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>
18 /* Active configuration fields */
19 #define usb_actconfig_show(field, multiplier, format_string) \
20 static ssize_t show_##field(struct device *dev, \
21 struct device_attribute *attr, char *buf) \
23 struct usb_device *udev; \
24 struct usb_host_config *actconfig; \
26 udev = to_usb_device(dev); \
27 actconfig = udev->actconfig; \
29 return sprintf(buf, format_string, \
30 actconfig->desc.field * multiplier); \
35 #define usb_actconfig_attr(field, multiplier, format_string) \
36 usb_actconfig_show(field, multiplier, format_string) \
37 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
39 usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
40 usb_actconfig_attr(bmAttributes, 1, "%2x\n")
41 usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
43 static ssize_t show_configuration_string(struct device *dev,
44 struct device_attribute *attr, char *buf)
46 struct usb_device *udev;
47 struct usb_host_config *actconfig;
49 udev = to_usb_device(dev);
50 actconfig = udev->actconfig;
51 if ((!actconfig) || (!actconfig->string))
53 return sprintf(buf, "%s\n", actconfig->string);
55 static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
57 /* configuration value is always present, and r/w */
58 usb_actconfig_show(bConfigurationValue, 1, "%u\n");
61 set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
62 const char *buf, size_t count)
64 struct usb_device *udev = to_usb_device(dev);
67 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
69 usb_lock_device(udev);
70 value = usb_set_configuration(udev, config);
71 usb_unlock_device(udev);
72 return (value < 0) ? value : count;
75 static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
76 show_bConfigurationValue, set_bConfigurationValue);
79 #define usb_string_attr(name) \
80 static ssize_t show_##name(struct device *dev, \
81 struct device_attribute *attr, char *buf) \
83 struct usb_device *udev; \
85 udev = to_usb_device(dev); \
86 return sprintf(buf, "%s\n", udev->name); \
88 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
90 usb_string_attr(product);
91 usb_string_attr(manufacturer);
92 usb_string_attr(serial);
95 show_speed(struct device *dev, struct device_attribute *attr, char *buf)
97 struct usb_device *udev;
100 udev = to_usb_device(dev);
102 switch (udev->speed) {
106 case USB_SPEED_UNKNOWN:
116 return sprintf(buf, "%s\n", speed);
118 static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
121 show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
123 struct usb_device *udev;
125 udev = to_usb_device(dev);
126 return sprintf(buf, "%d\n", udev->bus->busnum);
128 static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
131 show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
133 struct usb_device *udev;
135 udev = to_usb_device(dev);
136 return sprintf(buf, "%d\n", udev->devnum);
138 static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
141 show_version(struct device *dev, struct device_attribute *attr, char *buf)
143 struct usb_device *udev;
146 udev = to_usb_device(dev);
147 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
148 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
150 static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
153 show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
155 struct usb_device *udev;
157 udev = to_usb_device(dev);
158 return sprintf(buf, "%d\n", udev->maxchild);
160 static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
163 show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
165 struct usb_device *udev;
167 udev = to_usb_device(dev);
168 return sprintf(buf, "0x%x\n", udev->quirks);
170 static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
173 show_urbnum(struct device *dev, struct device_attribute *attr, char *buf)
175 struct usb_device *udev;
177 udev = to_usb_device(dev);
178 return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
180 static DEVICE_ATTR(urbnum, S_IRUGO, show_urbnum, NULL);
185 static const char power_group[] = "power";
188 show_persist(struct device *dev, struct device_attribute *attr, char *buf)
190 struct usb_device *udev = to_usb_device(dev);
192 return sprintf(buf, "%d\n", udev->persist_enabled);
196 set_persist(struct device *dev, struct device_attribute *attr,
197 const char *buf, size_t count)
199 struct usb_device *udev = to_usb_device(dev);
202 /* Hubs are always enabled for USB_PERSIST */
203 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
206 if (sscanf(buf, "%d", &value) != 1)
209 udev->persist_enabled = !!value;
214 static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
216 static int add_persist_attributes(struct device *dev)
220 if (is_usb_device(dev)) {
221 struct usb_device *udev = to_usb_device(dev);
223 /* Hubs are automatically enabled for USB_PERSIST,
224 * no point in creating the attribute file.
226 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
227 rc = sysfs_add_file_to_group(&dev->kobj,
228 &dev_attr_persist.attr,
234 static void remove_persist_attributes(struct device *dev)
236 sysfs_remove_file_from_group(&dev->kobj,
237 &dev_attr_persist.attr,
242 #define add_persist_attributes(dev) 0
243 #define remove_persist_attributes(dev) do {} while (0)
245 #endif /* CONFIG_PM */
247 #ifdef CONFIG_USB_SUSPEND
250 show_connected_duration(struct device *dev, struct device_attribute *attr,
253 struct usb_device *udev = to_usb_device(dev);
255 return sprintf(buf, "%u\n",
256 jiffies_to_msecs(jiffies - udev->connect_time));
259 static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
262 * If the device is resumed, the last time the device was suspended has
263 * been pre-subtracted from active_duration. We add the current time to
264 * get the duration that the device was actually active.
266 * If the device is suspended, the active_duration is up-to-date.
269 show_active_duration(struct device *dev, struct device_attribute *attr,
272 struct usb_device *udev = to_usb_device(dev);
275 if (udev->state != USB_STATE_SUSPENDED)
276 duration = jiffies_to_msecs(jiffies + udev->active_duration);
278 duration = jiffies_to_msecs(udev->active_duration);
279 return sprintf(buf, "%u\n", duration);
282 static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
285 show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
287 struct usb_device *udev = to_usb_device(dev);
289 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
293 set_autosuspend(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
296 struct usb_device *udev = to_usb_device(dev);
299 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
300 value <= - INT_MAX/HZ)
304 udev->autosuspend_delay = value;
306 usb_try_autosuspend_device(udev);
308 if (usb_autoresume_device(udev) == 0)
309 usb_autosuspend_device(udev);
314 static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
315 show_autosuspend, set_autosuspend);
317 static const char on_string[] = "on";
318 static const char auto_string[] = "auto";
319 static const char suspend_string[] = "suspend";
322 show_level(struct device *dev, struct device_attribute *attr, char *buf)
324 struct usb_device *udev = to_usb_device(dev);
325 const char *p = auto_string;
327 if (udev->state == USB_STATE_SUSPENDED) {
328 if (udev->autoresume_disabled)
331 if (udev->autosuspend_disabled)
334 return sprintf(buf, "%s\n", p);
338 set_level(struct device *dev, struct device_attribute *attr,
339 const char *buf, size_t count)
341 struct usb_device *udev = to_usb_device(dev);
345 int old_autosuspend_disabled, old_autoresume_disabled;
347 cp = memchr(buf, '\n', count);
351 usb_lock_device(udev);
352 old_autosuspend_disabled = udev->autosuspend_disabled;
353 old_autoresume_disabled = udev->autoresume_disabled;
355 /* Setting the flags without calling usb_pm_lock is a subject to
356 * races, but who cares...
358 if (len == sizeof on_string - 1 &&
359 strncmp(buf, on_string, len) == 0) {
360 udev->autosuspend_disabled = 1;
361 udev->autoresume_disabled = 0;
362 rc = usb_external_resume_device(udev);
364 } else if (len == sizeof auto_string - 1 &&
365 strncmp(buf, auto_string, len) == 0) {
366 udev->autosuspend_disabled = 0;
367 udev->autoresume_disabled = 0;
368 rc = usb_external_resume_device(udev);
370 } else if (len == sizeof suspend_string - 1 &&
371 strncmp(buf, suspend_string, len) == 0) {
372 udev->autosuspend_disabled = 0;
373 udev->autoresume_disabled = 1;
374 rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
380 udev->autosuspend_disabled = old_autosuspend_disabled;
381 udev->autoresume_disabled = old_autoresume_disabled;
383 usb_unlock_device(udev);
384 return (rc < 0 ? rc : count);
387 static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
389 static int add_power_attributes(struct device *dev)
393 if (is_usb_device(dev)) {
394 rc = sysfs_add_file_to_group(&dev->kobj,
395 &dev_attr_autosuspend.attr,
398 rc = sysfs_add_file_to_group(&dev->kobj,
399 &dev_attr_level.attr,
402 rc = sysfs_add_file_to_group(&dev->kobj,
403 &dev_attr_connected_duration.attr,
406 rc = sysfs_add_file_to_group(&dev->kobj,
407 &dev_attr_active_duration.attr,
413 static void remove_power_attributes(struct device *dev)
415 sysfs_remove_file_from_group(&dev->kobj,
416 &dev_attr_active_duration.attr,
418 sysfs_remove_file_from_group(&dev->kobj,
419 &dev_attr_connected_duration.attr,
421 sysfs_remove_file_from_group(&dev->kobj,
422 &dev_attr_level.attr,
424 sysfs_remove_file_from_group(&dev->kobj,
425 &dev_attr_autosuspend.attr,
431 #define add_power_attributes(dev) 0
432 #define remove_power_attributes(dev) do {} while (0)
434 #endif /* CONFIG_USB_SUSPEND */
437 /* Descriptor fields */
438 #define usb_descriptor_attr_le16(field, format_string) \
440 show_##field(struct device *dev, struct device_attribute *attr, \
443 struct usb_device *udev; \
445 udev = to_usb_device(dev); \
446 return sprintf(buf, format_string, \
447 le16_to_cpu(udev->descriptor.field)); \
449 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
451 usb_descriptor_attr_le16(idVendor, "%04x\n")
452 usb_descriptor_attr_le16(idProduct, "%04x\n")
453 usb_descriptor_attr_le16(bcdDevice, "%04x\n")
455 #define usb_descriptor_attr(field, format_string) \
457 show_##field(struct device *dev, struct device_attribute *attr, \
460 struct usb_device *udev; \
462 udev = to_usb_device(dev); \
463 return sprintf(buf, format_string, udev->descriptor.field); \
465 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
467 usb_descriptor_attr(bDeviceClass, "%02x\n")
468 usb_descriptor_attr(bDeviceSubClass, "%02x\n")
469 usb_descriptor_attr(bDeviceProtocol, "%02x\n")
470 usb_descriptor_attr(bNumConfigurations, "%d\n")
471 usb_descriptor_attr(bMaxPacketSize0, "%d\n")
475 /* show if the device is authorized (1) or not (0) */
476 static ssize_t usb_dev_authorized_show(struct device *dev,
477 struct device_attribute *attr,
480 struct usb_device *usb_dev = to_usb_device(dev);
481 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
486 * Authorize a device to be used in the system
488 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
490 static ssize_t usb_dev_authorized_store(struct device *dev,
491 struct device_attribute *attr,
492 const char *buf, size_t size)
495 struct usb_device *usb_dev = to_usb_device(dev);
497 result = sscanf(buf, "%u\n", &val);
501 result = usb_deauthorize_device(usb_dev);
503 result = usb_authorize_device(usb_dev);
504 return result < 0? result : size;
507 static DEVICE_ATTR(authorized, 0644,
508 usb_dev_authorized_show, usb_dev_authorized_store);
511 static struct attribute *dev_attrs[] = {
512 /* current configuration's attributes */
513 &dev_attr_configuration.attr,
514 &dev_attr_bNumInterfaces.attr,
515 &dev_attr_bConfigurationValue.attr,
516 &dev_attr_bmAttributes.attr,
517 &dev_attr_bMaxPower.attr,
518 &dev_attr_urbnum.attr,
519 /* device attributes */
520 &dev_attr_idVendor.attr,
521 &dev_attr_idProduct.attr,
522 &dev_attr_bcdDevice.attr,
523 &dev_attr_bDeviceClass.attr,
524 &dev_attr_bDeviceSubClass.attr,
525 &dev_attr_bDeviceProtocol.attr,
526 &dev_attr_bNumConfigurations.attr,
527 &dev_attr_bMaxPacketSize0.attr,
528 &dev_attr_speed.attr,
529 &dev_attr_busnum.attr,
530 &dev_attr_devnum.attr,
531 &dev_attr_version.attr,
532 &dev_attr_maxchild.attr,
533 &dev_attr_quirks.attr,
534 &dev_attr_authorized.attr,
537 static struct attribute_group dev_attr_grp = {
541 /* When modifying this list, be sure to modify dev_string_attrs_are_visible()
544 static struct attribute *dev_string_attrs[] = {
545 &dev_attr_manufacturer.attr,
546 &dev_attr_product.attr,
547 &dev_attr_serial.attr,
551 static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
552 struct attribute *a, int n)
554 struct usb_device *udev = to_usb_device(
555 container_of(kobj, struct device, kobj));
557 if (a == &dev_attr_manufacturer.attr) {
558 if (udev->manufacturer == NULL)
560 } else if (a == &dev_attr_product.attr) {
561 if (udev->product == NULL)
563 } else if (a == &dev_attr_serial.attr) {
564 if (udev->serial == NULL)
570 static struct attribute_group dev_string_attr_grp = {
571 .attrs = dev_string_attrs,
572 .is_visible = dev_string_attrs_are_visible,
575 struct attribute_group *usb_device_groups[] = {
577 &dev_string_attr_grp,
581 /* Binary descriptors */
584 read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
585 char *buf, loff_t off, size_t count)
587 struct usb_device *udev = to_usb_device(
588 container_of(kobj, struct device, kobj));
589 size_t nleft = count;
592 usb_lock_device(udev);
594 /* The binary attribute begins with the device descriptor */
595 srclen = sizeof(struct usb_device_descriptor);
597 n = min_t(size_t, nleft, srclen - off);
598 memcpy(buf, off + (char *) &udev->descriptor, n);
606 /* Then follows the raw descriptor entry for the current
607 * configuration (config plus subsidiary descriptors).
609 if (udev->actconfig) {
610 int cfgno = udev->actconfig - udev->config;
612 srclen = __le16_to_cpu(udev->actconfig->desc.wTotalLength);
614 n = min_t(size_t, nleft, srclen - off);
615 memcpy(buf, off + udev->rawdescriptors[cfgno], n);
619 usb_unlock_device(udev);
620 return count - nleft;
623 static struct bin_attribute dev_bin_attr_descriptors = {
624 .attr = {.name = "descriptors", .mode = 0444},
625 .read = read_descriptors,
626 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
629 int usb_create_sysfs_dev_files(struct usb_device *udev)
631 struct device *dev = &udev->dev;
634 /* Unforunately these attributes cannot be created before
635 * the uevent is broadcast.
637 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
641 retval = add_persist_attributes(dev);
645 retval = add_power_attributes(dev);
649 retval = usb_create_ep_files(dev, &udev->ep0, udev);
654 usb_remove_sysfs_dev_files(udev);
658 void usb_remove_sysfs_dev_files(struct usb_device *udev)
660 struct device *dev = &udev->dev;
662 usb_remove_ep_files(&udev->ep0);
663 remove_power_attributes(dev);
664 remove_persist_attributes(dev);
665 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
668 /* Interface Accociation Descriptor fields */
669 #define usb_intf_assoc_attr(field, format_string) \
671 show_iad_##field(struct device *dev, struct device_attribute *attr, \
674 struct usb_interface *intf = to_usb_interface(dev); \
676 return sprintf(buf, format_string, \
677 intf->intf_assoc->field); \
679 static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
681 usb_intf_assoc_attr(bFirstInterface, "%02x\n")
682 usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
683 usb_intf_assoc_attr(bFunctionClass, "%02x\n")
684 usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
685 usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
687 /* Interface fields */
688 #define usb_intf_attr(field, format_string) \
690 show_##field(struct device *dev, struct device_attribute *attr, \
693 struct usb_interface *intf = to_usb_interface(dev); \
695 return sprintf(buf, format_string, \
696 intf->cur_altsetting->desc.field); \
698 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
700 usb_intf_attr(bInterfaceNumber, "%02x\n")
701 usb_intf_attr(bAlternateSetting, "%2d\n")
702 usb_intf_attr(bNumEndpoints, "%02x\n")
703 usb_intf_attr(bInterfaceClass, "%02x\n")
704 usb_intf_attr(bInterfaceSubClass, "%02x\n")
705 usb_intf_attr(bInterfaceProtocol, "%02x\n")
707 static ssize_t show_interface_string(struct device *dev,
708 struct device_attribute *attr, char *buf)
710 struct usb_interface *intf;
713 intf = to_usb_interface(dev);
714 string = intf->cur_altsetting->string;
715 barrier(); /* The altsetting might change! */
719 return sprintf(buf, "%s\n", string);
721 static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
723 static ssize_t show_modalias(struct device *dev,
724 struct device_attribute *attr, char *buf)
726 struct usb_interface *intf;
727 struct usb_device *udev;
728 struct usb_host_interface *alt;
730 intf = to_usb_interface(dev);
731 udev = interface_to_usbdev(intf);
732 alt = intf->cur_altsetting;
734 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
735 "ic%02Xisc%02Xip%02X\n",
736 le16_to_cpu(udev->descriptor.idVendor),
737 le16_to_cpu(udev->descriptor.idProduct),
738 le16_to_cpu(udev->descriptor.bcdDevice),
739 udev->descriptor.bDeviceClass,
740 udev->descriptor.bDeviceSubClass,
741 udev->descriptor.bDeviceProtocol,
742 alt->desc.bInterfaceClass,
743 alt->desc.bInterfaceSubClass,
744 alt->desc.bInterfaceProtocol);
746 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
748 static struct attribute *intf_attrs[] = {
749 &dev_attr_bInterfaceNumber.attr,
750 &dev_attr_bAlternateSetting.attr,
751 &dev_attr_bNumEndpoints.attr,
752 &dev_attr_bInterfaceClass.attr,
753 &dev_attr_bInterfaceSubClass.attr,
754 &dev_attr_bInterfaceProtocol.attr,
755 &dev_attr_modalias.attr,
758 static struct attribute_group intf_attr_grp = {
762 static struct attribute *intf_assoc_attrs[] = {
763 &dev_attr_iad_bFirstInterface.attr,
764 &dev_attr_iad_bInterfaceCount.attr,
765 &dev_attr_iad_bFunctionClass.attr,
766 &dev_attr_iad_bFunctionSubClass.attr,
767 &dev_attr_iad_bFunctionProtocol.attr,
771 static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
772 struct attribute *a, int n)
774 struct usb_interface *intf = to_usb_interface(
775 container_of(kobj, struct device, kobj));
777 if (intf->intf_assoc == NULL)
782 static struct attribute_group intf_assoc_attr_grp = {
783 .attrs = intf_assoc_attrs,
784 .is_visible = intf_assoc_attrs_are_visible,
787 struct attribute_group *usb_interface_groups[] = {
789 &intf_assoc_attr_grp,
793 static inline void usb_create_intf_ep_files(struct usb_interface *intf,
794 struct usb_device *udev)
796 struct usb_host_interface *iface_desc;
799 iface_desc = intf->cur_altsetting;
800 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
801 usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
805 static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
807 struct usb_host_interface *iface_desc;
810 iface_desc = intf->cur_altsetting;
811 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
812 usb_remove_ep_files(&iface_desc->endpoint[i]);
815 int usb_create_sysfs_intf_files(struct usb_interface *intf)
817 struct usb_device *udev = interface_to_usbdev(intf);
818 struct usb_host_interface *alt = intf->cur_altsetting;
821 if (intf->sysfs_files_created)
824 /* The interface string may be present in some altsettings
825 * and missing in others. Hence its attribute cannot be created
826 * before the uevent is broadcast.
828 if (alt->string == NULL)
829 alt->string = usb_cache_string(udev, alt->desc.iInterface);
831 retval = device_create_file(&intf->dev, &dev_attr_interface);
832 usb_create_intf_ep_files(intf, udev);
833 intf->sysfs_files_created = 1;
837 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
839 struct device *dev = &intf->dev;
841 if (!intf->sysfs_files_created)
843 usb_remove_intf_ep_files(intf);
844 device_remove_file(dev, &dev_attr_interface);
845 intf->sysfs_files_created = 0;