2 * Copyright (C) 2011 Marvell International Ltd. All rights reserved.
3 * Author: Chao Xie <chao.xie@marvell.com>
4 * Neil Zhang <zhangwm@marvell.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
12 #include <linux/module.h>
13 #include <linux/pci.h>
14 #include <linux/dma-mapping.h>
15 #include <linux/dmapool.h>
16 #include <linux/kernel.h>
17 #include <linux/delay.h>
18 #include <linux/ioport.h>
19 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/errno.h>
22 #include <linux/err.h>
23 #include <linux/timer.h>
24 #include <linux/list.h>
25 #include <linux/interrupt.h>
26 #include <linux/moduleparam.h>
27 #include <linux/device.h>
28 #include <linux/usb/ch9.h>
29 #include <linux/usb/gadget.h>
30 #include <linux/usb/otg.h>
33 #include <linux/irq.h>
34 #include <linux/platform_device.h>
35 #include <linux/clk.h>
36 #include <linux/platform_data/mv_usb.h>
37 #include <asm/unaligned.h>
41 #define DRIVER_DESC "Marvell PXA USB Device Controller driver"
42 #define DRIVER_VERSION "8 Nov 2010"
44 #define ep_dir(ep) (((ep)->ep_num == 0) ? \
45 ((ep)->udc->ep0_dir) : ((ep)->direction))
47 /* timeout value -- usec */
48 #define RESET_TIMEOUT 10000
49 #define FLUSH_TIMEOUT 10000
50 #define EPSTATUS_TIMEOUT 10000
51 #define PRIME_TIMEOUT 10000
52 #define READSAFE_TIMEOUT 1000
54 #define LOOPS_USEC_SHIFT 1
55 #define LOOPS_USEC (1 << LOOPS_USEC_SHIFT)
56 #define LOOPS(timeout) ((timeout) >> LOOPS_USEC_SHIFT)
58 static DECLARE_COMPLETION(release_done);
60 static const char driver_name[] = "mv_udc";
61 static const char driver_desc[] = DRIVER_DESC;
63 static void nuke(struct mv_ep *ep, int status);
64 static void stop_activity(struct mv_udc *udc, struct usb_gadget_driver *driver);
66 /* for endpoint 0 operations */
67 static const struct usb_endpoint_descriptor mv_ep0_desc = {
68 .bLength = USB_DT_ENDPOINT_SIZE,
69 .bDescriptorType = USB_DT_ENDPOINT,
70 .bEndpointAddress = 0,
71 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
72 .wMaxPacketSize = EP0_MAX_PKT_SIZE,
75 static void ep0_reset(struct mv_udc *udc)
82 for (i = 0; i < 2; i++) {
87 ep->dqh = &udc->ep_dqh[i];
89 /* configure ep0 endpoint capabilities in dQH */
90 ep->dqh->max_packet_length =
91 (EP0_MAX_PKT_SIZE << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
94 ep->dqh->next_dtd_ptr = EP_QUEUE_HEAD_NEXT_TERMINATE;
96 epctrlx = readl(&udc->op_regs->epctrlx[0]);
98 epctrlx |= EPCTRL_TX_ENABLE
99 | (USB_ENDPOINT_XFER_CONTROL
100 << EPCTRL_TX_EP_TYPE_SHIFT);
103 epctrlx |= EPCTRL_RX_ENABLE
104 | (USB_ENDPOINT_XFER_CONTROL
105 << EPCTRL_RX_EP_TYPE_SHIFT);
108 writel(epctrlx, &udc->op_regs->epctrlx[0]);
112 /* protocol ep0 stall, will automatically be cleared on new transaction */
113 static void ep0_stall(struct mv_udc *udc)
117 /* set TX and RX to stall */
118 epctrlx = readl(&udc->op_regs->epctrlx[0]);
119 epctrlx |= EPCTRL_RX_EP_STALL | EPCTRL_TX_EP_STALL;
120 writel(epctrlx, &udc->op_regs->epctrlx[0]);
122 /* update ep0 state */
123 udc->ep0_state = WAIT_FOR_SETUP;
124 udc->ep0_dir = EP_DIR_OUT;
127 static int process_ep_req(struct mv_udc *udc, int index,
128 struct mv_req *curr_req)
130 struct mv_dtd *curr_dtd;
131 struct mv_dqh *curr_dqh;
132 int actual, remaining_length;
138 curr_dqh = &udc->ep_dqh[index];
139 direction = index % 2;
141 curr_dtd = curr_req->head;
142 actual = curr_req->req.length;
144 for (i = 0; i < curr_req->dtd_count; i++) {
145 if (curr_dtd->size_ioc_sts & DTD_STATUS_ACTIVE) {
146 dev_dbg(&udc->dev->dev, "%s, dTD not completed\n",
147 udc->eps[index].name);
151 errors = curr_dtd->size_ioc_sts & DTD_ERROR_MASK;
154 (curr_dtd->size_ioc_sts & DTD_PACKET_SIZE)
155 >> DTD_LENGTH_BIT_POS;
156 actual -= remaining_length;
158 if (remaining_length) {
160 dev_dbg(&udc->dev->dev,
161 "TX dTD remains data\n");
168 dev_info(&udc->dev->dev,
169 "complete_tr error: ep=%d %s: error = 0x%x\n",
170 index >> 1, direction ? "SEND" : "RECV",
172 if (errors & DTD_STATUS_HALTED) {
173 /* Clear the errors and Halt condition */
174 curr_dqh->size_ioc_int_sts &= ~errors;
176 } else if (errors & DTD_STATUS_DATA_BUFF_ERR) {
178 } else if (errors & DTD_STATUS_TRANSACTION_ERR) {
182 if (i != curr_req->dtd_count - 1)
183 curr_dtd = (struct mv_dtd *)curr_dtd->next_dtd_virt;
188 if (direction == EP_DIR_OUT)
189 bit_pos = 1 << curr_req->ep->ep_num;
191 bit_pos = 1 << (16 + curr_req->ep->ep_num);
193 while ((curr_dqh->curr_dtd_ptr == curr_dtd->td_dma)) {
194 if (curr_dtd->dtd_next == EP_QUEUE_HEAD_NEXT_TERMINATE) {
195 while (readl(&udc->op_regs->epstatus) & bit_pos)
202 curr_req->req.actual = actual;
208 * done() - retire a request; caller blocked irqs
209 * @status : request status to be set, only works when
210 * request is still in progress.
212 static void done(struct mv_ep *ep, struct mv_req *req, int status)
213 __releases(&ep->udc->lock)
214 __acquires(&ep->udc->lock)
216 struct mv_udc *udc = NULL;
217 unsigned char stopped = ep->stopped;
218 struct mv_dtd *curr_td, *next_td;
221 udc = (struct mv_udc *)ep->udc;
222 /* Removed the req from fsl_ep->queue */
223 list_del_init(&req->queue);
225 /* req.status should be set as -EINPROGRESS in ep_queue() */
226 if (req->req.status == -EINPROGRESS)
227 req->req.status = status;
229 status = req->req.status;
231 /* Free dtd for the request */
233 for (j = 0; j < req->dtd_count; j++) {
235 if (j != req->dtd_count - 1)
236 next_td = curr_td->next_dtd_virt;
237 dma_pool_free(udc->dtd_pool, curr_td, curr_td->td_dma);
240 usb_gadget_unmap_request(&udc->gadget, &req->req, ep_dir(ep));
242 if (status && (status != -ESHUTDOWN))
243 dev_info(&udc->dev->dev, "complete %s req %p stat %d len %u/%u",
244 ep->ep.name, &req->req, status,
245 req->req.actual, req->req.length);
249 spin_unlock(&ep->udc->lock);
251 usb_gadget_giveback_request(&ep->ep, &req->req);
253 spin_lock(&ep->udc->lock);
254 ep->stopped = stopped;
257 static int queue_dtd(struct mv_ep *ep, struct mv_req *req)
261 u32 bit_pos, direction;
262 u32 usbcmd, epstatus;
267 direction = ep_dir(ep);
268 dqh = &(udc->ep_dqh[ep->ep_num * 2 + direction]);
269 bit_pos = 1 << (((direction == EP_DIR_OUT) ? 0 : 16) + ep->ep_num);
271 /* check if the pipe is empty */
272 if (!(list_empty(&ep->queue))) {
273 struct mv_req *lastreq;
274 lastreq = list_entry(ep->queue.prev, struct mv_req, queue);
275 lastreq->tail->dtd_next =
276 req->head->td_dma & EP_QUEUE_HEAD_NEXT_POINTER_MASK;
280 if (readl(&udc->op_regs->epprime) & bit_pos)
283 loops = LOOPS(READSAFE_TIMEOUT);
285 /* start with setting the semaphores */
286 usbcmd = readl(&udc->op_regs->usbcmd);
287 usbcmd |= USBCMD_ATDTW_TRIPWIRE_SET;
288 writel(usbcmd, &udc->op_regs->usbcmd);
290 /* read the endpoint status */
291 epstatus = readl(&udc->op_regs->epstatus) & bit_pos;
294 * Reread the ATDTW semaphore bit to check if it is
295 * cleared. When hardware see a hazard, it will clear
296 * the bit or else we remain set to 1 and we can
297 * proceed with priming of endpoint if not already
300 if (readl(&udc->op_regs->usbcmd)
301 & USBCMD_ATDTW_TRIPWIRE_SET)
306 dev_err(&udc->dev->dev,
307 "Timeout for ATDTW_TRIPWIRE...\n");
314 /* Clear the semaphore */
315 usbcmd = readl(&udc->op_regs->usbcmd);
316 usbcmd &= USBCMD_ATDTW_TRIPWIRE_CLEAR;
317 writel(usbcmd, &udc->op_regs->usbcmd);
323 /* Write dQH next pointer and terminate bit to 0 */
324 dqh->next_dtd_ptr = req->head->td_dma
325 & EP_QUEUE_HEAD_NEXT_POINTER_MASK;
327 /* clear active and halt bit, in case set from a previous error */
328 dqh->size_ioc_int_sts &= ~(DTD_STATUS_ACTIVE | DTD_STATUS_HALTED);
330 /* Ensure that updates to the QH will occur before priming. */
333 /* Prime the Endpoint */
334 writel(bit_pos, &udc->op_regs->epprime);
340 static struct mv_dtd *build_dtd(struct mv_req *req, unsigned *length,
341 dma_addr_t *dma, int *is_last)
348 /* how big will this transfer be? */
349 if (usb_endpoint_xfer_isoc(req->ep->ep.desc)) {
351 mult = (dqh->max_packet_length >> EP_QUEUE_HEAD_MULT_POS)
353 *length = min(req->req.length - req->req.actual,
354 (unsigned)(mult * req->ep->ep.maxpacket));
356 *length = min(req->req.length - req->req.actual,
357 (unsigned)EP_MAX_LENGTH_TRANSFER);
362 * Be careful that no _GFP_HIGHMEM is set,
363 * or we can not use dma_to_virt
365 dtd = dma_pool_alloc(udc->dtd_pool, GFP_ATOMIC, dma);
370 /* initialize buffer page pointers */
371 temp = (u32)(req->req.dma + req->req.actual);
372 dtd->buff_ptr0 = cpu_to_le32(temp);
374 dtd->buff_ptr1 = cpu_to_le32(temp + 0x1000);
375 dtd->buff_ptr2 = cpu_to_le32(temp + 0x2000);
376 dtd->buff_ptr3 = cpu_to_le32(temp + 0x3000);
377 dtd->buff_ptr4 = cpu_to_le32(temp + 0x4000);
379 req->req.actual += *length;
381 /* zlp is needed if req->req.zero is set */
383 if (*length == 0 || (*length % req->ep->ep.maxpacket) != 0)
387 } else if (req->req.length == req->req.actual)
392 /* Fill in the transfer size; set active bit */
393 temp = ((*length << DTD_LENGTH_BIT_POS) | DTD_STATUS_ACTIVE);
395 /* Enable interrupt for the last dtd of a request */
396 if (*is_last && !req->req.no_interrupt)
401 dtd->size_ioc_sts = temp;
408 /* generate dTD linked list for a request */
409 static int req_to_dtd(struct mv_req *req)
412 int is_last, is_first = 1;
413 struct mv_dtd *dtd, *last_dtd = NULL;
417 dtd = build_dtd(req, &count, &dma, &is_last);
425 last_dtd->dtd_next = dma;
426 last_dtd->next_dtd_virt = dtd;
432 /* set terminate bit to 1 for the last dTD */
433 dtd->dtd_next = DTD_NEXT_TERMINATE;
440 static int mv_ep_enable(struct usb_ep *_ep,
441 const struct usb_endpoint_descriptor *desc)
447 u32 bit_pos, epctrlx, direction;
448 unsigned char zlt = 0, ios = 0, mult = 0;
451 ep = container_of(_ep, struct mv_ep, ep);
455 || desc->bDescriptorType != USB_DT_ENDPOINT)
458 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
461 direction = ep_dir(ep);
462 max = usb_endpoint_maxp(desc);
465 * disable HW zero length termination select
466 * driver handles zero length packet through req->req.zero
470 bit_pos = 1 << ((direction == EP_DIR_OUT ? 0 : 16) + ep->ep_num);
472 /* Check if the Endpoint is Primed */
473 if ((readl(&udc->op_regs->epprime) & bit_pos)
474 || (readl(&udc->op_regs->epstatus) & bit_pos)) {
475 dev_info(&udc->dev->dev,
476 "ep=%d %s: Init ERROR: ENDPTPRIME=0x%x,"
477 " ENDPTSTATUS=0x%x, bit_pos=0x%x\n",
478 (unsigned)ep->ep_num, direction ? "SEND" : "RECV",
479 (unsigned)readl(&udc->op_regs->epprime),
480 (unsigned)readl(&udc->op_regs->epstatus),
484 /* Set the max packet length, interrupt on Setup and Mult fields */
485 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
486 case USB_ENDPOINT_XFER_BULK:
490 case USB_ENDPOINT_XFER_CONTROL:
492 case USB_ENDPOINT_XFER_INT:
495 case USB_ENDPOINT_XFER_ISOC:
496 /* Calculate transactions needed for high bandwidth iso */
497 mult = (unsigned char)(1 + ((max >> 11) & 0x03));
498 max = max & 0x7ff; /* bit 0~10 */
499 /* 3 transactions at most */
507 spin_lock_irqsave(&udc->lock, flags);
508 /* Get the endpoint queue head address */
510 dqh->max_packet_length = (max << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
511 | (mult << EP_QUEUE_HEAD_MULT_POS)
512 | (zlt ? EP_QUEUE_HEAD_ZLT_SEL : 0)
513 | (ios ? EP_QUEUE_HEAD_IOS : 0);
514 dqh->next_dtd_ptr = 1;
515 dqh->size_ioc_int_sts = 0;
517 ep->ep.maxpacket = max;
521 /* Enable the endpoint for Rx or Tx and set the endpoint type */
522 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
523 if (direction == EP_DIR_IN) {
524 epctrlx &= ~EPCTRL_TX_ALL_MASK;
525 epctrlx |= EPCTRL_TX_ENABLE | EPCTRL_TX_DATA_TOGGLE_RST
526 | ((desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
527 << EPCTRL_TX_EP_TYPE_SHIFT);
529 epctrlx &= ~EPCTRL_RX_ALL_MASK;
530 epctrlx |= EPCTRL_RX_ENABLE | EPCTRL_RX_DATA_TOGGLE_RST
531 | ((desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
532 << EPCTRL_RX_EP_TYPE_SHIFT);
534 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
537 * Implement Guideline (GL# USB-7) The unused endpoint type must
538 * be programmed to bulk.
540 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
541 if ((epctrlx & EPCTRL_RX_ENABLE) == 0) {
542 epctrlx |= (USB_ENDPOINT_XFER_BULK
543 << EPCTRL_RX_EP_TYPE_SHIFT);
544 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
547 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
548 if ((epctrlx & EPCTRL_TX_ENABLE) == 0) {
549 epctrlx |= (USB_ENDPOINT_XFER_BULK
550 << EPCTRL_TX_EP_TYPE_SHIFT);
551 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
554 spin_unlock_irqrestore(&udc->lock, flags);
561 static int mv_ep_disable(struct usb_ep *_ep)
566 u32 epctrlx, direction;
569 ep = container_of(_ep, struct mv_ep, ep);
570 if ((_ep == NULL) || !ep->ep.desc)
575 /* Get the endpoint queue head address */
578 spin_lock_irqsave(&udc->lock, flags);
580 direction = ep_dir(ep);
582 /* Reset the max packet length and the interrupt on Setup */
583 dqh->max_packet_length = 0;
585 /* Disable the endpoint for Rx or Tx and reset the endpoint type */
586 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
587 epctrlx &= ~((direction == EP_DIR_IN)
588 ? (EPCTRL_TX_ENABLE | EPCTRL_TX_TYPE)
589 : (EPCTRL_RX_ENABLE | EPCTRL_RX_TYPE));
590 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
592 /* nuke all pending requests (does flush) */
593 nuke(ep, -ESHUTDOWN);
598 spin_unlock_irqrestore(&udc->lock, flags);
603 static struct usb_request *
604 mv_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
606 struct mv_req *req = NULL;
608 req = kzalloc(sizeof *req, gfp_flags);
612 req->req.dma = DMA_ADDR_INVALID;
613 INIT_LIST_HEAD(&req->queue);
618 static void mv_free_request(struct usb_ep *_ep, struct usb_request *_req)
620 struct mv_req *req = NULL;
622 req = container_of(_req, struct mv_req, req);
628 static void mv_ep_fifo_flush(struct usb_ep *_ep)
631 u32 bit_pos, direction;
638 ep = container_of(_ep, struct mv_ep, ep);
643 direction = ep_dir(ep);
646 bit_pos = (1 << 16) | 1;
647 else if (direction == EP_DIR_OUT)
648 bit_pos = 1 << ep->ep_num;
650 bit_pos = 1 << (16 + ep->ep_num);
652 loops = LOOPS(EPSTATUS_TIMEOUT);
654 unsigned int inter_loops;
657 dev_err(&udc->dev->dev,
658 "TIMEOUT for ENDPTSTATUS=0x%x, bit_pos=0x%x\n",
659 (unsigned)readl(&udc->op_regs->epstatus),
663 /* Write 1 to the Flush register */
664 writel(bit_pos, &udc->op_regs->epflush);
666 /* Wait until flushing completed */
667 inter_loops = LOOPS(FLUSH_TIMEOUT);
668 while (readl(&udc->op_regs->epflush)) {
670 * ENDPTFLUSH bit should be cleared to indicate this
671 * operation is complete
673 if (inter_loops == 0) {
674 dev_err(&udc->dev->dev,
675 "TIMEOUT for ENDPTFLUSH=0x%x,"
677 (unsigned)readl(&udc->op_regs->epflush),
685 } while (readl(&udc->op_regs->epstatus) & bit_pos);
688 /* queues (submits) an I/O request to an endpoint */
690 mv_ep_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
692 struct mv_ep *ep = container_of(_ep, struct mv_ep, ep);
693 struct mv_req *req = container_of(_req, struct mv_req, req);
694 struct mv_udc *udc = ep->udc;
698 /* catch various bogus parameters */
699 if (!_req || !req->req.complete || !req->req.buf
700 || !list_empty(&req->queue)) {
701 dev_err(&udc->dev->dev, "%s, bad params", __func__);
704 if (unlikely(!_ep || !ep->ep.desc)) {
705 dev_err(&udc->dev->dev, "%s, bad ep", __func__);
710 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
715 /* map virtual address to hardware */
716 retval = usb_gadget_map_request(&udc->gadget, _req, ep_dir(ep));
720 req->req.status = -EINPROGRESS;
724 spin_lock_irqsave(&udc->lock, flags);
726 /* build dtds and push them to device queue */
727 if (!req_to_dtd(req)) {
728 retval = queue_dtd(ep, req);
730 spin_unlock_irqrestore(&udc->lock, flags);
731 dev_err(&udc->dev->dev, "Failed to queue dtd\n");
735 spin_unlock_irqrestore(&udc->lock, flags);
736 dev_err(&udc->dev->dev, "Failed to dma_pool_alloc\n");
741 /* Update ep0 state */
743 udc->ep0_state = DATA_STATE_XMIT;
745 /* irq handler advances the queue */
746 list_add_tail(&req->queue, &ep->queue);
747 spin_unlock_irqrestore(&udc->lock, flags);
752 usb_gadget_unmap_request(&udc->gadget, _req, ep_dir(ep));
757 static void mv_prime_ep(struct mv_ep *ep, struct mv_req *req)
759 struct mv_dqh *dqh = ep->dqh;
762 /* Write dQH next pointer and terminate bit to 0 */
763 dqh->next_dtd_ptr = req->head->td_dma
764 & EP_QUEUE_HEAD_NEXT_POINTER_MASK;
766 /* clear active and halt bit, in case set from a previous error */
767 dqh->size_ioc_int_sts &= ~(DTD_STATUS_ACTIVE | DTD_STATUS_HALTED);
769 /* Ensure that updates to the QH will occure before priming. */
772 bit_pos = 1 << (((ep_dir(ep) == EP_DIR_OUT) ? 0 : 16) + ep->ep_num);
774 /* Prime the Endpoint */
775 writel(bit_pos, &ep->udc->op_regs->epprime);
778 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
779 static int mv_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
781 struct mv_ep *ep = container_of(_ep, struct mv_ep, ep);
783 struct mv_udc *udc = ep->udc;
785 int stopped, ret = 0;
791 spin_lock_irqsave(&ep->udc->lock, flags);
792 stopped = ep->stopped;
794 /* Stop the ep before we deal with the queue */
796 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
797 if (ep_dir(ep) == EP_DIR_IN)
798 epctrlx &= ~EPCTRL_TX_ENABLE;
800 epctrlx &= ~EPCTRL_RX_ENABLE;
801 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
803 /* make sure it's actually queued on this endpoint */
804 list_for_each_entry(req, &ep->queue, queue) {
805 if (&req->req == _req)
808 if (&req->req != _req) {
813 /* The request is in progress, or completed but not dequeued */
814 if (ep->queue.next == &req->queue) {
815 _req->status = -ECONNRESET;
816 mv_ep_fifo_flush(_ep); /* flush current transfer */
818 /* The request isn't the last request in this ep queue */
819 if (req->queue.next != &ep->queue) {
820 struct mv_req *next_req;
822 next_req = list_entry(req->queue.next,
823 struct mv_req, queue);
825 /* Point the QH to the first TD of next request */
826 mv_prime_ep(ep, next_req);
831 qh->next_dtd_ptr = 1;
832 qh->size_ioc_int_sts = 0;
835 /* The request hasn't been processed, patch up the TD chain */
837 struct mv_req *prev_req;
839 prev_req = list_entry(req->queue.prev, struct mv_req, queue);
840 writel(readl(&req->tail->dtd_next),
841 &prev_req->tail->dtd_next);
845 done(ep, req, -ECONNRESET);
849 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
850 if (ep_dir(ep) == EP_DIR_IN)
851 epctrlx |= EPCTRL_TX_ENABLE;
853 epctrlx |= EPCTRL_RX_ENABLE;
854 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
855 ep->stopped = stopped;
857 spin_unlock_irqrestore(&ep->udc->lock, flags);
861 static void ep_set_stall(struct mv_udc *udc, u8 ep_num, u8 direction, int stall)
865 epctrlx = readl(&udc->op_regs->epctrlx[ep_num]);
868 if (direction == EP_DIR_IN)
869 epctrlx |= EPCTRL_TX_EP_STALL;
871 epctrlx |= EPCTRL_RX_EP_STALL;
873 if (direction == EP_DIR_IN) {
874 epctrlx &= ~EPCTRL_TX_EP_STALL;
875 epctrlx |= EPCTRL_TX_DATA_TOGGLE_RST;
877 epctrlx &= ~EPCTRL_RX_EP_STALL;
878 epctrlx |= EPCTRL_RX_DATA_TOGGLE_RST;
881 writel(epctrlx, &udc->op_regs->epctrlx[ep_num]);
884 static int ep_is_stall(struct mv_udc *udc, u8 ep_num, u8 direction)
888 epctrlx = readl(&udc->op_regs->epctrlx[ep_num]);
890 if (direction == EP_DIR_OUT)
891 return (epctrlx & EPCTRL_RX_EP_STALL) ? 1 : 0;
893 return (epctrlx & EPCTRL_TX_EP_STALL) ? 1 : 0;
896 static int mv_ep_set_halt_wedge(struct usb_ep *_ep, int halt, int wedge)
899 unsigned long flags = 0;
903 ep = container_of(_ep, struct mv_ep, ep);
905 if (!_ep || !ep->ep.desc) {
910 if (ep->ep.desc->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
911 status = -EOPNOTSUPP;
916 * Attempt to halt IN ep will fail if any transfer requests
919 if (halt && (ep_dir(ep) == EP_DIR_IN) && !list_empty(&ep->queue)) {
924 spin_lock_irqsave(&ep->udc->lock, flags);
925 ep_set_stall(udc, ep->ep_num, ep_dir(ep), halt);
930 spin_unlock_irqrestore(&ep->udc->lock, flags);
932 if (ep->ep_num == 0) {
933 udc->ep0_state = WAIT_FOR_SETUP;
934 udc->ep0_dir = EP_DIR_OUT;
940 static int mv_ep_set_halt(struct usb_ep *_ep, int halt)
942 return mv_ep_set_halt_wedge(_ep, halt, 0);
945 static int mv_ep_set_wedge(struct usb_ep *_ep)
947 return mv_ep_set_halt_wedge(_ep, 1, 1);
950 static struct usb_ep_ops mv_ep_ops = {
951 .enable = mv_ep_enable,
952 .disable = mv_ep_disable,
954 .alloc_request = mv_alloc_request,
955 .free_request = mv_free_request,
957 .queue = mv_ep_queue,
958 .dequeue = mv_ep_dequeue,
960 .set_wedge = mv_ep_set_wedge,
961 .set_halt = mv_ep_set_halt,
962 .fifo_flush = mv_ep_fifo_flush, /* flush fifo */
965 static void udc_clock_enable(struct mv_udc *udc)
967 clk_prepare_enable(udc->clk);
970 static void udc_clock_disable(struct mv_udc *udc)
972 clk_disable_unprepare(udc->clk);
975 static void udc_stop(struct mv_udc *udc)
979 /* Disable interrupts */
980 tmp = readl(&udc->op_regs->usbintr);
981 tmp &= ~(USBINTR_INT_EN | USBINTR_ERR_INT_EN |
982 USBINTR_PORT_CHANGE_DETECT_EN | USBINTR_RESET_EN);
983 writel(tmp, &udc->op_regs->usbintr);
987 /* Reset the Run the bit in the command register to stop VUSB */
988 tmp = readl(&udc->op_regs->usbcmd);
989 tmp &= ~USBCMD_RUN_STOP;
990 writel(tmp, &udc->op_regs->usbcmd);
993 static void udc_start(struct mv_udc *udc)
997 usbintr = USBINTR_INT_EN | USBINTR_ERR_INT_EN
998 | USBINTR_PORT_CHANGE_DETECT_EN
999 | USBINTR_RESET_EN | USBINTR_DEVICE_SUSPEND;
1000 /* Enable interrupts */
1001 writel(usbintr, &udc->op_regs->usbintr);
1005 /* Set the Run bit in the command register */
1006 writel(USBCMD_RUN_STOP, &udc->op_regs->usbcmd);
1009 static int udc_reset(struct mv_udc *udc)
1014 /* Stop the controller */
1015 tmp = readl(&udc->op_regs->usbcmd);
1016 tmp &= ~USBCMD_RUN_STOP;
1017 writel(tmp, &udc->op_regs->usbcmd);
1019 /* Reset the controller to get default values */
1020 writel(USBCMD_CTRL_RESET, &udc->op_regs->usbcmd);
1022 /* wait for reset to complete */
1023 loops = LOOPS(RESET_TIMEOUT);
1024 while (readl(&udc->op_regs->usbcmd) & USBCMD_CTRL_RESET) {
1026 dev_err(&udc->dev->dev,
1027 "Wait for RESET completed TIMEOUT\n");
1034 /* set controller to device mode */
1035 tmp = readl(&udc->op_regs->usbmode);
1036 tmp |= USBMODE_CTRL_MODE_DEVICE;
1038 /* turn setup lockout off, require setup tripwire in usbcmd */
1039 tmp |= USBMODE_SETUP_LOCK_OFF;
1041 writel(tmp, &udc->op_regs->usbmode);
1043 writel(0x0, &udc->op_regs->epsetupstat);
1045 /* Configure the Endpoint List Address */
1046 writel(udc->ep_dqh_dma & USB_EP_LIST_ADDRESS_MASK,
1047 &udc->op_regs->eplistaddr);
1049 portsc = readl(&udc->op_regs->portsc[0]);
1050 if (readl(&udc->cap_regs->hcsparams) & HCSPARAMS_PPC)
1051 portsc &= (~PORTSCX_W1C_BITS | ~PORTSCX_PORT_POWER);
1054 portsc |= PORTSCX_FORCE_FULL_SPEED_CONNECT;
1056 portsc &= (~PORTSCX_FORCE_FULL_SPEED_CONNECT);
1058 writel(portsc, &udc->op_regs->portsc[0]);
1060 tmp = readl(&udc->op_regs->epctrlx[0]);
1061 tmp &= ~(EPCTRL_TX_EP_STALL | EPCTRL_RX_EP_STALL);
1062 writel(tmp, &udc->op_regs->epctrlx[0]);
1067 static int mv_udc_enable_internal(struct mv_udc *udc)
1074 dev_dbg(&udc->dev->dev, "enable udc\n");
1075 udc_clock_enable(udc);
1076 if (udc->pdata->phy_init) {
1077 retval = udc->pdata->phy_init(udc->phy_regs);
1079 dev_err(&udc->dev->dev,
1080 "init phy error %d\n", retval);
1081 udc_clock_disable(udc);
1090 static int mv_udc_enable(struct mv_udc *udc)
1092 if (udc->clock_gating)
1093 return mv_udc_enable_internal(udc);
1098 static void mv_udc_disable_internal(struct mv_udc *udc)
1101 dev_dbg(&udc->dev->dev, "disable udc\n");
1102 if (udc->pdata->phy_deinit)
1103 udc->pdata->phy_deinit(udc->phy_regs);
1104 udc_clock_disable(udc);
1109 static void mv_udc_disable(struct mv_udc *udc)
1111 if (udc->clock_gating)
1112 mv_udc_disable_internal(udc);
1115 static int mv_udc_get_frame(struct usb_gadget *gadget)
1123 udc = container_of(gadget, struct mv_udc, gadget);
1125 retval = readl(&udc->op_regs->frindex) & USB_FRINDEX_MASKS;
1130 /* Tries to wake up the host connected to this gadget */
1131 static int mv_udc_wakeup(struct usb_gadget *gadget)
1133 struct mv_udc *udc = container_of(gadget, struct mv_udc, gadget);
1136 /* Remote wakeup feature not enabled by host */
1137 if (!udc->remote_wakeup)
1140 portsc = readl(&udc->op_regs->portsc);
1141 /* not suspended? */
1142 if (!(portsc & PORTSCX_PORT_SUSPEND))
1144 /* trigger force resume */
1145 portsc |= PORTSCX_PORT_FORCE_RESUME;
1146 writel(portsc, &udc->op_regs->portsc[0]);
1150 static int mv_udc_vbus_session(struct usb_gadget *gadget, int is_active)
1153 unsigned long flags;
1156 udc = container_of(gadget, struct mv_udc, gadget);
1157 spin_lock_irqsave(&udc->lock, flags);
1159 udc->vbus_active = (is_active != 0);
1161 dev_dbg(&udc->dev->dev, "%s: softconnect %d, vbus_active %d\n",
1162 __func__, udc->softconnect, udc->vbus_active);
1164 if (udc->driver && udc->softconnect && udc->vbus_active) {
1165 retval = mv_udc_enable(udc);
1167 /* Clock is disabled, need re-init registers */
1172 } else if (udc->driver && udc->softconnect) {
1176 /* stop all the transfer in queue*/
1177 stop_activity(udc, udc->driver);
1179 mv_udc_disable(udc);
1183 spin_unlock_irqrestore(&udc->lock, flags);
1187 static int mv_udc_pullup(struct usb_gadget *gadget, int is_on)
1190 unsigned long flags;
1193 udc = container_of(gadget, struct mv_udc, gadget);
1194 spin_lock_irqsave(&udc->lock, flags);
1196 udc->softconnect = (is_on != 0);
1198 dev_dbg(&udc->dev->dev, "%s: softconnect %d, vbus_active %d\n",
1199 __func__, udc->softconnect, udc->vbus_active);
1201 if (udc->driver && udc->softconnect && udc->vbus_active) {
1202 retval = mv_udc_enable(udc);
1204 /* Clock is disabled, need re-init registers */
1209 } else if (udc->driver && udc->vbus_active) {
1210 /* stop all the transfer in queue*/
1211 stop_activity(udc, udc->driver);
1213 mv_udc_disable(udc);
1216 spin_unlock_irqrestore(&udc->lock, flags);
1220 static int mv_udc_start(struct usb_gadget *, struct usb_gadget_driver *);
1221 static int mv_udc_stop(struct usb_gadget *);
1222 /* device controller usb_gadget_ops structure */
1223 static const struct usb_gadget_ops mv_ops = {
1225 /* returns the current frame number */
1226 .get_frame = mv_udc_get_frame,
1228 /* tries to wake up the host connected to this gadget */
1229 .wakeup = mv_udc_wakeup,
1231 /* notify controller that VBUS is powered or not */
1232 .vbus_session = mv_udc_vbus_session,
1234 /* D+ pullup, software-controlled connect/disconnect to USB host */
1235 .pullup = mv_udc_pullup,
1236 .udc_start = mv_udc_start,
1237 .udc_stop = mv_udc_stop,
1240 static int eps_init(struct mv_udc *udc)
1246 /* initialize ep0 */
1249 strncpy(ep->name, "ep0", sizeof(ep->name));
1250 ep->ep.name = ep->name;
1251 ep->ep.ops = &mv_ep_ops;
1254 usb_ep_set_maxpacket_limit(&ep->ep, EP0_MAX_PKT_SIZE);
1255 ep->ep.caps.type_control = true;
1256 ep->ep.caps.dir_in = true;
1257 ep->ep.caps.dir_out = true;
1259 ep->ep.desc = &mv_ep0_desc;
1260 INIT_LIST_HEAD(&ep->queue);
1262 ep->ep_type = USB_ENDPOINT_XFER_CONTROL;
1264 /* initialize other endpoints */
1265 for (i = 2; i < udc->max_eps * 2; i++) {
1268 snprintf(name, sizeof(name), "ep%din", i / 2);
1269 ep->direction = EP_DIR_IN;
1270 ep->ep.caps.dir_in = true;
1272 snprintf(name, sizeof(name), "ep%dout", i / 2);
1273 ep->direction = EP_DIR_OUT;
1274 ep->ep.caps.dir_out = true;
1277 strncpy(ep->name, name, sizeof(ep->name));
1278 ep->ep.name = ep->name;
1280 ep->ep.caps.type_iso = true;
1281 ep->ep.caps.type_bulk = true;
1282 ep->ep.caps.type_int = true;
1284 ep->ep.ops = &mv_ep_ops;
1286 usb_ep_set_maxpacket_limit(&ep->ep, (unsigned short) ~0);
1289 INIT_LIST_HEAD(&ep->queue);
1290 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
1292 ep->dqh = &udc->ep_dqh[i];
1298 /* delete all endpoint requests, called with spinlock held */
1299 static void nuke(struct mv_ep *ep, int status)
1301 /* called with spinlock held */
1304 /* endpoint fifo flush */
1305 mv_ep_fifo_flush(&ep->ep);
1307 while (!list_empty(&ep->queue)) {
1308 struct mv_req *req = NULL;
1309 req = list_entry(ep->queue.next, struct mv_req, queue);
1310 done(ep, req, status);
1314 static void gadget_reset(struct mv_udc *udc, struct usb_gadget_driver *driver)
1318 nuke(&udc->eps[0], -ESHUTDOWN);
1320 list_for_each_entry(ep, &udc->gadget.ep_list, ep.ep_list) {
1321 nuke(ep, -ESHUTDOWN);
1324 /* report reset; the driver is already quiesced */
1326 spin_unlock(&udc->lock);
1327 usb_gadget_udc_reset(&udc->gadget, driver);
1328 spin_lock(&udc->lock);
1331 /* stop all USB activities */
1332 static void stop_activity(struct mv_udc *udc, struct usb_gadget_driver *driver)
1336 nuke(&udc->eps[0], -ESHUTDOWN);
1338 list_for_each_entry(ep, &udc->gadget.ep_list, ep.ep_list) {
1339 nuke(ep, -ESHUTDOWN);
1342 /* report disconnect; the driver is already quiesced */
1344 spin_unlock(&udc->lock);
1345 driver->disconnect(&udc->gadget);
1346 spin_lock(&udc->lock);
1350 static int mv_udc_start(struct usb_gadget *gadget,
1351 struct usb_gadget_driver *driver)
1355 unsigned long flags;
1357 udc = container_of(gadget, struct mv_udc, gadget);
1362 spin_lock_irqsave(&udc->lock, flags);
1364 /* hook up the driver ... */
1365 driver->driver.bus = NULL;
1366 udc->driver = driver;
1368 udc->usb_state = USB_STATE_ATTACHED;
1369 udc->ep0_state = WAIT_FOR_SETUP;
1370 udc->ep0_dir = EP_DIR_OUT;
1372 spin_unlock_irqrestore(&udc->lock, flags);
1374 if (udc->transceiver) {
1375 retval = otg_set_peripheral(udc->transceiver->otg,
1378 dev_err(&udc->dev->dev,
1379 "unable to register peripheral to otg\n");
1385 /* When boot with cable attached, there will be no vbus irq occurred */
1387 queue_work(udc->qwork, &udc->vbus_work);
1392 static int mv_udc_stop(struct usb_gadget *gadget)
1395 unsigned long flags;
1397 udc = container_of(gadget, struct mv_udc, gadget);
1399 spin_lock_irqsave(&udc->lock, flags);
1404 /* stop all usb activities */
1405 udc->gadget.speed = USB_SPEED_UNKNOWN;
1406 stop_activity(udc, NULL);
1407 mv_udc_disable(udc);
1409 spin_unlock_irqrestore(&udc->lock, flags);
1411 /* unbind gadget driver */
1417 static void mv_set_ptc(struct mv_udc *udc, u32 mode)
1421 portsc = readl(&udc->op_regs->portsc[0]);
1422 portsc |= mode << 16;
1423 writel(portsc, &udc->op_regs->portsc[0]);
1426 static void prime_status_complete(struct usb_ep *ep, struct usb_request *_req)
1428 struct mv_ep *mvep = container_of(ep, struct mv_ep, ep);
1429 struct mv_req *req = container_of(_req, struct mv_req, req);
1431 unsigned long flags;
1435 dev_info(&udc->dev->dev, "switch to test mode %d\n", req->test_mode);
1437 spin_lock_irqsave(&udc->lock, flags);
1438 if (req->test_mode) {
1439 mv_set_ptc(udc, req->test_mode);
1442 spin_unlock_irqrestore(&udc->lock, flags);
1446 udc_prime_status(struct mv_udc *udc, u8 direction, u16 status, bool empty)
1453 udc->ep0_dir = direction;
1454 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1456 req = udc->status_req;
1458 /* fill in the reqest structure */
1459 if (empty == false) {
1460 *((u16 *) req->req.buf) = cpu_to_le16(status);
1461 req->req.length = 2;
1463 req->req.length = 0;
1466 req->req.status = -EINPROGRESS;
1467 req->req.actual = 0;
1468 if (udc->test_mode) {
1469 req->req.complete = prime_status_complete;
1470 req->test_mode = udc->test_mode;
1473 req->req.complete = NULL;
1476 if (req->req.dma == DMA_ADDR_INVALID) {
1477 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1478 req->req.buf, req->req.length,
1479 ep_dir(ep) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1483 /* prime the data phase */
1484 if (!req_to_dtd(req)) {
1485 retval = queue_dtd(ep, req);
1487 dev_err(&udc->dev->dev,
1488 "Failed to queue dtd when prime status\n");
1491 } else{ /* no mem */
1493 dev_err(&udc->dev->dev,
1494 "Failed to dma_pool_alloc when prime status\n");
1498 list_add_tail(&req->queue, &ep->queue);
1502 usb_gadget_unmap_request(&udc->gadget, &req->req, ep_dir(ep));
1507 static void mv_udc_testmode(struct mv_udc *udc, u16 index)
1509 if (index <= TEST_FORCE_EN) {
1510 udc->test_mode = index;
1511 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1514 dev_err(&udc->dev->dev,
1515 "This test mode(%d) is not supported\n", index);
1518 static void ch9setaddress(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1520 udc->dev_addr = (u8)setup->wValue;
1522 /* update usb state */
1523 udc->usb_state = USB_STATE_ADDRESS;
1525 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1529 static void ch9getstatus(struct mv_udc *udc, u8 ep_num,
1530 struct usb_ctrlrequest *setup)
1535 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
1536 != (USB_DIR_IN | USB_TYPE_STANDARD))
1539 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1540 status = 1 << USB_DEVICE_SELF_POWERED;
1541 status |= udc->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP;
1542 } else if ((setup->bRequestType & USB_RECIP_MASK)
1543 == USB_RECIP_INTERFACE) {
1544 /* get interface status */
1546 } else if ((setup->bRequestType & USB_RECIP_MASK)
1547 == USB_RECIP_ENDPOINT) {
1548 u8 ep_num, direction;
1550 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1551 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1552 ? EP_DIR_IN : EP_DIR_OUT;
1553 status = ep_is_stall(udc, ep_num, direction)
1554 << USB_ENDPOINT_HALT;
1557 retval = udc_prime_status(udc, EP_DIR_IN, status, false);
1561 udc->ep0_state = DATA_STATE_XMIT;
1564 static void ch9clearfeature(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1570 if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1571 == ((USB_TYPE_STANDARD | USB_RECIP_DEVICE))) {
1572 switch (setup->wValue) {
1573 case USB_DEVICE_REMOTE_WAKEUP:
1574 udc->remote_wakeup = 0;
1579 } else if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1580 == ((USB_TYPE_STANDARD | USB_RECIP_ENDPOINT))) {
1581 switch (setup->wValue) {
1582 case USB_ENDPOINT_HALT:
1583 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1584 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1585 ? EP_DIR_IN : EP_DIR_OUT;
1586 if (setup->wValue != 0 || setup->wLength != 0
1587 || ep_num > udc->max_eps)
1589 ep = &udc->eps[ep_num * 2 + direction];
1592 spin_unlock(&udc->lock);
1593 ep_set_stall(udc, ep_num, direction, 0);
1594 spin_lock(&udc->lock);
1602 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1608 static void ch9setfeature(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1613 if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1614 == ((USB_TYPE_STANDARD | USB_RECIP_DEVICE))) {
1615 switch (setup->wValue) {
1616 case USB_DEVICE_REMOTE_WAKEUP:
1617 udc->remote_wakeup = 1;
1619 case USB_DEVICE_TEST_MODE:
1620 if (setup->wIndex & 0xFF
1621 || udc->gadget.speed != USB_SPEED_HIGH)
1624 if (udc->usb_state != USB_STATE_CONFIGURED
1625 && udc->usb_state != USB_STATE_ADDRESS
1626 && udc->usb_state != USB_STATE_DEFAULT)
1629 mv_udc_testmode(udc, (setup->wIndex >> 8));
1634 } else if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1635 == ((USB_TYPE_STANDARD | USB_RECIP_ENDPOINT))) {
1636 switch (setup->wValue) {
1637 case USB_ENDPOINT_HALT:
1638 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1639 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1640 ? EP_DIR_IN : EP_DIR_OUT;
1641 if (setup->wValue != 0 || setup->wLength != 0
1642 || ep_num > udc->max_eps)
1644 spin_unlock(&udc->lock);
1645 ep_set_stall(udc, ep_num, direction, 1);
1646 spin_lock(&udc->lock);
1654 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1660 static void handle_setup_packet(struct mv_udc *udc, u8 ep_num,
1661 struct usb_ctrlrequest *setup)
1662 __releases(&ep->udc->lock)
1663 __acquires(&ep->udc->lock)
1665 bool delegate = false;
1667 nuke(&udc->eps[ep_num * 2 + EP_DIR_OUT], -ESHUTDOWN);
1669 dev_dbg(&udc->dev->dev, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1670 setup->bRequestType, setup->bRequest,
1671 setup->wValue, setup->wIndex, setup->wLength);
1672 /* We process some standard setup requests here */
1673 if ((setup->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
1674 switch (setup->bRequest) {
1675 case USB_REQ_GET_STATUS:
1676 ch9getstatus(udc, ep_num, setup);
1679 case USB_REQ_SET_ADDRESS:
1680 ch9setaddress(udc, setup);
1683 case USB_REQ_CLEAR_FEATURE:
1684 ch9clearfeature(udc, setup);
1687 case USB_REQ_SET_FEATURE:
1688 ch9setfeature(udc, setup);
1697 /* delegate USB standard requests to the gadget driver */
1698 if (delegate == true) {
1699 /* USB requests handled by gadget */
1700 if (setup->wLength) {
1701 /* DATA phase from gadget, STATUS phase from udc */
1702 udc->ep0_dir = (setup->bRequestType & USB_DIR_IN)
1703 ? EP_DIR_IN : EP_DIR_OUT;
1704 spin_unlock(&udc->lock);
1705 if (udc->driver->setup(&udc->gadget,
1706 &udc->local_setup_buff) < 0)
1708 spin_lock(&udc->lock);
1709 udc->ep0_state = (setup->bRequestType & USB_DIR_IN)
1710 ? DATA_STATE_XMIT : DATA_STATE_RECV;
1712 /* no DATA phase, IN STATUS phase from gadget */
1713 udc->ep0_dir = EP_DIR_IN;
1714 spin_unlock(&udc->lock);
1715 if (udc->driver->setup(&udc->gadget,
1716 &udc->local_setup_buff) < 0)
1718 spin_lock(&udc->lock);
1719 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1724 /* complete DATA or STATUS phase of ep0 prime status phase if needed */
1725 static void ep0_req_complete(struct mv_udc *udc,
1726 struct mv_ep *ep0, struct mv_req *req)
1730 if (udc->usb_state == USB_STATE_ADDRESS) {
1731 /* set the new address */
1732 new_addr = (u32)udc->dev_addr;
1733 writel(new_addr << USB_DEVICE_ADDRESS_BIT_SHIFT,
1734 &udc->op_regs->deviceaddr);
1739 switch (udc->ep0_state) {
1740 case DATA_STATE_XMIT:
1741 /* receive status phase */
1742 if (udc_prime_status(udc, EP_DIR_OUT, 0, true))
1745 case DATA_STATE_RECV:
1746 /* send status phase */
1747 if (udc_prime_status(udc, EP_DIR_IN, 0 , true))
1750 case WAIT_FOR_OUT_STATUS:
1751 udc->ep0_state = WAIT_FOR_SETUP;
1753 case WAIT_FOR_SETUP:
1754 dev_err(&udc->dev->dev, "unexpect ep0 packets\n");
1762 static void get_setup_data(struct mv_udc *udc, u8 ep_num, u8 *buffer_ptr)
1767 dqh = &udc->ep_dqh[ep_num * 2 + EP_DIR_OUT];
1769 /* Clear bit in ENDPTSETUPSTAT */
1770 writel((1 << ep_num), &udc->op_regs->epsetupstat);
1772 /* while a hazard exists when setup package arrives */
1774 /* Set Setup Tripwire */
1775 temp = readl(&udc->op_regs->usbcmd);
1776 writel(temp | USBCMD_SETUP_TRIPWIRE_SET, &udc->op_regs->usbcmd);
1778 /* Copy the setup packet to local buffer */
1779 memcpy(buffer_ptr, (u8 *) dqh->setup_buffer, 8);
1780 } while (!(readl(&udc->op_regs->usbcmd) & USBCMD_SETUP_TRIPWIRE_SET));
1782 /* Clear Setup Tripwire */
1783 temp = readl(&udc->op_regs->usbcmd);
1784 writel(temp & ~USBCMD_SETUP_TRIPWIRE_SET, &udc->op_regs->usbcmd);
1787 static void irq_process_tr_complete(struct mv_udc *udc)
1790 int i, ep_num = 0, direction = 0;
1791 struct mv_ep *curr_ep;
1792 struct mv_req *curr_req, *temp_req;
1796 * We use separate loops for ENDPTSETUPSTAT and ENDPTCOMPLETE
1797 * because the setup packets are to be read ASAP
1800 /* Process all Setup packet received interrupts */
1801 tmp = readl(&udc->op_regs->epsetupstat);
1804 for (i = 0; i < udc->max_eps; i++) {
1805 if (tmp & (1 << i)) {
1806 get_setup_data(udc, i,
1807 (u8 *)(&udc->local_setup_buff));
1808 handle_setup_packet(udc, i,
1809 &udc->local_setup_buff);
1814 /* Don't clear the endpoint setup status register here.
1815 * It is cleared as a setup packet is read out of the buffer
1818 /* Process non-setup transaction complete interrupts */
1819 tmp = readl(&udc->op_regs->epcomplete);
1824 writel(tmp, &udc->op_regs->epcomplete);
1826 for (i = 0; i < udc->max_eps * 2; i++) {
1830 bit_pos = 1 << (ep_num + 16 * direction);
1832 if (!(bit_pos & tmp))
1836 curr_ep = &udc->eps[0];
1838 curr_ep = &udc->eps[i];
1839 /* process the req queue until an uncomplete request */
1840 list_for_each_entry_safe(curr_req, temp_req,
1841 &curr_ep->queue, queue) {
1842 status = process_ep_req(udc, i, curr_req);
1846 /* write back status to req */
1847 curr_req->req.status = status;
1849 /* ep0 request completion */
1851 ep0_req_complete(udc, curr_ep, curr_req);
1854 done(curr_ep, curr_req, status);
1860 static void irq_process_reset(struct mv_udc *udc)
1865 udc->ep0_dir = EP_DIR_OUT;
1866 udc->ep0_state = WAIT_FOR_SETUP;
1867 udc->remote_wakeup = 0; /* default to 0 on reset */
1869 /* The address bits are past bit 25-31. Set the address */
1870 tmp = readl(&udc->op_regs->deviceaddr);
1871 tmp &= ~(USB_DEVICE_ADDRESS_MASK);
1872 writel(tmp, &udc->op_regs->deviceaddr);
1874 /* Clear all the setup token semaphores */
1875 tmp = readl(&udc->op_regs->epsetupstat);
1876 writel(tmp, &udc->op_regs->epsetupstat);
1878 /* Clear all the endpoint complete status bits */
1879 tmp = readl(&udc->op_regs->epcomplete);
1880 writel(tmp, &udc->op_regs->epcomplete);
1882 /* wait until all endptprime bits cleared */
1883 loops = LOOPS(PRIME_TIMEOUT);
1884 while (readl(&udc->op_regs->epprime) & 0xFFFFFFFF) {
1886 dev_err(&udc->dev->dev,
1887 "Timeout for ENDPTPRIME = 0x%x\n",
1888 readl(&udc->op_regs->epprime));
1895 /* Write 1s to the Flush register */
1896 writel((u32)~0, &udc->op_regs->epflush);
1898 if (readl(&udc->op_regs->portsc[0]) & PORTSCX_PORT_RESET) {
1899 dev_info(&udc->dev->dev, "usb bus reset\n");
1900 udc->usb_state = USB_STATE_DEFAULT;
1901 /* reset all the queues, stop all USB activities */
1902 gadget_reset(udc, udc->driver);
1904 dev_info(&udc->dev->dev, "USB reset portsc 0x%x\n",
1905 readl(&udc->op_regs->portsc));
1913 /* reset all the queues, stop all USB activities */
1914 stop_activity(udc, udc->driver);
1916 /* reset ep0 dQH and endptctrl */
1919 /* enable interrupt and set controller to run state */
1922 udc->usb_state = USB_STATE_ATTACHED;
1926 static void handle_bus_resume(struct mv_udc *udc)
1928 udc->usb_state = udc->resume_state;
1929 udc->resume_state = 0;
1931 /* report resume to the driver */
1933 if (udc->driver->resume) {
1934 spin_unlock(&udc->lock);
1935 udc->driver->resume(&udc->gadget);
1936 spin_lock(&udc->lock);
1941 static void irq_process_suspend(struct mv_udc *udc)
1943 udc->resume_state = udc->usb_state;
1944 udc->usb_state = USB_STATE_SUSPENDED;
1946 if (udc->driver->suspend) {
1947 spin_unlock(&udc->lock);
1948 udc->driver->suspend(&udc->gadget);
1949 spin_lock(&udc->lock);
1953 static void irq_process_port_change(struct mv_udc *udc)
1957 portsc = readl(&udc->op_regs->portsc[0]);
1958 if (!(portsc & PORTSCX_PORT_RESET)) {
1960 u32 speed = portsc & PORTSCX_PORT_SPEED_MASK;
1962 case PORTSCX_PORT_SPEED_HIGH:
1963 udc->gadget.speed = USB_SPEED_HIGH;
1965 case PORTSCX_PORT_SPEED_FULL:
1966 udc->gadget.speed = USB_SPEED_FULL;
1968 case PORTSCX_PORT_SPEED_LOW:
1969 udc->gadget.speed = USB_SPEED_LOW;
1972 udc->gadget.speed = USB_SPEED_UNKNOWN;
1977 if (portsc & PORTSCX_PORT_SUSPEND) {
1978 udc->resume_state = udc->usb_state;
1979 udc->usb_state = USB_STATE_SUSPENDED;
1980 if (udc->driver->suspend) {
1981 spin_unlock(&udc->lock);
1982 udc->driver->suspend(&udc->gadget);
1983 spin_lock(&udc->lock);
1987 if (!(portsc & PORTSCX_PORT_SUSPEND)
1988 && udc->usb_state == USB_STATE_SUSPENDED) {
1989 handle_bus_resume(udc);
1992 if (!udc->resume_state)
1993 udc->usb_state = USB_STATE_DEFAULT;
1996 static void irq_process_error(struct mv_udc *udc)
1998 /* Increment the error count */
2002 static irqreturn_t mv_udc_irq(int irq, void *dev)
2004 struct mv_udc *udc = (struct mv_udc *)dev;
2007 /* Disable ISR when stopped bit is set */
2011 spin_lock(&udc->lock);
2013 status = readl(&udc->op_regs->usbsts);
2014 intr = readl(&udc->op_regs->usbintr);
2018 spin_unlock(&udc->lock);
2022 /* Clear all the interrupts occurred */
2023 writel(status, &udc->op_regs->usbsts);
2025 if (status & USBSTS_ERR)
2026 irq_process_error(udc);
2028 if (status & USBSTS_RESET)
2029 irq_process_reset(udc);
2031 if (status & USBSTS_PORT_CHANGE)
2032 irq_process_port_change(udc);
2034 if (status & USBSTS_INT)
2035 irq_process_tr_complete(udc);
2037 if (status & USBSTS_SUSPEND)
2038 irq_process_suspend(udc);
2040 spin_unlock(&udc->lock);
2045 static irqreturn_t mv_udc_vbus_irq(int irq, void *dev)
2047 struct mv_udc *udc = (struct mv_udc *)dev;
2049 /* polling VBUS and init phy may cause too much time*/
2051 queue_work(udc->qwork, &udc->vbus_work);
2056 static void mv_udc_vbus_work(struct work_struct *work)
2061 udc = container_of(work, struct mv_udc, vbus_work);
2062 if (!udc->pdata->vbus)
2065 vbus = udc->pdata->vbus->poll();
2066 dev_info(&udc->dev->dev, "vbus is %d\n", vbus);
2068 if (vbus == VBUS_HIGH)
2069 mv_udc_vbus_session(&udc->gadget, 1);
2070 else if (vbus == VBUS_LOW)
2071 mv_udc_vbus_session(&udc->gadget, 0);
2074 /* release device structure */
2075 static void gadget_release(struct device *_dev)
2079 udc = dev_get_drvdata(_dev);
2081 complete(udc->done);
2084 static int mv_udc_remove(struct platform_device *pdev)
2088 udc = platform_get_drvdata(pdev);
2090 usb_del_gadget_udc(&udc->gadget);
2093 flush_workqueue(udc->qwork);
2094 destroy_workqueue(udc->qwork);
2097 /* free memory allocated in probe */
2098 dma_pool_destroy(udc->dtd_pool);
2101 dma_free_coherent(&pdev->dev, udc->ep_dqh_size,
2102 udc->ep_dqh, udc->ep_dqh_dma);
2104 mv_udc_disable(udc);
2106 /* free dev, wait for the release() finished */
2107 wait_for_completion(udc->done);
2112 static int mv_udc_probe(struct platform_device *pdev)
2114 struct mv_usb_platform_data *pdata = dev_get_platdata(&pdev->dev);
2120 if (pdata == NULL) {
2121 dev_err(&pdev->dev, "missing platform_data\n");
2125 udc = devm_kzalloc(&pdev->dev, sizeof(*udc), GFP_KERNEL);
2129 udc->done = &release_done;
2130 udc->pdata = dev_get_platdata(&pdev->dev);
2131 spin_lock_init(&udc->lock);
2135 if (pdata->mode == MV_USB_MODE_OTG) {
2136 udc->transceiver = devm_usb_get_phy(&pdev->dev,
2138 if (IS_ERR(udc->transceiver)) {
2139 retval = PTR_ERR(udc->transceiver);
2141 if (retval == -ENXIO)
2144 udc->transceiver = NULL;
2145 return -EPROBE_DEFER;
2149 /* udc only have one sysclk. */
2150 udc->clk = devm_clk_get(&pdev->dev, NULL);
2151 if (IS_ERR(udc->clk))
2152 return PTR_ERR(udc->clk);
2154 r = platform_get_resource_byname(udc->dev, IORESOURCE_MEM, "capregs");
2156 dev_err(&pdev->dev, "no I/O memory resource defined\n");
2160 udc->cap_regs = (struct mv_cap_regs __iomem *)
2161 devm_ioremap(&pdev->dev, r->start, resource_size(r));
2162 if (udc->cap_regs == NULL) {
2163 dev_err(&pdev->dev, "failed to map I/O memory\n");
2167 r = platform_get_resource_byname(udc->dev, IORESOURCE_MEM, "phyregs");
2169 dev_err(&pdev->dev, "no phy I/O memory resource defined\n");
2173 udc->phy_regs = devm_ioremap(&pdev->dev, r->start, resource_size(r));
2174 if (udc->phy_regs == NULL) {
2175 dev_err(&pdev->dev, "failed to map phy I/O memory\n");
2179 /* we will acces controller register, so enable the clk */
2180 retval = mv_udc_enable_internal(udc);
2185 (struct mv_op_regs __iomem *)((unsigned long)udc->cap_regs
2186 + (readl(&udc->cap_regs->caplength_hciversion)
2188 udc->max_eps = readl(&udc->cap_regs->dccparams) & DCCPARAMS_DEN_MASK;
2191 * some platform will use usb to download image, it may not disconnect
2192 * usb gadget before loading kernel. So first stop udc here.
2195 writel(0xFFFFFFFF, &udc->op_regs->usbsts);
2197 size = udc->max_eps * sizeof(struct mv_dqh) *2;
2198 size = (size + DQH_ALIGNMENT - 1) & ~(DQH_ALIGNMENT - 1);
2199 udc->ep_dqh = dma_alloc_coherent(&pdev->dev, size,
2200 &udc->ep_dqh_dma, GFP_KERNEL);
2202 if (udc->ep_dqh == NULL) {
2203 dev_err(&pdev->dev, "allocate dQH memory failed\n");
2205 goto err_disable_clock;
2207 udc->ep_dqh_size = size;
2209 /* create dTD dma_pool resource */
2210 udc->dtd_pool = dma_pool_create("mv_dtd",
2212 sizeof(struct mv_dtd),
2216 if (!udc->dtd_pool) {
2221 size = udc->max_eps * sizeof(struct mv_ep) *2;
2222 udc->eps = devm_kzalloc(&pdev->dev, size, GFP_KERNEL);
2223 if (udc->eps == NULL) {
2225 goto err_destroy_dma;
2228 /* initialize ep0 status request structure */
2229 udc->status_req = devm_kzalloc(&pdev->dev, sizeof(struct mv_req),
2231 if (!udc->status_req) {
2233 goto err_destroy_dma;
2235 INIT_LIST_HEAD(&udc->status_req->queue);
2237 /* allocate a small amount of memory to get valid address */
2238 udc->status_req->req.buf = kzalloc(8, GFP_KERNEL);
2239 udc->status_req->req.dma = DMA_ADDR_INVALID;
2241 udc->resume_state = USB_STATE_NOTATTACHED;
2242 udc->usb_state = USB_STATE_POWERED;
2243 udc->ep0_dir = EP_DIR_OUT;
2244 udc->remote_wakeup = 0;
2246 r = platform_get_resource(udc->dev, IORESOURCE_IRQ, 0);
2248 dev_err(&pdev->dev, "no IRQ resource defined\n");
2250 goto err_destroy_dma;
2252 udc->irq = r->start;
2253 if (devm_request_irq(&pdev->dev, udc->irq, mv_udc_irq,
2254 IRQF_SHARED, driver_name, udc)) {
2255 dev_err(&pdev->dev, "Request irq %d for UDC failed\n",
2258 goto err_destroy_dma;
2261 /* initialize gadget structure */
2262 udc->gadget.ops = &mv_ops; /* usb_gadget_ops */
2263 udc->gadget.ep0 = &udc->eps[0].ep; /* gadget ep0 */
2264 INIT_LIST_HEAD(&udc->gadget.ep_list); /* ep_list */
2265 udc->gadget.speed = USB_SPEED_UNKNOWN; /* speed */
2266 udc->gadget.max_speed = USB_SPEED_HIGH; /* support dual speed */
2268 /* the "gadget" abstracts/virtualizes the controller */
2269 udc->gadget.name = driver_name; /* gadget name */
2273 /* VBUS detect: we can disable/enable clock on demand.*/
2274 if (udc->transceiver)
2275 udc->clock_gating = 1;
2276 else if (pdata->vbus) {
2277 udc->clock_gating = 1;
2278 retval = devm_request_threaded_irq(&pdev->dev,
2279 pdata->vbus->irq, NULL,
2280 mv_udc_vbus_irq, IRQF_ONESHOT, "vbus", udc);
2282 dev_info(&pdev->dev,
2283 "Can not request irq for VBUS, "
2284 "disable clock gating\n");
2285 udc->clock_gating = 0;
2288 udc->qwork = create_singlethread_workqueue("mv_udc_queue");
2290 dev_err(&pdev->dev, "cannot create workqueue\n");
2292 goto err_destroy_dma;
2295 INIT_WORK(&udc->vbus_work, mv_udc_vbus_work);
2299 * When clock gating is supported, we can disable clk and phy.
2300 * If not, it means that VBUS detection is not supported, we
2301 * have to enable vbus active all the time to let controller work.
2303 if (udc->clock_gating)
2304 mv_udc_disable_internal(udc);
2306 udc->vbus_active = 1;
2308 retval = usb_add_gadget_udc_release(&pdev->dev, &udc->gadget,
2311 goto err_create_workqueue;
2313 platform_set_drvdata(pdev, udc);
2314 dev_info(&pdev->dev, "successful probe UDC device %s clock gating.\n",
2315 udc->clock_gating ? "with" : "without");
2319 err_create_workqueue:
2321 destroy_workqueue(udc->qwork);
2323 dma_pool_destroy(udc->dtd_pool);
2325 dma_free_coherent(&pdev->dev, udc->ep_dqh_size,
2326 udc->ep_dqh, udc->ep_dqh_dma);
2328 mv_udc_disable_internal(udc);
2334 static int mv_udc_suspend(struct device *dev)
2338 udc = dev_get_drvdata(dev);
2340 /* if OTG is enabled, the following will be done in OTG driver*/
2341 if (udc->transceiver)
2344 if (udc->pdata->vbus && udc->pdata->vbus->poll)
2345 if (udc->pdata->vbus->poll() == VBUS_HIGH) {
2346 dev_info(&udc->dev->dev, "USB cable is connected!\n");
2351 * only cable is unplugged, udc can suspend.
2352 * So do not care about clock_gating == 1.
2354 if (!udc->clock_gating) {
2357 spin_lock_irq(&udc->lock);
2358 /* stop all usb activities */
2359 stop_activity(udc, udc->driver);
2360 spin_unlock_irq(&udc->lock);
2362 mv_udc_disable_internal(udc);
2368 static int mv_udc_resume(struct device *dev)
2373 udc = dev_get_drvdata(dev);
2375 /* if OTG is enabled, the following will be done in OTG driver*/
2376 if (udc->transceiver)
2379 if (!udc->clock_gating) {
2380 retval = mv_udc_enable_internal(udc);
2384 if (udc->driver && udc->softconnect) {
2394 static const struct dev_pm_ops mv_udc_pm_ops = {
2395 .suspend = mv_udc_suspend,
2396 .resume = mv_udc_resume,
2400 static void mv_udc_shutdown(struct platform_device *pdev)
2405 udc = platform_get_drvdata(pdev);
2406 /* reset controller mode to IDLE */
2408 mode = readl(&udc->op_regs->usbmode);
2410 writel(mode, &udc->op_regs->usbmode);
2411 mv_udc_disable(udc);
2414 static struct platform_driver udc_driver = {
2415 .probe = mv_udc_probe,
2416 .remove = mv_udc_remove,
2417 .shutdown = mv_udc_shutdown,
2421 .pm = &mv_udc_pm_ops,
2426 module_platform_driver(udc_driver);
2427 MODULE_ALIAS("platform:mv-udc");
2428 MODULE_DESCRIPTION(DRIVER_DESC);
2429 MODULE_AUTHOR("Chao Xie <chao.xie@marvell.com>");
2430 MODULE_VERSION(DRIVER_VERSION);
2431 MODULE_LICENSE("GPL");