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>
24 #include "scsi_priv.h"
25 #include "scsi_logging.h"
27 static struct device_type scsi_dev_type;
30 enum scsi_device_state value;
33 { SDEV_CREATED, "created" },
34 { SDEV_RUNNING, "running" },
35 { SDEV_CANCEL, "cancel" },
36 { SDEV_DEL, "deleted" },
37 { SDEV_QUIESCE, "quiesce" },
38 { SDEV_OFFLINE, "offline" },
39 { SDEV_TRANSPORT_OFFLINE, "transport-offline" },
40 { SDEV_BLOCK, "blocked" },
41 { SDEV_CREATED_BLOCK, "created-blocked" },
44 const char *scsi_device_state_name(enum scsi_device_state state)
49 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
50 if (sdev_states[i].value == state) {
51 name = sdev_states[i].name;
59 enum scsi_host_state value;
62 { SHOST_CREATED, "created" },
63 { SHOST_RUNNING, "running" },
64 { SHOST_CANCEL, "cancel" },
65 { SHOST_DEL, "deleted" },
66 { SHOST_RECOVERY, "recovery" },
67 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
68 { SHOST_DEL_RECOVERY, "deleted/recovery", },
70 const char *scsi_host_state_name(enum scsi_host_state state)
75 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
76 if (shost_states[i].value == state) {
77 name = shost_states[i].name;
88 } sdev_access_states[] = {
89 { SCSI_ACCESS_STATE_OPTIMAL, "active/optimized" },
90 { SCSI_ACCESS_STATE_ACTIVE, "active/non-optimized" },
91 { SCSI_ACCESS_STATE_STANDBY, "standby" },
92 { SCSI_ACCESS_STATE_UNAVAILABLE, "unavailable" },
93 { SCSI_ACCESS_STATE_LBA, "lba-dependent" },
94 { SCSI_ACCESS_STATE_OFFLINE, "offline" },
95 { SCSI_ACCESS_STATE_TRANSITIONING, "transitioning" },
98 static const char *scsi_access_state_name(unsigned char state)
103 for (i = 0; i < ARRAY_SIZE(sdev_access_states); i++) {
104 if (sdev_access_states[i].value == state) {
105 name = sdev_access_states[i].name;
113 static int check_set(unsigned long long *val, char *src)
117 if (strcmp(src, "-") == 0) {
118 *val = SCAN_WILD_CARD;
121 * Doesn't check for int overflow
123 *val = simple_strtoull(src, &last, 0);
130 static int scsi_scan(struct Scsi_Host *shost, const char *str)
132 char s1[15], s2[15], s3[17], junk;
133 unsigned long long channel, id, lun;
136 res = sscanf(str, "%10s %10s %16s %c", s1, s2, s3, &junk);
139 if (check_set(&channel, s1))
141 if (check_set(&id, s2))
143 if (check_set(&lun, s3))
145 if (shost->transportt->user_scan)
146 res = shost->transportt->user_scan(shost, channel, id, lun);
148 res = scsi_scan_host_selected(shost, channel, id, lun,
154 * shost_show_function: macro to create an attr function that can be used to
155 * show a non-bit field.
157 #define shost_show_function(name, field, format_string) \
159 show_##name (struct device *dev, struct device_attribute *attr, \
162 struct Scsi_Host *shost = class_to_shost(dev); \
163 return snprintf (buf, 20, format_string, shost->field); \
167 * shost_rd_attr: macro to create a function and attribute variable for a
170 #define shost_rd_attr2(name, field, format_string) \
171 shost_show_function(name, field, format_string) \
172 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
174 #define shost_rd_attr(field, format_string) \
175 shost_rd_attr2(field, field, format_string)
178 * Create the actual show/store functions and data structures.
182 store_scan(struct device *dev, struct device_attribute *attr,
183 const char *buf, size_t count)
185 struct Scsi_Host *shost = class_to_shost(dev);
188 res = scsi_scan(shost, buf);
193 static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
196 store_shost_state(struct device *dev, struct device_attribute *attr,
197 const char *buf, size_t count)
200 struct Scsi_Host *shost = class_to_shost(dev);
201 enum scsi_host_state state = 0;
203 for (i = 0; i < ARRAY_SIZE(shost_states); i++) {
204 const int len = strlen(shost_states[i].name);
205 if (strncmp(shost_states[i].name, buf, len) == 0 &&
207 state = shost_states[i].value;
214 if (scsi_host_set_state(shost, state))
220 show_shost_state(struct device *dev, struct device_attribute *attr, char *buf)
222 struct Scsi_Host *shost = class_to_shost(dev);
223 const char *name = scsi_host_state_name(shost->shost_state);
228 return snprintf(buf, 20, "%s\n", name);
231 /* DEVICE_ATTR(state) clashes with dev_attr_state for sdev */
232 static struct device_attribute dev_attr_hstate =
233 __ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
236 show_shost_mode(unsigned int mode, char *buf)
240 if (mode & MODE_INITIATOR)
241 len = sprintf(buf, "%s", "Initiator");
243 if (mode & MODE_TARGET)
244 len += sprintf(buf + len, "%s%s", len ? ", " : "", "Target");
246 len += sprintf(buf + len, "\n");
252 show_shost_supported_mode(struct device *dev, struct device_attribute *attr,
255 struct Scsi_Host *shost = class_to_shost(dev);
256 unsigned int supported_mode = shost->hostt->supported_mode;
258 if (supported_mode == MODE_UNKNOWN)
259 /* by default this should be initiator */
260 supported_mode = MODE_INITIATOR;
262 return show_shost_mode(supported_mode, buf);
265 static DEVICE_ATTR(supported_mode, S_IRUGO | S_IWUSR, show_shost_supported_mode, NULL);
268 show_shost_active_mode(struct device *dev,
269 struct device_attribute *attr, char *buf)
271 struct Scsi_Host *shost = class_to_shost(dev);
273 if (shost->active_mode == MODE_UNKNOWN)
274 return snprintf(buf, 20, "unknown\n");
276 return show_shost_mode(shost->active_mode, buf);
279 static DEVICE_ATTR(active_mode, S_IRUGO | S_IWUSR, show_shost_active_mode, NULL);
281 static int check_reset_type(const char *str)
283 if (sysfs_streq(str, "adapter"))
284 return SCSI_ADAPTER_RESET;
285 else if (sysfs_streq(str, "firmware"))
286 return SCSI_FIRMWARE_RESET;
292 store_host_reset(struct device *dev, struct device_attribute *attr,
293 const char *buf, size_t count)
295 struct Scsi_Host *shost = class_to_shost(dev);
296 struct scsi_host_template *sht = shost->hostt;
300 type = check_reset_type(buf);
302 goto exit_store_host_reset;
305 ret = sht->host_reset(shost, type);
309 exit_store_host_reset:
315 static DEVICE_ATTR(host_reset, S_IWUSR, NULL, store_host_reset);
318 show_shost_eh_deadline(struct device *dev,
319 struct device_attribute *attr, char *buf)
321 struct Scsi_Host *shost = class_to_shost(dev);
323 if (shost->eh_deadline == -1)
324 return snprintf(buf, strlen("off") + 2, "off\n");
325 return sprintf(buf, "%u\n", shost->eh_deadline / HZ);
329 store_shost_eh_deadline(struct device *dev, struct device_attribute *attr,
330 const char *buf, size_t count)
332 struct Scsi_Host *shost = class_to_shost(dev);
334 unsigned long deadline, flags;
336 if (shost->transportt &&
337 (shost->transportt->eh_strategy_handler ||
338 !shost->hostt->eh_host_reset_handler))
341 if (!strncmp(buf, "off", strlen("off")))
344 ret = kstrtoul(buf, 10, &deadline);
347 if (deadline * HZ > UINT_MAX)
351 spin_lock_irqsave(shost->host_lock, flags);
352 if (scsi_host_in_recovery(shost))
356 shost->eh_deadline = -1;
358 shost->eh_deadline = deadline * HZ;
362 spin_unlock_irqrestore(shost->host_lock, flags);
367 static DEVICE_ATTR(eh_deadline, S_IRUGO | S_IWUSR, show_shost_eh_deadline, store_shost_eh_deadline);
369 shost_rd_attr(use_blk_mq, "%d\n");
370 shost_rd_attr(unique_id, "%u\n");
371 shost_rd_attr(cmd_per_lun, "%hd\n");
372 shost_rd_attr(can_queue, "%hd\n");
373 shost_rd_attr(sg_tablesize, "%hu\n");
374 shost_rd_attr(sg_prot_tablesize, "%hu\n");
375 shost_rd_attr(unchecked_isa_dma, "%d\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", atomic_read(&shost->host_busy));
386 static DEVICE_ATTR(host_busy, S_IRUGO, show_host_busy, NULL);
388 static struct attribute *scsi_sysfs_shost_attrs[] = {
389 &dev_attr_use_blk_mq.attr,
390 &dev_attr_unique_id.attr,
391 &dev_attr_host_busy.attr,
392 &dev_attr_cmd_per_lun.attr,
393 &dev_attr_can_queue.attr,
394 &dev_attr_sg_tablesize.attr,
395 &dev_attr_sg_prot_tablesize.attr,
396 &dev_attr_unchecked_isa_dma.attr,
397 &dev_attr_proc_name.attr,
399 &dev_attr_hstate.attr,
400 &dev_attr_supported_mode.attr,
401 &dev_attr_active_mode.attr,
402 &dev_attr_prot_capabilities.attr,
403 &dev_attr_prot_guard_type.attr,
404 &dev_attr_host_reset.attr,
405 &dev_attr_eh_deadline.attr,
409 static struct attribute_group scsi_shost_attr_group = {
410 .attrs = scsi_sysfs_shost_attrs,
413 const struct attribute_group *scsi_sysfs_shost_attr_groups[] = {
414 &scsi_shost_attr_group,
418 static void scsi_device_cls_release(struct device *class_dev)
420 struct scsi_device *sdev;
422 sdev = class_to_sdev(class_dev);
423 put_device(&sdev->sdev_gendev);
426 static void scsi_device_dev_release_usercontext(struct work_struct *work)
428 struct scsi_device *sdev;
429 struct device *parent;
430 struct list_head *this, *tmp;
431 struct scsi_vpd *vpd_pg80 = NULL, *vpd_pg83 = NULL;
434 sdev = container_of(work, struct scsi_device, ew.work);
436 scsi_dh_release_device(sdev);
438 parent = sdev->sdev_gendev.parent;
440 spin_lock_irqsave(sdev->host->host_lock, flags);
441 list_del(&sdev->siblings);
442 list_del(&sdev->same_target_siblings);
443 list_del(&sdev->starved_entry);
444 spin_unlock_irqrestore(sdev->host->host_lock, flags);
446 cancel_work_sync(&sdev->event_work);
448 list_for_each_safe(this, tmp, &sdev->event_list) {
449 struct scsi_event *evt;
451 evt = list_entry(this, struct scsi_event, node);
452 list_del(&evt->node);
456 blk_put_queue(sdev->request_queue);
457 /* NULL queue means the device can't be used */
458 sdev->request_queue = NULL;
460 mutex_lock(&sdev->inquiry_mutex);
461 rcu_swap_protected(sdev->vpd_pg80, vpd_pg80,
462 lockdep_is_held(&sdev->inquiry_mutex));
463 rcu_swap_protected(sdev->vpd_pg83, vpd_pg83,
464 lockdep_is_held(&sdev->inquiry_mutex));
465 mutex_unlock(&sdev->inquiry_mutex);
468 kfree_rcu(vpd_pg83, rcu);
470 kfree_rcu(vpd_pg80, rcu);
471 kfree(sdev->inquiry);
478 static void scsi_device_dev_release(struct device *dev)
480 struct scsi_device *sdp = to_scsi_device(dev);
481 execute_in_process_context(scsi_device_dev_release_usercontext,
485 static struct class sdev_class = {
486 .name = "scsi_device",
487 .dev_release = scsi_device_cls_release,
490 /* all probing is done in the individual ->probe routines */
491 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
493 struct scsi_device *sdp;
495 if (dev->type != &scsi_dev_type)
498 sdp = to_scsi_device(dev);
499 if (sdp->no_uld_attach)
501 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
504 static int scsi_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
506 struct scsi_device *sdev;
508 if (dev->type != &scsi_dev_type)
511 sdev = to_scsi_device(dev);
513 add_uevent_var(env, "MODALIAS=" SCSI_DEVICE_MODALIAS_FMT, sdev->type);
517 struct bus_type scsi_bus_type = {
519 .match = scsi_bus_match,
520 .uevent = scsi_bus_uevent,
522 .pm = &scsi_bus_pm_ops,
525 EXPORT_SYMBOL_GPL(scsi_bus_type);
527 int scsi_sysfs_register(void)
531 error = bus_register(&scsi_bus_type);
533 error = class_register(&sdev_class);
535 bus_unregister(&scsi_bus_type);
541 void scsi_sysfs_unregister(void)
543 class_unregister(&sdev_class);
544 bus_unregister(&scsi_bus_type);
548 * sdev_show_function: macro to create an attr function that can be used to
549 * show a non-bit field.
551 #define sdev_show_function(field, format_string) \
553 sdev_show_##field (struct device *dev, struct device_attribute *attr, \
556 struct scsi_device *sdev; \
557 sdev = to_scsi_device(dev); \
558 return snprintf (buf, 20, format_string, sdev->field); \
562 * sdev_rd_attr: macro to create a function and attribute variable for a
565 #define sdev_rd_attr(field, format_string) \
566 sdev_show_function(field, format_string) \
567 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
571 * sdev_rw_attr: create a function and attribute variable for a
574 #define sdev_rw_attr(field, format_string) \
575 sdev_show_function(field, format_string) \
578 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
579 const char *buf, size_t count) \
581 struct scsi_device *sdev; \
582 sdev = to_scsi_device(dev); \
583 sscanf (buf, format_string, &sdev->field); \
586 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
588 /* Currently we don't export bit fields, but we might in future,
589 * so leave this code in */
592 * sdev_rd_attr: create a function and attribute variable for a
593 * read/write bit field.
595 #define sdev_rw_attr_bit(field) \
596 sdev_show_function(field, "%d\n") \
599 sdev_store_##field (struct device *dev, struct device_attribute *attr, \
600 const char *buf, size_t count) \
603 struct scsi_device *sdev; \
604 ret = scsi_sdev_check_buf_bit(buf); \
606 sdev = to_scsi_device(dev); \
612 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
615 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
616 * else return -EINVAL.
618 static int scsi_sdev_check_buf_bit(const char *buf)
620 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
623 else if (buf[0] == '0')
632 * Create the actual show/store functions and data structures.
634 sdev_rd_attr (type, "%d\n");
635 sdev_rd_attr (scsi_level, "%d\n");
636 sdev_rd_attr (vendor, "%.8s\n");
637 sdev_rd_attr (model, "%.16s\n");
638 sdev_rd_attr (rev, "%.4s\n");
641 sdev_show_device_busy(struct device *dev, struct device_attribute *attr,
644 struct scsi_device *sdev = to_scsi_device(dev);
645 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_busy));
647 static DEVICE_ATTR(device_busy, S_IRUGO, sdev_show_device_busy, NULL);
650 sdev_show_device_blocked(struct device *dev, struct device_attribute *attr,
653 struct scsi_device *sdev = to_scsi_device(dev);
654 return snprintf(buf, 20, "%d\n", atomic_read(&sdev->device_blocked));
656 static DEVICE_ATTR(device_blocked, S_IRUGO, sdev_show_device_blocked, NULL);
659 * TODO: can we make these symlinks to the block layer ones?
662 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
664 struct scsi_device *sdev;
665 sdev = to_scsi_device(dev);
666 return snprintf(buf, 20, "%d\n", sdev->request_queue->rq_timeout / HZ);
670 sdev_store_timeout (struct device *dev, struct device_attribute *attr,
671 const char *buf, size_t count)
673 struct scsi_device *sdev;
675 sdev = to_scsi_device(dev);
676 sscanf (buf, "%d\n", &timeout);
677 blk_queue_rq_timeout(sdev->request_queue, timeout * HZ);
680 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
683 sdev_show_eh_timeout(struct device *dev, struct device_attribute *attr, char *buf)
685 struct scsi_device *sdev;
686 sdev = to_scsi_device(dev);
687 return snprintf(buf, 20, "%u\n", sdev->eh_timeout / HZ);
691 sdev_store_eh_timeout(struct device *dev, struct device_attribute *attr,
692 const char *buf, size_t count)
694 struct scsi_device *sdev;
695 unsigned int eh_timeout;
698 if (!capable(CAP_SYS_ADMIN))
701 sdev = to_scsi_device(dev);
702 err = kstrtouint(buf, 10, &eh_timeout);
705 sdev->eh_timeout = eh_timeout * HZ;
709 static DEVICE_ATTR(eh_timeout, S_IRUGO | S_IWUSR, sdev_show_eh_timeout, sdev_store_eh_timeout);
712 store_rescan_field (struct device *dev, struct device_attribute *attr,
713 const char *buf, size_t count)
715 scsi_rescan_device(dev);
718 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
721 sdev_store_delete(struct device *dev, struct device_attribute *attr,
722 const char *buf, size_t count)
724 if (device_remove_file_self(dev, attr))
725 scsi_remove_device(to_scsi_device(dev));
728 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
731 store_state_field(struct device *dev, struct device_attribute *attr,
732 const char *buf, size_t count)
735 struct scsi_device *sdev = to_scsi_device(dev);
736 enum scsi_device_state state = 0;
738 for (i = 0; i < ARRAY_SIZE(sdev_states); i++) {
739 const int len = strlen(sdev_states[i].name);
740 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
742 state = sdev_states[i].value;
749 mutex_lock(&sdev->state_mutex);
750 ret = scsi_device_set_state(sdev, state);
751 mutex_unlock(&sdev->state_mutex);
753 return ret == 0 ? count : -EINVAL;
757 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
759 struct scsi_device *sdev = to_scsi_device(dev);
760 const char *name = scsi_device_state_name(sdev->sdev_state);
765 return snprintf(buf, 20, "%s\n", name);
768 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
771 show_queue_type_field(struct device *dev, struct device_attribute *attr,
774 struct scsi_device *sdev = to_scsi_device(dev);
775 const char *name = "none";
777 if (sdev->simple_tags)
780 return snprintf(buf, 20, "%s\n", name);
784 store_queue_type_field(struct device *dev, struct device_attribute *attr,
785 const char *buf, size_t count)
787 struct scsi_device *sdev = to_scsi_device(dev);
789 if (!sdev->tagged_supported)
792 sdev_printk(KERN_INFO, sdev,
793 "ignoring write to deprecated queue_type attribute");
797 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
798 store_queue_type_field);
800 #define sdev_vpd_pg_attr(_page) \
802 show_vpd_##_page(struct file *filp, struct kobject *kobj, \
803 struct bin_attribute *bin_attr, \
804 char *buf, loff_t off, size_t count) \
806 struct device *dev = container_of(kobj, struct device, kobj); \
807 struct scsi_device *sdev = to_scsi_device(dev); \
808 struct scsi_vpd *vpd_page; \
812 vpd_page = rcu_dereference(sdev->vpd_##_page); \
814 ret = memory_read_from_buffer(buf, count, &off, \
815 vpd_page->data, vpd_page->len); \
819 static struct bin_attribute dev_attr_vpd_##_page = { \
820 .attr = {.name = __stringify(vpd_##_page), .mode = S_IRUGO }, \
822 .read = show_vpd_##_page, \
825 sdev_vpd_pg_attr(pg83);
826 sdev_vpd_pg_attr(pg80);
828 static ssize_t show_inquiry(struct file *filep, struct kobject *kobj,
829 struct bin_attribute *bin_attr,
830 char *buf, loff_t off, size_t count)
832 struct device *dev = container_of(kobj, struct device, kobj);
833 struct scsi_device *sdev = to_scsi_device(dev);
838 return memory_read_from_buffer(buf, count, &off, sdev->inquiry,
842 static struct bin_attribute dev_attr_inquiry = {
848 .read = show_inquiry,
852 show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
855 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
858 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
860 #define show_sdev_iostat(field) \
862 show_iostat_##field(struct device *dev, struct device_attribute *attr, \
865 struct scsi_device *sdev = to_scsi_device(dev); \
866 unsigned long long count = atomic_read(&sdev->field); \
867 return snprintf(buf, 20, "0x%llx\n", count); \
869 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
871 show_sdev_iostat(iorequest_cnt);
872 show_sdev_iostat(iodone_cnt);
873 show_sdev_iostat(ioerr_cnt);
876 sdev_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
878 struct scsi_device *sdev;
879 sdev = to_scsi_device(dev);
880 return snprintf (buf, 20, SCSI_DEVICE_MODALIAS_FMT "\n", sdev->type);
882 static DEVICE_ATTR(modalias, S_IRUGO, sdev_show_modalias, NULL);
884 #define DECLARE_EVT_SHOW(name, Cap_name) \
886 sdev_show_evt_##name(struct device *dev, struct device_attribute *attr, \
889 struct scsi_device *sdev = to_scsi_device(dev); \
890 int val = test_bit(SDEV_EVT_##Cap_name, sdev->supported_events);\
891 return snprintf(buf, 20, "%d\n", val); \
894 #define DECLARE_EVT_STORE(name, Cap_name) \
896 sdev_store_evt_##name(struct device *dev, struct device_attribute *attr,\
897 const char *buf, size_t count) \
899 struct scsi_device *sdev = to_scsi_device(dev); \
900 int val = simple_strtoul(buf, NULL, 0); \
902 clear_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
904 set_bit(SDEV_EVT_##Cap_name, sdev->supported_events); \
910 #define DECLARE_EVT(name, Cap_name) \
911 DECLARE_EVT_SHOW(name, Cap_name) \
912 DECLARE_EVT_STORE(name, Cap_name) \
913 static DEVICE_ATTR(evt_##name, S_IRUGO, sdev_show_evt_##name, \
914 sdev_store_evt_##name);
915 #define REF_EVT(name) &dev_attr_evt_##name.attr
917 DECLARE_EVT(media_change, MEDIA_CHANGE)
918 DECLARE_EVT(inquiry_change_reported, INQUIRY_CHANGE_REPORTED)
919 DECLARE_EVT(capacity_change_reported, CAPACITY_CHANGE_REPORTED)
920 DECLARE_EVT(soft_threshold_reached, SOFT_THRESHOLD_REACHED_REPORTED)
921 DECLARE_EVT(mode_parameter_change_reported, MODE_PARAMETER_CHANGE_REPORTED)
922 DECLARE_EVT(lun_change_reported, LUN_CHANGE_REPORTED)
925 sdev_store_queue_depth(struct device *dev, struct device_attribute *attr,
926 const char *buf, size_t count)
929 struct scsi_device *sdev = to_scsi_device(dev);
930 struct scsi_host_template *sht = sdev->host->hostt;
932 if (!sht->change_queue_depth)
935 depth = simple_strtoul(buf, NULL, 0);
937 if (depth < 1 || depth > sdev->host->can_queue)
940 retval = sht->change_queue_depth(sdev, depth);
944 sdev->max_queue_depth = sdev->queue_depth;
948 sdev_show_function(queue_depth, "%d\n");
950 static DEVICE_ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
951 sdev_store_queue_depth);
954 sdev_show_wwid(struct device *dev, struct device_attribute *attr,
957 struct scsi_device *sdev = to_scsi_device(dev);
960 count = scsi_vpd_lun_id(sdev, buf, PAGE_SIZE);
967 static DEVICE_ATTR(wwid, S_IRUGO, sdev_show_wwid, NULL);
969 #ifdef CONFIG_SCSI_DH
971 sdev_show_dh_state(struct device *dev, struct device_attribute *attr,
974 struct scsi_device *sdev = to_scsi_device(dev);
977 return snprintf(buf, 20, "detached\n");
979 return snprintf(buf, 20, "%s\n", sdev->handler->name);
983 sdev_store_dh_state(struct device *dev, struct device_attribute *attr,
984 const char *buf, size_t count)
986 struct scsi_device *sdev = to_scsi_device(dev);
989 if (sdev->sdev_state == SDEV_CANCEL ||
990 sdev->sdev_state == SDEV_DEL)
993 if (!sdev->handler) {
995 * Attach to a device handler
997 err = scsi_dh_attach(sdev->request_queue, buf);
998 } else if (!strncmp(buf, "activate", 8)) {
1000 * Activate a device handler
1002 if (sdev->handler->activate)
1003 err = sdev->handler->activate(sdev, NULL, NULL);
1006 } else if (!strncmp(buf, "detach", 6)) {
1008 * Detach from a device handler
1010 sdev_printk(KERN_WARNING, sdev,
1011 "can't detach handler %s.\n",
1012 sdev->handler->name);
1016 return err < 0 ? err : count;
1019 static DEVICE_ATTR(dh_state, S_IRUGO | S_IWUSR, sdev_show_dh_state,
1020 sdev_store_dh_state);
1023 sdev_show_access_state(struct device *dev,
1024 struct device_attribute *attr,
1027 struct scsi_device *sdev = to_scsi_device(dev);
1028 unsigned char access_state;
1029 const char *access_state_name;
1034 access_state = (sdev->access_state & SCSI_ACCESS_STATE_MASK);
1035 access_state_name = scsi_access_state_name(access_state);
1037 return sprintf(buf, "%s\n",
1038 access_state_name ? access_state_name : "unknown");
1040 static DEVICE_ATTR(access_state, S_IRUGO, sdev_show_access_state, NULL);
1043 sdev_show_preferred_path(struct device *dev,
1044 struct device_attribute *attr,
1047 struct scsi_device *sdev = to_scsi_device(dev);
1052 if (sdev->access_state & SCSI_ACCESS_STATE_PREFERRED)
1053 return sprintf(buf, "1\n");
1055 return sprintf(buf, "0\n");
1057 static DEVICE_ATTR(preferred_path, S_IRUGO, sdev_show_preferred_path, NULL);
1061 sdev_show_queue_ramp_up_period(struct device *dev,
1062 struct device_attribute *attr,
1065 struct scsi_device *sdev;
1066 sdev = to_scsi_device(dev);
1067 return snprintf(buf, 20, "%u\n",
1068 jiffies_to_msecs(sdev->queue_ramp_up_period));
1072 sdev_store_queue_ramp_up_period(struct device *dev,
1073 struct device_attribute *attr,
1074 const char *buf, size_t count)
1076 struct scsi_device *sdev = to_scsi_device(dev);
1077 unsigned int period;
1079 if (kstrtouint(buf, 10, &period))
1082 sdev->queue_ramp_up_period = msecs_to_jiffies(period);
1086 static DEVICE_ATTR(queue_ramp_up_period, S_IRUGO | S_IWUSR,
1087 sdev_show_queue_ramp_up_period,
1088 sdev_store_queue_ramp_up_period);
1090 static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
1091 struct attribute *attr, int i)
1093 struct device *dev = container_of(kobj, struct device, kobj);
1094 struct scsi_device *sdev = to_scsi_device(dev);
1097 if (attr == &dev_attr_queue_depth.attr &&
1098 !sdev->host->hostt->change_queue_depth)
1101 if (attr == &dev_attr_queue_ramp_up_period.attr &&
1102 !sdev->host->hostt->change_queue_depth)
1105 #ifdef CONFIG_SCSI_DH
1106 if (attr == &dev_attr_access_state.attr &&
1109 if (attr == &dev_attr_preferred_path.attr &&
1116 static umode_t scsi_sdev_bin_attr_is_visible(struct kobject *kobj,
1117 struct bin_attribute *attr, int i)
1119 struct device *dev = container_of(kobj, struct device, kobj);
1120 struct scsi_device *sdev = to_scsi_device(dev);
1123 if (attr == &dev_attr_vpd_pg80 && !sdev->vpd_pg80)
1126 if (attr == &dev_attr_vpd_pg83 && !sdev->vpd_pg83)
1132 /* Default template for device attributes. May NOT be modified */
1133 static struct attribute *scsi_sdev_attrs[] = {
1134 &dev_attr_device_blocked.attr,
1135 &dev_attr_type.attr,
1136 &dev_attr_scsi_level.attr,
1137 &dev_attr_device_busy.attr,
1138 &dev_attr_vendor.attr,
1139 &dev_attr_model.attr,
1141 &dev_attr_rescan.attr,
1142 &dev_attr_delete.attr,
1143 &dev_attr_state.attr,
1144 &dev_attr_timeout.attr,
1145 &dev_attr_eh_timeout.attr,
1146 &dev_attr_iocounterbits.attr,
1147 &dev_attr_iorequest_cnt.attr,
1148 &dev_attr_iodone_cnt.attr,
1149 &dev_attr_ioerr_cnt.attr,
1150 &dev_attr_modalias.attr,
1151 &dev_attr_queue_depth.attr,
1152 &dev_attr_queue_type.attr,
1153 &dev_attr_wwid.attr,
1154 #ifdef CONFIG_SCSI_DH
1155 &dev_attr_dh_state.attr,
1156 &dev_attr_access_state.attr,
1157 &dev_attr_preferred_path.attr,
1159 &dev_attr_queue_ramp_up_period.attr,
1160 REF_EVT(media_change),
1161 REF_EVT(inquiry_change_reported),
1162 REF_EVT(capacity_change_reported),
1163 REF_EVT(soft_threshold_reached),
1164 REF_EVT(mode_parameter_change_reported),
1165 REF_EVT(lun_change_reported),
1169 static struct bin_attribute *scsi_sdev_bin_attrs[] = {
1175 static struct attribute_group scsi_sdev_attr_group = {
1176 .attrs = scsi_sdev_attrs,
1177 .bin_attrs = scsi_sdev_bin_attrs,
1178 .is_visible = scsi_sdev_attr_is_visible,
1179 .is_bin_visible = scsi_sdev_bin_attr_is_visible,
1182 static const struct attribute_group *scsi_sdev_attr_groups[] = {
1183 &scsi_sdev_attr_group,
1187 static int scsi_target_add(struct scsi_target *starget)
1191 if (starget->state != STARGET_CREATED)
1194 error = device_add(&starget->dev);
1196 dev_err(&starget->dev, "target device_add failed, error %d\n", error);
1199 transport_add_device(&starget->dev);
1200 starget->state = STARGET_RUNNING;
1202 pm_runtime_set_active(&starget->dev);
1203 pm_runtime_enable(&starget->dev);
1204 device_enable_async_suspend(&starget->dev);
1210 * scsi_sysfs_add_sdev - add scsi device to sysfs
1211 * @sdev: scsi_device to add
1214 * 0 on Success / non-zero on Failure
1216 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
1219 struct request_queue *rq = sdev->request_queue;
1220 struct scsi_target *starget = sdev->sdev_target;
1222 error = scsi_target_add(starget);
1226 transport_configure_device(&starget->dev);
1228 device_enable_async_suspend(&sdev->sdev_gendev);
1229 scsi_autopm_get_target(starget);
1230 pm_runtime_set_active(&sdev->sdev_gendev);
1231 pm_runtime_forbid(&sdev->sdev_gendev);
1232 pm_runtime_enable(&sdev->sdev_gendev);
1233 scsi_autopm_put_target(starget);
1235 scsi_autopm_get_device(sdev);
1237 error = scsi_dh_add_device(sdev);
1240 * device_handler is optional, so any error can be ignored
1242 sdev_printk(KERN_INFO, sdev,
1243 "failed to add device handler: %d\n", error);
1245 error = device_add(&sdev->sdev_gendev);
1247 sdev_printk(KERN_INFO, sdev,
1248 "failed to add device: %d\n", error);
1249 scsi_dh_remove_device(sdev);
1253 device_enable_async_suspend(&sdev->sdev_dev);
1254 error = device_add(&sdev->sdev_dev);
1256 sdev_printk(KERN_INFO, sdev,
1257 "failed to add class device: %d\n", error);
1258 scsi_dh_remove_device(sdev);
1259 device_del(&sdev->sdev_gendev);
1262 transport_add_device(&sdev->sdev_gendev);
1263 sdev->is_visible = 1;
1265 error = bsg_register_queue(rq, &sdev->sdev_gendev, NULL, NULL);
1268 /* we're treating error on bsg register as non-fatal,
1269 * so pretend nothing went wrong */
1270 sdev_printk(KERN_INFO, sdev,
1271 "Failed to register bsg queue, errno=%d\n", error);
1273 /* add additional host specific attributes */
1274 if (sdev->host->hostt->sdev_attrs) {
1275 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
1276 error = device_create_file(&sdev->sdev_gendev,
1277 sdev->host->hostt->sdev_attrs[i]);
1283 scsi_autopm_put_device(sdev);
1287 void __scsi_remove_device(struct scsi_device *sdev)
1289 struct device *dev = &sdev->sdev_gendev;
1293 * This cleanup path is not reentrant and while it is impossible
1294 * to get a new reference with scsi_device_get() someone can still
1295 * hold a previously acquired one.
1297 if (sdev->sdev_state == SDEV_DEL)
1300 if (sdev->is_visible) {
1302 * If scsi_internal_target_block() is running concurrently,
1303 * wait until it has finished before changing the device state.
1305 mutex_lock(&sdev->state_mutex);
1307 * If blocked, we go straight to DEL and restart the queue so
1308 * any commands issued during driver shutdown (like sync
1309 * cache) are errored immediately.
1311 res = scsi_device_set_state(sdev, SDEV_CANCEL);
1313 res = scsi_device_set_state(sdev, SDEV_DEL);
1315 scsi_start_queue(sdev);
1317 mutex_unlock(&sdev->state_mutex);
1322 bsg_unregister_queue(sdev->request_queue);
1323 device_unregister(&sdev->sdev_dev);
1324 transport_remove_device(dev);
1325 scsi_dh_remove_device(sdev);
1328 put_device(&sdev->sdev_dev);
1331 * Stop accepting new requests and wait until all queuecommand() and
1332 * scsi_run_queue() invocations have finished before tearing down the
1335 mutex_lock(&sdev->state_mutex);
1336 scsi_device_set_state(sdev, SDEV_DEL);
1337 mutex_unlock(&sdev->state_mutex);
1339 blk_cleanup_queue(sdev->request_queue);
1340 cancel_work_sync(&sdev->requeue_work);
1342 if (sdev->host->hostt->slave_destroy)
1343 sdev->host->hostt->slave_destroy(sdev);
1344 transport_destroy_device(dev);
1347 * Paired with the kref_get() in scsi_sysfs_initialize(). We have
1348 * remoed sysfs visibility from the device, so make the target
1349 * invisible if this was the last device underneath it.
1351 scsi_target_reap(scsi_target(sdev));
1357 * scsi_remove_device - unregister a device from the scsi bus
1358 * @sdev: scsi_device to unregister
1360 void scsi_remove_device(struct scsi_device *sdev)
1362 struct Scsi_Host *shost = sdev->host;
1364 mutex_lock(&shost->scan_mutex);
1365 __scsi_remove_device(sdev);
1366 mutex_unlock(&shost->scan_mutex);
1368 EXPORT_SYMBOL(scsi_remove_device);
1370 static void __scsi_remove_target(struct scsi_target *starget)
1372 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1373 unsigned long flags;
1374 struct scsi_device *sdev;
1376 spin_lock_irqsave(shost->host_lock, flags);
1378 list_for_each_entry(sdev, &shost->__devices, siblings) {
1380 * We cannot call scsi_device_get() here, as
1381 * we might've been called from rmmod() causing
1382 * scsi_device_get() to fail the module_is_live()
1385 if (sdev->channel != starget->channel ||
1386 sdev->id != starget->id ||
1387 !get_device(&sdev->sdev_gendev))
1389 spin_unlock_irqrestore(shost->host_lock, flags);
1390 scsi_remove_device(sdev);
1391 put_device(&sdev->sdev_gendev);
1392 spin_lock_irqsave(shost->host_lock, flags);
1395 spin_unlock_irqrestore(shost->host_lock, flags);
1399 * scsi_remove_target - try to remove a target and all its devices
1400 * @dev: generic starget or parent of generic stargets to be removed
1402 * Note: This is slightly racy. It is possible that if the user
1403 * requests the addition of another device then the target won't be
1406 void scsi_remove_target(struct device *dev)
1408 struct Scsi_Host *shost = dev_to_shost(dev->parent);
1409 struct scsi_target *starget;
1410 unsigned long flags;
1413 spin_lock_irqsave(shost->host_lock, flags);
1414 list_for_each_entry(starget, &shost->__targets, siblings) {
1415 if (starget->state == STARGET_DEL ||
1416 starget->state == STARGET_REMOVE ||
1417 starget->state == STARGET_CREATED_REMOVE)
1419 if (starget->dev.parent == dev || &starget->dev == dev) {
1420 kref_get(&starget->reap_ref);
1421 if (starget->state == STARGET_CREATED)
1422 starget->state = STARGET_CREATED_REMOVE;
1424 starget->state = STARGET_REMOVE;
1425 spin_unlock_irqrestore(shost->host_lock, flags);
1426 __scsi_remove_target(starget);
1427 scsi_target_reap(starget);
1431 spin_unlock_irqrestore(shost->host_lock, flags);
1433 EXPORT_SYMBOL(scsi_remove_target);
1435 int scsi_register_driver(struct device_driver *drv)
1437 drv->bus = &scsi_bus_type;
1439 return driver_register(drv);
1441 EXPORT_SYMBOL(scsi_register_driver);
1443 int scsi_register_interface(struct class_interface *intf)
1445 intf->class = &sdev_class;
1447 return class_interface_register(intf);
1449 EXPORT_SYMBOL(scsi_register_interface);
1452 * scsi_sysfs_add_host - add scsi host to subsystem
1453 * @shost: scsi host struct to add to subsystem
1455 int scsi_sysfs_add_host(struct Scsi_Host *shost)
1459 /* add host specific attributes */
1460 if (shost->hostt->shost_attrs) {
1461 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
1462 error = device_create_file(&shost->shost_dev,
1463 shost->hostt->shost_attrs[i]);
1469 transport_register_device(&shost->shost_gendev);
1470 transport_configure_device(&shost->shost_gendev);
1474 static struct device_type scsi_dev_type = {
1475 .name = "scsi_device",
1476 .release = scsi_device_dev_release,
1477 .groups = scsi_sdev_attr_groups,
1480 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
1482 unsigned long flags;
1483 struct Scsi_Host *shost = sdev->host;
1484 struct scsi_target *starget = sdev->sdev_target;
1486 device_initialize(&sdev->sdev_gendev);
1487 sdev->sdev_gendev.bus = &scsi_bus_type;
1488 sdev->sdev_gendev.type = &scsi_dev_type;
1489 dev_set_name(&sdev->sdev_gendev, "%d:%d:%d:%llu",
1490 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1492 device_initialize(&sdev->sdev_dev);
1493 sdev->sdev_dev.parent = get_device(&sdev->sdev_gendev);
1494 sdev->sdev_dev.class = &sdev_class;
1495 dev_set_name(&sdev->sdev_dev, "%d:%d:%d:%llu",
1496 sdev->host->host_no, sdev->channel, sdev->id, sdev->lun);
1498 * Get a default scsi_level from the target (derived from sibling
1499 * devices). This is the best we can do for guessing how to set
1500 * sdev->lun_in_cdb for the initial INQUIRY command. For LUN 0 the
1501 * setting doesn't matter, because all the bits are zero anyway.
1502 * But it does matter for higher LUNs.
1504 sdev->scsi_level = starget->scsi_level;
1505 if (sdev->scsi_level <= SCSI_2 &&
1506 sdev->scsi_level != SCSI_UNKNOWN &&
1507 !shost->no_scsi2_lun_in_cdb)
1508 sdev->lun_in_cdb = 1;
1510 transport_setup_device(&sdev->sdev_gendev);
1511 spin_lock_irqsave(shost->host_lock, flags);
1512 list_add_tail(&sdev->same_target_siblings, &starget->devices);
1513 list_add_tail(&sdev->siblings, &shost->__devices);
1514 spin_unlock_irqrestore(shost->host_lock, flags);
1516 * device can now only be removed via __scsi_remove_device() so hold
1517 * the target. Target will be held in CREATED state until something
1518 * beneath it becomes visible (in which case it moves to RUNNING)
1520 kref_get(&starget->reap_ref);
1523 int scsi_is_sdev_device(const struct device *dev)
1525 return dev->type == &scsi_dev_type;
1527 EXPORT_SYMBOL(scsi_is_sdev_device);
1529 /* A blank transport template that is used in drivers that don't
1530 * yet implement Transport Attributes */
1531 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };