Debian Codegraph @

upstream/debian-unstable/man4/cciss.4

raw
1 '\" t
2 .\" Copyright 2011, Hewlett-Packard Development Company, L.P.
3 .\" Copyright, the authors of the Linux man-pages project
4 .\"
5 .\" SPDX-License-Identifier: GPL-2.0-only
6 .\"
7 .\" shorthand for double quote that works everywhere.
8 .ds q \N'34'
9 .TH cciss 4 2026-02-08 "Linux man-pages 6.18"
10 .SH NAME
11 cciss \- HP Smart Array block driver
12 .SH SYNOPSIS
13 .nf
14 modprobe cciss [ cciss_allow_hpsa=1 ]
15 .fi
16 .SH DESCRIPTION
17 .\" commit 253d2464df446456c0bba5ed4137a7be0b278aa8
18 .BR Note :
19 This obsolete driver was removed in Linux 4.14,
20 as it is superseded by the
21 .BR hpsa (4)
22 driver in newer kernels.
23 .P
24 .B cciss
25 is a block driver for older HP Smart Array RAID controllers.
26 .SS Options
27 .IR "cciss_allow_hpsa=1" :
28 This option prevents the
29 .B cciss
30 driver from attempting to drive any controllers that the
31 .BR hpsa (4)
32 driver is capable of controlling, which is to say, the
33 .B cciss
34 driver is restricted by this option to the following controllers:
35 .P
36 .nf
37 Smart Array 5300
38 Smart Array 5i
39 Smart Array 532
40 Smart Array 5312
41 Smart Array 641
42 Smart Array 642
43 Smart Array 6400
44 Smart Array 6400 EM
45 Smart Array 6i
46 Smart Array P600
47 Smart Array P400i
48 Smart Array E200i
49 Smart Array E200
50 Smart Array E200i
51 Smart Array E200i
52 Smart Array E200i
53 Smart Array E500
54 .fi
55 .SS Supported hardware
56 The
57 .B cciss
58 driver supports the following Smart Array boards:
59 .P
60 .nf
61 Smart Array 5300
62 Smart Array 5i
63 Smart Array 532
64 Smart Array 5312
65 Smart Array 641
66 Smart Array 642
67 Smart Array 6400
68 Smart Array 6400 U320 Expansion Module
69 Smart Array 6i
70 Smart Array P600
71 Smart Array P800
72 Smart Array E400
73 Smart Array P400i
74 Smart Array E200
75 Smart Array E200i
76 Smart Array E500
77 Smart Array P700m
78 Smart Array P212
79 Smart Array P410
80 Smart Array P410i
81 Smart Array P411
82 Smart Array P812
83 Smart Array P712m
84 Smart Array P711m
85 .fi
86 .SS Configuration details
87 To configure HP Smart Array controllers,
88 use the HP Array Configuration Utility
89 (either
90 .BR hpacuxe (8)
91 or
92 .BR hpacucli (8))
93 or the Offline ROM-based Configuration Utility (ORCA)
94 run from the Smart Array's option ROM at boot time.
95 .SH FILES
96 .SS Device nodes
97 The device naming scheme is as follows:
98 .P
99 Major numbers:
100 .IP
101 .TS
102 r r.
103 104 cciss0
104 105 cciss1
105 106 cciss2
106 105 cciss3
107 108 cciss4
108 109 cciss5
109 110 cciss6
110 111 cciss7
111 .TE
112 .P
113 Minor numbers:
114 .P
115 .EX
116 b7 b6 b5 b4 b3 b2 b1 b0
117 |\-\-\-\-+\-\-\-\-| |\-\-\-\-+\-\-\-\-|
118 | |
119 | +\-\-\-\-\-\-\-\- Partition ID (0=wholedev, 1\-15 partition)
120 |
121 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Logical Volume number
122 .EE
123 .P
124 The device naming scheme is:
125 .TS
126 li l.
127 /dev/cciss/c0d0 Controller 0, disk 0, whole device
128 /dev/cciss/c0d0p1 Controller 0, disk 0, partition 1
129 /dev/cciss/c0d0p2 Controller 0, disk 0, partition 2
130 /dev/cciss/c0d0p3 Controller 0, disk 0, partition 3
131 \&
132 /dev/cciss/c1d1 Controller 1, disk 1, whole device
133 /dev/cciss/c1d1p1 Controller 1, disk 1, partition 1
134 /dev/cciss/c1d1p2 Controller 1, disk 1, partition 2
135 /dev/cciss/c1d1p3 Controller 1, disk 1, partition 3
136 .TE
137 .SS Files in /proc
138 The files
139 .I /proc/driver/cciss/cciss[0\-9]+
140 contain information about
141 the configuration of each controller.
142 For example:
143 .P
144 .in +4n
145 .EX
146 .RB $ " cd /proc/driver/cciss" ;
147 .RB $ " ls \-l" ;
148 total 0
149 -rw\-r\-\-r\-\- 1 root root 0 2010\-09\-10 10:38 cciss0
150 -rw\-r\-\-r\-\- 1 root root 0 2010\-09\-10 10:38 cciss1
151 -rw\-r\-\-r\-\- 1 root root 0 2010\-09\-10 10:38 cciss2
152 .RB $ " cat cciss2" ;
153 cciss2: HP Smart Array P800 Controller
154 Board ID: 0x3223103c
155 Firmware Version: 7.14
156 IRQ: 16
157 Logical drives: 1
158 Current Q depth: 0
159 Current # commands on controller: 0
160 Max Q depth since init: 1
161 Max # commands on controller since init: 2
162 Max SG entries since init: 32
163 Sequential access devices: 0
164 \&
165 cciss/c2d0: 36.38GB RAID 0
166 .EE
167 .in
168 .\"
169 .SS Files in /sys
170 .TP
171 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /model
172 Displays the SCSI INQUIRY page 0 model for logical drive
173 .I Y
174 of controller
175 .IR X .
176 .TP
177 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /rev
178 Displays the SCSI INQUIRY page 0 revision for logical drive
179 .I Y
180 of controller
181 .IR X .
182 .TP
183 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /unique_id
184 Displays the SCSI INQUIRY page 83 serial number for logical drive
185 .I Y
186 of controller
187 .IR X .
188 .TP
189 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /vendor
190 Displays the SCSI INQUIRY page 0 vendor for logical drive
191 .I Y
192 of controller
193 .IR X .
194 .TP
195 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /block:cciss!c X d Y
196 A symbolic link to
197 .IR /sys/block/cciss!c X d Y.
198 .TP
199 .IR /sys/bus/pci/devices/ dev /cciss X /rescan
200 When this file is written to, the driver rescans the controller
201 to discover any new, removed, or modified logical drives.
202 .TP
203 .IR /sys/bus/pci/devices/ dev /cciss X /resettable
204 A value of 1 displayed in this file indicates that
205 the "reset_devices=1" kernel parameter (used by
206 .BR kdump )
207 is honored by this controller.
208 A value of 0 indicates that the
209 "reset_devices=1" kernel parameter will not be honored.
210 Some models of Smart Array are not able to honor this parameter.
211 .TP
212 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /lunid
213 Displays the 8-byte LUN ID used to address logical drive
214 .I Y
215 of controller
216 .IR X .
217 .TP
218 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /raid_level
219 Displays the RAID level of logical drive
220 .I Y
221 of controller
222 .IR X .
223 .TP
224 .IR /sys/bus/pci/devices/ dev /cciss X /c X d Y /usage_count
225 Displays the usage count (number of opens) of logical drive
226 .I Y
227 of controller
228 .IR X .
229 .SS SCSI tape drive and medium changer support
230 SCSI sequential access devices and medium changer devices are supported and
231 appropriate device nodes are automatically created (e.g.,
232 .IR /dev/st0 ,
233 .IR /dev/st1 ,
234 etc.;
235 see
236 .BR st (4)
237 for more details.)
238 You must enable "SCSI tape drive support for Smart Array 5xxx" and
239 "SCSI support" in your kernel configuration to be able to use SCSI
240 tape drives with your Smart Array 5xxx controller.
241 .P
242 Additionally, note that the driver will not engage the SCSI core at
243 init time.
244 The driver must be directed to dynamically engage the SCSI core via the
245 .I /proc
246 filesystem entry,
247 which the "block" side of the driver creates as
248 .I /proc/driver/cciss/cciss*
249 at run time.
250 This is because at driver init time,
251 the SCSI core may not yet be initialized (because the driver is a block
252 driver) and attempting to register it with the SCSI core in such a case
253 would cause a hang.
254 This is best done via an initialization script
255 (typically in
256 .IR /etc/init.d ,
257 but could vary depending on distribution).
258 For example:
259 .P
260 .in +4n
261 .EX
262 for x in /proc/driver/cciss/cciss[0\-9]*
263 do
264 echo "engage scsi" > $x
265 done
266 .EE
267 .in
268 .P
269 Once the SCSI core is engaged by the driver, it cannot be disengaged
270 (except by unloading the driver, if it happens to be linked as a module.)
271 .P
272 Note also that if no sequential access devices or medium changers are
273 detected, the SCSI core will not be engaged by the action of the above
274 script.
275 .SS Hot plug support for SCSI tape drives
276 Hot plugging of SCSI tape drives is supported, with some caveats.
277 The
278 .B cciss
279 driver must be informed that changes to the SCSI bus
280 have been made.
281 This may be done via the
282 .I /proc
283 filesystem.
284 For example:
285 .IP
286 echo "rescan" > /proc/scsi/cciss0/1
287 .P
288 This causes the driver to:
289 .RS
290 .IP (1) 5
291 query the adapter about changes to the
292 physical SCSI buses and/or fiber channel arbitrated loop, and
293 .IP (2)
294 make note of any new or removed sequential access devices
295 or medium changers.
296 .RE
297 .P
298 The driver will output messages indicating which
299 devices have been added or removed and the controller, bus, target, and
300 lun used to address each device.
301 The driver then notifies the SCSI midlayer
302 of these changes.
303 .P
304 Note that the naming convention of the
305 .I /proc
306 filesystem entries
307 contains a number in addition to the driver name
308 (e.g., "cciss0"
309 instead of just "cciss", which you might expect).
310 .P
311 Note:
312 .I Only
313 sequential access devices and medium changers are presented
314 as SCSI devices to the SCSI midlayer by the
315 .B cciss
316 driver.
317 Specifically, physical SCSI disk drives are
318 .I not
319 presented to the SCSI midlayer.
320 The only disk devices that are presented to the kernel are logical
321 drives that the array controller constructs from regions on
322 the physical drives.
323 The logical drives are presented to the block layer
324 (not to the SCSI midlayer).
325 It is important for the driver to prevent the kernel from accessing the
326 physical drives directly, since these drives are used by the array
327 controller to construct the logical drives.
328 .SS SCSI error handling for tape drives and medium changers
329 The Linux SCSI midlayer provides an error-handling protocol that
330 is initiated whenever a SCSI command fails to complete within a
331 certain amount of time (which can vary depending on the command).
332 The
333 .B cciss
334 driver participates in this protocol to some extent.
335 The normal protocol is a four-step process:
336 .IP (1) 5
337 First, the device is told to abort the command.
338 .IP (2)
339 If that doesn't work, the device is reset.
340 .IP (3)
341 If that doesn't work, the SCSI bus is reset.
342 .IP (4)
343 If that doesn't work, the host bus adapter is reset.
344 .P
345 The
346 .B cciss
347 driver is a block
348 driver as well as a SCSI driver and only the tape drives and medium
349 changers are presented to the SCSI midlayer.
350 Furthermore, unlike more
351 straightforward SCSI drivers, disk I/O continues through the block
352 side during the SCSI error-recovery process.
353 Therefore, the
354 .B cciss
355 driver implements only the first two of these actions,
356 aborting the command, and resetting the device.
357 Note also that most tape drives will not oblige
358 in aborting commands, and sometimes it appears they will not even
359 obey a reset command, though in most circumstances they will.
360 If the command cannot be aborted and the device cannot be
361 reset, the device will be set offline.
362 .P
363 In the event that the error-handling code is triggered and a tape drive is
364 successfully reset or the tardy command is successfully aborted, the
365 tape drive may still not allow I/O to continue until some command
366 is issued that positions the tape to a known position.
367 Typically you must rewind the tape (by issuing
368 .I "mt \-f /dev/st0 rewind"
369 for example) before I/O can proceed again to a tape drive that was reset.
370 .SH SEE ALSO
371 .BR hpsa (4),
372 .BR cciss_vol_status (8),
373 .BR hpacucli (8),
374 .BR hpacuxe (8)
375 .P
376 .UR http:\://cciss.sf.net
377 .UE ,
378 and
379 .I Documentation/blockdev/cciss.txt
380 and
381 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
382 in the Linux kernel source tree
383 .\" .SH AUTHORS
384 .\" Don Brace, Steve Cameron, Chase Maupin, Mike Miller, Michael Ni,
385 .\" Charles White, Francis Wiran
386 .\" and probably some other people.