xref: /freebsd/share/man/man4/ciss.4 (revision 8ccc0d235c226d84112561d453c49904398d085c)
1.\" Written by Tom Rhodes
2.\" This file is in the public domain.
3.\"
4.Dd November 6, 2025
5.Dt CISS 4
6.Os
7.Sh NAME
8.Nm ciss
9.Nd Common Interface for SCSI-3 Support driver
10.Sh SYNOPSIS
11To compile this driver into the kernel,
12place the following lines in your
13kernel configuration file:
14.Bd -ragged -offset indent
15.Cd "device scbus"
16.Cd "device ciss"
17.Ed
18.Pp
19Alternatively, to load the driver as a
20module at boot time, place the following line in
21.Xr loader.conf 5 :
22.Bd -literal -offset indent
23ciss_load="YES"
24.Ed
25.Sh DESCRIPTION
26The
27.Nm
28driver claims to provide a common interface between generic SCSI
29transports and intelligent host adapters.
30.Pp
31The
32.Nm
33driver supports
34.Em CISS
35as defined in the document entitled
36.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,
37dated 2000/11/27, produced by Compaq Computer Corporation.
38.Pp
39We provide a shim layer between the
40.Nm
41interface and
42.Xr CAM 4 ,
43offloading most of the queueing and being-a-disk chores onto CAM.
44Entry to the driver is via the PCI bus attachment
45.Fn ciss_probe ,
46.Fn ciss_attach ,
47etc.\& and via the CAM interface
48.Fn ciss_cam_action ,
49and
50.Fn ciss_cam_poll .
51The Compaq
52.Nm
53adapters require faked responses to get reasonable
54behavior out of them.
55In addition, the
56.Nm
57command set is by no means adequate to support the functionality
58of a RAID controller,
59and thus the supported Compaq adapters utilize portions of the
60control protocol from earlier Compaq adapter families.
61.Pp
62Currently
63.Nm
64supports the
65.Dq simple
66and
67.Dq performant
68transport layer.
69.Pp
70Non-disk devices (such as internal DATs and devices
71attached to the external SCSI bus) are supported as normal CAM devices
72provided that they are exported by the controller firmware and are not
73marked as being masked.
74Masked devices can be exposed by setting the
75.Va hw.ciss.expose_hidden_physical
76tunable to non-zero at boot time.
77Direct Access devices (such as disk
78drives) are only exposed as
79.Xr pass 4
80devices.
81Hot-insertion and removal of devices is supported and notification messages
82will be reported to the console and logs.
83.Pp
84The problem which adapter freezes with the message
85.Dq ADAPTER HEARTBEAT FAILED
86might be solved by updating the firmware and/or setting the
87.Va hw.ciss.nop_message_heartbeat
88tunable to non-zero at boot time.
89.Sh HARDWARE
90The
91.Nm
92driver supports controllers implementing
93Common Interface for SCSI-3 Support Open Specification v1.04, including:
94.Pp
95.Bl -bullet -compact
96.It
97Compaq Smart Array 5300 (simple mode only)
98.It
99Compaq Smart Array 532
100.It
101Compaq Smart Array 5i
102.It
103HP Smart Array 5312
104.It
105HP Smart Array 6i
106.It
107HP Smart Array 641
108.It
109HP Smart Array 642
110.It
111HP Smart Array 6400
112.It
113HP Smart Array 6400 EM
114.It
115HP Smart Array E200
116.It
117HP Smart Array E200i
118.It
119HP Smart Array P212
120.It
121HP Smart Array P220i
122.It
123HP Smart Array P222
124.It
125HP Smart Array P230i
126.It
127HP Smart Array P400
128.It
129HP Smart Array P400i
130.It
131HP Smart Array P410
132.It
133HP Smart Array P410i
134.It
135HP Smart Array P411
136.It
137HP Smart Array P420
138.It
139HP Smart Array P420i
140.It
141HP Smart Array P421
142.It
143HP Smart Array P430
144.It
145HP Smart Array P430i
146.It
147HP Smart Array P431
148.It
149HP Smart Array P440ar
150.It
151HP Smart Array P530
152.It
153HP Smart Array P531
154.It
155HP Smart Array P600
156.It
157HP Smart Array P721m
158.It
159HP Smart Array P731m
160.It
161HP Smart Array P800
162.It
163HP Smart Array P812
164.It
165HP Smart Array P830
166.It
167HP Smart Array P830i
168.It
169HP Modular Smart Array 20 (MSA20)
170.It
171HP Modular Smart Array 500 (MSA500)
172.El
173.Sh SEE ALSO
174.Xr cam 4 ,
175.Xr pass 4 ,
176.Xr xpt 4 ,
177.Xr loader.conf 5 ,
178.Xr camcontrol 8
179.Rs
180.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
181.%D 2000/11/27
182.%Q "Compaq Computer Corporation"
183.Re
184.Sh AUTHORS
185.An -nosplit
186The
187.Nm
188driver was written by
189.An Mike Smith Aq Mt msmith@FreeBSD.org .
190.Pp
191This manual page is based on his comments and was written by
192.An Tom Rhodes Aq Mt trhodes@FreeBSD.org .
193