4 * SCSI sysfs interface routines.
6 * Created to pull SCSI mid layer sysfs routines into one file.
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>
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_dh.h>
21 #include <scsi/scsi_transport.h>
22 #include <scsi/scsi_driver.h>
23 #include <scsi/scsi_devinfo.h>
25 #include "scsi_priv.h"
26 #include "scsi_logging.h"
28 static struct device_type scsi_dev_type;
31 enum scsi_device_state value;
34 { SDEV_CREATED, "created" },
35 { SDEV_RUNNING, "running" },
36 { SDEV_CANCEL, "cancel" },
37 { SDEV_DEL, "deleted" },
38 { SDEV_QUIESCE, "quiesce" },
39 { SDEV_OFFLINE, "offline" },
40 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
41 { SDEV_BLOCK, "blocked" },
42 { SDEV_CREATED_BLOCK, "created-blocked" },
45 const char *scsi_device_state_name(enum scsi_device_state state)
50 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
51 if (sdev_states[i].value == state) {
52 name = sdev_states[i].name;
60 enum scsi_host_state value;
63 { SHOST_CREATED, "created" },
64 { SHOST_RUNNING, "running" },
65 { SHOST_CANCEL, "cancel" },
66 { SHOST_DEL, "deleted" },
67 { SHOST_RECOVERY, "recovery" },
68 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
69 { SHOST_DEL_RECOVERY, "deleted/recovery", },
71 const char *scsi_host_state_name(enum scsi_host_state state)
76 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
77 if (shost_states[i].value == state) {
78 name = shost_states[i].name;
89 } sdev_access_states[] = {
90 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
91 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
92 { SCSI_ACCESS_STATE_STANDBY, "standby" },
93 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
94 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
95 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
96 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
99 static const char *scsi_access_state_name(unsigned char state)
104 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
105 if (sdev_access_states[i].value == state) {
106 name = sdev_access_states[i].name;
114 static int check_set(unsigned long long *val, char *src)
118 if (strcmp(src, "-") == 0) {
119 *val = SCAN_WILD_CARD;
122 * Doesn't check for int overflow
124 *val = simple_strtoull(src, &last, 0);
131 static int scsi_scan(struct Scsi_Host *shost, const char *str)
133 char s1[15], s2[15], s3[17], junk;
134 unsigned long long channel, id, lun;
137 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
140 if (check_set(&channel, s1))
142 if (check_set(&id, s2))
144 if (check_set(&lun, s3))
146 if (shost->transportt->user_scan)
147 res = shost->transportt->user_scan(shost, channel, id, lun);
149 res = scsi_scan_host_selected(shost, channel, id, lun,
155 * shost_show_function: macro to create an attr function that can be used to
156 * show a non-bit field.
158 #define shost_show_function(name, field, format_string) \
160 show_##name (struct device *dev, struct device_attribute *attr, \
163 struct Scsi_Host *shost = class_to_shost(dev); \
164 return snprintf (buf, 20, format_string, shost->field); \
168 * shost_rd_attr: macro to create a function and attribute variable for a
171 #define shost_rd_attr2(name, field, format_string) \
172 shost_show_function(name, field, format_string) \
173 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
175 #define shost_rd_attr(field, format_string) \
176 shost_rd_attr2(field, field, format_string)
179 * Create the actual show/store functions and data structures.
183 store_scan(struct device *dev, struct device_attribute *attr,
184 const char *buf, size_t count)
186 struct Scsi_Host *shost = class_to_shost(dev);
189 res = scsi_scan(shost, buf);
194 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
197 store_shost_state(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t count)
201 struct Scsi_Host *shost = class_to_shost(dev);
202 enum scsi_host_state state = 0;
204 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
205 const int len = strlen(shost_states[i].name);
206 if (strncmp(shost_states[i].name, buf, len) == 0 &&
208 state = shost_states[i].value;
215 if (scsi_host_set_state(shost, state))
221 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
223 struct Scsi_Host *shost = class_to_shost(dev);
224 const char *name = scsi_host_state_name(shost->shost_state);
229 return snprintf(buf, 20, "%s\n", name);
232 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
233 static struct device_attribute dev_attr_hstate =
234 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
237 show_shost_mode(unsigned int mode, char *buf)
241 if (mode & MODE_INITIATOR)
242 len = sprintf(buf, "%s", "Initiator");
244 if (mode & MODE_TARGET)
245 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
247 len += sprintf(buf + len, "\n");
253 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
256 struct Scsi_Host *shost = class_to_shost(dev);
257 unsigned int supported_mode = shost->hostt->supported_mode;
259 if (supported_mode == MODE_UNKNOWN)
260 /* by default this should be initiator */
261 supported_mode = MODE_INITIATOR;
263 return show_shost_mode(supported_mode, buf);
266 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
269 show_shost_active_mode(struct device *dev,
270 struct device_attribute *attr, char *buf)
272 struct Scsi_Host *shost = class_to_shost(dev);
274 if (shost->active_mode == MODE_UNKNOWN)
275 return snprintf(buf, 20, "unknown\n");
277 return show_shost_mode(shost->active_mode, buf);
280 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
282 static int check_reset_type(const char *str)
284 if (sysfs_streq(str, "adapter"))
285 return SCSI_ADAPTER_RESET;
286 else if (sysfs_streq(str, "firmware"))
287 return SCSI_FIRMWARE_RESET;
293 store_host_reset(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
296 struct Scsi_Host *shost = class_to_shost(dev);
297 struct scsi_host_template *sht = shost->hostt;
301 type = check_reset_type(buf);
303 goto exit_store_host_reset;
306 ret = sht->host_reset(shost, type);
310 exit_store_host_reset:
316 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
319 show_shost_eh_deadline(struct device *dev,
320 struct device_attribute *attr, char *buf)
322 struct Scsi_Host *shost = class_to_shost(dev);
324 if (shost->eh_deadline == -1)
325 return snprintf(buf, strlen("off") + 2, "off\n");
326 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
330 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
331 const char *buf, size_t count)
333 struct Scsi_Host *shost = class_to_shost(dev);
335 unsigned long deadline, flags;
337 if (shost->transportt &&
338 (shost->transportt->eh_strategy_handler ||
339 !shost->hostt->eh_host_reset_handler))
342 if (!strncmp(buf, "off", strlen("off")))
345 ret = kstrtoul(buf, 10, &deadline);
348 if (deadline * HZ > UINT_MAX)
352 spin_lock_irqsave(shost->host_lock, flags);
353 if (scsi_host_in_recovery(shost))
357 shost->eh_deadline = -1;
359 shost->eh_deadline = deadline * HZ;
363 spin_unlock_irqrestore(shost->host_lock, flags);
368 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
370 shost_rd_attr(unique_id, "%u\n");
371 shost_rd_attr(cmd_per_lun, "%hd\n");
372 shost_rd_attr(can_queue, "%hd\n");
373 shost_rd_attr(sg_tablesize, "%hu\n");
374 shost_rd_attr(sg_prot_tablesize, "%hu\n");
375 shost_rd_attr(unchecked_isa_dma, "%d\n");
376 shost_rd_attr(prot_capabilities, "%u\n");
377 shost_rd_attr(prot_guard_type, "%hd\n");
378 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
381 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
383 struct Scsi_Host *shost = class_to_shost(dev);
384 return snprintf(buf, 20, "%d\n", scsi_host_busy(shost));
386 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
389 show_use_blk_mq(struct device *dev, struct device_attribute *attr, char *buf)
391 return sprintf(buf, "1\n");
393 static DEVICE_ATTR(use_blk_mq, S_IRUGO, show_use_blk_mq, NULL);
395 static struct attribute *scsi_sysfs_shost_attrs[] = {
396 &dev_attr_use_blk_mq.attr,
397 &dev_attr_unique_id.attr,
398 &dev_attr_host_busy.attr,
399 &dev_attr_cmd_per_lun.attr,
400 &dev_attr_can_queue.attr,
401 &dev_attr_sg_tablesize.attr,
402 &dev_attr_sg_prot_tablesize.attr,
403 &dev_attr_unchecked_isa_dma.attr,
404 &dev_attr_proc_name.attr,
406 &dev_attr_hstate.attr,
407 &dev_attr_supported_mode.attr,
408 &dev_attr_active_mode.attr,
409 &dev_attr_prot_capabilities.attr,
410 &dev_attr_prot_guard_type.attr,
411 &dev_attr_host_reset.attr,
412 &dev_attr_eh_deadline.attr,
416 static struct attribute_group scsi_shost_attr_group = {
417 .attrs = scsi_sysfs_shost_attrs,
420 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
421 &scsi_shost_attr_group,
425 static void scsi_device_cls_release(struct device *class_dev)
427 struct scsi_device *sdev;
429 sdev = class_to_sdev(class_dev);
430 put_device(&sdev->sdev_gendev);
433 static void scsi_device_dev_release_usercontext(struct work_struct *work)
435 struct scsi_device *sdev;
436 struct device *parent;
437 struct list_head *this, *tmp;
438 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
441 sdev = container_of(work, struct scsi_device, ew.work);
443 scsi_dh_release_device(sdev);
445 parent = sdev->sdev_gendev.parent;
447 spin_lock_irqsave(sdev->host->host_lock, flags);
448 list_del(&sdev->siblings);
449 list_del(&sdev->same_target_siblings);
450 list_del(&sdev->starved_entry);
451 spin_unlock_irqrestore(sdev->host->host_lock, flags);
453 cancel_work_sync(&sdev->event_work);
455 list_for_each_safe(this, tmp, &sdev->event_list) {
456 struct scsi_event *evt;
458 evt = list_entry(this, struct scsi_event, node);
459 list_del(&evt->node);
463 blk_put_queue(sdev->request_queue);
464 /* NULL queue means the device can't be used */
465 sdev->request_queue = NULL;
467 mutex_lock(&sdev->inquiry_mutex);
468 rcu_swap_protected(sdev->vpd_pg80, vpd_pg80,
469 lockdep_is_held(&sdev->inquiry_mutex));
470 rcu_swap_protected(sdev->vpd_pg83, vpd_pg83,
471 lockdep_is_held(&sdev->inquiry_mutex));
472 mutex_unlock(&sdev->inquiry_mutex);
475 kfree_rcu(vpd_pg83, rcu);
477 kfree_rcu(vpd_pg80, rcu);
478 kfree(sdev->inquiry);
485 static void scsi_device_dev_release(struct device *dev)
487 struct scsi_device *sdp = to_scsi_device(dev);
488 execute_in_process_context(scsi_device_dev_release_usercontext,
492 static struct class sdev_class = {
493 .name = "scsi_device",
494 .dev_release = scsi_device_cls_release,
497 /* all probing is done in the individual ->probe routines */
498 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
500 struct scsi_device *sdp;
502 if (dev->type != &scsi_dev_type)
505 sdp = to_scsi_device(dev);
506 if (sdp->no_uld_attach)
508 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
511 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
513 struct scsi_device *sdev;
515 if (dev->type != &scsi_dev_type)
518 sdev = to_scsi_device(dev);
520 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
524 struct bus_type scsi_bus_type = {
526 .match = scsi_bus_match,
527 .uevent = scsi_bus_uevent,
529 .pm = &scsi_bus_pm_ops,
532 EXPORT_SYMBOL_GPL(scsi_bus_type);
534 int scsi_sysfs_register(void)
538 error = bus_register(&scsi_bus_type);
540 error = class_register(&sdev_class);
542 bus_unregister(&scsi_bus_type);
548 void scsi_sysfs_unregister(void)
550 class_unregister(&sdev_class);
551 bus_unregister(&scsi_bus_type);
555 * sdev_show_function: macro to create an attr function that can be used to
556 * show a non-bit field.
558 #define sdev_show_function(field, format_string) \
560 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
563 struct scsi_device *sdev; \
564 sdev = to_scsi_device(dev); \
565 return snprintf (buf, 20, format_string, sdev->field); \
569 * sdev_rd_attr: macro to create a function and attribute variable for a
572 #define sdev_rd_attr(field, format_string) \
573 sdev_show_function(field, format_string) \
574 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
578 * sdev_rw_attr: create a function and attribute variable for a
581 #define sdev_rw_attr(field, format_string) \
582 sdev_show_function(field, format_string) \
585 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
586 const char *buf, size_t count) \
588 struct scsi_device *sdev; \
589 sdev = to_scsi_device(dev); \
590 sscanf (buf, format_string, &sdev->field); \
593 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
595 /* Currently we don't export bit fields, but we might in future,
596 * so leave this code in */
599 * sdev_rd_attr: create a function and attribute variable for a
600 * read/write bit field.
602 #define sdev_rw_attr_bit(field) \
603 sdev_show_function(field, "%d\n") \
606 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
607 const char *buf, size_t count) \
610 struct scsi_device *sdev; \
611 ret = scsi_sdev_check_buf_bit(buf); \
613 sdev = to_scsi_device(dev); \
619 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
622 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
623 * else return -EINVAL.
625 static int scsi_sdev_check_buf_bit(const char *buf)
627 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
630 else if (buf[0] == '0')
639 * Create the actual show/store functions and data structures.
641 sdev_rd_attr (type, "%d\n");
642 sdev_rd_attr (scsi_level, "%d\n");
643 sdev_rd_attr (vendor, "%.8s\n");
644 sdev_rd_attr (model, "%.16s\n");
645 sdev_rd_attr (rev, "%.4s\n");
648 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
651 struct scsi_device *sdev = to_scsi_device(dev);
652 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
654 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
657 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
660 struct scsi_device *sdev = to_scsi_device(dev);
661 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
663 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
666 * TODO: can we make these symlinks to the block layer ones?
669 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
671 struct scsi_device *sdev;
672 sdev = to_scsi_device(dev);
673 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
677 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
678 const char *buf, size_t count)
680 struct scsi_device *sdev;
682 sdev = to_scsi_device(dev);
683 sscanf (buf, "%d\n", &timeout);
684 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
687 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
690 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
692 struct scsi_device *sdev;
693 sdev = to_scsi_device(dev);
694 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
698 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
699 const char *buf, size_t count)
701 struct scsi_device *sdev;
702 unsigned int eh_timeout;
705 if (!capable(CAP_SYS_ADMIN))
708 sdev = to_scsi_device(dev);
709 err = kstrtouint(buf, 10, &eh_timeout);
712 sdev->eh_timeout = eh_timeout * HZ;
716 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
719 store_rescan_field (struct device *dev, struct device_attribute *attr,
720 const char *buf, size_t count)
722 scsi_rescan_device(dev);
725 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
728 sdev_store_delete(struct device *dev, struct device_attribute *attr,
729 const char *buf, size_t count)
731 struct kernfs_node *kn;
733 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
736 * Concurrent writes into the "delete" sysfs attribute may trigger
737 * concurrent calls to device_remove_file() and scsi_remove_device().
738 * device_remove_file() handles concurrent removal calls by
739 * serializing these and by ignoring the second and later removal
740 * attempts. Concurrent calls of scsi_remove_device() are
741 * serialized. The second and later calls of scsi_remove_device() are
742 * ignored because the first call of that function changes the device
743 * state into SDEV_DEL.
745 device_remove_file(dev, attr);
746 scsi_remove_device(to_scsi_device(dev));
748 sysfs_unbreak_active_protection(kn);
751 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
754 store_state_field(struct device *dev, struct device_attribute *attr,
755 const char *buf, size_t count)
758 struct scsi_device *sdev = to_scsi_device(dev);
759 enum scsi_device_state state = 0;
761 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
762 const int len = strlen(sdev_states[i].name);
763 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
765 state = sdev_states[i].value;
772 mutex_lock(&sdev->state_mutex);
773 ret = scsi_device_set_state(sdev, state);
774 mutex_unlock(&sdev->state_mutex);
776 return ret == 0 ? count : -EINVAL;
780 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
782 struct scsi_device *sdev = to_scsi_device(dev);
783 const char *name = scsi_device_state_name(sdev->sdev_state);
788 return snprintf(buf, 20, "%s\n", name);
791 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
794 show_queue_type_field(struct device *dev, struct device_attribute *attr,
797 struct scsi_device *sdev = to_scsi_device(dev);
798 const char *name = "none";
800 if (sdev->simple_tags)
803 return snprintf(buf, 20, "%s\n", name);
807 store_queue_type_field(struct device *dev, struct device_attribute *attr,
808 const char *buf, size_t count)
810 struct scsi_device *sdev = to_scsi_device(dev);
812 if (!sdev->tagged_supported)
815 sdev_printk(KERN_INFO, sdev,
816 "ignoring write to deprecated queue_type attribute");
820 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
821 store_queue_type_field);
823 #define sdev_vpd_pg_attr(_page) \
825 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
826 struct bin_attribute *bin_attr, \
827 char *buf, loff_t off, size_t count) \
829 struct device *dev = container_of(kobj, struct device, kobj); \
830 struct scsi_device *sdev = to_scsi_device(dev); \
831 struct scsi_vpd *vpd_page; \
835 vpd_page = rcu_dereference(sdev->vpd_##_page); \
837 ret = memory_read_from_buffer(buf, count, &off, \
838 vpd_page->data, vpd_page->len); \
842 static struct bin_attribute dev_attr_vpd_##_page = { \
843 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
845 .read = show_vpd_##_page, \
848 sdev_vpd_pg_attr(pg83);
849 sdev_vpd_pg_attr(pg80);
851 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
852 struct bin_attribute *bin_attr,
853 char *buf, loff_t off, size_t count)
855 struct device *dev = container_of(kobj, struct device, kobj);
856 struct scsi_device *sdev = to_scsi_device(dev);
861 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
865 static struct bin_attribute dev_attr_inquiry = {
871 .read = show_inquiry,
875 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
878 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
881 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
883 #define show_sdev_iostat(field) \
885 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
888 struct scsi_device *sdev = to_scsi_device(dev); \
889 unsigned long long count = atomic_read(&sdev->field); \
890 return snprintf(buf, 20, "0x%llx\n", count); \
892 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
894 show_sdev_iostat(iorequest_cnt);
895 show_sdev_iostat(iodone_cnt);
896 show_sdev_iostat(ioerr_cnt);
899 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
901 struct scsi_device *sdev;
902 sdev = to_scsi_device(dev);
903 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
905 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
907 #define DECLARE_EVT_SHOW(name, Cap_name) \
909 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
912 struct scsi_device *sdev = to_scsi_device(dev); \
913 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
914 return snprintf(buf, 20, "%d\n", val); \
917 #define DECLARE_EVT_STORE(name, Cap_name) \
919 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
920 const char *buf, size_t count) \
922 struct scsi_device *sdev = to_scsi_device(dev); \
923 int val = simple_strtoul(buf, NULL, 0); \
925 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
927 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
933 #define DECLARE_EVT(name, Cap_name) \
934 DECLARE_EVT_SHOW(name, Cap_name) \
935 DECLARE_EVT_STORE(name, Cap_name) \
936 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
937 sdev_store_evt_##name);
938 #define REF_EVT(name) &dev_attr_evt_##name.attr
940 DECLARE_EVT(media_change, MEDIA_CHANGE)
941 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
942 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
943 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
944 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
945 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
948 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
949 const char *buf, size_t count)
952 struct scsi_device *sdev = to_scsi_device(dev);
953 struct scsi_host_template *sht = sdev->host->hostt;
955 if (!sht->change_queue_depth)
958 depth = simple_strtoul(buf, NULL, 0);
960 if (depth < 1 || depth > sdev->host->can_queue)
963 retval = sht->change_queue_depth(sdev, depth);
967 sdev->max_queue_depth = sdev->queue_depth;
971 sdev_show_function(queue_depth, "%d\n");
973 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
974 sdev_store_queue_depth);
977 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
980 struct scsi_device *sdev = to_scsi_device(dev);
983 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
990 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
992 #define BLIST_FLAG_NAME(name) \
993 [const_ilog2((__force __u64)BLIST_##name)] = #name
994 static const char *const sdev_bflags_name[] = {
995 #include "scsi_devinfo_tbl.c"
997 #undef BLIST_FLAG_NAME
1000 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1003 struct scsi_device *sdev = to_scsi_device(dev);
1007 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1008 const char *name = NULL;
1010 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1012 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1013 name = sdev_bflags_name[i];
1016 len += snprintf(buf + len, PAGE_SIZE - len,
1017 "%s%s", len ? " " : "", name);
1019 len += snprintf(buf + len, PAGE_SIZE - len,
1020 "%sINVALID_BIT(%d)", len ? " " : "", i);
1023 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
1026 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1028 #ifdef CONFIG_SCSI_DH
1030 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1033 struct scsi_device *sdev = to_scsi_device(dev);
1036 return snprintf(buf, 20, "detached\n");
1038 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1042 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1043 const char *buf, size_t count)
1045 struct scsi_device *sdev = to_scsi_device(dev);
1048 if (sdev->sdev_state == SDEV_CANCEL ||
1049 sdev->sdev_state == SDEV_DEL)
1052 if (!sdev->handler) {
1054 * Attach to a device handler
1056 err = scsi_dh_attach(sdev->request_queue, buf);
1057 } else if (!strncmp(buf, "activate", 8)) {
1059 * Activate a device handler
1061 if (sdev->handler->activate)
1062 err = sdev->handler->activate(sdev, NULL, NULL);
1065 } else if (!strncmp(buf, "detach", 6)) {
1067 * Detach from a device handler
1069 sdev_printk(KERN_WARNING, sdev,
1070 "can't detach handler %s.\n",
1071 sdev->handler->name);
1075 return err < 0 ? err : count;
1078 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1079 sdev_store_dh_state);
1082 sdev_show_access_state(struct device *dev,
1083 struct device_attribute *attr,
1086 struct scsi_device *sdev = to_scsi_device(dev);
1087 unsigned char access_state;
1088 const char *access_state_name;
1093 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1094 access_state_name = scsi_access_state_name(access_state);
1096 return sprintf(buf, "%s\n",
1097 access_state_name ? access_state_name : "unknown");
1099 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1102 sdev_show_preferred_path(struct device *dev,
1103 struct device_attribute *attr,
1106 struct scsi_device *sdev = to_scsi_device(dev);
1111 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1112 return sprintf(buf, "1\n");
1114 return sprintf(buf, "0\n");
1116 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1120 sdev_show_queue_ramp_up_period(struct device *dev,
1121 struct device_attribute *attr,
1124 struct scsi_device *sdev;
1125 sdev = to_scsi_device(dev);
1126 return snprintf(buf, 20, "%u\n",
1127 jiffies_to_msecs(sdev->queue_ramp_up_period));
1131 sdev_store_queue_ramp_up_period(struct device *dev,
1132 struct device_attribute *attr,
1133 const char *buf, size_t count)
1135 struct scsi_device *sdev = to_scsi_device(dev);
1136 unsigned int period;
1138 if (kstrtouint(buf, 10, &period))
1141 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1145 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1146 sdev_show_queue_ramp_up_period,
1147 sdev_store_queue_ramp_up_period);
1149 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1150 struct attribute *attr, int i)
1152 struct device *dev = container_of(kobj, struct device, kobj);
1153 struct scsi_device *sdev = to_scsi_device(dev);
1156 if (attr == &dev_attr_queue_depth.attr &&
1157 !sdev->host->hostt->change_queue_depth)
1160 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1161 !sdev->host->hostt->change_queue_depth)
1164 #ifdef CONFIG_SCSI_DH
1165 if (attr == &dev_attr_access_state.attr &&
1168 if (attr == &dev_attr_preferred_path.attr &&
1175 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1176 struct bin_attribute *attr, int i)
1178 struct device *dev = container_of(kobj, struct device, kobj);
1179 struct scsi_device *sdev = to_scsi_device(dev);
1182 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1185 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1191 /* Default template for device attributes. May NOT be modified */
1192 static struct attribute *scsi_sdev_attrs[] = {
1193 &dev_attr_device_blocked.attr,
1194 &dev_attr_type.attr,
1195 &dev_attr_scsi_level.attr,
1196 &dev_attr_device_busy.attr,
1197 &dev_attr_vendor.attr,
1198 &dev_attr_model.attr,
1200 &dev_attr_rescan.attr,
1201 &dev_attr_delete.attr,
1202 &dev_attr_state.attr,
1203 &dev_attr_timeout.attr,
1204 &dev_attr_eh_timeout.attr,
1205 &dev_attr_iocounterbits.attr,
1206 &dev_attr_iorequest_cnt.attr,
1207 &dev_attr_iodone_cnt.attr,
1208 &dev_attr_ioerr_cnt.attr,
1209 &dev_attr_modalias.attr,
1210 &dev_attr_queue_depth.attr,
1211 &dev_attr_queue_type.attr,
1212 &dev_attr_wwid.attr,
1213 &dev_attr_blacklist.attr,
1214 #ifdef CONFIG_SCSI_DH
1215 &dev_attr_dh_state.attr,
1216 &dev_attr_access_state.attr,
1217 &dev_attr_preferred_path.attr,
1219 &dev_attr_queue_ramp_up_period.attr,
1220 REF_EVT(media_change),
1221 REF_EVT(inquiry_change_reported),
1222 REF_EVT(capacity_change_reported),
1223 REF_EVT(soft_threshold_reached),
1224 REF_EVT(mode_parameter_change_reported),
1225 REF_EVT(lun_change_reported),
1229 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1235 static struct attribute_group scsi_sdev_attr_group = {
1236 .attrs = scsi_sdev_attrs,
1237 .bin_attrs = scsi_sdev_bin_attrs,
1238 .is_visible = scsi_sdev_attr_is_visible,
1239 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1242 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1243 &scsi_sdev_attr_group,
1247 static int scsi_target_add(struct scsi_target *starget)
1251 if (starget->state != STARGET_CREATED)
1254 error = device_add(&starget->dev);
1256 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1259 transport_add_device(&starget->dev);
1260 starget->state = STARGET_RUNNING;
1262 pm_runtime_set_active(&starget->dev);
1263 pm_runtime_enable(&starget->dev);
1264 device_enable_async_suspend(&starget->dev);
1270 * scsi_sysfs_add_sdev - add scsi device to sysfs
1271 * @sdev: scsi_device to add
1274 * 0 on Success / non-zero on Failure
1276 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1279 struct request_queue *rq = sdev->request_queue;
1280 struct scsi_target *starget = sdev->sdev_target;
1282 error = scsi_target_add(starget);
1286 transport_configure_device(&starget->dev);
1288 device_enable_async_suspend(&sdev->sdev_gendev);
1289 scsi_autopm_get_target(starget);
1290 pm_runtime_set_active(&sdev->sdev_gendev);
1291 pm_runtime_forbid(&sdev->sdev_gendev);
1292 pm_runtime_enable(&sdev->sdev_gendev);
1293 scsi_autopm_put_target(starget);
1295 scsi_autopm_get_device(sdev);
1297 scsi_dh_add_device(sdev);
1299 error = device_add(&sdev->sdev_gendev);
1301 sdev_printk(KERN_INFO, sdev,
1302 "failed to add device: %d\n", error);
1306 device_enable_async_suspend(&sdev->sdev_dev);
1307 error = device_add(&sdev->sdev_dev);
1309 sdev_printk(KERN_INFO, sdev,
1310 "failed to add class device: %d\n", error);
1311 device_del(&sdev->sdev_gendev);
1314 transport_add_device(&sdev->sdev_gendev);
1315 sdev->is_visible = 1;
1317 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1319 /* we're treating error on bsg register as non-fatal,
1320 * so pretend nothing went wrong */
1321 sdev_printk(KERN_INFO, sdev,
1322 "Failed to register bsg queue, errno=%d\n", error);
1324 /* add additional host specific attributes */
1325 if (sdev->host->hostt->sdev_attrs) {
1326 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1327 error = device_create_file(&sdev->sdev_gendev,
1328 sdev->host->hostt->sdev_attrs[i]);
1334 if (sdev->host->hostt->sdev_groups) {
1335 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1336 sdev->host->hostt->sdev_groups);
1341 scsi_autopm_put_device(sdev);
1345 void __scsi_remove_device(struct scsi_device *sdev)
1347 struct device *dev = &sdev->sdev_gendev;
1351 * This cleanup path is not reentrant and while it is impossible
1352 * to get a new reference with scsi_device_get() someone can still
1353 * hold a previously acquired one.
1355 if (sdev->sdev_state == SDEV_DEL)
1358 if (sdev->is_visible) {
1360 * If scsi_internal_target_block() is running concurrently,
1361 * wait until it has finished before changing the device state.
1363 mutex_lock(&sdev->state_mutex);
1365 * If blocked, we go straight to DEL and restart the queue so
1366 * any commands issued during driver shutdown (like sync
1367 * cache) are errored immediately.
1369 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1371 res = scsi_device_set_state(sdev, SDEV_DEL);
1373 scsi_start_queue(sdev);
1375 mutex_unlock(&sdev->state_mutex);
1380 if (sdev->host->hostt->sdev_groups)
1381 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1382 sdev->host->hostt->sdev_groups);
1384 bsg_unregister_queue(sdev->request_queue);
1385 device_unregister(&sdev->sdev_dev);
1386 transport_remove_device(dev);
1389 put_device(&sdev->sdev_dev);
1392 * Stop accepting new requests and wait until all queuecommand() and
1393 * scsi_run_queue() invocations have finished before tearing down the
1396 mutex_lock(&sdev->state_mutex);
1397 scsi_device_set_state(sdev, SDEV_DEL);
1398 mutex_unlock(&sdev->state_mutex);
1400 blk_cleanup_queue(sdev->request_queue);
1401 cancel_work_sync(&sdev->requeue_work);
1403 if (sdev->host->hostt->slave_destroy)
1404 sdev->host->hostt->slave_destroy(sdev);
1405 transport_destroy_device(dev);
1408 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1409 * remoed sysfs visibility from the device, so make the target
1410 * invisible if this was the last device underneath it.
1412 scsi_target_reap(scsi_target(sdev));
1418 * scsi_remove_device - unregister a device from the scsi bus
1419 * @sdev: scsi_device to unregister
1421 void scsi_remove_device(struct scsi_device *sdev)
1423 struct Scsi_Host *shost = sdev->host;
1425 mutex_lock(&shost->scan_mutex);
1426 __scsi_remove_device(sdev);
1427 mutex_unlock(&shost->scan_mutex);
1429 EXPORT_SYMBOL(scsi_remove_device);
1431 static void __scsi_remove_target(struct scsi_target *starget)
1433 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1434 unsigned long flags;
1435 struct scsi_device *sdev;
1437 spin_lock_irqsave(shost->host_lock, flags);
1439 list_for_each_entry(sdev, &shost->__devices, siblings) {
1441 * We cannot call scsi_device_get() here, as
1442 * we might've been called from rmmod() causing
1443 * scsi_device_get() to fail the module_is_live()
1446 if (sdev->channel != starget->channel ||
1447 sdev->id != starget->id)
1449 if (sdev->sdev_state == SDEV_DEL ||
1450 sdev->sdev_state == SDEV_CANCEL ||
1451 !get_device(&sdev->sdev_gendev))
1453 spin_unlock_irqrestore(shost->host_lock, flags);
1454 scsi_remove_device(sdev);
1455 put_device(&sdev->sdev_gendev);
1456 spin_lock_irqsave(shost->host_lock, flags);
1459 spin_unlock_irqrestore(shost->host_lock, flags);
1463 * scsi_remove_target - try to remove a target and all its devices
1464 * @dev: generic starget or parent of generic stargets to be removed
1466 * Note: This is slightly racy. It is possible that if the user
1467 * requests the addition of another device then the target won't be
1470 void scsi_remove_target(struct device *dev)
1472 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1473 struct scsi_target *starget;
1474 unsigned long flags;
1477 spin_lock_irqsave(shost->host_lock, flags);
1478 list_for_each_entry(starget, &shost->__targets, siblings) {
1479 if (starget->state == STARGET_DEL ||
1480 starget->state == STARGET_REMOVE ||
1481 starget->state == STARGET_CREATED_REMOVE)
1483 if (starget->dev.parent == dev || &starget->dev == dev) {
1484 kref_get(&starget->reap_ref);
1485 if (starget->state == STARGET_CREATED)
1486 starget->state = STARGET_CREATED_REMOVE;
1488 starget->state = STARGET_REMOVE;
1489 spin_unlock_irqrestore(shost->host_lock, flags);
1490 __scsi_remove_target(starget);
1491 scsi_target_reap(starget);
1495 spin_unlock_irqrestore(shost->host_lock, flags);
1497 EXPORT_SYMBOL(scsi_remove_target);
1499 int scsi_register_driver(struct device_driver *drv)
1501 drv->bus = &scsi_bus_type;
1503 return driver_register(drv);
1505 EXPORT_SYMBOL(scsi_register_driver);
1507 int scsi_register_interface(struct class_interface *intf)
1509 intf->class = &sdev_class;
1511 return class_interface_register(intf);
1513 EXPORT_SYMBOL(scsi_register_interface);
1516 * scsi_sysfs_add_host - add scsi host to subsystem
1517 * @shost: scsi host struct to add to subsystem
1519 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1523 /* add host specific attributes */
1524 if (shost->hostt->shost_attrs) {
1525 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1526 error = device_create_file(&shost->shost_dev,
1527 shost->hostt->shost_attrs[i]);
1533 transport_register_device(&shost->shost_gendev);
1534 transport_configure_device(&shost->shost_gendev);
1538 static struct device_type scsi_dev_type = {
1539 .name = "scsi_device",
1540 .release = scsi_device_dev_release,
1541 .groups = scsi_sdev_attr_groups,
1544 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1546 unsigned long flags;
1547 struct Scsi_Host *shost = sdev->host;
1548 struct scsi_target *starget = sdev->sdev_target;
1550 device_initialize(&sdev->sdev_gendev);
1551 sdev->sdev_gendev.bus = &scsi_bus_type;
1552 sdev->sdev_gendev.type = &scsi_dev_type;
1553 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1554 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1556 device_initialize(&sdev->sdev_dev);
1557 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1558 sdev->sdev_dev.class = &sdev_class;
1559 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1560 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1562 * Get a default scsi_level from the target (derived from sibling
1563 * devices). This is the best we can do for guessing how to set
1564 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1565 * setting doesn't matter, because all the bits are zero anyway.
1566 * But it does matter for higher LUNs.
1568 sdev->scsi_level = starget->scsi_level;
1569 if (sdev->scsi_level <= SCSI_2 &&
1570 sdev->scsi_level != SCSI_UNKNOWN &&
1571 !shost->no_scsi2_lun_in_cdb)
1572 sdev->lun_in_cdb = 1;
1574 transport_setup_device(&sdev->sdev_gendev);
1575 spin_lock_irqsave(shost->host_lock, flags);
1576 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1577 list_add_tail(&sdev->siblings, &shost->__devices);
1578 spin_unlock_irqrestore(shost->host_lock, flags);
1580 * device can now only be removed via __scsi_remove_device() so hold
1581 * the target. Target will be held in CREATED state until something
1582 * beneath it becomes visible (in which case it moves to RUNNING)
1584 kref_get(&starget->reap_ref);
1587 int scsi_is_sdev_device(const struct device *dev)
1589 return dev->type == &scsi_dev_type;
1591 EXPORT_SYMBOL(scsi_is_sdev_device);
1593 /* A blank transport template that is used in drivers that don't
1594 * yet implement Transport Attributes */
1595 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };