scsi: docs: convert aha152x.txt to ReST

Link: https://lore.kernel.org/r/097cfcc7f25343676a1fedcefed7e3b91b41b4df.1583136624.git.mchehab+huawei@kernel.org
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Mauro Carvalho Chehab 2020-03-02 09:15:39 +01:00 committed by Martin K. Petersen
parent cb32240894
commit 94b5530f1f
5 changed files with 53 additions and 31 deletions

View File

@ -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
Adaptec AHA-1520/1522 SCSI driver for Linux (aha152x) .. include:: <isonum.txt>
=====================================================
Adaptec AHA-1520/1522 SCSI driver for Linux (aha152x)
=====================================================
Copyright |copy| 1993-1999 Jürgen Fischer <fischer@norbit.de>
Copyright 1993-1999 Jürgen Fischer <fischer@norbit.de>
TC1550 patches by Luuk van Dijk (ldz@xs4all.nl) TC1550 patches by Luuk van Dijk (ldz@xs4all.nl)
@ -14,8 +19,10 @@ less polling loops), has slightly higher throughput (at
least on my ancient test box; a i486/33Mhz/20MB). least on my ancient test box; a i486/33Mhz/20MB).
CONFIGURATION ARGUMENTS: Configuration Arguments
=======================
============ ======================================== ======================
IOPORT base io address (0x340/0x140) IOPORT base io address (0x340/0x140)
IRQ interrupt level (9-12; default 11) IRQ interrupt level (9-12; default 11)
SCSI_ID scsi id of controller (0-7; default 7) 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) DELAY: bus reset delay (default 100)
EXT_TRANS: enable extended translation (0/1: default 0 [off]) EXT_TRANS: enable extended translation (0/1: default 0 [off])
(see NOTES) (see NOTES)
============ ======================================== ======================
COMPILE TIME CONFIGURATION (go into AHA152X in drivers/scsi/Makefile): Compile Time Configuration
==========================
-DAUTOCONF (go into AHA152X in drivers/scsi/Makefile):
use configuration the controller reports (AHA-152x only)
-DSKIP_BIOSTEST - DAUTOCONF
Don't test for BIOS signature (AHA-1510 or disabled BIOS) use configuration the controller reports (AHA-152x only)
-DSETUP0="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }" - DSKIP_BIOSTEST
override for the first controller Don't test for BIOS signature (AHA-1510 or disabled BIOS)
-DSETUP1="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }" - DSETUP0="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
override for the second controller override for the first controller
-DAHA152X_DEBUG - DSETUP1="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
enable debugging output override for the second controller
-DAHA152X_STAT - DAHA152X_DEBUG
enable some statistics enable debugging output
- DAHA152X_STAT
enable some statistics
LILO COMMAND LINE OPTIONS: LILO Command Line Options
=========================
aha152x=<IOPORT>[,<IRQ>[,<SCSI-ID>[,<RECONNECT>[,<PARITY>[,<SYNCHRONOUS>[,<DELAY> [,<EXT_TRANS]]]]]]] ::
aha152x=<IOPORT>[,<IRQ>[,<SCSI-ID>[,<RECONNECT>[,<PARITY>[,<SYNCHRONOUS>[,<DELAY> [,<EXT_TRANS]]]]]]]
The normal configuration can be overridden by specifying a command line. 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 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. For two controllers use the aha152x statement twice.
SYMBOLS FOR MODULE CONFIGURATION: Symbols for Module Configuration
================================
Choose from 2 alternatives: 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 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 configuration override for second controller
2. specify only what you need to (irq or io is required; new) 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. 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. SCSI uses block numbers to address blocks/sectors on a device.
The BIOS uses a cylinder/head/sector addressing scheme (C/H/S) 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: use default translation (C/32/64)
- for disks>1GB: - for disks>1GB:
- take current geometry from the partition table - 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 ie. either (C/32/64) or (C/63/255)). This can be extended translation
even if it's not enabled in the driver. even if it's not enabled in the driver.
@ -161,7 +181,8 @@ geometry right in most cases:
disks. disks.
REFERENCES USED: References Used
===============
"AIC-6260 SCSI Chip Specification", Adaptec Corporation. "AIC-6260 SCSI Chip Specification", Adaptec Corporation.
@ -177,7 +198,7 @@ REFERENCES USED:
Drew Eckhardt (drew@cs.colorado.edu) Drew Eckhardt (drew@cs.colorado.edu)
Eric Youngdale (eric@andante.org) Eric Youngdale (eric@andante.org)
special thanks to Eric Youngdale for the free(!) supplying the special thanks to Eric Youngdale for the free(!) supplying the
documentation on the chip. documentation on the chip.

View File

@ -10,5 +10,6 @@ Linux SCSI Subsystem
53c700 53c700
aacraid aacraid
advansys advansys
aha152x
scsi_transport_srp/figures scsi_transport_srp/figures

View File

@ -16,7 +16,7 @@ parameters may be changed at runtime by the command
See header of drivers/scsi/advansys.c. See header of drivers/scsi/advansys.c.
aha152x= [HW,SCSI] aha152x= [HW,SCSI]
See Documentation/scsi/aha152x.txt. See Documentation/scsi/aha152x.rst.
aha1542= [HW,SCSI] aha1542= [HW,SCSI]
Format: <portbase>[,<buson>,<busoff>[,<dmaspeed>]] Format: <portbase>[,<buson>,<busoff>[,<dmaspeed>]]

View File

@ -383,7 +383,7 @@ config SCSI_AHA152X
It is explained in section 3.3 of the SCSI-HOWTO, available from 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 <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 To compile this driver as a module, choose M here: the
module will be called aha152x. module will be called aha152x.

View File

@ -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" "aha152x: unable to verify geometry for disk with >1GB.\n"
" Using default translation. Please verify yourself.\n" " Using default translation. Please verify yourself.\n"
" Perhaps you need to enable extended translation in the driver.\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 { } else {
info_array[0] = info[0]; info_array[0] = info[0];