cciss.4: Copyedit by mtk

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2011-09-21 05:07:35 +02:00
parent d3ea2cc70f
commit 536fabdfa1
1 changed files with 118 additions and 58 deletions

View File

@ -1,7 +1,7 @@
.\" Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
.\" Written by Stephen M. Cameron <scameron@beardog.cce.hp.com>
.\" Licensed under GNU General Public License version 2 (GPLv2)
.\"
.\"
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH CCISS 4 2011-09-21 "Linux" "Linux Programmer's Manual"
@ -16,10 +16,13 @@ modprobe cciss [ cciss_allow_hpsa=1 ]
is a block driver for older HP Smart Array RAID controllers.
.SS Options
.IR "cciss_allow_hpsa=1" :
This option prevents the cciss driver
from attempting to drive any controllers which the hpsa driver
is capable of controlling, which is to say, the cciss driver
is restricted by this option to the following controllers:
This option prevents the
.B cciss
driver from attempting to drive any controllers which the
.BR hpsa (4)
driver is capable of controlling, which is to say, the
.B cciss
driver is restricted by this option to the following controllers:
.nf
Smart Array 5300
@ -74,8 +77,11 @@ driver supports the following Smart Array boards:
.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
@ -116,7 +122,7 @@ The device naming scheme is:
.fi
.SS Files in /proc
The files
The files
.I /proc/driver/cciss/cciss[0-9]+
contain information about
the configuration of each controller.
@ -146,58 +152,85 @@ For example:
.fi
.SS Files in /sys
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/model
Displays the SCSI INQUIRY page 0 model for logical drive Y of controller X.
Displays the SCSI INQUIRY page 0 model for logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/rev
Displays the SCSI INQUIRY page 0 revision for logical drive Y of controller X.
Displays the SCSI INQUIRY page 0 revision for logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/unique_id
Displays the SCSI INQUIRY page 83 serial number for
logical drive Y of controller X.
Displays the SCSI INQUIRY page 83 serial number for logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/vendor
Displays the SCSI INQUIRY page 0 vendor for logical drive Y of controller X.
Displays the SCSI INQUIRY page 0 vendor for logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/block:cciss!cXdY
A symbolic link to /sys/block/cciss!cXdY
A symbolic link to
.IR /sys/block/cciss!cXdY .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/rescan
Kicks off a rescan of the controller to discover logical drive topology changes.
.\" FIXME The following is not clear. How is the rescan kicked off?
.\" Do you write something to this file?
Kicks off a rescan of the controller to discover
logical drive topology changes.
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/resettable
A value of 1 indicates the "reset_devices=1" kernel parameter (used by
kdump) is honored by this controller.
A value of 0 indicates the
A value of 1 displayed in this file indicates that
the "reset_devices=1" kernel parameter (used by
.BR kdump )
is honored by this controller.
A value of 0 indicates that the
"reset_devices=1" kernel parameter will not be honored.
Some models of Smart Array are not able to honor this parameter.
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/lunid
Displays the 8-byte LUN ID used to address logical drive Y of controller X.
Displays the 8-byte LUN ID used to address logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/raid_level
Displays the RAID level of logical drive Y of controller X.
Displays the RAID level of logical drive
.I Y
of controller
.IR X .
.TP
.I /sys/bus/pci/devices/<dev>/ccissX/cXdY/usage_count
Displays the usage count (number of opens) of logical drive Y of controller X.
Displays the usage count (number of opens) of logical drive
.I Y
of controller
.IR X .
.SS SCSI tape drive and medium changer support
SCSI sequential access devices and medium changer devices are supported and
appropriate device nodes are automatically created (e.g.
appropriate device nodes are automatically created (e.g.,
.IR /dev/st0 ,
.IR /dev/st1
etc.; see
.IR /dev/st1 ,
etc.; see
.BR st (4)
for more details.)
You must enable "SCSI tape drive support for Smart Array 5xxx" and
"SCSI support" in your kernel configuration to be able to use SCSI
tape drives with your Smart Array 5xxx controller.
Additionally, note that the driver will not engage the SCSI core at init time.
Additionally, note that the driver will not engage the SCSI core at
init time.
The driver must be directed to dynamically engage the SCSI core via
the /proc filesystem entry which the "block" side of the driver creates as
/proc/driver/cciss/cciss* at runtime.
the /proc file-system entry, which the "block" side of the driver creates as
.I /proc/driver/cciss/cciss*
at runtime.
This is because at driver init time,
the SCSI core may not yet be initialized (because the driver is a block
driver) and attempting to register it with the SCSI core in such a case
@ -225,77 +258,104 @@ script.
.SS Hot plug support for SCSI tape drives
Hot plugging of SCSI tape drives is supported, with some caveats.
The cciss driver must be informed that changes to the SCSI bus
The
.B cciss
driver must be informed that changes to the SCSI bus
have been made.
This may be done via the /proc filesystem.
This may be done via the /proc file system.
For example:
echo "rescan" > /proc/scsi/cciss0/1
This causes the driver to query the adapter about changes to the
physical SCSI buses and/or fibre channel arbitrated loop and the
driver to make note of any new or removed sequential access devices
This causes the driver to:
.RS
.IP 1. 3
query the adapter about changes to the
physical SCSI buses and/or fibre channel arbitrated loop, and
.IP 2.
make note of any new or removed sequential access devices
or medium changers.
The driver will output messages indicating what
.RE
.LP
The driver will output messages indicating which
devices have been added or removed and the controller, bus, target and
lun used to address the device.
It then notifies the SCSI mid layer
lun used to address each device.
The driver then notifies the SCSI midlayer
of these changes.
Note that the naming convention of the /proc filesystem entries
Note that the naming convention of the /proc file-system entries
contains a number in addition to the driver name
(e.g., "cciss0"
instead of just "cciss" which you might expect).
instead of just "cciss", which you might expect).
Note:
Note:
.I Only
sequential access devices and medium changers are presented
as SCSI devices to the SCSI mid layer by the cciss driver.
as SCSI devices to the SCSI midlayer by the
.B cciss
driver.
Specifically, physical SCSI disk drives are
.I not
presented to the SCSI mid layer.
presented to the SCSI midlayer.
.\" FIXME The following sentence doesn't quite parse smantically, and it
.\" presents multiple ideas. Please rewrite as shorter sentences.
The physical SCSI disk drives are controlled directly by the array controller
hardware and it is important to prevent the kernel from attempting to directly
access these devices too, as if the array controller were merely a SCSI
controller in the same way that we are allowing it to access SCSI tape drives.
.SS SCSI error handling for tape drives and medium changers
The linux SCSI mid layer provides an error handling protocol which
kicks into gear whenever a SCSI command fails to complete within a
The Linux SCSI midlayer provides an error-handling protocol which
is initiated whenever a SCSI command fails to complete within a
certain amount of time (which can vary depending on the command).
The cciss driver participates in this protocol to some extent.
The normal protocol is a four step process.
First the device is told to abort the command.
The
.B cciss
driver participates in this protocol to some extent.
The normal protocol is a four-step process:
.IP * 3
First, the device is told to abort the command.
.IP *
If that doesn't work, the device is reset.
.IP *
If that doesn't work, the SCSI bus is reset.
.IP *
If that doesn't work the host bus adapter is reset.
Because the cciss driver is a block
.LP
.\" FIXME Check the following. There was a very long sentence here that
.\" was hard to parse. I broke it into 3 sentences. Is the meaning still
.\" correctly conveyed?
The
.B cciss
driver is a block
driver as well as a SCSI driver and only the tape drives and medium
changers are presented to the SCSI mid layer, and unlike more
straightforward SCSI drivers, disk i/o continues through the block
side during the SCSI error recovery process, the cciss driver only
implements the first two of these actions, aborting the command, and
resetting the device.
Additionally, most tape drives will not oblige
changers are presented to the SCSI midlayer
Furthermore, unlike more
straightforward SCSI drivers, disk I/O continues through the block
side during the SCSI error-recovery process
Therefore, the
.B cciss
driver implements only the first two of these actions,
aborting the command, and resetting the device.
Note also that most tape drives will not oblige
in aborting commands, and sometimes it appears they will not even
obey a reset command, though in most circumstances they will.
In the case that the command cannot be aborted and the device cannot be
If the command cannot be aborted and the device cannot be
reset, the device will be set offline.
In the event the error handling code is triggered and a tape drive is
In the event that the error-handling code is triggered and a tape drive is
successfully reset or the tardy command is successfully aborted, the
tape drive may still not allow i/o to continue until some command
tape drive may still not allow I/O to continue until some command
is issued which positions the tape to a known position.
Typically you must rewind the tape (by issuing
.I "mt -f /dev/st0 rewind"
for example)
before I/O can proceed again to a tape drive which was reset.
.SH "SEE ALSO"
.BR cciss_vol_status (8),
.BR hpsa (4),
.BR hpacucli (8),
.BR hpacuxe (8),
.BR cciss_vol_status (8),
.IR http://cciss.sf.net ,
and the linux kernel source files
and the Linux kernel source files
.I Documentation/blockdev/cciss.txt
and
.I Documentation/ABI/testing/sysfs-bus-pci-devices-cciss