Many pages: Use a consistent style for lists

[thirdparty/man-pages.git] / man4 / smartpqi.4

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 704efb735af6e905add61e45a1c72a63cb53d492..409bcaeb270a04b26ffa9b561792552efa417689 100644 (file)
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -1,11 +1,10 @@
-.\" Copyright (C) 2016-2017, Microsemi Corporation
+.\" Copyright (C) 2019, Microchip Technology Inc. and its subsidiaries
+.\" Copyright (C) 2016-2018, Microsemi Corporation
 .\" 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
-.TH SMARTPQI 4 2017-10-19 "Linux" "Linux Programmer's Manual"
+.\" SPDX-License-Identifier: GPL-2.0-only
+.TH SMARTPQI 4 (date) "Linux man-pages (unreleased)"
 .SH NAME
 smartpqi \- Microsemi Smart Family SCSI driver
 .SH SYNOPSIS
@@ -14,6 +13,8 @@ smartpqi \- Microsemi Smart Family SCSI driver
 .RB [ disable_heartbeat= { 0 | 1 }]
 .RB [ disable_ctrl_shutdown= { 0 | 1 }]
 .RB [ lockup_action= { none | reboot | panic }]
+.RB [ expose_ld_first= { 0 | 1 }]
+.RB [ hide_vsep= { 0 | 1 }]
 .YS
 .SH DESCRIPTION
 .B smartpqi
@@ -45,8 +46,8 @@ host
 attribute.
 .TP
 .B CCISS_GETPCIINFO
-This operation Returns the PCI domain, bus,
-device and function and "board ID" (PCI subsystem ID).
+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:
@@ -90,6 +91,16 @@ parameter    action
 \fBreboot\fP   reboot the system
 \fBpanic\fP    panic the system
 .TE
+.TP
+.BR expose_ld_first= { 0 | 1 }
+This option enables support for exposing logical devices to
+the operating system before physical devices.
+The default value is 0.
+.TP
+.BR hide_vsep= { 0 | 1 }
+This option enables disabling exposure of the virtual SEP to the host.
+This is usually associated with direct attached drives.
+The default value is 0.
 .SH FILES
 .SS Device nodes
 Logical drives are accessed via the SCSI disk driver
@@ -144,11 +155,91 @@ 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
+.B OPTIONS
 above
 for an explanation of the
 .I lockup_action
 values.
+.TP
+.I /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
+.in +4n
+.EX
+$ \c
+.B cat /sys/class/scsi_host/host1/driver_version
+1.1.2\-126
+.EE
+.in
+.TP
+.I /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
+.in +4n
+.EX
+$ \c
+.B cat /sys/class/scsi_host/host1/firmware_version
+1.29\-112
+.EE
+.in
+.TP
+.I /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
+.in +4n
+.EX
+$ \c
+.B cat /sys/class/scsi_host/host1/model
+1100\-16i
+.EE
+.in
+.TP
+.I /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
+.in +4n
+.EX
+$ \c
+.B cat /sys/class/scsi_host/host1/serial_number
+6A316373777
+.EE
+.in
+.TP
+.I /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
+.in +4n
+.EX
+$ \c
+.B cat /sys/class/scsi_host/host1/vendor
+Adaptec
+.EE
+.in
 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 In the file specifications below,
 .I c
@@ -206,7 +297,7 @@ Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
 .IP
 For example:
 .IP
-.in +2n
+.in +4n
 .EX
 $ \c
 .B cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled