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