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>
6 .\" SPDX-License-Identifier: GPL-2.0-only
7 .TH smartpqi 4 (date) "Linux man-pages (unreleased)"
9 smartpqi \- Microsemi Smart Family SCSI driver
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 }]
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
27 drivers, many, but not all of the
29 operations supported by the
31 driver are also supported by the
34 The data structures used by these operations
35 are described in the Linux kernel source file
36 .IR include/linux/cciss_ioctl.h .
38 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
40 all do exactly the same thing, which is to cause the driver to re-scan
42 This does exactly the same thing as writing to the
43 .BR smartpqi -specific
49 This operation returns the PCI domain, bus,
50 device, and function and "board ID" (PCI subsystem ID).
53 This operation returns the driver version in four bytes, encoded as:
57 (major_version << 28) | (minor_version << 24) |
58 (release << 16) | revision
63 Allows BMIC and CISS commands to be passed through to the controller.
66 .BR disable_device_id_wildcards= { 0 | 1 }
67 Disables support for device ID wildcards.
68 The default value is 0.
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.
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.
80 .BR lockup_action= { none | reboot | panic }
81 Specifies the action the driver takes when a controller
90 \fBnone\fP take controller offline only
91 \fBreboot\fP reboot the system
92 \fBpanic\fP panic the system
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.
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.
106 Logical drives are accessed via the SCSI disk driver
108 tape drives via the SCSI tape driver
110 and the RAID controller via the SCSI generic driver
112 with device nodes named
118 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
120 .IR /sys/class/scsi_host/host * /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.
133 .IR /sys/class/scsi_host/host * /version
136 attribute is a read-only attribute.
137 This attribute contains the driver version and the controller firmware
145 .B cat /sys/class/scsi_host/host1/version
151 .IR /sys/class/scsi_host/host * /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.
160 for an explanation of the
164 .I /sys/class/scsi_host/host*/driver_version
167 attribute is read-only.
168 This attribute contains the smartpqi driver version.
175 .B cat /sys/class/scsi_host/host1/driver_version
180 .I /sys/class/scsi_host/host*/firmware_version
183 attribute is read-only.
184 This attribute contains the controller firmware version.
191 .B cat /sys/class/scsi_host/host1/firmware_version
196 .I /sys/class/scsi_host/host*/model
199 attribute is read-only.
200 This attribute contains the product identification string of the controller.
207 .B cat /sys/class/scsi_host/host1/model
212 .I /sys/class/scsi_host/host*/serial_number
215 attribute is read-only.
216 This attribute contains the unique identification number of the controller.
223 .B cat /sys/class/scsi_host/host1/serial_number
228 .I /sys/class/scsi_host/host*/vendor
231 attribute is read-only.
232 This attribute contains the vendor identification string of the controller.
239 .B cat /sys/class/scsi_host/host1/vendor
243 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
244 In the file specifications below,
246 stands for the number of the appropriate SCSI controller,
250 the target number, and
252 is the logical unit number (LUN).
254 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
257 attribute is read-only.
258 This attribute contains the RAID level of each logical drive.
265 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
270 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
273 attribute is read-only.
274 This attribute contains the unique identifier of the disk.
281 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
286 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
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.
303 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
310 driver was added in Linux 4.9.
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/
324 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
325 in the Linux kernel source tree.