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_gadget_resize_tx_fifos - reallocate fifo spaces for current use-case
150 * @dwc: pointer to our context structure
152 * This function will a best effort FIFO allocation in order
153 * to improve FIFO usage and throughput, while still allowing
154 * us to enable as many endpoints as possible.
156 * Keep in mind that this operation will be highly dependent
157 * on the configured size for RAM1 - which contains TxFifo -,
158 * the amount of endpoints enabled on coreConsultant tool, and
159 * the width of the Master Bus.
161 * In the ideal world, we would always be able to satisfy the
162 * following equation:
164 * ((512 + 2 * MDWIDTH-Bytes) + (Number of IN Endpoints - 1) * \
165 * (3 * (1024 + MDWIDTH-Bytes) + MDWIDTH-Bytes)) / MDWIDTH-Bytes
167 * Unfortunately, due to many variables that's not always the case.
169 int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc)
171 int last_fifo_depth = 0;
177 if (!dwc->needs_fifo_resize)
180 ram1_depth = DWC3_RAM1_DEPTH(dwc->hwparams.hwparams7);
181 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
183 /* MDWIDTH is represented in bits, we need it in bytes */
187 * FIXME For now we will only allocate 1 wMaxPacketSize space
188 * for each enabled endpoint, later patches will come to
189 * improve this algorithm so that we better use the internal
192 for (num = 0; num < dwc->num_in_eps; num++) {
193 /* bit0 indicates direction; 1 means IN ep */
194 struct dwc3_ep *dep = dwc->eps[(num << 1) | 1];
198 if (!(dep->flags & DWC3_EP_ENABLED))
201 if (usb_endpoint_xfer_bulk(dep->endpoint.desc)
202 || usb_endpoint_xfer_isoc(dep->endpoint.desc))
206 * REVISIT: the following assumes we will always have enough
207 * space available on the FIFO RAM for all possible use cases.
208 * Make sure that's true somehow and change FIFO allocation
211 * If we have Bulk or Isochronous endpoints, we want
212 * them to be able to be very, very fast. So we're giving
213 * those endpoints a fifo_size which is enough for 3 full
216 tmp = mult * (dep->endpoint.maxpacket + mdwidth);
219 fifo_size = DIV_ROUND_UP(tmp, mdwidth);
221 fifo_size |= (last_fifo_depth << 16);
223 dwc3_trace(trace_dwc3_gadget, "%s: Fifo Addr %04x Size %d",
224 dep->name, last_fifo_depth, fifo_size & 0xffff);
226 dwc3_writel(dwc->regs, DWC3_GTXFIFOSIZ(num), fifo_size);
228 last_fifo_depth += (fifo_size & 0xffff);
234 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
237 struct dwc3 *dwc = dep->dwc;
245 * Skip LINK TRB. We can't use req->trb and check for
246 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
247 * just completed (not the LINK TRB).
249 if (((dep->busy_slot & DWC3_TRB_MASK) ==
251 usb_endpoint_xfer_isoc(dep->endpoint.desc))
253 } while(++i < req->request.num_mapped_sgs);
256 list_del(&req->list);
259 if (req->request.status == -EINPROGRESS)
260 req->request.status = status;
262 if (dwc->ep0_bounced && dep->number <= 1)
263 dwc->ep0_bounced = false;
265 usb_gadget_unmap_request(&dwc->gadget, &req->request,
268 dev_dbg(dwc->dev, "request %p from %s completed %d/%d ===> %d\n",
269 req, dep->name, req->request.actual,
270 req->request.length, status);
271 trace_dwc3_gadget_giveback(req);
273 spin_unlock(&dwc->lock);
274 usb_gadget_giveback_request(&dep->endpoint, &req->request);
275 spin_lock(&dwc->lock);
278 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
283 trace_dwc3_gadget_generic_cmd(cmd, param);
285 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
286 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
289 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
290 if (!(reg & DWC3_DGCMD_CMDACT)) {
291 dwc3_trace(trace_dwc3_gadget,
292 "Command Complete --> %d",
293 DWC3_DGCMD_STATUS(reg));
294 if (DWC3_DGCMD_STATUS(reg))
300 * We can't sleep here, because it's also called from
305 dwc3_trace(trace_dwc3_gadget,
306 "Command Timed Out");
313 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
314 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
316 struct dwc3_ep *dep = dwc->eps[ep];
320 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
322 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
323 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
324 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
326 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
328 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
329 if (!(reg & DWC3_DEPCMD_CMDACT)) {
330 dwc3_trace(trace_dwc3_gadget,
331 "Command Complete --> %d",
332 DWC3_DEPCMD_STATUS(reg));
333 if (DWC3_DEPCMD_STATUS(reg))
339 * We can't sleep here, because it is also called from
344 dwc3_trace(trace_dwc3_gadget,
345 "Command Timed Out");
353 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
354 struct dwc3_trb *trb)
356 u32 offset = (char *) trb - (char *) dep->trb_pool;
358 return dep->trb_pool_dma + offset;
361 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
363 struct dwc3 *dwc = dep->dwc;
368 dep->trb_pool = dma_alloc_coherent(dwc->dev,
369 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
370 &dep->trb_pool_dma, GFP_KERNEL);
371 if (!dep->trb_pool) {
372 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
380 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
382 struct dwc3 *dwc = dep->dwc;
384 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
385 dep->trb_pool, dep->trb_pool_dma);
387 dep->trb_pool = NULL;
388 dep->trb_pool_dma = 0;
391 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
394 * dwc3_gadget_start_config - Configure EP resources
395 * @dwc: pointer to our controller context structure
396 * @dep: endpoint that is being enabled
398 * The assignment of transfer resources cannot perfectly follow the
399 * data book due to the fact that the controller driver does not have
400 * all knowledge of the configuration in advance. It is given this
401 * information piecemeal by the composite gadget framework after every
402 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
403 * programming model in this scenario can cause errors. For two
406 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
407 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
408 * multiple interfaces.
410 * 2) The databook does not mention doing more DEPXFERCFG for new
411 * endpoint on alt setting (8.1.6).
413 * The following simplified method is used instead:
415 * All hardware endpoints can be assigned a transfer resource and this
416 * setting will stay persistent until either a core reset or
417 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
418 * do DEPXFERCFG for every hardware endpoint as well. We are
419 * guaranteed that there are as many transfer resources as endpoints.
421 * This function is called for each endpoint when it is being enabled
422 * but is triggered only when called for EP0-out, which always happens
423 * first, and which should only happen in one of the above conditions.
425 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
427 struct dwc3_gadget_ep_cmd_params params;
435 memset(¶ms, 0x00, sizeof(params));
436 cmd = DWC3_DEPCMD_DEPSTARTCFG;
438 ret = dwc3_send_gadget_ep_cmd(dwc, 0, cmd, ¶ms);
442 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
443 struct dwc3_ep *dep = dwc->eps[i];
448 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
456 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
457 const struct usb_endpoint_descriptor *desc,
458 const struct usb_ss_ep_comp_descriptor *comp_desc,
459 bool ignore, bool restore)
461 struct dwc3_gadget_ep_cmd_params params;
463 memset(¶ms, 0x00, sizeof(params));
465 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
466 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
468 /* Burst size is only needed in SuperSpeed mode */
469 if (dwc->gadget.speed == USB_SPEED_SUPER) {
470 u32 burst = dep->endpoint.maxburst - 1;
472 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst);
476 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
479 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
480 params.param2 |= dep->saved_state;
483 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
484 | DWC3_DEPCFG_XFER_NOT_READY_EN;
486 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
487 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
488 | DWC3_DEPCFG_STREAM_EVENT_EN;
489 dep->stream_capable = true;
492 if (!usb_endpoint_xfer_control(desc))
493 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
496 * We are doing 1:1 mapping for endpoints, meaning
497 * Physical Endpoints 2 maps to Logical Endpoint 2 and
498 * so on. We consider the direction bit as part of the physical
499 * endpoint number. So USB endpoint 0x81 is 0x03.
501 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
504 * We must use the lower 16 TX FIFOs even though
508 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
510 if (desc->bInterval) {
511 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
512 dep->interval = 1 << (desc->bInterval - 1);
515 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
516 DWC3_DEPCMD_SETEPCONFIG, ¶ms);
519 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
521 struct dwc3_gadget_ep_cmd_params params;
523 memset(¶ms, 0x00, sizeof(params));
525 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
527 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
528 DWC3_DEPCMD_SETTRANSFRESOURCE, ¶ms);
532 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
533 * @dep: endpoint to be initialized
534 * @desc: USB Endpoint Descriptor
536 * Caller should take care of locking
538 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
539 const struct usb_endpoint_descriptor *desc,
540 const struct usb_ss_ep_comp_descriptor *comp_desc,
541 bool ignore, bool restore)
543 struct dwc3 *dwc = dep->dwc;
547 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
549 if (!(dep->flags & DWC3_EP_ENABLED)) {
550 ret = dwc3_gadget_start_config(dwc, dep);
555 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
560 if (!(dep->flags & DWC3_EP_ENABLED)) {
561 struct dwc3_trb *trb_st_hw;
562 struct dwc3_trb *trb_link;
564 dep->endpoint.desc = desc;
565 dep->comp_desc = comp_desc;
566 dep->type = usb_endpoint_type(desc);
567 dep->flags |= DWC3_EP_ENABLED;
569 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
570 reg |= DWC3_DALEPENA_EP(dep->number);
571 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
573 if (!usb_endpoint_xfer_isoc(desc))
576 /* Link TRB for ISOC. The HWO bit is never reset */
577 trb_st_hw = &dep->trb_pool[0];
579 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
580 memset(trb_link, 0, sizeof(*trb_link));
582 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
583 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
584 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
585 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
588 switch (usb_endpoint_type(desc)) {
589 case USB_ENDPOINT_XFER_CONTROL:
590 strlcat(dep->name, "-control", sizeof(dep->name));
592 case USB_ENDPOINT_XFER_ISOC:
593 strlcat(dep->name, "-isoc", sizeof(dep->name));
595 case USB_ENDPOINT_XFER_BULK:
596 strlcat(dep->name, "-bulk", sizeof(dep->name));
598 case USB_ENDPOINT_XFER_INT:
599 strlcat(dep->name, "-int", sizeof(dep->name));
602 dev_err(dwc->dev, "invalid endpoint transfer type\n");
608 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
609 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
611 struct dwc3_request *req;
613 if (!list_empty(&dep->req_queued)) {
614 dwc3_stop_active_transfer(dwc, dep->number, true);
616 /* - giveback all requests to gadget driver */
617 while (!list_empty(&dep->req_queued)) {
618 req = next_request(&dep->req_queued);
620 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
624 while (!list_empty(&dep->request_list)) {
625 req = next_request(&dep->request_list);
627 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
632 * __dwc3_gadget_ep_disable - Disables a HW endpoint
633 * @dep: the endpoint to disable
635 * This function also removes requests which are currently processed ny the
636 * hardware and those which are not yet scheduled.
637 * Caller should take care of locking.
639 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
641 struct dwc3 *dwc = dep->dwc;
644 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
646 dwc3_remove_requests(dwc, dep);
648 /* make sure HW endpoint isn't stalled */
649 if (dep->flags & DWC3_EP_STALL)
650 __dwc3_gadget_ep_set_halt(dep, 0, false);
652 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
653 reg &= ~DWC3_DALEPENA_EP(dep->number);
654 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
656 dep->stream_capable = false;
657 dep->endpoint.desc = NULL;
658 dep->comp_desc = NULL;
662 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
664 (dep->number & 1) ? "in" : "out");
669 /* -------------------------------------------------------------------------- */
671 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
672 const struct usb_endpoint_descriptor *desc)
677 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
682 /* -------------------------------------------------------------------------- */
684 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
685 const struct usb_endpoint_descriptor *desc)
692 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
693 pr_debug("dwc3: invalid parameters\n");
697 if (!desc->wMaxPacketSize) {
698 pr_debug("dwc3: missing wMaxPacketSize\n");
702 dep = to_dwc3_ep(ep);
705 if (dep->flags & DWC3_EP_ENABLED) {
706 dev_WARN_ONCE(dwc->dev, true, "%s is already enabled\n",
711 spin_lock_irqsave(&dwc->lock, flags);
712 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
713 spin_unlock_irqrestore(&dwc->lock, flags);
718 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
726 pr_debug("dwc3: invalid parameters\n");
730 dep = to_dwc3_ep(ep);
733 if (!(dep->flags & DWC3_EP_ENABLED)) {
734 dev_WARN_ONCE(dwc->dev, true, "%s is already disabled\n",
739 spin_lock_irqsave(&dwc->lock, flags);
740 ret = __dwc3_gadget_ep_disable(dep);
741 spin_unlock_irqrestore(&dwc->lock, flags);
746 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
749 struct dwc3_request *req;
750 struct dwc3_ep *dep = to_dwc3_ep(ep);
752 req = kzalloc(sizeof(*req), gfp_flags);
756 req->epnum = dep->number;
759 trace_dwc3_alloc_request(req);
761 return &req->request;
764 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
765 struct usb_request *request)
767 struct dwc3_request *req = to_dwc3_request(request);
769 trace_dwc3_free_request(req);
774 * dwc3_prepare_one_trb - setup one TRB from one request
775 * @dep: endpoint for which this request is prepared
776 * @req: dwc3_request pointer
778 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
779 struct dwc3_request *req, dma_addr_t dma,
780 unsigned length, unsigned last, unsigned chain, unsigned node)
782 struct dwc3_trb *trb;
784 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
785 dep->name, req, (unsigned long long) dma,
786 length, last ? " last" : "",
787 chain ? " chain" : "");
790 trb = &dep->trb_pool[dep->free_slot & DWC3_TRB_MASK];
793 dwc3_gadget_move_request_queued(req);
795 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
796 req->start_slot = dep->free_slot & DWC3_TRB_MASK;
800 /* Skip the LINK-TRB on ISOC */
801 if (((dep->free_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
802 usb_endpoint_xfer_isoc(dep->endpoint.desc))
805 trb->size = DWC3_TRB_SIZE_LENGTH(length);
806 trb->bpl = lower_32_bits(dma);
807 trb->bph = upper_32_bits(dma);
809 switch (usb_endpoint_type(dep->endpoint.desc)) {
810 case USB_ENDPOINT_XFER_CONTROL:
811 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
814 case USB_ENDPOINT_XFER_ISOC:
816 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
818 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
821 case USB_ENDPOINT_XFER_BULK:
822 case USB_ENDPOINT_XFER_INT:
823 trb->ctrl = DWC3_TRBCTL_NORMAL;
827 * This is only possible with faulty memory because we
828 * checked it already :)
833 if (!req->request.no_interrupt && !chain)
834 trb->ctrl |= DWC3_TRB_CTRL_IOC;
836 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
837 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
838 trb->ctrl |= DWC3_TRB_CTRL_CSP;
840 trb->ctrl |= DWC3_TRB_CTRL_LST;
844 trb->ctrl |= DWC3_TRB_CTRL_CHN;
846 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
847 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
849 trb->ctrl |= DWC3_TRB_CTRL_HWO;
851 trace_dwc3_prepare_trb(dep, trb);
855 * dwc3_prepare_trbs - setup TRBs from requests
856 * @dep: endpoint for which requests are being prepared
857 * @starting: true if the endpoint is idle and no requests are queued.
859 * The function goes through the requests list and sets up TRBs for the
860 * transfers. The function returns once there are no more TRBs available or
861 * it runs out of requests.
863 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
865 struct dwc3_request *req, *n;
868 unsigned int last_one = 0;
870 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
872 /* the first request must not be queued */
873 trbs_left = (dep->busy_slot - dep->free_slot) & DWC3_TRB_MASK;
875 /* Can't wrap around on a non-isoc EP since there's no link TRB */
876 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
877 max = DWC3_TRB_NUM - (dep->free_slot & DWC3_TRB_MASK);
883 * If busy & slot are equal than it is either full or empty. If we are
884 * starting to process requests then we are empty. Otherwise we are
885 * full and don't do anything
890 trbs_left = DWC3_TRB_NUM;
892 * In case we start from scratch, we queue the ISOC requests
893 * starting from slot 1. This is done because we use ring
894 * buffer and have no LST bit to stop us. Instead, we place
895 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
896 * after the first request so we start at slot 1 and have
897 * 7 requests proceed before we hit the first IOC.
898 * Other transfer types don't use the ring buffer and are
899 * processed from the first TRB until the last one. Since we
900 * don't wrap around we have to start at the beginning.
902 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
911 /* The last TRB is a link TRB, not used for xfer */
912 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->endpoint.desc))
915 list_for_each_entry_safe(req, n, &dep->request_list, list) {
920 if (req->request.num_mapped_sgs > 0) {
921 struct usb_request *request = &req->request;
922 struct scatterlist *sg = request->sg;
923 struct scatterlist *s;
926 for_each_sg(sg, s, request->num_mapped_sgs, i) {
927 unsigned chain = true;
929 length = sg_dma_len(s);
930 dma = sg_dma_address(s);
932 if (i == (request->num_mapped_sgs - 1) ||
934 if (list_empty(&dep->request_list))
946 dwc3_prepare_one_trb(dep, req, dma, length,
956 dma = req->request.dma;
957 length = req->request.length;
963 /* Is this the last request? */
964 if (list_is_last(&req->list, &dep->request_list))
967 dwc3_prepare_one_trb(dep, req, dma, length,
976 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
979 struct dwc3_gadget_ep_cmd_params params;
980 struct dwc3_request *req;
981 struct dwc3 *dwc = dep->dwc;
985 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
986 dwc3_trace(trace_dwc3_gadget, "%s: endpoint busy", dep->name);
991 * If we are getting here after a short-out-packet we don't enqueue any
992 * new requests as we try to set the IOC bit only on the last request.
995 if (list_empty(&dep->req_queued))
996 dwc3_prepare_trbs(dep, start_new);
998 /* req points to the first request which will be sent */
999 req = next_request(&dep->req_queued);
1001 dwc3_prepare_trbs(dep, start_new);
1004 * req points to the first request where HWO changed from 0 to 1
1006 req = next_request(&dep->req_queued);
1009 dep->flags |= DWC3_EP_PENDING_REQUEST;
1013 memset(¶ms, 0, sizeof(params));
1016 params.param0 = upper_32_bits(req->trb_dma);
1017 params.param1 = lower_32_bits(req->trb_dma);
1018 cmd = DWC3_DEPCMD_STARTTRANSFER;
1020 cmd = DWC3_DEPCMD_UPDATETRANSFER;
1023 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
1024 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
1026 dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");
1029 * FIXME we need to iterate over the list of requests
1030 * here and stop, unmap, free and del each of the linked
1031 * requests instead of what we do now.
1033 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1035 list_del(&req->list);
1039 dep->flags |= DWC3_EP_BUSY;
1042 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
1044 WARN_ON_ONCE(!dep->resource_index);
1050 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1051 struct dwc3_ep *dep, u32 cur_uf)
1055 if (list_empty(&dep->request_list)) {
1056 dwc3_trace(trace_dwc3_gadget,
1057 "ISOC ep %s run out for requests",
1059 dep->flags |= DWC3_EP_PENDING_REQUEST;
1063 /* 4 micro frames in the future */
1064 uf = cur_uf + dep->interval * 4;
1066 __dwc3_gadget_kick_transfer(dep, uf, 1);
1069 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1070 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1074 mask = ~(dep->interval - 1);
1075 cur_uf = event->parameters & mask;
1077 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1080 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1082 struct dwc3 *dwc = dep->dwc;
1085 req->request.actual = 0;
1086 req->request.status = -EINPROGRESS;
1087 req->direction = dep->direction;
1088 req->epnum = dep->number;
1090 trace_dwc3_ep_queue(req);
1093 * We only add to our list of requests now and
1094 * start consuming the list once we get XferNotReady
1097 * That way, we avoid doing anything that we don't need
1098 * to do now and defer it until the point we receive a
1099 * particular token from the Host side.
1101 * This will also avoid Host cancelling URBs due to too
1104 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1109 list_add_tail(&req->list, &dep->request_list);
1112 * If there are no pending requests and the endpoint isn't already
1113 * busy, we will just start the request straight away.
1115 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1116 * little bit faster.
1118 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1119 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1120 !(dep->flags & DWC3_EP_BUSY)) {
1121 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1126 * There are a few special cases:
1128 * 1. XferNotReady with empty list of requests. We need to kick the
1129 * transfer here in that situation, otherwise we will be NAKing
1130 * forever. If we get XferNotReady before gadget driver has a
1131 * chance to queue a request, we will ACK the IRQ but won't be
1132 * able to receive the data until the next request is queued.
1133 * The following code is handling exactly that.
1136 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1138 * If xfernotready is already elapsed and it is a case
1139 * of isoc transfer, then issue END TRANSFER, so that
1140 * you can receive xfernotready again and can have
1141 * notion of current microframe.
1143 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1144 if (list_empty(&dep->req_queued)) {
1145 dwc3_stop_active_transfer(dwc, dep->number, true);
1146 dep->flags = DWC3_EP_ENABLED;
1151 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1153 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1159 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1160 * kick the transfer here after queuing a request, otherwise the
1161 * core may not see the modified TRB(s).
1163 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1164 (dep->flags & DWC3_EP_BUSY) &&
1165 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1166 WARN_ON_ONCE(!dep->resource_index);
1167 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index,
1173 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1174 * right away, otherwise host will not know we have streams to be
1177 if (dep->stream_capable)
1178 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1181 if (ret && ret != -EBUSY)
1182 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1190 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1193 struct dwc3_request *req = to_dwc3_request(request);
1194 struct dwc3_ep *dep = to_dwc3_ep(ep);
1195 struct dwc3 *dwc = dep->dwc;
1197 unsigned long flags;
1201 spin_lock_irqsave(&dwc->lock, flags);
1202 if (!dep->endpoint.desc) {
1203 dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",
1209 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1210 request, req->dep->name)) {
1215 ret = __dwc3_gadget_ep_queue(dep, req);
1218 spin_unlock_irqrestore(&dwc->lock, flags);
1223 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1224 struct usb_request *request)
1226 struct dwc3_request *req = to_dwc3_request(request);
1227 struct dwc3_request *r = NULL;
1229 struct dwc3_ep *dep = to_dwc3_ep(ep);
1230 struct dwc3 *dwc = dep->dwc;
1232 unsigned long flags;
1235 trace_dwc3_ep_dequeue(req);
1237 spin_lock_irqsave(&dwc->lock, flags);
1239 list_for_each_entry(r, &dep->request_list, list) {
1245 list_for_each_entry(r, &dep->req_queued, list) {
1250 /* wait until it is processed */
1251 dwc3_stop_active_transfer(dwc, dep->number, true);
1254 dev_err(dwc->dev, "request %p was not queued to %s\n",
1261 /* giveback the request */
1262 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1265 spin_unlock_irqrestore(&dwc->lock, flags);
1270 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1272 struct dwc3_gadget_ep_cmd_params params;
1273 struct dwc3 *dwc = dep->dwc;
1276 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1277 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1281 memset(¶ms, 0x00, sizeof(params));
1284 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1285 (!list_empty(&dep->req_queued) ||
1286 !list_empty(&dep->request_list)))) {
1287 dev_dbg(dwc->dev, "%s: pending request, cannot halt\n",
1292 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1293 DWC3_DEPCMD_SETSTALL, ¶ms);
1295 dev_err(dwc->dev, "failed to set STALL on %s\n",
1298 dep->flags |= DWC3_EP_STALL;
1300 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1301 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1303 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1306 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1312 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1314 struct dwc3_ep *dep = to_dwc3_ep(ep);
1315 struct dwc3 *dwc = dep->dwc;
1317 unsigned long flags;
1321 spin_lock_irqsave(&dwc->lock, flags);
1322 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1323 spin_unlock_irqrestore(&dwc->lock, flags);
1328 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1330 struct dwc3_ep *dep = to_dwc3_ep(ep);
1331 struct dwc3 *dwc = dep->dwc;
1332 unsigned long flags;
1335 spin_lock_irqsave(&dwc->lock, flags);
1336 dep->flags |= DWC3_EP_WEDGE;
1338 if (dep->number == 0 || dep->number == 1)
1339 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1341 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1342 spin_unlock_irqrestore(&dwc->lock, flags);
1347 /* -------------------------------------------------------------------------- */
1349 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1350 .bLength = USB_DT_ENDPOINT_SIZE,
1351 .bDescriptorType = USB_DT_ENDPOINT,
1352 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1355 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1356 .enable = dwc3_gadget_ep0_enable,
1357 .disable = dwc3_gadget_ep0_disable,
1358 .alloc_request = dwc3_gadget_ep_alloc_request,
1359 .free_request = dwc3_gadget_ep_free_request,
1360 .queue = dwc3_gadget_ep0_queue,
1361 .dequeue = dwc3_gadget_ep_dequeue,
1362 .set_halt = dwc3_gadget_ep0_set_halt,
1363 .set_wedge = dwc3_gadget_ep_set_wedge,
1366 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1367 .enable = dwc3_gadget_ep_enable,
1368 .disable = dwc3_gadget_ep_disable,
1369 .alloc_request = dwc3_gadget_ep_alloc_request,
1370 .free_request = dwc3_gadget_ep_free_request,
1371 .queue = dwc3_gadget_ep_queue,
1372 .dequeue = dwc3_gadget_ep_dequeue,
1373 .set_halt = dwc3_gadget_ep_set_halt,
1374 .set_wedge = dwc3_gadget_ep_set_wedge,
1377 /* -------------------------------------------------------------------------- */
1379 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1381 struct dwc3 *dwc = gadget_to_dwc(g);
1384 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1385 return DWC3_DSTS_SOFFN(reg);
1388 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1390 struct dwc3 *dwc = gadget_to_dwc(g);
1392 unsigned long timeout;
1393 unsigned long flags;
1402 spin_lock_irqsave(&dwc->lock, flags);
1405 * According to the Databook Remote wakeup request should
1406 * be issued only when the device is in early suspend state.
1408 * We can check that via USB Link State bits in DSTS register.
1410 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1412 speed = reg & DWC3_DSTS_CONNECTSPD;
1413 if (speed == DWC3_DSTS_SUPERSPEED) {
1414 dev_dbg(dwc->dev, "no wakeup on SuperSpeed\n");
1419 link_state = DWC3_DSTS_USBLNKST(reg);
1421 switch (link_state) {
1422 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1423 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1426 dev_dbg(dwc->dev, "can't wakeup from link state %d\n",
1432 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1434 dev_err(dwc->dev, "failed to put link in Recovery\n");
1438 /* Recent versions do this automatically */
1439 if (dwc->revision < DWC3_REVISION_194A) {
1440 /* write zeroes to Link Change Request */
1441 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1442 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1443 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1446 /* poll until Link State changes to ON */
1447 timeout = jiffies + msecs_to_jiffies(100);
1449 while (!time_after(jiffies, timeout)) {
1450 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1452 /* in HS, means ON */
1453 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1457 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1458 dev_err(dwc->dev, "failed to send remote wakeup\n");
1463 spin_unlock_irqrestore(&dwc->lock, flags);
1468 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1471 struct dwc3 *dwc = gadget_to_dwc(g);
1472 unsigned long flags;
1474 spin_lock_irqsave(&dwc->lock, flags);
1475 g->is_selfpowered = !!is_selfpowered;
1476 spin_unlock_irqrestore(&dwc->lock, flags);
1481 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1486 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1488 if (dwc->revision <= DWC3_REVISION_187A) {
1489 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1490 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1493 if (dwc->revision >= DWC3_REVISION_194A)
1494 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1495 reg |= DWC3_DCTL_RUN_STOP;
1497 if (dwc->has_hibernation)
1498 reg |= DWC3_DCTL_KEEP_CONNECT;
1500 dwc->pullups_connected = true;
1502 reg &= ~DWC3_DCTL_RUN_STOP;
1504 if (dwc->has_hibernation && !suspend)
1505 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1507 dwc->pullups_connected = false;
1510 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1513 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1515 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1518 if (reg & DWC3_DSTS_DEVCTRLHLT)
1527 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1529 ? dwc->gadget_driver->function : "no-function",
1530 is_on ? "connect" : "disconnect");
1535 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1537 struct dwc3 *dwc = gadget_to_dwc(g);
1538 unsigned long flags;
1543 spin_lock_irqsave(&dwc->lock, flags);
1544 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1545 spin_unlock_irqrestore(&dwc->lock, flags);
1550 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1554 /* Enable all but Start and End of Frame IRQs */
1555 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1556 DWC3_DEVTEN_EVNTOVERFLOWEN |
1557 DWC3_DEVTEN_CMDCMPLTEN |
1558 DWC3_DEVTEN_ERRTICERREN |
1559 DWC3_DEVTEN_WKUPEVTEN |
1560 DWC3_DEVTEN_ULSTCNGEN |
1561 DWC3_DEVTEN_CONNECTDONEEN |
1562 DWC3_DEVTEN_USBRSTEN |
1563 DWC3_DEVTEN_DISCONNEVTEN);
1565 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1568 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1570 /* mask all interrupts */
1571 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1574 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1575 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1577 static int dwc3_gadget_start(struct usb_gadget *g,
1578 struct usb_gadget_driver *driver)
1580 struct dwc3 *dwc = gadget_to_dwc(g);
1581 struct dwc3_ep *dep;
1582 unsigned long flags;
1587 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1588 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1589 IRQF_SHARED, "dwc3", dwc);
1591 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1596 spin_lock_irqsave(&dwc->lock, flags);
1598 if (dwc->gadget_driver) {
1599 dev_err(dwc->dev, "%s is already bound to %s\n",
1601 dwc->gadget_driver->driver.name);
1606 dwc->gadget_driver = driver;
1608 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1609 reg &= ~(DWC3_DCFG_SPEED_MASK);
1612 * WORKAROUND: DWC3 revision < 2.20a have an issue
1613 * which would cause metastability state on Run/Stop
1614 * bit if we try to force the IP to USB2-only mode.
1616 * Because of that, we cannot configure the IP to any
1617 * speed other than the SuperSpeed
1621 * STAR#9000525659: Clock Domain Crossing on DCTL in
1624 if (dwc->revision < DWC3_REVISION_220A) {
1625 reg |= DWC3_DCFG_SUPERSPEED;
1627 switch (dwc->maximum_speed) {
1629 reg |= DWC3_DSTS_LOWSPEED;
1631 case USB_SPEED_FULL:
1632 reg |= DWC3_DSTS_FULLSPEED1;
1634 case USB_SPEED_HIGH:
1635 reg |= DWC3_DSTS_HIGHSPEED;
1637 case USB_SPEED_SUPER: /* FALLTHROUGH */
1638 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1640 reg |= DWC3_DSTS_SUPERSPEED;
1643 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1645 /* Start with SuperSpeed Default */
1646 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1649 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1652 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1657 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1660 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1664 /* begin to receive SETUP packets */
1665 dwc->ep0state = EP0_SETUP_PHASE;
1666 dwc3_ep0_out_start(dwc);
1668 dwc3_gadget_enable_irq(dwc);
1670 spin_unlock_irqrestore(&dwc->lock, flags);
1675 __dwc3_gadget_ep_disable(dwc->eps[0]);
1678 dwc->gadget_driver = NULL;
1681 spin_unlock_irqrestore(&dwc->lock, flags);
1689 static int dwc3_gadget_stop(struct usb_gadget *g)
1691 struct dwc3 *dwc = gadget_to_dwc(g);
1692 unsigned long flags;
1695 spin_lock_irqsave(&dwc->lock, flags);
1697 dwc3_gadget_disable_irq(dwc);
1698 __dwc3_gadget_ep_disable(dwc->eps[0]);
1699 __dwc3_gadget_ep_disable(dwc->eps[1]);
1701 dwc->gadget_driver = NULL;
1703 spin_unlock_irqrestore(&dwc->lock, flags);
1705 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1711 static const struct usb_gadget_ops dwc3_gadget_ops = {
1712 .get_frame = dwc3_gadget_get_frame,
1713 .wakeup = dwc3_gadget_wakeup,
1714 .set_selfpowered = dwc3_gadget_set_selfpowered,
1715 .pullup = dwc3_gadget_pullup,
1716 .udc_start = dwc3_gadget_start,
1717 .udc_stop = dwc3_gadget_stop,
1720 /* -------------------------------------------------------------------------- */
1722 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1723 u8 num, u32 direction)
1725 struct dwc3_ep *dep;
1728 for (i = 0; i < num; i++) {
1729 u8 epnum = (i << 1) | (!!direction);
1731 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1736 dep->number = epnum;
1737 dep->direction = !!direction;
1738 dwc->eps[epnum] = dep;
1740 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1741 (epnum & 1) ? "in" : "out");
1743 dep->endpoint.name = dep->name;
1745 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1747 if (epnum == 0 || epnum == 1) {
1748 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1749 dep->endpoint.maxburst = 1;
1750 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1752 dwc->gadget.ep0 = &dep->endpoint;
1756 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1757 dep->endpoint.max_streams = 15;
1758 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1759 list_add_tail(&dep->endpoint.ep_list,
1760 &dwc->gadget.ep_list);
1762 ret = dwc3_alloc_trb_pool(dep);
1767 if (epnum == 0 || epnum == 1) {
1768 dep->endpoint.caps.type_control = true;
1770 dep->endpoint.caps.type_iso = true;
1771 dep->endpoint.caps.type_bulk = true;
1772 dep->endpoint.caps.type_int = true;
1775 dep->endpoint.caps.dir_in = !!direction;
1776 dep->endpoint.caps.dir_out = !direction;
1778 INIT_LIST_HEAD(&dep->request_list);
1779 INIT_LIST_HEAD(&dep->req_queued);
1785 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1789 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1791 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1793 dwc3_trace(trace_dwc3_gadget,
1794 "failed to allocate OUT endpoints");
1798 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1800 dwc3_trace(trace_dwc3_gadget,
1801 "failed to allocate IN endpoints");
1808 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1810 struct dwc3_ep *dep;
1813 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1814 dep = dwc->eps[epnum];
1818 * Physical endpoints 0 and 1 are special; they form the
1819 * bi-directional USB endpoint 0.
1821 * For those two physical endpoints, we don't allocate a TRB
1822 * pool nor do we add them the endpoints list. Due to that, we
1823 * shouldn't do these two operations otherwise we would end up
1824 * with all sorts of bugs when removing dwc3.ko.
1826 if (epnum != 0 && epnum != 1) {
1827 dwc3_free_trb_pool(dep);
1828 list_del(&dep->endpoint.ep_list);
1835 /* -------------------------------------------------------------------------- */
1837 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1838 struct dwc3_request *req, struct dwc3_trb *trb,
1839 const struct dwc3_event_depevt *event, int status)
1842 unsigned int s_pkt = 0;
1843 unsigned int trb_status;
1845 trace_dwc3_complete_trb(dep, trb);
1847 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1849 * We continue despite the error. There is not much we
1850 * can do. If we don't clean it up we loop forever. If
1851 * we skip the TRB then it gets overwritten after a
1852 * while since we use them in a ring buffer. A BUG()
1853 * would help. Lets hope that if this occurs, someone
1854 * fixes the root cause instead of looking away :)
1856 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1858 count = trb->size & DWC3_TRB_SIZE_MASK;
1860 if (dep->direction) {
1862 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1863 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1864 dev_dbg(dwc->dev, "incomplete IN transfer %s\n",
1867 * If missed isoc occurred and there is
1868 * no request queued then issue END
1869 * TRANSFER, so that core generates
1870 * next xfernotready and we will issue
1871 * a fresh START TRANSFER.
1872 * If there are still queued request
1873 * then wait, do not issue either END
1874 * or UPDATE TRANSFER, just attach next
1875 * request in request_list during
1876 * giveback.If any future queued request
1877 * is successfully transferred then we
1878 * will issue UPDATE TRANSFER for all
1879 * request in the request_list.
1881 dep->flags |= DWC3_EP_MISSED_ISOC;
1883 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1885 status = -ECONNRESET;
1888 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1891 if (count && (event->status & DEPEVT_STATUS_SHORT))
1897 if ((event->status & DEPEVT_STATUS_LST) &&
1898 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1899 DWC3_TRB_CTRL_HWO)))
1901 if ((event->status & DEPEVT_STATUS_IOC) &&
1902 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1907 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1908 const struct dwc3_event_depevt *event, int status)
1910 struct dwc3_request *req;
1911 struct dwc3_trb *trb;
1918 req = next_request(&dep->req_queued);
1925 slot = req->start_slot + i;
1926 if ((slot == DWC3_TRB_NUM - 1) &&
1927 usb_endpoint_xfer_isoc(dep->endpoint.desc))
1929 slot %= DWC3_TRB_NUM;
1930 trb = &dep->trb_pool[slot];
1931 count += trb->size & DWC3_TRB_SIZE_MASK;
1934 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1938 } while (++i < req->request.num_mapped_sgs);
1941 * We assume here we will always receive the entire data block
1942 * which we should receive. Meaning, if we program RX to
1943 * receive 4K but we receive only 2K, we assume that's all we
1944 * should receive and we simply bounce the request back to the
1945 * gadget driver for further processing.
1947 req->request.actual += req->request.length - count;
1948 dwc3_gadget_giveback(dep, req, status);
1954 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1955 list_empty(&dep->req_queued)) {
1956 if (list_empty(&dep->request_list)) {
1958 * If there is no entry in request list then do
1959 * not issue END TRANSFER now. Just set PENDING
1960 * flag, so that END TRANSFER is issued when an
1961 * entry is added into request list.
1963 dep->flags = DWC3_EP_PENDING_REQUEST;
1965 dwc3_stop_active_transfer(dwc, dep->number, true);
1966 dep->flags = DWC3_EP_ENABLED;
1971 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1972 if ((event->status & DEPEVT_STATUS_IOC) &&
1973 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1978 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
1979 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1981 unsigned status = 0;
1983 u32 is_xfer_complete;
1985 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
1987 if (event->status & DEPEVT_STATUS_BUSERR)
1988 status = -ECONNRESET;
1990 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
1991 if (clean_busy && (is_xfer_complete ||
1992 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
1993 dep->flags &= ~DWC3_EP_BUSY;
1996 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
1997 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
1999 if (dwc->revision < DWC3_REVISION_183A) {
2003 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2006 if (!(dep->flags & DWC3_EP_ENABLED))
2009 if (!list_empty(&dep->req_queued))
2013 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2015 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2020 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2023 ret = __dwc3_gadget_kick_transfer(dep, 0, is_xfer_complete);
2024 if (!ret || ret == -EBUSY)
2029 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2030 const struct dwc3_event_depevt *event)
2032 struct dwc3_ep *dep;
2033 u8 epnum = event->endpoint_number;
2035 dep = dwc->eps[epnum];
2037 if (!(dep->flags & DWC3_EP_ENABLED))
2040 if (epnum == 0 || epnum == 1) {
2041 dwc3_ep0_interrupt(dwc, event);
2045 switch (event->endpoint_event) {
2046 case DWC3_DEPEVT_XFERCOMPLETE:
2047 dep->resource_index = 0;
2049 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2050 dev_dbg(dwc->dev, "%s is an Isochronous endpoint\n",
2055 dwc3_endpoint_transfer_complete(dwc, dep, event);
2057 case DWC3_DEPEVT_XFERINPROGRESS:
2058 dwc3_endpoint_transfer_complete(dwc, dep, event);
2060 case DWC3_DEPEVT_XFERNOTREADY:
2061 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2062 dwc3_gadget_start_isoc(dwc, dep, event);
2067 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2069 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2070 dep->name, active ? "Transfer Active"
2071 : "Transfer Not Active");
2073 ret = __dwc3_gadget_kick_transfer(dep, 0, !active);
2074 if (!ret || ret == -EBUSY)
2077 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
2082 case DWC3_DEPEVT_STREAMEVT:
2083 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2084 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2089 switch (event->status) {
2090 case DEPEVT_STREAMEVT_FOUND:
2091 dwc3_trace(trace_dwc3_gadget,
2092 "Stream %d found and started",
2096 case DEPEVT_STREAMEVT_NOTFOUND:
2099 dev_dbg(dwc->dev, "Couldn't find suitable stream\n");
2102 case DWC3_DEPEVT_RXTXFIFOEVT:
2103 dev_dbg(dwc->dev, "%s FIFO Overrun\n", dep->name);
2105 case DWC3_DEPEVT_EPCMDCMPLT:
2106 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2111 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2113 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2114 spin_unlock(&dwc->lock);
2115 dwc->gadget_driver->disconnect(&dwc->gadget);
2116 spin_lock(&dwc->lock);
2120 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2122 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2123 spin_unlock(&dwc->lock);
2124 dwc->gadget_driver->suspend(&dwc->gadget);
2125 spin_lock(&dwc->lock);
2129 static void dwc3_resume_gadget(struct dwc3 *dwc)
2131 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2132 spin_unlock(&dwc->lock);
2133 dwc->gadget_driver->resume(&dwc->gadget);
2134 spin_lock(&dwc->lock);
2138 static void dwc3_reset_gadget(struct dwc3 *dwc)
2140 if (!dwc->gadget_driver)
2143 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2144 spin_unlock(&dwc->lock);
2145 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2146 spin_lock(&dwc->lock);
2150 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2152 struct dwc3_ep *dep;
2153 struct dwc3_gadget_ep_cmd_params params;
2157 dep = dwc->eps[epnum];
2159 if (!dep->resource_index)
2163 * NOTICE: We are violating what the Databook says about the
2164 * EndTransfer command. Ideally we would _always_ wait for the
2165 * EndTransfer Command Completion IRQ, but that's causing too
2166 * much trouble synchronizing between us and gadget driver.
2168 * We have discussed this with the IP Provider and it was
2169 * suggested to giveback all requests here, but give HW some
2170 * extra time to synchronize with the interconnect. We're using
2171 * an arbitrary 100us delay for that.
2173 * Note also that a similar handling was tested by Synopsys
2174 * (thanks a lot Paul) and nothing bad has come out of it.
2175 * In short, what we're doing is:
2177 * - Issue EndTransfer WITH CMDIOC bit set
2181 cmd = DWC3_DEPCMD_ENDTRANSFER;
2182 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2183 cmd |= DWC3_DEPCMD_CMDIOC;
2184 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2185 memset(¶ms, 0, sizeof(params));
2186 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
2188 dep->resource_index = 0;
2189 dep->flags &= ~DWC3_EP_BUSY;
2193 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2197 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2198 struct dwc3_ep *dep;
2200 dep = dwc->eps[epnum];
2204 if (!(dep->flags & DWC3_EP_ENABLED))
2207 dwc3_remove_requests(dwc, dep);
2211 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2215 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2216 struct dwc3_ep *dep;
2217 struct dwc3_gadget_ep_cmd_params params;
2220 dep = dwc->eps[epnum];
2224 if (!(dep->flags & DWC3_EP_STALL))
2227 dep->flags &= ~DWC3_EP_STALL;
2229 memset(¶ms, 0, sizeof(params));
2230 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
2231 DWC3_DEPCMD_CLEARSTALL, ¶ms);
2236 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2240 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2241 reg &= ~DWC3_DCTL_INITU1ENA;
2242 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2244 reg &= ~DWC3_DCTL_INITU2ENA;
2245 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2247 dwc3_disconnect_gadget(dwc);
2249 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2250 dwc->setup_packet_pending = false;
2251 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2254 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2259 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2260 * would cause a missing Disconnect Event if there's a
2261 * pending Setup Packet in the FIFO.
2263 * There's no suggested workaround on the official Bug
2264 * report, which states that "unless the driver/application
2265 * is doing any special handling of a disconnect event,
2266 * there is no functional issue".
2268 * Unfortunately, it turns out that we _do_ some special
2269 * handling of a disconnect event, namely complete all
2270 * pending transfers, notify gadget driver of the
2271 * disconnection, and so on.
2273 * Our suggested workaround is to follow the Disconnect
2274 * Event steps here, instead, based on a setup_packet_pending
2275 * flag. Such flag gets set whenever we have a XferNotReady
2276 * event on EP0 and gets cleared on XferComplete for the
2281 * STAR#9000466709: RTL: Device : Disconnect event not
2282 * generated if setup packet pending in FIFO
2284 if (dwc->revision < DWC3_REVISION_188A) {
2285 if (dwc->setup_packet_pending)
2286 dwc3_gadget_disconnect_interrupt(dwc);
2289 dwc3_reset_gadget(dwc);
2291 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2292 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2293 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2294 dwc->test_mode = false;
2296 dwc3_stop_active_transfers(dwc);
2297 dwc3_clear_stall_all_ep(dwc);
2299 /* Reset device address to zero */
2300 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2301 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2302 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2305 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2308 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2311 * We change the clock only at SS but I dunno why I would want to do
2312 * this. Maybe it becomes part of the power saving plan.
2315 if (speed != DWC3_DSTS_SUPERSPEED)
2319 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2320 * each time on Connect Done.
2325 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2326 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2327 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2330 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2332 struct dwc3_ep *dep;
2337 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2338 speed = reg & DWC3_DSTS_CONNECTSPD;
2341 dwc3_update_ram_clk_sel(dwc, speed);
2344 case DWC3_DCFG_SUPERSPEED:
2346 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2347 * would cause a missing USB3 Reset event.
2349 * In such situations, we should force a USB3 Reset
2350 * event by calling our dwc3_gadget_reset_interrupt()
2355 * STAR#9000483510: RTL: SS : USB3 reset event may
2356 * not be generated always when the link enters poll
2358 if (dwc->revision < DWC3_REVISION_190A)
2359 dwc3_gadget_reset_interrupt(dwc);
2361 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2362 dwc->gadget.ep0->maxpacket = 512;
2363 dwc->gadget.speed = USB_SPEED_SUPER;
2365 case DWC3_DCFG_HIGHSPEED:
2366 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2367 dwc->gadget.ep0->maxpacket = 64;
2368 dwc->gadget.speed = USB_SPEED_HIGH;
2370 case DWC3_DCFG_FULLSPEED2:
2371 case DWC3_DCFG_FULLSPEED1:
2372 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2373 dwc->gadget.ep0->maxpacket = 64;
2374 dwc->gadget.speed = USB_SPEED_FULL;
2376 case DWC3_DCFG_LOWSPEED:
2377 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2378 dwc->gadget.ep0->maxpacket = 8;
2379 dwc->gadget.speed = USB_SPEED_LOW;
2383 /* Enable USB2 LPM Capability */
2385 if ((dwc->revision > DWC3_REVISION_194A)
2386 && (speed != DWC3_DCFG_SUPERSPEED)) {
2387 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2388 reg |= DWC3_DCFG_LPM_CAP;
2389 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2391 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2392 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2394 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2397 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2398 * DCFG.LPMCap is set, core responses with an ACK and the
2399 * BESL value in the LPM token is less than or equal to LPM
2402 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2403 && dwc->has_lpm_erratum,
2404 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2406 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2407 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2409 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2411 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2412 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2413 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2417 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2420 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2425 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2428 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2433 * Configure PHY via GUSB3PIPECTLn if required.
2435 * Update GTXFIFOSIZn
2437 * In both cases reset values should be sufficient.
2441 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2444 * TODO take core out of low power mode when that's
2448 dwc->gadget_driver->resume(&dwc->gadget);
2451 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2452 unsigned int evtinfo)
2454 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2455 unsigned int pwropt;
2458 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2459 * Hibernation mode enabled which would show up when device detects
2460 * host-initiated U3 exit.
2462 * In that case, device will generate a Link State Change Interrupt
2463 * from U3 to RESUME which is only necessary if Hibernation is
2466 * There are no functional changes due to such spurious event and we
2467 * just need to ignore it.
2471 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2474 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2475 if ((dwc->revision < DWC3_REVISION_250A) &&
2476 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2477 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2478 (next == DWC3_LINK_STATE_RESUME)) {
2479 dwc3_trace(trace_dwc3_gadget,
2480 "ignoring transition U3 -> Resume");
2486 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2487 * on the link partner, the USB session might do multiple entry/exit
2488 * of low power states before a transfer takes place.
2490 * Due to this problem, we might experience lower throughput. The
2491 * suggested workaround is to disable DCTL[12:9] bits if we're
2492 * transitioning from U1/U2 to U0 and enable those bits again
2493 * after a transfer completes and there are no pending transfers
2494 * on any of the enabled endpoints.
2496 * This is the first half of that workaround.
2500 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2501 * core send LGO_Ux entering U0
2503 if (dwc->revision < DWC3_REVISION_183A) {
2504 if (next == DWC3_LINK_STATE_U0) {
2508 switch (dwc->link_state) {
2509 case DWC3_LINK_STATE_U1:
2510 case DWC3_LINK_STATE_U2:
2511 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2512 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2513 | DWC3_DCTL_ACCEPTU2ENA
2514 | DWC3_DCTL_INITU1ENA
2515 | DWC3_DCTL_ACCEPTU1ENA);
2518 dwc->u1u2 = reg & u1u2;
2522 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2532 case DWC3_LINK_STATE_U1:
2533 if (dwc->speed == USB_SPEED_SUPER)
2534 dwc3_suspend_gadget(dwc);
2536 case DWC3_LINK_STATE_U2:
2537 case DWC3_LINK_STATE_U3:
2538 dwc3_suspend_gadget(dwc);
2540 case DWC3_LINK_STATE_RESUME:
2541 dwc3_resume_gadget(dwc);
2548 dwc->link_state = next;
2551 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2552 unsigned int evtinfo)
2554 unsigned int is_ss = evtinfo & BIT(4);
2557 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2558 * have a known issue which can cause USB CV TD.9.23 to fail
2561 * Because of this issue, core could generate bogus hibernation
2562 * events which SW needs to ignore.
2566 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2567 * Device Fallback from SuperSpeed
2569 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2572 /* enter hibernation here */
2575 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2576 const struct dwc3_event_devt *event)
2578 switch (event->type) {
2579 case DWC3_DEVICE_EVENT_DISCONNECT:
2580 dwc3_gadget_disconnect_interrupt(dwc);
2582 case DWC3_DEVICE_EVENT_RESET:
2583 dwc3_gadget_reset_interrupt(dwc);
2585 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2586 dwc3_gadget_conndone_interrupt(dwc);
2588 case DWC3_DEVICE_EVENT_WAKEUP:
2589 dwc3_gadget_wakeup_interrupt(dwc);
2591 case DWC3_DEVICE_EVENT_HIBER_REQ:
2592 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2593 "unexpected hibernation event\n"))
2596 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2598 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2599 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2601 case DWC3_DEVICE_EVENT_EOPF:
2602 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2604 case DWC3_DEVICE_EVENT_SOF:
2605 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2607 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2608 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2610 case DWC3_DEVICE_EVENT_CMD_CMPL:
2611 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2613 case DWC3_DEVICE_EVENT_OVERFLOW:
2614 dwc3_trace(trace_dwc3_gadget, "Overflow");
2617 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2621 static void dwc3_process_event_entry(struct dwc3 *dwc,
2622 const union dwc3_event *event)
2624 trace_dwc3_event(event->raw);
2626 /* Endpoint IRQ, handle it and return early */
2627 if (event->type.is_devspec == 0) {
2629 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2632 switch (event->type.type) {
2633 case DWC3_EVENT_TYPE_DEV:
2634 dwc3_gadget_interrupt(dwc, &event->devt);
2636 /* REVISIT what to do with Carkit and I2C events ? */
2638 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2642 static irqreturn_t dwc3_process_event_buf(struct dwc3 *dwc, u32 buf)
2644 struct dwc3_event_buffer *evt;
2645 irqreturn_t ret = IRQ_NONE;
2649 evt = dwc->ev_buffs[buf];
2652 if (!(evt->flags & DWC3_EVENT_PENDING))
2656 union dwc3_event event;
2658 event.raw = *(u32 *) (evt->buf + evt->lpos);
2660 dwc3_process_event_entry(dwc, &event);
2663 * FIXME we wrap around correctly to the next entry as
2664 * almost all entries are 4 bytes in size. There is one
2665 * entry which has 12 bytes which is a regular entry
2666 * followed by 8 bytes data. ATM I don't know how
2667 * things are organized if we get next to the a
2668 * boundary so I worry about that once we try to handle
2671 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2674 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(buf), 4);
2678 evt->flags &= ~DWC3_EVENT_PENDING;
2681 /* Unmask interrupt */
2682 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(buf));
2683 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2684 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(buf), reg);
2689 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc)
2691 struct dwc3 *dwc = _dwc;
2692 unsigned long flags;
2693 irqreturn_t ret = IRQ_NONE;
2696 spin_lock_irqsave(&dwc->lock, flags);
2698 for (i = 0; i < dwc->num_event_buffers; i++)
2699 ret |= dwc3_process_event_buf(dwc, i);
2701 spin_unlock_irqrestore(&dwc->lock, flags);
2706 static irqreturn_t dwc3_check_event_buf(struct dwc3 *dwc, u32 buf)
2708 struct dwc3_event_buffer *evt;
2712 evt = dwc->ev_buffs[buf];
2714 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(buf));
2715 count &= DWC3_GEVNTCOUNT_MASK;
2720 evt->flags |= DWC3_EVENT_PENDING;
2722 /* Mask interrupt */
2723 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(buf));
2724 reg |= DWC3_GEVNTSIZ_INTMASK;
2725 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(buf), reg);
2727 return IRQ_WAKE_THREAD;
2730 static irqreturn_t dwc3_interrupt(int irq, void *_dwc)
2732 struct dwc3 *dwc = _dwc;
2734 irqreturn_t ret = IRQ_NONE;
2736 for (i = 0; i < dwc->num_event_buffers; i++) {
2739 status = dwc3_check_event_buf(dwc, i);
2740 if (status == IRQ_WAKE_THREAD)
2748 * dwc3_gadget_init - Initializes gadget related registers
2749 * @dwc: pointer to our controller context structure
2751 * Returns 0 on success otherwise negative errno.
2753 int dwc3_gadget_init(struct dwc3 *dwc)
2757 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2758 &dwc->ctrl_req_addr, GFP_KERNEL);
2759 if (!dwc->ctrl_req) {
2760 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2765 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2766 &dwc->ep0_trb_addr, GFP_KERNEL);
2767 if (!dwc->ep0_trb) {
2768 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2773 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2774 if (!dwc->setup_buf) {
2779 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2780 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2782 if (!dwc->ep0_bounce) {
2783 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2788 dwc->gadget.ops = &dwc3_gadget_ops;
2789 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2790 dwc->gadget.sg_supported = true;
2791 dwc->gadget.name = "dwc3-gadget";
2794 * FIXME We might be setting max_speed to <SUPER, however versions
2795 * <2.20a of dwc3 have an issue with metastability (documented
2796 * elsewhere in this driver) which tells us we can't set max speed to
2797 * anything lower than SUPER.
2799 * Because gadget.max_speed is only used by composite.c and function
2800 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2801 * to happen so we avoid sending SuperSpeed Capability descriptor
2802 * together with our BOS descriptor as that could confuse host into
2803 * thinking we can handle super speed.
2805 * Note that, in fact, we won't even support GetBOS requests when speed
2806 * is less than super speed because we don't have means, yet, to tell
2807 * composite.c that we are USB 2.0 + LPM ECN.
2809 if (dwc->revision < DWC3_REVISION_220A)
2810 dwc3_trace(trace_dwc3_gadget,
2811 "Changing max_speed on rev %08x\n",
2814 dwc->gadget.max_speed = dwc->maximum_speed;
2817 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2820 dwc->gadget.quirk_ep_out_aligned_size = true;
2823 * REVISIT: Here we should clear all pending IRQs to be
2824 * sure we're starting from a well known location.
2827 ret = dwc3_gadget_init_endpoints(dwc);
2831 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2833 dev_err(dwc->dev, "failed to register udc\n");
2840 dwc3_gadget_free_endpoints(dwc);
2841 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2842 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2845 kfree(dwc->setup_buf);
2848 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2849 dwc->ep0_trb, dwc->ep0_trb_addr);
2852 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2853 dwc->ctrl_req, dwc->ctrl_req_addr);
2859 /* -------------------------------------------------------------------------- */
2861 void dwc3_gadget_exit(struct dwc3 *dwc)
2863 usb_del_gadget_udc(&dwc->gadget);
2865 dwc3_gadget_free_endpoints(dwc);
2867 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2868 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2870 kfree(dwc->setup_buf);
2872 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2873 dwc->ep0_trb, dwc->ep0_trb_addr);
2875 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2876 dwc->ctrl_req, dwc->ctrl_req_addr);
2879 int dwc3_gadget_suspend(struct dwc3 *dwc)
2881 if (dwc->pullups_connected) {
2882 dwc3_gadget_disable_irq(dwc);
2883 dwc3_gadget_run_stop(dwc, true, true);
2886 __dwc3_gadget_ep_disable(dwc->eps[0]);
2887 __dwc3_gadget_ep_disable(dwc->eps[1]);
2889 dwc->dcfg = dwc3_readl(dwc->regs, DWC3_DCFG);
2894 int dwc3_gadget_resume(struct dwc3 *dwc)
2896 struct dwc3_ep *dep;
2899 /* Start with SuperSpeed Default */
2900 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2903 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2909 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2914 /* begin to receive SETUP packets */
2915 dwc->ep0state = EP0_SETUP_PHASE;
2916 dwc3_ep0_out_start(dwc);
2918 dwc3_writel(dwc->regs, DWC3_DCFG, dwc->dcfg);
2920 if (dwc->pullups_connected) {
2921 dwc3_gadget_enable_irq(dwc);
2922 dwc3_gadget_run_stop(dwc, true, false);
2928 __dwc3_gadget_ep_disable(dwc->eps[0]);