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_calc_tx_fifo_size - calculates the txfifo size value
636 * @dwc: pointer to the DWC3 context
637 * @nfifos: number of fifos to calculate for
639 * Calculates the size value based on the equation below:
641 * DWC3 revision 280A and prior:
642 * fifo_size = mult * (max_packet / mdwidth) + 1;
644 * DWC3 revision 290A and onwards:
645 * fifo_size = mult * ((max_packet + mdwidth)/mdwidth + 1) + 1
647 * The max packet size is set to 1024, as the txfifo requirements mainly apply
648 * to super speed USB use cases. However, it is safe to overestimate the fifo
649 * allocations for other scenarios, i.e. high speed USB.
651 static int dwc3_gadget_calc_tx_fifo_size(struct dwc3 *dwc, int mult)
653 int max_packet = 1024;
657 mdwidth = dwc3_mdwidth(dwc);
659 /* MDWIDTH is represented in bits, we need it in bytes */
662 if (DWC3_VER_IS_PRIOR(DWC3, 290A))
663 fifo_size = mult * (max_packet / mdwidth) + 1;
665 fifo_size = mult * ((max_packet + mdwidth) / mdwidth) + 1;
670 * dwc3_gadget_clear_tx_fifo_size - Clears txfifo allocation
671 * @dwc: pointer to the DWC3 context
673 * Iterates through all the endpoint registers and clears the previous txfifo
676 void dwc3_gadget_clear_tx_fifos(struct dwc3 *dwc)
683 if (!dwc->do_fifo_resize)
686 /* Read ep0IN related TXFIFO size */
688 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(0));
689 if (DWC3_IP_IS(DWC3))
690 fifo_depth = DWC3_GTXFIFOSIZ_TXFDEP(size);
692 fifo_depth = DWC31_GTXFIFOSIZ_TXFDEP(size);
694 dwc->last_fifo_depth = fifo_depth;
695 /* Clear existing TXFIFO for all IN eps except ep0 */
696 for (num = 3; num < min_t(int, dwc->num_eps, DWC3_ENDPOINTS_NUM);
699 /* Don't change TXFRAMNUM on usb31 version */
700 size = DWC3_IP_IS(DWC3) ? 0 :
701 dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(num >> 1)) &
702 DWC31_GTXFIFOSIZ_TXFRAMNUM;
704 dwc3_writel(dwc->regs, DWC3_GTXFIFOSIZ(num >> 1), size);
705 dep->flags &= ~DWC3_EP_TXFIFO_RESIZED;
707 dwc->num_ep_resized = 0;
711 * dwc3_gadget_resize_tx_fifos - reallocate fifo spaces for current use-case
712 * @dwc: pointer to our context structure
714 * This function will a best effort FIFO allocation in order
715 * to improve FIFO usage and throughput, while still allowing
716 * us to enable as many endpoints as possible.
718 * Keep in mind that this operation will be highly dependent
719 * on the configured size for RAM1 - which contains TxFifo -,
720 * the amount of endpoints enabled on coreConsultant tool, and
721 * the width of the Master Bus.
723 * In general, FIFO depths are represented with the following equation:
725 * fifo_size = mult * ((max_packet + mdwidth)/mdwidth + 1) + 1
727 * In conjunction with dwc3_gadget_check_config(), this resizing logic will
728 * ensure that all endpoints will have enough internal memory for one max
729 * packet per endpoint.
731 static int dwc3_gadget_resize_tx_fifos(struct dwc3_ep *dep)
733 struct dwc3 *dwc = dep->dwc;
744 if (!dwc->do_fifo_resize)
747 /* resize IN endpoints except ep0 */
748 if (!usb_endpoint_dir_in(dep->endpoint.desc) || dep->number <= 1)
751 /* bail if already resized */
752 if (dep->flags & DWC3_EP_TXFIFO_RESIZED)
755 ram1_depth = DWC3_RAM1_DEPTH(dwc->hwparams.hwparams7);
757 if ((dep->endpoint.maxburst > 1 &&
758 usb_endpoint_xfer_bulk(dep->endpoint.desc)) ||
759 usb_endpoint_xfer_isoc(dep->endpoint.desc))
762 if (dep->endpoint.maxburst > 6 &&
763 usb_endpoint_xfer_bulk(dep->endpoint.desc) && DWC3_IP_IS(DWC31))
764 num_fifos = dwc->tx_fifo_resize_max_num;
766 /* FIFO size for a single buffer */
767 fifo = dwc3_gadget_calc_tx_fifo_size(dwc, 1);
769 /* Calculate the number of remaining EPs w/o any FIFO */
770 num_in_ep = dwc->max_cfg_eps;
771 num_in_ep -= dwc->num_ep_resized;
773 /* Reserve at least one FIFO for the number of IN EPs */
774 min_depth = num_in_ep * (fifo + 1);
775 remaining = ram1_depth - min_depth - dwc->last_fifo_depth;
776 remaining = max_t(int, 0, remaining);
778 * We've already reserved 1 FIFO per EP, so check what we can fit in
779 * addition to it. If there is not enough remaining space, allocate
780 * all the remaining space to the EP.
782 fifo_size = (num_fifos - 1) * fifo;
783 if (remaining < fifo_size)
784 fifo_size = remaining;
787 /* Last increment according to the TX FIFO size equation */
790 /* Check if TXFIFOs start at non-zero addr */
791 tmp = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(0));
792 fifo_0_start = DWC3_GTXFIFOSIZ_TXFSTADDR(tmp);
794 fifo_size |= (fifo_0_start + (dwc->last_fifo_depth << 16));
795 if (DWC3_IP_IS(DWC3))
796 dwc->last_fifo_depth += DWC3_GTXFIFOSIZ_TXFDEP(fifo_size);
798 dwc->last_fifo_depth += DWC31_GTXFIFOSIZ_TXFDEP(fifo_size);
800 /* Check fifo size allocation doesn't exceed available RAM size. */
801 if (dwc->last_fifo_depth >= ram1_depth) {
802 dev_err(dwc->dev, "Fifosize(%d) > RAM size(%d) %s depth:%d\n",
803 dwc->last_fifo_depth, ram1_depth,
804 dep->endpoint.name, fifo_size);
805 if (DWC3_IP_IS(DWC3))
806 fifo_size = DWC3_GTXFIFOSIZ_TXFDEP(fifo_size);
808 fifo_size = DWC31_GTXFIFOSIZ_TXFDEP(fifo_size);
810 dwc->last_fifo_depth -= fifo_size;
814 dwc3_writel(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1), fifo_size);
815 dep->flags |= DWC3_EP_TXFIFO_RESIZED;
816 dwc->num_ep_resized++;
822 * __dwc3_gadget_ep_enable - initializes a hw endpoint
823 * @dep: endpoint to be initialized
824 * @action: one of INIT, MODIFY or RESTORE
826 * Caller should take care of locking. Execute all necessary commands to
827 * initialize a HW endpoint so it can be used by a gadget driver.
829 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep, unsigned int action)
831 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
832 struct dwc3 *dwc = dep->dwc;
837 if (!(dep->flags & DWC3_EP_ENABLED)) {
838 ret = dwc3_gadget_resize_tx_fifos(dep);
842 ret = dwc3_gadget_start_config(dep);
847 ret = dwc3_gadget_set_ep_config(dep, action);
851 if (!(dep->flags & DWC3_EP_ENABLED)) {
852 struct dwc3_trb *trb_st_hw;
853 struct dwc3_trb *trb_link;
855 dep->type = usb_endpoint_type(desc);
856 dep->flags |= DWC3_EP_ENABLED;
858 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
859 reg |= DWC3_DALEPENA_EP(dep->number);
860 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
862 if (usb_endpoint_xfer_control(desc))
865 /* Initialize the TRB ring */
866 dep->trb_dequeue = 0;
867 dep->trb_enqueue = 0;
868 memset(dep->trb_pool, 0,
869 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
871 /* Link TRB. The HWO bit is never reset */
872 trb_st_hw = &dep->trb_pool[0];
874 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
875 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
876 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
877 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
878 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
882 * Issue StartTransfer here with no-op TRB so we can always rely on No
883 * Response Update Transfer command.
885 if (usb_endpoint_xfer_bulk(desc) ||
886 usb_endpoint_xfer_int(desc)) {
887 struct dwc3_gadget_ep_cmd_params params;
888 struct dwc3_trb *trb;
892 memset(¶ms, 0, sizeof(params));
893 trb = &dep->trb_pool[0];
894 trb_dma = dwc3_trb_dma_offset(dep, trb);
896 params.param0 = upper_32_bits(trb_dma);
897 params.param1 = lower_32_bits(trb_dma);
899 cmd = DWC3_DEPCMD_STARTTRANSFER;
901 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
905 if (dep->stream_capable) {
907 * For streams, at start, there maybe a race where the
908 * host primes the endpoint before the function driver
909 * queues a request to initiate a stream. In that case,
910 * the controller will not see the prime to generate the
911 * ERDY and start stream. To workaround this, issue a
912 * no-op TRB as normal, but end it immediately. As a
913 * result, when the function driver queues the request,
914 * the next START_TRANSFER command will cause the
915 * controller to generate an ERDY to initiate the
918 dwc3_stop_active_transfer(dep, true, true);
921 * All stream eps will reinitiate stream on NoStream
922 * rejection until we can determine that the host can
923 * prime after the first transfer.
925 * However, if the controller is capable of
926 * TXF_FLUSH_BYPASS, then IN direction endpoints will
927 * automatically restart the stream without the driver
930 if (!dep->direction ||
931 !(dwc->hwparams.hwparams9 &
932 DWC3_GHWPARAMS9_DEV_TXF_FLUSH_BYPASS))
933 dep->flags |= DWC3_EP_FORCE_RESTART_STREAM;
938 trace_dwc3_gadget_ep_enable(dep);
943 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
945 struct dwc3_request *req;
947 dwc3_stop_active_transfer(dep, true, false);
949 /* - giveback all requests to gadget driver */
950 while (!list_empty(&dep->started_list)) {
951 req = next_request(&dep->started_list);
953 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
956 while (!list_empty(&dep->pending_list)) {
957 req = next_request(&dep->pending_list);
959 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
962 while (!list_empty(&dep->cancelled_list)) {
963 req = next_request(&dep->cancelled_list);
965 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
970 * __dwc3_gadget_ep_disable - disables a hw endpoint
971 * @dep: the endpoint to disable
973 * This function undoes what __dwc3_gadget_ep_enable did and also removes
974 * requests which are currently being processed by the hardware and those which
975 * are not yet scheduled.
977 * Caller should take care of locking.
979 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
981 struct dwc3 *dwc = dep->dwc;
984 trace_dwc3_gadget_ep_disable(dep);
986 /* make sure HW endpoint isn't stalled */
987 if (dep->flags & DWC3_EP_STALL)
988 __dwc3_gadget_ep_set_halt(dep, 0, false);
990 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
991 reg &= ~DWC3_DALEPENA_EP(dep->number);
992 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
994 /* Clear out the ep descriptors for non-ep0 */
995 if (dep->number > 1) {
996 dep->endpoint.comp_desc = NULL;
997 dep->endpoint.desc = NULL;
1000 dwc3_remove_requests(dwc, dep);
1002 dep->stream_capable = false;
1004 dep->flags &= DWC3_EP_TXFIFO_RESIZED;
1009 /* -------------------------------------------------------------------------- */
1011 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
1012 const struct usb_endpoint_descriptor *desc)
1017 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
1022 /* -------------------------------------------------------------------------- */
1024 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
1025 const struct usb_endpoint_descriptor *desc)
1027 struct dwc3_ep *dep;
1029 unsigned long flags;
1032 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
1033 pr_debug("dwc3: invalid parameters\n");
1037 if (!desc->wMaxPacketSize) {
1038 pr_debug("dwc3: missing wMaxPacketSize\n");
1042 dep = to_dwc3_ep(ep);
1045 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
1046 "%s is already enabled\n",
1050 spin_lock_irqsave(&dwc->lock, flags);
1051 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
1052 spin_unlock_irqrestore(&dwc->lock, flags);
1057 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
1059 struct dwc3_ep *dep;
1061 unsigned long flags;
1065 pr_debug("dwc3: invalid parameters\n");
1069 dep = to_dwc3_ep(ep);
1072 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
1073 "%s is already disabled\n",
1077 spin_lock_irqsave(&dwc->lock, flags);
1078 ret = __dwc3_gadget_ep_disable(dep);
1079 spin_unlock_irqrestore(&dwc->lock, flags);
1084 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
1087 struct dwc3_request *req;
1088 struct dwc3_ep *dep = to_dwc3_ep(ep);
1090 req = kzalloc(sizeof(*req), gfp_flags);
1094 req->direction = dep->direction;
1095 req->epnum = dep->number;
1097 req->status = DWC3_REQUEST_STATUS_UNKNOWN;
1099 trace_dwc3_alloc_request(req);
1101 return &req->request;
1104 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
1105 struct usb_request *request)
1107 struct dwc3_request *req = to_dwc3_request(request);
1109 trace_dwc3_free_request(req);
1114 * dwc3_ep_prev_trb - returns the previous TRB in the ring
1115 * @dep: The endpoint with the TRB ring
1116 * @index: The index of the current TRB in the ring
1118 * Returns the TRB prior to the one pointed to by the index. If the
1119 * index is 0, we will wrap backwards, skip the link TRB, and return
1120 * the one just before that.
1122 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
1127 tmp = DWC3_TRB_NUM - 1;
1129 return &dep->trb_pool[tmp - 1];
1132 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
1137 * If the enqueue & dequeue are equal then the TRB ring is either full
1138 * or empty. It's considered full when there are DWC3_TRB_NUM-1 of TRBs
1139 * pending to be processed by the driver.
1141 if (dep->trb_enqueue == dep->trb_dequeue) {
1143 * If there is any request remained in the started_list at
1144 * this point, that means there is no TRB available.
1146 if (!list_empty(&dep->started_list))
1149 return DWC3_TRB_NUM - 1;
1152 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
1153 trbs_left &= (DWC3_TRB_NUM - 1);
1155 if (dep->trb_dequeue < dep->trb_enqueue)
1161 static void __dwc3_prepare_one_trb(struct dwc3_ep *dep, struct dwc3_trb *trb,
1162 dma_addr_t dma, unsigned int length, unsigned int chain,
1163 unsigned int node, unsigned int stream_id,
1164 unsigned int short_not_ok, unsigned int no_interrupt,
1165 unsigned int is_last, bool must_interrupt)
1167 struct dwc3 *dwc = dep->dwc;
1168 struct usb_gadget *gadget = dwc->gadget;
1169 enum usb_device_speed speed = gadget->speed;
1171 trb->size = DWC3_TRB_SIZE_LENGTH(length);
1172 trb->bpl = lower_32_bits(dma);
1173 trb->bph = upper_32_bits(dma);
1175 switch (usb_endpoint_type(dep->endpoint.desc)) {
1176 case USB_ENDPOINT_XFER_CONTROL:
1177 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
1180 case USB_ENDPOINT_XFER_ISOC:
1182 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
1185 * USB Specification 2.0 Section 5.9.2 states that: "If
1186 * there is only a single transaction in the microframe,
1187 * only a DATA0 data packet PID is used. If there are
1188 * two transactions per microframe, DATA1 is used for
1189 * the first transaction data packet and DATA0 is used
1190 * for the second transaction data packet. If there are
1191 * three transactions per microframe, DATA2 is used for
1192 * the first transaction data packet, DATA1 is used for
1193 * the second, and DATA0 is used for the third."
1195 * IOW, we should satisfy the following cases:
1197 * 1) length <= maxpacket
1200 * 2) maxpacket < length <= (2 * maxpacket)
1203 * 3) (2 * maxpacket) < length <= (3 * maxpacket)
1204 * - DATA2, DATA1, DATA0
1206 if (speed == USB_SPEED_HIGH) {
1207 struct usb_ep *ep = &dep->endpoint;
1208 unsigned int mult = 2;
1209 unsigned int maxp = usb_endpoint_maxp(ep->desc);
1211 if (length <= (2 * maxp))
1217 trb->size |= DWC3_TRB_SIZE_PCM1(mult);
1220 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
1223 /* always enable Interrupt on Missed ISOC */
1224 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
1227 case USB_ENDPOINT_XFER_BULK:
1228 case USB_ENDPOINT_XFER_INT:
1229 trb->ctrl = DWC3_TRBCTL_NORMAL;
1233 * This is only possible with faulty memory because we
1234 * checked it already :)
1236 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
1237 usb_endpoint_type(dep->endpoint.desc));
1241 * Enable Continue on Short Packet
1242 * when endpoint is not a stream capable
1244 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
1245 if (!dep->stream_capable)
1246 trb->ctrl |= DWC3_TRB_CTRL_CSP;
1249 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
1252 if ((!no_interrupt && !chain) || must_interrupt)
1253 trb->ctrl |= DWC3_TRB_CTRL_IOC;
1256 trb->ctrl |= DWC3_TRB_CTRL_CHN;
1257 else if (dep->stream_capable && is_last)
1258 trb->ctrl |= DWC3_TRB_CTRL_LST;
1260 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
1261 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(stream_id);
1263 trb->ctrl |= DWC3_TRB_CTRL_HWO;
1265 dwc3_ep_inc_enq(dep);
1267 trace_dwc3_prepare_trb(dep, trb);
1271 * dwc3_prepare_one_trb - setup one TRB from one request
1272 * @dep: endpoint for which this request is prepared
1273 * @req: dwc3_request pointer
1274 * @trb_length: buffer size of the TRB
1275 * @chain: should this TRB be chained to the next?
1276 * @node: only for isochronous endpoints. First TRB needs different type.
1277 * @use_bounce_buffer: set to use bounce buffer
1278 * @must_interrupt: set to interrupt on TRB completion
1280 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
1281 struct dwc3_request *req, unsigned int trb_length,
1282 unsigned int chain, unsigned int node, bool use_bounce_buffer,
1283 bool must_interrupt)
1285 struct dwc3_trb *trb;
1287 unsigned int stream_id = req->request.stream_id;
1288 unsigned int short_not_ok = req->request.short_not_ok;
1289 unsigned int no_interrupt = req->request.no_interrupt;
1290 unsigned int is_last = req->request.is_last;
1292 if (use_bounce_buffer)
1293 dma = dep->dwc->bounce_addr;
1294 else if (req->request.num_sgs > 0)
1295 dma = sg_dma_address(req->start_sg);
1297 dma = req->request.dma;
1299 trb = &dep->trb_pool[dep->trb_enqueue];
1302 dwc3_gadget_move_started_request(req);
1304 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
1309 __dwc3_prepare_one_trb(dep, trb, dma, trb_length, chain, node,
1310 stream_id, short_not_ok, no_interrupt, is_last,
1314 static bool dwc3_needs_extra_trb(struct dwc3_ep *dep, struct dwc3_request *req)
1316 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1317 unsigned int rem = req->request.length % maxp;
1319 if ((req->request.length && req->request.zero && !rem &&
1320 !usb_endpoint_xfer_isoc(dep->endpoint.desc)) ||
1321 (!req->direction && rem))
1328 * dwc3_prepare_last_sg - prepare TRBs for the last SG entry
1329 * @dep: The endpoint that the request belongs to
1330 * @req: The request to prepare
1331 * @entry_length: The last SG entry size
1332 * @node: Indicates whether this is not the first entry (for isoc only)
1334 * Return the number of TRBs prepared.
1336 static int dwc3_prepare_last_sg(struct dwc3_ep *dep,
1337 struct dwc3_request *req, unsigned int entry_length,
1340 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1341 unsigned int rem = req->request.length % maxp;
1342 unsigned int num_trbs = 1;
1344 if (dwc3_needs_extra_trb(dep, req))
1347 if (dwc3_calc_trbs_left(dep) < num_trbs)
1350 req->needs_extra_trb = num_trbs > 1;
1352 /* Prepare a normal TRB */
1353 if (req->direction || req->request.length)
1354 dwc3_prepare_one_trb(dep, req, entry_length,
1355 req->needs_extra_trb, node, false, false);
1357 /* Prepare extra TRBs for ZLP and MPS OUT transfer alignment */
1358 if ((!req->direction && !req->request.length) || req->needs_extra_trb)
1359 dwc3_prepare_one_trb(dep, req,
1360 req->direction ? 0 : maxp - rem,
1361 false, 1, true, false);
1366 static int dwc3_prepare_trbs_sg(struct dwc3_ep *dep,
1367 struct dwc3_request *req)
1369 struct scatterlist *sg = req->start_sg;
1370 struct scatterlist *s;
1372 unsigned int length = req->request.length;
1373 unsigned int remaining = req->request.num_mapped_sgs
1374 - req->num_queued_sgs;
1375 unsigned int num_trbs = req->num_trbs;
1376 bool needs_extra_trb = dwc3_needs_extra_trb(dep, req);
1379 * If we resume preparing the request, then get the remaining length of
1380 * the request and resume where we left off.
1382 for_each_sg(req->request.sg, s, req->num_queued_sgs, i)
1383 length -= sg_dma_len(s);
1385 for_each_sg(sg, s, remaining, i) {
1386 unsigned int num_trbs_left = dwc3_calc_trbs_left(dep);
1387 unsigned int trb_length;
1388 bool must_interrupt = false;
1389 bool last_sg = false;
1391 trb_length = min_t(unsigned int, length, sg_dma_len(s));
1393 length -= trb_length;
1396 * IOMMU driver is coalescing the list of sgs which shares a
1397 * page boundary into one and giving it to USB driver. With
1398 * this the number of sgs mapped is not equal to the number of
1399 * sgs passed. So mark the chain bit to false if it isthe last
1402 if ((i == remaining - 1) || !length)
1409 if (!dwc3_prepare_last_sg(dep, req, trb_length, i))
1413 * Look ahead to check if we have enough TRBs for the
1414 * next SG entry. If not, set interrupt on this TRB to
1415 * resume preparing the next SG entry when more TRBs are
1418 if (num_trbs_left == 1 || (needs_extra_trb &&
1419 num_trbs_left <= 2 &&
1420 sg_dma_len(sg_next(s)) >= length))
1421 must_interrupt = true;
1423 dwc3_prepare_one_trb(dep, req, trb_length, 1, i, false,
1428 * There can be a situation where all sgs in sglist are not
1429 * queued because of insufficient trb number. To handle this
1430 * case, update start_sg to next sg to be queued, so that
1431 * we have free trbs we can continue queuing from where we
1432 * previously stopped
1435 req->start_sg = sg_next(s);
1437 req->num_queued_sgs++;
1438 req->num_pending_sgs--;
1441 * The number of pending SG entries may not correspond to the
1442 * number of mapped SG entries. If all the data are queued, then
1443 * don't include unused SG entries.
1446 req->num_pending_sgs = 0;
1454 return req->num_trbs - num_trbs;
1457 static int dwc3_prepare_trbs_linear(struct dwc3_ep *dep,
1458 struct dwc3_request *req)
1460 return dwc3_prepare_last_sg(dep, req, req->request.length, 0);
1464 * dwc3_prepare_trbs - setup TRBs from requests
1465 * @dep: endpoint for which requests are being prepared
1467 * The function goes through the requests list and sets up TRBs for the
1468 * transfers. The function returns once there are no more TRBs available or
1469 * it runs out of requests.
1471 * Returns the number of TRBs prepared or negative errno.
1473 static int dwc3_prepare_trbs(struct dwc3_ep *dep)
1475 struct dwc3_request *req, *n;
1478 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1481 * We can get in a situation where there's a request in the started list
1482 * but there weren't enough TRBs to fully kick it in the first time
1483 * around, so it has been waiting for more TRBs to be freed up.
1485 * In that case, we should check if we have a request with pending_sgs
1486 * in the started list and prepare TRBs for that request first,
1487 * otherwise we will prepare TRBs completely out of order and that will
1490 list_for_each_entry(req, &dep->started_list, list) {
1491 if (req->num_pending_sgs > 0) {
1492 ret = dwc3_prepare_trbs_sg(dep, req);
1493 if (!ret || req->num_pending_sgs)
1497 if (!dwc3_calc_trbs_left(dep))
1501 * Don't prepare beyond a transfer. In DWC_usb32, its transfer
1502 * burst capability may try to read and use TRBs beyond the
1503 * active transfer instead of stopping.
1505 if (dep->stream_capable && req->request.is_last)
1509 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1510 struct dwc3 *dwc = dep->dwc;
1512 ret = usb_gadget_map_request_by_dev(dwc->sysdev, &req->request,
1517 req->sg = req->request.sg;
1518 req->start_sg = req->sg;
1519 req->num_queued_sgs = 0;
1520 req->num_pending_sgs = req->request.num_mapped_sgs;
1522 if (req->num_pending_sgs > 0) {
1523 ret = dwc3_prepare_trbs_sg(dep, req);
1524 if (req->num_pending_sgs)
1527 ret = dwc3_prepare_trbs_linear(dep, req);
1530 if (!ret || !dwc3_calc_trbs_left(dep))
1534 * Don't prepare beyond a transfer. In DWC_usb32, its transfer
1535 * burst capability may try to read and use TRBs beyond the
1536 * active transfer instead of stopping.
1538 if (dep->stream_capable && req->request.is_last)
1545 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep);
1547 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep)
1549 struct dwc3_gadget_ep_cmd_params params;
1550 struct dwc3_request *req;
1556 * Note that it's normal to have no new TRBs prepared (i.e. ret == 0).
1557 * This happens when we need to stop and restart a transfer such as in
1558 * the case of reinitiating a stream or retrying an isoc transfer.
1560 ret = dwc3_prepare_trbs(dep);
1564 starting = !(dep->flags & DWC3_EP_TRANSFER_STARTED);
1567 * If there's no new TRB prepared and we don't need to restart a
1568 * transfer, there's no need to update the transfer.
1570 if (!ret && !starting)
1573 req = next_request(&dep->started_list);
1575 dep->flags |= DWC3_EP_PENDING_REQUEST;
1579 memset(¶ms, 0, sizeof(params));
1582 params.param0 = upper_32_bits(req->trb_dma);
1583 params.param1 = lower_32_bits(req->trb_dma);
1584 cmd = DWC3_DEPCMD_STARTTRANSFER;
1586 if (dep->stream_capable)
1587 cmd |= DWC3_DEPCMD_PARAM(req->request.stream_id);
1589 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1590 cmd |= DWC3_DEPCMD_PARAM(dep->frame_number);
1592 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1593 DWC3_DEPCMD_PARAM(dep->resource_index);
1596 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1598 struct dwc3_request *tmp;
1603 dwc3_stop_active_transfer(dep, true, true);
1605 list_for_each_entry_safe(req, tmp, &dep->started_list, list)
1606 dwc3_gadget_move_cancelled_request(req, DWC3_REQUEST_STATUS_DEQUEUED);
1608 /* If ep isn't started, then there's no end transfer pending */
1609 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
1610 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
1615 if (dep->stream_capable && req->request.is_last)
1616 dep->flags |= DWC3_EP_WAIT_TRANSFER_COMPLETE;
1621 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1625 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1626 return DWC3_DSTS_SOFFN(reg);
1630 * dwc3_gadget_start_isoc_quirk - workaround invalid frame number
1631 * @dep: isoc endpoint
1633 * This function tests for the correct combination of BIT[15:14] from the 16-bit
1634 * microframe number reported by the XferNotReady event for the future frame
1635 * number to start the isoc transfer.
1637 * In DWC_usb31 version 1.70a-ea06 and prior, for highspeed and fullspeed
1638 * isochronous IN, BIT[15:14] of the 16-bit microframe number reported by the
1639 * XferNotReady event are invalid. The driver uses this number to schedule the
1640 * isochronous transfer and passes it to the START TRANSFER command. Because
1641 * this number is invalid, the command may fail. If BIT[15:14] matches the
1642 * internal 16-bit microframe, the START TRANSFER command will pass and the
1643 * transfer will start at the scheduled time, if it is off by 1, the command
1644 * will still pass, but the transfer will start 2 seconds in the future. For all
1645 * other conditions, the START TRANSFER command will fail with bus-expiry.
1647 * In order to workaround this issue, we can test for the correct combination of
1648 * BIT[15:14] by sending START TRANSFER commands with different values of
1649 * BIT[15:14]: 'b00, 'b01, 'b10, and 'b11. Each combination is 2^14 uframe apart
1650 * (or 2 seconds). 4 seconds into the future will result in a bus-expiry status.
1651 * As the result, within the 4 possible combinations for BIT[15:14], there will
1652 * be 2 successful and 2 failure START COMMAND status. One of the 2 successful
1653 * command status will result in a 2-second delay start. The smaller BIT[15:14]
1654 * value is the correct combination.
1656 * Since there are only 4 outcomes and the results are ordered, we can simply
1657 * test 2 START TRANSFER commands with BIT[15:14] combinations 'b00 and 'b01 to
1658 * deduce the smaller successful combination.
1660 * Let test0 = test status for combination 'b00 and test1 = test status for 'b01
1661 * of BIT[15:14]. The correct combination is as follow:
1663 * if test0 fails and test1 passes, BIT[15:14] is 'b01
1664 * if test0 fails and test1 fails, BIT[15:14] is 'b10
1665 * if test0 passes and test1 fails, BIT[15:14] is 'b11
1666 * if test0 passes and test1 passes, BIT[15:14] is 'b00
1668 * Synopsys STAR 9001202023: Wrong microframe number for isochronous IN
1671 static int dwc3_gadget_start_isoc_quirk(struct dwc3_ep *dep)
1677 while (dep->combo_num < 2) {
1678 struct dwc3_gadget_ep_cmd_params params;
1679 u32 test_frame_number;
1683 * Check if we can start isoc transfer on the next interval or
1684 * 4 uframes in the future with BIT[15:14] as dep->combo_num
1686 test_frame_number = dep->frame_number & DWC3_FRNUMBER_MASK;
1687 test_frame_number |= dep->combo_num << 14;
1688 test_frame_number += max_t(u32, 4, dep->interval);
1690 params.param0 = upper_32_bits(dep->dwc->bounce_addr);
1691 params.param1 = lower_32_bits(dep->dwc->bounce_addr);
1693 cmd = DWC3_DEPCMD_STARTTRANSFER;
1694 cmd |= DWC3_DEPCMD_PARAM(test_frame_number);
1695 cmd_status = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1697 /* Redo if some other failure beside bus-expiry is received */
1698 if (cmd_status && cmd_status != -EAGAIN) {
1699 dep->start_cmd_status = 0;
1704 /* Store the first test status */
1705 if (dep->combo_num == 0)
1706 dep->start_cmd_status = cmd_status;
1711 * End the transfer if the START_TRANSFER command is successful
1712 * to wait for the next XferNotReady to test the command again
1714 if (cmd_status == 0) {
1715 dwc3_stop_active_transfer(dep, true, true);
1720 /* test0 and test1 are both completed at this point */
1721 test0 = (dep->start_cmd_status == 0);
1722 test1 = (cmd_status == 0);
1724 if (!test0 && test1)
1726 else if (!test0 && !test1)
1728 else if (test0 && !test1)
1730 else if (test0 && test1)
1733 dep->frame_number &= DWC3_FRNUMBER_MASK;
1734 dep->frame_number |= dep->combo_num << 14;
1735 dep->frame_number += max_t(u32, 4, dep->interval);
1737 /* Reinitialize test variables */
1738 dep->start_cmd_status = 0;
1741 return __dwc3_gadget_kick_transfer(dep);
1744 static int __dwc3_gadget_start_isoc(struct dwc3_ep *dep)
1746 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
1747 struct dwc3 *dwc = dep->dwc;
1751 if (list_empty(&dep->pending_list) &&
1752 list_empty(&dep->started_list)) {
1753 dep->flags |= DWC3_EP_PENDING_REQUEST;
1757 if (!dwc->dis_start_transfer_quirk &&
1758 (DWC3_VER_IS_PRIOR(DWC31, 170A) ||
1759 DWC3_VER_TYPE_IS_WITHIN(DWC31, 170A, EA01, EA06))) {
1760 if (dwc->gadget->speed <= USB_SPEED_HIGH && dep->direction)
1761 return dwc3_gadget_start_isoc_quirk(dep);
1764 if (desc->bInterval <= 14 &&
1765 dwc->gadget->speed >= USB_SPEED_HIGH) {
1766 u32 frame = __dwc3_gadget_get_frame(dwc);
1767 bool rollover = frame <
1768 (dep->frame_number & DWC3_FRNUMBER_MASK);
1771 * frame_number is set from XferNotReady and may be already
1772 * out of date. DSTS only provides the lower 14 bit of the
1773 * current frame number. So add the upper two bits of
1774 * frame_number and handle a possible rollover.
1775 * This will provide the correct frame_number unless more than
1776 * rollover has happened since XferNotReady.
1779 dep->frame_number = (dep->frame_number & ~DWC3_FRNUMBER_MASK) |
1782 dep->frame_number += BIT(14);
1785 for (i = 0; i < DWC3_ISOC_MAX_RETRIES; i++) {
1786 dep->frame_number = DWC3_ALIGN_FRAME(dep, i + 1);
1788 ret = __dwc3_gadget_kick_transfer(dep);
1794 * After a number of unsuccessful start attempts due to bus-expiry
1795 * status, issue END_TRANSFER command and retry on the next XferNotReady
1798 if (ret == -EAGAIN) {
1799 struct dwc3_gadget_ep_cmd_params params;
1802 cmd = DWC3_DEPCMD_ENDTRANSFER |
1803 DWC3_DEPCMD_CMDIOC |
1804 DWC3_DEPCMD_PARAM(dep->resource_index);
1806 dep->resource_index = 0;
1807 memset(¶ms, 0, sizeof(params));
1809 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1811 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
1817 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1819 struct dwc3 *dwc = dep->dwc;
1821 if (!dep->endpoint.desc || !dwc->pullups_connected || !dwc->connected) {
1822 dev_dbg(dwc->dev, "%s: can't queue to disabled endpoint\n",
1827 if (WARN(req->dep != dep, "request %pK belongs to '%s'\n",
1828 &req->request, req->dep->name))
1831 if (WARN(req->status < DWC3_REQUEST_STATUS_COMPLETED,
1832 "%s: request %pK already in flight\n",
1833 dep->name, &req->request))
1836 pm_runtime_get(dwc->dev);
1838 req->request.actual = 0;
1839 req->request.status = -EINPROGRESS;
1841 trace_dwc3_ep_queue(req);
1843 list_add_tail(&req->list, &dep->pending_list);
1844 req->status = DWC3_REQUEST_STATUS_QUEUED;
1846 if (dep->flags & DWC3_EP_WAIT_TRANSFER_COMPLETE)
1850 * Start the transfer only after the END_TRANSFER is completed
1851 * and endpoint STALL is cleared.
1853 if ((dep->flags & DWC3_EP_END_TRANSFER_PENDING) ||
1854 (dep->flags & DWC3_EP_WEDGE) ||
1855 (dep->flags & DWC3_EP_STALL)) {
1856 dep->flags |= DWC3_EP_DELAY_START;
1861 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1862 * wait for a XferNotReady event so we will know what's the current
1863 * (micro-)frame number.
1865 * Without this trick, we are very, very likely gonna get Bus Expiry
1866 * errors which will force us issue EndTransfer command.
1868 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1869 if (!(dep->flags & DWC3_EP_PENDING_REQUEST) &&
1870 !(dep->flags & DWC3_EP_TRANSFER_STARTED))
1873 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1874 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
1875 return __dwc3_gadget_start_isoc(dep);
1879 __dwc3_gadget_kick_transfer(dep);
1884 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1887 struct dwc3_request *req = to_dwc3_request(request);
1888 struct dwc3_ep *dep = to_dwc3_ep(ep);
1889 struct dwc3 *dwc = dep->dwc;
1891 unsigned long flags;
1895 spin_lock_irqsave(&dwc->lock, flags);
1896 ret = __dwc3_gadget_ep_queue(dep, req);
1897 spin_unlock_irqrestore(&dwc->lock, flags);
1902 static void dwc3_gadget_ep_skip_trbs(struct dwc3_ep *dep, struct dwc3_request *req)
1906 /* If req->trb is not set, then the request has not started */
1911 * If request was already started, this means we had to
1912 * stop the transfer. With that we also need to ignore
1913 * all TRBs used by the request, however TRBs can only
1914 * be modified after completion of END_TRANSFER
1915 * command. So what we do here is that we wait for
1916 * END_TRANSFER completion and only after that, we jump
1917 * over TRBs by clearing HWO and incrementing dequeue
1920 for (i = 0; i < req->num_trbs; i++) {
1921 struct dwc3_trb *trb;
1923 trb = &dep->trb_pool[dep->trb_dequeue];
1924 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1925 dwc3_ep_inc_deq(dep);
1931 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep)
1933 struct dwc3_request *req;
1934 struct dwc3_request *tmp;
1935 struct dwc3 *dwc = dep->dwc;
1937 list_for_each_entry_safe(req, tmp, &dep->cancelled_list, list) {
1938 dwc3_gadget_ep_skip_trbs(dep, req);
1939 switch (req->status) {
1940 case DWC3_REQUEST_STATUS_DISCONNECTED:
1941 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
1943 case DWC3_REQUEST_STATUS_DEQUEUED:
1944 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1946 case DWC3_REQUEST_STATUS_STALLED:
1947 dwc3_gadget_giveback(dep, req, -EPIPE);
1950 dev_err(dwc->dev, "request cancelled with wrong reason:%d\n", req->status);
1951 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1957 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1958 struct usb_request *request)
1960 struct dwc3_request *req = to_dwc3_request(request);
1961 struct dwc3_request *r = NULL;
1963 struct dwc3_ep *dep = to_dwc3_ep(ep);
1964 struct dwc3 *dwc = dep->dwc;
1966 unsigned long flags;
1969 trace_dwc3_ep_dequeue(req);
1971 spin_lock_irqsave(&dwc->lock, flags);
1973 list_for_each_entry(r, &dep->cancelled_list, list) {
1978 list_for_each_entry(r, &dep->pending_list, list) {
1980 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1985 list_for_each_entry(r, &dep->started_list, list) {
1987 struct dwc3_request *t;
1989 /* wait until it is processed */
1990 dwc3_stop_active_transfer(dep, true, true);
1993 * Remove any started request if the transfer is
1996 list_for_each_entry_safe(r, t, &dep->started_list, list)
1997 dwc3_gadget_move_cancelled_request(r,
1998 DWC3_REQUEST_STATUS_DEQUEUED);
2000 dep->flags &= ~DWC3_EP_WAIT_TRANSFER_COMPLETE;
2006 dev_err(dwc->dev, "request %pK was not queued to %s\n",
2010 spin_unlock_irqrestore(&dwc->lock, flags);
2015 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
2017 struct dwc3_gadget_ep_cmd_params params;
2018 struct dwc3 *dwc = dep->dwc;
2019 struct dwc3_request *req;
2020 struct dwc3_request *tmp;
2023 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2024 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
2028 memset(¶ms, 0x00, sizeof(params));
2031 struct dwc3_trb *trb;
2033 unsigned int transfer_in_flight;
2034 unsigned int started;
2036 if (dep->number > 1)
2037 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
2039 trb = &dwc->ep0_trb[dep->trb_enqueue];
2041 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
2042 started = !list_empty(&dep->started_list);
2044 if (!protocol && ((dep->direction && transfer_in_flight) ||
2045 (!dep->direction && started))) {
2049 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
2052 dev_err(dwc->dev, "failed to set STALL on %s\n",
2055 dep->flags |= DWC3_EP_STALL;
2058 * Don't issue CLEAR_STALL command to control endpoints. The
2059 * controller automatically clears the STALL when it receives
2062 if (dep->number <= 1) {
2063 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
2067 dwc3_stop_active_transfer(dep, true, true);
2069 list_for_each_entry_safe(req, tmp, &dep->started_list, list)
2070 dwc3_gadget_move_cancelled_request(req, DWC3_REQUEST_STATUS_STALLED);
2072 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING) {
2073 dep->flags |= DWC3_EP_PENDING_CLEAR_STALL;
2077 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
2079 ret = dwc3_send_clear_stall_ep_cmd(dep);
2081 dev_err(dwc->dev, "failed to clear STALL on %s\n",
2086 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
2088 if ((dep->flags & DWC3_EP_DELAY_START) &&
2089 !usb_endpoint_xfer_isoc(dep->endpoint.desc))
2090 __dwc3_gadget_kick_transfer(dep);
2092 dep->flags &= ~DWC3_EP_DELAY_START;
2098 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
2100 struct dwc3_ep *dep = to_dwc3_ep(ep);
2101 struct dwc3 *dwc = dep->dwc;
2103 unsigned long flags;
2107 spin_lock_irqsave(&dwc->lock, flags);
2108 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
2109 spin_unlock_irqrestore(&dwc->lock, flags);
2114 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
2116 struct dwc3_ep *dep = to_dwc3_ep(ep);
2117 struct dwc3 *dwc = dep->dwc;
2118 unsigned long flags;
2121 spin_lock_irqsave(&dwc->lock, flags);
2122 dep->flags |= DWC3_EP_WEDGE;
2124 if (dep->number == 0 || dep->number == 1)
2125 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
2127 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
2128 spin_unlock_irqrestore(&dwc->lock, flags);
2133 /* -------------------------------------------------------------------------- */
2135 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
2136 .bLength = USB_DT_ENDPOINT_SIZE,
2137 .bDescriptorType = USB_DT_ENDPOINT,
2138 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
2141 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
2142 .enable = dwc3_gadget_ep0_enable,
2143 .disable = dwc3_gadget_ep0_disable,
2144 .alloc_request = dwc3_gadget_ep_alloc_request,
2145 .free_request = dwc3_gadget_ep_free_request,
2146 .queue = dwc3_gadget_ep0_queue,
2147 .dequeue = dwc3_gadget_ep_dequeue,
2148 .set_halt = dwc3_gadget_ep0_set_halt,
2149 .set_wedge = dwc3_gadget_ep_set_wedge,
2152 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
2153 .enable = dwc3_gadget_ep_enable,
2154 .disable = dwc3_gadget_ep_disable,
2155 .alloc_request = dwc3_gadget_ep_alloc_request,
2156 .free_request = dwc3_gadget_ep_free_request,
2157 .queue = dwc3_gadget_ep_queue,
2158 .dequeue = dwc3_gadget_ep_dequeue,
2159 .set_halt = dwc3_gadget_ep_set_halt,
2160 .set_wedge = dwc3_gadget_ep_set_wedge,
2163 /* -------------------------------------------------------------------------- */
2165 static int dwc3_gadget_get_frame(struct usb_gadget *g)
2167 struct dwc3 *dwc = gadget_to_dwc(g);
2169 return __dwc3_gadget_get_frame(dwc);
2172 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
2182 * According to the Databook Remote wakeup request should
2183 * be issued only when the device is in early suspend state.
2185 * We can check that via USB Link State bits in DSTS register.
2187 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2189 link_state = DWC3_DSTS_USBLNKST(reg);
2191 switch (link_state) {
2192 case DWC3_LINK_STATE_RESET:
2193 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
2194 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
2195 case DWC3_LINK_STATE_U2: /* in HS, means Sleep (L1) */
2196 case DWC3_LINK_STATE_U1:
2197 case DWC3_LINK_STATE_RESUME:
2203 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
2205 dev_err(dwc->dev, "failed to put link in Recovery\n");
2209 /* Recent versions do this automatically */
2210 if (DWC3_VER_IS_PRIOR(DWC3, 194A)) {
2211 /* write zeroes to Link Change Request */
2212 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2213 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
2214 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2217 /* poll until Link State changes to ON */
2221 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2223 /* in HS, means ON */
2224 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
2228 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
2229 dev_err(dwc->dev, "failed to send remote wakeup\n");
2236 static int dwc3_gadget_wakeup(struct usb_gadget *g)
2238 struct dwc3 *dwc = gadget_to_dwc(g);
2239 unsigned long flags;
2242 spin_lock_irqsave(&dwc->lock, flags);
2243 ret = __dwc3_gadget_wakeup(dwc);
2244 spin_unlock_irqrestore(&dwc->lock, flags);
2249 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
2252 struct dwc3 *dwc = gadget_to_dwc(g);
2253 unsigned long flags;
2255 spin_lock_irqsave(&dwc->lock, flags);
2256 g->is_selfpowered = !!is_selfpowered;
2257 spin_unlock_irqrestore(&dwc->lock, flags);
2262 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2266 for (epnum = 2; epnum < dwc->num_eps; epnum++) {
2267 struct dwc3_ep *dep;
2269 dep = dwc->eps[epnum];
2273 dwc3_remove_requests(dwc, dep);
2277 static void __dwc3_gadget_set_ssp_rate(struct dwc3 *dwc)
2279 enum usb_ssp_rate ssp_rate = dwc->gadget_ssp_rate;
2282 if (ssp_rate == USB_SSP_GEN_UNKNOWN)
2283 ssp_rate = dwc->max_ssp_rate;
2285 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2286 reg &= ~DWC3_DCFG_SPEED_MASK;
2287 reg &= ~DWC3_DCFG_NUMLANES(~0);
2289 if (ssp_rate == USB_SSP_GEN_1x2)
2290 reg |= DWC3_DCFG_SUPERSPEED;
2291 else if (dwc->max_ssp_rate != USB_SSP_GEN_1x2)
2292 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2294 if (ssp_rate != USB_SSP_GEN_2x1 &&
2295 dwc->max_ssp_rate != USB_SSP_GEN_2x1)
2296 reg |= DWC3_DCFG_NUMLANES(1);
2298 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2301 static void __dwc3_gadget_set_speed(struct dwc3 *dwc)
2303 enum usb_device_speed speed;
2306 speed = dwc->gadget_max_speed;
2307 if (speed == USB_SPEED_UNKNOWN || speed > dwc->maximum_speed)
2308 speed = dwc->maximum_speed;
2310 if (speed == USB_SPEED_SUPER_PLUS &&
2311 DWC3_IP_IS(DWC32)) {
2312 __dwc3_gadget_set_ssp_rate(dwc);
2316 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2317 reg &= ~(DWC3_DCFG_SPEED_MASK);
2320 * WORKAROUND: DWC3 revision < 2.20a have an issue
2321 * which would cause metastability state on Run/Stop
2322 * bit if we try to force the IP to USB2-only mode.
2324 * Because of that, we cannot configure the IP to any
2325 * speed other than the SuperSpeed
2329 * STAR#9000525659: Clock Domain Crossing on DCTL in
2332 if (DWC3_VER_IS_PRIOR(DWC3, 220A) &&
2333 !dwc->dis_metastability_quirk) {
2334 reg |= DWC3_DCFG_SUPERSPEED;
2337 case USB_SPEED_FULL:
2338 reg |= DWC3_DCFG_FULLSPEED;
2340 case USB_SPEED_HIGH:
2341 reg |= DWC3_DCFG_HIGHSPEED;
2343 case USB_SPEED_SUPER:
2344 reg |= DWC3_DCFG_SUPERSPEED;
2346 case USB_SPEED_SUPER_PLUS:
2347 if (DWC3_IP_IS(DWC3))
2348 reg |= DWC3_DCFG_SUPERSPEED;
2350 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2353 dev_err(dwc->dev, "invalid speed (%d)\n", speed);
2355 if (DWC3_IP_IS(DWC3))
2356 reg |= DWC3_DCFG_SUPERSPEED;
2358 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2362 if (DWC3_IP_IS(DWC32) &&
2363 speed > USB_SPEED_UNKNOWN &&
2364 speed < USB_SPEED_SUPER_PLUS)
2365 reg &= ~DWC3_DCFG_NUMLANES(~0);
2367 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2370 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
2375 if (pm_runtime_suspended(dwc->dev))
2378 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2380 if (DWC3_VER_IS_WITHIN(DWC3, ANY, 187A)) {
2381 reg &= ~DWC3_DCTL_TRGTULST_MASK;
2382 reg |= DWC3_DCTL_TRGTULST_RX_DET;
2385 if (!DWC3_VER_IS_PRIOR(DWC3, 194A))
2386 reg &= ~DWC3_DCTL_KEEP_CONNECT;
2387 reg |= DWC3_DCTL_RUN_STOP;
2389 if (dwc->has_hibernation)
2390 reg |= DWC3_DCTL_KEEP_CONNECT;
2392 __dwc3_gadget_set_speed(dwc);
2393 dwc->pullups_connected = true;
2395 reg &= ~DWC3_DCTL_RUN_STOP;
2397 if (dwc->has_hibernation && !suspend)
2398 reg &= ~DWC3_DCTL_KEEP_CONNECT;
2400 dwc->pullups_connected = false;
2403 dwc3_gadget_dctl_write_safe(dwc, reg);
2406 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2407 reg &= DWC3_DSTS_DEVCTRLHLT;
2408 } while (--timeout && !(!is_on ^ !reg));
2416 static void dwc3_gadget_disable_irq(struct dwc3 *dwc);
2417 static void __dwc3_gadget_stop(struct dwc3 *dwc);
2418 static int __dwc3_gadget_start(struct dwc3 *dwc);
2420 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
2422 struct dwc3 *dwc = gadget_to_dwc(g);
2423 unsigned long flags;
2427 dwc->softconnect = is_on;
2429 * Per databook, when we want to stop the gadget, if a control transfer
2430 * is still in process, complete it and get the core into setup phase.
2432 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
2433 reinit_completion(&dwc->ep0_in_setup);
2435 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
2436 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
2438 dev_warn(dwc->dev, "timed out waiting for SETUP phase\n");
2442 * Avoid issuing a runtime resume if the device is already in the
2443 * suspended state during gadget disconnect. DWC3 gadget was already
2444 * halted/stopped during runtime suspend.
2447 pm_runtime_barrier(dwc->dev);
2448 if (pm_runtime_suspended(dwc->dev))
2453 * Check the return value for successful resume, or error. For a
2454 * successful resume, the DWC3 runtime PM resume routine will handle
2455 * the run stop sequence, so avoid duplicate operations here.
2457 ret = pm_runtime_get_sync(dwc->dev);
2458 if (!ret || ret < 0) {
2459 pm_runtime_put(dwc->dev);
2464 * Synchronize and disable any further event handling while controller
2465 * is being enabled/disabled.
2467 disable_irq(dwc->irq_gadget);
2469 spin_lock_irqsave(&dwc->lock, flags);
2474 dwc->connected = false;
2476 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
2477 * Section 4.1.8 Table 4-7, it states that for a device-initiated
2478 * disconnect, the SW needs to ensure that it sends "a DEPENDXFER
2479 * command for any active transfers" before clearing the RunStop
2482 dwc3_stop_active_transfers(dwc);
2483 __dwc3_gadget_stop(dwc);
2486 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
2487 * Section 1.3.4, it mentions that for the DEVCTRLHLT bit, the
2488 * "software needs to acknowledge the events that are generated
2489 * (by writing to GEVNTCOUNTn) while it is waiting for this bit
2490 * to be set to '1'."
2492 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2493 count &= DWC3_GEVNTCOUNT_MASK;
2495 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
2496 dwc->ev_buf->lpos = (dwc->ev_buf->lpos + count) %
2497 dwc->ev_buf->length;
2500 __dwc3_gadget_start(dwc);
2503 ret = dwc3_gadget_run_stop(dwc, is_on, false);
2504 spin_unlock_irqrestore(&dwc->lock, flags);
2505 enable_irq(dwc->irq_gadget);
2507 pm_runtime_put(dwc->dev);
2512 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
2516 /* Enable all but Start and End of Frame IRQs */
2517 reg = (DWC3_DEVTEN_EVNTOVERFLOWEN |
2518 DWC3_DEVTEN_CMDCMPLTEN |
2519 DWC3_DEVTEN_ERRTICERREN |
2520 DWC3_DEVTEN_WKUPEVTEN |
2521 DWC3_DEVTEN_CONNECTDONEEN |
2522 DWC3_DEVTEN_USBRSTEN |
2523 DWC3_DEVTEN_DISCONNEVTEN);
2525 if (DWC3_VER_IS_PRIOR(DWC3, 250A))
2526 reg |= DWC3_DEVTEN_ULSTCNGEN;
2528 /* On 2.30a and above this bit enables U3/L2-L1 Suspend Events */
2529 if (!DWC3_VER_IS_PRIOR(DWC3, 230A))
2530 reg |= DWC3_DEVTEN_U3L2L1SUSPEN;
2532 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
2535 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
2537 /* mask all interrupts */
2538 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
2541 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
2542 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
2545 * dwc3_gadget_setup_nump - calculate and initialize NUMP field of %DWC3_DCFG
2546 * @dwc: pointer to our context structure
2548 * The following looks like complex but it's actually very simple. In order to
2549 * calculate the number of packets we can burst at once on OUT transfers, we're
2550 * gonna use RxFIFO size.
2552 * To calculate RxFIFO size we need two numbers:
2553 * MDWIDTH = size, in bits, of the internal memory bus
2554 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
2556 * Given these two numbers, the formula is simple:
2558 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
2560 * 24 bytes is for 3x SETUP packets
2561 * 16 bytes is a clock domain crossing tolerance
2563 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
2565 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
2572 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
2573 mdwidth = dwc3_mdwidth(dwc);
2575 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
2576 nump = min_t(u32, nump, 16);
2579 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2580 reg &= ~DWC3_DCFG_NUMP_MASK;
2581 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
2582 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2585 static int __dwc3_gadget_start(struct dwc3 *dwc)
2587 struct dwc3_ep *dep;
2592 * Use IMOD if enabled via dwc->imod_interval. Otherwise, if
2593 * the core supports IMOD, disable it.
2595 if (dwc->imod_interval) {
2596 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
2597 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
2598 } else if (dwc3_has_imod(dwc)) {
2599 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), 0);
2603 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
2604 * field instead of letting dwc3 itself calculate that automatically.
2606 * This way, we maximize the chances that we'll be able to get several
2607 * bursts of data without going through any sort of endpoint throttling.
2609 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
2610 if (DWC3_IP_IS(DWC3))
2611 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
2613 reg &= ~DWC31_GRXTHRCFG_PKTCNTSEL;
2615 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
2617 dwc3_gadget_setup_nump(dwc);
2620 * Currently the controller handles single stream only. So, Ignore
2621 * Packet Pending bit for stream selection and don't search for another
2622 * stream if the host sends Data Packet with PP=0 (for OUT direction) or
2623 * ACK with NumP=0 and PP=0 (for IN direction). This slightly improves
2624 * the stream performance.
2626 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2627 reg |= DWC3_DCFG_IGNSTRMPP;
2628 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2630 /* Start with SuperSpeed Default */
2631 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2634 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2636 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2641 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
2643 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2647 /* begin to receive SETUP packets */
2648 dwc->ep0state = EP0_SETUP_PHASE;
2649 dwc->link_state = DWC3_LINK_STATE_SS_DIS;
2650 dwc->delayed_status = false;
2651 dwc3_ep0_out_start(dwc);
2653 dwc3_gadget_enable_irq(dwc);
2658 __dwc3_gadget_ep_disable(dwc->eps[0]);
2664 static int dwc3_gadget_start(struct usb_gadget *g,
2665 struct usb_gadget_driver *driver)
2667 struct dwc3 *dwc = gadget_to_dwc(g);
2668 unsigned long flags;
2672 irq = dwc->irq_gadget;
2673 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
2674 IRQF_SHARED, "dwc3", dwc->ev_buf);
2676 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
2681 spin_lock_irqsave(&dwc->lock, flags);
2682 dwc->gadget_driver = driver;
2683 spin_unlock_irqrestore(&dwc->lock, flags);
2688 static void __dwc3_gadget_stop(struct dwc3 *dwc)
2690 dwc3_gadget_disable_irq(dwc);
2691 __dwc3_gadget_ep_disable(dwc->eps[0]);
2692 __dwc3_gadget_ep_disable(dwc->eps[1]);
2695 static int dwc3_gadget_stop(struct usb_gadget *g)
2697 struct dwc3 *dwc = gadget_to_dwc(g);
2698 unsigned long flags;
2700 spin_lock_irqsave(&dwc->lock, flags);
2701 dwc->gadget_driver = NULL;
2702 dwc->max_cfg_eps = 0;
2703 spin_unlock_irqrestore(&dwc->lock, flags);
2705 free_irq(dwc->irq_gadget, dwc->ev_buf);
2710 static void dwc3_gadget_config_params(struct usb_gadget *g,
2711 struct usb_dcd_config_params *params)
2713 struct dwc3 *dwc = gadget_to_dwc(g);
2715 params->besl_baseline = USB_DEFAULT_BESL_UNSPECIFIED;
2716 params->besl_deep = USB_DEFAULT_BESL_UNSPECIFIED;
2718 /* Recommended BESL */
2719 if (!dwc->dis_enblslpm_quirk) {
2721 * If the recommended BESL baseline is 0 or if the BESL deep is
2722 * less than 2, Microsoft's Windows 10 host usb stack will issue
2723 * a usb reset immediately after it receives the extended BOS
2724 * descriptor and the enumeration will fail. To maintain
2725 * compatibility with the Windows' usb stack, let's set the
2726 * recommended BESL baseline to 1 and clamp the BESL deep to be
2729 params->besl_baseline = 1;
2730 if (dwc->is_utmi_l1_suspend)
2732 clamp_t(u8, dwc->hird_threshold, 2, 15);
2735 /* U1 Device exit Latency */
2736 if (dwc->dis_u1_entry_quirk)
2737 params->bU1devExitLat = 0;
2739 params->bU1devExitLat = DWC3_DEFAULT_U1_DEV_EXIT_LAT;
2741 /* U2 Device exit Latency */
2742 if (dwc->dis_u2_entry_quirk)
2743 params->bU2DevExitLat = 0;
2745 params->bU2DevExitLat =
2746 cpu_to_le16(DWC3_DEFAULT_U2_DEV_EXIT_LAT);
2749 static void dwc3_gadget_set_speed(struct usb_gadget *g,
2750 enum usb_device_speed speed)
2752 struct dwc3 *dwc = gadget_to_dwc(g);
2753 unsigned long flags;
2755 spin_lock_irqsave(&dwc->lock, flags);
2756 dwc->gadget_max_speed = speed;
2757 spin_unlock_irqrestore(&dwc->lock, flags);
2760 static void dwc3_gadget_set_ssp_rate(struct usb_gadget *g,
2761 enum usb_ssp_rate rate)
2763 struct dwc3 *dwc = gadget_to_dwc(g);
2764 unsigned long flags;
2766 spin_lock_irqsave(&dwc->lock, flags);
2767 dwc->gadget_max_speed = USB_SPEED_SUPER_PLUS;
2768 dwc->gadget_ssp_rate = rate;
2769 spin_unlock_irqrestore(&dwc->lock, flags);
2772 static int dwc3_gadget_vbus_draw(struct usb_gadget *g, unsigned int mA)
2774 struct dwc3 *dwc = gadget_to_dwc(g);
2775 union power_supply_propval val = {0};
2779 return usb_phy_set_power(dwc->usb2_phy, mA);
2784 val.intval = 1000 * mA;
2785 ret = power_supply_set_property(dwc->usb_psy, POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT, &val);
2791 * dwc3_gadget_check_config - ensure dwc3 can support the USB configuration
2792 * @g: pointer to the USB gadget
2794 * Used to record the maximum number of endpoints being used in a USB composite
2795 * device. (across all configurations) This is to be used in the calculation
2796 * of the TXFIFO sizes when resizing internal memory for individual endpoints.
2797 * It will help ensured that the resizing logic reserves enough space for at
2798 * least one max packet.
2800 static int dwc3_gadget_check_config(struct usb_gadget *g)
2802 struct dwc3 *dwc = gadget_to_dwc(g);
2808 if (!dwc->do_fifo_resize)
2811 list_for_each_entry(ep, &g->ep_list, ep_list) {
2812 /* Only interested in the IN endpoints */
2813 if (ep->claimed && (ep->address & USB_DIR_IN))
2817 if (ep_num <= dwc->max_cfg_eps)
2820 /* Update the max number of eps in the composition */
2821 dwc->max_cfg_eps = ep_num;
2823 fifo_size = dwc3_gadget_calc_tx_fifo_size(dwc, dwc->max_cfg_eps);
2824 /* Based on the equation, increment by one for every ep */
2825 fifo_size += dwc->max_cfg_eps;
2827 /* Check if we can fit a single fifo per endpoint */
2828 ram1_depth = DWC3_RAM1_DEPTH(dwc->hwparams.hwparams7);
2829 if (fifo_size > ram1_depth)
2835 static void dwc3_gadget_async_callbacks(struct usb_gadget *g, bool enable)
2837 struct dwc3 *dwc = gadget_to_dwc(g);
2838 unsigned long flags;
2840 spin_lock_irqsave(&dwc->lock, flags);
2841 dwc->async_callbacks = enable;
2842 spin_unlock_irqrestore(&dwc->lock, flags);
2845 static const struct usb_gadget_ops dwc3_gadget_ops = {
2846 .get_frame = dwc3_gadget_get_frame,
2847 .wakeup = dwc3_gadget_wakeup,
2848 .set_selfpowered = dwc3_gadget_set_selfpowered,
2849 .pullup = dwc3_gadget_pullup,
2850 .udc_start = dwc3_gadget_start,
2851 .udc_stop = dwc3_gadget_stop,
2852 .udc_set_speed = dwc3_gadget_set_speed,
2853 .udc_set_ssp_rate = dwc3_gadget_set_ssp_rate,
2854 .get_config_params = dwc3_gadget_config_params,
2855 .vbus_draw = dwc3_gadget_vbus_draw,
2856 .check_config = dwc3_gadget_check_config,
2857 .udc_async_callbacks = dwc3_gadget_async_callbacks,
2860 /* -------------------------------------------------------------------------- */
2862 static int dwc3_gadget_init_control_endpoint(struct dwc3_ep *dep)
2864 struct dwc3 *dwc = dep->dwc;
2866 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
2867 dep->endpoint.maxburst = 1;
2868 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
2869 if (!dep->direction)
2870 dwc->gadget->ep0 = &dep->endpoint;
2872 dep->endpoint.caps.type_control = true;
2877 static int dwc3_gadget_init_in_endpoint(struct dwc3_ep *dep)
2879 struct dwc3 *dwc = dep->dwc;
2883 mdwidth = dwc3_mdwidth(dwc);
2885 /* MDWIDTH is represented in bits, we need it in bytes */
2888 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1));
2889 if (DWC3_IP_IS(DWC3))
2890 size = DWC3_GTXFIFOSIZ_TXFDEP(size);
2892 size = DWC31_GTXFIFOSIZ_TXFDEP(size);
2894 /* FIFO Depth is in MDWDITH bytes. Multiply */
2898 * To meet performance requirement, a minimum TxFIFO size of 3x
2899 * MaxPacketSize is recommended for endpoints that support burst and a
2900 * minimum TxFIFO size of 2x MaxPacketSize for endpoints that don't
2901 * support burst. Use those numbers and we can calculate the max packet
2904 if (dwc->maximum_speed >= USB_SPEED_SUPER)
2909 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2911 dep->endpoint.max_streams = 16;
2912 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2913 list_add_tail(&dep->endpoint.ep_list,
2914 &dwc->gadget->ep_list);
2915 dep->endpoint.caps.type_iso = true;
2916 dep->endpoint.caps.type_bulk = true;
2917 dep->endpoint.caps.type_int = true;
2919 return dwc3_alloc_trb_pool(dep);
2922 static int dwc3_gadget_init_out_endpoint(struct dwc3_ep *dep)
2924 struct dwc3 *dwc = dep->dwc;
2928 mdwidth = dwc3_mdwidth(dwc);
2930 /* MDWIDTH is represented in bits, convert to bytes */
2933 /* All OUT endpoints share a single RxFIFO space */
2934 size = dwc3_readl(dwc->regs, DWC3_GRXFIFOSIZ(0));
2935 if (DWC3_IP_IS(DWC3))
2936 size = DWC3_GRXFIFOSIZ_RXFDEP(size);
2938 size = DWC31_GRXFIFOSIZ_RXFDEP(size);
2940 /* FIFO depth is in MDWDITH bytes */
2944 * To meet performance requirement, a minimum recommended RxFIFO size
2945 * is defined as follow:
2946 * RxFIFO size >= (3 x MaxPacketSize) +
2947 * (3 x 8 bytes setup packets size) + (16 bytes clock crossing margin)
2949 * Then calculate the max packet limit as below.
2951 size -= (3 * 8) + 16;
2957 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2958 dep->endpoint.max_streams = 16;
2959 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2960 list_add_tail(&dep->endpoint.ep_list,
2961 &dwc->gadget->ep_list);
2962 dep->endpoint.caps.type_iso = true;
2963 dep->endpoint.caps.type_bulk = true;
2964 dep->endpoint.caps.type_int = true;
2966 return dwc3_alloc_trb_pool(dep);
2969 static int dwc3_gadget_init_endpoint(struct dwc3 *dwc, u8 epnum)
2971 struct dwc3_ep *dep;
2972 bool direction = epnum & 1;
2974 u8 num = epnum >> 1;
2976 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
2981 dep->number = epnum;
2982 dep->direction = direction;
2983 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
2984 dwc->eps[epnum] = dep;
2986 dep->start_cmd_status = 0;
2988 snprintf(dep->name, sizeof(dep->name), "ep%u%s", num,
2989 direction ? "in" : "out");
2991 dep->endpoint.name = dep->name;
2993 if (!(dep->number > 1)) {
2994 dep->endpoint.desc = &dwc3_gadget_ep0_desc;
2995 dep->endpoint.comp_desc = NULL;
2999 ret = dwc3_gadget_init_control_endpoint(dep);
3001 ret = dwc3_gadget_init_in_endpoint(dep);
3003 ret = dwc3_gadget_init_out_endpoint(dep);
3008 dep->endpoint.caps.dir_in = direction;
3009 dep->endpoint.caps.dir_out = !direction;
3011 INIT_LIST_HEAD(&dep->pending_list);
3012 INIT_LIST_HEAD(&dep->started_list);
3013 INIT_LIST_HEAD(&dep->cancelled_list);
3015 dwc3_debugfs_create_endpoint_dir(dep);
3020 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc, u8 total)
3024 INIT_LIST_HEAD(&dwc->gadget->ep_list);
3026 for (epnum = 0; epnum < total; epnum++) {
3029 ret = dwc3_gadget_init_endpoint(dwc, epnum);
3037 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
3039 struct dwc3_ep *dep;
3042 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
3043 dep = dwc->eps[epnum];
3047 * Physical endpoints 0 and 1 are special; they form the
3048 * bi-directional USB endpoint 0.
3050 * For those two physical endpoints, we don't allocate a TRB
3051 * pool nor do we add them the endpoints list. Due to that, we
3052 * shouldn't do these two operations otherwise we would end up
3053 * with all sorts of bugs when removing dwc3.ko.
3055 if (epnum != 0 && epnum != 1) {
3056 dwc3_free_trb_pool(dep);
3057 list_del(&dep->endpoint.ep_list);
3060 debugfs_remove_recursive(debugfs_lookup(dep->name,
3061 debugfs_lookup(dev_name(dep->dwc->dev),
3067 /* -------------------------------------------------------------------------- */
3069 static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
3070 struct dwc3_request *req, struct dwc3_trb *trb,
3071 const struct dwc3_event_depevt *event, int status, int chain)
3075 dwc3_ep_inc_deq(dep);
3077 trace_dwc3_complete_trb(dep, trb);
3081 * If we're in the middle of series of chained TRBs and we
3082 * receive a short transfer along the way, DWC3 will skip
3083 * through all TRBs including the last TRB in the chain (the
3084 * where CHN bit is zero. DWC3 will also avoid clearing HWO
3085 * bit and SW has to do it manually.
3087 * We're going to do that here to avoid problems of HW trying
3088 * to use bogus TRBs for transfers.
3090 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
3091 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
3094 * For isochronous transfers, the first TRB in a service interval must
3095 * have the Isoc-First type. Track and report its interval frame number.
3097 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
3098 (trb->ctrl & DWC3_TRBCTL_ISOCHRONOUS_FIRST)) {
3099 unsigned int frame_number;
3101 frame_number = DWC3_TRB_CTRL_GET_SID_SOFN(trb->ctrl);
3102 frame_number &= ~(dep->interval - 1);
3103 req->request.frame_number = frame_number;
3107 * We use bounce buffer for requests that needs extra TRB or OUT ZLP. If
3108 * this TRB points to the bounce buffer address, it's a MPS alignment
3109 * TRB. Don't add it to req->remaining calculation.
3111 if (trb->bpl == lower_32_bits(dep->dwc->bounce_addr) &&
3112 trb->bph == upper_32_bits(dep->dwc->bounce_addr)) {
3113 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
3117 count = trb->size & DWC3_TRB_SIZE_MASK;
3118 req->remaining += count;
3120 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
3123 if (event->status & DEPEVT_STATUS_SHORT && !chain)
3126 if ((trb->ctrl & DWC3_TRB_CTRL_IOC) ||
3127 (trb->ctrl & DWC3_TRB_CTRL_LST))
3133 static int dwc3_gadget_ep_reclaim_trb_sg(struct dwc3_ep *dep,
3134 struct dwc3_request *req, const struct dwc3_event_depevt *event,
3137 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
3138 struct scatterlist *sg = req->sg;
3139 struct scatterlist *s;
3140 unsigned int num_queued = req->num_queued_sgs;
3144 for_each_sg(sg, s, num_queued, i) {
3145 trb = &dep->trb_pool[dep->trb_dequeue];
3147 req->sg = sg_next(s);
3148 req->num_queued_sgs--;
3150 ret = dwc3_gadget_ep_reclaim_completed_trb(dep, req,
3151 trb, event, status, true);
3159 static int dwc3_gadget_ep_reclaim_trb_linear(struct dwc3_ep *dep,
3160 struct dwc3_request *req, const struct dwc3_event_depevt *event,
3163 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
3165 return dwc3_gadget_ep_reclaim_completed_trb(dep, req, trb,
3166 event, status, false);
3169 static bool dwc3_gadget_ep_request_completed(struct dwc3_request *req)
3171 return req->num_pending_sgs == 0 && req->num_queued_sgs == 0;
3174 static int dwc3_gadget_ep_cleanup_completed_request(struct dwc3_ep *dep,
3175 const struct dwc3_event_depevt *event,
3176 struct dwc3_request *req, int status)
3180 if (req->request.num_mapped_sgs)
3181 ret = dwc3_gadget_ep_reclaim_trb_sg(dep, req, event,
3184 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
3187 req->request.actual = req->request.length - req->remaining;
3189 if (!dwc3_gadget_ep_request_completed(req))
3192 if (req->needs_extra_trb) {
3193 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
3195 req->needs_extra_trb = false;
3198 dwc3_gadget_giveback(dep, req, status);
3204 static void dwc3_gadget_ep_cleanup_completed_requests(struct dwc3_ep *dep,
3205 const struct dwc3_event_depevt *event, int status)
3207 struct dwc3_request *req;
3208 struct dwc3_request *tmp;
3210 list_for_each_entry_safe(req, tmp, &dep->started_list, list) {
3213 ret = dwc3_gadget_ep_cleanup_completed_request(dep, event,
3220 static bool dwc3_gadget_ep_should_continue(struct dwc3_ep *dep)
3222 struct dwc3_request *req;
3223 struct dwc3 *dwc = dep->dwc;
3225 if (!dep->endpoint.desc || !dwc->pullups_connected ||
3229 if (!list_empty(&dep->pending_list))
3233 * We only need to check the first entry of the started list. We can
3234 * assume the completed requests are removed from the started list.
3236 req = next_request(&dep->started_list);
3240 return !dwc3_gadget_ep_request_completed(req);
3243 static void dwc3_gadget_endpoint_frame_from_event(struct dwc3_ep *dep,
3244 const struct dwc3_event_depevt *event)
3246 dep->frame_number = event->parameters;
3249 static bool dwc3_gadget_endpoint_trbs_complete(struct dwc3_ep *dep,
3250 const struct dwc3_event_depevt *event, int status)
3252 struct dwc3 *dwc = dep->dwc;
3253 bool no_started_trb = true;
3255 dwc3_gadget_ep_cleanup_completed_requests(dep, event, status);
3257 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING)
3260 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
3261 list_empty(&dep->started_list) &&
3262 (list_empty(&dep->pending_list) || status == -EXDEV))
3263 dwc3_stop_active_transfer(dep, true, true);
3264 else if (dwc3_gadget_ep_should_continue(dep))
3265 if (__dwc3_gadget_kick_transfer(dep) == 0)
3266 no_started_trb = false;
3270 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
3271 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
3273 if (DWC3_VER_IS_PRIOR(DWC3, 183A)) {
3277 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
3280 if (!(dep->flags & DWC3_EP_ENABLED))
3283 if (!list_empty(&dep->started_list))
3284 return no_started_trb;
3287 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3289 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
3294 return no_started_trb;
3297 static void dwc3_gadget_endpoint_transfer_in_progress(struct dwc3_ep *dep,
3298 const struct dwc3_event_depevt *event)
3302 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
3303 dwc3_gadget_endpoint_frame_from_event(dep, event);
3305 if (event->status & DEPEVT_STATUS_BUSERR)
3306 status = -ECONNRESET;
3308 if (event->status & DEPEVT_STATUS_MISSED_ISOC)
3311 dwc3_gadget_endpoint_trbs_complete(dep, event, status);
3314 static void dwc3_gadget_endpoint_transfer_complete(struct dwc3_ep *dep,
3315 const struct dwc3_event_depevt *event)
3319 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3321 if (event->status & DEPEVT_STATUS_BUSERR)
3322 status = -ECONNRESET;
3324 if (dwc3_gadget_endpoint_trbs_complete(dep, event, status))
3325 dep->flags &= ~DWC3_EP_WAIT_TRANSFER_COMPLETE;
3328 static void dwc3_gadget_endpoint_transfer_not_ready(struct dwc3_ep *dep,
3329 const struct dwc3_event_depevt *event)
3331 dwc3_gadget_endpoint_frame_from_event(dep, event);
3334 * The XferNotReady event is generated only once before the endpoint
3335 * starts. It will be generated again when END_TRANSFER command is
3336 * issued. For some controller versions, the XferNotReady event may be
3337 * generated while the END_TRANSFER command is still in process. Ignore
3338 * it and wait for the next XferNotReady event after the command is
3341 if (dep->flags & DWC3_EP_END_TRANSFER_PENDING)
3344 (void) __dwc3_gadget_start_isoc(dep);
3347 static void dwc3_gadget_endpoint_command_complete(struct dwc3_ep *dep,
3348 const struct dwc3_event_depevt *event)
3350 u8 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
3352 if (cmd != DWC3_DEPCMD_ENDTRANSFER)
3355 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
3356 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3357 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
3359 if (dep->flags & DWC3_EP_PENDING_CLEAR_STALL) {
3360 struct dwc3 *dwc = dep->dwc;
3362 dep->flags &= ~DWC3_EP_PENDING_CLEAR_STALL;
3363 if (dwc3_send_clear_stall_ep_cmd(dep)) {
3364 struct usb_ep *ep0 = &dwc->eps[0]->endpoint;
3366 dev_err(dwc->dev, "failed to clear STALL on %s\n", dep->name);
3367 if (dwc->delayed_status)
3368 __dwc3_gadget_ep0_set_halt(ep0, 1);
3372 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
3373 if (dwc->delayed_status)
3374 dwc3_ep0_send_delayed_status(dwc);
3377 if ((dep->flags & DWC3_EP_DELAY_START) &&
3378 !usb_endpoint_xfer_isoc(dep->endpoint.desc))
3379 __dwc3_gadget_kick_transfer(dep);
3381 dep->flags &= ~DWC3_EP_DELAY_START;
3384 static void dwc3_gadget_endpoint_stream_event(struct dwc3_ep *dep,
3385 const struct dwc3_event_depevt *event)
3387 struct dwc3 *dwc = dep->dwc;
3389 if (event->status == DEPEVT_STREAMEVT_FOUND) {
3390 dep->flags |= DWC3_EP_FIRST_STREAM_PRIMED;
3394 /* Note: NoStream rejection event param value is 0 and not 0xFFFF */
3395 switch (event->parameters) {
3396 case DEPEVT_STREAM_PRIME:
3398 * If the host can properly transition the endpoint state from
3399 * idle to prime after a NoStream rejection, there's no need to
3400 * force restarting the endpoint to reinitiate the stream. To
3401 * simplify the check, assume the host follows the USB spec if
3402 * it primed the endpoint more than once.
3404 if (dep->flags & DWC3_EP_FORCE_RESTART_STREAM) {
3405 if (dep->flags & DWC3_EP_FIRST_STREAM_PRIMED)
3406 dep->flags &= ~DWC3_EP_FORCE_RESTART_STREAM;
3408 dep->flags |= DWC3_EP_FIRST_STREAM_PRIMED;
3412 case DEPEVT_STREAM_NOSTREAM:
3413 if ((dep->flags & DWC3_EP_IGNORE_NEXT_NOSTREAM) ||
3414 !(dep->flags & DWC3_EP_FORCE_RESTART_STREAM) ||
3415 !(dep->flags & DWC3_EP_WAIT_TRANSFER_COMPLETE))
3419 * If the host rejects a stream due to no active stream, by the
3420 * USB and xHCI spec, the endpoint will be put back to idle
3421 * state. When the host is ready (buffer added/updated), it will
3422 * prime the endpoint to inform the usb device controller. This
3423 * triggers the device controller to issue ERDY to restart the
3424 * stream. However, some hosts don't follow this and keep the
3425 * endpoint in the idle state. No prime will come despite host
3426 * streams are updated, and the device controller will not be
3427 * triggered to generate ERDY to move the next stream data. To
3428 * workaround this and maintain compatibility with various
3429 * hosts, force to reinitate the stream until the host is ready
3430 * instead of waiting for the host to prime the endpoint.
3432 if (DWC3_VER_IS_WITHIN(DWC32, 100A, ANY)) {
3433 unsigned int cmd = DWC3_DGCMD_SET_ENDPOINT_PRIME;
3435 dwc3_send_gadget_generic_command(dwc, cmd, dep->number);
3437 dep->flags |= DWC3_EP_DELAY_START;
3438 dwc3_stop_active_transfer(dep, true, true);
3445 dep->flags &= ~DWC3_EP_IGNORE_NEXT_NOSTREAM;
3448 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
3449 const struct dwc3_event_depevt *event)
3451 struct dwc3_ep *dep;
3452 u8 epnum = event->endpoint_number;
3454 dep = dwc->eps[epnum];
3456 if (!(dep->flags & DWC3_EP_ENABLED)) {
3457 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
3460 /* Handle only EPCMDCMPLT when EP disabled */
3461 if (event->endpoint_event != DWC3_DEPEVT_EPCMDCMPLT)
3465 if (epnum == 0 || epnum == 1) {
3466 dwc3_ep0_interrupt(dwc, event);
3470 switch (event->endpoint_event) {
3471 case DWC3_DEPEVT_XFERINPROGRESS:
3472 dwc3_gadget_endpoint_transfer_in_progress(dep, event);
3474 case DWC3_DEPEVT_XFERNOTREADY:
3475 dwc3_gadget_endpoint_transfer_not_ready(dep, event);
3477 case DWC3_DEPEVT_EPCMDCMPLT:
3478 dwc3_gadget_endpoint_command_complete(dep, event);
3480 case DWC3_DEPEVT_XFERCOMPLETE:
3481 dwc3_gadget_endpoint_transfer_complete(dep, event);
3483 case DWC3_DEPEVT_STREAMEVT:
3484 dwc3_gadget_endpoint_stream_event(dep, event);
3486 case DWC3_DEPEVT_RXTXFIFOEVT:
3491 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
3493 if (dwc->async_callbacks && dwc->gadget_driver->disconnect) {
3494 spin_unlock(&dwc->lock);
3495 dwc->gadget_driver->disconnect(dwc->gadget);
3496 spin_lock(&dwc->lock);
3500 static void dwc3_suspend_gadget(struct dwc3 *dwc)
3502 if (dwc->async_callbacks && dwc->gadget_driver->suspend) {
3503 spin_unlock(&dwc->lock);
3504 dwc->gadget_driver->suspend(dwc->gadget);
3505 spin_lock(&dwc->lock);
3509 static void dwc3_resume_gadget(struct dwc3 *dwc)
3511 if (dwc->async_callbacks && dwc->gadget_driver->resume) {
3512 spin_unlock(&dwc->lock);
3513 dwc->gadget_driver->resume(dwc->gadget);
3514 spin_lock(&dwc->lock);
3518 static void dwc3_reset_gadget(struct dwc3 *dwc)
3520 if (!dwc->gadget_driver)
3523 if (dwc->async_callbacks && dwc->gadget->speed != USB_SPEED_UNKNOWN) {
3524 spin_unlock(&dwc->lock);
3525 usb_gadget_udc_reset(dwc->gadget, dwc->gadget_driver);
3526 spin_lock(&dwc->lock);
3530 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
3533 struct dwc3_gadget_ep_cmd_params params;
3537 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED) ||
3538 (dep->flags & DWC3_EP_END_TRANSFER_PENDING))
3542 * NOTICE: We are violating what the Databook says about the
3543 * EndTransfer command. Ideally we would _always_ wait for the
3544 * EndTransfer Command Completion IRQ, but that's causing too
3545 * much trouble synchronizing between us and gadget driver.
3547 * We have discussed this with the IP Provider and it was
3548 * suggested to giveback all requests here.
3550 * Note also that a similar handling was tested by Synopsys
3551 * (thanks a lot Paul) and nothing bad has come out of it.
3552 * In short, what we're doing is issuing EndTransfer with
3553 * CMDIOC bit set and delay kicking transfer until the
3554 * EndTransfer command had completed.
3556 * As of IP version 3.10a of the DWC_usb3 IP, the controller
3557 * supports a mode to work around the above limitation. The
3558 * software can poll the CMDACT bit in the DEPCMD register
3559 * after issuing a EndTransfer command. This mode is enabled
3560 * by writing GUCTL2[14]. This polling is already done in the
3561 * dwc3_send_gadget_ep_cmd() function so if the mode is
3562 * enabled, the EndTransfer command will have completed upon
3563 * returning from this function.
3565 * This mode is NOT available on the DWC_usb31 IP.
3568 cmd = DWC3_DEPCMD_ENDTRANSFER;
3569 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
3570 cmd |= interrupt ? DWC3_DEPCMD_CMDIOC : 0;
3571 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
3572 memset(¶ms, 0, sizeof(params));
3573 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
3575 dep->resource_index = 0;
3578 * The END_TRANSFER command will cause the controller to generate a
3579 * NoStream Event, and it's not due to the host DP NoStream rejection.
3580 * Ignore the next NoStream event.
3582 if (dep->stream_capable)
3583 dep->flags |= DWC3_EP_IGNORE_NEXT_NOSTREAM;
3586 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
3588 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
3591 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
3595 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
3596 struct dwc3_ep *dep;
3599 dep = dwc->eps[epnum];
3603 if (!(dep->flags & DWC3_EP_STALL))
3606 dep->flags &= ~DWC3_EP_STALL;
3608 ret = dwc3_send_clear_stall_ep_cmd(dep);
3613 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
3617 dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RX_DET);
3619 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3620 reg &= ~DWC3_DCTL_INITU1ENA;
3621 reg &= ~DWC3_DCTL_INITU2ENA;
3622 dwc3_gadget_dctl_write_safe(dwc, reg);
3624 dwc3_disconnect_gadget(dwc);
3626 dwc->gadget->speed = USB_SPEED_UNKNOWN;
3627 dwc->setup_packet_pending = false;
3628 usb_gadget_set_state(dwc->gadget, USB_STATE_NOTATTACHED);
3630 dwc->connected = false;
3633 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
3638 * Ideally, dwc3_reset_gadget() would trigger the function
3639 * drivers to stop any active transfers through ep disable.
3640 * However, for functions which defer ep disable, such as mass
3641 * storage, we will need to rely on the call to stop active
3642 * transfers here, and avoid allowing of request queuing.
3644 dwc->connected = false;
3647 * WORKAROUND: DWC3 revisions <1.88a have an issue which
3648 * would cause a missing Disconnect Event if there's a
3649 * pending Setup Packet in the FIFO.
3651 * There's no suggested workaround on the official Bug
3652 * report, which states that "unless the driver/application
3653 * is doing any special handling of a disconnect event,
3654 * there is no functional issue".
3656 * Unfortunately, it turns out that we _do_ some special
3657 * handling of a disconnect event, namely complete all
3658 * pending transfers, notify gadget driver of the
3659 * disconnection, and so on.
3661 * Our suggested workaround is to follow the Disconnect
3662 * Event steps here, instead, based on a setup_packet_pending
3663 * flag. Such flag gets set whenever we have a SETUP_PENDING
3664 * status for EP0 TRBs and gets cleared on XferComplete for the
3669 * STAR#9000466709: RTL: Device : Disconnect event not
3670 * generated if setup packet pending in FIFO
3672 if (DWC3_VER_IS_PRIOR(DWC3, 188A)) {
3673 if (dwc->setup_packet_pending)
3674 dwc3_gadget_disconnect_interrupt(dwc);
3677 dwc3_reset_gadget(dwc);
3679 * In the Synopsis DesignWare Cores USB3 Databook Rev. 3.30a
3680 * Section 4.1.2 Table 4-2, it states that during a USB reset, the SW
3681 * needs to ensure that it sends "a DEPENDXFER command for any active
3684 dwc3_stop_active_transfers(dwc);
3685 dwc->connected = true;
3687 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3688 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
3689 dwc3_gadget_dctl_write_safe(dwc, reg);
3690 dwc->test_mode = false;
3691 dwc3_clear_stall_all_ep(dwc);
3693 /* Reset device address to zero */
3694 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3695 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
3696 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3699 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
3701 struct dwc3_ep *dep;
3707 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
3708 speed = reg & DWC3_DSTS_CONNECTSPD;
3711 if (DWC3_IP_IS(DWC32))
3712 lanes = DWC3_DSTS_CONNLANES(reg) + 1;
3714 dwc->gadget->ssp_rate = USB_SSP_GEN_UNKNOWN;
3717 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
3718 * each time on Connect Done.
3720 * Currently we always use the reset value. If any platform
3721 * wants to set this to a different value, we need to add a
3722 * setting and update GCTL.RAMCLKSEL here.
3726 case DWC3_DSTS_SUPERSPEED_PLUS:
3727 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
3728 dwc->gadget->ep0->maxpacket = 512;
3729 dwc->gadget->speed = USB_SPEED_SUPER_PLUS;
3732 dwc->gadget->ssp_rate = USB_SSP_GEN_2x2;
3734 dwc->gadget->ssp_rate = USB_SSP_GEN_2x1;
3736 case DWC3_DSTS_SUPERSPEED:
3738 * WORKAROUND: DWC3 revisions <1.90a have an issue which
3739 * would cause a missing USB3 Reset event.
3741 * In such situations, we should force a USB3 Reset
3742 * event by calling our dwc3_gadget_reset_interrupt()
3747 * STAR#9000483510: RTL: SS : USB3 reset event may
3748 * not be generated always when the link enters poll
3750 if (DWC3_VER_IS_PRIOR(DWC3, 190A))
3751 dwc3_gadget_reset_interrupt(dwc);
3753 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
3754 dwc->gadget->ep0->maxpacket = 512;
3755 dwc->gadget->speed = USB_SPEED_SUPER;
3758 dwc->gadget->speed = USB_SPEED_SUPER_PLUS;
3759 dwc->gadget->ssp_rate = USB_SSP_GEN_1x2;
3762 case DWC3_DSTS_HIGHSPEED:
3763 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
3764 dwc->gadget->ep0->maxpacket = 64;
3765 dwc->gadget->speed = USB_SPEED_HIGH;
3767 case DWC3_DSTS_FULLSPEED:
3768 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
3769 dwc->gadget->ep0->maxpacket = 64;
3770 dwc->gadget->speed = USB_SPEED_FULL;
3774 dwc->eps[1]->endpoint.maxpacket = dwc->gadget->ep0->maxpacket;
3776 /* Enable USB2 LPM Capability */
3778 if (!DWC3_VER_IS_WITHIN(DWC3, ANY, 194A) &&
3779 !dwc->usb2_gadget_lpm_disable &&
3780 (speed != DWC3_DSTS_SUPERSPEED) &&
3781 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
3782 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3783 reg |= DWC3_DCFG_LPM_CAP;
3784 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3786 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3787 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
3789 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold |
3790 (dwc->is_utmi_l1_suspend << 4));
3793 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
3794 * DCFG.LPMCap is set, core responses with an ACK and the
3795 * BESL value in the LPM token is less than or equal to LPM
3798 WARN_ONCE(DWC3_VER_IS_PRIOR(DWC3, 240A) && dwc->has_lpm_erratum,
3799 "LPM Erratum not available on dwc3 revisions < 2.40a\n");
3801 if (dwc->has_lpm_erratum && !DWC3_VER_IS_PRIOR(DWC3, 240A))
3802 reg |= DWC3_DCTL_NYET_THRES(dwc->lpm_nyet_threshold);
3804 dwc3_gadget_dctl_write_safe(dwc, reg);
3806 if (dwc->usb2_gadget_lpm_disable) {
3807 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
3808 reg &= ~DWC3_DCFG_LPM_CAP;
3809 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
3812 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3813 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
3814 dwc3_gadget_dctl_write_safe(dwc, reg);
3818 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
3820 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3825 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
3827 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
3832 * Configure PHY via GUSB3PIPECTLn if required.
3834 * Update GTXFIFOSIZn
3836 * In both cases reset values should be sufficient.
3840 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
3843 * TODO take core out of low power mode when that's
3847 if (dwc->async_callbacks && dwc->gadget_driver->resume) {
3848 spin_unlock(&dwc->lock);
3849 dwc->gadget_driver->resume(dwc->gadget);
3850 spin_lock(&dwc->lock);
3854 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
3855 unsigned int evtinfo)
3857 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3858 unsigned int pwropt;
3861 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
3862 * Hibernation mode enabled which would show up when device detects
3863 * host-initiated U3 exit.
3865 * In that case, device will generate a Link State Change Interrupt
3866 * from U3 to RESUME which is only necessary if Hibernation is
3869 * There are no functional changes due to such spurious event and we
3870 * just need to ignore it.
3874 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
3877 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
3878 if (DWC3_VER_IS_PRIOR(DWC3, 250A) &&
3879 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
3880 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
3881 (next == DWC3_LINK_STATE_RESUME)) {
3887 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
3888 * on the link partner, the USB session might do multiple entry/exit
3889 * of low power states before a transfer takes place.
3891 * Due to this problem, we might experience lower throughput. The
3892 * suggested workaround is to disable DCTL[12:9] bits if we're
3893 * transitioning from U1/U2 to U0 and enable those bits again
3894 * after a transfer completes and there are no pending transfers
3895 * on any of the enabled endpoints.
3897 * This is the first half of that workaround.
3901 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
3902 * core send LGO_Ux entering U0
3904 if (DWC3_VER_IS_PRIOR(DWC3, 183A)) {
3905 if (next == DWC3_LINK_STATE_U0) {
3909 switch (dwc->link_state) {
3910 case DWC3_LINK_STATE_U1:
3911 case DWC3_LINK_STATE_U2:
3912 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
3913 u1u2 = reg & (DWC3_DCTL_INITU2ENA
3914 | DWC3_DCTL_ACCEPTU2ENA
3915 | DWC3_DCTL_INITU1ENA
3916 | DWC3_DCTL_ACCEPTU1ENA);
3919 dwc->u1u2 = reg & u1u2;
3923 dwc3_gadget_dctl_write_safe(dwc, reg);
3933 case DWC3_LINK_STATE_U1:
3934 if (dwc->speed == USB_SPEED_SUPER)
3935 dwc3_suspend_gadget(dwc);
3937 case DWC3_LINK_STATE_U2:
3938 case DWC3_LINK_STATE_U3:
3939 dwc3_suspend_gadget(dwc);
3941 case DWC3_LINK_STATE_RESUME:
3942 dwc3_resume_gadget(dwc);
3949 dwc->link_state = next;
3952 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
3953 unsigned int evtinfo)
3955 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3957 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
3958 dwc3_suspend_gadget(dwc);
3960 dwc->link_state = next;
3963 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
3964 unsigned int evtinfo)
3966 unsigned int is_ss = evtinfo & BIT(4);
3969 * WORKAROUND: DWC3 revison 2.20a with hibernation support
3970 * have a known issue which can cause USB CV TD.9.23 to fail
3973 * Because of this issue, core could generate bogus hibernation
3974 * events which SW needs to ignore.
3978 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
3979 * Device Fallback from SuperSpeed
3981 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
3984 /* enter hibernation here */
3987 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
3988 const struct dwc3_event_devt *event)
3990 switch (event->type) {
3991 case DWC3_DEVICE_EVENT_DISCONNECT:
3992 dwc3_gadget_disconnect_interrupt(dwc);
3994 case DWC3_DEVICE_EVENT_RESET:
3995 dwc3_gadget_reset_interrupt(dwc);
3997 case DWC3_DEVICE_EVENT_CONNECT_DONE:
3998 dwc3_gadget_conndone_interrupt(dwc);
4000 case DWC3_DEVICE_EVENT_WAKEUP:
4001 dwc3_gadget_wakeup_interrupt(dwc);
4003 case DWC3_DEVICE_EVENT_HIBER_REQ:
4004 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
4005 "unexpected hibernation event\n"))
4008 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
4010 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
4011 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
4013 case DWC3_DEVICE_EVENT_SUSPEND:
4014 /* It changed to be suspend event for version 2.30a and above */
4015 if (!DWC3_VER_IS_PRIOR(DWC3, 230A)) {
4017 * Ignore suspend event until the gadget enters into
4018 * USB_STATE_CONFIGURED state.
4020 if (dwc->gadget->state >= USB_STATE_CONFIGURED)
4021 dwc3_gadget_suspend_interrupt(dwc,
4025 case DWC3_DEVICE_EVENT_SOF:
4026 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
4027 case DWC3_DEVICE_EVENT_CMD_CMPL:
4028 case DWC3_DEVICE_EVENT_OVERFLOW:
4031 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
4035 static void dwc3_process_event_entry(struct dwc3 *dwc,
4036 const union dwc3_event *event)
4038 trace_dwc3_event(event->raw, dwc);
4040 if (!event->type.is_devspec)
4041 dwc3_endpoint_interrupt(dwc, &event->depevt);
4042 else if (event->type.type == DWC3_EVENT_TYPE_DEV)
4043 dwc3_gadget_interrupt(dwc, &event->devt);
4045 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
4048 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
4050 struct dwc3 *dwc = evt->dwc;
4051 irqreturn_t ret = IRQ_NONE;
4057 if (!(evt->flags & DWC3_EVENT_PENDING))
4061 union dwc3_event event;
4063 event.raw = *(u32 *) (evt->cache + evt->lpos);
4065 dwc3_process_event_entry(dwc, &event);
4068 * FIXME we wrap around correctly to the next entry as
4069 * almost all entries are 4 bytes in size. There is one
4070 * entry which has 12 bytes which is a regular entry
4071 * followed by 8 bytes data. ATM I don't know how
4072 * things are organized if we get next to the a
4073 * boundary so I worry about that once we try to handle
4076 evt->lpos = (evt->lpos + 4) % evt->length;
4081 evt->flags &= ~DWC3_EVENT_PENDING;
4084 /* Unmask interrupt */
4085 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
4086 reg &= ~DWC3_GEVNTSIZ_INTMASK;
4087 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
4089 if (dwc->imod_interval) {
4090 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
4091 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
4097 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
4099 struct dwc3_event_buffer *evt = _evt;
4100 struct dwc3 *dwc = evt->dwc;
4101 unsigned long flags;
4102 irqreturn_t ret = IRQ_NONE;
4104 spin_lock_irqsave(&dwc->lock, flags);
4105 ret = dwc3_process_event_buf(evt);
4106 spin_unlock_irqrestore(&dwc->lock, flags);
4111 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
4113 struct dwc3 *dwc = evt->dwc;
4118 if (pm_runtime_suspended(dwc->dev)) {
4119 pm_runtime_get(dwc->dev);
4120 disable_irq_nosync(dwc->irq_gadget);
4121 dwc->pending_events = true;
4126 * With PCIe legacy interrupt, test shows that top-half irq handler can
4127 * be called again after HW interrupt deassertion. Check if bottom-half
4128 * irq event handler completes before caching new event to prevent
4131 if (evt->flags & DWC3_EVENT_PENDING)
4134 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
4135 count &= DWC3_GEVNTCOUNT_MASK;
4140 evt->flags |= DWC3_EVENT_PENDING;
4142 /* Mask interrupt */
4143 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
4144 reg |= DWC3_GEVNTSIZ_INTMASK;
4145 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
4147 amount = min(count, evt->length - evt->lpos);
4148 memcpy(evt->cache + evt->lpos, evt->buf + evt->lpos, amount);
4151 memcpy(evt->cache, evt->buf, count - amount);
4153 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
4155 return IRQ_WAKE_THREAD;
4158 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
4160 struct dwc3_event_buffer *evt = _evt;
4162 return dwc3_check_event_buf(evt);
4165 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
4167 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
4170 irq = platform_get_irq_byname_optional(dwc3_pdev, "peripheral");
4174 if (irq == -EPROBE_DEFER)
4177 irq = platform_get_irq_byname_optional(dwc3_pdev, "dwc_usb3");
4181 if (irq == -EPROBE_DEFER)
4184 irq = platform_get_irq(dwc3_pdev, 0);
4195 static void dwc_gadget_release(struct device *dev)
4197 struct usb_gadget *gadget = container_of(dev, struct usb_gadget, dev);
4203 * dwc3_gadget_init - initializes gadget related registers
4204 * @dwc: pointer to our controller context structure
4206 * Returns 0 on success otherwise negative errno.
4208 int dwc3_gadget_init(struct dwc3 *dwc)
4214 irq = dwc3_gadget_get_irq(dwc);
4220 dwc->irq_gadget = irq;
4222 dwc->ep0_trb = dma_alloc_coherent(dwc->sysdev,
4223 sizeof(*dwc->ep0_trb) * 2,
4224 &dwc->ep0_trb_addr, GFP_KERNEL);
4225 if (!dwc->ep0_trb) {
4226 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
4231 dwc->setup_buf = kzalloc(DWC3_EP0_SETUP_SIZE, GFP_KERNEL);
4232 if (!dwc->setup_buf) {
4237 dwc->bounce = dma_alloc_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE,
4238 &dwc->bounce_addr, GFP_KERNEL);
4244 init_completion(&dwc->ep0_in_setup);
4245 dwc->gadget = kzalloc(sizeof(struct usb_gadget), GFP_KERNEL);
4252 usb_initialize_gadget(dwc->dev, dwc->gadget, dwc_gadget_release);
4253 dev = &dwc->gadget->dev;
4254 dev->platform_data = dwc;
4255 dwc->gadget->ops = &dwc3_gadget_ops;
4256 dwc->gadget->speed = USB_SPEED_UNKNOWN;
4257 dwc->gadget->ssp_rate = USB_SSP_GEN_UNKNOWN;
4258 dwc->gadget->sg_supported = true;
4259 dwc->gadget->name = "dwc3-gadget";
4260 dwc->gadget->lpm_capable = !dwc->usb2_gadget_lpm_disable;
4263 * FIXME We might be setting max_speed to <SUPER, however versions
4264 * <2.20a of dwc3 have an issue with metastability (documented
4265 * elsewhere in this driver) which tells us we can't set max speed to
4266 * anything lower than SUPER.
4268 * Because gadget.max_speed is only used by composite.c and function
4269 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
4270 * to happen so we avoid sending SuperSpeed Capability descriptor
4271 * together with our BOS descriptor as that could confuse host into
4272 * thinking we can handle super speed.
4274 * Note that, in fact, we won't even support GetBOS requests when speed
4275 * is less than super speed because we don't have means, yet, to tell
4276 * composite.c that we are USB 2.0 + LPM ECN.
4278 if (DWC3_VER_IS_PRIOR(DWC3, 220A) &&
4279 !dwc->dis_metastability_quirk)
4280 dev_info(dwc->dev, "changing max_speed on rev %08x\n",
4283 dwc->gadget->max_speed = dwc->maximum_speed;
4284 dwc->gadget->max_ssp_rate = dwc->max_ssp_rate;
4287 * REVISIT: Here we should clear all pending IRQs to be
4288 * sure we're starting from a well known location.
4291 ret = dwc3_gadget_init_endpoints(dwc, dwc->num_eps);
4295 ret = usb_add_gadget(dwc->gadget);
4297 dev_err(dwc->dev, "failed to add gadget\n");
4301 if (DWC3_IP_IS(DWC32) && dwc->maximum_speed == USB_SPEED_SUPER_PLUS)
4302 dwc3_gadget_set_ssp_rate(dwc->gadget, dwc->max_ssp_rate);
4304 dwc3_gadget_set_speed(dwc->gadget, dwc->maximum_speed);
4309 dwc3_gadget_free_endpoints(dwc);
4311 usb_put_gadget(dwc->gadget);
4314 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
4318 kfree(dwc->setup_buf);
4321 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
4322 dwc->ep0_trb, dwc->ep0_trb_addr);
4328 /* -------------------------------------------------------------------------- */
4330 void dwc3_gadget_exit(struct dwc3 *dwc)
4335 usb_del_gadget(dwc->gadget);
4336 dwc3_gadget_free_endpoints(dwc);
4337 usb_put_gadget(dwc->gadget);
4338 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
4340 kfree(dwc->setup_buf);
4341 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
4342 dwc->ep0_trb, dwc->ep0_trb_addr);
4345 int dwc3_gadget_suspend(struct dwc3 *dwc)
4347 if (!dwc->gadget_driver)
4350 dwc3_gadget_run_stop(dwc, false, false);
4351 dwc3_disconnect_gadget(dwc);
4352 __dwc3_gadget_stop(dwc);
4357 int dwc3_gadget_resume(struct dwc3 *dwc)
4361 if (!dwc->gadget_driver || !dwc->softconnect)
4364 ret = __dwc3_gadget_start(dwc);
4368 ret = dwc3_gadget_run_stop(dwc, true, false);
4375 __dwc3_gadget_stop(dwc);
4381 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
4383 if (dwc->pending_events) {
4384 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
4385 dwc->pending_events = false;
4386 enable_irq(dwc->irq_gadget);