1 /*
2 * devices.c
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)
6 *
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.
11 *
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.
16 *
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
20 *
21 *************************************************************
22 *
23 * <mountpoint>/devices contains USB topology, device, config, class,
24 * interface, & endpoint data.
25 *
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.)
37 *
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
43 * up an eventual usbd
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
49 *
50 * $Id: devices.c,v 1.5 2000/01/11 13:58:21 tom Exp $
51 */
52
53 #include <linux/fs.h>
54 #include <linux/mm.h>
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>
61
62 #include "hcd.h"
63
64 #define MAX_TOPO_LEVEL 6
65
66 /* Define ALLOW_SERIAL_NUMBER if you want to see the serial number of devices */
67 #define ALLOW_SERIAL_NUMBER
68
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";
72
73 static char *format_string_manufacturer =
74 /* S: Manufacturer=xxxx */
75 "S: Manufacturer=%.100s\n";
76
77 static char *format_string_product =
78 /* S: Product=xxxx */
79 "S: Product=%.100s\n";
80
81 #ifdef ALLOW_SERIAL_NUMBER
82 static char *format_string_serialnumber =
83 /* S: SerialNumber=xxxx */
84 "S: SerialNumber=%.100s\n";
85 #endif
86
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";
90
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";
94
95 static char *format_device2 =
96 /* P: Vendor=xxxx ProdID=xxxx Rev=xx.xx */
97 "P: Vendor=%04x ProdID=%04x Rev=%2x.%02x\n";
98
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";
102
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";
106
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";
110
111
112 /*
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.
116 */
117
118 static DECLARE_WAIT_QUEUE_HEAD(deviceconndiscwq);
119 static unsigned int conndiscevcnt = 0;
120
121 /* this struct stores the poll state for <mountpoint>/devices pollers */
122 struct usb_device_status {
123 unsigned int lastev;
124 };
125
126 struct class_info {
127 int class;
128 char *class_name;
129 };
130
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 */
148 };
149
150 /*****************************************************************/
151
152 void usbfs_conn_disc_event(void)
153 {
154 conndiscevcnt++;
155 wake_up(&deviceconndiscwq);
156 }
157
158 static const char *class_decode(const int class)
159 {
160 int ix;
161
162 for (ix = 0; clas_info[ix].class != -1; ix++)
163 if (clas_info[ix].class == class)
164 break;
165 return (clas_info[ix].class_name);
166 }
167
168 static char *usb_dump_endpoint_descriptor (
169 int speed,
170 char *start,
171 char *end,
172 const struct usb_endpoint_descriptor *desc
173 )
174 {
175 char dir, unit, *type;
176 unsigned interval, in, bandwidth = 1;
177
178 if (start > end)
179 return start;
180 in = (desc->bEndpointAddress & USB_DIR_IN);
181 dir = in ? 'I' : 'O';
182 if (speed == USB_SPEED_HIGH) {
183 switch (le16_to_cpu(desc->wMaxPacketSize) & (0x03 << 11)) {
184 case 1 << 11: bandwidth = 2; break;
185 case 2 << 11: bandwidth = 3; break;
186 }
187 }
188
189 /* this isn't checking for illegal values */
190 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
191 case USB_ENDPOINT_XFER_CONTROL:
192 type = "Ctrl";
193 if (speed == USB_SPEED_HIGH) /* uframes per NAK */
194 interval = desc->bInterval;
195 else
196 interval = 0;
197 dir = 'B'; /* ctrl is bidirectional */
198 break;
199 case USB_ENDPOINT_XFER_ISOC:
200 type = "Isoc";
201 interval = 1 << (desc->bInterval - 1);
202 break;
203 case USB_ENDPOINT_XFER_BULK:
204 type = "Bulk";
205 if (speed == USB_SPEED_HIGH && !in) /* uframes per NAK */
206 interval = desc->bInterval;
207 else
208 interval = 0;
209 break;
210 case USB_ENDPOINT_XFER_INT:
211 type = "Int.";
212 if (speed == USB_SPEED_HIGH) {
213 interval = 1 << (desc->bInterval - 1);
214 } else
215 interval = desc->bInterval;
216 break;
217 default: /* "can't happen" */
218 return start;
219 }
220 interval *= (speed == USB_SPEED_HIGH) ? 125 : 1000;
221 if (interval % 1000)
222 unit = 'u';
223 else {
224 unit = 'm';
225 interval /= 1000;
226 }
227
228 start += sprintf(start, format_endpt, desc->bEndpointAddress, dir,
229 desc->bmAttributes, type,
230 (le16_to_cpu(desc->wMaxPacketSize) & 0x07ff) * bandwidth,
231 interval, unit);
232 return start;
233 }
234
235 static char *usb_dump_interface_descriptor(char *start, char *end,
236 const struct usb_interface_cache *intfc,
237 const struct usb_interface *iface,
238 int setno)
239 {
240 const struct usb_interface_descriptor *desc = &intfc->altsetting[setno].desc;
241 char *driver_name = "";
242
243 if (start > end)
244 return start;
245 down_read(&usb_bus_type.subsys.rwsem);
246 if (iface)
247 driver_name = (iface->dev.driver
248 ? iface->dev.driver->name
249 : "(none)");
250 start += sprintf(start, format_iface,
251 desc->bInterfaceNumber,
252 desc->bAlternateSetting,
253 desc->bNumEndpoints,
254 desc->bInterfaceClass,
255 class_decode(desc->bInterfaceClass),
256 desc->bInterfaceSubClass,
257 desc->bInterfaceProtocol,
258 driver_name);
259 up_read(&usb_bus_type.subsys.rwsem);
260 return start;
261 }
262
263 static char *usb_dump_interface(
264 int speed,
265 char *start,
266 char *end,
267 const struct usb_interface_cache *intfc,
268 const struct usb_interface *iface,
269 int setno
270 ) {
271 const struct usb_host_interface *desc = &intfc->altsetting[setno];
272 int i;
273
274 start = usb_dump_interface_descriptor(start, end, intfc, iface, setno);
275 for (i = 0; i < desc->desc.bNumEndpoints; i++) {
276 if (start > end)
277 return start;
278 start = usb_dump_endpoint_descriptor(speed,
279 start, end, &desc->endpoint[i].desc);
280 }
281 return start;
282 }
283
284 /* TBD:
285 * 0. TBDs
286 * 1. marking active interface altsettings (code lists all, but should mark
287 * which ones are active, if any)
288 */
289
290 static char *usb_dump_config_descriptor(char *start, char *end, const struct usb_config_descriptor *desc, int active)
291 {
292 if (start > end)
293 return start;
294 start += sprintf(start, format_config,
295 active ? '*' : ' ', /* mark active/actual/current cfg. */
296 desc->bNumInterfaces,
297 desc->bConfigurationValue,
298 desc->bmAttributes,
299 desc->bMaxPower * 2);
300 return start;
301 }
302
303 static char *usb_dump_config (
304 int speed,
305 char *start,
306 char *end,
307 const struct usb_host_config *config,
308 int active
309 )
310 {
311 int i, j;
312 struct usb_interface_cache *intfc;
313 struct usb_interface *interface;
314
315 if (start > end)
316 return start;
317 if (!config) /* getting these some in 2.3.7; none in 2.3.6 */
318 return start + sprintf(start, "(null Cfg. desc.)\n");
319 start = usb_dump_config_descriptor(start, end, &config->desc, active);
320 for (i = 0; i < config->desc.bNumInterfaces; i++) {
321 intfc = config->intf_cache[i];
322 interface = config->interface[i];
323 for (j = 0; j < intfc->num_altsetting; j++) {
324 if (start > end)
325 return start;
326 start = usb_dump_interface(speed,
327 start, end, intfc, interface, j);
328 }
329 }
330 return start;
331 }
332
333 /*
334 * Dump the different USB descriptors.
335 */
336 static char *usb_dump_device_descriptor(char *start, char *end, const struct usb_device_descriptor *desc)
337 {
338 u16 bcdUSB = le16_to_cpu(desc->bcdUSB);
339 u16 bcdDevice = le16_to_cpu(desc->bcdDevice);
340
341 if (start > end)
342 return start;
343 start += sprintf (start, format_device1,
344 bcdUSB >> 8, bcdUSB & 0xff,
345 desc->bDeviceClass,
346 class_decode (desc->bDeviceClass),
347 desc->bDeviceSubClass,
348 desc->bDeviceProtocol,
349 desc->bMaxPacketSize0,
350 desc->bNumConfigurations);
351 if (start > end)
352 return start;
353 start += sprintf(start, format_device2,
354 le16_to_cpu(desc->idVendor),
355 le16_to_cpu(desc->idProduct),
356 bcdDevice >> 8, bcdDevice & 0xff);
357 return start;
358 }
359
360 /*
361 * Dump the different strings that this device holds.
362 */
363 static char *usb_dump_device_strings (char *start, char *end, struct usb_device *dev)
364 {
365 char *buf;
366
367 if (start > end)
368 return start;
369 buf = kmalloc(128, GFP_KERNEL);
370 if (!buf)
371 return start;
372 if (dev->descriptor.iManufacturer) {
373 if (usb_string(dev, dev->descriptor.iManufacturer, buf, 128) > 0)
374 start += sprintf(start, format_string_manufacturer, buf);
375 }
376 if (start > end)
377 goto out;
378 if (dev->descriptor.iProduct) {
379 if (usb_string(dev, dev->descriptor.iProduct, buf, 128) > 0)
380 start += sprintf(start, format_string_product, buf);
381 }
382 if (start > end)
383 goto out;
384 #ifdef ALLOW_SERIAL_NUMBER
385 if (dev->descriptor.iSerialNumber) {
386 if (usb_string(dev, dev->descriptor.iSerialNumber, buf, 128) > 0)
387 start += sprintf(start, format_string_serialnumber, buf);
388 }
389 #endif
390 out:
391 kfree(buf);
392 return start;
393 }
394
395 static char *usb_dump_desc(char *start, char *end, struct usb_device *dev)
396 {
397 int i;
398
399 if (start > end)
400 return start;
401
402 start = usb_dump_device_descriptor(start, end, &dev->descriptor);
403
404 if (start > end)
405 return start;
406
407 start = usb_dump_device_strings (start, end, dev);
408
409 for (i = 0; i < dev->descriptor.bNumConfigurations; i++) {
410 if (start > end)
411 return start;
412 start = usb_dump_config(dev->speed,
413 start, end, dev->config + i,
414 /* active ? */
415 (dev->config + i) == dev->actconfig);
416 }
417 return start;
418 }
419
420
421 #ifdef PROC_EXTRA /* TBD: may want to add this code later */
422
423 static char *usb_dump_hub_descriptor(char *start, char *end, const struct usb_hub_descriptor * desc)
424 {
425 int leng = USB_DT_HUB_NONVAR_SIZE;
426 unsigned char *ptr = (unsigned char *)desc;
427
428 if (start > end)
429 return start;
430 start += sprintf(start, "Interface:");
431 while (leng && start <= end) {
432 start += sprintf(start, " %02x", *ptr);
433 ptr++; leng--;
434 }
435 *start++ = '\n';
436 return start;
437 }
438
439 static char *usb_dump_string(char *start, char *end, const struct usb_device *dev, char *id, int index)
440 {
441 if (start > end)
442 return start;
443 start += sprintf(start, "Interface:");
444 if (index <= dev->maxstring && dev->stringindex && dev->stringindex[index])
445 start += sprintf(start, "%s: %.100s ", id, dev->stringindex[index]);
446 return start;
447 }
448
449 #endif /* PROC_EXTRA */
450
451 /*****************************************************************/
452
453 /* This is a recursive function. Parameters:
454 * buffer - the user-space buffer to write data into
455 * nbytes - the maximum number of bytes to write
456 * skip_bytes - the number of bytes to skip before writing anything
457 * file_offset - the offset into the devices file on completion
458 * The caller must own the device lock.
459 */
460 static ssize_t usb_device_dump(char __user **buffer, size_t *nbytes, loff_t *skip_bytes, loff_t *file_offset,
461 struct usb_device *usbdev, struct usb_bus *bus, int level, int index, int count)
462 {
463 int chix;
464 int ret, cnt = 0;
465 int parent_devnum = 0;
466 char *pages_start, *data_end, *speed;
467 unsigned int length;
468 ssize_t total_written = 0;
469
470 /* don't bother with anything else if we're not writing any data */
471 if (*nbytes <= 0)
472 return 0;
473
474 if (level > MAX_TOPO_LEVEL)
475 return total_written;
476 /* allocate 2^1 pages = 8K (on i386); should be more than enough for one device */
477 if (!(pages_start = (char*) __get_free_pages(GFP_KERNEL,1)))
478 return -ENOMEM;
479
480 if (usbdev->parent && usbdev->parent->devnum != -1)
481 parent_devnum = usbdev->parent->devnum;
482 /*
483 * So the root hub's parent is 0 and any device that is
484 * plugged into the root hub has a parent of 0.
485 */
486 switch (usbdev->speed) {
487 case USB_SPEED_LOW:
488 speed = "1.5"; break;
489 case USB_SPEED_UNKNOWN: /* usb 1.1 root hub code */
490 case USB_SPEED_FULL:
491 speed = "12 "; break;
492 case USB_SPEED_HIGH:
493 speed = "480"; break;
494 default:
495 speed = "?? ";
496 }
497 data_end = pages_start + sprintf(pages_start, format_topo,
498 bus->busnum, level, parent_devnum,
499 index, count, usbdev->devnum,
500 speed, usbdev->maxchild);
501 /*
502 * level = topology-tier level;
503 * parent_devnum = parent device number;
504 * index = parent's connector number;
505 * count = device count at this level
506 */
507 /* If this is the root hub, display the bandwidth information */
508 if (level == 0) {
509 int max;
510
511 /* high speed reserves 80%, full/low reserves 90% */
512 if (usbdev->speed == USB_SPEED_HIGH)
513 max = 800;
514 else
515 max = FRAME_TIME_MAX_USECS_ALLOC;
516
517 /* report "average" periodic allocation over a microsecond.
518 * the schedules are actually bursty, HCDs need to deal with
519 * that and just compute/report this average.
520 */
521 data_end += sprintf(data_end, format_bandwidth,
522 bus->bandwidth_allocated, max,
523 (100 * bus->bandwidth_allocated + max / 2)
524 / max,
525 bus->bandwidth_int_reqs,
526 bus->bandwidth_isoc_reqs);
527
528 }
529 data_end = usb_dump_desc(data_end, pages_start + (2 * PAGE_SIZE) - 256, usbdev);
530
531 if (data_end > (pages_start + (2 * PAGE_SIZE) - 256))
532 data_end += sprintf(data_end, "(truncated)\n");
533
534 length = data_end - pages_start;
535 /* if we can start copying some data to the user */
536 if (length > *skip_bytes) {
537 length -= *skip_bytes;
538 if (length > *nbytes)
539 length = *nbytes;
540 if (copy_to_user(*buffer, pages_start + *skip_bytes, length)) {
541 free_pages((unsigned long)pages_start, 1);
542
543 if (total_written == 0)
544 return -EFAULT;
545 return total_written;
546 }
547 *nbytes -= length;
548 *file_offset += length;
549 total_written += length;
550 *buffer += length;
551 *skip_bytes = 0;
552 } else
553 *skip_bytes -= length;
554
555 free_pages((unsigned long)pages_start, 1);
556
557 /* Now look at all of this device's children. */
558 for (chix = 0; chix < usbdev->maxchild; chix++) {
559 struct usb_device *childdev = usbdev->children[chix];
560
561 if (childdev) {
562 down(&childdev->serialize);
563 ret = usb_device_dump(buffer, nbytes, skip_bytes, file_offset, childdev,
564 bus, level + 1, chix, ++cnt);
565 up(&childdev->serialize);
566 if (ret == -EFAULT)
567 return total_written;
568 total_written += ret;
569 }
570 }
571 return total_written;
572 }
573
574 static ssize_t usb_device_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
575 {
576 struct usb_bus *bus;
577 ssize_t ret, total_written = 0;
578 loff_t skip_bytes = *ppos;
579
580 if (*ppos < 0)
581 return -EINVAL;
582 if (nbytes <= 0)
583 return 0;
584 if (!access_ok(VERIFY_WRITE, buf, nbytes))
585 return -EFAULT;
586
587 down (&usb_bus_list_lock);
588 /* print devices for all busses */
589 list_for_each_entry(bus, &usb_bus_list, bus_list) {
590 /* recurse through all children of the root hub */
591 if (!bus->root_hub)
592 continue;
593 usb_lock_device(bus->root_hub);
594 ret = usb_device_dump(&buf, &nbytes, &skip_bytes, ppos, bus->root_hub, bus, 0, 0, 0);
595 usb_unlock_device(bus->root_hub);
596 if (ret < 0) {
597 up(&usb_bus_list_lock);
598 return ret;
599 }
600 total_written += ret;
601 }
602 up (&usb_bus_list_lock);
603 return total_written;
604 }
605
606 /* Kernel lock for "lastev" protection */
607 static unsigned int usb_device_poll(struct file *file, struct poll_table_struct *wait)
608 {
609 struct usb_device_status *st = (struct usb_device_status *)file->private_data;
610 unsigned int mask = 0;
611
612 lock_kernel();
613 if (!st) {
614 st = kmalloc(sizeof(struct usb_device_status), GFP_KERNEL);
615 if (!st) {
616 unlock_kernel();
617 return POLLIN;
618 }
619
620 /* we may have dropped BKL - need to check for having lost the race */
621 if (file->private_data) {
622 kfree(st);
623 goto lost_race;
624 }
625
626 /*
627 * need to prevent the module from being unloaded, since
628 * proc_unregister does not call the release method and
629 * we would have a memory leak
630 */
631 st->lastev = conndiscevcnt;
632 file->private_data = st;
633 mask = POLLIN;
634 }
635 lost_race:
636 if (file->f_mode & FMODE_READ)
637 poll_wait(file, &deviceconndiscwq, wait);
638 if (st->lastev != conndiscevcnt)
639 mask |= POLLIN;
640 st->lastev = conndiscevcnt;
641 unlock_kernel();
642 return mask;
643 }
644
645 static int usb_device_open(struct inode *inode, struct file *file)
646 {
647 file->private_data = NULL;
648 return 0;
649 }
650
651 static int usb_device_release(struct inode *inode, struct file *file)
652 {
653 if (file->private_data) {
654 kfree(file->private_data);
655 file->private_data = NULL;
656 }
657
658 return 0;
659 }
660
661 static loff_t usb_device_lseek(struct file * file, loff_t offset, int orig)
662 {
663 loff_t ret;
664
665 lock_kernel();
666
667 switch (orig) {
668 case 0:
669 file->f_pos = offset;
670 ret = file->f_pos;
671 break;
672 case 1:
673 file->f_pos += offset;
674 ret = file->f_pos;
675 break;
676 case 2:
677 default:
678 ret = -EINVAL;
679 }
680
681 unlock_kernel();
682 return ret;
683 }
684
685 struct file_operations usbfs_devices_fops = {
686 .llseek = usb_device_lseek,
687 .read = usb_device_read,
688 .poll = usb_device_poll,
689 .open = usb_device_open,
690 .release = usb_device_release,
691 };
692
|
This page was automatically generated by the
LXR engine.
|