2 * drivers/usb/core/sysfs.c
4 * (C) Copyright 2002 David Brownell
5 * (C) Copyright 2002,2004 Greg Kroah-Hartman
6 * (C) Copyright 2002,2004 IBM Corp.
8 * All of the sysfs file attributes for usb devices and interfaces.
13 #include <linux/kernel.h>
14 #include <linux/string.h>
15 #include <linux/usb.h>
16 #include <linux/usb/quirks.h>
19 /* Active configuration fields */
20 #define usb_actconfig_show(field, multiplier, format_string) \
21 static ssize_t show_##field(struct device *dev, \
22 struct device_attribute *attr, char *buf) \
24 struct usb_device *udev; \
25 struct usb_host_config *actconfig; \
27 udev = to_usb_device(dev); \
28 actconfig = udev->actconfig; \
30 return sprintf(buf, format_string, \
31 actconfig->desc.field * multiplier); \
36 #define usb_actconfig_attr(field, multiplier, format_string) \
37 usb_actconfig_show(field, multiplier, format_string) \
38 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
40 usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
41 usb_actconfig_attr(bmAttributes, 1, "%2x\n")
42 usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
44 static ssize_t show_configuration_string(struct device *dev,
45 struct device_attribute *attr, char *buf)
47 struct usb_device *udev;
48 struct usb_host_config *actconfig;
50 udev = to_usb_device(dev);
51 actconfig = udev->actconfig;
52 if ((!actconfig) || (!actconfig->string))
54 return sprintf(buf, "%s\n", actconfig->string);
56 static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
58 /* configuration value is always present, and r/w */
59 usb_actconfig_show(bConfigurationValue, 1, "%u\n");
62 set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
63 const char *buf, size_t count)
65 struct usb_device *udev = to_usb_device(dev);
68 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
70 usb_lock_device(udev);
71 value = usb_set_configuration(udev, config);
72 usb_unlock_device(udev);
73 return (value < 0) ? value : count;
76 static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
77 show_bConfigurationValue, set_bConfigurationValue);
80 #define usb_string_attr(name) \
81 static ssize_t show_##name(struct device *dev, \
82 struct device_attribute *attr, char *buf) \
84 struct usb_device *udev; \
86 udev = to_usb_device(dev); \
87 return sprintf(buf, "%s\n", udev->name); \
89 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
91 usb_string_attr(product);
92 usb_string_attr(manufacturer);
93 usb_string_attr(serial);
96 show_speed(struct device *dev, struct device_attribute *attr, char *buf)
98 struct usb_device *udev;
101 udev = to_usb_device(dev);
103 switch (udev->speed) {
107 case USB_SPEED_UNKNOWN:
117 return sprintf(buf, "%s\n", speed);
119 static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
122 show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
124 struct usb_device *udev;
126 udev = to_usb_device(dev);
127 return sprintf(buf, "%d\n", udev->bus->busnum);
129 static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
132 show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
134 struct usb_device *udev;
136 udev = to_usb_device(dev);
137 return sprintf(buf, "%d\n", udev->devnum);
139 static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
142 show_devpath(struct device *dev, struct device_attribute *attr, char *buf)
144 struct usb_device *udev;
146 udev = to_usb_device(dev);
147 return sprintf(buf, "%s\n", udev->devpath);
149 static DEVICE_ATTR(devpath, S_IRUGO, show_devpath, NULL);
152 show_version(struct device *dev, struct device_attribute *attr, char *buf)
154 struct usb_device *udev;
157 udev = to_usb_device(dev);
158 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
159 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
161 static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
164 show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
166 struct usb_device *udev;
168 udev = to_usb_device(dev);
169 return sprintf(buf, "%d\n", udev->maxchild);
171 static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
174 show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
176 struct usb_device *udev;
178 udev = to_usb_device(dev);
179 return sprintf(buf, "0x%x\n", udev->quirks);
181 static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
184 show_urbnum(struct device *dev, struct device_attribute *attr, char *buf)
186 struct usb_device *udev;
188 udev = to_usb_device(dev);
189 return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
191 static DEVICE_ATTR(urbnum, S_IRUGO, show_urbnum, NULL);
196 static const char power_group[] = "power";
199 show_persist(struct device *dev, struct device_attribute *attr, char *buf)
201 struct usb_device *udev = to_usb_device(dev);
203 return sprintf(buf, "%d\n", udev->persist_enabled);
207 set_persist(struct device *dev, struct device_attribute *attr,
208 const char *buf, size_t count)
210 struct usb_device *udev = to_usb_device(dev);
213 /* Hubs are always enabled for USB_PERSIST */
214 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
217 if (sscanf(buf, "%d", &value) != 1)
220 udev->persist_enabled = !!value;
225 static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
227 static int add_persist_attributes(struct device *dev)
231 if (is_usb_device(dev)) {
232 struct usb_device *udev = to_usb_device(dev);
234 /* Hubs are automatically enabled for USB_PERSIST,
235 * no point in creating the attribute file.
237 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
238 rc = sysfs_add_file_to_group(&dev->kobj,
239 &dev_attr_persist.attr,
245 static void remove_persist_attributes(struct device *dev)
247 sysfs_remove_file_from_group(&dev->kobj,
248 &dev_attr_persist.attr,
253 #define add_persist_attributes(dev) 0
254 #define remove_persist_attributes(dev) do {} while (0)
256 #endif /* CONFIG_PM */
258 #ifdef CONFIG_USB_SUSPEND
261 show_connected_duration(struct device *dev, struct device_attribute *attr,
264 struct usb_device *udev = to_usb_device(dev);
266 return sprintf(buf, "%u\n",
267 jiffies_to_msecs(jiffies - udev->connect_time));
270 static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
273 * If the device is resumed, the last time the device was suspended has
274 * been pre-subtracted from active_duration. We add the current time to
275 * get the duration that the device was actually active.
277 * If the device is suspended, the active_duration is up-to-date.
280 show_active_duration(struct device *dev, struct device_attribute *attr,
283 struct usb_device *udev = to_usb_device(dev);
286 if (udev->state != USB_STATE_SUSPENDED)
287 duration = jiffies_to_msecs(jiffies + udev->active_duration);
289 duration = jiffies_to_msecs(udev->active_duration);
290 return sprintf(buf, "%u\n", duration);
293 static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
296 show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
298 struct usb_device *udev = to_usb_device(dev);
300 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
304 set_autosuspend(struct device *dev, struct device_attribute *attr,
305 const char *buf, size_t count)
307 struct usb_device *udev = to_usb_device(dev);
310 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
311 value <= - INT_MAX/HZ)
315 udev->autosuspend_delay = value;
317 usb_try_autosuspend_device(udev);
319 if (usb_autoresume_device(udev) == 0)
320 usb_autosuspend_device(udev);
325 static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
326 show_autosuspend, set_autosuspend);
328 static const char on_string[] = "on";
329 static const char auto_string[] = "auto";
332 show_level(struct device *dev, struct device_attribute *attr, char *buf)
334 struct usb_device *udev = to_usb_device(dev);
335 const char *p = auto_string;
337 if (udev->state != USB_STATE_SUSPENDED && udev->autosuspend_disabled)
339 return sprintf(buf, "%s\n", p);
343 set_level(struct device *dev, struct device_attribute *attr,
344 const char *buf, size_t count)
346 struct usb_device *udev = to_usb_device(dev);
350 int old_autosuspend_disabled;
352 cp = memchr(buf, '\n', count);
356 usb_lock_device(udev);
357 old_autosuspend_disabled = udev->autosuspend_disabled;
359 /* Setting the flags without calling usb_pm_lock is a subject to
360 * races, but who cares...
362 if (len == sizeof on_string - 1 &&
363 strncmp(buf, on_string, len) == 0) {
364 udev->autosuspend_disabled = 1;
365 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
367 } else if (len == sizeof auto_string - 1 &&
368 strncmp(buf, auto_string, len) == 0) {
369 udev->autosuspend_disabled = 0;
370 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
376 udev->autosuspend_disabled = old_autosuspend_disabled;
377 usb_unlock_device(udev);
378 return (rc < 0 ? rc : count);
381 static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
383 static int add_power_attributes(struct device *dev)
387 if (is_usb_device(dev)) {
388 rc = sysfs_add_file_to_group(&dev->kobj,
389 &dev_attr_autosuspend.attr,
392 rc = sysfs_add_file_to_group(&dev->kobj,
393 &dev_attr_level.attr,
396 rc = sysfs_add_file_to_group(&dev->kobj,
397 &dev_attr_connected_duration.attr,
400 rc = sysfs_add_file_to_group(&dev->kobj,
401 &dev_attr_active_duration.attr,
407 static void remove_power_attributes(struct device *dev)
409 sysfs_remove_file_from_group(&dev->kobj,
410 &dev_attr_active_duration.attr,
412 sysfs_remove_file_from_group(&dev->kobj,
413 &dev_attr_connected_duration.attr,
415 sysfs_remove_file_from_group(&dev->kobj,
416 &dev_attr_level.attr,
418 sysfs_remove_file_from_group(&dev->kobj,
419 &dev_attr_autosuspend.attr,
425 #define add_power_attributes(dev) 0
426 #define remove_power_attributes(dev) do {} while (0)
428 #endif /* CONFIG_USB_SUSPEND */
431 /* Descriptor fields */
432 #define usb_descriptor_attr_le16(field, format_string) \
434 show_##field(struct device *dev, struct device_attribute *attr, \
437 struct usb_device *udev; \
439 udev = to_usb_device(dev); \
440 return sprintf(buf, format_string, \
441 le16_to_cpu(udev->descriptor.field)); \
443 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
445 usb_descriptor_attr_le16(idVendor, "%04x\n")
446 usb_descriptor_attr_le16(idProduct, "%04x\n")
447 usb_descriptor_attr_le16(bcdDevice, "%04x\n")
449 #define usb_descriptor_attr(field, format_string) \
451 show_##field(struct device *dev, struct device_attribute *attr, \
454 struct usb_device *udev; \
456 udev = to_usb_device(dev); \
457 return sprintf(buf, format_string, udev->descriptor.field); \
459 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
461 usb_descriptor_attr(bDeviceClass, "%02x\n")
462 usb_descriptor_attr(bDeviceSubClass, "%02x\n")
463 usb_descriptor_attr(bDeviceProtocol, "%02x\n")
464 usb_descriptor_attr(bNumConfigurations, "%d\n")
465 usb_descriptor_attr(bMaxPacketSize0, "%d\n")
469 /* show if the device is authorized (1) or not (0) */
470 static ssize_t usb_dev_authorized_show(struct device *dev,
471 struct device_attribute *attr,
474 struct usb_device *usb_dev = to_usb_device(dev);
475 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
480 * Authorize a device to be used in the system
482 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
484 static ssize_t usb_dev_authorized_store(struct device *dev,
485 struct device_attribute *attr,
486 const char *buf, size_t size)
489 struct usb_device *usb_dev = to_usb_device(dev);
491 result = sscanf(buf, "%u\n", &val);
495 result = usb_deauthorize_device(usb_dev);
497 result = usb_authorize_device(usb_dev);
498 return result < 0? result : size;
501 static DEVICE_ATTR(authorized, 0644,
502 usb_dev_authorized_show, usb_dev_authorized_store);
504 /* "Safely remove a device" */
505 static ssize_t usb_remove_store(struct device *dev,
506 struct device_attribute *attr,
507 const char *buf, size_t count)
509 struct usb_device *udev = to_usb_device(dev);
512 usb_lock_device(udev);
513 if (udev->state != USB_STATE_NOTATTACHED) {
515 /* To avoid races, first unconfigure and then remove */
516 usb_set_configuration(udev, -1);
517 rc = usb_remove_device(udev);
521 usb_unlock_device(udev);
524 static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
527 static struct attribute *dev_attrs[] = {
528 /* current configuration's attributes */
529 &dev_attr_configuration.attr,
530 &dev_attr_bNumInterfaces.attr,
531 &dev_attr_bConfigurationValue.attr,
532 &dev_attr_bmAttributes.attr,
533 &dev_attr_bMaxPower.attr,
534 /* device attributes */
535 &dev_attr_urbnum.attr,
536 &dev_attr_idVendor.attr,
537 &dev_attr_idProduct.attr,
538 &dev_attr_bcdDevice.attr,
539 &dev_attr_bDeviceClass.attr,
540 &dev_attr_bDeviceSubClass.attr,
541 &dev_attr_bDeviceProtocol.attr,
542 &dev_attr_bNumConfigurations.attr,
543 &dev_attr_bMaxPacketSize0.attr,
544 &dev_attr_speed.attr,
545 &dev_attr_busnum.attr,
546 &dev_attr_devnum.attr,
547 &dev_attr_devpath.attr,
548 &dev_attr_version.attr,
549 &dev_attr_maxchild.attr,
550 &dev_attr_quirks.attr,
551 &dev_attr_authorized.attr,
552 &dev_attr_remove.attr,
555 static struct attribute_group dev_attr_grp = {
559 /* When modifying this list, be sure to modify dev_string_attrs_are_visible()
562 static struct attribute *dev_string_attrs[] = {
563 &dev_attr_manufacturer.attr,
564 &dev_attr_product.attr,
565 &dev_attr_serial.attr,
569 static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
570 struct attribute *a, int n)
572 struct device *dev = container_of(kobj, struct device, kobj);
573 struct usb_device *udev = to_usb_device(dev);
575 if (a == &dev_attr_manufacturer.attr) {
576 if (udev->manufacturer == NULL)
578 } else if (a == &dev_attr_product.attr) {
579 if (udev->product == NULL)
581 } else if (a == &dev_attr_serial.attr) {
582 if (udev->serial == NULL)
588 static struct attribute_group dev_string_attr_grp = {
589 .attrs = dev_string_attrs,
590 .is_visible = dev_string_attrs_are_visible,
593 const struct attribute_group *usb_device_groups[] = {
595 &dev_string_attr_grp,
599 /* Binary descriptors */
602 read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
603 char *buf, loff_t off, size_t count)
605 struct device *dev = container_of(kobj, struct device, kobj);
606 struct usb_device *udev = to_usb_device(dev);
607 size_t nleft = count;
612 /* The binary attribute begins with the device descriptor.
613 * Following that are the raw descriptor entries for all the
614 * configurations (config plus subsidiary descriptors).
616 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
617 nleft > 0; ++cfgno) {
619 src = &udev->descriptor;
620 srclen = sizeof(struct usb_device_descriptor);
622 src = udev->rawdescriptors[cfgno];
623 srclen = __le16_to_cpu(udev->config[cfgno].desc.
627 n = min(nleft, srclen - (size_t) off);
628 memcpy(buf, src + off, n);
636 return count - nleft;
639 static struct bin_attribute dev_bin_attr_descriptors = {
640 .attr = {.name = "descriptors", .mode = 0444},
641 .read = read_descriptors,
642 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
645 int usb_create_sysfs_dev_files(struct usb_device *udev)
647 struct device *dev = &udev->dev;
650 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
654 retval = add_persist_attributes(dev);
658 retval = add_power_attributes(dev);
663 usb_remove_sysfs_dev_files(udev);
667 void usb_remove_sysfs_dev_files(struct usb_device *udev)
669 struct device *dev = &udev->dev;
671 remove_power_attributes(dev);
672 remove_persist_attributes(dev);
673 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
676 /* Interface Accociation Descriptor fields */
677 #define usb_intf_assoc_attr(field, format_string) \
679 show_iad_##field(struct device *dev, struct device_attribute *attr, \
682 struct usb_interface *intf = to_usb_interface(dev); \
684 return sprintf(buf, format_string, \
685 intf->intf_assoc->field); \
687 static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
689 usb_intf_assoc_attr(bFirstInterface, "%02x\n")
690 usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
691 usb_intf_assoc_attr(bFunctionClass, "%02x\n")
692 usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
693 usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
695 /* Interface fields */
696 #define usb_intf_attr(field, format_string) \
698 show_##field(struct device *dev, struct device_attribute *attr, \
701 struct usb_interface *intf = to_usb_interface(dev); \
703 return sprintf(buf, format_string, \
704 intf->cur_altsetting->desc.field); \
706 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
708 usb_intf_attr(bInterfaceNumber, "%02x\n")
709 usb_intf_attr(bAlternateSetting, "%2d\n")
710 usb_intf_attr(bNumEndpoints, "%02x\n")
711 usb_intf_attr(bInterfaceClass, "%02x\n")
712 usb_intf_attr(bInterfaceSubClass, "%02x\n")
713 usb_intf_attr(bInterfaceProtocol, "%02x\n")
715 static ssize_t show_interface_string(struct device *dev,
716 struct device_attribute *attr, char *buf)
718 struct usb_interface *intf;
721 intf = to_usb_interface(dev);
722 string = intf->cur_altsetting->string;
723 barrier(); /* The altsetting might change! */
727 return sprintf(buf, "%s\n", string);
729 static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
731 static ssize_t show_modalias(struct device *dev,
732 struct device_attribute *attr, char *buf)
734 struct usb_interface *intf;
735 struct usb_device *udev;
736 struct usb_host_interface *alt;
738 intf = to_usb_interface(dev);
739 udev = interface_to_usbdev(intf);
740 alt = intf->cur_altsetting;
742 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
743 "ic%02Xisc%02Xip%02X\n",
744 le16_to_cpu(udev->descriptor.idVendor),
745 le16_to_cpu(udev->descriptor.idProduct),
746 le16_to_cpu(udev->descriptor.bcdDevice),
747 udev->descriptor.bDeviceClass,
748 udev->descriptor.bDeviceSubClass,
749 udev->descriptor.bDeviceProtocol,
750 alt->desc.bInterfaceClass,
751 alt->desc.bInterfaceSubClass,
752 alt->desc.bInterfaceProtocol);
754 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
756 static ssize_t show_supports_autosuspend(struct device *dev,
757 struct device_attribute *attr, char *buf)
759 struct usb_interface *intf;
760 struct usb_device *udev;
763 intf = to_usb_interface(dev);
764 udev = interface_to_usbdev(intf);
766 usb_lock_device(udev);
767 /* Devices will be autosuspended even when an interface isn't claimed */
768 if (!intf->dev.driver ||
769 to_usb_driver(intf->dev.driver)->supports_autosuspend)
770 ret = sprintf(buf, "%u\n", 1);
772 ret = sprintf(buf, "%u\n", 0);
773 usb_unlock_device(udev);
777 static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
779 static struct attribute *intf_attrs[] = {
780 &dev_attr_bInterfaceNumber.attr,
781 &dev_attr_bAlternateSetting.attr,
782 &dev_attr_bNumEndpoints.attr,
783 &dev_attr_bInterfaceClass.attr,
784 &dev_attr_bInterfaceSubClass.attr,
785 &dev_attr_bInterfaceProtocol.attr,
786 &dev_attr_modalias.attr,
787 &dev_attr_supports_autosuspend.attr,
790 static struct attribute_group intf_attr_grp = {
794 static struct attribute *intf_assoc_attrs[] = {
795 &dev_attr_iad_bFirstInterface.attr,
796 &dev_attr_iad_bInterfaceCount.attr,
797 &dev_attr_iad_bFunctionClass.attr,
798 &dev_attr_iad_bFunctionSubClass.attr,
799 &dev_attr_iad_bFunctionProtocol.attr,
803 static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
804 struct attribute *a, int n)
806 struct device *dev = container_of(kobj, struct device, kobj);
807 struct usb_interface *intf = to_usb_interface(dev);
809 if (intf->intf_assoc == NULL)
814 static struct attribute_group intf_assoc_attr_grp = {
815 .attrs = intf_assoc_attrs,
816 .is_visible = intf_assoc_attrs_are_visible,
819 const struct attribute_group *usb_interface_groups[] = {
821 &intf_assoc_attr_grp,
825 int usb_create_sysfs_intf_files(struct usb_interface *intf)
827 struct usb_device *udev = interface_to_usbdev(intf);
828 struct usb_host_interface *alt = intf->cur_altsetting;
831 if (intf->sysfs_files_created || intf->unregistering)
834 if (alt->string == NULL &&
835 !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
836 alt->string = usb_cache_string(udev, alt->desc.iInterface);
838 retval = device_create_file(&intf->dev, &dev_attr_interface);
839 intf->sysfs_files_created = 1;
843 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
845 if (!intf->sysfs_files_created)
848 device_remove_file(&intf->dev, &dev_attr_interface);
849 intf->sysfs_files_created = 0;