2 * driver/usb/gadget/fsl_qe_udc.c
4 * Copyright (c) 2006-2008 Freescale Semiconductor, Inc. All rights reserved.
6 * Xie Xiaobo <X.Xie@freescale.com>
7 * Li Yang <leoli@freescale.com>
8 * Based on bareboard code from Shlomi Gridish.
11 * Freescle QE/CPM USB Pheripheral Controller Driver
12 * The controller can be found on MPC8360, MPC8272, and etc.
13 * MPC8360 Rev 1.1 may need QE mircocode update
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2 of the License, or (at your
18 * option) any later version.
23 #include <linux/module.h>
24 #include <linux/kernel.h>
25 #include <linux/init.h>
26 #include <linux/ioport.h>
27 #include <linux/types.h>
28 #include <linux/errno.h>
29 #include <linux/err.h>
30 #include <linux/slab.h>
31 #include <linux/list.h>
32 #include <linux/interrupt.h>
34 #include <linux/moduleparam.h>
35 #include <linux/of_address.h>
36 #include <linux/of_irq.h>
37 #include <linux/of_platform.h>
38 #include <linux/dma-mapping.h>
39 #include <linux/usb/ch9.h>
40 #include <linux/usb/gadget.h>
41 #include <linux/usb/otg.h>
46 #include "fsl_qe_udc.h"
48 #define DRIVER_DESC "Freescale QE/CPM USB Device Controller driver"
49 #define DRIVER_AUTHOR "Xie XiaoBo"
50 #define DRIVER_VERSION "1.0"
52 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
54 static const char driver_name[] = "fsl_qe_udc";
55 static const char driver_desc[] = DRIVER_DESC;
57 /*ep name is important in gadget, it should obey the convention of ep_match()*/
58 static const char *const ep_name[] = {
59 "ep0-control", /* everyone has ep0 */
60 /* 3 configurable endpoints */
66 static struct usb_endpoint_descriptor qe_ep0_desc = {
67 .bLength = USB_DT_ENDPOINT_SIZE,
68 .bDescriptorType = USB_DT_ENDPOINT,
70 .bEndpointAddress = 0,
71 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
72 .wMaxPacketSize = USB_MAX_CTRL_PAYLOAD,
75 /********************************************************************
76 * Internal Used Function Start
77 ********************************************************************/
78 /*-----------------------------------------------------------------
79 * done() - retire a request; caller blocked irqs
80 *--------------------------------------------------------------*/
81 static void done(struct qe_ep *ep, struct qe_req *req, int status)
83 struct qe_udc *udc = ep->udc;
84 unsigned char stopped = ep->stopped;
86 /* the req->queue pointer is used by ep_queue() func, in which
87 * the request will be added into a udc_ep->queue 'd tail
88 * so here the req will be dropped from the ep->queue
90 list_del_init(&req->queue);
92 /* req.status should be set as -EINPROGRESS in ep_queue() */
93 if (req->req.status == -EINPROGRESS)
94 req->req.status = status;
96 status = req->req.status;
99 dma_unmap_single(udc->gadget.dev.parent,
100 req->req.dma, req->req.length,
104 req->req.dma = DMA_ADDR_INVALID;
107 dma_sync_single_for_cpu(udc->gadget.dev.parent,
108 req->req.dma, req->req.length,
113 if (status && (status != -ESHUTDOWN))
114 dev_vdbg(udc->dev, "complete %s req %p stat %d len %u/%u\n",
115 ep->ep.name, &req->req, status,
116 req->req.actual, req->req.length);
118 /* don't modify queue heads during completion callback */
120 spin_unlock(&udc->lock);
122 /* this complete() should a func implemented by gadget layer,
123 * eg fsg->bulk_in_complete() */
124 if (req->req.complete)
125 req->req.complete(&ep->ep, &req->req);
127 spin_lock(&udc->lock);
129 ep->stopped = stopped;
132 /*-----------------------------------------------------------------
133 * nuke(): delete all requests related to this ep
134 *--------------------------------------------------------------*/
135 static void nuke(struct qe_ep *ep, int status)
137 /* Whether this eq has request linked */
138 while (!list_empty(&ep->queue)) {
139 struct qe_req *req = NULL;
140 req = list_entry(ep->queue.next, struct qe_req, queue);
142 done(ep, req, status);
146 /*---------------------------------------------------------------------------*
147 * USB and Endpoint manipulate process, include parameter and register *
148 *---------------------------------------------------------------------------*/
149 /* @value: 1--set stall 0--clean stall */
150 static int qe_eprx_stall_change(struct qe_ep *ep, int value)
153 u8 epnum = ep->epnum;
154 struct qe_udc *udc = ep->udc;
156 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
157 tem_usep = tem_usep & ~USB_RHS_MASK;
159 tem_usep |= USB_RHS_STALL;
160 else if (ep->dir == USB_DIR_IN)
161 tem_usep |= USB_RHS_IGNORE_OUT;
163 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
167 static int qe_eptx_stall_change(struct qe_ep *ep, int value)
170 u8 epnum = ep->epnum;
171 struct qe_udc *udc = ep->udc;
173 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
174 tem_usep = tem_usep & ~USB_THS_MASK;
176 tem_usep |= USB_THS_STALL;
177 else if (ep->dir == USB_DIR_OUT)
178 tem_usep |= USB_THS_IGNORE_IN;
180 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
185 static int qe_ep0_stall(struct qe_udc *udc)
187 qe_eptx_stall_change(&udc->eps[0], 1);
188 qe_eprx_stall_change(&udc->eps[0], 1);
189 udc->ep0_state = WAIT_FOR_SETUP;
194 static int qe_eprx_nack(struct qe_ep *ep)
196 u8 epnum = ep->epnum;
197 struct qe_udc *udc = ep->udc;
199 if (ep->state == EP_STATE_IDLE) {
200 /* Set the ep's nack */
201 clrsetbits_be16(&udc->usb_regs->usb_usep[epnum],
202 USB_RHS_MASK, USB_RHS_NACK);
204 /* Mask Rx and Busy interrupts */
205 clrbits16(&udc->usb_regs->usb_usbmr,
206 (USB_E_RXB_MASK | USB_E_BSY_MASK));
208 ep->state = EP_STATE_NACK;
213 static int qe_eprx_normal(struct qe_ep *ep)
215 struct qe_udc *udc = ep->udc;
217 if (ep->state == EP_STATE_NACK) {
218 clrsetbits_be16(&udc->usb_regs->usb_usep[ep->epnum],
219 USB_RTHS_MASK, USB_THS_IGNORE_IN);
221 /* Unmask RX interrupts */
222 out_be16(&udc->usb_regs->usb_usber,
223 USB_E_BSY_MASK | USB_E_RXB_MASK);
224 setbits16(&udc->usb_regs->usb_usbmr,
225 (USB_E_RXB_MASK | USB_E_BSY_MASK));
227 ep->state = EP_STATE_IDLE;
234 static int qe_ep_cmd_stoptx(struct qe_ep *ep)
236 if (ep->udc->soc_type == PORT_CPM)
237 cpm_command(CPM_USB_STOP_TX | (ep->epnum << CPM_USB_EP_SHIFT),
238 CPM_USB_STOP_TX_OPCODE);
240 qe_issue_cmd(QE_USB_STOP_TX, QE_CR_SUBBLOCK_USB,
246 static int qe_ep_cmd_restarttx(struct qe_ep *ep)
248 if (ep->udc->soc_type == PORT_CPM)
249 cpm_command(CPM_USB_RESTART_TX | (ep->epnum <<
250 CPM_USB_EP_SHIFT), CPM_USB_RESTART_TX_OPCODE);
252 qe_issue_cmd(QE_USB_RESTART_TX, QE_CR_SUBBLOCK_USB,
258 static int qe_ep_flushtxfifo(struct qe_ep *ep)
260 struct qe_udc *udc = ep->udc;
265 qe_ep_cmd_stoptx(ep);
266 out_8(&udc->usb_regs->usb_uscom,
267 USB_CMD_FLUSH_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
268 out_be16(&udc->ep_param[i]->tbptr, in_be16(&udc->ep_param[i]->tbase));
269 out_be32(&udc->ep_param[i]->tstate, 0);
270 out_be16(&udc->ep_param[i]->tbcnt, 0);
272 ep->c_txbd = ep->txbase;
273 ep->n_txbd = ep->txbase;
274 qe_ep_cmd_restarttx(ep);
278 static int qe_ep_filltxfifo(struct qe_ep *ep)
280 struct qe_udc *udc = ep->udc;
282 out_8(&udc->usb_regs->usb_uscom,
283 USB_CMD_STR_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
287 static int qe_epbds_reset(struct qe_udc *udc, int pipe_num)
291 struct qe_bd __iomem *bd;
294 ep = &udc->eps[pipe_num];
296 if (ep->dir == USB_DIR_OUT)
297 bdring_len = USB_BDRING_LEN_RX;
299 bdring_len = USB_BDRING_LEN;
302 for (i = 0; i < (bdring_len - 1); i++) {
303 out_be32((u32 __iomem *)bd, R_E | R_I);
306 out_be32((u32 __iomem *)bd, R_E | R_I | R_W);
309 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
310 out_be32(&bd->buf, 0);
311 out_be32((u32 __iomem *)bd, 0);
314 out_be32((u32 __iomem *)bd, T_W);
319 static int qe_ep_reset(struct qe_udc *udc, int pipe_num)
324 ep = &udc->eps[pipe_num];
325 tmpusep = in_be16(&udc->usb_regs->usb_usep[pipe_num]);
326 tmpusep &= ~USB_RTHS_MASK;
330 qe_ep_flushtxfifo(ep);
333 tmpusep |= USB_THS_IGNORE_IN;
336 qe_ep_flushtxfifo(ep);
337 tmpusep |= USB_RHS_IGNORE_OUT;
342 out_be16(&udc->usb_regs->usb_usep[pipe_num], tmpusep);
344 qe_epbds_reset(udc, pipe_num);
349 static int qe_ep_toggledata01(struct qe_ep *ep)
355 static int qe_ep_bd_init(struct qe_udc *udc, unsigned char pipe_num)
357 struct qe_ep *ep = &udc->eps[pipe_num];
358 unsigned long tmp_addr = 0;
359 struct usb_ep_para __iomem *epparam;
361 struct qe_bd __iomem *bd;
364 if (ep->dir == USB_DIR_OUT)
365 bdring_len = USB_BDRING_LEN_RX;
367 bdring_len = USB_BDRING_LEN;
369 epparam = udc->ep_param[pipe_num];
370 /* alloc multi-ram for BD rings and set the ep parameters */
371 tmp_addr = cpm_muram_alloc(sizeof(struct qe_bd) * (bdring_len +
372 USB_BDRING_LEN_TX), QE_ALIGNMENT_OF_BD);
373 if (IS_ERR_VALUE(tmp_addr))
376 out_be16(&epparam->rbase, (u16)tmp_addr);
377 out_be16(&epparam->tbase, (u16)(tmp_addr +
378 (sizeof(struct qe_bd) * bdring_len)));
380 out_be16(&epparam->rbptr, in_be16(&epparam->rbase));
381 out_be16(&epparam->tbptr, in_be16(&epparam->tbase));
383 ep->rxbase = cpm_muram_addr(tmp_addr);
384 ep->txbase = cpm_muram_addr(tmp_addr + (sizeof(struct qe_bd)
386 ep->n_rxbd = ep->rxbase;
387 ep->e_rxbd = ep->rxbase;
388 ep->n_txbd = ep->txbase;
389 ep->c_txbd = ep->txbase;
390 ep->data01 = 0; /* data0 */
392 /* Init TX and RX bds */
394 for (i = 0; i < bdring_len - 1; i++) {
395 out_be32(&bd->buf, 0);
396 out_be32((u32 __iomem *)bd, 0);
399 out_be32(&bd->buf, 0);
400 out_be32((u32 __iomem *)bd, R_W);
403 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
404 out_be32(&bd->buf, 0);
405 out_be32((u32 __iomem *)bd, 0);
408 out_be32(&bd->buf, 0);
409 out_be32((u32 __iomem *)bd, T_W);
414 static int qe_ep_rxbd_update(struct qe_ep *ep)
419 struct qe_bd __iomem *bd;
420 unsigned int bdring_len;
422 if (ep->rxbase == NULL)
427 ep->rxframe = kmalloc(sizeof(*ep->rxframe), GFP_ATOMIC);
428 if (ep->rxframe == NULL) {
429 dev_err(ep->udc->dev, "malloc rxframe failed\n");
433 qe_frame_init(ep->rxframe);
435 if (ep->dir == USB_DIR_OUT)
436 bdring_len = USB_BDRING_LEN_RX;
438 bdring_len = USB_BDRING_LEN;
440 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (bdring_len + 1);
441 ep->rxbuffer = kzalloc(size, GFP_ATOMIC);
442 if (ep->rxbuffer == NULL) {
443 dev_err(ep->udc->dev, "malloc rxbuffer failed,size=%d\n",
449 ep->rxbuf_d = virt_to_phys((void *)ep->rxbuffer);
450 if (ep->rxbuf_d == DMA_ADDR_INVALID) {
451 ep->rxbuf_d = dma_map_single(ep->udc->gadget.dev.parent,
457 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
463 size = ep->ep.maxpacket + USB_CRC_SIZE + 2;
465 tmp = (u32)(((tmp >> 2) << 2) + 4);
467 for (i = 0; i < bdring_len - 1; i++) {
468 out_be32(&bd->buf, tmp);
469 out_be32((u32 __iomem *)bd, (R_E | R_I));
473 out_be32(&bd->buf, tmp);
474 out_be32((u32 __iomem *)bd, (R_E | R_I | R_W));
479 static int qe_ep_register_init(struct qe_udc *udc, unsigned char pipe_num)
481 struct qe_ep *ep = &udc->eps[pipe_num];
482 struct usb_ep_para __iomem *epparam;
487 epparam = udc->ep_param[pipe_num];
490 logepnum = (ep->ep.desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
491 usep |= (logepnum << USB_EPNUM_SHIFT);
493 switch (ep->ep.desc->bmAttributes & 0x03) {
494 case USB_ENDPOINT_XFER_BULK:
495 usep |= USB_TRANS_BULK;
497 case USB_ENDPOINT_XFER_ISOC:
498 usep |= USB_TRANS_ISO;
500 case USB_ENDPOINT_XFER_INT:
501 usep |= USB_TRANS_INT;
504 usep |= USB_TRANS_CTR;
510 usep |= USB_THS_IGNORE_IN;
513 usep |= USB_RHS_IGNORE_OUT;
518 out_be16(&udc->usb_regs->usb_usep[pipe_num], usep);
521 out_8(&epparam->rbmr, rtfcr);
522 out_8(&epparam->tbmr, rtfcr);
524 tmp = (u16)(ep->ep.maxpacket + USB_CRC_SIZE);
525 /* MRBLR must be divisble by 4 */
526 tmp = (u16)(((tmp >> 2) << 2) + 4);
527 out_be16(&epparam->mrblr, tmp);
532 static int qe_ep_init(struct qe_udc *udc,
533 unsigned char pipe_num,
534 const struct usb_endpoint_descriptor *desc)
536 struct qe_ep *ep = &udc->eps[pipe_num];
541 max = usb_endpoint_maxp(desc);
543 /* check the max package size validate for this endpoint */
544 /* Refer to USB2.0 spec table 9-13,
547 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
548 case USB_ENDPOINT_XFER_BULK:
549 if (strstr(ep->ep.name, "-iso")
550 || strstr(ep->ep.name, "-int"))
552 switch (udc->gadget.speed) {
554 if ((max == 128) || (max == 256) || (max == 512))
570 case USB_ENDPOINT_XFER_INT:
571 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
573 switch (udc->gadget.speed) {
586 case USB_ENDPOINT_XFER_ISOC:
587 if (strstr(ep->ep.name, "-bulk")
588 || strstr(ep->ep.name, "-int"))
590 switch (udc->gadget.speed) {
601 case USB_ENDPOINT_XFER_CONTROL:
602 if (strstr(ep->ep.name, "-iso")
603 || strstr(ep->ep.name, "-int"))
605 switch (udc->gadget.speed) {
640 spin_lock_irqsave(&udc->lock, flags);
642 /* initialize ep structure */
643 ep->ep.maxpacket = max;
644 ep->tm = (u8)(desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
650 ep->dir = USB_DIR_BOTH;
651 udc->ep0_dir = USB_DIR_OUT;
652 udc->ep0_state = WAIT_FOR_SETUP;
654 switch (desc->bEndpointAddress & USB_ENDPOINT_DIR_MASK) {
656 ep->dir = USB_DIR_OUT;
659 ep->dir = USB_DIR_IN;
665 /* hardware special operation */
666 qe_ep_bd_init(udc, pipe_num);
667 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_OUT)) {
668 reval = qe_ep_rxbd_update(ep);
673 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_IN)) {
674 ep->txframe = kmalloc(sizeof(*ep->txframe), GFP_ATOMIC);
675 if (ep->txframe == NULL) {
676 dev_err(udc->dev, "malloc txframe failed\n");
679 qe_frame_init(ep->txframe);
682 qe_ep_register_init(udc, pipe_num);
684 /* Now HW will be NAKing transfers to that EP,
685 * until a buffer is queued to it. */
686 spin_unlock_irqrestore(&udc->lock, flags);
693 spin_unlock_irqrestore(&udc->lock, flags);
695 dev_err(udc->dev, "failed to initialize %s\n", ep->ep.name);
699 static inline void qe_usb_enable(struct qe_udc *udc)
701 setbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
704 static inline void qe_usb_disable(struct qe_udc *udc)
706 clrbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
709 /*----------------------------------------------------------------------------*
710 * USB and EP basic manipulate function end *
711 *----------------------------------------------------------------------------*/
714 /******************************************************************************
715 UDC transmit and receive process
716 ******************************************************************************/
717 static void recycle_one_rxbd(struct qe_ep *ep)
721 bdstatus = in_be32((u32 __iomem *)ep->e_rxbd);
722 bdstatus = R_I | R_E | (bdstatus & R_W);
723 out_be32((u32 __iomem *)ep->e_rxbd, bdstatus);
726 ep->e_rxbd = ep->rxbase;
731 static void recycle_rxbds(struct qe_ep *ep, unsigned char stopatnext)
734 struct qe_bd __iomem *bd, *nextbd;
735 unsigned char stop = 0;
739 bdstatus = in_be32((u32 __iomem *)bd);
741 while (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK) && !stop) {
742 bdstatus = R_E | R_I | (bdstatus & R_W);
743 out_be32((u32 __iomem *)bd, bdstatus);
750 bdstatus = in_be32((u32 __iomem *)bd);
751 if (stopatnext && (bd == nextbd))
758 static void ep_recycle_rxbds(struct qe_ep *ep)
760 struct qe_bd __iomem *bd = ep->n_rxbd;
762 u8 epnum = ep->epnum;
763 struct qe_udc *udc = ep->udc;
765 bdstatus = in_be32((u32 __iomem *)bd);
766 if (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK)) {
768 ((in_be16(&udc->ep_param[epnum]->rbptr) -
769 in_be16(&udc->ep_param[epnum]->rbase))
771 bdstatus = in_be32((u32 __iomem *)bd);
779 recycle_rxbds(ep, 0);
780 ep->e_rxbd = ep->n_rxbd;
782 recycle_rxbds(ep, 1);
784 if (in_be16(&udc->usb_regs->usb_usber) & USB_E_BSY_MASK)
785 out_be16(&udc->usb_regs->usb_usber, USB_E_BSY_MASK);
787 if (ep->has_data <= 0 && (!list_empty(&ep->queue)))
793 static void setup_received_handle(struct qe_udc *udc,
794 struct usb_ctrlrequest *setup);
795 static int qe_ep_rxframe_handle(struct qe_ep *ep);
796 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req);
797 /* when BD PID is setup, handle the packet */
798 static int ep0_setup_handle(struct qe_udc *udc)
800 struct qe_ep *ep = &udc->eps[0];
801 struct qe_frame *pframe;
805 pframe = ep->rxframe;
806 if ((frame_get_info(pframe) & PID_SETUP)
807 && (udc->ep0_state == WAIT_FOR_SETUP)) {
808 fsize = frame_get_length(pframe);
809 if (unlikely(fsize != 8))
811 cp = (u8 *)&udc->local_setup_buff;
812 memcpy(cp, pframe->data, fsize);
815 /* handle the usb command base on the usb_ctrlrequest */
816 setup_received_handle(udc, &udc->local_setup_buff);
822 static int qe_ep0_rx(struct qe_udc *udc)
824 struct qe_ep *ep = &udc->eps[0];
825 struct qe_frame *pframe;
826 struct qe_bd __iomem *bd;
827 u32 bdstatus, length;
830 pframe = ep->rxframe;
832 if (ep->dir == USB_DIR_IN) {
833 dev_err(udc->dev, "ep0 not a control endpoint\n");
838 bdstatus = in_be32((u32 __iomem *)bd);
839 length = bdstatus & BD_LENGTH_MASK;
841 while (!(bdstatus & R_E) && length) {
842 if ((bdstatus & R_F) && (bdstatus & R_L)
843 && !(bdstatus & R_ERROR)) {
844 if (length == USB_CRC_SIZE) {
845 udc->ep0_state = WAIT_FOR_SETUP;
847 "receive a ZLP in status phase\n");
849 qe_frame_clean(pframe);
850 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
851 frame_set_data(pframe, (u8 *)vaddr);
852 frame_set_length(pframe,
853 (length - USB_CRC_SIZE));
854 frame_set_status(pframe, FRAME_OK);
855 switch (bdstatus & R_PID) {
857 frame_set_info(pframe, PID_SETUP);
860 frame_set_info(pframe, PID_DATA1);
863 frame_set_info(pframe, PID_DATA0);
867 if ((bdstatus & R_PID) == R_PID_SETUP)
868 ep0_setup_handle(udc);
870 qe_ep_rxframe_handle(ep);
873 dev_err(udc->dev, "The receive frame with error!\n");
876 /* note: don't clear the rxbd's buffer address */
877 recycle_one_rxbd(ep);
885 bdstatus = in_be32((u32 __iomem *)bd);
886 length = bdstatus & BD_LENGTH_MASK;
895 static int qe_ep_rxframe_handle(struct qe_ep *ep)
897 struct qe_frame *pframe;
903 pframe = ep->rxframe;
905 if (frame_get_info(pframe) & PID_DATA1)
908 if (framepid != ep->data01) {
909 dev_err(ep->udc->dev, "the data01 error!\n");
913 fsize = frame_get_length(pframe);
914 if (list_empty(&ep->queue)) {
915 dev_err(ep->udc->dev, "the %s have no requeue!\n", ep->name);
917 req = list_entry(ep->queue.next, struct qe_req, queue);
919 cp = (u8 *)(req->req.buf) + req->req.actual;
921 memcpy(cp, pframe->data, fsize);
922 req->req.actual += fsize;
923 if ((fsize < ep->ep.maxpacket) ||
924 (req->req.actual >= req->req.length)) {
926 ep0_req_complete(ep->udc, req);
929 if (list_empty(&ep->queue) && ep->epnum != 0)
935 qe_ep_toggledata01(ep);
940 static void ep_rx_tasklet(unsigned long data)
942 struct qe_udc *udc = (struct qe_udc *)data;
944 struct qe_frame *pframe;
945 struct qe_bd __iomem *bd;
947 u32 bdstatus, length;
950 spin_lock_irqsave(&udc->lock, flags);
952 for (i = 1; i < USB_MAX_ENDPOINTS; i++) {
955 if (ep->dir == USB_DIR_IN || ep->enable_tasklet == 0) {
957 "This is a transmit ep or disable tasklet!\n");
961 pframe = ep->rxframe;
963 bdstatus = in_be32((u32 __iomem *)bd);
964 length = bdstatus & BD_LENGTH_MASK;
966 while (!(bdstatus & R_E) && length) {
967 if (list_empty(&ep->queue)) {
970 "The rxep have noreq %d\n",
975 if ((bdstatus & R_F) && (bdstatus & R_L)
976 && !(bdstatus & R_ERROR)) {
977 qe_frame_clean(pframe);
978 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
979 frame_set_data(pframe, (u8 *)vaddr);
980 frame_set_length(pframe,
981 (length - USB_CRC_SIZE));
982 frame_set_status(pframe, FRAME_OK);
983 switch (bdstatus & R_PID) {
985 frame_set_info(pframe, PID_DATA1);
988 frame_set_info(pframe, PID_SETUP);
991 frame_set_info(pframe, PID_DATA0);
994 /* handle the rx frame */
995 qe_ep_rxframe_handle(ep);
998 "error in received frame\n");
1000 /* note: don't clear the rxbd's buffer address */
1001 /*clear the length */
1002 out_be32((u32 __iomem *)bd, bdstatus & BD_STATUS_MASK);
1004 if (!(ep->localnack))
1005 recycle_one_rxbd(ep);
1013 bdstatus = in_be32((u32 __iomem *)bd);
1014 length = bdstatus & BD_LENGTH_MASK;
1020 ep_recycle_rxbds(ep);
1022 ep->enable_tasklet = 0;
1025 spin_unlock_irqrestore(&udc->lock, flags);
1028 static int qe_ep_rx(struct qe_ep *ep)
1031 struct qe_frame *pframe;
1032 struct qe_bd __iomem *bd;
1033 u16 swoffs, ucoffs, emptybds;
1036 pframe = ep->rxframe;
1038 if (ep->dir == USB_DIR_IN) {
1039 dev_err(udc->dev, "transmit ep in rx function\n");
1045 swoffs = (u16)(bd - ep->rxbase);
1046 ucoffs = (u16)((in_be16(&udc->ep_param[ep->epnum]->rbptr) -
1047 in_be16(&udc->ep_param[ep->epnum]->rbase)) >> 3);
1048 if (swoffs < ucoffs)
1049 emptybds = USB_BDRING_LEN_RX - ucoffs + swoffs;
1051 emptybds = swoffs - ucoffs;
1053 if (emptybds < MIN_EMPTY_BDS) {
1056 dev_vdbg(udc->dev, "%d empty bds, send NACK\n", emptybds);
1058 ep->has_data = USB_BDRING_LEN_RX - emptybds;
1060 if (list_empty(&ep->queue)) {
1062 dev_vdbg(udc->dev, "The rxep have no req queued with %d BDs\n",
1067 tasklet_schedule(&udc->rx_tasklet);
1068 ep->enable_tasklet = 1;
1073 /* send data from a frame, no matter what tx_req */
1074 static int qe_ep_tx(struct qe_ep *ep, struct qe_frame *frame)
1076 struct qe_udc *udc = ep->udc;
1077 struct qe_bd __iomem *bd;
1079 u32 bdstatus, pidmask;
1082 if (ep->dir == USB_DIR_OUT) {
1083 dev_err(udc->dev, "receive ep passed to tx function\n");
1087 /* Disable the Tx interrupt */
1088 saveusbmr = in_be16(&udc->usb_regs->usb_usbmr);
1089 out_be16(&udc->usb_regs->usb_usbmr,
1090 saveusbmr & ~(USB_E_TXB_MASK | USB_E_TXE_MASK));
1093 bdstatus = in_be32((u32 __iomem *)bd);
1095 if (!(bdstatus & (T_R | BD_LENGTH_MASK))) {
1096 if (frame_get_length(frame) == 0) {
1097 frame_set_data(frame, udc->nullbuf);
1098 frame_set_length(frame, 2);
1099 frame->info |= (ZLP | NO_CRC);
1100 dev_vdbg(udc->dev, "the frame size = 0\n");
1102 paddr = virt_to_phys((void *)frame->data);
1103 out_be32(&bd->buf, paddr);
1104 bdstatus = (bdstatus&T_W);
1105 if (!(frame_get_info(frame) & NO_CRC))
1106 bdstatus |= T_R | T_I | T_L | T_TC
1107 | frame_get_length(frame);
1109 bdstatus |= T_R | T_I | T_L | frame_get_length(frame);
1111 /* if the packet is a ZLP in status phase */
1112 if ((ep->epnum == 0) && (udc->ep0_state == DATA_STATE_NEED_ZLP))
1116 pidmask = T_PID_DATA1;
1117 frame->info |= PID_DATA1;
1119 pidmask = T_PID_DATA0;
1120 frame->info |= PID_DATA0;
1123 bdstatus |= pidmask;
1124 out_be32((u32 __iomem *)bd, bdstatus);
1125 qe_ep_filltxfifo(ep);
1127 /* enable the TX interrupt */
1128 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1130 qe_ep_toggledata01(ep);
1132 ep->n_txbd = ep->txbase;
1138 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1139 dev_vdbg(udc->dev, "The tx bd is not ready!\n");
1144 /* when a bd was transmitted, the function can
1145 * handle the tx_req, not include ep0 */
1146 static int txcomplete(struct qe_ep *ep, unsigned char restart)
1148 if (ep->tx_req != NULL) {
1149 struct qe_req *req = ep->tx_req;
1150 unsigned zlp = 0, last_len = 0;
1152 last_len = min_t(unsigned, req->req.length - ep->sent,
1156 int asent = ep->last;
1163 /* zlp needed when req->re.zero is set */
1164 if (req->req.zero) {
1165 if (last_len == 0 ||
1166 (req->req.length % ep->ep.maxpacket) != 0)
1173 /* a request already were transmitted completely */
1174 if (((ep->tx_req->req.length - ep->sent) <= 0) && !zlp) {
1175 done(ep, ep->tx_req, 0);
1182 /* we should gain a new tx_req fot this endpoint */
1183 if (ep->tx_req == NULL) {
1184 if (!list_empty(&ep->queue)) {
1185 ep->tx_req = list_entry(ep->queue.next, struct qe_req,
1195 /* give a frame and a tx_req, send some data */
1196 static int qe_usb_senddata(struct qe_ep *ep, struct qe_frame *frame)
1201 qe_frame_clean(frame);
1202 size = min_t(u32, (ep->tx_req->req.length - ep->sent),
1204 buf = (u8 *)ep->tx_req->req.buf + ep->sent;
1207 ep->tx_req->req.actual += size;
1208 frame_set_data(frame, buf);
1209 frame_set_length(frame, size);
1210 frame_set_status(frame, FRAME_OK);
1211 frame_set_info(frame, 0);
1212 return qe_ep_tx(ep, frame);
1217 /* give a frame struct,send a ZLP */
1218 static int sendnulldata(struct qe_ep *ep, struct qe_frame *frame, uint infor)
1220 struct qe_udc *udc = ep->udc;
1225 qe_frame_clean(frame);
1226 frame_set_data(frame, (u8 *)udc->nullbuf);
1227 frame_set_length(frame, 2);
1228 frame_set_status(frame, FRAME_OK);
1229 frame_set_info(frame, (ZLP | NO_CRC | infor));
1231 return qe_ep_tx(ep, frame);
1234 static int frame_create_tx(struct qe_ep *ep, struct qe_frame *frame)
1236 struct qe_req *req = ep->tx_req;
1242 if ((req->req.length - ep->sent) > 0)
1243 reval = qe_usb_senddata(ep, frame);
1245 reval = sendnulldata(ep, frame, 0);
1250 /* if direction is DIR_IN, the status is Device->Host
1251 * if direction is DIR_OUT, the status transaction is Device<-Host
1252 * in status phase, udc create a request and gain status */
1253 static int ep0_prime_status(struct qe_udc *udc, int direction)
1256 struct qe_ep *ep = &udc->eps[0];
1258 if (direction == USB_DIR_IN) {
1259 udc->ep0_state = DATA_STATE_NEED_ZLP;
1260 udc->ep0_dir = USB_DIR_IN;
1261 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1263 udc->ep0_dir = USB_DIR_OUT;
1264 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1270 /* a request complete in ep0, whether gadget request or udc request */
1271 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req)
1273 struct qe_ep *ep = &udc->eps[0];
1274 /* because usb and ep's status already been set in ch9setaddress() */
1276 switch (udc->ep0_state) {
1277 case DATA_STATE_XMIT:
1279 /* receive status phase */
1280 if (ep0_prime_status(udc, USB_DIR_OUT))
1284 case DATA_STATE_NEED_ZLP:
1286 udc->ep0_state = WAIT_FOR_SETUP;
1289 case DATA_STATE_RECV:
1291 /* send status phase */
1292 if (ep0_prime_status(udc, USB_DIR_IN))
1296 case WAIT_FOR_OUT_STATUS:
1298 udc->ep0_state = WAIT_FOR_SETUP;
1301 case WAIT_FOR_SETUP:
1302 dev_vdbg(udc->dev, "Unexpected interrupt\n");
1311 static int ep0_txcomplete(struct qe_ep *ep, unsigned char restart)
1313 struct qe_req *tx_req = NULL;
1314 struct qe_frame *frame = ep->txframe;
1316 if ((frame_get_info(frame) & (ZLP | NO_REQ)) == (ZLP | NO_REQ)) {
1318 ep->udc->ep0_state = WAIT_FOR_SETUP;
1320 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1324 tx_req = ep->tx_req;
1325 if (tx_req != NULL) {
1327 int asent = ep->last;
1334 /* a request already were transmitted completely */
1335 if ((ep->tx_req->req.length - ep->sent) <= 0) {
1336 ep->tx_req->req.actual = (unsigned int)ep->sent;
1337 ep0_req_complete(ep->udc, ep->tx_req);
1343 dev_vdbg(ep->udc->dev, "the ep0_controller have no req\n");
1349 static int ep0_txframe_handle(struct qe_ep *ep)
1351 /* if have error, transmit again */
1352 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1353 qe_ep_flushtxfifo(ep);
1354 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1355 if (frame_get_info(ep->txframe) & PID_DATA0)
1360 ep0_txcomplete(ep, 1);
1362 ep0_txcomplete(ep, 0);
1364 frame_create_tx(ep, ep->txframe);
1368 static int qe_ep0_txconf(struct qe_ep *ep)
1370 struct qe_bd __iomem *bd;
1371 struct qe_frame *pframe;
1375 bdstatus = in_be32((u32 __iomem *)bd);
1376 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1377 pframe = ep->txframe;
1379 /* clear and recycle the BD */
1380 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1381 out_be32(&bd->buf, 0);
1383 ep->c_txbd = ep->txbase;
1387 if (ep->c_txbd == ep->n_txbd) {
1388 if (bdstatus & DEVICE_T_ERROR) {
1389 frame_set_status(pframe, FRAME_ERROR);
1390 if (bdstatus & T_TO)
1391 pframe->status |= TX_ER_TIMEOUT;
1392 if (bdstatus & T_UN)
1393 pframe->status |= TX_ER_UNDERUN;
1395 ep0_txframe_handle(ep);
1399 bdstatus = in_be32((u32 __iomem *)bd);
1405 static int ep_txframe_handle(struct qe_ep *ep)
1407 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1408 qe_ep_flushtxfifo(ep);
1409 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1410 if (frame_get_info(ep->txframe) & PID_DATA0)
1419 frame_create_tx(ep, ep->txframe); /* send the data */
1423 /* confirm the already trainsmited bd */
1424 static int qe_ep_txconf(struct qe_ep *ep)
1426 struct qe_bd __iomem *bd;
1427 struct qe_frame *pframe = NULL;
1429 unsigned char breakonrxinterrupt = 0;
1432 bdstatus = in_be32((u32 __iomem *)bd);
1433 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1434 pframe = ep->txframe;
1435 if (bdstatus & DEVICE_T_ERROR) {
1436 frame_set_status(pframe, FRAME_ERROR);
1437 if (bdstatus & T_TO)
1438 pframe->status |= TX_ER_TIMEOUT;
1439 if (bdstatus & T_UN)
1440 pframe->status |= TX_ER_UNDERUN;
1443 /* clear and recycle the BD */
1444 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1445 out_be32(&bd->buf, 0);
1447 ep->c_txbd = ep->txbase;
1451 /* handle the tx frame */
1452 ep_txframe_handle(ep);
1454 bdstatus = in_be32((u32 __iomem *)bd);
1456 if (breakonrxinterrupt)
1462 /* Add a request in queue, and try to transmit a packet */
1463 static int ep_req_send(struct qe_ep *ep, struct qe_req *req)
1467 if (ep->tx_req == NULL) {
1470 txcomplete(ep, 0); /* can gain a new tx_req */
1471 reval = frame_create_tx(ep, ep->txframe);
1476 /* Maybe this is a good ideal */
1477 static int ep_req_rx(struct qe_ep *ep, struct qe_req *req)
1479 struct qe_udc *udc = ep->udc;
1480 struct qe_frame *pframe = NULL;
1481 struct qe_bd __iomem *bd;
1482 u32 bdstatus, length;
1488 if (list_empty(&ep->queue)) {
1489 dev_vdbg(udc->dev, "the req already finish!\n");
1492 pframe = ep->rxframe;
1495 bdstatus = in_be32((u32 __iomem *)bd);
1496 length = bdstatus & BD_LENGTH_MASK;
1498 while (!(bdstatus & R_E) && length) {
1501 if ((bdstatus & R_F) && (bdstatus & R_L)
1502 && !(bdstatus & R_ERROR)) {
1503 qe_frame_clean(pframe);
1504 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
1505 frame_set_data(pframe, (u8 *)vaddr);
1506 frame_set_length(pframe, (length - USB_CRC_SIZE));
1507 frame_set_status(pframe, FRAME_OK);
1508 switch (bdstatus & R_PID) {
1510 frame_set_info(pframe, PID_DATA1); break;
1512 frame_set_info(pframe, PID_DATA0); break;
1514 /* handle the rx frame */
1516 if (frame_get_info(pframe) & PID_DATA1)
1521 if (framepid != ep->data01) {
1522 dev_vdbg(udc->dev, "the data01 error!\n");
1524 fsize = frame_get_length(pframe);
1526 cp = (u8 *)(req->req.buf) + req->req.actual;
1528 memcpy(cp, pframe->data, fsize);
1529 req->req.actual += fsize;
1530 if ((fsize < ep->ep.maxpacket)
1531 || (req->req.actual >=
1535 if (list_empty(&ep->queue))
1539 qe_ep_toggledata01(ep);
1542 dev_err(udc->dev, "The receive frame with error!\n");
1545 /* note: don't clear the rxbd's buffer address *
1546 * only Clear the length */
1547 out_be32((u32 __iomem *)bd, (bdstatus & BD_STATUS_MASK));
1556 bdstatus = in_be32((u32 __iomem *)bd);
1557 length = bdstatus & BD_LENGTH_MASK;
1561 ep_recycle_rxbds(ep);
1566 /* only add the request in queue */
1567 static int ep_req_receive(struct qe_ep *ep, struct qe_req *req)
1569 if (ep->state == EP_STATE_NACK) {
1570 if (ep->has_data <= 0) {
1571 /* Enable rx and unmask rx interrupt */
1574 /* Copy the exist BD data */
1582 /********************************************************************
1583 Internal Used Function End
1584 ********************************************************************/
1586 /*-----------------------------------------------------------------------
1587 Endpoint Management Functions For Gadget
1588 -----------------------------------------------------------------------*/
1589 static int qe_ep_enable(struct usb_ep *_ep,
1590 const struct usb_endpoint_descriptor *desc)
1595 unsigned char epnum;
1597 ep = container_of(_ep, struct qe_ep, ep);
1599 /* catch various bogus parameters */
1600 if (!_ep || !desc || _ep->name == ep_name[0] ||
1601 (desc->bDescriptorType != USB_DT_ENDPOINT))
1605 if (!udc->driver || (udc->gadget.speed == USB_SPEED_UNKNOWN))
1608 epnum = (u8)desc->bEndpointAddress & 0xF;
1610 retval = qe_ep_init(udc, epnum, desc);
1612 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1613 dev_dbg(udc->dev, "enable ep%d failed\n", ep->epnum);
1616 dev_dbg(udc->dev, "enable ep%d successful\n", ep->epnum);
1620 static int qe_ep_disable(struct usb_ep *_ep)
1624 unsigned long flags;
1627 ep = container_of(_ep, struct qe_ep, ep);
1630 if (!_ep || !ep->ep.desc) {
1631 dev_dbg(udc->dev, "%s not enabled\n", _ep ? ep->ep.name : NULL);
1635 spin_lock_irqsave(&udc->lock, flags);
1636 /* Nuke all pending requests (does flush) */
1637 nuke(ep, -ESHUTDOWN);
1641 qe_ep_reset(udc, ep->epnum);
1642 spin_unlock_irqrestore(&udc->lock, flags);
1644 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1646 if (ep->dir == USB_DIR_OUT)
1647 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1648 (USB_BDRING_LEN_RX + 1);
1650 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1651 (USB_BDRING_LEN + 1);
1653 if (ep->dir != USB_DIR_IN) {
1656 dma_unmap_single(udc->gadget.dev.parent,
1659 ep->rxbuf_d = DMA_ADDR_INVALID;
1661 dma_sync_single_for_cpu(
1662 udc->gadget.dev.parent,
1666 kfree(ep->rxbuffer);
1669 if (ep->dir != USB_DIR_OUT)
1672 dev_dbg(udc->dev, "disabled %s OK\n", _ep->name);
1676 static struct usb_request *qe_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1680 req = kzalloc(sizeof(*req), gfp_flags);
1684 req->req.dma = DMA_ADDR_INVALID;
1686 INIT_LIST_HEAD(&req->queue);
1691 static void qe_free_request(struct usb_ep *_ep, struct usb_request *_req)
1695 req = container_of(_req, struct qe_req, req);
1701 static int __qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req)
1703 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1704 struct qe_req *req = container_of(_req, struct qe_req, req);
1709 /* catch various bogus parameters */
1710 if (!_req || !req->req.complete || !req->req.buf
1711 || !list_empty(&req->queue)) {
1712 dev_dbg(udc->dev, "bad params\n");
1715 if (!_ep || (!ep->ep.desc && ep_index(ep))) {
1716 dev_dbg(udc->dev, "bad ep\n");
1720 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
1725 /* map virtual address to hardware */
1726 if (req->req.dma == DMA_ADDR_INVALID) {
1727 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1735 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
1736 req->req.dma, req->req.length,
1743 req->req.status = -EINPROGRESS;
1744 req->req.actual = 0;
1746 list_add_tail(&req->queue, &ep->queue);
1747 dev_vdbg(udc->dev, "gadget have request in %s! %d\n",
1748 ep->name, req->req.length);
1750 /* push the request to device */
1752 reval = ep_req_send(ep, req);
1755 if (ep_index(ep) == 0 && req->req.length > 0) {
1757 udc->ep0_state = DATA_STATE_XMIT;
1759 udc->ep0_state = DATA_STATE_RECV;
1762 if (ep->dir == USB_DIR_OUT)
1763 reval = ep_req_receive(ep, req);
1768 /* queues (submits) an I/O request to an endpoint */
1769 static int qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1772 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1773 struct qe_udc *udc = ep->udc;
1774 unsigned long flags;
1777 spin_lock_irqsave(&udc->lock, flags);
1778 ret = __qe_ep_queue(_ep, _req);
1779 spin_unlock_irqrestore(&udc->lock, flags);
1783 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
1784 static int qe_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1786 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1788 unsigned long flags;
1793 spin_lock_irqsave(&ep->udc->lock, flags);
1795 /* make sure it's actually queued on this endpoint */
1796 list_for_each_entry(req, &ep->queue, queue) {
1797 if (&req->req == _req)
1801 if (&req->req != _req) {
1802 spin_unlock_irqrestore(&ep->udc->lock, flags);
1806 done(ep, req, -ECONNRESET);
1808 spin_unlock_irqrestore(&ep->udc->lock, flags);
1812 /*-----------------------------------------------------------------
1813 * modify the endpoint halt feature
1814 * @ep: the non-isochronous endpoint being stalled
1815 * @value: 1--set halt 0--clear halt
1816 * Returns zero, or a negative error code.
1817 *----------------------------------------------------------------*/
1818 static int qe_ep_set_halt(struct usb_ep *_ep, int value)
1821 unsigned long flags;
1822 int status = -EOPNOTSUPP;
1825 ep = container_of(_ep, struct qe_ep, ep);
1826 if (!_ep || !ep->ep.desc) {
1832 /* Attempt to halt IN ep will fail if any transfer requests
1833 * are still queue */
1834 if (value && ep_is_in(ep) && !list_empty(&ep->queue)) {
1840 spin_lock_irqsave(&ep->udc->lock, flags);
1841 qe_eptx_stall_change(ep, value);
1842 qe_eprx_stall_change(ep, value);
1843 spin_unlock_irqrestore(&ep->udc->lock, flags);
1845 if (ep->epnum == 0) {
1846 udc->ep0_state = WAIT_FOR_SETUP;
1850 /* set data toggle to DATA0 on clear halt */
1854 dev_vdbg(udc->dev, "%s %s halt stat %d\n", ep->ep.name,
1855 value ? "set" : "clear", status);
1860 static struct usb_ep_ops qe_ep_ops = {
1861 .enable = qe_ep_enable,
1862 .disable = qe_ep_disable,
1864 .alloc_request = qe_alloc_request,
1865 .free_request = qe_free_request,
1867 .queue = qe_ep_queue,
1868 .dequeue = qe_ep_dequeue,
1870 .set_halt = qe_ep_set_halt,
1873 /*------------------------------------------------------------------------
1874 Gadget Driver Layer Operations
1875 ------------------------------------------------------------------------*/
1877 /* Get the current frame number */
1878 static int qe_get_frame(struct usb_gadget *gadget)
1880 struct qe_udc *udc = container_of(gadget, struct qe_udc, gadget);
1883 tmp = in_be16(&udc->usb_param->frame_n);
1892 static int fsl_qe_start(struct usb_gadget *gadget,
1893 struct usb_gadget_driver *driver);
1894 static int fsl_qe_stop(struct usb_gadget *gadget,
1895 struct usb_gadget_driver *driver);
1897 /* defined in usb_gadget.h */
1898 static const struct usb_gadget_ops qe_gadget_ops = {
1899 .get_frame = qe_get_frame,
1900 .udc_start = fsl_qe_start,
1901 .udc_stop = fsl_qe_stop,
1904 /*-------------------------------------------------------------------------
1905 USB ep0 Setup process in BUS Enumeration
1906 -------------------------------------------------------------------------*/
1907 static int udc_reset_ep_queue(struct qe_udc *udc, u8 pipe)
1909 struct qe_ep *ep = &udc->eps[pipe];
1911 nuke(ep, -ECONNRESET);
1916 static int reset_queues(struct qe_udc *udc)
1920 for (pipe = 0; pipe < USB_MAX_ENDPOINTS; pipe++)
1921 udc_reset_ep_queue(udc, pipe);
1923 /* report disconnect; the driver is already quiesced */
1924 spin_unlock(&udc->lock);
1925 udc->driver->disconnect(&udc->gadget);
1926 spin_lock(&udc->lock);
1931 static void ch9setaddress(struct qe_udc *udc, u16 value, u16 index,
1934 /* Save the new address to device struct */
1935 udc->device_address = (u8) value;
1936 /* Update usb state */
1937 udc->usb_state = USB_STATE_ADDRESS;
1939 /* Status phase , send a ZLP */
1940 if (ep0_prime_status(udc, USB_DIR_IN))
1944 static void ownercomplete(struct usb_ep *_ep, struct usb_request *_req)
1946 struct qe_req *req = container_of(_req, struct qe_req, req);
1948 req->req.buf = NULL;
1952 static void ch9getstatus(struct qe_udc *udc, u8 request_type, u16 value,
1953 u16 index, u16 length)
1961 if ((request_type & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1962 /* Get device status */
1963 usb_status = 1 << USB_DEVICE_SELF_POWERED;
1964 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_INTERFACE) {
1965 /* Get interface status */
1966 /* We don't have interface information in udc driver */
1968 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_ENDPOINT) {
1969 /* Get endpoint status */
1970 int pipe = index & USB_ENDPOINT_NUMBER_MASK;
1971 struct qe_ep *target_ep = &udc->eps[pipe];
1974 /* stall if endpoint doesn't exist */
1975 if (!target_ep->ep.desc)
1978 usep = in_be16(&udc->usb_regs->usb_usep[pipe]);
1979 if (index & USB_DIR_IN) {
1980 if (target_ep->dir != USB_DIR_IN)
1982 if ((usep & USB_THS_MASK) == USB_THS_STALL)
1983 usb_status = 1 << USB_ENDPOINT_HALT;
1985 if (target_ep->dir != USB_DIR_OUT)
1987 if ((usep & USB_RHS_MASK) == USB_RHS_STALL)
1988 usb_status = 1 << USB_ENDPOINT_HALT;
1992 req = container_of(qe_alloc_request(&ep->ep, GFP_KERNEL),
1993 struct qe_req, req);
1994 req->req.length = 2;
1995 req->req.buf = udc->statusbuf;
1996 *(u16 *)req->req.buf = cpu_to_le16(usb_status);
1997 req->req.status = -EINPROGRESS;
1998 req->req.actual = 0;
1999 req->req.complete = ownercomplete;
2001 udc->ep0_dir = USB_DIR_IN;
2004 status = __qe_ep_queue(&ep->ep, &req->req);
2009 dev_err(udc->dev, "Can't respond to getstatus request \n");
2013 /* only handle the setup request, suppose the device in normal status */
2014 static void setup_received_handle(struct qe_udc *udc,
2015 struct usb_ctrlrequest *setup)
2017 /* Fix Endian (udc->local_setup_buff is cpu Endian now)*/
2018 u16 wValue = le16_to_cpu(setup->wValue);
2019 u16 wIndex = le16_to_cpu(setup->wIndex);
2020 u16 wLength = le16_to_cpu(setup->wLength);
2022 /* clear the previous request in the ep0 */
2023 udc_reset_ep_queue(udc, 0);
2025 if (setup->bRequestType & USB_DIR_IN)
2026 udc->ep0_dir = USB_DIR_IN;
2028 udc->ep0_dir = USB_DIR_OUT;
2030 switch (setup->bRequest) {
2031 case USB_REQ_GET_STATUS:
2032 /* Data+Status phase form udc */
2033 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
2034 != (USB_DIR_IN | USB_TYPE_STANDARD))
2036 ch9getstatus(udc, setup->bRequestType, wValue, wIndex,
2040 case USB_REQ_SET_ADDRESS:
2041 /* Status phase from udc */
2042 if (setup->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
2045 ch9setaddress(udc, wValue, wIndex, wLength);
2048 case USB_REQ_CLEAR_FEATURE:
2049 case USB_REQ_SET_FEATURE:
2050 /* Requests with no data phase, status phase from udc */
2051 if ((setup->bRequestType & USB_TYPE_MASK)
2052 != USB_TYPE_STANDARD)
2055 if ((setup->bRequestType & USB_RECIP_MASK)
2056 == USB_RECIP_ENDPOINT) {
2057 int pipe = wIndex & USB_ENDPOINT_NUMBER_MASK;
2060 if (wValue != 0 || wLength != 0
2061 || pipe > USB_MAX_ENDPOINTS)
2063 ep = &udc->eps[pipe];
2065 spin_unlock(&udc->lock);
2066 qe_ep_set_halt(&ep->ep,
2067 (setup->bRequest == USB_REQ_SET_FEATURE)
2069 spin_lock(&udc->lock);
2072 ep0_prime_status(udc, USB_DIR_IN);
2081 /* Data phase from gadget, status phase from udc */
2082 if (setup->bRequestType & USB_DIR_IN) {
2083 udc->ep0_state = DATA_STATE_XMIT;
2084 udc->ep0_dir = USB_DIR_IN;
2086 udc->ep0_state = DATA_STATE_RECV;
2087 udc->ep0_dir = USB_DIR_OUT;
2089 spin_unlock(&udc->lock);
2090 if (udc->driver->setup(&udc->gadget,
2091 &udc->local_setup_buff) < 0)
2093 spin_lock(&udc->lock);
2095 /* No data phase, IN status from gadget */
2096 udc->ep0_dir = USB_DIR_IN;
2097 spin_unlock(&udc->lock);
2098 if (udc->driver->setup(&udc->gadget,
2099 &udc->local_setup_buff) < 0)
2101 spin_lock(&udc->lock);
2102 udc->ep0_state = DATA_STATE_NEED_ZLP;
2106 /*-------------------------------------------------------------------------
2107 USB Interrupt handlers
2108 -------------------------------------------------------------------------*/
2109 static void suspend_irq(struct qe_udc *udc)
2111 udc->resume_state = udc->usb_state;
2112 udc->usb_state = USB_STATE_SUSPENDED;
2114 /* report suspend to the driver ,serial.c not support this*/
2115 if (udc->driver->suspend)
2116 udc->driver->suspend(&udc->gadget);
2119 static void resume_irq(struct qe_udc *udc)
2121 udc->usb_state = udc->resume_state;
2122 udc->resume_state = 0;
2124 /* report resume to the driver , serial.c not support this*/
2125 if (udc->driver->resume)
2126 udc->driver->resume(&udc->gadget);
2129 static void idle_irq(struct qe_udc *udc)
2133 usbs = in_8(&udc->usb_regs->usb_usbs);
2134 if (usbs & USB_IDLE_STATUS_MASK) {
2135 if ((udc->usb_state) != USB_STATE_SUSPENDED)
2138 if (udc->usb_state == USB_STATE_SUSPENDED)
2143 static int reset_irq(struct qe_udc *udc)
2147 if (udc->usb_state == USB_STATE_DEFAULT)
2150 qe_usb_disable(udc);
2151 out_8(&udc->usb_regs->usb_usadr, 0);
2153 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2154 if (udc->eps[i].init)
2155 qe_ep_reset(udc, i);
2159 udc->usb_state = USB_STATE_DEFAULT;
2160 udc->ep0_state = WAIT_FOR_SETUP;
2161 udc->ep0_dir = USB_DIR_OUT;
2166 static int bsy_irq(struct qe_udc *udc)
2171 static int txe_irq(struct qe_udc *udc)
2176 /* ep0 tx interrupt also in here */
2177 static int tx_irq(struct qe_udc *udc)
2180 struct qe_bd __iomem *bd;
2183 if ((udc->usb_state == USB_STATE_ADDRESS)
2184 && (in_8(&udc->usb_regs->usb_usadr) == 0))
2185 out_8(&udc->usb_regs->usb_usadr, udc->device_address);
2187 for (i = (USB_MAX_ENDPOINTS-1); ((i >= 0) && (res == 0)); i--) {
2189 if (ep && ep->init && (ep->dir != USB_DIR_OUT)) {
2191 if (!(in_be32((u32 __iomem *)bd) & T_R)
2192 && (in_be32(&bd->buf))) {
2193 /* confirm the transmitted bd */
2195 res = qe_ep0_txconf(ep);
2197 res = qe_ep_txconf(ep);
2205 /* setup packect's rx is handle in the function too */
2206 static void rx_irq(struct qe_udc *udc)
2209 struct qe_bd __iomem *bd;
2212 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2214 if (ep && ep->init && (ep->dir != USB_DIR_IN)) {
2216 if (!(in_be32((u32 __iomem *)bd) & R_E)
2217 && (in_be32(&bd->buf))) {
2218 if (ep->epnum == 0) {
2221 /*non-setup package receive*/
2229 static irqreturn_t qe_udc_irq(int irq, void *_udc)
2231 struct qe_udc *udc = (struct qe_udc *)_udc;
2233 irqreturn_t status = IRQ_NONE;
2234 unsigned long flags;
2236 spin_lock_irqsave(&udc->lock, flags);
2238 irq_src = in_be16(&udc->usb_regs->usb_usber) &
2239 in_be16(&udc->usb_regs->usb_usbmr);
2240 /* Clear notification bits */
2241 out_be16(&udc->usb_regs->usb_usber, irq_src);
2243 if (irq_src & USB_E_IDLE_MASK) {
2245 irq_src &= ~USB_E_IDLE_MASK;
2246 status = IRQ_HANDLED;
2249 if (irq_src & USB_E_TXB_MASK) {
2251 irq_src &= ~USB_E_TXB_MASK;
2252 status = IRQ_HANDLED;
2255 if (irq_src & USB_E_RXB_MASK) {
2257 irq_src &= ~USB_E_RXB_MASK;
2258 status = IRQ_HANDLED;
2261 if (irq_src & USB_E_RESET_MASK) {
2263 irq_src &= ~USB_E_RESET_MASK;
2264 status = IRQ_HANDLED;
2267 if (irq_src & USB_E_BSY_MASK) {
2269 irq_src &= ~USB_E_BSY_MASK;
2270 status = IRQ_HANDLED;
2273 if (irq_src & USB_E_TXE_MASK) {
2275 irq_src &= ~USB_E_TXE_MASK;
2276 status = IRQ_HANDLED;
2279 spin_unlock_irqrestore(&udc->lock, flags);
2284 /*-------------------------------------------------------------------------
2285 Gadget driver probe and unregister.
2286 --------------------------------------------------------------------------*/
2287 static int fsl_qe_start(struct usb_gadget *gadget,
2288 struct usb_gadget_driver *driver)
2291 unsigned long flags;
2293 udc = container_of(gadget, struct qe_udc, gadget);
2294 /* lock is needed but whether should use this lock or another */
2295 spin_lock_irqsave(&udc->lock, flags);
2297 driver->driver.bus = NULL;
2298 /* hook up the driver */
2299 udc->driver = driver;
2300 udc->gadget.speed = driver->max_speed;
2302 /* Enable IRQ reg and Set usbcmd reg EN bit */
2305 out_be16(&udc->usb_regs->usb_usber, 0xffff);
2306 out_be16(&udc->usb_regs->usb_usbmr, USB_E_DEFAULT_DEVICE);
2307 udc->usb_state = USB_STATE_ATTACHED;
2308 udc->ep0_state = WAIT_FOR_SETUP;
2309 udc->ep0_dir = USB_DIR_OUT;
2310 spin_unlock_irqrestore(&udc->lock, flags);
2312 dev_info(udc->dev, "%s bind to driver %s\n", udc->gadget.name,
2313 driver->driver.name);
2317 static int fsl_qe_stop(struct usb_gadget *gadget,
2318 struct usb_gadget_driver *driver)
2321 struct qe_ep *loop_ep;
2322 unsigned long flags;
2324 udc = container_of(gadget, struct qe_udc, gadget);
2325 /* stop usb controller, disable intr */
2326 qe_usb_disable(udc);
2328 /* in fact, no needed */
2329 udc->usb_state = USB_STATE_ATTACHED;
2330 udc->ep0_state = WAIT_FOR_SETUP;
2333 /* stand operation */
2334 spin_lock_irqsave(&udc->lock, flags);
2335 udc->gadget.speed = USB_SPEED_UNKNOWN;
2336 nuke(&udc->eps[0], -ESHUTDOWN);
2337 list_for_each_entry(loop_ep, &udc->gadget.ep_list, ep.ep_list)
2338 nuke(loop_ep, -ESHUTDOWN);
2339 spin_unlock_irqrestore(&udc->lock, flags);
2343 dev_info(udc->dev, "unregistered gadget driver '%s'\r\n",
2344 driver->driver.name);
2348 /* udc structure's alloc and setup, include ep-param alloc */
2349 static struct qe_udc *qe_udc_config(struct platform_device *ofdev)
2352 struct device_node *np = ofdev->dev.of_node;
2353 unsigned int tmp_addr = 0;
2354 struct usb_device_para __iomem *usbpram;
2359 udc = kzalloc(sizeof(*udc), GFP_KERNEL);
2361 dev_err(&ofdev->dev, "malloc udc failed\n");
2365 udc->dev = &ofdev->dev;
2367 /* get default address of usb parameter in MURAM from device tree */
2368 offset = *of_get_address(np, 1, &size, NULL);
2369 udc->usb_param = cpm_muram_addr(offset);
2370 memset_io(udc->usb_param, 0, size);
2372 usbpram = udc->usb_param;
2373 out_be16(&usbpram->frame_n, 0);
2374 out_be32(&usbpram->rstate, 0);
2376 tmp_addr = cpm_muram_alloc((USB_MAX_ENDPOINTS *
2377 sizeof(struct usb_ep_para)),
2378 USB_EP_PARA_ALIGNMENT);
2379 if (IS_ERR_VALUE(tmp_addr))
2382 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2383 out_be16(&usbpram->epptr[i], (u16)tmp_addr);
2384 udc->ep_param[i] = cpm_muram_addr(tmp_addr);
2388 memset_io(udc->ep_param[0], 0,
2389 USB_MAX_ENDPOINTS * sizeof(struct usb_ep_para));
2391 udc->resume_state = USB_STATE_NOTATTACHED;
2392 udc->usb_state = USB_STATE_POWERED;
2395 spin_lock_init(&udc->lock);
2403 /* USB Controller register init */
2404 static int qe_udc_reg_init(struct qe_udc *udc)
2406 struct usb_ctlr __iomem *qe_usbregs;
2407 qe_usbregs = udc->usb_regs;
2409 /* Spec says that we must enable the USB controller to change mode. */
2410 out_8(&qe_usbregs->usb_usmod, 0x01);
2411 /* Mode changed, now disable it, since muram isn't initialized yet. */
2412 out_8(&qe_usbregs->usb_usmod, 0x00);
2414 /* Initialize the rest. */
2415 out_be16(&qe_usbregs->usb_usbmr, 0);
2416 out_8(&qe_usbregs->usb_uscom, 0);
2417 out_be16(&qe_usbregs->usb_usber, USBER_ALL_CLEAR);
2422 static int qe_ep_config(struct qe_udc *udc, unsigned char pipe_num)
2424 struct qe_ep *ep = &udc->eps[pipe_num];
2427 strcpy(ep->name, ep_name[pipe_num]);
2428 ep->ep.name = ep_name[pipe_num];
2430 ep->ep.ops = &qe_ep_ops;
2432 ep->ep.maxpacket = (unsigned short) ~0;
2435 ep->epnum = (u8)pipe_num;
2442 ep->state = EP_STATE_IDLE;
2445 /* the queue lists any req for this ep */
2446 INIT_LIST_HEAD(&ep->queue);
2448 /* gagdet.ep_list used for ep_autoconfig so no ep0*/
2450 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
2452 ep->gadget = &udc->gadget;
2457 /*-----------------------------------------------------------------------
2458 * UDC device Driver operation functions *
2459 *----------------------------------------------------------------------*/
2460 static void qe_udc_release(struct device *dev)
2462 struct qe_udc *udc = container_of(dev, struct qe_udc, gadget.dev);
2465 complete(udc->done);
2466 cpm_muram_free(cpm_muram_offset(udc->ep_param[0]));
2467 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
2468 udc->ep_param[i] = NULL;
2473 /* Driver probe functions */
2474 static const struct of_device_id qe_udc_match[];
2475 static int qe_udc_probe(struct platform_device *ofdev)
2478 const struct of_device_id *match;
2479 struct device_node *np = ofdev->dev.of_node;
2481 unsigned int ret = 0;
2485 match = of_match_device(qe_udc_match, &ofdev->dev);
2489 prop = of_get_property(np, "mode", NULL);
2490 if (!prop || strcmp(prop, "peripheral"))
2493 /* Initialize the udc structure including QH member and other member */
2494 udc = qe_udc_config(ofdev);
2496 dev_err(&ofdev->dev, "failed to initialize\n");
2500 udc->soc_type = (unsigned long)match->data;
2501 udc->usb_regs = of_iomap(np, 0);
2502 if (!udc->usb_regs) {
2507 /* initialize usb hw reg except for regs for EP,
2508 * leave usbintr reg untouched*/
2509 qe_udc_reg_init(udc);
2511 /* here comes the stand operations for probe
2512 * set the qe_udc->gadget.xxx */
2513 udc->gadget.ops = &qe_gadget_ops;
2515 /* gadget.ep0 is a pointer */
2516 udc->gadget.ep0 = &udc->eps[0].ep;
2518 INIT_LIST_HEAD(&udc->gadget.ep_list);
2520 /* modify in register gadget process */
2521 udc->gadget.speed = USB_SPEED_UNKNOWN;
2523 /* name: Identifies the controller hardware type. */
2524 udc->gadget.name = driver_name;
2525 udc->gadget.dev.parent = &ofdev->dev;
2527 /* initialize qe_ep struct */
2528 for (i = 0; i < USB_MAX_ENDPOINTS ; i++) {
2529 /* because the ep type isn't decide here so
2530 * qe_ep_init() should be called in ep_enable() */
2532 /* setup the qe_ep struct and link ep.ep.list
2533 * into gadget.ep_list */
2534 qe_ep_config(udc, (unsigned char)i);
2537 /* ep0 initialization in here */
2538 ret = qe_ep_init(udc, 0, &qe_ep0_desc);
2542 /* create a buf for ZLP send, need to remain zeroed */
2543 udc->nullbuf = kzalloc(256, GFP_KERNEL);
2544 if (udc->nullbuf == NULL) {
2545 dev_err(udc->dev, "cannot alloc nullbuf\n");
2550 /* buffer for data of get_status request */
2551 udc->statusbuf = kzalloc(2, GFP_KERNEL);
2552 if (udc->statusbuf == NULL) {
2557 udc->nullp = virt_to_phys((void *)udc->nullbuf);
2558 if (udc->nullp == DMA_ADDR_INVALID) {
2559 udc->nullp = dma_map_single(
2560 udc->gadget.dev.parent,
2566 dma_sync_single_for_device(udc->gadget.dev.parent,
2571 tasklet_init(&udc->rx_tasklet, ep_rx_tasklet,
2572 (unsigned long)udc);
2573 /* request irq and disable DR */
2574 udc->usb_irq = irq_of_parse_and_map(np, 0);
2575 if (!udc->usb_irq) {
2580 ret = request_irq(udc->usb_irq, qe_udc_irq, 0,
2583 dev_err(udc->dev, "cannot request irq %d err %d\n",
2588 ret = usb_add_gadget_udc_release(&ofdev->dev, &udc->gadget,
2593 platform_set_drvdata(ofdev, udc);
2595 "%s USB controller initialized as device\n",
2596 (udc->soc_type == PORT_QE) ? "QE" : "CPM");
2600 free_irq(udc->usb_irq, udc);
2602 irq_dispose_mapping(udc->usb_irq);
2605 dma_unmap_single(udc->gadget.dev.parent,
2608 udc->nullp = DMA_ADDR_INVALID;
2610 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2614 kfree(udc->statusbuf);
2616 kfree(udc->nullbuf);
2619 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2621 kfree(ep->rxbuffer);
2624 iounmap(udc->usb_regs);
2631 static int qe_udc_suspend(struct platform_device *dev, pm_message_t state)
2636 static int qe_udc_resume(struct platform_device *dev)
2642 static int qe_udc_remove(struct platform_device *ofdev)
2644 struct qe_udc *udc = platform_get_drvdata(ofdev);
2647 DECLARE_COMPLETION(done);
2649 usb_del_gadget_udc(&udc->gadget);
2652 tasklet_disable(&udc->rx_tasklet);
2655 dma_unmap_single(udc->gadget.dev.parent,
2658 udc->nullp = DMA_ADDR_INVALID;
2660 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2664 kfree(udc->statusbuf);
2665 kfree(udc->nullbuf);
2668 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2669 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (USB_BDRING_LEN + 1);
2673 dma_unmap_single(udc->gadget.dev.parent,
2676 ep->rxbuf_d = DMA_ADDR_INVALID;
2678 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2683 kfree(ep->rxbuffer);
2686 free_irq(udc->usb_irq, udc);
2687 irq_dispose_mapping(udc->usb_irq);
2689 tasklet_kill(&udc->rx_tasklet);
2691 iounmap(udc->usb_regs);
2693 /* wait for release() of gadget.dev to free udc */
2694 wait_for_completion(&done);
2699 /*-------------------------------------------------------------------------*/
2700 static const struct of_device_id qe_udc_match[] = {
2702 .compatible = "fsl,mpc8323-qe-usb",
2703 .data = (void *)PORT_QE,
2706 .compatible = "fsl,mpc8360-qe-usb",
2707 .data = (void *)PORT_QE,
2710 .compatible = "fsl,mpc8272-cpm-usb",
2711 .data = (void *)PORT_CPM,
2716 MODULE_DEVICE_TABLE(of, qe_udc_match);
2718 static struct platform_driver udc_driver = {
2720 .name = (char *)driver_name,
2721 .owner = THIS_MODULE,
2722 .of_match_table = qe_udc_match,
2724 .probe = qe_udc_probe,
2725 .remove = qe_udc_remove,
2727 .suspend = qe_udc_suspend,
2728 .resume = qe_udc_resume,
2732 module_platform_driver(udc_driver);
2734 MODULE_DESCRIPTION(DRIVER_DESC);
2735 MODULE_AUTHOR(DRIVER_AUTHOR);
2736 MODULE_LICENSE("GPL");