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 int *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_strtoul(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[15], junk;
 103         unsigned int channel, id, lun;
 104         int res;
 105
 106         res = sscanf(str, "%10s %10s %10s %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 && shost->transportt->eh_strategy_handler)
 304                 return ret;
 305
 306         if (!strncmp(buf, "off", strlen("off")))
 307                 deadline = -1;
 308         else {
 309                 ret = kstrtoul(buf, 10, &deadline);
 310                 if (ret)
 311                         return ret;
 312                 if (deadline * HZ > UINT_MAX)
 313                         return -EINVAL;
 314         }
 315
 316         spin_lock_irqsave(shost->host_lock, flags);
 317         if (scsi_host_in_recovery(shost))
 318                 ret = -EBUSY;
 319         else {
 320                 if (deadline == -1)
 321                         shost->eh_deadline = -1;
 322                 else
 323                         shost->eh_deadline = deadline * HZ;
 324
 325                 ret = count;
 326         }
 327         spin_unlock_irqrestore(shost->host_lock, flags);
 328
 329         return ret;
 330 }
 331
 332 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
 333
 334 shost_rd_attr(unique_id, "%u\n");
 335 shost_rd_attr(host_busy, "%hu\n");
 336 shost_rd_attr(cmd_per_lun, "%hd\n");
 337 shost_rd_attr(can_queue, "%hd\n");
 338 shost_rd_attr(sg_tablesize, "%hu\n");
 339 shost_rd_attr(sg_prot_tablesize, "%hu\n");
 340 shost_rd_attr(unchecked_isa_dma, "%d\n");
 341 shost_rd_attr(prot_capabilities, "%u\n");
 342 shost_rd_attr(prot_guard_type, "%hd\n");
 343 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
 344
 345 static struct attribute *scsi_sysfs_shost_attrs[] = {
 346         &dev_attr_unique_id.attr,
 347         &dev_attr_host_busy.attr,
 348         &dev_attr_cmd_per_lun.attr,
 349         &dev_attr_can_queue.attr,
 350         &dev_attr_sg_tablesize.attr,
 351         &dev_attr_sg_prot_tablesize.attr,
 352         &dev_attr_unchecked_isa_dma.attr,
 353         &dev_attr_proc_name.attr,
 354         &dev_attr_scan.attr,
 355         &dev_attr_hstate.attr,
 356         &dev_attr_supported_mode.attr,
 357         &dev_attr_active_mode.attr,
 358         &dev_attr_prot_capabilities.attr,
 359         &dev_attr_prot_guard_type.attr,
 360         &dev_attr_host_reset.attr,
 361         &dev_attr_eh_deadline.attr,
 362         NULL
 363 };
 364
 365 struct attribute_group scsi_shost_attr_group = {
 366         .attrs =        scsi_sysfs_shost_attrs,
 367 };
 368
 369 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
 370         &scsi_shost_attr_group,
 371         NULL
 372 };
 373
 374 static void scsi_device_cls_release(struct device *class_dev)
 375 {
 376         struct scsi_device *sdev;
 377
 378         sdev = class_to_sdev(class_dev);
 379         put_device(&sdev->sdev_gendev);
 380 }
 381
 382 static void scsi_device_dev_release_usercontext(struct work_struct *work)
 383 {
 384         struct scsi_device *sdev;
 385         struct device *parent;
 386         struct list_head *this, *tmp;
 387         unsigned long flags;
 388
 389         sdev = container_of(work, struct scsi_device, ew.work);
 390
 391         parent = sdev->sdev_gendev.parent;
 392
 393         spin_lock_irqsave(sdev->host->host_lock, flags);
 394         list_del(&sdev->siblings);
 395         list_del(&sdev->same_target_siblings);
 396         list_del(&sdev->starved_entry);
 397         spin_unlock_irqrestore(sdev->host->host_lock, flags);
 398
 399         cancel_work_sync(&sdev->event_work);
 400
 401         list_for_each_safe(this, tmp, &sdev->event_list) {
 402                 struct scsi_event *evt;
 403
 404                 evt = list_entry(this, struct scsi_event, node);
 405                 list_del(&evt->node);
 406                 kfree(evt);
 407         }
 408
 409         blk_put_queue(sdev->request_queue);
 410         /* NULL queue means the device can't be used */
 411         sdev->request_queue = NULL;
 412
 413         kfree(sdev->inquiry);
 414         kfree(sdev);
 415
 416         if (parent)
 417                 put_device(parent);
 418 }
 419
 420 static void scsi_device_dev_release(struct device *dev)
 421 {
 422         struct scsi_device *sdp = to_scsi_device(dev);
 423         execute_in_process_context(scsi_device_dev_release_usercontext,
 424                                    &sdp->ew);
 425 }
 426
 427 static struct class sdev_class = {
 428         .name           = "scsi_device",
 429         .dev_release    = scsi_device_cls_release,
 430 };
 431
 432 /* all probing is done in the individual ->probe routines */
 433 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
 434 {
 435         struct scsi_device *sdp;
 436
 437         if (dev->type != &scsi_dev_type)
 438                 return 0;
 439
 440         sdp = to_scsi_device(dev);
 441         if (sdp->no_uld_attach)
 442                 return 0;
 443         return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
 444 }
 445
 446 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
 447 {
 448         struct scsi_device *sdev;
 449
 450         if (dev->type != &scsi_dev_type)
 451                 return 0;
 452
 453         sdev = to_scsi_device(dev);
 454
 455         add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
 456         return 0;
 457 }
 458
 459 struct bus_type scsi_bus_type = {
 460         .name           = "scsi",
 461         .match          = scsi_bus_match,
 462         .uevent         = scsi_bus_uevent,
 463 #ifdef CONFIG_PM
 464         .pm             = &scsi_bus_pm_ops,
 465 #endif
 466 };
 467 EXPORT_SYMBOL_GPL(scsi_bus_type);
 468
 469 int scsi_sysfs_register(void)
 470 {
 471         int error;
 472
 473         error = bus_register(&scsi_bus_type);
 474         if (!error) {
 475                 error = class_register(&sdev_class);
 476                 if (error)
 477                         bus_unregister(&scsi_bus_type);
 478         }
 479
 480         return error;
 481 }
 482
 483 void scsi_sysfs_unregister(void)
 484 {
 485         class_unregister(&sdev_class);
 486         bus_unregister(&scsi_bus_type);
 487 }
 488
 489 /*
 490  * sdev_show_function: macro to create an attr function that can be used to
 491  * show a non-bit field.
 492  */
 493 #define sdev_show_function(field, format_string)                                \
 494 static ssize_t                                                          \
 495 sdev_show_##field (struct device *dev, struct device_attribute *attr,   \
 496                    char *buf)                                           \
 497 {                                                                       \
 498         struct scsi_device *sdev;                                       \
 499         sdev = to_scsi_device(dev);                                     \
 500         return snprintf (buf, 20, format_string, sdev->field);          \
 501 }                                                                       \
 502
 503 /*
 504  * sdev_rd_attr: macro to create a function and attribute variable for a
 505  * read only field.
 506  */
 507 #define sdev_rd_attr(field, format_string)                              \
 508         sdev_show_function(field, format_string)                        \
 509 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
 510
 511
 512 /*
 513  * sdev_rw_attr: create a function and attribute variable for a
 514  * read/write field.
 515  */
 516 #define sdev_rw_attr(field, format_string)                              \
 517         sdev_show_function(field, format_string)                                \
 518                                                                         \
 519 static ssize_t                                                          \
 520 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
 521                     const char *buf, size_t count)                      \
 522 {                                                                       \
 523         struct scsi_device *sdev;                                       \
 524         sdev = to_scsi_device(dev);                                     \
 525         sscanf (buf, format_string, &sdev->field);                      \
 526         return count;                                                   \
 527 }                                                                       \
 528 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
 529
 530 /* Currently we don't export bit fields, but we might in future,
 531  * so leave this code in */
 532 #if 0
 533 /*
 534  * sdev_rd_attr: create a function and attribute variable for a
 535  * read/write bit field.
 536  */
 537 #define sdev_rw_attr_bit(field)                                         \
 538         sdev_show_function(field, "%d\n")                                       \
 539                                                                         \
 540 static ssize_t                                                          \
 541 sdev_store_##field (struct device *dev, struct device_attribute *attr,  \
 542                     const char *buf, size_t count)                      \
 543 {                                                                       \
 544         int ret;                                                        \
 545         struct scsi_device *sdev;                                       \
 546         ret = scsi_sdev_check_buf_bit(buf);                             \
 547         if (ret >= 0)   {                                               \
 548                 sdev = to_scsi_device(dev);                             \
 549                 sdev->field = ret;                                      \
 550                 ret = count;                                            \
 551         }                                                               \
 552         return ret;                                                     \
 553 }                                                                       \
 554 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
 555
 556 /*
 557  * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
 558  * else return -EINVAL.
 559  */
 560 static int scsi_sdev_check_buf_bit(const char *buf)
 561 {
 562         if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
 563                 if (buf[0] == '1')
 564                         return 1;
 565                 else if (buf[0] == '0')
 566                         return 0;
 567                 else
 568                         return -EINVAL;
 569         } else
 570                 return -EINVAL;
 571 }
 572 #endif
 573 /*
 574  * Create the actual show/store functions and data structures.
 575  */
 576 sdev_rd_attr (device_blocked, "%d\n");
 577 sdev_rd_attr (queue_depth, "%d\n");
 578 sdev_rd_attr (device_busy, "%d\n");
 579 sdev_rd_attr (type, "%d\n");
 580 sdev_rd_attr (scsi_level, "%d\n");
 581 sdev_rd_attr (vendor, "%.8s\n");
 582 sdev_rd_attr (model, "%.16s\n");
 583 sdev_rd_attr (rev, "%.4s\n");
 584
 585 /*
 586  * TODO: can we make these symlinks to the block layer ones?
 587  */
 588 static ssize_t
 589 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
 590 {
 591         struct scsi_device *sdev;
 592         sdev = to_scsi_device(dev);
 593         return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
 594 }
 595
 596 static ssize_t
 597 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
 598                     const char *buf, size_t count)
 599 {
 600         struct scsi_device *sdev;
 601         int timeout;
 602         sdev = to_scsi_device(dev);
 603         sscanf (buf, "%d\n", &timeout);
 604         blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
 605         return count;
 606 }
 607 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
 608
 609 static ssize_t
 610 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
 611 {
 612         struct scsi_device *sdev;
 613         sdev = to_scsi_device(dev);
 614         return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
 615 }
 616
 617 static ssize_t
 618 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
 619                     const char *buf, size_t count)
 620 {
 621         struct scsi_device *sdev;
 622         unsigned int eh_timeout;
 623         int err;
 624
 625         if (!capable(CAP_SYS_ADMIN))
 626                 return -EACCES;
 627
 628         sdev = to_scsi_device(dev);
 629         err = kstrtouint(buf, 10, &eh_timeout);
 630         if (err)
 631                 return err;
 632         sdev->eh_timeout = eh_timeout * HZ;
 633
 634         return count;
 635 }
 636 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
 637
 638 static ssize_t
 639 store_rescan_field (struct device *dev, struct device_attribute *attr,
 640                     const char *buf, size_t count)
 641 {
 642         scsi_rescan_device(dev);
 643         return count;
 644 }
 645 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
 646
 647 static void sdev_store_delete_callback(struct device *dev)
 648 {
 649         scsi_remove_device(to_scsi_device(dev));
 650 }
 651
 652 static ssize_t
 653 sdev_store_delete(struct device *dev, struct device_attribute *attr,
 654                   const char *buf, size_t count)
 655 {
 656         int rc;
 657
 658         /* An attribute cannot be unregistered by one of its own methods,
 659          * so we have to use this roundabout approach.
 660          */
 661         rc = device_schedule_callback(dev, sdev_store_delete_callback);
 662         if (rc)
 663                 count = rc;
 664         return count;
 665 };
 666 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
 667
 668 static ssize_t
 669 store_state_field(struct device *dev, struct device_attribute *attr,
 670                   const char *buf, size_t count)
 671 {
 672         int i;
 673         struct scsi_device *sdev = to_scsi_device(dev);
 674         enum scsi_device_state state = 0;
 675
 676         for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
 677                 const int len = strlen(sdev_states[i].name);
 678                 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
 679                    buf[len] == '\n') {
 680                         state = sdev_states[i].value;
 681                         break;
 682                 }
 683         }
 684         if (!state)
 685                 return -EINVAL;
 686
 687         if (scsi_device_set_state(sdev, state))
 688                 return -EINVAL;
 689         return count;
 690 }
 691
 692 static ssize_t
 693 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
 694 {
 695         struct scsi_device *sdev = to_scsi_device(dev);
 696         const char *name = scsi_device_state_name(sdev->sdev_state);
 697
 698         if (!name)
 699                 return -EINVAL;
 700
 701         return snprintf(buf, 20, "%s\n", name);
 702 }
 703
 704 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
 705
 706 static ssize_t
 707 show_queue_type_field(struct device *dev, struct device_attribute *attr,
 708                       char *buf)
 709 {
 710         struct scsi_device *sdev = to_scsi_device(dev);
 711         const char *name = "none";
 712
 713         if (sdev->ordered_tags)
 714                 name = "ordered";
 715         else if (sdev->simple_tags)
 716                 name = "simple";
 717
 718         return snprintf(buf, 20, "%s\n", name);
 719 }
 720
 721 static DEVICE_ATTR(queue_type, S_IRUGO, show_queue_type_field, NULL);
 722
 723 static ssize_t
 724 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,                              char *buf)
 725 {
 726         return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
 727 }
 728
 729 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
 730
 731 #define show_sdev_iostat(field)                                         \
 732 static ssize_t                                                          \
 733 show_iostat_##field(struct device *dev, struct device_attribute *attr,  \
 734                     char *buf)                                          \
 735 {                                                                       \
 736         struct scsi_device *sdev = to_scsi_device(dev);                 \
 737         unsigned long long count = atomic_read(&sdev->field);           \
 738         return snprintf(buf, 20, "0x%llx\n", count);                    \
 739 }                                                                       \
 740 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
 741
 742 show_sdev_iostat(iorequest_cnt);
 743 show_sdev_iostat(iodone_cnt);
 744 show_sdev_iostat(ioerr_cnt);
 745
 746 static ssize_t
 747 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
 748 {
 749         struct scsi_device *sdev;
 750         sdev = to_scsi_device(dev);
 751         return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
 752 }
 753 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
 754
 755 #define DECLARE_EVT_SHOW(name, Cap_name)                                \
 756 static ssize_t                                                          \
 757 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
 758                      char *buf)                                         \
 759 {                                                                       \
 760         struct scsi_device *sdev = to_scsi_device(dev);                 \
 761         int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
 762         return snprintf(buf, 20, "%d\n", val);                          \
 763 }
 764
 765 #define DECLARE_EVT_STORE(name, Cap_name)                               \
 766 static ssize_t                                                          \
 767 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
 768                       const char *buf, size_t count)                    \
 769 {                                                                       \
 770         struct scsi_device *sdev = to_scsi_device(dev);                 \
 771         int val = simple_strtoul(buf, NULL, 0);                         \
 772         if (val == 0)                                                   \
 773                 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
 774         else if (val == 1)                                              \
 775                 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events);   \
 776         else                                                            \
 777                 return -EINVAL;                                         \
 778         return count;                                                   \
 779 }
 780
 781 #define DECLARE_EVT(name, Cap_name)                                     \
 782         DECLARE_EVT_SHOW(name, Cap_name)                                \
 783         DECLARE_EVT_STORE(name, Cap_name)                               \
 784         static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name,   \
 785                            sdev_store_evt_##name);
 786 #define REF_EVT(name) &dev_attr_evt_##name.attr
 787
 788 DECLARE_EVT(media_change, MEDIA_CHANGE)
 789 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
 790 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
 791 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
 792 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
 793 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
 794
 795 /* Default template for device attributes.  May NOT be modified */
 796 static struct attribute *scsi_sdev_attrs[] = {
 797         &dev_attr_device_blocked.attr,
 798         &dev_attr_type.attr,
 799         &dev_attr_scsi_level.attr,
 800         &dev_attr_device_busy.attr,
 801         &dev_attr_vendor.attr,
 802         &dev_attr_model.attr,
 803         &dev_attr_rev.attr,
 804         &dev_attr_rescan.attr,
 805         &dev_attr_delete.attr,
 806         &dev_attr_state.attr,
 807         &dev_attr_timeout.attr,
 808         &dev_attr_eh_timeout.attr,
 809         &dev_attr_iocounterbits.attr,
 810         &dev_attr_iorequest_cnt.attr,
 811         &dev_attr_iodone_cnt.attr,
 812         &dev_attr_ioerr_cnt.attr,
 813         &dev_attr_modalias.attr,
 814         REF_EVT(media_change),
 815         REF_EVT(inquiry_change_reported),
 816         REF_EVT(capacity_change_reported),
 817         REF_EVT(soft_threshold_reached),
 818         REF_EVT(mode_parameter_change_reported),
 819         REF_EVT(lun_change_reported),
 820         NULL
 821 };
 822
 823 static struct attribute_group scsi_sdev_attr_group = {
 824         .attrs =        scsi_sdev_attrs,
 825 };
 826
 827 static const struct attribute_group *scsi_sdev_attr_groups[] = {
 828         &scsi_sdev_attr_group,
 829         NULL
 830 };
 831
 832 static ssize_t
 833 sdev_store_queue_depth_rw(struct device *dev, struct device_attribute *attr,
 834                           const char *buf, size_t count)
 835 {
 836         int depth, retval;
 837         struct scsi_device *sdev = to_scsi_device(dev);
 838         struct scsi_host_template *sht = sdev->host->hostt;
 839
 840         if (!sht->change_queue_depth)
 841                 return -EINVAL;
 842
 843         depth = simple_strtoul(buf, NULL, 0);
 844
 845         if (depth < 1)
 846                 return -EINVAL;
 847
 848         retval = sht->change_queue_depth(sdev, depth,
 849                                          SCSI_QDEPTH_DEFAULT);
 850         if (retval < 0)
 851                 return retval;
 852
 853         sdev->max_queue_depth = sdev->queue_depth;
 854
 855         return count;
 856 }
 857
 858 static struct device_attribute sdev_attr_queue_depth_rw =
 859         __ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
 860                sdev_store_queue_depth_rw);
 861
 862 static ssize_t
 863 sdev_show_queue_ramp_up_period(struct device *dev,
 864                                struct device_attribute *attr,
 865                                char *buf)
 866 {
 867         struct scsi_device *sdev;
 868         sdev = to_scsi_device(dev);
 869         return snprintf(buf, 20, "%u\n",
 870                         jiffies_to_msecs(sdev->queue_ramp_up_period));
 871 }
 872
 873 static ssize_t
 874 sdev_store_queue_ramp_up_period(struct device *dev,
 875                                 struct device_attribute *attr,
 876                                 const char *buf, size_t count)
 877 {
 878         struct scsi_device *sdev = to_scsi_device(dev);
 879         unsigned long period;
 880
 881         if (strict_strtoul(buf, 10, &period))
 882                 return -EINVAL;
 883
 884         sdev->queue_ramp_up_period = msecs_to_jiffies(period);
 885         return period;
 886 }
 887
 888 static struct device_attribute sdev_attr_queue_ramp_up_period =
 889         __ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
 890                sdev_show_queue_ramp_up_period,
 891                sdev_store_queue_ramp_up_period);
 892
 893 static ssize_t
 894 sdev_store_queue_type_rw(struct device *dev, struct device_attribute *attr,
 895                          const char *buf, size_t count)
 896 {
 897         struct scsi_device *sdev = to_scsi_device(dev);
 898         struct scsi_host_template *sht = sdev->host->hostt;
 899         int tag_type = 0, retval;
 900         int prev_tag_type = scsi_get_tag_type(sdev);
 901
 902         if (!sdev->tagged_supported || !sht->change_queue_type)
 903                 return -EINVAL;
 904
 905         if (strncmp(buf, "ordered", 7) == 0)
 906                 tag_type = MSG_ORDERED_TAG;
 907         else if (strncmp(buf, "simple", 6) == 0)
 908                 tag_type = MSG_SIMPLE_TAG;
 909         else if (strncmp(buf, "none", 4) != 0)
 910                 return -EINVAL;
 911
 912         if (tag_type == prev_tag_type)
 913                 return count;
 914
 915         retval = sht->change_queue_type(sdev, tag_type);
 916         if (retval < 0)
 917                 return retval;
 918
 919         return count;
 920 }
 921
 922 static int scsi_target_add(struct scsi_target *starget)
 923 {
 924         int error;
 925
 926         if (starget->state != STARGET_CREATED)
 927                 return 0;
 928
 929         error = device_add(&starget->dev);
 930         if (error) {
 931                 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
 932                 return error;
 933         }
 934         transport_add_device(&starget->dev);
 935         starget->state = STARGET_RUNNING;
 936
 937         pm_runtime_set_active(&starget->dev);
 938         pm_runtime_enable(&starget->dev);
 939         device_enable_async_suspend(&starget->dev);
 940
 941         return 0;
 942 }
 943
 944 static struct device_attribute sdev_attr_queue_type_rw =
 945         __ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
 946                sdev_store_queue_type_rw);
 947
 948 /**
 949  * scsi_sysfs_add_sdev - add scsi device to sysfs
 950  * @sdev:       scsi_device to add
 951  *
 952  * Return value:
 953  *      0 on Success / non-zero on Failure
 954  **/
 955 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
 956 {
 957         int error, i;
 958         struct request_queue *rq = sdev->request_queue;
 959         struct scsi_target *starget = sdev->sdev_target;
 960
 961         error = scsi_device_set_state(sdev, SDEV_RUNNING);
 962         if (error)
 963                 return error;
 964
 965         error = scsi_target_add(starget);
 966         if (error)
 967                 return error;
 968
 969         transport_configure_device(&starget->dev);
 970
 971         device_enable_async_suspend(&sdev->sdev_gendev);
 972         scsi_autopm_get_target(starget);
 973         pm_runtime_set_active(&sdev->sdev_gendev);
 974         pm_runtime_forbid(&sdev->sdev_gendev);
 975         pm_runtime_enable(&sdev->sdev_gendev);
 976         scsi_autopm_put_target(starget);
 977
 978         /* The following call will keep sdev active indefinitely, until
 979          * its driver does a corresponding scsi_autopm_pm_device().  Only
 980          * drivers supporting autosuspend will do this.
 981          */
 982         scsi_autopm_get_device(sdev);
 983
 984         error = device_add(&sdev->sdev_gendev);
 985         if (error) {
 986                 sdev_printk(KERN_INFO, sdev,
 987                                 "failed to add device: %d\n", error);
 988                 return error;
 989         }
 990         device_enable_async_suspend(&sdev->sdev_dev);
 991         error = device_add(&sdev->sdev_dev);
 992         if (error) {
 993                 sdev_printk(KERN_INFO, sdev,
 994                                 "failed to add class device: %d\n", error);
 995                 device_del(&sdev->sdev_gendev);
 996                 return error;
 997         }
 998         transport_add_device(&sdev->sdev_gendev);
 999         sdev->is_visible = 1;
1000
1001         /* create queue files, which may be writable, depending on the host */
1002         if (sdev->host->hostt->change_queue_depth) {
1003                 error = device_create_file(&sdev->sdev_gendev,
1004                                            &sdev_attr_queue_depth_rw);
1005                 error = device_create_file(&sdev->sdev_gendev,
1006                                            &sdev_attr_queue_ramp_up_period);
1007         }
1008         else
1009                 error = device_create_file(&sdev->sdev_gendev, &dev_attr_queue_depth);
1010         if (error)
1011                 return error;
1012
1013         if (sdev->host->hostt->change_queue_type)
1014                 error = device_create_file(&sdev->sdev_gendev, &sdev_attr_queue_type_rw);
1015         else
1016                 error = device_create_file(&sdev->sdev_gendev, &dev_attr_queue_type);
1017         if (error)
1018                 return error;
1019
1020         error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
1021
1022         if (error)
1023                 /* we're treating error on bsg register as non-fatal,
1024                  * so pretend nothing went wrong */
1025                 sdev_printk(KERN_INFO, sdev,
1026                             "Failed to register bsg queue, errno=%d\n", error);
1027
1028         /* add additional host specific attributes */
1029         if (sdev->host->hostt->sdev_attrs) {
1030                 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1031                         error = device_create_file(&sdev->sdev_gendev,
1032                                         sdev->host->hostt->sdev_attrs[i]);
1033                         if (error)
1034                                 return error;
1035                 }
1036         }
1037
1038         return error;
1039 }
1040
1041 void __scsi_remove_device(struct scsi_device *sdev)
1042 {
1043         struct device *dev = &sdev->sdev_gendev;
1044
1045         if (sdev->is_visible) {
1046                 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1047                         return;
1048
1049                 bsg_unregister_queue(sdev->request_queue);
1050                 device_unregister(&sdev->sdev_dev);
1051                 transport_remove_device(dev);
1052                 device_del(dev);
1053         } else
1054                 put_device(&sdev->sdev_dev);
1055
1056         /*
1057          * Stop accepting new requests and wait until all queuecommand() and
1058          * scsi_run_queue() invocations have finished before tearing down the
1059          * device.
1060          */
1061         scsi_device_set_state(sdev, SDEV_DEL);
1062         blk_cleanup_queue(sdev->request_queue);
1063         cancel_work_sync(&sdev->requeue_work);
1064
1065         if (sdev->host->hostt->slave_destroy)
1066                 sdev->host->hostt->slave_destroy(sdev);
1067         transport_destroy_device(dev);
1068
1069         /*
1070          * Paired with the kref_get() in scsi_sysfs_initialize().  We have
1071          * remoed sysfs visibility from the device, so make the target
1072          * invisible if this was the last device underneath it.
1073          */
1074         scsi_target_reap(scsi_target(sdev));
1075
1076         put_device(dev);
1077 }
1078
1079 /**
1080  * scsi_remove_device - unregister a device from the scsi bus
1081  * @sdev:       scsi_device to unregister
1082  **/
1083 void scsi_remove_device(struct scsi_device *sdev)
1084 {
1085         struct Scsi_Host *shost = sdev->host;
1086
1087         mutex_lock(&shost->scan_mutex);
1088         __scsi_remove_device(sdev);
1089         mutex_unlock(&shost->scan_mutex);
1090 }
1091 EXPORT_SYMBOL(scsi_remove_device);
1092
1093 static void __scsi_remove_target(struct scsi_target *starget)
1094 {
1095         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1096         unsigned long flags;
1097         struct scsi_device *sdev;
1098
1099         spin_lock_irqsave(shost->host_lock, flags);
1100  restart:
1101         list_for_each_entry(sdev, &shost->__devices, siblings) {
1102                 if (sdev->channel != starget->channel ||
1103                     sdev->id != starget->id ||
1104                     scsi_device_get(sdev))
1105                         continue;
1106                 spin_unlock_irqrestore(shost->host_lock, flags);
1107                 scsi_remove_device(sdev);
1108                 scsi_device_put(sdev);
1109                 spin_lock_irqsave(shost->host_lock, flags);
1110                 goto restart;
1111         }
1112         spin_unlock_irqrestore(shost->host_lock, flags);
1113 }
1114
1115 /**
1116  * scsi_remove_target - try to remove a target and all its devices
1117  * @dev: generic starget or parent of generic stargets to be removed
1118  *
1119  * Note: This is slightly racy.  It is possible that if the user
1120  * requests the addition of another device then the target won't be
1121  * removed.
1122  */
1123 void scsi_remove_target(struct device *dev)
1124 {
1125         struct Scsi_Host *shost = dev_to_shost(dev->parent);
1126         struct scsi_target *starget, *last = NULL;
1127         unsigned long flags;
1128
1129         /* remove targets being careful to lookup next entry before
1130          * deleting the last
1131          */
1132         spin_lock_irqsave(shost->host_lock, flags);
1133         list_for_each_entry(starget, &shost->__targets, siblings) {
1134                 if (starget->state == STARGET_DEL)
1135                         continue;
1136                 if (starget->dev.parent == dev || &starget->dev == dev) {
1137                         /* assuming new targets arrive at the end */
1138                         kref_get(&starget->reap_ref);
1139                         spin_unlock_irqrestore(shost->host_lock, flags);
1140                         if (last)
1141                                 scsi_target_reap(last);
1142                         last = starget;
1143                         __scsi_remove_target(starget);
1144                         spin_lock_irqsave(shost->host_lock, flags);
1145                 }
1146         }
1147         spin_unlock_irqrestore(shost->host_lock, flags);
1148
1149         if (last)
1150                 scsi_target_reap(last);
1151 }
1152 EXPORT_SYMBOL(scsi_remove_target);
1153
1154 int scsi_register_driver(struct device_driver *drv)
1155 {
1156         drv->bus = &scsi_bus_type;
1157
1158         return driver_register(drv);
1159 }
1160 EXPORT_SYMBOL(scsi_register_driver);
1161
1162 int scsi_register_interface(struct class_interface *intf)
1163 {
1164         intf->class = &sdev_class;
1165
1166         return class_interface_register(intf);
1167 }
1168 EXPORT_SYMBOL(scsi_register_interface);
1169
1170 /**
1171  * scsi_sysfs_add_host - add scsi host to subsystem
1172  * @shost:     scsi host struct to add to subsystem
1173  **/
1174 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1175 {
1176         int error, i;
1177
1178         /* add host specific attributes */
1179         if (shost->hostt->shost_attrs) {
1180                 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1181                         error = device_create_file(&shost->shost_dev,
1182                                         shost->hostt->shost_attrs[i]);
1183                         if (error)
1184                                 return error;
1185                 }
1186         }
1187
1188         transport_register_device(&shost->shost_gendev);
1189         transport_configure_device(&shost->shost_gendev);
1190         return 0;
1191 }
1192
1193 static struct device_type scsi_dev_type = {
1194         .name =         "scsi_device",
1195         .release =      scsi_device_dev_release,
1196         .groups =       scsi_sdev_attr_groups,
1197 };
1198
1199 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1200 {
1201         unsigned long flags;
1202         struct Scsi_Host *shost = sdev->host;
1203         struct scsi_target  *starget = sdev->sdev_target;
1204
1205         device_initialize(&sdev->sdev_gendev);
1206         sdev->sdev_gendev.bus = &scsi_bus_type;
1207         sdev->sdev_gendev.type = &scsi_dev_type;
1208         dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%d",
1209                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1210
1211         device_initialize(&sdev->sdev_dev);
1212         sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1213         sdev->sdev_dev.class = &sdev_class;
1214         dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%d",
1215                      sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1216         sdev->scsi_level = starget->scsi_level;
1217         transport_setup_device(&sdev->sdev_gendev);
1218         spin_lock_irqsave(shost->host_lock, flags);
1219         list_add_tail(&sdev->same_target_siblings, &starget->devices);
1220         list_add_tail(&sdev->siblings, &shost->__devices);
1221         spin_unlock_irqrestore(shost->host_lock, flags);
1222         /*
1223          * device can now only be removed via __scsi_remove_device() so hold
1224          * the target.  Target will be held in CREATED state until something
1225          * beneath it becomes visible (in which case it moves to RUNNING)
1226          */
1227         kref_get(&starget->reap_ref);
1228 }
1229
1230 int scsi_is_sdev_device(const struct device *dev)
1231 {
1232         return dev->type == &scsi_dev_type;
1233 }
1234 EXPORT_SYMBOL(scsi_is_sdev_device);
1235
1236 /* A blank transport template that is used in drivers that don't
1237  * yet implement Transport Attributes */
1238 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };