extras/scsi_id/scsi_serial.c

   1 /*
   2  * scsi_serial.c
   3  *
   4  * Code related to requesting and getting an id from a scsi device
   5  *
   6  * Copyright (C) IBM Corp. 2003
   7  *
   8  * Author:
   9  *      Patrick Mansfield<patmans@us.ibm.com>
  10  *
  11  *      This program is free software; you can redistribute it and/or modify it
  12  *      under the terms of the GNU General Public License as published by the
  13  *      Free Software Foundation version 2 of the License.
  14  */
  15
  16 #include <sys/types.h>
  17 #include <sys/ioctl.h>
  18 #include <sys/stat.h>
  19 #include <stdio.h>
  20 #include <errno.h>
  21 #include <string.h>
  22 #include <fcntl.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <syslog.h>
  26 #include <time.h>
  27 #include <inttypes.h>
  28 #include <scsi/scsi.h>
  29 #include <scsi/sg.h>
  30 #include <linux/types.h>
  31 #include <linux/bsg.h>
  32
  33 #include "libudev.h"
  34 #include "libudev-private.h"
  35 #include "scsi.h"
  36 #include "scsi_id.h"
  37
  38 /*
  39  * A priority based list of id, naa, and binary/ascii for the identifier
  40  * descriptor in VPD page 0x83.
  41  *
  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.
  45  */
  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 },
  51         /*
  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
  58          * names.
  59          */
  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 },
  68 };
  69
  70 static const char hex_str[]="0123456789abcdef";
  71
  72 /*
  73  * Values returned in the result/status, only the ones used by the code
  74  * are used here.
  75  */
  76
  77 #define DID_NO_CONNECT                  0x01    /* Unable to connect before timeout */
  78 #define DID_BUS_BUSY                    0x02    /* Bus remain busy until timeout */
  79 #define DID_TIME_OUT                    0x03    /* Timed out for some other reason */
  80 #define DRIVER_TIMEOUT                  0x06
  81 #define DRIVER_SENSE                    0x08    /* Sense_buffer has been set */
  82
  83 /* The following "category" function returns one of the following */
  84 #define SG_ERR_CAT_CLEAN                0       /* No errors or other information */
  85 #define SG_ERR_CAT_MEDIA_CHANGED        1       /* interpreted from sense buffer */
  86 #define SG_ERR_CAT_RESET                2       /* interpreted from sense buffer */
  87 #define SG_ERR_CAT_TIMEOUT              3
  88 #define SG_ERR_CAT_RECOVERED            4       /* Successful command after recovered err */
  89 #define SG_ERR_CAT_NOTSUPPORTED         5       /* Illegal / unsupported command */
  90 #define SG_ERR_CAT_SENSE                98      /* Something else in the sense buffer */
  91 #define SG_ERR_CAT_OTHER                99      /* Some other error/warning */
  92
  93 static int sg_err_category_new(struct udev *udev,
  94                                int scsi_status, int msg_status, int
  95                                host_status, int driver_status, const
  96                                unsigned char *sense_buffer, int sb_len)
  97 {
  98         scsi_status &= 0x7e;
  99
 100         /*
 101          * XXX change to return only two values - failed or OK.
 102          */
 103
 104         if (!scsi_status && !host_status && !driver_status)
 105                 return SG_ERR_CAT_CLEAN;
 106
 107         if ((scsi_status == SCSI_CHECK_CONDITION) ||
 108             (scsi_status == SCSI_COMMAND_TERMINATED) ||
 109             ((driver_status & 0xf) == DRIVER_SENSE)) {
 110                 if (sense_buffer && (sb_len > 2)) {
 111                         int sense_key;
 112                         unsigned char asc;
 113
 114                         if (sense_buffer[0] & 0x2) {
 115                                 sense_key = sense_buffer[1] & 0xf;
 116                                 asc = sense_buffer[2];
 117                         } else {
 118                                 sense_key = sense_buffer[2] & 0xf;
 119                                 asc = (sb_len > 12) ? sense_buffer[12] : 0;
 120                         }
 121
 122                         if (sense_key == RECOVERED_ERROR)
 123                                 return SG_ERR_CAT_RECOVERED;
 124                         else if (sense_key == UNIT_ATTENTION) {
 125                                 if (0x28 == asc)
 126                                         return SG_ERR_CAT_MEDIA_CHANGED;
 127                                 if (0x29 == asc)
 128                                         return SG_ERR_CAT_RESET;
 129                         } else if (sense_key == ILLEGAL_REQUEST) {
 130                                 return SG_ERR_CAT_NOTSUPPORTED;
 131                         }
 132                 }
 133                 return SG_ERR_CAT_SENSE;
 134         }
 135         if (!host_status) {
 136                 if ((host_status == DID_NO_CONNECT) ||
 137                     (host_status == DID_BUS_BUSY) ||
 138                     (host_status == DID_TIME_OUT))
 139                         return SG_ERR_CAT_TIMEOUT;
 140         }
 141         if (!driver_status) {
 142                 if (driver_status == DRIVER_TIMEOUT)
 143                         return SG_ERR_CAT_TIMEOUT;
 144         }
 145         return SG_ERR_CAT_OTHER;
 146 }
 147
 148 static int sg_err_category3(struct udev *udev, struct sg_io_hdr *hp)
 149 {
 150         return sg_err_category_new(udev,
 151                                    hp->status, hp->msg_status,
 152                                    hp->host_status, hp->driver_status,
 153                                    hp->sbp, hp->sb_len_wr);
 154 }
 155
 156 static int sg_err_category4(struct udev *udev, struct sg_io_v4 *hp)
 157 {
 158         return sg_err_category_new(udev, hp->device_status, 0,
 159                                    hp->transport_status, hp->driver_status,
 160                                    (unsigned char *)(uintptr_t)hp->response,
 161                                    hp->response_len);
 162 }
 163
 164 static int scsi_dump_sense(struct udev *udev,
 165                            struct scsi_id_device *dev_scsi,
 166                            unsigned char *sense_buffer, int sb_len)
 167 {
 168         int s;
 169         int code;
 170         int sense_class;
 171         int sense_key;
 172         int asc, ascq;
 173 #ifdef DUMP_SENSE
 174         char out_buffer[256];
 175         int i, j;
 176 #endif
 177
 178         /*
 179          * Figure out and print the sense key, asc and ascq.
 180          *
 181          * If you want to suppress these for a particular drive model, add
 182          * a black list entry in the scsi_id config file.
 183          *
 184          * XXX We probably need to: lookup the sense/asc/ascq in a retry
 185          * table, and if found return 1 (after dumping the sense, asc, and
 186          * ascq). So, if/when we get something like a power on/reset,
 187          * we'll retry the command.
 188          */
 189
 190         dbg(udev, "got check condition\n");
 191
 192         if (sb_len < 1) {
 193                 info(udev, "%s: sense buffer empty\n", dev_scsi->kernel);
 194                 return -1;
 195         }
 196
 197         sense_class = (sense_buffer[0] >> 4) & 0x07;
 198         code = sense_buffer[0] & 0xf;
 199
 200         if (sense_class == 7) {
 201                 /*
 202                  * extended sense data.
 203                  */
 204                 s = sense_buffer[7] + 8;
 205                 if (sb_len < s) {
 206                         info(udev, "%s: sense buffer too small %d bytes, %d bytes too short\n",
 207                             dev_scsi->kernel, sb_len, s - sb_len);
 208                         return -1;
 209                 }
 210                 if ((code == 0x0) || (code == 0x1)) {
 211                         sense_key = sense_buffer[2] & 0xf;
 212                         if (s < 14) {
 213                                 /*
 214                                  * Possible?
 215                                  */
 216                                 info(udev, "%s: sense result too" " small %d bytes\n",
 217                                     dev_scsi->kernel, s);
 218                                 return -1;
 219                         }
 220                         asc = sense_buffer[12];
 221                         ascq = sense_buffer[13];
 222                 } else if ((code == 0x2) || (code == 0x3)) {
 223                         sense_key = sense_buffer[1] & 0xf;
 224                         asc = sense_buffer[2];
 225                         ascq = sense_buffer[3];
 226                 } else {
 227                         info(udev, "%s: invalid sense code 0x%x\n",
 228                             dev_scsi->kernel, code);
 229                         return -1;
 230                 }
 231                 info(udev, "%s: sense key 0x%x ASC 0x%x ASCQ 0x%x\n",
 232                     dev_scsi->kernel, sense_key, asc, ascq);
 233         } else {
 234                 if (sb_len < 4) {
 235                         info(udev, "%s: sense buffer too small %d bytes, %d bytes too short\n",
 236                             dev_scsi->kernel, sb_len, 4 - sb_len);
 237                         return -1;
 238                 }
 239
 240                 if (sense_buffer[0] < 15)
 241                         info(udev, "%s: old sense key: 0x%x\n", dev_scsi->kernel, sense_buffer[0] & 0x0f);
 242                 else
 243                         info(udev, "%s: sense = %2x %2x\n",
 244                             dev_scsi->kernel, sense_buffer[0], sense_buffer[2]);
 245                 info(udev, "%s: non-extended sense class %d code 0x%0x\n",
 246                     dev_scsi->kernel, sense_class, code);
 247
 248         }
 249
 250 #ifdef DUMP_SENSE
 251         for (i = 0, j = 0; (i < s) && (j < 254); i++) {
 252                 dbg(udev, "i %d, j %d\n", i, j);
 253                 out_buffer[j++] = hex_str[(sense_buffer[i] & 0xf0) >> 4];
 254                 out_buffer[j++] = hex_str[sense_buffer[i] & 0x0f];
 255                 out_buffer[j++] = ' ';
 256         }
 257         out_buffer[j] = '\0';
 258         info(udev, "%s: sense dump:\n", dev_scsi->kernel);
 259         info(udev, "%s: %s\n", dev_scsi->kernel, out_buffer);
 260
 261 #endif
 262         return -1;
 263 }
 264
 265 static int scsi_dump(struct udev *udev,
 266                      struct scsi_id_device *dev_scsi, struct sg_io_hdr *io)
 267 {
 268         if (!io->status && !io->host_status && !io->msg_status &&
 269             !io->driver_status) {
 270                 /*
 271                  * Impossible, should not be called.
 272                  */
 273                 info(udev, "%s: called with no error\n", __FUNCTION__);
 274                 return -1;
 275         }
 276
 277         info(udev, "%s: sg_io failed status 0x%x 0x%x 0x%x 0x%x\n",
 278             dev_scsi->kernel, io->driver_status, io->host_status, io->msg_status, io->status);
 279         if (io->status == SCSI_CHECK_CONDITION)
 280                 return scsi_dump_sense(udev, dev_scsi, io->sbp, io->sb_len_wr);
 281         else
 282                 return -1;
 283 }
 284
 285 static int scsi_dump_v4(struct udev *udev,
 286                         struct scsi_id_device *dev_scsi, struct sg_io_v4 *io)
 287 {
 288         if (!io->device_status && !io->transport_status &&
 289             !io->driver_status) {
 290                 /*
 291                  * Impossible, should not be called.
 292                  */
 293                 info(udev, "%s: called with no error\n", __FUNCTION__);
 294                 return -1;
 295         }
 296
 297         info(udev, "%s: sg_io failed status 0x%x 0x%x 0x%x\n",
 298             dev_scsi->kernel, io->driver_status, io->transport_status,
 299              io->device_status);
 300         if (io->device_status == SCSI_CHECK_CONDITION)
 301                 return scsi_dump_sense(udev, dev_scsi, (unsigned char *)(uintptr_t)io->response,
 302                                        io->response_len);
 303         else
 304                 return -1;
 305 }
 306
 307 static int scsi_inquiry(struct udev *udev,
 308                         struct scsi_id_device *dev_scsi, int fd,
 309                         unsigned char evpd, unsigned char page,
 310                         unsigned char *buf, unsigned int buflen)
 311 {
 312         unsigned char inq_cmd[INQUIRY_CMDLEN] =
 313                 { INQUIRY_CMD, evpd, page, 0, buflen, 0 };
 314         unsigned char sense[SENSE_BUFF_LEN];
 315         void *io_buf;
 316         int retval;
 317         int retry = 3; /* rather random */
 318
 319         if (buflen > SCSI_INQ_BUFF_LEN) {
 320                 info(udev, "buflen %d too long\n", buflen);
 321                 return -1;
 322         }
 323
 324 resend:
 325         dbg(udev, "%s evpd %d, page 0x%x\n", dev_scsi->kernel, evpd, page);
 326
 327         if (dev_scsi->use_sg == 4) {
 328                 struct sg_io_v4 io_v4;
 329
 330                 memset(&io_v4, 0, sizeof(struct sg_io_v4));
 331                 io_v4.guard = 'Q';
 332                 io_v4.protocol = BSG_PROTOCOL_SCSI;
 333                 io_v4.subprotocol = BSG_SUB_PROTOCOL_SCSI_CMD;
 334                 io_v4.request_len = sizeof(inq_cmd);
 335                 io_v4.request = (uintptr_t)inq_cmd;
 336                 io_v4.max_response_len = sizeof(sense);
 337                 io_v4.response = (uintptr_t)sense;
 338                 io_v4.din_xfer_len = buflen;
 339                 io_v4.din_xferp = (uintptr_t)buf;
 340                 io_buf = (void *)&io_v4;
 341         } else {
 342                 struct sg_io_hdr io_hdr;
 343
 344                 memset(&io_hdr, 0, sizeof(struct sg_io_hdr));
 345                 io_hdr.interface_id = 'S';
 346                 io_hdr.cmd_len = sizeof(inq_cmd);
 347                 io_hdr.mx_sb_len = sizeof(sense);
 348                 io_hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 349                 io_hdr.dxfer_len = buflen;
 350                 io_hdr.dxferp = buf;
 351                 io_hdr.cmdp = inq_cmd;
 352                 io_hdr.sbp = sense;
 353                 io_hdr.timeout = DEF_TIMEOUT;
 354                 io_buf = (void *)&io_hdr;
 355         }
 356
 357         retval = ioctl(fd, SG_IO, io_buf);
 358         if (retval < 0) {
 359                 if ((errno == EINVAL || errno == ENOSYS) && dev_scsi->use_sg == 4) {
 360                         dev_scsi->use_sg = 3;
 361                         goto resend;
 362                 }
 363                 info(udev, "%s: ioctl failed: %s\n", dev_scsi->kernel, strerror(errno));
 364                 goto error;
 365         }
 366
 367         if (dev_scsi->use_sg == 4)
 368                 retval = sg_err_category4(udev, io_buf);
 369         else
 370                 retval = sg_err_category3(udev, io_buf);
 371
 372         switch (retval) {
 373                 case SG_ERR_CAT_NOTSUPPORTED:
 374                         buf[1] = 0;
 375                         /* Fallthrough */
 376                 case SG_ERR_CAT_CLEAN:
 377                 case SG_ERR_CAT_RECOVERED:
 378                         retval = 0;
 379                         break;
 380
 381                 default:
 382                         if (dev_scsi->use_sg == 4)
 383                                 retval = scsi_dump_v4(udev, dev_scsi, io_buf);
 384                         else
 385                                 retval = scsi_dump(udev, dev_scsi, io_buf);
 386         }
 387
 388         if (!retval) {
 389                 retval = buflen;
 390         } else if (retval > 0) {
 391                 if (--retry > 0) {
 392                         dbg(udev, "%s: Retrying ...\n", dev_scsi->kernel);
 393                         goto resend;
 394                 }
 395                 retval = -1;
 396         }
 397
 398 error:
 399         if (retval < 0)
 400                 info(udev, "%s: Unable to get INQUIRY vpd %d page 0x%x.\n",
 401                     dev_scsi->kernel, evpd, page);
 402
 403         return retval;
 404 }
 405
 406 /* Get list of supported EVPD pages */
 407 static int do_scsi_page0_inquiry(struct udev *udev,
 408                                  struct scsi_id_device *dev_scsi, int fd,
 409                                  unsigned char *buffer, unsigned int len)
 410 {
 411         int retval;
 412
 413         memset(buffer, 0, len);
 414         retval = scsi_inquiry(udev, dev_scsi, fd, 1, 0x0, buffer, len);
 415         if (retval < 0)
 416                 return 1;
 417
 418         if (buffer[1] != 0) {
 419                 info(udev, "%s: page 0 not available.\n", dev_scsi->kernel);
 420                 return 1;
 421         }
 422         if (buffer[3] > len) {
 423                 info(udev, "%s: page 0 buffer too long %d\n", dev_scsi->kernel,  buffer[3]);
 424                 return 1;
 425         }
 426
 427         /*
 428          * Following check is based on code once included in the 2.5.x
 429          * kernel.
 430          *
 431          * Some ill behaved devices return the standard inquiry here
 432          * rather than the evpd data, snoop the data to verify.
 433          */
 434         if (buffer[3] > MODEL_LENGTH) {
 435                 /*
 436                  * If the vendor id appears in the page assume the page is
 437                  * invalid.
 438                  */
 439                 if (!strncmp((char *)&buffer[VENDOR_LENGTH], dev_scsi->vendor, VENDOR_LENGTH)) {
 440                         info(udev, "%s: invalid page0 data\n", dev_scsi->kernel);
 441                         return 1;
 442                 }
 443         }
 444         return 0;
 445 }
 446
 447 /*
 448  * The caller checks that serial is long enough to include the vendor +
 449  * model.
 450  */
 451 static int prepend_vendor_model(struct udev *udev,
 452                                 struct scsi_id_device *dev_scsi, char *serial)
 453 {
 454         int ind;
 455
 456         strncpy(serial, dev_scsi->vendor, VENDOR_LENGTH);
 457         strncat(serial, dev_scsi->model, MODEL_LENGTH);
 458         ind = strlen(serial);
 459
 460         /*
 461          * This is not a complete check, since we are using strncat/cpy
 462          * above, ind will never be too large.
 463          */
 464         if (ind != (VENDOR_LENGTH + MODEL_LENGTH)) {
 465                 info(udev, "%s: expected length %d, got length %d\n",
 466                      dev_scsi->kernel, (VENDOR_LENGTH + MODEL_LENGTH), ind);
 467                 return -1;
 468         }
 469         return ind;
 470 }
 471
 472 /**
 473  * check_fill_0x83_id - check the page 0x83 id, if OK allocate and fill
 474  * serial number.
 475  **/
 476 static int check_fill_0x83_id(struct udev *udev,
 477                               struct scsi_id_device *dev_scsi,
 478                               unsigned char *page_83,
 479                               const struct scsi_id_search_values
 480                               *id_search, char *serial, char *serial_short, int max_len)
 481 {
 482         int i, j, s, len;
 483
 484         /*
 485          * ASSOCIATION must be with the device (value 0)
 486          */
 487         if ((page_83[1] & 0x30) != 0)
 488                 return 1;
 489
 490         if ((page_83[1] & 0x0f) != id_search->id_type)
 491                 return 1;
 492
 493         /*
 494          * Possibly check NAA sub-type.
 495          */
 496         if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
 497             (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
 498                 return 1;
 499
 500         /*
 501          * Check for matching code set - ASCII or BINARY.
 502          */
 503         if ((page_83[0] & 0x0f) != id_search->code_set)
 504                 return 1;
 505
 506         /*
 507          * page_83[3]: identifier length
 508          */
 509         len = page_83[3];
 510         if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
 511                 /*
 512                  * If not ASCII, use two bytes for each binary value.
 513                  */
 514                 len *= 2;
 515
 516         /*
 517          * Add one byte for the NUL termination, and one for the id_type.
 518          */
 519         len += 2;
 520         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 521                 len += VENDOR_LENGTH + MODEL_LENGTH;
 522
 523         if (max_len < len) {
 524                 info(udev, "%s: length %d too short - need %d\n",
 525                     dev_scsi->kernel, max_len, len);
 526                 return 1;
 527         }
 528
 529         serial[0] = hex_str[id_search->id_type];
 530
 531         /*
 532          * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
 533          * the id since it is not unique across all vendors and models,
 534          * this differs from SCSI_ID_T10_VENDOR, where the vendor is
 535          * included in the identifier.
 536          */
 537         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 538                 if (prepend_vendor_model(udev, dev_scsi, &serial[1]) < 0) {
 539                         dbg(udev, "prepend failed\n");
 540                         return 1;
 541                 }
 542
 543         i = 4; /* offset to the start of the identifier */
 544         s = j = strlen(serial);
 545         if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
 546                 /*
 547                  * ASCII descriptor.
 548                  */
 549                 while (i < (4 + page_83[3]))
 550                         serial[j++] = page_83[i++];
 551         } else {
 552                 /*
 553                  * Binary descriptor, convert to ASCII, using two bytes of
 554                  * ASCII for each byte in the page_83.
 555                  */
 556                 while (i < (4 + page_83[3])) {
 557                         serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 558                         serial[j++] = hex_str[page_83[i] & 0x0f];
 559                         i++;
 560                 }
 561         }
 562
 563         strcpy(serial_short, &serial[s]);
 564         return 0;
 565 }
 566
 567 /* Extract the raw binary from VPD 0x83 pre-SPC devices */
 568 static int check_fill_0x83_prespc3(struct udev *udev,
 569                                    struct scsi_id_device *dev_scsi,
 570                                    unsigned char *page_83,
 571                                    const struct scsi_id_search_values
 572                                    *id_search, char *serial, char *serial_short, int max_len)
 573 {
 574         int i, j;
 575
 576         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 577         serial[0] = hex_str[id_search->id_type];
 578         /* serial has been memset to zero before */
 579         j = strlen(serial);     /* j = 1; */
 580
 581         for (i = 0; i < page_83[3]; ++i) {
 582                 serial[j++] = hex_str[(page_83[4+i] & 0xf0) >> 4];
 583                 serial[j++] = hex_str[ page_83[4+i] & 0x0f];
 584         }
 585         strcpy(serial_short, serial);
 586         return 0;
 587 }
 588
 589
 590 /* Get device identification VPD page */
 591 static int do_scsi_page83_inquiry(struct udev *udev,
 592                                   struct scsi_id_device *dev_scsi, int fd,
 593                                   char *serial, char *serial_short, int len)
 594 {
 595         int retval;
 596         unsigned int id_ind, j;
 597         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 598
 599         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 600         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83,
 601                               SCSI_INQ_BUFF_LEN);
 602         if (retval < 0)
 603                 return 1;
 604
 605         if (page_83[1] != PAGE_83) {
 606                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 607                 return 1;
 608         }
 609
 610         /*
 611          * XXX Some devices (IBM 3542) return all spaces for an identifier if
 612          * the LUN is not actually configured. This leads to identifiers of
 613          * the form: "1            ".
 614          */
 615
 616         /*
 617          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 618          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 619          *
 620          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 621          * encoded hexi-decimal in the 16 bytes following the initial
 622          * 4-byte page 83 reply header.
 623          *
 624          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 625          * of an Identification descriptor.  The 3rd byte of the first
 626          * Identification descriptor is a reserved (BSZ) byte field.
 627          *
 628          * Reference the 7th byte of the page 83 reply to determine
 629          * whether the reply is compliant with SCSI-2 or SPC-2/3
 630          * specifications.  A zero value in the 7th byte indicates
 631          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 632          * first Identification descriptor).  This byte will be non-zero
 633          * for a SCSI-2 conformant page 83 reply from these EMC
 634          * Symmetrix models since the 7th byte of the reply corresponds
 635          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 636          * 0x006048.
 637          */
 638
 639         if (page_83[6] != 0)
 640                 return check_fill_0x83_prespc3(udev,
 641                                                dev_scsi, page_83, id_search_list,
 642                                                serial, serial_short, len);
 643
 644         /*
 645          * Search for a match in the prioritized id_search_list.
 646          */
 647         for (id_ind = 0;
 648              id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
 649              id_ind++) {
 650                 /*
 651                  * Examine each descriptor returned. There is normally only
 652                  * one or a small number of descriptors.
 653                  */
 654                 for (j = 4; j <= (unsigned int)page_83[3] + 3; j += page_83[j + 3] + 4) {
 655                         retval = check_fill_0x83_id(udev,
 656                                                     dev_scsi, &page_83[j],
 657                                                     &id_search_list[id_ind],
 658                                                     serial, serial_short, len);
 659                         dbg(udev, "%s id desc %d/%d/%d\n", dev_scsi->kernel,
 660                                 id_search_list[id_ind].id_type,
 661                                 id_search_list[id_ind].naa_type,
 662                                 id_search_list[id_ind].code_set);
 663                         if (!retval) {
 664                                 dbg(udev, "  used\n");
 665                                 return retval;
 666                         } else if (retval < 0) {
 667                                 dbg(udev, "  failed\n");
 668                                 return retval;
 669                         } else {
 670                                 dbg(udev, "  not used\n");
 671                         }
 672                 }
 673         }
 674         return 1;
 675 }
 676
 677 /*
 678  * Get device identification VPD page for older SCSI-2 device which is not
 679  * compliant with either SPC-2 or SPC-3 format.
 680  *
 681  * Return the hard coded error code value 2 if the page 83 reply is not
 682  * conformant to the SCSI-2 format.
 683  */
 684 static int do_scsi_page83_prespc3_inquiry(struct udev *udev,
 685                                           struct scsi_id_device *dev_scsi, int fd,
 686                                           char *serial, char *serial_short, int len)
 687 {
 688         int retval;
 689         int i, j;
 690         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 691
 692         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 693         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83, SCSI_INQ_BUFF_LEN);
 694         if (retval < 0)
 695                 return 1;
 696
 697         if (page_83[1] != PAGE_83) {
 698                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 699                 return 1;
 700         }
 701         /*
 702          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 703          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 704          *
 705          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 706          * encoded hexi-decimal in the 16 bytes following the initial
 707          * 4-byte page 83 reply header.
 708          *
 709          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 710          * of an Identification descriptor.  The 3rd byte of the first
 711          * Identification descriptor is a reserved (BSZ) byte field.
 712          *
 713          * Reference the 7th byte of the page 83 reply to determine
 714          * whether the reply is compliant with SCSI-2 or SPC-2/3
 715          * specifications.  A zero value in the 7th byte indicates
 716          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 717          * first Identification descriptor).  This byte will be non-zero
 718          * for a SCSI-2 conformant page 83 reply from these EMC
 719          * Symmetrix models since the 7th byte of the reply corresponds
 720          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 721          * 0x006048.
 722          */
 723         if (page_83[6] == 0)
 724                 return 2;
 725
 726         serial[0] = hex_str[id_search_list[0].id_type];
 727         /*
 728          * The first four bytes contain data, not a descriptor.
 729          */
 730         i = 4;
 731         j = strlen(serial);
 732         /*
 733          * Binary descriptor, convert to ASCII,
 734          * using two bytes of ASCII for each byte
 735          * in the page_83.
 736          */
 737         while (i < (page_83[3]+4)) {
 738                 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 739                 serial[j++] = hex_str[page_83[i] & 0x0f];
 740                 i++;
 741         }
 742         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 743         return 0;
 744 }
 745
 746 /* Get unit serial number VPD page */
 747 static int do_scsi_page80_inquiry(struct udev *udev,
 748                                   struct scsi_id_device *dev_scsi, int fd,
 749                                   char *serial, char *serial_short, int max_len)
 750 {
 751         int retval;
 752         int ser_ind;
 753         int i;
 754         int len;
 755         unsigned char buf[SCSI_INQ_BUFF_LEN];
 756
 757         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 758         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_80, buf, SCSI_INQ_BUFF_LEN);
 759         if (retval < 0)
 760                 return retval;
 761
 762         if (buf[1] != PAGE_80) {
 763                 info(udev, "%s: Invalid page 0x80\n", dev_scsi->kernel);
 764                 return 1;
 765         }
 766
 767         len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
 768         if (max_len < len) {
 769                 info(udev, "%s: length %d too short - need %d\n",
 770                      dev_scsi->kernel, max_len, len);
 771                 return 1;
 772         }
 773         /*
 774          * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
 775          * specific type where we prepend '0' + vendor + model.
 776          */
 777         serial[0] = 'S';
 778         ser_ind = prepend_vendor_model(udev, dev_scsi, &serial[1]);
 779         if (ser_ind < 0)
 780                 return 1;
 781         len = buf[3];
 782         for (i = 4; i < len + 4; i++, ser_ind++)
 783                 serial[ser_ind] = buf[i];
 784         memcpy(serial_short, &buf[4], len);
 785         serial_short[len] = '\0';
 786         return 0;
 787 }
 788
 789 int scsi_std_inquiry(struct udev *udev,
 790                      struct scsi_id_device *dev_scsi, const char *devname)
 791 {
 792         int fd;
 793         unsigned char buf[SCSI_INQ_BUFF_LEN];
 794         struct stat statbuf;
 795         int err = 0;
 796
 797         dbg(udev, "opening %s\n", devname);
 798         fd = open(devname, O_RDONLY | O_NONBLOCK);
 799         if (fd < 0) {
 800                 info(udev, "scsi_id: cannot open %s: %s\n",
 801                      devname, strerror(errno));
 802                 return 1;
 803         }
 804
 805         if (fstat(fd, &statbuf) < 0) {
 806                 info(udev, "scsi_id: cannot stat %s: %s\n",
 807                      devname, strerror(errno));
 808                 err = 2;
 809                 goto out;
 810         }
 811         sprintf(dev_scsi->kernel,"%d:%d", major(statbuf.st_rdev),
 812                 minor(statbuf.st_rdev));
 813
 814         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 815         err = scsi_inquiry(udev, dev_scsi, fd, 0, 0, buf, SCSI_INQ_BUFF_LEN);
 816         if (err < 0)
 817                 goto out;
 818
 819         err = 0;
 820         memcpy(dev_scsi->vendor, buf + 8, 8);
 821         dev_scsi->vendor[8] = '\0';
 822         memcpy(dev_scsi->model, buf + 16, 16);
 823         dev_scsi->model[16] = '\0';
 824         memcpy(dev_scsi->revision, buf + 32, 4);
 825         dev_scsi->revision[4] = '\0';
 826         sprintf(dev_scsi->type,"%x", buf[0] & 0x1f);
 827
 828 out:
 829         close(fd);
 830         return err;
 831 }
 832
 833 int scsi_get_serial(struct udev *udev,
 834                     struct scsi_id_device *dev_scsi, const char *devname,
 835                     int page_code, int len)
 836 {
 837         unsigned char page0[SCSI_INQ_BUFF_LEN];
 838         int fd = -1;
 839         int cnt = 10;
 840         int ind;
 841         int retval;
 842
 843         memset(dev_scsi->serial, 0, len);
 844         dbg(udev, "opening %s\n", devname);
 845         while (--cnt) {
 846                 const struct timespec duration = { 0, 500 * 1000 * 1000 };
 847
 848                 fd = open(devname, O_RDONLY | O_NONBLOCK);
 849                 if (fd >= 0)
 850                         break;
 851                 info(udev, "%s: cannot open %s: %s\n", dev_scsi->kernel, devname, strerror(errno));
 852                 if (errno != EBUSY)
 853                         break;
 854                 nanosleep(&duration, NULL);
 855         }
 856         if (fd < 0)
 857                 return 1;
 858
 859         if (page_code == PAGE_80) {
 860                 if (do_scsi_page80_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 861                         retval = 1;
 862                         goto completed;
 863                 } else  {
 864                         retval = 0;
 865                         goto completed;
 866                 }
 867         } else if (page_code == PAGE_83) {
 868                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 869                         retval = 1;
 870                         goto completed;
 871                 } else  {
 872                         retval = 0;
 873                         goto completed;
 874                 }
 875         } else if (page_code == PAGE_83_PRE_SPC3) {
 876                 retval = do_scsi_page83_prespc3_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len);
 877                 if (retval) {
 878                         /*
 879                          * Fallback to servicing a SPC-2/3 compliant page 83
 880                          * inquiry if the page 83 reply format does not
 881                          * conform to pre-SPC3 expectations.
 882                          */
 883                         if (retval == 2) {
 884                                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 885                                         retval = 1;
 886                                         goto completed;
 887                                 } else  {
 888                                         retval = 0;
 889                                         goto completed;
 890                                 }
 891                         }
 892                         else {
 893                                 retval = 1;
 894                                 goto completed;
 895                         }
 896                 } else  {
 897                         retval = 0;
 898                         goto completed;
 899                 }
 900         } else if (page_code != 0x00) {
 901                 info(udev, "%s: unsupported page code 0x%d\n", dev_scsi->kernel, page_code);
 902                 return 1;
 903         }
 904
 905         /*
 906          * Get page 0, the page of the pages. By default, try from best to
 907          * worst of supported pages: 0x83 then 0x80.
 908          */
 909         if (do_scsi_page0_inquiry(udev, dev_scsi, fd, page0, SCSI_INQ_BUFF_LEN)) {
 910                 /*
 911                  * Don't try anything else. Black list if a specific page
 912                  * should be used for this vendor+model, or maybe have an
 913                  * optional fall-back to page 0x80 or page 0x83.
 914                  */
 915                 retval = 1;
 916                 goto completed;
 917         }
 918
 919         dbg(udev, "%s: Checking page0\n", dev_scsi->kernel);
 920
 921         for (ind = 4; ind <= page0[3] + 3; ind++)
 922                 if (page0[ind] == PAGE_83)
 923                         if (!do_scsi_page83_inquiry(udev, dev_scsi, fd,
 924                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 925                                 /*
 926                                  * Success
 927                                  */
 928                                 retval = 0;
 929                                 goto completed;
 930                         }
 931
 932         for (ind = 4; ind <= page0[3] + 3; ind++)
 933                 if (page0[ind] == PAGE_80)
 934                         if (!do_scsi_page80_inquiry(udev, dev_scsi, fd,
 935                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 936                                 /*
 937                                  * Success
 938                                  */
 939                                 retval = 0;
 940                                 goto completed;
 941                         }
 942         retval = 1;
 943
 944 completed:
 945         close(fd);
 946         return retval;
 947 }