man4/smartpqi.4

   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 <kevin.barnett@microchip.com>
   6 .\"
   7 .\" SPDX-License-Identifier: GPL-2.0-only
   8 .TH smartpqi 4 (date) "Linux man-pages (unreleased)"
   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 .YS
  20 .SH DESCRIPTION
  21 .B smartpqi
  22 is a SCSI driver for Microchip Smart Storage controllers.
  23 .SS Supported \f[BI]ioctl\fP\/() operations
  24 For compatibility with applications written for the
  25 .BR cciss (4)
  26 and
  27 .BR hpsa (4)
  28 drivers, many, but not all of the
  29 .BR ioctl (2)
  30 operations supported by the
  31 .B hpsa
  32 driver are also supported by the
  33 .B smartpqi
  34 driver.
  35 The data structures used by these operations
  36 are described in the Linux kernel source file
  37 .IR include/linux/cciss_ioctl.h .
  38 .TP
  39 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
  40 These operations
  41 all do exactly the same thing, which is to cause the driver to re-scan
  42 for new devices.
  43 This does exactly the same thing as writing to the
  44 .BR smartpqi -specific
  45 host
  46 .I rescan
  47 attribute.
  48 .TP
  49 .B CCISS_GETPCIINFO
  50 This operation returns the PCI domain, bus,
  51 device, and function and "board ID" (PCI subsystem ID).
  52 .TP
  53 .B CCISS_GETDRIVVER
  54 This operation returns the driver version in four bytes, encoded as:
  55 .IP
  56 .in +4n
  57 .EX
  58 (major_version << 28) | (minor_version << 24) |
  59         (release << 16) | revision
  60 .EE
  61 .in
  62 .TP
  63 .B CCISS_PASSTHRU
  64 Allows BMIC and CISS commands to be passed through to the controller.
  65 .SS Boot options
  66 .TP
  67 .BR disable_device_id_wildcards= { 0 | 1 }
  68 Disables support for device ID wildcards.
  69 The default value is 0.
  70 .TP
  71 .BR disable_heartbeat= { 0 | 1 }
  72 Disables support for the controller's heartbeat check.
  73 This parameter is used for debugging purposes.
  74 The default value is 0, leaving the controller's heartbeat check active.
  75 .TP
  76 .BR disable_ctrl_shutdown= { 0 | 1 }
  77 Disables support for shutting down the controller in the
  78 event of a controller lockup.
  79 The default value is 0.
  80 .TP
  81 .BR lockup_action= { none | reboot | panic }
  82 Specifies the action the driver takes when a controller
  83 lockup is detected.
  84 The default action is
  85 .BR none .
  86 .TS
  87 l l
  88 ---
  89 l l.
  90 parameter       action
  91 \fBnone\fP      take controller offline only
  92 \fBreboot\fP    reboot the system
  93 \fBpanic\fP     panic the system
  94 .TE
  95 .TP
  96 .BR expose_ld_first= { 0 | 1 }
  97 This option enables support for exposing logical devices to
  98 the operating system before physical devices.
  99 The default value is 0.
 100 .TP
 101 .BR hide_vsep= { 0 | 1 }
 102 This option enables disabling exposure of the virtual SEP to the host.
 103 This is usually associated with direct attached drives.
 104 The default value is 0.
 105 .SH FILES
 106 .SS Device nodes
 107 Logical drives are accessed via the SCSI disk driver
 108 .RI ( sd ),
 109 tape drives via the SCSI tape driver
 110 .RI ( st ),
 111 and the RAID controller via the SCSI generic driver
 112 .RI ( sg ),
 113 with device nodes named
 114 .IR /dev/sd *,
 115 .IR /dev/st *,
 116 and
 117 .IR /dev/sg *,
 118 respectively.
 119 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
 120 .TP
 121 .IR /sys/class/scsi_host/host * /rescan
 122 The host
 123 .I rescan
 124 attribute is a write-only attribute.
 125 Writing to this attribute will cause the driver to scan for new,
 126 changed, or removed devices (e.g., hot-plugged tape drives, or newly
 127 configured or deleted logical drives) and notify the SCSI mid-layer of
 128 any changes detected.
 129 Usually this action is triggered automatically by configuration
 130 changes, so the user should not normally have to write to this file.
 131 Doing so may be useful when hot-plugging devices such as tape drives or
 132 entire storage boxes containing pre-configured logical drives.
 133 .TP
 134 .IR /sys/class/scsi_host/host * /version
 135 The host
 136 .I version
 137 attribute is a read-only attribute.
 138 This attribute contains the driver version and the controller firmware
 139 version.
 140 .IP
 141 For example:
 142 .IP
 143 .in +4n
 144 .EX
 145 $ \c
 146 .B cat /sys/class/scsi_host/host1/version
 147 driver: 1.1.2\-126
 148 firmware: 1.29\-112
 149 .EE
 150 .in
 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 .I /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 .I /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 .I /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 .I /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 .I /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 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 245 In the file specifications below,
 246 .I c
 247 stands for the number of the appropriate SCSI controller,
 248 .I b
 249 is the bus number,
 250 .I t
 251 the target number, and
 252 .I l
 253 is the logical unit number (LUN).
 254 .TP
 255 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
 256 The
 257 .I raid_level
 258 attribute is read-only.
 259 This attribute contains the RAID level of each logical drive.
 260 .IP
 261 For example:
 262 .IP
 263 .in +4n
 264 .EX
 265 $ \c
 266 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
 267 RAID 0
 268 .EE
 269 .in
 270 .TP
 271 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
 272 The
 273 .I sas_address
 274 attribute is read-only.
 275 This attribute contains the unique identifier of the disk.
 276 .IP
 277 For example:
 278 .IP
 279 .in +4n
 280 .EX
 281 $ \c
 282 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
 283 0x5001173d028543a2
 284 .EE
 285 .in
 286 .TP
 287 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
 288 The
 289 .I ssd_smart_path_enabled
 290 attribute is read-only.
 291 This attribute is for ioaccel-enabled volumes.
 292 (Ioaccel is an alternative driver submission path that allows the
 293 driver to send I/O requests directly to backend SCSI devices,
 294 bypassing the controller firmware.
 295 This results in an increase in performance.
 296 This method is used for HBA disks and for logical volumes comprised of SSDs.)
 297 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 298 .IP
 299 For example:
 300 .IP
 301 .in +4n
 302 .EX
 303 $ \c
 304 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
 305 0
 306 .EE
 307 .in
 308 .SH VERSIONS
 309 The
 310 .B smartpqi
 311 driver was added in Linux 4.9.
 312 .SH NOTES
 313 .SS Configuration
 314 To configure a Microchip Smart Storage controller,
 315 refer to the User Guide for the controller,
 316 which can be found by searching for the specific controller at
 317 .UR https://www.microchip.com/design-centers/storage
 318 .UE .
 319 .SH SEE ALSO
 320 .BR cciss (4),
 321 .BR hpsa (4),
 322 .BR sd (4),
 323 .BR st (4)
 324 .PP
 325 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 326 in the Linux kernel source tree.