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 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
151 struct dwc3 *dwc = dep->dwc;
159 * Skip LINK TRB. We can't use req->trb and check for
160 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
161 * just completed (not the LINK TRB).
163 if (((dep->busy_slot & DWC3_TRB_MASK) ==
165 usb_endpoint_xfer_isoc(dep->endpoint.desc))
167 } while(++i < req->request.num_mapped_sgs);
168 req->started = false;
170 list_del(&req->list);
173 if (req->request.status == -EINPROGRESS)
174 req->request.status = status;
176 if (dwc->ep0_bounced && dep->number == 0)
177 dwc->ep0_bounced = false;
179 usb_gadget_unmap_request(&dwc->gadget, &req->request,
182 trace_dwc3_gadget_giveback(req);
184 spin_unlock(&dwc->lock);
185 usb_gadget_giveback_request(&dep->endpoint, &req->request);
186 spin_lock(&dwc->lock);
189 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
194 trace_dwc3_gadget_generic_cmd(cmd, param);
196 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
197 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
200 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
201 if (!(reg & DWC3_DGCMD_CMDACT)) {
202 dwc3_trace(trace_dwc3_gadget,
203 "Command Complete --> %d",
204 DWC3_DGCMD_STATUS(reg));
205 if (DWC3_DGCMD_STATUS(reg))
211 * We can't sleep here, because it's also called from
216 dwc3_trace(trace_dwc3_gadget,
217 "Command Timed Out");
224 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
225 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
227 struct dwc3_ep *dep = dwc->eps[ep];
232 trace_dwc3_gadget_ep_cmd(dep, cmd, params);
234 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
235 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
236 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
238 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
240 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
241 if (!(reg & DWC3_DEPCMD_CMDACT)) {
242 dwc3_trace(trace_dwc3_gadget,
243 "Command Complete --> %d",
244 DWC3_DEPCMD_STATUS(reg));
245 if (DWC3_DEPCMD_STATUS(reg))
252 * We can't sleep here, because it is also called from
257 dwc3_trace(trace_dwc3_gadget,
258 "Command Timed Out");
269 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
270 struct dwc3_trb *trb)
272 u32 offset = (char *) trb - (char *) dep->trb_pool;
274 return dep->trb_pool_dma + offset;
277 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
279 struct dwc3 *dwc = dep->dwc;
284 dep->trb_pool = dma_alloc_coherent(dwc->dev,
285 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
286 &dep->trb_pool_dma, GFP_KERNEL);
287 if (!dep->trb_pool) {
288 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
296 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
298 struct dwc3 *dwc = dep->dwc;
300 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
301 dep->trb_pool, dep->trb_pool_dma);
303 dep->trb_pool = NULL;
304 dep->trb_pool_dma = 0;
307 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
310 * dwc3_gadget_start_config - Configure EP resources
311 * @dwc: pointer to our controller context structure
312 * @dep: endpoint that is being enabled
314 * The assignment of transfer resources cannot perfectly follow the
315 * data book due to the fact that the controller driver does not have
316 * all knowledge of the configuration in advance. It is given this
317 * information piecemeal by the composite gadget framework after every
318 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
319 * programming model in this scenario can cause errors. For two
322 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
323 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
324 * multiple interfaces.
326 * 2) The databook does not mention doing more DEPXFERCFG for new
327 * endpoint on alt setting (8.1.6).
329 * The following simplified method is used instead:
331 * All hardware endpoints can be assigned a transfer resource and this
332 * setting will stay persistent until either a core reset or
333 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
334 * do DEPXFERCFG for every hardware endpoint as well. We are
335 * guaranteed that there are as many transfer resources as endpoints.
337 * This function is called for each endpoint when it is being enabled
338 * but is triggered only when called for EP0-out, which always happens
339 * first, and which should only happen in one of the above conditions.
341 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
343 struct dwc3_gadget_ep_cmd_params params;
351 memset(¶ms, 0x00, sizeof(params));
352 cmd = DWC3_DEPCMD_DEPSTARTCFG;
354 ret = dwc3_send_gadget_ep_cmd(dwc, 0, cmd, ¶ms);
358 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
359 struct dwc3_ep *dep = dwc->eps[i];
364 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
372 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
373 const struct usb_endpoint_descriptor *desc,
374 const struct usb_ss_ep_comp_descriptor *comp_desc,
375 bool ignore, bool restore)
377 struct dwc3_gadget_ep_cmd_params params;
379 memset(¶ms, 0x00, sizeof(params));
381 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
382 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
384 /* Burst size is only needed in SuperSpeed mode */
385 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
386 u32 burst = dep->endpoint.maxburst - 1;
388 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst);
392 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
395 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
396 params.param2 |= dep->saved_state;
399 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
400 | DWC3_DEPCFG_XFER_NOT_READY_EN;
402 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
403 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
404 | DWC3_DEPCFG_STREAM_EVENT_EN;
405 dep->stream_capable = true;
408 if (!usb_endpoint_xfer_control(desc))
409 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
412 * We are doing 1:1 mapping for endpoints, meaning
413 * Physical Endpoints 2 maps to Logical Endpoint 2 and
414 * so on. We consider the direction bit as part of the physical
415 * endpoint number. So USB endpoint 0x81 is 0x03.
417 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
420 * We must use the lower 16 TX FIFOs even though
424 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
426 if (desc->bInterval) {
427 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
428 dep->interval = 1 << (desc->bInterval - 1);
431 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
432 DWC3_DEPCMD_SETEPCONFIG, ¶ms);
435 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
437 struct dwc3_gadget_ep_cmd_params params;
439 memset(¶ms, 0x00, sizeof(params));
441 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
443 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
444 DWC3_DEPCMD_SETTRANSFRESOURCE, ¶ms);
448 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
449 * @dep: endpoint to be initialized
450 * @desc: USB Endpoint Descriptor
452 * Caller should take care of locking
454 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
455 const struct usb_endpoint_descriptor *desc,
456 const struct usb_ss_ep_comp_descriptor *comp_desc,
457 bool ignore, bool restore)
459 struct dwc3 *dwc = dep->dwc;
463 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
465 if (!(dep->flags & DWC3_EP_ENABLED)) {
466 ret = dwc3_gadget_start_config(dwc, dep);
471 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
476 if (!(dep->flags & DWC3_EP_ENABLED)) {
477 struct dwc3_trb *trb_st_hw;
478 struct dwc3_trb *trb_link;
480 dep->endpoint.desc = desc;
481 dep->comp_desc = comp_desc;
482 dep->type = usb_endpoint_type(desc);
483 dep->flags |= DWC3_EP_ENABLED;
485 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
486 reg |= DWC3_DALEPENA_EP(dep->number);
487 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
489 if (!usb_endpoint_xfer_isoc(desc))
492 /* Link TRB for ISOC. The HWO bit is never reset */
493 trb_st_hw = &dep->trb_pool[0];
495 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
496 memset(trb_link, 0, sizeof(*trb_link));
498 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
499 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
500 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
501 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
505 switch (usb_endpoint_type(desc)) {
506 case USB_ENDPOINT_XFER_CONTROL:
507 /* don't change name */
509 case USB_ENDPOINT_XFER_ISOC:
510 strlcat(dep->name, "-isoc", sizeof(dep->name));
512 case USB_ENDPOINT_XFER_BULK:
513 strlcat(dep->name, "-bulk", sizeof(dep->name));
515 case USB_ENDPOINT_XFER_INT:
516 strlcat(dep->name, "-int", sizeof(dep->name));
519 dev_err(dwc->dev, "invalid endpoint transfer type\n");
525 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
526 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
528 struct dwc3_request *req;
530 if (!list_empty(&dep->started_list)) {
531 dwc3_stop_active_transfer(dwc, dep->number, true);
533 /* - giveback all requests to gadget driver */
534 while (!list_empty(&dep->started_list)) {
535 req = next_request(&dep->started_list);
537 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
541 while (!list_empty(&dep->pending_list)) {
542 req = next_request(&dep->pending_list);
544 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
549 * __dwc3_gadget_ep_disable - Disables a HW endpoint
550 * @dep: the endpoint to disable
552 * This function also removes requests which are currently processed ny the
553 * hardware and those which are not yet scheduled.
554 * Caller should take care of locking.
556 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
558 struct dwc3 *dwc = dep->dwc;
561 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
563 dwc3_remove_requests(dwc, dep);
565 /* make sure HW endpoint isn't stalled */
566 if (dep->flags & DWC3_EP_STALL)
567 __dwc3_gadget_ep_set_halt(dep, 0, false);
569 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
570 reg &= ~DWC3_DALEPENA_EP(dep->number);
571 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
573 dep->stream_capable = false;
574 dep->endpoint.desc = NULL;
575 dep->comp_desc = NULL;
579 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
581 (dep->number & 1) ? "in" : "out");
586 /* -------------------------------------------------------------------------- */
588 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
589 const struct usb_endpoint_descriptor *desc)
594 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
599 /* -------------------------------------------------------------------------- */
601 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
602 const struct usb_endpoint_descriptor *desc)
609 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
610 pr_debug("dwc3: invalid parameters\n");
614 if (!desc->wMaxPacketSize) {
615 pr_debug("dwc3: missing wMaxPacketSize\n");
619 dep = to_dwc3_ep(ep);
622 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
623 "%s is already enabled\n",
627 spin_lock_irqsave(&dwc->lock, flags);
628 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
629 spin_unlock_irqrestore(&dwc->lock, flags);
634 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
642 pr_debug("dwc3: invalid parameters\n");
646 dep = to_dwc3_ep(ep);
649 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
650 "%s is already disabled\n",
654 spin_lock_irqsave(&dwc->lock, flags);
655 ret = __dwc3_gadget_ep_disable(dep);
656 spin_unlock_irqrestore(&dwc->lock, flags);
661 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
664 struct dwc3_request *req;
665 struct dwc3_ep *dep = to_dwc3_ep(ep);
667 req = kzalloc(sizeof(*req), gfp_flags);
671 req->epnum = dep->number;
674 trace_dwc3_alloc_request(req);
676 return &req->request;
679 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
680 struct usb_request *request)
682 struct dwc3_request *req = to_dwc3_request(request);
684 trace_dwc3_free_request(req);
689 * dwc3_prepare_one_trb - setup one TRB from one request
690 * @dep: endpoint for which this request is prepared
691 * @req: dwc3_request pointer
693 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
694 struct dwc3_request *req, dma_addr_t dma,
695 unsigned length, unsigned last, unsigned chain, unsigned node)
697 struct dwc3_trb *trb;
699 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
700 dep->name, req, (unsigned long long) dma,
701 length, last ? " last" : "",
702 chain ? " chain" : "");
705 trb = &dep->trb_pool[dep->free_slot & DWC3_TRB_MASK];
708 dwc3_gadget_move_started_request(req);
710 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
711 req->start_slot = dep->free_slot & DWC3_TRB_MASK;
715 /* Skip the LINK-TRB on ISOC */
716 if (((dep->free_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
717 usb_endpoint_xfer_isoc(dep->endpoint.desc))
720 trb->size = DWC3_TRB_SIZE_LENGTH(length);
721 trb->bpl = lower_32_bits(dma);
722 trb->bph = upper_32_bits(dma);
724 switch (usb_endpoint_type(dep->endpoint.desc)) {
725 case USB_ENDPOINT_XFER_CONTROL:
726 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
729 case USB_ENDPOINT_XFER_ISOC:
731 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
733 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
735 /* always enable Interrupt on Missed ISOC */
736 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
739 case USB_ENDPOINT_XFER_BULK:
740 case USB_ENDPOINT_XFER_INT:
741 trb->ctrl = DWC3_TRBCTL_NORMAL;
745 * This is only possible with faulty memory because we
746 * checked it already :)
751 /* always enable Continue on Short Packet */
752 trb->ctrl |= DWC3_TRB_CTRL_CSP;
754 if (!req->request.no_interrupt)
755 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
758 trb->ctrl |= DWC3_TRB_CTRL_LST;
761 trb->ctrl |= DWC3_TRB_CTRL_CHN;
763 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
764 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
766 trb->ctrl |= DWC3_TRB_CTRL_HWO;
768 trace_dwc3_prepare_trb(dep, trb);
772 * dwc3_prepare_trbs - setup TRBs from requests
773 * @dep: endpoint for which requests are being prepared
774 * @starting: true if the endpoint is idle and no requests are queued.
776 * The function goes through the requests list and sets up TRBs for the
777 * transfers. The function returns once there are no more TRBs available or
778 * it runs out of requests.
780 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
782 struct dwc3_request *req, *n;
785 unsigned int last_one = 0;
787 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
789 /* the first request must not be queued */
790 trbs_left = (dep->busy_slot - dep->free_slot) & DWC3_TRB_MASK;
792 /* Can't wrap around on a non-isoc EP since there's no link TRB */
793 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
794 max = DWC3_TRB_NUM - (dep->free_slot & DWC3_TRB_MASK);
800 * If busy & slot are equal than it is either full or empty. If we are
801 * starting to process requests then we are empty. Otherwise we are
802 * full and don't do anything
807 trbs_left = DWC3_TRB_NUM;
809 * In case we start from scratch, we queue the ISOC requests
810 * starting from slot 1. This is done because we use ring
811 * buffer and have no LST bit to stop us. Instead, we place
812 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
813 * after the first request so we start at slot 1 and have
814 * 7 requests proceed before we hit the first IOC.
815 * Other transfer types don't use the ring buffer and are
816 * processed from the first TRB until the last one. Since we
817 * don't wrap around we have to start at the beginning.
819 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
828 /* The last TRB is a link TRB, not used for xfer */
829 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->endpoint.desc))
832 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
837 if (req->request.num_mapped_sgs > 0) {
838 struct usb_request *request = &req->request;
839 struct scatterlist *sg = request->sg;
840 struct scatterlist *s;
843 for_each_sg(sg, s, request->num_mapped_sgs, i) {
844 unsigned chain = true;
846 length = sg_dma_len(s);
847 dma = sg_dma_address(s);
849 if (i == (request->num_mapped_sgs - 1) ||
851 if (list_empty(&dep->pending_list))
863 dwc3_prepare_one_trb(dep, req, dma, length,
873 dma = req->request.dma;
874 length = req->request.length;
880 /* Is this the last request? */
881 if (list_is_last(&req->list, &dep->pending_list))
884 dwc3_prepare_one_trb(dep, req, dma, length,
893 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
896 struct dwc3_gadget_ep_cmd_params params;
897 struct dwc3_request *req;
898 struct dwc3 *dwc = dep->dwc;
902 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
903 dwc3_trace(trace_dwc3_gadget, "%s: endpoint busy", dep->name);
908 * If we are getting here after a short-out-packet we don't enqueue any
909 * new requests as we try to set the IOC bit only on the last request.
912 if (list_empty(&dep->started_list))
913 dwc3_prepare_trbs(dep, start_new);
915 /* req points to the first request which will be sent */
916 req = next_request(&dep->started_list);
918 dwc3_prepare_trbs(dep, start_new);
921 * req points to the first request where HWO changed from 0 to 1
923 req = next_request(&dep->started_list);
926 dep->flags |= DWC3_EP_PENDING_REQUEST;
930 memset(¶ms, 0, sizeof(params));
933 params.param0 = upper_32_bits(req->trb_dma);
934 params.param1 = lower_32_bits(req->trb_dma);
935 cmd = DWC3_DEPCMD_STARTTRANSFER;
937 cmd = DWC3_DEPCMD_UPDATETRANSFER;
940 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
941 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
944 * FIXME we need to iterate over the list of requests
945 * here and stop, unmap, free and del each of the linked
946 * requests instead of what we do now.
948 usb_gadget_unmap_request(&dwc->gadget, &req->request,
950 list_del(&req->list);
954 dep->flags |= DWC3_EP_BUSY;
957 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
959 WARN_ON_ONCE(!dep->resource_index);
965 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
966 struct dwc3_ep *dep, u32 cur_uf)
970 if (list_empty(&dep->pending_list)) {
971 dwc3_trace(trace_dwc3_gadget,
972 "ISOC ep %s run out for requests",
974 dep->flags |= DWC3_EP_PENDING_REQUEST;
978 /* 4 micro frames in the future */
979 uf = cur_uf + dep->interval * 4;
981 __dwc3_gadget_kick_transfer(dep, uf, 1);
984 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
985 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
989 mask = ~(dep->interval - 1);
990 cur_uf = event->parameters & mask;
992 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
995 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
997 struct dwc3 *dwc = dep->dwc;
1000 if (!dep->endpoint.desc) {
1001 dwc3_trace(trace_dwc3_gadget,
1002 "trying to queue request %p to disabled %s\n",
1003 &req->request, dep->endpoint.name);
1007 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1008 &req->request, req->dep->name)) {
1009 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1010 &req->request, req->dep->name);
1014 req->request.actual = 0;
1015 req->request.status = -EINPROGRESS;
1016 req->direction = dep->direction;
1017 req->epnum = dep->number;
1019 trace_dwc3_ep_queue(req);
1022 * We only add to our list of requests now and
1023 * start consuming the list once we get XferNotReady
1026 * That way, we avoid doing anything that we don't need
1027 * to do now and defer it until the point we receive a
1028 * particular token from the Host side.
1030 * This will also avoid Host cancelling URBs due to too
1033 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1038 list_add_tail(&req->list, &dep->pending_list);
1041 * If there are no pending requests and the endpoint isn't already
1042 * busy, we will just start the request straight away.
1044 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1045 * little bit faster.
1047 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1048 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1049 !(dep->flags & DWC3_EP_BUSY)) {
1050 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1055 * There are a few special cases:
1057 * 1. XferNotReady with empty list of requests. We need to kick the
1058 * transfer here in that situation, otherwise we will be NAKing
1059 * forever. If we get XferNotReady before gadget driver has a
1060 * chance to queue a request, we will ACK the IRQ but won't be
1061 * able to receive the data until the next request is queued.
1062 * The following code is handling exactly that.
1065 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1067 * If xfernotready is already elapsed and it is a case
1068 * of isoc transfer, then issue END TRANSFER, so that
1069 * you can receive xfernotready again and can have
1070 * notion of current microframe.
1072 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1073 if (list_empty(&dep->started_list)) {
1074 dwc3_stop_active_transfer(dwc, dep->number, true);
1075 dep->flags = DWC3_EP_ENABLED;
1080 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1082 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1088 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1089 * kick the transfer here after queuing a request, otherwise the
1090 * core may not see the modified TRB(s).
1092 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1093 (dep->flags & DWC3_EP_BUSY) &&
1094 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1095 WARN_ON_ONCE(!dep->resource_index);
1096 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index,
1102 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1103 * right away, otherwise host will not know we have streams to be
1106 if (dep->stream_capable)
1107 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1110 if (ret && ret != -EBUSY)
1111 dwc3_trace(trace_dwc3_gadget,
1112 "%s: failed to kick transfers\n",
1120 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1121 struct usb_request *request)
1123 dwc3_gadget_ep_free_request(ep, request);
1126 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1128 struct dwc3_request *req;
1129 struct usb_request *request;
1130 struct usb_ep *ep = &dep->endpoint;
1132 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1133 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1137 request->length = 0;
1138 request->buf = dwc->zlp_buf;
1139 request->complete = __dwc3_gadget_ep_zlp_complete;
1141 req = to_dwc3_request(request);
1143 return __dwc3_gadget_ep_queue(dep, req);
1146 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1149 struct dwc3_request *req = to_dwc3_request(request);
1150 struct dwc3_ep *dep = to_dwc3_ep(ep);
1151 struct dwc3 *dwc = dep->dwc;
1153 unsigned long flags;
1157 spin_lock_irqsave(&dwc->lock, flags);
1158 ret = __dwc3_gadget_ep_queue(dep, req);
1161 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1162 * setting request->zero, instead of doing magic, we will just queue an
1163 * extra usb_request ourselves so that it gets handled the same way as
1164 * any other request.
1166 if (ret == 0 && request->zero && request->length &&
1167 (request->length % ep->maxpacket == 0))
1168 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1170 spin_unlock_irqrestore(&dwc->lock, flags);
1175 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1176 struct usb_request *request)
1178 struct dwc3_request *req = to_dwc3_request(request);
1179 struct dwc3_request *r = NULL;
1181 struct dwc3_ep *dep = to_dwc3_ep(ep);
1182 struct dwc3 *dwc = dep->dwc;
1184 unsigned long flags;
1187 trace_dwc3_ep_dequeue(req);
1189 spin_lock_irqsave(&dwc->lock, flags);
1191 list_for_each_entry(r, &dep->pending_list, list) {
1197 list_for_each_entry(r, &dep->started_list, list) {
1202 /* wait until it is processed */
1203 dwc3_stop_active_transfer(dwc, dep->number, true);
1206 dev_err(dwc->dev, "request %p was not queued to %s\n",
1213 /* giveback the request */
1214 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1217 spin_unlock_irqrestore(&dwc->lock, flags);
1222 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1224 struct dwc3_gadget_ep_cmd_params params;
1225 struct dwc3 *dwc = dep->dwc;
1228 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1229 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1233 memset(¶ms, 0x00, sizeof(params));
1236 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1237 (!list_empty(&dep->started_list) ||
1238 !list_empty(&dep->pending_list)))) {
1239 dwc3_trace(trace_dwc3_gadget,
1240 "%s: pending request, cannot halt\n",
1245 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1246 DWC3_DEPCMD_SETSTALL, ¶ms);
1248 dev_err(dwc->dev, "failed to set STALL on %s\n",
1251 dep->flags |= DWC3_EP_STALL;
1253 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1254 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1256 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1259 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1265 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1267 struct dwc3_ep *dep = to_dwc3_ep(ep);
1268 struct dwc3 *dwc = dep->dwc;
1270 unsigned long flags;
1274 spin_lock_irqsave(&dwc->lock, flags);
1275 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1276 spin_unlock_irqrestore(&dwc->lock, flags);
1281 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1283 struct dwc3_ep *dep = to_dwc3_ep(ep);
1284 struct dwc3 *dwc = dep->dwc;
1285 unsigned long flags;
1288 spin_lock_irqsave(&dwc->lock, flags);
1289 dep->flags |= DWC3_EP_WEDGE;
1291 if (dep->number == 0 || dep->number == 1)
1292 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1294 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1295 spin_unlock_irqrestore(&dwc->lock, flags);
1300 /* -------------------------------------------------------------------------- */
1302 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1303 .bLength = USB_DT_ENDPOINT_SIZE,
1304 .bDescriptorType = USB_DT_ENDPOINT,
1305 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1308 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1309 .enable = dwc3_gadget_ep0_enable,
1310 .disable = dwc3_gadget_ep0_disable,
1311 .alloc_request = dwc3_gadget_ep_alloc_request,
1312 .free_request = dwc3_gadget_ep_free_request,
1313 .queue = dwc3_gadget_ep0_queue,
1314 .dequeue = dwc3_gadget_ep_dequeue,
1315 .set_halt = dwc3_gadget_ep0_set_halt,
1316 .set_wedge = dwc3_gadget_ep_set_wedge,
1319 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1320 .enable = dwc3_gadget_ep_enable,
1321 .disable = dwc3_gadget_ep_disable,
1322 .alloc_request = dwc3_gadget_ep_alloc_request,
1323 .free_request = dwc3_gadget_ep_free_request,
1324 .queue = dwc3_gadget_ep_queue,
1325 .dequeue = dwc3_gadget_ep_dequeue,
1326 .set_halt = dwc3_gadget_ep_set_halt,
1327 .set_wedge = dwc3_gadget_ep_set_wedge,
1330 /* -------------------------------------------------------------------------- */
1332 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1334 struct dwc3 *dwc = gadget_to_dwc(g);
1337 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1338 return DWC3_DSTS_SOFFN(reg);
1341 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1343 struct dwc3 *dwc = gadget_to_dwc(g);
1345 unsigned long timeout;
1346 unsigned long flags;
1355 spin_lock_irqsave(&dwc->lock, flags);
1358 * According to the Databook Remote wakeup request should
1359 * be issued only when the device is in early suspend state.
1361 * We can check that via USB Link State bits in DSTS register.
1363 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1365 speed = reg & DWC3_DSTS_CONNECTSPD;
1366 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1367 (speed == DWC3_DSTS_SUPERSPEED_PLUS)) {
1368 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1373 link_state = DWC3_DSTS_USBLNKST(reg);
1375 switch (link_state) {
1376 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1377 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1380 dwc3_trace(trace_dwc3_gadget,
1381 "can't wakeup from '%s'\n",
1382 dwc3_gadget_link_string(link_state));
1387 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1389 dev_err(dwc->dev, "failed to put link in Recovery\n");
1393 /* Recent versions do this automatically */
1394 if (dwc->revision < DWC3_REVISION_194A) {
1395 /* write zeroes to Link Change Request */
1396 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1397 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1398 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1401 /* poll until Link State changes to ON */
1402 timeout = jiffies + msecs_to_jiffies(100);
1404 while (!time_after(jiffies, timeout)) {
1405 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1407 /* in HS, means ON */
1408 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1412 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1413 dev_err(dwc->dev, "failed to send remote wakeup\n");
1418 spin_unlock_irqrestore(&dwc->lock, flags);
1423 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1426 struct dwc3 *dwc = gadget_to_dwc(g);
1427 unsigned long flags;
1429 spin_lock_irqsave(&dwc->lock, flags);
1430 g->is_selfpowered = !!is_selfpowered;
1431 spin_unlock_irqrestore(&dwc->lock, flags);
1436 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1441 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1443 if (dwc->revision <= DWC3_REVISION_187A) {
1444 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1445 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1448 if (dwc->revision >= DWC3_REVISION_194A)
1449 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1450 reg |= DWC3_DCTL_RUN_STOP;
1452 if (dwc->has_hibernation)
1453 reg |= DWC3_DCTL_KEEP_CONNECT;
1455 dwc->pullups_connected = true;
1457 reg &= ~DWC3_DCTL_RUN_STOP;
1459 if (dwc->has_hibernation && !suspend)
1460 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1462 dwc->pullups_connected = false;
1465 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1468 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1470 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1473 if (reg & DWC3_DSTS_DEVCTRLHLT)
1482 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1484 ? dwc->gadget_driver->function : "no-function",
1485 is_on ? "connect" : "disconnect");
1490 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1492 struct dwc3 *dwc = gadget_to_dwc(g);
1493 unsigned long flags;
1498 spin_lock_irqsave(&dwc->lock, flags);
1499 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1500 spin_unlock_irqrestore(&dwc->lock, flags);
1505 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1509 /* Enable all but Start and End of Frame IRQs */
1510 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1511 DWC3_DEVTEN_EVNTOVERFLOWEN |
1512 DWC3_DEVTEN_CMDCMPLTEN |
1513 DWC3_DEVTEN_ERRTICERREN |
1514 DWC3_DEVTEN_WKUPEVTEN |
1515 DWC3_DEVTEN_ULSTCNGEN |
1516 DWC3_DEVTEN_CONNECTDONEEN |
1517 DWC3_DEVTEN_USBRSTEN |
1518 DWC3_DEVTEN_DISCONNEVTEN);
1520 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1523 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1525 /* mask all interrupts */
1526 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1529 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1530 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1532 static int dwc3_gadget_start(struct usb_gadget *g,
1533 struct usb_gadget_driver *driver)
1535 struct dwc3 *dwc = gadget_to_dwc(g);
1536 struct dwc3_ep *dep;
1537 unsigned long flags;
1542 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1543 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1544 IRQF_SHARED, "dwc3", dwc->ev_buf);
1546 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1551 spin_lock_irqsave(&dwc->lock, flags);
1553 if (dwc->gadget_driver) {
1554 dev_err(dwc->dev, "%s is already bound to %s\n",
1556 dwc->gadget_driver->driver.name);
1561 dwc->gadget_driver = driver;
1563 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1564 reg &= ~(DWC3_DCFG_SPEED_MASK);
1567 * WORKAROUND: DWC3 revision < 2.20a have an issue
1568 * which would cause metastability state on Run/Stop
1569 * bit if we try to force the IP to USB2-only mode.
1571 * Because of that, we cannot configure the IP to any
1572 * speed other than the SuperSpeed
1576 * STAR#9000525659: Clock Domain Crossing on DCTL in
1579 if (dwc->revision < DWC3_REVISION_220A) {
1580 reg |= DWC3_DCFG_SUPERSPEED;
1582 switch (dwc->maximum_speed) {
1584 reg |= DWC3_DSTS_LOWSPEED;
1586 case USB_SPEED_FULL:
1587 reg |= DWC3_DSTS_FULLSPEED1;
1589 case USB_SPEED_HIGH:
1590 reg |= DWC3_DSTS_HIGHSPEED;
1592 case USB_SPEED_SUPER_PLUS:
1593 reg |= DWC3_DSTS_SUPERSPEED_PLUS;
1596 dev_err(dwc->dev, "invalid dwc->maximum_speed (%d)\n",
1597 dwc->maximum_speed);
1599 case USB_SPEED_SUPER:
1600 reg |= DWC3_DCFG_SUPERSPEED;
1604 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1606 /* Start with SuperSpeed Default */
1607 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1610 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1613 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1618 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1621 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1625 /* begin to receive SETUP packets */
1626 dwc->ep0state = EP0_SETUP_PHASE;
1627 dwc3_ep0_out_start(dwc);
1629 dwc3_gadget_enable_irq(dwc);
1631 spin_unlock_irqrestore(&dwc->lock, flags);
1636 __dwc3_gadget_ep_disable(dwc->eps[0]);
1639 dwc->gadget_driver = NULL;
1642 spin_unlock_irqrestore(&dwc->lock, flags);
1644 free_irq(irq, dwc->ev_buf);
1650 static int dwc3_gadget_stop(struct usb_gadget *g)
1652 struct dwc3 *dwc = gadget_to_dwc(g);
1653 unsigned long flags;
1656 spin_lock_irqsave(&dwc->lock, flags);
1658 dwc3_gadget_disable_irq(dwc);
1659 __dwc3_gadget_ep_disable(dwc->eps[0]);
1660 __dwc3_gadget_ep_disable(dwc->eps[1]);
1662 dwc->gadget_driver = NULL;
1664 spin_unlock_irqrestore(&dwc->lock, flags);
1666 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1667 free_irq(irq, dwc->ev_buf);
1672 static const struct usb_gadget_ops dwc3_gadget_ops = {
1673 .get_frame = dwc3_gadget_get_frame,
1674 .wakeup = dwc3_gadget_wakeup,
1675 .set_selfpowered = dwc3_gadget_set_selfpowered,
1676 .pullup = dwc3_gadget_pullup,
1677 .udc_start = dwc3_gadget_start,
1678 .udc_stop = dwc3_gadget_stop,
1681 /* -------------------------------------------------------------------------- */
1683 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1684 u8 num, u32 direction)
1686 struct dwc3_ep *dep;
1689 for (i = 0; i < num; i++) {
1690 u8 epnum = (i << 1) | (!!direction);
1692 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1697 dep->number = epnum;
1698 dep->direction = !!direction;
1699 dwc->eps[epnum] = dep;
1701 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1702 (epnum & 1) ? "in" : "out");
1704 dep->endpoint.name = dep->name;
1706 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1708 if (epnum == 0 || epnum == 1) {
1709 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1710 dep->endpoint.maxburst = 1;
1711 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1713 dwc->gadget.ep0 = &dep->endpoint;
1717 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1718 dep->endpoint.max_streams = 15;
1719 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1720 list_add_tail(&dep->endpoint.ep_list,
1721 &dwc->gadget.ep_list);
1723 ret = dwc3_alloc_trb_pool(dep);
1728 if (epnum == 0 || epnum == 1) {
1729 dep->endpoint.caps.type_control = true;
1731 dep->endpoint.caps.type_iso = true;
1732 dep->endpoint.caps.type_bulk = true;
1733 dep->endpoint.caps.type_int = true;
1736 dep->endpoint.caps.dir_in = !!direction;
1737 dep->endpoint.caps.dir_out = !direction;
1739 INIT_LIST_HEAD(&dep->pending_list);
1740 INIT_LIST_HEAD(&dep->started_list);
1746 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1750 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1752 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1754 dwc3_trace(trace_dwc3_gadget,
1755 "failed to allocate OUT endpoints");
1759 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1761 dwc3_trace(trace_dwc3_gadget,
1762 "failed to allocate IN endpoints");
1769 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1771 struct dwc3_ep *dep;
1774 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1775 dep = dwc->eps[epnum];
1779 * Physical endpoints 0 and 1 are special; they form the
1780 * bi-directional USB endpoint 0.
1782 * For those two physical endpoints, we don't allocate a TRB
1783 * pool nor do we add them the endpoints list. Due to that, we
1784 * shouldn't do these two operations otherwise we would end up
1785 * with all sorts of bugs when removing dwc3.ko.
1787 if (epnum != 0 && epnum != 1) {
1788 dwc3_free_trb_pool(dep);
1789 list_del(&dep->endpoint.ep_list);
1796 /* -------------------------------------------------------------------------- */
1798 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1799 struct dwc3_request *req, struct dwc3_trb *trb,
1800 const struct dwc3_event_depevt *event, int status)
1803 unsigned int s_pkt = 0;
1804 unsigned int trb_status;
1806 trace_dwc3_complete_trb(dep, trb);
1808 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1810 * We continue despite the error. There is not much we
1811 * can do. If we don't clean it up we loop forever. If
1812 * we skip the TRB then it gets overwritten after a
1813 * while since we use them in a ring buffer. A BUG()
1814 * would help. Lets hope that if this occurs, someone
1815 * fixes the root cause instead of looking away :)
1817 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1819 count = trb->size & DWC3_TRB_SIZE_MASK;
1821 if (dep->direction) {
1823 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1824 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1825 dwc3_trace(trace_dwc3_gadget,
1826 "%s: incomplete IN transfer\n",
1829 * If missed isoc occurred and there is
1830 * no request queued then issue END
1831 * TRANSFER, so that core generates
1832 * next xfernotready and we will issue
1833 * a fresh START TRANSFER.
1834 * If there are still queued request
1835 * then wait, do not issue either END
1836 * or UPDATE TRANSFER, just attach next
1837 * request in pending_list during
1838 * giveback.If any future queued request
1839 * is successfully transferred then we
1840 * will issue UPDATE TRANSFER for all
1841 * request in the pending_list.
1843 dep->flags |= DWC3_EP_MISSED_ISOC;
1845 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1847 status = -ECONNRESET;
1850 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1853 if (count && (event->status & DEPEVT_STATUS_SHORT))
1858 * We assume here we will always receive the entire data block
1859 * which we should receive. Meaning, if we program RX to
1860 * receive 4K but we receive only 2K, we assume that's all we
1861 * should receive and we simply bounce the request back to the
1862 * gadget driver for further processing.
1864 req->request.actual += req->request.length - count;
1867 if ((event->status & DEPEVT_STATUS_LST) &&
1868 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1869 DWC3_TRB_CTRL_HWO)))
1871 if ((event->status & DEPEVT_STATUS_IOC) &&
1872 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1877 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1878 const struct dwc3_event_depevt *event, int status)
1880 struct dwc3_request *req;
1881 struct dwc3_trb *trb;
1887 req = next_request(&dep->started_list);
1888 if (WARN_ON_ONCE(!req))
1893 slot = req->start_slot + i;
1894 if ((slot == DWC3_TRB_NUM - 1) &&
1895 usb_endpoint_xfer_isoc(dep->endpoint.desc))
1897 slot %= DWC3_TRB_NUM;
1898 trb = &dep->trb_pool[slot];
1900 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1904 } while (++i < req->request.num_mapped_sgs);
1906 dwc3_gadget_giveback(dep, req, status);
1912 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1913 list_empty(&dep->started_list)) {
1914 if (list_empty(&dep->pending_list)) {
1916 * If there is no entry in request list then do
1917 * not issue END TRANSFER now. Just set PENDING
1918 * flag, so that END TRANSFER is issued when an
1919 * entry is added into request list.
1921 dep->flags = DWC3_EP_PENDING_REQUEST;
1923 dwc3_stop_active_transfer(dwc, dep->number, true);
1924 dep->flags = DWC3_EP_ENABLED;
1932 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
1933 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1935 unsigned status = 0;
1937 u32 is_xfer_complete;
1939 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
1941 if (event->status & DEPEVT_STATUS_BUSERR)
1942 status = -ECONNRESET;
1944 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
1945 if (clean_busy && (is_xfer_complete ||
1946 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
1947 dep->flags &= ~DWC3_EP_BUSY;
1950 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
1951 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
1953 if (dwc->revision < DWC3_REVISION_183A) {
1957 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
1960 if (!(dep->flags & DWC3_EP_ENABLED))
1963 if (!list_empty(&dep->started_list))
1967 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1969 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1974 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1977 ret = __dwc3_gadget_kick_transfer(dep, 0, is_xfer_complete);
1978 if (!ret || ret == -EBUSY)
1983 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
1984 const struct dwc3_event_depevt *event)
1986 struct dwc3_ep *dep;
1987 u8 epnum = event->endpoint_number;
1989 dep = dwc->eps[epnum];
1991 if (!(dep->flags & DWC3_EP_ENABLED))
1994 if (epnum == 0 || epnum == 1) {
1995 dwc3_ep0_interrupt(dwc, event);
1999 switch (event->endpoint_event) {
2000 case DWC3_DEPEVT_XFERCOMPLETE:
2001 dep->resource_index = 0;
2003 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2004 dwc3_trace(trace_dwc3_gadget,
2005 "%s is an Isochronous endpoint\n",
2010 dwc3_endpoint_transfer_complete(dwc, dep, event);
2012 case DWC3_DEPEVT_XFERINPROGRESS:
2013 dwc3_endpoint_transfer_complete(dwc, dep, event);
2015 case DWC3_DEPEVT_XFERNOTREADY:
2016 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2017 dwc3_gadget_start_isoc(dwc, dep, event);
2022 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2024 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2025 dep->name, active ? "Transfer Active"
2026 : "Transfer Not Active");
2028 ret = __dwc3_gadget_kick_transfer(dep, 0, !active);
2029 if (!ret || ret == -EBUSY)
2032 dwc3_trace(trace_dwc3_gadget,
2033 "%s: failed to kick transfers\n",
2038 case DWC3_DEPEVT_STREAMEVT:
2039 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2040 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2045 switch (event->status) {
2046 case DEPEVT_STREAMEVT_FOUND:
2047 dwc3_trace(trace_dwc3_gadget,
2048 "Stream %d found and started",
2052 case DEPEVT_STREAMEVT_NOTFOUND:
2055 dwc3_trace(trace_dwc3_gadget,
2056 "unable to find suitable stream\n");
2059 case DWC3_DEPEVT_RXTXFIFOEVT:
2060 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2062 case DWC3_DEPEVT_EPCMDCMPLT:
2063 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2068 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2070 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2071 spin_unlock(&dwc->lock);
2072 dwc->gadget_driver->disconnect(&dwc->gadget);
2073 spin_lock(&dwc->lock);
2077 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2079 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2080 spin_unlock(&dwc->lock);
2081 dwc->gadget_driver->suspend(&dwc->gadget);
2082 spin_lock(&dwc->lock);
2086 static void dwc3_resume_gadget(struct dwc3 *dwc)
2088 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2089 spin_unlock(&dwc->lock);
2090 dwc->gadget_driver->resume(&dwc->gadget);
2091 spin_lock(&dwc->lock);
2095 static void dwc3_reset_gadget(struct dwc3 *dwc)
2097 if (!dwc->gadget_driver)
2100 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2101 spin_unlock(&dwc->lock);
2102 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2103 spin_lock(&dwc->lock);
2107 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2109 struct dwc3_ep *dep;
2110 struct dwc3_gadget_ep_cmd_params params;
2114 dep = dwc->eps[epnum];
2116 if (!dep->resource_index)
2120 * NOTICE: We are violating what the Databook says about the
2121 * EndTransfer command. Ideally we would _always_ wait for the
2122 * EndTransfer Command Completion IRQ, but that's causing too
2123 * much trouble synchronizing between us and gadget driver.
2125 * We have discussed this with the IP Provider and it was
2126 * suggested to giveback all requests here, but give HW some
2127 * extra time to synchronize with the interconnect. We're using
2128 * an arbitrary 100us delay for that.
2130 * Note also that a similar handling was tested by Synopsys
2131 * (thanks a lot Paul) and nothing bad has come out of it.
2132 * In short, what we're doing is:
2134 * - Issue EndTransfer WITH CMDIOC bit set
2138 cmd = DWC3_DEPCMD_ENDTRANSFER;
2139 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2140 cmd |= DWC3_DEPCMD_CMDIOC;
2141 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2142 memset(¶ms, 0, sizeof(params));
2143 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
2145 dep->resource_index = 0;
2146 dep->flags &= ~DWC3_EP_BUSY;
2150 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2154 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2155 struct dwc3_ep *dep;
2157 dep = dwc->eps[epnum];
2161 if (!(dep->flags & DWC3_EP_ENABLED))
2164 dwc3_remove_requests(dwc, dep);
2168 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2172 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2173 struct dwc3_ep *dep;
2174 struct dwc3_gadget_ep_cmd_params params;
2177 dep = dwc->eps[epnum];
2181 if (!(dep->flags & DWC3_EP_STALL))
2184 dep->flags &= ~DWC3_EP_STALL;
2186 memset(¶ms, 0, sizeof(params));
2187 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
2188 DWC3_DEPCMD_CLEARSTALL, ¶ms);
2193 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2197 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2198 reg &= ~DWC3_DCTL_INITU1ENA;
2199 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2201 reg &= ~DWC3_DCTL_INITU2ENA;
2202 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2204 dwc3_disconnect_gadget(dwc);
2206 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2207 dwc->setup_packet_pending = false;
2208 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2211 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2216 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2217 * would cause a missing Disconnect Event if there's a
2218 * pending Setup Packet in the FIFO.
2220 * There's no suggested workaround on the official Bug
2221 * report, which states that "unless the driver/application
2222 * is doing any special handling of a disconnect event,
2223 * there is no functional issue".
2225 * Unfortunately, it turns out that we _do_ some special
2226 * handling of a disconnect event, namely complete all
2227 * pending transfers, notify gadget driver of the
2228 * disconnection, and so on.
2230 * Our suggested workaround is to follow the Disconnect
2231 * Event steps here, instead, based on a setup_packet_pending
2232 * flag. Such flag gets set whenever we have a SETUP_PENDING
2233 * status for EP0 TRBs and gets cleared on XferComplete for the
2238 * STAR#9000466709: RTL: Device : Disconnect event not
2239 * generated if setup packet pending in FIFO
2241 if (dwc->revision < DWC3_REVISION_188A) {
2242 if (dwc->setup_packet_pending)
2243 dwc3_gadget_disconnect_interrupt(dwc);
2246 dwc3_reset_gadget(dwc);
2248 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2249 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2250 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2251 dwc->test_mode = false;
2253 dwc3_stop_active_transfers(dwc);
2254 dwc3_clear_stall_all_ep(dwc);
2256 /* Reset device address to zero */
2257 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2258 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2259 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2262 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2265 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2268 * We change the clock only at SS but I dunno why I would want to do
2269 * this. Maybe it becomes part of the power saving plan.
2272 if ((speed != DWC3_DSTS_SUPERSPEED) &&
2273 (speed != DWC3_DSTS_SUPERSPEED_PLUS))
2277 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2278 * each time on Connect Done.
2283 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2284 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2285 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2288 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2290 struct dwc3_ep *dep;
2295 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2296 speed = reg & DWC3_DSTS_CONNECTSPD;
2299 dwc3_update_ram_clk_sel(dwc, speed);
2302 case DWC3_DCFG_SUPERSPEED_PLUS:
2303 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2304 dwc->gadget.ep0->maxpacket = 512;
2305 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2307 case DWC3_DCFG_SUPERSPEED:
2309 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2310 * would cause a missing USB3 Reset event.
2312 * In such situations, we should force a USB3 Reset
2313 * event by calling our dwc3_gadget_reset_interrupt()
2318 * STAR#9000483510: RTL: SS : USB3 reset event may
2319 * not be generated always when the link enters poll
2321 if (dwc->revision < DWC3_REVISION_190A)
2322 dwc3_gadget_reset_interrupt(dwc);
2324 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2325 dwc->gadget.ep0->maxpacket = 512;
2326 dwc->gadget.speed = USB_SPEED_SUPER;
2328 case DWC3_DCFG_HIGHSPEED:
2329 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2330 dwc->gadget.ep0->maxpacket = 64;
2331 dwc->gadget.speed = USB_SPEED_HIGH;
2333 case DWC3_DCFG_FULLSPEED2:
2334 case DWC3_DCFG_FULLSPEED1:
2335 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2336 dwc->gadget.ep0->maxpacket = 64;
2337 dwc->gadget.speed = USB_SPEED_FULL;
2339 case DWC3_DCFG_LOWSPEED:
2340 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2341 dwc->gadget.ep0->maxpacket = 8;
2342 dwc->gadget.speed = USB_SPEED_LOW;
2346 /* Enable USB2 LPM Capability */
2348 if ((dwc->revision > DWC3_REVISION_194A) &&
2349 (speed != DWC3_DCFG_SUPERSPEED) &&
2350 (speed != DWC3_DCFG_SUPERSPEED_PLUS)) {
2351 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2352 reg |= DWC3_DCFG_LPM_CAP;
2353 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2355 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2356 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2358 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2361 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2362 * DCFG.LPMCap is set, core responses with an ACK and the
2363 * BESL value in the LPM token is less than or equal to LPM
2366 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2367 && dwc->has_lpm_erratum,
2368 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2370 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2371 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2373 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2375 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2376 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2377 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2381 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2384 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2389 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2392 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2397 * Configure PHY via GUSB3PIPECTLn if required.
2399 * Update GTXFIFOSIZn
2401 * In both cases reset values should be sufficient.
2405 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2408 * TODO take core out of low power mode when that's
2412 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2413 spin_unlock(&dwc->lock);
2414 dwc->gadget_driver->resume(&dwc->gadget);
2415 spin_lock(&dwc->lock);
2419 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2420 unsigned int evtinfo)
2422 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2423 unsigned int pwropt;
2426 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2427 * Hibernation mode enabled which would show up when device detects
2428 * host-initiated U3 exit.
2430 * In that case, device will generate a Link State Change Interrupt
2431 * from U3 to RESUME which is only necessary if Hibernation is
2434 * There are no functional changes due to such spurious event and we
2435 * just need to ignore it.
2439 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2442 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2443 if ((dwc->revision < DWC3_REVISION_250A) &&
2444 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2445 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2446 (next == DWC3_LINK_STATE_RESUME)) {
2447 dwc3_trace(trace_dwc3_gadget,
2448 "ignoring transition U3 -> Resume");
2454 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2455 * on the link partner, the USB session might do multiple entry/exit
2456 * of low power states before a transfer takes place.
2458 * Due to this problem, we might experience lower throughput. The
2459 * suggested workaround is to disable DCTL[12:9] bits if we're
2460 * transitioning from U1/U2 to U0 and enable those bits again
2461 * after a transfer completes and there are no pending transfers
2462 * on any of the enabled endpoints.
2464 * This is the first half of that workaround.
2468 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2469 * core send LGO_Ux entering U0
2471 if (dwc->revision < DWC3_REVISION_183A) {
2472 if (next == DWC3_LINK_STATE_U0) {
2476 switch (dwc->link_state) {
2477 case DWC3_LINK_STATE_U1:
2478 case DWC3_LINK_STATE_U2:
2479 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2480 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2481 | DWC3_DCTL_ACCEPTU2ENA
2482 | DWC3_DCTL_INITU1ENA
2483 | DWC3_DCTL_ACCEPTU1ENA);
2486 dwc->u1u2 = reg & u1u2;
2490 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2500 case DWC3_LINK_STATE_U1:
2501 if (dwc->speed == USB_SPEED_SUPER)
2502 dwc3_suspend_gadget(dwc);
2504 case DWC3_LINK_STATE_U2:
2505 case DWC3_LINK_STATE_U3:
2506 dwc3_suspend_gadget(dwc);
2508 case DWC3_LINK_STATE_RESUME:
2509 dwc3_resume_gadget(dwc);
2516 dwc->link_state = next;
2519 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2520 unsigned int evtinfo)
2522 unsigned int is_ss = evtinfo & BIT(4);
2525 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2526 * have a known issue which can cause USB CV TD.9.23 to fail
2529 * Because of this issue, core could generate bogus hibernation
2530 * events which SW needs to ignore.
2534 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2535 * Device Fallback from SuperSpeed
2537 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2540 /* enter hibernation here */
2543 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2544 const struct dwc3_event_devt *event)
2546 switch (event->type) {
2547 case DWC3_DEVICE_EVENT_DISCONNECT:
2548 dwc3_gadget_disconnect_interrupt(dwc);
2550 case DWC3_DEVICE_EVENT_RESET:
2551 dwc3_gadget_reset_interrupt(dwc);
2553 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2554 dwc3_gadget_conndone_interrupt(dwc);
2556 case DWC3_DEVICE_EVENT_WAKEUP:
2557 dwc3_gadget_wakeup_interrupt(dwc);
2559 case DWC3_DEVICE_EVENT_HIBER_REQ:
2560 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2561 "unexpected hibernation event\n"))
2564 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2566 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2567 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2569 case DWC3_DEVICE_EVENT_EOPF:
2570 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2572 case DWC3_DEVICE_EVENT_SOF:
2573 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2575 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2576 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2578 case DWC3_DEVICE_EVENT_CMD_CMPL:
2579 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2581 case DWC3_DEVICE_EVENT_OVERFLOW:
2582 dwc3_trace(trace_dwc3_gadget, "Overflow");
2585 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2589 static void dwc3_process_event_entry(struct dwc3 *dwc,
2590 const union dwc3_event *event)
2592 trace_dwc3_event(event->raw);
2594 /* Endpoint IRQ, handle it and return early */
2595 if (event->type.is_devspec == 0) {
2597 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2600 switch (event->type.type) {
2601 case DWC3_EVENT_TYPE_DEV:
2602 dwc3_gadget_interrupt(dwc, &event->devt);
2604 /* REVISIT what to do with Carkit and I2C events ? */
2606 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2610 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2612 struct dwc3 *dwc = evt->dwc;
2613 irqreturn_t ret = IRQ_NONE;
2619 if (!(evt->flags & DWC3_EVENT_PENDING))
2623 union dwc3_event event;
2625 event.raw = *(u32 *) (evt->buf + evt->lpos);
2627 dwc3_process_event_entry(dwc, &event);
2630 * FIXME we wrap around correctly to the next entry as
2631 * almost all entries are 4 bytes in size. There is one
2632 * entry which has 12 bytes which is a regular entry
2633 * followed by 8 bytes data. ATM I don't know how
2634 * things are organized if we get next to the a
2635 * boundary so I worry about that once we try to handle
2638 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2641 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2645 evt->flags &= ~DWC3_EVENT_PENDING;
2648 /* Unmask interrupt */
2649 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2650 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2651 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2656 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2658 struct dwc3_event_buffer *evt = _evt;
2659 struct dwc3 *dwc = evt->dwc;
2660 unsigned long flags;
2661 irqreturn_t ret = IRQ_NONE;
2663 spin_lock_irqsave(&dwc->lock, flags);
2664 ret = dwc3_process_event_buf(evt);
2665 spin_unlock_irqrestore(&dwc->lock, flags);
2670 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2672 struct dwc3 *dwc = evt->dwc;
2676 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2677 count &= DWC3_GEVNTCOUNT_MASK;
2682 evt->flags |= DWC3_EVENT_PENDING;
2684 /* Mask interrupt */
2685 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2686 reg |= DWC3_GEVNTSIZ_INTMASK;
2687 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2689 return IRQ_WAKE_THREAD;
2692 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2694 struct dwc3_event_buffer *evt = _evt;
2696 return dwc3_check_event_buf(evt);
2700 * dwc3_gadget_init - Initializes gadget related registers
2701 * @dwc: pointer to our controller context structure
2703 * Returns 0 on success otherwise negative errno.
2705 int dwc3_gadget_init(struct dwc3 *dwc)
2709 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2710 &dwc->ctrl_req_addr, GFP_KERNEL);
2711 if (!dwc->ctrl_req) {
2712 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2717 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2718 &dwc->ep0_trb_addr, GFP_KERNEL);
2719 if (!dwc->ep0_trb) {
2720 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2725 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2726 if (!dwc->setup_buf) {
2731 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2732 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2734 if (!dwc->ep0_bounce) {
2735 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2740 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2741 if (!dwc->zlp_buf) {
2746 dwc->gadget.ops = &dwc3_gadget_ops;
2747 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2748 dwc->gadget.sg_supported = true;
2749 dwc->gadget.name = "dwc3-gadget";
2750 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2753 * FIXME We might be setting max_speed to <SUPER, however versions
2754 * <2.20a of dwc3 have an issue with metastability (documented
2755 * elsewhere in this driver) which tells us we can't set max speed to
2756 * anything lower than SUPER.
2758 * Because gadget.max_speed is only used by composite.c and function
2759 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2760 * to happen so we avoid sending SuperSpeed Capability descriptor
2761 * together with our BOS descriptor as that could confuse host into
2762 * thinking we can handle super speed.
2764 * Note that, in fact, we won't even support GetBOS requests when speed
2765 * is less than super speed because we don't have means, yet, to tell
2766 * composite.c that we are USB 2.0 + LPM ECN.
2768 if (dwc->revision < DWC3_REVISION_220A)
2769 dwc3_trace(trace_dwc3_gadget,
2770 "Changing max_speed on rev %08x\n",
2773 dwc->gadget.max_speed = dwc->maximum_speed;
2776 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2779 dwc->gadget.quirk_ep_out_aligned_size = true;
2782 * REVISIT: Here we should clear all pending IRQs to be
2783 * sure we're starting from a well known location.
2786 ret = dwc3_gadget_init_endpoints(dwc);
2790 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2792 dev_err(dwc->dev, "failed to register udc\n");
2799 kfree(dwc->zlp_buf);
2802 dwc3_gadget_free_endpoints(dwc);
2803 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2804 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2807 kfree(dwc->setup_buf);
2810 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2811 dwc->ep0_trb, dwc->ep0_trb_addr);
2814 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2815 dwc->ctrl_req, dwc->ctrl_req_addr);
2821 /* -------------------------------------------------------------------------- */
2823 void dwc3_gadget_exit(struct dwc3 *dwc)
2825 usb_del_gadget_udc(&dwc->gadget);
2827 dwc3_gadget_free_endpoints(dwc);
2829 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2830 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2832 kfree(dwc->setup_buf);
2833 kfree(dwc->zlp_buf);
2835 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2836 dwc->ep0_trb, dwc->ep0_trb_addr);
2838 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2839 dwc->ctrl_req, dwc->ctrl_req_addr);
2842 int dwc3_gadget_suspend(struct dwc3 *dwc)
2844 if (dwc->pullups_connected) {
2845 dwc3_gadget_disable_irq(dwc);
2846 dwc3_gadget_run_stop(dwc, true, true);
2849 __dwc3_gadget_ep_disable(dwc->eps[0]);
2850 __dwc3_gadget_ep_disable(dwc->eps[1]);
2852 dwc->dcfg = dwc3_readl(dwc->regs, DWC3_DCFG);
2857 int dwc3_gadget_resume(struct dwc3 *dwc)
2859 struct dwc3_ep *dep;
2862 /* Start with SuperSpeed Default */
2863 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2866 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2872 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
2877 /* begin to receive SETUP packets */
2878 dwc->ep0state = EP0_SETUP_PHASE;
2879 dwc3_ep0_out_start(dwc);
2881 dwc3_writel(dwc->regs, DWC3_DCFG, dwc->dcfg);
2883 if (dwc->pullups_connected) {
2884 dwc3_gadget_enable_irq(dwc);
2885 dwc3_gadget_run_stop(dwc, true, false);
2891 __dwc3_gadget_ep_disable(dwc->eps[0]);