Permalink
Browse files

hpsa.4: Copyedits my mtk

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
  • Loading branch information...
mkerrisk committed Sep 21, 2011
1 parent 302d12b commit 32627bf742f1d28592caa9832d5b67a5c137259f
Showing with 48 additions and 32 deletions.
  1. +48 −32 man4/hpsa.4
View
@@ -17,14 +17,14 @@ is a SCSI driver for HP Smart Array RAID controllers.
.SS Options
.IR "hpsa_allow_any=1" :
This option allows the driver to attempt to operate on
-any HP Smart Array hardware RAID controller even if it is
-not explicitly known to the driver.
-This allows newer hardware
-to work with older drivers.
-Typically this is used for example
-to allow installation of OSes from media which predates the
-RAID controller though it may also be used to enable hpsa to
-drive older controllers that would normally be handled by the
+any HP Smart Array hardware RAID controller,
+even if it is not explicitly known to the driver.
+This allows newer hardware to work with older drivers.
+Typically this is used to allow installation of
+operating systems from media which predates the
+RAID controller, though it may also be used to enable
+.B hpsa
+to drive older controllers that would normally be handled by the
.BR cciss (4)
driver.
These older boards have not been tested and are
@@ -52,14 +52,22 @@ driver supports the following Smart Array boards:
.fi
.SS Configuration Details
To configure HP Smart Array controllers, use the HP Array Configuration Utility
-(either hpacuxe or hpacucli) or the Offline ROM-based Configuration Utility (ORCA)
+(either
+.BR hpacuxe (8)
+or
+.BR hpacucli (8))
+or the Offline ROM-based Configuration Utility (ORCA)
run from the Smart Array's option ROM at boot time.
.SH FILES
.SS Device Nodes
-Logical drives are accessed via the SCSI disk driver (sd),
-tape drives via the SCSI tape driver (st), and
-the RAID controller vi the SCSI generic driver (sg), with
-device nodes named
+Logical drives are accessed via the SCSI disk driver
+.RB ( sd (4)),
+tape drives via the SCSI tape driver
+.RB ( st (4)),
+and
+the RAID controller via the SCSI generic driver
+.RB ( sg (4)),
+with device nodes named
.IR /dev/sd*,
.IR /dev/st* ,
and
@@ -68,20 +76,21 @@ respectively.
.SS HPSA-Specific Host Attribute Files in /sys
.TP
.I /sys/class/scsi_host/host*/rescan
-the host "rescan" attribute is a write only attribute.
+This is a write-only attribute.
Writing to this
attribute will cause the driver to scan for new, changed, or removed devices
(e.g. hot-plugged tape drives, or newly configured or deleted logical drives,
etc.) and notify the SCSI midlayer of any changes detected.
-Normally this is
-triggered automatically by HP's Array Configuration Utility (either the GUI or
-command line variety) so for logical drive changes, the user should not
-normally have to use this.
-It may be useful when hot plugging devices like
-tape drives, or entire storage boxes containing pre-configured logical drives.
+Normally a rescan is triggered automatically
+by HP's Array Configuration Utility (either the GUI or the
+command-line variety);
+thus, for logical drive changes, the user should not
+normally have to use this attribute.
+This attribute may be useful when hot plugging devices like tape drives,
+or entire storage boxes containing pre-configured logical drives.
.TP
.I /sys/class/scsi_host/host*/firmware_revision
-The "firmware_revision" attribute contains the firmware version of the Smart Array.
+This attribute contains the firmware version of the Smart Array.
For example:
@@ -94,7 +103,7 @@ For example:
.SS HPSA-Specific Disk Attribute Files in /sys
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/unique_id
-contains a 32 hex-digit unique ID for each logical drive
+This attribute contains a 32 hex-digit unique ID for each logical drive
.nf
For example:
@@ -105,7 +114,7 @@ For example:
.fi
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/raid_level
-contains the RAID level of each logical drive.
+This attribute contains the RAID level of each logical drive.
.nf
For example:
@@ -116,9 +125,10 @@ For example:
.fi
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/lunid
-(where c:b:t:l are the controller, bus, target and lun of the device)
-contains 16 hex-digit (8 byte) LUN ID by which a logical drive or
+This attribute contains the 16 hex-digit (8 byte) LUN ID by which a logical drive or
physical device can be addressed.
+.IR c : b : t : l
+are the controller, bus, target and lun of the device.
.nf
For example:
@@ -128,15 +138,20 @@ For example:
0x0000004000000000
.fi
.SS Supported ioctl() operations
-For compatibility with applications written for the cciss driver, many, but
-not all of the ioctls supported by the cciss driver are also supported by the
-hpsa driver.
-The data structures used by these are described in
+For compatibility with applications written for the
+.BR cciss (4)
+driver, many, but
+not all of the ioctls supported by the
+.BR cciss (4)
+driver are also supported by the
+.B hpsa
+driver.
+The data structures used by these ioctls are described in
the kernel source file
.IR include/linux/cciss_ioctl.h .
.TP
.BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
-The above three ioctls all do exactly the same thing,
+These three ioctls all do exactly the same thing,
which is to cause the driver to rescan for new devices.
This does exactly the same thing as writing to the
hpsa-specific host "rescan" attribute.
@@ -155,7 +170,8 @@ Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
These are used extensively by the HP Array Configuration Utility, SNMP storage
agents, etc.
See
-.I cciss_vol_status at
+.I cciss_vol_status
+at
.I http://cciss.sf.net
for some examples.
.SH "SEE ALSO"
@@ -166,7 +182,7 @@ for some examples.
.BR hpacucli (8),
.BR hpacuxe (8),
.IR http://cciss.sf.net ,
-and the linux kernel source files
+and the Linux kernel source files
.I Documentation/scsi/hpsa.txt
and
.I Documentation/ABI/testing/sysfs-bus-pci-devices-cciss

0 comments on commit 32627bf

Please sign in to comment.