freebsd-nq/share/man/man4/ciss.4

.\" $FreeBSD$
.\" Written by Tom Rhodes
.\" This file is in the public domain.
.\"
.Dd November 3, 2005
.Dt CISS 4
.Os
.Sh NAME
.Nm ciss
.Nd Common Interface for SCSI-3 Support driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device scbus"
.Cd "device ciss"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
ciss_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver claims to provide a common interface between generic SCSI
transports and intelligent host adapters.
.Pp
The
.Nm
driver supports
.Em CISS
as defined in the document entitled
.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,
dated 2000/11/27, produced by Compaq Computer Corporation.
.Pp
We provide a shim layer between the
.Nm
interface and
.Xr CAM 4 ,
offloading most of the queueing and being-a-disk chores onto CAM.
Entry to the driver is via the PCI bus attachment
.Fn ciss_probe ,
.Fn ciss_attach ,
etc.\& and via the CAM interface
.Fn ciss_cam_action ,
and
.Fn ciss_cam_poll .
The Compaq
.Nm
adapters require faked responses to get reasonable
behavior out of them.
In addition, the
.Nm
command set is by no means adequate to support the functionality
of a RAID controller,
and thus the supported Compaq adapters utilize portions of the
control protocol from earlier Compaq adapter families.
.Pp
Currently
.Nm
only supports the
.Dq simple
transport layer over PCI.
This interface (ab)uses the I2O register set (specifically the post
queues) to exchange commands with the adapter.
Other interfaces are available, but we are not supposed to know about them,
and it is dubious whether they would provide major performance improvements
except under extreme load.
.Pp
Non-disk devices (such as internal DATs and devices
attached to the external SCSI bus) are supported as normal CAM devices
provided that they are exported by the controller firmware and are not
marked as being masked.
Masked devices can be exposed by setting the
.Va hw.ciss.expose_hidden_physical
tunable to non-zero at boot time.
Direct Access devices (such as disk
drives) are only exposed as
.Xr pass 4
devices.
Hot-insertion and removal of devices is supported but a bus
rescan might be necessary.
.Pp
The problem which adapter freezes with the message
.Dq ADAPTER HEARTBEAT FAILED
might be solved by updating the firmware and/or setting the
.Va hw.ciss.nop_message_heartbeat
tunable to non-zero at boot time.
.Sh HARDWARE
Controllers supported by the
.Nm
driver include:
.Pp
.Bl -bullet -compact
.It
Compaq Smart Array 5300
.It
Compaq Smart Array 532
.It
Compaq Smart Array 5i
.It
HP Smart Array 5312
.It
HP Smart Array 6i
.It
HP Smart Array 641
.It
HP Smart Array 642
.It
HP Smart Array 6400
.It
HP Smart Array 6400 EM
.It
HP Smart Array E200
.It
HP Smart Array E200i
.It
HP Smart Array P212
.It
HP Smart Array P400
.It
HP Smart Array P400i
.It
HP Smart Array P410
.It
HP Smart Array P410i
.It
HP Smart Array P411
.It
HP Smart Array P600
.It
HP Smart Array P800
.It
HP Smart Array P812
.It
HP Modular Smart Array 20 (MSA20)
.It
HP Modular Smart Array 500 (MSA500)
.El
.Sh SEE ALSO
.Xr cam 4 ,
.Xr pass 4 ,
.Xr xpt 4 ,
.Xr loader.conf 5 ,
.Xr camcontrol 8
.Rs
.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
.%D 2000/11/27
.%Q "Compaq Computer Corporation"
.Re
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Mike Smith Aq msmith@FreeBSD.org .
.Pp
This manual page is based on his comments and was written by
.An Tom Rhodes Aq trhodes@FreeBSD.org .
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.\" $FreeBSD$`
			`.\" Written by Tom Rhodes`
			`.\" This file is in the public domain.`
			`.\"`
Update list of controllers ciss(4) driver actually supports according to implementation. Submitted by: Christoph Schug <chris@schug.net> MFC after: 1 week 2005-11-03 13:02:35 +00:00			`.Dd November 3, 2005`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Dt CISS 4`
			`.Os`
			`.Sh NAME`
			`.Nm ciss`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Nd Common Interface for SCSI-3 Support driver`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Sh SYNOPSIS`
Convert to use a SYNPOSIS section that mentions kernel modules. Also add "device scbus" where needed. MFC after: 3 days 2006-05-20 09:39:28 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Cd "device scbus"`
			`.Cd "device ciss"`
