scsicmds.h

   1 /*
   2  * scsicmds.h
   3  *
   4  * Home page of code is: http://www.smartmontools.org
   5  *
   6  * Copyright (C) 2002-8 Bruce Allen
   7  * Copyright (C) 2000 Michael Cornwell <cornwell@acm.org>
   8  * Copyright (C) 2003-15 Douglas Gilbert <dgilbert@interlog.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2, or (at your option)
  13  * any later version.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * (for example COPYING); if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * This code was originally developed as a Senior Thesis by Michael Cornwell
  20  * at the Concurrent Systems Laboratory (now part of the Storage Systems
  21  * Research Center), Jack Baskin School of Engineering, University of
  22  * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
  23  *
  24  * N.B. What was formerly known as "SMART" are now called "informational
  25  * exceptions" in recent t10.org drafts (i.e. recent SCSI).
  26  *
  27  */
  28
  29
  30 #ifndef SCSICMDS_H_
  31 #define SCSICMDS_H_
  32
  33 #define SCSICMDS_H_CVSID "$Id: scsicmds.h 4557 2017-10-19 19:17:29Z samm2 $\n"
  34
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38
  39 /* #define SCSI_DEBUG 1 */ /* Comment out to disable command debugging */
  40
  41 /* Following conditional defines just in case OS already has them defined.
  42  * If they are defined we hope they are defined correctly (for SCSI). */
  43 #ifndef TEST_UNIT_READY
  44 #define TEST_UNIT_READY 0x0
  45 #endif
  46 #ifndef LOG_SELECT
  47 #define LOG_SELECT 0x4c
  48 #endif
  49 #ifndef LOG_SENSE
  50 #define LOG_SENSE 0x4d
  51 #endif
  52 #ifndef MODE_SENSE
  53 #define MODE_SENSE 0x1a
  54 #endif
  55 #ifndef MODE_SENSE_10
  56 #define MODE_SENSE_10 0x5a
  57 #endif
  58 #ifndef MODE_SELECT
  59 #define MODE_SELECT 0x15
  60 #endif
  61 #ifndef MODE_SELECT_10
  62 #define MODE_SELECT_10 0x55
  63 #endif
  64 #ifndef INQUIRY
  65 #define INQUIRY 0x12
  66 #endif
  67 #ifndef REQUEST_SENSE
  68 #define REQUEST_SENSE  0x03
  69 #endif
  70 #ifndef RECEIVE_DIAGNOSTIC
  71 #define RECEIVE_DIAGNOSTIC  0x1c
  72 #endif
  73 #ifndef SEND_DIAGNOSTIC
  74 #define SEND_DIAGNOSTIC  0x1d
  75 #endif
  76 #ifndef READ_DEFECT_10
  77 #define READ_DEFECT_10  0x37
  78 #endif
  79 #ifndef READ_DEFECT_12
  80 #define READ_DEFECT_12  0xb7
  81 #endif
  82 #ifndef START_STOP_UNIT
  83 #define START_STOP_UNIT  0x1b
  84 #endif
  85 #ifndef REPORT_LUNS
  86 #define REPORT_LUNS  0xa0
  87 #endif
  88 #ifndef READ_CAPACITY_10
  89 #define READ_CAPACITY_10  0x25
  90 #endif
  91 #ifndef READ_CAPACITY_16
  92 #define READ_CAPACITY_16  0x9e
  93 #endif
  94 #ifndef SAI_READ_CAPACITY_16    /* service action for READ_CAPACITY_16 */
  95 #define SAI_READ_CAPACITY_16  0x10
  96 #endif
  97
  98 #ifndef SAT_ATA_PASSTHROUGH_12
  99 #define SAT_ATA_PASSTHROUGH_12 0xa1
 100 #endif
 101 #ifndef SAT_ATA_PASSTHROUGH_16
 102 #define SAT_ATA_PASSTHROUGH_16 0x85
 103 #endif
 104
 105 typedef unsigned char UINT8;
 106 typedef signed char INT8;
 107 typedef unsigned int UINT32;
 108 typedef int INT32;
 109
 110 #define DXFER_NONE        0
 111 #define DXFER_FROM_DEVICE 1
 112 #define DXFER_TO_DEVICE   2
 113
 114 struct scsi_cmnd_io
 115 {
 116     UINT8 * cmnd;       /* [in]: ptr to SCSI command block (cdb) */
 117     size_t  cmnd_len;   /* [in]: number of bytes in SCSI command */
 118     int dxfer_dir;      /* [in]: DXFER_NONE, DXFER_FROM_DEVICE, or
 119                                  DXFER_TO_DEVICE */
 120     UINT8 * dxferp;     /* [in]: ptr to outgoing or incoming data buffer */
 121     size_t dxfer_len;   /* [in]: bytes to be transferred to/from dxferp */
 122     UINT8 * sensep;     /* [in]: ptr to sense buffer, filled when
 123                                  CHECK CONDITION status occurs */
 124     size_t max_sense_len; /* [in]: max number of bytes to write to sensep */
 125     unsigned timeout;   /* [in]: seconds, 0-> default timeout (60 seconds?) */
 126     size_t resp_sense_len;  /* [out]: sense buffer length written */
 127     UINT8 scsi_status;  /* [out]: 0->ok, 2->CHECK CONDITION, etc ... */
 128     int resid;          /* [out]: Number of bytes requested to be transferred
 129                                   less actual number transferred (0 if not
 130                                    supported) */
 131 };
 132
 133 struct scsi_sense_disect {
 134     UINT8 resp_code;
 135     UINT8 sense_key;
 136     UINT8 asc;
 137     UINT8 ascq;
 138     int progress; /* -1 -> N/A, 0-65535 -> available */
 139 };
 140
 141 /* Useful data from Informational Exception Control mode page (0x1c) */
 142 #define SCSI_IECMP_RAW_LEN 64
 143 struct scsi_iec_mode_page {
 144     UINT8 requestedCurrent;
 145     UINT8 gotCurrent;
 146     UINT8 requestedChangeable;
 147     UINT8 gotChangeable;
 148     UINT8 modese_len;   /* 0 (don't know), 6 or 10 */
 149     UINT8 raw_curr[SCSI_IECMP_RAW_LEN];
 150     UINT8 raw_chg[SCSI_IECMP_RAW_LEN];
 151 };
 152
 153 /* Carrier for Error counter log pages (e.g. read, write, verify ...) */
 154 struct scsiErrorCounter {
 155     UINT8 gotPC[7];
 156     UINT8 gotExtraPC;
 157     uint64_t counter[8];
 158 };
 159
 160 /* Carrier for Non-medium error log page */
 161 struct scsiNonMediumError {
 162     UINT8 gotPC0;
 163     UINT8 gotExtraPC;
 164     uint64_t counterPC0;
 165     UINT8 gotTFE_H;
 166     uint64_t counterTFE_H; /* Track following errors [Hitachi] */
 167     UINT8 gotPE_H;
 168     uint64_t counterPE_H;  /* Positioning errors [Hitachi] */
 169 };
 170
 171 /* SCSI Peripheral types (of interest) */
 172 #define SCSI_PT_DIRECT_ACCESS           0x0
 173 #define SCSI_PT_SEQUENTIAL_ACCESS       0x1
 174 #define SCSI_PT_CDROM                   0x5
 175 #define SCSI_PT_MEDIUM_CHANGER          0x8
 176 #define SCSI_PT_ENCLOSURE               0xd
 177
 178 /* ANSI SCSI-3 Log Pages retrieved by LOG SENSE. */
 179 #define SUPPORTED_LPAGES                        0x00
 180 #define BUFFER_OVERRUN_LPAGE                    0x01
 181 #define WRITE_ERROR_COUNTER_LPAGE               0x02
 182 #define READ_ERROR_COUNTER_LPAGE                0x03
 183 #define READ_REVERSE_ERROR_COUNTER_LPAGE        0x04
 184 #define VERIFY_ERROR_COUNTER_LPAGE              0x05
 185 #define NON_MEDIUM_ERROR_LPAGE                  0x06
 186 #define LAST_N_ERROR_LPAGE                      0x07
 187 #define FORMAT_STATUS_LPAGE                     0x08
 188 #define LB_PROV_LPAGE                           0x0c   /* SBC-3 */
 189 #define TEMPERATURE_LPAGE                       0x0d
 190 #define STARTSTOP_CYCLE_COUNTER_LPAGE           0x0e
 191 #define APPLICATION_CLIENT_LPAGE                0x0f
 192 #define SELFTEST_RESULTS_LPAGE                  0x10
 193 #define SS_MEDIA_LPAGE                          0x11   /* SBC-3 */
 194 #define BACKGROUND_RESULTS_LPAGE                0x15   /* SBC-3 */
 195 #define NONVOL_CACHE_LPAGE                      0x17   /* SBC-3 */
 196 #define PROTOCOL_SPECIFIC_LPAGE                 0x18
 197 #define IE_LPAGE                                0x2f
 198
 199 /* Seagate vendor specific log pages. */
 200 #define SEAGATE_CACHE_LPAGE                     0x37
 201 #define SEAGATE_FACTORY_LPAGE                   0x3e
 202
 203 /* Log page response lengths */
 204 #define LOG_RESP_SELF_TEST_LEN 0x194
 205
 206 /* See the SSC-2 document at www.t10.org . Earler note: From IBM
 207 Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */
 208 #define TAPE_ALERTS_LPAGE                        0x2e
 209
 210 /* ANSI SCSI-3 Mode Pages */
 211 #define VENDOR_UNIQUE_PAGE                       0x00
 212 #define READ_WRITE_ERROR_RECOVERY_PAGE           0x01
 213 #define DISCONNECT_RECONNECT_PAGE                0x02
 214 #define FORMAT_DEVICE_PAGE                       0x03
 215 #define RIGID_DISK_DRIVE_GEOMETRY_PAGE           0x04
 216 #define FLEXIBLE_DISK_PAGE                       0x05
 217 #define VERIFY_ERROR_RECOVERY_PAGE               0x07
 218 #define CACHING_PAGE                             0x08
 219 #define PERIPHERAL_DEVICE_PAGE                   0x09
 220 #define XOR_CONTROL_MODE_PAGE                    0x10
 221 #define CONTROL_MODE_PAGE                        0x0a
 222 #define MEDIUM_TYPES_SUPPORTED_PAGE              0x0b
 223 #define NOTCH_PAGE                               0x0c
 224 #define CD_DEVICE_PAGE                           0x0d
 225 #define CD_AUDIO_CONTROL_PAGE                    0x0e
 226 #define DATA_COMPRESSION_PAGE                    0x0f
 227 #define ENCLOSURE_SERVICES_MANAGEMENT_PAGE       0x14
 228 #define PROTOCOL_SPECIFIC_LUN_PAGE               0x18
 229 #define PROTOCOL_SPECIFIC_PORT_PAGE              0x19
 230 #define POWER_CONDITION_PAGE                     0x1a
 231 #define INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE    0x1c
 232 #define FAULT_FAILURE_REPORTING_PAGE             0x1c
 233
 234 /* Background control mode subpage is [0x1c,0x1] */
 235 #define BACKGROUND_CONTROL_M_SUBPAGE             0x1   /* SBC-2 */
 236
 237 #define ALL_MODE_PAGES                           0x3f
 238
 239 /* Mode page control field */
 240 #define MPAGE_CONTROL_CURRENT               0
 241 #define MPAGE_CONTROL_CHANGEABLE            1
 242 #define MPAGE_CONTROL_DEFAULT               2
 243 #define MPAGE_CONTROL_SAVED                 3
 244
 245 /* SCSI Vital Product Data (VPD) pages */
 246 #define SCSI_VPD_SUPPORTED_VPD_PAGES    0x0
 247 #define SCSI_VPD_UNIT_SERIAL_NUMBER     0x80
 248 #define SCSI_VPD_DEVICE_IDENTIFICATION  0x83
 249 #define SCSI_VPD_EXTENDED_INQUIRY_DATA  0x86
 250 #define SCSI_VPD_ATA_INFORMATION        0x89
 251 #define SCSI_VPD_POWER_CONDITION        0x8a
 252 #define SCSI_VPD_POWER_CONSUMPTION      0x8d
 253 #define SCSI_VPD_BLOCK_LIMITS           0xb0
 254 #define SCSI_VPD_BLOCK_DEVICE_CHARACTERISTICS   0xb1
 255 #define SCSI_VPD_LOGICAL_BLOCK_PROVISIONING     0xb2
 256
 257 /* defines for useful SCSI Status codes */
 258 #define SCSI_STATUS_CHECK_CONDITION     0x2
 259
 260 /* defines for useful Sense Key codes */
 261 #define SCSI_SK_NO_SENSE                0x0
 262 #define SCSI_SK_RECOVERED_ERR           0x1
 263 #define SCSI_SK_NOT_READY               0x2
 264 #define SCSI_SK_MEDIUM_ERROR            0x3
 265 #define SCSI_SK_HARDWARE_ERROR          0x4
 266 #define SCSI_SK_ILLEGAL_REQUEST         0x5
 267 #define SCSI_SK_UNIT_ATTENTION          0x6
 268 #define SCSI_SK_ABORTED_COMMAND         0xb
 269
 270 /* defines for useful Additional Sense Codes (ASCs) */
 271 #define SCSI_ASC_NOT_READY              0x4     /* more info in ASCQ code */
 272 #define SCSI_ASC_NO_MEDIUM              0x3a    /* more info in ASCQ code */
 273 #define SCSI_ASC_UNKNOWN_OPCODE         0x20
 274 #define SCSI_ASC_INVALID_FIELD          0x24
 275 #define SCSI_ASC_UNKNOWN_PARAM          0x26
 276 #define SCSI_ASC_WARNING                0xb
 277 #define SCSI_ASC_IMPENDING_FAILURE      0x5d
 278
 279 #define SCSI_ASCQ_ATA_PASS_THROUGH      0x1d
 280
 281 /* Simplified error code (negative values as per errno) */
 282 #define SIMPLE_NO_ERROR                 0
 283 #define SIMPLE_ERR_NOT_READY            1
 284 #define SIMPLE_ERR_BAD_OPCODE           2
 285 #define SIMPLE_ERR_BAD_FIELD            3       /* in cbd */
 286 #define SIMPLE_ERR_BAD_PARAM            4       /* in data */
 287 #define SIMPLE_ERR_BAD_RESP             5       /* response fails sanity */
 288 #define SIMPLE_ERR_NO_MEDIUM            6       /* no medium present */
 289 #define SIMPLE_ERR_BECOMING_READY       7       /* device will be ready soon */
 290 #define SIMPLE_ERR_TRY_AGAIN            8       /* some warning, try again */
 291 #define SIMPLE_ERR_MEDIUM_HARDWARE      9       /* medium or hardware error */
 292 #define SIMPLE_ERR_UNKNOWN              10      /* unknown sense value */
 293 #define SIMPLE_ERR_ABORTED_COMMAND      11      /* most likely transport error */
 294
 295
 296 /* defines for functioncode parameter in SENDDIAGNOSTIC function */
 297 #define SCSI_DIAG_NO_SELF_TEST          0x00
 298 #define SCSI_DIAG_DEF_SELF_TEST         0xff
 299 #define SCSI_DIAG_BG_SHORT_SELF_TEST    0x01
 300 #define SCSI_DIAG_BG_EXTENDED_SELF_TEST 0x02
 301 #define SCSI_DIAG_FG_SHORT_SELF_TEST    0x05
 302 #define SCSI_DIAG_FG_EXTENDED_SELF_TEST 0x06
 303 #define SCSI_DIAG_ABORT_SELF_TEST       0x04
 304
 305
 306 /* SCSI command timeout values (units are seconds) */
 307 #define SCSI_TIMEOUT_DEFAULT    60  // should be longer than the spin up time
 308                                     // of a disk in JBOD.
 309
 310 #define SCSI_TIMEOUT_SELF_TEST  (5 * 60 * 60)   /* allow max 5 hours for */
 311                                             /* extended foreground self test */
 312
 313
 314
 315 #define LOGPAGEHDRSIZE  4
 316
 317 class scsi_device;
 318
 319 // Set of supported SCSI VPD pages. Constructor fetches Supported VPD pages
 320 // VPD page and remembers the response for later queries.
 321 class supported_vpd_pages
 322 {
 323 public:
 324     explicit supported_vpd_pages(scsi_device * device);
 325     ~supported_vpd_pages() { num_valid = 0; }
 326
 327     bool is_supported(int vpd_page_num) const;
 328
 329     /* Returns 0 or less for VPD pages not supported or error */
 330     int num_pages() const { return num_valid; }
 331
 332 private:
 333     int num_valid;      /* 0 or less for invalid */
 334     unsigned char pages[256];
 335 };
 336
 337 extern supported_vpd_pages * supported_vpd_pages_p;
 338
 339
 340 // Print SCSI debug messages?
 341 extern unsigned char scsi_debugmode;
 342
 343 void scsi_do_sense_disect(const struct scsi_cmnd_io * in,
 344                           struct scsi_sense_disect * out);
 345
 346 int scsiSimpleSenseFilter(const struct scsi_sense_disect * sinfo);
 347
 348 const char * scsiErrString(int scsiErr);
 349
 350 int scsi_vpd_dev_id_iter(const unsigned char * initial_desig_desc,
 351                          int page_len, int * off, int m_assoc,
 352                          int m_desig_type, int m_code_set);
 353
 354 int scsi_decode_lu_dev_id(const unsigned char * b, int blen, char * s,
 355                           int slen, int * transport);
 356
 357
 358 /* STANDARD SCSI Commands  */
 359 int scsiTestUnitReady(scsi_device * device);
 360
 361 int scsiStdInquiry(scsi_device * device, UINT8 *pBuf, int bufLen);
 362
 363 int scsiInquiryVpd(scsi_device * device, int vpd_page, UINT8 *pBuf, int bufLen);
 364
 365 int scsiLogSense(scsi_device * device, int pagenum, int subpagenum, UINT8 *pBuf,
 366                  int bufLen, int known_resp_len);
 367
 368 int scsiLogSelect(scsi_device * device, int pcr, int sp, int pc, int pagenum,
 369                   int subpagenum, UINT8 *pBuf, int bufLen);
 370
 371 int scsiModeSense(scsi_device * device, int pagenum, int subpagenum, int pc,
 372                   UINT8 *pBuf, int bufLen);
 373
 374 int scsiModeSelect(scsi_device * device, int sp, UINT8 *pBuf, int bufLen);
 375
 376 int scsiModeSense10(scsi_device * device, int pagenum, int subpagenum, int pc,
 377                     UINT8 *pBuf, int bufLen);
 378
 379 int scsiModeSelect10(scsi_device * device, int sp, UINT8 *pBuf, int bufLen);
 380
 381 int scsiModePageOffset(const UINT8 * resp, int len, int modese_len);
 382
 383 int scsiRequestSense(scsi_device * device, struct scsi_sense_disect * sense_info);
 384
 385 int scsiSendDiagnostic(scsi_device * device, int functioncode, UINT8 *pBuf, int bufLen);
 386
 387 int scsiReadDefect10(scsi_device * device, int req_plist, int req_glist, int dl_format,
 388                      UINT8 *pBuf, int bufLen);
 389
 390 int scsiReadDefect12(scsi_device * device, int req_plist, int req_glist,
 391                      int dl_format, int addrDescIndex, UINT8 *pBuf, int bufLen);
 392
 393 int scsiReadCapacity10(scsi_device * device, unsigned int * last_lbp,
 394                        unsigned int * lb_sizep);
 395
 396 int scsiReadCapacity16(scsi_device * device, UINT8 *pBuf, int bufLen);
 397
 398 /* SMART specific commands */
 399 int scsiCheckIE(scsi_device * device, int hasIELogPage, int hasTempLogPage, UINT8 *asc,
 400                 UINT8 *ascq, UINT8 *currenttemp, UINT8 *triptemp);
 401
 402 int scsiFetchIECmpage(scsi_device * device, struct scsi_iec_mode_page *iecp,
 403                       int modese_len);
 404 int scsi_IsExceptionControlEnabled(const struct scsi_iec_mode_page *iecp);
 405 int scsi_IsWarningEnabled(const struct scsi_iec_mode_page *iecp);
 406 int scsiSetExceptionControlAndWarning(scsi_device * device, int enabled,
 407                             const struct scsi_iec_mode_page *iecp);
 408 void scsiDecodeErrCounterPage(unsigned char * resp,
 409                               struct scsiErrorCounter *ecp);
 410 void scsiDecodeNonMediumErrPage(unsigned char * resp,
 411                                 struct scsiNonMediumError *nmep);
 412 int scsiFetchExtendedSelfTestTime(scsi_device * device, int * durationSec,
 413                                   int modese_len);
 414 int scsiCountFailedSelfTests(scsi_device * device, int noisy);
 415 int scsiSelfTestInProgress(scsi_device * device, int * inProgress);
 416 int scsiFetchControlGLTSD(scsi_device * device, int modese_len, int current);
 417 int scsiSetControlGLTSD(scsi_device * device, int enabled, int modese_len);
 418 int scsiFetchTransportProtocol(scsi_device * device, int modese_len);
 419 int scsiGetRPM(scsi_device * device, int modese_len, int * form_factorp,
 420                int * haw_zbcp);
 421 int scsiGetSetCache(scsi_device * device,  int modese_len, short int * wce,
 422                     short int * rcd);
 423 uint64_t scsiGetSize(scsi_device * device, unsigned int * lb_sizep,
 424                      int * lb_per_pb_expp);
 425 int scsiGetProtPBInfo(scsi_device * device, unsigned char * rc16_12_31p);
 426
 427 /* T10 Standard IE Additional Sense Code strings taken from t10.org */
 428 const char* scsiGetIEString(UINT8 asc, UINT8 ascq);
 429 int scsiGetTemp(scsi_device * device, UINT8 *currenttemp, UINT8 *triptemp);
 430
 431
 432 int scsiSmartDefaultSelfTest(scsi_device * device);
 433 int scsiSmartShortSelfTest(scsi_device * device);
 434 int scsiSmartExtendSelfTest(scsi_device * device);
 435 int scsiSmartShortCapSelfTest(scsi_device * device);
 436 int scsiSmartExtendCapSelfTest(scsi_device * device);
 437 int scsiSmartSelfTestAbort(scsi_device * device);
 438
 439 const char * scsiTapeAlertsTapeDevice(unsigned short code);
 440 const char * scsiTapeAlertsChangerDevice(unsigned short code);
 441
 442 const char * scsi_get_opcode_name(UINT8 opcode);
 443 void scsi_format_id_string(char * out, const unsigned char * in, int n);
 444
 445 void dStrHex(const char* str, int len, int no_ascii);
 446 inline void dStrHex(const unsigned char* str, int len, int no_ascii)
 447   { dStrHex((const char *)str, len, no_ascii); }
 448
 449 /* Attempt to find the first SCSI sense data descriptor that matches the
 450    given 'desc_type'. If found return pointer to start of sense data
 451    descriptor; otherwise (including fixed format sense data) returns NULL. */
 452 const unsigned char * sg_scsi_sense_desc_find(const unsigned char * sensep,
 453                                                      int sense_len, int desc_type);
 454
 455
 456 /* SCSI command transmission interface function declaration. Its
 457  * definition is target OS specific (see os_<OS>.c file).
 458  * Returns 0 if SCSI command successfully launched and response
 459  * received. Even when 0 is returned the caller should check
 460  * scsi_cmnd_io::scsi_status for SCSI defined errors and warnings
 461  * (e.g. CHECK CONDITION). If the SCSI command could not be issued
 462  * (e.g. device not present or not a SCSI device) or some other problem
 463  * arises (e.g. timeout) then returns a negative errno value. */
 464 // Moved to C++ interface
 465 //int do_scsi_cmnd_io(int dev_fd, struct scsi_cmnd_io * iop, int report);
 466
 467
 468
 469 #endif