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 #include "bsg.h"
  33
  34 #include "libudev.h"
  35 #include "libudev-private.h"
  36 #include "scsi.h"
  37 #include "scsi_id.h"
  38
  39 /*
  40  * A priority based list of id, naa, and binary/ascii for the identifier
  41  * descriptor in VPD page 0x83.
  42  *
  43  * Brute force search for a match starting with the first value in the
  44  * following id_search_list. This is not a performance issue, since there
  45  * is normally one or some small number of descriptors.
  46  */
  47 static const struct scsi_id_search_values id_search_list[] = {
  48         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG_EXTENDED,  SCSI_ID_BINARY },
  49         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG_EXTENDED,  SCSI_ID_ASCII },
  50         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG,   SCSI_ID_BINARY },
  51         { SCSI_ID_NAA,  SCSI_ID_NAA_IEEE_REG,   SCSI_ID_ASCII },
  52         /*
  53          * Devices already exist using NAA values that are now marked
  54          * reserved. These should not conflict with other values, or it is
  55          * a bug in the device. As long as we find the IEEE extended one
  56          * first, we really don't care what other ones are used. Using
  57          * don't care here means that a device that returns multiple
  58          * non-IEEE descriptors in a random order will get different
  59          * names.
  60          */
  61         { SCSI_ID_NAA,  SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  62         { SCSI_ID_NAA,  SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  63         { SCSI_ID_EUI_64,       SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  64         { SCSI_ID_EUI_64,       SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  65         { SCSI_ID_T10_VENDOR,   SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  66         { SCSI_ID_T10_VENDOR,   SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  67         { SCSI_ID_VENDOR_SPECIFIC,      SCSI_ID_NAA_DONT_CARE,  SCSI_ID_BINARY },
  68         { SCSI_ID_VENDOR_SPECIFIC,      SCSI_ID_NAA_DONT_CARE,  SCSI_ID_ASCII },
  69 };
  70
  71 static const char hex_str[]="0123456789abcdef";
  72
  73 /*
  74  * Values returned in the result/status, only the ones used by the code
  75  * are used here.
  76  */
  77
  78 #define DID_NO_CONNECT                  0x01    /* Unable to connect before timeout */
  79 #define DID_BUS_BUSY                    0x02    /* Bus remain busy until timeout */
  80 #define DID_TIME_OUT                    0x03    /* Timed out for some other reason */
  81 #define DRIVER_TIMEOUT                  0x06
  82 #define DRIVER_SENSE                    0x08    /* Sense_buffer has been set */
  83
  84 /* The following "category" function returns one of the following */
  85 #define SG_ERR_CAT_CLEAN                0       /* No errors or other information */
  86 #define SG_ERR_CAT_MEDIA_CHANGED        1       /* interpreted from sense buffer */
  87 #define SG_ERR_CAT_RESET                2       /* interpreted from sense buffer */
  88 #define SG_ERR_CAT_TIMEOUT              3
  89 #define SG_ERR_CAT_RECOVERED            4       /* Successful command after recovered err */
  90 #define SG_ERR_CAT_NOTSUPPORTED         5       /* Illegal / unsupported command */
  91 #define SG_ERR_CAT_SENSE                98      /* Something else in the sense buffer */
  92 #define SG_ERR_CAT_OTHER                99      /* Some other error/warning */
  93
  94 static int sg_err_category_new(struct udev *udev,
  95                                int scsi_status, int msg_status, int
  96                                host_status, int driver_status, const
  97                                unsigned char *sense_buffer, int sb_len)
  98 {
  99         scsi_status &= 0x7e;
 100
 101         /*
 102          * XXX change to return only two values - failed or OK.
 103          */
 104
 105         if (!scsi_status && !host_status && !driver_status)
 106                 return SG_ERR_CAT_CLEAN;
 107
 108         if ((scsi_status == SCSI_CHECK_CONDITION) ||
 109             (scsi_status == SCSI_COMMAND_TERMINATED) ||
 110             ((driver_status & 0xf) == DRIVER_SENSE)) {
 111                 if (sense_buffer && (sb_len > 2)) {
 112                         int sense_key;
 113                         unsigned char asc;
 114
 115                         if (sense_buffer[0] & 0x2) {
 116                                 sense_key = sense_buffer[1] & 0xf;
 117                                 asc = sense_buffer[2];
 118                         } else {
 119                                 sense_key = sense_buffer[2] & 0xf;
 120                                 asc = (sb_len > 12) ? sense_buffer[12] : 0;
 121                         }
 122
 123                         if (sense_key == RECOVERED_ERROR)
 124                                 return SG_ERR_CAT_RECOVERED;
 125                         else if (sense_key == UNIT_ATTENTION) {
 126                                 if (0x28 == asc)
 127                                         return SG_ERR_CAT_MEDIA_CHANGED;
 128                                 if (0x29 == asc)
 129                                         return SG_ERR_CAT_RESET;
 130                         } else if (sense_key == ILLEGAL_REQUEST) {
 131                                 return SG_ERR_CAT_NOTSUPPORTED;
 132                         }
 133                 }
 134                 return SG_ERR_CAT_SENSE;
 135         }
 136         if (!host_status) {
 137                 if ((host_status == DID_NO_CONNECT) ||
 138                     (host_status == DID_BUS_BUSY) ||
 139                     (host_status == DID_TIME_OUT))
 140                         return SG_ERR_CAT_TIMEOUT;
 141         }
 142         if (!driver_status) {
 143                 if (driver_status == DRIVER_TIMEOUT)
 144                         return SG_ERR_CAT_TIMEOUT;
 145         }
 146         return SG_ERR_CAT_OTHER;
 147 }
 148
 149 static int sg_err_category3(struct udev *udev, struct sg_io_hdr *hp)
 150 {
 151         return sg_err_category_new(udev,
 152                                    hp->status, hp->msg_status,
 153                                    hp->host_status, hp->driver_status,
 154                                    hp->sbp, hp->sb_len_wr);
 155 }
 156
 157 static int sg_err_category4(struct udev *udev, struct sg_io_v4 *hp)
 158 {
 159         return sg_err_category_new(udev, hp->device_status, 0,
 160                                    hp->transport_status, hp->driver_status,
 161                                    (unsigned char *)(uintptr_t)hp->response,
 162                                    hp->response_len);
 163 }
 164
 165 static int scsi_dump_sense(struct udev *udev,
 166                            struct scsi_id_device *dev_scsi,
 167                            unsigned char *sense_buffer, int sb_len)
 168 {
 169         int s;
 170         int code;
 171         int sense_class;
 172         int sense_key;
 173         int descriptor_format;
 174         int asc, ascq;
 175 #ifdef DUMP_SENSE
 176         char out_buffer[256];
 177         int i, j;
 178 #endif
 179
 180         /*
 181          * Figure out and print the sense key, asc and ascq.
 182          *
 183          * If you want to suppress these for a particular drive model, add
 184          * a black list entry in the scsi_id config file.
 185          *
 186          * XXX We probably need to: lookup the sense/asc/ascq in a retry
 187          * table, and if found return 1 (after dumping the sense, asc, and
 188          * ascq). So, if/when we get something like a power on/reset,
 189          * we'll retry the command.
 190          */
 191
 192         dbg(udev, "got check condition\n");
 193
 194         if (sb_len < 1) {
 195                 info(udev, "%s: sense buffer empty\n", dev_scsi->kernel);
 196                 return -1;
 197         }
 198
 199         sense_class = (sense_buffer[0] >> 4) & 0x07;
 200         code = sense_buffer[0] & 0xf;
 201
 202         if (sense_class == 7) {
 203                 /*
 204                  * extended sense data.
 205                  */
 206                 s = sense_buffer[7] + 8;
 207                 if (sb_len < s) {
 208                         info(udev, "%s: sense buffer too small %d bytes, %d bytes too short\n",
 209                             dev_scsi->kernel, sb_len, s - sb_len);
 210                         return -1;
 211                 }
 212                 if ((code == 0x0) || (code == 0x1)) {
 213                         descriptor_format = 0;
 214                         sense_key = sense_buffer[2] & 0xf;
 215                         if (s < 14) {
 216                                 /*
 217                                  * Possible?
 218                                  */
 219                                 info(udev, "%s: sense result too" " small %d bytes\n",
 220                                     dev_scsi->kernel, s);
 221                                 return -1;
 222                         }
 223                         asc = sense_buffer[12];
 224                         ascq = sense_buffer[13];
 225                 } else if ((code == 0x2) || (code == 0x3)) {
 226                         descriptor_format = 1;
 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 {
 486         int i, j, s, len;
 487
 488         /*
 489          * ASSOCIATION must be with the device (value 0)
 490          */
 491         if ((page_83[1] & 0x30) != 0)
 492                 return 1;
 493
 494         if ((page_83[1] & 0x0f) != id_search->id_type)
 495                 return 1;
 496
 497         /*
 498          * Possibly check NAA sub-type.
 499          */
 500         if ((id_search->naa_type != SCSI_ID_NAA_DONT_CARE) &&
 501             (id_search->naa_type != (page_83[4] & 0xf0) >> 4))
 502                 return 1;
 503
 504         /*
 505          * Check for matching code set - ASCII or BINARY.
 506          */
 507         if ((page_83[0] & 0x0f) != id_search->code_set)
 508                 return 1;
 509
 510         /*
 511          * page_83[3]: identifier length
 512          */
 513         len = page_83[3];
 514         if ((page_83[0] & 0x0f) != SCSI_ID_ASCII)
 515                 /*
 516                  * If not ASCII, use two bytes for each binary value.
 517                  */
 518                 len *= 2;
 519
 520         /*
 521          * Add one byte for the NUL termination, and one for the id_type.
 522          */
 523         len += 2;
 524         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 525                 len += VENDOR_LENGTH + MODEL_LENGTH;
 526
 527         if (max_len < len) {
 528                 info(udev, "%s: length %d too short - need %d\n",
 529                     dev_scsi->kernel, max_len, len);
 530                 return 1;
 531         }
 532
 533         serial[0] = hex_str[id_search->id_type];
 534
 535         /*
 536          * For SCSI_ID_VENDOR_SPECIFIC prepend the vendor and model before
 537          * the id since it is not unique across all vendors and models,
 538          * this differs from SCSI_ID_T10_VENDOR, where the vendor is
 539          * included in the identifier.
 540          */
 541         if (id_search->id_type == SCSI_ID_VENDOR_SPECIFIC)
 542                 if (prepend_vendor_model(udev, dev_scsi, &serial[1]) < 0) {
 543                         dbg(udev, "prepend failed\n");
 544                         return 1;
 545                 }
 546
 547         i = 4; /* offset to the start of the identifier */
 548         s = j = strlen(serial);
 549         if ((page_83[0] & 0x0f) == SCSI_ID_ASCII) {
 550                 /*
 551                  * ASCII descriptor.
 552                  */
 553                 while (i < (4 + page_83[3]))
 554                         serial[j++] = page_83[i++];
 555         } else {
 556                 /*
 557                  * Binary descriptor, convert to ASCII, using two bytes of
 558                  * ASCII for each byte in the page_83.
 559                  */
 560                 while (i < (4 + page_83[3])) {
 561                         serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 562                         serial[j++] = hex_str[page_83[i] & 0x0f];
 563                         i++;
 564                 }
 565         }
 566
 567         strcpy(serial_short, &serial[s]);
 568         return 0;
 569 }
 570
 571 /* Extract the raw binary from VPD 0x83 pre-SPC devices */
 572 static int check_fill_0x83_prespc3(struct udev *udev,
 573                                    struct scsi_id_device *dev_scsi,
 574                                    unsigned char *page_83,
 575                                    const struct scsi_id_search_values
 576                                    *id_search, char *serial, char *serial_short, int max_len)
 577 {
 578         int i, j;
 579
 580         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 581         serial[0] = hex_str[id_search->id_type];
 582         /* serial has been memset to zero before */
 583         j = strlen(serial);     /* j = 1; */
 584
 585         for (i = 0; i < page_83[3]; ++i) {
 586                 serial[j++] = hex_str[(page_83[4+i] & 0xf0) >> 4];
 587                 serial[j++] = hex_str[ page_83[4+i] & 0x0f];
 588         }
 589         strcpy(serial_short, serial);
 590         return 0;
 591 }
 592
 593
 594 /* Get device identification VPD page */
 595 static int do_scsi_page83_inquiry(struct udev *udev,
 596                                   struct scsi_id_device *dev_scsi, int fd,
 597                                   char *serial, char *serial_short, int len)
 598 {
 599         int retval;
 600         unsigned int id_ind, j;
 601         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 602
 603         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 604         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83,
 605                               SCSI_INQ_BUFF_LEN);
 606         if (retval < 0)
 607                 return 1;
 608
 609         if (page_83[1] != PAGE_83) {
 610                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 611                 return 1;
 612         }
 613
 614         /*
 615          * XXX Some devices (IBM 3542) return all spaces for an identifier if
 616          * the LUN is not actually configured. This leads to identifiers of
 617          * the form: "1            ".
 618          */
 619
 620         /*
 621          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 622          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 623          *
 624          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 625          * encoded hexi-decimal in the 16 bytes following the initial
 626          * 4-byte page 83 reply header.
 627          *
 628          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 629          * of an Identification descriptor.  The 3rd byte of the first
 630          * Identification descriptor is a reserved (BSZ) byte field.
 631          *
 632          * Reference the 7th byte of the page 83 reply to determine
 633          * whether the reply is compliant with SCSI-2 or SPC-2/3
 634          * specifications.  A zero value in the 7th byte indicates
 635          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 636          * first Identification descriptor).  This byte will be non-zero
 637          * for a SCSI-2 conformant page 83 reply from these EMC
 638          * Symmetrix models since the 7th byte of the reply corresponds
 639          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 640          * 0x006048.
 641          */
 642
 643         if (page_83[6] != 0)
 644                 return check_fill_0x83_prespc3(udev,
 645                                                dev_scsi, page_83, id_search_list,
 646                                                serial, serial_short, len);
 647
 648         /*
 649          * Search for a match in the prioritized id_search_list.
 650          */
 651         for (id_ind = 0;
 652              id_ind < sizeof(id_search_list)/sizeof(id_search_list[0]);
 653              id_ind++) {
 654                 /*
 655                  * Examine each descriptor returned. There is normally only
 656                  * one or a small number of descriptors.
 657                  */
 658                 for (j = 4; j <= (unsigned int)page_83[3] + 3; j += page_83[j + 3] + 4) {
 659                         retval = check_fill_0x83_id(udev,
 660                                                     dev_scsi, &page_83[j],
 661                                                     &id_search_list[id_ind],
 662                                                     serial, serial_short, len);
 663                         dbg(udev, "%s id desc %d/%d/%d\n", dev_scsi->kernel,
 664                                 id_search_list[id_ind].id_type,
 665                                 id_search_list[id_ind].naa_type,
 666                                 id_search_list[id_ind].code_set);
 667                         if (!retval) {
 668                                 dbg(udev, "  used\n");
 669                                 return retval;
 670                         } else if (retval < 0) {
 671                                 dbg(udev, "  failed\n");
 672                                 return retval;
 673                         } else {
 674                                 dbg(udev, "  not used\n");
 675                         }
 676                 }
 677         }
 678         return 1;
 679 }
 680
 681 /*
 682  * Get device identification VPD page for older SCSI-2 device which is not
 683  * compliant with either SPC-2 or SPC-3 format.
 684  *
 685  * Return the hard coded error code value 2 if the page 83 reply is not
 686  * conformant to the SCSI-2 format.
 687  */
 688 static int do_scsi_page83_prespc3_inquiry(struct udev *udev,
 689                                           struct scsi_id_device *dev_scsi, int fd,
 690                                           char *serial, char *serial_short, int len)
 691 {
 692         int retval;
 693         int i, j;
 694         unsigned char page_83[SCSI_INQ_BUFF_LEN];
 695
 696         memset(page_83, 0, SCSI_INQ_BUFF_LEN);
 697         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_83, page_83, SCSI_INQ_BUFF_LEN);
 698         if (retval < 0)
 699                 return 1;
 700
 701         if (page_83[1] != PAGE_83) {
 702                 info(udev, "%s: Invalid page 0x83\n", dev_scsi->kernel);
 703                 return 1;
 704         }
 705         /*
 706          * Model 4, 5, and (some) model 6 EMC Symmetrix devices return
 707          * a page 83 reply according to SCSI-2 format instead of SPC-2/3.
 708          *
 709          * The SCSI-2 page 83 format returns an IEEE WWN in binary
 710          * encoded hexi-decimal in the 16 bytes following the initial
 711          * 4-byte page 83 reply header.
 712          *
 713          * Both the SPC-2 and SPC-3 formats return an IEEE WWN as part
 714          * of an Identification descriptor.  The 3rd byte of the first
 715          * Identification descriptor is a reserved (BSZ) byte field.
 716          *
 717          * Reference the 7th byte of the page 83 reply to determine
 718          * whether the reply is compliant with SCSI-2 or SPC-2/3
 719          * specifications.  A zero value in the 7th byte indicates
 720          * an SPC-2/3 conformant reply, (i.e., the reserved field of the
 721          * first Identification descriptor).  This byte will be non-zero
 722          * for a SCSI-2 conformant page 83 reply from these EMC
 723          * Symmetrix models since the 7th byte of the reply corresponds
 724          * to the 4th and 5th nibbles of the 6-byte OUI for EMC, that is,
 725          * 0x006048.
 726          */
 727         if (page_83[6] == 0)
 728                 return 2;
 729
 730         serial[0] = hex_str[id_search_list[0].id_type];
 731         /*
 732          * The first four bytes contain data, not a descriptor.
 733          */
 734         i = 4;
 735         j = strlen(serial);
 736         /*
 737          * Binary descriptor, convert to ASCII,
 738          * using two bytes of ASCII for each byte
 739          * in the page_83.
 740          */
 741         while (i < (page_83[3]+4)) {
 742                 serial[j++] = hex_str[(page_83[i] & 0xf0) >> 4];
 743                 serial[j++] = hex_str[page_83[i] & 0x0f];
 744                 i++;
 745         }
 746         dbg(udev, "using pre-spc3-83 for %s\n", dev_scsi->kernel);
 747         return 0;
 748 }
 749
 750 /* Get unit serial number VPD page */
 751 static int do_scsi_page80_inquiry(struct udev *udev,
 752                                   struct scsi_id_device *dev_scsi, int fd,
 753                                   char *serial, char *serial_short, int max_len)
 754 {
 755         int retval;
 756         int ser_ind;
 757         int i;
 758         int len;
 759         unsigned char buf[SCSI_INQ_BUFF_LEN];
 760
 761         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 762         retval = scsi_inquiry(udev, dev_scsi, fd, 1, PAGE_80, buf, SCSI_INQ_BUFF_LEN);
 763         if (retval < 0)
 764                 return retval;
 765
 766         if (buf[1] != PAGE_80) {
 767                 info(udev, "%s: Invalid page 0x80\n", dev_scsi->kernel);
 768                 return 1;
 769         }
 770
 771         len = 1 + VENDOR_LENGTH + MODEL_LENGTH + buf[3];
 772         if (max_len < len) {
 773                 info(udev, "%s: length %d too short - need %d\n",
 774                      dev_scsi->kernel, max_len, len);
 775                 return 1;
 776         }
 777         /*
 778          * Prepend 'S' to avoid unlikely collision with page 0x83 vendor
 779          * specific type where we prepend '0' + vendor + model.
 780          */
 781         serial[0] = 'S';
 782         ser_ind = prepend_vendor_model(udev, dev_scsi, &serial[1]);
 783         if (ser_ind < 0)
 784                 return 1;
 785         len = buf[3];
 786         for (i = 4; i < len + 4; i++, ser_ind++)
 787                 serial[ser_ind] = buf[i];
 788         memcpy(serial_short, &buf[4], len);
 789         serial_short[len] = '\0';
 790         return 0;
 791 }
 792
 793 int scsi_std_inquiry(struct udev *udev,
 794                      struct scsi_id_device *dev_scsi, const char *devname)
 795 {
 796         int fd;
 797         unsigned char buf[SCSI_INQ_BUFF_LEN];
 798         struct stat statbuf;
 799         int err = 0;
 800
 801         dbg(udev, "opening %s\n", devname);
 802         fd = open(devname, O_RDONLY | O_NONBLOCK);
 803         if (fd < 0) {
 804                 info(udev, "scsi_id: cannot open %s: %s\n",
 805                      devname, strerror(errno));
 806                 return 1;
 807         }
 808
 809         if (fstat(fd, &statbuf) < 0) {
 810                 info(udev, "scsi_id: cannot stat %s: %s\n",
 811                      devname, strerror(errno));
 812                 err = 2;
 813                 goto out;
 814         }
 815         sprintf(dev_scsi->kernel,"%d:%d", major(statbuf.st_rdev),
 816                 minor(statbuf.st_rdev));
 817
 818         memset(buf, 0, SCSI_INQ_BUFF_LEN);
 819         err = scsi_inquiry(udev, dev_scsi, fd, 0, 0, buf, SCSI_INQ_BUFF_LEN);
 820         if (err < 0)
 821                 goto out;
 822
 823         err = 0;
 824         memcpy(dev_scsi->vendor, buf + 8, 8);
 825         dev_scsi->vendor[8] = '\0';
 826         memcpy(dev_scsi->model, buf + 16, 16);
 827         dev_scsi->model[16] = '\0';
 828         memcpy(dev_scsi->revision, buf + 32, 4);
 829         dev_scsi->revision[4] = '\0';
 830         sprintf(dev_scsi->type,"%x", buf[0] & 0x1f);
 831
 832 out:
 833         close(fd);
 834         return err;
 835 }
 836
 837 int scsi_get_serial(struct udev *udev,
 838                     struct scsi_id_device *dev_scsi, const char *devname,
 839                     int page_code, int len)
 840 {
 841         unsigned char page0[SCSI_INQ_BUFF_LEN];
 842         int fd = -1;
 843         int cnt = 10;
 844         int ind;
 845         int retval;
 846
 847         memset(dev_scsi->serial, 0, len);
 848         dbg(udev, "opening %s\n", devname);
 849         while (--cnt) {
 850                 const struct timespec duration = { 0, 500 * 1000 * 1000 };
 851
 852                 fd = open(devname, O_RDONLY | O_NONBLOCK);
 853                 if (fd >= 0)
 854                         break;
 855                 info(udev, "%s: cannot open %s: %s\n", dev_scsi->kernel, devname, strerror(errno));
 856                 if (errno != EBUSY)
 857                         break;
 858                 nanosleep(&duration, NULL);
 859         }
 860         if (fd < 0)
 861                 return 1;
 862
 863         if (page_code == PAGE_80) {
 864                 if (do_scsi_page80_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 865                         retval = 1;
 866                         goto completed;
 867                 } else  {
 868                         retval = 0;
 869                         goto completed;
 870                 }
 871         } else if (page_code == PAGE_83) {
 872                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 873                         retval = 1;
 874                         goto completed;
 875                 } else  {
 876                         retval = 0;
 877                         goto completed;
 878                 }
 879         } else if (page_code == PAGE_83_PRE_SPC3) {
 880                 retval = do_scsi_page83_prespc3_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len);
 881                 if (retval) {
 882                         /*
 883                          * Fallback to servicing a SPC-2/3 compliant page 83
 884                          * inquiry if the page 83 reply format does not
 885                          * conform to pre-SPC3 expectations.
 886                          */
 887                         if (retval == 2) {
 888                                 if (do_scsi_page83_inquiry(udev, dev_scsi, fd, dev_scsi->serial, dev_scsi->serial_short, len)) {
 889                                         retval = 1;
 890                                         goto completed;
 891                                 } else  {
 892                                         retval = 0;
 893                                         goto completed;
 894                                 }
 895                         }
 896                         else {
 897                                 retval = 1;
 898                                 goto completed;
 899                         }
 900                 } else  {
 901                         retval = 0;
 902                         goto completed;
 903                 }
 904         } else if (page_code != 0x00) {
 905                 info(udev, "%s: unsupported page code 0x%d\n", dev_scsi->kernel, page_code);
 906                 return 1;
 907         }
 908
 909         /*
 910          * Get page 0, the page of the pages. By default, try from best to
 911          * worst of supported pages: 0x83 then 0x80.
 912          */
 913         if (do_scsi_page0_inquiry(udev, dev_scsi, fd, page0, SCSI_INQ_BUFF_LEN)) {
 914                 /*
 915                  * Don't try anything else. Black list if a specific page
 916                  * should be used for this vendor+model, or maybe have an
 917                  * optional fall-back to page 0x80 or page 0x83.
 918                  */
 919                 retval = 1;
 920                 goto completed;
 921         }
 922
 923         dbg(udev, "%s: Checking page0\n", dev_scsi->kernel);
 924
 925         for (ind = 4; ind <= page0[3] + 3; ind++)
 926                 if (page0[ind] == PAGE_83)
 927                         if (!do_scsi_page83_inquiry(udev, dev_scsi, fd,
 928                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 929                                 /*
 930                                  * Success
 931                                  */
 932                                 retval = 0;
 933                                 goto completed;
 934                         }
 935
 936         for (ind = 4; ind <= page0[3] + 3; ind++)
 937                 if (page0[ind] == PAGE_80)
 938                         if (!do_scsi_page80_inquiry(udev, dev_scsi, fd,
 939                                                     dev_scsi->serial, dev_scsi->serial_short, len)) {
 940                                 /*
 941                                  * Success
 942                                  */
 943                                 retval = 0;
 944                                 goto completed;
 945                         }
 946         retval = 1;
 947
 948 completed:
 949         close(fd);
 950         return retval;
 951 }