1 // SPDX-License-Identifier: GPL-2.0
3 * drivers/usb/core/sysfs.c
5 * (C) Copyright 2002 David Brownell
6 * (C) Copyright 2002,2004 Greg Kroah-Hartman
7 * (C) Copyright 2002,2004 IBM Corp.
9 * All of the sysfs file attributes for usb devices and interfaces.
11 * Released under the GPLv2 only.
15 #include <linux/kernel.h>
16 #include <linux/kstrtox.h>
17 #include <linux/string.h>
18 #include <linux/usb.h>
19 #include <linux/usb/hcd.h>
20 #include <linux/usb/quirks.h>
24 /* Active configuration fields */
25 #define usb_actconfig_show(field, format_string) \
26 static ssize_t field##_show(struct device *dev, \
27 struct device_attribute *attr, char *buf) \
29 struct usb_device *udev; \
30 struct usb_host_config *actconfig; \
33 udev = to_usb_device(dev); \
34 rc = usb_lock_device_interruptible(udev); \
37 actconfig = udev->actconfig; \
39 rc = sysfs_emit(buf, format_string, \
40 actconfig->desc.field); \
41 usb_unlock_device(udev); \
45 #define usb_actconfig_attr(field, format_string) \
46 usb_actconfig_show(field, format_string) \
47 static DEVICE_ATTR_RO(field)
49 usb_actconfig_attr(bNumInterfaces, "%2d\n");
50 usb_actconfig_attr(bmAttributes, "%2x\n");
52 static ssize_t bMaxPower_show(struct device *dev,
53 struct device_attribute *attr, char *buf)
55 struct usb_device *udev;
56 struct usb_host_config *actconfig;
59 udev = to_usb_device(dev);
60 rc = usb_lock_device_interruptible(udev);
63 actconfig = udev->actconfig;
65 rc = sysfs_emit(buf, "%dmA\n", usb_get_max_power(udev, actconfig));
66 usb_unlock_device(udev);
69 static DEVICE_ATTR_RO(bMaxPower);
71 static ssize_t configuration_show(struct device *dev,
72 struct device_attribute *attr, char *buf)
74 struct usb_device *udev;
75 struct usb_host_config *actconfig;
78 udev = to_usb_device(dev);
79 rc = usb_lock_device_interruptible(udev);
82 actconfig = udev->actconfig;
83 if (actconfig && actconfig->string)
84 rc = sysfs_emit(buf, "%s\n", actconfig->string);
85 usb_unlock_device(udev);
88 static DEVICE_ATTR_RO(configuration);
90 /* configuration value is always present, and r/w */
91 usb_actconfig_show(bConfigurationValue, "%u\n");
93 static ssize_t bConfigurationValue_store(struct device *dev,
94 struct device_attribute *attr,
95 const char *buf, size_t count)
97 struct usb_device *udev = to_usb_device(dev);
98 int config, value, rc;
100 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
102 rc = usb_lock_device_interruptible(udev);
105 value = usb_set_configuration(udev, config);
106 usb_unlock_device(udev);
107 return (value < 0) ? value : count;
109 static DEVICE_ATTR_IGNORE_LOCKDEP(bConfigurationValue, S_IRUGO | S_IWUSR,
110 bConfigurationValue_show, bConfigurationValue_store);
113 static ssize_t devspec_show(struct device *dev, struct device_attribute *attr,
116 struct device_node *of_node = dev->of_node;
118 return sysfs_emit(buf, "%pOF\n", of_node);
120 static DEVICE_ATTR_RO(devspec);
124 #define usb_string_attr(name) \
125 static ssize_t name##_show(struct device *dev, \
126 struct device_attribute *attr, char *buf) \
128 struct usb_device *udev; \
131 udev = to_usb_device(dev); \
132 retval = usb_lock_device_interruptible(udev); \
135 retval = sysfs_emit(buf, "%s\n", udev->name); \
136 usb_unlock_device(udev); \
139 static DEVICE_ATTR_RO(name)
141 usb_string_attr(product);
142 usb_string_attr(manufacturer);
143 usb_string_attr(serial);
145 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
148 struct usb_device *udev;
151 udev = to_usb_device(dev);
153 switch (udev->speed) {
157 case USB_SPEED_UNKNOWN:
164 case USB_SPEED_SUPER:
167 case USB_SPEED_SUPER_PLUS:
168 if (udev->ssp_rate == USB_SSP_GEN_2x2)
176 return sysfs_emit(buf, "%s\n", speed);
178 static DEVICE_ATTR_RO(speed);
180 static ssize_t rx_lanes_show(struct device *dev, struct device_attribute *attr,
183 struct usb_device *udev;
185 udev = to_usb_device(dev);
186 return sysfs_emit(buf, "%d\n", udev->rx_lanes);
188 static DEVICE_ATTR_RO(rx_lanes);
190 static ssize_t tx_lanes_show(struct device *dev, struct device_attribute *attr,
193 struct usb_device *udev;
195 udev = to_usb_device(dev);
196 return sysfs_emit(buf, "%d\n", udev->tx_lanes);
198 static DEVICE_ATTR_RO(tx_lanes);
200 static ssize_t busnum_show(struct device *dev, struct device_attribute *attr,
203 struct usb_device *udev;
205 udev = to_usb_device(dev);
206 return sysfs_emit(buf, "%d\n", udev->bus->busnum);
208 static DEVICE_ATTR_RO(busnum);
210 static ssize_t devnum_show(struct device *dev, struct device_attribute *attr,
213 struct usb_device *udev;
215 udev = to_usb_device(dev);
216 return sysfs_emit(buf, "%d\n", udev->devnum);
218 static DEVICE_ATTR_RO(devnum);
220 static ssize_t devpath_show(struct device *dev, struct device_attribute *attr,
223 struct usb_device *udev;
225 udev = to_usb_device(dev);
226 return sysfs_emit(buf, "%s\n", udev->devpath);
228 static DEVICE_ATTR_RO(devpath);
230 static ssize_t version_show(struct device *dev, struct device_attribute *attr,
233 struct usb_device *udev;
236 udev = to_usb_device(dev);
237 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
238 return sysfs_emit(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
240 static DEVICE_ATTR_RO(version);
242 static ssize_t maxchild_show(struct device *dev, struct device_attribute *attr,
245 struct usb_device *udev;
247 udev = to_usb_device(dev);
248 return sysfs_emit(buf, "%d\n", udev->maxchild);
250 static DEVICE_ATTR_RO(maxchild);
252 static ssize_t quirks_show(struct device *dev, struct device_attribute *attr,
255 struct usb_device *udev;
257 udev = to_usb_device(dev);
258 return sysfs_emit(buf, "0x%x\n", udev->quirks);
260 static DEVICE_ATTR_RO(quirks);
262 static ssize_t avoid_reset_quirk_show(struct device *dev,
263 struct device_attribute *attr, char *buf)
265 struct usb_device *udev;
267 udev = to_usb_device(dev);
268 return sysfs_emit(buf, "%d\n", !!(udev->quirks & USB_QUIRK_RESET));
271 static ssize_t avoid_reset_quirk_store(struct device *dev,
272 struct device_attribute *attr,
273 const char *buf, size_t count)
275 struct usb_device *udev = to_usb_device(dev);
279 if (kstrtobool(buf, &val) != 0)
281 rc = usb_lock_device_interruptible(udev);
285 udev->quirks |= USB_QUIRK_RESET;
287 udev->quirks &= ~USB_QUIRK_RESET;
288 usb_unlock_device(udev);
291 static DEVICE_ATTR_RW(avoid_reset_quirk);
293 static ssize_t urbnum_show(struct device *dev, struct device_attribute *attr,
296 struct usb_device *udev;
298 udev = to_usb_device(dev);
299 return sysfs_emit(buf, "%d\n", atomic_read(&udev->urbnum));
301 static DEVICE_ATTR_RO(urbnum);
303 static ssize_t ltm_capable_show(struct device *dev,
304 struct device_attribute *attr, char *buf)
306 if (usb_device_supports_ltm(to_usb_device(dev)))
307 return sysfs_emit(buf, "%s\n", "yes");
308 return sysfs_emit(buf, "%s\n", "no");
310 static DEVICE_ATTR_RO(ltm_capable);
314 static ssize_t persist_show(struct device *dev, struct device_attribute *attr,
317 struct usb_device *udev = to_usb_device(dev);
319 return sysfs_emit(buf, "%d\n", udev->persist_enabled);
322 static ssize_t persist_store(struct device *dev, struct device_attribute *attr,
323 const char *buf, size_t count)
325 struct usb_device *udev = to_usb_device(dev);
329 /* Hubs are always enabled for USB_PERSIST */
330 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
333 if (kstrtobool(buf, &value) != 0)
336 rc = usb_lock_device_interruptible(udev);
339 udev->persist_enabled = !!value;
340 usb_unlock_device(udev);
343 static DEVICE_ATTR_RW(persist);
345 static int add_persist_attributes(struct device *dev)
349 if (is_usb_device(dev)) {
350 struct usb_device *udev = to_usb_device(dev);
352 /* Hubs are automatically enabled for USB_PERSIST,
353 * no point in creating the attribute file.
355 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
356 rc = sysfs_add_file_to_group(&dev->kobj,
357 &dev_attr_persist.attr,
363 static void remove_persist_attributes(struct device *dev)
365 sysfs_remove_file_from_group(&dev->kobj,
366 &dev_attr_persist.attr,
370 static ssize_t connected_duration_show(struct device *dev,
371 struct device_attribute *attr, char *buf)
373 struct usb_device *udev = to_usb_device(dev);
375 return sysfs_emit(buf, "%u\n",
376 jiffies_to_msecs(jiffies - udev->connect_time));
378 static DEVICE_ATTR_RO(connected_duration);
381 * If the device is resumed, the last time the device was suspended has
382 * been pre-subtracted from active_duration. We add the current time to
383 * get the duration that the device was actually active.
385 * If the device is suspended, the active_duration is up-to-date.
387 static ssize_t active_duration_show(struct device *dev,
388 struct device_attribute *attr, char *buf)
390 struct usb_device *udev = to_usb_device(dev);
393 if (udev->state != USB_STATE_SUSPENDED)
394 duration = jiffies_to_msecs(jiffies + udev->active_duration);
396 duration = jiffies_to_msecs(udev->active_duration);
397 return sysfs_emit(buf, "%u\n", duration);
399 static DEVICE_ATTR_RO(active_duration);
401 static ssize_t autosuspend_show(struct device *dev,
402 struct device_attribute *attr, char *buf)
404 return sysfs_emit(buf, "%d\n", dev->power.autosuspend_delay / 1000);
407 static ssize_t autosuspend_store(struct device *dev,
408 struct device_attribute *attr, const char *buf,
413 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
414 value <= -INT_MAX/1000)
417 pm_runtime_set_autosuspend_delay(dev, value * 1000);
420 static DEVICE_ATTR_RW(autosuspend);
422 static const char on_string[] = "on";
423 static const char auto_string[] = "auto";
425 static void warn_level(void)
427 static int level_warned;
431 printk(KERN_WARNING "WARNING! power/level is deprecated; "
432 "use power/control instead\n");
436 static ssize_t level_show(struct device *dev, struct device_attribute *attr,
439 struct usb_device *udev = to_usb_device(dev);
440 const char *p = auto_string;
443 if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
445 return sysfs_emit(buf, "%s\n", p);
448 static ssize_t level_store(struct device *dev, struct device_attribute *attr,
449 const char *buf, size_t count)
451 struct usb_device *udev = to_usb_device(dev);
458 cp = memchr(buf, '\n', count);
462 rv = usb_lock_device_interruptible(udev);
466 if (len == sizeof on_string - 1 &&
467 strncmp(buf, on_string, len) == 0)
468 usb_disable_autosuspend(udev);
470 else if (len == sizeof auto_string - 1 &&
471 strncmp(buf, auto_string, len) == 0)
472 usb_enable_autosuspend(udev);
477 usb_unlock_device(udev);
480 static DEVICE_ATTR_RW(level);
482 static ssize_t usb2_hardware_lpm_show(struct device *dev,
483 struct device_attribute *attr, char *buf)
485 struct usb_device *udev = to_usb_device(dev);
488 if (udev->usb2_hw_lpm_allowed == 1)
493 return sysfs_emit(buf, "%s\n", p);
496 static ssize_t usb2_hardware_lpm_store(struct device *dev,
497 struct device_attribute *attr,
498 const char *buf, size_t count)
500 struct usb_device *udev = to_usb_device(dev);
504 ret = usb_lock_device_interruptible(udev);
508 ret = kstrtobool(buf, &value);
511 udev->usb2_hw_lpm_allowed = value;
513 ret = usb_enable_usb2_hardware_lpm(udev);
515 ret = usb_disable_usb2_hardware_lpm(udev);
518 usb_unlock_device(udev);
525 static DEVICE_ATTR_RW(usb2_hardware_lpm);
527 static ssize_t usb2_lpm_l1_timeout_show(struct device *dev,
528 struct device_attribute *attr,
531 struct usb_device *udev = to_usb_device(dev);
532 return sysfs_emit(buf, "%d\n", udev->l1_params.timeout);
535 static ssize_t usb2_lpm_l1_timeout_store(struct device *dev,
536 struct device_attribute *attr,
537 const char *buf, size_t count)
539 struct usb_device *udev = to_usb_device(dev);
542 if (kstrtou16(buf, 0, &timeout))
545 udev->l1_params.timeout = timeout;
549 static DEVICE_ATTR_RW(usb2_lpm_l1_timeout);
551 static ssize_t usb2_lpm_besl_show(struct device *dev,
552 struct device_attribute *attr, char *buf)
554 struct usb_device *udev = to_usb_device(dev);
555 return sysfs_emit(buf, "%d\n", udev->l1_params.besl);
558 static ssize_t usb2_lpm_besl_store(struct device *dev,
559 struct device_attribute *attr,
560 const char *buf, size_t count)
562 struct usb_device *udev = to_usb_device(dev);
565 if (kstrtou8(buf, 0, &besl) || besl > 15)
568 udev->l1_params.besl = besl;
572 static DEVICE_ATTR_RW(usb2_lpm_besl);
574 static ssize_t usb3_hardware_lpm_u1_show(struct device *dev,
575 struct device_attribute *attr, char *buf)
577 struct usb_device *udev = to_usb_device(dev);
581 rc = usb_lock_device_interruptible(udev);
585 if (udev->usb3_lpm_u1_enabled)
590 usb_unlock_device(udev);
592 return sysfs_emit(buf, "%s\n", p);
594 static DEVICE_ATTR_RO(usb3_hardware_lpm_u1);
596 static ssize_t usb3_hardware_lpm_u2_show(struct device *dev,
597 struct device_attribute *attr, char *buf)
599 struct usb_device *udev = to_usb_device(dev);
603 rc = usb_lock_device_interruptible(udev);
607 if (udev->usb3_lpm_u2_enabled)
612 usb_unlock_device(udev);
614 return sysfs_emit(buf, "%s\n", p);
616 static DEVICE_ATTR_RO(usb3_hardware_lpm_u2);
618 static struct attribute *usb2_hardware_lpm_attr[] = {
619 &dev_attr_usb2_hardware_lpm.attr,
620 &dev_attr_usb2_lpm_l1_timeout.attr,
621 &dev_attr_usb2_lpm_besl.attr,
624 static const struct attribute_group usb2_hardware_lpm_attr_group = {
625 .name = power_group_name,
626 .attrs = usb2_hardware_lpm_attr,
629 static struct attribute *usb3_hardware_lpm_attr[] = {
630 &dev_attr_usb3_hardware_lpm_u1.attr,
631 &dev_attr_usb3_hardware_lpm_u2.attr,
634 static const struct attribute_group usb3_hardware_lpm_attr_group = {
635 .name = power_group_name,
636 .attrs = usb3_hardware_lpm_attr,
639 static struct attribute *power_attrs[] = {
640 &dev_attr_autosuspend.attr,
641 &dev_attr_level.attr,
642 &dev_attr_connected_duration.attr,
643 &dev_attr_active_duration.attr,
646 static const struct attribute_group power_attr_group = {
647 .name = power_group_name,
648 .attrs = power_attrs,
651 static int add_power_attributes(struct device *dev)
655 if (is_usb_device(dev)) {
656 struct usb_device *udev = to_usb_device(dev);
657 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
658 if (udev->usb2_hw_lpm_capable == 1)
659 rc = sysfs_merge_group(&dev->kobj,
660 &usb2_hardware_lpm_attr_group);
661 if ((udev->speed == USB_SPEED_SUPER ||
662 udev->speed == USB_SPEED_SUPER_PLUS) &&
663 udev->lpm_capable == 1)
664 rc = sysfs_merge_group(&dev->kobj,
665 &usb3_hardware_lpm_attr_group);
671 static void remove_power_attributes(struct device *dev)
673 sysfs_unmerge_group(&dev->kobj, &usb2_hardware_lpm_attr_group);
674 sysfs_unmerge_group(&dev->kobj, &power_attr_group);
679 #define add_persist_attributes(dev) 0
680 #define remove_persist_attributes(dev) do {} while (0)
682 #define add_power_attributes(dev) 0
683 #define remove_power_attributes(dev) do {} while (0)
685 #endif /* CONFIG_PM */
688 /* Descriptor fields */
689 #define usb_descriptor_attr_le16(field, format_string) \
691 field##_show(struct device *dev, struct device_attribute *attr, \
694 struct usb_device *udev; \
696 udev = to_usb_device(dev); \
697 return sysfs_emit(buf, format_string, \
698 le16_to_cpu(udev->descriptor.field)); \
700 static DEVICE_ATTR_RO(field)
702 usb_descriptor_attr_le16(idVendor, "%04x\n");
703 usb_descriptor_attr_le16(idProduct, "%04x\n");
704 usb_descriptor_attr_le16(bcdDevice, "%04x\n");
706 #define usb_descriptor_attr(field, format_string) \
708 field##_show(struct device *dev, struct device_attribute *attr, \
711 struct usb_device *udev; \
713 udev = to_usb_device(dev); \
714 return sysfs_emit(buf, format_string, udev->descriptor.field); \
716 static DEVICE_ATTR_RO(field)
718 usb_descriptor_attr(bDeviceClass, "%02x\n");
719 usb_descriptor_attr(bDeviceSubClass, "%02x\n");
720 usb_descriptor_attr(bDeviceProtocol, "%02x\n");
721 usb_descriptor_attr(bNumConfigurations, "%d\n");
722 usb_descriptor_attr(bMaxPacketSize0, "%d\n");
725 /* show if the device is authorized (1) or not (0) */
726 static ssize_t authorized_show(struct device *dev,
727 struct device_attribute *attr, char *buf)
729 struct usb_device *usb_dev = to_usb_device(dev);
730 return sysfs_emit(buf, "%u\n", usb_dev->authorized);
734 * Authorize a device to be used in the system
736 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
738 static ssize_t authorized_store(struct device *dev,
739 struct device_attribute *attr, const char *buf,
743 struct usb_device *usb_dev = to_usb_device(dev);
746 if (kstrtobool(buf, &val) != 0)
749 result = usb_authorize_device(usb_dev);
751 result = usb_deauthorize_device(usb_dev);
752 return result < 0 ? result : size;
754 static DEVICE_ATTR_IGNORE_LOCKDEP(authorized, S_IRUGO | S_IWUSR,
755 authorized_show, authorized_store);
757 /* "Safely remove a device" */
758 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
759 const char *buf, size_t count)
761 struct usb_device *udev = to_usb_device(dev);
764 usb_lock_device(udev);
765 if (udev->state != USB_STATE_NOTATTACHED) {
767 /* To avoid races, first unconfigure and then remove */
768 usb_set_configuration(udev, -1);
769 rc = usb_remove_device(udev);
773 usb_unlock_device(udev);
776 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, S_IWUSR, NULL, remove_store);
779 static struct attribute *dev_attrs[] = {
780 /* current configuration's attributes */
781 &dev_attr_configuration.attr,
782 &dev_attr_bNumInterfaces.attr,
783 &dev_attr_bConfigurationValue.attr,
784 &dev_attr_bmAttributes.attr,
785 &dev_attr_bMaxPower.attr,
786 /* device attributes */
787 &dev_attr_urbnum.attr,
788 &dev_attr_idVendor.attr,
789 &dev_attr_idProduct.attr,
790 &dev_attr_bcdDevice.attr,
791 &dev_attr_bDeviceClass.attr,
792 &dev_attr_bDeviceSubClass.attr,
793 &dev_attr_bDeviceProtocol.attr,
794 &dev_attr_bNumConfigurations.attr,
795 &dev_attr_bMaxPacketSize0.attr,
796 &dev_attr_speed.attr,
797 &dev_attr_rx_lanes.attr,
798 &dev_attr_tx_lanes.attr,
799 &dev_attr_busnum.attr,
800 &dev_attr_devnum.attr,
801 &dev_attr_devpath.attr,
802 &dev_attr_version.attr,
803 &dev_attr_maxchild.attr,
804 &dev_attr_quirks.attr,
805 &dev_attr_avoid_reset_quirk.attr,
806 &dev_attr_authorized.attr,
807 &dev_attr_remove.attr,
808 &dev_attr_ltm_capable.attr,
810 &dev_attr_devspec.attr,
814 static const struct attribute_group dev_attr_grp = {
818 /* When modifying this list, be sure to modify dev_string_attrs_are_visible()
821 static struct attribute *dev_string_attrs[] = {
822 &dev_attr_manufacturer.attr,
823 &dev_attr_product.attr,
824 &dev_attr_serial.attr,
828 static umode_t dev_string_attrs_are_visible(struct kobject *kobj,
829 struct attribute *a, int n)
831 struct device *dev = kobj_to_dev(kobj);
832 struct usb_device *udev = to_usb_device(dev);
834 if (a == &dev_attr_manufacturer.attr) {
835 if (udev->manufacturer == NULL)
837 } else if (a == &dev_attr_product.attr) {
838 if (udev->product == NULL)
840 } else if (a == &dev_attr_serial.attr) {
841 if (udev->serial == NULL)
847 static const struct attribute_group dev_string_attr_grp = {
848 .attrs = dev_string_attrs,
849 .is_visible = dev_string_attrs_are_visible,
852 /* Binary descriptors */
855 descriptors_read(struct file *filp, struct kobject *kobj,
856 struct bin_attribute *attr,
857 char *buf, loff_t off, size_t count)
859 struct device *dev = kobj_to_dev(kobj);
860 struct usb_device *udev = to_usb_device(dev);
861 size_t nleft = count;
866 /* The binary attribute begins with the device descriptor.
867 * Following that are the raw descriptor entries for all the
868 * configurations (config plus subsidiary descriptors).
870 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
871 nleft > 0; ++cfgno) {
873 src = &udev->descriptor;
874 srclen = sizeof(struct usb_device_descriptor);
876 src = udev->rawdescriptors[cfgno];
877 srclen = le16_to_cpu(udev->config[cfgno].desc.
881 n = min(nleft, srclen - (size_t) off);
882 memcpy(buf, src + off, n);
890 return count - nleft;
892 static BIN_ATTR_RO(descriptors, 18 + 65535); /* dev descr + max-size raw descriptor */
895 bos_descriptors_read(struct file *filp, struct kobject *kobj,
896 struct bin_attribute *attr,
897 char *buf, loff_t off, size_t count)
899 struct device *dev = kobj_to_dev(kobj);
900 struct usb_device *udev = to_usb_device(dev);
901 struct usb_host_bos *bos = udev->bos;
902 struct usb_bos_descriptor *desc;
903 size_t desclen, n = 0;
907 desclen = le16_to_cpu(desc->wTotalLength);
909 n = min(count, desclen - (size_t) off);
910 memcpy(buf, (void *) desc + off, n);
915 static BIN_ATTR_RO(bos_descriptors, 65535); /* max-size BOS */
917 /* When modifying this list, be sure to modify dev_bin_attrs_are_visible()
920 static struct bin_attribute *dev_bin_attrs[] = {
921 &bin_attr_descriptors,
922 &bin_attr_bos_descriptors,
926 static umode_t dev_bin_attrs_are_visible(struct kobject *kobj,
927 struct bin_attribute *a, int n)
929 struct device *dev = kobj_to_dev(kobj);
930 struct usb_device *udev = to_usb_device(dev);
933 * There's no need to check if the descriptors attribute should
934 * be visible because all devices have a device descriptor. The
935 * bos_descriptors attribute should be visible if and only if
936 * the device has a BOS, so check if it exists here.
938 if (a == &bin_attr_bos_descriptors) {
939 if (udev->bos == NULL)
945 static const struct attribute_group dev_bin_attr_grp = {
946 .bin_attrs = dev_bin_attrs,
947 .is_bin_visible = dev_bin_attrs_are_visible,
950 const struct attribute_group *usb_device_groups[] = {
952 &dev_string_attr_grp,
958 * Show & store the current value of authorized_default
960 static ssize_t authorized_default_show(struct device *dev,
961 struct device_attribute *attr, char *buf)
963 struct usb_device *rh_usb_dev = to_usb_device(dev);
964 struct usb_bus *usb_bus = rh_usb_dev->bus;
967 hcd = bus_to_hcd(usb_bus);
968 return sysfs_emit(buf, "%u\n", hcd->dev_policy);
971 static ssize_t authorized_default_store(struct device *dev,
972 struct device_attribute *attr,
973 const char *buf, size_t size)
977 struct usb_device *rh_usb_dev = to_usb_device(dev);
978 struct usb_bus *usb_bus = rh_usb_dev->bus;
981 hcd = bus_to_hcd(usb_bus);
982 result = sscanf(buf, "%u\n", &val);
984 hcd->dev_policy = val <= USB_DEVICE_AUTHORIZE_INTERNAL ?
985 val : USB_DEVICE_AUTHORIZE_ALL;
992 static DEVICE_ATTR_RW(authorized_default);
995 * interface_authorized_default_show - show default authorization status
998 * note: interface_authorized_default is the default value
999 * for initializing the authorized attribute of interfaces
1001 static ssize_t interface_authorized_default_show(struct device *dev,
1002 struct device_attribute *attr, char *buf)
1004 struct usb_device *usb_dev = to_usb_device(dev);
1005 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
1007 return sysfs_emit(buf, "%u\n", !!HCD_INTF_AUTHORIZED(hcd));
1011 * interface_authorized_default_store - store default authorization status
1012 * for USB interfaces
1014 * note: interface_authorized_default is the default value
1015 * for initializing the authorized attribute of interfaces
1017 static ssize_t interface_authorized_default_store(struct device *dev,
1018 struct device_attribute *attr, const char *buf, size_t count)
1020 struct usb_device *usb_dev = to_usb_device(dev);
1021 struct usb_hcd *hcd = bus_to_hcd(usb_dev->bus);
1025 if (kstrtobool(buf, &val) != 0)
1029 set_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
1031 clear_bit(HCD_FLAG_INTF_AUTHORIZED, &hcd->flags);
1035 static DEVICE_ATTR_RW(interface_authorized_default);
1037 /* Group all the USB bus attributes */
1038 static struct attribute *usb_bus_attrs[] = {
1039 &dev_attr_authorized_default.attr,
1040 &dev_attr_interface_authorized_default.attr,
1044 static const struct attribute_group usb_bus_attr_group = {
1045 .name = NULL, /* we want them in the same directory */
1046 .attrs = usb_bus_attrs,
1050 static int add_default_authorized_attributes(struct device *dev)
1054 if (is_usb_device(dev))
1055 rc = sysfs_create_group(&dev->kobj, &usb_bus_attr_group);
1060 static void remove_default_authorized_attributes(struct device *dev)
1062 if (is_usb_device(dev)) {
1063 sysfs_remove_group(&dev->kobj, &usb_bus_attr_group);
1067 int usb_create_sysfs_dev_files(struct usb_device *udev)
1069 struct device *dev = &udev->dev;
1072 retval = add_persist_attributes(dev);
1076 retval = add_power_attributes(dev);
1080 if (is_root_hub(udev)) {
1081 retval = add_default_authorized_attributes(dev);
1088 usb_remove_sysfs_dev_files(udev);
1092 void usb_remove_sysfs_dev_files(struct usb_device *udev)
1094 struct device *dev = &udev->dev;
1096 if (is_root_hub(udev))
1097 remove_default_authorized_attributes(dev);
1099 remove_power_attributes(dev);
1100 remove_persist_attributes(dev);
1103 /* Interface Association Descriptor fields */
1104 #define usb_intf_assoc_attr(field, format_string) \
1106 iad_##field##_show(struct device *dev, struct device_attribute *attr, \
1109 struct usb_interface *intf = to_usb_interface(dev); \
1111 return sysfs_emit(buf, format_string, \
1112 intf->intf_assoc->field); \
1114 static DEVICE_ATTR_RO(iad_##field)
1116 usb_intf_assoc_attr(bFirstInterface, "%02x\n");
1117 usb_intf_assoc_attr(bInterfaceCount, "%02d\n");
1118 usb_intf_assoc_attr(bFunctionClass, "%02x\n");
1119 usb_intf_assoc_attr(bFunctionSubClass, "%02x\n");
1120 usb_intf_assoc_attr(bFunctionProtocol, "%02x\n");
1122 /* Interface fields */
1123 #define usb_intf_attr(field, format_string) \
1125 field##_show(struct device *dev, struct device_attribute *attr, \
1128 struct usb_interface *intf = to_usb_interface(dev); \
1130 return sysfs_emit(buf, format_string, \
1131 intf->cur_altsetting->desc.field); \
1133 static DEVICE_ATTR_RO(field)
1135 usb_intf_attr(bInterfaceNumber, "%02x\n");
1136 usb_intf_attr(bAlternateSetting, "%2d\n");
1137 usb_intf_attr(bNumEndpoints, "%02x\n");
1138 usb_intf_attr(bInterfaceClass, "%02x\n");
1139 usb_intf_attr(bInterfaceSubClass, "%02x\n");
1140 usb_intf_attr(bInterfaceProtocol, "%02x\n");
1142 static ssize_t interface_show(struct device *dev, struct device_attribute *attr,
1145 struct usb_interface *intf;
1148 intf = to_usb_interface(dev);
1149 string = READ_ONCE(intf->cur_altsetting->string);
1152 return sysfs_emit(buf, "%s\n", string);
1154 static DEVICE_ATTR_RO(interface);
1156 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
1159 struct usb_interface *intf;
1160 struct usb_device *udev;
1161 struct usb_host_interface *alt;
1163 intf = to_usb_interface(dev);
1164 udev = interface_to_usbdev(intf);
1165 alt = READ_ONCE(intf->cur_altsetting);
1167 return sysfs_emit(buf,
1168 "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
1169 "ic%02Xisc%02Xip%02Xin%02X\n",
1170 le16_to_cpu(udev->descriptor.idVendor),
1171 le16_to_cpu(udev->descriptor.idProduct),
1172 le16_to_cpu(udev->descriptor.bcdDevice),
1173 udev->descriptor.bDeviceClass,
1174 udev->descriptor.bDeviceSubClass,
1175 udev->descriptor.bDeviceProtocol,
1176 alt->desc.bInterfaceClass,
1177 alt->desc.bInterfaceSubClass,
1178 alt->desc.bInterfaceProtocol,
1179 alt->desc.bInterfaceNumber);
1181 static DEVICE_ATTR_RO(modalias);
1183 static ssize_t supports_autosuspend_show(struct device *dev,
1184 struct device_attribute *attr,
1189 s = device_lock_interruptible(dev);
1192 /* Devices will be autosuspended even when an interface isn't claimed */
1193 s = (!dev->driver || to_usb_driver(dev->driver)->supports_autosuspend);
1196 return sysfs_emit(buf, "%u\n", s);
1198 static DEVICE_ATTR_RO(supports_autosuspend);
1201 * interface_authorized_show - show authorization status of an USB interface
1202 * 1 is authorized, 0 is deauthorized
1204 static ssize_t interface_authorized_show(struct device *dev,
1205 struct device_attribute *attr, char *buf)
1207 struct usb_interface *intf = to_usb_interface(dev);
1209 return sysfs_emit(buf, "%u\n", intf->authorized);
1213 * interface_authorized_store - authorize or deauthorize an USB interface
1215 static ssize_t interface_authorized_store(struct device *dev,
1216 struct device_attribute *attr, const char *buf, size_t count)
1218 struct usb_interface *intf = to_usb_interface(dev);
1220 struct kernfs_node *kn;
1222 if (kstrtobool(buf, &val) != 0)
1226 usb_authorize_interface(intf);
1229 * Prevent deadlock if another process is concurrently
1230 * trying to unregister intf.
1232 kn = sysfs_break_active_protection(&dev->kobj, &attr->attr);
1234 usb_deauthorize_interface(intf);
1235 sysfs_unbreak_active_protection(kn);
1241 static struct device_attribute dev_attr_interface_authorized =
1242 __ATTR(authorized, S_IRUGO | S_IWUSR,
1243 interface_authorized_show, interface_authorized_store);
1245 static struct attribute *intf_attrs[] = {
1246 &dev_attr_bInterfaceNumber.attr,
1247 &dev_attr_bAlternateSetting.attr,
1248 &dev_attr_bNumEndpoints.attr,
1249 &dev_attr_bInterfaceClass.attr,
1250 &dev_attr_bInterfaceSubClass.attr,
1251 &dev_attr_bInterfaceProtocol.attr,
1252 &dev_attr_modalias.attr,
1253 &dev_attr_supports_autosuspend.attr,
1254 &dev_attr_interface_authorized.attr,
1257 static const struct attribute_group intf_attr_grp = {
1258 .attrs = intf_attrs,
1261 static struct attribute *intf_assoc_attrs[] = {
1262 &dev_attr_iad_bFirstInterface.attr,
1263 &dev_attr_iad_bInterfaceCount.attr,
1264 &dev_attr_iad_bFunctionClass.attr,
1265 &dev_attr_iad_bFunctionSubClass.attr,
1266 &dev_attr_iad_bFunctionProtocol.attr,
1270 static umode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
1271 struct attribute *a, int n)
1273 struct device *dev = kobj_to_dev(kobj);
1274 struct usb_interface *intf = to_usb_interface(dev);
1276 if (intf->intf_assoc == NULL)
1281 static const struct attribute_group intf_assoc_attr_grp = {
1282 .attrs = intf_assoc_attrs,
1283 .is_visible = intf_assoc_attrs_are_visible,
1286 static ssize_t wireless_status_show(struct device *dev,
1287 struct device_attribute *attr, char *buf)
1289 struct usb_interface *intf;
1291 intf = to_usb_interface(dev);
1292 if (intf->wireless_status == USB_WIRELESS_STATUS_DISCONNECTED)
1293 return sysfs_emit(buf, "%s\n", "disconnected");
1294 return sysfs_emit(buf, "%s\n", "connected");
1296 static DEVICE_ATTR_RO(wireless_status);
1298 static struct attribute *intf_wireless_status_attrs[] = {
1299 &dev_attr_wireless_status.attr,
1303 static umode_t intf_wireless_status_attr_is_visible(struct kobject *kobj,
1304 struct attribute *a, int n)
1306 struct device *dev = kobj_to_dev(kobj);
1307 struct usb_interface *intf = to_usb_interface(dev);
1309 if (a != &dev_attr_wireless_status.attr ||
1310 intf->wireless_status != USB_WIRELESS_STATUS_NA)
1315 static const struct attribute_group intf_wireless_status_attr_grp = {
1316 .attrs = intf_wireless_status_attrs,
1317 .is_visible = intf_wireless_status_attr_is_visible,
1320 int usb_update_wireless_status_attr(struct usb_interface *intf)
1322 struct device *dev = &intf->dev;
1325 ret = sysfs_update_group(&dev->kobj, &intf_wireless_status_attr_grp);
1329 sysfs_notify(&dev->kobj, NULL, "wireless_status");
1330 kobject_uevent(&dev->kobj, KOBJ_CHANGE);
1335 const struct attribute_group *usb_interface_groups[] = {
1337 &intf_assoc_attr_grp,
1338 &intf_wireless_status_attr_grp,
1342 void usb_create_sysfs_intf_files(struct usb_interface *intf)
1344 struct usb_device *udev = interface_to_usbdev(intf);
1345 struct usb_host_interface *alt = intf->cur_altsetting;
1347 if (intf->sysfs_files_created || intf->unregistering)
1350 if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
1351 alt->string = usb_cache_string(udev, alt->desc.iInterface);
1352 if (alt->string && device_create_file(&intf->dev, &dev_attr_interface)) {
1353 /* This is not a serious error */
1354 dev_dbg(&intf->dev, "interface string descriptor file not created\n");
1356 intf->sysfs_files_created = 1;
1359 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
1361 if (!intf->sysfs_files_created)
1364 device_remove_file(&intf->dev, &dev_attr_interface);
1365 intf->sysfs_files_created = 0;