scsi_host.h: add some comments to struct scsi_host_template
Signed-off-by: Stefan Richter <stefanr@xxxxxxxxxxxxxxxxx>
---
include/scsi/scsi_host.h | 19 +++++++++++++++++--
1 files changed, 17 insertions(+), 2 deletions(-)
--- linux-2.6.14-git3/include/scsi/scsi_host.h.orig 2005-10-28 02:02:08.000000000 +0200
+++ linux-2.6.14-git3/include/scsi/scsi_host.h 2005-11-13 16:24:58.000000000 +0100
@@ -40,7 +40,19 @@ enum scsi_eh_timer_return {
struct scsi_host_template {
+ /*
+ * The low-level driver should set this to THIS_MODULE to prevent
+ * itself being unloaded while higher levels use devices at this host.
+ *
+ * Status: OPTIONAL (strongly recommended)
+ */
struct module *module;
+
+ /*
+ * A short human-readable identification of the host.
+ *
+ * Status: REQUIRED
+ */
const char *name;
/*
@@ -295,13 +307,16 @@ struct scsi_host_template {
int (*proc_info)(struct Scsi_Host *, char *, char **, off_t, int, int);
/*
- * Name of proc directory
+ * Name of proc directory. Also content of proc_name attribute of
+ * the host's sysfs class device.
+ *
+ * Status: REQUIRED
*/
char *proc_name;
/*
* Used to store the procfs directory if a driver implements the
- * proc_info method.
+ * proc_info method. Created and destroyed by SCSI core.
*/
struct proc_dir_entry *proc_dir;
-
: send the line "unsubscribe linux-scsi" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
