Linux Audio

Check our new training course

Loading...
v3.1
  1/*
  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
 13#include <linux/kernel.h>
 14#include <linux/string.h>
 15#include <linux/usb.h>
 16#include <linux/usb/quirks.h>
 17#include "usb.h"
 18
 19/* Active configuration fields */
 20#define usb_actconfig_show(field, multiplier, format_string)		\
 21static ssize_t  show_##field(struct device *dev,			\
 22		struct device_attribute *attr, char *buf)		\
 23{									\
 24	struct usb_device *udev;					\
 25	struct usb_host_config *actconfig;				\
 
 26									\
 27	udev = to_usb_device(dev);					\
 
 28	actconfig = udev->actconfig;					\
 29	if (actconfig)							\
 30		return sprintf(buf, format_string,			\
 31				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
 40usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
 41usb_actconfig_attr(bmAttributes, 1, "%2x\n")
 42usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
 43
 44static ssize_t show_configuration_string(struct device *dev,
 
 
 
 45		struct device_attribute *attr, char *buf)
 46{
 47	struct usb_device *udev;
 48	struct usb_host_config *actconfig;
 
 49
 50	udev = to_usb_device(dev);
 
 51	actconfig = udev->actconfig;
 52	if ((!actconfig) || (!actconfig->string))
 53		return 0;
 54	return sprintf(buf, "%s\n", actconfig->string);
 
 55}
 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
 62set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
 63		const char *buf, size_t count)
 64{
 65	struct usb_device	*udev = to_usb_device(dev);
 66	int			config, value;
 67
 68	if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
 69		return -EINVAL;
 70	usb_lock_device(udev);
 71	value = usb_set_configuration(udev, config);
 72	usb_unlock_device(udev);
 73	return (value < 0) ? value : count;
 74}
 75
 76static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
 77		show_bConfigurationValue, set_bConfigurationValue);
 78
 79/* String fields */
 80#define usb_string_attr(name)						\
 81static ssize_t  show_##name(struct device *dev,				\
 82		struct device_attribute *attr, char *buf)		\
 83{									\
 84	struct usb_device *udev;					\
 85	int retval;							\
 86									\
 87	udev = to_usb_device(dev);					\
 88	usb_lock_device(udev);						\
 89	retval = sprintf(buf, "%s\n", udev->name);			\
 90	usb_unlock_device(udev);					\
 91	return retval;							\
 92}									\
 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
100show_speed(struct device *dev, struct device_attribute *attr, char *buf)
101{
102	struct usb_device *udev;
103	char *speed;
104
105	udev = to_usb_device(dev);
106
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;
118	case USB_SPEED_WIRELESS:
119		speed = "480";
120		break;
121	case USB_SPEED_SUPER:
122		speed = "5000";
123		break;
124	default:
125		speed = "unknown";
126	}
127	return sprintf(buf, "%s\n", speed);
128}
129static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
130
131static ssize_t
132show_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
142show_devnum(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, "%d\n", udev->devnum);
148}
149static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
150
151static ssize_t
152show_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
162show_version(struct device *dev, struct device_attribute *attr, char *buf)
163{
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
174show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
175{
176	struct usb_device *udev;
177
178	udev = to_usb_device(dev);
179	return sprintf(buf, "%d\n", udev->maxchild);
180}
181static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
182
183static 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
193static ssize_t
194show_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
224show_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
 
 
 
 
 
 
 
 
233
234#ifdef	CONFIG_PM
235
236static 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;
257
258	usb_lock_device(udev);
259	udev->persist_enabled = !!value;
260	usb_unlock_device(udev);
261	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
273		/* 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,
279					power_group_name);
280	}
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,
288			power_group_name);
289}
290#else
291
292#define add_persist_attributes(dev)	0
293#define remove_persist_attributes(dev)	do {} while (0)
294
295#endif	/* CONFIG_PM */
296
297#ifdef	CONFIG_USB_SUSPEND
298
299static ssize_t
300show_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
335show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
336{
337	return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
338}
339
340static ssize_t
341set_autosuspend(struct device *dev, struct device_attribute *attr,
342		const char *buf, size_t count)
343{
344	int value;
345
346	if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
347			value <= -INT_MAX/1000)
348		return -EINVAL;
349
350	pm_runtime_set_autosuspend_delay(dev, value * 1000);
351	return count;
352}
353
354static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
355		show_autosuspend, set_autosuspend);
356
357static const char on_string[] = "on";
358static const char auto_string[] = "auto";
359
360static 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
370static 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
376	warn_level();
377	if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
378		p = on_string;
379	return sprintf(buf, "%s\n", p);
380}
381
382static ssize_t
383set_level(struct device *dev, struct device_attribute *attr,
384		const char *buf, size_t count)
385{
386	struct usb_device *udev = to_usb_device(dev);
387	int len = count;
388	char *cp;
389	int rc = count;
390
391	warn_level();
392	cp = memchr(buf, '\n', count);
393	if (cp)
394		len = cp - buf;
395
396	usb_lock_device(udev);
397
398	if (len == sizeof on_string - 1 &&
399			strncmp(buf, on_string, len) == 0)
400		usb_disable_autosuspend(udev);
401
402	else if (len == sizeof auto_string - 1 &&
403			strncmp(buf, auto_string, len) == 0)
404		usb_enable_autosuspend(udev);
405
406	else
407		rc = -EINVAL;
408
409	usb_unlock_device(udev);
410	return rc;
411}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
412
413static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
 
 
 
 
 
 
 
 
 
414
415static struct attribute *power_attrs[] = {
416	&dev_attr_autosuspend.attr,
417	&dev_attr_level.attr,
418	&dev_attr_connected_duration.attr,
419	&dev_attr_active_duration.attr,
420	NULL,
421};
422static struct attribute_group power_attr_group = {
423	.name	= power_group_name,
424	.attrs	= power_attrs,
425};
426
427static int add_power_attributes(struct device *dev)
428{
429	int rc = 0;
430
431	if (is_usb_device(dev))
 
432		rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
 
 
 
 
 
433	return rc;
434}
435
436static void remove_power_attributes(struct device *dev)
437{
 
438	sysfs_unmerge_group(&dev->kobj, &power_attr_group);
439}
440
441#else
442
443#define add_power_attributes(dev)	0
444#define remove_power_attributes(dev)	do {} while (0)
445
446#endif	/* CONFIG_USB_SUSPEND */
447
448
449/* Descriptor fields */
450#define usb_descriptor_attr_le16(field, format_string)			\
451static ssize_t								\
452show_##field(struct device *dev, struct device_attribute *attr,	\
453		char *buf)						\
454{									\
455	struct usb_device *udev;					\
456									\
457	udev = to_usb_device(dev);					\
458	return sprintf(buf, format_string, 				\
459			le16_to_cpu(udev->descriptor.field));		\
460}									\
461static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
462
463usb_descriptor_attr_le16(idVendor, "%04x\n")
464usb_descriptor_attr_le16(idProduct, "%04x\n")
465usb_descriptor_attr_le16(bcdDevice, "%04x\n")
466
467#define usb_descriptor_attr(field, format_string)			\
468static ssize_t								\
469show_##field(struct device *dev, struct device_attribute *attr,	\
470		char *buf)						\
471{									\
472	struct usb_device *udev;					\
473									\
474	udev = to_usb_device(dev);					\
475	return sprintf(buf, format_string, udev->descriptor.field);	\
476}									\
477static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
478
479usb_descriptor_attr(bDeviceClass, "%02x\n")
480usb_descriptor_attr(bDeviceSubClass, "%02x\n")
481usb_descriptor_attr(bDeviceProtocol, "%02x\n")
482usb_descriptor_attr(bNumConfigurations, "%d\n")
483usb_descriptor_attr(bMaxPacketSize0, "%d\n")
484
 
 
 
 
 
485
486
487/* show if the device is authorized (1) or not (0) */
488static ssize_t usb_dev_authorized_show(struct device *dev,
489				       struct device_attribute *attr,
490				       char *buf)
491{
492	struct usb_device *usb_dev = to_usb_device(dev);
493	return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
494}
495
496
497/*
498 * Authorize a device to be used in the system
499 *
500 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
501 */
502static ssize_t usb_dev_authorized_store(struct device *dev,
503					struct device_attribute *attr,
504					const char *buf, size_t size)
505{
506	ssize_t result;
507	struct usb_device *usb_dev = to_usb_device(dev);
508	unsigned val;
509	result = sscanf(buf, "%u\n", &val);
510	if (result != 1)
511		result = -EINVAL;
512	else if (val == 0)
513		result = usb_deauthorize_device(usb_dev);
514	else
515		result = usb_authorize_device(usb_dev);
516	return result < 0? result : size;
517}
518
519static DEVICE_ATTR(authorized, 0644,
520	    usb_dev_authorized_show, usb_dev_authorized_store);
521
522/* "Safely remove a device" */
523static ssize_t usb_remove_store(struct device *dev,
524		struct device_attribute *attr,
525		const char *buf, size_t count)
526{
527	struct usb_device *udev = to_usb_device(dev);
528	int rc = 0;
529
530	usb_lock_device(udev);
531	if (udev->state != USB_STATE_NOTATTACHED) {
532
533		/* To avoid races, first unconfigure and then remove */
534		usb_set_configuration(udev, -1);
535		rc = usb_remove_device(udev);
536	}
537	if (rc == 0)
538		rc = count;
539	usb_unlock_device(udev);
540	return rc;
541}
542static DEVICE_ATTR(remove, 0200, NULL, usb_remove_store);
543
544
545static struct attribute *dev_attrs[] = {
546	/* current configuration's attributes */
547	&dev_attr_configuration.attr,
548	&dev_attr_bNumInterfaces.attr,
549	&dev_attr_bConfigurationValue.attr,
550	&dev_attr_bmAttributes.attr,
551	&dev_attr_bMaxPower.attr,
552	/* device attributes */
553	&dev_attr_urbnum.attr,
554	&dev_attr_idVendor.attr,
555	&dev_attr_idProduct.attr,
556	&dev_attr_bcdDevice.attr,
557	&dev_attr_bDeviceClass.attr,
558	&dev_attr_bDeviceSubClass.attr,
559	&dev_attr_bDeviceProtocol.attr,
560	&dev_attr_bNumConfigurations.attr,
561	&dev_attr_bMaxPacketSize0.attr,
562	&dev_attr_speed.attr,
563	&dev_attr_busnum.attr,
564	&dev_attr_devnum.attr,
565	&dev_attr_devpath.attr,
566	&dev_attr_version.attr,
567	&dev_attr_maxchild.attr,
568	&dev_attr_quirks.attr,
569	&dev_attr_avoid_reset_quirk.attr,
570	&dev_attr_authorized.attr,
571	&dev_attr_remove.attr,
 
 
572	NULL,
573};
574static struct attribute_group dev_attr_grp = {
575	.attrs = dev_attrs,
576};
577
578/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
579 * accordingly.
580 */
581static struct attribute *dev_string_attrs[] = {
582	&dev_attr_manufacturer.attr,
583	&dev_attr_product.attr,
584	&dev_attr_serial.attr,
585	NULL
586};
587
588static mode_t dev_string_attrs_are_visible(struct kobject *kobj,
589		struct attribute *a, int n)
590{
591	struct device *dev = container_of(kobj, struct device, kobj);
592	struct usb_device *udev = to_usb_device(dev);
593
594	if (a == &dev_attr_manufacturer.attr) {
595		if (udev->manufacturer == NULL)
596			return 0;
597	} else if (a == &dev_attr_product.attr) {
598		if (udev->product == NULL)
599			return 0;
600	} else if (a == &dev_attr_serial.attr) {
601		if (udev->serial == NULL)
602			return 0;
603	}
604	return a->mode;
605}
606
607static struct attribute_group dev_string_attr_grp = {
608	.attrs =	dev_string_attrs,
609	.is_visible =	dev_string_attrs_are_visible,
610};
611
612const struct attribute_group *usb_device_groups[] = {
613	&dev_attr_grp,
614	&dev_string_attr_grp,
615	NULL
616};
617
618/* Binary descriptors */
619
620static ssize_t
621read_descriptors(struct file *filp, struct kobject *kobj,
622		struct bin_attribute *attr,
623		char *buf, loff_t off, size_t count)
624{
625	struct device *dev = container_of(kobj, struct device, kobj);
626	struct usb_device *udev = to_usb_device(dev);
627	size_t nleft = count;
628	size_t srclen, n;
629	int cfgno;
630	void *src;
631
632	/* The binary attribute begins with the device descriptor.
633	 * Following that are the raw descriptor entries for all the
634	 * configurations (config plus subsidiary descriptors).
635	 */
 
636	for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
637			nleft > 0; ++cfgno) {
638		if (cfgno < 0) {
639			src = &udev->descriptor;
640			srclen = sizeof(struct usb_device_descriptor);
641		} else {
642			src = udev->rawdescriptors[cfgno];
643			srclen = __le16_to_cpu(udev->config[cfgno].desc.
644					wTotalLength);
645		}
646		if (off < srclen) {
647			n = min(nleft, srclen - (size_t) off);
648			memcpy(buf, src + off, n);
649			nleft -= n;
650			buf += n;
651			off = 0;
652		} else {
653			off -= srclen;
654		}
655	}
 