Convert to use a SYNPOSIS section that mentions kernel modules. Also add "device scbus" where needed. MFC after: 3 days 2006-05-20 09:39:28 +00:00			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`ciss_load="YES"`
			`.Ed`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver claims to provide a common interface between generic SCSI`
			`transports and intelligent host adapters.`
			`.Pp`
			`The`
			`.Nm`
			`driver supports`
			`.Em CISS`
			`as defined in the document entitled`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,`
			`dated 2000/11/27, produced by Compaq Computer Corporation.`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Pp`
			`We provide a shim layer between the`
			`.Nm`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`interface and`
			`.Xr CAM 4 ,`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`offloading most of the queueing and being-a-disk chores onto CAM.`
			`Entry to the driver is via the PCI bus attachment`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Fn ciss_probe ,`
			`.Fn ciss_attach ,`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`etc.\& and via the CAM interface`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Fn ciss_cam_action ,`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`and`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Fn ciss_cam_poll .`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`The Compaq`
			`.Nm`
			`adapters require faked responses to get reasonable`
			`behavior out of them.`
			`In addition, the`
			`.Nm`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`command set is by no means adequate to support the functionality`
			`of a RAID controller,`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`and thus the supported Compaq adapters utilize portions of the`
			`control protocol from earlier Compaq adapter families.`
			`.Pp`
			`Currently`
			`.Nm`
			`only supports the`
			`.Dq simple`
			`transport layer over PCI.`
			`This interface (ab)uses the I2O register set (specifically the post`
			`queues) to exchange commands with the adapter.`
s/arn't/are not/ Reword the AUTHORS section to make more sense. 2002-12-31 17:53:04 +00:00			`Other interfaces are available, but we are not supposed to know about them,`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`and it is dubious whether they would provide major performance improvements`
			`except under extreme load.`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Pp`
			`Non-disk devices (such as internal DATs and devices`
Document the new passthrough interface. 2004-06-23 00:27:56 +00:00			`attached to the external SCSI bus) are supported as normal CAM devices`
			`provided that they are exported by the controller firmware and are not`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`marked as being masked.`
			`Masked devices can be exposed by setting the`
Document the new passthrough interface. 2004-06-23 00:27:56 +00:00			`.Va hw.ciss.expose_hidden_physical`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`tunable to non-zero at boot time.`
			`Direct Access devices (such as disk`
Document the new passthrough interface. 2004-06-23 00:27:56 +00:00			`drives) are only exposed as`
			`.Xr pass 4`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`devices.`
			`Hot-insertion and removal of devices is supported but a bus`
Document the new passthrough interface. 2004-06-23 00:27:56 +00:00			`rescan might be necessary.`
Add `hw.ciss.nop_message_heartbeat' tunable (default disabled) for NOP-message polling in ciss_periodic(). Note that setting the tunable to non-zero can be workaround only for `ADAPTER HEARTBEAT FAILED' problem, and may freeze the system w/o the problem. Reviewed by: scottl Reported by: Attila Nagy MFC after: 3 days 2008-02-10 06:21:52 +00:00			`.Pp`
			`The problem which adapter freezes with the message`
			`.Dq ADAPTER HEARTBEAT FAILED`
			`might be solved by updating the firmware and/or setting the`
			`.Va hw.ciss.nop_message_heartbeat`
			`tunable to non-zero at boot time.`
- Add a HARDWARE section which lists supported devices. 2004-08-03 20:52:28 +00:00			`.Sh HARDWARE`
			`Controllers supported by the`
			`.Nm`
			`driver include:`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Pp`
- Add a HARDWARE section which lists supported devices. 2004-08-03 20:52:28 +00:00			`.Bl -bullet -compact`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.It`
			`Compaq Smart Array 5300`
			`.It`
			`Compaq Smart Array 532`
			`.It`
			`Compaq Smart Array 5i`
Synchronize the list of support devices with the driver source code. 2003-11-07 11:43:05 +00:00			`.It`
			`HP Smart Array 5312`
			`.It`
			`HP Smart Array 6i`
			`.It`
			`HP Smart Array 641`
			`.It`
			`HP Smart Array 642`
			`.It`
			`HP Smart Array 6400`
			`.It`
			`HP Smart Array 6400 EM`
Add support for the HP Modular Smart Array 20 & 500 storage arrays. Logical volumes on these devices show up as LUNs behind another controller (also known as proxy controller). In order to issue firmware commands for a volume on a proxy controller, they must be targeted at the address of the proxy controller it is attached to, not the Host/PCI controller. A proxy controller is defined as a device listed in the INQUIRY PHYSICAL LUNS command who's L2 and L3 SCSI addresses are zero. The corresponding address returned defines which "bus" the controller lives on and we use this to create a virtual CAM bus. A logical volume's addresses first byte defines the logical drive number. The second byte defines the bus that it is attached to which corresponds to the BUS of the proxy controller's found or the Host/PCI controller. Change event notification to be handled in its own kernel thread. This is needed since some events may require the driver to sleep on some operations and this cannot be done during interrupt context. With this change, it is now possible to create and destroy logical volumes from FreeBSD, but it requires a native application to construct the proper firmware commands which is not publicly available. Special thanks to John Cagle @ HP for providing remote access to all the hardware and beating on the storage engineers at HP to answer my questions. 2004-04-16 23:00:01 +00:00			`.It`
Update PCI ids to add the E200, E200i, P400, and P400i storage controllers. Remove the E400 since it is not a real product. Submitted by: HP 2005-11-11 16:45:33 +00:00			`HP Smart Array E200`
			`.It`
			`HP Smart Array E200i`
			`.It`
Add support for the P212, P410, P410i, P411, and P812 HP Smart Array controllers. Submitted by: Scott Benesh at HP 2008-06-10 17:51:51 +00:00			`HP Smart Array P212`
			`.It`
Update PCI ids to add the E200, E200i, P400, and P400i storage controllers. Remove the E400 since it is not a real product. Submitted by: HP 2005-11-11 16:45:33 +00:00			`HP Smart Array P400`
			`.It`
			`HP Smart Array P400i`
Add HP Smart Array 6422 and V100 to the list of supported controllers. 2004-06-14 22:10:56 +00:00			`.It`
Add support for the P212, P410, P410i, P411, and P812 HP Smart Array controllers. Submitted by: Scott Benesh at HP 2008-06-10 17:51:51 +00:00			`HP Smart Array P410`
			`.It`
			`HP Smart Array P410i`
			`.It`
			`HP Smart Array P411`
			`.It`
Update list of controllers ciss(4) driver actually supports according to implementation. Submitted by: Christoph Schug <chris@schug.net> MFC after: 1 week 2005-11-03 13:02:35 +00:00			`HP Smart Array P600`
			`.It`
			`HP Smart Array P800`
Add HP Smart Array 6422 and V100 to the list of supported controllers. 2004-06-14 22:10:56 +00:00			`.It`
Add support for the P212, P410, P410i, P411, and P812 HP Smart Array controllers. Submitted by: Scott Benesh at HP 2008-06-10 17:51:51 +00:00			`HP Smart Array P812`
			`.It`
Add support for the HP Modular Smart Array 20 & 500 storage arrays. Logical volumes on these devices show up as LUNs behind another controller (also known as proxy controller). In order to issue firmware commands for a volume on a proxy controller, they must be targeted at the address of the proxy controller it is attached to, not the Host/PCI controller. A proxy controller is defined as a device listed in the INQUIRY PHYSICAL LUNS command who's L2 and L3 SCSI addresses are zero. The corresponding address returned defines which "bus" the controller lives on and we use this to create a virtual CAM bus. A logical volume's addresses first byte defines the logical drive number. The second byte defines the bus that it is attached to which corresponds to the BUS of the proxy controller's found or the Host/PCI controller. Change event notification to be handled in its own kernel thread. This is needed since some events may require the driver to sleep on some operations and this cannot be done during interrupt context. With this change, it is now possible to create and destroy logical volumes from FreeBSD, but it requires a native application to construct the proper firmware commands which is not publicly available. Special thanks to John Cagle @ HP for providing remote access to all the hardware and beating on the storage engineers at HP to answer my questions. 2004-04-16 23:00:01 +00:00			`HP Modular Smart Array 20 (MSA20)`
			`.It`
			`HP Modular Smart Array 500 (MSA500)`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr cam 4 ,`
			`.Xr pass 4 ,`
			`.Xr xpt 4 ,`
Document the new passthrough interface. 2004-06-23 00:27:56 +00:00			`.Xr loader.conf 5 ,`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Xr camcontrol 8`
			`.Rs`
			`.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"`
			`.%D 2000/11/27`
			`.%Q "Compaq Computer Corporation"`
			`.Re`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`.Sh AUTHORS`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.An -nosplit`
Actually cvs add the ciss.4 file... 2002-12-30 22:54:29 +00:00			`The`
			`.Nm`
			`driver was written by`
			`.An Mike Smith Aq msmith@FreeBSD.org .`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Pp`
s/arn't/are not/ Reword the AUTHORS section to make more sense. 2002-12-31 17:53:04 +00:00			`This manual page is based on his comments and was written by`
			`.An Tom Rhodes Aq trhodes@FreeBSD.org .`