4 * SCSI sysfs interface routines.
6 * Created to pull SCSI mid layer sysfs routines into one file.
9 #include <linux/module.h>
10 #include <linux/slab.h>
11 #include <linux/init.h>
12 #include <linux/blkdev.h>
13 #include <linux/device.h>
14 #include <linux/pm_runtime.h>
16 #include <scsi/scsi.h>
17 #include <scsi/scsi_device.h>
18 #include <scsi/scsi_host.h>
19 #include <scsi/scsi_tcq.h>
20 #include <scsi/scsi_dh.h>
21 #include <scsi/scsi_transport.h>
22 #include <scsi/scsi_driver.h>
23 #include <scsi/scsi_devinfo.h>
25 #include "scsi_priv.h"
26 #include "scsi_logging.h"
28 static struct device_type scsi_dev_type;
31 enum scsi_device_state value;
34 { SDEV_CREATED, "created" },
35 { SDEV_RUNNING, "running" },
36 { SDEV_CANCEL, "cancel" },
37 { SDEV_DEL, "deleted" },
38 { SDEV_QUIESCE, "quiesce" },
39 { SDEV_OFFLINE, "offline" },
40 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
41 { SDEV_BLOCK, "blocked" },
42 { SDEV_CREATED_BLOCK, "created-blocked" },
45 const char *scsi_device_state_name(enum scsi_device_state state)
50 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
51 if (sdev_states[i].value == state) {
52 name = sdev_states[i].name;
60 enum scsi_host_state value;
63 { SHOST_CREATED, "created" },
64 { SHOST_RUNNING, "running" },
65 { SHOST_CANCEL, "cancel" },
66 { SHOST_DEL, "deleted" },
67 { SHOST_RECOVERY, "recovery" },
68 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
69 { SHOST_DEL_RECOVERY, "deleted/recovery", },
71 const char *scsi_host_state_name(enum scsi_host_state state)
76 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
77 if (shost_states[i].value == state) {
78 name = shost_states[i].name;
89 } sdev_access_states[] = {
90 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
91 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
92 { SCSI_ACCESS_STATE_STANDBY, "standby" },
93 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
94 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
95 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
96 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
99 static const char *scsi_access_state_name(unsigned char state)
104 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
105 if (sdev_access_states[i].value == state) {
106 name = sdev_access_states[i].name;
114 static int check_set(unsigned long long *val, char *src)
118 if (strcmp(src, "-") == 0) {
119 *val = SCAN_WILD_CARD;
122 * Doesn't check for int overflow
124 *val = simple_strtoull(src, &last, 0);
131 static int scsi_scan(struct Scsi_Host *shost, const char *str)
133 char s1[15], s2[15], s3[17], junk;
134 unsigned long long channel, id, lun;
137 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
140 if (check_set(&channel, s1))
142 if (check_set(&id, s2))
144 if (check_set(&lun, s3))
146 if (shost->transportt->user_scan)
147 res = shost->transportt->user_scan(shost, channel, id, lun);
149 res = scsi_scan_host_selected(shost, channel, id, lun,
155 * shost_show_function: macro to create an attr function that can be used to
156 * show a non-bit field.
158 #define shost_show_function(name, field, format_string) \
160 show_##name (struct device *dev, struct device_attribute *attr, \
163 struct Scsi_Host *shost = class_to_shost(dev); \
164 return snprintf (buf, 20, format_string, shost->field); \
168 * shost_rd_attr: macro to create a function and attribute variable for a
171 #define shost_rd_attr2(name, field, format_string) \
172 shost_show_function(name, field, format_string) \
173 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
175 #define shost_rd_attr(field, format_string) \
176 shost_rd_attr2(field, field, format_string)
179 * Create the actual show/store functions and data structures.
183 store_scan(struct device *dev, struct device_attribute *attr,
184 const char *buf, size_t count)
186 struct Scsi_Host *shost = class_to_shost(dev);
189 res = scsi_scan(shost, buf);
194 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
197 store_shost_state(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t count)
201 struct Scsi_Host *shost = class_to_shost(dev);
202 enum scsi_host_state state = 0;
204 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
205 const int len = strlen(shost_states[i].name);
206 if (strncmp(shost_states[i].name, buf, len) == 0 &&
208 state = shost_states[i].value;
215 if (scsi_host_set_state(shost, state))
221 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
223 struct Scsi_Host *shost = class_to_shost(dev);
224 const char *name = scsi_host_state_name(shost->shost_state);
229 return snprintf(buf, 20, "%s\n", name);
232 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
233 static struct device_attribute dev_attr_hstate =
234 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
237 show_shost_mode(unsigned int mode, char *buf)
241 if (mode & MODE_INITIATOR)
242 len = sprintf(buf, "%s", "Initiator");
244 if (mode & MODE_TARGET)
245 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
247 len += sprintf(buf + len, "\n");
253 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
256 struct Scsi_Host *shost = class_to_shost(dev);
257 unsigned int supported_mode = shost->hostt->supported_mode;
259 if (supported_mode == MODE_UNKNOWN)
260 /* by default this should be initiator */
261 supported_mode = MODE_INITIATOR;
263 return show_shost_mode(supported_mode, buf);
266 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
269 show_shost_active_mode(struct device *dev,
270 struct device_attribute *attr, char *buf)
272 struct Scsi_Host *shost = class_to_shost(dev);
274 if (shost->active_mode == MODE_UNKNOWN)
275 return snprintf(buf, 20, "unknown\n");
277 return show_shost_mode(shost->active_mode, buf);
280 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
282 static int check_reset_type(const char *str)
284 if (sysfs_streq(str, "adapter"))
285 return SCSI_ADAPTER_RESET;
286 else if (sysfs_streq(str, "firmware"))
287 return SCSI_FIRMWARE_RESET;
293 store_host_reset(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
296 struct Scsi_Host *shost = class_to_shost(dev);
297 struct scsi_host_template *sht = shost->hostt;
301 type = check_reset_type(buf);
303 goto exit_store_host_reset;
306 ret = sht->host_reset(shost, type);
310 exit_store_host_reset:
316 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
319 show_shost_eh_deadline(struct device *dev,
320 struct device_attribute *attr, char *buf)
322 struct Scsi_Host *shost = class_to_shost(dev);
324 if (shost->eh_deadline == -1)
325 return snprintf(buf, strlen("off") + 2, "off\n");
326 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
330 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
331 const char *buf, size_t count)
333 struct Scsi_Host *shost = class_to_shost(dev);
335 unsigned long deadline, flags;
337 if (shost->transportt &&
338 (shost->transportt->eh_strategy_handler ||
339 !shost->hostt->eh_host_reset_handler))
342 if (!strncmp(buf, "off", strlen("off")))
345 ret = kstrtoul(buf, 10, &deadline);
348 if (deadline * HZ > UINT_MAX)
352 spin_lock_irqsave(shost->host_lock, flags);
353 if (scsi_host_in_recovery(shost))
357 shost->eh_deadline = -1;
359 shost->eh_deadline = deadline * HZ;
363 spin_unlock_irqrestore(shost->host_lock, flags);
368 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
370 shost_rd_attr(use_blk_mq, "%d\n");
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);
389 static struct attribute *scsi_sysfs_shost_attrs[] = {
390 &dev_attr_use_blk_mq.attr,
391 &dev_attr_unique_id.attr,
392 &dev_attr_host_busy.attr,
393 &dev_attr_cmd_per_lun.attr,
394 &dev_attr_can_queue.attr,
395 &dev_attr_sg_tablesize.attr,
396 &dev_attr_sg_prot_tablesize.attr,
397 &dev_attr_unchecked_isa_dma.attr,
398 &dev_attr_proc_name.attr,
400 &dev_attr_hstate.attr,
401 &dev_attr_supported_mode.attr,
402 &dev_attr_active_mode.attr,
403 &dev_attr_prot_capabilities.attr,
404 &dev_attr_prot_guard_type.attr,
405 &dev_attr_host_reset.attr,
406 &dev_attr_eh_deadline.attr,
410 static struct attribute_group scsi_shost_attr_group = {
411 .attrs = scsi_sysfs_shost_attrs,
414 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
415 &scsi_shost_attr_group,
419 static void scsi_device_cls_release(struct device *class_dev)
421 struct scsi_device *sdev;
423 sdev = class_to_sdev(class_dev);
424 put_device(&sdev->sdev_gendev);
427 static void scsi_device_dev_release_usercontext(struct work_struct *work)
429 struct scsi_device *sdev;
430 struct device *parent;
431 struct list_head *this, *tmp;
432 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
435 sdev = container_of(work, struct scsi_device, ew.work);
437 scsi_dh_release_device(sdev);
439 parent = sdev->sdev_gendev.parent;
441 spin_lock_irqsave(sdev->host->host_lock, flags);
442 list_del(&sdev->siblings);
443 list_del(&sdev->same_target_siblings);
444 list_del(&sdev->starved_entry);
445 spin_unlock_irqrestore(sdev->host->host_lock, flags);
447 cancel_work_sync(&sdev->event_work);
449 list_for_each_safe(this, tmp, &sdev->event_list) {
450 struct scsi_event *evt;
452 evt = list_entry(this, struct scsi_event, node);
453 list_del(&evt->node);
457 blk_put_queue(sdev->request_queue);
458 /* NULL queue means the device can't be used */
459 sdev->request_queue = NULL;
461 mutex_lock(&sdev->inquiry_mutex);
462 rcu_swap_protected(sdev->vpd_pg80, vpd_pg80,
463 lockdep_is_held(&sdev->inquiry_mutex));
464 rcu_swap_protected(sdev->vpd_pg83, vpd_pg83,
465 lockdep_is_held(&sdev->inquiry_mutex));
466 mutex_unlock(&sdev->inquiry_mutex);
469 kfree_rcu(vpd_pg83, rcu);
471 kfree_rcu(vpd_pg80, rcu);
472 kfree(sdev->inquiry);
479 static void scsi_device_dev_release(struct device *dev)
481 struct scsi_device *sdp = to_scsi_device(dev);
482 execute_in_process_context(scsi_device_dev_release_usercontext,
486 static struct class sdev_class = {
487 .name = "scsi_device",
488 .dev_release = scsi_device_cls_release,
491 /* all probing is done in the individual ->probe routines */
492 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
494 struct scsi_device *sdp;
496 if (dev->type != &scsi_dev_type)
499 sdp = to_scsi_device(dev);
500 if (sdp->no_uld_attach)
502 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
505 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
507 struct scsi_device *sdev;
509 if (dev->type != &scsi_dev_type)
512 sdev = to_scsi_device(dev);
514 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
518 struct bus_type scsi_bus_type = {
520 .match = scsi_bus_match,
521 .uevent = scsi_bus_uevent,
523 .pm = &scsi_bus_pm_ops,
526 EXPORT_SYMBOL_GPL(scsi_bus_type);
528 int scsi_sysfs_register(void)
532 error = bus_register(&scsi_bus_type);
534 error = class_register(&sdev_class);
536 bus_unregister(&scsi_bus_type);
542 void scsi_sysfs_unregister(void)
544 class_unregister(&sdev_class);
545 bus_unregister(&scsi_bus_type);
549 * sdev_show_function: macro to create an attr function that can be used to
550 * show a non-bit field.
552 #define sdev_show_function(field, format_string) \
554 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
557 struct scsi_device *sdev; \
558 sdev = to_scsi_device(dev); \
559 return snprintf (buf, 20, format_string, sdev->field); \
563 * sdev_rd_attr: macro to create a function and attribute variable for a
566 #define sdev_rd_attr(field, format_string) \
567 sdev_show_function(field, format_string) \
568 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
572 * sdev_rw_attr: create a function and attribute variable for a
575 #define sdev_rw_attr(field, format_string) \
576 sdev_show_function(field, format_string) \
579 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
580 const char *buf, size_t count) \
582 struct scsi_device *sdev; \
583 sdev = to_scsi_device(dev); \
584 sscanf (buf, format_string, &sdev->field); \
587 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
589 /* Currently we don't export bit fields, but we might in future,
590 * so leave this code in */
593 * sdev_rd_attr: create a function and attribute variable for a
594 * read/write bit field.
596 #define sdev_rw_attr_bit(field) \
597 sdev_show_function(field, "%d\n") \
600 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
601 const char *buf, size_t count) \
604 struct scsi_device *sdev; \
605 ret = scsi_sdev_check_buf_bit(buf); \
607 sdev = to_scsi_device(dev); \
613 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
616 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
617 * else return -EINVAL.
619 static int scsi_sdev_check_buf_bit(const char *buf)
621 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
624 else if (buf[0] == '0')
633 * Create the actual show/store functions and data structures.
635 sdev_rd_attr (type, "%d\n");
636 sdev_rd_attr (scsi_level, "%d\n");
637 sdev_rd_attr (vendor, "%.8s\n");
638 sdev_rd_attr (model, "%.16s\n");
639 sdev_rd_attr (rev, "%.4s\n");
642 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
645 struct scsi_device *sdev = to_scsi_device(dev);
646 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
648 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
651 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
654 struct scsi_device *sdev = to_scsi_device(dev);
655 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
657 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
660 * TODO: can we make these symlinks to the block layer ones?
663 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
665 struct scsi_device *sdev;
666 sdev = to_scsi_device(dev);
667 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
671 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
672 const char *buf, size_t count)
674 struct scsi_device *sdev;
676 sdev = to_scsi_device(dev);
677 sscanf (buf, "%d\n", &timeout);
678 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
681 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
684 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
686 struct scsi_device *sdev;
687 sdev = to_scsi_device(dev);
688 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
692 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
693 const char *buf, size_t count)
695 struct scsi_device *sdev;
696 unsigned int eh_timeout;
699 if (!capable(CAP_SYS_ADMIN))
702 sdev = to_scsi_device(dev);
703 err = kstrtouint(buf, 10, &eh_timeout);
706 sdev->eh_timeout = eh_timeout * HZ;
710 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
713 store_rescan_field (struct device *dev, struct device_attribute *attr,
714 const char *buf, size_t count)
716 scsi_rescan_device(dev);
719 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
722 sdev_store_delete(struct device *dev, struct device_attribute *attr,
723 const char *buf, size_t count)
725 if (device_remove_file_self(dev, attr))
726 scsi_remove_device(to_scsi_device(dev));
729 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
732 store_state_field(struct device *dev, struct device_attribute *attr,
733 const char *buf, size_t count)
736 struct scsi_device *sdev = to_scsi_device(dev);
737 enum scsi_device_state state = 0;
739 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
740 const int len = strlen(sdev_states[i].name);
741 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
743 state = sdev_states[i].value;
750 mutex_lock(&sdev->state_mutex);
751 ret = scsi_device_set_state(sdev, state);
752 mutex_unlock(&sdev->state_mutex);
754 return ret == 0 ? count : -EINVAL;
758 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
760 struct scsi_device *sdev = to_scsi_device(dev);
761 const char *name = scsi_device_state_name(sdev->sdev_state);
766 return snprintf(buf, 20, "%s\n", name);
769 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
772 show_queue_type_field(struct device *dev, struct device_attribute *attr,
775 struct scsi_device *sdev = to_scsi_device(dev);
776 const char *name = "none";
778 if (sdev->simple_tags)
781 return snprintf(buf, 20, "%s\n", name);
785 store_queue_type_field(struct device *dev, struct device_attribute *attr,
786 const char *buf, size_t count)
788 struct scsi_device *sdev = to_scsi_device(dev);
790 if (!sdev->tagged_supported)
793 sdev_printk(KERN_INFO, sdev,
794 "ignoring write to deprecated queue_type attribute");
798 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
799 store_queue_type_field);
801 #define sdev_vpd_pg_attr(_page) \
803 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
804 struct bin_attribute *bin_attr, \
805 char *buf, loff_t off, size_t count) \
807 struct device *dev = container_of(kobj, struct device, kobj); \
808 struct scsi_device *sdev = to_scsi_device(dev); \
809 struct scsi_vpd *vpd_page; \
813 vpd_page = rcu_dereference(sdev->vpd_##_page); \
815 ret = memory_read_from_buffer(buf, count, &off, \
816 vpd_page->data, vpd_page->len); \
820 static struct bin_attribute dev_attr_vpd_##_page = { \
821 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
823 .read = show_vpd_##_page, \
826 sdev_vpd_pg_attr(pg83);
827 sdev_vpd_pg_attr(pg80);
829 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
830 struct bin_attribute *bin_attr,
831 char *buf, loff_t off, size_t count)
833 struct device *dev = container_of(kobj, struct device, kobj);
834 struct scsi_device *sdev = to_scsi_device(dev);
839 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
843 static struct bin_attribute dev_attr_inquiry = {
849 .read = show_inquiry,
853 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
856 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
859 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
861 #define show_sdev_iostat(field) \
863 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
866 struct scsi_device *sdev = to_scsi_device(dev); \
867 unsigned long long count = atomic_read(&sdev->field); \
868 return snprintf(buf, 20, "0x%llx\n", count); \
870 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
872 show_sdev_iostat(iorequest_cnt);
873 show_sdev_iostat(iodone_cnt);
874 show_sdev_iostat(ioerr_cnt);
877 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
879 struct scsi_device *sdev;
880 sdev = to_scsi_device(dev);
881 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
883 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
885 #define DECLARE_EVT_SHOW(name, Cap_name) \
887 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
890 struct scsi_device *sdev = to_scsi_device(dev); \
891 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
892 return snprintf(buf, 20, "%d\n", val); \
895 #define DECLARE_EVT_STORE(name, Cap_name) \
897 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
898 const char *buf, size_t count) \
900 struct scsi_device *sdev = to_scsi_device(dev); \
901 int val = simple_strtoul(buf, NULL, 0); \
903 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
905 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
911 #define DECLARE_EVT(name, Cap_name) \
912 DECLARE_EVT_SHOW(name, Cap_name) \
913 DECLARE_EVT_STORE(name, Cap_name) \
914 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
915 sdev_store_evt_##name);
916 #define REF_EVT(name) &dev_attr_evt_##name.attr
918 DECLARE_EVT(media_change, MEDIA_CHANGE)
919 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
920 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
921 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
922 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
923 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
926 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
927 const char *buf, size_t count)
930 struct scsi_device *sdev = to_scsi_device(dev);
931 struct scsi_host_template *sht = sdev->host->hostt;
933 if (!sht->change_queue_depth)
936 depth = simple_strtoul(buf, NULL, 0);
938 if (depth < 1 || depth > sdev->host->can_queue)
941 retval = sht->change_queue_depth(sdev, depth);
945 sdev->max_queue_depth = sdev->queue_depth;
949 sdev_show_function(queue_depth, "%d\n");
951 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
952 sdev_store_queue_depth);
955 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
958 struct scsi_device *sdev = to_scsi_device(dev);
961 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
968 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
970 #define BLIST_FLAG_NAME(name) \
971 [const_ilog2((__force __u64)BLIST_##name)] = #name
972 static const char *const sdev_bflags_name[] = {
973 #include "scsi_devinfo_tbl.c"
975 #undef BLIST_FLAG_NAME
978 sdev_show_blacklist(struct device *dev, struct device_attribute *attr,
981 struct scsi_device *sdev = to_scsi_device(dev);
985 for (i = 0; i < sizeof(sdev->sdev_bflags) * BITS_PER_BYTE; i++) {
986 const char *name = NULL;
988 if (!(sdev->sdev_bflags & (__force blist_flags_t)BIT(i)))
990 if (i < ARRAY_SIZE(sdev_bflags_name) && sdev_bflags_name[i])
991 name = sdev_bflags_name[i];
994 len += snprintf(buf + len, PAGE_SIZE - len,
995 "%s%s", len ? " " : "", name);
997 len += snprintf(buf + len, PAGE_SIZE - len,
998 "%sINVALID_BIT(%d)", len ? " " : "", i);
1001 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
1004 static DEVICE_ATTR(blacklist, S_IRUGO, sdev_show_blacklist, NULL);
1006 #ifdef CONFIG_SCSI_DH
1008 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
1011 struct scsi_device *sdev = to_scsi_device(dev);
1014 return snprintf(buf, 20, "detached\n");
1016 return snprintf(buf, 20, "%s\n", sdev->handler->name);
1020 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
1021 const char *buf, size_t count)
1023 struct scsi_device *sdev = to_scsi_device(dev);
1026 if (sdev->sdev_state == SDEV_CANCEL ||
1027 sdev->sdev_state == SDEV_DEL)
1030 if (!sdev->handler) {
1032 * Attach to a device handler
1034 err = scsi_dh_attach(sdev->request_queue, buf);
1035 } else if (!strncmp(buf, "activate", 8)) {
1037 * Activate a device handler
1039 if (sdev->handler->activate)
1040 err = sdev->handler->activate(sdev, NULL, NULL);
1043 } else if (!strncmp(buf, "detach", 6)) {
1045 * Detach from a device handler
1047 sdev_printk(KERN_WARNING, sdev,
1048 "can't detach handler %s.\n",
1049 sdev->handler->name);
1053 return err < 0 ? err : count;
1056 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1057 sdev_store_dh_state);
1060 sdev_show_access_state(struct device *dev,
1061 struct device_attribute *attr,
1064 struct scsi_device *sdev = to_scsi_device(dev);
1065 unsigned char access_state;
1066 const char *access_state_name;
1071 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1072 access_state_name = scsi_access_state_name(access_state);
1074 return sprintf(buf, "%s\n",
1075 access_state_name ? access_state_name : "unknown");
1077 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1080 sdev_show_preferred_path(struct device *dev,
1081 struct device_attribute *attr,
1084 struct scsi_device *sdev = to_scsi_device(dev);
1089 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1090 return sprintf(buf, "1\n");
1092 return sprintf(buf, "0\n");
1094 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1098 sdev_show_queue_ramp_up_period(struct device *dev,
1099 struct device_attribute *attr,
1102 struct scsi_device *sdev;
1103 sdev = to_scsi_device(dev);
1104 return snprintf(buf, 20, "%u\n",
1105 jiffies_to_msecs(sdev->queue_ramp_up_period));
1109 sdev_store_queue_ramp_up_period(struct device *dev,
1110 struct device_attribute *attr,
1111 const char *buf, size_t count)
1113 struct scsi_device *sdev = to_scsi_device(dev);
1114 unsigned int period;
1116 if (kstrtouint(buf, 10, &period))
1119 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1123 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1124 sdev_show_queue_ramp_up_period,
1125 sdev_store_queue_ramp_up_period);
1127 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1128 struct attribute *attr, int i)
1130 struct device *dev = container_of(kobj, struct device, kobj);
1131 struct scsi_device *sdev = to_scsi_device(dev);
1134 if (attr == &dev_attr_queue_depth.attr &&
1135 !sdev->host->hostt->change_queue_depth)
1138 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1139 !sdev->host->hostt->change_queue_depth)
1142 #ifdef CONFIG_SCSI_DH
1143 if (attr == &dev_attr_access_state.attr &&
1146 if (attr == &dev_attr_preferred_path.attr &&
1153 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1154 struct bin_attribute *attr, int i)
1156 struct device *dev = container_of(kobj, struct device, kobj);
1157 struct scsi_device *sdev = to_scsi_device(dev);
1160 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1163 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1169 /* Default template for device attributes. May NOT be modified */
1170 static struct attribute *scsi_sdev_attrs[] = {
1171 &dev_attr_device_blocked.attr,
1172 &dev_attr_type.attr,
1173 &dev_attr_scsi_level.attr,
1174 &dev_attr_device_busy.attr,
1175 &dev_attr_vendor.attr,
1176 &dev_attr_model.attr,
1178 &dev_attr_rescan.attr,
1179 &dev_attr_delete.attr,
1180 &dev_attr_state.attr,
1181 &dev_attr_timeout.attr,
1182 &dev_attr_eh_timeout.attr,
1183 &dev_attr_iocounterbits.attr,
1184 &dev_attr_iorequest_cnt.attr,
1185 &dev_attr_iodone_cnt.attr,
1186 &dev_attr_ioerr_cnt.attr,
1187 &dev_attr_modalias.attr,
1188 &dev_attr_queue_depth.attr,
1189 &dev_attr_queue_type.attr,
1190 &dev_attr_wwid.attr,
1191 &dev_attr_blacklist.attr,
1192 #ifdef CONFIG_SCSI_DH
1193 &dev_attr_dh_state.attr,
1194 &dev_attr_access_state.attr,
1195 &dev_attr_preferred_path.attr,
1197 &dev_attr_queue_ramp_up_period.attr,
1198 REF_EVT(media_change),
1199 REF_EVT(inquiry_change_reported),
1200 REF_EVT(capacity_change_reported),
1201 REF_EVT(soft_threshold_reached),
1202 REF_EVT(mode_parameter_change_reported),
1203 REF_EVT(lun_change_reported),
1207 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1213 static struct attribute_group scsi_sdev_attr_group = {
1214 .attrs = scsi_sdev_attrs,
1215 .bin_attrs = scsi_sdev_bin_attrs,
1216 .is_visible = scsi_sdev_attr_is_visible,
1217 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1220 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1221 &scsi_sdev_attr_group,
1225 static int scsi_target_add(struct scsi_target *starget)
1229 if (starget->state != STARGET_CREATED)
1232 error = device_add(&starget->dev);
1234 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1237 transport_add_device(&starget->dev);
1238 starget->state = STARGET_RUNNING;
1240 pm_runtime_set_active(&starget->dev);
1241 pm_runtime_enable(&starget->dev);
1242 device_enable_async_suspend(&starget->dev);
1248 * scsi_sysfs_add_sdev - add scsi device to sysfs
1249 * @sdev: scsi_device to add
1252 * 0 on Success / non-zero on Failure
1254 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1257 struct request_queue *rq = sdev->request_queue;
1258 struct scsi_target *starget = sdev->sdev_target;
1260 error = scsi_target_add(starget);
1264 transport_configure_device(&starget->dev);
1266 device_enable_async_suspend(&sdev->sdev_gendev);
1267 scsi_autopm_get_target(starget);
1268 pm_runtime_set_active(&sdev->sdev_gendev);
1269 pm_runtime_forbid(&sdev->sdev_gendev);
1270 pm_runtime_enable(&sdev->sdev_gendev);
1271 scsi_autopm_put_target(starget);
1273 scsi_autopm_get_device(sdev);
1275 scsi_dh_add_device(sdev);
1277 error = device_add(&sdev->sdev_gendev);
1279 sdev_printk(KERN_INFO, sdev,
1280 "failed to add device: %d\n", error);
1284 device_enable_async_suspend(&sdev->sdev_dev);
1285 error = device_add(&sdev->sdev_dev);
1287 sdev_printk(KERN_INFO, sdev,
1288 "failed to add class device: %d\n", error);
1289 device_del(&sdev->sdev_gendev);
1292 transport_add_device(&sdev->sdev_gendev);
1293 sdev->is_visible = 1;
1295 error = bsg_scsi_register_queue(rq, &sdev->sdev_gendev);
1297 /* we're treating error on bsg register as non-fatal,
1298 * so pretend nothing went wrong */
1299 sdev_printk(KERN_INFO, sdev,
1300 "Failed to register bsg queue, errno=%d\n", error);
1302 /* add additional host specific attributes */
1303 if (sdev->host->hostt->sdev_attrs) {
1304 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1305 error = device_create_file(&sdev->sdev_gendev,
1306 sdev->host->hostt->sdev_attrs[i]);
1312 if (sdev->host->hostt->sdev_groups) {
1313 error = sysfs_create_groups(&sdev->sdev_gendev.kobj,
1314 sdev->host->hostt->sdev_groups);
1319 scsi_autopm_put_device(sdev);
1323 void __scsi_remove_device(struct scsi_device *sdev)
1325 struct device *dev = &sdev->sdev_gendev;
1329 * This cleanup path is not reentrant and while it is impossible
1330 * to get a new reference with scsi_device_get() someone can still
1331 * hold a previously acquired one.
1333 if (sdev->sdev_state == SDEV_DEL)
1336 if (sdev->is_visible) {
1338 * If scsi_internal_target_block() is running concurrently,
1339 * wait until it has finished before changing the device state.
1341 mutex_lock(&sdev->state_mutex);
1343 * If blocked, we go straight to DEL and restart the queue so
1344 * any commands issued during driver shutdown (like sync
1345 * cache) are errored immediately.
1347 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1349 res = scsi_device_set_state(sdev, SDEV_DEL);
1351 scsi_start_queue(sdev);
1353 mutex_unlock(&sdev->state_mutex);
1358 if (sdev->host->hostt->sdev_groups)
1359 sysfs_remove_groups(&sdev->sdev_gendev.kobj,
1360 sdev->host->hostt->sdev_groups);
1362 bsg_unregister_queue(sdev->request_queue);
1363 device_unregister(&sdev->sdev_dev);
1364 transport_remove_device(dev);
1367 put_device(&sdev->sdev_dev);
1370 * Stop accepting new requests and wait until all queuecommand() and
1371 * scsi_run_queue() invocations have finished before tearing down the
1374 mutex_lock(&sdev->state_mutex);
1375 scsi_device_set_state(sdev, SDEV_DEL);
1376 mutex_unlock(&sdev->state_mutex);
1378 blk_cleanup_queue(sdev->request_queue);
1379 cancel_work_sync(&sdev->requeue_work);
1381 if (sdev->host->hostt->slave_destroy)
1382 sdev->host->hostt->slave_destroy(sdev);
1383 transport_destroy_device(dev);
1386 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1387 * remoed sysfs visibility from the device, so make the target
1388 * invisible if this was the last device underneath it.
1390 scsi_target_reap(scsi_target(sdev));
1396 * scsi_remove_device - unregister a device from the scsi bus
1397 * @sdev: scsi_device to unregister
1399 void scsi_remove_device(struct scsi_device *sdev)
1401 struct Scsi_Host *shost = sdev->host;
1403 mutex_lock(&shost->scan_mutex);
1404 __scsi_remove_device(sdev);
1405 mutex_unlock(&shost->scan_mutex);
1407 EXPORT_SYMBOL(scsi_remove_device);
1409 static void __scsi_remove_target(struct scsi_target *starget)
1411 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1412 unsigned long flags;
1413 struct scsi_device *sdev;
1415 spin_lock_irqsave(shost->host_lock, flags);
1417 list_for_each_entry(sdev, &shost->__devices, siblings) {
1419 * We cannot call scsi_device_get() here, as
1420 * we might've been called from rmmod() causing
1421 * scsi_device_get() to fail the module_is_live()
1424 if (sdev->channel != starget->channel ||
1425 sdev->id != starget->id)
1427 if (sdev->sdev_state == SDEV_DEL ||
1428 sdev->sdev_state == SDEV_CANCEL ||
1429 !get_device(&sdev->sdev_gendev))
1431 spin_unlock_irqrestore(shost->host_lock, flags);
1432 scsi_remove_device(sdev);
1433 put_device(&sdev->sdev_gendev);
1434 spin_lock_irqsave(shost->host_lock, flags);
1437 spin_unlock_irqrestore(shost->host_lock, flags);
1441 * scsi_remove_target - try to remove a target and all its devices
1442 * @dev: generic starget or parent of generic stargets to be removed
1444 * Note: This is slightly racy. It is possible that if the user
1445 * requests the addition of another device then the target won't be
1448 void scsi_remove_target(struct device *dev)
1450 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1451 struct scsi_target *starget;
1452 unsigned long flags;
1455 spin_lock_irqsave(shost->host_lock, flags);
1456 list_for_each_entry(starget, &shost->__targets, siblings) {
1457 if (starget->state == STARGET_DEL ||
1458 starget->state == STARGET_REMOVE ||
1459 starget->state == STARGET_CREATED_REMOVE)
1461 if (starget->dev.parent == dev || &starget->dev == dev) {
1462 kref_get(&starget->reap_ref);
1463 if (starget->state == STARGET_CREATED)
1464 starget->state = STARGET_CREATED_REMOVE;
1466 starget->state = STARGET_REMOVE;
1467 spin_unlock_irqrestore(shost->host_lock, flags);
1468 __scsi_remove_target(starget);
1469 scsi_target_reap(starget);
1473 spin_unlock_irqrestore(shost->host_lock, flags);
1475 EXPORT_SYMBOL(scsi_remove_target);
1477 int scsi_register_driver(struct device_driver *drv)
1479 drv->bus = &scsi_bus_type;
1481 return driver_register(drv);
1483 EXPORT_SYMBOL(scsi_register_driver);
1485 int scsi_register_interface(struct class_interface *intf)
1487 intf->class = &sdev_class;
1489 return class_interface_register(intf);
1491 EXPORT_SYMBOL(scsi_register_interface);
1494 * scsi_sysfs_add_host - add scsi host to subsystem
1495 * @shost: scsi host struct to add to subsystem
1497 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1501 /* add host specific attributes */
1502 if (shost->hostt->shost_attrs) {
1503 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1504 error = device_create_file(&shost->shost_dev,
1505 shost->hostt->shost_attrs[i]);
1511 transport_register_device(&shost->shost_gendev);
1512 transport_configure_device(&shost->shost_gendev);
1516 static struct device_type scsi_dev_type = {
1517 .name = "scsi_device",
1518 .release = scsi_device_dev_release,
1519 .groups = scsi_sdev_attr_groups,
1522 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1524 unsigned long flags;
1525 struct Scsi_Host *shost = sdev->host;
1526 struct scsi_target *starget = sdev->sdev_target;
1528 device_initialize(&sdev->sdev_gendev);
1529 sdev->sdev_gendev.bus = &scsi_bus_type;
1530 sdev->sdev_gendev.type = &scsi_dev_type;
1531 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1532 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1534 device_initialize(&sdev->sdev_dev);
1535 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1536 sdev->sdev_dev.class = &sdev_class;
1537 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1538 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1540 * Get a default scsi_level from the target (derived from sibling
1541 * devices). This is the best we can do for guessing how to set
1542 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1543 * setting doesn't matter, because all the bits are zero anyway.
1544 * But it does matter for higher LUNs.
1546 sdev->scsi_level = starget->scsi_level;
1547 if (sdev->scsi_level <= SCSI_2 &&
1548 sdev->scsi_level != SCSI_UNKNOWN &&
1549 !shost->no_scsi2_lun_in_cdb)
1550 sdev->lun_in_cdb = 1;
1552 transport_setup_device(&sdev->sdev_gendev);
1553 spin_lock_irqsave(shost->host_lock, flags);
1554 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1555 list_add_tail(&sdev->siblings, &shost->__devices);
1556 spin_unlock_irqrestore(shost->host_lock, flags);
1558 * device can now only be removed via __scsi_remove_device() so hold
1559 * the target. Target will be held in CREATED state until something
1560 * beneath it becomes visible (in which case it moves to RUNNING)
1562 kref_get(&starget->reap_ref);
1565 int scsi_is_sdev_device(const struct device *dev)
1567 return dev->type == &scsi_dev_type;
1569 EXPORT_SYMBOL(scsi_is_sdev_device);
1571 /* A blank transport template that is used in drivers that don't
1572 * yet implement Transport Attributes */
1573 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };