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, "%d\n");
374 shost_rd_attr(sg_tablesize, "%hu\n");
375 shost_rd_attr(sg_prot_tablesize, "%hu\n");
376 shost_rd_attr(prot_capabilities, "%u\n");
377 shost_rd_attr(prot_guard_type, "%hd\n");
378 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
381 show_host_busy(struct device *dev, struct device_attribute *attr, char *buf)
383 struct Scsi_Host *shost = class_to_shost(dev);
384 return snprintf(buf, 20, "%d\n", scsi_host_busy(shost));
386 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
389 show_use_blk_mq(struct device *dev, struct device_attribute *attr, char *buf)
391 return sprintf(buf, "1\n");
393 static DEVICE_ATTR(use_blk_mq, S_IRUGO, show_use_blk_mq, NULL);
396 show_nr_hw_queues(struct device *dev, struct device_attribute *attr, char *buf)
398 struct Scsi_Host *shost = class_to_shost(dev);
399 struct blk_mq_tag_set *tag_set = &shost->tag_set;
401 return snprintf(buf, 20, "%d\n", tag_set->nr_hw_queues);
403 static DEVICE_ATTR(nr_hw_queues, S_IRUGO, show_nr_hw_queues, NULL);
405 static struct attribute *scsi_sysfs_shost_attrs[] = {
406 &dev_attr_use_blk_mq.attr,
407 &dev_attr_unique_id.attr,
408 &dev_attr_host_busy.attr,
409 &dev_attr_cmd_per_lun.attr,
410 &dev_attr_can_queue.attr,
411 &dev_attr_sg_tablesize.attr,
412 &dev_attr_sg_prot_tablesize.attr,
413 &dev_attr_proc_name.attr,
415 &dev_attr_hstate.attr,
416 &dev_attr_supported_mode.attr,
417 &dev_attr_active_mode.attr,
418 &dev_attr_prot_capabilities.attr,
419 &dev_attr_prot_guard_type.attr,
420 &dev_attr_host_reset.attr,
421 &dev_attr_eh_deadline.attr,
422 &dev_attr_nr_hw_queues.attr,
426 static struct attribute_group scsi_shost_attr_group = {
427 .attrs = scsi_sysfs_shost_attrs,
430 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
431 &scsi_shost_attr_group,
435 static void scsi_device_cls_release(struct device *class_dev)
437 struct scsi_device *sdev;
439 sdev = class_to_sdev(class_dev);
440 put_device(&sdev->sdev_gendev);
443 static void scsi_device_dev_release_usercontext(struct work_struct *work)
445 struct scsi_device *sdev;
446 struct device *parent;
447 struct list_head *this, *tmp;
448 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
449 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
452 sdev = container_of(work, struct scsi_device, ew.work);
454 scsi_dh_release_device(sdev);
456 parent = sdev->sdev_gendev.parent;
458 spin_lock_irqsave(sdev->host->host_lock, flags);
459 list_del(&sdev->siblings);
460 list_del(&sdev->same_target_siblings);
461 list_del(&sdev->starved_entry);
462 spin_unlock_irqrestore(sdev->host->host_lock, flags);
464 cancel_work_sync(&sdev->event_work);
466 list_for_each_safe(this, tmp, &sdev->event_list) {
467 struct scsi_event *evt;
469 evt = list_entry(this, struct scsi_event, node);
470 list_del(&evt->node);
474 blk_put_queue(sdev->request_queue);
475 /* NULL queue means the device can't be used */
476 sdev->request_queue = NULL;
478 sbitmap_free(&sdev->budget_map);
480 mutex_lock(&sdev->inquiry_mutex);
481 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
482 lockdep_is_held(&sdev->inquiry_mutex));
483 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
484 lockdep_is_held(&sdev->inquiry_mutex));
485 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
486 lockdep_is_held(&sdev->inquiry_mutex));
487 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
488 lockdep_is_held(&sdev->inquiry_mutex));
489 mutex_unlock(&sdev->inquiry_mutex);
492 kfree_rcu(vpd_pg0, rcu);
494 kfree_rcu(vpd_pg83, rcu);
496 kfree_rcu(vpd_pg80, rcu);
498 kfree_rcu(vpd_pg89, rcu);
499 kfree(sdev->inquiry);
506 static void scsi_device_dev_release(struct device *dev)
508 struct scsi_device *sdp = to_scsi_device(dev);
509 execute_in_process_context(scsi_device_dev_release_usercontext,
513 static struct class sdev_class = {
514 .name = "scsi_device",
515 .dev_release = scsi_device_cls_release,
518 /* all probing is done in the individual ->probe routines */
519 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
521 struct scsi_device *sdp;
523 if (dev->type != &scsi_dev_type)
526 sdp = to_scsi_device(dev);
527 if (sdp->no_uld_attach)
529 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
532 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
534 struct scsi_device *sdev;
536 if (dev->type != &scsi_dev_type)
539 sdev = to_scsi_device(dev);
541 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
545 struct bus_type scsi_bus_type = {
547 .match = scsi_bus_match,
548 .uevent = scsi_bus_uevent,
550 .pm = &scsi_bus_pm_ops,
553 EXPORT_SYMBOL_GPL(scsi_bus_type);
555 int scsi_sysfs_register(void)
559 error = bus_register(&scsi_bus_type);
561 error = class_register(&sdev_class);
563 bus_unregister(&scsi_bus_type);
569 void scsi_sysfs_unregister(void)
571 class_unregister(&sdev_class);
572 bus_unregister(&scsi_bus_type);
576 * sdev_show_function: macro to create an attr function that can be used to
577 * show a non-bit field.
579 #define sdev_show_function(field, format_string) \
581 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
584 struct scsi_device *sdev; \
585 sdev = to_scsi_device(dev); \
586 return snprintf (buf, 20, format_string, sdev->field); \
590 * sdev_rd_attr: macro to create a function and attribute variable for a
593 #define sdev_rd_attr(field, format_string) \
594 sdev_show_function(field, format_string) \
595 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
599 * sdev_rw_attr: create a function and attribute variable for a
602 #define sdev_rw_attr(field, format_string) \
603 sdev_show_function(field, format_string) \
606 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
607 const char *buf, size_t count) \
609 struct scsi_device *sdev; \
610 sdev = to_scsi_device(dev); \
611 sscanf (buf, format_string, &sdev->field); \
614 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
616 /* Currently we don't export bit fields, but we might in future,
617 * so leave this code in */
620 * sdev_rd_attr: create a function and attribute variable for a
621 * read/write bit field.
623 #define sdev_rw_attr_bit(field) \
624 sdev_show_function(field, "%d\n") \
627 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
628 const char *buf, size_t count) \
631 struct scsi_device *sdev; \
632 ret = scsi_sdev_check_buf_bit(buf); \
634 sdev = to_scsi_device(dev); \
640 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
643 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
644 * else return -EINVAL.
646 static int scsi_sdev_check_buf_bit(const char *buf)
648 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
651 else if (buf[0] == '0')
660 * Create the actual show/store functions and data structures.
662 sdev_rd_attr (type, "%d\n");
663 sdev_rd_attr (scsi_level, "%d\n");
664 sdev_rd_attr (vendor, "%.8s\n");
665 sdev_rd_attr (model, "%.16s\n");
666 sdev_rd_attr (rev, "%.4s\n");
669 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
672 struct scsi_device *sdev = to_scsi_device(dev);
673 return snprintf(buf, 20, "%d\n", scsi_device_busy(sdev));
675 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
678 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
681 struct scsi_device *sdev = to_scsi_device(dev);
682 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
684 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
687 * TODO: can we make these symlinks to the block layer ones?
690 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
692 struct scsi_device *sdev;
693 sdev = to_scsi_device(dev);
694 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
698 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
699 const char *buf, size_t count)
701 struct scsi_device *sdev;
703 sdev = to_scsi_device(dev);
704 sscanf (buf, "%d\n", &timeout);
705 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
708 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
711 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
713 struct scsi_device *sdev;
714 sdev = to_scsi_device(dev);
715 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
719 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
720 const char *buf, size_t count)
722 struct scsi_device *sdev;
723 unsigned int eh_timeout;
726 if (!capable(CAP_SYS_ADMIN))
729 sdev = to_scsi_device(dev);
730 err = kstrtouint(buf, 10, &eh_timeout);
733 sdev->eh_timeout = eh_timeout * HZ;
737 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
740 store_rescan_field (struct device *dev, struct device_attribute *attr,
741 const char *buf, size_t count)
743 scsi_rescan_device(dev);
746 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
749 sdev_store_delete(struct device *dev, struct device_attribute *attr,
750 const char *buf, size_t count)
752 struct kernfs_node *kn;
753 struct scsi_device *sdev = to_scsi_device(dev);
756 * We need to try to get module, avoiding the module been removed
759 if (scsi_device_get(sdev))
762 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
765 * Concurrent writes into the "delete" sysfs attribute may trigger
766 * concurrent calls to device_remove_file() and scsi_remove_device().
767 * device_remove_file() handles concurrent removal calls by
768 * serializing these and by ignoring the second and later removal
769 * attempts. Concurrent calls of scsi_remove_device() are
770 * serialized. The second and later calls of scsi_remove_device() are
771 * ignored because the first call of that function changes the device
772 * state into SDEV_DEL.
774 device_remove_file(dev, attr);
775 scsi_remove_device(sdev);
777 sysfs_unbreak_active_protection(kn);
778 scsi_device_put(sdev);
781 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
784 store_state_field(struct device *dev, struct device_attribute *attr,
785 const char *buf, size_t count)
788 struct scsi_device *sdev = to_scsi_device(dev);
789 enum scsi_device_state state = 0;
791 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
792 const int len = strlen(sdev_states[i].name);
793 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
795 state = sdev_states[i].value;
807 mutex_lock(&sdev->state_mutex);
808 ret = scsi_device_set_state(sdev, state);
810 * If the device state changes to SDEV_RUNNING, we need to run
811 * the queue to avoid I/O hang.
813 if (ret == 0 && state == SDEV_RUNNING)
814 blk_mq_run_hw_queues(sdev->request_queue, true);
815 mutex_unlock(&sdev->state_mutex);
817 return ret == 0 ? count : -EINVAL;
821 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
823 struct scsi_device *sdev = to_scsi_device(dev);
824 const char *name = scsi_device_state_name(sdev->sdev_state);
829 return snprintf(buf, 20, "%s\n", name);
832 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
835 show_queue_type_field(struct device *dev, struct device_attribute *attr,
838 struct scsi_device *sdev = to_scsi_device(dev);
839 const char *name = "none";
841 if (sdev->simple_tags)
844 return snprintf(buf, 20, "%s\n", name);
848 store_queue_type_field(struct device *dev, struct device_attribute *attr,
849 const char *buf, size_t count)
851 struct scsi_device *sdev = to_scsi_device(dev);
853 if (!sdev->tagged_supported)
856 sdev_printk(KERN_INFO, sdev,
857 "ignoring write to deprecated queue_type attribute");
861 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
862 store_queue_type_field);
864 #define sdev_vpd_pg_attr(_page) \
866 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
867 struct bin_attribute *bin_attr, \
868 char *buf, loff_t off, size_t count) \
870 struct device *dev = kobj_to_dev(kobj); \
871 struct scsi_device *sdev = to_scsi_device(dev); \
872 struct scsi_vpd *vpd_page; \
876 vpd_page = rcu_dereference(sdev->vpd_##_page); \
878 ret = memory_read_from_buffer(buf, count, &off, \
879 vpd_page->data, vpd_page->len); \
883 static struct bin_attribute dev_attr_vpd_##_page = { \
884 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
886 .read = show_vpd_##_page, \
889 sdev_vpd_pg_attr(pg83);
890 sdev_vpd_pg_attr(pg80);
891 sdev_vpd_pg_attr(pg89);
892 sdev_vpd_pg_attr(pg0);
894 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
895 struct bin_attribute *bin_attr,
896 char *buf, loff_t off, size_t count)
898 struct device *dev = kobj_to_dev(kobj);
899 struct scsi_device *sdev = to_scsi_device(dev);
904 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
908 static struct bin_attribute dev_attr_inquiry = {
914 .read = show_inquiry,
918 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
921 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
924 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
926 #define show_sdev_iostat(field) \
928 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
931 struct scsi_device *sdev = to_scsi_device(dev); \
932 unsigned long long count = atomic_read(&sdev->field); \
933 return snprintf(buf, 20, "0x%llx\n", count); \
935 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
937 show_sdev_iostat(iorequest_cnt);
938 show_sdev_iostat(iodone_cnt);
939 show_sdev_iostat(ioerr_cnt);
942 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
944 struct scsi_device *sdev;
945 sdev = to_scsi_device(dev);
946 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
948 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
950 #define DECLARE_EVT_SHOW(name, Cap_name) \
952 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
955 struct scsi_device *sdev = to_scsi_device(dev); \
956 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
957 return snprintf(buf, 20, "%d\n", val); \
960 #define DECLARE_EVT_STORE(name, Cap_name) \
962 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
963 const char *buf, size_t count) \
965 struct scsi_device *sdev = to_scsi_device(dev); \
966 int val = simple_strtoul(buf, NULL, 0); \
968 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
970 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
976 #define DECLARE_EVT(name, Cap_name) \
977 DECLARE_EVT_SHOW(name, Cap_name) \
978 DECLARE_EVT_STORE(name, Cap_name) \
979 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
980 sdev_store_evt_##name);
981 #define REF_EVT(name) &dev_attr_evt_##name.attr
983 DECLARE_EVT(media_change, MEDIA_CHANGE)
984 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
985 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
986 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
987 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
988 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
991 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
992 const char *buf, size_t count)
995 struct scsi_device *sdev = to_scsi_device(dev);
996 struct scsi_host_template *sht = sdev->host->hostt;
998 if (!sht->change_queue_depth)
1001 depth = simple_strtoul(buf, NULL, 0);
1003 if (depth < 1 || depth > sdev->host->can_queue)
1006 retval = sht->change_queue_depth(sdev, depth);
1010 sdev->max_queue_depth = sdev->queue_depth;
1014 sdev_show_function(queue_depth, "%d\n");
1016 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1017 sdev_store_queue_depth);
1020 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1023 struct scsi_device *sdev = to_scsi_device(dev);
1026 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1033 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1035 #define BLIST_FLAG_NAME(name) \
1036 [const_ilog2((__force __u64)BLIST_##name)] = #name
1037 static const char *const sdev_bflags_name[] = {
1038 #include "scsi_devinfo_tbl.c"
1040 #undef BLIST_FLAG_NAME
1043 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1046 struct scsi_device *sdev = to_scsi_device(dev);
1050 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1051 const char *name = NULL;
1053 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1055 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1056 name = sdev_bflags_name[i];
1059 len += scnprintf(buf + len, PAGE_SIZE - len,
1060 "%s%s", len ? " " : "", name);
1062 len += scnprintf(buf + len, PAGE_SIZE - len,
1063 "%sINVALID_BIT(%d)", len ? " " : "", i);
1066 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1069 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1071 #ifdef CONFIG_SCSI_DH
1073 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1076 struct scsi_device *sdev = to_scsi_device(dev);
1079 return snprintf(buf, 20, "detached\n");
1081 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1085 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1086 const char *buf, size_t count)
1088 struct scsi_device *sdev = to_scsi_device(dev);
1091 if (sdev->sdev_state == SDEV_CANCEL ||
1092 sdev->sdev_state == SDEV_DEL)
1095 if (!sdev->handler) {
1097 * Attach to a device handler
1099 err = scsi_dh_attach(sdev->request_queue, buf);
1100 } else if (!strncmp(buf, "activate", 8)) {
1102 * Activate a device handler
1104 if (sdev->handler->activate)
1105 err = sdev->handler->activate(sdev, NULL, NULL);
1108 } else if (!strncmp(buf, "detach", 6)) {
1110 * Detach from a device handler
1112 sdev_printk(KERN_WARNING, sdev,
1113 "can't detach handler %s.\n",
1114 sdev->handler->name);
1118 return err < 0 ? err : count;
1121 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1122 sdev_store_dh_state);
1125 sdev_show_access_state(struct device *dev,
1126 struct device_attribute *attr,
1129 struct scsi_device *sdev = to_scsi_device(dev);
1130 unsigned char access_state;
1131 const char *access_state_name;
1136 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1137 access_state_name = scsi_access_state_name(access_state);
1139 return sprintf(buf, "%s\n",
1140 access_state_name ? access_state_name : "unknown");
1142 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1145 sdev_show_preferred_path(struct device *dev,
1146 struct device_attribute *attr,
1149 struct scsi_device *sdev = to_scsi_device(dev);
1154 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1155 return sprintf(buf, "1\n");
1157 return sprintf(buf, "0\n");
1159 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1163 sdev_show_queue_ramp_up_period(struct device *dev,
1164 struct device_attribute *attr,
1167 struct scsi_device *sdev;
1168 sdev = to_scsi_device(dev);
1169 return snprintf(buf, 20, "%u\n",
1170 jiffies_to_msecs(sdev->queue_ramp_up_period));
1174 sdev_store_queue_ramp_up_period(struct device *dev,
1175 struct device_attribute *attr,
1176 const char *buf, size_t count)
1178 struct scsi_device *sdev = to_scsi_device(dev);
1179 unsigned int period;
1181 if (kstrtouint(buf, 10, &period))
1184 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1188 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1189 sdev_show_queue_ramp_up_period,
1190 sdev_store_queue_ramp_up_period);
1192 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1193 struct attribute *attr, int i)
1195 struct device *dev = kobj_to_dev(kobj);
1196 struct scsi_device *sdev = to_scsi_device(dev);
1199 if (attr == &dev_attr_queue_depth.attr &&
1200 !sdev->host->hostt->change_queue_depth)
1203 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1204 !sdev->host->hostt->change_queue_depth)
1207 #ifdef CONFIG_SCSI_DH
1208 if (attr == &dev_attr_access_state.attr &&
1211 if (attr == &dev_attr_preferred_path.attr &&
1218 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1219 struct bin_attribute *attr, int i)
1221 struct device *dev = kobj_to_dev(kobj);
1222 struct scsi_device *sdev = to_scsi_device(dev);
1225 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1228 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1231 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1234 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1240 /* Default template for device attributes. May NOT be modified */
1241 static struct attribute *scsi_sdev_attrs[] = {
1242 &dev_attr_device_blocked.attr,
1243 &dev_attr_type.attr,
1244 &dev_attr_scsi_level.attr,
1245 &dev_attr_device_busy.attr,
1246 &dev_attr_vendor.attr,
1247 &dev_attr_model.attr,
1249 &dev_attr_rescan.attr,
1250 &dev_attr_delete.attr,
1251 &dev_attr_state.attr,
1252 &dev_attr_timeout.attr,
1253 &dev_attr_eh_timeout.attr,
1254 &dev_attr_iocounterbits.attr,
1255 &dev_attr_iorequest_cnt.attr,
1256 &dev_attr_iodone_cnt.attr,
1257 &dev_attr_ioerr_cnt.attr,
1258 &dev_attr_modalias.attr,
1259 &dev_attr_queue_depth.attr,
1260 &dev_attr_queue_type.attr,
1261 &dev_attr_wwid.attr,
1262 &dev_attr_blacklist.attr,
1263 #ifdef CONFIG_SCSI_DH
1264 &dev_attr_dh_state.attr,
1265 &dev_attr_access_state.attr,
1266 &dev_attr_preferred_path.attr,
1268 &dev_attr_queue_ramp_up_period.attr,
1269 REF_EVT(media_change),
1270 REF_EVT(inquiry_change_reported),
1271 REF_EVT(capacity_change_reported),
1272 REF_EVT(soft_threshold_reached),
1273 REF_EVT(mode_parameter_change_reported),
1274 REF_EVT(lun_change_reported),
1278 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1286 static struct attribute_group scsi_sdev_attr_group = {
1287 .attrs = scsi_sdev_attrs,
1288 .bin_attrs = scsi_sdev_bin_attrs,
1289 .is_visible = scsi_sdev_attr_is_visible,
1290 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1293 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1294 &scsi_sdev_attr_group,
1298 static int scsi_target_add(struct scsi_target *starget)
1302 if (starget->state != STARGET_CREATED)
1305 error = device_add(&starget->dev);
1307 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1310 transport_add_device(&starget->dev);
1311 starget->state = STARGET_RUNNING;
1313 pm_runtime_set_active(&starget->dev);
1314 pm_runtime_enable(&starget->dev);
1315 device_enable_async_suspend(&starget->dev);
1321 * scsi_sysfs_add_sdev - add scsi device to sysfs
1322 * @sdev: scsi_device to add
1325 * 0 on Success / non-zero on Failure
1327 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1330 struct request_queue *rq = sdev->request_queue;
1331 struct scsi_target *starget = sdev->sdev_target;
1333 error = scsi_target_add(starget);
1337 transport_configure_device(&starget->dev);
1339 device_enable_async_suspend(&sdev->sdev_gendev);
1340 scsi_autopm_get_target(starget);
1341 pm_runtime_set_active(&sdev->sdev_gendev);
1342 if (!sdev->rpm_autosuspend)
1343 pm_runtime_forbid(&sdev->sdev_gendev);
1344 pm_runtime_enable(&sdev->sdev_gendev);
1345 scsi_autopm_put_target(starget);
1347 scsi_autopm_get_device(sdev);
1349 scsi_dh_add_device(sdev);
1351 error = device_add(&sdev->sdev_gendev);
1353 sdev_printk(KERN_INFO, sdev,
1354 "failed to add device: %d\n", error);
1358 device_enable_async_suspend(&sdev->sdev_dev);
1359 error = device_add(&sdev->sdev_dev);
1361 sdev_printk(KERN_INFO, sdev,
1362 "failed to add class device: %d\n", error);
1363 device_del(&sdev->sdev_gendev);
1366 transport_add_device(&sdev->sdev_gendev);
1367 sdev->is_visible = 1;
1369 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1371 /* we're treating error on bsg register as non-fatal,
1372 * so pretend nothing went wrong */
1373 sdev_printk(KERN_INFO, sdev,
1374 "Failed to register bsg queue, errno=%d\n", error);
1376 /* add additional host specific attributes */
1377 if (sdev->host->hostt->sdev_attrs) {
1378 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1379 error = device_create_file(&sdev->sdev_gendev,
1380 sdev->host->hostt->sdev_attrs[i]);
1386 if (sdev->host->hostt->sdev_groups) {
1387 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1388 sdev->host->hostt->sdev_groups);
1393 scsi_autopm_put_device(sdev);
1397 void __scsi_remove_device(struct scsi_device *sdev)
1399 struct device *dev = &sdev->sdev_gendev;
1403 * This cleanup path is not reentrant and while it is impossible
1404 * to get a new reference with scsi_device_get() someone can still
1405 * hold a previously acquired one.
1407 if (sdev->sdev_state == SDEV_DEL)
1410 if (sdev->is_visible) {
1412 * If scsi_internal_target_block() is running concurrently,
1413 * wait until it has finished before changing the device state.
1415 mutex_lock(&sdev->state_mutex);
1417 * If blocked, we go straight to DEL and restart the queue so
1418 * any commands issued during driver shutdown (like sync
1419 * cache) are errored immediately.
1421 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1423 res = scsi_device_set_state(sdev, SDEV_DEL);
1425 scsi_start_queue(sdev);
1427 mutex_unlock(&sdev->state_mutex);
1432 if (sdev->host->hostt->sdev_groups)
1433 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1434 sdev->host->hostt->sdev_groups);
1436 bsg_unregister_queue(sdev->request_queue);
1437 device_unregister(&sdev->sdev_dev);
1438 transport_remove_device(dev);
1441 put_device(&sdev->sdev_dev);
1444 * Stop accepting new requests and wait until all queuecommand() and
1445 * scsi_run_queue() invocations have finished before tearing down the
1448 mutex_lock(&sdev->state_mutex);
1449 scsi_device_set_state(sdev, SDEV_DEL);
1450 mutex_unlock(&sdev->state_mutex);
1452 blk_cleanup_queue(sdev->request_queue);
1453 cancel_work_sync(&sdev->requeue_work);
1455 if (sdev->host->hostt->slave_destroy)
1456 sdev->host->hostt->slave_destroy(sdev);
1457 transport_destroy_device(dev);
1460 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1461 * removed sysfs visibility from the device, so make the target
1462 * invisible if this was the last device underneath it.
1464 scsi_target_reap(scsi_target(sdev));
1470 * scsi_remove_device - unregister a device from the scsi bus
1471 * @sdev: scsi_device to unregister
1473 void scsi_remove_device(struct scsi_device *sdev)
1475 struct Scsi_Host *shost = sdev->host;
1477 mutex_lock(&shost->scan_mutex);
1478 __scsi_remove_device(sdev);
1479 mutex_unlock(&shost->scan_mutex);
1481 EXPORT_SYMBOL(scsi_remove_device);
1483 static void __scsi_remove_target(struct scsi_target *starget)
1485 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1486 unsigned long flags;
1487 struct scsi_device *sdev;
1489 spin_lock_irqsave(shost->host_lock, flags);
1491 list_for_each_entry(sdev, &shost->__devices, siblings) {
1493 * We cannot call scsi_device_get() here, as
1494 * we might've been called from rmmod() causing
1495 * scsi_device_get() to fail the module_is_live()
1498 if (sdev->channel != starget->channel ||
1499 sdev->id != starget->id)
1501 if (sdev->sdev_state == SDEV_DEL ||
1502 sdev->sdev_state == SDEV_CANCEL ||
1503 !get_device(&sdev->sdev_gendev))
1505 spin_unlock_irqrestore(shost->host_lock, flags);
1506 scsi_remove_device(sdev);
1507 put_device(&sdev->sdev_gendev);
1508 spin_lock_irqsave(shost->host_lock, flags);
1511 spin_unlock_irqrestore(shost->host_lock, flags);
1515 * scsi_remove_target - try to remove a target and all its devices
1516 * @dev: generic starget or parent of generic stargets to be removed
1518 * Note: This is slightly racy. It is possible that if the user
1519 * requests the addition of another device then the target won't be
1522 void scsi_remove_target(struct device *dev)
1524 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1525 struct scsi_target *starget;
1526 unsigned long flags;
1529 spin_lock_irqsave(shost->host_lock, flags);
1530 list_for_each_entry(starget, &shost->__targets, siblings) {
1531 if (starget->state == STARGET_DEL ||
1532 starget->state == STARGET_REMOVE ||
1533 starget->state == STARGET_CREATED_REMOVE)
1535 if (starget->dev.parent == dev || &starget->dev == dev) {
1536 kref_get(&starget->reap_ref);
1537 if (starget->state == STARGET_CREATED)
1538 starget->state = STARGET_CREATED_REMOVE;
1540 starget->state = STARGET_REMOVE;
1541 spin_unlock_irqrestore(shost->host_lock, flags);
1542 __scsi_remove_target(starget);
1543 scsi_target_reap(starget);
1547 spin_unlock_irqrestore(shost->host_lock, flags);
1549 EXPORT_SYMBOL(scsi_remove_target);
1551 int scsi_register_driver(struct device_driver *drv)
1553 drv->bus = &scsi_bus_type;
1555 return driver_register(drv);
1557 EXPORT_SYMBOL(scsi_register_driver);
1559 int scsi_register_interface(struct class_interface *intf)
1561 intf->class = &sdev_class;
1563 return class_interface_register(intf);
1565 EXPORT_SYMBOL(scsi_register_interface);
1568 * scsi_sysfs_add_host - add scsi host to subsystem
1569 * @shost: scsi host struct to add to subsystem
1571 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1575 /* add host specific attributes */
1576 if (shost->hostt->shost_attrs) {
1577 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1578 error = device_create_file(&shost->shost_dev,
1579 shost->hostt->shost_attrs[i]);
1585 transport_register_device(&shost->shost_gendev);
1586 transport_configure_device(&shost->shost_gendev);
1590 static struct device_type scsi_dev_type = {
1591 .name = "scsi_device",
1592 .release = scsi_device_dev_release,
1593 .groups = scsi_sdev_attr_groups,
1596 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1598 unsigned long flags;
1599 struct Scsi_Host *shost = sdev->host;
1600 struct scsi_target *starget = sdev->sdev_target;
1602 device_initialize(&sdev->sdev_gendev);
1603 sdev->sdev_gendev.bus = &scsi_bus_type;
1604 sdev->sdev_gendev.type = &scsi_dev_type;
1605 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1606 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1608 device_initialize(&sdev->sdev_dev);
1609 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1610 sdev->sdev_dev.class = &sdev_class;
1611 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1612 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1614 * Get a default scsi_level from the target (derived from sibling
1615 * devices). This is the best we can do for guessing how to set
1616 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1617 * setting doesn't matter, because all the bits are zero anyway.
1618 * But it does matter for higher LUNs.
1620 sdev->scsi_level = starget->scsi_level;
1621 if (sdev->scsi_level <= SCSI_2 &&
1622 sdev->scsi_level != SCSI_UNKNOWN &&
1623 !shost->no_scsi2_lun_in_cdb)
1624 sdev->lun_in_cdb = 1;
1626 transport_setup_device(&sdev->sdev_gendev);
1627 spin_lock_irqsave(shost->host_lock, flags);
1628 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1629 list_add_tail(&sdev->siblings, &shost->__devices);
1630 spin_unlock_irqrestore(shost->host_lock, flags);
1632 * device can now only be removed via __scsi_remove_device() so hold
1633 * the target. Target will be held in CREATED state until something
1634 * beneath it becomes visible (in which case it moves to RUNNING)
1636 kref_get(&starget->reap_ref);
1639 int scsi_is_sdev_device(const struct device *dev)
1641 return dev->type == &scsi_dev_type;
1643 EXPORT_SYMBOL(scsi_is_sdev_device);
1645 /* A blank transport template that is used in drivers that don't
1646 * yet implement Transport Attributes */
1647 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };