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