aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2014-03-31 03:57:18 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2014-03-31 03:57:18 +0000
commitd1ddad34402f8d773f7c71483c0f4b016e308751 (patch)
tree5d2d309636519c0f4a1be1b017b7f8903ac10675 /doc
parent15b4b8c012422d352a2b7e85b20682e0b02df464 (diff)
downloadsg3_utils-d1ddad34402f8d773f7c71483c0f4b016e308751.tar.gz
sg_lib_data: sync asc/ascq codes with T10 dated 20140320
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@562 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg_compare_and_write.86
-rw-r--r--doc/sg_decode_sense.84
-rw-r--r--doc/sg_format.858
-rw-r--r--doc/sg_luns.86
-rw-r--r--doc/sg_persist.85
5 files changed, 48 insertions, 31 deletions
diff --git a/doc/sg_compare_and_write.8 b/doc/sg_compare_and_write.8
index 401982df..68fa60e9 100644
--- a/doc/sg_compare_and_write.8
+++ b/doc/sg_compare_and_write.8
@@ -1,4 +1,4 @@
-.TH "COMPARE AND WRITE" "8" "August 2013" "sg3_utils\-1.37" SG3_UTILS
+.TH "COMPARE AND WRITE" "8" "March 2014" "sg3_utils\-1.38" SG3_UTILS
.SH NAME
sg_compare_and_write \- send the SCSI COMPARE AND WRITE command
.SH SYNOPSIS
@@ -51,7 +51,7 @@ the offset of the first byte mismatch). To suppress these messages use the
\fI\-\-quiet\fR option. With or without the \fI\-\-quiet\fR option the exit
status will be set to 14.
.PP
-This command is defined in SBC\-3 whose most recent revision is 35f. SBC\-3
+This command is defined in SBC\-3 whose most recent revision is 36. SBC\-3
and other SCSI documents can be found at http://www.t10.org .
.SH OPTIONS
Arguments to long options are mandatory for short options as well.
@@ -137,7 +137,7 @@ Eric Seppanen.
.SH "REPORTING BUGS"
Report bugs to shahar.salzman@kaminario.com or dgilbert@interlog.com
.SH COPYRIGHT
-Copyright \(co 2012\-2013 Kaminario Technologies LTD
+Copyright \(co 2012\-2014 Kaminario Technologies LTD
.br
Redistribution and use in source and binary forms, with or without
diff --git a/doc/sg_decode_sense.8 b/doc/sg_decode_sense.8
index 6820df80..47817d80 100644
--- a/doc/sg_decode_sense.8
+++ b/doc/sg_decode_sense.8
@@ -1,4 +1,4 @@
-.TH SG_DECODE_SENSE "8" "January 2014" "sg3_utils\-1.38" SG3_UTILS
+.TH SG_DECODE_SENSE "8" "March 2014" "sg3_utils\-1.38" SG3_UTILS
.SH NAME
sg_decode_sense \- decode SCSI sense data
.SH SYNOPSIS
@@ -12,7 +12,7 @@ sg_decode_sense \- decode SCSI sense data
This utility takes SCSI sense data in binary or as a sequence of
ASCII hexadecimal bytes and decodes it. The primary reference for the
decoding is SPC\-3 ANSI INCITS 408-2005 and the most recent draft
-SPC\-4 revision 29 which can be found at http://www.t10.org and other
+SPC\-4 revision 36s which can be found at http://www.t10.org and other
locations on the internet.
.PP
SCSI sense data is often found in kernel log files as a result of
diff --git a/doc/sg_format.8 b/doc/sg_format.8
index a77f5507..b2e5090a 100644
--- a/doc/sg_format.8
+++ b/doc/sg_format.8
@@ -1,4 +1,4 @@
-.TH SG_FORMAT "8" "January 2014" "sg3_utils\-1.38" SG3_UTILS
+.TH SG_FORMAT "8" "March 2014" "sg3_utils\-1.38" SG3_UTILS
.SH NAME
sg_format \- format or resize a SCSI disk (perhaps change its block size)
.SH SYNOPSIS
@@ -47,7 +47,7 @@ section for more information.
Protection information is optional and is made up of 8 additional bytes
associated with each logical block. Four protection types are defined
with protection type 0 being no additional protection bytes. See the
-PROTECTION TYPES section below for more information.
+PROTECTION INFORMATION section below for more information.
.SH OPTIONS
Arguments to long options are mandatory for short options as well.
The options are arranged in alphabetical order based on the long
@@ -124,8 +124,8 @@ bit field (bits 7 and 6 of byte 1 in the cdb). Prior to that it was a single
bit field (bit 7 of byte 1 in the cdb) and there was an accompanying bit
called RTO_REQ (bit 6 of byte 1 in the cdb). The deprecated
options "\-\-pinfo" and "\-\-rto\-req" represent the older usage. This
-option should be used in their place. See the PROTECTION TYPES section below
-for more information.
+option should be used in their place. See the PROTECTION INFORMATION section
+below for more information.
.TP
\fB\-F\fR, \fB\-\-format\fR
issue a SCSI FORMAT UNIT command.
@@ -155,8 +155,8 @@ parameters (e.g. when '\-\-pie=PIE' is greater than zero).
\fB\-P\fR, \fB\-\-pfu\fR=\fIPFU\fR
sets the "Protection Field Usage" field in the parameter block associated
with a FORMAT UNIT command to \fIPFU\fR. The default value is 0, the only
-other defined value currently is 1. See the PROTECTION TYPES section below
-for more information.
+other defined value currently is 1. See the PROTECTION INFORMATION section
+below for more information.
.TP
\fB\-q\fR, \fB\-\-pie\fR=\fIPIE\fR
sets the "Protection Interval Exponent" field in the parameter block
@@ -229,7 +229,7 @@ FORMAT UNIT command waits until the format operation completes before
returning its response. This can be many hours on large disks. This
utility sets a 15 hour timeout on such a FORMAT UNIT command!
.SH LISTS
-The SBC\-3 draft (revision 29) defines PLIST, CLIST, DLIST and GLIST in
+The SBC\-3 draft (revision 36) defines PLIST, CLIST, DLIST and GLIST in
section 4.13 on "Medium defects". Briefly, the PLIST is the "primary"
list of manufacturer detected defects, the CLIST ("certification" list)
contains those detected during the format operation, the DLIST is a list of
@@ -247,20 +247,36 @@ the CLIST is generated and used during the format process.
.PP
The sg_format utility does not permit a user to provide a defect
list (i.e. DLIST).
-.SH PROTECTION TYPES
-SBC\-3 drafts have added several "protection types" to the "protection
-information" introduced in the SBC\-2 standard. See the "protection
-information" section (section 4.21 in draft SBC\-3 rev 29). 8 bytes of
-protection information are added to each logical block (a 2 byte "logical
-block guard" (CRC), a 2 byte "logical block application guard", and a 4
-byte "logical block reference tag"). SBC\-3 defines 4 protection
-types (types 0 to 3) with protection type 0 meaning no protection information
-is maintained.
-.PP
-A device that supports protection information (i.e. supports one or more
-protection types of 1 or higher) sets the "PROTECT" bit in its standard
-INQUIRY response. It also sets the SPT field in the EXTENDED INQUIRY VPD page
-response to indicate which protection types it supports. The current
+.SH PROTECTION INFORMATION
+Protection Information (PI) is additional information held with logical
+blocks so that an application and/or host bus adapter can check the
+correctness of those logical blocks. PI is placed in one or more
+protection intervals beside each logical block. A protection interval
+contains 8 bytes made up of a 2 byte "logical block guard" (CRC), a 2
+byte "logical block application guard", and a 4 byte "logical block
+reference tag". Devices with 512 byte logical block size typically have
+one protection interval appended, making its logical block data 520 bytes
+long. Devices with 4096 byte logical block size often have 8 protection
+intervals spread across its logical block data for a total size of 4160
+bytes. Note that for all other purposes the logical block size is considered
+to be 512 and 4096 bytes respectively.
+.PP
+SBC\-3 drafts have added several "protection types" to the PI introduced in
+the SBC\-2 standard. SBC\-3 defines 4 protection types (types 0 to 3) with
+protection type 0 meaning no PI is maintained. While a device may support
+one or more protection types, it can only be formatted with 1 of the 4. To
+change a device's protection type, it must be re\-formatted. For more
+information see the Protection Information in section 4.22 of draft SBC\-3
+revision 36.
+.PP
+A device that supports PI information (i.e. supports one or more protection
+types 1, 2 and 3) sets the "PROTECT" bit in its standard INQUIRY response. It
+also sets the SPT field in the EXTENDED INQUIRY VPD page response to indicate
+which protection types it supports. Given PROTECT=1 then SPT=0 implies the
+device supports PI type 1 only, SPT=1 implies the device supports PI types 1
+and 2, and various other non\-obvious mappings up to SPT=7 which implies
+protection types 1, 2 and 3 are supported. The
+.B current
protection type of a disk can be found in the "P_TYPE" and "PROT_EN"
fields in the response of a READ CAPACITY (16) command (e.g. with
the 'sg_readcap \-\-long' utility).
diff --git a/doc/sg_luns.8 b/doc/sg_luns.8
index 77d8226d..43ce5f3f 100644
--- a/doc/sg_luns.8
+++ b/doc/sg_luns.8
@@ -1,4 +1,4 @@
-.TH SG_LUNS "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
+.TH SG_LUNS "8" "March" "sg3_utils\-1.38" SG3_UTILS
.SH NAME
sg_luns \- send SCSI REPORT LUNS command or decode given LUN
.SH SYNOPSIS
@@ -68,7 +68,7 @@ output the SCSI response (i.e. the data-out buffer) in binary (to stdout).
\fB\-s\fR, \fB\-\-select\fR=\fISR\fR
this option sets the SELECT REPORT field (\fISR\fR) in the SCSI REPORT
LUNS command. The default value is 0. For detailed information see the
-REPORT LUNS command in SPC (most recent is SPC\-4 revision 36e in section
+REPORT LUNS command in SPC (most recent is SPC\-4 revision 36s in section
6.33). To simplify, for the I_T nexus associated with the \fIDEVICE\fR, the
meanings of the \fISR\fR values defined to date for SPC\-4 are:
.br
@@ -258,7 +258,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2004\-2013 Douglas Gilbert
+Copyright \(co 2004\-2014 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.
diff --git a/doc/sg_persist.8 b/doc/sg_persist.8
index 805382ce..0d348785 100644
--- a/doc/sg_persist.8
+++ b/doc/sg_persist.8
@@ -1,4 +1,4 @@
-.TH SG_PERSIST "8" "February 2014" "sg3_utils\-1.38" SG3_UTILS
+.TH SG_PERSIST "8" "March 2014" "sg3_utils\-1.38" SG3_UTILS
.SH NAME
sg_persist \- use SCSI PERSISTENT RESERVE command to access registrations
and reservations
@@ -228,7 +228,8 @@ The \fITIDS\fR argument can take one of several forms. It can be a
comma (or single space) separated list of ASCII hex bytes representing
a single TransportID as defined in SPC\-4. They are usually 24 bytes
long apart from in iSCSI. The \fITIDS\fR argument may be a transport
-specific form (e.g. "sas,5000c50005b32001"). The \fITIDS\fR argument
+specific form (e.g. "sas,5000c50005b32001" is clearer than and equivalent
+to the hex byte form: "6,0,0,0,5,0,c5,0,5,b3,20,1"). The \fITIDS\fR argument
may be "\-" in which case one or more TransportIDs can be read from stdin.
The \fITIDS\fR argument may be of the form "file=<name>" in which case
one or more TransportIDs can be read from a file called <name>. See