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 "usb.h"
17
18/* Active configuration fields */
19#define usb_actconfig_show(field, multiplier, format_string)		\
20static ssize_t  show_##field(struct device *dev,			\
21		struct device_attribute *attr, char *buf)		\
22{									\
23	struct usb_device *udev;					\
24	struct usb_host_config *actconfig;				\
25									\
26	udev = to_usb_device(dev);					\
27	actconfig = udev->actconfig;					\
28	if (actconfig)							\
29		return sprintf(buf, format_string,			\
30				actconfig->desc.field * multiplier);	\
31	else								\
32		return 0;						\
33}									\
34
35#define usb_actconfig_attr(field, multiplier, format_string)		\
36usb_actconfig_show(field, multiplier, format_string)			\
37static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
38
39usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
40usb_actconfig_attr(bmAttributes, 1, "%2x\n")
41usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
42
43static ssize_t show_configuration_string(struct device *dev,
44		struct device_attribute *attr, char *buf)
45{
46	struct usb_device *udev;
47	struct usb_host_config *actconfig;
48
49	udev = to_usb_device(dev);
50	actconfig = udev->actconfig;
51	if ((!actconfig) || (!actconfig->string))
52		return 0;
53	return sprintf(buf, "%s\n", actconfig->string);
54}
55static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
56
57/* configuration value is always present, and r/w */
58usb_actconfig_show(bConfigurationValue, 1, "%u\n");
59
60static ssize_t
61set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
62		const char *buf, size_t count)
63{
64	struct usb_device	*udev = to_usb_device(dev);
65	int			config, value;
66
67	if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
68		return -EINVAL;
69	usb_lock_device(udev);
70	value = usb_set_configuration(udev, config);
71	usb_unlock_device(udev);
72	return (value < 0) ? value : count;
73}
74
75static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
76		show_bConfigurationValue, set_bConfigurationValue);
77
78/* String fields */
79#define usb_string_attr(name)						\
80static ssize_t  show_##name(struct device *dev,				\
81		struct device_attribute *attr, char *buf)		\
82{									\
83	struct usb_device *udev;					\
84									\
85	udev = to_usb_device(dev);					\
86	return sprintf(buf, "%s\n", udev->name);			\
87}									\
88static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
89
90usb_string_attr(product);
91usb_string_attr(manufacturer);
92usb_string_attr(serial);
93
94static ssize_t
95show_speed(struct device *dev, struct device_attribute *attr, char *buf)
96{
97	struct usb_device *udev;
98	char *speed;
99
100	udev = to_usb_device(dev);
101
102	switch (udev->speed) {
103	case USB_SPEED_LOW:
104		speed = "1.5";
105		break;
106	case USB_SPEED_UNKNOWN:
107	case USB_SPEED_FULL:
108		speed = "12";
109		break;
110	case USB_SPEED_HIGH:
111		speed = "480";
112		break;
113	default:
114		speed = "unknown";
115	}
116	return sprintf(buf, "%s\n", speed);
117}
118static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
119
120static ssize_t
121show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
122{
123	struct usb_device *udev;
124
125	udev = to_usb_device(dev);
126	return sprintf(buf, "%d\n", udev->bus->busnum);
127}
128static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
129
130static ssize_t
131show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
132{
133	struct usb_device *udev;
134
135	udev = to_usb_device(dev);
136	return sprintf(buf, "%d\n", udev->devnum);
137}
138static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
139
140static ssize_t
141show_version(struct device *dev, struct device_attribute *attr, char *buf)
142{
143	struct usb_device *udev;
144	u16 bcdUSB;
145
146	udev = to_usb_device(dev);
147	bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
148	return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
149}
150static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
151
152static ssize_t
153show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
154{
155	struct usb_device *udev;
156
157	udev = to_usb_device(dev);
158	return sprintf(buf, "%d\n", udev->maxchild);
159}
160static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
161
162static ssize_t
163show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
164{
165	struct usb_device *udev;
166
167	udev = to_usb_device(dev);
168	return sprintf(buf, "0x%x\n", udev->quirks);
169}
170static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
171
172#ifdef	CONFIG_USB_SUSPEND
173
174static ssize_t
175show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
176{
177	struct usb_device *udev = to_usb_device(dev);
178
179	return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
180}
181
182static ssize_t
183set_autosuspend(struct device *dev, struct device_attribute *attr,
184		const char *buf, size_t count)
185{
186	struct usb_device *udev = to_usb_device(dev);
187	int value;
188
189	if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
190			value <= - INT_MAX/HZ)
191		return -EINVAL;
192	value *= HZ;
193
194	udev->autosuspend_delay = value;
195	if (value >= 0)
196		usb_try_autosuspend_device(udev);
197	else {
198		if (usb_autoresume_device(udev) == 0)
199			usb_autosuspend_device(udev);
200	}
201	return count;
202}
203
204static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
205		show_autosuspend, set_autosuspend);
206
207static const char on_string[] = "on";
208static const char auto_string[] = "auto";
209static const char suspend_string[] = "suspend";
210
211static ssize_t
212show_level(struct device *dev, struct device_attribute *attr, char *buf)
213{
214	struct usb_device *udev = to_usb_device(dev);
215	const char *p = auto_string;
216
217	if (udev->state == USB_STATE_SUSPENDED) {
218		if (udev->autoresume_disabled)
219			p = suspend_string;
220	} else {
221		if (udev->autosuspend_disabled)
222			p = on_string;
223	}
224	return sprintf(buf, "%s\n", p);
225}
226
227static ssize_t
228set_level(struct device *dev, struct device_attribute *attr,
229		const char *buf, size_t count)
230{
231	struct usb_device *udev = to_usb_device(dev);
232	int len = count;
233	char *cp;
234	int rc = 0;
235	int old_autosuspend_disabled, old_autoresume_disabled;
236
237	cp = memchr(buf, '\n', count);
238	if (cp)
239		len = cp - buf;
240
241	usb_lock_device(udev);
242	old_autosuspend_disabled = udev->autosuspend_disabled;
243	old_autoresume_disabled = udev->autoresume_disabled;
244
245	/* Setting the flags without calling usb_pm_lock is a subject to
246	 * races, but who cares...
247	 */
248	if (len == sizeof on_string - 1 &&
249			strncmp(buf, on_string, len) == 0) {
250		udev->autosuspend_disabled = 1;
251		udev->autoresume_disabled = 0;
252		rc = usb_external_resume_device(udev);
253
254	} else if (len == sizeof auto_string - 1 &&
255			strncmp(buf, auto_string, len) == 0) {
256		udev->autosuspend_disabled = 0;
257		udev->autoresume_disabled = 0;
258		rc = usb_external_resume_device(udev);
259
260	} else if (len == sizeof suspend_string - 1 &&
261			strncmp(buf, suspend_string, len) == 0) {
262		udev->autosuspend_disabled = 0;
263		udev->autoresume_disabled = 1;
264		rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
265
266	} else
267		rc = -EINVAL;
268
269	if (rc) {
270		udev->autosuspend_disabled = old_autosuspend_disabled;
271		udev->autoresume_disabled = old_autoresume_disabled;
272	}
273	usb_unlock_device(udev);
274	return (rc < 0 ? rc : count);
275}
276
277static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
278
279static char power_group[] = "power";
280
281static int add_power_attributes(struct device *dev)
282{
283	int rc = 0;
284
285	if (is_usb_device(dev)) {
286		rc = sysfs_add_file_to_group(&dev->kobj,
287				&dev_attr_autosuspend.attr,
288				power_group);
289		if (rc == 0)
290			rc = sysfs_add_file_to_group(&dev->kobj,
291					&dev_attr_level.attr,
292					power_group);
293	}
294	return rc;
295}
296
297static void remove_power_attributes(struct device *dev)
298{
299	sysfs_remove_file_from_group(&dev->kobj,
300			&dev_attr_level.attr,
301			power_group);
302	sysfs_remove_file_from_group(&dev->kobj,
303			&dev_attr_autosuspend.attr,
304			power_group);
305}
306
307#else
308
309#define add_power_attributes(dev)	0
310#define remove_power_attributes(dev)	do {} while (0)
311
312#endif	/* CONFIG_USB_SUSPEND */
313
314/* Descriptor fields */
315#define usb_descriptor_attr_le16(field, format_string)			\
316static ssize_t								\
317show_##field(struct device *dev, struct device_attribute *attr,	\
318		char *buf)						\
319{									\
320	struct usb_device *udev;					\
321									\
322	udev = to_usb_device(dev);					\
323	return sprintf(buf, format_string, 				\
324			le16_to_cpu(udev->descriptor.field));		\
325}									\
326static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
327
328usb_descriptor_attr_le16(idVendor, "%04x\n")
329usb_descriptor_attr_le16(idProduct, "%04x\n")
330usb_descriptor_attr_le16(bcdDevice, "%04x\n")
331
332#define usb_descriptor_attr(field, format_string)			\
333static ssize_t								\
334show_##field(struct device *dev, struct device_attribute *attr,	\
335		char *buf)						\
336{									\
337	struct usb_device *udev;					\
338									\
339	udev = to_usb_device(dev);					\
340	return sprintf(buf, format_string, udev->descriptor.field);	\
341}									\
342static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
343
344usb_descriptor_attr(bDeviceClass, "%02x\n")
345usb_descriptor_attr(bDeviceSubClass, "%02x\n")
346usb_descriptor_attr(bDeviceProtocol, "%02x\n")
347usb_descriptor_attr(bNumConfigurations, "%d\n")
348usb_descriptor_attr(bMaxPacketSize0, "%d\n")
349
350static struct attribute *dev_attrs[] = {
351	/* current configuration's attributes */
352	&dev_attr_configuration.attr,
353	&dev_attr_bNumInterfaces.attr,
354	&dev_attr_bConfigurationValue.attr,
355	&dev_attr_bmAttributes.attr,
356	&dev_attr_bMaxPower.attr,
357	/* device attributes */
358	&dev_attr_idVendor.attr,
359	&dev_attr_idProduct.attr,
360	&dev_attr_bcdDevice.attr,
361	&dev_attr_bDeviceClass.attr,
362	&dev_attr_bDeviceSubClass.attr,
363	&dev_attr_bDeviceProtocol.attr,
364	&dev_attr_bNumConfigurations.attr,
365	&dev_attr_bMaxPacketSize0.attr,
366	&dev_attr_speed.attr,
367	&dev_attr_busnum.attr,
368	&dev_attr_devnum.attr,
369	&dev_attr_version.attr,
370	&dev_attr_maxchild.attr,
371	&dev_attr_quirks.attr,
372	NULL,
373};
374static struct attribute_group dev_attr_grp = {
375	.attrs = dev_attrs,
376};
377
378int usb_create_sysfs_dev_files(struct usb_device *udev)
379{
380	struct device *dev = &udev->dev;
381	int retval;
382
383	retval = sysfs_create_group(&dev->kobj, &dev_attr_grp);
384	if (retval)
385		return retval;
386
387	retval = add_power_attributes(dev);
388	if (retval)
389		goto error;
390
391	if (udev->manufacturer) {
392		retval = device_create_file(dev, &dev_attr_manufacturer);
393		if (retval)
394			goto error;
395	}
396	if (udev->product) {
397		retval = device_create_file(dev, &dev_attr_product);
398		if (retval)
399			goto error;
400	}
401	if (udev->serial) {
402		retval = device_create_file(dev, &dev_attr_serial);
403		if (retval)
404			goto error;
405	}
406	retval = usb_create_ep_files(dev, &udev->ep0, udev);
407	if (retval)
408		goto error;
409	return 0;
410error:
411	usb_remove_sysfs_dev_files(udev);
412	return retval;
413}
414
415void usb_remove_sysfs_dev_files(struct usb_device *udev)
416{
417	struct device *dev = &udev->dev;
418
419	usb_remove_ep_files(&udev->ep0);
420	device_remove_file(dev, &dev_attr_manufacturer);
421	device_remove_file(dev, &dev_attr_product);
422	device_remove_file(dev, &dev_attr_serial);
423	remove_power_attributes(dev);
424	sysfs_remove_group(&dev->kobj, &dev_attr_grp);
425}
426
427/* Interface fields */
428#define usb_intf_attr(field, format_string)				\
429static ssize_t								\
430show_##field(struct device *dev, struct device_attribute *attr,	\
431		char *buf)						\
432{									\
433	struct usb_interface *intf = to_usb_interface(dev);		\
434									\
435	return sprintf(buf, format_string,				\
436			intf->cur_altsetting->desc.field); 		\
437}									\
438static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
439
440usb_intf_attr(bInterfaceNumber, "%02x\n")
441usb_intf_attr(bAlternateSetting, "%2d\n")
442usb_intf_attr(bNumEndpoints, "%02x\n")
443usb_intf_attr(bInterfaceClass, "%02x\n")
444usb_intf_attr(bInterfaceSubClass, "%02x\n")
445usb_intf_attr(bInterfaceProtocol, "%02x\n")
446
447static ssize_t show_interface_string(struct device *dev,
448		struct device_attribute *attr, char *buf)
449{
450	struct usb_interface *intf;
451	struct usb_device *udev;
452	int len;
453
454	intf = to_usb_interface(dev);
455	udev = interface_to_usbdev(intf);
456	len = snprintf(buf, 256, "%s", intf->cur_altsetting->string);
457	if (len < 0)
458		return 0;
459	buf[len] = '\n';
460	buf[len+1] = 0;
461	return len+1;
462}
463static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
464
465static ssize_t show_modalias(struct device *dev,
466		struct device_attribute *attr, char *buf)
467{
468	struct usb_interface *intf;
469	struct usb_device *udev;
470	struct usb_host_interface *alt;
471
472	intf = to_usb_interface(dev);
473	udev = interface_to_usbdev(intf);
474	alt = intf->cur_altsetting;
475
476	return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
477			"ic%02Xisc%02Xip%02X\n",
478			le16_to_cpu(udev->descriptor.idVendor),
479			le16_to_cpu(udev->descriptor.idProduct),
480			le16_to_cpu(udev->descriptor.bcdDevice),
481			udev->descriptor.bDeviceClass,
482			udev->descriptor.bDeviceSubClass,
483			udev->descriptor.bDeviceProtocol,
484			alt->desc.bInterfaceClass,
485			alt->desc.bInterfaceSubClass,
486			alt->desc.bInterfaceProtocol);
487}
488static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
489
490static struct attribute *intf_attrs[] = {
491	&dev_attr_bInterfaceNumber.attr,
492	&dev_attr_bAlternateSetting.attr,
493	&dev_attr_bNumEndpoints.attr,
494	&dev_attr_bInterfaceClass.attr,
495	&dev_attr_bInterfaceSubClass.attr,
496	&dev_attr_bInterfaceProtocol.attr,
497	&dev_attr_modalias.attr,
498	NULL,
499};
500static struct attribute_group intf_attr_grp = {
501	.attrs = intf_attrs,
502};
503
504static inline void usb_create_intf_ep_files(struct usb_interface *intf,
505		struct usb_device *udev)
506{
507	struct usb_host_interface *iface_desc;
508	int i;
509
510	iface_desc = intf->cur_altsetting;
511	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
512		usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
513				udev);
514}
515
516static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
517{
518	struct usb_host_interface *iface_desc;
519	int i;
520
521	iface_desc = intf->cur_altsetting;
522	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
523		usb_remove_ep_files(&iface_desc->endpoint[i]);
524}
525
526int usb_create_sysfs_intf_files(struct usb_interface *intf)
527{
528	struct device *dev = &intf->dev;
529	struct usb_device *udev = interface_to_usbdev(intf);
530	struct usb_host_interface *alt = intf->cur_altsetting;
531	int retval;
532
533	retval = sysfs_create_group(&dev->kobj, &intf_attr_grp);
534	if (retval)
535		return retval;
536
537	if (alt->string == NULL)
538		alt->string = usb_cache_string(udev, alt->desc.iInterface);
539	if (alt->string)
540		retval = device_create_file(dev, &dev_attr_interface);
541	usb_create_intf_ep_files(intf, udev);
542	return 0;
543}
544
545void usb_remove_sysfs_intf_files(struct usb_interface *intf)
546{
547	struct device *dev = &intf->dev;
548
549	usb_remove_intf_ep_files(intf);
550	device_remove_file(dev, &dev_attr_interface);
551	sysfs_remove_group(&dev->kobj, &intf_attr_grp);
552}
553