2 * ata_id - reads product/serial number from ATA drives
4 * Copyright (C) 2005-2008 Kay Sievers <kay@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/>.
31 #include <scsi/scsi.h>
33 #include <scsi/scsi_ioctl.h>
34 #include <sys/ioctl.h>
35 #include <sys/types.h>
37 #include <linux/hdreg.h>
38 #include <linux/bsg.h>
41 #include "libudev-private.h"
42 #include "udev-util.h"
45 #define COMMAND_TIMEOUT_MSEC (30 * 1000)
47 static int disk_scsi_inquiry_command(int fd,
53 * INQUIRY, see SPC-4 section 6.4
55 [0] = 0x12, /* OPERATION CODE: INQUIRY */
56 [3] = (buf_len >> 8), /* ALLOCATION LENGTH */
57 [4] = (buf_len & 0xff),
59 uint8_t sense[32] = {};
60 struct sg_io_v4 io_v4 = {
62 .protocol = BSG_PROTOCOL_SCSI,
63 .subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD,
64 .request_len = sizeof(cdb),
65 .request = (uintptr_t) cdb,
66 .max_response_len = sizeof(sense),
67 .response = (uintptr_t) sense,
68 .din_xfer_len = buf_len,
69 .din_xferp = (uintptr_t) buf,
70 .timeout = COMMAND_TIMEOUT_MSEC,
74 ret = ioctl(fd, SG_IO, &io_v4);
76 /* could be that the driver doesn't do version 4, try version 3 */
77 if (errno == EINVAL) {
78 struct sg_io_hdr io_hdr = {
80 .cmdp = (unsigned char*) cdb,
81 .cmd_len = sizeof (cdb),
85 .mx_sb_len = sizeof(sense),
86 .dxfer_direction = SG_DXFER_FROM_DEV,
87 .timeout = COMMAND_TIMEOUT_MSEC,
90 ret = ioctl(fd, SG_IO, &io_hdr);
94 /* even if the ioctl succeeds, we need to check the return value */
95 if (!(io_hdr.status == 0 &&
96 io_hdr.host_status == 0 &&
97 io_hdr.driver_status == 0)) {
105 /* even if the ioctl succeeds, we need to check the return value */
106 if (!(io_v4.device_status == 0 &&
107 io_v4.transport_status == 0 &&
108 io_v4.driver_status == 0)) {
116 static int disk_identify_command(int fd,
122 * ATA Pass-Through 12 byte command, as described in
124 * T10 04-262r8 ATA Command Pass-Through
126 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
128 [0] = 0xa1, /* OPERATION CODE: 12 byte pass through */
129 [1] = 4 << 1, /* PROTOCOL: PIO Data-in */
130 [2] = 0x2e, /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
131 [3] = 0, /* FEATURES */
132 [4] = 1, /* SECTORS */
133 [5] = 0, /* LBA LOW */
134 [6] = 0, /* LBA MID */
135 [7] = 0, /* LBA HIGH */
136 [8] = 0 & 0x4F, /* SELECT */
137 [9] = 0xEC, /* Command: ATA IDENTIFY DEVICE */
139 uint8_t sense[32] = {};
140 uint8_t *desc = sense + 8;
141 struct sg_io_v4 io_v4 = {
143 .protocol = BSG_PROTOCOL_SCSI,
144 .subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD,
145 .request_len = sizeof(cdb),
146 .request = (uintptr_t) cdb,
147 .max_response_len = sizeof(sense),
148 .response = (uintptr_t) sense,
149 .din_xfer_len = buf_len,
150 .din_xferp = (uintptr_t) buf,
151 .timeout = COMMAND_TIMEOUT_MSEC,
155 ret = ioctl(fd, SG_IO, &io_v4);
157 /* could be that the driver doesn't do version 4, try version 3 */
158 if (errno == EINVAL) {
159 struct sg_io_hdr io_hdr = {
161 .cmdp = (unsigned char*) cdb,
162 .cmd_len = sizeof (cdb),
164 .dxfer_len = buf_len,
166 .mx_sb_len = sizeof (sense),
167 .dxfer_direction = SG_DXFER_FROM_DEV,
168 .timeout = COMMAND_TIMEOUT_MSEC,
171 ret = ioctl(fd, SG_IO, &io_hdr);
178 if (!(sense[0] == 0x72 && desc[0] == 0x9 && desc[1] == 0x0c)) {
186 static int disk_identify_packet_device_command(int fd,
192 * ATA Pass-Through 16 byte command, as described in
194 * T10 04-262r8 ATA Command Pass-Through
196 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
198 [0] = 0x85, /* OPERATION CODE: 16 byte pass through */
199 [1] = 4 << 1, /* PROTOCOL: PIO Data-in */
200 [2] = 0x2e, /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
201 [3] = 0, /* FEATURES */
202 [4] = 0, /* FEATURES */
203 [5] = 0, /* SECTORS */
204 [6] = 1, /* SECTORS */
205 [7] = 0, /* LBA LOW */
206 [8] = 0, /* LBA LOW */
207 [9] = 0, /* LBA MID */
208 [10] = 0, /* LBA MID */
209 [11] = 0, /* LBA HIGH */
210 [12] = 0, /* LBA HIGH */
211 [13] = 0, /* DEVICE */
212 [14] = 0xA1, /* Command: ATA IDENTIFY PACKET DEVICE */
213 [15] = 0, /* CONTROL */
215 uint8_t sense[32] = {};
216 uint8_t *desc = sense + 8;
217 struct sg_io_v4 io_v4 = {
219 .protocol = BSG_PROTOCOL_SCSI,
220 .subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD,
221 .request_len = sizeof (cdb),
222 .request = (uintptr_t) cdb,
223 .max_response_len = sizeof (sense),
224 .response = (uintptr_t) sense,
225 .din_xfer_len = buf_len,
226 .din_xferp = (uintptr_t) buf,
227 .timeout = COMMAND_TIMEOUT_MSEC,
231 ret = ioctl(fd, SG_IO, &io_v4);
233 /* could be that the driver doesn't do version 4, try version 3 */
234 if (errno == EINVAL) {
235 struct sg_io_hdr io_hdr = {
237 .cmdp = (unsigned char*) cdb,
238 .cmd_len = sizeof (cdb),
240 .dxfer_len = buf_len,
242 .mx_sb_len = sizeof (sense),
243 .dxfer_direction = SG_DXFER_FROM_DEV,
244 .timeout = COMMAND_TIMEOUT_MSEC,
247 ret = ioctl(fd, SG_IO, &io_hdr);
254 if (!(sense[0] == 0x72 && desc[0] == 0x9 && desc[1] == 0x0c)) {
263 * disk_identify_get_string:
264 * @identify: A block of IDENTIFY data
265 * @offset_words: Offset of the string to get, in words.
266 * @dest: Destination buffer for the string.
267 * @dest_len: Length of destination buffer, in bytes.
269 * Copies the ATA string from @identify located at @offset_words into @dest.
271 static void disk_identify_get_string(uint8_t identify[512],
272 unsigned int offset_words,
279 while (dest_len > 0) {
280 c1 = identify[offset_words * 2 + 1];
281 c2 = identify[offset_words * 2];
291 static void disk_identify_fixup_string(uint8_t identify[512],
292 unsigned int offset_words,
295 disk_identify_get_string(identify, offset_words,
296 (char *) identify + offset_words * 2, len);
299 static void disk_identify_fixup_uint16 (uint8_t identify[512], unsigned int offset_words)
303 p = (uint16_t *) identify;
304 p[offset_words] = le16toh (p[offset_words]);
309 * @udev: The libudev context.
310 * @fd: File descriptor for the block device.
311 * @out_identify: Return location for IDENTIFY data.
312 * @out_is_packet_device: Return location for whether returned data is from a IDENTIFY PACKET DEVICE.
314 * Sends the IDENTIFY DEVICE or IDENTIFY PACKET DEVICE command to the
315 * device represented by @fd. If successful, then the result will be
316 * copied into @out_identify and @out_is_packet_device.
318 * This routine is based on code from libatasmart, Copyright 2008
319 * Lennart Poettering, LGPL v2.1.
321 * Returns: 0 if the data was successfully obtained, otherwise
322 * non-zero with errno set.
324 static int disk_identify(struct udev *udev,
326 uint8_t out_identify[512],
327 int *out_is_packet_device)
330 uint8_t inquiry_buf[36];
331 int peripheral_device_type;
334 int is_packet_device = 0;
337 memzero(out_identify, 512);
339 /* If we were to use ATA PASS_THROUGH (12) on an ATAPI device
340 * we could accidentally blank media. This is because MMC's BLANK
341 * command has the same op-code (0x61).
343 * To prevent this from happening we bail out if the device
344 * isn't a Direct Access Block Device, e.g. SCSI type 0x00
345 * (CD/DVD devices are type 0x05). So we send a SCSI INQUIRY
346 * command first... libata is handling this via its SCSI
349 * This also ensures that we're actually dealing with a device
350 * that understands SCSI commands.
352 * (Yes, it is a bit perverse that we're tunneling the ATA
353 * command through SCSI and relying on the ATA driver
354 * emulating SCSI well-enough...)
356 * (See commit 160b069c25690bfb0c785994c7c3710289179107 for
357 * the original bug-fix and see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=556635
358 * for the original bug-report.)
360 ret = disk_scsi_inquiry_command (fd, inquiry_buf, sizeof (inquiry_buf));
364 /* SPC-4, section 6.4.2: Standard INQUIRY data */
365 peripheral_device_type = inquiry_buf[0] & 0x1f;
366 if (peripheral_device_type == 0x05)
368 is_packet_device = 1;
369 ret = disk_identify_packet_device_command(fd, out_identify, 512);
370 goto check_nul_bytes;
372 if (peripheral_device_type != 0x00) {
378 /* OK, now issue the IDENTIFY DEVICE command */
379 ret = disk_identify_command(fd, out_identify, 512);
384 /* Check if IDENTIFY data is all NUL bytes - if so, bail */
386 for (n = 0; n < 512; n++) {
387 if (out_identify[n] != '\0') {
400 if (out_is_packet_device != NULL)
401 *out_is_packet_device = is_packet_device;
405 int main(int argc, char *argv[])
407 _cleanup_udev_unref_ struct udev *udev = NULL;
408 struct hd_driveid id;
418 const char *node = NULL;
420 _cleanup_close_ int fd = -1;
422 int is_packet_device = 0;
423 static const struct option options[] = {
424 { "export", no_argument, NULL, 'x' },
425 { "help", no_argument, NULL, 'h' },
429 log_parse_environment();
439 option = getopt_long(argc, argv, "xh", options, NULL);
448 printf("Usage: ata_id [--export] [--help] <device>\n"
449 " -x,--export print values as environment keys\n"
450 " -h,--help print this help text\n\n");
457 log_error("no node specified");
461 fd = open(node, O_RDONLY|O_NONBLOCK|O_CLOEXEC);
463 log_error("unable to open '%s'", node);
467 if (disk_identify(udev, fd, identify.byte, &is_packet_device) == 0) {
469 * fix up only the fields from the IDENTIFY data that we are going to
470 * use and copy it into the hd_driveid struct for convenience
472 disk_identify_fixup_string(identify.byte, 10, 20); /* serial */
473 disk_identify_fixup_string(identify.byte, 23, 8); /* fwrev */
474 disk_identify_fixup_string(identify.byte, 27, 40); /* model */
475 disk_identify_fixup_uint16(identify.byte, 0); /* configuration */
476 disk_identify_fixup_uint16(identify.byte, 75); /* queue depth */
477 disk_identify_fixup_uint16(identify.byte, 75); /* SATA capabilities */
478 disk_identify_fixup_uint16(identify.byte, 82); /* command set supported */
479 disk_identify_fixup_uint16(identify.byte, 83); /* command set supported */
480 disk_identify_fixup_uint16(identify.byte, 84); /* command set supported */
481 disk_identify_fixup_uint16(identify.byte, 85); /* command set supported */
482 disk_identify_fixup_uint16(identify.byte, 86); /* command set supported */
483 disk_identify_fixup_uint16(identify.byte, 87); /* command set supported */
484 disk_identify_fixup_uint16(identify.byte, 89); /* time required for SECURITY ERASE UNIT */
485 disk_identify_fixup_uint16(identify.byte, 90); /* time required for enhanced SECURITY ERASE UNIT */
486 disk_identify_fixup_uint16(identify.byte, 91); /* current APM values */
487 disk_identify_fixup_uint16(identify.byte, 94); /* current AAM value */
488 disk_identify_fixup_uint16(identify.byte, 128); /* device lock function */
489 disk_identify_fixup_uint16(identify.byte, 217); /* nominal media rotation rate */
490 memcpy(&id, identify.byte, sizeof id);
492 /* If this fails, then try HDIO_GET_IDENTITY */
493 if (ioctl(fd, HDIO_GET_IDENTITY, &id) != 0) {
494 log_debug_errno(errno, "HDIO_GET_IDENTITY failed for '%s': %m", node);
499 memcpy (model, id.model, 40);
501 udev_util_encode_string(model, model_enc, sizeof(model_enc));
502 util_replace_whitespace((char *) id.model, model, 40);
503 util_replace_chars(model, NULL);
504 util_replace_whitespace((char *) id.serial_no, serial, 20);
505 util_replace_chars(serial, NULL);
506 util_replace_whitespace((char *) id.fw_rev, revision, 8);
507 util_replace_chars(revision, NULL);
510 /* Set this to convey the disk speaks the ATA protocol */
511 printf("ID_ATA=1\n");
513 if ((id.config >> 8) & 0x80) {
514 /* This is an ATAPI device */
515 switch ((id.config >> 8) & 0x1f) {
517 printf("ID_TYPE=cd\n");
520 printf("ID_TYPE=tape\n");
523 printf("ID_TYPE=cd\n");
526 printf("ID_TYPE=optical\n");
529 printf("ID_TYPE=generic\n");
533 printf("ID_TYPE=disk\n");
535 printf("ID_BUS=ata\n");
536 printf("ID_MODEL=%s\n", model);
537 printf("ID_MODEL_ENC=%s\n", model_enc);
538 printf("ID_REVISION=%s\n", revision);
539 if (serial[0] != '\0') {
540 printf("ID_SERIAL=%s_%s\n", model, serial);
541 printf("ID_SERIAL_SHORT=%s\n", serial);
543 printf("ID_SERIAL=%s\n", model);
546 if (id.command_set_1 & (1<<5)) {
547 printf("ID_ATA_WRITE_CACHE=1\n");
548 printf("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id.cfs_enable_1 & (1<<5)) ? 1 : 0);
550 if (id.command_set_1 & (1<<10)) {
551 printf("ID_ATA_FEATURE_SET_HPA=1\n");
552 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id.cfs_enable_1 & (1<<10)) ? 1 : 0);
555 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
556 * so it is easy to check whether the protected area is in use.
559 if (id.command_set_1 & (1<<3)) {
560 printf("ID_ATA_FEATURE_SET_PM=1\n");
561 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id.cfs_enable_1 & (1<<3)) ? 1 : 0);
563 if (id.command_set_1 & (1<<1)) {
564 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
565 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id.cfs_enable_1 & (1<<1)) ? 1 : 0);
566 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id.trseuc * 2);
567 if ((id.cfs_enable_1 & (1<<1))) /* enabled */ {
569 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
571 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
574 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id.trsEuc * 2);
576 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
578 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
580 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
582 if (id.command_set_1 & (1<<0)) {
583 printf("ID_ATA_FEATURE_SET_SMART=1\n");
584 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id.cfs_enable_1 & (1<<0)) ? 1 : 0);
586 if (id.command_set_2 & (1<<9)) {
587 printf("ID_ATA_FEATURE_SET_AAM=1\n");
588 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<9)) ? 1 : 0);
589 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id.acoustic >> 8);
590 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id.acoustic & 0xff);
592 if (id.command_set_2 & (1<<5)) {
593 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
594 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id.cfs_enable_2 & (1<<5)) ? 1 : 0);
596 if (id.command_set_2 & (1<<3)) {
597 printf("ID_ATA_FEATURE_SET_APM=1\n");
598 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<3)) ? 1 : 0);
599 if ((id.cfs_enable_2 & (1<<3)))
600 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id.CurAPMvalues & 0xff);
602 if (id.command_set_2 & (1<<0))
603 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
606 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
607 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
608 * the device does not claim compliance with the Serial ATA specification and words
609 * 76 through 79 are not valid and shall be ignored.
612 word = identify.wyde[76];
613 if (word != 0x0000 && word != 0xffff) {
614 printf("ID_ATA_SATA=1\n");
616 * If bit 2 of word 76 is set to one, then the device supports the Gen2
617 * signaling rate of 3.0 Gb/s (see SATA 2.6).
619 * If bit 1 of word 76 is set to one, then the device supports the Gen1
620 * signaling rate of 1.5 Gb/s (see SATA 2.6).
623 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
625 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
628 /* Word 217 indicates the nominal media rotation rate of the device */
629 word = identify.wyde[217];
631 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
632 else if (word >= 0x0401 && word <= 0xfffe)
633 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word);
636 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
637 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
638 * All other values are reserved.
640 word = identify.wyde[108];
641 if ((word & 0xf000) == 0x5000)
642 printf("ID_WWN=0x%1$"PRIu64"x\n"
643 "ID_WWN_WITH_EXTENSION=0x%1$"PRIu64"x\n",
644 identify.octa[108/4]);
646 /* from Linux's include/linux/ata.h */
647 if (identify.wyde[0] == 0x848a ||
648 identify.wyde[0] == 0x844a ||
649 (identify.wyde[83] & 0xc004) == 0x4004)
650 printf("ID_ATA_CFA=1\n");
652 if (serial[0] != '\0')
653 printf("%s_%s\n", model, serial);
655 printf("%s\n", model);