sg_decode sense: add --cdb option; add stdint.h to some headers

git-svn-id: svn://localhost/trunk@692 6180dd3e-e324-4e3e-922d-17de1ae2f315

Author: doug-gilbert

ChangeLog

@@ -2,10 +2,11 @@ Each utility has its own version number, date of last change and
 some description at the top of its ".c" file. All utilities in the main
 directory have their own "man" pages. There is also a sg3_utils man page.
 
-Changelog for sg3_utils-1.43 [20160407] [svn: r691]
+Changelog for sg3_utils-1.43 [20160423] [svn: r692]
   - sg_senddiag: add --timeout=SEC option
   - sg_sanitize: add --timeout=SEC option
   - sg_format: add --timeout=SEC option
+  - sg_decode sense: add --cdb option
   - sg_ses: handle 2 bit EIIOE field in aes dpage
     - expand join handling of SAS connectors and others
     - expand join debug code

doc/sg_decode_sense.8

@@ -1,18 +1,18 @@
-.TH SG_DECODE_SENSE "8" "August 2014" "sg3_utils\-1.40" SG3_UTILS
+.TH SG_DECODE_SENSE "8" "April 2016" "sg3_utils\-1.43" SG3_UTILS
 .SH NAME
 sg_decode_sense \- decode SCSI sense data
 .SH SYNOPSIS
 .B sg_decode_sense
-[\fI\-\-binary=FN\fR] [\fI\-\-file=FN\fR] [\fI\-\-help\fR]
+[\fI\-\-binary=FN\fR] [\fI\-\-cdb\fR] [\fI\-\-file=FN\fR] [\fI\-\-help\fR]
 [\fI\-\-hex\fR] [\fI\-\-nospace\fR] [\fI\-\-status=SS\fR]
 [\fI\-\-verbose\fR] [\fI\-\-version\fR] [\fI\-\-write=WFN\fR]
 [H1 H2 H3 ...]
 .SH DESCRIPTION
 .\" Add any additional description here
 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 37 which can be found at http://www.t10.org and other
+decoding is SPC\-4 ANSI INCITS 513-2015 and the most recent draft
+SPC\-5 revision 8 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
@@ -22,20 +22,29 @@ Sense data could be up to 252 bytes long but typically is much shorter
 than that, 18 bytes long is often seen and is usually associated with
 the older "fixed" format sense data.
 .PP
-The sense data can be provided on the command line or in a file. If
-given on the command line the sense data should be a sequence of
-hexadecimal bytes separated by space. Alternatively a file can be
-given with the contents in binary or ASCII hexadecimal bytes. The
-latter form can contain several lines each with none, one or more
-ASCII hexadecimal bytes separated by space (comma or tab). The
-hash symbol may appear and it and the rest of the line is ignored
-making it useful for comments.
+The sense data can be provided on the command line or in a file. If given
+on the command line the sense data should be a sequence of hexadecimal bytes
+separated by space. Alternatively a file can be given with the contents in
+binary or ASCII hexadecimal bytes. The latter form can contain several lines
+each with none, one or more ASCII hexadecimal bytes separated by
+space (comma or tab). The hash symbol may appear and it and the rest of the
+line is ignored making it useful for comments.
+.PP
+If the \fI\-\-cdb\fR option is given then rather than viewing the given hex
+arguments as sense data, it is viewed as a SCSI command descriptor
+block (CDB). In this case the command name is printed out. That name is
+based on the first hex byte given (know as the opcode) and optionally on
+another field called the "service action". 
 .SH OPTIONS
 Arguments to long options are mandatory for short options as well.
 .TP
 \fB\-b\fR, \fB\-\-binary\fR=\fIFN\fR
 the sense data is read in binary from a file called \fIFN\fR.
 .TP
+\fB\-c\fR, \fB\-\-cdb\fR
+treat the given string of hex arguments as bytes in a SCSI CDB and
+decode the command name.
+.TP
 \fB\-h\fR, \fB\-\-help\fR
 output the usage message then exit.
 .TP
@@ -123,7 +132,7 @@ Written by Douglas Gilbert.
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2010\-2014 Douglas Gilbert
+Copyright \(co 2010\-2016 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.

examples/sg__sat_set_features.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2007 Douglas Gilbert.
+ * Copyright (c) 2006-2016 Douglas Gilbert.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -58,7 +58,7 @@
 
 #define EBUFF_SZ 256
 
-static char * version_str = "1.03 20070719";
+static char * version_str = "1.04 20160423";
 
 static struct option long_options[] = {
         {"count", required_argument, 0, 'c'},
@@ -117,7 +117,7 @@ int main(int argc, char * argv[])
     int t_dir = 1;      /* 0 -> to device, 1 -> from device */
     int byte_block = 1; /* 0 -> bytes, 1 -> 512 byte blocks */
     int t_length = 0;   /* 0 -> no data transferred, 2 -> sector count */
-    const unsigned char * ucp = NULL;
+    const unsigned char * bp = NULL;
 
     memset(device_name, 0, sizeof(device_name));
     while (1) {
@@ -241,36 +241,36 @@ int main(int argc, char * argv[])
         break;
     case SG_LIB_CAT_RECOVERED:  /* sat-r09 uses this sk */
     case SG_LIB_CAT_NO_SENSE:   /* earlier SAT drafts used this */
-        ucp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
-                                      SAT_ATA_RETURN_DESC);
-        if (NULL == ucp) {
+        bp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
+                                     SAT_ATA_RETURN_DESC);
+        if (NULL == bp) {
             if (verbose > 1)
                 printf("ATA Return Descriptor expected in sense but not "
                        "found\n");
             sg_chk_n_print3("ATA_16 command error", &io_hdr, 1);
         } else if (verbose)
             sg_chk_n_print3("ATA Return Descriptor", &io_hdr, 1);
-        if (ucp && ucp[3]) {
-            if (ucp[3] & 0x4)
+        if (bp && bp[3]) {
+            if (bp[3] & 0x4)
                 printf("error in returned FIS: aborted command\n");
             else
-                printf("error=0x%x, status=0x%x\n", ucp[3], ucp[13]);
+                printf("error=0x%x, status=0x%x\n", bp[3], bp[13]);
         }
         break;
     default:
         fprintf(stderr, "unexpected SCSI sense category\n");
-        ucp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
-                                      SAT_ATA_RETURN_DESC);
-        if (NULL == ucp)
+        bp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
+                                     SAT_ATA_RETURN_DESC);
+        if (NULL == bp)
             sg_chk_n_print3("ATA_16 command error", &io_hdr, 1);
         else if (verbose)
             sg_chk_n_print3("ATA Return Descriptor, as expected",
                              &io_hdr, 1);
-        if (ucp && ucp[3]) {
-            if (ucp[3] & 0x4)
+        if (bp && bp[3]) {
+            if (bp[3] & 0x4)
                 printf("error in returned FIS: aborted command\n");
             else
-                printf("error=0x%x, status=0x%x\n", ucp[3], ucp[13]);
+                printf("error=0x%x, status=0x%x\n", bp[3], bp[13]);
         }
         break;
     }

examples/sg_sat_chk_power.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2012 Douglas Gilbert.
+ * Copyright (c) 2006-2016 Douglas Gilbert.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -56,7 +56,7 @@
 
 #define EBUFF_SZ 256
 
-static const char * version_str = "1.04 20120319";
+static const char * version_str = "1.05 20160423";
 
 
 #if 0
@@ -112,7 +112,7 @@ int main(int argc, char * argv[])
     int t_dir = 1;      /* 0 -> to device, 1 -> from device */
     int byte_block = 1; /* 0 -> bytes, 1 -> 512 byte blocks */
     int t_length = 0;   /* 0 -> no data transferred, 2 -> sector count */
-    const unsigned char * ucp = NULL;
+    const unsigned char * bp = NULL;
 
     for (k = 1; k < argc; ++k) {
         if (0 == strcmp(argv[k], "-v"))
@@ -189,43 +189,43 @@ int main(int argc, char * argv[])
     case SG_LIB_CAT_RECOVERED:  /* sat-r09 (latest) uses this sk */
     case SG_LIB_CAT_NO_SENSE:   /* earlier SAT drafts used this */
         /* XXX: Until the spec decides which one to go with. 20060607 */
-        ucp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
-                                      SAT_ATA_RETURN_DESC);
-        if (NULL == ucp) {
+        bp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
+                                     SAT_ATA_RETURN_DESC);
+        if (NULL == bp) {
             if (verbose > 1)
                 printf("ATA Return Descriptor expected in sense but not "
                        "found\n");
             sg_chk_n_print3("ATA_16 command error", &io_hdr, 1);
         } else if (verbose)
             sg_chk_n_print3("ATA Return Descriptor, as expected",
                              &io_hdr, 1);
-        if (ucp && ucp[3]) {
-            if (ucp[3] & 0x4)
+        if (bp && bp[3]) {
+            if (bp[3] & 0x4)
                 printf("error in returned FIS: aborted command\n");
             else
-                printf("error=0x%x, status=0x%x\n", ucp[3], ucp[13]);
+                printf("error=0x%x, status=0x%x\n", bp[3], bp[13]);
         }
         break;
     default:
         fprintf(stderr, "unexpected SCSI sense category\n");
-        ucp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
-                                      SAT_ATA_RETURN_DESC);
-        if (NULL == ucp)
+        bp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
+                                     SAT_ATA_RETURN_DESC);
+        if (NULL == bp)
             sg_chk_n_print3("ATA_16 command error", &io_hdr, 1);
         else if (verbose)
             sg_chk_n_print3("ATA Return Descriptor, as expected",
                              &io_hdr, 1);
