sg_dd: 'iflag=00,ff' places the 32 bit block address (big endian) into each block; sgp_dd: major rework, new: --chkaddr which checks for block address in each block

git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@916 6180dd3e-e324-4e3e-922d-17de1ae2f315

7 files changed, 56 insertions, 26 deletions

diff --git a/doc/sg_dd.8 b/doc/sg_dd.8
index 23b40b07..14290e07 100644
--- a/doc/sg_dd.8
+++ b/doc/sg_dd.8
@@ -293,7 +293,13 @@ Here is a list of flags and their meanings:
 this flag is only active with \fIiflag=\fR and when given replaces
 \fIif=IFILE\fR. If both are given an error is generated. The input will
 be a stream of zeros, similar to using "if=/dev/zero" alone (but a little
-quicker).
+quicker), apart from the following case.
+.br
+If 'iflag=00,ff' is given then the block address (lower 32 bits, in 4
+bytes, big endian) is placed, multiple times, in each block. The block
+address takes into account the \fIskip=SKIP\fR setting. The
+.B sgp_dd
+utility has a \fI\-\-chkaddr\fR option that complements this option.
 .TP
 append
 causes the O_APPEND flag to be added to the open of \fIOFILE\fR. For regular
@@ -356,8 +362,12 @@ causes the O_EXCL flag to be added to the open of \fIIFILE\fR and/or
 .TP
 ff
 this flag is only active with \fIiflag=\fR and when given replaces
-\fIif=IFILE\fR. If both are given an error is generated. The input will
-be a stream of 0xff bytes (or all bits set).
+\fIif=IFILE\fR. If both are given an error is generated. The input will be
+a stream of 0xff bytes (or all bits set), apart from the following case.
+.br
+If 'iflag=00,ff' is given then the block address (lower 32 bits, in 4
+bytes, big endian) is placed, multiple times, in each block. The block
+address takes into account the \fIskip=SKIP\fR setting.
 .TP
 flock
 after opening the associated file (i.e. \fIIFILE\fR and/or \fIOFILE\fR)
diff --git a/doc/sg_opcodes.8 b/doc/sg_opcodes.8
index cff8684a..bdae3b5c 100644
--- a/doc/sg_opcodes.8
+++ b/doc/sg_opcodes.8
@@ -1,4 +1,4 @@
-.TH SG_OPCODES "8" "March 2020" "sg3_utils\-1.46" SG3_UTILS
+.TH SG_OPCODES "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS
 .SH NAME
 sg_opcodes \- report supported SCSI commands or task management functions
 .SH SYNOPSIS
@@ -89,7 +89,7 @@ sense key of "illegal request".
 additionally prints out an indication (0 or 1) whether the command
 effects all logical units in the containing target. MLU (Multiple Logical
 Units) is a bit in the REPORT SUPPORTED OPERATION CODES response
-introduced by proposal 18-045r1 (and possibly in spc5r20). Without
+introduced by proposal 18\-045r1 (and possibly in spc5r20). Without
 the option, the default output format which lists all opcodes, does
 not include a MLU indication.
 .TP
diff --git a/doc/sg_requests.8 b/doc/sg_requests.8
index 81db55fe..f6a012c5 100644
--- a/doc/sg_requests.8
+++ b/doc/sg_requests.8
@@ -1,4 +1,4 @@
-.TH SG_REQUESTS "8" "July 2018" "sg3_utils\-1.45" SG3_UTILS
+.TH SG_REQUESTS "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS
 .SH NAME
 sg_requests \- send one or more SCSI REQUEST SENSE commands
 .SH SYNOPSIS
@@ -32,7 +32,7 @@ but will most likely be ignored.
 when used once it changes the REQUEST SENSE opcode from 0x3 to 0xff which
 should be rejected by the \fIDEVICE\fR. There is a small chance that the
 device vendor has implemented a vendor specific command at that opcode (0xff).
-When used twice the pass-through call to send the SCSI command is bypassed.
+When used twice the pass\-through call to send the SCSI command is bypassed.
 The idea here is to measure the user space overhead of this package's
 library to set up and process the response of a SCSI command. This option
 will be typically used with the \fI\-\-num=NUM\fR and \fI\-\-time\fR
