forked from Minki/linux
scsi: docs: convert scsi-generic.txt to ReST
Link: https://lore.kernel.org/r/f57b8ddf30397c2c7213e49634e5e9cbd4246368.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
fedd7a4d09
commit
d4d79340fb
@ -34,5 +34,6 @@ Linux SCSI Subsystem
|
||||
scsi-changer
|
||||
scsi_eh
|
||||
scsi_fc_transport
|
||||
scsi-generic
|
||||
|
||||
scsi_transport_srp/figures
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Notes on Linux SCSI Generic (sg) driver
|
||||
---------------------------------------
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
=======================================
|
||||
Notes on Linux SCSI Generic (sg) driver
|
||||
=======================================
|
||||
|
||||
20020126
|
||||
|
||||
Introduction
|
||||
============
|
||||
The SCSI Generic driver (sg) is one of the four "high level" SCSI device
|
||||
@ -18,7 +23,7 @@ and examples.
|
||||
Major versions of the sg driver
|
||||
===============================
|
||||
There are three major versions of sg found in the linux kernel (lk):
|
||||
- sg version 1 (original) from 1992 to early 1999 (lk 2.2.5) .
|
||||
- sg version 1 (original) from 1992 to early 1999 (lk 2.2.5) .
|
||||
It is based in the sg_header interface structure.
|
||||
- sg version 2 from lk 2.2.6 in the 2.2 series. It is based on
|
||||
an extended version of the sg_header interface structure.
|
||||
@ -29,12 +34,16 @@ There are three major versions of sg found in the linux kernel (lk):
|
||||
Sg driver documentation
|
||||
=======================
|
||||
The most recent documentation of the sg driver is kept at the Linux
|
||||
Documentation Project's (LDP) site:
|
||||
http://www.tldp.org/HOWTO/SCSI-Generic-HOWTO
|
||||
Documentation Project's (LDP) site:
|
||||
|
||||
- http://www.tldp.org/HOWTO/SCSI-Generic-HOWTO
|
||||
|
||||
This describes the sg version 3 driver found in the lk 2.4 series.
|
||||
|
||||
The LDP renders documents in single and multiple page HTML, postscript
|
||||
and pdf. This document can also be found at:
|
||||
http://sg.danny.cz/sg/p/sg_v3_ho.html
|
||||
|
||||
- http://sg.danny.cz/sg/p/sg_v3_ho.html
|
||||
|
||||
Documentation for the version 2 sg driver found in the lk 2.2 series can
|
||||
be found at http://sg.danny.cz/sg/. A larger version
|
||||
@ -45,23 +54,27 @@ found at http://www.torque.net/sg/p/original/SCSI-Programming-HOWTO.txt
|
||||
and in the LDP archives.
|
||||
|
||||
A changelog with brief notes can be found in the
|
||||
/usr/src/linux/include/scsi/sg.h file. Note that the glibc maintainers copy
|
||||
and edit this file (removing its changelog for example) before placing it
|
||||
in /usr/include/scsi/sg.h . Driver debugging information and other notes
|
||||
/usr/src/linux/include/scsi/sg.h file. Note that the glibc maintainers copy
|
||||
and edit this file (removing its changelog for example) before placing it
|
||||
in /usr/include/scsi/sg.h . Driver debugging information and other notes
|
||||
can be found at the top of the /usr/src/linux/drivers/scsi/sg.c file.
|
||||
|
||||
A more general description of the Linux SCSI subsystem of which sg is a
|
||||
A more general description of the Linux SCSI subsystem of which sg is a
|
||||
part can be found at http://www.tldp.org/HOWTO/SCSI-2.4-HOWTO .
|
||||
|
||||
|
||||
Example code and utilities
|
||||
==========================
|
||||
There are two packages of sg utilities:
|
||||
- sg3_utils for the sg version 3 driver found in lk 2.4
|
||||
- sg_utils for the sg version 2 (and original) driver found in lk 2.2
|
||||
|
||||
========= ==========================================================
|
||||
sg3_utils for the sg version 3 driver found in lk 2.4
|
||||
sg_utils for the sg version 2 (and original) driver found in lk 2.2
|
||||
and earlier
|
||||
========= ==========================================================
|
||||
|
||||
Both packages will work in the lk 2.4 series however sg3_utils offers more
|
||||
capabilities. They can be found at: http://sg.danny.cz/sg/sg3_utils.html and
|
||||
capabilities. They can be found at: http://sg.danny.cz/sg/sg3_utils.html and
|
||||
freecode.com
|
||||
|
||||
Another approach is to look at the applications that use the sg driver.
|
||||
@ -72,30 +85,34 @@ Mapping of Linux kernel versions to sg driver versions
|
||||
======================================================
|
||||
Here is a list of linux kernels in the 2.4 series that had new version
|
||||
of the sg driver:
|
||||
lk 2.4.0 : sg version 3.1.17
|
||||
lk 2.4.7 : sg version 3.1.19
|
||||
lk 2.4.10 : sg version 3.1.20 **
|
||||
lk 2.4.17 : sg version 3.1.22
|
||||
|
||||
** There were 3 changes to sg version 3.1.20 by third parties in the
|
||||
next six linux kernel versions.
|
||||
- lk 2.4.0 : sg version 3.1.17
|
||||
- lk 2.4.7 : sg version 3.1.19
|
||||
- lk 2.4.10 : sg version 3.1.20 [#]_
|
||||
- lk 2.4.17 : sg version 3.1.22
|
||||
|
||||
For reference here is a list of linux kernels in the 2.2 series that had
|
||||
.. [#] There were 3 changes to sg version 3.1.20 by third parties in the
|
||||
next six linux kernel versions.
|
||||
|
||||
For reference here is a list of linux kernels in the 2.2 series that had
|
||||
new version of the sg driver:
|
||||
lk 2.2.0 : original sg version [with no version number]
|
||||
lk 2.2.6 : sg version 2.1.31
|
||||
lk 2.2.8 : sg version 2.1.32
|
||||
lk 2.2.10 : sg version 2.1.34 [SG_GET_VERSION_NUM ioctl first appeared]
|
||||
lk 2.2.14 : sg version 2.1.36
|
||||
lk 2.2.16 : sg version 2.1.38
|
||||
lk 2.2.17 : sg version 2.1.39
|
||||
lk 2.2.20 : sg version 2.1.40
|
||||
|
||||
- lk 2.2.0 : original sg version [with no version number]
|
||||
- lk 2.2.6 : sg version 2.1.31
|
||||
- lk 2.2.8 : sg version 2.1.32
|
||||
- lk 2.2.10 : sg version 2.1.34 [SG_GET_VERSION_NUM ioctl first appeared]
|
||||
- lk 2.2.14 : sg version 2.1.36
|
||||
- lk 2.2.16 : sg version 2.1.38
|
||||
- lk 2.2.17 : sg version 2.1.39
|
||||
- lk 2.2.20 : sg version 2.1.40
|
||||
|
||||
The lk 2.5 development series has recently commenced and it currently
|
||||
contains sg version 3.5.23 which is functionally equivalent to sg
|
||||
version 3.1.22 found in lk 2.4.17 .
|
||||
version 3.1.22 found in lk 2.4.17.
|
||||
|
||||
|
||||
Douglas Gilbert
|
||||
|
||||
26th January 2002
|
||||
|
||||
dgilbert@interlog.com
|
||||
@ -14797,7 +14797,7 @@ M: Doug Gilbert <dgilbert@interlog.com>
|
||||
L: linux-scsi@vger.kernel.org
|
||||
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
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user