atactl.c revision 1.27 1 1.27 jmmv /* $NetBSD: atactl.c,v 1.27 2004/01/05 23:23:32 jmmv Exp $ */
2 1.1 kenh
3 1.1 kenh /*-
4 1.1 kenh * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 1.1 kenh * All rights reserved.
6 1.1 kenh *
7 1.1 kenh * This code is derived from software contributed to The NetBSD Foundation
8 1.1 kenh * by Ken Hornstein.
9 1.1 kenh *
10 1.1 kenh * Redistribution and use in source and binary forms, with or without
11 1.1 kenh * modification, are permitted provided that the following conditions
12 1.1 kenh * are met:
13 1.1 kenh * 1. Redistributions of source code must retain the above copyright
14 1.1 kenh * notice, this list of conditions and the following disclaimer.
15 1.1 kenh * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 kenh * notice, this list of conditions and the following disclaimer in the
17 1.1 kenh * documentation and/or other materials provided with the distribution.
18 1.1 kenh * 3. All advertising materials mentioning features or use of this software
19 1.1 kenh * must display the following acknowledgement:
20 1.1 kenh * This product includes software developed by the NetBSD
21 1.1 kenh * Foundation, Inc. and its contributors.
22 1.1 kenh * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.1 kenh * contributors may be used to endorse or promote products derived
24 1.1 kenh * from this software without specific prior written permission.
25 1.1 kenh *
26 1.1 kenh * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.1 kenh * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.1 kenh * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.1 kenh * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.1 kenh * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.1 kenh * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.1 kenh * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.1 kenh * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.1 kenh * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.1 kenh * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.1 kenh * POSSIBILITY OF SUCH DAMAGE.
37 1.1 kenh */
38 1.1 kenh
39 1.1 kenh /*
40 1.4 jwise * atactl(8) - a program to control ATA devices.
41 1.1 kenh */
42 1.21 agc #include <sys/cdefs.h>
43 1.21 agc
44 1.21 agc #ifndef lint
45 1.27 jmmv __RCSID("$NetBSD: atactl.c,v 1.27 2004/01/05 23:23:32 jmmv Exp $");
46 1.21 agc #endif
47 1.21 agc
48 1.1 kenh
49 1.1 kenh #include <sys/param.h>
50 1.1 kenh #include <sys/ioctl.h>
51 1.1 kenh #include <err.h>
52 1.1 kenh #include <errno.h>
53 1.1 kenh #include <fcntl.h>
54 1.1 kenh #include <stdio.h>
55 1.1 kenh #include <stdlib.h>
56 1.1 kenh #include <string.h>
57 1.1 kenh #include <unistd.h>
58 1.1 kenh #include <util.h>
59 1.1 kenh
60 1.1 kenh #include <dev/ata/atareg.h>
61 1.1 kenh #include <sys/ataio.h>
62 1.1 kenh
63 1.1 kenh struct command {
64 1.1 kenh const char *cmd_name;
65 1.5 soren const char *arg_names;
66 1.13 simonb void (*cmd_func)(int, char *[]);
67 1.1 kenh };
68 1.1 kenh
69 1.1 kenh struct bitinfo {
70 1.1 kenh u_int bitmask;
71 1.1 kenh const char *string;
72 1.1 kenh };
73 1.1 kenh
74 1.13 simonb int main(int, char *[]);
75 1.13 simonb void usage(void);
76 1.13 simonb void ata_command(struct atareq *);
77 1.13 simonb void print_bitinfo(const char *, const char *, u_int, struct bitinfo *);
78 1.24 lha void print_smart_status(void *, void *);
79 1.24 lha void print_selftest_entry(int, struct ata_smart_selftest *);
80 1.24 lha
81 1.24 lha void print_selftest(void *);
82 1.24 lha
83 1.20 mycroft int is_smart(void);
84 1.1 kenh
85 1.1 kenh int fd; /* file descriptor for device */
86 1.1 kenh const char *dvname; /* device name */
87 1.1 kenh char dvname_store[MAXPATHLEN]; /* for opendisk(3) */
88 1.1 kenh const char *cmdname; /* command user issued */
89 1.5 soren const char *argnames; /* helpstring: expected arguments */
90 1.1 kenh
91 1.13 simonb void device_identify(int, char *[]);
92 1.13 simonb void device_setidle(int, char *[]);
93 1.13 simonb void device_idle(int, char *[]);
94 1.13 simonb void device_checkpower(int, char *[]);
95 1.15 soren void device_smart(int, char *[]);
96 1.1 kenh
97 1.24 lha void smart_temp(struct ata_smart_attr *, int64_t);
98 1.24 lha
99 1.1 kenh struct command commands[] = {
100 1.5 soren { "identify", "", device_identify },
101 1.5 soren { "setidle", "idle-timer", device_setidle },
102 1.5 soren { "setstandby", "standby-timer", device_setidle },
103 1.5 soren { "idle", "", device_idle },
104 1.5 soren { "standby", "", device_idle },
105 1.5 soren { "sleep", "", device_idle },
106 1.5 soren { "checkpower", "", device_checkpower },
107 1.24 lha { "smart", "enable|disable|status|selftest-log", device_smart },
108 1.5 soren { NULL, NULL, NULL },
109 1.1 kenh };
110 1.1 kenh
111 1.1 kenh /*
112 1.1 kenh * Tables containing bitmasks used for error reporting and
113 1.1 kenh * device identification.
114 1.1 kenh */
115 1.1 kenh
116 1.1 kenh struct bitinfo ata_caps[] = {
117 1.23 yamt { WDC_CAP_DMA, "DMA" },
118 1.23 yamt { WDC_CAP_LBA, "LBA" },
119 1.1 kenh { ATA_CAP_STBY, "ATA standby timer values" },
120 1.1 kenh { WDC_CAP_IORDY, "IORDY operation" },
121 1.1 kenh { WDC_CAP_IORDY_DSBL, "IORDY disabling" },
122 1.22 fvdl { 0, NULL },
123 1.1 kenh };
124 1.1 kenh
125 1.1 kenh struct bitinfo ata_vers[] = {
126 1.1 kenh { WDC_VER_ATA1, "ATA-1" },
127 1.1 kenh { WDC_VER_ATA2, "ATA-2" },
128 1.1 kenh { WDC_VER_ATA3, "ATA-3" },
129 1.1 kenh { WDC_VER_ATA4, "ATA-4" },
130 1.23 yamt { WDC_VER_ATA5, "ATA-5" },
131 1.23 yamt { WDC_VER_ATA6, "ATA-6" },
132 1.23 yamt { WDC_VER_ATA7, "ATA-7" },
133 1.22 fvdl { 0, NULL },
134 1.1 kenh };
135 1.1 kenh
136 1.1 kenh struct bitinfo ata_cmd_set1[] = {
137 1.1 kenh { WDC_CMD1_NOP, "NOP command" },
138 1.1 kenh { WDC_CMD1_RB, "READ BUFFER command" },
139 1.1 kenh { WDC_CMD1_WB, "WRITE BUFFER command" },
140 1.1 kenh { WDC_CMD1_HPA, "Host Protected Area feature set" },
141 1.1 kenh { WDC_CMD1_DVRST, "DEVICE RESET command" },
142 1.1 kenh { WDC_CMD1_SRV, "SERVICE interrupt" },
143 1.1 kenh { WDC_CMD1_RLSE, "release interrupt" },
144 1.1 kenh { WDC_CMD1_AHEAD, "look-ahead" },
145 1.1 kenh { WDC_CMD1_CACHE, "write cache" },
146 1.1 kenh { WDC_CMD1_PKT, "PACKET command feature set" },
147 1.1 kenh { WDC_CMD1_PM, "Power Management feature set" },
148 1.1 kenh { WDC_CMD1_REMOV, "Removable Media feature set" },
149 1.1 kenh { WDC_CMD1_SEC, "Security Mode feature set" },
150 1.1 kenh { WDC_CMD1_SMART, "SMART feature set" },
151 1.22 fvdl { 0, NULL },
152 1.1 kenh };
153 1.1 kenh
154 1.1 kenh struct bitinfo ata_cmd_set2[] = {
155 1.23 yamt { ATA_CMD2_FCE, "FLUSH CACHE EXT command" },
156 1.23 yamt { WDC_CMD2_FC, "FLUSH CACHE command" },
157 1.23 yamt { WDC_CMD2_DCO, "Device Configuration Overlay feature set" },
158 1.23 yamt { ATA_CMD2_LBA48, "48-bit Address feature set" },
159 1.23 yamt { WDC_CMD2_AAM, "Automatic Acoustic Management feature set" },
160 1.23 yamt { WDC_CMD2_SM, "SET MAX security extention" },
161 1.23 yamt { WDC_CMD2_SFREQ, "SET FEATURES required to spin-up after power-up" },
162 1.23 yamt { WDC_CMD2_PUIS, "Power-Up In Standby feature set" },
163 1.1 kenh { WDC_CMD2_RMSN, "Removable Media Status Notification feature set" },
164 1.1 kenh { ATA_CMD2_APM, "Advanced Power Management feature set" },
165 1.1 kenh { ATA_CMD2_CFA, "CFA feature set" },
166 1.6 soren { ATA_CMD2_RWQ, "READ/WRITE DMA QUEUED commands" },
167 1.1 kenh { WDC_CMD2_DM, "DOWNLOAD MICROCODE command" },
168 1.22 fvdl { 0, NULL },
169 1.1 kenh };
170 1.1 kenh
171 1.23 yamt struct bitinfo ata_cmd_ext[] = {
172 1.23 yamt { ATA_CMDE_TLCONT, "Time-limited R/W feature set R/W Continuous mode" },
173 1.23 yamt { ATA_CMDE_TL, "Time-limited Read/Write" },
174 1.23 yamt { ATA_CMDE_URGW, "URG bit for WRITE STREAM DMA/PIO" },
175 1.23 yamt { ATA_CMDE_URGR, "URG bit for READ STREAM DMA/PIO" },
176 1.23 yamt { ATA_CMDE_WWN, "World Wide name" },
177 1.23 yamt { ATA_CMDE_WQFE, "WRITE DMA QUEUED FUA EXT command" },
178 1.23 yamt { ATA_CMDE_WFE, "WRITE DMA/MULTIPLE FUA EXT commands" },
179 1.23 yamt { ATA_CMDE_GPL, "General Purpose Logging feature set" },
180 1.23 yamt { ATA_CMDE_STREAM, "Streaming feature set" },
181 1.23 yamt { ATA_CMDE_MCPTC, "Media Card Pass Through Command feature set" },
182 1.23 yamt { ATA_CMDE_MS, "Media serial number" },
183 1.23 yamt { ATA_CMDE_SST, "SMART self-test" },
184 1.23 yamt { ATA_CMDE_SEL, "SMART error logging" },
185 1.23 yamt { 0, NULL },
186 1.23 yamt };
187 1.23 yamt
188 1.17 soren static const struct {
189 1.17 soren const int id;
190 1.17 soren const char *name;
191 1.24 lha void (*special)(struct ata_smart_attr *, int64_t);
192 1.17 soren } smart_attrs[] = {
193 1.19 soren { 1, "Raw read error rate" },
194 1.17 soren { 2, "Throughput performance" },
195 1.17 soren { 3, "Spin-up time" },
196 1.17 soren { 4, "Start/stop count" },
197 1.17 soren { 5, "Reallocated sector count" },
198 1.17 soren { 7, "Seek error rate" },
199 1.17 soren { 8, "Seek time performance" },
200 1.17 soren { 9, "Power-on hours count" },
201 1.17 soren { 10, "Spin retry count" },
202 1.17 soren { 11, "Calibration retry count" },
203 1.17 soren { 12, "Device power cycle count" },
204 1.17 soren { 191, "Gsense error rate" },
205 1.17 soren { 192, "Power-off retract count" },
206 1.17 soren { 193, "Load cycle count" },
207 1.24 lha { 194, "Temperature", smart_temp},
208 1.24 lha { 195, "Hardware ECC Recovered" },
209 1.17 soren { 196, "Reallocated event count" },
210 1.17 soren { 197, "Current pending sector" },
211 1.17 soren { 198, "Offline uncorrectable" },
212 1.17 soren { 199, "Ultra DMA CRC error count" },
213 1.24 lha { 0, "Unknown" },
214 1.17 soren };
215 1.17 soren
216 1.1 kenh int
217 1.13 simonb main(int argc, char *argv[])
218 1.1 kenh {
219 1.1 kenh int i;
220 1.1 kenh
221 1.1 kenh /* Must have at least: device command */
222 1.1 kenh if (argc < 3)
223 1.1 kenh usage();
224 1.1 kenh
225 1.1 kenh /* Skip program name, get and skip device name and command. */
226 1.1 kenh dvname = argv[1];
227 1.1 kenh cmdname = argv[2];
228 1.1 kenh argv += 3;
229 1.1 kenh argc -= 3;
230 1.1 kenh
231 1.1 kenh /*
232 1.1 kenh * Open the device
233 1.1 kenh */
234 1.1 kenh fd = opendisk(dvname, O_RDWR, dvname_store, sizeof(dvname_store), 0);
235 1.1 kenh if (fd == -1) {
236 1.1 kenh if (errno == ENOENT) {
237 1.1 kenh /*
238 1.1 kenh * Device doesn't exist. Probably trying to open
239 1.1 kenh * a device which doesn't use disk semantics for
240 1.1 kenh * device name. Try again, specifying "cooked",
241 1.1 kenh * which leaves off the "r" in front of the device's
242 1.1 kenh * name.
243 1.1 kenh */
244 1.1 kenh fd = opendisk(dvname, O_RDWR, dvname_store,
245 1.1 kenh sizeof(dvname_store), 1);
246 1.1 kenh if (fd == -1)
247 1.1 kenh err(1, "%s", dvname);
248 1.4 jwise } else
249 1.4 jwise err(1, "%s", dvname);
250 1.1 kenh }
251 1.1 kenh
252 1.1 kenh /*
253 1.1 kenh * Point the dvname at the actual device name that opendisk() opened.
254 1.1 kenh */
255 1.1 kenh dvname = dvname_store;
256 1.1 kenh
257 1.1 kenh /* Look up and call the command. */
258 1.1 kenh for (i = 0; commands[i].cmd_name != NULL; i++)
259 1.1 kenh if (strcmp(cmdname, commands[i].cmd_name) == 0)
260 1.1 kenh break;
261 1.1 kenh if (commands[i].cmd_name == NULL)
262 1.12 ad errx(1, "unknown command: %s", cmdname);
263 1.1 kenh
264 1.5 soren argnames = commands[i].arg_names;
265 1.5 soren
266 1.1 kenh (*commands[i].cmd_func)(argc, argv);
267 1.1 kenh exit(0);
268 1.1 kenh }
269 1.1 kenh
270 1.1 kenh void
271 1.13 simonb usage(void)
272 1.1 kenh {
273 1.5 soren int i;
274 1.1 kenh
275 1.27 jmmv fprintf(stderr, "usage: %s device command [arg [...]]\n",
276 1.11 cgd getprogname());
277 1.5 soren
278 1.5 soren fprintf(stderr, " Available device commands:\n");
279 1.5 soren for (i=0; commands[i].cmd_name != NULL; i++)
280 1.5 soren fprintf(stderr, "\t%s %s\n", commands[i].cmd_name,
281 1.5 soren commands[i].arg_names);
282 1.5 soren
283 1.1 kenh exit(1);
284 1.1 kenh }
285 1.1 kenh
286 1.1 kenh /*
287 1.1 kenh * Wrapper that calls ATAIOCCOMMAND and checks for errors
288 1.1 kenh */
289 1.1 kenh
290 1.1 kenh void
291 1.13 simonb ata_command(struct atareq *req)
292 1.1 kenh {
293 1.1 kenh int error;
294 1.1 kenh
295 1.1 kenh error = ioctl(fd, ATAIOCCOMMAND, req);
296 1.1 kenh
297 1.1 kenh if (error == -1)
298 1.1 kenh err(1, "ATAIOCCOMMAND failed");
299 1.1 kenh
300 1.1 kenh switch (req->retsts) {
301 1.1 kenh
302 1.1 kenh case ATACMD_OK:
303 1.1 kenh return;
304 1.1 kenh case ATACMD_TIMEOUT:
305 1.1 kenh fprintf(stderr, "ATA command timed out\n");
306 1.1 kenh exit(1);
307 1.1 kenh case ATACMD_DF:
308 1.1 kenh fprintf(stderr, "ATA device returned a Device Fault\n");
309 1.1 kenh exit(1);
310 1.1 kenh case ATACMD_ERROR:
311 1.1 kenh if (req->error & WDCE_ABRT)
312 1.1 kenh fprintf(stderr, "ATA device returned Aborted "
313 1.1 kenh "Command\n");
314 1.1 kenh else
315 1.1 kenh fprintf(stderr, "ATA device returned error register "
316 1.1 kenh "%0x\n", req->error);
317 1.1 kenh exit(1);
318 1.1 kenh default:
319 1.1 kenh fprintf(stderr, "ATAIOCCOMMAND returned unknown result code "
320 1.1 kenh "%d\n", req->retsts);
321 1.1 kenh exit(1);
322 1.1 kenh }
323 1.1 kenh }
324 1.1 kenh
325 1.1 kenh /*
326 1.1 kenh * Print out strings associated with particular bitmasks
327 1.1 kenh */
328 1.1 kenh
329 1.1 kenh void
330 1.13 simonb print_bitinfo(const char *bf, const char *af, u_int bits, struct bitinfo *binfo)
331 1.1 kenh {
332 1.1 kenh
333 1.22 fvdl for (; binfo->bitmask != 0; binfo++)
334 1.1 kenh if (bits & binfo->bitmask)
335 1.10 is printf("%s%s%s", bf, binfo->string, af);
336 1.1 kenh }
337 1.1 kenh
338 1.24 lha
339 1.24 lha /*
340 1.24 lha * Try to print SMART temperature field
341 1.24 lha */
342 1.24 lha
343 1.24 lha void
344 1.24 lha smart_temp(struct ata_smart_attr *attr, int64_t raw_value)
345 1.24 lha {
346 1.24 lha printf("\t%d", (int)attr->raw[0]);
347 1.24 lha if (attr->raw[0] != raw_value)
348 1.24 lha printf(" Lifetime max/min %d/%d",
349 1.24 lha (int)attr->raw[2],
350 1.24 lha (int)attr->raw[4]);
351 1.24 lha }
352 1.24 lha
353 1.24 lha
354 1.1 kenh /*
355 1.15 soren * Print out SMART attribute thresholds and values
356 1.15 soren */
357 1.15 soren
358 1.15 soren void
359 1.15 soren print_smart_status(void *vbuf, void *tbuf)
360 1.15 soren {
361 1.15 soren struct ata_smart_attributes *value_buf = vbuf;
362 1.15 soren struct ata_smart_thresholds *threshold_buf = tbuf;
363 1.24 lha struct ata_smart_attr *attr;
364 1.24 lha int64_t raw_value;
365 1.24 lha int flags;
366 1.17 soren int i, j;
367 1.24 lha int aid;
368 1.15 soren int8_t checksum;
369 1.15 soren
370 1.15 soren for (i = checksum = 0; i < 511; i++)
371 1.15 soren checksum += ((int8_t *) value_buf)[i];
372 1.15 soren checksum *= -1;
373 1.15 soren if (checksum != value_buf->checksum) {
374 1.15 soren fprintf(stderr, "SMART attribute values checksum error\n");
375 1.15 soren return;
376 1.15 soren }
377 1.15 soren
378 1.15 soren for (i = checksum = 0; i < 511; i++)
379 1.15 soren checksum += ((int8_t *) threshold_buf)[i];
380 1.15 soren checksum *= -1;
381 1.15 soren if (checksum != threshold_buf->checksum) {
382 1.15 soren fprintf(stderr, "SMART attribute thresholds checksum error\n");
383 1.15 soren return;
384 1.15 soren }
385 1.15 soren
386 1.24 lha printf("id value thresh crit collect reliability description\t\t\traw\n");
387 1.24 lha for (i = 0; i < 256; i++) {
388 1.24 lha int thresh = 0;
389 1.24 lha
390 1.24 lha attr = NULL;
391 1.24 lha
392 1.24 lha for (j = 0; j < 30; j++) {
393 1.24 lha if (value_buf->attributes[j].id == i)
394 1.24 lha attr = &value_buf->attributes[j];
395 1.24 lha if (threshold_buf->thresholds[j].id == i)
396 1.24 lha thresh = threshold_buf->thresholds[j].value;
397 1.15 soren }
398 1.15 soren
399 1.24 lha if (thresh && attr == NULL)
400 1.24 lha errx(1, "threshold but not attr %d", i);
401 1.24 lha if (attr == NULL)
402 1.24 lha continue;
403 1.24 lha
404 1.24 lha if (attr->value == 0||attr->value == 0xFE||attr->value == 0xFF)
405 1.24 lha continue;
406 1.24 lha
407 1.24 lha for (aid = 0;
408 1.24 lha smart_attrs[aid].id != i && smart_attrs[aid].id != 0;
409 1.24 lha aid++)
410 1.24 lha ;
411 1.24 lha
412 1.24 lha flags = attr->flags;
413 1.24 lha
414 1.24 lha printf("%3d %3d %3d %-3s %-7s %stive %-24s",
415 1.24 lha i, attr->value, thresh,
416 1.24 lha flags & WDSM_ATTR_ADVISORY ? "yes" : "no",
417 1.24 lha flags & WDSM_ATTR_COLLECTIVE ? "online" : "offline",
418 1.24 lha attr->value > thresh ? "posi" : "nega",
419 1.24 lha smart_attrs[aid].name);
420 1.24 lha
421 1.24 lha for (j = 0, raw_value = 0; j < 6; j++)
422 1.24 lha raw_value += ((int64_t)attr->raw[j]) << (8*j);
423 1.24 lha
424 1.24 lha if (smart_attrs[aid].special)
425 1.24 lha (*smart_attrs[aid].special)(attr, raw_value);
426 1.24 lha printf("\n");
427 1.15 soren }
428 1.15 soren }
429 1.24 lha
430 1.24 lha struct {
431 1.24 lha int number;
432 1.24 lha const char *name;
433 1.24 lha } selftest_name[] = {
434 1.24 lha { 0, "Off-line" },
435 1.24 lha { 1, "Short off-line" },
436 1.24 lha { 2, "Extended off-line" },
437 1.24 lha { 127, "Abort off-line test" },
438 1.24 lha { 129, "Short captive" },
439 1.24 lha { 130, "Extended captive" },
440 1.24 lha { 256, "Unknown test" }, /* larger then u_int8_t */
441 1.24 lha { 0, NULL }
442 1.24 lha };
443 1.24 lha
444 1.24 lha const char *selftest_status[] = {
445 1.24 lha "No error",
446 1.24 lha "Aborted by the host",
447 1.24 lha "Interruped by the host by reset",
448 1.24 lha "Fatal error or unknown test error",
449 1.24 lha "Unknown test element failed",
450 1.24 lha "Electrical test element failed",
451 1.24 lha "The Servo (and/or seek) test element failed",
452 1.24 lha "Read element of test failed",
453 1.24 lha "Reserved",
454 1.24 lha "Reserved",
455 1.24 lha "Reserved",
456 1.24 lha "Reserved",
457 1.24 lha "Reserved",
458 1.24 lha "Reserved",
459 1.24 lha "Reserved",
460 1.24 lha "Self-test in progress"
461 1.24 lha };
462 1.24 lha
463 1.24 lha void
464 1.24 lha print_selftest_entry(int num, struct ata_smart_selftest *le)
465 1.24 lha {
466 1.24 lha unsigned char *p;
467 1.24 lha int i;
468 1.24 lha
469 1.24 lha /* check if all zero */
470 1.24 lha for (p = (void *)le, i = 0; i < sizeof(*le); i++)
471 1.24 lha if (p[i] != 0)
472 1.24 lha break;
473 1.24 lha if (i == sizeof(*le))
474 1.24 lha return;
475 1.24 lha
476 1.24 lha printf("Log entry: %d\n", num);
477 1.24 lha
478 1.24 lha /* Get test name */
479 1.24 lha for (i = 0; selftest_name[i].name != NULL; i++)
480 1.24 lha if (selftest_name[i].number == le->number)
481 1.24 lha break;
482 1.24 lha if (selftest_name[i].number == 0)
483 1.24 lha i = 255; /* unknown test */
484 1.24 lha
485 1.24 lha printf("\tName: %s\n", selftest_name[i].name);
486 1.24 lha printf("\tStatus: %s\n", selftest_status[le->status >> 4]);
487 1.24 lha if (le->status >> 4 == 15)
488 1.24 lha printf("\tPrecent of test remaning: %1d0\n", le->status & 0xf);
489 1.24 lha if (le->status)
490 1.24 lha printf("LBA first error: %d\n", le->lba_first_error);
491 1.24 lha }
492 1.24 lha
493 1.24 lha void
494 1.24 lha print_selftest(void *buf)
495 1.24 lha {
496 1.24 lha struct ata_smart_selftestlog *stlog = buf;
497 1.24 lha int8_t checksum;
498 1.24 lha int i;
499 1.24 lha
500 1.24 lha for (i = checksum = 0; i < 511; i++)
501 1.24 lha checksum += ((int8_t *) buf)[i];
502 1.24 lha checksum *= -1;
503 1.24 lha if ((u_int8_t)checksum != stlog->checksum) {
504 1.24 lha fprintf(stderr, "SMART selftest log checksum error\n");
505 1.24 lha return;
506 1.24 lha }
507 1.24 lha
508 1.24 lha if (stlog->data_structure_revision != 1) {
509 1.24 lha fprintf(stderr, "Log revision not 1");
510 1.24 lha return;
511 1.24 lha }
512 1.24 lha
513 1.24 lha if (stlog->mostrecenttest == 0) {
514 1.24 lha printf("No self-tests have been logged\n");
515 1.24 lha return;
516 1.24 lha }
517 1.24 lha
518 1.24 lha if (stlog->mostrecenttest > 22) {
519 1.24 lha fprintf(stderr, "Most recent test is too large\n");
520 1.24 lha return;
521 1.24 lha }
522 1.24 lha
523 1.24 lha for (i = stlog->mostrecenttest; i < 22; i++)
524 1.24 lha print_selftest_entry(i, &stlog->log_entries[i]);
525 1.24 lha for (i = 0; i < stlog->mostrecenttest; i++)
526 1.24 lha print_selftest_entry(i, &stlog->log_entries[i]);
527 1.15 soren }
528 1.15 soren
529 1.15 soren /*
530 1.15 soren * is_smart:
531 1.15 soren *
532 1.15 soren * Detect whether device supports SMART and SMART is enabled.
533 1.15 soren */
534 1.15 soren
535 1.15 soren int
536 1.20 mycroft is_smart(void)
537 1.15 soren {
538 1.15 soren int retval = 0;
539 1.15 soren struct atareq req;
540 1.15 soren unsigned char inbuf[DEV_BSIZE];
541 1.15 soren struct ataparams *inqbuf;
542 1.15 soren char *status;
543 1.15 soren
544 1.15 soren memset(&inbuf, 0, sizeof(inbuf));
545 1.15 soren memset(&req, 0, sizeof(req));
546 1.15 soren
547 1.15 soren inqbuf = (struct ataparams *) inbuf;
548 1.15 soren
549 1.15 soren req.flags = ATACMD_READ;
550 1.15 soren req.command = WDCC_IDENTIFY;
551 1.15 soren req.databuf = (caddr_t) inbuf;
552 1.15 soren req.datalen = sizeof(inbuf);
553 1.15 soren req.timeout = 1000;
554 1.15 soren
555 1.15 soren ata_command(&req);
556 1.15 soren
557 1.15 soren if (inqbuf->atap_cmd_def != 0 && inqbuf->atap_cmd_def != 0xffff) {
558 1.15 soren if (!(inqbuf->atap_cmd_set1 & WDC_CMD1_SMART)) {
559 1.15 soren fprintf(stderr, "SMART unsupported\n");
560 1.15 soren } else {
561 1.15 soren if (inqbuf->atap_ata_major <= WDC_VER_ATA5 ||
562 1.15 soren inqbuf->atap_cmd_set2 == 0xffff ||
563 1.15 soren inqbuf->atap_cmd_set2 == 0x0000) {
564 1.15 soren status = "status unknown";
565 1.15 soren retval = 2;
566 1.15 soren } else {
567 1.18 mycroft if (inqbuf->atap_cmd1_en & WDC_CMD1_SMART) {
568 1.15 soren status = "enabled";
569 1.15 soren retval = 1;
570 1.15 soren } else {
571 1.15 soren status = "disabled";
572 1.15 soren }
573 1.15 soren }
574 1.20 mycroft printf("SMART supported, SMART %s\n", status);
575 1.15 soren }
576 1.15 soren }
577 1.15 soren return retval;
578 1.15 soren }
579 1.15 soren
580 1.15 soren /*
581 1.1 kenh * DEVICE COMMANDS
582 1.1 kenh */
583 1.1 kenh
584 1.1 kenh /*
585 1.1 kenh * device_identify:
586 1.1 kenh *
587 1.1 kenh * Display the identity of the device
588 1.1 kenh */
589 1.1 kenh void
590 1.13 simonb device_identify(int argc, char *argv[])
591 1.1 kenh {
592 1.1 kenh struct ataparams *inqbuf;
593 1.1 kenh struct atareq req;
594 1.1 kenh unsigned char inbuf[DEV_BSIZE];
595 1.2 kenh #if BYTE_ORDER == LITTLE_ENDIAN
596 1.1 kenh int i;
597 1.1 kenh u_int16_t *p;
598 1.1 kenh #endif
599 1.1 kenh
600 1.1 kenh /* No arguments. */
601 1.1 kenh if (argc != 0)
602 1.5 soren usage();
603 1.1 kenh
604 1.1 kenh memset(&inbuf, 0, sizeof(inbuf));
605 1.1 kenh memset(&req, 0, sizeof(req));
606 1.1 kenh
607 1.1 kenh inqbuf = (struct ataparams *) inbuf;
608 1.1 kenh
609 1.1 kenh req.flags = ATACMD_READ;
610 1.1 kenh req.command = WDCC_IDENTIFY;
611 1.1 kenh req.databuf = (caddr_t) inbuf;
612 1.1 kenh req.datalen = sizeof(inbuf);
613 1.1 kenh req.timeout = 1000;
614 1.1 kenh
615 1.1 kenh ata_command(&req);
616 1.1 kenh
617 1.1 kenh #if BYTE_ORDER == LITTLE_ENDIAN
618 1.1 kenh /*
619 1.1 kenh * On little endian machines, we need to shuffle the string
620 1.1 kenh * byte order. However, we don't have to do this for NEC or
621 1.1 kenh * Mitsumi ATAPI devices
622 1.1 kenh */
623 1.1 kenh
624 1.1 kenh if (!((inqbuf->atap_config & WDC_CFG_ATAPI_MASK) == WDC_CFG_ATAPI &&
625 1.1 kenh ((inqbuf->atap_model[0] == 'N' &&
626 1.1 kenh inqbuf->atap_model[1] == 'E') ||
627 1.1 kenh (inqbuf->atap_model[0] == 'F' &&
628 1.1 kenh inqbuf->atap_model[1] == 'X')))) {
629 1.1 kenh for (i = 0 ; i < sizeof(inqbuf->atap_model); i += 2) {
630 1.1 kenh p = (u_short *) (inqbuf->atap_model + i);
631 1.1 kenh *p = ntohs(*p);
632 1.1 kenh }
633 1.1 kenh for (i = 0 ; i < sizeof(inqbuf->atap_serial); i += 2) {
634 1.1 kenh p = (u_short *) (inqbuf->atap_serial + i);
635 1.1 kenh *p = ntohs(*p);
636 1.1 kenh }
637 1.1 kenh for (i = 0 ; i < sizeof(inqbuf->atap_revision); i += 2) {
638 1.1 kenh p = (u_short *) (inqbuf->atap_revision + i);
639 1.1 kenh *p = ntohs(*p);
640 1.1 kenh }
641 1.1 kenh }
642 1.1 kenh #endif
643 1.1 kenh
644 1.1 kenh /*
645 1.1 kenh * Strip blanks off of the info strings. Yuck, I wish this was
646 1.1 kenh * cleaner.
647 1.1 kenh */
648 1.1 kenh
649 1.1 kenh if (inqbuf->atap_model[sizeof(inqbuf->atap_model) - 1] == ' ') {
650 1.1 kenh inqbuf->atap_model[sizeof(inqbuf->atap_model) - 1] = '\0';
651 1.1 kenh while (inqbuf->atap_model[strlen(inqbuf->atap_model) - 1] == ' ')
652 1.1 kenh inqbuf->atap_model[strlen(inqbuf->atap_model) - 1] = '\0';
653 1.1 kenh }
654 1.1 kenh
655 1.1 kenh if (inqbuf->atap_revision[sizeof(inqbuf->atap_revision) - 1] == ' ') {
656 1.1 kenh inqbuf->atap_revision[sizeof(inqbuf->atap_revision) - 1] = '\0';
657 1.1 kenh while (inqbuf->atap_revision[strlen(inqbuf->atap_revision) - 1] == ' ')
658 1.1 kenh inqbuf->atap_revision[strlen(inqbuf->atap_revision) - 1] = '\0';
659 1.1 kenh }
660 1.1 kenh
661 1.1 kenh if (inqbuf->atap_serial[sizeof(inqbuf->atap_serial) - 1] == ' ') {
662 1.1 kenh inqbuf->atap_serial[sizeof(inqbuf->atap_serial) - 1] = '\0';
663 1.1 kenh while (inqbuf->atap_serial[strlen(inqbuf->atap_serial) - 1] == ' ')
664 1.1 kenh inqbuf->atap_serial[strlen(inqbuf->atap_serial) - 1] = '\0';
665 1.1 kenh }
666 1.1 kenh
667 1.1 kenh printf("Model: %.*s, Rev: %.*s, Serial #: %.*s\n",
668 1.1 kenh (int) sizeof(inqbuf->atap_model), inqbuf->atap_model,
669 1.1 kenh (int) sizeof(inqbuf->atap_revision), inqbuf->atap_revision,
670 1.1 kenh (int) sizeof(inqbuf->atap_serial), inqbuf->atap_serial);
671 1.1 kenh
672 1.1 kenh printf("Device type: %s, %s\n", inqbuf->atap_config & WDC_CFG_ATAPI ?
673 1.1 kenh "ATAPI" : "ATA", inqbuf->atap_config & ATA_CFG_FIXED ? "fixed" :
674 1.1 kenh "removable");
675 1.1 kenh
676 1.1 kenh if ((inqbuf->atap_config & WDC_CFG_ATAPI_MASK) == 0)
677 1.1 kenh printf("Cylinders: %d, heads: %d, sec/track: %d, total "
678 1.1 kenh "sectors: %d\n", inqbuf->atap_cylinders,
679 1.1 kenh inqbuf->atap_heads, inqbuf->atap_sectors,
680 1.1 kenh (inqbuf->atap_capacity[1] << 16) |
681 1.1 kenh inqbuf->atap_capacity[0]);
682 1.1 kenh
683 1.1 kenh if (inqbuf->atap_queuedepth & WDC_QUEUE_DEPTH_MASK)
684 1.1 kenh printf("Device supports command queue depth of %d\n",
685 1.1 kenh inqbuf->atap_queuedepth & 0xf);
686 1.1 kenh
687 1.1 kenh printf("Device capabilities:\n");
688 1.10 is print_bitinfo("\t", "\n", inqbuf->atap_capabilities1, ata_caps);
689 1.1 kenh
690 1.1 kenh if (inqbuf->atap_ata_major != 0 && inqbuf->atap_ata_major != 0xffff) {
691 1.1 kenh printf("Device supports following standards:\n");
692 1.10 is print_bitinfo("", " ", inqbuf->atap_ata_major, ata_vers);
693 1.1 kenh printf("\n");
694 1.1 kenh }
695 1.1 kenh
696 1.1 kenh if (inqbuf->atap_cmd_set1 != 0 && inqbuf->atap_cmd_set1 != 0xffff &&
697 1.1 kenh inqbuf->atap_cmd_set2 != 0 && inqbuf->atap_cmd_set2 != 0xffff) {
698 1.1 kenh printf("Command set support:\n");
699 1.10 is print_bitinfo("\t", "\n", inqbuf->atap_cmd_set1, ata_cmd_set1);
700 1.10 is print_bitinfo("\t", "\n", inqbuf->atap_cmd_set2, ata_cmd_set2);
701 1.23 yamt if (inqbuf->atap_cmd_ext != 0 && inqbuf->atap_cmd_ext != 0xffff)
702 1.23 yamt print_bitinfo("\t", "\n", inqbuf->atap_cmd_ext,
703 1.23 yamt ata_cmd_ext);
704 1.1 kenh }
705 1.1 kenh
706 1.1 kenh if (inqbuf->atap_cmd_def != 0 && inqbuf->atap_cmd_def != 0xffff) {
707 1.1 kenh printf("Command sets/features enabled:\n");
708 1.14 simonb print_bitinfo("\t", "\n", inqbuf->atap_cmd1_en &
709 1.1 kenh (WDC_CMD1_SRV | WDC_CMD1_RLSE | WDC_CMD1_AHEAD |
710 1.1 kenh WDC_CMD1_CACHE | WDC_CMD1_SEC | WDC_CMD1_SMART),
711 1.1 kenh ata_cmd_set1);
712 1.14 simonb print_bitinfo("\t", "\n", inqbuf->atap_cmd2_en &
713 1.1 kenh (WDC_CMD2_RMSN | ATA_CMD2_APM), ata_cmd_set2);
714 1.1 kenh }
715 1.1 kenh
716 1.1 kenh return;
717 1.1 kenh }
718 1.1 kenh
719 1.1 kenh /*
720 1.1 kenh * device idle:
721 1.1 kenh *
722 1.1 kenh * issue the IDLE IMMEDIATE command to the drive
723 1.1 kenh */
724 1.1 kenh
725 1.1 kenh void
726 1.13 simonb device_idle(int argc, char *argv[])
727 1.1 kenh {
728 1.1 kenh struct atareq req;
729 1.1 kenh
730 1.1 kenh /* No arguments. */
731 1.1 kenh if (argc != 0)
732 1.5 soren usage();
733 1.1 kenh
734 1.1 kenh memset(&req, 0, sizeof(req));
735 1.1 kenh
736 1.1 kenh if (strcmp(cmdname, "idle") == 0)
737 1.1 kenh req.command = WDCC_IDLE_IMMED;
738 1.1 kenh else if (strcmp(cmdname, "standby") == 0)
739 1.1 kenh req.command = WDCC_STANDBY_IMMED;
740 1.1 kenh else
741 1.1 kenh req.command = WDCC_SLEEP;
742 1.1 kenh
743 1.1 kenh req.timeout = 1000;
744 1.1 kenh
745 1.1 kenh ata_command(&req);
746 1.1 kenh
747 1.1 kenh return;
748 1.1 kenh }
749 1.1 kenh
750 1.1 kenh /*
751 1.1 kenh * Set the idle timer on the disk. Set it for either idle mode or
752 1.1 kenh * standby mode, depending on how we were invoked.
753 1.1 kenh */
754 1.1 kenh
755 1.1 kenh void
756 1.13 simonb device_setidle(int argc, char *argv[])
757 1.1 kenh {
758 1.1 kenh unsigned long idle;
759 1.1 kenh struct atareq req;
760 1.1 kenh char *end;
761 1.1 kenh
762 1.1 kenh /* Only one argument */
763 1.1 kenh if (argc != 1)
764 1.5 soren usage();
765 1.1 kenh
766 1.1 kenh idle = strtoul(argv[0], &end, 0);
767 1.1 kenh
768 1.1 kenh if (*end != '\0') {
769 1.1 kenh fprintf(stderr, "Invalid idle time: \"%s\"\n", argv[0]);
770 1.1 kenh exit(1);
771 1.1 kenh }
772 1.1 kenh
773 1.1 kenh if (idle > 19800) {
774 1.1 kenh fprintf(stderr, "Idle time has a maximum value of 5.5 "
775 1.1 kenh "hours\n");
776 1.1 kenh exit(1);
777 1.1 kenh }
778 1.1 kenh
779 1.1 kenh if (idle != 0 && idle < 5) {
780 1.1 kenh fprintf(stderr, "Idle timer must be at least 5 seconds\n");
781 1.1 kenh exit(1);
782 1.1 kenh }
783 1.1 kenh
784 1.1 kenh memset(&req, 0, sizeof(req));
785 1.1 kenh
786 1.1 kenh if (idle <= 240*5)
787 1.1 kenh req.sec_count = idle / 5;
788 1.1 kenh else
789 1.1 kenh req.sec_count = idle / (30*60) + 240;
790 1.1 kenh
791 1.1 kenh req.command = cmdname[3] == 's' ? WDCC_STANDBY : WDCC_IDLE;
792 1.1 kenh req.timeout = 1000;
793 1.1 kenh
794 1.1 kenh ata_command(&req);
795 1.1 kenh
796 1.1 kenh return;
797 1.3 kenh }
798 1.3 kenh
799 1.3 kenh /*
800 1.3 kenh * Query the device for the current power mode
801 1.3 kenh */
802 1.3 kenh
803 1.3 kenh void
804 1.13 simonb device_checkpower(int argc, char *argv[])
805 1.3 kenh {
806 1.3 kenh struct atareq req;
807 1.3 kenh
808 1.3 kenh /* No arguments. */
809 1.3 kenh if (argc != 0)
810 1.5 soren usage();
811 1.3 kenh
812 1.3 kenh memset(&req, 0, sizeof(req));
813 1.3 kenh
814 1.3 kenh req.command = WDCC_CHECK_PWR;
815 1.3 kenh req.timeout = 1000;
816 1.3 kenh req.flags = ATACMD_READREG;
817 1.3 kenh
818 1.3 kenh ata_command(&req);
819 1.3 kenh
820 1.3 kenh printf("Current power status: ");
821 1.3 kenh
822 1.3 kenh switch (req.sec_count) {
823 1.3 kenh case 0x00:
824 1.3 kenh printf("Standby mode\n");
825 1.3 kenh break;
826 1.3 kenh case 0x80:
827 1.3 kenh printf("Idle mode\n");
828 1.3 kenh break;
829 1.3 kenh case 0xff:
830 1.3 kenh printf("Active mode\n");
831 1.3 kenh break;
832 1.3 kenh default:
833 1.3 kenh printf("Unknown power code (%02x)\n", req.sec_count);
834 1.3 kenh }
835 1.3 kenh
836 1.15 soren return;
837 1.15 soren }
838 1.15 soren
839 1.15 soren /*
840 1.15 soren * device_smart:
841 1.15 soren *
842 1.15 soren * Display SMART status
843 1.15 soren */
844 1.15 soren void
845 1.15 soren device_smart(int argc, char *argv[])
846 1.15 soren {
847 1.15 soren struct atareq req;
848 1.15 soren unsigned char inbuf[DEV_BSIZE];
849 1.15 soren unsigned char inbuf2[DEV_BSIZE];
850 1.15 soren
851 1.15 soren /* Only one argument */
852 1.15 soren if (argc != 1)
853 1.15 soren usage();
854 1.15 soren
855 1.15 soren if (strcmp(argv[0], "enable") == 0) {
856 1.20 mycroft memset(&req, 0, sizeof(req));
857 1.15 soren
858 1.20 mycroft req.features = WDSM_ENABLE_OPS;
859 1.20 mycroft req.command = WDCC_SMART;
860 1.20 mycroft req.cylinder = htole16(WDSMART_CYL);
861 1.20 mycroft req.timeout = 1000;
862 1.15 soren
863 1.20 mycroft ata_command(&req);
864 1.15 soren
865 1.20 mycroft is_smart();
866 1.15 soren } else if (strcmp(argv[0], "disable") == 0) {
867 1.20 mycroft memset(&req, 0, sizeof(req));
868 1.15 soren
869 1.20 mycroft req.features = WDSM_DISABLE_OPS;
870 1.20 mycroft req.command = WDCC_SMART;
871 1.20 mycroft req.cylinder = htole16(WDSMART_CYL);
872 1.20 mycroft req.timeout = 1000;
873 1.15 soren
874 1.20 mycroft ata_command(&req);
875 1.15 soren
876 1.20 mycroft is_smart();
877 1.16 soren } else if (strcmp(argv[0], "status") == 0) {
878 1.24 lha if (!is_smart()) {
879 1.24 lha fprintf(stderr, "SMART not supported\n");
880 1.24 lha return;
881 1.24 lha }
882 1.24 lha
883 1.15 soren memset(&inbuf, 0, sizeof(inbuf));
884 1.15 soren memset(&req, 0, sizeof(req));
885 1.15 soren
886 1.15 soren req.features = WDSM_STATUS;
887 1.15 soren req.command = WDCC_SMART;
888 1.15 soren req.cylinder = htole16(WDSMART_CYL);
889 1.15 soren req.timeout = 1000;
890 1.15 soren
891 1.15 soren ata_command(&req);
892 1.15 soren
893 1.15 soren if (req.cylinder != htole16(WDSMART_CYL)) {
894 1.15 soren fprintf(stderr, "Threshold exceeds condition\n");
895 1.15 soren }
896 1.15 soren
897 1.15 soren /* WDSM_RD_DATA and WDSM_RD_THRESHOLDS are optional
898 1.15 soren * features, the following ata_command()'s may error
899 1.15 soren * and exit().
900 1.15 soren */
901 1.15 soren
902 1.15 soren memset(&inbuf, 0, sizeof(inbuf));
903 1.15 soren memset(&req, 0, sizeof(req));
904 1.15 soren
905 1.15 soren req.flags = ATACMD_READ;
906 1.15 soren req.features = WDSM_RD_DATA;
907 1.15 soren req.command = WDCC_SMART;
908 1.15 soren req.databuf = (caddr_t) inbuf;
909 1.15 soren req.datalen = sizeof(inbuf);
910 1.15 soren req.cylinder = htole16(WDSMART_CYL);
911 1.15 soren req.timeout = 1000;
912 1.15 soren
913 1.15 soren ata_command(&req);
914 1.15 soren
915 1.15 soren memset(&inbuf2, 0, sizeof(inbuf2));
916 1.15 soren memset(&req, 0, sizeof(req));
917 1.15 soren
918 1.15 soren req.flags = ATACMD_READ;
919 1.15 soren req.features = WDSM_RD_THRESHOLDS;
920 1.15 soren req.command = WDCC_SMART;
921 1.15 soren req.databuf = (caddr_t) inbuf2;
922 1.15 soren req.datalen = sizeof(inbuf2);
923 1.15 soren req.cylinder = htole16(WDSMART_CYL);
924 1.15 soren req.timeout = 1000;
925 1.15 soren
926 1.15 soren ata_command(&req);
927 1.15 soren
928 1.15 soren print_smart_status(inbuf, inbuf2);
929 1.24 lha
930 1.24 lha } else if (strcmp(argv[0], "selftest-log") == 0) {
931 1.24 lha if (!is_smart()) {
932 1.15 soren fprintf(stderr, "SMART not supported\n");
933 1.24 lha return;
934 1.15 soren }
935 1.24 lha
936 1.24 lha memset(&inbuf, 0, sizeof(inbuf));
937 1.24 lha memset(&req, 0, sizeof(req));
938 1.24 lha
939 1.24 lha req.flags = ATACMD_READ;
940 1.24 lha req.features = WDSM_RD_LOG;
941 1.24 lha req.sec_count = 1;
942 1.24 lha req.sec_num = 6;
943 1.24 lha req.command = WDCC_SMART;
944 1.24 lha req.databuf = (caddr_t) inbuf;
945 1.24 lha req.datalen = sizeof(inbuf);
946 1.24 lha req.cylinder = htole16(WDSMART_CYL);
947 1.24 lha req.timeout = 1000;
948 1.24 lha
949 1.24 lha ata_command(&req);
950 1.24 lha
951 1.24 lha print_selftest(inbuf);
952 1.24 lha
953 1.15 soren } else {
954 1.15 soren usage();
955 1.15 soren }
956 1.3 kenh return;
957 1.1 kenh }
958