Skip to contentSkip to conversation

Manually convert SCSI documentation to ReST format

PATCH Applied Mauro Carvalho Chehab 8 participants 56 messages Mar 2, 2020 – Mar 17, 2020

Subsystems (20)
lore
Share & tools
lore
#0 lore raw

cover Manually convert SCSI documentation to ReST format

This patch series manually convert all SCSI documentation files to ReST.

This is part of a bigger series that finaly finishes the migration to ReST. After that, we can focus on more interesting tasks from the documentation PoV, like cleaning obsolete stuff and filling the gaps.

If you want to see how this would show at the documentation body, a sneak peak of this series (together with the other pending doc patches from me) is available at:

https://www.infradead.org/~mchehab/kernel_docs/scsi/index.html

This series is available on this devel branch:

        https://git.linuxtv.org/mchehab/experimental.git/log/?h=scsi_docs_20200228

and it is based on next-20200228

Mauro Carvalho Chehab (42):
Add an empty index file for SCSI documents
docs: scsi: include SCSI Transport SRP diagram at the doc body
docs: scsi: convert 53c700.txt to ReST
docs: scsi: convert aacraid.txt to ReST
docs: scsi: convert advansys.txt to ReST
docs: scsi: convert aha152x.txt to ReST
docs: scsi: convert aic79xx.txt to ReST
docs: scsi: convert aic7xxx.txt to ReST
docs: scsi: convert bfa.txt to ReST
docs: scsi: convert bnx2fc.txt to ReST
docs: scsi: convert BusLogic.txt to ReST
docs: scsi: convert cxgb3i.txt to ReST
docs: scsi: convert dc395x.txt to ReST
docs: scsi: convert dpti.txt to ReST
docs: scsi: convert FlashPoint.txt to ReST
docs: scsi: convert g_NCR5380.txt to ReST
docs: scsi: convert hpsa.txt to ReST
docs: scsi: convert hptiop.txt to ReST
docs: scsi: convert libsas.txt to ReST
docs: scsi: convert link_power_management_policy.txt to ReST
docs: scsi: convert lpfc.txt to ReST
docs: scsi: convert megaraid.txt to ReST
docs: scsi: convert ncr53c8xx.txt to ReST
docs: scsi: convert NinjaSCSI.txt to ReST
docs: scsi: convert ppa.txt to ReST
docs: scsi: convert qlogicfas.txt to ReST
docs: scsi: convert scsi-changer.txt to ReST
docs: scsi: convert scsi_eh.txt to ReST
docs: scsi: convert scsi_fc_transport.txt to ReST
docs: scsi: convert scsi-generic.txt to ReST
docs: scsi: convert scsi_mid_low_api.txt to ReST
docs: scsi: convert scsi-parameters.txt to ReST
docs: scsi: convert scsi.txt to ReST
docs: scsi: convert sd-parameters.txt to ReST
docs: scsi: convert smartpqi.txt to ReST
docs: scsi: convert st.txt to ReST
docs: scsi: convert sym53c500_cs.txt to ReST
docs: scsi: convert sym53c8xx_2.txt to ReST
docs: scsi: convert tcm_qla2xxx.txt to ReST
docs: scsi: convert ufs.txt to ReST
docs: scsi: convert wd719x.txt to ReST
docs: scsi: convert arcmsr_spec.txt to ReST

 Documentation/driver-api/libata.rst           |    2 +-
 Documentation/index.rst                       |    1 +
 Documentation/scsi/{53c700.txt => 53c700.rst} |   61 +-
 .../scsi/{BusLogic.txt => BusLogic.rst}       |   89 +-
 .../scsi/{FlashPoint.txt => FlashPoint.rst}   |  225 +-
 .../scsi/{NinjaSCSI.txt => NinjaSCSI.rst}     |  198 +-
 .../scsi/{aacraid.txt => aacraid.rst}         |   59 +-
 .../scsi/{advansys.txt => advansys.rst}       |  129 +-
 .../scsi/{aha152x.txt => aha152x.rst}         |   73 +-
 .../scsi/{aic79xx.txt => aic79xx.rst}         |  586 +++---
 .../scsi/{aic7xxx.txt => aic7xxx.rst}         |  446 ++--
 Documentation/scsi/arcmsr_spec.rst            |  907 ++++++++
 Documentation/scsi/arcmsr_spec.txt            |  574 -----
 Documentation/scsi/{bfa.txt => bfa.rst}       |   28 +-
 Documentation/scsi/{bnx2fc.txt => bnx2fc.rst} |   18 +-
 Documentation/scsi/{cxgb3i.txt => cxgb3i.rst} |   22 +-
 Documentation/scsi/{dc395x.txt => dc395x.rst} |   75 +-
 Documentation/scsi/dpti.rst                   |   92 +
 Documentation/scsi/dpti.txt                   |   83 -
 .../scsi/{g_NCR5380.txt => g_NCR5380.rst}     |   89 +-
 Documentation/scsi/{hpsa.txt => hpsa.rst}     |   79 +-
 Documentation/scsi/{hptiop.txt => hptiop.rst} |   45 +-
 Documentation/scsi/index.rst                  |   51 +
 Documentation/scsi/{libsas.txt => libsas.rst} |  364 ++--
 ...y.txt => link_power_management_policy.rst} |   12 +-
 Documentation/scsi/{lpfc.txt => lpfc.rst}     |   16 +-
 .../scsi/{megaraid.txt => megaraid.rst}       |   47 +-
 .../scsi/{ncr53c8xx.txt => ncr53c8xx.rst}     | 1865 ++++++++++-------
 Documentation/scsi/{ppa.txt => ppa.rst}       |   12 +-
 .../scsi/{qlogicfas.txt => qlogicfas.rst}     |   17 +-
 .../{scsi-changer.txt => scsi-changer.rst}    |   36 +-
 .../{scsi-generic.txt => scsi-generic.rst}    |   75 +-
 ...csi-parameters.txt => scsi-parameters.rst} |   28 +-
 Documentation/scsi/{scsi.txt => scsi.rst}     |   31 +-
 .../scsi/{scsi_eh.txt => scsi_eh.rst}         |  217 +-
 ...fc_transport.txt => scsi_fc_transport.rst} |  236 ++-
 ...i_mid_low_api.txt => scsi_mid_low_api.rst} | 1730 +++++++--------
 .../{Makefile => figures.rst}                 |    9 +-
 .../{sd-parameters.txt => sd-parameters.rst}  |   21 +-
 .../scsi/{smartpqi.txt => smartpqi.rst}       |   52 +-
 Documentation/scsi/{st.txt => st.rst}         |  301 ++-
 .../{sym53c500_cs.txt => sym53c500_cs.rst}    |    8 +-
 .../scsi/{sym53c8xx_2.txt => sym53c8xx_2.rst} | 1109 +++++-----
 .../scsi/{tcm_qla2xxx.txt => tcm_qla2xxx.rst} |   26 +-
 Documentation/scsi/{ufs.txt => ufs.rst}       |   84 +-
 Documentation/scsi/{wd719x.txt => wd719x.rst} |   23 +-
 MAINTAINERS                                   |   28 +-
 drivers/scsi/BusLogic.c                       |    2 +-
 drivers/scsi/Kconfig                          |   42 +-
 drivers/scsi/aha152x.c                        |    4 +-
 drivers/scsi/aic7xxx/Kconfig.aic79xx          |    2 +-
 drivers/scsi/aic7xxx/Kconfig.aic7xxx          |    2 +-
 drivers/scsi/arcmsr/arcmsr_attr.c             |    2 +-
 drivers/scsi/arcmsr/arcmsr_hba.c              |    2 +-
 drivers/scsi/dpt/dpti_ioctl.h                 |    2 +-
 drivers/scsi/dpt_i2o.c                        |    2 +-
 drivers/scsi/dpti.h                           |    2 +-
 drivers/scsi/g_NCR5380.c                      |    2 +-
 drivers/scsi/ncr53c8xx.c                      |    2 +-
 drivers/scsi/pcmcia/Kconfig                   |    2 +-
 drivers/scsi/smartpqi/Kconfig                 |    2 +-
 drivers/scsi/st.c                             |    2 +-
 drivers/scsi/ufs/Kconfig                      |    2 +-
 include/scsi/sg.h                             |    2 +-
 scripts/documentation-file-ref-check          |    2 +-
 65 files changed, 6040 insertions(+), 4317 deletions(-)
 rename Documentation/scsi/{53c700.txt => 53c700.rst} (75%)
 rename Documentation/scsi/{BusLogic.txt => BusLogic.rst} (93%)
 rename Documentation/scsi/{FlashPoint.txt => FlashPoint.rst} (21%)
 rename Documentation/scsi/{NinjaSCSI.txt => NinjaSCSI.rst} (28%)
 rename Documentation/scsi/{aacraid.txt => aacraid.rst} (83%)
 rename Documentation/scsi/{advansys.txt => advansys.rst} (73%)
 rename Documentation/scsi/{aha152x.txt => aha152x.rst} (76%)
 rename Documentation/scsi/{aic79xx.txt => aic79xx.rst} (48%)
 rename Documentation/scsi/{aic7xxx.txt => aic7xxx.rst} (49%)
 create mode 100644 Documentation/scsi/arcmsr_spec.rst
 delete mode 100644 Documentation/scsi/arcmsr_spec.txt
 rename Documentation/scsi/{bfa.txt => bfa.rst} (72%)
 rename Documentation/scsi/{bnx2fc.txt => bnx2fc.rst} (91%)
 rename Documentation/scsi/{cxgb3i.txt => cxgb3i.rst} (86%)
 rename Documentation/scsi/{dc395x.txt => dc395x.rst} (64%)
 create mode 100644 Documentation/scsi/dpti.rst
 delete mode 100644 Documentation/scsi/dpti.txt
 rename Documentation/scsi/{g_NCR5380.txt => g_NCR5380.rst} (41%)
 rename Documentation/scsi/{hpsa.txt => hpsa.rst} (77%)
 rename Documentation/scsi/{hptiop.txt => hptiop.rst} (78%)
 create mode 100644 Documentation/scsi/index.rst
 rename Documentation/scsi/{libsas.txt => libsas.rst} (57%)
 rename Documentation/scsi/{link_power_management_policy.txt => link_power_management_policy.rst} (65%)
 rename Documentation/scsi/{lpfc.txt => lpfc.rst} (93%)
 rename Documentation/scsi/{megaraid.txt => megaraid.rst} (66%)
 rename Documentation/scsi/{ncr53c8xx.txt => ncr53c8xx.rst} (55%)
 rename Documentation/scsi/{ppa.txt => ppa.rst} (32%)
 rename Documentation/scsi/{qlogicfas.txt => qlogicfas.rst} (92%)
 rename Documentation/scsi/{scsi-changer.txt => scsi-changer.rst} (87%)
 rename Documentation/scsi/{scsi-generic.txt => scsi-generic.rst} (70%)
 rename Documentation/scsi/{scsi-parameters.txt => scsi-parameters.rst} (81%)
 rename Documentation/scsi/{scsi.txt => scsi.rst} (82%)
 rename Documentation/scsi/{scsi_eh.txt => scsi_eh.rst} (73%)
 rename Documentation/scsi/{scsi_fc_transport.txt => scsi_fc_transport.rst} (74%)
 rename Documentation/scsi/{scsi_mid_low_api.txt => scsi_mid_low_api.rst} (39%)
 rename Documentation/scsi/scsi_transport_srp/{Makefile => figures.rst} (1%)
 rename Documentation/scsi/{sd-parameters.txt => sd-parameters.rst} (37%)
 rename Documentation/scsi/{smartpqi.txt => smartpqi.rst} (67%)
 rename Documentation/scsi/{st.txt => st.rst} (79%)
 rename Documentation/scsi/{sym53c500_cs.txt => sym53c500_cs.rst} (89%)
 rename Documentation/scsi/{sym53c8xx_2.txt => sym53c8xx_2.rst} (53%)
 rename Documentation/scsi/{tcm_qla2xxx.txt => tcm_qla2xxx.rst} (57%)
 rename Documentation/scsi/{ufs.txt => ufs.rst} (79%)
 rename Documentation/scsi/{wd719x.txt => wd719x.rst} (46%)
Signature · 1 line
2.21.1
#1 lore raw

PATCH 1/42 Add an empty index file for SCSI documents

In preparation for adding the SCSI documents to the documentation body, add an empty index for it.

The next patches should be adding contents to it, as files get converted to ReST format.

---
 Documentation/index.rst      |  1 +
 Documentation/scsi/index.rst | 10 ++++++++++
 2 files changed, 11 insertions(+)
 create mode 100644 Documentation/scsi/index.rst
Documentation/index.rst +1 -0
index e99d0bd2589d..d39fd2c9f1ce 100644
@@ -130,6 +130,7 @@ needed).
    bpf/index
    usb/index
    PCI/index
+   scsi/index
    misc-devices/index
    mic/index
    scheduler/index
Documentation/scsi/index.rst new file +10 -0
new file mode 100644
index 000000000000..16baf8b0f11f
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+Linux SCSI Subsystem
+====================
+
+.. toctree::
+   :maxdepth: 1
+
+
Signature · 1 line
2.21.1
#2 lore raw

PATCH 2/42 docs: scsi: include SCSI Transport SRP diagram at the doc body

In reply to Mauro Carvalho Chehab

Instead of having a separate makefile, and be alone, group it at the SCSI documentation and make it being built as part of docs makefile.

---
 Documentation/scsi/index.rst                             | 2 +-
 .../scsi/scsi_transport_srp/{Makefile => figures.rst}    | 9 ++++-----
 2 files changed, 5 insertions(+), 6 deletions(-)
 rename Documentation/scsi/scsi_transport_srp/{Makefile => figures.rst} (1%)
Documentation/scsi/index.rst +1 -1
index 16baf8b0f11f..3ef7ad65372a 100644
@@ -7,4 +7,4 @@ Linux SCSI Subsystem
 .. toctree::
    :maxdepth: 1
 
-
+   scsi_transport_srp/figures
Documentation/scsi/scsi_transport_srp/figures.rst renamed from Documentation/scsi/scsi_transport_srp/Makefile +4 -5
similarity index 1%
rename from Documentation/scsi/scsi_transport_srp/Makefile
rename to Documentation/scsi/scsi_transport_srp/figures.rst
index 5f6b567e955c..6c8f8dd6301b 100644
@@ -1,7 +1,6 @@
-all: rport_state_diagram.svg rport_state_diagram.png
+.. SPDX-License-Identifier: GPL-2.0
 
-rport_state_diagram.svg: rport_state_diagram.dot
-	dot -Tsvg -o $@ $<
+SCSI RDMA (SRP) transport class diagram
+=======================================
 
-rport_state_diagram.png: rport_state_diagram.dot
-	dot -Tpng -o $@ $<
+.. kernel-figure:: rport_state_diagram.dot
Signature · 1 line
2.21.1
#3 lore raw

PATCH 3/42 docs: scsi: convert 53c700.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{53c700.txt => 53c700.rst} | 61 +++++++++----------
 Documentation/scsi/index.rst                  |  2 +
 MAINTAINERS                                   |  2 +-
 3 files changed, 33 insertions(+), 32 deletions(-)
 rename Documentation/scsi/{53c700.txt => 53c700.rst} (75%)
Documentation/scsi/53c700.rst renamed from Documentation/scsi/53c700.txt +30 -31
similarity index 75%
rename from Documentation/scsi/53c700.txt
rename to Documentation/scsi/53c700.rst
index e31aceb6df15..53a0e9f9c198 100644
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================
+The 53c700 Driver Notes
+=======================
+
 General Description
 ===================
 
@@ -16,9 +22,9 @@ fill in to get the driver working.
 Compile Time Flags
 ==================
 
-A compile time flag is:
+A compile time flag is::
 
-CONFIG_53C700_LE_ON_BE
+	CONFIG_53C700_LE_ON_BE
 
 define if the chipset must be supported in little endian mode on a big
 endian architecture (used for the 700 on parisc).
@@ -51,9 +57,11 @@ consistent with the best operation of the chip (although some choose
 to drive it off the CPU or bus clock rather than going to the expense
 of an extra clock chip).  The best operation clock speeds are:
 
-53c700 - 25MHz
-53c700-66 - 50MHz
-53c710 - 40Mhz
+=========  =====
+53c700     25MHz
+53c700-66  50MHz
+53c710     40Mhz
+=========  =====
 
 Writing Your Glue Driver
 ========================
@@ -69,7 +77,7 @@ parameters that matter to you (see below), plumb the NCR_700_intr
 routine into the interrupt line and call NCR_700_detect with the host
 template and the new parameters as arguments.  You should also call
 the relevant request_*_region function and place the register base
-address into the `base' pointer of the host parameters.
+address into the 'base' pointer of the host parameters.
 
 In the release routine, you must free the NCR_700_Host_Parameters that
 you allocated, call the corresponding release_*_region and free the
@@ -78,7 +86,7 @@ interrupt.
 Handling Interrupts
 -------------------
 
-In general, you should just plumb the card's interrupt line in with 
+In general, you should just plumb the card's interrupt line in with
 
 request_irq(irq, NCR_700_intr, <irq flags>, <driver name>, host);
 
@@ -95,41 +103,32 @@ Settable NCR_700_Host_Parameters
 The following are a list of the user settable parameters:
 
 clock: (MANDATORY)
-
-Set to the clock speed of the chip in MHz.
+  Set to the clock speed of the chip in MHz.
 
 base: (MANDATORY)
-
-set to the base of the io or mem region for the register set. On 64
-bit architectures this is only 32 bits wide, so the registers must be
-mapped into the low 32 bits of memory.
+  Set to the base of the io or mem region for the register set. On 64
+  bit architectures this is only 32 bits wide, so the registers must be
+  mapped into the low 32 bits of memory.
 
 pci_dev: (OPTIONAL)
-
-set to the PCI board device.  Leave NULL for a non-pci board.  This is
-used for the pci_alloc_consistent() and pci_map_*() functions.
+  Set to the PCI board device.  Leave NULL for a non-pci board.  This is
+  used for the pci_alloc_consistent() and pci_map_*() functions.
 
 dmode_extra: (OPTIONAL, 53c710 only)
-
-extra flags for the DMODE register.  These are used to control bus
-output pins on the 710.  The settings should be a combination of
-DMODE_FC1 and DMODE_FC2.  What these pins actually do is entirely up
-to the board designer.  Usually it is safe to ignore this setting.
+  Extra flags for the DMODE register.  These are used to control bus
+  output pins on the 710.  The settings should be a combination of
+  DMODE_FC1 and DMODE_FC2.  What these pins actually do is entirely up
+  to the board designer.  Usually it is safe to ignore this setting.
 
 differential: (OPTIONAL)
-
-set to 1 if the chip drives a differential bus.
+  Set to 1 if the chip drives a differential bus.
 
 force_le_on_be: (OPTIONAL, only if CONFIG_53C700_LE_ON_BE is set)
-
-set to 1 if the chip is operating in little endian mode on a big
-endian architecture.
+  Set to 1 if the chip is operating in little endian mode on a big
+  endian architecture.
 
 chip710: (OPTIONAL)
-
-set to 1 if the chip is a 53c710.
+  Set to 1 if the chip is a 53c710.
 
 burst_disable: (OPTIONAL, 53c710 only)
-
-disable 8 byte bursting for DMA transfers.
-
+  Disable 8 byte bursting for DMA transfers.
Documentation/scsi/index.rst +2 -0
index 3ef7ad65372a..99efc77c3ac2 100644
@@ -7,4 +7,6 @@ Linux SCSI Subsystem
 .. toctree::
    :maxdepth: 1
 
+   53c700
+
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index 09b04505e7c3..1552db209e69 100644
@@ -9445,7 +9445,7 @@ LASI 53c700 driver for PARISC
 M:	"James E.J. Bottomley" <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/scsi/53c700.txt
+F:	Documentation/scsi/53c700.rst
 F:	drivers/scsi/53c700*
 
 LEAKING_ADDRESSES
Signature · 1 line
2.21.1
#4 lore raw

PATCH 4/42 docs: scsi: convert aacraid.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{aacraid.txt => aacraid.rst}         | 59 ++++++++++++++-----
 Documentation/scsi/index.rst                  |  1 +
 MAINTAINERS                                   |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 4 files changed, 46 insertions(+), 18 deletions(-)
 rename Documentation/scsi/{aacraid.txt => aacraid.rst} (83%)
Documentation/scsi/aacraid.rst renamed from Documentation/scsi/aacraid.txt +43 -16
similarity index 83%
rename from Documentation/scsi/aacraid.txt
rename to Documentation/scsi/aacraid.rst
index 30f643f611b2..1904674b94f3 100644
@@ -1,7 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===================================
 AACRAID Driver for Linux (take two)
+===================================
 
 Introduction
--------------------------
+============
 The aacraid driver adds support for Adaptec (http://www.adaptec.com)
 RAID controllers. This is a major rewrite from the original
 Adaptec supplied driver. It has significantly cleaned up both the code
@@ -9,8 +13,11 @@ and the running binary size (the module is less than half the size of
 the original).
 
 Supported Cards/Chipsets
--------------------------
+========================
+
+	===================	=======	=======================================
 	PCI ID (pci.ids)	OEM	Product
+	===================	=======	=======================================
 	9005:0285:9005:0285	Adaptec	2200S (Vulcan)
 	9005:0285:9005:0286	Adaptec	2120S (Crusader)
 	9005:0285:9005:0287	Adaptec	2200S (Vulcan-2m)
@@ -117,34 +124,54 @@ Supported Cards/Chipsets
 	9005:0285:108e:0286	SUN	STK RAID INT (Cougar)
 	9005:0285:108e:0287	SUN	STK RAID EXT (Prometheus)
 	9005:0285:108e:7aae	SUN	STK RAID EM (Narvi)
+	===================	=======	=======================================
 
 People
--------------------------
+======
+
 Alan Cox <[email protected]>
-Christoph Hellwig <[email protected]>	(updates for new-style PCI probing and SCSI host registration,
-					 small cleanups/fixes)
-Matt Domsch <[email protected]>	(revision ioctl, adapter messages)
-Deanna Bonds                            (non-DASD support, PAE fibs and 64 bit, added new adaptec controllers
-					 added new ioctls, changed scsi interface to use new error handler,
-					 increased the number of fibs and outstanding commands to a container)
-
-					(fixed 64bit and 64G memory model, changed confusing naming convention
-					 where fibs that go to the hardware are consistently called hw_fibs and
-					 not just fibs like the name of the driver tracking structure)
-Mark Salyzyn <[email protected]> Fixed panic issues and added some new product ids for upcoming hbas. Performance tuning, card failover and bug mitigations.
+
+Christoph Hellwig <[email protected]>
+
+- updates for new-style PCI probing and SCSI host registration,
+  small cleanups/fixes
+
+Matt Domsch <[email protected]>
+
+- revision ioctl, adapter messages
+
+Deanna Bonds
+
+- non-DASD support, PAE fibs and 64 bit, added new adaptec controllers
+  added new ioctls, changed scsi interface to use new error handler,
+  increased the number of fibs and outstanding commands to a container
+- fixed 64bit and 64G memory model, changed confusing naming convention
+  where fibs that go to the hardware are consistently called hw_fibs and
+  not just fibs like the name of the driver tracking structure
+
+Mark Salyzyn <[email protected]>
+
+- Fixed panic issues and added some new product ids for upcoming hbas.
+- Performance tuning, card failover and bug mitigations.
+
 Achim Leubner <[email protected]>
 
-Original Driver
+- Original Driver
+
 -------------------------
+
 Adaptec Unix OEM Product Group
 
 Mailing List
--------------------------
+============
+
 [email protected] (Interested parties troll here)
 Also note this is very different to Brian's original driver
 so don't expect him to support it.
+
 Adaptec does support this driver.  Contact Adaptec tech support or
 [email protected]
 
 Original by Brian Boerner February 2001
+
 Rewritten by Alan Cox, November 2001
Documentation/scsi/index.rst +1 -0
index 99efc77c3ac2..2e0429d1a7a5 100644
@@ -8,5 +8,6 @@ Linux SCSI Subsystem
    :maxdepth: 1
 
    53c700
+   aacraid
 
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index 1552db209e69..cb6ecdbc96da 100644
@@ -236,7 +236,7 @@ M:	Adaptec OEM Raid Solutions <[email protected]>
 L:	[email protected]
 W:	http://www.adaptec.com/
 S:	Supported
-F:	Documentation/scsi/aacraid.txt
+F:	Documentation/scsi/aacraid.rst
 F:	drivers/scsi/aacraid/
 
 ABI/API
drivers/scsi/Kconfig +1 -1
index 2b882b96e0d4..a153444318fb 100644
@@ -421,7 +421,7 @@ config SCSI_AACRAID
 	help
 	  This driver supports a variety of Dell, HP, Adaptec, IBM and
 	  ICP storage products. For a list of supported products, refer
-	  to <file:Documentation/scsi/aacraid.txt>.
+	  to <file:Documentation/scsi/aacraid.rst>.
 
 	  To compile this driver as a module, choose M here: the module
 	  will be called aacraid.
Signature · 1 line
2.21.1
#5 lore raw

PATCH 5/42 docs: scsi: convert advansys.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{advansys.txt => advansys.rst}       | 129 +++++++++++-------
 Documentation/scsi/index.rst                  |   1 +
 MAINTAINERS                                   |   2 +-
 3 files changed, 81 insertions(+), 51 deletions(-)
 rename Documentation/scsi/{advansys.txt => advansys.rst} (73%)
Documentation/scsi/advansys.rst renamed from Documentation/scsi/advansys.txt +79 -50
similarity index 73%
rename from Documentation/scsi/advansys.txt
rename to Documentation/scsi/advansys.rst
index 4a3db62b7424..e0367e179696 100644
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================
+AdvanSys Driver Notes
+=====================
+
 AdvanSys (Advanced System Products, Inc.) manufactures the following
 RISC-based, Bus-Mastering, Fast (10 Mhz) and Ultra (20 Mhz) Narrow
 (8-bit transfer) SCSI Host Adapters for the ISA, EISA, VL, and PCI
@@ -12,50 +18,51 @@ adapter detected. The number of CDBs used by the driver can be
 lowered in the BIOS by changing the 'Host Queue Size' adapter setting.
 
 Laptop Products:
-   ABP-480 - Bus-Master CardBus (16 CDB)
+  - ABP-480 - Bus-Master CardBus (16 CDB)
 
 Connectivity Products:
-   ABP510/5150 - Bus-Master ISA (240 CDB)
-   ABP5140 - Bus-Master ISA PnP (16 CDB)
-   ABP5142 - Bus-Master ISA PnP with floppy (16 CDB)
-   ABP902/3902 - Bus-Master PCI (16 CDB)
-   ABP3905 - Bus-Master PCI (16 CDB)
-   ABP915 - Bus-Master PCI (16 CDB)
-   ABP920 - Bus-Master PCI (16 CDB)
-   ABP3922 - Bus-Master PCI (16 CDB)
-   ABP3925 - Bus-Master PCI (16 CDB)
-   ABP930 - Bus-Master PCI (16 CDB)
-   ABP930U - Bus-Master PCI Ultra (16 CDB)
-   ABP930UA - Bus-Master PCI Ultra (16 CDB)
-   ABP960 - Bus-Master PCI MAC/PC (16 CDB)
-   ABP960U - Bus-Master PCI MAC/PC Ultra (16 CDB)
+   - ABP510/5150 - Bus-Master ISA (240 CDB)
+   - ABP5140 - Bus-Master ISA PnP (16 CDB)
+   - ABP5142 - Bus-Master ISA PnP with floppy (16 CDB)
+   - ABP902/3902 - Bus-Master PCI (16 CDB)
+   - ABP3905 - Bus-Master PCI (16 CDB)
+   - ABP915 - Bus-Master PCI (16 CDB)
+   - ABP920 - Bus-Master PCI (16 CDB)
+   - ABP3922 - Bus-Master PCI (16 CDB)
+   - ABP3925 - Bus-Master PCI (16 CDB)
+   - ABP930 - Bus-Master PCI (16 CDB)
+   - ABP930U - Bus-Master PCI Ultra (16 CDB)
+   - ABP930UA - Bus-Master PCI Ultra (16 CDB)
+   - ABP960 - Bus-Master PCI MAC/PC (16 CDB)
+   - ABP960U - Bus-Master PCI MAC/PC Ultra (16 CDB)
 
 Single Channel Products:
-   ABP542 - Bus-Master ISA with floppy (240 CDB)
-   ABP742 - Bus-Master EISA (240 CDB)
-   ABP842 - Bus-Master VL (240 CDB)
-   ABP940 - Bus-Master PCI (240 CDB)
-   ABP940U - Bus-Master PCI Ultra (240 CDB)
-   ABP940UA/3940UA - Bus-Master PCI Ultra (240 CDB)
-   ABP970 - Bus-Master PCI MAC/PC (240 CDB)
-   ABP970U - Bus-Master PCI MAC/PC Ultra (240 CDB)
-   ABP3960UA - Bus-Master PCI MAC/PC Ultra (240 CDB)
-   ABP940UW/3940UW - Bus-Master PCI Ultra-Wide (253 CDB)
-   ABP970UW - Bus-Master PCI MAC/PC Ultra-Wide (253 CDB)
-   ABP3940U2W - Bus-Master PCI LVD/Ultra2-Wide (253 CDB)
+   - ABP542 - Bus-Master ISA with floppy (240 CDB)
+   - ABP742 - Bus-Master EISA (240 CDB)
+   - ABP842 - Bus-Master VL (240 CDB)
+   - ABP940 - Bus-Master PCI (240 CDB)
+   - ABP940U - Bus-Master PCI Ultra (240 CDB)
+   - ABP940UA/3940UA - Bus-Master PCI Ultra (240 CDB)
+   - ABP970 - Bus-Master PCI MAC/PC (240 CDB)
+   - ABP970U - Bus-Master PCI MAC/PC Ultra (240 CDB)
+   - ABP3960UA - Bus-Master PCI MAC/PC Ultra (240 CDB)
+   - ABP940UW/3940UW - Bus-Master PCI Ultra-Wide (253 CDB)
+   - ABP970UW - Bus-Master PCI MAC/PC Ultra-Wide (253 CDB)
+   - ABP3940U2W - Bus-Master PCI LVD/Ultra2-Wide (253 CDB)
 
 Multi-Channel Products:
-   ABP752 - Dual Channel Bus-Master EISA (240 CDB Per Channel)
-   ABP852 - Dual Channel Bus-Master VL (240 CDB Per Channel)
-   ABP950 - Dual Channel Bus-Master PCI (240 CDB Per Channel)
-   ABP950UW - Dual Channel Bus-Master PCI Ultra-Wide (253 CDB Per Channel)
-   ABP980 - Four Channel Bus-Master PCI (240 CDB Per Channel)
-   ABP980U - Four Channel Bus-Master PCI Ultra (240 CDB Per Channel)
-   ABP980UA/3980UA - Four Channel Bus-Master PCI Ultra (16 CDB Per Chan.)
-   ABP3950U2W - Bus-Master PCI LVD/Ultra2-Wide and Ultra-Wide (253 CDB)
-   ABP3950U3W - Bus-Master PCI Dual LVD2/Ultra3-Wide (253 CDB)
+   - ABP752 - Dual Channel Bus-Master EISA (240 CDB Per Channel)
+   - ABP852 - Dual Channel Bus-Master VL (240 CDB Per Channel)
+   - ABP950 - Dual Channel Bus-Master PCI (240 CDB Per Channel)
+   - ABP950UW - Dual Channel Bus-Master PCI Ultra-Wide (253 CDB Per Channel)
+   - ABP980 - Four Channel Bus-Master PCI (240 CDB Per Channel)
+   - ABP980U - Four Channel Bus-Master PCI Ultra (240 CDB Per Channel)
+   - ABP980UA/3980UA - Four Channel Bus-Master PCI Ultra (16 CDB Per Chan.)
+   - ABP3950U2W - Bus-Master PCI LVD/Ultra2-Wide and Ultra-Wide (253 CDB)
+   - ABP3950U3W - Bus-Master PCI Dual LVD2/Ultra3-Wide (253 CDB)
 
 Driver Compile Time Options and Debugging
+=========================================
 
 The following constants can be defined in the source file.
 
@@ -88,26 +95,30 @@ The following constants can be defined in the source file.
    first three hex digits of the pseudo I/O Port must be set to
    'deb' and the fourth hex digit specifies the debug level: 0 - F.
    The following command line will look for an adapter at 0x330
-   and set the debug level to 2.
+   and set the debug level to 2::
 
       linux advansys=0x330,0,0,0,0xdeb2
 
    If the driver is built as a loadable module this variable can be
    defined when the driver is loaded. The following insmod command
-   will set the debug level to one.
+   will set the debug level to one::
 
       insmod advansys.o asc_dbglvl=1
 
    Debugging Message Levels:
-      0: Errors Only
-      1: High-Level Tracing
-      2-N: Verbose Tracing
+
+
+      ==== ==================
+      0    Errors Only
+      1    High-Level Tracing
+      2-N  Verbose Tracing
+      ==== ==================
 
    To enable debug output to console, please make sure that:
 
    a. System and kernel logging is enabled (syslogd, klogd running).
    b. Kernel messages are routed to console output. Check
-      /etc/syslog.conf for an entry similar to this:
+      /etc/syslog.conf for an entry similar to this::
 
            kern.*                  /dev/console
 
@@ -120,8 +131,11 @@ The following constants can be defined in the source file.
 
    Alternatively you can enable printk() to console with this
    program. However, this is not the 'official' way to do this.
+
    Debug output is logged in /var/log/messages.
 
+   ::
+
      main()
      {
              syscall(103, 7, 0, 0);
@@ -144,11 +158,11 @@ The following constants can be defined in the source file.
    Statistics are only available for kernels greater than or equal
    to v1.3.0 with the CONFIG_PROC_FS (/proc) file system configured.
 
-   AdvanSys SCSI adapter files have the following path name format:
+   AdvanSys SCSI adapter files have the following path name format::
 
       /proc/scsi/advansys/{0,1,2,3,...}
 
-   This information can be displayed with cat. For example:
+   This information can be displayed with cat. For example::
 
       cat /proc/scsi/advansys/0
 
@@ -156,6 +170,7 @@ The following constants can be defined in the source file.
    contain adapter and device configuration information.
 
 Driver LILO Option
+==================
 
 If init/main.c is modified as described in the 'Directions for Adding
 the AdvanSys Driver to Linux' section (B.4.) above, the driver will
@@ -167,17 +182,30 @@ affects searching for ISA and VL boards.
 
 Examples:
   1. Eliminate I/O port scanning:
-       boot: linux advansys=
-         or
-       boot: linux advansys=0x0
+
+     boot::
+
+	linux advansys=
+
+     or::
+
+	boot: linux advansys=0x0
+
   2. Limit I/O port scanning to one I/O port:
-       boot: linux advansys=0x110
+
+     boot::
+
+	linux advansys=0x110
+
   3. Limit I/O port scanning to four I/O ports:
-       boot: linux advansys=0x110,0x210,0x230,0x330
+
+     boot::
+
+	linux advansys=0x110,0x210,0x230,0x330
 
 For a loadable module the same effect can be achieved by setting
 the 'asc_iopflag' variable and 'asc_ioport' array when loading
-the driver, e.g.
+the driver, e.g.::
 
       insmod advansys.o asc_iopflag=1 asc_ioport=0x110,0x330
 
@@ -187,6 +215,7 @@ the 'Driver Compile Time Options and Debugging' section above for
 more information.
 
 Credits (Chronological Order)
+=============================
 
 Bob Frey <[email protected]> wrote the AdvanSys SCSI driver
 and maintained it up to 3.3F. He continues to answer questions
Documentation/scsi/index.rst +1 -0
index 2e0429d1a7a5..df526a0ceccf 100644
@@ -9,5 +9,6 @@ Linux SCSI Subsystem
 
    53c700
    aacraid
+   advansys
 
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index cb6ecdbc96da..aac8ef48dc08 100644
@@ -540,7 +540,7 @@ M:	Matthew Wilcox <[email protected]>
 M:	Hannes Reinecke <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/scsi/advansys.txt
+F:	Documentation/scsi/advansys.rst
 F:	drivers/scsi/advansys.c
 
 ADXL34X THREE-AXIS DIGITAL ACCELEROMETER DRIVER (ADXL345/ADXL346)
Signature · 1 line
2.21.1
#6 lore raw

PATCH 6/42 docs: scsi: convert aha152x.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{aha152x.txt => aha152x.rst}         | 73 ++++++++++++-------
 Documentation/scsi/index.rst                  |  1 +
 Documentation/scsi/scsi-parameters.txt        |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 drivers/scsi/aha152x.c                        |  4 +-
 5 files changed, 52 insertions(+), 30 deletions(-)
 rename Documentation/scsi/{aha152x.txt => aha152x.rst} (76%)
Documentation/scsi/aha152x.rst renamed from Documentation/scsi/aha152x.txt +47 -26
similarity index 76%
rename from Documentation/scsi/aha152x.txt
rename to Documentation/scsi/aha152x.rst
index 94848734ac66..7012b5c46d5d 100644
@@ -1,7 +1,12 @@
-$Id: README.aha152x,v 1.2 1999/12/25 15:32:30 fischer Exp fischer $
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+
+=====================================================
 Adaptec AHA-1520/1522 SCSI driver for Linux (aha152x)
+=====================================================
+
+Copyright |copy| 1993-1999 Jürgen Fischer <[email protected]>
 
-Copyright 1993-1999 Jürgen Fischer <[email protected]>
 TC1550 patches by Luuk van Dijk ([email protected])
 
 
@@ -14,8 +19,10 @@ less polling loops), has slightly higher throughput (at
 least on my ancient test box; a i486/33Mhz/20MB).
 
 
-CONFIGURATION ARGUMENTS:
+Configuration Arguments
+=======================
 
+============  ========================================  ======================
 IOPORT        base io address                           (0x340/0x140)
 IRQ           interrupt level                           (9-12; default 11)
 SCSI_ID       scsi id of controller                     (0-7; default 7)
@@ -25,31 +32,38 @@ SYNCHRONOUS   enable synchronous transfers              (0/1; default 1 [on])
 DELAY:        bus reset delay                           (default 100)
 EXT_TRANS:    enable extended translation               (0/1: default 0 [off])
               (see NOTES)
+============  ========================================  ======================
 
-COMPILE TIME CONFIGURATION (go into AHA152X in drivers/scsi/Makefile):
+Compile Time Configuration
+==========================
 
--DAUTOCONF
- use configuration the controller reports (AHA-152x only)
+(go into AHA152X in drivers/scsi/Makefile):
 
--DSKIP_BIOSTEST
- Don't test for BIOS signature (AHA-1510 or disabled BIOS)
+- DAUTOCONF
+    use configuration the controller reports (AHA-152x only)
 
--DSETUP0="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
- override for the first controller 
+- DSKIP_BIOSTEST
+    Don't test for BIOS signature (AHA-1510 or disabled BIOS)
 
--DSETUP1="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
- override for the second controller
+- DSETUP0="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
+    override for the first controller
 
--DAHA152X_DEBUG
- enable debugging output
+- DSETUP1="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
+    override for the second controller
 
--DAHA152X_STAT
- enable some statistics
+- DAHA152X_DEBUG
+    enable debugging output
 
+- DAHA152X_STAT
+    enable some statistics
 
-LILO COMMAND LINE OPTIONS:
 
-aha152x=<IOPORT>[,<IRQ>[,<SCSI-ID>[,<RECONNECT>[,<PARITY>[,<SYNCHRONOUS>[,<DELAY> [,<EXT_TRANS]]]]]]]
+LILO Command Line Options
+=========================
+
+ ::
+
+    aha152x=<IOPORT>[,<IRQ>[,<SCSI-ID>[,<RECONNECT>[,<PARITY>[,<SYNCHRONOUS>[,<DELAY> [,<EXT_TRANS]]]]]]]
 
  The normal configuration can be overridden by specifying a command line.
  When you do this, the BIOS test is skipped. Entered values have to be
@@ -58,17 +72,21 @@ aha152x=<IOPORT>[,<IRQ>[,<SCSI-ID>[,<RECONNECT>[,<PARITY>[,<SYNCHRONOUS>[,<DELAY
  For two controllers use the aha152x statement twice.
 
 
-SYMBOLS FOR MODULE CONFIGURATION:
+Symbols for Module Configuration
+================================
 
 Choose from 2 alternatives:
 
-1. specify everything (old)
+1. specify everything (old)::
+
+    aha152x=IOPORT,IRQ,SCSI_ID,RECONNECT,PARITY,SYNCHRONOUS,DELAY,EXT_TRANS
 
-aha152x=IOPORT,IRQ,SCSI_ID,RECONNECT,PARITY,SYNCHRONOUS,DELAY,EXT_TRANS
   configuration override for first controller
 
+  ::
+
+    aha152x1=IOPORT,IRQ,SCSI_ID,RECONNECT,PARITY,SYNCHRONOUS,DELAY,EXT_TRANS
 
-aha152x1=IOPORT,IRQ,SCSI_ID,RECONNECT,PARITY,SYNCHRONOUS,DELAY,EXT_TRANS
   configuration override for second controller
 
 2. specify only what you need to (irq or io is required; new)
@@ -101,7 +119,8 @@ exttrans=EXTTRANS0[,EXTTRANS1]
 If you use both alternatives the first will be taken.
 
 
-NOTES ON EXT_TRANS: 
+Notes on EXT_TRANS
+==================
 
 SCSI uses block numbers to address blocks/sectors on a device.
 The BIOS uses a cylinder/head/sector addressing scheme (C/H/S)
@@ -150,8 +169,9 @@ geometry right in most cases:
 - for disks<1GB: use default translation (C/32/64)
 
 - for disks>1GB:
+
   - take current geometry from the partition table
-    (using scsicam_bios_param and accept only `valid' geometries,
+    (using scsicam_bios_param and accept only 'valid' geometries,
     ie. either (C/32/64) or (C/63/255)).  This can be extended translation
     even if it's not enabled in the driver.
 
@@ -161,7 +181,8 @@ geometry right in most cases:
     disks.
 
 
-REFERENCES USED:
+References Used
+===============
 
  "AIC-6260 SCSI Chip Specification", Adaptec Corporation.
 
@@ -177,7 +198,7 @@ REFERENCES USED:
 
  Drew Eckhardt ([email protected])
 
- Eric Youngdale ([email protected]) 
+ Eric Youngdale ([email protected])
 
  special thanks to Eric Youngdale for the free(!) supplying the
  documentation on the chip.
Documentation/scsi/index.rst +1 -0
index df526a0ceccf..8404e991b588 100644
@@ -10,5 +10,6 @@ Linux SCSI Subsystem
    53c700
    aacraid
    advansys
+   aha152x
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.txt +1 -1
index 25a4b4cf04a6..064d6dfcac26 100644
@@ -16,7 +16,7 @@ parameters may be changed at runtime by the command
 			See header of drivers/scsi/advansys.c.
 
 	aha152x=	[HW,SCSI]
-			See Documentation/scsi/aha152x.txt.
+			See Documentation/scsi/aha152x.rst.
 
 	aha1542=	[HW,SCSI]
 			Format: <portbase>[,<buson>,<busoff>[,<dmaspeed>]]
drivers/scsi/Kconfig +1 -1
index a153444318fb..18af62594bc0 100644
@@ -383,7 +383,7 @@ config SCSI_AHA152X
 
 	  It is explained in section 3.3 of the SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>. You might also want to
-	  read the file <file:Documentation/scsi/aha152x.txt>.
+	  read the file <file:Documentation/scsi/aha152x.rst>.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called aha152x.
drivers/scsi/aha152x.c +2 -2
index eb466c2e1839..90f97df1c42a 100644
@@ -220,7 +220,7 @@
  *
  **************************************************************************
 
- see Documentation/scsi/aha152x.txt for configuration details
+ see Documentation/scsi/aha152x.rst for configuration details
 
  **************************************************************************/
 
@@ -1249,7 +1249,7 @@ static int aha152x_biosparam(struct scsi_device *sdev, struct block_device *bdev
 				       "aha152x: unable to verify geometry for disk with >1GB.\n"
 				       "         Using default translation. Please verify yourself.\n"
 				       "         Perhaps you need to enable extended translation in the driver.\n"
-				       "         See Documentation/scsi/aha152x.txt for details.\n");
+				       "         See Documentation/scsi/aha152x.rst for details.\n");
 			}
 		} else {
 			info_array[0] = info[0];
Signature · 1 line
2.21.1
#7 lore raw

PATCH 7/42 docs: scsi: convert aic79xx.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{aic79xx.txt => aic79xx.rst}         | 586 ++++++++++--------
 Documentation/scsi/index.rst                  |   1 +
 Documentation/scsi/scsi-parameters.txt        |   2 +-
 drivers/scsi/aic7xxx/Kconfig.aic79xx          |   2 +-
 4 files changed, 344 insertions(+), 247 deletions(-)
 rename Documentation/scsi/{aic79xx.txt => aic79xx.rst} (48%)
Documentation/scsi/aic79xx.rst renamed from Documentation/scsi/aic79xx.txt +341 -245
similarity index 48%
rename from Documentation/scsi/aic79xx.txt
rename to Documentation/scsi/aic79xx.rst
index e2d3273000d4..071ff5111a4f 100644
@@ -1,11 +1,13 @@
-====================================================================
-=             Adaptec Ultra320 Family Manager Set                  =
-=                                                                  =
-=                            README for                            =
-=                    The Linux Operating System                    =
-====================================================================
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
 
-The following information is available in this file:
+===================================
+Adaptec Ultra320 Family Manager Set
+===================================
+
+README for The Linux Operating System
+
+.. The following information is available in this file:
 
   1. Supported Hardware
   2. Version History
@@ -15,28 +17,32 @@ The following information is available in this file:
 
 
 1. Supported Hardware
+=====================
 
-   The following Adaptec SCSI Host Adapters are supported by this 
-   driver set. 
+   The following Adaptec SCSI Host Adapters are supported by this
+   driver set.
 
+   =============              =========================================
    Ultra320 ASIC              Description
-   ----------------------------------------------------------------
-   AIC-7901A                  Single Channel 64-bit PCI-X 133MHz to 
+   =============              =========================================
+   AIC-7901A                  Single Channel 64-bit PCI-X 133MHz to
                               Ultra320 SCSI ASIC
-   AIC-7901B                  Single Channel 64-bit PCI-X 133MHz to 
+   AIC-7901B                  Single Channel 64-bit PCI-X 133MHz to
                               Ultra320 SCSI ASIC with Retained Training
-   AIC-7902A4                 Dual Channel 64-bit PCI-X 133MHz to 
+   AIC-7902A4                 Dual Channel 64-bit PCI-X 133MHz to
                               Ultra320 SCSI ASIC
    AIC-7902B                  Dual Channel 64-bit PCI-X 133MHz to
                               Ultra320 SCSI ASIC with Retained Training
+   =============              =========================================
 
+   ========================== ===================================== ============
    Ultra320 Adapters          Description                              ASIC
-   --------------------------------------------------------------------------
+   ========================== ===================================== ============
    Adaptec SCSI Card 39320    Dual Channel 64-bit PCI-X 133MHz to   7902A4/7902B
-                              Ultra320 SCSI Card (one external 
+                              Ultra320 SCSI Card (one external
                               68-pin, two internal 68-pin)
    Adaptec SCSI Card 39320A   Dual Channel 64-bit PCI-X 133MHz to      7902B
-                              Ultra320 SCSI Card (one external 
+                              Ultra320 SCSI Card (one external
                               68-pin, two internal 68-pin)
    Adaptec SCSI Card 39320D   Dual Channel 64-bit PCI-X 133MHz to      7902A4
                               Ultra320 SCSI Card (two external VHDC
@@ -46,11 +52,11 @@ The following information is available in this file:
                               and one internal 68-pin) based on the
                               AIC-7902B ASIC
    Adaptec SCSI Card 29320    Single Channel 64-bit PCI-X 133MHz to    7901A
-                              Ultra320 SCSI Card (one external 
+                              Ultra320 SCSI Card (one external
                               68-pin, two internal 68-pin, one
                               internal 50-pin)
    Adaptec SCSI Card 29320A   Single Channel 64-bit PCI-X 133MHz to    7901B
-                              Ultra320 SCSI Card (one external 
+                              Ultra320 SCSI Card (one external
                               68-pin, two internal 68-pin, one
                               internal 50-pin)
    Adaptec SCSI Card 29320LP  Single Channel 64-bit Low Profile        7901A
@@ -61,18 +67,22 @@ The following information is available in this file:
                               PCI-X 133MHz to Ultra320 SCSI Card
                               (One external VHDC, one internal
                               68-pin)
+   ========================== ===================================== ============
+
 2. Version History
+==================
 
-   3.0	  (December 1st, 2005)
+
+ * 3.0	  (December 1st, 2005)
 	- Updated driver to use SCSI transport class infrastructure
 	- Upported sequencer and core fixes from adaptec released
 	  version 2.0.15 of the driver.
 
-   1.3.11 (July 11, 2003)
+ * 1.3.11 (July 11, 2003)
         - Fix several deadlock issues.
         - Add 29320ALP and 39320B Id's.
 
-   1.3.10 (June 3rd, 2003)
+ * 1.3.10 (June 3rd, 2003)
         - Align the SCB_TAG field on a 16byte boundary.  This avoids
           SCB corruption on some PCI-33 busses.
         - Correct non-zero luns on Rev B. hardware.
@@ -87,7 +97,7 @@ The following information is available in this file:
           by some other driver probe that occurred before we
           claimed the controller.
 
-   1.3.9 (May 22nd, 2003)
+ * 1.3.9 (May 22nd, 2003)
         - Fix compiler errors.
         - Remove S/G splitting for segments that cross a 4GB boundary.
           This is guaranteed not to happen in Linux.
@@ -100,7 +110,7 @@ The following information is available in this file:
           if the transaction data length was even and we received
           an IWR message.
 
-   1.3.8 (April 29th, 2003)
+ * 1.3.8 (April 29th, 2003)
         - Fix types accessed via the command line interface code.
         - Perform a few firmware optimizations.
         - Fix "Unexpected PKT busfree" errors.
@@ -113,7 +123,7 @@ The following information is available in this file:
         - Add support for new 2.5.X interrupt API.
         - Correct big-endian architecture support.
 
-   1.3.7 (April 16th, 2003)
+ * 1.3.7 (April 16th, 2003)
         - Use del_timer_sync() to ensure that no timeouts
           are pending during controller shutdown.
         - For pre-2.5.X kernels, carefully adjust our segment
@@ -122,14 +132,14 @@ The following information is available in this file:
         - Workaround duplicate device entries in the mid-layer
           device list during add-single-device.
 
-   1.3.6 (March 28th, 2003)
+ * 1.3.6 (March 28th, 2003)
         - Correct a double free in the Domain Validation code.
         - Correct a reference to free'ed memory during controller
           shutdown.
         - Reset the bus on an SE->LVD change.  This is required
           to reset our transceivers.
 
-   1.3.5 (March 24th, 2003)
+ * 1.3.5 (March 24th, 2003)
         - Fix a few register window mode bugs.
         - Include read streaming in the PPR flags we display in
           diagnostics as well as /proc.
@@ -144,16 +154,16 @@ The following information is available in this file:
         - Cleanup command line parsing and move much of this code
           to aiclib.
 
-   1.3.4 (February 28th, 2003)
+ * 1.3.4 (February 28th, 2003)
         - Correct a race condition in our error recovery handler.
         - Allow Test Unit Ready commands to take a full 5 seconds
           during Domain Validation.
 
-   1.3.2 (February 19th, 2003)
+ * 1.3.2 (February 19th, 2003)
         - Correct a Rev B. regression due to the GEM318
           compatibility fix included in 1.3.1.
-          
-   1.3.1 (February 11th, 2003)
+
+ * 1.3.1 (February 11th, 2003)
         - Add support for the 39320A.
         - Improve recovery for certain PCI-X errors.
         - Fix handling of LQ/DATA/LQ/DATA for the
@@ -166,42 +176,43 @@ The following information is available in this file:
         - Adapt to a change in the 2.5.X daemonize() API.
         - Correct a "Missing case in ahd_handle_scsiint" panic.
 
-   1.3.0 (January 21st, 2003)
+ * 1.3.0 (January 21st, 2003)
         - Full regression testing for all U320 products completed.
         - Added abort and target/lun reset error recovery handler and
           interrupt coalescing.
 
-   1.2.0 (November 14th, 2002)
+ * 1.2.0 (November 14th, 2002)
         - Added support for Domain Validation
         - Add support for the Hewlett-Packard version of the 39320D
           and AIC-7902 adapters.
+
         Support for previous adapters has not been fully tested and should
         only be used at the customer's own risk.
 
-   1.1.1 (September 24th, 2002)
+ * 1.1.1 (September 24th, 2002)
         - Added support for the Linux 2.5.X kernel series
 
-   1.1.0 (September 17th, 2002)
+ * 1.1.0 (September 17th, 2002)
         - Added support for four additional SCSI products:
           ASC-39320, ASC-29320, ASC-29320LP, AIC-7901.
 
-   1.0.0 (May 30th, 2002)
+ * 1.0.0 (May 30th, 2002)
         - Initial driver release.
 
-   2.1. Software/Hardware Features
+ * 2.1. Software/Hardware Features
         - Support for the SPI-4 "Ultra320" standard:
           - 320MB/s transfer rates
           - Packetized SCSI Protocol at 160MB/s and 320MB/s
           - Quick Arbitration Selection (QAS)
           - Retained Training Information (Rev B. ASIC only)
         - Interrupt Coalescing
-        - Initiator Mode (target mode not currently 
+        - Initiator Mode (target mode not currently
           supported)
         - Support for the PCI-X standard up to 133MHz
         - Support for the PCI v2.2 standard
         - Domain Validation
 
-   2.2. Operating System Support:
+ * 2.2. Operating System Support:
         - Redhat Linux 7.2, 7.3, 8.0, Advanced Server 2.1
         - SuSE Linux 7.3, 8.0, 8.1, Enterprise Server 7
         - only Intel and AMD x86 supported at this time
@@ -210,197 +221,278 @@ The following information is available in this file:
      Refer to the User's Guide for more details on this.
 
 3. Command Line Options
+=======================
 
-        WARNING: ALTERING OR ADDING THESE DRIVER PARAMETERS
+    .. Warning::
+
+	         ALTERING OR ADDING THESE DRIVER PARAMETERS
                  INCORRECTLY CAN RENDER YOUR SYSTEM INOPERABLE.
-                 USE THEM WITH CAUTION. 
+                 USE THEM WITH CAUTION.
 
    Put a .conf file in the /etc/modprobe.d/ directory and add/edit a
-   line containing 'options aic79xx aic79xx=[command[,command...]]' where
-   'command' is one or more of the following:
-   -----------------------------------------------------------------
-              Option: verbose
-          Definition: enable additional informative messages during
-                      driver operation.
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: debug:[value]
-          Definition: Enables various levels of debugging information
-                      The bit definitions for the debugging mask can
-                      be found in drivers/scsi/aic7xxx/aic79xx.h under
-                      the "Debug" heading.
-     Possible Values: 0x0000 = no debugging, 0xffff = full debugging
-       Default Value: 0x0000
-   -----------------------------------------------------------------
-              Option: no_reset
-          Definition: Do not reset the bus during the initial probe
-                      phase
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: extended
-          Definition: Force extended translation on the controller
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: periodic_otag
-          Definition: Send an ordered tag periodically to prevent
-                      tag starvation.  Needed for some older devices
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: reverse_scan
-          Definition: Probe the scsi bus in reverse order, starting
-                      with target 15
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: global_tag_depth
-          Definition: Global tag depth for all targets on all busses.
-                      This option sets the default tag depth which
-                      may be selectively overridden vi the tag_info
-                      option.
-     Possible Values: 1 - 253
-       Default Value: 32
-   -----------------------------------------------------------------
-              Option: tag_info:{{value[,value...]}[,{value[,value...]}...]}
-          Definition: Set the per-target tagged queue depth on a
-                      per controller basis.  Both controllers and targets
-                      may be omitted indicating that they should retain
-                      the default tag depth.
-            Examples: tag_info:{{16,32,32,64,8,8,,32,32,32,32,32,32,32,32,32}
-                        On Controller 0
-                          specifies a tag depth of 16 for target 0
-                          specifies a tag depth of 64 for target 3
-                          specifies a tag depth of 8 for targets 4 and 5
-                          leaves target 6 at the default
-                          specifies a tag depth of 32 for targets 1,2,7-15
-                        All other targets retain the default depth.
-
-                      tag_info:{{},{32,,32}}
-                        On Controller 1
-                          specifies a tag depth of 32 for targets 0 and 2
-                        All other targets retain the default depth.
-                        
-     Possible Values: 1 - 253
-       Default Value: 32
-   -----------------------------------------------------------------
-              Option: rd_strm: {rd_strm_bitmask[,rd_strm_bitmask...]}
-          Definition: Enable read streaming on a per target basis.
-                      The rd_strm_bitmask is a 16 bit hex value in which
-                      each bit represents a target.  Setting the target's
-                      bit to '1' enables read streaming for that
-                      target.  Controllers may be omitted indicating that
-                      they should retain the default read streaming setting.
-             Example: rd_strm:{0x0041}
-                        On Controller 0
-                          enables read streaming for targets 0 and 6.
-                          disables read streaming for targets 1-5,7-15.
-                        All other targets retain the default read
-                        streaming setting.
-             Example: rd_strm:{0x0023,,0xFFFF}
-                        On Controller 0
-                          enables read streaming for targets 1,2, and 5.
-                          disables read streaming for targets 3,4,6-15.
-                        On Controller 2
-                          enables read streaming for all targets.
-                        All other targets retain the default read
-                        streaming setting.
-                      
-     Possible Values: 0x0000 - 0xffff
-       Default Value: 0x0000
-   -----------------------------------------------------------------
-              Option: dv: {value[,value...]}
-          Definition: Set Domain Validation Policy on a per-controller basis.
-                      Controllers may be omitted indicating that
-                      they should retain the default read streaming setting.
-             Example: dv:{-1,0,,1,1,0}
-                        On Controller 0 leave DV at its default setting.
-                        On Controller 1 disable DV.
-                        Skip configuration on Controller 2.
-                        On Controllers 3 and 4 enable DV.
-                        On Controller 5 disable DV.
-
-     Possible Values: < 0 Use setting from serial EEPROM.
-                      0 Disable DV
-                      > 0 Enable DV
-       Default Value: DV Serial EEPROM configuration setting.
-   -----------------------------------------------------------------
-              Option: seltime:[value]
-          Definition: Specifies the selection timeout value
-     Possible Values: 0 = 256ms, 1 = 128ms, 2 = 64ms, 3 = 32ms
-       Default Value: 0
-   -----------------------------------------------------------------
-
-   *** The following three options should only be changed at ***
-   *** the direction of a technical support representative.  ***
-
-   -----------------------------------------------------------------
-              Option: precomp: {value[,value...]}
-          Definition: Set IO Cell precompensation value on a per-controller
-                      basis.
-                      Controllers may be omitted indicating that
-                      they should retain the default precompensation setting.
-             Example: precomp:{0x1}
-                        On Controller 0 set precompensation to 1.
-             Example: precomp:{1,,7}
-                        On Controller 0 set precompensation to 1.
-                        On Controller 2 set precompensation to 8.
-                      
-     Possible Values: 0 - 7
-       Default Value: Varies based on chip revision
-   -----------------------------------------------------------------
-              Option: slewrate: {value[,value...]}
-          Definition: Set IO Cell slew rate on a per-controller basis.
+   line containing ``options aic79xx aic79xx=[command[,command...]]`` where
+   ``command`` is one or more of the following:
+
+
+verbose
+    :Definition: enable additional informative messages during driver operation.
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+debug:[value]
+    :Definition: Enables various levels of debugging information
+                 The bit definitions for the debugging mask can
+                 be found in drivers/scsi/aic7xxx/aic79xx.h under
+                 the "Debug" heading.
+    :Possible Values: 0x0000 = no debugging, 0xffff = full debugging
+    :Default Value: 0x0000
+
+no_reset
+    :Definition: Do not reset the bus during the initial probe
+                 phase
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+extended
+    :Definition: Force extended translation on the controller
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+periodic_otag
+    :Definition: Send an ordered tag periodically to prevent
+                 tag starvation.  Needed for some older devices
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+reverse_scan
+    :Definition: Probe the scsi bus in reverse order, starting with target 15
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+global_tag_depth
+    :Definition: Global tag depth for all targets on all busses.
+		 This option sets the default tag depth which
+		 may be selectively overridden vi the tag_info
+		 option.
+
+    :Possible Values: 1 - 253
+    :Default Value: 32
+
+tag_info:{{value[,value...]}[,{value[,value...]}...]}
+    :Definition: Set the per-target tagged queue depth on a
+                 per controller basis.  Both controllers and targets
+                 may be omitted indicating that they should retain
+                 the default tag depth.
+
+    :Possible Values: 1 - 253
+    :Default Value: 32
+
+    Examples:
+
+
+	::
+
+	    tag_info:{{16,32,32,64,8,8,,32,32,32,32,32,32,32,32,32}
+
+	On Controller 0
+
+	    - specifies a tag depth of 16 for target 0
+	    - specifies a tag depth of 64 for target 3
+	    - specifies a tag depth of 8 for targets 4 and 5
+	    - leaves target 6 at the default
+	    - specifies a tag depth of 32 for targets 1,2,7-15
+
+	All other targets retain the default depth.
+
+	::
+
+	    tag_info:{{},{32,,32}}
+
+	On Controller 1
+
+	    - specifies a tag depth of 32 for targets 0 and 2
+
+	All other targets retain the default depth.
+
+
+rd_strm: {rd_strm_bitmask[,rd_strm_bitmask...]}
+    :Definition: Enable read streaming on a per target basis.
+		 The rd_strm_bitmask is a 16 bit hex value in which
+		 each bit represents a target.  Setting the target's
+		 bit to '1' enables read streaming for that
+		 target.  Controllers may be omitted indicating that
+		 they should retain the default read streaming setting.
+
+    Examples:
+
+	    ::
+
+		rd_strm:{0x0041}
+
+	    On Controller 0
+
+		- enables read streaming for targets 0 and 6.
+		- disables read streaming for targets 1-5,7-15.
+
+	    All other targets retain the default read
+	    streaming setting.
+
+	    ::
+
+		rd_strm:{0x0023,,0xFFFF}
+
+	    On Controller 0
+
+		- enables read streaming for targets 1,2, and 5.
+		- disables read streaming for targets 3,4,6-15.
+
+	    On Controller 2
+
+		- enables read streaming for all targets.
+
+	    All other targets retain the default read
+	    streaming setting.
+
+    :Possible Values: 0x0000 - 0xffff
+    :Default Value: 0x0000
+
+dv: {value[,value...]}
+    :Definition: Set Domain Validation Policy on a per-controller basis.
+                 Controllers may be omitted indicating that
+                 they should retain the default read streaming setting.
+
+     :Possible Values:
+
+		      ==== ===============================
+		       < 0 Use setting from serial EEPROM.
+                         0 Disable DV
+		       > 0 Enable DV
+		      ==== ===============================
+
+    :Default Value: DV Serial EEPROM configuration setting.
+
+    Example:
+
+	::
+
+	    dv:{-1,0,,1,1,0}
+
+	- On Controller 0 leave DV at its default setting.
+	- On Controller 1 disable DV.
+	- Skip configuration on Controller 2.
+	- On Controllers 3 and 4 enable DV.
+	- On Controller 5 disable DV.
+
+seltime:[value]
+    :Definition: Specifies the selection timeout value
+    :Possible Values: 0 = 256ms, 1 = 128ms, 2 = 64ms, 3 = 32ms
+    :Default Value: 0
+
+.. Warning:
+
+    The following three options should only be changed at
+    the direction of a technical support representative.
+
+
+precomp: {value[,value...]}
+    :Definition: Set IO Cell precompensation value on a per-controller basis.
+                 Controllers may be omitted indicating that
+                 they should retain the default precompensation setting.
+
+    :Possible Values: 0 - 7
+    :Default Value: Varies based on chip revision
+
+    Examples:
+
+	::
+
+	    precomp:{0x1}
+
+	On Controller 0 set precompensation to 1.
+
+	::
+
+	    precomp:{1,,7}
+
+	- On Controller 0 set precompensation to 1.
+	- On Controller 2 set precompensation to 8.
+
+slewrate: {value[,value...]}
+    :Definition: Set IO Cell slew rate on a per-controller basis.
                       Controllers may be omitted indicating that
                       they should retain the default slew rate setting.
-             Example: slewrate:{0x1}
-                        On Controller 0 set slew rate to 1.
-             Example: slewrate :{1,,8}
-                        On Controller 0 set slew rate to 1.
-                        On Controller 2 set slew rate to 8.
-                      
-     Possible Values: 0 - 15
-       Default Value: Varies based on chip revision
-   -----------------------------------------------------------------
-              Option: amplitude: {value[,value...]}
-          Definition: Set IO Cell signal amplitude on a per-controller basis.
-                      Controllers may be omitted indicating that
-                      they should retain the default read streaming setting.
-             Example: amplitude:{0x1}
-                        On Controller 0 set amplitude to 1.
-             Example: amplitude :{1,,7}
-                        On Controller 0 set amplitude to 1.
-                        On Controller 2 set amplitude to 7.
-                      
-     Possible Values: 1 - 7
-       Default Value: Varies based on chip revision
-   -----------------------------------------------------------------
-
-   Example: 'options aic79xx aic79xx=verbose,rd_strm:{{0x0041}}'
-        enables verbose output in the driver and turns read streaming on
-        for targets 0 and 6 of Controller 0.
+
+    :Possible Values: 0 - 15
+    :Default Value: Varies based on chip revision
+
+    Examples:
+
+	::
+
+	    slewrate:{0x1}
+
+	- On Controller 0 set slew rate to 1.
+
+	::
+
+	    slewrate :{1,,8}
+
+	- On Controller 0 set slew rate to 1.
+	- On Controller 2 set slew rate to 8.
+
+amplitude: {value[,value...]}
+    :Definition: Set IO Cell signal amplitude on a per-controller basis.
+                 Controllers may be omitted indicating that
+                 they should retain the default read streaming setting.
+
+    :Possible Values: 1 - 7
+    :Default Value: Varies based on chip revision
+
+    Examples:
+
+    ::
+
+	amplitude:{0x1}
+
+    On Controller 0 set amplitude to 1.
+
+    ::
+
+	amplitude :{1,,7}
+
+    - On Controller 0 set amplitude to 1.
+    - On Controller 2 set amplitude to 7.
+
+Example::
+
+    options aic79xx aic79xx=verbose,rd_strm:{{0x0041}}
+
+enables verbose output in the driver and turns read streaming on
+for targets 0 and 6 of Controller 0.
 
 4. Additional Notes
+===================
 
-   4.1. Known/Unresolved or FYI Issues
+4.1. Known/Unresolved or FYI Issues
+-----------------------------------
 
         * Under SuSE Linux Enterprise 7, the driver may fail to operate
           correctly due to a problem with PCI interrupt routing in the
           Linux kernel.  Please contact SuSE for an updated Linux
           kernel.
 
-   4.2. Third-Party Compatibility Issues
+4.2. Third-Party Compatibility Issues
+-------------------------------------
 
         * Adaptec only supports Ultra320 hard drives running
           the latest firmware available. Please check with
           your hard drive manufacturer to ensure you have the
           latest version.
 
-   4.3. Operating System or Technology Limitations
-        
-        * PCI Hot Plug is untested and may cause the operating system 
+4.3. Operating System or Technology Limitations
+-----------------------------------------------
+
+        * PCI Hot Plug is untested and may cause the operating system
           to stop responding.
         * Luns that are not numbered contiguously starting with 0 might not
           be automatically probed during system startup.  This is a limitation
@@ -417,30 +509,34 @@ The following information is available in this file:
 
 
 5. Adaptec Customer Support
+===========================
 
-   A Technical Support Identification (TSID) Number is required for 
+   A Technical Support Identification (TSID) Number is required for
    Adaptec technical support.
+
     - The 12-digit TSID can be found on the white barcode-type label
-      included inside the box with your product.  The TSID helps us 
-      provide more efficient service by accurately identifying your 
+      included inside the box with your product.  The TSID helps us
+      provide more efficient service by accurately identifying your
       product and support status.
 
    Support Options
     - Search the Adaptec Support Knowledgebase (ASK) at
       http://ask.adaptec.com for articles, troubleshooting tips, and
       frequently asked questions about your product.
-    - For support via Email, submit your question to Adaptec's 
+    - For support via Email, submit your question to Adaptec's
       Technical Support Specialists at http://ask.adaptec.com/.
-     
+
    North America
     - Visit our Web site at http://www.adaptec.com/.
     - For information about Adaptec's support options, call
       408-957-2550, 24 hours a day, 7 days a week.
     - To speak with a Technical Support Specialist,
+
       * For hardware products, call 408-934-7274,
         Monday to Friday, 3:00 am to 5:00 pm, PDT.
       * For RAID and Fibre Channel products, call 321-207-2000,
         Monday to Friday, 3:00 am to 5:00 pm, PDT.
+
       To expedite your service, have your computer with you.
     - To order Adaptec products, including accessories and cables,
       call 408-957-7274.  To order cables online go to
@@ -449,49 +545,49 @@ The following information is available in this file:
    Europe
     - Visit our Web site at http://www.adaptec.com/en-US/_common/world_index.
     - To speak with a Technical Support Specialist, call, or email,
+
       * German:  +49 89 4366 5522, Monday-Friday, 9:00-17:00 CET,
         http://ask-de.adaptec.com/.
       * French:  +49 89 4366 5533, Monday-Friday, 9:00-17:00 CET,
 	http://ask-fr.adaptec.com/.
       * English: +49 89 4366 5544, Monday-Friday, 9:00-17:00 GMT,
 	http://ask.adaptec.com/.
+
     - You can order Adaptec cables online at
       http://www.adaptec.com/buy-cables/.
 
    Japan
     - Visit our web site at http://www.adaptec.co.jp/.
-    - To speak with a Technical Support Specialist, call 
+    - To speak with a Technical Support Specialist, call
       +81 3 5308 6120, Monday-Friday, 9:00 a.m. to 12:00 p.m.,
       1:00 p.m. to 6:00 p.m.
 
--------------------------------------------------------------------
-/*
- * Copyright (c) 2003 Adaptec Inc. 691 S. Milpitas Blvd., Milpitas CA 95035 USA.
- * All rights reserved.
- *
- * You are permitted to redistribute, use and modify this README file in whole
- * or in part in conjunction with redistribution of software governed by the
- * General Public License, provided that the following conditions are met:
- * 1. Redistributions of README file must retain the above copyright
- *    notice, this list of conditions, and the following disclaimer,
- *    without modification.
- * 2. The name of the author may not be used to endorse or promote products
- *    derived from this software without specific prior written permission.
- * 3. Modifications or new contributions must be attributed in a copyright
- *    notice identifying the author ("Contributor") and added below the
- *    original copyright notice. The copyright notice is for purposes of
- *    identifying contributors and should not be deemed as permission to alter
- *    the permissions given by Adaptec.
- *
- * THIS README FILE IS PROVIDED BY ADAPTEC AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, ANY
- * WARRANTIES OF NON-INFRINGEMENT OR THE IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
- * ADAPTEC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS README
- * FILE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+Copyright |copy| 2003 Adaptec Inc. 691 S. Milpitas Blvd., Milpitas CA 95035 USA.
+All rights reserved.
+
+You are permitted to redistribute, use and modify this README file in whole
+or in part in conjunction with redistribution of software governed by the
+General Public License, provided that the following conditions are met:
+
+1. Redistributions of README file must retain the above copyright
+   notice, this list of conditions, and the following disclaimer,
+   without modification.
+2. The name of the author may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+3. Modifications or new contributions must be attributed in a copyright
+   notice identifying the author ("Contributor") and added below the
+   original copyright notice. The copyright notice is for purposes of
+   identifying contributors and should not be deemed as permission to alter
+   the permissions given by Adaptec.
+
+THIS README FILE IS PROVIDED BY ADAPTEC AND CONTRIBUTORS ``AS IS`` AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, ANY
+WARRANTIES OF NON-INFRINGEMENT OR THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ADAPTEC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS README
+FILE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Documentation/scsi/index.rst +1 -0
index 8404e991b588..b7fdfc0cb956 100644
@@ -11,5 +11,6 @@ Linux SCSI Subsystem
    aacraid
    advansys
    aha152x
+   aic79xx
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.txt +1 -1
index 064d6dfcac26..8ed9c662a1d4 100644
@@ -25,7 +25,7 @@ parameters may be changed at runtime by the command
 			See Documentation/scsi/aic7xxx.txt.
 
 	aic79xx=	[HW,SCSI]
-			See Documentation/scsi/aic79xx.txt.
+			See Documentation/scsi/aic79xx.rst.
 
 	atascsi=	[HW,SCSI]
 			See drivers/scsi/atari_scsi.c.
drivers/scsi/aic7xxx/Kconfig.aic79xx +1 -1
index 16743fb9eead..d4c50b8fce29 100644
@@ -32,7 +32,7 @@ config AIC79XX_CMDS_PER_DEVICE
 	on some devices.  The upper bound is 253.  0 disables tagged queueing.
 
 	Per device tag depth can be controlled via the kernel command line
-	"tag_info" option.  See Documentation/scsi/aic79xx.txt for details.
+	"tag_info" option.  See Documentation/scsi/aic79xx.rst for details.
 
 config AIC79XX_RESET_DELAY_MS
 	int "Initial bus reset delay in milli-seconds"
Signature · 1 line
2.21.1
#8 lore raw

Re: [PATCH 07/42] docs: scsi: convert aic79xx.txt to ReST

If you touch this please remove the obsolete version history, and the very out of data version information. Same for aic7xxx and probably a few other drivers as well.

#9 lore raw

PATCH 8/42 docs: scsi: convert aic7xxx.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{aic7xxx.txt => aic7xxx.rst}         | 446 ++++++++++--------
 Documentation/scsi/index.rst                  |   1 +
 Documentation/scsi/scsi-parameters.txt        |   2 +-
 drivers/scsi/aic7xxx/Kconfig.aic7xxx          |   2 +-
 4 files changed, 258 insertions(+), 193 deletions(-)
 rename Documentation/scsi/{aic7xxx.txt => aic7xxx.rst} (49%)
Documentation/scsi/aic7xxx.rst renamed from Documentation/scsi/aic7xxx.txt +255 -191
similarity index 49%
rename from Documentation/scsi/aic7xxx.txt
rename to Documentation/scsi/aic7xxx.rst
index 7c5d0223d444..bad0e5567b21 100644
@@ -1,8 +1,11 @@
-====================================================================
-=    Adaptec Aic7xxx Fast -> Ultra160 Family Manager Set v7.0      =
-=                            README for                            =
-=                     The Linux Operating System                   =
-====================================================================
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+
+========================================================
+Adaptec Aic7xxx Fast -> Ultra160 Family Manager Set v7.0
+========================================================
+
+README for The Linux Operating System
 
 The following information is available in this file:
 
@@ -12,13 +15,15 @@ The following information is available in this file:
   4. Contacting Adaptec
 
 1. Supported Hardware
+=====================
 
    The following Adaptec SCSI Chips and Host Adapters are supported by
-   the aic7xxx driver. 
+   the aic7xxx driver.
 
-   Chip    MIPS  Host Bus  MaxSync  MaxWidth  SCBs  Notes
-   ---------------------------------------------------------------
-   aic7770  10    EISA/VL   10MHz    16Bit      4   1
+   ======== ===== ========= ======== ========= ===== ===============
+   Chip     MIPS  Host Bus  MaxSync  MaxWidth  SCBs  Notes
+   ======== ===== ========= ======== ========= ===== ===============
+   aic7770  10    EISA/VL   10MHz    16Bit      4    1
    aic7850  10    PCI/32    10MHz    8Bit       3
    aic7855  10    PCI/32    10MHz    8Bit       3
    aic7856  10    PCI/32    10MHz    8Bit       3
@@ -28,12 +33,13 @@ The following information is available in this file:
    aic7880  10    PCI/32    20MHz    16Bit      16
    aic7890  20    PCI/32    40MHz    16Bit      16      3 4 5 6 7 8
    aic7891  20    PCI/64    40MHz    16Bit      16      3 4 5 6 7 8
-   aic7892  20   PCI/64-66  80MHz    16Bit      16      3 4 5 6 7 8
+   aic7892  20    PCI/64-66 80MHz    16Bit      16      3 4 5 6 7 8
    aic7895  15    PCI/32    20MHz    16Bit      16    2 3 4 5
    aic7895C 15    PCI/32    20MHz    16Bit      16    2 3 4 5     8
    aic7896  20    PCI/32    40MHz    16Bit      16    2 3 4 5 6 7 8
    aic7897  20    PCI/64    40MHz    16Bit      16    2 3 4 5 6 7 8
-   aic7899  20   PCI/64-66  80MHz    16Bit      16    2 3 4 5 6 7 8
+   aic7899  20    PCI/64-66 80MHz    16Bit      16    2 3 4 5 6 7 8
+   ======== ===== ========= ======== ========= ===== ===============
 
    1.   Multiplexed Twin Channel Device - One controller servicing two
         busses.
@@ -44,15 +50,16 @@ The following information is available in this file:
         for all possible target/lun combinations.
    5.   Block Move Instruction Support - Doubles the speed of certain
         sequencer operations.
-   6.   `Bayonet' style Scatter Gather Engine - Improves S/G prefetch
+   6.   'Bayonet' style Scatter Gather Engine - Improves S/G prefetch
         performance.
    7.   Queuing Registers - Allows queuing of new transactions without
         pausing the sequencer.
    8.   Multiple Target IDs - Allows the controller to respond to selection
         as a target on multiple SCSI IDs.
 
+   ============== ======= =========== =============== =============== =========
    Controller      Chip   Host-Bus    Int-Connectors  Ext-Connectors  Notes
-   --------------------------------------------------------------------------
+   ============== ======= =========== =============== =============== =========
    AHA-274X[A]    aic7770   EISA         SE-50M         SE-HD50F
    AHA-274X[A]W   aic7770   EISA         SE-HD68F       SE-HD68F
                                          SE-50M
@@ -73,7 +80,7 @@ The following information is available in this file:
    AHA-2915C      aic7860   PCI/32       SE-50M
    AHA-2940AU/CN  aic7860   PCI/32       SE-50M         SE-HD50F
    AHA-2944W      aic7870   PCI/32     HVD-HD68F        HVD-HD68F
-                                        HVD-50M
+                                       HVD-50M
    AHA-3940W      aic7870   PCI/32     2 X SE-HD68F     SE-HD68F        2
    AHA-2940UW     aic7880   PCI/32       SE-HD68F
                                          SE-50M         SE-HD68F
@@ -85,12 +92,12 @@ The following information is available in this file:
    AHA-3940UWD    aic7880   PCI/32     2 X SE-HD68F   2 X SE-VHD68F       3
    AHA-3940U      aic7880   PCI/32     2 X SE-50M       SE-HD50F          3
    AHA-2944UW     aic7880   PCI/32      HVD-HD68F       HVD-HD68F
-                                         HVD-50M
+                                        HVD-50M
    AHA-3944UWD    aic7880   PCI/32     2 X HVD-HD68F  2 X HVD-VHD68F      3
    AHA-4944UW     aic7880   PCI/32
    AHA-2930UW     aic7880   PCI/32
    AHA-2940UW Pro aic7880   PCI/32      SE-HD68F        SE-HD68F            4
-                                         SE-50M
+                                        SE-50M
    AHA-2940UW/CN  aic7880   PCI/32
    AHA-2940UDual  aic7895   PCI/32
    AHA-2940UWDual aic7895   PCI/32
@@ -102,27 +109,28 @@ The following information is available in this file:
    AHA-2940U2B    aic7890   PCI/32      LVD-HD68F       LVD-HD68F
    AHA-2940U2 OEM aic7891   PCI/64
    AHA-2940U2W    aic7890   PCI/32      LVD-HD68F       LVD-HD68F
-                                        SE-HD68F 
-                                         SE-50M
+                                        SE-HD68F
+                                        SE-50M
    AHA-2950U2B    aic7891   PCI/64      LVD-HD68F       LVD-HD68F
    AHA-2930U2     aic7890   PCI/32      LVD-HD68F       SE-HD50F
-                                         SE-50M 
+                                        SE-50M
    AHA-3950U2B    aic7897   PCI/64
    AHA-3950U2D    aic7897   PCI/64
    AHA-29160      aic7892   PCI/64-66
    AHA-29160 CPQ  aic7892   PCI/64-66
    AHA-29160N     aic7892   PCI/32      LVD-HD68F       SE-HD50F
-                                         SE-50M
+                                        SE-50M
    AHA-29160LP    aic7892   PCI/64-66
    AHA-19160      aic7892   PCI/64-66
    AHA-29150LP    aic7892   PCI/64-66
    AHA-29130LP    aic7892   PCI/64-66
    AHA-3960D      aic7899   PCI/64-66  2 X LVD-HD68F  2 X LVD-VHD68F
-                                         LVD-50M
+                                       LVD-50M
    AHA-3960D CPQ  aic7899   PCI/64-66  2 X LVD-HD68F  2 X LVD-VHD68F
-                                         LVD-50M
+                                       LVD-50M
    AHA-39160      aic7899   PCI/64-66  2 X LVD-HD68F  2 X LVD-VHD68F
-                                         LVD-50M
+                                       LVD-50M
+   ============== ======= =========== =============== =============== =========
 
    1. No BIOS support
    2. DEC21050 PCI-PCI bridge with multiple controller chips on secondary bus
@@ -131,11 +139,14 @@ The following information is available in this file:
       SCSI "stub" effects.
 
 2. Version History
-   7.0	  (4th August, 2005)
+==================
+
+   * 7.0	  (4th August, 2005)
 	- Updated driver to use SCSI transport class infrastructure
 	- Upported sequencer and core fixes from last adaptec released
 	  version of the driver.
-   6.2.36 (June 3rd, 2003)
+
+   * 6.2.36 (June 3rd, 2003)
         - Correct code that disables PCI parity error checking.
         - Correct and simplify handling of the ignore wide residue
           message.  The previous code would fail to report a residual
@@ -153,18 +164,18 @@ The following information is available in this file:
           by some other driver probe that occurred before we
           claimed the controller.
 
-   6.2.35 (May 14th, 2003)
+   * 6.2.35 (May 14th, 2003)
         - Fix a few GCC 3.3 compiler warnings.
         - Correct operation on EISA Twin Channel controller.
         - Add support for 2.5.X's scsi_report_device_reset().
 
-   6.2.34 (May 5th, 2003)
+   * 6.2.34 (May 5th, 2003)
         - Fix locking regression introduced in 6.2.29 that
           could cause a lock order reversal between the io_request_lock
           and our per-softc lock.  This was only possible on RH9,
           SuSE, and kernel.org 2.4.X kernels.
 
-   6.2.33 (April 30th, 2003)
+   * 6.2.33 (April 30th, 2003)
         - Dynamically disable PCI parity error reporting after
           10 errors are reported to the user.  These errors are
           the result of some other device issuing PCI transactions
@@ -172,172 +183,224 @@ The following information is available in this file:
           problem, continuing to report the errors just degrades
           our performance.
 
-   6.2.32 (March 28th, 2003)
+   * 6.2.32 (March 28th, 2003)
         - Dynamically sized S/G lists to avoid SCSI malloc
           pool fragmentation and SCSI mid-layer deadlock.
 
-   6.2.28 (January 20th, 2003)
+   * 6.2.28 (January 20th, 2003)
         - Domain Validation Fixes
         - Add ability to disable PCI parity error checking.
         - Enhanced Memory Mapped I/O probe
 
-   6.2.20 (November 7th, 2002)
+   * 6.2.20 (November 7th, 2002)
         - Added Domain Validation.
 
 3. Command Line Options
+=======================
 
-        WARNING: ALTERING OR ADDING THESE DRIVER PARAMETERS
+
+    .. Warning::
+
+                 ALTERING OR ADDING THESE DRIVER PARAMETERS
                  INCORRECTLY CAN RENDER YOUR SYSTEM INOPERABLE.
-                 USE THEM WITH CAUTION. 
+                 USE THEM WITH CAUTION.
 
    Put a .conf file in the /etc/modprobe.d directory and add/edit a
-   line containing 'options aic7xxx aic7xxx=[command[,command...]]' where
-   'command' is one or more of the following:
-   -----------------------------------------------------------------
-              Option: verbose
-          Definition: enable additional informative messages during
-                      driver operation.
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: debug:[value]
-          Definition: Enables various levels of debugging information
-     Possible Values: 0x0000 = no debugging, 0xffff = full debugging
-       Default Value: 0x0000
-   -----------------------------------------------------------------
-              Option: no_probe
-              Option: probe_eisa_vl
-          Definition: Do not probe for EISA/VLB controllers.
-                      This is a toggle.  If the driver is compiled
-                      to not probe EISA/VLB controllers by default,
-                      specifying "no_probe" will enable this probing.
-                      If the driver is compiled to probe EISA/VLB
-                      controllers by default, specifying "no_probe"
-                      will disable this probing.
-     Possible Values: This option is a toggle
-       Default Value: EISA/VLB probing is disabled by default.
-   -----------------------------------------------------------------
-              Option: pci_parity
-          Definition: Toggles the detection of PCI parity errors.
-                      On many motherboards with VIA chipsets,
-                      PCI parity is not generated correctly on the
-                      PCI bus.  It is impossible for the hardware to
-                      differentiate between these "spurious" parity
-                      errors and real parity errors.  The symptom of
-                      this problem is a stream of the message:
-    "scsi0: Data Parity Error Detected during address or write data phase"
-                      output by the driver.
-     Possible Values: This option is a toggle
-       Default Value: PCI Parity Error reporting is disabled
-   -----------------------------------------------------------------
-              Option: no_reset
-          Definition: Do not reset the bus during the initial probe
-                      phase
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: extended
-          Definition: Force extended translation on the controller
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: periodic_otag
-          Definition: Send an ordered tag periodically to prevent
-                      tag starvation.  Needed for some older devices
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: reverse_scan
-          Definition: Probe the scsi bus in reverse order, starting
-                      with target 15
-     Possible Values: This option is a flag
-       Default Value: disabled
-   -----------------------------------------------------------------
-              Option: global_tag_depth:[value]
-          Definition: Global tag depth for all targets on all busses.
-                      This option sets the default tag depth which
-                      may be selectively overridden vi the tag_info
-                      option.
-     Possible Values: 1 - 253
-       Default Value: 32
-   -----------------------------------------------------------------
-              Option: tag_info:{{value[,value...]}[,{value[,value...]}...]}
-          Definition: Set the per-target tagged queue depth on a
-                      per controller basis.  Both controllers and targets
-                      may be omitted indicating that they should retain
-                      the default tag depth.
-            Examples: tag_info:{{16,32,32,64,8,8,,32,32,32,32,32,32,32,32,32}
-                        On Controller 0
-                          specifies a tag depth of 16 for target 0
-                          specifies a tag depth of 64 for target 3
-                          specifies a tag depth of 8 for targets 4 and 5
-                          leaves target 6 at the default
-                          specifies a tag depth of 32 for targets 1,2,7-15
-                        All other targets retain the default depth.
-
-                      tag_info:{{},{32,,32}}
-                        On Controller 1
-                          specifies a tag depth of 32 for targets 0 and 2
-                        All other targets retain the default depth.
-                        
-     Possible Values: 1 - 253
-       Default Value: 32
-   -----------------------------------------------------------------
-              Option: seltime:[value]
-          Definition: Specifies the selection timeout value
-     Possible Values: 0 = 256ms, 1 = 128ms, 2 = 64ms, 3 = 32ms
-       Default Value: 0
-   -----------------------------------------------------------------
-              Option: dv: {value[,value...]} 
-          Definition: Set Domain Validation Policy on a per-controller basis.
-                      Controllers may be omitted indicating that
-                      they should retain the default read streaming setting.
-             Example: dv:{-1,0,,1,1,0}
-                        On Controller 0 leave DV at its default setting.
-                        On Controller 1 disable DV.
-                        Skip configuration on Controller 2.
-                        On Controllers 3 and 4 enable DV.
-                        On Controller 5 disable DV.
-
-     Possible Values: < 0 Use setting from serial EEPROM.
-                      0 Disable DV
-                      > 0 Enable DV
-
-       Default Value: SCSI-Select setting on controllers with a SCSI Select
-                      option for DV.  Otherwise, on for controllers supporting
-                      U160 speeds and off for all other controller types.
-   -----------------------------------------------------------------
-
-   Example:
-   'options aic7xxx aic7xxx=verbose,no_probe,tag_info:{{},{,,10}},seltime:1'
-        enables verbose logging, Disable EISA/VLB probing,
-        and set tag depth on Controller 1/Target 2 to 10 tags.
+   line containing ``options aic7xxx aic7xxx=[command[,command...]]`` where
+   ``command`` is one or more of the following:
+
+verbose
+
+    :Definition: enable additional informative messages during driver operation.
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+
+debug:[value]
+
+    :Definition: Enables various levels of debugging information
+    :Possible Values: 0x0000 = no debugging, 0xffff = full debugging
+    :Default Value: 0x0000
+
+no_probe
+
+probe_eisa_vl
+
+    :Definition: Do not probe for EISA/VLB controllers.
+		 This is a toggle.  If the driver is compiled
+		 to not probe EISA/VLB controllers by default,
+		 specifying "no_probe" will enable this probing.
+		 If the driver is compiled to probe EISA/VLB
+		 controllers by default, specifying "no_probe"
+		 will disable this probing.
+
+    :Possible Values: This option is a toggle
+    :Default Value: EISA/VLB probing is disabled by default.
+
+pci_parity
+
+    :Definition: Toggles the detection of PCI parity errors.
+		 On many motherboards with VIA chipsets,
+		 PCI parity is not generated correctly on the
+		 PCI bus.  It is impossible for the hardware to
+		 differentiate between these "spurious" parity
+		 errors and real parity errors.  The symptom of
+		 this problem is a stream of the message::
+
+		    "scsi0:	Data Parity Error Detected during address or write data phase"
+
+		 output by the driver.
+
+    :Possible Values: This option is a toggle
+    :Default Value: PCI Parity Error reporting is disabled
+
+no_reset
+
+    :Definition: Do not reset the bus during the initial probe
+		 phase
+
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+extended
+
+    :Definition: Force extended translation on the controller
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+periodic_otag
+
+    :Definition: Send an ordered tag periodically to prevent
+		 tag starvation.  Needed for some older devices
+
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+reverse_scan
+
+    :Definition: Probe the scsi bus in reverse order, starting
+		with target 15
+
+    :Possible Values: This option is a flag
+    :Default Value: disabled
+
+global_tag_depth:[value]
+
+    :Definition: Global tag depth for all targets on all busses.
+		 This option sets the default tag depth which
+		 may be selectively overridden vi the tag_info
+		 option.
+
+    :Possible Values: 1 - 253
+    :Default Value: 32
+
+tag_info:{{value[,value...]}[,{value[,value...]}...]}
+
+    :Definition: Set the per-target tagged queue depth on a
+		 per controller basis.  Both controllers and targets
+		 may be omitted indicating that they should retain
+		 the default tag depth.
+
+    :Possible Values: 1 - 253
+    :Default Value: 32
+
+    Examples:
+
+	    ::
+
+	        tag_info:{{16,32,32,64,8,8,,32,32,32,32,32,32,32,32,32}
+
+	    On Controller 0:
+
+		- specifies a tag depth of 16 for target 0
+		- specifies a tag depth of 64 for target 3
+		- specifies a tag depth of 8 for targets 4 and 5
+		- leaves target 6 at the default
+		- specifies a tag depth of 32 for targets 1,2,7-15
+		- All other targets retain the default depth.
+
+	    ::
+
+                tag_info:{{},{32,,32}}
+
+	    On Controller 1:
+
+		- specifies a tag depth of 32 for targets 0 and 2
+		- All other targets retain the default depth.
+
+seltime:[value]
+
+    :Definition: Specifies the selection timeout value
+    :Possible Values: 0 = 256ms, 1 = 128ms, 2 = 64ms, 3 = 32ms
+    :Default Value: 0
+
+dv: {value[,value...]}
+
+    :Definition: Set Domain Validation Policy on a per-controller basis.
+		 Controllers may be omitted indicating that
+		 they should retain the default read streaming setting.
+
+    :Possible Values:
+
+		      ==== ===============================
+		       < 0 Use setting from serial EEPROM.
+                         0 Disable DV
+		       > 0 Enable DV
+		      ==== ===============================
+
+
+    :Default Value: SCSI-Select setting on controllers with a SCSI Select
+		    option for DV.  Otherwise, on for controllers supporting
+		    U160 speeds and off for all other controller types.
+
+    Example:
+
+	    ::
+
+		dv:{-1,0,,1,1,0}
+
+	   - On Controller 0 leave DV at its default setting.
+	   - On Controller 1 disable DV.
+	   - Skip configuration on Controller 2.
+	   - On Controllers 3 and 4 enable DV.
+	   - On Controller 5 disable DV.
+
+Example::
+
+    options aic7xxx aic7xxx=verbose,no_probe,tag_info:{{},{,,10}},seltime:1
+
+enables verbose logging, Disable EISA/VLB probing,
+and set tag depth on Controller 1/Target 2 to 10 tags.
 
 4. Adaptec Customer Support
+===========================
 
-   A Technical Support Identification (TSID) Number is required for 
+   A Technical Support Identification (TSID) Number is required for
    Adaptec technical support.
+
     - The 12-digit TSID can be found on the white barcode-type label
-      included inside the box with your product.  The TSID helps us 
-      provide more efficient service by accurately identifying your 
+      included inside the box with your product.  The TSID helps us
+      provide more efficient service by accurately identifying your
       product and support status.
 
    Support Options
     - Search the Adaptec Support Knowledgebase (ASK) at
       http://ask.adaptec.com for articles, troubleshooting tips, and
       frequently asked questions about your product.
-    - For support via Email, submit your question to Adaptec's 
+    - For support via Email, submit your question to Adaptec's
       Technical Support Specialists at http://ask.adaptec.com/.
-     
+
    North America
     - Visit our Web site at http://www.adaptec.com/.
     - For information about Adaptec's support options, call
       408-957-2550, 24 hours a day, 7 days a week.
     - To speak with a Technical Support Specialist,
+
       * For hardware products, call 408-934-7274,
         Monday to Friday, 3:00 am to 5:00 pm, PDT.
       * For RAID and Fibre Channel products, call 321-207-2000,
         Monday to Friday, 3:00 am to 5:00 pm, PDT.
+
       To expedite your service, have your computer with you.
     - To order Adaptec products, including accessories and cables,
       call 408-957-7274.  To order cables online go to
@@ -346,49 +409,50 @@ The following information is available in this file:
    Europe
     - Visit our Web site at http://www.adaptec.com/en-US/_common/world_index.
     - To speak with a Technical Support Specialist, call, or email,
+
       * German:  +49 89 4366 5522, Monday-Friday, 9:00-17:00 CET,
         http://ask-de.adaptec.com/.
       * French:  +49 89 4366 5533, Monday-Friday, 9:00-17:00 CET,
 	http://ask-fr.adaptec.com/.
       * English: +49 89 4366 5544, Monday-Friday, 9:00-17:00 GMT,
 	http://ask.adaptec.com/.
+
     - You can order Adaptec cables online at
       http://www.adaptec.com/buy-cables/.
 
    Japan
     - Visit our web site at http://www.adaptec.co.jp/.
-    - To speak with a Technical Support Specialist, call 
+    - To speak with a Technical Support Specialist, call
       +81 3 5308 6120, Monday-Friday, 9:00 a.m. to 12:00 p.m.,
       1:00 p.m. to 6:00 p.m.
 
--------------------------------------------------------------------
-/*
- * Copyright (c) 2003 Adaptec Inc. 691 S. Milpitas Blvd., Milpitas CA 95035 USA.
- * All rights reserved.
- *
- * You are permitted to redistribute, use and modify this README file in whole
- * or in part in conjunction with redistribution of software governed by the
- * General Public License, provided that the following conditions are met:
- * 1. Redistributions of README file must retain the above copyright
- *    notice, this list of conditions, and the following disclaimer,
- *    without modification.
- * 2. The name of the author may not be used to endorse or promote products
- *    derived from this software without specific prior written permission.
- * 3. Modifications or new contributions must be attributed in a copyright
- *    notice identifying the author ("Contributor") and added below the
- *    original copyright notice. The copyright notice is for purposes of
- *    identifying contributors and should not be deemed as permission to alter
- *    the permissions given by Adaptec.
- *
- * THIS README FILE IS PROVIDED BY ADAPTEC AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, ANY
- * WARRANTIES OF NON-INFRINGEMENT OR THE IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
- * ADAPTEC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS README
- * FILE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+Copyright |copy| 2003 Adaptec Inc. 691 S. Milpitas Blvd., Milpitas CA 95035 USA.
+
+All rights reserved.
+
+You are permitted to redistribute, use and modify this README file in whole
+or in part in conjunction with redistribution of software governed by the
+General Public License, provided that the following conditions are met:
+
+1. Redistributions of README file must retain the above copyright
+   notice, this list of conditions, and the following disclaimer,
+   without modification.
+2. The name of the author may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+3. Modifications or new contributions must be attributed in a copyright
+   notice identifying the author ("Contributor") and added below the
+   original copyright notice. The copyright notice is for purposes of
+   identifying contributors and should not be deemed as permission to alter
+   the permissions given by Adaptec.
+
+THIS README FILE IS PROVIDED BY ADAPTEC AND CONTRIBUTORS ``AS IS`` AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, ANY
+WARRANTIES OF NON-INFRINGEMENT OR THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ADAPTEC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS README
+FILE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Documentation/scsi/index.rst +1 -0
index b7fdfc0cb956..c0b66763515f 100644
@@ -12,5 +12,6 @@ Linux SCSI Subsystem
    advansys
    aha152x
    aic79xx
+   aic7xxx
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.txt +1 -1
index 8ed9c662a1d4..266fd3b2398a 100644
@@ -22,7 +22,7 @@ parameters may be changed at runtime by the command
 			Format: <portbase>[,<buson>,<busoff>[,<dmaspeed>]]
 
 	aic7xxx=	[HW,SCSI]
-			See Documentation/scsi/aic7xxx.txt.
+			See Documentation/scsi/aic7xxx.rst.
 
 	aic79xx=	[HW,SCSI]
 			See Documentation/scsi/aic79xx.rst.
drivers/scsi/aic7xxx/Kconfig.aic7xxx +1 -1
index 3546b8cc401f..9d027549d698 100644
@@ -37,7 +37,7 @@ config AIC7XXX_CMDS_PER_DEVICE
 	on some devices.  The upper bound is 253.  0 disables tagged queueing.
 
 	Per device tag depth can be controlled via the kernel command line
-	"tag_info" option.  See Documentation/scsi/aic7xxx.txt for details.
+	"tag_info" option.  See Documentation/scsi/aic7xxx.rst for details.
 
 config AIC7XXX_RESET_DELAY_MS
 	int "Initial bus reset delay in milli-seconds"
Signature · 1 line
2.21.1
#10 lore raw

PATCH 9/42 docs: scsi: convert bfa.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{bfa.txt => bfa.rst} | 28 +++++++++++++++++--------
 Documentation/scsi/index.rst            |  1 +
 2 files changed, 20 insertions(+), 9 deletions(-)
 rename Documentation/scsi/{bfa.txt => bfa.rst} (72%)
Documentation/scsi/bfa.rst renamed from Documentation/scsi/bfa.txt +19 -9
similarity index 72%
rename from Documentation/scsi/bfa.txt
rename to Documentation/scsi/bfa.rst
index 3cc4d80d6092..3abc0411857d 100644
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================================
 Linux driver for Brocade FC/FCOE adapters
-
+=========================================
 
 Supported Hardware
 ------------------
@@ -7,8 +10,9 @@ Supported Hardware
 bfa 3.0.2.2 driver supports all Brocade FC/FCOE adapters. Below is a list of
 adapter models with corresponding PCIIDs.
 
-	PCIID		  	Model
-
+	===================	===========================================
+	PCIID			Model
+	===================	===========================================
 	1657:0013:1657:0014	425 4Gbps dual port FC HBA
 	1657:0013:1657:0014	825 8Gbps PCIe dual port FC HBA
 	1657:0013:103c:1742	HP 82B 8Gbps PCIedual port FC HBA
@@ -26,6 +30,7 @@ adapter models with corresponding PCIIDs.
 
 	1657:0022:1657:0024	1860 16Gbps FC HBA
 	1657:0022:1657:0022	1860 10Gbps CNA - FCOE
+	===================	===========================================
 
 
 Firmware download
@@ -37,9 +42,11 @@ http://www.brocade.com/services-support/drivers-downloads/adapters/Linux.page
 
 and then click following respective util package link:
 
-	Version			Link
-
+	=========	=======================================================
+	Version		Link
+	=========	=======================================================
 	v3.0.0.0	Linux Adapter Firmware package for RHEL 6.2, SLES 11SP2
+	=========	=======================================================
 
 
 Configuration & Management utility download
@@ -52,9 +59,11 @@ http://www.brocade.com/services-support/drivers-downloads/adapters/Linux.page
 
 and then click following respective util package link
 
-	Version			Link
-
+	=========	=======================================================
+	Version		Link
+	=========	=======================================================
 	v3.0.2.0	Linux Adapter Firmware package for RHEL 6.2, SLES 11SP2
+	=========	=======================================================
 
 
 Documentation
@@ -69,10 +78,11 @@ http://www.brocade.com/services-support/drivers-downloads/adapters/Linux.page
 and use the following inbox and out-of-box driver version mapping to find
 the corresponding documentation:
 
+	=============		==================
 	Inbox Version		Out-of-box Version
-
+	=============		==================
 	v3.0.2.2		v3.0.0.0
-
+	=============		==================
 
 Support
 -------
Documentation/scsi/index.rst +1 -0
index c0b66763515f..1e37227f3536 100644
@@ -13,5 +13,6 @@ Linux SCSI Subsystem
    aha152x
    aic79xx
    aic7xxx
+   bfa
 
    scsi_transport_srp/figures
Signature · 1 line
2.21.1
#11 lore raw

PATCH 10/42 docs: scsi: convert bnx2fc.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{bnx2fc.txt => bnx2fc.rst} | 18 ++++++++++++------
 Documentation/scsi/index.rst                  |  1 +
 2 files changed, 13 insertions(+), 6 deletions(-)
 rename Documentation/scsi/{bnx2fc.txt => bnx2fc.rst} (91%)
Documentation/scsi/bnx2fc.rst renamed from Documentation/scsi/bnx2fc.txt +12 -6
similarity index 91%
rename from Documentation/scsi/bnx2fc.txt
rename to Documentation/scsi/bnx2fc.rst
index 80823556d62f..2fef2dff80c7 100644
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========================
 Operating FCoE using bnx2fc
 ===========================
 Broadcom FCoE offload through bnx2fc is full stateful hardware offload that
@@ -24,6 +27,7 @@ Driver Usage Model:
 
 2. Configure the interfaces on which bnx2fc driver has to operate on.
 Here are the steps to configure:
+
 	a. cd /etc/fcoe
 	b. copy cfg-ethx to cfg-eth5 if FCoE has to be enabled on eth5.
 	c. Repeat this for all the interfaces where FCoE has to be enabled.
@@ -39,8 +43,10 @@ discovery and log into the targets.
 
 5. "Symbolic Name" in 'fcoeadm -i' output would display if bnx2fc has claimed
 the interface.
-Eg:
-[root@bh2 ~]# fcoeadm -i
+
+Eg::
+
+ [root@bh2 ~]# fcoeadm -i
     Description:      NetXtreme II BCM57712 10 Gigabit Ethernet
     Revision:         01
     Manufacturer:     Broadcom Corporation
@@ -60,16 +66,16 @@ Eg:
         State:             Online
 
 6. Verify the vlan discovery is performed by running ifconfig and notice
-<INTERFACE>.<VLAN>-fcoe interfaces are automatically created.
+   <INTERFACE>.<VLAN>-fcoe interfaces are automatically created.
 
 Refer to fcoeadm manpage for more information on fcoeadm operations to
 create/destroy interfaces or to display lun/target information.
 
-NOTE:
+NOTE
 ====
 ** Broadcom FCoE capable devices implement a DCBX/LLDP client on-chip. Only one
 LLDP client is allowed per interface. For proper operation all host software
 based DCBX/LLDP clients (e.g. lldpad) must be disabled. To disable lldpad on a
-given interface, run the following command:
+given interface, run the following command::
 
-lldptool set-lldp -i <interface_name> adminStatus=disabled
+	lldptool set-lldp -i <interface_name> adminStatus=disabled
Documentation/scsi/index.rst +1 -0
index 1e37227f3536..d453fb3f1f7d 100644
@@ -14,5 +14,6 @@ Linux SCSI Subsystem
    aic79xx
    aic7xxx
    bfa
+   bnx2fc
 
    scsi_transport_srp/figures
Signature · 1 line
2.21.1
#12 lore raw

PATCH 11/42 docs: scsi: convert BusLogic.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{BusLogic.txt => BusLogic.rst}       | 89 +++++++++++++------
 Documentation/scsi/index.rst                  |  1 +
 drivers/scsi/BusLogic.c                       |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 4 files changed, 67 insertions(+), 27 deletions(-)
 rename Documentation/scsi/{BusLogic.txt => BusLogic.rst} (93%)
Documentation/scsi/BusLogic.rst renamed from Documentation/scsi/BusLogic.txt +64 -25
similarity index 93%
rename from Documentation/scsi/BusLogic.txt
rename to Documentation/scsi/BusLogic.rst
index 48e982cd6fe7..b60169812358 100644
@@ -1,6 +1,11 @@
-	   BusLogic MultiMaster and FlashPoint SCSI Driver for Linux
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================================================
+BusLogic MultiMaster and FlashPoint SCSI Driver for Linux
+=========================================================
 
 			 Version 2.0.15 for Linux 2.0
+
 			 Version 2.1.15 for Linux 2.1
 
 			      PRODUCTION RELEASE
@@ -8,13 +13,16 @@
 				17 August 1998
 
 			       Leonard N. Zubkoff
+
 			       Dandelion Digital
+
 			       [email protected]
 
 	 Copyright 1995-1998 by Leonard N. Zubkoff <[email protected]>
 
 
-				 INTRODUCTION
+Introduction
+============
 
 BusLogic, Inc. designed and manufactured a variety of high performance SCSI
 host adapters which share a common programming interface across a diverse
@@ -86,9 +94,11 @@ Contact information for offices in Europe and Japan is available on the Web
 site.
 
 
-				DRIVER FEATURES
+Driver Features
+===============
 
-o Configuration Reporting and Testing
+Configuration Reporting and Testing
+-----------------------------------
 
   During system initialization, the driver reports extensively on the host
   adapter hardware configuration, including the synchronous transfer parameters
@@ -130,7 +140,8 @@ o Configuration Reporting and Testing
     The status of Wide Negotiation, Disconnect/Reconnect, and Tagged Queuing
     are reported as "Enabled", Disabled", or a sequence of "Y" and "N" letters.
 
-o Performance Features
+Performance Features
+--------------------
 
   BusLogic SCSI Host Adapters directly implement SCSI-2 Tagged Queuing, and so
   support has been included in the driver to utilize tagged queuing with any
@@ -150,7 +161,8 @@ o Performance Features
   queue depth of 1 is selected.  Tagged queuing is also disabled for individual
   target devices if disconnect/reconnect is disabled for that device.
 
-o Robustness Features
+Robustness Features
+-------------------
 
   The driver implements extensive error recovery procedures.  When the higher
   level parts of the SCSI subsystem request that a timed out command be reset,
@@ -174,7 +186,8 @@ o Robustness Features
   lock up or crash, and thereby allowing a clean shutdown and restart after the
   offending component is removed.
 
-o PCI Configuration Support
+PCI Configuration Support
+-------------------------
 
   On PCI systems running kernels compiled with PCI BIOS support enabled, this
   driver will interrogate the PCI configuration space and use the I/O port
@@ -184,19 +197,22 @@ o PCI Configuration Support
   used to disable the ISA compatible I/O port entirely as it is not necessary.
   The ISA compatible I/O port is disabled by default on the BT-948/958/958D.
 
-o /proc File System Support
+/proc File System Support
+-------------------------
 
   Copies of the host adapter configuration information together with updated
   data transfer and error recovery statistics are available through the
   /proc/scsi/BusLogic/<N> interface.
 
-o Shared Interrupts Support
+Shared Interrupts Support
+-------------------------
 
   On systems that support shared interrupts, any number of BusLogic Host
   Adapters may share the same interrupt request channel.
 
 
-			    SUPPORTED HOST ADAPTERS
+Supported Host Adapters
+=======================
 
 The following list comprises the supported BusLogic SCSI Host Adapters as of
 the date of this document.  It is recommended that anyone purchasing a BusLogic
@@ -205,6 +221,7 @@ that it is or will be supported.
 
 FlashPoint Series PCI Host Adapters:
 
+=======================	=============================================
 FlashPoint LT (BT-930)	Ultra SCSI-3
 FlashPoint LT (BT-930R)	Ultra SCSI-3 with RAIDPlus
 FlashPoint LT (BT-920)	Ultra SCSI-3 (BT-930 without BIOS)
@@ -214,15 +231,19 @@ FlashPoint LW (BT-950)	Wide Ultra SCSI-3
 FlashPoint LW (BT-950R)	Wide Ultra SCSI-3 with RAIDPlus
 FlashPoint DW (BT-952)	Dual Channel Wide Ultra SCSI-3
 FlashPoint DW (BT-952R)	Dual Channel Wide Ultra SCSI-3 with RAIDPlus
+=======================	=============================================
 
 MultiMaster "W" Series Host Adapters:
 
+=======     ===		==============================
 BT-948	    PCI		Ultra SCSI-3
 BT-958	    PCI		Wide Ultra SCSI-3
 BT-958D	    PCI		Wide Differential Ultra SCSI-3
+=======     ===		==============================
 
 MultiMaster "C" Series Host Adapters:
 
+========    ====	==============================
 BT-946C	    PCI		Fast SCSI-2
 BT-956C	    PCI		Wide Fast SCSI-2
 BT-956CD    PCI		Wide Differential Fast SCSI-2
@@ -232,9 +253,11 @@ BT-757C	    EISA	Wide Fast SCSI-2
 BT-757CD    EISA	Wide Differential Fast SCSI-2
 BT-545C	    ISA		Fast SCSI-2
 BT-540CF    ISA		Fast SCSI-2
+========    ====	==============================
 
 MultiMaster "S" Series Host Adapters:
 
+=======     ====	==============================
 BT-445S	    VLB		Fast SCSI-2
 BT-747S	    EISA	Fast SCSI-2
 BT-747D	    EISA	Differential Fast SCSI-2
@@ -244,11 +267,14 @@ BT-545S	    ISA		Fast SCSI-2
 BT-542D	    ISA		Differential Fast SCSI-2
 BT-742A	    EISA	SCSI-2 (742A revision H)
 BT-542B	    ISA		SCSI-2 (542B revision H)
+=======     ====	==============================
 
 MultiMaster "A" Series Host Adapters:
 
+=======     ====	==============================
 BT-742A	    EISA	SCSI-2 (742A revisions A - G)
 BT-542B	    ISA		SCSI-2 (542B revisions A - G)
+=======     ====	==============================
 
 AMI FastDisk Host Adapters that are true BusLogic MultiMaster clones are also
 supported by this driver.
@@ -260,9 +286,11 @@ list.  The retail kit includes the bare board and manual as well as cabling and
 driver media and documentation that are not provided with bare boards.
 
 
-			 FLASHPOINT INSTALLATION NOTES
+FlashPoint Installation Notes
+=============================
 
-o RAIDPlus Support
+RAIDPlus Support
+----------------
 
   FlashPoint Host Adapters now include RAIDPlus, Mylex's bootable software
   RAID.  RAIDPlus is not supported on Linux, and there are no plans to support
@@ -273,7 +301,8 @@ o RAIDPlus Support
   than RAIDPlus, so there is little impetus to include RAIDPlus support in the
   BusLogic driver.
 
-o Enabling UltraSCSI Transfers
+Enabling UltraSCSI Transfers
+----------------------------
 
   FlashPoint Host Adapters ship with their configuration set to "Factory
   Default" settings that are conservative and do not allow for UltraSCSI speed
@@ -287,12 +316,14 @@ o Enabling UltraSCSI Transfers
   the "Optimum Performance" settings are loaded.
 
 
-		      BT-948/958/958D INSTALLATION NOTES
+BT-948/958/958D Installation Notes
+==================================
 
 The BT-948/958/958D PCI Ultra SCSI Host Adapters have some features which may
 require attention in some circumstances when installing Linux.
 
-o PCI I/O Port Assignments
+PCI I/O Port Assignments
+------------------------
 
   When configured to factory default settings, the BT-948/958/958D will only
   recognize the PCI I/O port assignments made by the motherboard's PCI BIOS.
@@ -312,7 +343,8 @@ o PCI I/O Port Assignments
   possible future I/O port conflicts.  The older BT-946C/956C/956CD also have
   this configuration option, but the factory default setting is "Primary".
 
-o PCI Slot Scanning Order
+PCI Slot Scanning Order
+-----------------------
 
   In systems with multiple BusLogic PCI Host Adapters, the order in which the
   PCI slots are scanned may appear reversed with the BT-948/958/958D as
@@ -339,7 +371,8 @@ o PCI Slot Scanning Order
   so as to recognize the host adapters in the same order as they are enumerated
   by the host adapter's BIOS.
 
-o Enabling UltraSCSI Transfers
+Enabling UltraSCSI Transfers
+----------------------------
 
   The BT-948/958/958D ship with their configuration set to "Factory Default"
   settings that are conservative and do not allow for UltraSCSI speed to be
@@ -353,7 +386,8 @@ o Enabling UltraSCSI Transfers
   "Optimum Performance" settings are loaded.
 
 
-				DRIVER OPTIONS
+Driver Options
+==============
 
 BusLogic Driver Options may be specified either via the Linux Kernel Command
 Line or via the Loadable Kernel Module Installation Facility.  Driver Options
@@ -520,30 +554,34 @@ The following examples demonstrate setting the Queue Depth for Target Devices
 Devices on the second host adapter to 31, and the Bus Settle Time on the
 second host adapter to 30 seconds.
 
-Linux Kernel Command Line:
+Linux Kernel Command Line::
 
   linux BusLogic=QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30
 
-LILO Linux Boot Loader (in /etc/lilo.conf):
+LILO Linux Boot Loader (in /etc/lilo.conf)::
 
   append = "BusLogic=QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30"
 
-INSMOD Loadable Kernel Module Installation Facility:
+INSMOD Loadable Kernel Module Installation Facility::
 
   insmod BusLogic.o \
       'BusLogic="QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30"'
 
-NOTE: Module Utilities 2.1.71 or later is required for correct parsing
+
+.. Note::
+
+      Module Utilities 2.1.71 or later is required for correct parsing
       of driver options containing commas.
 
 
-			      DRIVER INSTALLATION
+Driver Installation
+===================
 
 This distribution was prepared for Linux kernel version 2.0.35, but should be
 compatible with 2.0.4 or any later 2.0 series kernel.
 
 To install the new BusLogic SCSI driver, you may use the following commands,
-replacing "/usr/src" with wherever you keep your Linux kernel source tree:
+replacing "/usr/src" with wherever you keep your Linux kernel source tree::
 
   cd /usr/src
   tar -xvzf BusLogic-2.0.15.tar.gz
@@ -557,7 +595,8 @@ Then install "arch/x86/boot/zImage" as your standard kernel, run lilo if
 appropriate, and reboot.
 
 
-		      BUSLOGIC ANNOUNCEMENTS MAILING LIST
+BusLogic Announcements Mailing List
+===================================
 
 The BusLogic Announcements Mailing List provides a forum for informing Linux
 users of new driver releases and other announcements regarding Linux support
Documentation/scsi/index.rst +1 -0
index d453fb3f1f7d..6bb2428c1d56 100644
@@ -15,5 +15,6 @@ Linux SCSI Subsystem
    aic7xxx
    bfa
    bnx2fc
+   BusLogic
 
    scsi_transport_srp/figures
drivers/scsi/BusLogic.c +1 -1
index 3170b295a5da..9b8be4f0da19 100644
@@ -3652,7 +3652,7 @@ static bool __init blogic_parse(char **str, char *keyword)
   selected host adapter.
 
   The BusLogic Driver Probing Options are described in
-  <file:Documentation/scsi/BusLogic.txt>.
+  <file:Documentation/scsi/BusLogic.rst>.
 */
 
 static int __init blogic_parseopts(char *options)
drivers/scsi/Kconfig +1 -1
index 18af62594bc0..5ec7330f82b6 100644
@@ -502,7 +502,7 @@ config SCSI_BUSLOGIC
 	  This is support for BusLogic MultiMaster and FlashPoint SCSI Host
 	  Adapters. Consult the SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>, and the files
-	  <file:Documentation/scsi/BusLogic.txt> and
+	  <file:Documentation/scsi/BusLogic.rst> and
 	  <file:Documentation/scsi/FlashPoint.txt> for more information.
 	  Note that support for FlashPoint is only available for 32-bit
 	  x86 configurations.
Signature · 1 line
2.21.1
maintainer Acked-by on v1 11/42
#13 lore raw

Re: [PATCH 11/42] docs: scsi: convert BusLogic.txt to ReST

Quoted 8 lines · Mauro Carvalho Chehab
---
 .../scsi/{BusLogic.txt => BusLogic.rst}       | 89 +++++++++++++------
 Documentation/scsi/index.rst                  |  1 +
 drivers/scsi/BusLogic.c                       |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 4 files changed, 67 insertions(+), 27 deletions(-)
 rename Documentation/scsi/{BusLogic.txt => BusLogic.rst} (93%)

--
Khalid

Quoted 324 lines
Documentation/scsi/BusLogic.rst renamed from Documentation/scsi/BusLogic.txt +64 -25
similarity index 93%
rename from Documentation/scsi/BusLogic.txt
rename to Documentation/scsi/BusLogic.rst
index 48e982cd6fe7..b60169812358 100644
@@ -1,6 +1,11 @@
-	   BusLogic MultiMaster and FlashPoint SCSI Driver for Linux
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================================================
+BusLogic MultiMaster and FlashPoint SCSI Driver for Linux
+=========================================================
 
 			 Version 2.0.15 for Linux 2.0
+
 			 Version 2.1.15 for Linux 2.1
 
 			      PRODUCTION RELEASE
@@ -8,13 +13,16 @@
 				17 August 1998
 
 			       Leonard N. Zubkoff
+
 			       Dandelion Digital
+
 			       [email protected]
 
 	 Copyright 1995-1998 by Leonard N. Zubkoff <[email protected]>
 
 
-				 INTRODUCTION
+Introduction
+============
 
 BusLogic, Inc. designed and manufactured a variety of high performance SCSI
 host adapters which share a common programming interface across a diverse
@@ -86,9 +94,11 @@ Contact information for offices in Europe and Japan is available on the Web
 site.
 
 
-				DRIVER FEATURES
+Driver Features
+===============
 
-o Configuration Reporting and Testing
+Configuration Reporting and Testing
+-----------------------------------
 
   During system initialization, the driver reports extensively on the host
   adapter hardware configuration, including the synchronous transfer parameters
@@ -130,7 +140,8 @@ o Configuration Reporting and Testing
     The status of Wide Negotiation, Disconnect/Reconnect, and Tagged Queuing
     are reported as "Enabled", Disabled", or a sequence of "Y" and "N" letters.
 
-o Performance Features
+Performance Features
+--------------------
 
   BusLogic SCSI Host Adapters directly implement SCSI-2 Tagged Queuing, and so
   support has been included in the driver to utilize tagged queuing with any
@@ -150,7 +161,8 @@ o Performance Features
   queue depth of 1 is selected.  Tagged queuing is also disabled for individual
   target devices if disconnect/reconnect is disabled for that device.
 
-o Robustness Features
+Robustness Features
+-------------------
 
   The driver implements extensive error recovery procedures.  When the higher
   level parts of the SCSI subsystem request that a timed out command be reset,
@@ -174,7 +186,8 @@ o Robustness Features
   lock up or crash, and thereby allowing a clean shutdown and restart after the
   offending component is removed.
 
-o PCI Configuration Support
+PCI Configuration Support
+-------------------------
 
   On PCI systems running kernels compiled with PCI BIOS support enabled, this
   driver will interrogate the PCI configuration space and use the I/O port
@@ -184,19 +197,22 @@ o PCI Configuration Support
   used to disable the ISA compatible I/O port entirely as it is not necessary.
   The ISA compatible I/O port is disabled by default on the BT-948/958/958D.
 
-o /proc File System Support
+/proc File System Support
+-------------------------
 
   Copies of the host adapter configuration information together with updated
   data transfer and error recovery statistics are available through the
   /proc/scsi/BusLogic/<N> interface.
 
-o Shared Interrupts Support
+Shared Interrupts Support
+-------------------------
 
   On systems that support shared interrupts, any number of BusLogic Host
   Adapters may share the same interrupt request channel.
 
 
-			    SUPPORTED HOST ADAPTERS
+Supported Host Adapters
+=======================
 
 The following list comprises the supported BusLogic SCSI Host Adapters as of
 the date of this document.  It is recommended that anyone purchasing a BusLogic
@@ -205,6 +221,7 @@ that it is or will be supported.
 
 FlashPoint Series PCI Host Adapters:
 
+=======================	=============================================
 FlashPoint LT (BT-930)	Ultra SCSI-3
 FlashPoint LT (BT-930R)	Ultra SCSI-3 with RAIDPlus
 FlashPoint LT (BT-920)	Ultra SCSI-3 (BT-930 without BIOS)
@@ -214,15 +231,19 @@ FlashPoint LW (BT-950)	Wide Ultra SCSI-3
 FlashPoint LW (BT-950R)	Wide Ultra SCSI-3 with RAIDPlus
 FlashPoint DW (BT-952)	Dual Channel Wide Ultra SCSI-3
 FlashPoint DW (BT-952R)	Dual Channel Wide Ultra SCSI-3 with RAIDPlus
+=======================	=============================================
 
 MultiMaster "W" Series Host Adapters:
 
+=======     ===		==============================
 BT-948	    PCI		Ultra SCSI-3
 BT-958	    PCI		Wide Ultra SCSI-3
 BT-958D	    PCI		Wide Differential Ultra SCSI-3
+=======     ===		==============================
 
 MultiMaster "C" Series Host Adapters:
 
+========    ====	==============================
 BT-946C	    PCI		Fast SCSI-2
 BT-956C	    PCI		Wide Fast SCSI-2
 BT-956CD    PCI		Wide Differential Fast SCSI-2
@@ -232,9 +253,11 @@ BT-757C	    EISA	Wide Fast SCSI-2
 BT-757CD    EISA	Wide Differential Fast SCSI-2
 BT-545C	    ISA		Fast SCSI-2
 BT-540CF    ISA		Fast SCSI-2
+========    ====	==============================
 
 MultiMaster "S" Series Host Adapters:
 
+=======     ====	==============================
 BT-445S	    VLB		Fast SCSI-2
 BT-747S	    EISA	Fast SCSI-2
 BT-747D	    EISA	Differential Fast SCSI-2
@@ -244,11 +267,14 @@ BT-545S	    ISA		Fast SCSI-2
 BT-542D	    ISA		Differential Fast SCSI-2
 BT-742A	    EISA	SCSI-2 (742A revision H)
 BT-542B	    ISA		SCSI-2 (542B revision H)
+=======     ====	==============================
 
 MultiMaster "A" Series Host Adapters:
 
+=======     ====	==============================
 BT-742A	    EISA	SCSI-2 (742A revisions A - G)
 BT-542B	    ISA		SCSI-2 (542B revisions A - G)
+=======     ====	==============================
 
 AMI FastDisk Host Adapters that are true BusLogic MultiMaster clones are also
 supported by this driver.
@@ -260,9 +286,11 @@ list.  The retail kit includes the bare board and manual as well as cabling and
 driver media and documentation that are not provided with bare boards.
 
 
-			 FLASHPOINT INSTALLATION NOTES
+FlashPoint Installation Notes
+=============================
 
-o RAIDPlus Support
+RAIDPlus Support
+----------------
 
   FlashPoint Host Adapters now include RAIDPlus, Mylex's bootable software
   RAID.  RAIDPlus is not supported on Linux, and there are no plans to support
@@ -273,7 +301,8 @@ o RAIDPlus Support
   than RAIDPlus, so there is little impetus to include RAIDPlus support in the
   BusLogic driver.
 
-o Enabling UltraSCSI Transfers
+Enabling UltraSCSI Transfers
+----------------------------
 
   FlashPoint Host Adapters ship with their configuration set to "Factory
   Default" settings that are conservative and do not allow for UltraSCSI speed
@@ -287,12 +316,14 @@ o Enabling UltraSCSI Transfers
   the "Optimum Performance" settings are loaded.
 
 
-		      BT-948/958/958D INSTALLATION NOTES
+BT-948/958/958D Installation Notes
+==================================
 
 The BT-948/958/958D PCI Ultra SCSI Host Adapters have some features which may
 require attention in some circumstances when installing Linux.
 
-o PCI I/O Port Assignments
+PCI I/O Port Assignments
+------------------------
 
   When configured to factory default settings, the BT-948/958/958D will only
   recognize the PCI I/O port assignments made by the motherboard's PCI BIOS.
@@ -312,7 +343,8 @@ o PCI I/O Port Assignments
   possible future I/O port conflicts.  The older BT-946C/956C/956CD also have
   this configuration option, but the factory default setting is "Primary".
 
-o PCI Slot Scanning Order
+PCI Slot Scanning Order
+-----------------------
 
   In systems with multiple BusLogic PCI Host Adapters, the order in which the
   PCI slots are scanned may appear reversed with the BT-948/958/958D as
@@ -339,7 +371,8 @@ o PCI Slot Scanning Order
   so as to recognize the host adapters in the same order as they are enumerated
   by the host adapter's BIOS.
 
-o Enabling UltraSCSI Transfers
+Enabling UltraSCSI Transfers
+----------------------------
 
   The BT-948/958/958D ship with their configuration set to "Factory Default"
   settings that are conservative and do not allow for UltraSCSI speed to be
@@ -353,7 +386,8 @@ o Enabling UltraSCSI Transfers
   "Optimum Performance" settings are loaded.
 
 
-				DRIVER OPTIONS
+Driver Options
+==============
 
 BusLogic Driver Options may be specified either via the Linux Kernel Command
 Line or via the Loadable Kernel Module Installation Facility.  Driver Options
@@ -520,30 +554,34 @@ The following examples demonstrate setting the Queue Depth for Target Devices
 Devices on the second host adapter to 31, and the Bus Settle Time on the
 second host adapter to 30 seconds.
 
-Linux Kernel Command Line:
+Linux Kernel Command Line::
 
   linux BusLogic=QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30
 
-LILO Linux Boot Loader (in /etc/lilo.conf):
+LILO Linux Boot Loader (in /etc/lilo.conf)::
 
   append = "BusLogic=QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30"
 
-INSMOD Loadable Kernel Module Installation Facility:
+INSMOD Loadable Kernel Module Installation Facility::
 
   insmod BusLogic.o \
       'BusLogic="QueueDepth:[,7,15];QueueDepth:31,BusSettleTime:30"'
 
-NOTE: Module Utilities 2.1.71 or later is required for correct parsing
+
+.. Note::
+
+      Module Utilities 2.1.71 or later is required for correct parsing
       of driver options containing commas.
 
 
-			      DRIVER INSTALLATION
+Driver Installation
+===================
 
 This distribution was prepared for Linux kernel version 2.0.35, but should be
 compatible with 2.0.4 or any later 2.0 series kernel.
 
 To install the new BusLogic SCSI driver, you may use the following commands,
-replacing "/usr/src" with wherever you keep your Linux kernel source tree:
+replacing "/usr/src" with wherever you keep your Linux kernel source tree::
 
   cd /usr/src
   tar -xvzf BusLogic-2.0.15.tar.gz
@@ -557,7 +595,8 @@ Then install "arch/x86/boot/zImage" as your standard kernel, run lilo if
 appropriate, and reboot.
 
 
-		      BUSLOGIC ANNOUNCEMENTS MAILING LIST
+BusLogic Announcements Mailing List
+===================================
 
 The BusLogic Announcements Mailing List provides a forum for informing Linux
 users of new driver releases and other announcements regarding Linux support
Documentation/scsi/index.rst +1 -0
index d453fb3f1f7d..6bb2428c1d56 100644
@@ -15,5 +15,6 @@ Linux SCSI Subsystem
    aic7xxx
    bfa
    bnx2fc
+   BusLogic
 
    scsi_transport_srp/figures
drivers/scsi/BusLogic.c +1 -1
index 3170b295a5da..9b8be4f0da19 100644
@@ -3652,7 +3652,7 @@ static bool __init blogic_parse(char **str, char *keyword)
   selected host adapter.
 
   The BusLogic Driver Probing Options are described in
-  <file:Documentation/scsi/BusLogic.txt>.
+  <file:Documentation/scsi/BusLogic.rst>.
 */
 
 static int __init blogic_parseopts(char *options)
drivers/scsi/Kconfig +1 -1
index 18af62594bc0..5ec7330f82b6 100644
@@ -502,7 +502,7 @@ config SCSI_BUSLOGIC
 	  This is support for BusLogic MultiMaster and FlashPoint SCSI Host
 	  Adapters. Consult the SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>, and the files
-	  <file:Documentation/scsi/BusLogic.txt> and
+	  <file:Documentation/scsi/BusLogic.rst> and
 	  <file:Documentation/scsi/FlashPoint.txt> for more information.
 	  Note that support for FlashPoint is only available for 32-bit
 	  x86 configurations.
#14 lore raw

PATCH 12/42 docs: scsi: convert cxgb3i.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{cxgb3i.txt => cxgb3i.rst} | 22 ++++++++++++-------
 Documentation/scsi/index.rst                  |  1 +
 2 files changed, 15 insertions(+), 8 deletions(-)
 rename Documentation/scsi/{cxgb3i.txt => cxgb3i.rst} (86%)
Documentation/scsi/cxgb3i.rst renamed from Documentation/scsi/cxgb3i.txt +14 -8
similarity index 86%
rename from Documentation/scsi/cxgb3i.txt
rename to Documentation/scsi/cxgb3i.rst
index 7ac8032ee9b2..e01f18fbfa9f 100644
@@ -1,4 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
 Chelsio S3 iSCSI Driver for Linux
+=================================
 
 Introduction
 ============
@@ -49,7 +53,8 @@ The following steps need to be taken to accelerates the open-iscsi initiator:
 
    The cxgb3i module registers a new transport class "cxgb3i" with open-iscsi.
 
-   * in the case of recompiling the kernel, the cxgb3i selection is located at
+   * in the case of recompiling the kernel, the cxgb3i selection is located at::
+
 	Device Drivers
 		SCSI device support --->
 			[*] SCSI low-level drivers  --->
@@ -58,25 +63,26 @@ The following steps need to be taken to accelerates the open-iscsi initiator:
 2. Create an interface file located under /etc/iscsi/ifaces/ for the new
    transport class "cxgb3i".
 
-   The content of the file should be in the following format:
+   The content of the file should be in the following format::
+
 	iface.transport_name = cxgb3i
 	iface.net_ifacename = <ethX>
 	iface.ipaddress = <iscsi ip address>
 
    * if iface.ipaddress is specified, <iscsi ip address> needs to be either the
-	same as the ethX's ip address or an address on the same subnet. Make
-	sure the ip address is unique in the network.
+     same as the ethX's ip address or an address on the same subnet. Make
+     sure the ip address is unique in the network.
 
 3. edit /etc/iscsi/iscsid.conf
    The default setting for MaxRecvDataSegmentLength (131072) is too big;
-   replace with a value no bigger than 15360 (for example 8192):
+   replace with a value no bigger than 15360 (for example 8192)::
 
 	node.conn[0].iscsi.MaxRecvDataSegmentLength = 8192
 
    * The login would fail for a normal session if MaxRecvDataSegmentLength is
-	too big.  A error message in the format of
-	"cxgb3i: ERR! MaxRecvSegmentLength <X> too big. Need to be <= <Y>."
-	would be logged to dmesg.
+     too big.  A error message in the format of
+     "cxgb3i: ERR! MaxRecvSegmentLength <X> too big. Need to be <= <Y>."
+     would be logged to dmesg.
 
 4. To direct open-iscsi traffic to go through cxgb3i's accelerated path,
    "-I <iface file name>" option needs to be specified with most of the
Documentation/scsi/index.rst +1 -0
index 6bb2428c1d56..3809213b83da 100644
@@ -16,5 +16,6 @@ Linux SCSI Subsystem
    bfa
    bnx2fc
    BusLogic
+   cxgb3i
 
    scsi_transport_srp/figures
Signature · 1 line
2.21.1
#15 lore raw

PATCH 13/42 docs: scsi: convert dc395x.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{dc395x.txt => dc395x.rst} | 75 +++++++++++--------
 Documentation/scsi/index.rst                  |  1 +
 MAINTAINERS                                   |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 4 files changed, 48 insertions(+), 32 deletions(-)
 rename Documentation/scsi/{dc395x.txt => dc395x.rst} (64%)
Documentation/scsi/dc395x.rst renamed from Documentation/scsi/dc395x.txt +45 -30
similarity index 64%
rename from Documentation/scsi/dc395x.txt
rename to Documentation/scsi/dc395x.rst
index 88219f96633d..d779e782b1cb 100644
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================
 README file for the dc395x SCSI driver
-==========================================
+======================================
 
 Status
 ------
@@ -18,14 +21,14 @@ http://lists.twibble.org/mailman/listinfo/dc395x/
 
 Parameters
 ----------
-The driver uses the settings from the EEPROM set in the SCSI BIOS 
+The driver uses the settings from the EEPROM set in the SCSI BIOS
 setup. If there is no EEPROM, the driver uses default values.
 Both can be overridden by command line parameters (module or kernel
 parameters).
 
 The following parameters are available:
 
- - safe
+safe
    Default: 0, Acceptable values: 0 or 1
 
    If safe is set to 1 then the adapter will use conservative
@@ -33,52 +36,63 @@ The following parameters are available:
 
 		shortcut for dc395x=7,4,9,15,2,10
 
- - adapter_id
+adapter_id
    Default: 7, Acceptable values: 0 to 15
 
    Sets the host adapter SCSI ID.
 
- - max_speed
+max_speed
    Default: 1, Acceptable value: 0 to 7
-   0 = 20   Mhz
-   1 = 12.2 Mhz
-   2 = 10   Mhz
-   3 = 8    Mhz
-   4 = 6.7  Mhz
-   5 = 5.8  Hhz
-   6 = 5    Mhz
-   7 = 4    Mhz
 
- - dev_mode
+   ==  ========
+   0   20   Mhz
+   1   12.2 Mhz
+   2   10   Mhz
+   3   8    Mhz
+   4   6.7  Mhz
+   5   5.8  Hhz
+   6   5    Mhz
+   7   4    Mhz
+   ==  ========
+
+dev_mode
    Bitmap for device configuration
 
    DevMode bit definition:
+
+      === ======== ========  =========================================
       Bit Val(hex) Val(dec)  Meaning
-      *0    0x01       1     Parity check
-      *1    0x02       2     Synchronous Negotiation
-      *2    0x04       4     Disconnection
-      *3    0x08       8     Send Start command on startup. (Not used)
-      *4    0x10      16     Tagged Command Queueing
-      *5    0x20      32     Wide Negotiation
+      === ======== ========  =========================================
+       0    0x01       1     Parity check
+       1    0x02       2     Synchronous Negotiation
+       2    0x04       4     Disconnection
+       3    0x08       8     Send Start command on startup. (Not used)
+       4    0x10      16     Tagged Command Queueing
+       5    0x20      32     Wide Negotiation
+      === ======== ========  =========================================
 
- - adapter_mode
+adapter_mode
    Bitmap for adapter configuration
 
    AdaptMode bit definition
+
+    ===== ======== ========  ====================================================
       Bit Val(hex) Val(dec)  Meaning
-      *0    0x01       1     Support more than two drives. (Not used)
-      *1    0x02       2     Use DOS compatible mapping for HDs greater than 1GB.
-      *2    0x04       4     Reset SCSI Bus on startup.
-      *3    0x08       8     Active Negation: Improves SCSI Bus noise immunity.
+    ===== ======== ========  ====================================================
+       0    0x01       1     Support more than two drives. (Not used)
+       1    0x02       2     Use DOS compatible mapping for HDs greater than 1GB.
+       2    0x04       4     Reset SCSI Bus on startup.
+       3    0x08       8     Active Negation: Improves SCSI Bus noise immunity.
        4    0x10      16     Immediate return on BIOS seek command. (Not used)
     (*)5    0x20      32     Check for LUNs >= 1.
+    ===== ======== ========  ====================================================
 
- - tags
+tags
    Default: 3, Acceptable values: 0-5
-   
+
    The number of tags is 1<<x, if x has been specified
 
- - reset_delay
+reset_delay
    Default: 1, Acceptable values: 0-180
 
    The seconds to not accept commands after a SCSI Reset
@@ -95,8 +109,9 @@ License (GPL). Please read it, before using this driver. It should be
 included in your kernel sources and with your distribution. It carries the
 filename COPYING. If you don't have it, please ask me to send you one by
 email.
-Note: The GNU GPL says also something about warranty and liability. 
+
+Note: The GNU GPL says also something about warranty and liability.
 Please be aware the following: While we do my best to provide a working and
-reliable driver, there is a chance, that it will kill your valuable data. 
+reliable driver, there is a chance, that it will kill your valuable data.
 We refuse to take any responsibility for that. The driver is provided as-is
 and YOU USE IT AT YOUR OWN RESPONSIBILITY.
Documentation/scsi/index.rst +1 -0
index 3809213b83da..6fe00709cbce 100644
@@ -17,5 +17,6 @@ Linux SCSI Subsystem
    bnx2fc
    BusLogic
    cxgb3i
+   dc395x
 
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index aac8ef48dc08..1e2ab816fe66 100644
@@ -4690,7 +4690,7 @@ L:	[email protected]
 W:	http://twibble.org/dist/dc395x/
 W:	http://lists.twibble.org/mailman/listinfo/dc395x/
 S:	Maintained
-F:	Documentation/scsi/dc395x.txt
+F:	Documentation/scsi/dc395x.rst
 F:	drivers/scsi/dc395x.*
 
 DCCP PROTOCOL
drivers/scsi/Kconfig +1 -1
index 5ec7330f82b6..9f5b2ddec6e0 100644
@@ -1187,7 +1187,7 @@ config SCSI_DC395x
 	  This driver works, but is still in experimental status. So better
 	  have a bootable disk and a backup in case of emergency.
 
-	  Documentation can be found in <file:Documentation/scsi/dc395x.txt>.
+	  Documentation can be found in <file:Documentation/scsi/dc395x.rst>.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called dc395x.
Signature · 1 line
2.21.1
#16 lore raw

PATCH 14/42 docs: scsi: convert dpti.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/dpti.rst   | 92 +++++++++++++++++++++++++++++++++++
 Documentation/scsi/dpti.txt   | 83 -------------------------------
 Documentation/scsi/index.rst  |  1 +
 drivers/scsi/Kconfig          |  2 +-
 drivers/scsi/dpt/dpti_ioctl.h |  2 +-
 drivers/scsi/dpt_i2o.c        |  2 +-
 drivers/scsi/dpti.h           |  2 +-
 7 files changed, 97 insertions(+), 87 deletions(-)
 create mode 100644 Documentation/scsi/dpti.rst
 delete mode 100644 Documentation/scsi/dpti.txt
Documentation/scsi/dpti.rst new file +92 -0
new file mode 100644
index 000000000000..0496919d87d3
@@ -0,0 +1,92 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===================
+Adaptec dpti driver
+===================
+
+Redistribution and use in source form, with or without modification, are
+permitted provided that redistributions of source code must retain the
+above copyright notice, this list of conditions and the following disclaimer.
+
+This software is provided ``as is`` by Adaptec and
+any express or implied warranties, including, but not limited to, the
+implied warranties of merchantability and fitness for a particular purpose,
+are disclaimed. In no event shall Adaptec be
+liable for any direct, indirect, incidental, special, exemplary or
+consequential damages (including, but not limited to, procurement of
+substitute goods or services; loss of use, data, or profits; or business
+interruptions) however caused and on any theory of liability, whether in
+contract, strict liability, or tort (including negligence or otherwise)
+arising in any way out of the use of this driver software, even if advised
+of the possibility of such damage.
+
+This driver supports the Adaptec I2O RAID and DPT SmartRAID V I2O boards.
+
+Credits
+=======
+
+The original linux driver was ported to Linux by Karen White while at
+Dell Computer.  It was ported from Bob Pasteur's (of DPT) original
+non-Linux driver.  Mark Salyzyn and Bob Pasteur consulted on the original
+driver.
+
+2.0 version of the driver by Deanna Bonds and Mark Salyzyn.
+
+History
+=======
+
+The driver was originally ported to linux version 2.0.34
+
+==== ==========================================================================
+V2.0 Rewrite of driver.  Re-architectured based on i2o subsystem.
+     This was the first full GPL version since the last version used
+     i2osig headers which were not GPL.  Developer Testing version.
+V2.1 Internal testing
+V2.2 First released version
+
+V2.3 Changes:
+
+     - Added Raptor Support
+     - Fixed bug causing system to hang under extreme load with
+     - management utilities running (removed GFP_DMA from kmalloc flags)
+
+V2.4 First version ready to be submitted to be embedded in the kernel
+
+     Changes:
+
+     - Implemented suggestions from Alan Cox
+     - Added calculation of resid for sg layer
+     - Better error handling
+     - Added checking underflow conditions
+     - Added DATAPROTECT checking
+     - Changed error return codes
+     - Fixed pointer bug in bus reset routine
+     - Enabled hba reset from ioctls (allows a FW flash to reboot and use
+       the new FW without having to reboot)
+     - Changed proc output
+==== ==========================================================================
+
+TODO
+====
+- Add 64 bit Scatter Gather when compiled on 64 bit architectures
+- Add sparse lun scanning
+- Add code that checks if a device that had been taken offline is
+  now online (at the FW level) when test unit ready or inquiry
+  command from scsi-core
+- Add proc read interface
+- busrescan command
+- rescan command
+- Add code to rescan routine that notifies scsi-core about new devices
+- Add support for C-PCI (hotplug stuff)
+- Add ioctl passthru error recovery
+
+Notes
+=====
+The DPT card optimizes the order of processing commands.  Consequently,
+a command may take up to 6 minutes to complete after it has been sent
+to the board.
+
+The files dpti_ioctl.h dptsig.h osd_defs.h osd_util.h sys_info.h are part of the
+interface files for Adaptec's management routines.  These define the structures used
+in the ioctls.  They are written to be portable.  They are hard to read, but I need
+to use them 'as is' or I can miss changes in the interface.
Documentation/scsi/dpti.txt deleted +0 -83

83 lines not on this page · raw message

Documentation/scsi/index.rst +1 -0
index 6fe00709cbce..b553dd9904bf 100644
@@ -18,5 +18,6 @@ Linux SCSI Subsystem
    BusLogic
    cxgb3i
    dc395x
+   dpti
 
    scsi_transport_srp/figures
drivers/scsi/Kconfig +1 -1
index 9f5b2ddec6e0..5e834fba7934 100644
@@ -448,7 +448,7 @@ config SCSI_DPT_I2O
 	help
 	  This driver supports all of Adaptec's I2O based RAID controllers as 
 	  well as the DPT SmartRaid V cards.  This is an Adaptec maintained
-	  driver by Deanna Bonds.  See <file:Documentation/scsi/dpti.txt>.
+	  driver by Deanna Bonds.  See <file:Documentation/scsi/dpti.rst>.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called dpt_i2o.
drivers/scsi/dpt/dpti_ioctl.h +1 -1
index 6bc33f4f020d..25e9251f8c78 100644
@@ -5,7 +5,7 @@
     begin                : Thu Sep 7 2000
     copyright            : (C) 2001 by Adaptec
 
-    See Documentation/scsi/dpti.txt for history, notes, license info
+    See Documentation/scsi/dpti.rst for history, notes, license info
     and credits
  ***************************************************************************/
 
drivers/scsi/dpt_i2o.c +1 -1
index abc74fd474dc..5362fb0b96a7 100644
@@ -8,7 +8,7 @@
 			   July 30, 2001 First version being submitted
 			   for inclusion in the kernel.  V2.4
 
-    See Documentation/scsi/dpti.txt for history, notes, license info
+    See Documentation/scsi/dpti.rst for history, notes, license info
     and credits
  ***************************************************************************/
 
drivers/scsi/dpti.h +1 -1
index 42b1e28b5884..6da9ab1fcfe8 100644
@@ -5,7 +5,7 @@
     begin                : Thu Sep 7 2000
     copyright            : (C) 2001 by Adaptec
 
-    See Documentation/scsi/dpti.txt for history, notes, license info
+    See Documentation/scsi/dpti.rst for history, notes, license info
     and credits
  ***************************************************************************/
 
Signature · 1 line
2.21.1
#17 lore raw

PATCH 15/42 docs: scsi: convert FlashPoint.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{FlashPoint.txt => FlashPoint.rst}   | 225 +++++++++---------
 Documentation/scsi/index.rst                  |   1 +
 drivers/scsi/Kconfig                          |   2 +-
 3 files changed, 121 insertions(+), 107 deletions(-)
 rename Documentation/scsi/{FlashPoint.txt => FlashPoint.rst} (21%)
Documentation/scsi/FlashPoint.rst renamed from Documentation/scsi/FlashPoint.txt +119 -106
similarity index 21%
rename from Documentation/scsi/FlashPoint.txt
rename to Documentation/scsi/FlashPoint.rst
index 5b5f29cb9f8b..ef3c07e94ad6 100644
@@ -1,27 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===================================
+The BusLogic FlashPoint SCSI Driver
+===================================
+
 The BusLogic FlashPoint SCSI Host Adapters are now fully supported on Linux.
 The upgrade program described below has been officially terminated effective
 31 March 1997 since it is no longer needed.
 
+::
 
+  	  MYLEX INTRODUCES LINUX OPERATING SYSTEM SUPPORT FOR ITS
+  	      BUSLOGIC FLASHPOINT LINE OF SCSI HOST ADAPTERS
 
-	  MYLEX INTRODUCES LINUX OPERATING SYSTEM SUPPORT FOR ITS
-	      BUSLOGIC FLASHPOINT LINE OF SCSI HOST ADAPTERS
 
+  FREMONT, CA, -- October 8, 1996 -- Mylex Corporation has expanded Linux
+  operating system support to its BusLogic brand of FlashPoint Ultra SCSI
+  host adapters.  All of BusLogic's other SCSI host adapters, including the
+  MultiMaster line, currently support the Linux operating system.  Linux
+  drivers and information will be available on October 15th at
+  http://sourceforge.net/projects/dandelion/.
 
-FREMONT, CA, -- October 8, 1996 -- Mylex Corporation has expanded Linux
-operating system support to its BusLogic brand of FlashPoint Ultra SCSI
-host adapters.  All of BusLogic's other SCSI host adapters, including the
-MultiMaster line, currently support the Linux operating system.  Linux
-drivers and information will be available on October 15th at
-http://sourceforge.net/projects/dandelion/.
-
-"Mylex is committed to supporting the Linux community," says Peter Shambora,
-vice president of marketing for Mylex.  "We have supported Linux driver
-development and provided technical support for our host adapters for several
-years, and are pleased to now make our FlashPoint products available to this
-user base."
+  "Mylex is committed to supporting the Linux community," says Peter Shambora,
+  vice president of marketing for Mylex.  "We have supported Linux driver
+  development and provided technical support for our host adapters for several
+  years, and are pleased to now make our FlashPoint products available to this
+  user base."
 
 The Linux Operating System
+==========================
 
 Linux is a freely-distributed implementation of UNIX for Intel x86, Sun
 SPARC, SGI MIPS, Motorola 68k, Digital Alpha AXP and Motorola PowerPC
@@ -30,6 +37,7 @@ System, Emacs, and TCP/IP networking.  Further information is available at
 http://www.linux.org and http://www.ssc.com/.
 
 FlashPoint Host Adapters
+========================
 
 The FlashPoint family of Ultra SCSI host adapters, designed for workstation
 and file server environments, are available in narrow, wide, dual channel,
@@ -38,6 +46,7 @@ automation technology, which minimizes SCSI command overhead and reduces
 the number of interrupts generated to the CPU.
 
 About Mylex
+===========
 
 Mylex Corporation (NASDAQ/NM SYMBOL: MYLX), founded in 1983, is a leading
 producer of RAID technology and network management products.  The company
@@ -51,16 +60,20 @@ and availability.  Products are sold globally through a network of OEMs,
 major distributors, VARs, and system integrators.  Mylex Corporation is
 headquartered at 34551 Ardenwood Blvd., Fremont, CA.
 
-				   ####
-
 Contact:
+========
+
+::
+
+  Peter Shambora
+  Vice President of Marketing
+  Mylex Corp.
+  510/796-6100
+  [email protected]
+
+
+::
 
-Peter Shambora
-Vice President of Marketing
-Mylex Corp.
-510/796-6100
[email protected]
-
 			       ANNOUNCEMENT
 	       BusLogic FlashPoint LT/BT-948 Upgrade Program
 			      1 February 1996
@@ -69,95 +82,95 @@ [email protected]
 	       BusLogic FlashPoint LW/BT-958 Upgrade Program
 			       14 June 1996
 
-Ever since its introduction last October, the BusLogic FlashPoint LT has
-been problematic for members of the Linux community, in that no Linux
-drivers have been available for this new Ultra SCSI product.  Despite its
-officially being positioned as a desktop workstation product, and not being
-particularly well suited for a high performance multitasking operating
-system like Linux, the FlashPoint LT has been touted by computer system
-vendors as the latest thing, and has been sold even on many of their high
-end systems, to the exclusion of the older MultiMaster products.  This has
-caused grief for many people who inadvertently purchased a system expecting
-that all BusLogic SCSI Host Adapters were supported by Linux, only to
-discover that the FlashPoint was not supported and would not be for quite
-some time, if ever.
+  Ever since its introduction last October, the BusLogic FlashPoint LT has
+  been problematic for members of the Linux community, in that no Linux
+  drivers have been available for this new Ultra SCSI product.  Despite its
+  officially being positioned as a desktop workstation product, and not being
+  particularly well suited for a high performance multitasking operating
+  system like Linux, the FlashPoint LT has been touted by computer system
+  vendors as the latest thing, and has been sold even on many of their high
+  end systems, to the exclusion of the older MultiMaster products.  This has
+  caused grief for many people who inadvertently purchased a system expecting
+  that all BusLogic SCSI Host Adapters were supported by Linux, only to
+  discover that the FlashPoint was not supported and would not be for quite
+  some time, if ever.
 
-After this problem was identified, BusLogic contacted its major OEM
-customers to make sure the BT-946C/956C MultiMaster cards would still be
-made available, and that Linux users who mistakenly ordered systems with
-the FlashPoint would be able to upgrade to the BT-946C.  While this helped
-many purchasers of new systems, it was only a partial solution to the
-overall problem of FlashPoint support for Linux users.  It did nothing to
-assist the people who initially purchased a FlashPoint for a supported
-operating system and then later decided to run Linux, or those who had
-ended up with a FlashPoint LT, believing it was supported, and were unable
-to return it.
+  After this problem was identified, BusLogic contacted its major OEM
+  customers to make sure the BT-946C/956C MultiMaster cards would still be
+  made available, and that Linux users who mistakenly ordered systems with
+  the FlashPoint would be able to upgrade to the BT-946C.  While this helped
+  many purchasers of new systems, it was only a partial solution to the
+  overall problem of FlashPoint support for Linux users.  It did nothing to
+  assist the people who initially purchased a FlashPoint for a supported
+  operating system and then later decided to run Linux, or those who had
+  ended up with a FlashPoint LT, believing it was supported, and were unable
+  to return it.
 
-In the middle of December, I asked to meet with BusLogic's senior
-management to discuss the issues related to Linux and free software support
-for the FlashPoint.  Rumors of varying accuracy had been circulating
-publicly about BusLogic's attitude toward the Linux community, and I felt
-it was best that these issues be addressed directly.  I sent an email
-message after 11pm one evening, and the meeting took place the next
-afternoon.  Unfortunately, corporate wheels sometimes grind slowly,
-especially when a company is being acquired, and so it's taken until now
-before the details were completely determined and a public statement could
-be made.
+  In the middle of December, I asked to meet with BusLogic's senior
+  management to discuss the issues related to Linux and free software support
+  for the FlashPoint.  Rumors of varying accuracy had been circulating
+  publicly about BusLogic's attitude toward the Linux community, and I felt
+  it was best that these issues be addressed directly.  I sent an email
+  message after 11pm one evening, and the meeting took place the next
+  afternoon.  Unfortunately, corporate wheels sometimes grind slowly,
+  especially when a company is being acquired, and so it's taken until now
+  before the details were completely determined and a public statement could
+  be made.
 
-BusLogic is not prepared at this time to release the information necessary
-for third parties to write drivers for the FlashPoint.  The only existing
-FlashPoint drivers have been written directly by BusLogic Engineering, and
-there is no FlashPoint documentation sufficiently detailed to allow outside
-developers to write a driver without substantial assistance.  While there
-are people at BusLogic who would rather not release the details of the
-FlashPoint architecture at all, that debate has not yet been settled either
-way.  In any event, even if documentation were available today it would
-take quite a while for a usable driver to be written, especially since I'm
-not convinced that the effort required would be worthwhile.
+  BusLogic is not prepared at this time to release the information necessary
+  for third parties to write drivers for the FlashPoint.  The only existing
+  FlashPoint drivers have been written directly by BusLogic Engineering, and
+  there is no FlashPoint documentation sufficiently detailed to allow outside
+  developers to write a driver without substantial assistance.  While there
+  are people at BusLogic who would rather not release the details of the
+  FlashPoint architecture at all, that debate has not yet been settled either
+  way.  In any event, even if documentation were available today it would
+  take quite a while for a usable driver to be written, especially since I'm
+  not convinced that the effort required would be worthwhile.
 
-However, BusLogic does remain committed to providing a high performance
-SCSI solution for the Linux community, and does not want to see anyone left
-unable to run Linux because they have a Flashpoint LT.  Therefore, BusLogic
-has put in place a direct upgrade program to allow any Linux user worldwide
-to trade in their FlashPoint LT for the new BT-948 MultiMaster PCI Ultra
-SCSI Host Adapter.  The BT-948 is the Ultra SCSI successor to the BT-946C
-and has all the best features of both the BT-946C and FlashPoint LT,
-including smart termination and a flash PROM for easy firmware updates, and
-is of course compatible with the present Linux driver.  The price for this
-upgrade has been set at US $45 plus shipping and handling, and the upgrade
-program will be administered through BusLogic Technical Support, which can
-be reached by electronic mail at [email protected], by Voice at +1 408
-654-0760, or by FAX at +1 408 492-1542.
+  However, BusLogic does remain committed to providing a high performance
+  SCSI solution for the Linux community, and does not want to see anyone left
+  unable to run Linux because they have a Flashpoint LT.  Therefore, BusLogic
+  has put in place a direct upgrade program to allow any Linux user worldwide
+  to trade in their FlashPoint LT for the new BT-948 MultiMaster PCI Ultra
+  SCSI Host Adapter.  The BT-948 is the Ultra SCSI successor to the BT-946C
+  and has all the best features of both the BT-946C and FlashPoint LT,
+  including smart termination and a flash PROM for easy firmware updates, and
+  is of course compatible with the present Linux driver.  The price for this
+  upgrade has been set at US $45 plus shipping and handling, and the upgrade
+  program will be administered through BusLogic Technical Support, which can
+  be reached by electronic mail at [email protected], by Voice at +1 408
+  654-0760, or by FAX at +1 408 492-1542.
 
-As of 14 June 1996, the original BusLogic FlashPoint LT to BT-948 upgrade
-program has now been extended to encompass the FlashPoint LW Wide Ultra
-SCSI Host Adapter.  Any Linux user worldwide may trade in their FlashPoint
-LW (BT-950) for a BT-958 MultiMaster PCI Ultra SCSI Host Adapter.  The
-price for this upgrade has been set at US $65 plus shipping and handling.
+  As of 14 June 1996, the original BusLogic FlashPoint LT to BT-948 upgrade
+  program has now been extended to encompass the FlashPoint LW Wide Ultra
+  SCSI Host Adapter.  Any Linux user worldwide may trade in their FlashPoint
+  LW (BT-950) for a BT-958 MultiMaster PCI Ultra SCSI Host Adapter.  The
+  price for this upgrade has been set at US $65 plus shipping and handling.
 
-I was a beta test site for the BT-948/958, and versions 1.2.1 and 1.3.1 of
-my BusLogic driver already included latent support for the BT-948/958.
-Additional cosmetic support for the Ultra SCSI MultiMaster cards was added
-subsequent releases.  As a result of this cooperative testing process,
-several firmware bugs were found and corrected.  My heavily loaded Linux
-test system provided an ideal environment for testing error recovery
-processes that are much more rarely exercised in production systems, but
-are crucial to overall system stability.  It was especially convenient
-being able to work directly with their firmware engineer in demonstrating
-the problems under control of the firmware debugging environment; things
-sure have come a long way since the last time I worked on firmware for an
-embedded system.  I am presently working on some performance testing and
-expect to have some data to report in the not too distant future.
+  I was a beta test site for the BT-948/958, and versions 1.2.1 and 1.3.1 of
+  my BusLogic driver already included latent support for the BT-948/958.
+  Additional cosmetic support for the Ultra SCSI MultiMaster cards was added
+  subsequent releases.  As a result of this cooperative testing process,
+  several firmware bugs were found and corrected.  My heavily loaded Linux
+  test system provided an ideal environment for testing error recovery
+  processes that are much more rarely exercised in production systems, but
+  are crucial to overall system stability.  It was especially convenient
+  being able to work directly with their firmware engineer in demonstrating
+  the problems under control of the firmware debugging environment; things
+  sure have come a long way since the last time I worked on firmware for an
+  embedded system.  I am presently working on some performance testing and
+  expect to have some data to report in the not too distant future.
 
-BusLogic asked me to send this announcement since a large percentage of the
-questions regarding support for the FlashPoint have either been sent to me
-directly via email, or have appeared in the Linux newsgroups in which I
-participate.  To summarize, BusLogic is offering Linux users an upgrade
-from the unsupported FlashPoint LT (BT-930) to the supported BT-948 for US
-$45 plus shipping and handling, or from the unsupported FlashPoint LW
-(BT-950) to the supported BT-958 for $65 plus shipping and handling.
-Contact BusLogic Technical Support at [email protected] or +1 408
-654-0760 to take advantage of their offer.
+  BusLogic asked me to send this announcement since a large percentage of the
+  questions regarding support for the FlashPoint have either been sent to me
+  directly via email, or have appeared in the Linux newsgroups in which I
+  participate.  To summarize, BusLogic is offering Linux users an upgrade
+  from the unsupported FlashPoint LT (BT-930) to the supported BT-948 for US
+  $45 plus shipping and handling, or from the unsupported FlashPoint LW
+  (BT-950) to the supported BT-958 for $65 plus shipping and handling.
+  Contact BusLogic Technical Support at [email protected] or +1 408
+  654-0760 to take advantage of their offer.
 
-		Leonard N. Zubkoff
-		[email protected]
+  		Leonard N. Zubkoff
+  		[email protected]
Documentation/scsi/index.rst +1 -0
index b553dd9904bf..aad8359357e6 100644
@@ -19,5 +19,6 @@ Linux SCSI Subsystem
    cxgb3i
    dc395x
    dpti
+   FlashPoint
 
    scsi_transport_srp/figures
drivers/scsi/Kconfig +1 -1
index 5e834fba7934..e47498f7627e 100644
@@ -503,7 +503,7 @@ config SCSI_BUSLOGIC
 	  Adapters. Consult the SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>, and the files
 	  <file:Documentation/scsi/BusLogic.rst> and
-	  <file:Documentation/scsi/FlashPoint.txt> for more information.
+	  <file:Documentation/scsi/FlashPoint.rst> for more information.
 	  Note that support for FlashPoint is only available for 32-bit
 	  x86 configurations.
 
Signature · 1 line
2.21.1
#18 lore raw

PATCH 16/42 docs: scsi: convert g_NCR5380.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{g_NCR5380.txt => g_NCR5380.rst}     | 89 ++++++++++++-------
 Documentation/scsi/index.rst                  |  1 +
 Documentation/scsi/scsi-parameters.txt        |  6 +-
 MAINTAINERS                                   |  2 +-
 drivers/scsi/g_NCR5380.c                      |  2 +-
 5 files changed, 63 insertions(+), 37 deletions(-)
 rename Documentation/scsi/{g_NCR5380.txt => g_NCR5380.rst} (41%)
Documentation/scsi/g_NCR5380.rst renamed from Documentation/scsi/g_NCR5380.txt +57 -32
similarity index 41%
rename from Documentation/scsi/g_NCR5380.txt
rename to Documentation/scsi/g_NCR5380.rst
index 37b1967a00a9..a282059fec43 100644
@@ -1,7 +1,13 @@
-README file for the Linux g_NCR5380 driver.
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
 
-(c) 1993 Drew Eckhard
-NCR53c400 extensions (c) 1994,1995,1996 Kevin Lentin
+==========================================
+README file for the Linux g_NCR5380 driver
+==========================================
+
+Copyright |copy| 1993 Drew Eckhard
+
+NCR53c400 extensions Copyright |copy| 1994,1995,1996 Kevin Lentin
 
 This file documents the NCR53c400 extensions by Kevin Lentin and some
 enhancements to the NCR5380 core.
@@ -26,43 +32,62 @@ time. More info to come in the future.
 This driver works as a module.
 When included as a module, parameters can be passed on the insmod/modprobe
 command line:
+
+  ============= ===============================================================
   irq=xx[,...]	the interrupt(s)
   base=xx[,...]	the port or base address(es) (for port or memory mapped, resp.)
   card=xx[,...]	card type(s):
-		0 = NCR5380,
-		1 = NCR53C400,
-		2 = NCR53C400A,
-		3 = Domex Technology Corp 3181E (DTC3181E)
-		4 = Hewlett Packard C2502
+
+		==  ======================================
+		0   NCR5380,
+		1   NCR53C400,
+		2   NCR53C400A,
+		3   Domex Technology Corp 3181E (DTC3181E)
+		4   Hewlett Packard C2502
+		==  ======================================
+  ============= ===============================================================
 
 These old-style parameters can support only one card:
-  ncr_irq=xx   the interrupt
-  ncr_addr=xx  the port or base address (for port or memory
-               mapped, resp.)
-  ncr_5380=1   to set up for a NCR5380 board
-  ncr_53c400=1 to set up for a NCR53C400 board
+
+  ============= =================================================
+  ncr_irq=xx    the interrupt
+  ncr_addr=xx   the port or base address (for port or memory
+                mapped, resp.)
+  ncr_5380=1    to set up for a NCR5380 board
+  ncr_53c400=1  to set up for a NCR53C400 board
   ncr_53c400a=1 to set up for a NCR53C400A board
-  dtc_3181e=1  to set up for a Domex Technology Corp 3181E board
-  hp_c2502=1   to set up for a Hewlett Packard C2502 board
-
-E.g. Trantor T130B in its default configuration:
-modprobe g_NCR5380 irq=5 base=0x350 card=1
-or alternatively, using the old syntax,
-modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
-
-E.g. a port mapped NCR5380 board, driver to probe for IRQ:
-modprobe g_NCR5380 base=0x350 card=0
-or alternatively,
-modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
-
-E.g. a memory mapped NCR53C400 board with no IRQ:
-modprobe g_NCR5380 irq=255 base=0xc8000 card=1
-or alternatively,
-modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
+  dtc_3181e=1   to set up for a Domex Technology Corp 3181E board
+  hp_c2502=1    to set up for a Hewlett Packard C2502 board
+  ============= =================================================
+
+E.g. Trantor T130B in its default configuration::
+
+	modprobe g_NCR5380 irq=5 base=0x350 card=1
+
+or alternatively, using the old syntax::
+
+	modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
+
+E.g. a port mapped NCR5380 board, driver to probe for IRQ::
+
+	modprobe g_NCR5380 base=0x350 card=0
+
+or alternatively::
+
+	modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
+
+E.g. a memory mapped NCR53C400 board with no IRQ::
+
+	modprobe g_NCR5380 irq=255 base=0xc8000 card=1
+
+or alternatively::
+
+	modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
 
 E.g. two cards, DTC3181 (in non-PnP mode) at 0x240 with no IRQ
-and HP C2502 at 0x300 with IRQ 7:
-modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
+and HP C2502 at 0x300 with IRQ 7::
+
+	modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
 
 Kevin Lentin
 [email protected]
Documentation/scsi/index.rst +1 -0
index aad8359357e6..4b577c9e804e 100644
@@ -20,5 +20,6 @@ Linux SCSI Subsystem
    dc395x
    dpti
    FlashPoint
+   g_NCR5380
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.txt +3 -3
index 266fd3b2398a..864bbf7f737b 100644
@@ -57,13 +57,13 @@ parameters may be changed at runtime by the command
 			See header of drivers/scsi/NCR_D700.c.
 
 	ncr5380=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c400=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c400a=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c8xx=	[HW,SCSI]
 
MAINTAINERS +1 -1
index 1e2ab816fe66..451a3f67d23a 100644
@@ -11533,7 +11533,7 @@ M:	Finn Thain <[email protected]>
 M:	Michael Schmitz <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/scsi/g_NCR5380.txt
+F:	Documentation/scsi/g_NCR5380.rst
 F:	drivers/scsi/NCR5380.*
 F:	drivers/scsi/arm/cumana_1.c
 F:	drivers/scsi/arm/oak.c
drivers/scsi/g_NCR5380.c +1 -1
index 2ab774e62e40..2cc676e3df6a 100644
@@ -20,7 +20,7 @@
  * Added ISAPNP support for DTC436 adapters,
  * Thomas Sailer, [email protected]
  *
- * See Documentation/scsi/g_NCR5380.txt for more info.
+ * See Documentation/scsi/g_NCR5380.rst for more info.
  */
 
 #include <asm/io.h>
Signature · 1 line
2.21.1
Acked-by on v1 16/42
#19 lore raw

Re: [PATCH 16/42] docs: scsi: convert g_NCR5380.txt to ReST

Quoted 1 line · Mauro Carvalho Chehab
Quoted 184 lines
---
 .../scsi/{g_NCR5380.txt => g_NCR5380.rst}     | 89 ++++++++++++-------
 Documentation/scsi/index.rst                  |  1 +
 Documentation/scsi/scsi-parameters.txt        |  6 +-
 MAINTAINERS                                   |  2 +-
 drivers/scsi/g_NCR5380.c                      |  2 +-
 5 files changed, 63 insertions(+), 37 deletions(-)
 rename Documentation/scsi/{g_NCR5380.txt => g_NCR5380.rst} (41%)
Documentation/scsi/g_NCR5380.rst renamed from Documentation/scsi/g_NCR5380.txt +57 -32
similarity index 41%
rename from Documentation/scsi/g_NCR5380.txt
rename to Documentation/scsi/g_NCR5380.rst
index 37b1967a00a9..a282059fec43 100644
@@ -1,7 +1,13 @@
-README file for the Linux g_NCR5380 driver.
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
 
-(c) 1993 Drew Eckhard
-NCR53c400 extensions (c) 1994,1995,1996 Kevin Lentin
+==========================================
+README file for the Linux g_NCR5380 driver
+==========================================
+
+Copyright |copy| 1993 Drew Eckhard
+
+NCR53c400 extensions Copyright |copy| 1994,1995,1996 Kevin Lentin
 
 This file documents the NCR53c400 extensions by Kevin Lentin and some
 enhancements to the NCR5380 core.
@@ -26,43 +32,62 @@ time. More info to come in the future.
 This driver works as a module.
 When included as a module, parameters can be passed on the insmod/modprobe
 command line:
+
+  ============= ===============================================================
   irq=xx[,...]	the interrupt(s)
   base=xx[,...]	the port or base address(es) (for port or memory mapped, resp.)
   card=xx[,...]	card type(s):
-		0 = NCR5380,
-		1 = NCR53C400,
-		2 = NCR53C400A,
-		3 = Domex Technology Corp 3181E (DTC3181E)
-		4 = Hewlett Packard C2502
+
+		==  ======================================
+		0   NCR5380,
+		1   NCR53C400,
+		2   NCR53C400A,
+		3   Domex Technology Corp 3181E (DTC3181E)
+		4   Hewlett Packard C2502
+		==  ======================================
+  ============= ===============================================================
 
 These old-style parameters can support only one card:
-  ncr_irq=xx   the interrupt
-  ncr_addr=xx  the port or base address (for port or memory
-               mapped, resp.)
-  ncr_5380=1   to set up for a NCR5380 board
-  ncr_53c400=1 to set up for a NCR53C400 board
+
+  ============= =================================================
+  ncr_irq=xx    the interrupt
+  ncr_addr=xx   the port or base address (for port or memory
+                mapped, resp.)
+  ncr_5380=1    to set up for a NCR5380 board
+  ncr_53c400=1  to set up for a NCR53C400 board
   ncr_53c400a=1 to set up for a NCR53C400A board
-  dtc_3181e=1  to set up for a Domex Technology Corp 3181E board
-  hp_c2502=1   to set up for a Hewlett Packard C2502 board
-
-E.g. Trantor T130B in its default configuration:
-modprobe g_NCR5380 irq=5 base=0x350 card=1
-or alternatively, using the old syntax,
-modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
-
-E.g. a port mapped NCR5380 board, driver to probe for IRQ:
-modprobe g_NCR5380 base=0x350 card=0
-or alternatively,
-modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
-
-E.g. a memory mapped NCR53C400 board with no IRQ:
-modprobe g_NCR5380 irq=255 base=0xc8000 card=1
-or alternatively,
-modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
+  dtc_3181e=1   to set up for a Domex Technology Corp 3181E board
+  hp_c2502=1    to set up for a Hewlett Packard C2502 board
+  ============= =================================================
+
+E.g. Trantor T130B in its default configuration::
+
+	modprobe g_NCR5380 irq=5 base=0x350 card=1
+
+or alternatively, using the old syntax::
+
+	modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
+
+E.g. a port mapped NCR5380 board, driver to probe for IRQ::
+
+	modprobe g_NCR5380 base=0x350 card=0
+
+or alternatively::
+
+	modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
+
+E.g. a memory mapped NCR53C400 board with no IRQ::
+
+	modprobe g_NCR5380 irq=255 base=0xc8000 card=1
+
+or alternatively::
+
+	modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
 
 E.g. two cards, DTC3181 (in non-PnP mode) at 0x240 with no IRQ
-and HP C2502 at 0x300 with IRQ 7:
-modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
+and HP C2502 at 0x300 with IRQ 7::
+
+	modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
 
 Kevin Lentin
 [email protected]
Documentation/scsi/index.rst +1 -0
index aad8359357e6..4b577c9e804e 100644
@@ -20,5 +20,6 @@ Linux SCSI Subsystem
    dc395x
    dpti
    FlashPoint
+   g_NCR5380
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.txt +3 -3
index 266fd3b2398a..864bbf7f737b 100644
@@ -57,13 +57,13 @@ parameters may be changed at runtime by the command
 			See header of drivers/scsi/NCR_D700.c.
 
 	ncr5380=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c400=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c400a=	[HW,SCSI]
-			See Documentation/scsi/g_NCR5380.txt.
+			See Documentation/scsi/g_NCR5380.rst.
 
 	ncr53c8xx=	[HW,SCSI]
 
MAINTAINERS +1 -1
index 1e2ab816fe66..451a3f67d23a 100644
@@ -11533,7 +11533,7 @@ M:	Finn Thain <[email protected]>
 M:	Michael Schmitz <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/scsi/g_NCR5380.txt
+F:	Documentation/scsi/g_NCR5380.rst
 F:	drivers/scsi/NCR5380.*
 F:	drivers/scsi/arm/cumana_1.c
 F:	drivers/scsi/arm/oak.c
drivers/scsi/g_NCR5380.c +1 -1
index 2ab774e62e40..2cc676e3df6a 100644
@@ -20,7 +20,7 @@
  * Added ISAPNP support for DTC436 adapters,
  * Thomas Sailer, [email protected]
  *
- * See Documentation/scsi/g_NCR5380.txt for more info.
+ * See Documentation/scsi/g_NCR5380.rst for more info.
  */
 
 #include <asm/io.h>
#20 lore raw

PATCH 17/42 docs: scsi: convert hpsa.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{hpsa.txt => hpsa.rst} | 79 +++++++++++------------
 Documentation/scsi/index.rst              |  1 +
 MAINTAINERS                               |  2 +-
 3 files changed, 41 insertions(+), 41 deletions(-)
 rename Documentation/scsi/{hpsa.txt => hpsa.rst} (77%)
Documentation/scsi/hpsa.rst renamed from Documentation/scsi/hpsa.txt +39 -40
similarity index 77%
rename from Documentation/scsi/hpsa.txt
rename to Documentation/scsi/hpsa.rst
index 891435a72fce..340e10c6e35f 100644
@@ -1,6 +1,8 @@
+.. 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,18 +37,20 @@ 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
-  /sys/class/scsi_host/host*/resettable
-  /sys/class/scsi_host/host*/transport_mode
+  ::
+
+    /sys/class/scsi_host/host*/rescan
+    /sys/class/scsi_host/host*/firmware_revision
+    /sys/class/scsi_host/host*/resettable
+    /sys/class/scsi_host/host*/transport_mode
 
   the host "rescan" attribute is a write only attribute.  Writing to this
   attribute will cause the driver to scan for new, changed, or removed devices
@@ -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,16 +82,18 @@ 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
-  /sys/class/scsi_disk/c:b:t:l/device/lunid
+  ::
+
+    /sys/class/scsi_disk/c:b:t:l/device/unique_id
+    /sys/class/scsi_disk/c:b:t:l/device/raid_level
+    /sys/class/scsi_disk/c:b:t:l/device/lunid
 
   (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
-
-  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_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
index 4b577c9e804e..b16f348bd31b 100644
@@ -21,5 +21,6 @@ Linux SCSI Subsystem
    dpti
    FlashPoint
    g_NCR5380
+   hpsa
 
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index 451a3f67d23a..39767eca07d9 100644
@@ -7456,7 +7456,7 @@ M:	Don Brace <[email protected]>
 L:	[email protected]
 L:	[email protected]
 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
Signature · 1 line
2.21.1
#21 lore raw

PATCH 18/42 docs: scsi: convert hptiop.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/{hptiop.txt => hptiop.rst} | 45 ++++++++++++++++---
 Documentation/scsi/index.rst                  |  1 +
 MAINTAINERS                                   |  2 +-
 3 files changed, 40 insertions(+), 8 deletions(-)
 rename Documentation/scsi/{hptiop.txt => hptiop.rst} (78%)
Documentation/scsi/hptiop.rst renamed from Documentation/scsi/hptiop.txt +38 -7
similarity index 78%
rename from Documentation/scsi/hptiop.txt
rename to Documentation/scsi/hptiop.rst
index 12ecfd308e55..23ae7ae36971 100644
@@ -1,15 +1,25 @@
-HIGHPOINT ROCKETRAID 3xxx/4xxx ADAPTER DRIVER (hptiop)
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+
+======================================================
+Highpoint RocketRAID 3xxx/4xxx Adapter Driver (hptiop)
+======================================================
 
 Controller Register Map
--------------------------
+-----------------------
 
-For RR44xx Intel IOP based adapters, the controller IOP is accessed via PCI BAR0 and BAR2:
+For RR44xx Intel IOP based adapters, the controller IOP is accessed via PCI BAR0 and BAR2
 
+     ============== ==================================
      BAR0 offset    Register
+     ============== ==================================
             0x11C5C Link Interface IRQ Set
             0x11C60 Link Interface IRQ Clear
+     ============== ==================================
 
+     ============== ==================================
      BAR2 offset    Register
+     ============== ==================================
             0x10    Inbound Message Register 0
             0x14    Inbound Message Register 1
             0x18    Outbound Message Register 0
@@ -21,10 +31,13 @@ For RR44xx Intel IOP based adapters, the controller IOP is accessed via PCI BAR0
             0x34    Outbound Interrupt Mask Register
             0x40    Inbound Queue Port
             0x44    Outbound Queue Port
+     ============== ==================================
 
 For Intel IOP based adapters, the controller IOP is accessed via PCI BAR0:
 
+     ============== ==================================
      BAR0 offset    Register
+     ============== ==================================
             0x10    Inbound Message Register 0
             0x14    Inbound Message Register 1
             0x18    Outbound Message Register 0
@@ -36,16 +49,22 @@ For Intel IOP based adapters, the controller IOP is accessed via PCI BAR0:
             0x34    Outbound Interrupt Mask Register
             0x40    Inbound Queue Port
             0x44    Outbound Queue Port
+     ============== ==================================
 
 For Marvell not Frey IOP based adapters, the IOP is accessed via PCI BAR0 and BAR1:
 
+     ============== ==================================
      BAR0 offset    Register
+     ============== ==================================
          0x20400    Inbound Doorbell Register
          0x20404    Inbound Interrupt Mask Register
          0x20408    Outbound Doorbell Register
          0x2040C    Outbound Interrupt Mask Register
+     ============== ==================================
 
+     ============== ==================================
      BAR1 offset    Register
+     ============== ==================================
              0x0    Inbound Queue Head Pointer
              0x4    Inbound Queue Tail Pointer
              0x8    Outbound Queue Head Pointer
@@ -53,14 +72,20 @@ For Marvell not Frey IOP based adapters, the IOP is accessed via PCI BAR0 and BA
             0x10    Inbound Message Register
             0x14    Outbound Message Register
      0x40-0x1040    Inbound Queue
-   0x1040-0x2040    Outbound Queue
+     0x1040-0x2040  Outbound Queue
+     ============== ==================================
 
 For Marvell Frey IOP based adapters, the IOP is accessed via PCI BAR0 and BAR1:
 
+     ============== ==================================
      BAR0 offset    Register
+     ============== ==================================
              0x0    IOP configuration information.
+     ============== ==================================
 
+     ============== ===================================================
      BAR1 offset    Register
+     ============== ===================================================
           0x4000    Inbound List Base Address Low
           0x4004    Inbound List Base Address High
           0x4018    Inbound List Write Pointer
@@ -76,10 +101,11 @@ For Marvell Frey IOP based adapters, the IOP is accessed via PCI BAR0 and BAR1:
          0x10420    CPU to PCIe Function 0 Message A
          0x10480    CPU to PCIe Function 0 Doorbell
          0x10484    CPU to PCIe Function 0 Doorbell Enable
+     ============== ===================================================
 
 
 I/O Request Workflow of Not Marvell Frey
-------------------------------------------
+----------------------------------------
 
 All queued requests are handled via inbound/outbound queue port.
 A request packet can be allocated in either IOP or host memory.
@@ -124,7 +150,7 @@ of an inbound message.
 
 
 I/O Request Workflow of Marvell Frey
---------------------------------------
+------------------------------------
 
 All queued requests are handled via inbound/outbound list.
 
@@ -167,13 +193,17 @@ User-level Interface
 
 The driver exposes following sysfs attributes:
 
+     ==================   ===    ========================
      NAME                 R/W    Description
+     ==================   ===    ========================
      driver-version        R     driver version string
      firmware-version      R     firmware version string
+     ==================   ===    ========================
 
 
 -----------------------------------------------------------------------------
-Copyright (C) 2006-2012 HighPoint Technologies, Inc. All Rights Reserved.
+
+Copyright |copy| 2006-2012 HighPoint Technologies, Inc. All Rights Reserved.
 
   This file is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -181,4 +211,5 @@ Copyright (C) 2006-2012 HighPoint Technologies, Inc. All Rights Reserved.
   GNU General Public License for more details.
 
   [email protected]
+
   http://www.highpoint-tech.com
Documentation/scsi/index.rst +1 -0
index b16f348bd31b..b13df9c1810a 100644
@@ -22,5 +22,6 @@ Linux SCSI Subsystem
    FlashPoint
    g_NCR5380
    hpsa
+   hptiop
 
    scsi_transport_srp/figures
MAINTAINERS +1 -1
index 39767eca07d9..e2bd7911baa9 100644
@@ -7545,7 +7545,7 @@ HIGHPOINT ROCKETRAID 3xxx RAID DRIVER
 M:	HighPoint Linux Team <[email protected]>
 W:	http://www.highpoint-tech.com
 S:	Supported
-F:	Documentation/scsi/hptiop.txt
+F:	Documentation/scsi/hptiop.rst
 F:	drivers/scsi/hptiop.c
 
 HIPPI
Signature · 1 line
2.21.1
#22 lore raw

PATCH 19/42 docs: scsi: convert libsas.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |   1 +
 Documentation/scsi/{libsas.txt => libsas.rst} | 364 +++++++++++-------
 2 files changed, 218 insertions(+), 147 deletions(-)
 rename Documentation/scsi/{libsas.txt => libsas.rst} (57%)
Documentation/scsi/index.rst +1 -0
index b13df9c1810a..e6850c0a1378 100644
@@ -23,5 +23,6 @@ Linux SCSI Subsystem
    g_NCR5380
    hpsa
    hptiop
+   libsas
 
    scsi_transport_srp/figures
Documentation/scsi/libsas.rst renamed from Documentation/scsi/libsas.txt +217 -147

511 lines not on this page · raw message

Signature · 1 line
2.21.1
#23 lore raw

PATCH 20/42 docs: scsi: convert link_power_management_policy.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                         |  1 +
 ...t_policy.txt => link_power_management_policy.rst} | 12 +++++++++---
 2 files changed, 10 insertions(+), 3 deletions(-)
 rename Documentation/scsi/{link_power_management_policy.txt => link_power_management_policy.rst} (65%)
Documentation/scsi/index.rst +1 -0
index e6850c0a1378..c40050ac3b32 100644
@@ -24,5 +24,6 @@ Linux SCSI Subsystem
    hpsa
    hptiop
    libsas
+   link_power_management_policy
 
    scsi_transport_srp/figures
Documentation/scsi/link_power_management_policy.rst renamed from Documentation/scsi/link_power_management_policy.txt +9 -3
similarity index 65%
rename from Documentation/scsi/link_power_management_policy.txt
rename to Documentation/scsi/link_power_management_policy.rst
index d18993d01884..64288dcf10f6 100644
@@ -1,8 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+Link Power Managent Policy
+==========================
+
 This parameter allows the user to set the link (interface) power management.
 There are 3 possible options:
 
+=====================   =====================================================
 Value			Effect
-----------------------------------------------------------------------------
+=====================   =====================================================
 min_power		Tell the controller to try to make the link use the
 			least possible power when possible.  This may
 			sacrifice some performance due to increased latency
@@ -15,5 +22,4 @@ max_performance		Generally, this means no power management.  Tell
 medium_power		Tell the controller to enter a lower power state
 			when possible, but do not enter the lowest power
 			state, thus improving latency over min_power setting.
-
-
+=====================   =====================================================
Signature · 1 line
2.21.1
#24 lore raw

PATCH 21/42 docs: scsi: convert lpfc.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst              |  1 +
 Documentation/scsi/{lpfc.txt => lpfc.rst} | 16 +++++++---------
 2 files changed, 8 insertions(+), 9 deletions(-)
 rename Documentation/scsi/{lpfc.txt => lpfc.rst} (93%)
Documentation/scsi/index.rst +1 -0
index c40050ac3b32..22427511e227 100644
@@ -25,5 +25,6 @@ Linux SCSI Subsystem
    hptiop
    libsas
    link_power_management_policy
+   lpfc
 
    scsi_transport_srp/figures
Documentation/scsi/lpfc.rst renamed from Documentation/scsi/lpfc.txt +7 -9
similarity index 93%
rename from Documentation/scsi/lpfc.txt
rename to Documentation/scsi/lpfc.rst
index 5741ea8aa88a..6e217e82b9b9 100644
@@ -1,10 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-LPFC Driver Release Notes:
+=========================
+LPFC Driver Release Notes
+=========================
 
-=============================================================================
 
-
-                               IMPORTANT:
+.. important::
 
   Starting in the 8.0.17 release, the driver began to be targeted strictly
   toward the upstream kernel. As such, we removed #ifdefs for older kernels
@@ -22,9 +23,6 @@ LPFC Driver Release Notes:
   Please heed these dependencies....
 
 
-   ********************************************************************
-
-
 The following information is provided for additional background on the
 history of the driver as we push for upstream acceptance.
 
@@ -64,6 +62,7 @@ Cable pull and temporary device Loss:
 
 
 Kernel Support
+==============
 
   This source package is targeted for the upstream kernel only. (See notes
   at the top of this file). It relies on interfaces that are slowing
@@ -77,7 +76,6 @@ Kernel Support
 
 
 Patches
+=======
 
   Thankfully, at this time, patches are not needed.
-
-
Signature · 1 line
2.21.1
#25 lore raw

PATCH 22/42 docs: scsi: convert megaraid.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 .../scsi/{megaraid.txt => megaraid.rst}       | 47 +++++++++++--------
 MAINTAINERS                                   |  2 +-
 3 files changed, 29 insertions(+), 21 deletions(-)
 rename Documentation/scsi/{megaraid.txt => megaraid.rst} (66%)
Documentation/scsi/index.rst +1 -0
index 22427511e227..37be1fc9d128 100644
@@ -26,5 +26,6 @@ Linux SCSI Subsystem
    libsas
    link_power_management_policy
    lpfc
+   megaraid
 
    scsi_transport_srp/figures
Documentation/scsi/megaraid.rst renamed from Documentation/scsi/megaraid.txt +27 -20

69 lines not on this page · raw message

MAINTAINERS +1 -1
index e2bd7911baa9..6d28bfc72259 100644
@@ -10699,7 +10699,7 @@ L:	[email protected]
 L:	[email protected]
 W:	http://www.avagotech.com/support/
 S:	Maintained
-F:	Documentation/scsi/megaraid.txt
+F:	Documentation/scsi/megaraid.rst
 F:	drivers/scsi/megaraid.*
 F:	drivers/scsi/megaraid/
 
Signature · 1 line
2.21.1
#26 lore raw

PATCH 23/42 docs: scsi: convert ncr53c8xx.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |    1 +
 .../scsi/{ncr53c8xx.txt => ncr53c8xx.rst}     | 1865 ++++++++++-------
 drivers/scsi/ncr53c8xx.c                      |    2 +-
 3 files changed, 1107 insertions(+), 761 deletions(-)
 rename Documentation/scsi/{ncr53c8xx.txt => ncr53c8xx.rst} (55%)
Documentation/scsi/index.rst +1 -0
index 37be1fc9d128..a2545efbb407 100644
@@ -27,5 +27,6 @@ Linux SCSI Subsystem
    link_power_management_policy
    lpfc
    megaraid
+   ncr53c8xx
 
    scsi_transport_srp/figures
Documentation/scsi/ncr53c8xx.rst renamed from Documentation/scsi/ncr53c8xx.txt +1105 -760

2,716 lines not on this page · raw message

drivers/scsi/ncr53c8xx.c +1 -1
index 11a2cb844ecb..f88adab3f913 100644
@@ -2203,7 +2203,7 @@ static	struct script script0 __initdata = {
 	**	Possible data corruption during Memory Write and Invalidate.
 	**	This work-around resets the addressing logic prior to the 
 	**	start of the first MOVE of a DATA IN phase.
-	**	(See Documentation/scsi/ncr53c8xx.txt for more information)
+	**	(See Documentation/scsi/ncr53c8xx.rst for more information)
 	*/
 	SCR_JUMPR ^ IFFALSE (IF (SCR_DATA_IN)),
 		20,
Signature · 1 line
2.21.1
#27 lore raw

PATCH 24/42 docs: scsi: convert NinjaSCSI.txt to ReST

In reply to Mauro Carvalho Chehab
---
 .../scsi/{NinjaSCSI.txt => NinjaSCSI.rst}     | 198 +++++++++++-------
 Documentation/scsi/index.rst                  |   1 +
 MAINTAINERS                                   |   4 +-
 drivers/scsi/pcmcia/Kconfig                   |   2 +-
 4 files changed, 121 insertions(+), 84 deletions(-)
 rename Documentation/scsi/{NinjaSCSI.txt => NinjaSCSI.rst} (28%)
Documentation/scsi/NinjaSCSI.rst renamed from Documentation/scsi/NinjaSCSI.txt +117 -81
similarity index 28%
rename from Documentation/scsi/NinjaSCSI.txt
rename to Documentation/scsi/NinjaSCSI.rst
index ac8db8ceec77..999a6ed5bf7e 100644
@@ -1,127 +1,163 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-         WorkBiT NinjaSCSI-3/32Bi driver for Linux
+=========================================
+WorkBiT NinjaSCSI-3/32Bi driver for Linux
+=========================================
 
 1. Comment
- This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
+==========
+
+This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
 for Linux.
 
 2. My Linux environment
-Linux kernel: 2.4.7 / 2.2.19
-pcmcia-cs:    3.1.27
-gcc:          gcc-2.95.4
-PC card:      I-O data PCSC-F (NinjaSCSI-3)
-              I-O data CBSC-II in 16 bit mode (NinjaSCSI-32Bi)
-SCSI device:  I-O data CDPS-PX24 (CD-ROM drive)
-              Media Intelligent MMO-640GT (Optical disk drive)
+=======================
+
+:Linux kernel: 2.4.7 / 2.2.19
+:pcmcia-cs:    3.1.27
+:gcc:          gcc-2.95.4
+:PC card:      I-O data PCSC-F (NinjaSCSI-3),
+               I-O data CBSC-II in 16 bit mode (NinjaSCSI-32Bi)
+:SCSI device:  I-O data CDPS-PX24 (CD-ROM drive),
+               Media Intelligent MMO-640GT (Optical disk drive)
 
 3. Install
-[1] Check your PC card is true "NinjaSCSI-3" card.
+==========
+
+(a) Check your PC card is true "NinjaSCSI-3" card.
+
     If you installed pcmcia-cs already, pcmcia reports your card as UNKNOWN
     card, and write ["WBT", "NinjaSCSI-3", "R1.0"] or some other string to
     your console or log file.
+
     You can also use "cardctl" program (this program is in pcmcia-cs source
     code) to get more info.
 
-# cat /var/log/messages
-...
-Jan  2 03:45:06 lindberg cardmgr[78]: unsupported card in socket 1
-Jan  2 03:45:06 lindberg cardmgr[78]:   product info: "WBT", "NinjaSCSI-3", "R1.0"
-...
-# cardctl ident
-Socket 0:
-  no product info available
-Socket 1:
-  product info: "IO DATA", "CBSC16       ", "1"
+    ::
 
+	# cat /var/log/messages
+	...
+	Jan  2 03:45:06 lindberg cardmgr[78]: unsupported card in socket 1
+	Jan  2 03:45:06 lindberg cardmgr[78]:   product info: "WBT", "NinjaSCSI-3", "R1.0"
+	...
+	# cardctl ident
+	Socket 0:
+	  no product info available
+	Socket 1:
+	  product info: "IO DATA", "CBSC16       ", "1"
 
-[2] Get the Linux kernel source, and extract it to /usr/src.
+
+(b) Get the Linux kernel source, and extract it to /usr/src.
     Because the NinjaSCSI driver requires some SCSI header files in Linux 
     kernel source, I recommend rebuilding your kernel; this eliminates 
     some versioning problems.
-$ cd /usr/src
-$ tar -zxvf linux-x.x.x.tar.gz
-$ cd linux
-$ make config
-...
 
-[3] If you use this driver with Kernel 2.2, unpack pcmcia-cs in some directory
+    ::
+
+	$ cd /usr/src
+	$ tar -zxvf linux-x.x.x.tar.gz
+	$ cd linux
+	$ make config
+	...
+
+(c) If you use this driver with Kernel 2.2, unpack pcmcia-cs in some directory
     and make & install. This driver requires the pcmcia-cs header file.
-$ cd /usr/src
-$ tar zxvf cs-pcmcia-cs-3.x.x.tar.gz
-...
 
-[4] Extract this driver's archive somewhere, and edit Makefile, then do make.
-$ tar -zxvf nsp_cs-x.x.tar.gz
-$ cd nsp_cs-x.x
-$ emacs Makefile
-...
-$ make
+    ::
 
-[5] Copy nsp_cs.ko to suitable place, like /lib/modules/<Kernel version>/pcmcia/ .
+	$ cd /usr/src
+	$ tar zxvf cs-pcmcia-cs-3.x.x.tar.gz
+	...
+
+(d) Extract this driver's archive somewhere, and edit Makefile, then do make::
+
+	$ tar -zxvf nsp_cs-x.x.tar.gz
+	$ cd nsp_cs-x.x
+	$ emacs Makefile
+	...
+	$ make
+
+(e) Copy nsp_cs.ko to suitable place, like /lib/modules/<Kernel version>/pcmcia/ .
+
+(f) Add these lines to /etc/pcmcia/config .
 
-[6] Add these lines to /etc/pcmcia/config .
     If you use pcmcia-cs-3.1.8 or later, we can use "nsp_cs.conf" file.
     So, you don't need to edit file. Just copy to /etc/pcmcia/ .
 
--------------------------------------
-device "nsp_cs"
-  class "scsi" module "nsp_cs"
-
-card "WorkBit NinjaSCSI-3"
-  version "WBT", "NinjaSCSI-3", "R1.0"
-  bind "nsp_cs"
-
-card "WorkBit NinjaSCSI-32Bi (16bit)"
-  version "WORKBIT", "UltraNinja-16", "1"
-  bind "nsp_cs"
-
-# OEM
-card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
-  version "IO DATA", "CBSC16       ", "1"
-  bind "nsp_cs"
-
-# OEM
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
-  version "KME    ", "SCSI-CARD-001", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
-  version "KME    ", "SCSI-CARD-002", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
-  version "KME    ", "SCSI-CARD-003", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
-  version "KME    ", "SCSI-CARD-004", "1"
-  bind "nsp_cs"
--------------------------------------
-
-[7] Start (or restart) pcmcia-cs.
-# /etc/rc.d/rc.pcmcia start        (BSD style)
-or
-# /etc/init.d/pcmcia start         (SYSV style)
+    ::
+
+	device "nsp_cs"
+	  class "scsi" module "nsp_cs"
+
+	card "WorkBit NinjaSCSI-3"
+	  version "WBT", "NinjaSCSI-3", "R1.0"
+	  bind "nsp_cs"
+
+	card "WorkBit NinjaSCSI-32Bi (16bit)"
+	  version "WORKBIT", "UltraNinja-16", "1"
+	  bind "nsp_cs"
+
+	# OEM
+	card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
+	  version "IO DATA", "CBSC16       ", "1"
+	  bind "nsp_cs"
+
+	# OEM
+	card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
+	  version "KME    ", "SCSI-CARD-001", "1"
+	  bind "nsp_cs"
+	card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
+	  version "KME    ", "SCSI-CARD-002", "1"
+	  bind "nsp_cs"
+	card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
+	  version "KME    ", "SCSI-CARD-003", "1"
+	  bind "nsp_cs"
+	card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
+	  version "KME    ", "SCSI-CARD-004", "1"
+	  bind "nsp_cs"
+
+(f) Start (or restart) pcmcia-cs::
+
+	# /etc/rc.d/rc.pcmcia start        (BSD style)
+
+    or::
+
+	# /etc/init.d/pcmcia start         (SYSV style)
 
 
 4. History
+==========
+
 See README.nin_cs .
 
 5. Caution
- If you eject card when doing some operation for your SCSI device or suspend
+==========
+
+If you eject card when doing some operation for your SCSI device or suspend
 your computer, you encount some *BAD* error like disk crash.
- It works good when I using this driver right way. But I'm not guarantee
+
+It works good when I using this driver right way. But I'm not guarantee
 your data. Please backup your data when you use this driver.
 
 6. Known Bugs
- In 2.4 kernel, you can't use 640MB Optical disk. This error comes from
+=============
+
+In 2.4 kernel, you can't use 640MB Optical disk. This error comes from
 high level SCSI driver.
 
 7. Testing
- Please send me some reports(bug reports etc..) of this software.
+==========
+
+Please send me some reports(bug reports etc..) of this software.
 When you send report, please tell me these or more.
-	card name
-	kernel version
-	your SCSI device name(hard drive, CD-ROM, etc...)
+
+	- card name
+	- kernel version
+	- your SCSI device name(hard drive, CD-ROM, etc...)
 
 8. Copyright
+============
+
  See GPL.
 
 
Documentation/scsi/index.rst +1 -0
index a2545efbb407..eb2df0e0dcb7 100644
@@ -28,5 +28,6 @@ Linux SCSI Subsystem
    lpfc
    megaraid
    ncr53c8xx
+   NinjaSCSI
 
    scsi_transport_srp/figures
MAINTAINERS +2 -2
index 6d28bfc72259..2f441cf59b4b 100644
@@ -11861,7 +11861,7 @@ NINJA SCSI-3 / NINJA SCSI-32Bi (16bit/CardBus) PCMCIA SCSI HOST ADAPTER DRIVER
 M:	YOKOTA Hiroshi <[email protected]>
 W:	http://www.netlab.is.tsukuba.ac.jp/~yokota/izumi/ninja/
 S:	Maintained
-F:	Documentation/scsi/NinjaSCSI.txt
+F:	Documentation/scsi/NinjaSCSI.rst
 F:	drivers/scsi/pcmcia/nsp_*
 
 NINJA SCSI-32Bi/UDE PCI/CARDBUS SCSI HOST ADAPTER DRIVER
@@ -11869,7 +11869,7 @@ M:	GOTO Masanori <[email protected]>
 M:	YOKOTA Hiroshi <[email protected]>
 W:	http://www.netlab.is.tsukuba.ac.jp/~yokota/izumi/ninja/
 S:	Maintained
-F:	Documentation/scsi/NinjaSCSI.txt
+F:	Documentation/scsi/NinjaSCSI.rst
 F:	drivers/scsi/nsp32*
 
 NIOS2 ARCHITECTURE
drivers/scsi/pcmcia/Kconfig +1 -1
index dc9b74c9348a..9696b6b5591f 100644
@@ -36,7 +36,7 @@ config PCMCIA_NINJA_SCSI
 	help
 	  If you intend to attach this type of PCMCIA SCSI host adapter to
 	  your computer, say Y here and read
-	  <file:Documentation/scsi/NinjaSCSI.txt>.
+	  <file:Documentation/scsi/NinjaSCSI.rst>.
 
 	  Supported cards:
 
Signature · 1 line
2.21.1
maintainer Acked-by on v1 24/42
#28 lore raw

Re: [PATCH 24/42] docs: scsi: convert NinjaSCSI.txt to ReST

2020年3月2日(月) 17:17 Mauro Carvalho Chehab <[email protected]>:

Quoted 2 lines
Quoted 309 lines
---
 .../scsi/{NinjaSCSI.txt => NinjaSCSI.rst}     | 198 +++++++++++-------
 Documentation/scsi/index.rst                  |   1 +
 MAINTAINERS                                   |   4 +-
 drivers/scsi/pcmcia/Kconfig                   |   2 +-
 4 files changed, 121 insertions(+), 84 deletions(-)
 rename Documentation/scsi/{NinjaSCSI.txt => NinjaSCSI.rst} (28%)
Documentation/scsi/NinjaSCSI.rst renamed from Documentation/scsi/NinjaSCSI.txt +117 -81
similarity index 28%
rename from Documentation/scsi/NinjaSCSI.txt
rename to Documentation/scsi/NinjaSCSI.rst
index ac8db8ceec77..999a6ed5bf7e 100644
@@ -1,127 +1,163 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-         WorkBiT NinjaSCSI-3/32Bi driver for Linux
+=========================================
+WorkBiT NinjaSCSI-3/32Bi driver for Linux
+=========================================
 
 1. Comment
- This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
+==========
+
+This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
 for Linux.
 
 2. My Linux environment
-Linux kernel: 2.4.7 / 2.2.19
-pcmcia-cs:    3.1.27
-gcc:          gcc-2.95.4
-PC card:      I-O data PCSC-F (NinjaSCSI-3)
-              I-O data CBSC-II in 16 bit mode (NinjaSCSI-32Bi)
-SCSI device:  I-O data CDPS-PX24 (CD-ROM drive)
-              Media Intelligent MMO-640GT (Optical disk drive)
+=======================
+
+:Linux kernel: 2.4.7 / 2.2.19
+:pcmcia-cs:    3.1.27
+:gcc:          gcc-2.95.4
+:PC card:      I-O data PCSC-F (NinjaSCSI-3),
+               I-O data CBSC-II in 16 bit mode (NinjaSCSI-32Bi)
+:SCSI device:  I-O data CDPS-PX24 (CD-ROM drive),
+               Media Intelligent MMO-640GT (Optical disk drive)
 
 3. Install
-[1] Check your PC card is true "NinjaSCSI-3" card.
+==========
+
+(a) Check your PC card is true "NinjaSCSI-3" card.
+
     If you installed pcmcia-cs already, pcmcia reports your card as UNKNOWN
     card, and write ["WBT", "NinjaSCSI-3", "R1.0"] or some other string to
     your console or log file.
+
     You can also use "cardctl" program (this program is in pcmcia-cs source
     code) to get more info.
 
-# cat /var/log/messages
-...
-Jan  2 03:45:06 lindberg cardmgr[78]: unsupported card in socket 1
-Jan  2 03:45:06 lindberg cardmgr[78]:   product info: "WBT", "NinjaSCSI-3", "R1.0"
-...
-# cardctl ident
-Socket 0:
-  no product info available
-Socket 1:
-  product info: "IO DATA", "CBSC16       ", "1"
+    ::
 
+       # cat /var/log/messages
+       ...
+       Jan  2 03:45:06 lindberg cardmgr[78]: unsupported card in socket 1
+       Jan  2 03:45:06 lindberg cardmgr[78]:   product info: "WBT", "NinjaSCSI-3", "R1.0"
+       ...
+       # cardctl ident
+       Socket 0:
+         no product info available
+       Socket 1:
+         product info: "IO DATA", "CBSC16       ", "1"
 
-[2] Get the Linux kernel source, and extract it to /usr/src.
+
+(b) Get the Linux kernel source, and extract it to /usr/src.
     Because the NinjaSCSI driver requires some SCSI header files in Linux
     kernel source, I recommend rebuilding your kernel; this eliminates
     some versioning problems.
-$ cd /usr/src
-$ tar -zxvf linux-x.x.x.tar.gz
-$ cd linux
-$ make config
-...
 
-[3] If you use this driver with Kernel 2.2, unpack pcmcia-cs in some directory
+    ::
+
+       $ cd /usr/src
+       $ tar -zxvf linux-x.x.x.tar.gz
+       $ cd linux
+       $ make config
+       ...
+
+(c) If you use this driver with Kernel 2.2, unpack pcmcia-cs in some directory
     and make & install. This driver requires the pcmcia-cs header file.
-$ cd /usr/src
-$ tar zxvf cs-pcmcia-cs-3.x.x.tar.gz
-...
 
-[4] Extract this driver's archive somewhere, and edit Makefile, then do make.
-$ tar -zxvf nsp_cs-x.x.tar.gz
-$ cd nsp_cs-x.x
-$ emacs Makefile
-...
-$ make
+    ::
 
-[5] Copy nsp_cs.ko to suitable place, like /lib/modules/<Kernel version>/pcmcia/ .
+       $ cd /usr/src
+       $ tar zxvf cs-pcmcia-cs-3.x.x.tar.gz
+       ...
+
+(d) Extract this driver's archive somewhere, and edit Makefile, then do make::
+
+       $ tar -zxvf nsp_cs-x.x.tar.gz
+       $ cd nsp_cs-x.x
+       $ emacs Makefile
+       ...
+       $ make
+
+(e) Copy nsp_cs.ko to suitable place, like /lib/modules/<Kernel version>/pcmcia/ .
+
+(f) Add these lines to /etc/pcmcia/config .
 
-[6] Add these lines to /etc/pcmcia/config .
     If you use pcmcia-cs-3.1.8 or later, we can use "nsp_cs.conf" file.
     So, you don't need to edit file. Just copy to /etc/pcmcia/ .
 
--------------------------------------
-device "nsp_cs"
-  class "scsi" module "nsp_cs"
-
-card "WorkBit NinjaSCSI-3"
-  version "WBT", "NinjaSCSI-3", "R1.0"
-  bind "nsp_cs"
-
-card "WorkBit NinjaSCSI-32Bi (16bit)"
-  version "WORKBIT", "UltraNinja-16", "1"
-  bind "nsp_cs"
-
-# OEM
-card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
-  version "IO DATA", "CBSC16       ", "1"
-  bind "nsp_cs"
-
-# OEM
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
-  version "KME    ", "SCSI-CARD-001", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
-  version "KME    ", "SCSI-CARD-002", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
-  version "KME    ", "SCSI-CARD-003", "1"
-  bind "nsp_cs"
-card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
-  version "KME    ", "SCSI-CARD-004", "1"
-  bind "nsp_cs"
--------------------------------------
-
-[7] Start (or restart) pcmcia-cs.
-# /etc/rc.d/rc.pcmcia start        (BSD style)
-or
-# /etc/init.d/pcmcia start         (SYSV style)
+    ::
+
+       device "nsp_cs"
+         class "scsi" module "nsp_cs"
+
+       card "WorkBit NinjaSCSI-3"
+         version "WBT", "NinjaSCSI-3", "R1.0"
+         bind "nsp_cs"
+
+       card "WorkBit NinjaSCSI-32Bi (16bit)"
+         version "WORKBIT", "UltraNinja-16", "1"
+         bind "nsp_cs"
+
+       # OEM
+       card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
+         version "IO DATA", "CBSC16       ", "1"
+         bind "nsp_cs"
+
+       # OEM
+       card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
+         version "KME    ", "SCSI-CARD-001", "1"
+         bind "nsp_cs"
+       card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
+         version "KME    ", "SCSI-CARD-002", "1"
+         bind "nsp_cs"
+       card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
+         version "KME    ", "SCSI-CARD-003", "1"
+         bind "nsp_cs"
+       card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
+         version "KME    ", "SCSI-CARD-004", "1"
+         bind "nsp_cs"
+
+(f) Start (or restart) pcmcia-cs::
+
+       # /etc/rc.d/rc.pcmcia start        (BSD style)
+
+    or::
+
+       # /etc/init.d/pcmcia start         (SYSV style)
 
 
 4. History
+==========
+
 See README.nin_cs .
 
 5. Caution
- If you eject card when doing some operation for your SCSI device or suspend
+==========
+
+If you eject card when doing some operation for your SCSI device or suspend
 your computer, you encount some *BAD* error like disk crash.
- It works good when I using this driver right way. But I'm not guarantee
+
+It works good when I using this driver right way. But I'm not guarantee
 your data. Please backup your data when you use this driver.
 
 6. Known Bugs
- In 2.4 kernel, you can't use 640MB Optical disk. This error comes from
+=============
+
+In 2.4 kernel, you can't use 640MB Optical disk. This error comes from
 high level SCSI driver.
 
 7. Testing
- Please send me some reports(bug reports etc..) of this software.
+==========
+
+Please send me some reports(bug reports etc..) of this software.
 When you send report, please tell me these or more.
-       card name
-       kernel version
-       your SCSI device name(hard drive, CD-ROM, etc...)
+
+       - card name
+       - kernel version
+       - your SCSI device name(hard drive, CD-ROM, etc...)
 
 8. Copyright
+============
+
  See GPL.
 
 
Documentation/scsi/index.rst +1 -0
index a2545efbb407..eb2df0e0dcb7 100644
@@ -28,5 +28,6 @@ Linux SCSI Subsystem
    lpfc
    megaraid
    ncr53c8xx
+   NinjaSCSI
 
    scsi_transport_srp/figures
MAINTAINERS +2 -2
index 6d28bfc72259..2f441cf59b4b 100644
@@ -11861,7 +11861,7 @@ NINJA SCSI-3 / NINJA SCSI-32Bi (16bit/CardBus) PCMCIA SCSI HOST ADAPTER DRIVER
 M:     YOKOTA Hiroshi <[email protected]>
 W:     http://www.netlab.is.tsukuba.ac.jp/~yokota/izumi/ninja/
 S:     Maintained
-F:     Documentation/scsi/NinjaSCSI.txt
+F:     Documentation/scsi/NinjaSCSI.rst
 F:     drivers/scsi/pcmcia/nsp_*
 
 NINJA SCSI-32Bi/UDE PCI/CARDBUS SCSI HOST ADAPTER DRIVER
@@ -11869,7 +11869,7 @@ M:      GOTO Masanori <[email protected]>
 M:     YOKOTA Hiroshi <[email protected]>
 W:     http://www.netlab.is.tsukuba.ac.jp/~yokota/izumi/ninja/
 S:     Maintained
-F:     Documentation/scsi/NinjaSCSI.txt
+F:     Documentation/scsi/NinjaSCSI.rst
 F:     drivers/scsi/nsp32*
 
 NIOS2 ARCHITECTURE
drivers/scsi/pcmcia/Kconfig +1 -2
index dc9b74c9348a..9696b6b5591f 100644
@@ -36,7 +36,7 @@ config PCMCIA_NINJA_SCSI
        help
          If you intend to attach this type of PCMCIA SCSI host adapter to
          your computer, say Y here and read
-         <file:Documentation/scsi/NinjaSCSI.txt>.
+         <file:Documentation/scsi/NinjaSCSI.rst>.
 
          Supported cards:
 
--

2.21.1

#29 lore raw

PATCH 25/42 docs: scsi: convert ppa.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst            |  1 +
 Documentation/scsi/{ppa.txt => ppa.rst} | 12 ++++++++----
 drivers/scsi/Kconfig                    |  4 ++--
 3 files changed, 11 insertions(+), 6 deletions(-)
 rename Documentation/scsi/{ppa.txt => ppa.rst} (32%)
Documentation/scsi/index.rst +1 -0
index eb2df0e0dcb7..17327f67af68 100644
@@ -29,5 +29,6 @@ Linux SCSI Subsystem
    megaraid
    ncr53c8xx
    NinjaSCSI
+   ppa
 
    scsi_transport_srp/figures
Documentation/scsi/ppa.rst renamed from Documentation/scsi/ppa.txt +8 -4
similarity index 32%
rename from Documentation/scsi/ppa.txt
rename to Documentation/scsi/ppa.rst
index 05ff47dbe8d1..5fe3859a6892 100644
@@ -1,13 +1,17 @@
--------- Terse where to get ZIP Drive help info --------
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================
+Terse where to get ZIP Drive help info
+======================================
 
 General Iomega ZIP drive page for Linux:
-http://web.archive.org/web/*/http://www.torque.net/~campbell/
+http://web.archive.org/web/%2E/http://www.torque.net/~campbell/
 
 Driver archive for old drivers:
-http://web.archive.org/web/*/http://www.torque.net/~campbell/ppa
+http://web.archive.org/web/%2E/http://www.torque.net/~campbell/ppa
 
 Linux Parport page (parallel port)
-http://web.archive.org/web/*/http://www.torque.net/parport/
+http://web.archive.org/web/%2E/http://www.torque.net/parport/
 
 Email list for Linux Parport
 [email protected]
drivers/scsi/Kconfig +2 -2
index e47498f7627e..82462d6a4ce5 100644
@@ -804,7 +804,7 @@ config SCSI_PPA
 	  newer drives)", below.
 
 	  For more information about this driver and how to use it you should
-	  read the file <file:Documentation/scsi/ppa.txt>.  You should also read
+	  read the file <file:Documentation/scsi/ppa.rst>.  You should also read
 	  the SCSI-HOWTO, which is available from
 	  <http://www.tldp.org/docs.html#howto>.  If you use this driver,
 	  you will still be able to use the parallel port for other tasks,
@@ -831,7 +831,7 @@ config SCSI_IMM
 	  here and Y to "IOMEGA Parallel Port (ppa - older drives)", above.
 
 	  For more information about this driver and how to use it you should
-	  read the file <file:Documentation/scsi/ppa.txt>.  You should also read
+	  read the file <file:Documentation/scsi/ppa.rst>.  You should also read
 	  the SCSI-HOWTO, which is available from
 	  <http://www.tldp.org/docs.html#howto>.  If you use this driver,
 	  you will still be able to use the parallel port for other tasks,
Signature · 1 line
2.21.1
#30 lore raw

PATCH 26/42 docs: scsi: convert qlogicfas.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                    |  1 +
 .../scsi/{qlogicfas.txt => qlogicfas.rst}       | 17 +++++++++++++----
 drivers/scsi/Kconfig                            |  2 +-
 3 files changed, 15 insertions(+), 5 deletions(-)
 rename Documentation/scsi/{qlogicfas.txt => qlogicfas.rst} (92%)
Documentation/scsi/index.rst +1 -0
index 17327f67af68..29e211ee9145 100644
@@ -30,5 +30,6 @@ Linux SCSI Subsystem
    ncr53c8xx
    NinjaSCSI
    ppa
+   qlogicfas
 
    scsi_transport_srp/figures
Documentation/scsi/qlogicfas.rst renamed from Documentation/scsi/qlogicfas.txt +13 -4
similarity index 92%
rename from Documentation/scsi/qlogicfas.txt
rename to Documentation/scsi/qlogicfas.rst
index c211d827fef2..b17f1b3676c3 100644
@@ -1,3 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
+Qlogic FASXXX Family Driver Notes
+=================================
 
 This driver supports the Qlogic FASXXX family of chips.  This driver
 only works with the ISA, VLB, and PCMCIA versions of the Qlogic
@@ -16,7 +21,8 @@ is provided by the qla1280 driver.
 Nor does it support the PCI-Basic, which is supported by the
 'am53c974' driver.
 
-PCMCIA SUPPORT
+PCMCIA Support
+==============
 
 This currently only works if the card is enabled first from DOS.  This
 means you will have to load your socket and card services, and
@@ -31,7 +37,8 @@ it from configuring the card.
 I am working with the PCMCIA group to make it more flexible, but that
 may take a while.
 
-ALL CARDS
+All Cards
+=========
 
 The top of the qlogic.c file has a number of defines that controls
 configuration.  As shipped, it provides a balance between speed and
@@ -46,7 +53,8 @@ command or something.  It comes up faster if this is set to zero, and
 if you have reliable hardware and connections it may be more useful to
 not reset things.
 
-SOME TROUBLESHOOTING TIPS
+Some Troubleshooting Tips
+=========================
 
 Make sure it works properly under DOS.  You should also do an initial FDISK
 on a new drive if you want partitions.
@@ -54,7 +62,8 @@ on a new drive if you want partitions.
 Don't enable all the speedups first.  If anything is wrong, they will make
 any problem worse.
 
-IMPORTANT
+Important
+=========
 
 The best way to test if your cables, termination, etc. are good is to
 copy a very big file (e.g. a doublespace container file, or a very
drivers/scsi/Kconfig +1 -1
index 82462d6a4ce5..d34c682e94cf 100644
@@ -1117,7 +1117,7 @@ config SCSI_QLOGIC_FAS
 	  SCSI support"), below.
 
 	  Information about this driver is contained in
-	  <file:Documentation/scsi/qlogicfas.txt>.  You should also read the
+	  <file:Documentation/scsi/qlogicfas.rst>.  You should also read the
 	  SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>.
 
Signature · 1 line
2.21.1
#31 lore raw

PATCH 27/42 docs: scsi: convert scsi-changer.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 .../{scsi-changer.txt => scsi-changer.rst}    | 36 ++++++++++---------
 drivers/scsi/Kconfig                          |  2 +-
 3 files changed, 22 insertions(+), 17 deletions(-)
 rename Documentation/scsi/{scsi-changer.txt => scsi-changer.rst} (87%)
Documentation/scsi/index.rst +1 -0
index 29e211ee9145..635a3b3c5e90 100644
@@ -31,5 +31,6 @@ Linux SCSI Subsystem
    NinjaSCSI
    ppa
    qlogicfas
+   scsi-changer
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-changer.rst renamed from Documentation/scsi/scsi-changer.txt +20 -16
similarity index 87%
rename from Documentation/scsi/scsi-changer.txt
rename to Documentation/scsi/scsi-changer.rst
index ade046ea7c17..ab60e7e61a6c 100644
@@ -1,4 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
 
+========================================
 README for the SCSI media changer driver
 ========================================
 
@@ -28,15 +30,17 @@ The SCSI changer model is complex, compared to - for example - IDE-CD
 changers. But it allows to handle nearly all possible cases. It knows
 4 different types of changer elements:
 
-  media transport - this one shuffles around the media, i.e. the
+  ===============   ==================================================
+  media transport   this one shuffles around the media, i.e. the
                     transport arm.  Also known as "picker".
-  storage         - a slot which can hold a media.
-  import/export   - the same as above, but is accessible from outside,
+  storage           a slot which can hold a media.
+  import/export     the same as above, but is accessible from outside,
                     i.e. there the operator (you !) can use this to
                     fill in and remove media from the changer.
 		    Sometimes named "mailslot".
-  data transfer   - this is the device which reads/writes, i.e. the
+  data transfer     this is the device which reads/writes, i.e. the
 		    CD-ROM / Tape / whatever drive.
+  ===============   ==================================================
 
 None of these is limited to one: A huge Jukebox could have slots for
 123 CD-ROM's, 5 CD-ROM readers (and therefore 6 SCSI ID's: the changer
@@ -131,24 +135,23 @@ timeout_init=<seconds>
 timeout_move=<seconds>
 	timeout for all other commands (default: 120).
 
-dt_id=<id1>,<id2>,...
-dt_lun=<lun1>,<lun2>,...
+dt_id=<id1>,<id2>,... / dt_lun=<lun1>,<lun2>,...
 	These two allow to specify the SCSI ID and LUN for the data
 	transfer elements.  You likely don't need this as the jukebox
 	should provide this information.  But some devices don't ...
 
-vendor_firsts=
-vendor_counts=
-vendor_labels=
+vendor_firsts=, vendor_counts=, vendor_labels=
 	These insmod options can be used to tell the driver that there
 	are some vendor-specific element types.  Grundig for example
 	does this.  Some jukeboxes have a printer to label fresh burned
 	CDs, which is addressed as element 0xc000 (type 5).  To tell the
-	driver about this vendor-specific element, use this:
+	driver about this vendor-specific element, use this::
+
 		$ insmod ch			\
 			vendor_firsts=0xc000	\
 			vendor_counts=1		\
 			vendor_labels=printer
+
 	All three insmod options accept up to four comma-separated
 	values, this way you can configure the element types 5-8.
 	You likely need the SCSI specs for the device in question to
@@ -162,13 +165,15 @@ Credits
 I wrote this driver using the famous mailing-patches-around-the-world
 method.  With (more or less) help from:
 
-	Daniel Moehwald <[email protected]>
-	Dane Jasper <[email protected]>
-	R. Scott Bailey <[email protected]>
-	Jonathan Corbet <[email protected]>
+	- Daniel Moehwald <[email protected]>
+	- Dane Jasper <[email protected]>
+	- R. Scott Bailey <[email protected]>
+	- Jonathan Corbet <[email protected]>
 
 Special thanks go to
-	Martin Kuehne <[email protected]>
+
+	- Martin Kuehne <[email protected]>
+
 for a old, second-hand (but full functional) cdrom jukebox which I use
 to develop/test driver and tools now.
 
@@ -176,5 +181,4 @@ Have fun,
 
    Gerd
 
--- 
 Gerd Knorr <[email protected]>
drivers/scsi/Kconfig +1 -1
index d34c682e94cf..6cb9abb0898d 100644
@@ -149,7 +149,7 @@ config CHR_DEV_SCH
 	  don't need this for those tiny 6-slot cdrom changers.  Media
 	  changers are listed as "Type: Medium Changer" in /proc/scsi/scsi.
 	  If you have such hardware and want to use it with linux, say Y
-	  here.  Check <file:Documentation/scsi/scsi-changer.txt> for details.
+	  here.  Check <file:Documentation/scsi/scsi-changer.rst> for details.
 	
 	  If you want to compile this as a module ( = code which can be
 	  inserted in and removed from the running kernel whenever you want),
Signature · 1 line
2.21.1
#32 lore raw

PATCH 28/42 docs: scsi: convert scsi_eh.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/driver-api/libata.rst           |   2 +-
 Documentation/scsi/index.rst                  |   1 +
 .../scsi/{scsi_eh.txt => scsi_eh.rst}         | 215 ++++++++++--------
 3 files changed, 128 insertions(+), 90 deletions(-)
 rename Documentation/scsi/{scsi_eh.txt => scsi_eh.rst} (73%)
Documentation/driver-api/libata.rst +1 -1
index 207f0d24de69..e2f87b82b074 100644
@@ -401,7 +401,7 @@ Error handling
 ==============
 
 This chapter describes how errors are handled under libata. Readers are
-advised to read SCSI EH (Documentation/scsi/scsi_eh.txt) and ATA
+advised to read SCSI EH (Documentation/scsi/scsi_eh.rst) and ATA
 exceptions doc first.
 
 Origins of commands
Documentation/scsi/index.rst +1 -0
index 635a3b3c5e90..8da7c27f73b7 100644
@@ -32,5 +32,6 @@ Linux SCSI Subsystem
    ppa
    qlogicfas
    scsi-changer
+   scsi_eh
 
    scsi_transport_srp/figures
Documentation/scsi/scsi_eh.rst renamed from Documentation/scsi/scsi_eh.txt +126 -89

452 lines not on this page · raw message

Signature · 1 line
2.21.1
#33 lore raw

PATCH 29/42 docs: scsi: convert scsi_fc_transport.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |   1 +
 ...fc_transport.txt => scsi_fc_transport.rst} | 236 +++++++++++-------
 2 files changed, 151 insertions(+), 86 deletions(-)
 rename Documentation/scsi/{scsi_fc_transport.txt => scsi_fc_transport.rst} (74%)
Documentation/scsi/index.rst +1 -0
index 8da7c27f73b7..471982ef461d 100644
@@ -33,5 +33,6 @@ Linux SCSI Subsystem
    qlogicfas
    scsi-changer
    scsi_eh
+   scsi_fc_transport
 
    scsi_transport_srp/figures
Documentation/scsi/scsi_fc_transport.rst renamed from Documentation/scsi/scsi_fc_transport.txt +150 -86

401 lines not on this page · raw message

Signature · 1 line
2.21.1
#34 lore raw

PATCH 30/42 docs: scsi: convert scsi-generic.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 .../{scsi-generic.txt => scsi-generic.rst}    | 75 ++++++++++++-------
 MAINTAINERS                                   |  2 +-
 drivers/scsi/Kconfig                          |  2 +-
 include/scsi/sg.h                             |  2 +-
 5 files changed, 50 insertions(+), 32 deletions(-)
 rename Documentation/scsi/{scsi-generic.txt => scsi-generic.rst} (70%)
Documentation/scsi/index.rst +1 -0
index 471982ef461d..119280f26da6 100644
@@ -34,5 +34,6 @@ Linux SCSI Subsystem
    scsi-changer
    scsi_eh
    scsi_fc_transport
+   scsi-generic
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-generic.rst renamed from Documentation/scsi/scsi-generic.txt +46 -29

124 lines not on this page · raw message

MAINTAINERS +1 -1
index 2f441cf59b4b..776de9c5b404 100644
@@ -14857,7 +14857,7 @@ M:	Doug Gilbert <[email protected]>
 L:	[email protected]
 W:	http://sg.danny.cz/sg
 S:	Maintained
-F:	Documentation/scsi/scsi-generic.txt
+F:	Documentation/scsi/scsi-generic.rst
 F:	drivers/scsi/sg.c
 F:	include/scsi/sg.h
 
drivers/scsi/Kconfig +1 -1
index 6cb9abb0898d..bdf65b0bb78b 100644
@@ -133,7 +133,7 @@ config CHR_DEV_SG
 	  quality digital reader of audio CDs (<http://www.xiph.org/paranoia/>).
 	  For other devices, it's possible that you'll have to write the
 	  driver software yourself. Please read the file
-	  <file:Documentation/scsi/scsi-generic.txt> for more information.
+	  <file:Documentation/scsi/scsi-generic.rst> for more information.
 
 	  To compile this driver as a module, choose M here and read
 	  <file:Documentation/scsi/scsi.txt>. The module will be called sg.
include/scsi/sg.h +1 -1
index 29c7ad04d2e2..7327e12f3373 100644
@@ -24,7 +24,7 @@
  *	http://sg.danny.cz/sg  [alternatively check the MAINTAINERS file]
  * The documentation for the sg version 3 driver can be found at:
  *	http://sg.danny.cz/sg/p/sg_v3_ho.html
- * Also see: <kernel_source>/Documentation/scsi/scsi-generic.txt
+ * Also see: <kernel_source>/Documentation/scsi/scsi-generic.rst
  *
  * For utility and test programs see: http://sg.danny.cz/sg/sg3_utils.html
  */
Signature · 1 line
2.21.1
#35 lore raw

PATCH 31/42 docs: scsi: convert scsi_mid_low_api.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |    1 +
 Documentation/scsi/scsi_eh.rst                |    2 +-
 ...i_mid_low_api.txt => scsi_mid_low_api.rst} | 1730 +++++++++--------
 scripts/documentation-file-ref-check          |    2 +-
 4 files changed, 895 insertions(+), 840 deletions(-)
 rename Documentation/scsi/{scsi_mid_low_api.txt => scsi_mid_low_api.rst} (39%)
Documentation/scsi/index.rst +1 -0
index 119280f26da6..48337be1c3f1 100644
@@ -35,5 +35,6 @@ Linux SCSI Subsystem
    scsi_eh
    scsi_fc_transport
    scsi-generic
+   scsi_mid_low_api
 
    scsi_transport_srp/figures
Documentation/scsi/scsi_eh.rst +1 -1
index 341f22f35056..7d78c2475615 100644
@@ -5,7 +5,7 @@ SCSI EH
 =======
 
 This document describes SCSI midlayer error handling infrastructure.
-Please refer to Documentation/scsi/scsi_mid_low_api.txt for more
+Please refer to Documentation/scsi/scsi_mid_low_api.rst for more
 information regarding SCSI midlayer.
 
 .. TABLE OF CONTENTS
Documentation/scsi/scsi_mid_low_api.rst renamed from Documentation/scsi/scsi_mid_low_api.txt +892 -838

2,016 lines not on this page · raw message

scripts/documentation-file-ref-check +1 -1
index 997202a18ddb..9a8cc10cffd0 100755
@@ -12,7 +12,7 @@ use Getopt::Long qw(:config no_auto_abbrev);
 # to mention a past documentation file, for example, to give credits for
 # the original work.
 my %false_positives = (
-	"Documentation/scsi/scsi_mid_low_api.txt" => "Documentation/Configure.help",
+	"Documentation/scsi/scsi_mid_low_api.rst" => "Documentation/Configure.help",
 	"drivers/vhost/vhost.c" => "Documentation/virtual/lguest/lguest.c",
 );
 
Signature · 1 line
2.21.1
#36 lore raw

Re: [PATCH 31/42] docs: scsi: convert scsi_mid_low_api.txt to ReST

Quoted 6 lines · Mauro Carvalho Chehab
Documentation/scsi/scsi_mid_low_api.rst renamed from Documentation/scsi/scsi_mid_low_api.txt +6 -0
+			slave_alloc()
+			slave_configure()
+			    |
+			slave_alloc()   ***
+			slave_destroy() ***
+

Documentation/scsi/scsi_mid_low_api.rst aware of an LLD when that LLD registers its first HBA. · line 164

Quoted 10 lines
Documentation/scsi/scsi_mid_low_api.rst renamed from Documentation/scsi/scsi_mid_low_api.txt +3 -3
+
+    *** For scsi devices that the mid level tries to scan but do not
+	respond, a slave_alloc(), slave_destroy() pair is called.
 
 If the LLD wants to adjust the default queue settings, it can invoke
 scsi_change_queue_depth() in its slave_configure() routine.
 
-*** For scsi devices that the mid level tries to scan but do not
-    respond, a slave_alloc(), slave_destroy() pair is called.
-

Elsewhere in this series you have replaced asterisks with footnotes, as in [#]. Was that overlooked here?

BTW, certain patches in this series produce warnings from 'git am', that is, 'space before tab in indent'. Most of that whitespace appears to be intentional (for table formatting) or is pre-existing, but some seems to have been accidentally added...

$ git diff @~42.. | grep $'^[+].*\x20\x09'

Also, some of the patches in this series, like this one, were not Cc'd to the linux-scsi mailing list.

#37 lore raw

Re: [PATCH 31/42] docs: scsi: convert scsi_mid_low_api.txt to ReST

In reply to Mauro Carvalho Chehab

Much of this file just duplicates the kerneldoc comments in the source files. IF you convert it to rest it should reference those instead of duplicating them.

Then again I'm not sure this file is useful at all any more..

#38 lore raw

PATCH 32/42 docs: scsi: convert scsi-parameters.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                         |  1 +
 .../{scsi-parameters.txt => scsi-parameters.rst}     | 12 ++++++++----
 2 files changed, 9 insertions(+), 4 deletions(-)
 rename Documentation/scsi/{scsi-parameters.txt => scsi-parameters.rst} (91%)
Documentation/scsi/index.rst +1 -0
index 48337be1c3f1..4bf0bb26f3d5 100644
@@ -36,5 +36,6 @@ Linux SCSI Subsystem
    scsi_fc_transport
    scsi-generic
    scsi_mid_low_api
+   scsi-parameters
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.rst renamed from Documentation/scsi/scsi-parameters.txt +8 -4
similarity index 91%
rename from Documentation/scsi/scsi-parameters.txt
rename to Documentation/scsi/scsi-parameters.rst
index 864bbf7f737b..0c4bbb1aee94 100644
@@ -1,16 +1,20 @@
-                          SCSI Kernel Parameters
-                          ~~~~~~~~~~~~~~~~~~~~~~
+.. SPDX-License-Identifier: GPL-2.0
+
+======================
+SCSI Kernel Parameters
+======================
 
 See Documentation/admin-guide/kernel-parameters.rst for general information on
 specifying module parameters.
 
 This document may not be entirely up to date and comprehensive. The command
-"modinfo -p ${modulename}" shows a current list of all parameters of a loadable
+``modinfo -p ${modulename}`` shows a current list of all parameters of a loadable
 module. Loadable modules, after being loaded into the running kernel, also
 reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
 parameters may be changed at runtime by the command
-"echo -n ${value} > /sys/module/${modulename}/parameters/${parm}".
+``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
 
+::
 
 	advansys=	[HW,SCSI]
 			See header of drivers/scsi/advansys.c.
Signature · 1 line
2.21.1
#39 lore raw

PATCH 33/42 docs: scsi: convert scsi.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst              |  1 +
 Documentation/scsi/{scsi.txt => scsi.rst} | 31 +++++++++++++----------
 drivers/scsi/Kconfig                      | 16 ++++++------
 3 files changed, 26 insertions(+), 22 deletions(-)
 rename Documentation/scsi/{scsi.txt => scsi.rst} (82%)
Documentation/scsi/index.rst +1 -0
index 4bf0bb26f3d5..97276e425f25 100644
@@ -37,5 +37,6 @@ Linux SCSI Subsystem
    scsi-generic
    scsi_mid_low_api
    scsi-parameters
+   scsi
 
    scsi_transport_srp/figures
Documentation/scsi/scsi.rst renamed from Documentation/scsi/scsi.txt +17 -14
similarity index 82%
rename from Documentation/scsi/scsi.txt
rename to Documentation/scsi/scsi.rst
index 3d99d38cb62a..276918eb4d74 100644
@@ -1,44 +1,47 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============================
 SCSI subsystem documentation
 ============================
+
 The Linux Documentation Project (LDP) maintains a document describing
 the SCSI subsystem in the Linux kernel (lk) 2.4 series. See:
 http://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single
 and multiple page HTML renderings as well as postscript and pdf.
 It can also be found at:
-http://web.archive.org/web/*/http://www.torque.net/scsi/SCSI-2.4-HOWTO
+http://web.archive.org/web/%2E/http://www.torque.net/scsi/SCSI-2.4-HOWTO
 
 Notes on using modules in the SCSI subsystem
 ============================================
-The scsi support in the linux kernel can be modularized in a number of 
+The scsi support in the linux kernel can be modularized in a number of
 different ways depending upon the needs of the end user.  To understand
 your options, we should first define a few terms.
 
-The scsi-core (also known as the "mid level") contains the core of scsi 
+The scsi-core (also known as the "mid level") contains the core of scsi
 support.  Without it you can do nothing with any of the other scsi drivers.
 The scsi core support can be a module (scsi_mod.o), or it can be built into
-the kernel. If the core is a module, it must be the first scsi module 
-loaded, and if you unload the modules, it will have to be the last one 
+the kernel. If the core is a module, it must be the first scsi module
+loaded, and if you unload the modules, it will have to be the last one
 unloaded.  In practice the modprobe and rmmod commands (and "autoclean")
 will enforce the correct ordering of loading and unloading modules in
 the SCSI subsystem.
 
-The individual upper and lower level drivers can be loaded in any order 
+The individual upper and lower level drivers can be loaded in any order
 once the scsi core is present in the kernel (either compiled in or loaded
 as a module).  The disk driver (sd_mod.o), cdrom driver (sr_mod.o),
-tape driver ** (st.o) and scsi generics driver (sg.o) represent the upper 
-level drivers to support the various assorted devices which can be 
-controlled.  You can for example load the tape driver to use the tape drive, 
+tape driver [1]_ (st.o) and scsi generics driver (sg.o) represent the upper
+level drivers to support the various assorted devices which can be
+controlled.  You can for example load the tape driver to use the tape drive,
 and then unload it once you have no further need for the driver (and release
 the associated memory).
 
 The lower level drivers are the ones that support the individual cards that
 are supported for the hardware platform that you are running under. Those
 individual cards are often called Host Bus Adapters (HBAs). For example the
-aic7xxx.o driver is used to control all recent SCSI controller cards from 
-Adaptec. Almost all lower level drivers can be built either as modules or 
+aic7xxx.o driver is used to control all recent SCSI controller cards from
+Adaptec. Almost all lower level drivers can be built either as modules or
 built into the kernel.
 
-
-** There is a variant of the st driver for controlling OnStream tape
-   devices. Its module name is osst.o .
+.. [1] There is a variant of the st driver for controlling OnStream tape
+       devices. Its module name is osst.o .
 
drivers/scsi/Kconfig +8 -8
index bdf65b0bb78b..c705e2b951a4 100644
@@ -33,7 +33,7 @@ config SCSI
 	  Channel, and FireWire storage.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>.
+	  <file:Documentation/scsi/scsi.rst>.
 	  The module will be called scsi_mod.
 
 	  However, do not compile this as a module if your root file system
@@ -79,7 +79,7 @@ config BLK_DEV_SD
 	  CD-ROMs.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>.
+	  <file:Documentation/scsi/scsi.rst>.
 	  The module will be called sd_mod.
 
 	  Do not compile this driver as a module if your root file system
@@ -98,7 +98,7 @@ config CHR_DEV_ST
 	  for SCSI CD-ROMs.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>. The module will be called st.
+	  <file:Documentation/scsi/scsi.rst>. The module will be called st.
 
 config BLK_DEV_SR
 	tristate "SCSI CDROM support"
@@ -112,7 +112,7 @@ config BLK_DEV_SR
 	  Make sure to say Y or M to "ISO 9660 CD-ROM file system support".
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>.
+	  <file:Documentation/scsi/scsi.rst>.
 	  The module will be called sr_mod.
 
 config CHR_DEV_SG
@@ -136,7 +136,7 @@ config CHR_DEV_SG
 	  <file:Documentation/scsi/scsi-generic.rst> for more information.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>. The module will be called sg.
+	  <file:Documentation/scsi/scsi.rst>. The module will be called sg.
 
 	  If unsure, say N.
 
@@ -154,7 +154,7 @@ config CHR_DEV_SCH
 	  If you want to compile this as a module ( = code which can be
 	  inserted in and removed from the running kernel whenever you want),
 	  say M here and read <file:Documentation/kbuild/modules.rst> and
-	  <file:Documentation/scsi/scsi.txt>. The module will be called ch.o.
+	  <file:Documentation/scsi/scsi.rst>. The module will be called ch.o.
 	  If unsure, say N.
 
 config SCSI_ENCLOSURE
@@ -604,7 +604,7 @@ config FCOE_FNIC
 	  This is support for the Cisco PCI-Express FCoE HBA.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>.
+	  <file:Documentation/scsi/scsi.rst>.
 	  The module will be called fnic.
 
 config SCSI_SNIC
@@ -614,7 +614,7 @@ config SCSI_SNIC
 	  This is support for the Cisco PCI-Express SCSI HBA.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/scsi.txt>.
+	  <file:Documentation/scsi/scsi.rst>.
 	  The module will be called snic.
 
 config SCSI_SNIC_DEBUG_FS
Signature · 1 line
2.21.1
#40 lore raw

PATCH 34/42 docs: scsi: convert sd-parameters.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 .../{sd-parameters.txt => sd-parameters.rst}  | 21 ++++++++++++-------
 2 files changed, 14 insertions(+), 8 deletions(-)
 rename Documentation/scsi/{sd-parameters.txt => sd-parameters.rst} (37%)
Documentation/scsi/index.rst +1 -0
index 97276e425f25..6805e157b6e8 100644
@@ -38,5 +38,6 @@ Linux SCSI Subsystem
    scsi_mid_low_api
    scsi-parameters
    scsi
+   sd-parameters
 
    scsi_transport_srp/figures
Documentation/scsi/sd-parameters.rst renamed from Documentation/scsi/sd-parameters.txt +13 -8
similarity index 37%
rename from Documentation/scsi/sd-parameters.txt
rename to Documentation/scsi/sd-parameters.rst
index 8e5af00d88e7..87d554008bfb 100644
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================
 Linux SCSI Disk Driver (sd) Parameters
 ======================================
 
@@ -5,18 +8,20 @@ cache_type (RW)
 ---------------
 Enable/disable drive write & read cache.
 
- cache_type string          | WCE RCD | Write cache | Read cache
-----------------------------+---------+-------------+------------
- write through              | 0   0   | off         | on
- none                       | 0   1   | off         | off
- write back                 | 1   0   | on          | on
- write back, no read (daft) | 1   1   | on          | off
+===========================   === ===   ===========   ==========
+ cache_type string            WCE RCD   Write cache   Read cache
+===========================   === ===   ===========   ==========
+ write through                0   0     off           on
+ none                         0   1     off           off
+ write back                   1   0     on            on
+ write back, no read (daft)   1   1     on            off
+===========================   === ===   ===========   ==========
 
-To set cache type to "write back" and save this setting to the drive:
+To set cache type to "write back" and save this setting to the drive::
 
   # echo "write back" > cache_type
 
 To modify the caching mode without making the change persistent, prepend
-"temporary " to the cache type string. E.g.:
+"temporary " to the cache type string. E.g.::
 
   # echo "temporary write back" > cache_type
Signature · 1 line
2.21.1
#41 lore raw

PATCH 35/42 docs: scsi: convert smartpqi.txt to ReST

In reply to Mauro Carvalho Chehab
---
 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%)
Documentation/scsi/index.rst +1 -0
index 6805e157b6e8..ff98919faed7 100644
@@ -39,5 +39,6 @@ Linux SCSI Subsystem
    scsi-parameters
    scsi
    sd-parameters
+   smartpqi
 
    scsi_transport_srp/figures
Documentation/scsi/smartpqi.rst renamed from Documentation/scsi/smartpqi.txt +25 -27

94 lines not on this page · raw message

MAINTAINERS +1 -1
index 776de9c5b404..f27c24d82c0f 100644
@@ -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 <[email protected]>
drivers/scsi/smartpqi/Kconfig +1 -1
index bc6506884e3b..d3311c014863 100644
@@ -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
Signature · 1 line
2.21.1
#42 lore raw

PATCH 36/42 docs: scsi: convert st.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst           |   1 +
 Documentation/scsi/scsi-parameters.rst |   4 +-
 Documentation/scsi/{st.txt => st.rst}  | 301 ++++++++++++++++---------
 MAINTAINERS                            |   2 +-
 drivers/scsi/Kconfig                   |   2 +-
 drivers/scsi/st.c                      |   2 +-
 6 files changed, 197 insertions(+), 115 deletions(-)
 rename Documentation/scsi/{st.txt => st.rst} (79%)
Documentation/scsi/index.rst +1 -0
index ff98919faed7..0cc2cfca7474 100644
@@ -40,5 +40,6 @@ Linux SCSI Subsystem
    scsi
    sd-parameters
    smartpqi
+   st
 
    scsi_transport_srp/figures
Documentation/scsi/scsi-parameters.rst +2 -2
index 0c4bbb1aee94..9aba897c97ac 100644
@@ -73,7 +73,7 @@ parameters may be changed at runtime by the command
 
 	osst=		[HW,SCSI] SCSI Tape Driver
 			Format: <buffer_size>,<write_threshold>
-			See also Documentation/scsi/st.txt.
+			See also Documentation/scsi/st.rst.
 
 	scsi_debug_*=	[SCSI]
 			See drivers/scsi/scsi_debug.c.
@@ -105,7 +105,7 @@ parameters may be changed at runtime by the command
 			See header of drivers/scsi/sim710.c.
 
 	st=		[HW,SCSI] SCSI tape parameters (buffers, etc.)
-			See Documentation/scsi/st.txt.
+			See Documentation/scsi/st.rst.
 
 	wd33c93=	[HW,SCSI]
 			See header of drivers/scsi/wd33c93.c.
Documentation/scsi/st.rst renamed from Documentation/scsi/st.txt +191 -110

534 lines not on this page · raw message

MAINTAINERS +1 -1
index f27c24d82c0f..a3bfe6813e5e 100644
@@ -14877,7 +14877,7 @@ SCSI TAPE DRIVER
 M:	Kai Mäkisara <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/scsi/st.txt
+F:	Documentation/scsi/st.rst
 F:	drivers/scsi/st.*
 F:	drivers/scsi/st_*.h
 
drivers/scsi/Kconfig +1 -1
index c705e2b951a4..5bde34020b3a 100644
@@ -94,7 +94,7 @@ config CHR_DEV_ST
 	  If you want to use a SCSI tape drive under Linux, say Y and read the
 	  SCSI-HOWTO, available from
 	  <http://www.tldp.org/docs.html#howto>, and
-	  <file:Documentation/scsi/st.txt> in the kernel source.  This is NOT
+	  <file:Documentation/scsi/st.rst> in the kernel source.  This is NOT
 	  for SCSI CD-ROMs.
 
 	  To compile this driver as a module, choose M here and read
drivers/scsi/st.c +1 -1
index 393f3019ccac..2cff8a7349a7 100644
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0-only
 /*
    SCSI Tape Driver for Linux version 1.1 and newer. See the accompanying
-   file Documentation/scsi/st.txt for more information.
+   file Documentation/scsi/st.rst for more information.
 
    History:
    Rewritten from Dwayne Forsyth's SCSI tape driver by Kai Makisara.
Signature · 1 line
2.21.1
#43 lore raw

PATCH 37/42 docs: scsi: convert sym53c500_cs.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                              | 1 +
 Documentation/scsi/{sym53c500_cs.txt => sym53c500_cs.rst} | 8 +++++++-
 2 files changed, 8 insertions(+), 1 deletion(-)
 rename Documentation/scsi/{sym53c500_cs.txt => sym53c500_cs.rst} (89%)
Documentation/scsi/index.rst +1 -0
index 0cc2cfca7474..00584fb0588c 100644
@@ -41,5 +41,6 @@ Linux SCSI Subsystem
    sd-parameters
    smartpqi
    st
+   sym53c500_cs
 
    scsi_transport_srp/figures
Documentation/scsi/sym53c500_cs.rst renamed from Documentation/scsi/sym53c500_cs.txt +7 -1
similarity index 89%
rename from Documentation/scsi/sym53c500_cs.txt
rename to Documentation/scsi/sym53c500_cs.rst
index 75febcf9298c..55464861bbd5 100644
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================
+The sym53c500_cs Driver
+=======================
+
 The sym53c500_cs driver originated as an add-on to David Hinds' pcmcia-cs
 package, and was written by Tom Corner ([email protected]).  A rewrite was
 long overdue, and the current version addresses the following concerns:
@@ -20,4 +26,4 @@ Through the years, there have been a number of downloads of the pcmcia-cs
 version of this driver, and I guess it worked for those users.  It worked
 for Tom Corner, and it works for me.  Your mileage will probably vary.
 
---Bob Tracy ([email protected])
+Bob Tracy ([email protected])
Signature · 1 line
2.21.1
#44 lore raw

PATCH 38/42 docs: scsi: convert sym53c8xx_2.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |    1 +
 .../scsi/{sym53c8xx_2.txt => sym53c8xx_2.rst} | 1109 ++++++++++-------
 drivers/scsi/Kconfig                          |    2 +-
 3 files changed, 637 insertions(+), 475 deletions(-)
 rename Documentation/scsi/{sym53c8xx_2.txt => sym53c8xx_2.rst} (53%)
Documentation/scsi/index.rst +1 -0
index 00584fb0588c..238dd0ac36a6 100644
@@ -42,5 +42,6 @@ Linux SCSI Subsystem
    smartpqi
    st
    sym53c500_cs
+   sym53c8xx_2
 
    scsi_transport_srp/figures
Documentation/scsi/sym53c8xx_2.rst renamed from Documentation/scsi/sym53c8xx_2.txt +635 -474

1,585 lines not on this page · raw message

drivers/scsi/Kconfig +1 -1
index 5bde34020b3a..b5be6f43ec3f 100644
@@ -921,7 +921,7 @@ config SCSI_SYM53C8XX_2
 	  language.  It does not support LSI53C10XX Ultra-320 PCI-X SCSI
 	  controllers; you need to use the Fusion MPT driver for that.
 
-	  Please read <file:Documentation/scsi/sym53c8xx_2.txt> for more
+	  Please read <file:Documentation/scsi/sym53c8xx_2.rst> for more
 	  information.
 
 config SCSI_SYM53C8XX_DMA_ADDRESSING_MODE
Signature · 1 line
2.21.1
#45 lore raw

PATCH 39/42 docs: scsi: convert tcm_qla2xxx.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 .../scsi/{tcm_qla2xxx.txt => tcm_qla2xxx.rst} | 26 ++++++++++++++-----
 2 files changed, 21 insertions(+), 6 deletions(-)
 rename Documentation/scsi/{tcm_qla2xxx.txt => tcm_qla2xxx.rst} (57%)
Documentation/scsi/index.rst +1 -0
index 238dd0ac36a6..df005cb94f6b 100644
@@ -43,5 +43,6 @@ Linux SCSI Subsystem
    st
    sym53c500_cs
    sym53c8xx_2
+   tcm_qla2xxx
 
    scsi_transport_srp/figures
Documentation/scsi/tcm_qla2xxx.rst renamed from Documentation/scsi/tcm_qla2xxx.txt +20 -6
similarity index 57%
rename from Documentation/scsi/tcm_qla2xxx.txt
rename to Documentation/scsi/tcm_qla2xxx.rst
index c3a670a25e2b..91bc1fcd369e 100644
@@ -1,22 +1,36 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+========================
+tcm_qla2xxx Driver Notes
+========================
+
 tcm_qla2xxx jam_host attribute
 ------------------------------
 There is now a new module endpoint atribute called jam_host
-attribute: jam_host: boolean=0/1
+attribute::
+
+	jam_host: boolean=0/1
+
 This attribute and accompanying code is only included if the
 Kconfig parameter TCM_QLA2XXX_DEBUG is set to Y
+
 By default this jammer code and functionality is disabled
 
 Use this attribute to control the discarding of SCSI commands to a
 selected host.
+
 This may be useful for testing error handling and simulating slow drain
 and other fabric issues.
 
 Setting a boolean of 1 for the jam_host attribute for a particular host
- will discard the commands for that host.
+will discard the commands for that host.
+
 Reset back to 0 to stop the jamming.
 
-Enable host 4 to be jammed
-echo 1 > /sys/kernel/config/target/qla2xxx/21:00:00:24:ff:27:8f:ae/tpgt_1/attrib/jam_host
+Enable host 4 to be jammed::
 
-Disable jamming on host 4
-echo 0 > /sys/kernel/config/target/qla2xxx/21:00:00:24:ff:27:8f:ae/tpgt_1/attrib/jam_host
+  echo 1 > /sys/kernel/config/target/qla2xxx/21:00:00:24:ff:27:8f:ae/tpgt_1/attrib/jam_host
+
+Disable jamming on host 4::
+
+  echo 0 > /sys/kernel/config/target/qla2xxx/21:00:00:24:ff:27:8f:ae/tpgt_1/attrib/jam_host
Signature · 1 line
2.21.1
#46 lore raw

PATCH 40/42 docs: scsi: convert ufs.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst            |  1 +
 Documentation/scsi/{ufs.txt => ufs.rst} | 84 ++++++++++++++++---------
 MAINTAINERS                             |  2 +-
 drivers/scsi/ufs/Kconfig                |  2 +-
 4 files changed, 57 insertions(+), 32 deletions(-)
 rename Documentation/scsi/{ufs.txt => ufs.rst} (79%)
Documentation/scsi/index.rst +1 -0
index df005cb94f6b..27720d145eff 100644
@@ -44,5 +44,6 @@ Linux SCSI Subsystem
    sym53c500_cs
    sym53c8xx_2
    tcm_qla2xxx
+   ufs
 
    scsi_transport_srp/figures
Documentation/scsi/ufs.rst renamed from Documentation/scsi/ufs.txt +54 -30

186 lines not on this page · raw message

MAINTAINERS +1 -1
index a3bfe6813e5e..9ac2a10ca41f 100644
@@ -17204,7 +17204,7 @@ R:	Alim Akhtar <[email protected]>
 R:	Avri Altman <[email protected]>
 L:	[email protected]
 S:	Supported
-F:	Documentation/scsi/ufs.txt
+F:	Documentation/scsi/ufs.rst
 F:	drivers/scsi/ufs/
 
 UNIVERSAL FLASH STORAGE HOST CONTROLLER DRIVER DWC HOOKS
drivers/scsi/ufs/Kconfig +1 -1
index d14c2243e02a..e2005aeddc2d 100644
@@ -46,7 +46,7 @@ config SCSI_UFSHCD
 	  The module will be called ufshcd.
 
 	  To compile this driver as a module, choose M here and read
-	  <file:Documentation/scsi/ufs.txt>.
+	  <file:Documentation/scsi/ufs.rst>.
 	  However, do not compile this as a module if your root file system
 	  (the one containing the directory /) is located on a UFS device.
 
Signature · 1 line
2.21.1
#48 lore raw

PATCH 41/42 docs: scsi: convert wd719x.txt to ReST

In reply to Mauro Carvalho Chehab
---
 Documentation/scsi/index.rst                  |  1 +
 Documentation/scsi/{wd719x.txt => wd719x.rst} | 23 +++++++++++--------
 2 files changed, 14 insertions(+), 10 deletions(-)
 rename Documentation/scsi/{wd719x.txt => wd719x.rst} (46%)
Documentation/scsi/index.rst +1 -0
index 27720d145eff..260f1145431d 100644
@@ -45,5 +45,6 @@ Linux SCSI Subsystem
    sym53c8xx_2
    tcm_qla2xxx
    ufs
+   wd719x
 
    scsi_transport_srp/figures
Documentation/scsi/wd719x.rst renamed from Documentation/scsi/wd719x.txt +13 -10
similarity index 46%
rename from Documentation/scsi/wd719x.txt
rename to Documentation/scsi/wd719x.rst
index 0816b0220238..a35015dfedd9 100644
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===============================================================
 Driver for Western Digital WD7193, WD7197 and WD7296 SCSI cards
----------------------------------------------------------------
+===============================================================
 
 The card requires firmware that can be cut out of the Windows NT driver that
 can be downloaded from WD at:
@@ -9,13 +12,13 @@ There is no license anywhere in the file or on the page - so the firmware
 probably cannot be added to linux-firmware.
 
 This script downloads and extracts the firmware, creating wd719x-risc.bin and
-d719x-wcs.bin files. Put them in /lib/firmware/.
+d719x-wcs.bin files. Put them in /lib/firmware/::
 
-#!/bin/sh
-wget http://support.wdc.com/download/archive/pciscsi.exe
-lha xi pciscsi.exe pci-scsi.exe
-lha xi pci-scsi.exe nt/wd7296a.sys
-rm pci-scsi.exe
-dd if=wd7296a.sys of=wd719x-risc.bin bs=1 skip=5760 count=14336
-dd if=wd7296a.sys of=wd719x-wcs.bin bs=1 skip=20096 count=514
-rm wd7296a.sys
+	#!/bin/sh
+	wget http://support.wdc.com/download/archive/pciscsi.exe
+	lha xi pciscsi.exe pci-scsi.exe
+	lha xi pci-scsi.exe nt/wd7296a.sys
+	rm pci-scsi.exe
+	dd if=wd7296a.sys of=wd719x-risc.bin bs=1 skip=5760 count=14336
+	dd if=wd7296a.sys of=wd719x-wcs.bin bs=1 skip=20096 count=514
+	rm wd7296a.sys
Signature · 1 line
2.21.1
#49 lore raw

PATCH 42/42 docs: scsi: convert arcmsr_spec.txt to ReST

In reply to Mauro Carvalho Chehab

This file had its own peculiar style, not following any other files inside the Kernel (as far as I saw).

Had to do a number of changes here, starting by removing the two leading asterisks from each line, adding table and literal block markups and changing whitespace and blank lines.

The end result is that (IMHO), it is now a lot easier to read it as a text file, while producing a good html output.

---
 Documentation/scsi/arcmsr_spec.rst | 907 +++++++++++++++++++++++++++++
 Documentation/scsi/arcmsr_spec.txt | 574 ------------------
 Documentation/scsi/index.rst       |   1 +
 drivers/scsi/arcmsr/arcmsr_attr.c  |   2 +-
 drivers/scsi/arcmsr/arcmsr_hba.c   |   2 +-
 5 files changed, 910 insertions(+), 576 deletions(-)
 create mode 100644 Documentation/scsi/arcmsr_spec.rst
 delete mode 100644 Documentation/scsi/arcmsr_spec.txt
Documentation/scsi/arcmsr_spec.rst new file +907 -0
new file mode 100644
index 000000000000..83dd53bcff78
@@ -0,0 +1,907 @@
+ARECA FIRMWARE SPEC
+===================
+
+Usage of IOP331 adapter
+=======================
+
+(All In/Out is in IOP331's view)
+
+1. Message 0
+------------
+
+- InitThread message and return code
+
+2. Doorbell is used for RS-232 emulation
+----------------------------------------
+
+inDoorBell
+    bit0
+	data in ready
+	zDRIVER DATA WRITE OK)
+    bit1
+	data out has been read
+	(DRIVER DATA READ OK)
+
+outDooeBell:
+    bit0
+	data out ready
+	(IOP331 DATA WRITE OK)
+    bit1
+	data in has been read
+	(IOP331 DATA READ OK)
+
+3. Index Memory Usage
+---------------------
+
+============   ==========================================
+offset 0xf00   for RS232 out (request buffer)
+offset 0xe00   for RS232 in  (scratch buffer)
+offset 0xa00   for inbound message code message_rwbuffer
+	       (driver send to IOP331)
+offset 0xa00   for outbound message code message_rwbuffer
+	       (IOP331 send to driver)
+============   ==========================================
+
+4. RS-232 emulation
+-------------------
+
+Currently 128 byte buffer is used:
+
+============   =====================
+1st uint32_t   Data length (1--124)
+Byte 4--127    Max 124 bytes of data
+============   =====================
+
+5. PostQ
+--------
+
+All SCSI Command must be sent through postQ:
+
+    (inbound queue port)
+	Request frame must be 32 bytes aligned:
+
+	    #bit27--bit31
+		flag for post ccb
+	    #bit0--bit26
+		real address (bit27--bit31) of post arcmsr_cdb
+
+		=====   ===================
+		bit31   ==  ===============
+			0   256 bytes frame
+			1   512 bytes frame
+			==  ===============
+		bit30   ==  ==============
+			0   normal request
+			1   BIOS request
+			==  ==============
+		bit29   reserved
+		bit28   reserved
+		bit27   reserved
+		=====   ===================
+
+    (outbount queue port)
+	Request reply:
+
+	    #bit27--bit31
+		    flag for reply
+	    #bit0--bit26
+		    real address (bit27--bit31) of reply arcmsr_cdb
+
+		    =====   =======================================================
+		    bit31   must be 0 (for this type of reply)
+		    bit30   reserved for BIOS handshake
+		    bit29   reserved
+		    bit28   ==  ===================================================
+			    0   no error, ignore AdapStatus/DevStatus/SenseData
+			    1   Error, error code in AdapStatus/DevStatus/SenseData
+			    ==  ===================================================
+		    bit27   reserved
+		    =====   =======================================================
+
+6. BIOS request
+---------------
+
+All BIOS request is the same with request from PostQ
+
+Except:
+
+Request frame is sent from configuration space:
+
+	============   ==========================
+	offset: 0x78   Request Frame (bit30 == 1)
+	offset: 0x18   writeonly to generate
+		       IRQ to IOP331
+	============   ==========================
+
+Completion of request::
+
+	(bit30 == 0, bit28==err flag)
+
+7. Definition of SGL entry (structure)
+--------------------------------------
+
+8. Message1 Out - Diag Status Code (????)
+-----------------------------------------
+
+9. Message0 message code
+------------------------
+
+======  =================================================================
+0x00    NOP
+0x01    Get Config
+	->offset 0xa00 :for outbound message code message_rwbuffer
+	(IOP331 send to driver)
+
+	===================== ==========================================
+	Signature             0x87974060(4)
+	Request len           0x00000200(4)
+	numbers of queue      0x00000100(4)
+	SDRAM Size            0x00000100(4)-->256 MB
+	IDE Channels          0x00000008(4)
+	vendor                40 bytes char
+	model                 8 bytes char
+	FirmVer               16 bytes char
+	Device Map            16 bytes char
+	FirmwareVersion       DWORD
+
+			      - Added for checking of
+				new firmware capability
+	===================== ==========================================
+0x02    Set Config
+	->offset 0xa00 :for inbound message code message_rwbuffer
+	(driver send to IOP331)
+
+	========================= ==================
+	Signature                 0x87974063(4)
+	UPPER32 of Request Frame  (4)-->Driver Only
+	========================= ==================
+0x03    Reset (Abort all queued Command)
+0x04    Stop Background Activity
+0x05    Flush Cache
+0x06    Start Background Activity
+	(re-start if background is halted)
+0x07    Check If Host Command Pending
+	(Novell May Need This Function)
+0x08    Set controller time
+	->offset 0xa00   for inbound message code message_rwbuffer
+	(driver to IOP331)
+
+	======   ==================
+	byte 0   0xaa <-- signature
+	byte 1   0x55 <-- signature
+	byte 2   year (04)
+	byte 3   month (1..12)
+	byte 4   date (1..31)
+	byte 5   hour (0..23)
+	byte 6   minute (0..59)
+	byte 7   second (0..59)
+	======   ==================
+======  =================================================================
+
+
+RS-232 Interface for Areca Raid Controller
+==========================================
+
+      The low level command interface is exclusive with VT100 terminal
+
+1. Sequence of command execution
+--------------------------------
+
+	(A) Header
+		3 bytes sequence (0x5E, 0x01, 0x61)
+
+	(B) Command block
+		variable length of data including length,
+		command code, data and checksum byte
+
+	(C) Return data
+		variable length of data
+
+2. Command block
+----------------
+
+	(A) 1st byte
+		command block length (low byte)
+
+	(B) 2nd byte
+		command block length (high byte)
+
+		.. Note:: command block length shouldn't > 2040 bytes,
+			  length excludes these two bytes
+
+	(C) 3rd byte
+		command code
+
+	(D) 4th and following bytes
+		variable length data bytes
+
+	    depends on command code
+
+	(E) last byte
+	    checksum byte (sum of 1st byte until last data byte)
+
+3. Command code and associated data
+-----------------------------------
+
+The following are command code defined in raid controller Command
+code 0x10--0x1? are used for system level management,
+no password checking is needed and should be implemented in separate
+well controlled utility and not for end user access.
+Command code 0x20--0x?? always check the password,
+password must be entered to enable these command::
+
+	enum
+	{
+		GUI_SET_SERIAL=0x10,
+		GUI_SET_VENDOR,
+		GUI_SET_MODEL,
+		GUI_IDENTIFY,
+		GUI_CHECK_PASSWORD,
+		GUI_LOGOUT,
+		GUI_HTTP,
+		GUI_SET_ETHERNET_ADDR,
+		GUI_SET_LOGO,
+		GUI_POLL_EVENT,
+		GUI_GET_EVENT,
+		GUI_GET_HW_MONITOR,
+		//    GUI_QUICK_CREATE=0x20, (function removed)
+		GUI_GET_INFO_R=0x20,
+		GUI_GET_INFO_V,
+		GUI_GET_INFO_P,
+		GUI_GET_INFO_S,
+		GUI_CLEAR_EVENT,
+		GUI_MUTE_BEEPER=0x30,
+		GUI_BEEPER_SETTING,
+		GUI_SET_PASSWORD,
+		GUI_HOST_INTERFACE_MODE,
+		GUI_REBUILD_PRIORITY,
+		GUI_MAX_ATA_MODE,
+		GUI_RESET_CONTROLLER,
+		GUI_COM_PORT_SETTING,
+		GUI_NO_OPERATION,
+		GUI_DHCP_IP,
+		GUI_CREATE_PASS_THROUGH=0x40,
+		GUI_MODIFY_PASS_THROUGH,
+		GUI_DELETE_PASS_THROUGH,
+		GUI_IDENTIFY_DEVICE,
+		GUI_CREATE_RAIDSET=0x50,
+		GUI_DELETE_RAIDSET,
+		GUI_EXPAND_RAIDSET,
+		GUI_ACTIVATE_RAIDSET,
+		GUI_CREATE_HOT_SPARE,
+		GUI_DELETE_HOT_SPARE,
+		GUI_CREATE_VOLUME=0x60,
+		GUI_MODIFY_VOLUME,
+		GUI_DELETE_VOLUME,
+		GUI_START_CHECK_VOLUME,
+		GUI_STOP_CHECK_VOLUME
+	};
+
+Command description
+^^^^^^^^^^^^^^^^^^^
+
+GUI_SET_SERIAL
+	Set the controller serial#
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x10
+	byte 3            password length (should be 0x0f)
+	byte 4-0x13       should be "ArEcATecHnoLogY"
+	byte 0x14--0x23   Serial number string (must be 16 bytes)
+	================  =============================================
+
+GUI_SET_VENDOR
+	Set vendor string for the controller
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x11
+	byte 3            password length (should be 0x08)
+	byte 4-0x13       should be "ArEcAvAr"
+	byte 0x14--0x3B   vendor string (must be 40 bytes)
+	================  =============================================
+
+GUI_SET_MODEL
+	Set the model name of the controller
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x12
+	byte 3            password length (should be 0x08)
+	byte 4-0x13       should be "ArEcAvAr"
+	byte 0x14--0x1B   model string (must be 8 bytes)
+	================  =============================================
+
+GUI_IDENTIFY
+	Identify device
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x13
+			    return "Areca RAID Subsystem "
+	================  =============================================
+
+GUI_CHECK_PASSWORD
+	Verify password
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x14
+	byte 3            password length
+	byte 4-0x??       user password to be checked
+	================  =============================================
+
+GUI_LOGOUT
+	Logout GUI (force password checking on next command)
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x15
+	================  =============================================
+
+GUI_HTTP
+	HTTP interface (reserved for Http proxy service)(0x16)
+
+GUI_SET_ETHERNET_ADDR
+	Set the ethernet MAC address
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x17
+	byte 3            password length (should be 0x08)
+	byte 4-0x13       should be "ArEcAvAr"
+	byte 0x14--0x19   Ethernet MAC address (must be 6 bytes)
+	================  =============================================
+
+GUI_SET_LOGO
+	Set logo in HTTP
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x18
+	byte 3            Page# (0/1/2/3) (0xff --> clear OEM logo)
+	byte 4/5/6/7      0x55/0xaa/0xa5/0x5a
+	byte 8            TITLE.JPG data (each page must be 2000 bytes)
+
+			  .. Note:: page0 1st 2 byte must be
+				    actual length of the JPG file
+	================  =============================================
+
+GUI_POLL_EVENT
+	Poll If Event Log Changed
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x19
+	================  =============================================
+
+GUI_GET_EVENT
+	Read Event
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x1a
+	byte 3            Event Page (0:1st page/1/2/3:last page)
+	================  =============================================
+
+GUI_GET_HW_MONITOR
+	Get HW monitor data
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x1b
+	byte 3 		  # of FANs(example 2)
+	byte 4 		  # of Voltage sensor(example 3)
+	byte 5 		  # of temperature sensor(example 2)
+	byte 6 		  # of power
+	byte 7/8          Fan#0 (RPM)
+	byte 9/10         Fan#1
+	byte 11/12 	  Voltage#0 original value in ``*1000``
+	byte 13/14 	  Voltage#0 value
+	byte 15/16 	  Voltage#1 org
+	byte 17/18 	  Voltage#1
+	byte 19/20 	  Voltage#2 org
+	byte 21/22 	  Voltage#2
+	byte 23 	  Temp#0
+	byte 24 	  Temp#1
+	byte 25 	  Power indicator (bit0   power#0,
+			  bit1   power#1)
+	byte 26 	  UPS indicator
+	================  =============================================
+
+GUI_QUICK_CREATE
+	Quick create raid/volume set
+
+	================  ==============================================
+	byte 0,1       	  length
+	byte 2         	  command code 0x20
+	byte 3/4/5/6   	  raw capacity
+	byte 7 		  raid level
+	byte 8 		  stripe size
+	byte 9 		  spare
+	byte 10/11/12/13  device mask (the devices to create raid/volume)
+	================  ==============================================
+
+    This function is removed, application like
+    to implement quick create function
+
+    need to use GUI_CREATE_RAIDSET and GUI_CREATE_VOLUMESET function.
+
+GUI_GET_INFO_R
+	Get Raid Set Information
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x20
+	byte 3            raidset#
+	================  =============================================
+
+	::
+
+	    typedef struct sGUI_RAIDSET
+	    {
+		    BYTE grsRaidSetName[16];
+		    DWORD grsCapacity;
+		    DWORD grsCapacityX;
+		    DWORD grsFailMask;
+		    BYTE grsDevArray[32];
+		    BYTE grsMemberDevices;
+		    BYTE grsNewMemberDevices;
+		    BYTE grsRaidState;
+		    BYTE grsVolumes;
+		    BYTE grsVolumeList[16];
+		    BYTE grsRes1;
+		    BYTE grsRes2;
+		    BYTE grsRes3;
+		    BYTE grsFreeSegments;
+		    DWORD grsRawStripes[8];
+		    DWORD grsRes4;
+		    DWORD grsRes5; //     Total to 128 bytes
+		    DWORD grsRes6; //     Total to 128 bytes
+	    } sGUI_RAIDSET, *pGUI_RAIDSET;
+
+GUI_GET_INFO_V
+	Get Volume Set Information
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x21
+	byte 3            volumeset#
+	================  =============================================
+
+	::
+
+	    typedef struct sGUI_VOLUMESET
+	    {
+		    BYTE gvsVolumeName[16]; //     16
+		    DWORD gvsCapacity;
+		    DWORD gvsCapacityX;
+		    DWORD gvsFailMask;
+		    DWORD gvsStripeSize;
+		    DWORD gvsNewFailMask;
+		    DWORD gvsNewStripeSize;
+		    DWORD gvsVolumeStatus;
+		    DWORD gvsProgress; //     32
+		    sSCSI_ATTR gvsScsi;
+		    BYTE gvsMemberDisks;
+		    BYTE gvsRaidLevel; //     8
+		    BYTE gvsNewMemberDisks;
+		    BYTE gvsNewRaidLevel;
+		    BYTE gvsRaidSetNumber;
+		    BYTE gvsRes0; //     4
+		    BYTE gvsRes1[4]; //     64 bytes
+	    } sGUI_VOLUMESET, *pGUI_VOLUMESET;
+
+GUI_GET_INFO_P
+	Get Physical Drive Information
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x22
+	byte 3            drive # (from 0 to max-channels - 1)
+	================  =============================================
+
+	::
+
+	    typedef struct sGUI_PHY_DRV
+	    {
+		    BYTE gpdModelName[40];
+		    BYTE gpdSerialNumber[20];
+		    BYTE gpdFirmRev[8];
+		    DWORD gpdCapacity;
+		    DWORD gpdCapacityX; //     Reserved for expansion
+		    BYTE gpdDeviceState;
+		    BYTE gpdPioMode;
+		    BYTE gpdCurrentUdmaMode;
+		    BYTE gpdUdmaMode;
+		    BYTE gpdDriveSelect;
+		    BYTE gpdRaidNumber; //     0xff if not belongs to a raid set
+		    sSCSI_ATTR gpdScsi;
+		    BYTE gpdReserved[40]; //     Total to 128 bytes
+	    } sGUI_PHY_DRV, *pGUI_PHY_DRV;
+
+GUI_GET_INFO_S
+	Get System Information
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x23
+	================  =============================================
+
+	::
+
+	    typedef struct sCOM_ATTR
+	    {
+		    BYTE comBaudRate;
+		    BYTE comDataBits;
+		    BYTE comStopBits;
+		    BYTE comParity;
+		    BYTE comFlowControl;
+	    } sCOM_ATTR, *pCOM_ATTR;
+	    typedef struct sSYSTEM_INFO
+	    {
+		    BYTE gsiVendorName[40];
+		    BYTE gsiSerialNumber[16];
+		    BYTE gsiFirmVersion[16];
+		    BYTE gsiBootVersion[16];
+		    BYTE gsiMbVersion[16];
+		    BYTE gsiModelName[8];
+		    BYTE gsiLocalIp[4];
+		    BYTE gsiCurrentIp[4];
+		    DWORD gsiTimeTick;
+		    DWORD gsiCpuSpeed;
+		    DWORD gsiICache;
+		    DWORD gsiDCache;
+		    DWORD gsiScache;
+		    DWORD gsiMemorySize;
+		    DWORD gsiMemorySpeed;
+		    DWORD gsiEvents;
+		    BYTE gsiMacAddress[6];
+		    BYTE gsiDhcp;
+		    BYTE gsiBeeper;
+		    BYTE gsiChannelUsage;
+		    BYTE gsiMaxAtaMode;
+		    BYTE gsiSdramEcc; //     1:if ECC enabled
+		    BYTE gsiRebuildPriority;
+		    sCOM_ATTR gsiComA; //     5 bytes
+		    sCOM_ATTR gsiComB; //     5 bytes
+		    BYTE gsiIdeChannels;
+		    BYTE gsiScsiHostChannels;
+		    BYTE gsiIdeHostChannels;
+		    BYTE gsiMaxVolumeSet;
+		    BYTE gsiMaxRaidSet;
+		    BYTE gsiEtherPort; //     1:if ether net port supported
+		    BYTE gsiRaid6Engine; //     1:Raid6 engine supported
+		    BYTE gsiRes[75];
+	    } sSYSTEM_INFO, *pSYSTEM_INFO;
+
+GUI_CLEAR_EVENT
+	Clear System Event
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x24
+	================  =============================================
+
+GUI_MUTE_BEEPER
+	Mute current beeper
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x30
+	================  =============================================
+GUI_BEEPER_SETTING
+	Disable beeper
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x31
+	byte 3            0->disable, 1->enable
+	================  =============================================
+
+GUI_SET_PASSWORD
+	Change password
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x32
+	byte 3 		  pass word length ( must <= 15 )
+	byte 4 		  password (must be alpha-numerical)
+	================  =============================================
+
+GUI_HOST_INTERFACE_MODE
+	Set host interface mode
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x33
+	byte 3 		  0->Independent, 1->cluster
+	================  =============================================
+
+GUI_REBUILD_PRIORITY
+	Set rebuild priority
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x34
+	byte 3 		  0/1/2/3 (low->high)
+	================  =============================================
+
+GUI_MAX_ATA_MODE
+	Set maximum ATA mode to be used
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x35
+	byte 3 		  0/1/2/3 (133/100/66/33)
+	================  =============================================
+
+GUI_RESET_CONTROLLER
+	Reset Controller
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x36
+			  * Response with VT100 screen (discard it)
+	================  =============================================
+
+GUI_COM_PORT_SETTING
+	COM port setting
+
+	================  =================================================
+	byte 0,1	  length
+	byte 2 		  command code 0x37
+	byte 3 		  0->COMA (term port),
+			  1->COMB (debug port)
+	byte 4 		  0/1/2/3/4/5/6/7
+			  (1200/2400/4800/9600/19200/38400/57600/115200)
+	byte 5 		  data bit
+			  (0:7 bit, 1:8 bit   must be 8 bit)
+	byte 6 		  stop bit (0:1, 1:2 stop bits)
+	byte 7 		  parity (0:none, 1:off, 2:even)
+	byte 8 		  flow control
+			  (0:none, 1:xon/xoff, 2:hardware => must use none)
+	================  =================================================
+
+GUI_NO_OPERATION
+	No operation
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x38
+	================  =============================================
+
+GUI_DHCP_IP
+	Set DHCP option and local IP address
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x39
+	byte 3            0:dhcp disabled, 1:dhcp enabled
+	byte 4/5/6/7      IP address
+	================  =============================================
+
+GUI_CREATE_PASS_THROUGH
+	Create pass through disk
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x40
+	byte 3 		  device #
+	byte 4 		  scsi channel (0/1)
+	byte 5 		  scsi id (0-->15)
+	byte 6 		  scsi lun (0-->7)
+	byte 7 		  tagged queue (1   enabled)
+	byte 8 		  cache mode (1   enabled)
+	byte 9 		  max speed (0/1/2/3/4,
+			  async/20/40/80/160 for scsi)
+			  (0/1/2/3/4, 33/66/100/133/150 for ide  )
+	================  =============================================
+
+GUI_MODIFY_PASS_THROUGH
+	Modify pass through disk
+
+	================  =============================================
+	byte 0,1          length
+	byte 2 		  command code 0x41
+	byte 3 		  device #
+	byte 4 		  scsi channel (0/1)
+	byte 5 		  scsi id (0-->15)
+	byte 6 		  scsi lun (0-->7)
+	byte 7 		  tagged queue (1   enabled)
+	byte 8 		  cache mode (1   enabled)
+	byte 9 		  max speed (0/1/2/3/4,
+			  async/20/40/80/160 for scsi)
+			  (0/1/2/3/4, 33/66/100/133/150 for ide  )
+	================  =============================================
+
+GUI_DELETE_PASS_THROUGH
+	Delete pass through disk
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x42
+	byte 3            device# to be deleted
+	================  =============================================
+GUI_IDENTIFY_DEVICE
+	Identify Device
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x43
+	byte 3            Flash Method
+			  (0:flash selected, 1:flash not selected)
+	byte 4/5/6/7      IDE device mask to be flashed
+			  .. Note:: no response data available
+	================  =============================================
+
+GUI_CREATE_RAIDSET
+	Create Raid Set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x50
+	byte 3/4/5/6      device mask
+	byte 7-22         raidset name (if byte 7 == 0:use default)
+	================  =============================================
+
+GUI_DELETE_RAIDSET
+	Delete Raid Set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x51
+	byte 3            raidset#
+	================  =============================================
+
+GUI_EXPAND_RAIDSET
+	Expand Raid Set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x52
+	byte 3            raidset#
+	byte 4/5/6/7      device mask for expansion
+	byte 8/9/10       (8:0 no change, 1 change, 0xff:terminate,
+			  9:new raid level,
+			  10:new stripe size
+			  0/1/2/3/4/5->4/8/16/32/64/128K )
+	byte 11/12/13     repeat for each volume in the raidset
+	================  =============================================
+
+GUI_ACTIVATE_RAIDSET
+	Activate incomplete raid set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x53
+	byte 3            raidset#
+	================  =============================================
+
+GUI_CREATE_HOT_SPARE
+	Create hot spare disk
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x54
+	byte 3/4/5/6      device mask for hot spare creation
+	================  =============================================
+
+GUI_DELETE_HOT_SPARE
+	Delete hot spare disk
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x55
+	byte 3/4/5/6      device mask for hot spare deletion
+	================  =============================================
+
+GUI_CREATE_VOLUME
+	Create volume set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x60
+	byte 3            raidset#
+	byte 4-19         volume set name
+			  (if byte4 == 0, use default)
+	byte 20-27        volume capacity (blocks)
+	byte 28 	  raid level
+	byte 29 	  stripe size
+			  (0/1/2/3/4/5->4/8/16/32/64/128K)
+	byte 30 	  channel
+	byte 31 	  ID
+	byte 32 	  LUN
+	byte 33 	  1 enable tag
+	byte 34 	  1 enable cache
+	byte 35 	  speed
+			  (0/1/2/3/4->async/20/40/80/160 for scsi)
+			  (0/1/2/3/4->33/66/100/133/150 for IDE  )
+	byte 36 	  1 to select quick init
+	================  =============================================
+
+GUI_MODIFY_VOLUME
+	Modify volume Set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x61
+	byte 3            volumeset#
+	byte 4-19         new volume set name
+			  (if byte4 == 0, not change)
+	byte 20-27        new volume capacity (reserved)
+	byte 28 	  new raid level
+	byte 29 	  new stripe size
+			  (0/1/2/3/4/5->4/8/16/32/64/128K)
+	byte 30 	  new channel
+	byte 31 	  new ID
+	byte 32 	  new LUN
+	byte 33 	  1 enable tag
+	byte 34 	  1 enable cache
+	byte 35 	  speed
+			  (0/1/2/3/4->async/20/40/80/160 for scsi)
+			  (0/1/2/3/4->33/66/100/133/150 for IDE  )
+	================  =============================================
+
+GUI_DELETE_VOLUME
+	Delete volume set
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x62
+	byte 3            volumeset#
+	================  =============================================
+
+GUI_START_CHECK_VOLUME
+	Start volume consistency check
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x63
+	byte 3            volumeset#
+	================  =============================================
+
+GUI_STOP_CHECK_VOLUME
+	Stop volume consistency check
+
+	================  =============================================
+	byte 0,1          length
+	byte 2            command code 0x64
+	================  =============================================
+
+4. Returned data
+----------------
+
+(A) Header
+    3 bytes sequence (0x5E, 0x01, 0x61)
+(B) Length
+    2 bytes
+    (low byte 1st, excludes length and checksum byte)
+(C)
+    status or data:
+
+	1) If length == 1 ==> 1 byte status code::
+
+		#define GUI_OK                    0x41
+		#define GUI_RAIDSET_NOT_NORMAL    0x42
+		#define GUI_VOLUMESET_NOT_NORMAL  0x43
+		#define GUI_NO_RAIDSET            0x44
+		#define GUI_NO_VOLUMESET          0x45
+		#define GUI_NO_PHYSICAL_DRIVE     0x46
+		#define GUI_PARAMETER_ERROR       0x47
+		#define GUI_UNSUPPORTED_COMMAND   0x48
+		#define GUI_DISK_CONFIG_CHANGED   0x49
+		#define GUI_INVALID_PASSWORD      0x4a
+		#define GUI_NO_DISK_SPACE         0x4b
+		#define GUI_CHECKSUM_ERROR        0x4c
+		#define GUI_PASSWORD_REQUIRED     0x4d
+
+	2) If length > 1:
+
+		data block returned from controller
+		and the contents depends on the command code
+
+(E) Checksum
+    checksum of length and status or data byte
+
Documentation/scsi/arcmsr_spec.txt deleted +0 -574

574 lines not on this page · raw message

Documentation/scsi/index.rst +1 -0
index 260f1145431d..7c5f5f8f614e 100644
@@ -13,6 +13,7 @@ Linux SCSI Subsystem
    aha152x
    aic79xx
    aic7xxx
+   arcmsr_spec
    bfa
    bnx2fc
    BusLogic
drivers/scsi/arcmsr/arcmsr_attr.c +1 -1
index 259d9c20bf25..57be9609d504 100644
@@ -41,7 +41,7 @@
 ** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************
 ** For history of changes, see Documentation/scsi/ChangeLog.arcmsr
-**     Firmware Specification, see Documentation/scsi/arcmsr_spec.txt
+**     Firmware Specification, see Documentation/scsi/arcmsr_spec.rst
 *******************************************************************************
 */
 #include <linux/module.h>
drivers/scsi/arcmsr/arcmsr_hba.c +1 -1
index 40dc8eac0e3a..a48632b05ade 100644
@@ -41,7 +41,7 @@
 ** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************
 ** For history of changes, see Documentation/scsi/ChangeLog.arcmsr
-**     Firmware Specification, see Documentation/scsi/arcmsr_spec.txt
+**     Firmware Specification, see Documentation/scsi/arcmsr_spec.rst
 *******************************************************************************
 */
 #include <linux/module.h>
Signature · 1 line
2.21.1
maintainer
#50 lore raw
In reply to Mauro Carvalho Chehab
Quoted 10 lines · On Mon, 2 Mar 2020 09:15:33 +0100 Mauro Carvalho Chehab…

This patch series manually convert all SCSI documentation files to ReST.

This is part of a bigger series that finaly finishes the migration to ReST. After that, we can focus on more interesting tasks from the documentation PoV, like cleaning obsolete stuff and filling the gaps.

If you want to see how this would show at the documentation body, a sneak peak of this series (together with the other pending doc patches from me) is available at:

Quoted 7 lines

https://www.infradead.org/~mchehab/kernel_docs/scsi/index.html

This series is available on this devel branch:

        https://git.linuxtv.org/mchehab/experimental.git/log/?h=scsi_docs_20200228

and it is based on next-20200228

Any thoughts from the SCSI maintainers on this series? Assuming you're favorable, would you like to carry it or should I?

Thanks,

jon

#51 lore raw

Jon,

Quoted 2 lines

Any thoughts from the SCSI maintainers on this series? Assuming you're favorable, would you like to carry it or should I?

I'm fine with this series and was going to queue it up. Unless you guys prefer to take it through docs?

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering
maintainer
#52 lore raw
Quoted 5 lines · On Tue, 10 Mar 2020 13:50:44 -0400 "Martin K. Petersen"…
Quoted 2 lines

Any thoughts from the SCSI maintainers on this series? Assuming you're favorable, would you like to carry it or should I?

I'm fine with this series and was going to queue it up. Unless you guys prefer to take it through docs?

No, don't stop now, it's all yours :)

Someday I'd like to discuss moving that stuff out of the top level, but that can be another day.

Thanks,

jon

#53 lore raw
In reply to Mauro Carvalho Chehab

Mauro,

Quoted 6 lines

This patch series manually convert all SCSI documentation files to ReST.

This is part of a bigger series that finaly finishes the migration to ReST. After that, we can focus on more interesting tasks from the documentation PoV, like cleaning obsolete stuff and filling the gaps.

Applied to 5.7/scsi-queue.

For some reason patch 23 didn't show up in the mbox so I had a bunch of conflicts due to the ncr53c8xx entry missing from index.rst. I thought you had somehow lost that patch along the way and decided to proceed regardless. However, it turns out the patch was missing due to a lore issue. By the time I figured out what the problem was, I had made it to the end of the series. And as a result, in my tree the ncr53c8xx patch comes last.

Anyway. Thanks for cleaning this up!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering
#54 lore raw

Hi Martin,

Em Tue, 10 Mar 2020 19:40:19 -0400
"Martin K. Petersen" <[email protected]> escreveu:

Quoted 12 lines

Mauro,

Quoted 6 lines

This patch series manually convert all SCSI documentation files to ReST.

This is part of a bigger series that finaly finishes the migration to ReST. After that, we can focus on more interesting tasks from the documentation PoV, like cleaning obsolete stuff and filling the gaps.

Applied to 5.7/scsi-queue.

Quoted 7 lines

For some reason patch 23 didn't show up in the mbox so I had a bunch of conflicts due to the ncr53c8xx entry missing from index.rst. I thought you had somehow lost that patch along the way and decided to proceed regardless. However, it turns out the patch was missing due to a lore issue. By the time I figured out what the problem was, I had made it to the end of the series. And as a result, in my tree the ncr53c8xx patch comes last.

No problem. Yeah, sometimes some of those patches are big, and vger ends by silently dropping the big guys.

Btw, maybe due to the conflict you had, I double-checked that two files ended by being deleted instead of converted (looking at today's linux-next).

So, I'm sending a followup patch re-adding them after the conversion.

Feel free to either apply it as a separate patch at the end or to fold with the previously applied patches. Whatever works best for you.

Regards,
Mauro

#55 lore raw

Mauro,

Quoted 3 lines

Btw, maybe due to the conflict you had, I double-checked that two files ended by being deleted instead of converted (looking at today's linux-next).

Yeah, I messed that up, sorry! The files were in my repo but I evidently forgot to add them after manually applying so they ended up missing in the commit.

Quoted 2 lines

Feel free to either apply it as a separate patch at the end or to fold with the previously applied patches. Whatever works best for you.

Since your series was near the top of my tree I decided to grab a fresh mbox from lore. I manually added the missing pieces from my mail folder so the series would apply cleanly.

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering