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/>.
26 #include <linux/bsg.h>
27 #include <linux/hdreg.h>
28 #include <scsi/scsi.h>
29 #include <scsi/scsi_ioctl.h>
35 #include <sys/ioctl.h>
37 #include <sys/types.h>
42 #include "libudev-private.h"
44 #include "udev-util.h"
46 #define COMMAND_TIMEOUT_MSEC (30 * 1000)
48 static int disk_scsi_inquiry_command(int fd
,
54 * INQUIRY, see SPC-4 section 6.4
56 [0] = 0x12, /* OPERATION CODE: INQUIRY */
57 [3] = (buf_len
>> 8), /* ALLOCATION LENGTH */
58 [4] = (buf_len
& 0xff),
60 uint8_t sense
[32] = {};
61 struct sg_io_v4 io_v4
= {
63 .protocol
= BSG_PROTOCOL_SCSI
,
64 .subprotocol
= BSG_SUB_PROTOCOL_SCSI_CMD
,
65 .request_len
= sizeof(cdb
),
66 .request
= (uintptr_t) cdb
,
67 .max_response_len
= sizeof(sense
),
68 .response
= (uintptr_t) sense
,
69 .din_xfer_len
= buf_len
,
70 .din_xferp
= (uintptr_t) buf
,
71 .timeout
= COMMAND_TIMEOUT_MSEC
,
75 ret
= ioctl(fd
, SG_IO
, &io_v4
);
77 /* could be that the driver doesn't do version 4, try version 3 */
78 if (errno
== EINVAL
) {
79 struct sg_io_hdr io_hdr
= {
81 .cmdp
= (unsigned char*) cdb
,
82 .cmd_len
= sizeof (cdb
),
86 .mx_sb_len
= sizeof(sense
),
87 .dxfer_direction
= SG_DXFER_FROM_DEV
,
88 .timeout
= COMMAND_TIMEOUT_MSEC
,
91 ret
= ioctl(fd
, SG_IO
, &io_hdr
);
95 /* even if the ioctl succeeds, we need to check the return value */
96 if (!(io_hdr
.status
== 0 &&
97 io_hdr
.host_status
== 0 &&
98 io_hdr
.driver_status
== 0)) {
106 /* even if the ioctl succeeds, we need to check the return value */
107 if (!(io_v4
.device_status
== 0 &&
108 io_v4
.transport_status
== 0 &&
109 io_v4
.driver_status
== 0)) {
117 static int disk_identify_command(int fd
,
123 * ATA Pass-Through 12 byte command, as described in
125 * T10 04-262r8 ATA Command Pass-Through
127 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
129 [0] = 0xa1, /* OPERATION CODE: 12 byte pass through */
130 [1] = 4 << 1, /* PROTOCOL: PIO Data-in */
131 [2] = 0x2e, /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
132 [3] = 0, /* FEATURES */
133 [4] = 1, /* SECTORS */
134 [5] = 0, /* LBA LOW */
135 [6] = 0, /* LBA MID */
136 [7] = 0, /* LBA HIGH */
137 [8] = 0 & 0x4F, /* SELECT */
138 [9] = 0xEC, /* Command: ATA IDENTIFY DEVICE */
140 uint8_t sense
[32] = {};
141 uint8_t *desc
= sense
+ 8;
142 struct sg_io_v4 io_v4
= {
144 .protocol
= BSG_PROTOCOL_SCSI
,
145 .subprotocol
= BSG_SUB_PROTOCOL_SCSI_CMD
,
146 .request_len
= sizeof(cdb
),
147 .request
= (uintptr_t) cdb
,
148 .max_response_len
= sizeof(sense
),
149 .response
= (uintptr_t) sense
,
150 .din_xfer_len
= buf_len
,
151 .din_xferp
= (uintptr_t) buf
,
152 .timeout
= COMMAND_TIMEOUT_MSEC
,
156 ret
= ioctl(fd
, SG_IO
, &io_v4
);
158 /* could be that the driver doesn't do version 4, try version 3 */
159 if (errno
== EINVAL
) {
160 struct sg_io_hdr io_hdr
= {
162 .cmdp
= (unsigned char*) cdb
,
163 .cmd_len
= sizeof (cdb
),
165 .dxfer_len
= buf_len
,
167 .mx_sb_len
= sizeof (sense
),
168 .dxfer_direction
= SG_DXFER_FROM_DEV
,
169 .timeout
= COMMAND_TIMEOUT_MSEC
,
172 ret
= ioctl(fd
, SG_IO
, &io_hdr
);
179 if (!(sense
[0] == 0x72 && desc
[0] == 0x9 && desc
[1] == 0x0c)) {
187 static int disk_identify_packet_device_command(int fd
,
193 * ATA Pass-Through 16 byte command, as described in
195 * T10 04-262r8 ATA Command Pass-Through
197 * from http://www.t10.org/ftp/t10/document.04/04-262r8.pdf
199 [0] = 0x85, /* OPERATION CODE: 16 byte pass through */
200 [1] = 4 << 1, /* PROTOCOL: PIO Data-in */
201 [2] = 0x2e, /* OFF_LINE=0, CK_COND=1, T_DIR=1, BYT_BLOK=1, T_LENGTH=2 */
202 [3] = 0, /* FEATURES */
203 [4] = 0, /* FEATURES */
204 [5] = 0, /* SECTORS */
205 [6] = 1, /* SECTORS */
206 [7] = 0, /* LBA LOW */
207 [8] = 0, /* LBA LOW */
208 [9] = 0, /* LBA MID */
209 [10] = 0, /* LBA MID */
210 [11] = 0, /* LBA HIGH */
211 [12] = 0, /* LBA HIGH */
212 [13] = 0, /* DEVICE */
213 [14] = 0xA1, /* Command: ATA IDENTIFY PACKET DEVICE */
214 [15] = 0, /* CONTROL */
216 uint8_t sense
[32] = {};
217 uint8_t *desc
= sense
+ 8;
218 struct sg_io_v4 io_v4
= {
220 .protocol
= BSG_PROTOCOL_SCSI
,
221 .subprotocol
= BSG_SUB_PROTOCOL_SCSI_CMD
,
222 .request_len
= sizeof (cdb
),
223 .request
= (uintptr_t) cdb
,
224 .max_response_len
= sizeof (sense
),
225 .response
= (uintptr_t) sense
,
226 .din_xfer_len
= buf_len
,
227 .din_xferp
= (uintptr_t) buf
,
228 .timeout
= COMMAND_TIMEOUT_MSEC
,
232 ret
= ioctl(fd
, SG_IO
, &io_v4
);
234 /* could be that the driver doesn't do version 4, try version 3 */
235 if (errno
== EINVAL
) {
236 struct sg_io_hdr io_hdr
= {
238 .cmdp
= (unsigned char*) cdb
,
239 .cmd_len
= sizeof (cdb
),
241 .dxfer_len
= buf_len
,
243 .mx_sb_len
= sizeof (sense
),
244 .dxfer_direction
= SG_DXFER_FROM_DEV
,
245 .timeout
= COMMAND_TIMEOUT_MSEC
,
248 ret
= ioctl(fd
, SG_IO
, &io_hdr
);
255 if (!(sense
[0] == 0x72 && desc
[0] == 0x9 && desc
[1] == 0x0c)) {
264 * disk_identify_get_string:
265 * @identify: A block of IDENTIFY data
266 * @offset_words: Offset of the string to get, in words.
267 * @dest: Destination buffer for the string.
268 * @dest_len: Length of destination buffer, in bytes.
270 * Copies the ATA string from @identify located at @offset_words into @dest.
272 static void disk_identify_get_string(uint8_t identify
[512],
273 unsigned int offset_words
,
280 while (dest_len
> 0) {
281 c1
= identify
[offset_words
* 2 + 1];
282 c2
= identify
[offset_words
* 2];
292 static void disk_identify_fixup_string(uint8_t identify
[512],
293 unsigned int offset_words
,
296 disk_identify_get_string(identify
, offset_words
,
297 (char *) identify
+ offset_words
* 2, len
);
300 static void disk_identify_fixup_uint16 (uint8_t identify
[512], unsigned int offset_words
)
304 p
= (uint16_t *) identify
;
305 p
[offset_words
] = le16toh (p
[offset_words
]);
310 * @udev: The libudev context.
311 * @fd: File descriptor for the block device.
312 * @out_identify: Return location for IDENTIFY data.
313 * @out_is_packet_device: Return location for whether returned data is from a IDENTIFY PACKET DEVICE.
315 * Sends the IDENTIFY DEVICE or IDENTIFY PACKET DEVICE command to the
316 * device represented by @fd. If successful, then the result will be
317 * copied into @out_identify and @out_is_packet_device.
319 * This routine is based on code from libatasmart, Copyright 2008
320 * Lennart Poettering, LGPL v2.1.
322 * Returns: 0 if the data was successfully obtained, otherwise
323 * non-zero with errno set.
325 static int disk_identify(struct udev
*udev
,
327 uint8_t out_identify
[512],
328 int *out_is_packet_device
)
331 uint8_t inquiry_buf
[36];
332 int peripheral_device_type
;
335 int is_packet_device
= 0;
338 memzero(out_identify
, 512);
340 /* If we were to use ATA PASS_THROUGH (12) on an ATAPI device
341 * we could accidentally blank media. This is because MMC's BLANK
342 * command has the same op-code (0x61).
344 * To prevent this from happening we bail out if the device
345 * isn't a Direct Access Block Device, e.g. SCSI type 0x00
346 * (CD/DVD devices are type 0x05). So we send a SCSI INQUIRY
347 * command first... libata is handling this via its SCSI
350 * This also ensures that we're actually dealing with a device
351 * that understands SCSI commands.
353 * (Yes, it is a bit perverse that we're tunneling the ATA
354 * command through SCSI and relying on the ATA driver
355 * emulating SCSI well-enough...)
357 * (See commit 160b069c25690bfb0c785994c7c3710289179107 for
358 * the original bug-fix and see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=556635
359 * for the original bug-report.)
361 ret
= disk_scsi_inquiry_command (fd
, inquiry_buf
, sizeof (inquiry_buf
));
365 /* SPC-4, section 6.4.2: Standard INQUIRY data */
366 peripheral_device_type
= inquiry_buf
[0] & 0x1f;
367 if (peripheral_device_type
== 0x05)
369 is_packet_device
= 1;
370 ret
= disk_identify_packet_device_command(fd
, out_identify
, 512);
371 goto check_nul_bytes
;
373 if (peripheral_device_type
!= 0x00) {
379 /* OK, now issue the IDENTIFY DEVICE command */
380 ret
= disk_identify_command(fd
, out_identify
, 512);
385 /* Check if IDENTIFY data is all NUL bytes - if so, bail */
387 for (n
= 0; n
< 512; n
++) {
388 if (out_identify
[n
] != '\0') {
401 if (out_is_packet_device
!= NULL
)
402 *out_is_packet_device
= is_packet_device
;
406 int main(int argc
, char *argv
[])
408 _cleanup_udev_unref_
struct udev
*udev
= NULL
;
409 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
, 76); /* 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
, 108); /* WWN */
489 disk_identify_fixup_uint16(identify
.byte
, 109); /* WWN */
490 disk_identify_fixup_uint16(identify
.byte
, 110); /* WWN */
491 disk_identify_fixup_uint16(identify
.byte
, 111); /* WWN */
492 disk_identify_fixup_uint16(identify
.byte
, 128); /* device lock function */
493 disk_identify_fixup_uint16(identify
.byte
, 217); /* nominal media rotation rate */
494 memcpy(&id
, identify
.byte
, sizeof id
);
496 /* If this fails, then try HDIO_GET_IDENTITY */
497 if (ioctl(fd
, HDIO_GET_IDENTITY
, &id
) != 0) {
498 log_debug_errno(errno
, "HDIO_GET_IDENTITY failed for '%s': %m", node
);
503 memcpy(model
, id
.model
, 40);
505 udev_util_encode_string(model
, model_enc
, sizeof(model_enc
));
506 util_replace_whitespace((char *) id
.model
, model
, 40);
507 util_replace_chars(model
, NULL
);
508 util_replace_whitespace((char *) id
.serial_no
, serial
, 20);
509 util_replace_chars(serial
, NULL
);
510 util_replace_whitespace((char *) id
.fw_rev
, revision
, 8);
511 util_replace_chars(revision
, NULL
);
514 /* Set this to convey the disk speaks the ATA protocol */
515 printf("ID_ATA=1\n");
517 if ((id
.config
>> 8) & 0x80) {
518 /* This is an ATAPI device */
519 switch ((id
.config
>> 8) & 0x1f) {
521 printf("ID_TYPE=cd\n");
524 printf("ID_TYPE=tape\n");
527 printf("ID_TYPE=cd\n");
530 printf("ID_TYPE=optical\n");
533 printf("ID_TYPE=generic\n");
537 printf("ID_TYPE=disk\n");
539 printf("ID_BUS=ata\n");
540 printf("ID_MODEL=%s\n", model
);
541 printf("ID_MODEL_ENC=%s\n", model_enc
);
542 printf("ID_REVISION=%s\n", revision
);
543 if (serial
[0] != '\0') {
544 printf("ID_SERIAL=%s_%s\n", model
, serial
);
545 printf("ID_SERIAL_SHORT=%s\n", serial
);
547 printf("ID_SERIAL=%s\n", model
);
550 if (id
.command_set_1
& (1<<5)) {
551 printf("ID_ATA_WRITE_CACHE=1\n");
552 printf("ID_ATA_WRITE_CACHE_ENABLED=%d\n", (id
.cfs_enable_1
& (1<<5)) ? 1 : 0);
554 if (id
.command_set_1
& (1<<10)) {
555 printf("ID_ATA_FEATURE_SET_HPA=1\n");
556 printf("ID_ATA_FEATURE_SET_HPA_ENABLED=%d\n", (id
.cfs_enable_1
& (1<<10)) ? 1 : 0);
559 * TODO: use the READ NATIVE MAX ADDRESS command to get the native max address
560 * so it is easy to check whether the protected area is in use.
563 if (id
.command_set_1
& (1<<3)) {
564 printf("ID_ATA_FEATURE_SET_PM=1\n");
565 printf("ID_ATA_FEATURE_SET_PM_ENABLED=%d\n", (id
.cfs_enable_1
& (1<<3)) ? 1 : 0);
567 if (id
.command_set_1
& (1<<1)) {
568 printf("ID_ATA_FEATURE_SET_SECURITY=1\n");
569 printf("ID_ATA_FEATURE_SET_SECURITY_ENABLED=%d\n", (id
.cfs_enable_1
& (1<<1)) ? 1 : 0);
570 printf("ID_ATA_FEATURE_SET_SECURITY_ERASE_UNIT_MIN=%d\n", id
.trseuc
* 2);
571 if ((id
.cfs_enable_1
& (1<<1))) /* enabled */ {
573 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=maximum\n");
575 printf("ID_ATA_FEATURE_SET_SECURITY_LEVEL=high\n");
578 printf("ID_ATA_FEATURE_SET_SECURITY_ENHANCED_ERASE_UNIT_MIN=%d\n", id
.trsEuc
* 2);
580 printf("ID_ATA_FEATURE_SET_SECURITY_EXPIRE=1\n");
582 printf("ID_ATA_FEATURE_SET_SECURITY_FROZEN=1\n");
584 printf("ID_ATA_FEATURE_SET_SECURITY_LOCKED=1\n");
586 if (id
.command_set_1
& (1<<0)) {
587 printf("ID_ATA_FEATURE_SET_SMART=1\n");
588 printf("ID_ATA_FEATURE_SET_SMART_ENABLED=%d\n", (id
.cfs_enable_1
& (1<<0)) ? 1 : 0);
590 if (id
.command_set_2
& (1<<9)) {
591 printf("ID_ATA_FEATURE_SET_AAM=1\n");
592 printf("ID_ATA_FEATURE_SET_AAM_ENABLED=%d\n", (id
.cfs_enable_2
& (1<<9)) ? 1 : 0);
593 printf("ID_ATA_FEATURE_SET_AAM_VENDOR_RECOMMENDED_VALUE=%d\n", id
.acoustic
>> 8);
594 printf("ID_ATA_FEATURE_SET_AAM_CURRENT_VALUE=%d\n", id
.acoustic
& 0xff);
596 if (id
.command_set_2
& (1<<5)) {
597 printf("ID_ATA_FEATURE_SET_PUIS=1\n");
598 printf("ID_ATA_FEATURE_SET_PUIS_ENABLED=%d\n", (id
.cfs_enable_2
& (1<<5)) ? 1 : 0);
600 if (id
.command_set_2
& (1<<3)) {
601 printf("ID_ATA_FEATURE_SET_APM=1\n");
602 printf("ID_ATA_FEATURE_SET_APM_ENABLED=%d\n", (id
.cfs_enable_2
& (1<<3)) ? 1 : 0);
603 if ((id
.cfs_enable_2
& (1<<3)))
604 printf("ID_ATA_FEATURE_SET_APM_CURRENT_VALUE=%d\n", id
.CurAPMvalues
& 0xff);
606 if (id
.command_set_2
& (1<<0))
607 printf("ID_ATA_DOWNLOAD_MICROCODE=1\n");
610 * Word 76 indicates the capabilities of a SATA device. A PATA device shall set
611 * word 76 to 0000h or FFFFh. If word 76 is set to 0000h or FFFFh, then
612 * the device does not claim compliance with the Serial ATA specification and words
613 * 76 through 79 are not valid and shall be ignored.
616 word
= identify
.wyde
[76];
617 if (word
!= 0x0000 && word
!= 0xffff) {
618 printf("ID_ATA_SATA=1\n");
620 * If bit 2 of word 76 is set to one, then the device supports the Gen2
621 * signaling rate of 3.0 Gb/s (see SATA 2.6).
623 * If bit 1 of word 76 is set to one, then the device supports the Gen1
624 * signaling rate of 1.5 Gb/s (see SATA 2.6).
627 printf("ID_ATA_SATA_SIGNAL_RATE_GEN2=1\n");
629 printf("ID_ATA_SATA_SIGNAL_RATE_GEN1=1\n");
632 /* Word 217 indicates the nominal media rotation rate of the device */
633 word
= identify
.wyde
[217];
635 printf ("ID_ATA_ROTATION_RATE_RPM=0\n"); /* non-rotating e.g. SSD */
636 else if (word
>= 0x0401 && word
<= 0xfffe)
637 printf ("ID_ATA_ROTATION_RATE_RPM=%d\n", word
);
640 * Words 108-111 contain a mandatory World Wide Name (WWN) in the NAA IEEE Registered identifier
641 * format. Word 108 bits (15:12) shall contain 5h, indicating that the naming authority is IEEE.
642 * All other values are reserved.
644 word
= identify
.wyde
[108];
645 if ((word
& 0xf000) == 0x5000) {
648 wwwn
= identify
.wyde
[108];
650 wwwn
|= identify
.wyde
[109];
652 wwwn
|= identify
.wyde
[110];
654 wwwn
|= identify
.wyde
[111];
655 printf("ID_WWN=0x%1$" PRIx64
"\n"
656 "ID_WWN_WITH_EXTENSION=0x%1$" PRIx64
"\n",
660 /* from Linux's include/linux/ata.h */
661 if (identify
.wyde
[0] == 0x848a ||
662 identify
.wyde
[0] == 0x844a ||
663 (identify
.wyde
[83] & 0xc004) == 0x4004)
664 printf("ID_ATA_CFA=1\n");
666 if (serial
[0] != '\0')
667 printf("%s_%s\n", model
, serial
);
669 printf("%s\n", model
);