1 // SPDX-License-Identifier: GPL-2.0-only
5 * SCSI sysfs interface routines.
7 * Created to pull SCSI mid layer sysfs routines into one file.
10 #include <linux/module.h>
11 #include <linux/slab.h>
12 #include <linux/init.h>
13 #include <linux/blkdev.h>
14 #include <linux/device.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/bsg.h>
18 #include <scsi/scsi.h>
19 #include <scsi/scsi_device.h>
20 #include <scsi/scsi_host.h>
21 #include <scsi/scsi_tcq.h>
22 #include <scsi/scsi_dh.h>
23 #include <scsi/scsi_transport.h>
24 #include <scsi/scsi_driver.h>
25 #include <scsi/scsi_devinfo.h>
27 #include "scsi_priv.h"
28 #include "scsi_logging.h"
30 static struct device_type scsi_dev_type;
33 enum scsi_device_state value;
36 { SDEV_CREATED, "created" },
37 { SDEV_RUNNING, "running" },
38 { SDEV_CANCEL, "cancel" },
39 { SDEV_DEL, "deleted" },
40 { SDEV_QUIESCE, "quiesce" },
41 { SDEV_OFFLINE, "offline" },
42 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
43 { SDEV_BLOCK, "blocked" },
44 { SDEV_CREATED_BLOCK, "created-blocked" },
47 const char *scsi_device_state_name(enum scsi_device_state state)
52 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
53 if (sdev_states[i].value == state) {
54 name = sdev_states[i].name;
62 enum scsi_host_state value;
65 { SHOST_CREATED, "created" },
66 { SHOST_RUNNING, "running" },
67 { SHOST_CANCEL, "cancel" },
68 { SHOST_DEL, "deleted" },
69 { SHOST_RECOVERY, "recovery" },
70 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
71 { SHOST_DEL_RECOVERY, "deleted/recovery", },
73 const char *scsi_host_state_name(enum scsi_host_state state)
78 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
79 if (shost_states[i].value == state) {
80 name = shost_states[i].name;
91 } sdev_access_states[] = {
92 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
93 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
94 { SCSI_ACCESS_STATE_STANDBY, "standby" },
95 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
96 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
97 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
98 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
101 static const char *scsi_access_state_name(unsigned char state)
106 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
107 if (sdev_access_states[i].value == state) {
108 name = sdev_access_states[i].name;
116 static int check_set(unsigned long long *val, char *src)
120 if (strcmp(src, "-") == 0) {
121 *val = SCAN_WILD_CARD;
124 * Doesn't check for int overflow
126 *val = simple_strtoull(src, &last, 0);
133 static int scsi_scan(struct Scsi_Host *shost, const char *str)
135 char s1[15], s2[15], s3[17], junk;
136 unsigned long long channel, id, lun;
139 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
142 if (check_set(&channel, s1))
144 if (check_set(&id, s2))
146 if (check_set(&lun, s3))
148 if (shost->transportt->user_scan)
149 res = shost->transportt->user_scan(shost, channel, id, lun);
151 res = scsi_scan_host_selected(shost, channel, id, lun,
157 * shost_show_function: macro to create an attr function that can be used to
158 * show a non-bit field.
160 #define shost_show_function(name, field, format_string) \
162 show_##name (struct device *dev, struct device_attribute *attr, \
165 struct Scsi_Host *shost = class_to_shost(dev); \
166 return snprintf (buf, 20, format_string, shost->field); \
170 * shost_rd_attr: macro to create a function and attribute variable for a
173 #define shost_rd_attr2(name, field, format_string) \
174 shost_show_function(name, field, format_string) \
175 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
177 #define shost_rd_attr(field, format_string) \
178 shost_rd_attr2(field, field, format_string)
181 * Create the actual show/store functions and data structures.
185 store_scan(struct device *dev, struct device_attribute *attr,
186 const char *buf, size_t count)
188 struct Scsi_Host *shost = class_to_shost(dev);
191 res = scsi_scan(shost, buf);
196 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
199 store_shost_state(struct device *dev, struct device_attribute *attr,
200 const char *buf, size_t count)
203 struct Scsi_Host *shost = class_to_shost(dev);
204 enum scsi_host_state state = 0;
206 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
207 const int len = strlen(shost_states[i].name);
208 if (strncmp(shost_states[i].name, buf, len) == 0 &&
210 state = shost_states[i].value;
217 if (scsi_host_set_state(shost, state))
223 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
225 struct Scsi_Host *shost = class_to_shost(dev);
226 const char *name = scsi_host_state_name(shost->shost_state);
231 return snprintf(buf, 20, "%s\n", name);
234 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
235 static struct device_attribute dev_attr_hstate =
236 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
239 show_shost_mode(unsigned int mode, char *buf)
243 if (mode & MODE_INITIATOR)
244 len = sprintf(buf, "%s", "Initiator");
246 if (mode & MODE_TARGET)
247 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
249 len += sprintf(buf + len, "\n");
255 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
258 struct Scsi_Host *shost = class_to_shost(dev);
259 unsigned int supported_mode = shost->hostt->supported_mode;
261 if (supported_mode == MODE_UNKNOWN)
262 /* by default this should be initiator */
263 supported_mode = MODE_INITIATOR;
265 return show_shost_mode(supported_mode, buf);
268 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
271 show_shost_active_mode(struct device *dev,
272 struct device_attribute *attr, char *buf)
274 struct Scsi_Host *shost = class_to_shost(dev);
276 if (shost->active_mode == MODE_UNKNOWN)
277 return snprintf(buf, 20, "unknown\n");
279 return show_shost_mode(shost->active_mode, buf);
282 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
284 static int check_reset_type(const char *str)
286 if (sysfs_streq(str, "adapter"))
287 return SCSI_ADAPTER_RESET;
288 else if (sysfs_streq(str, "firmware"))
289 return SCSI_FIRMWARE_RESET;
295 store_host_reset(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count)
298 struct Scsi_Host *shost = class_to_shost(dev);
299 struct scsi_host_template *sht = shost->hostt;
303 type = check_reset_type(buf);
305 goto exit_store_host_reset;
308 ret = sht->host_reset(shost, type);
312 exit_store_host_reset:
318 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
321 show_shost_eh_deadline(struct device *dev,
322 struct device_attribute *attr, char *buf)
324 struct Scsi_Host *shost = class_to_shost(dev);
326 if (shost->eh_deadline == -1)
327 return snprintf(buf, strlen("off") + 2, "off\n");
328 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
332 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
333 const char *buf, size_t count)
335 struct Scsi_Host *shost = class_to_shost(dev);
337 unsigned long deadline, flags;
339 if (shost->transportt &&
340 (shost->transportt->eh_strategy_handler ||
341 !shost->hostt->eh_host_reset_handler))
344 if (!strncmp(buf, "off", strlen("off")))
347 ret = kstrtoul(buf, 10, &deadline);
350 if (deadline * HZ > UINT_MAX)
354 spin_lock_irqsave(shost->host_lock, flags);
355 if (scsi_host_in_recovery(shost))
359 shost->eh_deadline = -1;
361 shost->eh_deadline = deadline * HZ;
365 spin_unlock_irqrestore(shost->host_lock, flags);
370 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
372 shost_rd_attr(unique_id, "%u\n");
373 shost_rd_attr(cmd_per_lun, "%hd\n");
374 shost_rd_attr(can_queue, "%d\n");
375 shost_rd_attr(sg_tablesize, "%hu\n");
376 shost_rd_attr(sg_prot_tablesize, "%hu\n");
377 shost_rd_attr(prot_capabilities, "%u\n");
378 shost_rd_attr(prot_guard_type, "%hd\n");
379 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
382 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
384 struct Scsi_Host *shost = class_to_shost(dev);
385 return snprintf(buf, 20, "%d\n", scsi_host_busy(shost));
387 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
390 show_use_blk_mq(struct device *dev, struct device_attribute *attr, char *buf)
392 return sprintf(buf, "1\n");
394 static DEVICE_ATTR(use_blk_mq, S_IRUGO, show_use_blk_mq, NULL);
397 show_nr_hw_queues(struct device *dev, struct device_attribute *attr, char *buf)
399 struct Scsi_Host *shost = class_to_shost(dev);
400 struct blk_mq_tag_set *tag_set = &shost->tag_set;
402 return snprintf(buf, 20, "%d\n", tag_set->nr_hw_queues);
404 static DEVICE_ATTR(nr_hw_queues, S_IRUGO, show_nr_hw_queues, NULL);
406 static struct attribute *scsi_sysfs_shost_attrs[] = {
407 &dev_attr_use_blk_mq.attr,
408 &dev_attr_unique_id.attr,
409 &dev_attr_host_busy.attr,
410 &dev_attr_cmd_per_lun.attr,
411 &dev_attr_can_queue.attr,
412 &dev_attr_sg_tablesize.attr,
413 &dev_attr_sg_prot_tablesize.attr,
414 &dev_attr_proc_name.attr,
416 &dev_attr_hstate.attr,
417 &dev_attr_supported_mode.attr,
418 &dev_attr_active_mode.attr,
419 &dev_attr_prot_capabilities.attr,
420 &dev_attr_prot_guard_type.attr,
421 &dev_attr_host_reset.attr,
422 &dev_attr_eh_deadline.attr,
423 &dev_attr_nr_hw_queues.attr,
427 static struct attribute_group scsi_shost_attr_group = {
428 .attrs = scsi_sysfs_shost_attrs,
431 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
432 &scsi_shost_attr_group,
436 static void scsi_device_cls_release(struct device *class_dev)
438 struct scsi_device *sdev;
440 sdev = class_to_sdev(class_dev);
441 put_device(&sdev->sdev_gendev);
444 static void scsi_device_dev_release_usercontext(struct work_struct *work)
446 struct scsi_device *sdev;
447 struct device *parent;
448 struct list_head *this, *tmp;
449 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
450 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
454 sdev = container_of(work, struct scsi_device, ew.work);
456 mod = sdev->host->hostt->module;
458 scsi_dh_release_device(sdev);
460 parent = sdev->sdev_gendev.parent;
462 spin_lock_irqsave(sdev->host->host_lock, flags);
463 list_del(&sdev->siblings);
464 list_del(&sdev->same_target_siblings);
465 list_del(&sdev->starved_entry);
466 spin_unlock_irqrestore(sdev->host->host_lock, flags);
468 cancel_work_sync(&sdev->event_work);
470 list_for_each_safe(this, tmp, &sdev->event_list) {
471 struct scsi_event *evt;
473 evt = list_entry(this, struct scsi_event, node);
474 list_del(&evt->node);
478 blk_put_queue(sdev->request_queue);
479 /* NULL queue means the device can't be used */
480 sdev->request_queue = NULL;
482 sbitmap_free(&sdev->budget_map);
484 mutex_lock(&sdev->inquiry_mutex);
485 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
486 lockdep_is_held(&sdev->inquiry_mutex));
487 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
488 lockdep_is_held(&sdev->inquiry_mutex));
489 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
490 lockdep_is_held(&sdev->inquiry_mutex));
491 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
492 lockdep_is_held(&sdev->inquiry_mutex));
493 mutex_unlock(&sdev->inquiry_mutex);
496 kfree_rcu(vpd_pg0, rcu);
498 kfree_rcu(vpd_pg83, rcu);
500 kfree_rcu(vpd_pg80, rcu);
502 kfree_rcu(vpd_pg89, rcu);
503 kfree(sdev->inquiry);
511 static void scsi_device_dev_release(struct device *dev)
513 struct scsi_device *sdp = to_scsi_device(dev);
515 /* Set module pointer as NULL in case of module unloading */
516 if (!try_module_get(sdp->host->hostt->module))
517 sdp->host->hostt->module = NULL;
519 execute_in_process_context(scsi_device_dev_release_usercontext,
523 static struct class sdev_class = {
524 .name = "scsi_device",
525 .dev_release = scsi_device_cls_release,
528 /* all probing is done in the individual ->probe routines */
529 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
531 struct scsi_device *sdp;
533 if (dev->type != &scsi_dev_type)
536 sdp = to_scsi_device(dev);
537 if (sdp->no_uld_attach)
539 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
542 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
544 struct scsi_device *sdev;
546 if (dev->type != &scsi_dev_type)
549 sdev = to_scsi_device(dev);
551 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
555 struct bus_type scsi_bus_type = {
557 .match = scsi_bus_match,
558 .uevent = scsi_bus_uevent,
560 .pm = &scsi_bus_pm_ops,
563 EXPORT_SYMBOL_GPL(scsi_bus_type);
565 int scsi_sysfs_register(void)
569 error = bus_register(&scsi_bus_type);
571 error = class_register(&sdev_class);
573 bus_unregister(&scsi_bus_type);
579 void scsi_sysfs_unregister(void)
581 class_unregister(&sdev_class);
582 bus_unregister(&scsi_bus_type);
586 * sdev_show_function: macro to create an attr function that can be used to
587 * show a non-bit field.
589 #define sdev_show_function(field, format_string) \
591 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
594 struct scsi_device *sdev; \
595 sdev = to_scsi_device(dev); \
596 return snprintf (buf, 20, format_string, sdev->field); \
600 * sdev_rd_attr: macro to create a function and attribute variable for a
603 #define sdev_rd_attr(field, format_string) \
604 sdev_show_function(field, format_string) \
605 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
609 * sdev_rw_attr: create a function and attribute variable for a
612 #define sdev_rw_attr(field, format_string) \
613 sdev_show_function(field, format_string) \
616 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
617 const char *buf, size_t count) \
619 struct scsi_device *sdev; \
620 sdev = to_scsi_device(dev); \
621 sscanf (buf, format_string, &sdev->field); \
624 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
626 /* Currently we don't export bit fields, but we might in future,
627 * so leave this code in */
630 * sdev_rd_attr: create a function and attribute variable for a
631 * read/write bit field.
633 #define sdev_rw_attr_bit(field) \
634 sdev_show_function(field, "%d\n") \
637 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
638 const char *buf, size_t count) \
641 struct scsi_device *sdev; \
642 ret = scsi_sdev_check_buf_bit(buf); \
644 sdev = to_scsi_device(dev); \
650 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
653 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
654 * else return -EINVAL.
656 static int scsi_sdev_check_buf_bit(const char *buf)
658 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
661 else if (buf[0] == '0')
670 * Create the actual show/store functions and data structures.
672 sdev_rd_attr (type, "%d\n");
673 sdev_rd_attr (scsi_level, "%d\n");
674 sdev_rd_attr (vendor, "%.8s\n");
675 sdev_rd_attr (model, "%.16s\n");
676 sdev_rd_attr (rev, "%.4s\n");
679 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
682 struct scsi_device *sdev = to_scsi_device(dev);
683 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
685 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
688 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
691 struct scsi_device *sdev = to_scsi_device(dev);
692 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
694 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
697 * TODO: can we make these symlinks to the block layer ones?
700 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
702 struct scsi_device *sdev;
703 sdev = to_scsi_device(dev);
704 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
708 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
709 const char *buf, size_t count)
711 struct scsi_device *sdev;
713 sdev = to_scsi_device(dev);
714 sscanf (buf, "%d\n", &timeout);
715 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
718 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
721 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
723 struct scsi_device *sdev;
724 sdev = to_scsi_device(dev);
725 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
729 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
730 const char *buf, size_t count)
732 struct scsi_device *sdev;
733 unsigned int eh_timeout;
736 if (!capable(CAP_SYS_ADMIN))
739 sdev = to_scsi_device(dev);
740 err = kstrtouint(buf, 10, &eh_timeout);
743 sdev->eh_timeout = eh_timeout * HZ;
747 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
750 store_rescan_field (struct device *dev, struct device_attribute *attr,
751 const char *buf, size_t count)
753 scsi_rescan_device(dev);
756 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
759 sdev_store_delete(struct device *dev, struct device_attribute *attr,
760 const char *buf, size_t count)
762 struct kernfs_node *kn;
763 struct scsi_device *sdev = to_scsi_device(dev);
766 * We need to try to get module, avoiding the module been removed
769 if (scsi_device_get(sdev))
772 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
775 * Concurrent writes into the "delete" sysfs attribute may trigger
776 * concurrent calls to device_remove_file() and scsi_remove_device().
777 * device_remove_file() handles concurrent removal calls by
778 * serializing these and by ignoring the second and later removal
779 * attempts. Concurrent calls of scsi_remove_device() are
780 * serialized. The second and later calls of scsi_remove_device() are
781 * ignored because the first call of that function changes the device
782 * state into SDEV_DEL.
784 device_remove_file(dev, attr);
785 scsi_remove_device(sdev);
787 sysfs_unbreak_active_protection(kn);
788 scsi_device_put(sdev);
791 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
794 store_state_field(struct device *dev, struct device_attribute *attr,
795 const char *buf, size_t count)
798 struct scsi_device *sdev = to_scsi_device(dev);
799 enum scsi_device_state state = 0;
801 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
802 const int len = strlen(sdev_states[i].name);
803 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
805 state = sdev_states[i].value;
817 mutex_lock(&sdev->state_mutex);
818 ret = scsi_device_set_state(sdev, state);
820 * If the device state changes to SDEV_RUNNING, we need to
821 * run the queue to avoid I/O hang, and rescan the device
822 * to revalidate it. Running the queue first is necessary
823 * because another thread may be waiting inside
824 * blk_mq_freeze_queue_wait() and because that call may be
825 * waiting for pending I/O to finish.
827 if (ret == 0 && state == SDEV_RUNNING) {
828 blk_mq_run_hw_queues(sdev->request_queue, true);
829 scsi_rescan_device(dev);
831 mutex_unlock(&sdev->state_mutex);
833 return ret == 0 ? count : -EINVAL;
837 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
839 struct scsi_device *sdev = to_scsi_device(dev);
840 const char *name = scsi_device_state_name(sdev->sdev_state);
845 return snprintf(buf, 20, "%s\n", name);
848 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
851 show_queue_type_field(struct device *dev, struct device_attribute *attr,
854 struct scsi_device *sdev = to_scsi_device(dev);
855 const char *name = "none";
857 if (sdev->simple_tags)
860 return snprintf(buf, 20, "%s\n", name);
864 store_queue_type_field(struct device *dev, struct device_attribute *attr,
865 const char *buf, size_t count)
867 struct scsi_device *sdev = to_scsi_device(dev);
869 if (!sdev->tagged_supported)
872 sdev_printk(KERN_INFO, sdev,
873 "ignoring write to deprecated queue_type attribute");
877 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
878 store_queue_type_field);
880 #define sdev_vpd_pg_attr(_page) \
882 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
883 struct bin_attribute *bin_attr, \
884 char *buf, loff_t off, size_t count) \
886 struct device *dev = kobj_to_dev(kobj); \
887 struct scsi_device *sdev = to_scsi_device(dev); \
888 struct scsi_vpd *vpd_page; \
892 vpd_page = rcu_dereference(sdev->vpd_##_page); \
894 ret = memory_read_from_buffer(buf, count, &off, \
895 vpd_page->data, vpd_page->len); \
899 static struct bin_attribute dev_attr_vpd_##_page = { \
900 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
902 .read = show_vpd_##_page, \
905 sdev_vpd_pg_attr(pg83);
906 sdev_vpd_pg_attr(pg80);
907 sdev_vpd_pg_attr(pg89);
908 sdev_vpd_pg_attr(pg0);
910 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
911 struct bin_attribute *bin_attr,
912 char *buf, loff_t off, size_t count)
914 struct device *dev = kobj_to_dev(kobj);
915 struct scsi_device *sdev = to_scsi_device(dev);
920 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
924 static struct bin_attribute dev_attr_inquiry = {
930 .read = show_inquiry,
934 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
937 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
940 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
942 #define show_sdev_iostat(field) \
944 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
947 struct scsi_device *sdev = to_scsi_device(dev); \
948 unsigned long long count = atomic_read(&sdev->field); \
949 return snprintf(buf, 20, "0x%llx\n", count); \
951 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
953 show_sdev_iostat(iorequest_cnt);
954 show_sdev_iostat(iodone_cnt);
955 show_sdev_iostat(ioerr_cnt);
958 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
960 struct scsi_device *sdev;
961 sdev = to_scsi_device(dev);
962 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
964 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
966 #define DECLARE_EVT_SHOW(name, Cap_name) \
968 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
971 struct scsi_device *sdev = to_scsi_device(dev); \
972 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
973 return snprintf(buf, 20, "%d\n", val); \
976 #define DECLARE_EVT_STORE(name, Cap_name) \
978 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
979 const char *buf, size_t count) \
981 struct scsi_device *sdev = to_scsi_device(dev); \
982 int val = simple_strtoul(buf, NULL, 0); \
984 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
986 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
992 #define DECLARE_EVT(name, Cap_name) \
993 DECLARE_EVT_SHOW(name, Cap_name) \
994 DECLARE_EVT_STORE(name, Cap_name) \
995 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
996 sdev_store_evt_##name);
997 #define REF_EVT(name) &dev_attr_evt_##name.attr
999 DECLARE_EVT(media_change, MEDIA_CHANGE)
1000 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1001 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1002 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1003 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1004 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
1007 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1008 const char *buf, size_t count)
1011 struct scsi_device *sdev = to_scsi_device(dev);
1012 struct scsi_host_template *sht = sdev->host->hostt;
1014 if (!sht->change_queue_depth)
1017 depth = simple_strtoul(buf, NULL, 0);
1019 if (depth < 1 || depth > sdev->host->can_queue)
1022 retval = sht->change_queue_depth(sdev, depth);
1026 sdev->max_queue_depth = sdev->queue_depth;
1030 sdev_show_function(queue_depth, "%d\n");
1032 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1033 sdev_store_queue_depth);
1036 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1039 struct scsi_device *sdev = to_scsi_device(dev);
1042 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1049 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1051 #define BLIST_FLAG_NAME(name) \
1052 [const_ilog2((__force __u64)BLIST_##name)] = #name
1053 static const char *const sdev_bflags_name[] = {
1054 #include "scsi_devinfo_tbl.c"
1056 #undef BLIST_FLAG_NAME
1059 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1062 struct scsi_device *sdev = to_scsi_device(dev);
1066 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1067 const char *name = NULL;
1069 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1071 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1072 name = sdev_bflags_name[i];
1075 len += scnprintf(buf + len, PAGE_SIZE - len,
1076 "%s%s", len ? " " : "", name);
1078 len += scnprintf(buf + len, PAGE_SIZE - len,
1079 "%sINVALID_BIT(%d)", len ? " " : "", i);
1082 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1085 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1087 #ifdef CONFIG_SCSI_DH
1089 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1092 struct scsi_device *sdev = to_scsi_device(dev);
1095 return snprintf(buf, 20, "detached\n");
1097 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1101 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1102 const char *buf, size_t count)
1104 struct scsi_device *sdev = to_scsi_device(dev);
1107 if (sdev->sdev_state == SDEV_CANCEL ||
1108 sdev->sdev_state == SDEV_DEL)
1111 if (!sdev->handler) {
1113 * Attach to a device handler
1115 err = scsi_dh_attach(sdev->request_queue, buf);
1116 } else if (!strncmp(buf, "activate", 8)) {
1118 * Activate a device handler
1120 if (sdev->handler->activate)
1121 err = sdev->handler->activate(sdev, NULL, NULL);
1124 } else if (!strncmp(buf, "detach", 6)) {
1126 * Detach from a device handler
1128 sdev_printk(KERN_WARNING, sdev,
1129 "can't detach handler %s.\n",
1130 sdev->handler->name);
1134 return err < 0 ? err : count;
1137 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1138 sdev_store_dh_state);
1141 sdev_show_access_state(struct device *dev,
1142 struct device_attribute *attr,
1145 struct scsi_device *sdev = to_scsi_device(dev);
1146 unsigned char access_state;
1147 const char *access_state_name;
1152 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1153 access_state_name = scsi_access_state_name(access_state);
1155 return sprintf(buf, "%s\n",
1156 access_state_name ? access_state_name : "unknown");
1158 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1161 sdev_show_preferred_path(struct device *dev,
1162 struct device_attribute *attr,
1165 struct scsi_device *sdev = to_scsi_device(dev);
1170 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1171 return sprintf(buf, "1\n");
1173 return sprintf(buf, "0\n");
1175 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1179 sdev_show_queue_ramp_up_period(struct device *dev,
1180 struct device_attribute *attr,
1183 struct scsi_device *sdev;
1184 sdev = to_scsi_device(dev);
1185 return snprintf(buf, 20, "%u\n",
1186 jiffies_to_msecs(sdev->queue_ramp_up_period));
1190 sdev_store_queue_ramp_up_period(struct device *dev,
1191 struct device_attribute *attr,
1192 const char *buf, size_t count)
1194 struct scsi_device *sdev = to_scsi_device(dev);
1195 unsigned int period;
1197 if (kstrtouint(buf, 10, &period))
1200 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1204 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1205 sdev_show_queue_ramp_up_period,
1206 sdev_store_queue_ramp_up_period);
1208 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1209 struct attribute *attr, int i)
1211 struct device *dev = kobj_to_dev(kobj);
1212 struct scsi_device *sdev = to_scsi_device(dev);
1215 if (attr == &dev_attr_queue_depth.attr &&
1216 !sdev->host->hostt->change_queue_depth)
1219 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1220 !sdev->host->hostt->change_queue_depth)
1223 #ifdef CONFIG_SCSI_DH
1224 if (attr == &dev_attr_access_state.attr &&
1227 if (attr == &dev_attr_preferred_path.attr &&
1234 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1235 struct bin_attribute *attr, int i)
1237 struct device *dev = kobj_to_dev(kobj);
1238 struct scsi_device *sdev = to_scsi_device(dev);
1241 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1244 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1247 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1250 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1256 /* Default template for device attributes. May NOT be modified */
1257 static struct attribute *scsi_sdev_attrs[] = {
1258 &dev_attr_device_blocked.attr,
1259 &dev_attr_type.attr,
1260 &dev_attr_scsi_level.attr,
1261 &dev_attr_device_busy.attr,
1262 &dev_attr_vendor.attr,
1263 &dev_attr_model.attr,
1265 &dev_attr_rescan.attr,
1266 &dev_attr_delete.attr,
1267 &dev_attr_state.attr,
1268 &dev_attr_timeout.attr,
1269 &dev_attr_eh_timeout.attr,
1270 &dev_attr_iocounterbits.attr,
1271 &dev_attr_iorequest_cnt.attr,
1272 &dev_attr_iodone_cnt.attr,
1273 &dev_attr_ioerr_cnt.attr,
1274 &dev_attr_modalias.attr,
1275 &dev_attr_queue_depth.attr,
1276 &dev_attr_queue_type.attr,
1277 &dev_attr_wwid.attr,
1278 &dev_attr_blacklist.attr,
1279 #ifdef CONFIG_SCSI_DH
1280 &dev_attr_dh_state.attr,
1281 &dev_attr_access_state.attr,
1282 &dev_attr_preferred_path.attr,
1284 &dev_attr_queue_ramp_up_period.attr,
1285 REF_EVT(media_change),
1286 REF_EVT(inquiry_change_reported),
1287 REF_EVT(capacity_change_reported),
1288 REF_EVT(soft_threshold_reached),
1289 REF_EVT(mode_parameter_change_reported),
1290 REF_EVT(lun_change_reported),
1294 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1302 static struct attribute_group scsi_sdev_attr_group = {
1303 .attrs = scsi_sdev_attrs,
1304 .bin_attrs = scsi_sdev_bin_attrs,
1305 .is_visible = scsi_sdev_attr_is_visible,
1306 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1309 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1310 &scsi_sdev_attr_group,
1314 static int scsi_target_add(struct scsi_target *starget)
1318 if (starget->state != STARGET_CREATED)
1321 error = device_add(&starget->dev);
1323 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1326 transport_add_device(&starget->dev);
1327 starget->state = STARGET_RUNNING;
1329 pm_runtime_set_active(&starget->dev);
1330 pm_runtime_enable(&starget->dev);
1331 device_enable_async_suspend(&starget->dev);
1337 * scsi_sysfs_add_sdev - add scsi device to sysfs
1338 * @sdev: scsi_device to add
1341 * 0 on Success / non-zero on Failure
1343 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1346 struct scsi_target *starget = sdev->sdev_target;
1348 error = scsi_target_add(starget);
1352 transport_configure_device(&starget->dev);
1354 device_enable_async_suspend(&sdev->sdev_gendev);
1355 scsi_autopm_get_target(starget);
1356 pm_runtime_set_active(&sdev->sdev_gendev);
1357 if (!sdev->rpm_autosuspend)
1358 pm_runtime_forbid(&sdev->sdev_gendev);
1359 pm_runtime_enable(&sdev->sdev_gendev);
1360 scsi_autopm_put_target(starget);
1362 scsi_autopm_get_device(sdev);
1364 scsi_dh_add_device(sdev);
1366 error = device_add(&sdev->sdev_gendev);
1368 sdev_printk(KERN_INFO, sdev,
1369 "failed to add device: %d\n", error);
1373 device_enable_async_suspend(&sdev->sdev_dev);
1374 error = device_add(&sdev->sdev_dev);
1376 sdev_printk(KERN_INFO, sdev,
1377 "failed to add class device: %d\n", error);
1378 device_del(&sdev->sdev_gendev);
1381 transport_add_device(&sdev->sdev_gendev);
1382 sdev->is_visible = 1;
1384 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1385 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1386 if (IS_ERR(sdev->bsg_dev)) {
1388 * We're treating error on bsg register as non-fatal, so
1389 * pretend nothing went wrong.
1391 sdev_printk(KERN_INFO, sdev,
1392 "Failed to register bsg queue, errno=%d\n",
1394 sdev->bsg_dev = NULL;
1398 /* add additional host specific attributes */
1399 if (sdev->host->hostt->sdev_attrs) {
1400 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1401 error = device_create_file(&sdev->sdev_gendev,
1402 sdev->host->hostt->sdev_attrs[i]);
1408 if (sdev->host->hostt->sdev_groups) {
1409 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1410 sdev->host->hostt->sdev_groups);
1415 scsi_autopm_put_device(sdev);
1419 void __scsi_remove_device(struct scsi_device *sdev)
1421 struct device *dev = &sdev->sdev_gendev;
1425 * This cleanup path is not reentrant and while it is impossible
1426 * to get a new reference with scsi_device_get() someone can still
1427 * hold a previously acquired one.
1429 if (sdev->sdev_state == SDEV_DEL)
1432 if (sdev->is_visible) {
1434 * If scsi_internal_target_block() is running concurrently,
1435 * wait until it has finished before changing the device state.
1437 mutex_lock(&sdev->state_mutex);
1439 * If blocked, we go straight to DEL and restart the queue so
1440 * any commands issued during driver shutdown (like sync
1441 * cache) are errored immediately.
1443 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1445 res = scsi_device_set_state(sdev, SDEV_DEL);
1447 scsi_start_queue(sdev);
1449 mutex_unlock(&sdev->state_mutex);
1454 if (sdev->host->hostt->sdev_groups)
1455 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1456 sdev->host->hostt->sdev_groups);
1458 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1459 bsg_unregister_queue(sdev->bsg_dev);
1460 device_unregister(&sdev->sdev_dev);
1461 transport_remove_device(dev);
1464 put_device(&sdev->sdev_dev);
1467 * Stop accepting new requests and wait until all queuecommand() and
1468 * scsi_run_queue() invocations have finished before tearing down the
1471 mutex_lock(&sdev->state_mutex);
1472 scsi_device_set_state(sdev, SDEV_DEL);
1473 mutex_unlock(&sdev->state_mutex);
1475 blk_cleanup_queue(sdev->request_queue);
1476 cancel_work_sync(&sdev->requeue_work);
1478 if (sdev->host->hostt->slave_destroy)
1479 sdev->host->hostt->slave_destroy(sdev);
1480 transport_destroy_device(dev);
1483 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1484 * removed sysfs visibility from the device, so make the target
1485 * invisible if this was the last device underneath it.
1487 scsi_target_reap(scsi_target(sdev));
1493 * scsi_remove_device - unregister a device from the scsi bus
1494 * @sdev: scsi_device to unregister
1496 void scsi_remove_device(struct scsi_device *sdev)
1498 struct Scsi_Host *shost = sdev->host;
1500 mutex_lock(&shost->scan_mutex);
1501 __scsi_remove_device(sdev);
1502 mutex_unlock(&shost->scan_mutex);
1504 EXPORT_SYMBOL(scsi_remove_device);
1506 static void __scsi_remove_target(struct scsi_target *starget)
1508 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1509 unsigned long flags;
1510 struct scsi_device *sdev;
1512 spin_lock_irqsave(shost->host_lock, flags);
1514 list_for_each_entry(sdev, &shost->__devices, siblings) {
1516 * We cannot call scsi_device_get() here, as
1517 * we might've been called from rmmod() causing
1518 * scsi_device_get() to fail the module_is_live()
1521 if (sdev->channel != starget->channel ||
1522 sdev->id != starget->id)
1524 if (sdev->sdev_state == SDEV_DEL ||
1525 sdev->sdev_state == SDEV_CANCEL ||
1526 !get_device(&sdev->sdev_gendev))
1528 spin_unlock_irqrestore(shost->host_lock, flags);
1529 scsi_remove_device(sdev);
1530 put_device(&sdev->sdev_gendev);
1531 spin_lock_irqsave(shost->host_lock, flags);
1534 spin_unlock_irqrestore(shost->host_lock, flags);
1538 * scsi_remove_target - try to remove a target and all its devices
1539 * @dev: generic starget or parent of generic stargets to be removed
1541 * Note: This is slightly racy. It is possible that if the user
1542 * requests the addition of another device then the target won't be
1545 void scsi_remove_target(struct device *dev)
1547 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1548 struct scsi_target *starget;
1549 unsigned long flags;
1552 spin_lock_irqsave(shost->host_lock, flags);
1553 list_for_each_entry(starget, &shost->__targets, siblings) {
1554 if (starget->state == STARGET_DEL ||
1555 starget->state == STARGET_REMOVE ||
1556 starget->state == STARGET_CREATED_REMOVE)
1558 if (starget->dev.parent == dev || &starget->dev == dev) {
1559 kref_get(&starget->reap_ref);
1560 if (starget->state == STARGET_CREATED)
1561 starget->state = STARGET_CREATED_REMOVE;
1563 starget->state = STARGET_REMOVE;
1564 spin_unlock_irqrestore(shost->host_lock, flags);
1565 __scsi_remove_target(starget);
1566 scsi_target_reap(starget);
1570 spin_unlock_irqrestore(shost->host_lock, flags);
1572 EXPORT_SYMBOL(scsi_remove_target);
1574 int scsi_register_driver(struct device_driver *drv)
1576 drv->bus = &scsi_bus_type;
1578 return driver_register(drv);
1580 EXPORT_SYMBOL(scsi_register_driver);
1582 int scsi_register_interface(struct class_interface *intf)
1584 intf->class = &sdev_class;
1586 return class_interface_register(intf);
1588 EXPORT_SYMBOL(scsi_register_interface);
1591 * scsi_sysfs_add_host - add scsi host to subsystem
1592 * @shost: scsi host struct to add to subsystem
1594 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1598 /* add host specific attributes */
1599 if (shost->hostt->shost_attrs) {
1600 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1601 error = device_create_file(&shost->shost_dev,
1602 shost->hostt->shost_attrs[i]);
1608 transport_register_device(&shost->shost_gendev);
1609 transport_configure_device(&shost->shost_gendev);
1613 static struct device_type scsi_dev_type = {
1614 .name = "scsi_device",
1615 .release = scsi_device_dev_release,
1616 .groups = scsi_sdev_attr_groups,
1619 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1621 unsigned long flags;
1622 struct Scsi_Host *shost = sdev->host;
1623 struct scsi_target *starget = sdev->sdev_target;
1625 device_initialize(&sdev->sdev_gendev);
1626 sdev->sdev_gendev.bus = &scsi_bus_type;
1627 sdev->sdev_gendev.type = &scsi_dev_type;
1628 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1629 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1631 device_initialize(&sdev->sdev_dev);
1632 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1633 sdev->sdev_dev.class = &sdev_class;
1634 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1635 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1637 * Get a default scsi_level from the target (derived from sibling
1638 * devices). This is the best we can do for guessing how to set
1639 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1640 * setting doesn't matter, because all the bits are zero anyway.
1641 * But it does matter for higher LUNs.
1643 sdev->scsi_level = starget->scsi_level;
1644 if (sdev->scsi_level <= SCSI_2 &&
1645 sdev->scsi_level != SCSI_UNKNOWN &&
1646 !shost->no_scsi2_lun_in_cdb)
1647 sdev->lun_in_cdb = 1;
1649 transport_setup_device(&sdev->sdev_gendev);
1650 spin_lock_irqsave(shost->host_lock, flags);
1651 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1652 list_add_tail(&sdev->siblings, &shost->__devices);
1653 spin_unlock_irqrestore(shost->host_lock, flags);
1655 * device can now only be removed via __scsi_remove_device() so hold
1656 * the target. Target will be held in CREATED state until something
1657 * beneath it becomes visible (in which case it moves to RUNNING)
1659 kref_get(&starget->reap_ref);
1662 int scsi_is_sdev_device(const struct device *dev)
1664 return dev->type == &scsi_dev_type;
1666 EXPORT_SYMBOL(scsi_is_sdev_device);
1668 /* A blank transport template that is used in drivers that don't
1669 * yet implement Transport Attributes */
1670 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };