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>
30 #define DWC3_ALIGN_FRAME(d, n) (((d)->frame_number + ((d)->interval * (n))) \
31 & ~((d)->interval - 1))
34 * dwc3_gadget_set_test_mode - enables usb2 test modes
35 * @dwc: pointer to our context structure
36 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
38 * Caller should take care of locking. This function will return 0 on
39 * success or -EINVAL if wrong Test Selector is passed.
41 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
45 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
46 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
60 dwc3_gadget_dctl_write_safe(dwc, reg);
66 * dwc3_gadget_get_link_state - gets current state of usb link
67 * @dwc: pointer to our context structure
69 * Caller should take care of locking. This function will
70 * return the link state on success (>= 0) or -ETIMEDOUT.
72 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
76 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
78 return DWC3_DSTS_USBLNKST(reg);
82 * dwc3_gadget_set_link_state - sets usb link to a particular state
83 * @dwc: pointer to our context structure
84 * @state: the state to put link into
86 * Caller should take care of locking. This function will
87 * return 0 on success or -ETIMEDOUT.
89 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
95 * Wait until device controller is ready. Only applies to 1.94a and
98 if (dwc->revision >= DWC3_REVISION_194A) {
100 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
101 if (reg & DWC3_DSTS_DCNRD)
111 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
112 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
114 /* set no action before sending new link state change */
115 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
117 /* set requested state */
118 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
119 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
122 * The following code is racy when called from dwc3_gadget_wakeup,
123 * and is not needed, at least on newer versions
125 if (dwc->revision >= DWC3_REVISION_194A)
128 /* wait for a change in DSTS */
131 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
133 if (DWC3_DSTS_USBLNKST(reg) == state)
143 * dwc3_ep_inc_trb - increment a trb index.
144 * @index: Pointer to the TRB index to increment.
146 * The index should never point to the link TRB. After incrementing,
147 * if it is point to the link TRB, wrap around to the beginning. The
148 * link TRB is always at the last TRB entry.
150 static void dwc3_ep_inc_trb(u8 *index)
153 if (*index == (DWC3_TRB_NUM - 1))
158 * dwc3_ep_inc_enq - increment endpoint's enqueue pointer
159 * @dep: The endpoint whose enqueue pointer we're incrementing
161 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
163 dwc3_ep_inc_trb(&dep->trb_enqueue);
167 * dwc3_ep_inc_deq - increment endpoint's dequeue pointer
168 * @dep: The endpoint whose enqueue pointer we're incrementing
170 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
172 dwc3_ep_inc_trb(&dep->trb_dequeue);
175 static void dwc3_gadget_del_and_unmap_request(struct dwc3_ep *dep,
176 struct dwc3_request *req, int status)
178 struct dwc3 *dwc = dep->dwc;
180 list_del(&req->list);
182 req->needs_extra_trb = false;
184 if (req->request.status == -EINPROGRESS)
185 req->request.status = status;
188 usb_gadget_unmap_request_by_dev(dwc->sysdev,
189 &req->request, req->direction);
192 trace_dwc3_gadget_giveback(req);
195 pm_runtime_put(dwc->dev);
199 * dwc3_gadget_giveback - call struct usb_request's ->complete callback
200 * @dep: The endpoint to whom the request belongs to
201 * @req: The request we're giving back
202 * @status: completion code for the request
204 * Must be called with controller's lock held and interrupts disabled. This
205 * function will unmap @req and call its ->complete() callback to notify upper
206 * layers that it has completed.
208 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
211 struct dwc3 *dwc = dep->dwc;
213 dwc3_gadget_del_and_unmap_request(dep, req, status);
214 req->status = DWC3_REQUEST_STATUS_COMPLETED;
216 spin_unlock(&dwc->lock);
217 usb_gadget_giveback_request(&dep->endpoint, &req->request);
218 spin_lock(&dwc->lock);
222 * dwc3_send_gadget_generic_command - issue a generic command for the controller
223 * @dwc: pointer to the controller context
224 * @cmd: the command to be issued
225 * @param: command parameter
227 * Caller should take care of locking. Issue @cmd with a given @param to @dwc
228 * and wait for its completion.
230 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
237 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
238 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
241 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
242 if (!(reg & DWC3_DGCMD_CMDACT)) {
243 status = DWC3_DGCMD_STATUS(reg);
255 trace_dwc3_gadget_generic_cmd(cmd, param, status);
260 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
263 * dwc3_send_gadget_ep_cmd - issue an endpoint command
264 * @dep: the endpoint to which the command is going to be issued
265 * @cmd: the command to be issued
266 * @params: parameters to the command
268 * Caller should handle locking. This function will issue @cmd with given
269 * @params to @dep and wait for its completion.
271 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
272 struct dwc3_gadget_ep_cmd_params *params)
274 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
275 struct dwc3 *dwc = dep->dwc;
277 u32 saved_config = 0;
284 * When operating in USB 2.0 speeds (HS/FS), if GUSB2PHYCFG.ENBLSLPM or
285 * GUSB2PHYCFG.SUSPHY is set, it must be cleared before issuing an
288 * Save and clear both GUSB2PHYCFG.ENBLSLPM and GUSB2PHYCFG.SUSPHY
289 * settings. Restore them after the command is completed.
291 * DWC_usb3 3.30a and DWC_usb31 1.90a programming guide section 3.2.2
293 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
294 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
295 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
296 saved_config |= DWC3_GUSB2PHYCFG_SUSPHY;
297 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
300 if (reg & DWC3_GUSB2PHYCFG_ENBLSLPM) {
301 saved_config |= DWC3_GUSB2PHYCFG_ENBLSLPM;
302 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
306 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
309 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
312 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
313 dwc->link_state == DWC3_LINK_STATE_U2 ||
314 dwc->link_state == DWC3_LINK_STATE_U3);
316 if (unlikely(needs_wakeup)) {
317 ret = __dwc3_gadget_wakeup(dwc);
318 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
323 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
324 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
325 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
328 * Synopsys Databook 2.60a states in section 6.3.2.5.6 of that if we're
329 * not relying on XferNotReady, we can make use of a special "No
330 * Response Update Transfer" command where we should clear both CmdAct
333 * With this, we don't need to wait for command completion and can
334 * straight away issue further commands to the endpoint.
336 * NOTICE: We're making an assumption that control endpoints will never
337 * make use of Update Transfer command. This is a safe assumption
338 * because we can never have more than one request at a time with
339 * Control Endpoints. If anybody changes that assumption, this chunk
340 * needs to be updated accordingly.
342 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_UPDATETRANSFER &&
343 !usb_endpoint_xfer_isoc(desc))
344 cmd &= ~(DWC3_DEPCMD_CMDIOC | DWC3_DEPCMD_CMDACT);
346 cmd |= DWC3_DEPCMD_CMDACT;
348 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd);
350 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
351 if (!(reg & DWC3_DEPCMD_CMDACT)) {
352 cmd_status = DWC3_DEPCMD_STATUS(reg);
354 switch (cmd_status) {
358 case DEPEVT_TRANSFER_NO_RESOURCE:
361 case DEPEVT_TRANSFER_BUS_EXPIRY:
363 * SW issues START TRANSFER command to
364 * isochronous ep with future frame interval. If
365 * future interval time has already passed when
366 * core receives the command, it will respond
367 * with an error status of 'Bus Expiry'.
369 * Instead of always returning -EINVAL, let's
370 * give a hint to the gadget driver that this is
371 * the case by returning -EAGAIN.
376 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
385 cmd_status = -ETIMEDOUT;
388 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
390 if (ret == 0 && DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
391 dep->flags |= DWC3_EP_TRANSFER_STARTED;
392 dwc3_gadget_ep_get_transfer_index(dep);
396 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
398 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
404 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
406 struct dwc3 *dwc = dep->dwc;
407 struct dwc3_gadget_ep_cmd_params params;
408 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
411 * As of core revision 2.60a the recommended programming model
412 * is to set the ClearPendIN bit when issuing a Clear Stall EP
413 * command for IN endpoints. This is to prevent an issue where
414 * some (non-compliant) hosts may not send ACK TPs for pending
415 * IN transfers due to a mishandled error condition. Synopsys
418 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A) &&
419 (dwc->gadget.speed >= USB_SPEED_SUPER))
420 cmd |= DWC3_DEPCMD_CLEARPENDIN;
422 memset(¶ms, 0, sizeof(params));
424 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
427 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
428 struct dwc3_trb *trb)
430 u32 offset = (char *) trb - (char *) dep->trb_pool;
432 return dep->trb_pool_dma + offset;
435 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
437 struct dwc3 *dwc = dep->dwc;
442 dep->trb_pool = dma_alloc_coherent(dwc->sysdev,
443 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
444 &dep->trb_pool_dma, GFP_KERNEL);
445 if (!dep->trb_pool) {
446 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
454 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
456 struct dwc3 *dwc = dep->dwc;
458 dma_free_coherent(dwc->sysdev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
459 dep->trb_pool, dep->trb_pool_dma);
461 dep->trb_pool = NULL;
462 dep->trb_pool_dma = 0;
465 static int dwc3_gadget_set_xfer_resource(struct dwc3_ep *dep)
467 struct dwc3_gadget_ep_cmd_params params;
469 memset(¶ms, 0x00, sizeof(params));
471 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
473 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
478 * dwc3_gadget_start_config - configure ep resources
479 * @dep: endpoint that is being enabled
481 * Issue a %DWC3_DEPCMD_DEPSTARTCFG command to @dep. After the command's
482 * completion, it will set Transfer Resource for all available endpoints.
484 * The assignment of transfer resources cannot perfectly follow the data book
485 * due to the fact that the controller driver does not have all knowledge of the
486 * configuration in advance. It is given this information piecemeal by the
487 * composite gadget framework after every SET_CONFIGURATION and
488 * SET_INTERFACE. Trying to follow the databook programming model in this
489 * scenario can cause errors. For two reasons:
491 * 1) The databook says to do %DWC3_DEPCMD_DEPSTARTCFG for every
492 * %USB_REQ_SET_CONFIGURATION and %USB_REQ_SET_INTERFACE (8.1.5). This is
493 * incorrect in the scenario of multiple interfaces.
495 * 2) The databook does not mention doing more %DWC3_DEPCMD_DEPXFERCFG for new
496 * endpoint on alt setting (8.1.6).
498 * The following simplified method is used instead:
500 * All hardware endpoints can be assigned a transfer resource and this setting
501 * will stay persistent until either a core reset or hibernation. So whenever we
502 * do a %DWC3_DEPCMD_DEPSTARTCFG(0) we can go ahead and do
503 * %DWC3_DEPCMD_DEPXFERCFG for every hardware endpoint as well. We are
504 * guaranteed that there are as many transfer resources as endpoints.
506 * This function is called for each endpoint when it is being enabled but is
507 * triggered only when called for EP0-out, which always happens first, and which
508 * should only happen in one of the above conditions.
510 static int dwc3_gadget_start_config(struct dwc3_ep *dep)
512 struct dwc3_gadget_ep_cmd_params params;
521 memset(¶ms, 0x00, sizeof(params));
522 cmd = DWC3_DEPCMD_DEPSTARTCFG;
525 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
529 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
530 struct dwc3_ep *dep = dwc->eps[i];
535 ret = dwc3_gadget_set_xfer_resource(dep);
543 static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
545 const struct usb_ss_ep_comp_descriptor *comp_desc;
546 const struct usb_endpoint_descriptor *desc;
547 struct dwc3_gadget_ep_cmd_params params;
548 struct dwc3 *dwc = dep->dwc;
550 comp_desc = dep->endpoint.comp_desc;
551 desc = dep->endpoint.desc;
553 memset(¶ms, 0x00, sizeof(params));
555 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
556 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
558 /* Burst size is only needed in SuperSpeed mode */
559 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
560 u32 burst = dep->endpoint.maxburst;
561 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
564 params.param0 |= action;
565 if (action == DWC3_DEPCFG_ACTION_RESTORE)
566 params.param2 |= dep->saved_state;
568 if (usb_endpoint_xfer_control(desc))
569 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
571 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
572 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
574 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
575 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
576 | DWC3_DEPCFG_STREAM_EVENT_EN;
577 dep->stream_capable = true;
580 if (!usb_endpoint_xfer_control(desc))
581 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
584 * We are doing 1:1 mapping for endpoints, meaning
585 * Physical Endpoints 2 maps to Logical Endpoint 2 and
586 * so on. We consider the direction bit as part of the physical
587 * endpoint number. So USB endpoint 0x81 is 0x03.
589 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
592 * We must use the lower 16 TX FIFOs even though
596 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
598 if (desc->bInterval) {
599 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
600 dep->interval = 1 << (desc->bInterval - 1);
603 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
607 * __dwc3_gadget_ep_enable - initializes a hw endpoint
608 * @dep: endpoint to be initialized
609 * @action: one of INIT, MODIFY or RESTORE
611 * Caller should take care of locking. Execute all necessary commands to
612 * initialize a HW endpoint so it can be used by a gadget driver.
614 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep, unsigned int action)
616 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
617 struct dwc3 *dwc = dep->dwc;
622 if (!(dep->flags & DWC3_EP_ENABLED)) {
623 ret = dwc3_gadget_start_config(dep);
628 ret = dwc3_gadget_set_ep_config(dep, action);
632 if (!(dep->flags & DWC3_EP_ENABLED)) {
633 struct dwc3_trb *trb_st_hw;
634 struct dwc3_trb *trb_link;
636 dep->type = usb_endpoint_type(desc);
637 dep->flags |= DWC3_EP_ENABLED;
639 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
640 reg |= DWC3_DALEPENA_EP(dep->number);
641 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
643 if (usb_endpoint_xfer_control(desc))
646 /* Initialize the TRB ring */
647 dep->trb_dequeue = 0;
648 dep->trb_enqueue = 0;
649 memset(dep->trb_pool, 0,
650 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
652 /* Link TRB. The HWO bit is never reset */
653 trb_st_hw = &dep->trb_pool[0];
655 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
656 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
657 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
658 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
659 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
663 * Issue StartTransfer here with no-op TRB so we can always rely on No
664 * Response Update Transfer command.
666 if ((usb_endpoint_xfer_bulk(desc) && !dep->stream_capable) ||
667 usb_endpoint_xfer_int(desc)) {
668 struct dwc3_gadget_ep_cmd_params params;
669 struct dwc3_trb *trb;
673 memset(¶ms, 0, sizeof(params));
674 trb = &dep->trb_pool[0];
675 trb_dma = dwc3_trb_dma_offset(dep, trb);
677 params.param0 = upper_32_bits(trb_dma);
678 params.param1 = lower_32_bits(trb_dma);
680 cmd = DWC3_DEPCMD_STARTTRANSFER;
682 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
688 trace_dwc3_gadget_ep_enable(dep);
693 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
695 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
697 struct dwc3_request *req;
699 dwc3_stop_active_transfer(dep, true, false);
701 /* - giveback all requests to gadget driver */
702 while (!list_empty(&dep->started_list)) {
703 req = next_request(&dep->started_list);
705 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
708 while (!list_empty(&dep->pending_list)) {
709 req = next_request(&dep->pending_list);
711 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
714 while (!list_empty(&dep->cancelled_list)) {
715 req = next_request(&dep->cancelled_list);
717 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
722 * __dwc3_gadget_ep_disable - disables a hw endpoint
723 * @dep: the endpoint to disable
725 * This function undoes what __dwc3_gadget_ep_enable did and also removes
726 * requests which are currently being processed by the hardware and those which
727 * are not yet scheduled.
729 * Caller should take care of locking.
731 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
733 struct dwc3 *dwc = dep->dwc;
736 trace_dwc3_gadget_ep_disable(dep);
738 dwc3_remove_requests(dwc, dep);
740 /* make sure HW endpoint isn't stalled */
741 if (dep->flags & DWC3_EP_STALL)
742 __dwc3_gadget_ep_set_halt(dep, 0, false);
744 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
745 reg &= ~DWC3_DALEPENA_EP(dep->number);
746 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
748 dep->stream_capable = false;
752 /* Clear out the ep descriptors for non-ep0 */
753 if (dep->number > 1) {
754 dep->endpoint.comp_desc = NULL;
755 dep->endpoint.desc = NULL;
761 /* -------------------------------------------------------------------------- */
763 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
764 const struct usb_endpoint_descriptor *desc)
769 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
774 /* -------------------------------------------------------------------------- */
776 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
777 const struct usb_endpoint_descriptor *desc)
784 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
785 pr_debug("dwc3: invalid parameters\n");
789 if (!desc->wMaxPacketSize) {
790 pr_debug("dwc3: missing wMaxPacketSize\n");
794 dep = to_dwc3_ep(ep);
797 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
798 "%s is already enabled\n",
802 spin_lock_irqsave(&dwc->lock, flags);
803 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
804 spin_unlock_irqrestore(&dwc->lock, flags);
809 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
817 pr_debug("dwc3: invalid parameters\n");
821 dep = to_dwc3_ep(ep);
824 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
825 "%s is already disabled\n",
829 spin_lock_irqsave(&dwc->lock, flags);
830 ret = __dwc3_gadget_ep_disable(dep);
831 spin_unlock_irqrestore(&dwc->lock, flags);
836 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
839 struct dwc3_request *req;
840 struct dwc3_ep *dep = to_dwc3_ep(ep);
842 req = kzalloc(sizeof(*req), gfp_flags);
846 req->direction = dep->direction;
847 req->epnum = dep->number;
849 req->status = DWC3_REQUEST_STATUS_UNKNOWN;
851 trace_dwc3_alloc_request(req);
853 return &req->request;
856 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
857 struct usb_request *request)
859 struct dwc3_request *req = to_dwc3_request(request);
861 trace_dwc3_free_request(req);
866 * dwc3_ep_prev_trb - returns the previous TRB in the ring
867 * @dep: The endpoint with the TRB ring
868 * @index: The index of the current TRB in the ring
870 * Returns the TRB prior to the one pointed to by the index. If the
871 * index is 0, we will wrap backwards, skip the link TRB, and return
872 * the one just before that.
874 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
879 tmp = DWC3_TRB_NUM - 1;
881 return &dep->trb_pool[tmp - 1];
884 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
886 struct dwc3_trb *tmp;
890 * If enqueue & dequeue are equal than it is either full or empty.
892 * One way to know for sure is if the TRB right before us has HWO bit
893 * set or not. If it has, then we're definitely full and can't fit any
894 * more transfers in our ring.
896 if (dep->trb_enqueue == dep->trb_dequeue) {
897 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
898 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
901 return DWC3_TRB_NUM - 1;
904 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
905 trbs_left &= (DWC3_TRB_NUM - 1);
907 if (dep->trb_dequeue < dep->trb_enqueue)
913 static void __dwc3_prepare_one_trb(struct dwc3_ep *dep, struct dwc3_trb *trb,
914 dma_addr_t dma, unsigned length, unsigned chain, unsigned node,
915 unsigned stream_id, unsigned short_not_ok, unsigned no_interrupt)
917 struct dwc3 *dwc = dep->dwc;
918 struct usb_gadget *gadget = &dwc->gadget;
919 enum usb_device_speed speed = gadget->speed;
921 trb->size = DWC3_TRB_SIZE_LENGTH(length);
922 trb->bpl = lower_32_bits(dma);
923 trb->bph = upper_32_bits(dma);
925 switch (usb_endpoint_type(dep->endpoint.desc)) {
926 case USB_ENDPOINT_XFER_CONTROL:
927 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
930 case USB_ENDPOINT_XFER_ISOC:
932 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
935 * USB Specification 2.0 Section 5.9.2 states that: "If
936 * there is only a single transaction in the microframe,
937 * only a DATA0 data packet PID is used. If there are
938 * two transactions per microframe, DATA1 is used for
939 * the first transaction data packet and DATA0 is used
940 * for the second transaction data packet. If there are
941 * three transactions per microframe, DATA2 is used for
942 * the first transaction data packet, DATA1 is used for
943 * the second, and DATA0 is used for the third."
945 * IOW, we should satisfy the following cases:
947 * 1) length <= maxpacket
950 * 2) maxpacket < length <= (2 * maxpacket)
953 * 3) (2 * maxpacket) < length <= (3 * maxpacket)
954 * - DATA2, DATA1, DATA0
956 if (speed == USB_SPEED_HIGH) {
957 struct usb_ep *ep = &dep->endpoint;
958 unsigned int mult = 2;
959 unsigned int maxp = usb_endpoint_maxp(ep->desc);
961 if (length <= (2 * maxp))
967 trb->size |= DWC3_TRB_SIZE_PCM1(mult);
970 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
973 /* always enable Interrupt on Missed ISOC */
974 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
977 case USB_ENDPOINT_XFER_BULK:
978 case USB_ENDPOINT_XFER_INT:
979 trb->ctrl = DWC3_TRBCTL_NORMAL;
983 * This is only possible with faulty memory because we
984 * checked it already :)
986 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
987 usb_endpoint_type(dep->endpoint.desc));
991 * Enable Continue on Short Packet
992 * when endpoint is not a stream capable
994 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
995 if (!dep->stream_capable)
996 trb->ctrl |= DWC3_TRB_CTRL_CSP;
999 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
1002 if ((!no_interrupt && !chain) ||
1003 (dwc3_calc_trbs_left(dep) == 1))
1004 trb->ctrl |= DWC3_TRB_CTRL_IOC;
1007 trb->ctrl |= DWC3_TRB_CTRL_CHN;
1009 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
1010 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(stream_id);
1012 trb->ctrl |= DWC3_TRB_CTRL_HWO;
1014 dwc3_ep_inc_enq(dep);
1016 trace_dwc3_prepare_trb(dep, trb);
1020 * dwc3_prepare_one_trb - setup one TRB from one request
1021 * @dep: endpoint for which this request is prepared
1022 * @req: dwc3_request pointer
1023 * @chain: should this TRB be chained to the next?
1024 * @node: only for isochronous endpoints. First TRB needs different type.
1026 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
1027 struct dwc3_request *req, unsigned chain, unsigned node)
1029 struct dwc3_trb *trb;
1030 unsigned int length;
1032 unsigned stream_id = req->request.stream_id;
1033 unsigned short_not_ok = req->request.short_not_ok;
1034 unsigned no_interrupt = req->request.no_interrupt;
1036 if (req->request.num_sgs > 0) {
1037 length = sg_dma_len(req->start_sg);
1038 dma = sg_dma_address(req->start_sg);
1040 length = req->request.length;
1041 dma = req->request.dma;
1044 trb = &dep->trb_pool[dep->trb_enqueue];
1047 dwc3_gadget_move_started_request(req);
1049 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
1054 __dwc3_prepare_one_trb(dep, trb, dma, length, chain, node,
1055 stream_id, short_not_ok, no_interrupt);
1058 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
1059 struct dwc3_request *req)
1061 struct scatterlist *sg = req->start_sg;
1062 struct scatterlist *s;
1065 unsigned int remaining = req->request.num_mapped_sgs
1066 - req->num_queued_sgs;
1068 for_each_sg(sg, s, remaining, i) {
1069 unsigned int length = req->request.length;
1070 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1071 unsigned int rem = length % maxp;
1072 unsigned chain = true;
1075 * IOMMU driver is coalescing the list of sgs which shares a
1076 * page boundary into one and giving it to USB driver. With
1077 * this the number of sgs mapped is not equal to the number of
1078 * sgs passed. So mark the chain bit to false if it isthe last
1081 if (i == remaining - 1)
1084 if (rem && usb_endpoint_dir_out(dep->endpoint.desc) && !chain) {
1085 struct dwc3 *dwc = dep->dwc;
1086 struct dwc3_trb *trb;
1088 req->needs_extra_trb = true;
1090 /* prepare normal TRB */
1091 dwc3_prepare_one_trb(dep, req, true, i);
1093 /* Now prepare one extra TRB to align transfer size */
1094 trb = &dep->trb_pool[dep->trb_enqueue];
1096 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr,
1097 maxp - rem, false, 1,
1098 req->request.stream_id,
1099 req->request.short_not_ok,
1100 req->request.no_interrupt);
1102 dwc3_prepare_one_trb(dep, req, chain, i);
1106 * There can be a situation where all sgs in sglist are not
1107 * queued because of insufficient trb number. To handle this
1108 * case, update start_sg to next sg to be queued, so that
1109 * we have free trbs we can continue queuing from where we
1110 * previously stopped
1113 req->start_sg = sg_next(s);
1115 req->num_queued_sgs++;
1117 if (!dwc3_calc_trbs_left(dep))
1122 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
1123 struct dwc3_request *req)
1125 unsigned int length = req->request.length;
1126 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1127 unsigned int rem = length % maxp;
1129 if ((!length || rem) && usb_endpoint_dir_out(dep->endpoint.desc)) {
1130 struct dwc3 *dwc = dep->dwc;
1131 struct dwc3_trb *trb;
1133 req->needs_extra_trb = true;
1135 /* prepare normal TRB */
1136 dwc3_prepare_one_trb(dep, req, true, 0);
1138 /* Now prepare one extra TRB to align transfer size */
1139 trb = &dep->trb_pool[dep->trb_enqueue];
1141 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, maxp - rem,
1142 false, 1, req->request.stream_id,
1143 req->request.short_not_ok,
1144 req->request.no_interrupt);
1145 } else if (req->request.zero && req->request.length &&
1146 (IS_ALIGNED(req->request.length, maxp))) {
1147 struct dwc3 *dwc = dep->dwc;
1148 struct dwc3_trb *trb;
1150 req->needs_extra_trb = true;
1152 /* prepare normal TRB */
1153 dwc3_prepare_one_trb(dep, req, true, 0);
1155 /* Now prepare one extra TRB to handle ZLP */
1156 trb = &dep->trb_pool[dep->trb_enqueue];
1158 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, 0,
1159 false, 1, req->request.stream_id,
1160 req->request.short_not_ok,
1161 req->request.no_interrupt);
1163 dwc3_prepare_one_trb(dep, req, false, 0);
1168 * dwc3_prepare_trbs - setup TRBs from requests
1169 * @dep: endpoint for which requests are being prepared
1171 * The function goes through the requests list and sets up TRBs for the
1172 * transfers. The function returns once there are no more TRBs available or
1173 * it runs out of requests.
1175 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
1177 struct dwc3_request *req, *n;
1179 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1182 * We can get in a situation where there's a request in the started list
1183 * but there weren't enough TRBs to fully kick it in the first time
1184 * around, so it has been waiting for more TRBs to be freed up.
1186 * In that case, we should check if we have a request with pending_sgs
1187 * in the started list and prepare TRBs for that request first,
1188 * otherwise we will prepare TRBs completely out of order and that will
1191 list_for_each_entry(req, &dep->started_list, list) {
1192 if (req->num_pending_sgs > 0)
1193 dwc3_prepare_one_trb_sg(dep, req);
1195 if (!dwc3_calc_trbs_left(dep))
1199 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1200 struct dwc3 *dwc = dep->dwc;
1203 ret = usb_gadget_map_request_by_dev(dwc->sysdev, &req->request,
1208 req->sg = req->request.sg;
1209 req->start_sg = req->sg;
1210 req->num_queued_sgs = 0;
1211 req->num_pending_sgs = req->request.num_mapped_sgs;
1213 if (req->num_pending_sgs > 0)
1214 dwc3_prepare_one_trb_sg(dep, req);
1216 dwc3_prepare_one_trb_linear(dep, req);
1218 if (!dwc3_calc_trbs_left(dep))
1223 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep)
1225 struct dwc3_gadget_ep_cmd_params params;
1226 struct dwc3_request *req;
1231 if (!dwc3_calc_trbs_left(dep))
1234 starting = !(dep->flags & DWC3_EP_TRANSFER_STARTED);
1236 dwc3_prepare_trbs(dep);
1237 req = next_request(&dep->started_list);
1239 dep->flags |= DWC3_EP_PENDING_REQUEST;
1243 memset(¶ms, 0, sizeof(params));
1246 params.param0 = upper_32_bits(req->trb_dma);
1247 params.param1 = lower_32_bits(req->trb_dma);
1248 cmd = DWC3_DEPCMD_STARTTRANSFER;
1250 if (dep->stream_capable)
1251 cmd |= DWC3_DEPCMD_PARAM(req->request.stream_id);
1253 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1254 cmd |= DWC3_DEPCMD_PARAM(dep->frame_number);
1256 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1257 DWC3_DEPCMD_PARAM(dep->resource_index);
1260 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1263 * FIXME we need to iterate over the list of requests
1264 * here and stop, unmap, free and del each of the linked
1265 * requests instead of what we do now.
1268 memset(req->trb, 0, sizeof(struct dwc3_trb));
1269 dwc3_gadget_del_and_unmap_request(dep, req, ret);
1276 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1280 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1281 return DWC3_DSTS_SOFFN(reg);
1285 * dwc3_gadget_start_isoc_quirk - workaround invalid frame number
1286 * @dep: isoc endpoint
1288 * This function tests for the correct combination of BIT[15:14] from the 16-bit
1289 * microframe number reported by the XferNotReady event for the future frame
1290 * number to start the isoc transfer.
1292 * In DWC_usb31 version 1.70a-ea06 and prior, for highspeed and fullspeed
1293 * isochronous IN, BIT[15:14] of the 16-bit microframe number reported by the
1294 * XferNotReady event are invalid. The driver uses this number to schedule the
1295 * isochronous transfer and passes it to the START TRANSFER command. Because
1296 * this number is invalid, the command may fail. If BIT[15:14] matches the
1297 * internal 16-bit microframe, the START TRANSFER command will pass and the
1298 * transfer will start at the scheduled time, if it is off by 1, the command
1299 * will still pass, but the transfer will start 2 seconds in the future. For all
1300 * other conditions, the START TRANSFER command will fail with bus-expiry.
1302 * In order to workaround this issue, we can test for the correct combination of
1303 * BIT[15:14] by sending START TRANSFER commands with different values of
1304 * BIT[15:14]: 'b00, 'b01, 'b10, and 'b11. Each combination is 2^14 uframe apart
1305 * (or 2 seconds). 4 seconds into the future will result in a bus-expiry status.
1306 * As the result, within the 4 possible combinations for BIT[15:14], there will
1307 * be 2 successful and 2 failure START COMMAND status. One of the 2 successful
1308 * command status will result in a 2-second delay start. The smaller BIT[15:14]
1309 * value is the correct combination.
1311 * Since there are only 4 outcomes and the results are ordered, we can simply
1312 * test 2 START TRANSFER commands with BIT[15:14] combinations 'b00 and 'b01 to
1313 * deduce the smaller successful combination.
1315 * Let test0 = test status for combination 'b00 and test1 = test status for 'b01
1316 * of BIT[15:14]. The correct combination is as follow:
1318 * if test0 fails and test1 passes, BIT[15:14] is 'b01
1319 * if test0 fails and test1 fails, BIT[15:14] is 'b10
1320 * if test0 passes and test1 fails, BIT[15:14] is 'b11
1321 * if test0 passes and test1 passes, BIT[15:14] is 'b00
1323 * Synopsys STAR 9001202023: Wrong microframe number for isochronous IN
1326 static int dwc3_gadget_start_isoc_quirk(struct dwc3_ep *dep)
1332 while (dep->combo_num < 2) {
1333 struct dwc3_gadget_ep_cmd_params params;
1334 u32 test_frame_number;
1338 * Check if we can start isoc transfer on the next interval or
1339 * 4 uframes in the future with BIT[15:14] as dep->combo_num
1341 test_frame_number = dep->frame_number & 0x3fff;
1342 test_frame_number |= dep->combo_num << 14;
1343 test_frame_number += max_t(u32, 4, dep->interval);
1345 params.param0 = upper_32_bits(dep->dwc->bounce_addr);
1346 params.param1 = lower_32_bits(dep->dwc->bounce_addr);
1348 cmd = DWC3_DEPCMD_STARTTRANSFER;
1349 cmd |= DWC3_DEPCMD_PARAM(test_frame_number);
1350 cmd_status = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1352 /* Redo if some other failure beside bus-expiry is received */
1353 if (cmd_status && cmd_status != -EAGAIN) {
1354 dep->start_cmd_status = 0;
1359 /* Store the first test status */
1360 if (dep->combo_num == 0)
1361 dep->start_cmd_status = cmd_status;
1366 * End the transfer if the START_TRANSFER command is successful
1367 * to wait for the next XferNotReady to test the command again
1369 if (cmd_status == 0) {
1370 dwc3_stop_active_transfer(dep, true, true);
1375 /* test0 and test1 are both completed at this point */
1376 test0 = (dep->start_cmd_status == 0);
1377 test1 = (cmd_status == 0);
1379 if (!test0 && test1)
1381 else if (!test0 && !test1)
1383 else if (test0 && !test1)
1385 else if (test0 && test1)
1388 dep->frame_number &= 0x3fff;
1389 dep->frame_number |= dep->combo_num << 14;
1390 dep->frame_number += max_t(u32, 4, dep->interval);
1392 /* Reinitialize test variables */
1393 dep->start_cmd_status = 0;
1396 return __dwc3_gadget_kick_transfer(dep);
1399 static int __dwc3_gadget_start_isoc(struct dwc3_ep *dep)
1401 struct dwc3 *dwc = dep->dwc;
1405 if (list_empty(&dep->pending_list)) {
1406 dep->flags |= DWC3_EP_PENDING_REQUEST;
1410 if (!dwc->dis_start_transfer_quirk && dwc3_is_usb31(dwc) &&
1411 (dwc->revision <= DWC3_USB31_REVISION_160A ||
1412 (dwc->revision == DWC3_USB31_REVISION_170A &&
1413 dwc->version_type >= DWC31_VERSIONTYPE_EA01 &&
1414 dwc->version_type <= DWC31_VERSIONTYPE_EA06))) {
1416 if (dwc->gadget.speed <= USB_SPEED_HIGH && dep->direction)
1417 return dwc3_gadget_start_isoc_quirk(dep);
1420 for (i = 0; i < DWC3_ISOC_MAX_RETRIES; i++) {
1421 dep->frame_number = DWC3_ALIGN_FRAME(dep, i + 1);
1423 ret = __dwc3_gadget_kick_transfer(dep);
1431 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1433 struct dwc3 *dwc = dep->dwc;
1435 if (!dep->endpoint.desc) {
1436 dev_err(dwc->dev, "%s: can't queue to disabled endpoint\n",
1441 if (WARN(req->dep != dep, "request %pK belongs to '%s'\n",
1442 &req->request, req->dep->name))
1445 if (WARN(req->status < DWC3_REQUEST_STATUS_COMPLETED,
1446 "%s: request %pK already in flight\n",
1447 dep->name, &req->request))
1450 pm_runtime_get(dwc->dev);
1452 req->request.actual = 0;
1453 req->request.status = -EINPROGRESS;
1455 trace_dwc3_ep_queue(req);
1457 list_add_tail(&req->list, &dep->pending_list);
1458 req->status = DWC3_REQUEST_STATUS_QUEUED;
1460 /* Start the transfer only after the END_TRANSFER is completed */
1461 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING) {
1462 dep->flags |= DWC3_EP_DELAY_START;
1467 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1468 * wait for a XferNotReady event so we will know what's the current
1469 * (micro-)frame number.
1471 * Without this trick, we are very, very likely gonna get Bus Expiry
1472 * errors which will force us issue EndTransfer command.
1474 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1475 if (!(dep->flags & DWC3_EP_PENDING_REQUEST) &&
1476 !(dep->flags & DWC3_EP_TRANSFER_STARTED))
1479 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1480 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED)) {
1481 return __dwc3_gadget_start_isoc(dep);
1486 return __dwc3_gadget_kick_transfer(dep);
1489 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1492 struct dwc3_request *req = to_dwc3_request(request);
1493 struct dwc3_ep *dep = to_dwc3_ep(ep);
1494 struct dwc3 *dwc = dep->dwc;
1496 unsigned long flags;
1500 spin_lock_irqsave(&dwc->lock, flags);
1501 ret = __dwc3_gadget_ep_queue(dep, req);
1502 spin_unlock_irqrestore(&dwc->lock, flags);
1507 static void dwc3_gadget_ep_skip_trbs(struct dwc3_ep *dep, struct dwc3_request *req)
1511 /* If req->trb is not set, then the request has not started */
1516 * If request was already started, this means we had to
1517 * stop the transfer. With that we also need to ignore
1518 * all TRBs used by the request, however TRBs can only
1519 * be modified after completion of END_TRANSFER
1520 * command. So what we do here is that we wait for
1521 * END_TRANSFER completion and only after that, we jump
1522 * over TRBs by clearing HWO and incrementing dequeue
1525 for (i = 0; i < req->num_trbs; i++) {
1526 struct dwc3_trb *trb;
1528 trb = &dep->trb_pool[dep->trb_dequeue];
1529 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1530 dwc3_ep_inc_deq(dep);
1536 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep)
1538 struct dwc3_request *req;
1539 struct dwc3_request *tmp;
1541 list_for_each_entry_safe(req, tmp, &dep->cancelled_list, list) {
1542 dwc3_gadget_ep_skip_trbs(dep, req);
1543 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1547 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1548 struct usb_request *request)
1550 struct dwc3_request *req = to_dwc3_request(request);
1551 struct dwc3_request *r = NULL;
1553 struct dwc3_ep *dep = to_dwc3_ep(ep);
1554 struct dwc3 *dwc = dep->dwc;
1556 unsigned long flags;
1559 trace_dwc3_ep_dequeue(req);
1561 spin_lock_irqsave(&dwc->lock, flags);
1563 list_for_each_entry(r, &dep->pending_list, list) {
1569 list_for_each_entry(r, &dep->started_list, list) {
1574 /* wait until it is processed */
1575 dwc3_stop_active_transfer(dep, true, true);
1580 dwc3_gadget_move_cancelled_request(req);
1581 if (dep->flags & DWC3_EP_TRANSFER_STARTED)
1586 dev_err(dwc->dev, "request %pK was not queued to %s\n",
1593 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1596 spin_unlock_irqrestore(&dwc->lock, flags);
1601 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1603 struct dwc3_gadget_ep_cmd_params params;
1604 struct dwc3 *dwc = dep->dwc;
1605 struct dwc3_request *req;
1606 struct dwc3_request *tmp;
1609 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1610 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1614 memset(¶ms, 0x00, sizeof(params));
1617 struct dwc3_trb *trb;
1619 unsigned transfer_in_flight;
1622 if (dep->number > 1)
1623 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1625 trb = &dwc->ep0_trb[dep->trb_enqueue];
1627 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1628 started = !list_empty(&dep->started_list);
1630 if (!protocol && ((dep->direction && transfer_in_flight) ||
1631 (!dep->direction && started))) {
1635 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1638 dev_err(dwc->dev, "failed to set STALL on %s\n",
1641 dep->flags |= DWC3_EP_STALL;
1644 * Don't issue CLEAR_STALL command to control endpoints. The
1645 * controller automatically clears the STALL when it receives
1648 if (dep->number <= 1) {
1649 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1653 ret = dwc3_send_clear_stall_ep_cmd(dep);
1655 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1660 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1662 dwc3_stop_active_transfer(dep, true, true);
1664 list_for_each_entry_safe(req, tmp, &dep->started_list, list)
1665 dwc3_gadget_move_cancelled_request(req);
1667 list_for_each_entry_safe(req, tmp, &dep->pending_list, list)
1668 dwc3_gadget_move_cancelled_request(req);
1670 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING)) {
1671 dep->flags &= ~DWC3_EP_DELAY_START;
1672 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
1679 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1681 struct dwc3_ep *dep = to_dwc3_ep(ep);
1682 struct dwc3 *dwc = dep->dwc;
1684 unsigned long flags;
1688 spin_lock_irqsave(&dwc->lock, flags);
1689 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1690 spin_unlock_irqrestore(&dwc->lock, flags);
1695 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1697 struct dwc3_ep *dep = to_dwc3_ep(ep);
1698 struct dwc3 *dwc = dep->dwc;
1699 unsigned long flags;
1702 spin_lock_irqsave(&dwc->lock, flags);
1703 dep->flags |= DWC3_EP_WEDGE;
1705 if (dep->number == 0 || dep->number == 1)
1706 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1708 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1709 spin_unlock_irqrestore(&dwc->lock, flags);
1714 /* -------------------------------------------------------------------------- */
1716 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1717 .bLength = USB_DT_ENDPOINT_SIZE,
1718 .bDescriptorType = USB_DT_ENDPOINT,
1719 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1722 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1723 .enable = dwc3_gadget_ep0_enable,
1724 .disable = dwc3_gadget_ep0_disable,
1725 .alloc_request = dwc3_gadget_ep_alloc_request,
1726 .free_request = dwc3_gadget_ep_free_request,
1727 .queue = dwc3_gadget_ep0_queue,
1728 .dequeue = dwc3_gadget_ep_dequeue,
1729 .set_halt = dwc3_gadget_ep0_set_halt,
1730 .set_wedge = dwc3_gadget_ep_set_wedge,
1733 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1734 .enable = dwc3_gadget_ep_enable,
1735 .disable = dwc3_gadget_ep_disable,
1736 .alloc_request = dwc3_gadget_ep_alloc_request,
1737 .free_request = dwc3_gadget_ep_free_request,
1738 .queue = dwc3_gadget_ep_queue,
1739 .dequeue = dwc3_gadget_ep_dequeue,
1740 .set_halt = dwc3_gadget_ep_set_halt,
1741 .set_wedge = dwc3_gadget_ep_set_wedge,
1744 /* -------------------------------------------------------------------------- */
1746 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1748 struct dwc3 *dwc = gadget_to_dwc(g);
1750 return __dwc3_gadget_get_frame(dwc);
1753 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1763 * According to the Databook Remote wakeup request should
1764 * be issued only when the device is in early suspend state.
1766 * We can check that via USB Link State bits in DSTS register.
1768 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1770 link_state = DWC3_DSTS_USBLNKST(reg);
1772 switch (link_state) {
1773 case DWC3_LINK_STATE_RESET:
1774 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1775 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1776 case DWC3_LINK_STATE_RESUME:
1782 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1784 dev_err(dwc->dev, "failed to put link in Recovery\n");
1788 /* Recent versions do this automatically */
1789 if (dwc->revision < DWC3_REVISION_194A) {
1790 /* write zeroes to Link Change Request */
1791 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1792 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1793 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1796 /* poll until Link State changes to ON */
1800 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1802 /* in HS, means ON */
1803 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1807 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1808 dev_err(dwc->dev, "failed to send remote wakeup\n");
1815 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1817 struct dwc3 *dwc = gadget_to_dwc(g);
1818 unsigned long flags;
1821 spin_lock_irqsave(&dwc->lock, flags);
1822 ret = __dwc3_gadget_wakeup(dwc);
1823 spin_unlock_irqrestore(&dwc->lock, flags);
1828 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1831 struct dwc3 *dwc = gadget_to_dwc(g);
1832 unsigned long flags;
1834 spin_lock_irqsave(&dwc->lock, flags);
1835 g->is_selfpowered = !!is_selfpowered;
1836 spin_unlock_irqrestore(&dwc->lock, flags);
1841 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1846 if (pm_runtime_suspended(dwc->dev))
1849 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1851 if (dwc->revision <= DWC3_REVISION_187A) {
1852 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1853 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1856 if (dwc->revision >= DWC3_REVISION_194A)
1857 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1858 reg |= DWC3_DCTL_RUN_STOP;
1860 if (dwc->has_hibernation)
1861 reg |= DWC3_DCTL_KEEP_CONNECT;
1863 dwc->pullups_connected = true;
1865 reg &= ~DWC3_DCTL_RUN_STOP;
1867 if (dwc->has_hibernation && !suspend)
1868 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1870 dwc->pullups_connected = false;
1873 dwc3_gadget_dctl_write_safe(dwc, reg);
1876 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1877 reg &= DWC3_DSTS_DEVCTRLHLT;
1878 } while (--timeout && !(!is_on ^ !reg));
1886 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1888 struct dwc3 *dwc = gadget_to_dwc(g);
1889 unsigned long flags;
1895 * Per databook, when we want to stop the gadget, if a control transfer
1896 * is still in process, complete it and get the core into setup phase.
1898 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
1899 reinit_completion(&dwc->ep0_in_setup);
1901 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
1902 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
1904 dev_err(dwc->dev, "timed out waiting for SETUP phase\n");
1909 spin_lock_irqsave(&dwc->lock, flags);
1910 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1911 spin_unlock_irqrestore(&dwc->lock, flags);
1916 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1920 /* Enable all but Start and End of Frame IRQs */
1921 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1922 DWC3_DEVTEN_EVNTOVERFLOWEN |
1923 DWC3_DEVTEN_CMDCMPLTEN |
1924 DWC3_DEVTEN_ERRTICERREN |
1925 DWC3_DEVTEN_WKUPEVTEN |
1926 DWC3_DEVTEN_CONNECTDONEEN |
1927 DWC3_DEVTEN_USBRSTEN |
1928 DWC3_DEVTEN_DISCONNEVTEN);
1930 if (dwc->revision < DWC3_REVISION_250A)
1931 reg |= DWC3_DEVTEN_ULSTCNGEN;
1933 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1936 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1938 /* mask all interrupts */
1939 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1942 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1943 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1946 * dwc3_gadget_setup_nump - calculate and initialize NUMP field of %DWC3_DCFG
1947 * @dwc: pointer to our context structure
1949 * The following looks like complex but it's actually very simple. In order to
1950 * calculate the number of packets we can burst at once on OUT transfers, we're
1951 * gonna use RxFIFO size.
1953 * To calculate RxFIFO size we need two numbers:
1954 * MDWIDTH = size, in bits, of the internal memory bus
1955 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1957 * Given these two numbers, the formula is simple:
1959 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1961 * 24 bytes is for 3x SETUP packets
1962 * 16 bytes is a clock domain crossing tolerance
1964 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1966 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1973 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1974 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1976 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1977 nump = min_t(u32, nump, 16);
1980 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1981 reg &= ~DWC3_DCFG_NUMP_MASK;
1982 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1983 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1986 static int __dwc3_gadget_start(struct dwc3 *dwc)
1988 struct dwc3_ep *dep;
1993 * Use IMOD if enabled via dwc->imod_interval. Otherwise, if
1994 * the core supports IMOD, disable it.
1996 if (dwc->imod_interval) {
1997 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
1998 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
1999 } else if (dwc3_has_imod(dwc)) {
2000 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), 0);
2004 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
2005 * field instead of letting dwc3 itself calculate that automatically.
2007 * This way, we maximize the chances that we'll be able to get several
2008 * bursts of data without going through any sort of endpoint throttling.
2010 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
2011 if (dwc3_is_usb31(dwc))
2012 reg &= ~DWC31_GRXTHRCFG_PKTCNTSEL;
2014 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
2016 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
2018 dwc3_gadget_setup_nump(dwc);
2020 /* Start with SuperSpeed Default */
2021 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2024 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2026 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2031 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2033 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2037 /* begin to receive SETUP packets */
2038 dwc->ep0state = EP0_SETUP_PHASE;
2039 dwc->link_state = DWC3_LINK_STATE_SS_DIS;
2040 dwc3_ep0_out_start(dwc);
2042 dwc3_gadget_enable_irq(dwc);
2047 __dwc3_gadget_ep_disable(dwc->eps[0]);
2053 static int dwc3_gadget_start(struct usb_gadget *g,
2054 struct usb_gadget_driver *driver)
2056 struct dwc3 *dwc = gadget_to_dwc(g);
2057 unsigned long flags;
2061 irq = dwc->irq_gadget;
2062 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
2063 IRQF_SHARED, "dwc3", dwc->ev_buf);
2065 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
2070 spin_lock_irqsave(&dwc->lock, flags);
2071 if (dwc->gadget_driver) {
2072 dev_err(dwc->dev, "%s is already bound to %s\n",
2074 dwc->gadget_driver->driver.name);
2079 dwc->gadget_driver = driver;
2081 if (pm_runtime_active(dwc->dev))
2082 __dwc3_gadget_start(dwc);
2084 spin_unlock_irqrestore(&dwc->lock, flags);
2089 spin_unlock_irqrestore(&dwc->lock, flags);
2096 static void __dwc3_gadget_stop(struct dwc3 *dwc)
2098 dwc3_gadget_disable_irq(dwc);
2099 __dwc3_gadget_ep_disable(dwc->eps[0]);
2100 __dwc3_gadget_ep_disable(dwc->eps[1]);
2103 static int dwc3_gadget_stop(struct usb_gadget *g)
2105 struct dwc3 *dwc = gadget_to_dwc(g);
2106 unsigned long flags;
2108 spin_lock_irqsave(&dwc->lock, flags);
2110 if (pm_runtime_suspended(dwc->dev))
2113 __dwc3_gadget_stop(dwc);
2116 dwc->gadget_driver = NULL;
2117 spin_unlock_irqrestore(&dwc->lock, flags);
2119 free_irq(dwc->irq_gadget, dwc->ev_buf);
2124 static void dwc3_gadget_config_params(struct usb_gadget *g,
2125 struct usb_dcd_config_params *params)
2127 struct dwc3 *dwc = gadget_to_dwc(g);
2129 params->besl_baseline = USB_DEFAULT_BESL_UNSPECIFIED;
2130 params->besl_deep = USB_DEFAULT_BESL_UNSPECIFIED;
2132 /* Recommended BESL */
2133 if (!dwc->dis_enblslpm_quirk) {
2135 * If the recommended BESL baseline is 0 or if the BESL deep is
2136 * less than 2, Microsoft's Windows 10 host usb stack will issue
2137 * a usb reset immediately after it receives the extended BOS
2138 * descriptor and the enumeration will fail. To maintain
2139 * compatibility with the Windows' usb stack, let's set the
2140 * recommended BESL baseline to 1 and clamp the BESL deep to be
2143 params->besl_baseline = 1;
2144 if (dwc->is_utmi_l1_suspend)
2146 clamp_t(u8, dwc->hird_threshold, 2, 15);
2149 /* U1 Device exit Latency */
2150 if (dwc->dis_u1_entry_quirk)
2151 params->bU1devExitLat = 0;
2153 params->bU1devExitLat = DWC3_DEFAULT_U1_DEV_EXIT_LAT;
2155 /* U2 Device exit Latency */
2156 if (dwc->dis_u2_entry_quirk)
2157 params->bU2DevExitLat = 0;
2159 params->bU2DevExitLat =
2160 cpu_to_le16(DWC3_DEFAULT_U2_DEV_EXIT_LAT);
2163 static void dwc3_gadget_set_speed(struct usb_gadget *g,
2164 enum usb_device_speed speed)
2166 struct dwc3 *dwc = gadget_to_dwc(g);
2167 unsigned long flags;
2170 spin_lock_irqsave(&dwc->lock, flags);
2171 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2172 reg &= ~(DWC3_DCFG_SPEED_MASK);
2175 * WORKAROUND: DWC3 revision < 2.20a have an issue
2176 * which would cause metastability state on Run/Stop
2177 * bit if we try to force the IP to USB2-only mode.
2179 * Because of that, we cannot configure the IP to any
2180 * speed other than the SuperSpeed
2184 * STAR#9000525659: Clock Domain Crossing on DCTL in
2187 if (dwc->revision < DWC3_REVISION_220A &&
2188 !dwc->dis_metastability_quirk) {
2189 reg |= DWC3_DCFG_SUPERSPEED;
2193 reg |= DWC3_DCFG_LOWSPEED;
2195 case USB_SPEED_FULL:
2196 reg |= DWC3_DCFG_FULLSPEED;
2198 case USB_SPEED_HIGH:
2199 reg |= DWC3_DCFG_HIGHSPEED;
2201 case USB_SPEED_SUPER:
2202 reg |= DWC3_DCFG_SUPERSPEED;
2204 case USB_SPEED_SUPER_PLUS:
2205 if (dwc3_is_usb31(dwc))
2206 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2208 reg |= DWC3_DCFG_SUPERSPEED;
2211 dev_err(dwc->dev, "invalid speed (%d)\n", speed);
2213 if (dwc->revision & DWC3_REVISION_IS_DWC31)
2214 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2216 reg |= DWC3_DCFG_SUPERSPEED;
2219 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2221 spin_unlock_irqrestore(&dwc->lock, flags);
2224 static const struct usb_gadget_ops dwc3_gadget_ops = {
2225 .get_frame = dwc3_gadget_get_frame,
2226 .wakeup = dwc3_gadget_wakeup,
2227 .set_selfpowered = dwc3_gadget_set_selfpowered,
2228 .pullup = dwc3_gadget_pullup,
2229 .udc_start = dwc3_gadget_start,
2230 .udc_stop = dwc3_gadget_stop,
2231 .udc_set_speed = dwc3_gadget_set_speed,
2232 .get_config_params = dwc3_gadget_config_params,
2235 /* -------------------------------------------------------------------------- */
2237 static int dwc3_gadget_init_control_endpoint(struct dwc3_ep *dep)
2239 struct dwc3 *dwc = dep->dwc;
2241 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
2242 dep->endpoint.maxburst = 1;
2243 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
2244 if (!dep->direction)
2245 dwc->gadget.ep0 = &dep->endpoint;
2247 dep->endpoint.caps.type_control = true;
2252 static int dwc3_gadget_init_in_endpoint(struct dwc3_ep *dep)
2254 struct dwc3 *dwc = dep->dwc;
2258 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
2259 /* MDWIDTH is represented in bits, we need it in bytes */
2262 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1));
2263 if (dwc3_is_usb31(dwc))
2264 size = DWC31_GTXFIFOSIZ_TXFDEP(size);
2266 size = DWC3_GTXFIFOSIZ_TXFDEP(size);
2268 /* FIFO Depth is in MDWDITH bytes. Multiply */
2272 * To meet performance requirement, a minimum TxFIFO size of 3x
2273 * MaxPacketSize is recommended for endpoints that support burst and a
2274 * minimum TxFIFO size of 2x MaxPacketSize for endpoints that don't
2275 * support burst. Use those numbers and we can calculate the max packet
2278 if (dwc->maximum_speed >= USB_SPEED_SUPER)
2283 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2285 dep->endpoint.max_streams = 15;
2286 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2287 list_add_tail(&dep->endpoint.ep_list,
2288 &dwc->gadget.ep_list);
2289 dep->endpoint.caps.type_iso = true;
2290 dep->endpoint.caps.type_bulk = true;
2291 dep->endpoint.caps.type_int = true;
2293 return dwc3_alloc_trb_pool(dep);
2296 static int dwc3_gadget_init_out_endpoint(struct dwc3_ep *dep)
2298 struct dwc3 *dwc = dep->dwc;
2302 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
2304 /* MDWIDTH is represented in bits, convert to bytes */
2307 /* All OUT endpoints share a single RxFIFO space */
2308 size = dwc3_readl(dwc->regs, DWC3_GRXFIFOSIZ(0));
2309 if (dwc3_is_usb31(dwc))
2310 size = DWC31_GRXFIFOSIZ_RXFDEP(size);
2312 size = DWC3_GRXFIFOSIZ_RXFDEP(size);
2314 /* FIFO depth is in MDWDITH bytes */
2318 * To meet performance requirement, a minimum recommended RxFIFO size
2319 * is defined as follow:
2320 * RxFIFO size >= (3 x MaxPacketSize) +
2321 * (3 x 8 bytes setup packets size) + (16 bytes clock crossing margin)
2323 * Then calculate the max packet limit as below.
2325 size -= (3 * 8) + 16;
2331 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2332 dep->endpoint.max_streams = 15;
2333 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2334 list_add_tail(&dep->endpoint.ep_list,
2335 &dwc->gadget.ep_list);
2336 dep->endpoint.caps.type_iso = true;
2337 dep->endpoint.caps.type_bulk = true;
2338 dep->endpoint.caps.type_int = true;
2340 return dwc3_alloc_trb_pool(dep);
2343 static int dwc3_gadget_init_endpoint(struct dwc3 *dwc, u8 epnum)
2345 struct dwc3_ep *dep;
2346 bool direction = epnum & 1;
2348 u8 num = epnum >> 1;
2350 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
2355 dep->number = epnum;
2356 dep->direction = direction;
2357 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
2358 dwc->eps[epnum] = dep;
2360 dep->start_cmd_status = 0;
2362 snprintf(dep->name, sizeof(dep->name), "ep%u%s", num,
2363 direction ? "in" : "out");
2365 dep->endpoint.name = dep->name;
2367 if (!(dep->number > 1)) {
2368 dep->endpoint.desc = &dwc3_gadget_ep0_desc;
2369 dep->endpoint.comp_desc = NULL;
2373 ret = dwc3_gadget_init_control_endpoint(dep);
2375 ret = dwc3_gadget_init_in_endpoint(dep);
2377 ret = dwc3_gadget_init_out_endpoint(dep);
2382 dep->endpoint.caps.dir_in = direction;
2383 dep->endpoint.caps.dir_out = !direction;
2385 INIT_LIST_HEAD(&dep->pending_list);
2386 INIT_LIST_HEAD(&dep->started_list);
2387 INIT_LIST_HEAD(&dep->cancelled_list);
2392 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc, u8 total)
2396 INIT_LIST_HEAD(&dwc->gadget.ep_list);
2398 for (epnum = 0; epnum < total; epnum++) {
2401 ret = dwc3_gadget_init_endpoint(dwc, epnum);
2409 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
2411 struct dwc3_ep *dep;
2414 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2415 dep = dwc->eps[epnum];
2419 * Physical endpoints 0 and 1 are special; they form the
2420 * bi-directional USB endpoint 0.
2422 * For those two physical endpoints, we don't allocate a TRB
2423 * pool nor do we add them the endpoints list. Due to that, we
2424 * shouldn't do these two operations otherwise we would end up
2425 * with all sorts of bugs when removing dwc3.ko.
2427 if (epnum != 0 && epnum != 1) {
2428 dwc3_free_trb_pool(dep);
2429 list_del(&dep->endpoint.ep_list);
2436 /* -------------------------------------------------------------------------- */
2438 static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
2439 struct dwc3_request *req, struct dwc3_trb *trb,
2440 const struct dwc3_event_depevt *event, int status, int chain)
2444 dwc3_ep_inc_deq(dep);
2446 trace_dwc3_complete_trb(dep, trb);
2450 * If we're in the middle of series of chained TRBs and we
2451 * receive a short transfer along the way, DWC3 will skip
2452 * through all TRBs including the last TRB in the chain (the
2453 * where CHN bit is zero. DWC3 will also avoid clearing HWO
2454 * bit and SW has to do it manually.
2456 * We're going to do that here to avoid problems of HW trying
2457 * to use bogus TRBs for transfers.
2459 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
2460 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2463 * For isochronous transfers, the first TRB in a service interval must
2464 * have the Isoc-First type. Track and report its interval frame number.
2466 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2467 (trb->ctrl & DWC3_TRBCTL_ISOCHRONOUS_FIRST)) {
2468 unsigned int frame_number;
2470 frame_number = DWC3_TRB_CTRL_GET_SID_SOFN(trb->ctrl);
2471 frame_number &= ~(dep->interval - 1);
2472 req->request.frame_number = frame_number;
2476 * If we're dealing with unaligned size OUT transfer, we will be left
2477 * with one TRB pending in the ring. We need to manually clear HWO bit
2481 if (req->needs_extra_trb && !(trb->ctrl & DWC3_TRB_CTRL_CHN)) {
2482 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2486 count = trb->size & DWC3_TRB_SIZE_MASK;
2487 req->remaining += count;
2489 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
2492 if (event->status & DEPEVT_STATUS_SHORT && !chain)
2495 if ((trb->ctrl & DWC3_TRB_CTRL_IOC) ||
2496 (trb->ctrl & DWC3_TRB_CTRL_LST))
2502 static int dwc3_gadget_ep_reclaim_trb_sg(struct dwc3_ep *dep,
2503 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2506 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2507 struct scatterlist *sg = req->sg;
2508 struct scatterlist *s;
2509 unsigned int pending = req->num_pending_sgs;
2513 for_each_sg(sg, s, pending, i) {
2514 trb = &dep->trb_pool[dep->trb_dequeue];
2516 if (trb->ctrl & DWC3_TRB_CTRL_HWO)
2519 req->sg = sg_next(s);
2520 req->num_pending_sgs--;
2522 ret = dwc3_gadget_ep_reclaim_completed_trb(dep, req,
2523 trb, event, status, true);
2531 static int dwc3_gadget_ep_reclaim_trb_linear(struct dwc3_ep *dep,
2532 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2535 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2537 return dwc3_gadget_ep_reclaim_completed_trb(dep, req, trb,
2538 event, status, false);
2541 static bool dwc3_gadget_ep_request_completed(struct dwc3_request *req)
2543 return req->num_pending_sgs == 0;
2546 static int dwc3_gadget_ep_cleanup_completed_request(struct dwc3_ep *dep,
2547 const struct dwc3_event_depevt *event,
2548 struct dwc3_request *req, int status)
2552 if (req->num_pending_sgs)
2553 ret = dwc3_gadget_ep_reclaim_trb_sg(dep, req, event,
2556 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2559 if (req->needs_extra_trb) {
2560 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2562 req->needs_extra_trb = false;
2565 req->request.actual = req->request.length - req->remaining;
2567 if (!dwc3_gadget_ep_request_completed(req)) {
2568 __dwc3_gadget_kick_transfer(dep);
2572 dwc3_gadget_giveback(dep, req, status);
2578 static void dwc3_gadget_ep_cleanup_completed_requests(struct dwc3_ep *dep,
2579 const struct dwc3_event_depevt *event, int status)
2581 struct dwc3_request *req;
2582 struct dwc3_request *tmp;
2584 list_for_each_entry_safe(req, tmp, &dep->started_list, list) {
2587 ret = dwc3_gadget_ep_cleanup_completed_request(dep, event,
2594 static void dwc3_gadget_endpoint_frame_from_event(struct dwc3_ep *dep,
2595 const struct dwc3_event_depevt *event)
2597 dep->frame_number = event->parameters;
2600 static void dwc3_gadget_endpoint_transfer_in_progress(struct dwc3_ep *dep,
2601 const struct dwc3_event_depevt *event)
2603 struct dwc3 *dwc = dep->dwc;
2604 unsigned status = 0;
2607 dwc3_gadget_endpoint_frame_from_event(dep, event);
2609 if (event->status & DEPEVT_STATUS_BUSERR)
2610 status = -ECONNRESET;
2612 if (event->status & DEPEVT_STATUS_MISSED_ISOC) {
2615 if (list_empty(&dep->started_list))
2619 dwc3_gadget_ep_cleanup_completed_requests(dep, event, status);
2622 dwc3_stop_active_transfer(dep, true, true);
2625 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2626 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2628 if (dwc->revision < DWC3_REVISION_183A) {
2632 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2635 if (!(dep->flags & DWC3_EP_ENABLED))
2638 if (!list_empty(&dep->started_list))
2642 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2644 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2650 static void dwc3_gadget_endpoint_transfer_not_ready(struct dwc3_ep *dep,
2651 const struct dwc3_event_depevt *event)
2653 dwc3_gadget_endpoint_frame_from_event(dep, event);
2654 (void) __dwc3_gadget_start_isoc(dep);
2657 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2658 const struct dwc3_event_depevt *event)
2660 struct dwc3_ep *dep;
2661 u8 epnum = event->endpoint_number;
2664 dep = dwc->eps[epnum];
2666 if (!(dep->flags & DWC3_EP_ENABLED)) {
2667 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
2670 /* Handle only EPCMDCMPLT when EP disabled */
2671 if (event->endpoint_event != DWC3_DEPEVT_EPCMDCMPLT)
2675 if (epnum == 0 || epnum == 1) {
2676 dwc3_ep0_interrupt(dwc, event);
2680 switch (event->endpoint_event) {
2681 case DWC3_DEPEVT_XFERINPROGRESS:
2682 dwc3_gadget_endpoint_transfer_in_progress(dep, event);
2684 case DWC3_DEPEVT_XFERNOTREADY:
2685 dwc3_gadget_endpoint_transfer_not_ready(dep, event);
2687 case DWC3_DEPEVT_EPCMDCMPLT:
2688 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
2690 if (cmd == DWC3_DEPCMD_ENDTRANSFER) {
2691 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
2692 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
2693 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
2694 if ((dep->flags & DWC3_EP_DELAY_START) &&
2695 !usb_endpoint_xfer_isoc(dep->endpoint.desc))
2696 __dwc3_gadget_kick_transfer(dep);
2698 dep->flags &= ~DWC3_EP_DELAY_START;
2701 case DWC3_DEPEVT_STREAMEVT:
2702 case DWC3_DEPEVT_XFERCOMPLETE:
2703 case DWC3_DEPEVT_RXTXFIFOEVT:
2708 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2710 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2711 spin_unlock(&dwc->lock);
2712 dwc->gadget_driver->disconnect(&dwc->gadget);
2713 spin_lock(&dwc->lock);
2717 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2719 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2720 spin_unlock(&dwc->lock);
2721 dwc->gadget_driver->suspend(&dwc->gadget);
2722 spin_lock(&dwc->lock);
2726 static void dwc3_resume_gadget(struct dwc3 *dwc)
2728 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2729 spin_unlock(&dwc->lock);
2730 dwc->gadget_driver->resume(&dwc->gadget);
2731 spin_lock(&dwc->lock);
2735 static void dwc3_reset_gadget(struct dwc3 *dwc)
2737 if (!dwc->gadget_driver)
2740 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2741 spin_unlock(&dwc->lock);
2742 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2743 spin_lock(&dwc->lock);
2747 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
2750 struct dwc3_gadget_ep_cmd_params params;
2754 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED) ||
2755 (dep->flags & DWC3_EP_END_TRANSFER_PENDING))
2759 * NOTICE: We are violating what the Databook says about the
2760 * EndTransfer command. Ideally we would _always_ wait for the
2761 * EndTransfer Command Completion IRQ, but that's causing too
2762 * much trouble synchronizing between us and gadget driver.
2764 * We have discussed this with the IP Provider and it was
2765 * suggested to giveback all requests here.
2767 * Note also that a similar handling was tested by Synopsys
2768 * (thanks a lot Paul) and nothing bad has come out of it.
2769 * In short, what we're doing is issuing EndTransfer with
2770 * CMDIOC bit set and delay kicking transfer until the
2771 * EndTransfer command had completed.
2773 * As of IP version 3.10a of the DWC_usb3 IP, the controller
2774 * supports a mode to work around the above limitation. The
2775 * software can poll the CMDACT bit in the DEPCMD register
2776 * after issuing a EndTransfer command. This mode is enabled
2777 * by writing GUCTL2[14]. This polling is already done in the
2778 * dwc3_send_gadget_ep_cmd() function so if the mode is
2779 * enabled, the EndTransfer command will have completed upon
2780 * returning from this function.
2782 * This mode is NOT available on the DWC_usb31 IP.
2785 cmd = DWC3_DEPCMD_ENDTRANSFER;
2786 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2787 cmd |= interrupt ? DWC3_DEPCMD_CMDIOC : 0;
2788 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2789 memset(¶ms, 0, sizeof(params));
2790 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2792 dep->resource_index = 0;
2795 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
2797 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
2800 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2804 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2805 struct dwc3_ep *dep;
2808 dep = dwc->eps[epnum];
2812 if (!(dep->flags & DWC3_EP_STALL))
2815 dep->flags &= ~DWC3_EP_STALL;
2817 ret = dwc3_send_clear_stall_ep_cmd(dep);
2822 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2826 dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RX_DET);
2828 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2829 reg &= ~DWC3_DCTL_INITU1ENA;
2830 reg &= ~DWC3_DCTL_INITU2ENA;
2831 dwc3_gadget_dctl_write_safe(dwc, reg);
2833 dwc3_disconnect_gadget(dwc);
2835 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2836 dwc->setup_packet_pending = false;
2837 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2839 dwc->connected = false;
2842 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2846 dwc->connected = true;
2849 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2850 * would cause a missing Disconnect Event if there's a
2851 * pending Setup Packet in the FIFO.
2853 * There's no suggested workaround on the official Bug
2854 * report, which states that "unless the driver/application
2855 * is doing any special handling of a disconnect event,
2856 * there is no functional issue".
2858 * Unfortunately, it turns out that we _do_ some special
2859 * handling of a disconnect event, namely complete all
2860 * pending transfers, notify gadget driver of the
2861 * disconnection, and so on.
2863 * Our suggested workaround is to follow the Disconnect
2864 * Event steps here, instead, based on a setup_packet_pending
2865 * flag. Such flag gets set whenever we have a SETUP_PENDING
2866 * status for EP0 TRBs and gets cleared on XferComplete for the
2871 * STAR#9000466709: RTL: Device : Disconnect event not
2872 * generated if setup packet pending in FIFO
2874 if (dwc->revision < DWC3_REVISION_188A) {
2875 if (dwc->setup_packet_pending)
2876 dwc3_gadget_disconnect_interrupt(dwc);
2879 dwc3_reset_gadget(dwc);
2881 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2882 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2883 dwc3_gadget_dctl_write_safe(dwc, reg);
2884 dwc->test_mode = false;
2885 dwc3_clear_stall_all_ep(dwc);
2887 /* Reset device address to zero */
2888 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2889 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2890 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2893 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2895 struct dwc3_ep *dep;
2900 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2901 speed = reg & DWC3_DSTS_CONNECTSPD;
2905 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2906 * each time on Connect Done.
2908 * Currently we always use the reset value. If any platform
2909 * wants to set this to a different value, we need to add a
2910 * setting and update GCTL.RAMCLKSEL here.
2914 case DWC3_DSTS_SUPERSPEED_PLUS:
2915 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2916 dwc->gadget.ep0->maxpacket = 512;
2917 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2919 case DWC3_DSTS_SUPERSPEED:
2921 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2922 * would cause a missing USB3 Reset event.
2924 * In such situations, we should force a USB3 Reset
2925 * event by calling our dwc3_gadget_reset_interrupt()
2930 * STAR#9000483510: RTL: SS : USB3 reset event may
2931 * not be generated always when the link enters poll
2933 if (dwc->revision < DWC3_REVISION_190A)
2934 dwc3_gadget_reset_interrupt(dwc);
2936 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2937 dwc->gadget.ep0->maxpacket = 512;
2938 dwc->gadget.speed = USB_SPEED_SUPER;
2940 case DWC3_DSTS_HIGHSPEED:
2941 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2942 dwc->gadget.ep0->maxpacket = 64;
2943 dwc->gadget.speed = USB_SPEED_HIGH;
2945 case DWC3_DSTS_FULLSPEED:
2946 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2947 dwc->gadget.ep0->maxpacket = 64;
2948 dwc->gadget.speed = USB_SPEED_FULL;
2950 case DWC3_DSTS_LOWSPEED:
2951 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2952 dwc->gadget.ep0->maxpacket = 8;
2953 dwc->gadget.speed = USB_SPEED_LOW;
2957 dwc->eps[1]->endpoint.maxpacket = dwc->gadget.ep0->maxpacket;
2959 /* Enable USB2 LPM Capability */
2961 if ((dwc->revision > DWC3_REVISION_194A) &&
2962 (speed != DWC3_DSTS_SUPERSPEED) &&
2963 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2964 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2965 reg |= DWC3_DCFG_LPM_CAP;
2966 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2968 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2969 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2971 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold |
2972 (dwc->is_utmi_l1_suspend << 4));
2975 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2976 * DCFG.LPMCap is set, core responses with an ACK and the
2977 * BESL value in the LPM token is less than or equal to LPM
2980 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2981 && dwc->has_lpm_erratum,
2982 "LPM Erratum not available on dwc3 revisions < 2.40a\n");
2984 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2985 reg |= DWC3_DCTL_NYET_THRES(dwc->lpm_nyet_threshold);
2987 dwc3_gadget_dctl_write_safe(dwc, reg);
2989 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2990 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2991 dwc3_gadget_dctl_write_safe(dwc, reg);
2995 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
2997 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3002 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
3004 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3009 * Configure PHY via GUSB3PIPECTLn if required.
3011 * Update GTXFIFOSIZn
3013 * In both cases reset values should be sufficient.
3017 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
3020 * TODO take core out of low power mode when that's
3024 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
3025 spin_unlock(&dwc->lock);
3026 dwc->gadget_driver->resume(&dwc->gadget);
3027 spin_lock(&dwc->lock);
3031 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
3032 unsigned int evtinfo)
3034 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3035 unsigned int pwropt;
3038 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
3039 * Hibernation mode enabled which would show up when device detects
3040 * host-initiated U3 exit.
3042 * In that case, device will generate a Link State Change Interrupt
3043 * from U3 to RESUME which is only necessary if Hibernation is
3046 * There are no functional changes due to such spurious event and we
3047 * just need to ignore it.
3051 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
3054 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
3055 if ((dwc->revision < DWC3_REVISION_250A) &&
3056 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
3057 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
3058 (next == DWC3_LINK_STATE_RESUME)) {
3064 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
3065 * on the link partner, the USB session might do multiple entry/exit
3066 * of low power states before a transfer takes place.
3068 * Due to this problem, we might experience lower throughput. The
3069 * suggested workaround is to disable DCTL[12:9] bits if we're
3070 * transitioning from U1/U2 to U0 and enable those bits again
3071 * after a transfer completes and there are no pending transfers
3072 * on any of the enabled endpoints.
3074 * This is the first half of that workaround.
3078 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
3079 * core send LGO_Ux entering U0
3081 if (dwc->revision < DWC3_REVISION_183A) {
3082 if (next == DWC3_LINK_STATE_U0) {
3086 switch (dwc->link_state) {
3087 case DWC3_LINK_STATE_U1:
3088 case DWC3_LINK_STATE_U2:
3089 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3090 u1u2 = reg & (DWC3_DCTL_INITU2ENA
3091 | DWC3_DCTL_ACCEPTU2ENA
3092 | DWC3_DCTL_INITU1ENA
3093 | DWC3_DCTL_ACCEPTU1ENA);
3096 dwc->u1u2 = reg & u1u2;
3100 dwc3_gadget_dctl_write_safe(dwc, reg);
3110 case DWC3_LINK_STATE_U1:
3111 if (dwc->speed == USB_SPEED_SUPER)
3112 dwc3_suspend_gadget(dwc);
3114 case DWC3_LINK_STATE_U2:
3115 case DWC3_LINK_STATE_U3:
3116 dwc3_suspend_gadget(dwc);
3118 case DWC3_LINK_STATE_RESUME:
3119 dwc3_resume_gadget(dwc);
3126 dwc->link_state = next;
3129 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
3130 unsigned int evtinfo)
3132 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3134 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
3135 dwc3_suspend_gadget(dwc);
3137 dwc->link_state = next;
3140 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
3141 unsigned int evtinfo)
3143 unsigned int is_ss = evtinfo & BIT(4);
3146 * WORKAROUND: DWC3 revison 2.20a with hibernation support
3147 * have a known issue which can cause USB CV TD.9.23 to fail
3150 * Because of this issue, core could generate bogus hibernation
3151 * events which SW needs to ignore.
3155 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
3156 * Device Fallback from SuperSpeed
3158 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
3161 /* enter hibernation here */
3164 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
3165 const struct dwc3_event_devt *event)
3167 switch (event->type) {
3168 case DWC3_DEVICE_EVENT_DISCONNECT:
3169 dwc3_gadget_disconnect_interrupt(dwc);
3171 case DWC3_DEVICE_EVENT_RESET:
3172 dwc3_gadget_reset_interrupt(dwc);
3174 case DWC3_DEVICE_EVENT_CONNECT_DONE:
3175 dwc3_gadget_conndone_interrupt(dwc);
3177 case DWC3_DEVICE_EVENT_WAKEUP:
3178 dwc3_gadget_wakeup_interrupt(dwc);
3180 case DWC3_DEVICE_EVENT_HIBER_REQ:
3181 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
3182 "unexpected hibernation event\n"))
3185 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
3187 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
3188 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
3190 case DWC3_DEVICE_EVENT_EOPF:
3191 /* It changed to be suspend event for version 2.30a and above */
3192 if (dwc->revision >= DWC3_REVISION_230A) {
3194 * Ignore suspend event until the gadget enters into
3195 * USB_STATE_CONFIGURED state.
3197 if (dwc->gadget.state >= USB_STATE_CONFIGURED)
3198 dwc3_gadget_suspend_interrupt(dwc,
3202 case DWC3_DEVICE_EVENT_SOF:
3203 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
3204 case DWC3_DEVICE_EVENT_CMD_CMPL:
3205 case DWC3_DEVICE_EVENT_OVERFLOW:
3208 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
3212 static void dwc3_process_event_entry(struct dwc3 *dwc,
3213 const union dwc3_event *event)
3215 trace_dwc3_event(event->raw, dwc);
3217 if (!event->type.is_devspec)
3218 dwc3_endpoint_interrupt(dwc, &event->depevt);
3219 else if (event->type.type == DWC3_EVENT_TYPE_DEV)
3220 dwc3_gadget_interrupt(dwc, &event->devt);
3222 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
3225 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
3227 struct dwc3 *dwc = evt->dwc;
3228 irqreturn_t ret = IRQ_NONE;
3234 if (!(evt->flags & DWC3_EVENT_PENDING))
3238 union dwc3_event event;
3240 event.raw = *(u32 *) (evt->cache + evt->lpos);
3242 dwc3_process_event_entry(dwc, &event);
3245 * FIXME we wrap around correctly to the next entry as
3246 * almost all entries are 4 bytes in size. There is one
3247 * entry which has 12 bytes which is a regular entry
3248 * followed by 8 bytes data. ATM I don't know how
3249 * things are organized if we get next to the a
3250 * boundary so I worry about that once we try to handle
3253 evt->lpos = (evt->lpos + 4) % evt->length;
3258 evt->flags &= ~DWC3_EVENT_PENDING;
3261 /* Unmask interrupt */
3262 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3263 reg &= ~DWC3_GEVNTSIZ_INTMASK;
3264 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3266 if (dwc->imod_interval) {
3267 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
3268 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
3274 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
3276 struct dwc3_event_buffer *evt = _evt;
3277 struct dwc3 *dwc = evt->dwc;
3278 unsigned long flags;
3279 irqreturn_t ret = IRQ_NONE;
3281 spin_lock_irqsave(&dwc->lock, flags);
3282 ret = dwc3_process_event_buf(evt);
3283 spin_unlock_irqrestore(&dwc->lock, flags);
3288 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
3290 struct dwc3 *dwc = evt->dwc;
3295 if (pm_runtime_suspended(dwc->dev)) {
3296 pm_runtime_get(dwc->dev);
3297 disable_irq_nosync(dwc->irq_gadget);
3298 dwc->pending_events = true;
3303 * With PCIe legacy interrupt, test shows that top-half irq handler can
3304 * be called again after HW interrupt deassertion. Check if bottom-half
3305 * irq event handler completes before caching new event to prevent
3308 if (evt->flags & DWC3_EVENT_PENDING)
3311 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
3312 count &= DWC3_GEVNTCOUNT_MASK;
3317 evt->flags |= DWC3_EVENT_PENDING;
3319 /* Mask interrupt */
3320 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3321 reg |= DWC3_GEVNTSIZ_INTMASK;
3322 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3324 amount = min(count, evt->length - evt->lpos);
3325 memcpy(evt->cache + evt->lpos, evt->buf + evt->lpos, amount);
3328 memcpy(evt->cache, evt->buf, count - amount);
3330 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
3332 return IRQ_WAKE_THREAD;
3335 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
3337 struct dwc3_event_buffer *evt = _evt;
3339 return dwc3_check_event_buf(evt);
3342 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
3344 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
3347 irq = platform_get_irq_byname_optional(dwc3_pdev, "peripheral");
3351 if (irq == -EPROBE_DEFER)
3354 irq = platform_get_irq_byname_optional(dwc3_pdev, "dwc_usb3");
3358 if (irq == -EPROBE_DEFER)
3361 irq = platform_get_irq(dwc3_pdev, 0);
3373 * dwc3_gadget_init - initializes gadget related registers
3374 * @dwc: pointer to our controller context structure
3376 * Returns 0 on success otherwise negative errno.
3378 int dwc3_gadget_init(struct dwc3 *dwc)
3383 irq = dwc3_gadget_get_irq(dwc);
3389 dwc->irq_gadget = irq;
3391 dwc->ep0_trb = dma_alloc_coherent(dwc->sysdev,
3392 sizeof(*dwc->ep0_trb) * 2,
3393 &dwc->ep0_trb_addr, GFP_KERNEL);
3394 if (!dwc->ep0_trb) {
3395 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
3400 dwc->setup_buf = kzalloc(DWC3_EP0_SETUP_SIZE, GFP_KERNEL);
3401 if (!dwc->setup_buf) {
3406 dwc->bounce = dma_alloc_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE,
3407 &dwc->bounce_addr, GFP_KERNEL);
3413 init_completion(&dwc->ep0_in_setup);
3415 dwc->gadget.ops = &dwc3_gadget_ops;
3416 dwc->gadget.speed = USB_SPEED_UNKNOWN;
3417 dwc->gadget.sg_supported = true;
3418 dwc->gadget.name = "dwc3-gadget";
3419 dwc->gadget.lpm_capable = true;
3422 * FIXME We might be setting max_speed to <SUPER, however versions
3423 * <2.20a of dwc3 have an issue with metastability (documented
3424 * elsewhere in this driver) which tells us we can't set max speed to
3425 * anything lower than SUPER.
3427 * Because gadget.max_speed is only used by composite.c and function
3428 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
3429 * to happen so we avoid sending SuperSpeed Capability descriptor
3430 * together with our BOS descriptor as that could confuse host into
3431 * thinking we can handle super speed.
3433 * Note that, in fact, we won't even support GetBOS requests when speed
3434 * is less than super speed because we don't have means, yet, to tell
3435 * composite.c that we are USB 2.0 + LPM ECN.
3437 if (dwc->revision < DWC3_REVISION_220A &&
3438 !dwc->dis_metastability_quirk)
3439 dev_info(dwc->dev, "changing max_speed on rev %08x\n",
3442 dwc->gadget.max_speed = dwc->maximum_speed;
3445 * REVISIT: Here we should clear all pending IRQs to be
3446 * sure we're starting from a well known location.
3449 ret = dwc3_gadget_init_endpoints(dwc, dwc->num_eps);
3453 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
3455 dev_err(dwc->dev, "failed to register udc\n");
3459 dwc3_gadget_set_speed(&dwc->gadget, dwc->maximum_speed);
3464 dwc3_gadget_free_endpoints(dwc);
3467 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3471 kfree(dwc->setup_buf);
3474 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3475 dwc->ep0_trb, dwc->ep0_trb_addr);
3481 /* -------------------------------------------------------------------------- */
3483 void dwc3_gadget_exit(struct dwc3 *dwc)
3485 usb_del_gadget_udc(&dwc->gadget);
3486 dwc3_gadget_free_endpoints(dwc);
3487 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3489 kfree(dwc->setup_buf);
3490 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3491 dwc->ep0_trb, dwc->ep0_trb_addr);
3494 int dwc3_gadget_suspend(struct dwc3 *dwc)
3496 if (!dwc->gadget_driver)
3499 dwc3_gadget_run_stop(dwc, false, false);
3500 dwc3_disconnect_gadget(dwc);
3501 __dwc3_gadget_stop(dwc);
3506 int dwc3_gadget_resume(struct dwc3 *dwc)
3510 if (!dwc->gadget_driver)
3513 ret = __dwc3_gadget_start(dwc);
3517 ret = dwc3_gadget_run_stop(dwc, true, false);
3524 __dwc3_gadget_stop(dwc);
3530 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3532 if (dwc->pending_events) {
3533 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3534 dwc->pending_events = false;
3535 enable_irq(dwc->irq_gadget);