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
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>
47 #include <linux/list.h>
48 #include <linux/dma-mapping.h>
50 #include <linux/usb/ch9.h>
51 #include <linux/usb/gadget.h>
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
66 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
70 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
71 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
85 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
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)
103 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
104 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
106 /* set requested state */
107 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
108 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
110 /* wait for a change in DSTS */
112 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
114 if (DWC3_DSTS_USBLNKST(reg) == state)
120 dev_vdbg(dwc->dev, "link state change request timed out\n");
126 * dwc3_gadget_resize_tx_fifos - reallocate fifo spaces for current use-case
127 * @dwc: pointer to our context structure
129 * This function will a best effort FIFO allocation in order
130 * to improve FIFO usage and throughput, while still allowing
131 * us to enable as many endpoints as possible.
133 * Keep in mind that this operation will be highly dependent
134 * on the configured size for RAM1 - which contains TxFifo -,
135 * the amount of endpoints enabled on coreConsultant tool, and
136 * the width of the Master Bus.
138 * In the ideal world, we would always be able to satisfy the
139 * following equation:
141 * ((512 + 2 * MDWIDTH-Bytes) + (Number of IN Endpoints - 1) * \
142 * (3 * (1024 + MDWIDTH-Bytes) + MDWIDTH-Bytes)) / MDWIDTH-Bytes
144 * Unfortunately, due to many variables that's not always the case.
146 int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc)
148 int last_fifo_depth = 0;
154 if (!dwc->needs_fifo_resize)
157 ram1_depth = DWC3_RAM1_DEPTH(dwc->hwparams.hwparams7);
158 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
160 /* MDWIDTH is represented in bits, we need it in bytes */
164 * FIXME For now we will only allocate 1 wMaxPacketSize space
165 * for each enabled endpoint, later patches will come to
166 * improve this algorithm so that we better use the internal
169 for (num = 0; num < DWC3_ENDPOINTS_NUM; num++) {
170 struct dwc3_ep *dep = dwc->eps[num];
171 int fifo_number = dep->number >> 1;
175 if (!(dep->number & 1))
178 if (!(dep->flags & DWC3_EP_ENABLED))
181 if (usb_endpoint_xfer_bulk(dep->desc)
182 || usb_endpoint_xfer_isoc(dep->desc))
186 * REVISIT: the following assumes we will always have enough
187 * space available on the FIFO RAM for all possible use cases.
188 * Make sure that's true somehow and change FIFO allocation
191 * If we have Bulk or Isochronous endpoints, we want
192 * them to be able to be very, very fast. So we're giving
193 * those endpoints a fifo_size which is enough for 3 full
196 tmp = mult * (dep->endpoint.maxpacket + mdwidth);
199 fifo_size = DIV_ROUND_UP(tmp, mdwidth);
201 fifo_size |= (last_fifo_depth << 16);
203 dev_vdbg(dwc->dev, "%s: Fifo Addr %04x Size %d\n",
204 dep->name, last_fifo_depth, fifo_size & 0xffff);
206 dwc3_writel(dwc->regs, DWC3_GTXFIFOSIZ(fifo_number),
209 last_fifo_depth += (fifo_size & 0xffff);
215 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
218 struct dwc3 *dwc = dep->dwc;
221 if (req->request.num_mapped_sgs)
222 dep->busy_slot += req->request.num_mapped_sgs;
227 * Skip LINK TRB. We can't use req->trb and check for
228 * DWC3_TRBCTL_LINK_TRB because it points the TRB we just
229 * completed (not the LINK TRB).
231 if (((dep->busy_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
232 usb_endpoint_xfer_isoc(dep->desc))
235 list_del(&req->list);
238 if (req->request.status == -EINPROGRESS)
239 req->request.status = status;
241 usb_gadget_unmap_request(&dwc->gadget, &req->request,
244 dev_dbg(dwc->dev, "request %p from %s completed %d/%d ===> %d\n",
245 req, dep->name, req->request.actual,
246 req->request.length, status);
248 spin_unlock(&dwc->lock);
249 req->request.complete(&dep->endpoint, &req->request);
250 spin_lock(&dwc->lock);
253 static const char *dwc3_gadget_ep_cmd_string(u8 cmd)
256 case DWC3_DEPCMD_DEPSTARTCFG:
257 return "Start New Configuration";
258 case DWC3_DEPCMD_ENDTRANSFER:
259 return "End Transfer";
260 case DWC3_DEPCMD_UPDATETRANSFER:
261 return "Update Transfer";
262 case DWC3_DEPCMD_STARTTRANSFER:
263 return "Start Transfer";
264 case DWC3_DEPCMD_CLEARSTALL:
265 return "Clear Stall";
266 case DWC3_DEPCMD_SETSTALL:
268 case DWC3_DEPCMD_GETSEQNUMBER:
269 return "Get Data Sequence Number";
270 case DWC3_DEPCMD_SETTRANSFRESOURCE:
271 return "Set Endpoint Transfer Resource";
272 case DWC3_DEPCMD_SETEPCONFIG:
273 return "Set Endpoint Configuration";
275 return "UNKNOWN command";
279 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
280 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
282 struct dwc3_ep *dep = dwc->eps[ep];
286 dev_vdbg(dwc->dev, "%s: cmd '%s' params %08x %08x %08x\n",
288 dwc3_gadget_ep_cmd_string(cmd), params->param0,
289 params->param1, params->param2);
291 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR0(ep), params->param0);
292 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR1(ep), params->param1);
293 dwc3_writel(dwc->regs, DWC3_DEPCMDPAR2(ep), params->param2);
295 dwc3_writel(dwc->regs, DWC3_DEPCMD(ep), cmd | DWC3_DEPCMD_CMDACT);
297 reg = dwc3_readl(dwc->regs, DWC3_DEPCMD(ep));
298 if (!(reg & DWC3_DEPCMD_CMDACT)) {
299 dev_vdbg(dwc->dev, "Command Complete --> %d\n",
300 DWC3_DEPCMD_STATUS(reg));
305 * We can't sleep here, because it is also called from
316 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
317 struct dwc3_trb *trb)
319 u32 offset = (char *) trb - (char *) dep->trb_pool;
321 return dep->trb_pool_dma + offset;
324 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
326 struct dwc3 *dwc = dep->dwc;
331 if (dep->number == 0 || dep->number == 1)
334 dep->trb_pool = dma_alloc_coherent(dwc->dev,
335 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
336 &dep->trb_pool_dma, GFP_KERNEL);
337 if (!dep->trb_pool) {
338 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
346 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
348 struct dwc3 *dwc = dep->dwc;
350 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
351 dep->trb_pool, dep->trb_pool_dma);
353 dep->trb_pool = NULL;
354 dep->trb_pool_dma = 0;
357 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
359 struct dwc3_gadget_ep_cmd_params params;
362 memset(¶ms, 0x00, sizeof(params));
364 if (dep->number != 1) {
365 cmd = DWC3_DEPCMD_DEPSTARTCFG;
366 /* XferRscIdx == 0 for ep0 and 2 for the remaining */
367 if (dep->number > 1) {
368 if (dwc->start_config_issued)
370 dwc->start_config_issued = true;
371 cmd |= DWC3_DEPCMD_PARAM(2);
374 return dwc3_send_gadget_ep_cmd(dwc, 0, cmd, ¶ms);
380 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
381 const struct usb_endpoint_descriptor *desc,
382 const struct usb_ss_ep_comp_descriptor *comp_desc)
384 struct dwc3_gadget_ep_cmd_params params;
386 memset(¶ms, 0x00, sizeof(params));
388 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
389 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc))
390 | DWC3_DEPCFG_BURST_SIZE(dep->endpoint.maxburst);
392 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN
393 | DWC3_DEPCFG_XFER_NOT_READY_EN;
395 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
396 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
397 | DWC3_DEPCFG_STREAM_EVENT_EN;
398 dep->stream_capable = true;
401 if (usb_endpoint_xfer_isoc(desc))
402 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
405 * We are doing 1:1 mapping for endpoints, meaning
406 * Physical Endpoints 2 maps to Logical Endpoint 2 and
407 * so on. We consider the direction bit as part of the physical
408 * endpoint number. So USB endpoint 0x81 is 0x03.
410 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
413 * We must use the lower 16 TX FIFOs even though
417 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
419 if (desc->bInterval) {
420 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
421 dep->interval = 1 << (desc->bInterval - 1);
424 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
425 DWC3_DEPCMD_SETEPCONFIG, ¶ms);
428 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
430 struct dwc3_gadget_ep_cmd_params params;
432 memset(¶ms, 0x00, sizeof(params));
434 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
436 return dwc3_send_gadget_ep_cmd(dwc, dep->number,
437 DWC3_DEPCMD_SETTRANSFRESOURCE, ¶ms);
441 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
442 * @dep: endpoint to be initialized
443 * @desc: USB Endpoint Descriptor
445 * Caller should take care of locking
447 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
448 const struct usb_endpoint_descriptor *desc,
449 const struct usb_ss_ep_comp_descriptor *comp_desc)
451 struct dwc3 *dwc = dep->dwc;
455 if (!(dep->flags & DWC3_EP_ENABLED)) {
456 ret = dwc3_gadget_start_config(dwc, dep);
461 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc);
465 if (!(dep->flags & DWC3_EP_ENABLED)) {
466 struct dwc3_trb *trb_st_hw;
467 struct dwc3_trb *trb_link;
469 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
474 dep->comp_desc = comp_desc;
475 dep->type = usb_endpoint_type(desc);
476 dep->flags |= DWC3_EP_ENABLED;
478 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
479 reg |= DWC3_DALEPENA_EP(dep->number);
480 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
482 if (!usb_endpoint_xfer_isoc(desc))
485 memset(&trb_link, 0, sizeof(trb_link));
487 /* Link TRB for ISOC. The HWO bit is never reset */
488 trb_st_hw = &dep->trb_pool[0];
490 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
492 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
493 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
494 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
495 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
501 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum);
502 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
504 struct dwc3_request *req;
506 if (!list_empty(&dep->req_queued))
507 dwc3_stop_active_transfer(dwc, dep->number);
509 while (!list_empty(&dep->request_list)) {
510 req = next_request(&dep->request_list);
512 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
517 * __dwc3_gadget_ep_disable - Disables a HW endpoint
518 * @dep: the endpoint to disable
520 * This function also removes requests which are currently processed ny the
521 * hardware and those which are not yet scheduled.
522 * Caller should take care of locking.
524 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
526 struct dwc3 *dwc = dep->dwc;
529 dwc3_remove_requests(dwc, dep);
531 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
532 reg &= ~DWC3_DALEPENA_EP(dep->number);
533 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
535 dep->stream_capable = false;
537 dep->endpoint.desc = NULL;
538 dep->comp_desc = NULL;
545 /* -------------------------------------------------------------------------- */
547 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
548 const struct usb_endpoint_descriptor *desc)
553 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
558 /* -------------------------------------------------------------------------- */
560 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
561 const struct usb_endpoint_descriptor *desc)
568 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
569 pr_debug("dwc3: invalid parameters\n");
573 if (!desc->wMaxPacketSize) {
574 pr_debug("dwc3: missing wMaxPacketSize\n");
578 dep = to_dwc3_ep(ep);
581 switch (usb_endpoint_type(desc)) {
582 case USB_ENDPOINT_XFER_CONTROL:
583 strlcat(dep->name, "-control", sizeof(dep->name));
585 case USB_ENDPOINT_XFER_ISOC:
586 strlcat(dep->name, "-isoc", sizeof(dep->name));
588 case USB_ENDPOINT_XFER_BULK:
589 strlcat(dep->name, "-bulk", sizeof(dep->name));
591 case USB_ENDPOINT_XFER_INT:
592 strlcat(dep->name, "-int", sizeof(dep->name));
595 dev_err(dwc->dev, "invalid endpoint transfer type\n");
598 if (dep->flags & DWC3_EP_ENABLED) {
599 dev_WARN_ONCE(dwc->dev, true, "%s is already enabled\n",
604 dev_vdbg(dwc->dev, "Enabling %s\n", dep->name);
606 spin_lock_irqsave(&dwc->lock, flags);
607 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc);
608 spin_unlock_irqrestore(&dwc->lock, flags);
613 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
621 pr_debug("dwc3: invalid parameters\n");
625 dep = to_dwc3_ep(ep);
628 if (!(dep->flags & DWC3_EP_ENABLED)) {
629 dev_WARN_ONCE(dwc->dev, true, "%s is already disabled\n",
634 snprintf(dep->name, sizeof(dep->name), "ep%d%s",
636 (dep->number & 1) ? "in" : "out");
638 spin_lock_irqsave(&dwc->lock, flags);
639 ret = __dwc3_gadget_ep_disable(dep);
640 spin_unlock_irqrestore(&dwc->lock, flags);
645 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
648 struct dwc3_request *req;
649 struct dwc3_ep *dep = to_dwc3_ep(ep);
650 struct dwc3 *dwc = dep->dwc;
652 req = kzalloc(sizeof(*req), gfp_flags);
654 dev_err(dwc->dev, "not enough memory\n");
658 req->epnum = dep->number;
661 return &req->request;
664 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
665 struct usb_request *request)
667 struct dwc3_request *req = to_dwc3_request(request);
673 * dwc3_prepare_one_trb - setup one TRB from one request
674 * @dep: endpoint for which this request is prepared
675 * @req: dwc3_request pointer
677 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
678 struct dwc3_request *req, dma_addr_t dma,
679 unsigned length, unsigned last, unsigned chain)
681 struct dwc3 *dwc = dep->dwc;
682 struct dwc3_trb *trb;
684 unsigned int cur_slot;
686 dev_vdbg(dwc->dev, "%s: req %p dma %08llx length %d%s%s\n",
687 dep->name, req, (unsigned long long) dma,
688 length, last ? " last" : "",
689 chain ? " chain" : "");
691 trb = &dep->trb_pool[dep->free_slot & DWC3_TRB_MASK];
692 cur_slot = dep->free_slot;
695 /* Skip the LINK-TRB on ISOC */
696 if (((cur_slot & DWC3_TRB_MASK) == DWC3_TRB_NUM - 1) &&
697 usb_endpoint_xfer_isoc(dep->desc))
701 dwc3_gadget_move_request_queued(req);
703 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
706 trb->size = DWC3_TRB_SIZE_LENGTH(length);
707 trb->bpl = lower_32_bits(dma);
708 trb->bph = upper_32_bits(dma);
710 switch (usb_endpoint_type(dep->desc)) {
711 case USB_ENDPOINT_XFER_CONTROL:
712 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
715 case USB_ENDPOINT_XFER_ISOC:
716 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
718 /* IOC every DWC3_TRB_NUM / 4 so we can refill */
719 if (!(cur_slot % (DWC3_TRB_NUM / 4)))
720 trb->ctrl |= DWC3_TRB_CTRL_IOC;
723 case USB_ENDPOINT_XFER_BULK:
724 case USB_ENDPOINT_XFER_INT:
725 trb->ctrl = DWC3_TRBCTL_NORMAL;
729 * This is only possible with faulty memory because we
730 * checked it already :)
735 if (usb_endpoint_xfer_isoc(dep->desc)) {
736 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
737 trb->ctrl |= DWC3_TRB_CTRL_CSP;
740 trb->ctrl |= DWC3_TRB_CTRL_CHN;
743 trb->ctrl |= DWC3_TRB_CTRL_LST;
746 if (usb_endpoint_xfer_bulk(dep->desc) && dep->stream_capable)
747 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
749 trb->ctrl |= DWC3_TRB_CTRL_HWO;
753 * dwc3_prepare_trbs - setup TRBs from requests
754 * @dep: endpoint for which requests are being prepared
755 * @starting: true if the endpoint is idle and no requests are queued.
757 * The function goes through the requests list and sets up TRBs for the
758 * transfers. The function returns once there are no more TRBs available or
759 * it runs out of requests.
761 static void dwc3_prepare_trbs(struct dwc3_ep *dep, bool starting)
763 struct dwc3_request *req, *n;
766 unsigned int last_one = 0;
768 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
770 /* the first request must not be queued */
771 trbs_left = (dep->busy_slot - dep->free_slot) & DWC3_TRB_MASK;
773 /* Can't wrap around on a non-isoc EP since there's no link TRB */
774 if (!usb_endpoint_xfer_isoc(dep->desc)) {
775 max = DWC3_TRB_NUM - (dep->free_slot & DWC3_TRB_MASK);
781 * If busy & slot are equal than it is either full or empty. If we are
782 * starting to process requests then we are empty. Otherwise we are
783 * full and don't do anything
788 trbs_left = DWC3_TRB_NUM;
790 * In case we start from scratch, we queue the ISOC requests
791 * starting from slot 1. This is done because we use ring
792 * buffer and have no LST bit to stop us. Instead, we place
793 * IOC bit every TRB_NUM/4. We try to avoid having an interrupt
794 * after the first request so we start at slot 1 and have
795 * 7 requests proceed before we hit the first IOC.
796 * Other transfer types don't use the ring buffer and are
797 * processed from the first TRB until the last one. Since we
798 * don't wrap around we have to start at the beginning.
800 if (usb_endpoint_xfer_isoc(dep->desc)) {
809 /* The last TRB is a link TRB, not used for xfer */
810 if ((trbs_left <= 1) && usb_endpoint_xfer_isoc(dep->desc))
813 list_for_each_entry_safe(req, n, &dep->request_list, list) {
817 if (req->request.num_mapped_sgs > 0) {
818 struct usb_request *request = &req->request;
819 struct scatterlist *sg = request->sg;
820 struct scatterlist *s;
823 for_each_sg(sg, s, request->num_mapped_sgs, i) {
824 unsigned chain = true;
826 length = sg_dma_len(s);
827 dma = sg_dma_address(s);
829 if (i == (request->num_mapped_sgs - 1) ||
842 dwc3_prepare_one_trb(dep, req, dma, length,
849 dma = req->request.dma;
850 length = req->request.length;
856 /* Is this the last request? */
857 if (list_is_last(&req->list, &dep->request_list))
860 dwc3_prepare_one_trb(dep, req, dma, length,
869 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param,
872 struct dwc3_gadget_ep_cmd_params params;
873 struct dwc3_request *req;
874 struct dwc3 *dwc = dep->dwc;
878 if (start_new && (dep->flags & DWC3_EP_BUSY)) {
879 dev_vdbg(dwc->dev, "%s: endpoint busy\n", dep->name);
882 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
885 * If we are getting here after a short-out-packet we don't enqueue any
886 * new requests as we try to set the IOC bit only on the last request.
889 if (list_empty(&dep->req_queued))
890 dwc3_prepare_trbs(dep, start_new);
892 /* req points to the first request which will be sent */
893 req = next_request(&dep->req_queued);
895 dwc3_prepare_trbs(dep, start_new);
898 * req points to the first request where HWO changed from 0 to 1
900 req = next_request(&dep->req_queued);
903 dep->flags |= DWC3_EP_PENDING_REQUEST;
907 memset(¶ms, 0, sizeof(params));
908 params.param0 = upper_32_bits(req->trb_dma);
909 params.param1 = lower_32_bits(req->trb_dma);
912 cmd = DWC3_DEPCMD_STARTTRANSFER;
914 cmd = DWC3_DEPCMD_UPDATETRANSFER;
916 cmd |= DWC3_DEPCMD_PARAM(cmd_param);
917 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
919 dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");
922 * FIXME we need to iterate over the list of requests
923 * here and stop, unmap, free and del each of the linked
924 * requests instead of what we do now.
926 usb_gadget_unmap_request(&dwc->gadget, &req->request,
928 list_del(&req->list);
932 dep->flags |= DWC3_EP_BUSY;
933 dep->res_trans_idx = dwc3_gadget_ep_get_transfer_index(dwc,
936 WARN_ON_ONCE(!dep->res_trans_idx);
941 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
943 struct dwc3 *dwc = dep->dwc;
946 req->request.actual = 0;
947 req->request.status = -EINPROGRESS;
948 req->direction = dep->direction;
949 req->epnum = dep->number;
952 * We only add to our list of requests now and
953 * start consuming the list once we get XferNotReady
956 * That way, we avoid doing anything that we don't need
957 * to do now and defer it until the point we receive a
958 * particular token from the Host side.
960 * This will also avoid Host cancelling URBs due to too
963 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
968 list_add_tail(&req->list, &dep->request_list);
971 * There is one special case: XferNotReady with
972 * empty list of requests. We need to kick the
973 * transfer here in that situation, otherwise
974 * we will be NAKing forever.
976 * If we get XferNotReady before gadget driver
977 * has a chance to queue a request, we will ACK
978 * the IRQ but won't be able to receive the data
979 * until the next request is queued. The following
980 * code is handling exactly that.
982 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
987 if (usb_endpoint_xfer_isoc(dep->desc) &&
988 (dep->flags & DWC3_EP_BUSY))
991 ret = __dwc3_gadget_kick_transfer(dep, 0, start_trans);
992 if (ret && ret != -EBUSY) {
993 struct dwc3 *dwc = dep->dwc;
995 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1003 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1006 struct dwc3_request *req = to_dwc3_request(request);
1007 struct dwc3_ep *dep = to_dwc3_ep(ep);
1008 struct dwc3 *dwc = dep->dwc;
1010 unsigned long flags;
1015 dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",
1020 dev_vdbg(dwc->dev, "queing request %p to %s length %d\n",
1021 request, ep->name, request->length);
1023 spin_lock_irqsave(&dwc->lock, flags);
1024 ret = __dwc3_gadget_ep_queue(dep, req);
1025 spin_unlock_irqrestore(&dwc->lock, flags);
1030 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1031 struct usb_request *request)
1033 struct dwc3_request *req = to_dwc3_request(request);
1034 struct dwc3_request *r = NULL;
1036 struct dwc3_ep *dep = to_dwc3_ep(ep);
1037 struct dwc3 *dwc = dep->dwc;
1039 unsigned long flags;
1042 spin_lock_irqsave(&dwc->lock, flags);
1044 list_for_each_entry(r, &dep->request_list, list) {
1050 list_for_each_entry(r, &dep->req_queued, list) {
1055 /* wait until it is processed */
1056 dwc3_stop_active_transfer(dwc, dep->number);
1059 dev_err(dwc->dev, "request %p was not queued to %s\n",
1065 /* giveback the request */
1066 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1069 spin_unlock_irqrestore(&dwc->lock, flags);
1074 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value)
1076 struct dwc3_gadget_ep_cmd_params params;
1077 struct dwc3 *dwc = dep->dwc;
1080 memset(¶ms, 0x00, sizeof(params));
1083 if (dep->number == 0 || dep->number == 1) {
1085 * Whenever EP0 is stalled, we will restart
1086 * the state machine, thus moving back to
1089 dwc->ep0state = EP0_SETUP_PHASE;
1092 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1093 DWC3_DEPCMD_SETSTALL, ¶ms);
1095 dev_err(dwc->dev, "failed to %s STALL on %s\n",
1096 value ? "set" : "clear",
1099 dep->flags |= DWC3_EP_STALL;
1101 if (dep->flags & DWC3_EP_WEDGE)
1104 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1105 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1107 dev_err(dwc->dev, "failed to %s STALL on %s\n",
1108 value ? "set" : "clear",
1111 dep->flags &= ~DWC3_EP_STALL;
1117 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1119 struct dwc3_ep *dep = to_dwc3_ep(ep);
1120 struct dwc3 *dwc = dep->dwc;
1122 unsigned long flags;
1126 spin_lock_irqsave(&dwc->lock, flags);
1128 if (usb_endpoint_xfer_isoc(dep->desc)) {
1129 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1134 ret = __dwc3_gadget_ep_set_halt(dep, value);
1136 spin_unlock_irqrestore(&dwc->lock, flags);
1141 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1143 struct dwc3_ep *dep = to_dwc3_ep(ep);
1144 struct dwc3 *dwc = dep->dwc;
1145 unsigned long flags;
1147 spin_lock_irqsave(&dwc->lock, flags);
1148 dep->flags |= DWC3_EP_WEDGE;
1149 spin_unlock_irqrestore(&dwc->lock, flags);
1151 return dwc3_gadget_ep_set_halt(ep, 1);
1154 /* -------------------------------------------------------------------------- */
1156 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1157 .bLength = USB_DT_ENDPOINT_SIZE,
1158 .bDescriptorType = USB_DT_ENDPOINT,
1159 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1162 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1163 .enable = dwc3_gadget_ep0_enable,
1164 .disable = dwc3_gadget_ep0_disable,
1165 .alloc_request = dwc3_gadget_ep_alloc_request,
1166 .free_request = dwc3_gadget_ep_free_request,
1167 .queue = dwc3_gadget_ep0_queue,
1168 .dequeue = dwc3_gadget_ep_dequeue,
1169 .set_halt = dwc3_gadget_ep_set_halt,
1170 .set_wedge = dwc3_gadget_ep_set_wedge,
1173 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1174 .enable = dwc3_gadget_ep_enable,
1175 .disable = dwc3_gadget_ep_disable,
1176 .alloc_request = dwc3_gadget_ep_alloc_request,
1177 .free_request = dwc3_gadget_ep_free_request,
1178 .queue = dwc3_gadget_ep_queue,
1179 .dequeue = dwc3_gadget_ep_dequeue,
1180 .set_halt = dwc3_gadget_ep_set_halt,
1181 .set_wedge = dwc3_gadget_ep_set_wedge,
1184 /* -------------------------------------------------------------------------- */
1186 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1188 struct dwc3 *dwc = gadget_to_dwc(g);
1191 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1192 return DWC3_DSTS_SOFFN(reg);
1195 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1197 struct dwc3 *dwc = gadget_to_dwc(g);
1199 unsigned long timeout;
1200 unsigned long flags;
1209 spin_lock_irqsave(&dwc->lock, flags);
1212 * According to the Databook Remote wakeup request should
1213 * be issued only when the device is in early suspend state.
1215 * We can check that via USB Link State bits in DSTS register.
1217 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1219 speed = reg & DWC3_DSTS_CONNECTSPD;
1220 if (speed == DWC3_DSTS_SUPERSPEED) {
1221 dev_dbg(dwc->dev, "no wakeup on SuperSpeed\n");
1226 link_state = DWC3_DSTS_USBLNKST(reg);
1228 switch (link_state) {
1229 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1230 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1233 dev_dbg(dwc->dev, "can't wakeup from link state %d\n",
1239 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1241 dev_err(dwc->dev, "failed to put link in Recovery\n");
1245 /* write zeroes to Link Change Request */
1246 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1247 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1249 /* poll until Link State changes to ON */
1250 timeout = jiffies + msecs_to_jiffies(100);
1252 while (!time_after(jiffies, timeout)) {
1253 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1255 /* in HS, means ON */
1256 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1260 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1261 dev_err(dwc->dev, "failed to send remote wakeup\n");
1266 spin_unlock_irqrestore(&dwc->lock, flags);
1271 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1274 struct dwc3 *dwc = gadget_to_dwc(g);
1275 unsigned long flags;
1277 spin_lock_irqsave(&dwc->lock, flags);
1278 dwc->is_selfpowered = !!is_selfpowered;
1279 spin_unlock_irqrestore(&dwc->lock, flags);
1284 static void dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on)
1289 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1291 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1292 reg |= (DWC3_DCTL_RUN_STOP
1293 | DWC3_DCTL_TRGTULST_RX_DET);
1295 reg &= ~DWC3_DCTL_RUN_STOP;
1298 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1301 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1303 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1306 if (reg & DWC3_DSTS_DEVCTRLHLT)
1315 dev_vdbg(dwc->dev, "gadget %s data soft-%s\n",
1317 ? dwc->gadget_driver->function : "no-function",
1318 is_on ? "connect" : "disconnect");
1321 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1323 struct dwc3 *dwc = gadget_to_dwc(g);
1324 unsigned long flags;
1328 spin_lock_irqsave(&dwc->lock, flags);
1329 dwc3_gadget_run_stop(dwc, is_on);
1330 spin_unlock_irqrestore(&dwc->lock, flags);
1335 static int dwc3_gadget_start(struct usb_gadget *g,
1336 struct usb_gadget_driver *driver)
1338 struct dwc3 *dwc = gadget_to_dwc(g);
1339 struct dwc3_ep *dep;
1340 unsigned long flags;
1344 spin_lock_irqsave(&dwc->lock, flags);
1346 if (dwc->gadget_driver) {
1347 dev_err(dwc->dev, "%s is already bound to %s\n",
1349 dwc->gadget_driver->driver.name);
1354 dwc->gadget_driver = driver;
1355 dwc->gadget.dev.driver = &driver->driver;
1357 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1358 reg &= ~(DWC3_DCFG_SPEED_MASK);
1359 reg |= dwc->maximum_speed;
1360 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1362 dwc->start_config_issued = false;
1364 /* Start with SuperSpeed Default */
1365 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1368 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL);
1370 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1375 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL);
1377 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1381 /* begin to receive SETUP packets */
1382 dwc->ep0state = EP0_SETUP_PHASE;
1383 dwc3_ep0_out_start(dwc);
1385 spin_unlock_irqrestore(&dwc->lock, flags);
1390 __dwc3_gadget_ep_disable(dwc->eps[0]);
1393 spin_unlock_irqrestore(&dwc->lock, flags);
1398 static int dwc3_gadget_stop(struct usb_gadget *g,
1399 struct usb_gadget_driver *driver)
1401 struct dwc3 *dwc = gadget_to_dwc(g);
1402 unsigned long flags;
1404 spin_lock_irqsave(&dwc->lock, flags);
1406 __dwc3_gadget_ep_disable(dwc->eps[0]);
1407 __dwc3_gadget_ep_disable(dwc->eps[1]);
1409 dwc->gadget_driver = NULL;
1410 dwc->gadget.dev.driver = NULL;
1412 spin_unlock_irqrestore(&dwc->lock, flags);
1416 static const struct usb_gadget_ops dwc3_gadget_ops = {
1417 .get_frame = dwc3_gadget_get_frame,
1418 .wakeup = dwc3_gadget_wakeup,
1419 .set_selfpowered = dwc3_gadget_set_selfpowered,
1420 .pullup = dwc3_gadget_pullup,
1421 .udc_start = dwc3_gadget_start,
1422 .udc_stop = dwc3_gadget_stop,
1425 /* -------------------------------------------------------------------------- */
1427 static int __devinit dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1429 struct dwc3_ep *dep;
1432 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1434 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1435 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1437 dev_err(dwc->dev, "can't allocate endpoint %d\n",
1443 dep->number = epnum;
1444 dwc->eps[epnum] = dep;
1446 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1447 (epnum & 1) ? "in" : "out");
1448 dep->endpoint.name = dep->name;
1449 dep->direction = (epnum & 1);
1451 if (epnum == 0 || epnum == 1) {
1452 dep->endpoint.maxpacket = 512;
1453 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1455 dwc->gadget.ep0 = &dep->endpoint;
1459 dep->endpoint.maxpacket = 1024;
1460 dep->endpoint.max_streams = 15;
1461 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1462 list_add_tail(&dep->endpoint.ep_list,
1463 &dwc->gadget.ep_list);
1465 ret = dwc3_alloc_trb_pool(dep);
1470 INIT_LIST_HEAD(&dep->request_list);
1471 INIT_LIST_HEAD(&dep->req_queued);
1477 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1479 struct dwc3_ep *dep;
1482 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1483 dep = dwc->eps[epnum];
1484 dwc3_free_trb_pool(dep);
1486 if (epnum != 0 && epnum != 1)
1487 list_del(&dep->endpoint.ep_list);
1493 static void dwc3_gadget_release(struct device *dev)
1495 dev_dbg(dev, "%s\n", __func__);
1498 /* -------------------------------------------------------------------------- */
1499 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
1500 const struct dwc3_event_depevt *event, int status)
1502 struct dwc3_request *req;
1503 struct dwc3_trb *trb;
1505 unsigned int s_pkt = 0;
1508 req = next_request(&dep->req_queued);
1516 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1518 * We continue despite the error. There is not much we
1519 * can do. If we don't clean it up we loop forever. If
1520 * we skip the TRB then it gets overwritten after a
1521 * while since we use them in a ring buffer. A BUG()
1522 * would help. Lets hope that if this occurs, someone
1523 * fixes the root cause instead of looking away :)
1525 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1526 dep->name, req->trb);
1527 count = trb->size & DWC3_TRB_SIZE_MASK;
1529 if (dep->direction) {
1531 dev_err(dwc->dev, "incomplete IN transfer %s\n",
1533 status = -ECONNRESET;
1536 if (count && (event->status & DEPEVT_STATUS_SHORT))
1541 * We assume here we will always receive the entire data block
1542 * which we should receive. Meaning, if we program RX to
1543 * receive 4K but we receive only 2K, we assume that's all we
1544 * should receive and we simply bounce the request back to the
1545 * gadget driver for further processing.
1547 req->request.actual += req->request.length - count;
1548 dwc3_gadget_giveback(dep, req, status);
1551 if ((event->status & DEPEVT_STATUS_LST) &&
1552 (trb->ctrl & DWC3_TRB_CTRL_LST))
1554 if ((event->status & DEPEVT_STATUS_IOC) &&
1555 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1559 if ((event->status & DEPEVT_STATUS_IOC) &&
1560 (trb->ctrl & DWC3_TRB_CTRL_IOC))
1565 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
1566 struct dwc3_ep *dep, const struct dwc3_event_depevt *event,
1569 unsigned status = 0;
1572 if (event->status & DEPEVT_STATUS_BUSERR)
1573 status = -ECONNRESET;
1575 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
1577 dep->flags &= ~DWC3_EP_BUSY;
1580 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
1581 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
1583 if (dwc->revision < DWC3_REVISION_183A) {
1587 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
1588 struct dwc3_ep *dep = dwc->eps[i];
1590 if (!(dep->flags & DWC3_EP_ENABLED))
1593 if (!list_empty(&dep->req_queued))
1597 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1599 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1605 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1606 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1610 if (list_empty(&dep->request_list)) {
1611 dev_vdbg(dwc->dev, "ISOC ep %s run out for requests.\n",
1616 mask = ~(dep->interval - 1);
1617 uf = event->parameters & mask;
1618 /* 4 micro frames in the future */
1619 uf += dep->interval * 4;
1621 __dwc3_gadget_kick_transfer(dep, uf, 1);
1624 static void dwc3_process_ep_cmd_complete(struct dwc3_ep *dep,
1625 const struct dwc3_event_depevt *event)
1627 struct dwc3 *dwc = dep->dwc;
1628 struct dwc3_event_depevt mod_ev = *event;
1631 * We were asked to remove one request. It is possible that this
1632 * request and a few others were started together and have the same
1633 * transfer index. Since we stopped the complete endpoint we don't
1634 * know how many requests were already completed (and not yet)
1635 * reported and how could be done (later). We purge them all until
1636 * the end of the list.
1638 mod_ev.status = DEPEVT_STATUS_LST;
1639 dwc3_cleanup_done_reqs(dwc, dep, &mod_ev, -ESHUTDOWN);
1640 dep->flags &= ~DWC3_EP_BUSY;
1641 /* pending requests are ignored and are queued on XferNotReady */
1644 static void dwc3_ep_cmd_compl(struct dwc3_ep *dep,
1645 const struct dwc3_event_depevt *event)
1647 u32 param = event->parameters;
1648 u32 cmd_type = (param >> 8) & ((1 << 5) - 1);
1651 case DWC3_DEPCMD_ENDTRANSFER:
1652 dwc3_process_ep_cmd_complete(dep, event);
1654 case DWC3_DEPCMD_STARTTRANSFER:
1655 dep->res_trans_idx = param & 0x7f;
1658 printk(KERN_ERR "%s() unknown /unexpected type: %d\n",
1659 __func__, cmd_type);
1664 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
1665 const struct dwc3_event_depevt *event)
1667 struct dwc3_ep *dep;
1668 u8 epnum = event->endpoint_number;
1670 dep = dwc->eps[epnum];
1672 dev_vdbg(dwc->dev, "%s: %s\n", dep->name,
1673 dwc3_ep_event_string(event->endpoint_event));
1675 if (epnum == 0 || epnum == 1) {
1676 dwc3_ep0_interrupt(dwc, event);
1680 switch (event->endpoint_event) {
1681 case DWC3_DEPEVT_XFERCOMPLETE:
1682 dep->res_trans_idx = 0;
1684 if (usb_endpoint_xfer_isoc(dep->desc)) {
1685 dev_dbg(dwc->dev, "%s is an Isochronous endpoint\n",
1690 dwc3_endpoint_transfer_complete(dwc, dep, event, 1);
1692 case DWC3_DEPEVT_XFERINPROGRESS:
1693 if (!usb_endpoint_xfer_isoc(dep->desc)) {
1694 dev_dbg(dwc->dev, "%s is not an Isochronous endpoint\n",
1699 dwc3_endpoint_transfer_complete(dwc, dep, event, 0);
1701 case DWC3_DEPEVT_XFERNOTREADY:
1702 if (usb_endpoint_xfer_isoc(dep->desc)) {
1703 dwc3_gadget_start_isoc(dwc, dep, event);
1707 dev_vdbg(dwc->dev, "%s: reason %s\n",
1708 dep->name, event->status &
1709 DEPEVT_STATUS_TRANSFER_ACTIVE
1711 : "Transfer Not Active");
1713 ret = __dwc3_gadget_kick_transfer(dep, 0, 1);
1714 if (!ret || ret == -EBUSY)
1717 dev_dbg(dwc->dev, "%s: failed to kick transfers\n",
1722 case DWC3_DEPEVT_STREAMEVT:
1723 if (!usb_endpoint_xfer_bulk(dep->desc)) {
1724 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
1729 switch (event->status) {
1730 case DEPEVT_STREAMEVT_FOUND:
1731 dev_vdbg(dwc->dev, "Stream %d found and started\n",
1735 case DEPEVT_STREAMEVT_NOTFOUND:
1738 dev_dbg(dwc->dev, "Couldn't find suitable stream\n");
1741 case DWC3_DEPEVT_RXTXFIFOEVT:
1742 dev_dbg(dwc->dev, "%s FIFO Overrun\n", dep->name);
1744 case DWC3_DEPEVT_EPCMDCMPLT:
1745 dwc3_ep_cmd_compl(dep, event);
1750 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
1752 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
1753 spin_unlock(&dwc->lock);
1754 dwc->gadget_driver->disconnect(&dwc->gadget);
1755 spin_lock(&dwc->lock);
1759 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum)
1761 struct dwc3_ep *dep;
1762 struct dwc3_gadget_ep_cmd_params params;
1766 dep = dwc->eps[epnum];
1768 WARN_ON(!dep->res_trans_idx);
1769 if (dep->res_trans_idx) {
1770 cmd = DWC3_DEPCMD_ENDTRANSFER;
1771 cmd |= DWC3_DEPCMD_HIPRI_FORCERM | DWC3_DEPCMD_CMDIOC;
1772 cmd |= DWC3_DEPCMD_PARAM(dep->res_trans_idx);
1773 memset(¶ms, 0, sizeof(params));
1774 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, ¶ms);
1776 dep->res_trans_idx = 0;
1780 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
1784 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1785 struct dwc3_ep *dep;
1787 dep = dwc->eps[epnum];
1788 if (!(dep->flags & DWC3_EP_ENABLED))
1791 dwc3_remove_requests(dwc, dep);
1795 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
1799 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1800 struct dwc3_ep *dep;
1801 struct dwc3_gadget_ep_cmd_params params;
1804 dep = dwc->eps[epnum];
1806 if (!(dep->flags & DWC3_EP_STALL))
1809 dep->flags &= ~DWC3_EP_STALL;
1811 memset(¶ms, 0, sizeof(params));
1812 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
1813 DWC3_DEPCMD_CLEARSTALL, ¶ms);
1818 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
1820 dev_vdbg(dwc->dev, "%s\n", __func__);
1823 U1/U2 is powersave optimization. Skip it for now. Anyway we need to
1824 enable it before we can disable it.
1826 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1827 reg &= ~DWC3_DCTL_INITU1ENA;
1828 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1830 reg &= ~DWC3_DCTL_INITU2ENA;
1831 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1834 dwc3_stop_active_transfers(dwc);
1835 dwc3_disconnect_gadget(dwc);
1836 dwc->start_config_issued = false;
1838 dwc->gadget.speed = USB_SPEED_UNKNOWN;
1839 dwc->setup_packet_pending = false;
1842 static void dwc3_gadget_usb3_phy_power(struct dwc3 *dwc, int on)
1846 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
1849 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
1851 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
1853 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
1856 static void dwc3_gadget_usb2_phy_power(struct dwc3 *dwc, int on)
1860 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
1863 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
1865 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
1867 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
1870 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
1874 dev_vdbg(dwc->dev, "%s\n", __func__);
1877 * WORKAROUND: DWC3 revisions <1.88a have an issue which
1878 * would cause a missing Disconnect Event if there's a
1879 * pending Setup Packet in the FIFO.
1881 * There's no suggested workaround on the official Bug
1882 * report, which states that "unless the driver/application
1883 * is doing any special handling of a disconnect event,
1884 * there is no functional issue".
1886 * Unfortunately, it turns out that we _do_ some special
1887 * handling of a disconnect event, namely complete all
1888 * pending transfers, notify gadget driver of the
1889 * disconnection, and so on.
1891 * Our suggested workaround is to follow the Disconnect
1892 * Event steps here, instead, based on a setup_packet_pending
1893 * flag. Such flag gets set whenever we have a XferNotReady
1894 * event on EP0 and gets cleared on XferComplete for the
1899 * STAR#9000466709: RTL: Device : Disconnect event not
1900 * generated if setup packet pending in FIFO
1902 if (dwc->revision < DWC3_REVISION_188A) {
1903 if (dwc->setup_packet_pending)
1904 dwc3_gadget_disconnect_interrupt(dwc);
1907 /* after reset -> Default State */
1908 dwc->dev_state = DWC3_DEFAULT_STATE;
1911 dwc3_gadget_usb2_phy_power(dwc, true);
1912 dwc3_gadget_usb3_phy_power(dwc, true);
1914 if (dwc->gadget.speed != USB_SPEED_UNKNOWN)
1915 dwc3_disconnect_gadget(dwc);
1917 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1918 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
1919 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1920 dwc->test_mode = false;
1922 dwc3_stop_active_transfers(dwc);
1923 dwc3_clear_stall_all_ep(dwc);
1924 dwc->start_config_issued = false;
1926 /* Reset device address to zero */
1927 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1928 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
1929 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1932 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
1935 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
1938 * We change the clock only at SS but I dunno why I would want to do
1939 * this. Maybe it becomes part of the power saving plan.
1942 if (speed != DWC3_DSTS_SUPERSPEED)
1946 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
1947 * each time on Connect Done.
1952 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
1953 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
1954 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
1957 static void dwc3_gadget_disable_phy(struct dwc3 *dwc, u8 speed)
1960 case USB_SPEED_SUPER:
1961 dwc3_gadget_usb2_phy_power(dwc, false);
1963 case USB_SPEED_HIGH:
1964 case USB_SPEED_FULL:
1966 dwc3_gadget_usb3_phy_power(dwc, false);
1971 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
1973 struct dwc3_gadget_ep_cmd_params params;
1974 struct dwc3_ep *dep;
1979 dev_vdbg(dwc->dev, "%s\n", __func__);
1981 memset(¶ms, 0x00, sizeof(params));
1983 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1984 speed = reg & DWC3_DSTS_CONNECTSPD;
1987 dwc3_update_ram_clk_sel(dwc, speed);
1990 case DWC3_DCFG_SUPERSPEED:
1992 * WORKAROUND: DWC3 revisions <1.90a have an issue which
1993 * would cause a missing USB3 Reset event.
1995 * In such situations, we should force a USB3 Reset
1996 * event by calling our dwc3_gadget_reset_interrupt()
2001 * STAR#9000483510: RTL: SS : USB3 reset event may
2002 * not be generated always when the link enters poll
2004 if (dwc->revision < DWC3_REVISION_190A)
2005 dwc3_gadget_reset_interrupt(dwc);
2007 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2008 dwc->gadget.ep0->maxpacket = 512;
2009 dwc->gadget.speed = USB_SPEED_SUPER;
2011 case DWC3_DCFG_HIGHSPEED:
2012 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2013 dwc->gadget.ep0->maxpacket = 64;
2014 dwc->gadget.speed = USB_SPEED_HIGH;
2016 case DWC3_DCFG_FULLSPEED2:
2017 case DWC3_DCFG_FULLSPEED1:
2018 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2019 dwc->gadget.ep0->maxpacket = 64;
2020 dwc->gadget.speed = USB_SPEED_FULL;
2022 case DWC3_DCFG_LOWSPEED:
2023 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2024 dwc->gadget.ep0->maxpacket = 8;
2025 dwc->gadget.speed = USB_SPEED_LOW;
2029 /* Disable unneded PHY */
2030 dwc3_gadget_disable_phy(dwc, dwc->gadget.speed);
2033 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL);
2035 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2040 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL);
2042 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2047 * Configure PHY via GUSB3PIPECTLn if required.
2049 * Update GTXFIFOSIZn
2051 * In both cases reset values should be sufficient.
2055 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2057 dev_vdbg(dwc->dev, "%s\n", __func__);
2060 * TODO take core out of low power mode when that's
2064 dwc->gadget_driver->resume(&dwc->gadget);
2067 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2068 unsigned int evtinfo)
2070 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2073 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2074 * on the link partner, the USB session might do multiple entry/exit
2075 * of low power states before a transfer takes place.
2077 * Due to this problem, we might experience lower throughput. The
2078 * suggested workaround is to disable DCTL[12:9] bits if we're
2079 * transitioning from U1/U2 to U0 and enable those bits again
2080 * after a transfer completes and there are no pending transfers
2081 * on any of the enabled endpoints.
2083 * This is the first half of that workaround.
2087 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2088 * core send LGO_Ux entering U0
2090 if (dwc->revision < DWC3_REVISION_183A) {
2091 if (next == DWC3_LINK_STATE_U0) {
2095 switch (dwc->link_state) {
2096 case DWC3_LINK_STATE_U1:
2097 case DWC3_LINK_STATE_U2:
2098 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2099 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2100 | DWC3_DCTL_ACCEPTU2ENA
2101 | DWC3_DCTL_INITU1ENA
2102 | DWC3_DCTL_ACCEPTU1ENA);
2105 dwc->u1u2 = reg & u1u2;
2109 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2118 dwc->link_state = next;
2120 dev_vdbg(dwc->dev, "%s link %d\n", __func__, dwc->link_state);
2123 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2124 const struct dwc3_event_devt *event)
2126 switch (event->type) {
2127 case DWC3_DEVICE_EVENT_DISCONNECT:
2128 dwc3_gadget_disconnect_interrupt(dwc);
2130 case DWC3_DEVICE_EVENT_RESET:
2131 dwc3_gadget_reset_interrupt(dwc);
2133 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2134 dwc3_gadget_conndone_interrupt(dwc);
2136 case DWC3_DEVICE_EVENT_WAKEUP:
2137 dwc3_gadget_wakeup_interrupt(dwc);
2139 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2140 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2142 case DWC3_DEVICE_EVENT_EOPF:
2143 dev_vdbg(dwc->dev, "End of Periodic Frame\n");
2145 case DWC3_DEVICE_EVENT_SOF:
2146 dev_vdbg(dwc->dev, "Start of Periodic Frame\n");
2148 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2149 dev_vdbg(dwc->dev, "Erratic Error\n");
2151 case DWC3_DEVICE_EVENT_CMD_CMPL:
2152 dev_vdbg(dwc->dev, "Command Complete\n");
2154 case DWC3_DEVICE_EVENT_OVERFLOW:
2155 dev_vdbg(dwc->dev, "Overflow\n");
2158 dev_dbg(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2162 static void dwc3_process_event_entry(struct dwc3 *dwc,
2163 const union dwc3_event *event)
2165 /* Endpoint IRQ, handle it and return early */
2166 if (event->type.is_devspec == 0) {
2168 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2171 switch (event->type.type) {
2172 case DWC3_EVENT_TYPE_DEV:
2173 dwc3_gadget_interrupt(dwc, &event->devt);
2175 /* REVISIT what to do with Carkit and I2C events ? */
2177 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2181 static irqreturn_t dwc3_process_event_buf(struct dwc3 *dwc, u32 buf)
2183 struct dwc3_event_buffer *evt;
2187 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(buf));
2188 count &= DWC3_GEVNTCOUNT_MASK;
2192 evt = dwc->ev_buffs[buf];
2196 union dwc3_event event;
2198 event.raw = *(u32 *) (evt->buf + evt->lpos);
2200 dwc3_process_event_entry(dwc, &event);
2202 * XXX we wrap around correctly to the next entry as almost all
2203 * entries are 4 bytes in size. There is one entry which has 12
2204 * bytes which is a regular entry followed by 8 bytes data. ATM
2205 * I don't know how things are organized if were get next to the
2206 * a boundary so I worry about that once we try to handle that.
2208 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2211 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(buf), 4);
2217 static irqreturn_t dwc3_interrupt(int irq, void *_dwc)
2219 struct dwc3 *dwc = _dwc;
2221 irqreturn_t ret = IRQ_NONE;
2223 spin_lock(&dwc->lock);
2225 for (i = 0; i < dwc->num_event_buffers; i++) {
2228 status = dwc3_process_event_buf(dwc, i);
2229 if (status == IRQ_HANDLED)
2233 spin_unlock(&dwc->lock);
2239 * dwc3_gadget_init - Initializes gadget related registers
2240 * @dwc: pointer to our controller context structure
2242 * Returns 0 on success otherwise negative errno.
2244 int __devinit dwc3_gadget_init(struct dwc3 *dwc)
2250 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2251 &dwc->ctrl_req_addr, GFP_KERNEL);
2252 if (!dwc->ctrl_req) {
2253 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2258 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2259 &dwc->ep0_trb_addr, GFP_KERNEL);
2260 if (!dwc->ep0_trb) {
2261 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2266 dwc->setup_buf = kzalloc(sizeof(*dwc->setup_buf) * 2,
2268 if (!dwc->setup_buf) {
2269 dev_err(dwc->dev, "failed to allocate setup buffer\n");
2274 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2275 512, &dwc->ep0_bounce_addr, GFP_KERNEL);
2276 if (!dwc->ep0_bounce) {
2277 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2282 dev_set_name(&dwc->gadget.dev, "gadget");
2284 dwc->gadget.ops = &dwc3_gadget_ops;
2285 dwc->gadget.max_speed = USB_SPEED_SUPER;
2286 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2287 dwc->gadget.dev.parent = dwc->dev;
2288 dwc->gadget.sg_supported = true;
2290 dma_set_coherent_mask(&dwc->gadget.dev, dwc->dev->coherent_dma_mask);
2292 dwc->gadget.dev.dma_parms = dwc->dev->dma_parms;
2293 dwc->gadget.dev.dma_mask = dwc->dev->dma_mask;
2294 dwc->gadget.dev.release = dwc3_gadget_release;
2295 dwc->gadget.name = "dwc3-gadget";
2298 * REVISIT: Here we should clear all pending IRQs to be
2299 * sure we're starting from a well known location.
2302 ret = dwc3_gadget_init_endpoints(dwc);
2306 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
2308 ret = request_irq(irq, dwc3_interrupt, IRQF_SHARED,
2311 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
2316 /* Enable all but Start and End of Frame IRQs */
2317 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
2318 DWC3_DEVTEN_EVNTOVERFLOWEN |
2319 DWC3_DEVTEN_CMDCMPLTEN |
2320 DWC3_DEVTEN_ERRTICERREN |
2321 DWC3_DEVTEN_WKUPEVTEN |
2322 DWC3_DEVTEN_ULSTCNGEN |
2323 DWC3_DEVTEN_CONNECTDONEEN |
2324 DWC3_DEVTEN_USBRSTEN |
2325 DWC3_DEVTEN_DISCONNEVTEN);
2326 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
2328 ret = device_register(&dwc->gadget.dev);
2330 dev_err(dwc->dev, "failed to register gadget device\n");
2331 put_device(&dwc->gadget.dev);
2335 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2337 dev_err(dwc->dev, "failed to register udc\n");
2344 device_unregister(&dwc->gadget.dev);
2347 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
2351 dwc3_gadget_free_endpoints(dwc);
2354 dma_free_coherent(dwc->dev, 512, dwc->ep0_bounce,
2355 dwc->ep0_bounce_addr);
2358 kfree(dwc->setup_buf);
2361 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2362 dwc->ep0_trb, dwc->ep0_trb_addr);
2365 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2366 dwc->ctrl_req, dwc->ctrl_req_addr);
2372 void dwc3_gadget_exit(struct dwc3 *dwc)
2376 usb_del_gadget_udc(&dwc->gadget);
2377 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
2379 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
2382 dwc3_gadget_free_endpoints(dwc);
2384 dma_free_coherent(dwc->dev, 512, dwc->ep0_bounce,
2385 dwc->ep0_bounce_addr);
2387 kfree(dwc->setup_buf);
2389 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
2390 dwc->ep0_trb, dwc->ep0_trb_addr);
2392 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2393 dwc->ctrl_req, dwc->ctrl_req_addr);
2395 device_unregister(&dwc->gadget.dev);