blob: b1725abf6c7bbea64fb76c51270dfc64ff3de87f [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; \
Alan Sternda307122009-12-08 15:54:44 -050085 int retval; \
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 \
Oliver Neukum92516442007-01-23 15:55:28 -050087 udev = to_usb_device(dev); \
Alan Sternda307122009-12-08 15:54:44 -050088 usb_lock_device(udev); \
89 retval = sprintf(buf, "%s\n", udev->name); \
90 usb_unlock_device(udev); \
91 return retval; \
Linus Torvalds1da177e2005-04-16 15:20:36 -070092} \
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
Oliver Neukum92516442007-01-23 15:55:28 -0500100show_speed(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
102 struct usb_device *udev;
103 char *speed;
104
Oliver Neukum92516442007-01-23 15:55:28 -0500105 udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
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;
Greg Kroah-Hartmanb132b042010-01-14 10:33:19 -0800118 case USB_SPEED_VARIABLE:
119 speed = "480";
120 break;
121 case USB_SPEED_SUPER:
122 speed = "5000";
123 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 default:
125 speed = "unknown";
126 }
Oliver Neukum92516442007-01-23 15:55:28 -0500127 return sprintf(buf, "%s\n", speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128}
129static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
130
131static ssize_t
Alan Stern83f7d952007-04-25 15:15:43 -0400132show_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
Oliver Neukum92516442007-01-23 15:55:28 -0500142show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 struct usb_device *udev;
145
Oliver Neukum92516442007-01-23 15:55:28 -0500146 udev = to_usb_device(dev);
147 return sprintf(buf, "%d\n", udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148}
149static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
150
151static ssize_t
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800152show_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
Oliver Neukum92516442007-01-23 15:55:28 -0500162show_version(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
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
Oliver Neukum92516442007-01-23 15:55:28 -0500174show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175{
176 struct usb_device *udev;
177
Oliver Neukum92516442007-01-23 15:55:28 -0500178 udev = to_usb_device(dev);
179 return sprintf(buf, "%d\n", udev->maxchild);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180}
181static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
182
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100183static 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
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700193static ssize_t
Oliver Neukumef955342010-01-16 01:33:03 +0100194show_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
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700224show_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
Alan Sternb41a60e2007-05-30 15:39:33 -0400233
Alan Sternfeccc302008-03-03 15:15:59 -0500234#ifdef CONFIG_PM
Alan Sternb41a60e2007-05-30 15:39:33 -0400235
Alan Sternfeccc302008-03-03 15:15:59 -0500236static const char power_group[] = "power";
Alan Sternb41a60e2007-05-30 15:39:33 -0400237
238static ssize_t
239show_persist(struct device *dev, struct device_attribute *attr, char *buf)
240{
241 struct usb_device *udev = to_usb_device(dev);
242
243 return sprintf(buf, "%d\n", udev->persist_enabled);
244}
245
246static ssize_t
247set_persist(struct device *dev, struct device_attribute *attr,
248 const char *buf, size_t count)
249{
250 struct usb_device *udev = to_usb_device(dev);
251 int value;
252
253 /* Hubs are always enabled for USB_PERSIST */
254 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
255 return -EPERM;
256
257 if (sscanf(buf, "%d", &value) != 1)
258 return -EINVAL;
259 usb_pm_lock(udev);
260 udev->persist_enabled = !!value;
261 usb_pm_unlock(udev);
262 return count;
263}
264
265static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
266
267static int add_persist_attributes(struct device *dev)
268{
269 int rc = 0;
270
271 if (is_usb_device(dev)) {
272 struct usb_device *udev = to_usb_device(dev);
273
Alan Sternfeccc302008-03-03 15:15:59 -0500274 /* Hubs are automatically enabled for USB_PERSIST,
275 * no point in creating the attribute file.
276 */
277 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
278 rc = sysfs_add_file_to_group(&dev->kobj,
279 &dev_attr_persist.attr,
280 power_group);
Alan Sternb41a60e2007-05-30 15:39:33 -0400281 }
282 return rc;
283}
284
285static void remove_persist_attributes(struct device *dev)
286{
287 sysfs_remove_file_from_group(&dev->kobj,
288 &dev_attr_persist.attr,
289 power_group);
290}
Alan Sternb41a60e2007-05-30 15:39:33 -0400291#else
292
293#define add_persist_attributes(dev) 0
294#define remove_persist_attributes(dev) do {} while (0)
295
Alan Sternfeccc302008-03-03 15:15:59 -0500296#endif /* CONFIG_PM */
Alan Sternb41a60e2007-05-30 15:39:33 -0400297
Alan Stern19c26232007-02-20 15:03:32 -0500298#ifdef CONFIG_USB_SUSPEND
299
300static ssize_t
Sarah Sharp15123002007-12-21 16:54:15 -0800301show_connected_duration(struct device *dev, struct device_attribute *attr,
302 char *buf)
303{
304 struct usb_device *udev = to_usb_device(dev);
305
306 return sprintf(buf, "%u\n",
307 jiffies_to_msecs(jiffies - udev->connect_time));
308}
309
310static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
311
312/*
313 * If the device is resumed, the last time the device was suspended has
314 * been pre-subtracted from active_duration. We add the current time to
315 * get the duration that the device was actually active.
316 *
317 * If the device is suspended, the active_duration is up-to-date.
318 */
319static ssize_t
320show_active_duration(struct device *dev, struct device_attribute *attr,
321 char *buf)
322{
323 struct usb_device *udev = to_usb_device(dev);
324 int duration;
325
326 if (udev->state != USB_STATE_SUSPENDED)
327 duration = jiffies_to_msecs(jiffies + udev->active_duration);
328 else
329 duration = jiffies_to_msecs(udev->active_duration);
330 return sprintf(buf, "%u\n", duration);
331}
332
333static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
334
335static ssize_t
Alan Stern19c26232007-02-20 15:03:32 -0500336show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
337{
338 struct usb_device *udev = to_usb_device(dev);
339
Alan Sterneaafbc32007-03-13 16:39:15 -0400340 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
Alan Stern19c26232007-02-20 15:03:32 -0500341}
342
343static ssize_t
344set_autosuspend(struct device *dev, struct device_attribute *attr,
345 const char *buf, size_t count)
346{
347 struct usb_device *udev = to_usb_device(dev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400348 int value;
Alan Stern19c26232007-02-20 15:03:32 -0500349
Alan Sterneaafbc32007-03-13 16:39:15 -0400350 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
351 value <= - INT_MAX/HZ)
Alan Stern19c26232007-02-20 15:03:32 -0500352 return -EINVAL;
353 value *= HZ;
354
Alan Stern19c26232007-02-20 15:03:32 -0500355 udev->autosuspend_delay = value;
Alan Sterneaafbc32007-03-13 16:39:15 -0400356 if (value >= 0)
Alan Stern19c26232007-02-20 15:03:32 -0500357 usb_try_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400358 else {
Alan Stern2add5222007-03-20 14:59:39 -0400359 if (usb_autoresume_device(udev) == 0)
360 usb_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400361 }
Alan Stern19c26232007-02-20 15:03:32 -0500362 return count;
363}
364
365static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
366 show_autosuspend, set_autosuspend);
367
Alan Stern2add5222007-03-20 14:59:39 -0400368static const char on_string[] = "on";
369static const char auto_string[] = "auto";
Alan Stern2add5222007-03-20 14:59:39 -0400370
371static ssize_t
372show_level(struct device *dev, struct device_attribute *attr, char *buf)
373{
374 struct usb_device *udev = to_usb_device(dev);
375 const char *p = auto_string;
376
Alan Stern8e4ceb32009-12-07 13:01:37 -0500377 if (udev->state != USB_STATE_SUSPENDED && udev->autosuspend_disabled)
378 p = on_string;
Alan Stern2add5222007-03-20 14:59:39 -0400379 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 = 0;
Alan Stern8e4ceb32009-12-07 13:01:37 -0500390 int old_autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400391
392 cp = memchr(buf, '\n', count);
393 if (cp)
394 len = cp - buf;
395
396 usb_lock_device(udev);
Alan Sterndd865572007-05-22 11:38:19 -0400397 old_autosuspend_disabled = udev->autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400398
399 /* Setting the flags without calling usb_pm_lock is a subject to
400 * races, but who cares...
401 */
402 if (len == sizeof on_string - 1 &&
403 strncmp(buf, on_string, len) == 0) {
404 udev->autosuspend_disabled = 1;
Alan Stern65bfd292008-11-25 16:39:18 -0500405 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400406
407 } else if (len == sizeof auto_string - 1 &&
408 strncmp(buf, auto_string, len) == 0) {
409 udev->autosuspend_disabled = 0;
Alan Stern65bfd292008-11-25 16:39:18 -0500410 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400411
Alan Stern2add5222007-03-20 14:59:39 -0400412 } else
413 rc = -EINVAL;
414
Alan Stern8e4ceb32009-12-07 13:01:37 -0500415 if (rc)
Alan Sterndd865572007-05-22 11:38:19 -0400416 udev->autosuspend_disabled = old_autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400417 usb_unlock_device(udev);
418 return (rc < 0 ? rc : count);
419}
420
421static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
422
Alan Stern19c26232007-02-20 15:03:32 -0500423static int add_power_attributes(struct device *dev)
424{
425 int rc = 0;
426
Alan Stern2add5222007-03-20 14:59:39 -0400427 if (is_usb_device(dev)) {
Alan Stern19c26232007-02-20 15:03:32 -0500428 rc = sysfs_add_file_to_group(&dev->kobj,
429 &dev_attr_autosuspend.attr,
430 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400431 if (rc == 0)
432 rc = sysfs_add_file_to_group(&dev->kobj,
433 &dev_attr_level.attr,
434 power_group);
Sarah Sharp15123002007-12-21 16:54:15 -0800435 if (rc == 0)
436 rc = sysfs_add_file_to_group(&dev->kobj,
437 &dev_attr_connected_duration.attr,
438 power_group);
439 if (rc == 0)
440 rc = sysfs_add_file_to_group(&dev->kobj,
441 &dev_attr_active_duration.attr,
442 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400443 }
Alan Stern19c26232007-02-20 15:03:32 -0500444 return rc;
445}
446
447static void remove_power_attributes(struct device *dev)
448{
449 sysfs_remove_file_from_group(&dev->kobj,
Sarah Sharp15123002007-12-21 16:54:15 -0800450 &dev_attr_active_duration.attr,
451 power_group);
452 sysfs_remove_file_from_group(&dev->kobj,
453 &dev_attr_connected_duration.attr,
454 power_group);
455 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern2add5222007-03-20 14:59:39 -0400456 &dev_attr_level.attr,
457 power_group);
458 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern19c26232007-02-20 15:03:32 -0500459 &dev_attr_autosuspend.attr,
460 power_group);
461}
462
463#else
464
465#define add_power_attributes(dev) 0
466#define remove_power_attributes(dev) do {} while (0)
467
468#endif /* CONFIG_USB_SUSPEND */
469
Alan Sternb41a60e2007-05-30 15:39:33 -0400470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471/* Descriptor fields */
472#define usb_descriptor_attr_le16(field, format_string) \
473static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500474show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400475 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{ \
477 struct usb_device *udev; \
478 \
Oliver Neukum92516442007-01-23 15:55:28 -0500479 udev = to_usb_device(dev); \
480 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 le16_to_cpu(udev->descriptor.field)); \
482} \
483static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
484
485usb_descriptor_attr_le16(idVendor, "%04x\n")
486usb_descriptor_attr_le16(idProduct, "%04x\n")
487usb_descriptor_attr_le16(bcdDevice, "%04x\n")
488
489#define usb_descriptor_attr(field, format_string) \
490static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500491show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400492 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{ \
494 struct usb_device *udev; \
495 \
Oliver Neukum92516442007-01-23 15:55:28 -0500496 udev = to_usb_device(dev); \
497 return sprintf(buf, format_string, udev->descriptor.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498} \
499static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
500
Oliver Neukum92516442007-01-23 15:55:28 -0500501usb_descriptor_attr(bDeviceClass, "%02x\n")
502usb_descriptor_attr(bDeviceSubClass, "%02x\n")
503usb_descriptor_attr(bDeviceProtocol, "%02x\n")
504usb_descriptor_attr(bNumConfigurations, "%d\n")
505usb_descriptor_attr(bMaxPacketSize0, "%d\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700507
508
509/* show if the device is authorized (1) or not (0) */
510static ssize_t usb_dev_authorized_show(struct device *dev,
511 struct device_attribute *attr,
512 char *buf)
513{
514 struct usb_device *usb_dev = to_usb_device(dev);
515 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
516}
517
518
519/*
520 * Authorize a device to be used in the system
521 *
522 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
523 */
524static ssize_t usb_dev_authorized_store(struct device *dev,
525 struct device_attribute *attr,
526 const char *buf, size_t size)
527{
528 ssize_t result;
529 struct usb_device *usb_dev = to_usb_device(dev);
530 unsigned val;
531 result = sscanf(buf, "%u\n", &val);
532 if (result != 1)
533 result = -EINVAL;
534 else if (val == 0)
535 result = usb_deauthorize_device(usb_dev);
536 else
537 result = usb_authorize_device(usb_dev);
538 return result < 0? result : size;
539}
540
541static DEVICE_ATTR(authorized, 0644,
542 usb_dev_authorized_show, usb_dev_authorized_store);
543
Alan Stern253e0572009-10-27 15:20:13 -0400544/* "Safely remove a device" */
545static ssize_t usb_remove_store(struct device *dev,
546 struct device_attribute *attr,
547 const char *buf, size_t count)
548{
549 struct usb_device *udev = to_usb_device(dev);
550 int rc = 0;
551
552 usb_lock_device(udev);
553 if (udev->state != USB_STATE_NOTATTACHED) {
554
555 /* To avoid races, first unconfigure and then remove */
556 usb_set_configuration(udev, -1);
557 rc = usb_remove_device(udev);
558 }
559 if (rc == 0)
560 rc = count;
561 usb_unlock_device(udev);
562 return rc;
563}
564static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
565
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567static struct attribute *dev_attrs[] = {
568 /* current configuration's attributes */
Alan Sternb6eb2d82006-07-06 15:37:42 -0400569 &dev_attr_configuration.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 &dev_attr_bNumInterfaces.attr,
571 &dev_attr_bConfigurationValue.attr,
572 &dev_attr_bmAttributes.attr,
573 &dev_attr_bMaxPower.attr,
574 /* device attributes */
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800575 &dev_attr_urbnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 &dev_attr_idVendor.attr,
577 &dev_attr_idProduct.attr,
578 &dev_attr_bcdDevice.attr,
579 &dev_attr_bDeviceClass.attr,
580 &dev_attr_bDeviceSubClass.attr,
581 &dev_attr_bDeviceProtocol.attr,
582 &dev_attr_bNumConfigurations.attr,
Greg Kroah-Hartmancf5910b2005-06-29 16:53:29 -0700583 &dev_attr_bMaxPacketSize0.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 &dev_attr_speed.attr,
Alan Stern83f7d952007-04-25 15:15:43 -0400585 &dev_attr_busnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 &dev_attr_devnum.attr,
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800587 &dev_attr_devpath.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 &dev_attr_version.attr,
589 &dev_attr_maxchild.attr,
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100590 &dev_attr_quirks.attr,
Oliver Neukumef955342010-01-16 01:33:03 +0100591 &dev_attr_avoid_reset_quirk.attr,
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700592 &dev_attr_authorized.attr,
Alan Stern253e0572009-10-27 15:20:13 -0400593 &dev_attr_remove.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 NULL,
595};
596static struct attribute_group dev_attr_grp = {
597 .attrs = dev_attrs,
598};
599
Alan Stern2e5f10e2008-04-30 15:37:19 -0400600/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
601 * accordingly.
602 */
603static struct attribute *dev_string_attrs[] = {
604 &dev_attr_manufacturer.attr,
605 &dev_attr_product.attr,
606 &dev_attr_serial.attr,
607 NULL
608};
609
610static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
611 struct attribute *a, int n)
612{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400613 struct device *dev = container_of(kobj, struct device, kobj);
614 struct usb_device *udev = to_usb_device(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400615
616 if (a == &dev_attr_manufacturer.attr) {
617 if (udev->manufacturer == NULL)
618 return 0;
619 } else if (a == &dev_attr_product.attr) {
620 if (udev->product == NULL)
621 return 0;
622 } else if (a == &dev_attr_serial.attr) {
623 if (udev->serial == NULL)
624 return 0;
625 }
626 return a->mode;
627}
628
629static struct attribute_group dev_string_attr_grp = {
630 .attrs = dev_string_attrs,
631 .is_visible = dev_string_attrs_are_visible,
632};
633
David Brownella4dbd672009-06-24 10:06:31 -0700634const struct attribute_group *usb_device_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400635 &dev_attr_grp,
636 &dev_string_attr_grp,
637 NULL
638};
639
Alan Stern69d42a72007-07-12 17:06:23 -0400640/* Binary descriptors */
641
642static ssize_t
643read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
644 char *buf, loff_t off, size_t count)
645{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400646 struct device *dev = container_of(kobj, struct device, kobj);
647 struct usb_device *udev = to_usb_device(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400648 size_t nleft = count;
649 size_t srclen, n;
Alan Stern217a9082008-05-20 16:40:42 -0400650 int cfgno;
651 void *src;
Alan Stern69d42a72007-07-12 17:06:23 -0400652
Alan Stern217a9082008-05-20 16:40:42 -0400653 /* The binary attribute begins with the device descriptor.
654 * Following that are the raw descriptor entries for all the
655 * configurations (config plus subsidiary descriptors).
Alan Stern69d42a72007-07-12 17:06:23 -0400656 */
Alan Stern217a9082008-05-20 16:40:42 -0400657 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
658 nleft > 0; ++cfgno) {
659 if (cfgno < 0) {
660 src = &udev->descriptor;
661 srclen = sizeof(struct usb_device_descriptor);
662 } else {
663 src = udev->rawdescriptors[cfgno];
664 srclen = __le16_to_cpu(udev->config[cfgno].desc.
665 wTotalLength);
666 }
Alan Stern69d42a72007-07-12 17:06:23 -0400667 if (off < srclen) {
Alan Stern217a9082008-05-20 16:40:42 -0400668 n = min(nleft, srclen - (size_t) off);
669 memcpy(buf, src + off, n);
Alan Stern69d42a72007-07-12 17:06:23 -0400670 nleft -= n;
Alan Stern217a9082008-05-20 16:40:42 -0400671 buf += n;
672 off = 0;
673 } else {
674 off -= srclen;
Alan Stern69d42a72007-07-12 17:06:23 -0400675 }
676 }
Alan Stern69d42a72007-07-12 17:06:23 -0400677 return count - nleft;
678}
679
680static struct bin_attribute dev_bin_attr_descriptors = {
681 .attr = {.name = "descriptors", .mode = 0444},
682 .read = read_descriptors,
683 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
684};
685
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700686int usb_create_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687{
688 struct device *dev = &udev->dev;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700689 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Alan Stern69d42a72007-07-12 17:06:23 -0400691 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
692 if (retval)
693 goto error;
694
Alan Sternb41a60e2007-05-30 15:39:33 -0400695 retval = add_persist_attributes(dev);
696 if (retval)
697 goto error;
698
Alan Stern19c26232007-02-20 15:03:32 -0500699 retval = add_power_attributes(dev);
700 if (retval)
701 goto error;
Alan Stern3b23dd62008-12-05 14:10:34 -0500702 return retval;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700703error:
Alan Sternaa084f32007-02-20 14:59:59 -0500704 usb_remove_sysfs_dev_files(udev);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700705 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706}
707
Oliver Neukum92516442007-01-23 15:55:28 -0500708void usb_remove_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709{
710 struct device *dev = &udev->dev;
711
Alan Stern19c26232007-02-20 15:03:32 -0500712 remove_power_attributes(dev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400713 remove_persist_attributes(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400714 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715}
716
Craig W. Nadler165fe972007-06-15 23:14:35 -0400717/* Interface Accociation Descriptor fields */
718#define usb_intf_assoc_attr(field, format_string) \
719static ssize_t \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800720show_iad_##field(struct device *dev, struct device_attribute *attr, \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400721 char *buf) \
722{ \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800723 struct usb_interface *intf = to_usb_interface(dev); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400724 \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800725 return sprintf(buf, format_string, \
726 intf->intf_assoc->field); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400727} \
728static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
729
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800730usb_intf_assoc_attr(bFirstInterface, "%02x\n")
731usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
732usb_intf_assoc_attr(bFunctionClass, "%02x\n")
733usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
734usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
Craig W. Nadler165fe972007-06-15 23:14:35 -0400735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736/* Interface fields */
737#define usb_intf_attr(field, format_string) \
738static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500739show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400740 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{ \
Oliver Neukum92516442007-01-23 15:55:28 -0500742 struct usb_interface *intf = to_usb_interface(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 \
Oliver Neukum92516442007-01-23 15:55:28 -0500744 return sprintf(buf, format_string, \
Alan Sternb724ae72005-10-24 15:36:00 -0400745 intf->cur_altsetting->desc.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746} \
747static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
748
Oliver Neukum92516442007-01-23 15:55:28 -0500749usb_intf_attr(bInterfaceNumber, "%02x\n")
750usb_intf_attr(bAlternateSetting, "%2d\n")
751usb_intf_attr(bNumEndpoints, "%02x\n")
752usb_intf_attr(bInterfaceClass, "%02x\n")
753usb_intf_attr(bInterfaceSubClass, "%02x\n")
754usb_intf_attr(bInterfaceProtocol, "%02x\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Alan Sternb724ae72005-10-24 15:36:00 -0400756static ssize_t show_interface_string(struct device *dev,
757 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 struct usb_interface *intf;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400760 char *string;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Oliver Neukum92516442007-01-23 15:55:28 -0500762 intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400763 string = intf->cur_altsetting->string;
764 barrier(); /* The altsetting might change! */
765
766 if (!string)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return 0;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400768 return sprintf(buf, "%s\n", string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769}
770static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
771
Alan Sternb724ae72005-10-24 15:36:00 -0400772static ssize_t show_modalias(struct device *dev,
773 struct device_attribute *attr, char *buf)
Greg KH360b52b2005-05-10 06:45:10 -0700774{
775 struct usb_interface *intf;
776 struct usb_device *udev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700777 struct usb_host_interface *alt;
Greg KH360b52b2005-05-10 06:45:10 -0700778
779 intf = to_usb_interface(dev);
780 udev = interface_to_usbdev(intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700781 alt = intf->cur_altsetting;
Greg KH360b52b2005-05-10 06:45:10 -0700782
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700783 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
784 "ic%02Xisc%02Xip%02X\n",
785 le16_to_cpu(udev->descriptor.idVendor),
786 le16_to_cpu(udev->descriptor.idProduct),
787 le16_to_cpu(udev->descriptor.bcdDevice),
788 udev->descriptor.bDeviceClass,
789 udev->descriptor.bDeviceSubClass,
790 udev->descriptor.bDeviceProtocol,
791 alt->desc.bInterfaceClass,
792 alt->desc.bInterfaceSubClass,
793 alt->desc.bInterfaceProtocol);
Greg KH360b52b2005-05-10 06:45:10 -0700794}
795static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
796
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700797static ssize_t show_supports_autosuspend(struct device *dev,
798 struct device_attribute *attr, char *buf)
799{
800 struct usb_interface *intf;
801 struct usb_device *udev;
802 int ret;
803
804 intf = to_usb_interface(dev);
805 udev = interface_to_usbdev(intf);
806
807 usb_lock_device(udev);
808 /* Devices will be autosuspended even when an interface isn't claimed */
809 if (!intf->dev.driver ||
810 to_usb_driver(intf->dev.driver)->supports_autosuspend)
811 ret = sprintf(buf, "%u\n", 1);
812 else
813 ret = sprintf(buf, "%u\n", 0);
814 usb_unlock_device(udev);
815
816 return ret;
817}
818static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
819
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820static struct attribute *intf_attrs[] = {
821 &dev_attr_bInterfaceNumber.attr,
822 &dev_attr_bAlternateSetting.attr,
823 &dev_attr_bNumEndpoints.attr,
824 &dev_attr_bInterfaceClass.attr,
825 &dev_attr_bInterfaceSubClass.attr,
826 &dev_attr_bInterfaceProtocol.attr,
Greg KH360b52b2005-05-10 06:45:10 -0700827 &dev_attr_modalias.attr,
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700828 &dev_attr_supports_autosuspend.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 NULL,
830};
831static struct attribute_group intf_attr_grp = {
832 .attrs = intf_attrs,
833};
834
Alan Stern2e5f10e2008-04-30 15:37:19 -0400835static struct attribute *intf_assoc_attrs[] = {
836 &dev_attr_iad_bFirstInterface.attr,
837 &dev_attr_iad_bInterfaceCount.attr,
838 &dev_attr_iad_bFunctionClass.attr,
839 &dev_attr_iad_bFunctionSubClass.attr,
840 &dev_attr_iad_bFunctionProtocol.attr,
841 NULL,
842};
843
844static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
845 struct attribute *a, int n)
846{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400847 struct device *dev = container_of(kobj, struct device, kobj);
848 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400849
850 if (intf->intf_assoc == NULL)
851 return 0;
852 return a->mode;
853}
854
855static struct attribute_group intf_assoc_attr_grp = {
856 .attrs = intf_assoc_attrs,
857 .is_visible = intf_assoc_attrs_are_visible,
858};
859
David Brownella4dbd672009-06-24 10:06:31 -0700860const struct attribute_group *usb_interface_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400861 &intf_attr_grp,
862 &intf_assoc_attr_grp,
863 NULL
864};
865
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700866int usb_create_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Alan Stern4f62efe2005-10-24 16:24:14 -0400868 struct usb_device *udev = interface_to_usbdev(intf);
869 struct usb_host_interface *alt = intf->cur_altsetting;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700870 int retval;
Alan Stern4f62efe2005-10-24 16:24:14 -0400871
Alan Stern352d0262008-10-29 15:16:58 -0400872 if (intf->sysfs_files_created || intf->unregistering)
Alan Stern7e615592007-11-06 11:43:42 -0500873 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Alan Stern1662e3a2009-03-18 14:28:53 -0400875 if (alt->string == NULL &&
876 !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern4f62efe2005-10-24 16:24:14 -0400877 alt->string = usb_cache_string(udev, alt->desc.iInterface);
878 if (alt->string)
Alan Stern2e5f10e2008-04-30 15:37:19 -0400879 retval = device_create_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500880 intf->sysfs_files_created = 1;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700881 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882}
883
Oliver Neukum92516442007-01-23 15:55:28 -0500884void usb_remove_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885{
Alan Stern7e615592007-11-06 11:43:42 -0500886 if (!intf->sysfs_files_created)
887 return;
Alan Stern92b0da12008-10-29 15:18:50 -0400888
Alan Stern92b0da12008-10-29 15:18:50 -0400889 device_remove_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500890 intf->sysfs_files_created = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891}