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/init.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/system.h>
38 #include <asm/unaligned.h>
42 #define DRIVER_DESC "Marvell PXA USB Device Controller driver"
43 #define DRIVER_VERSION "8 Nov 2010"
45 #define ep_dir(ep) (((ep)->ep_num == 0) ? \
46 ((ep)->udc->ep0_dir) : ((ep)->direction))
48 /* timeout value -- usec */
49 #define RESET_TIMEOUT 10000
50 #define FLUSH_TIMEOUT 10000
51 #define EPSTATUS_TIMEOUT 10000
52 #define PRIME_TIMEOUT 10000
53 #define READSAFE_TIMEOUT 1000
54 #define DTD_TIMEOUT 1000
56 #define LOOPS_USEC_SHIFT 4
57 #define LOOPS_USEC (1 << LOOPS_USEC_SHIFT)
58 #define LOOPS(timeout) ((timeout) >> LOOPS_USEC_SHIFT)
60 static DECLARE_COMPLETION(release_done);
62 static const char driver_name[] = "mv_udc";
63 static const char driver_desc[] = DRIVER_DESC;
65 /* controller device global variable */
66 static struct mv_udc *the_controller;
69 static void nuke(struct mv_ep *ep, int status);
70 static void stop_activity(struct mv_udc *udc, struct usb_gadget_driver *driver);
72 /* for endpoint 0 operations */
73 static const struct usb_endpoint_descriptor mv_ep0_desc = {
74 .bLength = USB_DT_ENDPOINT_SIZE,
75 .bDescriptorType = USB_DT_ENDPOINT,
76 .bEndpointAddress = 0,
77 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
78 .wMaxPacketSize = EP0_MAX_PKT_SIZE,
81 static void ep0_reset(struct mv_udc *udc)
88 for (i = 0; i < 2; i++) {
93 ep->dqh = &udc->ep_dqh[i];
95 /* configure ep0 endpoint capabilities in dQH */
96 ep->dqh->max_packet_length =
97 (EP0_MAX_PKT_SIZE << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
100 ep->dqh->next_dtd_ptr = EP_QUEUE_HEAD_NEXT_TERMINATE;
102 epctrlx = readl(&udc->op_regs->epctrlx[0]);
104 epctrlx |= EPCTRL_TX_ENABLE
105 | (USB_ENDPOINT_XFER_CONTROL
106 << EPCTRL_TX_EP_TYPE_SHIFT);
109 epctrlx |= EPCTRL_RX_ENABLE
110 | (USB_ENDPOINT_XFER_CONTROL
111 << EPCTRL_RX_EP_TYPE_SHIFT);
114 writel(epctrlx, &udc->op_regs->epctrlx[0]);
118 /* protocol ep0 stall, will automatically be cleared on new transaction */
119 static void ep0_stall(struct mv_udc *udc)
123 /* set TX and RX to stall */
124 epctrlx = readl(&udc->op_regs->epctrlx[0]);
125 epctrlx |= EPCTRL_RX_EP_STALL | EPCTRL_TX_EP_STALL;
126 writel(epctrlx, &udc->op_regs->epctrlx[0]);
128 /* update ep0 state */
129 udc->ep0_state = WAIT_FOR_SETUP;
130 udc->ep0_dir = EP_DIR_OUT;
133 static int process_ep_req(struct mv_udc *udc, int index,
134 struct mv_req *curr_req)
136 struct mv_dtd *curr_dtd;
137 struct mv_dqh *curr_dqh;
138 int td_complete, actual, remaining_length;
144 curr_dqh = &udc->ep_dqh[index];
145 direction = index % 2;
147 curr_dtd = curr_req->head;
149 actual = curr_req->req.length;
151 for (i = 0; i < curr_req->dtd_count; i++) {
152 if (curr_dtd->size_ioc_sts & DTD_STATUS_ACTIVE) {
153 dev_dbg(&udc->dev->dev, "%s, dTD not completed\n",
154 udc->eps[index].name);
158 errors = curr_dtd->size_ioc_sts & DTD_ERROR_MASK;
161 (curr_dtd->size_ioc_sts & DTD_PACKET_SIZE)
162 >> DTD_LENGTH_BIT_POS;
163 actual -= remaining_length;
165 if (remaining_length) {
167 dev_dbg(&udc->dev->dev,
168 "TX dTD remains data\n");
175 dev_info(&udc->dev->dev,
176 "complete_tr error: ep=%d %s: error = 0x%x\n",
177 index >> 1, direction ? "SEND" : "RECV",
179 if (errors & DTD_STATUS_HALTED) {
180 /* Clear the errors and Halt condition */
181 curr_dqh->size_ioc_int_sts &= ~errors;
183 } else if (errors & DTD_STATUS_DATA_BUFF_ERR) {
185 } else if (errors & DTD_STATUS_TRANSACTION_ERR) {
189 if (i != curr_req->dtd_count - 1)
190 curr_dtd = (struct mv_dtd *)curr_dtd->next_dtd_virt;
195 if (direction == EP_DIR_OUT)
196 bit_pos = 1 << curr_req->ep->ep_num;
198 bit_pos = 1 << (16 + curr_req->ep->ep_num);
200 while ((curr_dqh->curr_dtd_ptr == curr_dtd->td_dma)) {
201 if (curr_dtd->dtd_next == EP_QUEUE_HEAD_NEXT_TERMINATE) {
202 while (readl(&udc->op_regs->epstatus) & bit_pos)
209 curr_req->req.actual = actual;
215 * done() - retire a request; caller blocked irqs
216 * @status : request status to be set, only works when
217 * request is still in progress.
219 static void done(struct mv_ep *ep, struct mv_req *req, int status)
221 struct mv_udc *udc = NULL;
222 unsigned char stopped = ep->stopped;
223 struct mv_dtd *curr_td, *next_td;
226 udc = (struct mv_udc *)ep->udc;
227 /* Removed the req from fsl_ep->queue */
228 list_del_init(&req->queue);
230 /* req.status should be set as -EINPROGRESS in ep_queue() */
231 if (req->req.status == -EINPROGRESS)
232 req->req.status = status;
234 status = req->req.status;
236 /* Free dtd for the request */
238 for (j = 0; j < req->dtd_count; j++) {
240 if (j != req->dtd_count - 1)
241 next_td = curr_td->next_dtd_virt;
242 dma_pool_free(udc->dtd_pool, curr_td, curr_td->td_dma);
246 dma_unmap_single(ep->udc->gadget.dev.parent,
247 req->req.dma, req->req.length,
248 ((ep_dir(ep) == EP_DIR_IN) ?
249 DMA_TO_DEVICE : DMA_FROM_DEVICE));
250 req->req.dma = DMA_ADDR_INVALID;
253 dma_sync_single_for_cpu(ep->udc->gadget.dev.parent,
254 req->req.dma, req->req.length,
255 ((ep_dir(ep) == EP_DIR_IN) ?
256 DMA_TO_DEVICE : DMA_FROM_DEVICE));
258 if (status && (status != -ESHUTDOWN))
259 dev_info(&udc->dev->dev, "complete %s req %p stat %d len %u/%u",
260 ep->ep.name, &req->req, status,
261 req->req.actual, req->req.length);
265 spin_unlock(&ep->udc->lock);
267 * complete() is from gadget layer,
268 * eg fsg->bulk_in_complete()
270 if (req->req.complete)
271 req->req.complete(&ep->ep, &req->req);
273 spin_lock(&ep->udc->lock);
274 ep->stopped = stopped;
277 static int queue_dtd(struct mv_ep *ep, struct mv_req *req)
281 u32 bit_pos, direction;
282 u32 usbcmd, epstatus;
287 direction = ep_dir(ep);
288 dqh = &(udc->ep_dqh[ep->ep_num * 2 + direction]);
289 bit_pos = 1 << (((direction == EP_DIR_OUT) ? 0 : 16) + ep->ep_num);
291 /* check if the pipe is empty */
292 if (!(list_empty(&ep->queue))) {
293 struct mv_req *lastreq;
294 lastreq = list_entry(ep->queue.prev, struct mv_req, queue);
295 lastreq->tail->dtd_next =
296 req->head->td_dma & EP_QUEUE_HEAD_NEXT_POINTER_MASK;
300 if (readl(&udc->op_regs->epprime) & bit_pos)
303 loops = LOOPS(READSAFE_TIMEOUT);
305 /* start with setting the semaphores */
306 usbcmd = readl(&udc->op_regs->usbcmd);
307 usbcmd |= USBCMD_ATDTW_TRIPWIRE_SET;
308 writel(usbcmd, &udc->op_regs->usbcmd);
310 /* read the endpoint status */
311 epstatus = readl(&udc->op_regs->epstatus) & bit_pos;
314 * Reread the ATDTW semaphore bit to check if it is
315 * cleared. When hardware see a hazard, it will clear
316 * the bit or else we remain set to 1 and we can
317 * proceed with priming of endpoint if not already
320 if (readl(&udc->op_regs->usbcmd)
321 & USBCMD_ATDTW_TRIPWIRE_SET)
326 dev_err(&udc->dev->dev,
327 "Timeout for ATDTW_TRIPWIRE...\n");
334 /* Clear the semaphore */
335 usbcmd = readl(&udc->op_regs->usbcmd);
336 usbcmd &= USBCMD_ATDTW_TRIPWIRE_CLEAR;
337 writel(usbcmd, &udc->op_regs->usbcmd);
343 /* Write dQH next pointer and terminate bit to 0 */
344 dqh->next_dtd_ptr = req->head->td_dma
345 & EP_QUEUE_HEAD_NEXT_POINTER_MASK;
347 /* clear active and halt bit, in case set from a previous error */
348 dqh->size_ioc_int_sts &= ~(DTD_STATUS_ACTIVE | DTD_STATUS_HALTED);
350 /* Ensure that updates to the QH will occure before priming. */
353 /* Prime the Endpoint */
354 writel(bit_pos, &udc->op_regs->epprime);
361 static struct mv_dtd *build_dtd(struct mv_req *req, unsigned *length,
362 dma_addr_t *dma, int *is_last)
368 /* how big will this transfer be? */
369 *length = min(req->req.length - req->req.actual,
370 (unsigned)EP_MAX_LENGTH_TRANSFER);
375 * Be careful that no _GFP_HIGHMEM is set,
376 * or we can not use dma_to_virt
378 dtd = dma_pool_alloc(udc->dtd_pool, GFP_KERNEL, dma);
383 /* initialize buffer page pointers */
384 temp = (u32)(req->req.dma + req->req.actual);
385 dtd->buff_ptr0 = cpu_to_le32(temp);
387 dtd->buff_ptr1 = cpu_to_le32(temp + 0x1000);
388 dtd->buff_ptr2 = cpu_to_le32(temp + 0x2000);
389 dtd->buff_ptr3 = cpu_to_le32(temp + 0x3000);
390 dtd->buff_ptr4 = cpu_to_le32(temp + 0x4000);
392 req->req.actual += *length;
394 /* zlp is needed if req->req.zero is set */
396 if (*length == 0 || (*length % req->ep->ep.maxpacket) != 0)
400 } else if (req->req.length == req->req.actual)
405 /* Fill in the transfer size; set active bit */
406 temp = ((*length << DTD_LENGTH_BIT_POS) | DTD_STATUS_ACTIVE);
408 /* Enable interrupt for the last dtd of a request */
409 if (*is_last && !req->req.no_interrupt)
412 dtd->size_ioc_sts = temp;
419 /* generate dTD linked list for a request */
420 static int req_to_dtd(struct mv_req *req)
423 int is_last, is_first = 1;
424 struct mv_dtd *dtd, *last_dtd = NULL;
431 dtd = build_dtd(req, &count, &dma, &is_last);
439 last_dtd->dtd_next = dma;
440 last_dtd->next_dtd_virt = dtd;
446 /* set terminate bit to 1 for the last dTD */
447 dtd->dtd_next = DTD_NEXT_TERMINATE;
454 static int mv_ep_enable(struct usb_ep *_ep,
455 const struct usb_endpoint_descriptor *desc)
461 u32 bit_pos, epctrlx, direction;
462 unsigned char zlt = 0, ios = 0, mult = 0;
465 ep = container_of(_ep, struct mv_ep, ep);
468 if (!_ep || !desc || ep->desc
469 || desc->bDescriptorType != USB_DT_ENDPOINT)
472 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
475 direction = ep_dir(ep);
476 max = usb_endpoint_maxp(desc);
479 * disable HW zero length termination select
480 * driver handles zero length packet through req->req.zero
484 bit_pos = 1 << ((direction == EP_DIR_OUT ? 0 : 16) + ep->ep_num);
486 /* Check if the Endpoint is Primed */
487 if ((readl(&udc->op_regs->epprime) & bit_pos)
488 || (readl(&udc->op_regs->epstatus) & bit_pos)) {
489 dev_info(&udc->dev->dev,
490 "ep=%d %s: Init ERROR: ENDPTPRIME=0x%x,"
491 " ENDPTSTATUS=0x%x, bit_pos=0x%x\n",
492 (unsigned)ep->ep_num, direction ? "SEND" : "RECV",
493 (unsigned)readl(&udc->op_regs->epprime),
494 (unsigned)readl(&udc->op_regs->epstatus),
498 /* Set the max packet length, interrupt on Setup and Mult fields */
499 switch (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
500 case USB_ENDPOINT_XFER_BULK:
504 case USB_ENDPOINT_XFER_CONTROL:
506 case USB_ENDPOINT_XFER_INT:
509 case USB_ENDPOINT_XFER_ISOC:
510 /* Calculate transactions needed for high bandwidth iso */
511 mult = (unsigned char)(1 + ((max >> 11) & 0x03));
512 max = max & 0x7ff; /* bit 0~10 */
513 /* 3 transactions at most */
521 spin_lock_irqsave(&udc->lock, flags);
522 /* Get the endpoint queue head address */
524 dqh->max_packet_length = (max << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
525 | (mult << EP_QUEUE_HEAD_MULT_POS)
526 | (zlt ? EP_QUEUE_HEAD_ZLT_SEL : 0)
527 | (ios ? EP_QUEUE_HEAD_IOS : 0);
528 dqh->next_dtd_ptr = 1;
529 dqh->size_ioc_int_sts = 0;
531 ep->ep.maxpacket = max;
535 /* Enable the endpoint for Rx or Tx and set the endpoint type */
536 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
537 if (direction == EP_DIR_IN) {
538 epctrlx &= ~EPCTRL_TX_ALL_MASK;
539 epctrlx |= EPCTRL_TX_ENABLE | EPCTRL_TX_DATA_TOGGLE_RST
540 | ((desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
541 << EPCTRL_TX_EP_TYPE_SHIFT);
543 epctrlx &= ~EPCTRL_RX_ALL_MASK;
544 epctrlx |= EPCTRL_RX_ENABLE | EPCTRL_RX_DATA_TOGGLE_RST
545 | ((desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
546 << EPCTRL_RX_EP_TYPE_SHIFT);
548 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
551 * Implement Guideline (GL# USB-7) The unused endpoint type must
552 * be programmed to bulk.
554 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
555 if ((epctrlx & EPCTRL_RX_ENABLE) == 0) {
556 epctrlx |= (USB_ENDPOINT_XFER_BULK
557 << EPCTRL_RX_EP_TYPE_SHIFT);
558 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
561 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
562 if ((epctrlx & EPCTRL_TX_ENABLE) == 0) {
563 epctrlx |= (USB_ENDPOINT_XFER_BULK
564 << EPCTRL_TX_EP_TYPE_SHIFT);
565 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
568 spin_unlock_irqrestore(&udc->lock, flags);
575 static int mv_ep_disable(struct usb_ep *_ep)
580 u32 bit_pos, epctrlx, direction;
583 ep = container_of(_ep, struct mv_ep, ep);
584 if ((_ep == NULL) || !ep->desc)
589 /* Get the endpoint queue head address */
592 spin_lock_irqsave(&udc->lock, flags);
594 direction = ep_dir(ep);
595 bit_pos = 1 << ((direction == EP_DIR_OUT ? 0 : 16) + ep->ep_num);
597 /* Reset the max packet length and the interrupt on Setup */
598 dqh->max_packet_length = 0;
600 /* Disable the endpoint for Rx or Tx and reset the endpoint type */
601 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
602 epctrlx &= ~((direction == EP_DIR_IN)
603 ? (EPCTRL_TX_ENABLE | EPCTRL_TX_TYPE)
604 : (EPCTRL_RX_ENABLE | EPCTRL_RX_TYPE));
605 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
607 /* nuke all pending requests (does flush) */
608 nuke(ep, -ESHUTDOWN);
613 spin_unlock_irqrestore(&udc->lock, flags);
618 static struct usb_request *
619 mv_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
621 struct mv_req *req = NULL;
623 req = kzalloc(sizeof *req, gfp_flags);
627 req->req.dma = DMA_ADDR_INVALID;
628 INIT_LIST_HEAD(&req->queue);
633 static void mv_free_request(struct usb_ep *_ep, struct usb_request *_req)
635 struct mv_req *req = NULL;
637 req = container_of(_req, struct mv_req, req);
643 static void mv_ep_fifo_flush(struct usb_ep *_ep)
646 u32 bit_pos, direction;
653 ep = container_of(_ep, struct mv_ep, ep);
658 direction = ep_dir(ep);
661 bit_pos = (1 << 16) | 1;
662 else if (direction == EP_DIR_OUT)
663 bit_pos = 1 << ep->ep_num;
665 bit_pos = 1 << (16 + ep->ep_num);
667 loops = LOOPS(EPSTATUS_TIMEOUT);
669 unsigned int inter_loops;
672 dev_err(&udc->dev->dev,
673 "TIMEOUT for ENDPTSTATUS=0x%x, bit_pos=0x%x\n",
674 (unsigned)readl(&udc->op_regs->epstatus),
678 /* Write 1 to the Flush register */
679 writel(bit_pos, &udc->op_regs->epflush);
681 /* Wait until flushing completed */
682 inter_loops = LOOPS(FLUSH_TIMEOUT);
683 while (readl(&udc->op_regs->epflush)) {
685 * ENDPTFLUSH bit should be cleared to indicate this
686 * operation is complete
688 if (inter_loops == 0) {
689 dev_err(&udc->dev->dev,
690 "TIMEOUT for ENDPTFLUSH=0x%x,"
692 (unsigned)readl(&udc->op_regs->epflush),
700 } while (readl(&udc->op_regs->epstatus) & bit_pos);
703 /* queues (submits) an I/O request to an endpoint */
705 mv_ep_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
707 struct mv_ep *ep = container_of(_ep, struct mv_ep, ep);
708 struct mv_req *req = container_of(_req, struct mv_req, req);
709 struct mv_udc *udc = ep->udc;
712 /* catch various bogus parameters */
713 if (!_req || !req->req.complete || !req->req.buf
714 || !list_empty(&req->queue)) {
715 dev_err(&udc->dev->dev, "%s, bad params", __func__);
718 if (unlikely(!_ep || !ep->desc)) {
719 dev_err(&udc->dev->dev, "%s, bad ep", __func__);
722 if (ep->desc->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
723 if (req->req.length > ep->ep.maxpacket)
728 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
733 /* map virtual address to hardware */
734 if (req->req.dma == DMA_ADDR_INVALID) {
735 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
737 req->req.length, ep_dir(ep)
742 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
743 req->req.dma, req->req.length,
750 req->req.status = -EINPROGRESS;
754 spin_lock_irqsave(&udc->lock, flags);
756 /* build dtds and push them to device queue */
757 if (!req_to_dtd(req)) {
759 retval = queue_dtd(ep, req);
761 spin_unlock_irqrestore(&udc->lock, flags);
765 spin_unlock_irqrestore(&udc->lock, flags);
769 /* Update ep0 state */
771 udc->ep0_state = DATA_STATE_XMIT;
773 /* irq handler advances the queue */
775 list_add_tail(&req->queue, &ep->queue);
776 spin_unlock_irqrestore(&udc->lock, flags);
781 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
782 static int mv_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
784 struct mv_ep *ep = container_of(_ep, struct mv_ep, ep);
786 struct mv_udc *udc = ep->udc;
788 int stopped, ret = 0;
794 spin_lock_irqsave(&ep->udc->lock, flags);
795 stopped = ep->stopped;
797 /* Stop the ep before we deal with the queue */
799 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
800 if (ep_dir(ep) == EP_DIR_IN)
801 epctrlx &= ~EPCTRL_TX_ENABLE;
803 epctrlx &= ~EPCTRL_RX_ENABLE;
804 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
806 /* make sure it's actually queued on this endpoint */
807 list_for_each_entry(req, &ep->queue, queue) {
808 if (&req->req == _req)
811 if (&req->req != _req) {
816 /* The request is in progress, or completed but not dequeued */
817 if (ep->queue.next == &req->queue) {
818 _req->status = -ECONNRESET;
819 mv_ep_fifo_flush(_ep); /* flush current transfer */
821 /* The request isn't the last request in this ep queue */
822 if (req->queue.next != &ep->queue) {
824 struct mv_req *next_req;
827 next_req = list_entry(req->queue.next, struct mv_req,
830 /* Point the QH to the first TD of next request */
831 writel((u32) next_req->head, &qh->curr_dtd_ptr);
836 qh->next_dtd_ptr = 1;
837 qh->size_ioc_int_sts = 0;
840 /* The request hasn't been processed, patch up the TD chain */
842 struct mv_req *prev_req;
844 prev_req = list_entry(req->queue.prev, struct mv_req, queue);
845 writel(readl(&req->tail->dtd_next),
846 &prev_req->tail->dtd_next);
850 done(ep, req, -ECONNRESET);
854 epctrlx = readl(&udc->op_regs->epctrlx[ep->ep_num]);
855 if (ep_dir(ep) == EP_DIR_IN)
856 epctrlx |= EPCTRL_TX_ENABLE;
858 epctrlx |= EPCTRL_RX_ENABLE;
859 writel(epctrlx, &udc->op_regs->epctrlx[ep->ep_num]);
860 ep->stopped = stopped;
862 spin_unlock_irqrestore(&ep->udc->lock, flags);
866 static void ep_set_stall(struct mv_udc *udc, u8 ep_num, u8 direction, int stall)
870 epctrlx = readl(&udc->op_regs->epctrlx[ep_num]);
873 if (direction == EP_DIR_IN)
874 epctrlx |= EPCTRL_TX_EP_STALL;
876 epctrlx |= EPCTRL_RX_EP_STALL;
878 if (direction == EP_DIR_IN) {
879 epctrlx &= ~EPCTRL_TX_EP_STALL;
880 epctrlx |= EPCTRL_TX_DATA_TOGGLE_RST;
882 epctrlx &= ~EPCTRL_RX_EP_STALL;
883 epctrlx |= EPCTRL_RX_DATA_TOGGLE_RST;
886 writel(epctrlx, &udc->op_regs->epctrlx[ep_num]);
889 static int ep_is_stall(struct mv_udc *udc, u8 ep_num, u8 direction)
893 epctrlx = readl(&udc->op_regs->epctrlx[ep_num]);
895 if (direction == EP_DIR_OUT)
896 return (epctrlx & EPCTRL_RX_EP_STALL) ? 1 : 0;
898 return (epctrlx & EPCTRL_TX_EP_STALL) ? 1 : 0;
901 static int mv_ep_set_halt_wedge(struct usb_ep *_ep, int halt, int wedge)
904 unsigned long flags = 0;
908 ep = container_of(_ep, struct mv_ep, ep);
910 if (!_ep || !ep->desc) {
915 if (ep->desc->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
916 status = -EOPNOTSUPP;
921 * Attempt to halt IN ep will fail if any transfer requests
924 if (halt && (ep_dir(ep) == EP_DIR_IN) && !list_empty(&ep->queue)) {
929 spin_lock_irqsave(&ep->udc->lock, flags);
930 ep_set_stall(udc, ep->ep_num, ep_dir(ep), halt);
935 spin_unlock_irqrestore(&ep->udc->lock, flags);
937 if (ep->ep_num == 0) {
938 udc->ep0_state = WAIT_FOR_SETUP;
939 udc->ep0_dir = EP_DIR_OUT;
945 static int mv_ep_set_halt(struct usb_ep *_ep, int halt)
947 return mv_ep_set_halt_wedge(_ep, halt, 0);
950 static int mv_ep_set_wedge(struct usb_ep *_ep)
952 return mv_ep_set_halt_wedge(_ep, 1, 1);
955 static struct usb_ep_ops mv_ep_ops = {
956 .enable = mv_ep_enable,
957 .disable = mv_ep_disable,
959 .alloc_request = mv_alloc_request,
960 .free_request = mv_free_request,
962 .queue = mv_ep_queue,
963 .dequeue = mv_ep_dequeue,
965 .set_wedge = mv_ep_set_wedge,
966 .set_halt = mv_ep_set_halt,
967 .fifo_flush = mv_ep_fifo_flush, /* flush fifo */
970 static void udc_clock_enable(struct mv_udc *udc)
974 for (i = 0; i < udc->clknum; i++)
975 clk_enable(udc->clk[i]);
978 static void udc_clock_disable(struct mv_udc *udc)
982 for (i = 0; i < udc->clknum; i++)
983 clk_disable(udc->clk[i]);
986 static void udc_stop(struct mv_udc *udc)
990 /* Disable interrupts */
991 tmp = readl(&udc->op_regs->usbintr);
992 tmp &= ~(USBINTR_INT_EN | USBINTR_ERR_INT_EN |
993 USBINTR_PORT_CHANGE_DETECT_EN | USBINTR_RESET_EN);
994 writel(tmp, &udc->op_regs->usbintr);
998 /* Reset the Run the bit in the command register to stop VUSB */
999 tmp = readl(&udc->op_regs->usbcmd);
1000 tmp &= ~USBCMD_RUN_STOP;
1001 writel(tmp, &udc->op_regs->usbcmd);
1004 static void udc_start(struct mv_udc *udc)
1008 usbintr = USBINTR_INT_EN | USBINTR_ERR_INT_EN
1009 | USBINTR_PORT_CHANGE_DETECT_EN
1010 | USBINTR_RESET_EN | USBINTR_DEVICE_SUSPEND;
1011 /* Enable interrupts */
1012 writel(usbintr, &udc->op_regs->usbintr);
1016 /* Set the Run bit in the command register */
1017 writel(USBCMD_RUN_STOP, &udc->op_regs->usbcmd);
1020 static int udc_reset(struct mv_udc *udc)
1025 /* Stop the controller */
1026 tmp = readl(&udc->op_regs->usbcmd);
1027 tmp &= ~USBCMD_RUN_STOP;
1028 writel(tmp, &udc->op_regs->usbcmd);
1030 /* Reset the controller to get default values */
1031 writel(USBCMD_CTRL_RESET, &udc->op_regs->usbcmd);
1033 /* wait for reset to complete */
1034 loops = LOOPS(RESET_TIMEOUT);
1035 while (readl(&udc->op_regs->usbcmd) & USBCMD_CTRL_RESET) {
1037 dev_err(&udc->dev->dev,
1038 "Wait for RESET completed TIMEOUT\n");
1045 /* set controller to device mode */
1046 tmp = readl(&udc->op_regs->usbmode);
1047 tmp |= USBMODE_CTRL_MODE_DEVICE;
1049 /* turn setup lockout off, require setup tripwire in usbcmd */
1050 tmp |= USBMODE_SETUP_LOCK_OFF | USBMODE_STREAM_DISABLE;
1052 writel(tmp, &udc->op_regs->usbmode);
1054 writel(0x0, &udc->op_regs->epsetupstat);
1056 /* Configure the Endpoint List Address */
1057 writel(udc->ep_dqh_dma & USB_EP_LIST_ADDRESS_MASK,
1058 &udc->op_regs->eplistaddr);
1060 portsc = readl(&udc->op_regs->portsc[0]);
1061 if (readl(&udc->cap_regs->hcsparams) & HCSPARAMS_PPC)
1062 portsc &= (~PORTSCX_W1C_BITS | ~PORTSCX_PORT_POWER);
1065 portsc |= PORTSCX_FORCE_FULL_SPEED_CONNECT;
1067 portsc &= (~PORTSCX_FORCE_FULL_SPEED_CONNECT);
1069 writel(portsc, &udc->op_regs->portsc[0]);
1071 tmp = readl(&udc->op_regs->epctrlx[0]);
1072 tmp &= ~(EPCTRL_TX_EP_STALL | EPCTRL_RX_EP_STALL);
1073 writel(tmp, &udc->op_regs->epctrlx[0]);
1078 static int mv_udc_enable_internal(struct mv_udc *udc)
1085 dev_dbg(&udc->dev->dev, "enable udc\n");
1086 udc_clock_enable(udc);
1087 if (udc->pdata->phy_init) {
1088 retval = udc->pdata->phy_init(udc->phy_regs);
1090 dev_err(&udc->dev->dev,
1091 "init phy error %d\n", retval);
1092 udc_clock_disable(udc);
1101 static int mv_udc_enable(struct mv_udc *udc)
1103 if (udc->clock_gating)
1104 return mv_udc_enable_internal(udc);
1109 static void mv_udc_disable_internal(struct mv_udc *udc)
1112 dev_dbg(&udc->dev->dev, "disable udc\n");
1113 if (udc->pdata->phy_deinit)
1114 udc->pdata->phy_deinit(udc->phy_regs);
1115 udc_clock_disable(udc);
1120 static void mv_udc_disable(struct mv_udc *udc)
1122 if (udc->clock_gating)
1123 mv_udc_disable_internal(udc);
1126 static int mv_udc_get_frame(struct usb_gadget *gadget)
1134 udc = container_of(gadget, struct mv_udc, gadget);
1136 retval = readl(&udc->op_regs->frindex) & USB_FRINDEX_MASKS;
1141 /* Tries to wake up the host connected to this gadget */
1142 static int mv_udc_wakeup(struct usb_gadget *gadget)
1144 struct mv_udc *udc = container_of(gadget, struct mv_udc, gadget);
1147 /* Remote wakeup feature not enabled by host */
1148 if (!udc->remote_wakeup)
1151 portsc = readl(&udc->op_regs->portsc);
1152 /* not suspended? */
1153 if (!(portsc & PORTSCX_PORT_SUSPEND))
1155 /* trigger force resume */
1156 portsc |= PORTSCX_PORT_FORCE_RESUME;
1157 writel(portsc, &udc->op_regs->portsc[0]);
1161 static int mv_udc_vbus_session(struct usb_gadget *gadget, int is_active)
1164 unsigned long flags;
1167 udc = container_of(gadget, struct mv_udc, gadget);
1168 spin_lock_irqsave(&udc->lock, flags);
1170 udc->vbus_active = (is_active != 0);
1172 dev_dbg(&udc->dev->dev, "%s: softconnect %d, vbus_active %d\n",
1173 __func__, udc->softconnect, udc->vbus_active);
1175 if (udc->driver && udc->softconnect && udc->vbus_active) {
1176 retval = mv_udc_enable(udc);
1178 /* Clock is disabled, need re-init registers */
1183 } else if (udc->driver && udc->softconnect) {
1184 /* stop all the transfer in queue*/
1185 stop_activity(udc, udc->driver);
1187 mv_udc_disable(udc);
1190 spin_unlock_irqrestore(&udc->lock, flags);
1194 static int mv_udc_pullup(struct usb_gadget *gadget, int is_on)
1197 unsigned long flags;
1200 udc = container_of(gadget, struct mv_udc, gadget);
1201 spin_lock_irqsave(&udc->lock, flags);
1203 udc->softconnect = (is_on != 0);
1205 dev_dbg(&udc->dev->dev, "%s: softconnect %d, vbus_active %d\n",
1206 __func__, udc->softconnect, udc->vbus_active);
1208 if (udc->driver && udc->softconnect && udc->vbus_active) {
1209 retval = mv_udc_enable(udc);
1211 /* Clock is disabled, need re-init registers */
1216 } else if (udc->driver && udc->vbus_active) {
1217 /* stop all the transfer in queue*/
1218 stop_activity(udc, udc->driver);
1220 mv_udc_disable(udc);
1223 spin_unlock_irqrestore(&udc->lock, flags);
1227 static int mv_udc_start(struct usb_gadget_driver *driver,
1228 int (*bind)(struct usb_gadget *));
1229 static int mv_udc_stop(struct usb_gadget_driver *driver);
1230 /* device controller usb_gadget_ops structure */
1231 static const struct usb_gadget_ops mv_ops = {
1233 /* returns the current frame number */
1234 .get_frame = mv_udc_get_frame,
1236 /* tries to wake up the host connected to this gadget */
1237 .wakeup = mv_udc_wakeup,
1239 /* notify controller that VBUS is powered or not */
1240 .vbus_session = mv_udc_vbus_session,
1242 /* D+ pullup, software-controlled connect/disconnect to USB host */
1243 .pullup = mv_udc_pullup,
1244 .start = mv_udc_start,
1245 .stop = mv_udc_stop,
1248 static int eps_init(struct mv_udc *udc)
1254 /* initialize ep0 */
1257 strncpy(ep->name, "ep0", sizeof(ep->name));
1258 ep->ep.name = ep->name;
1259 ep->ep.ops = &mv_ep_ops;
1262 ep->ep.maxpacket = EP0_MAX_PKT_SIZE;
1264 ep->desc = &mv_ep0_desc;
1265 INIT_LIST_HEAD(&ep->queue);
1267 ep->ep_type = USB_ENDPOINT_XFER_CONTROL;
1269 /* initialize other endpoints */
1270 for (i = 2; i < udc->max_eps * 2; i++) {
1273 snprintf(name, sizeof(name), "ep%din", i / 2);
1274 ep->direction = EP_DIR_IN;
1276 snprintf(name, sizeof(name), "ep%dout", i / 2);
1277 ep->direction = EP_DIR_OUT;
1280 strncpy(ep->name, name, sizeof(ep->name));
1281 ep->ep.name = ep->name;
1283 ep->ep.ops = &mv_ep_ops;
1285 ep->ep.maxpacket = (unsigned short) ~0;
1288 INIT_LIST_HEAD(&ep->queue);
1289 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
1291 ep->dqh = &udc->ep_dqh[i];
1297 /* delete all endpoint requests, called with spinlock held */
1298 static void nuke(struct mv_ep *ep, int status)
1300 /* called with spinlock held */
1303 /* endpoint fifo flush */
1304 mv_ep_fifo_flush(&ep->ep);
1306 while (!list_empty(&ep->queue)) {
1307 struct mv_req *req = NULL;
1308 req = list_entry(ep->queue.next, struct mv_req, queue);
1309 done(ep, req, status);
1313 /* stop all USB activities */
1314 static void stop_activity(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 disconnect; the driver is already quiesced */
1326 spin_unlock(&udc->lock);
1327 driver->disconnect(&udc->gadget);
1328 spin_lock(&udc->lock);
1332 static int mv_udc_start(struct usb_gadget_driver *driver,
1333 int (*bind)(struct usb_gadget *))
1335 struct mv_udc *udc = the_controller;
1337 unsigned long flags;
1345 spin_lock_irqsave(&udc->lock, flags);
1347 /* hook up the driver ... */
1348 driver->driver.bus = NULL;
1349 udc->driver = driver;
1350 udc->gadget.dev.driver = &driver->driver;
1352 udc->usb_state = USB_STATE_ATTACHED;
1353 udc->ep0_state = WAIT_FOR_SETUP;
1354 udc->ep0_dir = EP_DIR_OUT;
1356 spin_unlock_irqrestore(&udc->lock, flags);
1358 retval = bind(&udc->gadget);
1360 dev_err(&udc->dev->dev, "bind to driver %s --> %d\n",
1361 driver->driver.name, retval);
1363 udc->gadget.dev.driver = NULL;
1367 if (udc->transceiver) {
1368 retval = otg_set_peripheral(udc->transceiver, &udc->gadget);
1370 dev_err(&udc->dev->dev,
1371 "unable to register peripheral to otg\n");
1372 if (driver->unbind) {
1373 driver->unbind(&udc->gadget);
1374 udc->gadget.dev.driver = NULL;
1381 /* pullup is always on */
1382 mv_udc_pullup(&udc->gadget, 1);
1384 /* When boot with cable attached, there will be no vbus irq occurred */
1386 queue_work(udc->qwork, &udc->vbus_work);
1391 static int mv_udc_stop(struct usb_gadget_driver *driver)
1393 struct mv_udc *udc = the_controller;
1394 unsigned long flags;
1399 spin_lock_irqsave(&udc->lock, flags);
1404 /* stop all usb activities */
1405 udc->gadget.speed = USB_SPEED_UNKNOWN;
1406 stop_activity(udc, driver);
1407 mv_udc_disable(udc);
1409 spin_unlock_irqrestore(&udc->lock, flags);
1411 /* unbind gadget driver */
1412 driver->unbind(&udc->gadget);
1413 udc->gadget.dev.driver = NULL;
1419 static void mv_set_ptc(struct mv_udc *udc, u32 mode)
1423 portsc = readl(&udc->op_regs->portsc[0]);
1424 portsc |= mode << 16;
1425 writel(portsc, &udc->op_regs->portsc[0]);
1428 static void prime_status_complete(struct usb_ep *ep, struct usb_request *_req)
1430 struct mv_udc *udc = the_controller;
1431 struct mv_req *req = container_of(_req, struct mv_req, req);
1432 unsigned long flags;
1434 dev_info(&udc->dev->dev, "switch to test mode %d\n", req->test_mode);
1436 spin_lock_irqsave(&udc->lock, flags);
1437 if (req->test_mode) {
1438 mv_set_ptc(udc, req->test_mode);
1441 spin_unlock_irqrestore(&udc->lock, flags);
1445 udc_prime_status(struct mv_udc *udc, u8 direction, u16 status, bool empty)
1452 udc->ep0_dir = direction;
1453 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1455 req = udc->status_req;
1457 /* fill in the reqest structure */
1458 if (empty == false) {
1459 *((u16 *) req->req.buf) = cpu_to_le16(status);
1460 req->req.length = 2;
1462 req->req.length = 0;
1465 req->req.status = -EINPROGRESS;
1466 req->req.actual = 0;
1467 if (udc->test_mode) {
1468 req->req.complete = prime_status_complete;
1469 req->test_mode = udc->test_mode;
1472 req->req.complete = NULL;
1475 if (req->req.dma == DMA_ADDR_INVALID) {
1476 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1477 req->req.buf, req->req.length,
1478 ep_dir(ep) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1482 /* prime the data phase */
1483 if (!req_to_dtd(req))
1484 retval = queue_dtd(ep, req);
1491 dev_err(&udc->dev->dev, "response error on GET_STATUS request\n");
1495 list_add_tail(&req->queue, &ep->queue);
1502 static void mv_udc_testmode(struct mv_udc *udc, u16 index)
1504 if (index <= TEST_FORCE_EN) {
1505 udc->test_mode = index;
1506 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1509 dev_err(&udc->dev->dev,
1510 "This test mode(%d) is not supported\n", index);
1513 static void ch9setaddress(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1515 udc->dev_addr = (u8)setup->wValue;
1517 /* update usb state */
1518 udc->usb_state = USB_STATE_ADDRESS;
1520 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1524 static void ch9getstatus(struct mv_udc *udc, u8 ep_num,
1525 struct usb_ctrlrequest *setup)
1530 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
1531 != (USB_DIR_IN | USB_TYPE_STANDARD))
1534 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1535 status = 1 << USB_DEVICE_SELF_POWERED;
1536 status |= udc->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP;
1537 } else if ((setup->bRequestType & USB_RECIP_MASK)
1538 == USB_RECIP_INTERFACE) {
1539 /* get interface status */
1541 } else if ((setup->bRequestType & USB_RECIP_MASK)
1542 == USB_RECIP_ENDPOINT) {
1543 u8 ep_num, direction;
1545 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1546 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1547 ? EP_DIR_IN : EP_DIR_OUT;
1548 status = ep_is_stall(udc, ep_num, direction)
1549 << USB_ENDPOINT_HALT;
1552 retval = udc_prime_status(udc, EP_DIR_IN, status, false);
1556 udc->ep0_state = DATA_STATE_XMIT;
1559 static void ch9clearfeature(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1565 if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1566 == ((USB_TYPE_STANDARD | USB_RECIP_DEVICE))) {
1567 switch (setup->wValue) {
1568 case USB_DEVICE_REMOTE_WAKEUP:
1569 udc->remote_wakeup = 0;
1574 } else if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1575 == ((USB_TYPE_STANDARD | USB_RECIP_ENDPOINT))) {
1576 switch (setup->wValue) {
1577 case USB_ENDPOINT_HALT:
1578 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1579 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1580 ? EP_DIR_IN : EP_DIR_OUT;
1581 if (setup->wValue != 0 || setup->wLength != 0
1582 || ep_num > udc->max_eps)
1584 ep = &udc->eps[ep_num * 2 + direction];
1587 spin_unlock(&udc->lock);
1588 ep_set_stall(udc, ep_num, direction, 0);
1589 spin_lock(&udc->lock);
1597 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1603 static void ch9setfeature(struct mv_udc *udc, struct usb_ctrlrequest *setup)
1608 if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1609 == ((USB_TYPE_STANDARD | USB_RECIP_DEVICE))) {
1610 switch (setup->wValue) {
1611 case USB_DEVICE_REMOTE_WAKEUP:
1612 udc->remote_wakeup = 1;
1614 case USB_DEVICE_TEST_MODE:
1615 if (setup->wIndex & 0xFF
1616 || udc->gadget.speed != USB_SPEED_HIGH)
1619 if (udc->usb_state != USB_STATE_CONFIGURED
1620 && udc->usb_state != USB_STATE_ADDRESS
1621 && udc->usb_state != USB_STATE_DEFAULT)
1624 mv_udc_testmode(udc, (setup->wIndex >> 8));
1629 } else if ((setup->bRequestType & (USB_TYPE_MASK | USB_RECIP_MASK))
1630 == ((USB_TYPE_STANDARD | USB_RECIP_ENDPOINT))) {
1631 switch (setup->wValue) {
1632 case USB_ENDPOINT_HALT:
1633 ep_num = setup->wIndex & USB_ENDPOINT_NUMBER_MASK;
1634 direction = (setup->wIndex & USB_ENDPOINT_DIR_MASK)
1635 ? EP_DIR_IN : EP_DIR_OUT;
1636 if (setup->wValue != 0 || setup->wLength != 0
1637 || ep_num > udc->max_eps)
1639 spin_unlock(&udc->lock);
1640 ep_set_stall(udc, ep_num, direction, 1);
1641 spin_lock(&udc->lock);
1649 if (udc_prime_status(udc, EP_DIR_IN, 0, true))
1655 static void handle_setup_packet(struct mv_udc *udc, u8 ep_num,
1656 struct usb_ctrlrequest *setup)
1658 bool delegate = false;
1660 nuke(&udc->eps[ep_num * 2 + EP_DIR_OUT], -ESHUTDOWN);
1662 dev_dbg(&udc->dev->dev, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1663 setup->bRequestType, setup->bRequest,
1664 setup->wValue, setup->wIndex, setup->wLength);
1665 /* We process some stardard setup requests here */
1666 if ((setup->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD) {
1667 switch (setup->bRequest) {
1668 case USB_REQ_GET_STATUS:
1669 ch9getstatus(udc, ep_num, setup);
1672 case USB_REQ_SET_ADDRESS:
1673 ch9setaddress(udc, setup);
1676 case USB_REQ_CLEAR_FEATURE:
1677 ch9clearfeature(udc, setup);
1680 case USB_REQ_SET_FEATURE:
1681 ch9setfeature(udc, setup);
1690 /* delegate USB standard requests to the gadget driver */
1691 if (delegate == true) {
1692 /* USB requests handled by gadget */
1693 if (setup->wLength) {
1694 /* DATA phase from gadget, STATUS phase from udc */
1695 udc->ep0_dir = (setup->bRequestType & USB_DIR_IN)
1696 ? EP_DIR_IN : EP_DIR_OUT;
1697 spin_unlock(&udc->lock);
1698 if (udc->driver->setup(&udc->gadget,
1699 &udc->local_setup_buff) < 0)
1701 spin_lock(&udc->lock);
1702 udc->ep0_state = (setup->bRequestType & USB_DIR_IN)
1703 ? DATA_STATE_XMIT : DATA_STATE_RECV;
1705 /* no DATA phase, IN STATUS phase from gadget */
1706 udc->ep0_dir = EP_DIR_IN;
1707 spin_unlock(&udc->lock);
1708 if (udc->driver->setup(&udc->gadget,
1709 &udc->local_setup_buff) < 0)
1711 spin_lock(&udc->lock);
1712 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1717 /* complete DATA or STATUS phase of ep0 prime status phase if needed */
1718 static void ep0_req_complete(struct mv_udc *udc,
1719 struct mv_ep *ep0, struct mv_req *req)
1723 if (udc->usb_state == USB_STATE_ADDRESS) {
1724 /* set the new address */
1725 new_addr = (u32)udc->dev_addr;
1726 writel(new_addr << USB_DEVICE_ADDRESS_BIT_SHIFT,
1727 &udc->op_regs->deviceaddr);
1732 switch (udc->ep0_state) {
1733 case DATA_STATE_XMIT:
1734 /* receive status phase */
1735 if (udc_prime_status(udc, EP_DIR_OUT, 0, true))
1738 case DATA_STATE_RECV:
1739 /* send status phase */
1740 if (udc_prime_status(udc, EP_DIR_IN, 0 , true))
1743 case WAIT_FOR_OUT_STATUS:
1744 udc->ep0_state = WAIT_FOR_SETUP;
1746 case WAIT_FOR_SETUP:
1747 dev_err(&udc->dev->dev, "unexpect ep0 packets\n");
1755 static void get_setup_data(struct mv_udc *udc, u8 ep_num, u8 *buffer_ptr)
1760 dqh = &udc->ep_dqh[ep_num * 2 + EP_DIR_OUT];
1762 /* Clear bit in ENDPTSETUPSTAT */
1763 writel((1 << ep_num), &udc->op_regs->epsetupstat);
1765 /* while a hazard exists when setup package arrives */
1767 /* Set Setup Tripwire */
1768 temp = readl(&udc->op_regs->usbcmd);
1769 writel(temp | USBCMD_SETUP_TRIPWIRE_SET, &udc->op_regs->usbcmd);
1771 /* Copy the setup packet to local buffer */
1772 memcpy(buffer_ptr, (u8 *) dqh->setup_buffer, 8);
1773 } while (!(readl(&udc->op_regs->usbcmd) & USBCMD_SETUP_TRIPWIRE_SET));
1775 /* Clear Setup Tripwire */
1776 temp = readl(&udc->op_regs->usbcmd);
1777 writel(temp & ~USBCMD_SETUP_TRIPWIRE_SET, &udc->op_regs->usbcmd);
1780 static void irq_process_tr_complete(struct mv_udc *udc)
1783 int i, ep_num = 0, direction = 0;
1784 struct mv_ep *curr_ep;
1785 struct mv_req *curr_req, *temp_req;
1789 * We use separate loops for ENDPTSETUPSTAT and ENDPTCOMPLETE
1790 * because the setup packets are to be read ASAP
1793 /* Process all Setup packet received interrupts */
1794 tmp = readl(&udc->op_regs->epsetupstat);
1797 for (i = 0; i < udc->max_eps; i++) {
1798 if (tmp & (1 << i)) {
1799 get_setup_data(udc, i,
1800 (u8 *)(&udc->local_setup_buff));
1801 handle_setup_packet(udc, i,
1802 &udc->local_setup_buff);
1807 /* Don't clear the endpoint setup status register here.
1808 * It is cleared as a setup packet is read out of the buffer
1811 /* Process non-setup transaction complete interrupts */
1812 tmp = readl(&udc->op_regs->epcomplete);
1817 writel(tmp, &udc->op_regs->epcomplete);
1819 for (i = 0; i < udc->max_eps * 2; i++) {
1823 bit_pos = 1 << (ep_num + 16 * direction);
1825 if (!(bit_pos & tmp))
1829 curr_ep = &udc->eps[0];
1831 curr_ep = &udc->eps[i];
1832 /* process the req queue until an uncomplete request */
1833 list_for_each_entry_safe(curr_req, temp_req,
1834 &curr_ep->queue, queue) {
1835 status = process_ep_req(udc, i, curr_req);
1839 /* write back status to req */
1840 curr_req->req.status = status;
1842 /* ep0 request completion */
1844 ep0_req_complete(udc, curr_ep, curr_req);
1847 done(curr_ep, curr_req, status);
1853 void irq_process_reset(struct mv_udc *udc)
1858 udc->ep0_dir = EP_DIR_OUT;
1859 udc->ep0_state = WAIT_FOR_SETUP;
1860 udc->remote_wakeup = 0; /* default to 0 on reset */
1862 /* The address bits are past bit 25-31. Set the address */
1863 tmp = readl(&udc->op_regs->deviceaddr);
1864 tmp &= ~(USB_DEVICE_ADDRESS_MASK);
1865 writel(tmp, &udc->op_regs->deviceaddr);
1867 /* Clear all the setup token semaphores */
1868 tmp = readl(&udc->op_regs->epsetupstat);
1869 writel(tmp, &udc->op_regs->epsetupstat);
1871 /* Clear all the endpoint complete status bits */
1872 tmp = readl(&udc->op_regs->epcomplete);
1873 writel(tmp, &udc->op_regs->epcomplete);
1875 /* wait until all endptprime bits cleared */
1876 loops = LOOPS(PRIME_TIMEOUT);
1877 while (readl(&udc->op_regs->epprime) & 0xFFFFFFFF) {
1879 dev_err(&udc->dev->dev,
1880 "Timeout for ENDPTPRIME = 0x%x\n",
1881 readl(&udc->op_regs->epprime));
1888 /* Write 1s to the Flush register */
1889 writel((u32)~0, &udc->op_regs->epflush);
1891 if (readl(&udc->op_regs->portsc[0]) & PORTSCX_PORT_RESET) {
1892 dev_info(&udc->dev->dev, "usb bus reset\n");
1893 udc->usb_state = USB_STATE_DEFAULT;
1894 /* reset all the queues, stop all USB activities */
1895 stop_activity(udc, udc->driver);
1897 dev_info(&udc->dev->dev, "USB reset portsc 0x%x\n",
1898 readl(&udc->op_regs->portsc));
1906 /* reset all the queues, stop all USB activities */
1907 stop_activity(udc, udc->driver);
1909 /* reset ep0 dQH and endptctrl */
1912 /* enable interrupt and set controller to run state */
1915 udc->usb_state = USB_STATE_ATTACHED;
1919 static void handle_bus_resume(struct mv_udc *udc)
1921 udc->usb_state = udc->resume_state;
1922 udc->resume_state = 0;
1924 /* report resume to the driver */
1926 if (udc->driver->resume) {
1927 spin_unlock(&udc->lock);
1928 udc->driver->resume(&udc->gadget);
1929 spin_lock(&udc->lock);
1934 static void irq_process_suspend(struct mv_udc *udc)
1936 udc->resume_state = udc->usb_state;
1937 udc->usb_state = USB_STATE_SUSPENDED;
1939 if (udc->driver->suspend) {
1940 spin_unlock(&udc->lock);
1941 udc->driver->suspend(&udc->gadget);
1942 spin_lock(&udc->lock);
1946 static void irq_process_port_change(struct mv_udc *udc)
1950 portsc = readl(&udc->op_regs->portsc[0]);
1951 if (!(portsc & PORTSCX_PORT_RESET)) {
1953 u32 speed = portsc & PORTSCX_PORT_SPEED_MASK;
1955 case PORTSCX_PORT_SPEED_HIGH:
1956 udc->gadget.speed = USB_SPEED_HIGH;
1958 case PORTSCX_PORT_SPEED_FULL:
1959 udc->gadget.speed = USB_SPEED_FULL;
1961 case PORTSCX_PORT_SPEED_LOW:
1962 udc->gadget.speed = USB_SPEED_LOW;
1965 udc->gadget.speed = USB_SPEED_UNKNOWN;
1970 if (portsc & PORTSCX_PORT_SUSPEND) {
1971 udc->resume_state = udc->usb_state;
1972 udc->usb_state = USB_STATE_SUSPENDED;
1973 if (udc->driver->suspend) {
1974 spin_unlock(&udc->lock);
1975 udc->driver->suspend(&udc->gadget);
1976 spin_lock(&udc->lock);
1980 if (!(portsc & PORTSCX_PORT_SUSPEND)
1981 && udc->usb_state == USB_STATE_SUSPENDED) {
1982 handle_bus_resume(udc);
1985 if (!udc->resume_state)
1986 udc->usb_state = USB_STATE_DEFAULT;
1989 static void irq_process_error(struct mv_udc *udc)
1991 /* Increment the error count */
1995 static irqreturn_t mv_udc_irq(int irq, void *dev)
1997 struct mv_udc *udc = (struct mv_udc *)dev;
2000 /* Disable ISR when stopped bit is set */
2004 spin_lock(&udc->lock);
2006 status = readl(&udc->op_regs->usbsts);
2007 intr = readl(&udc->op_regs->usbintr);
2011 spin_unlock(&udc->lock);
2015 /* Clear all the interrupts occurred */
2016 writel(status, &udc->op_regs->usbsts);
2018 if (status & USBSTS_ERR)
2019 irq_process_error(udc);
2021 if (status & USBSTS_RESET)
2022 irq_process_reset(udc);
2024 if (status & USBSTS_PORT_CHANGE)
2025 irq_process_port_change(udc);
2027 if (status & USBSTS_INT)
2028 irq_process_tr_complete(udc);
2030 if (status & USBSTS_SUSPEND)
2031 irq_process_suspend(udc);
2033 spin_unlock(&udc->lock);
2038 static irqreturn_t mv_udc_vbus_irq(int irq, void *dev)
2040 struct mv_udc *udc = (struct mv_udc *)dev;
2042 /* polling VBUS and init phy may cause too much time*/
2044 queue_work(udc->qwork, &udc->vbus_work);
2049 static void mv_udc_vbus_work(struct work_struct *work)
2054 udc = container_of(work, struct mv_udc, vbus_work);
2055 if (!udc->pdata->vbus)
2058 vbus = udc->pdata->vbus->poll();
2059 dev_info(&udc->dev->dev, "vbus is %d\n", vbus);
2061 if (vbus == VBUS_HIGH)
2062 mv_udc_vbus_session(&udc->gadget, 1);
2063 else if (vbus == VBUS_LOW)
2064 mv_udc_vbus_session(&udc->gadget, 0);
2067 /* release device structure */
2068 static void gadget_release(struct device *_dev)
2070 struct mv_udc *udc = the_controller;
2072 complete(udc->done);
2075 static int __devexit mv_udc_remove(struct platform_device *dev)
2077 struct mv_udc *udc = the_controller;
2080 usb_del_gadget_udc(&udc->gadget);
2083 flush_workqueue(udc->qwork);
2084 destroy_workqueue(udc->qwork);
2088 * If we have transceiver inited,
2089 * then vbus irq will not be requested in udc driver.
2091 if (udc->pdata && udc->pdata->vbus
2092 && udc->clock_gating && udc->transceiver == NULL)
2093 free_irq(udc->pdata->vbus->irq, &dev->dev);
2095 /* free memory allocated in probe */
2097 dma_pool_destroy(udc->dtd_pool);
2100 dma_free_coherent(&dev->dev, udc->ep_dqh_size,
2101 udc->ep_dqh, udc->ep_dqh_dma);
2106 free_irq(udc->irq, &dev->dev);
2108 mv_udc_disable(udc);
2111 iounmap(udc->cap_regs);
2112 udc->cap_regs = NULL;
2115 iounmap((void *)udc->phy_regs);
2118 if (udc->status_req) {
2119 kfree(udc->status_req->req.buf);
2120 kfree(udc->status_req);
2123 for (clk_i = 0; clk_i <= udc->clknum; clk_i++)
2124 clk_put(udc->clk[clk_i]);
2126 device_unregister(&udc->gadget.dev);
2128 /* free dev, wait for the release() finished */
2129 wait_for_completion(udc->done);
2132 the_controller = NULL;
2137 static int __devinit mv_udc_probe(struct platform_device *dev)
2139 struct mv_usb_platform_data *pdata = dev->dev.platform_data;
2146 if (pdata == NULL) {
2147 dev_err(&dev->dev, "missing platform_data\n");
2151 size = sizeof(*udc) + sizeof(struct clk *) * pdata->clknum;
2152 udc = kzalloc(size, GFP_KERNEL);
2154 dev_err(&dev->dev, "failed to allocate memory for udc\n");
2158 the_controller = udc;
2159 udc->done = &release_done;
2160 udc->pdata = dev->dev.platform_data;
2161 spin_lock_init(&udc->lock);
2165 #ifdef CONFIG_USB_OTG_UTILS
2166 if (pdata->mode == MV_USB_MODE_OTG)
2167 udc->transceiver = otg_get_transceiver();
2170 udc->clknum = pdata->clknum;
2171 for (clk_i = 0; clk_i < udc->clknum; clk_i++) {
2172 udc->clk[clk_i] = clk_get(&dev->dev, pdata->clkname[clk_i]);
2173 if (IS_ERR(udc->clk[clk_i])) {
2174 retval = PTR_ERR(udc->clk[clk_i]);
2179 r = platform_get_resource_byname(udc->dev, IORESOURCE_MEM, "capregs");
2181 dev_err(&dev->dev, "no I/O memory resource defined\n");
2186 udc->cap_regs = (struct mv_cap_regs __iomem *)
2187 ioremap(r->start, resource_size(r));
2188 if (udc->cap_regs == NULL) {
2189 dev_err(&dev->dev, "failed to map I/O memory\n");
2194 r = platform_get_resource_byname(udc->dev, IORESOURCE_MEM, "phyregs");
2196 dev_err(&dev->dev, "no phy I/O memory resource defined\n");
2198 goto err_iounmap_capreg;
2201 udc->phy_regs = (unsigned int)ioremap(r->start, resource_size(r));
2202 if (udc->phy_regs == 0) {
2203 dev_err(&dev->dev, "failed to map phy I/O memory\n");
2205 goto err_iounmap_capreg;
2208 /* we will acces controller register, so enable the clk */
2209 retval = mv_udc_enable_internal(udc);
2211 goto err_iounmap_phyreg;
2213 udc->op_regs = (struct mv_op_regs __iomem *)((u32)udc->cap_regs
2214 + (readl(&udc->cap_regs->caplength_hciversion)
2216 udc->max_eps = readl(&udc->cap_regs->dccparams) & DCCPARAMS_DEN_MASK;
2219 * some platform will use usb to download image, it may not disconnect
2220 * usb gadget before loading kernel. So first stop udc here.
2223 writel(0xFFFFFFFF, &udc->op_regs->usbsts);
2225 size = udc->max_eps * sizeof(struct mv_dqh) *2;
2226 size = (size + DQH_ALIGNMENT - 1) & ~(DQH_ALIGNMENT - 1);
2227 udc->ep_dqh = dma_alloc_coherent(&dev->dev, size,
2228 &udc->ep_dqh_dma, GFP_KERNEL);
2230 if (udc->ep_dqh == NULL) {
2231 dev_err(&dev->dev, "allocate dQH memory failed\n");
2233 goto err_disable_clock;
2235 udc->ep_dqh_size = size;
2237 /* create dTD dma_pool resource */
2238 udc->dtd_pool = dma_pool_create("mv_dtd",
2240 sizeof(struct mv_dtd),
2244 if (!udc->dtd_pool) {
2249 size = udc->max_eps * sizeof(struct mv_ep) *2;
2250 udc->eps = kzalloc(size, GFP_KERNEL);
2251 if (udc->eps == NULL) {
2252 dev_err(&dev->dev, "allocate ep memory failed\n");
2254 goto err_destroy_dma;
2257 /* initialize ep0 status request structure */
2258 udc->status_req = kzalloc(sizeof(struct mv_req), GFP_KERNEL);
2259 if (!udc->status_req) {
2260 dev_err(&dev->dev, "allocate status_req memory failed\n");
2264 INIT_LIST_HEAD(&udc->status_req->queue);
2266 /* allocate a small amount of memory to get valid address */
2267 udc->status_req->req.buf = kzalloc(8, GFP_KERNEL);
2268 udc->status_req->req.dma = DMA_ADDR_INVALID;
2270 udc->resume_state = USB_STATE_NOTATTACHED;
2271 udc->usb_state = USB_STATE_POWERED;
2272 udc->ep0_dir = EP_DIR_OUT;
2273 udc->remote_wakeup = 0;
2275 r = platform_get_resource(udc->dev, IORESOURCE_IRQ, 0);
2277 dev_err(&dev->dev, "no IRQ resource defined\n");
2279 goto err_free_status_req;
2281 udc->irq = r->start;
2282 if (request_irq(udc->irq, mv_udc_irq,
2283 IRQF_SHARED, driver_name, udc)) {
2284 dev_err(&dev->dev, "Request irq %d for UDC failed\n",
2287 goto err_free_status_req;
2290 /* initialize gadget structure */
2291 udc->gadget.ops = &mv_ops; /* usb_gadget_ops */
2292 udc->gadget.ep0 = &udc->eps[0].ep; /* gadget ep0 */
2293 INIT_LIST_HEAD(&udc->gadget.ep_list); /* ep_list */
2294 udc->gadget.speed = USB_SPEED_UNKNOWN; /* speed */
2295 udc->gadget.max_speed = USB_SPEED_HIGH; /* support dual speed */
2297 /* the "gadget" abstracts/virtualizes the controller */
2298 dev_set_name(&udc->gadget.dev, "gadget");
2299 udc->gadget.dev.parent = &dev->dev;
2300 udc->gadget.dev.dma_mask = dev->dev.dma_mask;
2301 udc->gadget.dev.release = gadget_release;
2302 udc->gadget.name = driver_name; /* gadget name */
2304 retval = device_register(&udc->gadget.dev);
2310 /* VBUS detect: we can disable/enable clock on demand.*/
2311 if (udc->transceiver)
2312 udc->clock_gating = 1;
2313 else if (pdata->vbus) {
2314 udc->clock_gating = 1;
2315 retval = request_threaded_irq(pdata->vbus->irq, NULL,
2316 mv_udc_vbus_irq, IRQF_ONESHOT, "vbus", udc);
2319 "Can not request irq for VBUS, "
2320 "disable clock gating\n");
2321 udc->clock_gating = 0;
2324 udc->qwork = create_singlethread_workqueue("mv_udc_queue");
2326 dev_err(&dev->dev, "cannot create workqueue\n");
2328 goto err_unregister;
2331 INIT_WORK(&udc->vbus_work, mv_udc_vbus_work);
2335 * When clock gating is supported, we can disable clk and phy.
2336 * If not, it means that VBUS detection is not supported, we
2337 * have to enable vbus active all the time to let controller work.
2339 if (udc->clock_gating)
2340 mv_udc_disable_internal(udc);
2342 udc->vbus_active = 1;
2344 retval = usb_add_gadget_udc(&dev->dev, &udc->gadget);
2346 goto err_unregister;
2348 dev_info(&dev->dev, "successful probe UDC device %s clock gating.\n",
2349 udc->clock_gating ? "with" : "without");
2354 if (udc->pdata && udc->pdata->vbus
2355 && udc->clock_gating && udc->transceiver == NULL)
2356 free_irq(pdata->vbus->irq, &dev->dev);
2357 device_unregister(&udc->gadget.dev);
2359 free_irq(udc->irq, &dev->dev);
2360 err_free_status_req:
2361 kfree(udc->status_req->req.buf);
2362 kfree(udc->status_req);
2366 dma_pool_destroy(udc->dtd_pool);
2368 dma_free_coherent(&dev->dev, udc->ep_dqh_size,
2369 udc->ep_dqh, udc->ep_dqh_dma);
2371 mv_udc_disable_internal(udc);
2373 iounmap((void *)udc->phy_regs);
2375 iounmap(udc->cap_regs);
2377 for (clk_i--; clk_i >= 0; clk_i--)
2378 clk_put(udc->clk[clk_i]);
2379 the_controller = NULL;
2385 static int mv_udc_suspend(struct device *_dev)
2387 struct mv_udc *udc = the_controller;
2389 /* if OTG is enabled, the following will be done in OTG driver*/
2390 if (udc->transceiver)
2393 if (udc->pdata->vbus && udc->pdata->vbus->poll)
2394 if (udc->pdata->vbus->poll() == VBUS_HIGH) {
2395 dev_info(&udc->dev->dev, "USB cable is connected!\n");
2400 * only cable is unplugged, udc can suspend.
2401 * So do not care about clock_gating == 1.
2403 if (!udc->clock_gating) {
2406 spin_lock_irq(&udc->lock);
2407 /* stop all usb activities */
2408 stop_activity(udc, udc->driver);
2409 spin_unlock_irq(&udc->lock);
2411 mv_udc_disable_internal(udc);
2417 static int mv_udc_resume(struct device *_dev)
2419 struct mv_udc *udc = the_controller;
2422 /* if OTG is enabled, the following will be done in OTG driver*/
2423 if (udc->transceiver)
2426 if (!udc->clock_gating) {
2427 retval = mv_udc_enable_internal(udc);
2431 if (udc->driver && udc->softconnect) {
2441 static const struct dev_pm_ops mv_udc_pm_ops = {
2442 .suspend = mv_udc_suspend,
2443 .resume = mv_udc_resume,
2447 static void mv_udc_shutdown(struct platform_device *dev)
2449 struct mv_udc *udc = the_controller;
2452 /* reset controller mode to IDLE */
2453 mode = readl(&udc->op_regs->usbmode);
2455 writel(mode, &udc->op_regs->usbmode);
2458 static struct platform_driver udc_driver = {
2459 .probe = mv_udc_probe,
2460 .remove = __exit_p(mv_udc_remove),
2461 .shutdown = mv_udc_shutdown,
2463 .owner = THIS_MODULE,
2466 .pm = &mv_udc_pm_ops,
2470 MODULE_ALIAS("platform:pxa-u2o");
2472 MODULE_DESCRIPTION(DRIVER_DESC);
2473 MODULE_AUTHOR("Chao Xie <chao.xie@marvell.com>");
2474 MODULE_VERSION(DRIVER_VERSION);
2475 MODULE_LICENSE("GPL");
2478 static int __init init(void)
2480 return platform_driver_register(&udc_driver);
2485 static void __exit cleanup(void)
2487 platform_driver_unregister(&udc_driver);
2489 module_exit(cleanup);