1 // SPDX-License-Identifier: GPL-2.0+
3 * driver/usb/gadget/fsl_qe_udc.c
5 * Copyright (c) 2006-2008 Freescale Semiconductor, Inc. All rights reserved.
7 * Xie Xiaobo <X.Xie@freescale.com>
8 * Li Yang <leoli@freescale.com>
9 * Based on bareboard code from Shlomi Gridish.
12 * Freescle QE/CPM USB Pheripheral Controller Driver
13 * The controller can be found on MPC8360, MPC8272, and etc.
14 * MPC8360 Rev 1.1 may need QE mircocode update
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/ioport.h>
22 #include <linux/types.h>
23 #include <linux/errno.h>
24 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <linux/list.h>
27 #include <linux/interrupt.h>
29 #include <linux/moduleparam.h>
31 #include <linux/of_address.h>
32 #include <linux/of_irq.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/usb/ch9.h>
36 #include <linux/usb/gadget.h>
37 #include <linux/usb/otg.h>
38 #include <soc/fsl/qe/qe.h>
42 #include "fsl_qe_udc.h"
44 #define DRIVER_DESC "Freescale QE/CPM USB Device Controller driver"
45 #define DRIVER_AUTHOR "Xie XiaoBo"
46 #define DRIVER_VERSION "1.0"
48 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
50 static const char driver_name[] = "fsl_qe_udc";
51 static const char driver_desc[] = DRIVER_DESC;
53 /*ep name is important in gadget, it should obey the convention of ep_match()*/
54 static const char *const ep_name[] = {
55 "ep0-control", /* everyone has ep0 */
56 /* 3 configurable endpoints */
62 static const struct usb_endpoint_descriptor qe_ep0_desc = {
63 .bLength = USB_DT_ENDPOINT_SIZE,
64 .bDescriptorType = USB_DT_ENDPOINT,
66 .bEndpointAddress = 0,
67 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
68 .wMaxPacketSize = USB_MAX_CTRL_PAYLOAD,
71 /********************************************************************
72 * Internal Used Function Start
73 ********************************************************************/
74 /*-----------------------------------------------------------------
75 * done() - retire a request; caller blocked irqs
76 *--------------------------------------------------------------*/
77 static void done(struct qe_ep *ep, struct qe_req *req, int status)
79 struct qe_udc *udc = ep->udc;
80 unsigned char stopped = ep->stopped;
82 /* the req->queue pointer is used by ep_queue() func, in which
83 * the request will be added into a udc_ep->queue 'd tail
84 * so here the req will be dropped from the ep->queue
86 list_del_init(&req->queue);
88 /* req.status should be set as -EINPROGRESS in ep_queue() */
89 if (req->req.status == -EINPROGRESS)
90 req->req.status = status;
92 status = req->req.status;
95 dma_unmap_single(udc->gadget.dev.parent,
96 req->req.dma, req->req.length,
100 req->req.dma = DMA_ADDR_INVALID;
103 dma_sync_single_for_cpu(udc->gadget.dev.parent,
104 req->req.dma, req->req.length,
109 if (status && (status != -ESHUTDOWN))
110 dev_vdbg(udc->dev, "complete %s req %p stat %d len %u/%u\n",
111 ep->ep.name, &req->req, status,
112 req->req.actual, req->req.length);
114 /* don't modify queue heads during completion callback */
116 spin_unlock(&udc->lock);
118 usb_gadget_giveback_request(&ep->ep, &req->req);
120 spin_lock(&udc->lock);
122 ep->stopped = stopped;
125 /*-----------------------------------------------------------------
126 * nuke(): delete all requests related to this ep
127 *--------------------------------------------------------------*/
128 static void nuke(struct qe_ep *ep, int status)
130 /* Whether this eq has request linked */
131 while (!list_empty(&ep->queue)) {
132 struct qe_req *req = NULL;
133 req = list_entry(ep->queue.next, struct qe_req, queue);
135 done(ep, req, status);
139 /*---------------------------------------------------------------------------*
140 * USB and Endpoint manipulate process, include parameter and register *
141 *---------------------------------------------------------------------------*/
142 /* @value: 1--set stall 0--clean stall */
143 static int qe_eprx_stall_change(struct qe_ep *ep, int value)
146 u8 epnum = ep->epnum;
147 struct qe_udc *udc = ep->udc;
149 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
150 tem_usep = tem_usep & ~USB_RHS_MASK;
152 tem_usep |= USB_RHS_STALL;
153 else if (ep->dir == USB_DIR_IN)
154 tem_usep |= USB_RHS_IGNORE_OUT;
156 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
160 static int qe_eptx_stall_change(struct qe_ep *ep, int value)
163 u8 epnum = ep->epnum;
164 struct qe_udc *udc = ep->udc;
166 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
167 tem_usep = tem_usep & ~USB_THS_MASK;
169 tem_usep |= USB_THS_STALL;
170 else if (ep->dir == USB_DIR_OUT)
171 tem_usep |= USB_THS_IGNORE_IN;
173 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
178 static int qe_ep0_stall(struct qe_udc *udc)
180 qe_eptx_stall_change(&udc->eps[0], 1);
181 qe_eprx_stall_change(&udc->eps[0], 1);
182 udc->ep0_state = WAIT_FOR_SETUP;
187 static int qe_eprx_nack(struct qe_ep *ep)
189 u8 epnum = ep->epnum;
190 struct qe_udc *udc = ep->udc;
192 if (ep->state == EP_STATE_IDLE) {
193 /* Set the ep's nack */
194 clrsetbits_be16(&udc->usb_regs->usb_usep[epnum],
195 USB_RHS_MASK, USB_RHS_NACK);
197 /* Mask Rx and Busy interrupts */
198 clrbits16(&udc->usb_regs->usb_usbmr,
199 (USB_E_RXB_MASK | USB_E_BSY_MASK));
201 ep->state = EP_STATE_NACK;
206 static int qe_eprx_normal(struct qe_ep *ep)
208 struct qe_udc *udc = ep->udc;
210 if (ep->state == EP_STATE_NACK) {
211 clrsetbits_be16(&udc->usb_regs->usb_usep[ep->epnum],
212 USB_RTHS_MASK, USB_THS_IGNORE_IN);
214 /* Unmask RX interrupts */
215 out_be16(&udc->usb_regs->usb_usber,
216 USB_E_BSY_MASK | USB_E_RXB_MASK);
217 setbits16(&udc->usb_regs->usb_usbmr,
218 (USB_E_RXB_MASK | USB_E_BSY_MASK));
220 ep->state = EP_STATE_IDLE;
227 static int qe_ep_cmd_stoptx(struct qe_ep *ep)
229 if (ep->udc->soc_type == PORT_CPM)
230 cpm_command(CPM_USB_STOP_TX | (ep->epnum << CPM_USB_EP_SHIFT),
231 CPM_USB_STOP_TX_OPCODE);
233 qe_issue_cmd(QE_USB_STOP_TX, QE_CR_SUBBLOCK_USB,
239 static int qe_ep_cmd_restarttx(struct qe_ep *ep)
241 if (ep->udc->soc_type == PORT_CPM)
242 cpm_command(CPM_USB_RESTART_TX | (ep->epnum <<
243 CPM_USB_EP_SHIFT), CPM_USB_RESTART_TX_OPCODE);
245 qe_issue_cmd(QE_USB_RESTART_TX, QE_CR_SUBBLOCK_USB,
251 static int qe_ep_flushtxfifo(struct qe_ep *ep)
253 struct qe_udc *udc = ep->udc;
258 qe_ep_cmd_stoptx(ep);
259 out_8(&udc->usb_regs->usb_uscom,
260 USB_CMD_FLUSH_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
261 out_be16(&udc->ep_param[i]->tbptr, in_be16(&udc->ep_param[i]->tbase));
262 out_be32(&udc->ep_param[i]->tstate, 0);
263 out_be16(&udc->ep_param[i]->tbcnt, 0);
265 ep->c_txbd = ep->txbase;
266 ep->n_txbd = ep->txbase;
267 qe_ep_cmd_restarttx(ep);
271 static int qe_ep_filltxfifo(struct qe_ep *ep)
273 struct qe_udc *udc = ep->udc;
275 out_8(&udc->usb_regs->usb_uscom,
276 USB_CMD_STR_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
280 static int qe_epbds_reset(struct qe_udc *udc, int pipe_num)
284 struct qe_bd __iomem *bd;
287 ep = &udc->eps[pipe_num];
289 if (ep->dir == USB_DIR_OUT)
290 bdring_len = USB_BDRING_LEN_RX;
292 bdring_len = USB_BDRING_LEN;
295 for (i = 0; i < (bdring_len - 1); i++) {
296 out_be32((u32 __iomem *)bd, R_E | R_I);
299 out_be32((u32 __iomem *)bd, R_E | R_I | R_W);
302 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
303 out_be32(&bd->buf, 0);
304 out_be32((u32 __iomem *)bd, 0);
307 out_be32((u32 __iomem *)bd, T_W);
312 static int qe_ep_reset(struct qe_udc *udc, int pipe_num)
317 ep = &udc->eps[pipe_num];
318 tmpusep = in_be16(&udc->usb_regs->usb_usep[pipe_num]);
319 tmpusep &= ~USB_RTHS_MASK;
323 qe_ep_flushtxfifo(ep);
326 tmpusep |= USB_THS_IGNORE_IN;
329 qe_ep_flushtxfifo(ep);
330 tmpusep |= USB_RHS_IGNORE_OUT;
335 out_be16(&udc->usb_regs->usb_usep[pipe_num], tmpusep);
337 qe_epbds_reset(udc, pipe_num);
342 static int qe_ep_toggledata01(struct qe_ep *ep)
348 static int qe_ep_bd_init(struct qe_udc *udc, unsigned char pipe_num)
350 struct qe_ep *ep = &udc->eps[pipe_num];
351 unsigned long tmp_addr = 0;
352 struct usb_ep_para __iomem *epparam;
354 struct qe_bd __iomem *bd;
357 if (ep->dir == USB_DIR_OUT)
358 bdring_len = USB_BDRING_LEN_RX;
360 bdring_len = USB_BDRING_LEN;
362 epparam = udc->ep_param[pipe_num];
363 /* alloc multi-ram for BD rings and set the ep parameters */
364 tmp_addr = cpm_muram_alloc(sizeof(struct qe_bd) * (bdring_len +
365 USB_BDRING_LEN_TX), QE_ALIGNMENT_OF_BD);
366 if (IS_ERR_VALUE(tmp_addr))
369 out_be16(&epparam->rbase, (u16)tmp_addr);
370 out_be16(&epparam->tbase, (u16)(tmp_addr +
371 (sizeof(struct qe_bd) * bdring_len)));
373 out_be16(&epparam->rbptr, in_be16(&epparam->rbase));
374 out_be16(&epparam->tbptr, in_be16(&epparam->tbase));
376 ep->rxbase = cpm_muram_addr(tmp_addr);
377 ep->txbase = cpm_muram_addr(tmp_addr + (sizeof(struct qe_bd)
379 ep->n_rxbd = ep->rxbase;
380 ep->e_rxbd = ep->rxbase;
381 ep->n_txbd = ep->txbase;
382 ep->c_txbd = ep->txbase;
383 ep->data01 = 0; /* data0 */
385 /* Init TX and RX bds */
387 for (i = 0; i < bdring_len - 1; i++) {
388 out_be32(&bd->buf, 0);
389 out_be32((u32 __iomem *)bd, 0);
392 out_be32(&bd->buf, 0);
393 out_be32((u32 __iomem *)bd, R_W);
396 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
397 out_be32(&bd->buf, 0);
398 out_be32((u32 __iomem *)bd, 0);
401 out_be32(&bd->buf, 0);
402 out_be32((u32 __iomem *)bd, T_W);
407 static int qe_ep_rxbd_update(struct qe_ep *ep)
412 struct qe_bd __iomem *bd;
413 unsigned int bdring_len;
415 if (ep->rxbase == NULL)
420 ep->rxframe = kmalloc(sizeof(*ep->rxframe), GFP_ATOMIC);
424 qe_frame_init(ep->rxframe);
426 if (ep->dir == USB_DIR_OUT)
427 bdring_len = USB_BDRING_LEN_RX;
429 bdring_len = USB_BDRING_LEN;
431 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (bdring_len + 1);
432 ep->rxbuffer = kzalloc(size, GFP_ATOMIC);
438 ep->rxbuf_d = virt_to_phys((void *)ep->rxbuffer);
439 if (ep->rxbuf_d == DMA_ADDR_INVALID) {
440 ep->rxbuf_d = dma_map_single(ep->udc->gadget.dev.parent,
446 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
452 size = ep->ep.maxpacket + USB_CRC_SIZE + 2;
454 tmp = (u32)(((tmp >> 2) << 2) + 4);
456 for (i = 0; i < bdring_len - 1; i++) {
457 out_be32(&bd->buf, tmp);
458 out_be32((u32 __iomem *)bd, (R_E | R_I));
462 out_be32(&bd->buf, tmp);
463 out_be32((u32 __iomem *)bd, (R_E | R_I | R_W));
468 static int qe_ep_register_init(struct qe_udc *udc, unsigned char pipe_num)
470 struct qe_ep *ep = &udc->eps[pipe_num];
471 struct usb_ep_para __iomem *epparam;
476 epparam = udc->ep_param[pipe_num];
479 logepnum = (ep->ep.desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
480 usep |= (logepnum << USB_EPNUM_SHIFT);
482 switch (ep->ep.desc->bmAttributes & 0x03) {
483 case USB_ENDPOINT_XFER_BULK:
484 usep |= USB_TRANS_BULK;
486 case USB_ENDPOINT_XFER_ISOC:
487 usep |= USB_TRANS_ISO;
489 case USB_ENDPOINT_XFER_INT:
490 usep |= USB_TRANS_INT;
493 usep |= USB_TRANS_CTR;
499 usep |= USB_THS_IGNORE_IN;
502 usep |= USB_RHS_IGNORE_OUT;
507 out_be16(&udc->usb_regs->usb_usep[pipe_num], usep);
510 out_8(&epparam->rbmr, rtfcr);
511 out_8(&epparam->tbmr, rtfcr);
513 tmp = (u16)(ep->ep.maxpacket + USB_CRC_SIZE);
514 /* MRBLR must be divisble by 4 */
515 tmp = (u16)(((tmp >> 2) << 2) + 4);
516 out_be16(&epparam->mrblr, tmp);
521 static int qe_ep_init(struct qe_udc *udc,
522 unsigned char pipe_num,
523 const struct usb_endpoint_descriptor *desc)
525 struct qe_ep *ep = &udc->eps[pipe_num];
530 max = usb_endpoint_maxp(desc);
532 /* check the max package size validate for this endpoint */
533 /* Refer to USB2.0 spec table 9-13,
536 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
537 case USB_ENDPOINT_XFER_BULK:
538 if (strstr(ep->ep.name, "-iso")
539 || strstr(ep->ep.name, "-int"))
541 switch (udc->gadget.speed) {
543 if ((max == 128) || (max == 256) || (max == 512))
560 case USB_ENDPOINT_XFER_INT:
561 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
563 switch (udc->gadget.speed) {
578 case USB_ENDPOINT_XFER_ISOC:
579 if (strstr(ep->ep.name, "-bulk")
580 || strstr(ep->ep.name, "-int"))
582 switch (udc->gadget.speed) {
595 case USB_ENDPOINT_XFER_CONTROL:
596 if (strstr(ep->ep.name, "-iso")
597 || strstr(ep->ep.name, "-int"))
599 switch (udc->gadget.speed) {
635 spin_lock_irqsave(&udc->lock, flags);
637 /* initialize ep structure */
638 ep->ep.maxpacket = max;
639 ep->tm = (u8)(desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
645 ep->dir = USB_DIR_BOTH;
646 udc->ep0_dir = USB_DIR_OUT;
647 udc->ep0_state = WAIT_FOR_SETUP;
649 switch (desc->bEndpointAddress & USB_ENDPOINT_DIR_MASK) {
651 ep->dir = USB_DIR_OUT;
654 ep->dir = USB_DIR_IN;
660 /* hardware special operation */
661 qe_ep_bd_init(udc, pipe_num);
662 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_OUT)) {
663 reval = qe_ep_rxbd_update(ep);
668 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_IN)) {
669 ep->txframe = kmalloc(sizeof(*ep->txframe), GFP_ATOMIC);
672 qe_frame_init(ep->txframe);
675 qe_ep_register_init(udc, pipe_num);
677 /* Now HW will be NAKing transfers to that EP,
678 * until a buffer is queued to it. */
679 spin_unlock_irqrestore(&udc->lock, flags);
686 spin_unlock_irqrestore(&udc->lock, flags);
688 dev_err(udc->dev, "failed to initialize %s\n", ep->ep.name);
692 static inline void qe_usb_enable(struct qe_udc *udc)
694 setbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
697 static inline void qe_usb_disable(struct qe_udc *udc)
699 clrbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
702 /*----------------------------------------------------------------------------*
703 * USB and EP basic manipulate function end *
704 *----------------------------------------------------------------------------*/
707 /******************************************************************************
708 UDC transmit and receive process
709 ******************************************************************************/
710 static void recycle_one_rxbd(struct qe_ep *ep)
714 bdstatus = in_be32((u32 __iomem *)ep->e_rxbd);
715 bdstatus = R_I | R_E | (bdstatus & R_W);
716 out_be32((u32 __iomem *)ep->e_rxbd, bdstatus);
719 ep->e_rxbd = ep->rxbase;
724 static void recycle_rxbds(struct qe_ep *ep, unsigned char stopatnext)
727 struct qe_bd __iomem *bd, *nextbd;
728 unsigned char stop = 0;
732 bdstatus = in_be32((u32 __iomem *)bd);
734 while (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK) && !stop) {
735 bdstatus = R_E | R_I | (bdstatus & R_W);
736 out_be32((u32 __iomem *)bd, bdstatus);
743 bdstatus = in_be32((u32 __iomem *)bd);
744 if (stopatnext && (bd == nextbd))
751 static void ep_recycle_rxbds(struct qe_ep *ep)
753 struct qe_bd __iomem *bd = ep->n_rxbd;
755 u8 epnum = ep->epnum;
756 struct qe_udc *udc = ep->udc;
758 bdstatus = in_be32((u32 __iomem *)bd);
759 if (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK)) {
761 ((in_be16(&udc->ep_param[epnum]->rbptr) -
762 in_be16(&udc->ep_param[epnum]->rbase))
764 bdstatus = in_be32((u32 __iomem *)bd);
772 recycle_rxbds(ep, 0);
773 ep->e_rxbd = ep->n_rxbd;
775 recycle_rxbds(ep, 1);
777 if (in_be16(&udc->usb_regs->usb_usber) & USB_E_BSY_MASK)
778 out_be16(&udc->usb_regs->usb_usber, USB_E_BSY_MASK);
780 if (ep->has_data <= 0 && (!list_empty(&ep->queue)))
786 static void setup_received_handle(struct qe_udc *udc,
787 struct usb_ctrlrequest *setup);
788 static int qe_ep_rxframe_handle(struct qe_ep *ep);
789 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req);
790 /* when BD PID is setup, handle the packet */
791 static int ep0_setup_handle(struct qe_udc *udc)
793 struct qe_ep *ep = &udc->eps[0];
794 struct qe_frame *pframe;
798 pframe = ep->rxframe;
799 if ((frame_get_info(pframe) & PID_SETUP)
800 && (udc->ep0_state == WAIT_FOR_SETUP)) {
801 fsize = frame_get_length(pframe);
802 if (unlikely(fsize != 8))
804 cp = (u8 *)&udc->local_setup_buff;
805 memcpy(cp, pframe->data, fsize);
808 /* handle the usb command base on the usb_ctrlrequest */
809 setup_received_handle(udc, &udc->local_setup_buff);
815 static int qe_ep0_rx(struct qe_udc *udc)
817 struct qe_ep *ep = &udc->eps[0];
818 struct qe_frame *pframe;
819 struct qe_bd __iomem *bd;
820 u32 bdstatus, length;
823 pframe = ep->rxframe;
825 if (ep->dir == USB_DIR_IN) {
826 dev_err(udc->dev, "ep0 not a control endpoint\n");
831 bdstatus = in_be32((u32 __iomem *)bd);
832 length = bdstatus & BD_LENGTH_MASK;
834 while (!(bdstatus & R_E) && length) {
835 if ((bdstatus & R_F) && (bdstatus & R_L)
836 && !(bdstatus & R_ERROR)) {
837 if (length == USB_CRC_SIZE) {
838 udc->ep0_state = WAIT_FOR_SETUP;
840 "receive a ZLP in status phase\n");
842 qe_frame_clean(pframe);
843 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
844 frame_set_data(pframe, (u8 *)vaddr);
845 frame_set_length(pframe,
846 (length - USB_CRC_SIZE));
847 frame_set_status(pframe, FRAME_OK);
848 switch (bdstatus & R_PID) {
850 frame_set_info(pframe, PID_SETUP);
853 frame_set_info(pframe, PID_DATA1);
856 frame_set_info(pframe, PID_DATA0);
860 if ((bdstatus & R_PID) == R_PID_SETUP)
861 ep0_setup_handle(udc);
863 qe_ep_rxframe_handle(ep);
866 dev_err(udc->dev, "The receive frame with error!\n");
869 /* note: don't clear the rxbd's buffer address */
870 recycle_one_rxbd(ep);
878 bdstatus = in_be32((u32 __iomem *)bd);
879 length = bdstatus & BD_LENGTH_MASK;
888 static int qe_ep_rxframe_handle(struct qe_ep *ep)
890 struct qe_frame *pframe;
896 pframe = ep->rxframe;
898 if (frame_get_info(pframe) & PID_DATA1)
901 if (framepid != ep->data01) {
902 dev_err(ep->udc->dev, "the data01 error!\n");
906 fsize = frame_get_length(pframe);
907 if (list_empty(&ep->queue)) {
908 dev_err(ep->udc->dev, "the %s have no requeue!\n", ep->name);
910 req = list_entry(ep->queue.next, struct qe_req, queue);
912 cp = (u8 *)(req->req.buf) + req->req.actual;
914 memcpy(cp, pframe->data, fsize);
915 req->req.actual += fsize;
916 if ((fsize < ep->ep.maxpacket) ||
917 (req->req.actual >= req->req.length)) {
919 ep0_req_complete(ep->udc, req);
922 if (list_empty(&ep->queue) && ep->epnum != 0)
928 qe_ep_toggledata01(ep);
933 static void ep_rx_tasklet(struct tasklet_struct *t)
935 struct qe_udc *udc = from_tasklet(udc, t, rx_tasklet);
937 struct qe_frame *pframe;
938 struct qe_bd __iomem *bd;
940 u32 bdstatus, length;
943 spin_lock_irqsave(&udc->lock, flags);
945 for (i = 1; i < USB_MAX_ENDPOINTS; i++) {
948 if (ep->dir == USB_DIR_IN || ep->enable_tasklet == 0) {
950 "This is a transmit ep or disable tasklet!\n");
954 pframe = ep->rxframe;
956 bdstatus = in_be32((u32 __iomem *)bd);
957 length = bdstatus & BD_LENGTH_MASK;
959 while (!(bdstatus & R_E) && length) {
960 if (list_empty(&ep->queue)) {
963 "The rxep have noreq %d\n",
968 if ((bdstatus & R_F) && (bdstatus & R_L)
969 && !(bdstatus & R_ERROR)) {
970 qe_frame_clean(pframe);
971 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
972 frame_set_data(pframe, (u8 *)vaddr);
973 frame_set_length(pframe,
974 (length - USB_CRC_SIZE));
975 frame_set_status(pframe, FRAME_OK);
976 switch (bdstatus & R_PID) {
978 frame_set_info(pframe, PID_DATA1);
981 frame_set_info(pframe, PID_SETUP);
984 frame_set_info(pframe, PID_DATA0);
987 /* handle the rx frame */
988 qe_ep_rxframe_handle(ep);
991 "error in received frame\n");
993 /* note: don't clear the rxbd's buffer address */
994 /*clear the length */
995 out_be32((u32 __iomem *)bd, bdstatus & BD_STATUS_MASK);
997 if (!(ep->localnack))
998 recycle_one_rxbd(ep);
1006 bdstatus = in_be32((u32 __iomem *)bd);
1007 length = bdstatus & BD_LENGTH_MASK;
1013 ep_recycle_rxbds(ep);
1015 ep->enable_tasklet = 0;
1018 spin_unlock_irqrestore(&udc->lock, flags);
1021 static int qe_ep_rx(struct qe_ep *ep)
1024 struct qe_frame *pframe;
1025 struct qe_bd __iomem *bd;
1026 u16 swoffs, ucoffs, emptybds;
1029 pframe = ep->rxframe;
1031 if (ep->dir == USB_DIR_IN) {
1032 dev_err(udc->dev, "transmit ep in rx function\n");
1038 swoffs = (u16)(bd - ep->rxbase);
1039 ucoffs = (u16)((in_be16(&udc->ep_param[ep->epnum]->rbptr) -
1040 in_be16(&udc->ep_param[ep->epnum]->rbase)) >> 3);
1041 if (swoffs < ucoffs)
1042 emptybds = USB_BDRING_LEN_RX - ucoffs + swoffs;
1044 emptybds = swoffs - ucoffs;
1046 if (emptybds < MIN_EMPTY_BDS) {
1049 dev_vdbg(udc->dev, "%d empty bds, send NACK\n", emptybds);
1051 ep->has_data = USB_BDRING_LEN_RX - emptybds;
1053 if (list_empty(&ep->queue)) {
1055 dev_vdbg(udc->dev, "The rxep have no req queued with %d BDs\n",
1060 tasklet_schedule(&udc->rx_tasklet);
1061 ep->enable_tasklet = 1;
1066 /* send data from a frame, no matter what tx_req */
1067 static int qe_ep_tx(struct qe_ep *ep, struct qe_frame *frame)
1069 struct qe_udc *udc = ep->udc;
1070 struct qe_bd __iomem *bd;
1072 u32 bdstatus, pidmask;
1075 if (ep->dir == USB_DIR_OUT) {
1076 dev_err(udc->dev, "receive ep passed to tx function\n");
1080 /* Disable the Tx interrupt */
1081 saveusbmr = in_be16(&udc->usb_regs->usb_usbmr);
1082 out_be16(&udc->usb_regs->usb_usbmr,
1083 saveusbmr & ~(USB_E_TXB_MASK | USB_E_TXE_MASK));
1086 bdstatus = in_be32((u32 __iomem *)bd);
1088 if (!(bdstatus & (T_R | BD_LENGTH_MASK))) {
1089 if (frame_get_length(frame) == 0) {
1090 frame_set_data(frame, udc->nullbuf);
1091 frame_set_length(frame, 2);
1092 frame->info |= (ZLP | NO_CRC);
1093 dev_vdbg(udc->dev, "the frame size = 0\n");
1095 paddr = virt_to_phys((void *)frame->data);
1096 out_be32(&bd->buf, paddr);
1097 bdstatus = (bdstatus&T_W);
1098 if (!(frame_get_info(frame) & NO_CRC))
1099 bdstatus |= T_R | T_I | T_L | T_TC
1100 | frame_get_length(frame);
1102 bdstatus |= T_R | T_I | T_L | frame_get_length(frame);
1104 /* if the packet is a ZLP in status phase */
1105 if ((ep->epnum == 0) && (udc->ep0_state == DATA_STATE_NEED_ZLP))
1109 pidmask = T_PID_DATA1;
1110 frame->info |= PID_DATA1;
1112 pidmask = T_PID_DATA0;
1113 frame->info |= PID_DATA0;
1116 bdstatus |= pidmask;
1117 out_be32((u32 __iomem *)bd, bdstatus);
1118 qe_ep_filltxfifo(ep);
1120 /* enable the TX interrupt */
1121 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1123 qe_ep_toggledata01(ep);
1125 ep->n_txbd = ep->txbase;
1131 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1132 dev_vdbg(udc->dev, "The tx bd is not ready!\n");
1137 /* when a bd was transmitted, the function can
1138 * handle the tx_req, not include ep0 */
1139 static int txcomplete(struct qe_ep *ep, unsigned char restart)
1141 if (ep->tx_req != NULL) {
1142 struct qe_req *req = ep->tx_req;
1143 unsigned zlp = 0, last_len = 0;
1145 last_len = min_t(unsigned, req->req.length - ep->sent,
1149 int asent = ep->last;
1156 /* zlp needed when req->re.zero is set */
1157 if (req->req.zero) {
1158 if (last_len == 0 ||
1159 (req->req.length % ep->ep.maxpacket) != 0)
1166 /* a request already were transmitted completely */
1167 if (((ep->tx_req->req.length - ep->sent) <= 0) && !zlp) {
1168 done(ep, ep->tx_req, 0);
1175 /* we should gain a new tx_req fot this endpoint */
1176 if (ep->tx_req == NULL) {
1177 if (!list_empty(&ep->queue)) {
1178 ep->tx_req = list_entry(ep->queue.next, struct qe_req,
1188 /* give a frame and a tx_req, send some data */
1189 static int qe_usb_senddata(struct qe_ep *ep, struct qe_frame *frame)
1194 qe_frame_clean(frame);
1195 size = min_t(u32, (ep->tx_req->req.length - ep->sent),
1197 buf = (u8 *)ep->tx_req->req.buf + ep->sent;
1200 ep->tx_req->req.actual += size;
1201 frame_set_data(frame, buf);
1202 frame_set_length(frame, size);
1203 frame_set_status(frame, FRAME_OK);
1204 frame_set_info(frame, 0);
1205 return qe_ep_tx(ep, frame);
1210 /* give a frame struct,send a ZLP */
1211 static int sendnulldata(struct qe_ep *ep, struct qe_frame *frame, uint infor)
1213 struct qe_udc *udc = ep->udc;
1218 qe_frame_clean(frame);
1219 frame_set_data(frame, (u8 *)udc->nullbuf);
1220 frame_set_length(frame, 2);
1221 frame_set_status(frame, FRAME_OK);
1222 frame_set_info(frame, (ZLP | NO_CRC | infor));
1224 return qe_ep_tx(ep, frame);
1227 static int frame_create_tx(struct qe_ep *ep, struct qe_frame *frame)
1229 struct qe_req *req = ep->tx_req;
1235 if ((req->req.length - ep->sent) > 0)
1236 reval = qe_usb_senddata(ep, frame);
1238 reval = sendnulldata(ep, frame, 0);
1243 /* if direction is DIR_IN, the status is Device->Host
1244 * if direction is DIR_OUT, the status transaction is Device<-Host
1245 * in status phase, udc create a request and gain status */
1246 static int ep0_prime_status(struct qe_udc *udc, int direction)
1249 struct qe_ep *ep = &udc->eps[0];
1251 if (direction == USB_DIR_IN) {
1252 udc->ep0_state = DATA_STATE_NEED_ZLP;
1253 udc->ep0_dir = USB_DIR_IN;
1254 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1256 udc->ep0_dir = USB_DIR_OUT;
1257 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1263 /* a request complete in ep0, whether gadget request or udc request */
1264 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req)
1266 struct qe_ep *ep = &udc->eps[0];
1267 /* because usb and ep's status already been set in ch9setaddress() */
1269 switch (udc->ep0_state) {
1270 case DATA_STATE_XMIT:
1272 /* receive status phase */
1273 if (ep0_prime_status(udc, USB_DIR_OUT))
1277 case DATA_STATE_NEED_ZLP:
1279 udc->ep0_state = WAIT_FOR_SETUP;
1282 case DATA_STATE_RECV:
1284 /* send status phase */
1285 if (ep0_prime_status(udc, USB_DIR_IN))
1289 case WAIT_FOR_OUT_STATUS:
1291 udc->ep0_state = WAIT_FOR_SETUP;
1294 case WAIT_FOR_SETUP:
1295 dev_vdbg(udc->dev, "Unexpected interrupt\n");
1304 static int ep0_txcomplete(struct qe_ep *ep, unsigned char restart)
1306 struct qe_req *tx_req = NULL;
1307 struct qe_frame *frame = ep->txframe;
1309 if ((frame_get_info(frame) & (ZLP | NO_REQ)) == (ZLP | NO_REQ)) {
1311 ep->udc->ep0_state = WAIT_FOR_SETUP;
1313 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1317 tx_req = ep->tx_req;
1318 if (tx_req != NULL) {
1320 int asent = ep->last;
1327 /* a request already were transmitted completely */
1328 if ((ep->tx_req->req.length - ep->sent) <= 0) {
1329 ep->tx_req->req.actual = (unsigned int)ep->sent;
1330 ep0_req_complete(ep->udc, ep->tx_req);
1336 dev_vdbg(ep->udc->dev, "the ep0_controller have no req\n");
1342 static int ep0_txframe_handle(struct qe_ep *ep)
1344 /* if have error, transmit again */
1345 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1346 qe_ep_flushtxfifo(ep);
1347 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1348 if (frame_get_info(ep->txframe) & PID_DATA0)
1353 ep0_txcomplete(ep, 1);
1355 ep0_txcomplete(ep, 0);
1357 frame_create_tx(ep, ep->txframe);
1361 static int qe_ep0_txconf(struct qe_ep *ep)
1363 struct qe_bd __iomem *bd;
1364 struct qe_frame *pframe;
1368 bdstatus = in_be32((u32 __iomem *)bd);
1369 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1370 pframe = ep->txframe;
1372 /* clear and recycle the BD */
1373 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1374 out_be32(&bd->buf, 0);
1376 ep->c_txbd = ep->txbase;
1380 if (ep->c_txbd == ep->n_txbd) {
1381 if (bdstatus & DEVICE_T_ERROR) {
1382 frame_set_status(pframe, FRAME_ERROR);
1383 if (bdstatus & T_TO)
1384 pframe->status |= TX_ER_TIMEOUT;
1385 if (bdstatus & T_UN)
1386 pframe->status |= TX_ER_UNDERUN;
1388 ep0_txframe_handle(ep);
1392 bdstatus = in_be32((u32 __iomem *)bd);
1398 static int ep_txframe_handle(struct qe_ep *ep)
1400 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1401 qe_ep_flushtxfifo(ep);
1402 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1403 if (frame_get_info(ep->txframe) & PID_DATA0)
1412 frame_create_tx(ep, ep->txframe); /* send the data */
1416 /* confirm the already trainsmited bd */
1417 static int qe_ep_txconf(struct qe_ep *ep)
1419 struct qe_bd __iomem *bd;
1420 struct qe_frame *pframe = NULL;
1422 unsigned char breakonrxinterrupt = 0;
1425 bdstatus = in_be32((u32 __iomem *)bd);
1426 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1427 pframe = ep->txframe;
1428 if (bdstatus & DEVICE_T_ERROR) {
1429 frame_set_status(pframe, FRAME_ERROR);
1430 if (bdstatus & T_TO)
1431 pframe->status |= TX_ER_TIMEOUT;
1432 if (bdstatus & T_UN)
1433 pframe->status |= TX_ER_UNDERUN;
1436 /* clear and recycle the BD */
1437 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1438 out_be32(&bd->buf, 0);
1440 ep->c_txbd = ep->txbase;
1444 /* handle the tx frame */
1445 ep_txframe_handle(ep);
1447 bdstatus = in_be32((u32 __iomem *)bd);
1449 if (breakonrxinterrupt)
1455 /* Add a request in queue, and try to transmit a packet */
1456 static int ep_req_send(struct qe_ep *ep, struct qe_req *req)
1460 if (ep->tx_req == NULL) {
1463 txcomplete(ep, 0); /* can gain a new tx_req */
1464 reval = frame_create_tx(ep, ep->txframe);
1469 /* Maybe this is a good ideal */
1470 static int ep_req_rx(struct qe_ep *ep, struct qe_req *req)
1472 struct qe_udc *udc = ep->udc;
1473 struct qe_frame *pframe = NULL;
1474 struct qe_bd __iomem *bd;
1475 u32 bdstatus, length;
1481 if (list_empty(&ep->queue)) {
1482 dev_vdbg(udc->dev, "the req already finish!\n");
1485 pframe = ep->rxframe;
1488 bdstatus = in_be32((u32 __iomem *)bd);
1489 length = bdstatus & BD_LENGTH_MASK;
1491 while (!(bdstatus & R_E) && length) {
1494 if ((bdstatus & R_F) && (bdstatus & R_L)
1495 && !(bdstatus & R_ERROR)) {
1496 qe_frame_clean(pframe);
1497 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
1498 frame_set_data(pframe, (u8 *)vaddr);
1499 frame_set_length(pframe, (length - USB_CRC_SIZE));
1500 frame_set_status(pframe, FRAME_OK);
1501 switch (bdstatus & R_PID) {
1503 frame_set_info(pframe, PID_DATA1); break;
1505 frame_set_info(pframe, PID_DATA0); break;
1507 /* handle the rx frame */
1509 if (frame_get_info(pframe) & PID_DATA1)
1514 if (framepid != ep->data01) {
1515 dev_vdbg(udc->dev, "the data01 error!\n");
1517 fsize = frame_get_length(pframe);
1519 cp = (u8 *)(req->req.buf) + req->req.actual;
1521 memcpy(cp, pframe->data, fsize);
1522 req->req.actual += fsize;
1523 if ((fsize < ep->ep.maxpacket)
1524 || (req->req.actual >=
1528 if (list_empty(&ep->queue))
1532 qe_ep_toggledata01(ep);
1535 dev_err(udc->dev, "The receive frame with error!\n");
1538 /* note: don't clear the rxbd's buffer address *
1539 * only Clear the length */
1540 out_be32((u32 __iomem *)bd, (bdstatus & BD_STATUS_MASK));
1549 bdstatus = in_be32((u32 __iomem *)bd);
1550 length = bdstatus & BD_LENGTH_MASK;
1554 ep_recycle_rxbds(ep);
1559 /* only add the request in queue */
1560 static int ep_req_receive(struct qe_ep *ep, struct qe_req *req)
1562 if (ep->state == EP_STATE_NACK) {
1563 if (ep->has_data <= 0) {
1564 /* Enable rx and unmask rx interrupt */
1567 /* Copy the exist BD data */
1575 /********************************************************************
1576 Internal Used Function End
1577 ********************************************************************/
1579 /*-----------------------------------------------------------------------
1580 Endpoint Management Functions For Gadget
1581 -----------------------------------------------------------------------*/
1582 static int qe_ep_enable(struct usb_ep *_ep,
1583 const struct usb_endpoint_descriptor *desc)
1588 unsigned char epnum;
1590 ep = container_of(_ep, struct qe_ep, ep);
1592 /* catch various bogus parameters */
1593 if (!_ep || !desc || _ep->name == ep_name[0] ||
1594 (desc->bDescriptorType != USB_DT_ENDPOINT))
1598 if (!udc->driver || (udc->gadget.speed == USB_SPEED_UNKNOWN))
1601 epnum = (u8)desc->bEndpointAddress & 0xF;
1603 retval = qe_ep_init(udc, epnum, desc);
1605 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1606 dev_dbg(udc->dev, "enable ep%d failed\n", ep->epnum);
1609 dev_dbg(udc->dev, "enable ep%d successful\n", ep->epnum);
1613 static int qe_ep_disable(struct usb_ep *_ep)
1617 unsigned long flags;
1620 ep = container_of(_ep, struct qe_ep, ep);
1623 if (!_ep || !ep->ep.desc) {
1624 dev_dbg(udc->dev, "%s not enabled\n", _ep ? ep->ep.name : NULL);
1628 spin_lock_irqsave(&udc->lock, flags);
1629 /* Nuke all pending requests (does flush) */
1630 nuke(ep, -ESHUTDOWN);
1634 qe_ep_reset(udc, ep->epnum);
1635 spin_unlock_irqrestore(&udc->lock, flags);
1637 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1639 if (ep->dir == USB_DIR_OUT)
1640 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1641 (USB_BDRING_LEN_RX + 1);
1643 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1644 (USB_BDRING_LEN + 1);
1646 if (ep->dir != USB_DIR_IN) {
1649 dma_unmap_single(udc->gadget.dev.parent,
1652 ep->rxbuf_d = DMA_ADDR_INVALID;
1654 dma_sync_single_for_cpu(
1655 udc->gadget.dev.parent,
1659 kfree(ep->rxbuffer);
1662 if (ep->dir != USB_DIR_OUT)
1665 dev_dbg(udc->dev, "disabled %s OK\n", _ep->name);
1669 static struct usb_request *qe_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1673 req = kzalloc(sizeof(*req), gfp_flags);
1677 req->req.dma = DMA_ADDR_INVALID;
1679 INIT_LIST_HEAD(&req->queue);
1684 static void qe_free_request(struct usb_ep *_ep, struct usb_request *_req)
1688 req = container_of(_req, struct qe_req, req);
1694 static int __qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req)
1696 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1697 struct qe_req *req = container_of(_req, struct qe_req, req);
1702 /* catch various bogus parameters */
1703 if (!_req || !req->req.complete || !req->req.buf
1704 || !list_empty(&req->queue)) {
1705 dev_dbg(udc->dev, "bad params\n");
1708 if (!_ep || (!ep->ep.desc && ep_index(ep))) {
1709 dev_dbg(udc->dev, "bad ep\n");
1713 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
1718 /* map virtual address to hardware */
1719 if (req->req.dma == DMA_ADDR_INVALID) {
1720 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1728 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
1729 req->req.dma, req->req.length,
1736 req->req.status = -EINPROGRESS;
1737 req->req.actual = 0;
1739 list_add_tail(&req->queue, &ep->queue);
1740 dev_vdbg(udc->dev, "gadget have request in %s! %d\n",
1741 ep->name, req->req.length);
1743 /* push the request to device */
1745 reval = ep_req_send(ep, req);
1748 if (ep_index(ep) == 0 && req->req.length > 0) {
1750 udc->ep0_state = DATA_STATE_XMIT;
1752 udc->ep0_state = DATA_STATE_RECV;
1755 if (ep->dir == USB_DIR_OUT)
1756 reval = ep_req_receive(ep, req);
1761 /* queues (submits) an I/O request to an endpoint */
1762 static int qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1765 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1766 struct qe_udc *udc = ep->udc;
1767 unsigned long flags;
1770 spin_lock_irqsave(&udc->lock, flags);
1771 ret = __qe_ep_queue(_ep, _req);
1772 spin_unlock_irqrestore(&udc->lock, flags);
1776 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
1777 static int qe_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1779 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1780 struct qe_req *req = NULL;
1781 struct qe_req *iter;
1782 unsigned long flags;
1787 spin_lock_irqsave(&ep->udc->lock, flags);
1789 /* make sure it's actually queued on this endpoint */
1790 list_for_each_entry(iter, &ep->queue, queue) {
1791 if (&iter->req != _req)
1798 spin_unlock_irqrestore(&ep->udc->lock, flags);
1802 done(ep, req, -ECONNRESET);
1804 spin_unlock_irqrestore(&ep->udc->lock, flags);
1808 /*-----------------------------------------------------------------
1809 * modify the endpoint halt feature
1810 * @ep: the non-isochronous endpoint being stalled
1811 * @value: 1--set halt 0--clear halt
1812 * Returns zero, or a negative error code.
1813 *----------------------------------------------------------------*/
1814 static int qe_ep_set_halt(struct usb_ep *_ep, int value)
1817 unsigned long flags;
1818 int status = -EOPNOTSUPP;
1821 ep = container_of(_ep, struct qe_ep, ep);
1822 if (!_ep || !ep->ep.desc) {
1828 /* Attempt to halt IN ep will fail if any transfer requests
1829 * are still queue */
1830 if (value && ep_is_in(ep) && !list_empty(&ep->queue)) {
1836 spin_lock_irqsave(&ep->udc->lock, flags);
1837 qe_eptx_stall_change(ep, value);
1838 qe_eprx_stall_change(ep, value);
1839 spin_unlock_irqrestore(&ep->udc->lock, flags);
1841 if (ep->epnum == 0) {
1842 udc->ep0_state = WAIT_FOR_SETUP;
1846 /* set data toggle to DATA0 on clear halt */
1850 dev_vdbg(udc->dev, "%s %s halt stat %d\n", ep->ep.name,
1851 value ? "set" : "clear", status);
1856 static const struct usb_ep_ops qe_ep_ops = {
1857 .enable = qe_ep_enable,
1858 .disable = qe_ep_disable,
1860 .alloc_request = qe_alloc_request,
1861 .free_request = qe_free_request,
1863 .queue = qe_ep_queue,
1864 .dequeue = qe_ep_dequeue,
1866 .set_halt = qe_ep_set_halt,
1869 /*------------------------------------------------------------------------
1870 Gadget Driver Layer Operations
1871 ------------------------------------------------------------------------*/
1873 /* Get the current frame number */
1874 static int qe_get_frame(struct usb_gadget *gadget)
1876 struct qe_udc *udc = container_of(gadget, struct qe_udc, gadget);
1879 tmp = in_be16(&udc->usb_param->frame_n);
1881 return tmp & 0x07ff;
1885 static int fsl_qe_start(struct usb_gadget *gadget,
1886 struct usb_gadget_driver *driver);
1887 static int fsl_qe_stop(struct usb_gadget *gadget);
1889 /* defined in usb_gadget.h */
1890 static const struct usb_gadget_ops qe_gadget_ops = {
1891 .get_frame = qe_get_frame,
1892 .udc_start = fsl_qe_start,
1893 .udc_stop = fsl_qe_stop,
1896 /*-------------------------------------------------------------------------
1897 USB ep0 Setup process in BUS Enumeration
1898 -------------------------------------------------------------------------*/
1899 static int udc_reset_ep_queue(struct qe_udc *udc, u8 pipe)
1901 struct qe_ep *ep = &udc->eps[pipe];
1903 nuke(ep, -ECONNRESET);
1908 static int reset_queues(struct qe_udc *udc)
1912 for (pipe = 0; pipe < USB_MAX_ENDPOINTS; pipe++)
1913 udc_reset_ep_queue(udc, pipe);
1915 /* report disconnect; the driver is already quiesced */
1916 spin_unlock(&udc->lock);
1917 usb_gadget_udc_reset(&udc->gadget, udc->driver);
1918 spin_lock(&udc->lock);
1923 static void ch9setaddress(struct qe_udc *udc, u16 value, u16 index,
1926 /* Save the new address to device struct */
1927 udc->device_address = (u8) value;
1928 /* Update usb state */
1929 udc->usb_state = USB_STATE_ADDRESS;
1931 /* Status phase , send a ZLP */
1932 if (ep0_prime_status(udc, USB_DIR_IN))
1936 static void ownercomplete(struct usb_ep *_ep, struct usb_request *_req)
1938 struct qe_req *req = container_of(_req, struct qe_req, req);
1940 req->req.buf = NULL;
1944 static void ch9getstatus(struct qe_udc *udc, u8 request_type, u16 value,
1945 u16 index, u16 length)
1953 if ((request_type & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1954 /* Get device status */
1955 usb_status = 1 << USB_DEVICE_SELF_POWERED;
1956 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_INTERFACE) {
1957 /* Get interface status */
1958 /* We don't have interface information in udc driver */
1960 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_ENDPOINT) {
1961 /* Get endpoint status */
1962 int pipe = index & USB_ENDPOINT_NUMBER_MASK;
1963 if (pipe >= USB_MAX_ENDPOINTS)
1965 struct qe_ep *target_ep = &udc->eps[pipe];
1968 /* stall if endpoint doesn't exist */
1969 if (!target_ep->ep.desc)
1972 usep = in_be16(&udc->usb_regs->usb_usep[pipe]);
1973 if (index & USB_DIR_IN) {
1974 if (target_ep->dir != USB_DIR_IN)
1976 if ((usep & USB_THS_MASK) == USB_THS_STALL)
1977 usb_status = 1 << USB_ENDPOINT_HALT;
1979 if (target_ep->dir != USB_DIR_OUT)
1981 if ((usep & USB_RHS_MASK) == USB_RHS_STALL)
1982 usb_status = 1 << USB_ENDPOINT_HALT;
1986 req = container_of(qe_alloc_request(&ep->ep, GFP_KERNEL),
1987 struct qe_req, req);
1988 req->req.length = 2;
1989 req->req.buf = udc->statusbuf;
1990 *(u16 *)req->req.buf = cpu_to_le16(usb_status);
1991 req->req.status = -EINPROGRESS;
1992 req->req.actual = 0;
1993 req->req.complete = ownercomplete;
1995 udc->ep0_dir = USB_DIR_IN;
1998 status = __qe_ep_queue(&ep->ep, &req->req);
2003 dev_err(udc->dev, "Can't respond to getstatus request \n");
2007 /* only handle the setup request, suppose the device in normal status */
2008 static void setup_received_handle(struct qe_udc *udc,
2009 struct usb_ctrlrequest *setup)
2011 /* Fix Endian (udc->local_setup_buff is cpu Endian now)*/
2012 u16 wValue = le16_to_cpu(setup->wValue);
2013 u16 wIndex = le16_to_cpu(setup->wIndex);
2014 u16 wLength = le16_to_cpu(setup->wLength);
2016 /* clear the previous request in the ep0 */
2017 udc_reset_ep_queue(udc, 0);
2019 if (setup->bRequestType & USB_DIR_IN)
2020 udc->ep0_dir = USB_DIR_IN;
2022 udc->ep0_dir = USB_DIR_OUT;
2024 switch (setup->bRequest) {
2025 case USB_REQ_GET_STATUS:
2026 /* Data+Status phase form udc */
2027 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
2028 != (USB_DIR_IN | USB_TYPE_STANDARD))
2030 ch9getstatus(udc, setup->bRequestType, wValue, wIndex,
2034 case USB_REQ_SET_ADDRESS:
2035 /* Status phase from udc */
2036 if (setup->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
2039 ch9setaddress(udc, wValue, wIndex, wLength);
2042 case USB_REQ_CLEAR_FEATURE:
2043 case USB_REQ_SET_FEATURE:
2044 /* Requests with no data phase, status phase from udc */
2045 if ((setup->bRequestType & USB_TYPE_MASK)
2046 != USB_TYPE_STANDARD)
2049 if ((setup->bRequestType & USB_RECIP_MASK)
2050 == USB_RECIP_ENDPOINT) {
2051 int pipe = wIndex & USB_ENDPOINT_NUMBER_MASK;
2054 if (wValue != 0 || wLength != 0
2055 || pipe >= USB_MAX_ENDPOINTS)
2057 ep = &udc->eps[pipe];
2059 spin_unlock(&udc->lock);
2060 qe_ep_set_halt(&ep->ep,
2061 (setup->bRequest == USB_REQ_SET_FEATURE)
2063 spin_lock(&udc->lock);
2066 ep0_prime_status(udc, USB_DIR_IN);
2075 /* Data phase from gadget, status phase from udc */
2076 if (setup->bRequestType & USB_DIR_IN) {
2077 udc->ep0_state = DATA_STATE_XMIT;
2078 udc->ep0_dir = USB_DIR_IN;
2080 udc->ep0_state = DATA_STATE_RECV;
2081 udc->ep0_dir = USB_DIR_OUT;
2083 spin_unlock(&udc->lock);
2084 if (udc->driver->setup(&udc->gadget,
2085 &udc->local_setup_buff) < 0)
2087 spin_lock(&udc->lock);
2089 /* No data phase, IN status from gadget */
2090 udc->ep0_dir = USB_DIR_IN;
2091 spin_unlock(&udc->lock);
2092 if (udc->driver->setup(&udc->gadget,
2093 &udc->local_setup_buff) < 0)
2095 spin_lock(&udc->lock);
2096 udc->ep0_state = DATA_STATE_NEED_ZLP;
2100 /*-------------------------------------------------------------------------
2101 USB Interrupt handlers
2102 -------------------------------------------------------------------------*/
2103 static void suspend_irq(struct qe_udc *udc)
2105 udc->resume_state = udc->usb_state;
2106 udc->usb_state = USB_STATE_SUSPENDED;
2108 /* report suspend to the driver ,serial.c not support this*/
2109 if (udc->driver->suspend)
2110 udc->driver->suspend(&udc->gadget);
2113 static void resume_irq(struct qe_udc *udc)
2115 udc->usb_state = udc->resume_state;
2116 udc->resume_state = 0;
2118 /* report resume to the driver , serial.c not support this*/
2119 if (udc->driver->resume)
2120 udc->driver->resume(&udc->gadget);
2123 static void idle_irq(struct qe_udc *udc)
2127 usbs = in_8(&udc->usb_regs->usb_usbs);
2128 if (usbs & USB_IDLE_STATUS_MASK) {
2129 if ((udc->usb_state) != USB_STATE_SUSPENDED)
2132 if (udc->usb_state == USB_STATE_SUSPENDED)
2137 static int reset_irq(struct qe_udc *udc)
2141 if (udc->usb_state == USB_STATE_DEFAULT)
2144 qe_usb_disable(udc);
2145 out_8(&udc->usb_regs->usb_usadr, 0);
2147 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2148 if (udc->eps[i].init)
2149 qe_ep_reset(udc, i);
2153 udc->usb_state = USB_STATE_DEFAULT;
2154 udc->ep0_state = WAIT_FOR_SETUP;
2155 udc->ep0_dir = USB_DIR_OUT;
2160 static int bsy_irq(struct qe_udc *udc)
2165 static int txe_irq(struct qe_udc *udc)
2170 /* ep0 tx interrupt also in here */
2171 static int tx_irq(struct qe_udc *udc)
2174 struct qe_bd __iomem *bd;
2177 if ((udc->usb_state == USB_STATE_ADDRESS)
2178 && (in_8(&udc->usb_regs->usb_usadr) == 0))
2179 out_8(&udc->usb_regs->usb_usadr, udc->device_address);
2181 for (i = (USB_MAX_ENDPOINTS-1); ((i >= 0) && (res == 0)); i--) {
2183 if (ep && ep->init && (ep->dir != USB_DIR_OUT)) {
2185 if (!(in_be32((u32 __iomem *)bd) & T_R)
2186 && (in_be32(&bd->buf))) {
2187 /* confirm the transmitted bd */
2189 res = qe_ep0_txconf(ep);
2191 res = qe_ep_txconf(ep);
2199 /* setup packect's rx is handle in the function too */
2200 static void rx_irq(struct qe_udc *udc)
2203 struct qe_bd __iomem *bd;
2206 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2208 if (ep && ep->init && (ep->dir != USB_DIR_IN)) {
2210 if (!(in_be32((u32 __iomem *)bd) & R_E)
2211 && (in_be32(&bd->buf))) {
2212 if (ep->epnum == 0) {
2215 /*non-setup package receive*/
2223 static irqreturn_t qe_udc_irq(int irq, void *_udc)
2225 struct qe_udc *udc = (struct qe_udc *)_udc;
2227 irqreturn_t status = IRQ_NONE;
2228 unsigned long flags;
2230 spin_lock_irqsave(&udc->lock, flags);
2232 irq_src = in_be16(&udc->usb_regs->usb_usber) &
2233 in_be16(&udc->usb_regs->usb_usbmr);
2234 /* Clear notification bits */
2235 out_be16(&udc->usb_regs->usb_usber, irq_src);
2237 if (irq_src & USB_E_IDLE_MASK) {
2239 irq_src &= ~USB_E_IDLE_MASK;
2240 status = IRQ_HANDLED;
2243 if (irq_src & USB_E_TXB_MASK) {
2245 irq_src &= ~USB_E_TXB_MASK;
2246 status = IRQ_HANDLED;
2249 if (irq_src & USB_E_RXB_MASK) {
2251 irq_src &= ~USB_E_RXB_MASK;
2252 status = IRQ_HANDLED;
2255 if (irq_src & USB_E_RESET_MASK) {
2257 irq_src &= ~USB_E_RESET_MASK;
2258 status = IRQ_HANDLED;
2261 if (irq_src & USB_E_BSY_MASK) {
2263 irq_src &= ~USB_E_BSY_MASK;
2264 status = IRQ_HANDLED;
2267 if (irq_src & USB_E_TXE_MASK) {
2269 irq_src &= ~USB_E_TXE_MASK;
2270 status = IRQ_HANDLED;
2273 spin_unlock_irqrestore(&udc->lock, flags);
2278 /*-------------------------------------------------------------------------
2279 Gadget driver probe and unregister.
2280 --------------------------------------------------------------------------*/
2281 static int fsl_qe_start(struct usb_gadget *gadget,
2282 struct usb_gadget_driver *driver)
2285 unsigned long flags;
2287 udc = container_of(gadget, struct qe_udc, gadget);
2288 /* lock is needed but whether should use this lock or another */
2289 spin_lock_irqsave(&udc->lock, flags);
2291 /* hook up the driver */
2292 udc->driver = driver;
2293 udc->gadget.speed = driver->max_speed;
2295 /* Enable IRQ reg and Set usbcmd reg EN bit */
2298 out_be16(&udc->usb_regs->usb_usber, 0xffff);
2299 out_be16(&udc->usb_regs->usb_usbmr, USB_E_DEFAULT_DEVICE);
2300 udc->usb_state = USB_STATE_ATTACHED;
2301 udc->ep0_state = WAIT_FOR_SETUP;
2302 udc->ep0_dir = USB_DIR_OUT;
2303 spin_unlock_irqrestore(&udc->lock, flags);
2308 static int fsl_qe_stop(struct usb_gadget *gadget)
2311 struct qe_ep *loop_ep;
2312 unsigned long flags;
2314 udc = container_of(gadget, struct qe_udc, gadget);
2315 /* stop usb controller, disable intr */
2316 qe_usb_disable(udc);
2318 /* in fact, no needed */
2319 udc->usb_state = USB_STATE_ATTACHED;
2320 udc->ep0_state = WAIT_FOR_SETUP;
2323 /* stand operation */
2324 spin_lock_irqsave(&udc->lock, flags);
2325 udc->gadget.speed = USB_SPEED_UNKNOWN;
2326 nuke(&udc->eps[0], -ESHUTDOWN);
2327 list_for_each_entry(loop_ep, &udc->gadget.ep_list, ep.ep_list)
2328 nuke(loop_ep, -ESHUTDOWN);
2329 spin_unlock_irqrestore(&udc->lock, flags);
2336 /* udc structure's alloc and setup, include ep-param alloc */
2337 static struct qe_udc *qe_udc_config(struct platform_device *ofdev)
2340 struct device_node *np = ofdev->dev.of_node;
2341 unsigned long tmp_addr = 0;
2342 struct usb_device_para __iomem *usbpram;
2347 udc = kzalloc(sizeof(*udc), GFP_KERNEL);
2351 udc->dev = &ofdev->dev;
2353 /* get default address of usb parameter in MURAM from device tree */
2354 offset = *of_get_address(np, 1, &size, NULL);
2355 udc->usb_param = cpm_muram_addr(offset);
2356 memset_io(udc->usb_param, 0, size);
2358 usbpram = udc->usb_param;
2359 out_be16(&usbpram->frame_n, 0);
2360 out_be32(&usbpram->rstate, 0);
2362 tmp_addr = cpm_muram_alloc((USB_MAX_ENDPOINTS *
2363 sizeof(struct usb_ep_para)),
2364 USB_EP_PARA_ALIGNMENT);
2365 if (IS_ERR_VALUE(tmp_addr))
2368 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2369 out_be16(&usbpram->epptr[i], (u16)tmp_addr);
2370 udc->ep_param[i] = cpm_muram_addr(tmp_addr);
2374 memset_io(udc->ep_param[0], 0,
2375 USB_MAX_ENDPOINTS * sizeof(struct usb_ep_para));
2377 udc->resume_state = USB_STATE_NOTATTACHED;
2378 udc->usb_state = USB_STATE_POWERED;
2381 spin_lock_init(&udc->lock);
2389 /* USB Controller register init */
2390 static int qe_udc_reg_init(struct qe_udc *udc)
2392 struct usb_ctlr __iomem *qe_usbregs;
2393 qe_usbregs = udc->usb_regs;
2395 /* Spec says that we must enable the USB controller to change mode. */
2396 out_8(&qe_usbregs->usb_usmod, 0x01);
2397 /* Mode changed, now disable it, since muram isn't initialized yet. */
2398 out_8(&qe_usbregs->usb_usmod, 0x00);
2400 /* Initialize the rest. */
2401 out_be16(&qe_usbregs->usb_usbmr, 0);
2402 out_8(&qe_usbregs->usb_uscom, 0);
2403 out_be16(&qe_usbregs->usb_usber, USBER_ALL_CLEAR);
2408 static int qe_ep_config(struct qe_udc *udc, unsigned char pipe_num)
2410 struct qe_ep *ep = &udc->eps[pipe_num];
2413 strcpy(ep->name, ep_name[pipe_num]);
2414 ep->ep.name = ep_name[pipe_num];
2416 if (pipe_num == 0) {
2417 ep->ep.caps.type_control = true;
2419 ep->ep.caps.type_iso = true;
2420 ep->ep.caps.type_bulk = true;
2421 ep->ep.caps.type_int = true;
2424 ep->ep.caps.dir_in = true;
2425 ep->ep.caps.dir_out = true;
2427 ep->ep.ops = &qe_ep_ops;
2429 usb_ep_set_maxpacket_limit(&ep->ep, (unsigned short) ~0);
2432 ep->epnum = (u8)pipe_num;
2439 ep->state = EP_STATE_IDLE;
2442 /* the queue lists any req for this ep */
2443 INIT_LIST_HEAD(&ep->queue);
2445 /* gagdet.ep_list used for ep_autoconfig so no ep0*/
2447 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
2449 ep->gadget = &udc->gadget;
2454 /*-----------------------------------------------------------------------
2455 * UDC device Driver operation functions *
2456 *----------------------------------------------------------------------*/
2457 static void qe_udc_release(struct device *dev)
2459 struct qe_udc *udc = container_of(dev, struct qe_udc, gadget.dev);
2462 complete(udc->done);
2463 cpm_muram_free(cpm_muram_offset(udc->ep_param[0]));
2464 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
2465 udc->ep_param[i] = NULL;
2470 /* Driver probe functions */
2471 static const struct of_device_id qe_udc_match[];
2472 static int qe_udc_probe(struct platform_device *ofdev)
2475 struct device_node *np = ofdev->dev.of_node;
2477 unsigned int ret = 0;
2481 prop = of_get_property(np, "mode", NULL);
2482 if (!prop || strcmp(prop, "peripheral"))
2485 /* Initialize the udc structure including QH member and other member */
2486 udc = qe_udc_config(ofdev);
2488 dev_err(&ofdev->dev, "failed to initialize\n");
2492 udc->soc_type = (unsigned long)device_get_match_data(&ofdev->dev);
2493 udc->usb_regs = of_iomap(np, 0);
2494 if (!udc->usb_regs) {
2499 /* initialize usb hw reg except for regs for EP,
2500 * leave usbintr reg untouched*/
2501 qe_udc_reg_init(udc);
2503 /* here comes the stand operations for probe
2504 * set the qe_udc->gadget.xxx */
2505 udc->gadget.ops = &qe_gadget_ops;
2507 /* gadget.ep0 is a pointer */
2508 udc->gadget.ep0 = &udc->eps[0].ep;
2510 INIT_LIST_HEAD(&udc->gadget.ep_list);
2512 /* modify in register gadget process */
2513 udc->gadget.speed = USB_SPEED_UNKNOWN;
2515 /* name: Identifies the controller hardware type. */
2516 udc->gadget.name = driver_name;
2517 udc->gadget.dev.parent = &ofdev->dev;
2519 /* initialize qe_ep struct */
2520 for (i = 0; i < USB_MAX_ENDPOINTS ; i++) {
2521 /* because the ep type isn't decide here so
2522 * qe_ep_init() should be called in ep_enable() */
2524 /* setup the qe_ep struct and link ep.ep.list
2525 * into gadget.ep_list */
2526 qe_ep_config(udc, (unsigned char)i);
2529 /* ep0 initialization in here */
2530 ret = qe_ep_init(udc, 0, &qe_ep0_desc);
2534 /* create a buf for ZLP send, need to remain zeroed */
2535 udc->nullbuf = devm_kzalloc(&ofdev->dev, 256, GFP_KERNEL);
2536 if (udc->nullbuf == NULL) {
2541 /* buffer for data of get_status request */
2542 udc->statusbuf = devm_kzalloc(&ofdev->dev, 2, GFP_KERNEL);
2543 if (udc->statusbuf == NULL) {
2548 udc->nullp = virt_to_phys((void *)udc->nullbuf);
2549 if (udc->nullp == DMA_ADDR_INVALID) {
2550 udc->nullp = dma_map_single(
2551 udc->gadget.dev.parent,
2557 dma_sync_single_for_device(udc->gadget.dev.parent,
2562 tasklet_setup(&udc->rx_tasklet, ep_rx_tasklet);
2563 /* request irq and disable DR */
2564 udc->usb_irq = irq_of_parse_and_map(np, 0);
2565 if (!udc->usb_irq) {
2570 ret = request_irq(udc->usb_irq, qe_udc_irq, 0,
2573 dev_err(udc->dev, "cannot request irq %d err %d\n",
2578 ret = usb_add_gadget_udc_release(&ofdev->dev, &udc->gadget,
2583 platform_set_drvdata(ofdev, udc);
2585 "%s USB controller initialized as device\n",
2586 (udc->soc_type == PORT_QE) ? "QE" : "CPM");
2590 free_irq(udc->usb_irq, udc);
2592 irq_dispose_mapping(udc->usb_irq);
2595 dma_unmap_single(udc->gadget.dev.parent,
2598 udc->nullp = DMA_ADDR_INVALID;
2600 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2606 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2608 kfree(ep->rxbuffer);
2611 iounmap(udc->usb_regs);
2618 static int qe_udc_suspend(struct platform_device *dev, pm_message_t state)
2623 static int qe_udc_resume(struct platform_device *dev)
2629 static void qe_udc_remove(struct platform_device *ofdev)
2631 struct qe_udc *udc = platform_get_drvdata(ofdev);
2634 DECLARE_COMPLETION_ONSTACK(done);
2636 usb_del_gadget_udc(&udc->gadget);
2639 tasklet_disable(&udc->rx_tasklet);
2642 dma_unmap_single(udc->gadget.dev.parent,
2645 udc->nullp = DMA_ADDR_INVALID;
2647 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2653 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2654 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (USB_BDRING_LEN + 1);
2658 dma_unmap_single(udc->gadget.dev.parent,
2661 ep->rxbuf_d = DMA_ADDR_INVALID;
2663 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2668 kfree(ep->rxbuffer);
2671 free_irq(udc->usb_irq, udc);
2672 irq_dispose_mapping(udc->usb_irq);
2674 tasklet_kill(&udc->rx_tasklet);
2676 iounmap(udc->usb_regs);
2678 /* wait for release() of gadget.dev to free udc */
2679 wait_for_completion(&done);
2682 /*-------------------------------------------------------------------------*/
2683 static const struct of_device_id qe_udc_match[] = {
2685 .compatible = "fsl,mpc8323-qe-usb",
2686 .data = (void *)PORT_QE,
2689 .compatible = "fsl,mpc8360-qe-usb",
2690 .data = (void *)PORT_QE,
2693 .compatible = "fsl,mpc8272-cpm-usb",
2694 .data = (void *)PORT_CPM,
2699 MODULE_DEVICE_TABLE(of, qe_udc_match);
2701 static struct platform_driver udc_driver = {
2703 .name = driver_name,
2704 .of_match_table = qe_udc_match,
2706 .probe = qe_udc_probe,
2707 .remove_new = qe_udc_remove,
2709 .suspend = qe_udc_suspend,
2710 .resume = qe_udc_resume,
2714 module_platform_driver(udc_driver);
2716 MODULE_DESCRIPTION(DRIVER_DESC);
2717 MODULE_AUTHOR(DRIVER_AUTHOR);
2718 MODULE_LICENSE("GPL");