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/types.h>
38 #include <linux/hdreg.h>
40 #include <linux/cdrom.h>
41 #include <linux/bsg.h>
42 #include <arpa/inet.h>
45 #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)) {
205 static int disk_identify_packet_device_command(int fd,
209 struct sg_io_v4 io_v4;
212 uint8_t *desc = sense+8;
216 * ATA Pass-Through 16 byte command, as described in
218 * T10 04-262r8 ATA Command Pass-Through
220 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
222 memset(cdb, 0, sizeof(cdb));
223 cdb[0] = 0x85; /* OPERATION CODE: 16 byte pass through */
224 cdb[1] = 4 << 1; /* PROTOCOL: PIO Data-in */
225 cdb[2] = 0x2e; /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
226 cdb[3] = 0; /* FEATURES */
227 cdb[4] = 0; /* FEATURES */
228 cdb[5] = 0; /* SECTORS */
229 cdb[6] = 1; /* SECTORS */
230 cdb[7] = 0; /* LBA LOW */
231 cdb[8] = 0; /* LBA LOW */
232 cdb[9] = 0; /* LBA MID */
233 cdb[10] = 0; /* LBA MID */
234 cdb[11] = 0; /* LBA HIGH */
235 cdb[12] = 0; /* LBA HIGH */
236 cdb[13] = 0; /* DEVICE */
237 cdb[14] = 0xA1; /* Command: ATA IDENTIFY PACKET DEVICE */;
238 cdb[15] = 0; /* CONTROL */
239 memset(sense, 0, sizeof(sense));
241 memset(&io_v4, 0, sizeof(struct sg_io_v4));
243 io_v4.protocol = BSG_PROTOCOL_SCSI;
244 io_v4.subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD;
245 io_v4.request_len = sizeof (cdb);
246 io_v4.request = (uintptr_t) cdb;
247 io_v4.max_response_len = sizeof (sense);
248 io_v4.response = (uintptr_t) sense;
249 io_v4.din_xfer_len = buf_len;
250 io_v4.din_xferp = (uintptr_t) buf;
251 io_v4.timeout = COMMAND_TIMEOUT_MSEC;
253 ret = ioctl(fd, SG_IO, &io_v4);
255 /* could be that the driver doesn't do version 4, try version 3 */
256 if (errno == EINVAL) {
257 struct sg_io_hdr io_hdr;
259 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
260 io_hdr.interface_id = 'S';
261 io_hdr.cmdp = (unsigned char*) cdb;
262 io_hdr.cmd_len = sizeof (cdb);
264 io_hdr.dxfer_len = buf_len;
266 io_hdr.mx_sb_len = sizeof (sense);
267 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
268 io_hdr.timeout = COMMAND_TIMEOUT_MSEC;
270 ret = ioctl(fd, SG_IO, &io_hdr);
278 if (!(sense[0] == 0x72 && desc[0] == 0x9 && desc[1] == 0x0c)) {
289 * disk_identify_get_string:
290 * @identify: A block of IDENTIFY data
291 * @offset_words: Offset of the string to get, in words.
292 * @dest: Destination buffer for the string.
293 * @dest_len: Length of destination buffer, in bytes.
295 * Copies the ATA string from @identify located at @offset_words into @dest.
297 static void disk_identify_get_string(uint8_t identify[512],
298 unsigned int offset_words,
305 while (dest_len > 0) {
306 c1 = identify[offset_words * 2 + 1];
307 c2 = identify[offset_words * 2];
317 static void disk_identify_fixup_string(uint8_t identify[512],
318 unsigned int offset_words,
321 disk_identify_get_string(identify, offset_words,
322 (char *) identify + offset_words * 2, len);
325 static void disk_identify_fixup_uint16 (uint8_t identify[512], unsigned int offset_words)
329 p = (uint16_t *) identify;
330 p[offset_words] = le16toh (p[offset_words]);
335 * @udev: The libudev context.
336 * @fd: File descriptor for the block device.
337 * @out_identify: Return location for IDENTIFY data.
338 * @out_is_packet_device: Return location for whether returned data is from a IDENTIFY PACKET DEVICE.
340 * Sends the IDENTIFY DEVICE or IDENTIFY PACKET DEVICE command to the
341 * device represented by @fd. If successful, then the result will be
342 * copied into @out_identify and @out_is_packet_device.
344 * This routine is based on code from libatasmart, Copyright 2008
345 * Lennart Poettering, LGPL v2.1.
347 * Returns: 0 if the data was successfully obtained, otherwise
348 * non-zero with errno set.
350 static int disk_identify(struct udev *udev,
352 uint8_t out_identify[512],
353 int *out_is_packet_device)
356 uint8_t inquiry_buf[36];
357 int peripheral_device_type;
360 int is_packet_device;
363 memset(out_identify, '\0', 512);
364 is_packet_device = 0;
366 /* If we were to use ATA PASS_THROUGH (12) on an ATAPI device
367 * we could accidentally blank media. This is because MMC's BLANK
368 * command has the same op-code (0x61).
370 * To prevent this from happening we bail out if the device
371 * isn't a Direct Access Block Device, e.g. SCSI type 0x00
372 * (CD/DVD devices are type 0x05). So we send a SCSI INQUIRY
373 * command first... libata is handling this via its SCSI
376 * This also ensures that we're actually dealing with a device
377 * that understands SCSI commands.
379 * (Yes, it is a bit perverse that we're tunneling the ATA
380 * command through SCSI and relying on the ATA driver
381 * emulating SCSI well-enough...)
383 * (See commit 160b069c25690bfb0c785994c7c3710289179107 for
384 * the original bug-fix and see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=556635
385 * for the original bug-report.)
387 ret = disk_scsi_inquiry_command (fd, inquiry_buf, sizeof (inquiry_buf));
391 /* SPC-4, section 6.4.2: Standard INQUIRY data */
392 peripheral_device_type = inquiry_buf[0] & 0x1f;
393 if (peripheral_device_type == 0x05)
395 is_packet_device = 1;
396 ret = disk_identify_packet_device_command(fd, out_identify, 512);
397 goto check_nul_bytes;
399 if (peripheral_device_type != 0x00) {
405 /* OK, now issue the IDENTIFY DEVICE command */
406 ret = disk_identify_command(fd, out_identify, 512);
411 /* Check if IDENTIFY data is all NUL bytes - if so, bail */
413 for (n = 0; n < 512; n++) {
414 if (out_identify[n] != '\0') {
427 if (out_is_packet_device != NULL)
428 *out_is_packet_device = is_packet_device;
432 static void log_fn(struct udev *udev, int priority,
433 const char *file, int line, const char *fn,
434 const char *format, va_list args)
436 vsyslog(priority, format, args);
439 int main(int argc, char *argv[])
442 struct hd_driveid id;
443 uint8_t identify[512];
444 uint16_t *identify_words;
449 const char *node = NULL;
454 int is_packet_device = 0;
455 static const struct option options[] = {
456 { "export", no_argument, NULL, 'x' },
457 { "help", no_argument, NULL, 'h' },
466 udev_set_log_fn(udev, log_fn);
471 option = getopt_long(argc, argv, "xh", options, NULL);
480 printf("Usage: ata_id [--export] [--help] <device>\n"
481 " --export print values as environment keys\n"
482 " --help print this help text\n\n");
489 log_error("no node specified\n");
494 fd = open(node, O_RDONLY|O_NONBLOCK);
496 log_error("unable to open '%s'\n", node);
501 if (disk_identify(udev, fd, identify, &is_packet_device) == 0) {
503 * fix up only the fields from the IDENTIFY data that we are going to
504 * use and copy it into the hd_driveid struct for convenience
506 disk_identify_fixup_string(identify, 10, 20); /* serial */
507 disk_identify_fixup_string(identify, 23, 8); /* fwrev */
508 disk_identify_fixup_string(identify, 27, 40); /* model */
509 disk_identify_fixup_uint16(identify, 0); /* configuration */
510 disk_identify_fixup_uint16(identify, 75); /* queue depth */
511 disk_identify_fixup_uint16(identify, 75); /* SATA capabilities */
512 disk_identify_fixup_uint16(identify, 82); /* command set supported */
513 disk_identify_fixup_uint16(identify, 83); /* command set supported */
514 disk_identify_fixup_uint16(identify, 84); /* command set supported */
515 disk_identify_fixup_uint16(identify, 85); /* command set supported */
516 disk_identify_fixup_uint16(identify, 86); /* command set supported */
517 disk_identify_fixup_uint16(identify, 87); /* command set supported */
518 disk_identify_fixup_uint16(identify, 89); /* time required for SECURITY ERASE UNIT */
519 disk_identify_fixup_uint16(identify, 90); /* time required for enhanced SECURITY ERASE UNIT */
520 disk_identify_fixup_uint16(identify, 91); /* current APM values */
521 disk_identify_fixup_uint16(identify, 94); /* current AAM value */
522 disk_identify_fixup_uint16(identify, 128); /* device lock function */
523 disk_identify_fixup_uint16(identify, 217); /* nominal media rotation rate */
524 memcpy(&id, identify, sizeof id);
526 /* If this fails, then try HDIO_GET_IDENTITY */
527 if (ioctl(fd, HDIO_GET_IDENTITY, &id) != 0) {
528 log_info("HDIO_GET_IDENTITY failed for '%s': %m\n", node);
533 identify_words = (uint16_t *) identify;
535 memcpy (model, id.model, 40);
537 udev_util_encode_string(model, model_enc, sizeof(model_enc));
538 util_replace_whitespace((char *) id.model, model, 40);
539 util_replace_chars(model, NULL);
540 util_replace_whitespace((char *) id.serial_no, serial, 20);
541 util_replace_chars(serial, NULL);
542 util_replace_whitespace((char *) id.fw_rev, revision, 8);
543 util_replace_chars(revision, NULL);
546 /* Set this to convey the disk speaks the ATA protocol */
547 printf("ID_ATA=1\n");
549 if ((id.config >> 8) & 0x80) {
550 /* This is an ATAPI device */
551 switch ((id.config >> 8) & 0x1f) {
553 printf("ID_TYPE=cd\n");
556 printf("ID_TYPE=tape\n");
559 printf("ID_TYPE=cd\n");
562 printf("ID_TYPE=optical\n");
565 printf("ID_TYPE=generic\n");
569 printf("ID_TYPE=disk\n");
571 printf("ID_BUS=ata\n");
572 printf("ID_MODEL=%s\n", model);
573 printf("ID_MODEL_ENC=%s\n", model_enc);
574 printf("ID_REVISION=%s\n", revision);
575 if (serial[0] != '\0') {
576 printf("ID_SERIAL=%s_%s\n", model, serial);
577 printf("ID_SERIAL_SHORT=%s\n", serial);
579 printf("ID_SERIAL=%s\n", model);
582 if (id.command_set_1 & (1<<5)) {
583 printf ("ID_ATA_WRITE_CACHE=1\n");
584 printf ("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id.cfs_enable_1 & (1<<5)) ? 1 : 0);
586 if (id.command_set_1 & (1<<10)) {
587 printf("ID_ATA_FEATURE_SET_HPA=1\n");
588 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id.cfs_enable_1 & (1<<10)) ? 1 : 0);
591 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
592 * so it is easy to check whether the protected area is in use.
595 if (id.command_set_1 & (1<<3)) {
596 printf("ID_ATA_FEATURE_SET_PM=1\n");
597 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id.cfs_enable_1 & (1<<3)) ? 1 : 0);
599 if (id.command_set_1 & (1<<1)) {
600 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
601 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id.cfs_enable_1 & (1<<1)) ? 1 : 0);
602 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id.trseuc * 2);
603 if ((id.cfs_enable_1 & (1<<1))) /* enabled */ {
605 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
607 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
610 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id.trsEuc * 2);
612 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
614 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
616 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
618 if (id.command_set_1 & (1<<0)) {
619 printf("ID_ATA_FEATURE_SET_SMART=1\n");
620 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id.cfs_enable_1 & (1<<0)) ? 1 : 0);
622 if (id.command_set_2 & (1<<9)) {
623 printf("ID_ATA_FEATURE_SET_AAM=1\n");
624 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<9)) ? 1 : 0);
625 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id.acoustic >> 8);
626 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id.acoustic & 0xff);
628 if (id.command_set_2 & (1<<5)) {
629 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
630 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id.cfs_enable_2 & (1<<5)) ? 1 : 0);
632 if (id.command_set_2 & (1<<3)) {
633 printf("ID_ATA_FEATURE_SET_APM=1\n");
634 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id.cfs_enable_2 & (1<<3)) ? 1 : 0);
635 if ((id.cfs_enable_2 & (1<<3)))
636 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id.CurAPMvalues & 0xff);
638 if (id.command_set_2 & (1<<0))
639 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
642 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
643 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
644 * the device does not claim compliance with the Serial ATA specification and words
645 * 76 through 79 are not valid and shall be ignored.
647 word = *((uint16_t *) identify + 76);
648 if (word != 0x0000 && word != 0xffff) {
649 printf("ID_ATA_SATA=1\n");
651 * If bit 2 of word 76 is set to one, then the device supports the Gen2
652 * signaling rate of 3.0 Gb/s (see SATA 2.6).
654 * If bit 1 of word 76 is set to one, then the device supports the Gen1
655 * signaling rate of 1.5 Gb/s (see SATA 2.6).
658 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
660 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
663 /* Word 217 indicates the nominal media rotation rate of the device */
664 word = *((uint16_t *) identify + 217);
665 if (word != 0x0000) {
666 if (word == 0x0001) {
667 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
668 } else if (word >= 0x0401 && word <= 0xfffe) {
669 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word);
674 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
675 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
676 * All other values are reserved.
678 word = *((uint16_t *) identify + 108);
679 if ((word & 0xf000) == 0x5000) {
682 wwwn = *((uint16_t *) identify + 108);
684 wwwn |= *((uint16_t *) identify + 109);
686 wwwn |= *((uint16_t *) identify + 110);
688 wwwn |= *((uint16_t *) identify + 111);
689 printf("ID_WWN=0x%llx\n", (unsigned long long int) wwwn);
690 /* ATA devices have no vendor extension */
691 printf("ID_WWN_WITH_EXTENSION=0x%llx\n", (unsigned long long int) wwwn);
694 /* from Linux's include/linux/ata.h */
695 if (identify_words[0] == 0x848a || identify_words[0] == 0x844a) {
696 printf("ID_ATA_CFA=1\n");
698 if ((identify_words[83] & 0xc004) == 0x4004) {
699 printf("ID_ATA_CFA=1\n");
703 if (serial[0] != '\0')
704 printf("%s_%s\n", model, serial);
706 printf("%s\n", model);