1.\" $FreeBSD: head/share/man/man4/ciss.4 158762 2006-05-20 09:39:28Z brueffer $
2.\" Written by Tom Rhodes
3.\" This file is in the public domain.
4.\"
5.Dd November 3, 2005
6.Dt CISS 4
7.Os
8.Sh NAME
9.Nm ciss
10.Nd Common Interface for SCSI-3 Support driver
11.Sh SYNOPSIS
12To compile this driver into the kernel,
13place the following lines in your
14kernel configuration file:
15.Bd -ragged -offset indent
16.Cd "device scbus"
17.Cd "device ciss"
18.Ed
19.Pp
20Alternatively, to load the driver as a
21module at boot time, place the following line in
22.Xr loader.conf 5 :
23.Bd -literal -offset indent
24ciss_load="YES"
25.Ed
26.Sh DESCRIPTION
27The
28.Nm
29driver claims to provide a common interface between generic SCSI
30transports and intelligent host adapters.
31.Pp
32The
33.Nm
34driver supports
35.Em CISS
36as defined in the document entitled
37.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,
38dated 2000/11/27, produced by Compaq Computer Corporation.
39.Pp
40We provide a shim layer between the
41.Nm
42interface and
43.Xr CAM 4 ,
44offloading most of the queueing and being-a-disk chores onto CAM.
45Entry to the driver is via the PCI bus attachment
46.Fn ciss_probe ,
47.Fn ciss_attach ,
48etc.\& and via the CAM interface
49.Fn ciss_cam_action ,
50and
51.Fn ciss_cam_poll .
52The Compaq
53.Nm
54adapters require faked responses to get reasonable
55behavior out of them.
56In addition, the
57.Nm
58command set is by no means adequate to support the functionality
59of a RAID controller,
60and thus the supported Compaq adapters utilize portions of the
61control protocol from earlier Compaq adapter families.
62.Pp
63Currently
64.Nm
65only supports the
66.Dq simple
67transport layer over PCI.
68This interface (ab)uses the I2O register set (specifically the post
69queues) to exchange commands with the adapter.
70Other interfaces are available, but we are not supposed to know about them,
71and it is dubious whether they would provide major performance improvements
72except under extreme load.
73.Pp
74Non-disk devices (such as internal DATs and devices
75attached to the external SCSI bus) are supported as normal CAM devices
76provided that they are exported by the controller firmware and are not
77marked as being masked.
78Masked devices can be exposed by setting the
79.Va hw.ciss.expose_hidden_physical
80tunable to non-zero at boot time.
81Direct Access devices (such as disk
82drives) are only exposed as
83.Xr pass 4
84devices.
85Hot-insertion and removal of devices is supported but a bus
86rescan might be necessary.
87.Sh HARDWARE
88Controllers supported by the
89.Nm
90driver include:
91.Pp
92.Bl -bullet -compact
93.It
94Compaq Smart Array 5300
95.It
96Compaq Smart Array 532
97.It
98Compaq Smart Array 5i
99.It
100HP Smart Array 5312
101.It
102HP Smart Array 6i
103.It
104HP Smart Array 641
105.It
106HP Smart Array 642
107.It
108HP Smart Array 6400
109.It
110HP Smart Array 6400 EM
111.It
112HP Smart Array E200
113.It
114HP Smart Array E200i
115.It
116HP Smart Array P400
117.It
118HP Smart Array P400i
119.It
120HP Smart Array P600
121.It
122HP Smart Array P800
123.It
124HP Modular Smart Array 20 (MSA20)
125.It
126HP Modular Smart Array 500 (MSA500)
127.El
128.Sh SEE ALSO
129.Xr cam 4 ,
130.Xr pass 4 ,
131.Xr xpt 4 ,
132.Xr loader.conf 5 ,
133.Xr camcontrol 8
134.Rs
135.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
136.%D 2000/11/27
137.%Q "Compaq Computer Corporation"
138.Re
139.Sh AUTHORS
140.An -nosplit
141The
142.Nm
143driver was written by
144.An Mike Smith Aq msmith@FreeBSD.org .
145.Pp
146This manual page is based on his comments and was written by
147.An Tom Rhodes Aq trhodes@FreeBSD.org .
2.\" Written by Tom Rhodes
3.\" This file is in the public domain.
4.\"
5.Dd November 3, 2005
6.Dt CISS 4
7.Os
8.Sh NAME
9.Nm ciss
10.Nd Common Interface for SCSI-3 Support driver
11.Sh SYNOPSIS
12To compile this driver into the kernel,
13place the following lines in your
14kernel configuration file:
15.Bd -ragged -offset indent
16.Cd "device scbus"
17.Cd "device ciss"
18.Ed
19.Pp
20Alternatively, to load the driver as a
21module at boot time, place the following line in
22.Xr loader.conf 5 :
23.Bd -literal -offset indent
24ciss_load="YES"
25.Ed
26.Sh DESCRIPTION
27The
28.Nm
29driver claims to provide a common interface between generic SCSI
30transports and intelligent host adapters.
31.Pp
32The
33.Nm
34driver supports
35.Em CISS
36as defined in the document entitled
37.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,
38dated 2000/11/27, produced by Compaq Computer Corporation.
39.Pp
40We provide a shim layer between the
41.Nm
42interface and
43.Xr CAM 4 ,
44offloading most of the queueing and being-a-disk chores onto CAM.
45Entry to the driver is via the PCI bus attachment
46.Fn ciss_probe ,
47.Fn ciss_attach ,
48etc.\& and via the CAM interface
49.Fn ciss_cam_action ,
50and
51.Fn ciss_cam_poll .
52The Compaq
53.Nm
54adapters require faked responses to get reasonable
55behavior out of them.
56In addition, the
57.Nm
58command set is by no means adequate to support the functionality
59of a RAID controller,
60and thus the supported Compaq adapters utilize portions of the
61control protocol from earlier Compaq adapter families.
62.Pp
63Currently
64.Nm
65only supports the
66.Dq simple
67transport layer over PCI.
68This interface (ab)uses the I2O register set (specifically the post
69queues) to exchange commands with the adapter.
70Other interfaces are available, but we are not supposed to know about them,
71and it is dubious whether they would provide major performance improvements
72except under extreme load.
73.Pp
74Non-disk devices (such as internal DATs and devices
75attached to the external SCSI bus) are supported as normal CAM devices
76provided that they are exported by the controller firmware and are not
77marked as being masked.
78Masked devices can be exposed by setting the
79.Va hw.ciss.expose_hidden_physical
80tunable to non-zero at boot time.
81Direct Access devices (such as disk
82drives) are only exposed as
83.Xr pass 4
84devices.
85Hot-insertion and removal of devices is supported but a bus
86rescan might be necessary.
87.Sh HARDWARE
88Controllers supported by the
89.Nm
90driver include:
91.Pp
92.Bl -bullet -compact
93.It
94Compaq Smart Array 5300
95.It
96Compaq Smart Array 532
97.It
98Compaq Smart Array 5i
99.It
100HP Smart Array 5312
101.It
102HP Smart Array 6i
103.It
104HP Smart Array 641
105.It
106HP Smart Array 642
107.It
108HP Smart Array 6400
109.It
110HP Smart Array 6400 EM
111.It
112HP Smart Array E200
113.It
114HP Smart Array E200i
115.It
116HP Smart Array P400
117.It
118HP Smart Array P400i
119.It
120HP Smart Array P600
121.It
122HP Smart Array P800
123.It
124HP Modular Smart Array 20 (MSA20)
125.It
126HP Modular Smart Array 500 (MSA500)
127.El
128.Sh SEE ALSO
129.Xr cam 4 ,
130.Xr pass 4 ,
131.Xr xpt 4 ,
132.Xr loader.conf 5 ,
133.Xr camcontrol 8
134.Rs
135.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
136.%D 2000/11/27
137.%Q "Compaq Computer Corporation"
138.Re
139.Sh AUTHORS
140.An -nosplit
141The
142.Nm
143driver was written by
144.An Mike Smith Aq msmith@FreeBSD.org .
145.Pp
146This manual page is based on his comments and was written by
147.An Tom Rhodes Aq trhodes@FreeBSD.org .