1 // SPDX-License-Identifier: GPL-2.0
3 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
11 #include <linux/kernel.h>
12 #include <linux/delay.h>
13 #include <linux/slab.h>
14 #include <linux/spinlock.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/interrupt.h>
19 #include <linux/list.h>
20 #include <linux/dma-mapping.h>
22 #include <linux/usb/ch9.h>
23 #include <linux/usb/gadget.h>
31 * dwc3_gadget_set_test_mode - enables usb2 test modes
32 * @dwc: pointer to our context structure
33 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
35 * Caller should take care of locking. This function will return 0 on
36 * success or -EINVAL if wrong Test Selector is passed.
38 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
42 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
43 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
57 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
63 * dwc3_gadget_get_link_state - gets current state of usb link
64 * @dwc: pointer to our context structure
66 * Caller should take care of locking. This function will
67 * return the link state on success (>= 0) or -ETIMEDOUT.
69 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
73 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
75 return DWC3_DSTS_USBLNKST(reg);
79 * dwc3_gadget_set_link_state - sets usb link to a particular state
80 * @dwc: pointer to our context structure
81 * @state: the state to put link into
83 * Caller should take care of locking. This function will
84 * return 0 on success or -ETIMEDOUT.
86 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
92 * Wait until device controller is ready. Only applies to 1.94a and
95 if (dwc->revision >= DWC3_REVISION_194A) {
97 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
98 if (reg & DWC3_DSTS_DCNRD)
108 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
109 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
111 /* set requested state */
112 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
113 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
116 * The following code is racy when called from dwc3_gadget_wakeup,
117 * and is not needed, at least on newer versions
119 if (dwc->revision >= DWC3_REVISION_194A)
122 /* wait for a change in DSTS */
125 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
127 if (DWC3_DSTS_USBLNKST(reg) == state)
137 * dwc3_ep_inc_trb - increment a trb index.
138 * @index: Pointer to the TRB index to increment.
140 * The index should never point to the link TRB. After incrementing,
141 * if it is point to the link TRB, wrap around to the beginning. The
142 * link TRB is always at the last TRB entry.
144 static void dwc3_ep_inc_trb(u8 *index)
147 if (*index == (DWC3_TRB_NUM - 1))
152 * dwc3_ep_inc_enq - increment endpoint's enqueue pointer
153 * @dep: The endpoint whose enqueue pointer we're incrementing
155 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
157 dwc3_ep_inc_trb(&dep->trb_enqueue);
161 * dwc3_ep_inc_deq - increment endpoint's dequeue pointer
162 * @dep: The endpoint whose enqueue pointer we're incrementing
164 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
166 dwc3_ep_inc_trb(&dep->trb_dequeue);
169 void dwc3_gadget_del_and_unmap_request(struct dwc3_ep *dep,
170 struct dwc3_request *req, int status)
172 struct dwc3 *dwc = dep->dwc;
174 req->started = false;
175 list_del(&req->list);
178 if (req->request.status == -EINPROGRESS)
179 req->request.status = status;
182 usb_gadget_unmap_request_by_dev(dwc->sysdev,
183 &req->request, req->direction);
186 trace_dwc3_gadget_giveback(req);
189 pm_runtime_put(dwc->dev);
193 * dwc3_gadget_giveback - call struct usb_request's ->complete callback
194 * @dep: The endpoint to whom the request belongs to
195 * @req: The request we're giving back
196 * @status: completion code for the request
198 * Must be called with controller's lock held and interrupts disabled. This
199 * function will unmap @req and call its ->complete() callback to notify upper
200 * layers that it has completed.
202 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
205 struct dwc3 *dwc = dep->dwc;
207 dwc3_gadget_del_and_unmap_request(dep, req, status);
209 spin_unlock(&dwc->lock);
210 usb_gadget_giveback_request(&dep->endpoint, &req->request);
211 spin_lock(&dwc->lock);
215 * dwc3_send_gadget_generic_command - issue a generic command for the controller
216 * @dwc: pointer to the controller context
217 * @cmd: the command to be issued
218 * @param: command parameter
220 * Caller should take care of locking. Issue @cmd with a given @param to @dwc
221 * and wait for its completion.
223 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
230 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
231 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
234 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
235 if (!(reg & DWC3_DGCMD_CMDACT)) {
236 status = DWC3_DGCMD_STATUS(reg);
248 trace_dwc3_gadget_generic_cmd(cmd, param, status);
253 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
256 * dwc3_send_gadget_ep_cmd - issue an endpoint command
257 * @dep: the endpoint to which the command is going to be issued
258 * @cmd: the command to be issued
259 * @params: parameters to the command
261 * Caller should handle locking. This function will issue @cmd with given
262 * @params to @dep and wait for its completion.
264 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
265 struct dwc3_gadget_ep_cmd_params *params)
267 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
268 struct dwc3 *dwc = dep->dwc;
277 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
278 * we're issuing an endpoint command, we must check if
279 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
281 * We will also set SUSPHY bit to what it was before returning as stated
282 * by the same section on Synopsys databook.
284 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
285 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
286 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
288 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
289 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
293 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
296 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
297 dwc->link_state == DWC3_LINK_STATE_U2 ||
298 dwc->link_state == DWC3_LINK_STATE_U3);
300 if (unlikely(needs_wakeup)) {
301 ret = __dwc3_gadget_wakeup(dwc);
302 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
307 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
308 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
309 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
312 * Synopsys Databook 2.60a states in section 6.3.2.5.6 of that if we're
313 * not relying on XferNotReady, we can make use of a special "No
314 * Response Update Transfer" command where we should clear both CmdAct
317 * With this, we don't need to wait for command completion and can
318 * straight away issue further commands to the endpoint.
320 * NOTICE: We're making an assumption that control endpoints will never
321 * make use of Update Transfer command. This is a safe assumption
322 * because we can never have more than one request at a time with
323 * Control Endpoints. If anybody changes that assumption, this chunk
324 * needs to be updated accordingly.
326 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_UPDATETRANSFER &&
327 !usb_endpoint_xfer_isoc(desc))
328 cmd &= ~(DWC3_DEPCMD_CMDIOC | DWC3_DEPCMD_CMDACT);
330 cmd |= DWC3_DEPCMD_CMDACT;
332 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd);
334 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
335 if (!(reg & DWC3_DEPCMD_CMDACT)) {
336 cmd_status = DWC3_DEPCMD_STATUS(reg);
338 switch (cmd_status) {
342 case DEPEVT_TRANSFER_NO_RESOURCE:
345 case DEPEVT_TRANSFER_BUS_EXPIRY:
347 * SW issues START TRANSFER command to
348 * isochronous ep with future frame interval. If
349 * future interval time has already passed when
350 * core receives the command, it will respond
351 * with an error status of 'Bus Expiry'.
353 * Instead of always returning -EINVAL, let's
354 * give a hint to the gadget driver that this is
355 * the case by returning -EAGAIN.
360 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
369 cmd_status = -ETIMEDOUT;
372 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
375 switch (DWC3_DEPCMD_CMD(cmd)) {
376 case DWC3_DEPCMD_STARTTRANSFER:
377 dep->flags |= DWC3_EP_TRANSFER_STARTED;
379 case DWC3_DEPCMD_ENDTRANSFER:
380 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
388 if (unlikely(susphy)) {
389 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
390 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
391 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
397 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
399 struct dwc3 *dwc = dep->dwc;
400 struct dwc3_gadget_ep_cmd_params params;
401 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
404 * As of core revision 2.60a the recommended programming model
405 * is to set the ClearPendIN bit when issuing a Clear Stall EP
406 * command for IN endpoints. This is to prevent an issue where
407 * some (non-compliant) hosts may not send ACK TPs for pending
408 * IN transfers due to a mishandled error condition. Synopsys
411 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A) &&
412 (dwc->gadget.speed >= USB_SPEED_SUPER))
413 cmd |= DWC3_DEPCMD_CLEARPENDIN;
415 memset(¶ms, 0, sizeof(params));
417 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
420 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
421 struct dwc3_trb *trb)
423 u32 offset = (char *) trb - (char *) dep->trb_pool;
425 return dep->trb_pool_dma + offset;
428 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
430 struct dwc3 *dwc = dep->dwc;
435 dep->trb_pool = dma_alloc_coherent(dwc->sysdev,
436 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
437 &dep->trb_pool_dma, GFP_KERNEL);
438 if (!dep->trb_pool) {
439 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
447 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
449 struct dwc3 *dwc = dep->dwc;
451 dma_free_coherent(dwc->sysdev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
452 dep->trb_pool, dep->trb_pool_dma);
454 dep->trb_pool = NULL;
455 dep->trb_pool_dma = 0;
458 static int dwc3_gadget_set_xfer_resource(struct dwc3_ep *dep);
461 * dwc3_gadget_start_config - configure ep resources
462 * @dwc: pointer to our controller context structure
463 * @dep: endpoint that is being enabled
465 * Issue a %DWC3_DEPCMD_DEPSTARTCFG command to @dep. After the command's
466 * completion, it will set Transfer Resource for all available endpoints.
468 * The assignment of transfer resources cannot perfectly follow the data book
469 * due to the fact that the controller driver does not have all knowledge of the
470 * configuration in advance. It is given this information piecemeal by the
471 * composite gadget framework after every SET_CONFIGURATION and
472 * SET_INTERFACE. Trying to follow the databook programming model in this
473 * scenario can cause errors. For two reasons:
475 * 1) The databook says to do %DWC3_DEPCMD_DEPSTARTCFG for every
476 * %USB_REQ_SET_CONFIGURATION and %USB_REQ_SET_INTERFACE (8.1.5). This is
477 * incorrect in the scenario of multiple interfaces.
479 * 2) The databook does not mention doing more %DWC3_DEPCMD_DEPXFERCFG for new
480 * endpoint on alt setting (8.1.6).
482 * The following simplified method is used instead:
484 * All hardware endpoints can be assigned a transfer resource and this setting
485 * will stay persistent until either a core reset or hibernation. So whenever we
486 * do a %DWC3_DEPCMD_DEPSTARTCFG(0) we can go ahead and do
487 * %DWC3_DEPCMD_DEPXFERCFG for every hardware endpoint as well. We are
488 * guaranteed that there are as many transfer resources as endpoints.
490 * This function is called for each endpoint when it is being enabled but is
491 * triggered only when called for EP0-out, which always happens first, and which
492 * should only happen in one of the above conditions.
494 static int dwc3_gadget_start_config(struct dwc3_ep *dep)
496 struct dwc3_gadget_ep_cmd_params params;
505 memset(¶ms, 0x00, sizeof(params));
506 cmd = DWC3_DEPCMD_DEPSTARTCFG;
509 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
513 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
514 struct dwc3_ep *dep = dwc->eps[i];
519 ret = dwc3_gadget_set_xfer_resource(dep);
527 static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
529 const struct usb_ss_ep_comp_descriptor *comp_desc;
530 const struct usb_endpoint_descriptor *desc;
531 struct dwc3_gadget_ep_cmd_params params;
532 struct dwc3 *dwc = dep->dwc;
534 comp_desc = dep->endpoint.comp_desc;
535 desc = dep->endpoint.desc;
537 memset(¶ms, 0x00, sizeof(params));
539 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
540 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
542 /* Burst size is only needed in SuperSpeed mode */
543 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
544 u32 burst = dep->endpoint.maxburst;
545 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
548 params.param0 |= action;
549 if (action == DWC3_DEPCFG_ACTION_RESTORE)
550 params.param2 |= dep->saved_state;
552 if (usb_endpoint_xfer_control(desc))
553 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
555 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
556 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
558 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
559 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
560 | DWC3_DEPCFG_STREAM_EVENT_EN;
561 dep->stream_capable = true;
564 if (!usb_endpoint_xfer_control(desc))
565 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
568 * We are doing 1:1 mapping for endpoints, meaning
569 * Physical Endpoints 2 maps to Logical Endpoint 2 and
570 * so on. We consider the direction bit as part of the physical
571 * endpoint number. So USB endpoint 0x81 is 0x03.
573 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
576 * We must use the lower 16 TX FIFOs even though
580 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
582 if (desc->bInterval) {
583 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
584 dep->interval = 1 << (desc->bInterval - 1);
587 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
590 static int dwc3_gadget_set_xfer_resource(struct dwc3_ep *dep)
592 struct dwc3_gadget_ep_cmd_params params;
594 memset(¶ms, 0x00, sizeof(params));
596 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
598 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
603 * __dwc3_gadget_ep_enable - initializes a hw endpoint
604 * @dep: endpoint to be initialized
605 * @action: one of INIT, MODIFY or RESTORE
607 * Caller should take care of locking. Execute all necessary commands to
608 * initialize a HW endpoint so it can be used by a gadget driver.
610 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep, unsigned int action)
612 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
613 struct dwc3 *dwc = dep->dwc;
618 if (!(dep->flags & DWC3_EP_ENABLED)) {
619 ret = dwc3_gadget_start_config(dep);
624 ret = dwc3_gadget_set_ep_config(dep, action);
628 if (!(dep->flags & DWC3_EP_ENABLED)) {
629 struct dwc3_trb *trb_st_hw;
630 struct dwc3_trb *trb_link;
632 dep->type = usb_endpoint_type(desc);
633 dep->flags |= DWC3_EP_ENABLED;
634 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
636 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
637 reg |= DWC3_DALEPENA_EP(dep->number);
638 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
640 init_waitqueue_head(&dep->wait_end_transfer);
642 if (usb_endpoint_xfer_control(desc))
645 /* Initialize the TRB ring */
646 dep->trb_dequeue = 0;
647 dep->trb_enqueue = 0;
648 memset(dep->trb_pool, 0,
649 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
651 /* Link TRB. The HWO bit is never reset */
652 trb_st_hw = &dep->trb_pool[0];
654 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
655 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
656 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
657 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
658 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
662 * Issue StartTransfer here with no-op TRB so we can always rely on No
663 * Response Update Transfer command.
665 if (usb_endpoint_xfer_bulk(desc) ||
666 usb_endpoint_xfer_int(desc)) {
667 struct dwc3_gadget_ep_cmd_params params;
668 struct dwc3_trb *trb;
672 memset(¶ms, 0, sizeof(params));
673 trb = &dep->trb_pool[0];
674 trb_dma = dwc3_trb_dma_offset(dep, trb);
676 params.param0 = upper_32_bits(trb_dma);
677 params.param1 = lower_32_bits(trb_dma);
679 cmd = DWC3_DEPCMD_STARTTRANSFER;
681 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
685 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
686 WARN_ON_ONCE(!dep->resource_index);
690 trace_dwc3_gadget_ep_enable(dep);
695 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force);
696 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
698 struct dwc3_request *req;
700 dwc3_stop_active_transfer(dep, true);
702 /* - giveback all requests to gadget driver */
703 while (!list_empty(&dep->started_list)) {
704 req = next_request(&dep->started_list);
706 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
709 while (!list_empty(&dep->pending_list)) {
710 req = next_request(&dep->pending_list);
712 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
717 * __dwc3_gadget_ep_disable - disables a hw endpoint
718 * @dep: the endpoint to disable
720 * This function undoes what __dwc3_gadget_ep_enable did and also removes
721 * requests which are currently being processed by the hardware and those which
722 * are not yet scheduled.
724 * Caller should take care of locking.
726 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
728 struct dwc3 *dwc = dep->dwc;
731 trace_dwc3_gadget_ep_disable(dep);
733 dwc3_remove_requests(dwc, dep);
735 /* make sure HW endpoint isn't stalled */
736 if (dep->flags & DWC3_EP_STALL)
737 __dwc3_gadget_ep_set_halt(dep, 0, false);
739 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
740 reg &= ~DWC3_DALEPENA_EP(dep->number);
741 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
743 dep->stream_capable = false;
745 dep->flags &= DWC3_EP_END_TRANSFER_PENDING;
747 /* Clear out the ep descriptors for non-ep0 */
748 if (dep->number > 1) {
749 dep->endpoint.comp_desc = NULL;
750 dep->endpoint.desc = NULL;
756 /* -------------------------------------------------------------------------- */
758 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
759 const struct usb_endpoint_descriptor *desc)
764 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
769 /* -------------------------------------------------------------------------- */
771 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
772 const struct usb_endpoint_descriptor *desc)
779 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
780 pr_debug("dwc3: invalid parameters\n");
784 if (!desc->wMaxPacketSize) {
785 pr_debug("dwc3: missing wMaxPacketSize\n");
789 dep = to_dwc3_ep(ep);
792 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
793 "%s is already enabled\n",
797 spin_lock_irqsave(&dwc->lock, flags);
798 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
799 spin_unlock_irqrestore(&dwc->lock, flags);
804 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
812 pr_debug("dwc3: invalid parameters\n");
816 dep = to_dwc3_ep(ep);
819 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
820 "%s is already disabled\n",
824 spin_lock_irqsave(&dwc->lock, flags);
825 ret = __dwc3_gadget_ep_disable(dep);
826 spin_unlock_irqrestore(&dwc->lock, flags);
831 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
834 struct dwc3_request *req;
835 struct dwc3_ep *dep = to_dwc3_ep(ep);
837 req = kzalloc(sizeof(*req), gfp_flags);
841 req->epnum = dep->number;
844 trace_dwc3_alloc_request(req);
846 return &req->request;
849 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
850 struct usb_request *request)
852 struct dwc3_request *req = to_dwc3_request(request);
854 trace_dwc3_free_request(req);
858 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep);
860 static void __dwc3_prepare_one_trb(struct dwc3_ep *dep, struct dwc3_trb *trb,
861 dma_addr_t dma, unsigned length, unsigned chain, unsigned node,
862 unsigned stream_id, unsigned short_not_ok, unsigned no_interrupt)
864 struct dwc3 *dwc = dep->dwc;
865 struct usb_gadget *gadget = &dwc->gadget;
866 enum usb_device_speed speed = gadget->speed;
868 dwc3_ep_inc_enq(dep);
870 trb->size = DWC3_TRB_SIZE_LENGTH(length);
871 trb->bpl = lower_32_bits(dma);
872 trb->bph = upper_32_bits(dma);
874 switch (usb_endpoint_type(dep->endpoint.desc)) {
875 case USB_ENDPOINT_XFER_CONTROL:
876 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
879 case USB_ENDPOINT_XFER_ISOC:
881 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
884 * USB Specification 2.0 Section 5.9.2 states that: "If
885 * there is only a single transaction in the microframe,
886 * only a DATA0 data packet PID is used. If there are
887 * two transactions per microframe, DATA1 is used for
888 * the first transaction data packet and DATA0 is used
889 * for the second transaction data packet. If there are
890 * three transactions per microframe, DATA2 is used for
891 * the first transaction data packet, DATA1 is used for
892 * the second, and DATA0 is used for the third."
894 * IOW, we should satisfy the following cases:
896 * 1) length <= maxpacket
899 * 2) maxpacket < length <= (2 * maxpacket)
902 * 3) (2 * maxpacket) < length <= (3 * maxpacket)
903 * - DATA2, DATA1, DATA0
905 if (speed == USB_SPEED_HIGH) {
906 struct usb_ep *ep = &dep->endpoint;
907 unsigned int mult = 2;
908 unsigned int maxp = usb_endpoint_maxp(ep->desc);
910 if (length <= (2 * maxp))
916 trb->size |= DWC3_TRB_SIZE_PCM1(mult);
919 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
922 /* always enable Interrupt on Missed ISOC */
923 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
926 case USB_ENDPOINT_XFER_BULK:
927 case USB_ENDPOINT_XFER_INT:
928 trb->ctrl = DWC3_TRBCTL_NORMAL;
932 * This is only possible with faulty memory because we
933 * checked it already :)
935 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
936 usb_endpoint_type(dep->endpoint.desc));
939 /* always enable Continue on Short Packet */
940 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
941 trb->ctrl |= DWC3_TRB_CTRL_CSP;
944 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
947 if ((!no_interrupt && !chain) ||
948 (dwc3_calc_trbs_left(dep) == 0))
949 trb->ctrl |= DWC3_TRB_CTRL_IOC;
952 trb->ctrl |= DWC3_TRB_CTRL_CHN;
954 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
955 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(stream_id);
957 trb->ctrl |= DWC3_TRB_CTRL_HWO;
959 trace_dwc3_prepare_trb(dep, trb);
963 * dwc3_prepare_one_trb - setup one TRB from one request
964 * @dep: endpoint for which this request is prepared
965 * @req: dwc3_request pointer
966 * @chain: should this TRB be chained to the next?
967 * @node: only for isochronous endpoints. First TRB needs different type.
969 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
970 struct dwc3_request *req, unsigned chain, unsigned node)
972 struct dwc3_trb *trb;
975 unsigned stream_id = req->request.stream_id;
976 unsigned short_not_ok = req->request.short_not_ok;
977 unsigned no_interrupt = req->request.no_interrupt;
979 if (req->request.num_sgs > 0) {
980 length = sg_dma_len(req->start_sg);
981 dma = sg_dma_address(req->start_sg);
983 length = req->request.length;
984 dma = req->request.dma;
987 trb = &dep->trb_pool[dep->trb_enqueue];
990 dwc3_gadget_move_started_request(req);
992 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
995 __dwc3_prepare_one_trb(dep, trb, dma, length, chain, node,
996 stream_id, short_not_ok, no_interrupt);
1000 * dwc3_ep_prev_trb - returns the previous TRB in the ring
1001 * @dep: The endpoint with the TRB ring
1002 * @index: The index of the current TRB in the ring
1004 * Returns the TRB prior to the one pointed to by the index. If the
1005 * index is 0, we will wrap backwards, skip the link TRB, and return
1006 * the one just before that.
1008 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
1013 tmp = DWC3_TRB_NUM - 1;
1015 return &dep->trb_pool[tmp - 1];
1018 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
1020 struct dwc3_trb *tmp;
1024 * If enqueue & dequeue are equal than it is either full or empty.
1026 * One way to know for sure is if the TRB right before us has HWO bit
1027 * set or not. If it has, then we're definitely full and can't fit any
1028 * more transfers in our ring.
1030 if (dep->trb_enqueue == dep->trb_dequeue) {
1031 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1032 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
1035 return DWC3_TRB_NUM - 1;
1038 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
1039 trbs_left &= (DWC3_TRB_NUM - 1);
1041 if (dep->trb_dequeue < dep->trb_enqueue)
1047 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
1048 struct dwc3_request *req)
1050 struct scatterlist *sg = req->start_sg;
1051 struct scatterlist *s;
1054 unsigned int remaining = req->request.num_mapped_sgs
1055 - req->num_queued_sgs;
1057 for_each_sg(sg, s, remaining, i) {
1058 unsigned int length = req->request.length;
1059 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1060 unsigned int rem = length % maxp;
1061 unsigned chain = true;
1066 if (rem && usb_endpoint_dir_out(dep->endpoint.desc) && !chain) {
1067 struct dwc3 *dwc = dep->dwc;
1068 struct dwc3_trb *trb;
1070 req->unaligned = true;
1072 /* prepare normal TRB */
1073 dwc3_prepare_one_trb(dep, req, true, i);
1075 /* Now prepare one extra TRB to align transfer size */
1076 trb = &dep->trb_pool[dep->trb_enqueue];
1077 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr,
1078 maxp - rem, false, 0,
1079 req->request.stream_id,
1080 req->request.short_not_ok,
1081 req->request.no_interrupt);
1083 dwc3_prepare_one_trb(dep, req, chain, i);
1087 * There can be a situation where all sgs in sglist are not
1088 * queued because of insufficient trb number. To handle this
1089 * case, update start_sg to next sg to be queued, so that
1090 * we have free trbs we can continue queuing from where we
1091 * previously stopped
1094 req->start_sg = sg_next(s);
1096 req->num_queued_sgs++;
1098 if (!dwc3_calc_trbs_left(dep))
1103 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
1104 struct dwc3_request *req)
1106 unsigned int length = req->request.length;
1107 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1108 unsigned int rem = length % maxp;
1110 if (rem && usb_endpoint_dir_out(dep->endpoint.desc)) {
1111 struct dwc3 *dwc = dep->dwc;
1112 struct dwc3_trb *trb;
1114 req->unaligned = true;
1116 /* prepare normal TRB */
1117 dwc3_prepare_one_trb(dep, req, true, 0);
1119 /* Now prepare one extra TRB to align transfer size */
1120 trb = &dep->trb_pool[dep->trb_enqueue];
1121 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, maxp - rem,
1122 false, 0, req->request.stream_id,
1123 req->request.short_not_ok,
1124 req->request.no_interrupt);
1125 } else if (req->request.zero && req->request.length &&
1126 (IS_ALIGNED(req->request.length,dep->endpoint.maxpacket))) {
1127 struct dwc3 *dwc = dep->dwc;
1128 struct dwc3_trb *trb;
1132 /* prepare normal TRB */
1133 dwc3_prepare_one_trb(dep, req, true, 0);
1135 /* Now prepare one extra TRB to handle ZLP */
1136 trb = &dep->trb_pool[dep->trb_enqueue];
1137 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, 0,
1138 false, 0, req->request.stream_id,
1139 req->request.short_not_ok,
1140 req->request.no_interrupt);
1142 dwc3_prepare_one_trb(dep, req, false, 0);
1147 * dwc3_prepare_trbs - setup TRBs from requests
1148 * @dep: endpoint for which requests are being prepared
1150 * The function goes through the requests list and sets up TRBs for the
1151 * transfers. The function returns once there are no more TRBs available or
1152 * it runs out of requests.
1154 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
1156 struct dwc3_request *req, *n;
1158 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1161 * We can get in a situation where there's a request in the started list
1162 * but there weren't enough TRBs to fully kick it in the first time
1163 * around, so it has been waiting for more TRBs to be freed up.
1165 * In that case, we should check if we have a request with pending_sgs
1166 * in the started list and prepare TRBs for that request first,
1167 * otherwise we will prepare TRBs completely out of order and that will
1170 list_for_each_entry(req, &dep->started_list, list) {
1171 if (req->num_pending_sgs > 0)
1172 dwc3_prepare_one_trb_sg(dep, req);
1174 if (!dwc3_calc_trbs_left(dep))
1178 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1179 struct dwc3 *dwc = dep->dwc;
1182 ret = usb_gadget_map_request_by_dev(dwc->sysdev, &req->request,
1187 req->sg = req->request.sg;
1188 req->start_sg = req->sg;
1189 req->num_queued_sgs = 0;
1190 req->num_pending_sgs = req->request.num_mapped_sgs;
1192 if (req->num_pending_sgs > 0)
1193 dwc3_prepare_one_trb_sg(dep, req);
1195 dwc3_prepare_one_trb_linear(dep, req);
1197 if (!dwc3_calc_trbs_left(dep))
1202 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep)
1204 struct dwc3_gadget_ep_cmd_params params;
1205 struct dwc3_request *req;
1210 if (!dwc3_calc_trbs_left(dep))
1213 starting = !(dep->flags & DWC3_EP_TRANSFER_STARTED);
1215 dwc3_prepare_trbs(dep);
1216 req = next_request(&dep->started_list);
1218 dep->flags |= DWC3_EP_PENDING_REQUEST;
1222 memset(¶ms, 0, sizeof(params));
1225 params.param0 = upper_32_bits(req->trb_dma);
1226 params.param1 = lower_32_bits(req->trb_dma);
1227 cmd = DWC3_DEPCMD_STARTTRANSFER;
1229 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1230 cmd |= DWC3_DEPCMD_PARAM(dep->frame_number);
1232 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1233 DWC3_DEPCMD_PARAM(dep->resource_index);
1236 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1239 * FIXME we need to iterate over the list of requests
1240 * here and stop, unmap, free and del each of the linked
1241 * requests instead of what we do now.
1244 memset(req->trb, 0, sizeof(struct dwc3_trb));
1245 dwc3_gadget_del_and_unmap_request(dep, req, ret);
1250 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1251 WARN_ON_ONCE(!dep->resource_index);
1257 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1261 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1262 return DWC3_DSTS_SOFFN(reg);
1265 static void __dwc3_gadget_start_isoc(struct dwc3_ep *dep)
1267 if (list_empty(&dep->pending_list)) {
1268 dev_info(dep->dwc->dev, "%s: ran out of requests\n",
1270 dep->flags |= DWC3_EP_PENDING_REQUEST;
1275 * Schedule the first trb for one interval in the future or at
1276 * least 4 microframes.
1278 dep->frame_number += max_t(u32, 4, dep->interval);
1279 __dwc3_gadget_kick_transfer(dep);
1282 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1284 struct dwc3 *dwc = dep->dwc;
1286 if (!dep->endpoint.desc) {
1287 dev_err(dwc->dev, "%s: can't queue to disabled endpoint\n",
1292 if (WARN(req->dep != dep, "request %pK belongs to '%s'\n",
1293 &req->request, req->dep->name))
1296 pm_runtime_get(dwc->dev);
1298 req->request.actual = 0;
1299 req->request.status = -EINPROGRESS;
1300 req->direction = dep->direction;
1301 req->epnum = dep->number;
1303 trace_dwc3_ep_queue(req);
1305 list_add_tail(&req->list, &dep->pending_list);
1308 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1309 * wait for a XferNotReady event so we will know what's the current
1310 * (micro-)frame number.
1312 * Without this trick, we are very, very likely gonna get Bus Expiry
1313 * errors which will force us issue EndTransfer command.
1315 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1316 if (!(dep->flags & DWC3_EP_PENDING_REQUEST) &&
1317 !(dep->flags & DWC3_EP_TRANSFER_STARTED))
1320 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1321 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED)) {
1322 __dwc3_gadget_start_isoc(dep);
1328 return __dwc3_gadget_kick_transfer(dep);
1331 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1334 struct dwc3_request *req = to_dwc3_request(request);
1335 struct dwc3_ep *dep = to_dwc3_ep(ep);
1336 struct dwc3 *dwc = dep->dwc;
1338 unsigned long flags;
1342 spin_lock_irqsave(&dwc->lock, flags);
1343 ret = __dwc3_gadget_ep_queue(dep, req);
1344 spin_unlock_irqrestore(&dwc->lock, flags);
1349 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1350 struct usb_request *request)
1352 struct dwc3_request *req = to_dwc3_request(request);
1353 struct dwc3_request *r = NULL;
1355 struct dwc3_ep *dep = to_dwc3_ep(ep);
1356 struct dwc3 *dwc = dep->dwc;
1358 unsigned long flags;
1361 trace_dwc3_ep_dequeue(req);
1363 spin_lock_irqsave(&dwc->lock, flags);
1365 list_for_each_entry(r, &dep->pending_list, list) {
1371 list_for_each_entry(r, &dep->started_list, list) {
1376 /* wait until it is processed */
1377 dwc3_stop_active_transfer(dep, true);
1380 * If request was already started, this means we had to
1381 * stop the transfer. With that we also need to ignore
1382 * all TRBs used by the request, however TRBs can only
1383 * be modified after completion of END_TRANSFER
1384 * command. So what we do here is that we wait for
1385 * END_TRANSFER completion and only after that, we jump
1386 * over TRBs by clearing HWO and incrementing dequeue
1389 * Note that we have 2 possible types of transfers here:
1391 * i) Linear buffer request
1392 * ii) SG-list based request
1394 * SG-list based requests will have r->num_pending_sgs
1395 * set to a valid number (> 0). Linear requests,
1396 * normally use a single TRB.
1398 * For each of these two cases, if r->unaligned flag is
1399 * set, one extra TRB has been used to align transfer
1400 * size to wMaxPacketSize.
1402 * All of these cases need to be taken into
1403 * consideration so we don't mess up our TRB ring
1406 wait_event_lock_irq(dep->wait_end_transfer,
1407 !(dep->flags & DWC3_EP_END_TRANSFER_PENDING),
1413 if (r->num_pending_sgs) {
1414 struct dwc3_trb *trb;
1417 for (i = 0; i < r->num_pending_sgs; i++) {
1419 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1420 dwc3_ep_inc_deq(dep);
1423 if (r->unaligned || r->zero) {
1424 trb = r->trb + r->num_pending_sgs + 1;
1425 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1426 dwc3_ep_inc_deq(dep);
1429 struct dwc3_trb *trb = r->trb;
1431 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1432 dwc3_ep_inc_deq(dep);
1434 if (r->unaligned || r->zero) {
1436 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1437 dwc3_ep_inc_deq(dep);
1442 dev_err(dwc->dev, "request %pK was not queued to %s\n",
1449 /* giveback the request */
1451 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1454 spin_unlock_irqrestore(&dwc->lock, flags);
1459 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1461 struct dwc3_gadget_ep_cmd_params params;
1462 struct dwc3 *dwc = dep->dwc;
1465 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1466 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1470 memset(¶ms, 0x00, sizeof(params));
1473 struct dwc3_trb *trb;
1475 unsigned transfer_in_flight;
1478 if (dep->flags & DWC3_EP_STALL)
1481 if (dep->number > 1)
1482 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1484 trb = &dwc->ep0_trb[dep->trb_enqueue];
1486 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1487 started = !list_empty(&dep->started_list);
1489 if (!protocol && ((dep->direction && transfer_in_flight) ||
1490 (!dep->direction && started))) {
1494 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1497 dev_err(dwc->dev, "failed to set STALL on %s\n",
1500 dep->flags |= DWC3_EP_STALL;
1502 if (!(dep->flags & DWC3_EP_STALL))
1505 ret = dwc3_send_clear_stall_ep_cmd(dep);
1507 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1510 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1516 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1518 struct dwc3_ep *dep = to_dwc3_ep(ep);
1519 struct dwc3 *dwc = dep->dwc;
1521 unsigned long flags;
1525 spin_lock_irqsave(&dwc->lock, flags);
1526 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1527 spin_unlock_irqrestore(&dwc->lock, flags);
1532 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1534 struct dwc3_ep *dep = to_dwc3_ep(ep);
1535 struct dwc3 *dwc = dep->dwc;
1536 unsigned long flags;
1539 spin_lock_irqsave(&dwc->lock, flags);
1540 dep->flags |= DWC3_EP_WEDGE;
1542 if (dep->number == 0 || dep->number == 1)
1543 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1545 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1546 spin_unlock_irqrestore(&dwc->lock, flags);
1551 /* -------------------------------------------------------------------------- */
1553 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1554 .bLength = USB_DT_ENDPOINT_SIZE,
1555 .bDescriptorType = USB_DT_ENDPOINT,
1556 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1559 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1560 .enable = dwc3_gadget_ep0_enable,
1561 .disable = dwc3_gadget_ep0_disable,
1562 .alloc_request = dwc3_gadget_ep_alloc_request,
1563 .free_request = dwc3_gadget_ep_free_request,
1564 .queue = dwc3_gadget_ep0_queue,
1565 .dequeue = dwc3_gadget_ep_dequeue,
1566 .set_halt = dwc3_gadget_ep0_set_halt,
1567 .set_wedge = dwc3_gadget_ep_set_wedge,
1570 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1571 .enable = dwc3_gadget_ep_enable,
1572 .disable = dwc3_gadget_ep_disable,
1573 .alloc_request = dwc3_gadget_ep_alloc_request,
1574 .free_request = dwc3_gadget_ep_free_request,
1575 .queue = dwc3_gadget_ep_queue,
1576 .dequeue = dwc3_gadget_ep_dequeue,
1577 .set_halt = dwc3_gadget_ep_set_halt,
1578 .set_wedge = dwc3_gadget_ep_set_wedge,
1581 /* -------------------------------------------------------------------------- */
1583 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1585 struct dwc3 *dwc = gadget_to_dwc(g);
1587 return __dwc3_gadget_get_frame(dwc);
1590 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1601 * According to the Databook Remote wakeup request should
1602 * be issued only when the device is in early suspend state.
1604 * We can check that via USB Link State bits in DSTS register.
1606 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1608 speed = reg & DWC3_DSTS_CONNECTSPD;
1609 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1610 (speed == DWC3_DSTS_SUPERSPEED_PLUS))
1613 link_state = DWC3_DSTS_USBLNKST(reg);
1615 switch (link_state) {
1616 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1617 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1623 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1625 dev_err(dwc->dev, "failed to put link in Recovery\n");
1629 /* Recent versions do this automatically */
1630 if (dwc->revision < DWC3_REVISION_194A) {
1631 /* write zeroes to Link Change Request */
1632 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1633 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1634 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1637 /* poll until Link State changes to ON */
1641 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1643 /* in HS, means ON */
1644 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1648 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1649 dev_err(dwc->dev, "failed to send remote wakeup\n");
1656 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1658 struct dwc3 *dwc = gadget_to_dwc(g);
1659 unsigned long flags;
1662 spin_lock_irqsave(&dwc->lock, flags);
1663 ret = __dwc3_gadget_wakeup(dwc);
1664 spin_unlock_irqrestore(&dwc->lock, flags);
1669 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1672 struct dwc3 *dwc = gadget_to_dwc(g);
1673 unsigned long flags;
1675 spin_lock_irqsave(&dwc->lock, flags);
1676 g->is_selfpowered = !!is_selfpowered;
1677 spin_unlock_irqrestore(&dwc->lock, flags);
1682 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1687 if (pm_runtime_suspended(dwc->dev))
1690 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1692 if (dwc->revision <= DWC3_REVISION_187A) {
1693 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1694 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1697 if (dwc->revision >= DWC3_REVISION_194A)
1698 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1699 reg |= DWC3_DCTL_RUN_STOP;
1701 if (dwc->has_hibernation)
1702 reg |= DWC3_DCTL_KEEP_CONNECT;
1704 dwc->pullups_connected = true;
1706 reg &= ~DWC3_DCTL_RUN_STOP;
1708 if (dwc->has_hibernation && !suspend)
1709 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1711 dwc->pullups_connected = false;
1714 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1717 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1718 reg &= DWC3_DSTS_DEVCTRLHLT;
1719 } while (--timeout && !(!is_on ^ !reg));
1727 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1729 struct dwc3 *dwc = gadget_to_dwc(g);
1730 unsigned long flags;
1736 * Per databook, when we want to stop the gadget, if a control transfer
1737 * is still in process, complete it and get the core into setup phase.
1739 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
1740 reinit_completion(&dwc->ep0_in_setup);
1742 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
1743 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
1745 dev_err(dwc->dev, "timed out waiting for SETUP phase\n");
1750 spin_lock_irqsave(&dwc->lock, flags);
1751 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1752 spin_unlock_irqrestore(&dwc->lock, flags);
1757 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1761 /* Enable all but Start and End of Frame IRQs */
1762 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1763 DWC3_DEVTEN_EVNTOVERFLOWEN |
1764 DWC3_DEVTEN_CMDCMPLTEN |
1765 DWC3_DEVTEN_ERRTICERREN |
1766 DWC3_DEVTEN_WKUPEVTEN |
1767 DWC3_DEVTEN_CONNECTDONEEN |
1768 DWC3_DEVTEN_USBRSTEN |
1769 DWC3_DEVTEN_DISCONNEVTEN);
1771 if (dwc->revision < DWC3_REVISION_250A)
1772 reg |= DWC3_DEVTEN_ULSTCNGEN;
1774 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1777 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1779 /* mask all interrupts */
1780 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1783 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1784 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1787 * dwc3_gadget_setup_nump - calculate and initialize NUMP field of %DWC3_DCFG
1788 * @dwc: pointer to our context structure
1790 * The following looks like complex but it's actually very simple. In order to
1791 * calculate the number of packets we can burst at once on OUT transfers, we're
1792 * gonna use RxFIFO size.
1794 * To calculate RxFIFO size we need two numbers:
1795 * MDWIDTH = size, in bits, of the internal memory bus
1796 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1798 * Given these two numbers, the formula is simple:
1800 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1802 * 24 bytes is for 3x SETUP packets
1803 * 16 bytes is a clock domain crossing tolerance
1805 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1807 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1814 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1815 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1817 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1818 nump = min_t(u32, nump, 16);
1821 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1822 reg &= ~DWC3_DCFG_NUMP_MASK;
1823 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1824 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1827 static int __dwc3_gadget_start(struct dwc3 *dwc)
1829 struct dwc3_ep *dep;
1834 * Use IMOD if enabled via dwc->imod_interval. Otherwise, if
1835 * the core supports IMOD, disable it.
1837 if (dwc->imod_interval) {
1838 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
1839 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
1840 } else if (dwc3_has_imod(dwc)) {
1841 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), 0);
1845 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1846 * field instead of letting dwc3 itself calculate that automatically.
1848 * This way, we maximize the chances that we'll be able to get several
1849 * bursts of data without going through any sort of endpoint throttling.
1851 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1852 if (dwc3_is_usb31(dwc))
1853 reg &= ~DWC31_GRXTHRCFG_PKTCNTSEL;
1855 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1857 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1859 dwc3_gadget_setup_nump(dwc);
1861 /* Start with SuperSpeed Default */
1862 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1865 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
1867 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1872 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
1874 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1878 /* begin to receive SETUP packets */
1879 dwc->ep0state = EP0_SETUP_PHASE;
1880 dwc3_ep0_out_start(dwc);
1882 dwc3_gadget_enable_irq(dwc);
1887 __dwc3_gadget_ep_disable(dwc->eps[0]);
1893 static int dwc3_gadget_start(struct usb_gadget *g,
1894 struct usb_gadget_driver *driver)
1896 struct dwc3 *dwc = gadget_to_dwc(g);
1897 unsigned long flags;
1901 irq = dwc->irq_gadget;
1902 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1903 IRQF_SHARED, "dwc3", dwc->ev_buf);
1905 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1910 spin_lock_irqsave(&dwc->lock, flags);
1911 if (dwc->gadget_driver) {
1912 dev_err(dwc->dev, "%s is already bound to %s\n",
1914 dwc->gadget_driver->driver.name);
1919 dwc->gadget_driver = driver;
1921 if (pm_runtime_active(dwc->dev))
1922 __dwc3_gadget_start(dwc);
1924 spin_unlock_irqrestore(&dwc->lock, flags);
1929 spin_unlock_irqrestore(&dwc->lock, flags);
1936 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1938 dwc3_gadget_disable_irq(dwc);
1939 __dwc3_gadget_ep_disable(dwc->eps[0]);
1940 __dwc3_gadget_ep_disable(dwc->eps[1]);
1943 static int dwc3_gadget_stop(struct usb_gadget *g)
1945 struct dwc3 *dwc = gadget_to_dwc(g);
1946 unsigned long flags;
1950 spin_lock_irqsave(&dwc->lock, flags);
1952 if (pm_runtime_suspended(dwc->dev))
1955 __dwc3_gadget_stop(dwc);
1957 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1958 struct dwc3_ep *dep = dwc->eps[epnum];
1964 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
1967 ret = wait_event_interruptible_lock_irq_timeout(dep->wait_end_transfer,
1968 !(dep->flags & DWC3_EP_END_TRANSFER_PENDING),
1969 dwc->lock, msecs_to_jiffies(5));
1972 /* Timed out or interrupted! There's nothing much
1973 * we can do so we just log here and print which
1974 * endpoints timed out at the end.
1976 tmo_eps |= 1 << epnum;
1977 dep->flags &= DWC3_EP_END_TRANSFER_PENDING;
1983 "end transfer timed out on endpoints 0x%x [bitmap]\n",
1988 dwc->gadget_driver = NULL;
1989 spin_unlock_irqrestore(&dwc->lock, flags);
1991 free_irq(dwc->irq_gadget, dwc->ev_buf);
1996 static void dwc3_gadget_set_speed(struct usb_gadget *g,
1997 enum usb_device_speed speed)
1999 struct dwc3 *dwc = gadget_to_dwc(g);
2000 unsigned long flags;
2003 spin_lock_irqsave(&dwc->lock, flags);
2004 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2005 reg &= ~(DWC3_DCFG_SPEED_MASK);
2008 * WORKAROUND: DWC3 revision < 2.20a have an issue
2009 * which would cause metastability state on Run/Stop
2010 * bit if we try to force the IP to USB2-only mode.
2012 * Because of that, we cannot configure the IP to any
2013 * speed other than the SuperSpeed
2017 * STAR#9000525659: Clock Domain Crossing on DCTL in
2020 if (dwc->revision < DWC3_REVISION_220A &&
2021 !dwc->dis_metastability_quirk) {
2022 reg |= DWC3_DCFG_SUPERSPEED;
2026 reg |= DWC3_DCFG_LOWSPEED;
2028 case USB_SPEED_FULL:
2029 reg |= DWC3_DCFG_FULLSPEED;
2031 case USB_SPEED_HIGH:
2032 reg |= DWC3_DCFG_HIGHSPEED;
2034 case USB_SPEED_SUPER:
2035 reg |= DWC3_DCFG_SUPERSPEED;
2037 case USB_SPEED_SUPER_PLUS:
2038 if (dwc3_is_usb31(dwc))
2039 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2041 reg |= DWC3_DCFG_SUPERSPEED;
2044 dev_err(dwc->dev, "invalid speed (%d)\n", speed);
2046 if (dwc->revision & DWC3_REVISION_IS_DWC31)
2047 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2049 reg |= DWC3_DCFG_SUPERSPEED;
2052 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2054 spin_unlock_irqrestore(&dwc->lock, flags);
2057 static const struct usb_gadget_ops dwc3_gadget_ops = {
2058 .get_frame = dwc3_gadget_get_frame,
2059 .wakeup = dwc3_gadget_wakeup,
2060 .set_selfpowered = dwc3_gadget_set_selfpowered,
2061 .pullup = dwc3_gadget_pullup,
2062 .udc_start = dwc3_gadget_start,
2063 .udc_stop = dwc3_gadget_stop,
2064 .udc_set_speed = dwc3_gadget_set_speed,
2067 /* -------------------------------------------------------------------------- */
2069 static int dwc3_gadget_init_control_endpoint(struct dwc3_ep *dep)
2071 struct dwc3 *dwc = dep->dwc;
2073 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
2074 dep->endpoint.maxburst = 1;
2075 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
2076 if (!dep->direction)
2077 dwc->gadget.ep0 = &dep->endpoint;
2079 dep->endpoint.caps.type_control = true;
2084 static int dwc3_gadget_init_in_endpoint(struct dwc3_ep *dep)
2086 struct dwc3 *dwc = dep->dwc;
2091 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
2092 /* MDWIDTH is represented in bits, we need it in bytes */
2095 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1));
2096 if (dwc3_is_usb31(dwc))
2097 size = DWC31_GTXFIFOSIZ_TXFDEF(size);
2099 size = DWC3_GTXFIFOSIZ_TXFDEF(size);
2101 /* FIFO Depth is in MDWDITH bytes. Multiply */
2104 kbytes = size / 1024;
2109 * FIFO sizes account an extra MDWIDTH * (kbytes + 1) bytes for
2110 * internal overhead. We don't really know how these are used,
2111 * but documentation say it exists.
2113 size -= mdwidth * (kbytes + 1);
2116 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2118 dep->endpoint.max_streams = 15;
2119 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2120 list_add_tail(&dep->endpoint.ep_list,
2121 &dwc->gadget.ep_list);
2122 dep->endpoint.caps.type_iso = true;
2123 dep->endpoint.caps.type_bulk = true;
2124 dep->endpoint.caps.type_int = true;
2126 return dwc3_alloc_trb_pool(dep);
2129 static int dwc3_gadget_init_out_endpoint(struct dwc3_ep *dep)
2131 struct dwc3 *dwc = dep->dwc;
2133 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
2134 dep->endpoint.max_streams = 15;
2135 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2136 list_add_tail(&dep->endpoint.ep_list,
2137 &dwc->gadget.ep_list);
2138 dep->endpoint.caps.type_iso = true;
2139 dep->endpoint.caps.type_bulk = true;
2140 dep->endpoint.caps.type_int = true;
2142 return dwc3_alloc_trb_pool(dep);
2145 static int dwc3_gadget_init_endpoint(struct dwc3 *dwc, u8 epnum)
2147 struct dwc3_ep *dep;
2148 bool direction = epnum & 1;
2150 u8 num = epnum >> 1;
2152 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
2157 dep->number = epnum;
2158 dep->direction = direction;
2159 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
2160 dwc->eps[epnum] = dep;
2162 snprintf(dep->name, sizeof(dep->name), "ep%u%s", num,
2163 direction ? "in" : "out");
2165 dep->endpoint.name = dep->name;
2167 if (!(dep->number > 1)) {
2168 dep->endpoint.desc = &dwc3_gadget_ep0_desc;
2169 dep->endpoint.comp_desc = NULL;
2172 spin_lock_init(&dep->lock);
2175 ret = dwc3_gadget_init_control_endpoint(dep);
2177 ret = dwc3_gadget_init_in_endpoint(dep);
2179 ret = dwc3_gadget_init_out_endpoint(dep);
2184 dep->endpoint.caps.dir_in = direction;
2185 dep->endpoint.caps.dir_out = !direction;
2187 INIT_LIST_HEAD(&dep->pending_list);
2188 INIT_LIST_HEAD(&dep->started_list);
2193 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc, u8 total)
2197 INIT_LIST_HEAD(&dwc->gadget.ep_list);
2199 for (epnum = 0; epnum < total; epnum++) {
2202 ret = dwc3_gadget_init_endpoint(dwc, epnum);
2210 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
2212 struct dwc3_ep *dep;
2215 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2216 dep = dwc->eps[epnum];
2220 * Physical endpoints 0 and 1 are special; they form the
2221 * bi-directional USB endpoint 0.
2223 * For those two physical endpoints, we don't allocate a TRB
2224 * pool nor do we add them the endpoints list. Due to that, we
2225 * shouldn't do these two operations otherwise we would end up
2226 * with all sorts of bugs when removing dwc3.ko.
2228 if (epnum != 0 && epnum != 1) {
2229 dwc3_free_trb_pool(dep);
2230 list_del(&dep->endpoint.ep_list);
2237 /* -------------------------------------------------------------------------- */
2239 static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
2240 struct dwc3_request *req, struct dwc3_trb *trb,
2241 const struct dwc3_event_depevt *event, int status, int chain)
2245 dwc3_ep_inc_deq(dep);
2247 trace_dwc3_complete_trb(dep, trb);
2250 * If we're in the middle of series of chained TRBs and we
2251 * receive a short transfer along the way, DWC3 will skip
2252 * through all TRBs including the last TRB in the chain (the
2253 * where CHN bit is zero. DWC3 will also avoid clearing HWO
2254 * bit and SW has to do it manually.
2256 * We're going to do that here to avoid problems of HW trying
2257 * to use bogus TRBs for transfers.
2259 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
2260 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2263 * If we're dealing with unaligned size OUT transfer, we will be left
2264 * with one TRB pending in the ring. We need to manually clear HWO bit
2267 if ((req->zero || req->unaligned) && (trb->ctrl & DWC3_TRB_CTRL_HWO)) {
2268 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2272 count = trb->size & DWC3_TRB_SIZE_MASK;
2273 req->remaining += count;
2275 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
2278 if (event->status & DEPEVT_STATUS_SHORT && !chain)
2281 if (event->status & DEPEVT_STATUS_IOC)
2287 static int dwc3_gadget_ep_reclaim_trb_sg(struct dwc3_ep *dep,
2288 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2291 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2292 struct scatterlist *sg = req->sg;
2293 struct scatterlist *s;
2294 unsigned int pending = req->num_pending_sgs;
2298 for_each_sg(sg, s, pending, i) {
2299 trb = &dep->trb_pool[dep->trb_dequeue];
2301 if (trb->ctrl & DWC3_TRB_CTRL_HWO)
2304 req->sg = sg_next(s);
2305 req->num_pending_sgs--;
2307 ret = dwc3_gadget_ep_reclaim_completed_trb(dep, req,
2308 trb, event, status, true);
2316 static int dwc3_gadget_ep_reclaim_trb_linear(struct dwc3_ep *dep,
2317 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2320 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2322 return dwc3_gadget_ep_reclaim_completed_trb(dep, req, trb,
2323 event, status, false);
2326 static bool dwc3_gadget_ep_request_completed(struct dwc3_request *req)
2328 return req->request.actual == req->request.length;
2331 static int dwc3_gadget_ep_cleanup_completed_request(struct dwc3_ep *dep,
2332 const struct dwc3_event_depevt *event,
2333 struct dwc3_request *req, int status)
2337 if (req->num_pending_sgs)
2338 ret = dwc3_gadget_ep_reclaim_trb_sg(dep, req, event,
2341 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2344 if (req->unaligned || req->zero) {
2345 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2347 req->unaligned = false;
2351 req->request.actual = req->request.length - req->remaining;
2353 if (!dwc3_gadget_ep_request_completed(req) &&
2354 req->num_pending_sgs) {
2355 __dwc3_gadget_kick_transfer(dep);
2359 dwc3_gadget_giveback(dep, req, status);
2365 static void dwc3_gadget_ep_cleanup_completed_requests(struct dwc3_ep *dep,
2366 const struct dwc3_event_depevt *event, int status)
2368 struct dwc3_request *req;
2369 struct dwc3_request *tmp;
2371 list_for_each_entry_safe(req, tmp, &dep->started_list, list) {
2374 ret = dwc3_gadget_ep_cleanup_completed_request(dep, event,
2381 static void dwc3_gadget_endpoint_frame_from_event(struct dwc3_ep *dep,
2382 const struct dwc3_event_depevt *event)
2386 mask = ~(dep->interval - 1);
2387 cur_uf = event->parameters & mask;
2388 dep->frame_number = cur_uf;
2391 static void dwc3_gadget_endpoint_transfer_in_progress(struct dwc3_ep *dep,
2392 const struct dwc3_event_depevt *event)
2394 struct dwc3 *dwc = dep->dwc;
2395 unsigned status = 0;
2398 dwc3_gadget_endpoint_frame_from_event(dep, event);
2400 if (event->status & DEPEVT_STATUS_BUSERR)
2401 status = -ECONNRESET;
2403 if (event->status & DEPEVT_STATUS_MISSED_ISOC) {
2408 dwc3_gadget_ep_cleanup_completed_requests(dep, event, status);
2411 dwc3_stop_active_transfer(dep, true);
2412 dep->flags = DWC3_EP_ENABLED;
2416 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2417 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2419 if (dwc->revision < DWC3_REVISION_183A) {
2423 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2426 if (!(dep->flags & DWC3_EP_ENABLED))
2429 if (!list_empty(&dep->started_list))
2433 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2435 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2441 static void dwc3_gadget_endpoint_transfer_not_ready(struct dwc3_ep *dep,
2442 const struct dwc3_event_depevt *event)
2444 dwc3_gadget_endpoint_frame_from_event(dep, event);
2445 __dwc3_gadget_start_isoc(dep);
2448 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2449 const struct dwc3_event_depevt *event)
2451 struct dwc3_ep *dep;
2452 u8 epnum = event->endpoint_number;
2455 dep = dwc->eps[epnum];
2457 if (!(dep->flags & DWC3_EP_ENABLED)) {
2458 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
2461 /* Handle only EPCMDCMPLT when EP disabled */
2462 if (event->endpoint_event != DWC3_DEPEVT_EPCMDCMPLT)
2466 if (epnum == 0 || epnum == 1) {
2467 dwc3_ep0_interrupt(dwc, event);
2471 switch (event->endpoint_event) {
2472 case DWC3_DEPEVT_XFERINPROGRESS:
2473 dwc3_gadget_endpoint_transfer_in_progress(dep, event);
2475 case DWC3_DEPEVT_XFERNOTREADY:
2476 dwc3_gadget_endpoint_transfer_not_ready(dep, event);
2478 case DWC3_DEPEVT_EPCMDCMPLT:
2479 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
2481 if (cmd == DWC3_DEPCMD_ENDTRANSFER) {
2482 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
2483 wake_up(&dep->wait_end_transfer);
2486 case DWC3_DEPEVT_STREAMEVT:
2487 case DWC3_DEPEVT_XFERCOMPLETE:
2488 case DWC3_DEPEVT_RXTXFIFOEVT:
2493 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2495 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2496 spin_unlock(&dwc->lock);
2497 dwc->gadget_driver->disconnect(&dwc->gadget);
2498 spin_lock(&dwc->lock);
2502 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2504 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2505 spin_unlock(&dwc->lock);
2506 dwc->gadget_driver->suspend(&dwc->gadget);
2507 spin_lock(&dwc->lock);
2511 static void dwc3_resume_gadget(struct dwc3 *dwc)
2513 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2514 spin_unlock(&dwc->lock);
2515 dwc->gadget_driver->resume(&dwc->gadget);
2516 spin_lock(&dwc->lock);
2520 static void dwc3_reset_gadget(struct dwc3 *dwc)
2522 if (!dwc->gadget_driver)
2525 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2526 spin_unlock(&dwc->lock);
2527 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2528 spin_lock(&dwc->lock);
2532 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force)
2534 struct dwc3 *dwc = dep->dwc;
2535 struct dwc3_gadget_ep_cmd_params params;
2539 if ((dep->flags & DWC3_EP_END_TRANSFER_PENDING) ||
2540 !dep->resource_index)
2544 * NOTICE: We are violating what the Databook says about the
2545 * EndTransfer command. Ideally we would _always_ wait for the
2546 * EndTransfer Command Completion IRQ, but that's causing too
2547 * much trouble synchronizing between us and gadget driver.
2549 * We have discussed this with the IP Provider and it was
2550 * suggested to giveback all requests here, but give HW some
2551 * extra time to synchronize with the interconnect. We're using
2552 * an arbitrary 100us delay for that.
2554 * Note also that a similar handling was tested by Synopsys
2555 * (thanks a lot Paul) and nothing bad has come out of it.
2556 * In short, what we're doing is:
2558 * - Issue EndTransfer WITH CMDIOC bit set
2561 * As of IP version 3.10a of the DWC_usb3 IP, the controller
2562 * supports a mode to work around the above limitation. The
2563 * software can poll the CMDACT bit in the DEPCMD register
2564 * after issuing a EndTransfer command. This mode is enabled
2565 * by writing GUCTL2[14]. This polling is already done in the
2566 * dwc3_send_gadget_ep_cmd() function so if the mode is
2567 * enabled, the EndTransfer command will have completed upon
2568 * returning from this function and we don't need to delay for
2571 * This mode is NOT available on the DWC_usb31 IP.
2574 cmd = DWC3_DEPCMD_ENDTRANSFER;
2575 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2576 cmd |= DWC3_DEPCMD_CMDIOC;
2577 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2578 memset(¶ms, 0, sizeof(params));
2579 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2581 dep->resource_index = 0;
2583 if (dwc3_is_usb31(dwc) || dwc->revision < DWC3_REVISION_310A) {
2584 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
2589 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2593 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2594 struct dwc3_ep *dep;
2597 dep = dwc->eps[epnum];
2601 if (!(dep->flags & DWC3_EP_STALL))
2604 dep->flags &= ~DWC3_EP_STALL;
2606 ret = dwc3_send_clear_stall_ep_cmd(dep);
2611 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2615 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2616 reg &= ~DWC3_DCTL_INITU1ENA;
2617 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2619 reg &= ~DWC3_DCTL_INITU2ENA;
2620 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2622 dwc3_disconnect_gadget(dwc);
2624 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2625 dwc->setup_packet_pending = false;
2626 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2628 dwc->connected = false;
2631 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2635 dwc->connected = true;
2638 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2639 * would cause a missing Disconnect Event if there's a
2640 * pending Setup Packet in the FIFO.
2642 * There's no suggested workaround on the official Bug
2643 * report, which states that "unless the driver/application
2644 * is doing any special handling of a disconnect event,
2645 * there is no functional issue".
2647 * Unfortunately, it turns out that we _do_ some special
2648 * handling of a disconnect event, namely complete all
2649 * pending transfers, notify gadget driver of the
2650 * disconnection, and so on.
2652 * Our suggested workaround is to follow the Disconnect
2653 * Event steps here, instead, based on a setup_packet_pending
2654 * flag. Such flag gets set whenever we have a SETUP_PENDING
2655 * status for EP0 TRBs and gets cleared on XferComplete for the
2660 * STAR#9000466709: RTL: Device : Disconnect event not
2661 * generated if setup packet pending in FIFO
2663 if (dwc->revision < DWC3_REVISION_188A) {
2664 if (dwc->setup_packet_pending)
2665 dwc3_gadget_disconnect_interrupt(dwc);
2668 dwc3_reset_gadget(dwc);
2670 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2671 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2672 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2673 dwc->test_mode = false;
2674 dwc3_clear_stall_all_ep(dwc);
2676 /* Reset device address to zero */
2677 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2678 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2679 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2682 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2684 struct dwc3_ep *dep;
2689 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2690 speed = reg & DWC3_DSTS_CONNECTSPD;
2694 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2695 * each time on Connect Done.
2697 * Currently we always use the reset value. If any platform
2698 * wants to set this to a different value, we need to add a
2699 * setting and update GCTL.RAMCLKSEL here.
2703 case DWC3_DSTS_SUPERSPEED_PLUS:
2704 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2705 dwc->gadget.ep0->maxpacket = 512;
2706 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2708 case DWC3_DSTS_SUPERSPEED:
2710 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2711 * would cause a missing USB3 Reset event.
2713 * In such situations, we should force a USB3 Reset
2714 * event by calling our dwc3_gadget_reset_interrupt()
2719 * STAR#9000483510: RTL: SS : USB3 reset event may
2720 * not be generated always when the link enters poll
2722 if (dwc->revision < DWC3_REVISION_190A)
2723 dwc3_gadget_reset_interrupt(dwc);
2725 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2726 dwc->gadget.ep0->maxpacket = 512;
2727 dwc->gadget.speed = USB_SPEED_SUPER;
2729 case DWC3_DSTS_HIGHSPEED:
2730 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2731 dwc->gadget.ep0->maxpacket = 64;
2732 dwc->gadget.speed = USB_SPEED_HIGH;
2734 case DWC3_DSTS_FULLSPEED:
2735 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2736 dwc->gadget.ep0->maxpacket = 64;
2737 dwc->gadget.speed = USB_SPEED_FULL;
2739 case DWC3_DSTS_LOWSPEED:
2740 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2741 dwc->gadget.ep0->maxpacket = 8;
2742 dwc->gadget.speed = USB_SPEED_LOW;
2746 dwc->eps[1]->endpoint.maxpacket = dwc->gadget.ep0->maxpacket;
2748 /* Enable USB2 LPM Capability */
2750 if ((dwc->revision > DWC3_REVISION_194A) &&
2751 (speed != DWC3_DSTS_SUPERSPEED) &&
2752 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2753 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2754 reg |= DWC3_DCFG_LPM_CAP;
2755 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2757 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2758 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2760 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2763 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2764 * DCFG.LPMCap is set, core responses with an ACK and the
2765 * BESL value in the LPM token is less than or equal to LPM
2768 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2769 && dwc->has_lpm_erratum,
2770 "LPM Erratum not available on dwc3 revisions < 2.40a\n");
2772 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2773 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2775 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2777 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2778 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2779 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2783 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
2785 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2790 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
2792 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2797 * Configure PHY via GUSB3PIPECTLn if required.
2799 * Update GTXFIFOSIZn
2801 * In both cases reset values should be sufficient.
2805 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2808 * TODO take core out of low power mode when that's
2812 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2813 spin_unlock(&dwc->lock);
2814 dwc->gadget_driver->resume(&dwc->gadget);
2815 spin_lock(&dwc->lock);
2819 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2820 unsigned int evtinfo)
2822 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2823 unsigned int pwropt;
2826 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2827 * Hibernation mode enabled which would show up when device detects
2828 * host-initiated U3 exit.
2830 * In that case, device will generate a Link State Change Interrupt
2831 * from U3 to RESUME which is only necessary if Hibernation is
2834 * There are no functional changes due to such spurious event and we
2835 * just need to ignore it.
2839 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2842 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2843 if ((dwc->revision < DWC3_REVISION_250A) &&
2844 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2845 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2846 (next == DWC3_LINK_STATE_RESUME)) {
2852 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2853 * on the link partner, the USB session might do multiple entry/exit
2854 * of low power states before a transfer takes place.
2856 * Due to this problem, we might experience lower throughput. The
2857 * suggested workaround is to disable DCTL[12:9] bits if we're
2858 * transitioning from U1/U2 to U0 and enable those bits again
2859 * after a transfer completes and there are no pending transfers
2860 * on any of the enabled endpoints.
2862 * This is the first half of that workaround.
2866 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2867 * core send LGO_Ux entering U0
2869 if (dwc->revision < DWC3_REVISION_183A) {
2870 if (next == DWC3_LINK_STATE_U0) {
2874 switch (dwc->link_state) {
2875 case DWC3_LINK_STATE_U1:
2876 case DWC3_LINK_STATE_U2:
2877 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2878 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2879 | DWC3_DCTL_ACCEPTU2ENA
2880 | DWC3_DCTL_INITU1ENA
2881 | DWC3_DCTL_ACCEPTU1ENA);
2884 dwc->u1u2 = reg & u1u2;
2888 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2898 case DWC3_LINK_STATE_U1:
2899 if (dwc->speed == USB_SPEED_SUPER)
2900 dwc3_suspend_gadget(dwc);
2902 case DWC3_LINK_STATE_U2:
2903 case DWC3_LINK_STATE_U3:
2904 dwc3_suspend_gadget(dwc);
2906 case DWC3_LINK_STATE_RESUME:
2907 dwc3_resume_gadget(dwc);
2914 dwc->link_state = next;
2917 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
2918 unsigned int evtinfo)
2920 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2922 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
2923 dwc3_suspend_gadget(dwc);
2925 dwc->link_state = next;
2928 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2929 unsigned int evtinfo)
2931 unsigned int is_ss = evtinfo & BIT(4);
2934 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2935 * have a known issue which can cause USB CV TD.9.23 to fail
2938 * Because of this issue, core could generate bogus hibernation
2939 * events which SW needs to ignore.
2943 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2944 * Device Fallback from SuperSpeed
2946 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2949 /* enter hibernation here */
2952 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2953 const struct dwc3_event_devt *event)
2955 switch (event->type) {
2956 case DWC3_DEVICE_EVENT_DISCONNECT:
2957 dwc3_gadget_disconnect_interrupt(dwc);
2959 case DWC3_DEVICE_EVENT_RESET:
2960 dwc3_gadget_reset_interrupt(dwc);
2962 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2963 dwc3_gadget_conndone_interrupt(dwc);
2965 case DWC3_DEVICE_EVENT_WAKEUP:
2966 dwc3_gadget_wakeup_interrupt(dwc);
2968 case DWC3_DEVICE_EVENT_HIBER_REQ:
2969 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2970 "unexpected hibernation event\n"))
2973 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2975 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2976 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2978 case DWC3_DEVICE_EVENT_EOPF:
2979 /* It changed to be suspend event for version 2.30a and above */
2980 if (dwc->revision >= DWC3_REVISION_230A) {
2982 * Ignore suspend event until the gadget enters into
2983 * USB_STATE_CONFIGURED state.
2985 if (dwc->gadget.state >= USB_STATE_CONFIGURED)
2986 dwc3_gadget_suspend_interrupt(dwc,
2990 case DWC3_DEVICE_EVENT_SOF:
2991 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2992 case DWC3_DEVICE_EVENT_CMD_CMPL:
2993 case DWC3_DEVICE_EVENT_OVERFLOW:
2996 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
3000 static void dwc3_process_event_entry(struct dwc3 *dwc,
3001 const union dwc3_event *event)
3003 trace_dwc3_event(event->raw, dwc);
3005 if (!event->type.is_devspec)
3006 dwc3_endpoint_interrupt(dwc, &event->depevt);
3007 else if (event->type.type == DWC3_EVENT_TYPE_DEV)
3008 dwc3_gadget_interrupt(dwc, &event->devt);
3010 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
3013 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
3015 struct dwc3 *dwc = evt->dwc;
3016 irqreturn_t ret = IRQ_NONE;
3022 if (!(evt->flags & DWC3_EVENT_PENDING))
3026 union dwc3_event event;
3028 event.raw = *(u32 *) (evt->cache + evt->lpos);
3030 dwc3_process_event_entry(dwc, &event);
3033 * FIXME we wrap around correctly to the next entry as
3034 * almost all entries are 4 bytes in size. There is one
3035 * entry which has 12 bytes which is a regular entry
3036 * followed by 8 bytes data. ATM I don't know how
3037 * things are organized if we get next to the a
3038 * boundary so I worry about that once we try to handle
3041 evt->lpos = (evt->lpos + 4) % evt->length;
3046 evt->flags &= ~DWC3_EVENT_PENDING;
3049 /* Unmask interrupt */
3050 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3051 reg &= ~DWC3_GEVNTSIZ_INTMASK;
3052 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3054 if (dwc->imod_interval) {
3055 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
3056 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
3062 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
3064 struct dwc3_event_buffer *evt = _evt;
3065 struct dwc3 *dwc = evt->dwc;
3066 unsigned long flags;
3067 irqreturn_t ret = IRQ_NONE;
3069 spin_lock_irqsave(&dwc->lock, flags);
3070 ret = dwc3_process_event_buf(evt);
3071 spin_unlock_irqrestore(&dwc->lock, flags);
3076 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
3078 struct dwc3 *dwc = evt->dwc;
3083 if (pm_runtime_suspended(dwc->dev)) {
3084 pm_runtime_get(dwc->dev);
3085 disable_irq_nosync(dwc->irq_gadget);
3086 dwc->pending_events = true;
3091 * With PCIe legacy interrupt, test shows that top-half irq handler can
3092 * be called again after HW interrupt deassertion. Check if bottom-half
3093 * irq event handler completes before caching new event to prevent
3096 if (evt->flags & DWC3_EVENT_PENDING)
3099 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
3100 count &= DWC3_GEVNTCOUNT_MASK;
3105 evt->flags |= DWC3_EVENT_PENDING;
3107 /* Mask interrupt */
3108 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3109 reg |= DWC3_GEVNTSIZ_INTMASK;
3110 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3112 amount = min(count, evt->length - evt->lpos);
3113 memcpy(evt->cache + evt->lpos, evt->buf + evt->lpos, amount);
3116 memcpy(evt->cache, evt->buf, count - amount);
3118 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
3120 return IRQ_WAKE_THREAD;
3123 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
3125 struct dwc3_event_buffer *evt = _evt;
3127 return dwc3_check_event_buf(evt);
3130 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
3132 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
3135 irq = platform_get_irq_byname(dwc3_pdev, "peripheral");
3139 if (irq == -EPROBE_DEFER)
3142 irq = platform_get_irq_byname(dwc3_pdev, "dwc_usb3");
3146 if (irq == -EPROBE_DEFER)
3149 irq = platform_get_irq(dwc3_pdev, 0);
3153 if (irq != -EPROBE_DEFER)
3154 dev_err(dwc->dev, "missing peripheral IRQ\n");
3164 * dwc3_gadget_init - initializes gadget related registers
3165 * @dwc: pointer to our controller context structure
3167 * Returns 0 on success otherwise negative errno.
3169 int dwc3_gadget_init(struct dwc3 *dwc)
3174 irq = dwc3_gadget_get_irq(dwc);
3180 dwc->irq_gadget = irq;
3182 dwc->ep0_trb = dma_alloc_coherent(dwc->sysdev,
3183 sizeof(*dwc->ep0_trb) * 2,
3184 &dwc->ep0_trb_addr, GFP_KERNEL);
3185 if (!dwc->ep0_trb) {
3186 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
3191 dwc->setup_buf = kzalloc(DWC3_EP0_SETUP_SIZE, GFP_KERNEL);
3192 if (!dwc->setup_buf) {
3197 dwc->bounce = dma_alloc_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE,
3198 &dwc->bounce_addr, GFP_KERNEL);
3204 init_completion(&dwc->ep0_in_setup);
3206 dwc->gadget.ops = &dwc3_gadget_ops;
3207 dwc->gadget.speed = USB_SPEED_UNKNOWN;
3208 dwc->gadget.sg_supported = true;
3209 dwc->gadget.name = "dwc3-gadget";
3210 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
3213 * FIXME We might be setting max_speed to <SUPER, however versions
3214 * <2.20a of dwc3 have an issue with metastability (documented
3215 * elsewhere in this driver) which tells us we can't set max speed to
3216 * anything lower than SUPER.
3218 * Because gadget.max_speed is only used by composite.c and function
3219 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
3220 * to happen so we avoid sending SuperSpeed Capability descriptor
3221 * together with our BOS descriptor as that could confuse host into
3222 * thinking we can handle super speed.
3224 * Note that, in fact, we won't even support GetBOS requests when speed
3225 * is less than super speed because we don't have means, yet, to tell
3226 * composite.c that we are USB 2.0 + LPM ECN.
3228 if (dwc->revision < DWC3_REVISION_220A &&
3229 !dwc->dis_metastability_quirk)
3230 dev_info(dwc->dev, "changing max_speed on rev %08x\n",
3233 dwc->gadget.max_speed = dwc->maximum_speed;
3236 * REVISIT: Here we should clear all pending IRQs to be
3237 * sure we're starting from a well known location.
3240 ret = dwc3_gadget_init_endpoints(dwc, dwc->num_eps);
3244 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
3246 dev_err(dwc->dev, "failed to register udc\n");
3253 dwc3_gadget_free_endpoints(dwc);
3256 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3260 kfree(dwc->setup_buf);
3263 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3264 dwc->ep0_trb, dwc->ep0_trb_addr);
3270 /* -------------------------------------------------------------------------- */
3272 void dwc3_gadget_exit(struct dwc3 *dwc)
3274 usb_del_gadget_udc(&dwc->gadget);
3275 dwc3_gadget_free_endpoints(dwc);
3276 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3278 kfree(dwc->setup_buf);
3279 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3280 dwc->ep0_trb, dwc->ep0_trb_addr);
3283 int dwc3_gadget_suspend(struct dwc3 *dwc)
3285 if (!dwc->gadget_driver)
3288 dwc3_gadget_run_stop(dwc, false, false);
3289 dwc3_disconnect_gadget(dwc);
3290 __dwc3_gadget_stop(dwc);
3295 int dwc3_gadget_resume(struct dwc3 *dwc)
3299 if (!dwc->gadget_driver)
3302 ret = __dwc3_gadget_start(dwc);
3306 ret = dwc3_gadget_run_stop(dwc, true, false);
3313 __dwc3_gadget_stop(dwc);
3319 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3321 if (dwc->pending_events) {
3322 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3323 dwc->pending_events = false;
3324 enable_irq(dwc->irq_gadget);