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