From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Don Brace <don.brace@microsemi.com>,
"James E.J. Bottomley" <jejb@linux.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
esc.storagedev@microsemi.com, linux-scsi@vger.kernel.org
Subject: [PATCH 35/42] docs: scsi: convert smartpqi.txt to ReST
Date: Mon, 2 Mar 2020 09:16:08 +0100 [thread overview]
Message-ID: <00b398efb7cfc667b046fbef92a84f1d3c33eb64.1583136624.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1583136624.git.mchehab+huawei@kernel.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/scsi/index.rst | 1 +
.../scsi/{smartpqi.txt => smartpqi.rst} | 52 +++++++++----------
MAINTAINERS | 2 +-
drivers/scsi/smartpqi/Kconfig | 2 +-
4 files changed, 28 insertions(+), 29 deletions(-)
rename Documentation/scsi/{smartpqi.txt => smartpqi.rst} (67%)
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 6805e157b6e8..ff98919faed7 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -39,5 +39,6 @@ Linux SCSI Subsystem
scsi-parameters
scsi
sd-parameters
+ smartpqi
scsi_transport_srp/figures
diff --git a/Documentation/scsi/smartpqi.txt b/Documentation/scsi/smartpqi.rst
similarity index 67%
rename from Documentation/scsi/smartpqi.txt
rename to Documentation/scsi/smartpqi.rst
index df129f55ace5..a7de27352c6f 100644
--- a/Documentation/scsi/smartpqi.txt
+++ b/Documentation/scsi/smartpqi.rst
@@ -1,6 +1,8 @@
+.. 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
@@ -16,20 +18,21 @@ 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:
-------------------
+- 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
+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
@@ -37,12 +40,13 @@ smartpqi specific entries in /sys
The version attribute is read-only and will return the driver version
and the controller firmware version.
- For example:
+ For example::
+
driver: 0.9.13-370
firmware: 0.01-522
- smartpqi sas device attributes
- ------------------------------
+smartpqi sas device attributes
+------------------------------
HBA devices are added to the SAS transport layer. These attributes are
automatically added by the SAS transport layer.
@@ -50,31 +54,25 @@ smartpqi specific entries in /sys
/sys/class/sas_device/end_device-X:X/enclosure_identifier
/sys/class/sas_device/end_device-X:X/scsi_target_id
-smartpqi specific ioctls:
--------------------------
+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_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::
- Returns driver version in three bytes encoded as:
- (DRIVER_MAJOR << 28) | (DRIVER_MINOR << 24) | (DRIVER_RELEASE << 16) | DRIVER_REVISION;
+ (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/MAINTAINERS b/MAINTAINERS
index 776de9c5b404..f27c24d82c0f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11153,7 +11153,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>
diff --git a/drivers/scsi/smartpqi/Kconfig b/drivers/scsi/smartpqi/Kconfig
index bc6506884e3b..d3311c014863 100644
--- a/drivers/scsi/smartpqi/Kconfig
+++ b/drivers/scsi/smartpqi/Kconfig
@@ -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
--
2.21.1
next prev parent reply other threads:[~2020-03-02 8:16 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-02 8:15 [PATCH 00/42] Manually convert SCSI documentation to ReST format Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 01/42] Add an empty index file for SCSI documents Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 02/42] docs: scsi: include SCSI Transport SRP diagram at the doc body Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 03/42] docs: scsi: convert 53c700.txt to ReST Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 04/42] docs: scsi: convert aacraid.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 05/42] docs: scsi: convert advansys.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 06/42] docs: scsi: convert aha152x.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 07/42] docs: scsi: convert aic79xx.txt " Mauro Carvalho Chehab
2020-03-17 13:41 ` Christoph Hellwig
2020-03-02 8:15 ` [PATCH 08/42] docs: scsi: convert aic7xxx.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 09/42] docs: scsi: convert bfa.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 10/42] docs: scsi: convert bnx2fc.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 11/42] docs: scsi: convert BusLogic.txt " Mauro Carvalho Chehab
2020-03-04 18:58 ` Khalid Aziz
2020-03-02 8:15 ` [PATCH 12/42] docs: scsi: convert cxgb3i.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 13/42] docs: scsi: convert dc395x.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 14/42] docs: scsi: convert dpti.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 15/42] docs: scsi: convert FlashPoint.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 16/42] docs: scsi: convert g_NCR5380.txt " Mauro Carvalho Chehab
2020-03-03 0:21 ` Finn Thain
2020-03-02 8:15 ` [PATCH 17/42] docs: scsi: convert hpsa.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 18/42] docs: scsi: convert hptiop.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 19/42] docs: scsi: convert libsas.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 20/42] docs: scsi: convert link_power_management_policy.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 21/42] docs: scsi: convert lpfc.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 22/42] docs: scsi: convert megaraid.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 24/42] docs: scsi: convert NinjaSCSI.txt " Mauro Carvalho Chehab
2020-03-11 13:06 ` Masanori Goto
2020-03-02 8:15 ` [PATCH 25/42] docs: scsi: convert ppa.txt " Mauro Carvalho Chehab
2020-03-02 8:15 ` [PATCH 26/42] docs: scsi: convert qlogicfas.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 27/42] docs: scsi: convert scsi-changer.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 28/42] docs: scsi: convert scsi_eh.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 29/42] docs: scsi: convert scsi_fc_transport.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 30/42] docs: scsi: convert scsi-generic.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 31/42] docs: scsi: convert scsi_mid_low_api.txt " Mauro Carvalho Chehab
2020-03-03 0:20 ` Finn Thain
2020-03-17 13:44 ` Christoph Hellwig
2020-03-02 8:16 ` [PATCH 32/42] docs: scsi: convert scsi-parameters.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 33/42] docs: scsi: convert scsi.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 34/42] docs: scsi: convert sd-parameters.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` Mauro Carvalho Chehab [this message]
2020-03-02 8:16 ` [PATCH 36/42] docs: scsi: convert st.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 37/42] docs: scsi: convert sym53c500_cs.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 38/42] docs: scsi: convert sym53c8xx_2.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 39/42] docs: scsi: convert tcm_qla2xxx.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 40/42] docs: scsi: convert ufs.txt " Mauro Carvalho Chehab
2020-03-03 7:22 ` Avri Altman
2020-03-02 8:16 ` [PATCH 41/42] docs: scsi: convert wd719x.txt " Mauro Carvalho Chehab
2020-03-02 8:16 ` [PATCH 42/42] docs: scsi: convert arcmsr_spec.txt " Mauro Carvalho Chehab
2020-03-10 17:43 ` [PATCH 00/42] Manually convert SCSI documentation to ReST format Jonathan Corbet
2020-03-10 17:50 ` Martin K. Petersen
2020-03-10 17:58 ` Jonathan Corbet
2020-03-10 23:40 ` Martin K. Petersen
2020-03-11 11:50 ` Mauro Carvalho Chehab
2020-03-12 3:05 ` Martin K. Petersen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=00b398efb7cfc667b046fbef92a84f1d3c33eb64.1583136624.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=don.brace@microsemi.com \
--cc=esc.storagedev@microsemi.com \
--cc=jejb@linux.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).