Loading...
1/*
2 * drivers/usb/core/sysfs.c
3 *
4 * (C) Copyright 2002 David Brownell
5 * (C) Copyright 2002,2004 Greg Kroah-Hartman
6 * (C) Copyright 2002,2004 IBM Corp.
7 *
8 * All of the sysfs file attributes for usb devices and interfaces.
9 *
10 */
11
12
13#include <linux/kernel.h>
14#include <linux/string.h>
15#include <linux/usb.h>
16#include <linux/usb/quirks.h>
17#include "usb.h"
18
19/* Active configuration fields */
20#define usb_actconfig_show(field, multiplier, format_string) \
21static ssize_t show_##field(struct device *dev, \
22 struct device_attribute *attr, char *buf) \
23{ \
24 struct usb_device *udev; \
25 struct usb_host_config *actconfig; \
26 \
27 udev = to_usb_device(dev); \
28 actconfig = udev->actconfig; \
29 if (actconfig) \
30 return sprintf(buf, format_string, \
31 actconfig->desc.field * multiplier); \
32 else \
33 return 0; \
34} \
35
36#define usb_actconfig_attr(field, multiplier, format_string) \
37usb_actconfig_show(field, multiplier, format_string) \
38static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
39
40usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
41usb_actconfig_attr(bmAttributes, 1, "%2x\n")
42usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
43
44static ssize_t show_configuration_string(struct device *dev,
45 struct device_attribute *attr, char *buf)
46{
47 struct usb_device *udev;
48 struct usb_host_config *actconfig;
49
50 udev = to_usb_device(dev);
51 actconfig = udev->actconfig;
52 if ((!actconfig) || (!actconfig->string))
53 return 0;
54 return sprintf(buf, "%s\n", actconfig->string);
55}
56static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
57
58/* configuration value is always present, and r/w */
59usb_actconfig_show(bConfigurationValue, 1, "%u\n");
60
61static ssize_t
62set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
63 const char *buf, size_t count)
64{
65 struct usb_device *udev = to_usb_device(dev);
66 int config, value;
67
68 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
69 return -EINVAL;
70 usb_lock_device(udev);
71 value = usb_set_configuration(udev, config);
72 usb_unlock_device(udev);
73 return (value < 0) ? value : count;
74}
75
76static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
77 show_bConfigurationValue, set_bConfigurationValue);
78
79/* String fields */
80#define usb_string_attr(name) \
81static ssize_t show_##name(struct device *dev, \
82 struct device_attribute *attr, char *buf) \
83{ \
84 struct usb_device *udev; \
85 int retval; \
86 \
87 udev = to_usb_device(dev); \
88 usb_lock_device(udev); \
89 retval = sprintf(buf, "%s\n", udev->name); \
90 usb_unlock_device(udev); \
91 return retval; \
92} \
93static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
94
95usb_string_attr(product);
96usb_string_attr(manufacturer);
97usb_string_attr(serial);
98
99static ssize_t
100show_speed(struct device *dev, struct device_attribute *attr, char *buf)
101{
102 struct usb_device *udev;
103 char *speed;
104
105 udev = to_usb_device(dev);
106
107 switch (udev->speed) {
108 case USB_SPEED_LOW:
109 speed = "1.5";
110 break;
111 case USB_SPEED_UNKNOWN:
112 case USB_SPEED_FULL:
113 speed = "12";
114 break;
115 case USB_SPEED_HIGH:
116 speed = "480";
117 break;
118 case USB_SPEED_WIRELESS:
119 speed = "480";
120 break;
121 case USB_SPEED_SUPER:
122 speed = "5000";
123 break;
124 default:
125 speed = "unknown";
126 }
127 return sprintf(buf, "%s\n", speed);
128}
129static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
130
131static ssize_t
132show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
133{
134 struct usb_device *udev;
135
136 udev = to_usb_device(dev);
137 return sprintf(buf, "%d\n", udev->bus->busnum);
138}
139static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
140
141static ssize_t
142show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
143{
144 struct usb_device *udev;
145
146 udev = to_usb_device(dev);
147 return sprintf(buf, "%d\n", udev->devnum);
148}
149static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
150
151static ssize_t
152show_devpath(struct device *dev, struct device_attribute *attr, char *buf)
153{
154 struct usb_device *udev;
155
156 udev = to_usb_device(dev);
157 return sprintf(buf, "%s\n", udev->devpath);
158}
159static DEVICE_ATTR(devpath, S_IRUGO, show_devpath, NULL);
160
161static ssize_t
162show_version(struct device *dev, struct device_attribute *attr, char *buf)
163{
164 struct usb_device *udev;
165 u16 bcdUSB;
166
167 udev = to_usb_device(dev);
168 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
169 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
170}
171static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
172
173static ssize_t
174show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
175{
176 struct usb_device *udev;
177
178 udev = to_usb_device(dev);
179 return sprintf(buf, "%d\n", udev->maxchild);
180}
181static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
182
183static ssize_t
184show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
185{
186 struct usb_device *udev;
187
188 udev = to_usb_device(dev);
189 return sprintf(buf, "0x%x\n", udev->quirks);
190}
191static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
192
193static ssize_t
194show_avoid_reset_quirk(struct device *dev, struct device_attribute *attr, char *buf)
195{
196 struct usb_device *udev;
197
198 udev = to_usb_device(dev);
199 return sprintf(buf, "%d\n", !!(udev->quirks & USB_QUIRK_RESET_MORPHS));
200}
201
202static ssize_t
203set_avoid_reset_quirk(struct device *dev, struct device_attribute *attr,
204 const char *buf, size_t count)
205{
206 struct usb_device *udev = to_usb_device(dev);
207 int config;
208
209 if (sscanf(buf, "%d", &config) != 1 || config < 0 || config > 1)
210 return -EINVAL;
211 usb_lock_device(udev);
212 if (config)
213 udev->quirks |= USB_QUIRK_RESET_MORPHS;
214 else
215 udev->quirks &= ~USB_QUIRK_RESET_MORPHS;
216 usb_unlock_device(udev);
217 return count;
218}
219
220static DEVICE_ATTR(avoid_reset_quirk, S_IRUGO | S_IWUSR,
221 show_avoid_reset_quirk, set_avoid_reset_quirk);
222
223static ssize_t
224show_urbnum(struct device *dev, struct device_attribute *attr, char *buf)
225{
226 struct usb_device *udev;
227
228 udev = to_usb_device(dev);
229 return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
230}
231static DEVICE_ATTR(urbnum, S_IRUGO, show_urbnum, NULL);
232
233
234#ifdef CONFIG_PM
235
236static ssize_t
237show_persist(struct device *dev, struct device_attribute *attr, char *buf)
238{
239 struct usb_device *udev = to_usb_device(dev);
240
241 return sprintf(buf, "%d\n", udev->persist_enabled);
242}
243
244static ssize_t
245set_persist(struct device *dev, struct device_attribute *attr,
246 const char *buf, size_t count)
247{
248 struct usb_device *udev = to_usb_device(dev);
249 int value;
250
251 /* Hubs are always enabled for USB_PERSIST */
252 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
253 return -EPERM;
254
255 if (sscanf(buf, "%d", &value) != 1)
256 return -EINVAL;
257
258 usb_lock_device(udev);
259 udev->persist_enabled = !!value;
260 usb_unlock_device(udev);
261 return count;
262}
263
264static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
265
266static int add_persist_attributes(struct device *dev)
267{
268 int rc = 0;
269
270 if (is_usb_device(dev)) {
271 struct usb_device *udev = to_usb_device(dev);
272
273 /* Hubs are automatically enabled for USB_PERSIST,
274 * no point in creating the attribute file.
275 */
276 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
277 rc = sysfs_add_file_to_group(&dev->kobj,
278 &dev_attr_persist.attr,
279 power_group_name);
280 }
281 return rc;
282}
283
284static void remove_persist_attributes(struct device *dev)
285{
286 sysfs_remove_file_from_group(&dev->kobj,
287 &dev_attr_persist.attr,
288 power_group_name);
289}
290#else
291
292#define add_persist_attributes(dev) 0
293#define remove_persist_attributes(dev) do {} while (0)
294
295#endif /* CONFIG_PM */
296
297#ifdef CONFIG_USB_SUSPEND
298
299static ssize_t
300show_connected_duration(struct device *dev, struct device_attribute *attr,
301 char *buf)
302{
303 struct usb_device *udev = to_usb_device(dev);
304
305 return sprintf(buf, "%u\n",
306 jiffies_to_msecs(jiffies - udev->connect_time));
307}
308
309static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
310
311/*
312 * If the device is resumed, the last time the device was suspended has
313 * been pre-subtracted from active_duration. We add the current time to
314 * get the duration that the device was actually active.
315 *
316 * If the device is suspended, the active_duration is up-to-date.
317 */
318static ssize_t
319show_active_duration(struct device *dev, struct device_attribute *attr,
320 char *buf)
321{
322 struct usb_device *udev = to_usb_device(dev);
323 int duration;
324
325 if (udev->state != USB_STATE_SUSPENDED)
326 duration = jiffies_to_msecs(jiffies + udev->active_duration);
327 else
328 duration = jiffies_to_msecs(udev->active_duration);
329 return sprintf(buf, "%u\n", duration);
330}
331
332static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
333
334static ssize_t
335show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
336{
337 return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
338}
339
340static ssize_t
341set_autosuspend(struct device *dev, struct device_attribute *attr,
342 const char *buf, size_t count)
343{
344 int value;
345
346 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
347 value <= -INT_MAX/1000)
348 return -EINVAL;
349
350 pm_runtime_set_autosuspend_delay(dev, value * 1000);
351 return count;
352}
353
354static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
355 show_autosuspend, set_autosuspend);
356
357static const char on_string[] = "on";
358static const char auto_string[] = "auto";
359
360static void warn_level(void) {
361 static int level_warned;
362
363 if (!level_warned) {
364 level_warned = 1;
365 printk(KERN_WARNING "WARNING! power/level is deprecated; "
366 "use power/control instead\n");
367 }
368}
369
370static ssize_t
371show_level(struct device *dev, struct device_attribute *attr, char *buf)
372{
373 struct usb_device *udev = to_usb_device(dev);
374 const char *p = auto_string;
375
376 warn_level();
377 if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
378 p = on_string;
379 return sprintf(buf, "%s\n", p);
380}
381
382static ssize_t
383set_level(struct device *dev, struct device_attribute *attr,
384 const char *buf, size_t count)
385{
386 struct usb_device *udev = to_usb_device(dev);
387 int len = count;
388 char *cp;
389 int rc = count;
390
391 warn_level();
392 cp = memchr(buf, '\n', count);
393 if (cp)
394 len = cp - buf;
395
396 usb_lock_device(udev);
397
398 if (len == sizeof on_string - 1 &&
399 strncmp(buf, on_string, len) == 0)
400 usb_disable_autosuspend(udev);
401
402 else if (len == sizeof auto_string - 1 &&
403 strncmp(buf, auto_string, len) == 0)
404 usb_enable_autosuspend(udev);
405
406 else
407 rc = -EINVAL;
408
409 usb_unlock_device(udev);
410 return rc;
411}
412
413static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
414
415static struct attribute *power_attrs[] = {
416 &dev_attr_autosuspend.attr,
417 &dev_attr_level.attr,
418 &dev_attr_connected_duration.attr,
419 &dev_attr_active_duration.attr,
420 NULL,
421};
422static struct attribute_group power_attr_group = {
423 .name = power_group_name,
424 .attrs = power_attrs,
425};
426
427static int add_power_attributes(struct device *dev)
428{
429 int rc = 0;
430
431 if (is_usb_device(dev))
432 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
433 return rc;
434}
435
436static void remove_power_attributes(struct device *dev)
437{
438 sysfs_unmerge_group(&dev->kobj, &power_attr_group);
439}
440
441#else
442
443#define add_power_attributes(dev) 0
444#define remove_power_attributes(dev) do {} while (0)
445
446#endif /* CONFIG_USB_SUSPEND */
447
448
449/* Descriptor fields */
450#define usb_descriptor_attr_le16(field, format_string) \
451static ssize_t \
452show_##field(struct device *dev, struct device_attribute *attr, \
453 char *buf) \
454{ \
455 struct usb_device *udev; \
456 \
457 udev = to_usb_device(dev); \
458 return sprintf(buf, format_string, \
459 le16_to_cpu(udev->descriptor.field)); \
460} \
461static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
462
463usb_descriptor_attr_le16(idVendor, "%04x\n")
464usb_descriptor_attr_le16(idProduct, "%04x\n")
465usb_descriptor_attr_le16(bcdDevice, "%04x\n")
466
467#define usb_descriptor_attr(field, format_string) \
468static ssize_t \
469show_##field(struct device *dev, struct device_attribute *attr, \
470 char *buf) \
471{ \
472 struct usb_device *udev; \
473 \
474 udev = to_usb_device(dev); \
475 return sprintf(buf, format_string, udev->descriptor.field); \
476} \
477static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
478
479usb_descriptor_attr(bDeviceClass, "%02x\n")
480usb_descriptor_attr(bDeviceSubClass, "%02x\n")
481usb_descriptor_attr(bDeviceProtocol, "%02x\n")
482usb_descriptor_attr(bNumConfigurations, "%d\n")
483usb_descriptor_attr(bMaxPacketSize0, "%d\n")
484
485
486
487/* show if the device is authorized (1) or not (0) */
488static ssize_t usb_dev_authorized_show(struct device *dev,
489 struct device_attribute *attr,
490 char *buf)
491{
492 struct usb_device *usb_dev = to_usb_device(dev);
493 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
494}
495
496
497/*
498 * Authorize a device to be used in the system
499 *
500 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
501 */
502static ssize_t usb_dev_authorized_store(struct device *dev,
503 struct device_attribute *attr,
504 const char *buf, size_t size)
505{
506 ssize_t result;
507 struct usb_device *usb_dev = to_usb_device(dev);
508 unsigned val;
509 result = sscanf(buf, "%u\n", &val);
510 if (result != 1)
511 result = -EINVAL;
512 else if (val == 0)
513 result = usb_deauthorize_device(usb_dev);
514 else
515 result = usb_authorize_device(usb_dev);
516 return result < 0? result : size;
517}
518
519static DEVICE_ATTR(authorized, 0644,
520 usb_dev_authorized_show, usb_dev_authorized_store);
521
522/* "Safely remove a device" */
523static ssize_t usb_remove_store(struct device *dev,
524 struct device_attribute *attr,
525 const char *buf, size_t count)
526{
527 struct usb_device *udev = to_usb_device(dev);
528 int rc = 0;
529
530 usb_lock_device(udev);
531 if (udev->state != USB_STATE_NOTATTACHED) {
532
533 /* To avoid races, first unconfigure and then remove */
534 usb_set_configuration(udev, -1);
535 rc = usb_remove_device(udev);
536 }
537 if (rc == 0)
538 rc = count;
539 usb_unlock_device(udev);
540 return rc;
541}
542static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
543
544
545static struct attribute *dev_attrs[] = {
546 /* current configuration's attributes */
547 &dev_attr_configuration.attr,
548 &dev_attr_bNumInterfaces.attr,
549 &dev_attr_bConfigurationValue.attr,
550 &dev_attr_bmAttributes.attr,
551 &dev_attr_bMaxPower.attr,
552 /* device attributes */
553 &dev_attr_urbnum.attr,
554 &dev_attr_idVendor.attr,
555 &dev_attr_idProduct.attr,
556 &dev_attr_bcdDevice.attr,
557 &dev_attr_bDeviceClass.attr,
558 &dev_attr_bDeviceSubClass.attr,
559 &dev_attr_bDeviceProtocol.attr,
560 &dev_attr_bNumConfigurations.attr,
561 &dev_attr_bMaxPacketSize0.attr,
562 &dev_attr_speed.attr,
563 &dev_attr_busnum.attr,
564 &dev_attr_devnum.attr,
565 &dev_attr_devpath.attr,
566 &dev_attr_version.attr,
567 &dev_attr_maxchild.attr,
568 &dev_attr_quirks.attr,
569 &dev_attr_avoid_reset_quirk.attr,
570 &dev_attr_authorized.attr,
571 &dev_attr_remove.attr,
572 NULL,
573};
574static struct attribute_group dev_attr_grp = {
575 .attrs = dev_attrs,
576};
577
578/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
579 * accordingly.
580 */
581static struct attribute *dev_string_attrs[] = {
582 &dev_attr_manufacturer.attr,
583 &dev_attr_product.attr,
584 &dev_attr_serial.attr,
585 NULL
586};
587
588static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
589 struct attribute *a, int n)
590{
591 struct device *dev = container_of(kobj, struct device, kobj);
592 struct usb_device *udev = to_usb_device(dev);
593
594 if (a == &dev_attr_manufacturer.attr) {
595 if (udev->manufacturer == NULL)
596 return 0;
597 } else if (a == &dev_attr_product.attr) {
598 if (udev->product == NULL)
599 return 0;
600 } else if (a == &dev_attr_serial.attr) {
601 if (udev->serial == NULL)
602 return 0;
603 }
604 return a->mode;
605}
606
607static struct attribute_group dev_string_attr_grp = {
608 .attrs = dev_string_attrs,
609 .is_visible = dev_string_attrs_are_visible,
610};
611
612const struct attribute_group *usb_device_groups[] = {
613 &dev_attr_grp,
614 &dev_string_attr_grp,
615 NULL
616};
617
618/* Binary descriptors */
619
620static ssize_t
621read_descriptors(struct file *filp, struct kobject *kobj,
622 struct bin_attribute *attr,
623 char *buf, loff_t off, size_t count)
624{
625 struct device *dev = container_of(kobj, struct device, kobj);
626 struct usb_device *udev = to_usb_device(dev);
627 size_t nleft = count;
628 size_t srclen, n;
629 int cfgno;
630 void *src;
631
632 /* The binary attribute begins with the device descriptor.
633 * Following that are the raw descriptor entries for all the
634 * configurations (config plus subsidiary descriptors).
635 */
636 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
637 nleft > 0; ++cfgno) {
638 if (cfgno < 0) {
639 src = &udev->descriptor;
640 srclen = sizeof(struct usb_device_descriptor);
641 } else {
642 src = udev->rawdescriptors[cfgno];
643 srclen = __le16_to_cpu(udev->config[cfgno].desc.
644 wTotalLength);
645 }
646 if (off < srclen) {
647 n = min(nleft, srclen - (size_t) off);
648 memcpy(buf, src + off, n);
649 nleft -= n;
650 buf += n;
651 off = 0;
652 } else {
653 off -= srclen;
654 }
655 }
656 return count - nleft;
657}
658
659static struct bin_attribute dev_bin_attr_descriptors = {
660 .attr = {.name = "descriptors", .mode = 0444},
661 .read = read_descriptors,
662 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
663};
664
665int usb_create_sysfs_dev_files(struct usb_device *udev)
666{
667 struct device *dev = &udev->dev;
668 int retval;
669
670 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
671 if (retval)
672 goto error;
673
674 retval = add_persist_attributes(dev);
675 if (retval)
676 goto error;
677
678 retval = add_power_attributes(dev);
679 if (retval)
680 goto error;
681 return retval;
682error:
683 usb_remove_sysfs_dev_files(udev);
684 return retval;
685}
686
687void usb_remove_sysfs_dev_files(struct usb_device *udev)
688{
689 struct device *dev = &udev->dev;
690
691 remove_power_attributes(dev);
692 remove_persist_attributes(dev);
693 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
694}
695
696/* Interface Accociation Descriptor fields */
697#define usb_intf_assoc_attr(field, format_string) \
698static ssize_t \
699show_iad_##field(struct device *dev, struct device_attribute *attr, \
700 char *buf) \
701{ \
702 struct usb_interface *intf = to_usb_interface(dev); \
703 \
704 return sprintf(buf, format_string, \
705 intf->intf_assoc->field); \
706} \
707static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
708
709usb_intf_assoc_attr(bFirstInterface, "%02x\n")
710usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
711usb_intf_assoc_attr(bFunctionClass, "%02x\n")
712usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
713usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
714
715/* Interface fields */
716#define usb_intf_attr(field, format_string) \
717static ssize_t \
718show_##field(struct device *dev, struct device_attribute *attr, \
719 char *buf) \
720{ \
721 struct usb_interface *intf = to_usb_interface(dev); \
722 \
723 return sprintf(buf, format_string, \
724 intf->cur_altsetting->desc.field); \
725} \
726static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
727
728usb_intf_attr(bInterfaceNumber, "%02x\n")
729usb_intf_attr(bAlternateSetting, "%2d\n")
730usb_intf_attr(bNumEndpoints, "%02x\n")
731usb_intf_attr(bInterfaceClass, "%02x\n")
732usb_intf_attr(bInterfaceSubClass, "%02x\n")
733usb_intf_attr(bInterfaceProtocol, "%02x\n")
734
735static ssize_t show_interface_string(struct device *dev,
736 struct device_attribute *attr, char *buf)
737{
738 struct usb_interface *intf;
739 char *string;
740
741 intf = to_usb_interface(dev);
742 string = intf->cur_altsetting->string;
743 barrier(); /* The altsetting might change! */
744
745 if (!string)
746 return 0;
747 return sprintf(buf, "%s\n", string);
748}
749static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
750
751static ssize_t show_modalias(struct device *dev,
752 struct device_attribute *attr, char *buf)
753{
754 struct usb_interface *intf;
755 struct usb_device *udev;
756 struct usb_host_interface *alt;
757
758 intf = to_usb_interface(dev);
759 udev = interface_to_usbdev(intf);
760 alt = intf->cur_altsetting;
761
762 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
763 "ic%02Xisc%02Xip%02X\n",
764 le16_to_cpu(udev->descriptor.idVendor),
765 le16_to_cpu(udev->descriptor.idProduct),
766 le16_to_cpu(udev->descriptor.bcdDevice),
767 udev->descriptor.bDeviceClass,
768 udev->descriptor.bDeviceSubClass,
769 udev->descriptor.bDeviceProtocol,
770 alt->desc.bInterfaceClass,
771 alt->desc.bInterfaceSubClass,
772 alt->desc.bInterfaceProtocol);
773}
774static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
775
776static ssize_t show_supports_autosuspend(struct device *dev,
777 struct device_attribute *attr, char *buf)
778{
779 struct usb_interface *intf;
780 struct usb_device *udev;
781 int ret;
782
783 intf = to_usb_interface(dev);
784 udev = interface_to_usbdev(intf);
785
786 usb_lock_device(udev);
787 /* Devices will be autosuspended even when an interface isn't claimed */
788 if (!intf->dev.driver ||
789 to_usb_driver(intf->dev.driver)->supports_autosuspend)
790 ret = sprintf(buf, "%u\n", 1);
791 else
792 ret = sprintf(buf, "%u\n", 0);
793 usb_unlock_device(udev);
794
795 return ret;
796}
797static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
798
799static struct attribute *intf_attrs[] = {
800 &dev_attr_bInterfaceNumber.attr,
801 &dev_attr_bAlternateSetting.attr,
802 &dev_attr_bNumEndpoints.attr,
803 &dev_attr_bInterfaceClass.attr,
804 &dev_attr_bInterfaceSubClass.attr,
805 &dev_attr_bInterfaceProtocol.attr,
806 &dev_attr_modalias.attr,
807 &dev_attr_supports_autosuspend.attr,
808 NULL,
809};
810static struct attribute_group intf_attr_grp = {
811 .attrs = intf_attrs,
812};
813
814static struct attribute *intf_assoc_attrs[] = {
815 &dev_attr_iad_bFirstInterface.attr,
816 &dev_attr_iad_bInterfaceCount.attr,
817 &dev_attr_iad_bFunctionClass.attr,
818 &dev_attr_iad_bFunctionSubClass.attr,
819 &dev_attr_iad_bFunctionProtocol.attr,
820 NULL,
821};
822
823static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
824 struct attribute *a, int n)
825{
826 struct device *dev = container_of(kobj, struct device, kobj);
827 struct usb_interface *intf = to_usb_interface(dev);
828
829 if (intf->intf_assoc == NULL)
830 return 0;
831 return a->mode;
832}
833
834static struct attribute_group intf_assoc_attr_grp = {
835 .attrs = intf_assoc_attrs,
836 .is_visible = intf_assoc_attrs_are_visible,
837};
838
839const struct attribute_group *usb_interface_groups[] = {
840 &intf_attr_grp,
841 &intf_assoc_attr_grp,
842 NULL
843};
844
845void usb_create_sysfs_intf_files(struct usb_interface *intf)
846{
847 struct usb_device *udev = interface_to_usbdev(intf);
848 struct usb_host_interface *alt = intf->cur_altsetting;
849
850 if (intf->sysfs_files_created || intf->unregistering)
851 return;
852
853 if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
854 alt->string = usb_cache_string(udev, alt->desc.iInterface);
855 if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
856 ; /* We don't actually care if the function fails. */
857 intf->sysfs_files_created = 1;
858}
859
860void usb_remove_sysfs_intf_files(struct usb_interface *intf)
861{
862 if (!intf->sysfs_files_created)
863 return;
864
865 device_remove_file(&intf->dev, &dev_attr_interface);
866 intf->sysfs_files_created = 0;
867}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/usb/core/sysfs.c
4 *
5 * (C) Copyright 2002 David Brownell
6 * (C) Copyright 2002,2004 Greg Kroah-Hartman
7 * (C) Copyright 2002,2004 IBM Corp.
8 *
9 * All of the sysfs file attributes for usb devices and interfaces.
10 *
11 * Released under the GPLv2 only.
12 */
13
14
15#include <linux/kernel.h>
16#include <linux/string.h>
17#include <linux/usb.h>
18#include <linux/usb/quirks.h>
19#include <linux/of.h>
20#include "usb.h"
21
22/* Active configuration fields */
23#define usb_actconfig_show(field, format_string) \
24static ssize_t field##_show(struct device *dev, \
25 struct device_attribute *attr, char *buf) \
26{ \
27 struct usb_device *udev; \
28 struct usb_host_config *actconfig; \
29 ssize_t rc; \
30 \
31 udev = to_usb_device(dev); \
32 rc = usb_lock_device_interruptible(udev); \
33 if (rc < 0) \
34 return -EINTR; \
35 actconfig = udev->actconfig; \
36 if (actconfig) \
37 rc = sprintf(buf, format_string, \
38 actconfig->desc.field); \
39 usb_unlock_device(udev); \
40 return rc; \
41} \
42
43#define usb_actconfig_attr(field, format_string) \
44 usb_actconfig_show(field, format_string) \
45 static DEVICE_ATTR_RO(field)
46
47usb_actconfig_attr(bNumInterfaces, "%2d\n");
48usb_actconfig_attr(bmAttributes, "%2x\n");
49
50static ssize_t bMaxPower_show(struct device *dev,
51 struct device_attribute *attr, char *buf)
52{
53 struct usb_device *udev;
54 struct usb_host_config *actconfig;
55 ssize_t rc;
56
57 udev = to_usb_device(dev);
58 rc = usb_lock_device_interruptible(udev);
59 if (rc < 0)
60 return -EINTR;
61 actconfig = udev->actconfig;
62 if (actconfig)
63 rc = sprintf(buf, "%dmA\n", usb_get_max_power(udev, actconfig));
64 usb_unlock_device(udev);
65 return rc;
66}
67static DEVICE_ATTR_RO(bMaxPower);
68
69static ssize_t configuration_show(struct device *dev,
70 struct device_attribute *attr, char *buf)
71{
72 struct usb_device *udev;
73 struct usb_host_config *actconfig;
74 ssize_t rc;
75
76 udev = to_usb_device(dev);
77 rc = usb_lock_device_interruptible(udev);
78 if (rc < 0)
79 return -EINTR;
80 actconfig = udev->actconfig;
81 if (actconfig && actconfig->string)
82 rc = sprintf(buf, "%s\n", actconfig->string);
83 usb_unlock_device(udev);
84 return rc;
85}
86static DEVICE_ATTR_RO(configuration);
87
88/* configuration value is always present, and r/w */
89usb_actconfig_show(bConfigurationValue, "%u\n");
90
91static ssize_t bConfigurationValue_store(struct device *dev,
92 struct device_attribute *attr,
93 const char *buf, size_t count)
94{
95 struct usb_device *udev = to_usb_device(dev);
96 int config, value, rc;
97
98 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
99 return -EINVAL;
100 rc = usb_lock_device_interruptible(udev);
101 if (rc < 0)
102 return -EINTR;
103 value = usb_set_configuration(udev, config);
104 usb_unlock_device(udev);
105 return (value < 0) ? value : count;
106}
107static DEVICE_ATTR_IGNORE_LOCKDEP(bConfigurationValue, S_IRUGO | S_IWUSR,
108 bConfigurationValue_show, bConfigurationValue_store);
109
110#ifdef CONFIG_OF
111static ssize_t devspec_show(struct device *dev, struct device_attribute *attr,
112 char *buf)
113{
114 struct device_node *of_node = dev->of_node;
115
116 return sprintf(buf, "%pOF\n", of_node);
117}
118static DEVICE_ATTR_RO(devspec);
119#endif
120
121/* String fields */
122#define usb_string_attr(name) \
123static ssize_t name##_show(struct device *dev, \
124 struct device_attribute *attr, char *buf) \
125{ \
126 struct usb_device *udev; \
127 int retval; \
128 \
129 udev = to_usb_device(dev); \
130 retval = usb_lock_device_interruptible(udev); \
131 if (retval < 0) \
132 return -EINTR; \
133 retval = sprintf(buf, "%s\n", udev->name); \
134 usb_unlock_device(udev); \
135 return retval; \
136} \
137static DEVICE_ATTR_RO(name)
138
139usb_string_attr(product);
140usb_string_attr(manufacturer);
141usb_string_attr(serial);
142
143static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
144 char *buf)
145{
146 struct usb_device *udev;
147 char *speed;
148
149 udev = to_usb_device(dev);
150
151 switch (udev->speed) {
152 case USB_SPEED_LOW:
153 speed = "1.5";
154 break;
155 case USB_SPEED_UNKNOWN:
156 case USB_SPEED_FULL:
157 speed = "12";
158 break;
159 case USB_SPEED_HIGH:
160 speed = "480";
161 break;
162 case USB_SPEED_WIRELESS:
163 speed = "480";
164 break;
165 case USB_SPEED_SUPER:
166 speed = "5000";
167 break;
168 case USB_SPEED_SUPER_PLUS:
169 speed = "10000";
170 break;
171 default:
172 speed = "unknown";
173 }
174 return sprintf(buf, "%s\n", speed);
175}
176static DEVICE_ATTR_RO(speed);
177
178static ssize_t busnum_show(struct device *dev, struct device_attribute *attr,
179 char *buf)
180{
181 struct usb_device *udev;
182
183 udev = to_usb_device(dev);
184 return sprintf(buf, "%d\n", udev->bus->busnum);
185}
186static DEVICE_ATTR_RO(busnum);
187
188static ssize_t devnum_show(struct device *dev, struct device_attribute *attr,
189 char *buf)
190{
191 struct usb_device *udev;
192
193 udev = to_usb_device(dev);
194 return sprintf(buf, "%d\n", udev->devnum);
195}
196static DEVICE_ATTR_RO(devnum);
197
198static ssize_t devpath_show(struct device *dev, struct device_attribute *attr,
199 char *buf)
200{
201 struct usb_device *udev;
202
203 udev = to_usb_device(dev);
204 return sprintf(buf, "%s\n", udev->devpath);
205}
206static DEVICE_ATTR_RO(devpath);
207
208static ssize_t version_show(struct device *dev, struct device_attribute *attr,
209 char *buf)
210{
211 struct usb_device *udev;
212 u16 bcdUSB;
213
214 udev = to_usb_device(dev);
215 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
216 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
217}
218static DEVICE_ATTR_RO(version);
219
220static ssize_t maxchild_show(struct device *dev, struct device_attribute *attr,
221 char *buf)
222{
223 struct usb_device *udev;
224
225 udev = to_usb_device(dev);
226 return sprintf(buf, "%d\n", udev->maxchild);
227}
228static DEVICE_ATTR_RO(maxchild);
229
230static ssize_t quirks_show(struct device *dev, struct device_attribute *attr,
231 char *buf)
232{
233 struct usb_device *udev;
234
235 udev = to_usb_device(dev);
236 return sprintf(buf, "0x%x\n", udev->quirks);
237}
238static DEVICE_ATTR_RO(quirks);
239
240static ssize_t avoid_reset_quirk_show(struct device *dev,
241 struct device_attribute *attr, char *buf)
242{
243 struct usb_device *udev;
244
245 udev = to_usb_device(dev);
246 return sprintf(buf, "%d\n", !!(udev->quirks & USB_QUIRK_RESET));
247}
248
249static ssize_t avoid_reset_quirk_store(struct device *dev,
250 struct device_attribute *attr,
251 const char *buf, size_t count)
252{
253 struct usb_device *udev = to_usb_device(dev);
254 int val, rc;
255
256 if (sscanf(buf, "%d", &val) != 1 || val < 0 || val > 1)
257 return -EINVAL;
258 rc = usb_lock_device_interruptible(udev);
259 if (rc < 0)
260 return -EINTR;
261 if (val)
262 udev->quirks |= USB_QUIRK_RESET;
263 else
264 udev->quirks &= ~USB_QUIRK_RESET;
265 usb_unlock_device(udev);
266 return count;
267}
268static DEVICE_ATTR_RW(avoid_reset_quirk);
269
270static ssize_t urbnum_show(struct device *dev, struct device_attribute *attr,
271 char *buf)
272{
273 struct usb_device *udev;
274
275 udev = to_usb_device(dev);
276 return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
277}
278static DEVICE_ATTR_RO(urbnum);
279
280static ssize_t removable_show(struct device *dev, struct device_attribute *attr,
281 char *buf)
282{
283 struct usb_device *udev;
284 char *state;
285
286 udev = to_usb_device(dev);
287
288 switch (udev->removable) {
289 case USB_DEVICE_REMOVABLE:
290 state = "removable";
291 break;
292 case USB_DEVICE_FIXED:
293 state = "fixed";
294 break;
295 default:
296 state = "unknown";
297 }
298
299 return sprintf(buf, "%s\n", state);
300}
301static DEVICE_ATTR_RO(removable);
302
303static ssize_t ltm_capable_show(struct device *dev,
304 struct device_attribute *attr, char *buf)
305{
306 if (usb_device_supports_ltm(to_usb_device(dev)))
307 return sprintf(buf, "%s\n", "yes");
308 return sprintf(buf, "%s\n", "no");
309}
310static DEVICE_ATTR_RO(ltm_capable);
311
312#ifdef CONFIG_PM
313
314static ssize_t persist_show(struct device *dev, struct device_attribute *attr,
315 char *buf)
316{
317 struct usb_device *udev = to_usb_device(dev);
318
319 return sprintf(buf, "%d\n", udev->persist_enabled);
320}
321
322static ssize_t persist_store(struct device *dev, struct device_attribute *attr,
323 const char *buf, size_t count)
324{
325 struct usb_device *udev = to_usb_device(dev);
326 int value, rc;
327
328 /* Hubs are always enabled for USB_PERSIST */
329 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
330 return -EPERM;
331
332 if (sscanf(buf, "%d", &value) != 1)
333 return -EINVAL;
334
335 rc = usb_lock_device_interruptible(udev);
336 if (rc < 0)
337 return -EINTR;
338 udev->persist_enabled = !!value;
339 usb_unlock_device(udev);
340 return count;
341}
342static DEVICE_ATTR_RW(persist);
343
344static int add_persist_attributes(struct device *dev)
345{
346 int rc = 0;
347
348 if (is_usb_device(dev)) {
349 struct usb_device *udev = to_usb_device(dev);
350
351 /* Hubs are automatically enabled for USB_PERSIST,
352 * no point in creating the attribute file.
353 */
354 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
355 rc = sysfs_add_file_to_group(&dev->kobj,
356 &dev_attr_persist.attr,
357 power_group_name);
358 }
359 return rc;
360}
361
362static void remove_persist_attributes(struct device *dev)
363{
364 sysfs_remove_file_from_group(&dev->kobj,
365 &dev_attr_persist.attr,
366 power_group_name);
367}
368
369static ssize_t connected_duration_show(struct device *dev,
370 struct device_attribute *attr, char *buf)
371{
372 struct usb_device *udev = to_usb_device(dev);
373
374 return sprintf(buf, "%u\n",
375 jiffies_to_msecs(jiffies - udev->connect_time));
376}
377static DEVICE_ATTR_RO(connected_duration);
378
379/*
380 * If the device is resumed, the last time the device was suspended has
381 * been pre-subtracted from active_duration. We add the current time to
382 * get the duration that the device was actually active.
383 *
384 * If the device is suspended, the active_duration is up-to-date.
385 */
386static ssize_t active_duration_show(struct device *dev,
387 struct device_attribute *attr, char *buf)
388{
389 struct usb_device *udev = to_usb_device(dev);
390 int duration;
391
392 if (udev->state != USB_STATE_SUSPENDED)
393 duration = jiffies_to_msecs(jiffies + udev->active_duration);
394 else
395 duration = jiffies_to_msecs(udev->active_duration);
396 return sprintf(buf, "%u\n", duration);
397}
398static DEVICE_ATTR_RO(active_duration);
399
400static ssize_t autosuspend_show(struct device *dev,
401 struct device_attribute *attr, char *buf)
402{
403 return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
404}
405
406static ssize_t autosuspend_store(struct device *dev,
407 struct device_attribute *attr, const char *buf,
408 size_t count)
409{
410 int value;
411
412 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
413 value <= -INT_MAX/1000)
414 return -EINVAL;
415
416 pm_runtime_set_autosuspend_delay(dev, value * 1000);
417 return count;
418}
419static DEVICE_ATTR_RW(autosuspend);
420
421static const char on_string[] = "on";
422static const char auto_string[] = "auto";
423
424static void warn_level(void)
425{
426 static int level_warned;
427
428 if (!level_warned) {
429 level_warned = 1;
430 printk(KERN_WARNING "WARNING! power/level is deprecated; "
431 "use power/control instead\n");
432 }
433}
434
435static ssize_t level_show(struct device *dev, struct device_attribute *attr,
436 char *buf)
437{
438 struct usb_device *udev = to_usb_device(dev);
439 const char *p = auto_string;
440
441 warn_level();
442 if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
443 p = on_string;
444 return sprintf(buf, "%s\n", p);
445}
446
447static ssize_t level_store(struct device *dev, struct device_attribute *attr,
448 const char *buf, size_t count)
449{
450 struct usb_device *udev = to_usb_device(dev);
451 int len = count;
452 char *cp;
453 int rc = count;
454 int rv;
455
456 warn_level();
457 cp = memchr(buf, '\n', count);
458 if (cp)
459 len = cp - buf;
460
461 rv = usb_lock_device_interruptible(udev);
462 if (rv < 0)
463 return -EINTR;
464
465 if (len == sizeof on_string - 1 &&
466 strncmp(buf, on_string, len) == 0)
467 usb_disable_autosuspend(udev);
468
469 else if (len == sizeof auto_string - 1 &&
470 strncmp(buf, auto_string, len) == 0)
471 usb_enable_autosuspend(udev);
472
473 else
474 rc = -EINVAL;
475
476 usb_unlock_device(udev);
477 return rc;
478}
479static DEVICE_ATTR_RW(level);
480
481static ssize_t usb2_hardware_lpm_show(struct device *dev,
482 struct device_attribute *attr, char *buf)
483{
484 struct usb_device *udev = to_usb_device(dev);
485 const char *p;
486
487 if (udev->usb2_hw_lpm_allowed == 1)
488 p = "enabled";
489 else
490 p = "disabled";
491
492 return sprintf(buf, "%s\n", p);
493}
494
495static ssize_t usb2_hardware_lpm_store(struct device *dev,
496 struct device_attribute *attr,
497 const char *buf, size_t count)
498{
499 struct usb_device *udev = to_usb_device(dev);
500 bool value;
501 int ret;
502
503 ret = usb_lock_device_interruptible(udev);
504 if (ret < 0)
505 return -EINTR;
506
507 ret = strtobool(buf, &value);
508
509 if (!ret) {
510 udev->usb2_hw_lpm_allowed = value;
511 ret = usb_set_usb2_hardware_lpm(udev, value);
512 }
513
514 usb_unlock_device(udev);
515
516 if (!ret)
517 return count;
518
519 return ret;
520}
521static DEVICE_ATTR_RW(usb2_hardware_lpm);
522
523static ssize_t usb2_lpm_l1_timeout_show(struct device *dev,
524 struct device_attribute *attr,
525 char *buf)
526{
527 struct usb_device *udev = to_usb_device(dev);
528 return sprintf(buf, "%d\n", udev->l1_params.timeout);
529}
530
531static ssize_t usb2_lpm_l1_timeout_store(struct device *dev,
532 struct device_attribute *attr,
533 const char *buf, size_t count)
534{
535 struct usb_device *udev = to_usb_device(dev);
536 u16 timeout;
537
538 if (kstrtou16(buf, 0, &timeout))
539 return -EINVAL;
540
541 udev->l1_params.timeout = timeout;
542
543 return count;
544}
545static DEVICE_ATTR_RW(usb2_lpm_l1_timeout);
546
547static ssize_t usb2_lpm_besl_show(struct device *dev,
548 struct device_attribute *attr, char *buf)
549{
550 struct usb_device *udev = to_usb_device(dev);
551 return sprintf(buf, "%d\n", udev->l1_params.besl);
552}
553
554static ssize_t usb2_lpm_besl_store(struct device *dev,
555 struct device_attribute *attr,
556 const char *buf, size_t count)
557{
558 struct usb_device *udev = to_usb_device(dev);
559 u8 besl;
560
561 if (kstrtou8(buf, 0, &besl) || besl > 15)
562 return -EINVAL;
563
564 udev->l1_params.besl = besl;
565
566 return count;
567}
568static DEVICE_ATTR_RW(usb2_lpm_besl);
569
570static ssize_t usb3_hardware_lpm_u1_show(struct device *dev,
571 struct device_attribute *attr, char *buf)
572{
573 struct usb_device *udev = to_usb_device(dev);
574 const char *p;
575 int rc;
576
577 rc = usb_lock_device_interruptible(udev);
578 if (rc < 0)
579 return -EINTR;
580
581 if (udev->usb3_lpm_u1_enabled)
582 p = "enabled";
583 else
584 p = "disabled";
585
586 usb_unlock_device(udev);
587
588 return sprintf(buf, "%s\n", p);
589}
590static DEVICE_ATTR_RO(usb3_hardware_lpm_u1);
591
592static ssize_t usb3_hardware_lpm_u2_show(struct device *dev,
593 struct device_attribute *attr, char *buf)
594{
595 struct usb_device *udev = to_usb_device(dev);
596 const char *p;
597 int rc;
598
599 rc = usb_lock_device_interruptible(udev);
600 if (rc < 0)
601 return -EINTR;
602
603 if (udev->usb3_lpm_u2_enabled)
604 p = "enabled";
605 else
606 p = "disabled";
607
608 usb_unlock_device(udev);
609
610 return sprintf(buf, "%s\n", p);
611}
612static DEVICE_ATTR_RO(usb3_hardware_lpm_u2);
613
614static struct attribute *usb2_hardware_lpm_attr[] = {
615 &dev_attr_usb2_hardware_lpm.attr,
616 &dev_attr_usb2_lpm_l1_timeout.attr,
617 &dev_attr_usb2_lpm_besl.attr,
618 NULL,
619};
620static struct attribute_group usb2_hardware_lpm_attr_group = {
621 .name = power_group_name,
622 .attrs = usb2_hardware_lpm_attr,
623};
624
625static struct attribute *usb3_hardware_lpm_attr[] = {
626 &dev_attr_usb3_hardware_lpm_u1.attr,
627 &dev_attr_usb3_hardware_lpm_u2.attr,
628 NULL,
629};
630static struct attribute_group usb3_hardware_lpm_attr_group = {
631 .name = power_group_name,
632 .attrs = usb3_hardware_lpm_attr,
633};
634
635static struct attribute *power_attrs[] = {
636 &dev_attr_autosuspend.attr,
637 &dev_attr_level.attr,
638 &dev_attr_connected_duration.attr,
639 &dev_attr_active_duration.attr,
640 NULL,
641};
642static struct attribute_group power_attr_group = {
643 .name = power_group_name,
644 .attrs = power_attrs,
645};
646
647static int add_power_attributes(struct device *dev)
648{
649 int rc = 0;
650
651 if (is_usb_device(dev)) {
652 struct usb_device *udev = to_usb_device(dev);
653 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
654 if (udev->usb2_hw_lpm_capable == 1)
655 rc = sysfs_merge_group(&dev->kobj,
656 &usb2_hardware_lpm_attr_group);
657 if ((udev->speed == USB_SPEED_SUPER ||
658 udev->speed == USB_SPEED_SUPER_PLUS) &&
659 udev->lpm_capable == 1)
660 rc = sysfs_merge_group(&dev->kobj,
661 &usb3_hardware_lpm_attr_group);
662 }
663
664 return rc;
665}
666
667static void remove_power_attributes(struct device *dev)
668{
669 sysfs_unmerge_group(&dev->kobj, &usb2_hardware_lpm_attr_group);
670 sysfs_unmerge_group(&dev->kobj, &power_attr_group);
671}
672
673#else
674
675#define add_persist_attributes(dev) 0
676#define remove_persist_attributes(dev) do {} while (0)
677
678#define add_power_attributes(dev) 0
679#define remove_power_attributes(dev) do {} while (0)
680
681#endif /* CONFIG_PM */
682
683
684/* Descriptor fields */
685#define usb_descriptor_attr_le16(field, format_string) \
686static ssize_t \
687field##_show(struct device *dev, struct device_attribute *attr, \
688 char *buf) \
689{ \
690 struct usb_device *udev; \
691 \
692 udev = to_usb_device(dev); \
693 return sprintf(buf, format_string, \
694 le16_to_cpu(udev->descriptor.field)); \
695} \
696static DEVICE_ATTR_RO(field)
697
698usb_descriptor_attr_le16(idVendor, "%04x\n");
699usb_descriptor_attr_le16(idProduct, "%04x\n");
700usb_descriptor_attr_le16(bcdDevice, "%04x\n");
701
702#define usb_descriptor_attr(field, format_string) \
703static ssize_t \
704field##_show(struct device *dev, struct device_attribute *attr, \
705 char *buf) \
706{ \
707 struct usb_device *udev; \
708 \
709 udev = to_usb_device(dev); \
710 return sprintf(buf, format_string, udev->descriptor.field); \
711} \
712static DEVICE_ATTR_RO(field)
713
714usb_descriptor_attr(bDeviceClass, "%02x\n");
715usb_descriptor_attr(bDeviceSubClass, "%02x\n");
716usb_descriptor_attr(bDeviceProtocol, "%02x\n");
717usb_descriptor_attr(bNumConfigurations, "%d\n");
718usb_descriptor_attr(bMaxPacketSize0, "%d\n");
719
720
721/* show if the device is authorized (1) or not (0) */
722static ssize_t authorized_show(struct device *dev,
723 struct device_attribute *attr, char *buf)
724{
725 struct usb_device *usb_dev = to_usb_device(dev);
726 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
727}
728
729/*
730 * Authorize a device to be used in the system
731 *
732 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
733 */
734static ssize_t authorized_store(struct device *dev,
735 struct device_attribute *attr, const char *buf,
736 size_t size)
737{
738 ssize_t result;
739 struct usb_device *usb_dev = to_usb_device(dev);
740 unsigned val;
741 result = sscanf(buf, "%u\n", &val);
742 if (result != 1)
743 result = -EINVAL;
744 else if (val == 0)
745 result = usb_deauthorize_device(usb_dev);
746 else
747 result = usb_authorize_device(usb_dev);
748 return result < 0 ? result : size;
749}
750static DEVICE_ATTR_IGNORE_LOCKDEP(authorized, S_IRUGO | S_IWUSR,
751 authorized_show, authorized_store);
752
753/* "Safely remove a device" */
754static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
755 const char *buf, size_t count)
756{
757 struct usb_device *udev = to_usb_device(dev);
758 int rc = 0;
759
760 usb_lock_device(udev);
761 if (udev->state != USB_STATE_NOTATTACHED) {
762
763 /* To avoid races, first unconfigure and then remove */
764 usb_set_configuration(udev, -1);
765 rc = usb_remove_device(udev);
766 }
767 if (rc == 0)
768 rc = count;
769 usb_unlock_device(udev);
770 return rc;
771}
772static DEVICE_ATTR_IGNORE_LOCKDEP(remove, S_IWUSR, NULL, remove_store);
773
774
775static struct attribute *dev_attrs[] = {
776 /* current configuration's attributes */
777 &dev_attr_configuration.attr,
778 &dev_attr_bNumInterfaces.attr,
779 &dev_attr_bConfigurationValue.attr,
780 &dev_attr_bmAttributes.attr,
781 &dev_attr_bMaxPower.attr,
782 /* device attributes */
783 &dev_attr_urbnum.attr,
784 &dev_attr_idVendor.attr,
785 &dev_attr_idProduct.attr,
786 &dev_attr_bcdDevice.attr,
787 &dev_attr_bDeviceClass.attr,
788 &dev_attr_bDeviceSubClass.attr,
789 &dev_attr_bDeviceProtocol.attr,
790 &dev_attr_bNumConfigurations.attr,
791 &dev_attr_bMaxPacketSize0.attr,
792 &dev_attr_speed.attr,
793 &dev_attr_busnum.attr,
794 &dev_attr_devnum.attr,
795 &dev_attr_devpath.attr,
796 &dev_attr_version.attr,
797 &dev_attr_maxchild.attr,
798 &dev_attr_quirks.attr,
799 &dev_attr_avoid_reset_quirk.attr,
800 &dev_attr_authorized.attr,
801 &dev_attr_remove.attr,
802 &dev_attr_removable.attr,
803 &dev_attr_ltm_capable.attr,
804#ifdef CONFIG_OF
805 &dev_attr_devspec.attr,
806#endif
807 NULL,
808};
809static struct attribute_group dev_attr_grp = {
810 .attrs = dev_attrs,
811};
812
813/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
814 * accordingly.
815 */
816static struct attribute *dev_string_attrs[] = {
817 &dev_attr_manufacturer.attr,
818 &dev_attr_product.attr,
819 &dev_attr_serial.attr,
820 NULL
821};
822
823static umode_t dev_string_attrs_are_visible(struct kobject *kobj,
824 struct attribute *a, int n)
825{
826 struct device *dev = container_of(kobj, struct device, kobj);
827 struct usb_device *udev = to_usb_device(dev);
828
829 if (a == &dev_attr_manufacturer.attr) {
830 if (udev->manufacturer == NULL)
831 return 0;
832 } else if (a == &dev_attr_product.attr) {
833 if (udev->product == NULL)
834 return 0;
835 } else if (a == &dev_attr_serial.attr) {
836 if (udev->serial == NULL)
837 return 0;
838 }
839 return a->mode;
840}
841
842static struct attribute_group dev_string_attr_grp = {
843 .attrs = dev_string_attrs,
844 .is_visible = dev_string_attrs_are_visible,
845};
846
847const struct attribute_group *usb_device_groups[] = {
848 &dev_attr_grp,
849 &dev_string_attr_grp,
850 NULL
851};
852
853/* Binary descriptors */
854
855static ssize_t
856read_descriptors(struct file *filp, struct kobject *kobj,
857 struct bin_attribute *attr,
858 char *buf, loff_t off, size_t count)
859{
860 struct device *dev = container_of(kobj, struct device, kobj);
861 struct usb_device *udev = to_usb_device(dev);
862 size_t nleft = count;
863 size_t srclen, n;
864 int cfgno;
865 void *src;
866
867 /* The binary attribute begins with the device descriptor.
868 * Following that are the raw descriptor entries for all the
869 * configurations (config plus subsidiary descriptors).
870 */
871 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
872 nleft > 0; ++cfgno) {
873 if (cfgno < 0) {
874 src = &udev->descriptor;
875 srclen = sizeof(struct usb_device_descriptor);
876 } else {
877 src = udev->rawdescriptors[cfgno];
878 srclen = __le16_to_cpu(udev->config[cfgno].desc.
879 wTotalLength);
880 }
881 if (off < srclen) {
882 n = min(nleft, srclen - (size_t) off);
883 memcpy(buf, src + off, n);
884 nleft -= n;
885 buf += n;
886 off = 0;
887 } else {
888 off -= srclen;
889 }
890 }
891 return count - nleft;
892}
893
894static struct bin_attribute dev_bin_attr_descriptors = {
895 .attr = {.name = "descriptors", .mode = 0444},
896 .read = read_descriptors,
897 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
898};
899
900int usb_create_sysfs_dev_files(struct usb_device *udev)
901{
902 struct device *dev = &udev->dev;
903 int retval;
904
905 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
906 if (retval)
907 goto error;
908
909 retval = add_persist_attributes(dev);
910 if (retval)
911 goto error;
912
913 retval = add_power_attributes(dev);
914 if (retval)
915 goto error;
916 return retval;
917error:
918 usb_remove_sysfs_dev_files(udev);
919 return retval;
920}
921
922void usb_remove_sysfs_dev_files(struct usb_device *udev)
923{
924 struct device *dev = &udev->dev;
925
926 remove_power_attributes(dev);
927 remove_persist_attributes(dev);
928 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
929}
930
931/* Interface Association Descriptor fields */
932#define usb_intf_assoc_attr(field, format_string) \
933static ssize_t \
934iad_##field##_show(struct device *dev, struct device_attribute *attr, \
935 char *buf) \
936{ \
937 struct usb_interface *intf = to_usb_interface(dev); \
938 \
939 return sprintf(buf, format_string, \
940 intf->intf_assoc->field); \
941} \
942static DEVICE_ATTR_RO(iad_##field)
943
944usb_intf_assoc_attr(bFirstInterface, "%02x\n");
945usb_intf_assoc_attr(bInterfaceCount, "%02d\n");
946usb_intf_assoc_attr(bFunctionClass, "%02x\n");
947usb_intf_assoc_attr(bFunctionSubClass, "%02x\n");
948usb_intf_assoc_attr(bFunctionProtocol, "%02x\n");
949
950/* Interface fields */
951#define usb_intf_attr(field, format_string) \
952static ssize_t \
953field##_show(struct device *dev, struct device_attribute *attr, \
954 char *buf) \
955{ \
956 struct usb_interface *intf = to_usb_interface(dev); \
957 \
958 return sprintf(buf, format_string, \
959 intf->cur_altsetting->desc.field); \
960} \
961static DEVICE_ATTR_RO(field)
962
963usb_intf_attr(bInterfaceNumber, "%02x\n");
964usb_intf_attr(bAlternateSetting, "%2d\n");
965usb_intf_attr(bNumEndpoints, "%02x\n");
966usb_intf_attr(bInterfaceClass, "%02x\n");
967usb_intf_attr(bInterfaceSubClass, "%02x\n");
968usb_intf_attr(bInterfaceProtocol, "%02x\n");
969
970static ssize_t interface_show(struct device *dev, struct device_attribute *attr,
971 char *buf)
972{
973 struct usb_interface *intf;
974 char *string;
975
976 intf = to_usb_interface(dev);
977 string = READ_ONCE(intf->cur_altsetting->string);
978 if (!string)
979 return 0;
980 return sprintf(buf, "%s\n", string);
981}
982static DEVICE_ATTR_RO(interface);
983
984static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
985 char *buf)
986{
987 struct usb_interface *intf;
988 struct usb_device *udev;
989 struct usb_host_interface *alt;
990
991 intf = to_usb_interface(dev);
992 udev = interface_to_usbdev(intf);
993 alt = READ_ONCE(intf->cur_altsetting);
994
995 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
996 "ic%02Xisc%02Xip%02Xin%02X\n",
997 le16_to_cpu(udev->descriptor.idVendor),
998 le16_to_cpu(udev->descriptor.idProduct),
999 le16_to_cpu(udev->descriptor.bcdDevice),
1000 udev->descriptor.bDeviceClass,
1001 udev->descriptor.bDeviceSubClass,
1002 udev->descriptor.bDeviceProtocol,
1003 alt->desc.bInterfaceClass,
1004 alt->desc.bInterfaceSubClass,
1005 alt->desc.bInterfaceProtocol,
1006 alt->desc.bInterfaceNumber);
1007}
1008static DEVICE_ATTR_RO(modalias);
1009
1010static ssize_t supports_autosuspend_show(struct device *dev,
1011 struct device_attribute *attr,
1012 char *buf)
1013{
1014 int s;
1015
1016 s = device_lock_interruptible(dev);
1017 if (s < 0)
1018 return -EINTR;
1019 /* Devices will be autosuspended even when an interface isn't claimed */
1020 s = (!dev->driver || to_usb_driver(dev->driver)->supports_autosuspend);
1021 device_unlock(dev);
1022
1023 return sprintf(buf, "%u\n", s);
1024}
1025static DEVICE_ATTR_RO(supports_autosuspend);
1026
1027/*
1028 * interface_authorized_show - show authorization status of an USB interface
1029 * 1 is authorized, 0 is deauthorized
1030 */
1031static ssize_t interface_authorized_show(struct device *dev,
1032 struct device_attribute *attr, char *buf)
1033{
1034 struct usb_interface *intf = to_usb_interface(dev);
1035
1036 return sprintf(buf, "%u\n", intf->authorized);
1037}
1038
1039/*
1040 * interface_authorized_store - authorize or deauthorize an USB interface
1041 */
1042static ssize_t interface_authorized_store(struct device *dev,
1043 struct device_attribute *attr, const char *buf, size_t count)
1044{
1045 struct usb_interface *intf = to_usb_interface(dev);
1046 bool val;
1047
1048 if (strtobool(buf, &val) != 0)
1049 return -EINVAL;
1050
1051 if (val)
1052 usb_authorize_interface(intf);
1053 else
1054 usb_deauthorize_interface(intf);
1055
1056 return count;
1057}
1058static struct device_attribute dev_attr_interface_authorized =
1059 __ATTR(authorized, S_IRUGO | S_IWUSR,
1060 interface_authorized_show, interface_authorized_store);
1061
1062static struct attribute *intf_attrs[] = {
1063 &dev_attr_bInterfaceNumber.attr,
1064 &dev_attr_bAlternateSetting.attr,
1065 &dev_attr_bNumEndpoints.attr,
1066 &dev_attr_bInterfaceClass.attr,
1067 &dev_attr_bInterfaceSubClass.attr,
1068 &dev_attr_bInterfaceProtocol.attr,
1069 &dev_attr_modalias.attr,
1070 &dev_attr_supports_autosuspend.attr,
1071 &dev_attr_interface_authorized.attr,
1072 NULL,
1073};
1074static struct attribute_group intf_attr_grp = {
1075 .attrs = intf_attrs,
1076};
1077
1078static struct attribute *intf_assoc_attrs[] = {
1079 &dev_attr_iad_bFirstInterface.attr,
1080 &dev_attr_iad_bInterfaceCount.attr,
1081 &dev_attr_iad_bFunctionClass.attr,
1082 &dev_attr_iad_bFunctionSubClass.attr,
1083 &dev_attr_iad_bFunctionProtocol.attr,
1084 NULL,
1085};
1086
1087static umode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
1088 struct attribute *a, int n)
1089{
1090 struct device *dev = container_of(kobj, struct device, kobj);
1091 struct usb_interface *intf = to_usb_interface(dev);
1092
1093 if (intf->intf_assoc == NULL)
1094 return 0;
1095 return a->mode;
1096}
1097
1098static struct attribute_group intf_assoc_attr_grp = {
1099 .attrs = intf_assoc_attrs,
1100 .is_visible = intf_assoc_attrs_are_visible,
1101};
1102
1103const struct attribute_group *usb_interface_groups[] = {
1104 &intf_attr_grp,
1105 &intf_assoc_attr_grp,
1106 NULL
1107};
1108
1109void usb_create_sysfs_intf_files(struct usb_interface *intf)
1110{
1111 struct usb_device *udev = interface_to_usbdev(intf);
1112 struct usb_host_interface *alt = intf->cur_altsetting;
1113
1114 if (intf->sysfs_files_created || intf->unregistering)
1115 return;
1116
1117 if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
1118 alt->string = usb_cache_string(udev, alt->desc.iInterface);
1119 if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
1120 ; /* We don't actually care if the function fails. */
1121 intf->sysfs_files_created = 1;
1122}
1123
1124void usb_remove_sysfs_intf_files(struct usb_interface *intf)
1125{
1126 if (!intf->sysfs_files_created)
1127 return;
1128
1129 device_remove_file(&intf->dev, &dev_attr_interface);
1130 intf->sysfs_files_created = 0;
1131}