4 * SCSI sysfs interface routines.
6 * Created to pull SCSI mid layer sysfs routines into one file.
9 #include <linux/config.h>
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/blkdev.h>
13 #include <linux/device.h>
15 #include <scsi/scsi.h>
16 #include <scsi/scsi_device.h>
17 #include <scsi/scsi_host.h>
18 #include <scsi/scsi_tcq.h>
19 #include <scsi/scsi_transport.h>
21 #include "scsi_priv.h"
22 #include "scsi_logging.h"
25 enum scsi_device_state value;
28 { SDEV_CREATED, "created" },
29 { SDEV_RUNNING, "running" },
30 { SDEV_CANCEL, "cancel" },
31 { SDEV_DEL, "deleted" },
32 { SDEV_QUIESCE, "quiesce" },
33 { SDEV_OFFLINE, "offline" },
34 { SDEV_BLOCK, "blocked" },
37 const char *scsi_device_state_name(enum scsi_device_state state)
42 for (i = 0; i < sizeof(sdev_states)/sizeof(sdev_states[0]); i++) {
43 if (sdev_states[i].value == state) {
44 name = sdev_states[i].name;
52 enum scsi_host_state value;
55 { SHOST_CREATED, "created" },
56 { SHOST_RUNNING, "running" },
57 { SHOST_CANCEL, "cancel" },
58 { SHOST_DEL, "deleted" },
59 { SHOST_RECOVERY, "recovery" },
60 { SHOST_CANCEL_RECOVERY, "cancel/recovery" },
61 { SHOST_DEL_RECOVERY, "deleted/recovery", },
63 const char *scsi_host_state_name(enum scsi_host_state state)
68 for (i = 0; i < sizeof(shost_states)/sizeof(shost_states[0]); i++) {
69 if (shost_states[i].value == state) {
70 name = shost_states[i].name;
77 static int check_set(unsigned int *val, char *src)
81 if (strncmp(src, "-", 20) == 0) {
82 *val = SCAN_WILD_CARD;
85 * Doesn't check for int overflow
87 *val = simple_strtoul(src, &last, 0);
94 static int scsi_scan(struct Scsi_Host *shost, const char *str)
96 char s1[15], s2[15], s3[15], junk;
97 unsigned int channel, id, lun;
100 res = sscanf(str, "%10s %10s %10s %c", s1, s2, s3, &junk);
103 if (check_set(&channel, s1))
105 if (check_set(&id, s2))
107 if (check_set(&lun, s3))
109 if (shost->transportt->user_scan)
110 res = shost->transportt->user_scan(shost, channel, id, lun);
112 res = scsi_scan_host_selected(shost, channel, id, lun, 1);
117 * shost_show_function: macro to create an attr function that can be used to
118 * show a non-bit field.
120 #define shost_show_function(name, field, format_string) \
122 show_##name (struct class_device *class_dev, char *buf) \
124 struct Scsi_Host *shost = class_to_shost(class_dev); \
125 return snprintf (buf, 20, format_string, shost->field); \
129 * shost_rd_attr: macro to create a function and attribute variable for a
132 #define shost_rd_attr2(name, field, format_string) \
133 shost_show_function(name, field, format_string) \
134 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
136 #define shost_rd_attr(field, format_string) \
137 shost_rd_attr2(field, field, format_string)
140 * Create the actual show/store functions and data structures.
143 static ssize_t store_scan(struct class_device *class_dev, const char *buf,
146 struct Scsi_Host *shost = class_to_shost(class_dev);
149 res = scsi_scan(shost, buf);
154 static CLASS_DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);
157 store_shost_state(struct class_device *class_dev, const char *buf, size_t count)
160 struct Scsi_Host *shost = class_to_shost(class_dev);
161 enum scsi_host_state state = 0;
163 for (i = 0; i < sizeof(shost_states)/sizeof(shost_states[0]); i++) {
164 const int len = strlen(shost_states[i].name);
165 if (strncmp(shost_states[i].name, buf, len) == 0 &&
167 state = shost_states[i].value;
174 if (scsi_host_set_state(shost, state))
180 show_shost_state(struct class_device *class_dev, char *buf)
182 struct Scsi_Host *shost = class_to_shost(class_dev);
183 const char *name = scsi_host_state_name(shost->shost_state);
188 return snprintf(buf, 20, "%s\n", name);
191 static CLASS_DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_shost_state, store_shost_state);
193 shost_rd_attr(unique_id, "%u\n");
194 shost_rd_attr(host_busy, "%hu\n");
195 shost_rd_attr(cmd_per_lun, "%hd\n");
196 shost_rd_attr(sg_tablesize, "%hu\n");
197 shost_rd_attr(unchecked_isa_dma, "%d\n");
198 shost_rd_attr2(proc_name, hostt->proc_name, "%s\n");
200 static struct class_device_attribute *scsi_sysfs_shost_attrs[] = {
201 &class_device_attr_unique_id,
202 &class_device_attr_host_busy,
203 &class_device_attr_cmd_per_lun,
204 &class_device_attr_sg_tablesize,
205 &class_device_attr_unchecked_isa_dma,
206 &class_device_attr_proc_name,
207 &class_device_attr_scan,
208 &class_device_attr_state,
212 static void scsi_device_cls_release(struct class_device *class_dev)
214 struct scsi_device *sdev;
216 sdev = class_to_sdev(class_dev);
217 put_device(&sdev->sdev_gendev);
220 static void scsi_device_dev_release(struct device *dev)
222 struct scsi_device *sdev;
223 struct device *parent;
224 struct scsi_target *starget;
227 parent = dev->parent;
228 sdev = to_scsi_device(dev);
229 starget = to_scsi_target(parent);
231 spin_lock_irqsave(sdev->host->host_lock, flags);
233 list_del(&sdev->siblings);
234 list_del(&sdev->same_target_siblings);
235 list_del(&sdev->starved_entry);
236 spin_unlock_irqrestore(sdev->host->host_lock, flags);
238 if (sdev->request_queue) {
239 sdev->request_queue->queuedata = NULL;
240 scsi_free_queue(sdev->request_queue);
241 /* temporary expedient, try to catch use of queue lock
242 * after free of sdev */
243 sdev->request_queue = NULL;
246 scsi_target_reap(scsi_target(sdev));
248 kfree(sdev->inquiry);
255 static struct class sdev_class = {
256 .name = "scsi_device",
257 .release = scsi_device_cls_release,
260 /* all probing is done in the individual ->probe routines */
261 static int scsi_bus_match(struct device *dev, struct device_driver *gendrv)
263 struct scsi_device *sdp = to_scsi_device(dev);
264 if (sdp->no_uld_attach)
266 return (sdp->inq_periph_qual == SCSI_INQ_PQ_CON)? 1: 0;
269 static int scsi_bus_suspend(struct device * dev, pm_message_t state)
271 struct scsi_device *sdev = to_scsi_device(dev);
272 struct scsi_host_template *sht = sdev->host->hostt;
275 err = scsi_device_quiesce(sdev);
280 err = sht->suspend(sdev);
285 static int scsi_bus_resume(struct device * dev)
287 struct scsi_device *sdev = to_scsi_device(dev);
288 struct scsi_host_template *sht = sdev->host->hostt;
292 err = sht->resume(sdev);
294 scsi_device_resume(sdev);
298 struct bus_type scsi_bus_type = {
300 .match = scsi_bus_match,
301 .suspend = scsi_bus_suspend,
302 .resume = scsi_bus_resume,
305 int scsi_sysfs_register(void)
309 error = bus_register(&scsi_bus_type);
311 error = class_register(&sdev_class);
313 bus_unregister(&scsi_bus_type);
319 void scsi_sysfs_unregister(void)
321 class_unregister(&sdev_class);
322 bus_unregister(&scsi_bus_type);
326 * sdev_show_function: macro to create an attr function that can be used to
327 * show a non-bit field.
329 #define sdev_show_function(field, format_string) \
331 sdev_show_##field (struct device *dev, struct device_attribute *attr, char *buf) \
333 struct scsi_device *sdev; \
334 sdev = to_scsi_device(dev); \
335 return snprintf (buf, 20, format_string, sdev->field); \
339 * sdev_rd_attr: macro to create a function and attribute variable for a
342 #define sdev_rd_attr(field, format_string) \
343 sdev_show_function(field, format_string) \
344 static DEVICE_ATTR(field, S_IRUGO, sdev_show_##field, NULL);
348 * sdev_rd_attr: create a function and attribute variable for a
351 #define sdev_rw_attr(field, format_string) \
352 sdev_show_function(field, format_string) \
355 sdev_store_##field (struct device *dev, struct device_attribute *attr, const char *buf, size_t count) \
357 struct scsi_device *sdev; \
358 sdev = to_scsi_device(dev); \
359 snscanf (buf, 20, format_string, &sdev->field); \
362 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
364 /* Currently we don't export bit fields, but we might in future,
365 * so leave this code in */
368 * sdev_rd_attr: create a function and attribute variable for a
369 * read/write bit field.
371 #define sdev_rw_attr_bit(field) \
372 sdev_show_function(field, "%d\n") \
375 sdev_store_##field (struct device *dev, struct device_attribute *attr, const char *buf, size_t count) \
378 struct scsi_device *sdev; \
379 ret = scsi_sdev_check_buf_bit(buf); \
381 sdev = to_scsi_device(dev); \
387 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, sdev_show_##field, sdev_store_##field);
390 * scsi_sdev_check_buf_bit: return 0 if buf is "0", return 1 if buf is "1",
391 * else return -EINVAL.
393 static int scsi_sdev_check_buf_bit(const char *buf)
395 if ((buf[1] == '\0') || ((buf[1] == '\n') && (buf[2] == '\0'))) {
398 else if (buf[0] == '0')
407 * Create the actual show/store functions and data structures.
409 sdev_rd_attr (device_blocked, "%d\n");
410 sdev_rd_attr (queue_depth, "%d\n");
411 sdev_rd_attr (type, "%d\n");
412 sdev_rd_attr (scsi_level, "%d\n");
413 sdev_rd_attr (vendor, "%.8s\n");
414 sdev_rd_attr (model, "%.16s\n");
415 sdev_rd_attr (rev, "%.4s\n");
418 sdev_show_timeout (struct device *dev, struct device_attribute *attr, char *buf)
420 struct scsi_device *sdev;
421 sdev = to_scsi_device(dev);
422 return snprintf (buf, 20, "%d\n", sdev->timeout / HZ);
426 sdev_store_timeout (struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
428 struct scsi_device *sdev;
430 sdev = to_scsi_device(dev);
431 sscanf (buf, "%d\n", &timeout);
432 sdev->timeout = timeout * HZ;
435 static DEVICE_ATTR(timeout, S_IRUGO | S_IWUSR, sdev_show_timeout, sdev_store_timeout);
438 store_rescan_field (struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
440 scsi_rescan_device(dev);
443 static DEVICE_ATTR(rescan, S_IWUSR, NULL, store_rescan_field);
445 static ssize_t sdev_store_delete(struct device *dev, struct device_attribute *attr, const char *buf,
448 scsi_remove_device(to_scsi_device(dev));
451 static DEVICE_ATTR(delete, S_IWUSR, NULL, sdev_store_delete);
454 store_state_field(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
457 struct scsi_device *sdev = to_scsi_device(dev);
458 enum scsi_device_state state = 0;
460 for (i = 0; i < sizeof(sdev_states)/sizeof(sdev_states[0]); i++) {
461 const int len = strlen(sdev_states[i].name);
462 if (strncmp(sdev_states[i].name, buf, len) == 0 &&
464 state = sdev_states[i].value;
471 if (scsi_device_set_state(sdev, state))
477 show_state_field(struct device *dev, struct device_attribute *attr, char *buf)
479 struct scsi_device *sdev = to_scsi_device(dev);
480 const char *name = scsi_device_state_name(sdev->sdev_state);
485 return snprintf(buf, 20, "%s\n", name);
488 static DEVICE_ATTR(state, S_IRUGO | S_IWUSR, show_state_field, store_state_field);
491 show_queue_type_field(struct device *dev, struct device_attribute *attr, char *buf)
493 struct scsi_device *sdev = to_scsi_device(dev);
494 const char *name = "none";
496 if (sdev->ordered_tags)
498 else if (sdev->simple_tags)
501 return snprintf(buf, 20, "%s\n", name);
504 static DEVICE_ATTR(queue_type, S_IRUGO, show_queue_type_field, NULL);
507 show_iostat_counterbits(struct device *dev, struct device_attribute *attr, char *buf)
509 return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
512 static DEVICE_ATTR(iocounterbits, S_IRUGO, show_iostat_counterbits, NULL);
514 #define show_sdev_iostat(field) \
516 show_iostat_##field(struct device *dev, struct device_attribute *attr, char *buf) \
518 struct scsi_device *sdev = to_scsi_device(dev); \
519 unsigned long long count = atomic_read(&sdev->field); \
520 return snprintf(buf, 20, "0x%llx\n", count); \
522 static DEVICE_ATTR(field, S_IRUGO, show_iostat_##field, NULL)
524 show_sdev_iostat(iorequest_cnt);
525 show_sdev_iostat(iodone_cnt);
526 show_sdev_iostat(ioerr_cnt);
529 /* Default template for device attributes. May NOT be modified */
530 static struct device_attribute *scsi_sysfs_sdev_attrs[] = {
531 &dev_attr_device_blocked,
532 &dev_attr_queue_depth,
533 &dev_attr_queue_type,
535 &dev_attr_scsi_level,
543 &dev_attr_iocounterbits,
544 &dev_attr_iorequest_cnt,
545 &dev_attr_iodone_cnt,
550 static ssize_t sdev_store_queue_depth_rw(struct device *dev, struct device_attribute *attr, const char *buf,
554 struct scsi_device *sdev = to_scsi_device(dev);
555 struct scsi_host_template *sht = sdev->host->hostt;
557 if (!sht->change_queue_depth)
560 depth = simple_strtoul(buf, NULL, 0);
565 retval = sht->change_queue_depth(sdev, depth);
572 static struct device_attribute sdev_attr_queue_depth_rw =
573 __ATTR(queue_depth, S_IRUGO | S_IWUSR, sdev_show_queue_depth,
574 sdev_store_queue_depth_rw);
576 static ssize_t sdev_store_queue_type_rw(struct device *dev, struct device_attribute *attr, const char *buf,
579 struct scsi_device *sdev = to_scsi_device(dev);
580 struct scsi_host_template *sht = sdev->host->hostt;
581 int tag_type = 0, retval;
582 int prev_tag_type = scsi_get_tag_type(sdev);
584 if (!sdev->tagged_supported || !sht->change_queue_type)
587 if (strncmp(buf, "ordered", 7) == 0)
588 tag_type = MSG_ORDERED_TAG;
589 else if (strncmp(buf, "simple", 6) == 0)
590 tag_type = MSG_SIMPLE_TAG;
591 else if (strncmp(buf, "none", 4) != 0)
594 if (tag_type == prev_tag_type)
597 retval = sht->change_queue_type(sdev, tag_type);
604 static struct device_attribute sdev_attr_queue_type_rw =
605 __ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
606 sdev_store_queue_type_rw);
608 static struct device_attribute *attr_changed_internally(
609 struct Scsi_Host *shost,
610 struct device_attribute * attr)
612 if (!strcmp("queue_depth", attr->attr.name)
613 && shost->hostt->change_queue_depth)
614 return &sdev_attr_queue_depth_rw;
615 else if (!strcmp("queue_type", attr->attr.name)
616 && shost->hostt->change_queue_type)
617 return &sdev_attr_queue_type_rw;
622 static struct device_attribute *attr_overridden(
623 struct device_attribute **attrs,
624 struct device_attribute *attr)
630 for (i = 0; attrs[i]; i++)
631 if (!strcmp(attrs[i]->attr.name, attr->attr.name))
636 static int attr_add(struct device *dev, struct device_attribute *attr)
638 struct device_attribute *base_attr;
641 * Spare the caller from having to copy things it's not interested in.
643 base_attr = attr_overridden(scsi_sysfs_sdev_attrs, attr);
645 /* extend permissions */
646 attr->attr.mode |= base_attr->attr.mode;
648 /* override null show/store with default */
650 attr->show = base_attr->show;
652 attr->store = base_attr->store;
655 return device_create_file(dev, attr);
659 * scsi_sysfs_add_sdev - add scsi device to sysfs
660 * @sdev: scsi_device to add
663 * 0 on Success / non-zero on Failure
665 int scsi_sysfs_add_sdev(struct scsi_device *sdev)
669 if ((error = scsi_device_set_state(sdev, SDEV_RUNNING)) != 0)
672 error = device_add(&sdev->sdev_gendev);
674 put_device(sdev->sdev_gendev.parent);
675 printk(KERN_INFO "error 1\n");
678 error = class_device_add(&sdev->sdev_classdev);
680 printk(KERN_INFO "error 2\n");
684 /* take a reference for the sdev_classdev; this is
685 * released by the sdev_class .release */
686 get_device(&sdev->sdev_gendev);
687 if (sdev->host->hostt->sdev_attrs) {
688 for (i = 0; sdev->host->hostt->sdev_attrs[i]; i++) {
689 error = attr_add(&sdev->sdev_gendev,
690 sdev->host->hostt->sdev_attrs[i]);
692 __scsi_remove_device(sdev);
698 for (i = 0; scsi_sysfs_sdev_attrs[i]; i++) {
699 if (!attr_overridden(sdev->host->hostt->sdev_attrs,
700 scsi_sysfs_sdev_attrs[i])) {
701 struct device_attribute * attr =
702 attr_changed_internally(sdev->host,
703 scsi_sysfs_sdev_attrs[i]);
704 error = device_create_file(&sdev->sdev_gendev, attr);
706 __scsi_remove_device(sdev);
712 transport_add_device(&sdev->sdev_gendev);
717 scsi_device_set_state(sdev, SDEV_CANCEL);
719 device_del(&sdev->sdev_gendev);
720 transport_destroy_device(&sdev->sdev_gendev);
721 put_device(&sdev->sdev_gendev);
726 void __scsi_remove_device(struct scsi_device *sdev)
728 struct device *dev = &sdev->sdev_gendev;
730 if (scsi_device_set_state(sdev, SDEV_CANCEL) != 0)
733 class_device_unregister(&sdev->sdev_classdev);
734 transport_remove_device(dev);
736 scsi_device_set_state(sdev, SDEV_DEL);
737 if (sdev->host->hostt->slave_destroy)
738 sdev->host->hostt->slave_destroy(sdev);
739 transport_destroy_device(dev);
744 * scsi_remove_device - unregister a device from the scsi bus
745 * @sdev: scsi_device to unregister
747 void scsi_remove_device(struct scsi_device *sdev)
749 struct Scsi_Host *shost = sdev->host;
751 mutex_lock(&shost->scan_mutex);
752 __scsi_remove_device(sdev);
753 mutex_unlock(&shost->scan_mutex);
755 EXPORT_SYMBOL(scsi_remove_device);
757 void __scsi_remove_target(struct scsi_target *starget)
759 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
761 struct scsi_device *sdev;
763 spin_lock_irqsave(shost->host_lock, flags);
766 list_for_each_entry(sdev, &shost->__devices, siblings) {
767 if (sdev->channel != starget->channel ||
768 sdev->id != starget->id ||
769 sdev->sdev_state == SDEV_DEL)
771 spin_unlock_irqrestore(shost->host_lock, flags);
772 scsi_remove_device(sdev);
773 spin_lock_irqsave(shost->host_lock, flags);
776 spin_unlock_irqrestore(shost->host_lock, flags);
777 scsi_target_reap(starget);
780 static int __remove_child (struct device * dev, void * data)
782 if (scsi_is_target_device(dev))
783 __scsi_remove_target(to_scsi_target(dev));
788 * scsi_remove_target - try to remove a target and all its devices
789 * @dev: generic starget or parent of generic stargets to be removed
791 * Note: This is slightly racy. It is possible that if the user
792 * requests the addition of another device then the target won't be
795 void scsi_remove_target(struct device *dev)
799 if (scsi_is_target_device(dev)) {
800 __scsi_remove_target(to_scsi_target(dev));
804 rdev = get_device(dev);
805 device_for_each_child(dev, NULL, __remove_child);
808 EXPORT_SYMBOL(scsi_remove_target);
810 int scsi_register_driver(struct device_driver *drv)
812 drv->bus = &scsi_bus_type;
814 return driver_register(drv);
816 EXPORT_SYMBOL(scsi_register_driver);
818 int scsi_register_interface(struct class_interface *intf)
820 intf->class = &sdev_class;
822 return class_interface_register(intf);
824 EXPORT_SYMBOL(scsi_register_interface);
827 static struct class_device_attribute *class_attr_overridden(
828 struct class_device_attribute **attrs,
829 struct class_device_attribute *attr)
835 for (i = 0; attrs[i]; i++)
836 if (!strcmp(attrs[i]->attr.name, attr->attr.name))
841 static int class_attr_add(struct class_device *classdev,
842 struct class_device_attribute *attr)
844 struct class_device_attribute *base_attr;
847 * Spare the caller from having to copy things it's not interested in.
849 base_attr = class_attr_overridden(scsi_sysfs_shost_attrs, attr);
851 /* extend permissions */
852 attr->attr.mode |= base_attr->attr.mode;
854 /* override null show/store with default */
856 attr->show = base_attr->show;
858 attr->store = base_attr->store;
861 return class_device_create_file(classdev, attr);
865 * scsi_sysfs_add_host - add scsi host to subsystem
866 * @shost: scsi host struct to add to subsystem
867 * @dev: parent struct device pointer
869 int scsi_sysfs_add_host(struct Scsi_Host *shost)
873 if (shost->hostt->shost_attrs) {
874 for (i = 0; shost->hostt->shost_attrs[i]; i++) {
875 error = class_attr_add(&shost->shost_classdev,
876 shost->hostt->shost_attrs[i]);
882 for (i = 0; scsi_sysfs_shost_attrs[i]; i++) {
883 if (!class_attr_overridden(shost->hostt->shost_attrs,
884 scsi_sysfs_shost_attrs[i])) {
885 error = class_device_create_file(&shost->shost_classdev,
886 scsi_sysfs_shost_attrs[i]);
892 transport_register_device(&shost->shost_gendev);
896 void scsi_sysfs_device_initialize(struct scsi_device *sdev)
899 struct Scsi_Host *shost = sdev->host;
900 struct scsi_target *starget = sdev->sdev_target;
902 device_initialize(&sdev->sdev_gendev);
903 sdev->sdev_gendev.bus = &scsi_bus_type;
904 sdev->sdev_gendev.release = scsi_device_dev_release;
905 sprintf(sdev->sdev_gendev.bus_id,"%d:%d:%d:%d",
906 sdev->host->host_no, sdev->channel, sdev->id,
909 class_device_initialize(&sdev->sdev_classdev);
910 sdev->sdev_classdev.dev = &sdev->sdev_gendev;
911 sdev->sdev_classdev.class = &sdev_class;
912 snprintf(sdev->sdev_classdev.class_id, BUS_ID_SIZE,
913 "%d:%d:%d:%d", sdev->host->host_no,
914 sdev->channel, sdev->id, sdev->lun);
915 sdev->scsi_level = SCSI_2;
916 transport_setup_device(&sdev->sdev_gendev);
917 spin_lock_irqsave(shost->host_lock, flags);
918 list_add_tail(&sdev->same_target_siblings, &starget->devices);
919 list_add_tail(&sdev->siblings, &shost->__devices);
920 spin_unlock_irqrestore(shost->host_lock, flags);
923 int scsi_is_sdev_device(const struct device *dev)
925 return dev->release == scsi_device_dev_release;
927 EXPORT_SYMBOL(scsi_is_sdev_device);
929 /* A blank transport template that is used in drivers that don't
930 * yet implement Transport Attributes */
931 struct scsi_transport_template blank_transport_template = { { { {NULL, }, }, }, };