-        if (ucp && ucp[3]) {
-            if (ucp[3] & 0x4)
+        if (bp && bp[3]) {
+            if (bp[3] & 0x4)
                 printf("error in returned FIS: aborted command\n");
             else
-                printf("error=0x%x, status=0x%x\n", ucp[3], ucp[13]);
+                printf("error=0x%x, status=0x%x\n", bp[3], bp[13]);
         }
         break;
     }
 
-    if (ucp) {
-        switch (ucp[5]) {       /* sector_count (7:0) */
+    if (bp) {
+        switch (bp[5]) {       /* sector_count (7:0) */
         case 0xff:
             printf("In active mode or idle mode\n");
             break;
@@ -242,7 +242,7 @@ int main(int argc, char * argv[])
             printf("In standby mode\n");
             break;
         default:
-            printf("unknown power mode (sector count) value=0x%x\n", ucp[5]);
+            printf("unknown power mode (sector count) value=0x%x\n", bp[5]);
             break;
         }
     } else

examples/sg_sat_smart_rd_data.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2007 Douglas Gilbert.
+ * Copyright (c) 2006-2016 Douglas Gilbert.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -57,7 +57,7 @@
 
 #define EBUFF_SZ 256
 
-static char * version_str = "1.02 20070130";
+static char * version_str = "1.03 20160423";
 
 int main(int argc, char * argv[])
 {
@@ -77,7 +77,7 @@ int main(int argc, char * argv[])
     int t_dir = 1;      /* 0 -> to device, 1 -> from device */
     int byte_block = 1; /* 0 -> bytes, 1 -> 512 byte blocks */
     int t_length = 2;   /* 0 -> no data transferred, 2 -> sector count */
-    const unsigned char * ucp = NULL;
+    const unsigned char * bp = NULL;
 
     for (k = 1; k < argc; ++k) {
         if (0 == strcmp(argv[k], "-v"))
@@ -158,17 +158,17 @@ int main(int argc, char * argv[])
         ok = 1;
         break;
     case SG_LIB_CAT_RECOVERED:
-        ucp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
-                                      SAT_ATA_RETURN_DESC);
-        if (NULL == ucp) {
+        bp = sg_scsi_sense_desc_find(sense_buffer, sizeof(sense_buffer),
+                                     SAT_ATA_RETURN_DESC);
+        if (NULL == bp) {
             if (verbose > 1)
                 printf("ATA Return Descriptor expected in sense but not "
                        "found\n");
             sg_chk_n_print3("ATA_16 command error", &io_hdr, 1);
         } else if (verbose)
             sg_chk_n_print3("ATA Return Descriptor", &io_hdr, 1);
-        if (ucp && ucp[3])
-            printf("error=0x%x, status=0x%x\n", ucp[3], ucp[13]);
+        if (bp && bp[3])
+            printf("error=0x%x, status=0x%x\n", bp[3], bp[13]);
         else
             ok = 1;
         break;

include/sg_cmds_basic.h

@@ -2,7 +2,7 @@
 #define SG_CMDS_BASIC_H
 
 /*
- * Copyright (c) 2004-2014 Douglas Gilbert.
+ * Copyright (c) 2004-2016 Douglas Gilbert.
  * All rights reserved.
  * Use of this source code is governed by a BSD-style
  * license that can be found in the BSD_LICENSE file.
@@ -21,6 +21,8 @@
  * sg_warnings_strm.
  */
 
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif

include/sg_cmds_extra.h

@@ -8,6 +8,8 @@
  * license that can be found in the BSD_LICENSE file.
  */
 
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif

lib/sg_cmds_extra.c

@@ -1561,7 +1561,7 @@ sg_ll_ata_pt(int sg_fd, const unsigned char * cdbp, int cdb_len,
                 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
     unsigned char sense_b[SENSE_BUFF_LEN];
     unsigned char * sp;
-    const unsigned char * ucp;
+    const unsigned char * bp;
     struct sg_pt_base * ptvp;
     const char * cnamep;
     char b[256];
@@ -1654,11 +1654,11 @@ sg_ll_ata_pt(int sg_fd, const unsigned char * cdbp, int cdb_len,
         }
         if (ata_return_dp && (max_ata_return_len > 0))  {
             /* search for ATA return descriptor */
-            ucp = sg_scsi_sense_desc_find(sp, slen, 0x9);
-            if (ucp) {
-                k = ucp[1] + 2;
+            bp = sg_scsi_sense_desc_find(sp, slen, 0x9);
+            if (bp) {
+                k = bp[1] + 2;
                 k = (k > max_ata_return_len) ? max_ata_return_len : k;
-                memcpy(ata_return_dp, ucp, k);
+                memcpy(ata_return_dp, bp, k);
             } else
                 ata_return_dp[0] = 0x0;
         }

lib/sg_cmds_mmc.c

@@ -186,11 +186,11 @@ sg_ll_get_config(int sg_fd, int rt, int starting, void * resp,
         }
     } else {
         if ((verbose > 2) && (ret > 3)) {
-            unsigned char * ucp;
+            unsigned char * bp;
             int len;
 
-            ucp = (unsigned char *)resp;
-            len = sg_get_unaligned_be32(ucp + 0);
+            bp = (unsigned char *)resp;
+            len = sg_get_unaligned_be32(bp + 0);
             if (len < 0)
                 len = 0;
             len = (ret < len) ? ret : len;
@@ -279,11 +279,11 @@ sg_ll_get_performance(int sg_fd, int data_type, unsigned int starting_lba,
         }
     } else {
         if ((verbose > 2) && (ret > 3)) {
-            unsigned char * ucp;
+            unsigned char * bp;
             int len;
 
-            ucp = (unsigned char *)resp;
-            len = sg_get_unaligned_be32(ucp + 0);
+            bp = (unsigned char *)resp;
+            len = sg_get_unaligned_be32(bp + 0);
             if (len < 0)
                 len = 0;
             len = (ret < len) ? ret : len;