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