blob: 15477008b63179fdd3f28443c508653be74a744e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/usb/core/sysfs.c
3 *
4 * (C) Copyright 2002 David Brownell
5 * (C) Copyright 2002,2004 Greg Kroah-Hartman
6 * (C) Copyright 2002,2004 IBM Corp.
7 *
8 * All of the sysfs file attributes for usb devices and interfaces.
9 *
10 */
11
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/kernel.h>
Alan Stern2add5222007-03-20 14:59:39 -040014#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/usb.h>
Alan Stern1662e3a2009-03-18 14:28:53 -040016#include <linux/usb/quirks.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include "usb.h"
18
19/* Active configuration fields */
20#define usb_actconfig_show(field, multiplier, format_string) \
Oliver Neukum92516442007-01-23 15:55:28 -050021static ssize_t show_##field(struct device *dev, \
Alan Sternb724ae72005-10-24 15:36:00 -040022 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070023{ \
24 struct usb_device *udev; \
25 struct usb_host_config *actconfig; \
26 \
Oliver Neukum92516442007-01-23 15:55:28 -050027 udev = to_usb_device(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 actconfig = udev->actconfig; \
29 if (actconfig) \
Oliver Neukum92516442007-01-23 15:55:28 -050030 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 actconfig->desc.field * multiplier); \
32 else \
33 return 0; \
34} \
35
36#define usb_actconfig_attr(field, multiplier, format_string) \
37usb_actconfig_show(field, multiplier, format_string) \
38static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
39
Oliver Neukum92516442007-01-23 15:55:28 -050040usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
41usb_actconfig_attr(bmAttributes, 1, "%2x\n")
42usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Alan Sternb724ae72005-10-24 15:36:00 -040044static ssize_t show_configuration_string(struct device *dev,
45 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046{
47 struct usb_device *udev;
48 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Oliver Neukum92516442007-01-23 15:55:28 -050050 udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 actconfig = udev->actconfig;
52 if ((!actconfig) || (!actconfig->string))
53 return 0;
Alan Stern4f62efe2005-10-24 16:24:14 -040054 return sprintf(buf, "%s\n", actconfig->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055}
56static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
57
58/* configuration value is always present, and r/w */
59usb_actconfig_show(bConfigurationValue, 1, "%u\n");
60
61static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -050062set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
Alan Sternb724ae72005-10-24 15:36:00 -040063 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064{
Oliver Neukum92516442007-01-23 15:55:28 -050065 struct usb_device *udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 int config, value;
67
Alan Stern3f141e22007-02-08 16:40:43 -050068 if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 return -EINVAL;
70 usb_lock_device(udev);
Oliver Neukum92516442007-01-23 15:55:28 -050071 value = usb_set_configuration(udev, config);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 usb_unlock_device(udev);
73 return (value < 0) ? value : count;
74}
75
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -080076static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 show_bConfigurationValue, set_bConfigurationValue);
78
79/* String fields */
80#define usb_string_attr(name) \
Alan Sternb724ae72005-10-24 15:36:00 -040081static ssize_t show_##name(struct device *dev, \
82 struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{ \
84 struct usb_device *udev; \
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 \
Oliver Neukum92516442007-01-23 15:55:28 -050086 udev = to_usb_device(dev); \
Alan Stern4f62efe2005-10-24 16:24:14 -040087 return sprintf(buf, "%s\n", udev->name); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070088} \
89static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
90
91usb_string_attr(product);
92usb_string_attr(manufacturer);
93usb_string_attr(serial);
94
95static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -050096show_speed(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097{
98 struct usb_device *udev;
99 char *speed;
100
Oliver Neukum92516442007-01-23 15:55:28 -0500101 udev = to_usb_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 switch (udev->speed) {
104 case USB_SPEED_LOW:
105 speed = "1.5";
106 break;
107 case USB_SPEED_UNKNOWN:
108 case USB_SPEED_FULL:
109 speed = "12";
110 break;
111 case USB_SPEED_HIGH:
112 speed = "480";
113 break;
114 default:
115 speed = "unknown";
116 }
Oliver Neukum92516442007-01-23 15:55:28 -0500117 return sprintf(buf, "%s\n", speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118}
119static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
120
121static ssize_t
Alan Stern83f7d952007-04-25 15:15:43 -0400122show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
123{
124 struct usb_device *udev;
125
126 udev = to_usb_device(dev);
127 return sprintf(buf, "%d\n", udev->bus->busnum);
128}
129static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
130
131static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500132show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
134 struct usb_device *udev;
135
Oliver Neukum92516442007-01-23 15:55:28 -0500136 udev = to_usb_device(dev);
137 return sprintf(buf, "%d\n", udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138}
139static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
140
141static ssize_t
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800142show_devpath(struct device *dev, struct device_attribute *attr, char *buf)
143{
144 struct usb_device *udev;
145
146 udev = to_usb_device(dev);
147 return sprintf(buf, "%s\n", udev->devpath);
148}
149static DEVICE_ATTR(devpath, S_IRUGO, show_devpath, NULL);
150
151static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500152show_version(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153{
154 struct usb_device *udev;
155 u16 bcdUSB;
156
157 udev = to_usb_device(dev);
158 bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
159 return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
160}
161static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
162
163static ssize_t
Oliver Neukum92516442007-01-23 15:55:28 -0500164show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 struct usb_device *udev;
167
Oliver Neukum92516442007-01-23 15:55:28 -0500168 udev = to_usb_device(dev);
169 return sprintf(buf, "%d\n", udev->maxchild);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170}
171static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
172
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100173static ssize_t
174show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
175{
176 struct usb_device *udev;
177
178 udev = to_usb_device(dev);
179 return sprintf(buf, "0x%x\n", udev->quirks);
180}
181static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
182
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700183static ssize_t
184show_urbnum(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, "%d\n", atomic_read(&udev->urbnum));
190}
191static DEVICE_ATTR(urbnum, S_IRUGO, show_urbnum, NULL);
192
Alan Sternb41a60e2007-05-30 15:39:33 -0400193
Alan Sternfeccc302008-03-03 15:15:59 -0500194#ifdef CONFIG_PM
Alan Sternb41a60e2007-05-30 15:39:33 -0400195
Alan Sternfeccc302008-03-03 15:15:59 -0500196static const char power_group[] = "power";
Alan Sternb41a60e2007-05-30 15:39:33 -0400197
198static ssize_t
199show_persist(struct device *dev, struct device_attribute *attr, char *buf)
200{
201 struct usb_device *udev = to_usb_device(dev);
202
203 return sprintf(buf, "%d\n", udev->persist_enabled);
204}
205
206static ssize_t
207set_persist(struct device *dev, struct device_attribute *attr,
208 const char *buf, size_t count)
209{
210 struct usb_device *udev = to_usb_device(dev);
211 int value;
212
213 /* Hubs are always enabled for USB_PERSIST */
214 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
215 return -EPERM;
216
217 if (sscanf(buf, "%d", &value) != 1)
218 return -EINVAL;
219 usb_pm_lock(udev);
220 udev->persist_enabled = !!value;
221 usb_pm_unlock(udev);
222 return count;
223}
224
225static DEVICE_ATTR(persist, S_IRUGO | S_IWUSR, show_persist, set_persist);
226
227static int add_persist_attributes(struct device *dev)
228{
229 int rc = 0;
230
231 if (is_usb_device(dev)) {
232 struct usb_device *udev = to_usb_device(dev);
233
Alan Sternfeccc302008-03-03 15:15:59 -0500234 /* Hubs are automatically enabled for USB_PERSIST,
235 * no point in creating the attribute file.
236 */
237 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
238 rc = sysfs_add_file_to_group(&dev->kobj,
239 &dev_attr_persist.attr,
240 power_group);
Alan Sternb41a60e2007-05-30 15:39:33 -0400241 }
242 return rc;
243}
244
245static void remove_persist_attributes(struct device *dev)
246{
247 sysfs_remove_file_from_group(&dev->kobj,
248 &dev_attr_persist.attr,
249 power_group);
250}
Alan Sternb41a60e2007-05-30 15:39:33 -0400251#else
252
253#define add_persist_attributes(dev) 0
254#define remove_persist_attributes(dev) do {} while (0)
255
Alan Sternfeccc302008-03-03 15:15:59 -0500256#endif /* CONFIG_PM */
Alan Sternb41a60e2007-05-30 15:39:33 -0400257
Alan Stern19c26232007-02-20 15:03:32 -0500258#ifdef CONFIG_USB_SUSPEND
259
260static ssize_t
Sarah Sharp15123002007-12-21 16:54:15 -0800261show_connected_duration(struct device *dev, struct device_attribute *attr,
262 char *buf)
263{
264 struct usb_device *udev = to_usb_device(dev);
265
266 return sprintf(buf, "%u\n",
267 jiffies_to_msecs(jiffies - udev->connect_time));
268}
269
270static DEVICE_ATTR(connected_duration, S_IRUGO, show_connected_duration, NULL);
271
272/*
273 * If the device is resumed, the last time the device was suspended has
274 * been pre-subtracted from active_duration. We add the current time to
275 * get the duration that the device was actually active.
276 *
277 * If the device is suspended, the active_duration is up-to-date.
278 */
279static ssize_t
280show_active_duration(struct device *dev, struct device_attribute *attr,
281 char *buf)
282{
283 struct usb_device *udev = to_usb_device(dev);
284 int duration;
285
286 if (udev->state != USB_STATE_SUSPENDED)
287 duration = jiffies_to_msecs(jiffies + udev->active_duration);
288 else
289 duration = jiffies_to_msecs(udev->active_duration);
290 return sprintf(buf, "%u\n", duration);
291}
292
293static DEVICE_ATTR(active_duration, S_IRUGO, show_active_duration, NULL);
294
295static ssize_t
Alan Stern19c26232007-02-20 15:03:32 -0500296show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
297{
298 struct usb_device *udev = to_usb_device(dev);
299
Alan Sterneaafbc32007-03-13 16:39:15 -0400300 return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
Alan Stern19c26232007-02-20 15:03:32 -0500301}
302
303static ssize_t
304set_autosuspend(struct device *dev, struct device_attribute *attr,
305 const char *buf, size_t count)
306{
307 struct usb_device *udev = to_usb_device(dev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400308 int value;
Alan Stern19c26232007-02-20 15:03:32 -0500309
Alan Sterneaafbc32007-03-13 16:39:15 -0400310 if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
311 value <= - INT_MAX/HZ)
Alan Stern19c26232007-02-20 15:03:32 -0500312 return -EINVAL;
313 value *= HZ;
314
Alan Stern19c26232007-02-20 15:03:32 -0500315 udev->autosuspend_delay = value;
Alan Sterneaafbc32007-03-13 16:39:15 -0400316 if (value >= 0)
Alan Stern19c26232007-02-20 15:03:32 -0500317 usb_try_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400318 else {
Alan Stern2add5222007-03-20 14:59:39 -0400319 if (usb_autoresume_device(udev) == 0)
320 usb_autosuspend_device(udev);
Alan Sterneaafbc32007-03-13 16:39:15 -0400321 }
Alan Stern19c26232007-02-20 15:03:32 -0500322 return count;
323}
324
325static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
326 show_autosuspend, set_autosuspend);
327
Alan Stern2add5222007-03-20 14:59:39 -0400328static const char on_string[] = "on";
329static const char auto_string[] = "auto";
Alan Stern2add5222007-03-20 14:59:39 -0400330
331static ssize_t
332show_level(struct device *dev, struct device_attribute *attr, char *buf)
333{
334 struct usb_device *udev = to_usb_device(dev);
335 const char *p = auto_string;
336
Alan Stern8e4ceb32009-12-07 13:01:37 -0500337 if (udev->state != USB_STATE_SUSPENDED && udev->autosuspend_disabled)
338 p = on_string;
Alan Stern2add5222007-03-20 14:59:39 -0400339 return sprintf(buf, "%s\n", p);
340}
341
342static ssize_t
343set_level(struct device *dev, struct device_attribute *attr,
344 const char *buf, size_t count)
345{
346 struct usb_device *udev = to_usb_device(dev);
347 int len = count;
348 char *cp;
349 int rc = 0;
Alan Stern8e4ceb32009-12-07 13:01:37 -0500350 int old_autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400351
352 cp = memchr(buf, '\n', count);
353 if (cp)
354 len = cp - buf;
355
356 usb_lock_device(udev);
Alan Sterndd865572007-05-22 11:38:19 -0400357 old_autosuspend_disabled = udev->autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400358
359 /* Setting the flags without calling usb_pm_lock is a subject to
360 * races, but who cares...
361 */
362 if (len == sizeof on_string - 1 &&
363 strncmp(buf, on_string, len) == 0) {
364 udev->autosuspend_disabled = 1;
Alan Stern65bfd292008-11-25 16:39:18 -0500365 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400366
367 } else if (len == sizeof auto_string - 1 &&
368 strncmp(buf, auto_string, len) == 0) {
369 udev->autosuspend_disabled = 0;
Alan Stern65bfd292008-11-25 16:39:18 -0500370 rc = usb_external_resume_device(udev, PMSG_USER_RESUME);
Alan Stern2add5222007-03-20 14:59:39 -0400371
Alan Stern2add5222007-03-20 14:59:39 -0400372 } else
373 rc = -EINVAL;
374
Alan Stern8e4ceb32009-12-07 13:01:37 -0500375 if (rc)
Alan Sterndd865572007-05-22 11:38:19 -0400376 udev->autosuspend_disabled = old_autosuspend_disabled;
Alan Stern2add5222007-03-20 14:59:39 -0400377 usb_unlock_device(udev);
378 return (rc < 0 ? rc : count);
379}
380
381static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
382
Alan Stern19c26232007-02-20 15:03:32 -0500383static int add_power_attributes(struct device *dev)
384{
385 int rc = 0;
386
Alan Stern2add5222007-03-20 14:59:39 -0400387 if (is_usb_device(dev)) {
Alan Stern19c26232007-02-20 15:03:32 -0500388 rc = sysfs_add_file_to_group(&dev->kobj,
389 &dev_attr_autosuspend.attr,
390 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400391 if (rc == 0)
392 rc = sysfs_add_file_to_group(&dev->kobj,
393 &dev_attr_level.attr,
394 power_group);
Sarah Sharp15123002007-12-21 16:54:15 -0800395 if (rc == 0)
396 rc = sysfs_add_file_to_group(&dev->kobj,
397 &dev_attr_connected_duration.attr,
398 power_group);
399 if (rc == 0)
400 rc = sysfs_add_file_to_group(&dev->kobj,
401 &dev_attr_active_duration.attr,
402 power_group);
Alan Stern2add5222007-03-20 14:59:39 -0400403 }
Alan Stern19c26232007-02-20 15:03:32 -0500404 return rc;
405}
406
407static void remove_power_attributes(struct device *dev)
408{
409 sysfs_remove_file_from_group(&dev->kobj,
Sarah Sharp15123002007-12-21 16:54:15 -0800410 &dev_attr_active_duration.attr,
411 power_group);
412 sysfs_remove_file_from_group(&dev->kobj,
413 &dev_attr_connected_duration.attr,
414 power_group);
415 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern2add5222007-03-20 14:59:39 -0400416 &dev_attr_level.attr,
417 power_group);
418 sysfs_remove_file_from_group(&dev->kobj,
Alan Stern19c26232007-02-20 15:03:32 -0500419 &dev_attr_autosuspend.attr,
420 power_group);
421}
422
423#else
424
425#define add_power_attributes(dev) 0
426#define remove_power_attributes(dev) do {} while (0)
427
428#endif /* CONFIG_USB_SUSPEND */
429
Alan Sternb41a60e2007-05-30 15:39:33 -0400430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431/* Descriptor fields */
432#define usb_descriptor_attr_le16(field, format_string) \
433static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500434show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400435 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436{ \
437 struct usb_device *udev; \
438 \
Oliver Neukum92516442007-01-23 15:55:28 -0500439 udev = to_usb_device(dev); \
440 return sprintf(buf, format_string, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 le16_to_cpu(udev->descriptor.field)); \
442} \
443static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
444
445usb_descriptor_attr_le16(idVendor, "%04x\n")
446usb_descriptor_attr_le16(idProduct, "%04x\n")
447usb_descriptor_attr_le16(bcdDevice, "%04x\n")
448
449#define usb_descriptor_attr(field, format_string) \
450static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500451show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400452 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{ \
454 struct usb_device *udev; \
455 \
Oliver Neukum92516442007-01-23 15:55:28 -0500456 udev = to_usb_device(dev); \
457 return sprintf(buf, format_string, udev->descriptor.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458} \
459static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
460
Oliver Neukum92516442007-01-23 15:55:28 -0500461usb_descriptor_attr(bDeviceClass, "%02x\n")
462usb_descriptor_attr(bDeviceSubClass, "%02x\n")
463usb_descriptor_attr(bDeviceProtocol, "%02x\n")
464usb_descriptor_attr(bNumConfigurations, "%d\n")
465usb_descriptor_attr(bMaxPacketSize0, "%d\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700467
468
469/* show if the device is authorized (1) or not (0) */
470static ssize_t usb_dev_authorized_show(struct device *dev,
471 struct device_attribute *attr,
472 char *buf)
473{
474 struct usb_device *usb_dev = to_usb_device(dev);
475 return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
476}
477
478
479/*
480 * Authorize a device to be used in the system
481 *
482 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
483 */
484static ssize_t usb_dev_authorized_store(struct device *dev,
485 struct device_attribute *attr,
486 const char *buf, size_t size)
487{
488 ssize_t result;
489 struct usb_device *usb_dev = to_usb_device(dev);
490 unsigned val;
491 result = sscanf(buf, "%u\n", &val);
492 if (result != 1)
493 result = -EINVAL;
494 else if (val == 0)
495 result = usb_deauthorize_device(usb_dev);
496 else
497 result = usb_authorize_device(usb_dev);
498 return result < 0? result : size;
499}
500
501static DEVICE_ATTR(authorized, 0644,
502 usb_dev_authorized_show, usb_dev_authorized_store);
503
Alan Stern253e0572009-10-27 15:20:13 -0400504/* "Safely remove a device" */
505static ssize_t usb_remove_store(struct device *dev,
506 struct device_attribute *attr,
507 const char *buf, size_t count)
508{
509 struct usb_device *udev = to_usb_device(dev);
510 int rc = 0;
511
512 usb_lock_device(udev);
513 if (udev->state != USB_STATE_NOTATTACHED) {
514
515 /* To avoid races, first unconfigure and then remove */
516 usb_set_configuration(udev, -1);
517 rc = usb_remove_device(udev);
518 }
519 if (rc == 0)
520 rc = count;
521 usb_unlock_device(udev);
522 return rc;
523}
524static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
525
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527static struct attribute *dev_attrs[] = {
528 /* current configuration's attributes */
Alan Sternb6eb2d82006-07-06 15:37:42 -0400529 &dev_attr_configuration.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 &dev_attr_bNumInterfaces.attr,
531 &dev_attr_bConfigurationValue.attr,
532 &dev_attr_bmAttributes.attr,
533 &dev_attr_bMaxPower.attr,
534 /* device attributes */
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800535 &dev_attr_urbnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 &dev_attr_idVendor.attr,
537 &dev_attr_idProduct.attr,
538 &dev_attr_bcdDevice.attr,
539 &dev_attr_bDeviceClass.attr,
540 &dev_attr_bDeviceSubClass.attr,
541 &dev_attr_bDeviceProtocol.attr,
542 &dev_attr_bNumConfigurations.attr,
Greg Kroah-Hartmancf5910b2005-06-29 16:53:29 -0700543 &dev_attr_bMaxPacketSize0.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 &dev_attr_speed.attr,
Alan Stern83f7d952007-04-25 15:15:43 -0400545 &dev_attr_busnum.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 &dev_attr_devnum.attr,
Greg Kroah-Hartman9af23622009-11-30 11:15:02 -0800547 &dev_attr_devpath.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 &dev_attr_version.attr,
549 &dev_attr_maxchild.attr,
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100550 &dev_attr_quirks.attr,
Inaky Perez-Gonzaleze03f2e82007-07-31 20:34:07 -0700551 &dev_attr_authorized.attr,
Alan Stern253e0572009-10-27 15:20:13 -0400552 &dev_attr_remove.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 NULL,
554};
555static struct attribute_group dev_attr_grp = {
556 .attrs = dev_attrs,
557};
558
Alan Stern2e5f10e2008-04-30 15:37:19 -0400559/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
560 * accordingly.
561 */
562static struct attribute *dev_string_attrs[] = {
563 &dev_attr_manufacturer.attr,
564 &dev_attr_product.attr,
565 &dev_attr_serial.attr,
566 NULL
567};
568
569static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
570 struct attribute *a, int n)
571{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400572 struct device *dev = container_of(kobj, struct device, kobj);
573 struct usb_device *udev = to_usb_device(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400574
575 if (a == &dev_attr_manufacturer.attr) {
576 if (udev->manufacturer == NULL)
577 return 0;
578 } else if (a == &dev_attr_product.attr) {
579 if (udev->product == NULL)
580 return 0;
581 } else if (a == &dev_attr_serial.attr) {
582 if (udev->serial == NULL)
583 return 0;
584 }
585 return a->mode;
586}
587
588static struct attribute_group dev_string_attr_grp = {
589 .attrs = dev_string_attrs,
590 .is_visible = dev_string_attrs_are_visible,
591};
592
David Brownella4dbd672009-06-24 10:06:31 -0700593const struct attribute_group *usb_device_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400594 &dev_attr_grp,
595 &dev_string_attr_grp,
596 NULL
597};
598
Alan Stern69d42a72007-07-12 17:06:23 -0400599/* Binary descriptors */
600
601static ssize_t
602read_descriptors(struct kobject *kobj, struct bin_attribute *attr,
603 char *buf, loff_t off, size_t count)
604{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400605 struct device *dev = container_of(kobj, struct device, kobj);
606 struct usb_device *udev = to_usb_device(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400607 size_t nleft = count;
608 size_t srclen, n;
Alan Stern217a9082008-05-20 16:40:42 -0400609 int cfgno;
610 void *src;
Alan Stern69d42a72007-07-12 17:06:23 -0400611
Alan Stern217a9082008-05-20 16:40:42 -0400612 /* The binary attribute begins with the device descriptor.
613 * Following that are the raw descriptor entries for all the
614 * configurations (config plus subsidiary descriptors).
Alan Stern69d42a72007-07-12 17:06:23 -0400615 */
Alan Stern217a9082008-05-20 16:40:42 -0400616 for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
617 nleft > 0; ++cfgno) {
618 if (cfgno < 0) {
619 src = &udev->descriptor;
620 srclen = sizeof(struct usb_device_descriptor);
621 } else {
622 src = udev->rawdescriptors[cfgno];
623 srclen = __le16_to_cpu(udev->config[cfgno].desc.
624 wTotalLength);
625 }
Alan Stern69d42a72007-07-12 17:06:23 -0400626 if (off < srclen) {
Alan Stern217a9082008-05-20 16:40:42 -0400627 n = min(nleft, srclen - (size_t) off);
628 memcpy(buf, src + off, n);
Alan Stern69d42a72007-07-12 17:06:23 -0400629 nleft -= n;
Alan Stern217a9082008-05-20 16:40:42 -0400630 buf += n;
631 off = 0;
632 } else {
633 off -= srclen;
Alan Stern69d42a72007-07-12 17:06:23 -0400634 }
635 }
Alan Stern69d42a72007-07-12 17:06:23 -0400636 return count - nleft;
637}
638
639static struct bin_attribute dev_bin_attr_descriptors = {
640 .attr = {.name = "descriptors", .mode = 0444},
641 .read = read_descriptors,
642 .size = 18 + 65535, /* dev descr + max-size raw descriptor */
643};
644
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700645int usb_create_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
647 struct device *dev = &udev->dev;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700648 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Alan Stern69d42a72007-07-12 17:06:23 -0400650 retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
651 if (retval)
652 goto error;
653
Alan Sternb41a60e2007-05-30 15:39:33 -0400654 retval = add_persist_attributes(dev);
655 if (retval)
656 goto error;
657
Alan Stern19c26232007-02-20 15:03:32 -0500658 retval = add_power_attributes(dev);
659 if (retval)
660 goto error;
Alan Stern3b23dd62008-12-05 14:10:34 -0500661 return retval;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700662error:
Alan Sternaa084f32007-02-20 14:59:59 -0500663 usb_remove_sysfs_dev_files(udev);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700664 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666
Oliver Neukum92516442007-01-23 15:55:28 -0500667void usb_remove_sysfs_dev_files(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
669 struct device *dev = &udev->dev;
670
Alan Stern19c26232007-02-20 15:03:32 -0500671 remove_power_attributes(dev);
Alan Sternb41a60e2007-05-30 15:39:33 -0400672 remove_persist_attributes(dev);
Alan Stern69d42a72007-07-12 17:06:23 -0400673 device_remove_bin_file(dev, &dev_bin_attr_descriptors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674}
675
Craig W. Nadler165fe972007-06-15 23:14:35 -0400676/* Interface Accociation Descriptor fields */
677#define usb_intf_assoc_attr(field, format_string) \
678static ssize_t \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800679show_iad_##field(struct device *dev, struct device_attribute *attr, \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400680 char *buf) \
681{ \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800682 struct usb_interface *intf = to_usb_interface(dev); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400683 \
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800684 return sprintf(buf, format_string, \
685 intf->intf_assoc->field); \
Craig W. Nadler165fe972007-06-15 23:14:35 -0400686} \
687static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
688
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800689usb_intf_assoc_attr(bFirstInterface, "%02x\n")
690usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
691usb_intf_assoc_attr(bFunctionClass, "%02x\n")
692usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
693usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
Craig W. Nadler165fe972007-06-15 23:14:35 -0400694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695/* Interface fields */
696#define usb_intf_attr(field, format_string) \
697static ssize_t \
Oliver Neukum92516442007-01-23 15:55:28 -0500698show_##field(struct device *dev, struct device_attribute *attr, \
Alan Sternb724ae72005-10-24 15:36:00 -0400699 char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{ \
Oliver Neukum92516442007-01-23 15:55:28 -0500701 struct usb_interface *intf = to_usb_interface(dev); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 \
Oliver Neukum92516442007-01-23 15:55:28 -0500703 return sprintf(buf, format_string, \
Alan Sternb724ae72005-10-24 15:36:00 -0400704 intf->cur_altsetting->desc.field); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705} \
706static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
707
Oliver Neukum92516442007-01-23 15:55:28 -0500708usb_intf_attr(bInterfaceNumber, "%02x\n")
709usb_intf_attr(bAlternateSetting, "%2d\n")
710usb_intf_attr(bNumEndpoints, "%02x\n")
711usb_intf_attr(bInterfaceClass, "%02x\n")
712usb_intf_attr(bInterfaceSubClass, "%02x\n")
713usb_intf_attr(bInterfaceProtocol, "%02x\n")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Alan Sternb724ae72005-10-24 15:36:00 -0400715static ssize_t show_interface_string(struct device *dev,
716 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
718 struct usb_interface *intf;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400719 char *string;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Oliver Neukum92516442007-01-23 15:55:28 -0500721 intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400722 string = intf->cur_altsetting->string;
723 barrier(); /* The altsetting might change! */
724
725 if (!string)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 return 0;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400727 return sprintf(buf, "%s\n", string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
730
Alan Sternb724ae72005-10-24 15:36:00 -0400731static ssize_t show_modalias(struct device *dev,
732 struct device_attribute *attr, char *buf)
Greg KH360b52b2005-05-10 06:45:10 -0700733{
734 struct usb_interface *intf;
735 struct usb_device *udev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700736 struct usb_host_interface *alt;
Greg KH360b52b2005-05-10 06:45:10 -0700737
738 intf = to_usb_interface(dev);
739 udev = interface_to_usbdev(intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700740 alt = intf->cur_altsetting;
Greg KH360b52b2005-05-10 06:45:10 -0700741
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700742 return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
743 "ic%02Xisc%02Xip%02X\n",
744 le16_to_cpu(udev->descriptor.idVendor),
745 le16_to_cpu(udev->descriptor.idProduct),
746 le16_to_cpu(udev->descriptor.bcdDevice),
747 udev->descriptor.bDeviceClass,
748 udev->descriptor.bDeviceSubClass,
749 udev->descriptor.bDeviceProtocol,
750 alt->desc.bInterfaceClass,
751 alt->desc.bInterfaceSubClass,
752 alt->desc.bInterfaceProtocol);
Greg KH360b52b2005-05-10 06:45:10 -0700753}
754static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
755
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700756static ssize_t show_supports_autosuspend(struct device *dev,
757 struct device_attribute *attr, char *buf)
758{
759 struct usb_interface *intf;
760 struct usb_device *udev;
761 int ret;
762
763 intf = to_usb_interface(dev);
764 udev = interface_to_usbdev(intf);
765
766 usb_lock_device(udev);
767 /* Devices will be autosuspended even when an interface isn't claimed */
768 if (!intf->dev.driver ||
769 to_usb_driver(intf->dev.driver)->supports_autosuspend)
770 ret = sprintf(buf, "%u\n", 1);
771 else
772 ret = sprintf(buf, "%u\n", 0);
773 usb_unlock_device(udev);
774
775 return ret;
776}
777static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779static struct attribute *intf_attrs[] = {
780 &dev_attr_bInterfaceNumber.attr,
781 &dev_attr_bAlternateSetting.attr,
782 &dev_attr_bNumEndpoints.attr,
783 &dev_attr_bInterfaceClass.attr,
784 &dev_attr_bInterfaceSubClass.attr,
785 &dev_attr_bInterfaceProtocol.attr,
Greg KH360b52b2005-05-10 06:45:10 -0700786 &dev_attr_modalias.attr,
Sarah Sharp49e7cc82008-10-06 14:45:46 -0700787 &dev_attr_supports_autosuspend.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 NULL,
789};
790static struct attribute_group intf_attr_grp = {
791 .attrs = intf_attrs,
792};
793
Alan Stern2e5f10e2008-04-30 15:37:19 -0400794static struct attribute *intf_assoc_attrs[] = {
795 &dev_attr_iad_bFirstInterface.attr,
796 &dev_attr_iad_bInterfaceCount.attr,
797 &dev_attr_iad_bFunctionClass.attr,
798 &dev_attr_iad_bFunctionSubClass.attr,
799 &dev_attr_iad_bFunctionProtocol.attr,
800 NULL,
801};
802
803static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
804 struct attribute *a, int n)
805{
H Hartley Sweetena864e3aa52009-04-15 21:34:40 -0400806 struct device *dev = container_of(kobj, struct device, kobj);
807 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern2e5f10e2008-04-30 15:37:19 -0400808
809 if (intf->intf_assoc == NULL)
810 return 0;
811 return a->mode;
812}
813
814static struct attribute_group intf_assoc_attr_grp = {
815 .attrs = intf_assoc_attrs,
816 .is_visible = intf_assoc_attrs_are_visible,
817};
818
David Brownella4dbd672009-06-24 10:06:31 -0700819const struct attribute_group *usb_interface_groups[] = {
Alan Stern2e5f10e2008-04-30 15:37:19 -0400820 &intf_attr_grp,
821 &intf_assoc_attr_grp,
822 NULL
823};
824
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700825int usb_create_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Alan Stern4f62efe2005-10-24 16:24:14 -0400827 struct usb_device *udev = interface_to_usbdev(intf);
828 struct usb_host_interface *alt = intf->cur_altsetting;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700829 int retval;
Alan Stern4f62efe2005-10-24 16:24:14 -0400830
Alan Stern352d0262008-10-29 15:16:58 -0400831 if (intf->sysfs_files_created || intf->unregistering)
Alan Stern7e615592007-11-06 11:43:42 -0500832 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Alan Stern1662e3a2009-03-18 14:28:53 -0400834 if (alt->string == NULL &&
835 !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern4f62efe2005-10-24 16:24:14 -0400836 alt->string = usb_cache_string(udev, alt->desc.iInterface);
837 if (alt->string)
Alan Stern2e5f10e2008-04-30 15:37:19 -0400838 retval = device_create_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500839 intf->sysfs_files_created = 1;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700840 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
Oliver Neukum92516442007-01-23 15:55:28 -0500843void usb_remove_sysfs_intf_files(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844{
Alan Stern7e615592007-11-06 11:43:42 -0500845 if (!intf->sysfs_files_created)
846 return;
Alan Stern92b0da12008-10-29 15:18:50 -0400847
Alan Stern92b0da12008-10-29 15:18:50 -0400848 device_remove_file(&intf->dev, &dev_attr_interface);
Alan Stern7e615592007-11-06 11:43:42 -0500849 intf->sysfs_files_created = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}