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>
17 #include <scsi/scsi.h>
18 #include <scsi/scsi_device.h>
19 #include <scsi/scsi_host.h>
20 #include <scsi/scsi_tcq.h>
21 #include <scsi/scsi_dh.h>
22 #include <scsi/scsi_transport.h>
23 #include <scsi/scsi_driver.h>
24 #include <scsi/scsi_devinfo.h>
26 #include "scsi_priv.h"
27 #include "scsi_logging.h"
29 static struct device_type scsi_dev_type;
32 enum scsi_device_state value;
35 { SDEV_CREATED, "created" },
36 { SDEV_RUNNING, "running" },
37 { SDEV_CANCEL, "cancel" },
38 { SDEV_DEL, "deleted" },
39 { SDEV_QUIESCE, "quiesce" },
40 { SDEV_OFFLINE, "offline" },
41 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
42 { SDEV_BLOCK, "blocked" },
43 { SDEV_CREATED_BLOCK, "created-blocked" },
46 const char *scsi_device_state_name(enum scsi_device_state state)
51 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
52 if (sdev_states[i].value == state) {
53 name = sdev_states[i].name;
61 enum scsi_host_state value;
64 { SHOST_CREATED, "created" },
65 { SHOST_RUNNING, "running" },
66 { SHOST_CANCEL, "cancel" },
67 { SHOST_DEL, "deleted" },
68 { SHOST_RECOVERY, "recovery" },
69 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
70 { SHOST_DEL_RECOVERY, "deleted/recovery", },
72 const char *scsi_host_state_name(enum scsi_host_state state)
77 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
78 if (shost_states[i].value == state) {
79 name = shost_states[i].name;
90 } sdev_access_states[] = {
91 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
92 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
93 { SCSI_ACCESS_STATE_STANDBY, "standby" },
94 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
95 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
96 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
97 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
100 static const char *scsi_access_state_name(unsigned char state)
105 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
106 if (sdev_access_states[i].value == state) {
107 name = sdev_access_states[i].name;
115 static int check_set(unsigned long long *val, char *src)
119 if (strcmp(src, "-") == 0) {
120 *val = SCAN_WILD_CARD;
123 * Doesn't check for int overflow
125 *val = simple_strtoull(src, &last, 0);
132 static int scsi_scan(struct Scsi_Host *shost, const char *str)
134 char s1[15], s2[15], s3[17], junk;
135 unsigned long long channel, id, lun;
138 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
141 if (check_set(&channel, s1))
143 if (check_set(&id, s2))
145 if (check_set(&lun, s3))
147 if (shost->transportt->user_scan)
148 res = shost->transportt->user_scan(shost, channel, id, lun);
150 res = scsi_scan_host_selected(shost, channel, id, lun,
156 * shost_show_function: macro to create an attr function that can be used to
157 * show a non-bit field.
159 #define shost_show_function(name, field, format_string) \
161 show_##name (struct device *dev, struct device_attribute *attr, \
164 struct Scsi_Host *shost = class_to_shost(dev); \
165 return snprintf (buf, 20, format_string, shost->field); \
169 * shost_rd_attr: macro to create a function and attribute variable for a
172 #define shost_rd_attr2(name, field, format_string) \
173 shost_show_function(name, field, format_string) \
174 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
176 #define shost_rd_attr(field, format_string) \
177 shost_rd_attr2(field, field, format_string)
180 * Create the actual show/store functions and data structures.
184 store_scan(struct device *dev, struct device_attribute *attr,
185 const char *buf, size_t count)
187 struct Scsi_Host *shost = class_to_shost(dev);
190 res = scsi_scan(shost, buf);
195 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
198 store_shost_state(struct device *dev, struct device_attribute *attr,
199 const char *buf, size_t count)
202 struct Scsi_Host *shost = class_to_shost(dev);
203 enum scsi_host_state state = 0;
205 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
206 const int len = strlen(shost_states[i].name);
207 if (strncmp(shost_states[i].name, buf, len) == 0 &&
209 state = shost_states[i].value;
216 if (scsi_host_set_state(shost, state))
222 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
224 struct Scsi_Host *shost = class_to_shost(dev);
225 const char *name = scsi_host_state_name(shost->shost_state);
230 return snprintf(buf, 20, "%s\n", name);
233 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
234 static struct device_attribute dev_attr_hstate =
235 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
238 show_shost_mode(unsigned int mode, char *buf)
242 if (mode & MODE_INITIATOR)
243 len = sprintf(buf, "%s", "Initiator");
245 if (mode & MODE_TARGET)
246 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
248 len += sprintf(buf + len, "\n");
254 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
257 struct Scsi_Host *shost = class_to_shost(dev);
258 unsigned int supported_mode = shost->hostt->supported_mode;
260 if (supported_mode == MODE_UNKNOWN)
261 /* by default this should be initiator */
262 supported_mode = MODE_INITIATOR;
264 return show_shost_mode(supported_mode, buf);
267 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
270 show_shost_active_mode(struct device *dev,
271 struct device_attribute *attr, char *buf)
273 struct Scsi_Host *shost = class_to_shost(dev);
275 if (shost->active_mode == MODE_UNKNOWN)
276 return snprintf(buf, 20, "unknown\n");
278 return show_shost_mode(shost->active_mode, buf);
281 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
283 static int check_reset_type(const char *str)
285 if (sysfs_streq(str, "adapter"))
286 return SCSI_ADAPTER_RESET;
287 else if (sysfs_streq(str, "firmware"))
288 return SCSI_FIRMWARE_RESET;
294 store_host_reset(struct device *dev, struct device_attribute *attr,
295 const char *buf, size_t count)
297 struct Scsi_Host *shost = class_to_shost(dev);
298 struct scsi_host_template *sht = shost->hostt;
302 type = check_reset_type(buf);
304 goto exit_store_host_reset;
307 ret = sht->host_reset(shost, type);
311 exit_store_host_reset:
317 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
320 show_shost_eh_deadline(struct device *dev,
321 struct device_attribute *attr, char *buf)
323 struct Scsi_Host *shost = class_to_shost(dev);
325 if (shost->eh_deadline == -1)
326 return snprintf(buf, strlen("off") + 2, "off\n");
327 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
331 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
332 const char *buf, size_t count)
334 struct Scsi_Host *shost = class_to_shost(dev);
336 unsigned long deadline, flags;
338 if (shost->transportt &&
339 (shost->transportt->eh_strategy_handler ||
340 !shost->hostt->eh_host_reset_handler))
343 if (!strncmp(buf, "off", strlen("off")))
346 ret = kstrtoul(buf, 10, &deadline);
349 if (deadline * HZ > UINT_MAX)
353 spin_lock_irqsave(shost->host_lock, flags);
354 if (scsi_host_in_recovery(shost))
358 shost->eh_deadline = -1;
360 shost->eh_deadline = deadline * HZ;
364 spin_unlock_irqrestore(shost->host_lock, flags);
369 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
371 shost_rd_attr(unique_id, "%u\n");
372 shost_rd_attr(cmd_per_lun, "%hd\n");
373 shost_rd_attr(can_queue, "%hd\n");
374 shost_rd_attr(sg_tablesize, "%hu\n");
375 shost_rd_attr(sg_prot_tablesize, "%hu\n");
376 shost_rd_attr(unchecked_isa_dma, "%d\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);
396 static struct attribute *scsi_sysfs_shost_attrs[] = {
397 &dev_attr_use_blk_mq.attr,
398 &dev_attr_unique_id.attr,
399 &dev_attr_host_busy.attr,
400 &dev_attr_cmd_per_lun.attr,
401 &dev_attr_can_queue.attr,
402 &dev_attr_sg_tablesize.attr,
403 &dev_attr_sg_prot_tablesize.attr,
404 &dev_attr_unchecked_isa_dma.attr,
405 &dev_attr_proc_name.attr,
407 &dev_attr_hstate.attr,
408 &dev_attr_supported_mode.attr,
409 &dev_attr_active_mode.attr,
410 &dev_attr_prot_capabilities.attr,
411 &dev_attr_prot_guard_type.attr,
412 &dev_attr_host_reset.attr,
413 &dev_attr_eh_deadline.attr,
417 static struct attribute_group scsi_shost_attr_group = {
418 .attrs = scsi_sysfs_shost_attrs,
421 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
422 &scsi_shost_attr_group,
426 static void scsi_device_cls_release(struct device *class_dev)
428 struct scsi_device *sdev;
430 sdev = class_to_sdev(class_dev);
431 put_device(&sdev->sdev_gendev);
434 static void scsi_device_dev_release_usercontext(struct work_struct *work)
436 struct scsi_device *sdev;
437 struct device *parent;
438 struct list_head *this, *tmp;
439 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
440 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
443 sdev = container_of(work, struct scsi_device, ew.work);
445 scsi_dh_release_device(sdev);
447 parent = sdev->sdev_gendev.parent;
449 spin_lock_irqsave(sdev->host->host_lock, flags);
450 list_del(&sdev->siblings);
451 list_del(&sdev->same_target_siblings);
452 list_del(&sdev->starved_entry);
453 spin_unlock_irqrestore(sdev->host->host_lock, flags);
455 cancel_work_sync(&sdev->event_work);
457 list_for_each_safe(this, tmp, &sdev->event_list) {
458 struct scsi_event *evt;
460 evt = list_entry(this, struct scsi_event, node);
461 list_del(&evt->node);
465 blk_put_queue(sdev->request_queue);
466 /* NULL queue means the device can't be used */
467 sdev->request_queue = NULL;
469 mutex_lock(&sdev->inquiry_mutex);
470 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
471 lockdep_is_held(&sdev->inquiry_mutex));
472 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
473 lockdep_is_held(&sdev->inquiry_mutex));
474 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
475 lockdep_is_held(&sdev->inquiry_mutex));
476 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
477 lockdep_is_held(&sdev->inquiry_mutex));
478 mutex_unlock(&sdev->inquiry_mutex);
481 kfree_rcu(vpd_pg0, rcu);
483 kfree_rcu(vpd_pg83, rcu);
485 kfree_rcu(vpd_pg80, rcu);
487 kfree_rcu(vpd_pg89, rcu);
488 kfree(sdev->inquiry);
495 static void scsi_device_dev_release(struct device *dev)
497 struct scsi_device *sdp = to_scsi_device(dev);
498 execute_in_process_context(scsi_device_dev_release_usercontext,
502 static struct class sdev_class = {
503 .name = "scsi_device",
504 .dev_release = scsi_device_cls_release,
507 /* all probing is done in the individual ->probe routines */
508 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
510 struct scsi_device *sdp;
512 if (dev->type != &scsi_dev_type)
515 sdp = to_scsi_device(dev);
516 if (sdp->no_uld_attach)
518 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
521 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
523 struct scsi_device *sdev;
525 if (dev->type != &scsi_dev_type)
528 sdev = to_scsi_device(dev);
530 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
534 struct bus_type scsi_bus_type = {
536 .match = scsi_bus_match,
537 .uevent = scsi_bus_uevent,
539 .pm = &scsi_bus_pm_ops,
542 EXPORT_SYMBOL_GPL(scsi_bus_type);
544 int scsi_sysfs_register(void)
548 error = bus_register(&scsi_bus_type);
550 error = class_register(&sdev_class);
552 bus_unregister(&scsi_bus_type);
558 void scsi_sysfs_unregister(void)
560 class_unregister(&sdev_class);
561 bus_unregister(&scsi_bus_type);
565 * sdev_show_function: macro to create an attr function that can be used to
566 * show a non-bit field.
568 #define sdev_show_function(field, format_string) \
570 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
573 struct scsi_device *sdev; \
574 sdev = to_scsi_device(dev); \
575 return snprintf (buf, 20, format_string, sdev->field); \
579 * sdev_rd_attr: macro to create a function and attribute variable for a
582 #define sdev_rd_attr(field, format_string) \
583 sdev_show_function(field, format_string) \
584 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
588 * sdev_rw_attr: create a function and attribute variable for a
591 #define sdev_rw_attr(field, format_string) \
592 sdev_show_function(field, format_string) \
595 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
596 const char *buf, size_t count) \
598 struct scsi_device *sdev; \
599 sdev = to_scsi_device(dev); \
600 sscanf (buf, format_string, &sdev->field); \
603 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
605 /* Currently we don't export bit fields, but we might in future,
606 * so leave this code in */
609 * sdev_rd_attr: create a function and attribute variable for a
610 * read/write bit field.
612 #define sdev_rw_attr_bit(field) \
613 sdev_show_function(field, "%d\n") \
616 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
617 const char *buf, size_t count) \
620 struct scsi_device *sdev; \
621 ret = scsi_sdev_check_buf_bit(buf); \
623 sdev = to_scsi_device(dev); \
629 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
632 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
633 * else return -EINVAL.
635 static int scsi_sdev_check_buf_bit(const char *buf)
637 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
640 else if (buf[0] == '0')
649 * Create the actual show/store functions and data structures.
651 sdev_rd_attr (type, "%d\n");
652 sdev_rd_attr (scsi_level, "%d\n");
653 sdev_rd_attr (vendor, "%.8s\n");
654 sdev_rd_attr (model, "%.16s\n");
655 sdev_rd_attr (rev, "%.4s\n");
658 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
661 struct scsi_device *sdev = to_scsi_device(dev);
662 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
664 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
667 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
670 struct scsi_device *sdev = to_scsi_device(dev);
671 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
673 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
676 * TODO: can we make these symlinks to the block layer ones?
679 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
681 struct scsi_device *sdev;
682 sdev = to_scsi_device(dev);
683 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
687 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
688 const char *buf, size_t count)
690 struct scsi_device *sdev;
692 sdev = to_scsi_device(dev);
693 sscanf (buf, "%d\n", &timeout);
694 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
697 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
700 sdev_show_eh_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, "%u\n", sdev->eh_timeout / HZ);
708 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
709 const char *buf, size_t count)
711 struct scsi_device *sdev;
712 unsigned int eh_timeout;
715 if (!capable(CAP_SYS_ADMIN))
718 sdev = to_scsi_device(dev);
719 err = kstrtouint(buf, 10, &eh_timeout);
722 sdev->eh_timeout = eh_timeout * HZ;
726 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
729 store_rescan_field (struct device *dev, struct device_attribute *attr,
730 const char *buf, size_t count)
732 scsi_rescan_device(dev);
735 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
738 sdev_store_delete(struct device *dev, struct device_attribute *attr,
739 const char *buf, size_t count)
741 struct kernfs_node *kn;
742 struct scsi_device *sdev = to_scsi_device(dev);
745 * We need to try to get module, avoiding the module been removed
748 if (scsi_device_get(sdev))
751 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
754 * Concurrent writes into the "delete" sysfs attribute may trigger
755 * concurrent calls to device_remove_file() and scsi_remove_device().
756 * device_remove_file() handles concurrent removal calls by
757 * serializing these and by ignoring the second and later removal
758 * attempts. Concurrent calls of scsi_remove_device() are
759 * serialized. The second and later calls of scsi_remove_device() are
760 * ignored because the first call of that function changes the device
761 * state into SDEV_DEL.
763 device_remove_file(dev, attr);
764 scsi_remove_device(sdev);
766 sysfs_unbreak_active_protection(kn);
767 scsi_device_put(sdev);
770 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
773 store_state_field(struct device *dev, struct device_attribute *attr,
774 const char *buf, size_t count)
777 struct scsi_device *sdev = to_scsi_device(dev);
778 enum scsi_device_state state = 0;
780 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
781 const int len = strlen(sdev_states[i].name);
782 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
784 state = sdev_states[i].value;
796 mutex_lock(&sdev->state_mutex);
797 ret = scsi_device_set_state(sdev, state);
799 * If the device state changes to SDEV_RUNNING, we need to run
800 * the queue to avoid I/O hang.
802 if (ret == 0 && state == SDEV_RUNNING)
803 blk_mq_run_hw_queues(sdev->request_queue, true);
804 mutex_unlock(&sdev->state_mutex);
806 return ret == 0 ? count : -EINVAL;
810 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
812 struct scsi_device *sdev = to_scsi_device(dev);
813 const char *name = scsi_device_state_name(sdev->sdev_state);
818 return snprintf(buf, 20, "%s\n", name);
821 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
824 show_queue_type_field(struct device *dev, struct device_attribute *attr,
827 struct scsi_device *sdev = to_scsi_device(dev);
828 const char *name = "none";
830 if (sdev->simple_tags)
833 return snprintf(buf, 20, "%s\n", name);
837 store_queue_type_field(struct device *dev, struct device_attribute *attr,
838 const char *buf, size_t count)
840 struct scsi_device *sdev = to_scsi_device(dev);
842 if (!sdev->tagged_supported)
845 sdev_printk(KERN_INFO, sdev,
846 "ignoring write to deprecated queue_type attribute");
850 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
851 store_queue_type_field);
853 #define sdev_vpd_pg_attr(_page) \
855 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
856 struct bin_attribute *bin_attr, \
857 char *buf, loff_t off, size_t count) \
859 struct device *dev = container_of(kobj, struct device, kobj); \
860 struct scsi_device *sdev = to_scsi_device(dev); \
861 struct scsi_vpd *vpd_page; \
865 vpd_page = rcu_dereference(sdev->vpd_##_page); \
867 ret = memory_read_from_buffer(buf, count, &off, \
868 vpd_page->data, vpd_page->len); \
872 static struct bin_attribute dev_attr_vpd_##_page = { \
873 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
875 .read = show_vpd_##_page, \
878 sdev_vpd_pg_attr(pg83);
879 sdev_vpd_pg_attr(pg80);
880 sdev_vpd_pg_attr(pg89);
881 sdev_vpd_pg_attr(pg0);
883 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
884 struct bin_attribute *bin_attr,
885 char *buf, loff_t off, size_t count)
887 struct device *dev = container_of(kobj, struct device, kobj);
888 struct scsi_device *sdev = to_scsi_device(dev);
893 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
897 static struct bin_attribute dev_attr_inquiry = {
903 .read = show_inquiry,
907 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
910 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
913 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
915 #define show_sdev_iostat(field) \
917 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
920 struct scsi_device *sdev = to_scsi_device(dev); \
921 unsigned long long count = atomic_read(&sdev->field); \
922 return snprintf(buf, 20, "0x%llx\n", count); \
924 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
926 show_sdev_iostat(iorequest_cnt);
927 show_sdev_iostat(iodone_cnt);
928 show_sdev_iostat(ioerr_cnt);
931 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
933 struct scsi_device *sdev;
934 sdev = to_scsi_device(dev);
935 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
937 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
939 #define DECLARE_EVT_SHOW(name, Cap_name) \
941 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
944 struct scsi_device *sdev = to_scsi_device(dev); \
945 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
946 return snprintf(buf, 20, "%d\n", val); \
949 #define DECLARE_EVT_STORE(name, Cap_name) \
951 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
952 const char *buf, size_t count) \
954 struct scsi_device *sdev = to_scsi_device(dev); \
955 int val = simple_strtoul(buf, NULL, 0); \
957 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
959 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
965 #define DECLARE_EVT(name, Cap_name) \
966 DECLARE_EVT_SHOW(name, Cap_name) \
967 DECLARE_EVT_STORE(name, Cap_name) \
968 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
969 sdev_store_evt_##name);
970 #define REF_EVT(name) &dev_attr_evt_##name.attr
972 DECLARE_EVT(media_change, MEDIA_CHANGE)
973 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
974 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
975 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
976 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
977 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
980 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
981 const char *buf, size_t count)
984 struct scsi_device *sdev = to_scsi_device(dev);
985 struct scsi_host_template *sht = sdev->host->hostt;
987 if (!sht->change_queue_depth)
990 depth = simple_strtoul(buf, NULL, 0);
992 if (depth < 1 || depth > sdev->host->can_queue)
995 retval = sht->change_queue_depth(sdev, depth);
999 sdev->max_queue_depth = sdev->queue_depth;
1003 sdev_show_function(queue_depth, "%d\n");
1005 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1006 sdev_store_queue_depth);
1009 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1012 struct scsi_device *sdev = to_scsi_device(dev);
1015 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1022 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1024 #define BLIST_FLAG_NAME(name) \
1025 [const_ilog2((__force __u64)BLIST_##name)] = #name
1026 static const char *const sdev_bflags_name[] = {
1027 #include "scsi_devinfo_tbl.c"
1029 #undef BLIST_FLAG_NAME
1032 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1035 struct scsi_device *sdev = to_scsi_device(dev);
1039 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1040 const char *name = NULL;
1042 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1044 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1045 name = sdev_bflags_name[i];
1048 len += snprintf(buf + len, PAGE_SIZE - len,
1049 "%s%s", len ? " " : "", name);
1051 len += snprintf(buf + len, PAGE_SIZE - len,
1052 "%sINVALID_BIT(%d)", len ? " " : "", i);
1055 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
1058 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1060 #ifdef CONFIG_SCSI_DH
1062 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1065 struct scsi_device *sdev = to_scsi_device(dev);
1068 return snprintf(buf, 20, "detached\n");
1070 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1074 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1075 const char *buf, size_t count)
1077 struct scsi_device *sdev = to_scsi_device(dev);
1080 if (sdev->sdev_state == SDEV_CANCEL ||
1081 sdev->sdev_state == SDEV_DEL)
1084 if (!sdev->handler) {
1086 * Attach to a device handler
1088 err = scsi_dh_attach(sdev->request_queue, buf);
1089 } else if (!strncmp(buf, "activate", 8)) {
1091 * Activate a device handler
1093 if (sdev->handler->activate)
1094 err = sdev->handler->activate(sdev, NULL, NULL);
1097 } else if (!strncmp(buf, "detach", 6)) {
1099 * Detach from a device handler
1101 sdev_printk(KERN_WARNING, sdev,
1102 "can't detach handler %s.\n",
1103 sdev->handler->name);
1107 return err < 0 ? err : count;
1110 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1111 sdev_store_dh_state);
1114 sdev_show_access_state(struct device *dev,
1115 struct device_attribute *attr,
1118 struct scsi_device *sdev = to_scsi_device(dev);
1119 unsigned char access_state;
1120 const char *access_state_name;
1125 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1126 access_state_name = scsi_access_state_name(access_state);
1128 return sprintf(buf, "%s\n",
1129 access_state_name ? access_state_name : "unknown");
1131 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1134 sdev_show_preferred_path(struct device *dev,
1135 struct device_attribute *attr,
1138 struct scsi_device *sdev = to_scsi_device(dev);
1143 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1144 return sprintf(buf, "1\n");
1146 return sprintf(buf, "0\n");
1148 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1152 sdev_show_queue_ramp_up_period(struct device *dev,
1153 struct device_attribute *attr,
1156 struct scsi_device *sdev;
1157 sdev = to_scsi_device(dev);
1158 return snprintf(buf, 20, "%u\n",
1159 jiffies_to_msecs(sdev->queue_ramp_up_period));
1163 sdev_store_queue_ramp_up_period(struct device *dev,
1164 struct device_attribute *attr,
1165 const char *buf, size_t count)
1167 struct scsi_device *sdev = to_scsi_device(dev);
1168 unsigned int period;
1170 if (kstrtouint(buf, 10, &period))
1173 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1177 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1178 sdev_show_queue_ramp_up_period,
1179 sdev_store_queue_ramp_up_period);
1181 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1182 struct attribute *attr, int i)
1184 struct device *dev = container_of(kobj, struct device, kobj);
1185 struct scsi_device *sdev = to_scsi_device(dev);
1188 if (attr == &dev_attr_queue_depth.attr &&
1189 !sdev->host->hostt->change_queue_depth)
1192 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1193 !sdev->host->hostt->change_queue_depth)
1196 #ifdef CONFIG_SCSI_DH
1197 if (attr == &dev_attr_access_state.attr &&
1200 if (attr == &dev_attr_preferred_path.attr &&
1207 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1208 struct bin_attribute *attr, int i)
1210 struct device *dev = container_of(kobj, struct device, kobj);
1211 struct scsi_device *sdev = to_scsi_device(dev);
1214 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1217 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1220 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1223 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1229 /* Default template for device attributes. May NOT be modified */
1230 static struct attribute *scsi_sdev_attrs[] = {
1231 &dev_attr_device_blocked.attr,
1232 &dev_attr_type.attr,
1233 &dev_attr_scsi_level.attr,
1234 &dev_attr_device_busy.attr,
1235 &dev_attr_vendor.attr,
1236 &dev_attr_model.attr,
1238 &dev_attr_rescan.attr,
1239 &dev_attr_delete.attr,
1240 &dev_attr_state.attr,
1241 &dev_attr_timeout.attr,
1242 &dev_attr_eh_timeout.attr,
1243 &dev_attr_iocounterbits.attr,
1244 &dev_attr_iorequest_cnt.attr,
1245 &dev_attr_iodone_cnt.attr,
1246 &dev_attr_ioerr_cnt.attr,
1247 &dev_attr_modalias.attr,
1248 &dev_attr_queue_depth.attr,
1249 &dev_attr_queue_type.attr,
1250 &dev_attr_wwid.attr,
1251 &dev_attr_blacklist.attr,
1252 #ifdef CONFIG_SCSI_DH
1253 &dev_attr_dh_state.attr,
1254 &dev_attr_access_state.attr,
1255 &dev_attr_preferred_path.attr,
1257 &dev_attr_queue_ramp_up_period.attr,
1258 REF_EVT(media_change),
1259 REF_EVT(inquiry_change_reported),
1260 REF_EVT(capacity_change_reported),
1261 REF_EVT(soft_threshold_reached),
1262 REF_EVT(mode_parameter_change_reported),
1263 REF_EVT(lun_change_reported),
1267 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1275 static struct attribute_group scsi_sdev_attr_group = {
1276 .attrs = scsi_sdev_attrs,
1277 .bin_attrs = scsi_sdev_bin_attrs,
1278 .is_visible = scsi_sdev_attr_is_visible,
1279 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1282 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1283 &scsi_sdev_attr_group,
1287 static int scsi_target_add(struct scsi_target *starget)
1291 if (starget->state != STARGET_CREATED)
1294 error = device_add(&starget->dev);
1296 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1299 transport_add_device(&starget->dev);
1300 starget->state = STARGET_RUNNING;
1302 pm_runtime_set_active(&starget->dev);
1303 pm_runtime_enable(&starget->dev);
1304 device_enable_async_suspend(&starget->dev);
1310 * scsi_sysfs_add_sdev - add scsi device to sysfs
1311 * @sdev: scsi_device to add
1314 * 0 on Success / non-zero on Failure
1316 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1319 struct request_queue *rq = sdev->request_queue;
1320 struct scsi_target *starget = sdev->sdev_target;
1322 error = scsi_target_add(starget);
1326 transport_configure_device(&starget->dev);
1328 device_enable_async_suspend(&sdev->sdev_gendev);
1329 scsi_autopm_get_target(starget);
1330 pm_runtime_set_active(&sdev->sdev_gendev);
1331 if (!sdev->rpm_autosuspend)
1332 pm_runtime_forbid(&sdev->sdev_gendev);
1333 pm_runtime_enable(&sdev->sdev_gendev);
1334 scsi_autopm_put_target(starget);
1336 scsi_autopm_get_device(sdev);
1338 scsi_dh_add_device(sdev);
1340 error = device_add(&sdev->sdev_gendev);
1342 sdev_printk(KERN_INFO, sdev,
1343 "failed to add device: %d\n", error);
1347 device_enable_async_suspend(&sdev->sdev_dev);
1348 error = device_add(&sdev->sdev_dev);
1350 sdev_printk(KERN_INFO, sdev,
1351 "failed to add class device: %d\n", error);
1352 device_del(&sdev->sdev_gendev);
1355 transport_add_device(&sdev->sdev_gendev);
1356 sdev->is_visible = 1;
1358 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1360 /* we're treating error on bsg register as non-fatal,
1361 * so pretend nothing went wrong */
1362 sdev_printk(KERN_INFO, sdev,
1363 "Failed to register bsg queue, errno=%d\n", error);
1365 /* add additional host specific attributes */
1366 if (sdev->host->hostt->sdev_attrs) {
1367 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1368 error = device_create_file(&sdev->sdev_gendev,
1369 sdev->host->hostt->sdev_attrs[i]);
1375 if (sdev->host->hostt->sdev_groups) {
1376 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1377 sdev->host->hostt->sdev_groups);
1382 scsi_autopm_put_device(sdev);
1386 void __scsi_remove_device(struct scsi_device *sdev)
1388 struct device *dev = &sdev->sdev_gendev;
1392 * This cleanup path is not reentrant and while it is impossible
1393 * to get a new reference with scsi_device_get() someone can still
1394 * hold a previously acquired one.
1396 if (sdev->sdev_state == SDEV_DEL)
1399 if (sdev->is_visible) {
1401 * If scsi_internal_target_block() is running concurrently,
1402 * wait until it has finished before changing the device state.
1404 mutex_lock(&sdev->state_mutex);
1406 * If blocked, we go straight to DEL and restart the queue so
1407 * any commands issued during driver shutdown (like sync
1408 * cache) are errored immediately.
1410 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1412 res = scsi_device_set_state(sdev, SDEV_DEL);
1414 scsi_start_queue(sdev);
1416 mutex_unlock(&sdev->state_mutex);
1421 if (sdev->host->hostt->sdev_groups)
1422 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1423 sdev->host->hostt->sdev_groups);
1425 bsg_unregister_queue(sdev->request_queue);
1426 device_unregister(&sdev->sdev_dev);
1427 transport_remove_device(dev);
1430 put_device(&sdev->sdev_dev);
1433 * Stop accepting new requests and wait until all queuecommand() and
1434 * scsi_run_queue() invocations have finished before tearing down the
1437 mutex_lock(&sdev->state_mutex);
1438 scsi_device_set_state(sdev, SDEV_DEL);
1439 mutex_unlock(&sdev->state_mutex);
1441 blk_cleanup_queue(sdev->request_queue);
1442 cancel_work_sync(&sdev->requeue_work);
1444 if (sdev->host->hostt->slave_destroy)
1445 sdev->host->hostt->slave_destroy(sdev);
1446 transport_destroy_device(dev);
1449 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1450 * remoed sysfs visibility from the device, so make the target
1451 * invisible if this was the last device underneath it.
1453 scsi_target_reap(scsi_target(sdev));
1459 * scsi_remove_device - unregister a device from the scsi bus
1460 * @sdev: scsi_device to unregister
1462 void scsi_remove_device(struct scsi_device *sdev)
1464 struct Scsi_Host *shost = sdev->host;
1466 mutex_lock(&shost->scan_mutex);
1467 __scsi_remove_device(sdev);
1468 mutex_unlock(&shost->scan_mutex);
1470 EXPORT_SYMBOL(scsi_remove_device);
1472 static void __scsi_remove_target(struct scsi_target *starget)
1474 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1475 unsigned long flags;
1476 struct scsi_device *sdev;
1478 spin_lock_irqsave(shost->host_lock, flags);
1480 list_for_each_entry(sdev, &shost->__devices, siblings) {
1482 * We cannot call scsi_device_get() here, as
1483 * we might've been called from rmmod() causing
1484 * scsi_device_get() to fail the module_is_live()
1487 if (sdev->channel != starget->channel ||
1488 sdev->id != starget->id)
1490 if (sdev->sdev_state == SDEV_DEL ||
1491 sdev->sdev_state == SDEV_CANCEL ||
1492 !get_device(&sdev->sdev_gendev))
1494 spin_unlock_irqrestore(shost->host_lock, flags);
1495 scsi_remove_device(sdev);
1496 put_device(&sdev->sdev_gendev);
1497 spin_lock_irqsave(shost->host_lock, flags);
1500 spin_unlock_irqrestore(shost->host_lock, flags);
1504 * scsi_remove_target - try to remove a target and all its devices
1505 * @dev: generic starget or parent of generic stargets to be removed
1507 * Note: This is slightly racy. It is possible that if the user
1508 * requests the addition of another device then the target won't be
1511 void scsi_remove_target(struct device *dev)
1513 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1514 struct scsi_target *starget;
1515 unsigned long flags;
1518 spin_lock_irqsave(shost->host_lock, flags);
1519 list_for_each_entry(starget, &shost->__targets, siblings) {
1520 if (starget->state == STARGET_DEL ||
1521 starget->state == STARGET_REMOVE ||
1522 starget->state == STARGET_CREATED_REMOVE)
1524 if (starget->dev.parent == dev || &starget->dev == dev) {
1525 kref_get(&starget->reap_ref);
1526 if (starget->state == STARGET_CREATED)
1527 starget->state = STARGET_CREATED_REMOVE;
1529 starget->state = STARGET_REMOVE;
1530 spin_unlock_irqrestore(shost->host_lock, flags);
1531 __scsi_remove_target(starget);
1532 scsi_target_reap(starget);
1536 spin_unlock_irqrestore(shost->host_lock, flags);
1538 EXPORT_SYMBOL(scsi_remove_target);
1540 int scsi_register_driver(struct device_driver *drv)
1542 drv->bus = &scsi_bus_type;
1544 return driver_register(drv);
1546 EXPORT_SYMBOL(scsi_register_driver);
1548 int scsi_register_interface(struct class_interface *intf)
1550 intf->class = &sdev_class;
1552 return class_interface_register(intf);
1554 EXPORT_SYMBOL(scsi_register_interface);
1557 * scsi_sysfs_add_host - add scsi host to subsystem
1558 * @shost: scsi host struct to add to subsystem
1560 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1564 /* add host specific attributes */
1565 if (shost->hostt->shost_attrs) {
1566 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1567 error = device_create_file(&shost->shost_dev,
1568 shost->hostt->shost_attrs[i]);
1574 transport_register_device(&shost->shost_gendev);
1575 transport_configure_device(&shost->shost_gendev);
1579 static struct device_type scsi_dev_type = {
1580 .name = "scsi_device",
1581 .release = scsi_device_dev_release,
1582 .groups = scsi_sdev_attr_groups,
1585 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1587 unsigned long flags;
1588 struct Scsi_Host *shost = sdev->host;
1589 struct scsi_target *starget = sdev->sdev_target;
1591 device_initialize(&sdev->sdev_gendev);
1592 sdev->sdev_gendev.bus = &scsi_bus_type;
1593 sdev->sdev_gendev.type = &scsi_dev_type;
1594 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1595 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1597 device_initialize(&sdev->sdev_dev);
1598 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1599 sdev->sdev_dev.class = &sdev_class;
1600 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1601 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1603 * Get a default scsi_level from the target (derived from sibling
1604 * devices). This is the best we can do for guessing how to set
1605 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1606 * setting doesn't matter, because all the bits are zero anyway.
1607 * But it does matter for higher LUNs.
1609 sdev->scsi_level = starget->scsi_level;
1610 if (sdev->scsi_level <= SCSI_2 &&
1611 sdev->scsi_level != SCSI_UNKNOWN &&
1612 !shost->no_scsi2_lun_in_cdb)
1613 sdev->lun_in_cdb = 1;
1615 transport_setup_device(&sdev->sdev_gendev);
1616 spin_lock_irqsave(shost->host_lock, flags);
1617 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1618 list_add_tail(&sdev->siblings, &shost->__devices);
1619 spin_unlock_irqrestore(shost->host_lock, flags);
1621 * device can now only be removed via __scsi_remove_device() so hold
1622 * the target. Target will be held in CREATED state until something
1623 * beneath it becomes visible (in which case it moves to RUNNING)
1625 kref_get(&starget->reap_ref);
1628 int scsi_is_sdev_device(const struct device *dev)
1630 return dev->type == &scsi_dev_type;
1632 EXPORT_SYMBOL(scsi_is_sdev_device);
1634 /* A blank transport template that is used in drivers that don't
1635 * yet implement Transport Attributes */
1636 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };