Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next
[linux-2.6.git] / drivers / usb / dwc3 / gadget.c
blobb5e5b35df49c8ff49ca5817ced0838e79dad9ccf
1 /**
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 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2, as published by the Free
24 * Software Foundation.
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
27 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
28 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
30 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <linux/kernel.h>
40 #include <linux/delay.h>
41 #include <linux/slab.h>
42 #include <linux/spinlock.h>
43 #include <linux/platform_device.h>
44 #include <linux/pm_runtime.h>
45 #include <linux/interrupt.h>
46 #include <linux/io.h>
47 #include <linux/list.h>
48 #include <linux/dma-mapping.h>
50 #include <linux/usb/ch9.h>
51 #include <linux/usb/gadget.h>
53 #include "core.h"
54 #include "gadget.h"
55 #include "io.h"
57 /**
58 * dwc3_gadget_set_test_mode - Enables USB2 Test Modes
59 * @dwc: pointer to our context structure
60 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
62 * Caller should take care of locking. This function will
63 * return 0 on success or -EINVAL if wrong Test Selector
64 * is passed
66 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
68 u32 reg;
70 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
71 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
73 switch (mode) {
74 case TEST_J:
75 case TEST_K:
76 case TEST_SE0_NAK:
77 case TEST_PACKET:
78 case TEST_FORCE_EN:
79 reg |= mode << 1;
80 break;
81 default:
82 return -EINVAL;
85 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
87 return 0;
90 /**
91 * dwc3_gadget_set_link_state - Sets USB Link to a particular State
92 * @dwc: pointer to our context structure
93 * @state: the state to put link into
95 * Caller should take care of locking. This function will
96 * return 0 on success or -ETIMEDOUT.
98 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
100 int retries = 10000;
101 u32 reg;
104 * Wait until device controller is ready. Only applies to 1.94a and
105 * later RTL.
107 if (dwc->revision >= DWC3_REVISION_194A) {
108 while (--retries) {
109 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
110 if (reg & DWC3_DSTS_DCNRD)
111 udelay(5);
112 else
113 break;
116 if (retries <= 0)
117 return -ETIMEDOUT;
120 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
121 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
123 /* set requested state */
124 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
125 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
128 * The following code is racy when called from dwc3_gadget_wakeup,
129 * and is not needed, at least on newer versions
131 if (dwc->revision >= DWC3_REVISION_194A)
132 return 0;
134 /* wait for a change in DSTS */
135 retries = 10000;
136 while (--retries) {
137 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
139 if (DWC3_DSTS_USBLNKST(reg) == state)
140 return 0;
142 udelay(5);
145 dev_vdbg(dwc->dev, "link state change request timed out\n");
147 return -ETIMEDOUT;
151 * dwc3_gadget_resize_tx_fifos - reallocate fifo spaces for current use-case
152 * @dwc: pointer to our context structure
154 * This function will a best effort FIFO allocation in order
155 * to improve FIFO usage and throughput, while still allowing
156 * us to enable as many endpoints as possible.
158 * Keep in mind that this operation will be highly dependent
159 * on the configured size for RAM1 - which contains TxFifo -,
160 * the amount of endpoints enabled on coreConsultant tool, and
161 * the width of the Master Bus.
163 * In the ideal world, we would always be able to satisfy the
164 * following equation:
166 * ((512 + 2 * MDWIDTH-Bytes) + (Number of IN Endpoints - 1) * \
167 * (3 * (1024 + MDWIDTH-Bytes) + MDWIDTH-Bytes)) / MDWIDTH-Bytes
169 * Unfortunately, due to many variables that's not always the case.
171 int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc)
173 int last_fifo_depth = 0;
174 int ram1_depth;
175 int fifo_size;
176 int mdwidth;
177 int num;
179 if (!dwc->needs_fifo_resize)
180 return 0;
182 ram1_depth = DWC3_RAM1_DEPTH(dwc->hwparams.hwparams7);
183 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
185 /* MDWIDTH is represented in bits, we need it in bytes */
186 mdwidth >>= 3;
189 * FIXME For now we will only allocate 1 wMaxPacketSize space
190 * for each enabled endpoint, later patches will come to
191 * improve this algorithm so that we better use the internal
192 * FIFO space
194 for (num = 0; num < DWC3_ENDPOINTS_NUM; num++) {
195 struct dwc3_ep *dep = dwc->eps[num];
196 int fifo_number = dep->number >> 1;
197 int mult = 1;
198 int tmp;
200 if (!(dep->number & 1))
201 continue;
203 if (!(dep->flags & DWC3_EP_ENABLED))
204 continue;
206 if (usb_endpoint_xfer_bulk(dep->endpoint.desc)
207 || usb_endpoint_xfer_isoc(dep->endpoint.desc))
208 mult = 3;
211 * REVISIT: the following assumes we will always have enough
212 * space available on the FIFO RAM for all possible use cases.
213 * Make sure that's true somehow and change FIFO allocation
214 * accordingly.
216 * If we have Bulk or Isochronous endpoints, we want
217 * them to be able to be very, very fast. So we're giving
218 * those endpoints a fifo_size which is enough for 3 full
219 * packets
221 tmp = mult * (dep->endpoint.maxpacket + mdwidth);
222 tmp += mdwidth;
224 fifo_size = DIV_ROUND_UP(tmp, mdwidth);
226 fifo_size |= (last_fifo_depth << 16);
228 dev_vdbg(dwc->dev, "%s: Fifo Addr %04x Size %d\n",
229 dep->name, last_fifo_depth, fifo_size & 0xffff);
231 dwc3_writel(dwc->regs, DWC3_GTXFIFOSIZ(fifo_number),
232 fifo_size);
234 last_fifo_depth += (fifo_size & 0xffff);
237 return 0;
240 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
241 int status)
243 struct dwc3 *dwc = dep->dwc;
244 int i;
246 if (req->queued) {
247 i = 0;
248 do {
249 dep->busy_slot++;
251 * Skip LINK TRB. We can't use req->trb and check for
252 * DWC3_TRBCTL_LINK_TRB because it points the TRB we
253 * just completed (not the LINK TRB).
255 if (((dep->busy_slot & DWC3_TRB_MASK) ==
256 DWC3_TRB_NUM- 1) &&
257 usb_endpoint_xfer_isoc(dep->endpoint.desc))
258 dep->busy_slot++;
259 } while(++i < req->request.num_mapped_sgs);
260 req->queued = false;
262 list_del(&req->list);
263 req->trb = NULL;
265 if (req->request.status == -EINPROGRESS)
266 req->request.status = status;
268 if (dwc->ep0_bounced && dep->number == 0)
269 dwc->ep0_bounced = false;
270 else
271 usb_gadget_unmap_request(&dwc->gadget, &req->request,
272 req->direction);
274 dev_dbg(dwc->dev, "request %p from %s completed %d/%d ===> %d\n",
275 req, dep->name, req->request.actual,
276 req->request.length, status);
278 spin_unlock(&dwc->lock);
279 req->request.complete(&dep->endpoint, &req->request);
280 spin_lock(&dwc->lock);
283 static const char *dwc3_gadget_ep_cmd_string(u8 cmd)
285 switch (cmd) {
286 case DWC3_DEPCMD_DEPSTARTCFG:
287 return "Start New Configuration";
288 case DWC3_DEPCMD_ENDTRANSFER:
289 return "End Transfer";
290 case DWC3_DEPCMD_UPDATETRANSFER:
291 return "Update Transfer";
292 case DWC3_DEPCMD_STARTTRANSFER:
293 return "Start Transfer";
294 case DWC3_DEPCMD_CLEARSTALL:
295 return "Clear Stall";
296 case DWC3_DEPCMD_SETSTALL:
297 return "Set Stall";
298 case DWC3_DEPCMD_GETEPSTATE:
299 return "Get Endpoint State";
300 case DWC3_DEPCMD_SETTRANSFRESOURCE:
301 return "Set Endpoint Transfer Resource";
302 case DWC3_DEPCMD_SETEPCONFIG:
303 return "Set Endpoint Configuration";
304 default:
305 return "UNKNOWN command";
309 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, int cmd, u32 param)
311 u32 timeout = 500;
312 u32 reg;
314 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
315 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
317 do {
318 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
319 if (!(reg & DWC3_DGCMD_CMDACT)) {
320 dev_vdbg(dwc->dev, "Command Complete --> %d\n",
321 DWC3_DGCMD_STATUS(reg));
322 return 0;
326 * We can't sleep here, because it's also called from
327 * interrupt context.
329 timeout--;
330 if (!timeout)
331 return -ETIMEDOUT;
332 udelay(1);
333 } while (1);
336 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
337 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
339 struct dwc3_ep *dep = dwc->eps[ep];
340 u32 timeout = 500;
341 u32 reg;
343 dev_vdbg(dwc->dev, "%s: cmd '%s' params %08x %08x %08x\n",
344 dep->name,
345 dwc3_gadget_ep_cmd_string(cmd), params->param0,
346 params->param1, params->param2);
348 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
349 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
350 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
352 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
353 do {
354 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
355 if (!(reg & DWC3_DEPCMD_CMDACT)) {
356 dev_vdbg(dwc->dev, "Command Complete --> %d\n",
357 DWC3_DEPCMD_STATUS(reg));
358 return 0;
362 * We can't sleep here, because it is also called from
363 * interrupt context.
365 timeout--;
366 if (!timeout)
367 return -ETIMEDOUT;
369 udelay(1);
370 } while (1);
373 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
374 struct dwc3_trb *trb)
376 u32 offset = (char *) trb - (char *) dep->trb_pool;
378 return dep->trb_pool_dma + offset;
381 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
383 struct dwc3 *dwc = dep->dwc;
385 if (dep->trb_pool)
386 return 0;
388 if (dep->number == 0 || dep->number == 1)
389 return 0;
391 dep->trb_pool = dma_alloc_coherent(dwc->dev,
392 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
393 &dep->trb_pool_dma, GFP_KERNEL);
394 if (!dep->trb_pool) {
395 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
396 dep->name);
397 return -ENOMEM;
400 return 0;
403 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
405 struct dwc3 *dwc = dep->dwc;
407 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
408 dep->trb_pool, dep->trb_pool_dma);
410 dep->trb_pool = NULL;
411 dep->trb_pool_dma = 0;
414 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
416 struct dwc3_gadget_ep_cmd_params params;
417 u32 cmd;
419 memset(&params, 0x00, sizeof(params));
421 if (dep->number != 1) {
422 cmd = DWC3_DEPCMD_DEPSTARTCFG;
423 /* XferRscIdx == 0 for ep0 and 2 for the remaining */
424 if (dep->number > 1) {
425 if (dwc->start_config_issued)
426 return 0;
427 dwc->start_config_issued = true;
428 cmd |= DWC3_DEPCMD_PARAM(2);
431 return dwc3_send_gadget_ep_cmd(dwc, 0, cmd, &params);
434 return 0;
437 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
438 const struct usb_endpoint_descriptor *desc,
439 const struct usb_ss_ep_comp_descriptor *comp_desc,
440 bool ignore)
442 struct dwc3_gadget_ep_cmd_params params;
444 memset(&params, 0x00, sizeof(params));
446 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
447 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
449 /* Burst size is only needed in SuperSpeed mode */
450 if (dwc->gadget.speed == USB_SPEED_SUPER) {
451 u32 burst = dep->endpoint.maxburst - 1;
453 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst);
456 if (ignore)
457 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
459 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
460 | DWC3_DEPCFG_XFER_NOT_READY_EN;
462 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
463 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
464 | DWC3_DEPCFG_STREAM_EVENT_EN;
465 dep->stream_capable = true;
468 if (usb_endpoint_xfer_isoc(desc))
469 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
472 * We are doing 1:1 mapping for endpoints, meaning
473 * Physical Endpoints 2 maps to Logical Endpoint 2 and
474 * so on. We consider the direction bit as part of the physical
475 * endpoint number. So USB endpoint 0x81 is 0x03.
477 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
480 * We must use the lower 16 TX FIFOs even though
481 * HW might have more
483 if (dep->direction)
484 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
486 if (desc->bInterval) {
487 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
488 dep->interval = 1 << (desc->bInterval - 1);
491 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
492 DWC3_DEPCMD_SETEPCONFIG, &params);
495 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
497 struct dwc3_gadget_ep_cmd_params params;
499 memset(&params, 0x00, sizeof(params));
501 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
503 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
504 DWC3_DEPCMD_SETTRANSFRESOURCE, &params);
508 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
509 * @dep: endpoint to be initialized
510 * @desc: USB Endpoint Descriptor
512 * Caller should take care of locking
514 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
515 const struct usb_endpoint_descriptor *desc,
516 const struct usb_ss_ep_comp_descriptor *comp_desc,
517 bool ignore)
519 struct dwc3 *dwc = dep->dwc;
520 u32 reg;
521 int ret = -ENOMEM;
523 if (!(dep->flags & DWC3_EP_ENABLED)) {
524 ret = dwc3_gadget_start_config(dwc, dep);
525 if (ret)
526 return ret;
529 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore);
530 if (ret)
531 return ret;
533 if (!(dep->flags & DWC3_EP_ENABLED)) {
534 struct dwc3_trb *trb_st_hw;
535 struct dwc3_trb *trb_link;
537 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
538 if (ret)
539 return ret;
541 dep->endpoint.desc = desc;
542 dep->comp_desc = comp_desc;
543 dep->type = usb_endpoint_type(desc);
544 dep->flags |= DWC3_EP_ENABLED;
546 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
547 reg |= DWC3_DALEPENA_EP(dep->number);
548 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
550 if (!usb_endpoint_xfer_isoc(desc))
551 return 0;
553 memset(&trb_link, 0, sizeof(trb_link));
555 /* Link TRB for ISOC. The HWO bit is never reset */
556 trb_st_hw = &dep->trb_pool[0];
558 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
560 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
561 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
562 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
563 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
566 return 0;
569 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum);
570 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
572 struct dwc3_request *req;
574 if (!list_empty(&dep->req_queued)) {
575 dwc3_stop_active_transfer(dwc, dep->number);
577 /* - giveback all requests to gadget driver */
578 while (!list_empty(&dep->req_queued)) {
579 req = next_request(&dep->req_queued);
581 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
585 while (!list_empty(&dep->request_list)) {
586 req = next_request(&dep->request_list);
588 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
593 * __dwc3_gadget_ep_disable - Disables a HW endpoint
594 * @dep: the endpoint to disable
596 * This function also removes requests which are currently processed ny the
597 * hardware and those which are not yet scheduled.
598 * Caller should take care of locking.
600 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
602 struct dwc3 *dwc = dep->dwc;
603 u32 reg;
605 dwc3_remove_requests(dwc, dep);
607 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
608 reg &= ~DWC3_DALEPENA_EP(dep->number);
609 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
611 dep->stream_capable = false;
612 dep->endpoint.desc = NULL;
613 dep->comp_desc = NULL;
614 dep->type = 0;
615 dep->flags = 0;
617 return 0;
620 /* -------------------------------------------------------------------------- */
622 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
623 const struct usb_endpoint_descriptor *desc)
625 return -EINVAL;
628 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
630 return -EINVAL;
633 /* -------------------------------------------------------------------------- */
635 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
636 const struct usb_endpoint_descriptor *desc)
638 struct dwc3_ep *dep;
639 struct dwc3 *dwc;
640 unsigned long flags;
641 int ret;
643 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
644 pr_debug("dwc3: invalid parameters\n");
645 return -EINVAL;
648 if (!desc->wMaxPacketSize) {
649 pr_debug("dwc3: missing wMaxPacketSize\n");
650 return -EINVAL;
653 dep = to_dwc3_ep(ep);
654 dwc = dep->dwc;
656 if (dep->flags & DWC3_EP_ENABLED) {
657 dev_WARN_ONCE(dwc->dev, true, "%s is already enabled\n",
658 dep->name);
659 return 0;
662 switch (usb_endpoint_type(desc)) {
663 case USB_ENDPOINT_XFER_CONTROL:
664 strlcat(dep->name, "-control", sizeof(dep->name));
665 break;
666 case USB_ENDPOINT_XFER_ISOC:
667 strlcat(dep->name, "-isoc", sizeof(dep->name));
668 break;
669 case USB_ENDPOINT_XFER_BULK:
670 strlcat(dep->name, "-bulk", sizeof(dep->name));
671 break;
672 case USB_ENDPOINT_XFER_INT:
673 strlcat(dep->name, "-int", sizeof(dep->name));
674 break;
675 default:
676 dev_err(dwc->dev, "invalid endpoint transfer type\n");
679 dev_vdbg(dwc->dev, "Enabling %s\n", dep->name);
681 spin_lock_irqsave(&dwc->lock, flags);
682 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false);
683 spin_unlock_irqrestore(&dwc->lock, flags);
685 return ret;
688 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
690 struct dwc3_ep *dep;
691 struct dwc3 *dwc;
692 unsigned long flags;
693 int ret;
695 if (!ep) {
696 pr_debug("dwc3: invalid parameters\n");
697 return -EINVAL;
700 dep = to_dwc3_ep(ep);
701 dwc = dep->dwc;
703 if (!(dep->flags & DWC3_EP_ENABLED)) {
704 dev_WARN_ONCE(dwc->dev, true, "%s is already disabled\n",
705 dep->name);
706 return 0;
709 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
710 dep->number >> 1,
711 (dep->number & 1) ? "in" : "out");
713 spin_lock_irqsave(&dwc->lock, flags);
714 ret = __dwc3_gadget_ep_disable(dep);
715 spin_unlock_irqrestore(&dwc->lock, flags);
717 return ret;
720 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
721 gfp_t gfp_flags)
723 struct dwc3_request *req;
724 struct dwc3_ep *dep = to_dwc3_ep(ep);
725 struct dwc3 *dwc = dep->dwc;
727 req = kzalloc(sizeof(*req), gfp_flags);
728 if (!req) {
729 dev_err(dwc->dev, "not enough memory\n");
730 return NULL;
733 req->epnum = dep->number;
734 req->dep = dep;
736 return &req->request;
739 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
740 struct usb_request *request)
742 struct dwc3_request *req = to_dwc3_request(request);
744 kfree(req);
748 * dwc3_prepare_one_trb - setup one TRB from one request
749 * @dep: endpoint for which this request is prepared
750 * @req: dwc3_request pointer
752 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
753 struct dwc3_request *req, dma_addr_t dma,
754 unsigned length, unsigned last, unsigned chain, unsigned node)
756 struct dwc3 *dwc = dep->dwc;
757 struct dwc3_trb *trb;
759 dev_vdbg(dwc->dev, "%s: req %p dma %08llx length %d%s%s\n",
760 dep->name, req, (unsigned long long) dma,
761 length, last ? " last" : "",
762 chain ? " chain" : "");
764 /* Skip the LINK-TRB on ISOC */
765 if (((dep->free_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
766 usb_endpoint_xfer_isoc(dep->endpoint.desc))
767 dep->free_slot++;
769 trb = &dep->trb_pool[dep->free_slot & DWC3_TRB_MASK];
771 if (!req->trb) {
772 dwc3_gadget_move_request_queued(req);
773 req->trb = trb;
774 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
775 req->start_slot = dep->free_slot & DWC3_TRB_MASK;
778 dep->free_slot++;
780 trb->size = DWC3_TRB_SIZE_LENGTH(length);
781 trb->bpl = lower_32_bits(dma);
782 trb->bph = upper_32_bits(dma);
784 switch (usb_endpoint_type(dep->endpoint.desc)) {
785 case USB_ENDPOINT_XFER_CONTROL:
786 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
787 break;
789 case USB_ENDPOINT_XFER_ISOC:
790 if (!node)
791 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
792 else
793 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
795 if (!req->request.no_interrupt && !chain)
796 trb->ctrl |= DWC3_TRB_CTRL_IOC;
797 break;
799 case USB_ENDPOINT_XFER_BULK:
800 case USB_ENDPOINT_XFER_INT:
801 trb->ctrl = DWC3_TRBCTL_NORMAL;
802 break;
803 default:
805 * This is only possible with faulty memory because we
806 * checked it already :)
808 BUG();
811 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
812 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
813 trb->ctrl |= DWC3_TRB_CTRL_CSP;
814 } else if (last) {
815 trb->ctrl |= DWC3_TRB_CTRL_LST;
818 if (chain)
819 trb->ctrl |= DWC3_TRB_CTRL_CHN;
821 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
822 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
824 trb->ctrl |= DWC3_TRB_CTRL_HWO;
828 * dwc3_prepare_trbs - setup TRBs from requests
829 * @dep: endpoint for which requests are being prepared
830 * @starting: true if the endpoint is idle and no requests are queued.
832 * The function goes through the requests list and sets up TRBs for the
833 * transfers. The function returns once there are no more TRBs available or
834 * it runs out of requests.
836 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
838 struct dwc3_request *req, *n;
839 u32 trbs_left;
840 u32 max;
841 unsigned int last_one = 0;
843 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
845 /* the first request must not be queued */
846 trbs_left = (dep->busy_slot - dep->free_slot) & DWC3_TRB_MASK;
848 /* Can't wrap around on a non-isoc EP since there's no link TRB */
849 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
850 max = DWC3_TRB_NUM - (dep->free_slot & DWC3_TRB_MASK);
851 if (trbs_left > max)
852 trbs_left = max;
856 * If busy & slot are equal than it is either full or empty. If we are
857 * starting to process requests then we are empty. Otherwise we are
858 * full and don't do anything
860 if (!trbs_left) {
861 if (!starting)
862 return;
863 trbs_left = DWC3_TRB_NUM;
865 * In case we start from scratch, we queue the ISOC requests
866 * starting from slot 1. This is done because we use ring
867 * buffer and have no LST bit to stop us. Instead, we place
868 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
869 * after the first request so we start at slot 1 and have
870 * 7 requests proceed before we hit the first IOC.
871 * Other transfer types don't use the ring buffer and are
872 * processed from the first TRB until the last one. Since we
873 * don't wrap around we have to start at the beginning.
875 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
876 dep->busy_slot = 1;
877 dep->free_slot = 1;
878 } else {
879 dep->busy_slot = 0;
880 dep->free_slot = 0;
884 /* The last TRB is a link TRB, not used for xfer */
885 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->endpoint.desc))
886 return;
888 list_for_each_entry_safe(req, n, &dep->request_list, list) {
889 unsigned length;
890 dma_addr_t dma;
891 last_one = false;
893 if (req->request.num_mapped_sgs > 0) {
894 struct usb_request *request = &req->request;
895 struct scatterlist *sg = request->sg;
896 struct scatterlist *s;
897 int i;
899 for_each_sg(sg, s, request->num_mapped_sgs, i) {
900 unsigned chain = true;
902 length = sg_dma_len(s);
903 dma = sg_dma_address(s);
905 if (i == (request->num_mapped_sgs - 1) ||
906 sg_is_last(s)) {
907 if (list_is_last(&req->list,
908 &dep->request_list))
909 last_one = true;
910 chain = false;
913 trbs_left--;
914 if (!trbs_left)
915 last_one = true;
917 if (last_one)
918 chain = false;
920 dwc3_prepare_one_trb(dep, req, dma, length,
921 last_one, chain, i);
923 if (last_one)
924 break;
926 } else {
927 dma = req->request.dma;
928 length = req->request.length;
929 trbs_left--;
931 if (!trbs_left)
932 last_one = 1;
934 /* Is this the last request? */
935 if (list_is_last(&req->list, &dep->request_list))
936 last_one = 1;
938 dwc3_prepare_one_trb(dep, req, dma, length,
939 last_one, false, 0);
941 if (last_one)
942 break;
947 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
948 int start_new)
950 struct dwc3_gadget_ep_cmd_params params;
951 struct dwc3_request *req;
952 struct dwc3 *dwc = dep->dwc;
953 int ret;
954 u32 cmd;
956 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
957 dev_vdbg(dwc->dev, "%s: endpoint busy\n", dep->name);
958 return -EBUSY;
960 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
963 * If we are getting here after a short-out-packet we don't enqueue any
964 * new requests as we try to set the IOC bit only on the last request.
966 if (start_new) {
967 if (list_empty(&dep->req_queued))
968 dwc3_prepare_trbs(dep, start_new);
970 /* req points to the first request which will be sent */
971 req = next_request(&dep->req_queued);
972 } else {
973 dwc3_prepare_trbs(dep, start_new);
976 * req points to the first request where HWO changed from 0 to 1
978 req = next_request(&dep->req_queued);
980 if (!req) {
981 dep->flags |= DWC3_EP_PENDING_REQUEST;
982 return 0;
985 memset(&params, 0, sizeof(params));
987 if (start_new) {
988 params.param0 = upper_32_bits(req->trb_dma);
989 params.param1 = lower_32_bits(req->trb_dma);
990 cmd = DWC3_DEPCMD_STARTTRANSFER;
991 } else {
992 cmd = DWC3_DEPCMD_UPDATETRANSFER;
995 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
996 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, &params);
997 if (ret < 0) {
998 dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");
1001 * FIXME we need to iterate over the list of requests
1002 * here and stop, unmap, free and del each of the linked
1003 * requests instead of what we do now.
1005 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1006 req->direction);
1007 list_del(&req->list);
1008 return ret;
1011 dep->flags |= DWC3_EP_BUSY;
1013 if (start_new) {
1014 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
1015 dep->number);
1016 WARN_ON_ONCE(!dep->resource_index);
1019 return 0;
1022 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1023 struct dwc3_ep *dep, u32 cur_uf)
1025 u32 uf;
1027 if (list_empty(&dep->request_list)) {
1028 dev_vdbg(dwc->dev, "ISOC ep %s run out for requests.\n",
1029 dep->name);
1030 dep->flags |= DWC3_EP_PENDING_REQUEST;
1031 return;
1034 /* 4 micro frames in the future */
1035 uf = cur_uf + dep->interval * 4;
1037 __dwc3_gadget_kick_transfer(dep, uf, 1);
1040 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1041 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1043 u32 cur_uf, mask;
1045 mask = ~(dep->interval - 1);
1046 cur_uf = event->parameters & mask;
1048 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1051 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1053 struct dwc3 *dwc = dep->dwc;
1054 int ret;
1056 req->request.actual = 0;
1057 req->request.status = -EINPROGRESS;
1058 req->direction = dep->direction;
1059 req->epnum = dep->number;
1062 * We only add to our list of requests now and
1063 * start consuming the list once we get XferNotReady
1064 * IRQ.
1066 * That way, we avoid doing anything that we don't need
1067 * to do now and defer it until the point we receive a
1068 * particular token from the Host side.
1070 * This will also avoid Host cancelling URBs due to too
1071 * many NAKs.
1073 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1074 dep->direction);
1075 if (ret)
1076 return ret;
1078 list_add_tail(&req->list, &dep->request_list);
1081 * There are a few special cases:
1083 * 1. XferNotReady with empty list of requests. We need to kick the
1084 * transfer here in that situation, otherwise we will be NAKing
1085 * forever. If we get XferNotReady before gadget driver has a
1086 * chance to queue a request, we will ACK the IRQ but won't be
1087 * able to receive the data until the next request is queued.
1088 * The following code is handling exactly that.
1091 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1093 * If xfernotready is already elapsed and it is a case
1094 * of isoc transfer, then issue END TRANSFER, so that
1095 * you can receive xfernotready again and can have
1096 * notion of current microframe.
1098 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1099 if (list_empty(&dep->req_queued)) {
1100 dwc3_stop_active_transfer(dwc, dep->number);
1101 dep->flags = DWC3_EP_ENABLED;
1103 return 0;
1106 ret = __dwc3_gadget_kick_transfer(dep, 0, true);
1107 if (ret && ret != -EBUSY)
1108 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1109 dep->name);
1110 return ret;
1114 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1115 * kick the transfer here after queuing a request, otherwise the
1116 * core may not see the modified TRB(s).
1118 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1119 (dep->flags & DWC3_EP_BUSY) &&
1120 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1121 WARN_ON_ONCE(!dep->resource_index);
1122 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index,
1123 false);
1124 if (ret && ret != -EBUSY)
1125 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1126 dep->name);
1127 return ret;
1130 return 0;
1133 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1134 gfp_t gfp_flags)
1136 struct dwc3_request *req = to_dwc3_request(request);
1137 struct dwc3_ep *dep = to_dwc3_ep(ep);
1138 struct dwc3 *dwc = dep->dwc;
1140 unsigned long flags;
1142 int ret;
1144 if (!dep->endpoint.desc) {
1145 dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",
1146 request, ep->name);
1147 return -ESHUTDOWN;
1150 dev_vdbg(dwc->dev, "queing request %p to %s length %d\n",
1151 request, ep->name, request->length);
1153 spin_lock_irqsave(&dwc->lock, flags);
1154 ret = __dwc3_gadget_ep_queue(dep, req);
1155 spin_unlock_irqrestore(&dwc->lock, flags);
1157 return ret;
1160 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1161 struct usb_request *request)
1163 struct dwc3_request *req = to_dwc3_request(request);
1164 struct dwc3_request *r = NULL;
1166 struct dwc3_ep *dep = to_dwc3_ep(ep);
1167 struct dwc3 *dwc = dep->dwc;
1169 unsigned long flags;
1170 int ret = 0;
1172 spin_lock_irqsave(&dwc->lock, flags);
1174 list_for_each_entry(r, &dep->request_list, list) {
1175 if (r == req)
1176 break;
1179 if (r != req) {
1180 list_for_each_entry(r, &dep->req_queued, list) {
1181 if (r == req)
1182 break;
1184 if (r == req) {
1185 /* wait until it is processed */
1186 dwc3_stop_active_transfer(dwc, dep->number);
1187 goto out1;
1189 dev_err(dwc->dev, "request %p was not queued to %s\n",
1190 request, ep->name);
1191 ret = -EINVAL;
1192 goto out0;
1195 out1:
1196 /* giveback the request */
1197 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1199 out0:
1200 spin_unlock_irqrestore(&dwc->lock, flags);
1202 return ret;
1205 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value)
1207 struct dwc3_gadget_ep_cmd_params params;
1208 struct dwc3 *dwc = dep->dwc;
1209 int ret;
1211 memset(&params, 0x00, sizeof(params));
1213 if (value) {
1214 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1215 DWC3_DEPCMD_SETSTALL, &params);
1216 if (ret)
1217 dev_err(dwc->dev, "failed to %s STALL on %s\n",
1218 value ? "set" : "clear",
1219 dep->name);
1220 else
1221 dep->flags |= DWC3_EP_STALL;
1222 } else {
1223 if (dep->flags & DWC3_EP_WEDGE)
1224 return 0;
1226 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1227 DWC3_DEPCMD_CLEARSTALL, &params);
1228 if (ret)
1229 dev_err(dwc->dev, "failed to %s STALL on %s\n",
1230 value ? "set" : "clear",
1231 dep->name);
1232 else
1233 dep->flags &= ~DWC3_EP_STALL;
1236 return ret;
1239 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1241 struct dwc3_ep *dep = to_dwc3_ep(ep);
1242 struct dwc3 *dwc = dep->dwc;
1244 unsigned long flags;
1246 int ret;
1248 spin_lock_irqsave(&dwc->lock, flags);
1250 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1251 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1252 ret = -EINVAL;
1253 goto out;
1256 ret = __dwc3_gadget_ep_set_halt(dep, value);
1257 out:
1258 spin_unlock_irqrestore(&dwc->lock, flags);
1260 return ret;
1263 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1265 struct dwc3_ep *dep = to_dwc3_ep(ep);
1266 struct dwc3 *dwc = dep->dwc;
1267 unsigned long flags;
1269 spin_lock_irqsave(&dwc->lock, flags);
1270 dep->flags |= DWC3_EP_WEDGE;
1271 spin_unlock_irqrestore(&dwc->lock, flags);
1273 if (dep->number == 0 || dep->number == 1)
1274 return dwc3_gadget_ep0_set_halt(ep, 1);
1275 else
1276 return dwc3_gadget_ep_set_halt(ep, 1);
1279 /* -------------------------------------------------------------------------- */
1281 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1282 .bLength = USB_DT_ENDPOINT_SIZE,
1283 .bDescriptorType = USB_DT_ENDPOINT,
1284 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1287 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1288 .enable = dwc3_gadget_ep0_enable,
1289 .disable = dwc3_gadget_ep0_disable,
1290 .alloc_request = dwc3_gadget_ep_alloc_request,
1291 .free_request = dwc3_gadget_ep_free_request,
1292 .queue = dwc3_gadget_ep0_queue,
1293 .dequeue = dwc3_gadget_ep_dequeue,
1294 .set_halt = dwc3_gadget_ep0_set_halt,
1295 .set_wedge = dwc3_gadget_ep_set_wedge,
1298 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1299 .enable = dwc3_gadget_ep_enable,
1300 .disable = dwc3_gadget_ep_disable,
1301 .alloc_request = dwc3_gadget_ep_alloc_request,
1302 .free_request = dwc3_gadget_ep_free_request,
1303 .queue = dwc3_gadget_ep_queue,
1304 .dequeue = dwc3_gadget_ep_dequeue,
1305 .set_halt = dwc3_gadget_ep_set_halt,
1306 .set_wedge = dwc3_gadget_ep_set_wedge,
1309 /* -------------------------------------------------------------------------- */
1311 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1313 struct dwc3 *dwc = gadget_to_dwc(g);
1314 u32 reg;
1316 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1317 return DWC3_DSTS_SOFFN(reg);
1320 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1322 struct dwc3 *dwc = gadget_to_dwc(g);
1324 unsigned long timeout;
1325 unsigned long flags;
1327 u32 reg;
1329 int ret = 0;
1331 u8 link_state;
1332 u8 speed;
1334 spin_lock_irqsave(&dwc->lock, flags);
1337 * According to the Databook Remote wakeup request should
1338 * be issued only when the device is in early suspend state.
1340 * We can check that via USB Link State bits in DSTS register.
1342 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1344 speed = reg & DWC3_DSTS_CONNECTSPD;
1345 if (speed == DWC3_DSTS_SUPERSPEED) {
1346 dev_dbg(dwc->dev, "no wakeup on SuperSpeed\n");
1347 ret = -EINVAL;
1348 goto out;
1351 link_state = DWC3_DSTS_USBLNKST(reg);
1353 switch (link_state) {
1354 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1355 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1356 break;
1357 default:
1358 dev_dbg(dwc->dev, "can't wakeup from link state %d\n",
1359 link_state);
1360 ret = -EINVAL;
1361 goto out;
1364 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1365 if (ret < 0) {
1366 dev_err(dwc->dev, "failed to put link in Recovery\n");
1367 goto out;
1370 /* Recent versions do this automatically */
1371 if (dwc->revision < DWC3_REVISION_194A) {
1372 /* write zeroes to Link Change Request */
1373 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1374 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1375 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1378 /* poll until Link State changes to ON */
1379 timeout = jiffies + msecs_to_jiffies(100);
1381 while (!time_after(jiffies, timeout)) {
1382 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1384 /* in HS, means ON */
1385 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1386 break;
1389 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1390 dev_err(dwc->dev, "failed to send remote wakeup\n");
1391 ret = -EINVAL;
1394 out:
1395 spin_unlock_irqrestore(&dwc->lock, flags);
1397 return ret;
1400 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1401 int is_selfpowered)
1403 struct dwc3 *dwc = gadget_to_dwc(g);
1404 unsigned long flags;
1406 spin_lock_irqsave(&dwc->lock, flags);
1407 dwc->is_selfpowered = !!is_selfpowered;
1408 spin_unlock_irqrestore(&dwc->lock, flags);
1410 return 0;
1413 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on)
1415 u32 reg;
1416 u32 timeout = 500;
1418 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1419 if (is_on) {
1420 if (dwc->revision <= DWC3_REVISION_187A) {
1421 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1422 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1425 if (dwc->revision >= DWC3_REVISION_194A)
1426 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1427 reg |= DWC3_DCTL_RUN_STOP;
1428 dwc->pullups_connected = true;
1429 } else {
1430 reg &= ~DWC3_DCTL_RUN_STOP;
1431 dwc->pullups_connected = false;
1434 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1436 do {
1437 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1438 if (is_on) {
1439 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1440 break;
1441 } else {
1442 if (reg & DWC3_DSTS_DEVCTRLHLT)
1443 break;
1445 timeout--;
1446 if (!timeout)
1447 return -ETIMEDOUT;
1448 udelay(1);
1449 } while (1);
1451 dev_vdbg(dwc->dev, "gadget %s data soft-%s\n",
1452 dwc->gadget_driver
1453 ? dwc->gadget_driver->function : "no-function",
1454 is_on ? "connect" : "disconnect");
1456 return 0;
1459 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1461 struct dwc3 *dwc = gadget_to_dwc(g);
1462 unsigned long flags;
1463 int ret;
1465 is_on = !!is_on;
1467 spin_lock_irqsave(&dwc->lock, flags);
1468 ret = dwc3_gadget_run_stop(dwc, is_on);
1469 spin_unlock_irqrestore(&dwc->lock, flags);
1471 return ret;
1474 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1476 u32 reg;
1478 /* Enable all but Start and End of Frame IRQs */
1479 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1480 DWC3_DEVTEN_EVNTOVERFLOWEN |
1481 DWC3_DEVTEN_CMDCMPLTEN |
1482 DWC3_DEVTEN_ERRTICERREN |
1483 DWC3_DEVTEN_WKUPEVTEN |
1484 DWC3_DEVTEN_ULSTCNGEN |
1485 DWC3_DEVTEN_CONNECTDONEEN |
1486 DWC3_DEVTEN_USBRSTEN |
1487 DWC3_DEVTEN_DISCONNEVTEN);
1489 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1492 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1494 /* mask all interrupts */
1495 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1498 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1499 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1501 static int dwc3_gadget_start(struct usb_gadget *g,
1502 struct usb_gadget_driver *driver)
1504 struct dwc3 *dwc = gadget_to_dwc(g);
1505 struct dwc3_ep *dep;
1506 unsigned long flags;
1507 int ret = 0;
1508 int irq;
1509 u32 reg;
1511 spin_lock_irqsave(&dwc->lock, flags);
1513 if (dwc->gadget_driver) {
1514 dev_err(dwc->dev, "%s is already bound to %s\n",
1515 dwc->gadget.name,
1516 dwc->gadget_driver->driver.name);
1517 ret = -EBUSY;
1518 goto err0;
1521 dwc->gadget_driver = driver;
1523 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1524 reg &= ~(DWC3_DCFG_SPEED_MASK);
1527 * WORKAROUND: DWC3 revision < 2.20a have an issue
1528 * which would cause metastability state on Run/Stop
1529 * bit if we try to force the IP to USB2-only mode.
1531 * Because of that, we cannot configure the IP to any
1532 * speed other than the SuperSpeed
1534 * Refers to:
1536 * STAR#9000525659: Clock Domain Crossing on DCTL in
1537 * USB 2.0 Mode
1539 if (dwc->revision < DWC3_REVISION_220A)
1540 reg |= DWC3_DCFG_SUPERSPEED;
1541 else
1542 reg |= dwc->maximum_speed;
1543 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1545 dwc->start_config_issued = false;
1547 /* Start with SuperSpeed Default */
1548 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1550 dep = dwc->eps[0];
1551 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false);
1552 if (ret) {
1553 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1554 goto err0;
1557 dep = dwc->eps[1];
1558 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false);
1559 if (ret) {
1560 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1561 goto err1;
1564 /* begin to receive SETUP packets */
1565 dwc->ep0state = EP0_SETUP_PHASE;
1566 dwc3_ep0_out_start(dwc);
1568 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1569 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1570 IRQF_SHARED | IRQF_ONESHOT, "dwc3", dwc);
1571 if (ret) {
1572 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1573 irq, ret);
1574 goto err1;
1577 dwc3_gadget_enable_irq(dwc);
1579 spin_unlock_irqrestore(&dwc->lock, flags);
1581 return 0;
1583 err1:
1584 __dwc3_gadget_ep_disable(dwc->eps[0]);
1586 err0:
1587 spin_unlock_irqrestore(&dwc->lock, flags);
1589 return ret;
1592 static int dwc3_gadget_stop(struct usb_gadget *g,
1593 struct usb_gadget_driver *driver)
1595 struct dwc3 *dwc = gadget_to_dwc(g);
1596 unsigned long flags;
1597 int irq;
1599 spin_lock_irqsave(&dwc->lock, flags);
1601 dwc3_gadget_disable_irq(dwc);
1602 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1603 free_irq(irq, dwc);
1605 __dwc3_gadget_ep_disable(dwc->eps[0]);
1606 __dwc3_gadget_ep_disable(dwc->eps[1]);
1608 dwc->gadget_driver = NULL;
1610 spin_unlock_irqrestore(&dwc->lock, flags);
1612 return 0;
1615 static const struct usb_gadget_ops dwc3_gadget_ops = {
1616 .get_frame = dwc3_gadget_get_frame,
1617 .wakeup = dwc3_gadget_wakeup,
1618 .set_selfpowered = dwc3_gadget_set_selfpowered,
1619 .pullup = dwc3_gadget_pullup,
1620 .udc_start = dwc3_gadget_start,
1621 .udc_stop = dwc3_gadget_stop,
1624 /* -------------------------------------------------------------------------- */
1626 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1627 u8 num, u32 direction)
1629 struct dwc3_ep *dep;
1630 u8 i;
1632 for (i = 0; i < num; i++) {
1633 u8 epnum = (i << 1) | (!!direction);
1635 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1636 if (!dep) {
1637 dev_err(dwc->dev, "can't allocate endpoint %d\n",
1638 epnum);
1639 return -ENOMEM;
1642 dep->dwc = dwc;
1643 dep->number = epnum;
1644 dwc->eps[epnum] = dep;
1646 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1647 (epnum & 1) ? "in" : "out");
1649 dep->endpoint.name = dep->name;
1650 dep->direction = (epnum & 1);
1652 if (epnum == 0 || epnum == 1) {
1653 dep->endpoint.maxpacket = 512;
1654 dep->endpoint.maxburst = 1;
1655 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1656 if (!epnum)
1657 dwc->gadget.ep0 = &dep->endpoint;
1658 } else {
1659 int ret;
1661 dep->endpoint.maxpacket = 1024;
1662 dep->endpoint.max_streams = 15;
1663 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1664 list_add_tail(&dep->endpoint.ep_list,
1665 &dwc->gadget.ep_list);
1667 ret = dwc3_alloc_trb_pool(dep);
1668 if (ret)
1669 return ret;
1672 INIT_LIST_HEAD(&dep->request_list);
1673 INIT_LIST_HEAD(&dep->req_queued);
1676 return 0;
1679 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1681 int ret;
1683 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1685 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1686 if (ret < 0) {
1687 dev_vdbg(dwc->dev, "failed to allocate OUT endpoints\n");
1688 return ret;
1691 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1692 if (ret < 0) {
1693 dev_vdbg(dwc->dev, "failed to allocate IN endpoints\n");
1694 return ret;
1697 return 0;
1700 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1702 struct dwc3_ep *dep;
1703 u8 epnum;
1705 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1706 dep = dwc->eps[epnum];
1707 if (!dep)
1708 continue;
1710 * Physical endpoints 0 and 1 are special; they form the
1711 * bi-directional USB endpoint 0.
1713 * For those two physical endpoints, we don't allocate a TRB
1714 * pool nor do we add them the endpoints list. Due to that, we
1715 * shouldn't do these two operations otherwise we would end up
1716 * with all sorts of bugs when removing dwc3.ko.
1718 if (epnum != 0 && epnum != 1) {
1719 dwc3_free_trb_pool(dep);
1720 list_del(&dep->endpoint.ep_list);
1723 kfree(dep);
1727 /* -------------------------------------------------------------------------- */
1729 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1730 struct dwc3_request *req, struct dwc3_trb *trb,
1731 const struct dwc3_event_depevt *event, int status)
1733 unsigned int count;
1734 unsigned int s_pkt = 0;
1735 unsigned int trb_status;
1737 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1739 * We continue despite the error. There is not much we
1740 * can do. If we don't clean it up we loop forever. If
1741 * we skip the TRB then it gets overwritten after a
1742 * while since we use them in a ring buffer. A BUG()
1743 * would help. Lets hope that if this occurs, someone
1744 * fixes the root cause instead of looking away :)
1746 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1747 dep->name, trb);
1748 count = trb->size & DWC3_TRB_SIZE_MASK;
1750 if (dep->direction) {
1751 if (count) {
1752 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1753 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1754 dev_dbg(dwc->dev, "incomplete IN transfer %s\n",
1755 dep->name);
1757 * If missed isoc occurred and there is
1758 * no request queued then issue END
1759 * TRANSFER, so that core generates
1760 * next xfernotready and we will issue
1761 * a fresh START TRANSFER.
1762 * If there are still queued request
1763 * then wait, do not issue either END
1764 * or UPDATE TRANSFER, just attach next
1765 * request in request_list during
1766 * giveback.If any future queued request
1767 * is successfully transferred then we
1768 * will issue UPDATE TRANSFER for all
1769 * request in the request_list.
1771 dep->flags |= DWC3_EP_MISSED_ISOC;
1772 } else {
1773 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1774 dep->name);
1775 status = -ECONNRESET;
1777 } else {
1778 dep->flags &= ~DWC3_EP_MISSED_ISOC;
1780 } else {
1781 if (count && (event->status & DEPEVT_STATUS_SHORT))
1782 s_pkt = 1;
1786 * We assume here we will always receive the entire data block
1787 * which we should receive. Meaning, if we program RX to
1788 * receive 4K but we receive only 2K, we assume that's all we
1789 * should receive and we simply bounce the request back to the
1790 * gadget driver for further processing.
1792 req->request.actual += req->request.length - count;
1793 if (s_pkt)
1794 return 1;
1795 if ((event->status & DEPEVT_STATUS_LST) &&
1796 (trb->ctrl & (DWC3_TRB_CTRL_LST |
1797 DWC3_TRB_CTRL_HWO)))
1798 return 1;
1799 if ((event->status & DEPEVT_STATUS_IOC) &&
1800 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1801 return 1;
1802 return 0;
1805 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1806 const struct dwc3_event_depevt *event, int status)
1808 struct dwc3_request *req;
1809 struct dwc3_trb *trb;
1810 unsigned int slot;
1811 unsigned int i;
1812 int ret;
1814 do {
1815 req = next_request(&dep->req_queued);
1816 if (!req) {
1817 WARN_ON_ONCE(1);
1818 return 1;
1820 i = 0;
1821 do {
1822 slot = req->start_slot + i;
1823 if ((slot == DWC3_TRB_NUM - 1) &&
1824 usb_endpoint_xfer_isoc(dep->endpoint.desc))
1825 slot++;
1826 slot %= DWC3_TRB_NUM;
1827 trb = &dep->trb_pool[slot];
1829 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
1830 event, status);
1831 if (ret)
1832 break;
1833 }while (++i < req->request.num_mapped_sgs);
1835 dwc3_gadget_giveback(dep, req, status);
1837 if (ret)
1838 break;
1839 } while (1);
1841 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1842 list_empty(&dep->req_queued)) {
1843 if (list_empty(&dep->request_list)) {
1845 * If there is no entry in request list then do
1846 * not issue END TRANSFER now. Just set PENDING
1847 * flag, so that END TRANSFER is issued when an
1848 * entry is added into request list.
1850 dep->flags = DWC3_EP_PENDING_REQUEST;
1851 } else {
1852 dwc3_stop_active_transfer(dwc, dep->number);
1853 dep->flags = DWC3_EP_ENABLED;
1855 return 1;
1858 if ((event->status & DEPEVT_STATUS_IOC) &&
1859 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1860 return 0;
1861 return 1;
1864 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
1865 struct dwc3_ep *dep, const struct dwc3_event_depevt *event,
1866 int start_new)
1868 unsigned status = 0;
1869 int clean_busy;
1871 if (event->status & DEPEVT_STATUS_BUSERR)
1872 status = -ECONNRESET;
1874 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
1875 if (clean_busy)
1876 dep->flags &= ~DWC3_EP_BUSY;
1879 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
1880 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
1882 if (dwc->revision < DWC3_REVISION_183A) {
1883 u32 reg;
1884 int i;
1886 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
1887 dep = dwc->eps[i];
1889 if (!(dep->flags & DWC3_EP_ENABLED))
1890 continue;
1892 if (!list_empty(&dep->req_queued))
1893 return;
1896 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1897 reg |= dwc->u1u2;
1898 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1900 dwc->u1u2 = 0;
1904 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
1905 const struct dwc3_event_depevt *event)
1907 struct dwc3_ep *dep;
1908 u8 epnum = event->endpoint_number;
1910 dep = dwc->eps[epnum];
1912 if (!(dep->flags & DWC3_EP_ENABLED))
1913 return;
1915 dev_vdbg(dwc->dev, "%s: %s\n", dep->name,
1916 dwc3_ep_event_string(event->endpoint_event));
1918 if (epnum == 0 || epnum == 1) {
1919 dwc3_ep0_interrupt(dwc, event);
1920 return;
1923 switch (event->endpoint_event) {
1924 case DWC3_DEPEVT_XFERCOMPLETE:
1925 dep->resource_index = 0;
1927 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1928 dev_dbg(dwc->dev, "%s is an Isochronous endpoint\n",
1929 dep->name);
1930 return;
1933 dwc3_endpoint_transfer_complete(dwc, dep, event, 1);
1934 break;
1935 case DWC3_DEPEVT_XFERINPROGRESS:
1936 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1937 dev_dbg(dwc->dev, "%s is not an Isochronous endpoint\n",
1938 dep->name);
1939 return;
1942 dwc3_endpoint_transfer_complete(dwc, dep, event, 0);
1943 break;
1944 case DWC3_DEPEVT_XFERNOTREADY:
1945 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1946 dwc3_gadget_start_isoc(dwc, dep, event);
1947 } else {
1948 int ret;
1950 dev_vdbg(dwc->dev, "%s: reason %s\n",
1951 dep->name, event->status &
1952 DEPEVT_STATUS_TRANSFER_ACTIVE
1953 ? "Transfer Active"
1954 : "Transfer Not Active");
1956 ret = __dwc3_gadget_kick_transfer(dep, 0, 1);
1957 if (!ret || ret == -EBUSY)
1958 return;
1960 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1961 dep->name);
1964 break;
1965 case DWC3_DEPEVT_STREAMEVT:
1966 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
1967 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
1968 dep->name);
1969 return;
1972 switch (event->status) {
1973 case DEPEVT_STREAMEVT_FOUND:
1974 dev_vdbg(dwc->dev, "Stream %d found and started\n",
1975 event->parameters);
1977 break;
1978 case DEPEVT_STREAMEVT_NOTFOUND:
1979 /* FALLTHROUGH */
1980 default:
1981 dev_dbg(dwc->dev, "Couldn't find suitable stream\n");
1983 break;
1984 case DWC3_DEPEVT_RXTXFIFOEVT:
1985 dev_dbg(dwc->dev, "%s FIFO Overrun\n", dep->name);
1986 break;
1987 case DWC3_DEPEVT_EPCMDCMPLT:
1988 dev_vdbg(dwc->dev, "Endpoint Command Complete\n");
1989 break;
1993 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
1995 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
1996 spin_unlock(&dwc->lock);
1997 dwc->gadget_driver->disconnect(&dwc->gadget);
1998 spin_lock(&dwc->lock);
2002 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum)
2004 struct dwc3_ep *dep;
2005 struct dwc3_gadget_ep_cmd_params params;
2006 u32 cmd;
2007 int ret;
2009 dep = dwc->eps[epnum];
2011 if (!dep->resource_index)
2012 return;
2015 * NOTICE: We are violating what the Databook says about the
2016 * EndTransfer command. Ideally we would _always_ wait for the
2017 * EndTransfer Command Completion IRQ, but that's causing too
2018 * much trouble synchronizing between us and gadget driver.
2020 * We have discussed this with the IP Provider and it was
2021 * suggested to giveback all requests here, but give HW some
2022 * extra time to synchronize with the interconnect. We're using
2023 * an arbitraty 100us delay for that.
2025 * Note also that a similar handling was tested by Synopsys
2026 * (thanks a lot Paul) and nothing bad has come out of it.
2027 * In short, what we're doing is:
2029 * - Issue EndTransfer WITH CMDIOC bit set
2030 * - Wait 100us
2033 cmd = DWC3_DEPCMD_ENDTRANSFER;
2034 cmd |= DWC3_DEPCMD_HIPRI_FORCERM | DWC3_DEPCMD_CMDIOC;
2035 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2036 memset(&params, 0, sizeof(params));
2037 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, &params);
2038 WARN_ON_ONCE(ret);
2039 dep->resource_index = 0;
2040 dep->flags &= ~DWC3_EP_BUSY;
2041 udelay(100);
2044 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2046 u32 epnum;
2048 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2049 struct dwc3_ep *dep;
2051 dep = dwc->eps[epnum];
2052 if (!dep)
2053 continue;
2055 if (!(dep->flags & DWC3_EP_ENABLED))
2056 continue;
2058 dwc3_remove_requests(dwc, dep);
2062 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2064 u32 epnum;
2066 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2067 struct dwc3_ep *dep;
2068 struct dwc3_gadget_ep_cmd_params params;
2069 int ret;
2071 dep = dwc->eps[epnum];
2072 if (!dep)
2073 continue;
2075 if (!(dep->flags & DWC3_EP_STALL))
2076 continue;
2078 dep->flags &= ~DWC3_EP_STALL;
2080 memset(&params, 0, sizeof(params));
2081 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
2082 DWC3_DEPCMD_CLEARSTALL, &params);
2083 WARN_ON_ONCE(ret);
2087 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2089 int reg;
2091 dev_vdbg(dwc->dev, "%s\n", __func__);
2093 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2094 reg &= ~DWC3_DCTL_INITU1ENA;
2095 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2097 reg &= ~DWC3_DCTL_INITU2ENA;
2098 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2100 dwc3_disconnect_gadget(dwc);
2101 dwc->start_config_issued = false;
2103 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2104 dwc->setup_packet_pending = false;
2107 static void dwc3_gadget_usb3_phy_suspend(struct dwc3 *dwc, int suspend)
2109 u32 reg;
2111 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
2113 if (suspend)
2114 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
2115 else
2116 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
2118 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
2121 static void dwc3_gadget_usb2_phy_suspend(struct dwc3 *dwc, int suspend)
2123 u32 reg;
2125 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
2127 if (suspend)
2128 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
2129 else
2130 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
2132 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
2135 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2137 u32 reg;
2139 dev_vdbg(dwc->dev, "%s\n", __func__);
2142 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2143 * would cause a missing Disconnect Event if there's a
2144 * pending Setup Packet in the FIFO.
2146 * There's no suggested workaround on the official Bug
2147 * report, which states that "unless the driver/application
2148 * is doing any special handling of a disconnect event,
2149 * there is no functional issue".
2151 * Unfortunately, it turns out that we _do_ some special
2152 * handling of a disconnect event, namely complete all
2153 * pending transfers, notify gadget driver of the
2154 * disconnection, and so on.
2156 * Our suggested workaround is to follow the Disconnect
2157 * Event steps here, instead, based on a setup_packet_pending
2158 * flag. Such flag gets set whenever we have a XferNotReady
2159 * event on EP0 and gets cleared on XferComplete for the
2160 * same endpoint.
2162 * Refers to:
2164 * STAR#9000466709: RTL: Device : Disconnect event not
2165 * generated if setup packet pending in FIFO
2167 if (dwc->revision < DWC3_REVISION_188A) {
2168 if (dwc->setup_packet_pending)
2169 dwc3_gadget_disconnect_interrupt(dwc);
2172 /* after reset -> Default State */
2173 usb_gadget_set_state(&dwc->gadget, USB_STATE_DEFAULT);
2175 /* Recent versions support automatic phy suspend and don't need this */
2176 if (dwc->revision < DWC3_REVISION_194A) {
2177 /* Resume PHYs */
2178 dwc3_gadget_usb2_phy_suspend(dwc, false);
2179 dwc3_gadget_usb3_phy_suspend(dwc, false);
2182 if (dwc->gadget.speed != USB_SPEED_UNKNOWN)
2183 dwc3_disconnect_gadget(dwc);
2185 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2186 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2187 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2188 dwc->test_mode = false;
2190 dwc3_stop_active_transfers(dwc);
2191 dwc3_clear_stall_all_ep(dwc);
2192 dwc->start_config_issued = false;
2194 /* Reset device address to zero */
2195 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2196 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2197 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2200 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2202 u32 reg;
2203 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2206 * We change the clock only at SS but I dunno why I would want to do
2207 * this. Maybe it becomes part of the power saving plan.
2210 if (speed != DWC3_DSTS_SUPERSPEED)
2211 return;
2214 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2215 * each time on Connect Done.
2217 if (!usb30_clock)
2218 return;
2220 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2221 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2222 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2225 static void dwc3_gadget_phy_suspend(struct dwc3 *dwc, u8 speed)
2227 switch (speed) {
2228 case USB_SPEED_SUPER:
2229 dwc3_gadget_usb2_phy_suspend(dwc, true);
2230 break;
2231 case USB_SPEED_HIGH:
2232 case USB_SPEED_FULL:
2233 case USB_SPEED_LOW:
2234 dwc3_gadget_usb3_phy_suspend(dwc, true);
2235 break;
2239 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2241 struct dwc3_ep *dep;
2242 int ret;
2243 u32 reg;
2244 u8 speed;
2246 dev_vdbg(dwc->dev, "%s\n", __func__);
2248 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2249 speed = reg & DWC3_DSTS_CONNECTSPD;
2250 dwc->speed = speed;
2252 dwc3_update_ram_clk_sel(dwc, speed);
2254 switch (speed) {
2255 case DWC3_DCFG_SUPERSPEED:
2257 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2258 * would cause a missing USB3 Reset event.
2260 * In such situations, we should force a USB3 Reset
2261 * event by calling our dwc3_gadget_reset_interrupt()
2262 * routine.
2264 * Refers to:
2266 * STAR#9000483510: RTL: SS : USB3 reset event may
2267 * not be generated always when the link enters poll
2269 if (dwc->revision < DWC3_REVISION_190A)
2270 dwc3_gadget_reset_interrupt(dwc);
2272 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2273 dwc->gadget.ep0->maxpacket = 512;
2274 dwc->gadget.speed = USB_SPEED_SUPER;
2275 break;
2276 case DWC3_DCFG_HIGHSPEED:
2277 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2278 dwc->gadget.ep0->maxpacket = 64;
2279 dwc->gadget.speed = USB_SPEED_HIGH;
2280 break;
2281 case DWC3_DCFG_FULLSPEED2:
2282 case DWC3_DCFG_FULLSPEED1:
2283 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2284 dwc->gadget.ep0->maxpacket = 64;
2285 dwc->gadget.speed = USB_SPEED_FULL;
2286 break;
2287 case DWC3_DCFG_LOWSPEED:
2288 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2289 dwc->gadget.ep0->maxpacket = 8;
2290 dwc->gadget.speed = USB_SPEED_LOW;
2291 break;
2294 /* Enable USB2 LPM Capability */
2296 if ((dwc->revision > DWC3_REVISION_194A)
2297 && (speed != DWC3_DCFG_SUPERSPEED)) {
2298 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2299 reg |= DWC3_DCFG_LPM_CAP;
2300 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2302 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2303 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2306 * TODO: This should be configurable. For now using
2307 * maximum allowed HIRD threshold value of 0b1100
2309 reg |= DWC3_DCTL_HIRD_THRES(12);
2311 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2314 /* Recent versions support automatic phy suspend and don't need this */
2315 if (dwc->revision < DWC3_REVISION_194A) {
2316 /* Suspend unneeded PHY */
2317 dwc3_gadget_phy_suspend(dwc, dwc->gadget.speed);
2320 dep = dwc->eps[0];
2321 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true);
2322 if (ret) {
2323 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2324 return;
2327 dep = dwc->eps[1];
2328 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true);
2329 if (ret) {
2330 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2331 return;
2335 * Configure PHY via GUSB3PIPECTLn if required.
2337 * Update GTXFIFOSIZn
2339 * In both cases reset values should be sufficient.
2343 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2345 dev_vdbg(dwc->dev, "%s\n", __func__);
2348 * TODO take core out of low power mode when that's
2349 * implemented.
2352 dwc->gadget_driver->resume(&dwc->gadget);
2355 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2356 unsigned int evtinfo)
2358 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2359 unsigned int pwropt;
2362 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2363 * Hibernation mode enabled which would show up when device detects
2364 * host-initiated U3 exit.
2366 * In that case, device will generate a Link State Change Interrupt
2367 * from U3 to RESUME which is only necessary if Hibernation is
2368 * configured in.
2370 * There are no functional changes due to such spurious event and we
2371 * just need to ignore it.
2373 * Refers to:
2375 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2376 * operational mode
2378 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2379 if ((dwc->revision < DWC3_REVISION_250A) &&
2380 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2381 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2382 (next == DWC3_LINK_STATE_RESUME)) {
2383 dev_vdbg(dwc->dev, "ignoring transition U3 -> Resume\n");
2384 return;
2389 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2390 * on the link partner, the USB session might do multiple entry/exit
2391 * of low power states before a transfer takes place.
2393 * Due to this problem, we might experience lower throughput. The
2394 * suggested workaround is to disable DCTL[12:9] bits if we're
2395 * transitioning from U1/U2 to U0 and enable those bits again
2396 * after a transfer completes and there are no pending transfers
2397 * on any of the enabled endpoints.
2399 * This is the first half of that workaround.
2401 * Refers to:
2403 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2404 * core send LGO_Ux entering U0
2406 if (dwc->revision < DWC3_REVISION_183A) {
2407 if (next == DWC3_LINK_STATE_U0) {
2408 u32 u1u2;
2409 u32 reg;
2411 switch (dwc->link_state) {
2412 case DWC3_LINK_STATE_U1:
2413 case DWC3_LINK_STATE_U2:
2414 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2415 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2416 | DWC3_DCTL_ACCEPTU2ENA
2417 | DWC3_DCTL_INITU1ENA
2418 | DWC3_DCTL_ACCEPTU1ENA);
2420 if (!dwc->u1u2)
2421 dwc->u1u2 = reg & u1u2;
2423 reg &= ~u1u2;
2425 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2426 break;
2427 default:
2428 /* do nothing */
2429 break;
2434 dwc->link_state = next;
2436 dev_vdbg(dwc->dev, "%s link %d\n", __func__, dwc->link_state);
2439 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2440 const struct dwc3_event_devt *event)
2442 switch (event->type) {
2443 case DWC3_DEVICE_EVENT_DISCONNECT:
2444 dwc3_gadget_disconnect_interrupt(dwc);
2445 break;
2446 case DWC3_DEVICE_EVENT_RESET:
2447 dwc3_gadget_reset_interrupt(dwc);
2448 break;
2449 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2450 dwc3_gadget_conndone_interrupt(dwc);
2451 break;
2452 case DWC3_DEVICE_EVENT_WAKEUP:
2453 dwc3_gadget_wakeup_interrupt(dwc);
2454 break;
2455 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2456 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2457 break;
2458 case DWC3_DEVICE_EVENT_EOPF:
2459 dev_vdbg(dwc->dev, "End of Periodic Frame\n");
2460 break;
2461 case DWC3_DEVICE_EVENT_SOF:
2462 dev_vdbg(dwc->dev, "Start of Periodic Frame\n");
2463 break;
2464 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2465 dev_vdbg(dwc->dev, "Erratic Error\n");
2466 break;
2467 case DWC3_DEVICE_EVENT_CMD_CMPL:
2468 dev_vdbg(dwc->dev, "Command Complete\n");
2469 break;
2470 case DWC3_DEVICE_EVENT_OVERFLOW:
2471 dev_vdbg(dwc->dev, "Overflow\n");
2472 break;
2473 default:
2474 dev_dbg(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2478 static void dwc3_process_event_entry(struct dwc3 *dwc,
2479 const union dwc3_event *event)
2481 /* Endpoint IRQ, handle it and return early */
2482 if (event->type.is_devspec == 0) {
2483 /* depevt */
2484 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2487 switch (event->type.type) {
2488 case DWC3_EVENT_TYPE_DEV:
2489 dwc3_gadget_interrupt(dwc, &event->devt);
2490 break;
2491 /* REVISIT what to do with Carkit and I2C events ? */
2492 default:
2493 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2497 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc)
2499 struct dwc3 *dwc = _dwc;
2500 unsigned long flags;
2501 irqreturn_t ret = IRQ_NONE;
2502 int i;
2504 spin_lock_irqsave(&dwc->lock, flags);
2506 for (i = 0; i < dwc->num_event_buffers; i++) {
2507 struct dwc3_event_buffer *evt;
2508 int left;
2510 evt = dwc->ev_buffs[i];
2511 left = evt->count;
2513 if (!(evt->flags & DWC3_EVENT_PENDING))
2514 continue;
2516 while (left > 0) {
2517 union dwc3_event event;
2519 event.raw = *(u32 *) (evt->buf + evt->lpos);
2521 dwc3_process_event_entry(dwc, &event);
2524 * FIXME we wrap around correctly to the next entry as
2525 * almost all entries are 4 bytes in size. There is one
2526 * entry which has 12 bytes which is a regular entry
2527 * followed by 8 bytes data. ATM I don't know how
2528 * things are organized if we get next to the a
2529 * boundary so I worry about that once we try to handle
2530 * that.
2532 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2533 left -= 4;
2535 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(i), 4);
2538 evt->count = 0;
2539 evt->flags &= ~DWC3_EVENT_PENDING;
2540 ret = IRQ_HANDLED;
2543 spin_unlock_irqrestore(&dwc->lock, flags);
2545 return ret;
2548 static irqreturn_t dwc3_process_event_buf(struct dwc3 *dwc, u32 buf)
2550 struct dwc3_event_buffer *evt;
2551 u32 count;
2553 evt = dwc->ev_buffs[buf];
2555 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(buf));
2556 count &= DWC3_GEVNTCOUNT_MASK;
2557 if (!count)
2558 return IRQ_NONE;
2560 evt->count = count;
2561 evt->flags |= DWC3_EVENT_PENDING;
2563 return IRQ_WAKE_THREAD;
2566 static irqreturn_t dwc3_interrupt(int irq, void *_dwc)
2568 struct dwc3 *dwc = _dwc;
2569 int i;
2570 irqreturn_t ret = IRQ_NONE;
2572 spin_lock(&dwc->lock);
2574 for (i = 0; i < dwc->num_event_buffers; i++) {
2575 irqreturn_t status;
2577 status = dwc3_process_event_buf(dwc, i);
2578 if (status == IRQ_WAKE_THREAD)
2579 ret = status;
2582 spin_unlock(&dwc->lock);
2584 return ret;
2588 * dwc3_gadget_init - Initializes gadget related registers
2589 * @dwc: pointer to our controller context structure
2591 * Returns 0 on success otherwise negative errno.
2593 int dwc3_gadget_init(struct dwc3 *dwc)
2595 u32 reg;
2596 int ret;
2598 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2599 &dwc->ctrl_req_addr, GFP_KERNEL);
2600 if (!dwc->ctrl_req) {
2601 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2602 ret = -ENOMEM;
2603 goto err0;
2606 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2607 &dwc->ep0_trb_addr, GFP_KERNEL);
2608 if (!dwc->ep0_trb) {
2609 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2610 ret = -ENOMEM;
2611 goto err1;
2614 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2615 if (!dwc->setup_buf) {
2616 dev_err(dwc->dev, "failed to allocate setup buffer\n");
2617 ret = -ENOMEM;
2618 goto err2;
2621 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2622 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2623 GFP_KERNEL);
2624 if (!dwc->ep0_bounce) {
2625 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2626 ret = -ENOMEM;
2627 goto err3;
2630 dwc->gadget.ops = &dwc3_gadget_ops;
2631 dwc->gadget.max_speed = USB_SPEED_SUPER;
2632 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2633 dwc->gadget.sg_supported = true;
2634 dwc->gadget.name = "dwc3-gadget";
2637 * REVISIT: Here we should clear all pending IRQs to be
2638 * sure we're starting from a well known location.
2641 ret = dwc3_gadget_init_endpoints(dwc);
2642 if (ret)
2643 goto err4;
2645 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2646 reg |= DWC3_DCFG_LPM_CAP;
2647 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2649 /* Enable USB2 LPM and automatic phy suspend only on recent versions */
2650 if (dwc->revision >= DWC3_REVISION_194A) {
2651 dwc3_gadget_usb2_phy_suspend(dwc, false);
2652 dwc3_gadget_usb3_phy_suspend(dwc, false);
2655 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2656 if (ret) {
2657 dev_err(dwc->dev, "failed to register udc\n");
2658 goto err5;
2661 return 0;
2663 err5:
2664 dwc3_gadget_free_endpoints(dwc);
2666 err4:
2667 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2668 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2670 err3:
2671 kfree(dwc->setup_buf);
2673 err2:
2674 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2675 dwc->ep0_trb, dwc->ep0_trb_addr);
2677 err1:
2678 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2679 dwc->ctrl_req, dwc->ctrl_req_addr);
2681 err0:
2682 return ret;
2685 /* -------------------------------------------------------------------------- */
2687 void dwc3_gadget_exit(struct dwc3 *dwc)
2689 usb_del_gadget_udc(&dwc->gadget);
2691 dwc3_gadget_free_endpoints(dwc);
2693 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2694 dwc->ep0_bounce, dwc->ep0_bounce_addr);
2696 kfree(dwc->setup_buf);
2698 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2699 dwc->ep0_trb, dwc->ep0_trb_addr);
2701 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2702 dwc->ctrl_req, dwc->ctrl_req_addr);
2705 int dwc3_gadget_prepare(struct dwc3 *dwc)
2707 if (dwc->pullups_connected)
2708 dwc3_gadget_disable_irq(dwc);
2710 return 0;
2713 void dwc3_gadget_complete(struct dwc3 *dwc)
2715 if (dwc->pullups_connected) {
2716 dwc3_gadget_enable_irq(dwc);
2717 dwc3_gadget_run_stop(dwc, true);
2721 int dwc3_gadget_suspend(struct dwc3 *dwc)
2723 __dwc3_gadget_ep_disable(dwc->eps[0]);
2724 __dwc3_gadget_ep_disable(dwc->eps[1]);
2726 dwc->dcfg = dwc3_readl(dwc->regs, DWC3_DCFG);
2728 return 0;
2731 int dwc3_gadget_resume(struct dwc3 *dwc)
2733 struct dwc3_ep *dep;
2734 int ret;
2736 /* Start with SuperSpeed Default */
2737 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2739 dep = dwc->eps[0];
2740 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false);
2741 if (ret)
2742 goto err0;
2744 dep = dwc->eps[1];
2745 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false);
2746 if (ret)
2747 goto err1;
2749 /* begin to receive SETUP packets */
2750 dwc->ep0state = EP0_SETUP_PHASE;
2751 dwc3_ep0_out_start(dwc);
2753 dwc3_writel(dwc->regs, DWC3_DCFG, dwc->dcfg);
2755 return 0;
2757 err1:
2758 __dwc3_gadget_ep_disable(dwc->eps[0]);
2760 err0:
2761 return ret;