X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=scsicmds.h;h=bbb9f8af19aadfc0e937a140c1c44ed361ff3c45;hb=5744dacb3937021d6e69aa9fcb0461ff21880fe4;hp=92b6307d98e19083047e65973c81e2002dacd31c;hpb=cdafb78b23fff3ab7270db93413558e6cf05e2d2;p=mirror_smartmontools-debian.git diff --git a/scsicmds.h b/scsicmds.h index 92b6307..bbb9f8a 100644 --- a/scsicmds.h +++ b/scsicmds.h @@ -1,13 +1,11 @@ /* * scsicmds.h * - * Home page of code is: http://smartmontools.sourceforge.net + * Home page of code is: http://www.smartmontools.org * - * Copyright (C) 2002-6 Bruce Allen + * Copyright (C) 2002-8 Bruce Allen * Copyright (C) 2000 Michael Cornwell - * - * Additional SCSI work: - * Copyright (C) 2003-6 Douglas Gilbert + * Copyright (C) 2003-15 Douglas Gilbert * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -15,8 +13,8 @@ * any later version. * * You should have received a copy of the GNU General Public License - * (for example COPYING); if not, write to the Free - * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + * (for example COPYING); if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * * This code was originally developed as a Senior Thesis by Michael Cornwell * at the Concurrent Systems Laboratory (now part of the Storage Systems @@ -32,20 +30,22 @@ #ifndef SCSICMDS_H_ #define SCSICMDS_H_ -#define SCSICMDS_H_CVSID "$Id: scsicmds.h,v 1.62 2006/09/12 00:22:49 dpgilbert Exp $\n" +#define SCSICMDS_H_CVSID "$Id: scsicmds.h 4557 2017-10-19 19:17:29Z samm2 $\n" #include #include #include -#include /* #define SCSI_DEBUG 1 */ /* Comment out to disable command debugging */ -/* Following conditional defines bypass inclusion of scsi/scsi.h and - * scsi/scsi_ioctl.h . Issue will be resolved later ... */ +/* Following conditional defines just in case OS already has them defined. + * If they are defined we hope they are defined correctly (for SCSI). */ #ifndef TEST_UNIT_READY #define TEST_UNIT_READY 0x0 #endif +#ifndef LOG_SELECT +#define LOG_SELECT 0x4c +#endif #ifndef LOG_SENSE #define LOG_SENSE 0x4d #endif @@ -76,6 +76,24 @@ #ifndef READ_DEFECT_10 #define READ_DEFECT_10 0x37 #endif +#ifndef READ_DEFECT_12 +#define READ_DEFECT_12 0xb7 +#endif +#ifndef START_STOP_UNIT +#define START_STOP_UNIT 0x1b +#endif +#ifndef REPORT_LUNS +#define REPORT_LUNS 0xa0 +#endif +#ifndef READ_CAPACITY_10 +#define READ_CAPACITY_10 0x25 +#endif +#ifndef READ_CAPACITY_16 +#define READ_CAPACITY_16 0x9e +#endif +#ifndef SAI_READ_CAPACITY_16 /* service action for READ_CAPACITY_16 */ +#define SAI_READ_CAPACITY_16 0x10 +#endif #ifndef SAT_ATA_PASSTHROUGH_12 #define SAT_ATA_PASSTHROUGH_12 0xa1 @@ -85,7 +103,7 @@ #endif typedef unsigned char UINT8; -typedef char INT8; +typedef signed char INT8; typedef unsigned int UINT32; typedef int INT32; @@ -97,11 +115,11 @@ struct scsi_cmnd_io { UINT8 * cmnd; /* [in]: ptr to SCSI command block (cdb) */ size_t cmnd_len; /* [in]: number of bytes in SCSI command */ - int dxfer_dir; /* [in]: DXFER_NONE, DXFER_FROM_DEVICE, or + int dxfer_dir; /* [in]: DXFER_NONE, DXFER_FROM_DEVICE, or DXFER_TO_DEVICE */ UINT8 * dxferp; /* [in]: ptr to outgoing or incoming data buffer */ size_t dxfer_len; /* [in]: bytes to be transferred to/from dxferp */ - UINT8 * sensep; /* [in]: ptr to sense buffer, filled when + UINT8 * sensep; /* [in]: ptr to sense buffer, filled when CHECK CONDITION status occurs */ size_t max_sense_len; /* [in]: max number of bytes to write to sensep */ unsigned timeout; /* [in]: seconds, 0-> default timeout (60 seconds?) */ @@ -113,10 +131,11 @@ struct scsi_cmnd_io }; struct scsi_sense_disect { - UINT8 error_code; + UINT8 resp_code; UINT8 sense_key; - UINT8 asc; + UINT8 asc; UINT8 ascq; + int progress; /* -1 -> N/A, 0-65535 -> available */ }; /* Useful data from Informational Exception Control mode page (0x1c) */ @@ -166,11 +185,15 @@ struct scsiNonMediumError { #define NON_MEDIUM_ERROR_LPAGE 0x06 #define LAST_N_ERROR_LPAGE 0x07 #define FORMAT_STATUS_LPAGE 0x08 +#define LB_PROV_LPAGE 0x0c /* SBC-3 */ #define TEMPERATURE_LPAGE 0x0d #define STARTSTOP_CYCLE_COUNTER_LPAGE 0x0e #define APPLICATION_CLIENT_LPAGE 0x0f #define SELFTEST_RESULTS_LPAGE 0x10 +#define SS_MEDIA_LPAGE 0x11 /* SBC-3 */ #define BACKGROUND_RESULTS_LPAGE 0x15 /* SBC-3 */ +#define NONVOL_CACHE_LPAGE 0x17 /* SBC-3 */ +#define PROTOCOL_SPECIFIC_LPAGE 0x18 #define IE_LPAGE 0x2f /* Seagate vendor specific log pages. */ @@ -180,7 +203,7 @@ struct scsiNonMediumError { /* Log page response lengths */ #define LOG_RESP_SELF_TEST_LEN 0x194 -/* See the SSC-2 document at www.t10.org . Earler note: From IBM +/* See the SSC-2 document at www.t10.org . Earler note: From IBM Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ #define TAPE_ALERTS_LPAGE 0x2e @@ -219,6 +242,18 @@ Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ #define MPAGE_CONTROL_DEFAULT 2 #define MPAGE_CONTROL_SAVED 3 +/* SCSI Vital Product Data (VPD) pages */ +#define SCSI_VPD_SUPPORTED_VPD_PAGES 0x0 +#define SCSI_VPD_UNIT_SERIAL_NUMBER 0x80 +#define SCSI_VPD_DEVICE_IDENTIFICATION 0x83 +#define SCSI_VPD_EXTENDED_INQUIRY_DATA 0x86 +#define SCSI_VPD_ATA_INFORMATION 0x89 +#define SCSI_VPD_POWER_CONDITION 0x8a +#define SCSI_VPD_POWER_CONSUMPTION 0x8d +#define SCSI_VPD_BLOCK_LIMITS 0xb0 +#define SCSI_VPD_BLOCK_DEVICE_CHARACTERISTICS 0xb1 +#define SCSI_VPD_LOGICAL_BLOCK_PROVISIONING 0xb2 + /* defines for useful SCSI Status codes */ #define SCSI_STATUS_CHECK_CONDITION 0x2 @@ -230,12 +265,13 @@ Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ #define SCSI_SK_HARDWARE_ERROR 0x4 #define SCSI_SK_ILLEGAL_REQUEST 0x5 #define SCSI_SK_UNIT_ATTENTION 0x6 +#define SCSI_SK_ABORTED_COMMAND 0xb /* defines for useful Additional Sense Codes (ASCs) */ #define SCSI_ASC_NOT_READY 0x4 /* more info in ASCQ code */ #define SCSI_ASC_NO_MEDIUM 0x3a /* more info in ASCQ code */ #define SCSI_ASC_UNKNOWN_OPCODE 0x20 -#define SCSI_ASC_UNKNOWN_FIELD 0x24 +#define SCSI_ASC_INVALID_FIELD 0x24 #define SCSI_ASC_UNKNOWN_PARAM 0x26 #define SCSI_ASC_WARNING 0xb #define SCSI_ASC_IMPENDING_FAILURE 0x5d @@ -253,6 +289,8 @@ Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ #define SIMPLE_ERR_BECOMING_READY 7 /* device will be ready soon */ #define SIMPLE_ERR_TRY_AGAIN 8 /* some warning, try again */ #define SIMPLE_ERR_MEDIUM_HARDWARE 9 /* medium or hardware error */ +#define SIMPLE_ERR_UNKNOWN 10 /* unknown sense value */ +#define SIMPLE_ERR_ABORTED_COMMAND 11 /* most likely transport error */ /* defines for functioncode parameter in SENDDIAGNOSTIC function */ @@ -266,7 +304,9 @@ Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ /* SCSI command timeout values (units are seconds) */ -#define SCSI_TIMEOUT_DEFAULT 6 /* 6 seconds should be ample */ +#define SCSI_TIMEOUT_DEFAULT 60 // should be longer than the spin up time + // of a disk in JBOD. + #define SCSI_TIMEOUT_SELF_TEST (5 * 60 * 60) /* allow max 5 hours for */ /* extended foreground self test */ @@ -274,6 +314,32 @@ Documentation, see http://www.storage.ibm.com/techsup/hddtech/prodspecs.htm */ #define LOGPAGEHDRSIZE 4 +class scsi_device; + +// Set of supported SCSI VPD pages. Constructor fetches Supported VPD pages +// VPD page and remembers the response for later queries. +class supported_vpd_pages +{ +public: + explicit supported_vpd_pages(scsi_device * device); + ~supported_vpd_pages() { num_valid = 0; } + + bool is_supported(int vpd_page_num) const; + + /* Returns 0 or less for VPD pages not supported or error */ + int num_pages() const { return num_valid; } + +private: + int num_valid; /* 0 or less for invalid */ + unsigned char pages[256]; +}; + +extern supported_vpd_pages * supported_vpd_pages_p; + + +// Print SCSI debug messages? +extern unsigned char scsi_debugmode; + void scsi_do_sense_disect(const struct scsi_cmnd_io * in, struct scsi_sense_disect * out); @@ -281,83 +347,111 @@ int scsiSimpleSenseFilter(const struct scsi_sense_disect * sinfo); const char * scsiErrString(int scsiErr); +int scsi_vpd_dev_id_iter(const unsigned char * initial_desig_desc, + int page_len, int * off, int m_assoc, + int m_desig_type, int m_code_set); + +int scsi_decode_lu_dev_id(const unsigned char * b, int blen, char * s, + int slen, int * transport); + + /* STANDARD SCSI Commands */ -int scsiTestUnitReady(int device); +int scsiTestUnitReady(scsi_device * device); -int scsiStdInquiry(int device, UINT8 *pBuf, int bufLen); +int scsiStdInquiry(scsi_device * device, UINT8 *pBuf, int bufLen); -int scsiInquiryVpd(int device, int vpd_page, UINT8 *pBuf, int bufLen); +int scsiInquiryVpd(scsi_device * device, int vpd_page, UINT8 *pBuf, int bufLen); -int scsiLogSense(int device, int pagenum, int subpagenum, UINT8 *pBuf, - int bufLen, int known_resp_len); +int scsiLogSense(scsi_device * device, int pagenum, int subpagenum, UINT8 *pBuf, + int bufLen, int known_resp_len); -int scsiModeSense(int device, int pagenum, int subpagenum, int pc, +int scsiLogSelect(scsi_device * device, int pcr, int sp, int pc, int pagenum, + int subpagenum, UINT8 *pBuf, int bufLen); + +int scsiModeSense(scsi_device * device, int pagenum, int subpagenum, int pc, UINT8 *pBuf, int bufLen); -int scsiModeSelect(int device, int sp, UINT8 *pBuf, int bufLen); +int scsiModeSelect(scsi_device * device, int sp, UINT8 *pBuf, int bufLen); -int scsiModeSense10(int device, int pagenum, int subpagenum, int pc, - UINT8 *pBuf, int bufLen); +int scsiModeSense10(scsi_device * device, int pagenum, int subpagenum, int pc, + UINT8 *pBuf, int bufLen); -int scsiModeSelect10(int device, int sp, UINT8 *pBuf, int bufLen); +int scsiModeSelect10(scsi_device * device, int sp, UINT8 *pBuf, int bufLen); int scsiModePageOffset(const UINT8 * resp, int len, int modese_len); -int scsiRequestSense(int device, struct scsi_sense_disect * sense_info); - -int scsiSendDiagnostic(int device, int functioncode, UINT8 *pBuf, int bufLen); +int scsiRequestSense(scsi_device * device, struct scsi_sense_disect * sense_info); -int scsiReceiveDiagnostic(int device, int pcv, int pagenum, UINT8 *pBuf, - int bufLen); +int scsiSendDiagnostic(scsi_device * device, int functioncode, UINT8 *pBuf, int bufLen); -int scsiReadDefect10(int device, int req_plist, int req_glist, int dl_format, +int scsiReadDefect10(scsi_device * device, int req_plist, int req_glist, int dl_format, UINT8 *pBuf, int bufLen); +int scsiReadDefect12(scsi_device * device, int req_plist, int req_glist, + int dl_format, int addrDescIndex, UINT8 *pBuf, int bufLen); + +int scsiReadCapacity10(scsi_device * device, unsigned int * last_lbp, + unsigned int * lb_sizep); + +int scsiReadCapacity16(scsi_device * device, UINT8 *pBuf, int bufLen); + /* SMART specific commands */ -int scsiCheckIE(int device, int hasIELogPage, int hasTempLogPage, UINT8 *asc, +int scsiCheckIE(scsi_device * device, int hasIELogPage, int hasTempLogPage, UINT8 *asc, UINT8 *ascq, UINT8 *currenttemp, UINT8 *triptemp); -int scsiFetchIECmpage(int device, struct scsi_iec_mode_page *iecp, +int scsiFetchIECmpage(scsi_device * device, struct scsi_iec_mode_page *iecp, int modese_len); int scsi_IsExceptionControlEnabled(const struct scsi_iec_mode_page *iecp); int scsi_IsWarningEnabled(const struct scsi_iec_mode_page *iecp); -int scsiSetExceptionControlAndWarning(int device, int enabled, +int scsiSetExceptionControlAndWarning(scsi_device * device, int enabled, const struct scsi_iec_mode_page *iecp); void scsiDecodeErrCounterPage(unsigned char * resp, struct scsiErrorCounter *ecp); void scsiDecodeNonMediumErrPage(unsigned char * resp, struct scsiNonMediumError *nmep); -int scsiFetchExtendedSelfTestTime(int device, int * durationSec, +int scsiFetchExtendedSelfTestTime(scsi_device * device, int * durationSec, int modese_len); -int scsiCountFailedSelfTests(int fd, int noisy); -int scsiSelfTestInProgress(int fd, int * inProgress); -int scsiFetchControlGLTSD(int device, int modese_len, int current); -int scsiSetControlGLTSD(int device, int enabled, int modese_len); -int scsiFetchTransportProtocol(int device, int modese_len); +int scsiCountFailedSelfTests(scsi_device * device, int noisy); +int scsiSelfTestInProgress(scsi_device * device, int * inProgress); +int scsiFetchControlGLTSD(scsi_device * device, int modese_len, int current); +int scsiSetControlGLTSD(scsi_device * device, int enabled, int modese_len); +int scsiFetchTransportProtocol(scsi_device * device, int modese_len); +int scsiGetRPM(scsi_device * device, int modese_len, int * form_factorp, + int * haw_zbcp); +int scsiGetSetCache(scsi_device * device, int modese_len, short int * wce, + short int * rcd); +uint64_t scsiGetSize(scsi_device * device, unsigned int * lb_sizep, + int * lb_per_pb_expp); +int scsiGetProtPBInfo(scsi_device * device, unsigned char * rc16_12_31p); /* T10 Standard IE Additional Sense Code strings taken from t10.org */ - const char* scsiGetIEString(UINT8 asc, UINT8 ascq); -int scsiGetTemp(int device, UINT8 *currenttemp, UINT8 *triptemp); +int scsiGetTemp(scsi_device * device, UINT8 *currenttemp, UINT8 *triptemp); -int scsiSmartIBMOfflineTest(int device); - -int scsiSmartDefaultSelfTest(int device); -int scsiSmartShortSelfTest(int device); -int scsiSmartExtendSelfTest(int device); -int scsiSmartShortCapSelfTest(int device); -int scsiSmartExtendCapSelfTest(int device); -int scsiSmartSelfTestAbort(int device); +int scsiSmartDefaultSelfTest(scsi_device * device); +int scsiSmartShortSelfTest(scsi_device * device); +int scsiSmartExtendSelfTest(scsi_device * device); +int scsiSmartShortCapSelfTest(scsi_device * device); +int scsiSmartExtendCapSelfTest(scsi_device * device); +int scsiSmartSelfTestAbort(scsi_device * device); const char * scsiTapeAlertsTapeDevice(unsigned short code); const char * scsiTapeAlertsChangerDevice(unsigned short code); const char * scsi_get_opcode_name(UINT8 opcode); +void scsi_format_id_string(char * out, const unsigned char * in, int n); + void dStrHex(const char* str, int len, int no_ascii); inline void dStrHex(const unsigned char* str, int len, int no_ascii) { dStrHex((const char *)str, len, no_ascii); } +/* Attempt to find the first SCSI sense data descriptor that matches the + given 'desc_type'. If found return pointer to start of sense data + descriptor; otherwise (including fixed format sense data) returns NULL. */ +const unsigned char * sg_scsi_sense_desc_find(const unsigned char * sensep, + int sense_len, int desc_type); + /* SCSI command transmission interface function declaration. Its * definition is target OS specific (see os_.c file). @@ -367,11 +461,9 @@ inline void dStrHex(const unsigned char* str, int len, int no_ascii) * (e.g. CHECK CONDITION). If the SCSI command could not be issued * (e.g. device not present or not a SCSI device) or some other problem * arises (e.g. timeout) then returns a negative errno value. */ -int do_scsi_cmnd_io(int dev_fd, struct scsi_cmnd_io * iop, int report); +// Moved to C++ interface +//int do_scsi_cmnd_io(int dev_fd, struct scsi_cmnd_io * iop, int report); -/* This is Linux specific and will be generalized later. */ -int isLinuxLibAta(unsigned char * vpd_di_buff, int len); #endif -