Linux 4.19.133
[linux/fpc-iii.git] / drivers / usb / chipidea / udc.c
blob169ccfacfc7550b145d49adcd97bf121bb093258
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * udc.c - ChipIdea UDC driver
5 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
7 * Author: David Lopo
8 */
10 #include <linux/delay.h>
11 #include <linux/device.h>
12 #include <linux/dmapool.h>
13 #include <linux/err.h>
14 #include <linux/irqreturn.h>
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/usb/ch9.h>
19 #include <linux/usb/gadget.h>
20 #include <linux/usb/otg-fsm.h>
21 #include <linux/usb/chipidea.h>
23 #include "ci.h"
24 #include "udc.h"
25 #include "bits.h"
26 #include "otg.h"
27 #include "otg_fsm.h"
29 /* control endpoint description */
30 static const struct usb_endpoint_descriptor
31 ctrl_endpt_out_desc = {
32 .bLength = USB_DT_ENDPOINT_SIZE,
33 .bDescriptorType = USB_DT_ENDPOINT,
35 .bEndpointAddress = USB_DIR_OUT,
36 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
37 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
40 static const struct usb_endpoint_descriptor
41 ctrl_endpt_in_desc = {
42 .bLength = USB_DT_ENDPOINT_SIZE,
43 .bDescriptorType = USB_DT_ENDPOINT,
45 .bEndpointAddress = USB_DIR_IN,
46 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
47 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
50 /**
51 * hw_ep_bit: calculates the bit number
52 * @num: endpoint number
53 * @dir: endpoint direction
55 * This function returns bit number
57 static inline int hw_ep_bit(int num, int dir)
59 return num + ((dir == TX) ? 16 : 0);
62 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
64 int fill = 16 - ci->hw_ep_max / 2;
66 if (n >= ci->hw_ep_max / 2)
67 n += fill;
69 return n;
72 /**
73 * hw_device_state: enables/disables interrupts (execute without interruption)
74 * @dma: 0 => disable, !0 => enable and set dma engine
76 * This function returns an error code
78 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
80 if (dma) {
81 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
82 /* interrupt, error, port change, reset, sleep/suspend */
83 hw_write(ci, OP_USBINTR, ~0,
84 USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
85 } else {
86 hw_write(ci, OP_USBINTR, ~0, 0);
88 return 0;
91 /**
92 * hw_ep_flush: flush endpoint fifo (execute without interruption)
93 * @num: endpoint number
94 * @dir: endpoint direction
96 * This function returns an error code
98 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
100 int n = hw_ep_bit(num, dir);
102 do {
103 /* flush any pending transfer */
104 hw_write(ci, OP_ENDPTFLUSH, ~0, BIT(n));
105 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
106 cpu_relax();
107 } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
109 return 0;
113 * hw_ep_disable: disables endpoint (execute without interruption)
114 * @num: endpoint number
115 * @dir: endpoint direction
117 * This function returns an error code
119 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
121 hw_write(ci, OP_ENDPTCTRL + num,
122 (dir == TX) ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
123 return 0;
127 * hw_ep_enable: enables endpoint (execute without interruption)
128 * @num: endpoint number
129 * @dir: endpoint direction
130 * @type: endpoint type
132 * This function returns an error code
134 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
136 u32 mask, data;
138 if (dir == TX) {
139 mask = ENDPTCTRL_TXT; /* type */
140 data = type << __ffs(mask);
142 mask |= ENDPTCTRL_TXS; /* unstall */
143 mask |= ENDPTCTRL_TXR; /* reset data toggle */
144 data |= ENDPTCTRL_TXR;
145 mask |= ENDPTCTRL_TXE; /* enable */
146 data |= ENDPTCTRL_TXE;
147 } else {
148 mask = ENDPTCTRL_RXT; /* type */
149 data = type << __ffs(mask);
151 mask |= ENDPTCTRL_RXS; /* unstall */
152 mask |= ENDPTCTRL_RXR; /* reset data toggle */
153 data |= ENDPTCTRL_RXR;
154 mask |= ENDPTCTRL_RXE; /* enable */
155 data |= ENDPTCTRL_RXE;
157 hw_write(ci, OP_ENDPTCTRL + num, mask, data);
158 return 0;
162 * hw_ep_get_halt: return endpoint halt status
163 * @num: endpoint number
164 * @dir: endpoint direction
166 * This function returns 1 if endpoint halted
168 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
170 u32 mask = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
172 return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
176 * hw_ep_prime: primes endpoint (execute without interruption)
177 * @num: endpoint number
178 * @dir: endpoint direction
179 * @is_ctrl: true if control endpoint
181 * This function returns an error code
183 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
185 int n = hw_ep_bit(num, dir);
187 /* Synchronize before ep prime */
188 wmb();
190 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
191 return -EAGAIN;
193 hw_write(ci, OP_ENDPTPRIME, ~0, BIT(n));
195 while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
196 cpu_relax();
197 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
198 return -EAGAIN;
200 /* status shoult be tested according with manual but it doesn't work */
201 return 0;
205 * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
206 * without interruption)
207 * @num: endpoint number
208 * @dir: endpoint direction
209 * @value: true => stall, false => unstall
211 * This function returns an error code
213 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
215 if (value != 0 && value != 1)
216 return -EINVAL;
218 do {
219 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
220 u32 mask_xs = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
221 u32 mask_xr = (dir == TX) ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
223 /* data toggle - reserved for EP0 but it's in ESS */
224 hw_write(ci, reg, mask_xs|mask_xr,
225 value ? mask_xs : mask_xr);
226 } while (value != hw_ep_get_halt(ci, num, dir));
228 return 0;
232 * hw_is_port_high_speed: test if port is high speed
234 * This function returns true if high speed port
236 static int hw_port_is_high_speed(struct ci_hdrc *ci)
238 return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
239 hw_read(ci, OP_PORTSC, PORTSC_HSP);
243 * hw_test_and_clear_complete: test & clear complete status (execute without
244 * interruption)
245 * @n: endpoint number
247 * This function returns complete status
249 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
251 n = ep_to_bit(ci, n);
252 return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
256 * hw_test_and_clear_intr_active: test & clear active interrupts (execute
257 * without interruption)
259 * This function returns active interrutps
261 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
263 u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
265 hw_write(ci, OP_USBSTS, ~0, reg);
266 return reg;
270 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
271 * interruption)
273 * This function returns guard value
275 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
277 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
281 * hw_test_and_set_setup_guard: test & set setup guard (execute without
282 * interruption)
284 * This function returns guard value
286 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
288 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
292 * hw_usb_set_address: configures USB address (execute without interruption)
293 * @value: new USB address
295 * This function explicitly sets the address, without the "USBADRA" (advance)
296 * feature, which is not supported by older versions of the controller.
298 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
300 hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
301 value << __ffs(DEVICEADDR_USBADR));
305 * hw_usb_reset: restart device after a bus reset (execute without
306 * interruption)
308 * This function returns an error code
310 static int hw_usb_reset(struct ci_hdrc *ci)
312 hw_usb_set_address(ci, 0);
314 /* ESS flushes only at end?!? */
315 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
317 /* clear setup token semaphores */
318 hw_write(ci, OP_ENDPTSETUPSTAT, 0, 0);
320 /* clear complete status */
321 hw_write(ci, OP_ENDPTCOMPLETE, 0, 0);
323 /* wait until all bits cleared */
324 while (hw_read(ci, OP_ENDPTPRIME, ~0))
325 udelay(10); /* not RTOS friendly */
327 /* reset all endpoints ? */
329 /* reset internal status and wait for further instructions
330 no need to verify the port reset status (ESS does it) */
332 return 0;
335 /******************************************************************************
336 * UTIL block
337 *****************************************************************************/
339 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
340 unsigned length)
342 int i;
343 u32 temp;
344 struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
345 GFP_ATOMIC);
347 if (node == NULL)
348 return -ENOMEM;
350 node->ptr = dma_pool_zalloc(hwep->td_pool, GFP_ATOMIC, &node->dma);
351 if (node->ptr == NULL) {
352 kfree(node);
353 return -ENOMEM;
356 node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
357 node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
358 node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
359 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX) {
360 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
362 if (hwreq->req.length == 0
363 || hwreq->req.length % hwep->ep.maxpacket)
364 mul++;
365 node->ptr->token |= cpu_to_le32(mul << __ffs(TD_MULTO));
368 temp = (u32) (hwreq->req.dma + hwreq->req.actual);
369 if (length) {
370 node->ptr->page[0] = cpu_to_le32(temp);
371 for (i = 1; i < TD_PAGE_COUNT; i++) {
372 u32 page = temp + i * CI_HDRC_PAGE_SIZE;
373 page &= ~TD_RESERVED_MASK;
374 node->ptr->page[i] = cpu_to_le32(page);
378 hwreq->req.actual += length;
380 if (!list_empty(&hwreq->tds)) {
381 /* get the last entry */
382 lastnode = list_entry(hwreq->tds.prev,
383 struct td_node, td);
384 lastnode->ptr->next = cpu_to_le32(node->dma);
387 INIT_LIST_HEAD(&node->td);
388 list_add_tail(&node->td, &hwreq->tds);
390 return 0;
394 * _usb_addr: calculates endpoint address from direction & number
395 * @ep: endpoint
397 static inline u8 _usb_addr(struct ci_hw_ep *ep)
399 return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
403 * _hardware_enqueue: configures a request at hardware level
404 * @hwep: endpoint
405 * @hwreq: request
407 * This function returns an error code
409 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
411 struct ci_hdrc *ci = hwep->ci;
412 int ret = 0;
413 unsigned rest = hwreq->req.length;
414 int pages = TD_PAGE_COUNT;
415 struct td_node *firstnode, *lastnode;
417 /* don't queue twice */
418 if (hwreq->req.status == -EALREADY)
419 return -EALREADY;
421 hwreq->req.status = -EALREADY;
423 ret = usb_gadget_map_request_by_dev(ci->dev->parent,
424 &hwreq->req, hwep->dir);
425 if (ret)
426 return ret;
429 * The first buffer could be not page aligned.
430 * In that case we have to span into one extra td.
432 if (hwreq->req.dma % PAGE_SIZE)
433 pages--;
435 if (rest == 0) {
436 ret = add_td_to_list(hwep, hwreq, 0);
437 if (ret < 0)
438 goto done;
441 while (rest > 0) {
442 unsigned count = min(hwreq->req.length - hwreq->req.actual,
443 (unsigned)(pages * CI_HDRC_PAGE_SIZE));
444 ret = add_td_to_list(hwep, hwreq, count);
445 if (ret < 0)
446 goto done;
448 rest -= count;
451 if (hwreq->req.zero && hwreq->req.length && hwep->dir == TX
452 && (hwreq->req.length % hwep->ep.maxpacket == 0)) {
453 ret = add_td_to_list(hwep, hwreq, 0);
454 if (ret < 0)
455 goto done;
458 firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
460 lastnode = list_entry(hwreq->tds.prev,
461 struct td_node, td);
463 lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
464 if (!hwreq->req.no_interrupt)
465 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
466 wmb();
468 hwreq->req.actual = 0;
469 if (!list_empty(&hwep->qh.queue)) {
470 struct ci_hw_req *hwreqprev;
471 int n = hw_ep_bit(hwep->num, hwep->dir);
472 int tmp_stat;
473 struct td_node *prevlastnode;
474 u32 next = firstnode->dma & TD_ADDR_MASK;
476 hwreqprev = list_entry(hwep->qh.queue.prev,
477 struct ci_hw_req, queue);
478 prevlastnode = list_entry(hwreqprev->tds.prev,
479 struct td_node, td);
481 prevlastnode->ptr->next = cpu_to_le32(next);
482 wmb();
483 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
484 goto done;
485 do {
486 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
487 tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
488 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
489 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
490 if (tmp_stat)
491 goto done;
494 /* QH configuration */
495 hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
496 hwep->qh.ptr->td.token &=
497 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
499 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == RX) {
500 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
502 if (hwreq->req.length == 0
503 || hwreq->req.length % hwep->ep.maxpacket)
504 mul++;
505 hwep->qh.ptr->cap |= cpu_to_le32(mul << __ffs(QH_MULT));
508 ret = hw_ep_prime(ci, hwep->num, hwep->dir,
509 hwep->type == USB_ENDPOINT_XFER_CONTROL);
510 done:
511 return ret;
515 * free_pending_td: remove a pending request for the endpoint
516 * @hwep: endpoint
518 static void free_pending_td(struct ci_hw_ep *hwep)
520 struct td_node *pending = hwep->pending_td;
522 dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
523 hwep->pending_td = NULL;
524 kfree(pending);
527 static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep,
528 struct td_node *node)
530 hwep->qh.ptr->td.next = cpu_to_le32(node->dma);
531 hwep->qh.ptr->td.token &=
532 cpu_to_le32(~(TD_STATUS_HALTED | TD_STATUS_ACTIVE));
534 return hw_ep_prime(ci, hwep->num, hwep->dir,
535 hwep->type == USB_ENDPOINT_XFER_CONTROL);
539 * _hardware_dequeue: handles a request at hardware level
540 * @gadget: gadget
541 * @hwep: endpoint
543 * This function returns an error code
545 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
547 u32 tmptoken;
548 struct td_node *node, *tmpnode;
549 unsigned remaining_length;
550 unsigned actual = hwreq->req.length;
551 struct ci_hdrc *ci = hwep->ci;
553 if (hwreq->req.status != -EALREADY)
554 return -EINVAL;
556 hwreq->req.status = 0;
558 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
559 tmptoken = le32_to_cpu(node->ptr->token);
560 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
561 int n = hw_ep_bit(hwep->num, hwep->dir);
563 if (ci->rev == CI_REVISION_24)
564 if (!hw_read(ci, OP_ENDPTSTAT, BIT(n)))
565 reprime_dtd(ci, hwep, node);
566 hwreq->req.status = -EALREADY;
567 return -EBUSY;
570 remaining_length = (tmptoken & TD_TOTAL_BYTES);
571 remaining_length >>= __ffs(TD_TOTAL_BYTES);
572 actual -= remaining_length;
574 hwreq->req.status = tmptoken & TD_STATUS;
575 if ((TD_STATUS_HALTED & hwreq->req.status)) {
576 hwreq->req.status = -EPIPE;
577 break;
578 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
579 hwreq->req.status = -EPROTO;
580 break;
581 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
582 hwreq->req.status = -EILSEQ;
583 break;
586 if (remaining_length) {
587 if (hwep->dir == TX) {
588 hwreq->req.status = -EPROTO;
589 break;
593 * As the hardware could still address the freed td
594 * which will run the udc unusable, the cleanup of the
595 * td has to be delayed by one.
597 if (hwep->pending_td)
598 free_pending_td(hwep);
600 hwep->pending_td = node;
601 list_del_init(&node->td);
604 usb_gadget_unmap_request_by_dev(hwep->ci->dev->parent,
605 &hwreq->req, hwep->dir);
607 hwreq->req.actual += actual;
609 if (hwreq->req.status)
610 return hwreq->req.status;
612 return hwreq->req.actual;
616 * _ep_nuke: dequeues all endpoint requests
617 * @hwep: endpoint
619 * This function returns an error code
620 * Caller must hold lock
622 static int _ep_nuke(struct ci_hw_ep *hwep)
623 __releases(hwep->lock)
624 __acquires(hwep->lock)
626 struct td_node *node, *tmpnode;
627 if (hwep == NULL)
628 return -EINVAL;
630 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
632 while (!list_empty(&hwep->qh.queue)) {
634 /* pop oldest request */
635 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
636 struct ci_hw_req, queue);
638 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
639 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
640 list_del_init(&node->td);
641 node->ptr = NULL;
642 kfree(node);
645 list_del_init(&hwreq->queue);
646 hwreq->req.status = -ESHUTDOWN;
648 if (hwreq->req.complete != NULL) {
649 spin_unlock(hwep->lock);
650 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
651 spin_lock(hwep->lock);
655 if (hwep->pending_td)
656 free_pending_td(hwep);
658 return 0;
661 static int _ep_set_halt(struct usb_ep *ep, int value, bool check_transfer)
663 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
664 int direction, retval = 0;
665 unsigned long flags;
667 if (ep == NULL || hwep->ep.desc == NULL)
668 return -EINVAL;
670 if (usb_endpoint_xfer_isoc(hwep->ep.desc))
671 return -EOPNOTSUPP;
673 spin_lock_irqsave(hwep->lock, flags);
675 if (value && hwep->dir == TX && check_transfer &&
676 !list_empty(&hwep->qh.queue) &&
677 !usb_endpoint_xfer_control(hwep->ep.desc)) {
678 spin_unlock_irqrestore(hwep->lock, flags);
679 return -EAGAIN;
682 direction = hwep->dir;
683 do {
684 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
686 if (!value)
687 hwep->wedge = 0;
689 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
690 hwep->dir = (hwep->dir == TX) ? RX : TX;
692 } while (hwep->dir != direction);
694 spin_unlock_irqrestore(hwep->lock, flags);
695 return retval;
700 * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
701 * @gadget: gadget
703 * This function returns an error code
705 static int _gadget_stop_activity(struct usb_gadget *gadget)
707 struct usb_ep *ep;
708 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
709 unsigned long flags;
711 /* flush all endpoints */
712 gadget_for_each_ep(ep, gadget) {
713 usb_ep_fifo_flush(ep);
715 usb_ep_fifo_flush(&ci->ep0out->ep);
716 usb_ep_fifo_flush(&ci->ep0in->ep);
718 /* make sure to disable all endpoints */
719 gadget_for_each_ep(ep, gadget) {
720 usb_ep_disable(ep);
723 if (ci->status != NULL) {
724 usb_ep_free_request(&ci->ep0in->ep, ci->status);
725 ci->status = NULL;
728 spin_lock_irqsave(&ci->lock, flags);
729 ci->gadget.speed = USB_SPEED_UNKNOWN;
730 ci->remote_wakeup = 0;
731 ci->suspended = 0;
732 spin_unlock_irqrestore(&ci->lock, flags);
734 return 0;
737 /******************************************************************************
738 * ISR block
739 *****************************************************************************/
741 * isr_reset_handler: USB reset interrupt handler
742 * @ci: UDC device
744 * This function resets USB engine after a bus reset occurred
746 static void isr_reset_handler(struct ci_hdrc *ci)
747 __releases(ci->lock)
748 __acquires(ci->lock)
750 int retval;
752 spin_unlock(&ci->lock);
753 if (ci->gadget.speed != USB_SPEED_UNKNOWN)
754 usb_gadget_udc_reset(&ci->gadget, ci->driver);
756 retval = _gadget_stop_activity(&ci->gadget);
757 if (retval)
758 goto done;
760 retval = hw_usb_reset(ci);
761 if (retval)
762 goto done;
764 ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
765 if (ci->status == NULL)
766 retval = -ENOMEM;
768 done:
769 spin_lock(&ci->lock);
771 if (retval)
772 dev_err(ci->dev, "error: %i\n", retval);
776 * isr_get_status_complete: get_status request complete function
777 * @ep: endpoint
778 * @req: request handled
780 * Caller must release lock
782 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
784 if (ep == NULL || req == NULL)
785 return;
787 kfree(req->buf);
788 usb_ep_free_request(ep, req);
792 * _ep_queue: queues (submits) an I/O request to an endpoint
793 * @ep: endpoint
794 * @req: request
795 * @gfp_flags: GFP flags (not used)
797 * Caller must hold lock
798 * This function returns an error code
800 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
801 gfp_t __maybe_unused gfp_flags)
803 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
804 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
805 struct ci_hdrc *ci = hwep->ci;
806 int retval = 0;
808 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
809 return -EINVAL;
811 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
812 if (req->length)
813 hwep = (ci->ep0_dir == RX) ?
814 ci->ep0out : ci->ep0in;
815 if (!list_empty(&hwep->qh.queue)) {
816 _ep_nuke(hwep);
817 dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
818 _usb_addr(hwep));
822 if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
823 hwreq->req.length > hwep->ep.mult * hwep->ep.maxpacket) {
824 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
825 return -EMSGSIZE;
828 /* first nuke then test link, e.g. previous status has not sent */
829 if (!list_empty(&hwreq->queue)) {
830 dev_err(hwep->ci->dev, "request already in queue\n");
831 return -EBUSY;
834 /* push request */
835 hwreq->req.status = -EINPROGRESS;
836 hwreq->req.actual = 0;
838 retval = _hardware_enqueue(hwep, hwreq);
840 if (retval == -EALREADY)
841 retval = 0;
842 if (!retval)
843 list_add_tail(&hwreq->queue, &hwep->qh.queue);
845 return retval;
849 * isr_get_status_response: get_status request response
850 * @ci: ci struct
851 * @setup: setup request packet
853 * This function returns an error code
855 static int isr_get_status_response(struct ci_hdrc *ci,
856 struct usb_ctrlrequest *setup)
857 __releases(hwep->lock)
858 __acquires(hwep->lock)
860 struct ci_hw_ep *hwep = ci->ep0in;
861 struct usb_request *req = NULL;
862 gfp_t gfp_flags = GFP_ATOMIC;
863 int dir, num, retval;
865 if (hwep == NULL || setup == NULL)
866 return -EINVAL;
868 spin_unlock(hwep->lock);
869 req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
870 spin_lock(hwep->lock);
871 if (req == NULL)
872 return -ENOMEM;
874 req->complete = isr_get_status_complete;
875 req->length = 2;
876 req->buf = kzalloc(req->length, gfp_flags);
877 if (req->buf == NULL) {
878 retval = -ENOMEM;
879 goto err_free_req;
882 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
883 *(u16 *)req->buf = (ci->remote_wakeup << 1) |
884 ci->gadget.is_selfpowered;
885 } else if ((setup->bRequestType & USB_RECIP_MASK) \
886 == USB_RECIP_ENDPOINT) {
887 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
888 TX : RX;
889 num = le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
890 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
892 /* else do nothing; reserved for future use */
894 retval = _ep_queue(&hwep->ep, req, gfp_flags);
895 if (retval)
896 goto err_free_buf;
898 return 0;
900 err_free_buf:
901 kfree(req->buf);
902 err_free_req:
903 spin_unlock(hwep->lock);
904 usb_ep_free_request(&hwep->ep, req);
905 spin_lock(hwep->lock);
906 return retval;
910 * isr_setup_status_complete: setup_status request complete function
911 * @ep: endpoint
912 * @req: request handled
914 * Caller must release lock. Put the port in test mode if test mode
915 * feature is selected.
917 static void
918 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
920 struct ci_hdrc *ci = req->context;
921 unsigned long flags;
923 if (ci->setaddr) {
924 hw_usb_set_address(ci, ci->address);
925 ci->setaddr = false;
926 if (ci->address)
927 usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
930 spin_lock_irqsave(&ci->lock, flags);
931 if (ci->test_mode)
932 hw_port_test_set(ci, ci->test_mode);
933 spin_unlock_irqrestore(&ci->lock, flags);
937 * isr_setup_status_phase: queues the status phase of a setup transation
938 * @ci: ci struct
940 * This function returns an error code
942 static int isr_setup_status_phase(struct ci_hdrc *ci)
944 struct ci_hw_ep *hwep;
947 * Unexpected USB controller behavior, caused by bad signal integrity
948 * or ground reference problems, can lead to isr_setup_status_phase
949 * being called with ci->status equal to NULL.
950 * If this situation occurs, you should review your USB hardware design.
952 if (WARN_ON_ONCE(!ci->status))
953 return -EPIPE;
955 hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
956 ci->status->context = ci;
957 ci->status->complete = isr_setup_status_complete;
959 return _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
963 * isr_tr_complete_low: transaction complete low level handler
964 * @hwep: endpoint
966 * This function returns an error code
967 * Caller must hold lock
969 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
970 __releases(hwep->lock)
971 __acquires(hwep->lock)
973 struct ci_hw_req *hwreq, *hwreqtemp;
974 struct ci_hw_ep *hweptemp = hwep;
975 int retval = 0;
977 list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
978 queue) {
979 retval = _hardware_dequeue(hwep, hwreq);
980 if (retval < 0)
981 break;
982 list_del_init(&hwreq->queue);
983 if (hwreq->req.complete != NULL) {
984 spin_unlock(hwep->lock);
985 if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
986 hwreq->req.length)
987 hweptemp = hwep->ci->ep0in;
988 usb_gadget_giveback_request(&hweptemp->ep, &hwreq->req);
989 spin_lock(hwep->lock);
993 if (retval == -EBUSY)
994 retval = 0;
996 return retval;
999 static int otg_a_alt_hnp_support(struct ci_hdrc *ci)
1001 dev_warn(&ci->gadget.dev,
1002 "connect the device to an alternate port if you want HNP\n");
1003 return isr_setup_status_phase(ci);
1007 * isr_setup_packet_handler: setup packet handler
1008 * @ci: UDC descriptor
1010 * This function handles setup packet
1012 static void isr_setup_packet_handler(struct ci_hdrc *ci)
1013 __releases(ci->lock)
1014 __acquires(ci->lock)
1016 struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
1017 struct usb_ctrlrequest req;
1018 int type, num, dir, err = -EINVAL;
1019 u8 tmode = 0;
1022 * Flush data and handshake transactions of previous
1023 * setup packet.
1025 _ep_nuke(ci->ep0out);
1026 _ep_nuke(ci->ep0in);
1028 /* read_setup_packet */
1029 do {
1030 hw_test_and_set_setup_guard(ci);
1031 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1032 } while (!hw_test_and_clear_setup_guard(ci));
1034 type = req.bRequestType;
1036 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1038 switch (req.bRequest) {
1039 case USB_REQ_CLEAR_FEATURE:
1040 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1041 le16_to_cpu(req.wValue) ==
1042 USB_ENDPOINT_HALT) {
1043 if (req.wLength != 0)
1044 break;
1045 num = le16_to_cpu(req.wIndex);
1046 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1047 num &= USB_ENDPOINT_NUMBER_MASK;
1048 if (dir == TX)
1049 num += ci->hw_ep_max / 2;
1050 if (!ci->ci_hw_ep[num].wedge) {
1051 spin_unlock(&ci->lock);
1052 err = usb_ep_clear_halt(
1053 &ci->ci_hw_ep[num].ep);
1054 spin_lock(&ci->lock);
1055 if (err)
1056 break;
1058 err = isr_setup_status_phase(ci);
1059 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1060 le16_to_cpu(req.wValue) ==
1061 USB_DEVICE_REMOTE_WAKEUP) {
1062 if (req.wLength != 0)
1063 break;
1064 ci->remote_wakeup = 0;
1065 err = isr_setup_status_phase(ci);
1066 } else {
1067 goto delegate;
1069 break;
1070 case USB_REQ_GET_STATUS:
1071 if ((type != (USB_DIR_IN|USB_RECIP_DEVICE) ||
1072 le16_to_cpu(req.wIndex) == OTG_STS_SELECTOR) &&
1073 type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1074 type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1075 goto delegate;
1076 if (le16_to_cpu(req.wLength) != 2 ||
1077 le16_to_cpu(req.wValue) != 0)
1078 break;
1079 err = isr_get_status_response(ci, &req);
1080 break;
1081 case USB_REQ_SET_ADDRESS:
1082 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1083 goto delegate;
1084 if (le16_to_cpu(req.wLength) != 0 ||
1085 le16_to_cpu(req.wIndex) != 0)
1086 break;
1087 ci->address = (u8)le16_to_cpu(req.wValue);
1088 ci->setaddr = true;
1089 err = isr_setup_status_phase(ci);
1090 break;
1091 case USB_REQ_SET_FEATURE:
1092 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1093 le16_to_cpu(req.wValue) ==
1094 USB_ENDPOINT_HALT) {
1095 if (req.wLength != 0)
1096 break;
1097 num = le16_to_cpu(req.wIndex);
1098 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1099 num &= USB_ENDPOINT_NUMBER_MASK;
1100 if (dir == TX)
1101 num += ci->hw_ep_max / 2;
1103 spin_unlock(&ci->lock);
1104 err = _ep_set_halt(&ci->ci_hw_ep[num].ep, 1, false);
1105 spin_lock(&ci->lock);
1106 if (!err)
1107 isr_setup_status_phase(ci);
1108 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1109 if (req.wLength != 0)
1110 break;
1111 switch (le16_to_cpu(req.wValue)) {
1112 case USB_DEVICE_REMOTE_WAKEUP:
1113 ci->remote_wakeup = 1;
1114 err = isr_setup_status_phase(ci);
1115 break;
1116 case USB_DEVICE_TEST_MODE:
1117 tmode = le16_to_cpu(req.wIndex) >> 8;
1118 switch (tmode) {
1119 case TEST_J:
1120 case TEST_K:
1121 case TEST_SE0_NAK:
1122 case TEST_PACKET:
1123 case TEST_FORCE_EN:
1124 ci->test_mode = tmode;
1125 err = isr_setup_status_phase(
1126 ci);
1127 break;
1128 default:
1129 break;
1131 break;
1132 case USB_DEVICE_B_HNP_ENABLE:
1133 if (ci_otg_is_fsm_mode(ci)) {
1134 ci->gadget.b_hnp_enable = 1;
1135 err = isr_setup_status_phase(
1136 ci);
1138 break;
1139 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1140 if (ci_otg_is_fsm_mode(ci))
1141 err = otg_a_alt_hnp_support(ci);
1142 break;
1143 case USB_DEVICE_A_HNP_SUPPORT:
1144 if (ci_otg_is_fsm_mode(ci)) {
1145 ci->gadget.a_hnp_support = 1;
1146 err = isr_setup_status_phase(
1147 ci);
1149 break;
1150 default:
1151 goto delegate;
1153 } else {
1154 goto delegate;
1156 break;
1157 default:
1158 delegate:
1159 if (req.wLength == 0) /* no data phase */
1160 ci->ep0_dir = TX;
1162 spin_unlock(&ci->lock);
1163 err = ci->driver->setup(&ci->gadget, &req);
1164 spin_lock(&ci->lock);
1165 break;
1168 if (err < 0) {
1169 spin_unlock(&ci->lock);
1170 if (_ep_set_halt(&hwep->ep, 1, false))
1171 dev_err(ci->dev, "error: _ep_set_halt\n");
1172 spin_lock(&ci->lock);
1177 * isr_tr_complete_handler: transaction complete interrupt handler
1178 * @ci: UDC descriptor
1180 * This function handles traffic events
1182 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1183 __releases(ci->lock)
1184 __acquires(ci->lock)
1186 unsigned i;
1187 int err;
1189 for (i = 0; i < ci->hw_ep_max; i++) {
1190 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1192 if (hwep->ep.desc == NULL)
1193 continue; /* not configured */
1195 if (hw_test_and_clear_complete(ci, i)) {
1196 err = isr_tr_complete_low(hwep);
1197 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1198 if (err > 0) /* needs status phase */
1199 err = isr_setup_status_phase(ci);
1200 if (err < 0) {
1201 spin_unlock(&ci->lock);
1202 if (_ep_set_halt(&hwep->ep, 1, false))
1203 dev_err(ci->dev,
1204 "error: _ep_set_halt\n");
1205 spin_lock(&ci->lock);
1210 /* Only handle setup packet below */
1211 if (i == 0 &&
1212 hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1213 isr_setup_packet_handler(ci);
1217 /******************************************************************************
1218 * ENDPT block
1219 *****************************************************************************/
1221 * ep_enable: configure endpoint, making it usable
1223 * Check usb_ep_enable() at "usb_gadget.h" for details
1225 static int ep_enable(struct usb_ep *ep,
1226 const struct usb_endpoint_descriptor *desc)
1228 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1229 int retval = 0;
1230 unsigned long flags;
1231 u32 cap = 0;
1233 if (ep == NULL || desc == NULL)
1234 return -EINVAL;
1236 spin_lock_irqsave(hwep->lock, flags);
1238 /* only internal SW should enable ctrl endpts */
1240 if (!list_empty(&hwep->qh.queue)) {
1241 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1242 spin_unlock_irqrestore(hwep->lock, flags);
1243 return -EBUSY;
1246 hwep->ep.desc = desc;
1248 hwep->dir = usb_endpoint_dir_in(desc) ? TX : RX;
1249 hwep->num = usb_endpoint_num(desc);
1250 hwep->type = usb_endpoint_type(desc);
1252 hwep->ep.maxpacket = usb_endpoint_maxp(desc);
1253 hwep->ep.mult = usb_endpoint_maxp_mult(desc);
1255 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1256 cap |= QH_IOS;
1258 cap |= QH_ZLT;
1259 cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1261 * For ISO-TX, we set mult at QH as the largest value, and use
1262 * MultO at TD as real mult value.
1264 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1265 cap |= 3 << __ffs(QH_MULT);
1267 hwep->qh.ptr->cap = cpu_to_le32(cap);
1269 hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE); /* needed? */
1271 if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1272 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1273 retval = -EINVAL;
1277 * Enable endpoints in the HW other than ep0 as ep0
1278 * is always enabled
1280 if (hwep->num)
1281 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1282 hwep->type);
1284 spin_unlock_irqrestore(hwep->lock, flags);
1285 return retval;
1289 * ep_disable: endpoint is no longer usable
1291 * Check usb_ep_disable() at "usb_gadget.h" for details
1293 static int ep_disable(struct usb_ep *ep)
1295 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1296 int direction, retval = 0;
1297 unsigned long flags;
1299 if (ep == NULL)
1300 return -EINVAL;
1301 else if (hwep->ep.desc == NULL)
1302 return -EBUSY;
1304 spin_lock_irqsave(hwep->lock, flags);
1305 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1306 spin_unlock_irqrestore(hwep->lock, flags);
1307 return 0;
1310 /* only internal SW should disable ctrl endpts */
1312 direction = hwep->dir;
1313 do {
1314 retval |= _ep_nuke(hwep);
1315 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1317 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1318 hwep->dir = (hwep->dir == TX) ? RX : TX;
1320 } while (hwep->dir != direction);
1322 hwep->ep.desc = NULL;
1324 spin_unlock_irqrestore(hwep->lock, flags);
1325 return retval;
1329 * ep_alloc_request: allocate a request object to use with this endpoint
1331 * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1333 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1335 struct ci_hw_req *hwreq = NULL;
1337 if (ep == NULL)
1338 return NULL;
1340 hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1341 if (hwreq != NULL) {
1342 INIT_LIST_HEAD(&hwreq->queue);
1343 INIT_LIST_HEAD(&hwreq->tds);
1346 return (hwreq == NULL) ? NULL : &hwreq->req;
1350 * ep_free_request: frees a request object
1352 * Check usb_ep_free_request() at "usb_gadget.h" for details
1354 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1356 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1357 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1358 struct td_node *node, *tmpnode;
1359 unsigned long flags;
1361 if (ep == NULL || req == NULL) {
1362 return;
1363 } else if (!list_empty(&hwreq->queue)) {
1364 dev_err(hwep->ci->dev, "freeing queued request\n");
1365 return;
1368 spin_lock_irqsave(hwep->lock, flags);
1370 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1371 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1372 list_del_init(&node->td);
1373 node->ptr = NULL;
1374 kfree(node);
1377 kfree(hwreq);
1379 spin_unlock_irqrestore(hwep->lock, flags);
1383 * ep_queue: queues (submits) an I/O request to an endpoint
1385 * Check usb_ep_queue()* at usb_gadget.h" for details
1387 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1388 gfp_t __maybe_unused gfp_flags)
1390 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1391 int retval = 0;
1392 unsigned long flags;
1394 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1395 return -EINVAL;
1397 spin_lock_irqsave(hwep->lock, flags);
1398 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1399 spin_unlock_irqrestore(hwep->lock, flags);
1400 return 0;
1402 retval = _ep_queue(ep, req, gfp_flags);
1403 spin_unlock_irqrestore(hwep->lock, flags);
1404 return retval;
1408 * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1410 * Check usb_ep_dequeue() at "usb_gadget.h" for details
1412 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1414 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1415 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1416 unsigned long flags;
1417 struct td_node *node, *tmpnode;
1419 if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1420 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1421 list_empty(&hwep->qh.queue))
1422 return -EINVAL;
1424 spin_lock_irqsave(hwep->lock, flags);
1425 if (hwep->ci->gadget.speed != USB_SPEED_UNKNOWN)
1426 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1428 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1429 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1430 list_del(&node->td);
1431 kfree(node);
1434 /* pop request */
1435 list_del_init(&hwreq->queue);
1437 usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1439 req->status = -ECONNRESET;
1441 if (hwreq->req.complete != NULL) {
1442 spin_unlock(hwep->lock);
1443 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
1444 spin_lock(hwep->lock);
1447 spin_unlock_irqrestore(hwep->lock, flags);
1448 return 0;
1452 * ep_set_halt: sets the endpoint halt feature
1454 * Check usb_ep_set_halt() at "usb_gadget.h" for details
1456 static int ep_set_halt(struct usb_ep *ep, int value)
1458 return _ep_set_halt(ep, value, true);
1462 * ep_set_wedge: sets the halt feature and ignores clear requests
1464 * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1466 static int ep_set_wedge(struct usb_ep *ep)
1468 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1469 unsigned long flags;
1471 if (ep == NULL || hwep->ep.desc == NULL)
1472 return -EINVAL;
1474 spin_lock_irqsave(hwep->lock, flags);
1475 hwep->wedge = 1;
1476 spin_unlock_irqrestore(hwep->lock, flags);
1478 return usb_ep_set_halt(ep);
1482 * ep_fifo_flush: flushes contents of a fifo
1484 * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1486 static void ep_fifo_flush(struct usb_ep *ep)
1488 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1489 unsigned long flags;
1491 if (ep == NULL) {
1492 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1493 return;
1496 spin_lock_irqsave(hwep->lock, flags);
1497 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1498 spin_unlock_irqrestore(hwep->lock, flags);
1499 return;
1502 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1504 spin_unlock_irqrestore(hwep->lock, flags);
1508 * Endpoint-specific part of the API to the USB controller hardware
1509 * Check "usb_gadget.h" for details
1511 static const struct usb_ep_ops usb_ep_ops = {
1512 .enable = ep_enable,
1513 .disable = ep_disable,
1514 .alloc_request = ep_alloc_request,
1515 .free_request = ep_free_request,
1516 .queue = ep_queue,
1517 .dequeue = ep_dequeue,
1518 .set_halt = ep_set_halt,
1519 .set_wedge = ep_set_wedge,
1520 .fifo_flush = ep_fifo_flush,
1523 /******************************************************************************
1524 * GADGET block
1525 *****************************************************************************/
1526 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1528 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1529 unsigned long flags;
1530 int gadget_ready = 0;
1532 spin_lock_irqsave(&ci->lock, flags);
1533 ci->vbus_active = is_active;
1534 if (ci->driver)
1535 gadget_ready = 1;
1536 spin_unlock_irqrestore(&ci->lock, flags);
1538 if (ci->usb_phy)
1539 usb_phy_set_charger_state(ci->usb_phy, is_active ?
1540 USB_CHARGER_PRESENT : USB_CHARGER_ABSENT);
1542 if (gadget_ready) {
1543 if (is_active) {
1544 pm_runtime_get_sync(&_gadget->dev);
1545 hw_device_reset(ci);
1546 hw_device_state(ci, ci->ep0out->qh.dma);
1547 usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1548 usb_udc_vbus_handler(_gadget, true);
1549 } else {
1550 usb_udc_vbus_handler(_gadget, false);
1551 if (ci->driver)
1552 ci->driver->disconnect(&ci->gadget);
1553 hw_device_state(ci, 0);
1554 if (ci->platdata->notify_event)
1555 ci->platdata->notify_event(ci,
1556 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1557 _gadget_stop_activity(&ci->gadget);
1558 pm_runtime_put_sync(&_gadget->dev);
1559 usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1563 return 0;
1566 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1568 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1569 unsigned long flags;
1570 int ret = 0;
1572 spin_lock_irqsave(&ci->lock, flags);
1573 if (ci->gadget.speed == USB_SPEED_UNKNOWN) {
1574 spin_unlock_irqrestore(&ci->lock, flags);
1575 return 0;
1577 if (!ci->remote_wakeup) {
1578 ret = -EOPNOTSUPP;
1579 goto out;
1581 if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1582 ret = -EINVAL;
1583 goto out;
1585 hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1586 out:
1587 spin_unlock_irqrestore(&ci->lock, flags);
1588 return ret;
1591 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1593 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1595 if (ci->usb_phy)
1596 return usb_phy_set_power(ci->usb_phy, ma);
1597 return -ENOTSUPP;
1600 static int ci_udc_selfpowered(struct usb_gadget *_gadget, int is_on)
1602 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1603 struct ci_hw_ep *hwep = ci->ep0in;
1604 unsigned long flags;
1606 spin_lock_irqsave(hwep->lock, flags);
1607 _gadget->is_selfpowered = (is_on != 0);
1608 spin_unlock_irqrestore(hwep->lock, flags);
1610 return 0;
1613 /* Change Data+ pullup status
1614 * this func is used by usb_gadget_connect/disconnet
1616 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1618 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1621 * Data+ pullup controlled by OTG state machine in OTG fsm mode;
1622 * and don't touch Data+ in host mode for dual role config.
1624 if (ci_otg_is_fsm_mode(ci) || ci->role == CI_ROLE_HOST)
1625 return 0;
1627 pm_runtime_get_sync(&ci->gadget.dev);
1628 if (is_on)
1629 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1630 else
1631 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1632 pm_runtime_put_sync(&ci->gadget.dev);
1634 return 0;
1637 static int ci_udc_start(struct usb_gadget *gadget,
1638 struct usb_gadget_driver *driver);
1639 static int ci_udc_stop(struct usb_gadget *gadget);
1641 /* Match ISOC IN from the highest endpoint */
1642 static struct usb_ep *ci_udc_match_ep(struct usb_gadget *gadget,
1643 struct usb_endpoint_descriptor *desc,
1644 struct usb_ss_ep_comp_descriptor *comp_desc)
1646 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1647 struct usb_ep *ep;
1649 if (usb_endpoint_xfer_isoc(desc) && usb_endpoint_dir_in(desc)) {
1650 list_for_each_entry_reverse(ep, &ci->gadget.ep_list, ep_list) {
1651 if (ep->caps.dir_in && !ep->claimed)
1652 return ep;
1656 return NULL;
1660 * Device operations part of the API to the USB controller hardware,
1661 * which don't involve endpoints (or i/o)
1662 * Check "usb_gadget.h" for details
1664 static const struct usb_gadget_ops usb_gadget_ops = {
1665 .vbus_session = ci_udc_vbus_session,
1666 .wakeup = ci_udc_wakeup,
1667 .set_selfpowered = ci_udc_selfpowered,
1668 .pullup = ci_udc_pullup,
1669 .vbus_draw = ci_udc_vbus_draw,
1670 .udc_start = ci_udc_start,
1671 .udc_stop = ci_udc_stop,
1672 .match_ep = ci_udc_match_ep,
1675 static int init_eps(struct ci_hdrc *ci)
1677 int retval = 0, i, j;
1679 for (i = 0; i < ci->hw_ep_max/2; i++)
1680 for (j = RX; j <= TX; j++) {
1681 int k = i + j * ci->hw_ep_max/2;
1682 struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1684 scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1685 (j == TX) ? "in" : "out");
1687 hwep->ci = ci;
1688 hwep->lock = &ci->lock;
1689 hwep->td_pool = ci->td_pool;
1691 hwep->ep.name = hwep->name;
1692 hwep->ep.ops = &usb_ep_ops;
1694 if (i == 0) {
1695 hwep->ep.caps.type_control = true;
1696 } else {
1697 hwep->ep.caps.type_iso = true;
1698 hwep->ep.caps.type_bulk = true;
1699 hwep->ep.caps.type_int = true;
1702 if (j == TX)
1703 hwep->ep.caps.dir_in = true;
1704 else
1705 hwep->ep.caps.dir_out = true;
1708 * for ep0: maxP defined in desc, for other
1709 * eps, maxP is set by epautoconfig() called
1710 * by gadget layer
1712 usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1714 INIT_LIST_HEAD(&hwep->qh.queue);
1715 hwep->qh.ptr = dma_pool_zalloc(ci->qh_pool, GFP_KERNEL,
1716 &hwep->qh.dma);
1717 if (hwep->qh.ptr == NULL)
1718 retval = -ENOMEM;
1721 * set up shorthands for ep0 out and in endpoints,
1722 * don't add to gadget's ep_list
1724 if (i == 0) {
1725 if (j == RX)
1726 ci->ep0out = hwep;
1727 else
1728 ci->ep0in = hwep;
1730 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1731 continue;
1734 list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1737 return retval;
1740 static void destroy_eps(struct ci_hdrc *ci)
1742 int i;
1744 for (i = 0; i < ci->hw_ep_max; i++) {
1745 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1747 if (hwep->pending_td)
1748 free_pending_td(hwep);
1749 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1754 * ci_udc_start: register a gadget driver
1755 * @gadget: our gadget
1756 * @driver: the driver being registered
1758 * Interrupts are enabled here.
1760 static int ci_udc_start(struct usb_gadget *gadget,
1761 struct usb_gadget_driver *driver)
1763 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1764 int retval = -ENOMEM;
1766 if (driver->disconnect == NULL)
1767 return -EINVAL;
1770 ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1771 retval = usb_ep_enable(&ci->ep0out->ep);
1772 if (retval)
1773 return retval;
1775 ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1776 retval = usb_ep_enable(&ci->ep0in->ep);
1777 if (retval)
1778 return retval;
1780 ci->driver = driver;
1782 /* Start otg fsm for B-device */
1783 if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1784 ci_hdrc_otg_fsm_start(ci);
1785 return retval;
1788 pm_runtime_get_sync(&ci->gadget.dev);
1789 if (ci->vbus_active) {
1790 hw_device_reset(ci);
1791 } else {
1792 usb_udc_vbus_handler(&ci->gadget, false);
1793 pm_runtime_put_sync(&ci->gadget.dev);
1794 return retval;
1797 retval = hw_device_state(ci, ci->ep0out->qh.dma);
1798 if (retval)
1799 pm_runtime_put_sync(&ci->gadget.dev);
1801 return retval;
1804 static void ci_udc_stop_for_otg_fsm(struct ci_hdrc *ci)
1806 if (!ci_otg_is_fsm_mode(ci))
1807 return;
1809 mutex_lock(&ci->fsm.lock);
1810 if (ci->fsm.otg->state == OTG_STATE_A_PERIPHERAL) {
1811 ci->fsm.a_bidl_adis_tmout = 1;
1812 ci_hdrc_otg_fsm_start(ci);
1813 } else if (ci->fsm.otg->state == OTG_STATE_B_PERIPHERAL) {
1814 ci->fsm.protocol = PROTO_UNDEF;
1815 ci->fsm.otg->state = OTG_STATE_UNDEFINED;
1817 mutex_unlock(&ci->fsm.lock);
1821 * ci_udc_stop: unregister a gadget driver
1823 static int ci_udc_stop(struct usb_gadget *gadget)
1825 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1826 unsigned long flags;
1828 spin_lock_irqsave(&ci->lock, flags);
1830 if (ci->vbus_active) {
1831 hw_device_state(ci, 0);
1832 spin_unlock_irqrestore(&ci->lock, flags);
1833 if (ci->platdata->notify_event)
1834 ci->platdata->notify_event(ci,
1835 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1836 _gadget_stop_activity(&ci->gadget);
1837 spin_lock_irqsave(&ci->lock, flags);
1838 pm_runtime_put(&ci->gadget.dev);
1841 ci->driver = NULL;
1842 spin_unlock_irqrestore(&ci->lock, flags);
1844 ci_udc_stop_for_otg_fsm(ci);
1845 return 0;
1848 /******************************************************************************
1849 * BUS block
1850 *****************************************************************************/
1852 * udc_irq: ci interrupt handler
1854 * This function returns IRQ_HANDLED if the IRQ has been handled
1855 * It locks access to registers
1857 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1859 irqreturn_t retval;
1860 u32 intr;
1862 if (ci == NULL)
1863 return IRQ_HANDLED;
1865 spin_lock(&ci->lock);
1867 if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1868 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1869 USBMODE_CM_DC) {
1870 spin_unlock(&ci->lock);
1871 return IRQ_NONE;
1874 intr = hw_test_and_clear_intr_active(ci);
1876 if (intr) {
1877 /* order defines priority - do NOT change it */
1878 if (USBi_URI & intr)
1879 isr_reset_handler(ci);
1881 if (USBi_PCI & intr) {
1882 ci->gadget.speed = hw_port_is_high_speed(ci) ?
1883 USB_SPEED_HIGH : USB_SPEED_FULL;
1884 if (ci->suspended) {
1885 if (ci->driver->resume) {
1886 spin_unlock(&ci->lock);
1887 ci->driver->resume(&ci->gadget);
1888 spin_lock(&ci->lock);
1890 ci->suspended = 0;
1891 usb_gadget_set_state(&ci->gadget,
1892 ci->resume_state);
1896 if (USBi_UI & intr)
1897 isr_tr_complete_handler(ci);
1899 if ((USBi_SLI & intr) && !(ci->suspended)) {
1900 ci->suspended = 1;
1901 ci->resume_state = ci->gadget.state;
1902 if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1903 ci->driver->suspend) {
1904 spin_unlock(&ci->lock);
1905 ci->driver->suspend(&ci->gadget);
1906 spin_lock(&ci->lock);
1908 usb_gadget_set_state(&ci->gadget,
1909 USB_STATE_SUSPENDED);
1911 retval = IRQ_HANDLED;
1912 } else {
1913 retval = IRQ_NONE;
1915 spin_unlock(&ci->lock);
1917 return retval;
1921 * udc_start: initialize gadget role
1922 * @ci: chipidea controller
1924 static int udc_start(struct ci_hdrc *ci)
1926 struct device *dev = ci->dev;
1927 struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;
1928 int retval = 0;
1930 ci->gadget.ops = &usb_gadget_ops;
1931 ci->gadget.speed = USB_SPEED_UNKNOWN;
1932 ci->gadget.max_speed = USB_SPEED_HIGH;
1933 ci->gadget.name = ci->platdata->name;
1934 ci->gadget.otg_caps = otg_caps;
1936 if (ci->platdata->flags & CI_HDRC_REQUIRES_ALIGNED_DMA)
1937 ci->gadget.quirk_avoids_skb_reserve = 1;
1939 if (ci->is_otg && (otg_caps->hnp_support || otg_caps->srp_support ||
1940 otg_caps->adp_support))
1941 ci->gadget.is_otg = 1;
1943 INIT_LIST_HEAD(&ci->gadget.ep_list);
1945 /* alloc resources */
1946 ci->qh_pool = dma_pool_create("ci_hw_qh", dev->parent,
1947 sizeof(struct ci_hw_qh),
1948 64, CI_HDRC_PAGE_SIZE);
1949 if (ci->qh_pool == NULL)
1950 return -ENOMEM;
1952 ci->td_pool = dma_pool_create("ci_hw_td", dev->parent,
1953 sizeof(struct ci_hw_td),
1954 64, CI_HDRC_PAGE_SIZE);
1955 if (ci->td_pool == NULL) {
1956 retval = -ENOMEM;
1957 goto free_qh_pool;
1960 retval = init_eps(ci);
1961 if (retval)
1962 goto free_pools;
1964 ci->gadget.ep0 = &ci->ep0in->ep;
1966 retval = usb_add_gadget_udc(dev, &ci->gadget);
1967 if (retval)
1968 goto destroy_eps;
1970 pm_runtime_no_callbacks(&ci->gadget.dev);
1971 pm_runtime_enable(&ci->gadget.dev);
1973 return retval;
1975 destroy_eps:
1976 destroy_eps(ci);
1977 free_pools:
1978 dma_pool_destroy(ci->td_pool);
1979 free_qh_pool:
1980 dma_pool_destroy(ci->qh_pool);
1981 return retval;
1985 * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1987 * No interrupts active, the IRQ has been released
1989 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1991 if (!ci->roles[CI_ROLE_GADGET])
1992 return;
1994 usb_del_gadget_udc(&ci->gadget);
1996 destroy_eps(ci);
1998 dma_pool_destroy(ci->td_pool);
1999 dma_pool_destroy(ci->qh_pool);
2002 static int udc_id_switch_for_device(struct ci_hdrc *ci)
2004 if (ci->is_otg)
2005 /* Clear and enable BSV irq */
2006 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
2007 OTGSC_BSVIS | OTGSC_BSVIE);
2009 return 0;
2012 static void udc_id_switch_for_host(struct ci_hdrc *ci)
2015 * host doesn't care B_SESSION_VALID event
2016 * so clear and disbale BSV irq
2018 if (ci->is_otg)
2019 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
2021 ci->vbus_active = 0;
2025 * ci_hdrc_gadget_init - initialize device related bits
2026 * ci: the controller
2028 * This function initializes the gadget, if the device is "device capable".
2030 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
2032 struct ci_role_driver *rdrv;
2033 int ret;
2035 if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
2036 return -ENXIO;
2038 rdrv = devm_kzalloc(ci->dev, sizeof(*rdrv), GFP_KERNEL);
2039 if (!rdrv)
2040 return -ENOMEM;
2042 rdrv->start = udc_id_switch_for_device;
2043 rdrv->stop = udc_id_switch_for_host;
2044 rdrv->irq = udc_irq;
2045 rdrv->name = "gadget";
2047 ret = udc_start(ci);
2048 if (!ret)
2049 ci->roles[CI_ROLE_GADGET] = rdrv;
2051 return ret;