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);
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_unchecked_isa_dma.attr,
415 &dev_attr_proc_name.attr,
417 &dev_attr_hstate.attr,
418 &dev_attr_supported_mode.attr,
419 &dev_attr_active_mode.attr,
420 &dev_attr_prot_capabilities.attr,
421 &dev_attr_prot_guard_type.attr,
422 &dev_attr_host_reset.attr,
423 &dev_attr_eh_deadline.attr,
424 &dev_attr_nr_hw_queues.attr,
428 static struct attribute_group scsi_shost_attr_group = {
429 .attrs = scsi_sysfs_shost_attrs,
432 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
433 &scsi_shost_attr_group,
437 static void scsi_device_cls_release(struct device *class_dev)
439 struct scsi_device *sdev;
441 sdev = class_to_sdev(class_dev);
442 put_device(&sdev->sdev_gendev);
445 static void scsi_device_dev_release_usercontext(struct work_struct *work)
447 struct scsi_device *sdev;
448 struct device *parent;
449 struct list_head *this, *tmp;
450 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
451 struct scsi_vpd *vpd_pg0 = NULL, *vpd_pg89 = NULL;
455 sdev = container_of(work, struct scsi_device, ew.work);
457 mod = sdev->host->hostt->module;
459 scsi_dh_release_device(sdev);
461 parent = sdev->sdev_gendev.parent;
463 spin_lock_irqsave(sdev->host->host_lock, flags);
464 list_del(&sdev->siblings);
465 list_del(&sdev->same_target_siblings);
466 list_del(&sdev->starved_entry);
467 spin_unlock_irqrestore(sdev->host->host_lock, flags);
469 cancel_work_sync(&sdev->event_work);
471 list_for_each_safe(this, tmp, &sdev->event_list) {
472 struct scsi_event *evt;
474 evt = list_entry(this, struct scsi_event, node);
475 list_del(&evt->node);
479 blk_put_queue(sdev->request_queue);
480 /* NULL queue means the device can't be used */
481 sdev->request_queue = NULL;
483 mutex_lock(&sdev->inquiry_mutex);
484 vpd_pg0 = rcu_replace_pointer(sdev->vpd_pg0, vpd_pg0,
485 lockdep_is_held(&sdev->inquiry_mutex));
486 vpd_pg80 = rcu_replace_pointer(sdev->vpd_pg80, vpd_pg80,
487 lockdep_is_held(&sdev->inquiry_mutex));
488 vpd_pg83 = rcu_replace_pointer(sdev->vpd_pg83, vpd_pg83,
489 lockdep_is_held(&sdev->inquiry_mutex));
490 vpd_pg89 = rcu_replace_pointer(sdev->vpd_pg89, vpd_pg89,
491 lockdep_is_held(&sdev->inquiry_mutex));
492 mutex_unlock(&sdev->inquiry_mutex);
495 kfree_rcu(vpd_pg0, rcu);
497 kfree_rcu(vpd_pg83, rcu);
499 kfree_rcu(vpd_pg80, rcu);
501 kfree_rcu(vpd_pg89, rcu);
502 kfree(sdev->inquiry);
510 static void scsi_device_dev_release(struct device *dev)
512 struct scsi_device *sdp = to_scsi_device(dev);
514 /* Set module pointer as NULL in case of module unloading */
515 if (!try_module_get(sdp->host->hostt->module))
516 sdp->host->hostt->module = NULL;
518 execute_in_process_context(scsi_device_dev_release_usercontext,
522 static struct class sdev_class = {
523 .name = "scsi_device",
524 .dev_release = scsi_device_cls_release,
527 /* all probing is done in the individual ->probe routines */
528 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
530 struct scsi_device *sdp;
532 if (dev->type != &scsi_dev_type)
535 sdp = to_scsi_device(dev);
536 if (sdp->no_uld_attach)
538 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
541 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
543 struct scsi_device *sdev;
545 if (dev->type != &scsi_dev_type)
548 sdev = to_scsi_device(dev);
550 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
554 struct bus_type scsi_bus_type = {
556 .match = scsi_bus_match,
557 .uevent = scsi_bus_uevent,
559 .pm = &scsi_bus_pm_ops,
562 EXPORT_SYMBOL_GPL(scsi_bus_type);
564 int scsi_sysfs_register(void)
568 error = bus_register(&scsi_bus_type);
570 error = class_register(&sdev_class);
572 bus_unregister(&scsi_bus_type);
578 void scsi_sysfs_unregister(void)
580 class_unregister(&sdev_class);
581 bus_unregister(&scsi_bus_type);
585 * sdev_show_function: macro to create an attr function that can be used to
586 * show a non-bit field.
588 #define sdev_show_function(field, format_string) \
590 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
593 struct scsi_device *sdev; \
594 sdev = to_scsi_device(dev); \
595 return snprintf (buf, 20, format_string, sdev->field); \
599 * sdev_rd_attr: macro to create a function and attribute variable for a
602 #define sdev_rd_attr(field, format_string) \
603 sdev_show_function(field, format_string) \
604 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
608 * sdev_rw_attr: create a function and attribute variable for a
611 #define sdev_rw_attr(field, format_string) \
612 sdev_show_function(field, format_string) \
615 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
616 const char *buf, size_t count) \
618 struct scsi_device *sdev; \
619 sdev = to_scsi_device(dev); \
620 sscanf (buf, format_string, &sdev->field); \
623 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
625 /* Currently we don't export bit fields, but we might in future,
626 * so leave this code in */
629 * sdev_rd_attr: create a function and attribute variable for a
630 * read/write bit field.
632 #define sdev_rw_attr_bit(field) \
633 sdev_show_function(field, "%d\n") \
636 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
637 const char *buf, size_t count) \
640 struct scsi_device *sdev; \
641 ret = scsi_sdev_check_buf_bit(buf); \
643 sdev = to_scsi_device(dev); \
649 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
652 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
653 * else return -EINVAL.
655 static int scsi_sdev_check_buf_bit(const char *buf)
657 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
660 else if (buf[0] == '0')
669 * Create the actual show/store functions and data structures.
671 sdev_rd_attr (type, "%d\n");
672 sdev_rd_attr (scsi_level, "%d\n");
673 sdev_rd_attr (vendor, "%.8s\n");
674 sdev_rd_attr (model, "%.16s\n");
675 sdev_rd_attr (rev, "%.4s\n");
678 sdev_show_device_busy(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_busy));
684 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
687 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
690 struct scsi_device *sdev = to_scsi_device(dev);
691 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
693 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
696 * TODO: can we make these symlinks to the block layer ones?
699 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
701 struct scsi_device *sdev;
702 sdev = to_scsi_device(dev);
703 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
707 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
708 const char *buf, size_t count)
710 struct scsi_device *sdev;
712 sdev = to_scsi_device(dev);
713 sscanf (buf, "%d\n", &timeout);
714 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
717 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
720 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
722 struct scsi_device *sdev;
723 sdev = to_scsi_device(dev);
724 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
728 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
729 const char *buf, size_t count)
731 struct scsi_device *sdev;
732 unsigned int eh_timeout;
735 if (!capable(CAP_SYS_ADMIN))
738 sdev = to_scsi_device(dev);
739 err = kstrtouint(buf, 10, &eh_timeout);
742 sdev->eh_timeout = eh_timeout * HZ;
746 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
749 store_rescan_field (struct device *dev, struct device_attribute *attr,
750 const char *buf, size_t count)
752 scsi_rescan_device(dev);
755 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
758 sdev_store_delete(struct device *dev, struct device_attribute *attr,
759 const char *buf, size_t count)
761 struct kernfs_node *kn;
762 struct scsi_device *sdev = to_scsi_device(dev);
765 * We need to try to get module, avoiding the module been removed
768 if (scsi_device_get(sdev))
771 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
774 * Concurrent writes into the "delete" sysfs attribute may trigger
775 * concurrent calls to device_remove_file() and scsi_remove_device().
776 * device_remove_file() handles concurrent removal calls by
777 * serializing these and by ignoring the second and later removal
778 * attempts. Concurrent calls of scsi_remove_device() are
779 * serialized. The second and later calls of scsi_remove_device() are
780 * ignored because the first call of that function changes the device
781 * state into SDEV_DEL.
783 device_remove_file(dev, attr);
784 scsi_remove_device(sdev);
786 sysfs_unbreak_active_protection(kn);
787 scsi_device_put(sdev);
790 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
793 store_state_field(struct device *dev, struct device_attribute *attr,
794 const char *buf, size_t count)
797 struct scsi_device *sdev = to_scsi_device(dev);
798 enum scsi_device_state state = 0;
799 bool rescan_dev = false;
801 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
802 const int len = strlen(sdev_states[i].name);
803 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
805 state = sdev_states[i].value;
817 mutex_lock(&sdev->state_mutex);
818 switch (sdev->sdev_state) {
823 mutex_unlock(&sdev->state_mutex);
826 if (sdev->sdev_state == SDEV_RUNNING && state == SDEV_RUNNING) {
829 ret = scsi_device_set_state(sdev, state);
830 if (ret == 0 && state == SDEV_RUNNING)
833 mutex_unlock(&sdev->state_mutex);
837 * If the device state changes to SDEV_RUNNING, we need to
838 * run the queue to avoid I/O hang, and rescan the device
839 * to revalidate it. Running the queue first is necessary
840 * because another thread may be waiting inside
841 * blk_mq_freeze_queue_wait() and because that call may be
842 * waiting for pending I/O to finish.
844 blk_mq_run_hw_queues(sdev->request_queue, true);
845 scsi_rescan_device(dev);
848 return ret == 0 ? count : -EINVAL;
852 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
854 struct scsi_device *sdev = to_scsi_device(dev);
855 const char *name = scsi_device_state_name(sdev->sdev_state);
860 return snprintf(buf, 20, "%s\n", name);
863 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
866 show_queue_type_field(struct device *dev, struct device_attribute *attr,
869 struct scsi_device *sdev = to_scsi_device(dev);
870 const char *name = "none";
872 if (sdev->simple_tags)
875 return snprintf(buf, 20, "%s\n", name);
879 store_queue_type_field(struct device *dev, struct device_attribute *attr,
880 const char *buf, size_t count)
882 struct scsi_device *sdev = to_scsi_device(dev);
884 if (!sdev->tagged_supported)
887 sdev_printk(KERN_INFO, sdev,
888 "ignoring write to deprecated queue_type attribute");
892 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
893 store_queue_type_field);
895 #define sdev_vpd_pg_attr(_page) \
897 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
898 struct bin_attribute *bin_attr, \
899 char *buf, loff_t off, size_t count) \
901 struct device *dev = kobj_to_dev(kobj); \
902 struct scsi_device *sdev = to_scsi_device(dev); \
903 struct scsi_vpd *vpd_page; \
907 vpd_page = rcu_dereference(sdev->vpd_##_page); \
909 ret = memory_read_from_buffer(buf, count, &off, \
910 vpd_page->data, vpd_page->len); \
914 static struct bin_attribute dev_attr_vpd_##_page = { \
915 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
917 .read = show_vpd_##_page, \
920 sdev_vpd_pg_attr(pg83);
921 sdev_vpd_pg_attr(pg80);
922 sdev_vpd_pg_attr(pg89);
923 sdev_vpd_pg_attr(pg0);
925 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
926 struct bin_attribute *bin_attr,
927 char *buf, loff_t off, size_t count)
929 struct device *dev = kobj_to_dev(kobj);
930 struct scsi_device *sdev = to_scsi_device(dev);
935 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
939 static struct bin_attribute dev_attr_inquiry = {
945 .read = show_inquiry,
949 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
952 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
955 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
957 #define show_sdev_iostat(field) \
959 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
962 struct scsi_device *sdev = to_scsi_device(dev); \
963 unsigned long long count = atomic_read(&sdev->field); \
964 return snprintf(buf, 20, "0x%llx\n", count); \
966 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
968 show_sdev_iostat(iorequest_cnt);
969 show_sdev_iostat(iodone_cnt);
970 show_sdev_iostat(ioerr_cnt);
973 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
975 struct scsi_device *sdev;
976 sdev = to_scsi_device(dev);
977 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
979 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
981 #define DECLARE_EVT_SHOW(name, Cap_name) \
983 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
986 struct scsi_device *sdev = to_scsi_device(dev); \
987 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
988 return snprintf(buf, 20, "%d\n", val); \
991 #define DECLARE_EVT_STORE(name, Cap_name) \
993 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
994 const char *buf, size_t count) \
996 struct scsi_device *sdev = to_scsi_device(dev); \
997 int val = simple_strtoul(buf, NULL, 0); \
999 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
1000 else if (val == 1) \
1001 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
1007 #define DECLARE_EVT(name, Cap_name) \
1008 DECLARE_EVT_SHOW(name, Cap_name) \
1009 DECLARE_EVT_STORE(name, Cap_name) \
1010 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
1011 sdev_store_evt_##name);
1012 #define REF_EVT(name) &dev_attr_evt_##name.attr
1014 DECLARE_EVT(media_change, MEDIA_CHANGE)
1015 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
1016 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
1017 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
1018 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
1019 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
1022 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
1023 const char *buf, size_t count)
1026 struct scsi_device *sdev = to_scsi_device(dev);
1027 struct scsi_host_template *sht = sdev->host->hostt;
1029 if (!sht->change_queue_depth)
1032 depth = simple_strtoul(buf, NULL, 0);
1034 if (depth < 1 || depth > sdev->host->can_queue)
1037 retval = sht->change_queue_depth(sdev, depth);
1041 sdev->max_queue_depth = sdev->queue_depth;
1045 sdev_show_function(queue_depth, "%d\n");
1047 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
1048 sdev_store_queue_depth);
1051 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
1054 struct scsi_device *sdev = to_scsi_device(dev);
1057 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
1064 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
1066 #define BLIST_FLAG_NAME(name) \
1067 [const_ilog2((__force __u64)BLIST_##name)] = #name
1068 static const char *const sdev_bflags_name[] = {
1069 #include "scsi_devinfo_tbl.c"
1071 #undef BLIST_FLAG_NAME
1074 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
1077 struct scsi_device *sdev = to_scsi_device(dev);
1081 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
1082 const char *name = NULL;
1084 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
1086 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
1087 name = sdev_bflags_name[i];
1090 len += scnprintf(buf + len, PAGE_SIZE - len,
1091 "%s%s", len ? " " : "", name);
1093 len += scnprintf(buf + len, PAGE_SIZE - len,
1094 "%sINVALID_BIT(%d)", len ? " " : "", i);
1097 len += scnprintf(buf + len, PAGE_SIZE - len, "\n");
1100 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1102 #ifdef CONFIG_SCSI_DH
1104 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1107 struct scsi_device *sdev = to_scsi_device(dev);
1110 return snprintf(buf, 20, "detached\n");
1112 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1116 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1117 const char *buf, size_t count)
1119 struct scsi_device *sdev = to_scsi_device(dev);
1122 if (sdev->sdev_state == SDEV_CANCEL ||
1123 sdev->sdev_state == SDEV_DEL)
1126 if (!sdev->handler) {
1128 * Attach to a device handler
1130 err = scsi_dh_attach(sdev->request_queue, buf);
1131 } else if (!strncmp(buf, "activate", 8)) {
1133 * Activate a device handler
1135 if (sdev->handler->activate)
1136 err = sdev->handler->activate(sdev, NULL, NULL);
1139 } else if (!strncmp(buf, "detach", 6)) {
1141 * Detach from a device handler
1143 sdev_printk(KERN_WARNING, sdev,
1144 "can't detach handler %s.\n",
1145 sdev->handler->name);
1149 return err < 0 ? err : count;
1152 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1153 sdev_store_dh_state);
1156 sdev_show_access_state(struct device *dev,
1157 struct device_attribute *attr,
1160 struct scsi_device *sdev = to_scsi_device(dev);
1161 unsigned char access_state;
1162 const char *access_state_name;
1167 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1168 access_state_name = scsi_access_state_name(access_state);
1170 return sprintf(buf, "%s\n",
1171 access_state_name ? access_state_name : "unknown");
1173 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1176 sdev_show_preferred_path(struct device *dev,
1177 struct device_attribute *attr,
1180 struct scsi_device *sdev = to_scsi_device(dev);
1185 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1186 return sprintf(buf, "1\n");
1188 return sprintf(buf, "0\n");
1190 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1194 sdev_show_queue_ramp_up_period(struct device *dev,
1195 struct device_attribute *attr,
1198 struct scsi_device *sdev;
1199 sdev = to_scsi_device(dev);
1200 return snprintf(buf, 20, "%u\n",
1201 jiffies_to_msecs(sdev->queue_ramp_up_period));
1205 sdev_store_queue_ramp_up_period(struct device *dev,
1206 struct device_attribute *attr,
1207 const char *buf, size_t count)
1209 struct scsi_device *sdev = to_scsi_device(dev);
1210 unsigned int period;
1212 if (kstrtouint(buf, 10, &period))
1215 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1219 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1220 sdev_show_queue_ramp_up_period,
1221 sdev_store_queue_ramp_up_period);
1223 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1224 struct attribute *attr, int i)
1226 struct device *dev = kobj_to_dev(kobj);
1227 struct scsi_device *sdev = to_scsi_device(dev);
1230 if (attr == &dev_attr_queue_depth.attr &&
1231 !sdev->host->hostt->change_queue_depth)
1234 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1235 !sdev->host->hostt->change_queue_depth)
1238 #ifdef CONFIG_SCSI_DH
1239 if (attr == &dev_attr_access_state.attr &&
1242 if (attr == &dev_attr_preferred_path.attr &&
1249 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1250 struct bin_attribute *attr, int i)
1252 struct device *dev = kobj_to_dev(kobj);
1253 struct scsi_device *sdev = to_scsi_device(dev);
1256 if (attr == &dev_attr_vpd_pg0 && !sdev->vpd_pg0)
1259 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1262 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1265 if (attr == &dev_attr_vpd_pg89 && !sdev->vpd_pg89)
1271 /* Default template for device attributes. May NOT be modified */
1272 static struct attribute *scsi_sdev_attrs[] = {
1273 &dev_attr_device_blocked.attr,
1274 &dev_attr_type.attr,
1275 &dev_attr_scsi_level.attr,
1276 &dev_attr_device_busy.attr,
1277 &dev_attr_vendor.attr,
1278 &dev_attr_model.attr,
1280 &dev_attr_rescan.attr,
1281 &dev_attr_delete.attr,
1282 &dev_attr_state.attr,
1283 &dev_attr_timeout.attr,
1284 &dev_attr_eh_timeout.attr,
1285 &dev_attr_iocounterbits.attr,
1286 &dev_attr_iorequest_cnt.attr,
1287 &dev_attr_iodone_cnt.attr,
1288 &dev_attr_ioerr_cnt.attr,
1289 &dev_attr_modalias.attr,
1290 &dev_attr_queue_depth.attr,
1291 &dev_attr_queue_type.attr,
1292 &dev_attr_wwid.attr,
1293 &dev_attr_blacklist.attr,
1294 #ifdef CONFIG_SCSI_DH
1295 &dev_attr_dh_state.attr,
1296 &dev_attr_access_state.attr,
1297 &dev_attr_preferred_path.attr,
1299 &dev_attr_queue_ramp_up_period.attr,
1300 REF_EVT(media_change),
1301 REF_EVT(inquiry_change_reported),
1302 REF_EVT(capacity_change_reported),
1303 REF_EVT(soft_threshold_reached),
1304 REF_EVT(mode_parameter_change_reported),
1305 REF_EVT(lun_change_reported),
1309 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1317 static struct attribute_group scsi_sdev_attr_group = {
1318 .attrs = scsi_sdev_attrs,
1319 .bin_attrs = scsi_sdev_bin_attrs,
1320 .is_visible = scsi_sdev_attr_is_visible,
1321 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1324 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1325 &scsi_sdev_attr_group,
1329 static int scsi_target_add(struct scsi_target *starget)
1333 if (starget->state != STARGET_CREATED)
1336 error = device_add(&starget->dev);
1338 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1341 transport_add_device(&starget->dev);
1342 starget->state = STARGET_RUNNING;
1344 pm_runtime_set_active(&starget->dev);
1345 pm_runtime_enable(&starget->dev);
1346 device_enable_async_suspend(&starget->dev);
1352 * scsi_sysfs_add_sdev - add scsi device to sysfs
1353 * @sdev: scsi_device to add
1356 * 0 on Success / non-zero on Failure
1358 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1361 struct request_queue *rq = sdev->request_queue;
1362 struct scsi_target *starget = sdev->sdev_target;
1364 error = scsi_target_add(starget);
1368 transport_configure_device(&starget->dev);
1370 device_enable_async_suspend(&sdev->sdev_gendev);
1371 scsi_autopm_get_target(starget);
1372 pm_runtime_set_active(&sdev->sdev_gendev);
1373 if (!sdev->rpm_autosuspend)
1374 pm_runtime_forbid(&sdev->sdev_gendev);
1375 pm_runtime_enable(&sdev->sdev_gendev);
1376 scsi_autopm_put_target(starget);
1378 scsi_autopm_get_device(sdev);
1380 scsi_dh_add_device(sdev);
1382 error = device_add(&sdev->sdev_gendev);
1384 sdev_printk(KERN_INFO, sdev,
1385 "failed to add device: %d\n", error);
1389 device_enable_async_suspend(&sdev->sdev_dev);
1390 error = device_add(&sdev->sdev_dev);
1392 sdev_printk(KERN_INFO, sdev,
1393 "failed to add class device: %d\n", error);
1394 device_del(&sdev->sdev_gendev);
1397 transport_add_device(&sdev->sdev_gendev);
1398 sdev->is_visible = 1;
1400 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1402 /* we're treating error on bsg register as non-fatal,
1403 * so pretend nothing went wrong */
1404 sdev_printk(KERN_INFO, sdev,
1405 "Failed to register bsg queue, errno=%d\n", error);
1407 /* add additional host specific attributes */
1408 if (sdev->host->hostt->sdev_attrs) {
1409 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1410 error = device_create_file(&sdev->sdev_gendev,
1411 sdev->host->hostt->sdev_attrs[i]);
1417 if (sdev->host->hostt->sdev_groups) {
1418 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1419 sdev->host->hostt->sdev_groups);
1424 scsi_autopm_put_device(sdev);
1428 void __scsi_remove_device(struct scsi_device *sdev)
1430 struct device *dev = &sdev->sdev_gendev;
1434 * This cleanup path is not reentrant and while it is impossible
1435 * to get a new reference with scsi_device_get() someone can still
1436 * hold a previously acquired one.
1438 if (sdev->sdev_state == SDEV_DEL)
1441 if (sdev->is_visible) {
1443 * If scsi_internal_target_block() is running concurrently,
1444 * wait until it has finished before changing the device state.
1446 mutex_lock(&sdev->state_mutex);
1448 * If blocked, we go straight to DEL and restart the queue so
1449 * any commands issued during driver shutdown (like sync
1450 * cache) are errored immediately.
1452 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1454 res = scsi_device_set_state(sdev, SDEV_DEL);
1456 scsi_start_queue(sdev);
1458 mutex_unlock(&sdev->state_mutex);
1463 if (sdev->host->hostt->sdev_groups)
1464 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1465 sdev->host->hostt->sdev_groups);
1467 bsg_unregister_queue(sdev->request_queue);
1468 device_unregister(&sdev->sdev_dev);
1469 transport_remove_device(dev);
1472 put_device(&sdev->sdev_dev);
1475 * Stop accepting new requests and wait until all queuecommand() and
1476 * scsi_run_queue() invocations have finished before tearing down the
1479 mutex_lock(&sdev->state_mutex);
1480 scsi_device_set_state(sdev, SDEV_DEL);
1481 mutex_unlock(&sdev->state_mutex);
1483 blk_cleanup_queue(sdev->request_queue);
1484 cancel_work_sync(&sdev->requeue_work);
1486 if (sdev->host->hostt->slave_destroy)
1487 sdev->host->hostt->slave_destroy(sdev);
1488 transport_destroy_device(dev);
1491 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1492 * remoed sysfs visibility from the device, so make the target
1493 * invisible if this was the last device underneath it.
1495 scsi_target_reap(scsi_target(sdev));
1501 * scsi_remove_device - unregister a device from the scsi bus
1502 * @sdev: scsi_device to unregister
1504 void scsi_remove_device(struct scsi_device *sdev)
1506 struct Scsi_Host *shost = sdev->host;
1508 mutex_lock(&shost->scan_mutex);
1509 __scsi_remove_device(sdev);
1510 mutex_unlock(&shost->scan_mutex);
1512 EXPORT_SYMBOL(scsi_remove_device);
1514 static void __scsi_remove_target(struct scsi_target *starget)
1516 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1517 unsigned long flags;
1518 struct scsi_device *sdev;
1520 spin_lock_irqsave(shost->host_lock, flags);
1522 list_for_each_entry(sdev, &shost->__devices, siblings) {
1524 * We cannot call scsi_device_get() here, as
1525 * we might've been called from rmmod() causing
1526 * scsi_device_get() to fail the module_is_live()
1529 if (sdev->channel != starget->channel ||
1530 sdev->id != starget->id)
1532 if (sdev->sdev_state == SDEV_DEL ||
1533 sdev->sdev_state == SDEV_CANCEL ||
1534 !get_device(&sdev->sdev_gendev))
1536 spin_unlock_irqrestore(shost->host_lock, flags);
1537 scsi_remove_device(sdev);
1538 put_device(&sdev->sdev_gendev);
1539 spin_lock_irqsave(shost->host_lock, flags);
1542 spin_unlock_irqrestore(shost->host_lock, flags);
1546 * scsi_remove_target - try to remove a target and all its devices
1547 * @dev: generic starget or parent of generic stargets to be removed
1549 * Note: This is slightly racy. It is possible that if the user
1550 * requests the addition of another device then the target won't be
1553 void scsi_remove_target(struct device *dev)
1555 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1556 struct scsi_target *starget;
1557 unsigned long flags;
1560 spin_lock_irqsave(shost->host_lock, flags);
1561 list_for_each_entry(starget, &shost->__targets, siblings) {
1562 if (starget->state == STARGET_DEL ||
1563 starget->state == STARGET_REMOVE ||
1564 starget->state == STARGET_CREATED_REMOVE)
1566 if (starget->dev.parent == dev || &starget->dev == dev) {
1567 kref_get(&starget->reap_ref);
1568 if (starget->state == STARGET_CREATED)
1569 starget->state = STARGET_CREATED_REMOVE;
1571 starget->state = STARGET_REMOVE;
1572 spin_unlock_irqrestore(shost->host_lock, flags);
1573 __scsi_remove_target(starget);
1574 scsi_target_reap(starget);
1578 spin_unlock_irqrestore(shost->host_lock, flags);
1580 EXPORT_SYMBOL(scsi_remove_target);
1582 int scsi_register_driver(struct device_driver *drv)
1584 drv->bus = &scsi_bus_type;
1586 return driver_register(drv);
1588 EXPORT_SYMBOL(scsi_register_driver);
1590 int scsi_register_interface(struct class_interface *intf)
1592 intf->class = &sdev_class;
1594 return class_interface_register(intf);
1596 EXPORT_SYMBOL(scsi_register_interface);
1599 * scsi_sysfs_add_host - add scsi host to subsystem
1600 * @shost: scsi host struct to add to subsystem
1602 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1606 /* add host specific attributes */
1607 if (shost->hostt->shost_attrs) {
1608 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1609 error = device_create_file(&shost->shost_dev,
1610 shost->hostt->shost_attrs[i]);
1616 transport_register_device(&shost->shost_gendev);
1617 transport_configure_device(&shost->shost_gendev);
1621 static struct device_type scsi_dev_type = {
1622 .name = "scsi_device",
1623 .release = scsi_device_dev_release,
1624 .groups = scsi_sdev_attr_groups,
1627 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1629 unsigned long flags;
1630 struct Scsi_Host *shost = sdev->host;
1631 struct scsi_target *starget = sdev->sdev_target;
1633 device_initialize(&sdev->sdev_gendev);
1634 sdev->sdev_gendev.bus = &scsi_bus_type;
1635 sdev->sdev_gendev.type = &scsi_dev_type;
1636 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1637 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1639 device_initialize(&sdev->sdev_dev);
1640 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1641 sdev->sdev_dev.class = &sdev_class;
1642 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1643 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1645 * Get a default scsi_level from the target (derived from sibling
1646 * devices). This is the best we can do for guessing how to set
1647 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1648 * setting doesn't matter, because all the bits are zero anyway.
1649 * But it does matter for higher LUNs.
1651 sdev->scsi_level = starget->scsi_level;
1652 if (sdev->scsi_level <= SCSI_2 &&
1653 sdev->scsi_level != SCSI_UNKNOWN &&
1654 !shost->no_scsi2_lun_in_cdb)
1655 sdev->lun_in_cdb = 1;
1657 transport_setup_device(&sdev->sdev_gendev);
1658 spin_lock_irqsave(shost->host_lock, flags);
1659 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1660 list_add_tail(&sdev->siblings, &shost->__devices);
1661 spin_unlock_irqrestore(shost->host_lock, flags);
1663 * device can now only be removed via __scsi_remove_device() so hold
1664 * the target. Target will be held in CREATED state until something
1665 * beneath it becomes visible (in which case it moves to RUNNING)
1667 kref_get(&starget->reap_ref);
1670 int scsi_is_sdev_device(const struct device *dev)
1672 return dev->type == &scsi_dev_type;
1674 EXPORT_SYMBOL(scsi_is_sdev_device);
1676 /* A blank transport template that is used in drivers that don't
1677 * yet implement Transport Attributes */
1678 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };