Linux 4.14.51
[linux/fpc-iii.git] / drivers / usb / chipidea / udc.c
blobfe8a90543ea375b4931ef3b6fa02cdd8a3574aae
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 "otg.h"
30 #include "otg_fsm.h"
32 /* control endpoint description */
33 static const struct usb_endpoint_descriptor
34 ctrl_endpt_out_desc = {
35 .bLength = USB_DT_ENDPOINT_SIZE,
36 .bDescriptorType = USB_DT_ENDPOINT,
38 .bEndpointAddress = USB_DIR_OUT,
39 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
40 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
43 static const struct usb_endpoint_descriptor
44 ctrl_endpt_in_desc = {
45 .bLength = USB_DT_ENDPOINT_SIZE,
46 .bDescriptorType = USB_DT_ENDPOINT,
48 .bEndpointAddress = USB_DIR_IN,
49 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
50 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
53 /**
54 * hw_ep_bit: calculates the bit number
55 * @num: endpoint number
56 * @dir: endpoint direction
58 * This function returns bit number
60 static inline int hw_ep_bit(int num, int dir)
62 return num + ((dir == TX) ? 16 : 0);
65 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
67 int fill = 16 - ci->hw_ep_max / 2;
69 if (n >= ci->hw_ep_max / 2)
70 n += fill;
72 return n;
75 /**
76 * hw_device_state: enables/disables interrupts (execute without interruption)
77 * @dma: 0 => disable, !0 => enable and set dma engine
79 * This function returns an error code
81 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
83 if (dma) {
84 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
85 /* interrupt, error, port change, reset, sleep/suspend */
86 hw_write(ci, OP_USBINTR, ~0,
87 USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
88 } else {
89 hw_write(ci, OP_USBINTR, ~0, 0);
91 return 0;
94 /**
95 * hw_ep_flush: flush endpoint fifo (execute without interruption)
96 * @num: endpoint number
97 * @dir: endpoint direction
99 * This function returns an error code
101 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
103 int n = hw_ep_bit(num, dir);
105 do {
106 /* flush any pending transfer */
107 hw_write(ci, OP_ENDPTFLUSH, ~0, BIT(n));
108 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
109 cpu_relax();
110 } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
112 return 0;
116 * hw_ep_disable: disables endpoint (execute without interruption)
117 * @num: endpoint number
118 * @dir: endpoint direction
120 * This function returns an error code
122 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
124 hw_write(ci, OP_ENDPTCTRL + num,
125 (dir == TX) ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
126 return 0;
130 * hw_ep_enable: enables endpoint (execute without interruption)
131 * @num: endpoint number
132 * @dir: endpoint direction
133 * @type: endpoint type
135 * This function returns an error code
137 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
139 u32 mask, data;
141 if (dir == TX) {
142 mask = ENDPTCTRL_TXT; /* type */
143 data = type << __ffs(mask);
145 mask |= ENDPTCTRL_TXS; /* unstall */
146 mask |= ENDPTCTRL_TXR; /* reset data toggle */
147 data |= ENDPTCTRL_TXR;
148 mask |= ENDPTCTRL_TXE; /* enable */
149 data |= ENDPTCTRL_TXE;
150 } else {
151 mask = ENDPTCTRL_RXT; /* type */
152 data = type << __ffs(mask);
154 mask |= ENDPTCTRL_RXS; /* unstall */
155 mask |= ENDPTCTRL_RXR; /* reset data toggle */
156 data |= ENDPTCTRL_RXR;
157 mask |= ENDPTCTRL_RXE; /* enable */
158 data |= ENDPTCTRL_RXE;
160 hw_write(ci, OP_ENDPTCTRL + num, mask, data);
161 return 0;
165 * hw_ep_get_halt: return endpoint halt status
166 * @num: endpoint number
167 * @dir: endpoint direction
169 * This function returns 1 if endpoint halted
171 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
173 u32 mask = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
175 return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
179 * hw_ep_prime: primes endpoint (execute without interruption)
180 * @num: endpoint number
181 * @dir: endpoint direction
182 * @is_ctrl: true if control endpoint
184 * This function returns an error code
186 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
188 int n = hw_ep_bit(num, dir);
190 /* Synchronize before ep prime */
191 wmb();
193 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
194 return -EAGAIN;
196 hw_write(ci, OP_ENDPTPRIME, ~0, BIT(n));
198 while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
199 cpu_relax();
200 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
201 return -EAGAIN;
203 /* status shoult be tested according with manual but it doesn't work */
204 return 0;
208 * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
209 * without interruption)
210 * @num: endpoint number
211 * @dir: endpoint direction
212 * @value: true => stall, false => unstall
214 * This function returns an error code
216 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
218 if (value != 0 && value != 1)
219 return -EINVAL;
221 do {
222 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
223 u32 mask_xs = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
224 u32 mask_xr = (dir == TX) ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
226 /* data toggle - reserved for EP0 but it's in ESS */
227 hw_write(ci, reg, mask_xs|mask_xr,
228 value ? mask_xs : mask_xr);
229 } while (value != hw_ep_get_halt(ci, num, dir));
231 return 0;
235 * hw_is_port_high_speed: test if port is high speed
237 * This function returns true if high speed port
239 static int hw_port_is_high_speed(struct ci_hdrc *ci)
241 return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
242 hw_read(ci, OP_PORTSC, PORTSC_HSP);
246 * hw_test_and_clear_complete: test & clear complete status (execute without
247 * interruption)
248 * @n: endpoint number
250 * This function returns complete status
252 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
254 n = ep_to_bit(ci, n);
255 return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
259 * hw_test_and_clear_intr_active: test & clear active interrupts (execute
260 * without interruption)
262 * This function returns active interrutps
264 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
266 u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
268 hw_write(ci, OP_USBSTS, ~0, reg);
269 return reg;
273 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
274 * interruption)
276 * This function returns guard value
278 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
280 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
284 * hw_test_and_set_setup_guard: test & set setup guard (execute without
285 * interruption)
287 * This function returns guard value
289 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
291 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
295 * hw_usb_set_address: configures USB address (execute without interruption)
296 * @value: new USB address
298 * This function explicitly sets the address, without the "USBADRA" (advance)
299 * feature, which is not supported by older versions of the controller.
301 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
303 hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
304 value << __ffs(DEVICEADDR_USBADR));
308 * hw_usb_reset: restart device after a bus reset (execute without
309 * interruption)
311 * This function returns an error code
313 static int hw_usb_reset(struct ci_hdrc *ci)
315 hw_usb_set_address(ci, 0);
317 /* ESS flushes only at end?!? */
318 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
320 /* clear setup token semaphores */
321 hw_write(ci, OP_ENDPTSETUPSTAT, 0, 0);
323 /* clear complete status */
324 hw_write(ci, OP_ENDPTCOMPLETE, 0, 0);
326 /* wait until all bits cleared */
327 while (hw_read(ci, OP_ENDPTPRIME, ~0))
328 udelay(10); /* not RTOS friendly */
330 /* reset all endpoints ? */
332 /* reset internal status and wait for further instructions
333 no need to verify the port reset status (ESS does it) */
335 return 0;
338 /******************************************************************************
339 * UTIL block
340 *****************************************************************************/
342 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
343 unsigned length)
345 int i;
346 u32 temp;
347 struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
348 GFP_ATOMIC);
350 if (node == NULL)
351 return -ENOMEM;
353 node->ptr = dma_pool_zalloc(hwep->td_pool, GFP_ATOMIC, &node->dma);
354 if (node->ptr == NULL) {
355 kfree(node);
356 return -ENOMEM;
359 node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
360 node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
361 node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
362 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX) {
363 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
365 if (hwreq->req.length == 0
366 || hwreq->req.length % hwep->ep.maxpacket)
367 mul++;
368 node->ptr->token |= cpu_to_le32(mul << __ffs(TD_MULTO));
371 temp = (u32) (hwreq->req.dma + hwreq->req.actual);
372 if (length) {
373 node->ptr->page[0] = cpu_to_le32(temp);
374 for (i = 1; i < TD_PAGE_COUNT; i++) {
375 u32 page = temp + i * CI_HDRC_PAGE_SIZE;
376 page &= ~TD_RESERVED_MASK;
377 node->ptr->page[i] = cpu_to_le32(page);
381 hwreq->req.actual += length;
383 if (!list_empty(&hwreq->tds)) {
384 /* get the last entry */
385 lastnode = list_entry(hwreq->tds.prev,
386 struct td_node, td);
387 lastnode->ptr->next = cpu_to_le32(node->dma);
390 INIT_LIST_HEAD(&node->td);
391 list_add_tail(&node->td, &hwreq->tds);
393 return 0;
397 * _usb_addr: calculates endpoint address from direction & number
398 * @ep: endpoint
400 static inline u8 _usb_addr(struct ci_hw_ep *ep)
402 return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
406 * _hardware_enqueue: configures a request at hardware level
407 * @hwep: endpoint
408 * @hwreq: request
410 * This function returns an error code
412 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
414 struct ci_hdrc *ci = hwep->ci;
415 int ret = 0;
416 unsigned rest = hwreq->req.length;
417 int pages = TD_PAGE_COUNT;
418 struct td_node *firstnode, *lastnode;
420 /* don't queue twice */
421 if (hwreq->req.status == -EALREADY)
422 return -EALREADY;
424 hwreq->req.status = -EALREADY;
426 ret = usb_gadget_map_request_by_dev(ci->dev->parent,
427 &hwreq->req, hwep->dir);
428 if (ret)
429 return ret;
432 * The first buffer could be not page aligned.
433 * In that case we have to span into one extra td.
435 if (hwreq->req.dma % PAGE_SIZE)
436 pages--;
438 if (rest == 0) {
439 ret = add_td_to_list(hwep, hwreq, 0);
440 if (ret < 0)
441 goto done;
444 while (rest > 0) {
445 unsigned count = min(hwreq->req.length - hwreq->req.actual,
446 (unsigned)(pages * CI_HDRC_PAGE_SIZE));
447 ret = add_td_to_list(hwep, hwreq, count);
448 if (ret < 0)
449 goto done;
451 rest -= count;
454 if (hwreq->req.zero && hwreq->req.length && hwep->dir == TX
455 && (hwreq->req.length % hwep->ep.maxpacket == 0)) {
456 ret = add_td_to_list(hwep, hwreq, 0);
457 if (ret < 0)
458 goto done;
461 firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
463 lastnode = list_entry(hwreq->tds.prev,
464 struct td_node, td);
466 lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
467 if (!hwreq->req.no_interrupt)
468 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
469 wmb();
471 hwreq->req.actual = 0;
472 if (!list_empty(&hwep->qh.queue)) {
473 struct ci_hw_req *hwreqprev;
474 int n = hw_ep_bit(hwep->num, hwep->dir);
475 int tmp_stat;
476 struct td_node *prevlastnode;
477 u32 next = firstnode->dma & TD_ADDR_MASK;
479 hwreqprev = list_entry(hwep->qh.queue.prev,
480 struct ci_hw_req, queue);
481 prevlastnode = list_entry(hwreqprev->tds.prev,
482 struct td_node, td);
484 prevlastnode->ptr->next = cpu_to_le32(next);
485 wmb();
486 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
487 goto done;
488 do {
489 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
490 tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
491 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
492 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
493 if (tmp_stat)
494 goto done;
497 /* QH configuration */
498 hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
499 hwep->qh.ptr->td.token &=
500 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
502 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == RX) {
503 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
505 if (hwreq->req.length == 0
506 || hwreq->req.length % hwep->ep.maxpacket)
507 mul++;
508 hwep->qh.ptr->cap |= cpu_to_le32(mul << __ffs(QH_MULT));
511 ret = hw_ep_prime(ci, hwep->num, hwep->dir,
512 hwep->type == USB_ENDPOINT_XFER_CONTROL);
513 done:
514 return ret;
518 * free_pending_td: remove a pending request for the endpoint
519 * @hwep: endpoint
521 static void free_pending_td(struct ci_hw_ep *hwep)
523 struct td_node *pending = hwep->pending_td;
525 dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
526 hwep->pending_td = NULL;
527 kfree(pending);
530 static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep,
531 struct td_node *node)
533 hwep->qh.ptr->td.next = cpu_to_le32(node->dma);
534 hwep->qh.ptr->td.token &=
535 cpu_to_le32(~(TD_STATUS_HALTED | TD_STATUS_ACTIVE));
537 return hw_ep_prime(ci, hwep->num, hwep->dir,
538 hwep->type == USB_ENDPOINT_XFER_CONTROL);
542 * _hardware_dequeue: handles a request at hardware level
543 * @gadget: gadget
544 * @hwep: endpoint
546 * This function returns an error code
548 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
550 u32 tmptoken;
551 struct td_node *node, *tmpnode;
552 unsigned remaining_length;
553 unsigned actual = hwreq->req.length;
554 struct ci_hdrc *ci = hwep->ci;
556 if (hwreq->req.status != -EALREADY)
557 return -EINVAL;
559 hwreq->req.status = 0;
561 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
562 tmptoken = le32_to_cpu(node->ptr->token);
563 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
564 int n = hw_ep_bit(hwep->num, hwep->dir);
566 if (ci->rev == CI_REVISION_24)
567 if (!hw_read(ci, OP_ENDPTSTAT, BIT(n)))
568 reprime_dtd(ci, hwep, node);
569 hwreq->req.status = -EALREADY;
570 return -EBUSY;
573 remaining_length = (tmptoken & TD_TOTAL_BYTES);
574 remaining_length >>= __ffs(TD_TOTAL_BYTES);
575 actual -= remaining_length;
577 hwreq->req.status = tmptoken & TD_STATUS;
578 if ((TD_STATUS_HALTED & hwreq->req.status)) {
579 hwreq->req.status = -EPIPE;
580 break;
581 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
582 hwreq->req.status = -EPROTO;
583 break;
584 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
585 hwreq->req.status = -EILSEQ;
586 break;
589 if (remaining_length) {
590 if (hwep->dir == TX) {
591 hwreq->req.status = -EPROTO;
592 break;
596 * As the hardware could still address the freed td
597 * which will run the udc unusable, the cleanup of the
598 * td has to be delayed by one.
600 if (hwep->pending_td)
601 free_pending_td(hwep);
603 hwep->pending_td = node;
604 list_del_init(&node->td);
607 usb_gadget_unmap_request_by_dev(hwep->ci->dev->parent,
608 &hwreq->req, hwep->dir);
610 hwreq->req.actual += actual;
612 if (hwreq->req.status)
613 return hwreq->req.status;
615 return hwreq->req.actual;
619 * _ep_nuke: dequeues all endpoint requests
620 * @hwep: endpoint
622 * This function returns an error code
623 * Caller must hold lock
625 static int _ep_nuke(struct ci_hw_ep *hwep)
626 __releases(hwep->lock)
627 __acquires(hwep->lock)
629 struct td_node *node, *tmpnode;
630 if (hwep == NULL)
631 return -EINVAL;
633 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
635 while (!list_empty(&hwep->qh.queue)) {
637 /* pop oldest request */
638 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
639 struct ci_hw_req, queue);
641 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
642 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
643 list_del_init(&node->td);
644 node->ptr = NULL;
645 kfree(node);
648 list_del_init(&hwreq->queue);
649 hwreq->req.status = -ESHUTDOWN;
651 if (hwreq->req.complete != NULL) {
652 spin_unlock(hwep->lock);
653 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
654 spin_lock(hwep->lock);
658 if (hwep->pending_td)
659 free_pending_td(hwep);
661 return 0;
664 static int _ep_set_halt(struct usb_ep *ep, int value, bool check_transfer)
666 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
667 int direction, retval = 0;
668 unsigned long flags;
670 if (ep == NULL || hwep->ep.desc == NULL)
671 return -EINVAL;
673 if (usb_endpoint_xfer_isoc(hwep->ep.desc))
674 return -EOPNOTSUPP;
676 spin_lock_irqsave(hwep->lock, flags);
678 if (value && hwep->dir == TX && check_transfer &&
679 !list_empty(&hwep->qh.queue) &&
680 !usb_endpoint_xfer_control(hwep->ep.desc)) {
681 spin_unlock_irqrestore(hwep->lock, flags);
682 return -EAGAIN;
685 direction = hwep->dir;
686 do {
687 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
689 if (!value)
690 hwep->wedge = 0;
692 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
693 hwep->dir = (hwep->dir == TX) ? RX : TX;
695 } while (hwep->dir != direction);
697 spin_unlock_irqrestore(hwep->lock, flags);
698 return retval;
703 * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
704 * @gadget: gadget
706 * This function returns an error code
708 static int _gadget_stop_activity(struct usb_gadget *gadget)
710 struct usb_ep *ep;
711 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
712 unsigned long flags;
714 spin_lock_irqsave(&ci->lock, flags);
715 ci->gadget.speed = USB_SPEED_UNKNOWN;
716 ci->remote_wakeup = 0;
717 ci->suspended = 0;
718 spin_unlock_irqrestore(&ci->lock, flags);
720 /* flush all endpoints */
721 gadget_for_each_ep(ep, gadget) {
722 usb_ep_fifo_flush(ep);
724 usb_ep_fifo_flush(&ci->ep0out->ep);
725 usb_ep_fifo_flush(&ci->ep0in->ep);
727 /* make sure to disable all endpoints */
728 gadget_for_each_ep(ep, gadget) {
729 usb_ep_disable(ep);
732 if (ci->status != NULL) {
733 usb_ep_free_request(&ci->ep0in->ep, ci->status);
734 ci->status = NULL;
737 return 0;
740 /******************************************************************************
741 * ISR block
742 *****************************************************************************/
744 * isr_reset_handler: USB reset interrupt handler
745 * @ci: UDC device
747 * This function resets USB engine after a bus reset occurred
749 static void isr_reset_handler(struct ci_hdrc *ci)
750 __releases(ci->lock)
751 __acquires(ci->lock)
753 int retval;
755 spin_unlock(&ci->lock);
756 if (ci->gadget.speed != USB_SPEED_UNKNOWN)
757 usb_gadget_udc_reset(&ci->gadget, ci->driver);
759 retval = _gadget_stop_activity(&ci->gadget);
760 if (retval)
761 goto done;
763 retval = hw_usb_reset(ci);
764 if (retval)
765 goto done;
767 ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
768 if (ci->status == NULL)
769 retval = -ENOMEM;
771 done:
772 spin_lock(&ci->lock);
774 if (retval)
775 dev_err(ci->dev, "error: %i\n", retval);
779 * isr_get_status_complete: get_status request complete function
780 * @ep: endpoint
781 * @req: request handled
783 * Caller must release lock
785 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
787 if (ep == NULL || req == NULL)
788 return;
790 kfree(req->buf);
791 usb_ep_free_request(ep, req);
795 * _ep_queue: queues (submits) an I/O request to an endpoint
796 * @ep: endpoint
797 * @req: request
798 * @gfp_flags: GFP flags (not used)
800 * Caller must hold lock
801 * This function returns an error code
803 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
804 gfp_t __maybe_unused gfp_flags)
806 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
807 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
808 struct ci_hdrc *ci = hwep->ci;
809 int retval = 0;
811 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
812 return -EINVAL;
814 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
815 if (req->length)
816 hwep = (ci->ep0_dir == RX) ?
817 ci->ep0out : ci->ep0in;
818 if (!list_empty(&hwep->qh.queue)) {
819 _ep_nuke(hwep);
820 dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
821 _usb_addr(hwep));
825 if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
826 hwreq->req.length > hwep->ep.mult * hwep->ep.maxpacket) {
827 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
828 return -EMSGSIZE;
831 /* first nuke then test link, e.g. previous status has not sent */
832 if (!list_empty(&hwreq->queue)) {
833 dev_err(hwep->ci->dev, "request already in queue\n");
834 return -EBUSY;
837 /* push request */
838 hwreq->req.status = -EINPROGRESS;
839 hwreq->req.actual = 0;
841 retval = _hardware_enqueue(hwep, hwreq);
843 if (retval == -EALREADY)
844 retval = 0;
845 if (!retval)
846 list_add_tail(&hwreq->queue, &hwep->qh.queue);
848 return retval;
852 * isr_get_status_response: get_status request response
853 * @ci: ci struct
854 * @setup: setup request packet
856 * This function returns an error code
858 static int isr_get_status_response(struct ci_hdrc *ci,
859 struct usb_ctrlrequest *setup)
860 __releases(hwep->lock)
861 __acquires(hwep->lock)
863 struct ci_hw_ep *hwep = ci->ep0in;
864 struct usb_request *req = NULL;
865 gfp_t gfp_flags = GFP_ATOMIC;
866 int dir, num, retval;
868 if (hwep == NULL || setup == NULL)
869 return -EINVAL;
871 spin_unlock(hwep->lock);
872 req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
873 spin_lock(hwep->lock);
874 if (req == NULL)
875 return -ENOMEM;
877 req->complete = isr_get_status_complete;
878 req->length = 2;
879 req->buf = kzalloc(req->length, gfp_flags);
880 if (req->buf == NULL) {
881 retval = -ENOMEM;
882 goto err_free_req;
885 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
886 *(u16 *)req->buf = (ci->remote_wakeup << 1) |
887 ci->gadget.is_selfpowered;
888 } else if ((setup->bRequestType & USB_RECIP_MASK) \
889 == USB_RECIP_ENDPOINT) {
890 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
891 TX : RX;
892 num = le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
893 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
895 /* else do nothing; reserved for future use */
897 retval = _ep_queue(&hwep->ep, req, gfp_flags);
898 if (retval)
899 goto err_free_buf;
901 return 0;
903 err_free_buf:
904 kfree(req->buf);
905 err_free_req:
906 spin_unlock(hwep->lock);
907 usb_ep_free_request(&hwep->ep, req);
908 spin_lock(hwep->lock);
909 return retval;
913 * isr_setup_status_complete: setup_status request complete function
914 * @ep: endpoint
915 * @req: request handled
917 * Caller must release lock. Put the port in test mode if test mode
918 * feature is selected.
920 static void
921 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
923 struct ci_hdrc *ci = req->context;
924 unsigned long flags;
926 if (ci->setaddr) {
927 hw_usb_set_address(ci, ci->address);
928 ci->setaddr = false;
929 if (ci->address)
930 usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
933 spin_lock_irqsave(&ci->lock, flags);
934 if (ci->test_mode)
935 hw_port_test_set(ci, ci->test_mode);
936 spin_unlock_irqrestore(&ci->lock, flags);
940 * isr_setup_status_phase: queues the status phase of a setup transation
941 * @ci: ci struct
943 * This function returns an error code
945 static int isr_setup_status_phase(struct ci_hdrc *ci)
947 struct ci_hw_ep *hwep;
950 * Unexpected USB controller behavior, caused by bad signal integrity
951 * or ground reference problems, can lead to isr_setup_status_phase
952 * being called with ci->status equal to NULL.
953 * If this situation occurs, you should review your USB hardware design.
955 if (WARN_ON_ONCE(!ci->status))
956 return -EPIPE;
958 hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
959 ci->status->context = ci;
960 ci->status->complete = isr_setup_status_complete;
962 return _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
966 * isr_tr_complete_low: transaction complete low level handler
967 * @hwep: endpoint
969 * This function returns an error code
970 * Caller must hold lock
972 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
973 __releases(hwep->lock)
974 __acquires(hwep->lock)
976 struct ci_hw_req *hwreq, *hwreqtemp;
977 struct ci_hw_ep *hweptemp = hwep;
978 int retval = 0;
980 list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
981 queue) {
982 retval = _hardware_dequeue(hwep, hwreq);
983 if (retval < 0)
984 break;
985 list_del_init(&hwreq->queue);
986 if (hwreq->req.complete != NULL) {
987 spin_unlock(hwep->lock);
988 if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
989 hwreq->req.length)
990 hweptemp = hwep->ci->ep0in;
991 usb_gadget_giveback_request(&hweptemp->ep, &hwreq->req);
992 spin_lock(hwep->lock);
996 if (retval == -EBUSY)
997 retval = 0;
999 return retval;
1002 static int otg_a_alt_hnp_support(struct ci_hdrc *ci)
1004 dev_warn(&ci->gadget.dev,
1005 "connect the device to an alternate port if you want HNP\n");
1006 return isr_setup_status_phase(ci);
1010 * isr_setup_packet_handler: setup packet handler
1011 * @ci: UDC descriptor
1013 * This function handles setup packet
1015 static void isr_setup_packet_handler(struct ci_hdrc *ci)
1016 __releases(ci->lock)
1017 __acquires(ci->lock)
1019 struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
1020 struct usb_ctrlrequest req;
1021 int type, num, dir, err = -EINVAL;
1022 u8 tmode = 0;
1025 * Flush data and handshake transactions of previous
1026 * setup packet.
1028 _ep_nuke(ci->ep0out);
1029 _ep_nuke(ci->ep0in);
1031 /* read_setup_packet */
1032 do {
1033 hw_test_and_set_setup_guard(ci);
1034 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1035 } while (!hw_test_and_clear_setup_guard(ci));
1037 type = req.bRequestType;
1039 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1041 switch (req.bRequest) {
1042 case USB_REQ_CLEAR_FEATURE:
1043 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1044 le16_to_cpu(req.wValue) ==
1045 USB_ENDPOINT_HALT) {
1046 if (req.wLength != 0)
1047 break;
1048 num = le16_to_cpu(req.wIndex);
1049 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1050 num &= USB_ENDPOINT_NUMBER_MASK;
1051 if (dir == TX)
1052 num += ci->hw_ep_max / 2;
1053 if (!ci->ci_hw_ep[num].wedge) {
1054 spin_unlock(&ci->lock);
1055 err = usb_ep_clear_halt(
1056 &ci->ci_hw_ep[num].ep);
1057 spin_lock(&ci->lock);
1058 if (err)
1059 break;
1061 err = isr_setup_status_phase(ci);
1062 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1063 le16_to_cpu(req.wValue) ==
1064 USB_DEVICE_REMOTE_WAKEUP) {
1065 if (req.wLength != 0)
1066 break;
1067 ci->remote_wakeup = 0;
1068 err = isr_setup_status_phase(ci);
1069 } else {
1070 goto delegate;
1072 break;
1073 case USB_REQ_GET_STATUS:
1074 if ((type != (USB_DIR_IN|USB_RECIP_DEVICE) ||
1075 le16_to_cpu(req.wIndex) == OTG_STS_SELECTOR) &&
1076 type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1077 type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1078 goto delegate;
1079 if (le16_to_cpu(req.wLength) != 2 ||
1080 le16_to_cpu(req.wValue) != 0)
1081 break;
1082 err = isr_get_status_response(ci, &req);
1083 break;
1084 case USB_REQ_SET_ADDRESS:
1085 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1086 goto delegate;
1087 if (le16_to_cpu(req.wLength) != 0 ||
1088 le16_to_cpu(req.wIndex) != 0)
1089 break;
1090 ci->address = (u8)le16_to_cpu(req.wValue);
1091 ci->setaddr = true;
1092 err = isr_setup_status_phase(ci);
1093 break;
1094 case USB_REQ_SET_FEATURE:
1095 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1096 le16_to_cpu(req.wValue) ==
1097 USB_ENDPOINT_HALT) {
1098 if (req.wLength != 0)
1099 break;
1100 num = le16_to_cpu(req.wIndex);
1101 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1102 num &= USB_ENDPOINT_NUMBER_MASK;
1103 if (dir == TX)
1104 num += ci->hw_ep_max / 2;
1106 spin_unlock(&ci->lock);
1107 err = _ep_set_halt(&ci->ci_hw_ep[num].ep, 1, false);
1108 spin_lock(&ci->lock);
1109 if (!err)
1110 isr_setup_status_phase(ci);
1111 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1112 if (req.wLength != 0)
1113 break;
1114 switch (le16_to_cpu(req.wValue)) {
1115 case USB_DEVICE_REMOTE_WAKEUP:
1116 ci->remote_wakeup = 1;
1117 err = isr_setup_status_phase(ci);
1118 break;
1119 case USB_DEVICE_TEST_MODE:
1120 tmode = le16_to_cpu(req.wIndex) >> 8;
1121 switch (tmode) {
1122 case TEST_J:
1123 case TEST_K:
1124 case TEST_SE0_NAK:
1125 case TEST_PACKET:
1126 case TEST_FORCE_EN:
1127 ci->test_mode = tmode;
1128 err = isr_setup_status_phase(
1129 ci);
1130 break;
1131 default:
1132 break;
1134 break;
1135 case USB_DEVICE_B_HNP_ENABLE:
1136 if (ci_otg_is_fsm_mode(ci)) {
1137 ci->gadget.b_hnp_enable = 1;
1138 err = isr_setup_status_phase(
1139 ci);
1141 break;
1142 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1143 if (ci_otg_is_fsm_mode(ci))
1144 err = otg_a_alt_hnp_support(ci);
1145 break;
1146 case USB_DEVICE_A_HNP_SUPPORT:
1147 if (ci_otg_is_fsm_mode(ci)) {
1148 ci->gadget.a_hnp_support = 1;
1149 err = isr_setup_status_phase(
1150 ci);
1152 break;
1153 default:
1154 goto delegate;
1156 } else {
1157 goto delegate;
1159 break;
1160 default:
1161 delegate:
1162 if (req.wLength == 0) /* no data phase */
1163 ci->ep0_dir = TX;
1165 spin_unlock(&ci->lock);
1166 err = ci->driver->setup(&ci->gadget, &req);
1167 spin_lock(&ci->lock);
1168 break;
1171 if (err < 0) {
1172 spin_unlock(&ci->lock);
1173 if (_ep_set_halt(&hwep->ep, 1, false))
1174 dev_err(ci->dev, "error: _ep_set_halt\n");
1175 spin_lock(&ci->lock);
1180 * isr_tr_complete_handler: transaction complete interrupt handler
1181 * @ci: UDC descriptor
1183 * This function handles traffic events
1185 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1186 __releases(ci->lock)
1187 __acquires(ci->lock)
1189 unsigned i;
1190 int err;
1192 for (i = 0; i < ci->hw_ep_max; i++) {
1193 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1195 if (hwep->ep.desc == NULL)
1196 continue; /* not configured */
1198 if (hw_test_and_clear_complete(ci, i)) {
1199 err = isr_tr_complete_low(hwep);
1200 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1201 if (err > 0) /* needs status phase */
1202 err = isr_setup_status_phase(ci);
1203 if (err < 0) {
1204 spin_unlock(&ci->lock);
1205 if (_ep_set_halt(&hwep->ep, 1, false))
1206 dev_err(ci->dev,
1207 "error: _ep_set_halt\n");
1208 spin_lock(&ci->lock);
1213 /* Only handle setup packet below */
1214 if (i == 0 &&
1215 hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1216 isr_setup_packet_handler(ci);
1220 /******************************************************************************
1221 * ENDPT block
1222 *****************************************************************************/
1224 * ep_enable: configure endpoint, making it usable
1226 * Check usb_ep_enable() at "usb_gadget.h" for details
1228 static int ep_enable(struct usb_ep *ep,
1229 const struct usb_endpoint_descriptor *desc)
1231 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1232 int retval = 0;
1233 unsigned long flags;
1234 u32 cap = 0;
1236 if (ep == NULL || desc == NULL)
1237 return -EINVAL;
1239 spin_lock_irqsave(hwep->lock, flags);
1241 /* only internal SW should enable ctrl endpts */
1243 if (!list_empty(&hwep->qh.queue)) {
1244 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1245 spin_unlock_irqrestore(hwep->lock, flags);
1246 return -EBUSY;
1249 hwep->ep.desc = desc;
1251 hwep->dir = usb_endpoint_dir_in(desc) ? TX : RX;
1252 hwep->num = usb_endpoint_num(desc);
1253 hwep->type = usb_endpoint_type(desc);
1255 hwep->ep.maxpacket = usb_endpoint_maxp(desc);
1256 hwep->ep.mult = usb_endpoint_maxp_mult(desc);
1258 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1259 cap |= QH_IOS;
1261 cap |= QH_ZLT;
1262 cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1264 * For ISO-TX, we set mult at QH as the largest value, and use
1265 * MultO at TD as real mult value.
1267 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1268 cap |= 3 << __ffs(QH_MULT);
1270 hwep->qh.ptr->cap = cpu_to_le32(cap);
1272 hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE); /* needed? */
1274 if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1275 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1276 retval = -EINVAL;
1280 * Enable endpoints in the HW other than ep0 as ep0
1281 * is always enabled
1283 if (hwep->num)
1284 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1285 hwep->type);
1287 spin_unlock_irqrestore(hwep->lock, flags);
1288 return retval;
1292 * ep_disable: endpoint is no longer usable
1294 * Check usb_ep_disable() at "usb_gadget.h" for details
1296 static int ep_disable(struct usb_ep *ep)
1298 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1299 int direction, retval = 0;
1300 unsigned long flags;
1302 if (ep == NULL)
1303 return -EINVAL;
1304 else if (hwep->ep.desc == NULL)
1305 return -EBUSY;
1307 spin_lock_irqsave(hwep->lock, flags);
1309 /* only internal SW should disable ctrl endpts */
1311 direction = hwep->dir;
1312 do {
1313 retval |= _ep_nuke(hwep);
1314 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1316 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1317 hwep->dir = (hwep->dir == TX) ? RX : TX;
1319 } while (hwep->dir != direction);
1321 hwep->ep.desc = NULL;
1323 spin_unlock_irqrestore(hwep->lock, flags);
1324 return retval;
1328 * ep_alloc_request: allocate a request object to use with this endpoint
1330 * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1332 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1334 struct ci_hw_req *hwreq = NULL;
1336 if (ep == NULL)
1337 return NULL;
1339 hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1340 if (hwreq != NULL) {
1341 INIT_LIST_HEAD(&hwreq->queue);
1342 INIT_LIST_HEAD(&hwreq->tds);
1345 return (hwreq == NULL) ? NULL : &hwreq->req;
1349 * ep_free_request: frees a request object
1351 * Check usb_ep_free_request() at "usb_gadget.h" for details
1353 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1355 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1356 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1357 struct td_node *node, *tmpnode;
1358 unsigned long flags;
1360 if (ep == NULL || req == NULL) {
1361 return;
1362 } else if (!list_empty(&hwreq->queue)) {
1363 dev_err(hwep->ci->dev, "freeing queued request\n");
1364 return;
1367 spin_lock_irqsave(hwep->lock, flags);
1369 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1370 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1371 list_del_init(&node->td);
1372 node->ptr = NULL;
1373 kfree(node);
1376 kfree(hwreq);
1378 spin_unlock_irqrestore(hwep->lock, flags);
1382 * ep_queue: queues (submits) an I/O request to an endpoint
1384 * Check usb_ep_queue()* at usb_gadget.h" for details
1386 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1387 gfp_t __maybe_unused gfp_flags)
1389 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1390 int retval = 0;
1391 unsigned long flags;
1393 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1394 return -EINVAL;
1396 spin_lock_irqsave(hwep->lock, flags);
1397 retval = _ep_queue(ep, req, gfp_flags);
1398 spin_unlock_irqrestore(hwep->lock, flags);
1399 return retval;
1403 * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1405 * Check usb_ep_dequeue() at "usb_gadget.h" for details
1407 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1409 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1410 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1411 unsigned long flags;
1412 struct td_node *node, *tmpnode;
1414 if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1415 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1416 list_empty(&hwep->qh.queue))
1417 return -EINVAL;
1419 spin_lock_irqsave(hwep->lock, flags);
1421 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1423 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1424 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1425 list_del(&node->td);
1426 kfree(node);
1429 /* pop request */
1430 list_del_init(&hwreq->queue);
1432 usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1434 req->status = -ECONNRESET;
1436 if (hwreq->req.complete != NULL) {
1437 spin_unlock(hwep->lock);
1438 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
1439 spin_lock(hwep->lock);
1442 spin_unlock_irqrestore(hwep->lock, flags);
1443 return 0;
1447 * ep_set_halt: sets the endpoint halt feature
1449 * Check usb_ep_set_halt() at "usb_gadget.h" for details
1451 static int ep_set_halt(struct usb_ep *ep, int value)
1453 return _ep_set_halt(ep, value, true);
1457 * ep_set_wedge: sets the halt feature and ignores clear requests
1459 * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1461 static int ep_set_wedge(struct usb_ep *ep)
1463 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1464 unsigned long flags;
1466 if (ep == NULL || hwep->ep.desc == NULL)
1467 return -EINVAL;
1469 spin_lock_irqsave(hwep->lock, flags);
1470 hwep->wedge = 1;
1471 spin_unlock_irqrestore(hwep->lock, flags);
1473 return usb_ep_set_halt(ep);
1477 * ep_fifo_flush: flushes contents of a fifo
1479 * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1481 static void ep_fifo_flush(struct usb_ep *ep)
1483 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1484 unsigned long flags;
1486 if (ep == NULL) {
1487 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1488 return;
1491 spin_lock_irqsave(hwep->lock, flags);
1493 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1495 spin_unlock_irqrestore(hwep->lock, flags);
1499 * Endpoint-specific part of the API to the USB controller hardware
1500 * Check "usb_gadget.h" for details
1502 static const struct usb_ep_ops usb_ep_ops = {
1503 .enable = ep_enable,
1504 .disable = ep_disable,
1505 .alloc_request = ep_alloc_request,
1506 .free_request = ep_free_request,
1507 .queue = ep_queue,
1508 .dequeue = ep_dequeue,
1509 .set_halt = ep_set_halt,
1510 .set_wedge = ep_set_wedge,
1511 .fifo_flush = ep_fifo_flush,
1514 /******************************************************************************
1515 * GADGET block
1516 *****************************************************************************/
1517 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1519 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1520 unsigned long flags;
1521 int gadget_ready = 0;
1523 spin_lock_irqsave(&ci->lock, flags);
1524 ci->vbus_active = is_active;
1525 if (ci->driver)
1526 gadget_ready = 1;
1527 spin_unlock_irqrestore(&ci->lock, flags);
1529 if (gadget_ready) {
1530 if (is_active) {
1531 pm_runtime_get_sync(&_gadget->dev);
1532 hw_device_reset(ci);
1533 hw_device_state(ci, ci->ep0out->qh.dma);
1534 usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1535 usb_udc_vbus_handler(_gadget, true);
1536 } else {
1537 usb_udc_vbus_handler(_gadget, false);
1538 if (ci->driver)
1539 ci->driver->disconnect(&ci->gadget);
1540 hw_device_state(ci, 0);
1541 if (ci->platdata->notify_event)
1542 ci->platdata->notify_event(ci,
1543 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1544 _gadget_stop_activity(&ci->gadget);
1545 pm_runtime_put_sync(&_gadget->dev);
1546 usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1550 return 0;
1553 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1555 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1556 unsigned long flags;
1557 int ret = 0;
1559 spin_lock_irqsave(&ci->lock, flags);
1560 if (!ci->remote_wakeup) {
1561 ret = -EOPNOTSUPP;
1562 goto out;
1564 if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1565 ret = -EINVAL;
1566 goto out;
1568 hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1569 out:
1570 spin_unlock_irqrestore(&ci->lock, flags);
1571 return ret;
1574 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1576 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1578 if (ci->usb_phy)
1579 return usb_phy_set_power(ci->usb_phy, ma);
1580 return -ENOTSUPP;
1583 static int ci_udc_selfpowered(struct usb_gadget *_gadget, int is_on)
1585 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1586 struct ci_hw_ep *hwep = ci->ep0in;
1587 unsigned long flags;
1589 spin_lock_irqsave(hwep->lock, flags);
1590 _gadget->is_selfpowered = (is_on != 0);
1591 spin_unlock_irqrestore(hwep->lock, flags);
1593 return 0;
1596 /* Change Data+ pullup status
1597 * this func is used by usb_gadget_connect/disconnet
1599 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1601 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1604 * Data+ pullup controlled by OTG state machine in OTG fsm mode;
1605 * and don't touch Data+ in host mode for dual role config.
1607 if (ci_otg_is_fsm_mode(ci) || ci->role == CI_ROLE_HOST)
1608 return 0;
1610 pm_runtime_get_sync(&ci->gadget.dev);
1611 if (is_on)
1612 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1613 else
1614 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1615 pm_runtime_put_sync(&ci->gadget.dev);
1617 return 0;
1620 static int ci_udc_start(struct usb_gadget *gadget,
1621 struct usb_gadget_driver *driver);
1622 static int ci_udc_stop(struct usb_gadget *gadget);
1624 * Device operations part of the API to the USB controller hardware,
1625 * which don't involve endpoints (or i/o)
1626 * Check "usb_gadget.h" for details
1628 static const struct usb_gadget_ops usb_gadget_ops = {
1629 .vbus_session = ci_udc_vbus_session,
1630 .wakeup = ci_udc_wakeup,
1631 .set_selfpowered = ci_udc_selfpowered,
1632 .pullup = ci_udc_pullup,
1633 .vbus_draw = ci_udc_vbus_draw,
1634 .udc_start = ci_udc_start,
1635 .udc_stop = ci_udc_stop,
1638 static int init_eps(struct ci_hdrc *ci)
1640 int retval = 0, i, j;
1642 for (i = 0; i < ci->hw_ep_max/2; i++)
1643 for (j = RX; j <= TX; j++) {
1644 int k = i + j * ci->hw_ep_max/2;
1645 struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1647 scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1648 (j == TX) ? "in" : "out");
1650 hwep->ci = ci;
1651 hwep->lock = &ci->lock;
1652 hwep->td_pool = ci->td_pool;
1654 hwep->ep.name = hwep->name;
1655 hwep->ep.ops = &usb_ep_ops;
1657 if (i == 0) {
1658 hwep->ep.caps.type_control = true;
1659 } else {
1660 hwep->ep.caps.type_iso = true;
1661 hwep->ep.caps.type_bulk = true;
1662 hwep->ep.caps.type_int = true;
1665 if (j == TX)
1666 hwep->ep.caps.dir_in = true;
1667 else
1668 hwep->ep.caps.dir_out = true;
1671 * for ep0: maxP defined in desc, for other
1672 * eps, maxP is set by epautoconfig() called
1673 * by gadget layer
1675 usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1677 INIT_LIST_HEAD(&hwep->qh.queue);
1678 hwep->qh.ptr = dma_pool_zalloc(ci->qh_pool, GFP_KERNEL,
1679 &hwep->qh.dma);
1680 if (hwep->qh.ptr == NULL)
1681 retval = -ENOMEM;
1684 * set up shorthands for ep0 out and in endpoints,
1685 * don't add to gadget's ep_list
1687 if (i == 0) {
1688 if (j == RX)
1689 ci->ep0out = hwep;
1690 else
1691 ci->ep0in = hwep;
1693 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1694 continue;
1697 list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1700 return retval;
1703 static void destroy_eps(struct ci_hdrc *ci)
1705 int i;
1707 for (i = 0; i < ci->hw_ep_max; i++) {
1708 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1710 if (hwep->pending_td)
1711 free_pending_td(hwep);
1712 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1717 * ci_udc_start: register a gadget driver
1718 * @gadget: our gadget
1719 * @driver: the driver being registered
1721 * Interrupts are enabled here.
1723 static int ci_udc_start(struct usb_gadget *gadget,
1724 struct usb_gadget_driver *driver)
1726 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1727 int retval = -ENOMEM;
1729 if (driver->disconnect == NULL)
1730 return -EINVAL;
1733 ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1734 retval = usb_ep_enable(&ci->ep0out->ep);
1735 if (retval)
1736 return retval;
1738 ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1739 retval = usb_ep_enable(&ci->ep0in->ep);
1740 if (retval)
1741 return retval;
1743 ci->driver = driver;
1745 /* Start otg fsm for B-device */
1746 if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1747 ci_hdrc_otg_fsm_start(ci);
1748 return retval;
1751 pm_runtime_get_sync(&ci->gadget.dev);
1752 if (ci->vbus_active) {
1753 hw_device_reset(ci);
1754 } else {
1755 usb_udc_vbus_handler(&ci->gadget, false);
1756 pm_runtime_put_sync(&ci->gadget.dev);
1757 return retval;
1760 retval = hw_device_state(ci, ci->ep0out->qh.dma);
1761 if (retval)
1762 pm_runtime_put_sync(&ci->gadget.dev);
1764 return retval;
1767 static void ci_udc_stop_for_otg_fsm(struct ci_hdrc *ci)
1769 if (!ci_otg_is_fsm_mode(ci))
1770 return;
1772 mutex_lock(&ci->fsm.lock);
1773 if (ci->fsm.otg->state == OTG_STATE_A_PERIPHERAL) {
1774 ci->fsm.a_bidl_adis_tmout = 1;
1775 ci_hdrc_otg_fsm_start(ci);
1776 } else if (ci->fsm.otg->state == OTG_STATE_B_PERIPHERAL) {
1777 ci->fsm.protocol = PROTO_UNDEF;
1778 ci->fsm.otg->state = OTG_STATE_UNDEFINED;
1780 mutex_unlock(&ci->fsm.lock);
1784 * ci_udc_stop: unregister a gadget driver
1786 static int ci_udc_stop(struct usb_gadget *gadget)
1788 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1789 unsigned long flags;
1791 spin_lock_irqsave(&ci->lock, flags);
1793 if (ci->vbus_active) {
1794 hw_device_state(ci, 0);
1795 spin_unlock_irqrestore(&ci->lock, flags);
1796 if (ci->platdata->notify_event)
1797 ci->platdata->notify_event(ci,
1798 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1799 _gadget_stop_activity(&ci->gadget);
1800 spin_lock_irqsave(&ci->lock, flags);
1801 pm_runtime_put(&ci->gadget.dev);
1804 ci->driver = NULL;
1805 spin_unlock_irqrestore(&ci->lock, flags);
1807 ci_udc_stop_for_otg_fsm(ci);
1808 return 0;
1811 /******************************************************************************
1812 * BUS block
1813 *****************************************************************************/
1815 * udc_irq: ci interrupt handler
1817 * This function returns IRQ_HANDLED if the IRQ has been handled
1818 * It locks access to registers
1820 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1822 irqreturn_t retval;
1823 u32 intr;
1825 if (ci == NULL)
1826 return IRQ_HANDLED;
1828 spin_lock(&ci->lock);
1830 if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1831 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1832 USBMODE_CM_DC) {
1833 spin_unlock(&ci->lock);
1834 return IRQ_NONE;
1837 intr = hw_test_and_clear_intr_active(ci);
1839 if (intr) {
1840 /* order defines priority - do NOT change it */
1841 if (USBi_URI & intr)
1842 isr_reset_handler(ci);
1844 if (USBi_PCI & intr) {
1845 ci->gadget.speed = hw_port_is_high_speed(ci) ?
1846 USB_SPEED_HIGH : USB_SPEED_FULL;
1847 if (ci->suspended) {
1848 if (ci->driver->resume) {
1849 spin_unlock(&ci->lock);
1850 ci->driver->resume(&ci->gadget);
1851 spin_lock(&ci->lock);
1853 ci->suspended = 0;
1854 usb_gadget_set_state(&ci->gadget,
1855 ci->resume_state);
1859 if (USBi_UI & intr)
1860 isr_tr_complete_handler(ci);
1862 if ((USBi_SLI & intr) && !(ci->suspended)) {
1863 ci->suspended = 1;
1864 ci->resume_state = ci->gadget.state;
1865 if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1866 ci->driver->suspend) {
1867 spin_unlock(&ci->lock);
1868 ci->driver->suspend(&ci->gadget);
1869 spin_lock(&ci->lock);
1871 usb_gadget_set_state(&ci->gadget,
1872 USB_STATE_SUSPENDED);
1874 retval = IRQ_HANDLED;
1875 } else {
1876 retval = IRQ_NONE;
1878 spin_unlock(&ci->lock);
1880 return retval;
1884 * udc_start: initialize gadget role
1885 * @ci: chipidea controller
1887 static int udc_start(struct ci_hdrc *ci)
1889 struct device *dev = ci->dev;
1890 struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;
1891 int retval = 0;
1893 ci->gadget.ops = &usb_gadget_ops;
1894 ci->gadget.speed = USB_SPEED_UNKNOWN;
1895 ci->gadget.max_speed = USB_SPEED_HIGH;
1896 ci->gadget.name = ci->platdata->name;
1897 ci->gadget.otg_caps = otg_caps;
1899 if (ci->platdata->flags & CI_HDRC_REQUIRES_ALIGNED_DMA)
1900 ci->gadget.quirk_avoids_skb_reserve = 1;
1902 if (ci->is_otg && (otg_caps->hnp_support || otg_caps->srp_support ||
1903 otg_caps->adp_support))
1904 ci->gadget.is_otg = 1;
1906 INIT_LIST_HEAD(&ci->gadget.ep_list);
1908 /* alloc resources */
1909 ci->qh_pool = dma_pool_create("ci_hw_qh", dev->parent,
1910 sizeof(struct ci_hw_qh),
1911 64, CI_HDRC_PAGE_SIZE);
1912 if (ci->qh_pool == NULL)
1913 return -ENOMEM;
1915 ci->td_pool = dma_pool_create("ci_hw_td", dev->parent,
1916 sizeof(struct ci_hw_td),
1917 64, CI_HDRC_PAGE_SIZE);
1918 if (ci->td_pool == NULL) {
1919 retval = -ENOMEM;
1920 goto free_qh_pool;
1923 retval = init_eps(ci);
1924 if (retval)
1925 goto free_pools;
1927 ci->gadget.ep0 = &ci->ep0in->ep;
1929 retval = usb_add_gadget_udc(dev, &ci->gadget);
1930 if (retval)
1931 goto destroy_eps;
1933 pm_runtime_no_callbacks(&ci->gadget.dev);
1934 pm_runtime_enable(&ci->gadget.dev);
1936 return retval;
1938 destroy_eps:
1939 destroy_eps(ci);
1940 free_pools:
1941 dma_pool_destroy(ci->td_pool);
1942 free_qh_pool:
1943 dma_pool_destroy(ci->qh_pool);
1944 return retval;
1948 * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1950 * No interrupts active, the IRQ has been released
1952 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1954 if (!ci->roles[CI_ROLE_GADGET])
1955 return;
1957 usb_del_gadget_udc(&ci->gadget);
1959 destroy_eps(ci);
1961 dma_pool_destroy(ci->td_pool);
1962 dma_pool_destroy(ci->qh_pool);
1965 static int udc_id_switch_for_device(struct ci_hdrc *ci)
1967 if (ci->is_otg)
1968 /* Clear and enable BSV irq */
1969 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
1970 OTGSC_BSVIS | OTGSC_BSVIE);
1972 return 0;
1975 static void udc_id_switch_for_host(struct ci_hdrc *ci)
1978 * host doesn't care B_SESSION_VALID event
1979 * so clear and disbale BSV irq
1981 if (ci->is_otg)
1982 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
1984 ci->vbus_active = 0;
1988 * ci_hdrc_gadget_init - initialize device related bits
1989 * ci: the controller
1991 * This function initializes the gadget, if the device is "device capable".
1993 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
1995 struct ci_role_driver *rdrv;
1996 int ret;
1998 if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
1999 return -ENXIO;
2001 rdrv = devm_kzalloc(ci->dev, sizeof(*rdrv), GFP_KERNEL);
2002 if (!rdrv)
2003 return -ENOMEM;
2005 rdrv->start = udc_id_switch_for_device;
2006 rdrv->stop = udc_id_switch_for_host;
2007 rdrv->irq = udc_irq;
2008 rdrv->name = "gadget";
2010 ret = udc_start(ci);
2011 if (!ret)
2012 ci->roles[CI_ROLE_GADGET] = rdrv;
2014 return ret;