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>
34 #include <sysfs/libsysfs.h>
39 * A priority based list of id, naa, and binary/ascii for the identifier
40 * descriptor in VPD page 0x83.
42 * Brute force search for a match starting with the first value in the
43 * following id_search_list. This is not a performance issue, since there
44 * is normally one or some small number of descriptors.
46 static const struct scsi_id_search_values id_search_list[] = {
47 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG_EXTENDED, SCSI_ID_BINARY },
48 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG_EXTENDED, SCSI_ID_ASCII },
49 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG, SCSI_ID_BINARY },
50 { SCSI_ID_NAA, SCSI_ID_NAA_IEEE_REG, SCSI_ID_ASCII },
52 * Devices already exist using NAA values that are now marked
53 * reserved. These should not conflict with other values, or it is
54 * a bug in the device. As long as we find the IEEE extended one
55 * first, we really don't care what other ones are used. Using
56 * don't care here means that a device that returns multiple
57 * non-IEEE descriptors in a random order will get different
60 { SCSI_ID_NAA, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
61 { SCSI_ID_NAA, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
62 { SCSI_ID_EUI_64, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
63 { SCSI_ID_EUI_64, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
64 { SCSI_ID_T10_VENDOR, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
65 { SCSI_ID_T10_VENDOR, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
66 { SCSI_ID_VENDOR_SPECIFIC, SCSI_ID_NAA_DONT_CARE, SCSI_ID_BINARY },
67 { SCSI_ID_VENDOR_SPECIFIC, SCSI_ID_NAA_DONT_CARE, SCSI_ID_ASCII },
70 static const char hex_str[]="0123456789abcdef";
73 * Values returned in the result/status, only the ones used by the code
77 #define DID_NO_CONNECT 0x01 /* Unable to connect before timeout */
79 #define DID_BUS_BUSY 0x02 /* Bus remain busy until timeout */
80 #define DID_TIME_OUT 0x03 /* Timed out for some other reason */
82 #define DRIVER_TIMEOUT 0x06
83 #define DRIVER_SENSE 0x08 /* Sense_buffer has been set */
85 /* The following "category" function returns one of the following */
86 #define SG_ERR_CAT_CLEAN 0 /* No errors or other information */
87 #define SG_ERR_CAT_MEDIA_CHANGED 1 /* interpreted from sense buffer */
88 #define SG_ERR_CAT_RESET 2 /* interpreted from sense buffer */
89 #define SG_ERR_CAT_TIMEOUT 3
90 #define SG_ERR_CAT_RECOVERED 4 /* Successful command after recovered err */
91 #define SG_ERR_CAT_SENSE 98 /* Something else in the sense buffer */
92 #define SG_ERR_CAT_OTHER 99 /* Some other error/warning */
94 static int sg_err_category_new(int scsi_status, int msg_status, int
95 host_status, int driver_status, const
96 unsigned char *sense_buffer, int sb_len)
101 * XXX change to return only two values - failed or OK.
107 if (!scsi_status && !msg_status && !host_status && !driver_status)
108 return SG_ERR_CAT_CLEAN;
110 if ((scsi_status == SCSI_CHECK_CONDITION) ||
111 (scsi_status == SCSI_COMMAND_TERMINATED) ||
112 ((driver_status & 0xf) == DRIVER_SENSE)) {
113 if (sense_buffer && (sb_len > 2)) {
117 if (sense_buffer[0] & 0x2) {
118 sense_key = sense_buffer[1] & 0xf;
119 asc = sense_buffer[2];
121 sense_key = sense_buffer[2] & 0xf;
122 asc = (sb_len > 12) ? sense_buffer[12] : 0;
125 if (sense_key == RECOVERED_ERROR)
126 return SG_ERR_CAT_RECOVERED;
127 else if (sense_key == UNIT_ATTENTION) {
129 return SG_ERR_CAT_MEDIA_CHANGED;
131 return SG_ERR_CAT_RESET;
134 return SG_ERR_CAT_SENSE;
137 if ((host_status == DID_NO_CONNECT) ||
138 (host_status == DID_BUS_BUSY) ||
139 (host_status == DID_TIME_OUT))
140 return SG_ERR_CAT_TIMEOUT;
142 if (!driver_status) {
143 if (driver_status == DRIVER_TIMEOUT)
144 return SG_ERR_CAT_TIMEOUT;
146 return SG_ERR_CAT_OTHER;
149 static int sg_err_category3(struct sg_io_hdr *hp)
151 return sg_err_category_new(hp->status, hp->msg_status,
152 hp->host_status, hp->driver_status,
153 hp->sbp, hp->sb_len_wr);
156 static int scsi_dump_sense(struct sysfs_device *scsi_dev, struct sg_io_hdr *io)
158 unsigned char *sense_buffer;
164 int descriptor_format;
167 char out_buffer[256];
172 * Figure out and print the sense key, asc and ascq.
174 * If you want to suppress these for a particular drive model, add
175 * a black list entry in the scsi_id config file.
177 * XXX We probably need to: lookup the sense/asc/ascq in a retry
178 * table, and if found return 1 (after dumping the sense, asc, and
179 * ascq). So, if/when we get something like a power on/reset,
180 * we'll retry the command.
183 dprintf("got check condition\n");
185 sb_len = io->sb_len_wr;
187 log_message(LOG_WARNING, "%s: sense buffer empty\n",
192 sense_buffer = io->sbp;
193 sense_class = (sense_buffer[0] >> 4) & 0x07;
194 code = sense_buffer[0] & 0xf;
196 if (sense_class == 7) {
198 * extended sense data.
200 s = sense_buffer[7] + 8;
202 log_message(LOG_WARNING,
203 "%s: sense buffer too small %d bytes,"
204 " %d bytes too short\n", scsi_dev->name,
208 if ((code == 0x0) || (code == 0x1)) {
209 descriptor_format = 0;
210 sense_key = sense_buffer[2] & 0xf;
215 log_message(LOG_WARNING, "%s: sense result too"
220 asc = sense_buffer[12];
221 ascq = sense_buffer[13];
222 } else if ((code == 0x2) || (code == 0x3)) {
223 descriptor_format = 1;
224 sense_key = sense_buffer[1] & 0xf;
225 asc = sense_buffer[2];
226 ascq = sense_buffer[3];
228 log_message(LOG_WARNING,
229 "%s: invalid sense code 0x%x\n",
230 scsi_dev->name, code);
233 log_message(LOG_WARNING,
234 "%s: sense key 0x%x ASC 0x%x ASCQ 0x%x\n",
235 scsi_dev->name, sense_key, asc, ascq);
238 log_message(LOG_WARNING,
239 "%s: sense buffer too small %d bytes, %d bytes too short\n",
240 scsi_dev->name, sb_len, 4 - sb_len);
244 if (sense_buffer[0] < 15)
245 log_message(LOG_WARNING, "%s: old sense key: 0x%x\n",
246 scsi_dev->name, sense_buffer[0] & 0x0f);
248 log_message(LOG_WARNING, "%s: sense = %2x %2x\n",
249 scsi_dev->name, sense_buffer[0],
251 log_message(LOG_WARNING,
252 "%s: non-extended sense class %d code 0x%0x\n",
253 scsi_dev->name, sense_class, code);
258 for (i = 0, j = 0; (i < s) && (j < 254); i++) {
259 dprintf("i %d, j %d\n", i, j);
260 out_buffer[j++] = hex_str[(sense_buffer[i] & 0xf0) >> 4];
261 out_buffer[j++] = hex_str[sense_buffer[i] & 0x0f];
262 out_buffer[j++] = ' ';
264 out_buffer[j] = '\0';
265 log_message(LOG_WARNING, "%s: sense dump:\n", scsi_dev->name);
266 log_message(LOG_WARNING, "%s: %s\n", scsi_dev->name, out_buffer);
272 static int scsi_dump(struct sysfs_device *scsi_dev, struct sg_io_hdr *io)
274 if (!io->status && !io->host_status && !io->msg_status &&
275 !io->driver_status) {
277 * Impossible, should not be called.
279 log_message(LOG_WARNING, "%s: called with no error\n",
284 log_message(LOG_WARNING, "%s: sg_io failed status 0x%x 0x%x 0x%x 0x%x\n",
285 scsi_dev->name, io->driver_status, io->host_status,
286 io->msg_status, io->status);
287 if (io->status == SCSI_CHECK_CONDITION)
288 return scsi_dump_sense(scsi_dev, io);
293 static int scsi_inquiry(struct sysfs_device *scsi_dev, int fd, unsigned
294 char evpd, unsigned char page, unsigned char *buf,
297 unsigned char inq_cmd[INQUIRY_CMDLEN] =
298 { INQUIRY_CMD, evpd, page, 0, buflen, 0 };
299 unsigned char sense[SENSE_BUFF_LEN];
300 struct sg_io_hdr io_hdr;
303 unsigned char *buffer;
304 int retry = 3; /* rather random */
307 log_message(LOG_WARNING, "buflen %d too long\n", buflen);
310 inq = malloc(OFFSET + sizeof (inq_cmd) + 512);
311 memset(inq, 0, OFFSET + sizeof (inq_cmd) + 512);
312 buffer = inq + OFFSET;
315 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
316 io_hdr.interface_id = 'S';
317 io_hdr.cmd_len = sizeof(inq_cmd);
318 io_hdr.mx_sb_len = sizeof(sense);
319 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
320 io_hdr.dxfer_len = buflen;
321 io_hdr.dxferp = buffer;
322 io_hdr.cmdp = inq_cmd;
324 io_hdr.timeout = DEF_TIMEOUT;
326 if (ioctl(fd, SG_IO, &io_hdr) < 0) {
327 log_message(LOG_WARNING, "%s: ioctl failed: %s\n",
328 scsi_dev->name, strerror(errno));
332 retval = sg_err_category3(&io_hdr);
335 case SG_ERR_CAT_CLEAN:
336 case SG_ERR_CAT_RECOVERED:
341 retval = scsi_dump(scsi_dev, &io_hdr);
346 memcpy(buf, buffer, retval);
347 } else if (retval > 0) {
349 dprintf("%s: Retrying ...\n", scsi_dev->name);
359 static int do_scsi_page0_inquiry(struct sysfs_device *scsi_dev, int fd,
360 char *buffer, int len)
363 char vendor[MAX_ATTR_LEN];
365 memset(buffer, 0, len);
366 retval = scsi_inquiry(scsi_dev, fd, 1, 0x0, buffer, len);
370 if (buffer[1] != 0) {
371 log_message(LOG_WARNING, "%s: page 0 not available.\n",
375 if (buffer[3] > len) {
376 log_message(LOG_WARNING, "%s: page 0 buffer too long %d\n",
377 scsi_dev->name, buffer[3]);
382 * Following check is based on code once included in the 2.5.x
385 * Some ill behaved devices return the standard inquiry here
386 * rather than the evpd data, snoop the data to verify.
388 if (buffer[3] > MODEL_LENGTH) {
390 * If the vendor id appears in the page assume the page is
393 if (sysfs_get_attr(scsi_dev->path, "vendor", vendor,
395 log_message(LOG_WARNING,
396 "%s: cannot get model attribute\n",
400 if (!strncmp(&buffer[VENDOR_LENGTH], vendor, VENDOR_LENGTH)) {
401 log_message(LOG_WARNING, "%s: invalid page0 data\n",
410 * The caller checks that serial is long enough to include the vendor +
413 static int prepend_vendor_model(struct sysfs_device *scsi_dev, char *serial)
415 char attr[MAX_ATTR_LEN];
418 if (sysfs_get_attr(scsi_dev->path, "vendor", attr, MAX_ATTR_LEN)) {
419 log_message(LOG_WARNING, "%s: cannot get vendor attribute\n",
423 strncpy(serial, attr, VENDOR_LENGTH);
424 ind = strlen(serial) - 1;
426 * Remove sysfs added newlines.
428 if (serial[ind] == '\n')
431 if (sysfs_get_attr(scsi_dev->path, "model", attr, MAX_ATTR_LEN)) {
432 log_message(LOG_WARNING, "%s: cannot get model attribute\n",
436 strncat(serial, attr, MODEL_LENGTH);
437 ind = strlen(serial) - 1;
438 if (serial[ind] == '\n')
444 * This is not a complete check, since we are using strncat/cpy
445 * above, ind will never be too large.
447 if (ind != (VENDOR_LENGTH + MODEL_LENGTH)) {
448 log_message(LOG_WARNING, "%s: expected length %d, got length %d\n",
449 scsi_dev->name, (VENDOR_LENGTH + MODEL_LENGTH),
457 * check_fill_0x83_id - check the page 0x83 id, if OK allocate and fill
460 static int check_fill_0x83_id(struct sysfs_device *scsi_dev, char
461 *page_83, const struct scsi_id_search_values
462 *id_search, char *serial, int max_len)
467 * ASSOCIATION must be with the device (value 0)
469 if ((page_83[1] & 0x30) != 0)
472 if ((page_83[1] & 0x0f) != id_search->id_type)
476 * Possibly check NAA sub-type.
478 if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
479 (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
483 * Check for matching code set - ASCII or BINARY.
485 if ((page_83[0] & 0x0f) != id_search->code_set)
489 * page_83[3]: identifier length
492 if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
494 * If not ASCII, use two bytes for each binary value.
499 * Add one byte for the NUL termination, and one for the id_type.
502 if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
503 len += VENDOR_LENGTH + MODEL_LENGTH;
506 log_message(LOG_WARNING, "%s: length %d too short - need %d\n",
507 scsi_dev->name, max_len, len);
511 serial[0] = hex_str[id_search->id_type];
514 * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
515 * the id since it is not unique across all vendors and models,
516 * this differs from SCSI_ID_T10_VENDOR, where the vendor is
517 * included in the identifier.
519 if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
520 if (prepend_vendor_model(scsi_dev, &serial[1]) < 0) {
521 dprintf("prepend failed\n");
525 i = 4; /* offset to the start of the identifier */
527 if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
531 while (i < (4 + page_83[3]))
532 serial[j++] = page_83[i++];
535 * Binary descriptor, convert to ASCII, using two bytes of
536 * ASCII for each byte in the page_83.
538 while (i < (4 + page_83[3])) {
539 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
540 serial[j++] = hex_str[page_83[i] & 0x0f];
547 static int do_scsi_page83_inquiry(struct sysfs_device *scsi_dev, int fd,
548 char *serial, int len)
552 unsigned char page_83[256];
554 memset(page_83, 0, 256);
555 retval = scsi_inquiry(scsi_dev, fd, 1, 0x83, page_83, 255);
559 if (page_83[1] != 0x83) {
560 log_message(LOG_WARNING, "%s: Invalid page 0x83\n",
566 * XXX Some devices (IBM 3542) return all spaces for an identifier if
567 * the LUN is not actually configured. This leads to identifers of
572 * Search for a match in the prioritized id_search_list.
575 id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
578 * Examine each descriptor returned. There is normally only
579 * one or a small number of descriptors.
581 for (j = 4; j <= page_83[3] + 3;
582 j += page_83[j + 3] + 4) {
583 retval = check_fill_0x83_id(scsi_dev, &page_83[j],
584 &id_search_list[id_ind],
586 dprintf("%s id desc %d/%d/%d\n", scsi_dev->name,
587 id_search_list[id_ind].id_type,
588 id_search_list[id_ind].naa_type,
589 id_search_list[id_ind].code_set);
593 } else if (retval < 0) {
594 dprintf(" failed\n");
597 dprintf(" not used\n");
604 static int do_scsi_page80_inquiry(struct sysfs_device *scsi_dev, int fd,
605 char *serial, int max_len)
611 unsigned char buf[256];
614 retval = scsi_inquiry(scsi_dev, fd, 1, 0x80, buf, 255);
618 if (buf[1] != 0x80) {
619 log_message(LOG_WARNING, "%s: Invalid page 0x80\n",
624 len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
626 log_message(LOG_WARNING, "%s: length %d too short - need %d\n",
627 scsi_dev->name, max_len, len);
631 * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
632 * specific type where we prepend '0' + vendor + model.
635 ser_ind = prepend_vendor_model(scsi_dev, &serial[1]);
639 for (i = 4; i < len + 4; i++, ser_ind++)
640 serial[ser_ind] = buf[i];
644 int scsi_get_serial (struct sysfs_device *scsi_dev, const char *devname,
645 int page_code, char *serial, int len)
647 unsigned char page0[256];
654 memset(serial, 0, len);
655 dprintf("opening %s\n", devname);
656 fd = open(devname, O_RDONLY | O_NONBLOCK);
658 log_message(LOG_WARNING, "%s: cannot open %s: %s\n",
659 scsi_dev->name, devname, strerror(errno));
663 if (page_code == 0x80) {
664 if (do_scsi_page80_inquiry(scsi_dev, fd, serial, len)) {
671 } else if (page_code == 0x83) {
672 if (do_scsi_page83_inquiry(scsi_dev, fd, serial, len)) {
679 } else if (page_code != 0x00) {
680 log_message(LOG_WARNING, "%s: unsupported page code 0x%d\n",
681 scsi_dev->name, page_code);
686 * Get page 0, the page of the pages. By default, try from best to
687 * worst of supported pages: 0x83 then 0x80.
689 if (do_scsi_page0_inquiry(scsi_dev, fd, page0, 255)) {
691 * Don't try anything else. Black list if a specific page
692 * should be used for this vendor+model, or maybe have an
693 * optional fall-back to page 0x80 or page 0x83.
699 dprintf("%s: Checking page0\n", scsi_dev->name);
701 for (ind = 4; ind <= page0[3] + 3; ind++)
702 if (page0[ind] == 0x83)
703 if (!do_scsi_page83_inquiry(scsi_dev, fd, serial,
712 for (ind = 4; ind <= page0[3] + 3; ind++)
713 if (page0[ind] == 0x80)
714 if (!do_scsi_page80_inquiry(scsi_dev, fd, serial,
725 log_message(LOG_WARNING, "%s: close failed: %s\n",
726 scsi_dev->name, strerror(errno));