656	return count - nleft;
657}
658
659static struct bin_attribute dev_bin_attr_descriptors = {
660	.attr = {.name = "descriptors", .mode = 0444},
661	.read = read_descriptors,
662	.size = 18 + 65535,	/* dev descr + max-size raw descriptor */
663};
664
665int usb_create_sysfs_dev_files(struct usb_device *udev)
666{
667	struct device *dev = &udev->dev;
668	int retval;
669
670	retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
671	if (retval)
672		goto error;
673
674	retval = add_persist_attributes(dev);
675	if (retval)
676		goto error;
677
678	retval = add_power_attributes(dev);
679	if (retval)
680		goto error;
681	return retval;
682error:
683	usb_remove_sysfs_dev_files(udev);
684	return retval;
685}
686
687void usb_remove_sysfs_dev_files(struct usb_device *udev)
688{
689	struct device *dev = &udev->dev;
690
691	remove_power_attributes(dev);
692	remove_persist_attributes(dev);
693	device_remove_bin_file(dev, &dev_bin_attr_descriptors);
694}
695
696/* Interface Accociation Descriptor fields */
697#define usb_intf_assoc_attr(field, format_string)			\
698static ssize_t								\
699show_iad_##field(struct device *dev, struct device_attribute *attr,	\
700		char *buf)						\
701{									\
702	struct usb_interface *intf = to_usb_interface(dev);		\
703									\
704	return sprintf(buf, format_string,				\
705			intf->intf_assoc->field); 			\
706}									\
707static DEVICE_ATTR(iad_##field, S_IRUGO, show_iad_##field, NULL);
708
709usb_intf_assoc_attr(bFirstInterface, "%02x\n")
710usb_intf_assoc_attr(bInterfaceCount, "%02d\n")
711usb_intf_assoc_attr(bFunctionClass, "%02x\n")
712usb_intf_assoc_attr(bFunctionSubClass, "%02x\n")
713usb_intf_assoc_attr(bFunctionProtocol, "%02x\n")
714
715/* Interface fields */
716#define usb_intf_attr(field, format_string)				\
717static ssize_t								\
718show_##field(struct device *dev, struct device_attribute *attr,	\
719		char *buf)						\
720{									\
721	struct usb_interface *intf = to_usb_interface(dev);		\
722									\
723	return sprintf(buf, format_string,				\
724			intf->cur_altsetting->desc.field); 		\
725}									\
726static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
727
728usb_intf_attr(bInterfaceNumber, "%02x\n")
729usb_intf_attr(bAlternateSetting, "%2d\n")
730usb_intf_attr(bNumEndpoints, "%02x\n")
731usb_intf_attr(bInterfaceClass, "%02x\n")
732usb_intf_attr(bInterfaceSubClass, "%02x\n")
733usb_intf_attr(bInterfaceProtocol, "%02x\n")
734
735static ssize_t show_interface_string(struct device *dev,
736		struct device_attribute *attr, char *buf)
737{
738	struct usb_interface *intf;
739	char *string;
740
741	intf = to_usb_interface(dev);
742	string = intf->cur_altsetting->string;
743	barrier();		/* The altsetting might change! */
744
745	if (!string)
746		return 0;
747	return sprintf(buf, "%s\n", string);
748}
749static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
750
751static ssize_t show_modalias(struct device *dev,
752		struct device_attribute *attr, char *buf)
753{
754	struct usb_interface *intf;
755	struct usb_device *udev;
756	struct usb_host_interface *alt;
757
758	intf = to_usb_interface(dev);
759	udev = interface_to_usbdev(intf);
760	alt = intf->cur_altsetting;
761
762	return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
763			"ic%02Xisc%02Xip%02X\n",
764			le16_to_cpu(udev->descriptor.idVendor),
765			le16_to_cpu(udev->descriptor.idProduct),
766			le16_to_cpu(udev->descriptor.bcdDevice),
767			udev->descriptor.bDeviceClass,
768			udev->descriptor.bDeviceSubClass,
769			udev->descriptor.bDeviceProtocol,
770			alt->desc.bInterfaceClass,
771			alt->desc.bInterfaceSubClass,
772			alt->desc.bInterfaceProtocol);
 
773}
774static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
775
776static ssize_t show_supports_autosuspend(struct device *dev,
777		struct device_attribute *attr, char *buf)
 