@@ -130,7 +130,7 @@ Written by Douglas Gilbert.
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2004\-2017 Douglas Gilbert
+Copyright \(co 2004\-2021 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_ses.8 b/doc/sg_ses.8
index 00471afc..4afcb2b4 100644
--- a/doc/sg_ses.8
+++ b/doc/sg_ses.8
@@ -1,14 +1,15 @@
-.TH SG_SES "8" "May 2021" "sg3_utils\-1.47" SG3_UTILS
+.TH SG_SES "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS
 .SH NAME
 sg_ses \- access a SCSI Enclosure Services (SES) device
 .SH SYNOPSIS
 .B sg_ses
-[\fI\-\-all\fR] [\fI\-\-descriptor=DES\fR] [\fI\-\-dev\-slot\-num=SN\fR]
-[\fI\-\-eiioe=A_F\fR] [\fI\-\-filter\fR] [\fI\-\-get=STR\fR] [\fI\-\-hex\fR]
-[\fI\-\-index=IIA\fR | \fI\-\-index=TIA,II\fR] [\fI\-\-inner\-hex\fR]
-[\fI\-\-join\fR] [\fI\-\-maxlen=LEN\fR] [\fI\-\-page=PG\fR] [\fI\-\-quiet\fR]
-[\fI\-\-raw\fR] [\fI\-\-readonly\fR] [\fI\-\-sas\-addr=SA\fR]
-[\fI\-\-status\fR] [\fI\-\-verbose\fR] [\fI\-\-warn\fR] \fIDEVICE\fR
+[\fI\-\-all\fR] [\fI\-\-ALL\fR] [\fI\-\-descriptor=DES\fR]
+[\fI\-\-dev\-slot\-num=SN\fR] [\fI\-\-eiioe=A_F\fR] [\fI\-\-filter\fR]
+[\fI\-\-get=STR\fR] [\fI\-\-hex\fR] [\fI\-\-index=IIA\fR |
+\fI\-\-index=TIA,II\fR] [\fI\-\-inner\-hex\fR] [\fI\-\-join\fR]
+[\fI\-\-maxlen=LEN\fR] [\fI\-\-page=PG\fR] [\fI\-\-quiet\fR] [\fI\-\-raw\fR]
+[\fI\-\-readonly\fR] [\fI\-\-sas\-addr=SA\fR] [\fI\-\-status\fR]
+[\fI\-\-verbose\fR] [\fI\-\-warn\fR] \fIDEVICE\fR
 .PP
 .B sg_ses
 \fI\-\-control\fR [\fI\-\-byte1=B1\fR] [\fI\-\-clear=STR\fR]
@@ -92,6 +93,15 @@ shows (almost) all status dpages, following references and presenting
 the information as a long list whose indentation indicates the level
 of nesting. This option is actually the same as \fI\-\-join\fR, see its
 description for more information.
+.br
+If used twice, adds threshold elements to output (if they are available).
+So it is the same as using \fI\-\-join\fRtwice.
+.TP
+\fB\-z\fR, \fB\-\-ALL\fR
+shows (almost) all status dpages, following references and presenting
+the information as a long list whose indentation indicates the level
+of nesting. Also shows the threshold elements if they are available.
+This option is the same as using  \fI\-\-join\fR rwice.
 .TP
 \fB\-b\fR, \fB\-\-byte1\fR=\fIB1\fR
 some modifiable dpages may need byte 1 (i.e. the second byte) set. In the
diff --git a/doc/sg_write_x.8 b/doc/sg_write_x.8
index 95352aae..e907c341 100644
--- a/doc/sg_write_x.8
+++ b/doc/sg_write_x.8
@@ -1,4 +1,4 @@
-.TH SG_WRITE_X "8" "June 2020" "sg3_utils\-1.45" SG3_UTILS
+.TH SG_WRITE_X "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS
 .SH NAME
 sg_write_x \- SCSI WRITE normal/ATOMIC/SAME/SCATTERED/STREAM, ORWRITE commands
 .SH SYNOPSIS
@@ -133,11 +133,12 @@ range descriptors which is required by the WRITE SCATTERED cdb. In the
 absence of other information the logic will take a degenerate LBA range
 descriptor as a terminator of the scatter list.
 .PP
-The current reference for these commands is draft SBC\-4 (T10/BSR INCITS
-506) revision 15 dated 9 November 2017. All six SCSI commands are described
-in that document. WRITE ATOMIC was added in SBC\-4 revision 3; WRITE STREAM
-was added in SBC\-4 revision 7; WRITE SCATTERED was added in SBC\-4
-revision 11 while the others are in the SBC\-3 standard.
+The reference for these commands is SBC\-4 (T10/BSR INCITS 506\-2021)
+and draft SBC\-5 INCITS 571 revision 1 dated 21 May 2021. All six SCSI
+commands are described in those documents. WRITE ATOMIC was added in
+SBC\-4 revision 3; WRITE STREAM was added in SBC\-4 revision 7; WRITE
+SCATTERED was added in SBC\-4 revision 11 while the others are in the
+previous SBC\-3 standard.
 .SH OPTIONS
 Arguments to long options are mandatory for short options as well.
 The options are arranged in alphabetical order based on the long
@@ -591,7 +592,7 @@ Written by Douglas Gilbert.
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2017\-2020 Douglas Gilbert
+Copyright \(co 2017\-2021 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_zone.8 b/doc/sg_zone.8
index a2aa45fc..bc916423 100644
--- a/doc/sg_zone.8
+++ b/doc/sg_zone.8
@@ -12,7 +12,7 @@ sg_zone \- send a SCSI ZONE modifying command
 .PP
 Sends a SCSI OPEN ZONE, CLOSE ZONE, FINISH ZONE, REMOVE ELEMENT AND MODIFY
 ZONES or SEQUENTIALIZE ZONE command to the \fIDEVICE\fR. All but the last
-two are found in the ZBC standard (INCITS 536-2016). The REMOVE ELEMENT AND
+two are found in the ZBC standard (INCITS 536-\2016). The REMOVE ELEMENT AND
 MODIFY ZONES command was added in zbc2r07 while the SEQUENTIALIZE ZONE command
 was added in zbc2r01b.
 .PP
diff --git a/doc/sgp_dd.8 b/doc/sgp_dd.8
index a8899464..7f6115da 100644
--- a/doc/sgp_dd.8
+++ b/doc/sgp_dd.8
@@ -1,4 +1,4 @@
-.TH SGP_DD "8" "February 2020" "sg3_utils\-1.45" SG3_UTILS
+.TH SGP_DD "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS
 .SH NAME
 sgp_dd \- copy data to and from files and devices, especially SCSI
 devices
@@ -10,7 +10,8 @@ devices
 .PP
 [\fIbpt=BPT\fR] [\fIcoe=\fR0|1] [\fIcdbsz=\fR6|10|12|16] [\fIdeb=VERB\fR]
 [\fIdio=\fR0|1] [\fIsync=\fR0|1] [\fIthr=THR\fR] [\fItime=\fR0|1]
-[\fIverbose=VERB\fR] [\fI\-\-dry\-run\fR] [\fI\-\-verbose\fR]
+[\fIverbose=VERB\fR] [\fI\-\-chkaddr\fR] [\fI\-\-dry\-run\fR]
+[\fI\-\-verbose\fR]
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP
@@ -134,6 +135,14 @@ performed, outputting the results (to stderr) at completion. When
 increase verbosity. Same as \fIdeb=VERB\fR. Added for compatibility with
 sg_dd and sgm_dd.
 .TP
+\fB\-c\fR, \fB\-\-chkaddr\fR
+this option checks that every block read contains the (32 bit) block address
+of that block. If that check fails, the copy exits with a miscompare error.
+This check complements the 'sg_dd iflag=00,ff' generation of blocks that
+contain their own (32 bit, big endian) block address. When \fI\-\-chkaddr\fR
+is used once, only the first block address in each block is checked. When
+used twice, each block address (that fits in a block) is checked.
+.TP
 \fB\-d\fR, \fB\-\-dry\-run\fR
 does all the command line parsing and preparation but bypasses the actual
 copy or read. That preparation may include opening \fIIFILE\fR or
@@ -321,7 +330,7 @@ Written by Douglas Gilbert and Peter Allworth.
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2000\-2020 Douglas Gilbert
+Copyright \(co 2000\-2021 Douglas Gilbert
 .br
 This software is distributed under the GPL version 2. There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.