2 .\" Copyright (C) 2019, Microchip Technology Inc. and its subsidiaries
3 .\" Copyright (C) 2016-2018, Microsemi Corporation
4 .\" Copyright (C) 2016, PMC-Sierra, Inc.
5 .\" Written by Kevin Barnett <kevin.barnett@microsemi.com>
7 .\" SPDX-License-Identifier: GPL-2.0-only
8 .TH smartpqi 4 (date) "Linux man-pages (unreleased)"
10 smartpqi \- Microsemi Smart Family SCSI driver
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 .RB [ expose_ld_first= { 0 | 1 }]
18 .RB [ hide_vsep= { 0 | 1 }]
22 is a SCSI driver for Microsemi Smart Family controllers.
23 .SS Supported \f[BI]ioctl\fP\/() operations
24 For compatibility with applications written for the
28 drivers, many, but not all of the
30 operations supported by the
32 driver are also supported by the
35 The data structures used by these operations
36 are described in the Linux kernel source file
37 .IR include/linux/cciss_ioctl.h .
39 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
41 all do exactly the same thing, which is to cause the driver to re-scan
43 This does exactly the same thing as writing to the
44 .BR smartpqi -specific
50 This operation returns the PCI domain, bus,
51 device, and function and "board ID" (PCI subsystem ID).
54 This operation returns the driver version in four bytes, encoded as:
58 (major_version << 28) | (minor_version << 24) |
59 (release << 16) | revision
64 Allows BMIC and CISS commands to be passed through to the controller.
67 .BR disable_device_id_wildcards= { 0 | 1 }
68 Disables support for device ID wildcards.
69 The default value is 0.
71 .BR disable_heartbeat= { 0 | 1 }
72 Disables support for the controller's heartbeat check.
73 This parameter is used for debugging purposes.
74 The default value is 0, leaving the controller's heartbeat check active.
76 .BR disable_ctrl_shutdown= { 0 | 1 }
77 Disables support for shutting down the controller in the
78 event of a controller lockup.
79 The default value is 0.
81 .BR lockup_action= { none | reboot | panic }
82 Specifies the action the driver takes when a controller
91 \fBnone\fP take controller offline only
92 \fBreboot\fP reboot the system
93 \fBpanic\fP panic the system
96 .BR expose_ld_first= { 0 | 1 }
97 This option enables support for exposing logical devices to
98 the operating system before physical devices.
99 The default value is 0.
101 .BR hide_vsep= { 0 | 1 }
102 This option enables disabling exposure of the virtual SEP to the host.
103 This is usually associated with direct attached drives.
104 The default value is 0.
107 Logical drives are accessed via the SCSI disk driver
109 tape drives via the SCSI tape driver
111 and the RAID controller via the SCSI generic driver
113 with device nodes named
119 .SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
121 .IR /sys/class/scsi_host/host * /rescan
124 attribute is a write-only attribute.
125 Writing to this attribute will cause the driver to scan for new,
126 changed, or removed devices (e.g., hot-plugged tape drives, or newly
127 configured or deleted logical drives) and notify the SCSI mid-layer of
128 any changes detected.
129 Usually this action is triggered automatically by configuration
130 changes, so the user should not normally have to write to this file.
131 Doing so may be useful when hot-plugging devices such as tape drives or
132 entire storage boxes containing pre-configured logical drives.
134 .IR /sys/class/scsi_host/host * /version
137 attribute is a read-only attribute.
138 This attribute contains the driver version and the controller firmware
146 .B cat /sys/class/scsi_host/host1/version
152 .IR /sys/class/scsi_host/host * /lockup_action
155 attribute is a read/write attribute.
156 This attribute will cause the driver to perform a specific action in the
157 unlikely event that a controller lockup has been detected.
161 for an explanation of the
165 .I /sys/class/scsi_host/host*/driver_version
168 attribute is read-only.
169 This attribute contains the smartpqi driver version.
176 .B cat /sys/class/scsi_host/host1/driver_version
181 .I /sys/class/scsi_host/host*/firmware_version
184 attribute is read-only.
185 This attribute contains the controller firmware version.
192 .B cat /sys/class/scsi_host/host1/firmware_version
197 .I /sys/class/scsi_host/host*/model
200 attribute is read-only.
201 This attribute contains the product identification string of the controller.
208 .B cat /sys/class/scsi_host/host1/model
213 .I /sys/class/scsi_host/host*/serial_number
216 attribute is read-only.
217 This attribute contains the unique identification number of the controller.
224 .B cat /sys/class/scsi_host/host1/serial_number
229 .I /sys/class/scsi_host/host*/vendor
232 attribute is read-only.
233 This attribute contains the vendor identification string of the controller.
240 .B cat /sys/class/scsi_host/host1/vendor
244 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
245 In the file specifications below,
247 stands for the number of the appropriate SCSI controller,
251 the target number, and
253 is the logical unit number (LUN).
255 .IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
258 attribute is read-only.
259 This attribute contains the RAID level of each logical drive.
266 .B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
271 .IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
274 attribute is read-only.
275 This attribute contains the unique identifier of the disk.
282 .B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
287 .IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
289 .I ssd_smart_path_enabled
290 attribute is read-only.
291 This attribute is for ioaccel-enabled volumes.
292 (Ioaccel is an alternative driver submission path that allows the
293 driver to send I/O requests directly to backend SCSI devices,
294 bypassing the controller firmware.
295 This results in an increase in performance.
296 This method is used for HBA disks and for logical volumes comprised of SSDs.)
297 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
304 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
311 driver was added in Linux 4.9.
314 To configure a Microsemi Smart Family controller,
315 refer to the User Guide for the controller,
316 which can be found by searching for the specific controller at
317 .UR https://storage.microsemi.com/
325 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
326 in the Linux kernel source tree.