]> err.no Git - linux-2.6/blob - drivers/usb/core/sysfs.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/mingo/linux-2.6-sched
[linux-2.6] / drivers / usb / core / sysfs.c
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)            \
20 static 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)            \
36 usb_actconfig_show(field, multiplier, format_string)                    \
37 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
38
39 usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
40 usb_actconfig_attr(bmAttributes, 1, "%2x\n")
41 usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
42
43 static 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 }
55 static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
56
57 /* configuration value is always present, and r/w */
58 usb_actconfig_show(bConfigurationValue, 1, "%u\n");
59
60 static ssize_t
61 set_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
75 static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR, 
76                 show_bConfigurationValue, set_bConfigurationValue);
77
78 /* String fields */
79 #define usb_string_attr(name)                                           \
80 static 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 }                                                                       \
88 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
89
90 usb_string_attr(product);
91 usb_string_attr(manufacturer);
92 usb_string_attr(serial);
93
94 static ssize_t
95 show_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 }
118 static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
119
120 static ssize_t
121 show_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 }
128 static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
129
130 static ssize_t
131 show_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 }
138 static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
139
140 static ssize_t
141 show_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 }
150 static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
151
152 static ssize_t
153 show_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 }
160 static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
161
162 static ssize_t
163 show_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 }
170 static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
171
172
173 #if defined(CONFIG_USB_PERSIST) || defined(CONFIG_USB_SUSPEND)
174 static const char power_group[] = "power";
175 #endif
176
177 #ifdef  CONFIG_USB_PERSIST
178
179 static ssize_t
180 show_persist(struct device *dev, struct device_attribute *attr, char *buf)
181 {
182         struct usb_device *udev = to_usb_device(dev);
183
184         return sprintf(buf, "%d\n", udev->persist_enabled);
185 }
186
187 static ssize_t
188 set_persist(struct device *dev, struct device_attribute *attr,
189                 const char *buf, size_t count)
190 {
191         struct usb_device *udev = to_usb_device(dev);
192         int value;
193
194         /* Hubs are always enabled for USB_PERSIST */
195         if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
196                 return -EPERM;
197
198         if (sscanf(buf, "%d", &value) != 1)
199                 return -EINVAL;
200         usb_pm_lock(udev);
201         udev->persist_enabled = !!value;
202         usb_pm_unlock(udev);
203         return count;
204 }
205
206 static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
207
208 static int add_persist_attributes(struct device *dev)
209 {
210         int rc = 0;
211
212         if (is_usb_device(dev)) {
213                 struct usb_device *udev = to_usb_device(dev);
214
215                 /* Hubs are automatically enabled for USB_PERSIST */
216                 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
217                         udev->persist_enabled = 1;
218                 rc = sysfs_add_file_to_group(&dev->kobj,
219                                 &dev_attr_persist.attr,
220                                 power_group);
221         }
222         return rc;
223 }
224
225 static void remove_persist_attributes(struct device *dev)
226 {
227         sysfs_remove_file_from_group(&dev->kobj,
228                         &dev_attr_persist.attr,
229                         power_group);
230 }
231
232 #else
233
234 #define add_persist_attributes(dev)     0
235 #define remove_persist_attributes(dev)  do {} while (0)
236
237 #endif  /* CONFIG_USB_PERSIST */
238
239 #ifdef  CONFIG_USB_SUSPEND
240
241 static ssize_t
242 show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
243 {
244         struct usb_device *udev = to_usb_device(dev);
245
246         return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
247 }
248
249 static ssize_t
250 set_autosuspend(struct device *dev, struct device_attribute *attr,
251                 const char *buf, size_t count)
252 {
253         struct usb_device *udev = to_usb_device(dev);
254         int value;
255
256         if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
257                         value <= - INT_MAX/HZ)
258                 return -EINVAL;
259         value *= HZ;
260
261         udev->autosuspend_delay = value;
262         if (value >= 0)
263                 usb_try_autosuspend_device(udev);
264         else {
265                 if (usb_autoresume_device(udev) == 0)
266                         usb_autosuspend_device(udev);
267         }
268         return count;
269 }
270
271 static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
272                 show_autosuspend, set_autosuspend);
273
274 static const char on_string[] = "on";
275 static const char auto_string[] = "auto";
276 static const char suspend_string[] = "suspend";
277
278 static ssize_t
279 show_level(struct device *dev, struct device_attribute *attr, char *buf)
280 {
281         struct usb_device *udev = to_usb_device(dev);
282         const char *p = auto_string;
283
284         if (udev->state == USB_STATE_SUSPENDED) {
285                 if (udev->autoresume_disabled)
286                         p = suspend_string;
287         } else {
288                 if (udev->autosuspend_disabled)
289                         p = on_string;
290         }
291         return sprintf(buf, "%s\n", p);
292 }
293
294 static ssize_t
295 set_level(struct device *dev, struct device_attribute *attr,
296                 const char *buf, size_t count)
297 {
298         struct usb_device *udev = to_usb_device(dev);
299         int len = count;
300         char *cp;
301         int rc = 0;
302         int old_autosuspend_disabled, old_autoresume_disabled;
303
304         cp = memchr(buf, '\n', count);
305         if (cp)
306                 len = cp - buf;
307
308         usb_lock_device(udev);
309         old_autosuspend_disabled = udev->autosuspend_disabled;
310         old_autoresume_disabled = udev->autoresume_disabled;
311
312         /* Setting the flags without calling usb_pm_lock is a subject to
313          * races, but who cares...
314          */
315         if (len == sizeof on_string - 1 &&
316                         strncmp(buf, on_string, len) == 0) {
317                 udev->autosuspend_disabled = 1;
318                 udev->autoresume_disabled = 0;
319                 rc = usb_external_resume_device(udev);
320
321         } else if (len == sizeof auto_string - 1 &&
322                         strncmp(buf, auto_string, len) == 0) {
323                 udev->autosuspend_disabled = 0;
324                 udev->autoresume_disabled = 0;
325                 rc = usb_external_resume_device(udev);
326
327         } else if (len == sizeof suspend_string - 1 &&
328                         strncmp(buf, suspend_string, len) == 0) {
329                 udev->autosuspend_disabled = 0;
330                 udev->autoresume_disabled = 1;
331                 rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
332
333         } else
334                 rc = -EINVAL;
335
336         if (rc) {
337                 udev->autosuspend_disabled = old_autosuspend_disabled;
338                 udev->autoresume_disabled = old_autoresume_disabled;
339         }
340         usb_unlock_device(udev);
341         return (rc < 0 ? rc : count);
342 }
343
344 static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
345
346 static int add_power_attributes(struct device *dev)
347 {
348         int rc = 0;
349
350         if (is_usb_device(dev)) {
351                 rc = sysfs_add_file_to_group(&dev->kobj,
352                                 &dev_attr_autosuspend.attr,
353                                 power_group);
354                 if (rc == 0)
355                         rc = sysfs_add_file_to_group(&dev->kobj,
356                                         &dev_attr_level.attr,
357                                         power_group);
358         }
359         return rc;
360 }
361
362 static void remove_power_attributes(struct device *dev)
363 {
364         sysfs_remove_file_from_group(&dev->kobj,
365                         &dev_attr_level.attr,
366                         power_group);
367         sysfs_remove_file_from_group(&dev->kobj,
368                         &dev_attr_autosuspend.attr,
369                         power_group);
370 }
371
372 #else
373
374 #define add_power_attributes(dev)       0
375 #define remove_power_attributes(dev)    do {} while (0)
376
377 #endif  /* CONFIG_USB_SUSPEND */
378
379
380 /* Descriptor fields */
381 #define usb_descriptor_attr_le16(field, format_string)                  \
382 static ssize_t                                                          \
383 show_##field(struct device *dev, struct device_attribute *attr, \
384                 char *buf)                                              \
385 {                                                                       \
386         struct usb_device *udev;                                        \
387                                                                         \
388         udev = to_usb_device(dev);                                      \
389         return sprintf(buf, format_string,                              \
390                         le16_to_cpu(udev->descriptor.field));           \
391 }                                                                       \
392 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
393
394 usb_descriptor_attr_le16(idVendor, "%04x\n")
395 usb_descriptor_attr_le16(idProduct, "%04x\n")
396 usb_descriptor_attr_le16(bcdDevice, "%04x\n")
397
398 #define usb_descriptor_attr(field, format_string)                       \
399 static ssize_t                                                          \
400 show_##field(struct device *dev, struct device_attribute *attr, \
401                 char *buf)                                              \
402 {                                                                       \
403         struct usb_device *udev;                                        \
404                                                                         \
405         udev = to_usb_device(dev);                                      \
406         return sprintf(buf, format_string, udev->descriptor.field);     \
407 }                                                                       \
408 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
409
410 usb_descriptor_attr(bDeviceClass, "%02x\n")
411 usb_descriptor_attr(bDeviceSubClass, "%02x\n")
412 usb_descriptor_attr(bDeviceProtocol, "%02x\n")
413 usb_descriptor_attr(bNumConfigurations, "%d\n")
414 usb_descriptor_attr(bMaxPacketSize0, "%d\n")
415
416 static struct attribute *dev_attrs[] = {
417         /* current configuration's attributes */
418         &dev_attr_configuration.attr,
419         &dev_attr_bNumInterfaces.attr,
420         &dev_attr_bConfigurationValue.attr,
421         &dev_attr_bmAttributes.attr,
422         &dev_attr_bMaxPower.attr,
423         /* device attributes */
424         &dev_attr_idVendor.attr,
425         &dev_attr_idProduct.attr,
426         &dev_attr_bcdDevice.attr,
427         &dev_attr_bDeviceClass.attr,
428         &dev_attr_bDeviceSubClass.attr,
429         &dev_attr_bDeviceProtocol.attr,
430         &dev_attr_bNumConfigurations.attr,
431         &dev_attr_bMaxPacketSize0.attr,
432         &dev_attr_speed.attr,
433         &dev_attr_busnum.attr,
434         &dev_attr_devnum.attr,
435         &dev_attr_version.attr,
436         &dev_attr_maxchild.attr,
437         &dev_attr_quirks.attr,
438         NULL,
439 };
440 static struct attribute_group dev_attr_grp = {
441         .attrs = dev_attrs,
442 };
443
444 int usb_create_sysfs_dev_files(struct usb_device *udev)
445 {
446         struct device *dev = &udev->dev;
447         int retval;
448
449         retval = sysfs_create_group(&dev->kobj, &dev_attr_grp);
450         if (retval)
451                 return retval;
452
453         retval = add_persist_attributes(dev);
454         if (retval)
455                 goto error;
456
457         retval = add_power_attributes(dev);
458         if (retval)
459                 goto error;
460
461         if (udev->manufacturer) {
462                 retval = device_create_file(dev, &dev_attr_manufacturer);
463                 if (retval)
464                         goto error;
465         }
466         if (udev->product) {
467                 retval = device_create_file(dev, &dev_attr_product);
468                 if (retval)
469                         goto error;
470         }
471         if (udev->serial) {
472                 retval = device_create_file(dev, &dev_attr_serial);
473                 if (retval)
474                         goto error;
475         }
476         retval = usb_create_ep_files(dev, &udev->ep0, udev);
477         if (retval)
478                 goto error;
479         return 0;
480 error:
481         usb_remove_sysfs_dev_files(udev);
482         return retval;
483 }
484
485 void usb_remove_sysfs_dev_files(struct usb_device *udev)
486 {
487         struct device *dev = &udev->dev;
488
489         usb_remove_ep_files(&udev->ep0);
490         device_remove_file(dev, &dev_attr_manufacturer);
491         device_remove_file(dev, &dev_attr_product);
492         device_remove_file(dev, &dev_attr_serial);
493         remove_power_attributes(dev);
494         remove_persist_attributes(dev);
495         sysfs_remove_group(&dev->kobj, &dev_attr_grp);
496 }
497
498 /* Interface Accociation Descriptor fields */
499 #define usb_intf_assoc_attr(field, format_string)                       \
500 static ssize_t                                                          \
501 show_iad_##field (struct device *dev, struct device_attribute *attr,    \
502                 char *buf)                                              \
503 {                                                                       \
504         struct usb_interface *intf = to_usb_interface (dev);            \
505                                                                         \
506         return sprintf (buf, format_string,                             \
507                         intf->intf_assoc->field);               \
508 }                                                                       \
509 static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
510
511 usb_intf_assoc_attr (bFirstInterface, "%02x\n")
512 usb_intf_assoc_attr (bInterfaceCount, "%02d\n")
513 usb_intf_assoc_attr (bFunctionClass, "%02x\n")
514 usb_intf_assoc_attr (bFunctionSubClass, "%02x\n")
515 usb_intf_assoc_attr (bFunctionProtocol, "%02x\n")
516
517 /* Interface fields */
518 #define usb_intf_attr(field, format_string)                             \
519 static ssize_t                                                          \
520 show_##field(struct device *dev, struct device_attribute *attr, \
521                 char *buf)                                              \
522 {                                                                       \
523         struct usb_interface *intf = to_usb_interface(dev);             \
524                                                                         \
525         return sprintf(buf, format_string,                              \
526                         intf->cur_altsetting->desc.field);              \
527 }                                                                       \
528 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
529
530 usb_intf_attr(bInterfaceNumber, "%02x\n")
531 usb_intf_attr(bAlternateSetting, "%2d\n")
532 usb_intf_attr(bNumEndpoints, "%02x\n")
533 usb_intf_attr(bInterfaceClass, "%02x\n")
534 usb_intf_attr(bInterfaceSubClass, "%02x\n")
535 usb_intf_attr(bInterfaceProtocol, "%02x\n")
536
537 static ssize_t show_interface_string(struct device *dev,
538                 struct device_attribute *attr, char *buf)
539 {
540         struct usb_interface *intf;
541         struct usb_device *udev;
542         int len;
543
544         intf = to_usb_interface(dev);
545         udev = interface_to_usbdev(intf);
546         len = snprintf(buf, 256, "%s", intf->cur_altsetting->string);
547         if (len < 0)
548                 return 0;
549         buf[len] = '\n';
550         buf[len+1] = 0;
551         return len+1;
552 }
553 static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
554
555 static ssize_t show_modalias(struct device *dev,
556                 struct device_attribute *attr, char *buf)
557 {
558         struct usb_interface *intf;
559         struct usb_device *udev;
560         struct usb_host_interface *alt;
561
562         intf = to_usb_interface(dev);
563         udev = interface_to_usbdev(intf);
564         alt = intf->cur_altsetting;
565
566         return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
567                         "ic%02Xisc%02Xip%02X\n",
568                         le16_to_cpu(udev->descriptor.idVendor),
569                         le16_to_cpu(udev->descriptor.idProduct),
570                         le16_to_cpu(udev->descriptor.bcdDevice),
571                         udev->descriptor.bDeviceClass,
572                         udev->descriptor.bDeviceSubClass,
573                         udev->descriptor.bDeviceProtocol,
574                         alt->desc.bInterfaceClass,
575                         alt->desc.bInterfaceSubClass,
576                         alt->desc.bInterfaceProtocol);
577 }
578 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
579
580 static struct attribute *intf_assoc_attrs[] = {
581         &dev_attr_iad_bFirstInterface.attr,
582         &dev_attr_iad_bInterfaceCount.attr,
583         &dev_attr_iad_bFunctionClass.attr,
584         &dev_attr_iad_bFunctionSubClass.attr,
585         &dev_attr_iad_bFunctionProtocol.attr,
586         NULL,
587 };
588 static struct attribute_group intf_assoc_attr_grp = {
589         .attrs = intf_assoc_attrs,
590 };
591
592 static struct attribute *intf_attrs[] = {
593         &dev_attr_bInterfaceNumber.attr,
594         &dev_attr_bAlternateSetting.attr,
595         &dev_attr_bNumEndpoints.attr,
596         &dev_attr_bInterfaceClass.attr,
597         &dev_attr_bInterfaceSubClass.attr,
598         &dev_attr_bInterfaceProtocol.attr,
599         &dev_attr_modalias.attr,
600         NULL,
601 };
602 static struct attribute_group intf_attr_grp = {
603         .attrs = intf_attrs,
604 };
605
606 static inline void usb_create_intf_ep_files(struct usb_interface *intf,
607                 struct usb_device *udev)
608 {
609         struct usb_host_interface *iface_desc;
610         int i;
611
612         iface_desc = intf->cur_altsetting;
613         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
614                 usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
615                                 udev);
616 }
617
618 static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
619 {
620         struct usb_host_interface *iface_desc;
621         int i;
622
623         iface_desc = intf->cur_altsetting;
624         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
625                 usb_remove_ep_files(&iface_desc->endpoint[i]);
626 }
627
628 int usb_create_sysfs_intf_files(struct usb_interface *intf)
629 {
630         struct device *dev = &intf->dev;
631         struct usb_device *udev = interface_to_usbdev(intf);
632         struct usb_host_interface *alt = intf->cur_altsetting;
633         int retval;
634
635         retval = sysfs_create_group(&dev->kobj, &intf_attr_grp);
636         if (retval)
637                 return retval;
638
639         if (alt->string == NULL)
640                 alt->string = usb_cache_string(udev, alt->desc.iInterface);
641         if (alt->string)
642                 retval = device_create_file(dev, &dev_attr_interface);
643         if (intf->intf_assoc)
644                 retval = sysfs_create_group(&dev->kobj, &intf_assoc_attr_grp);
645         usb_create_intf_ep_files(intf, udev);
646         return 0;
647 }
648
649 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
650 {
651         struct device *dev = &intf->dev;
652
653         usb_remove_intf_ep_files(intf);
654         device_remove_file(dev, &dev_attr_interface);
655         sysfs_remove_group(&dev->kobj, &intf_attr_grp);
656         sysfs_remove_group(&intf->dev.kobj, &intf_assoc_attr_grp);
657 }