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 .\" SPDX-License-Identifier: GPL-2.0-only
   7 .TH SMARTPQI 4 2021-03-22 "Linux" "Linux Programmer's Manual"
   8 .SH NAME
   9 smartpqi \- Microsemi Smart Family SCSI driver
  10 .SH SYNOPSIS
  11 .SY "modprobe smartpqi"
  12 .RB [ disable_device_id_wildcards= { 0 | 1 }]
  13 .RB [ disable_heartbeat= { 0 | 1 }]
  14 .RB [ disable_ctrl_shutdown= { 0 | 1 }]
  15 .RB [ lockup_action= { none | reboot | panic }]
  16 .RB [ expose_ld_first= { 0 | 1 }]
  17 .RB [ hide_vsep= { 0 | 1 }]
  18 .YS
  19 .SH DESCRIPTION
  20 .B smartpqi
  21 is a SCSI driver for Microsemi Smart Family controllers.
  22 .SS Supported \f[BI]ioctl\fP\/() operations
  23 For compatibility with applications written for the
  24 .BR cciss (4)
  25 and
  26 .BR hpsa (4)
  27 drivers, many, but not all of the
  28 .BR ioctl (2)
  29 operations supported by the
  30 .B hpsa
  31 driver are also supported by the
  32 .B smartpqi
  33 driver.
  34 The data structures used by these operations
  35 are described in the Linux kernel source file
  36 .IR include/linux/cciss_ioctl.h .
  37 .TP
  38 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
  39 These operations
  40 all do exactly the same thing, which is to cause the driver to re-scan
  41 for new devices.
  42 This does exactly the same thing as writing to the
  43 .BR smartpqi -specific
  44 host
  45 .I rescan
  46 attribute.
  47 .TP
  48 .B CCISS_GETPCIINFO
  49 This operation returns the PCI domain, bus,
  50 device, and function and "board ID" (PCI subsystem ID).
  51 .TP
  52 .B CCISS_GETDRIVVER
  53 This operation returns the driver version in four bytes, encoded as:
  54 .IP
  55 .in +4n
  56 .EX
  57 (major_version << 28) | (minor_version << 24) |
  58         (release << 16) | revision
  59 .EE
  60 .in
  61 .TP
  62 .B CCISS_PASSTHRU
  63 Allows BMIC and CISS commands to be passed through to the controller.
  64 .SS Boot options
  65 .TP
  66 .BR disable_device_id_wildcards= { 0 | 1 }
  67 Disables support for device ID wildcards.
  68 The default value is 0.
  69 .TP
  70 .BR disable_heartbeat= { 0 | 1 }
  71 Disables support for the controller's heartbeat check.
  72 This parameter is used for debugging purposes.
  73 The default value is 0, leaving the controller's heartbeat check active.
  74 .TP
  75 .BR disable_ctrl_shutdown= { 0 | 1 }
  76 Disables support for shutting down the controller in the
  77 event of a controller lockup.
  78 The default value is 0.
  79 .TP
  80 .BR lockup_action= { none | reboot | panic }
  81 Specifies the action the driver takes when a controller
  82 lockup is detected.
  83 The default action is
  84 .BR none .
  85 .TS
  86 l l
  87 ---
  88 l l.
  89 parameter       action
  90 \fBnone\fP      take controller offline only
  91 \fBreboot\fP    reboot the system
  92 \fBpanic\fP     panic the system
  93 .TE
  94 .TP
  95 .BR expose_ld_first= { 0 | 1 }
  96 This option enables support for exposing logical devices to
  97 the operating system before physical devices.
  98 The default value is 0.
  99 .TP
 100 .BR hide_vsep= { 0 | 1 }
 101 This option enables disabling exposure of the virtual SEP to the host.
 102 This is usually associated with direct attached drives.
 103 The default value is 0.
 104 .SH FILES
 105 .SS Device nodes
 106 Logical drives are accessed via the SCSI disk driver
 107 .RI ( sd ),
 108 tape drives via the SCSI tape driver
 109 .RI ( st ),
 110 and the RAID controller via the SCSI generic driver
 111 .RI ( sg ),
 112 with device nodes named
 113 .IR /dev/sd *,
 114 .IR /dev/st *,
 115 and
 116 .IR /dev/sg *,
 117 respectively.
 118 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
 119 .TP
 120 .IR /sys/class/scsi_host/host * /rescan
 121 The host
 122 .I rescan
 123 attribute is a write-only attribute.
 124 Writing to this attribute will cause the driver to scan for new,
 125 changed, or removed devices (e.g., hot-plugged tape drives, or newly
 126 configured or deleted logical drives) and notify the SCSI mid-layer of
 127 any changes detected.
 128 Usually this action is triggered automatically by configuration
 129 changes, so the user should not normally have to write to this file.
 130 Doing so may be useful when hot-plugging devices such as tape drives or
 131 entire storage boxes containing pre-configured logical drives.
 132 .TP
 133 .IR /sys/class/scsi_host/host * /version
 134 The host
 135 .I version
 136 attribute is a read-only attribute.
 137 This attribute contains the driver version and the controller firmware
 138 version.
 139 .IP
 140 For example:
 141 .IP
 142 .in +4n
 143 .EX
 144 $ \c
 145 .B cat /sys/class/scsi_host/host1/version
 146 driver: 1.1.2\-126
 147 firmware: 1.29\-112
 148 .EE
 149 .in
 150 .TP
 151 .IR /sys/class/scsi_host/host * /lockup_action
 152 The host
 153 .I lockup_action
 154 attribute is a read/write attribute.
 155 This attribute will cause the driver to perform a specific action in the
 156 unlikely event that a controller lockup has been detected.
 157 See
 158 .BR OPTIONS
 159 above
 160 for an explanation of the
 161 .I lockup_action
 162 values.
 163 .TP
 164 .IR /sys/class/scsi_host/host*/driver_version
 165 The
 166 .I driver_version
 167 attribute is read-only.
 168 This attribute contains the smartpqi driver version.
 169 .IP
 170 For example:
 171 .IP
 172 .in +4n
 173 .EX
 174 $ \c
 175 .B cat /sys/class/scsi_host/host1/driver_version
 176 1.1.2\-126
 177 .EE
 178 .in
 179 .TP
 180 .IR /sys/class/scsi_host/host*/firmware_version
 181 The
 182 .I firmware_version
 183 attribute is read-only.
 184 This attribute contains the controller firmware version.
 185 .IP
 186 For example:
 187 .IP
 188 .in +4n
 189 .EX
 190 $ \c
 191 .B cat /sys/class/scsi_host/host1/firmware_version
 192 1.29\-112
 193 .EE
 194 .in
 195 .TP
 196 .IR /sys/class/scsi_host/host*/model
 197 The
 198 .I model
 199 attribute is read-only.
 200 This attribute contains the product identification string of the controller.
 201 .IP
 202 For example:
 203 .IP
 204 .in +4n
 205 .EX
 206 $ \c
 207 .B cat /sys/class/scsi_host/host1/model
 208 1100\-16i
 209 .EE
 210 .in
 211 .TP
 212 .IR /sys/class/scsi_host/host*/serial_number
 213 The
 214 .I serial_number
 215 attribute is read-only.
 216 This attribute contains the unique identification number of the controller.
 217 .IP
 218 For example:
 219 .IP
 220 .in +4n
 221 .EX
 222 $ \c
 223 .B cat /sys/class/scsi_host/host1/serial_number
 224 6A316373777
 225 .EE
 226 .in
 227 .TP
 228 .IR /sys/class/scsi_host/host*/vendor
 229 The
 230 .I vendor
 231 attribute is read-only.
 232 This attribute contains the vendor identification string of the controller.
 233 .IP
 234 For example:
 235 .IP
 236 .in +4n
 237 .EX
 238 $ \c
 239 .B cat /sys/class/scsi_host/host1/vendor
 240 Adaptec
 241 .EE
 242 .in
 243 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 244 In the file specifications below,
 245 .I c
 246 stands for the number of the appropriate SCSI controller,
 247 .I b
 248 is the bus number,
 249 .I t
 250 the target number, and
 251 .I l
 252 is the logical unit number (LUN).
 253 .TP
 254 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
 255 The
 256 .I raid_level
 257 attribute is read-only.
 258 This attribute contains the RAID level of each logical drive.
 259 .IP
 260 For example:
 261 .IP
 262 .in +4n
 263 .EX
 264 $ \c
 265 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
 266 RAID 0
 267 .EE
 268 .in
 269 .TP
 270 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
 271 The
 272 .I sas_address
 273 attribute is read-only.
 274 This attribute contains the unique identifier of the disk.
 275 .IP
 276 For example:
 277 .IP
 278 .in +4n
 279 .EX
 280 $ \c
 281 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
 282 0x5001173d028543a2
 283 .EE
 284 .in
 285 .TP
 286 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
 287 The
 288 .I ssd_smart_path_enabled
 289 attribute is read-only.
 290 This attribute is for ioaccel-enabled volumes.
 291 (Ioaccel is an alternative driver submission path that allows the
 292 driver to send I/O requests directly to backend SCSI devices,
 293 bypassing the controller firmware.
 294 This results in an increase in performance.
 295 This method is used for HBA disks and for logical volumes comprised of SSDs.)
 296 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 297 .IP
 298 For example:
 299 .IP
 300 .in +4n
 301 .EX
 302 $ \c
 303 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
 304 0
 305 .EE
 306 .in
 307 .SH VERSIONS
 308 The
 309 .B smartpqi
 310 driver was added in Linux 4.9.
 311 .SH NOTES
 312 .SS Configuration
 313 To configure a Microsemi Smart Family controller,
 314 refer to the User Guide for the controller,
 315 which can be found by searching for the specific controller at
 316 .UR https://storage.microsemi.com/
 317 .UE .
 318 .SH SEE ALSO
 319 .BR cciss (4),
 320 .BR hpsa (4),
 321 .BR sd (4),
 322 .BR st (4)
 323 .PP
 324 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 325 in the Linux kernel source tree.