man4/smartpqi.4

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