atacmds.cpp 12.8 KB
Newer Older
1
//  $Id: atacmds.cpp,v 1.8 2002/10/15 14:24:26 ballen4705 Exp $
ballen4705's avatar
ballen4705 committed
2
3
/*
 * atacmds.c
4
5
 * 
 * Home page of code is: http://smartmontools.sourceforge.net
ballen4705's avatar
ballen4705 committed
6
 *
ballen4705's avatar
ballen4705 committed
7
 * Copyright (C) 2002 Bruce Allen <smartmontools-support@lists.sourceforge.net>
ballen4705's avatar
ballen4705 committed
8
9
10
11
12
13
14
15
16
17
18
 * Copyright (C) 1999-2000 Michael Cornwell <cornwell@acm.org>
 * Copyright (C) 2000 Andre Hedrick <andre@linux-ide.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * 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.
ballen4705's avatar
ballen4705 committed
19
20
21
22
23
24
 *
 * This code was originally developed as a Senior Thesis by Michael Cornwell
 * at the Concurrent Systems Laboratory (now part of the Storage Systems
 * Research Center), Jack Baskin School of Engineering, University of
 * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
 * 
ballen4705's avatar
ballen4705 committed
25
26
27
28
29
30
31
 */


#include <stdio.h>
#include <string.h>
#include "atacmds.h"

32

ballen4705's avatar
ballen4705 committed
33
34
// These Drive Identity tables are taken from hdparm 5.2. That's the
// "Gold Standard"
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
#define NOVAL_0			0x0000
#define NOVAL_1			0xffff
/* word 81: minor version number */
#define MINOR_MAX 0x1C
const char *minor_str[] = {			/* word 81 value: */
  "Device does not report version",		/* 0x0000	*/
  "ATA-1 X3T9.2 781D prior to revision 4",	/* 0x0001	*/
  "ATA-1 published, ANSI X3.221-1994",		/* 0x0002	*/
  "ATA-1 X3T9.2 781D revision 4",		/* 0x0003	*/
  "ATA-2 published, ANSI X3.279-1996",		/* 0x0004	*/
  "ATA-2 X3T10 948D prior to revision 2k",	/* 0x0005	*/
  "ATA-3 X3T10 2008D revision 1",		/* 0x0006	*/
  "ATA-2 X3T10 948D revision 2k",		/* 0x0007	*/
  "ATA-3 X3T10 2008D revision 0",		/* 0x0008	*/
  "ATA-2 X3T10 948D revision 3",		/* 0x0009	*/
  "ATA-3 published, ANSI X3.298-199x",		/* 0x000a	*/
  "ATA-3 X3T10 2008D revision 6",		/* 0x000b	*/
  "ATA-3 X3T13 2008D revision 7 and 7a",	/* 0x000c	*/
  "ATA/ATAPI-4 X3T13 1153D revision 6",		/* 0x000d	*/
  "ATA/ATAPI-4 T13 1153D revision 13",		/* 0x000e	*/
  "ATA/ATAPI-4 X3T13 1153D revision 7",		/* 0x000f	*/
  "ATA/ATAPI-4 T13 1153D revision 18",		/* 0x0010	*/
  "ATA/ATAPI-4 T13 1153D revision 15",		/* 0x0011	*/
  "ATA/ATAPI-4 published, ANSI NCITS 317-1998",	/* 0x0012	*/
  "ATA/ATAPI-5 T13 1321D revision 3",	        /* 0x0013	*/
  "ATA/ATAPI-4 T13 1153D revision 14",		/* 0x0014	*/
  "ATA/ATAPI-5 T13 1321D revision 1",		/* 0x0015	*/
  "ATA/ATAPI-5 published, ANSI NCITS 340-2000",	/* 0x0016	*/
  "ATA/ATAPI-4 T13 1153D revision 17",		/* 0x0017	*/
  "ATA/ATAPI-6 T13 1410D revision 0",		/* 0x0018	*/
  "ATA/ATAPI-6 T13 1410D revision 3a",		/* 0x0019	*/
  "Reserved",					/* 0x001a	*/
  "ATA/ATAPI-6 T13 1410D revision 2",		/* 0x001b	*/
  "ATA/ATAPI-6 T13 1410D revision 1",		/* 0x001c	*/
  "reserved"					/* 0x001d	*/
  "reserved"					/* 0x001e	*/
  "reserved"					/* 0x001f-0xfffe*/
};

