aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README46
1 files changed, 34 insertions, 12 deletions
diff --git a/README b/README
index d184f97e..a18621f1 100644
--- a/README
+++ b/README
@@ -2,8 +2,8 @@
====================
Introduction
============
-This package contains low level utilities for devices that use
-a SCSI command set. Apart from SCSI parallel devices, the SCSI
+This package contains low level utilities for devices that use a SCSI
+command set. Apart from SCSI parallel interface (SPI) devices, the SCSI
command set is used by ATAPI devices (CD/DVDs and tapes), USB
mass storage devices, Fibre Channel disks and IEEE 1394 storage
devices (that use the "SBP" protocol).
@@ -31,7 +31,7 @@ and the Linux SCSI generic driver (and the scsi_debug driver) can be
found at http://www.torque.net/sg . The most recent release version
of sg3_utils and the most recent beta is on that page. There is also
a page describing the utilities in the sg3_utils and sg_utils packages:
-http://www.torque.net/sg/u_index.html . A copy of the "u_index.html"
+http://www.torque.net/sg/sg3_utils.html . A copy of the "sg3_utils.html"
file is in the "doc" subdirectory.
In the Linux 2.4 kernel series these utilities need to use the SCSI generic
@@ -90,9 +90,11 @@ utilities without depending on libsgutils.so . For example
does not depend on libsgutils.so . See the INSTALL file for more
information.
-All the utilities in the main directory have "man" pages. Additional
-information (including a version number) can be found towards the top
-of each ".c" file corresponding to each utility.
+All the utilities in the main directory have "man" pages. There is
+also a sg3_utils (8) man page that summarizes common facilities
+including exit statuses. Additional information (including a version
+number) can be found towards the top of each ".c" file corresponding
+to each utility.
The sg driver in Linux can be seen as having 3 distinct versions:
@@ -151,10 +153,10 @@ Here is list in alphabetical order of utilities found in the main directory
of the sg3_utils directory:
- sginfo, sgm_dd, sgp_dd, sg_dd, sg_emc_trespass, sg_get_config,
sg_format, sg_ident, sg_inq, sg_logs, sg_luns, sg_map, sg_map26,
- sg_modes, sg_opcodes, sg_persist, sg_prevent, sg_rbuf, sg_read,
+ sg_modes, sg_opcodes, sg_persist, sg_prevent, sg_rbuf, sg_rdac, sg_read,
sg_readcap, sg_read_long, sg_reassign, sg_request, sg_reset, sg_rmsn,
sg_rtpg, sg_scan, sg_senddiag, sg_ses, sg_start, sg_sync,
- sg_test_rwbuff, sg_turs, sg_verify, sg_write_long, sg_wr_mode
+ sg_test_rwbuff, sg_turs, sg_verify, sg_vpd, sg_write_long, sg_wr_mode
These utilities and the libsgutils.so library which they depend on are built
by the Makefile in the main directory. This Makefile does not invoke the
@@ -192,7 +194,10 @@ phys into a compliant jitter tolerance pattern (CJTPAT).
The "utils" subdirectory contains source and a Makefile to build
"hxascdmp" which accepts binary data from stdin (or a file on the
command line) and outputs an ASCII-HEX and ASCII representation of
-it. It is similar to the Unix od command.
+it. It is similar to the Unix od command. There is also code to
+sg_chk_asc.c which checks a given text file (typically a copy of
+http://www.t10.org/lists/asc-num.txt ) and checks it against the
+asc/ascq test strings held in sg_lib.c .
The "doc" subdirectory contains copies of web pages relevant to
the sg3_utils package. Currently it contains:
@@ -201,7 +206,8 @@ the sg3_utils package. Currently it contains:
- sg_io.html : describes the SG_IO ioctl used by sg3_utils. Looks
at differences between the lk 2.4 and 2.6 series;
including its use with block devices
- - u_index.html : a description of the sg3_utils package contents
+ - sg3_utils.html : a description of the sg3_utils package contents
+ - tools.html : a list of SCSI and storage tools with a summary and url
Notes for utilities without man pages
@@ -240,6 +246,22 @@ scsi device. This is only supported for lk >= 2.4.15 and for adapter
drivers that indicate that they have 16 byte CDB capability (otherwise
DID_ABORT will appear in the host_status).
+"sg_sat_identify" attempts to push an ATA IDENTIFY DEVICE or
+IDENTIFY pACKET DEVICE command through the SAT-defined ATA PASS
+THROUGH (16) SCSI command. If successful, the 256 word (512 byte)
+response is output.
+
+"sg_sat_chk_power" attempts to push an ATA CHECK POWER MODE command
+through the SAT-defined ATA PASS THROUGH (16) SCSI command. That
+ATA command needs to read the "FIS" registers after the command is
+completed which involves using the ATA Status Return (sense data)
+descriptor (as defined in SAT).
+
+"sg_sat_smart_rd_data" attempts to push an ATA SMART/READ DATA command
+through the SAT-defined ATA PASS THROUGH (16) SCSI command. If
+successful, the 256 word (512 byte) response is output.
+
+
Command line processing
=======================
These utilities can be divided into 3 groups when their handling of
@@ -255,7 +277,7 @@ The recent utilities that use "getopt_long" are, in alphabetical
order:
- sg_format sg_get_config sg_ident sg_luns sg_map26 sg_persist
sg_prevent sg_read_long sg_reassign sg_requests sg_rmsn sg_rtpg
- sg_ses sg_sync sg_test_rwbuf sg_verify sg_write_long sg_wr_mode
+ sg_ses sg_sync sg_test_rwbuf sg_verify sg_vpd sg_write_long sg_wr_mode
Linux header file problems
@@ -303,4 +325,4 @@ user). It is available for Linux and other operating systems.
See http://members.aol.com/plscsi .
Doug Gilbert
-18th April 2006
+6th July 2006