2019-08-26 15:41:32 +00:00
|
|
|
.\" Copyright (C) 2019, Microchip Technology Inc. and its subsidiaries
|
|
|
|
.\" Copyright (C) 2016-2018, Microsemi Corporation
|
2017-10-18 15:10:39 +00:00
|
|
|
.\" Copyright (C) 2016, PMC-Sierra, Inc.
|
|
|
|
.\" Written by Kevin Barnett <kevin.barnett@microsemi.com>
|
|
|
|
.\"
|
|
|
|
.\" %%%LICENSE_START(GPLv2_ONELINE)
|
|
|
|
.\" Licensed under GNU General Public License version 2 (GPLv2)
|
|
|
|
.\" %%%LICENSE_END
|
localedef.1, close.2, copy_file_range.2, execve.2, get_robust_list.2, getdomainname.2, gethostname.2, inotify_add_watch.2, io_submit.2, ioctl_fideduperange.2, kcmp.2, kill.2, mmap.2, move_pages.2, perf_event_open.2, ptrace.2, rt_sigqueueinfo.2, sched_setaffinity.2, sched_setparam.2, setns.2, sigaction.2, signalfd.2, statx.2, syscall.2, syscalls.2, uname.2, write.2, errno.3, fexecve.3, getauxval.3, printf.3, pthread_mutex_consistent.3, pthread_mutexattr_init.3, pthread_mutexattr_setrobust.3, pthread_setcancelstate.3, regex.3, strtok.3, strtol.3, ttyname.3, smartpqi.4, core.5, resolv.conf.5, man-pages.7, mq_overview.7, operator.7, pthreads.7, signal-safety.7, sysvipc.7: Update timestamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2019-10-10 20:28:39 +00:00
|
|
|
.TH SMARTPQI 4 2019-10-10 "Linux" "Linux Programmer's Manual"
|
2017-10-18 15:10:39 +00:00
|
|
|
.SH NAME
|
|
|
|
smartpqi \- Microsemi Smart Family SCSI driver
|
|
|
|
.SH SYNOPSIS
|
2017-11-07 22:20:46 +00:00
|
|
|
.SY "modprobe smartpqi"
|
|
|
|
.RB [ disable_device_id_wildcards= { 0 | 1 }]
|
|
|
|
.RB [ disable_heartbeat= { 0 | 1 }]
|
|
|
|
.RB [ disable_ctrl_shutdown= { 0 | 1 }]
|
|
|
|
.RB [ lockup_action= { none | reboot | panic }]
|
2019-08-26 15:41:39 +00:00
|
|
|
.RB [ expose_ld_first= { 0 | 1 }]
|
2019-08-26 15:41:45 +00:00
|
|
|
.RB [ hide_vsep= { 0 | 1 }]
|
2017-11-07 22:20:46 +00:00
|
|
|
.YS
|
2017-10-18 15:10:39 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.B smartpqi
|
|
|
|
is a SCSI driver for Microsemi Smart Family controllers.
|
2017-11-13 06:54:29 +00:00
|
|
|
.SS Supported \f[BI]ioctl\fP\/() operations
|
|
|
|
For compatibility with applications written for the
|
|
|
|
.BR cciss (4)
|
|
|
|
and
|
|
|
|
.BR hpsa (4)
|
|
|
|
drivers, many, but not all of the
|
|
|
|
.BR ioctl (2)
|
|
|
|
operations supported by the
|
|
|
|
.B hpsa
|
|
|
|
driver are also supported by the
|
|
|
|
.B smartpqi
|
|
|
|
driver.
|
|
|
|
The data structures used by these operations
|
|
|
|
are described in the Linux kernel source file
|
|
|
|
.IR include/linux/cciss_ioctl.h .
|
|
|
|
.TP
|
|
|
|
.BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
|
|
|
|
These operations
|
|
|
|
all do exactly the same thing, which is to cause the driver to re-scan
|
|
|
|
for new devices.
|
|
|
|
This does exactly the same thing as writing to the
|
|
|
|
.BR smartpqi -specific
|
|
|
|
host
|
|
|
|
.I rescan
|
|
|
|
attribute.
|
|
|
|
.TP
|
|
|
|
.B CCISS_GETPCIINFO
|
|
|
|
This operation Returns the PCI domain, bus,
|
|
|
|
device and function and "board ID" (PCI subsystem ID).
|
|
|
|
.TP
|
|
|
|
.B CCISS_GETDRIVVER
|
|
|
|
This operation returns the driver version in four bytes, encoded as:
|
|
|
|
.IP
|
|
|
|
.in +4n
|
|
|
|
.EX
|
|
|
|
(major_version << 28) | (minor_version << 24) |
|
|
|
|
(release << 16) | revision
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.B CCISS_PASSTHRU
|
|
|
|
Allows BMIC and CISS commands to be passed through to the controller.
|
|
|
|
.SS Boot options
|
2017-11-07 22:20:46 +00:00
|
|
|
.TP
|
|
|
|
.BR disable_device_id_wildcards= { 0 | 1 }
|
|
|
|
Disables support for device ID wildcards.
|
2017-10-18 15:10:39 +00:00
|
|
|
The default value is 0.
|
2017-11-07 22:20:46 +00:00
|
|
|
.TP
|
|
|
|
.BR disable_heartbeat= { 0 | 1 }
|
|
|
|
Disables support for the controller's heartbeat check.
|
|
|
|
This parameter is used for debugging purposes.
|
|
|
|
The default value is 0, leaving the controller's heartbeat check active.
|
|
|
|
.TP
|
|
|
|
.BR disable_ctrl_shutdown= { 0 | 1 }
|
|
|
|
Disables support for shutting down the controller in the
|
|
|
|
event of a controller lockup.
|
2017-10-18 15:10:39 +00:00
|
|
|
The default value is 0.
|
2017-11-07 22:20:46 +00:00
|
|
|
.TP
|
|
|
|
.BR lockup_action= { none | reboot | panic }
|
|
|
|
Specifies the action the driver takes when a controller
|
|
|
|
lockup is detected.
|
|
|
|
The default action is
|
|
|
|
.BR none .
|
|
|
|
.TS
|
|
|
|
l l
|
|
|
|
---
|
|
|
|
l l.
|
|
|
|
parameter action
|
|
|
|
\fBnone\fP take controller offline only
|
|
|
|
\fBreboot\fP reboot the system
|
|
|
|
\fBpanic\fP panic the system
|
|
|
|
.TE
|
2019-08-26 15:41:39 +00:00
|
|
|
.TP
|
|
|
|
.BR expose_ld_first= { 0 | 1 }
|
2019-08-26 21:51:42 +00:00
|
|
|
This option enables support for exposing logical devices to
|
2019-08-26 22:01:24 +00:00
|
|
|
the operating system before physical devices.
|
2019-08-26 15:41:39 +00:00
|
|
|
The default value is 0.
|
2019-08-26 15:41:45 +00:00
|
|
|
.TP
|
|
|
|
.BR hide_vsep= { 0 | 1 }
|
2019-08-26 21:51:42 +00:00
|
|
|
This option enables disabling exposure of the virtual SEP to the host.
|
|
|
|
This is usually associated with direct attached drives.
|
2019-08-26 15:41:45 +00:00
|
|
|
The default value is 0.
|
2017-10-18 15:10:39 +00:00
|
|
|
.SH FILES
|
2017-11-07 22:20:46 +00:00
|
|
|
.SS Device nodes
|
|
|
|
Logical drives are accessed via the SCSI disk driver
|
|
|
|
.RI ( sd ),
|
|
|
|
tape drives via the SCSI tape driver
|
|
|
|
.RI ( st ),
|
|
|
|
and the RAID controller via the SCSI generic driver
|
|
|
|
.RI ( sg ),
|
|
|
|
with device nodes named
|
|
|
|
.IR /dev/sd *,
|
|
|
|
.IR /dev/st *,
|
|
|
|
and
|
|
|
|
.IR /dev/sg *,
|
|
|
|
respectively.
|
|
|
|
.SS SmartPQI-specific host attribute files in \f[BI]/sys\fP
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host * /rescan
|
|
|
|
The host
|
|
|
|
.I rescan
|
|
|
|
attribute is a write-only attribute.
|
|
|
|
Writing to this attribute will cause the driver to scan for new,
|
|
|
|
changed, or removed devices (e.g., hot-plugged tape drives, or newly
|
|
|
|
configured or deleted logical drives) and notify the SCSI mid-layer of
|
|
|
|
any changes detected.
|
2017-11-13 06:21:21 +00:00
|
|
|
Usually this action is triggered automatically by configuration
|
2017-11-07 22:20:46 +00:00
|
|
|
changes, so the user should not normally have to write to this file.
|
2017-11-13 06:21:21 +00:00
|
|
|
Doing so may be useful when hot-plugging devices such as tape drives or
|
2017-11-07 22:20:46 +00:00
|
|
|
entire storage boxes containing pre-configured logical drives.
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host * /version
|
|
|
|
The host
|
|
|
|
.I version
|
|
|
|
attribute is a read-only attribute.
|
|
|
|
This attribute contains the driver version and the controller firmware
|
|
|
|
version.
|
|
|
|
.IP
|
2017-10-18 15:10:39 +00:00
|
|
|
For example:
|
2017-11-13 06:14:44 +00:00
|
|
|
.IP
|
2017-11-07 22:20:46 +00:00
|
|
|
.in +4n
|
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/version
|
|
|
|
driver: 1.1.2\-126
|
|
|
|
firmware: 1.29\-112
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host * /lockup_action
|
|
|
|
The host
|
|
|
|
.I lockup_action
|
|
|
|
attribute is a read/write attribute.
|
|
|
|
This attribute will cause the driver to perform a specific action in the
|
|
|
|
unlikely event that a controller lockup has been detected.
|
|
|
|
See
|
|
|
|
.BR OPTIONS
|
|
|
|
above
|
|
|
|
for an explanation of the
|
|
|
|
.I lockup_action
|
|
|
|
values.
|
2019-08-26 15:41:52 +00:00
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host*/driver_version
|
|
|
|
The
|
|
|
|
.I driver_version
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute contains the smartpqi driver version.
|
|
|
|
.IP
|
|
|
|
For example:
|
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2019-08-26 15:41:52 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/driver_version
|
|
|
|
1.1.2-126
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host*/firmware_version
|
|
|
|
The
|
|
|
|
.I firmware_version
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute contains the controller firmware version.
|
|
|
|
.IP
|
|
|
|
For example:
|
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2019-08-26 15:41:52 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/firmware_version
|
|
|
|
1.29-112
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host*/model
|
|
|
|
The
|
|
|
|
.I model
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute contains the product identification string of the controller.
|
|
|
|
.IP
|
|
|
|
For example:
|
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2019-08-26 15:41:52 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/model
|
|
|
|
1100-16i
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host*/serial_number
|
|
|
|
The
|
|
|
|
.I serial_number
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute contains the unique identification number of the controller.
|
|
|
|
.IP
|
|
|
|
For example:
|
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2019-08-26 15:41:52 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/serial_number
|
|
|
|
6A316373777
|
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_host/host*/vendor
|
|
|
|
The
|
|
|
|
.I vendor
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute contains the vendor identification string of the controller.
|
|
|
|
.IP
|
|
|
|
For example:
|
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2019-08-26 15:41:52 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_host/host1/vendor
|
|
|
|
Adaptec
|
|
|
|
.EE
|
|
|
|
.in
|
2017-11-07 22:20:46 +00:00
|
|
|
.SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
|
|
|
|
In the file specifications below,
|
|
|
|
.I c
|
|
|
|
stands for the number of the appropriate SCSI controller,
|
|
|
|
.I b
|
2017-11-13 06:21:21 +00:00
|
|
|
is the bus number,
|
2017-11-07 22:20:46 +00:00
|
|
|
.I t
|
|
|
|
the target number, and
|
|
|
|
.I l
|
2017-11-13 06:21:21 +00:00
|
|
|
is the logical unit number (LUN).
|
2017-11-07 22:20:46 +00:00
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_disk/ c : b : t : l /device/raid_level
|
|
|
|
The
|
|
|
|
.I raid_level
|
|
|
|
attribute is read-only.
|
2017-10-18 15:10:39 +00:00
|
|
|
This attribute contains the RAID level of each logical drive.
|
2017-11-07 22:20:46 +00:00
|
|
|
.IP
|
2017-10-18 15:10:39 +00:00
|
|
|
For example:
|
2017-11-13 06:14:44 +00:00
|
|
|
.IP
|
2017-11-07 22:20:46 +00:00
|
|
|
.in +4n
|
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_disk/4:0:0:0/device/raid_level
|
2017-10-18 15:10:39 +00:00
|
|
|
RAID 0
|
2017-11-07 22:20:46 +00:00
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_disk/c : b : t : l/device/sas_address
|
|
|
|
The
|
|
|
|
.I sas_address
|
|
|
|
attribute is read-only.
|
2017-10-18 15:10:39 +00:00
|
|
|
This attribute contains the unique identifier of the disk.
|
2017-11-07 22:20:46 +00:00
|
|
|
.IP
|
2017-10-18 15:10:39 +00:00
|
|
|
For example:
|
2017-11-13 06:14:44 +00:00
|
|
|
.IP
|
2017-11-07 22:20:46 +00:00
|
|
|
.in +4n
|
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_disk/1:0:3:0/device/sas_address
|
2017-10-18 15:10:39 +00:00
|
|
|
0x5001173d028543a2
|
2017-11-07 22:20:46 +00:00
|
|
|
.EE
|
|
|
|
.in
|
|
|
|
.TP
|
|
|
|
.IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled
|
|
|
|
The
|
|
|
|
.I ssd_smart_path_enabled
|
|
|
|
attribute is read-only.
|
|
|
|
This attribute is for ioaccel-enabled volumes.
|
2017-11-15 11:57:17 +00:00
|
|
|
(Ioaccel is an alternative driver submission path that allows the
|
|
|
|
driver to send I/O requests directly to backend SCSI devices,
|
|
|
|
bypassing the controller firmware.
|
|
|
|
This results in an increase in performance.
|
|
|
|
This method is used for HBA disks and for logical volumes comprised of SSDs.)
|
2017-11-07 22:20:46 +00:00
|
|
|
Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
|
|
|
|
.IP
|
2017-10-18 15:10:39 +00:00
|
|
|
For example:
|
2017-11-13 06:14:44 +00:00
|
|
|
.IP
|
2019-08-26 21:50:48 +00:00
|
|
|
.in +4n
|
2017-11-07 22:20:46 +00:00
|
|
|
.EX
|
|
|
|
$ \c
|
|
|
|
.B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
|
2017-10-18 15:10:39 +00:00
|
|
|
0
|
2017-11-07 22:20:46 +00:00
|
|
|
.EE
|
|
|
|
.in
|
2017-11-13 06:56:31 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
The
|
2019-08-26 15:41:26 +00:00
|
|
|
.B smartpqi
|
2017-11-13 06:56:31 +00:00
|
|
|
driver was added in Linux 4.9.
|
2017-11-13 06:54:29 +00:00
|
|
|
.SH NOTES
|
|
|
|
.SS Configuration
|
2017-11-17 19:24:59 +00:00
|
|
|
To configure a Microsemi Smart Family controller,
|
|
|
|
refer to the User Guide for the controller,
|
|
|
|
which can be found by searching for the specific controller at
|
|
|
|
.UR https://storage.microsemi.com/
|
|
|
|
.UE .
|
2017-11-07 22:20:46 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
.BR cciss (4),
|
|
|
|
.BR hpsa (4),
|
|
|
|
.BR sd (4),
|
|
|
|
.BR st (4)
|
|
|
|
.PP
|
|
|
|
.I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
|
|
|
|
in the Linux kernel source tree.
|