const char actual_ver[] = { 
  /* word 81 value: */
  0,		/* 0x0000	WARNING: 	*/
  1,		/* 0x0001	WARNING: 	*/
  1,		/* 0x0002	WARNING: 	*/
  1,		/* 0x0003	WARNING: 	*/
  2,		/* 0x0004	WARNING:   This array 		*/
  2,		/* 0x0005	WARNING:   corresponds 		*/
  3,		/* 0x0006	WARNING:   *exactly*		*/
  2,		/* 0x0007	WARNING:   to the ATA/		*/
  3,		/* 0x0008	WARNING:   ATAPI version	*/
  2,		/* 0x0009	WARNING:   listed in	 	*/
  3,		/* 0x000a	WARNING:   the 		 	*/
  3,		/* 0x000b	WARNING:   minor_str 		*/
  3,		/* 0x000c	WARNING:   array		*/
  4,		/* 0x000d	WARNING:   above.		*/
  4,		/* 0x000e	WARNING:  			*/
  4,		/* 0x000f	WARNING:   If you change 	*/
  4,		/* 0x0010	WARNING:   that one,      	*/
  4,		/* 0x0011	WARNING:   change this one	*/
  4,		/* 0x0012	WARNING:   too!!!        	*/
  5,		/* 0x0013	WARNING:	*/
  4,		/* 0x0014	WARNING:	*/
  5,		/* 0x0015	WARNING:	*/
  5,		/* 0x0016	WARNING:	*/
  4,		/* 0x0017	WARNING:	*/
  6,		/* 0x0018	WARNING:	*/
  6,		/* 0x0019	WARNING:	*/
  0,		/* 0x001a	WARNING:	*/
  6,		/* 0x001b	WARNING:	*/
  6,		/* 0x001c	WARNING:	*/
  0		/* 0x001d-0xfffe    		*/
};



ballen4705's avatar
ballen4705 committed
110
111
112
113
114
115
116
117
118
119
120
121
int ataReadHDIdentity ( int device, struct hd_driveid *buf)
{
   if (ioctl ( device , HDIO_GET_IDENTITY, buf ) != 0)
   { 
       perror ("ATA GET HD Failed");
       return -1; 
   }

   return 0;
}


122
123
124
125
126
int ataVersionInfo (const char** description, struct hd_driveid drive){
  unsigned short major,minor;
  int i,atavalue=0;
  
  // get major and minor ATA revision numbers
ballen4705's avatar
ballen4705 committed
127
#ifdef __NEW_HD_DRIVE_ID
128
129
  major=drive.major_rev_num;
  minor=drive.minor_rev_num;
ballen4705's avatar
ballen4705 committed
130
#else
131
132
  major=drive.word80;
  minor=drive.word81;
ballen4705's avatar
ballen4705 committed
133
#endif
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
  
  // First check if device has ANY ATA version information in it
  if (major==NOVAL_0 || major==NOVAL_1) {
    *description=NULL;
    return -1;
  }
  
  // The minor revision number has more information - try there first
  if (minor && (minor<=MINOR_MAX)){
    int std = actual_ver[minor];
    if (std) {
      *description=minor_str[minor];
      return std;
    }
  }
  
  // HDPARM has a very complicated algorithm from here on. Since SMART only
  // exists on ATA-3 and later standards, let's punt on this.  If you don't
  // like it, please fix it.  The code's in CVS.
  for (i=1; i<16;i++ )
    if (major & (0x1<<i))
      atavalue = i;
  *description=NULL;
  return atavalue;
ballen4705's avatar
ballen4705 committed
158
159
160
}


161
int ataSmartSupport ( struct hd_driveid drive){
ballen4705's avatar
ballen4705 committed
162
#ifdef __NEW_HD_DRIVE_ID
163
  if (drive.command_set_1 & 0x0001)
ballen4705's avatar
ballen4705 committed
164
#else
165
  if (drive.command_sets & 0x0001)
ballen4705's avatar
ballen4705 committed
166
#endif
167
168
    return 1; /* drive supports S.M.A.R.T. and is disabled */
  return 0;
ballen4705's avatar
ballen4705 committed
169
170
}

ballen4705's avatar
ballen4705 committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
int ataReadSmartValues (int device, struct ata_smart_values *data){	
  int i;
  unsigned char chksum=0;
  unsigned char buf[HDIO_DRIVE_CMD_HDR_SIZE+ATA_SMART_SEC_SIZE]= 
    {WIN_SMART, 0, SMART_READ_VALUES, 1};
  
  if (ioctl(device,HDIO_DRIVE_CMD,buf)){
    perror ("Smart Values Read failed");
    return -1;
  }
  
  // compute checksum
  for (i=0;i<ATA_SMART_SEC_SIZE;i++)
    chksum+=buf[i+HDIO_DRIVE_CMD_HDR_SIZE];
  
  // verify that checksum vanishes
  if (chksum){
    perror ("Smart Read Failed, Checksum error!");
    return -1;
  }	
  
  // copy data and return
  memcpy(data,buf+HDIO_DRIVE_CMD_HDR_SIZE,ATA_SMART_SEC_SIZE);
  return 0;
ballen4705's avatar
ballen4705 committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
}


