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>
64 #define MAX_TOPO_LEVEL 6
66 /* Define ALLOW_SERIAL_NUMBER if you want to see the serial number of devices */
67 #define ALLOW_SERIAL_NUMBER
69 static char *format_topo =
70 /* T: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=ddd MxCh=dd */
71 "\nT: Bus=%2.2d Lev=%2.2d Prnt=%2.2d Port=%2.2d Cnt=%2.2d Dev#=%3d Spd=%3s MxCh=%2d\n";
73 static char *format_string_manufacturer =
74 /* S: Manufacturer=xxxx */
75 "S: Manufacturer=%.100s\n";
77 static char *format_string_product =
79 "S: Product=%.100s\n";
81 #ifdef ALLOW_SERIAL_NUMBER
82 static char *format_string_serialnumber =
83 /* S: SerialNumber=xxxx */
84 "S: SerialNumber=%.100s\n";
87 static char *format_bandwidth =
88 /* B: Alloc=ddd/ddd us (xx%), #Int=ddd, #Iso=ddd */
89 "B: Alloc=%3d/%3d us (%2d%%), #Int=%3d, #Iso=%3d\n";
91 static char *format_device1 =
92 /* D: Ver=xx.xx Cls=xx(sssss) Sub=xx Prot=xx MxPS=dd #Cfgs=dd */
93 "D: Ver=%2x.%02x Cls=%02x(%-5s) Sub=%02x Prot=%02x MxPS=%2d #Cfgs=%3d\n";
95 static char *format_device2 =
96 /* P: Vendor=xxxx ProdID=xxxx Rev=xx.xx */
97 "P: Vendor=%04x ProdID=%04x Rev=%2x.%02x\n";
99 static char *format_config =
100 /* C: #Ifs=dd Cfg#=dd Atr=xx MPwr=dddmA */
101 "C:%c #Ifs=%2d Cfg#=%2d Atr=%02x MxPwr=%3dmA\n";
103 static char *format_iface =
104 /* I: If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx Driver=xxxx*/
105 "I: If#=%2d Alt=%2d #EPs=%2d Cls=%02x(%-5s) Sub=%02x Prot=%02x Driver=%s\n";
107 static char *format_endpt =
108 /* E: Ad=xx(s) Atr=xx(ssss) MxPS=dddd Ivl=D?s */
109 "E: Ad=%02x(%c) Atr=%02x(%-4s) MxPS=%4d Ivl=%d%cs\n";
113 * Need access to the driver and USB bus lists.
114 * extern struct list_head usb_bus_list;
115 * However, these will come from functions that return ptrs to each of them.
118 static DECLARE_WAIT_QUEUE_HEAD(deviceconndiscwq);
119 static unsigned int conndiscevcnt = 0;
121 /* this struct stores the poll state for <mountpoint>/devices pollers */
122 struct usb_device_status {
131 static const struct class_info clas_info[] =
132 { /* max. 5 chars. per name string */
133 {USB_CLASS_PER_INTERFACE, ">ifc"},
134 {USB_CLASS_AUDIO, "audio"},
135 {USB_CLASS_COMM, "comm."},
136 {USB_CLASS_HID, "HID"},
137 {USB_CLASS_HUB, "hub"},
138 {USB_CLASS_PHYSICAL, "PID"},
139 {USB_CLASS_PRINTER, "print"},
140 {USB_CLASS_MASS_STORAGE, "stor."},
141 {USB_CLASS_CDC_DATA, "data"},
142 {USB_CLASS_APP_SPEC, "app."},
143 {USB_CLASS_VENDOR_SPEC, "vend."},
144 {USB_CLASS_STILL_IMAGE, "still"},
145 {USB_CLASS_CSCID, "scard"},
146 {USB_CLASS_CONTENT_SEC, "c-sec"},
147 {-1, "unk."} /* leave as last */
150 /*****************************************************************/
152 void usbdevfs_conn_disc_event(void)
155 wake_up(&deviceconndiscwq);
158 static const char *class_decode(const int class)
162 for (ix = 0; clas_info[ix].class != -1; ix++)
163 if (clas_info[ix].class == class)
165 return (clas_info[ix].class_name);
168 static char *usb_dump_endpoint_descriptor (
172 const struct usb_endpoint_descriptor *desc
175 char dir, unit, *type;
176 unsigned interval, in, bandwidth = 1;
180 in = (desc->bEndpointAddress & USB_DIR_IN);
181 dir = in ? 'I' : 'O';
182 if (speed == USB_SPEED_HIGH) {
183 switch (desc->wMaxPacketSize & (0x03 << 11)) {
184 case 1 << 11: bandwidth = 2; break;
185 case 2 << 11: bandwidth = 3; break;
189 /* this isn't checking for illegal values */
190 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
191 case USB_ENDPOINT_XFER_CONTROL:
193 if (speed == USB_SPEED_HIGH) /* uframes per NAK */
194 interval = desc->bInterval;
197 dir = 'B'; /* ctrl is bidirectional */
199 case USB_ENDPOINT_XFER_ISOC:
201 interval = 1 << (desc->bInterval - 1);
203 case USB_ENDPOINT_XFER_BULK:
205 if (speed == USB_SPEED_HIGH && !in) /* uframes per NAK */
206 interval = desc->bInterval;
210 case USB_ENDPOINT_XFER_INT:
212 if (speed == USB_SPEED_HIGH) {
213 interval = 1 << (desc->bInterval - 1);
215 interval = desc->bInterval;
217 default: /* "can't happen" */
220 interval *= (speed == USB_SPEED_HIGH) ? 125 : 1000;
228 start += sprintf(start, format_endpt, desc->bEndpointAddress, dir,
229 desc->bmAttributes, type,
230 (desc->wMaxPacketSize & 0x07ff) * bandwidth,
235 static char *usb_dump_interface_descriptor(char *start, char *end, const struct usb_interface *iface, int setno)
237 struct usb_interface_descriptor *desc = &iface->altsetting[setno].desc;
241 down_read(&usb_bus_type.subsys.rwsem);
242 start += sprintf(start, format_iface,
243 desc->bInterfaceNumber,
244 desc->bAlternateSetting,
246 desc->bInterfaceClass,
247 class_decode(desc->bInterfaceClass),
248 desc->bInterfaceSubClass,
249 desc->bInterfaceProtocol,
251 ? iface->dev.driver->name
253 up_read(&usb_bus_type.subsys.rwsem);
257 static char *usb_dump_interface(
261 const struct usb_interface *iface,
264 struct usb_host_interface *desc = &iface->altsetting[setno];
267 start = usb_dump_interface_descriptor(start, end, iface, setno);
268 for (i = 0; i < desc->desc.bNumEndpoints; i++) {
271 start = usb_dump_endpoint_descriptor(speed,
272 start, end, &desc->endpoint[i].desc);
279 * 1. marking active config and ifaces (code lists all, but should mark
280 * which ones are active, if any)
281 * 2. add <halted> status to each endpoint line
284 static char *usb_dump_config_descriptor(char *start, char *end, const struct usb_config_descriptor *desc, int active)
288 start += sprintf(start, format_config,
289 active ? '*' : ' ', /* mark active/actual/current cfg. */
290 desc->bNumInterfaces,
291 desc->bConfigurationValue,
293 desc->bMaxPower * 2);
297 static char *usb_dump_config (
301 const struct usb_host_config *config,
306 struct usb_interface *interface;
310 if (!config) /* getting these some in 2.3.7; none in 2.3.6 */
311 return start + sprintf(start, "(null Cfg. desc.)\n");
312 start = usb_dump_config_descriptor(start, end, &config->desc, active);
313 for (i = 0; i < config->desc.bNumInterfaces; i++) {
314 interface = config->interface[i];
317 for (j = 0; j < interface->num_altsetting; j++) {
320 start = usb_dump_interface(speed,
321 start, end, interface, j);
328 * Dump the different USB descriptors.
330 static char *usb_dump_device_descriptor(char *start, char *end, const struct usb_device_descriptor *desc)
334 start += sprintf (start, format_device1,
335 desc->bcdUSB >> 8, desc->bcdUSB & 0xff,
337 class_decode (desc->bDeviceClass),
338 desc->bDeviceSubClass,
339 desc->bDeviceProtocol,
340 desc->bMaxPacketSize0,
341 desc->bNumConfigurations);
344 start += sprintf(start, format_device2,
345 desc->idVendor, desc->idProduct,
346 desc->bcdDevice >> 8, desc->bcdDevice & 0xff);
351 * Dump the different strings that this device holds.
353 static char *usb_dump_device_strings (char *start, char *end, struct usb_device *dev)
359 buf = kmalloc(128, GFP_KERNEL);
362 if (dev->descriptor.iManufacturer) {
363 if (usb_string(dev, dev->descriptor.iManufacturer, buf, 128) > 0)
364 start += sprintf(start, format_string_manufacturer, buf);
368 if (dev->descriptor.iProduct) {
369 if (usb_string(dev, dev->descriptor.iProduct, buf, 128) > 0)
370 start += sprintf(start, format_string_product, buf);
374 #ifdef ALLOW_SERIAL_NUMBER
375 if (dev->descriptor.iSerialNumber) {
376 if (usb_string(dev, dev->descriptor.iSerialNumber, buf, 128) > 0)
377 start += sprintf(start, format_string_serialnumber, buf);
385 static char *usb_dump_desc(char *start, char *end, struct usb_device *dev)
392 start = usb_dump_device_descriptor(start, end, &dev->descriptor);
397 start = usb_dump_device_strings (start, end, dev);
399 for (i = 0; i < dev->descriptor.bNumConfigurations; i++) {
402 start = usb_dump_config(dev->speed,
403 start, end, dev->config + i,
405 (dev->config + i) == dev->actconfig);
411 #ifdef PROC_EXTRA /* TBD: may want to add this code later */
413 static char *usb_dump_hub_descriptor(char *start, char *end, const struct usb_hub_descriptor * desc)
415 int leng = USB_DT_HUB_NONVAR_SIZE;
416 unsigned char *ptr = (unsigned char *)desc;
420 start += sprintf(start, "Interface:");
421 while (leng && start <= end) {
422 start += sprintf(start, " %02x", *ptr);
429 static char *usb_dump_string(char *start, char *end, const struct usb_device *dev, char *id, int index)
433 start += sprintf(start, "Interface:");
434 if (index <= dev->maxstring && dev->stringindex && dev->stringindex[index])
435 start += sprintf(start, "%s: %.100s ", id, dev->stringindex[index]);
439 #endif /* PROC_EXTRA */
441 /*****************************************************************/
443 /* This is a recursive function. Parameters:
444 * buffer - the user-space buffer to write data into
445 * nbytes - the maximum number of bytes to write
446 * skip_bytes - the number of bytes to skip before writing anything
447 * file_offset - the offset into the devices file on completion
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)
464 return total_written;
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);
532 if (total_written == 0)
534 return total_written;
537 *file_offset += length;
538 total_written += length;
542 *skip_bytes -= length;
544 free_pages((unsigned long)pages_start, 1);
546 /* Now look at all of this device's children. */
547 for (chix = 0; chix < usbdev->maxchild; chix++) {
548 if (usbdev->children[chix]) {
549 ret = usb_device_dump(buffer, nbytes, skip_bytes, file_offset, usbdev->children[chix],
550 bus, level + 1, chix, ++cnt);
552 return total_written;
553 total_written += ret;
556 return total_written;
559 static ssize_t usb_device_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
561 struct list_head *buslist;
563 ssize_t ret, total_written = 0;
564 loff_t skip_bytes = *ppos;
570 if (!access_ok(VERIFY_WRITE, buf, nbytes))
573 /* enumerate busses */
574 down (&usb_bus_list_lock);
575 for (buslist = usb_bus_list.next; buslist != &usb_bus_list; buslist = buslist->next) {
576 /* print devices for this bus */
577 bus = list_entry(buslist, struct usb_bus, bus_list);
578 /* recurse through all children of the root hub */
579 ret = usb_device_dump(&buf, &nbytes, &skip_bytes, ppos, bus->root_hub, bus, 0, 0, 0);
581 up(&usb_bus_list_lock);
584 total_written += ret;
586 up (&usb_bus_list_lock);
587 return total_written;
590 /* Kernel lock for "lastev" protection */
591 static unsigned int usb_device_poll(struct file *file, struct poll_table_struct *wait)
593 struct usb_device_status *st = (struct usb_device_status *)file->private_data;
594 unsigned int mask = 0;
598 st = kmalloc(sizeof(struct usb_device_status), GFP_KERNEL);
604 /* we may have dropped BKL - need to check for having lost the race */
605 if (file->private_data) {
611 * need to prevent the module from being unloaded, since
612 * proc_unregister does not call the release method and
613 * we would have a memory leak
615 st->lastev = conndiscevcnt;
616 file->private_data = st;
620 if (file->f_mode & FMODE_READ)
621 poll_wait(file, &deviceconndiscwq, wait);
622 if (st->lastev != conndiscevcnt)
624 st->lastev = conndiscevcnt;
629 static int usb_device_open(struct inode *inode, struct file *file)
631 file->private_data = NULL;
635 static int usb_device_release(struct inode *inode, struct file *file)
637 if (file->private_data) {
638 kfree(file->private_data);
639 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 usbdevfs_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,