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;
182 dwc3_ep_inc_deq(dep);
183 } while(++i < req->request.num_mapped_sgs);
184 req->started = false;
186 list_del(&req->list);
189 if (req->request.status == -EINPROGRESS)
190 req->request.status = status;
192 if (dwc->ep0_bounced && dep->number == 0)
193 dwc->ep0_bounced = false;
195 usb_gadget_unmap_request(&dwc->gadget, &req->request,
198 trace_dwc3_gadget_giveback(req);
200 spin_unlock(&dwc->lock);
201 usb_gadget_giveback_request(&dep->endpoint, &req->request);
202 spin_lock(&dwc->lock);
205 pm_runtime_put(dwc->dev);
208 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
215 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
216 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
219 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
220 if (!(reg & DWC3_DGCMD_CMDACT)) {
221 status = DWC3_DGCMD_STATUS(reg);
233 trace_dwc3_gadget_generic_cmd(cmd, param, status);
238 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
240 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
241 struct dwc3_gadget_ep_cmd_params *params)
243 struct dwc3 *dwc = dep->dwc;
252 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
253 * we're issuing an endpoint command, we must check if
254 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
256 * We will also set SUSPHY bit to what it was before returning as stated
257 * by the same section on Synopsys databook.
259 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
260 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
261 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
263 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
264 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
268 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
271 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
272 dwc->link_state == DWC3_LINK_STATE_U2 ||
273 dwc->link_state == DWC3_LINK_STATE_U3);
275 if (unlikely(needs_wakeup)) {
276 ret = __dwc3_gadget_wakeup(dwc);
277 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
282 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
283 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
284 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
286 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
288 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
289 if (!(reg & DWC3_DEPCMD_CMDACT)) {
290 cmd_status = DWC3_DEPCMD_STATUS(reg);
292 dwc3_trace(trace_dwc3_gadget,
293 "Command Complete --> %d",
296 switch (cmd_status) {
300 case DEPEVT_TRANSFER_NO_RESOURCE:
301 dwc3_trace(trace_dwc3_gadget, "no resource available");
304 case DEPEVT_TRANSFER_BUS_EXPIRY:
306 * SW issues START TRANSFER command to
307 * isochronous ep with future frame interval. If
308 * future interval time has already passed when
309 * core receives the command, it will respond
310 * with an error status of 'Bus Expiry'.
312 * Instead of always returning -EINVAL, let's
313 * give a hint to the gadget driver that this is
314 * the case by returning -EAGAIN.
316 dwc3_trace(trace_dwc3_gadget, "bus expiry");
320 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
328 dwc3_trace(trace_dwc3_gadget,
329 "Command Timed Out");
331 cmd_status = -ETIMEDOUT;
334 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
336 if (unlikely(susphy)) {
337 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
338 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
339 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
345 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
347 struct dwc3 *dwc = dep->dwc;
348 struct dwc3_gadget_ep_cmd_params params;
349 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
352 * As of core revision 2.60a the recommended programming model
353 * is to set the ClearPendIN bit when issuing a Clear Stall EP
354 * command for IN endpoints. This is to prevent an issue where
355 * some (non-compliant) hosts may not send ACK TPs for pending
356 * IN transfers due to a mishandled error condition. Synopsys
359 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
360 cmd |= DWC3_DEPCMD_CLEARPENDIN;
362 memset(¶ms, 0, sizeof(params));
364 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
367 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
368 struct dwc3_trb *trb)
370 u32 offset = (char *) trb - (char *) dep->trb_pool;
372 return dep->trb_pool_dma + offset;
375 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
377 struct dwc3 *dwc = dep->dwc;
382 dep->trb_pool = dma_alloc_coherent(dwc->dev,
383 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
384 &dep->trb_pool_dma, GFP_KERNEL);
385 if (!dep->trb_pool) {
386 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
394 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
396 struct dwc3 *dwc = dep->dwc;
398 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
399 dep->trb_pool, dep->trb_pool_dma);
401 dep->trb_pool = NULL;
402 dep->trb_pool_dma = 0;
405 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
408 * dwc3_gadget_start_config - Configure EP resources
409 * @dwc: pointer to our controller context structure
410 * @dep: endpoint that is being enabled
412 * The assignment of transfer resources cannot perfectly follow the
413 * data book due to the fact that the controller driver does not have
414 * all knowledge of the configuration in advance. It is given this
415 * information piecemeal by the composite gadget framework after every
416 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
417 * programming model in this scenario can cause errors. For two
420 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
421 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
422 * multiple interfaces.
424 * 2) The databook does not mention doing more DEPXFERCFG for new
425 * endpoint on alt setting (8.1.6).
427 * The following simplified method is used instead:
429 * All hardware endpoints can be assigned a transfer resource and this
430 * setting will stay persistent until either a core reset or
431 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
432 * do DEPXFERCFG for every hardware endpoint as well. We are
433 * guaranteed that there are as many transfer resources as endpoints.
435 * This function is called for each endpoint when it is being enabled
436 * but is triggered only when called for EP0-out, which always happens
437 * first, and which should only happen in one of the above conditions.
439 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
441 struct dwc3_gadget_ep_cmd_params params;
449 memset(¶ms, 0x00, sizeof(params));
450 cmd = DWC3_DEPCMD_DEPSTARTCFG;
452 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
456 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
457 struct dwc3_ep *dep = dwc->eps[i];
462 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
470 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
471 const struct usb_endpoint_descriptor *desc,
472 const struct usb_ss_ep_comp_descriptor *comp_desc,
473 bool ignore, bool restore)
475 struct dwc3_gadget_ep_cmd_params params;
477 memset(¶ms, 0x00, sizeof(params));
479 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
480 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
482 /* Burst size is only needed in SuperSpeed mode */
483 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
484 u32 burst = dep->endpoint.maxburst;
485 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
489 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
492 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
493 params.param2 |= dep->saved_state;
496 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
497 | DWC3_DEPCFG_XFER_NOT_READY_EN;
499 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
500 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
501 | DWC3_DEPCFG_STREAM_EVENT_EN;
502 dep->stream_capable = true;
505 if (!usb_endpoint_xfer_control(desc))
506 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
509 * We are doing 1:1 mapping for endpoints, meaning
510 * Physical Endpoints 2 maps to Logical Endpoint 2 and
511 * so on. We consider the direction bit as part of the physical
512 * endpoint number. So USB endpoint 0x81 is 0x03.
514 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
517 * We must use the lower 16 TX FIFOs even though
521 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
523 if (desc->bInterval) {
524 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
525 dep->interval = 1 << (desc->bInterval - 1);
528 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
531 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
533 struct dwc3_gadget_ep_cmd_params params;
535 memset(¶ms, 0x00, sizeof(params));
537 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
539 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
544 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
545 * @dep: endpoint to be initialized
546 * @desc: USB Endpoint Descriptor
548 * Caller should take care of locking
550 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
551 const struct usb_endpoint_descriptor *desc,
552 const struct usb_ss_ep_comp_descriptor *comp_desc,
553 bool ignore, bool restore)
555 struct dwc3 *dwc = dep->dwc;
559 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
561 if (!(dep->flags & DWC3_EP_ENABLED)) {
562 ret = dwc3_gadget_start_config(dwc, dep);
567 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
572 if (!(dep->flags & DWC3_EP_ENABLED)) {
573 struct dwc3_trb *trb_st_hw;
574 struct dwc3_trb *trb_link;
576 dep->endpoint.desc = desc;
577 dep->comp_desc = comp_desc;
578 dep->type = usb_endpoint_type(desc);
579 dep->flags |= DWC3_EP_ENABLED;
581 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
582 reg |= DWC3_DALEPENA_EP(dep->number);
583 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
585 if (usb_endpoint_xfer_control(desc))
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 memset(trb_link, 0, sizeof(*trb_link));
594 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
595 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
596 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
597 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
603 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
604 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
606 struct dwc3_request *req;
608 if (!list_empty(&dep->started_list)) {
609 dwc3_stop_active_transfer(dwc, dep->number, true);
611 /* - giveback all requests to gadget driver */
612 while (!list_empty(&dep->started_list)) {
613 req = next_request(&dep->started_list);
615 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
619 while (!list_empty(&dep->pending_list)) {
620 req = next_request(&dep->pending_list);
622 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
627 * __dwc3_gadget_ep_disable - Disables a HW endpoint
628 * @dep: the endpoint to disable
630 * This function also removes requests which are currently processed ny the
631 * hardware and those which are not yet scheduled.
632 * Caller should take care of locking.
634 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
636 struct dwc3 *dwc = dep->dwc;
639 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
641 dwc3_remove_requests(dwc, dep);
643 /* make sure HW endpoint isn't stalled */
644 if (dep->flags & DWC3_EP_STALL)
645 __dwc3_gadget_ep_set_halt(dep, 0, false);
647 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
648 reg &= ~DWC3_DALEPENA_EP(dep->number);
649 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
651 dep->stream_capable = false;
652 dep->endpoint.desc = NULL;
653 dep->comp_desc = NULL;
660 /* -------------------------------------------------------------------------- */
662 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
663 const struct usb_endpoint_descriptor *desc)
668 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
673 /* -------------------------------------------------------------------------- */
675 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
676 const struct usb_endpoint_descriptor *desc)
683 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
684 pr_debug("dwc3: invalid parameters\n");
688 if (!desc->wMaxPacketSize) {
689 pr_debug("dwc3: missing wMaxPacketSize\n");
693 dep = to_dwc3_ep(ep);
696 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
697 "%s is already enabled\n",
701 spin_lock_irqsave(&dwc->lock, flags);
702 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
703 spin_unlock_irqrestore(&dwc->lock, flags);
708 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
716 pr_debug("dwc3: invalid parameters\n");
720 dep = to_dwc3_ep(ep);
723 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
724 "%s is already disabled\n",
728 spin_lock_irqsave(&dwc->lock, flags);
729 ret = __dwc3_gadget_ep_disable(dep);
730 spin_unlock_irqrestore(&dwc->lock, flags);
735 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
738 struct dwc3_request *req;
739 struct dwc3_ep *dep = to_dwc3_ep(ep);
741 req = kzalloc(sizeof(*req), gfp_flags);
745 req->epnum = dep->number;
748 trace_dwc3_alloc_request(req);
750 return &req->request;
753 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
754 struct usb_request *request)
756 struct dwc3_request *req = to_dwc3_request(request);
758 trace_dwc3_free_request(req);
763 * dwc3_prepare_one_trb - setup one TRB from one request
764 * @dep: endpoint for which this request is prepared
765 * @req: dwc3_request pointer
767 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
768 struct dwc3_request *req, dma_addr_t dma,
769 unsigned length, unsigned last, unsigned chain, unsigned node)
771 struct dwc3_trb *trb;
773 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
774 dep->name, req, (unsigned long long) dma,
775 length, last ? " last" : "",
776 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;
788 dwc3_ep_inc_enq(dep);
790 trb->size = DWC3_TRB_SIZE_LENGTH(length);
791 trb->bpl = lower_32_bits(dma);
792 trb->bph = upper_32_bits(dma);
794 switch (usb_endpoint_type(dep->endpoint.desc)) {
795 case USB_ENDPOINT_XFER_CONTROL:
796 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
799 case USB_ENDPOINT_XFER_ISOC:
801 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
803 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
805 /* always enable Interrupt on Missed ISOC */
806 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
809 case USB_ENDPOINT_XFER_BULK:
810 case USB_ENDPOINT_XFER_INT:
811 trb->ctrl = DWC3_TRBCTL_NORMAL;
815 * This is only possible with faulty memory because we
816 * checked it already :)
821 /* always enable Continue on Short Packet */
822 trb->ctrl |= DWC3_TRB_CTRL_CSP;
824 if (!req->request.no_interrupt && !chain)
825 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
828 trb->ctrl |= DWC3_TRB_CTRL_LST;
831 trb->ctrl |= DWC3_TRB_CTRL_CHN;
833 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
834 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
836 trb->ctrl |= DWC3_TRB_CTRL_HWO;
838 trace_dwc3_prepare_trb(dep, trb);
841 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
843 struct dwc3_trb *tmp;
846 * If enqueue & dequeue are equal than it is either full or empty.
848 * One way to know for sure is if the TRB right before us has HWO bit
849 * set or not. If it has, then we're definitely full and can't fit any
850 * more transfers in our ring.
852 if (dep->trb_enqueue == dep->trb_dequeue) {
853 /* If we're full, enqueue/dequeue are > 0 */
854 if (dep->trb_enqueue) {
855 tmp = &dep->trb_pool[dep->trb_enqueue - 1];
856 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
860 return DWC3_TRB_NUM - 1;
863 return dep->trb_dequeue - dep->trb_enqueue;
866 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
867 struct dwc3_request *req, unsigned int trbs_left)
869 struct usb_request *request = &req->request;
870 struct scatterlist *sg = request->sg;
871 struct scatterlist *s;
872 unsigned int last = false;
877 for_each_sg(sg, s, request->num_mapped_sgs, i) {
878 unsigned chain = true;
880 length = sg_dma_len(s);
881 dma = sg_dma_address(s);
884 if (list_is_last(&req->list, &dep->pending_list))
896 dwc3_prepare_one_trb(dep, req, dma, length,
904 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
905 struct dwc3_request *req, unsigned int trbs_left)
907 unsigned int last = false;
911 dma = req->request.dma;
912 length = req->request.length;
917 /* Is this the last request? */
918 if (list_is_last(&req->list, &dep->pending_list))
921 dwc3_prepare_one_trb(dep, req, dma, length,
926 * dwc3_prepare_trbs - setup TRBs from requests
927 * @dep: endpoint for which requests are being prepared
929 * The function goes through the requests list and sets up TRBs for the
930 * transfers. The function returns once there are no more TRBs available or
931 * it runs out of requests.
933 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
935 struct dwc3_request *req, *n;
938 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
940 trbs_left = dwc3_calc_trbs_left(dep);
942 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
943 if (req->request.num_mapped_sgs > 0)
944 dwc3_prepare_one_trb_sg(dep, req, trbs_left--);
946 dwc3_prepare_one_trb_linear(dep, req, trbs_left--);
953 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
955 struct dwc3_gadget_ep_cmd_params params;
956 struct dwc3_request *req;
957 struct dwc3 *dwc = dep->dwc;
962 starting = !(dep->flags & DWC3_EP_BUSY);
964 dwc3_prepare_trbs(dep);
965 req = next_request(&dep->started_list);
967 dep->flags |= DWC3_EP_PENDING_REQUEST;
971 memset(¶ms, 0, sizeof(params));
974 params.param0 = upper_32_bits(req->trb_dma);
975 params.param1 = lower_32_bits(req->trb_dma);
976 cmd = DWC3_DEPCMD_STARTTRANSFER;
978 cmd = DWC3_DEPCMD_UPDATETRANSFER;
981 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
982 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
985 * FIXME we need to iterate over the list of requests
986 * here and stop, unmap, free and del each of the linked
987 * requests instead of what we do now.
989 usb_gadget_unmap_request(&dwc->gadget, &req->request,
991 list_del(&req->list);
995 dep->flags |= DWC3_EP_BUSY;
998 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
999 WARN_ON_ONCE(!dep->resource_index);
1005 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1006 struct dwc3_ep *dep, u32 cur_uf)
1010 if (list_empty(&dep->pending_list)) {
1011 dwc3_trace(trace_dwc3_gadget,
1012 "ISOC ep %s run out for requests",
1014 dep->flags |= DWC3_EP_PENDING_REQUEST;
1018 /* 4 micro frames in the future */
1019 uf = cur_uf + dep->interval * 4;
1021 __dwc3_gadget_kick_transfer(dep, uf);
1024 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1025 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1029 mask = ~(dep->interval - 1);
1030 cur_uf = event->parameters & mask;
1032 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1035 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1037 struct dwc3 *dwc = dep->dwc;
1040 if (!dep->endpoint.desc) {
1041 dwc3_trace(trace_dwc3_gadget,
1042 "trying to queue request %p to disabled %s\n",
1043 &req->request, dep->endpoint.name);
1047 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1048 &req->request, req->dep->name)) {
1049 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'\n",
1050 &req->request, req->dep->name);
1054 pm_runtime_get(dwc->dev);
1056 req->request.actual = 0;
1057 req->request.status = -EINPROGRESS;
1058 req->direction = dep->direction;
1059 req->epnum = dep->number;
1061 trace_dwc3_ep_queue(req);
1064 * Per databook, the total size of buffer must be a multiple
1065 * of MaxPacketSize for OUT endpoints. And MaxPacketSize is
1066 * configed for endpoints in dwc3_gadget_set_ep_config(),
1067 * set to usb_endpoint_descriptor->wMaxPacketSize.
1069 if (dep->direction == 0 &&
1070 req->request.length % dep->endpoint.desc->wMaxPacketSize)
1071 req->request.length = roundup(req->request.length,
1072 dep->endpoint.desc->wMaxPacketSize);
1075 * We only add to our list of requests now and
1076 * start consuming the list once we get XferNotReady
1079 * That way, we avoid doing anything that we don't need
1080 * to do now and defer it until the point we receive a
1081 * particular token from the Host side.
1083 * This will also avoid Host cancelling URBs due to too
1086 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1091 list_add_tail(&req->list, &dep->pending_list);
1094 * If there are no pending requests and the endpoint isn't already
1095 * busy, we will just start the request straight away.
1097 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1098 * little bit faster.
1100 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1101 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1102 !(dep->flags & DWC3_EP_BUSY)) {
1103 ret = __dwc3_gadget_kick_transfer(dep, 0);
1108 * There are a few special cases:
1110 * 1. XferNotReady with empty list of requests. We need to kick the
1111 * transfer here in that situation, otherwise we will be NAKing
1112 * forever. If we get XferNotReady before gadget driver has a
1113 * chance to queue a request, we will ACK the IRQ but won't be
1114 * able to receive the data until the next request is queued.
1115 * The following code is handling exactly that.
1118 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1120 * If xfernotready is already elapsed and it is a case
1121 * of isoc transfer, then issue END TRANSFER, so that
1122 * you can receive xfernotready again and can have
1123 * notion of current microframe.
1125 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1126 if (list_empty(&dep->started_list)) {
1127 dwc3_stop_active_transfer(dwc, dep->number, true);
1128 dep->flags = DWC3_EP_ENABLED;
1133 ret = __dwc3_gadget_kick_transfer(dep, 0);
1135 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1141 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1142 * kick the transfer here after queuing a request, otherwise the
1143 * core may not see the modified TRB(s).
1145 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1146 (dep->flags & DWC3_EP_BUSY) &&
1147 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1148 WARN_ON_ONCE(!dep->resource_index);
1149 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index);
1154 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1155 * right away, otherwise host will not know we have streams to be
1158 if (dep->stream_capable)
1159 ret = __dwc3_gadget_kick_transfer(dep, 0);
1162 if (ret && ret != -EBUSY)
1163 dwc3_trace(trace_dwc3_gadget,
1164 "%s: failed to kick transfers\n",
1172 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1173 struct usb_request *request)
1175 dwc3_gadget_ep_free_request(ep, request);
1178 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1180 struct dwc3_request *req;
1181 struct usb_request *request;
1182 struct usb_ep *ep = &dep->endpoint;
1184 dwc3_trace(trace_dwc3_gadget, "queueing ZLP\n");
1185 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1189 request->length = 0;
1190 request->buf = dwc->zlp_buf;
1191 request->complete = __dwc3_gadget_ep_zlp_complete;
1193 req = to_dwc3_request(request);
1195 return __dwc3_gadget_ep_queue(dep, req);
1198 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1201 struct dwc3_request *req = to_dwc3_request(request);
1202 struct dwc3_ep *dep = to_dwc3_ep(ep);
1203 struct dwc3 *dwc = dep->dwc;
1205 unsigned long flags;
1209 spin_lock_irqsave(&dwc->lock, flags);
1210 ret = __dwc3_gadget_ep_queue(dep, req);
1213 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1214 * setting request->zero, instead of doing magic, we will just queue an
1215 * extra usb_request ourselves so that it gets handled the same way as
1216 * any other request.
1218 if (ret == 0 && request->zero && request->length &&
1219 (request->length % ep->desc->wMaxPacketSize == 0))
1220 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1222 spin_unlock_irqrestore(&dwc->lock, flags);
1227 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1228 struct usb_request *request)
1230 struct dwc3_request *req = to_dwc3_request(request);
1231 struct dwc3_request *r = NULL;
1233 struct dwc3_ep *dep = to_dwc3_ep(ep);
1234 struct dwc3 *dwc = dep->dwc;
1236 unsigned long flags;
1239 trace_dwc3_ep_dequeue(req);
1241 spin_lock_irqsave(&dwc->lock, flags);
1243 list_for_each_entry(r, &dep->pending_list, list) {
1249 list_for_each_entry(r, &dep->started_list, list) {
1254 /* wait until it is processed */
1255 dwc3_stop_active_transfer(dwc, dep->number, true);
1258 dev_err(dwc->dev, "request %p was not queued to %s\n",
1265 /* giveback the request */
1266 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1269 spin_unlock_irqrestore(&dwc->lock, flags);
1274 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1276 struct dwc3_gadget_ep_cmd_params params;
1277 struct dwc3 *dwc = dep->dwc;
1280 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1281 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1285 memset(¶ms, 0x00, sizeof(params));
1288 if (!protocol && ((dep->direction && dep->flags & DWC3_EP_BUSY) ||
1289 (!list_empty(&dep->started_list) ||
1290 !list_empty(&dep->pending_list)))) {
1291 dwc3_trace(trace_dwc3_gadget,
1292 "%s: pending request, cannot halt",
1297 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1300 dev_err(dwc->dev, "failed to set STALL on %s\n",
1303 dep->flags |= DWC3_EP_STALL;
1306 ret = dwc3_send_clear_stall_ep_cmd(dep);
1308 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1311 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1317 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1319 struct dwc3_ep *dep = to_dwc3_ep(ep);
1320 struct dwc3 *dwc = dep->dwc;
1322 unsigned long flags;
1326 spin_lock_irqsave(&dwc->lock, flags);
1327 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1328 spin_unlock_irqrestore(&dwc->lock, flags);
1333 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1335 struct dwc3_ep *dep = to_dwc3_ep(ep);
1336 struct dwc3 *dwc = dep->dwc;
1337 unsigned long flags;
1340 spin_lock_irqsave(&dwc->lock, flags);
1341 dep->flags |= DWC3_EP_WEDGE;
1343 if (dep->number == 0 || dep->number == 1)
1344 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1346 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1347 spin_unlock_irqrestore(&dwc->lock, flags);
1352 /* -------------------------------------------------------------------------- */
1354 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1355 .bLength = USB_DT_ENDPOINT_SIZE,
1356 .bDescriptorType = USB_DT_ENDPOINT,
1357 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1360 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1361 .enable = dwc3_gadget_ep0_enable,
1362 .disable = dwc3_gadget_ep0_disable,
1363 .alloc_request = dwc3_gadget_ep_alloc_request,
1364 .free_request = dwc3_gadget_ep_free_request,
1365 .queue = dwc3_gadget_ep0_queue,
1366 .dequeue = dwc3_gadget_ep_dequeue,
1367 .set_halt = dwc3_gadget_ep0_set_halt,
1368 .set_wedge = dwc3_gadget_ep_set_wedge,
1371 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1372 .enable = dwc3_gadget_ep_enable,
1373 .disable = dwc3_gadget_ep_disable,
1374 .alloc_request = dwc3_gadget_ep_alloc_request,
1375 .free_request = dwc3_gadget_ep_free_request,
1376 .queue = dwc3_gadget_ep_queue,
1377 .dequeue = dwc3_gadget_ep_dequeue,
1378 .set_halt = dwc3_gadget_ep_set_halt,
1379 .set_wedge = dwc3_gadget_ep_set_wedge,
1382 /* -------------------------------------------------------------------------- */
1384 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1386 struct dwc3 *dwc = gadget_to_dwc(g);
1389 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1390 return DWC3_DSTS_SOFFN(reg);
1393 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1395 unsigned long timeout;
1404 * According to the Databook Remote wakeup request should
1405 * be issued only when the device is in early suspend state.
1407 * We can check that via USB Link State bits in DSTS register.
1409 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1411 speed = reg & DWC3_DSTS_CONNECTSPD;
1412 if (speed == DWC3_DSTS_SUPERSPEED) {
1413 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed\n");
1417 link_state = DWC3_DSTS_USBLNKST(reg);
1419 switch (link_state) {
1420 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1421 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1424 dwc3_trace(trace_dwc3_gadget,
1425 "can't wakeup from '%s'\n",
1426 dwc3_gadget_link_string(link_state));
1430 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1432 dev_err(dwc->dev, "failed to put link in Recovery\n");
1436 /* Recent versions do this automatically */
1437 if (dwc->revision < DWC3_REVISION_194A) {
1438 /* write zeroes to Link Change Request */
1439 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1440 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1441 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1444 /* poll until Link State changes to ON */
1445 timeout = jiffies + msecs_to_jiffies(100);
1447 while (!time_after(jiffies, timeout)) {
1448 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1450 /* in HS, means ON */
1451 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1455 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1456 dev_err(dwc->dev, "failed to send remote wakeup\n");
1463 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1465 struct dwc3 *dwc = gadget_to_dwc(g);
1466 unsigned long flags;
1469 spin_lock_irqsave(&dwc->lock, flags);
1470 ret = __dwc3_gadget_wakeup(dwc);
1471 spin_unlock_irqrestore(&dwc->lock, flags);
1476 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1479 struct dwc3 *dwc = gadget_to_dwc(g);
1480 unsigned long flags;
1482 spin_lock_irqsave(&dwc->lock, flags);
1483 g->is_selfpowered = !!is_selfpowered;
1484 spin_unlock_irqrestore(&dwc->lock, flags);
1489 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1494 if (pm_runtime_suspended(dwc->dev))
1497 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1499 if (dwc->revision <= DWC3_REVISION_187A) {
1500 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1501 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1504 if (dwc->revision >= DWC3_REVISION_194A)
1505 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1506 reg |= DWC3_DCTL_RUN_STOP;
1508 if (dwc->has_hibernation)
1509 reg |= DWC3_DCTL_KEEP_CONNECT;
1511 dwc->pullups_connected = true;
1513 reg &= ~DWC3_DCTL_RUN_STOP;
1515 if (dwc->has_hibernation && !suspend)
1516 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1518 dwc->pullups_connected = false;
1521 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1524 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1526 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1529 if (reg & DWC3_DSTS_DEVCTRLHLT)
1538 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1540 ? dwc->gadget_driver->function : "no-function",
1541 is_on ? "connect" : "disconnect");
1546 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1548 struct dwc3 *dwc = gadget_to_dwc(g);
1549 unsigned long flags;
1554 spin_lock_irqsave(&dwc->lock, flags);
1555 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1556 spin_unlock_irqrestore(&dwc->lock, flags);
1561 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1565 /* Enable all but Start and End of Frame IRQs */
1566 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1567 DWC3_DEVTEN_EVNTOVERFLOWEN |
1568 DWC3_DEVTEN_CMDCMPLTEN |
1569 DWC3_DEVTEN_ERRTICERREN |
1570 DWC3_DEVTEN_WKUPEVTEN |
1571 DWC3_DEVTEN_ULSTCNGEN |
1572 DWC3_DEVTEN_CONNECTDONEEN |
1573 DWC3_DEVTEN_USBRSTEN |
1574 DWC3_DEVTEN_DISCONNEVTEN);
1576 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1579 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1581 /* mask all interrupts */
1582 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1585 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1586 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1589 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1590 * dwc: pointer to our context structure
1592 * The following looks like complex but it's actually very simple. In order to
1593 * calculate the number of packets we can burst at once on OUT transfers, we're
1594 * gonna use RxFIFO size.
1596 * To calculate RxFIFO size we need two numbers:
1597 * MDWIDTH = size, in bits, of the internal memory bus
1598 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1600 * Given these two numbers, the formula is simple:
1602 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1604 * 24 bytes is for 3x SETUP packets
1605 * 16 bytes is a clock domain crossing tolerance
1607 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1609 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1616 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1617 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1619 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1620 nump = min_t(u32, nump, 16);
1623 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1624 reg &= ~DWC3_DCFG_NUMP_MASK;
1625 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1626 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1629 static int __dwc3_gadget_start(struct dwc3 *dwc)
1631 struct dwc3_ep *dep;
1635 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1636 reg &= ~(DWC3_DCFG_SPEED_MASK);
1639 * WORKAROUND: DWC3 revision < 2.20a have an issue
1640 * which would cause metastability state on Run/Stop
1641 * bit if we try to force the IP to USB2-only mode.
1643 * Because of that, we cannot configure the IP to any
1644 * speed other than the SuperSpeed
1648 * STAR#9000525659: Clock Domain Crossing on DCTL in
1651 if (dwc->revision < DWC3_REVISION_220A) {
1652 reg |= DWC3_DCFG_SUPERSPEED;
1654 switch (dwc->maximum_speed) {
1656 reg |= DWC3_DSTS_LOWSPEED;
1658 case USB_SPEED_FULL:
1659 reg |= DWC3_DSTS_FULLSPEED1;
1661 case USB_SPEED_HIGH:
1662 reg |= DWC3_DSTS_HIGHSPEED;
1664 case USB_SPEED_SUPER: /* FALLTHROUGH */
1665 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1667 reg |= DWC3_DSTS_SUPERSPEED;
1670 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1673 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1674 * field instead of letting dwc3 itself calculate that automatically.
1676 * This way, we maximize the chances that we'll be able to get several
1677 * bursts of data without going through any sort of endpoint throttling.
1679 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1680 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1681 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1683 dwc3_gadget_setup_nump(dwc);
1685 /* Start with SuperSpeed Default */
1686 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1689 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1692 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1697 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1700 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1704 /* begin to receive SETUP packets */
1705 dwc->ep0state = EP0_SETUP_PHASE;
1706 dwc3_ep0_out_start(dwc);
1708 dwc3_gadget_enable_irq(dwc);
1713 __dwc3_gadget_ep_disable(dwc->eps[0]);
1719 static int dwc3_gadget_start(struct usb_gadget *g,
1720 struct usb_gadget_driver *driver)
1722 struct dwc3 *dwc = gadget_to_dwc(g);
1723 unsigned long flags;
1727 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1728 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1729 IRQF_SHARED, "dwc3", dwc->ev_buf);
1731 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1735 dwc->irq_gadget = irq;
1737 spin_lock_irqsave(&dwc->lock, flags);
1738 if (dwc->gadget_driver) {
1739 dev_err(dwc->dev, "%s is already bound to %s\n",
1741 dwc->gadget_driver->driver.name);
1746 dwc->gadget_driver = driver;
1748 if (pm_runtime_active(dwc->dev))
1749 __dwc3_gadget_start(dwc);
1751 spin_unlock_irqrestore(&dwc->lock, flags);
1756 spin_unlock_irqrestore(&dwc->lock, flags);
1763 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1765 dwc3_gadget_disable_irq(dwc);
1766 __dwc3_gadget_ep_disable(dwc->eps[0]);
1767 __dwc3_gadget_ep_disable(dwc->eps[1]);
1770 static int dwc3_gadget_stop(struct usb_gadget *g)
1772 struct dwc3 *dwc = gadget_to_dwc(g);
1773 unsigned long flags;
1775 spin_lock_irqsave(&dwc->lock, flags);
1776 __dwc3_gadget_stop(dwc);
1777 dwc->gadget_driver = NULL;
1778 spin_unlock_irqrestore(&dwc->lock, flags);
1780 free_irq(dwc->irq_gadget, dwc->ev_buf);
1785 static const struct usb_gadget_ops dwc3_gadget_ops = {
1786 .get_frame = dwc3_gadget_get_frame,
1787 .wakeup = dwc3_gadget_wakeup,
1788 .set_selfpowered = dwc3_gadget_set_selfpowered,
1789 .pullup = dwc3_gadget_pullup,
1790 .udc_start = dwc3_gadget_start,
1791 .udc_stop = dwc3_gadget_stop,
1794 /* -------------------------------------------------------------------------- */
1796 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1797 u8 num, u32 direction)
1799 struct dwc3_ep *dep;
1802 for (i = 0; i < num; i++) {
1803 u8 epnum = (i << 1) | (direction ? 1 : 0);
1805 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1810 dep->number = epnum;
1811 dep->direction = !!direction;
1812 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1813 dwc->eps[epnum] = dep;
1815 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1816 (epnum & 1) ? "in" : "out");
1818 dep->endpoint.name = dep->name;
1819 spin_lock_init(&dep->lock);
1821 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1823 if (epnum == 0 || epnum == 1) {
1824 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1825 dep->endpoint.maxburst = 1;
1826 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1828 dwc->gadget.ep0 = &dep->endpoint;
1832 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1833 dep->endpoint.max_streams = 15;
1834 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1835 list_add_tail(&dep->endpoint.ep_list,
1836 &dwc->gadget.ep_list);
1838 ret = dwc3_alloc_trb_pool(dep);
1843 if (epnum == 0 || epnum == 1) {
1844 dep->endpoint.caps.type_control = true;
1846 dep->endpoint.caps.type_iso = true;
1847 dep->endpoint.caps.type_bulk = true;
1848 dep->endpoint.caps.type_int = true;
1851 dep->endpoint.caps.dir_in = !!direction;
1852 dep->endpoint.caps.dir_out = !direction;
1854 INIT_LIST_HEAD(&dep->pending_list);
1855 INIT_LIST_HEAD(&dep->started_list);
1861 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1865 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1867 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1869 dwc3_trace(trace_dwc3_gadget,
1870 "failed to allocate OUT endpoints");
1874 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1876 dwc3_trace(trace_dwc3_gadget,
1877 "failed to allocate IN endpoints");
1884 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1886 struct dwc3_ep *dep;
1889 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1890 dep = dwc->eps[epnum];
1894 * Physical endpoints 0 and 1 are special; they form the
1895 * bi-directional USB endpoint 0.
1897 * For those two physical endpoints, we don't allocate a TRB
1898 * pool nor do we add them the endpoints list. Due to that, we
1899 * shouldn't do these two operations otherwise we would end up
1900 * with all sorts of bugs when removing dwc3.ko.
1902 if (epnum != 0 && epnum != 1) {
1903 dwc3_free_trb_pool(dep);
1904 list_del(&dep->endpoint.ep_list);
1911 /* -------------------------------------------------------------------------- */
1913 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1914 struct dwc3_request *req, struct dwc3_trb *trb,
1915 const struct dwc3_event_depevt *event, int status)
1918 unsigned int s_pkt = 0;
1919 unsigned int trb_status;
1921 trace_dwc3_complete_trb(dep, trb);
1923 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1925 * We continue despite the error. There is not much we
1926 * can do. If we don't clean it up we loop forever. If
1927 * we skip the TRB then it gets overwritten after a
1928 * while since we use them in a ring buffer. A BUG()
1929 * would help. Lets hope that if this occurs, someone
1930 * fixes the root cause instead of looking away :)
1932 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1934 count = trb->size & DWC3_TRB_SIZE_MASK;
1936 if (dep->direction) {
1938 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1939 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1940 dwc3_trace(trace_dwc3_gadget,
1941 "%s: incomplete IN transfer\n",
1944 * If missed isoc occurred and there is
1945 * no request queued then issue END
1946 * TRANSFER, so that core generates
1947 * next xfernotready and we will issue
1948 * a fresh START TRANSFER.
1949 * If there are still queued request
1950 * then wait, do not issue either END
1951 * or UPDATE TRANSFER, just attach next
1952 * request in pending_list during
1953 * giveback.If any future queued request
1954 * is successfully transferred then we
1955 * will issue UPDATE TRANSFER for all
1956 * request in the pending_list.
1958 dep->flags |= DWC3_EP_MISSED_ISOC;
1960 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1962 status = -ECONNRESET;
1965 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1968 if (count && (event->status & DEPEVT_STATUS_SHORT))
1973 * We assume here we will always receive the entire data block
1974 * which we should receive. Meaning, if we program RX to
1975 * receive 4K but we receive only 2K, we assume that's all we
1976 * should receive and we simply bounce the request back to the
1977 * gadget driver for further processing.
1979 req->request.actual += req->request.length - count;
1982 if ((event->status & DEPEVT_STATUS_LST) &&
1983 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1984 DWC3_TRB_CTRL_HWO)))
1986 if ((event->status & DEPEVT_STATUS_IOC) &&
1987 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1992 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1993 const struct dwc3_event_depevt *event, int status)
1995 struct dwc3_request *req;
1996 struct dwc3_trb *trb;
2002 req = next_request(&dep->started_list);
2003 if (WARN_ON_ONCE(!req))
2008 slot = req->first_trb_index + i;
2009 if (slot == DWC3_TRB_NUM - 1)
2011 slot %= DWC3_TRB_NUM;
2012 trb = &dep->trb_pool[slot];
2014 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2018 } while (++i < req->request.num_mapped_sgs);
2020 dwc3_gadget_giveback(dep, req, status);
2027 * Our endpoint might get disabled by another thread during
2028 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2029 * early on so DWC3_EP_BUSY flag gets cleared
2031 if (!dep->endpoint.desc)
2034 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2035 list_empty(&dep->started_list)) {
2036 if (list_empty(&dep->pending_list)) {
2038 * If there is no entry in request list then do
2039 * not issue END TRANSFER now. Just set PENDING
2040 * flag, so that END TRANSFER is issued when an
2041 * entry is added into request list.
2043 dep->flags = DWC3_EP_PENDING_REQUEST;
2045 dwc3_stop_active_transfer(dwc, dep->number, true);
2046 dep->flags = DWC3_EP_ENABLED;
2051 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
2052 if ((event->status & DEPEVT_STATUS_IOC) &&
2053 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2058 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2059 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2061 unsigned status = 0;
2063 u32 is_xfer_complete;
2065 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2067 if (event->status & DEPEVT_STATUS_BUSERR)
2068 status = -ECONNRESET;
2070 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2071 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2072 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2073 dep->flags &= ~DWC3_EP_BUSY;
2076 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2077 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2079 if (dwc->revision < DWC3_REVISION_183A) {
2083 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2086 if (!(dep->flags & DWC3_EP_ENABLED))
2089 if (!list_empty(&dep->started_list))
2093 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2095 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2101 * Our endpoint might get disabled by another thread during
2102 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2103 * early on so DWC3_EP_BUSY flag gets cleared
2105 if (!dep->endpoint.desc)
2108 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2111 ret = __dwc3_gadget_kick_transfer(dep, 0);
2112 if (!ret || ret == -EBUSY)
2117 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2118 const struct dwc3_event_depevt *event)
2120 struct dwc3_ep *dep;
2121 u8 epnum = event->endpoint_number;
2123 dep = dwc->eps[epnum];
2125 if (!(dep->flags & DWC3_EP_ENABLED))
2128 if (epnum == 0 || epnum == 1) {
2129 dwc3_ep0_interrupt(dwc, event);
2133 switch (event->endpoint_event) {
2134 case DWC3_DEPEVT_XFERCOMPLETE:
2135 dep->resource_index = 0;
2137 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2138 dwc3_trace(trace_dwc3_gadget,
2139 "%s is an Isochronous endpoint\n",
2144 dwc3_endpoint_transfer_complete(dwc, dep, event);
2146 case DWC3_DEPEVT_XFERINPROGRESS:
2147 dwc3_endpoint_transfer_complete(dwc, dep, event);
2149 case DWC3_DEPEVT_XFERNOTREADY:
2150 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2151 dwc3_gadget_start_isoc(dwc, dep, event);
2156 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2158 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2159 dep->name, active ? "Transfer Active"
2160 : "Transfer Not Active");
2162 ret = __dwc3_gadget_kick_transfer(dep, 0);
2163 if (!ret || ret == -EBUSY)
2166 dwc3_trace(trace_dwc3_gadget,
2167 "%s: failed to kick transfers\n",
2172 case DWC3_DEPEVT_STREAMEVT:
2173 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2174 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2179 switch (event->status) {
2180 case DEPEVT_STREAMEVT_FOUND:
2181 dwc3_trace(trace_dwc3_gadget,
2182 "Stream %d found and started",
2186 case DEPEVT_STREAMEVT_NOTFOUND:
2189 dwc3_trace(trace_dwc3_gadget,
2190 "unable to find suitable stream\n");
2193 case DWC3_DEPEVT_RXTXFIFOEVT:
2194 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun\n", dep->name);
2196 case DWC3_DEPEVT_EPCMDCMPLT:
2197 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2202 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2204 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2205 spin_unlock(&dwc->lock);
2206 dwc->gadget_driver->disconnect(&dwc->gadget);
2207 spin_lock(&dwc->lock);
2211 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2213 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2214 spin_unlock(&dwc->lock);
2215 dwc->gadget_driver->suspend(&dwc->gadget);
2216 spin_lock(&dwc->lock);
2220 static void dwc3_resume_gadget(struct dwc3 *dwc)
2222 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2223 spin_unlock(&dwc->lock);
2224 dwc->gadget_driver->resume(&dwc->gadget);
2225 spin_lock(&dwc->lock);
2229 static void dwc3_reset_gadget(struct dwc3 *dwc)
2231 if (!dwc->gadget_driver)
2234 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2235 spin_unlock(&dwc->lock);
2236 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2237 spin_lock(&dwc->lock);
2241 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2243 struct dwc3_ep *dep;
2244 struct dwc3_gadget_ep_cmd_params params;
2248 dep = dwc->eps[epnum];
2250 if (!dep->resource_index)
2254 * NOTICE: We are violating what the Databook says about the
2255 * EndTransfer command. Ideally we would _always_ wait for the
2256 * EndTransfer Command Completion IRQ, but that's causing too
2257 * much trouble synchronizing between us and gadget driver.
2259 * We have discussed this with the IP Provider and it was
2260 * suggested to giveback all requests here, but give HW some
2261 * extra time to synchronize with the interconnect. We're using
2262 * an arbitrary 100us delay for that.
2264 * Note also that a similar handling was tested by Synopsys
2265 * (thanks a lot Paul) and nothing bad has come out of it.
2266 * In short, what we're doing is:
2268 * - Issue EndTransfer WITH CMDIOC bit set
2272 cmd = DWC3_DEPCMD_ENDTRANSFER;
2273 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2274 cmd |= DWC3_DEPCMD_CMDIOC;
2275 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2276 memset(¶ms, 0, sizeof(params));
2277 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2279 dep->resource_index = 0;
2280 dep->flags &= ~DWC3_EP_BUSY;
2284 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2288 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2289 struct dwc3_ep *dep;
2291 dep = dwc->eps[epnum];
2295 if (!(dep->flags & DWC3_EP_ENABLED))
2298 dwc3_remove_requests(dwc, dep);
2302 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2306 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2307 struct dwc3_ep *dep;
2310 dep = dwc->eps[epnum];
2314 if (!(dep->flags & DWC3_EP_STALL))
2317 dep->flags &= ~DWC3_EP_STALL;
2319 ret = dwc3_send_clear_stall_ep_cmd(dep);
2324 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2328 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2329 reg &= ~DWC3_DCTL_INITU1ENA;
2330 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2332 reg &= ~DWC3_DCTL_INITU2ENA;
2333 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2335 dwc3_disconnect_gadget(dwc);
2337 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2338 dwc->setup_packet_pending = false;
2339 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2341 dwc->connected = false;
2344 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2348 dwc->connected = true;
2351 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2352 * would cause a missing Disconnect Event if there's a
2353 * pending Setup Packet in the FIFO.
2355 * There's no suggested workaround on the official Bug
2356 * report, which states that "unless the driver/application
2357 * is doing any special handling of a disconnect event,
2358 * there is no functional issue".
2360 * Unfortunately, it turns out that we _do_ some special
2361 * handling of a disconnect event, namely complete all
2362 * pending transfers, notify gadget driver of the
2363 * disconnection, and so on.
2365 * Our suggested workaround is to follow the Disconnect
2366 * Event steps here, instead, based on a setup_packet_pending
2367 * flag. Such flag gets set whenever we have a SETUP_PENDING
2368 * status for EP0 TRBs and gets cleared on XferComplete for the
2373 * STAR#9000466709: RTL: Device : Disconnect event not
2374 * generated if setup packet pending in FIFO
2376 if (dwc->revision < DWC3_REVISION_188A) {
2377 if (dwc->setup_packet_pending)
2378 dwc3_gadget_disconnect_interrupt(dwc);
2381 dwc3_reset_gadget(dwc);
2383 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2384 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2385 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2386 dwc->test_mode = false;
2388 dwc3_stop_active_transfers(dwc);
2389 dwc3_clear_stall_all_ep(dwc);
2391 /* Reset device address to zero */
2392 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2393 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2394 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2397 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2400 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2403 * We change the clock only at SS but I dunno why I would want to do
2404 * this. Maybe it becomes part of the power saving plan.
2407 if (speed != DWC3_DSTS_SUPERSPEED)
2411 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2412 * each time on Connect Done.
2417 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2418 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2419 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2422 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2424 struct dwc3_ep *dep;
2429 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2430 speed = reg & DWC3_DSTS_CONNECTSPD;
2433 dwc3_update_ram_clk_sel(dwc, speed);
2436 case DWC3_DCFG_SUPERSPEED:
2438 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2439 * would cause a missing USB3 Reset event.
2441 * In such situations, we should force a USB3 Reset
2442 * event by calling our dwc3_gadget_reset_interrupt()
2447 * STAR#9000483510: RTL: SS : USB3 reset event may
2448 * not be generated always when the link enters poll
2450 if (dwc->revision < DWC3_REVISION_190A)
2451 dwc3_gadget_reset_interrupt(dwc);
2453 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2454 dwc->gadget.ep0->maxpacket = 512;
2455 dwc->gadget.speed = USB_SPEED_SUPER;
2457 case DWC3_DCFG_HIGHSPEED:
2458 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2459 dwc->gadget.ep0->maxpacket = 64;
2460 dwc->gadget.speed = USB_SPEED_HIGH;
2462 case DWC3_DCFG_FULLSPEED2:
2463 case DWC3_DCFG_FULLSPEED1:
2464 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2465 dwc->gadget.ep0->maxpacket = 64;
2466 dwc->gadget.speed = USB_SPEED_FULL;
2468 case DWC3_DCFG_LOWSPEED:
2469 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2470 dwc->gadget.ep0->maxpacket = 8;
2471 dwc->gadget.speed = USB_SPEED_LOW;
2475 /* Enable USB2 LPM Capability */
2477 if ((dwc->revision > DWC3_REVISION_194A)
2478 && (speed != DWC3_DCFG_SUPERSPEED)) {
2479 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2480 reg |= DWC3_DCFG_LPM_CAP;
2481 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2483 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2484 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2486 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2489 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2490 * DCFG.LPMCap is set, core responses with an ACK and the
2491 * BESL value in the LPM token is less than or equal to LPM
2494 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2495 && dwc->has_lpm_erratum,
2496 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2498 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2499 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2501 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2503 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2504 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2505 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2509 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2512 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2517 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2520 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2525 * Configure PHY via GUSB3PIPECTLn if required.
2527 * Update GTXFIFOSIZn
2529 * In both cases reset values should be sufficient.
2533 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2536 * TODO take core out of low power mode when that's
2540 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2541 spin_unlock(&dwc->lock);
2542 dwc->gadget_driver->resume(&dwc->gadget);
2543 spin_lock(&dwc->lock);
2547 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2548 unsigned int evtinfo)
2550 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2551 unsigned int pwropt;
2554 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2555 * Hibernation mode enabled which would show up when device detects
2556 * host-initiated U3 exit.
2558 * In that case, device will generate a Link State Change Interrupt
2559 * from U3 to RESUME which is only necessary if Hibernation is
2562 * There are no functional changes due to such spurious event and we
2563 * just need to ignore it.
2567 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2570 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2571 if ((dwc->revision < DWC3_REVISION_250A) &&
2572 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2573 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2574 (next == DWC3_LINK_STATE_RESUME)) {
2575 dwc3_trace(trace_dwc3_gadget,
2576 "ignoring transition U3 -> Resume");
2582 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2583 * on the link partner, the USB session might do multiple entry/exit
2584 * of low power states before a transfer takes place.
2586 * Due to this problem, we might experience lower throughput. The
2587 * suggested workaround is to disable DCTL[12:9] bits if we're
2588 * transitioning from U1/U2 to U0 and enable those bits again
2589 * after a transfer completes and there are no pending transfers
2590 * on any of the enabled endpoints.
2592 * This is the first half of that workaround.
2596 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2597 * core send LGO_Ux entering U0
2599 if (dwc->revision < DWC3_REVISION_183A) {
2600 if (next == DWC3_LINK_STATE_U0) {
2604 switch (dwc->link_state) {
2605 case DWC3_LINK_STATE_U1:
2606 case DWC3_LINK_STATE_U2:
2607 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2608 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2609 | DWC3_DCTL_ACCEPTU2ENA
2610 | DWC3_DCTL_INITU1ENA
2611 | DWC3_DCTL_ACCEPTU1ENA);
2614 dwc->u1u2 = reg & u1u2;
2618 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2628 case DWC3_LINK_STATE_U1:
2629 if (dwc->speed == USB_SPEED_SUPER)
2630 dwc3_suspend_gadget(dwc);
2632 case DWC3_LINK_STATE_U2:
2633 case DWC3_LINK_STATE_U3:
2634 dwc3_suspend_gadget(dwc);
2636 case DWC3_LINK_STATE_RESUME:
2637 dwc3_resume_gadget(dwc);
2644 dwc->link_state = next;
2647 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2648 unsigned int evtinfo)
2650 unsigned int is_ss = evtinfo & BIT(4);
2653 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2654 * have a known issue which can cause USB CV TD.9.23 to fail
2657 * Because of this issue, core could generate bogus hibernation
2658 * events which SW needs to ignore.
2662 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2663 * Device Fallback from SuperSpeed
2665 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2668 /* enter hibernation here */
2671 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2672 const struct dwc3_event_devt *event)
2674 switch (event->type) {
2675 case DWC3_DEVICE_EVENT_DISCONNECT:
2676 dwc3_gadget_disconnect_interrupt(dwc);
2678 case DWC3_DEVICE_EVENT_RESET:
2679 dwc3_gadget_reset_interrupt(dwc);
2681 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2682 dwc3_gadget_conndone_interrupt(dwc);
2684 case DWC3_DEVICE_EVENT_WAKEUP:
2685 dwc3_gadget_wakeup_interrupt(dwc);
2687 case DWC3_DEVICE_EVENT_HIBER_REQ:
2688 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2689 "unexpected hibernation event\n"))
2692 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2694 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2695 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2697 case DWC3_DEVICE_EVENT_EOPF:
2698 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2700 case DWC3_DEVICE_EVENT_SOF:
2701 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2703 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2704 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2706 case DWC3_DEVICE_EVENT_CMD_CMPL:
2707 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2709 case DWC3_DEVICE_EVENT_OVERFLOW:
2710 dwc3_trace(trace_dwc3_gadget, "Overflow");
2713 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2717 static void dwc3_process_event_entry(struct dwc3 *dwc,
2718 const union dwc3_event *event)
2720 trace_dwc3_event(event->raw);
2722 /* Endpoint IRQ, handle it and return early */
2723 if (event->type.is_devspec == 0) {
2725 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2728 switch (event->type.type) {
2729 case DWC3_EVENT_TYPE_DEV:
2730 dwc3_gadget_interrupt(dwc, &event->devt);
2732 /* REVISIT what to do with Carkit and I2C events ? */
2734 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2738 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2740 struct dwc3 *dwc = evt->dwc;
2741 irqreturn_t ret = IRQ_NONE;
2747 if (!(evt->flags & DWC3_EVENT_PENDING))
2751 union dwc3_event event;
2753 event.raw = *(u32 *) (evt->buf + evt->lpos);
2755 dwc3_process_event_entry(dwc, &event);
2758 * FIXME we wrap around correctly to the next entry as
2759 * almost all entries are 4 bytes in size. There is one
2760 * entry which has 12 bytes which is a regular entry
2761 * followed by 8 bytes data. ATM I don't know how
2762 * things are organized if we get next to the a
2763 * boundary so I worry about that once we try to handle
2766 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2769 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2773 evt->flags &= ~DWC3_EVENT_PENDING;
2776 /* Unmask interrupt */
2777 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2778 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2779 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2784 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2786 struct dwc3_event_buffer *evt = _evt;
2787 struct dwc3 *dwc = evt->dwc;
2788 unsigned long flags;
2789 irqreturn_t ret = IRQ_NONE;
2791 spin_lock_irqsave(&dwc->lock, flags);
2792 ret = dwc3_process_event_buf(evt);
2793 spin_unlock_irqrestore(&dwc->lock, flags);
2798 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2800 struct dwc3 *dwc = evt->dwc;
2804 if (pm_runtime_suspended(dwc->dev)) {
2805 pm_runtime_get(dwc->dev);
2806 disable_irq_nosync(dwc->irq_gadget);
2807 dwc->pending_events = true;
2811 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2812 count &= DWC3_GEVNTCOUNT_MASK;
2817 evt->flags |= DWC3_EVENT_PENDING;
2819 /* Mask interrupt */
2820 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2821 reg |= DWC3_GEVNTSIZ_INTMASK;
2822 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2824 return IRQ_WAKE_THREAD;
2827 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2829 struct dwc3_event_buffer *evt = _evt;
2831 return dwc3_check_event_buf(evt);
2835 * dwc3_gadget_init - Initializes gadget related registers
2836 * @dwc: pointer to our controller context structure
2838 * Returns 0 on success otherwise negative errno.
2840 int dwc3_gadget_init(struct dwc3 *dwc)
2844 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2845 &dwc->ctrl_req_addr, GFP_KERNEL);
2846 if (!dwc->ctrl_req) {
2847 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2852 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2853 &dwc->ep0_trb_addr, GFP_KERNEL);
2854 if (!dwc->ep0_trb) {
2855 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2860 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2861 if (!dwc->setup_buf) {
2866 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2867 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2869 if (!dwc->ep0_bounce) {
2870 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2875 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2876 if (!dwc->zlp_buf) {
2881 dwc->gadget.ops = &dwc3_gadget_ops;
2882 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2883 dwc->gadget.sg_supported = true;
2884 dwc->gadget.name = "dwc3-gadget";
2885 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2888 * FIXME We might be setting max_speed to <SUPER, however versions
2889 * <2.20a of dwc3 have an issue with metastability (documented
2890 * elsewhere in this driver) which tells us we can't set max speed to
2891 * anything lower than SUPER.
2893 * Because gadget.max_speed is only used by composite.c and function
2894 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2895 * to happen so we avoid sending SuperSpeed Capability descriptor
2896 * together with our BOS descriptor as that could confuse host into
2897 * thinking we can handle super speed.
2899 * Note that, in fact, we won't even support GetBOS requests when speed
2900 * is less than super speed because we don't have means, yet, to tell
2901 * composite.c that we are USB 2.0 + LPM ECN.
2903 if (dwc->revision < DWC3_REVISION_220A)
2904 dwc3_trace(trace_dwc3_gadget,
2905 "Changing max_speed on rev %08x\n",
2908 dwc->gadget.max_speed = dwc->maximum_speed;
2911 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2914 dwc->gadget.quirk_ep_out_aligned_size = true;
2917 * REVISIT: Here we should clear all pending IRQs to be
2918 * sure we're starting from a well known location.
2921 ret = dwc3_gadget_init_endpoints(dwc);
2925 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2927 dev_err(dwc->dev, "failed to register udc\n");
2934 kfree(dwc->zlp_buf);
2937 dwc3_gadget_free_endpoints(dwc);
2938 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2939 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2942 kfree(dwc->setup_buf);
2945 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2946 dwc->ep0_trb, dwc->ep0_trb_addr);
2949 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2950 dwc->ctrl_req, dwc->ctrl_req_addr);
2956 /* -------------------------------------------------------------------------- */
2958 void dwc3_gadget_exit(struct dwc3 *dwc)
2960 usb_del_gadget_udc(&dwc->gadget);
2962 dwc3_gadget_free_endpoints(dwc);
2964 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2965 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2967 kfree(dwc->setup_buf);
2968 kfree(dwc->zlp_buf);
2970 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2971 dwc->ep0_trb, dwc->ep0_trb_addr);
2973 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2974 dwc->ctrl_req, dwc->ctrl_req_addr);
2977 int dwc3_gadget_suspend(struct dwc3 *dwc)
2981 if (!dwc->gadget_driver)
2984 ret = dwc3_gadget_run_stop(dwc, false, false);
2988 dwc3_disconnect_gadget(dwc);
2989 __dwc3_gadget_stop(dwc);
2994 int dwc3_gadget_resume(struct dwc3 *dwc)
2998 if (!dwc->gadget_driver)
3001 ret = __dwc3_gadget_start(dwc);
3005 ret = dwc3_gadget_run_stop(dwc, true, false);
3012 __dwc3_gadget_stop(dwc);
3018 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3020 if (dwc->pending_events) {
3021 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3022 dwc->pending_events = false;
3023 enable_irq(dwc->irq_gadget);