blob: 9561e087907db8922bdd471ad63df0aee1895d0e [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{
337 struct usb_device *udev = to_usb_device(dev);
338
Alan Sterneaafbc32007-03-13 16:39:15 -0400339 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
Alan Stern19c26232007-02-20 15:03:32 -0500340}
341
342static ssize_t
343set_autosuspend(struct device *dev, struct device_attribute *attr,
344 const char *buf, size_t count)
345{
346 struct usb_device *udev = to_usb_device(dev);
Alan Stern5899f1e2010-01-08 12:57:02 -0500347 int value, old_delay;
348 int rc;
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 Stern62e299e2010-01-08 12:56:19 -0500355 usb_lock_device(udev);
Alan Stern5899f1e2010-01-08 12:57:02 -0500356 old_delay = udev->autosuspend_delay;
Alan Stern19c26232007-02-20 15:03:32 -0500357 udev->autosuspend_delay = value;
Alan Stern5899f1e2010-01-08 12:57:02 -0500358
359 if (old_delay < 0) { /* Autosuspend wasn't allowed */
360 if (value >= 0)
Alan Stern2add5222007-03-20 14:59:39 -0400361 usb_autosuspend_device(udev);
Alan Stern5899f1e2010-01-08 12:57:02 -0500362 } else { /* Autosuspend was allowed */
363 if (value < 0) {
364 rc = usb_autoresume_device(udev);
365 if (rc < 0) {
366 count = rc;
367 udev->autosuspend_delay = old_delay;
368 }
369 } else {
370 usb_try_autosuspend_device(udev);
371 }
Alan Sterneaafbc32007-03-13 16:39:15 -0400372 }
Alan Stern5899f1e2010-01-08 12:57:02 -0500373
Alan Stern62e299e2010-01-08 12:56:19 -0500374 usb_unlock_device(udev);
Alan Stern19c26232007-02-20 15:03:32 -0500375 return count;
376}
377
378static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
379 show_autosuspend, set_autosuspend);
380
Alan Stern2add5222007-03-20 14:59:39 -0400381static const char on_string[] = "on";
382static const char auto_string[] = "auto";
Alan Stern2add5222007-03-20 14:59:39 -0400383
Alan Sterna9030982010-04-02 13:22:16 -0400384static void warn_level(void) {
385 static int level_warned;
386
387 if (!level_warned) {
388 level_warned = 1;
389 printk(KERN_WARNING "WARNING! power/level is deprecated; "
390 "use power/control instead\n");
391 }
392}
393
Alan Stern2add5222007-03-20 14:59:39 -0400394static ssize_t
395show_level(struct device *dev, struct device_attribute *attr, char *buf)
396{
397 struct usb_device *udev = to_usb_device(dev);
398 const char *p = auto_string;
399
Alan Sterna9030982010-04-02 13:22:16 -0400400 warn_level();
Alan Stern9e18c822010-04-02 13:22:09 -0400401 if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
Alan Stern8e4ceb32009-12-07 13:01:37 -0500402 p = on_string;
Alan Stern2add5222007-03-20 14:59:39 -0400403 return sprintf(buf, "%s\n", p);
404}
405
406static ssize_t
407set_level(struct device *dev, struct device_attribute *attr,
408 const char *buf, size_t count)
409{
410 struct usb_device *udev = to_usb_device(dev);
411 int len = count;
412 char *cp;
Alan Stern9e18c822010-04-02 13:22:09 -0400413 int rc = count;
Alan Stern2add5222007-03-20 14:59:39 -0400414
Alan Sterna9030982010-04-02 13:22:16 -0400415 warn_level();
Alan Stern2add5222007-03-20 14:59:39 -0400416 cp = memchr(buf, '\n', count);
417 if (cp)
418 len = cp - buf;
419
420 usb_lock_device(udev);
421
Alan Stern2add5222007-03-20 14:59:39 -0400422 if (len == sizeof on_string - 1 &&
Alan Stern088f7fe2010-01-08 12:56:54 -0500423 strncmp(buf, on_string, len) == 0)
Alan Stern9e18c822010-04-02 13:22:09 -0400424 usb_disable_autosuspend(udev);
Alan Stern2add5222007-03-20 14:59:39 -0400425
Alan Stern088f7fe2010-01-08 12:56:54 -0500426 else if (len == sizeof auto_string - 1 &&
427 strncmp(buf, auto_string, len) == 0)
Alan Stern9e18c822010-04-02 13:22:09 -0400428 usb_enable_autosuspend(udev);
Alan Stern2add5222007-03-20 14:59:39 -0400429
Alan Stern088f7fe2010-01-08 12:56:54 -0500430 else
Alan Stern2add5222007-03-20 14:59:39 -0400431 rc = -EINVAL;
432
433 usb_unlock_device(udev);
Alan Stern9e18c822010-04-02 13:22:09 -0400434 return rc;
Alan Stern2add5222007-03-20 14:59:39 -0400435}
436
437static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
438
Alan Stern045cac62010-11-15 15:57:07 -0500439static struct attribute *power_attrs[] = {
440 &dev_attr_autosuspend.attr,
441 &dev_attr_level.attr,
442 &dev_attr_connected_duration.attr,
443 &dev_attr_active_duration.attr,
444 NULL,
445};
446static struct attribute_group power_attr_group = {
447 .name = power_group_name,
448 .attrs = power_attrs,
449};
450
Alan Stern19c26232007-02-20 15:03:32 -0500451static int add_power_attributes(struct device *dev)
452{
453 int rc = 0;
454
Alan Stern045cac62010-11-15 15:57:07 -0500455 if (is_usb_device(dev))
456 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
Alan Stern19c26232007-02-20 15:03:32 -0500457 return rc;
458}
459
460static void remove_power_attributes(struct device *dev)
461{
Alan Stern045cac62010-11-15 15:57:07 -0500462 sysfs_unmerge_group(&dev->kobj, &power_attr_group);
Alan Stern19c26232007-02-20 15:03:32 -0500463}
464
465#else
466
467#define add_power_attributes(dev) 0
468#define remove_power_attributes(dev) do {} while (0)
469
470#endif /* CONFIG_USB_SUSPEND */
471
Alan Sternb41a60e2007-05-30 15:39:33 -0400472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/* Descriptor fields */
474#define usb_descriptor_attr_le16(field, format_string) \
475static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500476show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400477 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478{ \
479 struct usb_device *udev; \
480 \
Oliver Neukum92516442007-01-23 15:55:28 -0500481 udev = to_usb_device(dev); \
482 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 le16_to_cpu(udev->descriptor.field)); \
484} \
485static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
486
487usb_descriptor_attr_le16(idVendor, "%04x\n")
488usb_descriptor_attr_le16(idProduct, "%04x\n")
489usb_descriptor_attr_le16(bcdDevice, "%04x\n")
490
491#define usb_descriptor_attr(field, format_string) \
492static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500493show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400494 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{ \
496 struct usb_device *udev; \
497 \
Oliver Neukum92516442007-01-23 15:55:28 -0500498 udev = to_usb_device(dev); \
499 return sprintf(buf, format_string, udev->descriptor.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500} \
501static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
502
Oliver Neukum92516442007-01-23 15:55:28 -0500503usb_descriptor_attr(bDeviceClass, "%02x\n")
504usb_descriptor_attr(bDeviceSubClass, "%02x\n")
505usb_descriptor_attr(bDeviceProtocol, "%02x\n")
506usb_descriptor_attr(bNumConfigurations, "%d\n")
507usb_descriptor_attr(bMaxPacketSize0, "%d\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700509
510
511/* show if the device is authorized (1) or not (0) */
512static ssize_t usb_dev_authorized_show(struct device *dev,
513 struct device_attribute *attr,
514 char *buf)
515{
516 struct usb_device *usb_dev = to_usb_device(dev);
517 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
518}
519
520
521/*
522 * Authorize a device to be used in the system
523 *
524 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
525 */
526static ssize_t usb_dev_authorized_store(struct device *dev,
527 struct device_attribute *attr,
528 const char *buf, size_t size)
529{
530 ssize_t result;
531 struct usb_device *usb_dev = to_usb_device(dev);
532 unsigned val;
533 result = sscanf(buf, "%u\n", &val);
534 if (result != 1)
535 result = -EINVAL;
536 else if (val == 0)
537 result = usb_deauthorize_device(usb_dev);
538 else
539 result = usb_authorize_device(usb_dev);
540 return result < 0? result : size;
541}
542
543static DEVICE_ATTR(authorized, 0644,
544 usb_dev_authorized_show, usb_dev_authorized_store);
545
Alan Stern253e0572009-10-27 15:20:13 -0400546/* "Safely remove a device" */
547static ssize_t usb_remove_store(struct device *dev,
548 struct device_attribute *attr,
549 const char *buf, size_t count)
550{
551 struct usb_device *udev = to_usb_device(dev);
552 int rc = 0;
553
554 usb_lock_device(udev);
555 if (udev->state != USB_STATE_NOTATTACHED) {
556
557 /* To avoid races, first unconfigure and then remove */
558 usb_set_configuration(udev, -1);
559 rc = usb_remove_device(udev);
560 }
561 if (rc == 0)
562 rc = count;
563 usb_unlock_device(udev);
564 return rc;
565}
566static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
567
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569static struct attribute *dev_attrs[] = {
570 /* current configuration's attributes */
Alan Sternb6eb2d82006-07-06 15:37:42 -0400571 &dev_attr_configuration.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 &dev_attr_bNumInterfaces.attr,
573 &dev_attr_bConfigurationValue.attr,
574 &dev_attr_bmAttributes.attr,
575 &dev_attr_bMaxPower.attr,
576 /* device attributes */
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800577 &dev_attr_urbnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 &dev_attr_idVendor.attr,
579 &dev_attr_idProduct.attr,
580 &dev_attr_bcdDevice.attr,
581 &dev_attr_bDeviceClass.attr,
582 &dev_attr_bDeviceSubClass.attr,
583 &dev_attr_bDeviceProtocol.attr,
584 &dev_attr_bNumConfigurations.attr,
Greg Kroah-Hartmancf5910b2005-06-29 16:53:29 -0700585 &dev_attr_bMaxPacketSize0.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 &dev_attr_speed.attr,
Alan Stern83f7d952007-04-25 15:15:43 -0400587 &dev_attr_busnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 &dev_attr_devnum.attr,
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800589 &dev_attr_devpath.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 &dev_attr_version.attr,
591 &dev_attr_maxchild.attr,
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100592 &dev_attr_quirks.attr,
Oliver Neukumef955342010-01-16 01:33:03 +0100593 &dev_attr_avoid_reset_quirk.attr,
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700594 &dev_attr_authorized.attr,
Alan Stern253e0572009-10-27 15:20:13 -0400595 &dev_attr_remove.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 NULL,
597};
598static struct attribute_group dev_attr_grp = {
599 .attrs = dev_attrs,
600};
601
Alan Stern2e5f10e2008-04-30 15:37:19 -0400602/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
603 * accordingly.
604 */
605static struct attribute *dev_string_attrs[] = {
606 &dev_attr_manufacturer.attr,
607 &dev_attr_product.attr,
608 &dev_attr_serial.attr,
609 NULL
610};
611
612static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
613 struct attribute *a, int n)
614{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400615 struct device *dev = container_of(kobj, struct device, kobj);
616 struct usb_device *udev = to_usb_device(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400617
618 if (a == &dev_attr_manufacturer.attr) {
619 if (udev->manufacturer == NULL)
620 return 0;
621 } else if (a == &dev_attr_product.attr) {
622 if (udev->product == NULL)
623 return 0;
624 } else if (a == &dev_attr_serial.attr) {
625 if (udev->serial == NULL)
626 return 0;
627 }
628 return a->mode;
629}
630
631static struct attribute_group dev_string_attr_grp = {
632 .attrs = dev_string_attrs,
633 .is_visible = dev_string_attrs_are_visible,
634};
635
David Brownella4dbd672009-06-24 10:06:31 -0700636const struct attribute_group *usb_device_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400637 &dev_attr_grp,
638 &dev_string_attr_grp,
639 NULL
640};
641
Alan Stern69d42a72007-07-12 17:06:23 -0400642/* Binary descriptors */
643
644static ssize_t
Chris Wright2c3c8be2010-05-12 18:28:57 -0700645read_descriptors(struct file *filp, struct kobject *kobj,
646 struct bin_attribute *attr,
Alan Stern69d42a72007-07-12 17:06:23 -0400647 char *buf, loff_t off, size_t count)
648{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400649 struct device *dev = container_of(kobj, struct device, kobj);
650 struct usb_device *udev = to_usb_device(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400651 size_t nleft = count;
652 size_t srclen, n;
Alan Stern217a9082008-05-20 16:40:42 -0400653 int cfgno;
654 void *src;
Alan Stern69d42a72007-07-12 17:06:23 -0400655
Alan Stern217a9082008-05-20 16:40:42 -0400656 /* The binary attribute begins with the device descriptor.
657 * Following that are the raw descriptor entries for all the
658 * configurations (config plus subsidiary descriptors).
Alan Stern69d42a72007-07-12 17:06:23 -0400659 */
Alan Stern217a9082008-05-20 16:40:42 -0400660 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
661 nleft > 0; ++cfgno) {
662 if (cfgno < 0) {
663 src = &udev->descriptor;
664 srclen = sizeof(struct usb_device_descriptor);
665 } else {
666 src = udev->rawdescriptors[cfgno];
667 srclen = __le16_to_cpu(udev->config[cfgno].desc.
668 wTotalLength);
669 }
Alan Stern69d42a72007-07-12 17:06:23 -0400670 if (off < srclen) {
Alan Stern217a9082008-05-20 16:40:42 -0400671 n = min(nleft, srclen - (size_t) off);
672 memcpy(buf, src + off, n);
Alan Stern69d42a72007-07-12 17:06:23 -0400673 nleft -= n;
Alan Stern217a9082008-05-20 16:40:42 -0400674 buf += n;
675 off = 0;
676 } else {
677 off -= srclen;
Alan Stern69d42a72007-07-12 17:06:23 -0400678 }
679 }
Alan Stern69d42a72007-07-12 17:06:23 -0400680 return count - nleft;
681}
682
683static struct bin_attribute dev_bin_attr_descriptors = {
684 .attr = {.name = "descriptors", .mode = 0444},
685 .read = read_descriptors,
686 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
687};
688
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700689int usb_create_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690{
691 struct device *dev = &udev->dev;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700692 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Alan Stern69d42a72007-07-12 17:06:23 -0400694 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
695 if (retval)
696 goto error;
697
Alan Sternb41a60e2007-05-30 15:39:33 -0400698 retval = add_persist_attributes(dev);
699 if (retval)
700 goto error;
701
Alan Stern19c26232007-02-20 15:03:32 -0500702 retval = add_power_attributes(dev);
703 if (retval)
704 goto error;
Alan Stern3b23dd62008-12-05 14:10:34 -0500705 return retval;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700706error:
Alan Sternaa084f32007-02-20 14:59:59 -0500707 usb_remove_sysfs_dev_files(udev);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700708 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709}
710
Oliver Neukum92516442007-01-23 15:55:28 -0500711void usb_remove_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
713 struct device *dev = &udev->dev;
714
Alan Stern19c26232007-02-20 15:03:32 -0500715 remove_power_attributes(dev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400716 remove_persist_attributes(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400717 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718}
719
Craig W. Nadler165fe972007-06-15 23:14:35 -0400720/* Interface Accociation Descriptor fields */
721#define usb_intf_assoc_attr(field, format_string) \
722static ssize_t \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800723show_iad_##field(struct device *dev, struct device_attribute *attr, \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400724 char *buf) \
725{ \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800726 struct usb_interface *intf = to_usb_interface(dev); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400727 \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800728 return sprintf(buf, format_string, \
729 intf->intf_assoc->field); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400730} \
731static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
732
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800733usb_intf_assoc_attr(bFirstInterface, "%02x\n")
734usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
735usb_intf_assoc_attr(bFunctionClass, "%02x\n")
736usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
737usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
Craig W. Nadler165fe972007-06-15 23:14:35 -0400738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739/* Interface fields */
740#define usb_intf_attr(field, format_string) \
741static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500742show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400743 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{ \
Oliver Neukum92516442007-01-23 15:55:28 -0500745 struct usb_interface *intf = to_usb_interface(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 \
Oliver Neukum92516442007-01-23 15:55:28 -0500747 return sprintf(buf, format_string, \
Alan Sternb724ae72005-10-24 15:36:00 -0400748 intf->cur_altsetting->desc.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749} \
750static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
751
Oliver Neukum92516442007-01-23 15:55:28 -0500752usb_intf_attr(bInterfaceNumber, "%02x\n")
753usb_intf_attr(bAlternateSetting, "%2d\n")
754usb_intf_attr(bNumEndpoints, "%02x\n")
755usb_intf_attr(bInterfaceClass, "%02x\n")
756usb_intf_attr(bInterfaceSubClass, "%02x\n")
757usb_intf_attr(bInterfaceProtocol, "%02x\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Alan Sternb724ae72005-10-24 15:36:00 -0400759static ssize_t show_interface_string(struct device *dev,
760 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
762 struct usb_interface *intf;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400763 char *string;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Oliver Neukum92516442007-01-23 15:55:28 -0500765 intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400766 string = intf->cur_altsetting->string;
767 barrier(); /* The altsetting might change! */
768
769 if (!string)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return 0;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400771 return sprintf(buf, "%s\n", string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
774
Alan Sternb724ae72005-10-24 15:36:00 -0400775static ssize_t show_modalias(struct device *dev,
776 struct device_attribute *attr, char *buf)
Greg KH360b52b2005-05-10 06:45:10 -0700777{
778 struct usb_interface *intf;
779 struct usb_device *udev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700780 struct usb_host_interface *alt;
Greg KH360b52b2005-05-10 06:45:10 -0700781
782 intf = to_usb_interface(dev);
783 udev = interface_to_usbdev(intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700784 alt = intf->cur_altsetting;
Greg KH360b52b2005-05-10 06:45:10 -0700785
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700786 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
787 "ic%02Xisc%02Xip%02X\n",
788 le16_to_cpu(udev->descriptor.idVendor),
789 le16_to_cpu(udev->descriptor.idProduct),
790 le16_to_cpu(udev->descriptor.bcdDevice),
791 udev->descriptor.bDeviceClass,
792 udev->descriptor.bDeviceSubClass,
793 udev->descriptor.bDeviceProtocol,
794 alt->desc.bInterfaceClass,
795 alt->desc.bInterfaceSubClass,
796 alt->desc.bInterfaceProtocol);
Greg KH360b52b2005-05-10 06:45:10 -0700797}
798static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
799
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700800static ssize_t show_supports_autosuspend(struct device *dev,
801 struct device_attribute *attr, char *buf)
802{
803 struct usb_interface *intf;
804 struct usb_device *udev;
805 int ret;
806
807 intf = to_usb_interface(dev);
808 udev = interface_to_usbdev(intf);
809
810 usb_lock_device(udev);
811 /* Devices will be autosuspended even when an interface isn't claimed */
812 if (!intf->dev.driver ||
813 to_usb_driver(intf->dev.driver)->supports_autosuspend)
814 ret = sprintf(buf, "%u\n", 1);
815 else
816 ret = sprintf(buf, "%u\n", 0);
817 usb_unlock_device(udev);
818
819 return ret;
820}
821static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
822
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823static struct attribute *intf_attrs[] = {
824 &dev_attr_bInterfaceNumber.attr,
825 &dev_attr_bAlternateSetting.attr,
826 &dev_attr_bNumEndpoints.attr,
827 &dev_attr_bInterfaceClass.attr,
828 &dev_attr_bInterfaceSubClass.attr,
829 &dev_attr_bInterfaceProtocol.attr,
Greg KH360b52b2005-05-10 06:45:10 -0700830 &dev_attr_modalias.attr,
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700831 &dev_attr_supports_autosuspend.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 NULL,
833};
834static struct attribute_group intf_attr_grp = {
835 .attrs = intf_attrs,
836};
837
Alan Stern2e5f10e2008-04-30 15:37:19 -0400838static struct attribute *intf_assoc_attrs[] = {
839 &dev_attr_iad_bFirstInterface.attr,
840 &dev_attr_iad_bInterfaceCount.attr,
841 &dev_attr_iad_bFunctionClass.attr,
842 &dev_attr_iad_bFunctionSubClass.attr,
843 &dev_attr_iad_bFunctionProtocol.attr,
844 NULL,
845};
846
847static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
848 struct attribute *a, int n)
849{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400850 struct device *dev = container_of(kobj, struct device, kobj);
851 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400852
853 if (intf->intf_assoc == NULL)
854 return 0;
855 return a->mode;
856}
857
858static struct attribute_group intf_assoc_attr_grp = {
859 .attrs = intf_assoc_attrs,
860 .is_visible = intf_assoc_attrs_are_visible,
861};
862
David Brownella4dbd672009-06-24 10:06:31 -0700863const struct attribute_group *usb_interface_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400864 &intf_attr_grp,
865 &intf_assoc_attr_grp,
866 NULL
867};
868
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700869int usb_create_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870{
Alan Stern4f62efe2005-10-24 16:24:14 -0400871 struct usb_device *udev = interface_to_usbdev(intf);
872 struct usb_host_interface *alt = intf->cur_altsetting;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700873 int retval;
Alan Stern4f62efe2005-10-24 16:24:14 -0400874
Alan Stern352d0262008-10-29 15:16:58 -0400875 if (intf->sysfs_files_created || intf->unregistering)
Alan Stern7e615592007-11-06 11:43:42 -0500876 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Alan Stern1662e3a2009-03-18 14:28:53 -0400878 if (alt->string == NULL &&
879 !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern4f62efe2005-10-24 16:24:14 -0400880 alt->string = usb_cache_string(udev, alt->desc.iInterface);
881 if (alt->string)
Alan Stern2e5f10e2008-04-30 15:37:19 -0400882 retval = device_create_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500883 intf->sysfs_files_created = 1;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700884 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
Oliver Neukum92516442007-01-23 15:55:28 -0500887void usb_remove_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
Alan Stern7e615592007-11-06 11:43:42 -0500889 if (!intf->sysfs_files_created)
890 return;
Alan Stern92b0da12008-10-29 15:18:50 -0400891
Alan Stern92b0da12008-10-29 15:18:50 -0400892 device_remove_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500893 intf->sysfs_files_created = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894}