int ataReadSelfTestLog (int device, struct ata_smart_selftestlog *data)
{	
   int i;
   unsigned char chksum=0;	
   unsigned char buf[ HDIO_DRIVE_CMD_HDR_SIZE + 
                      ATA_SMART_SEC_SIZE] = 
                      { WIN_SMART, 0x06, SMART_READ_LOG_SECTOR, 1};

   if (ioctl ( device , HDIO_DRIVE_CMD, (unsigned char *) &buf ) != 0)
   {
       perror ("Smart Error Log Read failed");
       return -1;
   }
   
   // compute checksum
   for (i=0;i<ATA_SMART_SEC_SIZE;i++)
     chksum+=buf[HDIO_DRIVE_CMD_HDR_SIZE+i];

   if (chksum){
     fprintf(stderr,"Smart Self Test Log Checksum Incorrect!\n");
     return -1;
   }

   memcpy( data, &buf[HDIO_DRIVE_CMD_HDR_SIZE] , ATA_SMART_SEC_SIZE);

   return 0;
}


int ataReadErrorLog (int device, struct ata_smart_errorlog *data)
{	
   int i;
   unsigned char chksum=0;	
   unsigned char buf[ HDIO_DRIVE_CMD_HDR_SIZE + 
                      ATA_SMART_SEC_SIZE] = 
                      { WIN_SMART, 0x01, SMART_READ_LOG_SECTOR, 1};

   if (ioctl ( device , HDIO_DRIVE_CMD, (unsigned char *) &buf ) != 0)
   {
       perror ("Smart Error Log Read failed");
       return -1;
   }

   // compute checksum
   for (i=0;i<ATA_SMART_SEC_SIZE;i++)
     chksum+=buf[HDIO_DRIVE_CMD_HDR_SIZE+i];

   if (chksum){
     fprintf(stderr,"Smart Error Log Checksum Incorrect!\n");
     return -1;
   }
   memcpy( data, &buf[HDIO_DRIVE_CMD_HDR_SIZE] , ATA_SMART_SEC_SIZE);

   return 0;
}


int ataReadSmartThresholds ( int device, struct ata_smart_thresholds *data)
{	
   unsigned char buf[ HDIO_DRIVE_CMD_HDR_SIZE + 
                      ATA_SMART_SEC_SIZE] = 
                      { WIN_SMART, 1, SMART_READ_THRESHOLDS, 1};
	
   if (ioctl ( device , HDIO_DRIVE_CMD, (unsigned char *) &buf ) != 0)
   {
       perror ("Smart Thresholds Read failed");
       return -1;
   }

   memcpy( data, &buf[HDIO_DRIVE_CMD_HDR_SIZE] , ATA_SMART_SEC_SIZE);

   return 0;
}

int ataSetSmartThresholds ( int device, struct ata_smart_thresholds *data)
{	
   unsigned char buf[ HDIO_DRIVE_CMD_HDR_SIZE + 
		           ATA_SMART_SEC_SIZE] = 
                           { WIN_SMART, 1, 0xD7, 1};
	
   memcpy( &buf[HDIO_DRIVE_CMD_HDR_SIZE],  data , ATA_SMART_SEC_SIZE);

   if (ioctl ( device , HDIO_DRIVE_CMD, (unsigned char *)  &buf ) != 0)
   {
       perror ("Smart Thresholds Read failed");
       return -1;
   }

   return 0;
}


int ataEnableSmart (int device )
{	

   unsigned char parms[4] = { WIN_SMART, 1, SMART_ENABLE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
      perror ("Smart Enable failed");
      return -1;
   }
	
   return 0;
 }


int ataDisableSmart (int device )
{	
	
   unsigned char parms[4] = { WIN_SMART, 1, SMART_DISABLE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
      perror ("Smart Disable failed");
      return -1;
   }

   return 0;
}

int ataEnableAutoSave(int device){
   unsigned char parms[4] = { WIN_SMART, 241, SMART_AUTOSAVE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
      perror ("Smart Enable Auto-save failed");
      return -1;
   }
	
   return 0;
};

int ataDisableAutoSave(int device){
   unsigned char parms[4] = { WIN_SMART, 0, SMART_AUTOSAVE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
      perror ("Smart Disable Auto-save failed");
      return -1;
   }
	
   return 0;
};

