dt-bindings: mtd: ingenic: Use standard ecc-engine property
[linux/fpc-iii.git] / drivers / usb / dwc3 / gadget.c
blobe293400cc6e95c242c4baedff3d92f68cefdce5a
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * gadget.c - DesignWare USB3 DRD Controller Gadget Framework Link
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 */
11 #include <linux/kernel.h>
12 #include <linux/delay.h>
13 #include <linux/slab.h>
14 #include <linux/spinlock.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/interrupt.h>
18 #include <linux/io.h>
19 #include <linux/list.h>
20 #include <linux/dma-mapping.h>
22 #include <linux/usb/ch9.h>
23 #include <linux/usb/gadget.h>
25 #include "debug.h"
26 #include "core.h"
27 #include "gadget.h"
28 #include "io.h"
30 #define DWC3_ALIGN_FRAME(d, n) (((d)->frame_number + ((d)->interval * (n))) \
31 & ~((d)->interval - 1))
33 /**
34 * dwc3_gadget_set_test_mode - enables usb2 test modes
35 * @dwc: pointer to our context structure
36 * @mode: the mode to set (J, K SE0 NAK, Force Enable)
38 * Caller should take care of locking. This function will return 0 on
39 * success or -EINVAL if wrong Test Selector is passed.
41 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
43 u32 reg;
45 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
46 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
48 switch (mode) {
49 case TEST_J:
50 case TEST_K:
51 case TEST_SE0_NAK:
52 case TEST_PACKET:
53 case TEST_FORCE_EN:
54 reg |= mode << 1;
55 break;
56 default:
57 return -EINVAL;
60 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
62 return 0;
65 /**
66 * dwc3_gadget_get_link_state - gets current state of usb link
67 * @dwc: pointer to our context structure
69 * Caller should take care of locking. This function will
70 * return the link state on success (>= 0) or -ETIMEDOUT.
72 int dwc3_gadget_get_link_state(struct dwc3 *dwc)
74 u32 reg;
76 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
78 return DWC3_DSTS_USBLNKST(reg);
81 /**
82 * dwc3_gadget_set_link_state - sets usb link to a particular state
83 * @dwc: pointer to our context structure
84 * @state: the state to put link into
86 * Caller should take care of locking. This function will
87 * return 0 on success or -ETIMEDOUT.
89 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state)
91 int retries = 10000;
92 u32 reg;
95 * Wait until device controller is ready. Only applies to 1.94a and
96 * later RTL.
98 if (dwc->revision >= DWC3_REVISION_194A) {
99 while (--retries) {
100 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
101 if (reg & DWC3_DSTS_DCNRD)
102 udelay(5);
103 else
104 break;
107 if (retries <= 0)
108 return -ETIMEDOUT;
111 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
112 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
114 /* set requested state */
115 reg |= DWC3_DCTL_ULSTCHNGREQ(state);
116 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
119 * The following code is racy when called from dwc3_gadget_wakeup,
120 * and is not needed, at least on newer versions
122 if (dwc->revision >= DWC3_REVISION_194A)
123 return 0;
125 /* wait for a change in DSTS */
126 retries = 10000;
127 while (--retries) {
128 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
130 if (DWC3_DSTS_USBLNKST(reg) == state)
131 return 0;
133 udelay(5);
136 return -ETIMEDOUT;
140 * dwc3_ep_inc_trb - increment a trb index.
141 * @index: Pointer to the TRB index to increment.
143 * The index should never point to the link TRB. After incrementing,
144 * if it is point to the link TRB, wrap around to the beginning. The
145 * link TRB is always at the last TRB entry.
147 static void dwc3_ep_inc_trb(u8 *index)
149 (*index)++;
150 if (*index == (DWC3_TRB_NUM - 1))
151 *index = 0;
155 * dwc3_ep_inc_enq - increment endpoint's enqueue pointer
156 * @dep: The endpoint whose enqueue pointer we're incrementing
158 static void dwc3_ep_inc_enq(struct dwc3_ep *dep)
160 dwc3_ep_inc_trb(&dep->trb_enqueue);
164 * dwc3_ep_inc_deq - increment endpoint's dequeue pointer
165 * @dep: The endpoint whose enqueue pointer we're incrementing
167 static void dwc3_ep_inc_deq(struct dwc3_ep *dep)
169 dwc3_ep_inc_trb(&dep->trb_dequeue);
172 static void dwc3_gadget_del_and_unmap_request(struct dwc3_ep *dep,
173 struct dwc3_request *req, int status)
175 struct dwc3 *dwc = dep->dwc;
177 list_del(&req->list);
178 req->remaining = 0;
179 req->needs_extra_trb = false;
181 if (req->request.status == -EINPROGRESS)
182 req->request.status = status;
184 if (req->trb)
185 usb_gadget_unmap_request_by_dev(dwc->sysdev,
186 &req->request, req->direction);
188 req->trb = NULL;
189 trace_dwc3_gadget_giveback(req);
191 if (dep->number > 1)
192 pm_runtime_put(dwc->dev);
196 * dwc3_gadget_giveback - call struct usb_request's ->complete callback
197 * @dep: The endpoint to whom the request belongs to
198 * @req: The request we're giving back
199 * @status: completion code for the request
201 * Must be called with controller's lock held and interrupts disabled. This
202 * function will unmap @req and call its ->complete() callback to notify upper
203 * layers that it has completed.
205 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
206 int status)
208 struct dwc3 *dwc = dep->dwc;
210 dwc3_gadget_del_and_unmap_request(dep, req, status);
211 req->status = DWC3_REQUEST_STATUS_COMPLETED;
213 spin_unlock(&dwc->lock);
214 usb_gadget_giveback_request(&dep->endpoint, &req->request);
215 spin_lock(&dwc->lock);
219 * dwc3_send_gadget_generic_command - issue a generic command for the controller
220 * @dwc: pointer to the controller context
221 * @cmd: the command to be issued
222 * @param: command parameter
224 * Caller should take care of locking. Issue @cmd with a given @param to @dwc
225 * and wait for its completion.
227 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param)
229 u32 timeout = 500;
230 int status = 0;
231 int ret = 0;
232 u32 reg;
234 dwc3_writel(dwc->regs, DWC3_DGCMDPAR, param);
235 dwc3_writel(dwc->regs, DWC3_DGCMD, cmd | DWC3_DGCMD_CMDACT);
237 do {
238 reg = dwc3_readl(dwc->regs, DWC3_DGCMD);
239 if (!(reg & DWC3_DGCMD_CMDACT)) {
240 status = DWC3_DGCMD_STATUS(reg);
241 if (status)
242 ret = -EINVAL;
243 break;
245 } while (--timeout);
247 if (!timeout) {
248 ret = -ETIMEDOUT;
249 status = -ETIMEDOUT;
252 trace_dwc3_gadget_generic_cmd(cmd, param, status);
254 return ret;
257 static int __dwc3_gadget_wakeup(struct dwc3 *dwc);
260 * dwc3_send_gadget_ep_cmd - issue an endpoint command
261 * @dep: the endpoint to which the command is going to be issued
262 * @cmd: the command to be issued
263 * @params: parameters to the command
265 * Caller should handle locking. This function will issue @cmd with given
266 * @params to @dep and wait for its completion.
268 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned cmd,
269 struct dwc3_gadget_ep_cmd_params *params)
271 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
272 struct dwc3 *dwc = dep->dwc;
273 u32 timeout = 1000;
274 u32 saved_config = 0;
275 u32 reg;
277 int cmd_status = 0;
278 int ret = -EINVAL;
281 * When operating in USB 2.0 speeds (HS/FS), if GUSB2PHYCFG.ENBLSLPM or
282 * GUSB2PHYCFG.SUSPHY is set, it must be cleared before issuing an
283 * endpoint command.
285 * Save and clear both GUSB2PHYCFG.ENBLSLPM and GUSB2PHYCFG.SUSPHY
286 * settings. Restore them after the command is completed.
288 * DWC_usb3 3.30a and DWC_usb31 1.90a programming guide section 3.2.2
290 if (dwc->gadget.speed <= USB_SPEED_HIGH) {
291 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
292 if (unlikely(reg & DWC3_GUSB2PHYCFG_SUSPHY)) {
293 saved_config |= DWC3_GUSB2PHYCFG_SUSPHY;
294 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
297 if (reg & DWC3_GUSB2PHYCFG_ENBLSLPM) {
298 saved_config |= DWC3_GUSB2PHYCFG_ENBLSLPM;
299 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
302 if (saved_config)
303 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
306 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
307 int needs_wakeup;
309 needs_wakeup = (dwc->link_state == DWC3_LINK_STATE_U1 ||
310 dwc->link_state == DWC3_LINK_STATE_U2 ||
311 dwc->link_state == DWC3_LINK_STATE_U3);
313 if (unlikely(needs_wakeup)) {
314 ret = __dwc3_gadget_wakeup(dwc);
315 dev_WARN_ONCE(dwc->dev, ret, "wakeup failed --> %d\n",
316 ret);
320 dwc3_writel(dep->regs, DWC3_DEPCMDPAR0, params->param0);
321 dwc3_writel(dep->regs, DWC3_DEPCMDPAR1, params->param1);
322 dwc3_writel(dep->regs, DWC3_DEPCMDPAR2, params->param2);
325 * Synopsys Databook 2.60a states in section 6.3.2.5.6 of that if we're
326 * not relying on XferNotReady, we can make use of a special "No
327 * Response Update Transfer" command where we should clear both CmdAct
328 * and CmdIOC bits.
330 * With this, we don't need to wait for command completion and can
331 * straight away issue further commands to the endpoint.
333 * NOTICE: We're making an assumption that control endpoints will never
334 * make use of Update Transfer command. This is a safe assumption
335 * because we can never have more than one request at a time with
336 * Control Endpoints. If anybody changes that assumption, this chunk
337 * needs to be updated accordingly.
339 if (DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_UPDATETRANSFER &&
340 !usb_endpoint_xfer_isoc(desc))
341 cmd &= ~(DWC3_DEPCMD_CMDIOC | DWC3_DEPCMD_CMDACT);
342 else
343 cmd |= DWC3_DEPCMD_CMDACT;
345 dwc3_writel(dep->regs, DWC3_DEPCMD, cmd);
346 do {
347 reg = dwc3_readl(dep->regs, DWC3_DEPCMD);
348 if (!(reg & DWC3_DEPCMD_CMDACT)) {
349 cmd_status = DWC3_DEPCMD_STATUS(reg);
351 switch (cmd_status) {
352 case 0:
353 ret = 0;
354 break;
355 case DEPEVT_TRANSFER_NO_RESOURCE:
356 ret = -EINVAL;
357 break;
358 case DEPEVT_TRANSFER_BUS_EXPIRY:
360 * SW issues START TRANSFER command to
361 * isochronous ep with future frame interval. If
362 * future interval time has already passed when
363 * core receives the command, it will respond
364 * with an error status of 'Bus Expiry'.
366 * Instead of always returning -EINVAL, let's
367 * give a hint to the gadget driver that this is
368 * the case by returning -EAGAIN.
370 ret = -EAGAIN;
371 break;
372 default:
373 dev_WARN(dwc->dev, "UNKNOWN cmd status\n");
376 break;
378 } while (--timeout);
380 if (timeout == 0) {
381 ret = -ETIMEDOUT;
382 cmd_status = -ETIMEDOUT;
385 trace_dwc3_gadget_ep_cmd(dep, cmd, params, cmd_status);
387 if (ret == 0 && DWC3_DEPCMD_CMD(cmd) == DWC3_DEPCMD_STARTTRANSFER) {
388 dep->flags |= DWC3_EP_TRANSFER_STARTED;
389 dwc3_gadget_ep_get_transfer_index(dep);
392 if (saved_config) {
393 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
394 reg |= saved_config;
395 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
398 return ret;
401 static int dwc3_send_clear_stall_ep_cmd(struct dwc3_ep *dep)
403 struct dwc3 *dwc = dep->dwc;
404 struct dwc3_gadget_ep_cmd_params params;
405 u32 cmd = DWC3_DEPCMD_CLEARSTALL;
408 * As of core revision 2.60a the recommended programming model
409 * is to set the ClearPendIN bit when issuing a Clear Stall EP
410 * command for IN endpoints. This is to prevent an issue where
411 * some (non-compliant) hosts may not send ACK TPs for pending
412 * IN transfers due to a mishandled error condition. Synopsys
413 * STAR 9000614252.
415 if (dep->direction && (dwc->revision >= DWC3_REVISION_260A) &&
416 (dwc->gadget.speed >= USB_SPEED_SUPER))
417 cmd |= DWC3_DEPCMD_CLEARPENDIN;
419 memset(&params, 0, sizeof(params));
421 return dwc3_send_gadget_ep_cmd(dep, cmd, &params);
424 static dma_addr_t dwc3_trb_dma_offset(struct dwc3_ep *dep,
425 struct dwc3_trb *trb)
427 u32 offset = (char *) trb - (char *) dep->trb_pool;
429 return dep->trb_pool_dma + offset;
432 static int dwc3_alloc_trb_pool(struct dwc3_ep *dep)
434 struct dwc3 *dwc = dep->dwc;
436 if (dep->trb_pool)
437 return 0;
439 dep->trb_pool = dma_alloc_coherent(dwc->sysdev,
440 sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
441 &dep->trb_pool_dma, GFP_KERNEL);
442 if (!dep->trb_pool) {
443 dev_err(dep->dwc->dev, "failed to allocate trb pool for %s\n",
444 dep->name);
445 return -ENOMEM;
448 return 0;
451 static void dwc3_free_trb_pool(struct dwc3_ep *dep)
453 struct dwc3 *dwc = dep->dwc;
455 dma_free_coherent(dwc->sysdev, sizeof(struct dwc3_trb) * DWC3_TRB_NUM,
456 dep->trb_pool, dep->trb_pool_dma);
458 dep->trb_pool = NULL;
459 dep->trb_pool_dma = 0;
462 static int dwc3_gadget_set_xfer_resource(struct dwc3_ep *dep)
464 struct dwc3_gadget_ep_cmd_params params;
466 memset(&params, 0x00, sizeof(params));
468 params.param0 = DWC3_DEPXFERCFG_NUM_XFER_RES(1);
470 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETTRANSFRESOURCE,
471 &params);
475 * dwc3_gadget_start_config - configure ep resources
476 * @dep: endpoint that is being enabled
478 * Issue a %DWC3_DEPCMD_DEPSTARTCFG command to @dep. After the command's
479 * completion, it will set Transfer Resource for all available endpoints.
481 * The assignment of transfer resources cannot perfectly follow the data book
482 * due to the fact that the controller driver does not have all knowledge of the
483 * configuration in advance. It is given this information piecemeal by the
484 * composite gadget framework after every SET_CONFIGURATION and
485 * SET_INTERFACE. Trying to follow the databook programming model in this
486 * scenario can cause errors. For two reasons:
488 * 1) The databook says to do %DWC3_DEPCMD_DEPSTARTCFG for every
489 * %USB_REQ_SET_CONFIGURATION and %USB_REQ_SET_INTERFACE (8.1.5). This is
490 * incorrect in the scenario of multiple interfaces.
492 * 2) The databook does not mention doing more %DWC3_DEPCMD_DEPXFERCFG for new
493 * endpoint on alt setting (8.1.6).
495 * The following simplified method is used instead:
497 * All hardware endpoints can be assigned a transfer resource and this setting
498 * will stay persistent until either a core reset or hibernation. So whenever we
499 * do a %DWC3_DEPCMD_DEPSTARTCFG(0) we can go ahead and do
500 * %DWC3_DEPCMD_DEPXFERCFG for every hardware endpoint as well. We are
501 * guaranteed that there are as many transfer resources as endpoints.
503 * This function is called for each endpoint when it is being enabled but is
504 * triggered only when called for EP0-out, which always happens first, and which
505 * should only happen in one of the above conditions.
507 static int dwc3_gadget_start_config(struct dwc3_ep *dep)
509 struct dwc3_gadget_ep_cmd_params params;
510 struct dwc3 *dwc;
511 u32 cmd;
512 int i;
513 int ret;
515 if (dep->number)
516 return 0;
518 memset(&params, 0x00, sizeof(params));
519 cmd = DWC3_DEPCMD_DEPSTARTCFG;
520 dwc = dep->dwc;
522 ret = dwc3_send_gadget_ep_cmd(dep, cmd, &params);
523 if (ret)
524 return ret;
526 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
527 struct dwc3_ep *dep = dwc->eps[i];
529 if (!dep)
530 continue;
532 ret = dwc3_gadget_set_xfer_resource(dep);
533 if (ret)
534 return ret;
537 return 0;
540 static int dwc3_gadget_set_ep_config(struct dwc3_ep *dep, unsigned int action)
542 const struct usb_ss_ep_comp_descriptor *comp_desc;
543 const struct usb_endpoint_descriptor *desc;
544 struct dwc3_gadget_ep_cmd_params params;
545 struct dwc3 *dwc = dep->dwc;
547 comp_desc = dep->endpoint.comp_desc;
548 desc = dep->endpoint.desc;
550 memset(&params, 0x00, sizeof(params));
552 params.param0 = DWC3_DEPCFG_EP_TYPE(usb_endpoint_type(desc))
553 | DWC3_DEPCFG_MAX_PACKET_SIZE(usb_endpoint_maxp(desc));
555 /* Burst size is only needed in SuperSpeed mode */
556 if (dwc->gadget.speed >= USB_SPEED_SUPER) {
557 u32 burst = dep->endpoint.maxburst;
558 params.param0 |= DWC3_DEPCFG_BURST_SIZE(burst - 1);
561 params.param0 |= action;
562 if (action == DWC3_DEPCFG_ACTION_RESTORE)
563 params.param2 |= dep->saved_state;
565 if (usb_endpoint_xfer_control(desc))
566 params.param1 = DWC3_DEPCFG_XFER_COMPLETE_EN;
568 if (dep->number <= 1 || usb_endpoint_xfer_isoc(desc))
569 params.param1 |= DWC3_DEPCFG_XFER_NOT_READY_EN;
571 if (usb_ss_max_streams(comp_desc) && usb_endpoint_xfer_bulk(desc)) {
572 params.param1 |= DWC3_DEPCFG_STREAM_CAPABLE
573 | DWC3_DEPCFG_STREAM_EVENT_EN;
574 dep->stream_capable = true;
577 if (!usb_endpoint_xfer_control(desc))
578 params.param1 |= DWC3_DEPCFG_XFER_IN_PROGRESS_EN;
581 * We are doing 1:1 mapping for endpoints, meaning
582 * Physical Endpoints 2 maps to Logical Endpoint 2 and
583 * so on. We consider the direction bit as part of the physical
584 * endpoint number. So USB endpoint 0x81 is 0x03.
586 params.param1 |= DWC3_DEPCFG_EP_NUMBER(dep->number);
589 * We must use the lower 16 TX FIFOs even though
590 * HW might have more
592 if (dep->direction)
593 params.param0 |= DWC3_DEPCFG_FIFO_NUMBER(dep->number >> 1);
595 if (desc->bInterval) {
596 params.param1 |= DWC3_DEPCFG_BINTERVAL_M1(desc->bInterval - 1);
597 dep->interval = 1 << (desc->bInterval - 1);
600 return dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETEPCONFIG, &params);
604 * __dwc3_gadget_ep_enable - initializes a hw endpoint
605 * @dep: endpoint to be initialized
606 * @action: one of INIT, MODIFY or RESTORE
608 * Caller should take care of locking. Execute all necessary commands to
609 * initialize a HW endpoint so it can be used by a gadget driver.
611 static int __dwc3_gadget_ep_enable(struct dwc3_ep *dep, unsigned int action)
613 const struct usb_endpoint_descriptor *desc = dep->endpoint.desc;
614 struct dwc3 *dwc = dep->dwc;
616 u32 reg;
617 int ret;
619 if (!(dep->flags & DWC3_EP_ENABLED)) {
620 ret = dwc3_gadget_start_config(dep);
621 if (ret)
622 return ret;
625 ret = dwc3_gadget_set_ep_config(dep, action);
626 if (ret)
627 return ret;
629 if (!(dep->flags & DWC3_EP_ENABLED)) {
630 struct dwc3_trb *trb_st_hw;
631 struct dwc3_trb *trb_link;
633 dep->type = usb_endpoint_type(desc);
634 dep->flags |= DWC3_EP_ENABLED;
636 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
637 reg |= DWC3_DALEPENA_EP(dep->number);
638 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
640 if (usb_endpoint_xfer_control(desc))
641 goto out;
643 /* Initialize the TRB ring */
644 dep->trb_dequeue = 0;
645 dep->trb_enqueue = 0;
646 memset(dep->trb_pool, 0,
647 sizeof(struct dwc3_trb) * DWC3_TRB_NUM);
649 /* Link TRB. The HWO bit is never reset */
650 trb_st_hw = &dep->trb_pool[0];
652 trb_link = &dep->trb_pool[DWC3_TRB_NUM - 1];
653 trb_link->bpl = lower_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
654 trb_link->bph = upper_32_bits(dwc3_trb_dma_offset(dep, trb_st_hw));
655 trb_link->ctrl |= DWC3_TRBCTL_LINK_TRB;
656 trb_link->ctrl |= DWC3_TRB_CTRL_HWO;
660 * Issue StartTransfer here with no-op TRB so we can always rely on No
661 * Response Update Transfer command.
663 if ((usb_endpoint_xfer_bulk(desc) && !dep->stream_capable) ||
664 usb_endpoint_xfer_int(desc)) {
665 struct dwc3_gadget_ep_cmd_params params;
666 struct dwc3_trb *trb;
667 dma_addr_t trb_dma;
668 u32 cmd;
670 memset(&params, 0, sizeof(params));
671 trb = &dep->trb_pool[0];
672 trb_dma = dwc3_trb_dma_offset(dep, trb);
674 params.param0 = upper_32_bits(trb_dma);
675 params.param1 = lower_32_bits(trb_dma);
677 cmd = DWC3_DEPCMD_STARTTRANSFER;
679 ret = dwc3_send_gadget_ep_cmd(dep, cmd, &params);
680 if (ret < 0)
681 return ret;
684 out:
685 trace_dwc3_gadget_ep_enable(dep);
687 return 0;
690 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
691 bool interrupt);
692 static void dwc3_remove_requests(struct dwc3 *dwc, struct dwc3_ep *dep)
694 struct dwc3_request *req;
696 dwc3_stop_active_transfer(dep, true, false);
698 /* - giveback all requests to gadget driver */
699 while (!list_empty(&dep->started_list)) {
700 req = next_request(&dep->started_list);
702 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
705 while (!list_empty(&dep->pending_list)) {
706 req = next_request(&dep->pending_list);
708 dwc3_gadget_giveback(dep, req, -ESHUTDOWN);
713 * __dwc3_gadget_ep_disable - disables a hw endpoint
714 * @dep: the endpoint to disable
716 * This function undoes what __dwc3_gadget_ep_enable did and also removes
717 * requests which are currently being processed by the hardware and those which
718 * are not yet scheduled.
720 * Caller should take care of locking.
722 static int __dwc3_gadget_ep_disable(struct dwc3_ep *dep)
724 struct dwc3 *dwc = dep->dwc;
725 u32 reg;
727 trace_dwc3_gadget_ep_disable(dep);
729 dwc3_remove_requests(dwc, dep);
731 /* make sure HW endpoint isn't stalled */
732 if (dep->flags & DWC3_EP_STALL)
733 __dwc3_gadget_ep_set_halt(dep, 0, false);
735 reg = dwc3_readl(dwc->regs, DWC3_DALEPENA);
736 reg &= ~DWC3_DALEPENA_EP(dep->number);
737 dwc3_writel(dwc->regs, DWC3_DALEPENA, reg);
739 dep->stream_capable = false;
740 dep->type = 0;
741 dep->flags = 0;
743 /* Clear out the ep descriptors for non-ep0 */
744 if (dep->number > 1) {
745 dep->endpoint.comp_desc = NULL;
746 dep->endpoint.desc = NULL;
749 return 0;
752 /* -------------------------------------------------------------------------- */
754 static int dwc3_gadget_ep0_enable(struct usb_ep *ep,
755 const struct usb_endpoint_descriptor *desc)
757 return -EINVAL;
760 static int dwc3_gadget_ep0_disable(struct usb_ep *ep)
762 return -EINVAL;
765 /* -------------------------------------------------------------------------- */
767 static int dwc3_gadget_ep_enable(struct usb_ep *ep,
768 const struct usb_endpoint_descriptor *desc)
770 struct dwc3_ep *dep;
771 struct dwc3 *dwc;
772 unsigned long flags;
773 int ret;
775 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
776 pr_debug("dwc3: invalid parameters\n");
777 return -EINVAL;
780 if (!desc->wMaxPacketSize) {
781 pr_debug("dwc3: missing wMaxPacketSize\n");
782 return -EINVAL;
785 dep = to_dwc3_ep(ep);
786 dwc = dep->dwc;
788 if (dev_WARN_ONCE(dwc->dev, dep->flags & DWC3_EP_ENABLED,
789 "%s is already enabled\n",
790 dep->name))
791 return 0;
793 spin_lock_irqsave(&dwc->lock, flags);
794 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
795 spin_unlock_irqrestore(&dwc->lock, flags);
797 return ret;
800 static int dwc3_gadget_ep_disable(struct usb_ep *ep)
802 struct dwc3_ep *dep;
803 struct dwc3 *dwc;
804 unsigned long flags;
805 int ret;
807 if (!ep) {
808 pr_debug("dwc3: invalid parameters\n");
809 return -EINVAL;
812 dep = to_dwc3_ep(ep);
813 dwc = dep->dwc;
815 if (dev_WARN_ONCE(dwc->dev, !(dep->flags & DWC3_EP_ENABLED),
816 "%s is already disabled\n",
817 dep->name))
818 return 0;
820 spin_lock_irqsave(&dwc->lock, flags);
821 ret = __dwc3_gadget_ep_disable(dep);
822 spin_unlock_irqrestore(&dwc->lock, flags);
824 return ret;
827 static struct usb_request *dwc3_gadget_ep_alloc_request(struct usb_ep *ep,
828 gfp_t gfp_flags)
830 struct dwc3_request *req;
831 struct dwc3_ep *dep = to_dwc3_ep(ep);
833 req = kzalloc(sizeof(*req), gfp_flags);
834 if (!req)
835 return NULL;
837 req->direction = dep->direction;
838 req->epnum = dep->number;
839 req->dep = dep;
840 req->status = DWC3_REQUEST_STATUS_UNKNOWN;
842 trace_dwc3_alloc_request(req);
844 return &req->request;
847 static void dwc3_gadget_ep_free_request(struct usb_ep *ep,
848 struct usb_request *request)
850 struct dwc3_request *req = to_dwc3_request(request);
852 trace_dwc3_free_request(req);
853 kfree(req);
857 * dwc3_ep_prev_trb - returns the previous TRB in the ring
858 * @dep: The endpoint with the TRB ring
859 * @index: The index of the current TRB in the ring
861 * Returns the TRB prior to the one pointed to by the index. If the
862 * index is 0, we will wrap backwards, skip the link TRB, and return
863 * the one just before that.
865 static struct dwc3_trb *dwc3_ep_prev_trb(struct dwc3_ep *dep, u8 index)
867 u8 tmp = index;
869 if (!tmp)
870 tmp = DWC3_TRB_NUM - 1;
872 return &dep->trb_pool[tmp - 1];
875 static u32 dwc3_calc_trbs_left(struct dwc3_ep *dep)
877 struct dwc3_trb *tmp;
878 u8 trbs_left;
881 * If enqueue & dequeue are equal than it is either full or empty.
883 * One way to know for sure is if the TRB right before us has HWO bit
884 * set or not. If it has, then we're definitely full and can't fit any
885 * more transfers in our ring.
887 if (dep->trb_enqueue == dep->trb_dequeue) {
888 tmp = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
889 if (tmp->ctrl & DWC3_TRB_CTRL_HWO)
890 return 0;
892 return DWC3_TRB_NUM - 1;
895 trbs_left = dep->trb_dequeue - dep->trb_enqueue;
896 trbs_left &= (DWC3_TRB_NUM - 1);
898 if (dep->trb_dequeue < dep->trb_enqueue)
899 trbs_left--;
901 return trbs_left;
904 static void __dwc3_prepare_one_trb(struct dwc3_ep *dep, struct dwc3_trb *trb,
905 dma_addr_t dma, unsigned length, unsigned chain, unsigned node,
906 unsigned stream_id, unsigned short_not_ok, unsigned no_interrupt)
908 struct dwc3 *dwc = dep->dwc;
909 struct usb_gadget *gadget = &dwc->gadget;
910 enum usb_device_speed speed = gadget->speed;
912 trb->size = DWC3_TRB_SIZE_LENGTH(length);
913 trb->bpl = lower_32_bits(dma);
914 trb->bph = upper_32_bits(dma);
916 switch (usb_endpoint_type(dep->endpoint.desc)) {
917 case USB_ENDPOINT_XFER_CONTROL:
918 trb->ctrl = DWC3_TRBCTL_CONTROL_SETUP;
919 break;
921 case USB_ENDPOINT_XFER_ISOC:
922 if (!node) {
923 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS_FIRST;
926 * USB Specification 2.0 Section 5.9.2 states that: "If
927 * there is only a single transaction in the microframe,
928 * only a DATA0 data packet PID is used. If there are
929 * two transactions per microframe, DATA1 is used for
930 * the first transaction data packet and DATA0 is used
931 * for the second transaction data packet. If there are
932 * three transactions per microframe, DATA2 is used for
933 * the first transaction data packet, DATA1 is used for
934 * the second, and DATA0 is used for the third."
936 * IOW, we should satisfy the following cases:
938 * 1) length <= maxpacket
939 * - DATA0
941 * 2) maxpacket < length <= (2 * maxpacket)
942 * - DATA1, DATA0
944 * 3) (2 * maxpacket) < length <= (3 * maxpacket)
945 * - DATA2, DATA1, DATA0
947 if (speed == USB_SPEED_HIGH) {
948 struct usb_ep *ep = &dep->endpoint;
949 unsigned int mult = 2;
950 unsigned int maxp = usb_endpoint_maxp(ep->desc);
952 if (length <= (2 * maxp))
953 mult--;
955 if (length <= maxp)
956 mult--;
958 trb->size |= DWC3_TRB_SIZE_PCM1(mult);
960 } else {
961 trb->ctrl = DWC3_TRBCTL_ISOCHRONOUS;
964 /* always enable Interrupt on Missed ISOC */
965 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
966 break;
968 case USB_ENDPOINT_XFER_BULK:
969 case USB_ENDPOINT_XFER_INT:
970 trb->ctrl = DWC3_TRBCTL_NORMAL;
971 break;
972 default:
974 * This is only possible with faulty memory because we
975 * checked it already :)
977 dev_WARN(dwc->dev, "Unknown endpoint type %d\n",
978 usb_endpoint_type(dep->endpoint.desc));
982 * Enable Continue on Short Packet
983 * when endpoint is not a stream capable
985 if (usb_endpoint_dir_out(dep->endpoint.desc)) {
986 if (!dep->stream_capable)
987 trb->ctrl |= DWC3_TRB_CTRL_CSP;
989 if (short_not_ok)
990 trb->ctrl |= DWC3_TRB_CTRL_ISP_IMI;
993 if ((!no_interrupt && !chain) ||
994 (dwc3_calc_trbs_left(dep) == 1))
995 trb->ctrl |= DWC3_TRB_CTRL_IOC;
997 if (chain)
998 trb->ctrl |= DWC3_TRB_CTRL_CHN;
1000 if (usb_endpoint_xfer_bulk(dep->endpoint.desc) && dep->stream_capable)
1001 trb->ctrl |= DWC3_TRB_CTRL_SID_SOFN(stream_id);
1003 trb->ctrl |= DWC3_TRB_CTRL_HWO;
1005 dwc3_ep_inc_enq(dep);
1007 trace_dwc3_prepare_trb(dep, trb);
1011 * dwc3_prepare_one_trb - setup one TRB from one request
1012 * @dep: endpoint for which this request is prepared
1013 * @req: dwc3_request pointer
1014 * @chain: should this TRB be chained to the next?
1015 * @node: only for isochronous endpoints. First TRB needs different type.
1017 static void dwc3_prepare_one_trb(struct dwc3_ep *dep,
1018 struct dwc3_request *req, unsigned chain, unsigned node)
1020 struct dwc3_trb *trb;
1021 unsigned int length;
1022 dma_addr_t dma;
1023 unsigned stream_id = req->request.stream_id;
1024 unsigned short_not_ok = req->request.short_not_ok;
1025 unsigned no_interrupt = req->request.no_interrupt;
1027 if (req->request.num_sgs > 0) {
1028 length = sg_dma_len(req->start_sg);
1029 dma = sg_dma_address(req->start_sg);
1030 } else {
1031 length = req->request.length;
1032 dma = req->request.dma;
1035 trb = &dep->trb_pool[dep->trb_enqueue];
1037 if (!req->trb) {
1038 dwc3_gadget_move_started_request(req);
1039 req->trb = trb;
1040 req->trb_dma = dwc3_trb_dma_offset(dep, trb);
1043 req->num_trbs++;
1045 __dwc3_prepare_one_trb(dep, trb, dma, length, chain, node,
1046 stream_id, short_not_ok, no_interrupt);
1049 static void dwc3_prepare_one_trb_sg(struct dwc3_ep *dep,
1050 struct dwc3_request *req)
1052 struct scatterlist *sg = req->start_sg;
1053 struct scatterlist *s;
1054 int i;
1056 unsigned int remaining = req->request.num_mapped_sgs
1057 - req->num_queued_sgs;
1059 for_each_sg(sg, s, remaining, i) {
1060 unsigned int length = req->request.length;
1061 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1062 unsigned int rem = length % maxp;
1063 unsigned chain = true;
1065 if (sg_is_last(s))
1066 chain = false;
1068 if (rem && usb_endpoint_dir_out(dep->endpoint.desc) && !chain) {
1069 struct dwc3 *dwc = dep->dwc;
1070 struct dwc3_trb *trb;
1072 req->needs_extra_trb = true;
1074 /* prepare normal TRB */
1075 dwc3_prepare_one_trb(dep, req, true, i);
1077 /* Now prepare one extra TRB to align transfer size */
1078 trb = &dep->trb_pool[dep->trb_enqueue];
1079 req->num_trbs++;
1080 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr,
1081 maxp - rem, false, 1,
1082 req->request.stream_id,
1083 req->request.short_not_ok,
1084 req->request.no_interrupt);
1085 } else {
1086 dwc3_prepare_one_trb(dep, req, chain, i);
1090 * There can be a situation where all sgs in sglist are not
1091 * queued because of insufficient trb number. To handle this
1092 * case, update start_sg to next sg to be queued, so that
1093 * we have free trbs we can continue queuing from where we
1094 * previously stopped
1096 if (chain)
1097 req->start_sg = sg_next(s);
1099 req->num_queued_sgs++;
1101 if (!dwc3_calc_trbs_left(dep))
1102 break;
1106 static void dwc3_prepare_one_trb_linear(struct dwc3_ep *dep,
1107 struct dwc3_request *req)
1109 unsigned int length = req->request.length;
1110 unsigned int maxp = usb_endpoint_maxp(dep->endpoint.desc);
1111 unsigned int rem = length % maxp;
1113 if ((!length || rem) && usb_endpoint_dir_out(dep->endpoint.desc)) {
1114 struct dwc3 *dwc = dep->dwc;
1115 struct dwc3_trb *trb;
1117 req->needs_extra_trb = true;
1119 /* prepare normal TRB */
1120 dwc3_prepare_one_trb(dep, req, true, 0);
1122 /* Now prepare one extra TRB to align transfer size */
1123 trb = &dep->trb_pool[dep->trb_enqueue];
1124 req->num_trbs++;
1125 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, maxp - rem,
1126 false, 1, req->request.stream_id,
1127 req->request.short_not_ok,
1128 req->request.no_interrupt);
1129 } else if (req->request.zero && req->request.length &&
1130 (IS_ALIGNED(req->request.length, maxp))) {
1131 struct dwc3 *dwc = dep->dwc;
1132 struct dwc3_trb *trb;
1134 req->needs_extra_trb = true;
1136 /* prepare normal TRB */
1137 dwc3_prepare_one_trb(dep, req, true, 0);
1139 /* Now prepare one extra TRB to handle ZLP */
1140 trb = &dep->trb_pool[dep->trb_enqueue];
1141 req->num_trbs++;
1142 __dwc3_prepare_one_trb(dep, trb, dwc->bounce_addr, 0,
1143 false, 1, req->request.stream_id,
1144 req->request.short_not_ok,
1145 req->request.no_interrupt);
1146 } else {
1147 dwc3_prepare_one_trb(dep, req, false, 0);
1152 * dwc3_prepare_trbs - setup TRBs from requests
1153 * @dep: endpoint for which requests are being prepared
1155 * The function goes through the requests list and sets up TRBs for the
1156 * transfers. The function returns once there are no more TRBs available or
1157 * it runs out of requests.
1159 static void dwc3_prepare_trbs(struct dwc3_ep *dep)
1161 struct dwc3_request *req, *n;
1163 BUILD_BUG_ON_NOT_POWER_OF_2(DWC3_TRB_NUM);
1166 * We can get in a situation where there's a request in the started list
1167 * but there weren't enough TRBs to fully kick it in the first time
1168 * around, so it has been waiting for more TRBs to be freed up.
1170 * In that case, we should check if we have a request with pending_sgs
1171 * in the started list and prepare TRBs for that request first,
1172 * otherwise we will prepare TRBs completely out of order and that will
1173 * break things.
1175 list_for_each_entry(req, &dep->started_list, list) {
1176 if (req->num_pending_sgs > 0)
1177 dwc3_prepare_one_trb_sg(dep, req);
1179 if (!dwc3_calc_trbs_left(dep))
1180 return;
1183 list_for_each_entry_safe(req, n, &dep->pending_list, list) {
1184 struct dwc3 *dwc = dep->dwc;
1185 int ret;
1187 ret = usb_gadget_map_request_by_dev(dwc->sysdev, &req->request,
1188 dep->direction);
1189 if (ret)
1190 return;
1192 req->sg = req->request.sg;
1193 req->start_sg = req->sg;
1194 req->num_queued_sgs = 0;
1195 req->num_pending_sgs = req->request.num_mapped_sgs;
1197 if (req->num_pending_sgs > 0)
1198 dwc3_prepare_one_trb_sg(dep, req);
1199 else
1200 dwc3_prepare_one_trb_linear(dep, req);
1202 if (!dwc3_calc_trbs_left(dep))
1203 return;
1207 static int __dwc3_gadget_kick_transfer(struct dwc3_ep *dep)
1209 struct dwc3_gadget_ep_cmd_params params;
1210 struct dwc3_request *req;
1211 int starting;
1212 int ret;
1213 u32 cmd;
1215 if (!dwc3_calc_trbs_left(dep))
1216 return 0;
1218 starting = !(dep->flags & DWC3_EP_TRANSFER_STARTED);
1220 dwc3_prepare_trbs(dep);
1221 req = next_request(&dep->started_list);
1222 if (!req) {
1223 dep->flags |= DWC3_EP_PENDING_REQUEST;
1224 return 0;
1227 memset(&params, 0, sizeof(params));
1229 if (starting) {
1230 params.param0 = upper_32_bits(req->trb_dma);
1231 params.param1 = lower_32_bits(req->trb_dma);
1232 cmd = DWC3_DEPCMD_STARTTRANSFER;
1234 if (dep->stream_capable)
1235 cmd |= DWC3_DEPCMD_PARAM(req->request.stream_id);
1237 if (usb_endpoint_xfer_isoc(dep->endpoint.desc))
1238 cmd |= DWC3_DEPCMD_PARAM(dep->frame_number);
1239 } else {
1240 cmd = DWC3_DEPCMD_UPDATETRANSFER |
1241 DWC3_DEPCMD_PARAM(dep->resource_index);
1244 ret = dwc3_send_gadget_ep_cmd(dep, cmd, &params);
1245 if (ret < 0) {
1247 * FIXME we need to iterate over the list of requests
1248 * here and stop, unmap, free and del each of the linked
1249 * requests instead of what we do now.
1251 if (req->trb)
1252 memset(req->trb, 0, sizeof(struct dwc3_trb));
1253 dwc3_gadget_del_and_unmap_request(dep, req, ret);
1254 return ret;
1257 return 0;
1260 static int __dwc3_gadget_get_frame(struct dwc3 *dwc)
1262 u32 reg;
1264 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1265 return DWC3_DSTS_SOFFN(reg);
1269 * dwc3_gadget_start_isoc_quirk - workaround invalid frame number
1270 * @dep: isoc endpoint
1272 * This function tests for the correct combination of BIT[15:14] from the 16-bit
1273 * microframe number reported by the XferNotReady event for the future frame
1274 * number to start the isoc transfer.
1276 * In DWC_usb31 version 1.70a-ea06 and prior, for highspeed and fullspeed
1277 * isochronous IN, BIT[15:14] of the 16-bit microframe number reported by the
1278 * XferNotReady event are invalid. The driver uses this number to schedule the
1279 * isochronous transfer and passes it to the START TRANSFER command. Because
1280 * this number is invalid, the command may fail. If BIT[15:14] matches the
1281 * internal 16-bit microframe, the START TRANSFER command will pass and the
1282 * transfer will start at the scheduled time, if it is off by 1, the command
1283 * will still pass, but the transfer will start 2 seconds in the future. For all
1284 * other conditions, the START TRANSFER command will fail with bus-expiry.
1286 * In order to workaround this issue, we can test for the correct combination of
1287 * BIT[15:14] by sending START TRANSFER commands with different values of
1288 * BIT[15:14]: 'b00, 'b01, 'b10, and 'b11. Each combination is 2^14 uframe apart
1289 * (or 2 seconds). 4 seconds into the future will result in a bus-expiry status.
1290 * As the result, within the 4 possible combinations for BIT[15:14], there will
1291 * be 2 successful and 2 failure START COMMAND status. One of the 2 successful
1292 * command status will result in a 2-second delay start. The smaller BIT[15:14]
1293 * value is the correct combination.
1295 * Since there are only 4 outcomes and the results are ordered, we can simply
1296 * test 2 START TRANSFER commands with BIT[15:14] combinations 'b00 and 'b01 to
1297 * deduce the smaller successful combination.
1299 * Let test0 = test status for combination 'b00 and test1 = test status for 'b01
1300 * of BIT[15:14]. The correct combination is as follow:
1302 * if test0 fails and test1 passes, BIT[15:14] is 'b01
1303 * if test0 fails and test1 fails, BIT[15:14] is 'b10
1304 * if test0 passes and test1 fails, BIT[15:14] is 'b11
1305 * if test0 passes and test1 passes, BIT[15:14] is 'b00
1307 * Synopsys STAR 9001202023: Wrong microframe number for isochronous IN
1308 * endpoints.
1310 static int dwc3_gadget_start_isoc_quirk(struct dwc3_ep *dep)
1312 int cmd_status = 0;
1313 bool test0;
1314 bool test1;
1316 while (dep->combo_num < 2) {
1317 struct dwc3_gadget_ep_cmd_params params;
1318 u32 test_frame_number;
1319 u32 cmd;
1322 * Check if we can start isoc transfer on the next interval or
1323 * 4 uframes in the future with BIT[15:14] as dep->combo_num
1325 test_frame_number = dep->frame_number & 0x3fff;
1326 test_frame_number |= dep->combo_num << 14;
1327 test_frame_number += max_t(u32, 4, dep->interval);
1329 params.param0 = upper_32_bits(dep->dwc->bounce_addr);
1330 params.param1 = lower_32_bits(dep->dwc->bounce_addr);
1332 cmd = DWC3_DEPCMD_STARTTRANSFER;
1333 cmd |= DWC3_DEPCMD_PARAM(test_frame_number);
1334 cmd_status = dwc3_send_gadget_ep_cmd(dep, cmd, &params);
1336 /* Redo if some other failure beside bus-expiry is received */
1337 if (cmd_status && cmd_status != -EAGAIN) {
1338 dep->start_cmd_status = 0;
1339 dep->combo_num = 0;
1340 return 0;
1343 /* Store the first test status */
1344 if (dep->combo_num == 0)
1345 dep->start_cmd_status = cmd_status;
1347 dep->combo_num++;
1350 * End the transfer if the START_TRANSFER command is successful
1351 * to wait for the next XferNotReady to test the command again
1353 if (cmd_status == 0) {
1354 dwc3_stop_active_transfer(dep, true, true);
1355 return 0;
1359 /* test0 and test1 are both completed at this point */
1360 test0 = (dep->start_cmd_status == 0);
1361 test1 = (cmd_status == 0);
1363 if (!test0 && test1)
1364 dep->combo_num = 1;
1365 else if (!test0 && !test1)
1366 dep->combo_num = 2;
1367 else if (test0 && !test1)
1368 dep->combo_num = 3;
1369 else if (test0 && test1)
1370 dep->combo_num = 0;
1372 dep->frame_number &= 0x3fff;
1373 dep->frame_number |= dep->combo_num << 14;
1374 dep->frame_number += max_t(u32, 4, dep->interval);
1376 /* Reinitialize test variables */
1377 dep->start_cmd_status = 0;
1378 dep->combo_num = 0;
1380 return __dwc3_gadget_kick_transfer(dep);
1383 static int __dwc3_gadget_start_isoc(struct dwc3_ep *dep)
1385 struct dwc3 *dwc = dep->dwc;
1386 int ret;
1387 int i;
1389 if (list_empty(&dep->pending_list)) {
1390 dep->flags |= DWC3_EP_PENDING_REQUEST;
1391 return -EAGAIN;
1394 if (!dwc->dis_start_transfer_quirk && dwc3_is_usb31(dwc) &&
1395 (dwc->revision <= DWC3_USB31_REVISION_160A ||
1396 (dwc->revision == DWC3_USB31_REVISION_170A &&
1397 dwc->version_type >= DWC31_VERSIONTYPE_EA01 &&
1398 dwc->version_type <= DWC31_VERSIONTYPE_EA06))) {
1400 if (dwc->gadget.speed <= USB_SPEED_HIGH && dep->direction)
1401 return dwc3_gadget_start_isoc_quirk(dep);
1404 for (i = 0; i < DWC3_ISOC_MAX_RETRIES; i++) {
1405 dep->frame_number = DWC3_ALIGN_FRAME(dep, i + 1);
1407 ret = __dwc3_gadget_kick_transfer(dep);
1408 if (ret != -EAGAIN)
1409 break;
1412 return ret;
1415 static int __dwc3_gadget_ep_queue(struct dwc3_ep *dep, struct dwc3_request *req)
1417 struct dwc3 *dwc = dep->dwc;
1419 if (!dep->endpoint.desc) {
1420 dev_err(dwc->dev, "%s: can't queue to disabled endpoint\n",
1421 dep->name);
1422 return -ESHUTDOWN;
1425 if (WARN(req->dep != dep, "request %pK belongs to '%s'\n",
1426 &req->request, req->dep->name))
1427 return -EINVAL;
1429 if (WARN(req->status < DWC3_REQUEST_STATUS_COMPLETED,
1430 "%s: request %pK already in flight\n",
1431 dep->name, &req->request))
1432 return -EINVAL;
1434 pm_runtime_get(dwc->dev);
1436 req->request.actual = 0;
1437 req->request.status = -EINPROGRESS;
1439 trace_dwc3_ep_queue(req);
1441 list_add_tail(&req->list, &dep->pending_list);
1442 req->status = DWC3_REQUEST_STATUS_QUEUED;
1445 * NOTICE: Isochronous endpoints should NEVER be prestarted. We must
1446 * wait for a XferNotReady event so we will know what's the current
1447 * (micro-)frame number.
1449 * Without this trick, we are very, very likely gonna get Bus Expiry
1450 * errors which will force us issue EndTransfer command.
1452 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1453 if (!(dep->flags & DWC3_EP_PENDING_REQUEST) &&
1454 !(dep->flags & DWC3_EP_TRANSFER_STARTED))
1455 return 0;
1457 if ((dep->flags & DWC3_EP_PENDING_REQUEST)) {
1458 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED)) {
1459 return __dwc3_gadget_start_isoc(dep);
1464 return __dwc3_gadget_kick_transfer(dep);
1467 static int dwc3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
1468 gfp_t gfp_flags)
1470 struct dwc3_request *req = to_dwc3_request(request);
1471 struct dwc3_ep *dep = to_dwc3_ep(ep);
1472 struct dwc3 *dwc = dep->dwc;
1474 unsigned long flags;
1476 int ret;
1478 spin_lock_irqsave(&dwc->lock, flags);
1479 ret = __dwc3_gadget_ep_queue(dep, req);
1480 spin_unlock_irqrestore(&dwc->lock, flags);
1482 return ret;
1485 static void dwc3_gadget_ep_skip_trbs(struct dwc3_ep *dep, struct dwc3_request *req)
1487 int i;
1490 * If request was already started, this means we had to
1491 * stop the transfer. With that we also need to ignore
1492 * all TRBs used by the request, however TRBs can only
1493 * be modified after completion of END_TRANSFER
1494 * command. So what we do here is that we wait for
1495 * END_TRANSFER completion and only after that, we jump
1496 * over TRBs by clearing HWO and incrementing dequeue
1497 * pointer.
1499 for (i = 0; i < req->num_trbs; i++) {
1500 struct dwc3_trb *trb;
1502 trb = req->trb + i;
1503 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
1504 dwc3_ep_inc_deq(dep);
1507 req->num_trbs = 0;
1510 static void dwc3_gadget_ep_cleanup_cancelled_requests(struct dwc3_ep *dep)
1512 struct dwc3_request *req;
1513 struct dwc3_request *tmp;
1515 list_for_each_entry_safe(req, tmp, &dep->cancelled_list, list) {
1516 dwc3_gadget_ep_skip_trbs(dep, req);
1517 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1521 static int dwc3_gadget_ep_dequeue(struct usb_ep *ep,
1522 struct usb_request *request)
1524 struct dwc3_request *req = to_dwc3_request(request);
1525 struct dwc3_request *r = NULL;
1527 struct dwc3_ep *dep = to_dwc3_ep(ep);
1528 struct dwc3 *dwc = dep->dwc;
1530 unsigned long flags;
1531 int ret = 0;
1533 trace_dwc3_ep_dequeue(req);
1535 spin_lock_irqsave(&dwc->lock, flags);
1537 list_for_each_entry(r, &dep->pending_list, list) {
1538 if (r == req)
1539 break;
1542 if (r != req) {
1543 list_for_each_entry(r, &dep->started_list, list) {
1544 if (r == req)
1545 break;
1547 if (r == req) {
1548 /* wait until it is processed */
1549 dwc3_stop_active_transfer(dep, true, true);
1551 if (!r->trb)
1552 goto out0;
1554 dwc3_gadget_move_cancelled_request(req);
1555 if (dep->flags & DWC3_EP_TRANSFER_STARTED)
1556 goto out0;
1557 else
1558 goto out1;
1560 dev_err(dwc->dev, "request %pK was not queued to %s\n",
1561 request, ep->name);
1562 ret = -EINVAL;
1563 goto out0;
1566 out1:
1567 dwc3_gadget_giveback(dep, req, -ECONNRESET);
1569 out0:
1570 spin_unlock_irqrestore(&dwc->lock, flags);
1572 return ret;
1575 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol)
1577 struct dwc3_gadget_ep_cmd_params params;
1578 struct dwc3 *dwc = dep->dwc;
1579 int ret;
1581 if (usb_endpoint_xfer_isoc(dep->endpoint.desc)) {
1582 dev_err(dwc->dev, "%s is of Isochronous type\n", dep->name);
1583 return -EINVAL;
1586 memset(&params, 0x00, sizeof(params));
1588 if (value) {
1589 struct dwc3_trb *trb;
1591 unsigned transfer_in_flight;
1592 unsigned started;
1594 if (dep->number > 1)
1595 trb = dwc3_ep_prev_trb(dep, dep->trb_enqueue);
1596 else
1597 trb = &dwc->ep0_trb[dep->trb_enqueue];
1599 transfer_in_flight = trb->ctrl & DWC3_TRB_CTRL_HWO;
1600 started = !list_empty(&dep->started_list);
1602 if (!protocol && ((dep->direction && transfer_in_flight) ||
1603 (!dep->direction && started))) {
1604 return -EAGAIN;
1607 ret = dwc3_send_gadget_ep_cmd(dep, DWC3_DEPCMD_SETSTALL,
1608 &params);
1609 if (ret)
1610 dev_err(dwc->dev, "failed to set STALL on %s\n",
1611 dep->name);
1612 else
1613 dep->flags |= DWC3_EP_STALL;
1614 } else {
1616 ret = dwc3_send_clear_stall_ep_cmd(dep);
1617 if (ret)
1618 dev_err(dwc->dev, "failed to clear STALL on %s\n",
1619 dep->name);
1620 else
1621 dep->flags &= ~(DWC3_EP_STALL | DWC3_EP_WEDGE);
1624 return ret;
1627 static int dwc3_gadget_ep_set_halt(struct usb_ep *ep, int value)
1629 struct dwc3_ep *dep = to_dwc3_ep(ep);
1630 struct dwc3 *dwc = dep->dwc;
1632 unsigned long flags;
1634 int ret;
1636 spin_lock_irqsave(&dwc->lock, flags);
1637 ret = __dwc3_gadget_ep_set_halt(dep, value, false);
1638 spin_unlock_irqrestore(&dwc->lock, flags);
1640 return ret;
1643 static int dwc3_gadget_ep_set_wedge(struct usb_ep *ep)
1645 struct dwc3_ep *dep = to_dwc3_ep(ep);
1646 struct dwc3 *dwc = dep->dwc;
1647 unsigned long flags;
1648 int ret;
1650 spin_lock_irqsave(&dwc->lock, flags);
1651 dep->flags |= DWC3_EP_WEDGE;
1653 if (dep->number == 0 || dep->number == 1)
1654 ret = __dwc3_gadget_ep0_set_halt(ep, 1);
1655 else
1656 ret = __dwc3_gadget_ep_set_halt(dep, 1, false);
1657 spin_unlock_irqrestore(&dwc->lock, flags);
1659 return ret;
1662 /* -------------------------------------------------------------------------- */
1664 static struct usb_endpoint_descriptor dwc3_gadget_ep0_desc = {
1665 .bLength = USB_DT_ENDPOINT_SIZE,
1666 .bDescriptorType = USB_DT_ENDPOINT,
1667 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
1670 static const struct usb_ep_ops dwc3_gadget_ep0_ops = {
1671 .enable = dwc3_gadget_ep0_enable,
1672 .disable = dwc3_gadget_ep0_disable,
1673 .alloc_request = dwc3_gadget_ep_alloc_request,
1674 .free_request = dwc3_gadget_ep_free_request,
1675 .queue = dwc3_gadget_ep0_queue,
1676 .dequeue = dwc3_gadget_ep_dequeue,
1677 .set_halt = dwc3_gadget_ep0_set_halt,
1678 .set_wedge = dwc3_gadget_ep_set_wedge,
1681 static const struct usb_ep_ops dwc3_gadget_ep_ops = {
1682 .enable = dwc3_gadget_ep_enable,
1683 .disable = dwc3_gadget_ep_disable,
1684 .alloc_request = dwc3_gadget_ep_alloc_request,
1685 .free_request = dwc3_gadget_ep_free_request,
1686 .queue = dwc3_gadget_ep_queue,
1687 .dequeue = dwc3_gadget_ep_dequeue,
1688 .set_halt = dwc3_gadget_ep_set_halt,
1689 .set_wedge = dwc3_gadget_ep_set_wedge,
1692 /* -------------------------------------------------------------------------- */
1694 static int dwc3_gadget_get_frame(struct usb_gadget *g)
1696 struct dwc3 *dwc = gadget_to_dwc(g);
1698 return __dwc3_gadget_get_frame(dwc);
1701 static int __dwc3_gadget_wakeup(struct dwc3 *dwc)
1703 int retries;
1705 int ret;
1706 u32 reg;
1708 u8 link_state;
1709 u8 speed;
1712 * According to the Databook Remote wakeup request should
1713 * be issued only when the device is in early suspend state.
1715 * We can check that via USB Link State bits in DSTS register.
1717 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1719 speed = reg & DWC3_DSTS_CONNECTSPD;
1720 if ((speed == DWC3_DSTS_SUPERSPEED) ||
1721 (speed == DWC3_DSTS_SUPERSPEED_PLUS))
1722 return 0;
1724 link_state = DWC3_DSTS_USBLNKST(reg);
1726 switch (link_state) {
1727 case DWC3_LINK_STATE_RX_DET: /* in HS, means Early Suspend */
1728 case DWC3_LINK_STATE_U3: /* in HS, means SUSPEND */
1729 break;
1730 default:
1731 return -EINVAL;
1734 ret = dwc3_gadget_set_link_state(dwc, DWC3_LINK_STATE_RECOV);
1735 if (ret < 0) {
1736 dev_err(dwc->dev, "failed to put link in Recovery\n");
1737 return ret;
1740 /* Recent versions do this automatically */
1741 if (dwc->revision < DWC3_REVISION_194A) {
1742 /* write zeroes to Link Change Request */
1743 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1744 reg &= ~DWC3_DCTL_ULSTCHNGREQ_MASK;
1745 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1748 /* poll until Link State changes to ON */
1749 retries = 20000;
1751 while (retries--) {
1752 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1754 /* in HS, means ON */
1755 if (DWC3_DSTS_USBLNKST(reg) == DWC3_LINK_STATE_U0)
1756 break;
1759 if (DWC3_DSTS_USBLNKST(reg) != DWC3_LINK_STATE_U0) {
1760 dev_err(dwc->dev, "failed to send remote wakeup\n");
1761 return -EINVAL;
1764 return 0;
1767 static int dwc3_gadget_wakeup(struct usb_gadget *g)
1769 struct dwc3 *dwc = gadget_to_dwc(g);
1770 unsigned long flags;
1771 int ret;
1773 spin_lock_irqsave(&dwc->lock, flags);
1774 ret = __dwc3_gadget_wakeup(dwc);
1775 spin_unlock_irqrestore(&dwc->lock, flags);
1777 return ret;
1780 static int dwc3_gadget_set_selfpowered(struct usb_gadget *g,
1781 int is_selfpowered)
1783 struct dwc3 *dwc = gadget_to_dwc(g);
1784 unsigned long flags;
1786 spin_lock_irqsave(&dwc->lock, flags);
1787 g->is_selfpowered = !!is_selfpowered;
1788 spin_unlock_irqrestore(&dwc->lock, flags);
1790 return 0;
1793 static int dwc3_gadget_run_stop(struct dwc3 *dwc, int is_on, int suspend)
1795 u32 reg;
1796 u32 timeout = 500;
1798 if (pm_runtime_suspended(dwc->dev))
1799 return 0;
1801 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
1802 if (is_on) {
1803 if (dwc->revision <= DWC3_REVISION_187A) {
1804 reg &= ~DWC3_DCTL_TRGTULST_MASK;
1805 reg |= DWC3_DCTL_TRGTULST_RX_DET;
1808 if (dwc->revision >= DWC3_REVISION_194A)
1809 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1810 reg |= DWC3_DCTL_RUN_STOP;
1812 if (dwc->has_hibernation)
1813 reg |= DWC3_DCTL_KEEP_CONNECT;
1815 dwc->pullups_connected = true;
1816 } else {
1817 reg &= ~DWC3_DCTL_RUN_STOP;
1819 if (dwc->has_hibernation && !suspend)
1820 reg &= ~DWC3_DCTL_KEEP_CONNECT;
1822 dwc->pullups_connected = false;
1825 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
1827 do {
1828 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
1829 reg &= DWC3_DSTS_DEVCTRLHLT;
1830 } while (--timeout && !(!is_on ^ !reg));
1832 if (!timeout)
1833 return -ETIMEDOUT;
1835 return 0;
1838 static int dwc3_gadget_pullup(struct usb_gadget *g, int is_on)
1840 struct dwc3 *dwc = gadget_to_dwc(g);
1841 unsigned long flags;
1842 int ret;
1844 is_on = !!is_on;
1847 * Per databook, when we want to stop the gadget, if a control transfer
1848 * is still in process, complete it and get the core into setup phase.
1850 if (!is_on && dwc->ep0state != EP0_SETUP_PHASE) {
1851 reinit_completion(&dwc->ep0_in_setup);
1853 ret = wait_for_completion_timeout(&dwc->ep0_in_setup,
1854 msecs_to_jiffies(DWC3_PULL_UP_TIMEOUT));
1855 if (ret == 0) {
1856 dev_err(dwc->dev, "timed out waiting for SETUP phase\n");
1857 return -ETIMEDOUT;
1861 spin_lock_irqsave(&dwc->lock, flags);
1862 ret = dwc3_gadget_run_stop(dwc, is_on, false);
1863 spin_unlock_irqrestore(&dwc->lock, flags);
1865 return ret;
1868 static void dwc3_gadget_enable_irq(struct dwc3 *dwc)
1870 u32 reg;
1872 /* Enable all but Start and End of Frame IRQs */
1873 reg = (DWC3_DEVTEN_VNDRDEVTSTRCVEDEN |
1874 DWC3_DEVTEN_EVNTOVERFLOWEN |
1875 DWC3_DEVTEN_CMDCMPLTEN |
1876 DWC3_DEVTEN_ERRTICERREN |
1877 DWC3_DEVTEN_WKUPEVTEN |
1878 DWC3_DEVTEN_CONNECTDONEEN |
1879 DWC3_DEVTEN_USBRSTEN |
1880 DWC3_DEVTEN_DISCONNEVTEN);
1882 if (dwc->revision < DWC3_REVISION_250A)
1883 reg |= DWC3_DEVTEN_ULSTCNGEN;
1885 dwc3_writel(dwc->regs, DWC3_DEVTEN, reg);
1888 static void dwc3_gadget_disable_irq(struct dwc3 *dwc)
1890 /* mask all interrupts */
1891 dwc3_writel(dwc->regs, DWC3_DEVTEN, 0x00);
1894 static irqreturn_t dwc3_interrupt(int irq, void *_dwc);
1895 static irqreturn_t dwc3_thread_interrupt(int irq, void *_dwc);
1898 * dwc3_gadget_setup_nump - calculate and initialize NUMP field of %DWC3_DCFG
1899 * @dwc: pointer to our context structure
1901 * The following looks like complex but it's actually very simple. In order to
1902 * calculate the number of packets we can burst at once on OUT transfers, we're
1903 * gonna use RxFIFO size.
1905 * To calculate RxFIFO size we need two numbers:
1906 * MDWIDTH = size, in bits, of the internal memory bus
1907 * RAM2_DEPTH = depth, in MDWIDTH, of internal RAM2 (where RxFIFO sits)
1909 * Given these two numbers, the formula is simple:
1911 * RxFIFO Size = (RAM2_DEPTH * MDWIDTH / 8) - 24 - 16;
1913 * 24 bytes is for 3x SETUP packets
1914 * 16 bytes is a clock domain crossing tolerance
1916 * Given RxFIFO Size, NUMP = RxFIFOSize / 1024;
1918 static void dwc3_gadget_setup_nump(struct dwc3 *dwc)
1920 u32 ram2_depth;
1921 u32 mdwidth;
1922 u32 nump;
1923 u32 reg;
1925 ram2_depth = DWC3_GHWPARAMS7_RAM2_DEPTH(dwc->hwparams.hwparams7);
1926 mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);
1928 nump = ((ram2_depth * mdwidth / 8) - 24 - 16) / 1024;
1929 nump = min_t(u32, nump, 16);
1931 /* update NumP */
1932 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
1933 reg &= ~DWC3_DCFG_NUMP_MASK;
1934 reg |= nump << DWC3_DCFG_NUMP_SHIFT;
1935 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
1938 static int __dwc3_gadget_start(struct dwc3 *dwc)
1940 struct dwc3_ep *dep;
1941 int ret = 0;
1942 u32 reg;
1945 * Use IMOD if enabled via dwc->imod_interval. Otherwise, if
1946 * the core supports IMOD, disable it.
1948 if (dwc->imod_interval) {
1949 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
1950 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
1951 } else if (dwc3_has_imod(dwc)) {
1952 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), 0);
1956 * We are telling dwc3 that we want to use DCFG.NUMP as ACK TP's NUMP
1957 * field instead of letting dwc3 itself calculate that automatically.
1959 * This way, we maximize the chances that we'll be able to get several
1960 * bursts of data without going through any sort of endpoint throttling.
1962 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1963 if (dwc3_is_usb31(dwc))
1964 reg &= ~DWC31_GRXTHRCFG_PKTCNTSEL;
1965 else
1966 reg &= ~DWC3_GRXTHRCFG_PKTCNTSEL;
1968 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1970 dwc3_gadget_setup_nump(dwc);
1972 /* Start with SuperSpeed Default */
1973 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
1975 dep = dwc->eps[0];
1976 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
1977 if (ret) {
1978 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1979 goto err0;
1982 dep = dwc->eps[1];
1983 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_INIT);
1984 if (ret) {
1985 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
1986 goto err1;
1989 /* begin to receive SETUP packets */
1990 dwc->ep0state = EP0_SETUP_PHASE;
1991 dwc->link_state = DWC3_LINK_STATE_SS_DIS;
1992 dwc3_ep0_out_start(dwc);
1994 dwc3_gadget_enable_irq(dwc);
1996 return 0;
1998 err1:
1999 __dwc3_gadget_ep_disable(dwc->eps[0]);
2001 err0:
2002 return ret;
2005 static int dwc3_gadget_start(struct usb_gadget *g,
2006 struct usb_gadget_driver *driver)
2008 struct dwc3 *dwc = gadget_to_dwc(g);
2009 unsigned long flags;
2010 int ret = 0;
2011 int irq;
2013 irq = dwc->irq_gadget;
2014 ret = request_threaded_irq(irq, dwc3_interrupt, dwc3_thread_interrupt,
2015 IRQF_SHARED, "dwc3", dwc->ev_buf);
2016 if (ret) {
2017 dev_err(dwc->dev, "failed to request irq #%d --> %d\n",
2018 irq, ret);
2019 goto err0;
2022 spin_lock_irqsave(&dwc->lock, flags);
2023 if (dwc->gadget_driver) {
2024 dev_err(dwc->dev, "%s is already bound to %s\n",
2025 dwc->gadget.name,
2026 dwc->gadget_driver->driver.name);
2027 ret = -EBUSY;
2028 goto err1;
2031 dwc->gadget_driver = driver;
2033 if (pm_runtime_active(dwc->dev))
2034 __dwc3_gadget_start(dwc);
2036 spin_unlock_irqrestore(&dwc->lock, flags);
2038 return 0;
2040 err1:
2041 spin_unlock_irqrestore(&dwc->lock, flags);
2042 free_irq(irq, dwc);
2044 err0:
2045 return ret;
2048 static void __dwc3_gadget_stop(struct dwc3 *dwc)
2050 dwc3_gadget_disable_irq(dwc);
2051 __dwc3_gadget_ep_disable(dwc->eps[0]);
2052 __dwc3_gadget_ep_disable(dwc->eps[1]);
2055 static int dwc3_gadget_stop(struct usb_gadget *g)
2057 struct dwc3 *dwc = gadget_to_dwc(g);
2058 unsigned long flags;
2060 spin_lock_irqsave(&dwc->lock, flags);
2062 if (pm_runtime_suspended(dwc->dev))
2063 goto out;
2065 __dwc3_gadget_stop(dwc);
2067 out:
2068 dwc->gadget_driver = NULL;
2069 spin_unlock_irqrestore(&dwc->lock, flags);
2071 free_irq(dwc->irq_gadget, dwc->ev_buf);
2073 return 0;
2076 static void dwc3_gadget_set_speed(struct usb_gadget *g,
2077 enum usb_device_speed speed)
2079 struct dwc3 *dwc = gadget_to_dwc(g);
2080 unsigned long flags;
2081 u32 reg;
2083 spin_lock_irqsave(&dwc->lock, flags);
2084 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2085 reg &= ~(DWC3_DCFG_SPEED_MASK);
2088 * WORKAROUND: DWC3 revision < 2.20a have an issue
2089 * which would cause metastability state on Run/Stop
2090 * bit if we try to force the IP to USB2-only mode.
2092 * Because of that, we cannot configure the IP to any
2093 * speed other than the SuperSpeed
2095 * Refers to:
2097 * STAR#9000525659: Clock Domain Crossing on DCTL in
2098 * USB 2.0 Mode
2100 if (dwc->revision < DWC3_REVISION_220A &&
2101 !dwc->dis_metastability_quirk) {
2102 reg |= DWC3_DCFG_SUPERSPEED;
2103 } else {
2104 switch (speed) {
2105 case USB_SPEED_LOW:
2106 reg |= DWC3_DCFG_LOWSPEED;
2107 break;
2108 case USB_SPEED_FULL:
2109 reg |= DWC3_DCFG_FULLSPEED;
2110 break;
2111 case USB_SPEED_HIGH:
2112 reg |= DWC3_DCFG_HIGHSPEED;
2113 break;
2114 case USB_SPEED_SUPER:
2115 reg |= DWC3_DCFG_SUPERSPEED;
2116 break;
2117 case USB_SPEED_SUPER_PLUS:
2118 if (dwc3_is_usb31(dwc))
2119 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2120 else
2121 reg |= DWC3_DCFG_SUPERSPEED;
2122 break;
2123 default:
2124 dev_err(dwc->dev, "invalid speed (%d)\n", speed);
2126 if (dwc->revision & DWC3_REVISION_IS_DWC31)
2127 reg |= DWC3_DCFG_SUPERSPEED_PLUS;
2128 else
2129 reg |= DWC3_DCFG_SUPERSPEED;
2132 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2134 spin_unlock_irqrestore(&dwc->lock, flags);
2137 static const struct usb_gadget_ops dwc3_gadget_ops = {
2138 .get_frame = dwc3_gadget_get_frame,
2139 .wakeup = dwc3_gadget_wakeup,
2140 .set_selfpowered = dwc3_gadget_set_selfpowered,
2141 .pullup = dwc3_gadget_pullup,
2142 .udc_start = dwc3_gadget_start,
2143 .udc_stop = dwc3_gadget_stop,
2144 .udc_set_speed = dwc3_gadget_set_speed,
2147 /* -------------------------------------------------------------------------- */
2149 static int dwc3_gadget_init_control_endpoint(struct dwc3_ep *dep)
2151 struct dwc3 *dwc = dep->dwc;
2153 usb_ep_set_maxpacket_limit(&dep->endpoint, 512);
2154 dep->endpoint.maxburst = 1;
2155 dep->endpoint.ops = &dwc3_gadget_ep0_ops;
2156 if (!dep->direction)
2157 dwc->gadget.ep0 = &dep->endpoint;
2159 dep->endpoint.caps.type_control = true;
2161 return 0;
2164 static int dwc3_gadget_init_in_endpoint(struct dwc3_ep *dep)
2166 struct dwc3 *dwc = dep->dwc;
2167 int mdwidth;
2168 int kbytes;
2169 int size;
2171 mdwidth = DWC3_MDWIDTH(dwc->hwparams.hwparams0);
2172 /* MDWIDTH is represented in bits, we need it in bytes */
2173 mdwidth /= 8;
2175 size = dwc3_readl(dwc->regs, DWC3_GTXFIFOSIZ(dep->number >> 1));
2176 if (dwc3_is_usb31(dwc))
2177 size = DWC31_GTXFIFOSIZ_TXFDEF(size);
2178 else
2179 size = DWC3_GTXFIFOSIZ_TXFDEF(size);
2181 /* FIFO Depth is in MDWDITH bytes. Multiply */
2182 size *= mdwidth;
2184 kbytes = size / 1024;
2185 if (kbytes == 0)
2186 kbytes = 1;
2189 * FIFO sizes account an extra MDWIDTH * (kbytes + 1) bytes for
2190 * internal overhead. We don't really know how these are used,
2191 * but documentation say it exists.
2193 size -= mdwidth * (kbytes + 1);
2194 size /= kbytes;
2196 usb_ep_set_maxpacket_limit(&dep->endpoint, size);
2198 dep->endpoint.max_streams = 15;
2199 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2200 list_add_tail(&dep->endpoint.ep_list,
2201 &dwc->gadget.ep_list);
2202 dep->endpoint.caps.type_iso = true;
2203 dep->endpoint.caps.type_bulk = true;
2204 dep->endpoint.caps.type_int = true;
2206 return dwc3_alloc_trb_pool(dep);
2209 static int dwc3_gadget_init_out_endpoint(struct dwc3_ep *dep)
2211 struct dwc3 *dwc = dep->dwc;
2213 usb_ep_set_maxpacket_limit(&dep->endpoint, 1024);
2214 dep->endpoint.max_streams = 15;
2215 dep->endpoint.ops = &dwc3_gadget_ep_ops;
2216 list_add_tail(&dep->endpoint.ep_list,
2217 &dwc->gadget.ep_list);
2218 dep->endpoint.caps.type_iso = true;
2219 dep->endpoint.caps.type_bulk = true;
2220 dep->endpoint.caps.type_int = true;
2222 return dwc3_alloc_trb_pool(dep);
2225 static int dwc3_gadget_init_endpoint(struct dwc3 *dwc, u8 epnum)
2227 struct dwc3_ep *dep;
2228 bool direction = epnum & 1;
2229 int ret;
2230 u8 num = epnum >> 1;
2232 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
2233 if (!dep)
2234 return -ENOMEM;
2236 dep->dwc = dwc;
2237 dep->number = epnum;
2238 dep->direction = direction;
2239 dep->regs = dwc->regs + DWC3_DEP_BASE(epnum);
2240 dwc->eps[epnum] = dep;
2241 dep->combo_num = 0;
2242 dep->start_cmd_status = 0;
2244 snprintf(dep->name, sizeof(dep->name), "ep%u%s", num,
2245 direction ? "in" : "out");
2247 dep->endpoint.name = dep->name;
2249 if (!(dep->number > 1)) {
2250 dep->endpoint.desc = &dwc3_gadget_ep0_desc;
2251 dep->endpoint.comp_desc = NULL;
2254 spin_lock_init(&dep->lock);
2256 if (num == 0)
2257 ret = dwc3_gadget_init_control_endpoint(dep);
2258 else if (direction)
2259 ret = dwc3_gadget_init_in_endpoint(dep);
2260 else
2261 ret = dwc3_gadget_init_out_endpoint(dep);
2263 if (ret)
2264 return ret;
2266 dep->endpoint.caps.dir_in = direction;
2267 dep->endpoint.caps.dir_out = !direction;
2269 INIT_LIST_HEAD(&dep->pending_list);
2270 INIT_LIST_HEAD(&dep->started_list);
2271 INIT_LIST_HEAD(&dep->cancelled_list);
2273 return 0;
2276 static int dwc3_gadget_init_endpoints(struct dwc3 *dwc, u8 total)
2278 u8 epnum;
2280 INIT_LIST_HEAD(&dwc->gadget.ep_list);
2282 for (epnum = 0; epnum < total; epnum++) {
2283 int ret;
2285 ret = dwc3_gadget_init_endpoint(dwc, epnum);
2286 if (ret)
2287 return ret;
2290 return 0;
2293 static void dwc3_gadget_free_endpoints(struct dwc3 *dwc)
2295 struct dwc3_ep *dep;
2296 u8 epnum;
2298 for (epnum = 0; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2299 dep = dwc->eps[epnum];
2300 if (!dep)
2301 continue;
2303 * Physical endpoints 0 and 1 are special; they form the
2304 * bi-directional USB endpoint 0.
2306 * For those two physical endpoints, we don't allocate a TRB
2307 * pool nor do we add them the endpoints list. Due to that, we
2308 * shouldn't do these two operations otherwise we would end up
2309 * with all sorts of bugs when removing dwc3.ko.
2311 if (epnum != 0 && epnum != 1) {
2312 dwc3_free_trb_pool(dep);
2313 list_del(&dep->endpoint.ep_list);
2316 kfree(dep);
2320 /* -------------------------------------------------------------------------- */
2322 static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
2323 struct dwc3_request *req, struct dwc3_trb *trb,
2324 const struct dwc3_event_depevt *event, int status, int chain)
2326 unsigned int count;
2328 dwc3_ep_inc_deq(dep);
2330 trace_dwc3_complete_trb(dep, trb);
2331 req->num_trbs--;
2334 * If we're in the middle of series of chained TRBs and we
2335 * receive a short transfer along the way, DWC3 will skip
2336 * through all TRBs including the last TRB in the chain (the
2337 * where CHN bit is zero. DWC3 will also avoid clearing HWO
2338 * bit and SW has to do it manually.
2340 * We're going to do that here to avoid problems of HW trying
2341 * to use bogus TRBs for transfers.
2343 if (chain && (trb->ctrl & DWC3_TRB_CTRL_HWO))
2344 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2347 * For isochronous transfers, the first TRB in a service interval must
2348 * have the Isoc-First type. Track and report its interval frame number.
2350 if (usb_endpoint_xfer_isoc(dep->endpoint.desc) &&
2351 (trb->ctrl & DWC3_TRBCTL_ISOCHRONOUS_FIRST)) {
2352 unsigned int frame_number;
2354 frame_number = DWC3_TRB_CTRL_GET_SID_SOFN(trb->ctrl);
2355 frame_number &= ~(dep->interval - 1);
2356 req->request.frame_number = frame_number;
2360 * If we're dealing with unaligned size OUT transfer, we will be left
2361 * with one TRB pending in the ring. We need to manually clear HWO bit
2362 * from that TRB.
2365 if (req->needs_extra_trb && !(trb->ctrl & DWC3_TRB_CTRL_CHN)) {
2366 trb->ctrl &= ~DWC3_TRB_CTRL_HWO;
2367 return 1;
2370 count = trb->size & DWC3_TRB_SIZE_MASK;
2371 req->remaining += count;
2373 if ((trb->ctrl & DWC3_TRB_CTRL_HWO) && status != -ESHUTDOWN)
2374 return 1;
2376 if (event->status & DEPEVT_STATUS_SHORT && !chain)
2377 return 1;
2379 if (event->status & DEPEVT_STATUS_IOC)
2380 return 1;
2382 return 0;
2385 static int dwc3_gadget_ep_reclaim_trb_sg(struct dwc3_ep *dep,
2386 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2387 int status)
2389 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2390 struct scatterlist *sg = req->sg;
2391 struct scatterlist *s;
2392 unsigned int pending = req->num_pending_sgs;
2393 unsigned int i;
2394 int ret = 0;
2396 for_each_sg(sg, s, pending, i) {
2397 trb = &dep->trb_pool[dep->trb_dequeue];
2399 if (trb->ctrl & DWC3_TRB_CTRL_HWO)
2400 break;
2402 req->sg = sg_next(s);
2403 req->num_pending_sgs--;
2405 ret = dwc3_gadget_ep_reclaim_completed_trb(dep, req,
2406 trb, event, status, true);
2407 if (ret)
2408 break;
2411 return ret;
2414 static int dwc3_gadget_ep_reclaim_trb_linear(struct dwc3_ep *dep,
2415 struct dwc3_request *req, const struct dwc3_event_depevt *event,
2416 int status)
2418 struct dwc3_trb *trb = &dep->trb_pool[dep->trb_dequeue];
2420 return dwc3_gadget_ep_reclaim_completed_trb(dep, req, trb,
2421 event, status, false);
2424 static bool dwc3_gadget_ep_request_completed(struct dwc3_request *req)
2426 return req->request.actual == req->request.length;
2429 static int dwc3_gadget_ep_cleanup_completed_request(struct dwc3_ep *dep,
2430 const struct dwc3_event_depevt *event,
2431 struct dwc3_request *req, int status)
2433 int ret;
2435 if (req->num_pending_sgs)
2436 ret = dwc3_gadget_ep_reclaim_trb_sg(dep, req, event,
2437 status);
2438 else
2439 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2440 status);
2442 if (req->needs_extra_trb) {
2443 ret = dwc3_gadget_ep_reclaim_trb_linear(dep, req, event,
2444 status);
2445 req->needs_extra_trb = false;
2448 req->request.actual = req->request.length - req->remaining;
2450 if (!dwc3_gadget_ep_request_completed(req) &&
2451 req->num_pending_sgs) {
2452 __dwc3_gadget_kick_transfer(dep);
2453 goto out;
2456 dwc3_gadget_giveback(dep, req, status);
2458 out:
2459 return ret;
2462 static void dwc3_gadget_ep_cleanup_completed_requests(struct dwc3_ep *dep,
2463 const struct dwc3_event_depevt *event, int status)
2465 struct dwc3_request *req;
2466 struct dwc3_request *tmp;
2468 list_for_each_entry_safe(req, tmp, &dep->started_list, list) {
2469 int ret;
2471 ret = dwc3_gadget_ep_cleanup_completed_request(dep, event,
2472 req, status);
2473 if (ret)
2474 break;
2478 static void dwc3_gadget_endpoint_frame_from_event(struct dwc3_ep *dep,
2479 const struct dwc3_event_depevt *event)
2481 dep->frame_number = event->parameters;
2484 static void dwc3_gadget_endpoint_transfer_in_progress(struct dwc3_ep *dep,
2485 const struct dwc3_event_depevt *event)
2487 struct dwc3 *dwc = dep->dwc;
2488 unsigned status = 0;
2489 bool stop = false;
2491 dwc3_gadget_endpoint_frame_from_event(dep, event);
2493 if (event->status & DEPEVT_STATUS_BUSERR)
2494 status = -ECONNRESET;
2496 if (event->status & DEPEVT_STATUS_MISSED_ISOC) {
2497 status = -EXDEV;
2499 if (list_empty(&dep->started_list))
2500 stop = true;
2503 dwc3_gadget_ep_cleanup_completed_requests(dep, event, status);
2505 if (stop) {
2506 dwc3_stop_active_transfer(dep, true, true);
2507 dep->flags = DWC3_EP_ENABLED;
2511 * WORKAROUND: This is the 2nd half of U1/U2 -> U0 workaround.
2512 * See dwc3_gadget_linksts_change_interrupt() for 1st half.
2514 if (dwc->revision < DWC3_REVISION_183A) {
2515 u32 reg;
2516 int i;
2518 for (i = 0; i < DWC3_ENDPOINTS_NUM; i++) {
2519 dep = dwc->eps[i];
2521 if (!(dep->flags & DWC3_EP_ENABLED))
2522 continue;
2524 if (!list_empty(&dep->started_list))
2525 return;
2528 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2529 reg |= dwc->u1u2;
2530 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2532 dwc->u1u2 = 0;
2536 static void dwc3_gadget_endpoint_transfer_not_ready(struct dwc3_ep *dep,
2537 const struct dwc3_event_depevt *event)
2539 dwc3_gadget_endpoint_frame_from_event(dep, event);
2540 (void) __dwc3_gadget_start_isoc(dep);
2543 static void dwc3_endpoint_interrupt(struct dwc3 *dwc,
2544 const struct dwc3_event_depevt *event)
2546 struct dwc3_ep *dep;
2547 u8 epnum = event->endpoint_number;
2548 u8 cmd;
2550 dep = dwc->eps[epnum];
2552 if (!(dep->flags & DWC3_EP_ENABLED)) {
2553 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
2554 return;
2556 /* Handle only EPCMDCMPLT when EP disabled */
2557 if (event->endpoint_event != DWC3_DEPEVT_EPCMDCMPLT)
2558 return;
2561 if (epnum == 0 || epnum == 1) {
2562 dwc3_ep0_interrupt(dwc, event);
2563 return;
2566 switch (event->endpoint_event) {
2567 case DWC3_DEPEVT_XFERINPROGRESS:
2568 dwc3_gadget_endpoint_transfer_in_progress(dep, event);
2569 break;
2570 case DWC3_DEPEVT_XFERNOTREADY:
2571 dwc3_gadget_endpoint_transfer_not_ready(dep, event);
2572 break;
2573 case DWC3_DEPEVT_EPCMDCMPLT:
2574 cmd = DEPEVT_PARAMETER_CMD(event->parameters);
2576 if (cmd == DWC3_DEPCMD_ENDTRANSFER) {
2577 dep->flags &= ~DWC3_EP_TRANSFER_STARTED;
2578 dwc3_gadget_ep_cleanup_cancelled_requests(dep);
2580 break;
2581 case DWC3_DEPEVT_STREAMEVT:
2582 case DWC3_DEPEVT_XFERCOMPLETE:
2583 case DWC3_DEPEVT_RXTXFIFOEVT:
2584 break;
2588 static void dwc3_disconnect_gadget(struct dwc3 *dwc)
2590 if (dwc->gadget_driver && dwc->gadget_driver->disconnect) {
2591 spin_unlock(&dwc->lock);
2592 dwc->gadget_driver->disconnect(&dwc->gadget);
2593 spin_lock(&dwc->lock);
2597 static void dwc3_suspend_gadget(struct dwc3 *dwc)
2599 if (dwc->gadget_driver && dwc->gadget_driver->suspend) {
2600 spin_unlock(&dwc->lock);
2601 dwc->gadget_driver->suspend(&dwc->gadget);
2602 spin_lock(&dwc->lock);
2606 static void dwc3_resume_gadget(struct dwc3 *dwc)
2608 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2609 spin_unlock(&dwc->lock);
2610 dwc->gadget_driver->resume(&dwc->gadget);
2611 spin_lock(&dwc->lock);
2615 static void dwc3_reset_gadget(struct dwc3 *dwc)
2617 if (!dwc->gadget_driver)
2618 return;
2620 if (dwc->gadget.speed != USB_SPEED_UNKNOWN) {
2621 spin_unlock(&dwc->lock);
2622 usb_gadget_udc_reset(&dwc->gadget, dwc->gadget_driver);
2623 spin_lock(&dwc->lock);
2627 static void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force,
2628 bool interrupt)
2630 struct dwc3 *dwc = dep->dwc;
2631 struct dwc3_gadget_ep_cmd_params params;
2632 u32 cmd;
2633 int ret;
2635 if (!(dep->flags & DWC3_EP_TRANSFER_STARTED))
2636 return;
2639 * NOTICE: We are violating what the Databook says about the
2640 * EndTransfer command. Ideally we would _always_ wait for the
2641 * EndTransfer Command Completion IRQ, but that's causing too
2642 * much trouble synchronizing between us and gadget driver.
2644 * We have discussed this with the IP Provider and it was
2645 * suggested to giveback all requests here, but give HW some
2646 * extra time to synchronize with the interconnect. We're using
2647 * an arbitrary 100us delay for that.
2649 * Note also that a similar handling was tested by Synopsys
2650 * (thanks a lot Paul) and nothing bad has come out of it.
2651 * In short, what we're doing is:
2653 * - Issue EndTransfer WITH CMDIOC bit set
2654 * - Wait 100us
2656 * As of IP version 3.10a of the DWC_usb3 IP, the controller
2657 * supports a mode to work around the above limitation. The
2658 * software can poll the CMDACT bit in the DEPCMD register
2659 * after issuing a EndTransfer command. This mode is enabled
2660 * by writing GUCTL2[14]. This polling is already done in the
2661 * dwc3_send_gadget_ep_cmd() function so if the mode is
2662 * enabled, the EndTransfer command will have completed upon
2663 * returning from this function and we don't need to delay for
2664 * 100us.
2666 * This mode is NOT available on the DWC_usb31 IP.
2669 cmd = DWC3_DEPCMD_ENDTRANSFER;
2670 cmd |= force ? DWC3_DEPCMD_HIPRI_FORCERM : 0;
2671 cmd |= interrupt ? DWC3_DEPCMD_CMDIOC : 0;
2672 cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
2673 memset(&params, 0, sizeof(params));
2674 ret = dwc3_send_gadget_ep_cmd(dep, cmd, &params);
2675 WARN_ON_ONCE(ret);
2676 dep->resource_index = 0;
2678 if (dwc3_is_usb31(dwc) || dwc->revision < DWC3_REVISION_310A)
2679 udelay(100);
2682 static void dwc3_clear_stall_all_ep(struct dwc3 *dwc)
2684 u32 epnum;
2686 for (epnum = 1; epnum < DWC3_ENDPOINTS_NUM; epnum++) {
2687 struct dwc3_ep *dep;
2688 int ret;
2690 dep = dwc->eps[epnum];
2691 if (!dep)
2692 continue;
2694 if (!(dep->flags & DWC3_EP_STALL))
2695 continue;
2697 dep->flags &= ~DWC3_EP_STALL;
2699 ret = dwc3_send_clear_stall_ep_cmd(dep);
2700 WARN_ON_ONCE(ret);
2704 static void dwc3_gadget_disconnect_interrupt(struct dwc3 *dwc)
2706 int reg;
2708 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2709 reg &= ~DWC3_DCTL_INITU1ENA;
2710 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2712 reg &= ~DWC3_DCTL_INITU2ENA;
2713 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2715 dwc3_disconnect_gadget(dwc);
2717 dwc->gadget.speed = USB_SPEED_UNKNOWN;
2718 dwc->setup_packet_pending = false;
2719 usb_gadget_set_state(&dwc->gadget, USB_STATE_NOTATTACHED);
2721 dwc->connected = false;
2724 static void dwc3_gadget_reset_interrupt(struct dwc3 *dwc)
2726 u32 reg;
2728 dwc->connected = true;
2731 * WORKAROUND: DWC3 revisions <1.88a have an issue which
2732 * would cause a missing Disconnect Event if there's a
2733 * pending Setup Packet in the FIFO.
2735 * There's no suggested workaround on the official Bug
2736 * report, which states that "unless the driver/application
2737 * is doing any special handling of a disconnect event,
2738 * there is no functional issue".
2740 * Unfortunately, it turns out that we _do_ some special
2741 * handling of a disconnect event, namely complete all
2742 * pending transfers, notify gadget driver of the
2743 * disconnection, and so on.
2745 * Our suggested workaround is to follow the Disconnect
2746 * Event steps here, instead, based on a setup_packet_pending
2747 * flag. Such flag gets set whenever we have a SETUP_PENDING
2748 * status for EP0 TRBs and gets cleared on XferComplete for the
2749 * same endpoint.
2751 * Refers to:
2753 * STAR#9000466709: RTL: Device : Disconnect event not
2754 * generated if setup packet pending in FIFO
2756 if (dwc->revision < DWC3_REVISION_188A) {
2757 if (dwc->setup_packet_pending)
2758 dwc3_gadget_disconnect_interrupt(dwc);
2761 dwc3_reset_gadget(dwc);
2763 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2764 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
2765 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2766 dwc->test_mode = false;
2767 dwc3_clear_stall_all_ep(dwc);
2769 /* Reset device address to zero */
2770 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2771 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
2772 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2775 static void dwc3_gadget_conndone_interrupt(struct dwc3 *dwc)
2777 struct dwc3_ep *dep;
2778 int ret;
2779 u32 reg;
2780 u8 speed;
2782 reg = dwc3_readl(dwc->regs, DWC3_DSTS);
2783 speed = reg & DWC3_DSTS_CONNECTSPD;
2784 dwc->speed = speed;
2787 * RAMClkSel is reset to 0 after USB reset, so it must be reprogrammed
2788 * each time on Connect Done.
2790 * Currently we always use the reset value. If any platform
2791 * wants to set this to a different value, we need to add a
2792 * setting and update GCTL.RAMCLKSEL here.
2795 switch (speed) {
2796 case DWC3_DSTS_SUPERSPEED_PLUS:
2797 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2798 dwc->gadget.ep0->maxpacket = 512;
2799 dwc->gadget.speed = USB_SPEED_SUPER_PLUS;
2800 break;
2801 case DWC3_DSTS_SUPERSPEED:
2803 * WORKAROUND: DWC3 revisions <1.90a have an issue which
2804 * would cause a missing USB3 Reset event.
2806 * In such situations, we should force a USB3 Reset
2807 * event by calling our dwc3_gadget_reset_interrupt()
2808 * routine.
2810 * Refers to:
2812 * STAR#9000483510: RTL: SS : USB3 reset event may
2813 * not be generated always when the link enters poll
2815 if (dwc->revision < DWC3_REVISION_190A)
2816 dwc3_gadget_reset_interrupt(dwc);
2818 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(512);
2819 dwc->gadget.ep0->maxpacket = 512;
2820 dwc->gadget.speed = USB_SPEED_SUPER;
2821 break;
2822 case DWC3_DSTS_HIGHSPEED:
2823 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2824 dwc->gadget.ep0->maxpacket = 64;
2825 dwc->gadget.speed = USB_SPEED_HIGH;
2826 break;
2827 case DWC3_DSTS_FULLSPEED:
2828 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
2829 dwc->gadget.ep0->maxpacket = 64;
2830 dwc->gadget.speed = USB_SPEED_FULL;
2831 break;
2832 case DWC3_DSTS_LOWSPEED:
2833 dwc3_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
2834 dwc->gadget.ep0->maxpacket = 8;
2835 dwc->gadget.speed = USB_SPEED_LOW;
2836 break;
2839 dwc->eps[1]->endpoint.maxpacket = dwc->gadget.ep0->maxpacket;
2841 /* Enable USB2 LPM Capability */
2843 if ((dwc->revision > DWC3_REVISION_194A) &&
2844 (speed != DWC3_DSTS_SUPERSPEED) &&
2845 (speed != DWC3_DSTS_SUPERSPEED_PLUS)) {
2846 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
2847 reg |= DWC3_DCFG_LPM_CAP;
2848 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
2850 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2851 reg &= ~(DWC3_DCTL_HIRD_THRES_MASK | DWC3_DCTL_L1_HIBER_EN);
2853 reg |= DWC3_DCTL_HIRD_THRES(dwc->hird_threshold);
2856 * When dwc3 revisions >= 2.40a, LPM Erratum is enabled and
2857 * DCFG.LPMCap is set, core responses with an ACK and the
2858 * BESL value in the LPM token is less than or equal to LPM
2859 * NYET threshold.
2861 WARN_ONCE(dwc->revision < DWC3_REVISION_240A
2862 && dwc->has_lpm_erratum,
2863 "LPM Erratum not available on dwc3 revisions < 2.40a\n");
2865 if (dwc->has_lpm_erratum && dwc->revision >= DWC3_REVISION_240A)
2866 reg |= DWC3_DCTL_LPM_ERRATA(dwc->lpm_nyet_threshold);
2868 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2869 } else {
2870 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2871 reg &= ~DWC3_DCTL_HIRD_THRES_MASK;
2872 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2875 dep = dwc->eps[0];
2876 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
2877 if (ret) {
2878 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2879 return;
2882 dep = dwc->eps[1];
2883 ret = __dwc3_gadget_ep_enable(dep, DWC3_DEPCFG_ACTION_MODIFY);
2884 if (ret) {
2885 dev_err(dwc->dev, "failed to enable %s\n", dep->name);
2886 return;
2890 * Configure PHY via GUSB3PIPECTLn if required.
2892 * Update GTXFIFOSIZn
2894 * In both cases reset values should be sufficient.
2898 static void dwc3_gadget_wakeup_interrupt(struct dwc3 *dwc)
2901 * TODO take core out of low power mode when that's
2902 * implemented.
2905 if (dwc->gadget_driver && dwc->gadget_driver->resume) {
2906 spin_unlock(&dwc->lock);
2907 dwc->gadget_driver->resume(&dwc->gadget);
2908 spin_lock(&dwc->lock);
2912 static void dwc3_gadget_linksts_change_interrupt(struct dwc3 *dwc,
2913 unsigned int evtinfo)
2915 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
2916 unsigned int pwropt;
2919 * WORKAROUND: DWC3 < 2.50a have an issue when configured without
2920 * Hibernation mode enabled which would show up when device detects
2921 * host-initiated U3 exit.
2923 * In that case, device will generate a Link State Change Interrupt
2924 * from U3 to RESUME which is only necessary if Hibernation is
2925 * configured in.
2927 * There are no functional changes due to such spurious event and we
2928 * just need to ignore it.
2930 * Refers to:
2932 * STAR#9000570034 RTL: SS Resume event generated in non-Hibernation
2933 * operational mode
2935 pwropt = DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1);
2936 if ((dwc->revision < DWC3_REVISION_250A) &&
2937 (pwropt != DWC3_GHWPARAMS1_EN_PWROPT_HIB)) {
2938 if ((dwc->link_state == DWC3_LINK_STATE_U3) &&
2939 (next == DWC3_LINK_STATE_RESUME)) {
2940 return;
2945 * WORKAROUND: DWC3 Revisions <1.83a have an issue which, depending
2946 * on the link partner, the USB session might do multiple entry/exit
2947 * of low power states before a transfer takes place.
2949 * Due to this problem, we might experience lower throughput. The
2950 * suggested workaround is to disable DCTL[12:9] bits if we're
2951 * transitioning from U1/U2 to U0 and enable those bits again
2952 * after a transfer completes and there are no pending transfers
2953 * on any of the enabled endpoints.
2955 * This is the first half of that workaround.
2957 * Refers to:
2959 * STAR#9000446952: RTL: Device SS : if U1/U2 ->U0 takes >128us
2960 * core send LGO_Ux entering U0
2962 if (dwc->revision < DWC3_REVISION_183A) {
2963 if (next == DWC3_LINK_STATE_U0) {
2964 u32 u1u2;
2965 u32 reg;
2967 switch (dwc->link_state) {
2968 case DWC3_LINK_STATE_U1:
2969 case DWC3_LINK_STATE_U2:
2970 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
2971 u1u2 = reg & (DWC3_DCTL_INITU2ENA
2972 | DWC3_DCTL_ACCEPTU2ENA
2973 | DWC3_DCTL_INITU1ENA
2974 | DWC3_DCTL_ACCEPTU1ENA);
2976 if (!dwc->u1u2)
2977 dwc->u1u2 = reg & u1u2;
2979 reg &= ~u1u2;
2981 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
2982 break;
2983 default:
2984 /* do nothing */
2985 break;
2990 switch (next) {
2991 case DWC3_LINK_STATE_U1:
2992 if (dwc->speed == USB_SPEED_SUPER)
2993 dwc3_suspend_gadget(dwc);
2994 break;
2995 case DWC3_LINK_STATE_U2:
2996 case DWC3_LINK_STATE_U3:
2997 dwc3_suspend_gadget(dwc);
2998 break;
2999 case DWC3_LINK_STATE_RESUME:
3000 dwc3_resume_gadget(dwc);
3001 break;
3002 default:
3003 /* do nothing */
3004 break;
3007 dwc->link_state = next;
3010 static void dwc3_gadget_suspend_interrupt(struct dwc3 *dwc,
3011 unsigned int evtinfo)
3013 enum dwc3_link_state next = evtinfo & DWC3_LINK_STATE_MASK;
3015 if (dwc->link_state != next && next == DWC3_LINK_STATE_U3)
3016 dwc3_suspend_gadget(dwc);
3018 dwc->link_state = next;
3021 static void dwc3_gadget_hibernation_interrupt(struct dwc3 *dwc,
3022 unsigned int evtinfo)
3024 unsigned int is_ss = evtinfo & BIT(4);
3027 * WORKAROUND: DWC3 revison 2.20a with hibernation support
3028 * have a known issue which can cause USB CV TD.9.23 to fail
3029 * randomly.
3031 * Because of this issue, core could generate bogus hibernation
3032 * events which SW needs to ignore.
3034 * Refers to:
3036 * STAR#9000546576: Device Mode Hibernation: Issue in USB 2.0
3037 * Device Fallback from SuperSpeed
3039 if (is_ss ^ (dwc->speed == USB_SPEED_SUPER))
3040 return;
3042 /* enter hibernation here */
3045 static void dwc3_gadget_interrupt(struct dwc3 *dwc,
3046 const struct dwc3_event_devt *event)
3048 switch (event->type) {
3049 case DWC3_DEVICE_EVENT_DISCONNECT:
3050 dwc3_gadget_disconnect_interrupt(dwc);
3051 break;
3052 case DWC3_DEVICE_EVENT_RESET:
3053 dwc3_gadget_reset_interrupt(dwc);
3054 break;
3055 case DWC3_DEVICE_EVENT_CONNECT_DONE:
3056 dwc3_gadget_conndone_interrupt(dwc);
3057 break;
3058 case DWC3_DEVICE_EVENT_WAKEUP:
3059 dwc3_gadget_wakeup_interrupt(dwc);
3060 break;
3061 case DWC3_DEVICE_EVENT_HIBER_REQ:
3062 if (dev_WARN_ONCE(dwc->dev, !dwc->has_hibernation,
3063 "unexpected hibernation event\n"))
3064 break;
3066 dwc3_gadget_hibernation_interrupt(dwc, event->event_info);
3067 break;
3068 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
3069 dwc3_gadget_linksts_change_interrupt(dwc, event->event_info);
3070 break;
3071 case DWC3_DEVICE_EVENT_EOPF:
3072 /* It changed to be suspend event for version 2.30a and above */
3073 if (dwc->revision >= DWC3_REVISION_230A) {
3075 * Ignore suspend event until the gadget enters into
3076 * USB_STATE_CONFIGURED state.
3078 if (dwc->gadget.state >= USB_STATE_CONFIGURED)
3079 dwc3_gadget_suspend_interrupt(dwc,
3080 event->event_info);
3082 break;
3083 case DWC3_DEVICE_EVENT_SOF:
3084 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
3085 case DWC3_DEVICE_EVENT_CMD_CMPL:
3086 case DWC3_DEVICE_EVENT_OVERFLOW:
3087 break;
3088 default:
3089 dev_WARN(dwc->dev, "UNKNOWN IRQ %d\n", event->type);
3093 static void dwc3_process_event_entry(struct dwc3 *dwc,
3094 const union dwc3_event *event)
3096 trace_dwc3_event(event->raw, dwc);
3098 if (!event->type.is_devspec)
3099 dwc3_endpoint_interrupt(dwc, &event->depevt);
3100 else if (event->type.type == DWC3_EVENT_TYPE_DEV)
3101 dwc3_gadget_interrupt(dwc, &event->devt);
3102 else
3103 dev_err(dwc->dev, "UNKNOWN IRQ type %d\n", event->raw);
3106 static irqreturn_t dwc3_process_event_buf(struct dwc3_event_buffer *evt)
3108 struct dwc3 *dwc = evt->dwc;
3109 irqreturn_t ret = IRQ_NONE;
3110 int left;
3111 u32 reg;
3113 left = evt->count;
3115 if (!(evt->flags & DWC3_EVENT_PENDING))
3116 return IRQ_NONE;
3118 while (left > 0) {
3119 union dwc3_event event;
3121 event.raw = *(u32 *) (evt->cache + evt->lpos);
3123 dwc3_process_event_entry(dwc, &event);
3126 * FIXME we wrap around correctly to the next entry as
3127 * almost all entries are 4 bytes in size. There is one
3128 * entry which has 12 bytes which is a regular entry
3129 * followed by 8 bytes data. ATM I don't know how
3130 * things are organized if we get next to the a
3131 * boundary so I worry about that once we try to handle
3132 * that.
3134 evt->lpos = (evt->lpos + 4) % evt->length;
3135 left -= 4;
3138 evt->count = 0;
3139 evt->flags &= ~DWC3_EVENT_PENDING;
3140 ret = IRQ_HANDLED;
3142 /* Unmask interrupt */
3143 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3144 reg &= ~DWC3_GEVNTSIZ_INTMASK;
3145 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3147 if (dwc->imod_interval) {
3148 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), DWC3_GEVNTCOUNT_EHB);
3149 dwc3_writel(dwc->regs, DWC3_DEV_IMOD(0), dwc->imod_interval);
3152 return ret;
3155 static irqreturn_t dwc3_thread_interrupt(int irq, void *_evt)
3157 struct dwc3_event_buffer *evt = _evt;
3158 struct dwc3 *dwc = evt->dwc;
3159 unsigned long flags;
3160 irqreturn_t ret = IRQ_NONE;
3162 spin_lock_irqsave(&dwc->lock, flags);
3163 ret = dwc3_process_event_buf(evt);
3164 spin_unlock_irqrestore(&dwc->lock, flags);
3166 return ret;
3169 static irqreturn_t dwc3_check_event_buf(struct dwc3_event_buffer *evt)
3171 struct dwc3 *dwc = evt->dwc;
3172 u32 amount;
3173 u32 count;
3174 u32 reg;
3176 if (pm_runtime_suspended(dwc->dev)) {
3177 pm_runtime_get(dwc->dev);
3178 disable_irq_nosync(dwc->irq_gadget);
3179 dwc->pending_events = true;
3180 return IRQ_HANDLED;
3184 * With PCIe legacy interrupt, test shows that top-half irq handler can
3185 * be called again after HW interrupt deassertion. Check if bottom-half
3186 * irq event handler completes before caching new event to prevent
3187 * losing events.
3189 if (evt->flags & DWC3_EVENT_PENDING)
3190 return IRQ_HANDLED;
3192 count = dwc3_readl(dwc->regs, DWC3_GEVNTCOUNT(0));
3193 count &= DWC3_GEVNTCOUNT_MASK;
3194 if (!count)
3195 return IRQ_NONE;
3197 evt->count = count;
3198 evt->flags |= DWC3_EVENT_PENDING;
3200 /* Mask interrupt */
3201 reg = dwc3_readl(dwc->regs, DWC3_GEVNTSIZ(0));
3202 reg |= DWC3_GEVNTSIZ_INTMASK;
3203 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), reg);
3205 amount = min(count, evt->length - evt->lpos);
3206 memcpy(evt->cache + evt->lpos, evt->buf + evt->lpos, amount);
3208 if (amount < count)
3209 memcpy(evt->cache, evt->buf, count - amount);
3211 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), count);
3213 return IRQ_WAKE_THREAD;
3216 static irqreturn_t dwc3_interrupt(int irq, void *_evt)
3218 struct dwc3_event_buffer *evt = _evt;
3220 return dwc3_check_event_buf(evt);
3223 static int dwc3_gadget_get_irq(struct dwc3 *dwc)
3225 struct platform_device *dwc3_pdev = to_platform_device(dwc->dev);
3226 int irq;
3228 irq = platform_get_irq_byname(dwc3_pdev, "peripheral");
3229 if (irq > 0)
3230 goto out;
3232 if (irq == -EPROBE_DEFER)
3233 goto out;
3235 irq = platform_get_irq_byname(dwc3_pdev, "dwc_usb3");
3236 if (irq > 0)
3237 goto out;
3239 if (irq == -EPROBE_DEFER)
3240 goto out;
3242 irq = platform_get_irq(dwc3_pdev, 0);
3243 if (irq > 0)
3244 goto out;
3246 if (irq != -EPROBE_DEFER)
3247 dev_err(dwc->dev, "missing peripheral IRQ\n");
3249 if (!irq)
3250 irq = -EINVAL;
3252 out:
3253 return irq;
3257 * dwc3_gadget_init - initializes gadget related registers
3258 * @dwc: pointer to our controller context structure
3260 * Returns 0 on success otherwise negative errno.
3262 int dwc3_gadget_init(struct dwc3 *dwc)
3264 int ret;
3265 int irq;
3267 irq = dwc3_gadget_get_irq(dwc);
3268 if (irq < 0) {
3269 ret = irq;
3270 goto err0;
3273 dwc->irq_gadget = irq;
3275 dwc->ep0_trb = dma_alloc_coherent(dwc->sysdev,
3276 sizeof(*dwc->ep0_trb) * 2,
3277 &dwc->ep0_trb_addr, GFP_KERNEL);
3278 if (!dwc->ep0_trb) {
3279 dev_err(dwc->dev, "failed to allocate ep0 trb\n");
3280 ret = -ENOMEM;
3281 goto err0;
3284 dwc->setup_buf = kzalloc(DWC3_EP0_SETUP_SIZE, GFP_KERNEL);
3285 if (!dwc->setup_buf) {
3286 ret = -ENOMEM;
3287 goto err1;
3290 dwc->bounce = dma_alloc_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE,
3291 &dwc->bounce_addr, GFP_KERNEL);
3292 if (!dwc->bounce) {
3293 ret = -ENOMEM;
3294 goto err2;
3297 init_completion(&dwc->ep0_in_setup);
3299 dwc->gadget.ops = &dwc3_gadget_ops;
3300 dwc->gadget.speed = USB_SPEED_UNKNOWN;
3301 dwc->gadget.sg_supported = true;
3302 dwc->gadget.name = "dwc3-gadget";
3303 dwc->gadget.is_otg = dwc->dr_mode == USB_DR_MODE_OTG;
3306 * FIXME We might be setting max_speed to <SUPER, however versions
3307 * <2.20a of dwc3 have an issue with metastability (documented
3308 * elsewhere in this driver) which tells us we can't set max speed to
3309 * anything lower than SUPER.
3311 * Because gadget.max_speed is only used by composite.c and function
3312 * drivers (i.e. it won't go into dwc3's registers) we are allowing this
3313 * to happen so we avoid sending SuperSpeed Capability descriptor
3314 * together with our BOS descriptor as that could confuse host into
3315 * thinking we can handle super speed.
3317 * Note that, in fact, we won't even support GetBOS requests when speed
3318 * is less than super speed because we don't have means, yet, to tell
3319 * composite.c that we are USB 2.0 + LPM ECN.
3321 if (dwc->revision < DWC3_REVISION_220A &&
3322 !dwc->dis_metastability_quirk)
3323 dev_info(dwc->dev, "changing max_speed on rev %08x\n",
3324 dwc->revision);
3326 dwc->gadget.max_speed = dwc->maximum_speed;
3329 * REVISIT: Here we should clear all pending IRQs to be
3330 * sure we're starting from a well known location.
3333 ret = dwc3_gadget_init_endpoints(dwc, dwc->num_eps);
3334 if (ret)
3335 goto err3;
3337 ret = usb_add_gadget_udc(dwc->dev, &dwc->gadget);
3338 if (ret) {
3339 dev_err(dwc->dev, "failed to register udc\n");
3340 goto err4;
3343 dwc3_gadget_set_speed(&dwc->gadget, dwc->maximum_speed);
3345 return 0;
3347 err4:
3348 dwc3_gadget_free_endpoints(dwc);
3350 err3:
3351 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3352 dwc->bounce_addr);
3354 err2:
3355 kfree(dwc->setup_buf);
3357 err1:
3358 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3359 dwc->ep0_trb, dwc->ep0_trb_addr);
3361 err0:
3362 return ret;
3365 /* -------------------------------------------------------------------------- */
3367 void dwc3_gadget_exit(struct dwc3 *dwc)
3369 usb_del_gadget_udc(&dwc->gadget);
3370 dwc3_gadget_free_endpoints(dwc);
3371 dma_free_coherent(dwc->sysdev, DWC3_BOUNCE_SIZE, dwc->bounce,
3372 dwc->bounce_addr);
3373 kfree(dwc->setup_buf);
3374 dma_free_coherent(dwc->sysdev, sizeof(*dwc->ep0_trb) * 2,
3375 dwc->ep0_trb, dwc->ep0_trb_addr);
3378 int dwc3_gadget_suspend(struct dwc3 *dwc)
3380 if (!dwc->gadget_driver)
3381 return 0;
3383 dwc3_gadget_run_stop(dwc, false, false);
3384 dwc3_disconnect_gadget(dwc);
3385 __dwc3_gadget_stop(dwc);
3387 synchronize_irq(dwc->irq_gadget);
3389 return 0;
3392 int dwc3_gadget_resume(struct dwc3 *dwc)
3394 int ret;
3396 if (!dwc->gadget_driver)
3397 return 0;
3399 ret = __dwc3_gadget_start(dwc);
3400 if (ret < 0)
3401 goto err0;
3403 ret = dwc3_gadget_run_stop(dwc, true, false);
3404 if (ret < 0)
3405 goto err1;
3407 return 0;
3409 err1:
3410 __dwc3_gadget_stop(dwc);
3412 err0:
3413 return ret;
3416 void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
3418 if (dwc->pending_events) {
3419 dwc3_interrupt(dwc->irq_gadget, dwc->ev_buf);
3420 dwc->pending_events = false;
3421 enable_irq(dwc->irq_gadget);