3 * (C) Copyright 1999 Randy Dunlap.
4 * (C) Copyright 1999,2000 Thomas Sailer <sailer@ife.ee.ethz.ch>. (proc file per device)
5 * (C) Copyright 1999 Deti Fliegl (new USB architecture)
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 *************************************************************
23 * <mountpoint>/devices contains USB topology, device, config, class,
24 * interface, & endpoint data.
26 * I considered using /proc/bus/usb/devices/device# for each device
27 * as it is attached or detached, but I didn't like this for some
28 * reason -- maybe it's just too deep of a directory structure.
29 * I also don't like looking in multiple places to gather and view
30 * the data. Having only one file for ./devices also prevents race
31 * conditions that could arise if a program was reading device info
32 * for devices that are being removed (unplugged). (That is, the
33 * program may find a directory for devnum_12 then try to open it,
34 * but it was just unplugged, so the directory is now deleted.
35 * But programs would just have to be prepared for situations like
36 * this in any plug-and-play environment.)
38 * 1999-12-16: Thomas Sailer <sailer@ife.ee.ethz.ch>
39 * Converted the whole proc stuff to real
40 * read methods. Now not the whole device list needs to fit
41 * into one page, only the device list for one bus.
42 * Added a poll method to /proc/bus/usb/devices, to wake
44 * 2000-01-04: Thomas Sailer <sailer@ife.ee.ethz.ch>
45 * Turned into its own filesystem
46 * 2000-07-05: Ashley Montanaro <ashley@compsoc.man.ac.uk>
47 * Converted file reading routine to dump to buffer once
48 * per device, not per bus
50 * $Id: devices.c,v 1.5 2000/01/11 13:58:21 tom Exp $
55 #include <linux/slab.h>
56 #include <linux/poll.h>
57 #include <linux/usb.h>
58 #include <linux/smp_lock.h>
59 #include <linux/usbdevice_fs.h>
60 #include <asm/uaccess.h>
65 #define MAX_TOPO_LEVEL 6
67 /* Define ALLOW_SERIAL_NUMBER if you want to see the serial number of devices */
68 #define ALLOW_SERIAL_NUMBER
70 static char *format_topo =
71 /* T: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=ddd MxCh=dd */
72 "\nT: Bus=%2.2d Lev=%2.2d Prnt=%2.2d Port=%2.2d Cnt=%2.2d Dev#=%3d Spd=%3s MxCh=%2d\n";
74 static char *format_string_manufacturer =
75 /* S: Manufacturer=xxxx */
76 "S: Manufacturer=%.100s\n";
78 static char *format_string_product =
80 "S: Product=%.100s\n";
82 #ifdef ALLOW_SERIAL_NUMBER
83 static char *format_string_serialnumber =
84 /* S: SerialNumber=xxxx */
85 "S: SerialNumber=%.100s\n";
88 static char *format_bandwidth =
89 /* B: Alloc=ddd/ddd us (xx%), #Int=ddd, #Iso=ddd */
90 "B: Alloc=%3d/%3d us (%2d%%), #Int=%3d, #Iso=%3d\n";
92 static char *format_device1 =
93 /* D: Ver=xx.xx Cls=xx(sssss) Sub=xx Prot=xx MxPS=dd #Cfgs=dd */
94 "D: Ver=%2x.%02x Cls=%02x(%-5s) Sub=%02x Prot=%02x MxPS=%2d #Cfgs=%3d\n";
96 static char *format_device2 =
97 /* P: Vendor=xxxx ProdID=xxxx Rev=xx.xx */
98 "P: Vendor=%04x ProdID=%04x Rev=%2x.%02x\n";
100 static char *format_config =
101 /* C: #Ifs=dd Cfg#=dd Atr=xx MPwr=dddmA */
102 "C:%c #Ifs=%2d Cfg#=%2d Atr=%02x MxPwr=%3dmA\n";
104 static char *format_iface =
105 /* I: If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx Driver=xxxx*/
106 "I: If#=%2d Alt=%2d #EPs=%2d Cls=%02x(%-5s) Sub=%02x Prot=%02x Driver=%s\n";
108 static char *format_endpt =
109 /* E: Ad=xx(s) Atr=xx(ssss) MxPS=dddd Ivl=D?s */
110 "E: Ad=%02x(%c) Atr=%02x(%-4s) MxPS=%4d Ivl=%d%cs\n";
114 * Need access to the driver and USB bus lists.
115 * extern struct list_head usb_bus_list;
116 * However, these will come from functions that return ptrs to each of them.
119 static DECLARE_WAIT_QUEUE_HEAD(deviceconndiscwq);
120 static unsigned int conndiscevcnt = 0;
122 /* this struct stores the poll state for <mountpoint>/devices pollers */
123 struct usb_device_status {
132 static const struct class_info clas_info[] =
133 { /* max. 5 chars. per name string */
134 {USB_CLASS_PER_INTERFACE, ">ifc"},
135 {USB_CLASS_AUDIO, "audio"},
136 {USB_CLASS_COMM, "comm."},
137 {USB_CLASS_HID, "HID"},
138 {USB_CLASS_HUB, "hub"},
139 {USB_CLASS_PHYSICAL, "PID"},
140 {USB_CLASS_PRINTER, "print"},
141 {USB_CLASS_MASS_STORAGE, "stor."},
142 {USB_CLASS_CDC_DATA, "data"},
143 {USB_CLASS_APP_SPEC, "app."},
144 {USB_CLASS_VENDOR_SPEC, "vend."},
145 {USB_CLASS_STILL_IMAGE, "still"},
146 {USB_CLASS_CSCID, "scard"},
147 {USB_CLASS_CONTENT_SEC, "c-sec"},
148 {-1, "unk."} /* leave as last */
151 /*****************************************************************/
153 void usbfs_conn_disc_event(void)
156 wake_up(&deviceconndiscwq);
159 static const char *class_decode(const int class)
163 for (ix = 0; clas_info[ix].class != -1; ix++)
164 if (clas_info[ix].class == class)
166 return (clas_info[ix].class_name);
169 static char *usb_dump_endpoint_descriptor (
173 const struct usb_endpoint_descriptor *desc
176 char dir, unit, *type;
177 unsigned interval, in, bandwidth = 1;
181 in = (desc->bEndpointAddress & USB_DIR_IN);
182 dir = in ? 'I' : 'O';
183 if (speed == USB_SPEED_HIGH) {
184 switch (le16_to_cpu(desc->wMaxPacketSize) & (0x03 << 11)) {
185 case 1 << 11: bandwidth = 2; break;
186 case 2 << 11: bandwidth = 3; break;
190 /* this isn't checking for illegal values */
191 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
192 case USB_ENDPOINT_XFER_CONTROL:
194 if (speed == USB_SPEED_HIGH) /* uframes per NAK */
195 interval = desc->bInterval;
198 dir = 'B'; /* ctrl is bidirectional */
200 case USB_ENDPOINT_XFER_ISOC:
202 interval = 1 << (desc->bInterval - 1);
204 case USB_ENDPOINT_XFER_BULK:
206 if (speed == USB_SPEED_HIGH && !in) /* uframes per NAK */
207 interval = desc->bInterval;
211 case USB_ENDPOINT_XFER_INT:
213 if (speed == USB_SPEED_HIGH) {
214 interval = 1 << (desc->bInterval - 1);
216 interval = desc->bInterval;
218 default: /* "can't happen" */
221 interval *= (speed == USB_SPEED_HIGH) ? 125 : 1000;
229 start += sprintf(start, format_endpt, desc->bEndpointAddress, dir,
230 desc->bmAttributes, type,
231 (le16_to_cpu(desc->wMaxPacketSize) & 0x07ff) * bandwidth,
236 static char *usb_dump_interface_descriptor(char *start, char *end,
237 const struct usb_interface_cache *intfc,
238 const struct usb_interface *iface,
241 const struct usb_interface_descriptor *desc = &intfc->altsetting[setno].desc;
242 const char *driver_name = "";
246 down_read(&usb_bus_type.subsys.rwsem);
248 driver_name = (iface->dev.driver
249 ? iface->dev.driver->name
251 start += sprintf(start, format_iface,
252 desc->bInterfaceNumber,
253 desc->bAlternateSetting,
255 desc->bInterfaceClass,
256 class_decode(desc->bInterfaceClass),
257 desc->bInterfaceSubClass,
258 desc->bInterfaceProtocol,
260 up_read(&usb_bus_type.subsys.rwsem);
264 static char *usb_dump_interface(
268 const struct usb_interface_cache *intfc,
269 const struct usb_interface *iface,
272 const struct usb_host_interface *desc = &intfc->altsetting[setno];
275 start = usb_dump_interface_descriptor(start, end, intfc, iface, setno);
276 for (i = 0; i < desc->desc.bNumEndpoints; i++) {
279 start = usb_dump_endpoint_descriptor(speed,
280 start, end, &desc->endpoint[i].desc);
287 * 1. marking active interface altsettings (code lists all, but should mark
288 * which ones are active, if any)
291 static char *usb_dump_config_descriptor(char *start, char *end, const struct usb_config_descriptor *desc, int active)
295 start += sprintf(start, format_config,
296 active ? '*' : ' ', /* mark active/actual/current cfg. */
297 desc->bNumInterfaces,
298 desc->bConfigurationValue,
300 desc->bMaxPower * 2);
304 static char *usb_dump_config (
308 const struct usb_host_config *config,
313 struct usb_interface_cache *intfc;
314 struct usb_interface *interface;
318 if (!config) /* getting these some in 2.3.7; none in 2.3.6 */
319 return start + sprintf(start, "(null Cfg. desc.)\n");
320 start = usb_dump_config_descriptor(start, end, &config->desc, active);
321 for (i = 0; i < config->desc.bNumInterfaces; i++) {
322 intfc = config->intf_cache[i];
323 interface = config->interface[i];
324 for (j = 0; j < intfc->num_altsetting; j++) {
327 start = usb_dump_interface(speed,
328 start, end, intfc, interface, j);
335 * Dump the different USB descriptors.
337 static char *usb_dump_device_descriptor(char *start, char *end, const struct usb_device_descriptor *desc)
339 u16 bcdUSB = le16_to_cpu(desc->bcdUSB);
340 u16 bcdDevice = le16_to_cpu(desc->bcdDevice);
344 start += sprintf (start, format_device1,
345 bcdUSB >> 8, bcdUSB & 0xff,
347 class_decode (desc->bDeviceClass),
348 desc->bDeviceSubClass,
349 desc->bDeviceProtocol,
350 desc->bMaxPacketSize0,
351 desc->bNumConfigurations);
354 start += sprintf(start, format_device2,
355 le16_to_cpu(desc->idVendor),
356 le16_to_cpu(desc->idProduct),
357 bcdDevice >> 8, bcdDevice & 0xff);
362 * Dump the different strings that this device holds.
364 static char *usb_dump_device_strings (char *start, char *end, struct usb_device *dev)
368 if (dev->manufacturer)
369 start += sprintf(start, format_string_manufacturer, dev->manufacturer);
373 start += sprintf(start, format_string_product, dev->product);
376 #ifdef ALLOW_SERIAL_NUMBER
378 start += sprintf(start, format_string_serialnumber, dev->serial);
384 static char *usb_dump_desc(char *start, char *end, struct usb_device *dev)
391 start = usb_dump_device_descriptor(start, end, &dev->descriptor);
396 start = usb_dump_device_strings (start, end, dev);
398 for (i = 0; i < dev->descriptor.bNumConfigurations; i++) {
401 start = usb_dump_config(dev->speed,
402 start, end, dev->config + i,
404 (dev->config + i) == dev->actconfig);
410 #ifdef PROC_EXTRA /* TBD: may want to add this code later */
412 static char *usb_dump_hub_descriptor(char *start, char *end, const struct usb_hub_descriptor * desc)
414 int leng = USB_DT_HUB_NONVAR_SIZE;
415 unsigned char *ptr = (unsigned char *)desc;
419 start += sprintf(start, "Interface:");
420 while (leng && start <= end) {
421 start += sprintf(start, " %02x", *ptr);
428 static char *usb_dump_string(char *start, char *end, const struct usb_device *dev, char *id, int index)
432 start += sprintf(start, "Interface:");
433 if (index <= dev->maxstring && dev->stringindex && dev->stringindex[index])
434 start += sprintf(start, "%s: %.100s ", id, dev->stringindex[index]);
438 #endif /* PROC_EXTRA */
440 /*****************************************************************/
442 /* This is a recursive function. Parameters:
443 * buffer - the user-space buffer to write data into
444 * nbytes - the maximum number of bytes to write
445 * skip_bytes - the number of bytes to skip before writing anything
446 * file_offset - the offset into the devices file on completion
447 * The caller must own the device lock.
449 static ssize_t usb_device_dump(char __user **buffer, size_t *nbytes, loff_t *skip_bytes, loff_t *file_offset,
450 struct usb_device *usbdev, struct usb_bus *bus, int level, int index, int count)
454 int parent_devnum = 0;
455 char *pages_start, *data_end, *speed;
457 ssize_t total_written = 0;
459 /* don't bother with anything else if we're not writing any data */
463 if (level > MAX_TOPO_LEVEL)
465 /* allocate 2^1 pages = 8K (on i386); should be more than enough for one device */
466 if (!(pages_start = (char*) __get_free_pages(GFP_KERNEL,1)))
469 if (usbdev->parent && usbdev->parent->devnum != -1)
470 parent_devnum = usbdev->parent->devnum;
472 * So the root hub's parent is 0 and any device that is
473 * plugged into the root hub has a parent of 0.
475 switch (usbdev->speed) {
477 speed = "1.5"; break;
478 case USB_SPEED_UNKNOWN: /* usb 1.1 root hub code */
480 speed = "12 "; break;
482 speed = "480"; break;
486 data_end = pages_start + sprintf(pages_start, format_topo,
487 bus->busnum, level, parent_devnum,
488 index, count, usbdev->devnum,
489 speed, usbdev->maxchild);
491 * level = topology-tier level;
492 * parent_devnum = parent device number;
493 * index = parent's connector number;
494 * count = device count at this level
496 /* If this is the root hub, display the bandwidth information */
500 /* high speed reserves 80%, full/low reserves 90% */
501 if (usbdev->speed == USB_SPEED_HIGH)
504 max = FRAME_TIME_MAX_USECS_ALLOC;
506 /* report "average" periodic allocation over a microsecond.
507 * the schedules are actually bursty, HCDs need to deal with
508 * that and just compute/report this average.
510 data_end += sprintf(data_end, format_bandwidth,
511 bus->bandwidth_allocated, max,
512 (100 * bus->bandwidth_allocated + max / 2)
514 bus->bandwidth_int_reqs,
515 bus->bandwidth_isoc_reqs);
518 data_end = usb_dump_desc(data_end, pages_start + (2 * PAGE_SIZE) - 256, usbdev);
520 if (data_end > (pages_start + (2 * PAGE_SIZE) - 256))
521 data_end += sprintf(data_end, "(truncated)\n");
523 length = data_end - pages_start;
524 /* if we can start copying some data to the user */
525 if (length > *skip_bytes) {
526 length -= *skip_bytes;
527 if (length > *nbytes)
529 if (copy_to_user(*buffer, pages_start + *skip_bytes, length)) {
530 free_pages((unsigned long)pages_start, 1);
534 *file_offset += length;
535 total_written += length;
539 *skip_bytes -= length;
541 free_pages((unsigned long)pages_start, 1);
543 /* Now look at all of this device's children. */
544 for (chix = 0; chix < usbdev->maxchild; chix++) {
545 struct usb_device *childdev = usbdev->children[chix];
548 down(&childdev->serialize);
549 ret = usb_device_dump(buffer, nbytes, skip_bytes, file_offset, childdev,
550 bus, level + 1, chix, ++cnt);
551 up(&childdev->serialize);
553 return total_written;
554 total_written += ret;
557 return total_written;
560 static ssize_t usb_device_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
563 ssize_t ret, total_written = 0;
564 loff_t skip_bytes = *ppos;
570 if (!access_ok(VERIFY_WRITE, buf, nbytes))
573 down (&usb_bus_list_lock);
574 /* print devices for all busses */
575 list_for_each_entry(bus, &usb_bus_list, bus_list) {
576 /* recurse through all children of the root hub */
579 usb_lock_device(bus->root_hub);
580 ret = usb_device_dump(&buf, &nbytes, &skip_bytes, ppos, bus->root_hub, bus, 0, 0, 0);
581 usb_unlock_device(bus->root_hub);
583 up(&usb_bus_list_lock);
586 total_written += ret;
588 up (&usb_bus_list_lock);
589 return total_written;
592 /* Kernel lock for "lastev" protection */
593 static unsigned int usb_device_poll(struct file *file, struct poll_table_struct *wait)
595 struct usb_device_status *st = (struct usb_device_status *)file->private_data;
596 unsigned int mask = 0;
600 st = kmalloc(sizeof(struct usb_device_status), GFP_KERNEL);
606 /* we may have dropped BKL - need to check for having lost the race */
607 if (file->private_data) {
609 st = file->private_data;
614 * need to prevent the module from being unloaded, since
615 * proc_unregister does not call the release method and
616 * we would have a memory leak
618 st->lastev = conndiscevcnt;
619 file->private_data = st;
623 if (file->f_mode & FMODE_READ)
624 poll_wait(file, &deviceconndiscwq, wait);
625 if (st->lastev != conndiscevcnt)
627 st->lastev = conndiscevcnt;
632 static int usb_device_open(struct inode *inode, struct file *file)
634 file->private_data = NULL;
638 static int usb_device_release(struct inode *inode, struct file *file)
640 kfree(file->private_data);
641 file->private_data = NULL;
645 static loff_t usb_device_lseek(struct file * file, loff_t offset, int orig)
653 file->f_pos = offset;
657 file->f_pos += offset;
669 struct file_operations usbfs_devices_fops = {
670 .llseek = usb_device_lseek,
671 .read = usb_device_read,
672 .poll = usb_device_poll,
673 .open = usb_device_open,
674 .release = usb_device_release,