2 * ata_id - reads product/serial number from ATA drives
4 * Copyright (C) 2005-2008 Kay Sievers <kay.sievers@vrfy.org>
5 * Copyright (C) 2009 Lennart Poettering <lennart@poettering.net>
6 * Copyright (C) 2009 David Zeuthen <zeuthen@gmail.com>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 #include <scsi/scsi.h>
34 #include <scsi/scsi_ioctl.h>
35 #include <sys/ioctl.h>
36 #include <sys/types.h>
38 #include <linux/types.h>
39 #include <linux/hdreg.h>
41 #include <linux/cdrom.h>
42 #include <arpa/inet.h>
45 #include "libudev-private.h"
47 #define COMMAND_TIMEOUT 2000
49 /* Sends a SCSI command block */
50 static int sg_io(int fd, int direction,
51 const void *cdb, size_t cdb_len,
52 void *data, size_t data_len,
53 void *sense, size_t sense_len)
56 struct sg_io_hdr io_hdr;
58 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
59 io_hdr.interface_id = 'S';
60 io_hdr.cmdp = (unsigned char*) cdb;
61 io_hdr.cmd_len = cdb_len;
63 io_hdr.dxfer_len = data_len;
65 io_hdr.mx_sb_len = sense_len;
66 io_hdr.dxfer_direction = direction;
67 io_hdr.timeout = COMMAND_TIMEOUT;
68 return ioctl(fd, SG_IO, &io_hdr);
71 static int disk_command(int fd, int command, int direction, void *cmd_data,
72 void *data, size_t *len)
74 uint8_t *bytes = cmd_data;
77 uint8_t *desc = sense+8;
81 * ATA Pass-Through 12 byte command, as described in "T10 04-262r8
82 * ATA Command Pass-Through":
83 * http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
85 memset(cdb, 0, sizeof(cdb));
86 cdb[0] = 0xa1; /* OPERATION CODE: 12 byte pass through */
87 if (direction == SG_DXFER_NONE) {
88 cdb[1] = 3 << 1; /* PROTOCOL: Non-Data */
89 cdb[2] = 0x20; /* OFF_LINE=0, CK_COND=1, T_DIR=0, BYT_BLOK=0, T_LENGTH=0 */
90 } else if (direction == SG_DXFER_FROM_DEV) {
91 cdb[1] = 4 << 1; /* PROTOCOL: PIO Data-in */
92 cdb[2] = 0x2e; /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
93 } else if (direction == SG_DXFER_TO_DEV) {
94 cdb[1] = 5 << 1; /* PROTOCOL: PIO Data-Out */
95 cdb[2] = 0x26; /* OFF_LINE=0, CK_COND=1, T_DIR=0, BYT_BLOK=1, T_LENGTH=2 */
97 cdb[3] = bytes[1]; /* FEATURES */
98 cdb[4] = bytes[3]; /* SECTORS */
99 cdb[5] = bytes[9]; /* LBA LOW */
100 cdb[6] = bytes[8]; /* LBA MID */
101 cdb[7] = bytes[7]; /* LBA HIGH */
102 cdb[8] = bytes[10] & 0x4F; /* SELECT */
103 cdb[9] = (uint8_t) command;
104 memset(sense, 0, sizeof(sense));
105 if ((ret = sg_io(fd, direction, cdb, sizeof(cdb), data, len ? *len : 0, sense, sizeof(sense))) < 0)
107 if (sense[0] != 0x72 || desc[0] != 0x9 || desc[1] != 0x0c) {
112 memset(bytes, 0, 12);
113 bytes[1] = desc[3]; /* FEATURES */
114 bytes[2] = desc[4]; /* STATUS */
115 bytes[3] = desc[5]; /* SECTORS */
116 bytes[9] = desc[7]; /* LBA LOW */
117 bytes[8] = desc[9]; /* LBA MID */
118 bytes[7] = desc[11]; /* LBA HIGH */
119 bytes[10] = desc[12]; /* SELECT */
120 bytes[11] = desc[13]; /* ERROR */
125 * disk_identify_get_string:
126 * @identify: A block of IDENTIFY data
127 * @offset_words: Offset of the string to get, in words.
128 * @dest: Destination buffer for the string.
129 * @dest_len: Length of destination buffer, in bytes.
131 * Copies the ATA string from @identify located at @offset_words into @dest.
133 static void disk_identify_get_string (uint8_t identify[512],
134 unsigned int offset_words,
141 assert (identify != NULL);
142 assert (dest != NULL);
143 assert ((dest_len & 1) == 0);
145 while (dest_len > 0) {
146 c1 = ((uint16_t *) identify)[offset_words] >> 8;
147 c2 = ((uint16_t *) identify)[offset_words] & 0xff;
157 static void disk_identify_fixup_string (uint8_t identify[512],
158 unsigned int offset_words,
161 disk_identify_get_string(identify, offset_words,
162 (char *) identify + offset_words * 2, len);
165 static void disk_identify_fixup_uint16 (uint8_t identify[512], unsigned int offset_words)
169 p = (uint16_t *) identify;
170 p[offset_words] = le16toh (p[offset_words]);
175 * @udev: The libudev context.
176 * @fd: File descriptor for the block device.
177 * @out_identify: Return location for IDENTIFY data.
179 * Sends the IDENTIFY DEVICE command to the device represented by
180 * @fd. If successful, then the result will be copied into
183 * This routine is based on code from libatasmart, Copyright 2008
184 * Lennart Poettering, LGPL v2.1.
186 * Returns: 0 if the IDENTIFY data was successfully obtained,
187 * otherwise non-zero with errno set.
189 static int disk_identify (struct udev *udev,
191 uint8_t out_identify[512])
200 assert (out_identify != NULL);
204 memset (out_identify, '\0', 512);
206 if ((ret = fstat(fd, &st)) < 0)
209 if (!S_ISBLK(st.st_mode)) {
215 * do not confuse optical drive firmware with ATA commands
216 * some drives are reported to blank CD-RWs
218 if (ioctl(fd, CDROM_GET_CAPABILITY, NULL) >= 0) {
224 /* So, it's a block device. Let's make sure the ioctls work */
225 if ((ret = ioctl(fd, BLKGETSIZE64, &size)) < 0)
228 if (size <= 0 || size == (uint64_t) -1) {
233 memset(cmd, 0, sizeof(cmd));
235 ret = disk_command(fd,
236 0xEC, /* IDENTIFY DEVICE command */
237 SG_DXFER_FROM_DEV, cmd,
247 /* Check if IDENTIFY data is all NULs */
248 for (p = out_identify; p < (const uint8_t*) out_identify + len; p++) {
265 static void log_fn(struct udev *udev, int priority,
266 const char *file, int line, const char *fn,
267 const char *format, va_list args)
269 vsyslog(priority, format, args);
272 int main(int argc, char *argv[])
275 struct hd_driveid id;
276 uint8_t identify[512];
281 const char *node = NULL;
286 static const struct option options[] = {
287 { "export", no_argument, NULL, 'x' },
288 { "help", no_argument, NULL, 'h' },
296 udev_log_init("ata_id");
297 udev_set_log_fn(udev, log_fn);
302 option = getopt_long(argc, argv, "xh", options, NULL);
311 printf("Usage: ata_id [--export] [--help] <device>\n"
312 " --export print values as environment keys\n"
313 " --help print this help text\n\n");
322 err(udev, "no node specified\n");
327 fd = open(node, O_RDONLY|O_NONBLOCK);
329 err(udev, "unable to open '%s'\n", node);
334 if (disk_identify(udev, fd, identify) == 0) {
336 * fix up only the fields from the IDENTIFY data that we are going to
337 * use and copy it into the hd_driveid struct for convenience
339 disk_identify_fixup_string (identify, 10, 20); /* serial */
340 disk_identify_fixup_string (identify, 23, 6); /* fwrev */
341 disk_identify_fixup_string (identify, 27, 40); /* model */
342 disk_identify_fixup_uint16 (identify, 0); /* configuration */
343 disk_identify_fixup_uint16 (identify, 75); /* queue depth */
344 disk_identify_fixup_uint16 (identify, 75); /* SATA capabilities */
345 disk_identify_fixup_uint16 (identify, 82); /* command set supported */
346 disk_identify_fixup_uint16 (identify, 83); /* command set supported */
347 disk_identify_fixup_uint16 (identify, 84); /* command set supported */
348 disk_identify_fixup_uint16 (identify, 85); /* command set supported */
349 disk_identify_fixup_uint16 (identify, 86); /* command set supported */
350 disk_identify_fixup_uint16 (identify, 87); /* command set supported */
351 disk_identify_fixup_uint16 (identify, 89); /* time required for SECURITY ERASE UNIT */
352 disk_identify_fixup_uint16 (identify, 90); /* time required for enhanced SECURITY ERASE UNIT */
353 disk_identify_fixup_uint16 (identify, 91); /* current APM values */
354 disk_identify_fixup_uint16 (identify, 94); /* current AAM value */
355 disk_identify_fixup_uint16 (identify, 128); /* device lock function */
356 disk_identify_fixup_uint16 (identify, 217); /* nominal media rotation rate */
357 memcpy(&id, identify, sizeof id);
359 /* If this fails, then try HDIO_GET_IDENTITY */
360 if (ioctl(fd, HDIO_GET_IDENTITY, &id) != 0) {
361 if (errno == ENOTTY) {
362 info(udev, "HDIO_GET_IDENTITY unsupported for '%s'\n", node);
365 err(udev, "HDIO_GET_IDENTITY failed for '%s'\n", node);
372 memcpy (model, id.model, 40);
374 udev_util_encode_string(model, model_enc, sizeof(model_enc));
375 udev_util_replace_whitespace((char *) id.model, model, 40);
376 udev_util_replace_chars(model, NULL);
377 udev_util_replace_whitespace((char *) id.serial_no, serial, 20);
378 udev_util_replace_chars(serial, NULL);
379 udev_util_replace_whitespace((char *) id.fw_rev, revision, 8);
380 udev_util_replace_chars(revision, NULL);
383 /* Set this to convey the disk speaks the ATA protocol */
384 printf("ID_ATA=1\n");
386 if ((id.config >> 8) & 0x80) {
387 /* This is an ATAPI device */
388 switch ((id.config >> 8) & 0x1f) {
390 printf("ID_TYPE=cd\n");
393 printf("ID_TYPE=tape\n");
396 printf("ID_TYPE=cd\n");
399 printf("ID_TYPE=optical\n");
402 printf("ID_TYPE=generic\n");
406 printf("ID_TYPE=disk\n");
408 printf("ID_BUS=ata\n");
409 printf("ID_MODEL=%s\n", model);
410 printf("ID_MODEL_ENC=%s\n", model_enc);
411 printf("ID_REVISION=%s\n", revision);
412 printf("ID_SERIAL=%s_%s\n", model, serial);
413 printf("ID_SERIAL_SHORT=%s\n", serial);
415 if (id.command_set_1 & (1<<5)) {
416 printf ("ID_ATA_WRITE_CACHE=1\n");
417 printf ("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id.cfs_enable_1 & (1<<5)) ? 1 : 0);
419 if (id.command_set_1 & (1<<10)) {
420 printf("ID_ATA_FEATURE_SET_HPA=1\n");
421 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id.cfs_enable_1 & (1<<10)) ? 1 : 0);
424 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
425 * so it is easy to check whether the protected area is in use.
428 if (id.command_set_1 & (1<<3)) {
429 printf("ID_ATA_FEATURE_SET_PM=1\n");
430 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id.cfs_enable_1 & (1<<3)) ? 1 : 0);
432 if (id.command_set_1 & (1<<1)) {
433 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
434 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id.cfs_enable_1 & (1<<1)) ? 1 : 0);
435 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id.trseuc * 2);
436 if ((id.cfs_enable_1 & (1<<1))) /* enabled */ {
438 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
440 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
443 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id.trsEuc * 2);
445 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
447 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
449 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
451 if (id.command_set_1 & (1<<0)) {
452 printf("ID_ATA_FEATURE_SET_SMART=1\n");
453 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id.cfs_enable_1 & (1<<0)) ? 1 : 0);
455 if (id.command_set_2 & (1<<9)) {
456 printf("ID_ATA_FEATURE_SET_AAM=1\n");
457 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<9)) ? 1 : 0);
458 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id.acoustic >> 8);
459 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id.acoustic & 0xff);
461 if (id.command_set_2 & (1<<5)) {
462 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
463 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id.cfs_enable_2 & (1<<5)) ? 1 : 0);
465 if (id.command_set_2 & (1<<3)) {
466 printf("ID_ATA_FEATURE_SET_APM=1\n");
467 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<3)) ? 1 : 0);
468 if ((id.cfs_enable_2 & (1<<3)))
469 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id.CurAPMvalues & 0xff);
471 if (id.command_set_2 & (1<<0))
472 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
475 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
476 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
477 * the device does not claim compliance with the Serial ATA specification and words
478 * 76 through 79 are not valid and shall be ignored.
480 word = *((uint16_t *) identify + 76);
481 if (word != 0x0000 && word != 0xffff) {
482 printf("ID_ATA_SATA=1\n");
484 * If bit 2 of word 76 is set to one, then the device supports the Gen2
485 * signaling rate of 3.0 Gb/s (see SATA 2.6).
487 * If bit 1 of word 76 is set to one, then the device supports the Gen1
488 * signaling rate of 1.5 Gb/s (see SATA 2.6).
491 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
493 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
496 /* Word 217 indicates the nominal media rotation rate of the device */
497 word = *((uint16_t *) identify + 217);
498 if (word != 0x0000) {
499 if (word == 0x0001) {
500 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
501 } else if (word >= 0x0401 && word <= 0xfffe) {
502 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word);
507 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
508 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
509 * All other values are reserved.
511 word = *((uint16_t *) identify + 108);
512 if ((word & 0xf000) == 0x5000) {
515 wwwn = *((uint16_t *) identify + 108);
517 wwwn |= *((uint16_t *) identify + 109);
519 wwwn |= *((uint16_t *) identify + 110);
521 wwwn |= *((uint16_t *) identify + 111);
522 printf("ID_WWN=0x%llx\n", (unsigned long long int) wwwn);
523 /* ATA devices have no vendor extension */
524 printf("ID_WWN_WITH_EXTENSION=0x%llx\n", (unsigned long long int) wwwn);
527 if (serial[0] != '\0')
528 printf("%s_%s\n", model, serial);
530 printf("%s\n", model);