778{
779	struct usb_interface *intf;
780	struct usb_device *udev;
781	int ret;
782
783	intf = to_usb_interface(dev);
784	udev = interface_to_usbdev(intf);
785
786	usb_lock_device(udev);
787	/* Devices will be autosuspended even when an interface isn't claimed */
788	if (!intf->dev.driver ||
789			to_usb_driver(intf->dev.driver)->supports_autosuspend)
790		ret = sprintf(buf, "%u\n", 1);
791	else
792		ret = sprintf(buf, "%u\n", 0);
793	usb_unlock_device(udev);
794
795	return ret;
796}
797static DEVICE_ATTR(supports_autosuspend, S_IRUGO, show_supports_autosuspend, NULL);
798
799static struct attribute *intf_attrs[] = {
800	&dev_attr_bInterfaceNumber.attr,
801	&dev_attr_bAlternateSetting.attr,
802	&dev_attr_bNumEndpoints.attr,
803	&dev_attr_bInterfaceClass.attr,
804	&dev_attr_bInterfaceSubClass.attr,
805	&dev_attr_bInterfaceProtocol.attr,
806	&dev_attr_modalias.attr,
807	&dev_attr_supports_autosuspend.attr,
808	NULL,
809};
810static struct attribute_group intf_attr_grp = {
811	.attrs = intf_attrs,
812};
813
814static struct attribute *intf_assoc_attrs[] = {
815	&dev_attr_iad_bFirstInterface.attr,
816	&dev_attr_iad_bInterfaceCount.attr,
817	&dev_attr_iad_bFunctionClass.attr,
818	&dev_attr_iad_bFunctionSubClass.attr,
819	&dev_attr_iad_bFunctionProtocol.attr,
820	NULL,
821};
822
823static mode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
824		struct attribute *a, int n)
825{
826	struct device *dev = container_of(kobj, struct device, kobj);
827	struct usb_interface *intf = to_usb_interface(dev);
828
829	if (intf->intf_assoc == NULL)
830		return 0;
831	return a->mode;
832}
833
834static struct attribute_group intf_assoc_attr_grp = {
835	.attrs =	intf_assoc_attrs,
836	.is_visible =	intf_assoc_attrs_are_visible,
837};
838
839const struct attribute_group *usb_interface_groups[] = {
840	&intf_attr_grp,
841	&intf_assoc_attr_grp,
842	NULL
843};
844
845void usb_create_sysfs_intf_files(struct usb_interface *intf)
846{
847	struct usb_device *udev = interface_to_usbdev(intf);
848	struct usb_host_interface *alt = intf->cur_altsetting;
849
850	if (intf->sysfs_files_created || intf->unregistering)
851		return;
852
853	if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
854		alt->string = usb_cache_string(udev, alt->desc.iInterface);
855	if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
856		;	/* We don't actually care if the function fails. */
857	intf->sysfs_files_created = 1;
858}
859
860void usb_remove_sysfs_intf_files(struct usb_interface *intf)
861{
862	if (!intf->sysfs_files_created)
863		return;
864
865	device_remove_file(&intf->dev, &dev_attr_interface);
866	intf->sysfs_files_created = 0;
867}
v3.15
   1/*
   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
  13#include <linux/kernel.h>
  14#include <linux/string.h>
  15#include <linux/usb.h>
  16#include <linux/usb/quirks.h>
  17#include "usb.h"
  18
  19/* Active configuration fields */
  20#define usb_actconfig_show(field, format_string)			\
  21static ssize_t field##_show(struct device *dev,				\
  22			    struct device_attribute *attr, char *buf)	\
  23{									\
  24	struct usb_device *udev;					\
  25	struct usb_host_config *actconfig;				\
  26	ssize_t rc = 0;							\
  27									\
  28	udev = to_usb_device(dev);					\
  29	usb_lock_device(udev);						\
  30	actconfig = udev->actconfig;					\
  31	if (actconfig)							\
  32		rc = sprintf(buf, format_string,			\
  33				actconfig->desc.field);			\
  34	usb_unlock_device(udev);					\
  35	return rc;							\
  36}									\
  37
  38#define usb_actconfig_attr(field, format_string)		\
  39	usb_actconfig_show(field, format_string)		\
  40	static DEVICE_ATTR_RO(field)
 
 
 
 
  41
  42usb_actconfig_attr(bNumInterfaces, "%2d\n");
  43usb_actconfig_attr(bmAttributes, "%2x\n");
  44
  45static ssize_t bMaxPower_show(struct device *dev,
  46		struct device_attribute *attr, char *buf)
  47{
  48	struct usb_device *udev;
  49	struct usb_host_config *actconfig;
  50	ssize_t rc = 0;
  51
  52	udev = to_usb_device(dev);
  53	usb_lock_device(udev);
  54	actconfig = udev->actconfig;
  55	if (actconfig)
  56		rc = sprintf(buf, "%dmA\n", usb_get_max_power(udev, actconfig));
  57	usb_unlock_device(udev);
  58	return rc;
  59}
  60static DEVICE_ATTR_RO(bMaxPower);
  61
  62static ssize_t configuration_show(struct device *dev,
  63		struct device_attribute *attr, char *buf)
  64{
  65	struct usb_device *udev;
  66	struct usb_host_config *actconfig;
  67	ssize_t rc = 0;
  68
  69	udev = to_usb_device(dev);
  70	usb_lock_device(udev);
  71	actconfig = udev->actconfig;
  72	if (actconfig && actconfig->string)
  73		rc = sprintf(buf, "%s\n", actconfig->string);
  74	usb_unlock_device(udev);
  75	return rc;
  76}
  77static DEVICE_ATTR_RO(configuration);
  78
  79/* configuration value is always present, and r/w */
  80usb_actconfig_show(bConfigurationValue, "%u\n");
  81
  82static ssize_t bConfigurationValue_store(struct device *dev,
  83					 struct device_attribute *attr,
  84					 const char *buf, size_t count)
  85{
  86	struct usb_device	*udev = to_usb_device(dev);
  87	int			config, value;
  88
  89	if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
  90		return -EINVAL;
  91	usb_lock_device(udev);
  92	value = usb_set_configuration(udev, config);
  93	usb_unlock_device(udev);
  94	return (value < 0) ? value : count;
  95}
  96static DEVICE_ATTR_IGNORE_LOCKDEP(bConfigurationValue, S_IRUGO | S_IWUSR,
  97		bConfigurationValue_show, bConfigurationValue_store);
 
  98
  99/* String fields */
 100#define usb_string_attr(name)						\
 101static ssize_t  name##_show(struct device *dev,				\
 102		struct device_attribute *attr, char *buf)		\
 103{									\
 104	struct usb_device *udev;					\
 105	int retval;							\
 106									\
 107	udev = to_usb_device(dev);					\
 108	usb_lock_device(udev);						\
 109	retval = sprintf(buf, "%s\n", udev->name);			\
 110	usb_unlock_device(udev);					\
 111	return retval;							\
 112}									\
 113static DEVICE_ATTR_RO(name)
 114
 115usb_string_attr(product);
 116usb_string_attr(manufacturer);
 117usb_string_attr(serial);
 118
 119static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
 120			  char *buf)
 121{
 122	struct usb_device *udev;
 123	char *speed;
 124
 125	udev = to_usb_device(dev);
 126
 127	switch (udev->speed) {
 128	case USB_SPEED_LOW:
 129		speed = "1.5";
 130		break;
 131	case USB_SPEED_UNKNOWN:
 132	case USB_SPEED_FULL:
 133		speed = "12";
 134		break;
 135	case USB_SPEED_HIGH:
 136		speed = "480";
 137		break;
 138	case USB_SPEED_WIRELESS:
 139		speed = "480";
 140		break;
 141	case USB_SPEED_SUPER:
 142		speed = "5000";
 143		break;
 144	default:
 145		speed = "unknown";
 146	}
 147	return sprintf(buf, "%s\n", speed);
 148}
 149static DEVICE_ATTR_RO(speed);
 150
 151static ssize_t busnum_show(struct device *dev, struct device_attribute *attr,
 152			   char *buf)
 153{
 154	struct usb_device *udev;
 155
 156	udev = to_usb_device(dev);
 157	return sprintf(buf, "%d\n", udev->bus->busnum);
 158}
 159static DEVICE_ATTR_RO(busnum);
 160
 161static ssize_t devnum_show(struct device *dev, struct device_attribute *attr,
 162			   char *buf)
 163{
 164	struct usb_device *udev;
 165
 166	udev = to_usb_device(dev);
 167	return sprintf(buf, "%d\n", udev->devnum);
 168}
 169static DEVICE_ATTR_RO(devnum);
 170
 171static ssize_t devpath_show(struct device *dev, struct device_attribute *attr,
 172			    char *buf)
 173{
 174	struct usb_device *udev;
 175
 176	udev = to_usb_device(dev);
 177	return sprintf(buf, "%s\n", udev->devpath);
 178}
 179static DEVICE_ATTR_RO(devpath);
 180
 181static ssize_t version_show(struct device *dev, struct device_attribute *attr,
 182			    char *buf)
 183{
 184	struct usb_device *udev;
 185	u16 bcdUSB;
 186
 187	udev = to_usb_device(dev);
 188	bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
 189	return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
 190}
 191static DEVICE_ATTR_RO(version);
 192
 193static ssize_t maxchild_show(struct device *dev, struct device_attribute *attr,
 194			     char *buf)
 195{
 196	struct usb_device *udev;
 197
 198	udev = to_usb_device(dev);
 199	return sprintf(buf, "%d\n", udev->maxchild);
 200}
 201static DEVICE_ATTR_RO(maxchild);
 202
 203static ssize_t quirks_show(struct device *dev, struct device_attribute *attr,
 204			   char *buf)
 205{
 206	struct usb_device *udev;
 207
 208	udev = to_usb_device(dev);
 209	return sprintf(buf, "0x%x\n", udev->quirks);
 210}
 211static DEVICE_ATTR_RO(quirks);
 212
 213static ssize_t avoid_reset_quirk_show(struct device *dev,
 214				      struct device_attribute *attr, char *buf)
 215{
 216	struct usb_device *udev;
 217
 218	udev = to_usb_device(dev);
 219	return sprintf(buf, "%d\n", !!(udev->quirks & USB_QUIRK_RESET));
 220}
 221
 222static ssize_t avoid_reset_quirk_store(struct device *dev,
 223				      struct device_attribute *attr,
 224				      const char *buf, size_t count)
 225{
 226	struct usb_device	*udev = to_usb_device(dev);
 227	int			val;
 228
 229	if (sscanf(buf, "%d", &val) != 1 || val < 0 || val > 1)
 230		return -EINVAL;
 231	usb_lock_device(udev);
 232	if (val)
 233		udev->quirks |= USB_QUIRK_RESET;
 234	else
 235		udev->quirks &= ~USB_QUIRK_RESET;
 236	usb_unlock_device(udev);
 237	return count;
 238}
 239static DEVICE_ATTR_RW(avoid_reset_quirk);
 240
 241static ssize_t urbnum_show(struct device *dev, struct device_attribute *attr,
 242			   char *buf)
 
 
 
 243{
 244	struct usb_device *udev;
 245
 246	udev = to_usb_device(dev);
 247	return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
 248}
 249static DEVICE_ATTR_RO(urbnum);
 250
 251static ssize_t removable_show(struct device *dev, struct device_attribute *attr,
 252			      char *buf)
 253{
 254	struct usb_device *udev;
 255	char *state;
 256
 257	udev = to_usb_device(dev);
 258
 259	switch (udev->removable) {
 260	case USB_DEVICE_REMOVABLE:
 261		state = "removable";
 262		break;
 263	case USB_DEVICE_FIXED:
 264		state = "fixed";
 265		break;
 266	default:
 267		state = "unknown";
 268	}
 269
 270	return sprintf(buf, "%s\n", state);
 271}
 272static DEVICE_ATTR_RO(removable);
 273
 274static ssize_t ltm_capable_show(struct device *dev,
 275				struct device_attribute *attr, char *buf)
 276{
 277	if (usb_device_supports_ltm(to_usb_device(dev)))
 278		return sprintf(buf, "%s\n", "yes");
 279	return sprintf(buf, "%s\n", "no");
 280}
 281static DEVICE_ATTR_RO(ltm_capable);
 282
 283#ifdef	CONFIG_PM
 284
 285static ssize_t persist_show(struct device *dev, struct device_attribute *attr,
 286			    char *buf)
 287{
 288	struct usb_device *udev = to_usb_device(dev);
 289
 290	return sprintf(buf, "%d\n", udev->persist_enabled);
 291}
 292
 293static ssize_t persist_store(struct device *dev, struct device_attribute *attr,
 294			     const char *buf, size_t count)
 
 295{
 296	struct usb_device *udev = to_usb_device(dev);
 297	int value;
 298
 299	/* Hubs are always enabled for USB_PERSIST */
 300	if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
 301		return -EPERM;
 302
 303	if (sscanf(buf, "%d", &value) != 1)
 304		return -EINVAL;
 305
 306	usb_lock_device(udev);
 307	udev->persist_enabled = !!value;
 308	usb_unlock_device(udev);
 309	return count;
 310}
 311static DEVICE_ATTR_RW(persist);
 
 312
 313static int add_persist_attributes(struct device *dev)
 314{
 315	int rc = 0;
 316
 317	if (is_usb_device(dev)) {
 318		struct usb_device *udev = to_usb_device(dev);
 319
 320		/* Hubs are automatically enabled for USB_PERSIST,
 321		 * no point in creating the attribute file.
 322		 */
 323		if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
 324			rc = sysfs_add_file_to_group(&dev->kobj,
 325					&dev_attr_persist.attr,
 326					power_group_name);
 327	}
 328	return rc;
 329}
 330
 331static void remove_persist_attributes(struct device *dev)
 332{
 333	sysfs_remove_file_from_group(&dev->kobj,
 334			&dev_attr_persist.attr,
 335			power_group_name);
 336}
 337#else
 338
 339#define add_persist_attributes(dev)	0
 340#define remove_persist_attributes(dev)	do {} while (0)
 341
 342#endif	/* CONFIG_PM */
 343
 344#ifdef	CONFIG_PM_RUNTIME
 345
 346static ssize_t connected_duration_show(struct device *dev,
 347				       struct device_attribute *attr, char *buf)
 
 348{
 349	struct usb_device *udev = to_usb_device(dev);
 350
 351	return sprintf(buf, "%u\n",
 352			jiffies_to_msecs(jiffies - udev->connect_time));
 353}
 354static DEVICE_ATTR_RO(connected_duration);
 
 355
 356/*
 357 * If the device is resumed, the last time the device was suspended has
 358 * been pre-subtracted from active_duration.  We add the current time to
 359 * get the duration that the device was actually active.
 360 *
 361 * If the device is suspended, the active_duration is up-to-date.
 362 */
 363static ssize_t active_duration_show(struct device *dev,
 364				    struct device_attribute *attr, char *buf)
 
 365{
 366	struct usb_device *udev = to_usb_device(dev);
 367	int duration;
 368
 369	if (udev->state != USB_STATE_SUSPENDED)
 370		duration = jiffies_to_msecs(jiffies + udev->active_duration);
 371	else
 372		duration = jiffies_to_msecs(udev->active_duration);
 373	return sprintf(buf, "%u\n", duration);
 374}
 375static DEVICE_ATTR_RO(active_duration);
 376
 377static ssize_t autosuspend_show(struct device *dev,
 378				struct device_attribute *attr, char *buf)
 
 
 379{
 380	return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
 381}
 382
 383static ssize_t autosuspend_store(struct device *dev,
 384				 struct device_attribute *attr, const char *buf,
 385				 size_t count)
 386{
 387	int value;
 388
 389	if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
 390			value <= -INT_MAX/1000)
 391		return -EINVAL;
 392
 393	pm_runtime_set_autosuspend_delay(dev, value * 1000);
 394	return count;
 395}
 396static DEVICE_ATTR_RW(autosuspend);
 
 
 397
 398static const char on_string[] = "on";
 399static const char auto_string[] = "auto";
 400
 401static void warn_level(void)
 402{
 403	static int level_warned;
 404
 405	if (!level_warned) {
 406		level_warned = 1;
 407		printk(KERN_WARNING "WARNING! power/level is deprecated; "
 408				"use power/control instead\n");
 409	}
 410}
 411
 412static ssize_t level_show(struct device *dev, struct device_attribute *attr,
 413			  char *buf)
 414{
 415	struct usb_device *udev = to_usb_device(dev);
 416	const char *p = auto_string;
 417
 418	warn_level();
 419	if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
 420		p = on_string;
 421	return sprintf(buf, "%s\n", p);
 422}
 423
 424static ssize_t level_store(struct device *dev, struct device_attribute *attr,
 425			   const char *buf, size_t count)
 
 426{
 427	struct usb_device *udev = to_usb_device(dev);
 428	int len = count;
 429	char *cp;
 430	int rc = count;
 431
 432	warn_level();
 433	cp = memchr(buf, '\n', count);
 434	if (cp)
 435		len = cp - buf;
 436
 437	usb_lock_device(udev);
 438
 439	if (len == sizeof on_string - 1 &&
 440			strncmp(buf, on_string, len) == 0)
 441		usb_disable_autosuspend(udev);
 442
 443	else if (len == sizeof auto_string - 1 &&
 444			strncmp(buf, auto_string, len) == 0)
 445		usb_enable_autosuspend(udev);
 446
 447	else
 448		rc = -EINVAL;
 449
 450	usb_unlock_device(udev);
 451	return rc;
 452}
 453static DEVICE_ATTR_RW(level);
 454
 455static ssize_t usb2_hardware_lpm_show(struct device *dev,
 456				      struct device_attribute *attr, char *buf)
 457{
 458	struct usb_device *udev = to_usb_device(dev);
 459	const char *p;
 460
 461	if (udev->usb2_hw_lpm_allowed == 1)
 462		p = "enabled";
 463	else
 464		p = "disabled";
 465
 466	return sprintf(buf, "%s\n", p);
 467}
 468
 469static ssize_t usb2_hardware_lpm_store(struct device *dev,
 470				       struct device_attribute *attr,
 471				       const char *buf, size_t count)
 472{
 473	struct usb_device *udev = to_usb_device(dev);
 474	bool value;
 475	int ret;
 476
 477	usb_lock_device(udev);
 478
 479	ret = strtobool(buf, &value);
 480
 481	if (!ret) {
 482		udev->usb2_hw_lpm_allowed = value;
 483		ret = usb_set_usb2_hardware_lpm(udev, value);
 484	}
 485
 486	usb_unlock_device(udev);
 487
 488	if (!ret)
 489		return count;
 490
 491	return ret;
 492}
 493static DEVICE_ATTR_RW(usb2_hardware_lpm);
 494
 495static ssize_t usb2_lpm_l1_timeout_show(struct device *dev,
 496					struct device_attribute *attr,
 497					char *buf)
 498{
 499	struct usb_device *udev = to_usb_device(dev);
 500	return sprintf(buf, "%d\n", udev->l1_params.timeout);
 501}
 502
 503static ssize_t usb2_lpm_l1_timeout_store(struct device *dev,
 504					 struct device_attribute *attr,
 505					 const char *buf, size_t count)
 506{
 507	struct usb_device *udev = to_usb_device(dev);
 508	u16 timeout;
 509
 510	if (kstrtou16(buf, 0, &timeout))
 511		return -EINVAL;
 512
 513	udev->l1_params.timeout = timeout;
 514
 515	return count;
 516}
 517static DEVICE_ATTR_RW(usb2_lpm_l1_timeout);
 518
 519static ssize_t usb2_lpm_besl_show(struct device *dev,
 520				  struct device_attribute *attr, char *buf)
 521{
 522	struct usb_device *udev = to_usb_device(dev);
 523	return sprintf(buf, "%d\n", udev->l1_params.besl);
 524}
 525
 526static ssize_t usb2_lpm_besl_store(struct device *dev,
 527				   struct device_attribute *attr,
 528				   const char *buf, size_t count)
 529{
 530	struct usb_device *udev = to_usb_device(dev);
 531	u8 besl;
 532
 533	if (kstrtou8(buf, 0, &besl) || besl > 15)
 534		return -EINVAL;
 535
 536	udev->l1_params.besl = besl;
 537
 538	return count;
 539}
 540static DEVICE_ATTR_RW(usb2_lpm_besl);
 541
 542static struct attribute *usb2_hardware_lpm_attr[] = {
 543	&dev_attr_usb2_hardware_lpm.attr,
 544	&dev_attr_usb2_lpm_l1_timeout.attr,
 545	&dev_attr_usb2_lpm_besl.attr,
 546	NULL,
 547};
 548static struct attribute_group usb2_hardware_lpm_attr_group = {
 549	.name	= power_group_name,
 550	.attrs	= usb2_hardware_lpm_attr,
 551};
 552
 553static struct attribute *power_attrs[] = {
 554	&dev_attr_autosuspend.attr,
 555	&dev_attr_level.attr,
 556	&dev_attr_connected_duration.attr,
 557	&dev_attr_active_duration.attr,
 558	NULL,
 559};
 560static struct attribute_group power_attr_group = {
 561	.name	= power_group_name,
 562	.attrs	= power_attrs,
 563};
 564
 565static int add_power_attributes(struct device *dev)
 566{
 567	int rc = 0;
 568
 569	if (is_usb_device(dev)) {
 570		struct usb_device *udev = to_usb_device(dev);
 571		rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
 572		if (udev->usb2_hw_lpm_capable == 1)
 573			rc = sysfs_merge_group(&dev->kobj,
 574					&usb2_hardware_lpm_attr_group);
 575	}
 576
 577	return rc;
 578}
 579
 580static void remove_power_attributes(struct device *dev)
 581{
 582	sysfs_unmerge_group(&dev->kobj, &usb2_hardware_lpm_attr_group);
 583	sysfs_unmerge_group(&dev->kobj, &power_attr_group);
 584}
 585
 586#else
 587
 588#define add_power_attributes(dev)	0
 589#define remove_power_attributes(dev)	do {} while (0)
 590
 591#endif	/* CONFIG_PM_RUNTIME */
 592
 593
 594/* Descriptor fields */
 595#define usb_descriptor_attr_le16(field, format_string)			\
 596static ssize_t								\
 597field##_show(struct device *dev, struct device_attribute *attr,	\
 598		char *buf)						\
 599{									\
 600	struct usb_device *udev;					\
 601									\
 602	udev = to_usb_device(dev);					\
 603	return sprintf(buf, format_string, 				\
 604			le16_to_cpu(udev->descriptor.field));		\
 605}									\
 606static DEVICE_ATTR_RO(field)
 607
 608usb_descriptor_attr_le16(idVendor, "%04x\n");
 609usb_descriptor_attr_le16(idProduct, "%04x\n");
 610usb_descriptor_attr_le16(bcdDevice, "%04x\n");
 611
 612#define usb_descriptor_attr(field, format_string)			\
 613static ssize_t								\
 614field##_show(struct device *dev, struct device_attribute *attr,	\
 615		char *buf)						\
 616{									\
 617	struct usb_device *udev;					\
 618									\
 619	udev = to_usb_device(dev);					\
 620	return sprintf(buf, format_string, udev->descriptor.field);	\
 621}									\
 622static DEVICE_ATTR_RO(field)
 
 
 
 
 
 
 623
 624usb_descriptor_attr(bDeviceClass, "%02x\n");
 625usb_descriptor_attr(bDeviceSubClass, "%02x\n");
 626usb_descriptor_attr(bDeviceProtocol, "%02x\n");
 627usb_descriptor_attr(bNumConfigurations, "%d\n");
 628usb_descriptor_attr(bMaxPacketSize0, "%d\n");
 629
 630
 631/* show if the device is authorized (1) or not (0) */
 632static ssize_t authorized_show(struct device *dev,
 633			       struct device_attribute *attr, char *buf)
 
 634{
 635	struct usb_device *usb_dev = to_usb_device(dev);
 636	return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
 637}
 638
 
 639/*
 640 * Authorize a device to be used in the system
 641 *
 642 * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
 643 */
 644static ssize_t authorized_store(struct device *dev,
 645				struct device_attribute *attr, const char *buf,
 646				size_t size)
 647{
 648	ssize_t result;
 649	struct usb_device *usb_dev = to_usb_device(dev);
 650	unsigned val;
 651	result = sscanf(buf, "%u\n", &val);
 652	if (result != 1)
 653		result = -EINVAL;
 654	else if (val == 0)
 655		result = usb_deauthorize_device(usb_dev);
 656	else
 657		result = usb_authorize_device(usb_dev);
 658	return result < 0 ? result : size;
 659}
 660static DEVICE_ATTR_IGNORE_LOCKDEP(authorized, S_IRUGO | S_IWUSR,
 661				  authorized_show, authorized_store);
 
 662
 663/* "Safely remove a device" */
 664static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
 665			    const char *buf, size_t count)
 
 666{
 667	struct usb_device *udev = to_usb_device(dev);
 668	int rc = 0;
 669
 670	usb_lock_device(udev);
 671	if (udev->state != USB_STATE_NOTATTACHED) {
 672
 673		/* To avoid races, first unconfigure and then remove */
 674		usb_set_configuration(udev, -1);
 675		rc = usb_remove_device(udev);
 676	}
 677	if (rc == 0)
 678		rc = count;
 679	usb_unlock_device(udev);
 680	return rc;
 681}
 682static DEVICE_ATTR_IGNORE_LOCKDEP(remove, S_IWUSR, NULL, remove_store);
 683
 684
 685static struct attribute *dev_attrs[] = {
 686	/* current configuration's attributes */
 687	&dev_attr_configuration.attr,
 688	&dev_attr_bNumInterfaces.attr,
 689	&dev_attr_bConfigurationValue.attr,
 690	&dev_attr_bmAttributes.attr,
 691	&dev_attr_bMaxPower.attr,
 692	/* device attributes */
 693	&dev_attr_urbnum.attr,
 694	&dev_attr_idVendor.attr,
 695	&dev_attr_idProduct.attr,
 696	&dev_attr_bcdDevice.attr,
 697	&dev_attr_bDeviceClass.attr,
 698	&dev_attr_bDeviceSubClass.attr,
 699	&dev_attr_bDeviceProtocol.attr,
 700	&dev_attr_bNumConfigurations.attr,
 701	&dev_attr_bMaxPacketSize0.attr,
 702	&dev_attr_speed.attr,
 703	&dev_attr_busnum.attr,
 704	&dev_attr_devnum.attr,
 705	&dev_attr_devpath.attr,
 706	&dev_attr_version.attr,
 707	&dev_attr_maxchild.attr,
 708	&dev_attr_quirks.attr,
 709	&dev_attr_avoid_reset_quirk.attr,
 710	&dev_attr_authorized.attr,
 711	&dev_attr_remove.attr,
 712	&dev_attr_removable.attr,
 713	&dev_attr_ltm_capable.attr,
 714	NULL,
 715};
 716static struct attribute_group dev_attr_grp = {
 717	.attrs = dev_attrs,
 718};
 719
 720/* When modifying this list, be sure to modify dev_string_attrs_are_visible()
 721 * accordingly.
 722 */
 723static struct attribute *dev_string_attrs[] = {
 724	&dev_attr_manufacturer.attr,
 725	&dev_attr_product.attr,
 726	&dev_attr_serial.attr,
 727	NULL
 728};
 729
 730static umode_t dev_string_attrs_are_visible(struct kobject *kobj,
 731		struct attribute *a, int n)
 732{
 733	struct device *dev = container_of(kobj, struct device, kobj);
 734	struct usb_device *udev = to_usb_device(dev);
 735
 736	if (a == &dev_attr_manufacturer.attr) {
 737		if (udev->manufacturer == NULL)
 738			return 0;
 739	} else if (a == &dev_attr_product.attr) {
 740		if (udev->product == NULL)
 741			return 0;
 742	} else if (a == &dev_attr_serial.attr) {
 743		if (udev->serial == NULL)
 744			return 0;
 745	}
 746	return a->mode;
 747}
 748
 749static struct attribute_group dev_string_attr_grp = {
 750	.attrs =	dev_string_attrs,
 751	.is_visible =	dev_string_attrs_are_visible,
 752};
 753
 754const struct attribute_group *usb_device_groups[] = {
 755	&dev_attr_grp,
 756	&dev_string_attr_grp,
 757	NULL
 758};
 759
 760/* Binary descriptors */
 761
 762static ssize_t
 763read_descriptors(struct file *filp, struct kobject *kobj,
 764		struct bin_attribute *attr,
 765		char *buf, loff_t off, size_t count)
 766{
 767	struct device *dev = container_of(kobj, struct device, kobj);
 768	struct usb_device *udev = to_usb_device(dev);
 769	size_t nleft = count;
 770	size_t srclen, n;
 771	int cfgno;
 772	void *src;
 773
 774	/* The binary attribute begins with the device descriptor.
 775	 * Following that are the raw descriptor entries for all the
 776	 * configurations (config plus subsidiary descriptors).
 777	 */
 778	usb_lock_device(udev);
 779	for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
 780			nleft > 0; ++cfgno) {
 781		if (cfgno < 0) {
 782			src = &udev->descriptor;
 783			srclen = sizeof(struct usb_device_descriptor);
 784		} else {
 785			src = udev->rawdescriptors[cfgno];
 786			srclen = __le16_to_cpu(udev->config[cfgno].desc.
 787					wTotalLength);
 788		}
 789		if (off < srclen) {
 790			n = min(nleft, srclen - (size_t) off);
 791			memcpy(buf, src + off, n);
 792			nleft -= n;
 793			buf += n;
 794			off = 0;
 795		} else {
 796			off -= srclen;
 797		}
 798	}
 799	usb_unlock_device(udev);
 800	return count - nleft;
 801}
 802
 803static struct bin_attribute dev_bin_attr_descriptors = {
 804	.attr = {.name = "descriptors", .mode = 0444},
 805	.read = read_descriptors,
 806	.size = 18 + 65535,	/* dev descr + max-size raw descriptor */
 807};
 808
 809int usb_create_sysfs_dev_files(struct usb_device *udev)
 810{
 811	struct device *dev = &udev->dev;
 812	int retval;
 813
 814	retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
 815	if (retval)
 816		goto error;
 817
 818	retval = add_persist_attributes(dev);
 819	if (retval)
 820		goto error;
 821
 822	retval = add_power_attributes(dev);
 823	if (retval)
 824		goto error;
 825	return retval;
 826error:
 827	usb_remove_sysfs_dev_files(udev);
 828	return retval;
 829}
 830
 831void usb_remove_sysfs_dev_files(struct usb_device *udev)
 832{
 833	struct device *dev = &udev->dev;
 834
 835	remove_power_attributes(dev);
 836	remove_persist_attributes(dev);
 837	device_remove_bin_file(dev, &dev_bin_attr_descriptors);
 838}
 839
 840/* Interface Association Descriptor fields */
 841#define usb_intf_assoc_attr(field, format_string)			\
 842static ssize_t								\
 843iad_##field##_show(struct device *dev, struct device_attribute *attr,	\
 844		char *buf)						\
 845{									\
 846	struct usb_interface *intf = to_usb_interface(dev);		\
 847									\
 848	return sprintf(buf, format_string,				\
 849			intf->intf_assoc->field); 			\
 850}									\
 851static DEVICE_ATTR_RO(iad_##field)
 852
 853usb_intf_assoc_attr(bFirstInterface, "%02x\n");
 854usb_intf_assoc_attr(bInterfaceCount, "%02d\n");
 855usb_intf_assoc_attr(bFunctionClass, "%02x\n");
 856usb_intf_assoc_attr(bFunctionSubClass, "%02x\n");
 857usb_intf_assoc_attr(bFunctionProtocol, "%02x\n");
 858
 859/* Interface fields */
 860#define usb_intf_attr(field, format_string)				\
 861static ssize_t								\
 862field##_show(struct device *dev, struct device_attribute *attr,		\
 863		char *buf)						\
 864{									\
 865	struct usb_interface *intf = to_usb_interface(dev);		\
 866									\
 867	return sprintf(buf, format_string,				\
 868			intf->cur_altsetting->desc.field); 		\
 869}									\
 870static DEVICE_ATTR_RO(field)
 871
 872usb_intf_attr(bInterfaceNumber, "%02x\n");
 873usb_intf_attr(bAlternateSetting, "%2d\n");
 874usb_intf_attr(bNumEndpoints, "%02x\n");
 875usb_intf_attr(bInterfaceClass, "%02x\n");
 876usb_intf_attr(bInterfaceSubClass, "%02x\n");
 877usb_intf_attr(bInterfaceProtocol, "%02x\n");
 878
 879static ssize_t interface_show(struct device *dev, struct device_attribute *attr,
 880			      char *buf)
 881{
 882	struct usb_interface *intf;
 883	char *string;
 884
 885	intf = to_usb_interface(dev);
 886	string = ACCESS_ONCE(intf->cur_altsetting->string);
 
 
 887	if (!string)
 888		return 0;
 889	return sprintf(buf, "%s\n", string);
 890}
 891static DEVICE_ATTR_RO(interface);
 892
 893static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
 894			     char *buf)
 895{
 896	struct usb_interface *intf;
 897	struct usb_device *udev;
 898	struct usb_host_interface *alt;
 899
 900	intf = to_usb_interface(dev);
 901	udev = interface_to_usbdev(intf);
 902	alt = ACCESS_ONCE(intf->cur_altsetting);
 903
 904	return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
 905			"ic%02Xisc%02Xip%02Xin%02X\n",
 906			le16_to_cpu(udev->descriptor.idVendor),
 907			le16_to_cpu(udev->descriptor.idProduct),
 908			le16_to_cpu(udev->descriptor.bcdDevice),
 909			udev->descriptor.bDeviceClass,
 910			udev->descriptor.bDeviceSubClass,
 911			udev->descriptor.bDeviceProtocol,
 912			alt->desc.bInterfaceClass,
 913			alt->desc.bInterfaceSubClass,
 914			alt->desc.bInterfaceProtocol,
 915			alt->desc.bInterfaceNumber);
 916}
 917static DEVICE_ATTR_RO(modalias);
 918
 919static ssize_t supports_autosuspend_show(struct device *dev,
 920					 struct device_attribute *attr,
 921					 char *buf)
 922{
 923	int s;
 
 
 
 
 
 924
 925	device_lock(dev);
 926	/* Devices will be autosuspended even when an interface isn't claimed */
 927	s = (!dev->driver || to_usb_driver(dev->driver)->supports_autosuspend);
 928	device_unlock(dev);
 
 
 
 
 929
 930	return sprintf(buf, "%u\n", s);
 931}
 932static DEVICE_ATTR_RO(supports_autosuspend);
 933
 934static struct attribute *intf_attrs[] = {
 935	&dev_attr_bInterfaceNumber.attr,
 936	&dev_attr_bAlternateSetting.attr,
 937	&dev_attr_bNumEndpoints.attr,
 938	&dev_attr_bInterfaceClass.attr,
 939	&dev_attr_bInterfaceSubClass.attr,
 940	&dev_attr_bInterfaceProtocol.attr,
 941	&dev_attr_modalias.attr,
 942	&dev_attr_supports_autosuspend.attr,
 943	NULL,
 944};
 945static struct attribute_group intf_attr_grp = {
 946	.attrs = intf_attrs,
 947};
 948
 949static struct attribute *intf_assoc_attrs[] = {
 950	&dev_attr_iad_bFirstInterface.attr,
 951	&dev_attr_iad_bInterfaceCount.attr,
 952	&dev_attr_iad_bFunctionClass.attr,
 953	&dev_attr_iad_bFunctionSubClass.attr,
 954	&dev_attr_iad_bFunctionProtocol.attr,
 955	NULL,
 956};
 957
 958static umode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
 959		struct attribute *a, int n)
 960{
 961	struct device *dev = container_of(kobj, struct device, kobj);
 962	struct usb_interface *intf = to_usb_interface(dev);
 963
 964	if (intf->intf_assoc == NULL)
 965		return 0;
 966	return a->mode;
 967}
 968
 969static struct attribute_group intf_assoc_attr_grp = {
 970	.attrs =	intf_assoc_attrs,
 971	.is_visible =	intf_assoc_attrs_are_visible,
 972};
 973
 974const struct attribute_group *usb_interface_groups[] = {
 975	&intf_attr_grp,
 976	&intf_assoc_attr_grp,
 977	NULL
 978};
 979
 980void usb_create_sysfs_intf_files(struct usb_interface *intf)
 981{
 982	struct usb_device *udev = interface_to_usbdev(intf);
 983	struct usb_host_interface *alt = intf->cur_altsetting;
 984
 985	if (intf->sysfs_files_created || intf->unregistering)
 986		return;
 987
 988	if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
 989		alt->string = usb_cache_string(udev, alt->desc.iInterface);
 990	if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
 991		;	/* We don't actually care if the function fails. */
 992	intf->sysfs_files_created = 1;
 993}
 994
 995void usb_remove_sysfs_intf_files(struct usb_interface *intf)
 996{
 997	if (!intf->sysfs_files_created)
 998		return;
 999
1000	device_remove_file(&intf->dev, &dev_attr_interface);
1001	intf->sysfs_files_created = 0;
1002}