1 // SPDX-License-Identifier: GPL-2.0
3 * udc.c - ChipIdea UDC driver
5 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
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/pinctrl/consumer.h>
19 #include <linux/usb/ch9.h>
20 #include <linux/usb/gadget.h>
21 #include <linux/usb/otg-fsm.h>
22 #include <linux/usb/chipidea.h>
31 /* control endpoint description */
32 static const struct usb_endpoint_descriptor
33 ctrl_endpt_out_desc = {
34 .bLength = USB_DT_ENDPOINT_SIZE,
35 .bDescriptorType = USB_DT_ENDPOINT,
37 .bEndpointAddress = USB_DIR_OUT,
38 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
39 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
42 static const struct usb_endpoint_descriptor
43 ctrl_endpt_in_desc = {
44 .bLength = USB_DT_ENDPOINT_SIZE,
45 .bDescriptorType = USB_DT_ENDPOINT,
47 .bEndpointAddress = USB_DIR_IN,
48 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
49 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
52 static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep,
53 struct td_node *node);
55 * hw_ep_bit: calculates the bit number
56 * @num: endpoint number
57 * @dir: endpoint direction
59 * This function returns bit number
61 static inline int hw_ep_bit(int num, int dir)
63 return num + ((dir == TX) ? 16 : 0);
66 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
68 int fill = 16 - ci->hw_ep_max / 2;
70 if (n >= ci->hw_ep_max / 2)
77 * hw_device_state: enables/disables interrupts (execute without interruption)
79 * @dma: 0 => disable, !0 => enable and set dma engine
81 * This function returns an error code
83 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
86 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
87 /* interrupt, error, port change, reset, sleep/suspend */
88 hw_write(ci, OP_USBINTR, ~0,
89 USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
91 hw_write(ci, OP_USBINTR, ~0, 0);
97 * hw_ep_flush: flush endpoint fifo (execute without interruption)
99 * @num: endpoint number
100 * @dir: endpoint direction
102 * This function returns an error code
104 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
106 int n = hw_ep_bit(num, dir);
109 /* flush any pending transfer */
110 hw_write(ci, OP_ENDPTFLUSH, ~0, BIT(n));
111 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
113 } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
119 * hw_ep_disable: disables endpoint (execute without interruption)
120 * @ci: the controller
121 * @num: endpoint number
122 * @dir: endpoint direction
124 * This function returns an error code
126 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
128 hw_write(ci, OP_ENDPTCTRL + num,
129 (dir == TX) ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
134 * hw_ep_enable: enables endpoint (execute without interruption)
135 * @ci: the controller
136 * @num: endpoint number
137 * @dir: endpoint direction
138 * @type: endpoint type
140 * This function returns an error code
142 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
147 mask = ENDPTCTRL_TXT; /* type */
148 data = type << __ffs(mask);
150 mask |= ENDPTCTRL_TXS; /* unstall */
151 mask |= ENDPTCTRL_TXR; /* reset data toggle */
152 data |= ENDPTCTRL_TXR;
153 mask |= ENDPTCTRL_TXE; /* enable */
154 data |= ENDPTCTRL_TXE;
156 mask = ENDPTCTRL_RXT; /* type */
157 data = type << __ffs(mask);
159 mask |= ENDPTCTRL_RXS; /* unstall */
160 mask |= ENDPTCTRL_RXR; /* reset data toggle */
161 data |= ENDPTCTRL_RXR;
162 mask |= ENDPTCTRL_RXE; /* enable */
163 data |= ENDPTCTRL_RXE;
165 hw_write(ci, OP_ENDPTCTRL + num, mask, data);
170 * hw_ep_get_halt: return endpoint halt status
171 * @ci: the controller
172 * @num: endpoint number
173 * @dir: endpoint direction
175 * This function returns 1 if endpoint halted
177 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
179 u32 mask = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
181 return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
185 * hw_ep_prime: primes endpoint (execute without interruption)
186 * @ci: the controller
187 * @num: endpoint number
188 * @dir: endpoint direction
189 * @is_ctrl: true if control endpoint
191 * This function returns an error code
193 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
195 int n = hw_ep_bit(num, dir);
197 /* Synchronize before ep prime */
200 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
203 hw_write(ci, OP_ENDPTPRIME, ~0, BIT(n));
205 while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
207 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
210 /* status shoult be tested according with manual but it doesn't work */
215 * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
216 * without interruption)
217 * @ci: the controller
218 * @num: endpoint number
219 * @dir: endpoint direction
220 * @value: true => stall, false => unstall
222 * This function returns an error code
224 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
226 if (value != 0 && value != 1)
230 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
231 u32 mask_xs = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
232 u32 mask_xr = (dir == TX) ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
234 /* data toggle - reserved for EP0 but it's in ESS */
235 hw_write(ci, reg, mask_xs|mask_xr,
236 value ? mask_xs : mask_xr);
237 } while (value != hw_ep_get_halt(ci, num, dir));
243 * hw_port_is_high_speed: test if port is high speed
244 * @ci: the controller
246 * This function returns true if high speed port
248 static int hw_port_is_high_speed(struct ci_hdrc *ci)
250 return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
251 hw_read(ci, OP_PORTSC, PORTSC_HSP);
255 * hw_test_and_clear_complete: test & clear complete status (execute without
257 * @ci: the controller
258 * @n: endpoint number
260 * This function returns complete status
262 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
264 n = ep_to_bit(ci, n);
265 return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
269 * hw_test_and_clear_intr_active: test & clear active interrupts (execute
270 * without interruption)
271 * @ci: the controller
273 * This function returns active interrutps
275 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
277 u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
279 hw_write(ci, OP_USBSTS, ~0, reg);
284 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
286 * @ci: the controller
288 * This function returns guard value
290 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
292 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
296 * hw_test_and_set_setup_guard: test & set setup guard (execute without
298 * @ci: the controller
300 * This function returns guard value
302 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
304 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
308 * hw_usb_set_address: configures USB address (execute without interruption)
309 * @ci: the controller
310 * @value: new USB address
312 * This function explicitly sets the address, without the "USBADRA" (advance)
313 * feature, which is not supported by older versions of the controller.
315 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
317 hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
318 value << __ffs(DEVICEADDR_USBADR));
322 * hw_usb_reset: restart device after a bus reset (execute without
324 * @ci: the controller
326 * This function returns an error code
328 static int hw_usb_reset(struct ci_hdrc *ci)
330 hw_usb_set_address(ci, 0);
332 /* ESS flushes only at end?!? */
333 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
335 /* clear setup token semaphores */
336 hw_write(ci, OP_ENDPTSETUPSTAT, 0, 0);
338 /* clear complete status */
339 hw_write(ci, OP_ENDPTCOMPLETE, 0, 0);
341 /* wait until all bits cleared */
342 while (hw_read(ci, OP_ENDPTPRIME, ~0))
343 udelay(10); /* not RTOS friendly */
345 /* reset all endpoints ? */
347 /* reset internal status and wait for further instructions
348 no need to verify the port reset status (ESS does it) */
353 /******************************************************************************
355 *****************************************************************************/
357 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
358 unsigned int length, struct scatterlist *s)
362 struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
368 node->ptr = dma_pool_zalloc(hwep->td_pool, GFP_ATOMIC, &node->dma);
369 if (node->ptr == NULL) {
374 node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
375 node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
376 node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
377 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX) {
378 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
380 if (hwreq->req.length == 0
381 || hwreq->req.length % hwep->ep.maxpacket)
383 node->ptr->token |= cpu_to_le32(mul << __ffs(TD_MULTO));
387 temp = (u32) (sg_dma_address(s) + hwreq->req.actual);
388 node->td_remaining_size = CI_MAX_BUF_SIZE - length;
390 temp = (u32) (hwreq->req.dma + hwreq->req.actual);
394 node->ptr->page[0] = cpu_to_le32(temp);
395 for (i = 1; i < TD_PAGE_COUNT; i++) {
396 u32 page = temp + i * CI_HDRC_PAGE_SIZE;
397 page &= ~TD_RESERVED_MASK;
398 node->ptr->page[i] = cpu_to_le32(page);
402 hwreq->req.actual += length;
404 if (!list_empty(&hwreq->tds)) {
405 /* get the last entry */
406 lastnode = list_entry(hwreq->tds.prev,
408 lastnode->ptr->next = cpu_to_le32(node->dma);
411 INIT_LIST_HEAD(&node->td);
412 list_add_tail(&node->td, &hwreq->tds);
418 * _usb_addr: calculates endpoint address from direction & number
421 static inline u8 _usb_addr(struct ci_hw_ep *ep)
423 return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
426 static int prepare_td_for_non_sg(struct ci_hw_ep *hwep,
427 struct ci_hw_req *hwreq)
429 unsigned int rest = hwreq->req.length;
430 int pages = TD_PAGE_COUNT;
434 ret = add_td_to_list(hwep, hwreq, 0, NULL);
440 * The first buffer could be not page aligned.
441 * In that case we have to span into one extra td.
443 if (hwreq->req.dma % PAGE_SIZE)
447 unsigned int count = min(hwreq->req.length - hwreq->req.actual,
448 (unsigned int)(pages * CI_HDRC_PAGE_SIZE));
450 ret = add_td_to_list(hwep, hwreq, count, NULL);
457 if (hwreq->req.zero && hwreq->req.length && hwep->dir == TX
458 && (hwreq->req.length % hwep->ep.maxpacket == 0)) {
459 ret = add_td_to_list(hwep, hwreq, 0, NULL);
467 static int prepare_td_per_sg(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
468 struct scatterlist *s)
470 unsigned int rest = sg_dma_len(s);
473 hwreq->req.actual = 0;
475 unsigned int count = min_t(unsigned int, rest,
478 ret = add_td_to_list(hwep, hwreq, count, s);
488 static void ci_add_buffer_entry(struct td_node *node, struct scatterlist *s)
490 int empty_td_slot_index = (CI_MAX_BUF_SIZE - node->td_remaining_size)
495 token = le32_to_cpu(node->ptr->token) + (sg_dma_len(s) << __ffs(TD_TOTAL_BYTES));
496 node->ptr->token = cpu_to_le32(token);
498 for (i = empty_td_slot_index; i < TD_PAGE_COUNT; i++) {
499 u32 page = (u32) sg_dma_address(s) +
500 (i - empty_td_slot_index) * CI_HDRC_PAGE_SIZE;
502 page &= ~TD_RESERVED_MASK;
503 node->ptr->page[i] = cpu_to_le32(page);
507 static int prepare_td_for_sg(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
509 struct usb_request *req = &hwreq->req;
510 struct scatterlist *s = req->sg;
512 struct td_node *node = NULL;
514 if (!s || req->zero || req->length == 0) {
515 dev_err(hwep->ci->dev, "not supported operation for sg\n");
519 while (i++ < req->num_mapped_sgs) {
520 if (sg_dma_address(s) % PAGE_SIZE) {
521 dev_err(hwep->ci->dev, "not page aligned sg buffer\n");
525 if (node && (node->td_remaining_size >= sg_dma_len(s))) {
526 ci_add_buffer_entry(node, s);
527 node->td_remaining_size -= sg_dma_len(s);
529 ret = prepare_td_per_sg(hwep, hwreq, s);
533 node = list_entry(hwreq->tds.prev,
544 * _hardware_enqueue: configures a request at hardware level
548 * This function returns an error code
550 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
552 struct ci_hdrc *ci = hwep->ci;
554 struct td_node *firstnode, *lastnode;
556 /* don't queue twice */
557 if (hwreq->req.status == -EALREADY)
560 hwreq->req.status = -EALREADY;
562 ret = usb_gadget_map_request_by_dev(ci->dev->parent,
563 &hwreq->req, hwep->dir);
567 if (hwreq->req.num_mapped_sgs)
568 ret = prepare_td_for_sg(hwep, hwreq);
570 ret = prepare_td_for_non_sg(hwep, hwreq);
575 lastnode = list_entry(hwreq->tds.prev,
578 lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
579 if (!hwreq->req.no_interrupt)
580 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
582 list_for_each_entry_safe(firstnode, lastnode, &hwreq->tds, td)
583 trace_ci_prepare_td(hwep, hwreq, firstnode);
585 firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
589 hwreq->req.actual = 0;
590 if (!list_empty(&hwep->qh.queue)) {
591 struct ci_hw_req *hwreqprev;
592 int n = hw_ep_bit(hwep->num, hwep->dir);
594 struct td_node *prevlastnode;
595 u32 next = firstnode->dma & TD_ADDR_MASK;
597 hwreqprev = list_entry(hwep->qh.queue.prev,
598 struct ci_hw_req, queue);
599 prevlastnode = list_entry(hwreqprev->tds.prev,
602 prevlastnode->ptr->next = cpu_to_le32(next);
605 if (ci->rev == CI_REVISION_22) {
606 if (!hw_read(ci, OP_ENDPTSTAT, BIT(n)))
607 reprime_dtd(ci, hwep, prevlastnode);
610 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
613 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
614 tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
615 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
616 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
621 /* QH configuration */
622 hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
623 hwep->qh.ptr->td.token &=
624 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
626 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == RX) {
627 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
629 if (hwreq->req.length == 0
630 || hwreq->req.length % hwep->ep.maxpacket)
632 hwep->qh.ptr->cap |= cpu_to_le32(mul << __ffs(QH_MULT));
635 ret = hw_ep_prime(ci, hwep->num, hwep->dir,
636 hwep->type == USB_ENDPOINT_XFER_CONTROL);
642 * free_pending_td: remove a pending request for the endpoint
645 static void free_pending_td(struct ci_hw_ep *hwep)
647 struct td_node *pending = hwep->pending_td;
649 dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
650 hwep->pending_td = NULL;
654 static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep,
655 struct td_node *node)
657 hwep->qh.ptr->td.next = cpu_to_le32(node->dma);
658 hwep->qh.ptr->td.token &=
659 cpu_to_le32(~(TD_STATUS_HALTED | TD_STATUS_ACTIVE));
661 return hw_ep_prime(ci, hwep->num, hwep->dir,
662 hwep->type == USB_ENDPOINT_XFER_CONTROL);
666 * _hardware_dequeue: handles a request at hardware level
670 * This function returns an error code
672 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
675 struct td_node *node, *tmpnode;
676 unsigned remaining_length;
677 unsigned actual = hwreq->req.length;
678 struct ci_hdrc *ci = hwep->ci;
680 if (hwreq->req.status != -EALREADY)
683 hwreq->req.status = 0;
685 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
686 tmptoken = le32_to_cpu(node->ptr->token);
687 trace_ci_complete_td(hwep, hwreq, node);
688 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
689 int n = hw_ep_bit(hwep->num, hwep->dir);
691 if (ci->rev == CI_REVISION_24)
692 if (!hw_read(ci, OP_ENDPTSTAT, BIT(n)))
693 reprime_dtd(ci, hwep, node);
694 hwreq->req.status = -EALREADY;
698 remaining_length = (tmptoken & TD_TOTAL_BYTES);
699 remaining_length >>= __ffs(TD_TOTAL_BYTES);
700 actual -= remaining_length;
702 hwreq->req.status = tmptoken & TD_STATUS;
703 if ((TD_STATUS_HALTED & hwreq->req.status)) {
704 hwreq->req.status = -EPIPE;
706 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
707 hwreq->req.status = -EPROTO;
709 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
710 hwreq->req.status = -EILSEQ;
714 if (remaining_length) {
715 if (hwep->dir == TX) {
716 hwreq->req.status = -EPROTO;
721 * As the hardware could still address the freed td
722 * which will run the udc unusable, the cleanup of the
723 * td has to be delayed by one.
725 if (hwep->pending_td)
726 free_pending_td(hwep);
728 hwep->pending_td = node;
729 list_del_init(&node->td);
732 usb_gadget_unmap_request_by_dev(hwep->ci->dev->parent,
733 &hwreq->req, hwep->dir);
735 hwreq->req.actual += actual;
737 if (hwreq->req.status)
738 return hwreq->req.status;
740 return hwreq->req.actual;
744 * _ep_nuke: dequeues all endpoint requests
747 * This function returns an error code
748 * Caller must hold lock
750 static int _ep_nuke(struct ci_hw_ep *hwep)
751 __releases(hwep->lock)
752 __acquires(hwep->lock)
754 struct td_node *node, *tmpnode;
758 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
760 while (!list_empty(&hwep->qh.queue)) {
762 /* pop oldest request */
763 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
764 struct ci_hw_req, queue);
766 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
767 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
768 list_del_init(&node->td);
773 list_del_init(&hwreq->queue);
774 hwreq->req.status = -ESHUTDOWN;
776 if (hwreq->req.complete != NULL) {
777 spin_unlock(hwep->lock);
778 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
779 spin_lock(hwep->lock);
783 if (hwep->pending_td)
784 free_pending_td(hwep);
789 static int _ep_set_halt(struct usb_ep *ep, int value, bool check_transfer)
791 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
792 int direction, retval = 0;
795 if (ep == NULL || hwep->ep.desc == NULL)
798 if (usb_endpoint_xfer_isoc(hwep->ep.desc))
801 spin_lock_irqsave(hwep->lock, flags);
803 if (value && hwep->dir == TX && check_transfer &&
804 !list_empty(&hwep->qh.queue) &&
805 !usb_endpoint_xfer_control(hwep->ep.desc)) {
806 spin_unlock_irqrestore(hwep->lock, flags);
810 direction = hwep->dir;
812 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
817 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
818 hwep->dir = (hwep->dir == TX) ? RX : TX;
820 } while (hwep->dir != direction);
822 spin_unlock_irqrestore(hwep->lock, flags);
828 * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
831 * This function returns an error code
833 static int _gadget_stop_activity(struct usb_gadget *gadget)
836 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
839 /* flush all endpoints */
840 gadget_for_each_ep(ep, gadget) {
841 usb_ep_fifo_flush(ep);
843 usb_ep_fifo_flush(&ci->ep0out->ep);
844 usb_ep_fifo_flush(&ci->ep0in->ep);
846 /* make sure to disable all endpoints */
847 gadget_for_each_ep(ep, gadget) {
851 if (ci->status != NULL) {
852 usb_ep_free_request(&ci->ep0in->ep, ci->status);
856 spin_lock_irqsave(&ci->lock, flags);
857 ci->gadget.speed = USB_SPEED_UNKNOWN;
858 ci->remote_wakeup = 0;
860 spin_unlock_irqrestore(&ci->lock, flags);
865 /******************************************************************************
867 *****************************************************************************/
869 * isr_reset_handler: USB reset interrupt handler
872 * This function resets USB engine after a bus reset occurred
874 static void isr_reset_handler(struct ci_hdrc *ci)
880 spin_unlock(&ci->lock);
881 if (ci->gadget.speed != USB_SPEED_UNKNOWN)
882 usb_gadget_udc_reset(&ci->gadget, ci->driver);
884 retval = _gadget_stop_activity(&ci->gadget);
888 retval = hw_usb_reset(ci);
892 ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
893 if (ci->status == NULL)
897 spin_lock(&ci->lock);
900 dev_err(ci->dev, "error: %i\n", retval);
904 * isr_get_status_complete: get_status request complete function
906 * @req: request handled
908 * Caller must release lock
910 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
912 if (ep == NULL || req == NULL)
916 usb_ep_free_request(ep, req);
920 * _ep_queue: queues (submits) an I/O request to an endpoint
923 * @gfp_flags: GFP flags (not used)
925 * Caller must hold lock
926 * This function returns an error code
928 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
929 gfp_t __maybe_unused gfp_flags)
931 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
932 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
933 struct ci_hdrc *ci = hwep->ci;
936 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
939 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
941 hwep = (ci->ep0_dir == RX) ?
942 ci->ep0out : ci->ep0in;
943 if (!list_empty(&hwep->qh.queue)) {
945 dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
950 if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
951 hwreq->req.length > hwep->ep.mult * hwep->ep.maxpacket) {
952 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
956 /* first nuke then test link, e.g. previous status has not sent */
957 if (!list_empty(&hwreq->queue)) {
958 dev_err(hwep->ci->dev, "request already in queue\n");
963 hwreq->req.status = -EINPROGRESS;
964 hwreq->req.actual = 0;
966 retval = _hardware_enqueue(hwep, hwreq);
968 if (retval == -EALREADY)
971 list_add_tail(&hwreq->queue, &hwep->qh.queue);
977 * isr_get_status_response: get_status request response
979 * @setup: setup request packet
981 * This function returns an error code
983 static int isr_get_status_response(struct ci_hdrc *ci,
984 struct usb_ctrlrequest *setup)
985 __releases(hwep->lock)
986 __acquires(hwep->lock)
988 struct ci_hw_ep *hwep = ci->ep0in;
989 struct usb_request *req = NULL;
990 gfp_t gfp_flags = GFP_ATOMIC;
991 int dir, num, retval;
993 if (hwep == NULL || setup == NULL)
996 spin_unlock(hwep->lock);
997 req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
998 spin_lock(hwep->lock);
1002 req->complete = isr_get_status_complete;
1004 req->buf = kzalloc(req->length, gfp_flags);
1005 if (req->buf == NULL) {
1010 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
1011 *(u16 *)req->buf = (ci->remote_wakeup << 1) |
1012 ci->gadget.is_selfpowered;
1013 } else if ((setup->bRequestType & USB_RECIP_MASK) \
1014 == USB_RECIP_ENDPOINT) {
1015 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
1017 num = le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
1018 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
1020 /* else do nothing; reserved for future use */
1022 retval = _ep_queue(&hwep->ep, req, gfp_flags);
1031 spin_unlock(hwep->lock);
1032 usb_ep_free_request(&hwep->ep, req);
1033 spin_lock(hwep->lock);
1038 * isr_setup_status_complete: setup_status request complete function
1040 * @req: request handled
1042 * Caller must release lock. Put the port in test mode if test mode
1043 * feature is selected.
1046 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
1048 struct ci_hdrc *ci = req->context;
1049 unsigned long flags;
1051 if (req->status < 0)
1055 hw_usb_set_address(ci, ci->address);
1056 ci->setaddr = false;
1058 usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
1061 spin_lock_irqsave(&ci->lock, flags);
1063 hw_port_test_set(ci, ci->test_mode);
1064 spin_unlock_irqrestore(&ci->lock, flags);
1068 * isr_setup_status_phase: queues the status phase of a setup transation
1071 * This function returns an error code
1073 static int isr_setup_status_phase(struct ci_hdrc *ci)
1075 struct ci_hw_ep *hwep;
1078 * Unexpected USB controller behavior, caused by bad signal integrity
1079 * or ground reference problems, can lead to isr_setup_status_phase
1080 * being called with ci->status equal to NULL.
1081 * If this situation occurs, you should review your USB hardware design.
1083 if (WARN_ON_ONCE(!ci->status))
1086 hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
1087 ci->status->context = ci;
1088 ci->status->complete = isr_setup_status_complete;
1090 return _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
1094 * isr_tr_complete_low: transaction complete low level handler
1097 * This function returns an error code
1098 * Caller must hold lock
1100 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
1101 __releases(hwep->lock)
1102 __acquires(hwep->lock)
1104 struct ci_hw_req *hwreq, *hwreqtemp;
1105 struct ci_hw_ep *hweptemp = hwep;
1108 list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
1110 retval = _hardware_dequeue(hwep, hwreq);
1113 list_del_init(&hwreq->queue);
1114 if (hwreq->req.complete != NULL) {
1115 spin_unlock(hwep->lock);
1116 if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
1118 hweptemp = hwep->ci->ep0in;
1119 usb_gadget_giveback_request(&hweptemp->ep, &hwreq->req);
1120 spin_lock(hwep->lock);
1124 if (retval == -EBUSY)
1130 static int otg_a_alt_hnp_support(struct ci_hdrc *ci)
1132 dev_warn(&ci->gadget.dev,
1133 "connect the device to an alternate port if you want HNP\n");
1134 return isr_setup_status_phase(ci);
1138 * isr_setup_packet_handler: setup packet handler
1139 * @ci: UDC descriptor
1141 * This function handles setup packet
1143 static void isr_setup_packet_handler(struct ci_hdrc *ci)
1144 __releases(ci->lock)
1145 __acquires(ci->lock)
1147 struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
1148 struct usb_ctrlrequest req;
1149 int type, num, dir, err = -EINVAL;
1153 * Flush data and handshake transactions of previous
1156 _ep_nuke(ci->ep0out);
1157 _ep_nuke(ci->ep0in);
1159 /* read_setup_packet */
1161 hw_test_and_set_setup_guard(ci);
1162 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1163 } while (!hw_test_and_clear_setup_guard(ci));
1165 type = req.bRequestType;
1167 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1169 switch (req.bRequest) {
1170 case USB_REQ_CLEAR_FEATURE:
1171 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1172 le16_to_cpu(req.wValue) ==
1173 USB_ENDPOINT_HALT) {
1174 if (req.wLength != 0)
1176 num = le16_to_cpu(req.wIndex);
1177 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1178 num &= USB_ENDPOINT_NUMBER_MASK;
1180 num += ci->hw_ep_max / 2;
1181 if (!ci->ci_hw_ep[num].wedge) {
1182 spin_unlock(&ci->lock);
1183 err = usb_ep_clear_halt(
1184 &ci->ci_hw_ep[num].ep);
1185 spin_lock(&ci->lock);
1189 err = isr_setup_status_phase(ci);
1190 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1191 le16_to_cpu(req.wValue) ==
1192 USB_DEVICE_REMOTE_WAKEUP) {
1193 if (req.wLength != 0)
1195 ci->remote_wakeup = 0;
1196 err = isr_setup_status_phase(ci);
1201 case USB_REQ_GET_STATUS:
1202 if ((type != (USB_DIR_IN|USB_RECIP_DEVICE) ||
1203 le16_to_cpu(req.wIndex) == OTG_STS_SELECTOR) &&
1204 type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1205 type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1207 if (le16_to_cpu(req.wLength) != 2 ||
1208 le16_to_cpu(req.wValue) != 0)
1210 err = isr_get_status_response(ci, &req);
1212 case USB_REQ_SET_ADDRESS:
1213 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1215 if (le16_to_cpu(req.wLength) != 0 ||
1216 le16_to_cpu(req.wIndex) != 0)
1218 ci->address = (u8)le16_to_cpu(req.wValue);
1220 err = isr_setup_status_phase(ci);
1222 case USB_REQ_SET_FEATURE:
1223 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1224 le16_to_cpu(req.wValue) ==
1225 USB_ENDPOINT_HALT) {
1226 if (req.wLength != 0)
1228 num = le16_to_cpu(req.wIndex);
1229 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1230 num &= USB_ENDPOINT_NUMBER_MASK;
1232 num += ci->hw_ep_max / 2;
1234 spin_unlock(&ci->lock);
1235 err = _ep_set_halt(&ci->ci_hw_ep[num].ep, 1, false);
1236 spin_lock(&ci->lock);
1238 isr_setup_status_phase(ci);
1239 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1240 if (req.wLength != 0)
1242 switch (le16_to_cpu(req.wValue)) {
1243 case USB_DEVICE_REMOTE_WAKEUP:
1244 ci->remote_wakeup = 1;
1245 err = isr_setup_status_phase(ci);
1247 case USB_DEVICE_TEST_MODE:
1248 tmode = le16_to_cpu(req.wIndex) >> 8;
1252 case USB_TEST_SE0_NAK:
1253 case USB_TEST_PACKET:
1254 case USB_TEST_FORCE_ENABLE:
1255 ci->test_mode = tmode;
1256 err = isr_setup_status_phase(
1263 case USB_DEVICE_B_HNP_ENABLE:
1264 if (ci_otg_is_fsm_mode(ci)) {
1265 ci->gadget.b_hnp_enable = 1;
1266 err = isr_setup_status_phase(
1270 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1271 if (ci_otg_is_fsm_mode(ci))
1272 err = otg_a_alt_hnp_support(ci);
1274 case USB_DEVICE_A_HNP_SUPPORT:
1275 if (ci_otg_is_fsm_mode(ci)) {
1276 ci->gadget.a_hnp_support = 1;
1277 err = isr_setup_status_phase(
1290 if (req.wLength == 0) /* no data phase */
1293 spin_unlock(&ci->lock);
1294 err = ci->driver->setup(&ci->gadget, &req);
1295 spin_lock(&ci->lock);
1300 spin_unlock(&ci->lock);
1301 if (_ep_set_halt(&hwep->ep, 1, false))
1302 dev_err(ci->dev, "error: _ep_set_halt\n");
1303 spin_lock(&ci->lock);
1308 * isr_tr_complete_handler: transaction complete interrupt handler
1309 * @ci: UDC descriptor
1311 * This function handles traffic events
1313 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1314 __releases(ci->lock)
1315 __acquires(ci->lock)
1320 for (i = 0; i < ci->hw_ep_max; i++) {
1321 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1323 if (hwep->ep.desc == NULL)
1324 continue; /* not configured */
1326 if (hw_test_and_clear_complete(ci, i)) {
1327 err = isr_tr_complete_low(hwep);
1328 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1329 if (err > 0) /* needs status phase */
1330 err = isr_setup_status_phase(ci);
1332 spin_unlock(&ci->lock);
1333 if (_ep_set_halt(&hwep->ep, 1, false))
1335 "error: _ep_set_halt\n");
1336 spin_lock(&ci->lock);
1341 /* Only handle setup packet below */
1343 hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1344 isr_setup_packet_handler(ci);
1348 /******************************************************************************
1350 *****************************************************************************/
1352 * ep_enable: configure endpoint, making it usable
1354 * Check usb_ep_enable() at "usb_gadget.h" for details
1356 static int ep_enable(struct usb_ep *ep,
1357 const struct usb_endpoint_descriptor *desc)
1359 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1361 unsigned long flags;
1364 if (ep == NULL || desc == NULL)
1367 spin_lock_irqsave(hwep->lock, flags);
1369 /* only internal SW should enable ctrl endpts */
1371 if (!list_empty(&hwep->qh.queue)) {
1372 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1373 spin_unlock_irqrestore(hwep->lock, flags);
1377 hwep->ep.desc = desc;
1379 hwep->dir = usb_endpoint_dir_in(desc) ? TX : RX;
1380 hwep->num = usb_endpoint_num(desc);
1381 hwep->type = usb_endpoint_type(desc);
1383 hwep->ep.maxpacket = usb_endpoint_maxp(desc);
1384 hwep->ep.mult = usb_endpoint_maxp_mult(desc);
1386 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1390 cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1392 * For ISO-TX, we set mult at QH as the largest value, and use
1393 * MultO at TD as real mult value.
1395 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1396 cap |= 3 << __ffs(QH_MULT);
1398 hwep->qh.ptr->cap = cpu_to_le32(cap);
1400 hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE); /* needed? */
1402 if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1403 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1408 * Enable endpoints in the HW other than ep0 as ep0
1412 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1415 spin_unlock_irqrestore(hwep->lock, flags);
1420 * ep_disable: endpoint is no longer usable
1422 * Check usb_ep_disable() at "usb_gadget.h" for details
1424 static int ep_disable(struct usb_ep *ep)
1426 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1427 int direction, retval = 0;
1428 unsigned long flags;
1432 else if (hwep->ep.desc == NULL)
1435 spin_lock_irqsave(hwep->lock, flags);
1436 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1437 spin_unlock_irqrestore(hwep->lock, flags);
1441 /* only internal SW should disable ctrl endpts */
1443 direction = hwep->dir;
1445 retval |= _ep_nuke(hwep);
1446 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1448 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1449 hwep->dir = (hwep->dir == TX) ? RX : TX;
1451 } while (hwep->dir != direction);
1453 hwep->ep.desc = NULL;
1455 spin_unlock_irqrestore(hwep->lock, flags);
1460 * ep_alloc_request: allocate a request object to use with this endpoint
1462 * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1464 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1466 struct ci_hw_req *hwreq = NULL;
1471 hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1472 if (hwreq != NULL) {
1473 INIT_LIST_HEAD(&hwreq->queue);
1474 INIT_LIST_HEAD(&hwreq->tds);
1477 return (hwreq == NULL) ? NULL : &hwreq->req;
1481 * ep_free_request: frees a request object
1483 * Check usb_ep_free_request() at "usb_gadget.h" for details
1485 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1487 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1488 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1489 struct td_node *node, *tmpnode;
1490 unsigned long flags;
1492 if (ep == NULL || req == NULL) {
1494 } else if (!list_empty(&hwreq->queue)) {
1495 dev_err(hwep->ci->dev, "freeing queued request\n");
1499 spin_lock_irqsave(hwep->lock, flags);
1501 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1502 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1503 list_del_init(&node->td);
1510 spin_unlock_irqrestore(hwep->lock, flags);
1514 * ep_queue: queues (submits) an I/O request to an endpoint
1516 * Check usb_ep_queue()* at usb_gadget.h" for details
1518 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1519 gfp_t __maybe_unused gfp_flags)
1521 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1523 unsigned long flags;
1525 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1528 spin_lock_irqsave(hwep->lock, flags);
1529 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1530 spin_unlock_irqrestore(hwep->lock, flags);
1533 retval = _ep_queue(ep, req, gfp_flags);
1534 spin_unlock_irqrestore(hwep->lock, flags);
1539 * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1541 * Check usb_ep_dequeue() at "usb_gadget.h" for details
1543 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1545 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1546 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1547 unsigned long flags;
1548 struct td_node *node, *tmpnode;
1550 if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1551 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1552 list_empty(&hwep->qh.queue))
1555 spin_lock_irqsave(hwep->lock, flags);
1556 if (hwep->ci->gadget.speed != USB_SPEED_UNKNOWN)
1557 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1559 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1560 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1561 list_del(&node->td);
1566 list_del_init(&hwreq->queue);
1568 usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1570 req->status = -ECONNRESET;
1572 if (hwreq->req.complete != NULL) {
1573 spin_unlock(hwep->lock);
1574 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
1575 spin_lock(hwep->lock);
1578 spin_unlock_irqrestore(hwep->lock, flags);
1583 * ep_set_halt: sets the endpoint halt feature
1585 * Check usb_ep_set_halt() at "usb_gadget.h" for details
1587 static int ep_set_halt(struct usb_ep *ep, int value)
1589 return _ep_set_halt(ep, value, true);
1593 * ep_set_wedge: sets the halt feature and ignores clear requests
1595 * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1597 static int ep_set_wedge(struct usb_ep *ep)
1599 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1600 unsigned long flags;
1602 if (ep == NULL || hwep->ep.desc == NULL)
1605 spin_lock_irqsave(hwep->lock, flags);
1607 spin_unlock_irqrestore(hwep->lock, flags);
1609 return usb_ep_set_halt(ep);
1613 * ep_fifo_flush: flushes contents of a fifo
1615 * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1617 static void ep_fifo_flush(struct usb_ep *ep)
1619 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1620 unsigned long flags;
1623 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1627 spin_lock_irqsave(hwep->lock, flags);
1628 if (hwep->ci->gadget.speed == USB_SPEED_UNKNOWN) {
1629 spin_unlock_irqrestore(hwep->lock, flags);
1633 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1635 spin_unlock_irqrestore(hwep->lock, flags);
1639 * Endpoint-specific part of the API to the USB controller hardware
1640 * Check "usb_gadget.h" for details
1642 static const struct usb_ep_ops usb_ep_ops = {
1643 .enable = ep_enable,
1644 .disable = ep_disable,
1645 .alloc_request = ep_alloc_request,
1646 .free_request = ep_free_request,
1648 .dequeue = ep_dequeue,
1649 .set_halt = ep_set_halt,
1650 .set_wedge = ep_set_wedge,
1651 .fifo_flush = ep_fifo_flush,
1654 /******************************************************************************
1656 *****************************************************************************/
1658 static int ci_udc_get_frame(struct usb_gadget *_gadget)
1660 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1661 unsigned long flags;
1664 spin_lock_irqsave(&ci->lock, flags);
1665 ret = hw_read(ci, OP_FRINDEX, 0x3fff);
1666 spin_unlock_irqrestore(&ci->lock, flags);
1671 * ci_hdrc_gadget_connect: caller makes sure gadget driver is binded
1673 static void ci_hdrc_gadget_connect(struct usb_gadget *_gadget, int is_active)
1675 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1678 pm_runtime_get_sync(ci->dev);
1679 hw_device_reset(ci);
1680 spin_lock_irq(&ci->lock);
1682 hw_device_state(ci, ci->ep0out->qh.dma);
1683 usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1684 spin_unlock_irq(&ci->lock);
1685 usb_udc_vbus_handler(_gadget, true);
1687 spin_unlock_irq(&ci->lock);
1690 usb_udc_vbus_handler(_gadget, false);
1692 ci->driver->disconnect(&ci->gadget);
1693 hw_device_state(ci, 0);
1694 if (ci->platdata->notify_event)
1695 ci->platdata->notify_event(ci,
1696 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1697 _gadget_stop_activity(&ci->gadget);
1698 pm_runtime_put_sync(ci->dev);
1699 usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1703 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1705 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1706 unsigned long flags;
1709 spin_lock_irqsave(&ci->lock, flags);
1710 ci->vbus_active = is_active;
1711 spin_unlock_irqrestore(&ci->lock, flags);
1714 usb_phy_set_charger_state(ci->usb_phy, is_active ?
1715 USB_CHARGER_PRESENT : USB_CHARGER_ABSENT);
1717 if (ci->platdata->notify_event)
1718 ret = ci->platdata->notify_event(ci,
1719 CI_HDRC_CONTROLLER_VBUS_EVENT);
1722 ci_hdrc_gadget_connect(_gadget, is_active);
1727 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1729 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1730 unsigned long flags;
1733 spin_lock_irqsave(&ci->lock, flags);
1734 if (ci->gadget.speed == USB_SPEED_UNKNOWN) {
1735 spin_unlock_irqrestore(&ci->lock, flags);
1738 if (!ci->remote_wakeup) {
1742 if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1746 hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1748 spin_unlock_irqrestore(&ci->lock, flags);
1752 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1754 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1757 return usb_phy_set_power(ci->usb_phy, ma);
1761 static int ci_udc_selfpowered(struct usb_gadget *_gadget, int is_on)
1763 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1764 struct ci_hw_ep *hwep = ci->ep0in;
1765 unsigned long flags;
1767 spin_lock_irqsave(hwep->lock, flags);
1768 _gadget->is_selfpowered = (is_on != 0);
1769 spin_unlock_irqrestore(hwep->lock, flags);
1774 /* Change Data+ pullup status
1775 * this func is used by usb_gadget_connect/disconnect
1777 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1779 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1782 * Data+ pullup controlled by OTG state machine in OTG fsm mode;
1783 * and don't touch Data+ in host mode for dual role config.
1785 if (ci_otg_is_fsm_mode(ci) || ci->role == CI_ROLE_HOST)
1788 pm_runtime_get_sync(ci->dev);
1790 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1792 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1793 pm_runtime_put_sync(ci->dev);
1798 static int ci_udc_start(struct usb_gadget *gadget,
1799 struct usb_gadget_driver *driver);
1800 static int ci_udc_stop(struct usb_gadget *gadget);
1802 /* Match ISOC IN from the highest endpoint */
1803 static struct usb_ep *ci_udc_match_ep(struct usb_gadget *gadget,
1804 struct usb_endpoint_descriptor *desc,
1805 struct usb_ss_ep_comp_descriptor *comp_desc)
1807 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1810 if (usb_endpoint_xfer_isoc(desc) && usb_endpoint_dir_in(desc)) {
1811 list_for_each_entry_reverse(ep, &ci->gadget.ep_list, ep_list) {
1812 if (ep->caps.dir_in && !ep->claimed)
1821 * Device operations part of the API to the USB controller hardware,
1822 * which don't involve endpoints (or i/o)
1823 * Check "usb_gadget.h" for details
1825 static const struct usb_gadget_ops usb_gadget_ops = {
1826 .get_frame = ci_udc_get_frame,
1827 .vbus_session = ci_udc_vbus_session,
1828 .wakeup = ci_udc_wakeup,
1829 .set_selfpowered = ci_udc_selfpowered,
1830 .pullup = ci_udc_pullup,
1831 .vbus_draw = ci_udc_vbus_draw,
1832 .udc_start = ci_udc_start,
1833 .udc_stop = ci_udc_stop,
1834 .match_ep = ci_udc_match_ep,
1837 static int init_eps(struct ci_hdrc *ci)
1839 int retval = 0, i, j;
1841 for (i = 0; i < ci->hw_ep_max/2; i++)
1842 for (j = RX; j <= TX; j++) {
1843 int k = i + j * ci->hw_ep_max/2;
1844 struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1846 scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1847 (j == TX) ? "in" : "out");
1850 hwep->lock = &ci->lock;
1851 hwep->td_pool = ci->td_pool;
1853 hwep->ep.name = hwep->name;
1854 hwep->ep.ops = &usb_ep_ops;
1857 hwep->ep.caps.type_control = true;
1859 hwep->ep.caps.type_iso = true;
1860 hwep->ep.caps.type_bulk = true;
1861 hwep->ep.caps.type_int = true;
1865 hwep->ep.caps.dir_in = true;
1867 hwep->ep.caps.dir_out = true;
1870 * for ep0: maxP defined in desc, for other
1871 * eps, maxP is set by epautoconfig() called
1874 usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1876 INIT_LIST_HEAD(&hwep->qh.queue);
1877 hwep->qh.ptr = dma_pool_zalloc(ci->qh_pool, GFP_KERNEL,
1879 if (hwep->qh.ptr == NULL)
1883 * set up shorthands for ep0 out and in endpoints,
1884 * don't add to gadget's ep_list
1892 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1896 list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1902 static void destroy_eps(struct ci_hdrc *ci)
1906 for (i = 0; i < ci->hw_ep_max; i++) {
1907 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1909 if (hwep->pending_td)
1910 free_pending_td(hwep);
1911 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1916 * ci_udc_start: register a gadget driver
1917 * @gadget: our gadget
1918 * @driver: the driver being registered
1920 * Interrupts are enabled here.
1922 static int ci_udc_start(struct usb_gadget *gadget,
1923 struct usb_gadget_driver *driver)
1925 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1928 if (driver->disconnect == NULL)
1931 ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1932 retval = usb_ep_enable(&ci->ep0out->ep);
1936 ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1937 retval = usb_ep_enable(&ci->ep0in->ep);
1941 ci->driver = driver;
1943 /* Start otg fsm for B-device */
1944 if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1945 ci_hdrc_otg_fsm_start(ci);
1949 if (ci->vbus_active)
1950 ci_hdrc_gadget_connect(gadget, 1);
1952 usb_udc_vbus_handler(&ci->gadget, false);
1957 static void ci_udc_stop_for_otg_fsm(struct ci_hdrc *ci)
1959 if (!ci_otg_is_fsm_mode(ci))
1962 mutex_lock(&ci->fsm.lock);
1963 if (ci->fsm.otg->state == OTG_STATE_A_PERIPHERAL) {
1964 ci->fsm.a_bidl_adis_tmout = 1;
1965 ci_hdrc_otg_fsm_start(ci);
1966 } else if (ci->fsm.otg->state == OTG_STATE_B_PERIPHERAL) {
1967 ci->fsm.protocol = PROTO_UNDEF;
1968 ci->fsm.otg->state = OTG_STATE_UNDEFINED;
1970 mutex_unlock(&ci->fsm.lock);
1974 * ci_udc_stop: unregister a gadget driver
1976 static int ci_udc_stop(struct usb_gadget *gadget)
1978 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1979 unsigned long flags;
1981 spin_lock_irqsave(&ci->lock, flags);
1984 if (ci->vbus_active) {
1985 hw_device_state(ci, 0);
1986 spin_unlock_irqrestore(&ci->lock, flags);
1987 if (ci->platdata->notify_event)
1988 ci->platdata->notify_event(ci,
1989 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1990 _gadget_stop_activity(&ci->gadget);
1991 spin_lock_irqsave(&ci->lock, flags);
1992 pm_runtime_put(ci->dev);
1995 spin_unlock_irqrestore(&ci->lock, flags);
1997 ci_udc_stop_for_otg_fsm(ci);
2001 /******************************************************************************
2003 *****************************************************************************/
2005 * udc_irq: ci interrupt handler
2007 * This function returns IRQ_HANDLED if the IRQ has been handled
2008 * It locks access to registers
2010 static irqreturn_t udc_irq(struct ci_hdrc *ci)
2018 spin_lock(&ci->lock);
2020 if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
2021 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
2023 spin_unlock(&ci->lock);
2027 intr = hw_test_and_clear_intr_active(ci);
2030 /* order defines priority - do NOT change it */
2031 if (USBi_URI & intr)
2032 isr_reset_handler(ci);
2034 if (USBi_PCI & intr) {
2035 ci->gadget.speed = hw_port_is_high_speed(ci) ?
2036 USB_SPEED_HIGH : USB_SPEED_FULL;
2037 if (ci->suspended) {
2038 if (ci->driver->resume) {
2039 spin_unlock(&ci->lock);
2040 ci->driver->resume(&ci->gadget);
2041 spin_lock(&ci->lock);
2044 usb_gadget_set_state(&ci->gadget,
2050 isr_tr_complete_handler(ci);
2052 if ((USBi_SLI & intr) && !(ci->suspended)) {
2054 ci->resume_state = ci->gadget.state;
2055 if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
2056 ci->driver->suspend) {
2057 spin_unlock(&ci->lock);
2058 ci->driver->suspend(&ci->gadget);
2059 spin_lock(&ci->lock);
2061 usb_gadget_set_state(&ci->gadget,
2062 USB_STATE_SUSPENDED);
2064 retval = IRQ_HANDLED;
2068 spin_unlock(&ci->lock);
2074 * udc_start: initialize gadget role
2075 * @ci: chipidea controller
2077 static int udc_start(struct ci_hdrc *ci)
2079 struct device *dev = ci->dev;
2080 struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;
2083 ci->gadget.ops = &usb_gadget_ops;
2084 ci->gadget.speed = USB_SPEED_UNKNOWN;
2085 ci->gadget.max_speed = USB_SPEED_HIGH;
2086 ci->gadget.name = ci->platdata->name;
2087 ci->gadget.otg_caps = otg_caps;
2088 ci->gadget.sg_supported = 1;
2089 ci->gadget.irq = ci->irq;
2091 if (ci->platdata->flags & CI_HDRC_REQUIRES_ALIGNED_DMA)
2092 ci->gadget.quirk_avoids_skb_reserve = 1;
2094 if (ci->is_otg && (otg_caps->hnp_support || otg_caps->srp_support ||
2095 otg_caps->adp_support))
2096 ci->gadget.is_otg = 1;
2098 INIT_LIST_HEAD(&ci->gadget.ep_list);
2100 /* alloc resources */
2101 ci->qh_pool = dma_pool_create("ci_hw_qh", dev->parent,
2102 sizeof(struct ci_hw_qh),
2103 64, CI_HDRC_PAGE_SIZE);
2104 if (ci->qh_pool == NULL)
2107 ci->td_pool = dma_pool_create("ci_hw_td", dev->parent,
2108 sizeof(struct ci_hw_td),
2109 64, CI_HDRC_PAGE_SIZE);
2110 if (ci->td_pool == NULL) {
2115 retval = init_eps(ci);
2119 ci->gadget.ep0 = &ci->ep0in->ep;
2121 retval = usb_add_gadget_udc(dev, &ci->gadget);
2130 dma_pool_destroy(ci->td_pool);
2132 dma_pool_destroy(ci->qh_pool);
2137 * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
2139 * No interrupts active, the IRQ has been released
2141 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
2143 if (!ci->roles[CI_ROLE_GADGET])
2146 usb_del_gadget_udc(&ci->gadget);
2150 dma_pool_destroy(ci->td_pool);
2151 dma_pool_destroy(ci->qh_pool);
2154 static int udc_id_switch_for_device(struct ci_hdrc *ci)
2156 if (ci->platdata->pins_device)
2157 pinctrl_select_state(ci->platdata->pctl,
2158 ci->platdata->pins_device);
2161 /* Clear and enable BSV irq */
2162 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
2163 OTGSC_BSVIS | OTGSC_BSVIE);
2168 static void udc_id_switch_for_host(struct ci_hdrc *ci)
2171 * host doesn't care B_SESSION_VALID event
2172 * so clear and disable BSV irq
2175 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
2177 ci->vbus_active = 0;
2179 if (ci->platdata->pins_device && ci->platdata->pins_default)
2180 pinctrl_select_state(ci->platdata->pctl,
2181 ci->platdata->pins_default);
2185 * ci_hdrc_gadget_init - initialize device related bits
2186 * @ci: the controller
2188 * This function initializes the gadget, if the device is "device capable".
2190 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
2192 struct ci_role_driver *rdrv;
2195 if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
2198 rdrv = devm_kzalloc(ci->dev, sizeof(*rdrv), GFP_KERNEL);
2202 rdrv->start = udc_id_switch_for_device;
2203 rdrv->stop = udc_id_switch_for_host;
2204 rdrv->irq = udc_irq;
2205 rdrv->name = "gadget";
2207 ret = udc_start(ci);
2209 ci->roles[CI_ROLE_GADGET] = rdrv;