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%)
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../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%)
diff --git a/Documentation/scsi/g_NCR5380.txt b/Documentation/scsi/g_NCR5380.rst
similarity index 41%
rename from Documentation/scsi/g_NCR5380.txt
rename to Documentation/scsi/g_NCR5380.rst
index 37b1967a00a9..a282059fec43 100644
--- a/Documentation/scsi/g_NCR5380.txt
+++ b/Documentation/scsi/g_NCR5380.rst
@@ -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]
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index aad8359357e6..4b577c9e804e 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -20,5 +20,6 @@ Linux SCSI Subsystem
dc395x
dpti
FlashPoint
+ g_NCR5380
scsi_transport_srp/figures
diff --git a/Documentation/scsi/scsi-parameters.txt b/Documentation/scsi/scsi-parameters.txt
index 266fd3b2398a..864bbf7f737b 100644
--- a/Documentation/scsi/scsi-parameters.txt
+++ b/Documentation/scsi/scsi-parameters.txt
@@ -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]
diff --git a/MAINTAINERS b/MAINTAINERS
index 1e2ab816fe66..451a3f67d23a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -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
diff --git a/drivers/scsi/g_NCR5380.c b/drivers/scsi/g_NCR5380.c
index 2ab774e62e40..2cc676e3df6a 100644
--- a/drivers/scsi/g_NCR5380.c
+++ b/drivers/scsi/g_NCR5380.c
@@ -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>
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../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%)
diff --git a/Documentation/scsi/BusLogic.txt b/Documentation/scsi/BusLogic.rst
similarity index 93%
rename from Documentation/scsi/BusLogic.txt
rename to Documentation/scsi/BusLogic.rst
index 48e982cd6fe7..b60169812358 100644
--- a/Documentation/scsi/BusLogic.txt
+++ b/Documentation/scsi/BusLogic.rst
@@ -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
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index d453fb3f1f7d..6bb2428c1d56 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -15,5 +15,6 @@ Linux SCSI Subsystem
aic7xxx
bfa
bnx2fc
+ BusLogic
scsi_transport_srp/figures
diff --git a/drivers/scsi/BusLogic.c b/drivers/scsi/BusLogic.c
index 3170b295a5da..9b8be4f0da19 100644
--- a/drivers/scsi/BusLogic.c
+++ b/drivers/scsi/BusLogic.c
@@ -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)
diff --git a/drivers/scsi/Kconfig b/drivers/scsi/Kconfig
index 18af62594bc0..5ec7330f82b6 100644
--- a/drivers/scsi/Kconfig
+++ b/drivers/scsi/Kconfig
@@ -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.
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
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
diff --git a/Documentation/scsi/dpti.rst b/Documentation/scsi/dpti.rst
new file mode 100644
index 000000000000..0496919d87d3
--- /dev/null
+++ b/Documentation/scsi/dpti.rst
@@ -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.
diff --git a/Documentation/scsi/dpti.txt b/Documentation/scsi/dpti.txt
deleted file mode 100644
index f36dc0e7c8da..000000000000
--- a/Documentation/scsi/dpti.txt
+++ /dev/null
@@ -1,83 +0,0 @@
- /* TERMS AND CONDITIONS OF USE
- *
- * 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.
- *
- */
-
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 6fe00709cbce..b553dd9904bf 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -18,5 +18,6 @@ Linux SCSI Subsystem
BusLogic
cxgb3i
dc395x
+ dpti
scsi_transport_srp/figures
diff --git a/drivers/scsi/Kconfig b/drivers/scsi/Kconfig
index 9f5b2ddec6e0..5e834fba7934 100644
--- a/drivers/scsi/Kconfig
+++ b/drivers/scsi/Kconfig
@@ -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.
diff --git a/drivers/scsi/dpt/dpti_ioctl.h b/drivers/scsi/dpt/dpti_ioctl.h
index 6bc33f4f020d..25e9251f8c78 100644
--- a/drivers/scsi/dpt/dpti_ioctl.h
+++ b/drivers/scsi/dpt/dpti_ioctl.h
@@ -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
***************************************************************************/
diff --git a/drivers/scsi/dpt_i2o.c b/drivers/scsi/dpt_i2o.c
index abc74fd474dc..5362fb0b96a7 100644
--- a/drivers/scsi/dpt_i2o.c
+++ b/drivers/scsi/dpt_i2o.c
@@ -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
***************************************************************************/
diff --git a/drivers/scsi/dpti.h b/drivers/scsi/dpti.h
index 42b1e28b5884..6da9ab1fcfe8 100644
--- a/drivers/scsi/dpti.h
+++ b/drivers/scsi/dpti.h
@@ -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
***************************************************************************/
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
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%)
diff --git a/Documentation/scsi/bnx2fc.txt b/Documentation/scsi/bnx2fc.rst
similarity index 91%
rename from Documentation/scsi/bnx2fc.txt
rename to Documentation/scsi/bnx2fc.rst
index 80823556d62f..2fef2dff80c7 100644
--- a/Documentation/scsi/bnx2fc.txt
+++ b/Documentation/scsi/bnx2fc.rst
@@ -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
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 1e37227f3536..d453fb3f1f7d 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -14,5 +14,6 @@ Linux SCSI Subsystem
aic79xx
aic7xxx
bfa
+ bnx2fc
scsi_transport_srp/figures
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
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%)
diff --git a/Documentation/scsi/cxgb3i.txt b/Documentation/scsi/cxgb3i.rst
similarity index 86%
rename from Documentation/scsi/cxgb3i.txt
rename to Documentation/scsi/cxgb3i.rst
index 7ac8032ee9b2..e01f18fbfa9f 100644
--- a/Documentation/scsi/cxgb3i.txt
+++ b/Documentation/scsi/cxgb3i.rst
@@ -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
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 6bb2428c1d56..3809213b83da 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -16,5 +16,6 @@ Linux SCSI Subsystem
bfa
bnx2fc
BusLogic
+ cxgb3i
scsi_transport_srp/figures
--
2.21.1
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.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
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%)
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 16baf8b0f11f..3ef7ad65372a 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -7,4 +7,4 @@ Linux SCSI Subsystem
.. toctree::
:maxdepth: 1
-
+ scsi_transport_srp/figures
diff --git a/Documentation/scsi/scsi_transport_srp/Makefile b/Documentation/scsi/scsi_transport_srp/figures.rst
similarity index 1%
rename from Documentation/scsi/scsi_transport_srp/Makefile
rename to Documentation/scsi/scsi_transport_srp/figures.rst
index 5f6b567e955c..6c8f8dd6301b 100644
--- a/Documentation/scsi/scsi_transport_srp/Makefile
+++ b/Documentation/scsi/scsi_transport_srp/figures.rst
@@ -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
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../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%)
diff --git a/Documentation/scsi/aacraid.txt b/Documentation/scsi/aacraid.rst
similarity index 83%
rename from Documentation/scsi/aacraid.txt
rename to Documentation/scsi/aacraid.rst
index 30f643f611b2..1904674b94f3 100644
--- a/Documentation/scsi/aacraid.txt
+++ b/Documentation/scsi/aacraid.rst
@@ -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
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 99efc77c3ac2..2e0429d1a7a5 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -8,5 +8,6 @@ Linux SCSI Subsystem
:maxdepth: 1
53c700
+ aacraid
scsi_transport_srp/figures
diff --git a/MAINTAINERS b/MAINTAINERS
index 1552db209e69..cb6ecdbc96da 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -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
diff --git a/drivers/scsi/Kconfig b/drivers/scsi/Kconfig
index 2b882b96e0d4..a153444318fb 100644
--- a/drivers/scsi/Kconfig
+++ b/drivers/scsi/Kconfig
@@ -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.
--
2.21.1
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
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%)
diff --git a/Documentation/scsi/53c700.txt b/Documentation/scsi/53c700.rst
similarity index 75%
rename from Documentation/scsi/53c700.txt
rename to Documentation/scsi/53c700.rst
index e31aceb6df15..53a0e9f9c198 100644
--- a/Documentation/scsi/53c700.txt
+++ b/Documentation/scsi/53c700.rst
@@ -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.
diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
index 3ef7ad65372a..99efc77c3ac2 100644
--- a/Documentation/scsi/index.rst
+++ b/Documentation/scsi/index.rst
@@ -7,4 +7,6 @@ Linux SCSI Subsystem
.. toctree::
:maxdepth: 1
+ 53c700
+
scsi_transport_srp/figures
diff --git a/MAINTAINERS b/MAINTAINERS
index 09b04505e7c3..1552db209e69 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -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
--
2.21.1
On Mon, 2 Mar 2020, Mauro Carvalho Chehab wrote:
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Acked-by: Finn Thain <[email protected]>
> ---
> .../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%)
>
> diff --git a/Documentation/scsi/g_NCR5380.txt b/Documentation/scsi/g_NCR5380.rst
> similarity index 41%
> rename from Documentation/scsi/g_NCR5380.txt
> rename to Documentation/scsi/g_NCR5380.rst
> index 37b1967a00a9..a282059fec43 100644
> --- a/Documentation/scsi/g_NCR5380.txt
> +++ b/Documentation/scsi/g_NCR5380.rst
> @@ -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]
> diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
> index aad8359357e6..4b577c9e804e 100644
> --- a/Documentation/scsi/index.rst
> +++ b/Documentation/scsi/index.rst
> @@ -20,5 +20,6 @@ Linux SCSI Subsystem
> dc395x
> dpti
> FlashPoint
> + g_NCR5380
>
> scsi_transport_srp/figures
> diff --git a/Documentation/scsi/scsi-parameters.txt b/Documentation/scsi/scsi-parameters.txt
> index 266fd3b2398a..864bbf7f737b 100644
> --- a/Documentation/scsi/scsi-parameters.txt
> +++ b/Documentation/scsi/scsi-parameters.txt
> @@ -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]
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 1e2ab816fe66..451a3f67d23a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -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
> diff --git a/drivers/scsi/g_NCR5380.c b/drivers/scsi/g_NCR5380.c
> index 2ab774e62e40..2cc676e3df6a 100644
> --- a/drivers/scsi/g_NCR5380.c
> +++ b/drivers/scsi/g_NCR5380.c
> @@ -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>
>
On 3/2/20 1:15 AM, Mauro Carvalho Chehab wrote:
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> .../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%)
Acked-by: Khalid Aziz <[email protected]>
--
Khalid
>
> diff --git a/Documentation/scsi/BusLogic.txt b/Documentation/scsi/BusLogic.rst
> similarity index 93%
> rename from Documentation/scsi/BusLogic.txt
> rename to Documentation/scsi/BusLogic.rst
> index 48e982cd6fe7..b60169812358 100644
> --- a/Documentation/scsi/BusLogic.txt
> +++ b/Documentation/scsi/BusLogic.rst
> @@ -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
> diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
> index d453fb3f1f7d..6bb2428c1d56 100644
> --- a/Documentation/scsi/index.rst
> +++ b/Documentation/scsi/index.rst
> @@ -15,5 +15,6 @@ Linux SCSI Subsystem
> aic7xxx
> bfa
> bnx2fc
> + BusLogic
>
> scsi_transport_srp/figures
> diff --git a/drivers/scsi/BusLogic.c b/drivers/scsi/BusLogic.c
> index 3170b295a5da..9b8be4f0da19 100644
> --- a/drivers/scsi/BusLogic.c
> +++ b/drivers/scsi/BusLogic.c
> @@ -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)
> diff --git a/drivers/scsi/Kconfig b/drivers/scsi/Kconfig
> index 18af62594bc0..5ec7330f82b6 100644
> --- a/drivers/scsi/Kconfig
> +++ b/drivers/scsi/Kconfig
> @@ -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.
>
On Mon, 2 Mar 2020 09:15:33 +0100
Mauro Carvalho Chehab <[email protected]> wrote:
> 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
Any thoughts from the SCSI maintainers on this series? Assuming you're
favorable, would you like to carry it or should I?
Thanks,
jon
Jon,
> 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?
--
Martin K. Petersen Oracle Linux Engineering
On Tue, 10 Mar 2020 13:50:44 -0400
"Martin K. Petersen" <[email protected]> wrote:
> > 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
Mauro,
> 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!
--
Martin K. Petersen Oracle Linux Engineering
Hi Martin,
Em Tue, 10 Mar 2020 19:40:19 -0400
"Martin K. Petersen" <[email protected]> escreveu:
>
> Mauro,
>
> > 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.
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
Mauro,
> 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.
> 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.
--
Martin K. Petersen Oracle Linux Engineering