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