X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=atacmds.h;h=5768677acd2fec3b18b13572ab1a2a2ec14d08f0;hb=bcade6c14a06cfc842b41df91fdc5b9577cd68f1;hp=c5f77e4254654b5332d9cd2ce226e82f1e8a4194;hpb=4d68e6c82ac9302ab2c5e63bb3f4a350f5941d83;p=mirror_smartmontools-debian.git diff --git a/atacmds.h b/atacmds.h index c5f77e4..5768677 100644 --- a/atacmds.h +++ b/atacmds.h @@ -1,10 +1,10 @@ /* * atacmds.h * - * Home page of code is: http://smartmontools.sourceforge.net + * Home page of code is: http://www.smartmontools.org * - * Copyright (C) 2002-9 Bruce Allen - * Copyright (C) 2008-9 Christian Franke + * Copyright (C) 2002-11 Bruce Allen + * Copyright (C) 2008-15 Christian Franke * Copyright (C) 1999-2000 Michael Cornwell * * This program is free software; you can redistribute it and/or modify @@ -13,8 +13,7 @@ * 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, see . * * This code was originally developed as a Senior Thesis by Michael Cornwell * at the Concurrent Systems Laboratory (now part of the Storage Systems @@ -26,7 +25,7 @@ #ifndef ATACMDS_H_ #define ATACMDS_H_ -#define ATACMDS_H_CVSID "$Id: atacmds.h 2859 2009-07-23 18:55:06Z chrfranke $" +#define ATACMDS_H_CVSID "$Id: atacmds.h 4162 2015-10-31 16:36:16Z chrfranke $" #include "dev_interface.h" // ata_device @@ -67,20 +66,27 @@ typedef enum { WRITE_LOG } smart_command_set; -// Possible values for fix_firmwarebug. -enum { - FIX_NOTSPECIFIED = 0, - FIX_NONE, - FIX_SAMSUNG, - FIX_SAMSUNG2, - FIX_SAMSUNG3 -}; // ATA Specification Command Register Values (Commands) +#define ATA_CHECK_POWER_MODE 0xe5 #define ATA_IDENTIFY_DEVICE 0xec #define ATA_IDENTIFY_PACKET_DEVICE 0xa1 +#define ATA_IDLE 0xe3 #define ATA_SMART_CMD 0xb0 -#define ATA_CHECK_POWER_MODE 0xe5 +#define ATA_SECURITY_FREEZE_LOCK 0xf5 +#define ATA_SET_FEATURES 0xef +#define ATA_STANDBY_IMMEDIATE 0xe0 + +// SET_FEATURES subcommands +#define ATA_DISABLE_AAM 0xc2 +#define ATA_DISABLE_APM 0x85 +#define ATA_DISABLE_WRITE_CACHE 0x82 +#define ATA_DISABLE_READ_LOOK_AHEAD 0x55 +#define ATA_ENABLE_AAM 0x42 +#define ATA_ENABLE_APM 0x05 +#define ATA_ENABLE_WRITE_CACHE 0x02 +#define ATA_ENABLE_READ_LOOK_AHEAD 0xaa + // 48-bit commands #define ATA_READ_LOG_EXT 0x2F @@ -196,11 +202,12 @@ ASSERT_SIZEOF_STRUCT(ata_smart_attribute, 12); // 5: Selfpereserving bit #define ATTRIBUTE_FLAGS_SELFPRESERVING(x) (x & 0x20) +// 6-15: Reserved for future use +#define ATTRIBUTE_FLAGS_OTHER(x) ((x) & 0xffc0) -// Last ten bits are reserved for future use -/* ata_smart_values is format of the read drive Attribute command */ -/* see Table 34 of T13/1321D Rev 1 spec (Device SMART data structure) for *some* info */ +// Format of data returned by SMART READ DATA +// Table 62 of T13/1699-D (ATA8-ACS) Revision 6a, September 2008 #pragma pack(1) struct ata_smart_values { unsigned short int revnumber; @@ -214,9 +221,10 @@ struct ata_smart_values { unsigned char errorlog_capability; unsigned char vendor_specific_371; // Maxtor, IBM: self-test failure checkpoint see below! unsigned char short_test_completion_time; - unsigned char extend_test_completion_time; + unsigned char extend_test_completion_time_b; // If 0xff, use 16-bit value below unsigned char conveyance_test_completion_time; - unsigned char reserved_375_385[11]; + unsigned short extend_test_completion_time_w; // e04130r2, added to T13/1699-D Revision 1c, April 2005 + unsigned char reserved_377_385[9]; unsigned char vendor_specific_386_510[125]; // Maxtor bytes 508-509 Attribute/Threshold Revision # unsigned char chksum; } ATTR_PACKED; @@ -513,7 +521,7 @@ ASSERT_SIZEOF_STRUCT(ata_selective_self_test_log, 512); // T13/1699-D Revision 3f (Working Draft), December 11, 2006. // SCT Status response (read with SMART_READ_LOG page 0xe0) -// Table 60 of T13/1699-D Revision 3f +// Table 182 of T13/BSR INCITS 529 (ACS-4) Revision 04, August 25, 2014 #pragma pack(1) struct ata_sct_status_response { @@ -537,12 +545,27 @@ struct ata_sct_status_response unsigned char byte205; // 205: reserved (T13/e06152r0-2: Average lifetime temperature) unsigned int over_limit_count; // 206-209: # intervals since last reset with temperature > Max Op Limit unsigned int under_limit_count; // 210-213: # intervals since last reset with temperature < Min Op Limit - unsigned char bytes214_479[266]; // 214-479: reserved + unsigned short smart_status; // 214-215: LBA(32:8) of SMART RETURN STATUS (0, 0x2cf4, 0xc24f) (ACS-4) + unsigned char bytes216_479[479-216+1]; // 216-479: reserved unsigned char vendor_specific[32];// 480-511: vendor specific } ATTR_PACKED; #pragma pack() ASSERT_SIZEOF_STRUCT(ata_sct_status_response, 512); +// SCT Error Recovery Control command (send with SMART_WRITE_LOG page 0xe0) +// Table 88 of T13/1699-D Revision 6a +#pragma pack(1) +struct ata_sct_error_recovery_control_command +{ + unsigned short action_code; // 3 = Error Recovery Control + unsigned short function_code; // 1 = Set, 2 = Return + unsigned short selection_code; // 1 = Read Timer, 2 = Write Timer + unsigned short time_limit; // If set: Recovery time limit in 100ms units + unsigned short words004_255[252]; // reserved +} ATTR_PACKED; +#pragma pack() +ASSERT_SIZEOF_STRUCT(ata_sct_error_recovery_control_command, 512); + // SCT Feature Control command (send with SMART_WRITE_LOG page 0xe0) // Table 72 of T13/1699-D Revision 3f #pragma pack(1) @@ -552,8 +575,8 @@ struct ata_sct_feature_control_command unsigned short function_code; // 1 = Set, 2 = Return, 3 = Return options unsigned short feature_code; // 3 = Temperature logging interval unsigned short state; // Interval - unsigned short option_flags; // Bit 0: persistent, Bits 1-31: reserved - unsigned short words005_255[251]; // reserved + unsigned short option_flags; // Bit 0: persistent, Bits 1-15: reserved + unsigned short words005_255[251]; // reserved } ATTR_PACKED; #pragma pack() ASSERT_SIZEOF_STRUCT(ata_sct_feature_control_command, 512); @@ -626,20 +649,134 @@ struct ata_selective_selftest_args : num_spans(0), pending_time(0), scan_after_select(0) { } }; +// Priority for vendor attribute defs +enum ata_vendor_def_prior +{ + PRIOR_DEFAULT, + PRIOR_DATABASE, + PRIOR_USER +}; + +// Raw attribute value print formats +enum ata_attr_raw_format +{ + RAWFMT_DEFAULT, + RAWFMT_RAW8, + RAWFMT_RAW16, + RAWFMT_RAW48, + RAWFMT_HEX48, + RAWFMT_RAW56, + RAWFMT_HEX56, + RAWFMT_RAW64, + RAWFMT_HEX64, + RAWFMT_RAW16_OPT_RAW16, + RAWFMT_RAW16_OPT_AVG16, + RAWFMT_RAW24_OPT_RAW8, + RAWFMT_RAW24_DIV_RAW24, + RAWFMT_RAW24_DIV_RAW32, + RAWFMT_SEC2HOUR, + RAWFMT_MIN2HOUR, + RAWFMT_HALFMIN2HOUR, + RAWFMT_MSEC24_HOUR32, + RAWFMT_TEMPMINMAX, + RAWFMT_TEMP10X, +}; + +// Attribute flags +enum { + ATTRFLAG_INCREASING = 0x01, // Value not reset (for reallocated/pending counts) + ATTRFLAG_NO_NORMVAL = 0x02, // Normalized value not valid + ATTRFLAG_NO_WORSTVAL = 0x04, // Worst value not valid + ATTRFLAG_HDD_ONLY = 0x08, // DEFAULT setting for HDD only + ATTRFLAG_SSD_ONLY = 0x10, // DEFAULT setting for SSD only +}; + +// Vendor attribute display defs for all attribute ids +class ata_vendor_attr_defs +{ +public: + struct entry + { + std::string name; // Attribute name, empty for default + ata_attr_raw_format raw_format; // Raw value print format + ata_vendor_def_prior priority; // Setting priority + unsigned flags; // ATTRFLAG_* + char byteorder[8+1]; // String [012345rvwz] to define byte order + + entry() + : raw_format(RAWFMT_DEFAULT), + priority(PRIOR_DEFAULT), + flags(0) + { byteorder[0] = 0; } + }; + + entry & operator[](unsigned char id) + { return m_defs[id]; } + + const entry & operator[](unsigned char id) const + { return m_defs[id]; } + +private: + entry m_defs[256]; +}; + + +// Possible values for firmwarebugs +enum firmwarebug_t { + BUG_NONE = 0, + BUG_NOLOGDIR, + BUG_SAMSUNG, + BUG_SAMSUNG2, + BUG_SAMSUNG3, + BUG_XERRORLBA +}; + +// Set of firmware bugs +class firmwarebug_defs +{ +public: + firmwarebug_defs() + : m_bugs(0) { } + + bool is_set(firmwarebug_t bug) const + { return !!(m_bugs & (1 << bug)); } + + void set(firmwarebug_t bug) + { m_bugs |= (1 << bug); } + + void set(firmwarebug_defs bugs) + { m_bugs |= bugs.m_bugs; } + +private: + unsigned m_bugs; +}; + + +// Print ATA debug messages? +extern unsigned char ata_debugmode; + +// Suppress serial number? +extern bool dont_print_serial_number; // Get information from drive -int ataReadHDIdentity(ata_device * device, struct ata_identify_device *buf); +int ata_read_identity(ata_device * device, ata_identify_device * buf, bool fix_swapped_id, + unsigned char * raw_buf = 0); int ataCheckPowerMode(ata_device * device); +// Issue a no-data ATA command with optional sector count register value +bool ata_nodata_command(ata_device * device, unsigned char command, int sector_count = -1); + +// Issue SET FEATURES command with optional sector count register value +bool ata_set_features(ata_device * device, unsigned char features, int sector_count = -1); + /* Read S.M.A.R.T information from drive */ int ataReadSmartValues(ata_device * device,struct ata_smart_values *); int ataReadSmartThresholds(ata_device * device, struct ata_smart_thresholds_pvt *); int ataReadErrorLog (ata_device * device, ata_smart_errorlog *data, - unsigned char fix_firmwarebug); + firmwarebug_defs firmwarebugs); int ataReadSelfTestLog(ata_device * device, ata_smart_selftestlog * data, - unsigned char fix_firmwarebug); + firmwarebug_defs firmwarebugs); int ataReadSelectiveSelfTestLog(ata_device * device, struct ata_selective_self_test_log *data); -int ataSetSmartThresholds(ata_device * device, struct ata_smart_thresholds_pvt *); int ataReadLogDirectory(ata_device * device, ata_smart_log_directory *, bool gpl); // Read GP Log page(s) @@ -651,7 +788,7 @@ bool ataReadSmartLog(ata_device * device, unsigned char logaddr, void * data, unsigned nsectors); // Read SMART Extended Comprehensive Error Log bool ataReadExtErrorLog(ata_device * device, ata_smart_exterrlog * log, - unsigned nsectors); + unsigned page, unsigned nsectors, firmwarebug_defs firmwarebugs); // Read SMART Extended Self-test Log bool ataReadExtSelfTestLog(ata_device * device, ata_smart_extselftestlog * log, unsigned nsectors); @@ -663,6 +800,10 @@ int ataReadSCTTempHist(ata_device * device, ata_sct_temperature_history_table * // Set SCT temperature logging interval int ataSetSCTTempInterval(ata_device * device, unsigned interval, bool persistent); +// Get/Set SCT Error Recovery Control +int ataGetSCTErrorRecoveryControltime(ata_device * device, unsigned type, unsigned short & time_limit); +int ataSetSCTErrorRecoveryControltime(ata_device * device, unsigned type, unsigned short time_limit); + /* Enable/Disable SMART on device */ int ataEnableSmart (ata_device * device); @@ -675,18 +816,21 @@ int ataEnableAutoOffline (ata_device * device); int ataDisableAutoOffline (ata_device * device); /* S.M.A.R.T. test commands */ -int ataSmartOfflineTest (ata_device * device); -int ataSmartExtendSelfTest (ata_device * device); -int ataSmartShortSelfTest (ata_device * device); -int ataSmartShortCapSelfTest (ata_device * device); -int ataSmartExtendCapSelfTest (ata_device * device); -int ataSmartSelfTestAbort (ata_device * device); +int ataSmartTest(ata_device * device, int testtype, bool force, + const ata_selective_selftest_args & args, + const ata_smart_values * sv, uint64_t num_sectors); + int ataWriteSelectiveSelfTestLog(ata_device * device, ata_selective_selftest_args & args, - const ata_smart_values * sv, uint64_t num_sectors); + const ata_smart_values * sv, uint64_t num_sectors, + const ata_selective_selftest_args * prev_spans = 0); -// Returns the latest compatibility of ATA/ATAPI Version the device -// supports. Returns -1 if Version command is not supported -int ataVersionInfo(const char ** description, const ata_identify_device * drive, unsigned short * minor); +// Get World Wide Name (WWN) fields. +// Return NAA field or -1 if WWN is unsupported. +int ata_get_wwn(const ata_identify_device * id, unsigned & oui, uint64_t & unique_id); + +// Get nominal media rotation rate. +// Returns: 0 = not reported, 1 = SSD, >1 = HDD rpm, < 0 = -(Unknown value) +int ata_get_rotation_rate(const ata_identify_device * id); // If SMART supported, this is guaranteed to return 1 if SMART is enabled, else 0. int ataDoesSmartWork(ata_device * device); @@ -694,17 +838,18 @@ int ataDoesSmartWork(ata_device * device); // returns 1 if SMART supported, 0 if not supported or can't tell int ataSmartSupport(const ata_identify_device * drive); +// Return values: +// 1: Write Cache Reordering enabled +// 2: Write Cache Reordering disabled +// -1: error +int ataGetSetSCTWriteCacheReordering(ata_device * device, bool enable, bool persistent, bool set); + // Return values: // 1: SMART enabled // 0: SMART disabled // -1: can't tell if SMART is enabled -- try issuing ataDoesSmartWork command to see int ataIsSmartEnabled(const ata_identify_device * drive); -/* Check SMART for Threshold failure */ -// onlyfailed=0 : are or were any age or prefailure attributes <= threshold -// onlyfailed=1: are any prefailure attributes <= threshold now -int ataCheckSmart(const ata_smart_values * data, const ata_smart_thresholds_pvt * thresholds, int onlyfailed); - int ataSmartStatus2(ata_device * device); int isSmartErrorLogCapable(const ata_smart_values * data, const ata_identify_device * identity); @@ -730,36 +875,47 @@ int isSupportSelectiveSelfTest(const ata_smart_values * data); inline bool isSCTCapable(const ata_identify_device *drive) { return !!(drive->words088_255[206-88] & 0x01); } // 0x01 = SCT support +inline bool isSCTErrorRecoveryControlCapable(const ata_identify_device *drive) + { return ((drive->words088_255[206-88] & 0x09) == 0x09); } // 0x08 = SCT Error Recovery Control support + inline bool isSCTFeatureControlCapable(const ata_identify_device *drive) { return ((drive->words088_255[206-88] & 0x11) == 0x11); } // 0x10 = SCT Feature Control support inline bool isSCTDataTableCapable(const ata_identify_device *drive) { return ((drive->words088_255[206-88] & 0x21) == 0x21); } // 0x20 = SCT Data Table support -int ataSmartTest(ata_device * device, int testtype, const ata_selective_selftest_args & args, - const ata_smart_values * sv, uint64_t num_sectors); - int TestTime(const ata_smart_values * data, int testtype); -// Prints the raw value (with appropriate formatting) into the -// character string out. -int64_t ataPrintSmartAttribRawValue(char *out, - const ata_smart_attribute * attribute, - const unsigned char * defs); - -// Prints Attribute Name for standard SMART attributes. Writes a -// 30 byte string with attribute name into output -void ataPrintSmartAttribName(char * out, unsigned char id, const unsigned char * definitions); - -// This checks the n'th attribute in the attribute list, NOT the -// attribute with id==n. If the attribute does not exist, or the -// attribute is > threshold, then returns zero. If the attribute is -// <= threshold (failing) then we the attribute number if it is a -// prefail attribute. Else we return minus the attribute number if it -// is a usage attribute. -int ataCheckAttribute(const ata_smart_values * data, - const ata_smart_thresholds_pvt * thresholds, - int n); +// Attribute state +enum ata_attr_state +{ + ATTRSTATE_NON_EXISTING, // No such Attribute + ATTRSTATE_NO_NORMVAL, // Normalized value not valid + ATTRSTATE_NO_THRESHOLD, // Unknown or no threshold + ATTRSTATE_OK, // Never failed + ATTRSTATE_FAILED_PAST, // Failed in the past + ATTRSTATE_FAILED_NOW // Failed now +}; + +// Get attribute state +ata_attr_state ata_get_attr_state(const ata_smart_attribute & attr, + int attridx, + const ata_smart_threshold_entry * thresholds, + const ata_vendor_attr_defs & defs, + unsigned char * threshval = 0); + +// Get attribute raw value. +uint64_t ata_get_attr_raw_value(const ata_smart_attribute & attr, + const ata_vendor_attr_defs & defs); + +// Format attribute raw value. +std::string ata_format_attr_raw_value(const ata_smart_attribute & attr, + const ata_vendor_attr_defs & defs); + +// Get attribute name +std::string ata_get_smart_attr_name(unsigned char id, + const ata_vendor_attr_defs & defs, + int rpm = 0); // External handler function, for when a checksum is not correct. Can // simply return if no action is desired, or can print error messages @@ -767,41 +923,37 @@ int ataCheckAttribute(const ata_smart_values * data, // Structure with the incorrect checksum. void checksumwarning(const char *string); -// Returns raw value of Attribute with ID==id. This will be in the -// range 0 to 2^48-1 inclusive. If the Attribute does not exist, -// return -1. -int64_t ATAReturnAttributeRawValue(unsigned char id, const ata_smart_values * data); +// Find attribute index for attribute id, -1 if not found. +int ata_find_attr_index(unsigned char id, const ata_smart_values & smartval); // Return Temperature Attribute raw value selected according to possible // non-default interpretations. If the Attribute does not exist, return 0 -unsigned char ATAReturnTemperatureValue(const ata_smart_values * data, const unsigned char * defs); - - -// This are the meanings of the Self-test failure checkpoint byte. -// This is in the self-test log at offset 4 bytes into the self-test -// descriptor and in the SMART READ DATA structure at byte offset -// 371. These codes are not well documented. The meanings returned by -// this routine are used (at least) by Maxtor and IBM. Returns NULL if -// not recognized. -const char *SelfTestFailureCodeName(unsigned char which); +unsigned char ata_return_temperature_value(const ata_smart_values * data, const ata_vendor_attr_defs & defs); #define MAX_ATTRIBUTE_NUM 256 -// function to parse pairs like "9,minutes" or "220,temp". See end of -// extern.h for definition of defs[]. Returns 0 if pair recognized, -// else 1 if there is a problem. -int parse_attribute_def(const char * pair, unsigned char * defs); +// Parse vendor attribute display def (-v option). +// Return false on error. +bool parse_attribute_def(const char * opt, ata_vendor_attr_defs & defs, + ata_vendor_def_prior priority); // Get ID and increase flag of current pending or offline // uncorrectable attribute. -unsigned char get_unc_attr_id(bool offline, const unsigned char * defs, +unsigned char get_unc_attr_id(bool offline, const ata_vendor_attr_defs & defs, bool & increase); // Return a multiline string containing a list of valid arguments for // parse_attribute_def(). std::string create_vendor_attribute_arg_list(); +// Parse firmwarebug def (-F option). +// Return false on error. +bool parse_firmwarebug_def(const char * opt, firmwarebug_defs & firmwarebugs); + +// Return a string of valid argument words for parse_firmwarebug_def() +const char * get_valid_firmwarebug_args(); + // These are two of the functions that are defined in os_*.c and need // to be ported to get smartmontools onto another OS. @@ -813,33 +965,38 @@ std::string create_vendor_attribute_arg_list(); //int areca_command_interface(int fd, int disknum, smart_command_set command, int select, char *data); -// Optional functions of os_*.c -#ifdef HAVE_ATA_IDENTIFY_IS_CACHED -// Return true if OS caches the ATA identify sector -//int ata_identify_is_cached(int fd); -#endif - // This function is exported to give low-level capability int smartcommandhandler(ata_device * device, smart_command_set command, int select, char *data); // Print one self-test log entry. -bool ataPrintSmartSelfTestEntry(unsigned testnum, unsigned char test_type, - unsigned char test_status, - unsigned short timestamp, - uint64_t failing_lba, - bool print_error_only, bool & print_header); +// Returns: +// -1: failed self-test +// 1: extended self-test completed without error +// 0: otherwise +int ataPrintSmartSelfTestEntry(unsigned testnum, unsigned char test_type, + unsigned char test_status, + unsigned short timestamp, + uint64_t failing_lba, + bool print_error_only, bool & print_header); // Print Smart self-test log, used by smartctl and smartd. int ataPrintSmartSelfTestlog(const ata_smart_selftestlog * data, bool allentries, - unsigned char fix_firmwarebug); + firmwarebug_defs firmwarebugs); + +// Get capacity and sector sizes from IDENTIFY data +struct ata_size_info +{ + uint64_t sectors; + uint64_t capacity; + unsigned log_sector_size; + unsigned phy_sector_size; + unsigned log_sector_offset; +}; -// Get number of sectors from IDENTIFY sector. -uint64_t get_num_sectors(const ata_identify_device * drive); +void ata_get_size_info(const ata_identify_device * id, ata_size_info & sizes); // Convenience function for formatting strings from ata_identify_device. -void format_ata_string(char * out, const char * in, int n, bool fix_swap); -inline void format_ata_string(char * out, const unsigned char * in, int n, bool fix_swap) - { format_ata_string(out, (const char *)in, n, fix_swap); } +void ata_format_id_string(char * out, const unsigned char * in, int n); // Utility routines. unsigned char checksum(const void * data);