aboutsummaryrefslogtreecommitdiff
path: root/sg_sat_identify.8
diff options
context:
space:
mode:
Diffstat (limited to 'sg_sat_identify.8')
-rw-r--r--sg_sat_identify.865
1 files changed, 37 insertions, 28 deletions
diff --git a/sg_sat_identify.8 b/sg_sat_identify.8
index b4fb6171..7e7ef973 100644
--- a/sg_sat_identify.8
+++ b/sg_sat_identify.8
@@ -1,69 +1,71 @@
-.TH SG_SAT_IDENTIFY "8" "October 2006" "sg3_utils-1.22" SG3_UTILS
+.TH SG_SAT_IDENTIFY "8" "January 2007" "sg3_utils\-1.23" SG3_UTILS
.SH NAME
-sg_sat_identify \- call an ATA IDENTIFY (PACKET) DEVICE command via a
+sg_sat_identify \- sends a ATA IDENTIFY (PACKET) DEVICE command via a
SCSI to ATA Translation (SAT) layer
.SH SYNOPSIS
.B sg_sat_identify
-[\fI--chk_cond\fR] [\fI--help\fR] [\fI--hex\fR] [\fI--len=<12|16>\fR]
-[\fI--packet\fR] [\fI--raw\fR] [\fI--verbose\fR] [\fI--version\fR]
-\fI<device>\fR
+[\fI\-\-chk_cond\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-len=\fR12|16]
+[\fI\-\-packet\fR] [\fI\-\-raw\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR]
+\fIDEVICE\fR
.SH DESCRIPTION
.\" Add any additional description here
.PP
This utility sends either an ATA IDENTIFY DEVICE command or an ATA IDENTIFY
-PACKET DEVICE command and outputs the response. The devices that respond
-to these commands are ATA disks and ATAPI devices respectively. Rather
-than send these commands directly to the device they are sent via a SCSI
-transport which is assumed to contain a SCSI to ATA Translation (SAT)
-Layer (SATL). The SAT standard (latest draft: sat-r09.pdf at www.t10.org)
-defines two "ATA PASS-THROUGH" SCSI commands: one using a 16 byte "cdb"
+PACKET DEVICE command to \fIDEVICE\fR and outputs the response. The devices
+that respond to these commands are ATA disks and ATAPI devices respectively.
+Rather than send these commands directly to the device they are sent via a
+SCSI transport which is assumed to contain a SCSI to ATA Translation (SAT)
+Layer (SATL). The SAT standard (latest draft: sat\-r09.pdf at www.t10.org)
+defines two SCSI "ATA PASS\-THROUGH" commands: one using a 16 byte "cdb"
and the other with a 12 byte cdb. This utility defaults to using the 16
byte cdb variant.
.PP
The SATL may be in an operating system driver, in host bus adapter firmware
or in some external enclosure.
+.SH OPTIONS
+Arguments to long options are mandatory for short options as well.
.TP
---chk_cond | -c
-sets the bit of the same name in the ATA PASS-THROUGH SCSI command. The
+\fB\-c\fR, \fB\-\-chk_cond\fR
+sets the CK_COND bit in the ATA PASS\-THROUGH SCSI cdb. The
default setting is clear (i.e. 0). When set the SATL should yield a
sense buffer containing a ATA Result descriptor irrespective of whether
the command succeeded or failed. When clear the SATL should only yield
a sense buffer containing a ATA Result descriptor if the command failed.
.TP
---help | -h
+\fB\-h\fR, \fB\-\-help\fR
outputs the usage message summarizing command line options
-then exits. Ignores <device> if given.
+then exits. Ignores \fIDEVICE\fR if given.
.TP
---hex | -H
+\fB\-H\fR, \fB\-\-hex\fR
outputs the ATA IDENTIFY (PACKET) DEVICE response in hex. The default
-action (i.e. without any '-H' options) is to output the response in
+action (i.e. without any '\-H' options) is to output the response in
hex, grouped in 16 bit words (i.e. the ATA standard's preference).
When given once, the response is output in ASCII hex bytes (i.e. the
-SCSI standard's preference). When given twice (i.e. '-HH') the output
+SCSI standard's preference). When given twice (i.e. '\-HH') the output
is in hex, grouped in 16 bit words, the same as the default but without
-a header. When given thrice (i.e. '-HHH') the output is in hex, grouped in
-16 bit words, in a format that is acceptable for 'hdparm --Istdin' to
+a header. When given thrice (i.e. '\-HHH') the output is in hex, grouped in
+16 bit words, in a format that is acceptable for 'hdparm \-\-Istdin' to
process.
.TP
---len=<12|16> | -l <12|16>
-this is the length of the SCSI cdb used for the ATA PASS-THROUGH commands.
+\fB\-l\fR, \fB\-\-len\fR=12 | 16
+this is the length of the SCSI cdb used for the ATA PASS\-THROUGH commands.
The argument can either be 12 or 16. The default is 16. The larger cdb
size is needed for 48 bit LBA addressing of ATA devices. On the other
hand some SCSI transports cannot convey SCSI commands longer than 12 bytes.
.TP
---packet | -p
+\fB\-p\fR, \fB\-\-packet\fR
send an ATA IDENTIFY PACKET DEVICE command (via the SATL). The default
action is to send an ATA IDENTIFY DEVICE command.
.TP
---raw | -r
+\fB\-r\fR, \fB\-\-raw\fR
output the ATA IDENTIFY (PACKET) DEVICE response in binary. The output
should be piped to a file or another utility when this option is used.
The binary is sent to stdout, and errors are sent to stderr.
.TP
---verbose | -v
+\fB\-v\fR, \fB\-\-verbose\fR
increases the level or verbosity.
.TP
---version | -V
+\fB\-V\fR, \fB\-\-version\fR
print out version string
.SH NOTES
Since the response to the IDENTIFY (PACKET) DEVICE command is very
@@ -71,7 +73,14 @@ important for the correct use of an ATA(PI) device (and is typically the
first command sent), a SATL should provide an ATA Information VPD page
which contains the similar information.
.PP
-In the 2.4 series of Linux kernels the given device must be
+The SCSI ATA PASS\-THROUGH (12) command's opcode is 0xa1 and it clashes with
+the MMC set's BLANK command used by cd/dvd writers. So a SATL in front
+of an ATAPI device that uses MMC (i.e. has peripheral device type 5)
+probably should treat opcode 0xa1 as a BLANK command and send it through
+to the cd/dvd drive. The ATA PASS\-THROUGH (16) command's opcode (0x85)
+does not clash with anything so it is a better choice.
+.PP
+In the 2.4 series of Linux kernels the \fIDEVICE\fR must be
a SCSI generic (sg) device. In the 2.6 series block devices (e.g. disks
and ATAPI DVDs) can also be specified. For example "sg_inq /dev/sda"
will work in the 2.6 series kernels. From lk 2.6.6 other SCSI "char"
@@ -84,7 +93,7 @@ Written by Doug Gilbert
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2006 Douglas Gilbert
+Copyright \(co 2006\-2007 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.