2 * Copyright (C) 2006 by Bryan O'Donoghue, CodeHermit
3 * bodonoghue@CodeHermit.ie
6 * DasUBoot/drivers/usb/gadget/omap1510_udc.c, for design and implementation
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the
21 * Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 * 1. #define __SIMULATE_ERROR__ to inject a CRC error into every 2nd TX
29 * packet to force the USB re-transmit protocol.
31 * 2. #define __DEBUG_UDC__ to switch on debug tracing to serial console
32 * be careful that tracing doesn't create Hiesen-bugs with respect to
33 * response timeouts to control requests.
35 * 3. This driver should be able to support any higher level driver that
36 * that wants to do either of the two standard UDC implementations
37 * Control-Bulk-Interrupt or Bulk-IN/Bulk-Out standards. Hence
38 * gserial and cdc_acm should work with this code.
40 * 4. NAK events never actually get raised at all, the documentation
43 * 5. For some reason, cbd_datlen is *always* +2 the value it should be.
44 * this means that having an RX cbd of 16 bytes is not possible, since
45 * the same size is reported for 14 bytes received as 16 bytes received
46 * until we can find out why this happens, RX cbds must be limited to 8
47 * bytes. TODO: check errata for this behaviour.
49 * 6. Right now this code doesn't support properly powering up with the USB
50 * cable attached to the USB host my development board the Adder87x doesn't
51 * have a pull-up fitted to allow this, so it is necessary to power the
52 * board and *then* attached the USB cable to the host. However somebody
53 * with a different design in their board may be able to keep the cable
54 * constantly connected and simply enable/disable a pull-up re
55 * figure 31.1 in MPC885RM.pdf instead of having to power up the board and
56 * then attach the cable !
62 #include <usbdevice.h>
63 #include <usb/mpc8xx_udc.h>
67 DECLARE_GLOBAL_DATA_PTR;
69 #define ERR(fmt, args...)\
70 serial_printf("ERROR : [%s] %s:%d: "fmt,\
71 __FILE__,__FUNCTION__,__LINE__, ##args)
73 #define DBG(fmt,args...)\
74 serial_printf("[%s] %s:%d: "fmt,\
75 __FILE__,__FUNCTION__,__LINE__, ##args)
77 #define DBG(fmt,args...)
81 #ifdef __SIMULATE_ERROR__
82 static char err_poison_test = 0;
84 static struct mpc8xx_ep ep_ref[MAX_ENDPOINTS];
85 static u32 address_base = STATE_NOT_READY;
86 static mpc8xx_udc_state_t udc_state = 0;
87 static struct usb_device_instance *udc_device = 0;
88 static volatile usb_epb_t *endpoints[MAX_ENDPOINTS];
89 static volatile cbd_t *tx_cbd[TX_RING_SIZE];
90 static volatile cbd_t *rx_cbd[RX_RING_SIZE];
91 static volatile immap_t *immr = 0;
92 static volatile cpm8xx_t *cp = 0;
93 static volatile usb_pram_t *usb_paramp = 0;
94 static volatile usb_t *usbp = 0;
98 /* Static Function Declarations */
99 static void mpc8xx_udc_state_transition_up (usb_device_state_t initial,
100 usb_device_state_t final);
101 static void mpc8xx_udc_state_transition_down (usb_device_state_t initial,
102 usb_device_state_t final);
103 static void mpc8xx_udc_stall (unsigned int ep);
104 static void mpc8xx_udc_flush_tx_fifo (int epid);
105 static void mpc8xx_udc_flush_rx_fifo (void);
106 static void mpc8xx_udc_clear_rxbd (volatile cbd_t * rx_cbdp);
107 static void mpc8xx_udc_init_tx (struct usb_endpoint_instance *epi,
109 static void mpc8xx_udc_dump_request (struct usb_device_request *request);
110 static void mpc8xx_udc_clock_init (volatile immap_t * immr,
111 volatile cpm8xx_t * cp);
112 static int mpc8xx_udc_ep_tx (struct usb_endpoint_instance *epi);
113 static int mpc8xx_udc_epn_rx (unsigned int epid, volatile cbd_t * rx_cbdp);
114 static void mpc8xx_udc_ep0_rx (volatile cbd_t * rx_cbdp);
115 static void mpc8xx_udc_cbd_init (void);
116 static void mpc8xx_udc_endpoint_init (void);
117 static void mpc8xx_udc_cbd_attach (int ep, uchar tx_size, uchar rx_size);
118 static u32 mpc8xx_udc_alloc (u32 data_size, u32 alignment);
119 static int mpc8xx_udc_ep0_rx_setup (volatile cbd_t * rx_cbdp);
120 static void mpc8xx_udc_set_nak (unsigned int ep);
121 static short mpc8xx_udc_handle_txerr (void);
122 static void mpc8xx_udc_advance_rx (volatile cbd_t ** rx_cbdp, int epid);
124 /******************************************************************************
126 *****************************************************************************/
130 * Do initial bus gluing
134 /* Init various pointers */
135 immr = (immap_t *) CONFIG_SYS_IMMR;
136 cp = (cpm8xx_t *) & (immr->im_cpm);
137 usb_paramp = (usb_pram_t *) & (cp->cp_dparam[PROFF_USB]);
138 usbp = (usb_t *) & (cp->cp_scc[0]);
140 memset (ep_ref, 0x00, (sizeof (struct mpc8xx_ep) * MAX_ENDPOINTS));
143 udc_state = STATE_NOT_READY;
148 /* Set USB Frame #0, Respond at Address & Get a clock source */
150 mpc8xx_udc_clock_init (immr, cp);
152 /* PA15, PA14 as perhiperal USBRXD and USBOE */
153 immr->im_ioport.iop_padir &= ~0x0003;
154 immr->im_ioport.iop_papar |= 0x0003;
156 /* PC11/PC10 as peripheral USBRXP USBRXN */
157 immr->im_ioport.iop_pcso |= 0x0030;
159 /* PC7/PC6 as perhiperal USBTXP and USBTXN */
160 immr->im_ioport.iop_pcdir |= 0x0300;
161 immr->im_ioport.iop_pcpar |= 0x0300;
163 /* Set the base address */
164 address_base = (u32) (cp->cp_dpmem + CPM_USB_BASE);
166 /* Initialise endpoints and circular buffers */
167 mpc8xx_udc_endpoint_init ();
168 mpc8xx_udc_cbd_init ();
170 /* Assign allocated Dual Port Endpoint descriptors */
171 usb_paramp->ep0ptr = (u32) endpoints[0];
172 usb_paramp->ep1ptr = (u32) endpoints[1];
173 usb_paramp->ep2ptr = (u32) endpoints[2];
174 usb_paramp->ep3ptr = (u32) endpoints[3];
175 usb_paramp->frame_n = 0;
177 DBG ("ep0ptr=0x%08x ep1ptr=0x%08x ep2ptr=0x%08x ep3ptr=0x%08x\n",
178 usb_paramp->ep0ptr, usb_paramp->ep1ptr, usb_paramp->ep2ptr,
186 * Poll for whatever events may have occured
191 volatile cbd_t *rx_cbdp = 0;
192 volatile cbd_t *rx_cbdp_base = 0;
194 if (udc_state != STATE_READY) {
198 if (usbp->usber & USB_E_BSY) {
199 /* This shouldn't happen. If it does then it's a bug ! */
200 usbp->usber |= USB_E_BSY;
201 mpc8xx_udc_flush_rx_fifo ();
204 /* Scan all RX/Bidirectional Endpoints for RX data. */
205 for (epid = 0; epid < MAX_ENDPOINTS; epid++) {
206 if (!ep_ref[epid].prx) {
209 rx_cbdp = rx_cbdp_base = ep_ref[epid].prx;
212 if (!(rx_cbdp->cbd_sc & RX_BD_E)) {
214 if (rx_cbdp->cbd_sc & 0x1F) {
215 /* Corrupt data discard it.
216 * Controller has NAK'd this packet.
218 mpc8xx_udc_clear_rxbd (rx_cbdp);
222 mpc8xx_udc_ep0_rx (rx_cbdp);
226 mpc8xx_udc_set_nak (epid);
227 mpc8xx_udc_epn_rx (epid, rx_cbdp);
228 mpc8xx_udc_clear_rxbd (rx_cbdp);
232 /* Advance RX CBD pointer */
233 mpc8xx_udc_advance_rx (&rx_cbdp, epid);
234 ep_ref[epid].prx = rx_cbdp;
236 /* Advance RX CBD pointer */
237 mpc8xx_udc_advance_rx (&rx_cbdp, epid);
240 } while (rx_cbdp != rx_cbdp_base);
243 /* Handle TX events as appropiate, the correct place to do this is
244 * in a tx routine. Perhaps TX on epn was pre-empted by ep0
247 if (usbp->usber & USB_E_TXB) {
248 usbp->usber |= USB_E_TXB;
251 if (usbp->usber & (USB_TX_ERRMASK)) {
252 mpc8xx_udc_handle_txerr ();
255 /* Switch to the default state, respond at the default address */
256 if (usbp->usber & USB_E_RESET) {
257 usbp->usber |= USB_E_RESET;
259 udc_device->device_state = STATE_DEFAULT;
262 /* if(usbp->usber&USB_E_IDLE){
263 We could suspend here !
264 usbp->usber|=USB_E_IDLE;
265 DBG("idle state change\n");
268 We could resume here when IDLE is deasserted !
269 Not worth doing, so long as we are self powered though.
276 /* udc_endpoint_write
278 * Write some data to an endpoint
280 int udc_endpoint_write (struct usb_endpoint_instance *epi)
283 short epid = 1, unnak = 0, ret = 0;
285 if (udc_state != STATE_READY) {
286 ERR ("invalid udc_state != STATE_READY!\n");
290 if (!udc_device || !epi) {
294 if (udc_device->device_state != STATE_CONFIGURED) {
298 ep = epi->endpoint_address & 0x03;
299 if (ep >= MAX_ENDPOINTS) {
303 /* Set NAK for all RX endpoints during TX */
304 for (epid = 1; epid < MAX_ENDPOINTS; epid++) {
306 /* Don't set NAK on DATA IN/CONTROL endpoints */
307 if (ep_ref[epid].sc & USB_DIR_IN) {
311 if (!(usbp->usep[epid] & (USEP_THS_NAK | USEP_RHS_NAK))) {
315 mpc8xx_udc_set_nak (epid);
318 mpc8xx_udc_init_tx (&udc_device->bus->endpoint_array[ep],
320 ret = mpc8xx_udc_ep_tx (&udc_device->bus->endpoint_array[ep]);
322 /* Remove temporary NAK */
323 for (epid = 1; epid < MAX_ENDPOINTS; epid++) {
324 if (unnak & (1 << epid)) {
325 udc_unset_nak (epid);
332 /* mpc8xx_udc_assign_urb
334 * Associate a given urb to an endpoint TX or RX transmit/receive buffers
336 static int mpc8xx_udc_assign_urb (int ep, char direction)
338 struct usb_endpoint_instance *epi = 0;
340 if (ep >= MAX_ENDPOINTS) {
343 epi = &udc_device->bus->endpoint_array[ep];
348 if (!ep_ref[ep].urb) {
349 ep_ref[ep].urb = usbd_alloc_urb (udc_device, udc_device->bus->endpoint_array);
350 if (!ep_ref[ep].urb) {
354 ep_ref[ep].urb->actual_length = 0;
359 epi->tx_urb = ep_ref[ep].urb;
362 epi->rcv_urb = ep_ref[ep].urb;
370 udc_state = STATE_ERROR;
376 * Associate U-Boot software endpoints to mpc8xx endpoint parameter ram
377 * Isochronous endpoints aren't yet supported!
379 void udc_setup_ep (struct usb_device_instance *device, unsigned int ep,
380 struct usb_endpoint_instance *epi)
385 if (epi && (ep < MAX_ENDPOINTS)) {
388 if (epi->rcv_attributes != USB_ENDPOINT_XFER_CONTROL
389 || epi->tx_attributes !=
390 USB_ENDPOINT_XFER_CONTROL) {
392 /* ep0 must be a control endpoint */
393 udc_state = STATE_ERROR;
397 if (!(ep_ref[ep].sc & EP_ATTACHED)) {
398 mpc8xx_udc_cbd_attach (ep, epi->tx_packetSize,
399 epi->rcv_packetSize);
401 usbp->usep[ep] = 0x0000;
405 if ((epi->endpoint_address & USB_ENDPOINT_DIR_MASK)
409 ep_attrib = epi->tx_attributes;
410 epi->rcv_packetSize = 0;
411 ep_ref[ep].sc |= USB_DIR_IN;
415 ep_attrib = epi->rcv_attributes;
416 epi->tx_packetSize = 0;
417 ep_ref[ep].sc &= ~USB_DIR_IN;
420 if (mpc8xx_udc_assign_urb (ep, epi->endpoint_address
421 & USB_ENDPOINT_DIR_MASK)) {
426 case USB_ENDPOINT_XFER_CONTROL:
427 if (!(ep_ref[ep].sc & EP_ATTACHED)) {
428 mpc8xx_udc_cbd_attach (ep,
430 epi->rcv_packetSize);
432 usbp->usep[ep] = ep << 12;
433 epi->rcv_urb = epi->tx_urb = ep_ref[ep].urb;
436 case USB_ENDPOINT_XFER_BULK:
437 case USB_ENDPOINT_XFER_INT:
438 if (!(ep_ref[ep].sc & EP_ATTACHED)) {
440 mpc8xx_udc_cbd_attach (ep,
444 mpc8xx_udc_cbd_attach (ep,
446 epi->rcv_packetSize);
449 usbp->usep[ep] = (ep << 12) | ((ep_attrib) << 8);
452 case USB_ENDPOINT_XFER_ISOC:
454 serial_printf ("Error endpoint attrib %d>3\n", ep_attrib);
455 udc_state = STATE_ERROR;
464 * Move state, switch on the USB
466 void udc_connect (void)
468 /* Enable pull-up resistor on D+
469 * TODO: fit a pull-up resistor to drive SE0 for > 2.5us
472 if (udc_state != STATE_ERROR) {
473 udc_state = STATE_READY;
474 usbp->usmod |= USMOD_EN;
480 * Disconnect is not used but, is included for completeness
482 void udc_disconnect (void)
484 /* Disable pull-up resistor on D-
485 * TODO: fix a pullup resistor to control this
488 if (udc_state != STATE_ERROR) {
489 udc_state = STATE_NOT_READY;
491 usbp->usmod &= ~USMOD_EN;
496 * Grab an EP0 URB, register interest in a subset of USB events
498 void udc_enable (struct usb_device_instance *device)
500 if (udc_state == STATE_ERROR) {
506 if (!ep_ref[0].urb) {
507 ep_ref[0].urb = usbd_alloc_urb (device, device->bus->endpoint_array);
510 /* Register interest in all events except SOF, enable transceiver */
511 usbp->usber = 0x03FF;
512 usbp->usbmr = 0x02F7;
519 * disable the currently hooked device
521 void udc_disable (void)
525 if (udc_state == STATE_ERROR) {
526 DBG ("Won't disable UDC. udc_state==STATE_ERROR !\n");
532 for (; i < MAX_ENDPOINTS; i++) {
534 usbd_dealloc_urb (ep_ref[i].urb);
540 usbp->usmod = ~USMOD_EN;
541 udc_state = STATE_NOT_READY;
544 /* udc_startup_events
546 * Enable the specified device
548 void udc_startup_events (struct usb_device_instance *device)
551 if (udc_state == STATE_READY) {
552 usbd_device_event_irq (device, DEVICE_CREATE, 0);
558 * Allow upper layers to signal lower layers should not accept more RX data
561 void udc_set_nak (int epid)
564 mpc8xx_udc_set_nak (epid);
570 * Suspend sending of NAK tokens for DATA OUT tokens on a given endpoint.
571 * Switch off NAKing on this endpoint to accept more data output from host.
574 void udc_unset_nak (int epid)
576 if (epid > MAX_ENDPOINTS) {
580 if (usbp->usep[epid] & (USEP_THS_NAK | USEP_RHS_NAK)) {
581 usbp->usep[epid] &= ~(USEP_THS_NAK | USEP_RHS_NAK);
586 /******************************************************************************
588 ******************************************************************************/
590 /* udc_state_transition_up
591 * udc_state_transition_down
593 * Helper functions to implement device state changes. The device states and
594 * the events that transition between them are:
599 * DEVICE_HUB_CONFIGURED DEVICE_HUB_RESET
605 * DEVICE_RESET DEVICE_POWER_INTERRUPTION
611 * DEVICE_ADDRESS_ASSIGNED DEVICE_RESET
617 * DEVICE_CONFIGURED DEVICE_DE_CONFIGURED
622 * udc_state_transition_up transitions up (in the direction from STATE_ATTACHED
623 * to STATE_CONFIGURED) from the specified initial state to the specified final
624 * state, passing through each intermediate state on the way. If the initial
625 * state is at or above (i.e. nearer to STATE_CONFIGURED) the final state, then
626 * no state transitions will take place.
628 * udc_state_transition_down transitions down (in the direction from
629 * STATE_CONFIGURED to STATE_ATTACHED) from the specified initial state to the
630 * specified final state, passing through each intermediate state on the way.
631 * If the initial state is at or below (i.e. nearer to STATE_ATTACHED) the final
632 * state, then no state transitions will take place.
636 static void mpc8xx_udc_state_transition_up (usb_device_state_t initial,
637 usb_device_state_t final)
639 if (initial < final) {
642 usbd_device_event_irq (udc_device,
643 DEVICE_HUB_CONFIGURED, 0);
644 if (final == STATE_POWERED)
647 usbd_device_event_irq (udc_device, DEVICE_RESET, 0);
648 if (final == STATE_DEFAULT)
651 usbd_device_event_irq (udc_device,
652 DEVICE_ADDRESS_ASSIGNED, 0);
653 if (final == STATE_ADDRESSED)
655 case STATE_ADDRESSED:
656 usbd_device_event_irq (udc_device, DEVICE_CONFIGURED,
658 case STATE_CONFIGURED:
666 static void mpc8xx_udc_state_transition_down (usb_device_state_t initial,
667 usb_device_state_t final)
669 if (initial > final) {
671 case STATE_CONFIGURED:
672 usbd_device_event_irq (udc_device,
673 DEVICE_DE_CONFIGURED, 0);
674 if (final == STATE_ADDRESSED)
676 case STATE_ADDRESSED:
677 usbd_device_event_irq (udc_device, DEVICE_RESET, 0);
678 if (final == STATE_DEFAULT)
681 usbd_device_event_irq (udc_device,
682 DEVICE_POWER_INTERRUPTION, 0);
683 if (final == STATE_POWERED)
686 usbd_device_event_irq (udc_device, DEVICE_HUB_RESET,
698 * Force returning of STALL tokens on the given endpoint. Protocol or function
699 * STALL conditions are permissable here
701 static void mpc8xx_udc_stall (unsigned int ep)
703 usbp->usep[ep] |= STALL_BITMASK;
706 /* mpc8xx_udc_set_nak
708 * Force returning of NAK responses for the given endpoint as a kind of very
709 * simple flow control
711 static void mpc8xx_udc_set_nak (unsigned int ep)
713 usbp->usep[ep] |= NAK_BITMASK;
717 /* mpc8xx_udc_handle_txerr
719 * Handle errors relevant to TX. Return a status code to allow calling
720 * indicative of what if anything happened
722 static short mpc8xx_udc_handle_txerr ()
724 short ep = 0, ret = 0;
726 for (; ep < TX_RING_SIZE; ep++) {
727 if (usbp->usber & (0x10 << ep)) {
729 /* Timeout or underrun */
730 if (tx_cbd[ep]->cbd_sc & 0x06) {
732 mpc8xx_udc_flush_tx_fifo (ep);
735 if (usbp->usep[ep] & STALL_BITMASK) {
737 usbp->usep[ep] &= ~STALL_BITMASK;
741 usbp->usber |= (0x10 << ep);
747 /* mpc8xx_udc_advance_rx
751 static void mpc8xx_udc_advance_rx (volatile cbd_t ** rx_cbdp, int epid)
753 if ((*rx_cbdp)->cbd_sc & RX_BD_W) {
754 *rx_cbdp = (volatile cbd_t *) (endpoints[epid]->rbase + CONFIG_SYS_IMMR);
762 /* mpc8xx_udc_flush_tx_fifo
764 * Flush a given TX fifo. Assumes one tx cbd per endpoint
766 static void mpc8xx_udc_flush_tx_fifo (int epid)
768 volatile cbd_t *tx_cbdp = 0;
770 if (epid > MAX_ENDPOINTS) {
775 immr->im_cpm.cp_cpcr = ((epid << 2) | 0x1D01);
777 while (immr->im_cpm.cp_cpcr & 0x01);
779 usbp->uscom = 0x40 | 0;
782 tx_cbdp = (cbd_t *) (endpoints[epid]->tbptr + CONFIG_SYS_IMMR);
783 tx_cbdp->cbd_sc = (TX_BD_I | TX_BD_W);
786 endpoints[epid]->tptr = endpoints[epid]->tbase;
787 endpoints[epid]->tstate = 0x00;
788 endpoints[epid]->tbcnt = 0x00;
791 immr->im_cpm.cp_cpcr = ((epid << 2) | 0x2D01);
793 while (immr->im_cpm.cp_cpcr & 0x01);
798 /* mpc8xx_udc_flush_rx_fifo
800 * For the sake of completeness of the namespace, it seems like
801 * a good-design-decision (tm) to include mpc8xx_udc_flush_rx_fifo();
802 * If RX_BD_E is true => a driver bug either here or in an upper layer
803 * not polling frequently enough. If RX_BD_E is true we have told the host
804 * we have accepted data but, the CPM found it had no-where to put that data
805 * which needless to say would be a bad thing.
807 static void mpc8xx_udc_flush_rx_fifo ()
811 for (i = 0; i < RX_RING_SIZE; i++) {
812 if (!(rx_cbd[i]->cbd_sc & RX_BD_E)) {
813 ERR ("buf %p used rx data len = 0x%x sc=0x%x!\n",
814 rx_cbd[i], rx_cbd[i]->cbd_datlen,
819 ERR ("BUG : Input over-run\n");
822 /* mpc8xx_udc_clear_rxbd
824 * Release control of RX CBD to CP.
826 static void mpc8xx_udc_clear_rxbd (volatile cbd_t * rx_cbdp)
828 rx_cbdp->cbd_datlen = 0x0000;
829 rx_cbdp->cbd_sc = ((rx_cbdp->cbd_sc & RX_BD_W) | (RX_BD_E | RX_BD_I));
835 * Parse for tx timeout, control RX or USB reset/busy conditions
836 * Return -1 on timeout, -2 on fatal error, else return zero
838 static int mpc8xx_udc_tx_irq (int ep)
842 if (usbp->usber & (USB_TX_ERRMASK)) {
843 if (mpc8xx_udc_handle_txerr ()) {
844 /* Timeout, controlling function must retry send */
849 if (usbp->usber & (USB_E_RESET | USB_E_BSY)) {
850 /* Fatal, abandon TX transaction */
854 if (usbp->usber & USB_E_RXB) {
855 for (i = 0; i < RX_RING_SIZE; i++) {
856 if (!(rx_cbd[i]->cbd_sc & RX_BD_E)) {
857 if ((rx_cbd[i] == ep_ref[0].prx) || ep) {
869 * Transmit in a re-entrant fashion outbound USB packets.
870 * Implement retry/timeout mechanism described in USB specification
871 * Toggle DATA0/DATA1 pids as necessary
872 * Introduces non-standard tx_retry. The USB standard has no scope for slave
873 * devices to give up TX, however tx_retry stops us getting stuck in an endless
876 static int mpc8xx_udc_ep_tx (struct usb_endpoint_instance *epi)
878 struct urb *urb = epi->tx_urb;
879 volatile cbd_t *tx_cbdp = 0;
880 unsigned int ep = 0, pkt_len = 0, x = 0, tx_retry = 0;
883 if (!epi || (epi->endpoint_address & 0x03) >= MAX_ENDPOINTS || !urb) {
887 ep = epi->endpoint_address & 0x03;
888 tx_cbdp = (cbd_t *) (endpoints[ep]->tbptr + CONFIG_SYS_IMMR);
890 if (tx_cbdp->cbd_sc & TX_BD_R || usbp->usber & USB_E_TXB) {
891 mpc8xx_udc_flush_tx_fifo (ep);
892 usbp->usber |= USB_E_TXB;
895 while (tx_retry++ < 100) {
896 ret = mpc8xx_udc_tx_irq (ep);
898 /* ignore timeout here */
899 } else if (ret == -2) {
901 mpc8xx_udc_flush_tx_fifo (ep);
905 tx_cbdp = (cbd_t *) (endpoints[ep]->tbptr + CONFIG_SYS_IMMR);
906 while (tx_cbdp->cbd_sc & TX_BD_R) {
908 tx_cbdp->cbd_sc = (tx_cbdp->cbd_sc & TX_BD_W);
910 pkt_len = urb->actual_length - epi->sent;
912 if (pkt_len > epi->tx_packetSize || pkt_len > EP_MAX_PKT) {
913 pkt_len = MIN (epi->tx_packetSize, EP_MAX_PKT);
916 for (x = 0; x < pkt_len; x++) {
917 *((unsigned char *) (tx_cbdp->cbd_bufaddr + x)) =
918 urb->buffer[epi->sent + x];
920 tx_cbdp->cbd_datlen = pkt_len;
921 tx_cbdp->cbd_sc |= (CBD_TX_BITMASK | ep_ref[ep].pid);
924 #ifdef __SIMULATE_ERROR__
925 if (++err_poison_test == 2) {
927 tx_cbdp->cbd_sc &= ~TX_BD_TC;
931 usbp->uscom = (USCOM_STR | ep);
933 while (!(usbp->usber & USB_E_TXB)) {
934 ret = mpc8xx_udc_tx_irq (ep);
938 } else if (ret == -2) {
939 if (usbp->usber & USB_E_TXB) {
940 usbp->usber |= USB_E_TXB;
942 mpc8xx_udc_flush_tx_fifo (ep);
947 if (usbp->usber & USB_E_TXB) {
948 usbp->usber |= USB_E_TXB;
951 /* ACK must be present <= 18bit times from TX */
956 /* TX ACK : USB 2.0 8.7.2, Toggle PID, Advance TX */
957 epi->sent += pkt_len;
958 epi->last = MIN (urb->actual_length - epi->sent, epi->tx_packetSize);
959 TOGGLE_TX_PID (ep_ref[ep].pid);
961 if (epi->sent >= epi->tx_urb->actual_length) {
963 epi->tx_urb->actual_length = 0;
966 if (ep_ref[ep].sc & EP_SEND_ZLP) {
967 ep_ref[ep].sc &= ~EP_SEND_ZLP;
974 ERR ("TX fail, endpoint 0x%x tx bytes 0x%x/0x%x\n", ep, epi->sent,
975 epi->tx_urb->actual_length);
980 /* mpc8xx_udc_dump_request
982 * Dump a control request to console
984 static void mpc8xx_udc_dump_request (struct usb_device_request *request)
986 DBG ("bmRequestType:%02x bRequest:%02x wValue:%04x "
987 "wIndex:%04x wLength:%04x ?\n",
988 request->bmRequestType,
990 request->wValue, request->wIndex, request->wLength);
995 /* mpc8xx_udc_ep0_rx_setup
997 * Decode received ep0 SETUP packet. return non-zero on error
999 static int mpc8xx_udc_ep0_rx_setup (volatile cbd_t * rx_cbdp)
1002 struct urb *purb = ep_ref[0].urb;
1003 struct usb_endpoint_instance *epi =
1004 &udc_device->bus->endpoint_array[0];
1006 for (; x < rx_cbdp->cbd_datlen; x++) {
1007 *(((unsigned char *) &ep_ref[0].urb->device_request) + x) =
1008 *((unsigned char *) (rx_cbdp->cbd_bufaddr + x));
1011 mpc8xx_udc_clear_rxbd (rx_cbdp);
1013 if (ep0_recv_setup (purb)) {
1014 mpc8xx_udc_dump_request (&purb->device_request);
1018 if ((purb->device_request.bmRequestType & USB_REQ_DIRECTION_MASK)
1019 == USB_REQ_HOST2DEVICE) {
1021 switch (purb->device_request.bRequest) {
1022 case USB_REQ_SET_ADDRESS:
1023 /* Send the Status OUT ZLP */
1024 ep_ref[0].pid = TX_BD_PID_DATA1;
1025 purb->actual_length = 0;
1026 mpc8xx_udc_init_tx (epi, purb);
1027 mpc8xx_udc_ep_tx (epi);
1029 /* Move to the addressed state */
1030 usbp->usaddr = udc_device->address;
1031 mpc8xx_udc_state_transition_up (udc_device->device_state,
1035 case USB_REQ_SET_CONFIGURATION:
1036 if (!purb->device_request.wValue) {
1037 /* Respond at default address */
1038 usbp->usaddr = 0x00;
1039 mpc8xx_udc_state_transition_down (udc_device->device_state,
1042 /* TODO: Support multiple configurations */
1043 mpc8xx_udc_state_transition_up (udc_device->device_state,
1045 for (x = 1; x < MAX_ENDPOINTS; x++) {
1046 if ((udc_device->bus->endpoint_array[x].endpoint_address & USB_ENDPOINT_DIR_MASK)
1048 ep_ref[x].pid = TX_BD_PID_DATA0;
1050 ep_ref[x].pid = RX_BD_PID_DATA0;
1052 /* Set configuration must unstall endpoints */
1053 usbp->usep[x] &= ~STALL_BITMASK;
1058 /* CDC/Vendor specific */
1062 /* Send ZLP as ACK in Status OUT phase */
1063 ep_ref[0].pid = TX_BD_PID_DATA1;
1064 purb->actual_length = 0;
1065 mpc8xx_udc_init_tx (epi, purb);
1066 mpc8xx_udc_ep_tx (epi);
1070 if (purb->actual_length) {
1071 ep_ref[0].pid = TX_BD_PID_DATA1;
1072 mpc8xx_udc_init_tx (epi, purb);
1074 if (!(purb->actual_length % EP0_MAX_PACKET_SIZE)) {
1075 ep_ref[0].sc |= EP_SEND_ZLP;
1078 if (purb->device_request.wValue ==
1079 USB_DESCRIPTOR_TYPE_DEVICE) {
1080 if (le16_to_cpu (purb->device_request.wLength)
1081 > purb->actual_length) {
1082 /* Send EP0_MAX_PACKET_SIZE bytes
1083 * unless correct size requested.
1085 if (purb->actual_length > epi->tx_packetSize) {
1086 purb->actual_length = epi->tx_packetSize;
1090 mpc8xx_udc_ep_tx (epi);
1093 /* Corrupt SETUP packet? */
1094 ERR ("Zero length data or SETUP with DATA-IN phase ?\n");
1101 /* mpc8xx_udc_init_tx
1103 * Setup some basic parameters for a TX transaction
1105 static void mpc8xx_udc_init_tx (struct usb_endpoint_instance *epi,
1110 epi->tx_urb = tx_urb;
1113 /* mpc8xx_udc_ep0_rx
1115 * Receive ep0/control USB data. Parse and possibly send a response.
1117 static void mpc8xx_udc_ep0_rx (volatile cbd_t * rx_cbdp)
1119 if (rx_cbdp->cbd_sc & RX_BD_PID_SETUP) {
1121 /* Unconditionally accept SETUP packets */
1122 if (mpc8xx_udc_ep0_rx_setup (rx_cbdp)) {
1123 mpc8xx_udc_stall (0);
1128 mpc8xx_udc_clear_rxbd (rx_cbdp);
1130 if ((rx_cbdp->cbd_datlen - 2)) {
1131 /* SETUP with a DATA phase
1132 * outside of SETUP packet.
1135 mpc8xx_udc_stall (0);
1140 /* mpc8xx_udc_epn_rx
1142 * Receive some data from cbd into USB system urb data abstraction
1143 * Upper layers should NAK if there is insufficient RX data space
1145 static int mpc8xx_udc_epn_rx (unsigned int epid, volatile cbd_t * rx_cbdp)
1147 struct usb_endpoint_instance *epi = 0;
1148 struct urb *urb = 0;
1151 if (epid >= MAX_ENDPOINTS || !rx_cbdp->cbd_datlen) {
1155 /* USB 2.0 PDF section 8.6.4
1156 * Discard data with invalid PID it is a resend.
1158 if (ep_ref[epid].pid != (rx_cbdp->cbd_sc & 0xC0)) {
1161 TOGGLE_RX_PID (ep_ref[epid].pid);
1163 epi = &udc_device->bus->endpoint_array[epid];
1166 for (; x < (rx_cbdp->cbd_datlen - 2); x++) {
1167 *((unsigned char *) (urb->buffer + urb->actual_length + x)) =
1168 *((unsigned char *) (rx_cbdp->cbd_bufaddr + x));
1172 usbd_rcv_complete (epi, x, 0);
1173 if (ep_ref[epid].urb->status == RECV_ERROR) {
1174 DBG ("RX error unset NAK\n");
1175 udc_unset_nak (epid);
1181 /* mpc8xx_udc_clock_init
1183 * Obtain a clock reference for Full Speed Signaling
1185 static void mpc8xx_udc_clock_init (volatile immap_t * immr,
1186 volatile cpm8xx_t * cp)
1189 #if defined(CONFIG_SYS_USB_EXTC_CLK)
1191 /* This has been tested with a 48MHz crystal on CLK6 */
1192 switch (CONFIG_SYS_USB_EXTC_CLK) {
1194 immr->im_ioport.iop_papar |= 0x0100;
1195 immr->im_ioport.iop_padir &= ~0x0100;
1196 cp->cp_sicr |= 0x24;
1199 immr->im_ioport.iop_papar |= 0x0200;
1200 immr->im_ioport.iop_padir &= ~0x0200;
1201 cp->cp_sicr |= 0x2D;
1204 immr->im_ioport.iop_papar |= 0x0400;
1205 immr->im_ioport.iop_padir &= ~0x0400;
1206 cp->cp_sicr |= 0x36;
1209 immr->im_ioport.iop_papar |= 0x0800;
1210 immr->im_ioport.iop_padir &= ~0x0800;
1211 cp->cp_sicr |= 0x3F;
1214 udc_state = STATE_ERROR;
1218 #elif defined(CONFIG_SYS_USB_BRGCLK)
1220 /* This has been tested with brgclk == 50MHz */
1223 if (gd->cpu_clk < 48000000L) {
1224 ERR ("brgclk is too slow for full-speed USB!\n");
1225 udc_state = STATE_ERROR;
1229 /* Assume the brgclk is 'good enough', we want !(gd->cpu_clk%48MHz)
1230 * but, can /probably/ live with close-ish alternative rates.
1232 divisor = (gd->cpu_clk / 48000000L) - 1;
1233 cp->cp_sicr &= ~0x0000003F;
1235 switch (CONFIG_SYS_USB_BRGCLK) {
1237 cp->cp_brgc1 |= (divisor | CPM_BRG_EN);
1238 cp->cp_sicr &= ~0x2F;
1241 cp->cp_brgc2 |= (divisor | CPM_BRG_EN);
1242 cp->cp_sicr |= 0x00000009;
1245 cp->cp_brgc3 |= (divisor | CPM_BRG_EN);
1246 cp->cp_sicr |= 0x00000012;
1249 cp->cp_brgc4 = (divisor | CPM_BRG_EN);
1250 cp->cp_sicr |= 0x0000001B;
1253 udc_state = STATE_ERROR;
1258 #error "CONFIG_SYS_USB_EXTC_CLK or CONFIG_SYS_USB_BRGCLK must be defined"
1263 /* mpc8xx_udc_cbd_attach
1265 * attach a cbd to and endpoint
1267 static void mpc8xx_udc_cbd_attach (int ep, uchar tx_size, uchar rx_size)
1270 if (!tx_cbd[ep] || !rx_cbd[ep] || ep >= MAX_ENDPOINTS) {
1271 udc_state = STATE_ERROR;
1275 if (tx_size > USB_MAX_PKT || rx_size > USB_MAX_PKT ||
1276 (!tx_size && !rx_size)) {
1277 udc_state = STATE_ERROR;
1281 /* Attach CBD to appropiate Parameter RAM Endpoint data structure */
1283 endpoints[ep]->rbase = (u32) rx_cbd[rx_ct];
1284 endpoints[ep]->rbptr = (u32) rx_cbd[rx_ct];
1289 endpoints[ep]->rbptr = (u32) rx_cbd[rx_ct];
1290 rx_cbd[rx_ct]->cbd_sc |= RX_BD_W;
1295 endpoints[ep]->rbptr = (u32) rx_cbd[rx_ct];
1296 rx_cbd[rx_ct]->cbd_sc |= RX_BD_W;
1300 /* Where we expect to RX data on this endpoint */
1301 ep_ref[ep].prx = rx_cbd[rx_ct - 1];
1305 endpoints[ep]->rbase = 0;
1306 endpoints[ep]->rbptr = 0;
1310 endpoints[ep]->tbase = (u32) tx_cbd[tx_ct];
1311 endpoints[ep]->tbptr = (u32) tx_cbd[tx_ct];
1314 endpoints[ep]->tbase = 0;
1315 endpoints[ep]->tbptr = 0;
1318 endpoints[ep]->tstate = 0;
1319 endpoints[ep]->tbcnt = 0;
1320 endpoints[ep]->mrblr = EP_MAX_PKT;
1321 endpoints[ep]->rfcr = 0x18;
1322 endpoints[ep]->tfcr = 0x18;
1323 ep_ref[ep].sc |= EP_ATTACHED;
1325 DBG ("ep %d rbase 0x%08x rbptr 0x%08x tbase 0x%08x tbptr 0x%08x prx = %p\n",
1326 ep, endpoints[ep]->rbase, endpoints[ep]->rbptr,
1327 endpoints[ep]->tbase, endpoints[ep]->tbptr,
1333 /* mpc8xx_udc_cbd_init
1335 * Allocate space for a cbd and allocate TX/RX data space
1337 static void mpc8xx_udc_cbd_init (void)
1341 for (; i < TX_RING_SIZE; i++) {
1342 tx_cbd[i] = (cbd_t *)
1343 mpc8xx_udc_alloc (sizeof (cbd_t), sizeof (int));
1346 for (i = 0; i < RX_RING_SIZE; i++) {
1347 rx_cbd[i] = (cbd_t *)
1348 mpc8xx_udc_alloc (sizeof (cbd_t), sizeof (int));
1351 for (i = 0; i < TX_RING_SIZE; i++) {
1352 tx_cbd[i]->cbd_bufaddr =
1353 mpc8xx_udc_alloc (EP_MAX_PKT, sizeof (int));
1355 tx_cbd[i]->cbd_sc = (TX_BD_I | TX_BD_W);
1356 tx_cbd[i]->cbd_datlen = 0x0000;
1360 for (i = 0; i < RX_RING_SIZE; i++) {
1361 rx_cbd[i]->cbd_bufaddr =
1362 mpc8xx_udc_alloc (EP_MAX_PKT, sizeof (int));
1363 rx_cbd[i]->cbd_sc = (RX_BD_I | RX_BD_E);
1364 rx_cbd[i]->cbd_datlen = 0x0000;
1371 /* mpc8xx_udc_endpoint_init
1373 * Attach an endpoint to some dpram
1375 static void mpc8xx_udc_endpoint_init (void)
1379 for (; i < MAX_ENDPOINTS; i++) {
1380 endpoints[i] = (usb_epb_t *)
1381 mpc8xx_udc_alloc (sizeof (usb_epb_t), 32);
1387 * Grab the address of some dpram
1389 static u32 mpc8xx_udc_alloc (u32 data_size, u32 alignment)
1391 u32 retaddr = address_base;
1393 while (retaddr % alignment) {
1396 address_base += data_size;