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.
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) {
594 case USB_ENDPOINT_XFER_CONTROL:
595 if (strstr(ep->ep.name, "-iso")
596 || strstr(ep->ep.name, "-int"))
598 switch (udc->gadget.speed) {
634 spin_lock_irqsave(&udc->lock, flags);
636 /* initialize ep structure */
637 ep->ep.maxpacket = max;
638 ep->tm = (u8)(desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
644 ep->dir = USB_DIR_BOTH;
645 udc->ep0_dir = USB_DIR_OUT;
646 udc->ep0_state = WAIT_FOR_SETUP;
648 switch (desc->bEndpointAddress & USB_ENDPOINT_DIR_MASK) {
650 ep->dir = USB_DIR_OUT;
653 ep->dir = USB_DIR_IN;
659 /* hardware special operation */
660 qe_ep_bd_init(udc, pipe_num);
661 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_OUT)) {
662 reval = qe_ep_rxbd_update(ep);
667 if ((ep->tm == USBP_TM_CTL) || (ep->dir == USB_DIR_IN)) {
668 ep->txframe = kmalloc(sizeof(*ep->txframe), GFP_ATOMIC);
671 qe_frame_init(ep->txframe);
674 qe_ep_register_init(udc, pipe_num);
676 /* Now HW will be NAKing transfers to that EP,
677 * until a buffer is queued to it. */
678 spin_unlock_irqrestore(&udc->lock, flags);
685 spin_unlock_irqrestore(&udc->lock, flags);
687 dev_err(udc->dev, "failed to initialize %s\n", ep->ep.name);
691 static inline void qe_usb_enable(struct qe_udc *udc)
693 setbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
696 static inline void qe_usb_disable(struct qe_udc *udc)
698 clrbits8(&udc->usb_regs->usb_usmod, USB_MODE_EN);
701 /*----------------------------------------------------------------------------*
702 * USB and EP basic manipulate function end *
703 *----------------------------------------------------------------------------*/
706 /******************************************************************************
707 UDC transmit and receive process
708 ******************************************************************************/
709 static void recycle_one_rxbd(struct qe_ep *ep)
713 bdstatus = in_be32((u32 __iomem *)ep->e_rxbd);
714 bdstatus = R_I | R_E | (bdstatus & R_W);
715 out_be32((u32 __iomem *)ep->e_rxbd, bdstatus);
718 ep->e_rxbd = ep->rxbase;
723 static void recycle_rxbds(struct qe_ep *ep, unsigned char stopatnext)
726 struct qe_bd __iomem *bd, *nextbd;
727 unsigned char stop = 0;
731 bdstatus = in_be32((u32 __iomem *)bd);
733 while (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK) && !stop) {
734 bdstatus = R_E | R_I | (bdstatus & R_W);
735 out_be32((u32 __iomem *)bd, bdstatus);
742 bdstatus = in_be32((u32 __iomem *)bd);
743 if (stopatnext && (bd == nextbd))
750 static void ep_recycle_rxbds(struct qe_ep *ep)
752 struct qe_bd __iomem *bd = ep->n_rxbd;
754 u8 epnum = ep->epnum;
755 struct qe_udc *udc = ep->udc;
757 bdstatus = in_be32((u32 __iomem *)bd);
758 if (!(bdstatus & R_E) && !(bdstatus & BD_LENGTH_MASK)) {
760 ((in_be16(&udc->ep_param[epnum]->rbptr) -
761 in_be16(&udc->ep_param[epnum]->rbase))
763 bdstatus = in_be32((u32 __iomem *)bd);
771 recycle_rxbds(ep, 0);
772 ep->e_rxbd = ep->n_rxbd;
774 recycle_rxbds(ep, 1);
776 if (in_be16(&udc->usb_regs->usb_usber) & USB_E_BSY_MASK)
777 out_be16(&udc->usb_regs->usb_usber, USB_E_BSY_MASK);
779 if (ep->has_data <= 0 && (!list_empty(&ep->queue)))
785 static void setup_received_handle(struct qe_udc *udc,
786 struct usb_ctrlrequest *setup);
787 static int qe_ep_rxframe_handle(struct qe_ep *ep);
788 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req);
789 /* when BD PID is setup, handle the packet */
790 static int ep0_setup_handle(struct qe_udc *udc)
792 struct qe_ep *ep = &udc->eps[0];
793 struct qe_frame *pframe;
797 pframe = ep->rxframe;
798 if ((frame_get_info(pframe) & PID_SETUP)
799 && (udc->ep0_state == WAIT_FOR_SETUP)) {
800 fsize = frame_get_length(pframe);
801 if (unlikely(fsize != 8))
803 cp = (u8 *)&udc->local_setup_buff;
804 memcpy(cp, pframe->data, fsize);
807 /* handle the usb command base on the usb_ctrlrequest */
808 setup_received_handle(udc, &udc->local_setup_buff);
814 static int qe_ep0_rx(struct qe_udc *udc)
816 struct qe_ep *ep = &udc->eps[0];
817 struct qe_frame *pframe;
818 struct qe_bd __iomem *bd;
819 u32 bdstatus, length;
822 pframe = ep->rxframe;
824 if (ep->dir == USB_DIR_IN) {
825 dev_err(udc->dev, "ep0 not a control endpoint\n");
830 bdstatus = in_be32((u32 __iomem *)bd);
831 length = bdstatus & BD_LENGTH_MASK;
833 while (!(bdstatus & R_E) && length) {
834 if ((bdstatus & R_F) && (bdstatus & R_L)
835 && !(bdstatus & R_ERROR)) {
836 if (length == USB_CRC_SIZE) {
837 udc->ep0_state = WAIT_FOR_SETUP;
839 "receive a ZLP in status phase\n");
841 qe_frame_clean(pframe);
842 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
843 frame_set_data(pframe, (u8 *)vaddr);
844 frame_set_length(pframe,
845 (length - USB_CRC_SIZE));
846 frame_set_status(pframe, FRAME_OK);
847 switch (bdstatus & R_PID) {
849 frame_set_info(pframe, PID_SETUP);
852 frame_set_info(pframe, PID_DATA1);
855 frame_set_info(pframe, PID_DATA0);
859 if ((bdstatus & R_PID) == R_PID_SETUP)
860 ep0_setup_handle(udc);
862 qe_ep_rxframe_handle(ep);
865 dev_err(udc->dev, "The receive frame with error!\n");
868 /* note: don't clear the rxbd's buffer address */
869 recycle_one_rxbd(ep);
877 bdstatus = in_be32((u32 __iomem *)bd);
878 length = bdstatus & BD_LENGTH_MASK;
887 static int qe_ep_rxframe_handle(struct qe_ep *ep)
889 struct qe_frame *pframe;
895 pframe = ep->rxframe;
897 if (frame_get_info(pframe) & PID_DATA1)
900 if (framepid != ep->data01) {
901 dev_err(ep->udc->dev, "the data01 error!\n");
905 fsize = frame_get_length(pframe);
906 if (list_empty(&ep->queue)) {
907 dev_err(ep->udc->dev, "the %s have no requeue!\n", ep->name);
909 req = list_entry(ep->queue.next, struct qe_req, queue);
911 cp = (u8 *)(req->req.buf) + req->req.actual;
913 memcpy(cp, pframe->data, fsize);
914 req->req.actual += fsize;
915 if ((fsize < ep->ep.maxpacket) ||
916 (req->req.actual >= req->req.length)) {
918 ep0_req_complete(ep->udc, req);
921 if (list_empty(&ep->queue) && ep->epnum != 0)
927 qe_ep_toggledata01(ep);
932 static void ep_rx_tasklet(struct tasklet_struct *t)
934 struct qe_udc *udc = from_tasklet(udc, t, rx_tasklet);
936 struct qe_frame *pframe;
937 struct qe_bd __iomem *bd;
939 u32 bdstatus, length;
942 spin_lock_irqsave(&udc->lock, flags);
944 for (i = 1; i < USB_MAX_ENDPOINTS; i++) {
947 if (ep->dir == USB_DIR_IN || ep->enable_tasklet == 0) {
949 "This is a transmit ep or disable tasklet!\n");
953 pframe = ep->rxframe;
955 bdstatus = in_be32((u32 __iomem *)bd);
956 length = bdstatus & BD_LENGTH_MASK;
958 while (!(bdstatus & R_E) && length) {
959 if (list_empty(&ep->queue)) {
962 "The rxep have noreq %d\n",
967 if ((bdstatus & R_F) && (bdstatus & R_L)
968 && !(bdstatus & R_ERROR)) {
969 qe_frame_clean(pframe);
970 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
971 frame_set_data(pframe, (u8 *)vaddr);
972 frame_set_length(pframe,
973 (length - USB_CRC_SIZE));
974 frame_set_status(pframe, FRAME_OK);
975 switch (bdstatus & R_PID) {
977 frame_set_info(pframe, PID_DATA1);
980 frame_set_info(pframe, PID_SETUP);
983 frame_set_info(pframe, PID_DATA0);
986 /* handle the rx frame */
987 qe_ep_rxframe_handle(ep);
990 "error in received frame\n");
992 /* note: don't clear the rxbd's buffer address */
993 /*clear the length */
994 out_be32((u32 __iomem *)bd, bdstatus & BD_STATUS_MASK);
996 if (!(ep->localnack))
997 recycle_one_rxbd(ep);
1005 bdstatus = in_be32((u32 __iomem *)bd);
1006 length = bdstatus & BD_LENGTH_MASK;
1012 ep_recycle_rxbds(ep);
1014 ep->enable_tasklet = 0;
1017 spin_unlock_irqrestore(&udc->lock, flags);
1020 static int qe_ep_rx(struct qe_ep *ep)
1023 struct qe_frame *pframe;
1024 struct qe_bd __iomem *bd;
1025 u16 swoffs, ucoffs, emptybds;
1028 pframe = ep->rxframe;
1030 if (ep->dir == USB_DIR_IN) {
1031 dev_err(udc->dev, "transmit ep in rx function\n");
1037 swoffs = (u16)(bd - ep->rxbase);
1038 ucoffs = (u16)((in_be16(&udc->ep_param[ep->epnum]->rbptr) -
1039 in_be16(&udc->ep_param[ep->epnum]->rbase)) >> 3);
1040 if (swoffs < ucoffs)
1041 emptybds = USB_BDRING_LEN_RX - ucoffs + swoffs;
1043 emptybds = swoffs - ucoffs;
1045 if (emptybds < MIN_EMPTY_BDS) {
1048 dev_vdbg(udc->dev, "%d empty bds, send NACK\n", emptybds);
1050 ep->has_data = USB_BDRING_LEN_RX - emptybds;
1052 if (list_empty(&ep->queue)) {
1054 dev_vdbg(udc->dev, "The rxep have no req queued with %d BDs\n",
1059 tasklet_schedule(&udc->rx_tasklet);
1060 ep->enable_tasklet = 1;
1065 /* send data from a frame, no matter what tx_req */
1066 static int qe_ep_tx(struct qe_ep *ep, struct qe_frame *frame)
1068 struct qe_udc *udc = ep->udc;
1069 struct qe_bd __iomem *bd;
1071 u32 bdstatus, pidmask;
1074 if (ep->dir == USB_DIR_OUT) {
1075 dev_err(udc->dev, "receive ep passed to tx function\n");
1079 /* Disable the Tx interrupt */
1080 saveusbmr = in_be16(&udc->usb_regs->usb_usbmr);
1081 out_be16(&udc->usb_regs->usb_usbmr,
1082 saveusbmr & ~(USB_E_TXB_MASK | USB_E_TXE_MASK));
1085 bdstatus = in_be32((u32 __iomem *)bd);
1087 if (!(bdstatus & (T_R | BD_LENGTH_MASK))) {
1088 if (frame_get_length(frame) == 0) {
1089 frame_set_data(frame, udc->nullbuf);
1090 frame_set_length(frame, 2);
1091 frame->info |= (ZLP | NO_CRC);
1092 dev_vdbg(udc->dev, "the frame size = 0\n");
1094 paddr = virt_to_phys((void *)frame->data);
1095 out_be32(&bd->buf, paddr);
1096 bdstatus = (bdstatus&T_W);
1097 if (!(frame_get_info(frame) & NO_CRC))
1098 bdstatus |= T_R | T_I | T_L | T_TC
1099 | frame_get_length(frame);
1101 bdstatus |= T_R | T_I | T_L | frame_get_length(frame);
1103 /* if the packet is a ZLP in status phase */
1104 if ((ep->epnum == 0) && (udc->ep0_state == DATA_STATE_NEED_ZLP))
1108 pidmask = T_PID_DATA1;
1109 frame->info |= PID_DATA1;
1111 pidmask = T_PID_DATA0;
1112 frame->info |= PID_DATA0;
1115 bdstatus |= pidmask;
1116 out_be32((u32 __iomem *)bd, bdstatus);
1117 qe_ep_filltxfifo(ep);
1119 /* enable the TX interrupt */
1120 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1122 qe_ep_toggledata01(ep);
1124 ep->n_txbd = ep->txbase;
1130 out_be16(&udc->usb_regs->usb_usbmr, saveusbmr);
1131 dev_vdbg(udc->dev, "The tx bd is not ready!\n");
1136 /* when a bd was transmitted, the function can
1137 * handle the tx_req, not include ep0 */
1138 static int txcomplete(struct qe_ep *ep, unsigned char restart)
1140 if (ep->tx_req != NULL) {
1141 struct qe_req *req = ep->tx_req;
1142 unsigned zlp = 0, last_len = 0;
1144 last_len = min_t(unsigned, req->req.length - ep->sent,
1148 int asent = ep->last;
1155 /* zlp needed when req->re.zero is set */
1156 if (req->req.zero) {
1157 if (last_len == 0 ||
1158 (req->req.length % ep->ep.maxpacket) != 0)
1165 /* a request already were transmitted completely */
1166 if (((ep->tx_req->req.length - ep->sent) <= 0) && !zlp) {
1167 done(ep, ep->tx_req, 0);
1174 /* we should gain a new tx_req fot this endpoint */
1175 if (ep->tx_req == NULL) {
1176 if (!list_empty(&ep->queue)) {
1177 ep->tx_req = list_entry(ep->queue.next, struct qe_req,
1187 /* give a frame and a tx_req, send some data */
1188 static int qe_usb_senddata(struct qe_ep *ep, struct qe_frame *frame)
1193 qe_frame_clean(frame);
1194 size = min_t(u32, (ep->tx_req->req.length - ep->sent),
1196 buf = (u8 *)ep->tx_req->req.buf + ep->sent;
1199 ep->tx_req->req.actual += size;
1200 frame_set_data(frame, buf);
1201 frame_set_length(frame, size);
1202 frame_set_status(frame, FRAME_OK);
1203 frame_set_info(frame, 0);
1204 return qe_ep_tx(ep, frame);
1209 /* give a frame struct,send a ZLP */
1210 static int sendnulldata(struct qe_ep *ep, struct qe_frame *frame, uint infor)
1212 struct qe_udc *udc = ep->udc;
1217 qe_frame_clean(frame);
1218 frame_set_data(frame, (u8 *)udc->nullbuf);
1219 frame_set_length(frame, 2);
1220 frame_set_status(frame, FRAME_OK);
1221 frame_set_info(frame, (ZLP | NO_CRC | infor));
1223 return qe_ep_tx(ep, frame);
1226 static int frame_create_tx(struct qe_ep *ep, struct qe_frame *frame)
1228 struct qe_req *req = ep->tx_req;
1234 if ((req->req.length - ep->sent) > 0)
1235 reval = qe_usb_senddata(ep, frame);
1237 reval = sendnulldata(ep, frame, 0);
1242 /* if direction is DIR_IN, the status is Device->Host
1243 * if direction is DIR_OUT, the status transaction is Device<-Host
1244 * in status phase, udc create a request and gain status */
1245 static int ep0_prime_status(struct qe_udc *udc, int direction)
1248 struct qe_ep *ep = &udc->eps[0];
1250 if (direction == USB_DIR_IN) {
1251 udc->ep0_state = DATA_STATE_NEED_ZLP;
1252 udc->ep0_dir = USB_DIR_IN;
1253 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1255 udc->ep0_dir = USB_DIR_OUT;
1256 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1262 /* a request complete in ep0, whether gadget request or udc request */
1263 static void ep0_req_complete(struct qe_udc *udc, struct qe_req *req)
1265 struct qe_ep *ep = &udc->eps[0];
1266 /* because usb and ep's status already been set in ch9setaddress() */
1268 switch (udc->ep0_state) {
1269 case DATA_STATE_XMIT:
1271 /* receive status phase */
1272 if (ep0_prime_status(udc, USB_DIR_OUT))
1276 case DATA_STATE_NEED_ZLP:
1278 udc->ep0_state = WAIT_FOR_SETUP;
1281 case DATA_STATE_RECV:
1283 /* send status phase */
1284 if (ep0_prime_status(udc, USB_DIR_IN))
1288 case WAIT_FOR_OUT_STATUS:
1290 udc->ep0_state = WAIT_FOR_SETUP;
1293 case WAIT_FOR_SETUP:
1294 dev_vdbg(udc->dev, "Unexpected interrupt\n");
1303 static int ep0_txcomplete(struct qe_ep *ep, unsigned char restart)
1305 struct qe_req *tx_req = NULL;
1306 struct qe_frame *frame = ep->txframe;
1308 if ((frame_get_info(frame) & (ZLP | NO_REQ)) == (ZLP | NO_REQ)) {
1310 ep->udc->ep0_state = WAIT_FOR_SETUP;
1312 sendnulldata(ep, ep->txframe, SETUP_STATUS | NO_REQ);
1316 tx_req = ep->tx_req;
1317 if (tx_req != NULL) {
1319 int asent = ep->last;
1326 /* a request already were transmitted completely */
1327 if ((ep->tx_req->req.length - ep->sent) <= 0) {
1328 ep->tx_req->req.actual = (unsigned int)ep->sent;
1329 ep0_req_complete(ep->udc, ep->tx_req);
1335 dev_vdbg(ep->udc->dev, "the ep0_controller have no req\n");
1341 static int ep0_txframe_handle(struct qe_ep *ep)
1343 /* if have error, transmit again */
1344 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1345 qe_ep_flushtxfifo(ep);
1346 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1347 if (frame_get_info(ep->txframe) & PID_DATA0)
1352 ep0_txcomplete(ep, 1);
1354 ep0_txcomplete(ep, 0);
1356 frame_create_tx(ep, ep->txframe);
1360 static int qe_ep0_txconf(struct qe_ep *ep)
1362 struct qe_bd __iomem *bd;
1363 struct qe_frame *pframe;
1367 bdstatus = in_be32((u32 __iomem *)bd);
1368 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1369 pframe = ep->txframe;
1371 /* clear and recycle the BD */
1372 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1373 out_be32(&bd->buf, 0);
1375 ep->c_txbd = ep->txbase;
1379 if (ep->c_txbd == ep->n_txbd) {
1380 if (bdstatus & DEVICE_T_ERROR) {
1381 frame_set_status(pframe, FRAME_ERROR);
1382 if (bdstatus & T_TO)
1383 pframe->status |= TX_ER_TIMEOUT;
1384 if (bdstatus & T_UN)
1385 pframe->status |= TX_ER_UNDERUN;
1387 ep0_txframe_handle(ep);
1391 bdstatus = in_be32((u32 __iomem *)bd);
1397 static int ep_txframe_handle(struct qe_ep *ep)
1399 if (frame_get_status(ep->txframe) & FRAME_ERROR) {
1400 qe_ep_flushtxfifo(ep);
1401 dev_vdbg(ep->udc->dev, "The EP0 transmit data have error!\n");
1402 if (frame_get_info(ep->txframe) & PID_DATA0)
1411 frame_create_tx(ep, ep->txframe); /* send the data */
1415 /* confirm the already trainsmited bd */
1416 static int qe_ep_txconf(struct qe_ep *ep)
1418 struct qe_bd __iomem *bd;
1419 struct qe_frame *pframe = NULL;
1421 unsigned char breakonrxinterrupt = 0;
1424 bdstatus = in_be32((u32 __iomem *)bd);
1425 while (!(bdstatus & T_R) && (bdstatus & ~T_W)) {
1426 pframe = ep->txframe;
1427 if (bdstatus & DEVICE_T_ERROR) {
1428 frame_set_status(pframe, FRAME_ERROR);
1429 if (bdstatus & T_TO)
1430 pframe->status |= TX_ER_TIMEOUT;
1431 if (bdstatus & T_UN)
1432 pframe->status |= TX_ER_UNDERUN;
1435 /* clear and recycle the BD */
1436 out_be32((u32 __iomem *)bd, bdstatus & T_W);
1437 out_be32(&bd->buf, 0);
1439 ep->c_txbd = ep->txbase;
1443 /* handle the tx frame */
1444 ep_txframe_handle(ep);
1446 bdstatus = in_be32((u32 __iomem *)bd);
1448 if (breakonrxinterrupt)
1454 /* Add a request in queue, and try to transmit a packet */
1455 static int ep_req_send(struct qe_ep *ep, struct qe_req *req)
1459 if (ep->tx_req == NULL) {
1462 txcomplete(ep, 0); /* can gain a new tx_req */
1463 reval = frame_create_tx(ep, ep->txframe);
1468 /* Maybe this is a good ideal */
1469 static int ep_req_rx(struct qe_ep *ep, struct qe_req *req)
1471 struct qe_udc *udc = ep->udc;
1472 struct qe_frame *pframe = NULL;
1473 struct qe_bd __iomem *bd;
1474 u32 bdstatus, length;
1480 if (list_empty(&ep->queue)) {
1481 dev_vdbg(udc->dev, "the req already finish!\n");
1484 pframe = ep->rxframe;
1487 bdstatus = in_be32((u32 __iomem *)bd);
1488 length = bdstatus & BD_LENGTH_MASK;
1490 while (!(bdstatus & R_E) && length) {
1493 if ((bdstatus & R_F) && (bdstatus & R_L)
1494 && !(bdstatus & R_ERROR)) {
1495 qe_frame_clean(pframe);
1496 vaddr = (u32)phys_to_virt(in_be32(&bd->buf));
1497 frame_set_data(pframe, (u8 *)vaddr);
1498 frame_set_length(pframe, (length - USB_CRC_SIZE));
1499 frame_set_status(pframe, FRAME_OK);
1500 switch (bdstatus & R_PID) {
1502 frame_set_info(pframe, PID_DATA1); break;
1504 frame_set_info(pframe, PID_DATA0); break;
1506 /* handle the rx frame */
1508 if (frame_get_info(pframe) & PID_DATA1)
1513 if (framepid != ep->data01) {
1514 dev_vdbg(udc->dev, "the data01 error!\n");
1516 fsize = frame_get_length(pframe);
1518 cp = (u8 *)(req->req.buf) + req->req.actual;
1520 memcpy(cp, pframe->data, fsize);
1521 req->req.actual += fsize;
1522 if ((fsize < ep->ep.maxpacket)
1523 || (req->req.actual >=
1527 if (list_empty(&ep->queue))
1531 qe_ep_toggledata01(ep);
1534 dev_err(udc->dev, "The receive frame with error!\n");
1537 /* note: don't clear the rxbd's buffer address *
1538 * only Clear the length */
1539 out_be32((u32 __iomem *)bd, (bdstatus & BD_STATUS_MASK));
1548 bdstatus = in_be32((u32 __iomem *)bd);
1549 length = bdstatus & BD_LENGTH_MASK;
1553 ep_recycle_rxbds(ep);
1558 /* only add the request in queue */
1559 static int ep_req_receive(struct qe_ep *ep, struct qe_req *req)
1561 if (ep->state == EP_STATE_NACK) {
1562 if (ep->has_data <= 0) {
1563 /* Enable rx and unmask rx interrupt */
1566 /* Copy the exist BD data */
1574 /********************************************************************
1575 Internal Used Function End
1576 ********************************************************************/
1578 /*-----------------------------------------------------------------------
1579 Endpoint Management Functions For Gadget
1580 -----------------------------------------------------------------------*/
1581 static int qe_ep_enable(struct usb_ep *_ep,
1582 const struct usb_endpoint_descriptor *desc)
1587 unsigned char epnum;
1589 ep = container_of(_ep, struct qe_ep, ep);
1591 /* catch various bogus parameters */
1592 if (!_ep || !desc || _ep->name == ep_name[0] ||
1593 (desc->bDescriptorType != USB_DT_ENDPOINT))
1597 if (!udc->driver || (udc->gadget.speed == USB_SPEED_UNKNOWN))
1600 epnum = (u8)desc->bEndpointAddress & 0xF;
1602 retval = qe_ep_init(udc, epnum, desc);
1604 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1605 dev_dbg(udc->dev, "enable ep%d failed\n", ep->epnum);
1608 dev_dbg(udc->dev, "enable ep%d successful\n", ep->epnum);
1612 static int qe_ep_disable(struct usb_ep *_ep)
1616 unsigned long flags;
1619 ep = container_of(_ep, struct qe_ep, ep);
1622 if (!_ep || !ep->ep.desc) {
1623 dev_dbg(udc->dev, "%s not enabled\n", _ep ? ep->ep.name : NULL);
1627 spin_lock_irqsave(&udc->lock, flags);
1628 /* Nuke all pending requests (does flush) */
1629 nuke(ep, -ESHUTDOWN);
1633 qe_ep_reset(udc, ep->epnum);
1634 spin_unlock_irqrestore(&udc->lock, flags);
1636 cpm_muram_free(cpm_muram_offset(ep->rxbase));
1638 if (ep->dir == USB_DIR_OUT)
1639 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1640 (USB_BDRING_LEN_RX + 1);
1642 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) *
1643 (USB_BDRING_LEN + 1);
1645 if (ep->dir != USB_DIR_IN) {
1648 dma_unmap_single(udc->gadget.dev.parent,
1651 ep->rxbuf_d = DMA_ADDR_INVALID;
1653 dma_sync_single_for_cpu(
1654 udc->gadget.dev.parent,
1658 kfree(ep->rxbuffer);
1661 if (ep->dir != USB_DIR_OUT)
1664 dev_dbg(udc->dev, "disabled %s OK\n", _ep->name);
1668 static struct usb_request *qe_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1672 req = kzalloc(sizeof(*req), gfp_flags);
1676 req->req.dma = DMA_ADDR_INVALID;
1678 INIT_LIST_HEAD(&req->queue);
1683 static void qe_free_request(struct usb_ep *_ep, struct usb_request *_req)
1687 req = container_of(_req, struct qe_req, req);
1693 static int __qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req)
1695 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1696 struct qe_req *req = container_of(_req, struct qe_req, req);
1701 /* catch various bogus parameters */
1702 if (!_req || !req->req.complete || !req->req.buf
1703 || !list_empty(&req->queue)) {
1704 dev_dbg(udc->dev, "bad params\n");
1707 if (!_ep || (!ep->ep.desc && ep_index(ep))) {
1708 dev_dbg(udc->dev, "bad ep\n");
1712 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
1717 /* map virtual address to hardware */
1718 if (req->req.dma == DMA_ADDR_INVALID) {
1719 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1727 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
1728 req->req.dma, req->req.length,
1735 req->req.status = -EINPROGRESS;
1736 req->req.actual = 0;
1738 list_add_tail(&req->queue, &ep->queue);
1739 dev_vdbg(udc->dev, "gadget have request in %s! %d\n",
1740 ep->name, req->req.length);
1742 /* push the request to device */
1744 reval = ep_req_send(ep, req);
1747 if (ep_index(ep) == 0 && req->req.length > 0) {
1749 udc->ep0_state = DATA_STATE_XMIT;
1751 udc->ep0_state = DATA_STATE_RECV;
1754 if (ep->dir == USB_DIR_OUT)
1755 reval = ep_req_receive(ep, req);
1760 /* queues (submits) an I/O request to an endpoint */
1761 static int qe_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1764 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1765 struct qe_udc *udc = ep->udc;
1766 unsigned long flags;
1769 spin_lock_irqsave(&udc->lock, flags);
1770 ret = __qe_ep_queue(_ep, _req);
1771 spin_unlock_irqrestore(&udc->lock, flags);
1775 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
1776 static int qe_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1778 struct qe_ep *ep = container_of(_ep, struct qe_ep, ep);
1779 struct qe_req *req = NULL;
1780 struct qe_req *iter;
1781 unsigned long flags;
1786 spin_lock_irqsave(&ep->udc->lock, flags);
1788 /* make sure it's actually queued on this endpoint */
1789 list_for_each_entry(iter, &ep->queue, queue) {
1790 if (&iter->req != _req)
1797 spin_unlock_irqrestore(&ep->udc->lock, flags);
1801 done(ep, req, -ECONNRESET);
1803 spin_unlock_irqrestore(&ep->udc->lock, flags);
1807 /*-----------------------------------------------------------------
1808 * modify the endpoint halt feature
1809 * @ep: the non-isochronous endpoint being stalled
1810 * @value: 1--set halt 0--clear halt
1811 * Returns zero, or a negative error code.
1812 *----------------------------------------------------------------*/
1813 static int qe_ep_set_halt(struct usb_ep *_ep, int value)
1816 unsigned long flags;
1817 int status = -EOPNOTSUPP;
1820 ep = container_of(_ep, struct qe_ep, ep);
1821 if (!_ep || !ep->ep.desc) {
1827 /* Attempt to halt IN ep will fail if any transfer requests
1828 * are still queue */
1829 if (value && ep_is_in(ep) && !list_empty(&ep->queue)) {
1835 spin_lock_irqsave(&ep->udc->lock, flags);
1836 qe_eptx_stall_change(ep, value);
1837 qe_eprx_stall_change(ep, value);
1838 spin_unlock_irqrestore(&ep->udc->lock, flags);
1840 if (ep->epnum == 0) {
1841 udc->ep0_state = WAIT_FOR_SETUP;
1845 /* set data toggle to DATA0 on clear halt */
1849 dev_vdbg(udc->dev, "%s %s halt stat %d\n", ep->ep.name,
1850 value ? "set" : "clear", status);
1855 static const struct usb_ep_ops qe_ep_ops = {
1856 .enable = qe_ep_enable,
1857 .disable = qe_ep_disable,
1859 .alloc_request = qe_alloc_request,
1860 .free_request = qe_free_request,
1862 .queue = qe_ep_queue,
1863 .dequeue = qe_ep_dequeue,
1865 .set_halt = qe_ep_set_halt,
1868 /*------------------------------------------------------------------------
1869 Gadget Driver Layer Operations
1870 ------------------------------------------------------------------------*/
1872 /* Get the current frame number */
1873 static int qe_get_frame(struct usb_gadget *gadget)
1875 struct qe_udc *udc = container_of(gadget, struct qe_udc, gadget);
1878 tmp = in_be16(&udc->usb_param->frame_n);
1880 return tmp & 0x07ff;
1884 static int fsl_qe_start(struct usb_gadget *gadget,
1885 struct usb_gadget_driver *driver);
1886 static int fsl_qe_stop(struct usb_gadget *gadget);
1888 /* defined in usb_gadget.h */
1889 static const struct usb_gadget_ops qe_gadget_ops = {
1890 .get_frame = qe_get_frame,
1891 .udc_start = fsl_qe_start,
1892 .udc_stop = fsl_qe_stop,
1895 /*-------------------------------------------------------------------------
1896 USB ep0 Setup process in BUS Enumeration
1897 -------------------------------------------------------------------------*/
1898 static int udc_reset_ep_queue(struct qe_udc *udc, u8 pipe)
1900 struct qe_ep *ep = &udc->eps[pipe];
1902 nuke(ep, -ECONNRESET);
1907 static int reset_queues(struct qe_udc *udc)
1911 for (pipe = 0; pipe < USB_MAX_ENDPOINTS; pipe++)
1912 udc_reset_ep_queue(udc, pipe);
1914 /* report disconnect; the driver is already quiesced */
1915 spin_unlock(&udc->lock);
1916 usb_gadget_udc_reset(&udc->gadget, udc->driver);
1917 spin_lock(&udc->lock);
1922 static void ch9setaddress(struct qe_udc *udc, u16 value, u16 index,
1925 /* Save the new address to device struct */
1926 udc->device_address = (u8) value;
1927 /* Update usb state */
1928 udc->usb_state = USB_STATE_ADDRESS;
1930 /* Status phase , send a ZLP */
1931 if (ep0_prime_status(udc, USB_DIR_IN))
1935 static void ownercomplete(struct usb_ep *_ep, struct usb_request *_req)
1937 struct qe_req *req = container_of(_req, struct qe_req, req);
1939 req->req.buf = NULL;
1943 static void ch9getstatus(struct qe_udc *udc, u8 request_type, u16 value,
1944 u16 index, u16 length)
1952 if ((request_type & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1953 /* Get device status */
1954 usb_status = 1 << USB_DEVICE_SELF_POWERED;
1955 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_INTERFACE) {
1956 /* Get interface status */
1957 /* We don't have interface information in udc driver */
1959 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_ENDPOINT) {
1960 /* Get endpoint status */
1961 int pipe = index & USB_ENDPOINT_NUMBER_MASK;
1962 struct qe_ep *target_ep = &udc->eps[pipe];
1965 /* stall if endpoint doesn't exist */
1966 if (!target_ep->ep.desc)
1969 usep = in_be16(&udc->usb_regs->usb_usep[pipe]);
1970 if (index & USB_DIR_IN) {
1971 if (target_ep->dir != USB_DIR_IN)
1973 if ((usep & USB_THS_MASK) == USB_THS_STALL)
1974 usb_status = 1 << USB_ENDPOINT_HALT;
1976 if (target_ep->dir != USB_DIR_OUT)
1978 if ((usep & USB_RHS_MASK) == USB_RHS_STALL)
1979 usb_status = 1 << USB_ENDPOINT_HALT;
1983 req = container_of(qe_alloc_request(&ep->ep, GFP_KERNEL),
1984 struct qe_req, req);
1985 req->req.length = 2;
1986 req->req.buf = udc->statusbuf;
1987 *(u16 *)req->req.buf = cpu_to_le16(usb_status);
1988 req->req.status = -EINPROGRESS;
1989 req->req.actual = 0;
1990 req->req.complete = ownercomplete;
1992 udc->ep0_dir = USB_DIR_IN;
1995 status = __qe_ep_queue(&ep->ep, &req->req);
2000 dev_err(udc->dev, "Can't respond to getstatus request \n");
2004 /* only handle the setup request, suppose the device in normal status */
2005 static void setup_received_handle(struct qe_udc *udc,
2006 struct usb_ctrlrequest *setup)
2008 /* Fix Endian (udc->local_setup_buff is cpu Endian now)*/
2009 u16 wValue = le16_to_cpu(setup->wValue);
2010 u16 wIndex = le16_to_cpu(setup->wIndex);
2011 u16 wLength = le16_to_cpu(setup->wLength);
2013 /* clear the previous request in the ep0 */
2014 udc_reset_ep_queue(udc, 0);
2016 if (setup->bRequestType & USB_DIR_IN)
2017 udc->ep0_dir = USB_DIR_IN;
2019 udc->ep0_dir = USB_DIR_OUT;
2021 switch (setup->bRequest) {
2022 case USB_REQ_GET_STATUS:
2023 /* Data+Status phase form udc */
2024 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
2025 != (USB_DIR_IN | USB_TYPE_STANDARD))
2027 ch9getstatus(udc, setup->bRequestType, wValue, wIndex,
2031 case USB_REQ_SET_ADDRESS:
2032 /* Status phase from udc */
2033 if (setup->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
2036 ch9setaddress(udc, wValue, wIndex, wLength);
2039 case USB_REQ_CLEAR_FEATURE:
2040 case USB_REQ_SET_FEATURE:
2041 /* Requests with no data phase, status phase from udc */
2042 if ((setup->bRequestType & USB_TYPE_MASK)
2043 != USB_TYPE_STANDARD)
2046 if ((setup->bRequestType & USB_RECIP_MASK)
2047 == USB_RECIP_ENDPOINT) {
2048 int pipe = wIndex & USB_ENDPOINT_NUMBER_MASK;
2051 if (wValue != 0 || wLength != 0
2052 || pipe >= USB_MAX_ENDPOINTS)
2054 ep = &udc->eps[pipe];
2056 spin_unlock(&udc->lock);
2057 qe_ep_set_halt(&ep->ep,
2058 (setup->bRequest == USB_REQ_SET_FEATURE)
2060 spin_lock(&udc->lock);
2063 ep0_prime_status(udc, USB_DIR_IN);
2072 /* Data phase from gadget, status phase from udc */
2073 if (setup->bRequestType & USB_DIR_IN) {
2074 udc->ep0_state = DATA_STATE_XMIT;
2075 udc->ep0_dir = USB_DIR_IN;
2077 udc->ep0_state = DATA_STATE_RECV;
2078 udc->ep0_dir = USB_DIR_OUT;
2080 spin_unlock(&udc->lock);
2081 if (udc->driver->setup(&udc->gadget,
2082 &udc->local_setup_buff) < 0)
2084 spin_lock(&udc->lock);
2086 /* No data phase, IN status from gadget */
2087 udc->ep0_dir = USB_DIR_IN;
2088 spin_unlock(&udc->lock);
2089 if (udc->driver->setup(&udc->gadget,
2090 &udc->local_setup_buff) < 0)
2092 spin_lock(&udc->lock);
2093 udc->ep0_state = DATA_STATE_NEED_ZLP;
2097 /*-------------------------------------------------------------------------
2098 USB Interrupt handlers
2099 -------------------------------------------------------------------------*/
2100 static void suspend_irq(struct qe_udc *udc)
2102 udc->resume_state = udc->usb_state;
2103 udc->usb_state = USB_STATE_SUSPENDED;
2105 /* report suspend to the driver ,serial.c not support this*/
2106 if (udc->driver->suspend)
2107 udc->driver->suspend(&udc->gadget);
2110 static void resume_irq(struct qe_udc *udc)
2112 udc->usb_state = udc->resume_state;
2113 udc->resume_state = 0;
2115 /* report resume to the driver , serial.c not support this*/
2116 if (udc->driver->resume)
2117 udc->driver->resume(&udc->gadget);
2120 static void idle_irq(struct qe_udc *udc)
2124 usbs = in_8(&udc->usb_regs->usb_usbs);
2125 if (usbs & USB_IDLE_STATUS_MASK) {
2126 if ((udc->usb_state) != USB_STATE_SUSPENDED)
2129 if (udc->usb_state == USB_STATE_SUSPENDED)
2134 static int reset_irq(struct qe_udc *udc)
2138 if (udc->usb_state == USB_STATE_DEFAULT)
2141 qe_usb_disable(udc);
2142 out_8(&udc->usb_regs->usb_usadr, 0);
2144 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2145 if (udc->eps[i].init)
2146 qe_ep_reset(udc, i);
2150 udc->usb_state = USB_STATE_DEFAULT;
2151 udc->ep0_state = WAIT_FOR_SETUP;
2152 udc->ep0_dir = USB_DIR_OUT;
2157 static int bsy_irq(struct qe_udc *udc)
2162 static int txe_irq(struct qe_udc *udc)
2167 /* ep0 tx interrupt also in here */
2168 static int tx_irq(struct qe_udc *udc)
2171 struct qe_bd __iomem *bd;
2174 if ((udc->usb_state == USB_STATE_ADDRESS)
2175 && (in_8(&udc->usb_regs->usb_usadr) == 0))
2176 out_8(&udc->usb_regs->usb_usadr, udc->device_address);
2178 for (i = (USB_MAX_ENDPOINTS-1); ((i >= 0) && (res == 0)); i--) {
2180 if (ep && ep->init && (ep->dir != USB_DIR_OUT)) {
2182 if (!(in_be32((u32 __iomem *)bd) & T_R)
2183 && (in_be32(&bd->buf))) {
2184 /* confirm the transmitted bd */
2186 res = qe_ep0_txconf(ep);
2188 res = qe_ep_txconf(ep);
2196 /* setup packect's rx is handle in the function too */
2197 static void rx_irq(struct qe_udc *udc)
2200 struct qe_bd __iomem *bd;
2203 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2205 if (ep && ep->init && (ep->dir != USB_DIR_IN)) {
2207 if (!(in_be32((u32 __iomem *)bd) & R_E)
2208 && (in_be32(&bd->buf))) {
2209 if (ep->epnum == 0) {
2212 /*non-setup package receive*/
2220 static irqreturn_t qe_udc_irq(int irq, void *_udc)
2222 struct qe_udc *udc = (struct qe_udc *)_udc;
2224 irqreturn_t status = IRQ_NONE;
2225 unsigned long flags;
2227 spin_lock_irqsave(&udc->lock, flags);
2229 irq_src = in_be16(&udc->usb_regs->usb_usber) &
2230 in_be16(&udc->usb_regs->usb_usbmr);
2231 /* Clear notification bits */
2232 out_be16(&udc->usb_regs->usb_usber, irq_src);
2234 if (irq_src & USB_E_IDLE_MASK) {
2236 irq_src &= ~USB_E_IDLE_MASK;
2237 status = IRQ_HANDLED;
2240 if (irq_src & USB_E_TXB_MASK) {
2242 irq_src &= ~USB_E_TXB_MASK;
2243 status = IRQ_HANDLED;
2246 if (irq_src & USB_E_RXB_MASK) {
2248 irq_src &= ~USB_E_RXB_MASK;
2249 status = IRQ_HANDLED;
2252 if (irq_src & USB_E_RESET_MASK) {
2254 irq_src &= ~USB_E_RESET_MASK;
2255 status = IRQ_HANDLED;
2258 if (irq_src & USB_E_BSY_MASK) {
2260 irq_src &= ~USB_E_BSY_MASK;
2261 status = IRQ_HANDLED;
2264 if (irq_src & USB_E_TXE_MASK) {
2266 irq_src &= ~USB_E_TXE_MASK;
2267 status = IRQ_HANDLED;
2270 spin_unlock_irqrestore(&udc->lock, flags);
2275 /*-------------------------------------------------------------------------
2276 Gadget driver probe and unregister.
2277 --------------------------------------------------------------------------*/
2278 static int fsl_qe_start(struct usb_gadget *gadget,
2279 struct usb_gadget_driver *driver)
2282 unsigned long flags;
2284 udc = container_of(gadget, struct qe_udc, gadget);
2285 /* lock is needed but whether should use this lock or another */
2286 spin_lock_irqsave(&udc->lock, flags);
2288 /* hook up the driver */
2289 udc->driver = driver;
2290 udc->gadget.speed = driver->max_speed;
2292 /* Enable IRQ reg and Set usbcmd reg EN bit */
2295 out_be16(&udc->usb_regs->usb_usber, 0xffff);
2296 out_be16(&udc->usb_regs->usb_usbmr, USB_E_DEFAULT_DEVICE);
2297 udc->usb_state = USB_STATE_ATTACHED;
2298 udc->ep0_state = WAIT_FOR_SETUP;
2299 udc->ep0_dir = USB_DIR_OUT;
2300 spin_unlock_irqrestore(&udc->lock, flags);
2305 static int fsl_qe_stop(struct usb_gadget *gadget)
2308 struct qe_ep *loop_ep;
2309 unsigned long flags;
2311 udc = container_of(gadget, struct qe_udc, gadget);
2312 /* stop usb controller, disable intr */
2313 qe_usb_disable(udc);
2315 /* in fact, no needed */
2316 udc->usb_state = USB_STATE_ATTACHED;
2317 udc->ep0_state = WAIT_FOR_SETUP;
2320 /* stand operation */
2321 spin_lock_irqsave(&udc->lock, flags);
2322 udc->gadget.speed = USB_SPEED_UNKNOWN;
2323 nuke(&udc->eps[0], -ESHUTDOWN);
2324 list_for_each_entry(loop_ep, &udc->gadget.ep_list, ep.ep_list)
2325 nuke(loop_ep, -ESHUTDOWN);
2326 spin_unlock_irqrestore(&udc->lock, flags);
2333 /* udc structure's alloc and setup, include ep-param alloc */
2334 static struct qe_udc *qe_udc_config(struct platform_device *ofdev)
2337 struct device_node *np = ofdev->dev.of_node;
2338 unsigned long tmp_addr = 0;
2339 struct usb_device_para __iomem *usbpram;
2344 udc = kzalloc(sizeof(*udc), GFP_KERNEL);
2348 udc->dev = &ofdev->dev;
2350 /* get default address of usb parameter in MURAM from device tree */
2351 offset = *of_get_address(np, 1, &size, NULL);
2352 udc->usb_param = cpm_muram_addr(offset);
2353 memset_io(udc->usb_param, 0, size);
2355 usbpram = udc->usb_param;
2356 out_be16(&usbpram->frame_n, 0);
2357 out_be32(&usbpram->rstate, 0);
2359 tmp_addr = cpm_muram_alloc((USB_MAX_ENDPOINTS *
2360 sizeof(struct usb_ep_para)),
2361 USB_EP_PARA_ALIGNMENT);
2362 if (IS_ERR_VALUE(tmp_addr))
2365 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
2366 out_be16(&usbpram->epptr[i], (u16)tmp_addr);
2367 udc->ep_param[i] = cpm_muram_addr(tmp_addr);
2371 memset_io(udc->ep_param[0], 0,
2372 USB_MAX_ENDPOINTS * sizeof(struct usb_ep_para));
2374 udc->resume_state = USB_STATE_NOTATTACHED;
2375 udc->usb_state = USB_STATE_POWERED;
2378 spin_lock_init(&udc->lock);
2386 /* USB Controller register init */
2387 static int qe_udc_reg_init(struct qe_udc *udc)
2389 struct usb_ctlr __iomem *qe_usbregs;
2390 qe_usbregs = udc->usb_regs;
2392 /* Spec says that we must enable the USB controller to change mode. */
2393 out_8(&qe_usbregs->usb_usmod, 0x01);
2394 /* Mode changed, now disable it, since muram isn't initialized yet. */
2395 out_8(&qe_usbregs->usb_usmod, 0x00);
2397 /* Initialize the rest. */
2398 out_be16(&qe_usbregs->usb_usbmr, 0);
2399 out_8(&qe_usbregs->usb_uscom, 0);
2400 out_be16(&qe_usbregs->usb_usber, USBER_ALL_CLEAR);
2405 static int qe_ep_config(struct qe_udc *udc, unsigned char pipe_num)
2407 struct qe_ep *ep = &udc->eps[pipe_num];
2410 strcpy(ep->name, ep_name[pipe_num]);
2411 ep->ep.name = ep_name[pipe_num];
2413 if (pipe_num == 0) {
2414 ep->ep.caps.type_control = true;
2416 ep->ep.caps.type_iso = true;
2417 ep->ep.caps.type_bulk = true;
2418 ep->ep.caps.type_int = true;
2421 ep->ep.caps.dir_in = true;
2422 ep->ep.caps.dir_out = true;
2424 ep->ep.ops = &qe_ep_ops;
2426 usb_ep_set_maxpacket_limit(&ep->ep, (unsigned short) ~0);
2429 ep->epnum = (u8)pipe_num;
2436 ep->state = EP_STATE_IDLE;
2439 /* the queue lists any req for this ep */
2440 INIT_LIST_HEAD(&ep->queue);
2442 /* gagdet.ep_list used for ep_autoconfig so no ep0*/
2444 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
2446 ep->gadget = &udc->gadget;
2451 /*-----------------------------------------------------------------------
2452 * UDC device Driver operation functions *
2453 *----------------------------------------------------------------------*/
2454 static void qe_udc_release(struct device *dev)
2456 struct qe_udc *udc = container_of(dev, struct qe_udc, gadget.dev);
2459 complete(udc->done);
2460 cpm_muram_free(cpm_muram_offset(udc->ep_param[0]));
2461 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
2462 udc->ep_param[i] = NULL;
2467 /* Driver probe functions */
2468 static const struct of_device_id qe_udc_match[];
2469 static int qe_udc_probe(struct platform_device *ofdev)
2472 const struct of_device_id *match;
2473 struct device_node *np = ofdev->dev.of_node;
2475 unsigned int ret = 0;
2479 match = of_match_device(qe_udc_match, &ofdev->dev);
2483 prop = of_get_property(np, "mode", NULL);
2484 if (!prop || strcmp(prop, "peripheral"))
2487 /* Initialize the udc structure including QH member and other member */
2488 udc = qe_udc_config(ofdev);
2490 dev_err(&ofdev->dev, "failed to initialize\n");
2494 udc->soc_type = (unsigned long)match->data;
2495 udc->usb_regs = of_iomap(np, 0);
2496 if (!udc->usb_regs) {
2501 /* initialize usb hw reg except for regs for EP,
2502 * leave usbintr reg untouched*/
2503 qe_udc_reg_init(udc);
2505 /* here comes the stand operations for probe
2506 * set the qe_udc->gadget.xxx */
2507 udc->gadget.ops = &qe_gadget_ops;
2509 /* gadget.ep0 is a pointer */
2510 udc->gadget.ep0 = &udc->eps[0].ep;
2512 INIT_LIST_HEAD(&udc->gadget.ep_list);
2514 /* modify in register gadget process */
2515 udc->gadget.speed = USB_SPEED_UNKNOWN;
2517 /* name: Identifies the controller hardware type. */
2518 udc->gadget.name = driver_name;
2519 udc->gadget.dev.parent = &ofdev->dev;
2521 /* initialize qe_ep struct */
2522 for (i = 0; i < USB_MAX_ENDPOINTS ; i++) {
2523 /* because the ep type isn't decide here so
2524 * qe_ep_init() should be called in ep_enable() */
2526 /* setup the qe_ep struct and link ep.ep.list
2527 * into gadget.ep_list */
2528 qe_ep_config(udc, (unsigned char)i);
2531 /* ep0 initialization in here */
2532 ret = qe_ep_init(udc, 0, &qe_ep0_desc);
2536 /* create a buf for ZLP send, need to remain zeroed */
2537 udc->nullbuf = devm_kzalloc(&ofdev->dev, 256, GFP_KERNEL);
2538 if (udc->nullbuf == NULL) {
2543 /* buffer for data of get_status request */
2544 udc->statusbuf = devm_kzalloc(&ofdev->dev, 2, GFP_KERNEL);
2545 if (udc->statusbuf == NULL) {
2550 udc->nullp = virt_to_phys((void *)udc->nullbuf);
2551 if (udc->nullp == DMA_ADDR_INVALID) {
2552 udc->nullp = dma_map_single(
2553 udc->gadget.dev.parent,
2559 dma_sync_single_for_device(udc->gadget.dev.parent,
2564 tasklet_setup(&udc->rx_tasklet, ep_rx_tasklet);
2565 /* request irq and disable DR */
2566 udc->usb_irq = irq_of_parse_and_map(np, 0);
2567 if (!udc->usb_irq) {
2572 ret = request_irq(udc->usb_irq, qe_udc_irq, 0,
2575 dev_err(udc->dev, "cannot request irq %d err %d\n",
2580 ret = usb_add_gadget_udc_release(&ofdev->dev, &udc->gadget,
2585 platform_set_drvdata(ofdev, udc);
2587 "%s USB controller initialized as device\n",
2588 (udc->soc_type == PORT_QE) ? "QE" : "CPM");
2592 free_irq(udc->usb_irq, udc);
2594 irq_dispose_mapping(udc->usb_irq);
2597 dma_unmap_single(udc->gadget.dev.parent,
2600 udc->nullp = DMA_ADDR_INVALID;
2602 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2608 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2610 kfree(ep->rxbuffer);
2613 iounmap(udc->usb_regs);
2620 static int qe_udc_suspend(struct platform_device *dev, pm_message_t state)
2625 static int qe_udc_resume(struct platform_device *dev)
2631 static int qe_udc_remove(struct platform_device *ofdev)
2633 struct qe_udc *udc = platform_get_drvdata(ofdev);
2636 DECLARE_COMPLETION_ONSTACK(done);
2638 usb_del_gadget_udc(&udc->gadget);
2641 tasklet_disable(&udc->rx_tasklet);
2644 dma_unmap_single(udc->gadget.dev.parent,
2647 udc->nullp = DMA_ADDR_INVALID;
2649 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2655 cpm_muram_free(cpm_muram_offset(ep->rxbase));
2656 size = (ep->ep.maxpacket + USB_CRC_SIZE + 2) * (USB_BDRING_LEN + 1);
2660 dma_unmap_single(udc->gadget.dev.parent,
2663 ep->rxbuf_d = DMA_ADDR_INVALID;
2665 dma_sync_single_for_cpu(udc->gadget.dev.parent,
2670 kfree(ep->rxbuffer);
2673 free_irq(udc->usb_irq, udc);
2674 irq_dispose_mapping(udc->usb_irq);
2676 tasklet_kill(&udc->rx_tasklet);
2678 iounmap(udc->usb_regs);
2680 /* wait for release() of gadget.dev to free udc */
2681 wait_for_completion(&done);
2686 /*-------------------------------------------------------------------------*/
2687 static const struct of_device_id qe_udc_match[] = {
2689 .compatible = "fsl,mpc8323-qe-usb",
2690 .data = (void *)PORT_QE,
2693 .compatible = "fsl,mpc8360-qe-usb",
2694 .data = (void *)PORT_QE,
2697 .compatible = "fsl,mpc8272-cpm-usb",
2698 .data = (void *)PORT_CPM,
2703 MODULE_DEVICE_TABLE(of, qe_udc_match);
2705 static struct platform_driver udc_driver = {
2707 .name = driver_name,
2708 .of_match_table = qe_udc_match,
2710 .probe = qe_udc_probe,
2711 .remove = qe_udc_remove,
2713 .suspend = qe_udc_suspend,
2714 .resume = qe_udc_resume,
2718 module_platform_driver(udc_driver);
2720 MODULE_DESCRIPTION(DRIVER_DESC);
2721 MODULE_AUTHOR(DRIVER_AUTHOR);
2722 MODULE_LICENSE("GPL");