1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
3 * ata_id - reads product/serial number from ATA drives
5 * Copyright (C) 2005-2008 Kay Sievers <kay.sievers@vrfy.org>
6 * Copyright (C) 2009 Lennart Poettering <lennart@poettering.net>
7 * Copyright (C) 2009 David Zeuthen <zeuthen@gmail.com>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 #include <scsi/scsi.h>
35 #include <scsi/scsi_ioctl.h>
36 #include <sys/ioctl.h>
37 #include <sys/types.h>
39 #include <linux/types.h>
40 #include <linux/hdreg.h>
42 #include <linux/cdrom.h>
43 #include <arpa/inet.h>
46 #include "libudev-private.h"
48 #define COMMAND_TIMEOUT 2000
50 /* Sends a SCSI command block */
51 static int sg_io(int fd, int direction,
52 const void *cdb, size_t cdb_len,
53 void *data, size_t data_len,
54 void *sense, size_t sense_len)
57 struct sg_io_hdr io_hdr;
59 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
60 io_hdr.interface_id = 'S';
61 io_hdr.cmdp = (unsigned char*) cdb;
62 io_hdr.cmd_len = cdb_len;
64 io_hdr.dxfer_len = data_len;
66 io_hdr.mx_sb_len = sense_len;
67 io_hdr.dxfer_direction = direction;
68 io_hdr.timeout = COMMAND_TIMEOUT;
69 return ioctl(fd, SG_IO, &io_hdr);
72 static int disk_command(int fd, int command, int direction, void *cmd_data,
73 void *data, size_t *len)
75 uint8_t *bytes = cmd_data;
78 uint8_t *desc = sense+8;
82 * ATA Pass-Through 12 byte command, as described in "T10 04-262r8
83 * ATA Command Pass-Through":
84 * http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
86 memset(cdb, 0, sizeof(cdb));
87 cdb[0] = 0xa1; /* OPERATION CODE: 12 byte pass through */
88 if (direction == SG_DXFER_NONE) {
89 cdb[1] = 3 << 1; /* PROTOCOL: Non-Data */
90 cdb[2] = 0x20; /* OFF_LINE=0, CK_COND=1, T_DIR=0, BYT_BLOK=0, T_LENGTH=0 */
91 } else if (direction == SG_DXFER_FROM_DEV) {
92 cdb[1] = 4 << 1; /* PROTOCOL: PIO Data-in */
93 cdb[2] = 0x2e; /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
94 } else if (direction == SG_DXFER_TO_DEV) {
95 cdb[1] = 5 << 1; /* PROTOCOL: PIO Data-Out */
96 cdb[2] = 0x26; /* OFF_LINE=0, CK_COND=1, T_DIR=0, BYT_BLOK=1, T_LENGTH=2 */
98 cdb[3] = bytes[1]; /* FEATURES */
99 cdb[4] = bytes[3]; /* SECTORS */
100 cdb[5] = bytes[9]; /* LBA LOW */
101 cdb[6] = bytes[8]; /* LBA MID */
102 cdb[7] = bytes[7]; /* LBA HIGH */
103 cdb[8] = bytes[10] & 0x4F; /* SELECT */
104 cdb[9] = (uint8_t) command;
105 memset(sense, 0, sizeof(sense));
106 if ((ret = sg_io(fd, direction, cdb, sizeof(cdb), data, len ? *len : 0, sense, sizeof(sense))) < 0)
108 if (sense[0] != 0x72 || desc[0] != 0x9 || desc[1] != 0x0c) {
113 memset(bytes, 0, 12);
114 bytes[1] = desc[3]; /* FEATURES */
115 bytes[2] = desc[4]; /* STATUS */
116 bytes[3] = desc[5]; /* SECTORS */
117 bytes[9] = desc[7]; /* LBA LOW */
118 bytes[8] = desc[9]; /* LBA MID */
119 bytes[7] = desc[11]; /* LBA HIGH */
120 bytes[10] = desc[12]; /* SELECT */
121 bytes[11] = desc[13]; /* ERROR */
126 * disk_identify_get_string:
127 * @identify: A block of IDENTIFY data
128 * @offset_words: Offset of the string to get, in words.
129 * @dest: Destination buffer for the string.
130 * @dest_len: Length of destination buffer, in bytes.
132 * Copies the ATA string from @identify located at @offset_words into @dest.
134 static void disk_identify_get_string (uint8_t identify[512],
135 unsigned int offset_words,
142 assert (identify != NULL);
143 assert (dest != NULL);
144 assert ((dest_len & 1) == 0);
146 while (dest_len > 0) {
147 c1 = ((uint16_t *) identify)[offset_words] >> 8;
148 c2 = ((uint16_t *) identify)[offset_words] & 0xff;
158 static void disk_identify_fixup_string (uint8_t identify[512],
159 unsigned int offset_words,
162 disk_identify_get_string(identify, offset_words,
163 (char *) identify + offset_words * 2, len);
166 static void disk_identify_fixup_uint16 (uint8_t identify[512], unsigned int offset_words)
170 p = (uint16_t *) identify;
171 p[offset_words] = le16toh (p[offset_words]);
176 * @udev: The libudev context.
177 * @fd: File descriptor for the block device.
178 * @out_identify: Return location for IDENTIFY data.
180 * Sends the IDENTIFY DEVICE command to the device represented by
181 * @fd. If successful, then the result will be copied into
184 * This routine is based on code from libatasmart, Copyright 2008
185 * Lennart Poettering, LGPL v2.1.
187 * Returns: 0 if the IDENTIFY data was successfully obtained,
188 * otherwise non-zero with errno set.
190 static int disk_identify (struct udev *udev,
192 uint8_t out_identify[512])
201 assert (out_identify != NULL);
205 memset (out_identify, '\0', 512);
207 if ((ret = fstat(fd, &st)) < 0)
210 if (!S_ISBLK(st.st_mode)) {
216 * do not confuse optical drive firmware with ATA commands
217 * some drives are reported to blank CD-RWs
219 if (ioctl(fd, CDROM_GET_CAPABILITY, NULL) >= 0) {
225 /* So, it's a block device. Let's make sure the ioctls work */
226 if ((ret = ioctl(fd, BLKGETSIZE64, &size)) < 0)
229 if (size <= 0 || size == (uint64_t) -1) {
234 memset(cmd, 0, sizeof(cmd));
236 ret = disk_command(fd,
237 0xEC, /* IDENTIFY DEVICE command */
238 SG_DXFER_FROM_DEV, cmd,
248 /* Check if IDENTIFY data is all NULs */
249 for (p = out_identify; p < (const uint8_t*) out_identify + len; p++) {
266 static void log_fn(struct udev *udev, int priority,
267 const char *file, int line, const char *fn,
268 const char *format, va_list args)
270 vsyslog(priority, format, args);
273 int main(int argc, char *argv[])
276 struct hd_driveid id;
277 uint8_t identify[512];
282 const char *node = NULL;
287 static const struct option options[] = {
288 { "export", no_argument, NULL, 'x' },
289 { "help", no_argument, NULL, 'h' },
297 udev_log_init("ata_id");
298 udev_set_log_fn(udev, log_fn);
303 option = getopt_long(argc, argv, "xh", options, NULL);
312 printf("Usage: ata_id [--export] [--help] <device>\n"
313 " --export print values as environment keys\n"
314 " --help print this help text\n\n");
323 err(udev, "no node specified\n");
328 fd = open(node, O_RDONLY|O_NONBLOCK);
330 err(udev, "unable to open '%s'\n", node);
335 if (disk_identify(udev, fd, identify) == 0) {
337 * fix up only the fields from the IDENTIFY data that we are going to
338 * use and copy it into the hd_driveid struct for convenience
340 disk_identify_fixup_string (identify, 10, 20); /* serial */
341 disk_identify_fixup_string (identify, 23, 6); /* fwrev */
342 disk_identify_fixup_string (identify, 27, 40); /* model */
343 disk_identify_fixup_uint16 (identify, 0); /* configuration */
344 disk_identify_fixup_uint16 (identify, 75); /* queue depth */
345 disk_identify_fixup_uint16 (identify, 75); /* SATA capabilities */
346 disk_identify_fixup_uint16 (identify, 82); /* command set supported */
347 disk_identify_fixup_uint16 (identify, 83); /* command set supported */
348 disk_identify_fixup_uint16 (identify, 84); /* command set supported */
349 disk_identify_fixup_uint16 (identify, 85); /* command set supported */
350 disk_identify_fixup_uint16 (identify, 86); /* command set supported */
351 disk_identify_fixup_uint16 (identify, 87); /* command set supported */
352 disk_identify_fixup_uint16 (identify, 89); /* time required for SECURITY ERASE UNIT */
353 disk_identify_fixup_uint16 (identify, 90); /* time required for enhanced SECURITY ERASE UNIT */
354 disk_identify_fixup_uint16 (identify, 91); /* current APM values */
355 disk_identify_fixup_uint16 (identify, 94); /* current AAM value */
356 disk_identify_fixup_uint16 (identify, 128); /* device lock function */
357 disk_identify_fixup_uint16 (identify, 217); /* nominal media rotation rate */
358 memcpy(&id, identify, sizeof id);
360 /* If this fails, then try HDIO_GET_IDENTITY */
361 if (ioctl(fd, HDIO_GET_IDENTITY, &id) != 0) {
362 if (errno == ENOTTY) {
363 info(udev, "HDIO_GET_IDENTITY unsupported for '%s'\n", node);
366 err(udev, "HDIO_GET_IDENTITY failed for '%s'\n", node);
373 memcpy (model, id.model, 40);
375 udev_util_encode_string(model, model_enc, sizeof(model_enc));
376 udev_util_replace_whitespace((char *) id.model, model, 40);
377 udev_util_replace_chars(model, NULL);
378 udev_util_replace_whitespace((char *) id.serial_no, serial, 20);
379 udev_util_replace_chars(serial, NULL);
380 udev_util_replace_whitespace((char *) id.fw_rev, revision, 8);
381 udev_util_replace_chars(revision, NULL);
384 /* Set this to convey the disk speaks the ATA protocol */
385 printf("ID_ATA=1\n");
387 if ((id.config >> 8) & 0x80) {
388 /* This is an ATAPI device */
389 switch ((id.config >> 8) & 0x1f) {
391 printf("ID_TYPE=cd\n");
394 printf("ID_TYPE=tape\n");
397 printf("ID_TYPE=cd\n");
400 printf("ID_TYPE=optical\n");
403 printf("ID_TYPE=generic\n");
407 printf("ID_TYPE=disk\n");
409 printf("ID_BUS=ata\n");
410 printf("ID_MODEL=%s\n", model);
411 printf("ID_MODEL_ENC=%s\n", model_enc);
412 printf("ID_REVISION=%s\n", revision);
413 printf("ID_SERIAL=%s_%s\n", model, serial);
414 printf("ID_SERIAL_SHORT=%s\n", serial);
416 if (id.command_set_1 & (1<<5)) {
417 printf ("ID_ATA_WRITE_CACHE=1\n");
418 printf ("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id.cfs_enable_1 & (1<<5)) ? 1 : 0);
420 if (id.command_set_1 & (1<<10)) {
421 printf("ID_ATA_FEATURE_SET_HPA=1\n");
422 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id.cfs_enable_1 & (1<<10)) ? 1 : 0);
425 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
426 * so it is easy to check whether the protected area is in use.
429 if (id.command_set_1 & (1<<3)) {
430 printf("ID_ATA_FEATURE_SET_PM=1\n");
431 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id.cfs_enable_1 & (1<<3)) ? 1 : 0);
433 if (id.command_set_1 & (1<<1)) {
434 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
435 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id.cfs_enable_1 & (1<<1)) ? 1 : 0);
436 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id.trseuc * 2);
437 if ((id.cfs_enable_1 & (1<<1))) /* enabled */ {
439 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
441 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
444 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id.trsEuc * 2);
446 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
448 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
450 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
452 if (id.command_set_1 & (1<<0)) {
453 printf("ID_ATA_FEATURE_SET_SMART=1\n");
454 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id.cfs_enable_1 & (1<<0)) ? 1 : 0);
456 if (id.command_set_2 & (1<<9)) {
457 printf("ID_ATA_FEATURE_SET_AAM=1\n");
458 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<9)) ? 1 : 0);
459 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id.acoustic >> 8);
460 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id.acoustic & 0xff);
462 if (id.command_set_2 & (1<<5)) {
463 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
464 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id.cfs_enable_2 & (1<<5)) ? 1 : 0);
466 if (id.command_set_2 & (1<<3)) {
467 printf("ID_ATA_FEATURE_SET_APM=1\n");
468 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<3)) ? 1 : 0);
469 if ((id.cfs_enable_2 & (1<<3)))
470 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id.CurAPMvalues & 0xff);
472 if (id.command_set_2 & (1<<0))
473 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
476 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
477 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
478 * the device does not claim compliance with the Serial ATA specification and words
479 * 76 through 79 are not valid and shall be ignored.
481 word = *((uint16_t *) identify + 76);
482 if (word != 0x0000 && word != 0xffff) {
483 printf("ID_ATA_SATA=1\n");
485 * If bit 2 of word 76 is set to one, then the device supports the Gen2
486 * signaling rate of 3.0 Gb/s (see SATA 2.6).
488 * If bit 1 of word 76 is set to one, then the device supports the Gen1
489 * signaling rate of 1.5 Gb/s (see SATA 2.6).
492 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
494 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
497 /* Word 217 indicates the nominal media rotation rate of the device */
498 word = *((uint16_t *) identify + 217);
499 if (word != 0x0000) {
500 if (word == 0x0001) {
501 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
502 } else if (word >= 0x0401 && word <= 0xfffe) {
503 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word);
508 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
509 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
510 * All other values are reserved.
512 word = *((uint16_t *) identify + 108);
513 if ((word & 0xf000) == 0x5000) {
516 wwwn = *((uint16_t *) identify + 108);
518 wwwn |= *((uint16_t *) identify + 109);
520 wwwn |= *((uint16_t *) identify + 110);
522 wwwn |= *((uint16_t *) identify + 111);
523 printf("ID_WWN=0x%llx\n", (unsigned long long int) wwwn);
524 /* ATA devices have no vendor extension */
525 printf("ID_WWN_WITH_EXTENSION=0x%llx\n", (unsigned long long int) wwwn);
528 if (serial[0] != '\0')
529 printf("%s_%s\n", model, serial);
531 printf("%s\n", model);