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 .RE
  94 .SH FILES
  95 .SS Device nodes
  96 Logical drives are accessed via the SCSI disk driver
  97 .RI ( sd ),
  98 tape drives via the SCSI tape driver
  99 .RI ( st ),
 100 and the RAID controller via the SCSI generic driver
 101 .RI ( sg ),
 102 with device nodes named
 103 .IR /dev/sd *,
 104 .IR /dev/st *,
 105 and
 106 .IR /dev/sg *,
 107 respectively.
 108 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
 109 .TP
 110 .IR /sys/class/scsi_host/host * /rescan
 111 The host
 112 .I rescan
 113 attribute is a write-only attribute.
 114 Writing to this attribute will cause the driver to scan for new,
 115 changed, or removed devices (e.g., hot-plugged tape drives, or newly
 116 configured or deleted logical drives) and notify the SCSI mid-layer of
 117 any changes detected.
 118 Usually this action is triggered automatically by configuration
 119 changes, so the user should not normally have to write to this file.
 120 Doing so may be useful when hot-plugging devices such as tape drives or
 121 entire storage boxes containing pre-configured logical drives.
 122 .TP
 123 .IR /sys/class/scsi_host/host * /version
 124 The host
 125 .I version
 126 attribute is a read-only attribute.
 127 This attribute contains the driver version and the controller firmware
 128 version.
 129 .IP
 130 For example:
 131 .IP
 132 .in +4n
 133 .EX
 134 $ \c
 135 .B cat /sys/class/scsi_host/host1/version
 136 driver: 1.1.2\-126
 137 firmware: 1.29\-112
 138 .EE
 139 .in
 140 .TP
 141 .IR /sys/class/scsi_host/host * /lockup_action
 142 The host
 143 .I lockup_action
 144 attribute is a read/write attribute.
 145 This attribute will cause the driver to perform a specific action in the
 146 unlikely event that a controller lockup has been detected.
 147 See
 148 .BR OPTIONS
 149 above
 150 for an explanation of the
 151 .I lockup_action
 152 values.
 153 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 154 In the file specifications below,
 155 .I c
 156 stands for the number of the appropriate SCSI controller,
 157 .I b
 158 is the bus number,
 159 .I t
 160 the target number, and
 161 .I l
 162 is the logical unit number (LUN).
 163 .TP
 164 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
 165 The
 166 .I raid_level
 167 attribute is read-only.
 168 This attribute contains the RAID level of each logical drive.
 169 .IP
 170 For example:
 171 .IP
 172 .in +4n
 173 .EX
 174 $ \c
 175 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
 176 RAID 0
 177 .EE
 178 .in
 179 .TP
 180 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
 181 The
 182 .I sas_address
 183 attribute is read-only.
 184 This attribute contains the unique identifier of the disk.
 185 .IP
 186 For example:
 187 .IP
 188 .in +4n
 189 .EX
 190 $ \c
 191 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
 192 0x5001173d028543a2
 193 .EE
 194 .in
 195 .TP
 196 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
 197 The
 198 .I ssd_smart_path_enabled
 199 attribute is read-only.
 200 .\" FIXME
 201 .\" What is "ioaccel"?  This string appears nowhere in man-pages HEAD.
 202 This attribute is for ioaccel-enabled volumes.
 203 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 204 .IP
 205 For example:
 206 .IP
 207 .in +2n
 208 .EX
 209 $ \c
 210 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
 211 0
 212 .EE
 213 .in
 214 .SH VERSIONS
 215 The
 216 .B smarpqi
 217 driver was added in Linux 4.9.
 218 .SH NOTES
 219 .SS Configuration
 220 To configure Microsemi Smart Family controllers, please refer to the
 221 controller's User Guide documentation.
 222 .\" FIXME
 223 .\" Does this manual have a title?  Is it freely available online?
 224 .\" Does it have a stable URL?  Can this information be moved to the SEE
 225 .\" ALSO section?
 226 .SH SEE ALSO
 227 .BR cciss (4),
 228 .BR hpsa (4),
 229 .BR sd (4),
 230 .BR st (4)
 231 .PP
 232 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 233 in the Linux kernel source tree.