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