2 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
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");
148 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
151 dep->trb_enqueue %= DWC3_TRB_NUM;
154 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
157 dep->trb_dequeue %= DWC3_TRB_NUM;
160 static int dwc3_ep_is_last_trb(unsigned int index)
162 return index == DWC3_TRB_NUM - 1;
165 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
168 struct dwc3 *dwc = dep->dwc;
174 dwc3_ep_inc_deq(dep);
176 * Skip LINK TRB. We can't use req->trb and check for
177 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
178 * just completed (not the LINK TRB).
180 if (dwc3_ep_is_last_trb(dep->trb_dequeue))
181 dwc3_ep_inc_deq(dep);
182 } while(++i < req->request.num_mapped_sgs);
183 req->started = false;
185 list_del(&req->list);
188 if (req->request.status == -EINPROGRESS)
189 req->request.status = status;
191 if (dwc->ep0_bounced && dep->number == 0)
192 dwc->ep0_bounced = false;
194 usb_gadget_unmap_request(&dwc->gadget, &req->request,
197 trace_dwc3_gadget_giveback(req);
199 spin_unlock(&dwc->lock);
200 usb_gadget_giveback_request(&dep->endpoint, &req->request);
201 spin_lock(&dwc->lock);
204 pm_runtime_put(dwc->dev);
207 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
212 trace_dwc3_gadget_generic_cmd(cmd, param);
214 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
215 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
218 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
219 if (!(reg & DWC3_DGCMD_CMDACT)) {
220 dwc3_trace(trace_dwc3_gadget,
221 "Command Complete --> %d",
222 DWC3_DGCMD_STATUS(reg));
223 if (DWC3_DGCMD_STATUS(reg))
229 * We can't sleep here, because it's also called from
234 dwc3_trace(trace_dwc3_gadget,
235 "Command Timed Out");
242 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
244 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
245 struct dwc3_gadget_ep_cmd_params *params)
247 struct dwc3 *dwc = dep->dwc;
254 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
257 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
258 * we're issuing an endpoint command, we must check if
259 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
261 * We will also set SUSPHY bit to what it was before returning as stated
262 * by the same section on Synopsys databook.
264 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
265 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
266 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
268 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
269 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
273 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
276 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
277 dwc->link_state == DWC3_LINK_STATE_U2 ||
278 dwc->link_state == DWC3_LINK_STATE_U3);
280 if (unlikely(needs_wakeup)) {
281 ret = __dwc3_gadget_wakeup(dwc);
282 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
287 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
288 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
289 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
291 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
293 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
294 if (!(reg & DWC3_DEPCMD_CMDACT)) {
295 int cmd_status = DWC3_DEPCMD_STATUS(reg);
297 dwc3_trace(trace_dwc3_gadget,
298 "Command Complete --> %d",
301 switch (cmd_status) {
305 case DEPEVT_TRANSFER_NO_RESOURCE:
306 dwc3_trace(trace_dwc3_gadget, "no resource available");
309 case DEPEVT_TRANSFER_BUS_EXPIRY:
311 * SW issues START TRANSFER command to
312 * isochronous ep with future frame interval. If
313 * future interval time has already passed when
314 * core receives the command, it will respond
315 * with an error status of 'Bus Expiry'.
317 * Instead of always returning -EINVAL, let's
318 * give a hint to the gadget driver that this is
319 * the case by returning -EAGAIN.
321 dwc3_trace(trace_dwc3_gadget, "bus expiry");
325 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
333 dwc3_trace(trace_dwc3_gadget,
334 "Command Timed Out");
338 if (unlikely(susphy)) {
339 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
340 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
341 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
347 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
349 struct dwc3 *dwc = dep->dwc;
350 struct dwc3_gadget_ep_cmd_params params;
351 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
354 * As of core revision 2.60a the recommended programming model
355 * is to set the ClearPendIN bit when issuing a Clear Stall EP
356 * command for IN endpoints. This is to prevent an issue where
357 * some (non-compliant) hosts may not send ACK TPs for pending
358 * IN transfers due to a mishandled error condition. Synopsys
361 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
362 cmd |= DWC3_DEPCMD_CLEARPENDIN;
364 memset(¶ms, 0, sizeof(params));
366 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
369 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
370 struct dwc3_trb *trb)
372 u32 offset = (char *) trb - (char *) dep->trb_pool;
374 return dep->trb_pool_dma + offset;
377 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
379 struct dwc3 *dwc = dep->dwc;
384 dep->trb_pool = dma_alloc_coherent(dwc->dev,
385 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
386 &dep->trb_pool_dma, GFP_KERNEL);
387 if (!dep->trb_pool) {
388 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
396 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
398 struct dwc3 *dwc = dep->dwc;
400 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
401 dep->trb_pool, dep->trb_pool_dma);
403 dep->trb_pool = NULL;
404 dep->trb_pool_dma = 0;
407 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
410 * dwc3_gadget_start_config - Configure EP resources
411 * @dwc: pointer to our controller context structure
412 * @dep: endpoint that is being enabled
414 * The assignment of transfer resources cannot perfectly follow the
415 * data book due to the fact that the controller driver does not have
416 * all knowledge of the configuration in advance. It is given this
417 * information piecemeal by the composite gadget framework after every
418 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
419 * programming model in this scenario can cause errors. For two
422 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
423 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
424 * multiple interfaces.
426 * 2) The databook does not mention doing more DEPXFERCFG for new
427 * endpoint on alt setting (8.1.6).
429 * The following simplified method is used instead:
431 * All hardware endpoints can be assigned a transfer resource and this
432 * setting will stay persistent until either a core reset or
433 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
434 * do DEPXFERCFG for every hardware endpoint as well. We are
435 * guaranteed that there are as many transfer resources as endpoints.
437 * This function is called for each endpoint when it is being enabled
438 * but is triggered only when called for EP0-out, which always happens
439 * first, and which should only happen in one of the above conditions.
441 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
443 struct dwc3_gadget_ep_cmd_params params;
451 memset(¶ms, 0x00, sizeof(params));
452 cmd = DWC3_DEPCMD_DEPSTARTCFG;
454 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
458 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
459 struct dwc3_ep *dep = dwc->eps[i];
464 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
472 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
473 const struct usb_endpoint_descriptor *desc,
474 const struct usb_ss_ep_comp_descriptor *comp_desc,
475 bool ignore, bool restore)
477 struct dwc3_gadget_ep_cmd_params params;
479 memset(¶ms, 0x00, sizeof(params));
481 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
482 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
484 /* Burst size is only needed in SuperSpeed mode */
485 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
486 u32 burst = dep->endpoint.maxburst;
487 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
491 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
494 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
495 params.param2 |= dep->saved_state;
498 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
499 | DWC3_DEPCFG_XFER_NOT_READY_EN;
501 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
502 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
503 | DWC3_DEPCFG_STREAM_EVENT_EN;
504 dep->stream_capable = true;
507 if (!usb_endpoint_xfer_control(desc))
508 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
511 * We are doing 1:1 mapping for endpoints, meaning
512 * Physical Endpoints 2 maps to Logical Endpoint 2 and
513 * so on. We consider the direction bit as part of the physical
514 * endpoint number. So USB endpoint 0x81 is 0x03.
516 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
519 * We must use the lower 16 TX FIFOs even though
523 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
525 if (desc->bInterval) {
526 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
527 dep->interval = 1 << (desc->bInterval - 1);
530 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
533 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
535 struct dwc3_gadget_ep_cmd_params params;
537 memset(¶ms, 0x00, sizeof(params));
539 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
541 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
546 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
547 * @dep: endpoint to be initialized
548 * @desc: USB Endpoint Descriptor
550 * Caller should take care of locking
552 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
553 const struct usb_endpoint_descriptor *desc,
554 const struct usb_ss_ep_comp_descriptor *comp_desc,
555 bool ignore, bool restore)
557 struct dwc3 *dwc = dep->dwc;
561 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
563 if (!(dep->flags & DWC3_EP_ENABLED)) {
564 ret = dwc3_gadget_start_config(dwc, dep);
569 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
574 if (!(dep->flags & DWC3_EP_ENABLED)) {
575 struct dwc3_trb *trb_st_hw;
576 struct dwc3_trb *trb_link;
578 dep->endpoint.desc = desc;
579 dep->comp_desc = comp_desc;
580 dep->type = usb_endpoint_type(desc);
581 dep->flags |= DWC3_EP_ENABLED;
583 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
584 reg |= DWC3_DALEPENA_EP(dep->number);
585 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
587 if (usb_endpoint_xfer_control(desc))
590 /* Link TRB. The HWO bit is never reset */
591 trb_st_hw = &dep->trb_pool[0];
593 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
594 memset(trb_link, 0, sizeof(*trb_link));
596 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
597 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
598 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
599 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
605 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
606 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
608 struct dwc3_request *req;
610 if (!list_empty(&dep->started_list)) {
611 dwc3_stop_active_transfer(dwc, dep->number, true);
613 /* - giveback all requests to gadget driver */
614 while (!list_empty(&dep->started_list)) {
615 req = next_request(&dep->started_list);
617 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
621 while (!list_empty(&dep->pending_list)) {
622 req = next_request(&dep->pending_list);
624 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
629 * __dwc3_gadget_ep_disable - Disables a HW endpoint
630 * @dep: the endpoint to disable
632 * This function also removes requests which are currently processed ny the
633 * hardware and those which are not yet scheduled.
634 * Caller should take care of locking.
636 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
638 struct dwc3 *dwc = dep->dwc;
641 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
643 dwc3_remove_requests(dwc, dep);
645 /* make sure HW endpoint isn't stalled */
646 if (dep->flags & DWC3_EP_STALL)
647 __dwc3_gadget_ep_set_halt(dep, 0, false);
649 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
650 reg &= ~DWC3_DALEPENA_EP(dep->number);
651 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
653 dep->stream_capable = false;
654 dep->endpoint.desc = NULL;
655 dep->comp_desc = NULL;
662 /* -------------------------------------------------------------------------- */
664 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
665 const struct usb_endpoint_descriptor *desc)
670 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
675 /* -------------------------------------------------------------------------- */
677 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
678 const struct usb_endpoint_descriptor *desc)
685 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
686 pr_debug("dwc3: invalid parameters\n");
690 if (!desc->wMaxPacketSize) {
691 pr_debug("dwc3: missing wMaxPacketSize\n");
695 dep = to_dwc3_ep(ep);
698 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
699 "%s is already enabled\n",
703 spin_lock_irqsave(&dwc->lock, flags);
704 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
705 spin_unlock_irqrestore(&dwc->lock, flags);
710 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
718 pr_debug("dwc3: invalid parameters\n");
722 dep = to_dwc3_ep(ep);
725 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
726 "%s is already disabled\n",
730 spin_lock_irqsave(&dwc->lock, flags);
731 ret = __dwc3_gadget_ep_disable(dep);
732 spin_unlock_irqrestore(&dwc->lock, flags);
737 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
740 struct dwc3_request *req;
741 struct dwc3_ep *dep = to_dwc3_ep(ep);
743 req = kzalloc(sizeof(*req), gfp_flags);
747 req->epnum = dep->number;
750 trace_dwc3_alloc_request(req);
752 return &req->request;
755 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
756 struct usb_request *request)
758 struct dwc3_request *req = to_dwc3_request(request);
760 trace_dwc3_free_request(req);
765 * dwc3_prepare_one_trb - setup one TRB from one request
766 * @dep: endpoint for which this request is prepared
767 * @req: dwc3_request pointer
769 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
770 struct dwc3_request *req, dma_addr_t dma,
771 unsigned length, unsigned last, unsigned chain, unsigned node)
773 struct dwc3_trb *trb;
775 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
776 dep->name, req, (unsigned long long) dma,
777 length, last ? " last" : "",
778 chain ? " chain" : "");
781 trb = &dep->trb_pool[dep->trb_enqueue];
784 dwc3_gadget_move_started_request(req);
786 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
787 req->first_trb_index = dep->trb_enqueue;
790 dwc3_ep_inc_enq(dep);
791 /* Skip the LINK-TRB */
792 if (dwc3_ep_is_last_trb(dep->trb_enqueue))
793 dwc3_ep_inc_enq(dep);
795 trb->size = DWC3_TRB_SIZE_LENGTH(length);
796 trb->bpl = lower_32_bits(dma);
797 trb->bph = upper_32_bits(dma);
799 switch (usb_endpoint_type(dep->endpoint.desc)) {
800 case USB_ENDPOINT_XFER_CONTROL:
801 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
804 case USB_ENDPOINT_XFER_ISOC:
806 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
808 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
810 /* always enable Interrupt on Missed ISOC */
811 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
814 case USB_ENDPOINT_XFER_BULK:
815 case USB_ENDPOINT_XFER_INT:
816 trb->ctrl = DWC3_TRBCTL_NORMAL;
820 * This is only possible with faulty memory because we
821 * checked it already :)
826 /* always enable Continue on Short Packet */
827 trb->ctrl |= DWC3_TRB_CTRL_CSP;
829 if (!req->request.no_interrupt && !chain)
830 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
833 trb->ctrl |= DWC3_TRB_CTRL_LST;
836 trb->ctrl |= DWC3_TRB_CTRL_CHN;
838 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
839 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
841 trb->ctrl |= DWC3_TRB_CTRL_HWO;
843 trace_dwc3_prepare_trb(dep, trb);
846 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
848 struct dwc3_trb *tmp;
851 * If enqueue & dequeue are equal than it is either full or empty.
853 * One way to know for sure is if the TRB right before us has HWO bit
854 * set or not. If it has, then we're definitely full and can't fit any
855 * more transfers in our ring.
857 if (dep->trb_enqueue == dep->trb_dequeue) {
858 /* If we're full, enqueue/dequeue are > 0 */
859 if (dep->trb_enqueue) {
860 tmp = &dep->trb_pool[dep->trb_enqueue - 1];
861 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
865 return DWC3_TRB_NUM - 1;
868 return dep->trb_dequeue - dep->trb_enqueue;
871 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
872 struct dwc3_request *req, unsigned int trbs_left)
874 struct usb_request *request = &req->request;
875 struct scatterlist *sg = request->sg;
876 struct scatterlist *s;
877 unsigned int last = false;
882 for_each_sg(sg, s, request->num_mapped_sgs, i) {
883 unsigned chain = true;
885 length = sg_dma_len(s);
886 dma = sg_dma_address(s);
889 if (list_is_last(&req->list, &dep->pending_list))
901 dwc3_prepare_one_trb(dep, req, dma, length,
909 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
910 struct dwc3_request *req, unsigned int trbs_left)
912 unsigned int last = false;
916 dma = req->request.dma;
917 length = req->request.length;
922 /* Is this the last request? */
923 if (list_is_last(&req->list, &dep->pending_list))
926 dwc3_prepare_one_trb(dep, req, dma, length,
931 * dwc3_prepare_trbs - setup TRBs from requests
932 * @dep: endpoint for which requests are being prepared
934 * The function goes through the requests list and sets up TRBs for the
935 * transfers. The function returns once there are no more TRBs available or
936 * it runs out of requests.
938 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
940 struct dwc3_request *req, *n;
943 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
945 trbs_left = dwc3_calc_trbs_left(dep);
947 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
948 if (req->request.num_mapped_sgs > 0)
949 dwc3_prepare_one_trb_sg(dep, req, trbs_left--);
951 dwc3_prepare_one_trb_linear(dep, req, trbs_left--);
958 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
960 struct dwc3_gadget_ep_cmd_params params;
961 struct dwc3_request *req;
962 struct dwc3 *dwc = dep->dwc;
967 starting = !(dep->flags & DWC3_EP_BUSY);
969 dwc3_prepare_trbs(dep);
970 req = next_request(&dep->started_list);
972 dep->flags |= DWC3_EP_PENDING_REQUEST;
976 memset(¶ms, 0, sizeof(params));
979 params.param0 = upper_32_bits(req->trb_dma);
980 params.param1 = lower_32_bits(req->trb_dma);
981 cmd = DWC3_DEPCMD_STARTTRANSFER;
983 cmd = DWC3_DEPCMD_UPDATETRANSFER;
986 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
987 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
990 * FIXME we need to iterate over the list of requests
991 * here and stop, unmap, free and del each of the linked
992 * requests instead of what we do now.
994 usb_gadget_unmap_request(&dwc->gadget, &req->request,
996 list_del(&req->list);
1000 dep->flags |= DWC3_EP_BUSY;
1003 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1004 WARN_ON_ONCE(!dep->resource_index);
1010 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1011 struct dwc3_ep *dep, u32 cur_uf)
1015 if (list_empty(&dep->pending_list)) {
1016 dwc3_trace(trace_dwc3_gadget,
1017 "ISOC ep %s run out for requests",
1019 dep->flags |= DWC3_EP_PENDING_REQUEST;
1023 /* 4 micro frames in the future */
1024 uf = cur_uf + dep->interval * 4;
1026 __dwc3_gadget_kick_transfer(dep, uf);
1029 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1030 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1034 mask = ~(dep->interval - 1);
1035 cur_uf = event->parameters & mask;
1037 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1040 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1042 struct dwc3 *dwc = dep->dwc;
1045 if (!dep->endpoint.desc) {
1046 dwc3_trace(trace_dwc3_gadget,
1047 "trying to queue request %p to disabled %s\n",
1048 &req->request, dep->endpoint.name);
1052 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1053 &req->request, req->dep->name)) {
1054 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1055 &req->request, req->dep->name);
1059 pm_runtime_get(dwc->dev);
1061 req->request.actual = 0;
1062 req->request.status = -EINPROGRESS;
1063 req->direction = dep->direction;
1064 req->epnum = dep->number;
1066 trace_dwc3_ep_queue(req);
1069 * Per databook, the total size of buffer must be a multiple
1070 * of MaxPacketSize for OUT endpoints. And MaxPacketSize is
1071 * configed for endpoints in dwc3_gadget_set_ep_config(),
1072 * set to usb_endpoint_descriptor->wMaxPacketSize.
1074 if (dep->direction == 0 &&
1075 req->request.length % dep->endpoint.desc->wMaxPacketSize)
1076 req->request.length = roundup(req->request.length,
1077 dep->endpoint.desc->wMaxPacketSize);
1080 * We only add to our list of requests now and
1081 * start consuming the list once we get XferNotReady
1084 * That way, we avoid doing anything that we don't need
1085 * to do now and defer it until the point we receive a
1086 * particular token from the Host side.
1088 * This will also avoid Host cancelling URBs due to too
1091 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1096 list_add_tail(&req->list, &dep->pending_list);
1099 * If there are no pending requests and the endpoint isn't already
1100 * busy, we will just start the request straight away.
1102 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1103 * little bit faster.
1105 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1106 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1107 !(dep->flags & DWC3_EP_BUSY)) {
1108 ret = __dwc3_gadget_kick_transfer(dep, 0);
1113 * There are a few special cases:
1115 * 1. XferNotReady with empty list of requests. We need to kick the
1116 * transfer here in that situation, otherwise we will be NAKing
1117 * forever. If we get XferNotReady before gadget driver has a
1118 * chance to queue a request, we will ACK the IRQ but won't be
1119 * able to receive the data until the next request is queued.
1120 * The following code is handling exactly that.
1123 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1125 * If xfernotready is already elapsed and it is a case
1126 * of isoc transfer, then issue END TRANSFER, so that
1127 * you can receive xfernotready again and can have
1128 * notion of current microframe.
1130 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1131 if (list_empty(&dep->started_list)) {
1132 dwc3_stop_active_transfer(dwc, dep->number, true);
1133 dep->flags = DWC3_EP_ENABLED;
1138 ret = __dwc3_gadget_kick_transfer(dep, 0);
1140 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1146 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1147 * kick the transfer here after queuing a request, otherwise the
1148 * core may not see the modified TRB(s).
1150 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1151 (dep->flags & DWC3_EP_BUSY) &&
1152 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1153 WARN_ON_ONCE(!dep->resource_index);
1154 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index);
1159 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1160 * right away, otherwise host will not know we have streams to be
1163 if (dep->stream_capable)
1164 ret = __dwc3_gadget_kick_transfer(dep, 0);
1167 if (ret && ret != -EBUSY)
1168 dwc3_trace(trace_dwc3_gadget,
1169 "%s: failed to kick transfers\n",
1177 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1178 struct usb_request *request)
1180 dwc3_gadget_ep_free_request(ep, request);
1183 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1185 struct dwc3_request *req;
1186 struct usb_request *request;
1187 struct usb_ep *ep = &dep->endpoint;
1189 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1190 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1194 request->length = 0;
1195 request->buf = dwc->zlp_buf;
1196 request->complete = __dwc3_gadget_ep_zlp_complete;
1198 req = to_dwc3_request(request);
1200 return __dwc3_gadget_ep_queue(dep, req);
1203 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1206 struct dwc3_request *req = to_dwc3_request(request);
1207 struct dwc3_ep *dep = to_dwc3_ep(ep);
1208 struct dwc3 *dwc = dep->dwc;
1210 unsigned long flags;
1214 spin_lock_irqsave(&dwc->lock, flags);
1215 ret = __dwc3_gadget_ep_queue(dep, req);
1218 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1219 * setting request->zero, instead of doing magic, we will just queue an
1220 * extra usb_request ourselves so that it gets handled the same way as
1221 * any other request.
1223 if (ret == 0 && request->zero && request->length &&
1224 (request->length % ep->desc->wMaxPacketSize == 0))
1225 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1227 spin_unlock_irqrestore(&dwc->lock, flags);
1232 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1233 struct usb_request *request)
1235 struct dwc3_request *req = to_dwc3_request(request);
1236 struct dwc3_request *r = NULL;
1238 struct dwc3_ep *dep = to_dwc3_ep(ep);
1239 struct dwc3 *dwc = dep->dwc;
1241 unsigned long flags;
1244 trace_dwc3_ep_dequeue(req);
1246 spin_lock_irqsave(&dwc->lock, flags);
1248 list_for_each_entry(r, &dep->pending_list, list) {
1254 list_for_each_entry(r, &dep->started_list, list) {
1259 /* wait until it is processed */
1260 dwc3_stop_active_transfer(dwc, dep->number, true);
1263 dev_err(dwc->dev, "request %p was not queued to %s\n",
1270 /* giveback the request */
1271 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1274 spin_unlock_irqrestore(&dwc->lock, flags);
1279 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1281 struct dwc3_gadget_ep_cmd_params params;
1282 struct dwc3 *dwc = dep->dwc;
1285 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1286 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1290 memset(¶ms, 0x00, sizeof(params));
1293 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1294 (!list_empty(&dep->started_list) ||
1295 !list_empty(&dep->pending_list)))) {
1296 dwc3_trace(trace_dwc3_gadget,
1297 "%s: pending request, cannot halt",
1302 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1305 dev_err(dwc->dev, "failed to set STALL on %s\n",
1308 dep->flags |= DWC3_EP_STALL;
1311 ret = dwc3_send_clear_stall_ep_cmd(dep);
1313 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1316 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1322 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1324 struct dwc3_ep *dep = to_dwc3_ep(ep);
1325 struct dwc3 *dwc = dep->dwc;
1327 unsigned long flags;
1331 spin_lock_irqsave(&dwc->lock, flags);
1332 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1333 spin_unlock_irqrestore(&dwc->lock, flags);
1338 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1340 struct dwc3_ep *dep = to_dwc3_ep(ep);
1341 struct dwc3 *dwc = dep->dwc;
1342 unsigned long flags;
1345 spin_lock_irqsave(&dwc->lock, flags);
1346 dep->flags |= DWC3_EP_WEDGE;
1348 if (dep->number == 0 || dep->number == 1)
1349 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1351 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1352 spin_unlock_irqrestore(&dwc->lock, flags);
1357 /* -------------------------------------------------------------------------- */
1359 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1360 .bLength = USB_DT_ENDPOINT_SIZE,
1361 .bDescriptorType = USB_DT_ENDPOINT,
1362 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1365 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1366 .enable = dwc3_gadget_ep0_enable,
1367 .disable = dwc3_gadget_ep0_disable,
1368 .alloc_request = dwc3_gadget_ep_alloc_request,
1369 .free_request = dwc3_gadget_ep_free_request,
1370 .queue = dwc3_gadget_ep0_queue,
1371 .dequeue = dwc3_gadget_ep_dequeue,
1372 .set_halt = dwc3_gadget_ep0_set_halt,
1373 .set_wedge = dwc3_gadget_ep_set_wedge,
1376 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1377 .enable = dwc3_gadget_ep_enable,
1378 .disable = dwc3_gadget_ep_disable,
1379 .alloc_request = dwc3_gadget_ep_alloc_request,
1380 .free_request = dwc3_gadget_ep_free_request,
1381 .queue = dwc3_gadget_ep_queue,
1382 .dequeue = dwc3_gadget_ep_dequeue,
1383 .set_halt = dwc3_gadget_ep_set_halt,
1384 .set_wedge = dwc3_gadget_ep_set_wedge,
1387 /* -------------------------------------------------------------------------- */
1389 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1391 struct dwc3 *dwc = gadget_to_dwc(g);
1394 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1395 return DWC3_DSTS_SOFFN(reg);
1398 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1400 unsigned long timeout;
1409 * According to the Databook Remote wakeup request should
1410 * be issued only when the device is in early suspend state.
1412 * We can check that via USB Link State bits in DSTS register.
1414 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1416 speed = reg & DWC3_DSTS_CONNECTSPD;
1417 if (speed == DWC3_DSTS_SUPERSPEED) {
1418 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1422 link_state = DWC3_DSTS_USBLNKST(reg);
1424 switch (link_state) {
1425 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1426 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1429 dwc3_trace(trace_dwc3_gadget,
1430 "can't wakeup from '%s'\n",
1431 dwc3_gadget_link_string(link_state));
1435 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1437 dev_err(dwc->dev, "failed to put link in Recovery\n");
1441 /* Recent versions do this automatically */
1442 if (dwc->revision < DWC3_REVISION_194A) {
1443 /* write zeroes to Link Change Request */
1444 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1445 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1446 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1449 /* poll until Link State changes to ON */
1450 timeout = jiffies + msecs_to_jiffies(100);
1452 while (!time_after(jiffies, timeout)) {
1453 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1455 /* in HS, means ON */
1456 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1460 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1461 dev_err(dwc->dev, "failed to send remote wakeup\n");
1468 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1470 struct dwc3 *dwc = gadget_to_dwc(g);
1471 unsigned long flags;
1474 spin_lock_irqsave(&dwc->lock, flags);
1475 ret = __dwc3_gadget_wakeup(dwc);
1476 spin_unlock_irqrestore(&dwc->lock, flags);
1481 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1484 struct dwc3 *dwc = gadget_to_dwc(g);
1485 unsigned long flags;
1487 spin_lock_irqsave(&dwc->lock, flags);
1488 g->is_selfpowered = !!is_selfpowered;
1489 spin_unlock_irqrestore(&dwc->lock, flags);
1494 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1499 if (pm_runtime_suspended(dwc->dev))
1502 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1504 if (dwc->revision <= DWC3_REVISION_187A) {
1505 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1506 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1509 if (dwc->revision >= DWC3_REVISION_194A)
1510 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1511 reg |= DWC3_DCTL_RUN_STOP;
1513 if (dwc->has_hibernation)
1514 reg |= DWC3_DCTL_KEEP_CONNECT;
1516 dwc->pullups_connected = true;
1518 reg &= ~DWC3_DCTL_RUN_STOP;
1520 if (dwc->has_hibernation && !suspend)
1521 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1523 dwc->pullups_connected = false;
1526 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1529 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1531 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1534 if (reg & DWC3_DSTS_DEVCTRLHLT)
1543 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1545 ? dwc->gadget_driver->function : "no-function",
1546 is_on ? "connect" : "disconnect");
1551 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1553 struct dwc3 *dwc = gadget_to_dwc(g);
1554 unsigned long flags;
1559 spin_lock_irqsave(&dwc->lock, flags);
1560 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1561 spin_unlock_irqrestore(&dwc->lock, flags);
1566 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1570 /* Enable all but Start and End of Frame IRQs */
1571 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1572 DWC3_DEVTEN_EVNTOVERFLOWEN |
1573 DWC3_DEVTEN_CMDCMPLTEN |
1574 DWC3_DEVTEN_ERRTICERREN |
1575 DWC3_DEVTEN_WKUPEVTEN |
1576 DWC3_DEVTEN_ULSTCNGEN |
1577 DWC3_DEVTEN_CONNECTDONEEN |
1578 DWC3_DEVTEN_USBRSTEN |
1579 DWC3_DEVTEN_DISCONNEVTEN);
1581 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1584 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1586 /* mask all interrupts */
1587 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1590 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1591 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1594 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1595 * dwc: pointer to our context structure
1597 * The following looks like complex but it's actually very simple. In order to
1598 * calculate the number of packets we can burst at once on OUT transfers, we're
1599 * gonna use RxFIFO size.
1601 * To calculate RxFIFO size we need two numbers:
1602 * MDWIDTH = size, in bits, of the internal memory bus
1603 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1605 * Given these two numbers, the formula is simple:
1607 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1609 * 24 bytes is for 3x SETUP packets
1610 * 16 bytes is a clock domain crossing tolerance
1612 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1614 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1621 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1622 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1624 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1625 nump = min_t(u32, nump, 16);
1628 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1629 reg &= ~DWC3_DCFG_NUMP_MASK;
1630 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1631 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1634 static int __dwc3_gadget_start(struct dwc3 *dwc)
1636 struct dwc3_ep *dep;
1640 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1641 reg &= ~(DWC3_DCFG_SPEED_MASK);
1644 * WORKAROUND: DWC3 revision < 2.20a have an issue
1645 * which would cause metastability state on Run/Stop
1646 * bit if we try to force the IP to USB2-only mode.
1648 * Because of that, we cannot configure the IP to any
1649 * speed other than the SuperSpeed
1653 * STAR#9000525659: Clock Domain Crossing on DCTL in
1656 if (dwc->revision < DWC3_REVISION_220A) {
1657 reg |= DWC3_DCFG_SUPERSPEED;
1659 switch (dwc->maximum_speed) {
1661 reg |= DWC3_DSTS_LOWSPEED;
1663 case USB_SPEED_FULL:
1664 reg |= DWC3_DSTS_FULLSPEED1;
1666 case USB_SPEED_HIGH:
1667 reg |= DWC3_DSTS_HIGHSPEED;
1669 case USB_SPEED_SUPER: /* FALLTHROUGH */
1670 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1672 reg |= DWC3_DSTS_SUPERSPEED;
1675 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1678 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1679 * field instead of letting dwc3 itself calculate that automatically.
1681 * This way, we maximize the chances that we'll be able to get several
1682 * bursts of data without going through any sort of endpoint throttling.
1684 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1685 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1686 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1688 dwc3_gadget_setup_nump(dwc);
1690 /* Start with SuperSpeed Default */
1691 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1694 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1697 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1702 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1705 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1709 /* begin to receive SETUP packets */
1710 dwc->ep0state = EP0_SETUP_PHASE;
1711 dwc3_ep0_out_start(dwc);
1713 dwc3_gadget_enable_irq(dwc);
1718 __dwc3_gadget_ep_disable(dwc->eps[0]);
1724 static int dwc3_gadget_start(struct usb_gadget *g,
1725 struct usb_gadget_driver *driver)
1727 struct dwc3 *dwc = gadget_to_dwc(g);
1728 unsigned long flags;
1732 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1733 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1734 IRQF_SHARED, "dwc3", dwc->ev_buf);
1736 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1740 dwc->irq_gadget = irq;
1742 spin_lock_irqsave(&dwc->lock, flags);
1743 if (dwc->gadget_driver) {
1744 dev_err(dwc->dev, "%s is already bound to %s\n",
1746 dwc->gadget_driver->driver.name);
1751 dwc->gadget_driver = driver;
1753 if (pm_runtime_active(dwc->dev))
1754 __dwc3_gadget_start(dwc);
1756 spin_unlock_irqrestore(&dwc->lock, flags);
1761 spin_unlock_irqrestore(&dwc->lock, flags);
1768 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1770 dwc3_gadget_disable_irq(dwc);
1771 __dwc3_gadget_ep_disable(dwc->eps[0]);
1772 __dwc3_gadget_ep_disable(dwc->eps[1]);
1775 static int dwc3_gadget_stop(struct usb_gadget *g)
1777 struct dwc3 *dwc = gadget_to_dwc(g);
1778 unsigned long flags;
1780 spin_lock_irqsave(&dwc->lock, flags);
1781 __dwc3_gadget_stop(dwc);
1782 dwc->gadget_driver = NULL;
1783 spin_unlock_irqrestore(&dwc->lock, flags);
1785 free_irq(dwc->irq_gadget, dwc->ev_buf);
1790 static const struct usb_gadget_ops dwc3_gadget_ops = {
1791 .get_frame = dwc3_gadget_get_frame,
1792 .wakeup = dwc3_gadget_wakeup,
1793 .set_selfpowered = dwc3_gadget_set_selfpowered,
1794 .pullup = dwc3_gadget_pullup,
1795 .udc_start = dwc3_gadget_start,
1796 .udc_stop = dwc3_gadget_stop,
1799 /* -------------------------------------------------------------------------- */
1801 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1802 u8 num, u32 direction)
1804 struct dwc3_ep *dep;
1807 for (i = 0; i < num; i++) {
1808 u8 epnum = (i << 1) | (!!direction);
1810 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1815 dep->number = epnum;
1816 dep->direction = !!direction;
1817 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1818 dwc->eps[epnum] = dep;
1820 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1821 (epnum & 1) ? "in" : "out");
1823 dep->endpoint.name = dep->name;
1824 spin_lock_init(&dep->lock);
1826 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1828 if (epnum == 0 || epnum == 1) {
1829 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1830 dep->endpoint.maxburst = 1;
1831 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1833 dwc->gadget.ep0 = &dep->endpoint;
1837 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1838 dep->endpoint.max_streams = 15;
1839 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1840 list_add_tail(&dep->endpoint.ep_list,
1841 &dwc->gadget.ep_list);
1843 ret = dwc3_alloc_trb_pool(dep);
1848 if (epnum == 0 || epnum == 1) {
1849 dep->endpoint.caps.type_control = true;
1851 dep->endpoint.caps.type_iso = true;
1852 dep->endpoint.caps.type_bulk = true;
1853 dep->endpoint.caps.type_int = true;
1856 dep->endpoint.caps.dir_in = !!direction;
1857 dep->endpoint.caps.dir_out = !direction;
1859 INIT_LIST_HEAD(&dep->pending_list);
1860 INIT_LIST_HEAD(&dep->started_list);
1866 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1870 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1872 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1874 dwc3_trace(trace_dwc3_gadget,
1875 "failed to allocate OUT endpoints");
1879 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1881 dwc3_trace(trace_dwc3_gadget,
1882 "failed to allocate IN endpoints");
1889 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1891 struct dwc3_ep *dep;
1894 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1895 dep = dwc->eps[epnum];
1899 * Physical endpoints 0 and 1 are special; they form the
1900 * bi-directional USB endpoint 0.
1902 * For those two physical endpoints, we don't allocate a TRB
1903 * pool nor do we add them the endpoints list. Due to that, we
1904 * shouldn't do these two operations otherwise we would end up
1905 * with all sorts of bugs when removing dwc3.ko.
1907 if (epnum != 0 && epnum != 1) {
1908 dwc3_free_trb_pool(dep);
1909 list_del(&dep->endpoint.ep_list);
1916 /* -------------------------------------------------------------------------- */
1918 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1919 struct dwc3_request *req, struct dwc3_trb *trb,
1920 const struct dwc3_event_depevt *event, int status)
1923 unsigned int s_pkt = 0;
1924 unsigned int trb_status;
1926 trace_dwc3_complete_trb(dep, trb);
1928 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1930 * We continue despite the error. There is not much we
1931 * can do. If we don't clean it up we loop forever. If
1932 * we skip the TRB then it gets overwritten after a
1933 * while since we use them in a ring buffer. A BUG()
1934 * would help. Lets hope that if this occurs, someone
1935 * fixes the root cause instead of looking away :)
1937 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1939 count = trb->size & DWC3_TRB_SIZE_MASK;
1941 if (dep->direction) {
1943 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1944 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1945 dwc3_trace(trace_dwc3_gadget,
1946 "%s: incomplete IN transfer\n",
1949 * If missed isoc occurred and there is
1950 * no request queued then issue END
1951 * TRANSFER, so that core generates
1952 * next xfernotready and we will issue
1953 * a fresh START TRANSFER.
1954 * If there are still queued request
1955 * then wait, do not issue either END
1956 * or UPDATE TRANSFER, just attach next
1957 * request in pending_list during
1958 * giveback.If any future queued request
1959 * is successfully transferred then we
1960 * will issue UPDATE TRANSFER for all
1961 * request in the pending_list.
1963 dep->flags |= DWC3_EP_MISSED_ISOC;
1965 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1967 status = -ECONNRESET;
1970 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1973 if (count && (event->status & DEPEVT_STATUS_SHORT))
1978 * We assume here we will always receive the entire data block
1979 * which we should receive. Meaning, if we program RX to
1980 * receive 4K but we receive only 2K, we assume that's all we
1981 * should receive and we simply bounce the request back to the
1982 * gadget driver for further processing.
1984 req->request.actual += req->request.length - count;
1987 if ((event->status & DEPEVT_STATUS_LST) &&
1988 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1989 DWC3_TRB_CTRL_HWO)))
1991 if ((event->status & DEPEVT_STATUS_IOC) &&
1992 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1997 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1998 const struct dwc3_event_depevt *event, int status)
2000 struct dwc3_request *req;
2001 struct dwc3_trb *trb;
2007 req = next_request(&dep->started_list);
2008 if (WARN_ON_ONCE(!req))
2013 slot = req->first_trb_index + i;
2014 if (slot == DWC3_TRB_NUM - 1)
2016 slot %= DWC3_TRB_NUM;
2017 trb = &dep->trb_pool[slot];
2019 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2023 } while (++i < req->request.num_mapped_sgs);
2025 dwc3_gadget_giveback(dep, req, status);
2032 * Our endpoint might get disabled by another thread during
2033 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2034 * early on so DWC3_EP_BUSY flag gets cleared
2036 if (!dep->endpoint.desc)
2039 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2040 list_empty(&dep->started_list)) {
2041 if (list_empty(&dep->pending_list)) {
2043 * If there is no entry in request list then do
2044 * not issue END TRANSFER now. Just set PENDING
2045 * flag, so that END TRANSFER is issued when an
2046 * entry is added into request list.
2048 dep->flags = DWC3_EP_PENDING_REQUEST;
2050 dwc3_stop_active_transfer(dwc, dep->number, true);
2051 dep->flags = DWC3_EP_ENABLED;
2056 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
2057 if ((event->status & DEPEVT_STATUS_IOC) &&
2058 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2063 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2064 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2066 unsigned status = 0;
2068 u32 is_xfer_complete;
2070 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2072 if (event->status & DEPEVT_STATUS_BUSERR)
2073 status = -ECONNRESET;
2075 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2076 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2077 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2078 dep->flags &= ~DWC3_EP_BUSY;
2081 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2082 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2084 if (dwc->revision < DWC3_REVISION_183A) {
2088 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2091 if (!(dep->flags & DWC3_EP_ENABLED))
2094 if (!list_empty(&dep->started_list))
2098 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2100 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2106 * Our endpoint might get disabled by another thread during
2107 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2108 * early on so DWC3_EP_BUSY flag gets cleared
2110 if (!dep->endpoint.desc)
2113 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2116 ret = __dwc3_gadget_kick_transfer(dep, 0);
2117 if (!ret || ret == -EBUSY)
2122 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2123 const struct dwc3_event_depevt *event)
2125 struct dwc3_ep *dep;
2126 u8 epnum = event->endpoint_number;
2128 dep = dwc->eps[epnum];
2130 if (!(dep->flags & DWC3_EP_ENABLED))
2133 if (epnum == 0 || epnum == 1) {
2134 dwc3_ep0_interrupt(dwc, event);
2138 switch (event->endpoint_event) {
2139 case DWC3_DEPEVT_XFERCOMPLETE:
2140 dep->resource_index = 0;
2142 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2143 dwc3_trace(trace_dwc3_gadget,
2144 "%s is an Isochronous endpoint\n",
2149 dwc3_endpoint_transfer_complete(dwc, dep, event);
2151 case DWC3_DEPEVT_XFERINPROGRESS:
2152 dwc3_endpoint_transfer_complete(dwc, dep, event);
2154 case DWC3_DEPEVT_XFERNOTREADY:
2155 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2156 dwc3_gadget_start_isoc(dwc, dep, event);
2161 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2163 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2164 dep->name, active ? "Transfer Active"
2165 : "Transfer Not Active");
2167 ret = __dwc3_gadget_kick_transfer(dep, 0);
2168 if (!ret || ret == -EBUSY)
2171 dwc3_trace(trace_dwc3_gadget,
2172 "%s: failed to kick transfers\n",
2177 case DWC3_DEPEVT_STREAMEVT:
2178 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2179 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2184 switch (event->status) {
2185 case DEPEVT_STREAMEVT_FOUND:
2186 dwc3_trace(trace_dwc3_gadget,
2187 "Stream %d found and started",
2191 case DEPEVT_STREAMEVT_NOTFOUND:
2194 dwc3_trace(trace_dwc3_gadget,
2195 "unable to find suitable stream\n");
2198 case DWC3_DEPEVT_RXTXFIFOEVT:
2199 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2201 case DWC3_DEPEVT_EPCMDCMPLT:
2202 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2207 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2209 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2210 spin_unlock(&dwc->lock);
2211 dwc->gadget_driver->disconnect(&dwc->gadget);
2212 spin_lock(&dwc->lock);
2216 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2218 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2219 spin_unlock(&dwc->lock);
2220 dwc->gadget_driver->suspend(&dwc->gadget);
2221 spin_lock(&dwc->lock);
2225 static void dwc3_resume_gadget(struct dwc3 *dwc)
2227 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2228 spin_unlock(&dwc->lock);
2229 dwc->gadget_driver->resume(&dwc->gadget);
2230 spin_lock(&dwc->lock);
2234 static void dwc3_reset_gadget(struct dwc3 *dwc)
2236 if (!dwc->gadget_driver)
2239 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2240 spin_unlock(&dwc->lock);
2241 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2242 spin_lock(&dwc->lock);
2246 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2248 struct dwc3_ep *dep;
2249 struct dwc3_gadget_ep_cmd_params params;
2253 dep = dwc->eps[epnum];
2255 if (!dep->resource_index)
2259 * NOTICE: We are violating what the Databook says about the
2260 * EndTransfer command. Ideally we would _always_ wait for the
2261 * EndTransfer Command Completion IRQ, but that's causing too
2262 * much trouble synchronizing between us and gadget driver.
2264 * We have discussed this with the IP Provider and it was
2265 * suggested to giveback all requests here, but give HW some
2266 * extra time to synchronize with the interconnect. We're using
2267 * an arbitrary 100us delay for that.
2269 * Note also that a similar handling was tested by Synopsys
2270 * (thanks a lot Paul) and nothing bad has come out of it.
2271 * In short, what we're doing is:
2273 * - Issue EndTransfer WITH CMDIOC bit set
2277 cmd = DWC3_DEPCMD_ENDTRANSFER;
2278 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2279 cmd |= DWC3_DEPCMD_CMDIOC;
2280 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2281 memset(¶ms, 0, sizeof(params));
2282 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2284 dep->resource_index = 0;
2285 dep->flags &= ~DWC3_EP_BUSY;
2289 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2293 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2294 struct dwc3_ep *dep;
2296 dep = dwc->eps[epnum];
2300 if (!(dep->flags & DWC3_EP_ENABLED))
2303 dwc3_remove_requests(dwc, dep);
2307 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2311 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2312 struct dwc3_ep *dep;
2315 dep = dwc->eps[epnum];
2319 if (!(dep->flags & DWC3_EP_STALL))
2322 dep->flags &= ~DWC3_EP_STALL;
2324 ret = dwc3_send_clear_stall_ep_cmd(dep);
2329 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2333 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2334 reg &= ~DWC3_DCTL_INITU1ENA;
2335 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2337 reg &= ~DWC3_DCTL_INITU2ENA;
2338 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2340 dwc3_disconnect_gadget(dwc);
2342 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2343 dwc->setup_packet_pending = false;
2344 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2346 dwc->connected = false;
2349 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2353 dwc->connected = true;
2356 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2357 * would cause a missing Disconnect Event if there's a
2358 * pending Setup Packet in the FIFO.
2360 * There's no suggested workaround on the official Bug
2361 * report, which states that "unless the driver/application
2362 * is doing any special handling of a disconnect event,
2363 * there is no functional issue".
2365 * Unfortunately, it turns out that we _do_ some special
2366 * handling of a disconnect event, namely complete all
2367 * pending transfers, notify gadget driver of the
2368 * disconnection, and so on.
2370 * Our suggested workaround is to follow the Disconnect
2371 * Event steps here, instead, based on a setup_packet_pending
2372 * flag. Such flag gets set whenever we have a SETUP_PENDING
2373 * status for EP0 TRBs and gets cleared on XferComplete for the
2378 * STAR#9000466709: RTL: Device : Disconnect event not
2379 * generated if setup packet pending in FIFO
2381 if (dwc->revision < DWC3_REVISION_188A) {
2382 if (dwc->setup_packet_pending)
2383 dwc3_gadget_disconnect_interrupt(dwc);
2386 dwc3_reset_gadget(dwc);
2388 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2389 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2390 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2391 dwc->test_mode = false;
2393 dwc3_stop_active_transfers(dwc);
2394 dwc3_clear_stall_all_ep(dwc);
2396 /* Reset device address to zero */
2397 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2398 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2399 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2402 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2405 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2408 * We change the clock only at SS but I dunno why I would want to do
2409 * this. Maybe it becomes part of the power saving plan.
2412 if (speed != DWC3_DSTS_SUPERSPEED)
2416 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2417 * each time on Connect Done.
2422 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2423 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2424 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2427 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2429 struct dwc3_ep *dep;
2434 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2435 speed = reg & DWC3_DSTS_CONNECTSPD;
2438 dwc3_update_ram_clk_sel(dwc, speed);
2441 case DWC3_DCFG_SUPERSPEED:
2443 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2444 * would cause a missing USB3 Reset event.
2446 * In such situations, we should force a USB3 Reset
2447 * event by calling our dwc3_gadget_reset_interrupt()
2452 * STAR#9000483510: RTL: SS : USB3 reset event may
2453 * not be generated always when the link enters poll
2455 if (dwc->revision < DWC3_REVISION_190A)
2456 dwc3_gadget_reset_interrupt(dwc);
2458 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2459 dwc->gadget.ep0->maxpacket = 512;
2460 dwc->gadget.speed = USB_SPEED_SUPER;
2462 case DWC3_DCFG_HIGHSPEED:
2463 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2464 dwc->gadget.ep0->maxpacket = 64;
2465 dwc->gadget.speed = USB_SPEED_HIGH;
2467 case DWC3_DCFG_FULLSPEED2:
2468 case DWC3_DCFG_FULLSPEED1:
2469 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2470 dwc->gadget.ep0->maxpacket = 64;
2471 dwc->gadget.speed = USB_SPEED_FULL;
2473 case DWC3_DCFG_LOWSPEED:
2474 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2475 dwc->gadget.ep0->maxpacket = 8;
2476 dwc->gadget.speed = USB_SPEED_LOW;
2480 /* Enable USB2 LPM Capability */
2482 if ((dwc->revision > DWC3_REVISION_194A)
2483 && (speed != DWC3_DCFG_SUPERSPEED)) {
2484 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2485 reg |= DWC3_DCFG_LPM_CAP;
2486 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2488 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2489 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2491 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2494 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2495 * DCFG.LPMCap is set, core responses with an ACK and the
2496 * BESL value in the LPM token is less than or equal to LPM
2499 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2500 && dwc->has_lpm_erratum,
2501 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2503 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2504 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2506 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2508 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2509 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2510 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2514 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2517 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2522 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2525 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2530 * Configure PHY via GUSB3PIPECTLn if required.
2532 * Update GTXFIFOSIZn
2534 * In both cases reset values should be sufficient.
2538 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2541 * TODO take core out of low power mode when that's
2545 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2546 spin_unlock(&dwc->lock);
2547 dwc->gadget_driver->resume(&dwc->gadget);
2548 spin_lock(&dwc->lock);
2552 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2553 unsigned int evtinfo)
2555 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2556 unsigned int pwropt;
2559 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2560 * Hibernation mode enabled which would show up when device detects
2561 * host-initiated U3 exit.
2563 * In that case, device will generate a Link State Change Interrupt
2564 * from U3 to RESUME which is only necessary if Hibernation is
2567 * There are no functional changes due to such spurious event and we
2568 * just need to ignore it.
2572 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2575 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2576 if ((dwc->revision < DWC3_REVISION_250A) &&
2577 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2578 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2579 (next == DWC3_LINK_STATE_RESUME)) {
2580 dwc3_trace(trace_dwc3_gadget,
2581 "ignoring transition U3 -> Resume");
2587 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2588 * on the link partner, the USB session might do multiple entry/exit
2589 * of low power states before a transfer takes place.
2591 * Due to this problem, we might experience lower throughput. The
2592 * suggested workaround is to disable DCTL[12:9] bits if we're
2593 * transitioning from U1/U2 to U0 and enable those bits again
2594 * after a transfer completes and there are no pending transfers
2595 * on any of the enabled endpoints.
2597 * This is the first half of that workaround.
2601 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2602 * core send LGO_Ux entering U0
2604 if (dwc->revision < DWC3_REVISION_183A) {
2605 if (next == DWC3_LINK_STATE_U0) {
2609 switch (dwc->link_state) {
2610 case DWC3_LINK_STATE_U1:
2611 case DWC3_LINK_STATE_U2:
2612 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2613 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2614 | DWC3_DCTL_ACCEPTU2ENA
2615 | DWC3_DCTL_INITU1ENA
2616 | DWC3_DCTL_ACCEPTU1ENA);
2619 dwc->u1u2 = reg & u1u2;
2623 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2633 case DWC3_LINK_STATE_U1:
2634 if (dwc->speed == USB_SPEED_SUPER)
2635 dwc3_suspend_gadget(dwc);
2637 case DWC3_LINK_STATE_U2:
2638 case DWC3_LINK_STATE_U3:
2639 dwc3_suspend_gadget(dwc);
2641 case DWC3_LINK_STATE_RESUME:
2642 dwc3_resume_gadget(dwc);
2649 dwc->link_state = next;
2652 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2653 unsigned int evtinfo)
2655 unsigned int is_ss = evtinfo & BIT(4);
2658 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2659 * have a known issue which can cause USB CV TD.9.23 to fail
2662 * Because of this issue, core could generate bogus hibernation
2663 * events which SW needs to ignore.
2667 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2668 * Device Fallback from SuperSpeed
2670 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2673 /* enter hibernation here */
2676 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2677 const struct dwc3_event_devt *event)
2679 switch (event->type) {
2680 case DWC3_DEVICE_EVENT_DISCONNECT:
2681 dwc3_gadget_disconnect_interrupt(dwc);
2683 case DWC3_DEVICE_EVENT_RESET:
2684 dwc3_gadget_reset_interrupt(dwc);
2686 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2687 dwc3_gadget_conndone_interrupt(dwc);
2689 case DWC3_DEVICE_EVENT_WAKEUP:
2690 dwc3_gadget_wakeup_interrupt(dwc);
2692 case DWC3_DEVICE_EVENT_HIBER_REQ:
2693 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2694 "unexpected hibernation event\n"))
2697 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2699 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2700 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2702 case DWC3_DEVICE_EVENT_EOPF:
2703 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2705 case DWC3_DEVICE_EVENT_SOF:
2706 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2708 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2709 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2711 case DWC3_DEVICE_EVENT_CMD_CMPL:
2712 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2714 case DWC3_DEVICE_EVENT_OVERFLOW:
2715 dwc3_trace(trace_dwc3_gadget, "Overflow");
2718 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2722 static void dwc3_process_event_entry(struct dwc3 *dwc,
2723 const union dwc3_event *event)
2725 trace_dwc3_event(event->raw);
2727 /* Endpoint IRQ, handle it and return early */
2728 if (event->type.is_devspec == 0) {
2730 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2733 switch (event->type.type) {
2734 case DWC3_EVENT_TYPE_DEV:
2735 dwc3_gadget_interrupt(dwc, &event->devt);
2737 /* REVISIT what to do with Carkit and I2C events ? */
2739 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2743 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2745 struct dwc3 *dwc = evt->dwc;
2746 irqreturn_t ret = IRQ_NONE;
2752 if (!(evt->flags & DWC3_EVENT_PENDING))
2756 union dwc3_event event;
2758 event.raw = *(u32 *) (evt->buf + evt->lpos);
2760 dwc3_process_event_entry(dwc, &event);
2763 * FIXME we wrap around correctly to the next entry as
2764 * almost all entries are 4 bytes in size. There is one
2765 * entry which has 12 bytes which is a regular entry
2766 * followed by 8 bytes data. ATM I don't know how
2767 * things are organized if we get next to the a
2768 * boundary so I worry about that once we try to handle
2771 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2774 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2778 evt->flags &= ~DWC3_EVENT_PENDING;
2781 /* Unmask interrupt */
2782 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2783 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2784 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2789 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2791 struct dwc3_event_buffer *evt = _evt;
2792 struct dwc3 *dwc = evt->dwc;
2793 unsigned long flags;
2794 irqreturn_t ret = IRQ_NONE;
2796 spin_lock_irqsave(&dwc->lock, flags);
2797 ret = dwc3_process_event_buf(evt);
2798 spin_unlock_irqrestore(&dwc->lock, flags);
2803 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2805 struct dwc3 *dwc = evt->dwc;
2809 if (pm_runtime_suspended(dwc->dev)) {
2810 pm_runtime_get(dwc->dev);
2811 disable_irq_nosync(dwc->irq_gadget);
2812 dwc->pending_events = true;
2816 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2817 count &= DWC3_GEVNTCOUNT_MASK;
2822 evt->flags |= DWC3_EVENT_PENDING;
2824 /* Mask interrupt */
2825 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2826 reg |= DWC3_GEVNTSIZ_INTMASK;
2827 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2829 return IRQ_WAKE_THREAD;
2832 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2834 struct dwc3_event_buffer *evt = _evt;
2836 return dwc3_check_event_buf(evt);
2840 * dwc3_gadget_init - Initializes gadget related registers
2841 * @dwc: pointer to our controller context structure
2843 * Returns 0 on success otherwise negative errno.
2845 int dwc3_gadget_init(struct dwc3 *dwc)
2849 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2850 &dwc->ctrl_req_addr, GFP_KERNEL);
2851 if (!dwc->ctrl_req) {
2852 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2857 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2858 &dwc->ep0_trb_addr, GFP_KERNEL);
2859 if (!dwc->ep0_trb) {
2860 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2865 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2866 if (!dwc->setup_buf) {
2871 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2872 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2874 if (!dwc->ep0_bounce) {
2875 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2880 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2881 if (!dwc->zlp_buf) {
2886 dwc->gadget.ops = &dwc3_gadget_ops;
2887 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2888 dwc->gadget.sg_supported = true;
2889 dwc->gadget.name = "dwc3-gadget";
2890 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2893 * FIXME We might be setting max_speed to <SUPER, however versions
2894 * <2.20a of dwc3 have an issue with metastability (documented
2895 * elsewhere in this driver) which tells us we can't set max speed to
2896 * anything lower than SUPER.
2898 * Because gadget.max_speed is only used by composite.c and function
2899 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2900 * to happen so we avoid sending SuperSpeed Capability descriptor
2901 * together with our BOS descriptor as that could confuse host into
2902 * thinking we can handle super speed.
2904 * Note that, in fact, we won't even support GetBOS requests when speed
2905 * is less than super speed because we don't have means, yet, to tell
2906 * composite.c that we are USB 2.0 + LPM ECN.
2908 if (dwc->revision < DWC3_REVISION_220A)
2909 dwc3_trace(trace_dwc3_gadget,
2910 "Changing max_speed on rev %08x\n",
2913 dwc->gadget.max_speed = dwc->maximum_speed;
2916 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2919 dwc->gadget.quirk_ep_out_aligned_size = true;
2922 * REVISIT: Here we should clear all pending IRQs to be
2923 * sure we're starting from a well known location.
2926 ret = dwc3_gadget_init_endpoints(dwc);
2930 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2932 dev_err(dwc->dev, "failed to register udc\n");
2939 kfree(dwc->zlp_buf);
2942 dwc3_gadget_free_endpoints(dwc);
2943 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2944 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2947 kfree(dwc->setup_buf);
2950 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2951 dwc->ep0_trb, dwc->ep0_trb_addr);
2954 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2955 dwc->ctrl_req, dwc->ctrl_req_addr);
2961 /* -------------------------------------------------------------------------- */
2963 void dwc3_gadget_exit(struct dwc3 *dwc)
2965 usb_del_gadget_udc(&dwc->gadget);
2967 dwc3_gadget_free_endpoints(dwc);
2969 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2970 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2972 kfree(dwc->setup_buf);
2973 kfree(dwc->zlp_buf);
2975 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2976 dwc->ep0_trb, dwc->ep0_trb_addr);
2978 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2979 dwc->ctrl_req, dwc->ctrl_req_addr);
2982 int dwc3_gadget_suspend(struct dwc3 *dwc)
2986 if (!dwc->gadget_driver)
2989 ret = dwc3_gadget_run_stop(dwc, false, false);
2993 dwc3_disconnect_gadget(dwc);
2994 __dwc3_gadget_stop(dwc);
2999 int dwc3_gadget_resume(struct dwc3 *dwc)
3003 if (!dwc->gadget_driver)
3006 ret = __dwc3_gadget_start(dwc);
3010 ret = dwc3_gadget_run_stop(dwc, true, false);
3017 __dwc3_gadget_stop(dwc);
3023 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3025 if (dwc->pending_events) {
3026 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3027 dwc->pending_events = false;
3028 enable_irq(dwc->irq_gadget);