mirror of
https://github.com/torvalds/linux.git
synced 2024-12-26 12:52:30 +00:00
scsi: docs: convert scsi.txt to ReST
Link: https://lore.kernel.org/r/c617b37769a82901def0fed3d236a25995c4e160.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
Martin K. Petersen
parent
a0b1643bee
commit
b7223d9bde
@ -37,5 +37,6 @@ Linux SCSI Subsystem
|
||||
scsi-generic
|
||||
scsi_mid_low_api
|
||||
scsi-parameters
|
||||
scsi
|
||||
|
||||
scsi_transport_srp/figures
|
||||
|
||||
@ -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 .
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user