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);
183 #if defined(CONFIG_USB_PERSIST) || defined(CONFIG_USB_SUSPEND)
184 static const char power_group[] = "power";
187 #ifdef CONFIG_USB_PERSIST
190 show_persist(struct device *dev, struct device_attribute *attr, char *buf)
192 struct usb_device *udev = to_usb_device(dev);
194 return sprintf(buf, "%d\n", udev->persist_enabled);
198 set_persist(struct device *dev, struct device_attribute *attr,
199 const char *buf, size_t count)
201 struct usb_device *udev = to_usb_device(dev);
204 /* Hubs are always enabled for USB_PERSIST */
205 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
208 if (sscanf(buf, "%d", &value) != 1)
211 udev->persist_enabled = !!value;
216 static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
218 static int add_persist_attributes(struct device *dev)
222 if (is_usb_device(dev)) {
223 struct usb_device *udev = to_usb_device(dev);
225 /* Hubs are automatically enabled for USB_PERSIST */
226 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
227 udev->persist_enabled = 1;
228 rc = sysfs_add_file_to_group(&dev->kobj,
229 &dev_attr_persist.attr,
235 static void remove_persist_attributes(struct device *dev)
237 sysfs_remove_file_from_group(&dev->kobj,
238 &dev_attr_persist.attr,
244 #define add_persist_attributes(dev) 0
245 #define remove_persist_attributes(dev) do {} while (0)
247 #endif /* CONFIG_USB_PERSIST */
249 #ifdef CONFIG_USB_SUSPEND
252 show_connected_duration(struct device *dev, struct device_attribute *attr,
255 struct usb_device *udev = to_usb_device(dev);
257 return sprintf(buf, "%u\n",
258 jiffies_to_msecs(jiffies - udev->connect_time));
261 static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
264 * If the device is resumed, the last time the device was suspended has
265 * been pre-subtracted from active_duration. We add the current time to
266 * get the duration that the device was actually active.
268 * If the device is suspended, the active_duration is up-to-date.
271 show_active_duration(struct device *dev, struct device_attribute *attr,
274 struct usb_device *udev = to_usb_device(dev);
277 if (udev->state != USB_STATE_SUSPENDED)
278 duration = jiffies_to_msecs(jiffies + udev->active_duration);
280 duration = jiffies_to_msecs(udev->active_duration);
281 return sprintf(buf, "%u\n", duration);
284 static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
287 show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
289 struct usb_device *udev = to_usb_device(dev);
291 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
295 set_autosuspend(struct device *dev, struct device_attribute *attr,
296 const char *buf, size_t count)
298 struct usb_device *udev = to_usb_device(dev);
301 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
302 value <= - INT_MAX/HZ)
306 udev->autosuspend_delay = value;
308 usb_try_autosuspend_device(udev);
310 if (usb_autoresume_device(udev) == 0)
311 usb_autosuspend_device(udev);
316 static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
317 show_autosuspend, set_autosuspend);
319 static const char on_string[] = "on";
320 static const char auto_string[] = "auto";
321 static const char suspend_string[] = "suspend";
324 show_level(struct device *dev, struct device_attribute *attr, char *buf)
326 struct usb_device *udev = to_usb_device(dev);
327 const char *p = auto_string;
329 if (udev->state == USB_STATE_SUSPENDED) {
330 if (udev->autoresume_disabled)
333 if (udev->autosuspend_disabled)
336 return sprintf(buf, "%s\n", p);
340 set_level(struct device *dev, struct device_attribute *attr,
341 const char *buf, size_t count)
343 struct usb_device *udev = to_usb_device(dev);
347 int old_autosuspend_disabled, old_autoresume_disabled;
349 cp = memchr(buf, '\n', count);
353 usb_lock_device(udev);
354 old_autosuspend_disabled = udev->autosuspend_disabled;
355 old_autoresume_disabled = udev->autoresume_disabled;
357 /* Setting the flags without calling usb_pm_lock is a subject to
358 * races, but who cares...
360 if (len == sizeof on_string - 1 &&
361 strncmp(buf, on_string, len) == 0) {
362 udev->autosuspend_disabled = 1;
363 udev->autoresume_disabled = 0;
364 rc = usb_external_resume_device(udev);
366 } else if (len == sizeof auto_string - 1 &&
367 strncmp(buf, auto_string, len) == 0) {
368 udev->autosuspend_disabled = 0;
369 udev->autoresume_disabled = 0;
370 rc = usb_external_resume_device(udev);
372 } else if (len == sizeof suspend_string - 1 &&
373 strncmp(buf, suspend_string, len) == 0) {
374 udev->autosuspend_disabled = 0;
375 udev->autoresume_disabled = 1;
376 rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
382 udev->autosuspend_disabled = old_autosuspend_disabled;
383 udev->autoresume_disabled = old_autoresume_disabled;
385 usb_unlock_device(udev);
386 return (rc < 0 ? rc : count);
389 static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
391 static int add_power_attributes(struct device *dev)
395 if (is_usb_device(dev)) {
396 rc = sysfs_add_file_to_group(&dev->kobj,
397 &dev_attr_autosuspend.attr,
400 rc = sysfs_add_file_to_group(&dev->kobj,
401 &dev_attr_level.attr,
404 rc = sysfs_add_file_to_group(&dev->kobj,
405 &dev_attr_connected_duration.attr,
408 rc = sysfs_add_file_to_group(&dev->kobj,
409 &dev_attr_active_duration.attr,
415 static void remove_power_attributes(struct device *dev)
417 sysfs_remove_file_from_group(&dev->kobj,
418 &dev_attr_active_duration.attr,
420 sysfs_remove_file_from_group(&dev->kobj,
421 &dev_attr_connected_duration.attr,
423 sysfs_remove_file_from_group(&dev->kobj,
424 &dev_attr_level.attr,
426 sysfs_remove_file_from_group(&dev->kobj,
427 &dev_attr_autosuspend.attr,
433 #define add_power_attributes(dev) 0
434 #define remove_power_attributes(dev) do {} while (0)
436 #endif /* CONFIG_USB_SUSPEND */
439 /* Descriptor fields */
440 #define usb_descriptor_attr_le16(field, format_string) \
442 show_##field(struct device *dev, struct device_attribute *attr, \
445 struct usb_device *udev; \
447 udev = to_usb_device(dev); \
448 return sprintf(buf, format_string, \
449 le16_to_cpu(udev->descriptor.field)); \
451 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
453 usb_descriptor_attr_le16(idVendor, "%04x\n")
454 usb_descriptor_attr_le16(idProduct, "%04x\n")
455 usb_descriptor_attr_le16(bcdDevice, "%04x\n")
457 #define usb_descriptor_attr(field, format_string) \
459 show_##field(struct device *dev, struct device_attribute *attr, \
462 struct usb_device *udev; \
464 udev = to_usb_device(dev); \
465 return sprintf(buf, format_string, udev->descriptor.field); \
467 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
469 usb_descriptor_attr(bDeviceClass, "%02x\n")
470 usb_descriptor_attr(bDeviceSubClass, "%02x\n")
471 usb_descriptor_attr(bDeviceProtocol, "%02x\n")
472 usb_descriptor_attr(bNumConfigurations, "%d\n")
473 usb_descriptor_attr(bMaxPacketSize0, "%d\n")
477 /* show if the device is authorized (1) or not (0) */
478 static ssize_t usb_dev_authorized_show(struct device *dev,
479 struct device_attribute *attr,
482 struct usb_device *usb_dev = to_usb_device(dev);
483 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
488 * Authorize a device to be used in the system
490 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
492 static ssize_t usb_dev_authorized_store(struct device *dev,
493 struct device_attribute *attr,
494 const char *buf, size_t size)
497 struct usb_device *usb_dev = to_usb_device(dev);
499 result = sscanf(buf, "%u\n", &val);
503 result = usb_deauthorize_device(usb_dev);
505 result = usb_authorize_device(usb_dev);
506 return result < 0? result : size;
509 static DEVICE_ATTR(authorized, 0644,
510 usb_dev_authorized_show, usb_dev_authorized_store);
513 static struct attribute *dev_attrs[] = {
514 /* current configuration's attributes */
515 &dev_attr_configuration.attr,
516 &dev_attr_bNumInterfaces.attr,
517 &dev_attr_bConfigurationValue.attr,
518 &dev_attr_bmAttributes.attr,
519 &dev_attr_bMaxPower.attr,
520 &dev_attr_urbnum.attr,
521 /* device attributes */
522 &dev_attr_idVendor.attr,
523 &dev_attr_idProduct.attr,
524 &dev_attr_bcdDevice.attr,
525 &dev_attr_bDeviceClass.attr,
526 &dev_attr_bDeviceSubClass.attr,
527 &dev_attr_bDeviceProtocol.attr,
528 &dev_attr_bNumConfigurations.attr,
529 &dev_attr_bMaxPacketSize0.attr,
530 &dev_attr_speed.attr,
531 &dev_attr_busnum.attr,
532 &dev_attr_devnum.attr,
533 &dev_attr_version.attr,
534 &dev_attr_maxchild.attr,
535 &dev_attr_quirks.attr,
536 &dev_attr_authorized.attr,
539 static struct attribute_group dev_attr_grp = {
543 /* Binary descriptors */
546 read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
547 char *buf, loff_t off, size_t count)
549 struct usb_device *udev = to_usb_device(
550 container_of(kobj, struct device, kobj));
551 size_t nleft = count;
554 usb_lock_device(udev);
556 /* The binary attribute begins with the device descriptor */
557 srclen = sizeof(struct usb_device_descriptor);
559 n = min_t(size_t, nleft, srclen - off);
560 memcpy(buf, off + (char *) &udev->descriptor, n);
568 /* Then follows the raw descriptor entry for the current
569 * configuration (config plus subsidiary descriptors).
571 if (udev->actconfig) {
572 int cfgno = udev->actconfig - udev->config;
574 srclen = __le16_to_cpu(udev->actconfig->desc.wTotalLength);
576 n = min_t(size_t, nleft, srclen - off);
577 memcpy(buf, off + udev->rawdescriptors[cfgno], n);
581 usb_unlock_device(udev);
582 return count - nleft;
585 static struct bin_attribute dev_bin_attr_descriptors = {
586 .attr = {.name = "descriptors", .mode = 0444},
587 .read = read_descriptors,
588 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
591 int usb_create_sysfs_dev_files(struct usb_device *udev)
593 struct device *dev = &udev->dev;
596 retval = sysfs_create_group(&dev->kobj, &dev_attr_grp);
600 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
604 retval = add_persist_attributes(dev);
608 retval = add_power_attributes(dev);
612 if (udev->manufacturer) {
613 retval = device_create_file(dev, &dev_attr_manufacturer);
618 retval = device_create_file(dev, &dev_attr_product);
623 retval = device_create_file(dev, &dev_attr_serial);
627 retval = usb_create_ep_files(dev, &udev->ep0, udev);
632 usb_remove_sysfs_dev_files(udev);
636 void usb_remove_sysfs_dev_files(struct usb_device *udev)
638 struct device *dev = &udev->dev;
640 usb_remove_ep_files(&udev->ep0);
641 device_remove_file(dev, &dev_attr_manufacturer);
642 device_remove_file(dev, &dev_attr_product);
643 device_remove_file(dev, &dev_attr_serial);
644 remove_power_attributes(dev);
645 remove_persist_attributes(dev);
646 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
647 sysfs_remove_group(&dev->kobj, &dev_attr_grp);
650 /* Interface Accociation Descriptor fields */
651 #define usb_intf_assoc_attr(field, format_string) \
653 show_iad_##field(struct device *dev, struct device_attribute *attr, \
656 struct usb_interface *intf = to_usb_interface(dev); \
658 return sprintf(buf, format_string, \
659 intf->intf_assoc->field); \
661 static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
663 usb_intf_assoc_attr(bFirstInterface, "%02x\n")
664 usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
665 usb_intf_assoc_attr(bFunctionClass, "%02x\n")
666 usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
667 usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
669 /* Interface fields */
670 #define usb_intf_attr(field, format_string) \
672 show_##field(struct device *dev, struct device_attribute *attr, \
675 struct usb_interface *intf = to_usb_interface(dev); \
677 return sprintf(buf, format_string, \
678 intf->cur_altsetting->desc.field); \
680 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
682 usb_intf_attr(bInterfaceNumber, "%02x\n")
683 usb_intf_attr(bAlternateSetting, "%2d\n")
684 usb_intf_attr(bNumEndpoints, "%02x\n")
685 usb_intf_attr(bInterfaceClass, "%02x\n")
686 usb_intf_attr(bInterfaceSubClass, "%02x\n")
687 usb_intf_attr(bInterfaceProtocol, "%02x\n")
689 static ssize_t show_interface_string(struct device *dev,
690 struct device_attribute *attr, char *buf)
692 struct usb_interface *intf;
693 struct usb_device *udev;
696 intf = to_usb_interface(dev);
697 udev = interface_to_usbdev(intf);
698 len = snprintf(buf, 256, "%s", intf->cur_altsetting->string);
705 static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
707 static ssize_t show_modalias(struct device *dev,
708 struct device_attribute *attr, char *buf)
710 struct usb_interface *intf;
711 struct usb_device *udev;
712 struct usb_host_interface *alt;
714 intf = to_usb_interface(dev);
715 udev = interface_to_usbdev(intf);
716 alt = intf->cur_altsetting;
718 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
719 "ic%02Xisc%02Xip%02X\n",
720 le16_to_cpu(udev->descriptor.idVendor),
721 le16_to_cpu(udev->descriptor.idProduct),
722 le16_to_cpu(udev->descriptor.bcdDevice),
723 udev->descriptor.bDeviceClass,
724 udev->descriptor.bDeviceSubClass,
725 udev->descriptor.bDeviceProtocol,
726 alt->desc.bInterfaceClass,
727 alt->desc.bInterfaceSubClass,
728 alt->desc.bInterfaceProtocol);
730 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
732 static struct attribute *intf_assoc_attrs[] = {
733 &dev_attr_iad_bFirstInterface.attr,
734 &dev_attr_iad_bInterfaceCount.attr,
735 &dev_attr_iad_bFunctionClass.attr,
736 &dev_attr_iad_bFunctionSubClass.attr,
737 &dev_attr_iad_bFunctionProtocol.attr,
740 static struct attribute_group intf_assoc_attr_grp = {
741 .attrs = intf_assoc_attrs,
744 static struct attribute *intf_attrs[] = {
745 &dev_attr_bInterfaceNumber.attr,
746 &dev_attr_bAlternateSetting.attr,
747 &dev_attr_bNumEndpoints.attr,
748 &dev_attr_bInterfaceClass.attr,
749 &dev_attr_bInterfaceSubClass.attr,
750 &dev_attr_bInterfaceProtocol.attr,
751 &dev_attr_modalias.attr,
754 static struct attribute_group intf_attr_grp = {
758 static inline void usb_create_intf_ep_files(struct usb_interface *intf,
759 struct usb_device *udev)
761 struct usb_host_interface *iface_desc;
764 iface_desc = intf->cur_altsetting;
765 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
766 usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
770 static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
772 struct usb_host_interface *iface_desc;
775 iface_desc = intf->cur_altsetting;
776 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
777 usb_remove_ep_files(&iface_desc->endpoint[i]);
780 int usb_create_sysfs_intf_files(struct usb_interface *intf)
782 struct device *dev = &intf->dev;
783 struct usb_device *udev = interface_to_usbdev(intf);
784 struct usb_host_interface *alt = intf->cur_altsetting;
787 if (intf->sysfs_files_created)
789 retval = sysfs_create_group(&dev->kobj, &intf_attr_grp);
793 if (alt->string == NULL)
794 alt->string = usb_cache_string(udev, alt->desc.iInterface);
796 retval = device_create_file(dev, &dev_attr_interface);
797 if (intf->intf_assoc)
798 retval = sysfs_create_group(&dev->kobj, &intf_assoc_attr_grp);
799 usb_create_intf_ep_files(intf, udev);
800 intf->sysfs_files_created = 1;
804 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
806 struct device *dev = &intf->dev;
808 if (!intf->sysfs_files_created)
810 usb_remove_intf_ep_files(intf);
811 device_remove_file(dev, &dev_attr_interface);
812 sysfs_remove_group(&dev->kobj, &intf_attr_grp);
813 sysfs_remove_group(&intf->dev.kobj, &intf_assoc_attr_grp);
814 intf->sysfs_files_created = 0;