drivers/scsi/scsi_sysfs.c

   1 /*
   2  * scsi_sysfs.c
   3  *
   4  * SCSI sysfs interface routines.
   5  *
   6  * Created to pull SCSI mid layer sysfs routines into one file.
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/slab.h>
  11 #include <linux/init.h>
  12 #include <linux/blkdev.h>
  13 #include <linux/device.h>
  14 #include <linux/pm_runtime.h>
  15
  16 #include <scsi/scsi.h>
  17 #include <scsi/scsi_device.h>
  18 #include <scsi/scsi_host.h>
  19 #include <scsi/scsi_tcq.h>
  20 #include <scsi/scsi_transport.h>
  21 #include <scsi/scsi_driver.h>
  22
  23 #include "scsi_priv.h"
  24 #include "scsi_logging.h"
  25
  26 static struct device_type scsi_dev_type;
  27
  28 static const struct {
  29         enum scsi_device_state  value;
  30         char                    *name;
  31 } sdev_states[] = {
  32         { SDEV_CREATED, "created" },
  33         { SDEV_RUNNING, "running" },
  34         { SDEV_CANCEL, "cancel" },
  35         { SDEV_DEL, "deleted" },
  36         { SDEV_QUIESCE, "quiesce" },
  37         { SDEV_OFFLINE, "offline" },
  38         { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
  39         { SDEV_BLOCK,   "blocked" },
  40         { SDEV_CREATED_BLOCK, "created-blocked" },
  41 };
  42
  43 const char *scsi_device_state_name(enum scsi_device_state state)
  44 {
  45         int i;
  46         char *name = NULL;
  47
  48         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
  49                 if (sdev_states[i].value == state) {
  50                         name = sdev_states[i].name;
  51                         break;
  52                 }
  53         }
  54         return name;
  55 }
  56
  57 static const struct {
  58         enum scsi_host_state    value;
  59         char                    *name;
  60 } shost_states[] = {
  61         { SHOST_CREATED, "created" },
  62         { SHOST_RUNNING, "running" },
  63         { SHOST_CANCEL, "cancel" },
  64         { SHOST_DEL, "deleted" },
  65         { SHOST_RECOVERY, "recovery" },
  66         { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
  67         { SHOST_DEL_RECOVERY, "deleted/recovery", },
  68 };
  69 const char *scsi_host_state_name(enum scsi_host_state state)
  70 {
  71         int i;
  72         char *name = NULL;
  73
  74         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
  75                 if (shost_states[i].value == state) {
  76                         name = shost_states[i].name;
  77                         break;
  78                 }
  79         }
  80         return name;
  81 }
  82
  83 static int check_set(unsigned long long *val, char *src)
  84 {
  85         char *last;
  86
  87         if (strncmp(src, "-", 20) == 0) {
  88                 *val = SCAN_WILD_CARD;
  89         } else {
  90                 /*
  91                  * Doesn't check for int overflow
  92                  */
  93                 *val = simple_strtoull(src, &last, 0);
  94                 if (*last != '\0')
  95                         return 1;
  96         }
  97         return 0;
  98 }
  99
 100 static int scsi_scan(struct Scsi_Host *shost, const char *str)
 101 {
 102         char s1[15], s2[15], s3[17], junk;
 103         unsigned long long channel, id, lun;
 104         int res;
 105
 106         res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
 107         if (res != 3)
 108                 return -EINVAL;
 109         if (check_set(&channel, s1))
 110                 return -EINVAL;
 111         if (check_set(&id, s2))
 112                 return -EINVAL;
 113         if (check_set(&lun, s3))
 114                 return -EINVAL;
 115         if (shost->transportt->user_scan)
 116                 res = shost->transportt->user_scan(shost, channel, id, lun);
 117         else
 118                 res = scsi_scan_host_selected(shost, channel, id, lun, 1);
 119         return res;
 120 }
 121
 122 /*
 123  * shost_show_function: macro to create an attr function that can be used to
 124  * show a non-bit field.
 125  */
 126 #define shost_show_function(name, field, format_string)                 \
 127 static ssize_t                                                          \
 128 show_##name (struct device *dev, struct device_attribute *attr,         \
 129              char *buf)                                                 \
 130 {                                                                       \
 131         struct Scsi_Host *shost = class_to_shost(dev);                  \
 132         return snprintf (buf, 20, format_string, shost->field);         \
 133 }
 134
 135 /*
 136  * shost_rd_attr: macro to create a function and attribute variable for a
 137  * read only field.
 138  */
 139 #define shost_rd_attr2(name, field, format_string)                      \
 140         shost_show_function(name, field, format_string)                 \
 141 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
 142
 143 #define shost_rd_attr(field, format_string) \
 144 shost_rd_attr2(field, field, format_string)
 145
 146 /*
 147  * Create the actual show/store functions and data structures.
 148  */
 149
 150 static ssize_t
 151 store_scan(struct device *dev, struct device_attribute *attr,
 152            const char *buf, size_t count)
 153 {
 154         struct Scsi_Host *shost = class_to_shost(dev);
 155         int res;
 156
 157         res = scsi_scan(shost, buf);
 158         if (res == 0)
 159                 res = count;
 160         return res;
 161 };
 162 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
 163
 164 static ssize_t
 165 store_shost_state(struct device *dev, struct device_attribute *attr,
 166                   const char *buf, size_t count)
 167 {
 168         int i;
 169         struct Scsi_Host *shost = class_to_shost(dev);
 170         enum scsi_host_state state = 0;
 171
 172         for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
 173                 const int len = strlen(shost_states[i].name);
 174                 if (strncmp(shost_states[i].name, buf, len) == 0 &&
 175                    buf[len] == '\n') {
 176                         state = shost_states[i].value;
 177                         break;
 178                 }
 179         }
 180         if (!state)
 181                 return -EINVAL;
 182
 183         if (scsi_host_set_state(shost, state))
 184                 return -EINVAL;
 185         return count;
 186 }
 187
 188 static ssize_t
 189 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
 190 {
 191         struct Scsi_Host *shost = class_to_shost(dev);
 192         const char *name = scsi_host_state_name(shost->shost_state);
 193
 194         if (!name)
 195                 return -EINVAL;
 196
 197         return snprintf(buf, 20, "%s\n", name);
 198 }
 199
 200 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
 201 struct device_attribute dev_attr_hstate =
 202         __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
 203
 204 static ssize_t
 205 show_shost_mode(unsigned int mode, char *buf)
 206 {
 207         ssize_t len = 0;
 208
 209         if (mode & MODE_INITIATOR)
 210                 len = sprintf(buf, "%s", "Initiator");
 211
 212         if (mode & MODE_TARGET)
 213                 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
 214
 215         len += sprintf(buf + len, "\n");
 216
 217         return len;
 218 }
 219
 220 static ssize_t
 221 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
 222                           char *buf)
 223 {
 224         struct Scsi_Host *shost = class_to_shost(dev);
 225         unsigned int supported_mode = shost->hostt->supported_mode;
 226
 227         if (supported_mode == MODE_UNKNOWN)
 228                 /* by default this should be initiator */
 229                 supported_mode = MODE_INITIATOR;
 230
 231         return show_shost_mode(supported_mode, buf);
 232 }
 233
 234 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
 235
 236 static ssize_t
 237 show_shost_active_mode(struct device *dev,
 238                        struct device_attribute *attr, char *buf)
 239 {
 240         struct Scsi_Host *shost = class_to_shost(dev);
 241
 242         if (shost->active_mode == MODE_UNKNOWN)
 243                 return snprintf(buf, 20, "unknown\n");
 244         else
 245                 return show_shost_mode(shost->active_mode, buf);
 246 }
 247
 248 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
 249
 250 static int check_reset_type(const char *str)
 251 {
 252         if (sysfs_streq(str, "adapter"))
 253                 return SCSI_ADAPTER_RESET;
 254         else if (sysfs_streq(str, "firmware"))
 255                 return SCSI_FIRMWARE_RESET;
 256         else
 257                 return 0;
 258 }
 259
 260 static ssize_t
 261 store_host_reset(struct device *dev, struct device_attribute *attr,
 262                 const char *buf, size_t count)
 263 {
 264         struct Scsi_Host *shost = class_to_shost(dev);
 265         struct scsi_host_template *sht = shost->hostt;
 266         int ret = -EINVAL;
 267         int type;
 268
 269         type = check_reset_type(buf);
 270         if (!type)
 271                 goto exit_store_host_reset;
 272
 273         if (sht->host_reset)
 274                 ret = sht->host_reset(shost, type);
 275
 276 exit_store_host_reset:
 277         if (ret == 0)
 278                 ret = count;
 279         return ret;
 280 }
 281
 282 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
 283
 284 static ssize_t
 285 show_shost_eh_deadline(struct device *dev,
 286                       struct device_attribute *attr, char *buf)
 287 {
 288         struct Scsi_Host *shost = class_to_shost(dev);
 289
 290         if (shost->eh_deadline == -1)
 291                 return snprintf(buf, strlen("off") + 2, "off\n");
 292         return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
 293 }
 294
 295 static ssize_t
 296 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
 297                 const char *buf, size_t count)
 298 {
 299         struct Scsi_Host *shost = class_to_shost(dev);
 300         int ret = -EINVAL;
 301         unsigned long deadline, flags;
 302
 303         if (shost->transportt &&
 304             (shost->transportt->eh_strategy_handler ||
 305              !shost->hostt->eh_host_reset_handler))
 306                 return ret;
 307
 308         if (!strncmp(buf, "off", strlen("off")))
 309                 deadline = -1;
 310         else {
 311                 ret = kstrtoul(buf, 10, &deadline);
 312                 if (ret)
 313                         return ret;
 314                 if (deadline * HZ > UINT_MAX)
 315                         return -EINVAL;
 316         }
 317
 318         spin_lock_irqsave(shost->host_lock, flags);
 319         if (scsi_host_in_recovery(shost))
 320                 ret = -EBUSY;
 321         else {
 322                 if (deadline == -1)
 323                         shost->eh_deadline = -1;
 324                 else
 325                         shost->eh_deadline = deadline * HZ;
 326
 327                 ret = count;
 328         }
 329         spin_unlock_irqrestore(shost->host_lock, flags);
 330
 331         return ret;
 332 }
 333
 334 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
 335
 336 shost_rd_attr(use_blk_mq, "%d\n");
 337 shost_rd_attr(unique_id, "%u\n");
 338 shost_rd_attr(cmd_per_lun, "%hd\n");
 339 shost_rd_attr(can_queue, "%hd\n");
 340 shost_rd_attr(sg_tablesize, "%hu\n");
 341 shost_rd_attr(sg_prot_tablesize, "%hu\n");
 342 shost_rd_attr(unchecked_isa_dma, "%d\n");
 343 shost_rd_attr(prot_capabilities, "%u\n");
 344 shost_rd_attr(prot_guard_type, "%hd\n");
 345 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
 346
 347 static ssize_t
 348 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
 349 {
 350         struct Scsi_Host *shost = class_to_shost(dev);
 351         return snprintf(buf, 20, "%d\n", atomic_read(&shost->host_busy));
 352 }
 353 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
 354
 355 static struct attribute *scsi_sysfs_shost_attrs[] = {
 356         &dev_attr_use_blk_mq.attr,
 357         &dev_attr_unique_id.attr,
 358         &dev_attr_host_busy.attr,
 359         &dev_attr_cmd_per_lun.attr,
 360         &dev_attr_can_queue.attr,
 361         &dev_attr_sg_tablesize.attr,
 362         &dev_attr_sg_prot_tablesize.attr,
 363         &dev_attr_unchecked_isa_dma.attr,
 364         &dev_attr_proc_name.attr,
 365         &dev_attr_scan.attr,
 366         &dev_attr_hstate.attr,
 367         &dev_attr_supported_mode.attr,
 368         &dev_attr_active_mode.attr,
 369         &dev_attr_prot_capabilities.attr,
 370         &dev_attr_prot_guard_type.attr,
 371         &dev_attr_host_reset.attr,
 372         &dev_attr_eh_deadline.attr,
 373         NULL
 374 };
 375
 376 struct attribute_group scsi_shost_attr_group = {
 377         .attrs =        scsi_sysfs_shost_attrs,
 378 };
 379
 380 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
 381         &scsi_shost_attr_group,
 382         NULL
 383 };
 384
 385 static void scsi_device_cls_release(struct device *class_dev)
 386 {
 387         struct scsi_device *sdev;
 388
 389         sdev = class_to_sdev(class_dev);
 390         put_device(&sdev->sdev_gendev);
 391 }
 392
 393 static void scsi_device_dev_release_usercontext(struct work_struct *work)
 394 {
 395         struct scsi_device *sdev;
 396         struct device *parent;
 397         struct list_head *this, *tmp;
 398         unsigned long flags;
 399
 400         sdev = container_of(work, struct scsi_device, ew.work);
 401
 402         scsi_dh_release_device(sdev);
 403
 404         parent = sdev->sdev_gendev.parent;
 405
 406         spin_lock_irqsave(sdev->host->host_lock, flags);
 407         list_del(&sdev->siblings);
 408         list_del(&sdev->same_target_siblings);
 409         list_del(&sdev->starved_entry);
 410         spin_unlock_irqrestore(sdev->host->host_lock, flags);
 411
 412         cancel_work_sync(&sdev->event_work);
 413
 414         list_for_each_safe(this, tmp, &sdev->event_list) {
 415                 struct scsi_event *evt;
 416
 417                 evt = list_entry(this, struct scsi_event, node);
 418                 list_del(&evt->node);
 419                 kfree(evt);
 420         }
 421
 422         blk_put_queue(sdev->request_queue);
 423         /* NULL queue means the device can't be used */
 424         sdev->request_queue = NULL;
 425
 426         kfree(sdev->vpd_pg83);
 427         kfree(sdev->vpd_pg80);
 428         kfree(sdev->inquiry);
 429         kfree(sdev);
 430
 431         if (parent)
 432                 put_device(parent);
 433 }
 434
 435 static void scsi_device_dev_release(struct device *dev)
 436 {
 437         struct scsi_device *sdp = to_scsi_device(dev);
 438         execute_in_process_context(scsi_device_dev_release_usercontext,
 439                                    &sdp->ew);
 440 }
 441
 442 static struct class sdev_class = {
 443         .name           = "scsi_device",
 444         .dev_release    = scsi_device_cls_release,
 445 };
 446
 447 /* all probing is done in the individual ->probe routines */
 448 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
 449 {
 450         struct scsi_device *sdp;
 451
 452         if (dev->type != &scsi_dev_type)
 453                 return 0;
 454
 455         sdp = to_scsi_device(dev);
 456         if (sdp->no_uld_attach)
 457                 return 0;
 458         return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
 459 }
 460
 461 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
 462 {
 463         struct scsi_device *sdev;
 464
 465         if (dev->type != &scsi_dev_type)
 466                 return 0;
 467
 468         sdev = to_scsi_device(dev);
 469
 470         add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
 471         return 0;
 472 }
 473
 474 struct bus_type scsi_bus_type = {
 475         .name           = "scsi",
 476         .match          = scsi_bus_match,
 477         .uevent         = scsi_bus_uevent,
 478 #ifdef CONFIG_PM
 479         .pm             = &scsi_bus_pm_ops,
 480 #endif
 481 };
 482 EXPORT_SYMBOL_GPL(scsi_bus_type);
 483
 484 int scsi_sysfs_register(void)
 485 {
 486         int error;
 487
 488         error = bus_register(&scsi_bus_type);
 489         if (!error) {
 490                 error = class_register(&sdev_class);
 491                 if (error)
 492                         bus_unregister(&scsi_bus_type);
 493         }
 494
 495         return error;
 496 }
 497
 498 void scsi_sysfs_unregister(void)
 499 {
 500         class_unregister(&sdev_class);
 501         bus_unregister(&scsi_bus_type);
 502 }
 503
 504 /*
 505  * sdev_show_function: macro to create an attr function that can be used to
 506  * show a non-bit field.
 507  */
 508 #define sdev_show_function(field, format_string)                                \
 509 static ssize_t                                                          \
 510 sdev_show_##field (struct device *dev, struct device_attribute *attr,   \
 511                    char *buf)                                           \
 512 {                                                                       \
 513         struct scsi_device *sdev;                                       \
 514         sdev = to_scsi_device(dev);                                     \
 515         return snprintf (buf, 20, format_string, sdev->field);          \
 516 }                                                                       \
 517
 518 /*
 519  * sdev_rd_attr: macro to create a function and attribute variable for a
 520  * read only field.
 521  */
 522 #define sdev_rd_attr(field, format_string)                              \
 523         sdev_show_function(field, format_string)                        \
 524 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
 525
 526
 527 /*
 528  * sdev_rw_attr: create a function and attribute variable for a
 529  * read/write field.
 530  */
 531 #define sdev_rw_attr(field, format_string)                              \
 532         sdev_show_function(field, format_string)                                \
 533                                                                         \
 534 static ssize_t                                                          \
 535 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
 536                     const char *buf, size_t count)                      \
 537 {                                                                       \
 538         struct scsi_device *sdev;                                       \
 539         sdev = to_scsi_device(dev);                                     \
 540         sscanf (buf, format_string, &sdev->field);                      \
 541         return count;                                                   \
 542 }                                                                       \
 543 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
 544
 545 /* Currently we don't export bit fields, but we might in future,
 546  * so leave this code in */
 547 #if 0
 548 /*
 549  * sdev_rd_attr: create a function and attribute variable for a
 550  * read/write bit field.
 551  */
 552 #define sdev_rw_attr_bit(field)                                         \
 553         sdev_show_function(field, "%d\n")                                       \
 554                                                                         \
 555 static ssize_t                                                          \
 556 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
 557                     const char *buf, size_t count)                      \
 558 {                                                                       \
 559         int ret;                                                        \
 560         struct scsi_device *sdev;                                       \
 561         ret = scsi_sdev_check_buf_bit(buf);                             \
 562         if (ret >= 0)   {                                               \
 563                 sdev = to_scsi_device(dev);                             \
 564                 sdev->field = ret;                                      \
 565                 ret = count;                                            \
 566         }                                                               \
 567         return ret;                                                     \
 568 }                                                                       \
 569 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
 570
 571 /*
 572  * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
 573  * else return -EINVAL.
 574  */
 575 static int scsi_sdev_check_buf_bit(const char *buf)
 576 {
 577         if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
 578                 if (buf[0] == '1')
 579                         return 1;
 580                 else if (buf[0] == '0')
 581                         return 0;
 582                 else
 583                         return -EINVAL;
 584         } else
 585                 return -EINVAL;
 586 }
 587 #endif
 588 /*
 589  * Create the actual show/store functions and data structures.
 590  */
 591 sdev_rd_attr (type, "%d\n");
 592 sdev_rd_attr (scsi_level, "%d\n");
 593 sdev_rd_attr (vendor, "%.8s\n");
 594 sdev_rd_attr (model, "%.16s\n");
 595 sdev_rd_attr (rev, "%.4s\n");
 596
 597 static ssize_t
 598 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
 599                 char *buf)
 600 {
 601         struct scsi_device *sdev = to_scsi_device(dev);
 602         return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
 603 }
 604 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
 605
 606 static ssize_t
 607 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
 608                 char *buf)
 609 {
 610         struct scsi_device *sdev = to_scsi_device(dev);
 611         return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
 612 }
 613 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
 614
 615 /*
 616  * TODO: can we make these symlinks to the block layer ones?
 617  */
 618 static ssize_t
 619 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
 620 {
 621         struct scsi_device *sdev;
 622         sdev = to_scsi_device(dev);
 623         return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
 624 }
 625
 626 static ssize_t
 627 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
 628                     const char *buf, size_t count)
 629 {
 630         struct scsi_device *sdev;
 631         int timeout;
 632         sdev = to_scsi_device(dev);
 633         sscanf (buf, "%d\n", &timeout);
 634         blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
 635         return count;
 636 }
 637 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
 638
 639 static ssize_t
 640 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
 641 {
 642         struct scsi_device *sdev;
 643         sdev = to_scsi_device(dev);
 644         return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
 645 }
 646
 647 static ssize_t
 648 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
 649                     const char *buf, size_t count)
 650 {
 651         struct scsi_device *sdev;
 652         unsigned int eh_timeout;
 653         int err;
 654
 655         if (!capable(CAP_SYS_ADMIN))
 656                 return -EACCES;
 657
 658         sdev = to_scsi_device(dev);
 659         err = kstrtouint(buf, 10, &eh_timeout);
 660         if (err)
 661                 return err;
 662         sdev->eh_timeout = eh_timeout * HZ;
 663
 664         return count;
 665 }
 666 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
 667
 668 static ssize_t
 669 store_rescan_field (struct device *dev, struct device_attribute *attr,
 670                     const char *buf, size_t count)
 671 {
 672         scsi_rescan_device(dev);
 673         return count;
 674 }
 675 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
 676
 677 static ssize_t
 678 sdev_store_delete(struct device *dev, struct device_attribute *attr,
 679                   const char *buf, size_t count)
 680 {
 681         if (device_remove_file_self(dev, attr))
 682                 scsi_remove_device(to_scsi_device(dev));
 683         return count;
 684 };
 685 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
 686
 687 static ssize_t
 688 store_state_field(struct device *dev, struct device_attribute *attr,
 689                   const char *buf, size_t count)
 690 {
 691         int i;
 692         struct scsi_device *sdev = to_scsi_device(dev);
 693         enum scsi_device_state state = 0;
 694
 695         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
 696                 const int len = strlen(sdev_states[i].name);
 697                 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
 698                    buf[len] == '\n') {
 699                         state = sdev_states[i].value;
 700                         break;
 701                 }
 702         }
 703         if (!state)
 704                 return -EINVAL;
 705
 706         if (scsi_device_set_state(sdev, state))
 707                 return -EINVAL;
 708         return count;
 709 }
 710
 711 static ssize_t
 712 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
 713 {
 714         struct scsi_device *sdev = to_scsi_device(dev);
 715         const char *name = scsi_device_state_name(sdev->sdev_state);
 716
 717         if (!name)
 718                 return -EINVAL;
 719
 720         return snprintf(buf, 20, "%s\n", name);
 721 }
 722
 723 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
 724
 725 static ssize_t
 726 show_queue_type_field(struct device *dev, struct device_attribute *attr,
 727                       char *buf)
 728 {
 729         struct scsi_device *sdev = to_scsi_device(dev);
 730         const char *name = "none";
 731
 732         if (sdev->simple_tags)
 733                 name = "simple";
 734
 735         return snprintf(buf, 20, "%s\n", name);
 736 }
 737
 738 static ssize_t
 739 store_queue_type_field(struct device *dev, struct device_attribute *attr,
 740                        const char *buf, size_t count)
 741 {
 742         struct scsi_device *sdev = to_scsi_device(dev);
 743
 744         if (!sdev->tagged_supported)
 745                 return -EINVAL;
 746
 747         sdev_printk(KERN_INFO, sdev,
 748                     "ignoring write to deprecated queue_type attribute");
 749         return count;
 750 }
 751
 752 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
 753                    store_queue_type_field);
 754
 755 #define sdev_vpd_pg_attr(_page)                                         \
 756 static ssize_t                                                  \
 757 show_vpd_##_page(struct file *filp, struct kobject *kobj,       \
 758                  struct bin_attribute *bin_attr,                        \
 759                  char *buf, loff_t off, size_t count)                   \
 760 {                                                                       \
 761         struct device *dev = container_of(kobj, struct device, kobj);   \
 762         struct scsi_device *sdev = to_scsi_device(dev);                 \
 763         if (!sdev->vpd_##_page)                                         \
 764                 return -EINVAL;                                         \
 765         return memory_read_from_buffer(buf, count, &off,                \
 766                                        sdev->vpd_##_page,               \
 767                                        sdev->vpd_##_page##_len);        \
 768 }                                                                       \
 769 static struct bin_attribute dev_attr_vpd_##_page = {            \
 770         .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO },   \
 771         .size = 0,                                                      \
 772         .read = show_vpd_##_page,                                       \
 773 };
 774
 775 sdev_vpd_pg_attr(pg83);
 776 sdev_vpd_pg_attr(pg80);
 777
 778 static ssize_t
 779 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
 780                         char *buf)
 781 {
 782         return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
 783 }
 784
 785 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
 786
 787 #define show_sdev_iostat(field)                                         \
 788 static ssize_t                                                          \
 789 show_iostat_##field(struct device *dev, struct device_attribute *attr,  \
 790                     char *buf)                                          \
 791 {                                                                       \
 792         struct scsi_device *sdev = to_scsi_device(dev);                 \
 793         unsigned long long count = atomic_read(&sdev->field);           \
 794         return snprintf(buf, 20, "0x%llx\n", count);                    \
 795 }                                                                       \
 796 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
 797
 798 show_sdev_iostat(iorequest_cnt);
 799 show_sdev_iostat(iodone_cnt);
 800 show_sdev_iostat(ioerr_cnt);
 801
 802 static ssize_t
 803 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
 804 {
 805         struct scsi_device *sdev;
 806         sdev = to_scsi_device(dev);
 807         return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
 808 }
 809 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
 810
 811 #define DECLARE_EVT_SHOW(name, Cap_name)                                \
 812 static ssize_t                                                          \
 813 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
 814                      char *buf)                                         \
 815 {                                                                       \
 816         struct scsi_device *sdev = to_scsi_device(dev);                 \
 817         int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
 818         return snprintf(buf, 20, "%d\n", val);                          \
 819 }
 820
 821 #define DECLARE_EVT_STORE(name, Cap_name)                               \
 822 static ssize_t                                                          \
 823 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
 824                       const char *buf, size_t count)                    \
 825 {                                                                       \
 826         struct scsi_device *sdev = to_scsi_device(dev);                 \
 827         int val = simple_strtoul(buf, NULL, 0);                         \
 828         if (val == 0)                                                   \
 829                 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
 830         else if (val == 1)                                              \
 831                 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events);   \
 832         else                                                            \
 833                 return -EINVAL;                                         \
 834         return count;                                                   \
 835 }
 836
 837 #define DECLARE_EVT(name, Cap_name)                                     \
 838         DECLARE_EVT_SHOW(name, Cap_name)                                \
 839         DECLARE_EVT_STORE(name, Cap_name)                               \
 840         static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name,   \
 841                            sdev_store_evt_##name);
 842 #define REF_EVT(name) &dev_attr_evt_##name.attr
 843
 844 DECLARE_EVT(media_change, MEDIA_CHANGE)
 845 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
 846 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
 847 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
 848 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
 849 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
 850
 851 static ssize_t
 852 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
 853                        const char *buf, size_t count)
 854 {
 855         int depth, retval;
 856         struct scsi_device *sdev = to_scsi_device(dev);
 857         struct scsi_host_template *sht = sdev->host->hostt;
 858
 859         if (!sht->change_queue_depth)
 860                 return -EINVAL;
 861
 862         depth = simple_strtoul(buf, NULL, 0);
 863
 864         if (depth < 1 || depth > sdev->host->can_queue)
 865                 return -EINVAL;
 866
 867         retval = sht->change_queue_depth(sdev, depth);
 868         if (retval < 0)
 869                 return retval;
 870
 871         sdev->max_queue_depth = sdev->queue_depth;
 872
 873         return count;
 874 }
 875 sdev_show_function(queue_depth, "%d\n");
 876
 877 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
 878                    sdev_store_queue_depth);
 879
 880 static ssize_t
 881 sdev_show_queue_ramp_up_period(struct device *dev,
 882                                struct device_attribute *attr,
 883                                char *buf)
 884 {
 885         struct scsi_device *sdev;
 886         sdev = to_scsi_device(dev);
 887         return snprintf(buf, 20, "%u\n",
 888                         jiffies_to_msecs(sdev->queue_ramp_up_period));
 889 }
 890
 891 static ssize_t
 892 sdev_store_queue_ramp_up_period(struct device *dev,
 893                                 struct device_attribute *attr,
 894                                 const char *buf, size_t count)
 895 {
 896         struct scsi_device *sdev = to_scsi_device(dev);
 897         unsigned int period;
 898
 899         if (kstrtouint(buf, 10, &period))
 900                 return -EINVAL;
 901
 902         sdev->queue_ramp_up_period = msecs_to_jiffies(period);
 903         return period;
 904 }
 905
 906 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
 907                    sdev_show_queue_ramp_up_period,
 908                    sdev_store_queue_ramp_up_period);
 909
 910 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
 911                                          struct attribute *attr, int i)
 912 {
 913         struct device *dev = container_of(kobj, struct device, kobj);
 914         struct scsi_device *sdev = to_scsi_device(dev);
 915
 916
 917         if (attr == &dev_attr_queue_depth.attr &&
 918             !sdev->host->hostt->change_queue_depth)
 919                 return S_IRUGO;
 920
 921         if (attr == &dev_attr_queue_ramp_up_period.attr &&
 922             !sdev->host->hostt->change_queue_depth)
 923                 return 0;
 924
 925         return attr->mode;
 926 }
 927
 928 /* Default template for device attributes.  May NOT be modified */
 929 static struct attribute *scsi_sdev_attrs[] = {
 930         &dev_attr_device_blocked.attr,
 931         &dev_attr_type.attr,
 932         &dev_attr_scsi_level.attr,
 933         &dev_attr_device_busy.attr,
 934         &dev_attr_vendor.attr,
 935         &dev_attr_model.attr,
 936         &dev_attr_rev.attr,
 937         &dev_attr_rescan.attr,
 938         &dev_attr_delete.attr,
 939         &dev_attr_state.attr,
 940         &dev_attr_timeout.attr,
 941         &dev_attr_eh_timeout.attr,
 942         &dev_attr_iocounterbits.attr,
 943         &dev_attr_iorequest_cnt.attr,
 944         &dev_attr_iodone_cnt.attr,
 945         &dev_attr_ioerr_cnt.attr,
 946         &dev_attr_modalias.attr,
 947         &dev_attr_queue_depth.attr,
 948         &dev_attr_queue_type.attr,
 949         &dev_attr_queue_ramp_up_period.attr,
 950         REF_EVT(media_change),
 951         REF_EVT(inquiry_change_reported),
 952         REF_EVT(capacity_change_reported),
 953         REF_EVT(soft_threshold_reached),
 954         REF_EVT(mode_parameter_change_reported),
 955         REF_EVT(lun_change_reported),
 956         NULL
 957 };
 958
 959 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
 960         &dev_attr_vpd_pg83,
 961         &dev_attr_vpd_pg80,
 962         NULL
 963 };
 964 static struct attribute_group scsi_sdev_attr_group = {
 965         .attrs =        scsi_sdev_attrs,
 966         .bin_attrs =    scsi_sdev_bin_attrs,
 967         .is_visible =   scsi_sdev_attr_is_visible,
 968 };
 969
 970 static const struct attribute_group *scsi_sdev_attr_groups[] = {
 971         &scsi_sdev_attr_group,
 972         NULL
 973 };
 974
 975 static int scsi_target_add(struct scsi_target *starget)
 976 {
 977         int error;
 978
 979         if (starget->state != STARGET_CREATED)
 980                 return 0;
 981
 982         error = device_add(&starget->dev);
 983         if (error) {
 984                 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
 985                 return error;
 986         }
 987         transport_add_device(&starget->dev);
 988         starget->state = STARGET_RUNNING;
 989
 990         pm_runtime_set_active(&starget->dev);
 991         pm_runtime_enable(&starget->dev);
 992         device_enable_async_suspend(&starget->dev);
 993
 994         return 0;
 995 }
 996
 997 /**
 998  * scsi_sysfs_add_sdev - add scsi device to sysfs
 999  * @sdev:       scsi_device to add
1000  *
1001  * Return value:
1002  *      0 on Success / non-zero on Failure
1003  **/
1004 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1005 {
1006         int error, i;
1007         struct request_queue *rq = sdev->request_queue;
1008         struct scsi_target *starget = sdev->sdev_target;
1009
1010         error = scsi_device_set_state(sdev, SDEV_RUNNING);
1011         if (error)
1012                 return error;
1013
1014         error = scsi_target_add(starget);
1015         if (error)
1016                 return error;
1017
1018         transport_configure_device(&starget->dev);
1019
1020         device_enable_async_suspend(&sdev->sdev_gendev);
1021         scsi_autopm_get_target(starget);
1022         pm_runtime_set_active(&sdev->sdev_gendev);
1023         pm_runtime_forbid(&sdev->sdev_gendev);
1024         pm_runtime_enable(&sdev->sdev_gendev);
1025         scsi_autopm_put_target(starget);
1026
1027         scsi_autopm_get_device(sdev);
1028
1029         error = device_add(&sdev->sdev_gendev);
1030         if (error) {
1031                 sdev_printk(KERN_INFO, sdev,
1032                                 "failed to add device: %d\n", error);
1033                 return error;
1034         }
1035
1036         error = scsi_dh_add_device(sdev);
1037         if (error) {
1038                 sdev_printk(KERN_INFO, sdev,
1039                                 "failed to add device handler: %d\n", error);
1040                 return error;
1041         }
1042
1043         device_enable_async_suspend(&sdev->sdev_dev);
1044         error = device_add(&sdev->sdev_dev);
1045         if (error) {
1046                 sdev_printk(KERN_INFO, sdev,
1047                                 "failed to add class device: %d\n", error);
1048                 scsi_dh_remove_device(sdev);
1049                 device_del(&sdev->sdev_gendev);
1050                 return error;
1051         }
1052         transport_add_device(&sdev->sdev_gendev);
1053         sdev->is_visible = 1;
1054
1055         error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
1056
1057         if (error)
1058                 /* we're treating error on bsg register as non-fatal,
1059                  * so pretend nothing went wrong */
1060                 sdev_printk(KERN_INFO, sdev,
1061                             "Failed to register bsg queue, errno=%d\n", error);
1062
1063         /* add additional host specific attributes */
1064         if (sdev->host->hostt->sdev_attrs) {
1065                 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1066                         error = device_create_file(&sdev->sdev_gendev,
1067                                         sdev->host->hostt->sdev_attrs[i]);
1068                         if (error)
1069                                 return error;
1070                 }
1071         }
1072
1073         scsi_autopm_put_device(sdev);
1074         return error;
1075 }
1076
1077 void __scsi_remove_device(struct scsi_device *sdev)
1078 {
1079         struct device *dev = &sdev->sdev_gendev;
1080
1081         if (sdev->is_visible) {
1082                 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1083                         return;
1084
1085                 bsg_unregister_queue(sdev->request_queue);
1086                 device_unregister(&sdev->sdev_dev);
1087                 transport_remove_device(dev);
1088                 scsi_dh_remove_device(sdev);
1089                 device_del(dev);
1090         } else
1091                 put_device(&sdev->sdev_dev);
1092
1093         /*
1094          * Stop accepting new requests and wait until all queuecommand() and
1095          * scsi_run_queue() invocations have finished before tearing down the
1096          * device.
1097          */
1098         scsi_device_set_state(sdev, SDEV_DEL);
1099         blk_cleanup_queue(sdev->request_queue);
1100         cancel_work_sync(&sdev->requeue_work);
1101
1102         if (sdev->host->hostt->slave_destroy)
1103                 sdev->host->hostt->slave_destroy(sdev);
1104         transport_destroy_device(dev);
1105
1106         /*
1107          * Paired with the kref_get() in scsi_sysfs_initialize().  We have
1108          * remoed sysfs visibility from the device, so make the target
1109          * invisible if this was the last device underneath it.
1110          */
1111         scsi_target_reap(scsi_target(sdev));
1112
1113         put_device(dev);
1114 }
1115
1116 /**
1117  * scsi_remove_device - unregister a device from the scsi bus
1118  * @sdev:       scsi_device to unregister
1119  **/
1120 void scsi_remove_device(struct scsi_device *sdev)
1121 {
1122         struct Scsi_Host *shost = sdev->host;
1123
1124         mutex_lock(&shost->scan_mutex);
1125         __scsi_remove_device(sdev);
1126         mutex_unlock(&shost->scan_mutex);
1127 }
1128 EXPORT_SYMBOL(scsi_remove_device);
1129
1130 static void __scsi_remove_target(struct scsi_target *starget)
1131 {
1132         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1133         unsigned long flags;
1134         struct scsi_device *sdev;
1135
1136         spin_lock_irqsave(shost->host_lock, flags);
1137  restart:
1138         list_for_each_entry(sdev, &shost->__devices, siblings) {
1139                 if (sdev->channel != starget->channel ||
1140                     sdev->id != starget->id ||
1141                     scsi_device_get(sdev))
1142                         continue;
1143                 spin_unlock_irqrestore(shost->host_lock, flags);
1144                 scsi_remove_device(sdev);
1145                 scsi_device_put(sdev);
1146                 spin_lock_irqsave(shost->host_lock, flags);
1147                 goto restart;
1148         }
1149         spin_unlock_irqrestore(shost->host_lock, flags);
1150 }
1151
1152 /**
1153  * scsi_remove_target - try to remove a target and all its devices
1154  * @dev: generic starget or parent of generic stargets to be removed
1155  *
1156  * Note: This is slightly racy.  It is possible that if the user
1157  * requests the addition of another device then the target won't be
1158  * removed.
1159  */
1160 void scsi_remove_target(struct device *dev)
1161 {
1162         struct Scsi_Host *shost = dev_to_shost(dev->parent);
1163         struct scsi_target *starget, *last = NULL;
1164         unsigned long flags;
1165
1166         /* remove targets being careful to lookup next entry before
1167          * deleting the last
1168          */
1169         spin_lock_irqsave(shost->host_lock, flags);
1170         list_for_each_entry(starget, &shost->__targets, siblings) {
1171                 if (starget->state == STARGET_DEL)
1172                         continue;
1173                 if (starget->dev.parent == dev || &starget->dev == dev) {
1174                         /* assuming new targets arrive at the end */
1175                         kref_get(&starget->reap_ref);
1176                         spin_unlock_irqrestore(shost->host_lock, flags);
1177                         if (last)
1178                                 scsi_target_reap(last);
1179                         last = starget;
1180                         __scsi_remove_target(starget);
1181                         spin_lock_irqsave(shost->host_lock, flags);
1182                 }
1183         }
1184         spin_unlock_irqrestore(shost->host_lock, flags);
1185
1186         if (last)
1187                 scsi_target_reap(last);
1188 }
1189 EXPORT_SYMBOL(scsi_remove_target);
1190
1191 int scsi_register_driver(struct device_driver *drv)
1192 {
1193         drv->bus = &scsi_bus_type;
1194
1195         return driver_register(drv);
1196 }
1197 EXPORT_SYMBOL(scsi_register_driver);
1198
1199 int scsi_register_interface(struct class_interface *intf)
1200 {
1201         intf->class = &sdev_class;
1202
1203         return class_interface_register(intf);
1204 }
1205 EXPORT_SYMBOL(scsi_register_interface);
1206
1207 /**
1208  * scsi_sysfs_add_host - add scsi host to subsystem
1209  * @shost:     scsi host struct to add to subsystem
1210  **/
1211 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1212 {
1213         int error, i;
1214
1215         /* add host specific attributes */
1216         if (shost->hostt->shost_attrs) {
1217                 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1218                         error = device_create_file(&shost->shost_dev,
1219                                         shost->hostt->shost_attrs[i]);
1220                         if (error)
1221                                 return error;
1222                 }
1223         }
1224
1225         transport_register_device(&shost->shost_gendev);
1226         transport_configure_device(&shost->shost_gendev);
1227         return 0;
1228 }
1229
1230 static struct device_type scsi_dev_type = {
1231         .name =         "scsi_device",
1232         .release =      scsi_device_dev_release,
1233         .groups =       scsi_sdev_attr_groups,
1234 };
1235
1236 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1237 {
1238         unsigned long flags;
1239         struct Scsi_Host *shost = sdev->host;
1240         struct scsi_target  *starget = sdev->sdev_target;
1241
1242         device_initialize(&sdev->sdev_gendev);
1243         sdev->sdev_gendev.bus = &scsi_bus_type;
1244         sdev->sdev_gendev.type = &scsi_dev_type;
1245         dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1246                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1247
1248         device_initialize(&sdev->sdev_dev);
1249         sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1250         sdev->sdev_dev.class = &sdev_class;
1251         dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1252                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1253         /*
1254          * Get a default scsi_level from the target (derived from sibling
1255          * devices).  This is the best we can do for guessing how to set
1256          * sdev->lun_in_cdb for the initial INQUIRY command.  For LUN 0 the
1257          * setting doesn't matter, because all the bits are zero anyway.
1258          * But it does matter for higher LUNs.
1259          */
1260         sdev->scsi_level = starget->scsi_level;
1261         if (sdev->scsi_level <= SCSI_2 &&
1262                         sdev->scsi_level != SCSI_UNKNOWN &&
1263                         !shost->no_scsi2_lun_in_cdb)
1264                 sdev->lun_in_cdb = 1;
1265
1266         transport_setup_device(&sdev->sdev_gendev);
1267         spin_lock_irqsave(shost->host_lock, flags);
1268         list_add_tail(&sdev->same_target_siblings, &starget->devices);
1269         list_add_tail(&sdev->siblings, &shost->__devices);
1270         spin_unlock_irqrestore(shost->host_lock, flags);
1271         /*
1272          * device can now only be removed via __scsi_remove_device() so hold
1273          * the target.  Target will be held in CREATED state until something
1274          * beneath it becomes visible (in which case it moves to RUNNING)
1275          */
1276         kref_get(&starget->reap_ref);
1277 }
1278
1279 int scsi_is_sdev_device(const struct device *dev)
1280 {
1281         return dev->type == &scsi_dev_type;
1282 }
1283 EXPORT_SYMBOL(scsi_is_sdev_device);
1284
1285 /* A blank transport template that is used in drivers that don't
1286  * yet implement Transport Attributes */
1287 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };