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>
30 #include <linux/of_address.h>
31 #include <linux/of_irq.h>
32 #include <linux/of_platform.h>
33 #include <linux/dma-mapping.h>
34 #include <linux/usb/ch9.h>
35 #include <linux/usb/gadget.h>
36 #include <linux/usb/otg.h>
37 #include <soc/fsl/qe/qe.h>
41 #include "fsl_qe_udc.h"
43 #define DRIVER_DESC "Freescale QE/CPM USB Device Controller driver"
44 #define DRIVER_AUTHOR "Xie XiaoBo"
45 #define DRIVER_VERSION "1.0"
47 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
49 static const char driver_name[] = "fsl_qe_udc";
50 static const char driver_desc[] = DRIVER_DESC;
52 /*ep name is important in gadget, it should obey the convention of ep_match()*/
53 static const char *const ep_name[] = {
54 "ep0-control", /* everyone has ep0 */
55 /* 3 configurable endpoints */
61 static const struct usb_endpoint_descriptor qe_ep0_desc = {
62 .bLength = USB_DT_ENDPOINT_SIZE,
63 .bDescriptorType = USB_DT_ENDPOINT,
65 .bEndpointAddress = 0,
66 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
67 .wMaxPacketSize = USB_MAX_CTRL_PAYLOAD,
70 /********************************************************************
71 * Internal Used Function Start
72 ********************************************************************/
73 /*-----------------------------------------------------------------
74 * done() - retire a request; caller blocked irqs
75 *--------------------------------------------------------------*/
76 static void done(struct qe_ep *ep, struct qe_req *req, int status)
78 struct qe_udc *udc = ep->udc;
79 unsigned char stopped = ep->stopped;
81 /* the req->queue pointer is used by ep_queue() func, in which
82 * the request will be added into a udc_ep->queue 'd tail
83 * so here the req will be dropped from the ep->queue
85 list_del_init(&req->queue);
87 /* req.status should be set as -EINPROGRESS in ep_queue() */
88 if (req->req.status == -EINPROGRESS)
89 req->req.status = status;
91 status = req->req.status;
94 dma_unmap_single(udc->gadget.dev.parent,
95 req->req.dma, req->req.length,
99 req->req.dma = DMA_ADDR_INVALID;
102 dma_sync_single_for_cpu(udc->gadget.dev.parent,
103 req->req.dma, req->req.length,
108 if (status && (status != -ESHUTDOWN))
109 dev_vdbg(udc->dev, "complete %s req %p stat %d len %u/%u\n",
110 ep->ep.name, &req->req, status,
111 req->req.actual, req->req.length);
113 /* don't modify queue heads during completion callback */
115 spin_unlock(&udc->lock);
117 usb_gadget_giveback_request(&ep->ep, &req->req);
119 spin_lock(&udc->lock);
121 ep->stopped = stopped;
124 /*-----------------------------------------------------------------
125 * nuke(): delete all requests related to this ep
126 *--------------------------------------------------------------*/
127 static void nuke(struct qe_ep *ep, int status)
129 /* Whether this eq has request linked */
130 while (!list_empty(&ep->queue)) {
131 struct qe_req *req = NULL;
132 req = list_entry(ep->queue.next, struct qe_req, queue);
134 done(ep, req, status);
138 /*---------------------------------------------------------------------------*
139 * USB and Endpoint manipulate process, include parameter and register *
140 *---------------------------------------------------------------------------*/
141 /* @value: 1--set stall 0--clean stall */
142 static int qe_eprx_stall_change(struct qe_ep *ep, int value)
145 u8 epnum = ep->epnum;
146 struct qe_udc *udc = ep->udc;
148 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
149 tem_usep = tem_usep & ~USB_RHS_MASK;
151 tem_usep |= USB_RHS_STALL;
152 else if (ep->dir == USB_DIR_IN)
153 tem_usep |= USB_RHS_IGNORE_OUT;
155 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
159 static int qe_eptx_stall_change(struct qe_ep *ep, int value)
162 u8 epnum = ep->epnum;
163 struct qe_udc *udc = ep->udc;
165 tem_usep = in_be16(&udc->usb_regs->usb_usep[epnum]);
166 tem_usep = tem_usep & ~USB_THS_MASK;
168 tem_usep |= USB_THS_STALL;
169 else if (ep->dir == USB_DIR_OUT)
170 tem_usep |= USB_THS_IGNORE_IN;
172 out_be16(&udc->usb_regs->usb_usep[epnum], tem_usep);
177 static int qe_ep0_stall(struct qe_udc *udc)
179 qe_eptx_stall_change(&udc->eps[0], 1);
180 qe_eprx_stall_change(&udc->eps[0], 1);
181 udc->ep0_state = WAIT_FOR_SETUP;
186 static int qe_eprx_nack(struct qe_ep *ep)
188 u8 epnum = ep->epnum;
189 struct qe_udc *udc = ep->udc;
191 if (ep->state == EP_STATE_IDLE) {
192 /* Set the ep's nack */
193 clrsetbits_be16(&udc->usb_regs->usb_usep[epnum],
194 USB_RHS_MASK, USB_RHS_NACK);
196 /* Mask Rx and Busy interrupts */
197 clrbits16(&udc->usb_regs->usb_usbmr,
198 (USB_E_RXB_MASK | USB_E_BSY_MASK));
200 ep->state = EP_STATE_NACK;
205 static int qe_eprx_normal(struct qe_ep *ep)
207 struct qe_udc *udc = ep->udc;
209 if (ep->state == EP_STATE_NACK) {
210 clrsetbits_be16(&udc->usb_regs->usb_usep[ep->epnum],
211 USB_RTHS_MASK, USB_THS_IGNORE_IN);
213 /* Unmask RX interrupts */
214 out_be16(&udc->usb_regs->usb_usber,
215 USB_E_BSY_MASK | USB_E_RXB_MASK);
216 setbits16(&udc->usb_regs->usb_usbmr,
217 (USB_E_RXB_MASK | USB_E_BSY_MASK));
219 ep->state = EP_STATE_IDLE;
226 static int qe_ep_cmd_stoptx(struct qe_ep *ep)
228 if (ep->udc->soc_type == PORT_CPM)
229 cpm_command(CPM_USB_STOP_TX | (ep->epnum << CPM_USB_EP_SHIFT),
230 CPM_USB_STOP_TX_OPCODE);
232 qe_issue_cmd(QE_USB_STOP_TX, QE_CR_SUBBLOCK_USB,
238 static int qe_ep_cmd_restarttx(struct qe_ep *ep)
240 if (ep->udc->soc_type == PORT_CPM)
241 cpm_command(CPM_USB_RESTART_TX | (ep->epnum <<
242 CPM_USB_EP_SHIFT), CPM_USB_RESTART_TX_OPCODE);
244 qe_issue_cmd(QE_USB_RESTART_TX, QE_CR_SUBBLOCK_USB,
250 static int qe_ep_flushtxfifo(struct qe_ep *ep)
252 struct qe_udc *udc = ep->udc;
257 qe_ep_cmd_stoptx(ep);
258 out_8(&udc->usb_regs->usb_uscom,
259 USB_CMD_FLUSH_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
260 out_be16(&udc->ep_param[i]->tbptr, in_be16(&udc->ep_param[i]->tbase));
261 out_be32(&udc->ep_param[i]->tstate, 0);
262 out_be16(&udc->ep_param[i]->tbcnt, 0);
264 ep->c_txbd = ep->txbase;
265 ep->n_txbd = ep->txbase;
266 qe_ep_cmd_restarttx(ep);
270 static int qe_ep_filltxfifo(struct qe_ep *ep)
272 struct qe_udc *udc = ep->udc;
274 out_8(&udc->usb_regs->usb_uscom,
275 USB_CMD_STR_FIFO | (USB_CMD_EP_MASK & (ep->epnum)));
279 static int qe_epbds_reset(struct qe_udc *udc, int pipe_num)
283 struct qe_bd __iomem *bd;
286 ep = &udc->eps[pipe_num];
288 if (ep->dir == USB_DIR_OUT)
289 bdring_len = USB_BDRING_LEN_RX;
291 bdring_len = USB_BDRING_LEN;
294 for (i = 0; i < (bdring_len - 1); i++) {
295 out_be32((u32 __iomem *)bd, R_E | R_I);
298 out_be32((u32 __iomem *)bd, R_E | R_I | R_W);
301 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
302 out_be32(&bd->buf, 0);
303 out_be32((u32 __iomem *)bd, 0);
306 out_be32((u32 __iomem *)bd, T_W);
311 static int qe_ep_reset(struct qe_udc *udc, int pipe_num)
316 ep = &udc->eps[pipe_num];
317 tmpusep = in_be16(&udc->usb_regs->usb_usep[pipe_num]);
318 tmpusep &= ~USB_RTHS_MASK;
322 qe_ep_flushtxfifo(ep);
325 tmpusep |= USB_THS_IGNORE_IN;
328 qe_ep_flushtxfifo(ep);
329 tmpusep |= USB_RHS_IGNORE_OUT;
334 out_be16(&udc->usb_regs->usb_usep[pipe_num], tmpusep);
336 qe_epbds_reset(udc, pipe_num);
341 static int qe_ep_toggledata01(struct qe_ep *ep)
347 static int qe_ep_bd_init(struct qe_udc *udc, unsigned char pipe_num)
349 struct qe_ep *ep = &udc->eps[pipe_num];
350 unsigned long tmp_addr = 0;
351 struct usb_ep_para __iomem *epparam;
353 struct qe_bd __iomem *bd;
356 if (ep->dir == USB_DIR_OUT)
357 bdring_len = USB_BDRING_LEN_RX;
359 bdring_len = USB_BDRING_LEN;
361 epparam = udc->ep_param[pipe_num];
362 /* alloc multi-ram for BD rings and set the ep parameters */
363 tmp_addr = cpm_muram_alloc(sizeof(struct qe_bd) * (bdring_len +
364 USB_BDRING_LEN_TX), QE_ALIGNMENT_OF_BD);
365 if (IS_ERR_VALUE(tmp_addr))
368 out_be16(&epparam->rbase, (u16)tmp_addr);
369 out_be16(&epparam->tbase, (u16)(tmp_addr +
370 (sizeof(struct qe_bd) * bdring_len)));
372 out_be16(&epparam->rbptr, in_be16(&epparam->rbase));
373 out_be16(&epparam->tbptr, in_be16(&epparam->tbase));
375 ep->rxbase = cpm_muram_addr(tmp_addr);
376 ep->txbase = cpm_muram_addr(tmp_addr + (sizeof(struct qe_bd)
378 ep->n_rxbd = ep->rxbase;
379 ep->e_rxbd = ep->rxbase;
380 ep->n_txbd = ep->txbase;
381 ep->c_txbd = ep->txbase;
382 ep->data01 = 0; /* data0 */
384 /* Init TX and RX bds */
386 for (i = 0; i < bdring_len - 1; i++) {
387 out_be32(&bd->buf, 0);
388 out_be32((u32 __iomem *)bd, 0);
391 out_be32(&bd->buf, 0);
392 out_be32((u32 __iomem *)bd, R_W);
395 for (i = 0; i < USB_BDRING_LEN_TX - 1; i++) {
396 out_be32(&bd->buf, 0);
397 out_be32((u32 __iomem *)bd, 0);
400 out_be32(&bd->buf, 0);
401 out_be32((u32 __iomem *)bd, T_W);
406 static int qe_ep_rxbd_update(struct qe_ep *ep)
411 struct qe_bd __iomem *bd;
412 unsigned int bdring_len;
414 if (ep->rxbase == NULL)
419 ep->rxframe = kmalloc(sizeof(*ep->rxframe), GFP_ATOMIC);
423 qe_frame_init(ep->rxframe);
425 if (ep->dir == USB_DIR_OUT)
426 bdring_len = USB_BDRING_LEN_RX;
428 bdring_len = USB_BDRING_LEN;
430 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (bdring_len + 1);
431 ep->rxbuffer = kzalloc(size, GFP_ATOMIC);
437 ep->rxbuf_d = virt_to_phys((void *)ep->rxbuffer);
438 if (ep->rxbuf_d == DMA_ADDR_INVALID) {
439 ep->rxbuf_d = dma_map_single(ep->udc->gadget.dev.parent,
445 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
451 size = ep->ep.maxpacket + USB_CRC_SIZE + 2;
453 tmp = (u32)(((tmp >> 2) << 2) + 4);
455 for (i = 0; i < bdring_len - 1; i++) {
456 out_be32(&bd->buf, tmp);
457 out_be32((u32 __iomem *)bd, (R_E | R_I));
461 out_be32(&bd->buf, tmp);
462 out_be32((u32 __iomem *)bd, (R_E | R_I | R_W));
467 static int qe_ep_register_init(struct qe_udc *udc, unsigned char pipe_num)
469 struct qe_ep *ep = &udc->eps[pipe_num];
470 struct usb_ep_para __iomem *epparam;
475 epparam = udc->ep_param[pipe_num];
478 logepnum = (ep->ep.desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
479 usep |= (logepnum << USB_EPNUM_SHIFT);
481 switch (ep->ep.desc->bmAttributes & 0x03) {
482 case USB_ENDPOINT_XFER_BULK:
483 usep |= USB_TRANS_BULK;
485 case USB_ENDPOINT_XFER_ISOC:
486 usep |= USB_TRANS_ISO;
488 case USB_ENDPOINT_XFER_INT:
489 usep |= USB_TRANS_INT;
492 usep |= USB_TRANS_CTR;
498 usep |= USB_THS_IGNORE_IN;
501 usep |= USB_RHS_IGNORE_OUT;
506 out_be16(&udc->usb_regs->usb_usep[pipe_num], usep);
509 out_8(&epparam->rbmr, rtfcr);
510 out_8(&epparam->tbmr, rtfcr);
512 tmp = (u16)(ep->ep.maxpacket + USB_CRC_SIZE);
513 /* MRBLR must be divisble by 4 */
514 tmp = (u16)(((tmp >> 2) << 2) + 4);
515 out_be16(&epparam->mrblr, tmp);
520 static int qe_ep_init(struct qe_udc *udc,
521 unsigned char pipe_num,
522 const struct usb_endpoint_descriptor *desc)
524 struct qe_ep *ep = &udc->eps[pipe_num];
529 max = usb_endpoint_maxp(desc);
531 /* check the max package size validate for this endpoint */
532 /* Refer to USB2.0 spec table 9-13,
535 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
536 case USB_ENDPOINT_XFER_BULK:
537 if (strstr(ep->ep.name, "-iso")
538 || strstr(ep->ep.name, "-int"))
540 switch (udc->gadget.speed) {
542 if ((max == 128) || (max == 256) || (max == 512))
559 case USB_ENDPOINT_XFER_INT:
560 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
562 switch (udc->gadget.speed) {
577 case USB_ENDPOINT_XFER_ISOC:
578 if (strstr(ep->ep.name, "-bulk")
579 || strstr(ep->ep.name, "-int"))
581 switch (udc->gadget.speed) {
593 case USB_ENDPOINT_XFER_CONTROL:
594 if (strstr(ep->ep.name, "-iso")
595 || strstr(ep->ep.name, "-int"))
597 switch (udc->gadget.speed) {
633 spin_lock_irqsave(&udc->lock, flags);
635 /* initialize ep structure */
636 ep->ep.maxpacket = max;
637 ep->tm = (u8)(desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
643 ep->dir = USB_DIR_BOTH;
644 udc->ep0_dir = USB_DIR_OUT;
645 udc->ep0_state = WAIT_FOR_SETUP;
647 switch (desc->bEndpointAddress & USB_ENDPOINT_DIR_MASK) {
649 ep->dir = USB_DIR_OUT;
652 ep->dir = USB_DIR_IN;
658 /* hardware special operation */
659 qe_ep_bd_init(udc, pipe_num);
660 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_OUT)) {
661 reval = qe_ep_rxbd_update(ep);
666 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_IN)) {
667 ep->txframe = kmalloc(sizeof(*ep->txframe), GFP_ATOMIC);
670 qe_frame_init(ep->txframe);
673 qe_ep_register_init(udc, pipe_num);
675 /* Now HW will be NAKing transfers to that EP,
676 * until a buffer is queued to it. */
677 spin_unlock_irqrestore(&udc->lock, flags);
684 spin_unlock_irqrestore(&udc->lock, flags);
686 dev_err(udc->dev, "failed to initialize %s\n", ep->ep.name);
690 static inline void qe_usb_enable(struct qe_udc *udc)
692 setbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
695 static inline void qe_usb_disable(struct qe_udc *udc)
697 clrbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
700 /*----------------------------------------------------------------------------*
701 * USB and EP basic manipulate function end *
702 *----------------------------------------------------------------------------*/
705 /******************************************************************************
706 UDC transmit and receive process
707 ******************************************************************************/
708 static void recycle_one_rxbd(struct qe_ep *ep)
712 bdstatus = in_be32((u32 __iomem *)ep->e_rxbd);
713 bdstatus = R_I | R_E | (bdstatus & R_W);
714 out_be32((u32 __iomem *)ep->e_rxbd, bdstatus);
717 ep->e_rxbd = ep->rxbase;
722 static void recycle_rxbds(struct qe_ep *ep, unsigned char stopatnext)
725 struct qe_bd __iomem *bd, *nextbd;
726 unsigned char stop = 0;
730 bdstatus = in_be32((u32 __iomem *)bd);
732 while (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK) && !stop) {
733 bdstatus = R_E | R_I | (bdstatus & R_W);
734 out_be32((u32 __iomem *)bd, bdstatus);
741 bdstatus = in_be32((u32 __iomem *)bd);
742 if (stopatnext && (bd == nextbd))
749 static void ep_recycle_rxbds(struct qe_ep *ep)
751 struct qe_bd __iomem *bd = ep->n_rxbd;
753 u8 epnum = ep->epnum;
754 struct qe_udc *udc = ep->udc;
756 bdstatus = in_be32((u32 __iomem *)bd);
757 if (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK)) {
759 ((in_be16(&udc->ep_param[epnum]->rbptr) -
760 in_be16(&udc->ep_param[epnum]->rbase))
762 bdstatus = in_be32((u32 __iomem *)bd);
770 recycle_rxbds(ep, 0);
771 ep->e_rxbd = ep->n_rxbd;
773 recycle_rxbds(ep, 1);
775 if (in_be16(&udc->usb_regs->usb_usber) & USB_E_BSY_MASK)
776 out_be16(&udc->usb_regs->usb_usber, USB_E_BSY_MASK);
778 if (ep->has_data <= 0 && (!list_empty(&ep->queue)))
784 static void setup_received_handle(struct qe_udc *udc,
785 struct usb_ctrlrequest *setup);
786 static int qe_ep_rxframe_handle(struct qe_ep *ep);
787 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req);
788 /* when BD PID is setup, handle the packet */
789 static int ep0_setup_handle(struct qe_udc *udc)
791 struct qe_ep *ep = &udc->eps[0];
792 struct qe_frame *pframe;
796 pframe = ep->rxframe;
797 if ((frame_get_info(pframe) & PID_SETUP)
798 && (udc->ep0_state == WAIT_FOR_SETUP)) {
799 fsize = frame_get_length(pframe);
800 if (unlikely(fsize != 8))
802 cp = (u8 *)&udc->local_setup_buff;
803 memcpy(cp, pframe->data, fsize);
806 /* handle the usb command base on the usb_ctrlrequest */
807 setup_received_handle(udc, &udc->local_setup_buff);
813 static int qe_ep0_rx(struct qe_udc *udc)
815 struct qe_ep *ep = &udc->eps[0];
816 struct qe_frame *pframe;
817 struct qe_bd __iomem *bd;
818 u32 bdstatus, length;
821 pframe = ep->rxframe;
823 if (ep->dir == USB_DIR_IN) {
824 dev_err(udc->dev, "ep0 not a control endpoint\n");
829 bdstatus = in_be32((u32 __iomem *)bd);
830 length = bdstatus & BD_LENGTH_MASK;
832 while (!(bdstatus & R_E) && length) {
833 if ((bdstatus & R_F) && (bdstatus & R_L)
834 && !(bdstatus & R_ERROR)) {
835 if (length == USB_CRC_SIZE) {
836 udc->ep0_state = WAIT_FOR_SETUP;
838 "receive a ZLP in status phase\n");
840 qe_frame_clean(pframe);
841 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
842 frame_set_data(pframe, (u8 *)vaddr);
843 frame_set_length(pframe,
844 (length - USB_CRC_SIZE));
845 frame_set_status(pframe, FRAME_OK);
846 switch (bdstatus & R_PID) {
848 frame_set_info(pframe, PID_SETUP);
851 frame_set_info(pframe, PID_DATA1);
854 frame_set_info(pframe, PID_DATA0);
858 if ((bdstatus & R_PID) == R_PID_SETUP)
859 ep0_setup_handle(udc);
861 qe_ep_rxframe_handle(ep);
864 dev_err(udc->dev, "The receive frame with error!\n");
867 /* note: don't clear the rxbd's buffer address */
868 recycle_one_rxbd(ep);
876 bdstatus = in_be32((u32 __iomem *)bd);
877 length = bdstatus & BD_LENGTH_MASK;
886 static int qe_ep_rxframe_handle(struct qe_ep *ep)
888 struct qe_frame *pframe;
894 pframe = ep->rxframe;
896 if (frame_get_info(pframe) & PID_DATA1)
899 if (framepid != ep->data01) {
900 dev_err(ep->udc->dev, "the data01 error!\n");
904 fsize = frame_get_length(pframe);
905 if (list_empty(&ep->queue)) {
906 dev_err(ep->udc->dev, "the %s have no requeue!\n", ep->name);
908 req = list_entry(ep->queue.next, struct qe_req, queue);
910 cp = (u8 *)(req->req.buf) + req->req.actual;
912 memcpy(cp, pframe->data, fsize);
913 req->req.actual += fsize;
914 if ((fsize < ep->ep.maxpacket) ||
915 (req->req.actual >= req->req.length)) {
917 ep0_req_complete(ep->udc, req);
920 if (list_empty(&ep->queue) && ep->epnum != 0)
926 qe_ep_toggledata01(ep);
931 static void ep_rx_tasklet(struct tasklet_struct *t)
933 struct qe_udc *udc = from_tasklet(udc, t, rx_tasklet);
935 struct qe_frame *pframe;
936 struct qe_bd __iomem *bd;
938 u32 bdstatus, length;
941 spin_lock_irqsave(&udc->lock, flags);
943 for (i = 1; i < USB_MAX_ENDPOINTS; i++) {
946 if (ep->dir == USB_DIR_IN || ep->enable_tasklet == 0) {
948 "This is a transmit ep or disable tasklet!\n");
952 pframe = ep->rxframe;
954 bdstatus = in_be32((u32 __iomem *)bd);
955 length = bdstatus & BD_LENGTH_MASK;
957 while (!(bdstatus & R_E) && length) {
958 if (list_empty(&ep->queue)) {
961 "The rxep have noreq %d\n",
966 if ((bdstatus & R_F) && (bdstatus & R_L)
967 && !(bdstatus & R_ERROR)) {
968 qe_frame_clean(pframe);
969 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
970 frame_set_data(pframe, (u8 *)vaddr);
971 frame_set_length(pframe,
972 (length - USB_CRC_SIZE));
973 frame_set_status(pframe, FRAME_OK);
974 switch (bdstatus & R_PID) {
976 frame_set_info(pframe, PID_DATA1);
979 frame_set_info(pframe, PID_SETUP);
982 frame_set_info(pframe, PID_DATA0);
985 /* handle the rx frame */
986 qe_ep_rxframe_handle(ep);
989 "error in received frame\n");
991 /* note: don't clear the rxbd's buffer address */
992 /*clear the length */
993 out_be32((u32 __iomem *)bd, bdstatus & BD_STATUS_MASK);
995 if (!(ep->localnack))
996 recycle_one_rxbd(ep);
1004 bdstatus = in_be32((u32 __iomem *)bd);
1005 length = bdstatus & BD_LENGTH_MASK;
1011 ep_recycle_rxbds(ep);
1013 ep->enable_tasklet = 0;
1016 spin_unlock_irqrestore(&udc->lock, flags);
1019 static int qe_ep_rx(struct qe_ep *ep)
1022 struct qe_frame *pframe;
1023 struct qe_bd __iomem *bd;
1024 u16 swoffs, ucoffs, emptybds;
1027 pframe = ep->rxframe;
1029 if (ep->dir == USB_DIR_IN) {
1030 dev_err(udc->dev, "transmit ep in rx function\n");
1036 swoffs = (u16)(bd - ep->rxbase);
1037 ucoffs = (u16)((in_be16(&udc->ep_param[ep->epnum]->rbptr) -
1038 in_be16(&udc->ep_param[ep->epnum]->rbase)) >> 3);
1039 if (swoffs < ucoffs)
1040 emptybds = USB_BDRING_LEN_RX - ucoffs + swoffs;
1042 emptybds = swoffs - ucoffs;
1044 if (emptybds < MIN_EMPTY_BDS) {
1047 dev_vdbg(udc->dev, "%d empty bds, send NACK\n", emptybds);
1049 ep->has_data = USB_BDRING_LEN_RX - emptybds;
1051 if (list_empty(&ep->queue)) {
1053 dev_vdbg(udc->dev, "The rxep have no req queued with %d BDs\n",
1058 tasklet_schedule(&udc->rx_tasklet);
1059 ep->enable_tasklet = 1;
1064 /* send data from a frame, no matter what tx_req */
1065 static int qe_ep_tx(struct qe_ep *ep, struct qe_frame *frame)
1067 struct qe_udc *udc = ep->udc;
1068 struct qe_bd __iomem *bd;
1070 u32 bdstatus, pidmask;
1073 if (ep->dir == USB_DIR_OUT) {
1074 dev_err(udc->dev, "receive ep passed to tx function\n");
1078 /* Disable the Tx interrupt */
1079 saveusbmr = in_be16(&udc->usb_regs->usb_usbmr);
1080 out_be16(&udc->usb_regs->usb_usbmr,
1081 saveusbmr & ~(USB_E_TXB_MASK | USB_E_TXE_MASK));
1084 bdstatus = in_be32((u32 __iomem *)bd);
1086 if (!(bdstatus & (T_R | BD_LENGTH_MASK))) {
1087 if (frame_get_length(frame) == 0) {
1088 frame_set_data(frame, udc->nullbuf);
1089 frame_set_length(frame, 2);
1090 frame->info |= (ZLP | NO_CRC);
1091 dev_vdbg(udc->dev, "the frame size = 0\n");
1093 paddr = virt_to_phys((void *)frame->data);
1094 out_be32(&bd->buf, paddr);
1095 bdstatus = (bdstatus&T_W);
1096 if (!(frame_get_info(frame) & NO_CRC))
1097 bdstatus |= T_R | T_I | T_L | T_TC
1098 | frame_get_length(frame);
1100 bdstatus |= T_R | T_I | T_L | frame_get_length(frame);
1102 /* if the packet is a ZLP in status phase */
1103 if ((ep->epnum == 0) && (udc->ep0_state == DATA_STATE_NEED_ZLP))
1107 pidmask = T_PID_DATA1;
1108 frame->info |= PID_DATA1;
1110 pidmask = T_PID_DATA0;
1111 frame->info |= PID_DATA0;
1114 bdstatus |= pidmask;
1115 out_be32((u32 __iomem *)bd, bdstatus);
1116 qe_ep_filltxfifo(ep);
1118 /* enable the TX interrupt */
1119 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1121 qe_ep_toggledata01(ep);
1123 ep->n_txbd = ep->txbase;
1129 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1130 dev_vdbg(udc->dev, "The tx bd is not ready!\n");
1135 /* when a bd was transmitted, the function can
1136 * handle the tx_req, not include ep0 */
1137 static int txcomplete(struct qe_ep *ep, unsigned char restart)
1139 if (ep->tx_req != NULL) {
1140 struct qe_req *req = ep->tx_req;
1141 unsigned zlp = 0, last_len = 0;
1143 last_len = min_t(unsigned, req->req.length - ep->sent,
1147 int asent = ep->last;
1154 /* zlp needed when req->re.zero is set */
1155 if (req->req.zero) {
1156 if (last_len == 0 ||
1157 (req->req.length % ep->ep.maxpacket) != 0)
1164 /* a request already were transmitted completely */
1165 if (((ep->tx_req->req.length - ep->sent) <= 0) && !zlp) {
1166 done(ep, ep->tx_req, 0);
1173 /* we should gain a new tx_req fot this endpoint */
1174 if (ep->tx_req == NULL) {
1175 if (!list_empty(&ep->queue)) {
1176 ep->tx_req = list_entry(ep->queue.next, struct qe_req,
1186 /* give a frame and a tx_req, send some data */
1187 static int qe_usb_senddata(struct qe_ep *ep, struct qe_frame *frame)
1192 qe_frame_clean(frame);
1193 size = min_t(u32, (ep->tx_req->req.length - ep->sent),
1195 buf = (u8 *)ep->tx_req->req.buf + ep->sent;
1198 ep->tx_req->req.actual += size;
1199 frame_set_data(frame, buf);
1200 frame_set_length(frame, size);
1201 frame_set_status(frame, FRAME_OK);
1202 frame_set_info(frame, 0);
1203 return qe_ep_tx(ep, frame);
1208 /* give a frame struct,send a ZLP */
1209 static int sendnulldata(struct qe_ep *ep, struct qe_frame *frame, uint infor)
1211 struct qe_udc *udc = ep->udc;
1216 qe_frame_clean(frame);
1217 frame_set_data(frame, (u8 *)udc->nullbuf);
1218 frame_set_length(frame, 2);
1219 frame_set_status(frame, FRAME_OK);
1220 frame_set_info(frame, (ZLP | NO_CRC | infor));
1222 return qe_ep_tx(ep, frame);
1225 static int frame_create_tx(struct qe_ep *ep, struct qe_frame *frame)
1227 struct qe_req *req = ep->tx_req;
1233 if ((req->req.length - ep->sent) > 0)
1234 reval = qe_usb_senddata(ep, frame);
1236 reval = sendnulldata(ep, frame, 0);
1241 /* if direction is DIR_IN, the status is Device->Host
1242 * if direction is DIR_OUT, the status transaction is Device<-Host
1243 * in status phase, udc create a request and gain status */
1244 static int ep0_prime_status(struct qe_udc *udc, int direction)
1247 struct qe_ep *ep = &udc->eps[0];
1249 if (direction == USB_DIR_IN) {
1250 udc->ep0_state = DATA_STATE_NEED_ZLP;
1251 udc->ep0_dir = USB_DIR_IN;
1252 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1254 udc->ep0_dir = USB_DIR_OUT;
1255 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1261 /* a request complete in ep0, whether gadget request or udc request */
1262 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req)
1264 struct qe_ep *ep = &udc->eps[0];
1265 /* because usb and ep's status already been set in ch9setaddress() */
1267 switch (udc->ep0_state) {
1268 case DATA_STATE_XMIT:
1270 /* receive status phase */
1271 if (ep0_prime_status(udc, USB_DIR_OUT))
1275 case DATA_STATE_NEED_ZLP:
1277 udc->ep0_state = WAIT_FOR_SETUP;
1280 case DATA_STATE_RECV:
1282 /* send status phase */
1283 if (ep0_prime_status(udc, USB_DIR_IN))
1287 case WAIT_FOR_OUT_STATUS:
1289 udc->ep0_state = WAIT_FOR_SETUP;
1292 case WAIT_FOR_SETUP:
1293 dev_vdbg(udc->dev, "Unexpected interrupt\n");
1302 static int ep0_txcomplete(struct qe_ep *ep, unsigned char restart)
1304 struct qe_req *tx_req = NULL;
1305 struct qe_frame *frame = ep->txframe;
1307 if ((frame_get_info(frame) & (ZLP | NO_REQ)) == (ZLP | NO_REQ)) {
1309 ep->udc->ep0_state = WAIT_FOR_SETUP;
1311 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1315 tx_req = ep->tx_req;
1316 if (tx_req != NULL) {
1318 int asent = ep->last;
1325 /* a request already were transmitted completely */
1326 if ((ep->tx_req->req.length - ep->sent) <= 0) {
1327 ep->tx_req->req.actual = (unsigned int)ep->sent;
1328 ep0_req_complete(ep->udc, ep->tx_req);
1334 dev_vdbg(ep->udc->dev, "the ep0_controller have no req\n");
1340 static int ep0_txframe_handle(struct qe_ep *ep)
1342 /* if have error, transmit again */
1343 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1344 qe_ep_flushtxfifo(ep);
1345 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1346 if (frame_get_info(ep->txframe) & PID_DATA0)
1351 ep0_txcomplete(ep, 1);
1353 ep0_txcomplete(ep, 0);
1355 frame_create_tx(ep, ep->txframe);
1359 static int qe_ep0_txconf(struct qe_ep *ep)
1361 struct qe_bd __iomem *bd;
1362 struct qe_frame *pframe;
1366 bdstatus = in_be32((u32 __iomem *)bd);
1367 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1368 pframe = ep->txframe;
1370 /* clear and recycle the BD */
1371 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1372 out_be32(&bd->buf, 0);
1374 ep->c_txbd = ep->txbase;
1378 if (ep->c_txbd == ep->n_txbd) {
1379 if (bdstatus & DEVICE_T_ERROR) {
1380 frame_set_status(pframe, FRAME_ERROR);
1381 if (bdstatus & T_TO)
1382 pframe->status |= TX_ER_TIMEOUT;
1383 if (bdstatus & T_UN)
1384 pframe->status |= TX_ER_UNDERUN;
1386 ep0_txframe_handle(ep);
1390 bdstatus = in_be32((u32 __iomem *)bd);
1396 static int ep_txframe_handle(struct qe_ep *ep)
1398 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1399 qe_ep_flushtxfifo(ep);
1400 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1401 if (frame_get_info(ep->txframe) & PID_DATA0)
1410 frame_create_tx(ep, ep->txframe); /* send the data */
1414 /* confirm the already trainsmited bd */
1415 static int qe_ep_txconf(struct qe_ep *ep)
1417 struct qe_bd __iomem *bd;
1418 struct qe_frame *pframe = NULL;
1420 unsigned char breakonrxinterrupt = 0;
1423 bdstatus = in_be32((u32 __iomem *)bd);
1424 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1425 pframe = ep->txframe;
1426 if (bdstatus & DEVICE_T_ERROR) {
1427 frame_set_status(pframe, FRAME_ERROR);
1428 if (bdstatus & T_TO)
1429 pframe->status |= TX_ER_TIMEOUT;
1430 if (bdstatus & T_UN)
1431 pframe->status |= TX_ER_UNDERUN;
1434 /* clear and recycle the BD */
1435 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1436 out_be32(&bd->buf, 0);
1438 ep->c_txbd = ep->txbase;
1442 /* handle the tx frame */
1443 ep_txframe_handle(ep);
1445 bdstatus = in_be32((u32 __iomem *)bd);
1447 if (breakonrxinterrupt)
1453 /* Add a request in queue, and try to transmit a packet */
1454 static int ep_req_send(struct qe_ep *ep, struct qe_req *req)
1458 if (ep->tx_req == NULL) {
1461 txcomplete(ep, 0); /* can gain a new tx_req */
1462 reval = frame_create_tx(ep, ep->txframe);
1467 /* Maybe this is a good ideal */
1468 static int ep_req_rx(struct qe_ep *ep, struct qe_req *req)
1470 struct qe_udc *udc = ep->udc;
1471 struct qe_frame *pframe = NULL;
1472 struct qe_bd __iomem *bd;
1473 u32 bdstatus, length;
1479 if (list_empty(&ep->queue)) {
1480 dev_vdbg(udc->dev, "the req already finish!\n");
1483 pframe = ep->rxframe;
1486 bdstatus = in_be32((u32 __iomem *)bd);
1487 length = bdstatus & BD_LENGTH_MASK;
1489 while (!(bdstatus & R_E) && length) {
1492 if ((bdstatus & R_F) && (bdstatus & R_L)
1493 && !(bdstatus & R_ERROR)) {
1494 qe_frame_clean(pframe);
1495 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
1496 frame_set_data(pframe, (u8 *)vaddr);
1497 frame_set_length(pframe, (length - USB_CRC_SIZE));
1498 frame_set_status(pframe, FRAME_OK);
1499 switch (bdstatus & R_PID) {
1501 frame_set_info(pframe, PID_DATA1); break;
1503 frame_set_info(pframe, PID_DATA0); break;
1505 /* handle the rx frame */
1507 if (frame_get_info(pframe) & PID_DATA1)
1512 if (framepid != ep->data01) {
1513 dev_vdbg(udc->dev, "the data01 error!\n");
1515 fsize = frame_get_length(pframe);
1517 cp = (u8 *)(req->req.buf) + req->req.actual;
1519 memcpy(cp, pframe->data, fsize);
1520 req->req.actual += fsize;
1521 if ((fsize < ep->ep.maxpacket)
1522 || (req->req.actual >=
1526 if (list_empty(&ep->queue))
1530 qe_ep_toggledata01(ep);
1533 dev_err(udc->dev, "The receive frame with error!\n");
1536 /* note: don't clear the rxbd's buffer address *
1537 * only Clear the length */
1538 out_be32((u32 __iomem *)bd, (bdstatus & BD_STATUS_MASK));
1547 bdstatus = in_be32((u32 __iomem *)bd);
1548 length = bdstatus & BD_LENGTH_MASK;
1552 ep_recycle_rxbds(ep);
1557 /* only add the request in queue */
1558 static int ep_req_receive(struct qe_ep *ep, struct qe_req *req)
1560 if (ep->state == EP_STATE_NACK) {
1561 if (ep->has_data <= 0) {
1562 /* Enable rx and unmask rx interrupt */
1565 /* Copy the exist BD data */
1573 /********************************************************************
1574 Internal Used Function End
1575 ********************************************************************/
1577 /*-----------------------------------------------------------------------
1578 Endpoint Management Functions For Gadget
1579 -----------------------------------------------------------------------*/
1580 static int qe_ep_enable(struct usb_ep *_ep,
1581 const struct usb_endpoint_descriptor *desc)
1586 unsigned char epnum;
1588 ep = container_of(_ep, struct qe_ep, ep);
1590 /* catch various bogus parameters */
1591 if (!_ep || !desc || _ep->name == ep_name[0] ||
1592 (desc->bDescriptorType != USB_DT_ENDPOINT))
1596 if (!udc->driver || (udc->gadget.speed == USB_SPEED_UNKNOWN))
1599 epnum = (u8)desc->bEndpointAddress & 0xF;
1601 retval = qe_ep_init(udc, epnum, desc);
1603 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1604 dev_dbg(udc->dev, "enable ep%d failed\n", ep->epnum);
1607 dev_dbg(udc->dev, "enable ep%d successful\n", ep->epnum);
1611 static int qe_ep_disable(struct usb_ep *_ep)
1615 unsigned long flags;
1618 ep = container_of(_ep, struct qe_ep, ep);
1621 if (!_ep || !ep->ep.desc) {
1622 dev_dbg(udc->dev, "%s not enabled\n", _ep ? ep->ep.name : NULL);
1626 spin_lock_irqsave(&udc->lock, flags);
1627 /* Nuke all pending requests (does flush) */
1628 nuke(ep, -ESHUTDOWN);
1632 qe_ep_reset(udc, ep->epnum);
1633 spin_unlock_irqrestore(&udc->lock, flags);
1635 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1637 if (ep->dir == USB_DIR_OUT)
1638 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1639 (USB_BDRING_LEN_RX + 1);
1641 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1642 (USB_BDRING_LEN + 1);
1644 if (ep->dir != USB_DIR_IN) {
1647 dma_unmap_single(udc->gadget.dev.parent,
1650 ep->rxbuf_d = DMA_ADDR_INVALID;
1652 dma_sync_single_for_cpu(
1653 udc->gadget.dev.parent,
1657 kfree(ep->rxbuffer);
1660 if (ep->dir != USB_DIR_OUT)
1663 dev_dbg(udc->dev, "disabled %s OK\n", _ep->name);
1667 static struct usb_request *qe_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1671 req = kzalloc(sizeof(*req), gfp_flags);
1675 req->req.dma = DMA_ADDR_INVALID;
1677 INIT_LIST_HEAD(&req->queue);
1682 static void qe_free_request(struct usb_ep *_ep, struct usb_request *_req)
1686 req = container_of(_req, struct qe_req, req);
1692 static int __qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req)
1694 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1695 struct qe_req *req = container_of(_req, struct qe_req, req);
1700 /* catch various bogus parameters */
1701 if (!_req || !req->req.complete || !req->req.buf
1702 || !list_empty(&req->queue)) {
1703 dev_dbg(udc->dev, "bad params\n");
1706 if (!_ep || (!ep->ep.desc && ep_index(ep))) {
1707 dev_dbg(udc->dev, "bad ep\n");
1711 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
1716 /* map virtual address to hardware */
1717 if (req->req.dma == DMA_ADDR_INVALID) {
1718 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1726 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
1727 req->req.dma, req->req.length,
1734 req->req.status = -EINPROGRESS;
1735 req->req.actual = 0;
1737 list_add_tail(&req->queue, &ep->queue);
1738 dev_vdbg(udc->dev, "gadget have request in %s! %d\n",
1739 ep->name, req->req.length);
1741 /* push the request to device */
1743 reval = ep_req_send(ep, req);
1746 if (ep_index(ep) == 0 && req->req.length > 0) {
1748 udc->ep0_state = DATA_STATE_XMIT;
1750 udc->ep0_state = DATA_STATE_RECV;
1753 if (ep->dir == USB_DIR_OUT)
1754 reval = ep_req_receive(ep, req);
1759 /* queues (submits) an I/O request to an endpoint */
1760 static int qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1763 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1764 struct qe_udc *udc = ep->udc;
1765 unsigned long flags;
1768 spin_lock_irqsave(&udc->lock, flags);
1769 ret = __qe_ep_queue(_ep, _req);
1770 spin_unlock_irqrestore(&udc->lock, flags);
1774 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
1775 static int qe_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1777 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1779 unsigned long flags;
1784 spin_lock_irqsave(&ep->udc->lock, flags);
1786 /* make sure it's actually queued on this endpoint */
1787 list_for_each_entry(req, &ep->queue, queue) {
1788 if (&req->req == _req)
1792 if (&req->req != _req) {
1793 spin_unlock_irqrestore(&ep->udc->lock, flags);
1797 done(ep, req, -ECONNRESET);
1799 spin_unlock_irqrestore(&ep->udc->lock, flags);
1803 /*-----------------------------------------------------------------
1804 * modify the endpoint halt feature
1805 * @ep: the non-isochronous endpoint being stalled
1806 * @value: 1--set halt 0--clear halt
1807 * Returns zero, or a negative error code.
1808 *----------------------------------------------------------------*/
1809 static int qe_ep_set_halt(struct usb_ep *_ep, int value)
1812 unsigned long flags;
1813 int status = -EOPNOTSUPP;
1816 ep = container_of(_ep, struct qe_ep, ep);
1817 if (!_ep || !ep->ep.desc) {
1823 /* Attempt to halt IN ep will fail if any transfer requests
1824 * are still queue */
1825 if (value && ep_is_in(ep) && !list_empty(&ep->queue)) {
1831 spin_lock_irqsave(&ep->udc->lock, flags);
1832 qe_eptx_stall_change(ep, value);
1833 qe_eprx_stall_change(ep, value);
1834 spin_unlock_irqrestore(&ep->udc->lock, flags);
1836 if (ep->epnum == 0) {
1837 udc->ep0_state = WAIT_FOR_SETUP;
1841 /* set data toggle to DATA0 on clear halt */
1845 dev_vdbg(udc->dev, "%s %s halt stat %d\n", ep->ep.name,
1846 value ? "set" : "clear", status);
1851 static const struct usb_ep_ops qe_ep_ops = {
1852 .enable = qe_ep_enable,
1853 .disable = qe_ep_disable,
1855 .alloc_request = qe_alloc_request,
1856 .free_request = qe_free_request,
1858 .queue = qe_ep_queue,
1859 .dequeue = qe_ep_dequeue,
1861 .set_halt = qe_ep_set_halt,
1864 /*------------------------------------------------------------------------
1865 Gadget Driver Layer Operations
1866 ------------------------------------------------------------------------*/
1868 /* Get the current frame number */
1869 static int qe_get_frame(struct usb_gadget *gadget)
1871 struct qe_udc *udc = container_of(gadget, struct qe_udc, gadget);
1874 tmp = in_be16(&udc->usb_param->frame_n);
1876 return tmp & 0x07ff;
1880 static int fsl_qe_start(struct usb_gadget *gadget,
1881 struct usb_gadget_driver *driver);
1882 static int fsl_qe_stop(struct usb_gadget *gadget);
1884 /* defined in usb_gadget.h */
1885 static const struct usb_gadget_ops qe_gadget_ops = {
1886 .get_frame = qe_get_frame,
1887 .udc_start = fsl_qe_start,
1888 .udc_stop = fsl_qe_stop,
1891 /*-------------------------------------------------------------------------
1892 USB ep0 Setup process in BUS Enumeration
1893 -------------------------------------------------------------------------*/
1894 static int udc_reset_ep_queue(struct qe_udc *udc, u8 pipe)
1896 struct qe_ep *ep = &udc->eps[pipe];
1898 nuke(ep, -ECONNRESET);
1903 static int reset_queues(struct qe_udc *udc)
1907 for (pipe = 0; pipe < USB_MAX_ENDPOINTS; pipe++)
1908 udc_reset_ep_queue(udc, pipe);
1910 /* report disconnect; the driver is already quiesced */
1911 spin_unlock(&udc->lock);
1912 usb_gadget_udc_reset(&udc->gadget, udc->driver);
1913 spin_lock(&udc->lock);
1918 static void ch9setaddress(struct qe_udc *udc, u16 value, u16 index,
1921 /* Save the new address to device struct */
1922 udc->device_address = (u8) value;
1923 /* Update usb state */
1924 udc->usb_state = USB_STATE_ADDRESS;
1926 /* Status phase , send a ZLP */
1927 if (ep0_prime_status(udc, USB_DIR_IN))
1931 static void ownercomplete(struct usb_ep *_ep, struct usb_request *_req)
1933 struct qe_req *req = container_of(_req, struct qe_req, req);
1935 req->req.buf = NULL;
1939 static void ch9getstatus(struct qe_udc *udc, u8 request_type, u16 value,
1940 u16 index, u16 length)
1948 if ((request_type & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1949 /* Get device status */
1950 usb_status = 1 << USB_DEVICE_SELF_POWERED;
1951 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_INTERFACE) {
1952 /* Get interface status */
1953 /* We don't have interface information in udc driver */
1955 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_ENDPOINT) {
1956 /* Get endpoint status */
1957 int pipe = index & USB_ENDPOINT_NUMBER_MASK;
1958 struct qe_ep *target_ep = &udc->eps[pipe];
1961 /* stall if endpoint doesn't exist */
1962 if (!target_ep->ep.desc)
1965 usep = in_be16(&udc->usb_regs->usb_usep[pipe]);
1966 if (index & USB_DIR_IN) {
1967 if (target_ep->dir != USB_DIR_IN)
1969 if ((usep & USB_THS_MASK) == USB_THS_STALL)
1970 usb_status = 1 << USB_ENDPOINT_HALT;
1972 if (target_ep->dir != USB_DIR_OUT)
1974 if ((usep & USB_RHS_MASK) == USB_RHS_STALL)
1975 usb_status = 1 << USB_ENDPOINT_HALT;
1979 req = container_of(qe_alloc_request(&ep->ep, GFP_KERNEL),
1980 struct qe_req, req);
1981 req->req.length = 2;
1982 req->req.buf = udc->statusbuf;
1983 *(u16 *)req->req.buf = cpu_to_le16(usb_status);
1984 req->req.status = -EINPROGRESS;
1985 req->req.actual = 0;
1986 req->req.complete = ownercomplete;
1988 udc->ep0_dir = USB_DIR_IN;
1991 status = __qe_ep_queue(&ep->ep, &req->req);
1996 dev_err(udc->dev, "Can't respond to getstatus request \n");
2000 /* only handle the setup request, suppose the device in normal status */
2001 static void setup_received_handle(struct qe_udc *udc,
2002 struct usb_ctrlrequest *setup)
2004 /* Fix Endian (udc->local_setup_buff is cpu Endian now)*/
2005 u16 wValue = le16_to_cpu(setup->wValue);
2006 u16 wIndex = le16_to_cpu(setup->wIndex);
2007 u16 wLength = le16_to_cpu(setup->wLength);
2009 /* clear the previous request in the ep0 */
2010 udc_reset_ep_queue(udc, 0);
2012 if (setup->bRequestType & USB_DIR_IN)
2013 udc->ep0_dir = USB_DIR_IN;
2015 udc->ep0_dir = USB_DIR_OUT;
2017 switch (setup->bRequest) {
2018 case USB_REQ_GET_STATUS:
2019 /* Data+Status phase form udc */
2020 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
2021 != (USB_DIR_IN | USB_TYPE_STANDARD))
2023 ch9getstatus(udc, setup->bRequestType, wValue, wIndex,
2027 case USB_REQ_SET_ADDRESS:
2028 /* Status phase from udc */
2029 if (setup->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
2032 ch9setaddress(udc, wValue, wIndex, wLength);
2035 case USB_REQ_CLEAR_FEATURE:
2036 case USB_REQ_SET_FEATURE:
2037 /* Requests with no data phase, status phase from udc */
2038 if ((setup->bRequestType & USB_TYPE_MASK)
2039 != USB_TYPE_STANDARD)
2042 if ((setup->bRequestType & USB_RECIP_MASK)
2043 == USB_RECIP_ENDPOINT) {
2044 int pipe = wIndex & USB_ENDPOINT_NUMBER_MASK;
2047 if (wValue != 0 || wLength != 0
2048 || pipe >= USB_MAX_ENDPOINTS)
2050 ep = &udc->eps[pipe];
2052 spin_unlock(&udc->lock);
2053 qe_ep_set_halt(&ep->ep,
2054 (setup->bRequest == USB_REQ_SET_FEATURE)
2056 spin_lock(&udc->lock);
2059 ep0_prime_status(udc, USB_DIR_IN);
2068 /* Data phase from gadget, status phase from udc */
2069 if (setup->bRequestType & USB_DIR_IN) {
2070 udc->ep0_state = DATA_STATE_XMIT;
2071 udc->ep0_dir = USB_DIR_IN;
2073 udc->ep0_state = DATA_STATE_RECV;
2074 udc->ep0_dir = USB_DIR_OUT;
2076 spin_unlock(&udc->lock);
2077 if (udc->driver->setup(&udc->gadget,
2078 &udc->local_setup_buff) < 0)
2080 spin_lock(&udc->lock);
2082 /* No data phase, IN status from gadget */
2083 udc->ep0_dir = USB_DIR_IN;
2084 spin_unlock(&udc->lock);
2085 if (udc->driver->setup(&udc->gadget,
2086 &udc->local_setup_buff) < 0)
2088 spin_lock(&udc->lock);
2089 udc->ep0_state = DATA_STATE_NEED_ZLP;
2093 /*-------------------------------------------------------------------------
2094 USB Interrupt handlers
2095 -------------------------------------------------------------------------*/
2096 static void suspend_irq(struct qe_udc *udc)
2098 udc->resume_state = udc->usb_state;
2099 udc->usb_state = USB_STATE_SUSPENDED;
2101 /* report suspend to the driver ,serial.c not support this*/
2102 if (udc->driver->suspend)
2103 udc->driver->suspend(&udc->gadget);
2106 static void resume_irq(struct qe_udc *udc)
2108 udc->usb_state = udc->resume_state;
2109 udc->resume_state = 0;
2111 /* report resume to the driver , serial.c not support this*/
2112 if (udc->driver->resume)
2113 udc->driver->resume(&udc->gadget);
2116 static void idle_irq(struct qe_udc *udc)
2120 usbs = in_8(&udc->usb_regs->usb_usbs);
2121 if (usbs & USB_IDLE_STATUS_MASK) {
2122 if ((udc->usb_state) != USB_STATE_SUSPENDED)
2125 if (udc->usb_state == USB_STATE_SUSPENDED)
2130 static int reset_irq(struct qe_udc *udc)
2134 if (udc->usb_state == USB_STATE_DEFAULT)
2137 qe_usb_disable(udc);
2138 out_8(&udc->usb_regs->usb_usadr, 0);
2140 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2141 if (udc->eps[i].init)
2142 qe_ep_reset(udc, i);
2146 udc->usb_state = USB_STATE_DEFAULT;
2147 udc->ep0_state = WAIT_FOR_SETUP;
2148 udc->ep0_dir = USB_DIR_OUT;
2153 static int bsy_irq(struct qe_udc *udc)
2158 static int txe_irq(struct qe_udc *udc)
2163 /* ep0 tx interrupt also in here */
2164 static int tx_irq(struct qe_udc *udc)
2167 struct qe_bd __iomem *bd;
2170 if ((udc->usb_state == USB_STATE_ADDRESS)
2171 && (in_8(&udc->usb_regs->usb_usadr) == 0))
2172 out_8(&udc->usb_regs->usb_usadr, udc->device_address);
2174 for (i = (USB_MAX_ENDPOINTS-1); ((i >= 0) && (res == 0)); i--) {
2176 if (ep && ep->init && (ep->dir != USB_DIR_OUT)) {
2178 if (!(in_be32((u32 __iomem *)bd) & T_R)
2179 && (in_be32(&bd->buf))) {
2180 /* confirm the transmitted bd */
2182 res = qe_ep0_txconf(ep);
2184 res = qe_ep_txconf(ep);
2192 /* setup packect's rx is handle in the function too */
2193 static void rx_irq(struct qe_udc *udc)
2196 struct qe_bd __iomem *bd;
2199 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2201 if (ep && ep->init && (ep->dir != USB_DIR_IN)) {
2203 if (!(in_be32((u32 __iomem *)bd) & R_E)
2204 && (in_be32(&bd->buf))) {
2205 if (ep->epnum == 0) {
2208 /*non-setup package receive*/
2216 static irqreturn_t qe_udc_irq(int irq, void *_udc)
2218 struct qe_udc *udc = (struct qe_udc *)_udc;
2220 irqreturn_t status = IRQ_NONE;
2221 unsigned long flags;
2223 spin_lock_irqsave(&udc->lock, flags);
2225 irq_src = in_be16(&udc->usb_regs->usb_usber) &
2226 in_be16(&udc->usb_regs->usb_usbmr);
2227 /* Clear notification bits */
2228 out_be16(&udc->usb_regs->usb_usber, irq_src);
2230 if (irq_src & USB_E_IDLE_MASK) {
2232 irq_src &= ~USB_E_IDLE_MASK;
2233 status = IRQ_HANDLED;
2236 if (irq_src & USB_E_TXB_MASK) {
2238 irq_src &= ~USB_E_TXB_MASK;
2239 status = IRQ_HANDLED;
2242 if (irq_src & USB_E_RXB_MASK) {
2244 irq_src &= ~USB_E_RXB_MASK;
2245 status = IRQ_HANDLED;
2248 if (irq_src & USB_E_RESET_MASK) {
2250 irq_src &= ~USB_E_RESET_MASK;
2251 status = IRQ_HANDLED;
2254 if (irq_src & USB_E_BSY_MASK) {
2256 irq_src &= ~USB_E_BSY_MASK;
2257 status = IRQ_HANDLED;
2260 if (irq_src & USB_E_TXE_MASK) {
2262 irq_src &= ~USB_E_TXE_MASK;
2263 status = IRQ_HANDLED;
2266 spin_unlock_irqrestore(&udc->lock, flags);
2271 /*-------------------------------------------------------------------------
2272 Gadget driver probe and unregister.
2273 --------------------------------------------------------------------------*/
2274 static int fsl_qe_start(struct usb_gadget *gadget,
2275 struct usb_gadget_driver *driver)
2278 unsigned long flags;
2280 udc = container_of(gadget, struct qe_udc, gadget);
2281 /* lock is needed but whether should use this lock or another */
2282 spin_lock_irqsave(&udc->lock, flags);
2284 driver->driver.bus = NULL;
2285 /* hook up the driver */
2286 udc->driver = driver;
2287 udc->gadget.speed = driver->max_speed;
2289 /* Enable IRQ reg and Set usbcmd reg EN bit */
2292 out_be16(&udc->usb_regs->usb_usber, 0xffff);
2293 out_be16(&udc->usb_regs->usb_usbmr, USB_E_DEFAULT_DEVICE);
2294 udc->usb_state = USB_STATE_ATTACHED;
2295 udc->ep0_state = WAIT_FOR_SETUP;
2296 udc->ep0_dir = USB_DIR_OUT;
2297 spin_unlock_irqrestore(&udc->lock, flags);
2302 static int fsl_qe_stop(struct usb_gadget *gadget)
2305 struct qe_ep *loop_ep;
2306 unsigned long flags;
2308 udc = container_of(gadget, struct qe_udc, gadget);
2309 /* stop usb controller, disable intr */
2310 qe_usb_disable(udc);
2312 /* in fact, no needed */
2313 udc->usb_state = USB_STATE_ATTACHED;
2314 udc->ep0_state = WAIT_FOR_SETUP;
2317 /* stand operation */
2318 spin_lock_irqsave(&udc->lock, flags);
2319 udc->gadget.speed = USB_SPEED_UNKNOWN;
2320 nuke(&udc->eps[0], -ESHUTDOWN);
2321 list_for_each_entry(loop_ep, &udc->gadget.ep_list, ep.ep_list)
2322 nuke(loop_ep, -ESHUTDOWN);
2323 spin_unlock_irqrestore(&udc->lock, flags);
2330 /* udc structure's alloc and setup, include ep-param alloc */
2331 static struct qe_udc *qe_udc_config(struct platform_device *ofdev)
2334 struct device_node *np = ofdev->dev.of_node;
2335 unsigned long tmp_addr = 0;
2336 struct usb_device_para __iomem *usbpram;
2341 udc = kzalloc(sizeof(*udc), GFP_KERNEL);
2345 udc->dev = &ofdev->dev;
2347 /* get default address of usb parameter in MURAM from device tree */
2348 offset = *of_get_address(np, 1, &size, NULL);
2349 udc->usb_param = cpm_muram_addr(offset);
2350 memset_io(udc->usb_param, 0, size);
2352 usbpram = udc->usb_param;
2353 out_be16(&usbpram->frame_n, 0);
2354 out_be32(&usbpram->rstate, 0);
2356 tmp_addr = cpm_muram_alloc((USB_MAX_ENDPOINTS *
2357 sizeof(struct usb_ep_para)),
2358 USB_EP_PARA_ALIGNMENT);
2359 if (IS_ERR_VALUE(tmp_addr))
2362 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2363 out_be16(&usbpram->epptr[i], (u16)tmp_addr);
2364 udc->ep_param[i] = cpm_muram_addr(tmp_addr);
2368 memset_io(udc->ep_param[0], 0,
2369 USB_MAX_ENDPOINTS * sizeof(struct usb_ep_para));
2371 udc->resume_state = USB_STATE_NOTATTACHED;
2372 udc->usb_state = USB_STATE_POWERED;
2375 spin_lock_init(&udc->lock);
2383 /* USB Controller register init */
2384 static int qe_udc_reg_init(struct qe_udc *udc)
2386 struct usb_ctlr __iomem *qe_usbregs;
2387 qe_usbregs = udc->usb_regs;
2389 /* Spec says that we must enable the USB controller to change mode. */
2390 out_8(&qe_usbregs->usb_usmod, 0x01);
2391 /* Mode changed, now disable it, since muram isn't initialized yet. */
2392 out_8(&qe_usbregs->usb_usmod, 0x00);
2394 /* Initialize the rest. */
2395 out_be16(&qe_usbregs->usb_usbmr, 0);
2396 out_8(&qe_usbregs->usb_uscom, 0);
2397 out_be16(&qe_usbregs->usb_usber, USBER_ALL_CLEAR);
2402 static int qe_ep_config(struct qe_udc *udc, unsigned char pipe_num)
2404 struct qe_ep *ep = &udc->eps[pipe_num];
2407 strcpy(ep->name, ep_name[pipe_num]);
2408 ep->ep.name = ep_name[pipe_num];
2410 if (pipe_num == 0) {
2411 ep->ep.caps.type_control = true;
2413 ep->ep.caps.type_iso = true;
2414 ep->ep.caps.type_bulk = true;
2415 ep->ep.caps.type_int = true;
2418 ep->ep.caps.dir_in = true;
2419 ep->ep.caps.dir_out = true;
2421 ep->ep.ops = &qe_ep_ops;
2423 usb_ep_set_maxpacket_limit(&ep->ep, (unsigned short) ~0);
2426 ep->epnum = (u8)pipe_num;
2433 ep->state = EP_STATE_IDLE;
2436 /* the queue lists any req for this ep */
2437 INIT_LIST_HEAD(&ep->queue);
2439 /* gagdet.ep_list used for ep_autoconfig so no ep0*/
2441 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
2443 ep->gadget = &udc->gadget;
2448 /*-----------------------------------------------------------------------
2449 * UDC device Driver operation functions *
2450 *----------------------------------------------------------------------*/
2451 static void qe_udc_release(struct device *dev)
2453 struct qe_udc *udc = container_of(dev, struct qe_udc, gadget.dev);
2456 complete(udc->done);
2457 cpm_muram_free(cpm_muram_offset(udc->ep_param[0]));
2458 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
2459 udc->ep_param[i] = NULL;
2464 /* Driver probe functions */
2465 static const struct of_device_id qe_udc_match[];
2466 static int qe_udc_probe(struct platform_device *ofdev)
2469 const struct of_device_id *match;
2470 struct device_node *np = ofdev->dev.of_node;
2472 unsigned int ret = 0;
2476 match = of_match_device(qe_udc_match, &ofdev->dev);
2480 prop = of_get_property(np, "mode", NULL);
2481 if (!prop || strcmp(prop, "peripheral"))
2484 /* Initialize the udc structure including QH member and other member */
2485 udc = qe_udc_config(ofdev);
2487 dev_err(&ofdev->dev, "failed to initialize\n");
2491 udc->soc_type = (unsigned long)match->data;
2492 udc->usb_regs = of_iomap(np, 0);
2493 if (!udc->usb_regs) {
2498 /* initialize usb hw reg except for regs for EP,
2499 * leave usbintr reg untouched*/
2500 qe_udc_reg_init(udc);
2502 /* here comes the stand operations for probe
2503 * set the qe_udc->gadget.xxx */
2504 udc->gadget.ops = &qe_gadget_ops;
2506 /* gadget.ep0 is a pointer */
2507 udc->gadget.ep0 = &udc->eps[0].ep;
2509 INIT_LIST_HEAD(&udc->gadget.ep_list);
2511 /* modify in register gadget process */
2512 udc->gadget.speed = USB_SPEED_UNKNOWN;
2514 /* name: Identifies the controller hardware type. */
2515 udc->gadget.name = driver_name;
2516 udc->gadget.dev.parent = &ofdev->dev;
2518 /* initialize qe_ep struct */
2519 for (i = 0; i < USB_MAX_ENDPOINTS ; i++) {
2520 /* because the ep type isn't decide here so
2521 * qe_ep_init() should be called in ep_enable() */
2523 /* setup the qe_ep struct and link ep.ep.list
2524 * into gadget.ep_list */
2525 qe_ep_config(udc, (unsigned char)i);
2528 /* ep0 initialization in here */
2529 ret = qe_ep_init(udc, 0, &qe_ep0_desc);
2533 /* create a buf for ZLP send, need to remain zeroed */
2534 udc->nullbuf = devm_kzalloc(&ofdev->dev, 256, GFP_KERNEL);
2535 if (udc->nullbuf == NULL) {
2540 /* buffer for data of get_status request */
2541 udc->statusbuf = devm_kzalloc(&ofdev->dev, 2, GFP_KERNEL);
2542 if (udc->statusbuf == NULL) {
2547 udc->nullp = virt_to_phys((void *)udc->nullbuf);
2548 if (udc->nullp == DMA_ADDR_INVALID) {
2549 udc->nullp = dma_map_single(
2550 udc->gadget.dev.parent,
2556 dma_sync_single_for_device(udc->gadget.dev.parent,
2561 tasklet_setup(&udc->rx_tasklet, ep_rx_tasklet);
2562 /* request irq and disable DR */
2563 udc->usb_irq = irq_of_parse_and_map(np, 0);
2564 if (!udc->usb_irq) {
2569 ret = request_irq(udc->usb_irq, qe_udc_irq, 0,
2572 dev_err(udc->dev, "cannot request irq %d err %d\n",
2577 ret = usb_add_gadget_udc_release(&ofdev->dev, &udc->gadget,
2582 platform_set_drvdata(ofdev, udc);
2584 "%s USB controller initialized as device\n",
2585 (udc->soc_type == PORT_QE) ? "QE" : "CPM");
2589 free_irq(udc->usb_irq, udc);
2591 irq_dispose_mapping(udc->usb_irq);
2594 dma_unmap_single(udc->gadget.dev.parent,
2597 udc->nullp = DMA_ADDR_INVALID;
2599 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2605 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2607 kfree(ep->rxbuffer);
2610 iounmap(udc->usb_regs);
2617 static int qe_udc_suspend(struct platform_device *dev, pm_message_t state)
2622 static int qe_udc_resume(struct platform_device *dev)
2628 static int qe_udc_remove(struct platform_device *ofdev)
2630 struct qe_udc *udc = platform_get_drvdata(ofdev);
2633 DECLARE_COMPLETION_ONSTACK(done);
2635 usb_del_gadget_udc(&udc->gadget);
2638 tasklet_disable(&udc->rx_tasklet);
2641 dma_unmap_single(udc->gadget.dev.parent,
2644 udc->nullp = DMA_ADDR_INVALID;
2646 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2652 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2653 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (USB_BDRING_LEN + 1);
2657 dma_unmap_single(udc->gadget.dev.parent,
2660 ep->rxbuf_d = DMA_ADDR_INVALID;
2662 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2667 kfree(ep->rxbuffer);
2670 free_irq(udc->usb_irq, udc);
2671 irq_dispose_mapping(udc->usb_irq);
2673 tasklet_kill(&udc->rx_tasklet);
2675 iounmap(udc->usb_regs);
2677 /* wait for release() of gadget.dev to free udc */
2678 wait_for_completion(&done);
2683 /*-------------------------------------------------------------------------*/
2684 static const struct of_device_id qe_udc_match[] = {
2686 .compatible = "fsl,mpc8323-qe-usb",
2687 .data = (void *)PORT_QE,
2690 .compatible = "fsl,mpc8360-qe-usb",
2691 .data = (void *)PORT_QE,
2694 .compatible = "fsl,mpc8272-cpm-usb",
2695 .data = (void *)PORT_CPM,
2700 MODULE_DEVICE_TABLE(of, qe_udc_match);
2702 static struct platform_driver udc_driver = {
2704 .name = driver_name,
2705 .of_match_table = qe_udc_match,
2707 .probe = qe_udc_probe,
2708 .remove = qe_udc_remove,
2710 .suspend = qe_udc_suspend,
2711 .resume = qe_udc_resume,
2715 module_platform_driver(udc_driver);
2717 MODULE_DESCRIPTION(DRIVER_DESC);
2718 MODULE_AUTHOR(DRIVER_AUTHOR);
2719 MODULE_LICENSE("GPL");