2 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 of
11 * the License as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/interrupt.h>
27 #include <linux/list.h>
28 #include <linux/dma-mapping.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
39 * dwc3_gadget_set_test_mode - Enables USB2 Test Modes
40 * @dwc: pointer to our context structure
41 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
43 * Caller should take care of locking. This function will
44 * return 0 on success or -EINVAL if wrong Test Selector
47 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
51 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
52 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
66 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
72 * dwc3_gadget_get_link_state - Gets current state of USB Link
73 * @dwc: pointer to our context structure
75 * Caller should take care of locking. This function will
76 * return the link state on success (>= 0) or -ETIMEDOUT.
78 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
82 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
84 return DWC3_DSTS_USBLNKST(reg);
88 * dwc3_gadget_set_link_state - Sets USB Link to a particular State
89 * @dwc: pointer to our context structure
90 * @state: the state to put link into
92 * Caller should take care of locking. This function will
93 * return 0 on success or -ETIMEDOUT.
95 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
101 * Wait until device controller is ready. Only applies to 1.94a and
104 if (dwc->revision >= DWC3_REVISION_194A) {
106 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
107 if (reg & DWC3_DSTS_DCNRD)
117 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
118 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
120 /* set requested state */
121 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
122 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
125 * The following code is racy when called from dwc3_gadget_wakeup,
126 * and is not needed, at least on newer versions
128 if (dwc->revision >= DWC3_REVISION_194A)
131 /* wait for a change in DSTS */
134 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
136 if (DWC3_DSTS_USBLNKST(reg) == state)
142 dwc3_trace(trace_dwc3_gadget,
143 "link state change request timed out");
149 * dwc3_ep_inc_trb() - Increment a TRB index.
150 * @index - Pointer to the TRB index to increment.
152 * The index should never point to the link TRB. After incrementing,
153 * if it is point to the link TRB, wrap around to the beginning. The
154 * link TRB is always at the last TRB entry.
156 static void dwc3_ep_inc_trb(u8 *index)
159 if (*index == (DWC3_TRB_NUM - 1))
163 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
165 dwc3_ep_inc_trb(&dep->trb_enqueue);
168 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
170 dwc3_ep_inc_trb(&dep->trb_dequeue);
173 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
176 struct dwc3 *dwc = dep->dwc;
182 dwc3_ep_inc_deq(dep);
183 } while(++i < req->request.num_mapped_sgs);
184 req->started = false;
186 list_del(&req->list);
189 if (req->request.status == -EINPROGRESS)
190 req->request.status = status;
192 if (dwc->ep0_bounced && dep->number == 0)
193 dwc->ep0_bounced = false;
195 usb_gadget_unmap_request(&dwc->gadget, &req->request,
198 trace_dwc3_gadget_giveback(req);
200 spin_unlock(&dwc->lock);
201 usb_gadget_giveback_request(&dep->endpoint, &req->request);
202 spin_lock(&dwc->lock);
205 pm_runtime_put(dwc->dev);
208 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
215 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
216 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
219 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
220 if (!(reg & DWC3_DGCMD_CMDACT)) {
221 status = DWC3_DGCMD_STATUS(reg);
233 trace_dwc3_gadget_generic_cmd(cmd, param, status);
238 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
240 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
241 struct dwc3_gadget_ep_cmd_params *params)
243 struct dwc3 *dwc = dep->dwc;
252 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
253 * we're issuing an endpoint command, we must check if
254 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
256 * We will also set SUSPHY bit to what it was before returning as stated
257 * by the same section on Synopsys databook.
259 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
260 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
261 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
263 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
264 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
268 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
271 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
272 dwc->link_state == DWC3_LINK_STATE_U2 ||
273 dwc->link_state == DWC3_LINK_STATE_U3);
275 if (unlikely(needs_wakeup)) {
276 ret = __dwc3_gadget_wakeup(dwc);
277 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
282 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
283 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
284 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
286 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
288 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
289 if (!(reg & DWC3_DEPCMD_CMDACT)) {
290 cmd_status = DWC3_DEPCMD_STATUS(reg);
292 switch (cmd_status) {
296 case DEPEVT_TRANSFER_NO_RESOURCE:
299 case DEPEVT_TRANSFER_BUS_EXPIRY:
301 * SW issues START TRANSFER command to
302 * isochronous ep with future frame interval. If
303 * future interval time has already passed when
304 * core receives the command, it will respond
305 * with an error status of 'Bus Expiry'.
307 * Instead of always returning -EINVAL, let's
308 * give a hint to the gadget driver that this is
309 * the case by returning -EAGAIN.
314 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
323 cmd_status = -ETIMEDOUT;
326 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
328 if (unlikely(susphy)) {
329 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
330 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
331 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
337 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
339 struct dwc3 *dwc = dep->dwc;
340 struct dwc3_gadget_ep_cmd_params params;
341 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
344 * As of core revision 2.60a the recommended programming model
345 * is to set the ClearPendIN bit when issuing a Clear Stall EP
346 * command for IN endpoints. This is to prevent an issue where
347 * some (non-compliant) hosts may not send ACK TPs for pending
348 * IN transfers due to a mishandled error condition. Synopsys
351 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
352 cmd |= DWC3_DEPCMD_CLEARPENDIN;
354 memset(¶ms, 0, sizeof(params));
356 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
359 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
360 struct dwc3_trb *trb)
362 u32 offset = (char *) trb - (char *) dep->trb_pool;
364 return dep->trb_pool_dma + offset;
367 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
369 struct dwc3 *dwc = dep->dwc;
374 dep->trb_pool = dma_alloc_coherent(dwc->dev,
375 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
376 &dep->trb_pool_dma, GFP_KERNEL);
377 if (!dep->trb_pool) {
378 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
386 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
388 struct dwc3 *dwc = dep->dwc;
390 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
391 dep->trb_pool, dep->trb_pool_dma);
393 dep->trb_pool = NULL;
394 dep->trb_pool_dma = 0;
397 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
400 * dwc3_gadget_start_config - Configure EP resources
401 * @dwc: pointer to our controller context structure
402 * @dep: endpoint that is being enabled
404 * The assignment of transfer resources cannot perfectly follow the
405 * data book due to the fact that the controller driver does not have
406 * all knowledge of the configuration in advance. It is given this
407 * information piecemeal by the composite gadget framework after every
408 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
409 * programming model in this scenario can cause errors. For two
412 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
413 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
414 * multiple interfaces.
416 * 2) The databook does not mention doing more DEPXFERCFG for new
417 * endpoint on alt setting (8.1.6).
419 * The following simplified method is used instead:
421 * All hardware endpoints can be assigned a transfer resource and this
422 * setting will stay persistent until either a core reset or
423 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
424 * do DEPXFERCFG for every hardware endpoint as well. We are
425 * guaranteed that there are as many transfer resources as endpoints.
427 * This function is called for each endpoint when it is being enabled
428 * but is triggered only when called for EP0-out, which always happens
429 * first, and which should only happen in one of the above conditions.
431 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
433 struct dwc3_gadget_ep_cmd_params params;
441 memset(¶ms, 0x00, sizeof(params));
442 cmd = DWC3_DEPCMD_DEPSTARTCFG;
444 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
448 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
449 struct dwc3_ep *dep = dwc->eps[i];
454 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
462 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
463 const struct usb_endpoint_descriptor *desc,
464 const struct usb_ss_ep_comp_descriptor *comp_desc,
465 bool ignore, bool restore)
467 struct dwc3_gadget_ep_cmd_params params;
469 memset(¶ms, 0x00, sizeof(params));
471 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
472 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
474 /* Burst size is only needed in SuperSpeed mode */
475 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
476 u32 burst = dep->endpoint.maxburst;
477 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
481 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
484 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
485 params.param2 |= dep->saved_state;
488 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
490 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
491 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
493 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
494 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
495 | DWC3_DEPCFG_STREAM_EVENT_EN;
496 dep->stream_capable = true;
499 if (!usb_endpoint_xfer_control(desc))
500 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
503 * We are doing 1:1 mapping for endpoints, meaning
504 * Physical Endpoints 2 maps to Logical Endpoint 2 and
505 * so on. We consider the direction bit as part of the physical
506 * endpoint number. So USB endpoint 0x81 is 0x03.
508 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
511 * We must use the lower 16 TX FIFOs even though
515 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
517 if (desc->bInterval) {
518 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
519 dep->interval = 1 << (desc->bInterval - 1);
522 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
525 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
527 struct dwc3_gadget_ep_cmd_params params;
529 memset(¶ms, 0x00, sizeof(params));
531 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
533 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
538 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
539 * @dep: endpoint to be initialized
540 * @desc: USB Endpoint Descriptor
542 * Caller should take care of locking
544 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
545 const struct usb_endpoint_descriptor *desc,
546 const struct usb_ss_ep_comp_descriptor *comp_desc,
547 bool ignore, bool restore)
549 struct dwc3 *dwc = dep->dwc;
553 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
555 if (!(dep->flags & DWC3_EP_ENABLED)) {
556 ret = dwc3_gadget_start_config(dwc, dep);
561 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
566 if (!(dep->flags & DWC3_EP_ENABLED)) {
567 struct dwc3_trb *trb_st_hw;
568 struct dwc3_trb *trb_link;
570 dep->endpoint.desc = desc;
571 dep->comp_desc = comp_desc;
572 dep->type = usb_endpoint_type(desc);
573 dep->flags |= DWC3_EP_ENABLED;
575 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
576 reg |= DWC3_DALEPENA_EP(dep->number);
577 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
579 if (usb_endpoint_xfer_control(desc))
582 /* Initialize the TRB ring */
583 dep->trb_dequeue = 0;
584 dep->trb_enqueue = 0;
585 memset(dep->trb_pool, 0,
586 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
588 /* Link TRB. The HWO bit is never reset */
589 trb_st_hw = &dep->trb_pool[0];
591 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
592 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
593 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
594 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
595 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
601 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
602 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
604 struct dwc3_request *req;
605 struct dwc3_trb *current_trb;
606 unsigned transfer_in_flight;
609 current_trb = &dep->trb_pool[dep->trb_enqueue];
611 current_trb = &dwc->ep0_trb[dep->trb_enqueue];
612 transfer_in_flight = current_trb->ctrl & DWC3_TRB_CTRL_HWO;
614 if (transfer_in_flight && !list_empty(&dep->started_list)) {
615 dwc3_stop_active_transfer(dwc, dep->number, true);
617 /* - giveback all requests to gadget driver */
618 while (!list_empty(&dep->started_list)) {
619 req = next_request(&dep->started_list);
621 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
625 while (!list_empty(&dep->pending_list)) {
626 req = next_request(&dep->pending_list);
628 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
633 * __dwc3_gadget_ep_disable - Disables a HW endpoint
634 * @dep: the endpoint to disable
636 * This function also removes requests which are currently processed ny the
637 * hardware and those which are not yet scheduled.
638 * Caller should take care of locking.
640 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
642 struct dwc3 *dwc = dep->dwc;
645 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
647 dwc3_remove_requests(dwc, dep);
649 /* make sure HW endpoint isn't stalled */
650 if (dep->flags & DWC3_EP_STALL)
651 __dwc3_gadget_ep_set_halt(dep, 0, false);
653 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
654 reg &= ~DWC3_DALEPENA_EP(dep->number);
655 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
657 dep->stream_capable = false;
658 dep->endpoint.desc = NULL;
659 dep->comp_desc = NULL;
666 /* -------------------------------------------------------------------------- */
668 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
669 const struct usb_endpoint_descriptor *desc)
674 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
679 /* -------------------------------------------------------------------------- */
681 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
682 const struct usb_endpoint_descriptor *desc)
689 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
690 pr_debug("dwc3: invalid parameters\n");
694 if (!desc->wMaxPacketSize) {
695 pr_debug("dwc3: missing wMaxPacketSize\n");
699 dep = to_dwc3_ep(ep);
702 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
703 "%s is already enabled\n",
707 spin_lock_irqsave(&dwc->lock, flags);
708 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
709 spin_unlock_irqrestore(&dwc->lock, flags);
714 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
722 pr_debug("dwc3: invalid parameters\n");
726 dep = to_dwc3_ep(ep);
729 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
730 "%s is already disabled\n",
734 spin_lock_irqsave(&dwc->lock, flags);
735 ret = __dwc3_gadget_ep_disable(dep);
736 spin_unlock_irqrestore(&dwc->lock, flags);
741 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
744 struct dwc3_request *req;
745 struct dwc3_ep *dep = to_dwc3_ep(ep);
747 req = kzalloc(sizeof(*req), gfp_flags);
751 req->epnum = dep->number;
754 dep->allocated_requests++;
756 trace_dwc3_alloc_request(req);
758 return &req->request;
761 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
762 struct usb_request *request)
764 struct dwc3_request *req = to_dwc3_request(request);
765 struct dwc3_ep *dep = to_dwc3_ep(ep);
767 dep->allocated_requests--;
768 trace_dwc3_free_request(req);
773 * dwc3_prepare_one_trb - setup one TRB from one request
774 * @dep: endpoint for which this request is prepared
775 * @req: dwc3_request pointer
777 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
778 struct dwc3_request *req, dma_addr_t dma,
779 unsigned length, unsigned last, unsigned chain, unsigned node)
781 struct dwc3_trb *trb;
783 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
784 dep->name, req, (unsigned long long) dma,
785 length, last ? " last" : "",
786 chain ? " chain" : "");
789 trb = &dep->trb_pool[dep->trb_enqueue];
792 dwc3_gadget_move_started_request(req);
794 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
795 req->first_trb_index = dep->trb_enqueue;
798 dwc3_ep_inc_enq(dep);
800 trb->size = DWC3_TRB_SIZE_LENGTH(length);
801 trb->bpl = lower_32_bits(dma);
802 trb->bph = upper_32_bits(dma);
804 switch (usb_endpoint_type(dep->endpoint.desc)) {
805 case USB_ENDPOINT_XFER_CONTROL:
806 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
809 case USB_ENDPOINT_XFER_ISOC:
811 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
813 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
815 /* always enable Interrupt on Missed ISOC */
816 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
819 case USB_ENDPOINT_XFER_BULK:
820 case USB_ENDPOINT_XFER_INT:
821 trb->ctrl = DWC3_TRBCTL_NORMAL;
825 * This is only possible with faulty memory because we
826 * checked it already :)
831 /* always enable Continue on Short Packet */
832 trb->ctrl |= DWC3_TRB_CTRL_CSP;
834 if (!req->request.no_interrupt && !chain)
835 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
838 trb->ctrl |= DWC3_TRB_CTRL_LST;
841 trb->ctrl |= DWC3_TRB_CTRL_CHN;
843 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
844 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
846 trb->ctrl |= DWC3_TRB_CTRL_HWO;
848 dep->queued_requests++;
850 trace_dwc3_prepare_trb(dep, trb);
854 * dwc3_ep_prev_trb() - Returns the previous TRB in the ring
855 * @dep: The endpoint with the TRB ring
856 * @index: The index of the current TRB in the ring
858 * Returns the TRB prior to the one pointed to by the index. If the
859 * index is 0, we will wrap backwards, skip the link TRB, and return
860 * the one just before that.
862 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
865 index = DWC3_TRB_NUM - 2;
867 index = dep->trb_enqueue - 1;
869 return &dep->trb_pool[index];
872 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
874 struct dwc3_trb *tmp;
878 * If enqueue & dequeue are equal than it is either full or empty.
880 * One way to know for sure is if the TRB right before us has HWO bit
881 * set or not. If it has, then we're definitely full and can't fit any
882 * more transfers in our ring.
884 if (dep->trb_enqueue == dep->trb_dequeue) {
885 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
886 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
889 return DWC3_TRB_NUM - 1;
892 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
893 trbs_left &= (DWC3_TRB_NUM - 1);
895 if (dep->trb_dequeue < dep->trb_enqueue)
901 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
902 struct dwc3_request *req, unsigned int trbs_left,
903 unsigned int more_coming)
905 struct usb_request *request = &req->request;
906 struct scatterlist *sg = request->sg;
907 struct scatterlist *s;
908 unsigned int last = false;
913 for_each_sg(sg, s, request->num_mapped_sgs, i) {
914 unsigned chain = true;
916 length = sg_dma_len(s);
917 dma = sg_dma_address(s);
920 if (usb_endpoint_xfer_int(dep->endpoint.desc) ||
933 dwc3_prepare_one_trb(dep, req, dma, length,
941 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
942 struct dwc3_request *req, unsigned int trbs_left,
943 unsigned int more_coming)
945 unsigned int last = false;
949 dma = req->request.dma;
950 length = req->request.length;
955 /* Is this the last request? */
956 if (usb_endpoint_xfer_int(dep->endpoint.desc) || !more_coming)
959 dwc3_prepare_one_trb(dep, req, dma, length,
964 * dwc3_prepare_trbs - setup TRBs from requests
965 * @dep: endpoint for which requests are being prepared
967 * The function goes through the requests list and sets up TRBs for the
968 * transfers. The function returns once there are no more TRBs available or
969 * it runs out of requests.
971 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
973 struct dwc3_request *req, *n;
974 unsigned int more_coming;
977 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
979 trbs_left = dwc3_calc_trbs_left(dep);
983 more_coming = dep->allocated_requests - dep->queued_requests;
985 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
986 if (req->request.num_mapped_sgs > 0)
987 dwc3_prepare_one_trb_sg(dep, req, trbs_left--,
990 dwc3_prepare_one_trb_linear(dep, req, trbs_left--,
998 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
1000 struct dwc3_gadget_ep_cmd_params params;
1001 struct dwc3_request *req;
1002 struct dwc3 *dwc = dep->dwc;
1007 starting = !(dep->flags & DWC3_EP_BUSY);
1009 dwc3_prepare_trbs(dep);
1010 req = next_request(&dep->started_list);
1012 dep->flags |= DWC3_EP_PENDING_REQUEST;
1016 memset(¶ms, 0, sizeof(params));
1019 params.param0 = upper_32_bits(req->trb_dma);
1020 params.param1 = lower_32_bits(req->trb_dma);
1021 cmd = DWC3_DEPCMD_STARTTRANSFER |
1022 DWC3_DEPCMD_PARAM(cmd_param);
1024 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1025 DWC3_DEPCMD_PARAM(dep->resource_index);
1028 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1031 * FIXME we need to iterate over the list of requests
1032 * here and stop, unmap, free and del each of the linked
1033 * requests instead of what we do now.
1035 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1037 list_del(&req->list);
1041 dep->flags |= DWC3_EP_BUSY;
1044 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1045 WARN_ON_ONCE(!dep->resource_index);
1051 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1052 struct dwc3_ep *dep, u32 cur_uf)
1056 if (list_empty(&dep->pending_list)) {
1057 dwc3_trace(trace_dwc3_gadget,
1058 "ISOC ep %s run out for requests",
1060 dep->flags |= DWC3_EP_PENDING_REQUEST;
1064 /* 4 micro frames in the future */
1065 uf = cur_uf + dep->interval * 4;
1067 __dwc3_gadget_kick_transfer(dep, uf);
1070 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1071 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1075 mask = ~(dep->interval - 1);
1076 cur_uf = event->parameters & mask;
1078 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1081 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1083 struct dwc3 *dwc = dep->dwc;
1086 if (!dep->endpoint.desc) {
1087 dwc3_trace(trace_dwc3_gadget,
1088 "trying to queue request %p to disabled %s",
1089 &req->request, dep->endpoint.name);
1093 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1094 &req->request, req->dep->name)) {
1095 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'",
1096 &req->request, req->dep->name);
1100 pm_runtime_get(dwc->dev);
1102 req->request.actual = 0;
1103 req->request.status = -EINPROGRESS;
1104 req->direction = dep->direction;
1105 req->epnum = dep->number;
1107 trace_dwc3_ep_queue(req);
1110 * We only add to our list of requests now and
1111 * start consuming the list once we get XferNotReady
1114 * That way, we avoid doing anything that we don't need
1115 * to do now and defer it until the point we receive a
1116 * particular token from the Host side.
1118 * This will also avoid Host cancelling URBs due to too
1121 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1126 list_add_tail(&req->list, &dep->pending_list);
1129 * If there are no pending requests and the endpoint isn't already
1130 * busy, we will just start the request straight away.
1132 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1133 * little bit faster.
1135 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1136 !usb_endpoint_xfer_int(dep->endpoint.desc)) {
1137 ret = __dwc3_gadget_kick_transfer(dep, 0);
1142 * There are a few special cases:
1144 * 1. XferNotReady with empty list of requests. We need to kick the
1145 * transfer here in that situation, otherwise we will be NAKing
1146 * forever. If we get XferNotReady before gadget driver has a
1147 * chance to queue a request, we will ACK the IRQ but won't be
1148 * able to receive the data until the next request is queued.
1149 * The following code is handling exactly that.
1152 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1154 * If xfernotready is already elapsed and it is a case
1155 * of isoc transfer, then issue END TRANSFER, so that
1156 * you can receive xfernotready again and can have
1157 * notion of current microframe.
1159 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1160 if (list_empty(&dep->started_list)) {
1161 dwc3_stop_active_transfer(dwc, dep->number, true);
1162 dep->flags = DWC3_EP_ENABLED;
1167 ret = __dwc3_gadget_kick_transfer(dep, 0);
1169 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1175 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1176 * kick the transfer here after queuing a request, otherwise the
1177 * core may not see the modified TRB(s).
1179 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1180 (dep->flags & DWC3_EP_BUSY) &&
1181 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1182 WARN_ON_ONCE(!dep->resource_index);
1183 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index);
1188 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1189 * right away, otherwise host will not know we have streams to be
1192 if (dep->stream_capable)
1193 ret = __dwc3_gadget_kick_transfer(dep, 0);
1196 if (ret && ret != -EBUSY)
1197 dwc3_trace(trace_dwc3_gadget,
1198 "%s: failed to kick transfers",
1206 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1207 struct usb_request *request)
1209 dwc3_gadget_ep_free_request(ep, request);
1212 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1214 struct dwc3_request *req;
1215 struct usb_request *request;
1216 struct usb_ep *ep = &dep->endpoint;
1218 dwc3_trace(trace_dwc3_gadget, "queueing ZLP");
1219 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1223 request->length = 0;
1224 request->buf = dwc->zlp_buf;
1225 request->complete = __dwc3_gadget_ep_zlp_complete;
1227 req = to_dwc3_request(request);
1229 return __dwc3_gadget_ep_queue(dep, req);
1232 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1235 struct dwc3_request *req = to_dwc3_request(request);
1236 struct dwc3_ep *dep = to_dwc3_ep(ep);
1237 struct dwc3 *dwc = dep->dwc;
1239 unsigned long flags;
1243 spin_lock_irqsave(&dwc->lock, flags);
1244 ret = __dwc3_gadget_ep_queue(dep, req);
1247 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1248 * setting request->zero, instead of doing magic, we will just queue an
1249 * extra usb_request ourselves so that it gets handled the same way as
1250 * any other request.
1252 if (ret == 0 && request->zero && request->length &&
1253 (request->length % ep->maxpacket == 0))
1254 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1256 spin_unlock_irqrestore(&dwc->lock, flags);
1261 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1262 struct usb_request *request)
1264 struct dwc3_request *req = to_dwc3_request(request);
1265 struct dwc3_request *r = NULL;
1267 struct dwc3_ep *dep = to_dwc3_ep(ep);
1268 struct dwc3 *dwc = dep->dwc;
1270 unsigned long flags;
1273 trace_dwc3_ep_dequeue(req);
1275 spin_lock_irqsave(&dwc->lock, flags);
1277 list_for_each_entry(r, &dep->pending_list, list) {
1283 list_for_each_entry(r, &dep->started_list, list) {
1288 /* wait until it is processed */
1289 dwc3_stop_active_transfer(dwc, dep->number, true);
1292 dev_err(dwc->dev, "request %p was not queued to %s\n",
1299 /* giveback the request */
1300 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1303 spin_unlock_irqrestore(&dwc->lock, flags);
1308 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1310 struct dwc3_gadget_ep_cmd_params params;
1311 struct dwc3 *dwc = dep->dwc;
1314 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1315 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1319 memset(¶ms, 0x00, sizeof(params));
1322 struct dwc3_trb *trb;
1324 unsigned transfer_in_flight;
1327 if (dep->number > 1)
1328 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1330 trb = &dwc->ep0_trb[dep->trb_enqueue];
1332 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1333 started = !list_empty(&dep->started_list);
1335 if (!protocol && ((dep->direction && transfer_in_flight) ||
1336 (!dep->direction && started))) {
1337 dwc3_trace(trace_dwc3_gadget,
1338 "%s: pending request, cannot halt",
1343 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1346 dev_err(dwc->dev, "failed to set STALL on %s\n",
1349 dep->flags |= DWC3_EP_STALL;
1352 ret = dwc3_send_clear_stall_ep_cmd(dep);
1354 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1357 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1363 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1365 struct dwc3_ep *dep = to_dwc3_ep(ep);
1366 struct dwc3 *dwc = dep->dwc;
1368 unsigned long flags;
1372 spin_lock_irqsave(&dwc->lock, flags);
1373 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1374 spin_unlock_irqrestore(&dwc->lock, flags);
1379 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1381 struct dwc3_ep *dep = to_dwc3_ep(ep);
1382 struct dwc3 *dwc = dep->dwc;
1383 unsigned long flags;
1386 spin_lock_irqsave(&dwc->lock, flags);
1387 dep->flags |= DWC3_EP_WEDGE;
1389 if (dep->number == 0 || dep->number == 1)
1390 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1392 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1393 spin_unlock_irqrestore(&dwc->lock, flags);
1398 /* -------------------------------------------------------------------------- */
1400 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1401 .bLength = USB_DT_ENDPOINT_SIZE,
1402 .bDescriptorType = USB_DT_ENDPOINT,
1403 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1406 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1407 .enable = dwc3_gadget_ep0_enable,
1408 .disable = dwc3_gadget_ep0_disable,
1409 .alloc_request = dwc3_gadget_ep_alloc_request,
1410 .free_request = dwc3_gadget_ep_free_request,
1411 .queue = dwc3_gadget_ep0_queue,
1412 .dequeue = dwc3_gadget_ep_dequeue,
1413 .set_halt = dwc3_gadget_ep0_set_halt,
1414 .set_wedge = dwc3_gadget_ep_set_wedge,
1417 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1418 .enable = dwc3_gadget_ep_enable,
1419 .disable = dwc3_gadget_ep_disable,
1420 .alloc_request = dwc3_gadget_ep_alloc_request,
1421 .free_request = dwc3_gadget_ep_free_request,
1422 .queue = dwc3_gadget_ep_queue,
1423 .dequeue = dwc3_gadget_ep_dequeue,
1424 .set_halt = dwc3_gadget_ep_set_halt,
1425 .set_wedge = dwc3_gadget_ep_set_wedge,
1428 /* -------------------------------------------------------------------------- */
1430 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1432 struct dwc3 *dwc = gadget_to_dwc(g);
1435 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1436 return DWC3_DSTS_SOFFN(reg);
1439 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1441 unsigned long timeout;
1450 * According to the Databook Remote wakeup request should
1451 * be issued only when the device is in early suspend state.
1453 * We can check that via USB Link State bits in DSTS register.
1455 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1457 speed = reg & DWC3_DSTS_CONNECTSPD;
1458 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1459 (speed == DWC3_DSTS_SUPERSPEED_PLUS)) {
1460 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed");
1464 link_state = DWC3_DSTS_USBLNKST(reg);
1466 switch (link_state) {
1467 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1468 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1471 dwc3_trace(trace_dwc3_gadget,
1472 "can't wakeup from '%s'",
1473 dwc3_gadget_link_string(link_state));
1477 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1479 dev_err(dwc->dev, "failed to put link in Recovery\n");
1483 /* Recent versions do this automatically */
1484 if (dwc->revision < DWC3_REVISION_194A) {
1485 /* write zeroes to Link Change Request */
1486 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1487 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1488 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1491 /* poll until Link State changes to ON */
1492 timeout = jiffies + msecs_to_jiffies(100);
1494 while (!time_after(jiffies, timeout)) {
1495 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1497 /* in HS, means ON */
1498 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1502 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1503 dev_err(dwc->dev, "failed to send remote wakeup\n");
1510 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1512 struct dwc3 *dwc = gadget_to_dwc(g);
1513 unsigned long flags;
1516 spin_lock_irqsave(&dwc->lock, flags);
1517 ret = __dwc3_gadget_wakeup(dwc);
1518 spin_unlock_irqrestore(&dwc->lock, flags);
1523 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1526 struct dwc3 *dwc = gadget_to_dwc(g);
1527 unsigned long flags;
1529 spin_lock_irqsave(&dwc->lock, flags);
1530 g->is_selfpowered = !!is_selfpowered;
1531 spin_unlock_irqrestore(&dwc->lock, flags);
1536 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1541 if (pm_runtime_suspended(dwc->dev))
1544 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1546 if (dwc->revision <= DWC3_REVISION_187A) {
1547 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1548 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1551 if (dwc->revision >= DWC3_REVISION_194A)
1552 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1553 reg |= DWC3_DCTL_RUN_STOP;
1555 if (dwc->has_hibernation)
1556 reg |= DWC3_DCTL_KEEP_CONNECT;
1558 dwc->pullups_connected = true;
1560 reg &= ~DWC3_DCTL_RUN_STOP;
1562 if (dwc->has_hibernation && !suspend)
1563 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1565 dwc->pullups_connected = false;
1568 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1571 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1573 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1576 if (reg & DWC3_DSTS_DEVCTRLHLT)
1585 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1587 ? dwc->gadget_driver->function : "no-function",
1588 is_on ? "connect" : "disconnect");
1593 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1595 struct dwc3 *dwc = gadget_to_dwc(g);
1596 unsigned long flags;
1601 spin_lock_irqsave(&dwc->lock, flags);
1602 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1603 spin_unlock_irqrestore(&dwc->lock, flags);
1608 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1612 /* Enable all but Start and End of Frame IRQs */
1613 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1614 DWC3_DEVTEN_EVNTOVERFLOWEN |
1615 DWC3_DEVTEN_CMDCMPLTEN |
1616 DWC3_DEVTEN_ERRTICERREN |
1617 DWC3_DEVTEN_WKUPEVTEN |
1618 DWC3_DEVTEN_ULSTCNGEN |
1619 DWC3_DEVTEN_CONNECTDONEEN |
1620 DWC3_DEVTEN_USBRSTEN |
1621 DWC3_DEVTEN_DISCONNEVTEN);
1623 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1626 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1628 /* mask all interrupts */
1629 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1632 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1633 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1636 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1637 * dwc: pointer to our context structure
1639 * The following looks like complex but it's actually very simple. In order to
1640 * calculate the number of packets we can burst at once on OUT transfers, we're
1641 * gonna use RxFIFO size.
1643 * To calculate RxFIFO size we need two numbers:
1644 * MDWIDTH = size, in bits, of the internal memory bus
1645 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1647 * Given these two numbers, the formula is simple:
1649 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1651 * 24 bytes is for 3x SETUP packets
1652 * 16 bytes is a clock domain crossing tolerance
1654 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1656 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1663 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1664 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1666 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1667 nump = min_t(u32, nump, 16);
1670 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1671 reg &= ~DWC3_DCFG_NUMP_MASK;
1672 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1673 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1676 static int __dwc3_gadget_start(struct dwc3 *dwc)
1678 struct dwc3_ep *dep;
1682 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1683 reg &= ~(DWC3_DCFG_SPEED_MASK);
1686 * WORKAROUND: DWC3 revision < 2.20a have an issue
1687 * which would cause metastability state on Run/Stop
1688 * bit if we try to force the IP to USB2-only mode.
1690 * Because of that, we cannot configure the IP to any
1691 * speed other than the SuperSpeed
1695 * STAR#9000525659: Clock Domain Crossing on DCTL in
1698 if (dwc->revision < DWC3_REVISION_220A) {
1699 reg |= DWC3_DCFG_SUPERSPEED;
1701 switch (dwc->maximum_speed) {
1703 reg |= DWC3_DCFG_LOWSPEED;
1705 case USB_SPEED_FULL:
1706 reg |= DWC3_DCFG_FULLSPEED1;
1708 case USB_SPEED_HIGH:
1709 reg |= DWC3_DCFG_HIGHSPEED;
1711 case USB_SPEED_SUPER_PLUS:
1712 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
1715 dev_err(dwc->dev, "invalid dwc->maximum_speed (%d)\n",
1716 dwc->maximum_speed);
1718 case USB_SPEED_SUPER:
1719 reg |= DWC3_DCFG_SUPERSPEED;
1723 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1726 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1727 * field instead of letting dwc3 itself calculate that automatically.
1729 * This way, we maximize the chances that we'll be able to get several
1730 * bursts of data without going through any sort of endpoint throttling.
1732 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1733 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1734 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1736 dwc3_gadget_setup_nump(dwc);
1738 /* Start with SuperSpeed Default */
1739 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1742 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1745 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1750 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1753 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1757 /* begin to receive SETUP packets */
1758 dwc->ep0state = EP0_SETUP_PHASE;
1759 dwc3_ep0_out_start(dwc);
1761 dwc3_gadget_enable_irq(dwc);
1766 __dwc3_gadget_ep_disable(dwc->eps[0]);
1772 static int dwc3_gadget_start(struct usb_gadget *g,
1773 struct usb_gadget_driver *driver)
1775 struct dwc3 *dwc = gadget_to_dwc(g);
1776 unsigned long flags;
1780 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1781 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1782 IRQF_SHARED, "dwc3", dwc->ev_buf);
1784 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1788 dwc->irq_gadget = irq;
1790 spin_lock_irqsave(&dwc->lock, flags);
1791 if (dwc->gadget_driver) {
1792 dev_err(dwc->dev, "%s is already bound to %s\n",
1794 dwc->gadget_driver->driver.name);
1799 dwc->gadget_driver = driver;
1801 if (pm_runtime_active(dwc->dev))
1802 __dwc3_gadget_start(dwc);
1804 spin_unlock_irqrestore(&dwc->lock, flags);
1809 spin_unlock_irqrestore(&dwc->lock, flags);
1816 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1818 dwc3_gadget_disable_irq(dwc);
1819 __dwc3_gadget_ep_disable(dwc->eps[0]);
1820 __dwc3_gadget_ep_disable(dwc->eps[1]);
1823 static int dwc3_gadget_stop(struct usb_gadget *g)
1825 struct dwc3 *dwc = gadget_to_dwc(g);
1826 unsigned long flags;
1828 spin_lock_irqsave(&dwc->lock, flags);
1829 __dwc3_gadget_stop(dwc);
1830 dwc->gadget_driver = NULL;
1831 spin_unlock_irqrestore(&dwc->lock, flags);
1833 free_irq(dwc->irq_gadget, dwc->ev_buf);
1838 static const struct usb_gadget_ops dwc3_gadget_ops = {
1839 .get_frame = dwc3_gadget_get_frame,
1840 .wakeup = dwc3_gadget_wakeup,
1841 .set_selfpowered = dwc3_gadget_set_selfpowered,
1842 .pullup = dwc3_gadget_pullup,
1843 .udc_start = dwc3_gadget_start,
1844 .udc_stop = dwc3_gadget_stop,
1847 /* -------------------------------------------------------------------------- */
1849 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1850 u8 num, u32 direction)
1852 struct dwc3_ep *dep;
1855 for (i = 0; i < num; i++) {
1856 u8 epnum = (i << 1) | (direction ? 1 : 0);
1858 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1863 dep->number = epnum;
1864 dep->direction = !!direction;
1865 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1866 dwc->eps[epnum] = dep;
1868 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1869 (epnum & 1) ? "in" : "out");
1871 dep->endpoint.name = dep->name;
1872 spin_lock_init(&dep->lock);
1874 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1876 if (epnum == 0 || epnum == 1) {
1877 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1878 dep->endpoint.maxburst = 1;
1879 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1881 dwc->gadget.ep0 = &dep->endpoint;
1885 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1886 dep->endpoint.max_streams = 15;
1887 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1888 list_add_tail(&dep->endpoint.ep_list,
1889 &dwc->gadget.ep_list);
1891 ret = dwc3_alloc_trb_pool(dep);
1896 if (epnum == 0 || epnum == 1) {
1897 dep->endpoint.caps.type_control = true;
1899 dep->endpoint.caps.type_iso = true;
1900 dep->endpoint.caps.type_bulk = true;
1901 dep->endpoint.caps.type_int = true;
1904 dep->endpoint.caps.dir_in = !!direction;
1905 dep->endpoint.caps.dir_out = !direction;
1907 INIT_LIST_HEAD(&dep->pending_list);
1908 INIT_LIST_HEAD(&dep->started_list);
1914 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1918 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1920 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1922 dwc3_trace(trace_dwc3_gadget,
1923 "failed to allocate OUT endpoints");
1927 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1929 dwc3_trace(trace_dwc3_gadget,
1930 "failed to allocate IN endpoints");
1937 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1939 struct dwc3_ep *dep;
1942 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1943 dep = dwc->eps[epnum];
1947 * Physical endpoints 0 and 1 are special; they form the
1948 * bi-directional USB endpoint 0.
1950 * For those two physical endpoints, we don't allocate a TRB
1951 * pool nor do we add them the endpoints list. Due to that, we
1952 * shouldn't do these two operations otherwise we would end up
1953 * with all sorts of bugs when removing dwc3.ko.
1955 if (epnum != 0 && epnum != 1) {
1956 dwc3_free_trb_pool(dep);
1957 list_del(&dep->endpoint.ep_list);
1964 /* -------------------------------------------------------------------------- */
1966 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1967 struct dwc3_request *req, struct dwc3_trb *trb,
1968 const struct dwc3_event_depevt *event, int status)
1971 unsigned int s_pkt = 0;
1972 unsigned int trb_status;
1974 dep->queued_requests--;
1975 trace_dwc3_complete_trb(dep, trb);
1977 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1979 * We continue despite the error. There is not much we
1980 * can do. If we don't clean it up we loop forever. If
1981 * we skip the TRB then it gets overwritten after a
1982 * while since we use them in a ring buffer. A BUG()
1983 * would help. Lets hope that if this occurs, someone
1984 * fixes the root cause instead of looking away :)
1986 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1988 count = trb->size & DWC3_TRB_SIZE_MASK;
1990 if (dep->direction) {
1992 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1993 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1994 dwc3_trace(trace_dwc3_gadget,
1995 "%s: incomplete IN transfer",
1998 * If missed isoc occurred and there is
1999 * no request queued then issue END
2000 * TRANSFER, so that core generates
2001 * next xfernotready and we will issue
2002 * a fresh START TRANSFER.
2003 * If there are still queued request
2004 * then wait, do not issue either END
2005 * or UPDATE TRANSFER, just attach next
2006 * request in pending_list during
2007 * giveback.If any future queued request
2008 * is successfully transferred then we
2009 * will issue UPDATE TRANSFER for all
2010 * request in the pending_list.
2012 dep->flags |= DWC3_EP_MISSED_ISOC;
2014 dev_err(dwc->dev, "incomplete IN transfer %s\n",
2016 status = -ECONNRESET;
2019 dep->flags &= ~DWC3_EP_MISSED_ISOC;
2022 if (count && (event->status & DEPEVT_STATUS_SHORT))
2027 * We assume here we will always receive the entire data block
2028 * which we should receive. Meaning, if we program RX to
2029 * receive 4K but we receive only 2K, we assume that's all we
2030 * should receive and we simply bounce the request back to the
2031 * gadget driver for further processing.
2033 req->request.actual += req->request.length - count;
2036 if ((event->status & DEPEVT_STATUS_LST) &&
2037 (trb->ctrl & (DWC3_TRB_CTRL_LST |
2038 DWC3_TRB_CTRL_HWO)))
2040 if ((event->status & DEPEVT_STATUS_IOC) &&
2041 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2046 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
2047 const struct dwc3_event_depevt *event, int status)
2049 struct dwc3_request *req;
2050 struct dwc3_trb *trb;
2056 req = next_request(&dep->started_list);
2057 if (WARN_ON_ONCE(!req))
2062 slot = req->first_trb_index + i;
2063 if (slot == DWC3_TRB_NUM - 1)
2065 slot %= DWC3_TRB_NUM;
2066 trb = &dep->trb_pool[slot];
2068 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2072 } while (++i < req->request.num_mapped_sgs);
2074 dwc3_gadget_giveback(dep, req, status);
2081 * Our endpoint might get disabled by another thread during
2082 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2083 * early on so DWC3_EP_BUSY flag gets cleared
2085 if (!dep->endpoint.desc)
2088 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2089 list_empty(&dep->started_list)) {
2090 if (list_empty(&dep->pending_list)) {
2092 * If there is no entry in request list then do
2093 * not issue END TRANSFER now. Just set PENDING
2094 * flag, so that END TRANSFER is issued when an
2095 * entry is added into request list.
2097 dep->flags = DWC3_EP_PENDING_REQUEST;
2099 dwc3_stop_active_transfer(dwc, dep->number, true);
2100 dep->flags = DWC3_EP_ENABLED;
2105 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
2106 if ((event->status & DEPEVT_STATUS_IOC) &&
2107 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2112 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2113 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2115 unsigned status = 0;
2117 u32 is_xfer_complete;
2119 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2121 if (event->status & DEPEVT_STATUS_BUSERR)
2122 status = -ECONNRESET;
2124 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2125 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2126 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2127 dep->flags &= ~DWC3_EP_BUSY;
2130 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2131 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2133 if (dwc->revision < DWC3_REVISION_183A) {
2137 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2140 if (!(dep->flags & DWC3_EP_ENABLED))
2143 if (!list_empty(&dep->started_list))
2147 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2149 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2155 * Our endpoint might get disabled by another thread during
2156 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2157 * early on so DWC3_EP_BUSY flag gets cleared
2159 if (!dep->endpoint.desc)
2162 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2165 ret = __dwc3_gadget_kick_transfer(dep, 0);
2166 if (!ret || ret == -EBUSY)
2171 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2172 const struct dwc3_event_depevt *event)
2174 struct dwc3_ep *dep;
2175 u8 epnum = event->endpoint_number;
2177 dep = dwc->eps[epnum];
2179 if (!(dep->flags & DWC3_EP_ENABLED))
2182 if (epnum == 0 || epnum == 1) {
2183 dwc3_ep0_interrupt(dwc, event);
2187 switch (event->endpoint_event) {
2188 case DWC3_DEPEVT_XFERCOMPLETE:
2189 dep->resource_index = 0;
2191 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2192 dwc3_trace(trace_dwc3_gadget,
2193 "%s is an Isochronous endpoint",
2198 dwc3_endpoint_transfer_complete(dwc, dep, event);
2200 case DWC3_DEPEVT_XFERINPROGRESS:
2201 dwc3_endpoint_transfer_complete(dwc, dep, event);
2203 case DWC3_DEPEVT_XFERNOTREADY:
2204 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2205 dwc3_gadget_start_isoc(dwc, dep, event);
2210 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2212 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2213 dep->name, active ? "Transfer Active"
2214 : "Transfer Not Active");
2216 ret = __dwc3_gadget_kick_transfer(dep, 0);
2217 if (!ret || ret == -EBUSY)
2220 dwc3_trace(trace_dwc3_gadget,
2221 "%s: failed to kick transfers",
2226 case DWC3_DEPEVT_STREAMEVT:
2227 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2228 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2233 switch (event->status) {
2234 case DEPEVT_STREAMEVT_FOUND:
2235 dwc3_trace(trace_dwc3_gadget,
2236 "Stream %d found and started",
2240 case DEPEVT_STREAMEVT_NOTFOUND:
2243 dwc3_trace(trace_dwc3_gadget,
2244 "unable to find suitable stream");
2247 case DWC3_DEPEVT_RXTXFIFOEVT:
2248 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun", dep->name);
2250 case DWC3_DEPEVT_EPCMDCMPLT:
2251 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2256 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2258 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2259 spin_unlock(&dwc->lock);
2260 dwc->gadget_driver->disconnect(&dwc->gadget);
2261 spin_lock(&dwc->lock);
2265 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2267 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2268 spin_unlock(&dwc->lock);
2269 dwc->gadget_driver->suspend(&dwc->gadget);
2270 spin_lock(&dwc->lock);
2274 static void dwc3_resume_gadget(struct dwc3 *dwc)
2276 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2277 spin_unlock(&dwc->lock);
2278 dwc->gadget_driver->resume(&dwc->gadget);
2279 spin_lock(&dwc->lock);
2283 static void dwc3_reset_gadget(struct dwc3 *dwc)
2285 if (!dwc->gadget_driver)
2288 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2289 spin_unlock(&dwc->lock);
2290 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2291 spin_lock(&dwc->lock);
2295 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2297 struct dwc3_ep *dep;
2298 struct dwc3_gadget_ep_cmd_params params;
2302 dep = dwc->eps[epnum];
2304 if (!dep->resource_index)
2308 * NOTICE: We are violating what the Databook says about the
2309 * EndTransfer command. Ideally we would _always_ wait for the
2310 * EndTransfer Command Completion IRQ, but that's causing too
2311 * much trouble synchronizing between us and gadget driver.
2313 * We have discussed this with the IP Provider and it was
2314 * suggested to giveback all requests here, but give HW some
2315 * extra time to synchronize with the interconnect. We're using
2316 * an arbitrary 100us delay for that.
2318 * Note also that a similar handling was tested by Synopsys
2319 * (thanks a lot Paul) and nothing bad has come out of it.
2320 * In short, what we're doing is:
2322 * - Issue EndTransfer WITH CMDIOC bit set
2326 cmd = DWC3_DEPCMD_ENDTRANSFER;
2327 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2328 cmd |= DWC3_DEPCMD_CMDIOC;
2329 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2330 memset(¶ms, 0, sizeof(params));
2331 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2333 dep->resource_index = 0;
2334 dep->flags &= ~DWC3_EP_BUSY;
2338 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2342 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2343 struct dwc3_ep *dep;
2345 dep = dwc->eps[epnum];
2349 if (!(dep->flags & DWC3_EP_ENABLED))
2352 dwc3_remove_requests(dwc, dep);
2356 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2360 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2361 struct dwc3_ep *dep;
2364 dep = dwc->eps[epnum];
2368 if (!(dep->flags & DWC3_EP_STALL))
2371 dep->flags &= ~DWC3_EP_STALL;
2373 ret = dwc3_send_clear_stall_ep_cmd(dep);
2378 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2382 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2383 reg &= ~DWC3_DCTL_INITU1ENA;
2384 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2386 reg &= ~DWC3_DCTL_INITU2ENA;
2387 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2389 dwc3_disconnect_gadget(dwc);
2391 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2392 dwc->setup_packet_pending = false;
2393 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2395 dwc->connected = false;
2398 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2402 dwc->connected = true;
2405 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2406 * would cause a missing Disconnect Event if there's a
2407 * pending Setup Packet in the FIFO.
2409 * There's no suggested workaround on the official Bug
2410 * report, which states that "unless the driver/application
2411 * is doing any special handling of a disconnect event,
2412 * there is no functional issue".
2414 * Unfortunately, it turns out that we _do_ some special
2415 * handling of a disconnect event, namely complete all
2416 * pending transfers, notify gadget driver of the
2417 * disconnection, and so on.
2419 * Our suggested workaround is to follow the Disconnect
2420 * Event steps here, instead, based on a setup_packet_pending
2421 * flag. Such flag gets set whenever we have a SETUP_PENDING
2422 * status for EP0 TRBs and gets cleared on XferComplete for the
2427 * STAR#9000466709: RTL: Device : Disconnect event not
2428 * generated if setup packet pending in FIFO
2430 if (dwc->revision < DWC3_REVISION_188A) {
2431 if (dwc->setup_packet_pending)
2432 dwc3_gadget_disconnect_interrupt(dwc);
2435 dwc3_reset_gadget(dwc);
2437 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2438 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2439 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2440 dwc->test_mode = false;
2442 dwc3_stop_active_transfers(dwc);
2443 dwc3_clear_stall_all_ep(dwc);
2445 /* Reset device address to zero */
2446 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2447 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2448 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2451 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2454 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2457 * We change the clock only at SS but I dunno why I would want to do
2458 * this. Maybe it becomes part of the power saving plan.
2461 if ((speed != DWC3_DSTS_SUPERSPEED) &&
2462 (speed != DWC3_DSTS_SUPERSPEED_PLUS))
2466 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2467 * each time on Connect Done.
2472 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2473 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2474 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2477 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2479 struct dwc3_ep *dep;
2484 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2485 speed = reg & DWC3_DSTS_CONNECTSPD;
2488 dwc3_update_ram_clk_sel(dwc, speed);
2491 case DWC3_DSTS_SUPERSPEED_PLUS:
2492 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2493 dwc->gadget.ep0->maxpacket = 512;
2494 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2496 case DWC3_DSTS_SUPERSPEED:
2498 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2499 * would cause a missing USB3 Reset event.
2501 * In such situations, we should force a USB3 Reset
2502 * event by calling our dwc3_gadget_reset_interrupt()
2507 * STAR#9000483510: RTL: SS : USB3 reset event may
2508 * not be generated always when the link enters poll
2510 if (dwc->revision < DWC3_REVISION_190A)
2511 dwc3_gadget_reset_interrupt(dwc);
2513 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2514 dwc->gadget.ep0->maxpacket = 512;
2515 dwc->gadget.speed = USB_SPEED_SUPER;
2517 case DWC3_DSTS_HIGHSPEED:
2518 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2519 dwc->gadget.ep0->maxpacket = 64;
2520 dwc->gadget.speed = USB_SPEED_HIGH;
2522 case DWC3_DSTS_FULLSPEED2:
2523 case DWC3_DSTS_FULLSPEED1:
2524 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2525 dwc->gadget.ep0->maxpacket = 64;
2526 dwc->gadget.speed = USB_SPEED_FULL;
2528 case DWC3_DSTS_LOWSPEED:
2529 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2530 dwc->gadget.ep0->maxpacket = 8;
2531 dwc->gadget.speed = USB_SPEED_LOW;
2535 /* Enable USB2 LPM Capability */
2537 if ((dwc->revision > DWC3_REVISION_194A) &&
2538 (speed != DWC3_DSTS_SUPERSPEED) &&
2539 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2540 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2541 reg |= DWC3_DCFG_LPM_CAP;
2542 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2544 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2545 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2547 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2550 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2551 * DCFG.LPMCap is set, core responses with an ACK and the
2552 * BESL value in the LPM token is less than or equal to LPM
2555 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2556 && dwc->has_lpm_erratum,
2557 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2559 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2560 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2562 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2564 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2565 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2566 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2570 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2573 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2578 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2581 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2586 * Configure PHY via GUSB3PIPECTLn if required.
2588 * Update GTXFIFOSIZn
2590 * In both cases reset values should be sufficient.
2594 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2597 * TODO take core out of low power mode when that's
2601 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2602 spin_unlock(&dwc->lock);
2603 dwc->gadget_driver->resume(&dwc->gadget);
2604 spin_lock(&dwc->lock);
2608 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2609 unsigned int evtinfo)
2611 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2612 unsigned int pwropt;
2615 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2616 * Hibernation mode enabled which would show up when device detects
2617 * host-initiated U3 exit.
2619 * In that case, device will generate a Link State Change Interrupt
2620 * from U3 to RESUME which is only necessary if Hibernation is
2623 * There are no functional changes due to such spurious event and we
2624 * just need to ignore it.
2628 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2631 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2632 if ((dwc->revision < DWC3_REVISION_250A) &&
2633 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2634 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2635 (next == DWC3_LINK_STATE_RESUME)) {
2636 dwc3_trace(trace_dwc3_gadget,
2637 "ignoring transition U3 -> Resume");
2643 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2644 * on the link partner, the USB session might do multiple entry/exit
2645 * of low power states before a transfer takes place.
2647 * Due to this problem, we might experience lower throughput. The
2648 * suggested workaround is to disable DCTL[12:9] bits if we're
2649 * transitioning from U1/U2 to U0 and enable those bits again
2650 * after a transfer completes and there are no pending transfers
2651 * on any of the enabled endpoints.
2653 * This is the first half of that workaround.
2657 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2658 * core send LGO_Ux entering U0
2660 if (dwc->revision < DWC3_REVISION_183A) {
2661 if (next == DWC3_LINK_STATE_U0) {
2665 switch (dwc->link_state) {
2666 case DWC3_LINK_STATE_U1:
2667 case DWC3_LINK_STATE_U2:
2668 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2669 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2670 | DWC3_DCTL_ACCEPTU2ENA
2671 | DWC3_DCTL_INITU1ENA
2672 | DWC3_DCTL_ACCEPTU1ENA);
2675 dwc->u1u2 = reg & u1u2;
2679 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2689 case DWC3_LINK_STATE_U1:
2690 if (dwc->speed == USB_SPEED_SUPER)
2691 dwc3_suspend_gadget(dwc);
2693 case DWC3_LINK_STATE_U2:
2694 case DWC3_LINK_STATE_U3:
2695 dwc3_suspend_gadget(dwc);
2697 case DWC3_LINK_STATE_RESUME:
2698 dwc3_resume_gadget(dwc);
2705 dwc->link_state = next;
2708 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2709 unsigned int evtinfo)
2711 unsigned int is_ss = evtinfo & BIT(4);
2714 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2715 * have a known issue which can cause USB CV TD.9.23 to fail
2718 * Because of this issue, core could generate bogus hibernation
2719 * events which SW needs to ignore.
2723 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2724 * Device Fallback from SuperSpeed
2726 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2729 /* enter hibernation here */
2732 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2733 const struct dwc3_event_devt *event)
2735 switch (event->type) {
2736 case DWC3_DEVICE_EVENT_DISCONNECT:
2737 dwc3_gadget_disconnect_interrupt(dwc);
2739 case DWC3_DEVICE_EVENT_RESET:
2740 dwc3_gadget_reset_interrupt(dwc);
2742 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2743 dwc3_gadget_conndone_interrupt(dwc);
2745 case DWC3_DEVICE_EVENT_WAKEUP:
2746 dwc3_gadget_wakeup_interrupt(dwc);
2748 case DWC3_DEVICE_EVENT_HIBER_REQ:
2749 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2750 "unexpected hibernation event\n"))
2753 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2755 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2756 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2758 case DWC3_DEVICE_EVENT_EOPF:
2759 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2761 case DWC3_DEVICE_EVENT_SOF:
2762 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2764 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2765 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2767 case DWC3_DEVICE_EVENT_CMD_CMPL:
2768 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2770 case DWC3_DEVICE_EVENT_OVERFLOW:
2771 dwc3_trace(trace_dwc3_gadget, "Overflow");
2774 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2778 static void dwc3_process_event_entry(struct dwc3 *dwc,
2779 const union dwc3_event *event)
2781 trace_dwc3_event(event->raw);
2783 /* Endpoint IRQ, handle it and return early */
2784 if (event->type.is_devspec == 0) {
2786 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2789 switch (event->type.type) {
2790 case DWC3_EVENT_TYPE_DEV:
2791 dwc3_gadget_interrupt(dwc, &event->devt);
2793 /* REVISIT what to do with Carkit and I2C events ? */
2795 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2799 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2801 struct dwc3 *dwc = evt->dwc;
2802 irqreturn_t ret = IRQ_NONE;
2808 if (!(evt->flags & DWC3_EVENT_PENDING))
2812 union dwc3_event event;
2814 event.raw = *(u32 *) (evt->buf + evt->lpos);
2816 dwc3_process_event_entry(dwc, &event);
2819 * FIXME we wrap around correctly to the next entry as
2820 * almost all entries are 4 bytes in size. There is one
2821 * entry which has 12 bytes which is a regular entry
2822 * followed by 8 bytes data. ATM I don't know how
2823 * things are organized if we get next to the a
2824 * boundary so I worry about that once we try to handle
2827 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2830 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2834 evt->flags &= ~DWC3_EVENT_PENDING;
2837 /* Unmask interrupt */
2838 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2839 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2840 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2845 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2847 struct dwc3_event_buffer *evt = _evt;
2848 struct dwc3 *dwc = evt->dwc;
2849 unsigned long flags;
2850 irqreturn_t ret = IRQ_NONE;
2852 spin_lock_irqsave(&dwc->lock, flags);
2853 ret = dwc3_process_event_buf(evt);
2854 spin_unlock_irqrestore(&dwc->lock, flags);
2859 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2861 struct dwc3 *dwc = evt->dwc;
2865 if (pm_runtime_suspended(dwc->dev)) {
2866 pm_runtime_get(dwc->dev);
2867 disable_irq_nosync(dwc->irq_gadget);
2868 dwc->pending_events = true;
2872 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2873 count &= DWC3_GEVNTCOUNT_MASK;
2878 evt->flags |= DWC3_EVENT_PENDING;
2880 /* Mask interrupt */
2881 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2882 reg |= DWC3_GEVNTSIZ_INTMASK;
2883 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2885 return IRQ_WAKE_THREAD;
2888 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2890 struct dwc3_event_buffer *evt = _evt;
2892 return dwc3_check_event_buf(evt);
2896 * dwc3_gadget_init - Initializes gadget related registers
2897 * @dwc: pointer to our controller context structure
2899 * Returns 0 on success otherwise negative errno.
2901 int dwc3_gadget_init(struct dwc3 *dwc)
2905 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2906 &dwc->ctrl_req_addr, GFP_KERNEL);
2907 if (!dwc->ctrl_req) {
2908 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2913 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2914 &dwc->ep0_trb_addr, GFP_KERNEL);
2915 if (!dwc->ep0_trb) {
2916 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2921 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2922 if (!dwc->setup_buf) {
2927 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2928 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2930 if (!dwc->ep0_bounce) {
2931 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2936 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2937 if (!dwc->zlp_buf) {
2942 dwc->gadget.ops = &dwc3_gadget_ops;
2943 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2944 dwc->gadget.sg_supported = true;
2945 dwc->gadget.name = "dwc3-gadget";
2946 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2949 * FIXME We might be setting max_speed to <SUPER, however versions
2950 * <2.20a of dwc3 have an issue with metastability (documented
2951 * elsewhere in this driver) which tells us we can't set max speed to
2952 * anything lower than SUPER.
2954 * Because gadget.max_speed is only used by composite.c and function
2955 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2956 * to happen so we avoid sending SuperSpeed Capability descriptor
2957 * together with our BOS descriptor as that could confuse host into
2958 * thinking we can handle super speed.
2960 * Note that, in fact, we won't even support GetBOS requests when speed
2961 * is less than super speed because we don't have means, yet, to tell
2962 * composite.c that we are USB 2.0 + LPM ECN.
2964 if (dwc->revision < DWC3_REVISION_220A)
2965 dwc3_trace(trace_dwc3_gadget,
2966 "Changing max_speed on rev %08x",
2969 dwc->gadget.max_speed = dwc->maximum_speed;
2972 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2975 dwc->gadget.quirk_ep_out_aligned_size = true;
2978 * REVISIT: Here we should clear all pending IRQs to be
2979 * sure we're starting from a well known location.
2982 ret = dwc3_gadget_init_endpoints(dwc);
2986 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2988 dev_err(dwc->dev, "failed to register udc\n");
2995 kfree(dwc->zlp_buf);
2998 dwc3_gadget_free_endpoints(dwc);
2999 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3000 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3003 kfree(dwc->setup_buf);
3006 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
3007 dwc->ep0_trb, dwc->ep0_trb_addr);
3010 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3011 dwc->ctrl_req, dwc->ctrl_req_addr);
3017 /* -------------------------------------------------------------------------- */
3019 void dwc3_gadget_exit(struct dwc3 *dwc)
3021 usb_del_gadget_udc(&dwc->gadget);
3023 dwc3_gadget_free_endpoints(dwc);
3025 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3026 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3028 kfree(dwc->setup_buf);
3029 kfree(dwc->zlp_buf);
3031 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
3032 dwc->ep0_trb, dwc->ep0_trb_addr);
3034 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3035 dwc->ctrl_req, dwc->ctrl_req_addr);
3038 int dwc3_gadget_suspend(struct dwc3 *dwc)
3042 if (!dwc->gadget_driver)
3045 ret = dwc3_gadget_run_stop(dwc, false, false);
3049 dwc3_disconnect_gadget(dwc);
3050 __dwc3_gadget_stop(dwc);
3055 int dwc3_gadget_resume(struct dwc3 *dwc)
3059 if (!dwc->gadget_driver)
3062 ret = __dwc3_gadget_start(dwc);
3066 ret = dwc3_gadget_run_stop(dwc, true, false);
3073 __dwc3_gadget_stop(dwc);
3079 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3081 if (dwc->pending_events) {
3082 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3083 dwc->pending_events = false;
3084 enable_irq(dwc->irq_gadget);