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 pm_runtime_put(dwc->dev);
207 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
213 trace_dwc3_gadget_generic_cmd(cmd, param);
215 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
216 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
219 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
220 if (!(reg & DWC3_DGCMD_CMDACT)) {
221 dwc3_trace(trace_dwc3_gadget,
222 "Command Complete --> %d",
223 DWC3_DGCMD_STATUS(reg));
224 if (DWC3_DGCMD_STATUS(reg))
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;
253 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
254 * we're issuing an endpoint command, we must check if
255 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
257 * We will also set SUSPHY bit to what it was before returning as stated
258 * by the same section on Synopsys databook.
260 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
261 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
262 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
264 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
265 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
269 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
272 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
273 dwc->link_state == DWC3_LINK_STATE_U2 ||
274 dwc->link_state == DWC3_LINK_STATE_U3);
276 if (unlikely(needs_wakeup)) {
277 ret = __dwc3_gadget_wakeup(dwc);
278 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
283 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
284 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
285 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
287 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
289 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
290 if (!(reg & DWC3_DEPCMD_CMDACT)) {
291 cmd_status = DWC3_DEPCMD_STATUS(reg);
293 dwc3_trace(trace_dwc3_gadget,
294 "Command Complete --> %d",
297 switch (cmd_status) {
301 case DEPEVT_TRANSFER_NO_RESOURCE:
302 dwc3_trace(trace_dwc3_gadget, "no resource available");
305 case DEPEVT_TRANSFER_BUS_EXPIRY:
307 * SW issues START TRANSFER command to
308 * isochronous ep with future frame interval. If
309 * future interval time has already passed when
310 * core receives the command, it will respond
311 * with an error status of 'Bus Expiry'.
313 * Instead of always returning -EINVAL, let's
314 * give a hint to the gadget driver that this is
315 * the case by returning -EAGAIN.
317 dwc3_trace(trace_dwc3_gadget, "bus expiry");
321 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
329 dwc3_trace(trace_dwc3_gadget,
330 "Command Timed Out");
332 cmd_status = -ETIMEDOUT;
335 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
337 if (unlikely(susphy)) {
338 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
339 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
340 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
346 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
348 struct dwc3 *dwc = dep->dwc;
349 struct dwc3_gadget_ep_cmd_params params;
350 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
353 * As of core revision 2.60a the recommended programming model
354 * is to set the ClearPendIN bit when issuing a Clear Stall EP
355 * command for IN endpoints. This is to prevent an issue where
356 * some (non-compliant) hosts may not send ACK TPs for pending
357 * IN transfers due to a mishandled error condition. Synopsys
360 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
361 cmd |= DWC3_DEPCMD_CLEARPENDIN;
363 memset(¶ms, 0, sizeof(params));
365 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
368 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
369 struct dwc3_trb *trb)
371 u32 offset = (char *) trb - (char *) dep->trb_pool;
373 return dep->trb_pool_dma + offset;
376 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
378 struct dwc3 *dwc = dep->dwc;
383 dep->trb_pool = dma_alloc_coherent(dwc->dev,
384 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
385 &dep->trb_pool_dma, GFP_KERNEL);
386 if (!dep->trb_pool) {
387 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
395 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
397 struct dwc3 *dwc = dep->dwc;
399 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
400 dep->trb_pool, dep->trb_pool_dma);
402 dep->trb_pool = NULL;
403 dep->trb_pool_dma = 0;
406 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
409 * dwc3_gadget_start_config - Configure EP resources
410 * @dwc: pointer to our controller context structure
411 * @dep: endpoint that is being enabled
413 * The assignment of transfer resources cannot perfectly follow the
414 * data book due to the fact that the controller driver does not have
415 * all knowledge of the configuration in advance. It is given this
416 * information piecemeal by the composite gadget framework after every
417 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
418 * programming model in this scenario can cause errors. For two
421 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
422 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
423 * multiple interfaces.
425 * 2) The databook does not mention doing more DEPXFERCFG for new
426 * endpoint on alt setting (8.1.6).
428 * The following simplified method is used instead:
430 * All hardware endpoints can be assigned a transfer resource and this
431 * setting will stay persistent until either a core reset or
432 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
433 * do DEPXFERCFG for every hardware endpoint as well. We are
434 * guaranteed that there are as many transfer resources as endpoints.
436 * This function is called for each endpoint when it is being enabled
437 * but is triggered only when called for EP0-out, which always happens
438 * first, and which should only happen in one of the above conditions.
440 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
442 struct dwc3_gadget_ep_cmd_params params;
450 memset(¶ms, 0x00, sizeof(params));
451 cmd = DWC3_DEPCMD_DEPSTARTCFG;
453 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
457 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
458 struct dwc3_ep *dep = dwc->eps[i];
463 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
471 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
472 const struct usb_endpoint_descriptor *desc,
473 const struct usb_ss_ep_comp_descriptor *comp_desc,
474 bool ignore, bool restore)
476 struct dwc3_gadget_ep_cmd_params params;
478 memset(¶ms, 0x00, sizeof(params));
480 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
481 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
483 /* Burst size is only needed in SuperSpeed mode */
484 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
485 u32 burst = dep->endpoint.maxburst;
486 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
490 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
493 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
494 params.param2 |= dep->saved_state;
497 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
498 | DWC3_DEPCFG_XFER_NOT_READY_EN;
500 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
501 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
502 | DWC3_DEPCFG_STREAM_EVENT_EN;
503 dep->stream_capable = true;
506 if (!usb_endpoint_xfer_control(desc))
507 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
510 * We are doing 1:1 mapping for endpoints, meaning
511 * Physical Endpoints 2 maps to Logical Endpoint 2 and
512 * so on. We consider the direction bit as part of the physical
513 * endpoint number. So USB endpoint 0x81 is 0x03.
515 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
518 * We must use the lower 16 TX FIFOs even though
522 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
524 if (desc->bInterval) {
525 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
526 dep->interval = 1 << (desc->bInterval - 1);
529 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
532 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
534 struct dwc3_gadget_ep_cmd_params params;
536 memset(¶ms, 0x00, sizeof(params));
538 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
540 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
545 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
546 * @dep: endpoint to be initialized
547 * @desc: USB Endpoint Descriptor
549 * Caller should take care of locking
551 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
552 const struct usb_endpoint_descriptor *desc,
553 const struct usb_ss_ep_comp_descriptor *comp_desc,
554 bool ignore, bool restore)
556 struct dwc3 *dwc = dep->dwc;
560 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
562 if (!(dep->flags & DWC3_EP_ENABLED)) {
563 ret = dwc3_gadget_start_config(dwc, dep);
568 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
573 if (!(dep->flags & DWC3_EP_ENABLED)) {
574 struct dwc3_trb *trb_st_hw;
575 struct dwc3_trb *trb_link;
577 dep->endpoint.desc = desc;
578 dep->comp_desc = comp_desc;
579 dep->type = usb_endpoint_type(desc);
580 dep->flags |= DWC3_EP_ENABLED;
582 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
583 reg |= DWC3_DALEPENA_EP(dep->number);
584 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
586 if (usb_endpoint_xfer_control(desc))
589 /* Link TRB. The HWO bit is never reset */
590 trb_st_hw = &dep->trb_pool[0];
592 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
593 memset(trb_link, 0, sizeof(*trb_link));
595 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
596 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
597 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
598 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
604 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
605 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
607 struct dwc3_request *req;
609 if (!list_empty(&dep->started_list)) {
610 dwc3_stop_active_transfer(dwc, dep->number, true);
612 /* - giveback all requests to gadget driver */
613 while (!list_empty(&dep->started_list)) {
614 req = next_request(&dep->started_list);
616 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
620 while (!list_empty(&dep->pending_list)) {
621 req = next_request(&dep->pending_list);
623 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
628 * __dwc3_gadget_ep_disable - Disables a HW endpoint
629 * @dep: the endpoint to disable
631 * This function also removes requests which are currently processed ny the
632 * hardware and those which are not yet scheduled.
633 * Caller should take care of locking.
635 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
637 struct dwc3 *dwc = dep->dwc;
640 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
642 dwc3_remove_requests(dwc, dep);
644 /* make sure HW endpoint isn't stalled */
645 if (dep->flags & DWC3_EP_STALL)
646 __dwc3_gadget_ep_set_halt(dep, 0, false);
648 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
649 reg &= ~DWC3_DALEPENA_EP(dep->number);
650 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
652 dep->stream_capable = false;
653 dep->endpoint.desc = NULL;
654 dep->comp_desc = NULL;
661 /* -------------------------------------------------------------------------- */
663 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
664 const struct usb_endpoint_descriptor *desc)
669 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
674 /* -------------------------------------------------------------------------- */
676 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
677 const struct usb_endpoint_descriptor *desc)
684 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
685 pr_debug("dwc3: invalid parameters\n");
689 if (!desc->wMaxPacketSize) {
690 pr_debug("dwc3: missing wMaxPacketSize\n");
694 dep = to_dwc3_ep(ep);
697 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
698 "%s is already enabled\n",
702 spin_lock_irqsave(&dwc->lock, flags);
703 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
704 spin_unlock_irqrestore(&dwc->lock, flags);
709 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
717 pr_debug("dwc3: invalid parameters\n");
721 dep = to_dwc3_ep(ep);
724 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
725 "%s is already disabled\n",
729 spin_lock_irqsave(&dwc->lock, flags);
730 ret = __dwc3_gadget_ep_disable(dep);
731 spin_unlock_irqrestore(&dwc->lock, flags);
736 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
739 struct dwc3_request *req;
740 struct dwc3_ep *dep = to_dwc3_ep(ep);
742 req = kzalloc(sizeof(*req), gfp_flags);
746 req->epnum = dep->number;
749 trace_dwc3_alloc_request(req);
751 return &req->request;
754 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
755 struct usb_request *request)
757 struct dwc3_request *req = to_dwc3_request(request);
759 trace_dwc3_free_request(req);
764 * dwc3_prepare_one_trb - setup one TRB from one request
765 * @dep: endpoint for which this request is prepared
766 * @req: dwc3_request pointer
768 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
769 struct dwc3_request *req, dma_addr_t dma,
770 unsigned length, unsigned last, unsigned chain, unsigned node)
772 struct dwc3_trb *trb;
774 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
775 dep->name, req, (unsigned long long) dma,
776 length, last ? " last" : "",
777 chain ? " chain" : "");
780 trb = &dep->trb_pool[dep->trb_enqueue];
783 dwc3_gadget_move_started_request(req);
785 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
786 req->first_trb_index = dep->trb_enqueue;
789 dwc3_ep_inc_enq(dep);
790 /* Skip the LINK-TRB */
791 if (dwc3_ep_is_last_trb(dep->trb_enqueue))
792 dwc3_ep_inc_enq(dep);
794 trb->size = DWC3_TRB_SIZE_LENGTH(length);
795 trb->bpl = lower_32_bits(dma);
796 trb->bph = upper_32_bits(dma);
798 switch (usb_endpoint_type(dep->endpoint.desc)) {
799 case USB_ENDPOINT_XFER_CONTROL:
800 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
803 case USB_ENDPOINT_XFER_ISOC:
805 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
807 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
809 /* always enable Interrupt on Missed ISOC */
810 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
813 case USB_ENDPOINT_XFER_BULK:
814 case USB_ENDPOINT_XFER_INT:
815 trb->ctrl = DWC3_TRBCTL_NORMAL;
819 * This is only possible with faulty memory because we
820 * checked it already :)
825 /* always enable Continue on Short Packet */
826 trb->ctrl |= DWC3_TRB_CTRL_CSP;
828 if (!req->request.no_interrupt && !chain)
829 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
832 trb->ctrl |= DWC3_TRB_CTRL_LST;
835 trb->ctrl |= DWC3_TRB_CTRL_CHN;
837 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
838 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
840 trb->ctrl |= DWC3_TRB_CTRL_HWO;
842 trace_dwc3_prepare_trb(dep, trb);
845 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
847 struct dwc3_trb *tmp;
850 * If enqueue & dequeue are equal than it is either full or empty.
852 * One way to know for sure is if the TRB right before us has HWO bit
853 * set or not. If it has, then we're definitely full and can't fit any
854 * more transfers in our ring.
856 if (dep->trb_enqueue == dep->trb_dequeue) {
857 /* If we're full, enqueue/dequeue are > 0 */
858 if (dep->trb_enqueue) {
859 tmp = &dep->trb_pool[dep->trb_enqueue - 1];
860 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
864 return DWC3_TRB_NUM - 1;
867 return dep->trb_dequeue - dep->trb_enqueue;
870 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
871 struct dwc3_request *req, unsigned int trbs_left)
873 struct usb_request *request = &req->request;
874 struct scatterlist *sg = request->sg;
875 struct scatterlist *s;
876 unsigned int last = false;
881 for_each_sg(sg, s, request->num_mapped_sgs, i) {
882 unsigned chain = true;
884 length = sg_dma_len(s);
885 dma = sg_dma_address(s);
888 if (list_is_last(&req->list, &dep->pending_list))
900 dwc3_prepare_one_trb(dep, req, dma, length,
908 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
909 struct dwc3_request *req, unsigned int trbs_left)
911 unsigned int last = false;
915 dma = req->request.dma;
916 length = req->request.length;
921 /* Is this the last request? */
922 if (list_is_last(&req->list, &dep->pending_list))
925 dwc3_prepare_one_trb(dep, req, dma, length,
930 * dwc3_prepare_trbs - setup TRBs from requests
931 * @dep: endpoint for which requests are being prepared
933 * The function goes through the requests list and sets up TRBs for the
934 * transfers. The function returns once there are no more TRBs available or
935 * it runs out of requests.
937 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
939 struct dwc3_request *req, *n;
942 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
944 trbs_left = dwc3_calc_trbs_left(dep);
946 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
947 if (req->request.num_mapped_sgs > 0)
948 dwc3_prepare_one_trb_sg(dep, req, trbs_left--);
950 dwc3_prepare_one_trb_linear(dep, req, trbs_left--);
957 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
959 struct dwc3_gadget_ep_cmd_params params;
960 struct dwc3_request *req;
961 struct dwc3 *dwc = dep->dwc;
966 starting = !(dep->flags & DWC3_EP_BUSY);
968 dwc3_prepare_trbs(dep);
969 req = next_request(&dep->started_list);
971 dep->flags |= DWC3_EP_PENDING_REQUEST;
975 memset(¶ms, 0, sizeof(params));
978 params.param0 = upper_32_bits(req->trb_dma);
979 params.param1 = lower_32_bits(req->trb_dma);
980 cmd = DWC3_DEPCMD_STARTTRANSFER;
982 cmd = DWC3_DEPCMD_UPDATETRANSFER;
985 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
986 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
989 * FIXME we need to iterate over the list of requests
990 * here and stop, unmap, free and del each of the linked
991 * requests instead of what we do now.
993 usb_gadget_unmap_request(&dwc->gadget, &req->request,
995 list_del(&req->list);
999 dep->flags |= DWC3_EP_BUSY;
1002 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1003 WARN_ON_ONCE(!dep->resource_index);
1009 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1010 struct dwc3_ep *dep, u32 cur_uf)
1014 if (list_empty(&dep->pending_list)) {
1015 dwc3_trace(trace_dwc3_gadget,
1016 "ISOC ep %s run out for requests",
1018 dep->flags |= DWC3_EP_PENDING_REQUEST;
1022 /* 4 micro frames in the future */
1023 uf = cur_uf + dep->interval * 4;
1025 __dwc3_gadget_kick_transfer(dep, uf);
1028 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1029 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1033 mask = ~(dep->interval - 1);
1034 cur_uf = event->parameters & mask;
1036 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1039 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1041 struct dwc3 *dwc = dep->dwc;
1044 if (!dep->endpoint.desc) {
1045 dwc3_trace(trace_dwc3_gadget,
1046 "trying to queue request %p to disabled %s\n",
1047 &req->request, dep->endpoint.name);
1051 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1052 &req->request, req->dep->name)) {
1053 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1054 &req->request, req->dep->name);
1058 pm_runtime_get(dwc->dev);
1060 req->request.actual = 0;
1061 req->request.status = -EINPROGRESS;
1062 req->direction = dep->direction;
1063 req->epnum = dep->number;
1065 trace_dwc3_ep_queue(req);
1068 * Per databook, the total size of buffer must be a multiple
1069 * of MaxPacketSize for OUT endpoints. And MaxPacketSize is
1070 * configed for endpoints in dwc3_gadget_set_ep_config(),
1071 * set to usb_endpoint_descriptor->wMaxPacketSize.
1073 if (dep->direction == 0 &&
1074 req->request.length % dep->endpoint.desc->wMaxPacketSize)
1075 req->request.length = roundup(req->request.length,
1076 dep->endpoint.desc->wMaxPacketSize);
1079 * We only add to our list of requests now and
1080 * start consuming the list once we get XferNotReady
1083 * That way, we avoid doing anything that we don't need
1084 * to do now and defer it until the point we receive a
1085 * particular token from the Host side.
1087 * This will also avoid Host cancelling URBs due to too
1090 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1095 list_add_tail(&req->list, &dep->pending_list);
1098 * If there are no pending requests and the endpoint isn't already
1099 * busy, we will just start the request straight away.
1101 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1102 * little bit faster.
1104 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1105 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1106 !(dep->flags & DWC3_EP_BUSY)) {
1107 ret = __dwc3_gadget_kick_transfer(dep, 0);
1112 * There are a few special cases:
1114 * 1. XferNotReady with empty list of requests. We need to kick the
1115 * transfer here in that situation, otherwise we will be NAKing
1116 * forever. If we get XferNotReady before gadget driver has a
1117 * chance to queue a request, we will ACK the IRQ but won't be
1118 * able to receive the data until the next request is queued.
1119 * The following code is handling exactly that.
1122 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1124 * If xfernotready is already elapsed and it is a case
1125 * of isoc transfer, then issue END TRANSFER, so that
1126 * you can receive xfernotready again and can have
1127 * notion of current microframe.
1129 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1130 if (list_empty(&dep->started_list)) {
1131 dwc3_stop_active_transfer(dwc, dep->number, true);
1132 dep->flags = DWC3_EP_ENABLED;
1137 ret = __dwc3_gadget_kick_transfer(dep, 0);
1139 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1145 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1146 * kick the transfer here after queuing a request, otherwise the
1147 * core may not see the modified TRB(s).
1149 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1150 (dep->flags & DWC3_EP_BUSY) &&
1151 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1152 WARN_ON_ONCE(!dep->resource_index);
1153 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index);
1158 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1159 * right away, otherwise host will not know we have streams to be
1162 if (dep->stream_capable)
1163 ret = __dwc3_gadget_kick_transfer(dep, 0);
1166 if (ret && ret != -EBUSY)
1167 dwc3_trace(trace_dwc3_gadget,
1168 "%s: failed to kick transfers\n",
1176 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1177 struct usb_request *request)
1179 dwc3_gadget_ep_free_request(ep, request);
1182 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1184 struct dwc3_request *req;
1185 struct usb_request *request;
1186 struct usb_ep *ep = &dep->endpoint;
1188 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1189 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1193 request->length = 0;
1194 request->buf = dwc->zlp_buf;
1195 request->complete = __dwc3_gadget_ep_zlp_complete;
1197 req = to_dwc3_request(request);
1199 return __dwc3_gadget_ep_queue(dep, req);
1202 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1205 struct dwc3_request *req = to_dwc3_request(request);
1206 struct dwc3_ep *dep = to_dwc3_ep(ep);
1207 struct dwc3 *dwc = dep->dwc;
1209 unsigned long flags;
1213 spin_lock_irqsave(&dwc->lock, flags);
1214 ret = __dwc3_gadget_ep_queue(dep, req);
1217 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1218 * setting request->zero, instead of doing magic, we will just queue an
1219 * extra usb_request ourselves so that it gets handled the same way as
1220 * any other request.
1222 if (ret == 0 && request->zero && request->length &&
1223 (request->length % ep->desc->wMaxPacketSize == 0))
1224 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1226 spin_unlock_irqrestore(&dwc->lock, flags);
1231 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1232 struct usb_request *request)
1234 struct dwc3_request *req = to_dwc3_request(request);
1235 struct dwc3_request *r = NULL;
1237 struct dwc3_ep *dep = to_dwc3_ep(ep);
1238 struct dwc3 *dwc = dep->dwc;
1240 unsigned long flags;
1243 trace_dwc3_ep_dequeue(req);
1245 spin_lock_irqsave(&dwc->lock, flags);
1247 list_for_each_entry(r, &dep->pending_list, list) {
1253 list_for_each_entry(r, &dep->started_list, list) {
1258 /* wait until it is processed */
1259 dwc3_stop_active_transfer(dwc, dep->number, true);
1262 dev_err(dwc->dev, "request %p was not queued to %s\n",
1269 /* giveback the request */
1270 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1273 spin_unlock_irqrestore(&dwc->lock, flags);
1278 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1280 struct dwc3_gadget_ep_cmd_params params;
1281 struct dwc3 *dwc = dep->dwc;
1284 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1285 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1289 memset(¶ms, 0x00, sizeof(params));
1292 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1293 (!list_empty(&dep->started_list) ||
1294 !list_empty(&dep->pending_list)))) {
1295 dwc3_trace(trace_dwc3_gadget,
1296 "%s: pending request, cannot halt",
1301 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1304 dev_err(dwc->dev, "failed to set STALL on %s\n",
1307 dep->flags |= DWC3_EP_STALL;
1310 ret = dwc3_send_clear_stall_ep_cmd(dep);
1312 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1315 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1321 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1323 struct dwc3_ep *dep = to_dwc3_ep(ep);
1324 struct dwc3 *dwc = dep->dwc;
1326 unsigned long flags;
1330 spin_lock_irqsave(&dwc->lock, flags);
1331 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1332 spin_unlock_irqrestore(&dwc->lock, flags);
1337 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1339 struct dwc3_ep *dep = to_dwc3_ep(ep);
1340 struct dwc3 *dwc = dep->dwc;
1341 unsigned long flags;
1344 spin_lock_irqsave(&dwc->lock, flags);
1345 dep->flags |= DWC3_EP_WEDGE;
1347 if (dep->number == 0 || dep->number == 1)
1348 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1350 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1351 spin_unlock_irqrestore(&dwc->lock, flags);
1356 /* -------------------------------------------------------------------------- */
1358 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1359 .bLength = USB_DT_ENDPOINT_SIZE,
1360 .bDescriptorType = USB_DT_ENDPOINT,
1361 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1364 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1365 .enable = dwc3_gadget_ep0_enable,
1366 .disable = dwc3_gadget_ep0_disable,
1367 .alloc_request = dwc3_gadget_ep_alloc_request,
1368 .free_request = dwc3_gadget_ep_free_request,
1369 .queue = dwc3_gadget_ep0_queue,
1370 .dequeue = dwc3_gadget_ep_dequeue,
1371 .set_halt = dwc3_gadget_ep0_set_halt,
1372 .set_wedge = dwc3_gadget_ep_set_wedge,
1375 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1376 .enable = dwc3_gadget_ep_enable,
1377 .disable = dwc3_gadget_ep_disable,
1378 .alloc_request = dwc3_gadget_ep_alloc_request,
1379 .free_request = dwc3_gadget_ep_free_request,
1380 .queue = dwc3_gadget_ep_queue,
1381 .dequeue = dwc3_gadget_ep_dequeue,
1382 .set_halt = dwc3_gadget_ep_set_halt,
1383 .set_wedge = dwc3_gadget_ep_set_wedge,
1386 /* -------------------------------------------------------------------------- */
1388 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1390 struct dwc3 *dwc = gadget_to_dwc(g);
1393 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1394 return DWC3_DSTS_SOFFN(reg);
1397 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1399 unsigned long timeout;
1408 * According to the Databook Remote wakeup request should
1409 * be issued only when the device is in early suspend state.
1411 * We can check that via USB Link State bits in DSTS register.
1413 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1415 speed = reg & DWC3_DSTS_CONNECTSPD;
1416 if (speed == DWC3_DSTS_SUPERSPEED) {
1417 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1421 link_state = DWC3_DSTS_USBLNKST(reg);
1423 switch (link_state) {
1424 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1425 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1428 dwc3_trace(trace_dwc3_gadget,
1429 "can't wakeup from '%s'\n",
1430 dwc3_gadget_link_string(link_state));
1434 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1436 dev_err(dwc->dev, "failed to put link in Recovery\n");
1440 /* Recent versions do this automatically */
1441 if (dwc->revision < DWC3_REVISION_194A) {
1442 /* write zeroes to Link Change Request */
1443 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1444 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1445 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1448 /* poll until Link State changes to ON */
1449 timeout = jiffies + msecs_to_jiffies(100);
1451 while (!time_after(jiffies, timeout)) {
1452 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1454 /* in HS, means ON */
1455 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1459 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1460 dev_err(dwc->dev, "failed to send remote wakeup\n");
1467 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1469 struct dwc3 *dwc = gadget_to_dwc(g);
1470 unsigned long flags;
1473 spin_lock_irqsave(&dwc->lock, flags);
1474 ret = __dwc3_gadget_wakeup(dwc);
1475 spin_unlock_irqrestore(&dwc->lock, flags);
1480 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1483 struct dwc3 *dwc = gadget_to_dwc(g);
1484 unsigned long flags;
1486 spin_lock_irqsave(&dwc->lock, flags);
1487 g->is_selfpowered = !!is_selfpowered;
1488 spin_unlock_irqrestore(&dwc->lock, flags);
1493 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1498 if (pm_runtime_suspended(dwc->dev))
1501 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1503 if (dwc->revision <= DWC3_REVISION_187A) {
1504 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1505 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1508 if (dwc->revision >= DWC3_REVISION_194A)
1509 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1510 reg |= DWC3_DCTL_RUN_STOP;
1512 if (dwc->has_hibernation)
1513 reg |= DWC3_DCTL_KEEP_CONNECT;
1515 dwc->pullups_connected = true;
1517 reg &= ~DWC3_DCTL_RUN_STOP;
1519 if (dwc->has_hibernation && !suspend)
1520 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1522 dwc->pullups_connected = false;
1525 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1528 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1530 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1533 if (reg & DWC3_DSTS_DEVCTRLHLT)
1542 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1544 ? dwc->gadget_driver->function : "no-function",
1545 is_on ? "connect" : "disconnect");
1550 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1552 struct dwc3 *dwc = gadget_to_dwc(g);
1553 unsigned long flags;
1558 spin_lock_irqsave(&dwc->lock, flags);
1559 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1560 spin_unlock_irqrestore(&dwc->lock, flags);
1565 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1569 /* Enable all but Start and End of Frame IRQs */
1570 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1571 DWC3_DEVTEN_EVNTOVERFLOWEN |
1572 DWC3_DEVTEN_CMDCMPLTEN |
1573 DWC3_DEVTEN_ERRTICERREN |
1574 DWC3_DEVTEN_WKUPEVTEN |
1575 DWC3_DEVTEN_ULSTCNGEN |
1576 DWC3_DEVTEN_CONNECTDONEEN |
1577 DWC3_DEVTEN_USBRSTEN |
1578 DWC3_DEVTEN_DISCONNEVTEN);
1580 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1583 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1585 /* mask all interrupts */
1586 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1589 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1590 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1593 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1594 * dwc: pointer to our context structure
1596 * The following looks like complex but it's actually very simple. In order to
1597 * calculate the number of packets we can burst at once on OUT transfers, we're
1598 * gonna use RxFIFO size.
1600 * To calculate RxFIFO size we need two numbers:
1601 * MDWIDTH = size, in bits, of the internal memory bus
1602 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1604 * Given these two numbers, the formula is simple:
1606 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1608 * 24 bytes is for 3x SETUP packets
1609 * 16 bytes is a clock domain crossing tolerance
1611 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1613 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1620 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1621 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1623 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1624 nump = min_t(u32, nump, 16);
1627 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1628 reg &= ~DWC3_DCFG_NUMP_MASK;
1629 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1630 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1633 static int __dwc3_gadget_start(struct dwc3 *dwc)
1635 struct dwc3_ep *dep;
1639 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1640 reg &= ~(DWC3_DCFG_SPEED_MASK);
1643 * WORKAROUND: DWC3 revision < 2.20a have an issue
1644 * which would cause metastability state on Run/Stop
1645 * bit if we try to force the IP to USB2-only mode.
1647 * Because of that, we cannot configure the IP to any
1648 * speed other than the SuperSpeed
1652 * STAR#9000525659: Clock Domain Crossing on DCTL in
1655 if (dwc->revision < DWC3_REVISION_220A) {
1656 reg |= DWC3_DCFG_SUPERSPEED;
1658 switch (dwc->maximum_speed) {
1660 reg |= DWC3_DSTS_LOWSPEED;
1662 case USB_SPEED_FULL:
1663 reg |= DWC3_DSTS_FULLSPEED1;
1665 case USB_SPEED_HIGH:
1666 reg |= DWC3_DSTS_HIGHSPEED;
1668 case USB_SPEED_SUPER: /* FALLTHROUGH */
1669 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1671 reg |= DWC3_DSTS_SUPERSPEED;
1674 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1677 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1678 * field instead of letting dwc3 itself calculate that automatically.
1680 * This way, we maximize the chances that we'll be able to get several
1681 * bursts of data without going through any sort of endpoint throttling.
1683 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1684 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1685 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1687 dwc3_gadget_setup_nump(dwc);
1689 /* Start with SuperSpeed Default */
1690 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1693 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1696 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1701 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1704 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1708 /* begin to receive SETUP packets */
1709 dwc->ep0state = EP0_SETUP_PHASE;
1710 dwc3_ep0_out_start(dwc);
1712 dwc3_gadget_enable_irq(dwc);
1717 __dwc3_gadget_ep_disable(dwc->eps[0]);
1723 static int dwc3_gadget_start(struct usb_gadget *g,
1724 struct usb_gadget_driver *driver)
1726 struct dwc3 *dwc = gadget_to_dwc(g);
1727 unsigned long flags;
1731 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1732 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1733 IRQF_SHARED, "dwc3", dwc->ev_buf);
1735 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1739 dwc->irq_gadget = irq;
1741 spin_lock_irqsave(&dwc->lock, flags);
1742 if (dwc->gadget_driver) {
1743 dev_err(dwc->dev, "%s is already bound to %s\n",
1745 dwc->gadget_driver->driver.name);
1750 dwc->gadget_driver = driver;
1752 if (pm_runtime_active(dwc->dev))
1753 __dwc3_gadget_start(dwc);
1755 spin_unlock_irqrestore(&dwc->lock, flags);
1760 spin_unlock_irqrestore(&dwc->lock, flags);
1767 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1769 dwc3_gadget_disable_irq(dwc);
1770 __dwc3_gadget_ep_disable(dwc->eps[0]);
1771 __dwc3_gadget_ep_disable(dwc->eps[1]);
1774 static int dwc3_gadget_stop(struct usb_gadget *g)
1776 struct dwc3 *dwc = gadget_to_dwc(g);
1777 unsigned long flags;
1779 spin_lock_irqsave(&dwc->lock, flags);
1780 __dwc3_gadget_stop(dwc);
1781 dwc->gadget_driver = NULL;
1782 spin_unlock_irqrestore(&dwc->lock, flags);
1784 free_irq(dwc->irq_gadget, dwc->ev_buf);
1789 static const struct usb_gadget_ops dwc3_gadget_ops = {
1790 .get_frame = dwc3_gadget_get_frame,
1791 .wakeup = dwc3_gadget_wakeup,
1792 .set_selfpowered = dwc3_gadget_set_selfpowered,
1793 .pullup = dwc3_gadget_pullup,
1794 .udc_start = dwc3_gadget_start,
1795 .udc_stop = dwc3_gadget_stop,
1798 /* -------------------------------------------------------------------------- */
1800 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1801 u8 num, u32 direction)
1803 struct dwc3_ep *dep;
1806 for (i = 0; i < num; i++) {
1807 u8 epnum = (i << 1) | (!!direction);
1809 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1814 dep->number = epnum;
1815 dep->direction = !!direction;
1816 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1817 dwc->eps[epnum] = dep;
1819 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1820 (epnum & 1) ? "in" : "out");
1822 dep->endpoint.name = dep->name;
1823 spin_lock_init(&dep->lock);
1825 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1827 if (epnum == 0 || epnum == 1) {
1828 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1829 dep->endpoint.maxburst = 1;
1830 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1832 dwc->gadget.ep0 = &dep->endpoint;
1836 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1837 dep->endpoint.max_streams = 15;
1838 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1839 list_add_tail(&dep->endpoint.ep_list,
1840 &dwc->gadget.ep_list);
1842 ret = dwc3_alloc_trb_pool(dep);
1847 if (epnum == 0 || epnum == 1) {
1848 dep->endpoint.caps.type_control = true;
1850 dep->endpoint.caps.type_iso = true;
1851 dep->endpoint.caps.type_bulk = true;
1852 dep->endpoint.caps.type_int = true;
1855 dep->endpoint.caps.dir_in = !!direction;
1856 dep->endpoint.caps.dir_out = !direction;
1858 INIT_LIST_HEAD(&dep->pending_list);
1859 INIT_LIST_HEAD(&dep->started_list);
1865 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1869 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1871 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1873 dwc3_trace(trace_dwc3_gadget,
1874 "failed to allocate OUT endpoints");
1878 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1880 dwc3_trace(trace_dwc3_gadget,
1881 "failed to allocate IN endpoints");
1888 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1890 struct dwc3_ep *dep;
1893 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1894 dep = dwc->eps[epnum];
1898 * Physical endpoints 0 and 1 are special; they form the
1899 * bi-directional USB endpoint 0.
1901 * For those two physical endpoints, we don't allocate a TRB
1902 * pool nor do we add them the endpoints list. Due to that, we
1903 * shouldn't do these two operations otherwise we would end up
1904 * with all sorts of bugs when removing dwc3.ko.
1906 if (epnum != 0 && epnum != 1) {
1907 dwc3_free_trb_pool(dep);
1908 list_del(&dep->endpoint.ep_list);
1915 /* -------------------------------------------------------------------------- */
1917 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1918 struct dwc3_request *req, struct dwc3_trb *trb,
1919 const struct dwc3_event_depevt *event, int status)
1922 unsigned int s_pkt = 0;
1923 unsigned int trb_status;
1925 trace_dwc3_complete_trb(dep, trb);
1927 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1929 * We continue despite the error. There is not much we
1930 * can do. If we don't clean it up we loop forever. If
1931 * we skip the TRB then it gets overwritten after a
1932 * while since we use them in a ring buffer. A BUG()
1933 * would help. Lets hope that if this occurs, someone
1934 * fixes the root cause instead of looking away :)
1936 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1938 count = trb->size & DWC3_TRB_SIZE_MASK;
1940 if (dep->direction) {
1942 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1943 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1944 dwc3_trace(trace_dwc3_gadget,
1945 "%s: incomplete IN transfer\n",
1948 * If missed isoc occurred and there is
1949 * no request queued then issue END
1950 * TRANSFER, so that core generates
1951 * next xfernotready and we will issue
1952 * a fresh START TRANSFER.
1953 * If there are still queued request
1954 * then wait, do not issue either END
1955 * or UPDATE TRANSFER, just attach next
1956 * request in pending_list during
1957 * giveback.If any future queued request
1958 * is successfully transferred then we
1959 * will issue UPDATE TRANSFER for all
1960 * request in the pending_list.
1962 dep->flags |= DWC3_EP_MISSED_ISOC;
1964 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1966 status = -ECONNRESET;
1969 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1972 if (count && (event->status & DEPEVT_STATUS_SHORT))
1977 * We assume here we will always receive the entire data block
1978 * which we should receive. Meaning, if we program RX to
1979 * receive 4K but we receive only 2K, we assume that's all we
1980 * should receive and we simply bounce the request back to the
1981 * gadget driver for further processing.
1983 req->request.actual += req->request.length - count;
1986 if ((event->status & DEPEVT_STATUS_LST) &&
1987 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1988 DWC3_TRB_CTRL_HWO)))
1990 if ((event->status & DEPEVT_STATUS_IOC) &&
1991 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1996 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1997 const struct dwc3_event_depevt *event, int status)
1999 struct dwc3_request *req;
2000 struct dwc3_trb *trb;
2006 req = next_request(&dep->started_list);
2007 if (WARN_ON_ONCE(!req))
2012 slot = req->first_trb_index + i;
2013 if (slot == DWC3_TRB_NUM - 1)
2015 slot %= DWC3_TRB_NUM;
2016 trb = &dep->trb_pool[slot];
2018 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2022 } while (++i < req->request.num_mapped_sgs);
2024 dwc3_gadget_giveback(dep, req, status);
2031 * Our endpoint might get disabled by another thread during
2032 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2033 * early on so DWC3_EP_BUSY flag gets cleared
2035 if (!dep->endpoint.desc)
2038 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2039 list_empty(&dep->started_list)) {
2040 if (list_empty(&dep->pending_list)) {
2042 * If there is no entry in request list then do
2043 * not issue END TRANSFER now. Just set PENDING
2044 * flag, so that END TRANSFER is issued when an
2045 * entry is added into request list.
2047 dep->flags = DWC3_EP_PENDING_REQUEST;
2049 dwc3_stop_active_transfer(dwc, dep->number, true);
2050 dep->flags = DWC3_EP_ENABLED;
2055 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
2056 if ((event->status & DEPEVT_STATUS_IOC) &&
2057 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2062 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2063 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2065 unsigned status = 0;
2067 u32 is_xfer_complete;
2069 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2071 if (event->status & DEPEVT_STATUS_BUSERR)
2072 status = -ECONNRESET;
2074 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2075 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2076 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2077 dep->flags &= ~DWC3_EP_BUSY;
2080 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2081 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2083 if (dwc->revision < DWC3_REVISION_183A) {
2087 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2090 if (!(dep->flags & DWC3_EP_ENABLED))
2093 if (!list_empty(&dep->started_list))
2097 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2099 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2105 * Our endpoint might get disabled by another thread during
2106 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2107 * early on so DWC3_EP_BUSY flag gets cleared
2109 if (!dep->endpoint.desc)
2112 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2115 ret = __dwc3_gadget_kick_transfer(dep, 0);
2116 if (!ret || ret == -EBUSY)
2121 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2122 const struct dwc3_event_depevt *event)
2124 struct dwc3_ep *dep;
2125 u8 epnum = event->endpoint_number;
2127 dep = dwc->eps[epnum];
2129 if (!(dep->flags & DWC3_EP_ENABLED))
2132 if (epnum == 0 || epnum == 1) {
2133 dwc3_ep0_interrupt(dwc, event);
2137 switch (event->endpoint_event) {
2138 case DWC3_DEPEVT_XFERCOMPLETE:
2139 dep->resource_index = 0;
2141 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2142 dwc3_trace(trace_dwc3_gadget,
2143 "%s is an Isochronous endpoint\n",
2148 dwc3_endpoint_transfer_complete(dwc, dep, event);
2150 case DWC3_DEPEVT_XFERINPROGRESS:
2151 dwc3_endpoint_transfer_complete(dwc, dep, event);
2153 case DWC3_DEPEVT_XFERNOTREADY:
2154 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2155 dwc3_gadget_start_isoc(dwc, dep, event);
2160 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2162 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2163 dep->name, active ? "Transfer Active"
2164 : "Transfer Not Active");
2166 ret = __dwc3_gadget_kick_transfer(dep, 0);
2167 if (!ret || ret == -EBUSY)
2170 dwc3_trace(trace_dwc3_gadget,
2171 "%s: failed to kick transfers\n",
2176 case DWC3_DEPEVT_STREAMEVT:
2177 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2178 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2183 switch (event->status) {
2184 case DEPEVT_STREAMEVT_FOUND:
2185 dwc3_trace(trace_dwc3_gadget,
2186 "Stream %d found and started",
2190 case DEPEVT_STREAMEVT_NOTFOUND:
2193 dwc3_trace(trace_dwc3_gadget,
2194 "unable to find suitable stream\n");
2197 case DWC3_DEPEVT_RXTXFIFOEVT:
2198 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2200 case DWC3_DEPEVT_EPCMDCMPLT:
2201 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2206 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2208 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2209 spin_unlock(&dwc->lock);
2210 dwc->gadget_driver->disconnect(&dwc->gadget);
2211 spin_lock(&dwc->lock);
2215 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2217 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2218 spin_unlock(&dwc->lock);
2219 dwc->gadget_driver->suspend(&dwc->gadget);
2220 spin_lock(&dwc->lock);
2224 static void dwc3_resume_gadget(struct dwc3 *dwc)
2226 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2227 spin_unlock(&dwc->lock);
2228 dwc->gadget_driver->resume(&dwc->gadget);
2229 spin_lock(&dwc->lock);
2233 static void dwc3_reset_gadget(struct dwc3 *dwc)
2235 if (!dwc->gadget_driver)
2238 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2239 spin_unlock(&dwc->lock);
2240 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2241 spin_lock(&dwc->lock);
2245 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2247 struct dwc3_ep *dep;
2248 struct dwc3_gadget_ep_cmd_params params;
2252 dep = dwc->eps[epnum];
2254 if (!dep->resource_index)
2258 * NOTICE: We are violating what the Databook says about the
2259 * EndTransfer command. Ideally we would _always_ wait for the
2260 * EndTransfer Command Completion IRQ, but that's causing too
2261 * much trouble synchronizing between us and gadget driver.
2263 * We have discussed this with the IP Provider and it was
2264 * suggested to giveback all requests here, but give HW some
2265 * extra time to synchronize with the interconnect. We're using
2266 * an arbitrary 100us delay for that.
2268 * Note also that a similar handling was tested by Synopsys
2269 * (thanks a lot Paul) and nothing bad has come out of it.
2270 * In short, what we're doing is:
2272 * - Issue EndTransfer WITH CMDIOC bit set
2276 cmd = DWC3_DEPCMD_ENDTRANSFER;
2277 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2278 cmd |= DWC3_DEPCMD_CMDIOC;
2279 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2280 memset(¶ms, 0, sizeof(params));
2281 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2283 dep->resource_index = 0;
2284 dep->flags &= ~DWC3_EP_BUSY;
2288 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2292 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2293 struct dwc3_ep *dep;
2295 dep = dwc->eps[epnum];
2299 if (!(dep->flags & DWC3_EP_ENABLED))
2302 dwc3_remove_requests(dwc, dep);
2306 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2310 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2311 struct dwc3_ep *dep;
2314 dep = dwc->eps[epnum];
2318 if (!(dep->flags & DWC3_EP_STALL))
2321 dep->flags &= ~DWC3_EP_STALL;
2323 ret = dwc3_send_clear_stall_ep_cmd(dep);
2328 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2332 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2333 reg &= ~DWC3_DCTL_INITU1ENA;
2334 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2336 reg &= ~DWC3_DCTL_INITU2ENA;
2337 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2339 dwc3_disconnect_gadget(dwc);
2341 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2342 dwc->setup_packet_pending = false;
2343 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2345 dwc->connected = false;
2348 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2352 dwc->connected = true;
2355 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2356 * would cause a missing Disconnect Event if there's a
2357 * pending Setup Packet in the FIFO.
2359 * There's no suggested workaround on the official Bug
2360 * report, which states that "unless the driver/application
2361 * is doing any special handling of a disconnect event,
2362 * there is no functional issue".
2364 * Unfortunately, it turns out that we _do_ some special
2365 * handling of a disconnect event, namely complete all
2366 * pending transfers, notify gadget driver of the
2367 * disconnection, and so on.
2369 * Our suggested workaround is to follow the Disconnect
2370 * Event steps here, instead, based on a setup_packet_pending
2371 * flag. Such flag gets set whenever we have a SETUP_PENDING
2372 * status for EP0 TRBs and gets cleared on XferComplete for the
2377 * STAR#9000466709: RTL: Device : Disconnect event not
2378 * generated if setup packet pending in FIFO
2380 if (dwc->revision < DWC3_REVISION_188A) {
2381 if (dwc->setup_packet_pending)
2382 dwc3_gadget_disconnect_interrupt(dwc);
2385 dwc3_reset_gadget(dwc);
2387 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2388 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2389 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2390 dwc->test_mode = false;
2392 dwc3_stop_active_transfers(dwc);
2393 dwc3_clear_stall_all_ep(dwc);
2395 /* Reset device address to zero */
2396 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2397 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2398 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2401 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2404 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2407 * We change the clock only at SS but I dunno why I would want to do
2408 * this. Maybe it becomes part of the power saving plan.
2411 if (speed != DWC3_DSTS_SUPERSPEED)
2415 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2416 * each time on Connect Done.
2421 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2422 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2423 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2426 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2428 struct dwc3_ep *dep;
2433 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2434 speed = reg & DWC3_DSTS_CONNECTSPD;
2437 dwc3_update_ram_clk_sel(dwc, speed);
2440 case DWC3_DCFG_SUPERSPEED:
2442 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2443 * would cause a missing USB3 Reset event.
2445 * In such situations, we should force a USB3 Reset
2446 * event by calling our dwc3_gadget_reset_interrupt()
2451 * STAR#9000483510: RTL: SS : USB3 reset event may
2452 * not be generated always when the link enters poll
2454 if (dwc->revision < DWC3_REVISION_190A)
2455 dwc3_gadget_reset_interrupt(dwc);
2457 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2458 dwc->gadget.ep0->maxpacket = 512;
2459 dwc->gadget.speed = USB_SPEED_SUPER;
2461 case DWC3_DCFG_HIGHSPEED:
2462 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2463 dwc->gadget.ep0->maxpacket = 64;
2464 dwc->gadget.speed = USB_SPEED_HIGH;
2466 case DWC3_DCFG_FULLSPEED2:
2467 case DWC3_DCFG_FULLSPEED1:
2468 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2469 dwc->gadget.ep0->maxpacket = 64;
2470 dwc->gadget.speed = USB_SPEED_FULL;
2472 case DWC3_DCFG_LOWSPEED:
2473 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2474 dwc->gadget.ep0->maxpacket = 8;
2475 dwc->gadget.speed = USB_SPEED_LOW;
2479 /* Enable USB2 LPM Capability */
2481 if ((dwc->revision > DWC3_REVISION_194A)
2482 && (speed != DWC3_DCFG_SUPERSPEED)) {
2483 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2484 reg |= DWC3_DCFG_LPM_CAP;
2485 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2487 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2488 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2490 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2493 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2494 * DCFG.LPMCap is set, core responses with an ACK and the
2495 * BESL value in the LPM token is less than or equal to LPM
2498 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2499 && dwc->has_lpm_erratum,
2500 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2502 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2503 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2505 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2507 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2508 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2509 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2513 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2516 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2521 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2524 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2529 * Configure PHY via GUSB3PIPECTLn if required.
2531 * Update GTXFIFOSIZn
2533 * In both cases reset values should be sufficient.
2537 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2540 * TODO take core out of low power mode when that's
2544 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2545 spin_unlock(&dwc->lock);
2546 dwc->gadget_driver->resume(&dwc->gadget);
2547 spin_lock(&dwc->lock);
2551 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2552 unsigned int evtinfo)
2554 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2555 unsigned int pwropt;
2558 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2559 * Hibernation mode enabled which would show up when device detects
2560 * host-initiated U3 exit.
2562 * In that case, device will generate a Link State Change Interrupt
2563 * from U3 to RESUME which is only necessary if Hibernation is
2566 * There are no functional changes due to such spurious event and we
2567 * just need to ignore it.
2571 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2574 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2575 if ((dwc->revision < DWC3_REVISION_250A) &&
2576 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2577 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2578 (next == DWC3_LINK_STATE_RESUME)) {
2579 dwc3_trace(trace_dwc3_gadget,
2580 "ignoring transition U3 -> Resume");
2586 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2587 * on the link partner, the USB session might do multiple entry/exit
2588 * of low power states before a transfer takes place.
2590 * Due to this problem, we might experience lower throughput. The
2591 * suggested workaround is to disable DCTL[12:9] bits if we're
2592 * transitioning from U1/U2 to U0 and enable those bits again
2593 * after a transfer completes and there are no pending transfers
2594 * on any of the enabled endpoints.
2596 * This is the first half of that workaround.
2600 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2601 * core send LGO_Ux entering U0
2603 if (dwc->revision < DWC3_REVISION_183A) {
2604 if (next == DWC3_LINK_STATE_U0) {
2608 switch (dwc->link_state) {
2609 case DWC3_LINK_STATE_U1:
2610 case DWC3_LINK_STATE_U2:
2611 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2612 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2613 | DWC3_DCTL_ACCEPTU2ENA
2614 | DWC3_DCTL_INITU1ENA
2615 | DWC3_DCTL_ACCEPTU1ENA);
2618 dwc->u1u2 = reg & u1u2;
2622 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2632 case DWC3_LINK_STATE_U1:
2633 if (dwc->speed == USB_SPEED_SUPER)
2634 dwc3_suspend_gadget(dwc);
2636 case DWC3_LINK_STATE_U2:
2637 case DWC3_LINK_STATE_U3:
2638 dwc3_suspend_gadget(dwc);
2640 case DWC3_LINK_STATE_RESUME:
2641 dwc3_resume_gadget(dwc);
2648 dwc->link_state = next;
2651 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2652 unsigned int evtinfo)
2654 unsigned int is_ss = evtinfo & BIT(4);
2657 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2658 * have a known issue which can cause USB CV TD.9.23 to fail
2661 * Because of this issue, core could generate bogus hibernation
2662 * events which SW needs to ignore.
2666 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2667 * Device Fallback from SuperSpeed
2669 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2672 /* enter hibernation here */
2675 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2676 const struct dwc3_event_devt *event)
2678 switch (event->type) {
2679 case DWC3_DEVICE_EVENT_DISCONNECT:
2680 dwc3_gadget_disconnect_interrupt(dwc);
2682 case DWC3_DEVICE_EVENT_RESET:
2683 dwc3_gadget_reset_interrupt(dwc);
2685 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2686 dwc3_gadget_conndone_interrupt(dwc);
2688 case DWC3_DEVICE_EVENT_WAKEUP:
2689 dwc3_gadget_wakeup_interrupt(dwc);
2691 case DWC3_DEVICE_EVENT_HIBER_REQ:
2692 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2693 "unexpected hibernation event\n"))
2696 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2698 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2699 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2701 case DWC3_DEVICE_EVENT_EOPF:
2702 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2704 case DWC3_DEVICE_EVENT_SOF:
2705 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2707 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2708 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2710 case DWC3_DEVICE_EVENT_CMD_CMPL:
2711 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2713 case DWC3_DEVICE_EVENT_OVERFLOW:
2714 dwc3_trace(trace_dwc3_gadget, "Overflow");
2717 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2721 static void dwc3_process_event_entry(struct dwc3 *dwc,
2722 const union dwc3_event *event)
2724 trace_dwc3_event(event->raw);
2726 /* Endpoint IRQ, handle it and return early */
2727 if (event->type.is_devspec == 0) {
2729 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2732 switch (event->type.type) {
2733 case DWC3_EVENT_TYPE_DEV:
2734 dwc3_gadget_interrupt(dwc, &event->devt);
2736 /* REVISIT what to do with Carkit and I2C events ? */
2738 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2742 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2744 struct dwc3 *dwc = evt->dwc;
2745 irqreturn_t ret = IRQ_NONE;
2751 if (!(evt->flags & DWC3_EVENT_PENDING))
2755 union dwc3_event event;
2757 event.raw = *(u32 *) (evt->buf + evt->lpos);
2759 dwc3_process_event_entry(dwc, &event);
2762 * FIXME we wrap around correctly to the next entry as
2763 * almost all entries are 4 bytes in size. There is one
2764 * entry which has 12 bytes which is a regular entry
2765 * followed by 8 bytes data. ATM I don't know how
2766 * things are organized if we get next to the a
2767 * boundary so I worry about that once we try to handle
2770 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2773 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2777 evt->flags &= ~DWC3_EVENT_PENDING;
2780 /* Unmask interrupt */
2781 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2782 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2783 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2788 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2790 struct dwc3_event_buffer *evt = _evt;
2791 struct dwc3 *dwc = evt->dwc;
2792 unsigned long flags;
2793 irqreturn_t ret = IRQ_NONE;
2795 spin_lock_irqsave(&dwc->lock, flags);
2796 ret = dwc3_process_event_buf(evt);
2797 spin_unlock_irqrestore(&dwc->lock, flags);
2802 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2804 struct dwc3 *dwc = evt->dwc;
2808 if (pm_runtime_suspended(dwc->dev)) {
2809 pm_runtime_get(dwc->dev);
2810 disable_irq_nosync(dwc->irq_gadget);
2811 dwc->pending_events = true;
2815 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2816 count &= DWC3_GEVNTCOUNT_MASK;
2821 evt->flags |= DWC3_EVENT_PENDING;
2823 /* Mask interrupt */
2824 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2825 reg |= DWC3_GEVNTSIZ_INTMASK;
2826 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2828 return IRQ_WAKE_THREAD;
2831 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2833 struct dwc3_event_buffer *evt = _evt;
2835 return dwc3_check_event_buf(evt);
2839 * dwc3_gadget_init - Initializes gadget related registers
2840 * @dwc: pointer to our controller context structure
2842 * Returns 0 on success otherwise negative errno.
2844 int dwc3_gadget_init(struct dwc3 *dwc)
2848 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2849 &dwc->ctrl_req_addr, GFP_KERNEL);
2850 if (!dwc->ctrl_req) {
2851 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2856 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2857 &dwc->ep0_trb_addr, GFP_KERNEL);
2858 if (!dwc->ep0_trb) {
2859 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2864 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2865 if (!dwc->setup_buf) {
2870 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2871 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2873 if (!dwc->ep0_bounce) {
2874 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2879 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2880 if (!dwc->zlp_buf) {
2885 dwc->gadget.ops = &dwc3_gadget_ops;
2886 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2887 dwc->gadget.sg_supported = true;
2888 dwc->gadget.name = "dwc3-gadget";
2889 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2892 * FIXME We might be setting max_speed to <SUPER, however versions
2893 * <2.20a of dwc3 have an issue with metastability (documented
2894 * elsewhere in this driver) which tells us we can't set max speed to
2895 * anything lower than SUPER.
2897 * Because gadget.max_speed is only used by composite.c and function
2898 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2899 * to happen so we avoid sending SuperSpeed Capability descriptor
2900 * together with our BOS descriptor as that could confuse host into
2901 * thinking we can handle super speed.
2903 * Note that, in fact, we won't even support GetBOS requests when speed
2904 * is less than super speed because we don't have means, yet, to tell
2905 * composite.c that we are USB 2.0 + LPM ECN.
2907 if (dwc->revision < DWC3_REVISION_220A)
2908 dwc3_trace(trace_dwc3_gadget,
2909 "Changing max_speed on rev %08x\n",
2912 dwc->gadget.max_speed = dwc->maximum_speed;
2915 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2918 dwc->gadget.quirk_ep_out_aligned_size = true;
2921 * REVISIT: Here we should clear all pending IRQs to be
2922 * sure we're starting from a well known location.
2925 ret = dwc3_gadget_init_endpoints(dwc);
2929 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2931 dev_err(dwc->dev, "failed to register udc\n");
2938 kfree(dwc->zlp_buf);
2941 dwc3_gadget_free_endpoints(dwc);
2942 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2943 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2946 kfree(dwc->setup_buf);
2949 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2950 dwc->ep0_trb, dwc->ep0_trb_addr);
2953 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2954 dwc->ctrl_req, dwc->ctrl_req_addr);
2960 /* -------------------------------------------------------------------------- */
2962 void dwc3_gadget_exit(struct dwc3 *dwc)
2964 usb_del_gadget_udc(&dwc->gadget);
2966 dwc3_gadget_free_endpoints(dwc);
2968 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2969 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2971 kfree(dwc->setup_buf);
2972 kfree(dwc->zlp_buf);
2974 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2975 dwc->ep0_trb, dwc->ep0_trb_addr);
2977 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2978 dwc->ctrl_req, dwc->ctrl_req_addr);
2981 int dwc3_gadget_suspend(struct dwc3 *dwc)
2985 if (!dwc->gadget_driver)
2988 ret = dwc3_gadget_run_stop(dwc, false, false);
2992 dwc3_disconnect_gadget(dwc);
2993 __dwc3_gadget_stop(dwc);
2998 int dwc3_gadget_resume(struct dwc3 *dwc)
3002 if (!dwc->gadget_driver)
3005 ret = __dwc3_gadget_start(dwc);
3009 ret = dwc3_gadget_run_stop(dwc, true, false);
3016 __dwc3_gadget_stop(dwc);
3022 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3024 if (dwc->pending_events) {
3025 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3026 dwc->pending_events = false;
3027 enable_irq(dwc->irq_gadget);