[PATCH] scsi: document generic scsi host sysfs attributes

[PATCH] scsi: document generic scsi host sysfs attributes

[Stephen M. Cameron]

From: Stephen M. Cameron <scameron@beardog.cce.hp.com>

Signed-off-by: Stephen M. Cameron <scameron@beardog.cce.hp.com>
---
 Documentation/ABI/testing/sysfs-bus-scsi |  121 ++++++++++++++++++++++++++++++
 1 files changed, 121 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-scsi

diff --git a/Documentation/ABI/testing/sysfs-bus-scsi b/Documentation/ABI/testing/sysfs-bus-scsi
new file mode 100644
index 0000000..fe4d36e
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-scsi
@@ -0,0 +1,121 @@
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/unique_id
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned integer uniquely identifying the SCSI host
+		within the system.  This value is assigned by the low level
+		driver.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/host_busy
+Date:		February 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer indicating whether the SCSI
+		host is busy.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/cmd_per_lun
+Date:		February 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only short integer indicating how many concurrent
+		commands per logical unit the SCSI host supports.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/can_queue
+Date:		October, 2006
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only short integer indicating the total number of
+		concurrent commands the SCSI host supports.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/sg_tablesize
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer indicating how many scatter
+		gather entries are available for each command.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/sg_prot_tablesize
+Date:		September, 2010
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer which indicates how many
+		scatter gather entries are available for DIX integrity data.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/unchecked_isa_dma
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/proc_name
+Date:		March, 2004
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/scan
+Date:		August, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only integer which indicates whether the host is an
+		ancient ISA device which therefore requires extra bounce
+		buffering.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/hstate
+Date:		February, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		String value which indicates the state of the SCSI host.
+		Possible values are: "created", "running", "cancel",
+		"deleted", "recovery", "cancel/recovery" and "deleted/recovery"
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/supported_mode
+Date:		October, 2007
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only string value which indicates the supported modes of
+		the SCSI host.  Possible modes are: "Initiator" and "Target".
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/active_mode
+Date:		October, 2007
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only string value which indicates the currently active
+		mode of the SCSI host.  Possible values are "Initiator",
+		"Target" and "unknown".
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/prot_capabilities
+Date:		July, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned integer bitmap which indicates what
+		data integrity capabilities the SCSI host supports.
+		Bit 0: T10 DIF type 1
+		Bit 1: T10 DIF type 2
+		Bit 2: T10 DIF type 3
+		Bit 3: DIX between OS and HBA only.
+		Bit 4: DIX with DIF type 1
+		Bit 5: DIX with DIF type 2
+		Bit 6: DIX with DIF type 3
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/prot_guard_type
+Date:		July, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short bitmap value which indicates what
+		checksums DIX capable controllers implement.
+		Bit 0: DIX guard CRC.
+		Bit 1: DIX guard IP.
+

Re: [PATCH] scsi: document generic scsi host sysfs attributes

[Stefan Richter]

On Aug 17 Stephen M. Cameron wrote:
> What:		/sys/bus/scsi/devices/host*/scsi_host/host*/unchecked_isa_dma
> +Date:		February, 2003
> +KernelVersion:	Unknown
> +Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
> +Description:
> +
> +What:		/sys/bus/scsi/devices/host*/scsi_host/host*/proc_name
> +Date:		March, 2004
> +KernelVersion:	Unknown
> +Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
> +Description:
> +
> +What:		/sys/bus/scsi/devices/host*/scsi_host/host*/scan
> +Date:		August, 2003
> +KernelVersion:	Unknown
> +Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
> +Description:
> +		Read only integer which indicates whether the host is an
> +		ancient ISA device which therefore requires extra bounce
> +		buffering.

The last description obviously belongs to unchecked_isa_dma.

scan is a write-only attribute that may or may not initiate a bus rescan,
I suppose.

proc_name is the "name of proc directory" of a driver, if the driver
maintained one; though it seems all drivers provide proc_name
independently of the obsolete proc interface for driver data.
-- 
Stefan Richter
-=====-==-== =--- =--=-
http://arcgraph.de/sr/

[PATCH] scsi: document generic scsi host sysfs attributes

[Stephen M. Cameron]

From: Stephen M. Cameron <scameron@beardog.cce.hp.com>

Signed-off-by: Stephen M. Cameron <scameron@beardog.cce.hp.com>
---
 Documentation/ABI/testing/sysfs-bus-scsi |  129 ++++++++++++++++++++++++++++++
 1 files changed, 129 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-scsi

diff --git a/Documentation/ABI/testing/sysfs-bus-scsi b/Documentation/ABI/testing/sysfs-bus-scsi
new file mode 100644
index 0000000..088d16a
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-scsi
@@ -0,0 +1,129 @@
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/unique_id
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned integer uniquely identifying the SCSI host
+		within the system.  This value is assigned by the low level
+		driver.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/host_busy
+Date:		February 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer indicating whether the SCSI
+		host is busy.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/cmd_per_lun
+Date:		February 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only short integer indicating how many concurrent
+		commands per logical unit the SCSI host supports.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/can_queue
+Date:		October, 2006
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only short integer indicating the total number of
+		concurrent commands the SCSI host supports.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/sg_tablesize
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer indicating how many scatter
+		gather entries are available for each command.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/sg_prot_tablesize
+Date:		September, 2010
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short integer which indicates how many
+		scatter gather entries are available for DIX integrity data.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/unchecked_isa_dma
+Date:		February, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only integer which indicates whether the host is an
+		ancient ISA device which therefore requires extra bounce
+		buffering.
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/proc_name
+Date:		March, 2004
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only string which indicates the name of the proc
+		directory of a driver
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/scan
+Date:		August, 2003
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Write only attribute which causes the SCSI mid layer to
+		scan the SCSI host at the specified channel, bus, and id for
+		devices.  The integer decimal value of -1 interpreted as
+		an unsigned integer (4294967295 on most architectures) may
+		be used as a wild card.  For example:
+		echo 4294967295 4294967295 4294967295 > /sys/.../scan
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/hstate
+Date:		February, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		String value which indicates the state of the SCSI host.
+		Possible values are: "created", "running", "cancel",
+		"deleted", "recovery", "cancel/recovery" and "deleted/recovery"
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/supported_mode
+Date:		October, 2007
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only string value which indicates the supported modes of
+		the SCSI host.  Possible modes are: "Initiator" and "Target".
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/active_mode
+Date:		October, 2007
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only string value which indicates the currently active
+		mode of the SCSI host.  Possible values are "Initiator",
+		"Target" and "unknown".
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/prot_capabilities
+Date:		July, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned integer bitmap which indicates what
+		data integrity capabilities the SCSI host supports.
+		Bit 0: T10 DIF type 1
+		Bit 1: T10 DIF type 2
+		Bit 2: T10 DIF type 3
+		Bit 3: DIX between OS and HBA only.
+		Bit 4: DIX with DIF type 1
+		Bit 5: DIX with DIF type 2
+		Bit 6: DIX with DIF type 3
+
+What:		/sys/bus/scsi/devices/host*/scsi_host/host*/prot_guard_type
+Date:		July, 2008
+KernelVersion:	Unknown
+Contact:	James Bottomley <James.Bottomley@HansenPartnership.com>
+Description:
+		Read only unsigned short bitmap value which indicates what
+		checksums DIX capable controllers implement.
+		Bit 0: DIX guard CRC.
+		Bit 1: DIX guard IP.
+