0dfb020f7d44962b6c05e826c8574692b388ed60
[dragonfly.git] / sys / bus / usb / usbdi.c
1 /*      $NetBSD: usbdi.c,v 1.106 2004/10/24 12:52:40 augustss Exp $     */
2 /*      $FreeBSD: src/sys/dev/usb/usbdi.c,v 1.91.2.1 2005/12/15 00:36:00 iedowse Exp $  */
3 /*      $DragonFly: src/sys/bus/usb/usbdi.c,v 1.18 2007/06/29 22:56:31 hasso Exp $      */
4
5 /*
6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Lennart Augustsson (lennart@augustsson.net) at
11  * Carlstedt Research & Technology.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *        This product includes software developed by the NetBSD
24  *        Foundation, Inc. and its contributors.
25  * 4. Neither the name of The NetBSD Foundation nor the names of its
26  *    contributors may be used to endorse or promote products derived
27  *    from this software without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39  * POSSIBILITY OF SUCH DAMAGE.
40  */
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/module.h>
45 #include <sys/bus.h>
46 #include "usb_if.h"
47 #if defined(DIAGNOSTIC) && defined(__i386__)
48 #include <machine/cpu.h>
49 #endif
50 #include <sys/malloc.h>
51 #include <sys/proc.h>
52 #include <sys/thread2.h>
53
54 #include <bus/usb/usb.h>
55 #include <bus/usb/usbdi.h>
56 #include <bus/usb/usbdi_util.h>
57 #include <bus/usb/usbdivar.h>
58 #include <bus/usb/usb_mem.h>
59 #include <bus/usb/usb_quirks.h>
60
61 #define delay(d)        DELAY(d)
62
63 #ifdef USB_DEBUG
64 #define DPRINTF(x)      if (usbdebug) kprintf x
65 #define DPRINTFN(n,x)   if (usbdebug>(n)) kprintf x
66 extern int usbdebug;
67 #else
68 #define DPRINTF(x)
69 #define DPRINTFN(n,x)
70 #endif
71
72 static usbd_status usbd_ar_pipe(usbd_pipe_handle pipe);
73 static void usbd_do_request_async_cb
74         (usbd_xfer_handle, usbd_private_handle, usbd_status);
75 static void usbd_start_next(usbd_pipe_handle pipe);
76 static usbd_status usbd_open_pipe_ival
77         (usbd_interface_handle, u_int8_t, u_int8_t, usbd_pipe_handle *, int);
78 static int usbd_xfer_isread(usbd_xfer_handle xfer);
79
80 static int usbd_nbuses = 0;
81
82 void
83 usbd_init(void)
84 {
85         usbd_nbuses++;
86 }
87
88 void
89 usbd_finish(void)
90 {
91         --usbd_nbuses;
92 }
93
94 static __inline int
95 usbd_xfer_isread(usbd_xfer_handle xfer)
96 {
97         if (xfer->rqflags & URQ_REQUEST)
98                 return (xfer->request.bmRequestType & UT_READ);
99         else
100                 return (xfer->pipe->endpoint->edesc->bEndpointAddress &
101                         UE_DIR_IN);
102 }
103
104 #ifdef USB_DEBUG
105 void
106 usbd_dump_iface(struct usbd_interface *iface)
107 {
108         kprintf("usbd_dump_iface: iface=%p\n", iface);
109         if (iface == NULL)
110                 return;
111         kprintf(" device=%p idesc=%p index=%d altindex=%d priv=%p\n",
112                iface->device, iface->idesc, iface->index, iface->altindex,
113                iface->priv);
114 }
115
116 void
117 usbd_dump_device(struct usbd_device *dev)
118 {
119         kprintf("usbd_dump_device: dev=%p\n", dev);
120         if (dev == NULL)
121                 return;
122         kprintf(" bus=%p default_pipe=%p\n", dev->bus, dev->default_pipe);
123         kprintf(" address=%d config=%d depth=%d speed=%d self_powered=%d "
124                "power=%d langid=%d\n",
125                dev->address, dev->config, dev->depth, dev->speed,
126                dev->self_powered, dev->power, dev->langid);
127 }
128
129 void
130 usbd_dump_endpoint(struct usbd_endpoint *endp)
131 {
132         kprintf("usbd_dump_endpoint: endp=%p\n", endp);
133         if (endp == NULL)
134                 return;
135         kprintf(" edesc=%p refcnt=%d\n", endp->edesc, endp->refcnt);
136         if (endp->edesc)
137                 kprintf(" bEndpointAddress=0x%02x\n",
138                        endp->edesc->bEndpointAddress);
139 }
140
141 void
142 usbd_dump_queue(usbd_pipe_handle pipe)
143 {
144         usbd_xfer_handle xfer;
145
146         kprintf("usbd_dump_queue: pipe=%p\n", pipe);
147         STAILQ_FOREACH(xfer, &pipe->queue, next) {
148                 kprintf("  xfer=%p\n", xfer);
149         }
150 }
151
152 void
153 usbd_dump_pipe(usbd_pipe_handle pipe)
154 {
155         kprintf("usbd_dump_pipe: pipe=%p\n", pipe);
156         if (pipe == NULL)
157                 return;
158         usbd_dump_iface(pipe->iface);
159         usbd_dump_device(pipe->device);
160         usbd_dump_endpoint(pipe->endpoint);
161         kprintf(" (usbd_dump_pipe:)\n refcnt=%d running=%d aborting=%d\n",
162                pipe->refcnt, pipe->running, pipe->aborting);
163         kprintf(" intrxfer=%p, repeat=%d, interval=%d\n",
164                pipe->intrxfer, pipe->repeat, pipe->interval);
165 }
166 #endif
167
168 usbd_status
169 usbd_open_pipe(usbd_interface_handle iface, u_int8_t address,
170                u_int8_t flags, usbd_pipe_handle *pipe)
171 {
172         return (usbd_open_pipe_ival(iface, address, flags, pipe,
173                                     USBD_DEFAULT_INTERVAL));
174 }
175
176 usbd_status
177 usbd_open_pipe_ival(usbd_interface_handle iface, u_int8_t address,
178                     u_int8_t flags, usbd_pipe_handle *pipe, int ival)
179 {
180         usbd_pipe_handle p;
181         struct usbd_endpoint *ep;
182         usbd_status err;
183         int i;
184
185         DPRINTFN(3,("usbd_open_pipe: iface=%p address=0x%x flags=0x%x\n",
186                     iface, address, flags));
187
188         for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
189                 ep = &iface->endpoints[i];
190                 if (ep->edesc == NULL)
191                         return (USBD_IOERROR);
192                 if (ep->edesc->bEndpointAddress == address)
193                         goto found;
194         }
195         return (USBD_BAD_ADDRESS);
196  found:
197         if ((flags & USBD_EXCLUSIVE_USE) && ep->refcnt != 0)
198                 return (USBD_IN_USE);
199         err = usbd_setup_pipe(iface->device, iface, ep, ival, &p);
200         if (err)
201                 return (err);
202         LIST_INSERT_HEAD(&iface->pipes, p, next);
203         *pipe = p;
204         return (USBD_NORMAL_COMPLETION);
205 }
206
207 usbd_status
208 usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address,
209                     u_int8_t flags, usbd_pipe_handle *pipe,
210                     usbd_private_handle priv, void *buffer, u_int32_t len,
211                     usbd_callback cb, int ival)
212 {
213         usbd_status err;
214         usbd_xfer_handle xfer;
215         usbd_pipe_handle ipipe;
216
217         DPRINTFN(3,("usbd_open_pipe_intr: address=0x%x flags=0x%x len=%d\n",
218                     address, flags, len));
219
220         err = usbd_open_pipe_ival(iface, address, USBD_EXCLUSIVE_USE,
221                                   &ipipe, ival);
222         if (err)
223                 return (err);
224         xfer = usbd_alloc_xfer(iface->device);
225         if (xfer == NULL) {
226                 err = USBD_NOMEM;
227                 goto bad1;
228         }
229         usbd_setup_xfer(xfer, ipipe, priv, buffer, len, flags,
230             USBD_NO_TIMEOUT, cb);
231         ipipe->intrxfer = xfer;
232         ipipe->repeat = 1;
233         err = usbd_transfer(xfer);
234         *pipe = ipipe;
235         if (err != USBD_IN_PROGRESS && err)
236                 goto bad2;
237         return (USBD_NORMAL_COMPLETION);
238
239  bad2:
240         ipipe->intrxfer = NULL;
241         ipipe->repeat = 0;
242         usbd_free_xfer(xfer);
243  bad1:
244         usbd_close_pipe(ipipe);
245         return (err);
246 }
247
248 usbd_status
249 usbd_close_pipe(usbd_pipe_handle pipe)
250 {
251 #ifdef DIAGNOSTIC
252         if (pipe == NULL) {
253                 kprintf("usbd_close_pipe: pipe==NULL\n");
254                 return (USBD_NORMAL_COMPLETION);
255         }
256 #endif
257
258         if (--pipe->refcnt != 0)
259                 return (USBD_NORMAL_COMPLETION);
260         if (! STAILQ_EMPTY(&pipe->queue))
261                 return (USBD_PENDING_REQUESTS);
262         LIST_REMOVE(pipe, next);
263         pipe->endpoint->refcnt--;
264         pipe->methods->close(pipe);
265         if (pipe->intrxfer != NULL)
266                 usbd_free_xfer(pipe->intrxfer);
267         kfree(pipe, M_USB);
268         return (USBD_NORMAL_COMPLETION);
269 }
270
271 usbd_status
272 usbd_transfer(usbd_xfer_handle xfer)
273 {
274         usbd_pipe_handle pipe = xfer->pipe;
275         usb_dma_t *dmap = &xfer->dmabuf;
276         usbd_status err;
277         u_int size;
278
279         DPRINTFN(5,("usbd_transfer: xfer=%p, flags=%d, pipe=%p, running=%d\n",
280                     xfer, xfer->flags, pipe, pipe->running));
281 #ifdef USB_DEBUG
282         if (usbdebug > 5)
283                 usbd_dump_queue(pipe);
284 #endif
285         xfer->done = 0;
286
287         if (pipe->aborting)
288                 return (USBD_CANCELLED);
289
290         size = xfer->length;
291         /* If there is no buffer, allocate one. */
292         if (!(xfer->rqflags & URQ_DEV_DMABUF) && size != 0) {
293                 struct usbd_bus *bus = pipe->device->bus;
294
295 #ifdef DIAGNOSTIC
296                 if (xfer->rqflags & URQ_AUTO_DMABUF)
297                         kprintf("usbd_transfer: has old buffer!\n");
298 #endif
299                 err = bus->methods->allocm(bus, dmap, size);
300                 if (err)
301                         return (err);
302                 xfer->rqflags |= URQ_AUTO_DMABUF;
303         }
304
305         /* Copy data if going out. */
306         if (!(xfer->flags & USBD_NO_COPY) && size != 0 &&
307             !usbd_xfer_isread(xfer))
308                 memcpy(KERNADDR(dmap, 0), xfer->buffer, size);
309
310         err = pipe->methods->transfer(xfer);
311
312         if (err != USBD_IN_PROGRESS && err) {
313                 /* The transfer has not been queued, so free buffer. */
314                 if (xfer->rqflags & URQ_AUTO_DMABUF) {
315                         struct usbd_bus *bus = pipe->device->bus;
316
317                         bus->methods->freem(bus, &xfer->dmabuf);
318                         xfer->rqflags &= ~URQ_AUTO_DMABUF;
319                 }
320         }
321
322         if (!(xfer->flags & USBD_SYNCHRONOUS))
323                 return (err);
324
325         /* Sync transfer, wait for completion. */
326         if (err != USBD_IN_PROGRESS)
327                 return (err);
328         crit_enter();
329         if (!xfer->done) {
330                 if (pipe->device->bus->use_polling)
331                         panic("usbd_transfer: not done");
332                 tsleep(xfer, 0, "usbsyn", 0);
333         }
334         crit_exit();
335         return (xfer->status);
336 }
337
338 /* Like usbd_transfer(), but waits for completion. */
339 usbd_status
340 usbd_sync_transfer(usbd_xfer_handle xfer)
341 {
342         xfer->flags |= USBD_SYNCHRONOUS;
343         return (usbd_transfer(xfer));
344 }
345
346 void *
347 usbd_alloc_buffer(usbd_xfer_handle xfer, u_int32_t size)
348 {
349         struct usbd_bus *bus = xfer->device->bus;
350         usbd_status err;
351
352 #ifdef DIAGNOSTIC
353         if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
354                 kprintf("usbd_alloc_buffer: xfer already has a buffer\n");
355 #endif
356         err = bus->methods->allocm(bus, &xfer->dmabuf, size);
357         if (err)
358                 return (NULL);
359         xfer->rqflags |= URQ_DEV_DMABUF;
360         return (KERNADDR(&xfer->dmabuf, 0));
361 }
362
363 void
364 usbd_free_buffer(usbd_xfer_handle xfer)
365 {
366 #ifdef DIAGNOSTIC
367         if (!(xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))) {
368                 kprintf("usbd_free_buffer: no buffer\n");
369                 return;
370         }
371 #endif
372         xfer->rqflags &= ~(URQ_DEV_DMABUF | URQ_AUTO_DMABUF);
373         xfer->device->bus->methods->freem(xfer->device->bus, &xfer->dmabuf);
374 }
375
376 void *
377 usbd_get_buffer(usbd_xfer_handle xfer)
378 {
379         if (!(xfer->rqflags & URQ_DEV_DMABUF))
380                 return (0);
381         return (KERNADDR(&xfer->dmabuf, 0));
382 }
383
384 usbd_xfer_handle
385 usbd_alloc_xfer(usbd_device_handle dev)
386 {
387         usbd_xfer_handle xfer;
388
389         xfer = dev->bus->methods->allocx(dev->bus);
390         if (xfer == NULL)
391                 return (NULL);
392         xfer->device = dev;
393         callout_init(&xfer->timeout_handle);
394         DPRINTFN(5,("usbd_alloc_xfer() = %p\n", xfer));
395         return (xfer);
396 }
397
398 usbd_status
399 usbd_free_xfer(usbd_xfer_handle xfer)
400 {
401         DPRINTFN(5,("usbd_free_xfer: %p\n", xfer));
402         if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
403                 usbd_free_buffer(xfer);
404         xfer->device->bus->methods->freex(xfer->device->bus, xfer);
405         return (USBD_NORMAL_COMPLETION);
406 }
407
408 void
409 usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
410                 usbd_private_handle priv, void *buffer, u_int32_t length,
411                 u_int16_t flags, u_int32_t timeout,
412                 usbd_callback callback)
413 {
414         xfer->pipe = pipe;
415         xfer->priv = priv;
416         xfer->buffer = buffer;
417         xfer->length = length;
418         xfer->actlen = 0;
419         xfer->flags = flags;
420         xfer->timeout = timeout;
421         xfer->status = USBD_NOT_STARTED;
422         xfer->callback = callback;
423         xfer->rqflags &= ~URQ_REQUEST;
424         xfer->nframes = 0;
425 }
426
427 void
428 usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev,
429                         usbd_private_handle priv, u_int32_t timeout,
430                         usb_device_request_t *req, void *buffer,
431                         u_int32_t length, u_int16_t flags,
432                         usbd_callback callback)
433 {
434         xfer->pipe = dev->default_pipe;
435         xfer->priv = priv;
436         xfer->buffer = buffer;
437         xfer->length = length;
438         xfer->actlen = 0;
439         xfer->flags = flags;
440         xfer->timeout = timeout;
441         xfer->status = USBD_NOT_STARTED;
442         xfer->callback = callback;
443         xfer->request = *req;
444         xfer->rqflags |= URQ_REQUEST;
445         xfer->nframes = 0;
446 }
447
448 void
449 usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
450                      usbd_private_handle priv, u_int16_t *frlengths,
451                      u_int32_t nframes, u_int16_t flags, usbd_callback callback)
452 {
453         xfer->pipe = pipe;
454         xfer->priv = priv;
455         xfer->buffer = 0;
456         xfer->length = 0;
457         xfer->actlen = 0;
458         xfer->flags = flags;
459         xfer->timeout = USBD_NO_TIMEOUT;
460         xfer->status = USBD_NOT_STARTED;
461         xfer->callback = callback;
462         xfer->rqflags &= ~URQ_REQUEST;
463         xfer->frlengths = frlengths;
464         xfer->nframes = nframes;
465 }
466
467 void
468 usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv,
469                      void **buffer, u_int32_t *count, usbd_status *status)
470 {
471         if (priv != NULL)
472                 *priv = xfer->priv;
473         if (buffer != NULL)
474                 *buffer = xfer->buffer;
475         if (count != NULL)
476                 *count = xfer->actlen;
477         if (status != NULL)
478                 *status = xfer->status;
479 }
480
481 int
482 usbd_get_speed(usbd_device_handle dev)
483 {
484         return(dev->speed);
485 }
486
487 usb_config_descriptor_t *
488 usbd_get_config_descriptor(usbd_device_handle dev)
489 {
490 #ifdef DIAGNOSTIC
491         if (dev == NULL) {
492                 kprintf("usbd_get_config_descriptor: dev == NULL\n");
493                 return (NULL);
494         }
495 #endif
496         return (dev->cdesc);
497 }
498
499 usb_interface_descriptor_t *
500 usbd_get_interface_descriptor(usbd_interface_handle iface)
501 {
502 #ifdef DIAGNOSTIC
503         if (iface == NULL) {
504                 kprintf("usbd_get_interface_descriptor: dev == NULL\n");
505                 return (NULL);
506         }
507 #endif
508         return (iface->idesc);
509 }
510
511 usb_device_descriptor_t *
512 usbd_get_device_descriptor(usbd_device_handle dev)
513 {
514         return (&dev->ddesc);
515 }
516
517 usb_endpoint_descriptor_t *
518 usbd_interface2endpoint_descriptor(usbd_interface_handle iface, u_int8_t index)
519 {
520         if (index >= iface->idesc->bNumEndpoints)
521                 return (0);
522         return (iface->endpoints[index].edesc);
523 }
524
525 usbd_status
526 usbd_abort_pipe(usbd_pipe_handle pipe)
527 {
528         usbd_status err;
529
530 #ifdef DIAGNOSTIC
531         if (pipe == NULL) {
532                 kprintf("usbd_close_pipe: pipe==NULL\n");
533                 return (USBD_NORMAL_COMPLETION);
534         }
535 #endif
536         crit_enter();
537         err = usbd_ar_pipe(pipe);
538         crit_exit();
539         return (err);
540 }
541
542 usbd_status
543 usbd_abort_default_pipe(usbd_device_handle dev)
544 {
545         return (usbd_abort_pipe(dev->default_pipe));
546 }
547
548 usbd_status
549 usbd_clear_endpoint_stall(usbd_pipe_handle pipe)
550 {
551         usbd_device_handle dev = pipe->device;
552         usb_device_request_t req;
553         usbd_status err;
554
555         DPRINTFN(8, ("usbd_clear_endpoint_stall\n"));
556
557         /*
558          * Clearing en endpoint stall resets the endpoint toggle, so
559          * do the same to the HC toggle.
560          */
561         pipe->methods->cleartoggle(pipe);
562
563         req.bmRequestType = UT_WRITE_ENDPOINT;
564         req.bRequest = UR_CLEAR_FEATURE;
565         USETW(req.wValue, UF_ENDPOINT_HALT);
566         USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
567         USETW(req.wLength, 0);
568         err = usbd_do_request(dev, &req, 0);
569 #if 0
570 XXX should we do this?
571         if (!err) {
572                 pipe->state = USBD_PIPE_ACTIVE;
573                 /* XXX activate pipe */
574         }
575 #endif
576         return (err);
577 }
578
579 usbd_status
580 usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe)
581 {
582         usbd_device_handle dev = pipe->device;
583         usb_device_request_t req;
584         usbd_status err;
585
586         pipe->methods->cleartoggle(pipe);
587
588         req.bmRequestType = UT_WRITE_ENDPOINT;
589         req.bRequest = UR_CLEAR_FEATURE;
590         USETW(req.wValue, UF_ENDPOINT_HALT);
591         USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
592         USETW(req.wLength, 0);
593         err = usbd_do_request_async(dev, &req, 0);
594         return (err);
595 }
596
597 void
598 usbd_clear_endpoint_toggle(usbd_pipe_handle pipe)
599 {
600         pipe->methods->cleartoggle(pipe);
601 }
602
603 usbd_status
604 usbd_endpoint_count(usbd_interface_handle iface, u_int8_t *count)
605 {
606 #ifdef DIAGNOSTIC
607         if (iface == NULL || iface->idesc == NULL) {
608                 kprintf("usbd_endpoint_count: NULL pointer\n");
609                 return (USBD_INVAL);
610         }
611 #endif
612         *count = iface->idesc->bNumEndpoints;
613         return (USBD_NORMAL_COMPLETION);
614 }
615
616 usbd_status
617 usbd_interface_count(usbd_device_handle dev, u_int8_t *count)
618 {
619         if (dev->cdesc == NULL)
620                 return (USBD_NOT_CONFIGURED);
621         *count = dev->cdesc->bNumInterface;
622         return (USBD_NORMAL_COMPLETION);
623 }
624
625 void
626 usbd_interface2device_handle(usbd_interface_handle iface,
627                              usbd_device_handle *dev)
628 {
629         *dev = iface->device;
630 }
631
632 usbd_status
633 usbd_device2interface_handle(usbd_device_handle dev,
634                              u_int8_t ifaceno, usbd_interface_handle *iface)
635 {
636         if (dev->cdesc == NULL)
637                 return (USBD_NOT_CONFIGURED);
638         if (ifaceno >= dev->cdesc->bNumInterface)
639                 return (USBD_INVAL);
640         *iface = &dev->ifaces[ifaceno];
641         return (USBD_NORMAL_COMPLETION);
642 }
643
644 usbd_device_handle
645 usbd_pipe2device_handle(usbd_pipe_handle pipe)
646 {
647         return (pipe->device);
648 }
649
650 /* XXXX use altno */
651 usbd_status
652 usbd_set_interface(usbd_interface_handle iface, int altidx)
653 {
654         usb_device_request_t req;
655         usbd_status err;
656         void *endpoints;
657
658         if (LIST_FIRST(&iface->pipes) != 0)
659                 return (USBD_IN_USE);
660
661         endpoints = iface->endpoints;
662         err = usbd_fill_iface_data(iface->device, iface->index, altidx);
663         if (err)
664                 return (err);
665
666         /* new setting works, we can free old endpoints */
667         if (endpoints != NULL)
668                 kfree(endpoints, M_USB);
669
670 #ifdef DIAGNOSTIC
671         if (iface->idesc == NULL) {
672                 kprintf("usbd_set_interface: NULL pointer\n");
673                 return (USBD_INVAL);
674         }
675 #endif
676
677         req.bmRequestType = UT_WRITE_INTERFACE;
678         req.bRequest = UR_SET_INTERFACE;
679         USETW(req.wValue, iface->idesc->bAlternateSetting);
680         USETW(req.wIndex, iface->idesc->bInterfaceNumber);
681         USETW(req.wLength, 0);
682         return (usbd_do_request(iface->device, &req, 0));
683 }
684
685 int
686 usbd_get_no_alts(usb_config_descriptor_t *cdesc, int ifaceno)
687 {
688         char *p = (char *)cdesc;
689         char *end = p + UGETW(cdesc->wTotalLength);
690         usb_interface_descriptor_t *d;
691         int n;
692
693         for (n = 0; p < end; p += d->bLength) {
694                 d = (usb_interface_descriptor_t *)p;
695                 if (p + d->bLength <= end &&
696                     d->bDescriptorType == UDESC_INTERFACE &&
697                     d->bInterfaceNumber == ifaceno)
698                         n++;
699         }
700         return (n);
701 }
702
703 int
704 usbd_get_interface_altindex(usbd_interface_handle iface)
705 {
706         return (iface->altindex);
707 }
708
709 usbd_status
710 usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface)
711 {
712         usb_device_request_t req;
713
714         req.bmRequestType = UT_READ_INTERFACE;
715         req.bRequest = UR_GET_INTERFACE;
716         USETW(req.wValue, 0);
717         USETW(req.wIndex, iface->idesc->bInterfaceNumber);
718         USETW(req.wLength, 1);
719         return (usbd_do_request(iface->device, &req, aiface));
720 }
721
722 /*** Internal routines ***/
723
724 /* Dequeue all pipe operations, called from critical section. */
725 static usbd_status
726 usbd_ar_pipe(usbd_pipe_handle pipe)
727 {
728         usbd_xfer_handle xfer;
729
730         DPRINTFN(2,("usbd_ar_pipe: pipe=%p\n", pipe));
731 #ifdef USB_DEBUG
732         if (usbdebug > 5)
733                 usbd_dump_queue(pipe);
734 #endif
735         pipe->repeat = 0;
736         pipe->aborting = 1;
737         while ((xfer = STAILQ_FIRST(&pipe->queue)) != NULL) {
738                 DPRINTFN(2,("usbd_ar_pipe: pipe=%p xfer=%p (methods=%p)\n",
739                             pipe, xfer, pipe->methods));
740                 /* Make the HC abort it (and invoke the callback). */
741                 pipe->methods->abort(xfer);
742                 /* XXX only for non-0 usbd_clear_endpoint_stall(pipe); */
743         }
744         pipe->aborting = 0;
745         return (USBD_NORMAL_COMPLETION);
746 }
747
748 /* Called from critical section */
749 void
750 usb_transfer_complete(usbd_xfer_handle xfer)
751 {
752         usbd_pipe_handle pipe = xfer->pipe;
753         usb_dma_t *dmap = &xfer->dmabuf;
754         int sync = xfer->flags & USBD_SYNCHRONOUS;
755         int erred = xfer->status == USBD_CANCELLED ||
756             xfer->status == USBD_TIMEOUT;
757         int repeat = pipe->repeat;
758         int polling;
759
760         DPRINTFN(5, ("usb_transfer_complete: pipe=%p xfer=%p status=%d "
761                      "actlen=%d\n", pipe, xfer, xfer->status, xfer->actlen));
762 #ifdef DIAGNOSTIC
763         if (xfer->busy_free != XFER_ONQU) {
764                 kprintf("usb_transfer_complete: xfer=%p not busy 0x%08x\n",
765                        xfer, xfer->busy_free);
766                 return;
767         }
768 #endif
769
770 #ifdef DIAGNOSTIC
771         if (pipe == NULL) {
772                 kprintf("usbd_transfer_cb: pipe==0, xfer=%p\n", xfer);
773                 return;
774         }
775 #endif
776         polling = pipe->device->bus->use_polling;
777         /* XXXX */
778         if (polling)
779                 pipe->running = 0;
780
781         if (!(xfer->flags & USBD_NO_COPY) && xfer->actlen != 0 &&
782             usbd_xfer_isread(xfer)) {
783 #ifdef DIAGNOSTIC
784                 if (xfer->actlen > xfer->length) {
785                         kprintf("usb_transfer_complete: actlen > len %d > %d\n",
786                                xfer->actlen, xfer->length);
787                         xfer->actlen = xfer->length;
788                 }
789 #endif
790                 memcpy(xfer->buffer, KERNADDR(dmap, 0), xfer->actlen);
791         }
792
793         /* if we allocated the buffer in usbd_transfer() we free it here. */
794         if (xfer->rqflags & URQ_AUTO_DMABUF) {
795                 if (!repeat) {
796                         struct usbd_bus *bus = pipe->device->bus;
797                         bus->methods->freem(bus, dmap);
798                         xfer->rqflags &= ~URQ_AUTO_DMABUF;
799                 }
800         }
801
802         if (!repeat) {
803                 /* Remove request from queue. */
804 #ifdef DIAGNOSTIC
805                 if (xfer != STAILQ_FIRST(&pipe->queue))
806                         kprintf("usb_transfer_complete: bad dequeue %p != %p\n",
807                                xfer, STAILQ_FIRST(&pipe->queue));
808                 xfer->busy_free = XFER_BUSY;
809 #endif
810                 STAILQ_REMOVE_HEAD(&pipe->queue, next);
811         }
812         DPRINTFN(5,("usb_transfer_complete: repeat=%d new head=%p\n",
813                     repeat, STAILQ_FIRST(&pipe->queue)));
814
815         /* Count completed transfers. */
816         ++pipe->device->bus->stats.uds_requests
817                 [pipe->endpoint->edesc->bmAttributes & UE_XFERTYPE];
818
819         xfer->done = 1;
820         if (!xfer->status && xfer->actlen < xfer->length &&
821             !(xfer->flags & USBD_SHORT_XFER_OK)) {
822                 DPRINTFN(-1,("usbd_transfer_cb: short transfer %d<%d\n",
823                              xfer->actlen, xfer->length));
824                 xfer->status = USBD_SHORT_XFER;
825         }
826
827         /*
828          * For repeat operations, call the callback first, as the xfer
829          * will not go away and the "done" method may modify it. Otherwise
830          * reverse the order in case the callback wants to free or reuse
831          * the xfer.
832          */
833         if (repeat) {
834                 if (xfer->callback)
835                         xfer->callback(xfer, xfer->priv, xfer->status);
836                 pipe->methods->done(xfer);
837         } else {
838                 pipe->methods->done(xfer);
839                 if (xfer->callback)
840                         xfer->callback(xfer, xfer->priv, xfer->status);
841         }
842
843         if (sync && !polling)
844                 wakeup(xfer);
845
846         if (!repeat) {
847                 /* XXX should we stop the queue on all errors? */
848                 if (erred && pipe->iface != NULL)       /* not control pipe */
849                         pipe->running = 0;
850                 else
851                         usbd_start_next(pipe);
852         }
853 }
854
855 usbd_status
856 usb_insert_transfer(usbd_xfer_handle xfer)
857 {
858         usbd_pipe_handle pipe = xfer->pipe;
859         usbd_status err;
860
861         DPRINTFN(5,("usb_insert_transfer: pipe=%p running=%d timeout=%d\n",
862                     pipe, pipe->running, xfer->timeout));
863 #ifdef DIAGNOSTIC
864         if (xfer->busy_free != XFER_BUSY) {
865                 kprintf("usb_insert_transfer: xfer=%p not busy 0x%08x\n",
866                        xfer, xfer->busy_free);
867                 return (USBD_INVAL);
868         }
869         xfer->busy_free = XFER_ONQU;
870 #endif
871         crit_enter();
872         STAILQ_INSERT_TAIL(&pipe->queue, xfer, next);
873         if (pipe->running)
874                 err = USBD_IN_PROGRESS;
875         else {
876                 pipe->running = 1;
877                 err = USBD_NORMAL_COMPLETION;
878         }
879         crit_exit();
880         return (err);
881 }
882
883 /* Called from critical section */
884 void
885 usbd_start_next(usbd_pipe_handle pipe)
886 {
887         usbd_xfer_handle xfer;
888         usbd_status err;
889
890 #ifdef DIAGNOSTIC
891         if (pipe == NULL) {
892                 kprintf("usbd_start_next: pipe == NULL\n");
893                 return;
894         }
895         if (pipe->methods == NULL || pipe->methods->start == NULL) {
896                 kprintf("usbd_start_next: pipe=%p no start method\n", pipe);
897                 return;
898         }
899 #endif
900
901         /* Get next request in queue. */
902         xfer = STAILQ_FIRST(&pipe->queue);
903         DPRINTFN(5, ("usbd_start_next: pipe=%p, xfer=%p\n", pipe, xfer));
904         if (xfer == NULL) {
905                 pipe->running = 0;
906         } else {
907                 err = pipe->methods->start(xfer);
908                 if (err != USBD_IN_PROGRESS) {
909                         kprintf("usbd_start_next: error=%d\n", err);
910                         pipe->running = 0;
911                         /* XXX do what? */
912                 }
913         }
914 }
915
916 usbd_status
917 usbd_do_request(usbd_device_handle dev, usb_device_request_t *req, void *data)
918 {
919         return (usbd_do_request_flags(dev, req, data, 0, 0,
920                                       USBD_DEFAULT_TIMEOUT));
921 }
922
923 usbd_status
924 usbd_do_request_flags(usbd_device_handle dev, usb_device_request_t *req,
925                       void *data, u_int16_t flags, int *actlen, u_int32_t timo)
926 {
927         return (usbd_do_request_flags_pipe(dev, dev->default_pipe, req,
928                                            data, flags, actlen, timo));
929 }
930
931 usbd_status
932 usbd_do_request_flags_pipe(usbd_device_handle dev, usbd_pipe_handle pipe,
933         usb_device_request_t *req, void *data, u_int16_t flags, int *actlen,
934         u_int32_t timeout)
935 {
936         usbd_xfer_handle xfer;
937         usbd_status err;
938
939 #ifdef DIAGNOSTIC
940         KASSERT(mycpu->gd_intr_nesting_level == 0,
941                 ("usbd_do_request: in interrupt context"));
942         if (dev->bus->intr_context) {
943                 kprintf("usbd_do_request: not in process context\n");
944                 return (USBD_INVAL);
945         }
946 #endif
947
948         xfer = usbd_alloc_xfer(dev);
949         if (xfer == NULL)
950                 return (USBD_NOMEM);
951         usbd_setup_default_xfer(xfer, dev, 0, timeout, req,
952                                 data, UGETW(req->wLength), flags, 0);
953         xfer->pipe = pipe;
954         err = usbd_sync_transfer(xfer);
955 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
956         if (xfer->actlen > xfer->length)
957                 DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
958                          "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
959                          dev->address, xfer->request.bmRequestType,
960                          xfer->request.bRequest, UGETW(xfer->request.wValue),
961                          UGETW(xfer->request.wIndex),
962                          UGETW(xfer->request.wLength),
963                          xfer->length, xfer->actlen));
964 #endif
965         if (actlen != NULL)
966                 *actlen = xfer->actlen;
967         if (err == USBD_STALLED) {
968                 /*
969                  * The control endpoint has stalled.  Control endpoints
970                  * should not halt, but some may do so anyway so clear
971                  * any halt condition.
972                  */
973                 usb_device_request_t treq;
974                 usb_status_t status;
975                 u_int16_t s;
976                 usbd_status nerr;
977
978                 treq.bmRequestType = UT_READ_ENDPOINT;
979                 treq.bRequest = UR_GET_STATUS;
980                 USETW(treq.wValue, 0);
981                 USETW(treq.wIndex, 0);
982                 USETW(treq.wLength, sizeof(usb_status_t));
983                 usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
984                                            &treq, &status,sizeof(usb_status_t),
985                                            0, 0);
986                 nerr = usbd_sync_transfer(xfer);
987                 if (nerr)
988                         goto bad;
989                 s = UGETW(status.wStatus);
990                 DPRINTF(("usbd_do_request: status = 0x%04x\n", s));
991                 if (!(s & UES_HALT))
992                         goto bad;
993                 treq.bmRequestType = UT_WRITE_ENDPOINT;
994                 treq.bRequest = UR_CLEAR_FEATURE;
995                 USETW(treq.wValue, UF_ENDPOINT_HALT);
996                 USETW(treq.wIndex, 0);
997                 USETW(treq.wLength, 0);
998                 usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
999                                            &treq, &status, 0, 0, 0);
1000                 nerr = usbd_sync_transfer(xfer);
1001                 if (nerr)
1002                         goto bad;
1003         }
1004
1005  bad:
1006         usbd_free_xfer(xfer);
1007         return (err);
1008 }
1009
1010 void
1011 usbd_do_request_async_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
1012                          usbd_status status)
1013 {
1014 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
1015         if (xfer->actlen > xfer->length)
1016                 DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
1017                          "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
1018                          xfer->pipe->device->address,
1019                          xfer->request.bmRequestType,
1020                          xfer->request.bRequest, UGETW(xfer->request.wValue),
1021                          UGETW(xfer->request.wIndex),
1022                          UGETW(xfer->request.wLength),
1023                          xfer->length, xfer->actlen));
1024 #endif
1025         usbd_free_xfer(xfer);
1026 }
1027
1028 /*
1029  * Execute a request without waiting for completion.
1030  * Can be used from interrupt context.
1031  */
1032 usbd_status
1033 usbd_do_request_async(usbd_device_handle dev, usb_device_request_t *req,
1034                       void *data)
1035 {
1036         usbd_xfer_handle xfer;
1037         usbd_status err;
1038
1039         xfer = usbd_alloc_xfer(dev);
1040         if (xfer == NULL)
1041                 return (USBD_NOMEM);
1042         usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT, req,
1043             data, UGETW(req->wLength), 0, usbd_do_request_async_cb);
1044         err = usbd_transfer(xfer);
1045         if (err != USBD_IN_PROGRESS && err) {
1046                 usbd_free_xfer(xfer);
1047                 return (err);
1048         }
1049         return (USBD_NORMAL_COMPLETION);
1050 }
1051
1052 const struct usbd_quirks *
1053 usbd_get_quirks(usbd_device_handle dev)
1054 {
1055 #ifdef DIAGNOSTIC
1056         if (dev == NULL) {
1057                 kprintf("usbd_get_quirks: dev == NULL\n");
1058                 return 0;
1059         }
1060 #endif
1061         return (dev->quirks);
1062 }
1063
1064 /* XXX do periodic free() of free list */
1065
1066 /*
1067  * Called from keyboard driver when in polling mode.
1068  */
1069 void
1070 usbd_dopoll(usbd_interface_handle iface)
1071 {
1072         iface->device->bus->methods->do_poll(iface->device->bus);
1073 }
1074
1075 void
1076 usbd_set_polling(usbd_device_handle dev, int on)
1077 {
1078         if (on)
1079                 dev->bus->use_polling++;
1080         else
1081                 dev->bus->use_polling--;
1082         /* When polling we need to make sure there is nothing pending to do. */
1083         if (dev->bus->use_polling)
1084                 dev->bus->methods->soft_intr(dev->bus);
1085 }
1086
1087
1088 usb_endpoint_descriptor_t *
1089 usbd_get_endpoint_descriptor(usbd_interface_handle iface, u_int8_t address)
1090 {
1091         struct usbd_endpoint *ep;
1092         int i;
1093
1094         for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
1095                 ep = &iface->endpoints[i];
1096                 if (ep->edesc->bEndpointAddress == address)
1097                         return (iface->endpoints[i].edesc);
1098         }
1099         return (0);
1100 }
1101
1102 /*
1103  * usbd_ratecheck() can limit the number of error messages that occurs.
1104  * When a device is unplugged it may take up to 0.25s for the hub driver
1105  * to notice it.  If the driver continuosly tries to do I/O operations
1106  * this can generate a large number of messages.
1107  */
1108 int
1109 usbd_ratecheck(struct timeval *last)
1110 {
1111         if (last->tv_sec == time_second)
1112                 return (0);
1113         last->tv_sec = time_second;
1114         return (1);
1115 }
1116
1117 /*
1118  * Search for a vendor/product pair in an array.  The item size is
1119  * given as an argument.
1120  */
1121 const struct usb_devno *
1122 usb_match_device(const struct usb_devno *tbl, u_int nentries, u_int sz,
1123                  u_int16_t vendor, u_int16_t product)
1124 {
1125         while (nentries-- > 0) {
1126                 u_int16_t tproduct = tbl->ud_product;
1127                 if (tbl->ud_vendor == vendor &&
1128                     (tproduct == product || tproduct == USB_PRODUCT_ANY))
1129                         return (tbl);
1130                 tbl = (const struct usb_devno *)((const char *)tbl + sz);
1131         }
1132         return (NULL);
1133 }
1134
1135
1136 void
1137 usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter)
1138 {
1139         const usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev);
1140
1141         iter->cur = (const uByte *)cd;
1142         iter->end = (const uByte *)cd + UGETW(cd->wTotalLength);
1143 }
1144
1145 const usb_descriptor_t *
1146 usb_desc_iter_next(usbd_desc_iter_t *iter)
1147 {
1148         const usb_descriptor_t *desc;
1149
1150         if (iter->cur + sizeof(usb_descriptor_t) >= iter->end) {
1151                 if (iter->cur != iter->end)
1152                         kprintf("usb_desc_iter_next: bad descriptor\n");
1153                 return NULL;
1154         }
1155         desc = (const usb_descriptor_t *)iter->cur;
1156         if (desc->bLength == 0) {
1157                 kprintf("usb_desc_iter_next: descriptor length = 0\n");
1158                 return NULL;
1159         }
1160         iter->cur += desc->bLength;
1161         if (iter->cur > iter->end) {
1162                 kprintf("usb_desc_iter_next: descriptor length too large\n");
1163                 return NULL;
1164         }
1165         return desc;
1166 }
1167
1168 usbd_status
1169 usbd_get_string(usbd_device_handle dev, int si, char *buf)
1170 {
1171         int swap = dev->quirks->uq_flags & UQ_SWAP_UNICODE;
1172         usb_string_descriptor_t us;
1173         char *s;
1174         int i, n;
1175         u_int16_t c;
1176         usbd_status err;
1177         int size;
1178
1179         buf[0] = '\0';
1180         if (si == 0)
1181                 return (USBD_INVAL);
1182         if (dev->quirks->uq_flags & UQ_NO_STRINGS)
1183                 return (USBD_STALLED);
1184         if (dev->langid == USBD_NOLANG) {
1185                 /* Set up default language */
1186                 err = usbd_get_string_desc(dev, USB_LANGUAGE_TABLE, 0, &us,
1187                     &size);
1188                 if (err || size < 4) {
1189                         DPRINTFN(-1,("usbd_get_string: getting lang failed, using 0\n"));
1190                         dev->langid = 0; /* Well, just pick something then */
1191                 } else {
1192                         /* Pick the first language as the default. */
1193                         dev->langid = UGETW(us.bString[0]);
1194                 }
1195         }
1196         err = usbd_get_string_desc(dev, si, dev->langid, &us, &size);
1197         if (err)
1198                 return (err);
1199         s = buf;
1200         n = size / 2 - 1;
1201         for (i = 0; i < n; i++) {
1202                 c = UGETW(us.bString[i]);
1203                 /* Convert from Unicode, handle buggy strings. */
1204                 if ((c & 0xff00) == 0)
1205                         *s++ = c;
1206                 else if ((c & 0x00ff) == 0 && swap)
1207                         *s++ = c >> 8;
1208                 else
1209                         *s++ = '?';
1210         }
1211         *s++ = 0;
1212         return (USBD_NORMAL_COMPLETION);
1213 }
1214
1215 int
1216 usbd_driver_load(module_t mod, int what, void *arg)
1217 {
1218         /* XXX should implement something like a function that removes all generic devices */
1219
1220         return (0);
1221 }
1222