man4/smartpqi.4

   1 .\" Copyright (C) 2016-2017, Microsemi Corporation
   2 .\" Copyright (C) 2016, PMC-Sierra, Inc.
   3 .\" Written by Kevin Barnett <kevin.barnett@microsemi.com>
   4 .\"
   5 .\" %%%LICENSE_START(GPLv2_ONELINE)
   6 .\" Licensed under GNU General Public License version 2 (GPLv2)
   7 .\" %%%LICENSE_END
   8 .TH SMARTPQI 4 2017-10-19 "Linux" "Linux Programmer's Manual"
   9 .SH NAME
  10 smartpqi \- Microsemi Smart Family 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 .YS
  18 .SH DESCRIPTION
  19 .B smartpqi
  20 is a SCSI driver for Microsemi Smart Family controllers.
  21 .SS Supported \f[BI]ioctl\fP\/() operations
  22 For compatibility with applications written for the
  23 .BR cciss (4)
  24 and
  25 .BR hpsa (4)
  26 drivers, many, but not all of the
  27 .BR ioctl (2)
  28 operations supported by the
  29 .B hpsa
  30 driver are also supported by the
  31 .B smartpqi
  32 driver.
  33 The data structures used by these operations
  34 are described in the Linux kernel source file
  35 .IR include/linux/cciss_ioctl.h .
  36 .TP
  37 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
  38 These operations
  39 all do exactly the same thing, which is to cause the driver to re-scan
  40 for new devices.
  41 This does exactly the same thing as writing to the
  42 .BR smartpqi -specific
  43 host
  44 .I rescan
  45 attribute.
  46 .TP
  47 .B CCISS_GETPCIINFO
  48 This operation Returns the PCI domain, bus,
  49 device and function and "board ID" (PCI subsystem ID).
  50 .TP
  51 .B CCISS_GETDRIVVER
  52 This operation returns the driver version in four bytes, encoded as:
  53 .IP
  54 .in +4n
  55 .EX
  56 (major_version << 28) | (minor_version << 24) |
  57         (release << 16) | revision
  58 .EE
  59 .in
  60 .TP
  61 .B CCISS_PASSTHRU
  62 Allows BMIC and CISS commands to be passed through to the controller.
  63 .SS Boot options
  64 .TP
  65 .BR disable_device_id_wildcards= { 0 | 1 }
  66 Disables support for device ID wildcards.
  67 The default value is 0.
  68 .TP
  69 .BR disable_heartbeat= { 0 | 1 }
  70 Disables support for the controller's heartbeat check.
  71 This parameter is used for debugging purposes.
  72 The default value is 0, leaving the controller's heartbeat check active.
  73 .TP
  74 .BR disable_ctrl_shutdown= { 0 | 1 }
  75 Disables support for shutting down the controller in the
  76 event of a controller lockup.
  77 The default value is 0.
  78 .TP
  79 .BR lockup_action= { none | reboot | panic }
  80 Specifies the action the driver takes when a controller
  81 lockup is detected.
  82 The default action is
  83 .BR none .
  84 .TS
  85 l l
  86 ---
  87 l l.
  88 parameter       action
  89 \fBnone\fP      take controller offline only
  90 \fBreboot\fP    reboot the system
  91 \fBpanic\fP     panic the system
  92 .TE
  93 .SH FILES
  94 .SS Device nodes
  95 Logical drives are accessed via the SCSI disk driver
  96 .RI ( sd ),
  97 tape drives via the SCSI tape driver
  98 .RI ( st ),
  99 and the RAID controller via the SCSI generic driver
 100 .RI ( sg ),
 101 with device nodes named
 102 .IR /dev/sd *,
 103 .IR /dev/st *,
 104 and
 105 .IR /dev/sg *,
 106 respectively.
 107 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
 108 .TP
 109 .IR /sys/class/scsi_host/host * /rescan
 110 The host
 111 .I rescan
 112 attribute is a write-only attribute.
 113 Writing to this attribute will cause the driver to scan for new,
 114 changed, or removed devices (e.g., hot-plugged tape drives, or newly
 115 configured or deleted logical drives) and notify the SCSI mid-layer of
 116 any changes detected.
 117 Usually this action is triggered automatically by configuration
 118 changes, so the user should not normally have to write to this file.
 119 Doing so may be useful when hot-plugging devices such as tape drives or
 120 entire storage boxes containing pre-configured logical drives.
 121 .TP
 122 .IR /sys/class/scsi_host/host * /version
 123 The host
 124 .I version
 125 attribute is a read-only attribute.
 126 This attribute contains the driver version and the controller firmware
 127 version.
 128 .IP
 129 For example:
 130 .IP
 131 .in +4n
 132 .EX
 133 $ \c
 134 .B cat /sys/class/scsi_host/host1/version
 135 driver: 1.1.2\-126
 136 firmware: 1.29\-112
 137 .EE
 138 .in
 139 .TP
 140 .IR /sys/class/scsi_host/host * /lockup_action
 141 The host
 142 .I lockup_action
 143 attribute is a read/write attribute.
 144 This attribute will cause the driver to perform a specific action in the
 145 unlikely event that a controller lockup has been detected.
 146 See
 147 .BR OPTIONS
 148 above
 149 for an explanation of the
 150 .I lockup_action
 151 values.
 152 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 153 In the file specifications below,
 154 .I c
 155 stands for the number of the appropriate SCSI controller,
 156 .I b
 157 is the bus number,
 158 .I t
 159 the target number, and
 160 .I l
 161 is the logical unit number (LUN).
 162 .TP
 163 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
 164 The
 165 .I raid_level
 166 attribute is read-only.
 167 This attribute contains the RAID level of each logical drive.
 168 .IP
 169 For example:
 170 .IP
 171 .in +4n
 172 .EX
 173 $ \c
 174 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
 175 RAID 0
 176 .EE
 177 .in
 178 .TP
 179 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
 180 The
 181 .I sas_address
 182 attribute is read-only.
 183 This attribute contains the unique identifier of the disk.
 184 .IP
 185 For example:
 186 .IP
 187 .in +4n
 188 .EX
 189 $ \c
 190 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
 191 0x5001173d028543a2
 192 .EE
 193 .in
 194 .TP
 195 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
 196 The
 197 .I ssd_smart_path_enabled
 198 attribute is read-only.
 199 This attribute is for ioaccel-enabled volumes.
 200 (Ioaccel is an alternative driver submission path that allows the
 201 driver to send I/O requests directly to backend SCSI devices,
 202 bypassing the controller firmware.
 203 This results in an increase in performance.
 204 This method is used for HBA disks and for logical volumes comprised of SSDs.)
 205 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 206 .IP
 207 For example:
 208 .IP
 209 .in +2n
 210 .EX
 211 $ \c
 212 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
 213 0
 214 .EE
 215 .in
 216 .SH VERSIONS
 217 The
 218 .B smarpqi
 219 driver was added in Linux 4.9.
 220 .SH NOTES
 221 .SS Configuration
 222 To configure a Microsemi Smart Family controller,
 223 refer to the User Guide for the controller,
 224 which can be found by searching for the specific controller at
 225 .UR https://storage.microsemi.com/
 226 .UE .
 227 .SH SEE ALSO
 228 .BR cciss (4),
 229 .BR hpsa (4),
 230 .BR sd (4),
 231 .BR st (4)
 232 .PP
 233 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 234 in the Linux kernel source tree.