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 == 0)
263 dwc->ep0_bounced = false;
265 usb_gadget_unmap_request(&dwc->gadget, &req->request,
268 trace_dwc3_gadget_giveback(req);
270 spin_unlock(&dwc->lock);
271 usb_gadget_giveback_request(&dep->endpoint, &req->request);
272 spin_lock(&dwc->lock);
275 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
280 trace_dwc3_gadget_generic_cmd(cmd, param);
282 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
283 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
286 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
287 if (!(reg & DWC3_DGCMD_CMDACT)) {
288 dwc3_trace(trace_dwc3_gadget,
289 "Command Complete --> %d",
290 DWC3_DGCMD_STATUS(reg));
291 if (DWC3_DGCMD_STATUS(reg))
297 * We can't sleep here, because it's also called from
302 dwc3_trace(trace_dwc3_gadget,
303 "Command Timed Out");
310 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
311 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
313 struct dwc3_ep *dep = dwc->eps[ep];
317 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
319 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
320 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
321 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
323 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
325 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
326 if (!(reg & DWC3_DEPCMD_CMDACT)) {
327 dwc3_trace(trace_dwc3_gadget,
328 "Command Complete --> %d",
329 DWC3_DEPCMD_STATUS(reg));
330 if (DWC3_DEPCMD_STATUS(reg))
336 * We can't sleep here, because it is also called from
341 dwc3_trace(trace_dwc3_gadget,
342 "Command Timed Out");
350 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
351 struct dwc3_trb *trb)
353 u32 offset = (char *) trb - (char *) dep->trb_pool;
355 return dep->trb_pool_dma + offset;
358 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
360 struct dwc3 *dwc = dep->dwc;
365 dep->trb_pool = dma_alloc_coherent(dwc->dev,
366 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
367 &dep->trb_pool_dma, GFP_KERNEL);
368 if (!dep->trb_pool) {
369 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
377 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
379 struct dwc3 *dwc = dep->dwc;
381 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
382 dep->trb_pool, dep->trb_pool_dma);
384 dep->trb_pool = NULL;
385 dep->trb_pool_dma = 0;
388 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
391 * dwc3_gadget_start_config - Configure EP resources
392 * @dwc: pointer to our controller context structure
393 * @dep: endpoint that is being enabled
395 * The assignment of transfer resources cannot perfectly follow the
396 * data book due to the fact that the controller driver does not have
397 * all knowledge of the configuration in advance. It is given this
398 * information piecemeal by the composite gadget framework after every
399 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
400 * programming model in this scenario can cause errors. For two
403 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
404 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
405 * multiple interfaces.
407 * 2) The databook does not mention doing more DEPXFERCFG for new
408 * endpoint on alt setting (8.1.6).
410 * The following simplified method is used instead:
412 * All hardware endpoints can be assigned a transfer resource and this
413 * setting will stay persistent until either a core reset or
414 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
415 * do DEPXFERCFG for every hardware endpoint as well. We are
416 * guaranteed that there are as many transfer resources as endpoints.
418 * This function is called for each endpoint when it is being enabled
419 * but is triggered only when called for EP0-out, which always happens
420 * first, and which should only happen in one of the above conditions.
422 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
424 struct dwc3_gadget_ep_cmd_params params;
432 memset(¶ms, 0x00, sizeof(params));
433 cmd = DWC3_DEPCMD_DEPSTARTCFG;
435 ret = dwc3_send_gadget_ep_cmd(dwc, 0, cmd, ¶ms);
439 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
440 struct dwc3_ep *dep = dwc->eps[i];
445 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
453 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
454 const struct usb_endpoint_descriptor *desc,
455 const struct usb_ss_ep_comp_descriptor *comp_desc,
456 bool ignore, bool restore)
458 struct dwc3_gadget_ep_cmd_params params;
460 memset(¶ms, 0x00, sizeof(params));
462 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
463 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
465 /* Burst size is only needed in SuperSpeed mode */
466 if (dwc->gadget.speed == USB_SPEED_SUPER) {
467 u32 burst = dep->endpoint.maxburst - 1;
469 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst);
473 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
476 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
477 params.param2 |= dep->saved_state;
480 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
481 | DWC3_DEPCFG_XFER_NOT_READY_EN;
483 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
484 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
485 | DWC3_DEPCFG_STREAM_EVENT_EN;
486 dep->stream_capable = true;
489 if (!usb_endpoint_xfer_control(desc))
490 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
493 * We are doing 1:1 mapping for endpoints, meaning
494 * Physical Endpoints 2 maps to Logical Endpoint 2 and
495 * so on. We consider the direction bit as part of the physical
496 * endpoint number. So USB endpoint 0x81 is 0x03.
498 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
501 * We must use the lower 16 TX FIFOs even though
505 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
507 if (desc->bInterval) {
508 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
509 dep->interval = 1 << (desc->bInterval - 1);
512 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
513 DWC3_DEPCMD_SETEPCONFIG, ¶ms);
516 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
518 struct dwc3_gadget_ep_cmd_params params;
520 memset(¶ms, 0x00, sizeof(params));
522 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
524 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
525 DWC3_DEPCMD_SETTRANSFRESOURCE, ¶ms);
529 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
530 * @dep: endpoint to be initialized
531 * @desc: USB Endpoint Descriptor
533 * Caller should take care of locking
535 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
536 const struct usb_endpoint_descriptor *desc,
537 const struct usb_ss_ep_comp_descriptor *comp_desc,
538 bool ignore, bool restore)
540 struct dwc3 *dwc = dep->dwc;
544 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
546 if (!(dep->flags & DWC3_EP_ENABLED)) {
547 ret = dwc3_gadget_start_config(dwc, dep);
552 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
557 if (!(dep->flags & DWC3_EP_ENABLED)) {
558 struct dwc3_trb *trb_st_hw;
559 struct dwc3_trb *trb_link;
561 dep->endpoint.desc = desc;
562 dep->comp_desc = comp_desc;
563 dep->type = usb_endpoint_type(desc);
564 dep->flags |= DWC3_EP_ENABLED;
566 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
567 reg |= DWC3_DALEPENA_EP(dep->number);
568 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
570 if (!usb_endpoint_xfer_isoc(desc))
573 /* Link TRB for ISOC. The HWO bit is never reset */
574 trb_st_hw = &dep->trb_pool[0];
576 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
577 memset(trb_link, 0, sizeof(*trb_link));
579 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
580 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
581 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
582 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
585 switch (usb_endpoint_type(desc)) {
586 case USB_ENDPOINT_XFER_CONTROL:
587 strlcat(dep->name, "-control", sizeof(dep->name));
589 case USB_ENDPOINT_XFER_ISOC:
590 strlcat(dep->name, "-isoc", sizeof(dep->name));
592 case USB_ENDPOINT_XFER_BULK:
593 strlcat(dep->name, "-bulk", sizeof(dep->name));
595 case USB_ENDPOINT_XFER_INT:
596 strlcat(dep->name, "-int", sizeof(dep->name));
599 dev_err(dwc->dev, "invalid endpoint transfer type\n");
605 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
606 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
608 struct dwc3_request *req;
610 if (!list_empty(&dep->req_queued)) {
611 dwc3_stop_active_transfer(dwc, dep->number, true);
613 /* - giveback all requests to gadget driver */
614 while (!list_empty(&dep->req_queued)) {
615 req = next_request(&dep->req_queued);
617 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
621 while (!list_empty(&dep->request_list)) {
622 req = next_request(&dep->request_list);
624 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
629 * __dwc3_gadget_ep_disable - Disables a HW endpoint
630 * @dep: the endpoint to disable
632 * This function also removes requests which are currently processed ny the
633 * hardware and those which are not yet scheduled.
634 * Caller should take care of locking.
636 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
638 struct dwc3 *dwc = dep->dwc;
641 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
643 dwc3_remove_requests(dwc, dep);
645 /* make sure HW endpoint isn't stalled */
646 if (dep->flags & DWC3_EP_STALL)
647 __dwc3_gadget_ep_set_halt(dep, 0, false);
649 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
650 reg &= ~DWC3_DALEPENA_EP(dep->number);
651 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
653 dep->stream_capable = false;
654 dep->endpoint.desc = NULL;
655 dep->comp_desc = NULL;
659 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
661 (dep->number & 1) ? "in" : "out");
666 /* -------------------------------------------------------------------------- */
668 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
669 const struct usb_endpoint_descriptor *desc)
674 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
679 /* -------------------------------------------------------------------------- */
681 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
682 const struct usb_endpoint_descriptor *desc)
689 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
690 pr_debug("dwc3: invalid parameters\n");
694 if (!desc->wMaxPacketSize) {
695 pr_debug("dwc3: missing wMaxPacketSize\n");
699 dep = to_dwc3_ep(ep);
702 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
703 "%s is already enabled\n",
707 spin_lock_irqsave(&dwc->lock, flags);
708 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
709 spin_unlock_irqrestore(&dwc->lock, flags);
714 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
722 pr_debug("dwc3: invalid parameters\n");
726 dep = to_dwc3_ep(ep);
729 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
730 "%s is already disabled\n",
734 spin_lock_irqsave(&dwc->lock, flags);
735 ret = __dwc3_gadget_ep_disable(dep);
736 spin_unlock_irqrestore(&dwc->lock, flags);
741 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
744 struct dwc3_request *req;
745 struct dwc3_ep *dep = to_dwc3_ep(ep);
747 req = kzalloc(sizeof(*req), gfp_flags);
751 req->epnum = dep->number;
754 trace_dwc3_alloc_request(req);
756 return &req->request;
759 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
760 struct usb_request *request)
762 struct dwc3_request *req = to_dwc3_request(request);
764 trace_dwc3_free_request(req);
769 * dwc3_prepare_one_trb - setup one TRB from one request
770 * @dep: endpoint for which this request is prepared
771 * @req: dwc3_request pointer
773 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
774 struct dwc3_request *req, dma_addr_t dma,
775 unsigned length, unsigned last, unsigned chain, unsigned node)
777 struct dwc3_trb *trb;
779 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
780 dep->name, req, (unsigned long long) dma,
781 length, last ? " last" : "",
782 chain ? " chain" : "");
785 trb = &dep->trb_pool[dep->free_slot & DWC3_TRB_MASK];
788 dwc3_gadget_move_request_queued(req);
790 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
791 req->start_slot = dep->free_slot & DWC3_TRB_MASK;
795 /* Skip the LINK-TRB on ISOC */
796 if (((dep->free_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
797 usb_endpoint_xfer_isoc(dep->endpoint.desc))
800 trb->size = DWC3_TRB_SIZE_LENGTH(length);
801 trb->bpl = lower_32_bits(dma);
802 trb->bph = upper_32_bits(dma);
804 switch (usb_endpoint_type(dep->endpoint.desc)) {
805 case USB_ENDPOINT_XFER_CONTROL:
806 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
809 case USB_ENDPOINT_XFER_ISOC:
811 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
813 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
816 case USB_ENDPOINT_XFER_BULK:
817 case USB_ENDPOINT_XFER_INT:
818 trb->ctrl = DWC3_TRBCTL_NORMAL;
822 * This is only possible with faulty memory because we
823 * checked it already :)
828 if (!req->request.no_interrupt && !chain)
829 trb->ctrl |= DWC3_TRB_CTRL_IOC;
831 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
832 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
833 trb->ctrl |= DWC3_TRB_CTRL_CSP;
835 trb->ctrl |= DWC3_TRB_CTRL_LST;
839 trb->ctrl |= DWC3_TRB_CTRL_CHN;
841 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
842 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
844 trb->ctrl |= DWC3_TRB_CTRL_HWO;
846 trace_dwc3_prepare_trb(dep, trb);
850 * dwc3_prepare_trbs - setup TRBs from requests
851 * @dep: endpoint for which requests are being prepared
852 * @starting: true if the endpoint is idle and no requests are queued.
854 * The function goes through the requests list and sets up TRBs for the
855 * transfers. The function returns once there are no more TRBs available or
856 * it runs out of requests.
858 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
860 struct dwc3_request *req, *n;
863 unsigned int last_one = 0;
865 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
867 /* the first request must not be queued */
868 trbs_left = (dep->busy_slot - dep->free_slot) & DWC3_TRB_MASK;
870 /* Can't wrap around on a non-isoc EP since there's no link TRB */
871 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
872 max = DWC3_TRB_NUM - (dep->free_slot & DWC3_TRB_MASK);
878 * If busy & slot are equal than it is either full or empty. If we are
879 * starting to process requests then we are empty. Otherwise we are
880 * full and don't do anything
885 trbs_left = DWC3_TRB_NUM;
887 * In case we start from scratch, we queue the ISOC requests
888 * starting from slot 1. This is done because we use ring
889 * buffer and have no LST bit to stop us. Instead, we place
890 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
891 * after the first request so we start at slot 1 and have
892 * 7 requests proceed before we hit the first IOC.
893 * Other transfer types don't use the ring buffer and are
894 * processed from the first TRB until the last one. Since we
895 * don't wrap around we have to start at the beginning.
897 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
906 /* The last TRB is a link TRB, not used for xfer */
907 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->endpoint.desc))
910 list_for_each_entry_safe(req, n, &dep->request_list, list) {
915 if (req->request.num_mapped_sgs > 0) {
916 struct usb_request *request = &req->request;
917 struct scatterlist *sg = request->sg;
918 struct scatterlist *s;
921 for_each_sg(sg, s, request->num_mapped_sgs, i) {
922 unsigned chain = true;
924 length = sg_dma_len(s);
925 dma = sg_dma_address(s);
927 if (i == (request->num_mapped_sgs - 1) ||
929 if (list_empty(&dep->request_list))
941 dwc3_prepare_one_trb(dep, req, dma, length,
951 dma = req->request.dma;
952 length = req->request.length;
958 /* Is this the last request? */
959 if (list_is_last(&req->list, &dep->request_list))
962 dwc3_prepare_one_trb(dep, req, dma, length,
971 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
974 struct dwc3_gadget_ep_cmd_params params;
975 struct dwc3_request *req;
976 struct dwc3 *dwc = dep->dwc;
980 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
981 dwc3_trace(trace_dwc3_gadget, "%s: endpoint busy", dep->name);
986 * If we are getting here after a short-out-packet we don't enqueue any
987 * new requests as we try to set the IOC bit only on the last request.
990 if (list_empty(&dep->req_queued))
991 dwc3_prepare_trbs(dep, start_new);
993 /* req points to the first request which will be sent */
994 req = next_request(&dep->req_queued);
996 dwc3_prepare_trbs(dep, start_new);
999 * req points to the first request where HWO changed from 0 to 1
1001 req = next_request(&dep->req_queued);
1004 dep->flags |= DWC3_EP_PENDING_REQUEST;
1008 memset(¶ms, 0, sizeof(params));
1011 params.param0 = upper_32_bits(req->trb_dma);
1012 params.param1 = lower_32_bits(req->trb_dma);
1013 cmd = DWC3_DEPCMD_STARTTRANSFER;
1015 cmd = DWC3_DEPCMD_UPDATETRANSFER;
1018 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
1019 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
1022 * FIXME we need to iterate over the list of requests
1023 * here and stop, unmap, free and del each of the linked
1024 * requests instead of what we do now.
1026 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1028 list_del(&req->list);
1032 dep->flags |= DWC3_EP_BUSY;
1035 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
1037 WARN_ON_ONCE(!dep->resource_index);
1043 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1044 struct dwc3_ep *dep, u32 cur_uf)
1048 if (list_empty(&dep->request_list)) {
1049 dwc3_trace(trace_dwc3_gadget,
1050 "ISOC ep %s run out for requests",
1052 dep->flags |= DWC3_EP_PENDING_REQUEST;
1056 /* 4 micro frames in the future */
1057 uf = cur_uf + dep->interval * 4;
1059 __dwc3_gadget_kick_transfer(dep, uf, 1);
1062 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1063 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1067 mask = ~(dep->interval - 1);
1068 cur_uf = event->parameters & mask;
1070 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1073 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1075 struct dwc3 *dwc = dep->dwc;
1078 if (!dep->endpoint.desc) {
1079 dwc3_trace(trace_dwc3_gadget,
1080 "trying to queue request %p to disabled %s\n",
1081 &req->request, dep->endpoint.name);
1085 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1086 &req->request, req->dep->name)) {
1087 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1088 &req->request, req->dep->name);
1092 req->request.actual = 0;
1093 req->request.status = -EINPROGRESS;
1094 req->direction = dep->direction;
1095 req->epnum = dep->number;
1097 trace_dwc3_ep_queue(req);
1100 * We only add to our list of requests now and
1101 * start consuming the list once we get XferNotReady
1104 * That way, we avoid doing anything that we don't need
1105 * to do now and defer it until the point we receive a
1106 * particular token from the Host side.
1108 * This will also avoid Host cancelling URBs due to too
1111 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1116 list_add_tail(&req->list, &dep->request_list);
1119 * If there are no pending requests and the endpoint isn't already
1120 * busy, we will just start the request straight away.
1122 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1123 * little bit faster.
1125 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1126 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1127 !(dep->flags & DWC3_EP_BUSY)) {
1128 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1133 * There are a few special cases:
1135 * 1. XferNotReady with empty list of requests. We need to kick the
1136 * transfer here in that situation, otherwise we will be NAKing
1137 * forever. If we get XferNotReady before gadget driver has a
1138 * chance to queue a request, we will ACK the IRQ but won't be
1139 * able to receive the data until the next request is queued.
1140 * The following code is handling exactly that.
1143 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1145 * If xfernotready is already elapsed and it is a case
1146 * of isoc transfer, then issue END TRANSFER, so that
1147 * you can receive xfernotready again and can have
1148 * notion of current microframe.
1150 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1151 if (list_empty(&dep->req_queued)) {
1152 dwc3_stop_active_transfer(dwc, dep->number, true);
1153 dep->flags = DWC3_EP_ENABLED;
1158 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1160 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1166 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1167 * kick the transfer here after queuing a request, otherwise the
1168 * core may not see the modified TRB(s).
1170 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1171 (dep->flags & DWC3_EP_BUSY) &&
1172 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1173 WARN_ON_ONCE(!dep->resource_index);
1174 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index,
1180 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1181 * right away, otherwise host will not know we have streams to be
1184 if (dep->stream_capable)
1185 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1188 if (ret && ret != -EBUSY)
1189 dwc3_trace(trace_dwc3_gadget,
1190 "%s: failed to kick transfers\n",
1198 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1199 struct usb_request *request)
1201 dwc3_gadget_ep_free_request(ep, request);
1204 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1206 struct dwc3_request *req;
1207 struct usb_request *request;
1208 struct usb_ep *ep = &dep->endpoint;
1210 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1211 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1215 request->length = 0;
1216 request->buf = dwc->zlp_buf;
1217 request->complete = __dwc3_gadget_ep_zlp_complete;
1219 req = to_dwc3_request(request);
1221 return __dwc3_gadget_ep_queue(dep, req);
1224 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1227 struct dwc3_request *req = to_dwc3_request(request);
1228 struct dwc3_ep *dep = to_dwc3_ep(ep);
1229 struct dwc3 *dwc = dep->dwc;
1231 unsigned long flags;
1235 spin_lock_irqsave(&dwc->lock, flags);
1236 ret = __dwc3_gadget_ep_queue(dep, req);
1239 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1240 * setting request->zero, instead of doing magic, we will just queue an
1241 * extra usb_request ourselves so that it gets handled the same way as
1242 * any other request.
1244 if (ret == 0 && request->zero && request->length &&
1245 (request->length % ep->maxpacket == 0))
1246 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1248 spin_unlock_irqrestore(&dwc->lock, flags);
1253 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1254 struct usb_request *request)
1256 struct dwc3_request *req = to_dwc3_request(request);
1257 struct dwc3_request *r = NULL;
1259 struct dwc3_ep *dep = to_dwc3_ep(ep);
1260 struct dwc3 *dwc = dep->dwc;
1262 unsigned long flags;
1265 trace_dwc3_ep_dequeue(req);
1267 spin_lock_irqsave(&dwc->lock, flags);
1269 list_for_each_entry(r, &dep->request_list, list) {
1275 list_for_each_entry(r, &dep->req_queued, list) {
1280 /* wait until it is processed */
1281 dwc3_stop_active_transfer(dwc, dep->number, true);
1284 dev_err(dwc->dev, "request %p was not queued to %s\n",
1291 /* giveback the request */
1292 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1295 spin_unlock_irqrestore(&dwc->lock, flags);
1300 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1302 struct dwc3_gadget_ep_cmd_params params;
1303 struct dwc3 *dwc = dep->dwc;
1306 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1307 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1311 memset(¶ms, 0x00, sizeof(params));
1314 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1315 (!list_empty(&dep->req_queued) ||
1316 !list_empty(&dep->request_list)))) {
1317 dwc3_trace(trace_dwc3_gadget,
1318 "%s: pending request, cannot halt\n",
1323 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1324 DWC3_DEPCMD_SETSTALL, ¶ms);
1326 dev_err(dwc->dev, "failed to set STALL on %s\n",
1329 dep->flags |= DWC3_EP_STALL;
1331 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1332 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1334 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1337 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1343 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1345 struct dwc3_ep *dep = to_dwc3_ep(ep);
1346 struct dwc3 *dwc = dep->dwc;
1348 unsigned long flags;
1352 spin_lock_irqsave(&dwc->lock, flags);
1353 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1354 spin_unlock_irqrestore(&dwc->lock, flags);
1359 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1361 struct dwc3_ep *dep = to_dwc3_ep(ep);
1362 struct dwc3 *dwc = dep->dwc;
1363 unsigned long flags;
1366 spin_lock_irqsave(&dwc->lock, flags);
1367 dep->flags |= DWC3_EP_WEDGE;
1369 if (dep->number == 0 || dep->number == 1)
1370 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1372 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1373 spin_unlock_irqrestore(&dwc->lock, flags);
1378 /* -------------------------------------------------------------------------- */
1380 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1381 .bLength = USB_DT_ENDPOINT_SIZE,
1382 .bDescriptorType = USB_DT_ENDPOINT,
1383 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1386 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1387 .enable = dwc3_gadget_ep0_enable,
1388 .disable = dwc3_gadget_ep0_disable,
1389 .alloc_request = dwc3_gadget_ep_alloc_request,
1390 .free_request = dwc3_gadget_ep_free_request,
1391 .queue = dwc3_gadget_ep0_queue,
1392 .dequeue = dwc3_gadget_ep_dequeue,
1393 .set_halt = dwc3_gadget_ep0_set_halt,
1394 .set_wedge = dwc3_gadget_ep_set_wedge,
1397 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1398 .enable = dwc3_gadget_ep_enable,
1399 .disable = dwc3_gadget_ep_disable,
1400 .alloc_request = dwc3_gadget_ep_alloc_request,
1401 .free_request = dwc3_gadget_ep_free_request,
1402 .queue = dwc3_gadget_ep_queue,
1403 .dequeue = dwc3_gadget_ep_dequeue,
1404 .set_halt = dwc3_gadget_ep_set_halt,
1405 .set_wedge = dwc3_gadget_ep_set_wedge,
1408 /* -------------------------------------------------------------------------- */
1410 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1412 struct dwc3 *dwc = gadget_to_dwc(g);
1415 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1416 return DWC3_DSTS_SOFFN(reg);
1419 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1421 struct dwc3 *dwc = gadget_to_dwc(g);
1423 unsigned long timeout;
1424 unsigned long flags;
1433 spin_lock_irqsave(&dwc->lock, flags);
1436 * According to the Databook Remote wakeup request should
1437 * be issued only when the device is in early suspend state.
1439 * We can check that via USB Link State bits in DSTS register.
1441 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1443 speed = reg & DWC3_DSTS_CONNECTSPD;
1444 if (speed == DWC3_DSTS_SUPERSPEED) {
1445 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1450 link_state = DWC3_DSTS_USBLNKST(reg);
1452 switch (link_state) {
1453 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1454 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1457 dwc3_trace(trace_dwc3_gadget,
1458 "can't wakeup from '%s'\n",
1459 dwc3_gadget_link_string(link_state));
1464 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1466 dev_err(dwc->dev, "failed to put link in Recovery\n");
1470 /* Recent versions do this automatically */
1471 if (dwc->revision < DWC3_REVISION_194A) {
1472 /* write zeroes to Link Change Request */
1473 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1474 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1475 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1478 /* poll until Link State changes to ON */
1479 timeout = jiffies + msecs_to_jiffies(100);
1481 while (!time_after(jiffies, timeout)) {
1482 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1484 /* in HS, means ON */
1485 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1489 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1490 dev_err(dwc->dev, "failed to send remote wakeup\n");
1495 spin_unlock_irqrestore(&dwc->lock, flags);
1500 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1503 struct dwc3 *dwc = gadget_to_dwc(g);
1504 unsigned long flags;
1506 spin_lock_irqsave(&dwc->lock, flags);
1507 g->is_selfpowered = !!is_selfpowered;
1508 spin_unlock_irqrestore(&dwc->lock, flags);
1513 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1518 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1520 if (dwc->revision <= DWC3_REVISION_187A) {
1521 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1522 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1525 if (dwc->revision >= DWC3_REVISION_194A)
1526 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1527 reg |= DWC3_DCTL_RUN_STOP;
1529 if (dwc->has_hibernation)
1530 reg |= DWC3_DCTL_KEEP_CONNECT;
1532 dwc->pullups_connected = true;
1534 reg &= ~DWC3_DCTL_RUN_STOP;
1536 if (dwc->has_hibernation && !suspend)
1537 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1539 dwc->pullups_connected = false;
1542 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1545 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1547 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1550 if (reg & DWC3_DSTS_DEVCTRLHLT)
1559 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1561 ? dwc->gadget_driver->function : "no-function",
1562 is_on ? "connect" : "disconnect");
1567 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1569 struct dwc3 *dwc = gadget_to_dwc(g);
1570 unsigned long flags;
1575 spin_lock_irqsave(&dwc->lock, flags);
1576 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1577 spin_unlock_irqrestore(&dwc->lock, flags);
1582 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1586 /* Enable all but Start and End of Frame IRQs */
1587 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1588 DWC3_DEVTEN_EVNTOVERFLOWEN |
1589 DWC3_DEVTEN_CMDCMPLTEN |
1590 DWC3_DEVTEN_ERRTICERREN |
1591 DWC3_DEVTEN_WKUPEVTEN |
1592 DWC3_DEVTEN_ULSTCNGEN |
1593 DWC3_DEVTEN_CONNECTDONEEN |
1594 DWC3_DEVTEN_USBRSTEN |
1595 DWC3_DEVTEN_DISCONNEVTEN);
1597 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1600 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1602 /* mask all interrupts */
1603 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1606 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1607 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1609 static int dwc3_gadget_start(struct usb_gadget *g,
1610 struct usb_gadget_driver *driver)
1612 struct dwc3 *dwc = gadget_to_dwc(g);
1613 struct dwc3_ep *dep;
1614 unsigned long flags;
1619 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1620 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1621 IRQF_SHARED, "dwc3", dwc);
1623 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1628 spin_lock_irqsave(&dwc->lock, flags);
1630 if (dwc->gadget_driver) {
1631 dev_err(dwc->dev, "%s is already bound to %s\n",
1633 dwc->gadget_driver->driver.name);
1638 dwc->gadget_driver = driver;
1640 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1641 reg &= ~(DWC3_DCFG_SPEED_MASK);
1644 * WORKAROUND: DWC3 revision < 2.20a have an issue
1645 * which would cause metastability state on Run/Stop
1646 * bit if we try to force the IP to USB2-only mode.
1648 * Because of that, we cannot configure the IP to any
1649 * speed other than the SuperSpeed
1653 * STAR#9000525659: Clock Domain Crossing on DCTL in
1656 if (dwc->revision < DWC3_REVISION_220A) {
1657 reg |= DWC3_DCFG_SUPERSPEED;
1659 switch (dwc->maximum_speed) {
1661 reg |= DWC3_DSTS_LOWSPEED;
1663 case USB_SPEED_FULL:
1664 reg |= DWC3_DSTS_FULLSPEED1;
1666 case USB_SPEED_HIGH:
1667 reg |= DWC3_DSTS_HIGHSPEED;
1669 case USB_SPEED_SUPER: /* FALLTHROUGH */
1670 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1672 reg |= DWC3_DSTS_SUPERSPEED;
1675 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1677 /* Start with SuperSpeed Default */
1678 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1681 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1684 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1689 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1692 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1696 /* begin to receive SETUP packets */
1697 dwc->ep0state = EP0_SETUP_PHASE;
1698 dwc3_ep0_out_start(dwc);
1700 dwc3_gadget_enable_irq(dwc);
1702 spin_unlock_irqrestore(&dwc->lock, flags);
1707 __dwc3_gadget_ep_disable(dwc->eps[0]);
1710 dwc->gadget_driver = NULL;
1713 spin_unlock_irqrestore(&dwc->lock, flags);
1721 static int dwc3_gadget_stop(struct usb_gadget *g)
1723 struct dwc3 *dwc = gadget_to_dwc(g);
1724 unsigned long flags;
1727 spin_lock_irqsave(&dwc->lock, flags);
1729 dwc3_gadget_disable_irq(dwc);
1730 __dwc3_gadget_ep_disable(dwc->eps[0]);
1731 __dwc3_gadget_ep_disable(dwc->eps[1]);
1733 dwc->gadget_driver = NULL;
1735 spin_unlock_irqrestore(&dwc->lock, flags);
1737 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1743 static const struct usb_gadget_ops dwc3_gadget_ops = {
1744 .get_frame = dwc3_gadget_get_frame,
1745 .wakeup = dwc3_gadget_wakeup,
1746 .set_selfpowered = dwc3_gadget_set_selfpowered,
1747 .pullup = dwc3_gadget_pullup,
1748 .udc_start = dwc3_gadget_start,
1749 .udc_stop = dwc3_gadget_stop,
1752 /* -------------------------------------------------------------------------- */
1754 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1755 u8 num, u32 direction)
1757 struct dwc3_ep *dep;
1760 for (i = 0; i < num; i++) {
1761 u8 epnum = (i << 1) | (!!direction);
1763 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1768 dep->number = epnum;
1769 dep->direction = !!direction;
1770 dwc->eps[epnum] = dep;
1772 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1773 (epnum & 1) ? "in" : "out");
1775 dep->endpoint.name = dep->name;
1777 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1779 if (epnum == 0 || epnum == 1) {
1780 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1781 dep->endpoint.maxburst = 1;
1782 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1784 dwc->gadget.ep0 = &dep->endpoint;
1788 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1789 dep->endpoint.max_streams = 15;
1790 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1791 list_add_tail(&dep->endpoint.ep_list,
1792 &dwc->gadget.ep_list);
1794 ret = dwc3_alloc_trb_pool(dep);
1799 if (epnum == 0 || epnum == 1) {
1800 dep->endpoint.caps.type_control = true;
1802 dep->endpoint.caps.type_iso = true;
1803 dep->endpoint.caps.type_bulk = true;
1804 dep->endpoint.caps.type_int = true;
1807 dep->endpoint.caps.dir_in = !!direction;
1808 dep->endpoint.caps.dir_out = !direction;
1810 INIT_LIST_HEAD(&dep->request_list);
1811 INIT_LIST_HEAD(&dep->req_queued);
1817 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1821 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1823 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1825 dwc3_trace(trace_dwc3_gadget,
1826 "failed to allocate OUT endpoints");
1830 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1832 dwc3_trace(trace_dwc3_gadget,
1833 "failed to allocate IN endpoints");
1840 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1842 struct dwc3_ep *dep;
1845 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1846 dep = dwc->eps[epnum];
1850 * Physical endpoints 0 and 1 are special; they form the
1851 * bi-directional USB endpoint 0.
1853 * For those two physical endpoints, we don't allocate a TRB
1854 * pool nor do we add them the endpoints list. Due to that, we
1855 * shouldn't do these two operations otherwise we would end up
1856 * with all sorts of bugs when removing dwc3.ko.
1858 if (epnum != 0 && epnum != 1) {
1859 dwc3_free_trb_pool(dep);
1860 list_del(&dep->endpoint.ep_list);
1867 /* -------------------------------------------------------------------------- */
1869 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1870 struct dwc3_request *req, struct dwc3_trb *trb,
1871 const struct dwc3_event_depevt *event, int status)
1874 unsigned int s_pkt = 0;
1875 unsigned int trb_status;
1877 trace_dwc3_complete_trb(dep, trb);
1879 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1881 * We continue despite the error. There is not much we
1882 * can do. If we don't clean it up we loop forever. If
1883 * we skip the TRB then it gets overwritten after a
1884 * while since we use them in a ring buffer. A BUG()
1885 * would help. Lets hope that if this occurs, someone
1886 * fixes the root cause instead of looking away :)
1888 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1890 count = trb->size & DWC3_TRB_SIZE_MASK;
1892 if (dep->direction) {
1894 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1895 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1896 dwc3_trace(trace_dwc3_gadget,
1897 "%s: incomplete IN transfer\n",
1900 * If missed isoc occurred and there is
1901 * no request queued then issue END
1902 * TRANSFER, so that core generates
1903 * next xfernotready and we will issue
1904 * a fresh START TRANSFER.
1905 * If there are still queued request
1906 * then wait, do not issue either END
1907 * or UPDATE TRANSFER, just attach next
1908 * request in request_list during
1909 * giveback.If any future queued request
1910 * is successfully transferred then we
1911 * will issue UPDATE TRANSFER for all
1912 * request in the request_list.
1914 dep->flags |= DWC3_EP_MISSED_ISOC;
1916 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1918 status = -ECONNRESET;
1921 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1924 if (count && (event->status & DEPEVT_STATUS_SHORT))
1929 * We assume here we will always receive the entire data block
1930 * which we should receive. Meaning, if we program RX to
1931 * receive 4K but we receive only 2K, we assume that's all we
1932 * should receive and we simply bounce the request back to the
1933 * gadget driver for further processing.
1935 req->request.actual += req->request.length - count;
1938 if ((event->status & DEPEVT_STATUS_LST) &&
1939 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1940 DWC3_TRB_CTRL_HWO)))
1942 if ((event->status & DEPEVT_STATUS_IOC) &&
1943 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1948 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1949 const struct dwc3_event_depevt *event, int status)
1951 struct dwc3_request *req;
1952 struct dwc3_trb *trb;
1958 req = next_request(&dep->req_queued);
1959 if (WARN_ON_ONCE(!req))
1964 slot = req->start_slot + i;
1965 if ((slot == DWC3_TRB_NUM - 1) &&
1966 usb_endpoint_xfer_isoc(dep->endpoint.desc))
1968 slot %= DWC3_TRB_NUM;
1969 trb = &dep->trb_pool[slot];
1971 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1975 } while (++i < req->request.num_mapped_sgs);
1977 dwc3_gadget_giveback(dep, req, status);
1983 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1984 list_empty(&dep->req_queued)) {
1985 if (list_empty(&dep->request_list)) {
1987 * If there is no entry in request list then do
1988 * not issue END TRANSFER now. Just set PENDING
1989 * flag, so that END TRANSFER is issued when an
1990 * entry is added into request list.
1992 dep->flags = DWC3_EP_PENDING_REQUEST;
1994 dwc3_stop_active_transfer(dwc, dep->number, true);
1995 dep->flags = DWC3_EP_ENABLED;
2003 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2004 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2006 unsigned status = 0;
2008 u32 is_xfer_complete;
2010 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2012 if (event->status & DEPEVT_STATUS_BUSERR)
2013 status = -ECONNRESET;
2015 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2016 if (clean_busy && (is_xfer_complete ||
2017 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2018 dep->flags &= ~DWC3_EP_BUSY;
2021 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2022 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2024 if (dwc->revision < DWC3_REVISION_183A) {
2028 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2031 if (!(dep->flags & DWC3_EP_ENABLED))
2034 if (!list_empty(&dep->req_queued))
2038 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2040 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2045 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2048 ret = __dwc3_gadget_kick_transfer(dep, 0, is_xfer_complete);
2049 if (!ret || ret == -EBUSY)
2054 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2055 const struct dwc3_event_depevt *event)
2057 struct dwc3_ep *dep;
2058 u8 epnum = event->endpoint_number;
2060 dep = dwc->eps[epnum];
2062 if (!(dep->flags & DWC3_EP_ENABLED))
2065 if (epnum == 0 || epnum == 1) {
2066 dwc3_ep0_interrupt(dwc, event);
2070 switch (event->endpoint_event) {
2071 case DWC3_DEPEVT_XFERCOMPLETE:
2072 dep->resource_index = 0;
2074 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2075 dwc3_trace(trace_dwc3_gadget,
2076 "%s is an Isochronous endpoint\n",
2081 dwc3_endpoint_transfer_complete(dwc, dep, event);
2083 case DWC3_DEPEVT_XFERINPROGRESS:
2084 dwc3_endpoint_transfer_complete(dwc, dep, event);
2086 case DWC3_DEPEVT_XFERNOTREADY:
2087 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2088 dwc3_gadget_start_isoc(dwc, dep, event);
2093 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2095 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2096 dep->name, active ? "Transfer Active"
2097 : "Transfer Not Active");
2099 ret = __dwc3_gadget_kick_transfer(dep, 0, !active);
2100 if (!ret || ret == -EBUSY)
2103 dwc3_trace(trace_dwc3_gadget,
2104 "%s: failed to kick transfers\n",
2109 case DWC3_DEPEVT_STREAMEVT:
2110 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2111 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2116 switch (event->status) {
2117 case DEPEVT_STREAMEVT_FOUND:
2118 dwc3_trace(trace_dwc3_gadget,
2119 "Stream %d found and started",
2123 case DEPEVT_STREAMEVT_NOTFOUND:
2126 dwc3_trace(trace_dwc3_gadget,
2127 "unable to find suitable stream\n");
2130 case DWC3_DEPEVT_RXTXFIFOEVT:
2131 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2133 case DWC3_DEPEVT_EPCMDCMPLT:
2134 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2139 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2141 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2142 spin_unlock(&dwc->lock);
2143 dwc->gadget_driver->disconnect(&dwc->gadget);
2144 spin_lock(&dwc->lock);
2148 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2150 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2151 spin_unlock(&dwc->lock);
2152 dwc->gadget_driver->suspend(&dwc->gadget);
2153 spin_lock(&dwc->lock);
2157 static void dwc3_resume_gadget(struct dwc3 *dwc)
2159 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2160 spin_unlock(&dwc->lock);
2161 dwc->gadget_driver->resume(&dwc->gadget);
2162 spin_lock(&dwc->lock);
2166 static void dwc3_reset_gadget(struct dwc3 *dwc)
2168 if (!dwc->gadget_driver)
2171 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2172 spin_unlock(&dwc->lock);
2173 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2174 spin_lock(&dwc->lock);
2178 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2180 struct dwc3_ep *dep;
2181 struct dwc3_gadget_ep_cmd_params params;
2185 dep = dwc->eps[epnum];
2187 if (!dep->resource_index)
2191 * NOTICE: We are violating what the Databook says about the
2192 * EndTransfer command. Ideally we would _always_ wait for the
2193 * EndTransfer Command Completion IRQ, but that's causing too
2194 * much trouble synchronizing between us and gadget driver.
2196 * We have discussed this with the IP Provider and it was
2197 * suggested to giveback all requests here, but give HW some
2198 * extra time to synchronize with the interconnect. We're using
2199 * an arbitrary 100us delay for that.
2201 * Note also that a similar handling was tested by Synopsys
2202 * (thanks a lot Paul) and nothing bad has come out of it.
2203 * In short, what we're doing is:
2205 * - Issue EndTransfer WITH CMDIOC bit set
2209 cmd = DWC3_DEPCMD_ENDTRANSFER;
2210 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2211 cmd |= DWC3_DEPCMD_CMDIOC;
2212 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2213 memset(¶ms, 0, sizeof(params));
2214 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
2216 dep->resource_index = 0;
2217 dep->flags &= ~DWC3_EP_BUSY;
2221 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2225 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2226 struct dwc3_ep *dep;
2228 dep = dwc->eps[epnum];
2232 if (!(dep->flags & DWC3_EP_ENABLED))
2235 dwc3_remove_requests(dwc, dep);
2239 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2243 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2244 struct dwc3_ep *dep;
2245 struct dwc3_gadget_ep_cmd_params params;
2248 dep = dwc->eps[epnum];
2252 if (!(dep->flags & DWC3_EP_STALL))
2255 dep->flags &= ~DWC3_EP_STALL;
2257 memset(¶ms, 0, sizeof(params));
2258 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
2259 DWC3_DEPCMD_CLEARSTALL, ¶ms);
2264 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2268 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2269 reg &= ~DWC3_DCTL_INITU1ENA;
2270 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2272 reg &= ~DWC3_DCTL_INITU2ENA;
2273 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2275 dwc3_disconnect_gadget(dwc);
2277 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2278 dwc->setup_packet_pending = false;
2279 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2282 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2287 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2288 * would cause a missing Disconnect Event if there's a
2289 * pending Setup Packet in the FIFO.
2291 * There's no suggested workaround on the official Bug
2292 * report, which states that "unless the driver/application
2293 * is doing any special handling of a disconnect event,
2294 * there is no functional issue".
2296 * Unfortunately, it turns out that we _do_ some special
2297 * handling of a disconnect event, namely complete all
2298 * pending transfers, notify gadget driver of the
2299 * disconnection, and so on.
2301 * Our suggested workaround is to follow the Disconnect
2302 * Event steps here, instead, based on a setup_packet_pending
2303 * flag. Such flag gets set whenever we have a SETUP_PENDING
2304 * status for EP0 TRBs and gets cleared on XferComplete for the
2309 * STAR#9000466709: RTL: Device : Disconnect event not
2310 * generated if setup packet pending in FIFO
2312 if (dwc->revision < DWC3_REVISION_188A) {
2313 if (dwc->setup_packet_pending)
2314 dwc3_gadget_disconnect_interrupt(dwc);
2317 dwc3_reset_gadget(dwc);
2319 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2320 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2321 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2322 dwc->test_mode = false;
2324 dwc3_stop_active_transfers(dwc);
2325 dwc3_clear_stall_all_ep(dwc);
2327 /* Reset device address to zero */
2328 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2329 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2330 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2333 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2336 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2339 * We change the clock only at SS but I dunno why I would want to do
2340 * this. Maybe it becomes part of the power saving plan.
2343 if (speed != DWC3_DSTS_SUPERSPEED)
2347 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2348 * each time on Connect Done.
2353 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2354 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2355 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2358 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2360 struct dwc3_ep *dep;
2365 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2366 speed = reg & DWC3_DSTS_CONNECTSPD;
2369 dwc3_update_ram_clk_sel(dwc, speed);
2372 case DWC3_DCFG_SUPERSPEED:
2374 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2375 * would cause a missing USB3 Reset event.
2377 * In such situations, we should force a USB3 Reset
2378 * event by calling our dwc3_gadget_reset_interrupt()
2383 * STAR#9000483510: RTL: SS : USB3 reset event may
2384 * not be generated always when the link enters poll
2386 if (dwc->revision < DWC3_REVISION_190A)
2387 dwc3_gadget_reset_interrupt(dwc);
2389 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2390 dwc->gadget.ep0->maxpacket = 512;
2391 dwc->gadget.speed = USB_SPEED_SUPER;
2393 case DWC3_DCFG_HIGHSPEED:
2394 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2395 dwc->gadget.ep0->maxpacket = 64;
2396 dwc->gadget.speed = USB_SPEED_HIGH;
2398 case DWC3_DCFG_FULLSPEED2:
2399 case DWC3_DCFG_FULLSPEED1:
2400 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2401 dwc->gadget.ep0->maxpacket = 64;
2402 dwc->gadget.speed = USB_SPEED_FULL;
2404 case DWC3_DCFG_LOWSPEED:
2405 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2406 dwc->gadget.ep0->maxpacket = 8;
2407 dwc->gadget.speed = USB_SPEED_LOW;
2411 /* Enable USB2 LPM Capability */
2413 if ((dwc->revision > DWC3_REVISION_194A)
2414 && (speed != DWC3_DCFG_SUPERSPEED)) {
2415 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2416 reg |= DWC3_DCFG_LPM_CAP;
2417 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2419 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2420 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2422 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2425 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2426 * DCFG.LPMCap is set, core responses with an ACK and the
2427 * BESL value in the LPM token is less than or equal to LPM
2430 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2431 && dwc->has_lpm_erratum,
2432 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2434 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2435 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2437 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2439 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2440 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2441 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2445 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2448 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2453 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2456 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2461 * Configure PHY via GUSB3PIPECTLn if required.
2463 * Update GTXFIFOSIZn
2465 * In both cases reset values should be sufficient.
2469 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2472 * TODO take core out of low power mode when that's
2476 dwc->gadget_driver->resume(&dwc->gadget);
2479 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2480 unsigned int evtinfo)
2482 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2483 unsigned int pwropt;
2486 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2487 * Hibernation mode enabled which would show up when device detects
2488 * host-initiated U3 exit.
2490 * In that case, device will generate a Link State Change Interrupt
2491 * from U3 to RESUME which is only necessary if Hibernation is
2494 * There are no functional changes due to such spurious event and we
2495 * just need to ignore it.
2499 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2502 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2503 if ((dwc->revision < DWC3_REVISION_250A) &&
2504 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2505 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2506 (next == DWC3_LINK_STATE_RESUME)) {
2507 dwc3_trace(trace_dwc3_gadget,
2508 "ignoring transition U3 -> Resume");
2514 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2515 * on the link partner, the USB session might do multiple entry/exit
2516 * of low power states before a transfer takes place.
2518 * Due to this problem, we might experience lower throughput. The
2519 * suggested workaround is to disable DCTL[12:9] bits if we're
2520 * transitioning from U1/U2 to U0 and enable those bits again
2521 * after a transfer completes and there are no pending transfers
2522 * on any of the enabled endpoints.
2524 * This is the first half of that workaround.
2528 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2529 * core send LGO_Ux entering U0
2531 if (dwc->revision < DWC3_REVISION_183A) {
2532 if (next == DWC3_LINK_STATE_U0) {
2536 switch (dwc->link_state) {
2537 case DWC3_LINK_STATE_U1:
2538 case DWC3_LINK_STATE_U2:
2539 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2540 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2541 | DWC3_DCTL_ACCEPTU2ENA
2542 | DWC3_DCTL_INITU1ENA
2543 | DWC3_DCTL_ACCEPTU1ENA);
2546 dwc->u1u2 = reg & u1u2;
2550 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2560 case DWC3_LINK_STATE_U1:
2561 if (dwc->speed == USB_SPEED_SUPER)
2562 dwc3_suspend_gadget(dwc);
2564 case DWC3_LINK_STATE_U2:
2565 case DWC3_LINK_STATE_U3:
2566 dwc3_suspend_gadget(dwc);
2568 case DWC3_LINK_STATE_RESUME:
2569 dwc3_resume_gadget(dwc);
2576 dwc->link_state = next;
2579 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2580 unsigned int evtinfo)
2582 unsigned int is_ss = evtinfo & BIT(4);
2585 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2586 * have a known issue which can cause USB CV TD.9.23 to fail
2589 * Because of this issue, core could generate bogus hibernation
2590 * events which SW needs to ignore.
2594 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2595 * Device Fallback from SuperSpeed
2597 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2600 /* enter hibernation here */
2603 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2604 const struct dwc3_event_devt *event)
2606 switch (event->type) {
2607 case DWC3_DEVICE_EVENT_DISCONNECT:
2608 dwc3_gadget_disconnect_interrupt(dwc);
2610 case DWC3_DEVICE_EVENT_RESET:
2611 dwc3_gadget_reset_interrupt(dwc);
2613 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2614 dwc3_gadget_conndone_interrupt(dwc);
2616 case DWC3_DEVICE_EVENT_WAKEUP:
2617 dwc3_gadget_wakeup_interrupt(dwc);
2619 case DWC3_DEVICE_EVENT_HIBER_REQ:
2620 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2621 "unexpected hibernation event\n"))
2624 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2626 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2627 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2629 case DWC3_DEVICE_EVENT_EOPF:
2630 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2632 case DWC3_DEVICE_EVENT_SOF:
2633 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2635 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2636 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2638 case DWC3_DEVICE_EVENT_CMD_CMPL:
2639 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2641 case DWC3_DEVICE_EVENT_OVERFLOW:
2642 dwc3_trace(trace_dwc3_gadget, "Overflow");
2645 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2649 static void dwc3_process_event_entry(struct dwc3 *dwc,
2650 const union dwc3_event *event)
2652 trace_dwc3_event(event->raw);
2654 /* Endpoint IRQ, handle it and return early */
2655 if (event->type.is_devspec == 0) {
2657 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2660 switch (event->type.type) {
2661 case DWC3_EVENT_TYPE_DEV:
2662 dwc3_gadget_interrupt(dwc, &event->devt);
2664 /* REVISIT what to do with Carkit and I2C events ? */
2666 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2670 static irqreturn_t dwc3_process_event_buf(struct dwc3 *dwc, u32 buf)
2672 struct dwc3_event_buffer *evt;
2673 irqreturn_t ret = IRQ_NONE;
2677 evt = dwc->ev_buffs[buf];
2680 if (!(evt->flags & DWC3_EVENT_PENDING))
2684 union dwc3_event event;
2686 event.raw = *(u32 *) (evt->buf + evt->lpos);
2688 dwc3_process_event_entry(dwc, &event);
2691 * FIXME we wrap around correctly to the next entry as
2692 * almost all entries are 4 bytes in size. There is one
2693 * entry which has 12 bytes which is a regular entry
2694 * followed by 8 bytes data. ATM I don't know how
2695 * things are organized if we get next to the a
2696 * boundary so I worry about that once we try to handle
2699 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2702 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(buf), 4);
2706 evt->flags &= ~DWC3_EVENT_PENDING;
2709 /* Unmask interrupt */
2710 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(buf));
2711 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2712 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(buf), reg);
2717 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc)
2719 struct dwc3 *dwc = _dwc;
2720 unsigned long flags;
2721 irqreturn_t ret = IRQ_NONE;
2724 spin_lock_irqsave(&dwc->lock, flags);
2726 for (i = 0; i < dwc->num_event_buffers; i++)
2727 ret |= dwc3_process_event_buf(dwc, i);
2729 spin_unlock_irqrestore(&dwc->lock, flags);
2734 static irqreturn_t dwc3_check_event_buf(struct dwc3 *dwc, u32 buf)
2736 struct dwc3_event_buffer *evt;
2740 evt = dwc->ev_buffs[buf];
2742 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(buf));
2743 count &= DWC3_GEVNTCOUNT_MASK;
2748 evt->flags |= DWC3_EVENT_PENDING;
2750 /* Mask interrupt */
2751 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(buf));
2752 reg |= DWC3_GEVNTSIZ_INTMASK;
2753 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(buf), reg);
2755 return IRQ_WAKE_THREAD;
2758 static irqreturn_t dwc3_interrupt(int irq, void *_dwc)
2760 struct dwc3 *dwc = _dwc;
2762 irqreturn_t ret = IRQ_NONE;
2764 for (i = 0; i < dwc->num_event_buffers; i++) {
2767 status = dwc3_check_event_buf(dwc, i);
2768 if (status == IRQ_WAKE_THREAD)
2776 * dwc3_gadget_init - Initializes gadget related registers
2777 * @dwc: pointer to our controller context structure
2779 * Returns 0 on success otherwise negative errno.
2781 int dwc3_gadget_init(struct dwc3 *dwc)
2785 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2786 &dwc->ctrl_req_addr, GFP_KERNEL);
2787 if (!dwc->ctrl_req) {
2788 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2793 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2794 &dwc->ep0_trb_addr, GFP_KERNEL);
2795 if (!dwc->ep0_trb) {
2796 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2801 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2802 if (!dwc->setup_buf) {
2807 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2808 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2810 if (!dwc->ep0_bounce) {
2811 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2816 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2817 if (!dwc->zlp_buf) {
2822 dwc->gadget.ops = &dwc3_gadget_ops;
2823 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2824 dwc->gadget.sg_supported = true;
2825 dwc->gadget.name = "dwc3-gadget";
2826 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2829 * FIXME We might be setting max_speed to <SUPER, however versions
2830 * <2.20a of dwc3 have an issue with metastability (documented
2831 * elsewhere in this driver) which tells us we can't set max speed to
2832 * anything lower than SUPER.
2834 * Because gadget.max_speed is only used by composite.c and function
2835 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2836 * to happen so we avoid sending SuperSpeed Capability descriptor
2837 * together with our BOS descriptor as that could confuse host into
2838 * thinking we can handle super speed.
2840 * Note that, in fact, we won't even support GetBOS requests when speed
2841 * is less than super speed because we don't have means, yet, to tell
2842 * composite.c that we are USB 2.0 + LPM ECN.
2844 if (dwc->revision < DWC3_REVISION_220A)
2845 dwc3_trace(trace_dwc3_gadget,
2846 "Changing max_speed on rev %08x\n",
2849 dwc->gadget.max_speed = dwc->maximum_speed;
2852 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2855 dwc->gadget.quirk_ep_out_aligned_size = true;
2858 * REVISIT: Here we should clear all pending IRQs to be
2859 * sure we're starting from a well known location.
2862 ret = dwc3_gadget_init_endpoints(dwc);
2866 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2868 dev_err(dwc->dev, "failed to register udc\n");
2875 kfree(dwc->zlp_buf);
2878 dwc3_gadget_free_endpoints(dwc);
2879 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2880 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2883 kfree(dwc->setup_buf);
2886 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2887 dwc->ep0_trb, dwc->ep0_trb_addr);
2890 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2891 dwc->ctrl_req, dwc->ctrl_req_addr);
2897 /* -------------------------------------------------------------------------- */
2899 void dwc3_gadget_exit(struct dwc3 *dwc)
2901 usb_del_gadget_udc(&dwc->gadget);
2903 dwc3_gadget_free_endpoints(dwc);
2905 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2906 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2908 kfree(dwc->setup_buf);
2909 kfree(dwc->zlp_buf);
2911 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2912 dwc->ep0_trb, dwc->ep0_trb_addr);
2914 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2915 dwc->ctrl_req, dwc->ctrl_req_addr);
2918 int dwc3_gadget_suspend(struct dwc3 *dwc)
2920 if (dwc->pullups_connected) {
2921 dwc3_gadget_disable_irq(dwc);
2922 dwc3_gadget_run_stop(dwc, true, true);
2925 __dwc3_gadget_ep_disable(dwc->eps[0]);
2926 __dwc3_gadget_ep_disable(dwc->eps[1]);
2928 dwc->dcfg = dwc3_readl(dwc->regs, DWC3_DCFG);
2933 int dwc3_gadget_resume(struct dwc3 *dwc)
2935 struct dwc3_ep *dep;
2938 /* Start with SuperSpeed Default */
2939 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2942 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2948 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2953 /* begin to receive SETUP packets */
2954 dwc->ep0state = EP0_SETUP_PHASE;
2955 dwc3_ep0_out_start(dwc);
2957 dwc3_writel(dwc->regs, DWC3_DCFG, dwc->dcfg);
2959 if (dwc->pullups_connected) {
2960 dwc3_gadget_enable_irq(dwc);
2961 dwc3_gadget_run_stop(dwc, true, false);
2967 __dwc3_gadget_ep_disable(dwc->eps[0]);