2 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 of
11 * the License as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/interrupt.h>
27 #include <linux/list.h>
28 #include <linux/dma-mapping.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
39 * dwc3_gadget_set_test_mode - Enables USB2 Test Modes
40 * @dwc: pointer to our context structure
41 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
43 * Caller should take care of locking. This function will
44 * return 0 on success or -EINVAL if wrong Test Selector
47 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
51 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
52 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
66 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
72 * dwc3_gadget_get_link_state - Gets current state of USB Link
73 * @dwc: pointer to our context structure
75 * Caller should take care of locking. This function will
76 * return the link state on success (>= 0) or -ETIMEDOUT.
78 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
82 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
84 return DWC3_DSTS_USBLNKST(reg);
88 * dwc3_gadget_set_link_state - Sets USB Link to a particular State
89 * @dwc: pointer to our context structure
90 * @state: the state to put link into
92 * Caller should take care of locking. This function will
93 * return 0 on success or -ETIMEDOUT.
95 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
101 * Wait until device controller is ready. Only applies to 1.94a and
104 if (dwc->revision >= DWC3_REVISION_194A) {
106 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
107 if (reg & DWC3_DSTS_DCNRD)
117 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
118 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
120 /* set requested state */
121 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
122 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
125 * The following code is racy when called from dwc3_gadget_wakeup,
126 * and is not needed, at least on newer versions
128 if (dwc->revision >= DWC3_REVISION_194A)
131 /* wait for a change in DSTS */
134 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
136 if (DWC3_DSTS_USBLNKST(reg) == state)
142 dwc3_trace(trace_dwc3_gadget,
143 "link state change request timed out");
149 * dwc3_ep_inc_trb() - Increment a TRB index.
150 * @index - Pointer to the TRB index to increment.
152 * The index should never point to the link TRB. After incrementing,
153 * if it is point to the link TRB, wrap around to the beginning. The
154 * link TRB is always at the last TRB entry.
156 static void dwc3_ep_inc_trb(u8 *index)
159 if (*index == (DWC3_TRB_NUM - 1))
163 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
165 dwc3_ep_inc_trb(&dep->trb_enqueue);
168 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
170 dwc3_ep_inc_trb(&dep->trb_dequeue);
173 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
176 struct dwc3 *dwc = dep->dwc;
182 dwc3_ep_inc_deq(dep);
183 } while(++i < req->request.num_mapped_sgs);
184 req->started = false;
186 list_del(&req->list);
189 if (req->request.status == -EINPROGRESS)
190 req->request.status = status;
192 if (dwc->ep0_bounced && dep->number == 0)
193 dwc->ep0_bounced = false;
195 usb_gadget_unmap_request(&dwc->gadget, &req->request,
198 trace_dwc3_gadget_giveback(req);
200 spin_unlock(&dwc->lock);
201 usb_gadget_giveback_request(&dep->endpoint, &req->request);
202 spin_lock(&dwc->lock);
205 pm_runtime_put(dwc->dev);
208 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
215 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
216 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
219 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
220 if (!(reg & DWC3_DGCMD_CMDACT)) {
221 status = DWC3_DGCMD_STATUS(reg);
233 trace_dwc3_gadget_generic_cmd(cmd, param, status);
238 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
240 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
241 struct dwc3_gadget_ep_cmd_params *params)
243 struct dwc3 *dwc = dep->dwc;
252 * Synopsys Databook 2.60a states, on section 6.3.2.5.[1-8], that if
253 * we're issuing an endpoint command, we must check if
254 * GUSB2PHYCFG.SUSPHY bit is set. If it is, then we need to clear it.
256 * We will also set SUSPHY bit to what it was before returning as stated
257 * by the same section on Synopsys databook.
259 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
260 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
261 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
263 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
264 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
268 if (cmd == DWC3_DEPCMD_STARTTRANSFER) {
271 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
272 dwc->link_state == DWC3_LINK_STATE_U2 ||
273 dwc->link_state == DWC3_LINK_STATE_U3);
275 if (unlikely(needs_wakeup)) {
276 ret = __dwc3_gadget_wakeup(dwc);
277 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
282 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
283 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
284 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
286 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd | DWC3_DEPCMD_CMDACT);
288 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
289 if (!(reg & DWC3_DEPCMD_CMDACT)) {
290 cmd_status = DWC3_DEPCMD_STATUS(reg);
292 switch (cmd_status) {
296 case DEPEVT_TRANSFER_NO_RESOURCE:
299 case DEPEVT_TRANSFER_BUS_EXPIRY:
301 * SW issues START TRANSFER command to
302 * isochronous ep with future frame interval. If
303 * future interval time has already passed when
304 * core receives the command, it will respond
305 * with an error status of 'Bus Expiry'.
307 * Instead of always returning -EINVAL, let's
308 * give a hint to the gadget driver that this is
309 * the case by returning -EAGAIN.
314 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
323 cmd_status = -ETIMEDOUT;
326 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
328 if (unlikely(susphy)) {
329 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
330 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
331 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
337 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
339 struct dwc3 *dwc = dep->dwc;
340 struct dwc3_gadget_ep_cmd_params params;
341 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
344 * As of core revision 2.60a the recommended programming model
345 * is to set the ClearPendIN bit when issuing a Clear Stall EP
346 * command for IN endpoints. This is to prevent an issue where
347 * some (non-compliant) hosts may not send ACK TPs for pending
348 * IN transfers due to a mishandled error condition. Synopsys
351 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A))
352 cmd |= DWC3_DEPCMD_CLEARPENDIN;
354 memset(¶ms, 0, sizeof(params));
356 return dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
359 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
360 struct dwc3_trb *trb)
362 u32 offset = (char *) trb - (char *) dep->trb_pool;
364 return dep->trb_pool_dma + offset;
367 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
369 struct dwc3 *dwc = dep->dwc;
374 dep->trb_pool = dma_alloc_coherent(dwc->dev,
375 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
376 &dep->trb_pool_dma, GFP_KERNEL);
377 if (!dep->trb_pool) {
378 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
386 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
388 struct dwc3 *dwc = dep->dwc;
390 dma_free_coherent(dwc->dev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
391 dep->trb_pool, dep->trb_pool_dma);
393 dep->trb_pool = NULL;
394 dep->trb_pool_dma = 0;
397 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep);
400 * dwc3_gadget_start_config - Configure EP resources
401 * @dwc: pointer to our controller context structure
402 * @dep: endpoint that is being enabled
404 * The assignment of transfer resources cannot perfectly follow the
405 * data book due to the fact that the controller driver does not have
406 * all knowledge of the configuration in advance. It is given this
407 * information piecemeal by the composite gadget framework after every
408 * SET_CONFIGURATION and SET_INTERFACE. Trying to follow the databook
409 * programming model in this scenario can cause errors. For two
412 * 1) The databook says to do DEPSTARTCFG for every SET_CONFIGURATION
413 * and SET_INTERFACE (8.1.5). This is incorrect in the scenario of
414 * multiple interfaces.
416 * 2) The databook does not mention doing more DEPXFERCFG for new
417 * endpoint on alt setting (8.1.6).
419 * The following simplified method is used instead:
421 * All hardware endpoints can be assigned a transfer resource and this
422 * setting will stay persistent until either a core reset or
423 * hibernation. So whenever we do a DEPSTARTCFG(0) we can go ahead and
424 * do DEPXFERCFG for every hardware endpoint as well. We are
425 * guaranteed that there are as many transfer resources as endpoints.
427 * This function is called for each endpoint when it is being enabled
428 * but is triggered only when called for EP0-out, which always happens
429 * first, and which should only happen in one of the above conditions.
431 static int dwc3_gadget_start_config(struct dwc3 *dwc, struct dwc3_ep *dep)
433 struct dwc3_gadget_ep_cmd_params params;
441 memset(¶ms, 0x00, sizeof(params));
442 cmd = DWC3_DEPCMD_DEPSTARTCFG;
444 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
448 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
449 struct dwc3_ep *dep = dwc->eps[i];
454 ret = dwc3_gadget_set_xfer_resource(dwc, dep);
462 static int dwc3_gadget_set_ep_config(struct dwc3 *dwc, struct dwc3_ep *dep,
463 const struct usb_endpoint_descriptor *desc,
464 const struct usb_ss_ep_comp_descriptor *comp_desc,
465 bool ignore, bool restore)
467 struct dwc3_gadget_ep_cmd_params params;
469 memset(¶ms, 0x00, sizeof(params));
471 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
472 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
474 /* Burst size is only needed in SuperSpeed mode */
475 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
476 u32 burst = dep->endpoint.maxburst;
477 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
481 params.param0 |= DWC3_DEPCFG_IGN_SEQ_NUM;
484 params.param0 |= DWC3_DEPCFG_ACTION_RESTORE;
485 params.param2 |= dep->saved_state;
488 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
490 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
491 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
493 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
494 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
495 | DWC3_DEPCFG_STREAM_EVENT_EN;
496 dep->stream_capable = true;
499 if (!usb_endpoint_xfer_control(desc))
500 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
503 * We are doing 1:1 mapping for endpoints, meaning
504 * Physical Endpoints 2 maps to Logical Endpoint 2 and
505 * so on. We consider the direction bit as part of the physical
506 * endpoint number. So USB endpoint 0x81 is 0x03.
508 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
511 * We must use the lower 16 TX FIFOs even though
515 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
517 if (desc->bInterval) {
518 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
519 dep->interval = 1 << (desc->bInterval - 1);
522 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, ¶ms);
525 static int dwc3_gadget_set_xfer_resource(struct dwc3 *dwc, struct dwc3_ep *dep)
527 struct dwc3_gadget_ep_cmd_params params;
529 memset(¶ms, 0x00, sizeof(params));
531 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
533 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
538 * __dwc3_gadget_ep_enable - Initializes a HW endpoint
539 * @dep: endpoint to be initialized
540 * @desc: USB Endpoint Descriptor
542 * Caller should take care of locking
544 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep,
545 const struct usb_endpoint_descriptor *desc,
546 const struct usb_ss_ep_comp_descriptor *comp_desc,
547 bool ignore, bool restore)
549 struct dwc3 *dwc = dep->dwc;
553 dwc3_trace(trace_dwc3_gadget, "Enabling %s", dep->name);
555 if (!(dep->flags & DWC3_EP_ENABLED)) {
556 ret = dwc3_gadget_start_config(dwc, dep);
561 ret = dwc3_gadget_set_ep_config(dwc, dep, desc, comp_desc, ignore,
566 if (!(dep->flags & DWC3_EP_ENABLED)) {
567 struct dwc3_trb *trb_st_hw;
568 struct dwc3_trb *trb_link;
570 dep->endpoint.desc = desc;
571 dep->comp_desc = comp_desc;
572 dep->type = usb_endpoint_type(desc);
573 dep->flags |= DWC3_EP_ENABLED;
575 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
576 reg |= DWC3_DALEPENA_EP(dep->number);
577 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
579 if (usb_endpoint_xfer_control(desc))
582 /* Initialize the TRB ring */
583 dep->trb_dequeue = 0;
584 dep->trb_enqueue = 0;
585 memset(dep->trb_pool, 0,
586 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
588 /* Link TRB. The HWO bit is never reset */
589 trb_st_hw = &dep->trb_pool[0];
591 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
592 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
593 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
594 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
595 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
601 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force);
602 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
604 struct dwc3_request *req;
605 struct dwc3_trb *current_trb;
606 unsigned transfer_in_flight;
609 current_trb = &dep->trb_pool[dep->trb_enqueue];
611 current_trb = &dwc->ep0_trb[dep->trb_enqueue];
612 transfer_in_flight = current_trb->ctrl & DWC3_TRB_CTRL_HWO;
614 if (transfer_in_flight && !list_empty(&dep->started_list)) {
615 dwc3_stop_active_transfer(dwc, dep->number, true);
617 /* - giveback all requests to gadget driver */
618 while (!list_empty(&dep->started_list)) {
619 req = next_request(&dep->started_list);
621 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
625 while (!list_empty(&dep->pending_list)) {
626 req = next_request(&dep->pending_list);
628 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
633 * __dwc3_gadget_ep_disable - Disables a HW endpoint
634 * @dep: the endpoint to disable
636 * This function also removes requests which are currently processed ny the
637 * hardware and those which are not yet scheduled.
638 * Caller should take care of locking.
640 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
642 struct dwc3 *dwc = dep->dwc;
645 dwc3_trace(trace_dwc3_gadget, "Disabling %s", dep->name);
647 dwc3_remove_requests(dwc, dep);
649 /* make sure HW endpoint isn't stalled */
650 if (dep->flags & DWC3_EP_STALL)
651 __dwc3_gadget_ep_set_halt(dep, 0, false);
653 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
654 reg &= ~DWC3_DALEPENA_EP(dep->number);
655 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
657 dep->stream_capable = false;
658 dep->endpoint.desc = NULL;
659 dep->comp_desc = NULL;
666 /* -------------------------------------------------------------------------- */
668 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
669 const struct usb_endpoint_descriptor *desc)
674 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
679 /* -------------------------------------------------------------------------- */
681 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
682 const struct usb_endpoint_descriptor *desc)
689 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
690 pr_debug("dwc3: invalid parameters\n");
694 if (!desc->wMaxPacketSize) {
695 pr_debug("dwc3: missing wMaxPacketSize\n");
699 dep = to_dwc3_ep(ep);
702 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
703 "%s is already enabled\n",
707 spin_lock_irqsave(&dwc->lock, flags);
708 ret = __dwc3_gadget_ep_enable(dep, desc, ep->comp_desc, false, false);
709 spin_unlock_irqrestore(&dwc->lock, flags);
714 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
722 pr_debug("dwc3: invalid parameters\n");
726 dep = to_dwc3_ep(ep);
729 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
730 "%s is already disabled\n",
734 spin_lock_irqsave(&dwc->lock, flags);
735 ret = __dwc3_gadget_ep_disable(dep);
736 spin_unlock_irqrestore(&dwc->lock, flags);
741 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
744 struct dwc3_request *req;
745 struct dwc3_ep *dep = to_dwc3_ep(ep);
747 req = kzalloc(sizeof(*req), gfp_flags);
751 req->epnum = dep->number;
754 dep->allocated_requests++;
756 trace_dwc3_alloc_request(req);
758 return &req->request;
761 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
762 struct usb_request *request)
764 struct dwc3_request *req = to_dwc3_request(request);
765 struct dwc3_ep *dep = to_dwc3_ep(ep);
767 dep->allocated_requests--;
768 trace_dwc3_free_request(req);
773 * dwc3_prepare_one_trb - setup one TRB from one request
774 * @dep: endpoint for which this request is prepared
775 * @req: dwc3_request pointer
777 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
778 struct dwc3_request *req, dma_addr_t dma,
779 unsigned length, unsigned last, unsigned chain, unsigned node)
781 struct dwc3_trb *trb;
783 dwc3_trace(trace_dwc3_gadget, "%s: req %p dma %08llx length %d%s%s",
784 dep->name, req, (unsigned long long) dma,
785 length, last ? " last" : "",
786 chain ? " chain" : "");
789 trb = &dep->trb_pool[dep->trb_enqueue];
792 dwc3_gadget_move_started_request(req);
794 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
795 req->first_trb_index = dep->trb_enqueue;
798 dwc3_ep_inc_enq(dep);
800 trb->size = DWC3_TRB_SIZE_LENGTH(length);
801 trb->bpl = lower_32_bits(dma);
802 trb->bph = upper_32_bits(dma);
804 switch (usb_endpoint_type(dep->endpoint.desc)) {
805 case USB_ENDPOINT_XFER_CONTROL:
806 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
809 case USB_ENDPOINT_XFER_ISOC:
811 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
813 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
815 /* always enable Interrupt on Missed ISOC */
816 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
819 case USB_ENDPOINT_XFER_BULK:
820 case USB_ENDPOINT_XFER_INT:
821 trb->ctrl = DWC3_TRBCTL_NORMAL;
825 * This is only possible with faulty memory because we
826 * checked it already :)
831 /* always enable Continue on Short Packet */
832 trb->ctrl |= DWC3_TRB_CTRL_CSP;
834 if (!req->request.no_interrupt && !chain)
835 trb->ctrl |= DWC3_TRB_CTRL_IOC | DWC3_TRB_CTRL_ISP_IMI;
838 trb->ctrl |= DWC3_TRB_CTRL_LST;
841 trb->ctrl |= DWC3_TRB_CTRL_CHN;
843 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
844 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(req->request.stream_id);
846 trb->ctrl |= DWC3_TRB_CTRL_HWO;
848 dep->queued_requests++;
850 trace_dwc3_prepare_trb(dep, trb);
854 * dwc3_ep_prev_trb() - Returns the previous TRB in the ring
855 * @dep: The endpoint with the TRB ring
856 * @index: The index of the current TRB in the ring
858 * Returns the TRB prior to the one pointed to by the index. If the
859 * index is 0, we will wrap backwards, skip the link TRB, and return
860 * the one just before that.
862 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
865 index = DWC3_TRB_NUM - 2;
867 index = dep->trb_enqueue - 1;
869 return &dep->trb_pool[index];
872 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
874 struct dwc3_trb *tmp;
878 * If enqueue & dequeue are equal than it is either full or empty.
880 * One way to know for sure is if the TRB right before us has HWO bit
881 * set or not. If it has, then we're definitely full and can't fit any
882 * more transfers in our ring.
884 if (dep->trb_enqueue == dep->trb_dequeue) {
885 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
886 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
889 return DWC3_TRB_NUM - 1;
892 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
893 trbs_left &= (DWC3_TRB_NUM - 1);
895 if (dep->trb_dequeue < dep->trb_enqueue)
901 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
902 struct dwc3_request *req, unsigned int trbs_left,
903 unsigned int more_coming)
905 struct usb_request *request = &req->request;
906 struct scatterlist *sg = request->sg;
907 struct scatterlist *s;
908 unsigned int last = false;
913 for_each_sg(sg, s, request->num_mapped_sgs, i) {
914 unsigned chain = true;
916 length = sg_dma_len(s);
917 dma = sg_dma_address(s);
920 if (usb_endpoint_xfer_int(dep->endpoint.desc) ||
933 dwc3_prepare_one_trb(dep, req, dma, length,
941 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
942 struct dwc3_request *req, unsigned int trbs_left,
943 unsigned int more_coming)
945 unsigned int last = false;
949 dma = req->request.dma;
950 length = req->request.length;
955 /* Is this the last request? */
956 if (usb_endpoint_xfer_int(dep->endpoint.desc) || !more_coming)
959 dwc3_prepare_one_trb(dep, req, dma, length,
964 * dwc3_prepare_trbs - setup TRBs from requests
965 * @dep: endpoint for which requests are being prepared
967 * The function goes through the requests list and sets up TRBs for the
968 * transfers. The function returns once there are no more TRBs available or
969 * it runs out of requests.
971 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
973 struct dwc3_request *req, *n;
974 unsigned int more_coming;
977 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
979 trbs_left = dwc3_calc_trbs_left(dep);
983 more_coming = dep->allocated_requests - dep->queued_requests;
985 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
986 if (req->request.num_mapped_sgs > 0)
987 dwc3_prepare_one_trb_sg(dep, req, trbs_left--,
990 dwc3_prepare_one_trb_linear(dep, req, trbs_left--,
998 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep, u16 cmd_param)
1000 struct dwc3_gadget_ep_cmd_params params;
1001 struct dwc3_request *req;
1002 struct dwc3 *dwc = dep->dwc;
1007 starting = !(dep->flags & DWC3_EP_BUSY);
1009 dwc3_prepare_trbs(dep);
1010 req = next_request(&dep->started_list);
1012 dep->flags |= DWC3_EP_PENDING_REQUEST;
1016 memset(¶ms, 0, sizeof(params));
1019 params.param0 = upper_32_bits(req->trb_dma);
1020 params.param1 = lower_32_bits(req->trb_dma);
1021 cmd = DWC3_DEPCMD_STARTTRANSFER |
1022 DWC3_DEPCMD_PARAM(cmd_param);
1024 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1025 DWC3_DEPCMD_PARAM(dep->resource_index);
1028 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
1031 * FIXME we need to iterate over the list of requests
1032 * here and stop, unmap, free and del each of the linked
1033 * requests instead of what we do now.
1035 usb_gadget_unmap_request(&dwc->gadget, &req->request,
1037 list_del(&req->list);
1041 dep->flags |= DWC3_EP_BUSY;
1044 dep->resource_index = dwc3_gadget_ep_get_transfer_index(dep);
1045 WARN_ON_ONCE(!dep->resource_index);
1051 static void __dwc3_gadget_start_isoc(struct dwc3 *dwc,
1052 struct dwc3_ep *dep, u32 cur_uf)
1056 if (list_empty(&dep->pending_list)) {
1057 dwc3_trace(trace_dwc3_gadget,
1058 "ISOC ep %s run out for requests",
1060 dep->flags |= DWC3_EP_PENDING_REQUEST;
1064 /* 4 micro frames in the future */
1065 uf = cur_uf + dep->interval * 4;
1067 __dwc3_gadget_kick_transfer(dep, uf);
1070 static void dwc3_gadget_start_isoc(struct dwc3 *dwc,
1071 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
1075 mask = ~(dep->interval - 1);
1076 cur_uf = event->parameters & mask;
1078 __dwc3_gadget_start_isoc(dwc, dep, cur_uf);
1081 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1083 struct dwc3 *dwc = dep->dwc;
1086 if (!dep->endpoint.desc) {
1087 dwc3_trace(trace_dwc3_gadget,
1088 "trying to queue request %p to disabled %s",
1089 &req->request, dep->endpoint.name);
1093 if (WARN(req->dep != dep, "request %p belongs to '%s'\n",
1094 &req->request, req->dep->name)) {
1095 dwc3_trace(trace_dwc3_gadget, "request %p belongs to '%s'",
1096 &req->request, req->dep->name);
1100 pm_runtime_get(dwc->dev);
1102 req->request.actual = 0;
1103 req->request.status = -EINPROGRESS;
1104 req->direction = dep->direction;
1105 req->epnum = dep->number;
1107 trace_dwc3_ep_queue(req);
1110 * Per databook, the total size of buffer must be a multiple
1111 * of MaxPacketSize for OUT endpoints. And MaxPacketSize is
1112 * configed for endpoints in dwc3_gadget_set_ep_config(),
1113 * set to usb_endpoint_descriptor->wMaxPacketSize.
1115 if (dep->direction == 0 &&
1116 req->request.length % dep->endpoint.desc->wMaxPacketSize)
1117 req->request.length = roundup(req->request.length,
1118 dep->endpoint.desc->wMaxPacketSize);
1121 * We only add to our list of requests now and
1122 * start consuming the list once we get XferNotReady
1125 * That way, we avoid doing anything that we don't need
1126 * to do now and defer it until the point we receive a
1127 * particular token from the Host side.
1129 * This will also avoid Host cancelling URBs due to too
1132 ret = usb_gadget_map_request(&dwc->gadget, &req->request,
1137 list_add_tail(&req->list, &dep->pending_list);
1140 * If there are no pending requests and the endpoint isn't already
1141 * busy, we will just start the request straight away.
1143 * This will save one IRQ (XFER_NOT_READY) and possibly make it a
1144 * little bit faster.
1146 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1147 !usb_endpoint_xfer_int(dep->endpoint.desc) &&
1148 !(dep->flags & DWC3_EP_BUSY)) {
1149 ret = __dwc3_gadget_kick_transfer(dep, 0);
1154 * There are a few special cases:
1156 * 1. XferNotReady with empty list of requests. We need to kick the
1157 * transfer here in that situation, otherwise we will be NAKing
1158 * forever. If we get XferNotReady before gadget driver has a
1159 * chance to queue a request, we will ACK the IRQ but won't be
1160 * able to receive the data until the next request is queued.
1161 * The following code is handling exactly that.
1164 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
1166 * If xfernotready is already elapsed and it is a case
1167 * of isoc transfer, then issue END TRANSFER, so that
1168 * you can receive xfernotready again and can have
1169 * notion of current microframe.
1171 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1172 if (list_empty(&dep->started_list)) {
1173 dwc3_stop_active_transfer(dwc, dep->number, true);
1174 dep->flags = DWC3_EP_ENABLED;
1179 ret = __dwc3_gadget_kick_transfer(dep, 0);
1181 dep->flags &= ~DWC3_EP_PENDING_REQUEST;
1187 * 2. XferInProgress on Isoc EP with an active transfer. We need to
1188 * kick the transfer here after queuing a request, otherwise the
1189 * core may not see the modified TRB(s).
1191 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
1192 (dep->flags & DWC3_EP_BUSY) &&
1193 !(dep->flags & DWC3_EP_MISSED_ISOC)) {
1194 WARN_ON_ONCE(!dep->resource_index);
1195 ret = __dwc3_gadget_kick_transfer(dep, dep->resource_index);
1200 * 4. Stream Capable Bulk Endpoints. We need to start the transfer
1201 * right away, otherwise host will not know we have streams to be
1204 if (dep->stream_capable)
1205 ret = __dwc3_gadget_kick_transfer(dep, 0);
1208 if (ret && ret != -EBUSY)
1209 dwc3_trace(trace_dwc3_gadget,
1210 "%s: failed to kick transfers",
1218 static void __dwc3_gadget_ep_zlp_complete(struct usb_ep *ep,
1219 struct usb_request *request)
1221 dwc3_gadget_ep_free_request(ep, request);
1224 static int __dwc3_gadget_ep_queue_zlp(struct dwc3 *dwc, struct dwc3_ep *dep)
1226 struct dwc3_request *req;
1227 struct usb_request *request;
1228 struct usb_ep *ep = &dep->endpoint;
1230 dwc3_trace(trace_dwc3_gadget, "queueing ZLP");
1231 request = dwc3_gadget_ep_alloc_request(ep, GFP_ATOMIC);
1235 request->length = 0;
1236 request->buf = dwc->zlp_buf;
1237 request->complete = __dwc3_gadget_ep_zlp_complete;
1239 req = to_dwc3_request(request);
1241 return __dwc3_gadget_ep_queue(dep, req);
1244 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1247 struct dwc3_request *req = to_dwc3_request(request);
1248 struct dwc3_ep *dep = to_dwc3_ep(ep);
1249 struct dwc3 *dwc = dep->dwc;
1251 unsigned long flags;
1255 spin_lock_irqsave(&dwc->lock, flags);
1256 ret = __dwc3_gadget_ep_queue(dep, req);
1259 * Okay, here's the thing, if gadget driver has requested for a ZLP by
1260 * setting request->zero, instead of doing magic, we will just queue an
1261 * extra usb_request ourselves so that it gets handled the same way as
1262 * any other request.
1264 if (ret == 0 && request->zero && request->length &&
1265 (request->length % ep->desc->wMaxPacketSize == 0))
1266 ret = __dwc3_gadget_ep_queue_zlp(dwc, dep);
1268 spin_unlock_irqrestore(&dwc->lock, flags);
1273 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1274 struct usb_request *request)
1276 struct dwc3_request *req = to_dwc3_request(request);
1277 struct dwc3_request *r = NULL;
1279 struct dwc3_ep *dep = to_dwc3_ep(ep);
1280 struct dwc3 *dwc = dep->dwc;
1282 unsigned long flags;
1285 trace_dwc3_ep_dequeue(req);
1287 spin_lock_irqsave(&dwc->lock, flags);
1289 list_for_each_entry(r, &dep->pending_list, list) {
1295 list_for_each_entry(r, &dep->started_list, list) {
1300 /* wait until it is processed */
1301 dwc3_stop_active_transfer(dwc, dep->number, true);
1304 dev_err(dwc->dev, "request %p was not queued to %s\n",
1311 /* giveback the request */
1312 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1315 spin_unlock_irqrestore(&dwc->lock, flags);
1320 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1322 struct dwc3_gadget_ep_cmd_params params;
1323 struct dwc3 *dwc = dep->dwc;
1326 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1327 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1331 memset(¶ms, 0x00, sizeof(params));
1334 struct dwc3_trb *trb;
1336 unsigned transfer_in_flight;
1339 if (dep->number > 1)
1340 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1342 trb = &dwc->ep0_trb[dep->trb_enqueue];
1344 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1345 started = !list_empty(&dep->started_list);
1347 if (!protocol && ((dep->direction && transfer_in_flight) ||
1348 (!dep->direction && started))) {
1349 dwc3_trace(trace_dwc3_gadget,
1350 "%s: pending request, cannot halt",
1355 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1358 dev_err(dwc->dev, "failed to set STALL on %s\n",
1361 dep->flags |= DWC3_EP_STALL;
1364 ret = dwc3_send_clear_stall_ep_cmd(dep);
1366 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1369 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1375 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1377 struct dwc3_ep *dep = to_dwc3_ep(ep);
1378 struct dwc3 *dwc = dep->dwc;
1380 unsigned long flags;
1384 spin_lock_irqsave(&dwc->lock, flags);
1385 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1386 spin_unlock_irqrestore(&dwc->lock, flags);
1391 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1393 struct dwc3_ep *dep = to_dwc3_ep(ep);
1394 struct dwc3 *dwc = dep->dwc;
1395 unsigned long flags;
1398 spin_lock_irqsave(&dwc->lock, flags);
1399 dep->flags |= DWC3_EP_WEDGE;
1401 if (dep->number == 0 || dep->number == 1)
1402 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1404 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1405 spin_unlock_irqrestore(&dwc->lock, flags);
1410 /* -------------------------------------------------------------------------- */
1412 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1413 .bLength = USB_DT_ENDPOINT_SIZE,
1414 .bDescriptorType = USB_DT_ENDPOINT,
1415 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1418 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1419 .enable = dwc3_gadget_ep0_enable,
1420 .disable = dwc3_gadget_ep0_disable,
1421 .alloc_request = dwc3_gadget_ep_alloc_request,
1422 .free_request = dwc3_gadget_ep_free_request,
1423 .queue = dwc3_gadget_ep0_queue,
1424 .dequeue = dwc3_gadget_ep_dequeue,
1425 .set_halt = dwc3_gadget_ep0_set_halt,
1426 .set_wedge = dwc3_gadget_ep_set_wedge,
1429 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1430 .enable = dwc3_gadget_ep_enable,
1431 .disable = dwc3_gadget_ep_disable,
1432 .alloc_request = dwc3_gadget_ep_alloc_request,
1433 .free_request = dwc3_gadget_ep_free_request,
1434 .queue = dwc3_gadget_ep_queue,
1435 .dequeue = dwc3_gadget_ep_dequeue,
1436 .set_halt = dwc3_gadget_ep_set_halt,
1437 .set_wedge = dwc3_gadget_ep_set_wedge,
1440 /* -------------------------------------------------------------------------- */
1442 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1444 struct dwc3 *dwc = gadget_to_dwc(g);
1447 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1448 return DWC3_DSTS_SOFFN(reg);
1451 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1453 unsigned long timeout;
1462 * According to the Databook Remote wakeup request should
1463 * be issued only when the device is in early suspend state.
1465 * We can check that via USB Link State bits in DSTS register.
1467 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1469 speed = reg & DWC3_DSTS_CONNECTSPD;
1470 if (speed == DWC3_DSTS_SUPERSPEED) {
1471 dwc3_trace(trace_dwc3_gadget, "no wakeup on SuperSpeed");
1475 link_state = DWC3_DSTS_USBLNKST(reg);
1477 switch (link_state) {
1478 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1479 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1482 dwc3_trace(trace_dwc3_gadget,
1483 "can't wakeup from '%s'",
1484 dwc3_gadget_link_string(link_state));
1488 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1490 dev_err(dwc->dev, "failed to put link in Recovery\n");
1494 /* Recent versions do this automatically */
1495 if (dwc->revision < DWC3_REVISION_194A) {
1496 /* write zeroes to Link Change Request */
1497 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1498 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1499 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1502 /* poll until Link State changes to ON */
1503 timeout = jiffies + msecs_to_jiffies(100);
1505 while (!time_after(jiffies, timeout)) {
1506 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1508 /* in HS, means ON */
1509 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1513 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1514 dev_err(dwc->dev, "failed to send remote wakeup\n");
1521 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1523 struct dwc3 *dwc = gadget_to_dwc(g);
1524 unsigned long flags;
1527 spin_lock_irqsave(&dwc->lock, flags);
1528 ret = __dwc3_gadget_wakeup(dwc);
1529 spin_unlock_irqrestore(&dwc->lock, flags);
1534 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1537 struct dwc3 *dwc = gadget_to_dwc(g);
1538 unsigned long flags;
1540 spin_lock_irqsave(&dwc->lock, flags);
1541 g->is_selfpowered = !!is_selfpowered;
1542 spin_unlock_irqrestore(&dwc->lock, flags);
1547 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1552 if (pm_runtime_suspended(dwc->dev))
1555 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1557 if (dwc->revision <= DWC3_REVISION_187A) {
1558 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1559 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1562 if (dwc->revision >= DWC3_REVISION_194A)
1563 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1564 reg |= DWC3_DCTL_RUN_STOP;
1566 if (dwc->has_hibernation)
1567 reg |= DWC3_DCTL_KEEP_CONNECT;
1569 dwc->pullups_connected = true;
1571 reg &= ~DWC3_DCTL_RUN_STOP;
1573 if (dwc->has_hibernation && !suspend)
1574 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1576 dwc->pullups_connected = false;
1579 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1582 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1584 if (!(reg & DWC3_DSTS_DEVCTRLHLT))
1587 if (reg & DWC3_DSTS_DEVCTRLHLT)
1596 dwc3_trace(trace_dwc3_gadget, "gadget %s data soft-%s",
1598 ? dwc->gadget_driver->function : "no-function",
1599 is_on ? "connect" : "disconnect");
1604 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1606 struct dwc3 *dwc = gadget_to_dwc(g);
1607 unsigned long flags;
1612 spin_lock_irqsave(&dwc->lock, flags);
1613 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1614 spin_unlock_irqrestore(&dwc->lock, flags);
1619 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1623 /* Enable all but Start and End of Frame IRQs */
1624 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1625 DWC3_DEVTEN_EVNTOVERFLOWEN |
1626 DWC3_DEVTEN_CMDCMPLTEN |
1627 DWC3_DEVTEN_ERRTICERREN |
1628 DWC3_DEVTEN_WKUPEVTEN |
1629 DWC3_DEVTEN_ULSTCNGEN |
1630 DWC3_DEVTEN_CONNECTDONEEN |
1631 DWC3_DEVTEN_USBRSTEN |
1632 DWC3_DEVTEN_DISCONNEVTEN);
1634 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1637 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1639 /* mask all interrupts */
1640 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1643 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1644 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1647 * dwc3_gadget_setup_nump - Calculate and initialize NUMP field of DCFG
1648 * dwc: pointer to our context structure
1650 * The following looks like complex but it's actually very simple. In order to
1651 * calculate the number of packets we can burst at once on OUT transfers, we're
1652 * gonna use RxFIFO size.
1654 * To calculate RxFIFO size we need two numbers:
1655 * MDWIDTH = size, in bits, of the internal memory bus
1656 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1658 * Given these two numbers, the formula is simple:
1660 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1662 * 24 bytes is for 3x SETUP packets
1663 * 16 bytes is a clock domain crossing tolerance
1665 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1667 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1674 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1675 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1677 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1678 nump = min_t(u32, nump, 16);
1681 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1682 reg &= ~DWC3_DCFG_NUMP_MASK;
1683 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1684 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1687 static int __dwc3_gadget_start(struct dwc3 *dwc)
1689 struct dwc3_ep *dep;
1693 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1694 reg &= ~(DWC3_DCFG_SPEED_MASK);
1697 * WORKAROUND: DWC3 revision < 2.20a have an issue
1698 * which would cause metastability state on Run/Stop
1699 * bit if we try to force the IP to USB2-only mode.
1701 * Because of that, we cannot configure the IP to any
1702 * speed other than the SuperSpeed
1706 * STAR#9000525659: Clock Domain Crossing on DCTL in
1709 if (dwc->revision < DWC3_REVISION_220A) {
1710 reg |= DWC3_DCFG_SUPERSPEED;
1712 switch (dwc->maximum_speed) {
1714 reg |= DWC3_DCFG_LOWSPEED;
1716 case USB_SPEED_FULL:
1717 reg |= DWC3_DCFG_FULLSPEED1;
1719 case USB_SPEED_HIGH:
1720 reg |= DWC3_DCFG_HIGHSPEED;
1722 case USB_SPEED_SUPER: /* FALLTHROUGH */
1723 case USB_SPEED_UNKNOWN: /* FALTHROUGH */
1725 reg |= DWC3_DCFG_SUPERSPEED;
1728 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1731 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1732 * field instead of letting dwc3 itself calculate that automatically.
1734 * This way, we maximize the chances that we'll be able to get several
1735 * bursts of data without going through any sort of endpoint throttling.
1737 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1738 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1739 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1741 dwc3_gadget_setup_nump(dwc);
1743 /* Start with SuperSpeed Default */
1744 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1747 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1750 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1755 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, false,
1758 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1762 /* begin to receive SETUP packets */
1763 dwc->ep0state = EP0_SETUP_PHASE;
1764 dwc3_ep0_out_start(dwc);
1766 dwc3_gadget_enable_irq(dwc);
1771 __dwc3_gadget_ep_disable(dwc->eps[0]);
1777 static int dwc3_gadget_start(struct usb_gadget *g,
1778 struct usb_gadget_driver *driver)
1780 struct dwc3 *dwc = gadget_to_dwc(g);
1781 unsigned long flags;
1785 irq = platform_get_irq(to_platform_device(dwc->dev), 0);
1786 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
1787 IRQF_SHARED, "dwc3", dwc->ev_buf);
1789 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
1793 dwc->irq_gadget = irq;
1795 spin_lock_irqsave(&dwc->lock, flags);
1796 if (dwc->gadget_driver) {
1797 dev_err(dwc->dev, "%s is already bound to %s\n",
1799 dwc->gadget_driver->driver.name);
1804 dwc->gadget_driver = driver;
1806 if (pm_runtime_active(dwc->dev))
1807 __dwc3_gadget_start(dwc);
1809 spin_unlock_irqrestore(&dwc->lock, flags);
1814 spin_unlock_irqrestore(&dwc->lock, flags);
1821 static void __dwc3_gadget_stop(struct dwc3 *dwc)
1823 dwc3_gadget_disable_irq(dwc);
1824 __dwc3_gadget_ep_disable(dwc->eps[0]);
1825 __dwc3_gadget_ep_disable(dwc->eps[1]);
1828 static int dwc3_gadget_stop(struct usb_gadget *g)
1830 struct dwc3 *dwc = gadget_to_dwc(g);
1831 unsigned long flags;
1833 spin_lock_irqsave(&dwc->lock, flags);
1834 __dwc3_gadget_stop(dwc);
1835 dwc->gadget_driver = NULL;
1836 spin_unlock_irqrestore(&dwc->lock, flags);
1838 free_irq(dwc->irq_gadget, dwc->ev_buf);
1843 static const struct usb_gadget_ops dwc3_gadget_ops = {
1844 .get_frame = dwc3_gadget_get_frame,
1845 .wakeup = dwc3_gadget_wakeup,
1846 .set_selfpowered = dwc3_gadget_set_selfpowered,
1847 .pullup = dwc3_gadget_pullup,
1848 .udc_start = dwc3_gadget_start,
1849 .udc_stop = dwc3_gadget_stop,
1852 /* -------------------------------------------------------------------------- */
1854 static int dwc3_gadget_init_hw_endpoints(struct dwc3 *dwc,
1855 u8 num, u32 direction)
1857 struct dwc3_ep *dep;
1860 for (i = 0; i < num; i++) {
1861 u8 epnum = (i << 1) | (direction ? 1 : 0);
1863 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1868 dep->number = epnum;
1869 dep->direction = !!direction;
1870 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
1871 dwc->eps[epnum] = dep;
1873 snprintf(dep->name, sizeof(dep->name), "ep%d%s", epnum >> 1,
1874 (epnum & 1) ? "in" : "out");
1876 dep->endpoint.name = dep->name;
1877 spin_lock_init(&dep->lock);
1879 dwc3_trace(trace_dwc3_gadget, "initializing %s", dep->name);
1881 if (epnum == 0 || epnum == 1) {
1882 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
1883 dep->endpoint.maxburst = 1;
1884 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
1886 dwc->gadget.ep0 = &dep->endpoint;
1890 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
1891 dep->endpoint.max_streams = 15;
1892 dep->endpoint.ops = &dwc3_gadget_ep_ops;
1893 list_add_tail(&dep->endpoint.ep_list,
1894 &dwc->gadget.ep_list);
1896 ret = dwc3_alloc_trb_pool(dep);
1901 if (epnum == 0 || epnum == 1) {
1902 dep->endpoint.caps.type_control = true;
1904 dep->endpoint.caps.type_iso = true;
1905 dep->endpoint.caps.type_bulk = true;
1906 dep->endpoint.caps.type_int = true;
1909 dep->endpoint.caps.dir_in = !!direction;
1910 dep->endpoint.caps.dir_out = !direction;
1912 INIT_LIST_HEAD(&dep->pending_list);
1913 INIT_LIST_HEAD(&dep->started_list);
1919 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc)
1923 INIT_LIST_HEAD(&dwc->gadget.ep_list);
1925 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_out_eps, 0);
1927 dwc3_trace(trace_dwc3_gadget,
1928 "failed to allocate OUT endpoints");
1932 ret = dwc3_gadget_init_hw_endpoints(dwc, dwc->num_in_eps, 1);
1934 dwc3_trace(trace_dwc3_gadget,
1935 "failed to allocate IN endpoints");
1942 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
1944 struct dwc3_ep *dep;
1947 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
1948 dep = dwc->eps[epnum];
1952 * Physical endpoints 0 and 1 are special; they form the
1953 * bi-directional USB endpoint 0.
1955 * For those two physical endpoints, we don't allocate a TRB
1956 * pool nor do we add them the endpoints list. Due to that, we
1957 * shouldn't do these two operations otherwise we would end up
1958 * with all sorts of bugs when removing dwc3.ko.
1960 if (epnum != 0 && epnum != 1) {
1961 dwc3_free_trb_pool(dep);
1962 list_del(&dep->endpoint.ep_list);
1969 /* -------------------------------------------------------------------------- */
1971 static int __dwc3_cleanup_done_trbs(struct dwc3 *dwc, struct dwc3_ep *dep,
1972 struct dwc3_request *req, struct dwc3_trb *trb,
1973 const struct dwc3_event_depevt *event, int status)
1976 unsigned int s_pkt = 0;
1977 unsigned int trb_status;
1979 dep->queued_requests--;
1980 trace_dwc3_complete_trb(dep, trb);
1982 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
1984 * We continue despite the error. There is not much we
1985 * can do. If we don't clean it up we loop forever. If
1986 * we skip the TRB then it gets overwritten after a
1987 * while since we use them in a ring buffer. A BUG()
1988 * would help. Lets hope that if this occurs, someone
1989 * fixes the root cause instead of looking away :)
1991 dev_err(dwc->dev, "%s's TRB (%p) still owned by HW\n",
1993 count = trb->size & DWC3_TRB_SIZE_MASK;
1995 if (dep->direction) {
1997 trb_status = DWC3_TRB_SIZE_TRBSTS(trb->size);
1998 if (trb_status == DWC3_TRBSTS_MISSED_ISOC) {
1999 dwc3_trace(trace_dwc3_gadget,
2000 "%s: incomplete IN transfer",
2003 * If missed isoc occurred and there is
2004 * no request queued then issue END
2005 * TRANSFER, so that core generates
2006 * next xfernotready and we will issue
2007 * a fresh START TRANSFER.
2008 * If there are still queued request
2009 * then wait, do not issue either END
2010 * or UPDATE TRANSFER, just attach next
2011 * request in pending_list during
2012 * giveback.If any future queued request
2013 * is successfully transferred then we
2014 * will issue UPDATE TRANSFER for all
2015 * request in the pending_list.
2017 dep->flags |= DWC3_EP_MISSED_ISOC;
2019 dev_err(dwc->dev, "incomplete IN transfer %s\n",
2021 status = -ECONNRESET;
2024 dep->flags &= ~DWC3_EP_MISSED_ISOC;
2027 if (count && (event->status & DEPEVT_STATUS_SHORT))
2032 * We assume here we will always receive the entire data block
2033 * which we should receive. Meaning, if we program RX to
2034 * receive 4K but we receive only 2K, we assume that's all we
2035 * should receive and we simply bounce the request back to the
2036 * gadget driver for further processing.
2038 req->request.actual += req->request.length - count;
2041 if ((event->status & DEPEVT_STATUS_LST) &&
2042 (trb->ctrl & (DWC3_TRB_CTRL_LST |
2043 DWC3_TRB_CTRL_HWO)))
2045 if ((event->status & DEPEVT_STATUS_IOC) &&
2046 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2051 static int dwc3_cleanup_done_reqs(struct dwc3 *dwc, struct dwc3_ep *dep,
2052 const struct dwc3_event_depevt *event, int status)
2054 struct dwc3_request *req;
2055 struct dwc3_trb *trb;
2061 req = next_request(&dep->started_list);
2062 if (WARN_ON_ONCE(!req))
2067 slot = req->first_trb_index + i;
2068 if (slot == DWC3_TRB_NUM - 1)
2070 slot %= DWC3_TRB_NUM;
2071 trb = &dep->trb_pool[slot];
2073 ret = __dwc3_cleanup_done_trbs(dwc, dep, req, trb,
2077 } while (++i < req->request.num_mapped_sgs);
2079 dwc3_gadget_giveback(dep, req, status);
2086 * Our endpoint might get disabled by another thread during
2087 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2088 * early on so DWC3_EP_BUSY flag gets cleared
2090 if (!dep->endpoint.desc)
2093 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2094 list_empty(&dep->started_list)) {
2095 if (list_empty(&dep->pending_list)) {
2097 * If there is no entry in request list then do
2098 * not issue END TRANSFER now. Just set PENDING
2099 * flag, so that END TRANSFER is issued when an
2100 * entry is added into request list.
2102 dep->flags = DWC3_EP_PENDING_REQUEST;
2104 dwc3_stop_active_transfer(dwc, dep->number, true);
2105 dep->flags = DWC3_EP_ENABLED;
2110 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
2111 if ((event->status & DEPEVT_STATUS_IOC) &&
2112 (trb->ctrl & DWC3_TRB_CTRL_IOC))
2117 static void dwc3_endpoint_transfer_complete(struct dwc3 *dwc,
2118 struct dwc3_ep *dep, const struct dwc3_event_depevt *event)
2120 unsigned status = 0;
2122 u32 is_xfer_complete;
2124 is_xfer_complete = (event->endpoint_event == DWC3_DEPEVT_XFERCOMPLETE);
2126 if (event->status & DEPEVT_STATUS_BUSERR)
2127 status = -ECONNRESET;
2129 clean_busy = dwc3_cleanup_done_reqs(dwc, dep, event, status);
2130 if (clean_busy && (!dep->endpoint.desc || is_xfer_complete ||
2131 usb_endpoint_xfer_isoc(dep->endpoint.desc)))
2132 dep->flags &= ~DWC3_EP_BUSY;
2135 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2136 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2138 if (dwc->revision < DWC3_REVISION_183A) {
2142 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2145 if (!(dep->flags & DWC3_EP_ENABLED))
2148 if (!list_empty(&dep->started_list))
2152 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2154 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2160 * Our endpoint might get disabled by another thread during
2161 * dwc3_gadget_giveback(). If that happens, we're just gonna return 1
2162 * early on so DWC3_EP_BUSY flag gets cleared
2164 if (!dep->endpoint.desc)
2167 if (!usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2170 ret = __dwc3_gadget_kick_transfer(dep, 0);
2171 if (!ret || ret == -EBUSY)
2176 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2177 const struct dwc3_event_depevt *event)
2179 struct dwc3_ep *dep;
2180 u8 epnum = event->endpoint_number;
2182 dep = dwc->eps[epnum];
2184 if (!(dep->flags & DWC3_EP_ENABLED))
2187 if (epnum == 0 || epnum == 1) {
2188 dwc3_ep0_interrupt(dwc, event);
2192 switch (event->endpoint_event) {
2193 case DWC3_DEPEVT_XFERCOMPLETE:
2194 dep->resource_index = 0;
2196 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2197 dwc3_trace(trace_dwc3_gadget,
2198 "%s is an Isochronous endpoint",
2203 dwc3_endpoint_transfer_complete(dwc, dep, event);
2205 case DWC3_DEPEVT_XFERINPROGRESS:
2206 dwc3_endpoint_transfer_complete(dwc, dep, event);
2208 case DWC3_DEPEVT_XFERNOTREADY:
2209 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
2210 dwc3_gadget_start_isoc(dwc, dep, event);
2215 active = event->status & DEPEVT_STATUS_TRANSFER_ACTIVE;
2217 dwc3_trace(trace_dwc3_gadget, "%s: reason %s",
2218 dep->name, active ? "Transfer Active"
2219 : "Transfer Not Active");
2221 ret = __dwc3_gadget_kick_transfer(dep, 0);
2222 if (!ret || ret == -EBUSY)
2225 dwc3_trace(trace_dwc3_gadget,
2226 "%s: failed to kick transfers",
2231 case DWC3_DEPEVT_STREAMEVT:
2232 if (!usb_endpoint_xfer_bulk(dep->endpoint.desc)) {
2233 dev_err(dwc->dev, "Stream event for non-Bulk %s\n",
2238 switch (event->status) {
2239 case DEPEVT_STREAMEVT_FOUND:
2240 dwc3_trace(trace_dwc3_gadget,
2241 "Stream %d found and started",
2245 case DEPEVT_STREAMEVT_NOTFOUND:
2248 dwc3_trace(trace_dwc3_gadget,
2249 "unable to find suitable stream");
2252 case DWC3_DEPEVT_RXTXFIFOEVT:
2253 dwc3_trace(trace_dwc3_gadget, "%s FIFO Overrun", dep->name);
2255 case DWC3_DEPEVT_EPCMDCMPLT:
2256 dwc3_trace(trace_dwc3_gadget, "Endpoint Command Complete");
2261 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2263 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2264 spin_unlock(&dwc->lock);
2265 dwc->gadget_driver->disconnect(&dwc->gadget);
2266 spin_lock(&dwc->lock);
2270 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2272 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2273 spin_unlock(&dwc->lock);
2274 dwc->gadget_driver->suspend(&dwc->gadget);
2275 spin_lock(&dwc->lock);
2279 static void dwc3_resume_gadget(struct dwc3 *dwc)
2281 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2282 spin_unlock(&dwc->lock);
2283 dwc->gadget_driver->resume(&dwc->gadget);
2284 spin_lock(&dwc->lock);
2288 static void dwc3_reset_gadget(struct dwc3 *dwc)
2290 if (!dwc->gadget_driver)
2293 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2294 spin_unlock(&dwc->lock);
2295 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2296 spin_lock(&dwc->lock);
2300 static void dwc3_stop_active_transfer(struct dwc3 *dwc, u32 epnum, bool force)
2302 struct dwc3_ep *dep;
2303 struct dwc3_gadget_ep_cmd_params params;
2307 dep = dwc->eps[epnum];
2309 if (!dep->resource_index)
2313 * NOTICE: We are violating what the Databook says about the
2314 * EndTransfer command. Ideally we would _always_ wait for the
2315 * EndTransfer Command Completion IRQ, but that's causing too
2316 * much trouble synchronizing between us and gadget driver.
2318 * We have discussed this with the IP Provider and it was
2319 * suggested to giveback all requests here, but give HW some
2320 * extra time to synchronize with the interconnect. We're using
2321 * an arbitrary 100us delay for that.
2323 * Note also that a similar handling was tested by Synopsys
2324 * (thanks a lot Paul) and nothing bad has come out of it.
2325 * In short, what we're doing is:
2327 * - Issue EndTransfer WITH CMDIOC bit set
2331 cmd = DWC3_DEPCMD_ENDTRANSFER;
2332 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2333 cmd |= DWC3_DEPCMD_CMDIOC;
2334 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2335 memset(¶ms, 0, sizeof(params));
2336 ret = dwc3_send_gadget_ep_cmd(dep, cmd, ¶ms);
2338 dep->resource_index = 0;
2339 dep->flags &= ~DWC3_EP_BUSY;
2343 static void dwc3_stop_active_transfers(struct dwc3 *dwc)
2347 for (epnum = 2; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2348 struct dwc3_ep *dep;
2350 dep = dwc->eps[epnum];
2354 if (!(dep->flags & DWC3_EP_ENABLED))
2357 dwc3_remove_requests(dwc, dep);
2361 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2365 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2366 struct dwc3_ep *dep;
2369 dep = dwc->eps[epnum];
2373 if (!(dep->flags & DWC3_EP_STALL))
2376 dep->flags &= ~DWC3_EP_STALL;
2378 ret = dwc3_send_clear_stall_ep_cmd(dep);
2383 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2387 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2388 reg &= ~DWC3_DCTL_INITU1ENA;
2389 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2391 reg &= ~DWC3_DCTL_INITU2ENA;
2392 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2394 dwc3_disconnect_gadget(dwc);
2396 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2397 dwc->setup_packet_pending = false;
2398 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2400 dwc->connected = false;
2403 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2407 dwc->connected = true;
2410 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2411 * would cause a missing Disconnect Event if there's a
2412 * pending Setup Packet in the FIFO.
2414 * There's no suggested workaround on the official Bug
2415 * report, which states that "unless the driver/application
2416 * is doing any special handling of a disconnect event,
2417 * there is no functional issue".
2419 * Unfortunately, it turns out that we _do_ some special
2420 * handling of a disconnect event, namely complete all
2421 * pending transfers, notify gadget driver of the
2422 * disconnection, and so on.
2424 * Our suggested workaround is to follow the Disconnect
2425 * Event steps here, instead, based on a setup_packet_pending
2426 * flag. Such flag gets set whenever we have a SETUP_PENDING
2427 * status for EP0 TRBs and gets cleared on XferComplete for the
2432 * STAR#9000466709: RTL: Device : Disconnect event not
2433 * generated if setup packet pending in FIFO
2435 if (dwc->revision < DWC3_REVISION_188A) {
2436 if (dwc->setup_packet_pending)
2437 dwc3_gadget_disconnect_interrupt(dwc);
2440 dwc3_reset_gadget(dwc);
2442 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2443 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2444 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2445 dwc->test_mode = false;
2447 dwc3_stop_active_transfers(dwc);
2448 dwc3_clear_stall_all_ep(dwc);
2450 /* Reset device address to zero */
2451 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2452 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2453 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2456 static void dwc3_update_ram_clk_sel(struct dwc3 *dwc, u32 speed)
2459 u32 usb30_clock = DWC3_GCTL_CLK_BUS;
2462 * We change the clock only at SS but I dunno why I would want to do
2463 * this. Maybe it becomes part of the power saving plan.
2466 if (speed != DWC3_DSTS_SUPERSPEED)
2470 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2471 * each time on Connect Done.
2476 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
2477 reg |= DWC3_GCTL_RAMCLKSEL(usb30_clock);
2478 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
2481 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2483 struct dwc3_ep *dep;
2488 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2489 speed = reg & DWC3_DSTS_CONNECTSPD;
2492 dwc3_update_ram_clk_sel(dwc, speed);
2495 case DWC3_DSTS_SUPERSPEED:
2497 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2498 * would cause a missing USB3 Reset event.
2500 * In such situations, we should force a USB3 Reset
2501 * event by calling our dwc3_gadget_reset_interrupt()
2506 * STAR#9000483510: RTL: SS : USB3 reset event may
2507 * not be generated always when the link enters poll
2509 if (dwc->revision < DWC3_REVISION_190A)
2510 dwc3_gadget_reset_interrupt(dwc);
2512 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2513 dwc->gadget.ep0->maxpacket = 512;
2514 dwc->gadget.speed = USB_SPEED_SUPER;
2516 case DWC3_DSTS_HIGHSPEED:
2517 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2518 dwc->gadget.ep0->maxpacket = 64;
2519 dwc->gadget.speed = USB_SPEED_HIGH;
2521 case DWC3_DSTS_FULLSPEED2:
2522 case DWC3_DSTS_FULLSPEED1:
2523 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2524 dwc->gadget.ep0->maxpacket = 64;
2525 dwc->gadget.speed = USB_SPEED_FULL;
2527 case DWC3_DSTS_LOWSPEED:
2528 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2529 dwc->gadget.ep0->maxpacket = 8;
2530 dwc->gadget.speed = USB_SPEED_LOW;
2534 /* Enable USB2 LPM Capability */
2536 if ((dwc->revision > DWC3_REVISION_194A) &&
2537 (speed != DWC3_DSTS_SUPERSPEED)) {
2538 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2539 reg |= DWC3_DCFG_LPM_CAP;
2540 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2542 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2543 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2545 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2548 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2549 * DCFG.LPMCap is set, core responses with an ACK and the
2550 * BESL value in the LPM token is less than or equal to LPM
2553 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2554 && dwc->has_lpm_erratum,
2555 "LPM Erratum not available on dwc3 revisisions < 2.40a\n");
2557 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2558 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2560 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2562 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2563 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2564 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2568 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2571 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2576 ret = __dwc3_gadget_ep_enable(dep, &dwc3_gadget_ep0_desc, NULL, true,
2579 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2584 * Configure PHY via GUSB3PIPECTLn if required.
2586 * Update GTXFIFOSIZn
2588 * In both cases reset values should be sufficient.
2592 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2595 * TODO take core out of low power mode when that's
2599 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2600 spin_unlock(&dwc->lock);
2601 dwc->gadget_driver->resume(&dwc->gadget);
2602 spin_lock(&dwc->lock);
2606 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2607 unsigned int evtinfo)
2609 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2610 unsigned int pwropt;
2613 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2614 * Hibernation mode enabled which would show up when device detects
2615 * host-initiated U3 exit.
2617 * In that case, device will generate a Link State Change Interrupt
2618 * from U3 to RESUME which is only necessary if Hibernation is
2621 * There are no functional changes due to such spurious event and we
2622 * just need to ignore it.
2626 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2629 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2630 if ((dwc->revision < DWC3_REVISION_250A) &&
2631 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2632 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2633 (next == DWC3_LINK_STATE_RESUME)) {
2634 dwc3_trace(trace_dwc3_gadget,
2635 "ignoring transition U3 -> Resume");
2641 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2642 * on the link partner, the USB session might do multiple entry/exit
2643 * of low power states before a transfer takes place.
2645 * Due to this problem, we might experience lower throughput. The
2646 * suggested workaround is to disable DCTL[12:9] bits if we're
2647 * transitioning from U1/U2 to U0 and enable those bits again
2648 * after a transfer completes and there are no pending transfers
2649 * on any of the enabled endpoints.
2651 * This is the first half of that workaround.
2655 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2656 * core send LGO_Ux entering U0
2658 if (dwc->revision < DWC3_REVISION_183A) {
2659 if (next == DWC3_LINK_STATE_U0) {
2663 switch (dwc->link_state) {
2664 case DWC3_LINK_STATE_U1:
2665 case DWC3_LINK_STATE_U2:
2666 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2667 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2668 | DWC3_DCTL_ACCEPTU2ENA
2669 | DWC3_DCTL_INITU1ENA
2670 | DWC3_DCTL_ACCEPTU1ENA);
2673 dwc->u1u2 = reg & u1u2;
2677 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2687 case DWC3_LINK_STATE_U1:
2688 if (dwc->speed == USB_SPEED_SUPER)
2689 dwc3_suspend_gadget(dwc);
2691 case DWC3_LINK_STATE_U2:
2692 case DWC3_LINK_STATE_U3:
2693 dwc3_suspend_gadget(dwc);
2695 case DWC3_LINK_STATE_RESUME:
2696 dwc3_resume_gadget(dwc);
2703 dwc->link_state = next;
2706 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
2707 unsigned int evtinfo)
2709 unsigned int is_ss = evtinfo & BIT(4);
2712 * WORKAROUND: DWC3 revison 2.20a with hibernation support
2713 * have a known issue which can cause USB CV TD.9.23 to fail
2716 * Because of this issue, core could generate bogus hibernation
2717 * events which SW needs to ignore.
2721 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
2722 * Device Fallback from SuperSpeed
2724 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
2727 /* enter hibernation here */
2730 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
2731 const struct dwc3_event_devt *event)
2733 switch (event->type) {
2734 case DWC3_DEVICE_EVENT_DISCONNECT:
2735 dwc3_gadget_disconnect_interrupt(dwc);
2737 case DWC3_DEVICE_EVENT_RESET:
2738 dwc3_gadget_reset_interrupt(dwc);
2740 case DWC3_DEVICE_EVENT_CONNECT_DONE:
2741 dwc3_gadget_conndone_interrupt(dwc);
2743 case DWC3_DEVICE_EVENT_WAKEUP:
2744 dwc3_gadget_wakeup_interrupt(dwc);
2746 case DWC3_DEVICE_EVENT_HIBER_REQ:
2747 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
2748 "unexpected hibernation event\n"))
2751 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
2753 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
2754 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
2756 case DWC3_DEVICE_EVENT_EOPF:
2757 dwc3_trace(trace_dwc3_gadget, "End of Periodic Frame");
2759 case DWC3_DEVICE_EVENT_SOF:
2760 dwc3_trace(trace_dwc3_gadget, "Start of Periodic Frame");
2762 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
2763 dwc3_trace(trace_dwc3_gadget, "Erratic Error");
2765 case DWC3_DEVICE_EVENT_CMD_CMPL:
2766 dwc3_trace(trace_dwc3_gadget, "Command Complete");
2768 case DWC3_DEVICE_EVENT_OVERFLOW:
2769 dwc3_trace(trace_dwc3_gadget, "Overflow");
2772 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
2776 static void dwc3_process_event_entry(struct dwc3 *dwc,
2777 const union dwc3_event *event)
2779 trace_dwc3_event(event->raw);
2781 /* Endpoint IRQ, handle it and return early */
2782 if (event->type.is_devspec == 0) {
2784 return dwc3_endpoint_interrupt(dwc, &event->depevt);
2787 switch (event->type.type) {
2788 case DWC3_EVENT_TYPE_DEV:
2789 dwc3_gadget_interrupt(dwc, &event->devt);
2791 /* REVISIT what to do with Carkit and I2C events ? */
2793 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
2797 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
2799 struct dwc3 *dwc = evt->dwc;
2800 irqreturn_t ret = IRQ_NONE;
2806 if (!(evt->flags & DWC3_EVENT_PENDING))
2810 union dwc3_event event;
2812 event.raw = *(u32 *) (evt->buf + evt->lpos);
2814 dwc3_process_event_entry(dwc, &event);
2817 * FIXME we wrap around correctly to the next entry as
2818 * almost all entries are 4 bytes in size. There is one
2819 * entry which has 12 bytes which is a regular entry
2820 * followed by 8 bytes data. ATM I don't know how
2821 * things are organized if we get next to the a
2822 * boundary so I worry about that once we try to handle
2825 evt->lpos = (evt->lpos + 4) % DWC3_EVENT_BUFFERS_SIZE;
2828 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 4);
2832 evt->flags &= ~DWC3_EVENT_PENDING;
2835 /* Unmask interrupt */
2836 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2837 reg &= ~DWC3_GEVNTSIZ_INTMASK;
2838 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2843 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
2845 struct dwc3_event_buffer *evt = _evt;
2846 struct dwc3 *dwc = evt->dwc;
2847 unsigned long flags;
2848 irqreturn_t ret = IRQ_NONE;
2850 spin_lock_irqsave(&dwc->lock, flags);
2851 ret = dwc3_process_event_buf(evt);
2852 spin_unlock_irqrestore(&dwc->lock, flags);
2857 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
2859 struct dwc3 *dwc = evt->dwc;
2863 if (pm_runtime_suspended(dwc->dev)) {
2864 pm_runtime_get(dwc->dev);
2865 disable_irq_nosync(dwc->irq_gadget);
2866 dwc->pending_events = true;
2870 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
2871 count &= DWC3_GEVNTCOUNT_MASK;
2876 evt->flags |= DWC3_EVENT_PENDING;
2878 /* Mask interrupt */
2879 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
2880 reg |= DWC3_GEVNTSIZ_INTMASK;
2881 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
2883 return IRQ_WAKE_THREAD;
2886 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
2888 struct dwc3_event_buffer *evt = _evt;
2890 return dwc3_check_event_buf(evt);
2894 * dwc3_gadget_init - Initializes gadget related registers
2895 * @dwc: pointer to our controller context structure
2897 * Returns 0 on success otherwise negative errno.
2899 int dwc3_gadget_init(struct dwc3 *dwc)
2903 dwc->ctrl_req = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
2904 &dwc->ctrl_req_addr, GFP_KERNEL);
2905 if (!dwc->ctrl_req) {
2906 dev_err(dwc->dev, "failed to allocate ctrl request\n");
2911 dwc->ep0_trb = dma_alloc_coherent(dwc->dev, sizeof(*dwc->ep0_trb) * 2,
2912 &dwc->ep0_trb_addr, GFP_KERNEL);
2913 if (!dwc->ep0_trb) {
2914 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
2919 dwc->setup_buf = kzalloc(DWC3_EP0_BOUNCE_SIZE, GFP_KERNEL);
2920 if (!dwc->setup_buf) {
2925 dwc->ep0_bounce = dma_alloc_coherent(dwc->dev,
2926 DWC3_EP0_BOUNCE_SIZE, &dwc->ep0_bounce_addr,
2928 if (!dwc->ep0_bounce) {
2929 dev_err(dwc->dev, "failed to allocate ep0 bounce buffer\n");
2934 dwc->zlp_buf = kzalloc(DWC3_ZLP_BUF_SIZE, GFP_KERNEL);
2935 if (!dwc->zlp_buf) {
2940 dwc->gadget.ops = &dwc3_gadget_ops;
2941 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2942 dwc->gadget.sg_supported = true;
2943 dwc->gadget.name = "dwc3-gadget";
2944 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
2947 * FIXME We might be setting max_speed to <SUPER, however versions
2948 * <2.20a of dwc3 have an issue with metastability (documented
2949 * elsewhere in this driver) which tells us we can't set max speed to
2950 * anything lower than SUPER.
2952 * Because gadget.max_speed is only used by composite.c and function
2953 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
2954 * to happen so we avoid sending SuperSpeed Capability descriptor
2955 * together with our BOS descriptor as that could confuse host into
2956 * thinking we can handle super speed.
2958 * Note that, in fact, we won't even support GetBOS requests when speed
2959 * is less than super speed because we don't have means, yet, to tell
2960 * composite.c that we are USB 2.0 + LPM ECN.
2962 if (dwc->revision < DWC3_REVISION_220A)
2963 dwc3_trace(trace_dwc3_gadget,
2964 "Changing max_speed on rev %08x",
2967 dwc->gadget.max_speed = dwc->maximum_speed;
2970 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
2973 dwc->gadget.quirk_ep_out_aligned_size = true;
2976 * REVISIT: Here we should clear all pending IRQs to be
2977 * sure we're starting from a well known location.
2980 ret = dwc3_gadget_init_endpoints(dwc);
2984 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
2986 dev_err(dwc->dev, "failed to register udc\n");
2993 kfree(dwc->zlp_buf);
2996 dwc3_gadget_free_endpoints(dwc);
2997 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
2998 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3001 kfree(dwc->setup_buf);
3004 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
3005 dwc->ep0_trb, dwc->ep0_trb_addr);
3008 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3009 dwc->ctrl_req, dwc->ctrl_req_addr);
3015 /* -------------------------------------------------------------------------- */
3017 void dwc3_gadget_exit(struct dwc3 *dwc)
3019 usb_del_gadget_udc(&dwc->gadget);
3021 dwc3_gadget_free_endpoints(dwc);
3023 dma_free_coherent(dwc->dev, DWC3_EP0_BOUNCE_SIZE,
3024 dwc->ep0_bounce, dwc->ep0_bounce_addr);
3026 kfree(dwc->setup_buf);
3027 kfree(dwc->zlp_buf);
3029 dma_free_coherent(dwc->dev, sizeof(*dwc->ep0_trb),
3030 dwc->ep0_trb, dwc->ep0_trb_addr);
3032 dma_free_coherent(dwc->dev, sizeof(*dwc->ctrl_req),
3033 dwc->ctrl_req, dwc->ctrl_req_addr);
3036 int dwc3_gadget_suspend(struct dwc3 *dwc)
3040 if (!dwc->gadget_driver)
3043 ret = dwc3_gadget_run_stop(dwc, false, false);
3047 dwc3_disconnect_gadget(dwc);
3048 __dwc3_gadget_stop(dwc);
3053 int dwc3_gadget_resume(struct dwc3 *dwc)
3057 if (!dwc->gadget_driver)
3060 ret = __dwc3_gadget_start(dwc);
3064 ret = dwc3_gadget_run_stop(dwc, true, false);
3071 __dwc3_gadget_stop(dwc);
3077 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3079 if (dwc->pending_events) {
3080 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3081 dwc->pending_events = false;
3082 enable_irq(dwc->irq_gadget);