blob: 662c0cf3a3e139b6ba9bccfcf18232e3b8e7fa8a [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-Hartman551cdbb2010-01-14 11:08:04 -0800118 case USB_SPEED_WIRELESS:
Greg Kroah-Hartmanb132b042010-01-14 10:33:19 -0800119 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 Sternb41a60e2007-05-30 15:39:33 -0400236static ssize_t
237show_persist(struct device *dev, struct device_attribute *attr, char *buf)
238{
239 struct usb_device *udev = to_usb_device(dev);
240
241 return sprintf(buf, "%d\n", udev->persist_enabled);
242}
243
244static ssize_t
245set_persist(struct device *dev, struct device_attribute *attr,
246 const char *buf, size_t count)
247{
248 struct usb_device *udev = to_usb_device(dev);
249 int value;
250
251 /* Hubs are always enabled for USB_PERSIST */
252 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
253 return -EPERM;
254
255 if (sscanf(buf, "%d", &value) != 1)
256 return -EINVAL;
Alan Stern0c4db6d2010-01-08 12:56:42 -0500257
258 usb_lock_device(udev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400259 udev->persist_enabled = !!value;
Alan Stern0c4db6d2010-01-08 12:56:42 -0500260 usb_unlock_device(udev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400261 return count;
262}
263
264static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
265
266static int add_persist_attributes(struct device *dev)
267{
268 int rc = 0;
269
270 if (is_usb_device(dev)) {
271 struct usb_device *udev = to_usb_device(dev);
272
Alan Sternfeccc302008-03-03 15:15:59 -0500273 /* Hubs are automatically enabled for USB_PERSIST,
274 * no point in creating the attribute file.
275 */
276 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
277 rc = sysfs_add_file_to_group(&dev->kobj,
278 &dev_attr_persist.attr,
Alan Stern045cac62010-11-15 15:57:07 -0500279 power_group_name);
Alan Sternb41a60e2007-05-30 15:39:33 -0400280 }
281 return rc;
282}
283
284static void remove_persist_attributes(struct device *dev)
285{
286 sysfs_remove_file_from_group(&dev->kobj,
287 &dev_attr_persist.attr,
Alan Stern045cac62010-11-15 15:57:07 -0500288 power_group_name);
Alan Sternb41a60e2007-05-30 15:39:33 -0400289}
Alan Sternb41a60e2007-05-30 15:39:33 -0400290#else
291
292#define add_persist_attributes(dev) 0
293#define remove_persist_attributes(dev) do {} while (0)
294
Alan Sternfeccc302008-03-03 15:15:59 -0500295#endif /* CONFIG_PM */
Alan Sternb41a60e2007-05-30 15:39:33 -0400296
Alan Stern19c26232007-02-20 15:03:32 -0500297#ifdef CONFIG_USB_SUSPEND
298
299static ssize_t
Sarah Sharp15123002007-12-21 16:54:15 -0800300show_connected_duration(struct device *dev, struct device_attribute *attr,
301 char *buf)
302{
303 struct usb_device *udev = to_usb_device(dev);
304
305 return sprintf(buf, "%u\n",
306 jiffies_to_msecs(jiffies - udev->connect_time));
307}
308
309static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
310
311/*
312 * If the device is resumed, the last time the device was suspended has
313 * been pre-subtracted from active_duration. We add the current time to
314 * get the duration that the device was actually active.
315 *
316 * If the device is suspended, the active_duration is up-to-date.
317 */
318static ssize_t
319show_active_duration(struct device *dev, struct device_attribute *attr,
320 char *buf)
321{
322 struct usb_device *udev = to_usb_device(dev);
323 int duration;
324
325 if (udev->state != USB_STATE_SUSPENDED)
326 duration = jiffies_to_msecs(jiffies + udev->active_duration);
327 else
328 duration = jiffies_to_msecs(udev->active_duration);
329 return sprintf(buf, "%u\n", duration);
330}
331
332static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
333
334static ssize_t
Alan Stern19c26232007-02-20 15:03:32 -0500335show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
336{
Alan Sternfcc4a012010-11-15 15:57:51 -0500337 return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
Alan Stern19c26232007-02-20 15:03:32 -0500338}
339
340static ssize_t
341set_autosuspend(struct device *dev, struct device_attribute *attr,
342 const char *buf, size_t count)
343{
Alan Sternfcc4a012010-11-15 15:57:51 -0500344 int value;
Alan Stern19c26232007-02-20 15:03:32 -0500345
Alan Sternfcc4a012010-11-15 15:57:51 -0500346 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
347 value <= -INT_MAX/1000)
Alan Stern19c26232007-02-20 15:03:32 -0500348 return -EINVAL;
Alan Stern19c26232007-02-20 15:03:32 -0500349
Alan Sternfcc4a012010-11-15 15:57:51 -0500350 pm_runtime_set_autosuspend_delay(dev, value * 1000);
Alan Stern19c26232007-02-20 15:03:32 -0500351 return count;
352}
353
354static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
355 show_autosuspend, set_autosuspend);
356
Alan Stern2add5222007-03-20 14:59:39 -0400357static const char on_string[] = "on";
358static const char auto_string[] = "auto";
Alan Stern2add5222007-03-20 14:59:39 -0400359
Alan Sterna9030982010-04-02 13:22:16 -0400360static void warn_level(void) {
361 static int level_warned;
362
363 if (!level_warned) {
364 level_warned = 1;
365 printk(KERN_WARNING "WARNING! power/level is deprecated; "
366 "use power/control instead\n");
367 }
368}
369
Alan Stern2add5222007-03-20 14:59:39 -0400370static ssize_t
371show_level(struct device *dev, struct device_attribute *attr, char *buf)
372{
373 struct usb_device *udev = to_usb_device(dev);
374 const char *p = auto_string;
375
Alan Sterna9030982010-04-02 13:22:16 -0400376 warn_level();
Alan Stern9e18c822010-04-02 13:22:09 -0400377 if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
Alan Stern8e4ceb32009-12-07 13:01:37 -0500378 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;
Alan Stern9e18c822010-04-02 13:22:09 -0400389 int rc = count;
Alan Stern2add5222007-03-20 14:59:39 -0400390
Alan Sterna9030982010-04-02 13:22:16 -0400391 warn_level();
Alan Stern2add5222007-03-20 14:59:39 -0400392 cp = memchr(buf, '\n', count);
393 if (cp)
394 len = cp - buf;
395
396 usb_lock_device(udev);
397
Alan Stern2add5222007-03-20 14:59:39 -0400398 if (len == sizeof on_string - 1 &&
Alan Stern088f7fe2010-01-08 12:56:54 -0500399 strncmp(buf, on_string, len) == 0)
Alan Stern9e18c822010-04-02 13:22:09 -0400400 usb_disable_autosuspend(udev);
Alan Stern2add5222007-03-20 14:59:39 -0400401
Alan Stern088f7fe2010-01-08 12:56:54 -0500402 else if (len == sizeof auto_string - 1 &&
403 strncmp(buf, auto_string, len) == 0)
Alan Stern9e18c822010-04-02 13:22:09 -0400404 usb_enable_autosuspend(udev);
Alan Stern2add5222007-03-20 14:59:39 -0400405
Alan Stern088f7fe2010-01-08 12:56:54 -0500406 else
Alan Stern2add5222007-03-20 14:59:39 -0400407 rc = -EINVAL;
408
409 usb_unlock_device(udev);
Alan Stern9e18c822010-04-02 13:22:09 -0400410 return rc;
Alan Stern2add5222007-03-20 14:59:39 -0400411}
412
413static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
414
Andiry Xuc1045e82011-09-23 14:19:53 -0700415static ssize_t
416show_usb2_hardware_lpm(struct device *dev, struct device_attribute *attr,
417 char *buf)
418{
419 struct usb_device *udev = to_usb_device(dev);
420 const char *p;
421
422 if (udev->usb2_hw_lpm_enabled == 1)
423 p = "enabled";
424 else
425 p = "disabled";
426
427 return sprintf(buf, "%s\n", p);
428}
429
430static ssize_t
431set_usb2_hardware_lpm(struct device *dev, struct device_attribute *attr,
432 const char *buf, size_t count)
433{
434 struct usb_device *udev = to_usb_device(dev);
435 bool value;
436 int ret;
437
438 usb_lock_device(udev);
439
440 ret = strtobool(buf, &value);
441
442 if (!ret)
443 ret = usb_set_usb2_hardware_lpm(udev, value);
444
445 usb_unlock_device(udev);
446
447 if (!ret)
448 return count;
449
450 return ret;
451}
452
453static DEVICE_ATTR(usb2_hardware_lpm, S_IRUGO | S_IWUSR, show_usb2_hardware_lpm,
454 set_usb2_hardware_lpm);
455
456static struct attribute *usb2_hardware_lpm_attr[] = {
457 &dev_attr_usb2_hardware_lpm.attr,
458 NULL,
459};
460static struct attribute_group usb2_hardware_lpm_attr_group = {
461 .name = power_group_name,
462 .attrs = usb2_hardware_lpm_attr,
463};
464
Alan Stern045cac62010-11-15 15:57:07 -0500465static struct attribute *power_attrs[] = {
466 &dev_attr_autosuspend.attr,
467 &dev_attr_level.attr,
468 &dev_attr_connected_duration.attr,
469 &dev_attr_active_duration.attr,
470 NULL,
471};
472static struct attribute_group power_attr_group = {
473 .name = power_group_name,
474 .attrs = power_attrs,
475};
476
Alan Stern19c26232007-02-20 15:03:32 -0500477static int add_power_attributes(struct device *dev)
478{
479 int rc = 0;
480
Andiry Xuc1045e82011-09-23 14:19:53 -0700481 if (is_usb_device(dev)) {
482 struct usb_device *udev = to_usb_device(dev);
Alan Stern045cac62010-11-15 15:57:07 -0500483 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
Andiry Xuc1045e82011-09-23 14:19:53 -0700484 if (udev->usb2_hw_lpm_capable == 1)
485 rc = sysfs_merge_group(&dev->kobj,
486 &usb2_hardware_lpm_attr_group);
487 }
488
Alan Stern19c26232007-02-20 15:03:32 -0500489 return rc;
490}
491
492static void remove_power_attributes(struct device *dev)
493{
Andiry Xuc1045e82011-09-23 14:19:53 -0700494 sysfs_unmerge_group(&dev->kobj, &usb2_hardware_lpm_attr_group);
Alan Stern045cac62010-11-15 15:57:07 -0500495 sysfs_unmerge_group(&dev->kobj, &power_attr_group);
Alan Stern19c26232007-02-20 15:03:32 -0500496}
497
498#else
499
500#define add_power_attributes(dev) 0
501#define remove_power_attributes(dev) do {} while (0)
502
503#endif /* CONFIG_USB_SUSPEND */
504
Alan Sternb41a60e2007-05-30 15:39:33 -0400505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506/* Descriptor fields */
507#define usb_descriptor_attr_le16(field, format_string) \
508static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500509show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400510 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{ \
512 struct usb_device *udev; \
513 \
Oliver Neukum92516442007-01-23 15:55:28 -0500514 udev = to_usb_device(dev); \
515 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 le16_to_cpu(udev->descriptor.field)); \
517} \
518static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
519
520usb_descriptor_attr_le16(idVendor, "%04x\n")
521usb_descriptor_attr_le16(idProduct, "%04x\n")
522usb_descriptor_attr_le16(bcdDevice, "%04x\n")
523
524#define usb_descriptor_attr(field, format_string) \
525static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500526show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400527 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{ \
529 struct usb_device *udev; \
530 \
Oliver Neukum92516442007-01-23 15:55:28 -0500531 udev = to_usb_device(dev); \
532 return sprintf(buf, format_string, udev->descriptor.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533} \
534static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
535
Oliver Neukum92516442007-01-23 15:55:28 -0500536usb_descriptor_attr(bDeviceClass, "%02x\n")
537usb_descriptor_attr(bDeviceSubClass, "%02x\n")
538usb_descriptor_attr(bDeviceProtocol, "%02x\n")
539usb_descriptor_attr(bNumConfigurations, "%d\n")
540usb_descriptor_attr(bMaxPacketSize0, "%d\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700542
543
544/* show if the device is authorized (1) or not (0) */
545static ssize_t usb_dev_authorized_show(struct device *dev,
546 struct device_attribute *attr,
547 char *buf)
548{
549 struct usb_device *usb_dev = to_usb_device(dev);
550 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
551}
552
553
554/*
555 * Authorize a device to be used in the system
556 *
557 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
558 */
559static ssize_t usb_dev_authorized_store(struct device *dev,
560 struct device_attribute *attr,
561 const char *buf, size_t size)
562{
563 ssize_t result;
564 struct usb_device *usb_dev = to_usb_device(dev);
565 unsigned val;
566 result = sscanf(buf, "%u\n", &val);
567 if (result != 1)
568 result = -EINVAL;
569 else if (val == 0)
570 result = usb_deauthorize_device(usb_dev);
571 else
572 result = usb_authorize_device(usb_dev);
573 return result < 0? result : size;
574}
575
576static DEVICE_ATTR(authorized, 0644,
577 usb_dev_authorized_show, usb_dev_authorized_store);
578
Alan Stern253e0572009-10-27 15:20:13 -0400579/* "Safely remove a device" */
580static ssize_t usb_remove_store(struct device *dev,
581 struct device_attribute *attr,
582 const char *buf, size_t count)
583{
584 struct usb_device *udev = to_usb_device(dev);
585 int rc = 0;
586
587 usb_lock_device(udev);
588 if (udev->state != USB_STATE_NOTATTACHED) {
589
590 /* To avoid races, first unconfigure and then remove */
591 usb_set_configuration(udev, -1);
592 rc = usb_remove_device(udev);
593 }
594 if (rc == 0)
595 rc = count;
596 usb_unlock_device(udev);
597 return rc;
598}
599static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
600
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602static struct attribute *dev_attrs[] = {
603 /* current configuration's attributes */
Alan Sternb6eb2d82006-07-06 15:37:42 -0400604 &dev_attr_configuration.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 &dev_attr_bNumInterfaces.attr,
606 &dev_attr_bConfigurationValue.attr,
607 &dev_attr_bmAttributes.attr,
608 &dev_attr_bMaxPower.attr,
609 /* device attributes */
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800610 &dev_attr_urbnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 &dev_attr_idVendor.attr,
612 &dev_attr_idProduct.attr,
613 &dev_attr_bcdDevice.attr,
614 &dev_attr_bDeviceClass.attr,
615 &dev_attr_bDeviceSubClass.attr,
616 &dev_attr_bDeviceProtocol.attr,
617 &dev_attr_bNumConfigurations.attr,
Greg Kroah-Hartmancf5910b2005-06-29 16:53:29 -0700618 &dev_attr_bMaxPacketSize0.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 &dev_attr_speed.attr,
Alan Stern83f7d952007-04-25 15:15:43 -0400620 &dev_attr_busnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 &dev_attr_devnum.attr,
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800622 &dev_attr_devpath.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 &dev_attr_version.attr,
624 &dev_attr_maxchild.attr,
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100625 &dev_attr_quirks.attr,
Oliver Neukumef955342010-01-16 01:33:03 +0100626 &dev_attr_avoid_reset_quirk.attr,
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700627 &dev_attr_authorized.attr,
Alan Stern253e0572009-10-27 15:20:13 -0400628 &dev_attr_remove.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 NULL,
630};
631static struct attribute_group dev_attr_grp = {
632 .attrs = dev_attrs,
633};
634
Alan Stern2e5f10e2008-04-30 15:37:19 -0400635/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
636 * accordingly.
637 */
638static struct attribute *dev_string_attrs[] = {
639 &dev_attr_manufacturer.attr,
640 &dev_attr_product.attr,
641 &dev_attr_serial.attr,
642 NULL
643};
644
645static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
646 struct attribute *a, int n)
647{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400648 struct device *dev = container_of(kobj, struct device, kobj);
649 struct usb_device *udev = to_usb_device(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400650
651 if (a == &dev_attr_manufacturer.attr) {
652 if (udev->manufacturer == NULL)
653 return 0;
654 } else if (a == &dev_attr_product.attr) {
655 if (udev->product == NULL)
656 return 0;
657 } else if (a == &dev_attr_serial.attr) {
658 if (udev->serial == NULL)
659 return 0;
660 }
661 return a->mode;
662}
663
664static struct attribute_group dev_string_attr_grp = {
665 .attrs = dev_string_attrs,
666 .is_visible = dev_string_attrs_are_visible,
667};
668
David Brownella4dbd672009-06-24 10:06:31 -0700669const struct attribute_group *usb_device_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400670 &dev_attr_grp,
671 &dev_string_attr_grp,
672 NULL
673};
674
Alan Stern69d42a72007-07-12 17:06:23 -0400675/* Binary descriptors */
676
677static ssize_t
Chris Wright2c3c8be2010-05-12 18:28:57 -0700678read_descriptors(struct file *filp, struct kobject *kobj,
679 struct bin_attribute *attr,
Alan Stern69d42a72007-07-12 17:06:23 -0400680 char *buf, loff_t off, size_t count)
681{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400682 struct device *dev = container_of(kobj, struct device, kobj);
683 struct usb_device *udev = to_usb_device(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400684 size_t nleft = count;
685 size_t srclen, n;
Alan Stern217a9082008-05-20 16:40:42 -0400686 int cfgno;
687 void *src;
Alan Stern69d42a72007-07-12 17:06:23 -0400688
Alan Stern217a9082008-05-20 16:40:42 -0400689 /* The binary attribute begins with the device descriptor.
690 * Following that are the raw descriptor entries for all the
691 * configurations (config plus subsidiary descriptors).
Alan Stern69d42a72007-07-12 17:06:23 -0400692 */
Alan Stern217a9082008-05-20 16:40:42 -0400693 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
694 nleft > 0; ++cfgno) {
695 if (cfgno < 0) {
696 src = &udev->descriptor;
697 srclen = sizeof(struct usb_device_descriptor);
698 } else {
699 src = udev->rawdescriptors[cfgno];
700 srclen = __le16_to_cpu(udev->config[cfgno].desc.
701 wTotalLength);
702 }
Alan Stern69d42a72007-07-12 17:06:23 -0400703 if (off < srclen) {
Alan Stern217a9082008-05-20 16:40:42 -0400704 n = min(nleft, srclen - (size_t) off);
705 memcpy(buf, src + off, n);
Alan Stern69d42a72007-07-12 17:06:23 -0400706 nleft -= n;
Alan Stern217a9082008-05-20 16:40:42 -0400707 buf += n;
708 off = 0;
709 } else {
710 off -= srclen;
Alan Stern69d42a72007-07-12 17:06:23 -0400711 }
712 }
Alan Stern69d42a72007-07-12 17:06:23 -0400713 return count - nleft;
714}
715
716static struct bin_attribute dev_bin_attr_descriptors = {
717 .attr = {.name = "descriptors", .mode = 0444},
718 .read = read_descriptors,
719 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
720};
721
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700722int usb_create_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 struct device *dev = &udev->dev;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700725 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Alan Stern69d42a72007-07-12 17:06:23 -0400727 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
728 if (retval)
729 goto error;
730
Alan Sternb41a60e2007-05-30 15:39:33 -0400731 retval = add_persist_attributes(dev);
732 if (retval)
733 goto error;
734
Alan Stern19c26232007-02-20 15:03:32 -0500735 retval = add_power_attributes(dev);
736 if (retval)
737 goto error;
Alan Stern3b23dd62008-12-05 14:10:34 -0500738 return retval;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700739error:
Alan Sternaa084f32007-02-20 14:59:59 -0500740 usb_remove_sysfs_dev_files(udev);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700741 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742}
743
Oliver Neukum92516442007-01-23 15:55:28 -0500744void usb_remove_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
746 struct device *dev = &udev->dev;
747
Alan Stern19c26232007-02-20 15:03:32 -0500748 remove_power_attributes(dev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400749 remove_persist_attributes(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400750 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751}
752
Craig W. Nadler165fe972007-06-15 23:14:35 -0400753/* Interface Accociation Descriptor fields */
754#define usb_intf_assoc_attr(field, format_string) \
755static ssize_t \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800756show_iad_##field(struct device *dev, struct device_attribute *attr, \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400757 char *buf) \
758{ \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800759 struct usb_interface *intf = to_usb_interface(dev); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400760 \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800761 return sprintf(buf, format_string, \
762 intf->intf_assoc->field); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400763} \
764static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
765
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800766usb_intf_assoc_attr(bFirstInterface, "%02x\n")
767usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
768usb_intf_assoc_attr(bFunctionClass, "%02x\n")
769usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
770usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
Craig W. Nadler165fe972007-06-15 23:14:35 -0400771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772/* Interface fields */
773#define usb_intf_attr(field, format_string) \
774static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500775show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400776 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777{ \
Oliver Neukum92516442007-01-23 15:55:28 -0500778 struct usb_interface *intf = to_usb_interface(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 \
Oliver Neukum92516442007-01-23 15:55:28 -0500780 return sprintf(buf, format_string, \
Alan Sternb724ae72005-10-24 15:36:00 -0400781 intf->cur_altsetting->desc.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782} \
783static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
784
Oliver Neukum92516442007-01-23 15:55:28 -0500785usb_intf_attr(bInterfaceNumber, "%02x\n")
786usb_intf_attr(bAlternateSetting, "%2d\n")
787usb_intf_attr(bNumEndpoints, "%02x\n")
788usb_intf_attr(bInterfaceClass, "%02x\n")
789usb_intf_attr(bInterfaceSubClass, "%02x\n")
790usb_intf_attr(bInterfaceProtocol, "%02x\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Alan Sternb724ae72005-10-24 15:36:00 -0400792static ssize_t show_interface_string(struct device *dev,
793 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
795 struct usb_interface *intf;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400796 char *string;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Oliver Neukum92516442007-01-23 15:55:28 -0500798 intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400799 string = intf->cur_altsetting->string;
800 barrier(); /* The altsetting might change! */
801
802 if (!string)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 return 0;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400804 return sprintf(buf, "%s\n", string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805}
806static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
807
Alan Sternb724ae72005-10-24 15:36:00 -0400808static ssize_t show_modalias(struct device *dev,
809 struct device_attribute *attr, char *buf)
Greg KH360b52b2005-05-10 06:45:10 -0700810{
811 struct usb_interface *intf;
812 struct usb_device *udev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700813 struct usb_host_interface *alt;
Greg KH360b52b2005-05-10 06:45:10 -0700814
815 intf = to_usb_interface(dev);
816 udev = interface_to_usbdev(intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700817 alt = intf->cur_altsetting;
Greg KH360b52b2005-05-10 06:45:10 -0700818
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700819 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
820 "ic%02Xisc%02Xip%02X\n",
821 le16_to_cpu(udev->descriptor.idVendor),
822 le16_to_cpu(udev->descriptor.idProduct),
823 le16_to_cpu(udev->descriptor.bcdDevice),
824 udev->descriptor.bDeviceClass,
825 udev->descriptor.bDeviceSubClass,
826 udev->descriptor.bDeviceProtocol,
827 alt->desc.bInterfaceClass,
828 alt->desc.bInterfaceSubClass,
829 alt->desc.bInterfaceProtocol);
Greg KH360b52b2005-05-10 06:45:10 -0700830}
831static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
832
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700833static ssize_t show_supports_autosuspend(struct device *dev,
834 struct device_attribute *attr, char *buf)
835{
836 struct usb_interface *intf;
837 struct usb_device *udev;
838 int ret;
839
840 intf = to_usb_interface(dev);
841 udev = interface_to_usbdev(intf);
842
843 usb_lock_device(udev);
844 /* Devices will be autosuspended even when an interface isn't claimed */
845 if (!intf->dev.driver ||
846 to_usb_driver(intf->dev.driver)->supports_autosuspend)
847 ret = sprintf(buf, "%u\n", 1);
848 else
849 ret = sprintf(buf, "%u\n", 0);
850 usb_unlock_device(udev);
851
852 return ret;
853}
854static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856static struct attribute *intf_attrs[] = {
857 &dev_attr_bInterfaceNumber.attr,
858 &dev_attr_bAlternateSetting.attr,
859 &dev_attr_bNumEndpoints.attr,
860 &dev_attr_bInterfaceClass.attr,
861 &dev_attr_bInterfaceSubClass.attr,
862 &dev_attr_bInterfaceProtocol.attr,
Greg KH360b52b2005-05-10 06:45:10 -0700863 &dev_attr_modalias.attr,
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700864 &dev_attr_supports_autosuspend.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 NULL,
866};
867static struct attribute_group intf_attr_grp = {
868 .attrs = intf_attrs,
869};
870
Alan Stern2e5f10e2008-04-30 15:37:19 -0400871static struct attribute *intf_assoc_attrs[] = {
872 &dev_attr_iad_bFirstInterface.attr,
873 &dev_attr_iad_bInterfaceCount.attr,
874 &dev_attr_iad_bFunctionClass.attr,
875 &dev_attr_iad_bFunctionSubClass.attr,
876 &dev_attr_iad_bFunctionProtocol.attr,
877 NULL,
878};
879
880static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
881 struct attribute *a, int n)
882{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400883 struct device *dev = container_of(kobj, struct device, kobj);
884 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400885
886 if (intf->intf_assoc == NULL)
887 return 0;
888 return a->mode;
889}
890
891static struct attribute_group intf_assoc_attr_grp = {
892 .attrs = intf_assoc_attrs,
893 .is_visible = intf_assoc_attrs_are_visible,
894};
895
David Brownella4dbd672009-06-24 10:06:31 -0700896const struct attribute_group *usb_interface_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400897 &intf_attr_grp,
898 &intf_assoc_attr_grp,
899 NULL
900};
901
Michal Nazarewicz643de622011-04-14 17:47:09 +0200902void usb_create_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Alan Stern4f62efe2005-10-24 16:24:14 -0400904 struct usb_device *udev = interface_to_usbdev(intf);
905 struct usb_host_interface *alt = intf->cur_altsetting;
906
Alan Stern352d0262008-10-29 15:16:58 -0400907 if (intf->sysfs_files_created || intf->unregistering)
Michal Nazarewicz643de622011-04-14 17:47:09 +0200908 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Michal Nazarewicz643de622011-04-14 17:47:09 +0200910 if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern4f62efe2005-10-24 16:24:14 -0400911 alt->string = usb_cache_string(udev, alt->desc.iInterface);
Michal Nazarewicz643de622011-04-14 17:47:09 +0200912 if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
913 ; /* We don't actually care if the function fails. */
Alan Stern7e615592007-11-06 11:43:42 -0500914 intf->sysfs_files_created = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
916
Oliver Neukum92516442007-01-23 15:55:28 -0500917void usb_remove_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918{
Alan Stern7e615592007-11-06 11:43:42 -0500919 if (!intf->sysfs_files_created)
920 return;
Alan Stern92b0da12008-10-29 15:18:50 -0400921
Alan Stern92b0da12008-10-29 15:18:50 -0400922 device_remove_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500923 intf->sysfs_files_created = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}