From: Mauro Carvalho Chehab Date: Mon, 2 Mar 2020 08:16:08 +0000 (+0100) Subject: scsi: docs: convert smartpqi.txt to ReST X-Git-Tag: v5.15~4079^2~101 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ff1efa74311a03152b985bfbf9daa3303af7d00c;p=platform%2Fkernel%2Flinux-starfive.git scsi: docs: convert smartpqi.txt to ReST Link: https://lore.kernel.org/r/00b398efb7cfc667b046fbef92a84f1d3c33eb64.1583136624.git.mchehab+huawei@kernel.org Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Martin K. Petersen --- diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst index 6805e15..ff98919 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 df129f55..a7de273 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 +================= 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 af7cc8b..7107ff6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -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 diff --git a/drivers/scsi/smartpqi/Kconfig b/drivers/scsi/smartpqi/Kconfig index bc65068..d3311c0 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