Debian Codegraph @

upstream/debian-trixie/man4/smartpqi.4

raw
1 '\" t
2 .\" Copyright (C) 2019-2023, Microchip Technology Inc. and its subsidiaries
3 .\" Copyright (C) 2016-2018, Microsemi Corporation
4 .\" Copyright (C) 2016, PMC-Sierra, Inc.
5 .\" Written by Kevin Barnett <[email protected]>
6 .\"
7 .\" SPDX-License-Identifier: GPL-2.0-only
8 .TH smartpqi 4 2024-05-02 "Linux man-pages 6.9.1"
9 .SH NAME
10 smartpqi \- Microchip Smart Storage SCSI driver
11 .SH SYNOPSIS
12 .SY "modprobe smartpqi"
13 .RB [ disable_device_id_wildcards= { 0 | 1 }]
14 .RB [ disable_heartbeat= { 0 | 1 }]
15 .RB [ disable_ctrl_shutdown= { 0 | 1 }]
16 .RB [ lockup_action= { none | reboot | panic }]
17 .RB [ expose_ld_first= { 0 | 1 }]
18 .RB [ hide_vsep= { 0 | 1 }]
19 .RB [ disable_managed_interrupts= { 0 | 1 }]
20 .RB [ ctrl_ready_timeout= { 0 |[ 30 , 1800 ]}]
21 .YS
22 .SH DESCRIPTION
23 .B smartpqi
24 is a SCSI driver for Microchip Smart Storage controllers.
25 .SS Supported \f[BI]ioctl\fP\/() operations
26 For compatibility with applications written for the
27 .BR cciss (4)
28 and
29 .BR hpsa (4)
30 drivers, many, but not all of the
31 .BR ioctl (2)
32 operations supported by the
33 .B hpsa
34 driver are also supported by the
35 .B smartpqi
36 driver.
37 The data structures used by these operations
38 are described in the Linux kernel source file
39 .IR include/linux/cciss_ioctl.h .
40 .TP
41 .B CCISS_DEREGDISK
42 .TQ
43 .B CCISS_REGNEWDISK
44 .TQ
45 .B CCISS_REGNEWD
46 These operations
47 all do exactly the same thing, which is to cause the driver to re-scan
48 for new devices.
49 This does exactly the same thing as writing to the
50 .BR smartpqi -specific
51 host
52 .I rescan
53 attribute.
54 .TP
55 .B CCISS_GETPCIINFO
56 This operation returns the PCI domain, bus,
57 device, and function and "board ID" (PCI subsystem ID).
58 .TP
59 .B CCISS_GETDRIVVER
60 This operation returns the driver version in four bytes, encoded as:
61 .IP
62 .in +4n
63 .EX
64 (major_version << 28) | (minor_version << 24) |
65 (release << 16) | revision
66 .EE
67 .in
68 .TP
69 .B CCISS_PASSTHRU
70 Allows BMIC and CISS commands to be passed through to the controller.
71 .SS Boot options
72 .TP
73 .BR disable_device_id_wildcards= { 0 | 1 }
74 Disables support for device ID wildcards.
75 The default value is 0 (wildcards are enabled).
76 .TP
77 .BR disable_heartbeat= { 0 | 1 }
78 Disables support for the controller's heartbeat check.
79 This parameter is used for debugging purposes.
80 The default value is 0 (the controller's heartbeat check is enabled).
81 .TP
82 .BR disable_ctrl_shutdown= { 0 | 1 }
83 Disables support for shutting down the controller in the
84 event of a controller lockup.
85 The default value is 0 (controller will be shut down).
86 .TP
87 .BR lockup_action= { none | reboot | panic }
88 Specifies the action the driver takes when a controller
89 lockup is detected.
90 The default action is
91 .BR none .
92 .TS
93 l l
94 ---
95 l l.
96 parameter action
97 \fBnone\fP take controller offline only
98 \fBreboot\fP reboot the system
99 \fBpanic\fP panic the system
100 .TE
101 .TP
102 .BR expose_ld_first= { 0 | 1 }
103 This option exposes logical devices to the OS before physical devices.
104 The default value is 0 (physical devices exposed first).
105 .TP
106 .BR hide_vsep= { 0 | 1 }
107 This option disables exposure of the virtual SEP to the OS.
108 The default value is 0 (virtual SEP is exposed).
109 .TP
110 .BR disable_managed_interrupts= { 0 | 1 }
111 Disables driver utilization of Linux kernel managed interrupts for controllers.
112 The managed interrupts feature automatically distributes interrupts
113 to all available CPUs and assigns SMP affinity.
114 The default value is 0 (managed interrupts enabled).
115 .TP
116 .BR ctrl_ready_timeout= { 0 |[ 30 , 1800 ]}
117 This option specifies the timeout in seconds for the driver to wait
118 for the controller to be ready.
119 The valid range is 0 or
120 .RB [ 30 ", " 1800 ].
121 The default value is 0,
122 which causes the driver to use a timeout of 180 seconds.
123 .SH FILES
124 .SS Device nodes
125 Disk drives are accessed via the SCSI disk driver
126 .RI ( sd ),
127 tape drives via the SCSI tape driver
128 .RI ( st ),
129 and the RAID controller via the SCSI generic driver
130 .RI ( sg ),
131 with device nodes named
132 .IR /dev/sd *,
133 .IR /dev/st *,
134 and
135 .IR /dev/sg *,
136 respectively.
137 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
138 .TP
139 .IR /sys/class/scsi_host/host * /rescan
140 The host
141 .I rescan
142 attribute is a write-only attribute.
143 Writing to this attribute will cause the driver to scan for new,
144 changed, or removed devices (e.g., hot-plugged tape drives, or newly
145 configured or deleted logical volumes) and notify the SCSI mid-layer of
146 any changes detected.
147 Usually this action is triggered automatically by configuration
148 changes, so the user should not normally have to write to this file.
149 Doing so may be useful when hot-plugging devices such as tape drives or
150 entire storage boxes containing pre-configured logical volumes.
151 .TP
152 .IR /sys/class/scsi_host/host * /lockup_action
153 The host
154 .I lockup_action
155 attribute is a read/write attribute.
156 This attribute will cause the driver to perform a specific action in the
157 unlikely event that a controller lockup has been detected.
158 See
159 .B OPTIONS
160 above
161 for an explanation of the
162 .I lockup_action
163 values.
164 .TP
165 .IR /sys/class/scsi_host/host * /driver_version
166 The
167 .I driver_version
168 attribute is read-only.
169 This attribute contains the smartpqi driver version.
170 .IP
171 For example:
172 .IP
173 .in +4n
174 .EX
175 $ \c
176 .B cat /sys/class/scsi_host/host1/driver_version
177 1.1.2\-126
178 .EE
179 .in
180 .TP
181 .IR /sys/class/scsi_host/host * /firmware_version
182 The
183 .I firmware_version
184 attribute is read-only.
185 This attribute contains the controller firmware version.
186 .IP
187 For example:
188 .IP
189 .in +4n
190 .EX
191 $ \c
192 .B cat /sys/class/scsi_host/host1/firmware_version
193 1.29\-112
194 .EE
195 .in
196 .TP
197 .IR /sys/class/scsi_host/host * /model
198 The
199 .I model
200 attribute is read-only.
201 This attribute contains the product identification string of the controller.
202 .IP
203 For example:
204 .IP
205 .in +4n
206 .EX
207 $ \c
208 .B cat /sys/class/scsi_host/host1/model
209 1100\-16i
210 .EE
211 .in
212 .TP
213 .IR /sys/class/scsi_host/host * /serial_number
214 The
215 .I serial_number
216 attribute is read-only.
217 This attribute contains the unique identification number of the controller.
218 .IP
219 For example:
220 .IP
221 .in +4n
222 .EX
223 $ \c
224 .B cat /sys/class/scsi_host/host1/serial_number
225 6A316373777
226 .EE
227 .in
228 .TP
229 .IR /sys/class/scsi_host/host * /vendor
230 The
231 .I vendor
232 attribute is read-only.
233 This attribute contains the vendor identification string of the controller.
234 .IP
235 For example:
236 .IP
237 .in +4n
238 .EX
239 $ \c
240 .B cat /sys/class/scsi_host/host1/vendor
241 Adaptec
242 .EE
243 .in
244 .TP
245 .IR /sys/class/scsi_host/host * /enable_stream_detection
246 The
247 .I enable_stream_detection
248 attribute is read-write.
249 This attribute enables/disables stream detection in the driver.
250 Enabling stream detection can improve sequential write performance
251 for ioaccel-enabled volumes.
252 See the
253 .B ssd_smart_path_enabled
254 disk attribute section for details on ioaccel-enabled volumes.
255 The default value is 1 (stream detection enabled).
256 .IP
257 Enable example:
258 .IP
259 .in +4n
260 .EX
261 $ \c
262 .B echo 1 > /sys/class/scsi_host/host1/enable_stream_detection
263 .EE
264 .in
265 .TP
266 .IR /sys/class/scsi_host/host * /enable_r5_writes
267 The
268 .I enable_r5_writes
269 attribute is read-write.
270 This attribute enables/disables RAID 5 write operations
271 for ioaccel-enabled volumes.
272 Enabling can improve sequential write performance.
273 See the
274 .B ssd_smart_path_enabled
275 disk attribute section for details on ioaccel-enabled volumes.
276 The default value is 1 (RAID 5 writes enabled).
277 .IP
278 Enable example:
279 .IP
280 .in +4n
281 .EX
282 $ \c
283 .B echo 1 > /sys/class/scsi_host/host1/enable_r5_writes
284 .EE
285 .in
286 .TP
287 .IR /sys/class/scsi_host/host * /enable_r6_writes
288 The
289 .I enable_r6_writes
290 attribute is read-write.
291 This attribute enables/disables RAID 6 write operations
292 for ioaccel-enabled volumes.
293 Enabling can improve sequential write performance.
294 See the
295 .B ssd_smart_path_enabled
296 disk attribute section for details on ioaccel-enabled volumes.
297 The default value is 1 (RAID 6 writes enabled).
298 .IP
299 Enable example:
300 .IP
301 .in +4n
302 .EX
303 $ \c
304 .B echo 1 > /sys/class/scsi_host/host1/enable_r6_writes
305 .EE
306 .in
307 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
308 In the file specifications below,
309 .I c
310 stands for the number of the appropriate SCSI controller,
311 .I b
312 is the bus number,
313 .I t
314 the target number, and
315 .I l
316 is the logical unit number (LUN).
317 .TP
318 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
319 The
320 .I raid_level
321 attribute is read-only.
322 This attribute contains the RAID level of the logical volume.
323 .IP
324 For example:
325 .IP
326 .in +4n
327 .EX
328 $ \c
329 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
330 RAID 0
331 .EE
332 .in
333 .TP
334 .IR /sys/class/scsi_disk/ c : b : t : l /device/sas_address
335 The
336 .I sas_address
337 attribute is read-only.
338 This attribute contains the SAS address of the device.
339 .IP
340 For example:
341 .IP
342 .in +4n
343 .EX
344 $ \c
345 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
346 0x5001173d028543a2
347 .EE
348 .in
349 .TP
350 .IR /sys/class/scsi_disk/ c : b : t : l /device/ssd_smart_path_enabled
351 The
352 .I ssd_smart_path_enabled
353 attribute is read-only.
354 This attribute is for ioaccel-enabled volumes.
355 (Ioaccel is an alternative driver submission path that allows the
356 driver to send I/O requests directly to backend SCSI devices,
357 bypassing the controller firmware.
358 This results in an increase in performance.
359 This method is used for HBA disks and for logical volumes comprised of SSDs.)
360 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
361 .IP
362 For example:
363 .IP
364 .in +4n
365 .EX
366 $ \c
367 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
368 0
369 .EE
370 .in
371 .TP
372 .IR /sys/class/scsi_disk/ c : b : t : l /device/lunid
373 The
374 .I lunid
375 attribute is read-only.
376 This attribute contains the SCSI LUN ID for the device.
377 .IP
378 For example:
379 .IP
380 .in +4n
381 .EX
382 $ \c
383 .B cat /sys/class/scsi_disk/13:1:0:3/device/lunid
384 0x0300004000000000
385 .EE
386 .in
387 .TP
388 .IR /sys/class/scsi_disk/ c : b : t : l /device/unique_id
389 The
390 .I unique_id
391 attribute is read-only.
392 This attribute contains a 16-byte ID
393 that uniquely identifies the device within the controller.
394 .IP
395 For example:
396 .IP
397 .in +4n
398 .EX
399 $ \c
400 .B cat /sys/class/scsi_disk/13:1:0:3/device/unique_id
401 600508B1001C6D4723A8E98D704FDB94
402 .EE
403 .in
404 .TP
405 .IR /sys/class/scsi_disk/ c : b : t : l /device/path_info
406 The
407 .I path_info
408 attribute is read-only.
409 This attribute contains the
410 .IR c : b : t : l
411 of the device
412 along with the device type
413 and whether the device is Active or Inactive.
414 If the device is an HBA device,
415 .I path_info
416 will also display the PORT, BOX, and BAY the device is plugged into.
417 .IP
418 For example:
419 .IP
420 .in +4n
421 .EX
422 $ \c
423 .B cat /sys/class/scsi_disk/13:1:0:3/device/path_info
424 [13:1:0:3] Direct-Access Active
425 \&
426 $ \c
427 .B cat /sys/class/scsi_disk/12:0:9:0/device/path_info
428 [12:0:9:0] Direct-Access PORT: C1 BOX: 1 BAY: 14 Inactive
429 [12:0:9:0] Direct-Access PORT: C0 BOX: 1 BAY: 14 Active
430 .EE
431 .in
432 .TP
433 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_bypass_cnt
434 The
435 .I raid_bypass_cnt
436 attribute is read-only.
437 This attribute contains the number of I/O requests
438 that have gone through the ioaccel path
439 for ioaccel-enabled volumes.
440 See the
441 .B ssd_smart_path_enabled
442 disk attribute section for details on ioaccel-enabled volumes.
443 .IP
444 For example:
445 .IP
446 .in +4n
447 .EX
448 $ \c
449 .B cat /sys/class/scsi_disk/13:1:0:3/device/raid_bypass_cnt
450 0x300
451 .EE
452 .in
453 .TP
454 .IR /sys/class/scsi_disk/ c : b : t : l /device/sas_ncq_prio_enable
455 The
456 .I sas_ncq_prio_enable
457 attribute is read/write.
458 This attribute enables SATA NCQ priority support.
459 This attribute works only when device has NCQ support
460 and controller firmware can handle IO with NCQ priority attribute.
461 .IP
462 For example:
463 .IP
464 .in +4n
465 .EX
466 $ \c
467 .B echo 1 > /sys/class/scsi_disk/13:1:0:3/device/sas_ncq_prio_enable
468 .EE
469 .in
470 .SH VERSIONS
471 The
472 .B smartpqi
473 driver was added in Linux 4.9.
474 .SH NOTES
475 .SS Configuration
476 To configure a Microchip Smart Storage controller,
477 refer to the User Guide for the controller,
478 which can be found by searching for the specific controller at
479 .UR https://www.microchip.com/design-centers/storage
480 .UE .
481 .SH HISTORY
482 .I /sys/class/scsi_host/host*/version
483 was replaced by two sysfs entries:
484 .IP
485 .I /sys/class/scsi_host/host*/driver_version
486 .IP
487 .I /sys/class/scsi_host/host*/firmware_version
488 .SH SEE ALSO
489 .BR cciss (4),
490 .BR hpsa (4),
491 .BR sd (4),
492 .BR st (4),
493 .BR sg (4)
494 .P
495 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
496 in the Linux kernel source tree.