Commit ff1efa74 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Martin K. Petersen
Browse files

scsi: docs: convert smartpqi.txt to ReST 

Link: https://lore.kernel.org/r/00b398efb7cfc667b046fbef92a84f1d3c33eb64.1583136624.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent d835971b

Documentation/scsi/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -39,5 +39,6 @@ Linux SCSI Subsystem 
   scsi-parameters

   scsi

   sd-parameters

   smartpqi



   scsi_transport_srp/figures

Documentation/scsi/smartpqi.txt→Documentation/scsi/smartpqi.rst

+25 −27
Original line number Diff line number Diff line 
.. 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,7 +40,8 @@ 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
@@ -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



  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;



  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.

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -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>
































drivers/scsi/smartpqi/Kconfig



+1
−1






























Original line number
Diff line number
Diff line







@@ -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