int ataEnableAutoOffline (int device )
{	

   /* timer hard coded to 4 hours */
   unsigned char parms[4] = { WIN_SMART, 248, SMART_AUTO_OFFLINE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
       perror ("Smart Enable Automatic Offline failed");
       return -1;
   }

   return 0;
}


int ataDisableAutoOffline (int device )
{	
   unsigned char parms[4] = { WIN_SMART, 0, SMART_AUTO_OFFLINE, 0};
	
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms ) != 0)
   {
      perror ("Smart Disable Automatic Offline failed");
      return -1;
   }

   return 0;
}


ballen4705's avatar
ballen4705 committed
373
374
375
// Not being used correctly.  Must examine the CL and CH registers to
// see what the smart status was.  How to fix this?  I don't know...
int ataSmartStatus (int device ){	
ballen4705's avatar
ballen4705 committed
376
377
   unsigned char parms[4] = { WIN_SMART, 0, SMART_STATUS, 0};

ballen4705's avatar
ballen4705 committed
378
   if (ioctl ( device , HDIO_DRIVE_CMD,  &parms))
ballen4705's avatar
ballen4705 committed
379
380
381
382
383
384
385
386
387
388
      return -1;
   return 0;
}



int ataSmartTest (int device, int testtype)
{	
   unsigned char parms[4] = { WIN_SMART, testtype, 
                    SMART_IMMEDIATE_OFFLINE, 0};
ballen4705's avatar
ballen4705 committed
389
   
ballen4705's avatar
ballen4705 committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
   if (ioctl ( device , HDIO_DRIVE_CMD, &parms) != 0)
   {
       perror ("Smart Offline failed");
       return -1;
   }

   printf("Completed Off-line command\n");
	
   return 0;
}


int ataSmartOfflineTest (int device)
{	
   return ataSmartTest( device, OFFLINE_FULL_SCAN  );
}

int ataSmartShortSelfTest (int device)
{	
   return ataSmartTest( device, SHORT_SELF_TEST  );
}

int ataSmartExtendSelfTest (int device)
{	
   return ataSmartTest( device, EXTEND_SELF_TEST  );
}

int ataSmartShortCapSelfTest (int device)
{	
   return ataSmartTest( device, SHORT_CAPTIVE_SELF_TEST );
}

int ataSmartExtendCapSelfTest (int device)
{
   return ataSmartTest( device, EXTEND_CAPTIVE_SELF_TEST );
}


int ataSmartSelfTestAbort (int device)
{
   return ataSmartTest( device, 127 );
}

/* Test Time Functions */

int isOfflineTestTime ( struct ata_smart_values data)
{
   return (int) data.total_time_to_complete_off_line;
}


int isShortSelfTestTime ( struct ata_smart_values data)
{
   return (int) data.short_test_completion_time;
}


int isExtendedSelfTestTime ( struct ata_smart_values data)
{
   return (int) data.extend_test_completion_time;
}


int isSmartErrorLogCapable ( struct ata_smart_values data)
{
   return data.errorlog_capability & 0x01;
}


int isSupportExecuteOfflineImmediate ( struct ata_smart_values data)
{
   return data.offline_data_collection_capability & 0x01;
}


int isSupportAutomaticTimer ( struct ata_smart_values data)
{
   return data.offline_data_collection_capability & 0x02;
}


int isSupportOfflineAbort ( struct ata_smart_values data)
{
   return data.offline_data_collection_capability & 0x04;
}


int isSupportOfflineSurfaceScan ( struct ata_smart_values data)
{
   return data.offline_data_collection_capability & 0x08;
}


int isSupportSelfTest (struct ata_smart_values data)
{
   return data.offline_data_collection_capability & 0x10;
}


489
490
491
492
493
494
// Loop over all valid attributes.  If they are prefailure attributes
// and are below the threshold value, then return the index of the
// lowest failing attribute.  Return 0 if all prefailure attributes
// are in bounds.
int ataCheckSmart (struct ata_smart_values data, struct ata_smart_thresholds thresholds){
  int i;
ballen4705's avatar
ballen4705 committed
495
  
496
497
498
499
500
501
502
503
504
  for (i = 0; i < NUMBER_ATA_SMART_ATTRIBUTES; i++){
    if (data.vendor_attributes[i].id &&   
	thresholds.thres_entries[i].id &&
	data.vendor_attributes[i].status.flag.prefailure &&
	(data.vendor_attributes[i].current < thresholds.thres_entries[i].threshold) &&
	(thresholds.thres_entries[i].threshold != 0xFE))
      return i;
  }
  return 0;
ballen4705's avatar
ballen4705 committed
505
}