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");
148 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
151 dep->trb_enqueue %= DWC3_TRB_NUM;
154 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
157 dep->trb_dequeue %= DWC3_TRB_NUM;
160 static int dwc3_ep_is_last_trb(unsigned int index)
162 return index == DWC3_TRB_NUM - 1;
165 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
168 struct dwc3 *dwc = dep->dwc;
174 dwc3_ep_inc_deq(dep);
176 * Skip LINK TRB. We can't use req->trb and check for
177 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
178 * just completed (not the LINK TRB).
180 if (dwc3_ep_is_last_trb(dep->trb_dequeue) &&
181 usb_endpoint_xfer_isoc(dep->endpoint.desc))
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 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
210 trace_dwc3_gadget_generic_cmd(cmd, param);
212 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
213 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
216 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
217 if (!(reg & DWC3_DGCMD_CMDACT)) {
218 dwc3_trace(trace_dwc3_gadget,
219 "Command Complete --> %d",
220 DWC3_DGCMD_STATUS(reg));
221 if (DWC3_DGCMD_STATUS(reg))
227 * We can't sleep here, because it's also called from
232 dwc3_trace(trace_dwc3_gadget,
233 "Command Timed Out");
240 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
242 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
243 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
245 struct dwc3_ep *dep = dwc->eps[ep];
252 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
255 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
256 * we're issuing an endpoint command, we must check if
257 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
259 * We will also set SUSPHY bit to what it was before returning as stated
260 * by the same section on Synopsys databook.
262 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
263 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
265 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
266 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
269 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
272 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
273 dwc->link_state == DWC3_LINK_STATE_U2 ||
274 dwc->link_state == DWC3_LINK_STATE_U3);
276 if (unlikely(needs_wakeup)) {
277 ret = __dwc3_gadget_wakeup(dwc);
278 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
283 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
284 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
285 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
287 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
289 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
290 if (!(reg & DWC3_DEPCMD_CMDACT)) {
291 dwc3_trace(trace_dwc3_gadget,
292 "Command Complete --> %d",
293 DWC3_DEPCMD_STATUS(reg));
294 if (DWC3_DEPCMD_STATUS(reg))
301 * We can't sleep here, because it is also called from
306 dwc3_trace(trace_dwc3_gadget,
307 "Command Timed Out");
315 if (unlikely(susphy)) {
316 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
317 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
318 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
324 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
325 struct dwc3_trb *trb)
327 u32 offset = (char *) trb - (char *) dep->trb_pool;
329 return dep->trb_pool_dma + offset;
332 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
334 struct dwc3 *dwc = dep->dwc;
339 dep->trb_pool = dma_alloc_coherent(dwc->dev,
340 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
341 &dep->trb_pool_dma, GFP_KERNEL);
342 if (!dep->trb_pool) {
343 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
351 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
353 struct dwc3 *dwc = dep->dwc;
355 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
356 dep->trb_pool, dep->trb_pool_dma);
358 dep->trb_pool = NULL;
359 dep->trb_pool_dma = 0;
362 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
365 * dwc3_gadget_start_config - Configure EP resources
366 * @dwc: pointer to our controller context structure
367 * @dep: endpoint that is being enabled
369 * The assignment of transfer resources cannot perfectly follow the
370 * data book due to the fact that the controller driver does not have
371 * all knowledge of the configuration in advance. It is given this
372 * information piecemeal by the composite gadget framework after every
373 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
374 * programming model in this scenario can cause errors. For two
377 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
378 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
379 * multiple interfaces.
381 * 2) The databook does not mention doing more DEPXFERCFG for new
382 * endpoint on alt setting (8.1.6).
384 * The following simplified method is used instead:
386 * All hardware endpoints can be assigned a transfer resource and this
387 * setting will stay persistent until either a core reset or
388 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
389 * do DEPXFERCFG for every hardware endpoint as well. We are
390 * guaranteed that there are as many transfer resources as endpoints.
392 * This function is called for each endpoint when it is being enabled
393 * but is triggered only when called for EP0-out, which always happens
394 * first, and which should only happen in one of the above conditions.
396 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
398 struct dwc3_gadget_ep_cmd_params params;
406 memset(¶ms, 0x00, sizeof(params));
407 cmd = DWC3_DEPCMD_DEPSTARTCFG;
409 ret = dwc3_send_gadget_ep_cmd(dwc, 0, cmd, ¶ms);
413 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
414 struct dwc3_ep *dep = dwc->eps[i];
419 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
427 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
428 const struct usb_endpoint_descriptor *desc,
429 const struct usb_ss_ep_comp_descriptor *comp_desc,
430 bool ignore, bool restore)
432 struct dwc3_gadget_ep_cmd_params params;
434 memset(¶ms, 0x00, sizeof(params));
436 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
437 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
439 /* Burst size is only needed in SuperSpeed mode */
440 if (dwc->gadget.speed == USB_SPEED_SUPER) {
441 u32 burst = dep->endpoint.maxburst - 1;
443 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst);
447 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
450 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
451 params.param2 |= dep->saved_state;
454 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
455 | DWC3_DEPCFG_XFER_NOT_READY_EN;
457 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
458 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
459 | DWC3_DEPCFG_STREAM_EVENT_EN;
460 dep->stream_capable = true;
463 if (!usb_endpoint_xfer_control(desc))
464 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
467 * We are doing 1:1 mapping for endpoints, meaning
468 * Physical Endpoints 2 maps to Logical Endpoint 2 and
469 * so on. We consider the direction bit as part of the physical
470 * endpoint number. So USB endpoint 0x81 is 0x03.
472 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
475 * We must use the lower 16 TX FIFOs even though
479 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
481 if (desc->bInterval) {
482 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
483 dep->interval = 1 << (desc->bInterval - 1);
486 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
487 DWC3_DEPCMD_SETEPCONFIG, ¶ms);
490 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
492 struct dwc3_gadget_ep_cmd_params params;
494 memset(¶ms, 0x00, sizeof(params));
496 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
498 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
499 DWC3_DEPCMD_SETTRANSFRESOURCE, ¶ms);
503 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
504 * @dep: endpoint to be initialized
505 * @desc: USB Endpoint Descriptor
507 * Caller should take care of locking
509 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
510 const struct usb_endpoint_descriptor *desc,
511 const struct usb_ss_ep_comp_descriptor *comp_desc,
512 bool ignore, bool restore)
514 struct dwc3 *dwc = dep->dwc;
518 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
520 if (!(dep->flags & DWC3_EP_ENABLED)) {
521 ret = dwc3_gadget_start_config(dwc, dep);
526 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
531 if (!(dep->flags & DWC3_EP_ENABLED)) {
532 struct dwc3_trb *trb_st_hw;
533 struct dwc3_trb *trb_link;
535 dep->endpoint.desc = desc;
536 dep->comp_desc = comp_desc;
537 dep->type = usb_endpoint_type(desc);
538 dep->flags |= DWC3_EP_ENABLED;
540 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
541 reg |= DWC3_DALEPENA_EP(dep->number);
542 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
544 if (!usb_endpoint_xfer_isoc(desc))
547 /* Link TRB for ISOC. The HWO bit is never reset */
548 trb_st_hw = &dep->trb_pool[0];
550 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
551 memset(trb_link, 0, sizeof(*trb_link));
553 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
554 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
555 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
556 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
560 switch (usb_endpoint_type(desc)) {
561 case USB_ENDPOINT_XFER_CONTROL:
562 /* don't change name */
564 case USB_ENDPOINT_XFER_ISOC:
565 strlcat(dep->name, "-isoc", sizeof(dep->name));
567 case USB_ENDPOINT_XFER_BULK:
568 strlcat(dep->name, "-bulk", sizeof(dep->name));
570 case USB_ENDPOINT_XFER_INT:
571 strlcat(dep->name, "-int", sizeof(dep->name));
574 dev_err(dwc->dev, "invalid endpoint transfer type\n");
580 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
581 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
583 struct dwc3_request *req;
585 if (!list_empty(&dep->started_list)) {
586 dwc3_stop_active_transfer(dwc, dep->number, true);
588 /* - giveback all requests to gadget driver */
589 while (!list_empty(&dep->started_list)) {
590 req = next_request(&dep->started_list);
592 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
596 while (!list_empty(&dep->pending_list)) {
597 req = next_request(&dep->pending_list);
599 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
604 * __dwc3_gadget_ep_disable - Disables a HW endpoint
605 * @dep: the endpoint to disable
607 * This function also removes requests which are currently processed ny the
608 * hardware and those which are not yet scheduled.
609 * Caller should take care of locking.
611 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
613 struct dwc3 *dwc = dep->dwc;
616 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
618 dwc3_remove_requests(dwc, dep);
620 /* make sure HW endpoint isn't stalled */
621 if (dep->flags & DWC3_EP_STALL)
622 __dwc3_gadget_ep_set_halt(dep, 0, false);
624 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
625 reg &= ~DWC3_DALEPENA_EP(dep->number);
626 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
628 dep->stream_capable = false;
629 dep->endpoint.desc = NULL;
630 dep->comp_desc = NULL;
634 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
636 (dep->number & 1) ? "in" : "out");
641 /* -------------------------------------------------------------------------- */
643 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
644 const struct usb_endpoint_descriptor *desc)
649 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
654 /* -------------------------------------------------------------------------- */
656 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
657 const struct usb_endpoint_descriptor *desc)
664 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
665 pr_debug("dwc3: invalid parameters\n");
669 if (!desc->wMaxPacketSize) {
670 pr_debug("dwc3: missing wMaxPacketSize\n");
674 dep = to_dwc3_ep(ep);
677 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
678 "%s is already enabled\n",
682 spin_lock_irqsave(&dwc->lock, flags);
683 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
684 spin_unlock_irqrestore(&dwc->lock, flags);
689 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
697 pr_debug("dwc3: invalid parameters\n");
701 dep = to_dwc3_ep(ep);
704 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
705 "%s is already disabled\n",
709 spin_lock_irqsave(&dwc->lock, flags);
710 ret = __dwc3_gadget_ep_disable(dep);
711 spin_unlock_irqrestore(&dwc->lock, flags);
716 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
719 struct dwc3_request *req;
720 struct dwc3_ep *dep = to_dwc3_ep(ep);
722 req = kzalloc(sizeof(*req), gfp_flags);
726 req->epnum = dep->number;
729 trace_dwc3_alloc_request(req);
731 return &req->request;
734 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
735 struct usb_request *request)
737 struct dwc3_request *req = to_dwc3_request(request);
739 trace_dwc3_free_request(req);
744 * dwc3_prepare_one_trb - setup one TRB from one request
745 * @dep: endpoint for which this request is prepared
746 * @req: dwc3_request pointer
748 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
749 struct dwc3_request *req, dma_addr_t dma,
750 unsigned length, unsigned last, unsigned chain, unsigned node)
752 struct dwc3_trb *trb;
754 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
755 dep->name, req, (unsigned long long) dma,
756 length, last ? " last" : "",
757 chain ? " chain" : "");
760 trb = &dep->trb_pool[dep->trb_enqueue];
763 dwc3_gadget_move_started_request(req);
765 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
766 req->first_trb_index = dep->trb_enqueue;
769 dwc3_ep_inc_enq(dep);
770 /* Skip the LINK-TRB on ISOC */
771 if (dwc3_ep_is_last_trb(dep->trb_enqueue) &&
772 usb_endpoint_xfer_isoc(dep->endpoint.desc))
773 dwc3_ep_inc_enq(dep);
775 trb->size = DWC3_TRB_SIZE_LENGTH(length);
776 trb->bpl = lower_32_bits(dma);
777 trb->bph = upper_32_bits(dma);
779 switch (usb_endpoint_type(dep->endpoint.desc)) {
780 case USB_ENDPOINT_XFER_CONTROL:
781 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
784 case USB_ENDPOINT_XFER_ISOC:
786 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
788 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
790 /* always enable Interrupt on Missed ISOC */
791 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
794 case USB_ENDPOINT_XFER_BULK:
795 case USB_ENDPOINT_XFER_INT:
796 trb->ctrl = DWC3_TRBCTL_NORMAL;
800 * This is only possible with faulty memory because we
801 * checked it already :)
806 /* always enable Continue on Short Packet */
807 trb->ctrl |= DWC3_TRB_CTRL_CSP;
809 if (!req->request.no_interrupt)
810 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
813 trb->ctrl |= DWC3_TRB_CTRL_LST;
816 trb->ctrl |= DWC3_TRB_CTRL_CHN;
818 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
819 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
821 trb->ctrl |= DWC3_TRB_CTRL_HWO;
823 trace_dwc3_prepare_trb(dep, trb);
827 * dwc3_prepare_trbs - setup TRBs from requests
828 * @dep: endpoint for which requests are being prepared
829 * @starting: true if the endpoint is idle and no requests are queued.
831 * The function goes through the requests list and sets up TRBs for the
832 * transfers. The function returns once there are no more TRBs available or
833 * it runs out of requests.
835 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
837 struct dwc3_request *req, *n;
840 unsigned int last_one = 0;
842 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
844 /* the first request must not be queued */
845 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
847 /* Can't wrap around on a non-isoc EP since there's no link TRB */
848 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
849 max = DWC3_TRB_NUM - dep->trb_enqueue;
855 * If busy & slot are equal than it is either full or empty. If we are
856 * starting to process requests then we are empty. Otherwise we are
857 * full and don't do anything
862 trbs_left = DWC3_TRB_NUM;
864 * In case we start from scratch, we queue the ISOC requests
865 * starting from slot 1. This is done because we use ring
866 * buffer and have no LST bit to stop us. Instead, we place
867 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
868 * after the first request so we start at slot 1 and have
869 * 7 requests proceed before we hit the first IOC.
870 * Other transfer types don't use the ring buffer and are
871 * processed from the first TRB until the last one. Since we
872 * don't wrap around we have to start at the beginning.
874 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
875 dep->trb_dequeue = 1;
876 dep->trb_enqueue = 1;
878 dep->trb_dequeue = 0;
879 dep->trb_enqueue = 0;
883 /* The last TRB is a link TRB, not used for xfer */
884 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->endpoint.desc))
887 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
892 if (req->request.num_mapped_sgs > 0) {
893 struct usb_request *request = &req->request;
894 struct scatterlist *sg = request->sg;
895 struct scatterlist *s;
898 for_each_sg(sg, s, request->num_mapped_sgs, i) {
899 unsigned chain = true;
901 length = sg_dma_len(s);
902 dma = sg_dma_address(s);
904 if (i == (request->num_mapped_sgs - 1) ||
906 if (list_empty(&dep->pending_list))
918 dwc3_prepare_one_trb(dep, req, dma, length,
928 dma = req->request.dma;
929 length = req->request.length;
935 /* Is this the last request? */
936 if (list_is_last(&req->list, &dep->pending_list))
939 dwc3_prepare_one_trb(dep, req, dma, length,
948 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
951 struct dwc3_gadget_ep_cmd_params params;
952 struct dwc3_request *req;
953 struct dwc3 *dwc = dep->dwc;
957 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
958 dwc3_trace(trace_dwc3_gadget, "%s: endpoint busy", dep->name);
963 * If we are getting here after a short-out-packet we don't enqueue any
964 * new requests as we try to set the IOC bit only on the last request.
967 if (list_empty(&dep->started_list))
968 dwc3_prepare_trbs(dep, start_new);
970 /* req points to the first request which will be sent */
971 req = next_request(&dep->started_list);
973 dwc3_prepare_trbs(dep, start_new);
976 * req points to the first request where HWO changed from 0 to 1
978 req = next_request(&dep->started_list);
981 dep->flags |= DWC3_EP_PENDING_REQUEST;
985 memset(¶ms, 0, sizeof(params));
988 params.param0 = upper_32_bits(req->trb_dma);
989 params.param1 = lower_32_bits(req->trb_dma);
990 cmd = DWC3_DEPCMD_STARTTRANSFER;
992 cmd = DWC3_DEPCMD_UPDATETRANSFER;
995 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
996 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
999 * FIXME we need to iterate over the list of requests
1000 * here and stop, unmap, free and del each of the linked
1001 * requests instead of what we do now.
1003 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1005 list_del(&req->list);
1009 dep->flags |= DWC3_EP_BUSY;
1012 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
1014 WARN_ON_ONCE(!dep->resource_index);
1020 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1021 struct dwc3_ep *dep, u32 cur_uf)
1025 if (list_empty(&dep->pending_list)) {
1026 dwc3_trace(trace_dwc3_gadget,
1027 "ISOC ep %s run out for requests",
1029 dep->flags |= DWC3_EP_PENDING_REQUEST;
1033 /* 4 micro frames in the future */
1034 uf = cur_uf + dep->interval * 4;
1036 __dwc3_gadget_kick_transfer(dep, uf, 1);
1039 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1040 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1044 mask = ~(dep->interval - 1);
1045 cur_uf = event->parameters & mask;
1047 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1050 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1052 struct dwc3 *dwc = dep->dwc;
1055 if (!dep->endpoint.desc) {
1056 dwc3_trace(trace_dwc3_gadget,
1057 "trying to queue request %p to disabled %s\n",
1058 &req->request, dep->endpoint.name);
1062 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1063 &req->request, req->dep->name)) {
1064 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1065 &req->request, req->dep->name);
1069 req->request.actual = 0;
1070 req->request.status = -EINPROGRESS;
1071 req->direction = dep->direction;
1072 req->epnum = dep->number;
1074 trace_dwc3_ep_queue(req);
1077 * Per databook, the total size of buffer must be a multiple
1078 * of MaxPacketSize for OUT endpoints. And MaxPacketSize is
1079 * configed for endpoints in dwc3_gadget_set_ep_config(),
1080 * set to usb_endpoint_descriptor->wMaxPacketSize.
1082 if (dep->direction == 0 &&
1083 req->request.length % dep->endpoint.desc->wMaxPacketSize)
1084 req->request.length = roundup(req->request.length,
1085 dep->endpoint.desc->wMaxPacketSize);
1088 * We only add to our list of requests now and
1089 * start consuming the list once we get XferNotReady
1092 * That way, we avoid doing anything that we don't need
1093 * to do now and defer it until the point we receive a
1094 * particular token from the Host side.
1096 * This will also avoid Host cancelling URBs due to too
1099 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1104 list_add_tail(&req->list, &dep->pending_list);
1107 * If there are no pending requests and the endpoint isn't already
1108 * busy, we will just start the request straight away.
1110 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1111 * little bit faster.
1113 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1114 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1115 !(dep->flags & DWC3_EP_BUSY)) {
1116 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1121 * There are a few special cases:
1123 * 1. XferNotReady with empty list of requests. We need to kick the
1124 * transfer here in that situation, otherwise we will be NAKing
1125 * forever. If we get XferNotReady before gadget driver has a
1126 * chance to queue a request, we will ACK the IRQ but won't be
1127 * able to receive the data until the next request is queued.
1128 * The following code is handling exactly that.
1131 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1133 * If xfernotready is already elapsed and it is a case
1134 * of isoc transfer, then issue END TRANSFER, so that
1135 * you can receive xfernotready again and can have
1136 * notion of current microframe.
1138 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1139 if (list_empty(&dep->started_list)) {
1140 dwc3_stop_active_transfer(dwc, dep->number, true);
1141 dep->flags = DWC3_EP_ENABLED;
1146 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1148 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1154 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1155 * kick the transfer here after queuing a request, otherwise the
1156 * core may not see the modified TRB(s).
1158 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1159 (dep->flags & DWC3_EP_BUSY) &&
1160 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1161 WARN_ON_ONCE(!dep->resource_index);
1162 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index,
1168 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1169 * right away, otherwise host will not know we have streams to be
1172 if (dep->stream_capable)
1173 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1176 if (ret && ret != -EBUSY)
1177 dwc3_trace(trace_dwc3_gadget,
1178 "%s: failed to kick transfers\n",
1186 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1187 struct usb_request *request)
1189 dwc3_gadget_ep_free_request(ep, request);
1192 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1194 struct dwc3_request *req;
1195 struct usb_request *request;
1196 struct usb_ep *ep = &dep->endpoint;
1198 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1199 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1203 request->length = 0;
1204 request->buf = dwc->zlp_buf;
1205 request->complete = __dwc3_gadget_ep_zlp_complete;
1207 req = to_dwc3_request(request);
1209 return __dwc3_gadget_ep_queue(dep, req);
1212 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1215 struct dwc3_request *req = to_dwc3_request(request);
1216 struct dwc3_ep *dep = to_dwc3_ep(ep);
1217 struct dwc3 *dwc = dep->dwc;
1219 unsigned long flags;
1223 spin_lock_irqsave(&dwc->lock, flags);
1224 ret = __dwc3_gadget_ep_queue(dep, req);
1227 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1228 * setting request->zero, instead of doing magic, we will just queue an
1229 * extra usb_request ourselves so that it gets handled the same way as
1230 * any other request.
1232 if (ret == 0 && request->zero && request->length &&
1233 (request->length % ep->desc->wMaxPacketSize == 0))
1234 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1236 spin_unlock_irqrestore(&dwc->lock, flags);
1241 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1242 struct usb_request *request)
1244 struct dwc3_request *req = to_dwc3_request(request);
1245 struct dwc3_request *r = NULL;
1247 struct dwc3_ep *dep = to_dwc3_ep(ep);
1248 struct dwc3 *dwc = dep->dwc;
1250 unsigned long flags;
1253 trace_dwc3_ep_dequeue(req);
1255 spin_lock_irqsave(&dwc->lock, flags);
1257 list_for_each_entry(r, &dep->pending_list, list) {
1263 list_for_each_entry(r, &dep->started_list, list) {
1268 /* wait until it is processed */
1269 dwc3_stop_active_transfer(dwc, dep->number, true);
1272 dev_err(dwc->dev, "request %p was not queued to %s\n",
1279 /* giveback the request */
1280 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1283 spin_unlock_irqrestore(&dwc->lock, flags);
1288 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1290 struct dwc3_gadget_ep_cmd_params params;
1291 struct dwc3 *dwc = dep->dwc;
1294 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1295 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1299 memset(¶ms, 0x00, sizeof(params));
1302 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1303 (!list_empty(&dep->started_list) ||
1304 !list_empty(&dep->pending_list)))) {
1305 dwc3_trace(trace_dwc3_gadget,
1306 "%s: pending request, cannot halt\n",
1311 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1312 DWC3_DEPCMD_SETSTALL, ¶ms);
1314 dev_err(dwc->dev, "failed to set STALL on %s\n",
1317 dep->flags |= DWC3_EP_STALL;
1319 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1320 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1322 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1325 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1331 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1333 struct dwc3_ep *dep = to_dwc3_ep(ep);
1334 struct dwc3 *dwc = dep->dwc;
1336 unsigned long flags;
1340 spin_lock_irqsave(&dwc->lock, flags);
1341 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1342 spin_unlock_irqrestore(&dwc->lock, flags);
1347 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1349 struct dwc3_ep *dep = to_dwc3_ep(ep);
1350 struct dwc3 *dwc = dep->dwc;
1351 unsigned long flags;
1354 spin_lock_irqsave(&dwc->lock, flags);
1355 dep->flags |= DWC3_EP_WEDGE;
1357 if (dep->number == 0 || dep->number == 1)
1358 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1360 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1361 spin_unlock_irqrestore(&dwc->lock, flags);
1366 /* -------------------------------------------------------------------------- */
1368 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1369 .bLength = USB_DT_ENDPOINT_SIZE,
1370 .bDescriptorType = USB_DT_ENDPOINT,
1371 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1374 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1375 .enable = dwc3_gadget_ep0_enable,
1376 .disable = dwc3_gadget_ep0_disable,
1377 .alloc_request = dwc3_gadget_ep_alloc_request,
1378 .free_request = dwc3_gadget_ep_free_request,
1379 .queue = dwc3_gadget_ep0_queue,
1380 .dequeue = dwc3_gadget_ep_dequeue,
1381 .set_halt = dwc3_gadget_ep0_set_halt,
1382 .set_wedge = dwc3_gadget_ep_set_wedge,
1385 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1386 .enable = dwc3_gadget_ep_enable,
1387 .disable = dwc3_gadget_ep_disable,
1388 .alloc_request = dwc3_gadget_ep_alloc_request,
1389 .free_request = dwc3_gadget_ep_free_request,
1390 .queue = dwc3_gadget_ep_queue,
1391 .dequeue = dwc3_gadget_ep_dequeue,
1392 .set_halt = dwc3_gadget_ep_set_halt,
1393 .set_wedge = dwc3_gadget_ep_set_wedge,
1396 /* -------------------------------------------------------------------------- */
1398 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1400 struct dwc3 *dwc = gadget_to_dwc(g);
1403 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1404 return DWC3_DSTS_SOFFN(reg);
1407 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1409 unsigned long timeout;
1418 * According to the Databook Remote wakeup request should
1419 * be issued only when the device is in early suspend state.
1421 * We can check that via USB Link State bits in DSTS register.
1423 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1425 speed = reg & DWC3_DSTS_CONNECTSPD;
1426 if (speed == DWC3_DSTS_SUPERSPEED) {
1427 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1431 link_state = DWC3_DSTS_USBLNKST(reg);
1433 switch (link_state) {
1434 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1435 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1438 dwc3_trace(trace_dwc3_gadget,
1439 "can't wakeup from '%s'\n",
1440 dwc3_gadget_link_string(link_state));
1444 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1446 dev_err(dwc->dev, "failed to put link in Recovery\n");
1450 /* Recent versions do this automatically */
1451 if (dwc->revision < DWC3_REVISION_194A) {
1452 /* write zeroes to Link Change Request */
1453 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1454 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1455 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1458 /* poll until Link State changes to ON */
1459 timeout = jiffies + msecs_to_jiffies(100);
1461 while (!time_after(jiffies, timeout)) {
1462 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1464 /* in HS, means ON */
1465 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1469 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1470 dev_err(dwc->dev, "failed to send remote wakeup\n");
1477 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1479 struct dwc3 *dwc = gadget_to_dwc(g);
1480 unsigned long flags;
1483 spin_lock_irqsave(&dwc->lock, flags);
1484 ret = __dwc3_gadget_wakeup(dwc);
1485 spin_unlock_irqrestore(&dwc->lock, flags);
1490 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1493 struct dwc3 *dwc = gadget_to_dwc(g);
1494 unsigned long flags;
1496 spin_lock_irqsave(&dwc->lock, flags);
1497 g->is_selfpowered = !!is_selfpowered;
1498 spin_unlock_irqrestore(&dwc->lock, flags);
1503 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1508 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1510 if (dwc->revision <= DWC3_REVISION_187A) {
1511 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1512 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1515 if (dwc->revision >= DWC3_REVISION_194A)
1516 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1517 reg |= DWC3_DCTL_RUN_STOP;
1519 if (dwc->has_hibernation)
1520 reg |= DWC3_DCTL_KEEP_CONNECT;
1522 dwc->pullups_connected = true;
1524 reg &= ~DWC3_DCTL_RUN_STOP;
1526 if (dwc->has_hibernation && !suspend)
1527 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1529 dwc->pullups_connected = false;
1532 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1535 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1537 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1540 if (reg & DWC3_DSTS_DEVCTRLHLT)
1549 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1551 ? dwc->gadget_driver->function : "no-function",
1552 is_on ? "connect" : "disconnect");
1557 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1559 struct dwc3 *dwc = gadget_to_dwc(g);
1560 unsigned long flags;
1565 spin_lock_irqsave(&dwc->lock, flags);
1566 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1567 spin_unlock_irqrestore(&dwc->lock, flags);
1572 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1576 /* Enable all but Start and End of Frame IRQs */
1577 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1578 DWC3_DEVTEN_EVNTOVERFLOWEN |
1579 DWC3_DEVTEN_CMDCMPLTEN |
1580 DWC3_DEVTEN_ERRTICERREN |
1581 DWC3_DEVTEN_WKUPEVTEN |
1582 DWC3_DEVTEN_ULSTCNGEN |
1583 DWC3_DEVTEN_CONNECTDONEEN |
1584 DWC3_DEVTEN_USBRSTEN |
1585 DWC3_DEVTEN_DISCONNEVTEN);
1587 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1590 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1592 /* mask all interrupts */
1593 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1596 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1597 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1599 static int dwc3_gadget_start(struct usb_gadget *g,
1600 struct usb_gadget_driver *driver)
1602 struct dwc3 *dwc = gadget_to_dwc(g);
1603 struct dwc3_ep *dep;
1604 unsigned long flags;
1609 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1610 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1611 IRQF_SHARED, "dwc3", dwc->ev_buf);
1613 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1618 spin_lock_irqsave(&dwc->lock, flags);
1620 if (dwc->gadget_driver) {
1621 dev_err(dwc->dev, "%s is already bound to %s\n",
1623 dwc->gadget_driver->driver.name);
1628 dwc->gadget_driver = driver;
1630 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1631 reg &= ~(DWC3_DCFG_SPEED_MASK);
1634 * WORKAROUND: DWC3 revision < 2.20a have an issue
1635 * which would cause metastability state on Run/Stop
1636 * bit if we try to force the IP to USB2-only mode.
1638 * Because of that, we cannot configure the IP to any
1639 * speed other than the SuperSpeed
1643 * STAR#9000525659: Clock Domain Crossing on DCTL in
1646 if (dwc->revision < DWC3_REVISION_220A) {
1647 reg |= DWC3_DCFG_SUPERSPEED;
1649 switch (dwc->maximum_speed) {
1651 reg |= DWC3_DSTS_LOWSPEED;
1653 case USB_SPEED_FULL:
1654 reg |= DWC3_DSTS_FULLSPEED1;
1656 case USB_SPEED_HIGH:
1657 reg |= DWC3_DSTS_HIGHSPEED;
1659 case USB_SPEED_SUPER: /* FALLTHROUGH */
1660 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1662 reg |= DWC3_DSTS_SUPERSPEED;
1665 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1667 /* Start with SuperSpeed Default */
1668 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1671 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1674 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1679 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1682 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1686 /* begin to receive SETUP packets */
1687 dwc->ep0state = EP0_SETUP_PHASE;
1688 dwc3_ep0_out_start(dwc);
1690 dwc3_gadget_enable_irq(dwc);
1692 spin_unlock_irqrestore(&dwc->lock, flags);
1697 __dwc3_gadget_ep_disable(dwc->eps[0]);
1700 dwc->gadget_driver = NULL;
1703 spin_unlock_irqrestore(&dwc->lock, flags);
1705 free_irq(irq, dwc->ev_buf);
1711 static int dwc3_gadget_stop(struct usb_gadget *g)
1713 struct dwc3 *dwc = gadget_to_dwc(g);
1714 unsigned long flags;
1717 spin_lock_irqsave(&dwc->lock, flags);
1719 dwc3_gadget_disable_irq(dwc);
1720 __dwc3_gadget_ep_disable(dwc->eps[0]);
1721 __dwc3_gadget_ep_disable(dwc->eps[1]);
1723 dwc->gadget_driver = NULL;
1725 spin_unlock_irqrestore(&dwc->lock, flags);
1727 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1728 free_irq(irq, dwc->ev_buf);
1733 static const struct usb_gadget_ops dwc3_gadget_ops = {
1734 .get_frame = dwc3_gadget_get_frame,
1735 .wakeup = dwc3_gadget_wakeup,
1736 .set_selfpowered = dwc3_gadget_set_selfpowered,
1737 .pullup = dwc3_gadget_pullup,
1738 .udc_start = dwc3_gadget_start,
1739 .udc_stop = dwc3_gadget_stop,
1742 /* -------------------------------------------------------------------------- */
1744 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1745 u8 num, u32 direction)
1747 struct dwc3_ep *dep;
1750 for (i = 0; i < num; i++) {
1751 u8 epnum = (i << 1) | (!!direction);
1753 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1758 dep->number = epnum;
1759 dep->direction = !!direction;
1760 dwc->eps[epnum] = dep;
1762 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1763 (epnum & 1) ? "in" : "out");
1765 dep->endpoint.name = dep->name;
1767 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1769 if (epnum == 0 || epnum == 1) {
1770 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1771 dep->endpoint.maxburst = 1;
1772 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1774 dwc->gadget.ep0 = &dep->endpoint;
1778 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1779 dep->endpoint.max_streams = 15;
1780 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1781 list_add_tail(&dep->endpoint.ep_list,
1782 &dwc->gadget.ep_list);
1784 ret = dwc3_alloc_trb_pool(dep);
1789 if (epnum == 0 || epnum == 1) {
1790 dep->endpoint.caps.type_control = true;
1792 dep->endpoint.caps.type_iso = true;
1793 dep->endpoint.caps.type_bulk = true;
1794 dep->endpoint.caps.type_int = true;
1797 dep->endpoint.caps.dir_in = !!direction;
1798 dep->endpoint.caps.dir_out = !direction;
1800 INIT_LIST_HEAD(&dep->pending_list);
1801 INIT_LIST_HEAD(&dep->started_list);
1807 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1811 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1813 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1815 dwc3_trace(trace_dwc3_gadget,
1816 "failed to allocate OUT endpoints");
1820 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1822 dwc3_trace(trace_dwc3_gadget,
1823 "failed to allocate IN endpoints");
1830 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1832 struct dwc3_ep *dep;
1835 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1836 dep = dwc->eps[epnum];
1840 * Physical endpoints 0 and 1 are special; they form the
1841 * bi-directional USB endpoint 0.
1843 * For those two physical endpoints, we don't allocate a TRB
1844 * pool nor do we add them the endpoints list. Due to that, we
1845 * shouldn't do these two operations otherwise we would end up
1846 * with all sorts of bugs when removing dwc3.ko.
1848 if (epnum != 0 && epnum != 1) {
1849 dwc3_free_trb_pool(dep);
1850 list_del(&dep->endpoint.ep_list);
1857 /* -------------------------------------------------------------------------- */
1859 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1860 struct dwc3_request *req, struct dwc3_trb *trb,
1861 const struct dwc3_event_depevt *event, int status)
1864 unsigned int s_pkt = 0;
1865 unsigned int trb_status;
1867 trace_dwc3_complete_trb(dep, trb);
1869 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1871 * We continue despite the error. There is not much we
1872 * can do. If we don't clean it up we loop forever. If
1873 * we skip the TRB then it gets overwritten after a
1874 * while since we use them in a ring buffer. A BUG()
1875 * would help. Lets hope that if this occurs, someone
1876 * fixes the root cause instead of looking away :)
1878 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1880 count = trb->size & DWC3_TRB_SIZE_MASK;
1882 if (dep->direction) {
1884 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1885 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1886 dwc3_trace(trace_dwc3_gadget,
1887 "%s: incomplete IN transfer\n",
1890 * If missed isoc occurred and there is
1891 * no request queued then issue END
1892 * TRANSFER, so that core generates
1893 * next xfernotready and we will issue
1894 * a fresh START TRANSFER.
1895 * If there are still queued request
1896 * then wait, do not issue either END
1897 * or UPDATE TRANSFER, just attach next
1898 * request in pending_list during
1899 * giveback.If any future queued request
1900 * is successfully transferred then we
1901 * will issue UPDATE TRANSFER for all
1902 * request in the pending_list.
1904 dep->flags |= DWC3_EP_MISSED_ISOC;
1906 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1908 status = -ECONNRESET;
1911 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1914 if (count && (event->status & DEPEVT_STATUS_SHORT))
1919 * We assume here we will always receive the entire data block
1920 * which we should receive. Meaning, if we program RX to
1921 * receive 4K but we receive only 2K, we assume that's all we
1922 * should receive and we simply bounce the request back to the
1923 * gadget driver for further processing.
1925 req->request.actual += req->request.length - count;
1928 if ((event->status & DEPEVT_STATUS_LST) &&
1929 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1930 DWC3_TRB_CTRL_HWO)))
1932 if ((event->status & DEPEVT_STATUS_IOC) &&
1933 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1938 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1939 const struct dwc3_event_depevt *event, int status)
1941 struct dwc3_request *req;
1942 struct dwc3_trb *trb;
1948 req = next_request(&dep->started_list);
1949 if (WARN_ON_ONCE(!req))
1954 slot = req->first_trb_index + i;
1955 if ((slot == DWC3_TRB_NUM - 1) &&
1956 usb_endpoint_xfer_isoc(dep->endpoint.desc))
1958 slot %= DWC3_TRB_NUM;
1959 trb = &dep->trb_pool[slot];
1961 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1965 } while (++i < req->request.num_mapped_sgs);
1967 dwc3_gadget_giveback(dep, req, status);
1973 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1974 list_empty(&dep->started_list)) {
1975 if (list_empty(&dep->pending_list)) {
1977 * If there is no entry in request list then do
1978 * not issue END TRANSFER now. Just set PENDING
1979 * flag, so that END TRANSFER is issued when an
1980 * entry is added into request list.
1982 dep->flags = DWC3_EP_PENDING_REQUEST;
1984 dwc3_stop_active_transfer(dwc, dep->number, true);
1985 dep->flags = DWC3_EP_ENABLED;
1993 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
1994 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1996 unsigned status = 0;
1998 u32 is_xfer_complete;
2000 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2002 if (event->status & DEPEVT_STATUS_BUSERR)
2003 status = -ECONNRESET;
2005 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2006 if (clean_busy && (is_xfer_complete ||
2007 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2008 dep->flags &= ~DWC3_EP_BUSY;
2011 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2012 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2014 if (dwc->revision < DWC3_REVISION_183A) {
2018 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2021 if (!(dep->flags & DWC3_EP_ENABLED))
2024 if (!list_empty(&dep->started_list))
2028 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2030 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2035 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2038 ret = __dwc3_gadget_kick_transfer(dep, 0, is_xfer_complete);
2039 if (!ret || ret == -EBUSY)
2044 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2045 const struct dwc3_event_depevt *event)
2047 struct dwc3_ep *dep;
2048 u8 epnum = event->endpoint_number;
2050 dep = dwc->eps[epnum];
2052 if (!(dep->flags & DWC3_EP_ENABLED))
2055 if (epnum == 0 || epnum == 1) {
2056 dwc3_ep0_interrupt(dwc, event);
2060 switch (event->endpoint_event) {
2061 case DWC3_DEPEVT_XFERCOMPLETE:
2062 dep->resource_index = 0;
2064 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2065 dwc3_trace(trace_dwc3_gadget,
2066 "%s is an Isochronous endpoint\n",
2071 dwc3_endpoint_transfer_complete(dwc, dep, event);
2073 case DWC3_DEPEVT_XFERINPROGRESS:
2074 dwc3_endpoint_transfer_complete(dwc, dep, event);
2076 case DWC3_DEPEVT_XFERNOTREADY:
2077 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2078 dwc3_gadget_start_isoc(dwc, dep, event);
2083 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2085 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2086 dep->name, active ? "Transfer Active"
2087 : "Transfer Not Active");
2089 ret = __dwc3_gadget_kick_transfer(dep, 0, !active);
2090 if (!ret || ret == -EBUSY)
2093 dwc3_trace(trace_dwc3_gadget,
2094 "%s: failed to kick transfers\n",
2099 case DWC3_DEPEVT_STREAMEVT:
2100 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2101 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2106 switch (event->status) {
2107 case DEPEVT_STREAMEVT_FOUND:
2108 dwc3_trace(trace_dwc3_gadget,
2109 "Stream %d found and started",
2113 case DEPEVT_STREAMEVT_NOTFOUND:
2116 dwc3_trace(trace_dwc3_gadget,
2117 "unable to find suitable stream\n");
2120 case DWC3_DEPEVT_RXTXFIFOEVT:
2121 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2123 case DWC3_DEPEVT_EPCMDCMPLT:
2124 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2129 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2131 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2132 spin_unlock(&dwc->lock);
2133 dwc->gadget_driver->disconnect(&dwc->gadget);
2134 spin_lock(&dwc->lock);
2138 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2140 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2141 spin_unlock(&dwc->lock);
2142 dwc->gadget_driver->suspend(&dwc->gadget);
2143 spin_lock(&dwc->lock);
2147 static void dwc3_resume_gadget(struct dwc3 *dwc)
2149 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2150 spin_unlock(&dwc->lock);
2151 dwc->gadget_driver->resume(&dwc->gadget);
2152 spin_lock(&dwc->lock);
2156 static void dwc3_reset_gadget(struct dwc3 *dwc)
2158 if (!dwc->gadget_driver)
2161 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2162 spin_unlock(&dwc->lock);
2163 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2164 spin_lock(&dwc->lock);
2168 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2170 struct dwc3_ep *dep;
2171 struct dwc3_gadget_ep_cmd_params params;
2175 dep = dwc->eps[epnum];
2177 if (!dep->resource_index)
2181 * NOTICE: We are violating what the Databook says about the
2182 * EndTransfer command. Ideally we would _always_ wait for the
2183 * EndTransfer Command Completion IRQ, but that's causing too
2184 * much trouble synchronizing between us and gadget driver.
2186 * We have discussed this with the IP Provider and it was
2187 * suggested to giveback all requests here, but give HW some
2188 * extra time to synchronize with the interconnect. We're using
2189 * an arbitrary 100us delay for that.
2191 * Note also that a similar handling was tested by Synopsys
2192 * (thanks a lot Paul) and nothing bad has come out of it.
2193 * In short, what we're doing is:
2195 * - Issue EndTransfer WITH CMDIOC bit set
2199 cmd = DWC3_DEPCMD_ENDTRANSFER;
2200 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2201 cmd |= DWC3_DEPCMD_CMDIOC;
2202 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2203 memset(¶ms, 0, sizeof(params));
2204 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
2206 dep->resource_index = 0;
2207 dep->flags &= ~DWC3_EP_BUSY;
2211 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2215 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2216 struct dwc3_ep *dep;
2218 dep = dwc->eps[epnum];
2222 if (!(dep->flags & DWC3_EP_ENABLED))
2225 dwc3_remove_requests(dwc, dep);
2229 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2233 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2234 struct dwc3_ep *dep;
2235 struct dwc3_gadget_ep_cmd_params params;
2238 dep = dwc->eps[epnum];
2242 if (!(dep->flags & DWC3_EP_STALL))
2245 dep->flags &= ~DWC3_EP_STALL;
2247 memset(¶ms, 0, sizeof(params));
2248 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
2249 DWC3_DEPCMD_CLEARSTALL, ¶ms);
2254 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2258 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2259 reg &= ~DWC3_DCTL_INITU1ENA;
2260 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2262 reg &= ~DWC3_DCTL_INITU2ENA;
2263 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2265 dwc3_disconnect_gadget(dwc);
2267 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2268 dwc->setup_packet_pending = false;
2269 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2272 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2277 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2278 * would cause a missing Disconnect Event if there's a
2279 * pending Setup Packet in the FIFO.
2281 * There's no suggested workaround on the official Bug
2282 * report, which states that "unless the driver/application
2283 * is doing any special handling of a disconnect event,
2284 * there is no functional issue".
2286 * Unfortunately, it turns out that we _do_ some special
2287 * handling of a disconnect event, namely complete all
2288 * pending transfers, notify gadget driver of the
2289 * disconnection, and so on.
2291 * Our suggested workaround is to follow the Disconnect
2292 * Event steps here, instead, based on a setup_packet_pending
2293 * flag. Such flag gets set whenever we have a SETUP_PENDING
2294 * status for EP0 TRBs and gets cleared on XferComplete for the
2299 * STAR#9000466709: RTL: Device : Disconnect event not
2300 * generated if setup packet pending in FIFO
2302 if (dwc->revision < DWC3_REVISION_188A) {
2303 if (dwc->setup_packet_pending)
2304 dwc3_gadget_disconnect_interrupt(dwc);
2307 dwc3_reset_gadget(dwc);
2309 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2310 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2311 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2312 dwc->test_mode = false;
2314 dwc3_stop_active_transfers(dwc);
2315 dwc3_clear_stall_all_ep(dwc);
2317 /* Reset device address to zero */
2318 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2319 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2320 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2323 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2326 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2329 * We change the clock only at SS but I dunno why I would want to do
2330 * this. Maybe it becomes part of the power saving plan.
2333 if (speed != DWC3_DSTS_SUPERSPEED)
2337 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2338 * each time on Connect Done.
2343 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2344 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2345 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2348 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2350 struct dwc3_ep *dep;
2355 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2356 speed = reg & DWC3_DSTS_CONNECTSPD;
2359 dwc3_update_ram_clk_sel(dwc, speed);
2362 case DWC3_DCFG_SUPERSPEED:
2364 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2365 * would cause a missing USB3 Reset event.
2367 * In such situations, we should force a USB3 Reset
2368 * event by calling our dwc3_gadget_reset_interrupt()
2373 * STAR#9000483510: RTL: SS : USB3 reset event may
2374 * not be generated always when the link enters poll
2376 if (dwc->revision < DWC3_REVISION_190A)
2377 dwc3_gadget_reset_interrupt(dwc);
2379 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2380 dwc->gadget.ep0->maxpacket = 512;
2381 dwc->gadget.speed = USB_SPEED_SUPER;
2383 case DWC3_DCFG_HIGHSPEED:
2384 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2385 dwc->gadget.ep0->maxpacket = 64;
2386 dwc->gadget.speed = USB_SPEED_HIGH;
2388 case DWC3_DCFG_FULLSPEED2:
2389 case DWC3_DCFG_FULLSPEED1:
2390 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2391 dwc->gadget.ep0->maxpacket = 64;
2392 dwc->gadget.speed = USB_SPEED_FULL;
2394 case DWC3_DCFG_LOWSPEED:
2395 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2396 dwc->gadget.ep0->maxpacket = 8;
2397 dwc->gadget.speed = USB_SPEED_LOW;
2401 /* Enable USB2 LPM Capability */
2403 if ((dwc->revision > DWC3_REVISION_194A)
2404 && (speed != DWC3_DCFG_SUPERSPEED)) {
2405 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2406 reg |= DWC3_DCFG_LPM_CAP;
2407 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2409 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2410 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2412 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2415 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2416 * DCFG.LPMCap is set, core responses with an ACK and the
2417 * BESL value in the LPM token is less than or equal to LPM
2420 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2421 && dwc->has_lpm_erratum,
2422 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2424 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2425 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2427 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2429 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2430 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2431 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2435 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2438 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2443 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2446 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2451 * Configure PHY via GUSB3PIPECTLn if required.
2453 * Update GTXFIFOSIZn
2455 * In both cases reset values should be sufficient.
2459 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2462 * TODO take core out of low power mode when that's
2466 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2467 spin_unlock(&dwc->lock);
2468 dwc->gadget_driver->resume(&dwc->gadget);
2469 spin_lock(&dwc->lock);
2473 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2474 unsigned int evtinfo)
2476 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2477 unsigned int pwropt;
2480 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2481 * Hibernation mode enabled which would show up when device detects
2482 * host-initiated U3 exit.
2484 * In that case, device will generate a Link State Change Interrupt
2485 * from U3 to RESUME which is only necessary if Hibernation is
2488 * There are no functional changes due to such spurious event and we
2489 * just need to ignore it.
2493 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2496 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2497 if ((dwc->revision < DWC3_REVISION_250A) &&
2498 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2499 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2500 (next == DWC3_LINK_STATE_RESUME)) {
2501 dwc3_trace(trace_dwc3_gadget,
2502 "ignoring transition U3 -> Resume");
2508 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2509 * on the link partner, the USB session might do multiple entry/exit
2510 * of low power states before a transfer takes place.
2512 * Due to this problem, we might experience lower throughput. The
2513 * suggested workaround is to disable DCTL[12:9] bits if we're
2514 * transitioning from U1/U2 to U0 and enable those bits again
2515 * after a transfer completes and there are no pending transfers
2516 * on any of the enabled endpoints.
2518 * This is the first half of that workaround.
2522 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2523 * core send LGO_Ux entering U0
2525 if (dwc->revision < DWC3_REVISION_183A) {
2526 if (next == DWC3_LINK_STATE_U0) {
2530 switch (dwc->link_state) {
2531 case DWC3_LINK_STATE_U1:
2532 case DWC3_LINK_STATE_U2:
2533 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2534 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2535 | DWC3_DCTL_ACCEPTU2ENA
2536 | DWC3_DCTL_INITU1ENA
2537 | DWC3_DCTL_ACCEPTU1ENA);
2540 dwc->u1u2 = reg & u1u2;
2544 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2554 case DWC3_LINK_STATE_U1:
2555 if (dwc->speed == USB_SPEED_SUPER)
2556 dwc3_suspend_gadget(dwc);
2558 case DWC3_LINK_STATE_U2:
2559 case DWC3_LINK_STATE_U3:
2560 dwc3_suspend_gadget(dwc);
2562 case DWC3_LINK_STATE_RESUME:
2563 dwc3_resume_gadget(dwc);
2570 dwc->link_state = next;
2573 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2574 unsigned int evtinfo)
2576 unsigned int is_ss = evtinfo & BIT(4);
2579 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2580 * have a known issue which can cause USB CV TD.9.23 to fail
2583 * Because of this issue, core could generate bogus hibernation
2584 * events which SW needs to ignore.
2588 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2589 * Device Fallback from SuperSpeed
2591 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2594 /* enter hibernation here */
2597 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2598 const struct dwc3_event_devt *event)
2600 switch (event->type) {
2601 case DWC3_DEVICE_EVENT_DISCONNECT:
2602 dwc3_gadget_disconnect_interrupt(dwc);
2604 case DWC3_DEVICE_EVENT_RESET:
2605 dwc3_gadget_reset_interrupt(dwc);
2607 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2608 dwc3_gadget_conndone_interrupt(dwc);
2610 case DWC3_DEVICE_EVENT_WAKEUP:
2611 dwc3_gadget_wakeup_interrupt(dwc);
2613 case DWC3_DEVICE_EVENT_HIBER_REQ:
2614 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2615 "unexpected hibernation event\n"))
2618 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2620 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2621 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2623 case DWC3_DEVICE_EVENT_EOPF:
2624 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2626 case DWC3_DEVICE_EVENT_SOF:
2627 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2629 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2630 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2632 case DWC3_DEVICE_EVENT_CMD_CMPL:
2633 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2635 case DWC3_DEVICE_EVENT_OVERFLOW:
2636 dwc3_trace(trace_dwc3_gadget, "Overflow");
2639 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2643 static void dwc3_process_event_entry(struct dwc3 *dwc,
2644 const union dwc3_event *event)
2646 trace_dwc3_event(event->raw);
2648 /* Endpoint IRQ, handle it and return early */
2649 if (event->type.is_devspec == 0) {
2651 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2654 switch (event->type.type) {
2655 case DWC3_EVENT_TYPE_DEV:
2656 dwc3_gadget_interrupt(dwc, &event->devt);
2658 /* REVISIT what to do with Carkit and I2C events ? */
2660 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2664 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2666 struct dwc3 *dwc = evt->dwc;
2667 irqreturn_t ret = IRQ_NONE;
2673 if (!(evt->flags & DWC3_EVENT_PENDING))
2677 union dwc3_event event;
2679 event.raw = *(u32 *) (evt->buf + evt->lpos);
2681 dwc3_process_event_entry(dwc, &event);
2684 * FIXME we wrap around correctly to the next entry as
2685 * almost all entries are 4 bytes in size. There is one
2686 * entry which has 12 bytes which is a regular entry
2687 * followed by 8 bytes data. ATM I don't know how
2688 * things are organized if we get next to the a
2689 * boundary so I worry about that once we try to handle
2692 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2695 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2699 evt->flags &= ~DWC3_EVENT_PENDING;
2702 /* Unmask interrupt */
2703 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2704 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2705 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2710 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2712 struct dwc3_event_buffer *evt = _evt;
2713 struct dwc3 *dwc = evt->dwc;
2714 unsigned long flags;
2715 irqreturn_t ret = IRQ_NONE;
2717 spin_lock_irqsave(&dwc->lock, flags);
2718 ret = dwc3_process_event_buf(evt);
2719 spin_unlock_irqrestore(&dwc->lock, flags);
2724 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2726 struct dwc3 *dwc = evt->dwc;
2730 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2731 count &= DWC3_GEVNTCOUNT_MASK;
2736 evt->flags |= DWC3_EVENT_PENDING;
2738 /* Mask interrupt */
2739 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2740 reg |= DWC3_GEVNTSIZ_INTMASK;
2741 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2743 return IRQ_WAKE_THREAD;
2746 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2748 struct dwc3_event_buffer *evt = _evt;
2750 return dwc3_check_event_buf(evt);
2754 * dwc3_gadget_init - Initializes gadget related registers
2755 * @dwc: pointer to our controller context structure
2757 * Returns 0 on success otherwise negative errno.
2759 int dwc3_gadget_init(struct dwc3 *dwc)
2763 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2764 &dwc->ctrl_req_addr, GFP_KERNEL);
2765 if (!dwc->ctrl_req) {
2766 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2771 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2772 &dwc->ep0_trb_addr, GFP_KERNEL);
2773 if (!dwc->ep0_trb) {
2774 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2779 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2780 if (!dwc->setup_buf) {
2785 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2786 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2788 if (!dwc->ep0_bounce) {
2789 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2794 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2795 if (!dwc->zlp_buf) {
2800 dwc->gadget.ops = &dwc3_gadget_ops;
2801 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2802 dwc->gadget.sg_supported = true;
2803 dwc->gadget.name = "dwc3-gadget";
2804 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2807 * FIXME We might be setting max_speed to <SUPER, however versions
2808 * <2.20a of dwc3 have an issue with metastability (documented
2809 * elsewhere in this driver) which tells us we can't set max speed to
2810 * anything lower than SUPER.
2812 * Because gadget.max_speed is only used by composite.c and function
2813 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2814 * to happen so we avoid sending SuperSpeed Capability descriptor
2815 * together with our BOS descriptor as that could confuse host into
2816 * thinking we can handle super speed.
2818 * Note that, in fact, we won't even support GetBOS requests when speed
2819 * is less than super speed because we don't have means, yet, to tell
2820 * composite.c that we are USB 2.0 + LPM ECN.
2822 if (dwc->revision < DWC3_REVISION_220A)
2823 dwc3_trace(trace_dwc3_gadget,
2824 "Changing max_speed on rev %08x\n",
2827 dwc->gadget.max_speed = dwc->maximum_speed;
2830 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2833 dwc->gadget.quirk_ep_out_aligned_size = true;
2836 * REVISIT: Here we should clear all pending IRQs to be
2837 * sure we're starting from a well known location.
2840 ret = dwc3_gadget_init_endpoints(dwc);
2844 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2846 dev_err(dwc->dev, "failed to register udc\n");
2853 kfree(dwc->zlp_buf);
2856 dwc3_gadget_free_endpoints(dwc);
2857 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2858 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2861 kfree(dwc->setup_buf);
2864 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2865 dwc->ep0_trb, dwc->ep0_trb_addr);
2868 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2869 dwc->ctrl_req, dwc->ctrl_req_addr);
2875 /* -------------------------------------------------------------------------- */
2877 void dwc3_gadget_exit(struct dwc3 *dwc)
2879 usb_del_gadget_udc(&dwc->gadget);
2881 dwc3_gadget_free_endpoints(dwc);
2883 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2884 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2886 kfree(dwc->setup_buf);
2887 kfree(dwc->zlp_buf);
2889 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2890 dwc->ep0_trb, dwc->ep0_trb_addr);
2892 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2893 dwc->ctrl_req, dwc->ctrl_req_addr);
2896 int dwc3_gadget_suspend(struct dwc3 *dwc)
2898 if (!dwc->gadget_driver)
2901 if (dwc->pullups_connected) {
2902 dwc3_gadget_disable_irq(dwc);
2903 dwc3_gadget_run_stop(dwc, true, true);
2906 __dwc3_gadget_ep_disable(dwc->eps[0]);
2907 __dwc3_gadget_ep_disable(dwc->eps[1]);
2909 dwc->dcfg = dwc3_readl(dwc->regs, DWC3_DCFG);
2914 int dwc3_gadget_resume(struct dwc3 *dwc)
2916 struct dwc3_ep *dep;
2919 if (!dwc->gadget_driver)
2922 /* Start with SuperSpeed Default */
2923 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2926 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2932 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2937 /* begin to receive SETUP packets */
2938 dwc->ep0state = EP0_SETUP_PHASE;
2939 dwc3_ep0_out_start(dwc);
2941 dwc3_writel(dwc->regs, DWC3_DCFG, dwc->dcfg);
2943 if (dwc->pullups_connected) {
2944 dwc3_gadget_enable_irq(dwc);
2945 dwc3_gadget_run_stop(dwc, true, false);
2951 __dwc3_gadget_ep_disable(dwc->eps[0]);