]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man4/smartpqi.4
mlock.2: tfix
[thirdparty/man-pages.git] / man4 / smartpqi.4
index 139375258689cb41345f2fd24303142e43cc0dfa..cf7c43034205eb606fda27f81c73e2ee21479cdf 100644 (file)
@@ -18,7 +18,49 @@ smartpqi \- Microsemi Smart Family SCSI driver
 .SH DESCRIPTION
 .B smartpqi
 is a SCSI driver for Microsemi Smart Family controllers.
-.SH OPTIONS
+.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
 .TP
 .BR disable_device_id_wildcards= { 0 | 1 }
 Disables support for device ID wildcards.
@@ -48,14 +90,6 @@ parameter    action
 \fBreboot\fP   reboot the system
 \fBpanic\fP    panic the system
 .TE
-.SH CONFIGURATION
-To configure Microsemi Smart Family controllers, please refer to the
-controller's User Guide documentation.
-.\" FIXME
-.\" Does this manual have a title?  Is it freely available online?
-.\" Does it have a stable URL?  Can this information be moved to the SEE
-.\" ALSO section?
-.RE
 .SH FILES
 .SS Device nodes
 Logical drives are accessed via the SCSI disk driver
@@ -162,60 +196,34 @@ $ \c
 The
 .I ssd_smart_path_enabled
 attribute is read-only.
-.\" FIXME
-.\" What is "ioaccel"?  This string appears nowhere in man-pages HEAD.
 This attribute is for ioaccel-enabled volumes.
+(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.)
 Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 .IP
 For example:
 .IP
-.in +4n
+.in +2n
 .EX
 $ \c
-.\" This example line is too wide for an 80-column TTY.
 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled
 0
 .EE
 .in
-.SS Supported \f[BI]ioctl\fP\/() operations
-.\" Does this subsection belong here, under .SH FILES ?
-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:
-.EX
-(major_version << 28) | (minor_version << 24) | (release << 16) | revision
-.EE
-.TP
-.B CCISS_PASSTHRU
-Allows BMIC and CISS commands to be passed through to the controller.
+.SH VERSIONS
+The
+.B smarpqi
+driver was added in Linux 4.9.
+.SH NOTES
+.SS Configuration
+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 .
 .SH SEE ALSO
 .BR cciss (4),
 .BR hpsa (4),