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 const struct attribute_group scsi_shost_attr_group = {
428 .attrs = scsi_sysfs_shost_attrs,
431 static void scsi_device_cls_release(struct device *class_dev)
433 struct scsi_device *sdev;
435 sdev = class_to_sdev(class_dev);
436 put_device(&sdev->sdev_gendev);
439 static void scsi_device_dev_release_usercontext(struct work_struct *work)
441 struct scsi_device *sdev;
442 struct device *parent;
443 struct list_head *this, *tmp;
444 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
445 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
449 sdev = container_of(work, struct scsi_device, ew.work);
451 mod = sdev->host->hostt->module;
453 scsi_dh_release_device(sdev);
455 parent = sdev->sdev_gendev.parent;
457 spin_lock_irqsave(sdev->host->host_lock, flags);
458 list_del(&sdev->siblings);
459 list_del(&sdev->same_target_siblings);
460 list_del(&sdev->starved_entry);
461 spin_unlock_irqrestore(sdev->host->host_lock, flags);
463 cancel_work_sync(&sdev->event_work);
465 list_for_each_safe(this, tmp, &sdev->event_list) {
466 struct scsi_event *evt;
468 evt = list_entry(this, struct scsi_event, node);
469 list_del(&evt->node);
473 blk_put_queue(sdev->request_queue);
474 /* NULL queue means the device can't be used */
475 sdev->request_queue = NULL;
477 sbitmap_free(&sdev->budget_map);
479 mutex_lock(&sdev->inquiry_mutex);
480 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
481 lockdep_is_held(&sdev->inquiry_mutex));
482 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
483 lockdep_is_held(&sdev->inquiry_mutex));
484 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
485 lockdep_is_held(&sdev->inquiry_mutex));
486 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
487 lockdep_is_held(&sdev->inquiry_mutex));
488 mutex_unlock(&sdev->inquiry_mutex);
491 kfree_rcu(vpd_pg0, rcu);
493 kfree_rcu(vpd_pg83, rcu);
495 kfree_rcu(vpd_pg80, rcu);
497 kfree_rcu(vpd_pg89, rcu);
498 kfree(sdev->inquiry);
506 static void scsi_device_dev_release(struct device *dev)
508 struct scsi_device *sdp = to_scsi_device(dev);
510 /* Set module pointer as NULL in case of module unloading */
511 if (!try_module_get(sdp->host->hostt->module))
512 sdp->host->hostt->module = NULL;
514 execute_in_process_context(scsi_device_dev_release_usercontext,
518 static struct class sdev_class = {
519 .name = "scsi_device",
520 .dev_release = scsi_device_cls_release,
523 /* all probing is done in the individual ->probe routines */
524 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
526 struct scsi_device *sdp;
528 if (dev->type != &scsi_dev_type)
531 sdp = to_scsi_device(dev);
532 if (sdp->no_uld_attach)
534 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
537 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
539 struct scsi_device *sdev;
541 if (dev->type != &scsi_dev_type)
544 sdev = to_scsi_device(dev);
546 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
550 struct bus_type scsi_bus_type = {
552 .match = scsi_bus_match,
553 .uevent = scsi_bus_uevent,
555 .pm = &scsi_bus_pm_ops,
558 EXPORT_SYMBOL_GPL(scsi_bus_type);
560 int scsi_sysfs_register(void)
564 error = bus_register(&scsi_bus_type);
566 error = class_register(&sdev_class);
568 bus_unregister(&scsi_bus_type);
574 void scsi_sysfs_unregister(void)
576 class_unregister(&sdev_class);
577 bus_unregister(&scsi_bus_type);
581 * sdev_show_function: macro to create an attr function that can be used to
582 * show a non-bit field.
584 #define sdev_show_function(field, format_string) \
586 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
589 struct scsi_device *sdev; \
590 sdev = to_scsi_device(dev); \
591 return snprintf (buf, 20, format_string, sdev->field); \
595 * sdev_rd_attr: macro to create a function and attribute variable for a
598 #define sdev_rd_attr(field, format_string) \
599 sdev_show_function(field, format_string) \
600 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
604 * sdev_rw_attr: create a function and attribute variable for a
607 #define sdev_rw_attr(field, format_string) \
608 sdev_show_function(field, format_string) \
611 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
612 const char *buf, size_t count) \
614 struct scsi_device *sdev; \
615 sdev = to_scsi_device(dev); \
616 sscanf (buf, format_string, &sdev->field); \
619 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
621 /* Currently we don't export bit fields, but we might in future,
622 * so leave this code in */
625 * sdev_rd_attr: create a function and attribute variable for a
626 * read/write bit field.
628 #define sdev_rw_attr_bit(field) \
629 sdev_show_function(field, "%d\n") \
632 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
633 const char *buf, size_t count) \
636 struct scsi_device *sdev; \
637 ret = scsi_sdev_check_buf_bit(buf); \
639 sdev = to_scsi_device(dev); \
645 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
648 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
649 * else return -EINVAL.
651 static int scsi_sdev_check_buf_bit(const char *buf)
653 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
656 else if (buf[0] == '0')
665 * Create the actual show/store functions and data structures.
667 sdev_rd_attr (type, "%d\n");
668 sdev_rd_attr (scsi_level, "%d\n");
669 sdev_rd_attr (vendor, "%.8s\n");
670 sdev_rd_attr (model, "%.16s\n");
671 sdev_rd_attr (rev, "%.4s\n");
674 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
677 struct scsi_device *sdev = to_scsi_device(dev);
678 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
680 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
683 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
686 struct scsi_device *sdev = to_scsi_device(dev);
687 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
689 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
692 * TODO: can we make these symlinks to the block layer ones?
695 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
697 struct scsi_device *sdev;
698 sdev = to_scsi_device(dev);
699 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
703 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
704 const char *buf, size_t count)
706 struct scsi_device *sdev;
708 sdev = to_scsi_device(dev);
709 sscanf (buf, "%d\n", &timeout);
710 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
713 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
716 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
718 struct scsi_device *sdev;
719 sdev = to_scsi_device(dev);
720 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
724 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
725 const char *buf, size_t count)
727 struct scsi_device *sdev;
728 unsigned int eh_timeout;
731 if (!capable(CAP_SYS_ADMIN))
734 sdev = to_scsi_device(dev);
735 err = kstrtouint(buf, 10, &eh_timeout);
738 sdev->eh_timeout = eh_timeout * HZ;
742 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
745 store_rescan_field (struct device *dev, struct device_attribute *attr,
746 const char *buf, size_t count)
748 scsi_rescan_device(dev);
751 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
754 sdev_store_delete(struct device *dev, struct device_attribute *attr,
755 const char *buf, size_t count)
757 struct kernfs_node *kn;
758 struct scsi_device *sdev = to_scsi_device(dev);
761 * We need to try to get module, avoiding the module been removed
764 if (scsi_device_get(sdev))
767 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
770 * Concurrent writes into the "delete" sysfs attribute may trigger
771 * concurrent calls to device_remove_file() and scsi_remove_device().
772 * device_remove_file() handles concurrent removal calls by
773 * serializing these and by ignoring the second and later removal
774 * attempts. Concurrent calls of scsi_remove_device() are
775 * serialized. The second and later calls of scsi_remove_device() are
776 * ignored because the first call of that function changes the device
777 * state into SDEV_DEL.
779 device_remove_file(dev, attr);
780 scsi_remove_device(sdev);
782 sysfs_unbreak_active_protection(kn);
783 scsi_device_put(sdev);
786 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
789 store_state_field(struct device *dev, struct device_attribute *attr,
790 const char *buf, size_t count)
793 struct scsi_device *sdev = to_scsi_device(dev);
794 enum scsi_device_state state = 0;
795 bool rescan_dev = false;
797 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
798 const int len = strlen(sdev_states[i].name);
799 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
801 state = sdev_states[i].value;
813 mutex_lock(&sdev->state_mutex);
814 if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
817 ret = scsi_device_set_state(sdev, state);
818 if (ret == 0 && state == SDEV_RUNNING)
821 mutex_unlock(&sdev->state_mutex);
825 * If the device state changes to SDEV_RUNNING, we need to
826 * run the queue to avoid I/O hang, and rescan the device
827 * to revalidate it. Running the queue first is necessary
828 * because another thread may be waiting inside
829 * blk_mq_freeze_queue_wait() and because that call may be
830 * waiting for pending I/O to finish.
832 blk_mq_run_hw_queues(sdev->request_queue, true);
833 scsi_rescan_device(dev);
836 return ret == 0 ? count : -EINVAL;
840 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
842 struct scsi_device *sdev = to_scsi_device(dev);
843 const char *name = scsi_device_state_name(sdev->sdev_state);
848 return snprintf(buf, 20, "%s\n", name);
851 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
854 show_queue_type_field(struct device *dev, struct device_attribute *attr,
857 struct scsi_device *sdev = to_scsi_device(dev);
858 const char *name = "none";
860 if (sdev->simple_tags)
863 return snprintf(buf, 20, "%s\n", name);
867 store_queue_type_field(struct device *dev, struct device_attribute *attr,
868 const char *buf, size_t count)
870 struct scsi_device *sdev = to_scsi_device(dev);
872 if (!sdev->tagged_supported)
875 sdev_printk(KERN_INFO, sdev,
876 "ignoring write to deprecated queue_type attribute");
880 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
881 store_queue_type_field);
883 #define sdev_vpd_pg_attr(_page) \
885 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
886 struct bin_attribute *bin_attr, \
887 char *buf, loff_t off, size_t count) \
889 struct device *dev = kobj_to_dev(kobj); \
890 struct scsi_device *sdev = to_scsi_device(dev); \
891 struct scsi_vpd *vpd_page; \
895 vpd_page = rcu_dereference(sdev->vpd_##_page); \
897 ret = memory_read_from_buffer(buf, count, &off, \
898 vpd_page->data, vpd_page->len); \
902 static struct bin_attribute dev_attr_vpd_##_page = { \
903 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
905 .read = show_vpd_##_page, \
908 sdev_vpd_pg_attr(pg83);
909 sdev_vpd_pg_attr(pg80);
910 sdev_vpd_pg_attr(pg89);
911 sdev_vpd_pg_attr(pg0);
913 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
914 struct bin_attribute *bin_attr,
915 char *buf, loff_t off, size_t count)
917 struct device *dev = kobj_to_dev(kobj);
918 struct scsi_device *sdev = to_scsi_device(dev);
923 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
927 static struct bin_attribute dev_attr_inquiry = {
933 .read = show_inquiry,
937 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
940 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
943 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
945 #define show_sdev_iostat(field) \
947 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
950 struct scsi_device *sdev = to_scsi_device(dev); \
951 unsigned long long count = atomic_read(&sdev->field); \
952 return snprintf(buf, 20, "0x%llx\n", count); \
954 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
956 show_sdev_iostat(iorequest_cnt);
957 show_sdev_iostat(iodone_cnt);
958 show_sdev_iostat(ioerr_cnt);
961 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
963 struct scsi_device *sdev;
964 sdev = to_scsi_device(dev);
965 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
967 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
969 #define DECLARE_EVT_SHOW(name, Cap_name) \
971 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
974 struct scsi_device *sdev = to_scsi_device(dev); \
975 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
976 return snprintf(buf, 20, "%d\n", val); \
979 #define DECLARE_EVT_STORE(name, Cap_name) \
981 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
982 const char *buf, size_t count) \
984 struct scsi_device *sdev = to_scsi_device(dev); \
985 int val = simple_strtoul(buf, NULL, 0); \
987 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
989 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
995 #define DECLARE_EVT(name, Cap_name) \
996 DECLARE_EVT_SHOW(name, Cap_name) \
997 DECLARE_EVT_STORE(name, Cap_name) \
998 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
999 sdev_store_evt_##name);
1000 #define REF_EVT(name) &dev_attr_evt_##name.attr
1002 DECLARE_EVT(media_change, MEDIA_CHANGE)
1003 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1004 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1005 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1006 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1007 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
1010 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1011 const char *buf, size_t count)
1014 struct scsi_device *sdev = to_scsi_device(dev);
1015 struct scsi_host_template *sht = sdev->host->hostt;
1017 if (!sht->change_queue_depth)
1020 depth = simple_strtoul(buf, NULL, 0);
1022 if (depth < 1 || depth > sdev->host->can_queue)
1025 retval = sht->change_queue_depth(sdev, depth);
1029 sdev->max_queue_depth = sdev->queue_depth;
1033 sdev_show_function(queue_depth, "%d\n");
1035 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1036 sdev_store_queue_depth);
1039 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1042 struct scsi_device *sdev = to_scsi_device(dev);
1045 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1052 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1054 #define BLIST_FLAG_NAME(name) \
1055 [const_ilog2((__force __u64)BLIST_##name)] = #name
1056 static const char *const sdev_bflags_name[] = {
1057 #include "scsi_devinfo_tbl.c"
1059 #undef BLIST_FLAG_NAME
1062 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1065 struct scsi_device *sdev = to_scsi_device(dev);
1069 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1070 const char *name = NULL;
1072 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1074 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1075 name = sdev_bflags_name[i];
1078 len += scnprintf(buf + len, PAGE_SIZE - len,
1079 "%s%s", len ? " " : "", name);
1081 len += scnprintf(buf + len, PAGE_SIZE - len,
1082 "%sINVALID_BIT(%d)", len ? " " : "", i);
1085 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1088 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1090 #ifdef CONFIG_SCSI_DH
1092 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1095 struct scsi_device *sdev = to_scsi_device(dev);
1098 return snprintf(buf, 20, "detached\n");
1100 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1104 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1105 const char *buf, size_t count)
1107 struct scsi_device *sdev = to_scsi_device(dev);
1110 if (sdev->sdev_state == SDEV_CANCEL ||
1111 sdev->sdev_state == SDEV_DEL)
1114 if (!sdev->handler) {
1116 * Attach to a device handler
1118 err = scsi_dh_attach(sdev->request_queue, buf);
1119 } else if (!strncmp(buf, "activate", 8)) {
1121 * Activate a device handler
1123 if (sdev->handler->activate)
1124 err = sdev->handler->activate(sdev, NULL, NULL);
1127 } else if (!strncmp(buf, "detach", 6)) {
1129 * Detach from a device handler
1131 sdev_printk(KERN_WARNING, sdev,
1132 "can't detach handler %s.\n",
1133 sdev->handler->name);
1137 return err < 0 ? err : count;
1140 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1141 sdev_store_dh_state);
1144 sdev_show_access_state(struct device *dev,
1145 struct device_attribute *attr,
1148 struct scsi_device *sdev = to_scsi_device(dev);
1149 unsigned char access_state;
1150 const char *access_state_name;
1155 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1156 access_state_name = scsi_access_state_name(access_state);
1158 return sprintf(buf, "%s\n",
1159 access_state_name ? access_state_name : "unknown");
1161 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1164 sdev_show_preferred_path(struct device *dev,
1165 struct device_attribute *attr,
1168 struct scsi_device *sdev = to_scsi_device(dev);
1173 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1174 return sprintf(buf, "1\n");
1176 return sprintf(buf, "0\n");
1178 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1182 sdev_show_queue_ramp_up_period(struct device *dev,
1183 struct device_attribute *attr,
1186 struct scsi_device *sdev;
1187 sdev = to_scsi_device(dev);
1188 return snprintf(buf, 20, "%u\n",
1189 jiffies_to_msecs(sdev->queue_ramp_up_period));
1193 sdev_store_queue_ramp_up_period(struct device *dev,
1194 struct device_attribute *attr,
1195 const char *buf, size_t count)
1197 struct scsi_device *sdev = to_scsi_device(dev);
1198 unsigned int period;
1200 if (kstrtouint(buf, 10, &period))
1203 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1207 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1208 sdev_show_queue_ramp_up_period,
1209 sdev_store_queue_ramp_up_period);
1211 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1212 struct attribute *attr, int i)
1214 struct device *dev = kobj_to_dev(kobj);
1215 struct scsi_device *sdev = to_scsi_device(dev);
1218 if (attr == &dev_attr_queue_depth.attr &&
1219 !sdev->host->hostt->change_queue_depth)
1222 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1223 !sdev->host->hostt->change_queue_depth)
1226 #ifdef CONFIG_SCSI_DH
1227 if (attr == &dev_attr_access_state.attr &&
1230 if (attr == &dev_attr_preferred_path.attr &&
1237 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1238 struct bin_attribute *attr, int i)
1240 struct device *dev = kobj_to_dev(kobj);
1241 struct scsi_device *sdev = to_scsi_device(dev);
1244 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1247 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1250 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1253 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1259 /* Default template for device attributes. May NOT be modified */
1260 static struct attribute *scsi_sdev_attrs[] = {
1261 &dev_attr_device_blocked.attr,
1262 &dev_attr_type.attr,
1263 &dev_attr_scsi_level.attr,
1264 &dev_attr_device_busy.attr,
1265 &dev_attr_vendor.attr,
1266 &dev_attr_model.attr,
1268 &dev_attr_rescan.attr,
1269 &dev_attr_delete.attr,
1270 &dev_attr_state.attr,
1271 &dev_attr_timeout.attr,
1272 &dev_attr_eh_timeout.attr,
1273 &dev_attr_iocounterbits.attr,
1274 &dev_attr_iorequest_cnt.attr,
1275 &dev_attr_iodone_cnt.attr,
1276 &dev_attr_ioerr_cnt.attr,
1277 &dev_attr_modalias.attr,
1278 &dev_attr_queue_depth.attr,
1279 &dev_attr_queue_type.attr,
1280 &dev_attr_wwid.attr,
1281 &dev_attr_blacklist.attr,
1282 #ifdef CONFIG_SCSI_DH
1283 &dev_attr_dh_state.attr,
1284 &dev_attr_access_state.attr,
1285 &dev_attr_preferred_path.attr,
1287 &dev_attr_queue_ramp_up_period.attr,
1288 REF_EVT(media_change),
1289 REF_EVT(inquiry_change_reported),
1290 REF_EVT(capacity_change_reported),
1291 REF_EVT(soft_threshold_reached),
1292 REF_EVT(mode_parameter_change_reported),
1293 REF_EVT(lun_change_reported),
1297 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1305 static struct attribute_group scsi_sdev_attr_group = {
1306 .attrs = scsi_sdev_attrs,
1307 .bin_attrs = scsi_sdev_bin_attrs,
1308 .is_visible = scsi_sdev_attr_is_visible,
1309 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1312 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1313 &scsi_sdev_attr_group,
1317 static int scsi_target_add(struct scsi_target *starget)
1321 if (starget->state != STARGET_CREATED)
1324 error = device_add(&starget->dev);
1326 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1329 transport_add_device(&starget->dev);
1330 starget->state = STARGET_RUNNING;
1332 pm_runtime_set_active(&starget->dev);
1333 pm_runtime_enable(&starget->dev);
1334 device_enable_async_suspend(&starget->dev);
1340 * scsi_sysfs_add_sdev - add scsi device to sysfs
1341 * @sdev: scsi_device to add
1344 * 0 on Success / non-zero on Failure
1346 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1349 struct scsi_target *starget = sdev->sdev_target;
1351 error = scsi_target_add(starget);
1355 transport_configure_device(&starget->dev);
1357 device_enable_async_suspend(&sdev->sdev_gendev);
1358 scsi_autopm_get_target(starget);
1359 pm_runtime_set_active(&sdev->sdev_gendev);
1360 if (!sdev->rpm_autosuspend)
1361 pm_runtime_forbid(&sdev->sdev_gendev);
1362 pm_runtime_enable(&sdev->sdev_gendev);
1363 scsi_autopm_put_target(starget);
1365 scsi_autopm_get_device(sdev);
1367 scsi_dh_add_device(sdev);
1369 error = device_add(&sdev->sdev_gendev);
1371 sdev_printk(KERN_INFO, sdev,
1372 "failed to add device: %d\n", error);
1376 device_enable_async_suspend(&sdev->sdev_dev);
1377 error = device_add(&sdev->sdev_dev);
1379 sdev_printk(KERN_INFO, sdev,
1380 "failed to add class device: %d\n", error);
1381 device_del(&sdev->sdev_gendev);
1384 transport_add_device(&sdev->sdev_gendev);
1385 sdev->is_visible = 1;
1387 if (IS_ENABLED(CONFIG_BLK_DEV_BSG)) {
1388 sdev->bsg_dev = scsi_bsg_register_queue(sdev);
1389 if (IS_ERR(sdev->bsg_dev)) {
1391 * We're treating error on bsg register as non-fatal, so
1392 * pretend nothing went wrong.
1394 error = PTR_ERR(sdev->bsg_dev);
1395 sdev_printk(KERN_INFO, sdev,
1396 "Failed to register bsg queue, errno=%d\n",
1398 sdev->bsg_dev = NULL;
1402 scsi_autopm_put_device(sdev);
1406 void __scsi_remove_device(struct scsi_device *sdev)
1408 struct device *dev = &sdev->sdev_gendev;
1412 * This cleanup path is not reentrant and while it is impossible
1413 * to get a new reference with scsi_device_get() someone can still
1414 * hold a previously acquired one.
1416 if (sdev->sdev_state == SDEV_DEL)
1419 if (sdev->is_visible) {
1421 * If scsi_internal_target_block() is running concurrently,
1422 * wait until it has finished before changing the device state.
1424 mutex_lock(&sdev->state_mutex);
1426 * If blocked, we go straight to DEL and restart the queue so
1427 * any commands issued during driver shutdown (like sync
1428 * cache) are errored immediately.
1430 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1432 res = scsi_device_set_state(sdev, SDEV_DEL);
1434 scsi_start_queue(sdev);
1436 mutex_unlock(&sdev->state_mutex);
1441 if (IS_ENABLED(CONFIG_BLK_DEV_BSG) && sdev->bsg_dev)
1442 bsg_unregister_queue(sdev->bsg_dev);
1443 device_unregister(&sdev->sdev_dev);
1444 transport_remove_device(dev);
1447 put_device(&sdev->sdev_dev);
1450 * Stop accepting new requests and wait until all queuecommand() and
1451 * scsi_run_queue() invocations have finished before tearing down the
1454 mutex_lock(&sdev->state_mutex);
1455 scsi_device_set_state(sdev, SDEV_DEL);
1456 mutex_unlock(&sdev->state_mutex);
1458 blk_cleanup_queue(sdev->request_queue);
1459 cancel_work_sync(&sdev->requeue_work);
1461 if (sdev->host->hostt->slave_destroy)
1462 sdev->host->hostt->slave_destroy(sdev);
1463 transport_destroy_device(dev);
1466 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1467 * removed sysfs visibility from the device, so make the target
1468 * invisible if this was the last device underneath it.
1470 scsi_target_reap(scsi_target(sdev));
1476 * scsi_remove_device - unregister a device from the scsi bus
1477 * @sdev: scsi_device to unregister
1479 void scsi_remove_device(struct scsi_device *sdev)
1481 struct Scsi_Host *shost = sdev->host;
1483 mutex_lock(&shost->scan_mutex);
1484 __scsi_remove_device(sdev);
1485 mutex_unlock(&shost->scan_mutex);
1487 EXPORT_SYMBOL(scsi_remove_device);
1489 static void __scsi_remove_target(struct scsi_target *starget)
1491 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1492 unsigned long flags;
1493 struct scsi_device *sdev;
1495 spin_lock_irqsave(shost->host_lock, flags);
1497 list_for_each_entry(sdev, &shost->__devices, siblings) {
1499 * We cannot call scsi_device_get() here, as
1500 * we might've been called from rmmod() causing
1501 * scsi_device_get() to fail the module_is_live()
1504 if (sdev->channel != starget->channel ||
1505 sdev->id != starget->id)
1507 if (sdev->sdev_state == SDEV_DEL ||
1508 sdev->sdev_state == SDEV_CANCEL ||
1509 !get_device(&sdev->sdev_gendev))
1511 spin_unlock_irqrestore(shost->host_lock, flags);
1512 scsi_remove_device(sdev);
1513 put_device(&sdev->sdev_gendev);
1514 spin_lock_irqsave(shost->host_lock, flags);
1517 spin_unlock_irqrestore(shost->host_lock, flags);
1521 * scsi_remove_target - try to remove a target and all its devices
1522 * @dev: generic starget or parent of generic stargets to be removed
1524 * Note: This is slightly racy. It is possible that if the user
1525 * requests the addition of another device then the target won't be
1528 void scsi_remove_target(struct device *dev)
1530 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1531 struct scsi_target *starget;
1532 unsigned long flags;
1535 spin_lock_irqsave(shost->host_lock, flags);
1536 list_for_each_entry(starget, &shost->__targets, siblings) {
1537 if (starget->state == STARGET_DEL ||
1538 starget->state == STARGET_REMOVE ||
1539 starget->state == STARGET_CREATED_REMOVE)
1541 if (starget->dev.parent == dev || &starget->dev == dev) {
1542 kref_get(&starget->reap_ref);
1543 if (starget->state == STARGET_CREATED)
1544 starget->state = STARGET_CREATED_REMOVE;
1546 starget->state = STARGET_REMOVE;
1547 spin_unlock_irqrestore(shost->host_lock, flags);
1548 __scsi_remove_target(starget);
1549 scsi_target_reap(starget);
1553 spin_unlock_irqrestore(shost->host_lock, flags);
1555 EXPORT_SYMBOL(scsi_remove_target);
1557 int scsi_register_driver(struct device_driver *drv)
1559 drv->bus = &scsi_bus_type;
1561 return driver_register(drv);
1563 EXPORT_SYMBOL(scsi_register_driver);
1565 int scsi_register_interface(struct class_interface *intf)
1567 intf->class = &sdev_class;
1569 return class_interface_register(intf);
1571 EXPORT_SYMBOL(scsi_register_interface);
1574 * scsi_sysfs_add_host - add scsi host to subsystem
1575 * @shost: scsi host struct to add to subsystem
1577 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1579 transport_register_device(&shost->shost_gendev);
1580 transport_configure_device(&shost->shost_gendev);
1584 static struct device_type scsi_dev_type = {
1585 .name = "scsi_device",
1586 .release = scsi_device_dev_release,
1587 .groups = scsi_sdev_attr_groups,
1590 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1592 unsigned long flags;
1593 struct Scsi_Host *shost = sdev->host;
1594 struct scsi_host_template *hostt = shost->hostt;
1595 struct scsi_target *starget = sdev->sdev_target;
1597 device_initialize(&sdev->sdev_gendev);
1598 sdev->sdev_gendev.bus = &scsi_bus_type;
1599 sdev->sdev_gendev.type = &scsi_dev_type;
1600 scsi_enable_async_suspend(&sdev->sdev_gendev);
1601 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1602 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1603 sdev->sdev_gendev.groups = hostt->sdev_groups;
1605 device_initialize(&sdev->sdev_dev);
1606 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1607 sdev->sdev_dev.class = &sdev_class;
1608 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1609 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1611 * Get a default scsi_level from the target (derived from sibling
1612 * devices). This is the best we can do for guessing how to set
1613 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1614 * setting doesn't matter, because all the bits are zero anyway.
1615 * But it does matter for higher LUNs.
1617 sdev->scsi_level = starget->scsi_level;
1618 if (sdev->scsi_level <= SCSI_2 &&
1619 sdev->scsi_level != SCSI_UNKNOWN &&
1620 !shost->no_scsi2_lun_in_cdb)
1621 sdev->lun_in_cdb = 1;
1623 transport_setup_device(&sdev->sdev_gendev);
1624 spin_lock_irqsave(shost->host_lock, flags);
1625 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1626 list_add_tail(&sdev->siblings, &shost->__devices);
1627 spin_unlock_irqrestore(shost->host_lock, flags);
1629 * device can now only be removed via __scsi_remove_device() so hold
1630 * the target. Target will be held in CREATED state until something
1631 * beneath it becomes visible (in which case it moves to RUNNING)
1633 kref_get(&starget->reap_ref);
1636 int scsi_is_sdev_device(const struct device *dev)
1638 return dev->type == &scsi_dev_type;
1640 EXPORT_SYMBOL(scsi_is_sdev_device);
1642 /* A blank transport template that is used in drivers that don't
1643 * yet implement Transport Attributes */
1644 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };