4 * Code related to requesting and getting an id from a scsi device
6 * Copyright (C) IBM Corp. 2003
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as
10 * published by the Free Software Foundation; either version 2.1 of the
11 * License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 #include <sys/types.h>
25 #include <sys/ioctl.h>
33 #include <linux/compiler.h> /* need __user when built via klibc */
35 #include <sysfs/libsysfs.h>
40 * A priority based list of id, naa, and binary/ascii for the identifier
41 * descriptor in VPD page 0x83.
43 * Brute force search for a match starting with the first value in the
44 * following id_search_list. This is not a performance issue, since there
45 * is normally one or some small number of descriptors.
47 static const struct scsi_id_search_values id_search_list[] = {
48 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG_EXTENDED, SCSI_ID_BINARY },
49 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG_EXTENDED, SCSI_ID_ASCII },
50 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG, SCSI_ID_BINARY },
51 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG, SCSI_ID_ASCII },
53 * Devices already exist using NAA values that are now marked
54 * reserved. These should not conflict with other values, or it is
55 * a bug in the device. As long as we find the IEEE extended one
56 * first, we really don't care what other ones are used. Using
57 * don't care here means that a device that returns multiple
58 * non-IEEE descriptors in a random order will get different
61 { SCSI_ID_NAA, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
62 { SCSI_ID_NAA, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
63 { SCSI_ID_EUI_64, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
64 { SCSI_ID_EUI_64, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
65 { SCSI_ID_T10_VENDOR, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
66 { SCSI_ID_T10_VENDOR, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
67 { SCSI_ID_VENDOR_SPECIFIC, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
68 { SCSI_ID_VENDOR_SPECIFIC, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
71 static const char hex_str[]="0123456789abcdef";
74 * Values returned in the result/status, only the ones used by the code
78 #define DID_NO_CONNECT 0x01 /* Unable to connect before timeout */
80 #define DID_BUS_BUSY 0x02 /* Bus remain busy until timeout */
81 #define DID_TIME_OUT 0x03 /* Timed out for some other reason */
83 #define DRIVER_TIMEOUT 0x06
84 #define DRIVER_SENSE 0x08 /* Sense_buffer has been set */
86 /* The following "category" function returns one of the following */
87 #define SG_ERR_CAT_CLEAN 0 /* No errors or other information */
88 #define SG_ERR_CAT_MEDIA_CHANGED 1 /* interpreted from sense buffer */
89 #define SG_ERR_CAT_RESET 2 /* interpreted from sense buffer */
90 #define SG_ERR_CAT_TIMEOUT 3
91 #define SG_ERR_CAT_RECOVERED 4 /* Successful command after recovered err */
92 #define SG_ERR_CAT_NOTSUPPORTED 5 /* Illegal / unsupported command */
93 #define SG_ERR_CAT_SENSE 98 /* Something else in the sense buffer */
94 #define SG_ERR_CAT_OTHER 99 /* Some other error/warning */
96 static int sg_err_category_new(int scsi_status, int msg_status, int
97 host_status, int driver_status, const
98 unsigned char *sense_buffer, int sb_len)
103 * XXX change to return only two values - failed or OK.
109 if (!scsi_status && !msg_status && !host_status && !driver_status)
110 return SG_ERR_CAT_CLEAN;
112 if ((scsi_status == SCSI_CHECK_CONDITION) ||
113 (scsi_status == SCSI_COMMAND_TERMINATED) ||
114 ((driver_status & 0xf) == DRIVER_SENSE)) {
115 if (sense_buffer && (sb_len > 2)) {
119 if (sense_buffer[0] & 0x2) {
120 sense_key = sense_buffer[1] & 0xf;
121 asc = sense_buffer[2];
123 sense_key = sense_buffer[2] & 0xf;
124 asc = (sb_len > 12) ? sense_buffer[12] : 0;
127 if (sense_key == RECOVERED_ERROR)
128 return SG_ERR_CAT_RECOVERED;
129 else if (sense_key == UNIT_ATTENTION) {
131 return SG_ERR_CAT_MEDIA_CHANGED;
133 return SG_ERR_CAT_RESET;
134 } else if (sense_key == ILLEGAL_REQUEST) {
135 return SG_ERR_CAT_NOTSUPPORTED;
138 return SG_ERR_CAT_SENSE;
141 if ((host_status == DID_NO_CONNECT) ||
142 (host_status == DID_BUS_BUSY) ||
143 (host_status == DID_TIME_OUT))
144 return SG_ERR_CAT_TIMEOUT;
146 if (!driver_status) {
147 if (driver_status == DRIVER_TIMEOUT)
148 return SG_ERR_CAT_TIMEOUT;
150 return SG_ERR_CAT_OTHER;
153 static int sg_err_category3(struct sg_io_hdr *hp)
155 return sg_err_category_new(hp->status, hp->msg_status,
156 hp->host_status, hp->driver_status,
157 hp->sbp, hp->sb_len_wr);
160 static int scsi_dump_sense(struct sysfs_device *scsi_dev, struct sg_io_hdr *io)
162 unsigned char *sense_buffer;
168 int descriptor_format;
171 char out_buffer[256];
176 * Figure out and print the sense key, asc and ascq.
178 * If you want to suppress these for a particular drive model, add
179 * a black list entry in the scsi_id config file.
181 * XXX We probably need to: lookup the sense/asc/ascq in a retry
182 * table, and if found return 1 (after dumping the sense, asc, and
183 * ascq). So, if/when we get something like a power on/reset,
184 * we'll retry the command.
187 dprintf("got check condition\n");
189 sb_len = io->sb_len_wr;
191 log_message(LOG_WARNING, "%s: sense buffer empty\n",
196 sense_buffer = io->sbp;
197 sense_class = (sense_buffer[0] >> 4) & 0x07;
198 code = sense_buffer[0] & 0xf;
200 if (sense_class == 7) {
202 * extended sense data.
204 s = sense_buffer[7] + 8;
206 log_message(LOG_WARNING,
207 "%s: sense buffer too small %d bytes,"
208 " %d bytes too short\n", scsi_dev->name,
212 if ((code == 0x0) || (code == 0x1)) {
213 descriptor_format = 0;
214 sense_key = sense_buffer[2] & 0xf;
219 log_message(LOG_WARNING, "%s: sense result too"
224 asc = sense_buffer[12];
225 ascq = sense_buffer[13];
226 } else if ((code == 0x2) || (code == 0x3)) {
227 descriptor_format = 1;
228 sense_key = sense_buffer[1] & 0xf;
229 asc = sense_buffer[2];
230 ascq = sense_buffer[3];
232 log_message(LOG_WARNING,
233 "%s: invalid sense code 0x%x\n",
234 scsi_dev->name, code);
237 log_message(LOG_WARNING,
238 "%s: sense key 0x%x ASC 0x%x ASCQ 0x%x\n",
239 scsi_dev->name, sense_key, asc, ascq);
242 log_message(LOG_WARNING,
243 "%s: sense buffer too small %d bytes, %d bytes too short\n",
244 scsi_dev->name, sb_len, 4 - sb_len);
248 if (sense_buffer[0] < 15)
249 log_message(LOG_WARNING, "%s: old sense key: 0x%x\n",
250 scsi_dev->name, sense_buffer[0] & 0x0f);
252 log_message(LOG_WARNING, "%s: sense = %2x %2x\n",
253 scsi_dev->name, sense_buffer[0],
255 log_message(LOG_WARNING,
256 "%s: non-extended sense class %d code 0x%0x\n",
257 scsi_dev->name, sense_class, code);
262 for (i = 0, j = 0; (i < s) && (j < 254); i++) {
263 dprintf("i %d, j %d\n", i, j);
264 out_buffer[j++] = hex_str[(sense_buffer[i] & 0xf0) >> 4];
265 out_buffer[j++] = hex_str[sense_buffer[i] & 0x0f];
266 out_buffer[j++] = ' ';
268 out_buffer[j] = '\0';
269 log_message(LOG_WARNING, "%s: sense dump:\n", scsi_dev->name);
270 log_message(LOG_WARNING, "%s: %s\n", scsi_dev->name, out_buffer);
276 static int scsi_dump(struct sysfs_device *scsi_dev, struct sg_io_hdr *io)
278 if (!io->status && !io->host_status && !io->msg_status &&
279 !io->driver_status) {
281 * Impossible, should not be called.
283 log_message(LOG_WARNING, "%s: called with no error\n",
288 log_message(LOG_WARNING, "%s: sg_io failed status 0x%x 0x%x 0x%x 0x%x\n",
289 scsi_dev->name, io->driver_status, io->host_status,
290 io->msg_status, io->status);
291 if (io->status == SCSI_CHECK_CONDITION)
292 return scsi_dump_sense(scsi_dev, io);
297 static int scsi_inquiry(struct sysfs_device *scsi_dev, int fd,
298 unsigned char evpd, unsigned char page,
299 unsigned char *buf, unsigned int buflen)
301 unsigned char inq_cmd[INQUIRY_CMDLEN] =
302 { INQUIRY_CMD, evpd, page, 0, buflen, 0 };
303 unsigned char sense[SENSE_BUFF_LEN];
304 struct sg_io_hdr io_hdr;
306 int retry = 3; /* rather random */
308 if (buflen > SCSI_INQ_BUFF_LEN) {
309 log_message(LOG_WARNING, "buflen %d too long\n", buflen);
314 dprintf("%s evpd %d, page 0x%x\n", scsi_dev->name, evpd, page);
316 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
317 io_hdr.interface_id = 'S';
318 io_hdr.cmd_len = sizeof(inq_cmd);
319 io_hdr.mx_sb_len = sizeof(sense);
320 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
321 io_hdr.dxfer_len = buflen;
323 io_hdr.cmdp = inq_cmd;
325 io_hdr.timeout = DEF_TIMEOUT;
327 if (ioctl(fd, SG_IO, &io_hdr) < 0) {
328 log_message(LOG_WARNING, "%s: ioctl failed: %s\n",
329 scsi_dev->name, strerror(errno));
334 retval = sg_err_category3(&io_hdr);
337 case SG_ERR_CAT_NOTSUPPORTED:
340 case SG_ERR_CAT_CLEAN:
341 case SG_ERR_CAT_RECOVERED:
346 retval = scsi_dump(scsi_dev, &io_hdr);
351 } else if (retval > 0) {
353 dprintf("%s: Retrying ...\n", scsi_dev->name);
361 log_message(LOG_WARNING,
362 "%s: Unable to get INQUIRY vpd %d page 0x%x.\n",
363 scsi_dev->name, evpd, page);
368 /* Get list of supported EVPD pages */
369 static int do_scsi_page0_inquiry(struct sysfs_device *scsi_dev, int fd,
370 unsigned char *buffer, unsigned int len)
373 struct sysfs_attribute *vendor;
375 memset(buffer, 0, len);
376 retval = scsi_inquiry(scsi_dev, fd, 1, 0x0, buffer, len);
380 if (buffer[1] != 0) {
381 log_message(LOG_WARNING, "%s: page 0 not available.\n",
385 if (buffer[3] > len) {
386 log_message(LOG_WARNING, "%s: page 0 buffer too long %d\n",
387 scsi_dev->name, buffer[3]);
392 * Following check is based on code once included in the 2.5.x
395 * Some ill behaved devices return the standard inquiry here
396 * rather than the evpd data, snoop the data to verify.
398 if (buffer[3] > MODEL_LENGTH) {
400 * If the vendor id appears in the page assume the page is
403 vendor = sysfs_get_device_attr(scsi_dev, "vendor");
405 log_message(LOG_WARNING,
406 "%s: cannot get model attribute\n",
410 if (!strncmp((char *)&buffer[VENDOR_LENGTH], vendor->value,
412 log_message(LOG_WARNING, "%s: invalid page0 data\n",
421 * The caller checks that serial is long enough to include the vendor +
424 static int prepend_vendor_model(struct sysfs_device *scsi_dev, char *serial)
426 struct sysfs_attribute *attr;
429 attr = sysfs_get_device_attr(scsi_dev, "vendor");
431 log_message(LOG_WARNING, "%s: cannot get vendor attribute\n",
435 strncpy(serial, attr->value, VENDOR_LENGTH);
436 ind = strlen(serial) - 1;
438 * Remove sysfs added newlines.
440 if (serial[ind] == '\n')
443 attr = sysfs_get_device_attr(scsi_dev, "model");
445 log_message(LOG_WARNING, "%s: cannot get model attribute\n",
449 strncat(serial, attr->value, MODEL_LENGTH);
450 ind = strlen(serial) - 1;
451 if (serial[ind] == '\n')
457 * This is not a complete check, since we are using strncat/cpy
458 * above, ind will never be too large.
460 if (ind != (VENDOR_LENGTH + MODEL_LENGTH)) {
461 log_message(LOG_WARNING, "%s: expected length %d, got length %d\n",
462 scsi_dev->name, (VENDOR_LENGTH + MODEL_LENGTH),
470 * check_fill_0x83_id - check the page 0x83 id, if OK allocate and fill
473 static int check_fill_0x83_id(struct sysfs_device *scsi_dev,
474 unsigned char *page_83,
475 const struct scsi_id_search_values
476 *id_search, char *serial, int max_len)
481 * ASSOCIATION must be with the device (value 0)
483 if ((page_83[1] & 0x30) != 0)
486 if ((page_83[1] & 0x0f) != id_search->id_type)
490 * Possibly check NAA sub-type.
492 if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
493 (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
497 * Check for matching code set - ASCII or BINARY.
499 if ((page_83[0] & 0x0f) != id_search->code_set)
503 * page_83[3]: identifier length
506 if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
508 * If not ASCII, use two bytes for each binary value.
513 * Add one byte for the NUL termination, and one for the id_type.
516 if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
517 len += VENDOR_LENGTH + MODEL_LENGTH;
520 log_message(LOG_WARNING, "%s: length %d too short - need %d\n",
521 scsi_dev->name, max_len, len);
525 serial[0] = hex_str[id_search->id_type];
528 * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
529 * the id since it is not unique across all vendors and models,
530 * this differs from SCSI_ID_T10_VENDOR, where the vendor is
531 * included in the identifier.
533 if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
534 if (prepend_vendor_model(scsi_dev, &serial[1]) < 0) {
535 dprintf("prepend failed\n");
539 i = 4; /* offset to the start of the identifier */
541 if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
545 while (i < (4 + page_83[3]))
546 serial[j++] = page_83[i++];
549 * Binary descriptor, convert to ASCII, using two bytes of
550 * ASCII for each byte in the page_83.
552 while (i < (4 + page_83[3])) {
553 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
554 serial[j++] = hex_str[page_83[i] & 0x0f];
561 /* Get device identification VPD page */
562 static int do_scsi_page83_inquiry(struct sysfs_device *scsi_dev, int fd,
563 char *serial, int len)
566 unsigned int id_ind, j;
567 unsigned char page_83[SCSI_INQ_BUFF_LEN];
569 memset(page_83, 0, SCSI_INQ_BUFF_LEN);
570 retval = scsi_inquiry(scsi_dev, fd, 1, 0x83, page_83,
575 if (page_83[1] != 0x83) {
576 log_message(LOG_WARNING, "%s: Invalid page 0x83\n",
582 * XXX Some devices (IBM 3542) return all spaces for an identifier if
583 * the LUN is not actually configured. This leads to identifers of
588 * Search for a match in the prioritized id_search_list.
591 id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
594 * Examine each descriptor returned. There is normally only
595 * one or a small number of descriptors.
597 for (j = 4; j <= (unsigned int)page_83[3] + 3; j += page_83[j + 3] + 4) {
598 retval = check_fill_0x83_id(scsi_dev, &page_83[j],
599 &id_search_list[id_ind],
601 dprintf("%s id desc %d/%d/%d\n", scsi_dev->name,
602 id_search_list[id_ind].id_type,
603 id_search_list[id_ind].naa_type,
604 id_search_list[id_ind].code_set);
608 } else if (retval < 0) {
609 dprintf(" failed\n");
612 dprintf(" not used\n");
619 /* Get unit serial number VPD page */
620 static int do_scsi_page80_inquiry(struct sysfs_device *scsi_dev, int fd,
621 char *serial, int max_len)
627 unsigned char buf[SCSI_INQ_BUFF_LEN];
629 memset(buf, 0, SCSI_INQ_BUFF_LEN);
630 retval = scsi_inquiry(scsi_dev, fd, 1, 0x80, buf, SCSI_INQ_BUFF_LEN);
634 if (buf[1] != 0x80) {
635 log_message(LOG_WARNING, "%s: Invalid page 0x80\n",
640 len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
642 log_message(LOG_WARNING, "%s: length %d too short - need %d\n",
643 scsi_dev->name, max_len, len);
647 * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
648 * specific type where we prepend '0' + vendor + model.
651 ser_ind = prepend_vendor_model(scsi_dev, &serial[1]);
655 for (i = 4; i < len + 4; i++, ser_ind++)
656 serial[ser_ind] = buf[i];
660 int scsi_get_serial (struct sysfs_device *scsi_dev, const char *devname,
661 int page_code, char *serial, int len)
663 unsigned char page0[SCSI_INQ_BUFF_LEN];
668 memset(serial, 0, len);
669 dprintf("opening %s\n", devname);
670 fd = open(devname, O_RDONLY | O_NONBLOCK);
672 log_message(LOG_WARNING, "%s: cannot open %s: %s\n",
673 scsi_dev->name, devname, strerror(errno));
677 if (page_code == 0x80) {
678 if (do_scsi_page80_inquiry(scsi_dev, fd, serial, len)) {
685 } else if (page_code == 0x83) {
686 if (do_scsi_page83_inquiry(scsi_dev, fd, serial, len)) {
693 } else if (page_code != 0x00) {
694 log_message(LOG_WARNING, "%s: unsupported page code 0x%d\n",
695 scsi_dev->name, page_code);
700 * Get page 0, the page of the pages. By default, try from best to
701 * worst of supported pages: 0x83 then 0x80.
703 if (do_scsi_page0_inquiry(scsi_dev, fd, page0, SCSI_INQ_BUFF_LEN)) {
705 * Don't try anything else. Black list if a specific page
706 * should be used for this vendor+model, or maybe have an
707 * optional fall-back to page 0x80 or page 0x83.
713 dprintf("%s: Checking page0\n", scsi_dev->name);
715 for (ind = 4; ind <= page0[3] + 3; ind++)
716 if (page0[ind] == 0x83)
717 if (!do_scsi_page83_inquiry(scsi_dev, fd, serial,
726 for (ind = 4; ind <= page0[3] + 3; ind++)
727 if (page0[ind] == 0x80)
728 if (!do_scsi_page80_inquiry(scsi_dev, fd, serial,
739 log_message(LOG_WARNING, "%s: close failed: %s\n",
740 scsi_dev->name, strerror(errno));