rearrange files into include, src, lib and doc directories

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

1 files changed, 372 insertions, 0 deletions

diff --git a/src/sg_sat_set_features.c b/src/sg_sat_set_features.c
new file mode 100644
index 00000000..02d28392
--- /dev/null
+++ b/src/sg_sat_set_features.c
@@ -0,0 +1,372 @@
+/*
+ * Copyright (c) 2006-2007 Douglas Gilbert.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ */
+
+#include <unistd.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <getopt.h>
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "sg_lib.h"
+#include "sg_cmds_basic.h"
+#include "sg_cmds_extra.h"
+
+/* This program performs a ATA PASS-THROUGH (16) SCSI command in order
+   to perform an ATA SET FEATURES command. See http://www.t10.org
+   SAT draft at time of writing: sat-r09.pdf
+
+   See man page (sg_sat_set_features.8) for details.
+
+*/
+
+#define SAT_ATA_PASS_THROUGH16 0x85
+#define SAT_ATA_PASS_THROUGH16_LEN 16
+#define SAT_ATA_PASS_THROUGH12 0xa1     /* clashes with MMC BLANK comand */
+#define SAT_ATA_PASS_THROUGH12_LEN 12
+#define SAT_ATA_RETURN_DESC 9  /* ATA Return (sense) Descriptor */
+#define ASCQ_ATA_PT_INFO_AVAILABLE 0x1d
+
+#define ATA_SET_FEATURES 0xef
+
+#define DEF_TIMEOUT 20
+
+static char * version_str = "1.03 20070719";
+
+static struct option long_options[] = {
+        {"count", required_argument, 0, 'c'},
+        {"chk_cond", no_argument, 0, 'C'},
+        {"feature", required_argument, 0, 'f'},
+        {"help", no_argument, 0, 'h'},
+        {"len", required_argument, 0, 'l'},
+        {"lba", required_argument, 0, 'L'},
+        {"verbose", no_argument, 0, 'v'},
+        {"version", no_argument, 0, 'V'},
+        {0, 0, 0, 0},
+};
+
+void usage()
+{
+    fprintf(stderr, "Usage: "
+          "sg_sat_set_features [--count=CO] [--chk_cond] [--feature=FEA] "
+          "[--help]\n"
+          "                           [--lba=LBA] [--len=16|12] [--verbose] "
+          "[--version]\n"
+          "                           DEVICE\n"
+          "  where:\n"
+          "    --count=CO | -c CO      count field contents (def: 0)\n"
+          "    --chk_cond | -C         set chk_cond field in pass-through "
+          "(def: 0)\n"
+          "    --feature=FEA|-f FEA     feature field contents\n"
+          "                             (def: 0 (which is reserved))\n"
+          "    --help | -h             output this usage message\n"
+          "    --lba=LBA | -L LBA      LBA field contents (def: 0)\n"
+          "    --len=16|12 | -l 16|12    cdb length: 16 or 12 bytes "
+          "(def: 16)\n"
+          "    --verbose | -v          increase verbosity\n"
+          "    --version | -V          print version string and exit\n\n"
+          "Sends an ATA SET FEATURES command via a SAT pass through.\n"
+          "Primary feature code is placed in '--feature=FEA' with "
+          "'--count=CO' and\n"
+          "'--lba=LBA' being auxiliaries for some features.  The arguments "
+          "CO, FEA\n"
+          "and LBA are decimal unless prefixed by '0x' or have a trailing "
+          "'h'.\n"
+          "Example enabling write cache: 'sg_sat_set_feature --feature=2 "
+          "/dev/sdc'\n");
+}
+
+
+
+static int do_set_features(int sg_fd, int feature, int count, int lba,
+                           int cdb_len, int chk_cond, int verbose)
+{
+    int res, ret;
+    int extend = 0;
+    int protocol = 3;   /* non-data */
+    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 */
+    int resid = 0;
+    int got_ard = 0;    /* got ATA result descriptor */
+    int sb_sz;
+    struct sg_scsi_sense_hdr ssh;
+    unsigned char sense_buffer[64];
+    unsigned char ata_return_desc[16];
+    unsigned char aptCmdBlk[SAT_ATA_PASS_THROUGH16_LEN] =
+                {SAT_ATA_PASS_THROUGH16, 0, 0, 0, 0, 0, 0, 0,
+                 0, 0, 0, 0, 0, 0, 0, 0};
+    unsigned char apt12CmdBlk[SAT_ATA_PASS_THROUGH12_LEN] =
+                {SAT_ATA_PASS_THROUGH12, 0, 0, 0, 0, 0, 0, 0,
+                 0, 0, 0, 0};
+
+    sb_sz = sizeof(sense_buffer);
+    memset(sense_buffer, 0, sb_sz);
+    memset(ata_return_desc, 0, sizeof(ata_return_desc));
+    if (16 == cdb_len) {
+        /* Prepare ATA PASS-THROUGH COMMAND (16) command */
+        aptCmdBlk[14] = ATA_SET_FEATURES;
+        aptCmdBlk[4] = feature;
+        aptCmdBlk[6] = count;
+        aptCmdBlk[8] = lba & 0xff;
+        aptCmdBlk[10] = (lba >> 8) & 0xff;
+        aptCmdBlk[12] = (lba >> 16) & 0xff;
+        aptCmdBlk[1] = (protocol << 1) | extend;
+        aptCmdBlk[2] = (chk_cond << 5) | (t_dir << 3) |
+                       (byte_block << 2) | t_length;
+        res = sg_ll_ata_pt(sg_fd, aptCmdBlk, cdb_len, DEF_TIMEOUT, NULL,
+                           NULL /* doutp */, 0, sense_buffer,
+                           sb_sz, ata_return_desc,
+                           sizeof(ata_return_desc), &resid, verbose);
+    } else {
+        /* Prepare ATA PASS-THROUGH COMMAND (12) command */
+        apt12CmdBlk[9] = ATA_SET_FEATURES;
+        apt12CmdBlk[3] = feature;
+        apt12CmdBlk[4] = count;
+        apt12CmdBlk[5] = lba & 0xff;
+        apt12CmdBlk[6] = (lba >> 8) & 0xff;
+        apt12CmdBlk[7] = (lba >> 16) & 0xff;
+        apt12CmdBlk[1] = (protocol << 1);
+        apt12CmdBlk[2] = (chk_cond << 5) | (t_dir << 3) |
+                         (byte_block << 2) | t_length;
+        res = sg_ll_ata_pt(sg_fd, apt12CmdBlk, cdb_len, DEF_TIMEOUT, NULL,
+                           NULL /* doutp */, 0, sense_buffer,
+                           sb_sz, ata_return_desc,
+                           sizeof(ata_return_desc), &resid, verbose);
+    }
+    if (0 == res) {
+        if (verbose > 2)
+            fprintf(stderr, "command completed with SCSI GOOD status\n");
+    } else if ((res > 0) && (res & SAM_STAT_CHECK_CONDITION)) {
+        if (verbose > 1)
+            sg_print_sense("ATA pass through", sense_buffer, sb_sz,
+                           ((verbose > 2) ? 1 : 0));
+        if (sg_scsi_normalize_sense(sense_buffer, sb_sz, &ssh)) {
+            switch (ssh.sense_key) {
+            case SPC_SK_ILLEGAL_REQUEST:
+                if ((0x20 == ssh.asc) && (0x0 == ssh.ascq)) {
+                    ret = SG_LIB_CAT_INVALID_OP;
+                    if (verbose < 2)
+                        fprintf(stderr, "ATA PASS-THROUGH (%d) not "
+                                "supported\n", cdb_len);
+                } else {
+                    ret = SG_LIB_CAT_ILLEGAL_REQ;
+                    if (verbose < 2)
+                        fprintf(stderr, "ATA PASS-THROUGH (%d), bad "
+                                "field in cdb\n", cdb_len);
+                }
+                return ret; 
+            case SPC_SK_NO_SENSE:
+            case SPC_SK_RECOVERED_ERROR:
+                if ((0x0 == ssh.asc) &&
+                    (ASCQ_ATA_PT_INFO_AVAILABLE == ssh.ascq)) {
+                    if (SAT_ATA_RETURN_DESC != ata_return_desc[0]) {
+                        if (verbose)
+                            fprintf(stderr, "did not find ATA Return "
+                                    "(sense) Descriptor\n");
+                        return SG_LIB_CAT_RECOVERED;
+                    }
+                    got_ard = 1;
+                    break;
+                } else if (SPC_SK_RECOVERED_ERROR == ssh.sense_key)
+                    return SG_LIB_CAT_RECOVERED;
+                else {
+                    if ((0x0 == ssh.asc) && (0x0 == ssh.ascq))
+                        break;
+                    return SG_LIB_CAT_SENSE;
+                }
+            case SPC_SK_UNIT_ATTENTION:
+                if (verbose < 2)
+                    fprintf(stderr, "ATA PASS-THROUGH (%d), Unit Attention "
+                                "detected\n", cdb_len);
+                return SG_LIB_CAT_UNIT_ATTENTION;
+            case SPC_SK_NOT_READY:
+                if (verbose < 2)
+                    fprintf(stderr, "ATA PASS-THROUGH (%d), device not "
+                                "ready\n", cdb_len);
+                return SG_LIB_CAT_NOT_READY;
+            case SPC_SK_MEDIUM_ERROR:
+            case SPC_SK_HARDWARE_ERROR:
+                if (verbose < 2)
+                    fprintf(stderr, "ATA PASS-THROUGH (%d), medium or "
+                            "hardware error\n", cdb_len);
+                return SG_LIB_CAT_MEDIUM_HARD;
+            case SPC_SK_ABORTED_COMMAND:
+                fprintf(stderr, "Aborted command\n");
+                return SG_LIB_CAT_ABORTED_COMMAND;
+            default:
+                if (verbose < 2)
+                    fprintf(stderr, "ATA PASS-THROUGH (%d), some sense "
+                            "data, use '-v' for more information\n", cdb_len);
+                return SG_LIB_CAT_SENSE;
+            }
+        } else {
+            fprintf(stderr, "CHECK CONDITION without response code ??\n");
+            return SG_LIB_CAT_SENSE;
+        }
+        if (0x72 != (sense_buffer[0] & 0x7f)) {
+            fprintf(stderr, "expected descriptor sense format, response "
+                    "code=0x%x\n", sense_buffer[0]);
+            return SG_LIB_CAT_MALFORMED;
+        }
+    } else if (res > 0) {
+        fprintf(stderr, "Unexpected SCSI status=0x%x\n", res);
+        return SG_LIB_CAT_MALFORMED;
+    } else {
+        fprintf(stderr, "ATA pass through (%d) failed\n", cdb_len);
+        if (verbose < 2)
+            fprintf(stderr, "    try adding '-v' for more information\n");
+        return -1;
+    }
+
+    if ((SAT_ATA_RETURN_DESC == ata_return_desc[0]) && (0 == got_ard))
+        fprintf(stderr, "Seem to have got ATA Result Descriptor but "
+                "it was not indicated\n");
+    if (got_ard) {
+        if (ata_return_desc[3] & 0x4) {
+                fprintf(stderr, "error indication in returned FIS: aborted "
+                        "command\n");
+                return SG_LIB_CAT_ABORTED_COMMAND;
+        }
+    }
+    return 0;
+}
+
+
+int main(int argc, char * argv[])
+{
+    int sg_fd, c, ret, res;
+    char device_name[256];
+    int count = 0;
+    int feature = 0;
+    int lba = 0;
+    int verbose = 0;
+    int chk_cond = 0;
+    int cdb_len = SAT_ATA_PASS_THROUGH16_LEN;
+
+    memset(device_name, 0, sizeof(device_name));
+    while (1) {
+        int option_index = 0;
+
+        c = getopt_long(argc, argv, "c:Cf:hl:L:vV", long_options,
+                        &option_index);
+        if (c == -1)
+            break;
+
+        switch (c) {
+        case 'c':
+            count = sg_get_num(optarg);
+            if ((count < 0) || (count > 255)) {
+                fprintf(stderr, "bad argument for '--count'\n");
+                return SG_LIB_SYNTAX_ERROR;
+            }
+            break;
+        case 'C':
+            chk_cond = 1;
+            break;
+        case 'f':
+            feature = sg_get_num(optarg);
+            if ((feature < 0) || (feature > 255)) {
+                fprintf(stderr, "bad argument for '--feature'\n");
+                return SG_LIB_SYNTAX_ERROR;
+            }
+            break;
+        case 'h':
+        case '?':
+            usage();
+            return 0;
+        case 'l':
+           cdb_len = sg_get_num(optarg);
+           if (! ((cdb_len == 12) || (cdb_len == 16))) {
+                fprintf(stderr, "argument to '--len' should be 12 or 16\n");
+                return SG_LIB_SYNTAX_ERROR;
+            }
+            break;
+        case 'L':
+            lba = sg_get_num(optarg);
+            if ((lba < 0) || (lba > 255)) {
+                fprintf(stderr, "bad argument for '--lba'\n");
+                return SG_LIB_SYNTAX_ERROR;
+            }
+            break;
+        case 'v':
+            ++verbose;
+            break;
+        case 'V':
+            fprintf(stderr, "version: %s\n", version_str);
+            return 0;
+        default:
+            fprintf(stderr, "unrecognised option code 0x%x ??\n", c);
+            usage();
+            return SG_LIB_SYNTAX_ERROR;
+        }
+    }
+    if (optind < argc) {
+        if ('\0' == device_name[0]) {
+            strncpy(device_name, argv[optind], sizeof(device_name) - 1);
+            device_name[sizeof(device_name) - 1] = '\0';
+            ++optind;
+        }
+        if (optind < argc) {
+            for (; optind < argc; ++optind)
+                fprintf(stderr, "Unexpected extra argument: %s\n",
+                        argv[optind]);
+            usage();
+            return SG_LIB_SYNTAX_ERROR;
+        }
+    }
+
+    if ('\0' == device_name[0]) {
+        fprintf(stderr, "missing device name!\n");
+        usage();
+        return 1;
+    }
+
+    if ((sg_fd = sg_cmds_open_device(device_name, 0 /* rw */,
+                                     verbose)) < 0) {
+        fprintf(stderr, "error opening file: %s: %s\n",
+                device_name, safe_strerror(-sg_fd));
+        return SG_LIB_FILE_ERROR;
+    }
+
+    ret = do_set_features(sg_fd, feature, count, lba, cdb_len, chk_cond,
+                          verbose);
+
+    res = sg_cmds_close_device(sg_fd);
+    if (res < 0) {
+        fprintf(stderr, "close error: %s\n", safe_strerror(-res));
+        if (0 == ret)
+            return SG_LIB_FILE_ERROR;
+    }
+    return (ret >= 0) ? ret : SG_LIB_CAT_OTHER;
+}