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