2 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 of
11 * the License as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/interrupt.h>
27 #include <linux/list.h>
28 #include <linux/dma-mapping.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
39 * dwc3_gadget_set_test_mode - Enables USB2 Test Modes
40 * @dwc: pointer to our context structure
41 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
43 * Caller should take care of locking. This function will
44 * return 0 on success or -EINVAL if wrong Test Selector
47 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
51 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
52 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
66 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
72 * dwc3_gadget_get_link_state - Gets current state of USB Link
73 * @dwc: pointer to our context structure
75 * Caller should take care of locking. This function will
76 * return the link state on success (>= 0) or -ETIMEDOUT.
78 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
82 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
84 return DWC3_DSTS_USBLNKST(reg);
88 * dwc3_gadget_set_link_state - Sets USB Link to a particular State
89 * @dwc: pointer to our context structure
90 * @state: the state to put link into
92 * Caller should take care of locking. This function will
93 * return 0 on success or -ETIMEDOUT.
95 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
101 * Wait until device controller is ready. Only applies to 1.94a and
104 if (dwc->revision >= DWC3_REVISION_194A) {
106 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
107 if (reg & DWC3_DSTS_DCNRD)
117 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
118 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
120 /* set requested state */
121 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
122 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
125 * The following code is racy when called from dwc3_gadget_wakeup,
126 * and is not needed, at least on newer versions
128 if (dwc->revision >= DWC3_REVISION_194A)
131 /* wait for a change in DSTS */
134 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
136 if (DWC3_DSTS_USBLNKST(reg) == state)
142 dwc3_trace(trace_dwc3_gadget,
143 "link state change request timed out");
148 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
151 dep->trb_enqueue %= DWC3_TRB_NUM;
154 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
157 dep->trb_dequeue %= DWC3_TRB_NUM;
160 static int dwc3_ep_is_last_trb(unsigned int index)
162 return index == DWC3_TRB_NUM - 1;
165 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
168 struct dwc3 *dwc = dep->dwc;
174 dwc3_ep_inc_deq(dep);
176 * Skip LINK TRB. We can't use req->trb and check for
177 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
178 * just completed (not the LINK TRB).
180 if (dwc3_ep_is_last_trb(dep->trb_dequeue))
181 dwc3_ep_inc_deq(dep);
182 } while(++i < req->request.num_mapped_sgs);
183 req->started = false;
185 list_del(&req->list);
188 if (req->request.status == -EINPROGRESS)
189 req->request.status = status;
191 if (dwc->ep0_bounced && dep->number == 0)
192 dwc->ep0_bounced = false;
194 usb_gadget_unmap_request(&dwc->gadget, &req->request,
197 trace_dwc3_gadget_giveback(req);
199 spin_unlock(&dwc->lock);
200 usb_gadget_giveback_request(&dep->endpoint, &req->request);
201 spin_lock(&dwc->lock);
204 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
209 trace_dwc3_gadget_generic_cmd(cmd, param);
211 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
212 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
215 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
216 if (!(reg & DWC3_DGCMD_CMDACT)) {
217 dwc3_trace(trace_dwc3_gadget,
218 "Command Complete --> %d",
219 DWC3_DGCMD_STATUS(reg));
220 if (DWC3_DGCMD_STATUS(reg))
226 * We can't sleep here, because it's also called from
231 dwc3_trace(trace_dwc3_gadget,
232 "Command Timed Out");
239 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
241 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
242 struct dwc3_gadget_ep_cmd_params *params)
244 struct dwc3 *dwc = dep->dwc;
251 unsigned ep = dep->number;
253 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
256 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
257 * we're issuing an endpoint command, we must check if
258 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
260 * We will also set SUSPHY bit to what it was before returning as stated
261 * by the same section on Synopsys databook.
263 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
264 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
266 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
267 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
270 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
273 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
274 dwc->link_state == DWC3_LINK_STATE_U2 ||
275 dwc->link_state == DWC3_LINK_STATE_U3);
277 if (unlikely(needs_wakeup)) {
278 ret = __dwc3_gadget_wakeup(dwc);
279 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
284 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
285 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
286 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
288 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
290 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
291 if (!(reg & DWC3_DEPCMD_CMDACT)) {
292 int cmd_status = DWC3_DEPCMD_STATUS(reg);
294 dwc3_trace(trace_dwc3_gadget,
295 "Command Complete --> %d",
298 switch (cmd_status) {
302 case DEPEVT_TRANSFER_NO_RESOURCE:
303 dwc3_trace(trace_dwc3_gadget, "%s: no resource available");
306 case DEPEVT_TRANSFER_BUS_EXPIRY:
308 * SW issues START TRANSFER command to
309 * isochronous ep with future frame interval. If
310 * future interval time has already passed when
311 * core receives the command, it will respond
312 * with an error status of 'Bus Expiry'.
314 * Instead of always returning -EINVAL, let's
315 * give a hint to the gadget driver that this is
316 * the case by returning -EAGAIN.
318 dwc3_trace(trace_dwc3_gadget, "%s: bus expiry");
322 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
329 * We can't sleep here, because it is also called from
334 dwc3_trace(trace_dwc3_gadget,
335 "Command Timed Out");
341 if (unlikely(susphy)) {
342 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
343 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
344 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
350 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
352 struct dwc3 *dwc = dep->dwc;
353 struct dwc3_gadget_ep_cmd_params params;
354 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
357 * As of core revision 2.60a the recommended programming model
358 * is to set the ClearPendIN bit when issuing a Clear Stall EP
359 * command for IN endpoints. This is to prevent an issue where
360 * some (non-compliant) hosts may not send ACK TPs for pending
361 * IN transfers due to a mishandled error condition. Synopsys
364 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
365 cmd |= DWC3_DEPCMD_CLEARPENDIN;
367 memset(¶ms, 0, sizeof(params));
369 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
372 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
373 struct dwc3_trb *trb)
375 u32 offset = (char *) trb - (char *) dep->trb_pool;
377 return dep->trb_pool_dma + offset;
380 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
382 struct dwc3 *dwc = dep->dwc;
387 dep->trb_pool = dma_alloc_coherent(dwc->dev,
388 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
389 &dep->trb_pool_dma, GFP_KERNEL);
390 if (!dep->trb_pool) {
391 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
399 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
401 struct dwc3 *dwc = dep->dwc;
403 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
404 dep->trb_pool, dep->trb_pool_dma);
406 dep->trb_pool = NULL;
407 dep->trb_pool_dma = 0;
410 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
413 * dwc3_gadget_start_config - Configure EP resources
414 * @dwc: pointer to our controller context structure
415 * @dep: endpoint that is being enabled
417 * The assignment of transfer resources cannot perfectly follow the
418 * data book due to the fact that the controller driver does not have
419 * all knowledge of the configuration in advance. It is given this
420 * information piecemeal by the composite gadget framework after every
421 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
422 * programming model in this scenario can cause errors. For two
425 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
426 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
427 * multiple interfaces.
429 * 2) The databook does not mention doing more DEPXFERCFG for new
430 * endpoint on alt setting (8.1.6).
432 * The following simplified method is used instead:
434 * All hardware endpoints can be assigned a transfer resource and this
435 * setting will stay persistent until either a core reset or
436 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
437 * do DEPXFERCFG for every hardware endpoint as well. We are
438 * guaranteed that there are as many transfer resources as endpoints.
440 * This function is called for each endpoint when it is being enabled
441 * but is triggered only when called for EP0-out, which always happens
442 * first, and which should only happen in one of the above conditions.
444 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
446 struct dwc3_gadget_ep_cmd_params params;
454 memset(¶ms, 0x00, sizeof(params));
455 cmd = DWC3_DEPCMD_DEPSTARTCFG;
457 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
461 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
462 struct dwc3_ep *dep = dwc->eps[i];
467 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
475 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
476 const struct usb_endpoint_descriptor *desc,
477 const struct usb_ss_ep_comp_descriptor *comp_desc,
478 bool ignore, bool restore)
480 struct dwc3_gadget_ep_cmd_params params;
482 memset(¶ms, 0x00, sizeof(params));
484 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
485 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
487 /* Burst size is only needed in SuperSpeed mode */
488 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
489 u32 burst = dep->endpoint.maxburst;
490 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
494 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
497 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
498 params.param2 |= dep->saved_state;
501 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
502 | DWC3_DEPCFG_XFER_NOT_READY_EN;
504 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
505 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
506 | DWC3_DEPCFG_STREAM_EVENT_EN;
507 dep->stream_capable = true;
510 if (!usb_endpoint_xfer_control(desc))
511 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
514 * We are doing 1:1 mapping for endpoints, meaning
515 * Physical Endpoints 2 maps to Logical Endpoint 2 and
516 * so on. We consider the direction bit as part of the physical
517 * endpoint number. So USB endpoint 0x81 is 0x03.
519 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
522 * We must use the lower 16 TX FIFOs even though
526 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
528 if (desc->bInterval) {
529 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
530 dep->interval = 1 << (desc->bInterval - 1);
533 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
536 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
538 struct dwc3_gadget_ep_cmd_params params;
540 memset(¶ms, 0x00, sizeof(params));
542 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
544 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
549 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
550 * @dep: endpoint to be initialized
551 * @desc: USB Endpoint Descriptor
553 * Caller should take care of locking
555 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
556 const struct usb_endpoint_descriptor *desc,
557 const struct usb_ss_ep_comp_descriptor *comp_desc,
558 bool ignore, bool restore)
560 struct dwc3 *dwc = dep->dwc;
564 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
566 if (!(dep->flags & DWC3_EP_ENABLED)) {
567 ret = dwc3_gadget_start_config(dwc, dep);
572 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
577 if (!(dep->flags & DWC3_EP_ENABLED)) {
578 struct dwc3_trb *trb_st_hw;
579 struct dwc3_trb *trb_link;
581 dep->endpoint.desc = desc;
582 dep->comp_desc = comp_desc;
583 dep->type = usb_endpoint_type(desc);
584 dep->flags |= DWC3_EP_ENABLED;
586 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
587 reg |= DWC3_DALEPENA_EP(dep->number);
588 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
590 if (usb_endpoint_xfer_control(desc))
593 /* Link TRB. The HWO bit is never reset */
594 trb_st_hw = &dep->trb_pool[0];
596 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
597 memset(trb_link, 0, sizeof(*trb_link));
599 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
600 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
601 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
602 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
606 switch (usb_endpoint_type(desc)) {
607 case USB_ENDPOINT_XFER_CONTROL:
608 /* don't change name */
610 case USB_ENDPOINT_XFER_ISOC:
611 strlcat(dep->name, "-isoc", sizeof(dep->name));
613 case USB_ENDPOINT_XFER_BULK:
614 strlcat(dep->name, "-bulk", sizeof(dep->name));
616 case USB_ENDPOINT_XFER_INT:
617 strlcat(dep->name, "-int", sizeof(dep->name));
620 dev_err(dwc->dev, "invalid endpoint transfer type\n");
626 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
627 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
629 struct dwc3_request *req;
631 if (!list_empty(&dep->started_list)) {
632 dwc3_stop_active_transfer(dwc, dep->number, true);
634 /* - giveback all requests to gadget driver */
635 while (!list_empty(&dep->started_list)) {
636 req = next_request(&dep->started_list);
638 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
642 while (!list_empty(&dep->pending_list)) {
643 req = next_request(&dep->pending_list);
645 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
650 * __dwc3_gadget_ep_disable - Disables a HW endpoint
651 * @dep: the endpoint to disable
653 * This function also removes requests which are currently processed ny the
654 * hardware and those which are not yet scheduled.
655 * Caller should take care of locking.
657 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
659 struct dwc3 *dwc = dep->dwc;
662 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
664 dwc3_remove_requests(dwc, dep);
666 /* make sure HW endpoint isn't stalled */
667 if (dep->flags & DWC3_EP_STALL)
668 __dwc3_gadget_ep_set_halt(dep, 0, false);
670 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
671 reg &= ~DWC3_DALEPENA_EP(dep->number);
672 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
674 dep->stream_capable = false;
675 dep->endpoint.desc = NULL;
676 dep->comp_desc = NULL;
680 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
682 (dep->number & 1) ? "in" : "out");
687 /* -------------------------------------------------------------------------- */
689 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
690 const struct usb_endpoint_descriptor *desc)
695 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
700 /* -------------------------------------------------------------------------- */
702 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
703 const struct usb_endpoint_descriptor *desc)
710 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
711 pr_debug("dwc3: invalid parameters\n");
715 if (!desc->wMaxPacketSize) {
716 pr_debug("dwc3: missing wMaxPacketSize\n");
720 dep = to_dwc3_ep(ep);
723 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
724 "%s is already enabled\n",
728 spin_lock_irqsave(&dwc->lock, flags);
729 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
730 spin_unlock_irqrestore(&dwc->lock, flags);
735 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
743 pr_debug("dwc3: invalid parameters\n");
747 dep = to_dwc3_ep(ep);
750 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
751 "%s is already disabled\n",
755 spin_lock_irqsave(&dwc->lock, flags);
756 ret = __dwc3_gadget_ep_disable(dep);
757 spin_unlock_irqrestore(&dwc->lock, flags);
762 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
765 struct dwc3_request *req;
766 struct dwc3_ep *dep = to_dwc3_ep(ep);
768 req = kzalloc(sizeof(*req), gfp_flags);
772 req->epnum = dep->number;
775 trace_dwc3_alloc_request(req);
777 return &req->request;
780 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
781 struct usb_request *request)
783 struct dwc3_request *req = to_dwc3_request(request);
785 trace_dwc3_free_request(req);
790 * dwc3_prepare_one_trb - setup one TRB from one request
791 * @dep: endpoint for which this request is prepared
792 * @req: dwc3_request pointer
794 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
795 struct dwc3_request *req, dma_addr_t dma,
796 unsigned length, unsigned last, unsigned chain, unsigned node)
798 struct dwc3_trb *trb;
800 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
801 dep->name, req, (unsigned long long) dma,
802 length, last ? " last" : "",
803 chain ? " chain" : "");
806 trb = &dep->trb_pool[dep->trb_enqueue];
809 dwc3_gadget_move_started_request(req);
811 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
812 req->first_trb_index = dep->trb_enqueue;
815 dwc3_ep_inc_enq(dep);
816 /* Skip the LINK-TRB */
817 if (dwc3_ep_is_last_trb(dep->trb_enqueue))
818 dwc3_ep_inc_enq(dep);
820 trb->size = DWC3_TRB_SIZE_LENGTH(length);
821 trb->bpl = lower_32_bits(dma);
822 trb->bph = upper_32_bits(dma);
824 switch (usb_endpoint_type(dep->endpoint.desc)) {
825 case USB_ENDPOINT_XFER_CONTROL:
826 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
829 case USB_ENDPOINT_XFER_ISOC:
831 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
833 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
835 /* always enable Interrupt on Missed ISOC */
836 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
839 case USB_ENDPOINT_XFER_BULK:
840 case USB_ENDPOINT_XFER_INT:
841 trb->ctrl = DWC3_TRBCTL_NORMAL;
845 * This is only possible with faulty memory because we
846 * checked it already :)
851 /* always enable Continue on Short Packet */
852 trb->ctrl |= DWC3_TRB_CTRL_CSP;
854 if (!req->request.no_interrupt && !chain)
855 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
858 trb->ctrl |= DWC3_TRB_CTRL_LST;
861 trb->ctrl |= DWC3_TRB_CTRL_CHN;
863 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
864 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
866 trb->ctrl |= DWC3_TRB_CTRL_HWO;
868 trace_dwc3_prepare_trb(dep, trb);
871 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
873 struct dwc3_trb *tmp;
876 * If enqueue & dequeue are equal than it is either full or empty.
878 * One way to know for sure is if the TRB right before us has HWO bit
879 * set or not. If it has, then we're definitely full and can't fit any
880 * more transfers in our ring.
882 if (dep->trb_enqueue == dep->trb_dequeue) {
883 /* If we're full, enqueue/dequeue are > 0 */
884 if (dep->trb_enqueue) {
885 tmp = &dep->trb_pool[dep->trb_enqueue - 1];
886 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
890 return DWC3_TRB_NUM - 1;
893 return dep->trb_dequeue - dep->trb_enqueue;
896 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
897 struct dwc3_request *req, unsigned int trbs_left)
899 struct usb_request *request = &req->request;
900 struct scatterlist *sg = request->sg;
901 struct scatterlist *s;
902 unsigned int last = false;
907 for_each_sg(sg, s, request->num_mapped_sgs, i) {
908 unsigned chain = true;
910 length = sg_dma_len(s);
911 dma = sg_dma_address(s);
914 if (list_is_last(&req->list, &dep->pending_list))
926 dwc3_prepare_one_trb(dep, req, dma, length,
934 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
935 struct dwc3_request *req, unsigned int trbs_left)
937 unsigned int last = false;
941 dma = req->request.dma;
942 length = req->request.length;
947 /* Is this the last request? */
948 if (list_is_last(&req->list, &dep->pending_list))
951 dwc3_prepare_one_trb(dep, req, dma, length,
956 * dwc3_prepare_trbs - setup TRBs from requests
957 * @dep: endpoint for which requests are being prepared
959 * The function goes through the requests list and sets up TRBs for the
960 * transfers. The function returns once there are no more TRBs available or
961 * it runs out of requests.
963 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
965 struct dwc3_request *req, *n;
968 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
970 trbs_left = dwc3_calc_trbs_left(dep);
972 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
973 if (req->request.num_mapped_sgs > 0)
974 dwc3_prepare_one_trb_sg(dep, req, trbs_left--);
976 dwc3_prepare_one_trb_linear(dep, req, trbs_left--);
983 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
985 struct dwc3_gadget_ep_cmd_params params;
986 struct dwc3_request *req;
987 struct dwc3 *dwc = dep->dwc;
992 starting = !(dep->flags & DWC3_EP_BUSY);
994 dwc3_prepare_trbs(dep);
995 req = next_request(&dep->started_list);
997 dep->flags |= DWC3_EP_PENDING_REQUEST;
1001 memset(¶ms, 0, sizeof(params));
1004 params.param0 = upper_32_bits(req->trb_dma);
1005 params.param1 = lower_32_bits(req->trb_dma);
1006 cmd = DWC3_DEPCMD_STARTTRANSFER;
1008 cmd = DWC3_DEPCMD_UPDATETRANSFER;
1011 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
1012 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1015 * FIXME we need to iterate over the list of requests
1016 * here and stop, unmap, free and del each of the linked
1017 * requests instead of what we do now.
1019 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1021 list_del(&req->list);
1025 dep->flags |= DWC3_EP_BUSY;
1028 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
1030 WARN_ON_ONCE(!dep->resource_index);
1036 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1037 struct dwc3_ep *dep, u32 cur_uf)
1041 if (list_empty(&dep->pending_list)) {
1042 dwc3_trace(trace_dwc3_gadget,
1043 "ISOC ep %s run out for requests",
1045 dep->flags |= DWC3_EP_PENDING_REQUEST;
1049 /* 4 micro frames in the future */
1050 uf = cur_uf + dep->interval * 4;
1052 __dwc3_gadget_kick_transfer(dep, uf);
1055 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1056 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1060 mask = ~(dep->interval - 1);
1061 cur_uf = event->parameters & mask;
1063 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1066 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1068 struct dwc3 *dwc = dep->dwc;
1071 if (!dep->endpoint.desc) {
1072 dwc3_trace(trace_dwc3_gadget,
1073 "trying to queue request %p to disabled %s\n",
1074 &req->request, dep->endpoint.name);
1078 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1079 &req->request, req->dep->name)) {
1080 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1081 &req->request, req->dep->name);
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->pending_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);
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->started_list)) {
1145 dwc3_stop_active_transfer(dwc, dep->number, true);
1146 dep->flags = DWC3_EP_ENABLED;
1151 ret = __dwc3_gadget_kick_transfer(dep, 0);
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);
1172 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1173 * right away, otherwise host will not know we have streams to be
1176 if (dep->stream_capable)
1177 ret = __dwc3_gadget_kick_transfer(dep, 0);
1180 if (ret && ret != -EBUSY)
1181 dwc3_trace(trace_dwc3_gadget,
1182 "%s: failed to kick transfers\n",
1190 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1191 struct usb_request *request)
1193 dwc3_gadget_ep_free_request(ep, request);
1196 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1198 struct dwc3_request *req;
1199 struct usb_request *request;
1200 struct usb_ep *ep = &dep->endpoint;
1202 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1203 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1207 request->length = 0;
1208 request->buf = dwc->zlp_buf;
1209 request->complete = __dwc3_gadget_ep_zlp_complete;
1211 req = to_dwc3_request(request);
1213 return __dwc3_gadget_ep_queue(dep, req);
1216 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1219 struct dwc3_request *req = to_dwc3_request(request);
1220 struct dwc3_ep *dep = to_dwc3_ep(ep);
1221 struct dwc3 *dwc = dep->dwc;
1223 unsigned long flags;
1227 spin_lock_irqsave(&dwc->lock, flags);
1228 ret = __dwc3_gadget_ep_queue(dep, req);
1231 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1232 * setting request->zero, instead of doing magic, we will just queue an
1233 * extra usb_request ourselves so that it gets handled the same way as
1234 * any other request.
1236 if (ret == 0 && request->zero && request->length &&
1237 (request->length % ep->maxpacket == 0))
1238 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1240 spin_unlock_irqrestore(&dwc->lock, flags);
1245 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1246 struct usb_request *request)
1248 struct dwc3_request *req = to_dwc3_request(request);
1249 struct dwc3_request *r = NULL;
1251 struct dwc3_ep *dep = to_dwc3_ep(ep);
1252 struct dwc3 *dwc = dep->dwc;
1254 unsigned long flags;
1257 trace_dwc3_ep_dequeue(req);
1259 spin_lock_irqsave(&dwc->lock, flags);
1261 list_for_each_entry(r, &dep->pending_list, list) {
1267 list_for_each_entry(r, &dep->started_list, list) {
1272 /* wait until it is processed */
1273 dwc3_stop_active_transfer(dwc, dep->number, true);
1276 dev_err(dwc->dev, "request %p was not queued to %s\n",
1283 /* giveback the request */
1284 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1287 spin_unlock_irqrestore(&dwc->lock, flags);
1292 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1294 struct dwc3_gadget_ep_cmd_params params;
1295 struct dwc3 *dwc = dep->dwc;
1298 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1299 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1303 memset(¶ms, 0x00, sizeof(params));
1306 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1307 (!list_empty(&dep->started_list) ||
1308 !list_empty(&dep->pending_list)))) {
1309 dwc3_trace(trace_dwc3_gadget,
1310 "%s: pending request, cannot halt",
1315 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1318 dev_err(dwc->dev, "failed to set STALL on %s\n",
1321 dep->flags |= DWC3_EP_STALL;
1324 ret = dwc3_send_clear_stall_ep_cmd(dep);
1326 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1329 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1335 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1337 struct dwc3_ep *dep = to_dwc3_ep(ep);
1338 struct dwc3 *dwc = dep->dwc;
1340 unsigned long flags;
1344 spin_lock_irqsave(&dwc->lock, flags);
1345 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1346 spin_unlock_irqrestore(&dwc->lock, flags);
1351 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1353 struct dwc3_ep *dep = to_dwc3_ep(ep);
1354 struct dwc3 *dwc = dep->dwc;
1355 unsigned long flags;
1358 spin_lock_irqsave(&dwc->lock, flags);
1359 dep->flags |= DWC3_EP_WEDGE;
1361 if (dep->number == 0 || dep->number == 1)
1362 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1364 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1365 spin_unlock_irqrestore(&dwc->lock, flags);
1370 /* -------------------------------------------------------------------------- */
1372 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1373 .bLength = USB_DT_ENDPOINT_SIZE,
1374 .bDescriptorType = USB_DT_ENDPOINT,
1375 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1378 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1379 .enable = dwc3_gadget_ep0_enable,
1380 .disable = dwc3_gadget_ep0_disable,
1381 .alloc_request = dwc3_gadget_ep_alloc_request,
1382 .free_request = dwc3_gadget_ep_free_request,
1383 .queue = dwc3_gadget_ep0_queue,
1384 .dequeue = dwc3_gadget_ep_dequeue,
1385 .set_halt = dwc3_gadget_ep0_set_halt,
1386 .set_wedge = dwc3_gadget_ep_set_wedge,
1389 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1390 .enable = dwc3_gadget_ep_enable,
1391 .disable = dwc3_gadget_ep_disable,
1392 .alloc_request = dwc3_gadget_ep_alloc_request,
1393 .free_request = dwc3_gadget_ep_free_request,
1394 .queue = dwc3_gadget_ep_queue,
1395 .dequeue = dwc3_gadget_ep_dequeue,
1396 .set_halt = dwc3_gadget_ep_set_halt,
1397 .set_wedge = dwc3_gadget_ep_set_wedge,
1400 /* -------------------------------------------------------------------------- */
1402 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1404 struct dwc3 *dwc = gadget_to_dwc(g);
1407 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1408 return DWC3_DSTS_SOFFN(reg);
1411 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1413 unsigned long timeout;
1422 * According to the Databook Remote wakeup request should
1423 * be issued only when the device is in early suspend state.
1425 * We can check that via USB Link State bits in DSTS register.
1427 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1429 speed = reg & DWC3_DSTS_CONNECTSPD;
1430 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1431 (speed == DWC3_DSTS_SUPERSPEED_PLUS)) {
1432 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1436 link_state = DWC3_DSTS_USBLNKST(reg);
1438 switch (link_state) {
1439 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1440 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1443 dwc3_trace(trace_dwc3_gadget,
1444 "can't wakeup from '%s'\n",
1445 dwc3_gadget_link_string(link_state));
1449 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1451 dev_err(dwc->dev, "failed to put link in Recovery\n");
1455 /* Recent versions do this automatically */
1456 if (dwc->revision < DWC3_REVISION_194A) {
1457 /* write zeroes to Link Change Request */
1458 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1459 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1460 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1463 /* poll until Link State changes to ON */
1464 timeout = jiffies + msecs_to_jiffies(100);
1466 while (!time_after(jiffies, timeout)) {
1467 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1469 /* in HS, means ON */
1470 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1474 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1475 dev_err(dwc->dev, "failed to send remote wakeup\n");
1482 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1484 struct dwc3 *dwc = gadget_to_dwc(g);
1485 unsigned long flags;
1488 spin_lock_irqsave(&dwc->lock, flags);
1489 ret = __dwc3_gadget_wakeup(dwc);
1490 spin_unlock_irqrestore(&dwc->lock, flags);
1495 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1498 struct dwc3 *dwc = gadget_to_dwc(g);
1499 unsigned long flags;
1501 spin_lock_irqsave(&dwc->lock, flags);
1502 g->is_selfpowered = !!is_selfpowered;
1503 spin_unlock_irqrestore(&dwc->lock, flags);
1508 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1513 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1515 if (dwc->revision <= DWC3_REVISION_187A) {
1516 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1517 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1520 if (dwc->revision >= DWC3_REVISION_194A)
1521 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1522 reg |= DWC3_DCTL_RUN_STOP;
1524 if (dwc->has_hibernation)
1525 reg |= DWC3_DCTL_KEEP_CONNECT;
1527 dwc->pullups_connected = true;
1529 reg &= ~DWC3_DCTL_RUN_STOP;
1531 if (dwc->has_hibernation && !suspend)
1532 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1534 dwc->pullups_connected = false;
1537 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1540 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1542 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1545 if (reg & DWC3_DSTS_DEVCTRLHLT)
1554 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1556 ? dwc->gadget_driver->function : "no-function",
1557 is_on ? "connect" : "disconnect");
1562 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1564 struct dwc3 *dwc = gadget_to_dwc(g);
1565 unsigned long flags;
1570 spin_lock_irqsave(&dwc->lock, flags);
1571 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1572 spin_unlock_irqrestore(&dwc->lock, flags);
1577 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1581 /* Enable all but Start and End of Frame IRQs */
1582 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1583 DWC3_DEVTEN_EVNTOVERFLOWEN |
1584 DWC3_DEVTEN_CMDCMPLTEN |
1585 DWC3_DEVTEN_ERRTICERREN |
1586 DWC3_DEVTEN_WKUPEVTEN |
1587 DWC3_DEVTEN_ULSTCNGEN |
1588 DWC3_DEVTEN_CONNECTDONEEN |
1589 DWC3_DEVTEN_USBRSTEN |
1590 DWC3_DEVTEN_DISCONNEVTEN);
1592 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1595 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1597 /* mask all interrupts */
1598 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1601 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1602 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1605 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1606 * dwc: pointer to our context structure
1608 * The following looks like complex but it's actually very simple. In order to
1609 * calculate the number of packets we can burst at once on OUT transfers, we're
1610 * gonna use RxFIFO size.
1612 * To calculate RxFIFO size we need two numbers:
1613 * MDWIDTH = size, in bits, of the internal memory bus
1614 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1616 * Given these two numbers, the formula is simple:
1618 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1620 * 24 bytes is for 3x SETUP packets
1621 * 16 bytes is a clock domain crossing tolerance
1623 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1625 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1632 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1633 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1635 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1636 nump = min_t(u32, nump, 16);
1639 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1640 reg &= ~DWC3_DCFG_NUMP_MASK;
1641 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1642 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1645 static int __dwc3_gadget_start(struct dwc3 *dwc)
1647 struct dwc3_ep *dep;
1651 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1652 reg &= ~(DWC3_DCFG_SPEED_MASK);
1655 * WORKAROUND: DWC3 revision < 2.20a have an issue
1656 * which would cause metastability state on Run/Stop
1657 * bit if we try to force the IP to USB2-only mode.
1659 * Because of that, we cannot configure the IP to any
1660 * speed other than the SuperSpeed
1664 * STAR#9000525659: Clock Domain Crossing on DCTL in
1667 if (dwc->revision < DWC3_REVISION_220A) {
1668 reg |= DWC3_DCFG_SUPERSPEED;
1670 switch (dwc->maximum_speed) {
1672 reg |= DWC3_DSTS_LOWSPEED;
1674 case USB_SPEED_FULL:
1675 reg |= DWC3_DSTS_FULLSPEED1;
1677 case USB_SPEED_HIGH:
1678 reg |= DWC3_DSTS_HIGHSPEED;
1680 case USB_SPEED_SUPER_PLUS:
1681 reg |= DWC3_DSTS_SUPERSPEED_PLUS;
1684 dev_err(dwc->dev, "invalid dwc->maximum_speed (%d)\n",
1685 dwc->maximum_speed);
1687 case USB_SPEED_SUPER:
1688 reg |= DWC3_DCFG_SUPERSPEED;
1692 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1695 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1696 * field instead of letting dwc3 itself calculate that automatically.
1698 * This way, we maximize the chances that we'll be able to get several
1699 * bursts of data without going through any sort of endpoint throttling.
1701 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1702 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1703 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1705 dwc3_gadget_setup_nump(dwc);
1707 /* Start with SuperSpeed Default */
1708 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1711 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1714 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1719 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1722 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1726 /* begin to receive SETUP packets */
1727 dwc->ep0state = EP0_SETUP_PHASE;
1728 dwc3_ep0_out_start(dwc);
1730 dwc3_gadget_enable_irq(dwc);
1735 __dwc3_gadget_ep_disable(dwc->eps[0]);
1741 static int dwc3_gadget_start(struct usb_gadget *g,
1742 struct usb_gadget_driver *driver)
1744 struct dwc3 *dwc = gadget_to_dwc(g);
1745 unsigned long flags;
1749 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1750 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1751 IRQF_SHARED, "dwc3", dwc->ev_buf);
1753 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1758 spin_lock_irqsave(&dwc->lock, flags);
1759 if (dwc->gadget_driver) {
1760 dev_err(dwc->dev, "%s is already bound to %s\n",
1762 dwc->gadget_driver->driver.name);
1767 dwc->gadget_driver = driver;
1769 __dwc3_gadget_start(dwc);
1770 spin_unlock_irqrestore(&dwc->lock, flags);
1775 spin_unlock_irqrestore(&dwc->lock, flags);
1782 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1784 dwc3_gadget_disable_irq(dwc);
1785 __dwc3_gadget_ep_disable(dwc->eps[0]);
1786 __dwc3_gadget_ep_disable(dwc->eps[1]);
1789 static int dwc3_gadget_stop(struct usb_gadget *g)
1791 struct dwc3 *dwc = gadget_to_dwc(g);
1792 unsigned long flags;
1795 spin_lock_irqsave(&dwc->lock, flags);
1796 __dwc3_gadget_stop(dwc);
1797 dwc->gadget_driver = NULL;
1798 spin_unlock_irqrestore(&dwc->lock, flags);
1800 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1801 free_irq(irq, dwc->ev_buf);
1806 static const struct usb_gadget_ops dwc3_gadget_ops = {
1807 .get_frame = dwc3_gadget_get_frame,
1808 .wakeup = dwc3_gadget_wakeup,
1809 .set_selfpowered = dwc3_gadget_set_selfpowered,
1810 .pullup = dwc3_gadget_pullup,
1811 .udc_start = dwc3_gadget_start,
1812 .udc_stop = dwc3_gadget_stop,
1815 /* -------------------------------------------------------------------------- */
1817 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1818 u8 num, u32 direction)
1820 struct dwc3_ep *dep;
1823 for (i = 0; i < num; i++) {
1824 u8 epnum = (i << 1) | (!!direction);
1826 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1831 dep->number = epnum;
1832 dep->direction = !!direction;
1833 dwc->eps[epnum] = dep;
1835 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1836 (epnum & 1) ? "in" : "out");
1838 dep->endpoint.name = dep->name;
1840 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1842 if (epnum == 0 || epnum == 1) {
1843 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1844 dep->endpoint.maxburst = 1;
1845 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1847 dwc->gadget.ep0 = &dep->endpoint;
1851 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1852 dep->endpoint.max_streams = 15;
1853 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1854 list_add_tail(&dep->endpoint.ep_list,
1855 &dwc->gadget.ep_list);
1857 ret = dwc3_alloc_trb_pool(dep);
1862 if (epnum == 0 || epnum == 1) {
1863 dep->endpoint.caps.type_control = true;
1865 dep->endpoint.caps.type_iso = true;
1866 dep->endpoint.caps.type_bulk = true;
1867 dep->endpoint.caps.type_int = true;
1870 dep->endpoint.caps.dir_in = !!direction;
1871 dep->endpoint.caps.dir_out = !direction;
1873 INIT_LIST_HEAD(&dep->pending_list);
1874 INIT_LIST_HEAD(&dep->started_list);
1880 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1884 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1886 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1888 dwc3_trace(trace_dwc3_gadget,
1889 "failed to allocate OUT endpoints");
1893 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1895 dwc3_trace(trace_dwc3_gadget,
1896 "failed to allocate IN endpoints");
1903 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1905 struct dwc3_ep *dep;
1908 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1909 dep = dwc->eps[epnum];
1913 * Physical endpoints 0 and 1 are special; they form the
1914 * bi-directional USB endpoint 0.
1916 * For those two physical endpoints, we don't allocate a TRB
1917 * pool nor do we add them the endpoints list. Due to that, we
1918 * shouldn't do these two operations otherwise we would end up
1919 * with all sorts of bugs when removing dwc3.ko.
1921 if (epnum != 0 && epnum != 1) {
1922 dwc3_free_trb_pool(dep);
1923 list_del(&dep->endpoint.ep_list);
1930 /* -------------------------------------------------------------------------- */
1932 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1933 struct dwc3_request *req, struct dwc3_trb *trb,
1934 const struct dwc3_event_depevt *event, int status)
1937 unsigned int s_pkt = 0;
1938 unsigned int trb_status;
1940 trace_dwc3_complete_trb(dep, trb);
1942 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1944 * We continue despite the error. There is not much we
1945 * can do. If we don't clean it up we loop forever. If
1946 * we skip the TRB then it gets overwritten after a
1947 * while since we use them in a ring buffer. A BUG()
1948 * would help. Lets hope that if this occurs, someone
1949 * fixes the root cause instead of looking away :)
1951 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1953 count = trb->size & DWC3_TRB_SIZE_MASK;
1955 if (dep->direction) {
1957 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1958 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1959 dwc3_trace(trace_dwc3_gadget,
1960 "%s: incomplete IN transfer\n",
1963 * If missed isoc occurred and there is
1964 * no request queued then issue END
1965 * TRANSFER, so that core generates
1966 * next xfernotready and we will issue
1967 * a fresh START TRANSFER.
1968 * If there are still queued request
1969 * then wait, do not issue either END
1970 * or UPDATE TRANSFER, just attach next
1971 * request in pending_list during
1972 * giveback.If any future queued request
1973 * is successfully transferred then we
1974 * will issue UPDATE TRANSFER for all
1975 * request in the pending_list.
1977 dep->flags |= DWC3_EP_MISSED_ISOC;
1979 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1981 status = -ECONNRESET;
1984 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1987 if (count && (event->status & DEPEVT_STATUS_SHORT))
1992 * We assume here we will always receive the entire data block
1993 * which we should receive. Meaning, if we program RX to
1994 * receive 4K but we receive only 2K, we assume that's all we
1995 * should receive and we simply bounce the request back to the
1996 * gadget driver for further processing.
1998 req->request.actual += req->request.length - count;
2001 if ((event->status & DEPEVT_STATUS_LST) &&
2002 (trb->ctrl & (DWC3_TRB_CTRL_LST |
2003 DWC3_TRB_CTRL_HWO)))
2005 if ((event->status & DEPEVT_STATUS_IOC) &&
2006 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2011 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
2012 const struct dwc3_event_depevt *event, int status)
2014 struct dwc3_request *req;
2015 struct dwc3_trb *trb;
2021 req = next_request(&dep->started_list);
2022 if (WARN_ON_ONCE(!req))
2027 slot = req->first_trb_index + i;
2028 if (slot == DWC3_TRB_NUM - 1)
2030 slot %= DWC3_TRB_NUM;
2031 trb = &dep->trb_pool[slot];
2033 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2037 } while (++i < req->request.num_mapped_sgs);
2039 dwc3_gadget_giveback(dep, req, status);
2045 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2046 list_empty(&dep->started_list)) {
2047 if (list_empty(&dep->pending_list)) {
2049 * If there is no entry in request list then do
2050 * not issue END TRANSFER now. Just set PENDING
2051 * flag, so that END TRANSFER is issued when an
2052 * entry is added into request list.
2054 dep->flags = DWC3_EP_PENDING_REQUEST;
2056 dwc3_stop_active_transfer(dwc, dep->number, true);
2057 dep->flags = DWC3_EP_ENABLED;
2065 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2066 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2068 unsigned status = 0;
2070 u32 is_xfer_complete;
2072 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2074 if (event->status & DEPEVT_STATUS_BUSERR)
2075 status = -ECONNRESET;
2077 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2078 if (clean_busy && (is_xfer_complete ||
2079 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2080 dep->flags &= ~DWC3_EP_BUSY;
2083 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2084 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2086 if (dwc->revision < DWC3_REVISION_183A) {
2090 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2093 if (!(dep->flags & DWC3_EP_ENABLED))
2096 if (!list_empty(&dep->started_list))
2100 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2102 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2107 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2110 ret = __dwc3_gadget_kick_transfer(dep, 0);
2111 if (!ret || ret == -EBUSY)
2116 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2117 const struct dwc3_event_depevt *event)
2119 struct dwc3_ep *dep;
2120 u8 epnum = event->endpoint_number;
2122 dep = dwc->eps[epnum];
2124 if (!(dep->flags & DWC3_EP_ENABLED))
2127 if (epnum == 0 || epnum == 1) {
2128 dwc3_ep0_interrupt(dwc, event);
2132 switch (event->endpoint_event) {
2133 case DWC3_DEPEVT_XFERCOMPLETE:
2134 dep->resource_index = 0;
2136 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2137 dwc3_trace(trace_dwc3_gadget,
2138 "%s is an Isochronous endpoint\n",
2143 dwc3_endpoint_transfer_complete(dwc, dep, event);
2145 case DWC3_DEPEVT_XFERINPROGRESS:
2146 dwc3_endpoint_transfer_complete(dwc, dep, event);
2148 case DWC3_DEPEVT_XFERNOTREADY:
2149 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2150 dwc3_gadget_start_isoc(dwc, dep, event);
2155 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2157 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2158 dep->name, active ? "Transfer Active"
2159 : "Transfer Not Active");
2161 ret = __dwc3_gadget_kick_transfer(dep, 0);
2162 if (!ret || ret == -EBUSY)
2165 dwc3_trace(trace_dwc3_gadget,
2166 "%s: failed to kick transfers\n",
2171 case DWC3_DEPEVT_STREAMEVT:
2172 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2173 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2178 switch (event->status) {
2179 case DEPEVT_STREAMEVT_FOUND:
2180 dwc3_trace(trace_dwc3_gadget,
2181 "Stream %d found and started",
2185 case DEPEVT_STREAMEVT_NOTFOUND:
2188 dwc3_trace(trace_dwc3_gadget,
2189 "unable to find suitable stream\n");
2192 case DWC3_DEPEVT_RXTXFIFOEVT:
2193 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2195 case DWC3_DEPEVT_EPCMDCMPLT:
2196 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2201 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2203 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2204 spin_unlock(&dwc->lock);
2205 dwc->gadget_driver->disconnect(&dwc->gadget);
2206 spin_lock(&dwc->lock);
2210 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2212 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2213 spin_unlock(&dwc->lock);
2214 dwc->gadget_driver->suspend(&dwc->gadget);
2215 spin_lock(&dwc->lock);
2219 static void dwc3_resume_gadget(struct dwc3 *dwc)
2221 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2222 spin_unlock(&dwc->lock);
2223 dwc->gadget_driver->resume(&dwc->gadget);
2224 spin_lock(&dwc->lock);
2228 static void dwc3_reset_gadget(struct dwc3 *dwc)
2230 if (!dwc->gadget_driver)
2233 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2234 spin_unlock(&dwc->lock);
2235 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2236 spin_lock(&dwc->lock);
2240 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2242 struct dwc3_ep *dep;
2243 struct dwc3_gadget_ep_cmd_params params;
2247 dep = dwc->eps[epnum];
2249 if (!dep->resource_index)
2253 * NOTICE: We are violating what the Databook says about the
2254 * EndTransfer command. Ideally we would _always_ wait for the
2255 * EndTransfer Command Completion IRQ, but that's causing too
2256 * much trouble synchronizing between us and gadget driver.
2258 * We have discussed this with the IP Provider and it was
2259 * suggested to giveback all requests here, but give HW some
2260 * extra time to synchronize with the interconnect. We're using
2261 * an arbitrary 100us delay for that.
2263 * Note also that a similar handling was tested by Synopsys
2264 * (thanks a lot Paul) and nothing bad has come out of it.
2265 * In short, what we're doing is:
2267 * - Issue EndTransfer WITH CMDIOC bit set
2271 cmd = DWC3_DEPCMD_ENDTRANSFER;
2272 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2273 cmd |= DWC3_DEPCMD_CMDIOC;
2274 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2275 memset(¶ms, 0, sizeof(params));
2276 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2278 dep->resource_index = 0;
2279 dep->flags &= ~DWC3_EP_BUSY;
2283 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2287 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2288 struct dwc3_ep *dep;
2290 dep = dwc->eps[epnum];
2294 if (!(dep->flags & DWC3_EP_ENABLED))
2297 dwc3_remove_requests(dwc, dep);
2301 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2305 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2306 struct dwc3_ep *dep;
2309 dep = dwc->eps[epnum];
2313 if (!(dep->flags & DWC3_EP_STALL))
2316 dep->flags &= ~DWC3_EP_STALL;
2318 ret = dwc3_send_clear_stall_ep_cmd(dep);
2323 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2327 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2328 reg &= ~DWC3_DCTL_INITU1ENA;
2329 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2331 reg &= ~DWC3_DCTL_INITU2ENA;
2332 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2334 dwc3_disconnect_gadget(dwc);
2336 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2337 dwc->setup_packet_pending = false;
2338 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2341 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2346 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2347 * would cause a missing Disconnect Event if there's a
2348 * pending Setup Packet in the FIFO.
2350 * There's no suggested workaround on the official Bug
2351 * report, which states that "unless the driver/application
2352 * is doing any special handling of a disconnect event,
2353 * there is no functional issue".
2355 * Unfortunately, it turns out that we _do_ some special
2356 * handling of a disconnect event, namely complete all
2357 * pending transfers, notify gadget driver of the
2358 * disconnection, and so on.
2360 * Our suggested workaround is to follow the Disconnect
2361 * Event steps here, instead, based on a setup_packet_pending
2362 * flag. Such flag gets set whenever we have a SETUP_PENDING
2363 * status for EP0 TRBs and gets cleared on XferComplete for the
2368 * STAR#9000466709: RTL: Device : Disconnect event not
2369 * generated if setup packet pending in FIFO
2371 if (dwc->revision < DWC3_REVISION_188A) {
2372 if (dwc->setup_packet_pending)
2373 dwc3_gadget_disconnect_interrupt(dwc);
2376 dwc3_reset_gadget(dwc);
2378 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2379 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2380 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2381 dwc->test_mode = false;
2383 dwc3_stop_active_transfers(dwc);
2384 dwc3_clear_stall_all_ep(dwc);
2386 /* Reset device address to zero */
2387 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2388 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2389 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2392 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2395 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2398 * We change the clock only at SS but I dunno why I would want to do
2399 * this. Maybe it becomes part of the power saving plan.
2402 if ((speed != DWC3_DSTS_SUPERSPEED) &&
2403 (speed != DWC3_DSTS_SUPERSPEED_PLUS))
2407 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2408 * each time on Connect Done.
2413 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2414 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2415 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2418 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2420 struct dwc3_ep *dep;
2425 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2426 speed = reg & DWC3_DSTS_CONNECTSPD;
2429 dwc3_update_ram_clk_sel(dwc, speed);
2432 case DWC3_DCFG_SUPERSPEED_PLUS:
2433 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2434 dwc->gadget.ep0->maxpacket = 512;
2435 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2437 case DWC3_DCFG_SUPERSPEED:
2439 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2440 * would cause a missing USB3 Reset event.
2442 * In such situations, we should force a USB3 Reset
2443 * event by calling our dwc3_gadget_reset_interrupt()
2448 * STAR#9000483510: RTL: SS : USB3 reset event may
2449 * not be generated always when the link enters poll
2451 if (dwc->revision < DWC3_REVISION_190A)
2452 dwc3_gadget_reset_interrupt(dwc);
2454 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2455 dwc->gadget.ep0->maxpacket = 512;
2456 dwc->gadget.speed = USB_SPEED_SUPER;
2458 case DWC3_DCFG_HIGHSPEED:
2459 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2460 dwc->gadget.ep0->maxpacket = 64;
2461 dwc->gadget.speed = USB_SPEED_HIGH;
2463 case DWC3_DCFG_FULLSPEED2:
2464 case DWC3_DCFG_FULLSPEED1:
2465 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2466 dwc->gadget.ep0->maxpacket = 64;
2467 dwc->gadget.speed = USB_SPEED_FULL;
2469 case DWC3_DCFG_LOWSPEED:
2470 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2471 dwc->gadget.ep0->maxpacket = 8;
2472 dwc->gadget.speed = USB_SPEED_LOW;
2476 /* Enable USB2 LPM Capability */
2478 if ((dwc->revision > DWC3_REVISION_194A) &&
2479 (speed != DWC3_DCFG_SUPERSPEED) &&
2480 (speed != DWC3_DCFG_SUPERSPEED_PLUS)) {
2481 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2482 reg |= DWC3_DCFG_LPM_CAP;
2483 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2485 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2486 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2488 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2491 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2492 * DCFG.LPMCap is set, core responses with an ACK and the
2493 * BESL value in the LPM token is less than or equal to LPM
2496 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2497 && dwc->has_lpm_erratum,
2498 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2500 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2501 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2503 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2505 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2506 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2507 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2511 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2514 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2519 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2522 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2527 * Configure PHY via GUSB3PIPECTLn if required.
2529 * Update GTXFIFOSIZn
2531 * In both cases reset values should be sufficient.
2535 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2538 * TODO take core out of low power mode when that's
2542 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2543 spin_unlock(&dwc->lock);
2544 dwc->gadget_driver->resume(&dwc->gadget);
2545 spin_lock(&dwc->lock);
2549 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2550 unsigned int evtinfo)
2552 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2553 unsigned int pwropt;
2556 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2557 * Hibernation mode enabled which would show up when device detects
2558 * host-initiated U3 exit.
2560 * In that case, device will generate a Link State Change Interrupt
2561 * from U3 to RESUME which is only necessary if Hibernation is
2564 * There are no functional changes due to such spurious event and we
2565 * just need to ignore it.
2569 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2572 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2573 if ((dwc->revision < DWC3_REVISION_250A) &&
2574 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2575 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2576 (next == DWC3_LINK_STATE_RESUME)) {
2577 dwc3_trace(trace_dwc3_gadget,
2578 "ignoring transition U3 -> Resume");
2584 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2585 * on the link partner, the USB session might do multiple entry/exit
2586 * of low power states before a transfer takes place.
2588 * Due to this problem, we might experience lower throughput. The
2589 * suggested workaround is to disable DCTL[12:9] bits if we're
2590 * transitioning from U1/U2 to U0 and enable those bits again
2591 * after a transfer completes and there are no pending transfers
2592 * on any of the enabled endpoints.
2594 * This is the first half of that workaround.
2598 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2599 * core send LGO_Ux entering U0
2601 if (dwc->revision < DWC3_REVISION_183A) {
2602 if (next == DWC3_LINK_STATE_U0) {
2606 switch (dwc->link_state) {
2607 case DWC3_LINK_STATE_U1:
2608 case DWC3_LINK_STATE_U2:
2609 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2610 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2611 | DWC3_DCTL_ACCEPTU2ENA
2612 | DWC3_DCTL_INITU1ENA
2613 | DWC3_DCTL_ACCEPTU1ENA);
2616 dwc->u1u2 = reg & u1u2;
2620 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2630 case DWC3_LINK_STATE_U1:
2631 if (dwc->speed == USB_SPEED_SUPER)
2632 dwc3_suspend_gadget(dwc);
2634 case DWC3_LINK_STATE_U2:
2635 case DWC3_LINK_STATE_U3:
2636 dwc3_suspend_gadget(dwc);
2638 case DWC3_LINK_STATE_RESUME:
2639 dwc3_resume_gadget(dwc);
2646 dwc->link_state = next;
2649 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2650 unsigned int evtinfo)
2652 unsigned int is_ss = evtinfo & BIT(4);
2655 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2656 * have a known issue which can cause USB CV TD.9.23 to fail
2659 * Because of this issue, core could generate bogus hibernation
2660 * events which SW needs to ignore.
2664 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2665 * Device Fallback from SuperSpeed
2667 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2670 /* enter hibernation here */
2673 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2674 const struct dwc3_event_devt *event)
2676 switch (event->type) {
2677 case DWC3_DEVICE_EVENT_DISCONNECT:
2678 dwc3_gadget_disconnect_interrupt(dwc);
2680 case DWC3_DEVICE_EVENT_RESET:
2681 dwc3_gadget_reset_interrupt(dwc);
2683 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2684 dwc3_gadget_conndone_interrupt(dwc);
2686 case DWC3_DEVICE_EVENT_WAKEUP:
2687 dwc3_gadget_wakeup_interrupt(dwc);
2689 case DWC3_DEVICE_EVENT_HIBER_REQ:
2690 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2691 "unexpected hibernation event\n"))
2694 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2696 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2697 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2699 case DWC3_DEVICE_EVENT_EOPF:
2700 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2702 case DWC3_DEVICE_EVENT_SOF:
2703 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2705 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2706 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2708 case DWC3_DEVICE_EVENT_CMD_CMPL:
2709 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2711 case DWC3_DEVICE_EVENT_OVERFLOW:
2712 dwc3_trace(trace_dwc3_gadget, "Overflow");
2715 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2719 static void dwc3_process_event_entry(struct dwc3 *dwc,
2720 const union dwc3_event *event)
2722 trace_dwc3_event(event->raw);
2724 /* Endpoint IRQ, handle it and return early */
2725 if (event->type.is_devspec == 0) {
2727 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2730 switch (event->type.type) {
2731 case DWC3_EVENT_TYPE_DEV:
2732 dwc3_gadget_interrupt(dwc, &event->devt);
2734 /* REVISIT what to do with Carkit and I2C events ? */
2736 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2740 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2742 struct dwc3 *dwc = evt->dwc;
2743 irqreturn_t ret = IRQ_NONE;
2749 if (!(evt->flags & DWC3_EVENT_PENDING))
2753 union dwc3_event event;
2755 event.raw = *(u32 *) (evt->buf + evt->lpos);
2757 dwc3_process_event_entry(dwc, &event);
2760 * FIXME we wrap around correctly to the next entry as
2761 * almost all entries are 4 bytes in size. There is one
2762 * entry which has 12 bytes which is a regular entry
2763 * followed by 8 bytes data. ATM I don't know how
2764 * things are organized if we get next to the a
2765 * boundary so I worry about that once we try to handle
2768 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2771 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2775 evt->flags &= ~DWC3_EVENT_PENDING;
2778 /* Unmask interrupt */
2779 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2780 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2781 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2786 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2788 struct dwc3_event_buffer *evt = _evt;
2789 struct dwc3 *dwc = evt->dwc;
2790 unsigned long flags;
2791 irqreturn_t ret = IRQ_NONE;
2793 spin_lock_irqsave(&dwc->lock, flags);
2794 ret = dwc3_process_event_buf(evt);
2795 spin_unlock_irqrestore(&dwc->lock, flags);
2800 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2802 struct dwc3 *dwc = evt->dwc;
2806 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2807 count &= DWC3_GEVNTCOUNT_MASK;
2812 evt->flags |= DWC3_EVENT_PENDING;
2814 /* Mask interrupt */
2815 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2816 reg |= DWC3_GEVNTSIZ_INTMASK;
2817 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2819 return IRQ_WAKE_THREAD;
2822 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2824 struct dwc3_event_buffer *evt = _evt;
2826 return dwc3_check_event_buf(evt);
2830 * dwc3_gadget_init - Initializes gadget related registers
2831 * @dwc: pointer to our controller context structure
2833 * Returns 0 on success otherwise negative errno.
2835 int dwc3_gadget_init(struct dwc3 *dwc)
2839 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2840 &dwc->ctrl_req_addr, GFP_KERNEL);
2841 if (!dwc->ctrl_req) {
2842 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2847 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2848 &dwc->ep0_trb_addr, GFP_KERNEL);
2849 if (!dwc->ep0_trb) {
2850 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2855 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2856 if (!dwc->setup_buf) {
2861 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2862 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2864 if (!dwc->ep0_bounce) {
2865 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2870 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2871 if (!dwc->zlp_buf) {
2876 dwc->gadget.ops = &dwc3_gadget_ops;
2877 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2878 dwc->gadget.sg_supported = true;
2879 dwc->gadget.name = "dwc3-gadget";
2880 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2883 * FIXME We might be setting max_speed to <SUPER, however versions
2884 * <2.20a of dwc3 have an issue with metastability (documented
2885 * elsewhere in this driver) which tells us we can't set max speed to
2886 * anything lower than SUPER.
2888 * Because gadget.max_speed is only used by composite.c and function
2889 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2890 * to happen so we avoid sending SuperSpeed Capability descriptor
2891 * together with our BOS descriptor as that could confuse host into
2892 * thinking we can handle super speed.
2894 * Note that, in fact, we won't even support GetBOS requests when speed
2895 * is less than super speed because we don't have means, yet, to tell
2896 * composite.c that we are USB 2.0 + LPM ECN.
2898 if (dwc->revision < DWC3_REVISION_220A)
2899 dwc3_trace(trace_dwc3_gadget,
2900 "Changing max_speed on rev %08x\n",
2903 dwc->gadget.max_speed = dwc->maximum_speed;
2906 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2909 dwc->gadget.quirk_ep_out_aligned_size = true;
2912 * REVISIT: Here we should clear all pending IRQs to be
2913 * sure we're starting from a well known location.
2916 ret = dwc3_gadget_init_endpoints(dwc);
2920 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2922 dev_err(dwc->dev, "failed to register udc\n");
2929 kfree(dwc->zlp_buf);
2932 dwc3_gadget_free_endpoints(dwc);
2933 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2934 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2937 kfree(dwc->setup_buf);
2940 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2941 dwc->ep0_trb, dwc->ep0_trb_addr);
2944 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2945 dwc->ctrl_req, dwc->ctrl_req_addr);
2951 /* -------------------------------------------------------------------------- */
2953 void dwc3_gadget_exit(struct dwc3 *dwc)
2955 usb_del_gadget_udc(&dwc->gadget);
2957 dwc3_gadget_free_endpoints(dwc);
2959 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2960 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2962 kfree(dwc->setup_buf);
2963 kfree(dwc->zlp_buf);
2965 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2966 dwc->ep0_trb, dwc->ep0_trb_addr);
2968 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2969 dwc->ctrl_req, dwc->ctrl_req_addr);
2972 int dwc3_gadget_suspend(struct dwc3 *dwc)
2976 if (!dwc->gadget_driver)
2979 ret = dwc3_gadget_run_stop(dwc, false, false);
2983 dwc3_disconnect_gadget(dwc);
2984 __dwc3_gadget_stop(dwc);
2989 int dwc3_gadget_resume(struct dwc3 *dwc)
2993 if (!dwc->gadget_driver)
2996 ret = __dwc3_gadget_start(dwc);
3000 ret = dwc3_gadget_run_stop(dwc, true, false);
3007 __dwc3_gadget_stop(dwc);