3 * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This file contains the driver for the AT91 series USB Device
33 * Thanks to "David Brownell" for helping out regarding the hardware
38 * NOTE: The "fifo_bank" is not reset in hardware when the endpoint is
41 * NOTE: When the chip detects BUS-reset it will also reset the
42 * endpoints, Function-address and more.
45 #ifdef USB_GLOBAL_INCLUDE_FILE
46 #include USB_GLOBAL_INCLUDE_FILE
48 #include <sys/stdint.h>
49 #include <sys/stddef.h>
50 #include <sys/param.h>
51 #include <sys/queue.h>
52 #include <sys/types.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
56 #include <sys/module.h>
58 #include <sys/mutex.h>
59 #include <sys/condvar.h>
60 #include <sys/sysctl.h>
62 #include <sys/unistd.h>
63 #include <sys/callout.h>
64 #include <sys/malloc.h>
67 #include <dev/usb/usb.h>
68 #include <dev/usb/usbdi.h>
70 #define USB_DEBUG_VAR at91dcidebug
72 #include <dev/usb/usb_core.h>
73 #include <dev/usb/usb_debug.h>
74 #include <dev/usb/usb_busdma.h>
75 #include <dev/usb/usb_process.h>
76 #include <dev/usb/usb_transfer.h>
77 #include <dev/usb/usb_device.h>
78 #include <dev/usb/usb_hub.h>
79 #include <dev/usb/usb_util.h>
81 #include <dev/usb/usb_controller.h>
82 #include <dev/usb/usb_bus.h>
83 #endif /* USB_GLOBAL_INCLUDE_FILE */
85 #include <dev/usb/controller/at91dci.h>
87 #define AT9100_DCI_BUS2SC(bus) \
88 ((struct at91dci_softc *)(((uint8_t *)(bus)) - \
89 ((uint8_t *)&(((struct at91dci_softc *)0)->sc_bus))))
91 #define AT9100_DCI_PC2SC(pc) \
92 AT9100_DCI_BUS2SC(USB_DMATAG_TO_XROOT((pc)->tag_parent)->bus)
94 #define AT9100_DCI_THREAD_IRQ \
95 (AT91_UDP_INT_BUS | AT91_UDP_INT_END_BR | AT91_UDP_INT_RXRSM | AT91_UDP_INT_RXSUSP)
98 static int at91dcidebug = 0;
100 static SYSCTL_NODE(_hw_usb, OID_AUTO, at91dci, CTLFLAG_RW, 0, "USB at91dci");
101 SYSCTL_INT(_hw_usb_at91dci, OID_AUTO, debug, CTLFLAG_RWTUN,
102 &at91dcidebug, 0, "at91dci debug level");
105 #define AT9100_DCI_INTR_ENDPT 1
109 static const struct usb_bus_methods at91dci_bus_methods;
110 static const struct usb_pipe_methods at91dci_device_bulk_methods;
111 static const struct usb_pipe_methods at91dci_device_ctrl_methods;
112 static const struct usb_pipe_methods at91dci_device_intr_methods;
113 static const struct usb_pipe_methods at91dci_device_isoc_fs_methods;
115 static at91dci_cmd_t at91dci_setup_rx;
116 static at91dci_cmd_t at91dci_data_rx;
117 static at91dci_cmd_t at91dci_data_tx;
118 static at91dci_cmd_t at91dci_data_tx_sync;
119 static void at91dci_device_done(struct usb_xfer *, usb_error_t);
120 static void at91dci_do_poll(struct usb_bus *);
121 static void at91dci_standard_done(struct usb_xfer *);
122 static void at91dci_root_intr(struct at91dci_softc *sc);
125 * NOTE: Some of the bits in the CSR register have inverse meaning so
126 * we need a helper macro when acknowledging events:
128 #define AT91_CSR_ACK(csr, what) do { \
129 (csr) &= ~((AT91_UDP_CSR_FORCESTALL| \
130 AT91_UDP_CSR_TXPKTRDY| \
131 AT91_UDP_CSR_RXBYTECNT) ^ (what));\
132 (csr) |= ((AT91_UDP_CSR_RX_DATA_BK0| \
133 AT91_UDP_CSR_RX_DATA_BK1| \
134 AT91_UDP_CSR_TXCOMP| \
135 AT91_UDP_CSR_RXSETUP| \
136 AT91_UDP_CSR_STALLSENT) ^ (what)); \
140 * Here is a list of what the chip supports.
141 * Probably it supports more than listed here!
143 static const struct usb_hw_ep_profile
144 at91dci_ep_profile[AT91_UDP_EP_MAX] = {
147 .max_in_frame_size = 8,
148 .max_out_frame_size = 8,
150 .support_control = 1,
153 .max_in_frame_size = 64,
154 .max_out_frame_size = 64,
156 .support_multi_buffer = 1,
158 .support_interrupt = 1,
159 .support_isochronous = 1,
164 .max_in_frame_size = 64,
165 .max_out_frame_size = 64,
167 .support_multi_buffer = 1,
169 .support_interrupt = 1,
170 .support_isochronous = 1,
175 /* can also do BULK */
176 .max_in_frame_size = 8,
177 .max_out_frame_size = 8,
179 .support_interrupt = 1,
184 .max_in_frame_size = 256,
185 .max_out_frame_size = 256,
187 .support_multi_buffer = 1,
189 .support_interrupt = 1,
190 .support_isochronous = 1,
195 .max_in_frame_size = 256,
196 .max_out_frame_size = 256,
198 .support_multi_buffer = 1,
200 .support_interrupt = 1,
201 .support_isochronous = 1,
208 at91dci_get_hw_ep_profile(struct usb_device *udev,
209 const struct usb_hw_ep_profile **ppf, uint8_t ep_addr)
211 if (ep_addr < AT91_UDP_EP_MAX) {
212 *ppf = (at91dci_ep_profile + ep_addr);
219 at91dci_clocks_on(struct at91dci_softc *sc)
221 if (sc->sc_flags.clocks_off &&
222 sc->sc_flags.port_powered) {
226 if (sc->sc_clocks_on) {
227 (sc->sc_clocks_on) (sc->sc_clocks_arg);
229 sc->sc_flags.clocks_off = 0;
231 /* enable Transceiver */
232 AT91_UDP_WRITE_4(sc, AT91_UDP_TXVC, 0);
237 at91dci_clocks_off(struct at91dci_softc *sc)
239 if (!sc->sc_flags.clocks_off) {
243 /* disable Transceiver */
244 AT91_UDP_WRITE_4(sc, AT91_UDP_TXVC, AT91_UDP_TXVC_DIS);
246 if (sc->sc_clocks_off) {
247 (sc->sc_clocks_off) (sc->sc_clocks_arg);
249 sc->sc_flags.clocks_off = 1;
254 at91dci_pull_up(struct at91dci_softc *sc)
256 /* pullup D+, if possible */
258 if (!sc->sc_flags.d_pulled_up &&
259 sc->sc_flags.port_powered) {
260 sc->sc_flags.d_pulled_up = 1;
261 (sc->sc_pull_up) (sc->sc_pull_arg);
266 at91dci_pull_down(struct at91dci_softc *sc)
268 /* pulldown D+, if possible */
270 if (sc->sc_flags.d_pulled_up) {
271 sc->sc_flags.d_pulled_up = 0;
272 (sc->sc_pull_down) (sc->sc_pull_arg);
277 at91dci_wakeup_peer(struct at91dci_softc *sc)
279 if (!(sc->sc_flags.status_suspend)) {
283 AT91_UDP_WRITE_4(sc, AT91_UDP_GSTATE, AT91_UDP_GSTATE_ESR);
285 /* wait 8 milliseconds */
286 /* Wait for reset to complete. */
287 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 125);
289 AT91_UDP_WRITE_4(sc, AT91_UDP_GSTATE, 0);
293 at91dci_set_address(struct at91dci_softc *sc, uint8_t addr)
295 DPRINTFN(5, "addr=%d\n", addr);
297 AT91_UDP_WRITE_4(sc, AT91_UDP_FADDR, addr |
302 at91dci_setup_rx(struct at91dci_softc *sc, struct at91dci_td *td)
304 struct usb_device_request req;
309 /* read out FIFO status */
310 csr = AT91_UDP_READ_4(sc, td->status_reg);
312 DPRINTFN(5, "csr=0x%08x rem=%u\n", csr, td->remainder);
315 temp &= (AT91_UDP_CSR_RX_DATA_BK0 |
316 AT91_UDP_CSR_RX_DATA_BK1 |
317 AT91_UDP_CSR_STALLSENT |
318 AT91_UDP_CSR_RXSETUP |
319 AT91_UDP_CSR_TXCOMP);
321 if (!(csr & AT91_UDP_CSR_RXSETUP)) {
324 /* clear did stall */
327 /* get the packet byte count */
328 count = (csr & AT91_UDP_CSR_RXBYTECNT) >> 16;
330 /* verify data length */
331 if (count != td->remainder) {
332 DPRINTFN(0, "Invalid SETUP packet "
333 "length, %d bytes\n", count);
336 if (count != sizeof(req)) {
337 DPRINTFN(0, "Unsupported SETUP packet "
338 "length, %d bytes\n", count);
342 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl,
343 td->fifo_reg, (void *)&req, sizeof(req));
345 /* copy data into real buffer */
346 usbd_copy_in(td->pc, 0, &req, sizeof(req));
348 td->offset = sizeof(req);
351 /* sneak peek the set address */
352 if ((req.bmRequestType == UT_WRITE_DEVICE) &&
353 (req.bRequest == UR_SET_ADDRESS)) {
354 sc->sc_dv_addr = req.wValue[0] & 0x7F;
356 sc->sc_dv_addr = 0xFF;
359 /* sneak peek the endpoint direction */
360 if (req.bmRequestType & UE_DIR_IN) {
361 csr |= AT91_UDP_CSR_DIR;
363 csr &= ~AT91_UDP_CSR_DIR;
366 /* write the direction of the control transfer */
367 AT91_CSR_ACK(csr, temp);
368 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
369 return (0); /* complete */
372 /* abort any ongoing transfer */
373 if (!td->did_stall) {
374 DPRINTFN(5, "stalling\n");
375 temp |= AT91_UDP_CSR_FORCESTALL;
379 /* clear interrupts, if any */
381 DPRINTFN(5, "clearing 0x%08x\n", temp);
382 AT91_CSR_ACK(csr, temp);
383 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
385 return (1); /* not complete */
389 at91dci_data_rx(struct at91dci_softc *sc, struct at91dci_td *td)
391 struct usb_page_search buf_res;
398 to = 2; /* don't loop forever! */
401 /* check if any of the FIFO banks have data */
403 /* read out FIFO status */
404 csr = AT91_UDP_READ_4(sc, td->status_reg);
406 DPRINTFN(5, "csr=0x%08x rem=%u\n", csr, td->remainder);
408 if (csr & AT91_UDP_CSR_RXSETUP) {
409 if (td->remainder == 0) {
411 * We are actually complete and have
412 * received the next SETUP
414 DPRINTFN(5, "faking complete\n");
415 return (0); /* complete */
418 * USB Host Aborted the transfer.
421 return (0); /* complete */
423 /* Make sure that "STALLSENT" gets cleared */
425 temp &= AT91_UDP_CSR_STALLSENT;
428 if (!(csr & (AT91_UDP_CSR_RX_DATA_BK0 |
429 AT91_UDP_CSR_RX_DATA_BK1))) {
432 AT91_CSR_ACK(csr, temp);
433 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
435 return (1); /* not complete */
437 /* get the packet byte count */
438 count = (csr & AT91_UDP_CSR_RXBYTECNT) >> 16;
440 /* verify the packet byte count */
441 if (count != td->max_packet_size) {
442 if (count < td->max_packet_size) {
443 /* we have a short packet */
447 /* invalid USB packet */
449 return (0); /* we are complete */
452 /* verify the packet byte count */
453 if (count > td->remainder) {
454 /* invalid USB packet */
456 return (0); /* we are complete */
459 usbd_get_page(td->pc, td->offset, &buf_res);
461 /* get correct length */
462 if (buf_res.length > count) {
463 buf_res.length = count;
466 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl,
467 td->fifo_reg, buf_res.buffer, buf_res.length);
469 /* update counters */
470 count -= buf_res.length;
471 td->offset += buf_res.length;
472 td->remainder -= buf_res.length;
475 /* clear status bits */
476 if (td->support_multi_buffer) {
479 temp |= AT91_UDP_CSR_RX_DATA_BK1;
482 temp |= AT91_UDP_CSR_RX_DATA_BK0;
485 temp |= (AT91_UDP_CSR_RX_DATA_BK0 |
486 AT91_UDP_CSR_RX_DATA_BK1);
490 AT91_CSR_ACK(csr, temp);
491 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
494 * NOTE: We may have to delay a little bit before
495 * proceeding after clearing the DATA_BK bits.
498 /* check if we are complete */
499 if ((td->remainder == 0) || got_short) {
501 /* we are complete */
504 /* else need to receive a zero length packet */
509 return (1); /* not complete */
513 at91dci_data_tx(struct at91dci_softc *sc, struct at91dci_td *td)
515 struct usb_page_search buf_res;
521 to = 2; /* don't loop forever! */
525 /* read out FIFO status */
526 csr = AT91_UDP_READ_4(sc, td->status_reg);
528 DPRINTFN(5, "csr=0x%08x rem=%u\n", csr, td->remainder);
530 if (csr & AT91_UDP_CSR_RXSETUP) {
532 * The current transfer was aborted
536 return (0); /* complete */
538 /* Make sure that "STALLSENT" gets cleared */
540 temp &= AT91_UDP_CSR_STALLSENT;
542 if (csr & AT91_UDP_CSR_TXPKTRDY) {
545 AT91_CSR_ACK(csr, temp);
546 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
548 return (1); /* not complete */
550 /* clear TXCOMP and set TXPKTRDY */
551 temp |= (AT91_UDP_CSR_TXCOMP |
552 AT91_UDP_CSR_TXPKTRDY);
555 count = td->max_packet_size;
556 if (td->remainder < count) {
557 /* we have a short packet */
559 count = td->remainder;
562 usbd_get_page(td->pc, td->offset, &buf_res);
564 /* get correct length */
565 if (buf_res.length > count) {
566 buf_res.length = count;
569 bus_space_write_multi_1(sc->sc_io_tag, sc->sc_io_hdl,
570 td->fifo_reg, buf_res.buffer, buf_res.length);
572 /* update counters */
573 count -= buf_res.length;
574 td->offset += buf_res.length;
575 td->remainder -= buf_res.length;
579 AT91_CSR_ACK(csr, temp);
580 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
582 /* check remainder */
583 if (td->remainder == 0) {
585 return (0); /* complete */
587 /* else we need to transmit a short packet */
592 return (1); /* not complete */
596 at91dci_data_tx_sync(struct at91dci_softc *sc, struct at91dci_td *td)
601 /* read out FIFO status */
602 csr = AT91_UDP_READ_4(sc, td->status_reg);
604 DPRINTFN(5, "csr=0x%08x\n", csr);
606 if (csr & AT91_UDP_CSR_RXSETUP) {
607 DPRINTFN(5, "faking complete\n");
609 return (0); /* complete */
612 temp &= (AT91_UDP_CSR_STALLSENT |
613 AT91_UDP_CSR_TXCOMP);
616 if (csr & AT91_UDP_CSR_TXPKTRDY) {
619 if (!(csr & AT91_UDP_CSR_TXCOMP)) {
622 if (td->status_reg == AT91_UDP_CSR(0) && sc->sc_dv_addr != 0xFF) {
624 * The AT91 has a special requirement with regard to
625 * setting the address and that is to write the new
626 * address before clearing TXCOMP:
628 at91dci_set_address(sc, sc->sc_dv_addr);
631 AT91_CSR_ACK(csr, temp);
632 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
634 return (0); /* complete */
639 AT91_CSR_ACK(csr, temp);
640 AT91_UDP_WRITE_4(sc, td->status_reg, csr);
642 return (1); /* not complete */
646 at91dci_xfer_do_fifo(struct usb_xfer *xfer)
648 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(xfer->xroot->bus);
649 struct at91dci_td *td;
654 td = xfer->td_transfer_cache;
659 if ((td->func) (sc, td)) {
660 /* operation in progress */
663 if (((void *)td) == xfer->td_transfer_last) {
668 } else if (td->remainder > 0) {
670 * We had a short transfer. If there is no alternate
671 * next, stop processing !
678 * Fetch the next transfer descriptor and transfer
679 * some flags to the next transfer descriptor
685 xfer->td_transfer_cache = td;
692 temp = (xfer->endpointno & UE_ADDR);
694 /* update FIFO bank flag and multi buffer */
696 sc->sc_ep_flags[temp].fifo_bank = 1;
698 sc->sc_ep_flags[temp].fifo_bank = 0;
701 /* compute all actual lengths */
702 xfer->td_transfer_cache = NULL;
703 sc->sc_xfer_complete = 1;
707 at91dci_xfer_do_complete(struct usb_xfer *xfer)
709 struct at91dci_td *td;
712 td = xfer->td_transfer_cache;
714 /* compute all actual lengths */
715 at91dci_standard_done(xfer);
722 at91dci_interrupt_poll_locked(struct at91dci_softc *sc)
724 struct usb_xfer *xfer;
726 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry)
727 at91dci_xfer_do_fifo(xfer);
731 at91dci_interrupt_complete_locked(struct at91dci_softc *sc)
733 struct usb_xfer *xfer;
735 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
736 if (at91dci_xfer_do_complete(xfer))
742 at91dci_vbus_interrupt(struct at91dci_softc *sc, uint8_t is_on)
744 DPRINTFN(5, "vbus = %u\n", is_on);
747 if (!sc->sc_flags.status_vbus) {
748 sc->sc_flags.status_vbus = 1;
750 /* complete root HUB interrupt endpoint */
751 at91dci_root_intr(sc);
754 if (sc->sc_flags.status_vbus) {
755 sc->sc_flags.status_vbus = 0;
756 sc->sc_flags.status_bus_reset = 0;
757 sc->sc_flags.status_suspend = 0;
758 sc->sc_flags.change_suspend = 0;
759 sc->sc_flags.change_connect = 1;
761 /* complete root HUB interrupt endpoint */
762 at91dci_root_intr(sc);
768 at91dci_filter_interrupt(void *arg)
770 struct at91dci_softc *sc = arg;
771 int retval = FILTER_HANDLED;
774 USB_BUS_SPIN_LOCK(&sc->sc_bus);
776 status = AT91_UDP_READ_4(sc, AT91_UDP_ISR);
777 status &= AT91_UDP_INT_DEFAULT;
779 if (status & AT9100_DCI_THREAD_IRQ)
780 retval = FILTER_SCHEDULE_THREAD;
782 /* acknowledge interrupts */
783 AT91_UDP_WRITE_4(sc, AT91_UDP_ICR, status & ~AT9100_DCI_THREAD_IRQ);
785 /* poll FIFOs, if any */
786 at91dci_interrupt_poll_locked(sc);
788 if (sc->sc_xfer_complete != 0)
789 retval = FILTER_SCHEDULE_THREAD;
791 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
797 at91dci_interrupt(void *arg)
799 struct at91dci_softc *sc = arg;
802 USB_BUS_LOCK(&sc->sc_bus);
803 USB_BUS_SPIN_LOCK(&sc->sc_bus);
805 status = AT91_UDP_READ_4(sc, AT91_UDP_ISR);
806 status &= AT9100_DCI_THREAD_IRQ;
808 /* acknowledge interrupts */
810 AT91_UDP_WRITE_4(sc, AT91_UDP_ICR, status);
812 /* check for any bus state change interrupts */
814 if (status & AT91_UDP_INT_BUS) {
816 DPRINTFN(5, "real bus interrupt 0x%08x\n", status);
818 if (status & AT91_UDP_INT_END_BR) {
820 /* set correct state */
821 sc->sc_flags.status_bus_reset = 1;
822 sc->sc_flags.status_suspend = 0;
823 sc->sc_flags.change_suspend = 0;
824 sc->sc_flags.change_connect = 1;
826 /* disable resume interrupt */
827 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR,
829 /* enable suspend interrupt */
830 AT91_UDP_WRITE_4(sc, AT91_UDP_IER,
831 AT91_UDP_INT_RXSUSP);
834 * If RXRSM and RXSUSP is set at the same time we interpret
835 * that like RESUME. Resume is set when there is at least 3
836 * milliseconds of inactivity on the USB BUS.
838 if (status & AT91_UDP_INT_RXRSM) {
839 if (sc->sc_flags.status_suspend) {
840 sc->sc_flags.status_suspend = 0;
841 sc->sc_flags.change_suspend = 1;
843 /* disable resume interrupt */
844 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR,
846 /* enable suspend interrupt */
847 AT91_UDP_WRITE_4(sc, AT91_UDP_IER,
848 AT91_UDP_INT_RXSUSP);
850 } else if (status & AT91_UDP_INT_RXSUSP) {
851 if (!sc->sc_flags.status_suspend) {
852 sc->sc_flags.status_suspend = 1;
853 sc->sc_flags.change_suspend = 1;
855 /* disable suspend interrupt */
856 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR,
857 AT91_UDP_INT_RXSUSP);
859 /* enable resume interrupt */
860 AT91_UDP_WRITE_4(sc, AT91_UDP_IER,
864 /* complete root HUB interrupt endpoint */
865 at91dci_root_intr(sc);
868 if (sc->sc_xfer_complete != 0) {
869 sc->sc_xfer_complete = 0;
870 at91dci_interrupt_complete_locked(sc);
872 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
873 USB_BUS_UNLOCK(&sc->sc_bus);
877 at91dci_setup_standard_chain_sub(struct at91dci_std_temp *temp)
879 struct at91dci_td *td;
881 /* get current Transfer Descriptor */
885 /* prepare for next TD */
886 temp->td_next = td->obj_next;
888 /* fill out the Transfer Descriptor */
889 td->func = temp->func;
891 td->offset = temp->offset;
892 td->remainder = temp->len;
895 td->did_stall = temp->did_stall;
896 td->short_pkt = temp->short_pkt;
897 td->alt_next = temp->setup_alt_next;
901 at91dci_setup_standard_chain(struct usb_xfer *xfer)
903 struct at91dci_std_temp temp;
904 struct at91dci_softc *sc;
905 struct at91dci_td *td;
910 DPRINTFN(9, "addr=%d endpt=%d sumlen=%d speed=%d\n",
911 xfer->address, UE_GET_ADDR(xfer->endpointno),
912 xfer->sumlen, usbd_get_speed(xfer->xroot->udev));
914 temp.max_frame_size = xfer->max_frame_size;
916 td = xfer->td_start[0];
917 xfer->td_transfer_first = td;
918 xfer->td_transfer_cache = td;
924 temp.td_next = xfer->td_start[0];
926 temp.setup_alt_next = xfer->flags_int.short_frames_ok ||
927 xfer->flags_int.isochronous_xfr;
928 temp.did_stall = !xfer->flags_int.control_stall;
930 sc = AT9100_DCI_BUS2SC(xfer->xroot->bus);
931 ep_no = (xfer->endpointno & UE_ADDR);
933 /* check if we should prepend a setup message */
935 if (xfer->flags_int.control_xfr) {
936 if (xfer->flags_int.control_hdr) {
938 temp.func = &at91dci_setup_rx;
939 temp.len = xfer->frlengths[0];
940 temp.pc = xfer->frbuffers + 0;
941 temp.short_pkt = temp.len ? 1 : 0;
942 /* check for last frame */
943 if (xfer->nframes == 1) {
944 /* no STATUS stage yet, SETUP is last */
945 if (xfer->flags_int.control_act)
946 temp.setup_alt_next = 0;
949 at91dci_setup_standard_chain_sub(&temp);
956 if (x != xfer->nframes) {
957 if (xfer->endpointno & UE_DIR_IN) {
958 temp.func = &at91dci_data_tx;
961 temp.func = &at91dci_data_rx;
965 /* setup "pc" pointer */
966 temp.pc = xfer->frbuffers + x;
970 while (x != xfer->nframes) {
972 /* DATA0 / DATA1 message */
974 temp.len = xfer->frlengths[x];
978 if (x == xfer->nframes) {
979 if (xfer->flags_int.control_xfr) {
980 if (xfer->flags_int.control_act) {
981 temp.setup_alt_next = 0;
984 temp.setup_alt_next = 0;
989 /* make sure that we send an USB packet */
995 /* regular data transfer */
997 temp.short_pkt = (xfer->flags.force_short_xfer) ? 0 : 1;
1000 at91dci_setup_standard_chain_sub(&temp);
1002 if (xfer->flags_int.isochronous_xfr) {
1003 temp.offset += temp.len;
1005 /* get next Page Cache pointer */
1006 temp.pc = xfer->frbuffers + x;
1010 /* check for control transfer */
1011 if (xfer->flags_int.control_xfr) {
1013 /* always setup a valid "pc" pointer for status and sync */
1014 temp.pc = xfer->frbuffers + 0;
1017 temp.setup_alt_next = 0;
1019 /* check if we need to sync */
1021 /* we need a SYNC point after TX */
1022 temp.func = &at91dci_data_tx_sync;
1023 at91dci_setup_standard_chain_sub(&temp);
1026 /* check if we should append a status stage */
1027 if (!xfer->flags_int.control_act) {
1030 * Send a DATA1 message and invert the current
1031 * endpoint direction.
1033 if (xfer->endpointno & UE_DIR_IN) {
1034 temp.func = &at91dci_data_rx;
1037 temp.func = &at91dci_data_tx;
1041 at91dci_setup_standard_chain_sub(&temp);
1043 /* we need a SYNC point after TX */
1044 temp.func = &at91dci_data_tx_sync;
1045 at91dci_setup_standard_chain_sub(&temp);
1050 /* must have at least one frame! */
1052 xfer->td_transfer_last = td;
1054 /* setup the correct fifo bank */
1055 if (sc->sc_ep_flags[ep_no].fifo_bank) {
1056 td = xfer->td_transfer_first;
1062 at91dci_timeout(void *arg)
1064 struct usb_xfer *xfer = arg;
1066 DPRINTF("xfer=%p\n", xfer);
1068 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1070 /* transfer is transferred */
1071 at91dci_device_done(xfer, USB_ERR_TIMEOUT);
1075 at91dci_start_standard_chain(struct usb_xfer *xfer)
1077 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(xfer->xroot->bus);
1081 USB_BUS_SPIN_LOCK(&sc->sc_bus);
1084 at91dci_xfer_do_fifo(xfer);
1086 if (at91dci_xfer_do_complete(xfer) == 0) {
1088 uint8_t ep_no = xfer->endpointno & UE_ADDR;
1091 * Only enable the endpoint interrupt when we are actually
1092 * waiting for data, hence we are dealing with level
1093 * triggered interrupts !
1095 AT91_UDP_WRITE_4(sc, AT91_UDP_IER, AT91_UDP_INT_EP(ep_no));
1097 DPRINTFN(15, "enable interrupts on endpoint %d\n", ep_no);
1099 /* put transfer on interrupt queue */
1100 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer);
1102 /* start timeout, if any */
1103 if (xfer->timeout != 0) {
1104 usbd_transfer_timeout_ms(xfer,
1105 &at91dci_timeout, xfer->timeout);
1108 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
1112 at91dci_root_intr(struct at91dci_softc *sc)
1116 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
1119 sc->sc_hub_idata[0] = 0x02; /* we only have one port */
1121 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata,
1122 sizeof(sc->sc_hub_idata));
1126 at91dci_standard_done_sub(struct usb_xfer *xfer)
1128 struct at91dci_td *td;
1134 td = xfer->td_transfer_cache;
1137 len = td->remainder;
1139 if (xfer->aframes != xfer->nframes) {
1141 * Verify the length and subtract
1142 * the remainder from "frlengths[]":
1144 if (len > xfer->frlengths[xfer->aframes]) {
1147 xfer->frlengths[xfer->aframes] -= len;
1150 /* Check for transfer error */
1152 /* the transfer is finished */
1157 /* Check for short transfer */
1159 if (xfer->flags_int.short_frames_ok ||
1160 xfer->flags_int.isochronous_xfr) {
1161 /* follow alt next */
1168 /* the transfer is finished */
1176 /* this USB frame is complete */
1182 /* update transfer cache */
1184 xfer->td_transfer_cache = td;
1187 USB_ERR_STALLED : USB_ERR_NORMAL_COMPLETION);
1191 at91dci_standard_done(struct usb_xfer *xfer)
1193 usb_error_t err = 0;
1195 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
1196 xfer, xfer->endpoint);
1200 xfer->td_transfer_cache = xfer->td_transfer_first;
1202 if (xfer->flags_int.control_xfr) {
1204 if (xfer->flags_int.control_hdr) {
1206 err = at91dci_standard_done_sub(xfer);
1210 if (xfer->td_transfer_cache == NULL) {
1214 while (xfer->aframes != xfer->nframes) {
1216 err = at91dci_standard_done_sub(xfer);
1219 if (xfer->td_transfer_cache == NULL) {
1224 if (xfer->flags_int.control_xfr &&
1225 !xfer->flags_int.control_act) {
1227 err = at91dci_standard_done_sub(xfer);
1230 at91dci_device_done(xfer, err);
1233 /*------------------------------------------------------------------------*
1234 * at91dci_device_done
1236 * NOTE: this function can be called more than one time on the
1237 * same USB transfer!
1238 *------------------------------------------------------------------------*/
1240 at91dci_device_done(struct usb_xfer *xfer, usb_error_t error)
1242 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(xfer->xroot->bus);
1245 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
1247 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n",
1248 xfer, xfer->endpoint, error);
1250 USB_BUS_SPIN_LOCK(&sc->sc_bus);
1252 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) {
1253 ep_no = (xfer->endpointno & UE_ADDR);
1255 /* disable endpoint interrupt */
1256 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR, AT91_UDP_INT_EP(ep_no));
1258 DPRINTFN(15, "disable interrupts on endpoint %d\n", ep_no);
1261 /* dequeue transfer and start next transfer */
1262 usbd_transfer_done(xfer, error);
1264 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
1268 at91dci_xfer_stall(struct usb_xfer *xfer)
1270 at91dci_device_done(xfer, USB_ERR_STALLED);
1274 at91dci_set_stall(struct usb_device *udev,
1275 struct usb_endpoint *ep, uint8_t *did_stall)
1277 struct at91dci_softc *sc;
1281 USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED);
1283 DPRINTFN(5, "endpoint=%p\n", ep);
1285 /* set FORCESTALL */
1286 sc = AT9100_DCI_BUS2SC(udev->bus);
1288 USB_BUS_SPIN_LOCK(&sc->sc_bus);
1289 csr_reg = (ep->edesc->bEndpointAddress & UE_ADDR);
1290 csr_reg = AT91_UDP_CSR(csr_reg);
1291 csr_val = AT91_UDP_READ_4(sc, csr_reg);
1292 AT91_CSR_ACK(csr_val, AT91_UDP_CSR_FORCESTALL);
1293 AT91_UDP_WRITE_4(sc, csr_reg, csr_val);
1294 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
1298 at91dci_clear_stall_sub(struct at91dci_softc *sc, uint8_t ep_no,
1299 uint8_t ep_type, uint8_t ep_dir)
1301 const struct usb_hw_ep_profile *pf;
1307 if (ep_type == UE_CONTROL) {
1308 /* clearing stall is not needed */
1312 USB_BUS_SPIN_LOCK(&sc->sc_bus);
1314 /* compute CSR register offset */
1315 csr_reg = AT91_UDP_CSR(ep_no);
1317 /* compute default CSR value */
1319 AT91_CSR_ACK(csr_val, 0);
1321 /* disable endpoint */
1322 AT91_UDP_WRITE_4(sc, csr_reg, csr_val);
1324 /* get endpoint profile */
1325 at91dci_get_hw_ep_profile(NULL, &pf, ep_no);
1328 AT91_UDP_WRITE_4(sc, AT91_UDP_RST, AT91_UDP_RST_EP(ep_no));
1329 AT91_UDP_WRITE_4(sc, AT91_UDP_RST, 0);
1332 * NOTE: One would assume that a FIFO reset would release the
1333 * FIFO banks as well, but it doesn't! We have to do this
1337 /* release FIFO banks, if any */
1338 for (to = 0; to != 2; to++) {
1341 csr_val = AT91_UDP_READ_4(sc, csr_reg);
1343 if (csr_val & (AT91_UDP_CSR_RX_DATA_BK0 |
1344 AT91_UDP_CSR_RX_DATA_BK1)) {
1345 /* clear status bits */
1346 if (pf->support_multi_buffer) {
1347 if (sc->sc_ep_flags[ep_no].fifo_bank) {
1348 sc->sc_ep_flags[ep_no].fifo_bank = 0;
1349 temp = AT91_UDP_CSR_RX_DATA_BK1;
1351 sc->sc_ep_flags[ep_no].fifo_bank = 1;
1352 temp = AT91_UDP_CSR_RX_DATA_BK0;
1355 temp = (AT91_UDP_CSR_RX_DATA_BK0 |
1356 AT91_UDP_CSR_RX_DATA_BK1);
1362 /* clear FORCESTALL */
1363 temp |= AT91_UDP_CSR_STALLSENT;
1365 AT91_CSR_ACK(csr_val, temp);
1366 AT91_UDP_WRITE_4(sc, csr_reg, csr_val);
1369 /* compute default CSR value */
1371 AT91_CSR_ACK(csr_val, 0);
1373 /* enable endpoint */
1374 csr_val &= ~AT91_UDP_CSR_ET_MASK;
1375 csr_val |= AT91_UDP_CSR_EPEDS;
1377 if (ep_type == UE_CONTROL) {
1378 csr_val |= AT91_UDP_CSR_ET_CTRL;
1380 if (ep_type == UE_BULK) {
1381 csr_val |= AT91_UDP_CSR_ET_BULK;
1382 } else if (ep_type == UE_INTERRUPT) {
1383 csr_val |= AT91_UDP_CSR_ET_INT;
1385 csr_val |= AT91_UDP_CSR_ET_ISO;
1387 if (ep_dir & UE_DIR_IN) {
1388 csr_val |= AT91_UDP_CSR_ET_DIR_IN;
1392 /* enable endpoint */
1393 AT91_UDP_WRITE_4(sc, AT91_UDP_CSR(ep_no), csr_val);
1395 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
1399 at91dci_clear_stall(struct usb_device *udev, struct usb_endpoint *ep)
1401 struct at91dci_softc *sc;
1402 struct usb_endpoint_descriptor *ed;
1404 DPRINTFN(5, "endpoint=%p\n", ep);
1406 USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED);
1409 if (udev->flags.usb_mode != USB_MODE_DEVICE) {
1414 sc = AT9100_DCI_BUS2SC(udev->bus);
1416 /* get endpoint descriptor */
1419 /* reset endpoint */
1420 at91dci_clear_stall_sub(sc,
1421 (ed->bEndpointAddress & UE_ADDR),
1422 (ed->bmAttributes & UE_XFERTYPE),
1423 (ed->bEndpointAddress & (UE_DIR_IN | UE_DIR_OUT)));
1427 at91dci_init(struct at91dci_softc *sc)
1434 /* set up the bus structure */
1435 sc->sc_bus.usbrev = USB_REV_1_1;
1436 sc->sc_bus.methods = &at91dci_bus_methods;
1438 USB_BUS_LOCK(&sc->sc_bus);
1440 /* turn on clocks */
1442 if (sc->sc_clocks_on) {
1443 (sc->sc_clocks_on) (sc->sc_clocks_arg);
1445 /* wait a little for things to stabilise */
1446 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 1000);
1448 /* disable and clear all interrupts */
1450 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR, 0xFFFFFFFF);
1451 AT91_UDP_WRITE_4(sc, AT91_UDP_ICR, 0xFFFFFFFF);
1453 /* compute default CSR value */
1456 AT91_CSR_ACK(csr_val, 0);
1458 /* disable all endpoints */
1460 for (n = 0; n != AT91_UDP_EP_MAX; n++) {
1462 /* disable endpoint */
1463 AT91_UDP_WRITE_4(sc, AT91_UDP_CSR(n), csr_val);
1466 /* enable the control endpoint */
1468 AT91_CSR_ACK(csr_val, AT91_UDP_CSR_ET_CTRL |
1469 AT91_UDP_CSR_EPEDS);
1471 /* write to FIFO control register */
1473 AT91_UDP_WRITE_4(sc, AT91_UDP_CSR(0), csr_val);
1475 /* enable the interrupts we want */
1477 AT91_UDP_WRITE_4(sc, AT91_UDP_IER, AT91_UDP_INT_BUS);
1479 /* turn off clocks */
1481 at91dci_clocks_off(sc);
1483 USB_BUS_UNLOCK(&sc->sc_bus);
1485 /* catch any lost interrupts */
1487 at91dci_do_poll(&sc->sc_bus);
1489 return (0); /* success */
1493 at91dci_uninit(struct at91dci_softc *sc)
1495 USB_BUS_LOCK(&sc->sc_bus);
1497 /* disable and clear all interrupts */
1498 AT91_UDP_WRITE_4(sc, AT91_UDP_IDR, 0xFFFFFFFF);
1499 AT91_UDP_WRITE_4(sc, AT91_UDP_ICR, 0xFFFFFFFF);
1501 sc->sc_flags.port_powered = 0;
1502 sc->sc_flags.status_vbus = 0;
1503 sc->sc_flags.status_bus_reset = 0;
1504 sc->sc_flags.status_suspend = 0;
1505 sc->sc_flags.change_suspend = 0;
1506 sc->sc_flags.change_connect = 1;
1508 at91dci_pull_down(sc);
1509 at91dci_clocks_off(sc);
1510 USB_BUS_UNLOCK(&sc->sc_bus);
1514 at91dci_suspend(struct at91dci_softc *sc)
1520 at91dci_resume(struct at91dci_softc *sc)
1526 at91dci_do_poll(struct usb_bus *bus)
1528 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(bus);
1530 USB_BUS_LOCK(&sc->sc_bus);
1531 USB_BUS_SPIN_LOCK(&sc->sc_bus);
1532 at91dci_interrupt_poll_locked(sc);
1533 at91dci_interrupt_complete_locked(sc);
1534 USB_BUS_SPIN_UNLOCK(&sc->sc_bus);
1535 USB_BUS_UNLOCK(&sc->sc_bus);
1538 /*------------------------------------------------------------------------*
1539 * at91dci bulk support
1540 *------------------------------------------------------------------------*/
1542 at91dci_device_bulk_open(struct usb_xfer *xfer)
1548 at91dci_device_bulk_close(struct usb_xfer *xfer)
1550 at91dci_device_done(xfer, USB_ERR_CANCELLED);
1554 at91dci_device_bulk_enter(struct usb_xfer *xfer)
1560 at91dci_device_bulk_start(struct usb_xfer *xfer)
1563 at91dci_setup_standard_chain(xfer);
1564 at91dci_start_standard_chain(xfer);
1567 static const struct usb_pipe_methods at91dci_device_bulk_methods =
1569 .open = at91dci_device_bulk_open,
1570 .close = at91dci_device_bulk_close,
1571 .enter = at91dci_device_bulk_enter,
1572 .start = at91dci_device_bulk_start,
1575 /*------------------------------------------------------------------------*
1576 * at91dci control support
1577 *------------------------------------------------------------------------*/
1579 at91dci_device_ctrl_open(struct usb_xfer *xfer)
1585 at91dci_device_ctrl_close(struct usb_xfer *xfer)
1587 at91dci_device_done(xfer, USB_ERR_CANCELLED);
1591 at91dci_device_ctrl_enter(struct usb_xfer *xfer)
1597 at91dci_device_ctrl_start(struct usb_xfer *xfer)
1600 at91dci_setup_standard_chain(xfer);
1601 at91dci_start_standard_chain(xfer);
1604 static const struct usb_pipe_methods at91dci_device_ctrl_methods =
1606 .open = at91dci_device_ctrl_open,
1607 .close = at91dci_device_ctrl_close,
1608 .enter = at91dci_device_ctrl_enter,
1609 .start = at91dci_device_ctrl_start,
1612 /*------------------------------------------------------------------------*
1613 * at91dci interrupt support
1614 *------------------------------------------------------------------------*/
1616 at91dci_device_intr_open(struct usb_xfer *xfer)
1622 at91dci_device_intr_close(struct usb_xfer *xfer)
1624 at91dci_device_done(xfer, USB_ERR_CANCELLED);
1628 at91dci_device_intr_enter(struct usb_xfer *xfer)
1634 at91dci_device_intr_start(struct usb_xfer *xfer)
1637 at91dci_setup_standard_chain(xfer);
1638 at91dci_start_standard_chain(xfer);
1641 static const struct usb_pipe_methods at91dci_device_intr_methods =
1643 .open = at91dci_device_intr_open,
1644 .close = at91dci_device_intr_close,
1645 .enter = at91dci_device_intr_enter,
1646 .start = at91dci_device_intr_start,
1649 /*------------------------------------------------------------------------*
1650 * at91dci full speed isochronous support
1651 *------------------------------------------------------------------------*/
1653 at91dci_device_isoc_fs_open(struct usb_xfer *xfer)
1659 at91dci_device_isoc_fs_close(struct usb_xfer *xfer)
1661 at91dci_device_done(xfer, USB_ERR_CANCELLED);
1665 at91dci_device_isoc_fs_enter(struct usb_xfer *xfer)
1667 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(xfer->xroot->bus);
1671 DPRINTFN(6, "xfer=%p next=%d nframes=%d\n",
1672 xfer, xfer->endpoint->isoc_next, xfer->nframes);
1674 /* get the current frame index */
1676 nframes = AT91_UDP_READ_4(sc, AT91_UDP_FRM);
1679 * check if the frame index is within the window where the frames
1682 temp = (nframes - xfer->endpoint->isoc_next) & AT91_UDP_FRM_MASK;
1684 if ((xfer->endpoint->is_synced == 0) ||
1685 (temp < xfer->nframes)) {
1687 * If there is data underflow or the endpoint queue is
1688 * empty we schedule the transfer a few frames ahead
1689 * of the current frame position. Else two isochronous
1690 * transfers might overlap.
1692 xfer->endpoint->isoc_next = (nframes + 3) & AT91_UDP_FRM_MASK;
1693 xfer->endpoint->is_synced = 1;
1694 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next);
1697 * compute how many milliseconds the insertion is ahead of the
1698 * current frame position:
1700 temp = (xfer->endpoint->isoc_next - nframes) & AT91_UDP_FRM_MASK;
1703 * pre-compute when the isochronous transfer will be finished:
1705 xfer->isoc_time_complete =
1706 usb_isoc_time_expand(&sc->sc_bus, nframes) + temp +
1709 /* compute frame number for next insertion */
1710 xfer->endpoint->isoc_next += xfer->nframes;
1713 at91dci_setup_standard_chain(xfer);
1717 at91dci_device_isoc_fs_start(struct usb_xfer *xfer)
1719 /* start TD chain */
1720 at91dci_start_standard_chain(xfer);
1723 static const struct usb_pipe_methods at91dci_device_isoc_fs_methods =
1725 .open = at91dci_device_isoc_fs_open,
1726 .close = at91dci_device_isoc_fs_close,
1727 .enter = at91dci_device_isoc_fs_enter,
1728 .start = at91dci_device_isoc_fs_start,
1731 /*------------------------------------------------------------------------*
1732 * at91dci root control support
1733 *------------------------------------------------------------------------*
1734 * Simulate a hardware HUB by handling all the necessary requests.
1735 *------------------------------------------------------------------------*/
1737 static const struct usb_device_descriptor at91dci_devd = {
1738 .bLength = sizeof(struct usb_device_descriptor),
1739 .bDescriptorType = UDESC_DEVICE,
1740 .bcdUSB = {0x00, 0x02},
1741 .bDeviceClass = UDCLASS_HUB,
1742 .bDeviceSubClass = UDSUBCLASS_HUB,
1743 .bDeviceProtocol = UDPROTO_FSHUB,
1744 .bMaxPacketSize = 64,
1745 .bcdDevice = {0x00, 0x01},
1748 .bNumConfigurations = 1,
1751 static const struct at91dci_config_desc at91dci_confd = {
1753 .bLength = sizeof(struct usb_config_descriptor),
1754 .bDescriptorType = UDESC_CONFIG,
1755 .wTotalLength[0] = sizeof(at91dci_confd),
1757 .bConfigurationValue = 1,
1758 .iConfiguration = 0,
1759 .bmAttributes = UC_SELF_POWERED,
1763 .bLength = sizeof(struct usb_interface_descriptor),
1764 .bDescriptorType = UDESC_INTERFACE,
1766 .bInterfaceClass = UICLASS_HUB,
1767 .bInterfaceSubClass = UISUBCLASS_HUB,
1768 .bInterfaceProtocol = 0,
1771 .bLength = sizeof(struct usb_endpoint_descriptor),
1772 .bDescriptorType = UDESC_ENDPOINT,
1773 .bEndpointAddress = (UE_DIR_IN | AT9100_DCI_INTR_ENDPT),
1774 .bmAttributes = UE_INTERRUPT,
1775 .wMaxPacketSize[0] = 8,
1780 #define HSETW(ptr, val) ptr = { (uint8_t)(val), (uint8_t)((val) >> 8) }
1782 static const struct usb_hub_descriptor_min at91dci_hubd = {
1783 .bDescLength = sizeof(at91dci_hubd),
1784 .bDescriptorType = UDESC_HUB,
1786 HSETW(.wHubCharacteristics, (UHD_PWR_NO_SWITCH | UHD_OC_INDIVIDUAL)),
1787 .bPwrOn2PwrGood = 50,
1788 .bHubContrCurrent = 0,
1789 .DeviceRemovable = {0}, /* port is removable */
1792 #define STRING_VENDOR \
1795 #define STRING_PRODUCT \
1796 "D\0C\0I\0 \0R\0o\0o\0t\0 \0H\0U\0B"
1798 USB_MAKE_STRING_DESC(STRING_VENDOR, at91dci_vendor);
1799 USB_MAKE_STRING_DESC(STRING_PRODUCT, at91dci_product);
1802 at91dci_roothub_exec(struct usb_device *udev,
1803 struct usb_device_request *req, const void **pptr, uint16_t *plength)
1805 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(udev->bus);
1812 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
1815 ptr = (const void *)&sc->sc_hub_temp;
1819 value = UGETW(req->wValue);
1820 index = UGETW(req->wIndex);
1822 /* demultiplex the control request */
1824 switch (req->bmRequestType) {
1825 case UT_READ_DEVICE:
1826 switch (req->bRequest) {
1827 case UR_GET_DESCRIPTOR:
1828 goto tr_handle_get_descriptor;
1830 goto tr_handle_get_config;
1832 goto tr_handle_get_status;
1838 case UT_WRITE_DEVICE:
1839 switch (req->bRequest) {
1840 case UR_SET_ADDRESS:
1841 goto tr_handle_set_address;
1843 goto tr_handle_set_config;
1844 case UR_CLEAR_FEATURE:
1845 goto tr_valid; /* nop */
1846 case UR_SET_DESCRIPTOR:
1847 goto tr_valid; /* nop */
1848 case UR_SET_FEATURE:
1854 case UT_WRITE_ENDPOINT:
1855 switch (req->bRequest) {
1856 case UR_CLEAR_FEATURE:
1857 switch (UGETW(req->wValue)) {
1858 case UF_ENDPOINT_HALT:
1859 goto tr_handle_clear_halt;
1860 case UF_DEVICE_REMOTE_WAKEUP:
1861 goto tr_handle_clear_wakeup;
1866 case UR_SET_FEATURE:
1867 switch (UGETW(req->wValue)) {
1868 case UF_ENDPOINT_HALT:
1869 goto tr_handle_set_halt;
1870 case UF_DEVICE_REMOTE_WAKEUP:
1871 goto tr_handle_set_wakeup;
1876 case UR_SYNCH_FRAME:
1877 goto tr_valid; /* nop */
1883 case UT_READ_ENDPOINT:
1884 switch (req->bRequest) {
1886 goto tr_handle_get_ep_status;
1892 case UT_WRITE_INTERFACE:
1893 switch (req->bRequest) {
1894 case UR_SET_INTERFACE:
1895 goto tr_handle_set_interface;
1896 case UR_CLEAR_FEATURE:
1897 goto tr_valid; /* nop */
1898 case UR_SET_FEATURE:
1904 case UT_READ_INTERFACE:
1905 switch (req->bRequest) {
1906 case UR_GET_INTERFACE:
1907 goto tr_handle_get_interface;
1909 goto tr_handle_get_iface_status;
1915 case UT_WRITE_CLASS_INTERFACE:
1916 case UT_WRITE_VENDOR_INTERFACE:
1920 case UT_READ_CLASS_INTERFACE:
1921 case UT_READ_VENDOR_INTERFACE:
1925 case UT_WRITE_CLASS_DEVICE:
1926 switch (req->bRequest) {
1927 case UR_CLEAR_FEATURE:
1929 case UR_SET_DESCRIPTOR:
1930 case UR_SET_FEATURE:
1937 case UT_WRITE_CLASS_OTHER:
1938 switch (req->bRequest) {
1939 case UR_CLEAR_FEATURE:
1940 goto tr_handle_clear_port_feature;
1941 case UR_SET_FEATURE:
1942 goto tr_handle_set_port_feature;
1943 case UR_CLEAR_TT_BUFFER:
1953 case UT_READ_CLASS_OTHER:
1954 switch (req->bRequest) {
1955 case UR_GET_TT_STATE:
1956 goto tr_handle_get_tt_state;
1958 goto tr_handle_get_port_status;
1964 case UT_READ_CLASS_DEVICE:
1965 switch (req->bRequest) {
1966 case UR_GET_DESCRIPTOR:
1967 goto tr_handle_get_class_descriptor;
1969 goto tr_handle_get_class_status;
1980 tr_handle_get_descriptor:
1981 switch (value >> 8) {
1986 len = sizeof(at91dci_devd);
1987 ptr = (const void *)&at91dci_devd;
1993 len = sizeof(at91dci_confd);
1994 ptr = (const void *)&at91dci_confd;
1997 switch (value & 0xff) {
1998 case 0: /* Language table */
1999 len = sizeof(usb_string_lang_en);
2000 ptr = (const void *)&usb_string_lang_en;
2003 case 1: /* Vendor */
2004 len = sizeof(at91dci_vendor);
2005 ptr = (const void *)&at91dci_vendor;
2008 case 2: /* Product */
2009 len = sizeof(at91dci_product);
2010 ptr = (const void *)&at91dci_product;
2021 tr_handle_get_config:
2023 sc->sc_hub_temp.wValue[0] = sc->sc_conf;
2026 tr_handle_get_status:
2028 USETW(sc->sc_hub_temp.wValue, UDS_SELF_POWERED);
2031 tr_handle_set_address:
2032 if (value & 0xFF00) {
2035 sc->sc_rt_addr = value;
2038 tr_handle_set_config:
2042 sc->sc_conf = value;
2045 tr_handle_get_interface:
2047 sc->sc_hub_temp.wValue[0] = 0;
2050 tr_handle_get_tt_state:
2051 tr_handle_get_class_status:
2052 tr_handle_get_iface_status:
2053 tr_handle_get_ep_status:
2055 USETW(sc->sc_hub_temp.wValue, 0);
2059 tr_handle_set_interface:
2060 tr_handle_set_wakeup:
2061 tr_handle_clear_wakeup:
2062 tr_handle_clear_halt:
2065 tr_handle_clear_port_feature:
2069 DPRINTFN(9, "UR_CLEAR_PORT_FEATURE on port %d\n", index);
2072 case UHF_PORT_SUSPEND:
2073 at91dci_wakeup_peer(sc);
2076 case UHF_PORT_ENABLE:
2077 sc->sc_flags.port_enabled = 0;
2081 case UHF_PORT_INDICATOR:
2082 case UHF_C_PORT_ENABLE:
2083 case UHF_C_PORT_OVER_CURRENT:
2084 case UHF_C_PORT_RESET:
2087 case UHF_PORT_POWER:
2088 sc->sc_flags.port_powered = 0;
2089 at91dci_pull_down(sc);
2090 at91dci_clocks_off(sc);
2092 case UHF_C_PORT_CONNECTION:
2093 sc->sc_flags.change_connect = 0;
2095 case UHF_C_PORT_SUSPEND:
2096 sc->sc_flags.change_suspend = 0;
2099 err = USB_ERR_IOERROR;
2104 tr_handle_set_port_feature:
2108 DPRINTFN(9, "UR_SET_PORT_FEATURE\n");
2111 case UHF_PORT_ENABLE:
2112 sc->sc_flags.port_enabled = 1;
2114 case UHF_PORT_SUSPEND:
2115 case UHF_PORT_RESET:
2117 case UHF_PORT_INDICATOR:
2120 case UHF_PORT_POWER:
2121 sc->sc_flags.port_powered = 1;
2124 err = USB_ERR_IOERROR;
2129 tr_handle_get_port_status:
2131 DPRINTFN(9, "UR_GET_PORT_STATUS\n");
2136 if (sc->sc_flags.status_vbus) {
2137 at91dci_clocks_on(sc);
2138 at91dci_pull_up(sc);
2140 at91dci_pull_down(sc);
2141 at91dci_clocks_off(sc);
2144 /* Select FULL-speed and Device Side Mode */
2146 value = UPS_PORT_MODE_DEVICE;
2148 if (sc->sc_flags.port_powered) {
2149 value |= UPS_PORT_POWER;
2151 if (sc->sc_flags.port_enabled) {
2152 value |= UPS_PORT_ENABLED;
2154 if (sc->sc_flags.status_vbus &&
2155 sc->sc_flags.status_bus_reset) {
2156 value |= UPS_CURRENT_CONNECT_STATUS;
2158 if (sc->sc_flags.status_suspend) {
2159 value |= UPS_SUSPEND;
2161 USETW(sc->sc_hub_temp.ps.wPortStatus, value);
2165 if (sc->sc_flags.change_connect) {
2166 value |= UPS_C_CONNECT_STATUS;
2168 if (sc->sc_flags.status_vbus &&
2169 sc->sc_flags.status_bus_reset) {
2170 /* reset endpoint flags */
2171 memset(sc->sc_ep_flags, 0, sizeof(sc->sc_ep_flags));
2174 if (sc->sc_flags.change_suspend) {
2175 value |= UPS_C_SUSPEND;
2177 USETW(sc->sc_hub_temp.ps.wPortChange, value);
2178 len = sizeof(sc->sc_hub_temp.ps);
2181 tr_handle_get_class_descriptor:
2185 ptr = (const void *)&at91dci_hubd;
2186 len = sizeof(at91dci_hubd);
2190 err = USB_ERR_STALLED;
2199 at91dci_xfer_setup(struct usb_setup_params *parm)
2201 const struct usb_hw_ep_profile *pf;
2202 struct at91dci_softc *sc;
2203 struct usb_xfer *xfer;
2209 sc = AT9100_DCI_BUS2SC(parm->udev->bus);
2210 xfer = parm->curr_xfer;
2213 * NOTE: This driver does not use any of the parameters that
2214 * are computed from the following values. Just set some
2215 * reasonable dummies:
2217 parm->hc_max_packet_size = 0x500;
2218 parm->hc_max_packet_count = 1;
2219 parm->hc_max_frame_size = 0x500;
2221 usbd_transfer_setup_sub(parm);
2224 * compute maximum number of TDs
2226 if (parm->methods == &at91dci_device_ctrl_methods) {
2228 ntd = xfer->nframes + 1 /* STATUS */ + 1 /* SYNC 1 */
2231 } else if (parm->methods == &at91dci_device_bulk_methods) {
2233 ntd = xfer->nframes + 1 /* SYNC */ ;
2235 } else if (parm->methods == &at91dci_device_intr_methods) {
2237 ntd = xfer->nframes + 1 /* SYNC */ ;
2239 } else if (parm->methods == &at91dci_device_isoc_fs_methods) {
2241 ntd = xfer->nframes + 1 /* SYNC */ ;
2249 * check if "usbd_transfer_setup_sub" set an error
2255 * allocate transfer descriptors
2264 ep_no = xfer->endpointno & UE_ADDR;
2265 at91dci_get_hw_ep_profile(parm->udev, &pf, ep_no);
2268 /* should not happen */
2269 parm->err = USB_ERR_INVAL;
2278 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1));
2280 for (n = 0; n != ntd; n++) {
2282 struct at91dci_td *td;
2286 td = USB_ADD_BYTES(parm->buf, parm->size[0]);
2289 td->max_packet_size = xfer->max_packet_size;
2290 td->status_reg = AT91_UDP_CSR(ep_no);
2291 td->fifo_reg = AT91_UDP_FDR(ep_no);
2292 if (pf->support_multi_buffer) {
2293 td->support_multi_buffer = 1;
2295 td->obj_next = last_obj;
2299 parm->size[0] += sizeof(*td);
2302 xfer->td_start[0] = last_obj;
2306 at91dci_xfer_unsetup(struct usb_xfer *xfer)
2312 at91dci_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc,
2313 struct usb_endpoint *ep)
2315 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(udev->bus);
2317 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d (%d)\n",
2319 edesc->bEndpointAddress, udev->flags.usb_mode,
2322 if (udev->device_index != sc->sc_rt_addr) {
2324 if (udev->speed != USB_SPEED_FULL) {
2328 switch (edesc->bmAttributes & UE_XFERTYPE) {
2330 ep->methods = &at91dci_device_ctrl_methods;
2333 ep->methods = &at91dci_device_intr_methods;
2335 case UE_ISOCHRONOUS:
2336 ep->methods = &at91dci_device_isoc_fs_methods;
2339 ep->methods = &at91dci_device_bulk_methods;
2349 at91dci_set_hw_power_sleep(struct usb_bus *bus, uint32_t state)
2351 struct at91dci_softc *sc = AT9100_DCI_BUS2SC(bus);
2354 case USB_HW_POWER_SUSPEND:
2355 at91dci_suspend(sc);
2357 case USB_HW_POWER_SHUTDOWN:
2360 case USB_HW_POWER_RESUME:
2368 static const struct usb_bus_methods at91dci_bus_methods =
2370 .endpoint_init = &at91dci_ep_init,
2371 .xfer_setup = &at91dci_xfer_setup,
2372 .xfer_unsetup = &at91dci_xfer_unsetup,
2373 .get_hw_ep_profile = &at91dci_get_hw_ep_profile,
2374 .set_stall = &at91dci_set_stall,
2375 .xfer_stall = &at91dci_xfer_stall,
2376 .clear_stall = &at91dci_clear_stall,
2377 .roothub_exec = &at91dci_roothub_exec,
2378 .xfer_poll = &at91dci_do_poll,
2379 .set_hw_power_sleep = &at91dci_set_hw_power_sleep,