2 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 of
11 * the License as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/interrupt.h>
27 #include <linux/list.h>
28 #include <linux/dma-mapping.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
39 * dwc3_gadget_set_test_mode - Enables USB2 Test Modes
40 * @dwc: pointer to our context structure
41 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
43 * Caller should take care of locking. This function will
44 * return 0 on success or -EINVAL if wrong Test Selector
47 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
51 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
52 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
66 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
72 * dwc3_gadget_get_link_state - Gets current state of USB Link
73 * @dwc: pointer to our context structure
75 * Caller should take care of locking. This function will
76 * return the link state on success (>= 0) or -ETIMEDOUT.
78 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
82 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
84 return DWC3_DSTS_USBLNKST(reg);
88 * dwc3_gadget_set_link_state - Sets USB Link to a particular State
89 * @dwc: pointer to our context structure
90 * @state: the state to put link into
92 * Caller should take care of locking. This function will
93 * return 0 on success or -ETIMEDOUT.
95 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
101 * Wait until device controller is ready. Only applies to 1.94a and
104 if (dwc->revision >= DWC3_REVISION_194A) {
106 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
107 if (reg & DWC3_DSTS_DCNRD)
117 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
118 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
120 /* set requested state */
121 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
122 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
125 * The following code is racy when called from dwc3_gadget_wakeup,
126 * and is not needed, at least on newer versions
128 if (dwc->revision >= DWC3_REVISION_194A)
131 /* wait for a change in DSTS */
134 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
136 if (DWC3_DSTS_USBLNKST(reg) == state)
142 dwc3_trace(trace_dwc3_gadget,
143 "link state change request timed out");
149 * dwc3_ep_inc_trb() - Increment a TRB index.
150 * @index - Pointer to the TRB index to increment.
152 * The index should never point to the link TRB. After incrementing,
153 * if it is point to the link TRB, wrap around to the beginning. The
154 * link TRB is always at the last TRB entry.
156 static void dwc3_ep_inc_trb(u8 *index)
159 if (*index == (DWC3_TRB_NUM - 1))
163 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
165 dwc3_ep_inc_trb(&dep->trb_enqueue);
168 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
170 dwc3_ep_inc_trb(&dep->trb_dequeue);
173 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
176 struct dwc3 *dwc = dep->dwc;
178 req->started = false;
179 list_del(&req->list);
183 if (req->request.status == -EINPROGRESS)
184 req->request.status = status;
186 if (dwc->ep0_bounced && dep->number == 0)
187 dwc->ep0_bounced = false;
189 usb_gadget_unmap_request(&dwc->gadget, &req->request,
192 trace_dwc3_gadget_giveback(req);
194 spin_unlock(&dwc->lock);
195 usb_gadget_giveback_request(&dep->endpoint, &req->request);
196 spin_lock(&dwc->lock);
199 pm_runtime_put(dwc->dev);
202 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
209 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
210 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
213 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
214 if (!(reg & DWC3_DGCMD_CMDACT)) {
215 status = DWC3_DGCMD_STATUS(reg);
227 trace_dwc3_gadget_generic_cmd(cmd, param, status);
232 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
234 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
235 struct dwc3_gadget_ep_cmd_params *params)
237 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
238 struct dwc3 *dwc = dep->dwc;
247 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
248 * we're issuing an endpoint command, we must check if
249 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
251 * We will also set SUSPHY bit to what it was before returning as stated
252 * by the same section on Synopsys databook.
254 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
255 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
256 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
258 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
259 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
263 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
266 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
267 dwc->link_state == DWC3_LINK_STATE_U2 ||
268 dwc->link_state == DWC3_LINK_STATE_U3);
270 if (unlikely(needs_wakeup)) {
271 ret = __dwc3_gadget_wakeup(dwc);
272 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
277 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
278 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
279 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
282 * Synopsys Databook 2.60a states in section 6.3.2.5.6 of that if we're
283 * not relying on XferNotReady, we can make use of a special "No
284 * Response Update Transfer" command where we should clear both CmdAct
287 * With this, we don't need to wait for command completion and can
288 * straight away issue further commands to the endpoint.
290 * NOTICE: We're making an assumption that control endpoints will never
291 * make use of Update Transfer command. This is a safe assumption
292 * because we can never have more than one request at a time with
293 * Control Endpoints. If anybody changes that assumption, this chunk
294 * needs to be updated accordingly.
296 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_UPDATETRANSFER &&
297 !usb_endpoint_xfer_isoc(desc))
298 cmd &= ~(DWC3_DEPCMD_CMDIOC | DWC3_DEPCMD_CMDACT);
300 cmd |= DWC3_DEPCMD_CMDACT;
302 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd);
304 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
305 if (!(reg & DWC3_DEPCMD_CMDACT)) {
306 cmd_status = DWC3_DEPCMD_STATUS(reg);
308 switch (cmd_status) {
312 case DEPEVT_TRANSFER_NO_RESOURCE:
315 case DEPEVT_TRANSFER_BUS_EXPIRY:
317 * SW issues START TRANSFER command to
318 * isochronous ep with future frame interval. If
319 * future interval time has already passed when
320 * core receives the command, it will respond
321 * with an error status of 'Bus Expiry'.
323 * Instead of always returning -EINVAL, let's
324 * give a hint to the gadget driver that this is
325 * the case by returning -EAGAIN.
330 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
339 cmd_status = -ETIMEDOUT;
342 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
345 switch (DWC3_DEPCMD_CMD(cmd)) {
346 case DWC3_DEPCMD_STARTTRANSFER:
347 dep->flags |= DWC3_EP_TRANSFER_STARTED;
349 case DWC3_DEPCMD_ENDTRANSFER:
350 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
358 if (unlikely(susphy)) {
359 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
360 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
361 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
367 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
369 struct dwc3 *dwc = dep->dwc;
370 struct dwc3_gadget_ep_cmd_params params;
371 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
374 * As of core revision 2.60a the recommended programming model
375 * is to set the ClearPendIN bit when issuing a Clear Stall EP
376 * command for IN endpoints. This is to prevent an issue where
377 * some (non-compliant) hosts may not send ACK TPs for pending
378 * IN transfers due to a mishandled error condition. Synopsys
381 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A) &&
382 (dwc->gadget.speed >= USB_SPEED_SUPER))
383 cmd |= DWC3_DEPCMD_CLEARPENDIN;
385 memset(¶ms, 0, sizeof(params));
387 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
390 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
391 struct dwc3_trb *trb)
393 u32 offset = (char *) trb - (char *) dep->trb_pool;
395 return dep->trb_pool_dma + offset;
398 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
400 struct dwc3 *dwc = dep->dwc;
405 dep->trb_pool = dma_alloc_coherent(dwc->dev,
406 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
407 &dep->trb_pool_dma, GFP_KERNEL);
408 if (!dep->trb_pool) {
409 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
417 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
419 struct dwc3 *dwc = dep->dwc;
421 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
422 dep->trb_pool, dep->trb_pool_dma);
424 dep->trb_pool = NULL;
425 dep->trb_pool_dma = 0;
428 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
431 * dwc3_gadget_start_config - Configure EP resources
432 * @dwc: pointer to our controller context structure
433 * @dep: endpoint that is being enabled
435 * The assignment of transfer resources cannot perfectly follow the
436 * data book due to the fact that the controller driver does not have
437 * all knowledge of the configuration in advance. It is given this
438 * information piecemeal by the composite gadget framework after every
439 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
440 * programming model in this scenario can cause errors. For two
443 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
444 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
445 * multiple interfaces.
447 * 2) The databook does not mention doing more DEPXFERCFG for new
448 * endpoint on alt setting (8.1.6).
450 * The following simplified method is used instead:
452 * All hardware endpoints can be assigned a transfer resource and this
453 * setting will stay persistent until either a core reset or
454 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
455 * do DEPXFERCFG for every hardware endpoint as well. We are
456 * guaranteed that there are as many transfer resources as endpoints.
458 * This function is called for each endpoint when it is being enabled
459 * but is triggered only when called for EP0-out, which always happens
460 * first, and which should only happen in one of the above conditions.
462 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
464 struct dwc3_gadget_ep_cmd_params params;
472 memset(¶ms, 0x00, sizeof(params));
473 cmd = DWC3_DEPCMD_DEPSTARTCFG;
475 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
479 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
480 struct dwc3_ep *dep = dwc->eps[i];
485 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
493 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
494 const struct usb_endpoint_descriptor *desc,
495 const struct usb_ss_ep_comp_descriptor *comp_desc,
496 bool modify, bool restore)
498 struct dwc3_gadget_ep_cmd_params params;
500 if (dev_WARN_ONCE(dwc->dev, modify && restore,
501 "Can't modify and restore\n"))
504 memset(¶ms, 0x00, sizeof(params));
506 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
507 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
509 /* Burst size is only needed in SuperSpeed mode */
510 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
511 u32 burst = dep->endpoint.maxburst;
512 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
516 params.param0 |= DWC3_DEPCFG_ACTION_MODIFY;
517 } else if (restore) {
518 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
519 params.param2 |= dep->saved_state;
521 params.param0 |= DWC3_DEPCFG_ACTION_INIT;
524 if (usb_endpoint_xfer_control(desc))
525 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
527 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
528 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
530 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
531 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
532 | DWC3_DEPCFG_STREAM_EVENT_EN;
533 dep->stream_capable = true;
536 if (!usb_endpoint_xfer_control(desc))
537 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
540 * We are doing 1:1 mapping for endpoints, meaning
541 * Physical Endpoints 2 maps to Logical Endpoint 2 and
542 * so on. We consider the direction bit as part of the physical
543 * endpoint number. So USB endpoint 0x81 is 0x03.
545 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
548 * We must use the lower 16 TX FIFOs even though
552 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
554 if (desc->bInterval) {
555 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
556 dep->interval = 1 << (desc->bInterval - 1);
559 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
562 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
564 struct dwc3_gadget_ep_cmd_params params;
566 memset(¶ms, 0x00, sizeof(params));
568 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
570 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
575 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
576 * @dep: endpoint to be initialized
577 * @desc: USB Endpoint Descriptor
579 * Caller should take care of locking
581 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
582 const struct usb_endpoint_descriptor *desc,
583 const struct usb_ss_ep_comp_descriptor *comp_desc,
584 bool modify, bool restore)
586 struct dwc3 *dwc = dep->dwc;
590 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
592 if (!(dep->flags & DWC3_EP_ENABLED)) {
593 ret = dwc3_gadget_start_config(dwc, dep);
598 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, modify,
603 if (!(dep->flags & DWC3_EP_ENABLED)) {
604 struct dwc3_trb *trb_st_hw;
605 struct dwc3_trb *trb_link;
607 dep->endpoint.desc = desc;
608 dep->comp_desc = comp_desc;
609 dep->type = usb_endpoint_type(desc);
610 dep->flags |= DWC3_EP_ENABLED;
611 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
613 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
614 reg |= DWC3_DALEPENA_EP(dep->number);
615 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
617 init_waitqueue_head(&dep->wait_end_transfer);
619 if (usb_endpoint_xfer_control(desc))
622 /* Initialize the TRB ring */
623 dep->trb_dequeue = 0;
624 dep->trb_enqueue = 0;
625 memset(dep->trb_pool, 0,
626 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
628 /* Link TRB. The HWO bit is never reset */
629 trb_st_hw = &dep->trb_pool[0];
631 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
632 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
633 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
634 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
635 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
639 * Issue StartTransfer here with no-op TRB so we can always rely on No
640 * Response Update Transfer command.
642 if (usb_endpoint_xfer_bulk(desc)) {
643 struct dwc3_gadget_ep_cmd_params params;
644 struct dwc3_trb *trb;
648 memset(¶ms, 0, sizeof(params));
649 trb = &dep->trb_pool[0];
650 trb_dma = dwc3_trb_dma_offset(dep, trb);
652 params.param0 = upper_32_bits(trb_dma);
653 params.param1 = lower_32_bits(trb_dma);
655 cmd = DWC3_DEPCMD_STARTTRANSFER;
657 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
661 dep->flags |= DWC3_EP_BUSY;
663 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
664 WARN_ON_ONCE(!dep->resource_index);
670 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
671 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
673 struct dwc3_request *req;
675 dwc3_stop_active_transfer(dwc, dep->number, true);
677 /* - giveback all requests to gadget driver */
678 while (!list_empty(&dep->started_list)) {
679 req = next_request(&dep->started_list);
681 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
684 while (!list_empty(&dep->pending_list)) {
685 req = next_request(&dep->pending_list);
687 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
692 * __dwc3_gadget_ep_disable - Disables a HW endpoint
693 * @dep: the endpoint to disable
695 * This function also removes requests which are currently processed ny the
696 * hardware and those which are not yet scheduled.
697 * Caller should take care of locking.
699 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
701 struct dwc3 *dwc = dep->dwc;
704 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
706 dwc3_remove_requests(dwc, dep);
708 /* make sure HW endpoint isn't stalled */
709 if (dep->flags & DWC3_EP_STALL)
710 __dwc3_gadget_ep_set_halt(dep, 0, false);
712 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
713 reg &= ~DWC3_DALEPENA_EP(dep->number);
714 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
716 dep->stream_capable = false;
717 dep->endpoint.desc = NULL;
718 dep->comp_desc = NULL;
720 dep->flags &= DWC3_EP_END_TRANSFER_PENDING;
725 /* -------------------------------------------------------------------------- */
727 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
728 const struct usb_endpoint_descriptor *desc)
733 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
738 /* -------------------------------------------------------------------------- */
740 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
741 const struct usb_endpoint_descriptor *desc)
748 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
749 pr_debug("dwc3: invalid parameters\n");
753 if (!desc->wMaxPacketSize) {
754 pr_debug("dwc3: missing wMaxPacketSize\n");
758 dep = to_dwc3_ep(ep);
761 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
762 "%s is already enabled\n",
766 spin_lock_irqsave(&dwc->lock, flags);
767 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
768 spin_unlock_irqrestore(&dwc->lock, flags);
773 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
781 pr_debug("dwc3: invalid parameters\n");
785 dep = to_dwc3_ep(ep);
788 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
789 "%s is already disabled\n",
793 spin_lock_irqsave(&dwc->lock, flags);
794 ret = __dwc3_gadget_ep_disable(dep);
795 spin_unlock_irqrestore(&dwc->lock, flags);
800 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
803 struct dwc3_request *req;
804 struct dwc3_ep *dep = to_dwc3_ep(ep);
806 req = kzalloc(sizeof(*req), gfp_flags);
810 req->epnum = dep->number;
813 dep->allocated_requests++;
815 trace_dwc3_alloc_request(req);
817 return &req->request;
820 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
821 struct usb_request *request)
823 struct dwc3_request *req = to_dwc3_request(request);
824 struct dwc3_ep *dep = to_dwc3_ep(ep);
826 dep->allocated_requests--;
827 trace_dwc3_free_request(req);
831 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep);
834 * dwc3_prepare_one_trb - setup one TRB from one request
835 * @dep: endpoint for which this request is prepared
836 * @req: dwc3_request pointer
838 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
839 struct dwc3_request *req, dma_addr_t dma,
840 unsigned length, unsigned chain, unsigned node)
842 struct dwc3_trb *trb;
843 struct dwc3 *dwc = dep->dwc;
844 struct usb_gadget *gadget = &dwc->gadget;
845 enum usb_device_speed speed = gadget->speed;
847 trb = &dep->trb_pool[dep->trb_enqueue];
850 dwc3_gadget_move_started_request(req);
852 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
853 dep->queued_requests++;
856 dwc3_ep_inc_enq(dep);
858 trb->size = DWC3_TRB_SIZE_LENGTH(length);
859 trb->bpl = lower_32_bits(dma);
860 trb->bph = upper_32_bits(dma);
862 switch (usb_endpoint_type(dep->endpoint.desc)) {
863 case USB_ENDPOINT_XFER_CONTROL:
864 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
867 case USB_ENDPOINT_XFER_ISOC:
869 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
871 if (speed == USB_SPEED_HIGH) {
872 struct usb_ep *ep = &dep->endpoint;
873 trb->size |= DWC3_TRB_SIZE_PCM1(ep->mult - 1);
876 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
879 /* always enable Interrupt on Missed ISOC */
880 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
883 case USB_ENDPOINT_XFER_BULK:
884 case USB_ENDPOINT_XFER_INT:
885 trb->ctrl = DWC3_TRBCTL_NORMAL;
889 * This is only possible with faulty memory because we
890 * checked it already :)
892 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
893 usb_endpoint_type(dep->endpoint.desc));
896 /* always enable Continue on Short Packet */
897 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
898 trb->ctrl |= DWC3_TRB_CTRL_CSP;
900 if (req->request.short_not_ok)
901 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
904 if ((!req->request.no_interrupt && !chain) ||
905 (dwc3_calc_trbs_left(dep) == 0))
906 trb->ctrl |= DWC3_TRB_CTRL_IOC;
909 trb->ctrl |= DWC3_TRB_CTRL_CHN;
911 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
912 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
914 trb->ctrl |= DWC3_TRB_CTRL_HWO;
916 trace_dwc3_prepare_trb(dep, trb);
920 * dwc3_ep_prev_trb() - Returns the previous TRB in the ring
921 * @dep: The endpoint with the TRB ring
922 * @index: The index of the current TRB in the ring
924 * Returns the TRB prior to the one pointed to by the index. If the
925 * index is 0, we will wrap backwards, skip the link TRB, and return
926 * the one just before that.
928 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
933 tmp = DWC3_TRB_NUM - 1;
935 return &dep->trb_pool[tmp - 1];
938 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
940 struct dwc3_trb *tmp;
944 * If enqueue & dequeue are equal than it is either full or empty.
946 * One way to know for sure is if the TRB right before us has HWO bit
947 * set or not. If it has, then we're definitely full and can't fit any
948 * more transfers in our ring.
950 if (dep->trb_enqueue == dep->trb_dequeue) {
951 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
952 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
955 return DWC3_TRB_NUM - 1;
958 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
959 trbs_left &= (DWC3_TRB_NUM - 1);
961 if (dep->trb_dequeue < dep->trb_enqueue)
967 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
968 struct dwc3_request *req)
970 struct scatterlist *sg = req->sg;
971 struct scatterlist *s;
976 for_each_sg(sg, s, req->num_pending_sgs, i) {
977 unsigned chain = true;
979 length = sg_dma_len(s);
980 dma = sg_dma_address(s);
985 dwc3_prepare_one_trb(dep, req, dma, length,
988 if (!dwc3_calc_trbs_left(dep))
993 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
994 struct dwc3_request *req)
999 dma = req->request.dma;
1000 length = req->request.length;
1002 dwc3_prepare_one_trb(dep, req, dma, length,
1007 * dwc3_prepare_trbs - setup TRBs from requests
1008 * @dep: endpoint for which requests are being prepared
1010 * The function goes through the requests list and sets up TRBs for the
1011 * transfers. The function returns once there are no more TRBs available or
1012 * it runs out of requests.
1014 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
1016 struct dwc3_request *req, *n;
1018 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1020 if (!dwc3_calc_trbs_left(dep))
1024 * We can get in a situation where there's a request in the started list
1025 * but there weren't enough TRBs to fully kick it in the first time
1026 * around, so it has been waiting for more TRBs to be freed up.
1028 * In that case, we should check if we have a request with pending_sgs
1029 * in the started list and prepare TRBs for that request first,
1030 * otherwise we will prepare TRBs completely out of order and that will
1033 list_for_each_entry(req, &dep->started_list, list) {
1034 if (req->num_pending_sgs > 0)
1035 dwc3_prepare_one_trb_sg(dep, req);
1037 if (!dwc3_calc_trbs_left(dep))
1041 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1042 if (req->num_pending_sgs > 0)
1043 dwc3_prepare_one_trb_sg(dep, req);
1045 dwc3_prepare_one_trb_linear(dep, req);
1047 if (!dwc3_calc_trbs_left(dep))
1052 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
1054 struct dwc3_gadget_ep_cmd_params params;
1055 struct dwc3_request *req;
1060 starting = !(dep->flags & DWC3_EP_BUSY);
1062 dwc3_prepare_trbs(dep);
1063 req = next_request(&dep->started_list);
1065 dep->flags |= DWC3_EP_PENDING_REQUEST;
1069 memset(¶ms, 0, sizeof(params));
1072 params.param0 = upper_32_bits(req->trb_dma);
1073 params.param1 = lower_32_bits(req->trb_dma);
1074 cmd = DWC3_DEPCMD_STARTTRANSFER |
1075 DWC3_DEPCMD_PARAM(cmd_param);
1077 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1078 DWC3_DEPCMD_PARAM(dep->resource_index);
1081 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1084 * FIXME we need to iterate over the list of requests
1085 * here and stop, unmap, free and del each of the linked
1086 * requests instead of what we do now.
1088 dwc3_gadget_giveback(dep, req, ret);
1092 dep->flags |= DWC3_EP_BUSY;
1095 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1096 WARN_ON_ONCE(!dep->resource_index);
1102 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1106 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1107 return DWC3_DSTS_SOFFN(reg);
1110 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1111 struct dwc3_ep *dep, u32 cur_uf)
1115 if (list_empty(&dep->pending_list)) {
1116 dwc3_trace(trace_dwc3_gadget,
1117 "ISOC ep %s run out for requests",
1119 dep->flags |= DWC3_EP_PENDING_REQUEST;
1123 /* 4 micro frames in the future */
1124 uf = cur_uf + dep->interval * 4;
1126 __dwc3_gadget_kick_transfer(dep, uf);
1129 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1130 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1134 mask = ~(dep->interval - 1);
1135 cur_uf = event->parameters & mask;
1137 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1140 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1142 struct dwc3 *dwc = dep->dwc;
1145 if (!dep->endpoint.desc) {
1146 dwc3_trace(trace_dwc3_gadget,
1147 "trying to queue request %p to disabled %s",
1148 &req->request, dep->endpoint.name);
1152 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1153 &req->request, req->dep->name)) {
1154 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'",
1155 &req->request, req->dep->name);
1159 pm_runtime_get(dwc->dev);
1161 req->request.actual = 0;
1162 req->request.status = -EINPROGRESS;
1163 req->direction = dep->direction;
1164 req->epnum = dep->number;
1166 trace_dwc3_ep_queue(req);
1168 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1173 req->sg = req->request.sg;
1174 req->num_pending_sgs = req->request.num_mapped_sgs;
1176 list_add_tail(&req->list, &dep->pending_list);
1179 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1180 * wait for a XferNotReady event so we will know what's the current
1181 * (micro-)frame number.
1183 * Without this trick, we are very, very likely gonna get Bus Expiry
1184 * errors which will force us issue EndTransfer command.
1186 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1187 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1188 if (dep->flags & DWC3_EP_TRANSFER_STARTED) {
1189 dwc3_stop_active_transfer(dwc, dep->number, true);
1190 dep->flags = DWC3_EP_ENABLED;
1194 cur_uf = __dwc3_gadget_get_frame(dwc);
1195 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1201 if (!dwc3_calc_trbs_left(dep))
1204 ret = __dwc3_gadget_kick_transfer(dep, 0);
1205 if (ret && ret != -EBUSY)
1206 dwc3_trace(trace_dwc3_gadget,
1207 "%s: failed to kick transfers",
1215 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1216 struct usb_request *request)
1218 dwc3_gadget_ep_free_request(ep, request);
1221 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1223 struct dwc3_request *req;
1224 struct usb_request *request;
1225 struct usb_ep *ep = &dep->endpoint;
1227 dwc3_trace(trace_dwc3_gadget, "queueing ZLP");
1228 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1232 request->length = 0;
1233 request->buf = dwc->zlp_buf;
1234 request->complete = __dwc3_gadget_ep_zlp_complete;
1236 req = to_dwc3_request(request);
1238 return __dwc3_gadget_ep_queue(dep, req);
1241 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1244 struct dwc3_request *req = to_dwc3_request(request);
1245 struct dwc3_ep *dep = to_dwc3_ep(ep);
1246 struct dwc3 *dwc = dep->dwc;
1248 unsigned long flags;
1252 spin_lock_irqsave(&dwc->lock, flags);
1253 ret = __dwc3_gadget_ep_queue(dep, req);
1256 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1257 * setting request->zero, instead of doing magic, we will just queue an
1258 * extra usb_request ourselves so that it gets handled the same way as
1259 * any other request.
1261 if (ret == 0 && request->zero && request->length &&
1262 (request->length % ep->maxpacket == 0))
1263 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1265 spin_unlock_irqrestore(&dwc->lock, flags);
1270 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1271 struct usb_request *request)
1273 struct dwc3_request *req = to_dwc3_request(request);
1274 struct dwc3_request *r = NULL;
1276 struct dwc3_ep *dep = to_dwc3_ep(ep);
1277 struct dwc3 *dwc = dep->dwc;
1279 unsigned long flags;
1282 trace_dwc3_ep_dequeue(req);
1284 spin_lock_irqsave(&dwc->lock, flags);
1286 list_for_each_entry(r, &dep->pending_list, list) {
1292 list_for_each_entry(r, &dep->started_list, list) {
1297 /* wait until it is processed */
1298 dwc3_stop_active_transfer(dwc, dep->number, true);
1301 dev_err(dwc->dev, "request %p was not queued to %s\n",
1308 /* giveback the request */
1309 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1312 spin_unlock_irqrestore(&dwc->lock, flags);
1317 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1319 struct dwc3_gadget_ep_cmd_params params;
1320 struct dwc3 *dwc = dep->dwc;
1323 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1324 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1328 memset(¶ms, 0x00, sizeof(params));
1331 struct dwc3_trb *trb;
1333 unsigned transfer_in_flight;
1336 if (dep->number > 1)
1337 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1339 trb = &dwc->ep0_trb[dep->trb_enqueue];
1341 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1342 started = !list_empty(&dep->started_list);
1344 if (!protocol && ((dep->direction && transfer_in_flight) ||
1345 (!dep->direction && started))) {
1346 dwc3_trace(trace_dwc3_gadget,
1347 "%s: pending request, cannot halt",
1352 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1355 dev_err(dwc->dev, "failed to set STALL on %s\n",
1358 dep->flags |= DWC3_EP_STALL;
1361 ret = dwc3_send_clear_stall_ep_cmd(dep);
1363 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1366 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1372 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1374 struct dwc3_ep *dep = to_dwc3_ep(ep);
1375 struct dwc3 *dwc = dep->dwc;
1377 unsigned long flags;
1381 spin_lock_irqsave(&dwc->lock, flags);
1382 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1383 spin_unlock_irqrestore(&dwc->lock, flags);
1388 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1390 struct dwc3_ep *dep = to_dwc3_ep(ep);
1391 struct dwc3 *dwc = dep->dwc;
1392 unsigned long flags;
1395 spin_lock_irqsave(&dwc->lock, flags);
1396 dep->flags |= DWC3_EP_WEDGE;
1398 if (dep->number == 0 || dep->number == 1)
1399 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1401 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1402 spin_unlock_irqrestore(&dwc->lock, flags);
1407 /* -------------------------------------------------------------------------- */
1409 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1410 .bLength = USB_DT_ENDPOINT_SIZE,
1411 .bDescriptorType = USB_DT_ENDPOINT,
1412 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1415 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1416 .enable = dwc3_gadget_ep0_enable,
1417 .disable = dwc3_gadget_ep0_disable,
1418 .alloc_request = dwc3_gadget_ep_alloc_request,
1419 .free_request = dwc3_gadget_ep_free_request,
1420 .queue = dwc3_gadget_ep0_queue,
1421 .dequeue = dwc3_gadget_ep_dequeue,
1422 .set_halt = dwc3_gadget_ep0_set_halt,
1423 .set_wedge = dwc3_gadget_ep_set_wedge,
1426 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1427 .enable = dwc3_gadget_ep_enable,
1428 .disable = dwc3_gadget_ep_disable,
1429 .alloc_request = dwc3_gadget_ep_alloc_request,
1430 .free_request = dwc3_gadget_ep_free_request,
1431 .queue = dwc3_gadget_ep_queue,
1432 .dequeue = dwc3_gadget_ep_dequeue,
1433 .set_halt = dwc3_gadget_ep_set_halt,
1434 .set_wedge = dwc3_gadget_ep_set_wedge,
1437 /* -------------------------------------------------------------------------- */
1439 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1441 struct dwc3 *dwc = gadget_to_dwc(g);
1443 return __dwc3_gadget_get_frame(dwc);
1446 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1457 * According to the Databook Remote wakeup request should
1458 * be issued only when the device is in early suspend state.
1460 * We can check that via USB Link State bits in DSTS register.
1462 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1464 speed = reg & DWC3_DSTS_CONNECTSPD;
1465 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1466 (speed == DWC3_DSTS_SUPERSPEED_PLUS)) {
1467 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed");
1471 link_state = DWC3_DSTS_USBLNKST(reg);
1473 switch (link_state) {
1474 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1475 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1478 dwc3_trace(trace_dwc3_gadget,
1479 "can't wakeup from '%s'",
1480 dwc3_gadget_link_string(link_state));
1484 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1486 dev_err(dwc->dev, "failed to put link in Recovery\n");
1490 /* Recent versions do this automatically */
1491 if (dwc->revision < DWC3_REVISION_194A) {
1492 /* write zeroes to Link Change Request */
1493 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1494 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1495 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1498 /* poll until Link State changes to ON */
1502 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1504 /* in HS, means ON */
1505 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1509 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1510 dev_err(dwc->dev, "failed to send remote wakeup\n");
1517 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1519 struct dwc3 *dwc = gadget_to_dwc(g);
1520 unsigned long flags;
1523 spin_lock_irqsave(&dwc->lock, flags);
1524 ret = __dwc3_gadget_wakeup(dwc);
1525 spin_unlock_irqrestore(&dwc->lock, flags);
1530 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1533 struct dwc3 *dwc = gadget_to_dwc(g);
1534 unsigned long flags;
1536 spin_lock_irqsave(&dwc->lock, flags);
1537 g->is_selfpowered = !!is_selfpowered;
1538 spin_unlock_irqrestore(&dwc->lock, flags);
1543 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1548 if (pm_runtime_suspended(dwc->dev))
1551 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1553 if (dwc->revision <= DWC3_REVISION_187A) {
1554 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1555 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1558 if (dwc->revision >= DWC3_REVISION_194A)
1559 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1560 reg |= DWC3_DCTL_RUN_STOP;
1562 if (dwc->has_hibernation)
1563 reg |= DWC3_DCTL_KEEP_CONNECT;
1565 dwc->pullups_connected = true;
1567 reg &= ~DWC3_DCTL_RUN_STOP;
1569 if (dwc->has_hibernation && !suspend)
1570 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1572 dwc->pullups_connected = false;
1575 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1578 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1579 reg &= DWC3_DSTS_DEVCTRLHLT;
1580 } while (--timeout && !(!is_on ^ !reg));
1585 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1587 ? dwc->gadget_driver->function : "no-function",
1588 is_on ? "connect" : "disconnect");
1593 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1595 struct dwc3 *dwc = gadget_to_dwc(g);
1596 unsigned long flags;
1602 * Per databook, when we want to stop the gadget, if a control transfer
1603 * is still in process, complete it and get the core into setup phase.
1605 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
1606 reinit_completion(&dwc->ep0_in_setup);
1608 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
1609 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
1611 dev_err(dwc->dev, "timed out waiting for SETUP phase\n");
1616 spin_lock_irqsave(&dwc->lock, flags);
1617 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1618 spin_unlock_irqrestore(&dwc->lock, flags);
1623 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1627 /* Enable all but Start and End of Frame IRQs */
1628 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1629 DWC3_DEVTEN_EVNTOVERFLOWEN |
1630 DWC3_DEVTEN_CMDCMPLTEN |
1631 DWC3_DEVTEN_ERRTICERREN |
1632 DWC3_DEVTEN_WKUPEVTEN |
1633 DWC3_DEVTEN_CONNECTDONEEN |
1634 DWC3_DEVTEN_USBRSTEN |
1635 DWC3_DEVTEN_DISCONNEVTEN);
1637 if (dwc->revision < DWC3_REVISION_250A)
1638 reg |= DWC3_DEVTEN_ULSTCNGEN;
1640 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1643 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1645 /* mask all interrupts */
1646 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1649 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1650 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1653 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1654 * dwc: pointer to our context structure
1656 * The following looks like complex but it's actually very simple. In order to
1657 * calculate the number of packets we can burst at once on OUT transfers, we're
1658 * gonna use RxFIFO size.
1660 * To calculate RxFIFO size we need two numbers:
1661 * MDWIDTH = size, in bits, of the internal memory bus
1662 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1664 * Given these two numbers, the formula is simple:
1666 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1668 * 24 bytes is for 3x SETUP packets
1669 * 16 bytes is a clock domain crossing tolerance
1671 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1673 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1680 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1681 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1683 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1684 nump = min_t(u32, nump, 16);
1687 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1688 reg &= ~DWC3_DCFG_NUMP_MASK;
1689 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1690 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1693 static int __dwc3_gadget_start(struct dwc3 *dwc)
1695 struct dwc3_ep *dep;
1699 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1700 reg &= ~(DWC3_DCFG_SPEED_MASK);
1703 * WORKAROUND: DWC3 revision < 2.20a have an issue
1704 * which would cause metastability state on Run/Stop
1705 * bit if we try to force the IP to USB2-only mode.
1707 * Because of that, we cannot configure the IP to any
1708 * speed other than the SuperSpeed
1712 * STAR#9000525659: Clock Domain Crossing on DCTL in
1715 if (dwc->revision < DWC3_REVISION_220A) {
1716 reg |= DWC3_DCFG_SUPERSPEED;
1718 switch (dwc->maximum_speed) {
1720 reg |= DWC3_DCFG_LOWSPEED;
1722 case USB_SPEED_FULL:
1723 reg |= DWC3_DCFG_FULLSPEED1;
1725 case USB_SPEED_HIGH:
1726 reg |= DWC3_DCFG_HIGHSPEED;
1728 case USB_SPEED_SUPER_PLUS:
1729 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
1732 dev_err(dwc->dev, "invalid dwc->maximum_speed (%d)\n",
1733 dwc->maximum_speed);
1735 case USB_SPEED_SUPER:
1736 reg |= DWC3_DCFG_SUPERSPEED;
1740 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1743 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1744 * field instead of letting dwc3 itself calculate that automatically.
1746 * This way, we maximize the chances that we'll be able to get several
1747 * bursts of data without going through any sort of endpoint throttling.
1749 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1750 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1751 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1753 dwc3_gadget_setup_nump(dwc);
1755 /* Start with SuperSpeed Default */
1756 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1759 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1762 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1767 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1770 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1774 /* begin to receive SETUP packets */
1775 dwc->ep0state = EP0_SETUP_PHASE;
1776 dwc3_ep0_out_start(dwc);
1778 dwc3_gadget_enable_irq(dwc);
1783 __dwc3_gadget_ep_disable(dwc->eps[0]);
1789 static int dwc3_gadget_start(struct usb_gadget *g,
1790 struct usb_gadget_driver *driver)
1792 struct dwc3 *dwc = gadget_to_dwc(g);
1793 unsigned long flags;
1797 irq = dwc->irq_gadget;
1798 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1799 IRQF_SHARED, "dwc3", dwc->ev_buf);
1801 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1806 spin_lock_irqsave(&dwc->lock, flags);
1807 if (dwc->gadget_driver) {
1808 dev_err(dwc->dev, "%s is already bound to %s\n",
1810 dwc->gadget_driver->driver.name);
1815 dwc->gadget_driver = driver;
1817 if (pm_runtime_active(dwc->dev))
1818 __dwc3_gadget_start(dwc);
1820 spin_unlock_irqrestore(&dwc->lock, flags);
1825 spin_unlock_irqrestore(&dwc->lock, flags);
1832 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1834 dwc3_gadget_disable_irq(dwc);
1835 __dwc3_gadget_ep_disable(dwc->eps[0]);
1836 __dwc3_gadget_ep_disable(dwc->eps[1]);
1839 static int dwc3_gadget_stop(struct usb_gadget *g)
1841 struct dwc3 *dwc = gadget_to_dwc(g);
1842 unsigned long flags;
1845 spin_lock_irqsave(&dwc->lock, flags);
1847 if (pm_runtime_suspended(dwc->dev))
1850 __dwc3_gadget_stop(dwc);
1852 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1853 struct dwc3_ep *dep = dwc->eps[epnum];
1858 if (!(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
1861 wait_event_lock_irq(dep->wait_end_transfer,
1862 !(dep->flags & DWC3_EP_END_TRANSFER_PENDING),
1867 dwc->gadget_driver = NULL;
1868 spin_unlock_irqrestore(&dwc->lock, flags);
1870 free_irq(dwc->irq_gadget, dwc->ev_buf);
1875 static const struct usb_gadget_ops dwc3_gadget_ops = {
1876 .get_frame = dwc3_gadget_get_frame,
1877 .wakeup = dwc3_gadget_wakeup,
1878 .set_selfpowered = dwc3_gadget_set_selfpowered,
1879 .pullup = dwc3_gadget_pullup,
1880 .udc_start = dwc3_gadget_start,
1881 .udc_stop = dwc3_gadget_stop,
1884 /* -------------------------------------------------------------------------- */
1886 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1887 u8 num, u32 direction)
1889 struct dwc3_ep *dep;
1892 for (i = 0; i < num; i++) {
1893 u8 epnum = (i << 1) | (direction ? 1 : 0);
1895 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1900 dep->number = epnum;
1901 dep->direction = !!direction;
1902 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1903 dwc->eps[epnum] = dep;
1905 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1906 (epnum & 1) ? "in" : "out");
1908 dep->endpoint.name = dep->name;
1909 spin_lock_init(&dep->lock);
1911 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1913 if (epnum == 0 || epnum == 1) {
1914 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1915 dep->endpoint.maxburst = 1;
1916 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1918 dwc->gadget.ep0 = &dep->endpoint;
1922 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1923 dep->endpoint.max_streams = 15;
1924 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1925 list_add_tail(&dep->endpoint.ep_list,
1926 &dwc->gadget.ep_list);
1928 ret = dwc3_alloc_trb_pool(dep);
1933 if (epnum == 0 || epnum == 1) {
1934 dep->endpoint.caps.type_control = true;
1936 dep->endpoint.caps.type_iso = true;
1937 dep->endpoint.caps.type_bulk = true;
1938 dep->endpoint.caps.type_int = true;
1941 dep->endpoint.caps.dir_in = !!direction;
1942 dep->endpoint.caps.dir_out = !direction;
1944 INIT_LIST_HEAD(&dep->pending_list);
1945 INIT_LIST_HEAD(&dep->started_list);
1951 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1955 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1957 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1959 dwc3_trace(trace_dwc3_gadget,
1960 "failed to allocate OUT endpoints");
1964 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1966 dwc3_trace(trace_dwc3_gadget,
1967 "failed to allocate IN endpoints");
1974 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1976 struct dwc3_ep *dep;
1979 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1980 dep = dwc->eps[epnum];
1984 * Physical endpoints 0 and 1 are special; they form the
1985 * bi-directional USB endpoint 0.
1987 * For those two physical endpoints, we don't allocate a TRB
1988 * pool nor do we add them the endpoints list. Due to that, we
1989 * shouldn't do these two operations otherwise we would end up
1990 * with all sorts of bugs when removing dwc3.ko.
1992 if (epnum != 0 && epnum != 1) {
1993 dwc3_free_trb_pool(dep);
1994 list_del(&dep->endpoint.ep_list);
2001 /* -------------------------------------------------------------------------- */
2003 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
2004 struct dwc3_request *req, struct dwc3_trb *trb,
2005 const struct dwc3_event_depevt *event, int status,
2009 unsigned int s_pkt = 0;
2010 unsigned int trb_status;
2012 dwc3_ep_inc_deq(dep);
2014 if (req->trb == trb)
2015 dep->queued_requests--;
2017 trace_dwc3_complete_trb(dep, trb);
2020 * If we're in the middle of series of chained TRBs and we
2021 * receive a short transfer along the way, DWC3 will skip
2022 * through all TRBs including the last TRB in the chain (the
2023 * where CHN bit is zero. DWC3 will also avoid clearing HWO
2024 * bit and SW has to do it manually.
2026 * We're going to do that here to avoid problems of HW trying
2027 * to use bogus TRBs for transfers.
2029 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
2030 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2032 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
2035 count = trb->size & DWC3_TRB_SIZE_MASK;
2036 req->remaining += count;
2038 if (dep->direction) {
2040 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
2041 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
2042 dwc3_trace(trace_dwc3_gadget,
2043 "%s: incomplete IN transfer",
2046 * If missed isoc occurred and there is
2047 * no request queued then issue END
2048 * TRANSFER, so that core generates
2049 * next xfernotready and we will issue
2050 * a fresh START TRANSFER.
2051 * If there are still queued request
2052 * then wait, do not issue either END
2053 * or UPDATE TRANSFER, just attach next
2054 * request in pending_list during
2055 * giveback.If any future queued request
2056 * is successfully transferred then we
2057 * will issue UPDATE TRANSFER for all
2058 * request in the pending_list.
2060 dep->flags |= DWC3_EP_MISSED_ISOC;
2062 dev_err(dwc->dev, "incomplete IN transfer %s\n",
2064 status = -ECONNRESET;
2067 dep->flags &= ~DWC3_EP_MISSED_ISOC;
2070 if (count && (event->status & DEPEVT_STATUS_SHORT))
2074 if (s_pkt && !chain)
2077 if ((event->status & DEPEVT_STATUS_IOC) &&
2078 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2084 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
2085 const struct dwc3_event_depevt *event, int status)
2087 struct dwc3_request *req, *n;
2088 struct dwc3_trb *trb;
2092 list_for_each_entry_safe(req, n, &dep->started_list, list) {
2096 length = req->request.length;
2097 chain = req->num_pending_sgs > 0;
2099 struct scatterlist *sg = req->sg;
2100 struct scatterlist *s;
2101 unsigned int pending = req->num_pending_sgs;
2104 for_each_sg(sg, s, pending, i) {
2105 trb = &dep->trb_pool[dep->trb_dequeue];
2107 if (trb->ctrl & DWC3_TRB_CTRL_HWO)
2110 req->sg = sg_next(s);
2111 req->num_pending_sgs--;
2113 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2114 event, status, chain);
2119 trb = &dep->trb_pool[dep->trb_dequeue];
2120 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2121 event, status, chain);
2124 req->request.actual = length - req->remaining;
2126 if ((req->request.actual < length) && req->num_pending_sgs)
2127 return __dwc3_gadget_kick_transfer(dep, 0);
2129 dwc3_gadget_giveback(dep, req, status);
2132 if ((event->status & DEPEVT_STATUS_IOC) &&
2133 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2140 * Our endpoint might get disabled by another thread during
2141 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2142 * early on so DWC3_EP_BUSY flag gets cleared
2144 if (!dep->endpoint.desc)
2147 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2148 list_empty(&dep->started_list)) {
2149 if (list_empty(&dep->pending_list)) {
2151 * If there is no entry in request list then do
2152 * not issue END TRANSFER now. Just set PENDING
2153 * flag, so that END TRANSFER is issued when an
2154 * entry is added into request list.
2156 dep->flags = DWC3_EP_PENDING_REQUEST;
2158 dwc3_stop_active_transfer(dwc, dep->number, true);
2159 dep->flags = DWC3_EP_ENABLED;
2164 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) && ioc)
2170 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2171 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2173 unsigned status = 0;
2175 u32 is_xfer_complete;
2177 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2179 if (event->status & DEPEVT_STATUS_BUSERR)
2180 status = -ECONNRESET;
2182 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2183 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2184 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2185 dep->flags &= ~DWC3_EP_BUSY;
2188 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2189 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2191 if (dwc->revision < DWC3_REVISION_183A) {
2195 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2198 if (!(dep->flags & DWC3_EP_ENABLED))
2201 if (!list_empty(&dep->started_list))
2205 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2207 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2213 * Our endpoint might get disabled by another thread during
2214 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2215 * early on so DWC3_EP_BUSY flag gets cleared
2217 if (!dep->endpoint.desc)
2220 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2223 ret = __dwc3_gadget_kick_transfer(dep, 0);
2224 if (!ret || ret == -EBUSY)
2229 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2230 const struct dwc3_event_depevt *event)
2232 struct dwc3_ep *dep;
2233 u8 epnum = event->endpoint_number;
2236 dep = dwc->eps[epnum];
2238 if (!(dep->flags & DWC3_EP_ENABLED) &&
2239 !(dep->flags & DWC3_EP_END_TRANSFER_PENDING))
2242 if (epnum == 0 || epnum == 1) {
2243 dwc3_ep0_interrupt(dwc, event);
2247 switch (event->endpoint_event) {
2248 case DWC3_DEPEVT_XFERCOMPLETE:
2249 dep->resource_index = 0;
2251 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2252 dev_err(dwc->dev, "XferComplete for Isochronous endpoint\n");
2256 dwc3_endpoint_transfer_complete(dwc, dep, event);
2258 case DWC3_DEPEVT_XFERINPROGRESS:
2259 dwc3_endpoint_transfer_complete(dwc, dep, event);
2261 case DWC3_DEPEVT_XFERNOTREADY:
2262 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2263 dwc3_gadget_start_isoc(dwc, dep, event);
2267 ret = __dwc3_gadget_kick_transfer(dep, 0);
2268 if (!ret || ret == -EBUSY)
2273 case DWC3_DEPEVT_STREAMEVT:
2274 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2275 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2280 case DWC3_DEPEVT_EPCMDCMPLT:
2281 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
2283 if (cmd == DWC3_DEPCMD_ENDTRANSFER) {
2284 dep->flags &= ~DWC3_EP_END_TRANSFER_PENDING;
2285 wake_up(&dep->wait_end_transfer);
2288 case DWC3_DEPEVT_RXTXFIFOEVT:
2293 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2295 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2296 spin_unlock(&dwc->lock);
2297 dwc->gadget_driver->disconnect(&dwc->gadget);
2298 spin_lock(&dwc->lock);
2302 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2304 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2305 spin_unlock(&dwc->lock);
2306 dwc->gadget_driver->suspend(&dwc->gadget);
2307 spin_lock(&dwc->lock);
2311 static void dwc3_resume_gadget(struct dwc3 *dwc)
2313 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2314 spin_unlock(&dwc->lock);
2315 dwc->gadget_driver->resume(&dwc->gadget);
2316 spin_lock(&dwc->lock);
2320 static void dwc3_reset_gadget(struct dwc3 *dwc)
2322 if (!dwc->gadget_driver)
2325 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2326 spin_unlock(&dwc->lock);
2327 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2328 spin_lock(&dwc->lock);
2332 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2334 struct dwc3_ep *dep;
2335 struct dwc3_gadget_ep_cmd_params params;
2339 dep = dwc->eps[epnum];
2341 if ((dep->flags & DWC3_EP_END_TRANSFER_PENDING) ||
2342 !dep->resource_index)
2346 * NOTICE: We are violating what the Databook says about the
2347 * EndTransfer command. Ideally we would _always_ wait for the
2348 * EndTransfer Command Completion IRQ, but that's causing too
2349 * much trouble synchronizing between us and gadget driver.
2351 * We have discussed this with the IP Provider and it was
2352 * suggested to giveback all requests here, but give HW some
2353 * extra time to synchronize with the interconnect. We're using
2354 * an arbitrary 100us delay for that.
2356 * Note also that a similar handling was tested by Synopsys
2357 * (thanks a lot Paul) and nothing bad has come out of it.
2358 * In short, what we're doing is:
2360 * - Issue EndTransfer WITH CMDIOC bit set
2363 * As of IP version 3.10a of the DWC_usb3 IP, the controller
2364 * supports a mode to work around the above limitation. The
2365 * software can poll the CMDACT bit in the DEPCMD register
2366 * after issuing a EndTransfer command. This mode is enabled
2367 * by writing GUCTL2[14]. This polling is already done in the
2368 * dwc3_send_gadget_ep_cmd() function so if the mode is
2369 * enabled, the EndTransfer command will have completed upon
2370 * returning from this function and we don't need to delay for
2373 * This mode is NOT available on the DWC_usb31 IP.
2376 cmd = DWC3_DEPCMD_ENDTRANSFER;
2377 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2378 cmd |= DWC3_DEPCMD_CMDIOC;
2379 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2380 memset(¶ms, 0, sizeof(params));
2381 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2383 dep->resource_index = 0;
2384 dep->flags &= ~DWC3_EP_BUSY;
2386 if (dwc3_is_usb31(dwc) || dwc->revision < DWC3_REVISION_310A) {
2387 dep->flags |= DWC3_EP_END_TRANSFER_PENDING;
2392 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2396 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2397 struct dwc3_ep *dep;
2400 dep = dwc->eps[epnum];
2404 if (!(dep->flags & DWC3_EP_STALL))
2407 dep->flags &= ~DWC3_EP_STALL;
2409 ret = dwc3_send_clear_stall_ep_cmd(dep);
2414 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2418 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2419 reg &= ~DWC3_DCTL_INITU1ENA;
2420 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2422 reg &= ~DWC3_DCTL_INITU2ENA;
2423 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2425 dwc3_disconnect_gadget(dwc);
2427 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2428 dwc->setup_packet_pending = false;
2429 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2431 dwc->connected = false;
2434 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2438 dwc->connected = true;
2441 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2442 * would cause a missing Disconnect Event if there's a
2443 * pending Setup Packet in the FIFO.
2445 * There's no suggested workaround on the official Bug
2446 * report, which states that "unless the driver/application
2447 * is doing any special handling of a disconnect event,
2448 * there is no functional issue".
2450 * Unfortunately, it turns out that we _do_ some special
2451 * handling of a disconnect event, namely complete all
2452 * pending transfers, notify gadget driver of the
2453 * disconnection, and so on.
2455 * Our suggested workaround is to follow the Disconnect
2456 * Event steps here, instead, based on a setup_packet_pending
2457 * flag. Such flag gets set whenever we have a SETUP_PENDING
2458 * status for EP0 TRBs and gets cleared on XferComplete for the
2463 * STAR#9000466709: RTL: Device : Disconnect event not
2464 * generated if setup packet pending in FIFO
2466 if (dwc->revision < DWC3_REVISION_188A) {
2467 if (dwc->setup_packet_pending)
2468 dwc3_gadget_disconnect_interrupt(dwc);
2471 dwc3_reset_gadget(dwc);
2473 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2474 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2475 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2476 dwc->test_mode = false;
2477 dwc3_clear_stall_all_ep(dwc);
2479 /* Reset device address to zero */
2480 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2481 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2482 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2485 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2488 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2491 * We change the clock only at SS but I dunno why I would want to do
2492 * this. Maybe it becomes part of the power saving plan.
2495 if ((speed != DWC3_DSTS_SUPERSPEED) &&
2496 (speed != DWC3_DSTS_SUPERSPEED_PLUS))
2500 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2501 * each time on Connect Done.
2506 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2507 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2508 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2511 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2513 struct dwc3_ep *dep;
2518 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2519 speed = reg & DWC3_DSTS_CONNECTSPD;
2522 dwc3_update_ram_clk_sel(dwc, speed);
2525 case DWC3_DSTS_SUPERSPEED_PLUS:
2526 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2527 dwc->gadget.ep0->maxpacket = 512;
2528 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2530 case DWC3_DSTS_SUPERSPEED:
2532 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2533 * would cause a missing USB3 Reset event.
2535 * In such situations, we should force a USB3 Reset
2536 * event by calling our dwc3_gadget_reset_interrupt()
2541 * STAR#9000483510: RTL: SS : USB3 reset event may
2542 * not be generated always when the link enters poll
2544 if (dwc->revision < DWC3_REVISION_190A)
2545 dwc3_gadget_reset_interrupt(dwc);
2547 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2548 dwc->gadget.ep0->maxpacket = 512;
2549 dwc->gadget.speed = USB_SPEED_SUPER;
2551 case DWC3_DSTS_HIGHSPEED:
2552 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2553 dwc->gadget.ep0->maxpacket = 64;
2554 dwc->gadget.speed = USB_SPEED_HIGH;
2556 case DWC3_DSTS_FULLSPEED2:
2557 case DWC3_DSTS_FULLSPEED1:
2558 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2559 dwc->gadget.ep0->maxpacket = 64;
2560 dwc->gadget.speed = USB_SPEED_FULL;
2562 case DWC3_DSTS_LOWSPEED:
2563 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2564 dwc->gadget.ep0->maxpacket = 8;
2565 dwc->gadget.speed = USB_SPEED_LOW;
2569 /* Enable USB2 LPM Capability */
2571 if ((dwc->revision > DWC3_REVISION_194A) &&
2572 (speed != DWC3_DSTS_SUPERSPEED) &&
2573 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2574 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2575 reg |= DWC3_DCFG_LPM_CAP;
2576 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2578 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2579 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2581 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2584 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2585 * DCFG.LPMCap is set, core responses with an ACK and the
2586 * BESL value in the LPM token is less than or equal to LPM
2589 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2590 && dwc->has_lpm_erratum,
2591 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2593 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2594 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2596 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2598 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2599 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2600 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2604 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2607 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2612 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2615 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2620 * Configure PHY via GUSB3PIPECTLn if required.
2622 * Update GTXFIFOSIZn
2624 * In both cases reset values should be sufficient.
2628 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2631 * TODO take core out of low power mode when that's
2635 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2636 spin_unlock(&dwc->lock);
2637 dwc->gadget_driver->resume(&dwc->gadget);
2638 spin_lock(&dwc->lock);
2642 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2643 unsigned int evtinfo)
2645 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2646 unsigned int pwropt;
2649 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2650 * Hibernation mode enabled which would show up when device detects
2651 * host-initiated U3 exit.
2653 * In that case, device will generate a Link State Change Interrupt
2654 * from U3 to RESUME which is only necessary if Hibernation is
2657 * There are no functional changes due to such spurious event and we
2658 * just need to ignore it.
2662 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2665 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2666 if ((dwc->revision < DWC3_REVISION_250A) &&
2667 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2668 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2669 (next == DWC3_LINK_STATE_RESUME)) {
2670 dwc3_trace(trace_dwc3_gadget,
2671 "ignoring transition U3 -> Resume");
2677 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2678 * on the link partner, the USB session might do multiple entry/exit
2679 * of low power states before a transfer takes place.
2681 * Due to this problem, we might experience lower throughput. The
2682 * suggested workaround is to disable DCTL[12:9] bits if we're
2683 * transitioning from U1/U2 to U0 and enable those bits again
2684 * after a transfer completes and there are no pending transfers
2685 * on any of the enabled endpoints.
2687 * This is the first half of that workaround.
2691 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2692 * core send LGO_Ux entering U0
2694 if (dwc->revision < DWC3_REVISION_183A) {
2695 if (next == DWC3_LINK_STATE_U0) {
2699 switch (dwc->link_state) {
2700 case DWC3_LINK_STATE_U1:
2701 case DWC3_LINK_STATE_U2:
2702 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2703 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2704 | DWC3_DCTL_ACCEPTU2ENA
2705 | DWC3_DCTL_INITU1ENA
2706 | DWC3_DCTL_ACCEPTU1ENA);
2709 dwc->u1u2 = reg & u1u2;
2713 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2723 case DWC3_LINK_STATE_U1:
2724 if (dwc->speed == USB_SPEED_SUPER)
2725 dwc3_suspend_gadget(dwc);
2727 case DWC3_LINK_STATE_U2:
2728 case DWC3_LINK_STATE_U3:
2729 dwc3_suspend_gadget(dwc);
2731 case DWC3_LINK_STATE_RESUME:
2732 dwc3_resume_gadget(dwc);
2739 dwc->link_state = next;
2742 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
2743 unsigned int evtinfo)
2745 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2747 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
2748 dwc3_suspend_gadget(dwc);
2750 dwc->link_state = next;
2753 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2754 unsigned int evtinfo)
2756 unsigned int is_ss = evtinfo & BIT(4);
2759 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2760 * have a known issue which can cause USB CV TD.9.23 to fail
2763 * Because of this issue, core could generate bogus hibernation
2764 * events which SW needs to ignore.
2768 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2769 * Device Fallback from SuperSpeed
2771 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2774 /* enter hibernation here */
2777 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2778 const struct dwc3_event_devt *event)
2780 switch (event->type) {
2781 case DWC3_DEVICE_EVENT_DISCONNECT:
2782 dwc3_gadget_disconnect_interrupt(dwc);
2784 case DWC3_DEVICE_EVENT_RESET:
2785 dwc3_gadget_reset_interrupt(dwc);
2787 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2788 dwc3_gadget_conndone_interrupt(dwc);
2790 case DWC3_DEVICE_EVENT_WAKEUP:
2791 dwc3_gadget_wakeup_interrupt(dwc);
2793 case DWC3_DEVICE_EVENT_HIBER_REQ:
2794 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2795 "unexpected hibernation event\n"))
2798 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2800 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2801 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2803 case DWC3_DEVICE_EVENT_EOPF:
2804 /* It changed to be suspend event for version 2.30a and above */
2805 if (dwc->revision < DWC3_REVISION_230A) {
2806 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2808 dwc3_trace(trace_dwc3_gadget, "U3/L1-L2 Suspend Event");
2811 * Ignore suspend event until the gadget enters into
2812 * USB_STATE_CONFIGURED state.
2814 if (dwc->gadget.state >= USB_STATE_CONFIGURED)
2815 dwc3_gadget_suspend_interrupt(dwc,
2819 case DWC3_DEVICE_EVENT_SOF:
2820 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2821 case DWC3_DEVICE_EVENT_CMD_CMPL:
2822 case DWC3_DEVICE_EVENT_OVERFLOW:
2825 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2829 static void dwc3_process_event_entry(struct dwc3 *dwc,
2830 const union dwc3_event *event)
2832 trace_dwc3_event(event->raw, dwc);
2834 /* Endpoint IRQ, handle it and return early */
2835 if (event->type.is_devspec == 0) {
2837 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2840 switch (event->type.type) {
2841 case DWC3_EVENT_TYPE_DEV:
2842 dwc3_gadget_interrupt(dwc, &event->devt);
2844 /* REVISIT what to do with Carkit and I2C events ? */
2846 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2850 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2852 struct dwc3 *dwc = evt->dwc;
2853 irqreturn_t ret = IRQ_NONE;
2859 if (!(evt->flags & DWC3_EVENT_PENDING))
2863 union dwc3_event event;
2865 event.raw = *(u32 *) (evt->buf + evt->lpos);
2867 dwc3_process_event_entry(dwc, &event);
2870 * FIXME we wrap around correctly to the next entry as
2871 * almost all entries are 4 bytes in size. There is one
2872 * entry which has 12 bytes which is a regular entry
2873 * followed by 8 bytes data. ATM I don't know how
2874 * things are organized if we get next to the a
2875 * boundary so I worry about that once we try to handle
2878 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2881 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2885 evt->flags &= ~DWC3_EVENT_PENDING;
2888 /* Unmask interrupt */
2889 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2890 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2891 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2896 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2898 struct dwc3_event_buffer *evt = _evt;
2899 struct dwc3 *dwc = evt->dwc;
2900 unsigned long flags;
2901 irqreturn_t ret = IRQ_NONE;
2903 spin_lock_irqsave(&dwc->lock, flags);
2904 ret = dwc3_process_event_buf(evt);
2905 spin_unlock_irqrestore(&dwc->lock, flags);
2910 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2912 struct dwc3 *dwc = evt->dwc;
2916 if (pm_runtime_suspended(dwc->dev)) {
2917 pm_runtime_get(dwc->dev);
2918 disable_irq_nosync(dwc->irq_gadget);
2919 dwc->pending_events = true;
2923 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2924 count &= DWC3_GEVNTCOUNT_MASK;
2929 evt->flags |= DWC3_EVENT_PENDING;
2931 /* Mask interrupt */
2932 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2933 reg |= DWC3_GEVNTSIZ_INTMASK;
2934 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2936 return IRQ_WAKE_THREAD;
2939 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2941 struct dwc3_event_buffer *evt = _evt;
2943 return dwc3_check_event_buf(evt);
2946 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
2948 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
2951 irq = platform_get_irq_byname(dwc3_pdev, "peripheral");
2955 if (irq == -EPROBE_DEFER)
2958 irq = platform_get_irq_byname(dwc3_pdev, "dwc_usb3");
2962 if (irq == -EPROBE_DEFER)
2965 irq = platform_get_irq(dwc3_pdev, 0);
2969 if (irq != -EPROBE_DEFER)
2970 dev_err(dwc->dev, "missing peripheral IRQ\n");
2980 * dwc3_gadget_init - Initializes gadget related registers
2981 * @dwc: pointer to our controller context structure
2983 * Returns 0 on success otherwise negative errno.
2985 int dwc3_gadget_init(struct dwc3 *dwc)
2990 irq = dwc3_gadget_get_irq(dwc);
2996 dwc->irq_gadget = irq;
2998 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2999 &dwc->ctrl_req_addr, GFP_KERNEL);
3000 if (!dwc->ctrl_req) {
3001 dev_err(dwc->dev, "failed to allocate ctrl request\n");
3006 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
3007 &dwc->ep0_trb_addr, GFP_KERNEL);
3008 if (!dwc->ep0_trb) {
3009 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
3014 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
3015 if (!dwc->setup_buf) {
3020 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
3021 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
3023 if (!dwc->ep0_bounce) {
3024 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
3029 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
3030 if (!dwc->zlp_buf) {
3035 init_completion(&dwc->ep0_in_setup);
3037 dwc->gadget.ops = &dwc3_gadget_ops;
3038 dwc->gadget.speed = USB_SPEED_UNKNOWN;
3039 dwc->gadget.sg_supported = true;
3040 dwc->gadget.name = "dwc3-gadget";
3041 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
3044 * FIXME We might be setting max_speed to <SUPER, however versions
3045 * <2.20a of dwc3 have an issue with metastability (documented
3046 * elsewhere in this driver) which tells us we can't set max speed to
3047 * anything lower than SUPER.
3049 * Because gadget.max_speed is only used by composite.c and function
3050 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
3051 * to happen so we avoid sending SuperSpeed Capability descriptor
3052 * together with our BOS descriptor as that could confuse host into
3053 * thinking we can handle super speed.
3055 * Note that, in fact, we won't even support GetBOS requests when speed
3056 * is less than super speed because we don't have means, yet, to tell
3057 * composite.c that we are USB 2.0 + LPM ECN.
3059 if (dwc->revision < DWC3_REVISION_220A)
3060 dwc3_trace(trace_dwc3_gadget,
3061 "Changing max_speed on rev %08x",
3064 dwc->gadget.max_speed = dwc->maximum_speed;
3067 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
3070 dwc->gadget.quirk_ep_out_aligned_size = true;
3073 * REVISIT: Here we should clear all pending IRQs to be
3074 * sure we're starting from a well known location.
3077 ret = dwc3_gadget_init_endpoints(dwc);
3081 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
3083 dev_err(dwc->dev, "failed to register udc\n");
3090 kfree(dwc->zlp_buf);
3093 dwc3_gadget_free_endpoints(dwc);
3094 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3095 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3098 kfree(dwc->setup_buf);
3101 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
3102 dwc->ep0_trb, dwc->ep0_trb_addr);
3105 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3106 dwc->ctrl_req, dwc->ctrl_req_addr);
3112 /* -------------------------------------------------------------------------- */
3114 void dwc3_gadget_exit(struct dwc3 *dwc)
3116 usb_del_gadget_udc(&dwc->gadget);
3118 dwc3_gadget_free_endpoints(dwc);
3120 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3121 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3123 kfree(dwc->setup_buf);
3124 kfree(dwc->zlp_buf);
3126 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
3127 dwc->ep0_trb, dwc->ep0_trb_addr);
3129 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3130 dwc->ctrl_req, dwc->ctrl_req_addr);
3133 int dwc3_gadget_suspend(struct dwc3 *dwc)
3137 if (!dwc->gadget_driver)
3140 ret = dwc3_gadget_run_stop(dwc, false, false);
3144 dwc3_disconnect_gadget(dwc);
3145 __dwc3_gadget_stop(dwc);
3150 int dwc3_gadget_resume(struct dwc3 *dwc)
3154 if (!dwc->gadget_driver)
3157 ret = __dwc3_gadget_start(dwc);
3161 ret = dwc3_gadget_run_stop(dwc, true, false);
3168 __dwc3_gadget_stop(dwc);
3174 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3176 if (dwc->pending_events) {
3177 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3178 dwc->pending_events = false;
3179 enable_irq(dwc->irq_gadget);