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

scsi: docs: convert hpsa.txt to ReST 

Link: https://lore.kernel.org/r/ea58e04176d43fb7194615b145060aa04c9cf3ad.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 3c1e681b

Documentation/scsi/hpsa.txt→Documentation/scsi/hpsa.rst

+39 −40
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=========================================

HPSA - Hewlett Packard Smart Array driver

-----------------------------------------

=========================================



This file describes the hpsa SCSI driver for HP Smart Array controllers.

The hpsa driver is intended to supplant the cciss driver for newer
@@ -11,17 +13,17 @@ driver (for logical drives) AND a SCSI driver (for tape drives). This 
complexity and eliminating that complexity is one of the reasons

for hpsa to exist.



Supported devices:

------------------

Supported devices

=================



Smart Array P212

Smart Array P410

Smart Array P410i

Smart Array P411

Smart Array P812

Smart Array P712m

Smart Array P711m

StorageWorks P1210m

- Smart Array P212

- Smart Array P410

- Smart Array P410i

- Smart Array P411

- Smart Array P812

- Smart Array P712m

- Smart Array P711m

- StorageWorks P1210m



Additionally, older Smart Arrays may work with the hpsa driver if the kernel

boot parameter "hpsa_allow_any=1" is specified, however these are not tested
@@ -35,13 +37,15 @@ mode, each command completion requires an interrupt, while with "performant mode 
command completions indicated by a single interrupt.



HPSA specific entries in /sys

-----------------------------

=============================



  In addition to the generic SCSI attributes available in /sys, hpsa supports

  the following attributes:



  HPSA specific host attributes:

  ------------------------------

HPSA specific host attributes

=============================



  ::



    /sys/class/scsi_host/host*/rescan

    /sys/class/scsi_host/host*/firmware_revision
@@ -58,7 +62,7 @@ HPSA specific entries in /sys 
  tape drives, or entire storage boxes containing pre-configured logical drives.



  The "firmware_revision" attribute contains the firmware version of the Smart Array.

  For example:

  For example::



	root@host:/sys/class/scsi_host/host4# cat firmware_revision

	7.14
@@ -78,8 +82,10 @@ HPSA specific entries in /sys 
  kexec tools to warn the user if they attempt to designate a device which is

  unable to honor the reset_devices kernel parameter as a dump device.



  HPSA specific disk attributes:

  ------------------------------

HPSA specific disk attributes

-----------------------------



  ::



    /sys/class/scsi_disk/c:b:t:l/device/unique_id

    /sys/class/scsi_disk/c:b:t:l/device/raid_level
@@ -87,7 +93,7 @@ HPSA specific entries in /sys 


  (where c:b:t:l are the controller, bus, target and lun of the device)



  For example:

  For example::



	root@host:/sys/class/scsi_disk/4:0:0:0/device# cat unique_id

	600508B1001044395355323037570F77
@@ -96,35 +102,28 @@ HPSA specific entries in /sys 
	root@host:/sys/class/scsi_disk/4:0:0:0/device# cat raid_level

	RAID 0



HPSA specific ioctls:

---------------------

HPSA specific ioctls

====================



  For compatibility with applications written for the cciss driver, many, but

  not all of the ioctls supported by the cciss driver are also supported by the

  hpsa driver.  The data structures used by these are described in

  include/linux/cciss_ioctl.h



  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

	hpsa 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:

		(major_version << 16) | (minor_version << 8) | (subminor_version)



  CCISS_PASSTHRU

  CCISS_BIG_PASSTHRU



  CCISS_PASSTHRU, CCISS_BIG_PASSTHRU

	Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.

	These are used extensively by the HP Array Configuration Utility, SNMP storage

	agents, etc.  See cciss_vol_status at http://cciss.sf.net for some examples.

Documentation/scsi/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -21,5 +21,6 @@ Linux SCSI Subsystem 
   dpti

   FlashPoint

   g_NCR5380

   hpsa



   scsi_transport_srp/figures

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -7416,7 +7416,7 @@ M: Don Brace <don.brace@microsemi.com> 
L:	esc.storagedev@microsemi.com

L:	linux-scsi@vger.kernel.org

S:	Supported

F:	Documentation/scsi/hpsa.txt

F:	Documentation/scsi/hpsa.rst

F:	drivers/scsi/hpsa*.[ch]

F:	include/linux/cciss*.h

F:	include/uapi/linux/cciss*.h