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 - https://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;
51 case USB_TEST_SE0_NAK:
53 case USB_TEST_FORCE_ENABLE:
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 (!DWC3_VER_IS_PRIOR(DWC3, 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 (!DWC3_VER_IS_PRIOR(DWC3, 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 int cmd,
238 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
239 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
242 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
243 if (!(reg & DWC3_DGCMD_CMDACT)) {
244 status = DWC3_DGCMD_STATUS(reg);
256 trace_dwc3_gadget_generic_cmd(cmd, param, status);
261 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
264 * dwc3_send_gadget_ep_cmd - issue an endpoint command
265 * @dep: the endpoint to which the command is going to be issued
266 * @cmd: the command to be issued
267 * @params: parameters to the command
269 * Caller should handle locking. This function will issue @cmd with given
270 * @params to @dep and wait for its completion.
272 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
273 struct dwc3_gadget_ep_cmd_params *params)
275 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
276 struct dwc3 *dwc = dep->dwc;
278 u32 saved_config = 0;
285 * When operating in USB 2.0 speeds (HS/FS), if GUSB2PHYCFG.ENBLSLPM or
286 * GUSB2PHYCFG.SUSPHY is set, it must be cleared before issuing an
289 * Save and clear both GUSB2PHYCFG.ENBLSLPM and GUSB2PHYCFG.SUSPHY
290 * settings. Restore them after the command is completed.
292 * DWC_usb3 3.30a and DWC_usb31 1.90a programming guide section 3.2.2
294 if (dwc->gadget->speed <= USB_SPEED_HIGH) {
295 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
296 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
297 saved_config |= DWC3_GUSB2PHYCFG_SUSPHY;
298 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
301 if (reg & DWC3_GUSB2PHYCFG_ENBLSLPM) {
302 saved_config |= DWC3_GUSB2PHYCFG_ENBLSLPM;
303 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
307 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
310 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
313 link_state = dwc3_gadget_get_link_state(dwc);
314 if (link_state == DWC3_LINK_STATE_U1 ||
315 link_state == DWC3_LINK_STATE_U2 ||
316 link_state == DWC3_LINK_STATE_U3) {
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:
359 dev_WARN(dwc->dev, "No resource for %s\n",
363 case DEPEVT_TRANSFER_BUS_EXPIRY:
365 * SW issues START TRANSFER command to
366 * isochronous ep with future frame interval. If
367 * future interval time has already passed when
368 * core receives the command, it will respond
369 * with an error status of 'Bus Expiry'.
371 * Instead of always returning -EINVAL, let's
372 * give a hint to the gadget driver that this is
373 * the case by returning -EAGAIN.
378 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
387 cmd_status = -ETIMEDOUT;
390 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
392 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
394 dep->flags |= DWC3_EP_TRANSFER_STARTED;
396 if (ret != -ETIMEDOUT)
397 dwc3_gadget_ep_get_transfer_index(dep);
401 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
403 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
409 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
411 struct dwc3 *dwc = dep->dwc;
412 struct dwc3_gadget_ep_cmd_params params;
413 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
416 * As of core revision 2.60a the recommended programming model
417 * is to set the ClearPendIN bit when issuing a Clear Stall EP
418 * command for IN endpoints. This is to prevent an issue where
419 * some (non-compliant) hosts may not send ACK TPs for pending
420 * IN transfers due to a mishandled error condition. Synopsys
423 if (dep->direction &&
424 !DWC3_VER_IS_PRIOR(DWC3, 260A) &&
425 (dwc->gadget->speed >= USB_SPEED_SUPER))
426 cmd |= DWC3_DEPCMD_CLEARPENDIN;
428 memset(¶ms, 0, sizeof(params));
430 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
433 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
434 struct dwc3_trb *trb)
436 u32 offset = (char *) trb - (char *) dep->trb_pool;
438 return dep->trb_pool_dma + offset;
441 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
443 struct dwc3 *dwc = dep->dwc;
448 dep->trb_pool = dma_alloc_coherent(dwc->sysdev,
449 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
450 &dep->trb_pool_dma, GFP_KERNEL);
451 if (!dep->trb_pool) {
452 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
460 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
462 struct dwc3 *dwc = dep->dwc;
464 dma_free_coherent(dwc->sysdev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
465 dep->trb_pool, dep->trb_pool_dma);
467 dep->trb_pool = NULL;
468 dep->trb_pool_dma = 0;
471 static int dwc3_gadget_set_xfer_resource(struct dwc3_ep *dep)
473 struct dwc3_gadget_ep_cmd_params params;
475 memset(¶ms, 0x00, sizeof(params));
477 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
479 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
484 * dwc3_gadget_start_config - configure ep resources
485 * @dep: endpoint that is being enabled
487 * Issue a %DWC3_DEPCMD_DEPSTARTCFG command to @dep. After the command's
488 * completion, it will set Transfer Resource for all available endpoints.
490 * The assignment of transfer resources cannot perfectly follow the data book
491 * due to the fact that the controller driver does not have all knowledge of the
492 * configuration in advance. It is given this information piecemeal by the
493 * composite gadget framework after every SET_CONFIGURATION and
494 * SET_INTERFACE. Trying to follow the databook programming model in this
495 * scenario can cause errors. For two reasons:
497 * 1) The databook says to do %DWC3_DEPCMD_DEPSTARTCFG for every
498 * %USB_REQ_SET_CONFIGURATION and %USB_REQ_SET_INTERFACE (8.1.5). This is
499 * incorrect in the scenario of multiple interfaces.
501 * 2) The databook does not mention doing more %DWC3_DEPCMD_DEPXFERCFG for new
502 * endpoint on alt setting (8.1.6).
504 * The following simplified method is used instead:
506 * All hardware endpoints can be assigned a transfer resource and this setting
507 * will stay persistent until either a core reset or hibernation. So whenever we
508 * do a %DWC3_DEPCMD_DEPSTARTCFG(0) we can go ahead and do
509 * %DWC3_DEPCMD_DEPXFERCFG for every hardware endpoint as well. We are
510 * guaranteed that there are as many transfer resources as endpoints.
512 * This function is called for each endpoint when it is being enabled but is
513 * triggered only when called for EP0-out, which always happens first, and which
514 * should only happen in one of the above conditions.
516 static int dwc3_gadget_start_config(struct dwc3_ep *dep)
518 struct dwc3_gadget_ep_cmd_params params;
527 memset(¶ms, 0x00, sizeof(params));
528 cmd = DWC3_DEPCMD_DEPSTARTCFG;
531 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
535 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
536 struct dwc3_ep *dep = dwc->eps[i];
541 ret = dwc3_gadget_set_xfer_resource(dep);
549 static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
551 const struct usb_ss_ep_comp_descriptor *comp_desc;
552 const struct usb_endpoint_descriptor *desc;
553 struct dwc3_gadget_ep_cmd_params params;
554 struct dwc3 *dwc = dep->dwc;
556 comp_desc = dep->endpoint.comp_desc;
557 desc = dep->endpoint.desc;
559 memset(¶ms, 0x00, sizeof(params));
561 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
562 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
564 /* Burst size is only needed in SuperSpeed mode */
565 if (dwc->gadget->speed >= USB_SPEED_SUPER) {
566 u32 burst = dep->endpoint.maxburst;
568 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
571 params.param0 |= action;
572 if (action == DWC3_DEPCFG_ACTION_RESTORE)
573 params.param2 |= dep->saved_state;
575 if (usb_endpoint_xfer_control(desc))
576 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
578 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
579 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
581 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
582 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
583 | DWC3_DEPCFG_XFER_COMPLETE_EN
584 | DWC3_DEPCFG_STREAM_EVENT_EN;
585 dep->stream_capable = true;
588 if (!usb_endpoint_xfer_control(desc))
589 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
592 * We are doing 1:1 mapping for endpoints, meaning
593 * Physical Endpoints 2 maps to Logical Endpoint 2 and
594 * so on. We consider the direction bit as part of the physical
595 * endpoint number. So USB endpoint 0x81 is 0x03.
597 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
600 * We must use the lower 16 TX FIFOs even though
604 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
606 if (desc->bInterval) {
610 * Valid range for DEPCFG.bInterval_m1 is from 0 to 13.
612 * NOTE: The programming guide incorrectly stated bInterval_m1
613 * must be set to 0 when operating in fullspeed. Internally the
614 * controller does not have this limitation. See DWC_usb3x
615 * programming guide section 3.2.2.1.
617 bInterval_m1 = min_t(u8, desc->bInterval - 1, 13);
619 if (usb_endpoint_type(desc) == USB_ENDPOINT_XFER_INT &&
620 dwc->gadget->speed == USB_SPEED_FULL)
621 dep->interval = desc->bInterval;
623 dep->interval = 1 << (desc->bInterval - 1);
625 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(bInterval_m1);
628 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
631 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
635 * __dwc3_gadget_ep_enable - initializes a hw endpoint
636 * @dep: endpoint to be initialized
637 * @action: one of INIT, MODIFY or RESTORE
639 * Caller should take care of locking. Execute all necessary commands to
640 * initialize a HW endpoint so it can be used by a gadget driver.
642 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep, unsigned int action)
644 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
645 struct dwc3 *dwc = dep->dwc;
650 if (!(dep->flags & DWC3_EP_ENABLED)) {
651 ret = dwc3_gadget_start_config(dep);
656 ret = dwc3_gadget_set_ep_config(dep, action);
660 if (!(dep->flags & DWC3_EP_ENABLED)) {
661 struct dwc3_trb *trb_st_hw;
662 struct dwc3_trb *trb_link;
664 dep->type = usb_endpoint_type(desc);
665 dep->flags |= DWC3_EP_ENABLED;
667 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
668 reg |= DWC3_DALEPENA_EP(dep->number);
669 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
671 if (usb_endpoint_xfer_control(desc))
674 /* Initialize the TRB ring */
675 dep->trb_dequeue = 0;
676 dep->trb_enqueue = 0;
677 memset(dep->trb_pool, 0,
678 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
680 /* Link TRB. The HWO bit is never reset */
681 trb_st_hw = &dep->trb_pool[0];
683 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
684 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
685 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
686 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
687 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
691 * Issue StartTransfer here with no-op TRB so we can always rely on No
692 * Response Update Transfer command.
694 if (usb_endpoint_xfer_bulk(desc) ||
695 usb_endpoint_xfer_int(desc)) {
696 struct dwc3_gadget_ep_cmd_params params;
697 struct dwc3_trb *trb;
701 memset(¶ms, 0, sizeof(params));
702 trb = &dep->trb_pool[0];
703 trb_dma = dwc3_trb_dma_offset(dep, trb);
705 params.param0 = upper_32_bits(trb_dma);
706 params.param1 = lower_32_bits(trb_dma);
708 cmd = DWC3_DEPCMD_STARTTRANSFER;
710 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
714 if (dep->stream_capable) {
716 * For streams, at start, there maybe a race where the
717 * host primes the endpoint before the function driver
718 * queues a request to initiate a stream. In that case,
719 * the controller will not see the prime to generate the
720 * ERDY and start stream. To workaround this, issue a
721 * no-op TRB as normal, but end it immediately. As a
722 * result, when the function driver queues the request,
723 * the next START_TRANSFER command will cause the
724 * controller to generate an ERDY to initiate the
727 dwc3_stop_active_transfer(dep, true, true);
730 * All stream eps will reinitiate stream on NoStream
731 * rejection until we can determine that the host can
732 * prime after the first transfer.
734 * However, if the controller is capable of
735 * TXF_FLUSH_BYPASS, then IN direction endpoints will
736 * automatically restart the stream without the driver
739 if (!dep->direction ||
740 !(dwc->hwparams.hwparams9 &
741 DWC3_GHWPARAMS9_DEV_TXF_FLUSH_BYPASS))
742 dep->flags |= DWC3_EP_FORCE_RESTART_STREAM;
747 trace_dwc3_gadget_ep_enable(dep);
752 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
754 struct dwc3_request *req;
756 dwc3_stop_active_transfer(dep, true, false);
758 /* - giveback all requests to gadget driver */
759 while (!list_empty(&dep->started_list)) {
760 req = next_request(&dep->started_list);
762 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
765 while (!list_empty(&dep->pending_list)) {
766 req = next_request(&dep->pending_list);
768 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
771 while (!list_empty(&dep->cancelled_list)) {
772 req = next_request(&dep->cancelled_list);
774 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
779 * __dwc3_gadget_ep_disable - disables a hw endpoint
780 * @dep: the endpoint to disable
782 * This function undoes what __dwc3_gadget_ep_enable did and also removes
783 * requests which are currently being processed by the hardware and those which
784 * are not yet scheduled.
786 * Caller should take care of locking.
788 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
790 struct dwc3 *dwc = dep->dwc;
793 trace_dwc3_gadget_ep_disable(dep);
795 /* make sure HW endpoint isn't stalled */
796 if (dep->flags & DWC3_EP_STALL)
797 __dwc3_gadget_ep_set_halt(dep, 0, false);
799 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
800 reg &= ~DWC3_DALEPENA_EP(dep->number);
801 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
803 /* Clear out the ep descriptors for non-ep0 */
804 if (dep->number > 1) {
805 dep->endpoint.comp_desc = NULL;
806 dep->endpoint.desc = NULL;
809 dwc3_remove_requests(dwc, dep);
811 dep->stream_capable = false;
818 /* -------------------------------------------------------------------------- */
820 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
821 const struct usb_endpoint_descriptor *desc)
826 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
831 /* -------------------------------------------------------------------------- */
833 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
834 const struct usb_endpoint_descriptor *desc)
841 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
842 pr_debug("dwc3: invalid parameters\n");
846 if (!desc->wMaxPacketSize) {
847 pr_debug("dwc3: missing wMaxPacketSize\n");
851 dep = to_dwc3_ep(ep);
854 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
855 "%s is already enabled\n",
859 spin_lock_irqsave(&dwc->lock, flags);
860 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
861 spin_unlock_irqrestore(&dwc->lock, flags);
866 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
874 pr_debug("dwc3: invalid parameters\n");
878 dep = to_dwc3_ep(ep);
881 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
882 "%s is already disabled\n",
886 spin_lock_irqsave(&dwc->lock, flags);
887 ret = __dwc3_gadget_ep_disable(dep);
888 spin_unlock_irqrestore(&dwc->lock, flags);
893 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
896 struct dwc3_request *req;
897 struct dwc3_ep *dep = to_dwc3_ep(ep);
899 req = kzalloc(sizeof(*req), gfp_flags);
903 req->direction = dep->direction;
904 req->epnum = dep->number;
906 req->status = DWC3_REQUEST_STATUS_UNKNOWN;
908 trace_dwc3_alloc_request(req);
910 return &req->request;
913 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
914 struct usb_request *request)
916 struct dwc3_request *req = to_dwc3_request(request);
918 trace_dwc3_free_request(req);
923 * dwc3_ep_prev_trb - returns the previous TRB in the ring
924 * @dep: The endpoint with the TRB ring
925 * @index: The index of the current TRB in the ring
927 * Returns the TRB prior to the one pointed to by the index. If the
928 * index is 0, we will wrap backwards, skip the link TRB, and return
929 * the one just before that.
931 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
936 tmp = DWC3_TRB_NUM - 1;
938 return &dep->trb_pool[tmp - 1];
941 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
943 struct dwc3_trb *tmp;
947 * If enqueue & dequeue are equal than it is either full or empty.
949 * One way to know for sure is if the TRB right before us has HWO bit
950 * set or not. If it has, then we're definitely full and can't fit any
951 * more transfers in our ring.
953 if (dep->trb_enqueue == dep->trb_dequeue) {
954 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
955 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
958 return DWC3_TRB_NUM - 1;
961 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
962 trbs_left &= (DWC3_TRB_NUM - 1);
964 if (dep->trb_dequeue < dep->trb_enqueue)
970 static void __dwc3_prepare_one_trb(struct dwc3_ep *dep, struct dwc3_trb *trb,
971 dma_addr_t dma, unsigned int length, unsigned int chain,
972 unsigned int node, unsigned int stream_id,
973 unsigned int short_not_ok, unsigned int no_interrupt,
974 unsigned int is_last, bool must_interrupt)
976 struct dwc3 *dwc = dep->dwc;
977 struct usb_gadget *gadget = dwc->gadget;
978 enum usb_device_speed speed = gadget->speed;
980 trb->size = DWC3_TRB_SIZE_LENGTH(length);
981 trb->bpl = lower_32_bits(dma);
982 trb->bph = upper_32_bits(dma);
984 switch (usb_endpoint_type(dep->endpoint.desc)) {
985 case USB_ENDPOINT_XFER_CONTROL:
986 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
989 case USB_ENDPOINT_XFER_ISOC:
991 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
994 * USB Specification 2.0 Section 5.9.2 states that: "If
995 * there is only a single transaction in the microframe,
996 * only a DATA0 data packet PID is used. If there are
997 * two transactions per microframe, DATA1 is used for
998 * the first transaction data packet and DATA0 is used
999 * for the second transaction data packet. If there are
1000 * three transactions per microframe, DATA2 is used for
1001 * the first transaction data packet, DATA1 is used for
1002 * the second, and DATA0 is used for the third."
1004 * IOW, we should satisfy the following cases:
1006 * 1) length <= maxpacket
1009 * 2) maxpacket < length <= (2 * maxpacket)
1012 * 3) (2 * maxpacket) < length <= (3 * maxpacket)
1013 * - DATA2, DATA1, DATA0
1015 if (speed == USB_SPEED_HIGH) {
1016 struct usb_ep *ep = &dep->endpoint;
1017 unsigned int mult = 2;
1018 unsigned int maxp = usb_endpoint_maxp(ep->desc);
1020 if (length <= (2 * maxp))
1026 trb->size |= DWC3_TRB_SIZE_PCM1(mult);
1029 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
1032 /* always enable Interrupt on Missed ISOC */
1033 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
1036 case USB_ENDPOINT_XFER_BULK:
1037 case USB_ENDPOINT_XFER_INT:
1038 trb->ctrl = DWC3_TRBCTL_NORMAL;
1042 * This is only possible with faulty memory because we
1043 * checked it already :)
1045 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
1046 usb_endpoint_type(dep->endpoint.desc));
1050 * Enable Continue on Short Packet
1051 * when endpoint is not a stream capable
1053 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
1054 if (!dep->stream_capable)
1055 trb->ctrl |= DWC3_TRB_CTRL_CSP;
1058 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
1061 if ((!no_interrupt && !chain) || must_interrupt)
1062 trb->ctrl |= DWC3_TRB_CTRL_IOC;
1065 trb->ctrl |= DWC3_TRB_CTRL_CHN;
1066 else if (dep->stream_capable && is_last)
1067 trb->ctrl |= DWC3_TRB_CTRL_LST;
1069 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
1070 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(stream_id);
1072 trb->ctrl |= DWC3_TRB_CTRL_HWO;
1074 dwc3_ep_inc_enq(dep);
1076 trace_dwc3_prepare_trb(dep, trb);
1080 * dwc3_prepare_one_trb - setup one TRB from one request
1081 * @dep: endpoint for which this request is prepared
1082 * @req: dwc3_request pointer
1083 * @trb_length: buffer size of the TRB
1084 * @chain: should this TRB be chained to the next?
1085 * @node: only for isochronous endpoints. First TRB needs different type.
1086 * @use_bounce_buffer: set to use bounce buffer
1087 * @must_interrupt: set to interrupt on TRB completion
1089 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
1090 struct dwc3_request *req, unsigned int trb_length,
1091 unsigned int chain, unsigned int node, bool use_bounce_buffer,
1092 bool must_interrupt)
1094 struct dwc3_trb *trb;
1096 unsigned int stream_id = req->request.stream_id;
1097 unsigned int short_not_ok = req->request.short_not_ok;
1098 unsigned int no_interrupt = req->request.no_interrupt;
1099 unsigned int is_last = req->request.is_last;
1101 if (use_bounce_buffer)
1102 dma = dep->dwc->bounce_addr;
1103 else if (req->request.num_sgs > 0)
1104 dma = sg_dma_address(req->start_sg);
1106 dma = req->request.dma;
1108 trb = &dep->trb_pool[dep->trb_enqueue];
1111 dwc3_gadget_move_started_request(req);
1113 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
1118 __dwc3_prepare_one_trb(dep, trb, dma, trb_length, chain, node,
1119 stream_id, short_not_ok, no_interrupt, is_last,
1123 static bool dwc3_needs_extra_trb(struct dwc3_ep *dep, struct dwc3_request *req)
1125 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1126 unsigned int rem = req->request.length % maxp;
1128 if ((req->request.length && req->request.zero && !rem &&
1129 !usb_endpoint_xfer_isoc(dep->endpoint.desc)) ||
1130 (!req->direction && rem))
1137 * dwc3_prepare_last_sg - prepare TRBs for the last SG entry
1138 * @dep: The endpoint that the request belongs to
1139 * @req: The request to prepare
1140 * @entry_length: The last SG entry size
1141 * @node: Indicates whether this is not the first entry (for isoc only)
1143 * Return the number of TRBs prepared.
1145 static int dwc3_prepare_last_sg(struct dwc3_ep *dep,
1146 struct dwc3_request *req, unsigned int entry_length,
1149 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1150 unsigned int rem = req->request.length % maxp;
1151 unsigned int num_trbs = 1;
1153 if (dwc3_needs_extra_trb(dep, req))
1156 if (dwc3_calc_trbs_left(dep) < num_trbs)
1159 req->needs_extra_trb = num_trbs > 1;
1161 /* Prepare a normal TRB */
1162 if (req->direction || req->request.length)
1163 dwc3_prepare_one_trb(dep, req, entry_length,
1164 req->needs_extra_trb, node, false, false);
1166 /* Prepare extra TRBs for ZLP and MPS OUT transfer alignment */
1167 if ((!req->direction && !req->request.length) || req->needs_extra_trb)
1168 dwc3_prepare_one_trb(dep, req,
1169 req->direction ? 0 : maxp - rem,
1170 false, 1, true, false);
1175 static int dwc3_prepare_trbs_sg(struct dwc3_ep *dep,
1176 struct dwc3_request *req)
1178 struct scatterlist *sg = req->start_sg;
1179 struct scatterlist *s;
1181 unsigned int length = req->request.length;
1182 unsigned int remaining = req->request.num_mapped_sgs
1183 - req->num_queued_sgs;
1184 unsigned int num_trbs = req->num_trbs;
1185 bool needs_extra_trb = dwc3_needs_extra_trb(dep, req);
1188 * If we resume preparing the request, then get the remaining length of
1189 * the request and resume where we left off.
1191 for_each_sg(req->request.sg, s, req->num_queued_sgs, i)
1192 length -= sg_dma_len(s);
1194 for_each_sg(sg, s, remaining, i) {
1195 unsigned int num_trbs_left = dwc3_calc_trbs_left(dep);
1196 unsigned int trb_length;
1197 bool must_interrupt = false;
1198 bool last_sg = false;
1200 trb_length = min_t(unsigned int, length, sg_dma_len(s));
1202 length -= trb_length;
1205 * IOMMU driver is coalescing the list of sgs which shares a
1206 * page boundary into one and giving it to USB driver. With
1207 * this the number of sgs mapped is not equal to the number of
1208 * sgs passed. So mark the chain bit to false if it isthe last
1211 if ((i == remaining - 1) || !length)
1218 if (!dwc3_prepare_last_sg(dep, req, trb_length, i))
1222 * Look ahead to check if we have enough TRBs for the
1223 * next SG entry. If not, set interrupt on this TRB to
1224 * resume preparing the next SG entry when more TRBs are
1227 if (num_trbs_left == 1 || (needs_extra_trb &&
1228 num_trbs_left <= 2 &&
1229 sg_dma_len(sg_next(s)) >= length))
1230 must_interrupt = true;
1232 dwc3_prepare_one_trb(dep, req, trb_length, 1, i, false,
1237 * There can be a situation where all sgs in sglist are not
1238 * queued because of insufficient trb number. To handle this
1239 * case, update start_sg to next sg to be queued, so that
1240 * we have free trbs we can continue queuing from where we
1241 * previously stopped
1244 req->start_sg = sg_next(s);
1246 req->num_queued_sgs++;
1247 req->num_pending_sgs--;
1250 * The number of pending SG entries may not correspond to the
1251 * number of mapped SG entries. If all the data are queued, then
1252 * don't include unused SG entries.
1255 req->num_pending_sgs = 0;
1263 return req->num_trbs - num_trbs;
1266 static int dwc3_prepare_trbs_linear(struct dwc3_ep *dep,
1267 struct dwc3_request *req)
1269 return dwc3_prepare_last_sg(dep, req, req->request.length, 0);
1273 * dwc3_prepare_trbs - setup TRBs from requests
1274 * @dep: endpoint for which requests are being prepared
1276 * The function goes through the requests list and sets up TRBs for the
1277 * transfers. The function returns once there are no more TRBs available or
1278 * it runs out of requests.
1280 * Returns the number of TRBs prepared or negative errno.
1282 static int dwc3_prepare_trbs(struct dwc3_ep *dep)
1284 struct dwc3_request *req, *n;
1287 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1290 * We can get in a situation where there's a request in the started list
1291 * but there weren't enough TRBs to fully kick it in the first time
1292 * around, so it has been waiting for more TRBs to be freed up.
1294 * In that case, we should check if we have a request with pending_sgs
1295 * in the started list and prepare TRBs for that request first,
1296 * otherwise we will prepare TRBs completely out of order and that will
1299 list_for_each_entry(req, &dep->started_list, list) {
1300 if (req->num_pending_sgs > 0) {
1301 ret = dwc3_prepare_trbs_sg(dep, req);
1302 if (!ret || req->num_pending_sgs)
1306 if (!dwc3_calc_trbs_left(dep))
1310 * Don't prepare beyond a transfer. In DWC_usb32, its transfer
1311 * burst capability may try to read and use TRBs beyond the
1312 * active transfer instead of stopping.
1314 if (dep->stream_capable && req->request.is_last)
1318 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1319 struct dwc3 *dwc = dep->dwc;
1321 ret = usb_gadget_map_request_by_dev(dwc->sysdev, &req->request,
1326 req->sg = req->request.sg;
1327 req->start_sg = req->sg;
1328 req->num_queued_sgs = 0;
1329 req->num_pending_sgs = req->request.num_mapped_sgs;
1331 if (req->num_pending_sgs > 0) {
1332 ret = dwc3_prepare_trbs_sg(dep, req);
1333 if (req->num_pending_sgs)
1336 ret = dwc3_prepare_trbs_linear(dep, req);
1339 if (!ret || !dwc3_calc_trbs_left(dep))
1343 * Don't prepare beyond a transfer. In DWC_usb32, its transfer
1344 * burst capability may try to read and use TRBs beyond the
1345 * active transfer instead of stopping.
1347 if (dep->stream_capable && req->request.is_last)
1354 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep);
1356 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep)
1358 struct dwc3_gadget_ep_cmd_params params;
1359 struct dwc3_request *req;
1365 * Note that it's normal to have no new TRBs prepared (i.e. ret == 0).
1366 * This happens when we need to stop and restart a transfer such as in
1367 * the case of reinitiating a stream or retrying an isoc transfer.
1369 ret = dwc3_prepare_trbs(dep);
1373 starting = !(dep->flags & DWC3_EP_TRANSFER_STARTED);
1376 * If there's no new TRB prepared and we don't need to restart a
1377 * transfer, there's no need to update the transfer.
1379 if (!ret && !starting)
1382 req = next_request(&dep->started_list);
1384 dep->flags |= DWC3_EP_PENDING_REQUEST;
1388 memset(¶ms, 0, sizeof(params));
1391 params.param0 = upper_32_bits(req->trb_dma);
1392 params.param1 = lower_32_bits(req->trb_dma);
1393 cmd = DWC3_DEPCMD_STARTTRANSFER;
1395 if (dep->stream_capable)
1396 cmd |= DWC3_DEPCMD_PARAM(req->request.stream_id);
1398 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1399 cmd |= DWC3_DEPCMD_PARAM(dep->frame_number);
1401 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1402 DWC3_DEPCMD_PARAM(dep->resource_index);
1405 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1407 struct dwc3_request *tmp;
1412 dwc3_stop_active_transfer(dep, true, true);
1414 list_for_each_entry_safe(req, tmp, &dep->started_list, list)
1415 dwc3_gadget_move_cancelled_request(req, DWC3_REQUEST_STATUS_DEQUEUED);
1417 /* If ep isn't started, then there's no end transfer pending */
1418 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
1419 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
1424 if (dep->stream_capable && req->request.is_last)
1425 dep->flags |= DWC3_EP_WAIT_TRANSFER_COMPLETE;
1430 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1434 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1435 return DWC3_DSTS_SOFFN(reg);
1439 * dwc3_gadget_start_isoc_quirk - workaround invalid frame number
1440 * @dep: isoc endpoint
1442 * This function tests for the correct combination of BIT[15:14] from the 16-bit
1443 * microframe number reported by the XferNotReady event for the future frame
1444 * number to start the isoc transfer.
1446 * In DWC_usb31 version 1.70a-ea06 and prior, for highspeed and fullspeed
1447 * isochronous IN, BIT[15:14] of the 16-bit microframe number reported by the
1448 * XferNotReady event are invalid. The driver uses this number to schedule the
1449 * isochronous transfer and passes it to the START TRANSFER command. Because
1450 * this number is invalid, the command may fail. If BIT[15:14] matches the
1451 * internal 16-bit microframe, the START TRANSFER command will pass and the
1452 * transfer will start at the scheduled time, if it is off by 1, the command
1453 * will still pass, but the transfer will start 2 seconds in the future. For all
1454 * other conditions, the START TRANSFER command will fail with bus-expiry.
1456 * In order to workaround this issue, we can test for the correct combination of
1457 * BIT[15:14] by sending START TRANSFER commands with different values of
1458 * BIT[15:14]: 'b00, 'b01, 'b10, and 'b11. Each combination is 2^14 uframe apart
1459 * (or 2 seconds). 4 seconds into the future will result in a bus-expiry status.
1460 * As the result, within the 4 possible combinations for BIT[15:14], there will
1461 * be 2 successful and 2 failure START COMMAND status. One of the 2 successful
1462 * command status will result in a 2-second delay start. The smaller BIT[15:14]
1463 * value is the correct combination.
1465 * Since there are only 4 outcomes and the results are ordered, we can simply
1466 * test 2 START TRANSFER commands with BIT[15:14] combinations 'b00 and 'b01 to
1467 * deduce the smaller successful combination.
1469 * Let test0 = test status for combination 'b00 and test1 = test status for 'b01
1470 * of BIT[15:14]. The correct combination is as follow:
1472 * if test0 fails and test1 passes, BIT[15:14] is 'b01
1473 * if test0 fails and test1 fails, BIT[15:14] is 'b10
1474 * if test0 passes and test1 fails, BIT[15:14] is 'b11
1475 * if test0 passes and test1 passes, BIT[15:14] is 'b00
1477 * Synopsys STAR 9001202023: Wrong microframe number for isochronous IN
1480 static int dwc3_gadget_start_isoc_quirk(struct dwc3_ep *dep)
1486 while (dep->combo_num < 2) {
1487 struct dwc3_gadget_ep_cmd_params params;
1488 u32 test_frame_number;
1492 * Check if we can start isoc transfer on the next interval or
1493 * 4 uframes in the future with BIT[15:14] as dep->combo_num
1495 test_frame_number = dep->frame_number & DWC3_FRNUMBER_MASK;
1496 test_frame_number |= dep->combo_num << 14;
1497 test_frame_number += max_t(u32, 4, dep->interval);
1499 params.param0 = upper_32_bits(dep->dwc->bounce_addr);
1500 params.param1 = lower_32_bits(dep->dwc->bounce_addr);
1502 cmd = DWC3_DEPCMD_STARTTRANSFER;
1503 cmd |= DWC3_DEPCMD_PARAM(test_frame_number);
1504 cmd_status = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1506 /* Redo if some other failure beside bus-expiry is received */
1507 if (cmd_status && cmd_status != -EAGAIN) {
1508 dep->start_cmd_status = 0;
1513 /* Store the first test status */
1514 if (dep->combo_num == 0)
1515 dep->start_cmd_status = cmd_status;
1520 * End the transfer if the START_TRANSFER command is successful
1521 * to wait for the next XferNotReady to test the command again
1523 if (cmd_status == 0) {
1524 dwc3_stop_active_transfer(dep, true, true);
1529 /* test0 and test1 are both completed at this point */
1530 test0 = (dep->start_cmd_status == 0);
1531 test1 = (cmd_status == 0);
1533 if (!test0 && test1)
1535 else if (!test0 && !test1)
1537 else if (test0 && !test1)
1539 else if (test0 && test1)
1542 dep->frame_number &= DWC3_FRNUMBER_MASK;
1543 dep->frame_number |= dep->combo_num << 14;
1544 dep->frame_number += max_t(u32, 4, dep->interval);
1546 /* Reinitialize test variables */
1547 dep->start_cmd_status = 0;
1550 return __dwc3_gadget_kick_transfer(dep);
1553 static int __dwc3_gadget_start_isoc(struct dwc3_ep *dep)
1555 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
1556 struct dwc3 *dwc = dep->dwc;
1560 if (list_empty(&dep->pending_list) &&
1561 list_empty(&dep->started_list)) {
1562 dep->flags |= DWC3_EP_PENDING_REQUEST;
1566 if (!dwc->dis_start_transfer_quirk &&
1567 (DWC3_VER_IS_PRIOR(DWC31, 170A) ||
1568 DWC3_VER_TYPE_IS_WITHIN(DWC31, 170A, EA01, EA06))) {
1569 if (dwc->gadget->speed <= USB_SPEED_HIGH && dep->direction)
1570 return dwc3_gadget_start_isoc_quirk(dep);
1573 if (desc->bInterval <= 14 &&
1574 dwc->gadget->speed >= USB_SPEED_HIGH) {
1575 u32 frame = __dwc3_gadget_get_frame(dwc);
1576 bool rollover = frame <
1577 (dep->frame_number & DWC3_FRNUMBER_MASK);
1580 * frame_number is set from XferNotReady and may be already
1581 * out of date. DSTS only provides the lower 14 bit of the
1582 * current frame number. So add the upper two bits of
1583 * frame_number and handle a possible rollover.
1584 * This will provide the correct frame_number unless more than
1585 * rollover has happened since XferNotReady.
1588 dep->frame_number = (dep->frame_number & ~DWC3_FRNUMBER_MASK) |
1591 dep->frame_number += BIT(14);
1594 for (i = 0; i < DWC3_ISOC_MAX_RETRIES; i++) {
1595 dep->frame_number = DWC3_ALIGN_FRAME(dep, i + 1);
1597 ret = __dwc3_gadget_kick_transfer(dep);
1603 * After a number of unsuccessful start attempts due to bus-expiry
1604 * status, issue END_TRANSFER command and retry on the next XferNotReady
1607 if (ret == -EAGAIN) {
1608 struct dwc3_gadget_ep_cmd_params params;
1611 cmd = DWC3_DEPCMD_ENDTRANSFER |
1612 DWC3_DEPCMD_CMDIOC |
1613 DWC3_DEPCMD_PARAM(dep->resource_index);
1615 dep->resource_index = 0;
1616 memset(¶ms, 0, sizeof(params));
1618 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1620 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
1626 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1628 struct dwc3 *dwc = dep->dwc;
1630 if (!dep->endpoint.desc || !dwc->pullups_connected || !dwc->connected) {
1631 dev_err(dwc->dev, "%s: can't queue to disabled endpoint\n",
1636 if (WARN(req->dep != dep, "request %pK belongs to '%s'\n",
1637 &req->request, req->dep->name))
1640 if (WARN(req->status < DWC3_REQUEST_STATUS_COMPLETED,
1641 "%s: request %pK already in flight\n",
1642 dep->name, &req->request))
1645 pm_runtime_get(dwc->dev);
1647 req->request.actual = 0;
1648 req->request.status = -EINPROGRESS;
1650 trace_dwc3_ep_queue(req);
1652 list_add_tail(&req->list, &dep->pending_list);
1653 req->status = DWC3_REQUEST_STATUS_QUEUED;
1655 if (dep->flags & DWC3_EP_WAIT_TRANSFER_COMPLETE)
1659 * Start the transfer only after the END_TRANSFER is completed
1660 * and endpoint STALL is cleared.
1662 if ((dep->flags & DWC3_EP_END_TRANSFER_PENDING) ||
1663 (dep->flags & DWC3_EP_WEDGE) ||
1664 (dep->flags & DWC3_EP_STALL)) {
1665 dep->flags |= DWC3_EP_DELAY_START;
1670 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1671 * wait for a XferNotReady event so we will know what's the current
1672 * (micro-)frame number.
1674 * Without this trick, we are very, very likely gonna get Bus Expiry
1675 * errors which will force us issue EndTransfer command.
1677 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1678 if (!(dep->flags & DWC3_EP_PENDING_REQUEST) &&
1679 !(dep->flags & DWC3_EP_TRANSFER_STARTED))
1682 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1683 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
1684 return __dwc3_gadget_start_isoc(dep);
1688 __dwc3_gadget_kick_transfer(dep);
1693 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1696 struct dwc3_request *req = to_dwc3_request(request);
1697 struct dwc3_ep *dep = to_dwc3_ep(ep);
1698 struct dwc3 *dwc = dep->dwc;
1700 unsigned long flags;
1704 spin_lock_irqsave(&dwc->lock, flags);
1705 ret = __dwc3_gadget_ep_queue(dep, req);
1706 spin_unlock_irqrestore(&dwc->lock, flags);
1711 static void dwc3_gadget_ep_skip_trbs(struct dwc3_ep *dep, struct dwc3_request *req)
1715 /* If req->trb is not set, then the request has not started */
1720 * If request was already started, this means we had to
1721 * stop the transfer. With that we also need to ignore
1722 * all TRBs used by the request, however TRBs can only
1723 * be modified after completion of END_TRANSFER
1724 * command. So what we do here is that we wait for
1725 * END_TRANSFER completion and only after that, we jump
1726 * over TRBs by clearing HWO and incrementing dequeue
1729 for (i = 0; i < req->num_trbs; i++) {
1730 struct dwc3_trb *trb;
1732 trb = &dep->trb_pool[dep->trb_dequeue];
1733 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1734 dwc3_ep_inc_deq(dep);
1740 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep)
1742 struct dwc3_request *req;
1743 struct dwc3_request *tmp;
1744 struct dwc3 *dwc = dep->dwc;
1746 list_for_each_entry_safe(req, tmp, &dep->cancelled_list, list) {
1747 dwc3_gadget_ep_skip_trbs(dep, req);
1748 switch (req->status) {
1749 case DWC3_REQUEST_STATUS_DISCONNECTED:
1750 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
1752 case DWC3_REQUEST_STATUS_DEQUEUED:
1753 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1755 case DWC3_REQUEST_STATUS_STALLED:
1756 dwc3_gadget_giveback(dep, req, -EPIPE);
1759 dev_err(dwc->dev, "request cancelled with wrong reason:%d\n", req->status);
1760 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1766 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1767 struct usb_request *request)
1769 struct dwc3_request *req = to_dwc3_request(request);
1770 struct dwc3_request *r = NULL;
1772 struct dwc3_ep *dep = to_dwc3_ep(ep);
1773 struct dwc3 *dwc = dep->dwc;
1775 unsigned long flags;
1778 trace_dwc3_ep_dequeue(req);
1780 spin_lock_irqsave(&dwc->lock, flags);
1782 list_for_each_entry(r, &dep->cancelled_list, list) {
1787 list_for_each_entry(r, &dep->pending_list, list) {
1789 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1794 list_for_each_entry(r, &dep->started_list, list) {
1796 struct dwc3_request *t;
1798 /* wait until it is processed */
1799 dwc3_stop_active_transfer(dep, true, true);
1802 * Remove any started request if the transfer is
1805 list_for_each_entry_safe(r, t, &dep->started_list, list)
1806 dwc3_gadget_move_cancelled_request(r,
1807 DWC3_REQUEST_STATUS_DEQUEUED);
1809 dep->flags &= ~DWC3_EP_WAIT_TRANSFER_COMPLETE;
1815 dev_err(dwc->dev, "request %pK was not queued to %s\n",
1819 spin_unlock_irqrestore(&dwc->lock, flags);
1824 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1826 struct dwc3_gadget_ep_cmd_params params;
1827 struct dwc3 *dwc = dep->dwc;
1828 struct dwc3_request *req;
1829 struct dwc3_request *tmp;
1832 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1833 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1837 memset(¶ms, 0x00, sizeof(params));
1840 struct dwc3_trb *trb;
1842 unsigned int transfer_in_flight;
1843 unsigned int started;
1845 if (dep->number > 1)
1846 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1848 trb = &dwc->ep0_trb[dep->trb_enqueue];
1850 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1851 started = !list_empty(&dep->started_list);
1853 if (!protocol && ((dep->direction && transfer_in_flight) ||
1854 (!dep->direction && started))) {
1858 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1861 dev_err(dwc->dev, "failed to set STALL on %s\n",
1864 dep->flags |= DWC3_EP_STALL;
1867 * Don't issue CLEAR_STALL command to control endpoints. The
1868 * controller automatically clears the STALL when it receives
1871 if (dep->number <= 1) {
1872 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1876 dwc3_stop_active_transfer(dep, true, true);
1878 list_for_each_entry_safe(req, tmp, &dep->started_list, list)
1879 dwc3_gadget_move_cancelled_request(req, DWC3_REQUEST_STATUS_STALLED);
1881 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING) {
1882 dep->flags |= DWC3_EP_PENDING_CLEAR_STALL;
1886 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
1888 ret = dwc3_send_clear_stall_ep_cmd(dep);
1890 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1895 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1897 if ((dep->flags & DWC3_EP_DELAY_START) &&
1898 !usb_endpoint_xfer_isoc(dep->endpoint.desc))
1899 __dwc3_gadget_kick_transfer(dep);
1901 dep->flags &= ~DWC3_EP_DELAY_START;
1907 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1909 struct dwc3_ep *dep = to_dwc3_ep(ep);
1910 struct dwc3 *dwc = dep->dwc;
1912 unsigned long flags;
1916 spin_lock_irqsave(&dwc->lock, flags);
1917 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1918 spin_unlock_irqrestore(&dwc->lock, flags);
1923 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1925 struct dwc3_ep *dep = to_dwc3_ep(ep);
1926 struct dwc3 *dwc = dep->dwc;
1927 unsigned long flags;
1930 spin_lock_irqsave(&dwc->lock, flags);
1931 dep->flags |= DWC3_EP_WEDGE;
1933 if (dep->number == 0 || dep->number == 1)
1934 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1936 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1937 spin_unlock_irqrestore(&dwc->lock, flags);
1942 /* -------------------------------------------------------------------------- */
1944 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1945 .bLength = USB_DT_ENDPOINT_SIZE,
1946 .bDescriptorType = USB_DT_ENDPOINT,
1947 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1950 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1951 .enable = dwc3_gadget_ep0_enable,
1952 .disable = dwc3_gadget_ep0_disable,
1953 .alloc_request = dwc3_gadget_ep_alloc_request,
1954 .free_request = dwc3_gadget_ep_free_request,
1955 .queue = dwc3_gadget_ep0_queue,
1956 .dequeue = dwc3_gadget_ep_dequeue,
1957 .set_halt = dwc3_gadget_ep0_set_halt,
1958 .set_wedge = dwc3_gadget_ep_set_wedge,
1961 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1962 .enable = dwc3_gadget_ep_enable,
1963 .disable = dwc3_gadget_ep_disable,
1964 .alloc_request = dwc3_gadget_ep_alloc_request,
1965 .free_request = dwc3_gadget_ep_free_request,
1966 .queue = dwc3_gadget_ep_queue,
1967 .dequeue = dwc3_gadget_ep_dequeue,
1968 .set_halt = dwc3_gadget_ep_set_halt,
1969 .set_wedge = dwc3_gadget_ep_set_wedge,
1972 /* -------------------------------------------------------------------------- */
1974 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1976 struct dwc3 *dwc = gadget_to_dwc(g);
1978 return __dwc3_gadget_get_frame(dwc);
1981 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1991 * According to the Databook Remote wakeup request should
1992 * be issued only when the device is in early suspend state.
1994 * We can check that via USB Link State bits in DSTS register.
1996 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1998 link_state = DWC3_DSTS_USBLNKST(reg);
2000 switch (link_state) {
2001 case DWC3_LINK_STATE_RESET:
2002 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
2003 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
2004 case DWC3_LINK_STATE_U2: /* in HS, means Sleep (L1) */
2005 case DWC3_LINK_STATE_U1:
2006 case DWC3_LINK_STATE_RESUME:
2012 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
2014 dev_err(dwc->dev, "failed to put link in Recovery\n");
2018 /* Recent versions do this automatically */
2019 if (DWC3_VER_IS_PRIOR(DWC3, 194A)) {
2020 /* write zeroes to Link Change Request */
2021 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2022 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
2023 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2026 /* poll until Link State changes to ON */
2030 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2032 /* in HS, means ON */
2033 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
2037 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
2038 dev_err(dwc->dev, "failed to send remote wakeup\n");
2045 static int dwc3_gadget_wakeup(struct usb_gadget *g)
2047 struct dwc3 *dwc = gadget_to_dwc(g);
2048 unsigned long flags;
2051 spin_lock_irqsave(&dwc->lock, flags);
2052 ret = __dwc3_gadget_wakeup(dwc);
2053 spin_unlock_irqrestore(&dwc->lock, flags);
2058 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
2061 struct dwc3 *dwc = gadget_to_dwc(g);
2062 unsigned long flags;
2064 spin_lock_irqsave(&dwc->lock, flags);
2065 g->is_selfpowered = !!is_selfpowered;
2066 spin_unlock_irqrestore(&dwc->lock, flags);
2071 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2075 for (epnum = 2; epnum < dwc->num_eps; epnum++) {
2076 struct dwc3_ep *dep;
2078 dep = dwc->eps[epnum];
2082 dwc3_remove_requests(dwc, dep);
2086 static void __dwc3_gadget_set_ssp_rate(struct dwc3 *dwc)
2088 enum usb_ssp_rate ssp_rate = dwc->gadget_ssp_rate;
2091 if (ssp_rate == USB_SSP_GEN_UNKNOWN)
2092 ssp_rate = dwc->max_ssp_rate;
2094 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2095 reg &= ~DWC3_DCFG_SPEED_MASK;
2096 reg &= ~DWC3_DCFG_NUMLANES(~0);
2098 if (ssp_rate == USB_SSP_GEN_1x2)
2099 reg |= DWC3_DCFG_SUPERSPEED;
2100 else if (dwc->max_ssp_rate != USB_SSP_GEN_1x2)
2101 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2103 if (ssp_rate != USB_SSP_GEN_2x1 &&
2104 dwc->max_ssp_rate != USB_SSP_GEN_2x1)
2105 reg |= DWC3_DCFG_NUMLANES(1);
2107 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2110 static void __dwc3_gadget_set_speed(struct dwc3 *dwc)
2112 enum usb_device_speed speed;
2115 speed = dwc->gadget_max_speed;
2116 if (speed == USB_SPEED_UNKNOWN || speed > dwc->maximum_speed)
2117 speed = dwc->maximum_speed;
2119 if (speed == USB_SPEED_SUPER_PLUS &&
2120 DWC3_IP_IS(DWC32)) {
2121 __dwc3_gadget_set_ssp_rate(dwc);
2125 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2126 reg &= ~(DWC3_DCFG_SPEED_MASK);
2129 * WORKAROUND: DWC3 revision < 2.20a have an issue
2130 * which would cause metastability state on Run/Stop
2131 * bit if we try to force the IP to USB2-only mode.
2133 * Because of that, we cannot configure the IP to any
2134 * speed other than the SuperSpeed
2138 * STAR#9000525659: Clock Domain Crossing on DCTL in
2141 if (DWC3_VER_IS_PRIOR(DWC3, 220A) &&
2142 !dwc->dis_metastability_quirk) {
2143 reg |= DWC3_DCFG_SUPERSPEED;
2146 case USB_SPEED_FULL:
2147 reg |= DWC3_DCFG_FULLSPEED;
2149 case USB_SPEED_HIGH:
2150 reg |= DWC3_DCFG_HIGHSPEED;
2152 case USB_SPEED_SUPER:
2153 reg |= DWC3_DCFG_SUPERSPEED;
2155 case USB_SPEED_SUPER_PLUS:
2156 if (DWC3_IP_IS(DWC3))
2157 reg |= DWC3_DCFG_SUPERSPEED;
2159 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2162 dev_err(dwc->dev, "invalid speed (%d)\n", speed);
2164 if (DWC3_IP_IS(DWC3))
2165 reg |= DWC3_DCFG_SUPERSPEED;
2167 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2171 if (DWC3_IP_IS(DWC32) &&
2172 speed > USB_SPEED_UNKNOWN &&
2173 speed < USB_SPEED_SUPER_PLUS)
2174 reg &= ~DWC3_DCFG_NUMLANES(~0);
2176 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2179 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
2184 if (pm_runtime_suspended(dwc->dev))
2187 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2189 if (DWC3_VER_IS_WITHIN(DWC3, ANY, 187A)) {
2190 reg &= ~DWC3_DCTL_TRGTULST_MASK;
2191 reg |= DWC3_DCTL_TRGTULST_RX_DET;
2194 if (!DWC3_VER_IS_PRIOR(DWC3, 194A))
2195 reg &= ~DWC3_DCTL_KEEP_CONNECT;
2196 reg |= DWC3_DCTL_RUN_STOP;
2198 if (dwc->has_hibernation)
2199 reg |= DWC3_DCTL_KEEP_CONNECT;
2201 __dwc3_gadget_set_speed(dwc);
2202 dwc->pullups_connected = true;
2204 reg &= ~DWC3_DCTL_RUN_STOP;
2206 if (dwc->has_hibernation && !suspend)
2207 reg &= ~DWC3_DCTL_KEEP_CONNECT;
2209 dwc->pullups_connected = false;
2212 dwc3_gadget_dctl_write_safe(dwc, reg);
2215 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2216 reg &= DWC3_DSTS_DEVCTRLHLT;
2217 } while (--timeout && !(!is_on ^ !reg));
2225 static void dwc3_gadget_disable_irq(struct dwc3 *dwc);
2226 static void __dwc3_gadget_stop(struct dwc3 *dwc);
2227 static int __dwc3_gadget_start(struct dwc3 *dwc);
2229 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
2231 struct dwc3 *dwc = gadget_to_dwc(g);
2232 unsigned long flags;
2238 * Per databook, when we want to stop the gadget, if a control transfer
2239 * is still in process, complete it and get the core into setup phase.
2241 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
2242 reinit_completion(&dwc->ep0_in_setup);
2244 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
2245 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
2247 dev_err(dwc->dev, "timed out waiting for SETUP phase\n");
2253 * Check the return value for successful resume, or error. For a
2254 * successful resume, the DWC3 runtime PM resume routine will handle
2255 * the run stop sequence, so avoid duplicate operations here.
2257 ret = pm_runtime_get_sync(dwc->dev);
2258 if (!ret || ret < 0) {
2259 pm_runtime_put(dwc->dev);
2264 * Synchronize and disable any further event handling while controller
2265 * is being enabled/disabled.
2267 disable_irq(dwc->irq_gadget);
2269 spin_lock_irqsave(&dwc->lock, flags);
2274 dwc->connected = false;
2276 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
2277 * Section 4.1.8 Table 4-7, it states that for a device-initiated
2278 * disconnect, the SW needs to ensure that it sends "a DEPENDXFER
2279 * command for any active transfers" before clearing the RunStop
2282 dwc3_stop_active_transfers(dwc);
2283 __dwc3_gadget_stop(dwc);
2286 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
2287 * Section 1.3.4, it mentions that for the DEVCTRLHLT bit, the
2288 * "software needs to acknowledge the events that are generated
2289 * (by writing to GEVNTCOUNTn) while it is waiting for this bit
2290 * to be set to '1'."
2292 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2293 count &= DWC3_GEVNTCOUNT_MASK;
2295 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
2296 dwc->ev_buf->lpos = (dwc->ev_buf->lpos + count) %
2297 dwc->ev_buf->length;
2300 __dwc3_gadget_start(dwc);
2303 ret = dwc3_gadget_run_stop(dwc, is_on, false);
2304 spin_unlock_irqrestore(&dwc->lock, flags);
2305 enable_irq(dwc->irq_gadget);
2307 pm_runtime_put(dwc->dev);
2312 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
2316 /* Enable all but Start and End of Frame IRQs */
2317 reg = (DWC3_DEVTEN_EVNTOVERFLOWEN |
2318 DWC3_DEVTEN_CMDCMPLTEN |
2319 DWC3_DEVTEN_ERRTICERREN |
2320 DWC3_DEVTEN_WKUPEVTEN |
2321 DWC3_DEVTEN_CONNECTDONEEN |
2322 DWC3_DEVTEN_USBRSTEN |
2323 DWC3_DEVTEN_DISCONNEVTEN);
2325 if (DWC3_VER_IS_PRIOR(DWC3, 250A))
2326 reg |= DWC3_DEVTEN_ULSTCNGEN;
2328 /* On 2.30a and above this bit enables U3/L2-L1 Suspend Events */
2329 if (!DWC3_VER_IS_PRIOR(DWC3, 230A))
2330 reg |= DWC3_DEVTEN_U3L2L1SUSPEN;
2332 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
2335 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
2337 /* mask all interrupts */
2338 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
2341 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
2342 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
2345 * dwc3_gadget_setup_nump - calculate and initialize NUMP field of %DWC3_DCFG
2346 * @dwc: pointer to our context structure
2348 * The following looks like complex but it's actually very simple. In order to
2349 * calculate the number of packets we can burst at once on OUT transfers, we're
2350 * gonna use RxFIFO size.
2352 * To calculate RxFIFO size we need two numbers:
2353 * MDWIDTH = size, in bits, of the internal memory bus
2354 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
2356 * Given these two numbers, the formula is simple:
2358 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
2360 * 24 bytes is for 3x SETUP packets
2361 * 16 bytes is a clock domain crossing tolerance
2363 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
2365 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
2372 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
2373 mdwidth = dwc3_mdwidth(dwc);
2375 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
2376 nump = min_t(u32, nump, 16);
2379 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2380 reg &= ~DWC3_DCFG_NUMP_MASK;
2381 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
2382 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2385 static int __dwc3_gadget_start(struct dwc3 *dwc)
2387 struct dwc3_ep *dep;
2392 * Use IMOD if enabled via dwc->imod_interval. Otherwise, if
2393 * the core supports IMOD, disable it.
2395 if (dwc->imod_interval) {
2396 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
2397 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
2398 } else if (dwc3_has_imod(dwc)) {
2399 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), 0);
2403 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
2404 * field instead of letting dwc3 itself calculate that automatically.
2406 * This way, we maximize the chances that we'll be able to get several
2407 * bursts of data without going through any sort of endpoint throttling.
2409 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
2410 if (DWC3_IP_IS(DWC3))
2411 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
2413 reg &= ~DWC31_GRXTHRCFG_PKTCNTSEL;
2415 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
2417 dwc3_gadget_setup_nump(dwc);
2420 * Currently the controller handles single stream only. So, Ignore
2421 * Packet Pending bit for stream selection and don't search for another
2422 * stream if the host sends Data Packet with PP=0 (for OUT direction) or
2423 * ACK with NumP=0 and PP=0 (for IN direction). This slightly improves
2424 * the stream performance.
2426 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2427 reg |= DWC3_DCFG_IGNSTRMPP;
2428 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2430 /* Start with SuperSpeed Default */
2431 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2434 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2436 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2441 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2443 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2447 /* begin to receive SETUP packets */
2448 dwc->ep0state = EP0_SETUP_PHASE;
2449 dwc->link_state = DWC3_LINK_STATE_SS_DIS;
2450 dwc3_ep0_out_start(dwc);
2452 dwc3_gadget_enable_irq(dwc);
2457 __dwc3_gadget_ep_disable(dwc->eps[0]);
2463 static int dwc3_gadget_start(struct usb_gadget *g,
2464 struct usb_gadget_driver *driver)
2466 struct dwc3 *dwc = gadget_to_dwc(g);
2467 unsigned long flags;
2471 irq = dwc->irq_gadget;
2472 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
2473 IRQF_SHARED, "dwc3", dwc->ev_buf);
2475 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
2480 spin_lock_irqsave(&dwc->lock, flags);
2481 dwc->gadget_driver = driver;
2482 spin_unlock_irqrestore(&dwc->lock, flags);
2487 static void __dwc3_gadget_stop(struct dwc3 *dwc)
2489 dwc3_gadget_disable_irq(dwc);
2490 __dwc3_gadget_ep_disable(dwc->eps[0]);
2491 __dwc3_gadget_ep_disable(dwc->eps[1]);
2494 static int dwc3_gadget_stop(struct usb_gadget *g)
2496 struct dwc3 *dwc = gadget_to_dwc(g);
2497 unsigned long flags;
2499 spin_lock_irqsave(&dwc->lock, flags);
2500 dwc->gadget_driver = NULL;
2501 spin_unlock_irqrestore(&dwc->lock, flags);
2503 free_irq(dwc->irq_gadget, dwc->ev_buf);
2508 static void dwc3_gadget_config_params(struct usb_gadget *g,
2509 struct usb_dcd_config_params *params)
2511 struct dwc3 *dwc = gadget_to_dwc(g);
2513 params->besl_baseline = USB_DEFAULT_BESL_UNSPECIFIED;
2514 params->besl_deep = USB_DEFAULT_BESL_UNSPECIFIED;
2516 /* Recommended BESL */
2517 if (!dwc->dis_enblslpm_quirk) {
2519 * If the recommended BESL baseline is 0 or if the BESL deep is
2520 * less than 2, Microsoft's Windows 10 host usb stack will issue
2521 * a usb reset immediately after it receives the extended BOS
2522 * descriptor and the enumeration will fail. To maintain
2523 * compatibility with the Windows' usb stack, let's set the
2524 * recommended BESL baseline to 1 and clamp the BESL deep to be
2527 params->besl_baseline = 1;
2528 if (dwc->is_utmi_l1_suspend)
2530 clamp_t(u8, dwc->hird_threshold, 2, 15);
2533 /* U1 Device exit Latency */
2534 if (dwc->dis_u1_entry_quirk)
2535 params->bU1devExitLat = 0;
2537 params->bU1devExitLat = DWC3_DEFAULT_U1_DEV_EXIT_LAT;
2539 /* U2 Device exit Latency */
2540 if (dwc->dis_u2_entry_quirk)
2541 params->bU2DevExitLat = 0;
2543 params->bU2DevExitLat =
2544 cpu_to_le16(DWC3_DEFAULT_U2_DEV_EXIT_LAT);
2547 static void dwc3_gadget_set_speed(struct usb_gadget *g,
2548 enum usb_device_speed speed)
2550 struct dwc3 *dwc = gadget_to_dwc(g);
2551 unsigned long flags;
2553 spin_lock_irqsave(&dwc->lock, flags);
2554 dwc->gadget_max_speed = speed;
2555 spin_unlock_irqrestore(&dwc->lock, flags);
2558 static void dwc3_gadget_set_ssp_rate(struct usb_gadget *g,
2559 enum usb_ssp_rate rate)
2561 struct dwc3 *dwc = gadget_to_dwc(g);
2562 unsigned long flags;
2564 spin_lock_irqsave(&dwc->lock, flags);
2565 dwc->gadget_max_speed = USB_SPEED_SUPER_PLUS;
2566 dwc->gadget_ssp_rate = rate;
2567 spin_unlock_irqrestore(&dwc->lock, flags);
2570 static int dwc3_gadget_vbus_draw(struct usb_gadget *g, unsigned int mA)
2572 struct dwc3 *dwc = gadget_to_dwc(g);
2573 union power_supply_propval val = {0};
2577 return usb_phy_set_power(dwc->usb2_phy, mA);
2582 val.intval = 1000 * mA;
2583 ret = power_supply_set_property(dwc->usb_psy, POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT, &val);
2588 static void dwc3_gadget_async_callbacks(struct usb_gadget *g, bool enable)
2590 struct dwc3 *dwc = gadget_to_dwc(g);
2591 unsigned long flags;
2593 spin_lock_irqsave(&dwc->lock, flags);
2594 dwc->async_callbacks = enable;
2595 spin_unlock_irqrestore(&dwc->lock, flags);
2598 static const struct usb_gadget_ops dwc3_gadget_ops = {
2599 .get_frame = dwc3_gadget_get_frame,
2600 .wakeup = dwc3_gadget_wakeup,
2601 .set_selfpowered = dwc3_gadget_set_selfpowered,
2602 .pullup = dwc3_gadget_pullup,
2603 .udc_start = dwc3_gadget_start,
2604 .udc_stop = dwc3_gadget_stop,
2605 .udc_set_speed = dwc3_gadget_set_speed,
2606 .udc_set_ssp_rate = dwc3_gadget_set_ssp_rate,
2607 .get_config_params = dwc3_gadget_config_params,
2608 .vbus_draw = dwc3_gadget_vbus_draw,
2609 .udc_async_callbacks = dwc3_gadget_async_callbacks,
2612 /* -------------------------------------------------------------------------- */
2614 static int dwc3_gadget_init_control_endpoint(struct dwc3_ep *dep)
2616 struct dwc3 *dwc = dep->dwc;
2618 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
2619 dep->endpoint.maxburst = 1;
2620 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
2621 if (!dep->direction)
2622 dwc->gadget->ep0 = &dep->endpoint;
2624 dep->endpoint.caps.type_control = true;
2629 static int dwc3_gadget_init_in_endpoint(struct dwc3_ep *dep)
2631 struct dwc3 *dwc = dep->dwc;
2635 mdwidth = dwc3_mdwidth(dwc);
2637 /* MDWIDTH is represented in bits, we need it in bytes */
2640 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1));
2641 if (DWC3_IP_IS(DWC3))
2642 size = DWC3_GTXFIFOSIZ_TXFDEP(size);
2644 size = DWC31_GTXFIFOSIZ_TXFDEP(size);
2646 /* FIFO Depth is in MDWDITH bytes. Multiply */
2650 * To meet performance requirement, a minimum TxFIFO size of 3x
2651 * MaxPacketSize is recommended for endpoints that support burst and a
2652 * minimum TxFIFO size of 2x MaxPacketSize for endpoints that don't
2653 * support burst. Use those numbers and we can calculate the max packet
2656 if (dwc->maximum_speed >= USB_SPEED_SUPER)
2661 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2663 dep->endpoint.max_streams = 16;
2664 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2665 list_add_tail(&dep->endpoint.ep_list,
2666 &dwc->gadget->ep_list);
2667 dep->endpoint.caps.type_iso = true;
2668 dep->endpoint.caps.type_bulk = true;
2669 dep->endpoint.caps.type_int = true;
2671 return dwc3_alloc_trb_pool(dep);
2674 static int dwc3_gadget_init_out_endpoint(struct dwc3_ep *dep)
2676 struct dwc3 *dwc = dep->dwc;
2680 mdwidth = dwc3_mdwidth(dwc);
2682 /* MDWIDTH is represented in bits, convert to bytes */
2685 /* All OUT endpoints share a single RxFIFO space */
2686 size = dwc3_readl(dwc->regs, DWC3_GRXFIFOSIZ(0));
2687 if (DWC3_IP_IS(DWC3))
2688 size = DWC3_GRXFIFOSIZ_RXFDEP(size);
2690 size = DWC31_GRXFIFOSIZ_RXFDEP(size);
2692 /* FIFO depth is in MDWDITH bytes */
2696 * To meet performance requirement, a minimum recommended RxFIFO size
2697 * is defined as follow:
2698 * RxFIFO size >= (3 x MaxPacketSize) +
2699 * (3 x 8 bytes setup packets size) + (16 bytes clock crossing margin)
2701 * Then calculate the max packet limit as below.
2703 size -= (3 * 8) + 16;
2709 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2710 dep->endpoint.max_streams = 16;
2711 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2712 list_add_tail(&dep->endpoint.ep_list,
2713 &dwc->gadget->ep_list);
2714 dep->endpoint.caps.type_iso = true;
2715 dep->endpoint.caps.type_bulk = true;
2716 dep->endpoint.caps.type_int = true;
2718 return dwc3_alloc_trb_pool(dep);
2721 static int dwc3_gadget_init_endpoint(struct dwc3 *dwc, u8 epnum)
2723 struct dwc3_ep *dep;
2724 bool direction = epnum & 1;
2726 u8 num = epnum >> 1;
2728 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
2733 dep->number = epnum;
2734 dep->direction = direction;
2735 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
2736 dwc->eps[epnum] = dep;
2738 dep->start_cmd_status = 0;
2740 snprintf(dep->name, sizeof(dep->name), "ep%u%s", num,
2741 direction ? "in" : "out");
2743 dep->endpoint.name = dep->name;
2745 if (!(dep->number > 1)) {
2746 dep->endpoint.desc = &dwc3_gadget_ep0_desc;
2747 dep->endpoint.comp_desc = NULL;
2751 ret = dwc3_gadget_init_control_endpoint(dep);
2753 ret = dwc3_gadget_init_in_endpoint(dep);
2755 ret = dwc3_gadget_init_out_endpoint(dep);
2760 dep->endpoint.caps.dir_in = direction;
2761 dep->endpoint.caps.dir_out = !direction;
2763 INIT_LIST_HEAD(&dep->pending_list);
2764 INIT_LIST_HEAD(&dep->started_list);
2765 INIT_LIST_HEAD(&dep->cancelled_list);
2767 dwc3_debugfs_create_endpoint_dir(dep);
2772 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc, u8 total)
2776 INIT_LIST_HEAD(&dwc->gadget->ep_list);
2778 for (epnum = 0; epnum < total; epnum++) {
2781 ret = dwc3_gadget_init_endpoint(dwc, epnum);
2789 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
2791 struct dwc3_ep *dep;
2794 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2795 dep = dwc->eps[epnum];
2799 * Physical endpoints 0 and 1 are special; they form the
2800 * bi-directional USB endpoint 0.
2802 * For those two physical endpoints, we don't allocate a TRB
2803 * pool nor do we add them the endpoints list. Due to that, we
2804 * shouldn't do these two operations otherwise we would end up
2805 * with all sorts of bugs when removing dwc3.ko.
2807 if (epnum != 0 && epnum != 1) {
2808 dwc3_free_trb_pool(dep);
2809 list_del(&dep->endpoint.ep_list);
2812 debugfs_remove_recursive(debugfs_lookup(dep->name,
2813 debugfs_lookup(dev_name(dep->dwc->dev),
2819 /* -------------------------------------------------------------------------- */
2821 static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
2822 struct dwc3_request *req, struct dwc3_trb *trb,
2823 const struct dwc3_event_depevt *event, int status, int chain)
2827 dwc3_ep_inc_deq(dep);
2829 trace_dwc3_complete_trb(dep, trb);
2833 * If we're in the middle of series of chained TRBs and we
2834 * receive a short transfer along the way, DWC3 will skip
2835 * through all TRBs including the last TRB in the chain (the
2836 * where CHN bit is zero. DWC3 will also avoid clearing HWO
2837 * bit and SW has to do it manually.
2839 * We're going to do that here to avoid problems of HW trying
2840 * to use bogus TRBs for transfers.
2842 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
2843 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2846 * For isochronous transfers, the first TRB in a service interval must
2847 * have the Isoc-First type. Track and report its interval frame number.
2849 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2850 (trb->ctrl & DWC3_TRBCTL_ISOCHRONOUS_FIRST)) {
2851 unsigned int frame_number;
2853 frame_number = DWC3_TRB_CTRL_GET_SID_SOFN(trb->ctrl);
2854 frame_number &= ~(dep->interval - 1);
2855 req->request.frame_number = frame_number;
2859 * We use bounce buffer for requests that needs extra TRB or OUT ZLP. If
2860 * this TRB points to the bounce buffer address, it's a MPS alignment
2861 * TRB. Don't add it to req->remaining calculation.
2863 if (trb->bpl == lower_32_bits(dep->dwc->bounce_addr) &&
2864 trb->bph == upper_32_bits(dep->dwc->bounce_addr)) {
2865 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2869 count = trb->size & DWC3_TRB_SIZE_MASK;
2870 req->remaining += count;
2872 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
2875 if (event->status & DEPEVT_STATUS_SHORT && !chain)
2878 if ((trb->ctrl & DWC3_TRB_CTRL_IOC) ||
2879 (trb->ctrl & DWC3_TRB_CTRL_LST))
2885 static int dwc3_gadget_ep_reclaim_trb_sg(struct dwc3_ep *dep,
2886 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2889 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2890 struct scatterlist *sg = req->sg;
2891 struct scatterlist *s;
2892 unsigned int num_queued = req->num_queued_sgs;
2896 for_each_sg(sg, s, num_queued, i) {
2897 trb = &dep->trb_pool[dep->trb_dequeue];
2899 req->sg = sg_next(s);
2900 req->num_queued_sgs--;
2902 ret = dwc3_gadget_ep_reclaim_completed_trb(dep, req,
2903 trb, event, status, true);
2911 static int dwc3_gadget_ep_reclaim_trb_linear(struct dwc3_ep *dep,
2912 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2915 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2917 return dwc3_gadget_ep_reclaim_completed_trb(dep, req, trb,
2918 event, status, false);
2921 static bool dwc3_gadget_ep_request_completed(struct dwc3_request *req)
2923 return req->num_pending_sgs == 0 && req->num_queued_sgs == 0;
2926 static int dwc3_gadget_ep_cleanup_completed_request(struct dwc3_ep *dep,
2927 const struct dwc3_event_depevt *event,
2928 struct dwc3_request *req, int status)
2932 if (req->request.num_mapped_sgs)
2933 ret = dwc3_gadget_ep_reclaim_trb_sg(dep, req, event,
2936 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2939 req->request.actual = req->request.length - req->remaining;
2941 if (!dwc3_gadget_ep_request_completed(req))
2944 if (req->needs_extra_trb) {
2945 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2947 req->needs_extra_trb = false;
2950 dwc3_gadget_giveback(dep, req, status);
2956 static void dwc3_gadget_ep_cleanup_completed_requests(struct dwc3_ep *dep,
2957 const struct dwc3_event_depevt *event, int status)
2959 struct dwc3_request *req;
2960 struct dwc3_request *tmp;
2962 list_for_each_entry_safe(req, tmp, &dep->started_list, list) {
2965 ret = dwc3_gadget_ep_cleanup_completed_request(dep, event,
2972 static bool dwc3_gadget_ep_should_continue(struct dwc3_ep *dep)
2974 struct dwc3_request *req;
2975 struct dwc3 *dwc = dep->dwc;
2977 if (!dep->endpoint.desc || !dwc->pullups_connected ||
2981 if (!list_empty(&dep->pending_list))
2985 * We only need to check the first entry of the started list. We can
2986 * assume the completed requests are removed from the started list.
2988 req = next_request(&dep->started_list);
2992 return !dwc3_gadget_ep_request_completed(req);
2995 static void dwc3_gadget_endpoint_frame_from_event(struct dwc3_ep *dep,
2996 const struct dwc3_event_depevt *event)
2998 dep->frame_number = event->parameters;
3001 static bool dwc3_gadget_endpoint_trbs_complete(struct dwc3_ep *dep,
3002 const struct dwc3_event_depevt *event, int status)
3004 struct dwc3 *dwc = dep->dwc;
3005 bool no_started_trb = true;
3007 dwc3_gadget_ep_cleanup_completed_requests(dep, event, status);
3009 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING)
3012 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
3013 list_empty(&dep->started_list) &&
3014 (list_empty(&dep->pending_list) || status == -EXDEV))
3015 dwc3_stop_active_transfer(dep, true, true);
3016 else if (dwc3_gadget_ep_should_continue(dep))
3017 if (__dwc3_gadget_kick_transfer(dep) == 0)
3018 no_started_trb = false;
3022 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
3023 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
3025 if (DWC3_VER_IS_PRIOR(DWC3, 183A)) {
3029 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
3032 if (!(dep->flags & DWC3_EP_ENABLED))
3035 if (!list_empty(&dep->started_list))
3036 return no_started_trb;
3039 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3041 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
3046 return no_started_trb;
3049 static void dwc3_gadget_endpoint_transfer_in_progress(struct dwc3_ep *dep,
3050 const struct dwc3_event_depevt *event)
3054 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
3055 dwc3_gadget_endpoint_frame_from_event(dep, event);
3057 if (event->status & DEPEVT_STATUS_BUSERR)
3058 status = -ECONNRESET;
3060 if (event->status & DEPEVT_STATUS_MISSED_ISOC)
3063 dwc3_gadget_endpoint_trbs_complete(dep, event, status);
3066 static void dwc3_gadget_endpoint_transfer_complete(struct dwc3_ep *dep,
3067 const struct dwc3_event_depevt *event)
3071 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3073 if (event->status & DEPEVT_STATUS_BUSERR)
3074 status = -ECONNRESET;
3076 if (dwc3_gadget_endpoint_trbs_complete(dep, event, status))
3077 dep->flags &= ~DWC3_EP_WAIT_TRANSFER_COMPLETE;
3080 static void dwc3_gadget_endpoint_transfer_not_ready(struct dwc3_ep *dep,
3081 const struct dwc3_event_depevt *event)
3083 dwc3_gadget_endpoint_frame_from_event(dep, event);
3086 * The XferNotReady event is generated only once before the endpoint
3087 * starts. It will be generated again when END_TRANSFER command is
3088 * issued. For some controller versions, the XferNotReady event may be
3089 * generated while the END_TRANSFER command is still in process. Ignore
3090 * it and wait for the next XferNotReady event after the command is
3093 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING)
3096 (void) __dwc3_gadget_start_isoc(dep);
3099 static void dwc3_gadget_endpoint_command_complete(struct dwc3_ep *dep,
3100 const struct dwc3_event_depevt *event)
3102 u8 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
3104 if (cmd != DWC3_DEPCMD_ENDTRANSFER)
3107 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
3108 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3109 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
3111 if (dep->flags & DWC3_EP_PENDING_CLEAR_STALL) {
3112 struct dwc3 *dwc = dep->dwc;
3114 dep->flags &= ~DWC3_EP_PENDING_CLEAR_STALL;
3115 if (dwc3_send_clear_stall_ep_cmd(dep)) {
3116 struct usb_ep *ep0 = &dwc->eps[0]->endpoint;
3118 dev_err(dwc->dev, "failed to clear STALL on %s\n", dep->name);
3119 if (dwc->delayed_status)
3120 __dwc3_gadget_ep0_set_halt(ep0, 1);
3124 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
3125 if (dwc->delayed_status)
3126 dwc3_ep0_send_delayed_status(dwc);
3129 if ((dep->flags & DWC3_EP_DELAY_START) &&
3130 !usb_endpoint_xfer_isoc(dep->endpoint.desc))
3131 __dwc3_gadget_kick_transfer(dep);
3133 dep->flags &= ~DWC3_EP_DELAY_START;
3136 static void dwc3_gadget_endpoint_stream_event(struct dwc3_ep *dep,
3137 const struct dwc3_event_depevt *event)
3139 struct dwc3 *dwc = dep->dwc;
3141 if (event->status == DEPEVT_STREAMEVT_FOUND) {
3142 dep->flags |= DWC3_EP_FIRST_STREAM_PRIMED;
3146 /* Note: NoStream rejection event param value is 0 and not 0xFFFF */
3147 switch (event->parameters) {
3148 case DEPEVT_STREAM_PRIME:
3150 * If the host can properly transition the endpoint state from
3151 * idle to prime after a NoStream rejection, there's no need to
3152 * force restarting the endpoint to reinitiate the stream. To
3153 * simplify the check, assume the host follows the USB spec if
3154 * it primed the endpoint more than once.
3156 if (dep->flags & DWC3_EP_FORCE_RESTART_STREAM) {
3157 if (dep->flags & DWC3_EP_FIRST_STREAM_PRIMED)
3158 dep->flags &= ~DWC3_EP_FORCE_RESTART_STREAM;
3160 dep->flags |= DWC3_EP_FIRST_STREAM_PRIMED;
3164 case DEPEVT_STREAM_NOSTREAM:
3165 if ((dep->flags & DWC3_EP_IGNORE_NEXT_NOSTREAM) ||
3166 !(dep->flags & DWC3_EP_FORCE_RESTART_STREAM) ||
3167 !(dep->flags & DWC3_EP_WAIT_TRANSFER_COMPLETE))
3171 * If the host rejects a stream due to no active stream, by the
3172 * USB and xHCI spec, the endpoint will be put back to idle
3173 * state. When the host is ready (buffer added/updated), it will
3174 * prime the endpoint to inform the usb device controller. This
3175 * triggers the device controller to issue ERDY to restart the
3176 * stream. However, some hosts don't follow this and keep the
3177 * endpoint in the idle state. No prime will come despite host
3178 * streams are updated, and the device controller will not be
3179 * triggered to generate ERDY to move the next stream data. To
3180 * workaround this and maintain compatibility with various
3181 * hosts, force to reinitate the stream until the host is ready
3182 * instead of waiting for the host to prime the endpoint.
3184 if (DWC3_VER_IS_WITHIN(DWC32, 100A, ANY)) {
3185 unsigned int cmd = DWC3_DGCMD_SET_ENDPOINT_PRIME;
3187 dwc3_send_gadget_generic_command(dwc, cmd, dep->number);
3189 dep->flags |= DWC3_EP_DELAY_START;
3190 dwc3_stop_active_transfer(dep, true, true);
3197 dep->flags &= ~DWC3_EP_IGNORE_NEXT_NOSTREAM;
3200 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
3201 const struct dwc3_event_depevt *event)
3203 struct dwc3_ep *dep;
3204 u8 epnum = event->endpoint_number;
3206 dep = dwc->eps[epnum];
3208 if (!(dep->flags & DWC3_EP_ENABLED)) {
3209 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
3212 /* Handle only EPCMDCMPLT when EP disabled */
3213 if (event->endpoint_event != DWC3_DEPEVT_EPCMDCMPLT)
3217 if (epnum == 0 || epnum == 1) {
3218 dwc3_ep0_interrupt(dwc, event);
3222 switch (event->endpoint_event) {
3223 case DWC3_DEPEVT_XFERINPROGRESS:
3224 dwc3_gadget_endpoint_transfer_in_progress(dep, event);
3226 case DWC3_DEPEVT_XFERNOTREADY:
3227 dwc3_gadget_endpoint_transfer_not_ready(dep, event);
3229 case DWC3_DEPEVT_EPCMDCMPLT:
3230 dwc3_gadget_endpoint_command_complete(dep, event);
3232 case DWC3_DEPEVT_XFERCOMPLETE:
3233 dwc3_gadget_endpoint_transfer_complete(dep, event);
3235 case DWC3_DEPEVT_STREAMEVT:
3236 dwc3_gadget_endpoint_stream_event(dep, event);
3238 case DWC3_DEPEVT_RXTXFIFOEVT:
3243 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
3245 if (dwc->async_callbacks && dwc->gadget_driver->disconnect) {
3246 spin_unlock(&dwc->lock);
3247 dwc->gadget_driver->disconnect(dwc->gadget);
3248 spin_lock(&dwc->lock);
3252 static void dwc3_suspend_gadget(struct dwc3 *dwc)
3254 if (dwc->async_callbacks && dwc->gadget_driver->suspend) {
3255 spin_unlock(&dwc->lock);
3256 dwc->gadget_driver->suspend(dwc->gadget);
3257 spin_lock(&dwc->lock);
3261 static void dwc3_resume_gadget(struct dwc3 *dwc)
3263 if (dwc->async_callbacks && dwc->gadget_driver->resume) {
3264 spin_unlock(&dwc->lock);
3265 dwc->gadget_driver->resume(dwc->gadget);
3266 spin_lock(&dwc->lock);
3270 static void dwc3_reset_gadget(struct dwc3 *dwc)
3272 if (!dwc->gadget_driver)
3275 if (dwc->async_callbacks && dwc->gadget->speed != USB_SPEED_UNKNOWN) {
3276 spin_unlock(&dwc->lock);
3277 usb_gadget_udc_reset(dwc->gadget, dwc->gadget_driver);
3278 spin_lock(&dwc->lock);
3282 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
3285 struct dwc3_gadget_ep_cmd_params params;
3289 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED) ||
3290 (dep->flags & DWC3_EP_END_TRANSFER_PENDING))
3294 * NOTICE: We are violating what the Databook says about the
3295 * EndTransfer command. Ideally we would _always_ wait for the
3296 * EndTransfer Command Completion IRQ, but that's causing too
3297 * much trouble synchronizing between us and gadget driver.
3299 * We have discussed this with the IP Provider and it was
3300 * suggested to giveback all requests here.
3302 * Note also that a similar handling was tested by Synopsys
3303 * (thanks a lot Paul) and nothing bad has come out of it.
3304 * In short, what we're doing is issuing EndTransfer with
3305 * CMDIOC bit set and delay kicking transfer until the
3306 * EndTransfer command had completed.
3308 * As of IP version 3.10a of the DWC_usb3 IP, the controller
3309 * supports a mode to work around the above limitation. The
3310 * software can poll the CMDACT bit in the DEPCMD register
3311 * after issuing a EndTransfer command. This mode is enabled
3312 * by writing GUCTL2[14]. This polling is already done in the
3313 * dwc3_send_gadget_ep_cmd() function so if the mode is
3314 * enabled, the EndTransfer command will have completed upon
3315 * returning from this function.
3317 * This mode is NOT available on the DWC_usb31 IP.
3320 cmd = DWC3_DEPCMD_ENDTRANSFER;
3321 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
3322 cmd |= interrupt ? DWC3_DEPCMD_CMDIOC : 0;
3323 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
3324 memset(¶ms, 0, sizeof(params));
3325 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
3327 dep->resource_index = 0;
3330 * The END_TRANSFER command will cause the controller to generate a
3331 * NoStream Event, and it's not due to the host DP NoStream rejection.
3332 * Ignore the next NoStream event.
3334 if (dep->stream_capable)
3335 dep->flags |= DWC3_EP_IGNORE_NEXT_NOSTREAM;
3338 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3340 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
3343 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
3347 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
3348 struct dwc3_ep *dep;
3351 dep = dwc->eps[epnum];
3355 if (!(dep->flags & DWC3_EP_STALL))
3358 dep->flags &= ~DWC3_EP_STALL;
3360 ret = dwc3_send_clear_stall_ep_cmd(dep);
3365 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
3369 dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RX_DET);
3371 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3372 reg &= ~DWC3_DCTL_INITU1ENA;
3373 reg &= ~DWC3_DCTL_INITU2ENA;
3374 dwc3_gadget_dctl_write_safe(dwc, reg);
3376 dwc3_disconnect_gadget(dwc);
3378 dwc->gadget->speed = USB_SPEED_UNKNOWN;
3379 dwc->setup_packet_pending = false;
3380 usb_gadget_set_state(dwc->gadget, USB_STATE_NOTATTACHED);
3382 dwc->connected = false;
3385 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
3390 * Ideally, dwc3_reset_gadget() would trigger the function
3391 * drivers to stop any active transfers through ep disable.
3392 * However, for functions which defer ep disable, such as mass
3393 * storage, we will need to rely on the call to stop active
3394 * transfers here, and avoid allowing of request queuing.
3396 dwc->connected = false;
3399 * WORKAROUND: DWC3 revisions <1.88a have an issue which
3400 * would cause a missing Disconnect Event if there's a
3401 * pending Setup Packet in the FIFO.
3403 * There's no suggested workaround on the official Bug
3404 * report, which states that "unless the driver/application
3405 * is doing any special handling of a disconnect event,
3406 * there is no functional issue".
3408 * Unfortunately, it turns out that we _do_ some special
3409 * handling of a disconnect event, namely complete all
3410 * pending transfers, notify gadget driver of the
3411 * disconnection, and so on.
3413 * Our suggested workaround is to follow the Disconnect
3414 * Event steps here, instead, based on a setup_packet_pending
3415 * flag. Such flag gets set whenever we have a SETUP_PENDING
3416 * status for EP0 TRBs and gets cleared on XferComplete for the
3421 * STAR#9000466709: RTL: Device : Disconnect event not
3422 * generated if setup packet pending in FIFO
3424 if (DWC3_VER_IS_PRIOR(DWC3, 188A)) {
3425 if (dwc->setup_packet_pending)
3426 dwc3_gadget_disconnect_interrupt(dwc);
3429 dwc3_reset_gadget(dwc);
3431 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
3432 * Section 4.1.2 Table 4-2, it states that during a USB reset, the SW
3433 * needs to ensure that it sends "a DEPENDXFER command for any active
3436 dwc3_stop_active_transfers(dwc);
3437 dwc->connected = true;
3439 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3440 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
3441 dwc3_gadget_dctl_write_safe(dwc, reg);
3442 dwc->test_mode = false;
3443 dwc3_clear_stall_all_ep(dwc);
3445 /* Reset device address to zero */
3446 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3447 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
3448 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3451 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
3453 struct dwc3_ep *dep;
3459 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
3460 speed = reg & DWC3_DSTS_CONNECTSPD;
3463 if (DWC3_IP_IS(DWC32))
3464 lanes = DWC3_DSTS_CONNLANES(reg) + 1;
3466 dwc->gadget->ssp_rate = USB_SSP_GEN_UNKNOWN;
3469 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
3470 * each time on Connect Done.
3472 * Currently we always use the reset value. If any platform
3473 * wants to set this to a different value, we need to add a
3474 * setting and update GCTL.RAMCLKSEL here.
3478 case DWC3_DSTS_SUPERSPEED_PLUS:
3479 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
3480 dwc->gadget->ep0->maxpacket = 512;
3481 dwc->gadget->speed = USB_SPEED_SUPER_PLUS;
3484 dwc->gadget->ssp_rate = USB_SSP_GEN_2x2;
3486 dwc->gadget->ssp_rate = USB_SSP_GEN_2x1;
3488 case DWC3_DSTS_SUPERSPEED:
3490 * WORKAROUND: DWC3 revisions <1.90a have an issue which
3491 * would cause a missing USB3 Reset event.
3493 * In such situations, we should force a USB3 Reset
3494 * event by calling our dwc3_gadget_reset_interrupt()
3499 * STAR#9000483510: RTL: SS : USB3 reset event may
3500 * not be generated always when the link enters poll
3502 if (DWC3_VER_IS_PRIOR(DWC3, 190A))
3503 dwc3_gadget_reset_interrupt(dwc);
3505 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
3506 dwc->gadget->ep0->maxpacket = 512;
3507 dwc->gadget->speed = USB_SPEED_SUPER;
3510 dwc->gadget->speed = USB_SPEED_SUPER_PLUS;
3511 dwc->gadget->ssp_rate = USB_SSP_GEN_1x2;
3514 case DWC3_DSTS_HIGHSPEED:
3515 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
3516 dwc->gadget->ep0->maxpacket = 64;
3517 dwc->gadget->speed = USB_SPEED_HIGH;
3519 case DWC3_DSTS_FULLSPEED:
3520 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
3521 dwc->gadget->ep0->maxpacket = 64;
3522 dwc->gadget->speed = USB_SPEED_FULL;
3526 dwc->eps[1]->endpoint.maxpacket = dwc->gadget->ep0->maxpacket;
3528 /* Enable USB2 LPM Capability */
3530 if (!DWC3_VER_IS_WITHIN(DWC3, ANY, 194A) &&
3531 !dwc->usb2_gadget_lpm_disable &&
3532 (speed != DWC3_DSTS_SUPERSPEED) &&
3533 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
3534 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3535 reg |= DWC3_DCFG_LPM_CAP;
3536 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3538 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3539 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
3541 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold |
3542 (dwc->is_utmi_l1_suspend << 4));
3545 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
3546 * DCFG.LPMCap is set, core responses with an ACK and the
3547 * BESL value in the LPM token is less than or equal to LPM
3550 WARN_ONCE(DWC3_VER_IS_PRIOR(DWC3, 240A) && dwc->has_lpm_erratum,
3551 "LPM Erratum not available on dwc3 revisions < 2.40a\n");
3553 if (dwc->has_lpm_erratum && !DWC3_VER_IS_PRIOR(DWC3, 240A))
3554 reg |= DWC3_DCTL_NYET_THRES(dwc->lpm_nyet_threshold);
3556 dwc3_gadget_dctl_write_safe(dwc, reg);
3558 if (dwc->usb2_gadget_lpm_disable) {
3559 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3560 reg &= ~DWC3_DCFG_LPM_CAP;
3561 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3564 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3565 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
3566 dwc3_gadget_dctl_write_safe(dwc, reg);
3570 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
3572 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3577 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
3579 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3584 * Configure PHY via GUSB3PIPECTLn if required.
3586 * Update GTXFIFOSIZn
3588 * In both cases reset values should be sufficient.
3592 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
3595 * TODO take core out of low power mode when that's
3599 if (dwc->async_callbacks && dwc->gadget_driver->resume) {
3600 spin_unlock(&dwc->lock);
3601 dwc->gadget_driver->resume(dwc->gadget);
3602 spin_lock(&dwc->lock);
3606 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
3607 unsigned int evtinfo)
3609 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3610 unsigned int pwropt;
3613 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
3614 * Hibernation mode enabled which would show up when device detects
3615 * host-initiated U3 exit.
3617 * In that case, device will generate a Link State Change Interrupt
3618 * from U3 to RESUME which is only necessary if Hibernation is
3621 * There are no functional changes due to such spurious event and we
3622 * just need to ignore it.
3626 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
3629 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
3630 if (DWC3_VER_IS_PRIOR(DWC3, 250A) &&
3631 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
3632 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
3633 (next == DWC3_LINK_STATE_RESUME)) {
3639 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
3640 * on the link partner, the USB session might do multiple entry/exit
3641 * of low power states before a transfer takes place.
3643 * Due to this problem, we might experience lower throughput. The
3644 * suggested workaround is to disable DCTL[12:9] bits if we're
3645 * transitioning from U1/U2 to U0 and enable those bits again
3646 * after a transfer completes and there are no pending transfers
3647 * on any of the enabled endpoints.
3649 * This is the first half of that workaround.
3653 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
3654 * core send LGO_Ux entering U0
3656 if (DWC3_VER_IS_PRIOR(DWC3, 183A)) {
3657 if (next == DWC3_LINK_STATE_U0) {
3661 switch (dwc->link_state) {
3662 case DWC3_LINK_STATE_U1:
3663 case DWC3_LINK_STATE_U2:
3664 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3665 u1u2 = reg & (DWC3_DCTL_INITU2ENA
3666 | DWC3_DCTL_ACCEPTU2ENA
3667 | DWC3_DCTL_INITU1ENA
3668 | DWC3_DCTL_ACCEPTU1ENA);
3671 dwc->u1u2 = reg & u1u2;
3675 dwc3_gadget_dctl_write_safe(dwc, reg);
3685 case DWC3_LINK_STATE_U1:
3686 if (dwc->speed == USB_SPEED_SUPER)
3687 dwc3_suspend_gadget(dwc);
3689 case DWC3_LINK_STATE_U2:
3690 case DWC3_LINK_STATE_U3:
3691 dwc3_suspend_gadget(dwc);
3693 case DWC3_LINK_STATE_RESUME:
3694 dwc3_resume_gadget(dwc);
3701 dwc->link_state = next;
3704 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
3705 unsigned int evtinfo)
3707 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3709 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
3710 dwc3_suspend_gadget(dwc);
3712 dwc->link_state = next;
3715 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
3716 unsigned int evtinfo)
3718 unsigned int is_ss = evtinfo & BIT(4);
3721 * WORKAROUND: DWC3 revison 2.20a with hibernation support
3722 * have a known issue which can cause USB CV TD.9.23 to fail
3725 * Because of this issue, core could generate bogus hibernation
3726 * events which SW needs to ignore.
3730 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
3731 * Device Fallback from SuperSpeed
3733 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
3736 /* enter hibernation here */
3739 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
3740 const struct dwc3_event_devt *event)
3742 switch (event->type) {
3743 case DWC3_DEVICE_EVENT_DISCONNECT:
3744 dwc3_gadget_disconnect_interrupt(dwc);
3746 case DWC3_DEVICE_EVENT_RESET:
3747 dwc3_gadget_reset_interrupt(dwc);
3749 case DWC3_DEVICE_EVENT_CONNECT_DONE:
3750 dwc3_gadget_conndone_interrupt(dwc);
3752 case DWC3_DEVICE_EVENT_WAKEUP:
3753 dwc3_gadget_wakeup_interrupt(dwc);
3755 case DWC3_DEVICE_EVENT_HIBER_REQ:
3756 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
3757 "unexpected hibernation event\n"))
3760 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
3762 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
3763 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
3765 case DWC3_DEVICE_EVENT_SUSPEND:
3766 /* It changed to be suspend event for version 2.30a and above */
3767 if (!DWC3_VER_IS_PRIOR(DWC3, 230A)) {
3769 * Ignore suspend event until the gadget enters into
3770 * USB_STATE_CONFIGURED state.
3772 if (dwc->gadget->state >= USB_STATE_CONFIGURED)
3773 dwc3_gadget_suspend_interrupt(dwc,
3777 case DWC3_DEVICE_EVENT_SOF:
3778 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
3779 case DWC3_DEVICE_EVENT_CMD_CMPL:
3780 case DWC3_DEVICE_EVENT_OVERFLOW:
3783 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
3787 static void dwc3_process_event_entry(struct dwc3 *dwc,
3788 const union dwc3_event *event)
3790 trace_dwc3_event(event->raw, dwc);
3792 if (!event->type.is_devspec)
3793 dwc3_endpoint_interrupt(dwc, &event->depevt);
3794 else if (event->type.type == DWC3_EVENT_TYPE_DEV)
3795 dwc3_gadget_interrupt(dwc, &event->devt);
3797 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
3800 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
3802 struct dwc3 *dwc = evt->dwc;
3803 irqreturn_t ret = IRQ_NONE;
3809 if (!(evt->flags & DWC3_EVENT_PENDING))
3813 union dwc3_event event;
3815 event.raw = *(u32 *) (evt->cache + evt->lpos);
3817 dwc3_process_event_entry(dwc, &event);
3820 * FIXME we wrap around correctly to the next entry as
3821 * almost all entries are 4 bytes in size. There is one
3822 * entry which has 12 bytes which is a regular entry
3823 * followed by 8 bytes data. ATM I don't know how
3824 * things are organized if we get next to the a
3825 * boundary so I worry about that once we try to handle
3828 evt->lpos = (evt->lpos + 4) % evt->length;
3833 evt->flags &= ~DWC3_EVENT_PENDING;
3836 /* Unmask interrupt */
3837 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3838 reg &= ~DWC3_GEVNTSIZ_INTMASK;
3839 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3841 if (dwc->imod_interval) {
3842 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
3843 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
3849 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
3851 struct dwc3_event_buffer *evt = _evt;
3852 struct dwc3 *dwc = evt->dwc;
3853 unsigned long flags;
3854 irqreturn_t ret = IRQ_NONE;
3856 spin_lock_irqsave(&dwc->lock, flags);
3857 ret = dwc3_process_event_buf(evt);
3858 spin_unlock_irqrestore(&dwc->lock, flags);
3863 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
3865 struct dwc3 *dwc = evt->dwc;
3870 if (pm_runtime_suspended(dwc->dev)) {
3871 pm_runtime_get(dwc->dev);
3872 disable_irq_nosync(dwc->irq_gadget);
3873 dwc->pending_events = true;
3878 * With PCIe legacy interrupt, test shows that top-half irq handler can
3879 * be called again after HW interrupt deassertion. Check if bottom-half
3880 * irq event handler completes before caching new event to prevent
3883 if (evt->flags & DWC3_EVENT_PENDING)
3886 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
3887 count &= DWC3_GEVNTCOUNT_MASK;
3892 evt->flags |= DWC3_EVENT_PENDING;
3894 /* Mask interrupt */
3895 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3896 reg |= DWC3_GEVNTSIZ_INTMASK;
3897 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3899 amount = min(count, evt->length - evt->lpos);
3900 memcpy(evt->cache + evt->lpos, evt->buf + evt->lpos, amount);
3903 memcpy(evt->cache, evt->buf, count - amount);
3905 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
3907 return IRQ_WAKE_THREAD;
3910 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
3912 struct dwc3_event_buffer *evt = _evt;
3914 return dwc3_check_event_buf(evt);
3917 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
3919 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
3922 irq = platform_get_irq_byname_optional(dwc3_pdev, "peripheral");
3926 if (irq == -EPROBE_DEFER)
3929 irq = platform_get_irq_byname_optional(dwc3_pdev, "dwc_usb3");
3933 if (irq == -EPROBE_DEFER)
3936 irq = platform_get_irq(dwc3_pdev, 0);
3947 static void dwc_gadget_release(struct device *dev)
3949 struct usb_gadget *gadget = container_of(dev, struct usb_gadget, dev);
3955 * dwc3_gadget_init - initializes gadget related registers
3956 * @dwc: pointer to our controller context structure
3958 * Returns 0 on success otherwise negative errno.
3960 int dwc3_gadget_init(struct dwc3 *dwc)
3966 irq = dwc3_gadget_get_irq(dwc);
3972 dwc->irq_gadget = irq;
3974 dwc->ep0_trb = dma_alloc_coherent(dwc->sysdev,
3975 sizeof(*dwc->ep0_trb) * 2,
3976 &dwc->ep0_trb_addr, GFP_KERNEL);
3977 if (!dwc->ep0_trb) {
3978 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
3983 dwc->setup_buf = kzalloc(DWC3_EP0_SETUP_SIZE, GFP_KERNEL);
3984 if (!dwc->setup_buf) {
3989 dwc->bounce = dma_alloc_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE,
3990 &dwc->bounce_addr, GFP_KERNEL);
3996 init_completion(&dwc->ep0_in_setup);
3997 dwc->gadget = kzalloc(sizeof(struct usb_gadget), GFP_KERNEL);
4004 usb_initialize_gadget(dwc->dev, dwc->gadget, dwc_gadget_release);
4005 dev = &dwc->gadget->dev;
4006 dev->platform_data = dwc;
4007 dwc->gadget->ops = &dwc3_gadget_ops;
4008 dwc->gadget->speed = USB_SPEED_UNKNOWN;
4009 dwc->gadget->ssp_rate = USB_SSP_GEN_UNKNOWN;
4010 dwc->gadget->sg_supported = true;
4011 dwc->gadget->name = "dwc3-gadget";
4012 dwc->gadget->lpm_capable = !dwc->usb2_gadget_lpm_disable;
4015 * FIXME We might be setting max_speed to <SUPER, however versions
4016 * <2.20a of dwc3 have an issue with metastability (documented
4017 * elsewhere in this driver) which tells us we can't set max speed to
4018 * anything lower than SUPER.
4020 * Because gadget.max_speed is only used by composite.c and function
4021 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
4022 * to happen so we avoid sending SuperSpeed Capability descriptor
4023 * together with our BOS descriptor as that could confuse host into
4024 * thinking we can handle super speed.
4026 * Note that, in fact, we won't even support GetBOS requests when speed
4027 * is less than super speed because we don't have means, yet, to tell
4028 * composite.c that we are USB 2.0 + LPM ECN.
4030 if (DWC3_VER_IS_PRIOR(DWC3, 220A) &&
4031 !dwc->dis_metastability_quirk)
4032 dev_info(dwc->dev, "changing max_speed on rev %08x\n",
4035 dwc->gadget->max_speed = dwc->maximum_speed;
4036 dwc->gadget->max_ssp_rate = dwc->max_ssp_rate;
4039 * REVISIT: Here we should clear all pending IRQs to be
4040 * sure we're starting from a well known location.
4043 ret = dwc3_gadget_init_endpoints(dwc, dwc->num_eps);
4047 ret = usb_add_gadget(dwc->gadget);
4049 dev_err(dwc->dev, "failed to add gadget\n");
4053 if (DWC3_IP_IS(DWC32) && dwc->maximum_speed == USB_SPEED_SUPER_PLUS)
4054 dwc3_gadget_set_ssp_rate(dwc->gadget, dwc->max_ssp_rate);
4056 dwc3_gadget_set_speed(dwc->gadget, dwc->maximum_speed);
4061 dwc3_gadget_free_endpoints(dwc);
4063 usb_put_gadget(dwc->gadget);
4066 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
4070 kfree(dwc->setup_buf);
4073 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
4074 dwc->ep0_trb, dwc->ep0_trb_addr);
4080 /* -------------------------------------------------------------------------- */
4082 void dwc3_gadget_exit(struct dwc3 *dwc)
4087 usb_del_gadget(dwc->gadget);
4088 dwc3_gadget_free_endpoints(dwc);
4089 usb_put_gadget(dwc->gadget);
4090 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
4092 kfree(dwc->setup_buf);
4093 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
4094 dwc->ep0_trb, dwc->ep0_trb_addr);
4097 int dwc3_gadget_suspend(struct dwc3 *dwc)
4099 if (!dwc->gadget_driver)
4102 dwc3_gadget_run_stop(dwc, false, false);
4103 dwc3_disconnect_gadget(dwc);
4104 __dwc3_gadget_stop(dwc);
4109 int dwc3_gadget_resume(struct dwc3 *dwc)
4113 if (!dwc->gadget_driver)
4116 ret = __dwc3_gadget_start(dwc);
4120 ret = dwc3_gadget_run_stop(dwc, true, false);
4127 __dwc3_gadget_stop(dwc);
4133 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
4135 if (dwc->pending_events) {
4136 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
4137 dwc->pending_events = false;
4138 enable_irq(dwc->irq_gadget);