Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 "usb.h"
17
18/* Active configuration fields */
19#define usb_actconfig_show(field, multiplier, format_string) \
20static ssize_t show_##field(struct device *dev, \
21 struct device_attribute *attr, char *buf) \
22{ \
23 struct usb_device *udev; \
24 struct usb_host_config *actconfig; \
25 \
26 udev = to_usb_device(dev); \
27 actconfig = udev->actconfig; \
28 if (actconfig) \
29 return sprintf(buf, format_string, \
30 actconfig->desc.field * multiplier); \
31 else \
32 return 0; \
33} \
34
35#define usb_actconfig_attr(field, multiplier, format_string) \
36usb_actconfig_show(field, multiplier, format_string) \
37static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
38
39usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
40usb_actconfig_attr(bmAttributes, 1, "%2x\n")
41usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
42
43static ssize_t show_configuration_string(struct device *dev,
44 struct device_attribute *attr, char *buf)
45{
46 struct usb_device *udev;
47 struct usb_host_config *actconfig;
48
49 udev = to_usb_device(dev);
50 actconfig = udev->actconfig;
51 if ((!actconfig) || (!actconfig->string))
52 return 0;
53 return sprintf(buf, "%s\n", actconfig->string);
54}
55static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
56
57/* configuration value is always present, and r/w */
58usb_actconfig_show(bConfigurationValue, 1, "%u\n");
59
60static ssize_t
61set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
62 const char *buf, size_t count)
63{
64 struct usb_device *udev = to_usb_device(dev);
65 int config, value;
66
67 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
68 return -EINVAL;
69 usb_lock_device(udev);
70 value = usb_set_configuration(udev, config);
71 usb_unlock_device(udev);
72 return (value < 0) ? value : count;
73}
74
75static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
76 show_bConfigurationValue, set_bConfigurationValue);
77
78/* String fields */
79#define usb_string_attr(name) \
80static ssize_t show_##name(struct device *dev, \
81 struct device_attribute *attr, char *buf) \
82{ \
83 struct usb_device *udev; \
84 \
85 udev = to_usb_device(dev); \
86 return sprintf(buf, "%s\n", udev->name); \
87} \
88static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
89
90usb_string_attr(product);
91usb_string_attr(manufacturer);
92usb_string_attr(serial);
93
94static ssize_t
95show_speed(struct device *dev, struct device_attribute *attr, char *buf)
96{
97 struct usb_device *udev;
98 char *speed;
99
100 udev = to_usb_device(dev);
101
102 switch (udev->speed) {
103 case USB_SPEED_LOW:
104 speed = "1.5";
105 break;
106 case USB_SPEED_UNKNOWN:
107 case USB_SPEED_FULL:
108 speed = "12";
109 break;
110 case USB_SPEED_HIGH:
111 speed = "480";
112 break;
113 default:
114 speed = "unknown";
115 }
116 return sprintf(buf, "%s\n", speed);
117}
118static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
119
120static ssize_t
121show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
122{
123 struct usb_device *udev;
124
125 udev = to_usb_device(dev);
126 return sprintf(buf, "%d\n", udev->bus->busnum);
127}
128static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
129
130static ssize_t
131show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
132{
133 struct usb_device *udev;
134
135 udev = to_usb_device(dev);
136 return sprintf(buf, "%d\n", udev->devnum);
137}
138static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
139
140static ssize_t
141show_version(struct device *dev, struct device_attribute *attr, char *buf)
142{
143 struct usb_device *udev;
144 u16 bcdUSB;
145
146 udev = to_usb_device(dev);
147 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
148 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
149}
150static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
151
152static ssize_t
153show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
154{
155 struct usb_device *udev;
156
157 udev = to_usb_device(dev);
158 return sprintf(buf, "%d\n", udev->maxchild);
159}
160static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
161
162static ssize_t
163show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
164{
165 struct usb_device *udev;
166
167 udev = to_usb_device(dev);
168 return sprintf(buf, "0x%x\n", udev->quirks);
169}
170static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
171
172#ifdef CONFIG_USB_SUSPEND
173
174static ssize_t
175show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
176{
177 struct usb_device *udev = to_usb_device(dev);
178
179 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
180}
181
182static ssize_t
183set_autosuspend(struct device *dev, struct device_attribute *attr,
184 const char *buf, size_t count)
185{
186 struct usb_device *udev = to_usb_device(dev);
187 int value;
188
189 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
190 value <= - INT_MAX/HZ)
191 return -EINVAL;
192 value *= HZ;
193
194 udev->autosuspend_delay = value;
195 if (value >= 0)
196 usb_try_autosuspend_device(udev);
197 else {
198 if (usb_autoresume_device(udev) == 0)
199 usb_autosuspend_device(udev);
200 }
201 return count;
202}
203
204static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
205 show_autosuspend, set_autosuspend);
206
207static const char on_string[] = "on";
208static const char auto_string[] = "auto";
209static const char suspend_string[] = "suspend";
210
211static ssize_t
212show_level(struct device *dev, struct device_attribute *attr, char *buf)
213{
214 struct usb_device *udev = to_usb_device(dev);
215 const char *p = auto_string;
216
217 if (udev->state == USB_STATE_SUSPENDED) {
218 if (udev->autoresume_disabled)
219 p = suspend_string;
220 } else {
221 if (udev->autosuspend_disabled)
222 p = on_string;
223 }
224 return sprintf(buf, "%s\n", p);
225}
226
227static ssize_t
228set_level(struct device *dev, struct device_attribute *attr,
229 const char *buf, size_t count)
230{
231 struct usb_device *udev = to_usb_device(dev);
232 int len = count;
233 char *cp;
234 int rc = 0;
235
236 cp = memchr(buf, '\n', count);
237 if (cp)
238 len = cp - buf;
239
240 usb_lock_device(udev);
241
242 /* Setting the flags without calling usb_pm_lock is a subject to
243 * races, but who cares...
244 */
245 if (len == sizeof on_string - 1 &&
246 strncmp(buf, on_string, len) == 0) {
247 udev->autosuspend_disabled = 1;
248 udev->autoresume_disabled = 0;
249 rc = usb_external_resume_device(udev);
250
251 } else if (len == sizeof auto_string - 1 &&
252 strncmp(buf, auto_string, len) == 0) {
253 udev->autosuspend_disabled = 0;
254 udev->autoresume_disabled = 0;
255 rc = usb_external_resume_device(udev);
256
257 } else if (len == sizeof suspend_string - 1 &&
258 strncmp(buf, suspend_string, len) == 0) {
259 udev->autosuspend_disabled = 0;
260 udev->autoresume_disabled = 1;
261 rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
262
263 } else
264 rc = -EINVAL;
265
266 usb_unlock_device(udev);
267 return (rc < 0 ? rc : count);
268}
269
270static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
271
272static char power_group[] = "power";
273
274static int add_power_attributes(struct device *dev)
275{
276 int rc = 0;
277
278 if (is_usb_device(dev)) {
279 rc = sysfs_add_file_to_group(&dev->kobj,
280 &dev_attr_autosuspend.attr,
281 power_group);
282 if (rc == 0)
283 rc = sysfs_add_file_to_group(&dev->kobj,
284 &dev_attr_level.attr,
285 power_group);
286 }
287 return rc;
288}
289
290static void remove_power_attributes(struct device *dev)
291{
292 sysfs_remove_file_from_group(&dev->kobj,
293 &dev_attr_level.attr,
294 power_group);
295 sysfs_remove_file_from_group(&dev->kobj,
296 &dev_attr_autosuspend.attr,
297 power_group);
298}
299
300#else
301
302#define add_power_attributes(dev) 0
303#define remove_power_attributes(dev) do {} while (0)
304
305#endif /* CONFIG_USB_SUSPEND */
306
307/* Descriptor fields */
308#define usb_descriptor_attr_le16(field, format_string) \
309static ssize_t \
310show_##field(struct device *dev, struct device_attribute *attr, \
311 char *buf) \
312{ \
313 struct usb_device *udev; \
314 \
315 udev = to_usb_device(dev); \
316 return sprintf(buf, format_string, \
317 le16_to_cpu(udev->descriptor.field)); \
318} \
319static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
320
321usb_descriptor_attr_le16(idVendor, "%04x\n")
322usb_descriptor_attr_le16(idProduct, "%04x\n")
323usb_descriptor_attr_le16(bcdDevice, "%04x\n")
324
325#define usb_descriptor_attr(field, format_string) \
326static ssize_t \
327show_##field(struct device *dev, struct device_attribute *attr, \
328 char *buf) \
329{ \
330 struct usb_device *udev; \
331 \
332 udev = to_usb_device(dev); \
333 return sprintf(buf, format_string, udev->descriptor.field); \
334} \
335static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
336
337usb_descriptor_attr(bDeviceClass, "%02x\n")
338usb_descriptor_attr(bDeviceSubClass, "%02x\n")
339usb_descriptor_attr(bDeviceProtocol, "%02x\n")
340usb_descriptor_attr(bNumConfigurations, "%d\n")
341usb_descriptor_attr(bMaxPacketSize0, "%d\n")
342
343static struct attribute *dev_attrs[] = {
344 /* current configuration's attributes */
345 &dev_attr_configuration.attr,
346 &dev_attr_bNumInterfaces.attr,
347 &dev_attr_bConfigurationValue.attr,
348 &dev_attr_bmAttributes.attr,
349 &dev_attr_bMaxPower.attr,
350 /* device attributes */
351 &dev_attr_idVendor.attr,
352 &dev_attr_idProduct.attr,
353 &dev_attr_bcdDevice.attr,
354 &dev_attr_bDeviceClass.attr,
355 &dev_attr_bDeviceSubClass.attr,
356 &dev_attr_bDeviceProtocol.attr,
357 &dev_attr_bNumConfigurations.attr,
358 &dev_attr_bMaxPacketSize0.attr,
359 &dev_attr_speed.attr,
360 &dev_attr_busnum.attr,
361 &dev_attr_devnum.attr,
362 &dev_attr_version.attr,
363 &dev_attr_maxchild.attr,
364 &dev_attr_quirks.attr,
365 NULL,
366};
367static struct attribute_group dev_attr_grp = {
368 .attrs = dev_attrs,
369};
370
371int usb_create_sysfs_dev_files(struct usb_device *udev)
372{
373 struct device *dev = &udev->dev;
374 int retval;
375
376 retval = sysfs_create_group(&dev->kobj, &dev_attr_grp);
377 if (retval)
378 return retval;
379
380 retval = add_power_attributes(dev);
381 if (retval)
382 goto error;
383
384 if (udev->manufacturer) {
385 retval = device_create_file(dev, &dev_attr_manufacturer);
386 if (retval)
387 goto error;
388 }
389 if (udev->product) {
390 retval = device_create_file(dev, &dev_attr_product);
391 if (retval)
392 goto error;
393 }
394 if (udev->serial) {
395 retval = device_create_file(dev, &dev_attr_serial);
396 if (retval)
397 goto error;
398 }
399 retval = usb_create_ep_files(dev, &udev->ep0, udev);
400 if (retval)
401 goto error;
402 return 0;
403error:
404 usb_remove_sysfs_dev_files(udev);
405 return retval;
406}
407
408void usb_remove_sysfs_dev_files(struct usb_device *udev)
409{
410 struct device *dev = &udev->dev;
411
412 usb_remove_ep_files(&udev->ep0);
413 device_remove_file(dev, &dev_attr_manufacturer);
414 device_remove_file(dev, &dev_attr_product);
415 device_remove_file(dev, &dev_attr_serial);
416 remove_power_attributes(dev);
417 sysfs_remove_group(&dev->kobj, &dev_attr_grp);
418}
419
420/* Interface fields */
421#define usb_intf_attr(field, format_string) \
422static ssize_t \
423show_##field(struct device *dev, struct device_attribute *attr, \
424 char *buf) \
425{ \
426 struct usb_interface *intf = to_usb_interface(dev); \
427 \
428 return sprintf(buf, format_string, \
429 intf->cur_altsetting->desc.field); \
430} \
431static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
432
433usb_intf_attr(bInterfaceNumber, "%02x\n")
434usb_intf_attr(bAlternateSetting, "%2d\n")
435usb_intf_attr(bNumEndpoints, "%02x\n")
436usb_intf_attr(bInterfaceClass, "%02x\n")
437usb_intf_attr(bInterfaceSubClass, "%02x\n")
438usb_intf_attr(bInterfaceProtocol, "%02x\n")
439
440static ssize_t show_interface_string(struct device *dev,
441 struct device_attribute *attr, char *buf)
442{
443 struct usb_interface *intf;
444 struct usb_device *udev;
445 int len;
446
447 intf = to_usb_interface(dev);
448 udev = interface_to_usbdev(intf);
449 len = snprintf(buf, 256, "%s", intf->cur_altsetting->string);
450 if (len < 0)
451 return 0;
452 buf[len] = '\n';
453 buf[len+1] = 0;
454 return len+1;
455}
456static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
457
458static ssize_t show_modalias(struct device *dev,
459 struct device_attribute *attr, char *buf)
460{
461 struct usb_interface *intf;
462 struct usb_device *udev;
463 struct usb_host_interface *alt;
464
465 intf = to_usb_interface(dev);
466 udev = interface_to_usbdev(intf);
467 alt = intf->cur_altsetting;
468
469 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
470 "ic%02Xisc%02Xip%02X\n",
471 le16_to_cpu(udev->descriptor.idVendor),
472 le16_to_cpu(udev->descriptor.idProduct),
473 le16_to_cpu(udev->descriptor.bcdDevice),
474 udev->descriptor.bDeviceClass,
475 udev->descriptor.bDeviceSubClass,
476 udev->descriptor.bDeviceProtocol,
477 alt->desc.bInterfaceClass,
478 alt->desc.bInterfaceSubClass,
479 alt->desc.bInterfaceProtocol);
480}
481static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
482
483static struct attribute *intf_attrs[] = {
484 &dev_attr_bInterfaceNumber.attr,
485 &dev_attr_bAlternateSetting.attr,
486 &dev_attr_bNumEndpoints.attr,
487 &dev_attr_bInterfaceClass.attr,
488 &dev_attr_bInterfaceSubClass.attr,
489 &dev_attr_bInterfaceProtocol.attr,
490 &dev_attr_modalias.attr,
491 NULL,
492};
493static struct attribute_group intf_attr_grp = {
494 .attrs = intf_attrs,
495};
496
497static inline void usb_create_intf_ep_files(struct usb_interface *intf,
498 struct usb_device *udev)
499{
500 struct usb_host_interface *iface_desc;
501 int i;
502
503 iface_desc = intf->cur_altsetting;
504 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
505 usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
506 udev);
507}
508
509static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
510{
511 struct usb_host_interface *iface_desc;
512 int i;
513
514 iface_desc = intf->cur_altsetting;
515 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
516 usb_remove_ep_files(&iface_desc->endpoint[i]);
517}
518
519int usb_create_sysfs_intf_files(struct usb_interface *intf)
520{
521 struct device *dev = &intf->dev;
522 struct usb_device *udev = interface_to_usbdev(intf);
523 struct usb_host_interface *alt = intf->cur_altsetting;
524 int retval;
525
526 retval = sysfs_create_group(&dev->kobj, &intf_attr_grp);
527 if (retval)
528 return retval;
529
530 if (alt->string == NULL)
531 alt->string = usb_cache_string(udev, alt->desc.iInterface);
532 if (alt->string)
533 retval = device_create_file(dev, &dev_attr_interface);
534 usb_create_intf_ep_files(intf, udev);
535 return 0;
536}
537
538void usb_remove_sysfs_intf_files(struct usb_interface *intf)
539{
540 struct device *dev = &intf->dev;
541
542 usb_remove_intf_ep_files(intf);
543 device_remove_file(dev, &dev_attr_interface);
544 sysfs_remove_group(&dev->kobj, &intf_attr_grp);
545}