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");
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);
182 if (req->request.status == -EINPROGRESS)
183 req->request.status = status;
185 if (dwc->ep0_bounced && dep->number == 0)
186 dwc->ep0_bounced = false;
188 usb_gadget_unmap_request(&dwc->gadget, &req->request,
191 trace_dwc3_gadget_giveback(req);
193 spin_unlock(&dwc->lock);
194 usb_gadget_giveback_request(&dep->endpoint, &req->request);
195 spin_lock(&dwc->lock);
198 pm_runtime_put(dwc->dev);
201 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
208 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
209 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
212 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
213 if (!(reg & DWC3_DGCMD_CMDACT)) {
214 status = DWC3_DGCMD_STATUS(reg);
226 trace_dwc3_gadget_generic_cmd(cmd, param, status);
231 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
233 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
234 struct dwc3_gadget_ep_cmd_params *params)
236 struct dwc3 *dwc = dep->dwc;
245 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
246 * we're issuing an endpoint command, we must check if
247 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
249 * We will also set SUSPHY bit to what it was before returning as stated
250 * by the same section on Synopsys databook.
252 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
253 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
254 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
256 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
257 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
261 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
264 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
265 dwc->link_state == DWC3_LINK_STATE_U2 ||
266 dwc->link_state == DWC3_LINK_STATE_U3);
268 if (unlikely(needs_wakeup)) {
269 ret = __dwc3_gadget_wakeup(dwc);
270 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
275 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
276 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
277 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
279 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
281 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
282 if (!(reg & DWC3_DEPCMD_CMDACT)) {
283 cmd_status = DWC3_DEPCMD_STATUS(reg);
285 switch (cmd_status) {
289 case DEPEVT_TRANSFER_NO_RESOURCE:
292 case DEPEVT_TRANSFER_BUS_EXPIRY:
294 * SW issues START TRANSFER command to
295 * isochronous ep with future frame interval. If
296 * future interval time has already passed when
297 * core receives the command, it will respond
298 * with an error status of 'Bus Expiry'.
300 * Instead of always returning -EINVAL, let's
301 * give a hint to the gadget driver that this is
302 * the case by returning -EAGAIN.
307 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
316 cmd_status = -ETIMEDOUT;
319 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
321 if (unlikely(susphy)) {
322 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
323 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
324 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
330 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
332 struct dwc3 *dwc = dep->dwc;
333 struct dwc3_gadget_ep_cmd_params params;
334 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
337 * As of core revision 2.60a the recommended programming model
338 * is to set the ClearPendIN bit when issuing a Clear Stall EP
339 * command for IN endpoints. This is to prevent an issue where
340 * some (non-compliant) hosts may not send ACK TPs for pending
341 * IN transfers due to a mishandled error condition. Synopsys
344 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A) &&
345 (dwc->gadget.speed >= USB_SPEED_SUPER))
346 cmd |= DWC3_DEPCMD_CLEARPENDIN;
348 memset(¶ms, 0, sizeof(params));
350 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
353 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
354 struct dwc3_trb *trb)
356 u32 offset = (char *) trb - (char *) dep->trb_pool;
358 return dep->trb_pool_dma + offset;
361 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
363 struct dwc3 *dwc = dep->dwc;
368 dep->trb_pool = dma_alloc_coherent(dwc->dev,
369 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
370 &dep->trb_pool_dma, GFP_KERNEL);
371 if (!dep->trb_pool) {
372 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
380 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
382 struct dwc3 *dwc = dep->dwc;
384 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
385 dep->trb_pool, dep->trb_pool_dma);
387 dep->trb_pool = NULL;
388 dep->trb_pool_dma = 0;
391 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
394 * dwc3_gadget_start_config - Configure EP resources
395 * @dwc: pointer to our controller context structure
396 * @dep: endpoint that is being enabled
398 * The assignment of transfer resources cannot perfectly follow the
399 * data book due to the fact that the controller driver does not have
400 * all knowledge of the configuration in advance. It is given this
401 * information piecemeal by the composite gadget framework after every
402 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
403 * programming model in this scenario can cause errors. For two
406 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
407 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
408 * multiple interfaces.
410 * 2) The databook does not mention doing more DEPXFERCFG for new
411 * endpoint on alt setting (8.1.6).
413 * The following simplified method is used instead:
415 * All hardware endpoints can be assigned a transfer resource and this
416 * setting will stay persistent until either a core reset or
417 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
418 * do DEPXFERCFG for every hardware endpoint as well. We are
419 * guaranteed that there are as many transfer resources as endpoints.
421 * This function is called for each endpoint when it is being enabled
422 * but is triggered only when called for EP0-out, which always happens
423 * first, and which should only happen in one of the above conditions.
425 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
427 struct dwc3_gadget_ep_cmd_params params;
435 memset(¶ms, 0x00, sizeof(params));
436 cmd = DWC3_DEPCMD_DEPSTARTCFG;
438 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
442 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
443 struct dwc3_ep *dep = dwc->eps[i];
448 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
456 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
457 const struct usb_endpoint_descriptor *desc,
458 const struct usb_ss_ep_comp_descriptor *comp_desc,
459 bool modify, bool restore)
461 struct dwc3_gadget_ep_cmd_params params;
463 if (dev_WARN_ONCE(dwc->dev, modify && restore,
464 "Can't modify and restore\n"))
467 memset(¶ms, 0x00, sizeof(params));
469 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
470 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
472 /* Burst size is only needed in SuperSpeed mode */
473 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
474 u32 burst = dep->endpoint.maxburst;
475 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
479 params.param0 |= DWC3_DEPCFG_ACTION_MODIFY;
480 } else if (restore) {
481 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
482 params.param2 |= dep->saved_state;
484 params.param0 |= DWC3_DEPCFG_ACTION_INIT;
487 if (usb_endpoint_xfer_control(desc))
488 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
490 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
491 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
493 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
494 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
495 | DWC3_DEPCFG_STREAM_EVENT_EN;
496 dep->stream_capable = true;
499 if (!usb_endpoint_xfer_control(desc))
500 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
503 * We are doing 1:1 mapping for endpoints, meaning
504 * Physical Endpoints 2 maps to Logical Endpoint 2 and
505 * so on. We consider the direction bit as part of the physical
506 * endpoint number. So USB endpoint 0x81 is 0x03.
508 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
511 * We must use the lower 16 TX FIFOs even though
515 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
517 if (desc->bInterval) {
518 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
519 dep->interval = 1 << (desc->bInterval - 1);
522 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
525 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
527 struct dwc3_gadget_ep_cmd_params params;
529 memset(¶ms, 0x00, sizeof(params));
531 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
533 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
538 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
539 * @dep: endpoint to be initialized
540 * @desc: USB Endpoint Descriptor
542 * Caller should take care of locking
544 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
545 const struct usb_endpoint_descriptor *desc,
546 const struct usb_ss_ep_comp_descriptor *comp_desc,
547 bool modify, bool restore)
549 struct dwc3 *dwc = dep->dwc;
553 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
555 if (!(dep->flags & DWC3_EP_ENABLED)) {
556 ret = dwc3_gadget_start_config(dwc, dep);
561 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, modify,
566 if (!(dep->flags & DWC3_EP_ENABLED)) {
567 struct dwc3_trb *trb_st_hw;
568 struct dwc3_trb *trb_link;
570 dep->endpoint.desc = desc;
571 dep->comp_desc = comp_desc;
572 dep->type = usb_endpoint_type(desc);
573 dep->flags |= DWC3_EP_ENABLED;
575 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
576 reg |= DWC3_DALEPENA_EP(dep->number);
577 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
579 if (usb_endpoint_xfer_control(desc))
582 /* Initialize the TRB ring */
583 dep->trb_dequeue = 0;
584 dep->trb_enqueue = 0;
585 memset(dep->trb_pool, 0,
586 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
588 /* Link TRB. The HWO bit is never reset */
589 trb_st_hw = &dep->trb_pool[0];
591 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
592 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
593 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
594 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
595 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
601 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
602 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
604 struct dwc3_request *req;
606 dwc3_stop_active_transfer(dwc, dep->number, true);
608 /* - giveback all requests to gadget driver */
609 while (!list_empty(&dep->started_list)) {
610 req = next_request(&dep->started_list);
612 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
615 while (!list_empty(&dep->pending_list)) {
616 req = next_request(&dep->pending_list);
618 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
623 * __dwc3_gadget_ep_disable - Disables a HW endpoint
624 * @dep: the endpoint to disable
626 * This function also removes requests which are currently processed ny the
627 * hardware and those which are not yet scheduled.
628 * Caller should take care of locking.
630 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
632 struct dwc3 *dwc = dep->dwc;
635 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
637 dwc3_remove_requests(dwc, dep);
639 /* make sure HW endpoint isn't stalled */
640 if (dep->flags & DWC3_EP_STALL)
641 __dwc3_gadget_ep_set_halt(dep, 0, false);
643 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
644 reg &= ~DWC3_DALEPENA_EP(dep->number);
645 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
647 dep->stream_capable = false;
648 dep->endpoint.desc = NULL;
649 dep->comp_desc = NULL;
656 /* -------------------------------------------------------------------------- */
658 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
659 const struct usb_endpoint_descriptor *desc)
664 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
669 /* -------------------------------------------------------------------------- */
671 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
672 const struct usb_endpoint_descriptor *desc)
679 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
680 pr_debug("dwc3: invalid parameters\n");
684 if (!desc->wMaxPacketSize) {
685 pr_debug("dwc3: missing wMaxPacketSize\n");
689 dep = to_dwc3_ep(ep);
692 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
693 "%s is already enabled\n",
697 spin_lock_irqsave(&dwc->lock, flags);
698 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
699 spin_unlock_irqrestore(&dwc->lock, flags);
704 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
712 pr_debug("dwc3: invalid parameters\n");
716 dep = to_dwc3_ep(ep);
719 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
720 "%s is already disabled\n",
724 spin_lock_irqsave(&dwc->lock, flags);
725 ret = __dwc3_gadget_ep_disable(dep);
726 spin_unlock_irqrestore(&dwc->lock, flags);
731 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
734 struct dwc3_request *req;
735 struct dwc3_ep *dep = to_dwc3_ep(ep);
737 req = kzalloc(sizeof(*req), gfp_flags);
741 req->epnum = dep->number;
744 dep->allocated_requests++;
746 trace_dwc3_alloc_request(req);
748 return &req->request;
751 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
752 struct usb_request *request)
754 struct dwc3_request *req = to_dwc3_request(request);
755 struct dwc3_ep *dep = to_dwc3_ep(ep);
757 dep->allocated_requests--;
758 trace_dwc3_free_request(req);
762 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep);
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 chain, unsigned node)
773 struct dwc3_trb *trb;
775 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s",
776 dep->name, req, (unsigned long long) dma,
777 length, chain ? " chain" : "");
779 trb = &dep->trb_pool[dep->trb_enqueue];
782 dwc3_gadget_move_started_request(req);
784 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
785 req->first_trb_index = dep->trb_enqueue;
786 dep->queued_requests++;
789 dwc3_ep_inc_enq(dep);
791 trb->size = DWC3_TRB_SIZE_LENGTH(length);
792 trb->bpl = lower_32_bits(dma);
793 trb->bph = upper_32_bits(dma);
795 switch (usb_endpoint_type(dep->endpoint.desc)) {
796 case USB_ENDPOINT_XFER_CONTROL:
797 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
800 case USB_ENDPOINT_XFER_ISOC:
802 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
804 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
806 /* always enable Interrupt on Missed ISOC */
807 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
810 case USB_ENDPOINT_XFER_BULK:
811 case USB_ENDPOINT_XFER_INT:
812 trb->ctrl = DWC3_TRBCTL_NORMAL;
816 * This is only possible with faulty memory because we
817 * checked it already :)
822 /* always enable Continue on Short Packet */
823 trb->ctrl |= DWC3_TRB_CTRL_CSP;
825 if ((!req->request.no_interrupt && !chain) ||
826 (dwc3_calc_trbs_left(dep) == 0))
827 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
830 trb->ctrl |= DWC3_TRB_CTRL_CHN;
832 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
833 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
835 trb->ctrl |= DWC3_TRB_CTRL_HWO;
837 trace_dwc3_prepare_trb(dep, trb);
841 * dwc3_ep_prev_trb() - Returns the previous TRB in the ring
842 * @dep: The endpoint with the TRB ring
843 * @index: The index of the current TRB in the ring
845 * Returns the TRB prior to the one pointed to by the index. If the
846 * index is 0, we will wrap backwards, skip the link TRB, and return
847 * the one just before that.
849 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
854 tmp = DWC3_TRB_NUM - 1;
856 return &dep->trb_pool[tmp - 1];
859 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
861 struct dwc3_trb *tmp;
865 * If enqueue & dequeue are equal than it is either full or empty.
867 * One way to know for sure is if the TRB right before us has HWO bit
868 * set or not. If it has, then we're definitely full and can't fit any
869 * more transfers in our ring.
871 if (dep->trb_enqueue == dep->trb_dequeue) {
872 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
873 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
876 return DWC3_TRB_NUM - 1;
879 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
880 trbs_left &= (DWC3_TRB_NUM - 1);
882 if (dep->trb_dequeue < dep->trb_enqueue)
888 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
889 struct dwc3_request *req)
891 struct scatterlist *sg = req->sg;
892 struct scatterlist *s;
897 for_each_sg(sg, s, req->num_pending_sgs, i) {
898 unsigned chain = true;
900 length = sg_dma_len(s);
901 dma = sg_dma_address(s);
906 dwc3_prepare_one_trb(dep, req, dma, length,
909 if (!dwc3_calc_trbs_left(dep))
914 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
915 struct dwc3_request *req)
920 dma = req->request.dma;
921 length = req->request.length;
923 dwc3_prepare_one_trb(dep, req, dma, length,
928 * dwc3_prepare_trbs - setup TRBs from requests
929 * @dep: endpoint for which requests are being prepared
931 * The function goes through the requests list and sets up TRBs for the
932 * transfers. The function returns once there are no more TRBs available or
933 * it runs out of requests.
935 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
937 struct dwc3_request *req, *n;
939 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
941 if (!dwc3_calc_trbs_left(dep))
944 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
945 if (req->num_pending_sgs > 0)
946 dwc3_prepare_one_trb_sg(dep, req);
948 dwc3_prepare_one_trb_linear(dep, req);
950 if (!dwc3_calc_trbs_left(dep))
955 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
957 struct dwc3_gadget_ep_cmd_params params;
958 struct dwc3_request *req;
959 struct dwc3 *dwc = dep->dwc;
964 starting = !(dep->flags & DWC3_EP_BUSY);
966 dwc3_prepare_trbs(dep);
967 req = next_request(&dep->started_list);
969 dep->flags |= DWC3_EP_PENDING_REQUEST;
973 memset(¶ms, 0, sizeof(params));
976 params.param0 = upper_32_bits(req->trb_dma);
977 params.param1 = lower_32_bits(req->trb_dma);
978 cmd = DWC3_DEPCMD_STARTTRANSFER |
979 DWC3_DEPCMD_PARAM(cmd_param);
981 cmd = DWC3_DEPCMD_UPDATETRANSFER |
982 DWC3_DEPCMD_PARAM(dep->resource_index);
985 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
988 * FIXME we need to iterate over the list of requests
989 * here and stop, unmap, free and del each of the linked
990 * requests instead of what we do now.
992 usb_gadget_unmap_request(&dwc->gadget, &req->request,
994 list_del(&req->list);
998 dep->flags |= DWC3_EP_BUSY;
1001 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1002 WARN_ON_ONCE(!dep->resource_index);
1008 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1009 struct dwc3_ep *dep, u32 cur_uf)
1013 if (list_empty(&dep->pending_list)) {
1014 dwc3_trace(trace_dwc3_gadget,
1015 "ISOC ep %s run out for requests",
1017 dep->flags |= DWC3_EP_PENDING_REQUEST;
1021 /* 4 micro frames in the future */
1022 uf = cur_uf + dep->interval * 4;
1024 __dwc3_gadget_kick_transfer(dep, uf);
1027 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1028 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1032 mask = ~(dep->interval - 1);
1033 cur_uf = event->parameters & mask;
1035 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1038 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1040 struct dwc3 *dwc = dep->dwc;
1043 if (!dep->endpoint.desc) {
1044 dwc3_trace(trace_dwc3_gadget,
1045 "trying to queue request %p to disabled %s",
1046 &req->request, dep->endpoint.name);
1050 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1051 &req->request, req->dep->name)) {
1052 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'",
1053 &req->request, req->dep->name);
1057 pm_runtime_get(dwc->dev);
1059 req->request.actual = 0;
1060 req->request.status = -EINPROGRESS;
1061 req->direction = dep->direction;
1062 req->epnum = dep->number;
1064 trace_dwc3_ep_queue(req);
1066 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1071 req->sg = req->request.sg;
1072 req->num_pending_sgs = req->request.num_mapped_sgs;
1074 list_add_tail(&req->list, &dep->pending_list);
1077 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1078 * wait for a XferNotReady event so we will know what's the current
1079 * (micro-)frame number.
1081 * Without this trick, we are very, very likely gonna get Bus Expiry
1082 * errors which will force us issue EndTransfer command.
1084 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1085 if ((dep->flags & DWC3_EP_PENDING_REQUEST) &&
1086 list_empty(&dep->started_list)) {
1087 dwc3_stop_active_transfer(dwc, dep->number, true);
1088 dep->flags = DWC3_EP_ENABLED;
1093 if (!dwc3_calc_trbs_left(dep))
1096 ret = __dwc3_gadget_kick_transfer(dep, 0);
1097 if (ret && ret != -EBUSY)
1098 dwc3_trace(trace_dwc3_gadget,
1099 "%s: failed to kick transfers",
1107 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1108 struct usb_request *request)
1110 dwc3_gadget_ep_free_request(ep, request);
1113 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1115 struct dwc3_request *req;
1116 struct usb_request *request;
1117 struct usb_ep *ep = &dep->endpoint;
1119 dwc3_trace(trace_dwc3_gadget, "queueing ZLP");
1120 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1124 request->length = 0;
1125 request->buf = dwc->zlp_buf;
1126 request->complete = __dwc3_gadget_ep_zlp_complete;
1128 req = to_dwc3_request(request);
1130 return __dwc3_gadget_ep_queue(dep, req);
1133 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1136 struct dwc3_request *req = to_dwc3_request(request);
1137 struct dwc3_ep *dep = to_dwc3_ep(ep);
1138 struct dwc3 *dwc = dep->dwc;
1140 unsigned long flags;
1144 spin_lock_irqsave(&dwc->lock, flags);
1145 ret = __dwc3_gadget_ep_queue(dep, req);
1148 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1149 * setting request->zero, instead of doing magic, we will just queue an
1150 * extra usb_request ourselves so that it gets handled the same way as
1151 * any other request.
1153 if (ret == 0 && request->zero && request->length &&
1154 (request->length % ep->maxpacket == 0))
1155 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1157 spin_unlock_irqrestore(&dwc->lock, flags);
1162 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1163 struct usb_request *request)
1165 struct dwc3_request *req = to_dwc3_request(request);
1166 struct dwc3_request *r = NULL;
1168 struct dwc3_ep *dep = to_dwc3_ep(ep);
1169 struct dwc3 *dwc = dep->dwc;
1171 unsigned long flags;
1174 trace_dwc3_ep_dequeue(req);
1176 spin_lock_irqsave(&dwc->lock, flags);
1178 list_for_each_entry(r, &dep->pending_list, list) {
1184 list_for_each_entry(r, &dep->started_list, list) {
1189 /* wait until it is processed */
1190 dwc3_stop_active_transfer(dwc, dep->number, true);
1193 dev_err(dwc->dev, "request %p was not queued to %s\n",
1200 /* giveback the request */
1201 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1204 spin_unlock_irqrestore(&dwc->lock, flags);
1209 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1211 struct dwc3_gadget_ep_cmd_params params;
1212 struct dwc3 *dwc = dep->dwc;
1215 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1216 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1220 memset(¶ms, 0x00, sizeof(params));
1223 struct dwc3_trb *trb;
1225 unsigned transfer_in_flight;
1228 if (dep->number > 1)
1229 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1231 trb = &dwc->ep0_trb[dep->trb_enqueue];
1233 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1234 started = !list_empty(&dep->started_list);
1236 if (!protocol && ((dep->direction && transfer_in_flight) ||
1237 (!dep->direction && started))) {
1238 dwc3_trace(trace_dwc3_gadget,
1239 "%s: pending request, cannot halt",
1244 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1247 dev_err(dwc->dev, "failed to set STALL on %s\n",
1250 dep->flags |= DWC3_EP_STALL;
1253 ret = dwc3_send_clear_stall_ep_cmd(dep);
1255 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1258 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1264 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1266 struct dwc3_ep *dep = to_dwc3_ep(ep);
1267 struct dwc3 *dwc = dep->dwc;
1269 unsigned long flags;
1273 spin_lock_irqsave(&dwc->lock, flags);
1274 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1275 spin_unlock_irqrestore(&dwc->lock, flags);
1280 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1282 struct dwc3_ep *dep = to_dwc3_ep(ep);
1283 struct dwc3 *dwc = dep->dwc;
1284 unsigned long flags;
1287 spin_lock_irqsave(&dwc->lock, flags);
1288 dep->flags |= DWC3_EP_WEDGE;
1290 if (dep->number == 0 || dep->number == 1)
1291 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1293 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1294 spin_unlock_irqrestore(&dwc->lock, flags);
1299 /* -------------------------------------------------------------------------- */
1301 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1302 .bLength = USB_DT_ENDPOINT_SIZE,
1303 .bDescriptorType = USB_DT_ENDPOINT,
1304 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1307 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1308 .enable = dwc3_gadget_ep0_enable,
1309 .disable = dwc3_gadget_ep0_disable,
1310 .alloc_request = dwc3_gadget_ep_alloc_request,
1311 .free_request = dwc3_gadget_ep_free_request,
1312 .queue = dwc3_gadget_ep0_queue,
1313 .dequeue = dwc3_gadget_ep_dequeue,
1314 .set_halt = dwc3_gadget_ep0_set_halt,
1315 .set_wedge = dwc3_gadget_ep_set_wedge,
1318 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1319 .enable = dwc3_gadget_ep_enable,
1320 .disable = dwc3_gadget_ep_disable,
1321 .alloc_request = dwc3_gadget_ep_alloc_request,
1322 .free_request = dwc3_gadget_ep_free_request,
1323 .queue = dwc3_gadget_ep_queue,
1324 .dequeue = dwc3_gadget_ep_dequeue,
1325 .set_halt = dwc3_gadget_ep_set_halt,
1326 .set_wedge = dwc3_gadget_ep_set_wedge,
1329 /* -------------------------------------------------------------------------- */
1331 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1333 struct dwc3 *dwc = gadget_to_dwc(g);
1336 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1337 return DWC3_DSTS_SOFFN(reg);
1340 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1351 * According to the Databook Remote wakeup request should
1352 * be issued only when the device is in early suspend state.
1354 * We can check that via USB Link State bits in DSTS register.
1356 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1358 speed = reg & DWC3_DSTS_CONNECTSPD;
1359 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1360 (speed == DWC3_DSTS_SUPERSPEED_PLUS)) {
1361 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed");
1365 link_state = DWC3_DSTS_USBLNKST(reg);
1367 switch (link_state) {
1368 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1369 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1372 dwc3_trace(trace_dwc3_gadget,
1373 "can't wakeup from '%s'",
1374 dwc3_gadget_link_string(link_state));
1378 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1380 dev_err(dwc->dev, "failed to put link in Recovery\n");
1384 /* Recent versions do this automatically */
1385 if (dwc->revision < DWC3_REVISION_194A) {
1386 /* write zeroes to Link Change Request */
1387 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1388 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1389 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1392 /* poll until Link State changes to ON */
1396 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1398 /* in HS, means ON */
1399 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1403 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1404 dev_err(dwc->dev, "failed to send remote wakeup\n");
1411 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1413 struct dwc3 *dwc = gadget_to_dwc(g);
1414 unsigned long flags;
1417 spin_lock_irqsave(&dwc->lock, flags);
1418 ret = __dwc3_gadget_wakeup(dwc);
1419 spin_unlock_irqrestore(&dwc->lock, flags);
1424 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1427 struct dwc3 *dwc = gadget_to_dwc(g);
1428 unsigned long flags;
1430 spin_lock_irqsave(&dwc->lock, flags);
1431 g->is_selfpowered = !!is_selfpowered;
1432 spin_unlock_irqrestore(&dwc->lock, flags);
1437 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1442 if (pm_runtime_suspended(dwc->dev))
1445 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1447 if (dwc->revision <= DWC3_REVISION_187A) {
1448 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1449 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1452 if (dwc->revision >= DWC3_REVISION_194A)
1453 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1454 reg |= DWC3_DCTL_RUN_STOP;
1456 if (dwc->has_hibernation)
1457 reg |= DWC3_DCTL_KEEP_CONNECT;
1459 dwc->pullups_connected = true;
1461 reg &= ~DWC3_DCTL_RUN_STOP;
1463 if (dwc->has_hibernation && !suspend)
1464 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1466 dwc->pullups_connected = false;
1469 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1472 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1473 reg &= DWC3_DSTS_DEVCTRLHLT;
1474 } while (--timeout && !(!is_on ^ !reg));
1479 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1481 ? dwc->gadget_driver->function : "no-function",
1482 is_on ? "connect" : "disconnect");
1487 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1489 struct dwc3 *dwc = gadget_to_dwc(g);
1490 unsigned long flags;
1495 spin_lock_irqsave(&dwc->lock, flags);
1496 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1497 spin_unlock_irqrestore(&dwc->lock, flags);
1502 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1506 /* Enable all but Start and End of Frame IRQs */
1507 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1508 DWC3_DEVTEN_EVNTOVERFLOWEN |
1509 DWC3_DEVTEN_CMDCMPLTEN |
1510 DWC3_DEVTEN_ERRTICERREN |
1511 DWC3_DEVTEN_WKUPEVTEN |
1512 DWC3_DEVTEN_ULSTCNGEN |
1513 DWC3_DEVTEN_CONNECTDONEEN |
1514 DWC3_DEVTEN_USBRSTEN |
1515 DWC3_DEVTEN_DISCONNEVTEN);
1517 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1520 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1522 /* mask all interrupts */
1523 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1526 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1527 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1530 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1531 * dwc: pointer to our context structure
1533 * The following looks like complex but it's actually very simple. In order to
1534 * calculate the number of packets we can burst at once on OUT transfers, we're
1535 * gonna use RxFIFO size.
1537 * To calculate RxFIFO size we need two numbers:
1538 * MDWIDTH = size, in bits, of the internal memory bus
1539 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1541 * Given these two numbers, the formula is simple:
1543 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1545 * 24 bytes is for 3x SETUP packets
1546 * 16 bytes is a clock domain crossing tolerance
1548 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1550 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1557 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1558 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1560 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1561 nump = min_t(u32, nump, 16);
1564 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1565 reg &= ~DWC3_DCFG_NUMP_MASK;
1566 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1567 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1570 static int __dwc3_gadget_start(struct dwc3 *dwc)
1572 struct dwc3_ep *dep;
1576 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1577 reg &= ~(DWC3_DCFG_SPEED_MASK);
1580 * WORKAROUND: DWC3 revision < 2.20a have an issue
1581 * which would cause metastability state on Run/Stop
1582 * bit if we try to force the IP to USB2-only mode.
1584 * Because of that, we cannot configure the IP to any
1585 * speed other than the SuperSpeed
1589 * STAR#9000525659: Clock Domain Crossing on DCTL in
1592 if (dwc->revision < DWC3_REVISION_220A) {
1593 reg |= DWC3_DCFG_SUPERSPEED;
1595 switch (dwc->maximum_speed) {
1597 reg |= DWC3_DCFG_LOWSPEED;
1599 case USB_SPEED_FULL:
1600 reg |= DWC3_DCFG_FULLSPEED1;
1602 case USB_SPEED_HIGH:
1603 reg |= DWC3_DCFG_HIGHSPEED;
1605 case USB_SPEED_SUPER_PLUS:
1606 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
1609 dev_err(dwc->dev, "invalid dwc->maximum_speed (%d)\n",
1610 dwc->maximum_speed);
1612 case USB_SPEED_SUPER:
1613 reg |= DWC3_DCFG_SUPERSPEED;
1617 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1620 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1621 * field instead of letting dwc3 itself calculate that automatically.
1623 * This way, we maximize the chances that we'll be able to get several
1624 * bursts of data without going through any sort of endpoint throttling.
1626 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1627 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1628 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1630 dwc3_gadget_setup_nump(dwc);
1632 /* Start with SuperSpeed Default */
1633 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1636 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1639 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1644 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1647 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1651 /* begin to receive SETUP packets */
1652 dwc->ep0state = EP0_SETUP_PHASE;
1653 dwc3_ep0_out_start(dwc);
1655 dwc3_gadget_enable_irq(dwc);
1660 __dwc3_gadget_ep_disable(dwc->eps[0]);
1666 static int dwc3_gadget_start(struct usb_gadget *g,
1667 struct usb_gadget_driver *driver)
1669 struct dwc3 *dwc = gadget_to_dwc(g);
1670 unsigned long flags;
1674 irq = dwc->irq_gadget;
1675 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1676 IRQF_SHARED, "dwc3", dwc->ev_buf);
1678 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1683 spin_lock_irqsave(&dwc->lock, flags);
1684 if (dwc->gadget_driver) {
1685 dev_err(dwc->dev, "%s is already bound to %s\n",
1687 dwc->gadget_driver->driver.name);
1692 dwc->gadget_driver = driver;
1694 if (pm_runtime_active(dwc->dev))
1695 __dwc3_gadget_start(dwc);
1697 spin_unlock_irqrestore(&dwc->lock, flags);
1702 spin_unlock_irqrestore(&dwc->lock, flags);
1709 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1711 if (pm_runtime_suspended(dwc->dev))
1714 dwc3_gadget_disable_irq(dwc);
1715 __dwc3_gadget_ep_disable(dwc->eps[0]);
1716 __dwc3_gadget_ep_disable(dwc->eps[1]);
1719 static int dwc3_gadget_stop(struct usb_gadget *g)
1721 struct dwc3 *dwc = gadget_to_dwc(g);
1722 unsigned long flags;
1724 spin_lock_irqsave(&dwc->lock, flags);
1725 __dwc3_gadget_stop(dwc);
1726 dwc->gadget_driver = NULL;
1727 spin_unlock_irqrestore(&dwc->lock, flags);
1729 free_irq(dwc->irq_gadget, dwc->ev_buf);
1734 static const struct usb_gadget_ops dwc3_gadget_ops = {
1735 .get_frame = dwc3_gadget_get_frame,
1736 .wakeup = dwc3_gadget_wakeup,
1737 .set_selfpowered = dwc3_gadget_set_selfpowered,
1738 .pullup = dwc3_gadget_pullup,
1739 .udc_start = dwc3_gadget_start,
1740 .udc_stop = dwc3_gadget_stop,
1743 /* -------------------------------------------------------------------------- */
1745 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1746 u8 num, u32 direction)
1748 struct dwc3_ep *dep;
1751 for (i = 0; i < num; i++) {
1752 u8 epnum = (i << 1) | (direction ? 1 : 0);
1754 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1759 dep->number = epnum;
1760 dep->direction = !!direction;
1761 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1762 dwc->eps[epnum] = dep;
1764 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1765 (epnum & 1) ? "in" : "out");
1767 dep->endpoint.name = dep->name;
1768 spin_lock_init(&dep->lock);
1770 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1772 if (epnum == 0 || epnum == 1) {
1773 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1774 dep->endpoint.maxburst = 1;
1775 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1777 dwc->gadget.ep0 = &dep->endpoint;
1781 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1782 dep->endpoint.max_streams = 15;
1783 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1784 list_add_tail(&dep->endpoint.ep_list,
1785 &dwc->gadget.ep_list);
1787 ret = dwc3_alloc_trb_pool(dep);
1792 if (epnum == 0 || epnum == 1) {
1793 dep->endpoint.caps.type_control = true;
1795 dep->endpoint.caps.type_iso = true;
1796 dep->endpoint.caps.type_bulk = true;
1797 dep->endpoint.caps.type_int = true;
1800 dep->endpoint.caps.dir_in = !!direction;
1801 dep->endpoint.caps.dir_out = !direction;
1803 INIT_LIST_HEAD(&dep->pending_list);
1804 INIT_LIST_HEAD(&dep->started_list);
1810 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1814 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1816 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1818 dwc3_trace(trace_dwc3_gadget,
1819 "failed to allocate OUT endpoints");
1823 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1825 dwc3_trace(trace_dwc3_gadget,
1826 "failed to allocate IN endpoints");
1833 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1835 struct dwc3_ep *dep;
1838 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1839 dep = dwc->eps[epnum];
1843 * Physical endpoints 0 and 1 are special; they form the
1844 * bi-directional USB endpoint 0.
1846 * For those two physical endpoints, we don't allocate a TRB
1847 * pool nor do we add them the endpoints list. Due to that, we
1848 * shouldn't do these two operations otherwise we would end up
1849 * with all sorts of bugs when removing dwc3.ko.
1851 if (epnum != 0 && epnum != 1) {
1852 dwc3_free_trb_pool(dep);
1853 list_del(&dep->endpoint.ep_list);
1860 /* -------------------------------------------------------------------------- */
1862 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1863 struct dwc3_request *req, struct dwc3_trb *trb,
1864 const struct dwc3_event_depevt *event, int status,
1868 unsigned int s_pkt = 0;
1869 unsigned int trb_status;
1871 dwc3_ep_inc_deq(dep);
1873 if (req->trb == trb)
1874 dep->queued_requests--;
1876 trace_dwc3_complete_trb(dep, trb);
1879 * If we're in the middle of series of chained TRBs and we
1880 * receive a short transfer along the way, DWC3 will skip
1881 * through all TRBs including the last TRB in the chain (the
1882 * where CHN bit is zero. DWC3 will also avoid clearing HWO
1883 * bit and SW has to do it manually.
1885 * We're going to do that here to avoid problems of HW trying
1886 * to use bogus TRBs for transfers.
1888 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
1889 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1891 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1894 count = trb->size & DWC3_TRB_SIZE_MASK;
1895 req->request.actual += count;
1897 if (dep->direction) {
1899 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1900 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1901 dwc3_trace(trace_dwc3_gadget,
1902 "%s: incomplete IN transfer",
1905 * If missed isoc occurred and there is
1906 * no request queued then issue END
1907 * TRANSFER, so that core generates
1908 * next xfernotready and we will issue
1909 * a fresh START TRANSFER.
1910 * If there are still queued request
1911 * then wait, do not issue either END
1912 * or UPDATE TRANSFER, just attach next
1913 * request in pending_list during
1914 * giveback.If any future queued request
1915 * is successfully transferred then we
1916 * will issue UPDATE TRANSFER for all
1917 * request in the pending_list.
1919 dep->flags |= DWC3_EP_MISSED_ISOC;
1921 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1923 status = -ECONNRESET;
1926 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1929 if (count && (event->status & DEPEVT_STATUS_SHORT))
1933 if (s_pkt && !chain)
1936 if ((event->status & DEPEVT_STATUS_IOC) &&
1937 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1943 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1944 const struct dwc3_event_depevt *event, int status)
1946 struct dwc3_request *req, *n;
1947 struct dwc3_trb *trb;
1951 list_for_each_entry_safe(req, n, &dep->started_list, list) {
1956 length = req->request.length;
1957 chain = req->num_pending_sgs > 0;
1959 struct scatterlist *sg = req->sg;
1960 struct scatterlist *s;
1961 unsigned int pending = req->num_pending_sgs;
1964 for_each_sg(sg, s, pending, i) {
1965 trb = &dep->trb_pool[dep->trb_dequeue];
1967 req->sg = sg_next(s);
1968 req->num_pending_sgs--;
1970 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1971 event, status, chain);
1976 trb = &dep->trb_pool[dep->trb_dequeue];
1977 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1978 event, status, chain);
1982 * We assume here we will always receive the entire data block
1983 * which we should receive. Meaning, if we program RX to
1984 * receive 4K but we receive only 2K, we assume that's all we
1985 * should receive and we simply bounce the request back to the
1986 * gadget driver for further processing.
1988 actual = length - req->request.actual;
1989 req->request.actual = actual;
1991 if (ret && chain && (actual < length) && req->num_pending_sgs)
1992 return __dwc3_gadget_kick_transfer(dep, 0);
1994 dwc3_gadget_giveback(dep, req, status);
1997 if ((event->status & DEPEVT_STATUS_IOC) &&
1998 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2005 * Our endpoint might get disabled by another thread during
2006 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2007 * early on so DWC3_EP_BUSY flag gets cleared
2009 if (!dep->endpoint.desc)
2012 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2013 list_empty(&dep->started_list)) {
2014 if (list_empty(&dep->pending_list)) {
2016 * If there is no entry in request list then do
2017 * not issue END TRANSFER now. Just set PENDING
2018 * flag, so that END TRANSFER is issued when an
2019 * entry is added into request list.
2021 dep->flags = DWC3_EP_PENDING_REQUEST;
2023 dwc3_stop_active_transfer(dwc, dep->number, true);
2024 dep->flags = DWC3_EP_ENABLED;
2029 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) && ioc)
2035 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2036 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2038 unsigned status = 0;
2040 u32 is_xfer_complete;
2042 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2044 if (event->status & DEPEVT_STATUS_BUSERR)
2045 status = -ECONNRESET;
2047 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2048 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2049 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2050 dep->flags &= ~DWC3_EP_BUSY;
2053 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2054 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2056 if (dwc->revision < DWC3_REVISION_183A) {
2060 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2063 if (!(dep->flags & DWC3_EP_ENABLED))
2066 if (!list_empty(&dep->started_list))
2070 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2072 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2078 * Our endpoint might get disabled by another thread during
2079 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2080 * early on so DWC3_EP_BUSY flag gets cleared
2082 if (!dep->endpoint.desc)
2085 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2088 ret = __dwc3_gadget_kick_transfer(dep, 0);
2089 if (!ret || ret == -EBUSY)
2094 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2095 const struct dwc3_event_depevt *event)
2097 struct dwc3_ep *dep;
2098 u8 epnum = event->endpoint_number;
2100 dep = dwc->eps[epnum];
2102 if (!(dep->flags & DWC3_EP_ENABLED))
2105 if (epnum == 0 || epnum == 1) {
2106 dwc3_ep0_interrupt(dwc, event);
2110 switch (event->endpoint_event) {
2111 case DWC3_DEPEVT_XFERCOMPLETE:
2112 dep->resource_index = 0;
2114 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2115 dwc3_trace(trace_dwc3_gadget,
2116 "%s is an Isochronous endpoint",
2121 dwc3_endpoint_transfer_complete(dwc, dep, event);
2123 case DWC3_DEPEVT_XFERINPROGRESS:
2124 dwc3_endpoint_transfer_complete(dwc, dep, event);
2126 case DWC3_DEPEVT_XFERNOTREADY:
2127 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2128 dwc3_gadget_start_isoc(dwc, dep, event);
2133 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2135 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2136 dep->name, active ? "Transfer Active"
2137 : "Transfer Not Active");
2139 ret = __dwc3_gadget_kick_transfer(dep, 0);
2140 if (!ret || ret == -EBUSY)
2143 dwc3_trace(trace_dwc3_gadget,
2144 "%s: failed to kick transfers",
2149 case DWC3_DEPEVT_STREAMEVT:
2150 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2151 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2156 switch (event->status) {
2157 case DEPEVT_STREAMEVT_FOUND:
2158 dwc3_trace(trace_dwc3_gadget,
2159 "Stream %d found and started",
2163 case DEPEVT_STREAMEVT_NOTFOUND:
2166 dwc3_trace(trace_dwc3_gadget,
2167 "unable to find suitable stream");
2170 case DWC3_DEPEVT_RXTXFIFOEVT:
2171 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun", dep->name);
2173 case DWC3_DEPEVT_EPCMDCMPLT:
2174 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2179 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2181 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2182 spin_unlock(&dwc->lock);
2183 dwc->gadget_driver->disconnect(&dwc->gadget);
2184 spin_lock(&dwc->lock);
2188 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2190 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2191 spin_unlock(&dwc->lock);
2192 dwc->gadget_driver->suspend(&dwc->gadget);
2193 spin_lock(&dwc->lock);
2197 static void dwc3_resume_gadget(struct dwc3 *dwc)
2199 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2200 spin_unlock(&dwc->lock);
2201 dwc->gadget_driver->resume(&dwc->gadget);
2202 spin_lock(&dwc->lock);
2206 static void dwc3_reset_gadget(struct dwc3 *dwc)
2208 if (!dwc->gadget_driver)
2211 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2212 spin_unlock(&dwc->lock);
2213 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2214 spin_lock(&dwc->lock);
2218 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2220 struct dwc3_ep *dep;
2221 struct dwc3_gadget_ep_cmd_params params;
2225 dep = dwc->eps[epnum];
2227 if (!dep->resource_index)
2231 * NOTICE: We are violating what the Databook says about the
2232 * EndTransfer command. Ideally we would _always_ wait for the
2233 * EndTransfer Command Completion IRQ, but that's causing too
2234 * much trouble synchronizing between us and gadget driver.
2236 * We have discussed this with the IP Provider and it was
2237 * suggested to giveback all requests here, but give HW some
2238 * extra time to synchronize with the interconnect. We're using
2239 * an arbitrary 100us delay for that.
2241 * Note also that a similar handling was tested by Synopsys
2242 * (thanks a lot Paul) and nothing bad has come out of it.
2243 * In short, what we're doing is:
2245 * - Issue EndTransfer WITH CMDIOC bit set
2248 * As of IP version 3.10a of the DWC_usb3 IP, the controller
2249 * supports a mode to work around the above limitation. The
2250 * software can poll the CMDACT bit in the DEPCMD register
2251 * after issuing a EndTransfer command. This mode is enabled
2252 * by writing GUCTL2[14]. This polling is already done in the
2253 * dwc3_send_gadget_ep_cmd() function so if the mode is
2254 * enabled, the EndTransfer command will have completed upon
2255 * returning from this function and we don't need to delay for
2258 * This mode is NOT available on the DWC_usb31 IP.
2261 cmd = DWC3_DEPCMD_ENDTRANSFER;
2262 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2263 cmd |= DWC3_DEPCMD_CMDIOC;
2264 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2265 memset(¶ms, 0, sizeof(params));
2266 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2268 dep->resource_index = 0;
2269 dep->flags &= ~DWC3_EP_BUSY;
2271 if (dwc3_is_usb31(dwc) || dwc->revision < DWC3_REVISION_310A)
2275 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2279 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2280 struct dwc3_ep *dep;
2282 dep = dwc->eps[epnum];
2286 if (!(dep->flags & DWC3_EP_ENABLED))
2289 dwc3_remove_requests(dwc, dep);
2293 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2297 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2298 struct dwc3_ep *dep;
2301 dep = dwc->eps[epnum];
2305 if (!(dep->flags & DWC3_EP_STALL))
2308 dep->flags &= ~DWC3_EP_STALL;
2310 ret = dwc3_send_clear_stall_ep_cmd(dep);
2315 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2319 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2320 reg &= ~DWC3_DCTL_INITU1ENA;
2321 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2323 reg &= ~DWC3_DCTL_INITU2ENA;
2324 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2326 dwc3_disconnect_gadget(dwc);
2328 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2329 dwc->setup_packet_pending = false;
2330 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2332 dwc->connected = false;
2335 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2339 dwc->connected = true;
2342 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2343 * would cause a missing Disconnect Event if there's a
2344 * pending Setup Packet in the FIFO.
2346 * There's no suggested workaround on the official Bug
2347 * report, which states that "unless the driver/application
2348 * is doing any special handling of a disconnect event,
2349 * there is no functional issue".
2351 * Unfortunately, it turns out that we _do_ some special
2352 * handling of a disconnect event, namely complete all
2353 * pending transfers, notify gadget driver of the
2354 * disconnection, and so on.
2356 * Our suggested workaround is to follow the Disconnect
2357 * Event steps here, instead, based on a setup_packet_pending
2358 * flag. Such flag gets set whenever we have a SETUP_PENDING
2359 * status for EP0 TRBs and gets cleared on XferComplete for the
2364 * STAR#9000466709: RTL: Device : Disconnect event not
2365 * generated if setup packet pending in FIFO
2367 if (dwc->revision < DWC3_REVISION_188A) {
2368 if (dwc->setup_packet_pending)
2369 dwc3_gadget_disconnect_interrupt(dwc);
2372 dwc3_reset_gadget(dwc);
2374 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2375 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2376 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2377 dwc->test_mode = false;
2379 dwc3_stop_active_transfers(dwc);
2380 dwc3_clear_stall_all_ep(dwc);
2382 /* Reset device address to zero */
2383 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2384 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2385 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2388 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2391 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2394 * We change the clock only at SS but I dunno why I would want to do
2395 * this. Maybe it becomes part of the power saving plan.
2398 if ((speed != DWC3_DSTS_SUPERSPEED) &&
2399 (speed != DWC3_DSTS_SUPERSPEED_PLUS))
2403 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2404 * each time on Connect Done.
2409 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2410 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2411 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2414 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2416 struct dwc3_ep *dep;
2421 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2422 speed = reg & DWC3_DSTS_CONNECTSPD;
2425 dwc3_update_ram_clk_sel(dwc, speed);
2428 case DWC3_DSTS_SUPERSPEED_PLUS:
2429 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2430 dwc->gadget.ep0->maxpacket = 512;
2431 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2433 case DWC3_DSTS_SUPERSPEED:
2435 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2436 * would cause a missing USB3 Reset event.
2438 * In such situations, we should force a USB3 Reset
2439 * event by calling our dwc3_gadget_reset_interrupt()
2444 * STAR#9000483510: RTL: SS : USB3 reset event may
2445 * not be generated always when the link enters poll
2447 if (dwc->revision < DWC3_REVISION_190A)
2448 dwc3_gadget_reset_interrupt(dwc);
2450 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2451 dwc->gadget.ep0->maxpacket = 512;
2452 dwc->gadget.speed = USB_SPEED_SUPER;
2454 case DWC3_DSTS_HIGHSPEED:
2455 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2456 dwc->gadget.ep0->maxpacket = 64;
2457 dwc->gadget.speed = USB_SPEED_HIGH;
2459 case DWC3_DSTS_FULLSPEED2:
2460 case DWC3_DSTS_FULLSPEED1:
2461 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2462 dwc->gadget.ep0->maxpacket = 64;
2463 dwc->gadget.speed = USB_SPEED_FULL;
2465 case DWC3_DSTS_LOWSPEED:
2466 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2467 dwc->gadget.ep0->maxpacket = 8;
2468 dwc->gadget.speed = USB_SPEED_LOW;
2472 /* Enable USB2 LPM Capability */
2474 if ((dwc->revision > DWC3_REVISION_194A) &&
2475 (speed != DWC3_DSTS_SUPERSPEED) &&
2476 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2477 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2478 reg |= DWC3_DCFG_LPM_CAP;
2479 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2481 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2482 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2484 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2487 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2488 * DCFG.LPMCap is set, core responses with an ACK and the
2489 * BESL value in the LPM token is less than or equal to LPM
2492 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2493 && dwc->has_lpm_erratum,
2494 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2496 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2497 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2499 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2501 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2502 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2503 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2507 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2510 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2515 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2518 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2523 * Configure PHY via GUSB3PIPECTLn if required.
2525 * Update GTXFIFOSIZn
2527 * In both cases reset values should be sufficient.
2531 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2534 * TODO take core out of low power mode when that's
2538 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2539 spin_unlock(&dwc->lock);
2540 dwc->gadget_driver->resume(&dwc->gadget);
2541 spin_lock(&dwc->lock);
2545 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2546 unsigned int evtinfo)
2548 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2549 unsigned int pwropt;
2552 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2553 * Hibernation mode enabled which would show up when device detects
2554 * host-initiated U3 exit.
2556 * In that case, device will generate a Link State Change Interrupt
2557 * from U3 to RESUME which is only necessary if Hibernation is
2560 * There are no functional changes due to such spurious event and we
2561 * just need to ignore it.
2565 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2568 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2569 if ((dwc->revision < DWC3_REVISION_250A) &&
2570 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2571 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2572 (next == DWC3_LINK_STATE_RESUME)) {
2573 dwc3_trace(trace_dwc3_gadget,
2574 "ignoring transition U3 -> Resume");
2580 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2581 * on the link partner, the USB session might do multiple entry/exit
2582 * of low power states before a transfer takes place.
2584 * Due to this problem, we might experience lower throughput. The
2585 * suggested workaround is to disable DCTL[12:9] bits if we're
2586 * transitioning from U1/U2 to U0 and enable those bits again
2587 * after a transfer completes and there are no pending transfers
2588 * on any of the enabled endpoints.
2590 * This is the first half of that workaround.
2594 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2595 * core send LGO_Ux entering U0
2597 if (dwc->revision < DWC3_REVISION_183A) {
2598 if (next == DWC3_LINK_STATE_U0) {
2602 switch (dwc->link_state) {
2603 case DWC3_LINK_STATE_U1:
2604 case DWC3_LINK_STATE_U2:
2605 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2606 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2607 | DWC3_DCTL_ACCEPTU2ENA
2608 | DWC3_DCTL_INITU1ENA
2609 | DWC3_DCTL_ACCEPTU1ENA);
2612 dwc->u1u2 = reg & u1u2;
2616 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2626 case DWC3_LINK_STATE_U1:
2627 if (dwc->speed == USB_SPEED_SUPER)
2628 dwc3_suspend_gadget(dwc);
2630 case DWC3_LINK_STATE_U2:
2631 case DWC3_LINK_STATE_U3:
2632 dwc3_suspend_gadget(dwc);
2634 case DWC3_LINK_STATE_RESUME:
2635 dwc3_resume_gadget(dwc);
2642 dwc->link_state = next;
2645 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
2646 unsigned int evtinfo)
2648 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2650 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
2651 dwc3_suspend_gadget(dwc);
2653 dwc->link_state = next;
2656 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2657 unsigned int evtinfo)
2659 unsigned int is_ss = evtinfo & BIT(4);
2662 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2663 * have a known issue which can cause USB CV TD.9.23 to fail
2666 * Because of this issue, core could generate bogus hibernation
2667 * events which SW needs to ignore.
2671 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2672 * Device Fallback from SuperSpeed
2674 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2677 /* enter hibernation here */
2680 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2681 const struct dwc3_event_devt *event)
2683 switch (event->type) {
2684 case DWC3_DEVICE_EVENT_DISCONNECT:
2685 dwc3_gadget_disconnect_interrupt(dwc);
2687 case DWC3_DEVICE_EVENT_RESET:
2688 dwc3_gadget_reset_interrupt(dwc);
2690 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2691 dwc3_gadget_conndone_interrupt(dwc);
2693 case DWC3_DEVICE_EVENT_WAKEUP:
2694 dwc3_gadget_wakeup_interrupt(dwc);
2696 case DWC3_DEVICE_EVENT_HIBER_REQ:
2697 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2698 "unexpected hibernation event\n"))
2701 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2703 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2704 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2706 case DWC3_DEVICE_EVENT_EOPF:
2707 /* It changed to be suspend event for version 2.30a and above */
2708 if (dwc->revision < DWC3_REVISION_230A) {
2709 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2711 dwc3_trace(trace_dwc3_gadget, "U3/L1-L2 Suspend Event");
2714 * Ignore suspend event until the gadget enters into
2715 * USB_STATE_CONFIGURED state.
2717 if (dwc->gadget.state >= USB_STATE_CONFIGURED)
2718 dwc3_gadget_suspend_interrupt(dwc,
2722 case DWC3_DEVICE_EVENT_SOF:
2723 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2725 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2726 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2728 case DWC3_DEVICE_EVENT_CMD_CMPL:
2729 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2731 case DWC3_DEVICE_EVENT_OVERFLOW:
2732 dwc3_trace(trace_dwc3_gadget, "Overflow");
2735 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2739 static void dwc3_process_event_entry(struct dwc3 *dwc,
2740 const union dwc3_event *event)
2742 trace_dwc3_event(event->raw);
2744 /* Endpoint IRQ, handle it and return early */
2745 if (event->type.is_devspec == 0) {
2747 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2750 switch (event->type.type) {
2751 case DWC3_EVENT_TYPE_DEV:
2752 dwc3_gadget_interrupt(dwc, &event->devt);
2754 /* REVISIT what to do with Carkit and I2C events ? */
2756 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2760 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2762 struct dwc3 *dwc = evt->dwc;
2763 irqreturn_t ret = IRQ_NONE;
2769 if (!(evt->flags & DWC3_EVENT_PENDING))
2773 union dwc3_event event;
2775 event.raw = *(u32 *) (evt->buf + evt->lpos);
2777 dwc3_process_event_entry(dwc, &event);
2780 * FIXME we wrap around correctly to the next entry as
2781 * almost all entries are 4 bytes in size. There is one
2782 * entry which has 12 bytes which is a regular entry
2783 * followed by 8 bytes data. ATM I don't know how
2784 * things are organized if we get next to the a
2785 * boundary so I worry about that once we try to handle
2788 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2791 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2795 evt->flags &= ~DWC3_EVENT_PENDING;
2798 /* Unmask interrupt */
2799 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2800 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2801 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2806 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2808 struct dwc3_event_buffer *evt = _evt;
2809 struct dwc3 *dwc = evt->dwc;
2810 unsigned long flags;
2811 irqreturn_t ret = IRQ_NONE;
2813 spin_lock_irqsave(&dwc->lock, flags);
2814 ret = dwc3_process_event_buf(evt);
2815 spin_unlock_irqrestore(&dwc->lock, flags);
2820 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2822 struct dwc3 *dwc = evt->dwc;
2826 if (pm_runtime_suspended(dwc->dev)) {
2827 pm_runtime_get(dwc->dev);
2828 disable_irq_nosync(dwc->irq_gadget);
2829 dwc->pending_events = true;
2833 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2834 count &= DWC3_GEVNTCOUNT_MASK;
2839 evt->flags |= DWC3_EVENT_PENDING;
2841 /* Mask interrupt */
2842 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2843 reg |= DWC3_GEVNTSIZ_INTMASK;
2844 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2846 return IRQ_WAKE_THREAD;
2849 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2851 struct dwc3_event_buffer *evt = _evt;
2853 return dwc3_check_event_buf(evt);
2857 * dwc3_gadget_init - Initializes gadget related registers
2858 * @dwc: pointer to our controller context structure
2860 * Returns 0 on success otherwise negative errno.
2862 int dwc3_gadget_init(struct dwc3 *dwc)
2865 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
2867 irq = platform_get_irq_byname(dwc3_pdev, "peripheral");
2868 if (irq == -EPROBE_DEFER)
2872 irq = platform_get_irq_byname(dwc3_pdev, "dwc_usb3");
2873 if (irq == -EPROBE_DEFER)
2877 irq = platform_get_irq(dwc3_pdev, 0);
2879 if (irq != -EPROBE_DEFER) {
2881 "missing peripheral IRQ\n");
2890 dwc->irq_gadget = irq;
2892 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2893 &dwc->ctrl_req_addr, GFP_KERNEL);
2894 if (!dwc->ctrl_req) {
2895 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2900 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2901 &dwc->ep0_trb_addr, GFP_KERNEL);
2902 if (!dwc->ep0_trb) {
2903 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2908 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2909 if (!dwc->setup_buf) {
2914 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2915 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2917 if (!dwc->ep0_bounce) {
2918 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2923 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2924 if (!dwc->zlp_buf) {
2929 dwc->gadget.ops = &dwc3_gadget_ops;
2930 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2931 dwc->gadget.sg_supported = true;
2932 dwc->gadget.name = "dwc3-gadget";
2933 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2936 * FIXME We might be setting max_speed to <SUPER, however versions
2937 * <2.20a of dwc3 have an issue with metastability (documented
2938 * elsewhere in this driver) which tells us we can't set max speed to
2939 * anything lower than SUPER.
2941 * Because gadget.max_speed is only used by composite.c and function
2942 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2943 * to happen so we avoid sending SuperSpeed Capability descriptor
2944 * together with our BOS descriptor as that could confuse host into
2945 * thinking we can handle super speed.
2947 * Note that, in fact, we won't even support GetBOS requests when speed
2948 * is less than super speed because we don't have means, yet, to tell
2949 * composite.c that we are USB 2.0 + LPM ECN.
2951 if (dwc->revision < DWC3_REVISION_220A)
2952 dwc3_trace(trace_dwc3_gadget,
2953 "Changing max_speed on rev %08x",
2956 dwc->gadget.max_speed = dwc->maximum_speed;
2959 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2962 dwc->gadget.quirk_ep_out_aligned_size = true;
2965 * REVISIT: Here we should clear all pending IRQs to be
2966 * sure we're starting from a well known location.
2969 ret = dwc3_gadget_init_endpoints(dwc);
2973 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2975 dev_err(dwc->dev, "failed to register udc\n");
2982 kfree(dwc->zlp_buf);
2985 dwc3_gadget_free_endpoints(dwc);
2986 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2987 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2990 kfree(dwc->setup_buf);
2993 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2994 dwc->ep0_trb, dwc->ep0_trb_addr);
2997 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2998 dwc->ctrl_req, dwc->ctrl_req_addr);
3004 /* -------------------------------------------------------------------------- */
3006 void dwc3_gadget_exit(struct dwc3 *dwc)
3008 usb_del_gadget_udc(&dwc->gadget);
3010 dwc3_gadget_free_endpoints(dwc);
3012 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3013 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3015 kfree(dwc->setup_buf);
3016 kfree(dwc->zlp_buf);
3018 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
3019 dwc->ep0_trb, dwc->ep0_trb_addr);
3021 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3022 dwc->ctrl_req, dwc->ctrl_req_addr);
3025 int dwc3_gadget_suspend(struct dwc3 *dwc)
3029 if (!dwc->gadget_driver)
3032 ret = dwc3_gadget_run_stop(dwc, false, false);
3036 dwc3_disconnect_gadget(dwc);
3037 __dwc3_gadget_stop(dwc);
3042 int dwc3_gadget_resume(struct dwc3 *dwc)
3046 if (!dwc->gadget_driver)
3049 ret = __dwc3_gadget_start(dwc);
3053 ret = dwc3_gadget_run_stop(dwc, true, false);
3060 __dwc3_gadget_stop(dwc);
3066 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3068 if (dwc->pending_events) {
3069 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3070 dwc->pending_events = false;
3071 enable_irq(dwc->irq_gadget);