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>
24 #include "scsi_priv.h"
25 #include "scsi_logging.h"
27 static struct device_type scsi_dev_type;
30 enum scsi_device_state value;
33 { SDEV_CREATED, "created" },
34 { SDEV_RUNNING, "running" },
35 { SDEV_CANCEL, "cancel" },
36 { SDEV_DEL, "deleted" },
37 { SDEV_QUIESCE, "quiesce" },
38 { SDEV_OFFLINE, "offline" },
39 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
40 { SDEV_BLOCK, "blocked" },
41 { SDEV_CREATED_BLOCK, "created-blocked" },
44 const char *scsi_device_state_name(enum scsi_device_state state)
49 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
50 if (sdev_states[i].value == state) {
51 name = sdev_states[i].name;
59 enum scsi_host_state value;
62 { SHOST_CREATED, "created" },
63 { SHOST_RUNNING, "running" },
64 { SHOST_CANCEL, "cancel" },
65 { SHOST_DEL, "deleted" },
66 { SHOST_RECOVERY, "recovery" },
67 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
68 { SHOST_DEL_RECOVERY, "deleted/recovery", },
70 const char *scsi_host_state_name(enum scsi_host_state state)
75 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
76 if (shost_states[i].value == state) {
77 name = shost_states[i].name;
88 } sdev_access_states[] = {
89 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
90 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
91 { SCSI_ACCESS_STATE_STANDBY, "standby" },
92 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
93 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
94 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
95 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
98 static const char *scsi_access_state_name(unsigned char state)
103 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
104 if (sdev_access_states[i].value == state) {
105 name = sdev_access_states[i].name;
113 static int check_set(unsigned long long *val, char *src)
117 if (strncmp(src, "-", 20) == 0) {
118 *val = SCAN_WILD_CARD;
121 * Doesn't check for int overflow
123 *val = simple_strtoull(src, &last, 0);
130 static int scsi_scan(struct Scsi_Host *shost, const char *str)
132 char s1[15], s2[15], s3[17], junk;
133 unsigned long long channel, id, lun;
136 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
139 if (check_set(&channel, s1))
141 if (check_set(&id, s2))
143 if (check_set(&lun, s3))
145 if (shost->transportt->user_scan)
146 res = shost->transportt->user_scan(shost, channel, id, lun);
148 res = scsi_scan_host_selected(shost, channel, id, lun,
154 * shost_show_function: macro to create an attr function that can be used to
155 * show a non-bit field.
157 #define shost_show_function(name, field, format_string) \
159 show_##name (struct device *dev, struct device_attribute *attr, \
162 struct Scsi_Host *shost = class_to_shost(dev); \
163 return snprintf (buf, 20, format_string, shost->field); \
167 * shost_rd_attr: macro to create a function and attribute variable for a
170 #define shost_rd_attr2(name, field, format_string) \
171 shost_show_function(name, field, format_string) \
172 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
174 #define shost_rd_attr(field, format_string) \
175 shost_rd_attr2(field, field, format_string)
178 * Create the actual show/store functions and data structures.
182 store_scan(struct device *dev, struct device_attribute *attr,
183 const char *buf, size_t count)
185 struct Scsi_Host *shost = class_to_shost(dev);
188 res = scsi_scan(shost, buf);
193 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
196 store_shost_state(struct device *dev, struct device_attribute *attr,
197 const char *buf, size_t count)
200 struct Scsi_Host *shost = class_to_shost(dev);
201 enum scsi_host_state state = 0;
203 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
204 const int len = strlen(shost_states[i].name);
205 if (strncmp(shost_states[i].name, buf, len) == 0 &&
207 state = shost_states[i].value;
214 if (scsi_host_set_state(shost, state))
220 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
222 struct Scsi_Host *shost = class_to_shost(dev);
223 const char *name = scsi_host_state_name(shost->shost_state);
228 return snprintf(buf, 20, "%s\n", name);
231 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
232 static struct device_attribute dev_attr_hstate =
233 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
236 show_shost_mode(unsigned int mode, char *buf)
240 if (mode & MODE_INITIATOR)
241 len = sprintf(buf, "%s", "Initiator");
243 if (mode & MODE_TARGET)
244 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
246 len += sprintf(buf + len, "\n");
252 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
255 struct Scsi_Host *shost = class_to_shost(dev);
256 unsigned int supported_mode = shost->hostt->supported_mode;
258 if (supported_mode == MODE_UNKNOWN)
259 /* by default this should be initiator */
260 supported_mode = MODE_INITIATOR;
262 return show_shost_mode(supported_mode, buf);
265 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
268 show_shost_active_mode(struct device *dev,
269 struct device_attribute *attr, char *buf)
271 struct Scsi_Host *shost = class_to_shost(dev);
273 if (shost->active_mode == MODE_UNKNOWN)
274 return snprintf(buf, 20, "unknown\n");
276 return show_shost_mode(shost->active_mode, buf);
279 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
281 static int check_reset_type(const char *str)
283 if (sysfs_streq(str, "adapter"))
284 return SCSI_ADAPTER_RESET;
285 else if (sysfs_streq(str, "firmware"))
286 return SCSI_FIRMWARE_RESET;
292 store_host_reset(struct device *dev, struct device_attribute *attr,
293 const char *buf, size_t count)
295 struct Scsi_Host *shost = class_to_shost(dev);
296 struct scsi_host_template *sht = shost->hostt;
300 type = check_reset_type(buf);
302 goto exit_store_host_reset;
305 ret = sht->host_reset(shost, type);
307 exit_store_host_reset:
313 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
316 show_shost_eh_deadline(struct device *dev,
317 struct device_attribute *attr, char *buf)
319 struct Scsi_Host *shost = class_to_shost(dev);
321 if (shost->eh_deadline == -1)
322 return snprintf(buf, strlen("off") + 2, "off\n");
323 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
327 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
328 const char *buf, size_t count)
330 struct Scsi_Host *shost = class_to_shost(dev);
332 unsigned long deadline, flags;
334 if (shost->transportt &&
335 (shost->transportt->eh_strategy_handler ||
336 !shost->hostt->eh_host_reset_handler))
339 if (!strncmp(buf, "off", strlen("off")))
342 ret = kstrtoul(buf, 10, &deadline);
345 if (deadline * HZ > UINT_MAX)
349 spin_lock_irqsave(shost->host_lock, flags);
350 if (scsi_host_in_recovery(shost))
354 shost->eh_deadline = -1;
356 shost->eh_deadline = deadline * HZ;
360 spin_unlock_irqrestore(shost->host_lock, flags);
365 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
367 shost_rd_attr(use_blk_mq, "%d\n");
368 shost_rd_attr(unique_id, "%u\n");
369 shost_rd_attr(cmd_per_lun, "%hd\n");
370 shost_rd_attr(can_queue, "%hd\n");
371 shost_rd_attr(sg_tablesize, "%hu\n");
372 shost_rd_attr(sg_prot_tablesize, "%hu\n");
373 shost_rd_attr(unchecked_isa_dma, "%d\n");
374 shost_rd_attr(prot_capabilities, "%u\n");
375 shost_rd_attr(prot_guard_type, "%hd\n");
376 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
379 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
381 struct Scsi_Host *shost = class_to_shost(dev);
382 return snprintf(buf, 20, "%d\n", atomic_read(&shost->host_busy));
384 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
386 static struct attribute *scsi_sysfs_shost_attrs[] = {
387 &dev_attr_use_blk_mq.attr,
388 &dev_attr_unique_id.attr,
389 &dev_attr_host_busy.attr,
390 &dev_attr_cmd_per_lun.attr,
391 &dev_attr_can_queue.attr,
392 &dev_attr_sg_tablesize.attr,
393 &dev_attr_sg_prot_tablesize.attr,
394 &dev_attr_unchecked_isa_dma.attr,
395 &dev_attr_proc_name.attr,
397 &dev_attr_hstate.attr,
398 &dev_attr_supported_mode.attr,
399 &dev_attr_active_mode.attr,
400 &dev_attr_prot_capabilities.attr,
401 &dev_attr_prot_guard_type.attr,
402 &dev_attr_host_reset.attr,
403 &dev_attr_eh_deadline.attr,
407 static struct attribute_group scsi_shost_attr_group = {
408 .attrs = scsi_sysfs_shost_attrs,
411 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
412 &scsi_shost_attr_group,
416 static void scsi_device_cls_release(struct device *class_dev)
418 struct scsi_device *sdev;
420 sdev = class_to_sdev(class_dev);
421 put_device(&sdev->sdev_gendev);
424 static void scsi_device_dev_release_usercontext(struct work_struct *work)
426 struct scsi_device *sdev;
427 struct device *parent;
428 struct list_head *this, *tmp;
432 sdev = container_of(work, struct scsi_device, ew.work);
434 mod = sdev->host->hostt->module;
436 scsi_dh_release_device(sdev);
438 parent = sdev->sdev_gendev.parent;
440 spin_lock_irqsave(sdev->host->host_lock, flags);
441 list_del(&sdev->siblings);
442 list_del(&sdev->same_target_siblings);
443 list_del(&sdev->starved_entry);
444 spin_unlock_irqrestore(sdev->host->host_lock, flags);
446 cancel_work_sync(&sdev->event_work);
448 list_for_each_safe(this, tmp, &sdev->event_list) {
449 struct scsi_event *evt;
451 evt = list_entry(this, struct scsi_event, node);
452 list_del(&evt->node);
456 blk_put_queue(sdev->request_queue);
457 /* NULL queue means the device can't be used */
458 sdev->request_queue = NULL;
460 kfree(sdev->vpd_pg83);
461 kfree(sdev->vpd_pg80);
462 kfree(sdev->inquiry);
470 static void scsi_device_dev_release(struct device *dev)
472 struct scsi_device *sdp = to_scsi_device(dev);
474 /* Set module pointer as NULL in case of module unloading */
475 if (!try_module_get(sdp->host->hostt->module))
476 sdp->host->hostt->module = NULL;
478 execute_in_process_context(scsi_device_dev_release_usercontext,
482 static struct class sdev_class = {
483 .name = "scsi_device",
484 .dev_release = scsi_device_cls_release,
487 /* all probing is done in the individual ->probe routines */
488 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
490 struct scsi_device *sdp;
492 if (dev->type != &scsi_dev_type)
495 sdp = to_scsi_device(dev);
496 if (sdp->no_uld_attach)
498 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
501 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
503 struct scsi_device *sdev;
505 if (dev->type != &scsi_dev_type)
508 sdev = to_scsi_device(dev);
510 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
514 struct bus_type scsi_bus_type = {
516 .match = scsi_bus_match,
517 .uevent = scsi_bus_uevent,
519 .pm = &scsi_bus_pm_ops,
522 EXPORT_SYMBOL_GPL(scsi_bus_type);
524 int scsi_sysfs_register(void)
528 error = bus_register(&scsi_bus_type);
530 error = class_register(&sdev_class);
532 bus_unregister(&scsi_bus_type);
538 void scsi_sysfs_unregister(void)
540 class_unregister(&sdev_class);
541 bus_unregister(&scsi_bus_type);
545 * sdev_show_function: macro to create an attr function that can be used to
546 * show a non-bit field.
548 #define sdev_show_function(field, format_string) \
550 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
553 struct scsi_device *sdev; \
554 sdev = to_scsi_device(dev); \
555 return snprintf (buf, 20, format_string, sdev->field); \
559 * sdev_rd_attr: macro to create a function and attribute variable for a
562 #define sdev_rd_attr(field, format_string) \
563 sdev_show_function(field, format_string) \
564 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
568 * sdev_rw_attr: create a function and attribute variable for a
571 #define sdev_rw_attr(field, format_string) \
572 sdev_show_function(field, format_string) \
575 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
576 const char *buf, size_t count) \
578 struct scsi_device *sdev; \
579 sdev = to_scsi_device(dev); \
580 sscanf (buf, format_string, &sdev->field); \
583 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
585 /* Currently we don't export bit fields, but we might in future,
586 * so leave this code in */
589 * sdev_rd_attr: create a function and attribute variable for a
590 * read/write bit field.
592 #define sdev_rw_attr_bit(field) \
593 sdev_show_function(field, "%d\n") \
596 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
597 const char *buf, size_t count) \
600 struct scsi_device *sdev; \
601 ret = scsi_sdev_check_buf_bit(buf); \
603 sdev = to_scsi_device(dev); \
609 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
612 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
613 * else return -EINVAL.
615 static int scsi_sdev_check_buf_bit(const char *buf)
617 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
620 else if (buf[0] == '0')
629 * Create the actual show/store functions and data structures.
631 sdev_rd_attr (type, "%d\n");
632 sdev_rd_attr (scsi_level, "%d\n");
633 sdev_rd_attr (vendor, "%.8s\n");
634 sdev_rd_attr (model, "%.16s\n");
635 sdev_rd_attr (rev, "%.4s\n");
638 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
641 struct scsi_device *sdev = to_scsi_device(dev);
642 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
644 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
647 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
650 struct scsi_device *sdev = to_scsi_device(dev);
651 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
653 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
656 * TODO: can we make these symlinks to the block layer ones?
659 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
661 struct scsi_device *sdev;
662 sdev = to_scsi_device(dev);
663 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
667 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
668 const char *buf, size_t count)
670 struct scsi_device *sdev;
672 sdev = to_scsi_device(dev);
673 sscanf (buf, "%d\n", &timeout);
674 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
677 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
680 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
682 struct scsi_device *sdev;
683 sdev = to_scsi_device(dev);
684 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
688 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
689 const char *buf, size_t count)
691 struct scsi_device *sdev;
692 unsigned int eh_timeout;
695 if (!capable(CAP_SYS_ADMIN))
698 sdev = to_scsi_device(dev);
699 err = kstrtouint(buf, 10, &eh_timeout);
702 sdev->eh_timeout = eh_timeout * HZ;
706 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
709 store_rescan_field (struct device *dev, struct device_attribute *attr,
710 const char *buf, size_t count)
712 scsi_rescan_device(dev);
715 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
718 sdev_store_delete(struct device *dev, struct device_attribute *attr,
719 const char *buf, size_t count)
721 struct kernfs_node *kn;
722 struct scsi_device *sdev = to_scsi_device(dev);
725 * We need to try to get module, avoiding the module been removed
728 if (scsi_device_get(sdev))
731 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
734 * Concurrent writes into the "delete" sysfs attribute may trigger
735 * concurrent calls to device_remove_file() and scsi_remove_device().
736 * device_remove_file() handles concurrent removal calls by
737 * serializing these and by ignoring the second and later removal
738 * attempts. Concurrent calls of scsi_remove_device() are
739 * serialized. The second and later calls of scsi_remove_device() are
740 * ignored because the first call of that function changes the device
741 * state into SDEV_DEL.
743 device_remove_file(dev, attr);
744 scsi_remove_device(sdev);
746 sysfs_unbreak_active_protection(kn);
747 scsi_device_put(sdev);
750 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
753 store_state_field(struct device *dev, struct device_attribute *attr,
754 const char *buf, size_t count)
757 struct scsi_device *sdev = to_scsi_device(dev);
758 enum scsi_device_state state = 0;
760 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
761 const int len = strlen(sdev_states[i].name);
762 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
764 state = sdev_states[i].value;
771 if (scsi_device_set_state(sdev, state))
777 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
779 struct scsi_device *sdev = to_scsi_device(dev);
780 const char *name = scsi_device_state_name(sdev->sdev_state);
785 return snprintf(buf, 20, "%s\n", name);
788 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
791 show_queue_type_field(struct device *dev, struct device_attribute *attr,
794 struct scsi_device *sdev = to_scsi_device(dev);
795 const char *name = "none";
797 if (sdev->simple_tags)
800 return snprintf(buf, 20, "%s\n", name);
804 store_queue_type_field(struct device *dev, struct device_attribute *attr,
805 const char *buf, size_t count)
807 struct scsi_device *sdev = to_scsi_device(dev);
809 if (!sdev->tagged_supported)
812 sdev_printk(KERN_INFO, sdev,
813 "ignoring write to deprecated queue_type attribute");
817 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
818 store_queue_type_field);
820 #define sdev_vpd_pg_attr(_page) \
822 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
823 struct bin_attribute *bin_attr, \
824 char *buf, loff_t off, size_t count) \
826 struct device *dev = container_of(kobj, struct device, kobj); \
827 struct scsi_device *sdev = to_scsi_device(dev); \
829 if (!sdev->vpd_##_page) \
832 ret = memory_read_from_buffer(buf, count, &off, \
833 rcu_dereference(sdev->vpd_##_page), \
834 sdev->vpd_##_page##_len); \
838 static struct bin_attribute dev_attr_vpd_##_page = { \
839 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
841 .read = show_vpd_##_page, \
844 sdev_vpd_pg_attr(pg83);
845 sdev_vpd_pg_attr(pg80);
847 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
848 struct bin_attribute *bin_attr,
849 char *buf, loff_t off, size_t count)
851 struct device *dev = container_of(kobj, struct device, kobj);
852 struct scsi_device *sdev = to_scsi_device(dev);
857 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
861 static struct bin_attribute dev_attr_inquiry = {
867 .read = show_inquiry,
871 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
874 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
877 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
879 #define show_sdev_iostat(field) \
881 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
884 struct scsi_device *sdev = to_scsi_device(dev); \
885 unsigned long long count = atomic_read(&sdev->field); \
886 return snprintf(buf, 20, "0x%llx\n", count); \
888 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
890 show_sdev_iostat(iorequest_cnt);
891 show_sdev_iostat(iodone_cnt);
892 show_sdev_iostat(ioerr_cnt);
895 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
897 struct scsi_device *sdev;
898 sdev = to_scsi_device(dev);
899 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
901 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
903 #define DECLARE_EVT_SHOW(name, Cap_name) \
905 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
908 struct scsi_device *sdev = to_scsi_device(dev); \
909 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
910 return snprintf(buf, 20, "%d\n", val); \
913 #define DECLARE_EVT_STORE(name, Cap_name) \
915 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
916 const char *buf, size_t count) \
918 struct scsi_device *sdev = to_scsi_device(dev); \
919 int val = simple_strtoul(buf, NULL, 0); \
921 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
923 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
929 #define DECLARE_EVT(name, Cap_name) \
930 DECLARE_EVT_SHOW(name, Cap_name) \
931 DECLARE_EVT_STORE(name, Cap_name) \
932 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
933 sdev_store_evt_##name);
934 #define REF_EVT(name) &dev_attr_evt_##name.attr
936 DECLARE_EVT(media_change, MEDIA_CHANGE)
937 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
938 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
939 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
940 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
941 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
944 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
945 const char *buf, size_t count)
948 struct scsi_device *sdev = to_scsi_device(dev);
949 struct scsi_host_template *sht = sdev->host->hostt;
951 if (!sht->change_queue_depth)
954 depth = simple_strtoul(buf, NULL, 0);
956 if (depth < 1 || depth > sdev->host->can_queue)
959 retval = sht->change_queue_depth(sdev, depth);
963 sdev->max_queue_depth = sdev->queue_depth;
967 sdev_show_function(queue_depth, "%d\n");
969 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
970 sdev_store_queue_depth);
973 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
976 struct scsi_device *sdev = to_scsi_device(dev);
979 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
986 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
988 #ifdef CONFIG_SCSI_DH
990 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
993 struct scsi_device *sdev = to_scsi_device(dev);
996 return snprintf(buf, 20, "detached\n");
998 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1002 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1003 const char *buf, size_t count)
1005 struct scsi_device *sdev = to_scsi_device(dev);
1008 if (sdev->sdev_state == SDEV_CANCEL ||
1009 sdev->sdev_state == SDEV_DEL)
1012 if (!sdev->handler) {
1014 * Attach to a device handler
1016 err = scsi_dh_attach(sdev->request_queue, buf);
1017 } else if (!strncmp(buf, "activate", 8)) {
1019 * Activate a device handler
1021 if (sdev->handler->activate)
1022 err = sdev->handler->activate(sdev, NULL, NULL);
1025 } else if (!strncmp(buf, "detach", 6)) {
1027 * Detach from a device handler
1029 sdev_printk(KERN_WARNING, sdev,
1030 "can't detach handler %s.\n",
1031 sdev->handler->name);
1035 return err < 0 ? err : count;
1038 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1039 sdev_store_dh_state);
1042 sdev_show_access_state(struct device *dev,
1043 struct device_attribute *attr,
1046 struct scsi_device *sdev = to_scsi_device(dev);
1047 unsigned char access_state;
1048 const char *access_state_name;
1053 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1054 access_state_name = scsi_access_state_name(access_state);
1056 return sprintf(buf, "%s\n",
1057 access_state_name ? access_state_name : "unknown");
1059 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1062 sdev_show_preferred_path(struct device *dev,
1063 struct device_attribute *attr,
1066 struct scsi_device *sdev = to_scsi_device(dev);
1071 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1072 return sprintf(buf, "1\n");
1074 return sprintf(buf, "0\n");
1076 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1080 sdev_show_queue_ramp_up_period(struct device *dev,
1081 struct device_attribute *attr,
1084 struct scsi_device *sdev;
1085 sdev = to_scsi_device(dev);
1086 return snprintf(buf, 20, "%u\n",
1087 jiffies_to_msecs(sdev->queue_ramp_up_period));
1091 sdev_store_queue_ramp_up_period(struct device *dev,
1092 struct device_attribute *attr,
1093 const char *buf, size_t count)
1095 struct scsi_device *sdev = to_scsi_device(dev);
1096 unsigned int period;
1098 if (kstrtouint(buf, 10, &period))
1101 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1105 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1106 sdev_show_queue_ramp_up_period,
1107 sdev_store_queue_ramp_up_period);
1109 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1110 struct attribute *attr, int i)
1112 struct device *dev = container_of(kobj, struct device, kobj);
1113 struct scsi_device *sdev = to_scsi_device(dev);
1116 if (attr == &dev_attr_queue_depth.attr &&
1117 !sdev->host->hostt->change_queue_depth)
1120 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1121 !sdev->host->hostt->change_queue_depth)
1124 #ifdef CONFIG_SCSI_DH
1125 if (attr == &dev_attr_access_state.attr &&
1128 if (attr == &dev_attr_preferred_path.attr &&
1135 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1136 struct bin_attribute *attr, int i)
1138 struct device *dev = container_of(kobj, struct device, kobj);
1139 struct scsi_device *sdev = to_scsi_device(dev);
1142 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1145 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1151 /* Default template for device attributes. May NOT be modified */
1152 static struct attribute *scsi_sdev_attrs[] = {
1153 &dev_attr_device_blocked.attr,
1154 &dev_attr_type.attr,
1155 &dev_attr_scsi_level.attr,
1156 &dev_attr_device_busy.attr,
1157 &dev_attr_vendor.attr,
1158 &dev_attr_model.attr,
1160 &dev_attr_rescan.attr,
1161 &dev_attr_delete.attr,
1162 &dev_attr_state.attr,
1163 &dev_attr_timeout.attr,
1164 &dev_attr_eh_timeout.attr,
1165 &dev_attr_iocounterbits.attr,
1166 &dev_attr_iorequest_cnt.attr,
1167 &dev_attr_iodone_cnt.attr,
1168 &dev_attr_ioerr_cnt.attr,
1169 &dev_attr_modalias.attr,
1170 &dev_attr_queue_depth.attr,
1171 &dev_attr_queue_type.attr,
1172 &dev_attr_wwid.attr,
1173 #ifdef CONFIG_SCSI_DH
1174 &dev_attr_dh_state.attr,
1175 &dev_attr_access_state.attr,
1176 &dev_attr_preferred_path.attr,
1178 &dev_attr_queue_ramp_up_period.attr,
1179 REF_EVT(media_change),
1180 REF_EVT(inquiry_change_reported),
1181 REF_EVT(capacity_change_reported),
1182 REF_EVT(soft_threshold_reached),
1183 REF_EVT(mode_parameter_change_reported),
1184 REF_EVT(lun_change_reported),
1188 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1194 static struct attribute_group scsi_sdev_attr_group = {
1195 .attrs = scsi_sdev_attrs,
1196 .bin_attrs = scsi_sdev_bin_attrs,
1197 .is_visible = scsi_sdev_attr_is_visible,
1198 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1201 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1202 &scsi_sdev_attr_group,
1206 static int scsi_target_add(struct scsi_target *starget)
1210 if (starget->state != STARGET_CREATED)
1213 error = device_add(&starget->dev);
1215 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1218 transport_add_device(&starget->dev);
1219 starget->state = STARGET_RUNNING;
1221 pm_runtime_set_active(&starget->dev);
1222 pm_runtime_enable(&starget->dev);
1223 device_enable_async_suspend(&starget->dev);
1229 * scsi_sysfs_add_sdev - add scsi device to sysfs
1230 * @sdev: scsi_device to add
1233 * 0 on Success / non-zero on Failure
1235 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1238 struct request_queue *rq = sdev->request_queue;
1239 struct scsi_target *starget = sdev->sdev_target;
1241 error = scsi_target_add(starget);
1245 transport_configure_device(&starget->dev);
1247 device_enable_async_suspend(&sdev->sdev_gendev);
1248 scsi_autopm_get_target(starget);
1249 pm_runtime_set_active(&sdev->sdev_gendev);
1250 pm_runtime_forbid(&sdev->sdev_gendev);
1251 pm_runtime_enable(&sdev->sdev_gendev);
1252 scsi_autopm_put_target(starget);
1254 scsi_autopm_get_device(sdev);
1256 error = scsi_dh_add_device(sdev);
1259 * device_handler is optional, so any error can be ignored
1261 sdev_printk(KERN_INFO, sdev,
1262 "failed to add device handler: %d\n", error);
1264 error = device_add(&sdev->sdev_gendev);
1266 sdev_printk(KERN_INFO, sdev,
1267 "failed to add device: %d\n", error);
1268 scsi_dh_remove_device(sdev);
1272 device_enable_async_suspend(&sdev->sdev_dev);
1273 error = device_add(&sdev->sdev_dev);
1275 sdev_printk(KERN_INFO, sdev,
1276 "failed to add class device: %d\n", error);
1277 scsi_dh_remove_device(sdev);
1278 device_del(&sdev->sdev_gendev);
1281 transport_add_device(&sdev->sdev_gendev);
1282 sdev->is_visible = 1;
1284 error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
1287 /* we're treating error on bsg register as non-fatal,
1288 * so pretend nothing went wrong */
1289 sdev_printk(KERN_INFO, sdev,
1290 "Failed to register bsg queue, errno=%d\n", error);
1292 /* add additional host specific attributes */
1293 if (sdev->host->hostt->sdev_attrs) {
1294 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1295 error = device_create_file(&sdev->sdev_gendev,
1296 sdev->host->hostt->sdev_attrs[i]);
1302 scsi_autopm_put_device(sdev);
1306 void __scsi_remove_device(struct scsi_device *sdev)
1308 struct device *dev = &sdev->sdev_gendev;
1311 * This cleanup path is not reentrant and while it is impossible
1312 * to get a new reference with scsi_device_get() someone can still
1313 * hold a previously acquired one.
1315 if (sdev->sdev_state == SDEV_DEL)
1318 if (sdev->is_visible) {
1319 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
1322 bsg_unregister_queue(sdev->request_queue);
1323 device_unregister(&sdev->sdev_dev);
1324 transport_remove_device(dev);
1325 scsi_dh_remove_device(sdev);
1328 put_device(&sdev->sdev_dev);
1331 * Stop accepting new requests and wait until all queuecommand() and
1332 * scsi_run_queue() invocations have finished before tearing down the
1335 scsi_device_set_state(sdev, SDEV_DEL);
1336 blk_cleanup_queue(sdev->request_queue);
1337 cancel_work_sync(&sdev->requeue_work);
1339 if (sdev->host->hostt->slave_destroy)
1340 sdev->host->hostt->slave_destroy(sdev);
1341 transport_destroy_device(dev);
1344 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1345 * remoed sysfs visibility from the device, so make the target
1346 * invisible if this was the last device underneath it.
1348 scsi_target_reap(scsi_target(sdev));
1354 * scsi_remove_device - unregister a device from the scsi bus
1355 * @sdev: scsi_device to unregister
1357 void scsi_remove_device(struct scsi_device *sdev)
1359 struct Scsi_Host *shost = sdev->host;
1361 mutex_lock(&shost->scan_mutex);
1362 __scsi_remove_device(sdev);
1363 mutex_unlock(&shost->scan_mutex);
1365 EXPORT_SYMBOL(scsi_remove_device);
1367 static void __scsi_remove_target(struct scsi_target *starget)
1369 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1370 unsigned long flags;
1371 struct scsi_device *sdev;
1373 spin_lock_irqsave(shost->host_lock, flags);
1375 list_for_each_entry(sdev, &shost->__devices, siblings) {
1376 if (sdev->channel != starget->channel ||
1377 sdev->id != starget->id ||
1378 scsi_device_get(sdev))
1380 spin_unlock_irqrestore(shost->host_lock, flags);
1381 scsi_remove_device(sdev);
1382 scsi_device_put(sdev);
1383 spin_lock_irqsave(shost->host_lock, flags);
1386 spin_unlock_irqrestore(shost->host_lock, flags);
1390 * scsi_remove_target - try to remove a target and all its devices
1391 * @dev: generic starget or parent of generic stargets to be removed
1393 * Note: This is slightly racy. It is possible that if the user
1394 * requests the addition of another device then the target won't be
1397 void scsi_remove_target(struct device *dev)
1399 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1400 struct scsi_target *starget;
1401 unsigned long flags;
1404 spin_lock_irqsave(shost->host_lock, flags);
1405 list_for_each_entry(starget, &shost->__targets, siblings) {
1406 if (starget->state == STARGET_DEL ||
1407 starget->state == STARGET_REMOVE ||
1408 starget->state == STARGET_CREATED_REMOVE)
1410 if (starget->dev.parent == dev || &starget->dev == dev) {
1411 kref_get(&starget->reap_ref);
1412 if (starget->state == STARGET_CREATED)
1413 starget->state = STARGET_CREATED_REMOVE;
1415 starget->state = STARGET_REMOVE;
1416 spin_unlock_irqrestore(shost->host_lock, flags);
1417 __scsi_remove_target(starget);
1418 scsi_target_reap(starget);
1422 spin_unlock_irqrestore(shost->host_lock, flags);
1424 EXPORT_SYMBOL(scsi_remove_target);
1426 int scsi_register_driver(struct device_driver *drv)
1428 drv->bus = &scsi_bus_type;
1430 return driver_register(drv);
1432 EXPORT_SYMBOL(scsi_register_driver);
1434 int scsi_register_interface(struct class_interface *intf)
1436 intf->class = &sdev_class;
1438 return class_interface_register(intf);
1440 EXPORT_SYMBOL(scsi_register_interface);
1443 * scsi_sysfs_add_host - add scsi host to subsystem
1444 * @shost: scsi host struct to add to subsystem
1446 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1450 /* add host specific attributes */
1451 if (shost->hostt->shost_attrs) {
1452 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1453 error = device_create_file(&shost->shost_dev,
1454 shost->hostt->shost_attrs[i]);
1460 transport_register_device(&shost->shost_gendev);
1461 transport_configure_device(&shost->shost_gendev);
1465 static struct device_type scsi_dev_type = {
1466 .name = "scsi_device",
1467 .release = scsi_device_dev_release,
1468 .groups = scsi_sdev_attr_groups,
1471 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1473 unsigned long flags;
1474 struct Scsi_Host *shost = sdev->host;
1475 struct scsi_target *starget = sdev->sdev_target;
1477 device_initialize(&sdev->sdev_gendev);
1478 sdev->sdev_gendev.bus = &scsi_bus_type;
1479 sdev->sdev_gendev.type = &scsi_dev_type;
1480 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1481 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1483 device_initialize(&sdev->sdev_dev);
1484 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1485 sdev->sdev_dev.class = &sdev_class;
1486 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1487 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1489 * Get a default scsi_level from the target (derived from sibling
1490 * devices). This is the best we can do for guessing how to set
1491 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1492 * setting doesn't matter, because all the bits are zero anyway.
1493 * But it does matter for higher LUNs.
1495 sdev->scsi_level = starget->scsi_level;
1496 if (sdev->scsi_level <= SCSI_2 &&
1497 sdev->scsi_level != SCSI_UNKNOWN &&
1498 !shost->no_scsi2_lun_in_cdb)
1499 sdev->lun_in_cdb = 1;
1501 transport_setup_device(&sdev->sdev_gendev);
1502 spin_lock_irqsave(shost->host_lock, flags);
1503 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1504 list_add_tail(&sdev->siblings, &shost->__devices);
1505 spin_unlock_irqrestore(shost->host_lock, flags);
1507 * device can now only be removed via __scsi_remove_device() so hold
1508 * the target. Target will be held in CREATED state until something
1509 * beneath it becomes visible (in which case it moves to RUNNING)
1511 kref_get(&starget->reap_ref);
1514 int scsi_is_sdev_device(const struct device *dev)
1516 return dev->type == &scsi_dev_type;
1518 EXPORT_SYMBOL(scsi_is_sdev_device);
1520 /* A blank transport template that is used in drivers that don't
1521 * yet implement Transport Attributes */
1522 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };