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