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