2 * Copyright (C) 2004-2007,2011-2012 Freescale Semiconductor, Inc.
5 * Author: Li Yang <leoli@freescale.com>
6 * Jiang Bo <tanya.jiang@freescale.com>
9 * Freescale high-speed USB SOC DR module device controller driver.
10 * This can be found on MPC8349E/MPC8313E/MPC5121E cpus.
11 * The driver is previously named as mpc_udc. Based on bare board
12 * code from Dave Liu and Shlomi Gridish.
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version.
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/ioport.h>
25 #include <linux/types.h>
26 #include <linux/errno.h>
27 #include <linux/err.h>
28 #include <linux/slab.h>
29 #include <linux/init.h>
30 #include <linux/list.h>
31 #include <linux/interrupt.h>
32 #include <linux/proc_fs.h>
34 #include <linux/moduleparam.h>
35 #include <linux/device.h>
36 #include <linux/usb/ch9.h>
37 #include <linux/usb/gadget.h>
38 #include <linux/usb/otg.h>
39 #include <linux/dma-mapping.h>
40 #include <linux/platform_device.h>
41 #include <linux/fsl_devices.h>
42 #include <linux/dmapool.h>
43 #include <linux/delay.h>
44 #include <linux/of_device.h>
46 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
51 #include "fsl_usb2_udc.h"
53 #define DRIVER_DESC "Freescale High-Speed USB SOC Device Controller driver"
54 #define DRIVER_AUTHOR "Li Yang/Jiang Bo"
55 #define DRIVER_VERSION "Apr 20, 2007"
57 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
59 static const char driver_name[] = "fsl-usb2-udc";
60 static const char driver_desc[] = DRIVER_DESC;
62 static struct usb_dr_device *dr_regs;
64 static struct usb_sys_interface *usb_sys_regs;
66 /* it is initialized in probe() */
67 static struct fsl_udc *udc_controller = NULL;
69 static const struct usb_endpoint_descriptor
71 .bLength = USB_DT_ENDPOINT_SIZE,
72 .bDescriptorType = USB_DT_ENDPOINT,
73 .bEndpointAddress = 0,
74 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
75 .wMaxPacketSize = USB_MAX_CTRL_PAYLOAD,
78 static void fsl_ep_fifo_flush(struct usb_ep *_ep);
82 * On some SoCs, the USB controller registers can be big or little endian,
83 * depending on the version of the chip. In order to be able to run the
84 * same kernel binary on 2 different versions of an SoC, the BE/LE decision
85 * must be made at run time. _fsl_readl and fsl_writel are pointers to the
86 * BE or LE readl() and writel() functions, and fsl_readl() and fsl_writel()
87 * call through those pointers. Platform code for SoCs that have BE USB
88 * registers should set pdata->big_endian_mmio flag.
90 * This also applies to controller-to-cpu accessors for the USB descriptors,
91 * since their endianness is also SoC dependant. Platform code for SoCs that
92 * have BE USB descriptors should set pdata->big_endian_desc flag.
94 static u32 _fsl_readl_be(const unsigned __iomem *p)
99 static u32 _fsl_readl_le(const unsigned __iomem *p)
104 static void _fsl_writel_be(u32 v, unsigned __iomem *p)
109 static void _fsl_writel_le(u32 v, unsigned __iomem *p)
114 static u32 (*_fsl_readl)(const unsigned __iomem *p);
115 static void (*_fsl_writel)(u32 v, unsigned __iomem *p);
117 #define fsl_readl(p) (*_fsl_readl)((p))
118 #define fsl_writel(v, p) (*_fsl_writel)((v), (p))
120 static inline void fsl_set_accessors(struct fsl_usb2_platform_data *pdata)
122 if (pdata->big_endian_mmio) {
123 _fsl_readl = _fsl_readl_be;
124 _fsl_writel = _fsl_writel_be;
126 _fsl_readl = _fsl_readl_le;
127 _fsl_writel = _fsl_writel_le;
131 static inline u32 cpu_to_hc32(const u32 x)
133 return udc_controller->pdata->big_endian_desc
134 ? (__force u32)cpu_to_be32(x)
135 : (__force u32)cpu_to_le32(x);
138 static inline u32 hc32_to_cpu(const u32 x)
140 return udc_controller->pdata->big_endian_desc
141 ? be32_to_cpu((__force __be32)x)
142 : le32_to_cpu((__force __le32)x);
144 #else /* !CONFIG_PPC32 */
145 static inline void fsl_set_accessors(struct fsl_usb2_platform_data *pdata) {}
147 #define fsl_readl(addr) readl(addr)
148 #define fsl_writel(val32, addr) writel(val32, addr)
149 #define cpu_to_hc32(x) cpu_to_le32(x)
150 #define hc32_to_cpu(x) le32_to_cpu(x)
151 #endif /* CONFIG_PPC32 */
153 /********************************************************************
154 * Internal Used Function
155 ********************************************************************/
156 /*-----------------------------------------------------------------
157 * done() - retire a request; caller blocked irqs
158 * @status : request status to be set, only works when
159 * request is still in progress.
160 *--------------------------------------------------------------*/
161 static void done(struct fsl_ep *ep, struct fsl_req *req, int status)
163 struct fsl_udc *udc = NULL;
164 unsigned char stopped = ep->stopped;
165 struct ep_td_struct *curr_td, *next_td;
168 udc = (struct fsl_udc *)ep->udc;
169 /* Removed the req from fsl_ep->queue */
170 list_del_init(&req->queue);
172 /* req.status should be set as -EINPROGRESS in ep_queue() */
173 if (req->req.status == -EINPROGRESS)
174 req->req.status = status;
176 status = req->req.status;
178 /* Free dtd for the request */
180 for (j = 0; j < req->dtd_count; j++) {
182 if (j != req->dtd_count - 1) {
183 next_td = curr_td->next_td_virt;
185 dma_pool_free(udc->td_pool, curr_td, curr_td->td_dma);
189 dma_unmap_single(ep->udc->gadget.dev.parent,
190 req->req.dma, req->req.length,
194 req->req.dma = DMA_ADDR_INVALID;
197 dma_sync_single_for_cpu(ep->udc->gadget.dev.parent,
198 req->req.dma, req->req.length,
203 if (status && (status != -ESHUTDOWN))
204 VDBG("complete %s req %p stat %d len %u/%u",
205 ep->ep.name, &req->req, status,
206 req->req.actual, req->req.length);
210 spin_unlock(&ep->udc->lock);
211 /* complete() is from gadget layer,
212 * eg fsg->bulk_in_complete() */
213 if (req->req.complete)
214 req->req.complete(&ep->ep, &req->req);
216 spin_lock(&ep->udc->lock);
217 ep->stopped = stopped;
220 /*-----------------------------------------------------------------
221 * nuke(): delete all requests related to this ep
222 * called with spinlock held
223 *--------------------------------------------------------------*/
224 static void nuke(struct fsl_ep *ep, int status)
229 fsl_ep_fifo_flush(&ep->ep);
231 /* Whether this eq has request linked */
232 while (!list_empty(&ep->queue)) {
233 struct fsl_req *req = NULL;
235 req = list_entry(ep->queue.next, struct fsl_req, queue);
236 done(ep, req, status);
240 /*------------------------------------------------------------------
241 Internal Hardware related function
242 ------------------------------------------------------------------*/
244 static int dr_controller_setup(struct fsl_udc *udc)
246 unsigned int tmp, portctrl, ep_num;
247 unsigned int max_no_of_ep;
249 unsigned long timeout;
251 #define FSL_UDC_RESET_TIMEOUT 1000
253 /* Config PHY interface */
254 portctrl = fsl_readl(&dr_regs->portsc1);
255 portctrl &= ~(PORTSCX_PHY_TYPE_SEL | PORTSCX_PORT_WIDTH);
256 switch (udc->phy_mode) {
257 case FSL_USB2_PHY_ULPI:
258 if (udc->pdata->have_sysif_regs) {
259 if (udc->pdata->controller_ver) {
260 /* controller version 1.6 or above */
261 ctrl = __raw_readl(&usb_sys_regs->control);
262 ctrl &= ~USB_CTRL_UTMI_PHY_EN;
263 ctrl |= USB_CTRL_USB_EN;
264 __raw_writel(ctrl, &usb_sys_regs->control);
267 portctrl |= PORTSCX_PTS_ULPI;
269 case FSL_USB2_PHY_UTMI_WIDE:
270 portctrl |= PORTSCX_PTW_16BIT;
272 case FSL_USB2_PHY_UTMI:
273 if (udc->pdata->have_sysif_regs) {
274 if (udc->pdata->controller_ver) {
275 /* controller version 1.6 or above */
276 ctrl = __raw_readl(&usb_sys_regs->control);
277 ctrl |= (USB_CTRL_UTMI_PHY_EN |
279 __raw_writel(ctrl, &usb_sys_regs->control);
280 mdelay(FSL_UTMI_PHY_DLY); /* Delay for UTMI
281 PHY CLK to become stable - 10ms*/
284 portctrl |= PORTSCX_PTS_UTMI;
286 case FSL_USB2_PHY_SERIAL:
287 portctrl |= PORTSCX_PTS_FSLS;
292 fsl_writel(portctrl, &dr_regs->portsc1);
294 /* Stop and reset the usb controller */
295 tmp = fsl_readl(&dr_regs->usbcmd);
296 tmp &= ~USB_CMD_RUN_STOP;
297 fsl_writel(tmp, &dr_regs->usbcmd);
299 tmp = fsl_readl(&dr_regs->usbcmd);
300 tmp |= USB_CMD_CTRL_RESET;
301 fsl_writel(tmp, &dr_regs->usbcmd);
303 /* Wait for reset to complete */
304 timeout = jiffies + FSL_UDC_RESET_TIMEOUT;
305 while (fsl_readl(&dr_regs->usbcmd) & USB_CMD_CTRL_RESET) {
306 if (time_after(jiffies, timeout)) {
307 ERR("udc reset timeout!\n");
313 /* Set the controller as device mode */
314 tmp = fsl_readl(&dr_regs->usbmode);
315 tmp &= ~USB_MODE_CTRL_MODE_MASK; /* clear mode bits */
316 tmp |= USB_MODE_CTRL_MODE_DEVICE;
317 /* Disable Setup Lockout */
318 tmp |= USB_MODE_SETUP_LOCK_OFF;
321 fsl_writel(tmp, &dr_regs->usbmode);
323 /* Clear the setup status */
324 fsl_writel(0, &dr_regs->usbsts);
326 tmp = udc->ep_qh_dma;
327 tmp &= USB_EP_LIST_ADDRESS_MASK;
328 fsl_writel(tmp, &dr_regs->endpointlistaddr);
330 VDBG("vir[qh_base] is %p phy[qh_base] is 0x%8x reg is 0x%8x",
331 udc->ep_qh, (int)tmp,
332 fsl_readl(&dr_regs->endpointlistaddr));
334 max_no_of_ep = (0x0000001F & fsl_readl(&dr_regs->dccparams));
335 for (ep_num = 1; ep_num < max_no_of_ep; ep_num++) {
336 tmp = fsl_readl(&dr_regs->endptctrl[ep_num]);
337 tmp &= ~(EPCTRL_TX_TYPE | EPCTRL_RX_TYPE);
338 tmp |= (EPCTRL_EP_TYPE_BULK << EPCTRL_TX_EP_TYPE_SHIFT)
339 | (EPCTRL_EP_TYPE_BULK << EPCTRL_RX_EP_TYPE_SHIFT);
340 fsl_writel(tmp, &dr_regs->endptctrl[ep_num]);
342 /* Config control enable i/o output, cpu endian register */
343 #ifndef CONFIG_ARCH_MXC
344 if (udc->pdata->have_sysif_regs) {
345 ctrl = __raw_readl(&usb_sys_regs->control);
346 ctrl |= USB_CTRL_IOENB;
347 __raw_writel(ctrl, &usb_sys_regs->control);
351 #if defined(CONFIG_PPC32) && !defined(CONFIG_NOT_COHERENT_CACHE)
352 /* Turn on cache snooping hardware, since some PowerPC platforms
353 * wholly rely on hardware to deal with cache coherent. */
355 if (udc->pdata->have_sysif_regs) {
356 /* Setup Snooping for all the 4GB space */
357 tmp = SNOOP_SIZE_2GB; /* starts from 0x0, size 2G */
358 __raw_writel(tmp, &usb_sys_regs->snoop1);
359 tmp |= 0x80000000; /* starts from 0x8000000, size 2G */
360 __raw_writel(tmp, &usb_sys_regs->snoop2);
367 /* Enable DR irq and set controller to run state */
368 static void dr_controller_run(struct fsl_udc *udc)
372 /* Enable DR irq reg */
373 temp = USB_INTR_INT_EN | USB_INTR_ERR_INT_EN
374 | USB_INTR_PTC_DETECT_EN | USB_INTR_RESET_EN
375 | USB_INTR_DEVICE_SUSPEND | USB_INTR_SYS_ERR_EN;
377 fsl_writel(temp, &dr_regs->usbintr);
379 /* Clear stopped bit */
382 /* Set the controller as device mode */
383 temp = fsl_readl(&dr_regs->usbmode);
384 temp |= USB_MODE_CTRL_MODE_DEVICE;
385 fsl_writel(temp, &dr_regs->usbmode);
387 /* Set controller to Run */
388 temp = fsl_readl(&dr_regs->usbcmd);
389 temp |= USB_CMD_RUN_STOP;
390 fsl_writel(temp, &dr_regs->usbcmd);
393 static void dr_controller_stop(struct fsl_udc *udc)
397 pr_debug("%s\n", __func__);
399 /* if we're in OTG mode, and the Host is currently using the port,
400 * stop now and don't rip the controller out from under the
403 if (udc->gadget.is_otg) {
404 if (!(fsl_readl(&dr_regs->otgsc) & OTGSC_STS_USB_ID)) {
405 pr_debug("udc: Leaving early\n");
410 /* disable all INTR */
411 fsl_writel(0, &dr_regs->usbintr);
413 /* Set stopped bit for isr */
416 /* disable IO output */
417 /* usb_sys_regs->control = 0; */
419 /* set controller to Stop */
420 tmp = fsl_readl(&dr_regs->usbcmd);
421 tmp &= ~USB_CMD_RUN_STOP;
422 fsl_writel(tmp, &dr_regs->usbcmd);
425 static void dr_ep_setup(unsigned char ep_num, unsigned char dir,
426 unsigned char ep_type)
428 unsigned int tmp_epctrl = 0;
430 tmp_epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
433 tmp_epctrl |= EPCTRL_TX_DATA_TOGGLE_RST;
434 tmp_epctrl |= EPCTRL_TX_ENABLE;
435 tmp_epctrl &= ~EPCTRL_TX_TYPE;
436 tmp_epctrl |= ((unsigned int)(ep_type)
437 << EPCTRL_TX_EP_TYPE_SHIFT);
440 tmp_epctrl |= EPCTRL_RX_DATA_TOGGLE_RST;
441 tmp_epctrl |= EPCTRL_RX_ENABLE;
442 tmp_epctrl &= ~EPCTRL_RX_TYPE;
443 tmp_epctrl |= ((unsigned int)(ep_type)
444 << EPCTRL_RX_EP_TYPE_SHIFT);
447 fsl_writel(tmp_epctrl, &dr_regs->endptctrl[ep_num]);
451 dr_ep_change_stall(unsigned char ep_num, unsigned char dir, int value)
455 tmp_epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
458 /* set the stall bit */
460 tmp_epctrl |= EPCTRL_TX_EP_STALL;
462 tmp_epctrl |= EPCTRL_RX_EP_STALL;
464 /* clear the stall bit and reset data toggle */
466 tmp_epctrl &= ~EPCTRL_TX_EP_STALL;
467 tmp_epctrl |= EPCTRL_TX_DATA_TOGGLE_RST;
469 tmp_epctrl &= ~EPCTRL_RX_EP_STALL;
470 tmp_epctrl |= EPCTRL_RX_DATA_TOGGLE_RST;
473 fsl_writel(tmp_epctrl, &dr_regs->endptctrl[ep_num]);
476 /* Get stall status of a specific ep
477 Return: 0: not stalled; 1:stalled */
478 static int dr_ep_get_stall(unsigned char ep_num, unsigned char dir)
482 epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
484 return (epctrl & EPCTRL_TX_EP_STALL) ? 1 : 0;
486 return (epctrl & EPCTRL_RX_EP_STALL) ? 1 : 0;
489 /********************************************************************
490 Internal Structure Build up functions
491 ********************************************************************/
493 /*------------------------------------------------------------------
494 * struct_ep_qh_setup(): set the Endpoint Capabilites field of QH
495 * @zlt: Zero Length Termination Select (1: disable; 0: enable)
497 ------------------------------------------------------------------*/
498 static void struct_ep_qh_setup(struct fsl_udc *udc, unsigned char ep_num,
499 unsigned char dir, unsigned char ep_type,
500 unsigned int max_pkt_len,
501 unsigned int zlt, unsigned char mult)
503 struct ep_queue_head *p_QH = &udc->ep_qh[2 * ep_num + dir];
504 unsigned int tmp = 0;
506 /* set the Endpoint Capabilites in QH */
508 case USB_ENDPOINT_XFER_CONTROL:
509 /* Interrupt On Setup (IOS). for control ep */
510 tmp = (max_pkt_len << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
513 case USB_ENDPOINT_XFER_ISOC:
514 tmp = (max_pkt_len << EP_QUEUE_HEAD_MAX_PKT_LEN_POS)
515 | (mult << EP_QUEUE_HEAD_MULT_POS);
517 case USB_ENDPOINT_XFER_BULK:
518 case USB_ENDPOINT_XFER_INT:
519 tmp = max_pkt_len << EP_QUEUE_HEAD_MAX_PKT_LEN_POS;
522 VDBG("error ep type is %d", ep_type);
526 tmp |= EP_QUEUE_HEAD_ZLT_SEL;
528 p_QH->max_pkt_length = cpu_to_hc32(tmp);
529 p_QH->next_dtd_ptr = 1;
530 p_QH->size_ioc_int_sts = 0;
533 /* Setup qh structure and ep register for ep0. */
534 static void ep0_setup(struct fsl_udc *udc)
536 /* the intialization of an ep includes: fields in QH, Regs,
538 struct_ep_qh_setup(udc, 0, USB_RECV, USB_ENDPOINT_XFER_CONTROL,
539 USB_MAX_CTRL_PAYLOAD, 0, 0);
540 struct_ep_qh_setup(udc, 0, USB_SEND, USB_ENDPOINT_XFER_CONTROL,
541 USB_MAX_CTRL_PAYLOAD, 0, 0);
542 dr_ep_setup(0, USB_RECV, USB_ENDPOINT_XFER_CONTROL);
543 dr_ep_setup(0, USB_SEND, USB_ENDPOINT_XFER_CONTROL);
549 /***********************************************************************
550 Endpoint Management Functions
551 ***********************************************************************/
553 /*-------------------------------------------------------------------------
554 * when configurations are set, or when interface settings change
555 * for example the do_set_interface() in gadget layer,
556 * the driver will enable or disable the relevant endpoints
557 * ep0 doesn't use this routine. It is always enabled.
558 -------------------------------------------------------------------------*/
559 static int fsl_ep_enable(struct usb_ep *_ep,
560 const struct usb_endpoint_descriptor *desc)
562 struct fsl_udc *udc = NULL;
563 struct fsl_ep *ep = NULL;
564 unsigned short max = 0;
565 unsigned char mult = 0, zlt;
566 int retval = -EINVAL;
567 unsigned long flags = 0;
569 ep = container_of(_ep, struct fsl_ep, ep);
571 /* catch various bogus parameters */
573 || (desc->bDescriptorType != USB_DT_ENDPOINT))
578 if (!udc->driver || (udc->gadget.speed == USB_SPEED_UNKNOWN))
581 max = usb_endpoint_maxp(desc);
583 /* Disable automatic zlp generation. Driver is responsible to indicate
584 * explicitly through req->req.zero. This is needed to enable multi-td
588 /* Assume the max packet size from gadget is always correct */
589 switch (desc->bmAttributes & 0x03) {
590 case USB_ENDPOINT_XFER_CONTROL:
591 case USB_ENDPOINT_XFER_BULK:
592 case USB_ENDPOINT_XFER_INT:
593 /* mult = 0. Execute N Transactions as demonstrated by
594 * the USB variable length packet protocol where N is
595 * computed using the Maximum Packet Length (dQH) and
596 * the Total Bytes field (dTD) */
599 case USB_ENDPOINT_XFER_ISOC:
600 /* Calculate transactions needed for high bandwidth iso */
601 mult = (unsigned char)(1 + ((max >> 11) & 0x03));
602 max = max & 0x7ff; /* bit 0~10 */
603 /* 3 transactions at most */
611 spin_lock_irqsave(&udc->lock, flags);
612 ep->ep.maxpacket = max;
616 /* Controller related setup */
617 /* Init EPx Queue Head (Ep Capabilites field in QH
618 * according to max, zlt, mult) */
619 struct_ep_qh_setup(udc, (unsigned char) ep_index(ep),
620 (unsigned char) ((desc->bEndpointAddress & USB_DIR_IN)
621 ? USB_SEND : USB_RECV),
622 (unsigned char) (desc->bmAttributes
623 & USB_ENDPOINT_XFERTYPE_MASK),
626 /* Init endpoint ctrl register */
627 dr_ep_setup((unsigned char) ep_index(ep),
628 (unsigned char) ((desc->bEndpointAddress & USB_DIR_IN)
629 ? USB_SEND : USB_RECV),
630 (unsigned char) (desc->bmAttributes
631 & USB_ENDPOINT_XFERTYPE_MASK));
633 spin_unlock_irqrestore(&udc->lock, flags);
636 VDBG("enabled %s (ep%d%s) maxpacket %d",ep->ep.name,
637 ep->ep.desc->bEndpointAddress & 0x0f,
638 (desc->bEndpointAddress & USB_DIR_IN)
639 ? "in" : "out", max);
644 /*---------------------------------------------------------------------
645 * @ep : the ep being unconfigured. May not be ep0
646 * Any pending and uncomplete req will complete with status (-ESHUTDOWN)
647 *---------------------------------------------------------------------*/
648 static int fsl_ep_disable(struct usb_ep *_ep)
650 struct fsl_udc *udc = NULL;
651 struct fsl_ep *ep = NULL;
652 unsigned long flags = 0;
656 ep = container_of(_ep, struct fsl_ep, ep);
657 if (!_ep || !ep->ep.desc) {
658 VDBG("%s not enabled", _ep ? ep->ep.name : NULL);
662 /* disable ep on controller */
663 ep_num = ep_index(ep);
664 epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
666 epctrl &= ~(EPCTRL_TX_ENABLE | EPCTRL_TX_TYPE);
667 epctrl |= EPCTRL_EP_TYPE_BULK << EPCTRL_TX_EP_TYPE_SHIFT;
669 epctrl &= ~(EPCTRL_RX_ENABLE | EPCTRL_TX_TYPE);
670 epctrl |= EPCTRL_EP_TYPE_BULK << EPCTRL_RX_EP_TYPE_SHIFT;
672 fsl_writel(epctrl, &dr_regs->endptctrl[ep_num]);
674 udc = (struct fsl_udc *)ep->udc;
675 spin_lock_irqsave(&udc->lock, flags);
677 /* nuke all pending requests (does flush) */
678 nuke(ep, -ESHUTDOWN);
682 spin_unlock_irqrestore(&udc->lock, flags);
684 VDBG("disabled %s OK", _ep->name);
688 /*---------------------------------------------------------------------
689 * allocate a request object used by this endpoint
690 * the main operation is to insert the req->queue to the eq->queue
691 * Returns the request, or null if one could not be allocated
692 *---------------------------------------------------------------------*/
693 static struct usb_request *
694 fsl_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
696 struct fsl_req *req = NULL;
698 req = kzalloc(sizeof *req, gfp_flags);
702 req->req.dma = DMA_ADDR_INVALID;
703 INIT_LIST_HEAD(&req->queue);
708 static void fsl_free_request(struct usb_ep *_ep, struct usb_request *_req)
710 struct fsl_req *req = NULL;
712 req = container_of(_req, struct fsl_req, req);
718 /* Actually add a dTD chain to an empty dQH and let go */
719 static void fsl_prime_ep(struct fsl_ep *ep, struct ep_td_struct *td)
721 struct ep_queue_head *qh = get_qh_by_ep(ep);
723 /* Write dQH next pointer and terminate bit to 0 */
724 qh->next_dtd_ptr = cpu_to_hc32(td->td_dma
725 & EP_QUEUE_HEAD_NEXT_POINTER_MASK);
727 /* Clear active and halt bit */
728 qh->size_ioc_int_sts &= cpu_to_hc32(~(EP_QUEUE_HEAD_STATUS_ACTIVE
729 | EP_QUEUE_HEAD_STATUS_HALT));
731 /* Ensure that updates to the QH will occur before priming. */
734 /* Prime endpoint by writing correct bit to ENDPTPRIME */
735 fsl_writel(ep_is_in(ep) ? (1 << (ep_index(ep) + 16))
736 : (1 << (ep_index(ep))), &dr_regs->endpointprime);
739 /* Add dTD chain to the dQH of an EP */
740 static void fsl_queue_td(struct fsl_ep *ep, struct fsl_req *req)
742 u32 temp, bitmask, tmp_stat;
744 /* VDBG("QH addr Register 0x%8x", dr_regs->endpointlistaddr);
745 VDBG("ep_qh[%d] addr is 0x%8x", i, (u32)&(ep->udc->ep_qh[i])); */
747 bitmask = ep_is_in(ep)
748 ? (1 << (ep_index(ep) + 16))
749 : (1 << (ep_index(ep)));
751 /* check if the pipe is empty */
752 if (!(list_empty(&ep->queue)) && !(ep_index(ep) == 0)) {
753 /* Add td to the end */
754 struct fsl_req *lastreq;
755 lastreq = list_entry(ep->queue.prev, struct fsl_req, queue);
756 lastreq->tail->next_td_ptr =
757 cpu_to_hc32(req->head->td_dma & DTD_ADDR_MASK);
758 /* Ensure dTD's next dtd pointer to be updated */
760 /* Read prime bit, if 1 goto done */
761 if (fsl_readl(&dr_regs->endpointprime) & bitmask)
765 /* Set ATDTW bit in USBCMD */
766 temp = fsl_readl(&dr_regs->usbcmd);
767 fsl_writel(temp | USB_CMD_ATDTW, &dr_regs->usbcmd);
769 /* Read correct status bit */
770 tmp_stat = fsl_readl(&dr_regs->endptstatus) & bitmask;
772 } while (!(fsl_readl(&dr_regs->usbcmd) & USB_CMD_ATDTW));
774 /* Write ATDTW bit to 0 */
775 temp = fsl_readl(&dr_regs->usbcmd);
776 fsl_writel(temp & ~USB_CMD_ATDTW, &dr_regs->usbcmd);
782 fsl_prime_ep(ep, req->head);
785 /* Fill in the dTD structure
786 * @req: request that the transfer belongs to
787 * @length: return actually data length of the dTD
788 * @dma: return dma address of the dTD
789 * @is_last: return flag if it is the last dTD of the request
790 * return: pointer to the built dTD */
791 static struct ep_td_struct *fsl_build_dtd(struct fsl_req *req, unsigned *length,
792 dma_addr_t *dma, int *is_last, gfp_t gfp_flags)
795 struct ep_td_struct *dtd;
797 /* how big will this transfer be? */
798 *length = min(req->req.length - req->req.actual,
799 (unsigned)EP_MAX_LENGTH_TRANSFER);
801 dtd = dma_pool_alloc(udc_controller->td_pool, gfp_flags, dma);
806 /* Clear reserved field */
807 swap_temp = hc32_to_cpu(dtd->size_ioc_sts);
808 swap_temp &= ~DTD_RESERVED_FIELDS;
809 dtd->size_ioc_sts = cpu_to_hc32(swap_temp);
811 /* Init all of buffer page pointers */
812 swap_temp = (u32) (req->req.dma + req->req.actual);
813 dtd->buff_ptr0 = cpu_to_hc32(swap_temp);
814 dtd->buff_ptr1 = cpu_to_hc32(swap_temp + 0x1000);
815 dtd->buff_ptr2 = cpu_to_hc32(swap_temp + 0x2000);
816 dtd->buff_ptr3 = cpu_to_hc32(swap_temp + 0x3000);
817 dtd->buff_ptr4 = cpu_to_hc32(swap_temp + 0x4000);
819 req->req.actual += *length;
821 /* zlp is needed if req->req.zero is set */
823 if (*length == 0 || (*length % req->ep->ep.maxpacket) != 0)
827 } else if (req->req.length == req->req.actual)
833 VDBG("multi-dtd request!");
834 /* Fill in the transfer size; set active bit */
835 swap_temp = ((*length << DTD_LENGTH_BIT_POS) | DTD_STATUS_ACTIVE);
837 /* Enable interrupt for the last dtd of a request */
838 if (*is_last && !req->req.no_interrupt)
839 swap_temp |= DTD_IOC;
841 dtd->size_ioc_sts = cpu_to_hc32(swap_temp);
845 VDBG("length = %d address= 0x%x", *length, (int)*dma);
850 /* Generate dtd chain for a request */
851 static int fsl_req_to_dtd(struct fsl_req *req, gfp_t gfp_flags)
856 struct ep_td_struct *last_dtd = NULL, *dtd;
860 dtd = fsl_build_dtd(req, &count, &dma, &is_last, gfp_flags);
868 last_dtd->next_td_ptr = cpu_to_hc32(dma);
869 last_dtd->next_td_virt = dtd;
876 dtd->next_td_ptr = cpu_to_hc32(DTD_NEXT_TERMINATE);
883 /* queues (submits) an I/O request to an endpoint */
885 fsl_ep_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
887 struct fsl_ep *ep = container_of(_ep, struct fsl_ep, ep);
888 struct fsl_req *req = container_of(_req, struct fsl_req, req);
892 /* catch various bogus parameters */
893 if (!_req || !req->req.complete || !req->req.buf
894 || !list_empty(&req->queue)) {
895 VDBG("%s, bad params", __func__);
898 if (unlikely(!_ep || !ep->ep.desc)) {
899 VDBG("%s, bad ep", __func__);
902 if (usb_endpoint_xfer_isoc(ep->ep.desc)) {
903 if (req->req.length > ep->ep.maxpacket)
908 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
913 /* map virtual address to hardware */
914 if (req->req.dma == DMA_ADDR_INVALID) {
915 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
917 req->req.length, ep_is_in(ep)
922 dma_sync_single_for_device(ep->udc->gadget.dev.parent,
923 req->req.dma, req->req.length,
930 req->req.status = -EINPROGRESS;
934 /* build dtds and push them to device queue */
935 if (!fsl_req_to_dtd(req, gfp_flags)) {
936 spin_lock_irqsave(&udc->lock, flags);
937 fsl_queue_td(ep, req);
942 /* irq handler advances the queue */
944 list_add_tail(&req->queue, &ep->queue);
945 spin_unlock_irqrestore(&udc->lock, flags);
950 /* dequeues (cancels, unlinks) an I/O request from an endpoint */
951 static int fsl_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
953 struct fsl_ep *ep = container_of(_ep, struct fsl_ep, ep);
956 int ep_num, stopped, ret = 0;
962 spin_lock_irqsave(&ep->udc->lock, flags);
963 stopped = ep->stopped;
965 /* Stop the ep before we deal with the queue */
967 ep_num = ep_index(ep);
968 epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
970 epctrl &= ~EPCTRL_TX_ENABLE;
972 epctrl &= ~EPCTRL_RX_ENABLE;
973 fsl_writel(epctrl, &dr_regs->endptctrl[ep_num]);
975 /* make sure it's actually queued on this endpoint */
976 list_for_each_entry(req, &ep->queue, queue) {
977 if (&req->req == _req)
980 if (&req->req != _req) {
985 /* The request is in progress, or completed but not dequeued */
986 if (ep->queue.next == &req->queue) {
987 _req->status = -ECONNRESET;
988 fsl_ep_fifo_flush(_ep); /* flush current transfer */
990 /* The request isn't the last request in this ep queue */
991 if (req->queue.next != &ep->queue) {
992 struct fsl_req *next_req;
994 next_req = list_entry(req->queue.next, struct fsl_req,
997 /* prime with dTD of next request */
998 fsl_prime_ep(ep, next_req->head);
1000 /* The request hasn't been processed, patch up the TD chain */
1002 struct fsl_req *prev_req;
1004 prev_req = list_entry(req->queue.prev, struct fsl_req, queue);
1005 prev_req->tail->next_td_ptr = req->tail->next_td_ptr;
1008 done(ep, req, -ECONNRESET);
1011 out: epctrl = fsl_readl(&dr_regs->endptctrl[ep_num]);
1013 epctrl |= EPCTRL_TX_ENABLE;
1015 epctrl |= EPCTRL_RX_ENABLE;
1016 fsl_writel(epctrl, &dr_regs->endptctrl[ep_num]);
1017 ep->stopped = stopped;
1019 spin_unlock_irqrestore(&ep->udc->lock, flags);
1023 /*-------------------------------------------------------------------------*/
1025 /*-----------------------------------------------------------------
1026 * modify the endpoint halt feature
1027 * @ep: the non-isochronous endpoint being stalled
1028 * @value: 1--set halt 0--clear halt
1029 * Returns zero, or a negative error code.
1030 *----------------------------------------------------------------*/
1031 static int fsl_ep_set_halt(struct usb_ep *_ep, int value)
1033 struct fsl_ep *ep = NULL;
1034 unsigned long flags = 0;
1035 int status = -EOPNOTSUPP; /* operation not supported */
1036 unsigned char ep_dir = 0, ep_num = 0;
1037 struct fsl_udc *udc = NULL;
1039 ep = container_of(_ep, struct fsl_ep, ep);
1041 if (!_ep || !ep->ep.desc) {
1046 if (usb_endpoint_xfer_isoc(ep->ep.desc)) {
1047 status = -EOPNOTSUPP;
1051 /* Attempt to halt IN ep will fail if any transfer requests
1052 * are still queue */
1053 if (value && ep_is_in(ep) && !list_empty(&ep->queue)) {
1059 ep_dir = ep_is_in(ep) ? USB_SEND : USB_RECV;
1060 ep_num = (unsigned char)(ep_index(ep));
1061 spin_lock_irqsave(&ep->udc->lock, flags);
1062 dr_ep_change_stall(ep_num, ep_dir, value);
1063 spin_unlock_irqrestore(&ep->udc->lock, flags);
1065 if (ep_index(ep) == 0) {
1066 udc->ep0_state = WAIT_FOR_SETUP;
1070 VDBG(" %s %s halt stat %d", ep->ep.name,
1071 value ? "set" : "clear", status);
1076 static int fsl_ep_fifo_status(struct usb_ep *_ep)
1079 struct fsl_udc *udc;
1082 struct ep_queue_head *qh;
1084 ep = container_of(_ep, struct fsl_ep, ep);
1085 if (!_ep || (!ep->ep.desc && ep_index(ep) != 0))
1088 udc = (struct fsl_udc *)ep->udc;
1090 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN)
1093 qh = get_qh_by_ep(ep);
1095 bitmask = (ep_is_in(ep)) ? (1 << (ep_index(ep) + 16)) :
1096 (1 << (ep_index(ep)));
1098 if (fsl_readl(&dr_regs->endptstatus) & bitmask)
1099 size = (qh->size_ioc_int_sts & DTD_PACKET_SIZE)
1100 >> DTD_LENGTH_BIT_POS;
1102 pr_debug("%s %u\n", __func__, size);
1106 static void fsl_ep_fifo_flush(struct usb_ep *_ep)
1111 unsigned long timeout;
1112 #define FSL_UDC_FLUSH_TIMEOUT 1000
1117 ep = container_of(_ep, struct fsl_ep, ep);
1121 ep_num = ep_index(ep);
1122 ep_dir = ep_is_in(ep) ? USB_SEND : USB_RECV;
1125 bits = (1 << 16) | 1;
1126 else if (ep_dir == USB_SEND)
1127 bits = 1 << (16 + ep_num);
1131 timeout = jiffies + FSL_UDC_FLUSH_TIMEOUT;
1133 fsl_writel(bits, &dr_regs->endptflush);
1135 /* Wait until flush complete */
1136 while (fsl_readl(&dr_regs->endptflush)) {
1137 if (time_after(jiffies, timeout)) {
1138 ERR("ep flush timeout\n");
1143 /* See if we need to flush again */
1144 } while (fsl_readl(&dr_regs->endptstatus) & bits);
1147 static struct usb_ep_ops fsl_ep_ops = {
1148 .enable = fsl_ep_enable,
1149 .disable = fsl_ep_disable,
1151 .alloc_request = fsl_alloc_request,
1152 .free_request = fsl_free_request,
1154 .queue = fsl_ep_queue,
1155 .dequeue = fsl_ep_dequeue,
1157 .set_halt = fsl_ep_set_halt,
1158 .fifo_status = fsl_ep_fifo_status,
1159 .fifo_flush = fsl_ep_fifo_flush, /* flush fifo */
1162 /*-------------------------------------------------------------------------
1163 Gadget Driver Layer Operations
1164 -------------------------------------------------------------------------*/
1166 /*----------------------------------------------------------------------
1167 * Get the current frame number (from DR frame_index Reg )
1168 *----------------------------------------------------------------------*/
1169 static int fsl_get_frame(struct usb_gadget *gadget)
1171 return (int)(fsl_readl(&dr_regs->frindex) & USB_FRINDEX_MASKS);
1174 /*-----------------------------------------------------------------------
1175 * Tries to wake up the host connected to this gadget
1176 -----------------------------------------------------------------------*/
1177 static int fsl_wakeup(struct usb_gadget *gadget)
1179 struct fsl_udc *udc = container_of(gadget, struct fsl_udc, gadget);
1182 /* Remote wakeup feature not enabled by host */
1183 if (!udc->remote_wakeup)
1186 portsc = fsl_readl(&dr_regs->portsc1);
1187 /* not suspended? */
1188 if (!(portsc & PORTSCX_PORT_SUSPEND))
1190 /* trigger force resume */
1191 portsc |= PORTSCX_PORT_FORCE_RESUME;
1192 fsl_writel(portsc, &dr_regs->portsc1);
1196 static int can_pullup(struct fsl_udc *udc)
1198 return udc->driver && udc->softconnect && udc->vbus_active;
1201 /* Notify controller that VBUS is powered, Called by whatever
1202 detects VBUS sessions */
1203 static int fsl_vbus_session(struct usb_gadget *gadget, int is_active)
1205 struct fsl_udc *udc;
1206 unsigned long flags;
1208 udc = container_of(gadget, struct fsl_udc, gadget);
1209 spin_lock_irqsave(&udc->lock, flags);
1210 VDBG("VBUS %s", is_active ? "on" : "off");
1211 udc->vbus_active = (is_active != 0);
1212 if (can_pullup(udc))
1213 fsl_writel((fsl_readl(&dr_regs->usbcmd) | USB_CMD_RUN_STOP),
1216 fsl_writel((fsl_readl(&dr_regs->usbcmd) & ~USB_CMD_RUN_STOP),
1218 spin_unlock_irqrestore(&udc->lock, flags);
1222 /* constrain controller's VBUS power usage
1223 * This call is used by gadget drivers during SET_CONFIGURATION calls,
1224 * reporting how much power the device may consume. For example, this
1225 * could affect how quickly batteries are recharged.
1227 * Returns zero on success, else negative errno.
1229 static int fsl_vbus_draw(struct usb_gadget *gadget, unsigned mA)
1231 struct fsl_udc *udc;
1233 udc = container_of(gadget, struct fsl_udc, gadget);
1234 if (!IS_ERR_OR_NULL(udc->transceiver))
1235 return usb_phy_set_power(udc->transceiver, mA);
1239 /* Change Data+ pullup status
1240 * this func is used by usb_gadget_connect/disconnet
1242 static int fsl_pullup(struct usb_gadget *gadget, int is_on)
1244 struct fsl_udc *udc;
1246 udc = container_of(gadget, struct fsl_udc, gadget);
1247 udc->softconnect = (is_on != 0);
1248 if (can_pullup(udc))
1249 fsl_writel((fsl_readl(&dr_regs->usbcmd) | USB_CMD_RUN_STOP),
1252 fsl_writel((fsl_readl(&dr_regs->usbcmd) & ~USB_CMD_RUN_STOP),
1258 static int fsl_start(struct usb_gadget_driver *driver,
1259 int (*bind)(struct usb_gadget *, struct usb_gadget_driver *));
1260 static int fsl_stop(struct usb_gadget_driver *driver);
1261 /* defined in gadget.h */
1262 static struct usb_gadget_ops fsl_gadget_ops = {
1263 .get_frame = fsl_get_frame,
1264 .wakeup = fsl_wakeup,
1265 /* .set_selfpowered = fsl_set_selfpowered, */ /* Always selfpowered */
1266 .vbus_session = fsl_vbus_session,
1267 .vbus_draw = fsl_vbus_draw,
1268 .pullup = fsl_pullup,
1273 /* Set protocol stall on ep0, protocol stall will automatically be cleared
1274 on new transaction */
1275 static void ep0stall(struct fsl_udc *udc)
1279 /* must set tx and rx to stall at the same time */
1280 tmp = fsl_readl(&dr_regs->endptctrl[0]);
1281 tmp |= EPCTRL_TX_EP_STALL | EPCTRL_RX_EP_STALL;
1282 fsl_writel(tmp, &dr_regs->endptctrl[0]);
1283 udc->ep0_state = WAIT_FOR_SETUP;
1287 /* Prime a status phase for ep0 */
1288 static int ep0_prime_status(struct fsl_udc *udc, int direction)
1290 struct fsl_req *req = udc->status_req;
1293 if (direction == EP_DIR_IN)
1294 udc->ep0_dir = USB_DIR_IN;
1296 udc->ep0_dir = USB_DIR_OUT;
1299 if (udc->ep0_state != DATA_STATE_XMIT)
1300 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1303 req->req.length = 0;
1304 req->req.status = -EINPROGRESS;
1305 req->req.actual = 0;
1306 req->req.complete = NULL;
1309 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1310 req->req.buf, req->req.length,
1311 ep_is_in(ep) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1314 if (fsl_req_to_dtd(req, GFP_ATOMIC) == 0)
1315 fsl_queue_td(ep, req);
1319 list_add_tail(&req->queue, &ep->queue);
1324 static void udc_reset_ep_queue(struct fsl_udc *udc, u8 pipe)
1326 struct fsl_ep *ep = get_ep_by_pipe(udc, pipe);
1329 nuke(ep, -ESHUTDOWN);
1335 static void ch9setaddress(struct fsl_udc *udc, u16 value, u16 index, u16 length)
1337 /* Save the new address to device struct */
1338 udc->device_address = (u8) value;
1339 /* Update usb state */
1340 udc->usb_state = USB_STATE_ADDRESS;
1342 if (ep0_prime_status(udc, EP_DIR_IN))
1349 static void ch9getstatus(struct fsl_udc *udc, u8 request_type, u16 value,
1350 u16 index, u16 length)
1352 u16 tmp = 0; /* Status, cpu endian */
1353 struct fsl_req *req;
1358 if ((request_type & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1359 /* Get device status */
1360 tmp = 1 << USB_DEVICE_SELF_POWERED;
1361 tmp |= udc->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP;
1362 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_INTERFACE) {
1363 /* Get interface status */
1364 /* We don't have interface information in udc driver */
1366 } else if ((request_type & USB_RECIP_MASK) == USB_RECIP_ENDPOINT) {
1367 /* Get endpoint status */
1368 struct fsl_ep *target_ep;
1370 target_ep = get_ep_by_pipe(udc, get_pipe_by_windex(index));
1372 /* stall if endpoint doesn't exist */
1373 if (!target_ep->ep.desc)
1375 tmp = dr_ep_get_stall(ep_index(target_ep), ep_is_in(target_ep))
1376 << USB_ENDPOINT_HALT;
1379 udc->ep0_dir = USB_DIR_IN;
1380 /* Borrow the per device status_req */
1381 req = udc->status_req;
1382 /* Fill in the reqest structure */
1383 *((u16 *) req->req.buf) = cpu_to_le16(tmp);
1386 req->req.length = 2;
1387 req->req.status = -EINPROGRESS;
1388 req->req.actual = 0;
1389 req->req.complete = NULL;
1392 req->req.dma = dma_map_single(ep->udc->gadget.dev.parent,
1393 req->req.buf, req->req.length,
1394 ep_is_in(ep) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1397 /* prime the data phase */
1398 if ((fsl_req_to_dtd(req, GFP_ATOMIC) == 0))
1399 fsl_queue_td(ep, req);
1403 list_add_tail(&req->queue, &ep->queue);
1404 udc->ep0_state = DATA_STATE_XMIT;
1405 if (ep0_prime_status(udc, EP_DIR_OUT))
1413 static void setup_received_irq(struct fsl_udc *udc,
1414 struct usb_ctrlrequest *setup)
1416 u16 wValue = le16_to_cpu(setup->wValue);
1417 u16 wIndex = le16_to_cpu(setup->wIndex);
1418 u16 wLength = le16_to_cpu(setup->wLength);
1420 udc_reset_ep_queue(udc, 0);
1422 /* We process some stardard setup requests here */
1423 switch (setup->bRequest) {
1424 case USB_REQ_GET_STATUS:
1425 /* Data+Status phase from udc */
1426 if ((setup->bRequestType & (USB_DIR_IN | USB_TYPE_MASK))
1427 != (USB_DIR_IN | USB_TYPE_STANDARD))
1429 ch9getstatus(udc, setup->bRequestType, wValue, wIndex, wLength);
1432 case USB_REQ_SET_ADDRESS:
1433 /* Status phase from udc */
1434 if (setup->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD
1435 | USB_RECIP_DEVICE))
1437 ch9setaddress(udc, wValue, wIndex, wLength);
1440 case USB_REQ_CLEAR_FEATURE:
1441 case USB_REQ_SET_FEATURE:
1442 /* Status phase from udc */
1444 int rc = -EOPNOTSUPP;
1447 if ((setup->bRequestType & (USB_RECIP_MASK | USB_TYPE_MASK))
1448 == (USB_RECIP_ENDPOINT | USB_TYPE_STANDARD)) {
1449 int pipe = get_pipe_by_windex(wIndex);
1452 if (wValue != 0 || wLength != 0 || pipe >= udc->max_ep)
1454 ep = get_ep_by_pipe(udc, pipe);
1456 spin_unlock(&udc->lock);
1457 rc = fsl_ep_set_halt(&ep->ep,
1458 (setup->bRequest == USB_REQ_SET_FEATURE)
1460 spin_lock(&udc->lock);
1462 } else if ((setup->bRequestType & (USB_RECIP_MASK
1463 | USB_TYPE_MASK)) == (USB_RECIP_DEVICE
1464 | USB_TYPE_STANDARD)) {
1465 /* Note: The driver has not include OTG support yet.
1466 * This will be set when OTG support is added */
1467 if (wValue == USB_DEVICE_TEST_MODE)
1469 else if (gadget_is_otg(&udc->gadget)) {
1470 if (setup->bRequest ==
1471 USB_DEVICE_B_HNP_ENABLE)
1472 udc->gadget.b_hnp_enable = 1;
1473 else if (setup->bRequest ==
1474 USB_DEVICE_A_HNP_SUPPORT)
1475 udc->gadget.a_hnp_support = 1;
1476 else if (setup->bRequest ==
1477 USB_DEVICE_A_ALT_HNP_SUPPORT)
1478 udc->gadget.a_alt_hnp_support = 1;
1485 if (ep0_prime_status(udc, EP_DIR_IN))
1492 tmp = fsl_readl(&dr_regs->portsc1) | (ptc << 16);
1493 fsl_writel(tmp, &dr_regs->portsc1);
1494 printk(KERN_INFO "udc: switch to test mode %d.\n", ptc);
1504 /* Requests handled by gadget */
1506 /* Data phase from gadget, status phase from udc */
1507 udc->ep0_dir = (setup->bRequestType & USB_DIR_IN)
1508 ? USB_DIR_IN : USB_DIR_OUT;
1509 spin_unlock(&udc->lock);
1510 if (udc->driver->setup(&udc->gadget,
1511 &udc->local_setup_buff) < 0)
1513 spin_lock(&udc->lock);
1514 udc->ep0_state = (setup->bRequestType & USB_DIR_IN)
1515 ? DATA_STATE_XMIT : DATA_STATE_RECV;
1517 * If the data stage is IN, send status prime immediately.
1518 * See 2.0 Spec chapter 8.5.3.3 for detail.
1520 if (udc->ep0_state == DATA_STATE_XMIT)
1521 if (ep0_prime_status(udc, EP_DIR_OUT))
1525 /* No data phase, IN status from gadget */
1526 udc->ep0_dir = USB_DIR_IN;
1527 spin_unlock(&udc->lock);
1528 if (udc->driver->setup(&udc->gadget,
1529 &udc->local_setup_buff) < 0)
1531 spin_lock(&udc->lock);
1532 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1536 /* Process request for Data or Status phase of ep0
1537 * prime status phase if needed */
1538 static void ep0_req_complete(struct fsl_udc *udc, struct fsl_ep *ep0,
1539 struct fsl_req *req)
1541 if (udc->usb_state == USB_STATE_ADDRESS) {
1542 /* Set the new address */
1543 u32 new_address = (u32) udc->device_address;
1544 fsl_writel(new_address << USB_DEVICE_ADDRESS_BIT_POS,
1545 &dr_regs->deviceaddr);
1550 switch (udc->ep0_state) {
1551 case DATA_STATE_XMIT:
1552 /* already primed at setup_received_irq */
1553 udc->ep0_state = WAIT_FOR_OUT_STATUS;
1555 case DATA_STATE_RECV:
1556 /* send status phase */
1557 if (ep0_prime_status(udc, EP_DIR_IN))
1560 case WAIT_FOR_OUT_STATUS:
1561 udc->ep0_state = WAIT_FOR_SETUP;
1563 case WAIT_FOR_SETUP:
1564 ERR("Unexpect ep0 packets\n");
1572 /* Tripwire mechanism to ensure a setup packet payload is extracted without
1573 * being corrupted by another incoming setup packet */
1574 static void tripwire_handler(struct fsl_udc *udc, u8 ep_num, u8 *buffer_ptr)
1577 struct ep_queue_head *qh;
1578 struct fsl_usb2_platform_data *pdata = udc->pdata;
1580 qh = &udc->ep_qh[ep_num * 2 + EP_DIR_OUT];
1582 /* Clear bit in ENDPTSETUPSTAT */
1583 temp = fsl_readl(&dr_regs->endptsetupstat);
1584 fsl_writel(temp | (1 << ep_num), &dr_regs->endptsetupstat);
1586 /* while a hazard exists when setup package arrives */
1588 /* Set Setup Tripwire */
1589 temp = fsl_readl(&dr_regs->usbcmd);
1590 fsl_writel(temp | USB_CMD_SUTW, &dr_regs->usbcmd);
1592 /* Copy the setup packet to local buffer */
1593 if (pdata->le_setup_buf) {
1594 u32 *p = (u32 *)buffer_ptr;
1595 u32 *s = (u32 *)qh->setup_buffer;
1597 /* Convert little endian setup buffer to CPU endian */
1598 *p++ = le32_to_cpu(*s++);
1599 *p = le32_to_cpu(*s);
1601 memcpy(buffer_ptr, (u8 *) qh->setup_buffer, 8);
1603 } while (!(fsl_readl(&dr_regs->usbcmd) & USB_CMD_SUTW));
1605 /* Clear Setup Tripwire */
1606 temp = fsl_readl(&dr_regs->usbcmd);
1607 fsl_writel(temp & ~USB_CMD_SUTW, &dr_regs->usbcmd);
1610 /* process-ep_req(): free the completed Tds for this req */
1611 static int process_ep_req(struct fsl_udc *udc, int pipe,
1612 struct fsl_req *curr_req)
1614 struct ep_td_struct *curr_td;
1615 int td_complete, actual, remaining_length, j, tmp;
1618 struct ep_queue_head *curr_qh = &udc->ep_qh[pipe];
1619 int direction = pipe % 2;
1621 curr_td = curr_req->head;
1623 actual = curr_req->req.length;
1625 for (j = 0; j < curr_req->dtd_count; j++) {
1626 remaining_length = (hc32_to_cpu(curr_td->size_ioc_sts)
1628 >> DTD_LENGTH_BIT_POS;
1629 actual -= remaining_length;
1631 errors = hc32_to_cpu(curr_td->size_ioc_sts);
1632 if (errors & DTD_ERROR_MASK) {
1633 if (errors & DTD_STATUS_HALTED) {
1634 ERR("dTD error %08x QH=%d\n", errors, pipe);
1635 /* Clear the errors and Halt condition */
1636 tmp = hc32_to_cpu(curr_qh->size_ioc_int_sts);
1638 curr_qh->size_ioc_int_sts = cpu_to_hc32(tmp);
1640 /* FIXME: continue with next queued TD? */
1644 if (errors & DTD_STATUS_DATA_BUFF_ERR) {
1645 VDBG("Transfer overflow");
1648 } else if (errors & DTD_STATUS_TRANSACTION_ERR) {
1653 ERR("Unknown error has occurred (0x%x)!\n",
1656 } else if (hc32_to_cpu(curr_td->size_ioc_sts)
1657 & DTD_STATUS_ACTIVE) {
1658 VDBG("Request not complete");
1659 status = REQ_UNCOMPLETE;
1661 } else if (remaining_length) {
1663 VDBG("Transmit dTD remaining length not zero");
1672 VDBG("dTD transmitted successful");
1675 if (j != curr_req->dtd_count - 1)
1676 curr_td = (struct ep_td_struct *)curr_td->next_td_virt;
1682 curr_req->req.actual = actual;
1687 /* Process a DTD completion interrupt */
1688 static void dtd_complete_irq(struct fsl_udc *udc)
1691 int i, ep_num, direction, bit_mask, status;
1692 struct fsl_ep *curr_ep;
1693 struct fsl_req *curr_req, *temp_req;
1695 /* Clear the bits in the register */
1696 bit_pos = fsl_readl(&dr_regs->endptcomplete);
1697 fsl_writel(bit_pos, &dr_regs->endptcomplete);
1702 for (i = 0; i < udc->max_ep; i++) {
1706 bit_mask = 1 << (ep_num + 16 * direction);
1708 if (!(bit_pos & bit_mask))
1711 curr_ep = get_ep_by_pipe(udc, i);
1713 /* If the ep is configured */
1714 if (curr_ep->name == NULL) {
1715 WARNING("Invalid EP?");
1719 /* process the req queue until an uncomplete request */
1720 list_for_each_entry_safe(curr_req, temp_req, &curr_ep->queue,
1722 status = process_ep_req(udc, i, curr_req);
1724 VDBG("status of process_ep_req= %d, ep = %d",
1726 if (status == REQ_UNCOMPLETE)
1728 /* write back status to req */
1729 curr_req->req.status = status;
1732 ep0_req_complete(udc, curr_ep, curr_req);
1735 done(curr_ep, curr_req, status);
1740 static inline enum usb_device_speed portscx_device_speed(u32 reg)
1742 switch (reg & PORTSCX_PORT_SPEED_MASK) {
1743 case PORTSCX_PORT_SPEED_HIGH:
1744 return USB_SPEED_HIGH;
1745 case PORTSCX_PORT_SPEED_FULL:
1746 return USB_SPEED_FULL;
1747 case PORTSCX_PORT_SPEED_LOW:
1748 return USB_SPEED_LOW;
1750 return USB_SPEED_UNKNOWN;
1754 /* Process a port change interrupt */
1755 static void port_change_irq(struct fsl_udc *udc)
1760 /* Bus resetting is finished */
1761 if (!(fsl_readl(&dr_regs->portsc1) & PORTSCX_PORT_RESET))
1764 portscx_device_speed(fsl_readl(&dr_regs->portsc1));
1766 /* Update USB state */
1767 if (!udc->resume_state)
1768 udc->usb_state = USB_STATE_DEFAULT;
1771 /* Process suspend interrupt */
1772 static void suspend_irq(struct fsl_udc *udc)
1774 udc->resume_state = udc->usb_state;
1775 udc->usb_state = USB_STATE_SUSPENDED;
1777 /* report suspend to the driver, serial.c does not support this */
1778 if (udc->driver->suspend)
1779 udc->driver->suspend(&udc->gadget);
1782 static void bus_resume(struct fsl_udc *udc)
1784 udc->usb_state = udc->resume_state;
1785 udc->resume_state = 0;
1787 /* report resume to the driver, serial.c does not support this */
1788 if (udc->driver->resume)
1789 udc->driver->resume(&udc->gadget);
1792 /* Clear up all ep queues */
1793 static int reset_queues(struct fsl_udc *udc)
1797 for (pipe = 0; pipe < udc->max_pipes; pipe++)
1798 udc_reset_ep_queue(udc, pipe);
1800 /* report disconnect; the driver is already quiesced */
1801 spin_unlock(&udc->lock);
1802 udc->driver->disconnect(&udc->gadget);
1803 spin_lock(&udc->lock);
1808 /* Process reset interrupt */
1809 static void reset_irq(struct fsl_udc *udc)
1812 unsigned long timeout;
1814 /* Clear the device address */
1815 temp = fsl_readl(&dr_regs->deviceaddr);
1816 fsl_writel(temp & ~USB_DEVICE_ADDRESS_MASK, &dr_regs->deviceaddr);
1818 udc->device_address = 0;
1820 /* Clear usb state */
1821 udc->resume_state = 0;
1823 udc->ep0_state = WAIT_FOR_SETUP;
1824 udc->remote_wakeup = 0; /* default to 0 on reset */
1825 udc->gadget.b_hnp_enable = 0;
1826 udc->gadget.a_hnp_support = 0;
1827 udc->gadget.a_alt_hnp_support = 0;
1829 /* Clear all the setup token semaphores */
1830 temp = fsl_readl(&dr_regs->endptsetupstat);
1831 fsl_writel(temp, &dr_regs->endptsetupstat);
1833 /* Clear all the endpoint complete status bits */
1834 temp = fsl_readl(&dr_regs->endptcomplete);
1835 fsl_writel(temp, &dr_regs->endptcomplete);
1837 timeout = jiffies + 100;
1838 while (fsl_readl(&dr_regs->endpointprime)) {
1839 /* Wait until all endptprime bits cleared */
1840 if (time_after(jiffies, timeout)) {
1841 ERR("Timeout for reset\n");
1847 /* Write 1s to the flush register */
1848 fsl_writel(0xffffffff, &dr_regs->endptflush);
1850 if (fsl_readl(&dr_regs->portsc1) & PORTSCX_PORT_RESET) {
1852 /* Bus is reseting */
1854 /* Reset all the queues, include XD, dTD, EP queue
1855 * head and TR Queue */
1857 udc->usb_state = USB_STATE_DEFAULT;
1859 VDBG("Controller reset");
1860 /* initialize usb hw reg except for regs for EP, not
1861 * touch usbintr reg */
1862 dr_controller_setup(udc);
1864 /* Reset all internal used Queues */
1869 /* Enable DR IRQ reg, Set Run bit, change udc state */
1870 dr_controller_run(udc);
1871 udc->usb_state = USB_STATE_ATTACHED;
1876 * USB device controller interrupt handler
1878 static irqreturn_t fsl_udc_irq(int irq, void *_udc)
1880 struct fsl_udc *udc = _udc;
1882 irqreturn_t status = IRQ_NONE;
1883 unsigned long flags;
1885 /* Disable ISR for OTG host mode */
1888 spin_lock_irqsave(&udc->lock, flags);
1889 irq_src = fsl_readl(&dr_regs->usbsts) & fsl_readl(&dr_regs->usbintr);
1890 /* Clear notification bits */
1891 fsl_writel(irq_src, &dr_regs->usbsts);
1893 /* VDBG("irq_src [0x%8x]", irq_src); */
1895 /* Need to resume? */
1896 if (udc->usb_state == USB_STATE_SUSPENDED)
1897 if ((fsl_readl(&dr_regs->portsc1) & PORTSCX_PORT_SUSPEND) == 0)
1901 if (irq_src & USB_STS_INT) {
1903 /* Setup package, we only support ep0 as control ep */
1904 if (fsl_readl(&dr_regs->endptsetupstat) & EP_SETUP_STATUS_EP0) {
1905 tripwire_handler(udc, 0,
1906 (u8 *) (&udc->local_setup_buff));
1907 setup_received_irq(udc, &udc->local_setup_buff);
1908 status = IRQ_HANDLED;
1911 /* completion of dtd */
1912 if (fsl_readl(&dr_regs->endptcomplete)) {
1913 dtd_complete_irq(udc);
1914 status = IRQ_HANDLED;
1918 /* SOF (for ISO transfer) */
1919 if (irq_src & USB_STS_SOF) {
1920 status = IRQ_HANDLED;
1924 if (irq_src & USB_STS_PORT_CHANGE) {
1925 port_change_irq(udc);
1926 status = IRQ_HANDLED;
1929 /* Reset Received */
1930 if (irq_src & USB_STS_RESET) {
1933 status = IRQ_HANDLED;
1936 /* Sleep Enable (Suspend) */
1937 if (irq_src & USB_STS_SUSPEND) {
1939 status = IRQ_HANDLED;
1942 if (irq_src & (USB_STS_ERR | USB_STS_SYS_ERR)) {
1943 VDBG("Error IRQ %x", irq_src);
1946 spin_unlock_irqrestore(&udc->lock, flags);
1950 /*----------------------------------------------------------------*
1951 * Hook to gadget drivers
1952 * Called by initialization code of gadget drivers
1953 *----------------------------------------------------------------*/
1954 static int fsl_start(struct usb_gadget_driver *driver,
1955 int (*bind)(struct usb_gadget *, struct usb_gadget_driver *))
1957 int retval = -ENODEV;
1958 unsigned long flags = 0;
1960 if (!udc_controller)
1963 if (!driver || driver->max_speed < USB_SPEED_FULL
1964 || !bind || !driver->disconnect || !driver->setup)
1967 if (udc_controller->driver)
1970 /* lock is needed but whether should use this lock or another */
1971 spin_lock_irqsave(&udc_controller->lock, flags);
1973 driver->driver.bus = NULL;
1974 /* hook up the driver */
1975 udc_controller->driver = driver;
1976 udc_controller->gadget.dev.driver = &driver->driver;
1977 spin_unlock_irqrestore(&udc_controller->lock, flags);
1979 /* bind udc driver to gadget driver */
1980 retval = bind(&udc_controller->gadget, driver);
1982 VDBG("bind to %s --> %d", driver->driver.name, retval);
1983 udc_controller->gadget.dev.driver = NULL;
1984 udc_controller->driver = NULL;
1988 if (!IS_ERR_OR_NULL(udc_controller->transceiver)) {
1989 /* Suspend the controller until OTG enable it */
1990 udc_controller->stopped = 1;
1991 printk(KERN_INFO "Suspend udc for OTG auto detect\n");
1993 /* connect to bus through transceiver */
1994 if (!IS_ERR_OR_NULL(udc_controller->transceiver)) {
1995 retval = otg_set_peripheral(
1996 udc_controller->transceiver->otg,
1997 &udc_controller->gadget);
1999 ERR("can't bind to transceiver\n");
2000 driver->unbind(&udc_controller->gadget);
2001 udc_controller->gadget.dev.driver = 0;
2002 udc_controller->driver = 0;
2007 /* Enable DR IRQ reg and set USBCMD reg Run bit */
2008 dr_controller_run(udc_controller);
2009 udc_controller->usb_state = USB_STATE_ATTACHED;
2010 udc_controller->ep0_state = WAIT_FOR_SETUP;
2011 udc_controller->ep0_dir = 0;
2013 printk(KERN_INFO "%s: bind to driver %s\n",
2014 udc_controller->gadget.name, driver->driver.name);
2018 printk(KERN_WARNING "gadget driver register failed %d\n",
2023 /* Disconnect from gadget driver */
2024 static int fsl_stop(struct usb_gadget_driver *driver)
2026 struct fsl_ep *loop_ep;
2027 unsigned long flags;
2029 if (!udc_controller)
2032 if (!driver || driver != udc_controller->driver || !driver->unbind)
2035 if (!IS_ERR_OR_NULL(udc_controller->transceiver))
2036 otg_set_peripheral(udc_controller->transceiver->otg, NULL);
2038 /* stop DR, disable intr */
2039 dr_controller_stop(udc_controller);
2041 /* in fact, no needed */
2042 udc_controller->usb_state = USB_STATE_ATTACHED;
2043 udc_controller->ep0_state = WAIT_FOR_SETUP;
2044 udc_controller->ep0_dir = 0;
2046 /* stand operation */
2047 spin_lock_irqsave(&udc_controller->lock, flags);
2048 udc_controller->gadget.speed = USB_SPEED_UNKNOWN;
2049 nuke(&udc_controller->eps[0], -ESHUTDOWN);
2050 list_for_each_entry(loop_ep, &udc_controller->gadget.ep_list,
2052 nuke(loop_ep, -ESHUTDOWN);
2053 spin_unlock_irqrestore(&udc_controller->lock, flags);
2055 /* report disconnect; the controller is already quiesced */
2056 driver->disconnect(&udc_controller->gadget);
2058 /* unbind gadget and unhook driver. */
2059 driver->unbind(&udc_controller->gadget);
2060 udc_controller->gadget.dev.driver = NULL;
2061 udc_controller->driver = NULL;
2063 printk(KERN_WARNING "unregistered gadget driver '%s'\n",
2064 driver->driver.name);
2068 /*-------------------------------------------------------------------------
2069 PROC File System Support
2070 -------------------------------------------------------------------------*/
2071 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
2073 #include <linux/seq_file.h>
2075 static const char proc_filename[] = "driver/fsl_usb2_udc";
2077 static int fsl_proc_read(char *page, char **start, off_t off, int count,
2078 int *eof, void *_dev)
2082 unsigned size = count;
2083 unsigned long flags;
2086 struct fsl_ep *ep = NULL;
2087 struct fsl_req *req;
2089 struct fsl_udc *udc = udc_controller;
2093 spin_lock_irqsave(&udc->lock, flags);
2095 /* ------basic driver information ---- */
2096 t = scnprintf(next, size,
2099 "Gadget driver: %s\n\n",
2100 driver_name, DRIVER_VERSION,
2101 udc->driver ? udc->driver->driver.name : "(none)");
2105 /* ------ DR Registers ----- */
2106 tmp_reg = fsl_readl(&dr_regs->usbcmd);
2107 t = scnprintf(next, size,
2111 (tmp_reg & USB_CMD_SUTW) ? 1 : 0,
2112 (tmp_reg & USB_CMD_RUN_STOP) ? "Run" : "Stop");
2116 tmp_reg = fsl_readl(&dr_regs->usbsts);
2117 t = scnprintf(next, size,
2119 "Dr Suspend: %d Reset Received: %d System Error: %s "
2120 "USB Error Interrupt: %s\n\n",
2121 (tmp_reg & USB_STS_SUSPEND) ? 1 : 0,
2122 (tmp_reg & USB_STS_RESET) ? 1 : 0,
2123 (tmp_reg & USB_STS_SYS_ERR) ? "Err" : "Normal",
2124 (tmp_reg & USB_STS_ERR) ? "Err detected" : "No err");
2128 tmp_reg = fsl_readl(&dr_regs->usbintr);
2129 t = scnprintf(next, size,
2130 "USB Interrupt Enable Reg:\n"
2131 "Sleep Enable: %d SOF Received Enable: %d "
2132 "Reset Enable: %d\n"
2133 "System Error Enable: %d "
2134 "Port Change Dectected Enable: %d\n"
2135 "USB Error Intr Enable: %d USB Intr Enable: %d\n\n",
2136 (tmp_reg & USB_INTR_DEVICE_SUSPEND) ? 1 : 0,
2137 (tmp_reg & USB_INTR_SOF_EN) ? 1 : 0,
2138 (tmp_reg & USB_INTR_RESET_EN) ? 1 : 0,
2139 (tmp_reg & USB_INTR_SYS_ERR_EN) ? 1 : 0,
2140 (tmp_reg & USB_INTR_PTC_DETECT_EN) ? 1 : 0,
2141 (tmp_reg & USB_INTR_ERR_INT_EN) ? 1 : 0,
2142 (tmp_reg & USB_INTR_INT_EN) ? 1 : 0);
2146 tmp_reg = fsl_readl(&dr_regs->frindex);
2147 t = scnprintf(next, size,
2148 "USB Frame Index Reg: Frame Number is 0x%x\n\n",
2149 (tmp_reg & USB_FRINDEX_MASKS));
2153 tmp_reg = fsl_readl(&dr_regs->deviceaddr);
2154 t = scnprintf(next, size,
2155 "USB Device Address Reg: Device Addr is 0x%x\n\n",
2156 (tmp_reg & USB_DEVICE_ADDRESS_MASK));
2160 tmp_reg = fsl_readl(&dr_regs->endpointlistaddr);
2161 t = scnprintf(next, size,
2162 "USB Endpoint List Address Reg: "
2163 "Device Addr is 0x%x\n\n",
2164 (tmp_reg & USB_EP_LIST_ADDRESS_MASK));
2168 tmp_reg = fsl_readl(&dr_regs->portsc1);
2169 t = scnprintf(next, size,
2170 "USB Port Status&Control Reg:\n"
2171 "Port Transceiver Type : %s Port Speed: %s\n"
2172 "PHY Low Power Suspend: %s Port Reset: %s "
2173 "Port Suspend Mode: %s\n"
2174 "Over-current Change: %s "
2175 "Port Enable/Disable Change: %s\n"
2176 "Port Enabled/Disabled: %s "
2177 "Current Connect Status: %s\n\n", ( {
2179 switch (tmp_reg & PORTSCX_PTS_FSLS) {
2180 case PORTSCX_PTS_UTMI:
2182 case PORTSCX_PTS_ULPI:
2184 case PORTSCX_PTS_FSLS:
2185 s = "FS/LS Serial"; break;
2190 usb_speed_string(portscx_device_speed(tmp_reg)),
2191 (tmp_reg & PORTSCX_PHY_LOW_POWER_SPD) ?
2192 "Normal PHY mode" : "Low power mode",
2193 (tmp_reg & PORTSCX_PORT_RESET) ? "In Reset" :
2195 (tmp_reg & PORTSCX_PORT_SUSPEND) ? "In " : "Not in",
2196 (tmp_reg & PORTSCX_OVER_CURRENT_CHG) ? "Dected" :
2198 (tmp_reg & PORTSCX_PORT_EN_DIS_CHANGE) ? "Disable" :
2200 (tmp_reg & PORTSCX_PORT_ENABLE) ? "Enable" :
2202 (tmp_reg & PORTSCX_CURRENT_CONNECT_STATUS) ?
2203 "Attached" : "Not-Att");
2207 tmp_reg = fsl_readl(&dr_regs->usbmode);
2208 t = scnprintf(next, size,
2209 "USB Mode Reg: Controller Mode is: %s\n\n", ( {
2211 switch (tmp_reg & USB_MODE_CTRL_MODE_HOST) {
2212 case USB_MODE_CTRL_MODE_IDLE:
2214 case USB_MODE_CTRL_MODE_DEVICE:
2215 s = "Device Controller"; break;
2216 case USB_MODE_CTRL_MODE_HOST:
2217 s = "Host Controller"; break;
2226 tmp_reg = fsl_readl(&dr_regs->endptsetupstat);
2227 t = scnprintf(next, size,
2228 "Endpoint Setup Status Reg: SETUP on ep 0x%x\n\n",
2229 (tmp_reg & EP_SETUP_STATUS_MASK));
2233 for (i = 0; i < udc->max_ep / 2; i++) {
2234 tmp_reg = fsl_readl(&dr_regs->endptctrl[i]);
2235 t = scnprintf(next, size, "EP Ctrl Reg [0x%x]: = [0x%x]\n",
2240 tmp_reg = fsl_readl(&dr_regs->endpointprime);
2241 t = scnprintf(next, size, "EP Prime Reg = [0x%x]\n\n", tmp_reg);
2245 #ifndef CONFIG_ARCH_MXC
2246 if (udc->pdata->have_sysif_regs) {
2247 tmp_reg = usb_sys_regs->snoop1;
2248 t = scnprintf(next, size, "Snoop1 Reg : = [0x%x]\n\n", tmp_reg);
2252 tmp_reg = usb_sys_regs->control;
2253 t = scnprintf(next, size, "General Control Reg : = [0x%x]\n\n",
2260 /* ------fsl_udc, fsl_ep, fsl_request structure information ----- */
2262 t = scnprintf(next, size, "For %s Maxpkt is 0x%x index is 0x%x\n",
2263 ep->ep.name, ep_maxpacket(ep), ep_index(ep));
2267 if (list_empty(&ep->queue)) {
2268 t = scnprintf(next, size, "its req queue is empty\n\n");
2272 list_for_each_entry(req, &ep->queue, queue) {
2273 t = scnprintf(next, size,
2274 "req %p actual 0x%x length 0x%x buf %p\n",
2275 &req->req, req->req.actual,
2276 req->req.length, req->req.buf);
2281 /* other gadget->eplist ep */
2282 list_for_each_entry(ep, &udc->gadget.ep_list, ep.ep_list) {
2284 t = scnprintf(next, size,
2285 "\nFor %s Maxpkt is 0x%x "
2287 ep->ep.name, ep_maxpacket(ep),
2292 if (list_empty(&ep->queue)) {
2293 t = scnprintf(next, size,
2294 "its req queue is empty\n\n");
2298 list_for_each_entry(req, &ep->queue, queue) {
2299 t = scnprintf(next, size,
2300 "req %p actual 0x%x length "
2302 &req->req, req->req.actual,
2303 req->req.length, req->req.buf);
2306 } /* end for each_entry of ep req */
2307 } /* end for else */
2308 } /* end for if(ep->queue) */
2309 } /* end (ep->desc) */
2311 spin_unlock_irqrestore(&udc->lock, flags);
2314 return count - size;
2317 #define create_proc_file() create_proc_read_entry(proc_filename, \
2318 0, NULL, fsl_proc_read, NULL)
2320 #define remove_proc_file() remove_proc_entry(proc_filename, NULL)
2322 #else /* !CONFIG_USB_GADGET_DEBUG_FILES */
2324 #define create_proc_file() do {} while (0)
2325 #define remove_proc_file() do {} while (0)
2327 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
2329 /*-------------------------------------------------------------------------*/
2331 /* Release udc structures */
2332 static void fsl_udc_release(struct device *dev)
2334 complete(udc_controller->done);
2335 dma_free_coherent(dev->parent, udc_controller->ep_qh_size,
2336 udc_controller->ep_qh, udc_controller->ep_qh_dma);
2337 kfree(udc_controller);
2340 /******************************************************************
2341 Internal structure setup functions
2342 *******************************************************************/
2343 /*------------------------------------------------------------------
2344 * init resource for globle controller
2345 * Return the udc handle on success or NULL on failure
2346 ------------------------------------------------------------------*/
2347 static int __init struct_udc_setup(struct fsl_udc *udc,
2348 struct platform_device *pdev)
2350 struct fsl_usb2_platform_data *pdata;
2353 pdata = pdev->dev.platform_data;
2354 udc->phy_mode = pdata->phy_mode;
2356 udc->eps = kzalloc(sizeof(struct fsl_ep) * udc->max_ep, GFP_KERNEL);
2358 ERR("malloc fsl_ep failed\n");
2362 /* initialized QHs, take care of alignment */
2363 size = udc->max_ep * sizeof(struct ep_queue_head);
2364 if (size < QH_ALIGNMENT)
2365 size = QH_ALIGNMENT;
2366 else if ((size % QH_ALIGNMENT) != 0) {
2367 size += QH_ALIGNMENT + 1;
2368 size &= ~(QH_ALIGNMENT - 1);
2370 udc->ep_qh = dma_alloc_coherent(&pdev->dev, size,
2371 &udc->ep_qh_dma, GFP_KERNEL);
2373 ERR("malloc QHs for udc failed\n");
2378 udc->ep_qh_size = size;
2380 /* Initialize ep0 status request structure */
2381 /* FIXME: fsl_alloc_request() ignores ep argument */
2382 udc->status_req = container_of(fsl_alloc_request(NULL, GFP_KERNEL),
2383 struct fsl_req, req);
2384 /* allocate a small amount of memory to get valid address */
2385 udc->status_req->req.buf = kmalloc(8, GFP_KERNEL);
2387 udc->resume_state = USB_STATE_NOTATTACHED;
2388 udc->usb_state = USB_STATE_POWERED;
2390 udc->remote_wakeup = 0; /* default to 0 on reset */
2395 /*----------------------------------------------------------------
2396 * Setup the fsl_ep struct for eps
2397 * Link fsl_ep->ep to gadget->ep_list
2398 * ep0out is not used so do nothing here
2399 * ep0in should be taken care
2400 *--------------------------------------------------------------*/
2401 static int __init struct_ep_setup(struct fsl_udc *udc, unsigned char index,
2402 char *name, int link)
2404 struct fsl_ep *ep = &udc->eps[index];
2407 strcpy(ep->name, name);
2408 ep->ep.name = ep->name;
2410 ep->ep.ops = &fsl_ep_ops;
2413 /* for ep0: maxP defined in desc
2414 * for other eps, maxP is set by epautoconfig() called by gadget layer
2416 ep->ep.maxpacket = (unsigned short) ~0;
2418 /* the queue lists any req for this ep */
2419 INIT_LIST_HEAD(&ep->queue);
2421 /* gagdet.ep_list used for ep_autoconfig so no ep0 */
2423 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
2424 ep->gadget = &udc->gadget;
2425 ep->qh = &udc->ep_qh[index];
2430 /* Driver probe function
2431 * all intialization operations implemented here except enabling usb_intr reg
2432 * board setup should have been done in the platform code
2434 static int __init fsl_udc_probe(struct platform_device *pdev)
2436 struct fsl_usb2_platform_data *pdata;
2437 struct resource *res;
2442 udc_controller = kzalloc(sizeof(struct fsl_udc), GFP_KERNEL);
2443 if (udc_controller == NULL) {
2444 ERR("malloc udc failed\n");
2448 pdata = pdev->dev.platform_data;
2449 udc_controller->pdata = pdata;
2450 spin_lock_init(&udc_controller->lock);
2451 udc_controller->stopped = 1;
2453 #ifdef CONFIG_USB_OTG
2454 if (pdata->operating_mode == FSL_USB2_DR_OTG) {
2455 udc_controller->transceiver = usb_get_phy(USB_PHY_TYPE_USB2);
2456 if (IS_ERR_OR_NULL(udc_controller->transceiver)) {
2457 ERR("Can't find OTG driver!\n");
2464 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2470 if (pdata->operating_mode == FSL_USB2_DR_DEVICE) {
2471 if (!request_mem_region(res->start, resource_size(res),
2473 ERR("request mem region for %s failed\n", pdev->name);
2479 dr_regs = ioremap(res->start, resource_size(res));
2482 goto err_release_mem_region;
2485 pdata->regs = (void *)dr_regs;
2488 * do platform specific init: check the clock, grab/config pins, etc.
2490 if (pdata->init && pdata->init(pdev)) {
2492 goto err_iounmap_noclk;
2495 /* Set accessors only after pdata->init() ! */
2496 fsl_set_accessors(pdata);
2498 #ifndef CONFIG_ARCH_MXC
2499 if (pdata->have_sysif_regs)
2500 usb_sys_regs = (void *)dr_regs + USB_DR_SYS_OFFSET;
2503 /* Initialize USB clocks */
2504 ret = fsl_udc_clk_init(pdev);
2506 goto err_iounmap_noclk;
2508 /* Read Device Controller Capability Parameters register */
2509 dccparams = fsl_readl(&dr_regs->dccparams);
2510 if (!(dccparams & DCCPARAMS_DC)) {
2511 ERR("This SOC doesn't support device role\n");
2515 /* Get max device endpoints */
2516 /* DEN is bidirectional ep number, max_ep doubles the number */
2517 udc_controller->max_ep = (dccparams & DCCPARAMS_DEN_MASK) * 2;
2519 udc_controller->irq = platform_get_irq(pdev, 0);
2520 if (!udc_controller->irq) {
2525 ret = request_irq(udc_controller->irq, fsl_udc_irq, IRQF_SHARED,
2526 driver_name, udc_controller);
2528 ERR("cannot request irq %d err %d\n",
2529 udc_controller->irq, ret);
2533 /* Initialize the udc structure including QH member and other member */
2534 if (struct_udc_setup(udc_controller, pdev)) {
2535 ERR("Can't initialize udc data structure\n");
2540 if (IS_ERR_OR_NULL(udc_controller->transceiver)) {
2541 /* initialize usb hw reg except for regs for EP,
2542 * leave usbintr reg untouched */
2543 dr_controller_setup(udc_controller);
2546 ret = fsl_udc_clk_finalize(pdev);
2550 /* Setup gadget structure */
2551 udc_controller->gadget.ops = &fsl_gadget_ops;
2552 udc_controller->gadget.max_speed = USB_SPEED_HIGH;
2553 udc_controller->gadget.ep0 = &udc_controller->eps[0].ep;
2554 INIT_LIST_HEAD(&udc_controller->gadget.ep_list);
2555 udc_controller->gadget.speed = USB_SPEED_UNKNOWN;
2556 udc_controller->gadget.name = driver_name;
2558 /* Setup gadget.dev and register with kernel */
2559 dev_set_name(&udc_controller->gadget.dev, "gadget");
2560 udc_controller->gadget.dev.release = fsl_udc_release;
2561 udc_controller->gadget.dev.parent = &pdev->dev;
2562 udc_controller->gadget.dev.of_node = pdev->dev.of_node;
2563 ret = device_register(&udc_controller->gadget.dev);
2567 if (!IS_ERR_OR_NULL(udc_controller->transceiver))
2568 udc_controller->gadget.is_otg = 1;
2570 /* setup QH and epctrl for ep0 */
2571 ep0_setup(udc_controller);
2573 /* setup udc->eps[] for ep0 */
2574 struct_ep_setup(udc_controller, 0, "ep0", 0);
2575 /* for ep0: the desc defined here;
2576 * for other eps, gadget layer called ep_enable with defined desc
2578 udc_controller->eps[0].ep.desc = &fsl_ep0_desc;
2579 udc_controller->eps[0].ep.maxpacket = USB_MAX_CTRL_PAYLOAD;
2581 /* setup the udc->eps[] for non-control endpoints and link
2582 * to gadget.ep_list */
2583 for (i = 1; i < (int)(udc_controller->max_ep / 2); i++) {
2586 sprintf(name, "ep%dout", i);
2587 struct_ep_setup(udc_controller, i * 2, name, 1);
2588 sprintf(name, "ep%din", i);
2589 struct_ep_setup(udc_controller, i * 2 + 1, name, 1);
2592 /* use dma_pool for TD management */
2593 udc_controller->td_pool = dma_pool_create("udc_td", &pdev->dev,
2594 sizeof(struct ep_td_struct),
2595 DTD_ALIGNMENT, UDC_DMA_BOUNDARY);
2596 if (udc_controller->td_pool == NULL) {
2598 goto err_unregister;
2601 ret = usb_add_gadget_udc(&pdev->dev, &udc_controller->gadget);
2609 dma_pool_destroy(udc_controller->td_pool);
2611 device_unregister(&udc_controller->gadget.dev);
2613 free_irq(udc_controller->irq, udc_controller);
2617 fsl_udc_clk_release();
2620 err_release_mem_region:
2621 if (pdata->operating_mode == FSL_USB2_DR_DEVICE)
2622 release_mem_region(res->start, resource_size(res));
2624 kfree(udc_controller);
2625 udc_controller = NULL;
2629 /* Driver removal function
2630 * Free resources and finish pending transactions
2632 static int __exit fsl_udc_remove(struct platform_device *pdev)
2634 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2635 struct fsl_usb2_platform_data *pdata = pdev->dev.platform_data;
2637 DECLARE_COMPLETION(done);
2639 if (!udc_controller)
2642 usb_del_gadget_udc(&udc_controller->gadget);
2643 udc_controller->done = &done;
2645 fsl_udc_clk_release();
2647 /* DR has been stopped in usb_gadget_unregister_driver() */
2650 /* Free allocated memory */
2651 kfree(udc_controller->status_req->req.buf);
2652 kfree(udc_controller->status_req);
2653 kfree(udc_controller->eps);
2655 dma_pool_destroy(udc_controller->td_pool);
2656 free_irq(udc_controller->irq, udc_controller);
2658 if (pdata->operating_mode == FSL_USB2_DR_DEVICE)
2659 release_mem_region(res->start, resource_size(res));
2661 device_unregister(&udc_controller->gadget.dev);
2662 /* free udc --wait for the release() finished */
2663 wait_for_completion(&done);
2666 * do platform specific un-initialization:
2667 * release iomux pins, etc.
2675 /*-----------------------------------------------------------------
2676 * Modify Power management attributes
2677 * Used by OTG statemachine to disable gadget temporarily
2678 -----------------------------------------------------------------*/
2679 static int fsl_udc_suspend(struct platform_device *pdev, pm_message_t state)
2681 dr_controller_stop(udc_controller);
2685 /*-----------------------------------------------------------------
2686 * Invoked on USB resume. May be called in_interrupt.
2687 * Here we start the DR controller and enable the irq
2688 *-----------------------------------------------------------------*/
2689 static int fsl_udc_resume(struct platform_device *pdev)
2691 /* Enable DR irq reg and set controller Run */
2692 if (udc_controller->stopped) {
2693 dr_controller_setup(udc_controller);
2694 dr_controller_run(udc_controller);
2696 udc_controller->usb_state = USB_STATE_ATTACHED;
2697 udc_controller->ep0_state = WAIT_FOR_SETUP;
2698 udc_controller->ep0_dir = 0;
2702 static int fsl_udc_otg_suspend(struct device *dev, pm_message_t state)
2704 struct fsl_udc *udc = udc_controller;
2707 mode = fsl_readl(&dr_regs->usbmode) & USB_MODE_CTRL_MODE_MASK;
2709 pr_debug("%s(): mode 0x%x stopped %d\n", __func__, mode, udc->stopped);
2712 * If the controller is already stopped, then this must be a
2713 * PM suspend. Remember this fact, so that we will leave the
2714 * controller stopped at PM resume time.
2717 pr_debug("gadget already stopped, leaving early\n");
2718 udc->already_stopped = 1;
2722 if (mode != USB_MODE_CTRL_MODE_DEVICE) {
2723 pr_debug("gadget not in device mode, leaving early\n");
2727 /* stop the controller */
2728 usbcmd = fsl_readl(&dr_regs->usbcmd) & ~USB_CMD_RUN_STOP;
2729 fsl_writel(usbcmd, &dr_regs->usbcmd);
2733 pr_info("USB Gadget suspended\n");
2738 static int fsl_udc_otg_resume(struct device *dev)
2740 pr_debug("%s(): stopped %d already_stopped %d\n", __func__,
2741 udc_controller->stopped, udc_controller->already_stopped);
2744 * If the controller was stopped at suspend time, then
2745 * don't resume it now.
2747 if (udc_controller->already_stopped) {
2748 udc_controller->already_stopped = 0;
2749 pr_debug("gadget was already stopped, leaving early\n");
2753 pr_info("USB Gadget resume\n");
2755 return fsl_udc_resume(NULL);
2757 /*-------------------------------------------------------------------------
2758 Register entry point for the peripheral controller driver
2759 --------------------------------------------------------------------------*/
2760 static const struct platform_device_id fsl_udc_devtype[] = {
2762 .name = "imx-udc-mx27",
2764 .name = "imx-udc-mx51",
2769 MODULE_DEVICE_TABLE(platform, fsl_udc_devtype);
2770 static struct platform_driver udc_driver = {
2771 .remove = __exit_p(fsl_udc_remove),
2772 /* Just for FSL i.mx SoC currently */
2773 .id_table = fsl_udc_devtype,
2774 /* these suspend and resume are not usb suspend and resume */
2775 .suspend = fsl_udc_suspend,
2776 .resume = fsl_udc_resume,
2778 .name = (char *)driver_name,
2779 .owner = THIS_MODULE,
2780 /* udc suspend/resume called from OTG driver */
2781 .suspend = fsl_udc_otg_suspend,
2782 .resume = fsl_udc_otg_resume,
2786 static int __init udc_init(void)
2788 printk(KERN_INFO "%s (%s)\n", driver_desc, DRIVER_VERSION);
2789 return platform_driver_probe(&udc_driver, fsl_udc_probe);
2792 module_init(udc_init);
2794 static void __exit udc_exit(void)
2796 platform_driver_unregister(&udc_driver);
2797 printk(KERN_WARNING "%s unregistered\n", driver_desc);
2800 module_exit(udc_exit);
2802 MODULE_DESCRIPTION(DRIVER_DESC);
2803 MODULE_AUTHOR(DRIVER_AUTHOR);
2804 MODULE_LICENSE("GPL");
2805 MODULE_ALIAS("platform:fsl-usb2-udc");