scsi: docs: convert smartpqi.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 2 Mar 2020 08:16:08 +0000 (09:16 +0100)
committerMartin K. Petersen <martin.petersen@oracle.com>
Thu, 12 Mar 2020 03:08:02 +0000 (23:08 -0400)
Link: https://lore.kernel.org/r/00b398efb7cfc667b046fbef92a84f1d3c33eb64.1583136624.git.mchehab+huawei@kernel.org
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Documentation/scsi/index.rst
Documentation/scsi/smartpqi.rst [new file with mode: 0644]
Documentation/scsi/smartpqi.txt [deleted file]
MAINTAINERS
drivers/scsi/smartpqi/Kconfig

index 6805e157b6e82e777969e19c8e8770c1f001beb6..ff98919faed7c475ff57d358f1fb5f8914abbf77 100644 (file)
@@ -39,5 +39,6 @@ Linux SCSI Subsystem
    scsi-parameters
    scsi
    sd-parameters
+   smartpqi
 
    scsi_transport_srp/figures
diff --git a/Documentation/scsi/smartpqi.rst b/Documentation/scsi/smartpqi.rst
new file mode 100644 (file)
index 0000000..a7de273
--- /dev/null
@@ -0,0 +1,78 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================================
+SMARTPQI - Microsemi Smart PQI Driver
+=====================================
+
+This file describes the smartpqi SCSI driver for Microsemi
+(http://www.microsemi.com) PQI controllers. The smartpqi driver
+is the next generation SCSI driver for Microsemi Corp. The smartpqi
+driver is the first SCSI driver to implement the PQI queuing model.
+
+The smartpqi driver will replace the aacraid driver for Adaptec Series 9
+controllers. Customers running an older kernel (Pre-4.9) using an Adaptec
+Series 9 controller will have to configure the smartpqi driver or their
+volumes will not be added to the OS.
+
+For Microsemi smartpqi controller support, enable the smartpqi driver
+when configuring the kernel.
+
+For more information on the PQI Queuing Interface, please see:
+
+- http://www.t10.org/drafts.htm
+- http://www.t10.org/members/w_pqi2.htm
+
+Supported devices
+=================
+<Controller names to be added as they become publicly available.>
+
+smartpqi specific entries in /sys
+=================================
+
+smartpqi host attributes
+------------------------
+  - /sys/class/scsi_host/host*/rescan
+  - /sys/class/scsi_host/host*/driver_version
+
+  The host rescan attribute is a write only attribute. Writing to this
+  attribute will trigger the driver to scan for new, changed, or removed
+  devices and notify the SCSI mid-layer of any changes detected.
+
+  The version attribute is read-only and will return the driver version
+  and the controller firmware version.
+  For example::
+
+              driver: 0.9.13-370
+              firmware: 0.01-522
+
+smartpqi sas device attributes
+------------------------------
+  HBA devices are added to the SAS transport layer. These attributes are
+  automatically added by the SAS transport layer.
+
+  /sys/class/sas_device/end_device-X:X/sas_address
+  /sys/class/sas_device/end_device-X:X/enclosure_identifier
+  /sys/class/sas_device/end_device-X:X/scsi_target_id
+
+smartpqi specific ioctls
+========================
+
+  For compatibility with applications written for the cciss protocol.
+
+  CCISS_DEREGDISK, CCISS_REGNEWDISK, CCISS_REGNEWD
+       The above three ioctls all do exactly the same thing, which is to cause the driver
+       to rescan for new devices.  This does exactly the same thing as writing to the
+       smartpqi specific host "rescan" attribute.
+
+  CCISS_GETPCIINFO
+       Returns PCI domain, bus, device and function and "board ID" (PCI subsystem ID).
+
+  CCISS_GETDRIVVER
+       Returns driver version in three bytes encoded as::
+
+         (DRIVER_MAJOR << 28) | (DRIVER_MINOR << 24) | (DRIVER_RELEASE << 16) | DRIVER_REVISION;
+
+  CCISS_PASSTHRU
+       Allows "BMIC" and "CISS" commands to be passed through to the Smart Storage Array.
+       These are used extensively by the SSA Array Configuration Utility, SNMP storage
+       agents, etc.
diff --git a/Documentation/scsi/smartpqi.txt b/Documentation/scsi/smartpqi.txt
deleted file mode 100644 (file)
index df129f5..0000000
+++ /dev/null
@@ -1,80 +0,0 @@
-
-SMARTPQI - Microsemi Smart PQI Driver
------------------------------------------
-
-This file describes the smartpqi SCSI driver for Microsemi
-(http://www.microsemi.com) PQI controllers. The smartpqi driver
-is the next generation SCSI driver for Microsemi Corp. The smartpqi
-driver is the first SCSI driver to implement the PQI queuing model.
-
-The smartpqi driver will replace the aacraid driver for Adaptec Series 9
-controllers. Customers running an older kernel (Pre-4.9) using an Adaptec
-Series 9 controller will have to configure the smartpqi driver or their
-volumes will not be added to the OS.
-
-For Microsemi smartpqi controller support, enable the smartpqi driver
-when configuring the kernel.
-
-For more information on the PQI Queuing Interface, please see:
-http://www.t10.org/drafts.htm
-http://www.t10.org/members/w_pqi2.htm
-
-Supported devices:
-------------------
-<Controller names to be added as they become publicly available.>
-
-smartpqi specific entries in /sys
------------------------------
-
-  smartpqi host attributes:
-  -------------------------
-  /sys/class/scsi_host/host*/rescan
-  /sys/class/scsi_host/host*/driver_version
-
-  The host rescan attribute is a write only attribute. Writing to this
-  attribute will trigger the driver to scan for new, changed, or removed
-  devices and notify the SCSI mid-layer of any changes detected.
-
-  The version attribute is read-only and will return the driver version
-  and the controller firmware version.
-  For example:
-              driver: 0.9.13-370
-              firmware: 0.01-522
-
-  smartpqi sas device attributes
-  ------------------------------
-  HBA devices are added to the SAS transport layer. These attributes are
-  automatically added by the SAS transport layer.
-
-  /sys/class/sas_device/end_device-X:X/sas_address
-  /sys/class/sas_device/end_device-X:X/enclosure_identifier
-  /sys/class/sas_device/end_device-X:X/scsi_target_id
-
-smartpqi specific ioctls:
--------------------------
-
-  For compatibility with applications written for the cciss protocol.
-
-  CCISS_DEREGDISK
-  CCISS_REGNEWDISK
-  CCISS_REGNEWD
-
-  The above three ioctls all do exactly the same thing, which is to cause the driver
-  to rescan for new devices.  This does exactly the same thing as writing to the
-  smartpqi specific host "rescan" attribute.
-
-  CCISS_GETPCIINFO
-
-       Returns PCI domain, bus, device and function and "board ID" (PCI subsystem ID).
-
-  CCISS_GETDRIVVER
-
-       Returns driver version in three bytes encoded as:
-       (DRIVER_MAJOR << 28) | (DRIVER_MINOR << 24) | (DRIVER_RELEASE << 16) | DRIVER_REVISION;
-
-  CCISS_PASSTHRU
-
-       Allows "BMIC" and "CISS" commands to be passed through to the Smart Storage Array.
-       These are used extensively by the SSA Array Configuration Utility, SNMP storage
-       agents, etc.
-
index af7cc8b330c4459c95ad2f75c8e8390c8901e4f0..7107ff6ecf927203c3edb8b75276a7f962fe8738 100644 (file)
@@ -11092,7 +11092,7 @@ F:      drivers/scsi/smartpqi/Kconfig
 F:     drivers/scsi/smartpqi/Makefile
 F:     include/linux/cciss*.h
 F:     include/uapi/linux/cciss*.h
-F:     Documentation/scsi/smartpqi.txt
+F:     Documentation/scsi/smartpqi.rst
 
 MICROSEMI ETHERNET SWITCH DRIVER
 M:     Alexandre Belloni <alexandre.belloni@bootlin.com>
index bc6506884e3be4bf97ad0762dc37630838076832..d3311c0148638ad95ba7a3d42b8b4983df057b88 100644 (file)
@@ -53,4 +53,4 @@ config SCSI_SMARTPQI
         Note: the aacraid driver will not manage a smartpqi
               controller. You need to enable smartpqi for smartpqi
               controllers. For more information, please see
-              Documentation/scsi/smartpqi.txt
+              Documentation/scsi/smartpqi.rst