drivers/scsi/scsi_sysfs.c

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