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-2010 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 <linux/bsg.h>
43 #include <arpa/inet.h>
46 #include "libudev-private.h"
48 #define COMMAND_TIMEOUT_MSEC (30 * 1000)
50 static int disk_scsi_inquiry_command(int fd,
54 struct sg_io_v4 io_v4;
60 * INQUIRY, see SPC-4 section 6.4
62 memset(cdb, 0, sizeof(cdb));
63 cdb[0] = 0x12; /* OPERATION CODE: INQUIRY */
64 cdb[3] = (buf_len >> 8); /* ALLOCATION LENGTH */
65 cdb[4] = (buf_len & 0xff);
67 memset(sense, 0, sizeof(sense));
69 memset(&io_v4, 0, sizeof(struct sg_io_v4));
71 io_v4.protocol = BSG_PROTOCOL_SCSI;
72 io_v4.subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD;
73 io_v4.request_len = sizeof (cdb);
74 io_v4.request = (uintptr_t) cdb;
75 io_v4.max_response_len = sizeof (sense);
76 io_v4.response = (uintptr_t) sense;
77 io_v4.din_xfer_len = buf_len;
78 io_v4.din_xferp = (uintptr_t) buf;
79 io_v4.timeout = COMMAND_TIMEOUT_MSEC;
81 ret = ioctl(fd, SG_IO, &io_v4);
83 /* could be that the driver doesn't do version 4, try version 3 */
84 if (errno == EINVAL) {
85 struct sg_io_hdr io_hdr;
87 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
88 io_hdr.interface_id = 'S';
89 io_hdr.cmdp = (unsigned char*) cdb;
90 io_hdr.cmd_len = sizeof (cdb);
92 io_hdr.dxfer_len = buf_len;
94 io_hdr.mx_sb_len = sizeof (sense);
95 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
96 io_hdr.timeout = COMMAND_TIMEOUT_MSEC;
98 ret = ioctl(fd, SG_IO, &io_hdr);
102 /* even if the ioctl succeeds, we need to check the return value */
103 if (!(io_hdr.status == 0 &&
104 io_hdr.host_status == 0 &&
105 io_hdr.driver_status == 0)) {
115 /* even if the ioctl succeeds, we need to check the return value */
116 if (!(io_v4.device_status == 0 &&
117 io_v4.transport_status == 0 &&
118 io_v4.driver_status == 0)) {
128 static int disk_identify_command(int fd,
132 struct sg_io_v4 io_v4;
135 uint8_t *desc = sense+8;
139 * ATA Pass-Through 12 byte command, as described in
141 * T10 04-262r8 ATA Command Pass-Through
143 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
145 memset(cdb, 0, sizeof(cdb));
146 cdb[0] = 0xa1; /* OPERATION CODE: 12 byte pass through */
147 cdb[1] = 4 << 1; /* PROTOCOL: PIO Data-in */
148 cdb[2] = 0x2e; /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
149 cdb[3] = 0; /* FEATURES */
150 cdb[4] = 1; /* SECTORS */
151 cdb[5] = 0; /* LBA LOW */
152 cdb[6] = 0; /* LBA MID */
153 cdb[7] = 0; /* LBA HIGH */
154 cdb[8] = 0 & 0x4F; /* SELECT */
155 cdb[9] = 0xEC; /* Command: ATA IDENTIFY DEVICE */;
156 memset(sense, 0, sizeof(sense));
158 memset(&io_v4, 0, sizeof(struct sg_io_v4));
160 io_v4.protocol = BSG_PROTOCOL_SCSI;
161 io_v4.subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD;
162 io_v4.request_len = sizeof (cdb);
163 io_v4.request = (uintptr_t) cdb;
164 io_v4.max_response_len = sizeof (sense);
165 io_v4.response = (uintptr_t) sense;
166 io_v4.din_xfer_len = buf_len;
167 io_v4.din_xferp = (uintptr_t) buf;
168 io_v4.timeout = COMMAND_TIMEOUT_MSEC;
170 ret = ioctl(fd, SG_IO, &io_v4);
172 /* could be that the driver doesn't do version 4, try version 3 */
173 if (errno == EINVAL) {
174 struct sg_io_hdr io_hdr;
176 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
177 io_hdr.interface_id = 'S';
178 io_hdr.cmdp = (unsigned char*) cdb;
179 io_hdr.cmd_len = sizeof (cdb);
181 io_hdr.dxfer_len = buf_len;
183 io_hdr.mx_sb_len = sizeof (sense);
184 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
185 io_hdr.timeout = COMMAND_TIMEOUT_MSEC;
187 ret = ioctl(fd, SG_IO, &io_hdr);
195 if (!(sense[0] == 0x72 && desc[0] == 0x9 && desc[1] == 0x0c)) {
206 * disk_identify_get_string:
207 * @identify: A block of IDENTIFY data
208 * @offset_words: Offset of the string to get, in words.
209 * @dest: Destination buffer for the string.
210 * @dest_len: Length of destination buffer, in bytes.
212 * Copies the ATA string from @identify located at @offset_words into @dest.
214 static void disk_identify_get_string (uint8_t identify[512],
215 unsigned int offset_words,
222 assert (identify != NULL);
223 assert (dest != NULL);
224 assert ((dest_len & 1) == 0);
226 while (dest_len > 0) {
227 c1 = ((uint16_t *) identify)[offset_words] >> 8;
228 c2 = ((uint16_t *) identify)[offset_words] & 0xff;
238 static void disk_identify_fixup_string (uint8_t identify[512],
239 unsigned int offset_words,
242 disk_identify_get_string(identify, offset_words,
243 (char *) identify + offset_words * 2, len);
246 static void disk_identify_fixup_uint16 (uint8_t identify[512], unsigned int offset_words)
250 p = (uint16_t *) identify;
251 p[offset_words] = le16toh (p[offset_words]);
256 * @udev: The libudev context.
257 * @fd: File descriptor for the block device.
258 * @out_identify: Return location for IDENTIFY data.
260 * Sends the IDENTIFY DEVICE command to the device represented by
261 * @fd. If successful, then the result will be copied into
264 * This routine is based on code from libatasmart, Copyright 2008
265 * Lennart Poettering, LGPL v2.1.
267 * Returns: 0 if the IDENTIFY data was successfully obtained,
268 * otherwise non-zero with errno set.
270 static int disk_identify (struct udev *udev,
272 uint8_t out_identify[512])
275 uint8_t inquiry_buf[36];
276 int peripheral_device_type;
280 assert (out_identify != NULL);
283 memset (out_identify, '\0', 512);
285 /* If we were to use ATA PASS_THROUGH (12) on an ATAPI device
286 * we could accidentally blank media. This is because MMC's BLANK
287 * command has the same op-code (0x61).
289 * To prevent this from happening we bail out if the device
290 * isn't a Direct Access Block Device, e.g. SCSI type 0x00
291 * (CD/DVD devices are type 0x05). So we send a SCSI INQUIRY
292 * command first... libata is handling this via its SCSI
295 * This also ensures that we're actually dealing with a device
296 * that understands SCSI commands.
298 * (Yes, it is a bit perverse that we're tunneling the ATA
299 * command through SCSI and relying on the ATA driver
300 * emulating SCSI well-enough...)
302 * (See commit 160b069c25690bfb0c785994c7c3710289179107 for
303 * the original bug-fix and see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=556635
304 * for the original bug-report.)
306 ret = disk_scsi_inquiry_command (fd, inquiry_buf, sizeof (inquiry_buf));
310 /* SPC-4, section 6.4.2: Standard INQUIRY data */
311 peripheral_device_type = inquiry_buf[0] & 0x1f;
312 if (peripheral_device_type != 0x00) {
318 /* OK, now issue the IDENTIFY DEVICE command */
319 ret = disk_identify_command(fd, out_identify, 512);
323 /* Check if IDENTIFY data is all NUL bytes - if so, bail */
325 for (n = 0; n < 512; n++) {
326 if (out_identify[n] != '\0') {
342 static void log_fn(struct udev *udev, int priority,
343 const char *file, int line, const char *fn,
344 const char *format, va_list args)
346 vsyslog(priority, format, args);
349 int main(int argc, char *argv[])
352 struct hd_driveid id;
353 uint8_t identify[512];
358 const char *node = NULL;
363 static const struct option options[] = {
364 { "export", no_argument, NULL, 'x' },
365 { "help", no_argument, NULL, 'h' },
373 udev_log_init("ata_id");
374 udev_set_log_fn(udev, log_fn);
379 option = getopt_long(argc, argv, "xh", options, NULL);
388 printf("Usage: ata_id [--export] [--help] <device>\n"
389 " --export print values as environment keys\n"
390 " --help print this help text\n\n");
399 err(udev, "no node specified\n");
404 fd = open(node, O_RDONLY|O_NONBLOCK);
406 err(udev, "unable to open '%s'\n", node);
411 if (disk_identify(udev, fd, identify) == 0) {
413 * fix up only the fields from the IDENTIFY data that we are going to
414 * use and copy it into the hd_driveid struct for convenience
416 disk_identify_fixup_string (identify, 10, 20); /* serial */
417 disk_identify_fixup_string (identify, 23, 6); /* fwrev */
418 disk_identify_fixup_string (identify, 27, 40); /* model */
419 disk_identify_fixup_uint16 (identify, 0); /* configuration */
420 disk_identify_fixup_uint16 (identify, 75); /* queue depth */
421 disk_identify_fixup_uint16 (identify, 75); /* SATA capabilities */
422 disk_identify_fixup_uint16 (identify, 82); /* command set supported */
423 disk_identify_fixup_uint16 (identify, 83); /* command set supported */
424 disk_identify_fixup_uint16 (identify, 84); /* command set supported */
425 disk_identify_fixup_uint16 (identify, 85); /* command set supported */
426 disk_identify_fixup_uint16 (identify, 86); /* command set supported */
427 disk_identify_fixup_uint16 (identify, 87); /* command set supported */
428 disk_identify_fixup_uint16 (identify, 89); /* time required for SECURITY ERASE UNIT */
429 disk_identify_fixup_uint16 (identify, 90); /* time required for enhanced SECURITY ERASE UNIT */
430 disk_identify_fixup_uint16 (identify, 91); /* current APM values */
431 disk_identify_fixup_uint16 (identify, 94); /* current AAM value */
432 disk_identify_fixup_uint16 (identify, 128); /* device lock function */
433 disk_identify_fixup_uint16 (identify, 217); /* nominal media rotation rate */
434 memcpy(&id, identify, sizeof id);
436 /* If this fails, then try HDIO_GET_IDENTITY */
437 if (ioctl(fd, HDIO_GET_IDENTITY, &id) != 0) {
438 if (errno == ENOTTY) {
439 info(udev, "HDIO_GET_IDENTITY unsupported for '%s'\n", node);
442 err(udev, "HDIO_GET_IDENTITY failed for '%s'\n", node);
449 memcpy (model, id.model, 40);
451 udev_util_encode_string(model, model_enc, sizeof(model_enc));
452 udev_util_replace_whitespace((char *) id.model, model, 40);
453 udev_util_replace_chars(model, NULL);
454 udev_util_replace_whitespace((char *) id.serial_no, serial, 20);
455 udev_util_replace_chars(serial, NULL);
456 udev_util_replace_whitespace((char *) id.fw_rev, revision, 8);
457 udev_util_replace_chars(revision, NULL);
460 /* Set this to convey the disk speaks the ATA protocol */
461 printf("ID_ATA=1\n");
463 if ((id.config >> 8) & 0x80) {
464 /* This is an ATAPI device */
465 switch ((id.config >> 8) & 0x1f) {
467 printf("ID_TYPE=cd\n");
470 printf("ID_TYPE=tape\n");
473 printf("ID_TYPE=cd\n");
476 printf("ID_TYPE=optical\n");
479 printf("ID_TYPE=generic\n");
483 printf("ID_TYPE=disk\n");
485 printf("ID_BUS=ata\n");
486 printf("ID_MODEL=%s\n", model);
487 printf("ID_MODEL_ENC=%s\n", model_enc);
488 printf("ID_REVISION=%s\n", revision);
489 printf("ID_SERIAL=%s_%s\n", model, serial);
490 printf("ID_SERIAL_SHORT=%s\n", serial);
492 if (id.command_set_1 & (1<<5)) {
493 printf ("ID_ATA_WRITE_CACHE=1\n");
494 printf ("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id.cfs_enable_1 & (1<<5)) ? 1 : 0);
496 if (id.command_set_1 & (1<<10)) {
497 printf("ID_ATA_FEATURE_SET_HPA=1\n");
498 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id.cfs_enable_1 & (1<<10)) ? 1 : 0);
501 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
502 * so it is easy to check whether the protected area is in use.
505 if (id.command_set_1 & (1<<3)) {
506 printf("ID_ATA_FEATURE_SET_PM=1\n");
507 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id.cfs_enable_1 & (1<<3)) ? 1 : 0);
509 if (id.command_set_1 & (1<<1)) {
510 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
511 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id.cfs_enable_1 & (1<<1)) ? 1 : 0);
512 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id.trseuc * 2);
513 if ((id.cfs_enable_1 & (1<<1))) /* enabled */ {
515 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
517 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
520 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id.trsEuc * 2);
522 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
524 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
526 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
528 if (id.command_set_1 & (1<<0)) {
529 printf("ID_ATA_FEATURE_SET_SMART=1\n");
530 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id.cfs_enable_1 & (1<<0)) ? 1 : 0);
532 if (id.command_set_2 & (1<<9)) {
533 printf("ID_ATA_FEATURE_SET_AAM=1\n");
534 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<9)) ? 1 : 0);
535 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id.acoustic >> 8);
536 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id.acoustic & 0xff);
538 if (id.command_set_2 & (1<<5)) {
539 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
540 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id.cfs_enable_2 & (1<<5)) ? 1 : 0);
542 if (id.command_set_2 & (1<<3)) {
543 printf("ID_ATA_FEATURE_SET_APM=1\n");
544 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<3)) ? 1 : 0);
545 if ((id.cfs_enable_2 & (1<<3)))
546 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id.CurAPMvalues & 0xff);
548 if (id.command_set_2 & (1<<0))
549 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
552 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
553 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
554 * the device does not claim compliance with the Serial ATA specification and words
555 * 76 through 79 are not valid and shall be ignored.
557 word = *((uint16_t *) identify + 76);
558 if (word != 0x0000 && word != 0xffff) {
559 printf("ID_ATA_SATA=1\n");
561 * If bit 2 of word 76 is set to one, then the device supports the Gen2
562 * signaling rate of 3.0 Gb/s (see SATA 2.6).
564 * If bit 1 of word 76 is set to one, then the device supports the Gen1
565 * signaling rate of 1.5 Gb/s (see SATA 2.6).
568 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
570 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
573 /* Word 217 indicates the nominal media rotation rate of the device */
574 word = *((uint16_t *) identify + 217);
575 if (word != 0x0000) {
576 if (word == 0x0001) {
577 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
578 } else if (word >= 0x0401 && word <= 0xfffe) {
579 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word);
584 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
585 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
586 * All other values are reserved.
588 word = *((uint16_t *) identify + 108);
589 if ((word & 0xf000) == 0x5000) {
592 wwwn = *((uint16_t *) identify + 108);
594 wwwn |= *((uint16_t *) identify + 109);
596 wwwn |= *((uint16_t *) identify + 110);
598 wwwn |= *((uint16_t *) identify + 111);
599 printf("ID_WWN=0x%llx\n", (unsigned long long int) wwwn);
600 /* ATA devices have no vendor extension */
601 printf("ID_WWN_WITH_EXTENSION=0x%llx\n", (unsigned long long int) wwwn);
604 if (serial[0] != '\0')
605 printf("%s_%s\n", model, serial);
607 printf("%s\n", model);