jme: Do not enable NIC WoL functions on S0
[linux/fpc-iii.git] / drivers / usb / chipidea / udc.c
blob8096116fc6618670912da2d96f4236d653e36327
1 /*
2 * udc.c - ChipIdea UDC driver
4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
6 * Author: David Lopo
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/delay.h>
14 #include <linux/device.h>
15 #include <linux/dmapool.h>
16 #include <linux/err.h>
17 #include <linux/irqreturn.h>
18 #include <linux/kernel.h>
19 #include <linux/slab.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/usb/ch9.h>
22 #include <linux/usb/gadget.h>
23 #include <linux/usb/otg-fsm.h>
24 #include <linux/usb/chipidea.h>
26 #include "ci.h"
27 #include "udc.h"
28 #include "bits.h"
29 #include "debug.h"
30 #include "otg.h"
31 #include "otg_fsm.h"
33 /* control endpoint description */
34 static const struct usb_endpoint_descriptor
35 ctrl_endpt_out_desc = {
36 .bLength = USB_DT_ENDPOINT_SIZE,
37 .bDescriptorType = USB_DT_ENDPOINT,
39 .bEndpointAddress = USB_DIR_OUT,
40 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
41 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
44 static const struct usb_endpoint_descriptor
45 ctrl_endpt_in_desc = {
46 .bLength = USB_DT_ENDPOINT_SIZE,
47 .bDescriptorType = USB_DT_ENDPOINT,
49 .bEndpointAddress = USB_DIR_IN,
50 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
51 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
54 /**
55 * hw_ep_bit: calculates the bit number
56 * @num: endpoint number
57 * @dir: endpoint direction
59 * This function returns bit number
61 static inline int hw_ep_bit(int num, int dir)
63 return num + (dir ? 16 : 0);
66 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
68 int fill = 16 - ci->hw_ep_max / 2;
70 if (n >= ci->hw_ep_max / 2)
71 n += fill;
73 return n;
76 /**
77 * hw_device_state: enables/disables interrupts (execute without interruption)
78 * @dma: 0 => disable, !0 => enable and set dma engine
80 * This function returns an error code
82 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
84 if (dma) {
85 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
86 /* interrupt, error, port change, reset, sleep/suspend */
87 hw_write(ci, OP_USBINTR, ~0,
88 USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
89 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
90 } else {
91 hw_write(ci, OP_USBINTR, ~0, 0);
92 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
94 return 0;
97 /**
98 * hw_ep_flush: flush endpoint fifo (execute without interruption)
99 * @num: endpoint number
100 * @dir: endpoint direction
102 * This function returns an error code
104 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
106 int n = hw_ep_bit(num, dir);
108 do {
109 /* flush any pending transfer */
110 hw_write(ci, OP_ENDPTFLUSH, ~0, BIT(n));
111 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
112 cpu_relax();
113 } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
115 return 0;
119 * hw_ep_disable: disables endpoint (execute without interruption)
120 * @num: endpoint number
121 * @dir: endpoint direction
123 * This function returns an error code
125 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
127 hw_ep_flush(ci, num, dir);
128 hw_write(ci, OP_ENDPTCTRL + num,
129 dir ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
130 return 0;
134 * hw_ep_enable: enables endpoint (execute without interruption)
135 * @num: endpoint number
136 * @dir: endpoint direction
137 * @type: endpoint type
139 * This function returns an error code
141 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
143 u32 mask, data;
145 if (dir) {
146 mask = ENDPTCTRL_TXT; /* type */
147 data = type << __ffs(mask);
149 mask |= ENDPTCTRL_TXS; /* unstall */
150 mask |= ENDPTCTRL_TXR; /* reset data toggle */
151 data |= ENDPTCTRL_TXR;
152 mask |= ENDPTCTRL_TXE; /* enable */
153 data |= ENDPTCTRL_TXE;
154 } else {
155 mask = ENDPTCTRL_RXT; /* type */
156 data = type << __ffs(mask);
158 mask |= ENDPTCTRL_RXS; /* unstall */
159 mask |= ENDPTCTRL_RXR; /* reset data toggle */
160 data |= ENDPTCTRL_RXR;
161 mask |= ENDPTCTRL_RXE; /* enable */
162 data |= ENDPTCTRL_RXE;
164 hw_write(ci, OP_ENDPTCTRL + num, mask, data);
165 return 0;
169 * hw_ep_get_halt: return endpoint halt status
170 * @num: endpoint number
171 * @dir: endpoint direction
173 * This function returns 1 if endpoint halted
175 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
177 u32 mask = dir ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
179 return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
183 * hw_ep_prime: primes endpoint (execute without interruption)
184 * @num: endpoint number
185 * @dir: endpoint direction
186 * @is_ctrl: true if control endpoint
188 * This function returns an error code
190 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
192 int n = hw_ep_bit(num, dir);
194 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
195 return -EAGAIN;
197 hw_write(ci, OP_ENDPTPRIME, ~0, BIT(n));
199 while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
200 cpu_relax();
201 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
202 return -EAGAIN;
204 /* status shoult be tested according with manual but it doesn't work */
205 return 0;
209 * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
210 * without interruption)
211 * @num: endpoint number
212 * @dir: endpoint direction
213 * @value: true => stall, false => unstall
215 * This function returns an error code
217 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
219 if (value != 0 && value != 1)
220 return -EINVAL;
222 do {
223 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
224 u32 mask_xs = dir ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
225 u32 mask_xr = dir ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
227 /* data toggle - reserved for EP0 but it's in ESS */
228 hw_write(ci, reg, mask_xs|mask_xr,
229 value ? mask_xs : mask_xr);
230 } while (value != hw_ep_get_halt(ci, num, dir));
232 return 0;
236 * hw_is_port_high_speed: test if port is high speed
238 * This function returns true if high speed port
240 static int hw_port_is_high_speed(struct ci_hdrc *ci)
242 return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
243 hw_read(ci, OP_PORTSC, PORTSC_HSP);
247 * hw_test_and_clear_complete: test & clear complete status (execute without
248 * interruption)
249 * @n: endpoint number
251 * This function returns complete status
253 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
255 n = ep_to_bit(ci, n);
256 return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
260 * hw_test_and_clear_intr_active: test & clear active interrupts (execute
261 * without interruption)
263 * This function returns active interrutps
265 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
267 u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
269 hw_write(ci, OP_USBSTS, ~0, reg);
270 return reg;
274 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
275 * interruption)
277 * This function returns guard value
279 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
281 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
285 * hw_test_and_set_setup_guard: test & set setup guard (execute without
286 * interruption)
288 * This function returns guard value
290 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
292 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
296 * hw_usb_set_address: configures USB address (execute without interruption)
297 * @value: new USB address
299 * This function explicitly sets the address, without the "USBADRA" (advance)
300 * feature, which is not supported by older versions of the controller.
302 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
304 hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
305 value << __ffs(DEVICEADDR_USBADR));
309 * hw_usb_reset: restart device after a bus reset (execute without
310 * interruption)
312 * This function returns an error code
314 static int hw_usb_reset(struct ci_hdrc *ci)
316 hw_usb_set_address(ci, 0);
318 /* ESS flushes only at end?!? */
319 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
321 /* clear setup token semaphores */
322 hw_write(ci, OP_ENDPTSETUPSTAT, 0, 0);
324 /* clear complete status */
325 hw_write(ci, OP_ENDPTCOMPLETE, 0, 0);
327 /* wait until all bits cleared */
328 while (hw_read(ci, OP_ENDPTPRIME, ~0))
329 udelay(10); /* not RTOS friendly */
331 /* reset all endpoints ? */
333 /* reset internal status and wait for further instructions
334 no need to verify the port reset status (ESS does it) */
336 return 0;
339 /******************************************************************************
340 * UTIL block
341 *****************************************************************************/
343 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
344 unsigned length)
346 int i;
347 u32 temp;
348 struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
349 GFP_ATOMIC);
351 if (node == NULL)
352 return -ENOMEM;
354 node->ptr = dma_pool_alloc(hwep->td_pool, GFP_ATOMIC,
355 &node->dma);
356 if (node->ptr == NULL) {
357 kfree(node);
358 return -ENOMEM;
361 memset(node->ptr, 0, sizeof(struct ci_hw_td));
362 node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
363 node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
364 node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
365 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX) {
366 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
368 if (hwreq->req.length == 0
369 || hwreq->req.length % hwep->ep.maxpacket)
370 mul++;
371 node->ptr->token |= mul << __ffs(TD_MULTO);
374 temp = (u32) (hwreq->req.dma + hwreq->req.actual);
375 if (length) {
376 node->ptr->page[0] = cpu_to_le32(temp);
377 for (i = 1; i < TD_PAGE_COUNT; i++) {
378 u32 page = temp + i * CI_HDRC_PAGE_SIZE;
379 page &= ~TD_RESERVED_MASK;
380 node->ptr->page[i] = cpu_to_le32(page);
384 hwreq->req.actual += length;
386 if (!list_empty(&hwreq->tds)) {
387 /* get the last entry */
388 lastnode = list_entry(hwreq->tds.prev,
389 struct td_node, td);
390 lastnode->ptr->next = cpu_to_le32(node->dma);
393 INIT_LIST_HEAD(&node->td);
394 list_add_tail(&node->td, &hwreq->tds);
396 return 0;
400 * _usb_addr: calculates endpoint address from direction & number
401 * @ep: endpoint
403 static inline u8 _usb_addr(struct ci_hw_ep *ep)
405 return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
409 * _hardware_queue: configures a request at hardware level
410 * @gadget: gadget
411 * @hwep: endpoint
413 * This function returns an error code
415 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
417 struct ci_hdrc *ci = hwep->ci;
418 int ret = 0;
419 unsigned rest = hwreq->req.length;
420 int pages = TD_PAGE_COUNT;
421 struct td_node *firstnode, *lastnode;
423 /* don't queue twice */
424 if (hwreq->req.status == -EALREADY)
425 return -EALREADY;
427 hwreq->req.status = -EALREADY;
429 ret = usb_gadget_map_request(&ci->gadget, &hwreq->req, hwep->dir);
430 if (ret)
431 return ret;
434 * The first buffer could be not page aligned.
435 * In that case we have to span into one extra td.
437 if (hwreq->req.dma % PAGE_SIZE)
438 pages--;
440 if (rest == 0)
441 add_td_to_list(hwep, hwreq, 0);
443 while (rest > 0) {
444 unsigned count = min(hwreq->req.length - hwreq->req.actual,
445 (unsigned)(pages * CI_HDRC_PAGE_SIZE));
446 add_td_to_list(hwep, hwreq, count);
447 rest -= count;
450 if (hwreq->req.zero && hwreq->req.length
451 && (hwreq->req.length % hwep->ep.maxpacket == 0))
452 add_td_to_list(hwep, hwreq, 0);
454 firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
456 lastnode = list_entry(hwreq->tds.prev,
457 struct td_node, td);
459 lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
460 if (!hwreq->req.no_interrupt)
461 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
462 wmb();
464 hwreq->req.actual = 0;
465 if (!list_empty(&hwep->qh.queue)) {
466 struct ci_hw_req *hwreqprev;
467 int n = hw_ep_bit(hwep->num, hwep->dir);
468 int tmp_stat;
469 struct td_node *prevlastnode;
470 u32 next = firstnode->dma & TD_ADDR_MASK;
472 hwreqprev = list_entry(hwep->qh.queue.prev,
473 struct ci_hw_req, queue);
474 prevlastnode = list_entry(hwreqprev->tds.prev,
475 struct td_node, td);
477 prevlastnode->ptr->next = cpu_to_le32(next);
478 wmb();
479 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
480 goto done;
481 do {
482 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
483 tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
484 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
485 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
486 if (tmp_stat)
487 goto done;
490 /* QH configuration */
491 hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
492 hwep->qh.ptr->td.token &=
493 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
495 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == RX) {
496 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
498 if (hwreq->req.length == 0
499 || hwreq->req.length % hwep->ep.maxpacket)
500 mul++;
501 hwep->qh.ptr->cap |= mul << __ffs(QH_MULT);
504 wmb(); /* synchronize before ep prime */
506 ret = hw_ep_prime(ci, hwep->num, hwep->dir,
507 hwep->type == USB_ENDPOINT_XFER_CONTROL);
508 done:
509 return ret;
513 * free_pending_td: remove a pending request for the endpoint
514 * @hwep: endpoint
516 static void free_pending_td(struct ci_hw_ep *hwep)
518 struct td_node *pending = hwep->pending_td;
520 dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
521 hwep->pending_td = NULL;
522 kfree(pending);
526 * _hardware_dequeue: handles a request at hardware level
527 * @gadget: gadget
528 * @hwep: endpoint
530 * This function returns an error code
532 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
534 u32 tmptoken;
535 struct td_node *node, *tmpnode;
536 unsigned remaining_length;
537 unsigned actual = hwreq->req.length;
539 if (hwreq->req.status != -EALREADY)
540 return -EINVAL;
542 hwreq->req.status = 0;
544 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
545 tmptoken = le32_to_cpu(node->ptr->token);
546 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
547 hwreq->req.status = -EALREADY;
548 return -EBUSY;
551 remaining_length = (tmptoken & TD_TOTAL_BYTES);
552 remaining_length >>= __ffs(TD_TOTAL_BYTES);
553 actual -= remaining_length;
555 hwreq->req.status = tmptoken & TD_STATUS;
556 if ((TD_STATUS_HALTED & hwreq->req.status)) {
557 hwreq->req.status = -EPIPE;
558 break;
559 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
560 hwreq->req.status = -EPROTO;
561 break;
562 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
563 hwreq->req.status = -EILSEQ;
564 break;
567 if (remaining_length) {
568 if (hwep->dir) {
569 hwreq->req.status = -EPROTO;
570 break;
574 * As the hardware could still address the freed td
575 * which will run the udc unusable, the cleanup of the
576 * td has to be delayed by one.
578 if (hwep->pending_td)
579 free_pending_td(hwep);
581 hwep->pending_td = node;
582 list_del_init(&node->td);
585 usb_gadget_unmap_request(&hwep->ci->gadget, &hwreq->req, hwep->dir);
587 hwreq->req.actual += actual;
589 if (hwreq->req.status)
590 return hwreq->req.status;
592 return hwreq->req.actual;
596 * _ep_nuke: dequeues all endpoint requests
597 * @hwep: endpoint
599 * This function returns an error code
600 * Caller must hold lock
602 static int _ep_nuke(struct ci_hw_ep *hwep)
603 __releases(hwep->lock)
604 __acquires(hwep->lock)
606 struct td_node *node, *tmpnode;
607 if (hwep == NULL)
608 return -EINVAL;
610 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
612 while (!list_empty(&hwep->qh.queue)) {
614 /* pop oldest request */
615 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
616 struct ci_hw_req, queue);
618 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
619 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
620 list_del_init(&node->td);
621 node->ptr = NULL;
622 kfree(node);
625 list_del_init(&hwreq->queue);
626 hwreq->req.status = -ESHUTDOWN;
628 if (hwreq->req.complete != NULL) {
629 spin_unlock(hwep->lock);
630 hwreq->req.complete(&hwep->ep, &hwreq->req);
631 spin_lock(hwep->lock);
635 if (hwep->pending_td)
636 free_pending_td(hwep);
638 return 0;
641 static int _ep_set_halt(struct usb_ep *ep, int value, bool check_transfer)
643 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
644 int direction, retval = 0;
645 unsigned long flags;
647 if (ep == NULL || hwep->ep.desc == NULL)
648 return -EINVAL;
650 if (usb_endpoint_xfer_isoc(hwep->ep.desc))
651 return -EOPNOTSUPP;
653 spin_lock_irqsave(hwep->lock, flags);
655 if (value && hwep->dir == TX && check_transfer &&
656 !list_empty(&hwep->qh.queue) &&
657 !usb_endpoint_xfer_control(hwep->ep.desc)) {
658 spin_unlock_irqrestore(hwep->lock, flags);
659 return -EAGAIN;
662 direction = hwep->dir;
663 do {
664 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
666 if (!value)
667 hwep->wedge = 0;
669 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
670 hwep->dir = (hwep->dir == TX) ? RX : TX;
672 } while (hwep->dir != direction);
674 spin_unlock_irqrestore(hwep->lock, flags);
675 return retval;
680 * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
681 * @gadget: gadget
683 * This function returns an error code
685 static int _gadget_stop_activity(struct usb_gadget *gadget)
687 struct usb_ep *ep;
688 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
689 unsigned long flags;
691 spin_lock_irqsave(&ci->lock, flags);
692 ci->gadget.speed = USB_SPEED_UNKNOWN;
693 ci->remote_wakeup = 0;
694 ci->suspended = 0;
695 spin_unlock_irqrestore(&ci->lock, flags);
697 /* flush all endpoints */
698 gadget_for_each_ep(ep, gadget) {
699 usb_ep_fifo_flush(ep);
701 usb_ep_fifo_flush(&ci->ep0out->ep);
702 usb_ep_fifo_flush(&ci->ep0in->ep);
704 /* make sure to disable all endpoints */
705 gadget_for_each_ep(ep, gadget) {
706 usb_ep_disable(ep);
709 if (ci->status != NULL) {
710 usb_ep_free_request(&ci->ep0in->ep, ci->status);
711 ci->status = NULL;
714 return 0;
717 /******************************************************************************
718 * ISR block
719 *****************************************************************************/
721 * isr_reset_handler: USB reset interrupt handler
722 * @ci: UDC device
724 * This function resets USB engine after a bus reset occurred
726 static void isr_reset_handler(struct ci_hdrc *ci)
727 __releases(ci->lock)
728 __acquires(ci->lock)
730 int retval;
732 spin_unlock(&ci->lock);
733 if (ci->gadget.speed != USB_SPEED_UNKNOWN) {
734 if (ci->driver)
735 ci->driver->disconnect(&ci->gadget);
738 retval = _gadget_stop_activity(&ci->gadget);
739 if (retval)
740 goto done;
742 retval = hw_usb_reset(ci);
743 if (retval)
744 goto done;
746 ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
747 if (ci->status == NULL)
748 retval = -ENOMEM;
750 usb_gadget_set_state(&ci->gadget, USB_STATE_DEFAULT);
752 done:
753 spin_lock(&ci->lock);
755 if (retval)
756 dev_err(ci->dev, "error: %i\n", retval);
760 * isr_get_status_complete: get_status request complete function
761 * @ep: endpoint
762 * @req: request handled
764 * Caller must release lock
766 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
768 if (ep == NULL || req == NULL)
769 return;
771 kfree(req->buf);
772 usb_ep_free_request(ep, req);
776 * _ep_queue: queues (submits) an I/O request to an endpoint
778 * Caller must hold lock
780 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
781 gfp_t __maybe_unused gfp_flags)
783 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
784 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
785 struct ci_hdrc *ci = hwep->ci;
786 int retval = 0;
788 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
789 return -EINVAL;
791 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
792 if (req->length)
793 hwep = (ci->ep0_dir == RX) ?
794 ci->ep0out : ci->ep0in;
795 if (!list_empty(&hwep->qh.queue)) {
796 _ep_nuke(hwep);
797 retval = -EOVERFLOW;
798 dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
799 _usb_addr(hwep));
803 if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
804 hwreq->req.length > (1 + hwep->ep.mult) * hwep->ep.maxpacket) {
805 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
806 return -EMSGSIZE;
809 /* first nuke then test link, e.g. previous status has not sent */
810 if (!list_empty(&hwreq->queue)) {
811 dev_err(hwep->ci->dev, "request already in queue\n");
812 return -EBUSY;
815 /* push request */
816 hwreq->req.status = -EINPROGRESS;
817 hwreq->req.actual = 0;
819 retval = _hardware_enqueue(hwep, hwreq);
821 if (retval == -EALREADY)
822 retval = 0;
823 if (!retval)
824 list_add_tail(&hwreq->queue, &hwep->qh.queue);
826 return retval;
830 * isr_get_status_response: get_status request response
831 * @ci: ci struct
832 * @setup: setup request packet
834 * This function returns an error code
836 static int isr_get_status_response(struct ci_hdrc *ci,
837 struct usb_ctrlrequest *setup)
838 __releases(hwep->lock)
839 __acquires(hwep->lock)
841 struct ci_hw_ep *hwep = ci->ep0in;
842 struct usb_request *req = NULL;
843 gfp_t gfp_flags = GFP_ATOMIC;
844 int dir, num, retval;
846 if (hwep == NULL || setup == NULL)
847 return -EINVAL;
849 spin_unlock(hwep->lock);
850 req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
851 spin_lock(hwep->lock);
852 if (req == NULL)
853 return -ENOMEM;
855 req->complete = isr_get_status_complete;
856 req->length = 2;
857 req->buf = kzalloc(req->length, gfp_flags);
858 if (req->buf == NULL) {
859 retval = -ENOMEM;
860 goto err_free_req;
863 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
864 /* Assume that device is bus powered for now. */
865 *(u16 *)req->buf = ci->remote_wakeup << 1;
866 } else if ((setup->bRequestType & USB_RECIP_MASK) \
867 == USB_RECIP_ENDPOINT) {
868 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
869 TX : RX;
870 num = le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
871 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
873 /* else do nothing; reserved for future use */
875 retval = _ep_queue(&hwep->ep, req, gfp_flags);
876 if (retval)
877 goto err_free_buf;
879 return 0;
881 err_free_buf:
882 kfree(req->buf);
883 err_free_req:
884 spin_unlock(hwep->lock);
885 usb_ep_free_request(&hwep->ep, req);
886 spin_lock(hwep->lock);
887 return retval;
891 * isr_setup_status_complete: setup_status request complete function
892 * @ep: endpoint
893 * @req: request handled
895 * Caller must release lock. Put the port in test mode if test mode
896 * feature is selected.
898 static void
899 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
901 struct ci_hdrc *ci = req->context;
902 unsigned long flags;
904 if (ci->setaddr) {
905 hw_usb_set_address(ci, ci->address);
906 ci->setaddr = false;
907 if (ci->address)
908 usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
911 spin_lock_irqsave(&ci->lock, flags);
912 if (ci->test_mode)
913 hw_port_test_set(ci, ci->test_mode);
914 spin_unlock_irqrestore(&ci->lock, flags);
918 * isr_setup_status_phase: queues the status phase of a setup transation
919 * @ci: ci struct
921 * This function returns an error code
923 static int isr_setup_status_phase(struct ci_hdrc *ci)
925 int retval;
926 struct ci_hw_ep *hwep;
928 hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
929 ci->status->context = ci;
930 ci->status->complete = isr_setup_status_complete;
932 retval = _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
934 return retval;
938 * isr_tr_complete_low: transaction complete low level handler
939 * @hwep: endpoint
941 * This function returns an error code
942 * Caller must hold lock
944 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
945 __releases(hwep->lock)
946 __acquires(hwep->lock)
948 struct ci_hw_req *hwreq, *hwreqtemp;
949 struct ci_hw_ep *hweptemp = hwep;
950 int retval = 0;
952 list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
953 queue) {
954 retval = _hardware_dequeue(hwep, hwreq);
955 if (retval < 0)
956 break;
957 list_del_init(&hwreq->queue);
958 if (hwreq->req.complete != NULL) {
959 spin_unlock(hwep->lock);
960 if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
961 hwreq->req.length)
962 hweptemp = hwep->ci->ep0in;
963 hwreq->req.complete(&hweptemp->ep, &hwreq->req);
964 spin_lock(hwep->lock);
968 if (retval == -EBUSY)
969 retval = 0;
971 return retval;
974 static int otg_a_alt_hnp_support(struct ci_hdrc *ci)
976 dev_warn(&ci->gadget.dev,
977 "connect the device to an alternate port if you want HNP\n");
978 return isr_setup_status_phase(ci);
982 * isr_setup_packet_handler: setup packet handler
983 * @ci: UDC descriptor
985 * This function handles setup packet
987 static void isr_setup_packet_handler(struct ci_hdrc *ci)
988 __releases(ci->lock)
989 __acquires(ci->lock)
991 struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
992 struct usb_ctrlrequest req;
993 int type, num, dir, err = -EINVAL;
994 u8 tmode = 0;
997 * Flush data and handshake transactions of previous
998 * setup packet.
1000 _ep_nuke(ci->ep0out);
1001 _ep_nuke(ci->ep0in);
1003 /* read_setup_packet */
1004 do {
1005 hw_test_and_set_setup_guard(ci);
1006 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1007 } while (!hw_test_and_clear_setup_guard(ci));
1009 type = req.bRequestType;
1011 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1013 switch (req.bRequest) {
1014 case USB_REQ_CLEAR_FEATURE:
1015 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1016 le16_to_cpu(req.wValue) ==
1017 USB_ENDPOINT_HALT) {
1018 if (req.wLength != 0)
1019 break;
1020 num = le16_to_cpu(req.wIndex);
1021 dir = num & USB_ENDPOINT_DIR_MASK;
1022 num &= USB_ENDPOINT_NUMBER_MASK;
1023 if (dir) /* TX */
1024 num += ci->hw_ep_max / 2;
1025 if (!ci->ci_hw_ep[num].wedge) {
1026 spin_unlock(&ci->lock);
1027 err = usb_ep_clear_halt(
1028 &ci->ci_hw_ep[num].ep);
1029 spin_lock(&ci->lock);
1030 if (err)
1031 break;
1033 err = isr_setup_status_phase(ci);
1034 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1035 le16_to_cpu(req.wValue) ==
1036 USB_DEVICE_REMOTE_WAKEUP) {
1037 if (req.wLength != 0)
1038 break;
1039 ci->remote_wakeup = 0;
1040 err = isr_setup_status_phase(ci);
1041 } else {
1042 goto delegate;
1044 break;
1045 case USB_REQ_GET_STATUS:
1046 if (type != (USB_DIR_IN|USB_RECIP_DEVICE) &&
1047 type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1048 type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1049 goto delegate;
1050 if (le16_to_cpu(req.wLength) != 2 ||
1051 le16_to_cpu(req.wValue) != 0)
1052 break;
1053 err = isr_get_status_response(ci, &req);
1054 break;
1055 case USB_REQ_SET_ADDRESS:
1056 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1057 goto delegate;
1058 if (le16_to_cpu(req.wLength) != 0 ||
1059 le16_to_cpu(req.wIndex) != 0)
1060 break;
1061 ci->address = (u8)le16_to_cpu(req.wValue);
1062 ci->setaddr = true;
1063 err = isr_setup_status_phase(ci);
1064 break;
1065 case USB_REQ_SET_FEATURE:
1066 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1067 le16_to_cpu(req.wValue) ==
1068 USB_ENDPOINT_HALT) {
1069 if (req.wLength != 0)
1070 break;
1071 num = le16_to_cpu(req.wIndex);
1072 dir = num & USB_ENDPOINT_DIR_MASK;
1073 num &= USB_ENDPOINT_NUMBER_MASK;
1074 if (dir) /* TX */
1075 num += ci->hw_ep_max / 2;
1077 spin_unlock(&ci->lock);
1078 err = _ep_set_halt(&ci->ci_hw_ep[num].ep, 1, false);
1079 spin_lock(&ci->lock);
1080 if (!err)
1081 isr_setup_status_phase(ci);
1082 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1083 if (req.wLength != 0)
1084 break;
1085 switch (le16_to_cpu(req.wValue)) {
1086 case USB_DEVICE_REMOTE_WAKEUP:
1087 ci->remote_wakeup = 1;
1088 err = isr_setup_status_phase(ci);
1089 break;
1090 case USB_DEVICE_TEST_MODE:
1091 tmode = le16_to_cpu(req.wIndex) >> 8;
1092 switch (tmode) {
1093 case TEST_J:
1094 case TEST_K:
1095 case TEST_SE0_NAK:
1096 case TEST_PACKET:
1097 case TEST_FORCE_EN:
1098 ci->test_mode = tmode;
1099 err = isr_setup_status_phase(
1100 ci);
1101 break;
1102 default:
1103 break;
1105 break;
1106 case USB_DEVICE_B_HNP_ENABLE:
1107 if (ci_otg_is_fsm_mode(ci)) {
1108 ci->gadget.b_hnp_enable = 1;
1109 err = isr_setup_status_phase(
1110 ci);
1112 break;
1113 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1114 if (ci_otg_is_fsm_mode(ci))
1115 err = otg_a_alt_hnp_support(ci);
1116 break;
1117 default:
1118 goto delegate;
1120 } else {
1121 goto delegate;
1123 break;
1124 default:
1125 delegate:
1126 if (req.wLength == 0) /* no data phase */
1127 ci->ep0_dir = TX;
1129 spin_unlock(&ci->lock);
1130 err = ci->driver->setup(&ci->gadget, &req);
1131 spin_lock(&ci->lock);
1132 break;
1135 if (err < 0) {
1136 spin_unlock(&ci->lock);
1137 if (_ep_set_halt(&hwep->ep, 1, false))
1138 dev_err(ci->dev, "error: _ep_set_halt\n");
1139 spin_lock(&ci->lock);
1144 * isr_tr_complete_handler: transaction complete interrupt handler
1145 * @ci: UDC descriptor
1147 * This function handles traffic events
1149 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1150 __releases(ci->lock)
1151 __acquires(ci->lock)
1153 unsigned i;
1154 int err;
1156 for (i = 0; i < ci->hw_ep_max; i++) {
1157 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1159 if (hwep->ep.desc == NULL)
1160 continue; /* not configured */
1162 if (hw_test_and_clear_complete(ci, i)) {
1163 err = isr_tr_complete_low(hwep);
1164 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1165 if (err > 0) /* needs status phase */
1166 err = isr_setup_status_phase(ci);
1167 if (err < 0) {
1168 spin_unlock(&ci->lock);
1169 if (_ep_set_halt(&hwep->ep, 1, false))
1170 dev_err(ci->dev,
1171 "error: _ep_set_halt\n");
1172 spin_lock(&ci->lock);
1177 /* Only handle setup packet below */
1178 if (i == 0 &&
1179 hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1180 isr_setup_packet_handler(ci);
1184 /******************************************************************************
1185 * ENDPT block
1186 *****************************************************************************/
1188 * ep_enable: configure endpoint, making it usable
1190 * Check usb_ep_enable() at "usb_gadget.h" for details
1192 static int ep_enable(struct usb_ep *ep,
1193 const struct usb_endpoint_descriptor *desc)
1195 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1196 int retval = 0;
1197 unsigned long flags;
1198 u32 cap = 0;
1200 if (ep == NULL || desc == NULL)
1201 return -EINVAL;
1203 spin_lock_irqsave(hwep->lock, flags);
1205 /* only internal SW should enable ctrl endpts */
1207 hwep->ep.desc = desc;
1209 if (!list_empty(&hwep->qh.queue))
1210 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1212 hwep->dir = usb_endpoint_dir_in(desc) ? TX : RX;
1213 hwep->num = usb_endpoint_num(desc);
1214 hwep->type = usb_endpoint_type(desc);
1216 hwep->ep.maxpacket = usb_endpoint_maxp(desc) & 0x07ff;
1217 hwep->ep.mult = QH_ISO_MULT(usb_endpoint_maxp(desc));
1219 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1220 cap |= QH_IOS;
1222 cap |= QH_ZLT;
1223 cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1225 * For ISO-TX, we set mult at QH as the largest value, and use
1226 * MultO at TD as real mult value.
1228 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1229 cap |= 3 << __ffs(QH_MULT);
1231 hwep->qh.ptr->cap = cpu_to_le32(cap);
1233 hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE); /* needed? */
1235 if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1236 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1237 retval = -EINVAL;
1241 * Enable endpoints in the HW other than ep0 as ep0
1242 * is always enabled
1244 if (hwep->num)
1245 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1246 hwep->type);
1248 spin_unlock_irqrestore(hwep->lock, flags);
1249 return retval;
1253 * ep_disable: endpoint is no longer usable
1255 * Check usb_ep_disable() at "usb_gadget.h" for details
1257 static int ep_disable(struct usb_ep *ep)
1259 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1260 int direction, retval = 0;
1261 unsigned long flags;
1263 if (ep == NULL)
1264 return -EINVAL;
1265 else if (hwep->ep.desc == NULL)
1266 return -EBUSY;
1268 spin_lock_irqsave(hwep->lock, flags);
1270 /* only internal SW should disable ctrl endpts */
1272 direction = hwep->dir;
1273 do {
1274 retval |= _ep_nuke(hwep);
1275 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1277 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1278 hwep->dir = (hwep->dir == TX) ? RX : TX;
1280 } while (hwep->dir != direction);
1282 hwep->ep.desc = NULL;
1284 spin_unlock_irqrestore(hwep->lock, flags);
1285 return retval;
1289 * ep_alloc_request: allocate a request object to use with this endpoint
1291 * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1293 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1295 struct ci_hw_req *hwreq = NULL;
1297 if (ep == NULL)
1298 return NULL;
1300 hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1301 if (hwreq != NULL) {
1302 INIT_LIST_HEAD(&hwreq->queue);
1303 INIT_LIST_HEAD(&hwreq->tds);
1306 return (hwreq == NULL) ? NULL : &hwreq->req;
1310 * ep_free_request: frees a request object
1312 * Check usb_ep_free_request() at "usb_gadget.h" for details
1314 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1316 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1317 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1318 struct td_node *node, *tmpnode;
1319 unsigned long flags;
1321 if (ep == NULL || req == NULL) {
1322 return;
1323 } else if (!list_empty(&hwreq->queue)) {
1324 dev_err(hwep->ci->dev, "freeing queued request\n");
1325 return;
1328 spin_lock_irqsave(hwep->lock, flags);
1330 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1331 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1332 list_del_init(&node->td);
1333 node->ptr = NULL;
1334 kfree(node);
1337 kfree(hwreq);
1339 spin_unlock_irqrestore(hwep->lock, flags);
1343 * ep_queue: queues (submits) an I/O request to an endpoint
1345 * Check usb_ep_queue()* at usb_gadget.h" for details
1347 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1348 gfp_t __maybe_unused gfp_flags)
1350 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1351 int retval = 0;
1352 unsigned long flags;
1354 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1355 return -EINVAL;
1357 spin_lock_irqsave(hwep->lock, flags);
1358 retval = _ep_queue(ep, req, gfp_flags);
1359 spin_unlock_irqrestore(hwep->lock, flags);
1360 return retval;
1364 * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1366 * Check usb_ep_dequeue() at "usb_gadget.h" for details
1368 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1370 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1371 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1372 unsigned long flags;
1373 struct td_node *node, *tmpnode;
1375 if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1376 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1377 list_empty(&hwep->qh.queue))
1378 return -EINVAL;
1380 spin_lock_irqsave(hwep->lock, flags);
1382 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1384 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1385 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1386 list_del(&node->td);
1387 kfree(node);
1390 /* pop request */
1391 list_del_init(&hwreq->queue);
1393 usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1395 req->status = -ECONNRESET;
1397 if (hwreq->req.complete != NULL) {
1398 spin_unlock(hwep->lock);
1399 hwreq->req.complete(&hwep->ep, &hwreq->req);
1400 spin_lock(hwep->lock);
1403 spin_unlock_irqrestore(hwep->lock, flags);
1404 return 0;
1408 * ep_set_halt: sets the endpoint halt feature
1410 * Check usb_ep_set_halt() at "usb_gadget.h" for details
1412 static int ep_set_halt(struct usb_ep *ep, int value)
1414 return _ep_set_halt(ep, value, true);
1418 * ep_set_wedge: sets the halt feature and ignores clear requests
1420 * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1422 static int ep_set_wedge(struct usb_ep *ep)
1424 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1425 unsigned long flags;
1427 if (ep == NULL || hwep->ep.desc == NULL)
1428 return -EINVAL;
1430 spin_lock_irqsave(hwep->lock, flags);
1431 hwep->wedge = 1;
1432 spin_unlock_irqrestore(hwep->lock, flags);
1434 return usb_ep_set_halt(ep);
1438 * ep_fifo_flush: flushes contents of a fifo
1440 * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1442 static void ep_fifo_flush(struct usb_ep *ep)
1444 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1445 unsigned long flags;
1447 if (ep == NULL) {
1448 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1449 return;
1452 spin_lock_irqsave(hwep->lock, flags);
1454 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1456 spin_unlock_irqrestore(hwep->lock, flags);
1460 * Endpoint-specific part of the API to the USB controller hardware
1461 * Check "usb_gadget.h" for details
1463 static const struct usb_ep_ops usb_ep_ops = {
1464 .enable = ep_enable,
1465 .disable = ep_disable,
1466 .alloc_request = ep_alloc_request,
1467 .free_request = ep_free_request,
1468 .queue = ep_queue,
1469 .dequeue = ep_dequeue,
1470 .set_halt = ep_set_halt,
1471 .set_wedge = ep_set_wedge,
1472 .fifo_flush = ep_fifo_flush,
1475 /******************************************************************************
1476 * GADGET block
1477 *****************************************************************************/
1478 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1480 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1481 unsigned long flags;
1482 int gadget_ready = 0;
1484 spin_lock_irqsave(&ci->lock, flags);
1485 ci->vbus_active = is_active;
1486 if (ci->driver)
1487 gadget_ready = 1;
1488 spin_unlock_irqrestore(&ci->lock, flags);
1490 if (gadget_ready) {
1491 if (is_active) {
1492 pm_runtime_get_sync(&_gadget->dev);
1493 hw_device_reset(ci, USBMODE_CM_DC);
1494 hw_device_state(ci, ci->ep0out->qh.dma);
1495 usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1496 } else {
1497 if (ci->driver)
1498 ci->driver->disconnect(&ci->gadget);
1499 hw_device_state(ci, 0);
1500 if (ci->platdata->notify_event)
1501 ci->platdata->notify_event(ci,
1502 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1503 _gadget_stop_activity(&ci->gadget);
1504 pm_runtime_put_sync(&_gadget->dev);
1505 usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1509 return 0;
1512 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1514 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1515 unsigned long flags;
1516 int ret = 0;
1518 spin_lock_irqsave(&ci->lock, flags);
1519 if (!ci->remote_wakeup) {
1520 ret = -EOPNOTSUPP;
1521 goto out;
1523 if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1524 ret = -EINVAL;
1525 goto out;
1527 hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1528 out:
1529 spin_unlock_irqrestore(&ci->lock, flags);
1530 return ret;
1533 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1535 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1537 if (ci->transceiver)
1538 return usb_phy_set_power(ci->transceiver, ma);
1539 return -ENOTSUPP;
1542 /* Change Data+ pullup status
1543 * this func is used by usb_gadget_connect/disconnet
1545 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1547 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1549 if (!ci->vbus_active)
1550 return -EOPNOTSUPP;
1552 if (is_on)
1553 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1554 else
1555 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1557 return 0;
1560 static int ci_udc_start(struct usb_gadget *gadget,
1561 struct usb_gadget_driver *driver);
1562 static int ci_udc_stop(struct usb_gadget *gadget,
1563 struct usb_gadget_driver *driver);
1565 * Device operations part of the API to the USB controller hardware,
1566 * which don't involve endpoints (or i/o)
1567 * Check "usb_gadget.h" for details
1569 static const struct usb_gadget_ops usb_gadget_ops = {
1570 .vbus_session = ci_udc_vbus_session,
1571 .wakeup = ci_udc_wakeup,
1572 .pullup = ci_udc_pullup,
1573 .vbus_draw = ci_udc_vbus_draw,
1574 .udc_start = ci_udc_start,
1575 .udc_stop = ci_udc_stop,
1578 static int init_eps(struct ci_hdrc *ci)
1580 int retval = 0, i, j;
1582 for (i = 0; i < ci->hw_ep_max/2; i++)
1583 for (j = RX; j <= TX; j++) {
1584 int k = i + j * ci->hw_ep_max/2;
1585 struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1587 scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1588 (j == TX) ? "in" : "out");
1590 hwep->ci = ci;
1591 hwep->lock = &ci->lock;
1592 hwep->td_pool = ci->td_pool;
1594 hwep->ep.name = hwep->name;
1595 hwep->ep.ops = &usb_ep_ops;
1597 * for ep0: maxP defined in desc, for other
1598 * eps, maxP is set by epautoconfig() called
1599 * by gadget layer
1601 usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1603 INIT_LIST_HEAD(&hwep->qh.queue);
1604 hwep->qh.ptr = dma_pool_alloc(ci->qh_pool, GFP_KERNEL,
1605 &hwep->qh.dma);
1606 if (hwep->qh.ptr == NULL)
1607 retval = -ENOMEM;
1608 else
1609 memset(hwep->qh.ptr, 0, sizeof(*hwep->qh.ptr));
1612 * set up shorthands for ep0 out and in endpoints,
1613 * don't add to gadget's ep_list
1615 if (i == 0) {
1616 if (j == RX)
1617 ci->ep0out = hwep;
1618 else
1619 ci->ep0in = hwep;
1621 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1622 continue;
1625 list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1628 return retval;
1631 static void destroy_eps(struct ci_hdrc *ci)
1633 int i;
1635 for (i = 0; i < ci->hw_ep_max; i++) {
1636 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1638 if (hwep->pending_td)
1639 free_pending_td(hwep);
1640 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1645 * ci_udc_start: register a gadget driver
1646 * @gadget: our gadget
1647 * @driver: the driver being registered
1649 * Interrupts are enabled here.
1651 static int ci_udc_start(struct usb_gadget *gadget,
1652 struct usb_gadget_driver *driver)
1654 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1655 unsigned long flags;
1656 int retval = -ENOMEM;
1658 if (driver->disconnect == NULL)
1659 return -EINVAL;
1662 ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1663 retval = usb_ep_enable(&ci->ep0out->ep);
1664 if (retval)
1665 return retval;
1667 ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1668 retval = usb_ep_enable(&ci->ep0in->ep);
1669 if (retval)
1670 return retval;
1672 ci->driver = driver;
1674 /* Start otg fsm for B-device */
1675 if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1676 ci_hdrc_otg_fsm_start(ci);
1677 return retval;
1680 pm_runtime_get_sync(&ci->gadget.dev);
1681 if (ci->vbus_active) {
1682 spin_lock_irqsave(&ci->lock, flags);
1683 hw_device_reset(ci, USBMODE_CM_DC);
1684 } else {
1685 pm_runtime_put_sync(&ci->gadget.dev);
1686 return retval;
1689 retval = hw_device_state(ci, ci->ep0out->qh.dma);
1690 spin_unlock_irqrestore(&ci->lock, flags);
1691 if (retval)
1692 pm_runtime_put_sync(&ci->gadget.dev);
1694 return retval;
1698 * ci_udc_stop: unregister a gadget driver
1700 static int ci_udc_stop(struct usb_gadget *gadget,
1701 struct usb_gadget_driver *driver)
1703 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1704 unsigned long flags;
1706 spin_lock_irqsave(&ci->lock, flags);
1708 if (ci->vbus_active) {
1709 hw_device_state(ci, 0);
1710 if (ci->platdata->notify_event)
1711 ci->platdata->notify_event(ci,
1712 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1713 spin_unlock_irqrestore(&ci->lock, flags);
1714 _gadget_stop_activity(&ci->gadget);
1715 spin_lock_irqsave(&ci->lock, flags);
1716 pm_runtime_put(&ci->gadget.dev);
1719 ci->driver = NULL;
1720 spin_unlock_irqrestore(&ci->lock, flags);
1722 return 0;
1725 /******************************************************************************
1726 * BUS block
1727 *****************************************************************************/
1729 * udc_irq: ci interrupt handler
1731 * This function returns IRQ_HANDLED if the IRQ has been handled
1732 * It locks access to registers
1734 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1736 irqreturn_t retval;
1737 u32 intr;
1739 if (ci == NULL)
1740 return IRQ_HANDLED;
1742 spin_lock(&ci->lock);
1744 if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1745 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1746 USBMODE_CM_DC) {
1747 spin_unlock(&ci->lock);
1748 return IRQ_NONE;
1751 intr = hw_test_and_clear_intr_active(ci);
1753 if (intr) {
1754 /* order defines priority - do NOT change it */
1755 if (USBi_URI & intr)
1756 isr_reset_handler(ci);
1758 if (USBi_PCI & intr) {
1759 ci->gadget.speed = hw_port_is_high_speed(ci) ?
1760 USB_SPEED_HIGH : USB_SPEED_FULL;
1761 if (ci->suspended && ci->driver->resume) {
1762 spin_unlock(&ci->lock);
1763 ci->driver->resume(&ci->gadget);
1764 spin_lock(&ci->lock);
1765 ci->suspended = 0;
1769 if (USBi_UI & intr)
1770 isr_tr_complete_handler(ci);
1772 if (USBi_SLI & intr) {
1773 if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1774 ci->driver->suspend) {
1775 ci->suspended = 1;
1776 spin_unlock(&ci->lock);
1777 ci->driver->suspend(&ci->gadget);
1778 usb_gadget_set_state(&ci->gadget,
1779 USB_STATE_SUSPENDED);
1780 spin_lock(&ci->lock);
1783 retval = IRQ_HANDLED;
1784 } else {
1785 retval = IRQ_NONE;
1787 spin_unlock(&ci->lock);
1789 return retval;
1793 * udc_start: initialize gadget role
1794 * @ci: chipidea controller
1796 static int udc_start(struct ci_hdrc *ci)
1798 struct device *dev = ci->dev;
1799 int retval = 0;
1801 spin_lock_init(&ci->lock);
1803 ci->gadget.ops = &usb_gadget_ops;
1804 ci->gadget.speed = USB_SPEED_UNKNOWN;
1805 ci->gadget.max_speed = USB_SPEED_HIGH;
1806 ci->gadget.is_otg = ci->is_otg ? 1 : 0;
1807 ci->gadget.name = ci->platdata->name;
1809 INIT_LIST_HEAD(&ci->gadget.ep_list);
1811 /* alloc resources */
1812 ci->qh_pool = dma_pool_create("ci_hw_qh", dev,
1813 sizeof(struct ci_hw_qh),
1814 64, CI_HDRC_PAGE_SIZE);
1815 if (ci->qh_pool == NULL)
1816 return -ENOMEM;
1818 ci->td_pool = dma_pool_create("ci_hw_td", dev,
1819 sizeof(struct ci_hw_td),
1820 64, CI_HDRC_PAGE_SIZE);
1821 if (ci->td_pool == NULL) {
1822 retval = -ENOMEM;
1823 goto free_qh_pool;
1826 retval = init_eps(ci);
1827 if (retval)
1828 goto free_pools;
1830 ci->gadget.ep0 = &ci->ep0in->ep;
1832 retval = usb_add_gadget_udc(dev, &ci->gadget);
1833 if (retval)
1834 goto destroy_eps;
1836 pm_runtime_no_callbacks(&ci->gadget.dev);
1837 pm_runtime_enable(&ci->gadget.dev);
1839 return retval;
1841 destroy_eps:
1842 destroy_eps(ci);
1843 free_pools:
1844 dma_pool_destroy(ci->td_pool);
1845 free_qh_pool:
1846 dma_pool_destroy(ci->qh_pool);
1847 return retval;
1851 * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1853 * No interrupts active, the IRQ has been released
1855 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1857 if (!ci->roles[CI_ROLE_GADGET])
1858 return;
1860 usb_del_gadget_udc(&ci->gadget);
1862 destroy_eps(ci);
1864 dma_pool_destroy(ci->td_pool);
1865 dma_pool_destroy(ci->qh_pool);
1868 static int udc_id_switch_for_device(struct ci_hdrc *ci)
1870 if (ci->is_otg)
1871 /* Clear and enable BSV irq */
1872 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
1873 OTGSC_BSVIS | OTGSC_BSVIE);
1875 return 0;
1878 static void udc_id_switch_for_host(struct ci_hdrc *ci)
1881 * host doesn't care B_SESSION_VALID event
1882 * so clear and disbale BSV irq
1884 if (ci->is_otg)
1885 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
1889 * ci_hdrc_gadget_init - initialize device related bits
1890 * ci: the controller
1892 * This function initializes the gadget, if the device is "device capable".
1894 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
1896 struct ci_role_driver *rdrv;
1898 if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
1899 return -ENXIO;
1901 rdrv = devm_kzalloc(ci->dev, sizeof(struct ci_role_driver), GFP_KERNEL);
1902 if (!rdrv)
1903 return -ENOMEM;
1905 rdrv->start = udc_id_switch_for_device;
1906 rdrv->stop = udc_id_switch_for_host;
1907 rdrv->irq = udc_irq;
1908 rdrv->name = "gadget";
1909 ci->roles[CI_ROLE_GADGET] = rdrv;
1911 return udc_start(ci);