blob: 470e2413a9cfcf36ffc46df40c44b31586c49952 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/kernel.h>
Alan Stern2add5222007-03-20 14:59:39 -040014#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/usb.h>
Alan Stern1662e3a2009-03-18 14:28:53 -040016#include <linux/usb/quirks.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include "usb.h"
18
19/* Active configuration fields */
20#define usb_actconfig_show(field, multiplier, format_string) \
Oliver Neukum92516442007-01-23 15:55:28 -050021static ssize_t show_##field(struct device *dev, \
Alan Sternb724ae72005-10-24 15:36:00 -040022 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070023{ \
24 struct usb_device *udev; \
25 struct usb_host_config *actconfig; \
26 \
Oliver Neukum92516442007-01-23 15:55:28 -050027 udev = to_usb_device(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 actconfig = udev->actconfig; \
29 if (actconfig) \
Oliver Neukum92516442007-01-23 15:55:28 -050030 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 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
Oliver Neukum92516442007-01-23 15:55:28 -050040usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
41usb_actconfig_attr(bmAttributes, 1, "%2x\n")
42usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Alan Sternb724ae72005-10-24 15:36:00 -040044static ssize_t show_configuration_string(struct device *dev,
45 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046{
47 struct usb_device *udev;
48 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Oliver Neukum92516442007-01-23 15:55:28 -050050 udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 actconfig = udev->actconfig;
52 if ((!actconfig) || (!actconfig->string))
53 return 0;
Alan Stern4f62efe2005-10-24 16:24:14 -040054 return sprintf(buf, "%s\n", actconfig->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055}
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
Oliver Neukum92516442007-01-23 15:55:28 -050062set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
Alan Sternb724ae72005-10-24 15:36:00 -040063 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064{
Oliver Neukum92516442007-01-23 15:55:28 -050065 struct usb_device *udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 int config, value;
67
Alan Stern3f141e22007-02-08 16:40:43 -050068 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 return -EINVAL;
70 usb_lock_device(udev);
Oliver Neukum92516442007-01-23 15:55:28 -050071 value = usb_set_configuration(udev, config);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 usb_unlock_device(udev);
73 return (value < 0) ? value : count;
74}
75
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -080076static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 show_bConfigurationValue, set_bConfigurationValue);
78
79/* String fields */
80#define usb_string_attr(name) \
Alan Sternb724ae72005-10-24 15:36:00 -040081static ssize_t show_##name(struct device *dev, \
82 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{ \
84 struct usb_device *udev; \
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 \
Oliver Neukum92516442007-01-23 15:55:28 -050086 udev = to_usb_device(dev); \
Alan Stern4f62efe2005-10-24 16:24:14 -040087 return sprintf(buf, "%s\n", udev->name); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070088} \
89static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
90
91usb_string_attr(product);
92usb_string_attr(manufacturer);
93usb_string_attr(serial);
94
95static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -050096show_speed(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097{
98 struct usb_device *udev;
99 char *speed;
100
Oliver Neukum92516442007-01-23 15:55:28 -0500101 udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 switch (udev->speed) {
104 case USB_SPEED_LOW:
105 speed = "1.5";
106 break;
107 case USB_SPEED_UNKNOWN:
108 case USB_SPEED_FULL:
109 speed = "12";
110 break;
111 case USB_SPEED_HIGH:
112 speed = "480";
113 break;
114 default:
115 speed = "unknown";
116 }
Oliver Neukum92516442007-01-23 15:55:28 -0500117 return sprintf(buf, "%s\n", speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118}
119static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
120
121static ssize_t
Alan Stern83f7d952007-04-25 15:15:43 -0400122show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
123{
124 struct usb_device *udev;
125
126 udev = to_usb_device(dev);
127 return sprintf(buf, "%d\n", udev->bus->busnum);
128}
129static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
130
131static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500132show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
134 struct usb_device *udev;
135
Oliver Neukum92516442007-01-23 15:55:28 -0500136 udev = to_usb_device(dev);
137 return sprintf(buf, "%d\n", udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138}
139static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
140
141static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500142show_version(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 struct usb_device *udev;
145 u16 bcdUSB;
146
147 udev = to_usb_device(dev);
148 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
149 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
150}
151static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
152
153static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500154show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
156 struct usb_device *udev;
157
Oliver Neukum92516442007-01-23 15:55:28 -0500158 udev = to_usb_device(dev);
159 return sprintf(buf, "%d\n", udev->maxchild);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160}
161static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
162
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100163static ssize_t
164show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
165{
166 struct usb_device *udev;
167
168 udev = to_usb_device(dev);
169 return sprintf(buf, "0x%x\n", udev->quirks);
170}
171static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
172
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700173static ssize_t
174show_urbnum(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", atomic_read(&udev->urbnum));
180}
181static DEVICE_ATTR(urbnum, S_IRUGO, show_urbnum, NULL);
182
Alan Sternb41a60e2007-05-30 15:39:33 -0400183
Alan Sternfeccc302008-03-03 15:15:59 -0500184#ifdef CONFIG_PM
Alan Sternb41a60e2007-05-30 15:39:33 -0400185
Alan Sternfeccc302008-03-03 15:15:59 -0500186static const char power_group[] = "power";
Alan Sternb41a60e2007-05-30 15:39:33 -0400187
188static ssize_t
189show_persist(struct device *dev, struct device_attribute *attr, char *buf)
190{
191 struct usb_device *udev = to_usb_device(dev);
192
193 return sprintf(buf, "%d\n", udev->persist_enabled);
194}
195
196static ssize_t
197set_persist(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t count)
199{
200 struct usb_device *udev = to_usb_device(dev);
201 int value;
202
203 /* Hubs are always enabled for USB_PERSIST */
204 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
205 return -EPERM;
206
207 if (sscanf(buf, "%d", &value) != 1)
208 return -EINVAL;
209 usb_pm_lock(udev);
210 udev->persist_enabled = !!value;
211 usb_pm_unlock(udev);
212 return count;
213}
214
215static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
216
217static int add_persist_attributes(struct device *dev)
218{
219 int rc = 0;
220
221 if (is_usb_device(dev)) {
222 struct usb_device *udev = to_usb_device(dev);
223
Alan Sternfeccc302008-03-03 15:15:59 -0500224 /* Hubs are automatically enabled for USB_PERSIST,
225 * no point in creating the attribute file.
226 */
227 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
228 rc = sysfs_add_file_to_group(&dev->kobj,
229 &dev_attr_persist.attr,
230 power_group);
Alan Sternb41a60e2007-05-30 15:39:33 -0400231 }
232 return rc;
233}
234
235static void remove_persist_attributes(struct device *dev)
236{
237 sysfs_remove_file_from_group(&dev->kobj,
238 &dev_attr_persist.attr,
239 power_group);
240}
Alan Sternb41a60e2007-05-30 15:39:33 -0400241#else
242
243#define add_persist_attributes(dev) 0
244#define remove_persist_attributes(dev) do {} while (0)
245
Alan Sternfeccc302008-03-03 15:15:59 -0500246#endif /* CONFIG_PM */
Alan Sternb41a60e2007-05-30 15:39:33 -0400247
Alan Stern19c26232007-02-20 15:03:32 -0500248#ifdef CONFIG_USB_SUSPEND
249
250static ssize_t
Sarah Sharp15123002007-12-21 16:54:15 -0800251show_connected_duration(struct device *dev, struct device_attribute *attr,
252 char *buf)
253{
254 struct usb_device *udev = to_usb_device(dev);
255
256 return sprintf(buf, "%u\n",
257 jiffies_to_msecs(jiffies - udev->connect_time));
258}
259
260static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
261
262/*
263 * If the device is resumed, the last time the device was suspended has
264 * been pre-subtracted from active_duration. We add the current time to
265 * get the duration that the device was actually active.
266 *
267 * If the device is suspended, the active_duration is up-to-date.
268 */
269static ssize_t
270show_active_duration(struct device *dev, struct device_attribute *attr,
271 char *buf)
272{
273 struct usb_device *udev = to_usb_device(dev);
274 int duration;
275
276 if (udev->state != USB_STATE_SUSPENDED)
277 duration = jiffies_to_msecs(jiffies + udev->active_duration);
278 else
279 duration = jiffies_to_msecs(udev->active_duration);
280 return sprintf(buf, "%u\n", duration);
281}
282
283static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
284
285static ssize_t
Alan Stern19c26232007-02-20 15:03:32 -0500286show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
287{
288 struct usb_device *udev = to_usb_device(dev);
289
Alan Sterneaafbc32007-03-13 16:39:15 -0400290 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
Alan Stern19c26232007-02-20 15:03:32 -0500291}
292
293static ssize_t
294set_autosuspend(struct device *dev, struct device_attribute *attr,
295 const char *buf, size_t count)
296{
297 struct usb_device *udev = to_usb_device(dev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400298 int value;
Alan Stern19c26232007-02-20 15:03:32 -0500299
Alan Sterneaafbc32007-03-13 16:39:15 -0400300 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
301 value <= - INT_MAX/HZ)
Alan Stern19c26232007-02-20 15:03:32 -0500302 return -EINVAL;
303 value *= HZ;
304
Alan Stern19c26232007-02-20 15:03:32 -0500305 udev->autosuspend_delay = value;
Alan Sterneaafbc32007-03-13 16:39:15 -0400306 if (value >= 0)
Alan Stern19c26232007-02-20 15:03:32 -0500307 usb_try_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400308 else {
Alan Stern2add5222007-03-20 14:59:39 -0400309 if (usb_autoresume_device(udev) == 0)
310 usb_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400311 }
Alan Stern19c26232007-02-20 15:03:32 -0500312 return count;
313}
314
315static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
316 show_autosuspend, set_autosuspend);
317
Alan Stern2add5222007-03-20 14:59:39 -0400318static const char on_string[] = "on";
319static const char auto_string[] = "auto";
320static const char suspend_string[] = "suspend";
321
322static ssize_t
323show_level(struct device *dev, struct device_attribute *attr, char *buf)
324{
325 struct usb_device *udev = to_usb_device(dev);
326 const char *p = auto_string;
327
328 if (udev->state == USB_STATE_SUSPENDED) {
329 if (udev->autoresume_disabled)
330 p = suspend_string;
331 } else {
332 if (udev->autosuspend_disabled)
333 p = on_string;
334 }
335 return sprintf(buf, "%s\n", p);
336}
337
338static ssize_t
339set_level(struct device *dev, struct device_attribute *attr,
340 const char *buf, size_t count)
341{
342 struct usb_device *udev = to_usb_device(dev);
343 int len = count;
344 char *cp;
345 int rc = 0;
Alan Sterndd865572007-05-22 11:38:19 -0400346 int old_autosuspend_disabled, old_autoresume_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400347
348 cp = memchr(buf, '\n', count);
349 if (cp)
350 len = cp - buf;
351
352 usb_lock_device(udev);
Alan Sterndd865572007-05-22 11:38:19 -0400353 old_autosuspend_disabled = udev->autosuspend_disabled;
354 old_autoresume_disabled = udev->autoresume_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400355
356 /* Setting the flags without calling usb_pm_lock is a subject to
357 * races, but who cares...
358 */
359 if (len == sizeof on_string - 1 &&
360 strncmp(buf, on_string, len) == 0) {
361 udev->autosuspend_disabled = 1;
362 udev->autoresume_disabled = 0;
Alan Stern65bfd292008-11-25 16:39:18 -0500363 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400364
365 } else if (len == sizeof auto_string - 1 &&
366 strncmp(buf, auto_string, len) == 0) {
367 udev->autosuspend_disabled = 0;
368 udev->autoresume_disabled = 0;
Alan Stern65bfd292008-11-25 16:39:18 -0500369 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400370
371 } else if (len == sizeof suspend_string - 1 &&
372 strncmp(buf, suspend_string, len) == 0) {
373 udev->autosuspend_disabled = 0;
374 udev->autoresume_disabled = 1;
Alan Stern65bfd292008-11-25 16:39:18 -0500375 rc = usb_external_suspend_device(udev, PMSG_USER_SUSPEND);
Alan Stern2add5222007-03-20 14:59:39 -0400376
377 } else
378 rc = -EINVAL;
379
Alan Sterndd865572007-05-22 11:38:19 -0400380 if (rc) {
381 udev->autosuspend_disabled = old_autosuspend_disabled;
382 udev->autoresume_disabled = old_autoresume_disabled;
383 }
Alan Stern2add5222007-03-20 14:59:39 -0400384 usb_unlock_device(udev);
385 return (rc < 0 ? rc : count);
386}
387
388static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
389
Alan Stern19c26232007-02-20 15:03:32 -0500390static int add_power_attributes(struct device *dev)
391{
392 int rc = 0;
393
Alan Stern2add5222007-03-20 14:59:39 -0400394 if (is_usb_device(dev)) {
Alan Stern19c26232007-02-20 15:03:32 -0500395 rc = sysfs_add_file_to_group(&dev->kobj,
396 &dev_attr_autosuspend.attr,
397 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400398 if (rc == 0)
399 rc = sysfs_add_file_to_group(&dev->kobj,
400 &dev_attr_level.attr,
401 power_group);
Sarah Sharp15123002007-12-21 16:54:15 -0800402 if (rc == 0)
403 rc = sysfs_add_file_to_group(&dev->kobj,
404 &dev_attr_connected_duration.attr,
405 power_group);
406 if (rc == 0)
407 rc = sysfs_add_file_to_group(&dev->kobj,
408 &dev_attr_active_duration.attr,
409 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400410 }
Alan Stern19c26232007-02-20 15:03:32 -0500411 return rc;
412}
413
414static void remove_power_attributes(struct device *dev)
415{
416 sysfs_remove_file_from_group(&dev->kobj,
Sarah Sharp15123002007-12-21 16:54:15 -0800417 &dev_attr_active_duration.attr,
418 power_group);
419 sysfs_remove_file_from_group(&dev->kobj,
420 &dev_attr_connected_duration.attr,
421 power_group);
422 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern2add5222007-03-20 14:59:39 -0400423 &dev_attr_level.attr,
424 power_group);
425 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern19c26232007-02-20 15:03:32 -0500426 &dev_attr_autosuspend.attr,
427 power_group);
428}
429
430#else
431
432#define add_power_attributes(dev) 0
433#define remove_power_attributes(dev) do {} while (0)
434
435#endif /* CONFIG_USB_SUSPEND */
436
Alan Sternb41a60e2007-05-30 15:39:33 -0400437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438/* Descriptor fields */
439#define usb_descriptor_attr_le16(field, format_string) \
440static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500441show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400442 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{ \
444 struct usb_device *udev; \
445 \
Oliver Neukum92516442007-01-23 15:55:28 -0500446 udev = to_usb_device(dev); \
447 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 le16_to_cpu(udev->descriptor.field)); \
449} \
450static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
451
452usb_descriptor_attr_le16(idVendor, "%04x\n")
453usb_descriptor_attr_le16(idProduct, "%04x\n")
454usb_descriptor_attr_le16(bcdDevice, "%04x\n")
455
456#define usb_descriptor_attr(field, format_string) \
457static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500458show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400459 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460{ \
461 struct usb_device *udev; \
462 \
Oliver Neukum92516442007-01-23 15:55:28 -0500463 udev = to_usb_device(dev); \
464 return sprintf(buf, format_string, udev->descriptor.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465} \
466static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
467
Oliver Neukum92516442007-01-23 15:55:28 -0500468usb_descriptor_attr(bDeviceClass, "%02x\n")
469usb_descriptor_attr(bDeviceSubClass, "%02x\n")
470usb_descriptor_attr(bDeviceProtocol, "%02x\n")
471usb_descriptor_attr(bNumConfigurations, "%d\n")
472usb_descriptor_attr(bMaxPacketSize0, "%d\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700474
475
476/* show if the device is authorized (1) or not (0) */
477static ssize_t usb_dev_authorized_show(struct device *dev,
478 struct device_attribute *attr,
479 char *buf)
480{
481 struct usb_device *usb_dev = to_usb_device(dev);
482 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
483}
484
485
486/*
487 * Authorize a device to be used in the system
488 *
489 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
490 */
491static ssize_t usb_dev_authorized_store(struct device *dev,
492 struct device_attribute *attr,
493 const char *buf, size_t size)
494{
495 ssize_t result;
496 struct usb_device *usb_dev = to_usb_device(dev);
497 unsigned val;
498 result = sscanf(buf, "%u\n", &val);
499 if (result != 1)
500 result = -EINVAL;
501 else if (val == 0)
502 result = usb_deauthorize_device(usb_dev);
503 else
504 result = usb_authorize_device(usb_dev);
505 return result < 0? result : size;
506}
507
508static DEVICE_ATTR(authorized, 0644,
509 usb_dev_authorized_show, usb_dev_authorized_store);
510
Alan Stern253e0572009-10-27 15:20:13 -0400511/* "Safely remove a device" */
512static ssize_t usb_remove_store(struct device *dev,
513 struct device_attribute *attr,
514 const char *buf, size_t count)
515{
516 struct usb_device *udev = to_usb_device(dev);
517 int rc = 0;
518
519 usb_lock_device(udev);
520 if (udev->state != USB_STATE_NOTATTACHED) {
521
522 /* To avoid races, first unconfigure and then remove */
523 usb_set_configuration(udev, -1);
524 rc = usb_remove_device(udev);
525 }
526 if (rc == 0)
527 rc = count;
528 usb_unlock_device(udev);
529 return rc;
530}
531static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
532
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534static struct attribute *dev_attrs[] = {
535 /* current configuration's attributes */
Alan Sternb6eb2d82006-07-06 15:37:42 -0400536 &dev_attr_configuration.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 &dev_attr_bNumInterfaces.attr,
538 &dev_attr_bConfigurationValue.attr,
539 &dev_attr_bmAttributes.attr,
540 &dev_attr_bMaxPower.attr,
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700541 &dev_attr_urbnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 /* device attributes */
543 &dev_attr_idVendor.attr,
544 &dev_attr_idProduct.attr,
545 &dev_attr_bcdDevice.attr,
546 &dev_attr_bDeviceClass.attr,
547 &dev_attr_bDeviceSubClass.attr,
548 &dev_attr_bDeviceProtocol.attr,
549 &dev_attr_bNumConfigurations.attr,
Greg Kroah-Hartmancf5910b2005-06-29 16:53:29 -0700550 &dev_attr_bMaxPacketSize0.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 &dev_attr_speed.attr,
Alan Stern83f7d952007-04-25 15:15:43 -0400552 &dev_attr_busnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 &dev_attr_devnum.attr,
554 &dev_attr_version.attr,
555 &dev_attr_maxchild.attr,
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100556 &dev_attr_quirks.attr,
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700557 &dev_attr_authorized.attr,
Alan Stern253e0572009-10-27 15:20:13 -0400558 &dev_attr_remove.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 NULL,
560};
561static struct attribute_group dev_attr_grp = {
562 .attrs = dev_attrs,
563};
564
Alan Stern2e5f10e2008-04-30 15:37:19 -0400565/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
566 * accordingly.
567 */
568static struct attribute *dev_string_attrs[] = {
569 &dev_attr_manufacturer.attr,
570 &dev_attr_product.attr,
571 &dev_attr_serial.attr,
572 NULL
573};
574
575static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
576 struct attribute *a, int n)
577{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400578 struct device *dev = container_of(kobj, struct device, kobj);
579 struct usb_device *udev = to_usb_device(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400580
581 if (a == &dev_attr_manufacturer.attr) {
582 if (udev->manufacturer == NULL)
583 return 0;
584 } else if (a == &dev_attr_product.attr) {
585 if (udev->product == NULL)
586 return 0;
587 } else if (a == &dev_attr_serial.attr) {
588 if (udev->serial == NULL)
589 return 0;
590 }
591 return a->mode;
592}
593
594static struct attribute_group dev_string_attr_grp = {
595 .attrs = dev_string_attrs,
596 .is_visible = dev_string_attrs_are_visible,
597};
598
David Brownella4dbd672009-06-24 10:06:31 -0700599const struct attribute_group *usb_device_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400600 &dev_attr_grp,
601 &dev_string_attr_grp,
602 NULL
603};
604
Alan Stern69d42a72007-07-12 17:06:23 -0400605/* Binary descriptors */
606
607static ssize_t
608read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
609 char *buf, loff_t off, size_t count)
610{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400611 struct device *dev = container_of(kobj, struct device, kobj);
612 struct usb_device *udev = to_usb_device(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400613 size_t nleft = count;
614 size_t srclen, n;
Alan Stern217a9082008-05-20 16:40:42 -0400615 int cfgno;
616 void *src;
Alan Stern69d42a72007-07-12 17:06:23 -0400617
Alan Stern217a9082008-05-20 16:40:42 -0400618 /* The binary attribute begins with the device descriptor.
619 * Following that are the raw descriptor entries for all the
620 * configurations (config plus subsidiary descriptors).
Alan Stern69d42a72007-07-12 17:06:23 -0400621 */
Alan Stern217a9082008-05-20 16:40:42 -0400622 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
623 nleft > 0; ++cfgno) {
624 if (cfgno < 0) {
625 src = &udev->descriptor;
626 srclen = sizeof(struct usb_device_descriptor);
627 } else {
628 src = udev->rawdescriptors[cfgno];
629 srclen = __le16_to_cpu(udev->config[cfgno].desc.
630 wTotalLength);
631 }
Alan Stern69d42a72007-07-12 17:06:23 -0400632 if (off < srclen) {
Alan Stern217a9082008-05-20 16:40:42 -0400633 n = min(nleft, srclen - (size_t) off);
634 memcpy(buf, src + off, n);
Alan Stern69d42a72007-07-12 17:06:23 -0400635 nleft -= n;
Alan Stern217a9082008-05-20 16:40:42 -0400636 buf += n;
637 off = 0;
638 } else {
639 off -= srclen;
Alan Stern69d42a72007-07-12 17:06:23 -0400640 }
641 }
Alan Stern69d42a72007-07-12 17:06:23 -0400642 return count - nleft;
643}
644
645static struct bin_attribute dev_bin_attr_descriptors = {
646 .attr = {.name = "descriptors", .mode = 0444},
647 .read = read_descriptors,
648 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
649};
650
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700651int usb_create_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652{
653 struct device *dev = &udev->dev;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700654 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Alan Stern69d42a72007-07-12 17:06:23 -0400656 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
657 if (retval)
658 goto error;
659
Alan Sternb41a60e2007-05-30 15:39:33 -0400660 retval = add_persist_attributes(dev);
661 if (retval)
662 goto error;
663
Alan Stern19c26232007-02-20 15:03:32 -0500664 retval = add_power_attributes(dev);
665 if (retval)
666 goto error;
Alan Stern3b23dd62008-12-05 14:10:34 -0500667 return retval;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700668error:
Alan Sternaa084f32007-02-20 14:59:59 -0500669 usb_remove_sysfs_dev_files(udev);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700670 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
Oliver Neukum92516442007-01-23 15:55:28 -0500673void usb_remove_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
675 struct device *dev = &udev->dev;
676
Alan Stern19c26232007-02-20 15:03:32 -0500677 remove_power_attributes(dev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400678 remove_persist_attributes(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400679 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
681
Craig W. Nadler165fe972007-06-15 23:14:35 -0400682/* Interface Accociation Descriptor fields */
683#define usb_intf_assoc_attr(field, format_string) \
684static ssize_t \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800685show_iad_##field(struct device *dev, struct device_attribute *attr, \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400686 char *buf) \
687{ \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800688 struct usb_interface *intf = to_usb_interface(dev); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400689 \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800690 return sprintf(buf, format_string, \
691 intf->intf_assoc->field); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400692} \
693static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
694
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800695usb_intf_assoc_attr(bFirstInterface, "%02x\n")
696usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
697usb_intf_assoc_attr(bFunctionClass, "%02x\n")
698usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
699usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
Craig W. Nadler165fe972007-06-15 23:14:35 -0400700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701/* Interface fields */
702#define usb_intf_attr(field, format_string) \
703static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500704show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400705 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{ \
Oliver Neukum92516442007-01-23 15:55:28 -0500707 struct usb_interface *intf = to_usb_interface(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 \
Oliver Neukum92516442007-01-23 15:55:28 -0500709 return sprintf(buf, format_string, \
Alan Sternb724ae72005-10-24 15:36:00 -0400710 intf->cur_altsetting->desc.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711} \
712static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
713
Oliver Neukum92516442007-01-23 15:55:28 -0500714usb_intf_attr(bInterfaceNumber, "%02x\n")
715usb_intf_attr(bAlternateSetting, "%2d\n")
716usb_intf_attr(bNumEndpoints, "%02x\n")
717usb_intf_attr(bInterfaceClass, "%02x\n")
718usb_intf_attr(bInterfaceSubClass, "%02x\n")
719usb_intf_attr(bInterfaceProtocol, "%02x\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Alan Sternb724ae72005-10-24 15:36:00 -0400721static ssize_t show_interface_string(struct device *dev,
722 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 struct usb_interface *intf;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400725 char *string;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Oliver Neukum92516442007-01-23 15:55:28 -0500727 intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400728 string = intf->cur_altsetting->string;
729 barrier(); /* The altsetting might change! */
730
731 if (!string)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 return 0;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400733 return sprintf(buf, "%s\n", string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734}
735static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
736
Alan Sternb724ae72005-10-24 15:36:00 -0400737static ssize_t show_modalias(struct device *dev,
738 struct device_attribute *attr, char *buf)
Greg KH360b52b2005-05-10 06:45:10 -0700739{
740 struct usb_interface *intf;
741 struct usb_device *udev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700742 struct usb_host_interface *alt;
Greg KH360b52b2005-05-10 06:45:10 -0700743
744 intf = to_usb_interface(dev);
745 udev = interface_to_usbdev(intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700746 alt = intf->cur_altsetting;
Greg KH360b52b2005-05-10 06:45:10 -0700747
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700748 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
749 "ic%02Xisc%02Xip%02X\n",
750 le16_to_cpu(udev->descriptor.idVendor),
751 le16_to_cpu(udev->descriptor.idProduct),
752 le16_to_cpu(udev->descriptor.bcdDevice),
753 udev->descriptor.bDeviceClass,
754 udev->descriptor.bDeviceSubClass,
755 udev->descriptor.bDeviceProtocol,
756 alt->desc.bInterfaceClass,
757 alt->desc.bInterfaceSubClass,
758 alt->desc.bInterfaceProtocol);
Greg KH360b52b2005-05-10 06:45:10 -0700759}
760static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
761
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700762static ssize_t show_supports_autosuspend(struct device *dev,
763 struct device_attribute *attr, char *buf)
764{
765 struct usb_interface *intf;
766 struct usb_device *udev;
767 int ret;
768
769 intf = to_usb_interface(dev);
770 udev = interface_to_usbdev(intf);
771
772 usb_lock_device(udev);
773 /* Devices will be autosuspended even when an interface isn't claimed */
774 if (!intf->dev.driver ||
775 to_usb_driver(intf->dev.driver)->supports_autosuspend)
776 ret = sprintf(buf, "%u\n", 1);
777 else
778 ret = sprintf(buf, "%u\n", 0);
779 usb_unlock_device(udev);
780
781 return ret;
782}
783static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785static struct attribute *intf_attrs[] = {
786 &dev_attr_bInterfaceNumber.attr,
787 &dev_attr_bAlternateSetting.attr,
788 &dev_attr_bNumEndpoints.attr,
789 &dev_attr_bInterfaceClass.attr,
790 &dev_attr_bInterfaceSubClass.attr,
791 &dev_attr_bInterfaceProtocol.attr,
Greg KH360b52b2005-05-10 06:45:10 -0700792 &dev_attr_modalias.attr,
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700793 &dev_attr_supports_autosuspend.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 NULL,
795};
796static struct attribute_group intf_attr_grp = {
797 .attrs = intf_attrs,
798};
799
Alan Stern2e5f10e2008-04-30 15:37:19 -0400800static struct attribute *intf_assoc_attrs[] = {
801 &dev_attr_iad_bFirstInterface.attr,
802 &dev_attr_iad_bInterfaceCount.attr,
803 &dev_attr_iad_bFunctionClass.attr,
804 &dev_attr_iad_bFunctionSubClass.attr,
805 &dev_attr_iad_bFunctionProtocol.attr,
806 NULL,
807};
808
809static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
810 struct attribute *a, int n)
811{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400812 struct device *dev = container_of(kobj, struct device, kobj);
813 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400814
815 if (intf->intf_assoc == NULL)
816 return 0;
817 return a->mode;
818}
819
820static struct attribute_group intf_assoc_attr_grp = {
821 .attrs = intf_assoc_attrs,
822 .is_visible = intf_assoc_attrs_are_visible,
823};
824
David Brownella4dbd672009-06-24 10:06:31 -0700825const struct attribute_group *usb_interface_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400826 &intf_attr_grp,
827 &intf_assoc_attr_grp,
828 NULL
829};
830
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700831int usb_create_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
Alan Stern4f62efe2005-10-24 16:24:14 -0400833 struct usb_device *udev = interface_to_usbdev(intf);
834 struct usb_host_interface *alt = intf->cur_altsetting;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700835 int retval;
Alan Stern4f62efe2005-10-24 16:24:14 -0400836
Alan Stern352d0262008-10-29 15:16:58 -0400837 if (intf->sysfs_files_created || intf->unregistering)
Alan Stern7e615592007-11-06 11:43:42 -0500838 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Alan Stern1662e3a2009-03-18 14:28:53 -0400840 if (alt->string == NULL &&
841 !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern4f62efe2005-10-24 16:24:14 -0400842 alt->string = usb_cache_string(udev, alt->desc.iInterface);
843 if (alt->string)
Alan Stern2e5f10e2008-04-30 15:37:19 -0400844 retval = device_create_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500845 intf->sysfs_files_created = 1;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700846 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847}
848
Oliver Neukum92516442007-01-23 15:55:28 -0500849void usb_remove_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850{
Alan Stern7e615592007-11-06 11:43:42 -0500851 if (!intf->sysfs_files_created)
852 return;
Alan Stern92b0da12008-10-29 15:18:50 -0400853
Alan Stern92b0da12008-10-29 15:18:50 -0400854 device_remove_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500855 intf->sysfs_files_created = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}