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