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