root/trunk/smartmontools/atacmds.h @ 2859

Revision 2859, 31.5 KB (checked in by chrfranke, 5 years ago)

Print only one warning on checksum errors in multi sector log.
Remove casts from calls of checksum().

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
Line 
1/*
2 * atacmds.h
3 *
4 * Home page of code is: http://smartmontools.sourceforge.net
5 *
6 * Copyright (C) 2002-9 Bruce Allen <smartmontools-support@lists.sourceforge.net>
7 * Copyright (C) 2008-9 Christian Franke <smartmontools-support@lists.sourceforge.net>
8 * Copyright (C) 1999-2000 Michael Cornwell <cornwell@acm.org>
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
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, 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 */
25
26#ifndef ATACMDS_H_
27#define ATACMDS_H_
28
29#define ATACMDS_H_CVSID "$Id$"
30
31#include "dev_interface.h" // ata_device
32
33// Macro to check expected size of struct at compile time using a
34// dummy typedef.  On size mismatch, compiler reports a negative array
35// size.  If you see an error message of this form, it means that the
36// #pragma pack(1) pragma below is not having the desired effect on
37// your compiler.
38#define ASSERT_SIZEOF_STRUCT(s, n) \
39  typedef char assert_sizeof_struct_##s[(sizeof(struct s) == (n)) ? 1 : -1]
40
41// Add __attribute__((packed)) if compiler supports it
42// because some gcc versions (at least ARM) lack support of #pragma pack()
43#ifdef HAVE_ATTR_PACKED
44#define ATTR_PACKED __attribute__((packed))
45#else
46#define ATTR_PACKED
47#endif
48
49typedef enum {
50  // returns no data, just succeeds or fails
51  ENABLE,
52  DISABLE,
53  AUTOSAVE,
54  IMMEDIATE_OFFLINE,
55  AUTO_OFFLINE,
56  STATUS,       // just says if SMART is working or not
57  STATUS_CHECK, // says if disk's SMART status is healthy, or failing
58  // return 512 bytes of data:
59  READ_VALUES,
60  READ_THRESHOLDS,
61  READ_LOG,
62  IDENTIFY,
63  PIDENTIFY,
64  // returns 1 byte of data
65  CHECK_POWER_MODE,
66  // writes 512 bytes of data:
67  WRITE_LOG
68} smart_command_set;
69
70// Possible values for fix_firmwarebug.
71enum {
72  FIX_NOTSPECIFIED = 0,
73  FIX_NONE,
74  FIX_SAMSUNG,
75  FIX_SAMSUNG2,
76  FIX_SAMSUNG3
77};
78
79// ATA Specification Command Register Values (Commands)
80#define ATA_IDENTIFY_DEVICE             0xec
81#define ATA_IDENTIFY_PACKET_DEVICE      0xa1
82#define ATA_SMART_CMD                   0xb0
83#define ATA_CHECK_POWER_MODE            0xe5
84// 48-bit commands
85#define ATA_READ_LOG_EXT                0x2F
86
87// ATA Specification Feature Register Values (SMART Subcommands).
88// Note that some are obsolete as of ATA-7.
89#define ATA_SMART_READ_VALUES           0xd0
90#define ATA_SMART_READ_THRESHOLDS       0xd1
91#define ATA_SMART_AUTOSAVE              0xd2
92#define ATA_SMART_SAVE                  0xd3
93#define ATA_SMART_IMMEDIATE_OFFLINE     0xd4
94#define ATA_SMART_READ_LOG_SECTOR       0xd5
95#define ATA_SMART_WRITE_LOG_SECTOR      0xd6
96#define ATA_SMART_WRITE_THRESHOLDS      0xd7
97#define ATA_SMART_ENABLE                0xd8
98#define ATA_SMART_DISABLE               0xd9
99#define ATA_SMART_STATUS                0xda
100// SFF 8035i Revision 2 Specification Feature Register Value (SMART
101// Subcommand)
102#define ATA_SMART_AUTO_OFFLINE          0xdb
103
104// Sector Number values for ATA_SMART_IMMEDIATE_OFFLINE Subcommand
105#define OFFLINE_FULL_SCAN               0
106#define SHORT_SELF_TEST                 1
107#define EXTEND_SELF_TEST                2
108#define CONVEYANCE_SELF_TEST            3
109#define SELECTIVE_SELF_TEST             4
110#define ABORT_SELF_TEST                 127
111#define SHORT_CAPTIVE_SELF_TEST         129
112#define EXTEND_CAPTIVE_SELF_TEST        130
113#define CONVEYANCE_CAPTIVE_SELF_TEST    131
114#define SELECTIVE_CAPTIVE_SELF_TEST     132
115#define CAPTIVE_MASK                    (0x01<<7)
116
117// Maximum allowed number of SMART Attributes
118#define NUMBER_ATA_SMART_ATTRIBUTES     30
119
120// Needed parts of the ATA DRIVE IDENTIFY Structure. Those labeled
121// word* are NOT used.
122#pragma pack(1)
123struct ata_identify_device {
124  unsigned short words000_009[10];
125  unsigned char  serial_no[20];
126  unsigned short words020_022[3];
127  unsigned char  fw_rev[8];
128  unsigned char  model[40];
129  unsigned short words047_079[33];
130  unsigned short major_rev_num;
131  unsigned short minor_rev_num;
132  unsigned short command_set_1;
133  unsigned short command_set_2;
134  unsigned short command_set_extension;
135  unsigned short cfs_enable_1;
136  unsigned short word086;
137  unsigned short csf_default;
138  unsigned short words088_255[168];
139} ATTR_PACKED;
140#pragma pack()
141ASSERT_SIZEOF_STRUCT(ata_identify_device, 512);
142
143/* ata_smart_attribute is the vendor specific in SFF-8035 spec */ 
144#pragma pack(1)
145struct ata_smart_attribute {
146  unsigned char id;
147  // meaning of flag bits: see MACROS just below
148  // WARNING: MISALIGNED!
149  unsigned short flags; 
150  unsigned char current;
151  unsigned char worst;
152  unsigned char raw[6];
153  unsigned char reserv;
154} ATTR_PACKED;
155#pragma pack()
156ASSERT_SIZEOF_STRUCT(ata_smart_attribute, 12);
157
158// MACROS to interpret the flags bits in the previous structure.
159// These have not been implemented using bitflags and a union, to make
160// it portable across bit/little endian and different platforms.
161
162// 0: Prefailure bit
163
164// From SFF 8035i Revision 2 page 19: Bit 0 (pre-failure/advisory bit)
165// - If the value of this bit equals zero, an attribute value less
166// than or equal to its corresponding attribute threshold indicates an
167// advisory condition where the usage or age of the device has
168// exceeded its intended design life period. If the value of this bit
169// equals one, an attribute value less than or equal to its
170// corresponding attribute threshold indicates a prefailure condition
171// where imminent loss of data is being predicted.
172#define ATTRIBUTE_FLAGS_PREFAILURE(x) (x & 0x01)
173
174// 1: Online bit
175
176//  From SFF 8035i Revision 2 page 19: Bit 1 (on-line data collection
177// bit) - If the value of this bit equals zero, then the attribute
178// value is updated only during off-line data collection
179// activities. If the value of this bit equals one, then the attribute
180// value is updated during normal operation of the device or during
181// both normal operation and off-line testing.
182#define ATTRIBUTE_FLAGS_ONLINE(x) (x & 0x02)
183
184
185// The following are (probably) IBM's, Maxtors and  Quantum's definitions for the
186// vendor-specific bits:
187// 2: Performance type bit
188#define ATTRIBUTE_FLAGS_PERFORMANCE(x) (x & 0x04)
189
190// 3: Errorrate type bit
191#define ATTRIBUTE_FLAGS_ERRORRATE(x) (x & 0x08)
192
193// 4: Eventcount bit
194#define ATTRIBUTE_FLAGS_EVENTCOUNT(x) (x & 0x10)
195
196// 5: Selfpereserving bit
197#define ATTRIBUTE_FLAGS_SELFPRESERVING(x) (x & 0x20)
198
199
200// Last ten bits are reserved for future use
201
202/* ata_smart_values is format of the read drive Attribute command */
203/* see Table 34 of T13/1321D Rev 1 spec (Device SMART data structure) for *some* info */
204#pragma pack(1)
205struct ata_smart_values {
206  unsigned short int revnumber;
207  struct ata_smart_attribute vendor_attributes [NUMBER_ATA_SMART_ATTRIBUTES];
208  unsigned char offline_data_collection_status;
209  unsigned char self_test_exec_status;  //IBM # segments for offline collection
210  unsigned short int total_time_to_complete_off_line; // IBM different
211  unsigned char vendor_specific_366; // Maxtor & IBM curent segment pointer
212  unsigned char offline_data_collection_capability;
213  unsigned short int smart_capability;
214  unsigned char errorlog_capability;
215  unsigned char vendor_specific_371;  // Maxtor, IBM: self-test failure checkpoint see below!
216  unsigned char short_test_completion_time;
217  unsigned char extend_test_completion_time;
218  unsigned char conveyance_test_completion_time;
219  unsigned char reserved_375_385[11];
220  unsigned char vendor_specific_386_510[125]; // Maxtor bytes 508-509 Attribute/Threshold Revision #
221  unsigned char chksum;
222} ATTR_PACKED;
223#pragma pack()
224ASSERT_SIZEOF_STRUCT(ata_smart_values, 512);
225
226/* Maxtor, IBM: self-test failure checkpoint byte meaning:
227 00 - write test
228 01 - servo basic
229 02 - servo random
230 03 - G-list scan
231 04 - Handling damage
232 05 - Read scan
233*/
234
235/* Vendor attribute of SMART Threshold (compare to ata_smart_attribute above) */
236#pragma pack(1)
237struct ata_smart_threshold_entry {
238  unsigned char id;
239  unsigned char threshold;
240  unsigned char reserved[10];
241} ATTR_PACKED;
242#pragma pack()
243ASSERT_SIZEOF_STRUCT(ata_smart_threshold_entry, 12);
244
245/* Format of Read SMART THreshold Command */
246/* Compare to ata_smart_values above */
247#pragma pack(1)
248struct ata_smart_thresholds_pvt {
249  unsigned short int revnumber;
250  struct ata_smart_threshold_entry thres_entries[NUMBER_ATA_SMART_ATTRIBUTES];
251  unsigned char reserved[149];
252  unsigned char chksum;
253} ATTR_PACKED;
254#pragma pack()
255ASSERT_SIZEOF_STRUCT(ata_smart_thresholds_pvt, 512);
256
257
258// Table 42 of T13/1321D Rev 1 spec (Error Data Structure)
259#pragma pack(1)
260struct ata_smart_errorlog_error_struct {
261  unsigned char reserved;
262  unsigned char error_register;
263  unsigned char sector_count;
264  unsigned char sector_number;
265  unsigned char cylinder_low;
266  unsigned char cylinder_high;
267  unsigned char drive_head;
268  unsigned char status;
269  unsigned char extended_error[19];
270  unsigned char state;
271  unsigned short timestamp;
272} ATTR_PACKED;
273#pragma pack()
274ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_error_struct, 30);
275
276
277// Table 41 of T13/1321D Rev 1 spec (Command Data Structure)
278#pragma pack(1)
279struct ata_smart_errorlog_command_struct {
280  unsigned char devicecontrolreg;
281  unsigned char featuresreg;
282  unsigned char sector_count;
283  unsigned char sector_number;
284  unsigned char cylinder_low;
285  unsigned char cylinder_high;
286  unsigned char drive_head;
287  unsigned char commandreg;
288  unsigned int timestamp;
289} ATTR_PACKED;
290#pragma pack()
291ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_command_struct, 12);
292
293// Table 40 of T13/1321D Rev 1 spec (Error log data structure)
294#pragma pack(1)
295struct ata_smart_errorlog_struct {
296  struct ata_smart_errorlog_command_struct commands[5];
297  struct ata_smart_errorlog_error_struct error_struct;
298} ATTR_PACKED;
299#pragma pack()
300ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_struct, 90);
301
302// Table 39 of T13/1321D Rev 1 spec (SMART error log sector)
303#pragma pack(1)
304struct ata_smart_errorlog {
305  unsigned char revnumber;
306  unsigned char error_log_pointer;
307  struct ata_smart_errorlog_struct errorlog_struct[5];
308  unsigned short int ata_error_count;
309  unsigned char reserved[57];
310  unsigned char checksum;
311} ATTR_PACKED;
312#pragma pack()
313ASSERT_SIZEOF_STRUCT(ata_smart_errorlog, 512);
314
315
316// Extended Comprehensive SMART Error Log data structures
317// See Section A.7 of
318//   AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS)
319//   T13/1699-D Revision 6a (Working Draft), September 6, 2008.
320
321// Command data structure
322// Table A.9 of T13/1699-D Revision 6a
323#pragma pack(1)
324struct ata_smart_exterrlog_command
325{
326  unsigned char device_control_register;
327  unsigned char features_register;
328  unsigned char features_register_hi;
329  unsigned char count_register;
330  unsigned char count_register_hi;
331  unsigned char lba_low_register;
332  unsigned char lba_low_register_hi;
333  unsigned char lba_mid_register;
334  unsigned char lba_mid_register_hi;
335  unsigned char lba_high_register;
336  unsigned char lba_high_register_hi;
337  unsigned char device_register;
338  unsigned char command_register;
339
340  unsigned char reserved;
341  unsigned int timestamp;
342} ATTR_PACKED;
343#pragma pack()
344ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_command, 18);
345
346// Error data structure
347// Table A.10 T13/1699-D Revision 6a
348#pragma pack(1)
349struct ata_smart_exterrlog_error
350{
351  unsigned char device_control_register;
352  unsigned char error_register;
353  unsigned char count_register;
354  unsigned char count_register_hi;
355  unsigned char lba_low_register;
356  unsigned char lba_low_register_hi;
357  unsigned char lba_mid_register;
358  unsigned char lba_mid_register_hi;
359  unsigned char lba_high_register;
360  unsigned char lba_high_register_hi;
361  unsigned char device_register;
362  unsigned char status_register;
363
364  unsigned char extended_error[19];
365  unsigned char state;
366  unsigned short timestamp;
367} ATTR_PACKED;
368#pragma pack()
369ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_error, 34);
370
371// Error log data structure
372// Table A.8 of T13/1699-D Revision 6a
373#pragma pack(1)
374struct ata_smart_exterrlog_error_log
375{
376  ata_smart_exterrlog_command commands[5];
377  ata_smart_exterrlog_error error;
378} ATTR_PACKED;
379#pragma pack()
380ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_error_log, 124);
381
382// Ext. Comprehensive SMART error log
383// Table A.7 of T13/1699-D Revision 6a
384#pragma pack(1)
385struct ata_smart_exterrlog
386{
387  unsigned char version;
388  unsigned char reserved1;
389  unsigned short error_log_index;
390  ata_smart_exterrlog_error_log error_logs[4];
391  unsigned short device_error_count;
392  unsigned char reserved2[9];
393  unsigned char checksum;
394} ATTR_PACKED;
395#pragma pack()
396ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog, 512);
397
398
399// Table 45 of T13/1321D Rev 1 spec (Self-test log descriptor entry)
400#pragma pack(1)
401struct ata_smart_selftestlog_struct {
402  unsigned char selftestnumber; // Sector number register
403  unsigned char selfteststatus;
404  unsigned short int timestamp;
405  unsigned char selftestfailurecheckpoint;
406  unsigned int lbafirstfailure;
407  unsigned char vendorspecific[15];
408} ATTR_PACKED;
409#pragma pack()
410ASSERT_SIZEOF_STRUCT(ata_smart_selftestlog_struct, 24);
411
412// Table 44 of T13/1321D Rev 1 spec (Self-test log data structure)
413#pragma pack(1)
414struct ata_smart_selftestlog {
415  unsigned short int revnumber;
416  struct ata_smart_selftestlog_struct selftest_struct[21];
417  unsigned char vendorspecific[2];
418  unsigned char mostrecenttest;
419  unsigned char reserved[2];
420  unsigned char chksum;
421} ATTR_PACKED;
422#pragma pack()
423ASSERT_SIZEOF_STRUCT(ata_smart_selftestlog, 512);
424
425// Extended SMART Self-test log data structures
426// See Section A.8 of
427//   AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS)
428//   T13/1699-D Revision 6a (Working Draft), September 6, 2008.
429
430// Extended Self-test log descriptor entry
431// Table A.13 of T13/1699-D Revision 6a
432#pragma pack(1)
433struct ata_smart_extselftestlog_desc
434{
435  unsigned char self_test_type;
436  unsigned char self_test_status;
437  unsigned short timestamp;
438  unsigned char checkpoint;
439  unsigned char failing_lba[6];
440  unsigned char vendorspecific[15];
441} ATTR_PACKED;
442#pragma pack()
443ASSERT_SIZEOF_STRUCT(ata_smart_extselftestlog_desc, 26);
444
445// Extended Self-test log data structure
446// Table A.12 of T13/1699-D Revision 6a
447#pragma pack(1)
448struct ata_smart_extselftestlog
449{
450  unsigned char version;
451  unsigned char reserved1;
452  unsigned short log_desc_index;
453  struct ata_smart_extselftestlog_desc log_descs[19];
454  unsigned char vendor_specifc[2];
455  unsigned char reserved2[11];
456  unsigned char chksum;
457} ATTR_PACKED;
458#pragma pack()
459ASSERT_SIZEOF_STRUCT(ata_smart_extselftestlog, 512);
460
461// SMART LOG DIRECTORY Table 52 of T13/1532D Vol 1 Rev 1a
462#pragma pack(1)
463struct ata_smart_log_entry {
464  unsigned char numsectors;
465  unsigned char reserved;
466} ATTR_PACKED;
467#pragma pack()
468ASSERT_SIZEOF_STRUCT(ata_smart_log_entry, 2);
469
470#pragma pack(1)
471struct ata_smart_log_directory {
472  unsigned short int logversion;
473  struct ata_smart_log_entry entry[255];
474} ATTR_PACKED;
475#pragma pack()
476ASSERT_SIZEOF_STRUCT(ata_smart_log_directory, 512);
477
478// SMART SELECTIVE SELF-TEST LOG Table 61 of T13/1532D Volume 1
479// Revision 3
480#pragma pack(1)
481struct test_span {
482  uint64_t start;
483  uint64_t end;
484} ATTR_PACKED;
485#pragma pack()
486ASSERT_SIZEOF_STRUCT(test_span, 16);
487
488#pragma pack(1)
489struct ata_selective_self_test_log {
490  unsigned short     logversion;
491  struct test_span   span[5];
492  unsigned char      reserved1[337-82+1];
493  unsigned char      vendor_specific1[491-338+1];
494  uint64_t           currentlba;
495  unsigned short     currentspan;
496  unsigned short     flags;
497  unsigned char      vendor_specific2[507-504+1];
498  unsigned short     pendingtime;
499  unsigned char      reserved2;
500  unsigned char      checksum;
501} ATTR_PACKED;
502#pragma pack()
503ASSERT_SIZEOF_STRUCT(ata_selective_self_test_log, 512);
504
505#define SELECTIVE_FLAG_DOSCAN  (0x0002)
506#define SELECTIVE_FLAG_PENDING (0x0008)
507#define SELECTIVE_FLAG_ACTIVE  (0x0010)
508
509
510// SCT (SMART Command Transport) data structures
511// See Sections 8.2 and 8.3 of:
512//   AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS)
513//   T13/1699-D Revision 3f (Working Draft), December 11, 2006.
514
515// SCT Status response (read with SMART_READ_LOG page 0xe0)
516// Table 60 of T13/1699-D Revision 3f
517#pragma pack(1)
518struct ata_sct_status_response
519{
520  unsigned short format_version;    // 0-1: Status response format version number (2, 3)
521  unsigned short sct_version;       // 2-3: Vendor specific version number
522  unsigned short sct_spec;          // 4-5: SCT level supported (1)
523  unsigned int status_flags;        // 6-9: Status flags (Bit 0: Segment initialized, Bits 1-31: reserved)
524  unsigned char device_state;       // 10: Device State (0-5)
525  unsigned char bytes011_013[3];    // 11-13: reserved
526  unsigned short ext_status_code;   // 14-15: Status of last SCT command (0xffff if executing)
527  unsigned short action_code;       // 16-17: Action code of last SCT command
528  unsigned short function_code;     // 18-19: Function code of last SCT command
529  unsigned char bytes020_039[20];   // 20-39: reserved
530  uint64_t lba_current;             // 40-47: LBA of SCT command executing in background
531  unsigned char bytes048_199[152];  // 48-199: reserved
532  signed char hda_temp;             // 200: Current temperature in Celsius (0x80 = invalid)
533  signed char min_temp;             // 201: Minimum temperature this power cycle
534  signed char max_temp;             // 202: Maximum temperature this power cycle
535  signed char life_min_temp;        // 203: Minimum lifetime temperature
536  signed char life_max_temp;        // 204: Maximum lifetime temperature
537  unsigned char byte205;            // 205: reserved (T13/e06152r0-2: Average lifetime temperature)
538  unsigned int over_limit_count;    // 206-209: # intervals since last reset with temperature > Max Op Limit
539  unsigned int under_limit_count;   // 210-213: # intervals since last reset with temperature < Min Op Limit
540  unsigned char bytes214_479[266];  // 214-479: reserved
541  unsigned char vendor_specific[32];// 480-511: vendor specific
542} ATTR_PACKED;
543#pragma pack()
544ASSERT_SIZEOF_STRUCT(ata_sct_status_response, 512);
545
546// SCT Feature Control command (send with SMART_WRITE_LOG page 0xe0)
547// Table 72 of T13/1699-D Revision 3f
548#pragma pack(1)
549struct ata_sct_feature_control_command
550{
551  unsigned short action_code;       // 4 = Feature Control
552  unsigned short function_code;     // 1 = Set, 2 = Return, 3 = Return options
553  unsigned short feature_code;      // 3 = Temperature logging interval
554  unsigned short state;             // Interval
555  unsigned short option_flags;      // Bit 0: persistent, Bits 1-31: reserved
556  unsigned short words005_255[251]; // reserved
557} ATTR_PACKED;
558#pragma pack()
559ASSERT_SIZEOF_STRUCT(ata_sct_feature_control_command, 512);
560
561// SCT Data Table command (send with SMART_WRITE_LOG page 0xe0)
562// Table 73 of T13/1699-D Revision 3f
563#pragma pack(1)
564struct ata_sct_data_table_command
565{
566  unsigned short action_code;       // 5 = Data Table
567  unsigned short function_code;     // 1 = Read Table
568  unsigned short table_id;          // 2 = Temperature History
569  unsigned short words003_255[253]; // reserved
570} ATTR_PACKED;
571#pragma pack()
572ASSERT_SIZEOF_STRUCT(ata_sct_data_table_command, 512);
573
574// SCT Temperature History Table (read with SMART_READ_LOG page 0xe1)
575// Table 75 of T13/1699-D Revision 3f
576#pragma pack(1)
577struct ata_sct_temperature_history_table
578{
579  unsigned short format_version;    // 0-1: Data table format version number (2)
580  unsigned short sampling_period;   // 2-3: Temperature sampling period in minutes
581  unsigned short interval;          // 4-5: Timer interval between history entries
582  signed char max_op_limit;         // 6: Maximum recommended continuous operating temperature
583  signed char over_limit;           // 7: Maximum temperature limit
584  signed char min_op_limit;         // 8: Minimum recommended continuous operating limit
585  signed char under_limit;          // 9: Minimum temperature limit
586  unsigned char bytes010_029[20];   // 10-29: reserved
587  unsigned short cb_size;           // 30-31: Number of history entries (range 128-478)
588  unsigned short cb_index;          // 32-33: Index of last updated entry (zero-based)
589  signed char cb[478];              // 34-(34+cb_size-1): Circular buffer of temperature values
590} ATTR_PACKED;
591#pragma pack()
592ASSERT_SIZEOF_STRUCT(ata_sct_temperature_history_table, 512);
593
594// Possible values for span_args.mode
595enum {
596  SEL_RANGE, // MIN-MAX
597  SEL_REDO,  // redo this
598  SEL_NEXT,  // do next range
599  SEL_CONT   // redo or next depending of last test status
600};
601
602// Arguments for selective self-test
603struct ata_selective_selftest_args
604{
605  // Arguments for each span
606  struct span_args
607  {
608    uint64_t start;   // First block
609    uint64_t end;     // Last block
610    int mode;         // SEL_*, see above
611
612    span_args()
613      : start(0), end(0), mode(SEL_RANGE) { }
614  };
615
616  span_args span[5];  // Range and mode for 5 spans
617  int num_spans;      // Number of spans
618  int pending_time;   // One plus time in minutes to wait after powerup before restarting
619                      // interrupted offline scan after selective self-test.
620  int scan_after_select; // Run offline scan after selective self-test:
621                      // 0: don't change,
622                      // 1: turn off scan after selective self-test,
623                      // 2: turn on scan after selective self-test.
624
625  ata_selective_selftest_args()
626    : num_spans(0), pending_time(0), scan_after_select(0) { }
627};
628
629
630// Get information from drive
631int ataReadHDIdentity(ata_device * device, struct ata_identify_device *buf);
632int ataCheckPowerMode(ata_device * device);
633
634/* Read S.M.A.R.T information from drive */
635int ataReadSmartValues(ata_device * device,struct ata_smart_values *);
636int ataReadSmartThresholds(ata_device * device, struct ata_smart_thresholds_pvt *);
637int ataReadErrorLog (ata_device * device, ata_smart_errorlog *data,
638                     unsigned char fix_firmwarebug);
639int ataReadSelfTestLog(ata_device * device, ata_smart_selftestlog * data,
640                       unsigned char fix_firmwarebug);
641int ataReadSelectiveSelfTestLog(ata_device * device, struct ata_selective_self_test_log *data);
642int ataSetSmartThresholds(ata_device * device, struct ata_smart_thresholds_pvt *);
643int ataReadLogDirectory(ata_device * device, ata_smart_log_directory *, bool gpl);
644
645// Read GP Log page(s)
646bool ataReadLogExt(ata_device * device, unsigned char logaddr,
647                   unsigned char features, unsigned page,
648                   void * data, unsigned nsectors);
649// Read SMART Log page(s)
650bool ataReadSmartLog(ata_device * device, unsigned char logaddr,
651                     void * data, unsigned nsectors);
652// Read SMART Extended Comprehensive Error Log
653bool ataReadExtErrorLog(ata_device * device, ata_smart_exterrlog * log,
654                        unsigned nsectors);
655// Read SMART Extended Self-test Log
656bool ataReadExtSelfTestLog(ata_device * device, ata_smart_extselftestlog * log,
657                           unsigned nsectors);
658
659// Read SCT information
660int ataReadSCTStatus(ata_device * device, ata_sct_status_response * sts);
661int ataReadSCTTempHist(ata_device * device, ata_sct_temperature_history_table * tmh,
662                       ata_sct_status_response * sts);
663// Set SCT temperature logging interval
664int ataSetSCTTempInterval(ata_device * device, unsigned interval, bool persistent);
665
666
667/* Enable/Disable SMART on device */
668int ataEnableSmart (ata_device * device);
669int ataDisableSmart (ata_device * device);
670int ataEnableAutoSave(ata_device * device);
671int ataDisableAutoSave(ata_device * device);
672
673/* Automatic Offline Testing */
674int ataEnableAutoOffline (ata_device * device);
675int ataDisableAutoOffline (ata_device * device);
676
677/* S.M.A.R.T. test commands */
678int ataSmartOfflineTest (ata_device * device);
679int ataSmartExtendSelfTest (ata_device * device);
680int ataSmartShortSelfTest (ata_device * device);
681int ataSmartShortCapSelfTest (ata_device * device);
682int ataSmartExtendCapSelfTest (ata_device * device);
683int ataSmartSelfTestAbort (ata_device * device);
684int ataWriteSelectiveSelfTestLog(ata_device * device, ata_selective_selftest_args & args,
685                                 const ata_smart_values * sv, uint64_t num_sectors);
686
687// Returns the latest compatibility of ATA/ATAPI Version the device
688// supports. Returns -1 if Version command is not supported
689int ataVersionInfo(const char ** description, const ata_identify_device * drive, unsigned short * minor);
690
691// If SMART supported, this is guaranteed to return 1 if SMART is enabled, else 0.
692int ataDoesSmartWork(ata_device * device);
693
694// returns 1 if SMART supported, 0 if not supported or can't tell
695int ataSmartSupport(const ata_identify_device * drive);
696
697// Return values:
698//  1: SMART enabled
699//  0: SMART disabled
700// -1: can't tell if SMART is enabled -- try issuing ataDoesSmartWork command to see
701int ataIsSmartEnabled(const ata_identify_device * drive);
702
703/* Check SMART for Threshold failure */
704// onlyfailed=0 : are or were any age or prefailure attributes <= threshold
705// onlyfailed=1:  are any prefailure attributes <= threshold now
706int ataCheckSmart(const ata_smart_values * data, const ata_smart_thresholds_pvt * thresholds, int onlyfailed);
707
708int ataSmartStatus2(ata_device * device);
709
710int isSmartErrorLogCapable(const ata_smart_values * data, const ata_identify_device * identity);
711
712int isSmartTestLogCapable(const ata_smart_values * data, const ata_identify_device * identity);
713
714int isGeneralPurposeLoggingCapable(const ata_identify_device * identity);
715
716int isSupportExecuteOfflineImmediate(const ata_smart_values * data);
717
718int isSupportAutomaticTimer(const ata_smart_values * data);
719
720int isSupportOfflineAbort(const ata_smart_values * data);
721
722int isSupportOfflineSurfaceScan(const ata_smart_values * data);
723
724int isSupportSelfTest(const ata_smart_values * data);
725
726int isSupportConveyanceSelfTest(const ata_smart_values * data);
727
728int isSupportSelectiveSelfTest(const ata_smart_values * data);
729
730inline bool isSCTCapable(const ata_identify_device *drive)
731  { return !!(drive->words088_255[206-88] & 0x01); } // 0x01 = SCT support
732
733inline bool isSCTFeatureControlCapable(const ata_identify_device *drive)
734  { return ((drive->words088_255[206-88] & 0x11) == 0x11); } // 0x10 = SCT Feature Control support
735
736inline bool isSCTDataTableCapable(const ata_identify_device *drive)
737  { return ((drive->words088_255[206-88] & 0x21) == 0x21); } // 0x20 = SCT Data Table support
738
739int ataSmartTest(ata_device * device, int testtype, const ata_selective_selftest_args & args,
740                 const ata_smart_values * sv, uint64_t num_sectors);
741
742int TestTime(const ata_smart_values * data, int testtype);
743
744// Prints the raw value (with appropriate formatting) into the
745// character string out.
746int64_t ataPrintSmartAttribRawValue(char *out, 
747                                    const ata_smart_attribute * attribute,
748                                    const unsigned char * defs);
749
750// Prints Attribute Name for standard SMART attributes. Writes a
751// 30 byte string with attribute name into output
752void ataPrintSmartAttribName(char * out, unsigned char id, const unsigned char * definitions);
753
754// This checks the n'th attribute in the attribute list, NOT the
755// attribute with id==n.  If the attribute does not exist, or the
756// attribute is > threshold, then returns zero.  If the attribute is
757// <= threshold (failing) then we the attribute number if it is a
758// prefail attribute.  Else we return minus the attribute number if it
759// is a usage attribute.
760int ataCheckAttribute(const ata_smart_values * data,
761                      const ata_smart_thresholds_pvt * thresholds,
762                      int n);
763
764// External handler function, for when a checksum is not correct.  Can
765// simply return if no action is desired, or can print error messages
766// as needed, or exit.  Is passed a string with the name of the Data
767// Structure with the incorrect checksum.
768void checksumwarning(const char *string);
769
770// Returns raw value of Attribute with ID==id. This will be in the
771// range 0 to 2^48-1 inclusive.  If the Attribute does not exist,
772// return -1.
773int64_t ATAReturnAttributeRawValue(unsigned char id, const ata_smart_values * data);
774
775// Return Temperature Attribute raw value selected according to possible
776// non-default interpretations. If the Attribute does not exist, return 0
777unsigned char ATAReturnTemperatureValue(const ata_smart_values * data, const unsigned char * defs);
778
779
780// This are the meanings of the Self-test failure checkpoint byte.
781// This is in the self-test log at offset 4 bytes into the self-test
782// descriptor and in the SMART READ DATA structure at byte offset
783// 371. These codes are not well documented.  The meanings returned by
784// this routine are used (at least) by Maxtor and IBM. Returns NULL if
785// not recognized.
786const char *SelfTestFailureCodeName(unsigned char which);
787
788
789#define MAX_ATTRIBUTE_NUM 256
790
791// function to parse pairs like "9,minutes" or "220,temp".  See end of
792// extern.h for definition of defs[].  Returns 0 if pair recognized,
793// else 1 if there is a problem.
794int parse_attribute_def(const char * pair, unsigned char * defs);
795
796// Get ID and increase flag of current pending or offline
797// uncorrectable attribute.
798unsigned char get_unc_attr_id(bool offline, const unsigned char * defs,
799                              bool & increase);
800
801// Return a multiline string containing a list of valid arguments for
802// parse_attribute_def().
803std::string create_vendor_attribute_arg_list();
804
805
806// These are two of the functions that are defined in os_*.c and need
807// to be ported to get smartmontools onto another OS.
808// Moved to C++ interface
809//int ata_command_interface(int device, smart_command_set command, int select, char *data);
810//int escalade_command_interface(int fd, int escalade_port, int escalade_type, smart_command_set command, int select, char *data);
811//int marvell_command_interface(int device, smart_command_set command, int select, char *data);
812//int highpoint_command_interface(int device, smart_command_set command, int select, char *data);
813//int areca_command_interface(int fd, int disknum, smart_command_set command, int select, char *data);
814
815
816// Optional functions of os_*.c
817#ifdef HAVE_ATA_IDENTIFY_IS_CACHED
818// Return true if OS caches the ATA identify sector
819//int ata_identify_is_cached(int fd);
820#endif
821
822// This function is exported to give low-level capability
823int smartcommandhandler(ata_device * device, smart_command_set command, int select, char *data);
824
825// Print one self-test log entry.
826bool ataPrintSmartSelfTestEntry(unsigned testnum, unsigned char test_type,
827                                unsigned char test_status,
828                                unsigned short timestamp,
829                                uint64_t failing_lba,
830                                bool print_error_only, bool & print_header);
831
832// Print Smart self-test log, used by smartctl and smartd.
833int ataPrintSmartSelfTestlog(const ata_smart_selftestlog * data, bool allentries,
834                             unsigned char fix_firmwarebug);
835
836// Get number of sectors from IDENTIFY sector.
837uint64_t get_num_sectors(const ata_identify_device * drive);
838
839// Convenience function for formatting strings from ata_identify_device.
840void format_ata_string(char * out, const char * in, int n, bool fix_swap);
841inline void format_ata_string(char * out, const unsigned char * in, int n, bool fix_swap)
842  { format_ata_string(out, (const char *)in, n, fix_swap); }
843
844// Utility routines.
845unsigned char checksum(const void * data);
846
847void swap2(char *location);
848void swap4(char *location);
849void swap8(char *location);
850// Typesafe variants using overloading
851inline void swapx(unsigned short * p)
852  { swap2((char*)p); }
853inline void swapx(unsigned int * p)
854  { swap4((char*)p); }
855inline void swapx(uint64_t * p)
856  { swap8((char*)p); }
857
858// Return pseudo-device to parse "smartctl -r ataioctl,2 ..." output
859// and simulate an ATA device with same behaviour
860ata_device * get_parsed_ata_device(smart_interface * intf, const char * dev_name);
861
862#endif /* ATACMDS_H_ */
Note: See TracBrowser for help on using the browser.