name : sg__sat_set_features.c /* * Copyright (c) 2006-2020 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> #include <sys/ioctl.h> #include <sys/types.h> #include <sys/stat.h> #include "sg_lib.h" #include "sg_io_linux.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 Invocation: sg_sat_set_features [-c <n>] [-f <n>] [-h] [-L <n>] [-v] [-V] <device> */ #define SAT_ATA_PASS_THROUGH16 0x85 #define SAT_ATA_PASS_THROUGH16_LEN 16 #define SAT_ATA_RETURN_DESC 9 /* ATA Return (sense) Descriptor */ #define ATA_SET_FEATURES 0xef #define EBUFF_SZ 512 static char * version_str = "1.06 20201125"; 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'}, {"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=C] [--chk_cond] [--feature=F] " "[--help]\n" " [-lba=LBA] [--verbose] [--version] " "DEVICE\n" " where:\n" " --count=C|-c C count field contents (def: 0)\n" " --chk_cond|-C set chk_cond field in pass-through " "(def: 0)\n" " --feature=F|-f F feature field contents (def: 0)\n" " --help|-h output this usage message\n" " --lba=LBA| -L LBA LBA field contents (def: 0)\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=F' with '--count=C' " "and\n" "'--lba=LBA' being auxiliaries for some features. The arguments C, " "F and LBA\n" "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"); } int main(int argc, char * argv[]) { int sg_fd, c, k; uint8_t apt_cdb[SAT_ATA_PASS_THROUGH16_LEN] = {SAT_ATA_PASS_THROUGH16, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}; sg_io_hdr_t io_hdr; char device_name[256]; char ebuff[EBUFF_SZ]; uint8_t sense_buffer[64]; int count = 0; int feature = 0; int lba = 0; int verbose = 0; int extend = 0; int chk_cond = 0; /* set to 1 to read register(s) back */ int protocol = 3; /* non-data data-in */ 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 uint8_t * bp = NULL; memset(device_name, 0, sizeof(device_name)); while (1) { int option_index = 0; c = getopt_long(argc, argv, "c:Cf:hL: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': 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 = open(device_name, O_RDWR)) < 0) { snprintf(ebuff, EBUFF_SZ, "sg_sat_set_features: error opening file: %s", device_name); perror(ebuff); return 1; } /* Prepare ATA PASS-THROUGH COMMAND (16) command */ apt_cdb[14] = ATA_SET_FEATURES; apt_cdb[1] = (protocol << 1) | extend; apt_cdb[2] = (chk_cond << 5) | (t_dir << 3) | (byte_block << 2) | t_length; apt_cdb[4] = feature; apt_cdb[6] = count; apt_cdb[8] = lba & 0xff; apt_cdb[10] = (lba >> 8) & 0xff; apt_cdb[12] = (lba >> 16) & 0xff; if (verbose) { fprintf(stderr, " ata pass through(16) cdb: "); for (k = 0; k < SAT_ATA_PASS_THROUGH16_LEN; ++k) fprintf(stderr, "%02x ", apt_cdb[k]); fprintf(stderr, "\n"); } memset(&io_hdr, 0, sizeof(sg_io_hdr_t)); io_hdr.interface_id = 'S'; io_hdr.cmd_len = sizeof(apt_cdb); /* io_hdr.iovec_count = 0; */ /* memset takes care of this */ io_hdr.mx_sb_len = sizeof(sense_buffer); io_hdr.dxfer_direction = SG_DXFER_NONE; io_hdr.dxfer_len = 0; io_hdr.dxferp = NULL; io_hdr.cmdp = apt_cdb; io_hdr.sbp = sense_buffer; io_hdr.timeout = 20000; /* 20000 millisecs == 20 seconds */ /* io_hdr.flags = 0; */ /* take defaults: indirect IO, etc */ /* io_hdr.pack_id = 0; */ /* io_hdr.usr_ptr = NULL; */ if (ioctl(sg_fd, SG_IO, &io_hdr) < 0) { perror("sg_sat_set_features: SG_IO ioctl error"); close(sg_fd); return 1; } /* error processing: N.B. expect check condition, no sense ... !! */ switch (sg_err_category3(&io_hdr)) { case SG_LIB_CAT_CLEAN: break; case SG_LIB_CAT_RECOVERED: /* sat-r09 uses this sk */ case SG_LIB_CAT_NO_SENSE: /* earlier SAT drafts used this */ 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 (bp && bp[3]) { if (bp[3] & 0x4) printf("error in returned FIS: aborted command\n"); else printf("error=0x%x, status=0x%x\n", bp[3], bp[13]); } break; default: fprintf(stderr, "unexpected SCSI sense category\n"); 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 (bp && bp[3]) { if (bp[3] & 0x4) printf("error in returned FIS: aborted command\n"); else printf("error=0x%x, status=0x%x\n", bp[3], bp[13]); } break; } close(sg_fd); return 0; }