]>
Commit | Line | Data |
---|---|---|
832b75ed GG |
1 | /* |
2 | * atacmds.h | |
3 | * | |
a86ec89e | 4 | * Home page of code is: http://www.smartmontools.org |
832b75ed | 5 | * |
a86ec89e | 6 | * Copyright (C) 2002-11 Bruce Allen |
f9e10201 | 7 | * Copyright (C) 2008-17 Christian Franke |
832b75ed GG |
8 | * Copyright (C) 1999-2000 Michael Cornwell <cornwell@acm.org> |
9 | * | |
ff28b140 | 10 | * SPDX-License-Identifier: GPL-2.0-or-later |
832b75ed GG |
11 | */ |
12 | ||
13 | #ifndef ATACMDS_H_ | |
14 | #define ATACMDS_H_ | |
15 | ||
ff28b140 | 16 | #define ATACMDS_H_CVSID "$Id: atacmds.h 4848 2018-12-05 18:30:46Z chrfranke $" |
2127e193 GI |
17 | |
18 | #include "dev_interface.h" // ata_device | |
832b75ed GG |
19 | |
20 | // Macro to check expected size of struct at compile time using a | |
21 | // dummy typedef. On size mismatch, compiler reports a negative array | |
22 | // size. If you see an error message of this form, it means that the | |
23 | // #pragma pack(1) pragma below is not having the desired effect on | |
24 | // your compiler. | |
25 | #define ASSERT_SIZEOF_STRUCT(s, n) \ | |
26 | typedef char assert_sizeof_struct_##s[(sizeof(struct s) == (n)) ? 1 : -1] | |
27 | ||
28 | // Add __attribute__((packed)) if compiler supports it | |
29 | // because some gcc versions (at least ARM) lack support of #pragma pack() | |
30 | #ifdef HAVE_ATTR_PACKED | |
31 | #define ATTR_PACKED __attribute__((packed)) | |
32 | #else | |
33 | #define ATTR_PACKED | |
34 | #endif | |
35 | ||
36 | typedef enum { | |
37 | // returns no data, just succeeds or fails | |
38 | ENABLE, | |
39 | DISABLE, | |
40 | AUTOSAVE, | |
41 | IMMEDIATE_OFFLINE, | |
42 | AUTO_OFFLINE, | |
43 | STATUS, // just says if SMART is working or not | |
44 | STATUS_CHECK, // says if disk's SMART status is healthy, or failing | |
45 | // return 512 bytes of data: | |
46 | READ_VALUES, | |
47 | READ_THRESHOLDS, | |
48 | READ_LOG, | |
49 | IDENTIFY, | |
50 | PIDENTIFY, | |
51 | // returns 1 byte of data | |
52 | CHECK_POWER_MODE, | |
53 | // writes 512 bytes of data: | |
54 | WRITE_LOG | |
55 | } smart_command_set; | |
56 | ||
2127e193 | 57 | |
832b75ed | 58 | // ATA Specification Command Register Values (Commands) |
d008864d | 59 | #define ATA_CHECK_POWER_MODE 0xe5 |
2127e193 | 60 | #define ATA_IDENTIFY_DEVICE 0xec |
832b75ed | 61 | #define ATA_IDENTIFY_PACKET_DEVICE 0xa1 |
d008864d | 62 | #define ATA_IDLE 0xe3 |
832b75ed | 63 | #define ATA_SMART_CMD 0xb0 |
d008864d | 64 | #define ATA_SECURITY_FREEZE_LOCK 0xf5 |
f9e10201 | 65 | #ifndef ATA_SET_FEATURES |
d008864d | 66 | #define ATA_SET_FEATURES 0xef |
f9e10201 JD |
67 | #endif |
68 | #define ATA_STANDBY 0xe2 | |
d008864d GI |
69 | #define ATA_STANDBY_IMMEDIATE 0xe0 |
70 | ||
71 | // SET_FEATURES subcommands | |
72 | #define ATA_DISABLE_AAM 0xc2 | |
73 | #define ATA_DISABLE_APM 0x85 | |
74 | #define ATA_DISABLE_WRITE_CACHE 0x82 | |
75 | #define ATA_DISABLE_READ_LOOK_AHEAD 0x55 | |
76 | #define ATA_ENABLE_AAM 0x42 | |
77 | #define ATA_ENABLE_APM 0x05 | |
78 | #define ATA_ENABLE_WRITE_CACHE 0x02 | |
79 | #define ATA_ENABLE_READ_LOOK_AHEAD 0xaa | |
f9e10201 | 80 | #define ATA_ENABLE_DISABLE_DSN 0x63 |
d008864d | 81 | |
2127e193 GI |
82 | // 48-bit commands |
83 | #define ATA_READ_LOG_EXT 0x2F | |
ff28b140 | 84 | #define ATA_WRITE_LOG_EXT 0x3f |
832b75ed GG |
85 | |
86 | // ATA Specification Feature Register Values (SMART Subcommands). | |
87 | // Note that some are obsolete as of ATA-7. | |
88 | #define ATA_SMART_READ_VALUES 0xd0 | |
89 | #define ATA_SMART_READ_THRESHOLDS 0xd1 | |
90 | #define ATA_SMART_AUTOSAVE 0xd2 | |
91 | #define ATA_SMART_SAVE 0xd3 | |
92 | #define ATA_SMART_IMMEDIATE_OFFLINE 0xd4 | |
93 | #define ATA_SMART_READ_LOG_SECTOR 0xd5 | |
94 | #define ATA_SMART_WRITE_LOG_SECTOR 0xd6 | |
95 | #define ATA_SMART_WRITE_THRESHOLDS 0xd7 | |
96 | #define ATA_SMART_ENABLE 0xd8 | |
97 | #define ATA_SMART_DISABLE 0xd9 | |
98 | #define ATA_SMART_STATUS 0xda | |
99 | // SFF 8035i Revision 2 Specification Feature Register Value (SMART | |
100 | // Subcommand) | |
101 | #define ATA_SMART_AUTO_OFFLINE 0xdb | |
102 | ||
103 | // Sector Number values for ATA_SMART_IMMEDIATE_OFFLINE Subcommand | |
104 | #define OFFLINE_FULL_SCAN 0 | |
105 | #define SHORT_SELF_TEST 1 | |
106 | #define EXTEND_SELF_TEST 2 | |
107 | #define CONVEYANCE_SELF_TEST 3 | |
108 | #define SELECTIVE_SELF_TEST 4 | |
109 | #define ABORT_SELF_TEST 127 | |
110 | #define SHORT_CAPTIVE_SELF_TEST 129 | |
111 | #define EXTEND_CAPTIVE_SELF_TEST 130 | |
112 | #define CONVEYANCE_CAPTIVE_SELF_TEST 131 | |
113 | #define SELECTIVE_CAPTIVE_SELF_TEST 132 | |
114 | #define CAPTIVE_MASK (0x01<<7) | |
115 | ||
116 | // Maximum allowed number of SMART Attributes | |
117 | #define NUMBER_ATA_SMART_ATTRIBUTES 30 | |
118 | ||
119 | // Needed parts of the ATA DRIVE IDENTIFY Structure. Those labeled | |
120 | // word* are NOT used. | |
121 | #pragma pack(1) | |
122 | struct ata_identify_device { | |
123 | unsigned short words000_009[10]; | |
124 | unsigned char serial_no[20]; | |
125 | unsigned short words020_022[3]; | |
126 | unsigned char fw_rev[8]; | |
127 | unsigned char model[40]; | |
128 | unsigned short words047_079[33]; | |
129 | unsigned short major_rev_num; | |
130 | unsigned short minor_rev_num; | |
131 | unsigned short command_set_1; | |
132 | unsigned short command_set_2; | |
133 | unsigned short command_set_extension; | |
134 | unsigned short cfs_enable_1; | |
135 | unsigned short word086; | |
136 | unsigned short csf_default; | |
137 | unsigned short words088_255[168]; | |
138 | } ATTR_PACKED; | |
139 | #pragma pack() | |
140 | ASSERT_SIZEOF_STRUCT(ata_identify_device, 512); | |
141 | ||
142 | /* ata_smart_attribute is the vendor specific in SFF-8035 spec */ | |
143 | #pragma pack(1) | |
144 | struct ata_smart_attribute { | |
145 | unsigned char id; | |
146 | // meaning of flag bits: see MACROS just below | |
147 | // WARNING: MISALIGNED! | |
148 | unsigned short flags; | |
149 | unsigned char current; | |
150 | unsigned char worst; | |
151 | unsigned char raw[6]; | |
152 | unsigned char reserv; | |
153 | } ATTR_PACKED; | |
154 | #pragma pack() | |
155 | ASSERT_SIZEOF_STRUCT(ata_smart_attribute, 12); | |
156 | ||
157 | // MACROS to interpret the flags bits in the previous structure. | |
158 | // These have not been implemented using bitflags and a union, to make | |
159 | // it portable across bit/little endian and different platforms. | |
160 | ||
161 | // 0: Prefailure bit | |
162 | ||
163 | // From SFF 8035i Revision 2 page 19: Bit 0 (pre-failure/advisory bit) | |
164 | // - If the value of this bit equals zero, an attribute value less | |
165 | // than or equal to its corresponding attribute threshold indicates an | |
166 | // advisory condition where the usage or age of the device has | |
167 | // exceeded its intended design life period. If the value of this bit | |
168 | // equals one, an attribute value less than or equal to its | |
169 | // corresponding attribute threshold indicates a prefailure condition | |
170 | // where imminent loss of data is being predicted. | |
171 | #define ATTRIBUTE_FLAGS_PREFAILURE(x) (x & 0x01) | |
172 | ||
173 | // 1: Online bit | |
174 | ||
175 | // From SFF 8035i Revision 2 page 19: Bit 1 (on-line data collection | |
176 | // bit) - If the value of this bit equals zero, then the attribute | |
177 | // value is updated only during off-line data collection | |
178 | // activities. If the value of this bit equals one, then the attribute | |
179 | // value is updated during normal operation of the device or during | |
180 | // both normal operation and off-line testing. | |
181 | #define ATTRIBUTE_FLAGS_ONLINE(x) (x & 0x02) | |
182 | ||
183 | ||
184 | // The following are (probably) IBM's, Maxtors and Quantum's definitions for the | |
185 | // vendor-specific bits: | |
186 | // 2: Performance type bit | |
187 | #define ATTRIBUTE_FLAGS_PERFORMANCE(x) (x & 0x04) | |
188 | ||
189 | // 3: Errorrate type bit | |
190 | #define ATTRIBUTE_FLAGS_ERRORRATE(x) (x & 0x08) | |
191 | ||
192 | // 4: Eventcount bit | |
193 | #define ATTRIBUTE_FLAGS_EVENTCOUNT(x) (x & 0x10) | |
194 | ||
195 | // 5: Selfpereserving bit | |
196 | #define ATTRIBUTE_FLAGS_SELFPRESERVING(x) (x & 0x20) | |
197 | ||
a7e8ffec GI |
198 | // 6-15: Reserved for future use |
199 | #define ATTRIBUTE_FLAGS_OTHER(x) ((x) & 0xffc0) | |
832b75ed | 200 | |
832b75ed | 201 | |
d008864d GI |
202 | // Format of data returned by SMART READ DATA |
203 | // Table 62 of T13/1699-D (ATA8-ACS) Revision 6a, September 2008 | |
832b75ed GG |
204 | #pragma pack(1) |
205 | struct 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 | |
ff28b140 | 211 | unsigned char vendor_specific_366; // Maxtor & IBM current segment pointer |
832b75ed GG |
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; | |
d008864d | 217 | unsigned char extend_test_completion_time_b; // If 0xff, use 16-bit value below |
832b75ed | 218 | unsigned char conveyance_test_completion_time; |
d008864d GI |
219 | unsigned short extend_test_completion_time_w; // e04130r2, added to T13/1699-D Revision 1c, April 2005 |
220 | unsigned char reserved_377_385[9]; | |
832b75ed GG |
221 | unsigned char vendor_specific_386_510[125]; // Maxtor bytes 508-509 Attribute/Threshold Revision # |
222 | unsigned char chksum; | |
223 | } ATTR_PACKED; | |
224 | #pragma pack() | |
225 | ASSERT_SIZEOF_STRUCT(ata_smart_values, 512); | |
226 | ||
227 | /* Maxtor, IBM: self-test failure checkpoint byte meaning: | |
228 | 00 - write test | |
229 | 01 - servo basic | |
230 | 02 - servo random | |
231 | 03 - G-list scan | |
232 | 04 - Handling damage | |
233 | 05 - Read scan | |
234 | */ | |
235 | ||
236 | /* Vendor attribute of SMART Threshold (compare to ata_smart_attribute above) */ | |
237 | #pragma pack(1) | |
238 | struct ata_smart_threshold_entry { | |
239 | unsigned char id; | |
240 | unsigned char threshold; | |
241 | unsigned char reserved[10]; | |
242 | } ATTR_PACKED; | |
243 | #pragma pack() | |
244 | ASSERT_SIZEOF_STRUCT(ata_smart_threshold_entry, 12); | |
245 | ||
246 | /* Format of Read SMART THreshold Command */ | |
247 | /* Compare to ata_smart_values above */ | |
248 | #pragma pack(1) | |
249 | struct ata_smart_thresholds_pvt { | |
250 | unsigned short int revnumber; | |
251 | struct ata_smart_threshold_entry thres_entries[NUMBER_ATA_SMART_ATTRIBUTES]; | |
252 | unsigned char reserved[149]; | |
253 | unsigned char chksum; | |
254 | } ATTR_PACKED; | |
255 | #pragma pack() | |
256 | ASSERT_SIZEOF_STRUCT(ata_smart_thresholds_pvt, 512); | |
257 | ||
258 | ||
259 | // Table 42 of T13/1321D Rev 1 spec (Error Data Structure) | |
260 | #pragma pack(1) | |
261 | struct ata_smart_errorlog_error_struct { | |
262 | unsigned char reserved; | |
263 | unsigned char error_register; | |
264 | unsigned char sector_count; | |
265 | unsigned char sector_number; | |
266 | unsigned char cylinder_low; | |
267 | unsigned char cylinder_high; | |
268 | unsigned char drive_head; | |
269 | unsigned char status; | |
270 | unsigned char extended_error[19]; | |
271 | unsigned char state; | |
272 | unsigned short timestamp; | |
273 | } ATTR_PACKED; | |
274 | #pragma pack() | |
275 | ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_error_struct, 30); | |
276 | ||
277 | ||
278 | // Table 41 of T13/1321D Rev 1 spec (Command Data Structure) | |
279 | #pragma pack(1) | |
280 | struct ata_smart_errorlog_command_struct { | |
281 | unsigned char devicecontrolreg; | |
282 | unsigned char featuresreg; | |
283 | unsigned char sector_count; | |
284 | unsigned char sector_number; | |
285 | unsigned char cylinder_low; | |
286 | unsigned char cylinder_high; | |
287 | unsigned char drive_head; | |
288 | unsigned char commandreg; | |
289 | unsigned int timestamp; | |
290 | } ATTR_PACKED; | |
291 | #pragma pack() | |
292 | ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_command_struct, 12); | |
293 | ||
294 | // Table 40 of T13/1321D Rev 1 spec (Error log data structure) | |
295 | #pragma pack(1) | |
296 | struct ata_smart_errorlog_struct { | |
297 | struct ata_smart_errorlog_command_struct commands[5]; | |
298 | struct ata_smart_errorlog_error_struct error_struct; | |
299 | } ATTR_PACKED; | |
300 | #pragma pack() | |
301 | ASSERT_SIZEOF_STRUCT(ata_smart_errorlog_struct, 90); | |
302 | ||
303 | // Table 39 of T13/1321D Rev 1 spec (SMART error log sector) | |
304 | #pragma pack(1) | |
305 | struct ata_smart_errorlog { | |
306 | unsigned char revnumber; | |
307 | unsigned char error_log_pointer; | |
308 | struct ata_smart_errorlog_struct errorlog_struct[5]; | |
309 | unsigned short int ata_error_count; | |
310 | unsigned char reserved[57]; | |
311 | unsigned char checksum; | |
312 | } ATTR_PACKED; | |
313 | #pragma pack() | |
314 | ASSERT_SIZEOF_STRUCT(ata_smart_errorlog, 512); | |
315 | ||
2127e193 GI |
316 | |
317 | // Extended Comprehensive SMART Error Log data structures | |
318 | // See Section A.7 of | |
319 | // AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS) | |
320 | // T13/1699-D Revision 6a (Working Draft), September 6, 2008. | |
321 | ||
322 | // Command data structure | |
323 | // Table A.9 of T13/1699-D Revision 6a | |
324 | #pragma pack(1) | |
325 | struct ata_smart_exterrlog_command | |
326 | { | |
327 | unsigned char device_control_register; | |
328 | unsigned char features_register; | |
329 | unsigned char features_register_hi; | |
330 | unsigned char count_register; | |
331 | unsigned char count_register_hi; | |
332 | unsigned char lba_low_register; | |
333 | unsigned char lba_low_register_hi; | |
334 | unsigned char lba_mid_register; | |
335 | unsigned char lba_mid_register_hi; | |
336 | unsigned char lba_high_register; | |
337 | unsigned char lba_high_register_hi; | |
338 | unsigned char device_register; | |
339 | unsigned char command_register; | |
340 | ||
341 | unsigned char reserved; | |
342 | unsigned int timestamp; | |
343 | } ATTR_PACKED; | |
344 | #pragma pack() | |
345 | ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_command, 18); | |
346 | ||
347 | // Error data structure | |
348 | // Table A.10 T13/1699-D Revision 6a | |
349 | #pragma pack(1) | |
350 | struct ata_smart_exterrlog_error | |
351 | { | |
352 | unsigned char device_control_register; | |
353 | unsigned char error_register; | |
354 | unsigned char count_register; | |
355 | unsigned char count_register_hi; | |
356 | unsigned char lba_low_register; | |
357 | unsigned char lba_low_register_hi; | |
358 | unsigned char lba_mid_register; | |
359 | unsigned char lba_mid_register_hi; | |
360 | unsigned char lba_high_register; | |
361 | unsigned char lba_high_register_hi; | |
362 | unsigned char device_register; | |
363 | unsigned char status_register; | |
364 | ||
365 | unsigned char extended_error[19]; | |
366 | unsigned char state; | |
367 | unsigned short timestamp; | |
368 | } ATTR_PACKED; | |
369 | #pragma pack() | |
370 | ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_error, 34); | |
371 | ||
372 | // Error log data structure | |
373 | // Table A.8 of T13/1699-D Revision 6a | |
374 | #pragma pack(1) | |
375 | struct ata_smart_exterrlog_error_log | |
376 | { | |
377 | ata_smart_exterrlog_command commands[5]; | |
378 | ata_smart_exterrlog_error error; | |
379 | } ATTR_PACKED; | |
380 | #pragma pack() | |
381 | ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog_error_log, 124); | |
382 | ||
383 | // Ext. Comprehensive SMART error log | |
384 | // Table A.7 of T13/1699-D Revision 6a | |
385 | #pragma pack(1) | |
386 | struct ata_smart_exterrlog | |
387 | { | |
388 | unsigned char version; | |
389 | unsigned char reserved1; | |
390 | unsigned short error_log_index; | |
391 | ata_smart_exterrlog_error_log error_logs[4]; | |
392 | unsigned short device_error_count; | |
393 | unsigned char reserved2[9]; | |
394 | unsigned char checksum; | |
395 | } ATTR_PACKED; | |
396 | #pragma pack() | |
397 | ASSERT_SIZEOF_STRUCT(ata_smart_exterrlog, 512); | |
398 | ||
399 | ||
832b75ed GG |
400 | // Table 45 of T13/1321D Rev 1 spec (Self-test log descriptor entry) |
401 | #pragma pack(1) | |
402 | struct ata_smart_selftestlog_struct { | |
403 | unsigned char selftestnumber; // Sector number register | |
404 | unsigned char selfteststatus; | |
405 | unsigned short int timestamp; | |
406 | unsigned char selftestfailurecheckpoint; | |
407 | unsigned int lbafirstfailure; | |
408 | unsigned char vendorspecific[15]; | |
409 | } ATTR_PACKED; | |
410 | #pragma pack() | |
411 | ASSERT_SIZEOF_STRUCT(ata_smart_selftestlog_struct, 24); | |
412 | ||
413 | // Table 44 of T13/1321D Rev 1 spec (Self-test log data structure) | |
414 | #pragma pack(1) | |
415 | struct ata_smart_selftestlog { | |
416 | unsigned short int revnumber; | |
417 | struct ata_smart_selftestlog_struct selftest_struct[21]; | |
418 | unsigned char vendorspecific[2]; | |
419 | unsigned char mostrecenttest; | |
420 | unsigned char reserved[2]; | |
421 | unsigned char chksum; | |
422 | } ATTR_PACKED; | |
423 | #pragma pack() | |
424 | ASSERT_SIZEOF_STRUCT(ata_smart_selftestlog, 512); | |
425 | ||
2127e193 GI |
426 | // Extended SMART Self-test log data structures |
427 | // See Section A.8 of | |
428 | // AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS) | |
429 | // T13/1699-D Revision 6a (Working Draft), September 6, 2008. | |
430 | ||
431 | // Extended Self-test log descriptor entry | |
432 | // Table A.13 of T13/1699-D Revision 6a | |
433 | #pragma pack(1) | |
434 | struct ata_smart_extselftestlog_desc | |
435 | { | |
436 | unsigned char self_test_type; | |
437 | unsigned char self_test_status; | |
438 | unsigned short timestamp; | |
439 | unsigned char checkpoint; | |
440 | unsigned char failing_lba[6]; | |
441 | unsigned char vendorspecific[15]; | |
442 | } ATTR_PACKED; | |
443 | #pragma pack() | |
444 | ASSERT_SIZEOF_STRUCT(ata_smart_extselftestlog_desc, 26); | |
445 | ||
446 | // Extended Self-test log data structure | |
447 | // Table A.12 of T13/1699-D Revision 6a | |
448 | #pragma pack(1) | |
449 | struct ata_smart_extselftestlog | |
450 | { | |
451 | unsigned char version; | |
452 | unsigned char reserved1; | |
453 | unsigned short log_desc_index; | |
454 | struct ata_smart_extselftestlog_desc log_descs[19]; | |
455 | unsigned char vendor_specifc[2]; | |
456 | unsigned char reserved2[11]; | |
457 | unsigned char chksum; | |
458 | } ATTR_PACKED; | |
459 | #pragma pack() | |
460 | ASSERT_SIZEOF_STRUCT(ata_smart_extselftestlog, 512); | |
461 | ||
832b75ed GG |
462 | // SMART LOG DIRECTORY Table 52 of T13/1532D Vol 1 Rev 1a |
463 | #pragma pack(1) | |
464 | struct ata_smart_log_entry { | |
465 | unsigned char numsectors; | |
466 | unsigned char reserved; | |
467 | } ATTR_PACKED; | |
468 | #pragma pack() | |
469 | ASSERT_SIZEOF_STRUCT(ata_smart_log_entry, 2); | |
470 | ||
471 | #pragma pack(1) | |
472 | struct ata_smart_log_directory { | |
473 | unsigned short int logversion; | |
474 | struct ata_smart_log_entry entry[255]; | |
475 | } ATTR_PACKED; | |
476 | #pragma pack() | |
477 | ASSERT_SIZEOF_STRUCT(ata_smart_log_directory, 512); | |
478 | ||
479 | // SMART SELECTIVE SELF-TEST LOG Table 61 of T13/1532D Volume 1 | |
480 | // Revision 3 | |
481 | #pragma pack(1) | |
482 | struct test_span { | |
483 | uint64_t start; | |
484 | uint64_t end; | |
485 | } ATTR_PACKED; | |
486 | #pragma pack() | |
487 | ASSERT_SIZEOF_STRUCT(test_span, 16); | |
488 | ||
489 | #pragma pack(1) | |
490 | struct ata_selective_self_test_log { | |
491 | unsigned short logversion; | |
492 | struct test_span span[5]; | |
493 | unsigned char reserved1[337-82+1]; | |
494 | unsigned char vendor_specific1[491-338+1]; | |
495 | uint64_t currentlba; | |
496 | unsigned short currentspan; | |
497 | unsigned short flags; | |
498 | unsigned char vendor_specific2[507-504+1]; | |
499 | unsigned short pendingtime; | |
500 | unsigned char reserved2; | |
501 | unsigned char checksum; | |
502 | } ATTR_PACKED; | |
503 | #pragma pack() | |
504 | ASSERT_SIZEOF_STRUCT(ata_selective_self_test_log, 512); | |
505 | ||
506 | #define SELECTIVE_FLAG_DOSCAN (0x0002) | |
507 | #define SELECTIVE_FLAG_PENDING (0x0008) | |
508 | #define SELECTIVE_FLAG_ACTIVE (0x0010) | |
509 | ||
a37e7145 GG |
510 | |
511 | // SCT (SMART Command Transport) data structures | |
512 | // See Sections 8.2 and 8.3 of: | |
513 | // AT Attachment 8 - ATA/ATAPI Command Set (ATA8-ACS) | |
514 | // T13/1699-D Revision 3f (Working Draft), December 11, 2006. | |
515 | ||
516 | // SCT Status response (read with SMART_READ_LOG page 0xe0) | |
ff28b140 | 517 | // Table 194 of T13/BSR INCITS 529 (ACS-4) Revision 20, October 26, 2017 |
a37e7145 GG |
518 | #pragma pack(1) |
519 | struct ata_sct_status_response | |
520 | { | |
521 | unsigned short format_version; // 0-1: Status response format version number (2, 3) | |
522 | unsigned short sct_version; // 2-3: Vendor specific version number | |
523 | unsigned short sct_spec; // 4-5: SCT level supported (1) | |
524 | unsigned int status_flags; // 6-9: Status flags (Bit 0: Segment initialized, Bits 1-31: reserved) | |
525 | unsigned char device_state; // 10: Device State (0-5) | |
526 | unsigned char bytes011_013[3]; // 11-13: reserved | |
527 | unsigned short ext_status_code; // 14-15: Status of last SCT command (0xffff if executing) | |
528 | unsigned short action_code; // 16-17: Action code of last SCT command | |
529 | unsigned short function_code; // 18-19: Function code of last SCT command | |
530 | unsigned char bytes020_039[20]; // 20-39: reserved | |
531 | uint64_t lba_current; // 40-47: LBA of SCT command executing in background | |
532 | unsigned char bytes048_199[152]; // 48-199: reserved | |
533 | signed char hda_temp; // 200: Current temperature in Celsius (0x80 = invalid) | |
534 | signed char min_temp; // 201: Minimum temperature this power cycle | |
535 | signed char max_temp; // 202: Maximum temperature this power cycle | |
536 | signed char life_min_temp; // 203: Minimum lifetime temperature | |
537 | signed char life_max_temp; // 204: Maximum lifetime temperature | |
ff28b140 | 538 | signed char max_op_limit; // 205: Specified maximum operating temperature (ACS-4) |
a37e7145 GG |
539 | unsigned int over_limit_count; // 206-209: # intervals since last reset with temperature > Max Op Limit |
540 | unsigned int under_limit_count; // 210-213: # intervals since last reset with temperature < Min Op Limit | |
a86ec89e | 541 | unsigned short smart_status; // 214-215: LBA(32:8) of SMART RETURN STATUS (0, 0x2cf4, 0xc24f) (ACS-4) |
f9e10201 JD |
542 | unsigned short min_erc_time; // 216-217: Minimum supported value for ERC (ACS-4) |
543 | unsigned char bytes216_479[479-218+1]; // 218-479: reserved | |
a37e7145 GG |
544 | unsigned char vendor_specific[32];// 480-511: vendor specific |
545 | } ATTR_PACKED; | |
546 | #pragma pack() | |
547 | ASSERT_SIZEOF_STRUCT(ata_sct_status_response, 512); | |
548 | ||
7f0798ef GI |
549 | // SCT Error Recovery Control command (send with SMART_WRITE_LOG page 0xe0) |
550 | // Table 88 of T13/1699-D Revision 6a | |
551 | #pragma pack(1) | |
552 | struct ata_sct_error_recovery_control_command | |
553 | { | |
554 | unsigned short action_code; // 3 = Error Recovery Control | |
555 | unsigned short function_code; // 1 = Set, 2 = Return | |
556 | unsigned short selection_code; // 1 = Read Timer, 2 = Write Timer | |
557 | unsigned short time_limit; // If set: Recovery time limit in 100ms units | |
558 | unsigned short words004_255[252]; // reserved | |
559 | } ATTR_PACKED; | |
560 | #pragma pack() | |
561 | ASSERT_SIZEOF_STRUCT(ata_sct_error_recovery_control_command, 512); | |
562 | ||
a37e7145 GG |
563 | // SCT Feature Control command (send with SMART_WRITE_LOG page 0xe0) |
564 | // Table 72 of T13/1699-D Revision 3f | |
565 | #pragma pack(1) | |
566 | struct ata_sct_feature_control_command | |
567 | { | |
568 | unsigned short action_code; // 4 = Feature Control | |
569 | unsigned short function_code; // 1 = Set, 2 = Return, 3 = Return options | |
570 | unsigned short feature_code; // 3 = Temperature logging interval | |
571 | unsigned short state; // Interval | |
7f0798ef GI |
572 | unsigned short option_flags; // Bit 0: persistent, Bits 1-15: reserved |
573 | unsigned short words005_255[251]; // reserved | |
a37e7145 GG |
574 | } ATTR_PACKED; |
575 | #pragma pack() | |
576 | ASSERT_SIZEOF_STRUCT(ata_sct_feature_control_command, 512); | |
577 | ||
578 | // SCT Data Table command (send with SMART_WRITE_LOG page 0xe0) | |
579 | // Table 73 of T13/1699-D Revision 3f | |
580 | #pragma pack(1) | |
581 | struct ata_sct_data_table_command | |
582 | { | |
583 | unsigned short action_code; // 5 = Data Table | |
584 | unsigned short function_code; // 1 = Read Table | |
585 | unsigned short table_id; // 2 = Temperature History | |
586 | unsigned short words003_255[253]; // reserved | |
587 | } ATTR_PACKED; | |
588 | #pragma pack() | |
589 | ASSERT_SIZEOF_STRUCT(ata_sct_data_table_command, 512); | |
590 | ||
591 | // SCT Temperature History Table (read with SMART_READ_LOG page 0xe1) | |
592 | // Table 75 of T13/1699-D Revision 3f | |
593 | #pragma pack(1) | |
594 | struct ata_sct_temperature_history_table | |
595 | { | |
596 | unsigned short format_version; // 0-1: Data table format version number (2) | |
597 | unsigned short sampling_period; // 2-3: Temperature sampling period in minutes | |
598 | unsigned short interval; // 4-5: Timer interval between history entries | |
599 | signed char max_op_limit; // 6: Maximum recommended continuous operating temperature | |
600 | signed char over_limit; // 7: Maximum temperature limit | |
601 | signed char min_op_limit; // 8: Minimum recommended continuous operating limit | |
602 | signed char under_limit; // 9: Minimum temperature limit | |
603 | unsigned char bytes010_029[20]; // 10-29: reserved | |
604 | unsigned short cb_size; // 30-31: Number of history entries (range 128-478) | |
605 | unsigned short cb_index; // 32-33: Index of last updated entry (zero-based) | |
606 | signed char cb[478]; // 34-(34+cb_size-1): Circular buffer of temperature values | |
607 | } ATTR_PACKED; | |
608 | #pragma pack() | |
609 | ASSERT_SIZEOF_STRUCT(ata_sct_temperature_history_table, 512); | |
610 | ||
2127e193 GI |
611 | // Possible values for span_args.mode |
612 | enum { | |
613 | SEL_RANGE, // MIN-MAX | |
614 | SEL_REDO, // redo this | |
615 | SEL_NEXT, // do next range | |
616 | SEL_CONT // redo or next depending of last test status | |
617 | }; | |
618 | ||
619 | // Arguments for selective self-test | |
620 | struct ata_selective_selftest_args | |
621 | { | |
622 | // Arguments for each span | |
623 | struct span_args | |
624 | { | |
625 | uint64_t start; // First block | |
626 | uint64_t end; // Last block | |
627 | int mode; // SEL_*, see above | |
628 | ||
629 | span_args() | |
630 | : start(0), end(0), mode(SEL_RANGE) { } | |
631 | }; | |
632 | ||
633 | span_args span[5]; // Range and mode for 5 spans | |
634 | int num_spans; // Number of spans | |
635 | int pending_time; // One plus time in minutes to wait after powerup before restarting | |
636 | // interrupted offline scan after selective self-test. | |
637 | int scan_after_select; // Run offline scan after selective self-test: | |
638 | // 0: don't change, | |
639 | // 1: turn off scan after selective self-test, | |
640 | // 2: turn on scan after selective self-test. | |
641 | ||
642 | ata_selective_selftest_args() | |
643 | : num_spans(0), pending_time(0), scan_after_select(0) { } | |
644 | }; | |
645 | ||
bed94269 GI |
646 | // Priority for vendor attribute defs |
647 | enum ata_vendor_def_prior | |
648 | { | |
649 | PRIOR_DEFAULT, | |
650 | PRIOR_DATABASE, | |
651 | PRIOR_USER | |
652 | }; | |
653 | ||
654 | // Raw attribute value print formats | |
655 | enum ata_attr_raw_format | |
656 | { | |
657 | RAWFMT_DEFAULT, | |
658 | RAWFMT_RAW8, | |
659 | RAWFMT_RAW16, | |
660 | RAWFMT_RAW48, | |
661 | RAWFMT_HEX48, | |
e165493d GI |
662 | RAWFMT_RAW56, |
663 | RAWFMT_HEX56, | |
bed94269 GI |
664 | RAWFMT_RAW64, |
665 | RAWFMT_HEX64, | |
666 | RAWFMT_RAW16_OPT_RAW16, | |
667 | RAWFMT_RAW16_OPT_AVG16, | |
e165493d | 668 | RAWFMT_RAW24_OPT_RAW8, |
cfbba5b9 GI |
669 | RAWFMT_RAW24_DIV_RAW24, |
670 | RAWFMT_RAW24_DIV_RAW32, | |
bed94269 GI |
671 | RAWFMT_SEC2HOUR, |
672 | RAWFMT_MIN2HOUR, | |
673 | RAWFMT_HALFMIN2HOUR, | |
cfbba5b9 | 674 | RAWFMT_MSEC24_HOUR32, |
bed94269 GI |
675 | RAWFMT_TEMPMINMAX, |
676 | RAWFMT_TEMP10X, | |
677 | }; | |
678 | ||
679 | // Attribute flags | |
680 | enum { | |
a86ec89e GI |
681 | ATTRFLAG_INCREASING = 0x01, // Value not reset (for reallocated/pending counts) |
682 | ATTRFLAG_NO_NORMVAL = 0x02, // Normalized value not valid | |
683 | ATTRFLAG_NO_WORSTVAL = 0x04, // Worst value not valid | |
684 | ATTRFLAG_HDD_ONLY = 0x08, // DEFAULT setting for HDD only | |
685 | ATTRFLAG_SSD_ONLY = 0x10, // DEFAULT setting for SSD only | |
bed94269 GI |
686 | }; |
687 | ||
688 | // Vendor attribute display defs for all attribute ids | |
689 | class ata_vendor_attr_defs | |
690 | { | |
691 | public: | |
692 | struct entry | |
693 | { | |
694 | std::string name; // Attribute name, empty for default | |
695 | ata_attr_raw_format raw_format; // Raw value print format | |
696 | ata_vendor_def_prior priority; // Setting priority | |
697 | unsigned flags; // ATTRFLAG_* | |
a23d5117 | 698 | char byteorder[8+1]; // String [012345rvwz] to define byte order |
bed94269 GI |
699 | |
700 | entry() | |
701 | : raw_format(RAWFMT_DEFAULT), | |
702 | priority(PRIOR_DEFAULT), | |
703 | flags(0) | |
a23d5117 | 704 | { byteorder[0] = 0; } |
bed94269 GI |
705 | }; |
706 | ||
707 | entry & operator[](unsigned char id) | |
708 | { return m_defs[id]; } | |
709 | ||
710 | const entry & operator[](unsigned char id) const | |
711 | { return m_defs[id]; } | |
712 | ||
713 | private: | |
714 | entry m_defs[256]; | |
715 | }; | |
716 | ||
a37e7145 | 717 | |
ee38a438 GI |
718 | // Possible values for firmwarebugs |
719 | enum firmwarebug_t { | |
720 | BUG_NONE = 0, | |
721 | BUG_NOLOGDIR, | |
722 | BUG_SAMSUNG, | |
723 | BUG_SAMSUNG2, | |
724 | BUG_SAMSUNG3, | |
725 | BUG_XERRORLBA | |
726 | }; | |
727 | ||
728 | // Set of firmware bugs | |
729 | class firmwarebug_defs | |
730 | { | |
731 | public: | |
732 | firmwarebug_defs() | |
733 | : m_bugs(0) { } | |
734 | ||
735 | bool is_set(firmwarebug_t bug) const | |
736 | { return !!(m_bugs & (1 << bug)); } | |
737 | ||
738 | void set(firmwarebug_t bug) | |
739 | { m_bugs |= (1 << bug); } | |
740 | ||
741 | void set(firmwarebug_defs bugs) | |
742 | { m_bugs |= bugs.m_bugs; } | |
743 | ||
744 | private: | |
745 | unsigned m_bugs; | |
746 | }; | |
747 | ||
748 | ||
cfbba5b9 GI |
749 | // Print ATA debug messages? |
750 | extern unsigned char ata_debugmode; | |
751 | ||
752 | // Suppress serial number? | |
753 | extern bool dont_print_serial_number; | |
754 | ||
832b75ed | 755 | // Get information from drive |
ee38a438 GI |
756 | int ata_read_identity(ata_device * device, ata_identify_device * buf, bool fix_swapped_id, |
757 | unsigned char * raw_buf = 0); | |
2127e193 | 758 | int ataCheckPowerMode(ata_device * device); |
832b75ed | 759 | |
d008864d GI |
760 | // Issue a no-data ATA command with optional sector count register value |
761 | bool ata_nodata_command(ata_device * device, unsigned char command, int sector_count = -1); | |
762 | ||
763 | // Issue SET FEATURES command with optional sector count register value | |
764 | bool ata_set_features(ata_device * device, unsigned char features, int sector_count = -1); | |
765 | ||
832b75ed | 766 | /* Read S.M.A.R.T information from drive */ |
2127e193 GI |
767 | int ataReadSmartValues(ata_device * device,struct ata_smart_values *); |
768 | int ataReadSmartThresholds(ata_device * device, struct ata_smart_thresholds_pvt *); | |
769 | int ataReadErrorLog (ata_device * device, ata_smart_errorlog *data, | |
ee38a438 | 770 | firmwarebug_defs firmwarebugs); |
2127e193 | 771 | int ataReadSelfTestLog(ata_device * device, ata_smart_selftestlog * data, |
ee38a438 | 772 | firmwarebug_defs firmwarebugs); |
2127e193 | 773 | int ataReadSelectiveSelfTestLog(ata_device * device, struct ata_selective_self_test_log *data); |
2127e193 GI |
774 | int ataReadLogDirectory(ata_device * device, ata_smart_log_directory *, bool gpl); |
775 | ||
f9e10201 JD |
776 | // Write GP Log page(s) |
777 | bool ataWriteLogExt(ata_device * device, unsigned char logaddr, | |
778 | unsigned page, void * data, unsigned nsectors); | |
779 | ||
2127e193 GI |
780 | // Read GP Log page(s) |
781 | bool ataReadLogExt(ata_device * device, unsigned char logaddr, | |
782 | unsigned char features, unsigned page, | |
783 | void * data, unsigned nsectors); | |
784 | // Read SMART Log page(s) | |
785 | bool ataReadSmartLog(ata_device * device, unsigned char logaddr, | |
786 | void * data, unsigned nsectors); | |
787 | // Read SMART Extended Comprehensive Error Log | |
788 | bool ataReadExtErrorLog(ata_device * device, ata_smart_exterrlog * log, | |
a86ec89e | 789 | unsigned page, unsigned nsectors, firmwarebug_defs firmwarebugs); |
2127e193 GI |
790 | // Read SMART Extended Self-test Log |
791 | bool ataReadExtSelfTestLog(ata_device * device, ata_smart_extselftestlog * log, | |
792 | unsigned nsectors); | |
a37e7145 GG |
793 | |
794 | // Read SCT information | |
2127e193 GI |
795 | int ataReadSCTStatus(ata_device * device, ata_sct_status_response * sts); |
796 | int ataReadSCTTempHist(ata_device * device, ata_sct_temperature_history_table * tmh, | |
a37e7145 GG |
797 | ata_sct_status_response * sts); |
798 | // Set SCT temperature logging interval | |
2127e193 | 799 | int ataSetSCTTempInterval(ata_device * device, unsigned interval, bool persistent); |
a37e7145 | 800 | |
7f0798ef GI |
801 | // Get/Set SCT Error Recovery Control |
802 | int ataGetSCTErrorRecoveryControltime(ata_device * device, unsigned type, unsigned short & time_limit); | |
803 | int ataSetSCTErrorRecoveryControltime(ata_device * device, unsigned type, unsigned short time_limit); | |
804 | ||
832b75ed GG |
805 | |
806 | /* Enable/Disable SMART on device */ | |
2127e193 GI |
807 | int ataEnableSmart (ata_device * device); |
808 | int ataDisableSmart (ata_device * device); | |
809 | int ataEnableAutoSave(ata_device * device); | |
810 | int ataDisableAutoSave(ata_device * device); | |
832b75ed GG |
811 | |
812 | /* Automatic Offline Testing */ | |
2127e193 GI |
813 | int ataEnableAutoOffline (ata_device * device); |
814 | int ataDisableAutoOffline (ata_device * device); | |
832b75ed GG |
815 | |
816 | /* S.M.A.R.T. test commands */ | |
d008864d GI |
817 | int ataSmartTest(ata_device * device, int testtype, bool force, |
818 | const ata_selective_selftest_args & args, | |
819 | const ata_smart_values * sv, uint64_t num_sectors); | |
820 | ||
2127e193 | 821 | int ataWriteSelectiveSelfTestLog(ata_device * device, ata_selective_selftest_args & args, |
cfbba5b9 GI |
822 | const ata_smart_values * sv, uint64_t num_sectors, |
823 | const ata_selective_selftest_args * prev_spans = 0); | |
832b75ed | 824 | |
a7e8ffec GI |
825 | // Get World Wide Name (WWN) fields. |
826 | // Return NAA field or -1 if WWN is unsupported. | |
827 | int ata_get_wwn(const ata_identify_device * id, unsigned & oui, uint64_t & unique_id); | |
828 | ||
ee38a438 GI |
829 | // Get nominal media rotation rate. |
830 | // Returns: 0 = not reported, 1 = SSD, >1 = HDD rpm, < 0 = -(Unknown value) | |
831 | int ata_get_rotation_rate(const ata_identify_device * id); | |
832 | ||
832b75ed | 833 | // If SMART supported, this is guaranteed to return 1 if SMART is enabled, else 0. |
2127e193 | 834 | int ataDoesSmartWork(ata_device * device); |
832b75ed GG |
835 | |
836 | // returns 1 if SMART supported, 0 if not supported or can't tell | |
2127e193 | 837 | int ataSmartSupport(const ata_identify_device * drive); |
832b75ed | 838 | |
3d17a85c GI |
839 | // Return values: |
840 | // 1: Write Cache Reordering enabled | |
841 | // 2: Write Cache Reordering disabled | |
842 | // -1: error | |
843 | int ataGetSetSCTWriteCacheReordering(ata_device * device, bool enable, bool persistent, bool set); | |
844 | ||
f9e10201 | 845 | // Return values: |
ff28b140 | 846 | // 1: Write cache controlled by ATA Set Features command |
f9e10201 JD |
847 | // 2: Force enable write cache |
848 | // 3: Force disable write cache | |
849 | int ataGetSetSCTWriteCache(ata_device * device, unsigned short state, bool persistent, bool set); | |
850 | ||
832b75ed GG |
851 | // Return values: |
852 | // 1: SMART enabled | |
853 | // 0: SMART disabled | |
854 | // -1: can't tell if SMART is enabled -- try issuing ataDoesSmartWork command to see | |
2127e193 | 855 | int ataIsSmartEnabled(const ata_identify_device * drive); |
832b75ed | 856 | |
2127e193 | 857 | int ataSmartStatus2(ata_device * device); |
832b75ed | 858 | |
ff28b140 | 859 | bool isSmartErrorLogCapable(const ata_smart_values * data, const ata_identify_device * identity); |
832b75ed | 860 | |
ff28b140 | 861 | bool isSmartTestLogCapable(const ata_smart_values * data, const ata_identify_device * identity); |
832b75ed | 862 | |
ff28b140 | 863 | bool isGeneralPurposeLoggingCapable(const ata_identify_device * identity); |
832b75ed | 864 | |
ff28b140 TL |
865 | // SMART self-test capability is also indicated in bit 1 of DEVICE |
866 | // IDENTIFY word 87 (if top two bits of word 87 match pattern 01). | |
867 | // However this was only introduced in ATA-6 (but self-test log was in | |
868 | // ATA-5). | |
869 | inline bool isSupportExecuteOfflineImmediate(const ata_smart_values *data) | |
870 | { return !!(data->offline_data_collection_capability & 0x01); } | |
832b75ed | 871 | |
ff28b140 TL |
872 | // TODO: Remove uses of this check. Bit 1 is vendor specific since ATA-4. |
873 | // Automatic timer support was only documented for very old IBM drives | |
874 | // (for example IBM Travelstar 40GNX). | |
875 | inline bool isSupportAutomaticTimer(const ata_smart_values * data) | |
876 | { return !!(data->offline_data_collection_capability & 0x02); } | |
832b75ed | 877 | |
ff28b140 TL |
878 | inline bool isSupportOfflineAbort(const ata_smart_values *data) |
879 | { return !!(data->offline_data_collection_capability & 0x04); } | |
832b75ed | 880 | |
ff28b140 TL |
881 | inline bool isSupportOfflineSurfaceScan(const ata_smart_values * data) |
882 | { return !!(data->offline_data_collection_capability & 0x08); } | |
832b75ed | 883 | |
ff28b140 TL |
884 | inline bool isSupportSelfTest(const ata_smart_values * data) |
885 | { return !!(data->offline_data_collection_capability & 0x10); } | |
832b75ed | 886 | |
ff28b140 TL |
887 | inline bool isSupportConveyanceSelfTest(const ata_smart_values * data) |
888 | { return !!(data->offline_data_collection_capability & 0x20); } | |
832b75ed | 889 | |
ff28b140 TL |
890 | inline bool isSupportSelectiveSelfTest(const ata_smart_values * data) |
891 | { return !!(data->offline_data_collection_capability & 0x40); } | |
832b75ed | 892 | |
a37e7145 GG |
893 | inline bool isSCTCapable(const ata_identify_device *drive) |
894 | { return !!(drive->words088_255[206-88] & 0x01); } // 0x01 = SCT support | |
895 | ||
7f0798ef GI |
896 | inline bool isSCTErrorRecoveryControlCapable(const ata_identify_device *drive) |
897 | { return ((drive->words088_255[206-88] & 0x09) == 0x09); } // 0x08 = SCT Error Recovery Control support | |
898 | ||
a37e7145 GG |
899 | inline bool isSCTFeatureControlCapable(const ata_identify_device *drive) |
900 | { return ((drive->words088_255[206-88] & 0x11) == 0x11); } // 0x10 = SCT Feature Control support | |
901 | ||
902 | inline bool isSCTDataTableCapable(const ata_identify_device *drive) | |
903 | { return ((drive->words088_255[206-88] & 0x21) == 0x21); } // 0x20 = SCT Data Table support | |
904 | ||
2127e193 | 905 | int TestTime(const ata_smart_values * data, int testtype); |
832b75ed | 906 | |
bed94269 GI |
907 | // Attribute state |
908 | enum ata_attr_state | |
909 | { | |
910 | ATTRSTATE_NON_EXISTING, // No such Attribute | |
911 | ATTRSTATE_NO_NORMVAL, // Normalized value not valid | |
bed94269 GI |
912 | ATTRSTATE_NO_THRESHOLD, // Unknown or no threshold |
913 | ATTRSTATE_OK, // Never failed | |
914 | ATTRSTATE_FAILED_PAST, // Failed in the past | |
915 | ATTRSTATE_FAILED_NOW // Failed now | |
916 | }; | |
917 | ||
918 | // Get attribute state | |
919 | ata_attr_state ata_get_attr_state(const ata_smart_attribute & attr, | |
cfbba5b9 GI |
920 | int attridx, |
921 | const ata_smart_threshold_entry * thresholds, | |
922 | const ata_vendor_attr_defs & defs, | |
923 | unsigned char * threshval = 0); | |
bed94269 GI |
924 | |
925 | // Get attribute raw value. | |
926 | uint64_t ata_get_attr_raw_value(const ata_smart_attribute & attr, | |
927 | const ata_vendor_attr_defs & defs); | |
928 | ||
929 | // Format attribute raw value. | |
930 | std::string ata_format_attr_raw_value(const ata_smart_attribute & attr, | |
931 | const ata_vendor_attr_defs & defs); | |
932 | ||
933 | // Get attribute name | |
934 | std::string ata_get_smart_attr_name(unsigned char id, | |
ee38a438 GI |
935 | const ata_vendor_attr_defs & defs, |
936 | int rpm = 0); | |
832b75ed GG |
937 | |
938 | // External handler function, for when a checksum is not correct. Can | |
939 | // simply return if no action is desired, or can print error messages | |
940 | // as needed, or exit. Is passed a string with the name of the Data | |
941 | // Structure with the incorrect checksum. | |
942 | void checksumwarning(const char *string); | |
943 | ||
bed94269 GI |
944 | // Find attribute index for attribute id, -1 if not found. |
945 | int ata_find_attr_index(unsigned char id, const ata_smart_values & smartval); | |
832b75ed | 946 | |
4d59bff9 GG |
947 | // Return Temperature Attribute raw value selected according to possible |
948 | // non-default interpretations. If the Attribute does not exist, return 0 | |
bed94269 | 949 | unsigned char ata_return_temperature_value(const ata_smart_values * data, const ata_vendor_attr_defs & defs); |
4d59bff9 | 950 | |
832b75ed | 951 | |
832b75ed GG |
952 | #define MAX_ATTRIBUTE_NUM 256 |
953 | ||
bed94269 GI |
954 | // Parse vendor attribute display def (-v option). |
955 | // Return false on error. | |
956 | bool parse_attribute_def(const char * opt, ata_vendor_attr_defs & defs, | |
957 | ata_vendor_def_prior priority); | |
2127e193 GI |
958 | |
959 | // Get ID and increase flag of current pending or offline | |
960 | // uncorrectable attribute. | |
bed94269 | 961 | unsigned char get_unc_attr_id(bool offline, const ata_vendor_attr_defs & defs, |
2127e193 | 962 | bool & increase); |
832b75ed | 963 | |
2127e193 GI |
964 | // Return a multiline string containing a list of valid arguments for |
965 | // parse_attribute_def(). | |
966 | std::string create_vendor_attribute_arg_list(); | |
832b75ed | 967 | |
ee38a438 GI |
968 | // Parse firmwarebug def (-F option). |
969 | // Return false on error. | |
970 | bool parse_firmwarebug_def(const char * opt, firmwarebug_defs & firmwarebugs); | |
971 | ||
972 | // Return a string of valid argument words for parse_firmwarebug_def() | |
973 | const char * get_valid_firmwarebug_args(); | |
974 | ||
832b75ed GG |
975 | |
976 | // These are two of the functions that are defined in os_*.c and need | |
977 | // to be ported to get smartmontools onto another OS. | |
2127e193 GI |
978 | // Moved to C++ interface |
979 | //int ata_command_interface(int device, smart_command_set command, int select, char *data); | |
980 | //int escalade_command_interface(int fd, int escalade_port, int escalade_type, smart_command_set command, int select, char *data); | |
981 | //int marvell_command_interface(int device, smart_command_set command, int select, char *data); | |
982 | //int highpoint_command_interface(int device, smart_command_set command, int select, char *data); | |
983 | //int areca_command_interface(int fd, int disknum, smart_command_set command, int select, char *data); | |
a37e7145 | 984 | |
a37e7145 | 985 | |
832b75ed | 986 | // This function is exported to give low-level capability |
2127e193 GI |
987 | int smartcommandhandler(ata_device * device, smart_command_set command, int select, char *data); |
988 | ||
a7e8ffec GI |
989 | // Get capacity and sector sizes from IDENTIFY data |
990 | struct ata_size_info | |
991 | { | |
992 | uint64_t sectors; | |
993 | uint64_t capacity; | |
994 | unsigned log_sector_size; | |
995 | unsigned phy_sector_size; | |
996 | unsigned log_sector_offset; | |
997 | }; | |
998 | ||
999 | void ata_get_size_info(const ata_identify_device * id, ata_size_info & sizes); | |
2127e193 GI |
1000 | |
1001 | // Convenience function for formatting strings from ata_identify_device. | |
cfbba5b9 | 1002 | void ata_format_id_string(char * out, const unsigned char * in, int n); |
832b75ed GG |
1003 | |
1004 | // Utility routines. | |
2127e193 GI |
1005 | unsigned char checksum(const void * data); |
1006 | ||
2127e193 GI |
1007 | // Return pseudo-device to parse "smartctl -r ataioctl,2 ..." output |
1008 | // and simulate an ATA device with same behaviour | |
1009 | ata_device * get_parsed_ata_device(smart_interface * intf, const char * dev_name); | |
1010 | ||
832b75ed | 1011 | #endif /* ATACMDS_H_ */ |