SG3UTILS SGSATPHYEVENT(1M)
NAME
sgsatphyevent - Sends an ATA READ LOG EXT command via a
SAT pass through to fetch log page 11h which contains SATA
phy event counters
SYNOPSIS
sgsatphyevent [--ckcond] [--extend] [--help] [--hex]
[--ignore] [--len=1612] [--raw] [--reset] --verbose]
[--version] DEVICE
DESCRIPTION
This utility sends an ATA READ LOG EXT with the log page
("address") set to 11h to DEVICE and outputs the response.
Log page 11h is defined in the SATA 2.5 standard and con-
tains phy event counters. Rather than send this command
directly to the DEVICE, are sent via a SCSI transport which
is assumed to contain a SCSI to ATA Translation (SAT) Layer
(SATL). The SAT standard (SAT ANSI INCITS 431-2007, prior
draft: sat-r09.pdf at www.t10.org) defines two SCSI "ATA
PAS-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.
The SATL may be in an operating system driver, in host bus
adapter firmware or in some external enclosure.
OPTIONS
Arguments to long options are mandatory for short options as
well.
-c, --ckcond
sets the CKCOND bit in the ATA PAS-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.
-e, --extend
sets the EXTEND bit in the ATA PAS-THROUGH SCSI cdb.
The default setting is clear (i.e. 0). When set a 48
bit LBA command is sent to the device. This option has
no effect when --len=12.
-h, --help
outputs the usage message summarizing command line
options then exits. Ignores DEVICE if given.
-H, --hex
outputs the ATA READ LOG EXT response in hex. The
default action (i.e. without any '-H' options) is to
sg3utils-1.26 Last change: December 2007 1
SG3UTILS SGSATPHYEVENT(1M)
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 ASCI hex bytes (i.e. the
SCSI standard's preference). When given twice (i.e.
'-H') the output is in hex, grouped in 16 bit words,
the same as the default but without a header.
-i, --ignore
usually the phy counter identifier names are decoded.
When this option is given, the numeric value of the
identifier is output, the vendor flag, the data length
(in bytes) and the corresponding value.
-l, --len=16 12
this is the length of the SCSI cdb used for the ATA
PAS-THROUGH commands. The argument can either be 16
or 12. 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.
-r, --raw
output the ATA READ LOG EXT 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.
-R, --reset
reset the counters after the current values are
returned, decoded and displayed.
-v, --verbose
increases the level or verbosity.
-V, --version
print out version string
NOTES
The SCSI ATA PAS-THROUGH (12) command's opcode is 0xa1 and
it clashes with the MC set's BLANK command used by cd/dvd
writers. So a SATL in front of an ATAPI device that uses MC
(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 PAS-THROUGH (16) command's opcode
(0x85) does not clash with anything so it is a better
choice.
In the 2.4 series of Linux kernels the DEVICE 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
"sginq /dev/sda" will work in the 2.6 series kernels. From
lk 2.6.6 other SCSI "char" device names may be used as well
sg3utils-1.26 Last change: December 2007 2
SG3UTILS SGSATPHYEVENT(1M)
(e.g. "/dev/st0m").
EXIT STATUS
The exit status of sgsatidentify is 0 when it is success-
ful. Otherwise see the sg3utils(1M) man page.
AUTHOR
Written by Doug Gilbert
REPORTING BUGS
Report bugs to .
COPYRIGHT
Copyright O 2006-2007 Douglas Gilbert
This software is distributed under a FreeBSD license. There
is NO warranty; not even for MERCHANTABILITY or FITNES FOR
A PARTICULAR PURPOSE.
SEE ALSO
sgsatidentify(sg3utils), smprepphyerrlog(smputils),
sdparm(sdparm), hdparm(hdparm)
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWsg3utilsu
Interface Stability Committed
NOTES
Source for sg3utils is available on http:/opensolaris.org.
sg3utils-1.26 Last change: December 2007 3
|