2 * core.c - DesignWare USB3 DRD Controller Core file
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.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <linux/version.h>
23 #include <linux/module.h>
24 #include <linux/kernel.h>
25 #include <linux/slab.h>
26 #include <linux/spinlock.h>
27 #include <linux/platform_device.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/interrupt.h>
30 #include <linux/ioport.h>
32 #include <linux/list.h>
33 #include <linux/delay.h>
34 #include <linux/dma-mapping.h>
36 #include <linux/acpi.h>
37 #include <linux/pinctrl/consumer.h>
39 #include <linux/usb/ch9.h>
40 #include <linux/usb/gadget.h>
41 #include <linux/usb/of.h>
42 #include <linux/usb/otg.h>
50 #define DWC3_DEFAULT_AUTOSUSPEND_DELAY 5000 /* ms */
53 * dwc3_get_dr_mode - Validates and sets dr_mode
54 * @dwc: pointer to our context structure
56 static int dwc3_get_dr_mode(struct dwc3 *dwc)
58 enum usb_dr_mode mode;
59 struct device *dev = dwc->dev;
62 if (dwc->dr_mode == USB_DR_MODE_UNKNOWN)
63 dwc->dr_mode = USB_DR_MODE_OTG;
66 hw_mode = DWC3_GHWPARAMS0_MODE(dwc->hwparams.hwparams0);
69 case DWC3_GHWPARAMS0_MODE_GADGET:
70 if (IS_ENABLED(CONFIG_USB_DWC3_HOST)) {
72 "Controller does not support host mode.\n");
75 mode = USB_DR_MODE_PERIPHERAL;
77 case DWC3_GHWPARAMS0_MODE_HOST:
78 if (IS_ENABLED(CONFIG_USB_DWC3_GADGET)) {
80 "Controller does not support device mode.\n");
83 mode = USB_DR_MODE_HOST;
86 if (IS_ENABLED(CONFIG_USB_DWC3_HOST))
87 mode = USB_DR_MODE_HOST;
88 else if (IS_ENABLED(CONFIG_USB_DWC3_GADGET))
89 mode = USB_DR_MODE_PERIPHERAL;
92 if (mode != dwc->dr_mode) {
94 "Configuration mismatch. dr_mode forced to %s\n",
95 mode == USB_DR_MODE_HOST ? "host" : "gadget");
103 static void dwc3_event_buffers_cleanup(struct dwc3 *dwc);
104 static int dwc3_event_buffers_setup(struct dwc3 *dwc);
106 static void dwc3_set_prtcap(struct dwc3 *dwc, u32 mode)
110 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
111 reg &= ~(DWC3_GCTL_PRTCAPDIR(DWC3_GCTL_PRTCAP_OTG));
112 reg |= DWC3_GCTL_PRTCAPDIR(mode);
113 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
116 static void __dwc3_set_mode(struct work_struct *work)
118 struct dwc3 *dwc = work_to_dwc(work);
122 if (!dwc->desired_dr_role)
125 if (dwc->desired_dr_role == dwc->current_dr_role)
128 if (dwc->dr_mode != USB_DR_MODE_OTG)
131 switch (dwc->current_dr_role) {
132 case DWC3_GCTL_PRTCAP_HOST:
135 case DWC3_GCTL_PRTCAP_DEVICE:
136 dwc3_gadget_exit(dwc);
137 dwc3_event_buffers_cleanup(dwc);
143 spin_lock_irqsave(&dwc->lock, flags);
145 dwc3_set_prtcap(dwc, dwc->desired_dr_role);
147 dwc->current_dr_role = dwc->desired_dr_role;
149 spin_unlock_irqrestore(&dwc->lock, flags);
151 switch (dwc->desired_dr_role) {
152 case DWC3_GCTL_PRTCAP_HOST:
153 ret = dwc3_host_init(dwc);
155 dev_err(dwc->dev, "failed to initialize host\n");
158 otg_set_vbus(dwc->usb2_phy->otg, true);
159 if (dwc->usb2_generic_phy)
160 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_HOST);
164 case DWC3_GCTL_PRTCAP_DEVICE:
165 dwc3_event_buffers_setup(dwc);
168 otg_set_vbus(dwc->usb2_phy->otg, false);
169 if (dwc->usb2_generic_phy)
170 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_DEVICE);
172 ret = dwc3_gadget_init(dwc);
174 dev_err(dwc->dev, "failed to initialize peripheral\n");
181 void dwc3_set_mode(struct dwc3 *dwc, u32 mode)
185 spin_lock_irqsave(&dwc->lock, flags);
186 dwc->desired_dr_role = mode;
187 spin_unlock_irqrestore(&dwc->lock, flags);
189 queue_work(system_power_efficient_wq, &dwc->drd_work);
192 u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type)
194 struct dwc3 *dwc = dep->dwc;
197 dwc3_writel(dwc->regs, DWC3_GDBGFIFOSPACE,
198 DWC3_GDBGFIFOSPACE_NUM(dep->number) |
199 DWC3_GDBGFIFOSPACE_TYPE(type));
201 reg = dwc3_readl(dwc->regs, DWC3_GDBGFIFOSPACE);
203 return DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(reg);
207 * dwc3_core_soft_reset - Issues core soft reset and PHY reset
208 * @dwc: pointer to our context structure
210 static int dwc3_core_soft_reset(struct dwc3 *dwc)
216 usb_phy_init(dwc->usb2_phy);
217 usb_phy_init(dwc->usb3_phy);
218 ret = phy_init(dwc->usb2_generic_phy);
222 ret = phy_init(dwc->usb3_generic_phy);
224 phy_exit(dwc->usb2_generic_phy);
229 * We're resetting only the device side because, if we're in host mode,
230 * XHCI driver will reset the host block. If dwc3 was configured for
231 * host-only mode, then we can return early.
233 if (dwc->dr_mode == USB_DR_MODE_HOST)
236 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
237 reg |= DWC3_DCTL_CSFTRST;
238 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
241 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
242 if (!(reg & DWC3_DCTL_CSFTRST))
252 * dwc3_frame_length_adjustment - Adjusts frame length if required
253 * @dwc3: Pointer to our controller context structure
255 static void dwc3_frame_length_adjustment(struct dwc3 *dwc)
260 if (dwc->revision < DWC3_REVISION_250A)
266 reg = dwc3_readl(dwc->regs, DWC3_GFLADJ);
267 dft = reg & DWC3_GFLADJ_30MHZ_MASK;
268 if (!dev_WARN_ONCE(dwc->dev, dft == dwc->fladj,
269 "request value same as default, ignoring\n")) {
270 reg &= ~DWC3_GFLADJ_30MHZ_MASK;
271 reg |= DWC3_GFLADJ_30MHZ_SDBND_SEL | dwc->fladj;
272 dwc3_writel(dwc->regs, DWC3_GFLADJ, reg);
277 * dwc3_free_one_event_buffer - Frees one event buffer
278 * @dwc: Pointer to our controller context structure
279 * @evt: Pointer to event buffer to be freed
281 static void dwc3_free_one_event_buffer(struct dwc3 *dwc,
282 struct dwc3_event_buffer *evt)
284 dma_free_coherent(dwc->sysdev, evt->length, evt->buf, evt->dma);
288 * dwc3_alloc_one_event_buffer - Allocates one event buffer structure
289 * @dwc: Pointer to our controller context structure
290 * @length: size of the event buffer
292 * Returns a pointer to the allocated event buffer structure on success
293 * otherwise ERR_PTR(errno).
295 static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
298 struct dwc3_event_buffer *evt;
300 evt = devm_kzalloc(dwc->dev, sizeof(*evt), GFP_KERNEL);
302 return ERR_PTR(-ENOMEM);
305 evt->length = length;
306 evt->cache = devm_kzalloc(dwc->dev, length, GFP_KERNEL);
308 return ERR_PTR(-ENOMEM);
310 evt->buf = dma_alloc_coherent(dwc->sysdev, length,
311 &evt->dma, GFP_KERNEL);
313 return ERR_PTR(-ENOMEM);
319 * dwc3_free_event_buffers - frees all allocated event buffers
320 * @dwc: Pointer to our controller context structure
322 static void dwc3_free_event_buffers(struct dwc3 *dwc)
324 struct dwc3_event_buffer *evt;
328 dwc3_free_one_event_buffer(dwc, evt);
332 * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
333 * @dwc: pointer to our controller context structure
334 * @length: size of event buffer
336 * Returns 0 on success otherwise negative errno. In the error case, dwc
337 * may contain some buffers allocated but not all which were requested.
339 static int dwc3_alloc_event_buffers(struct dwc3 *dwc, unsigned length)
341 struct dwc3_event_buffer *evt;
343 evt = dwc3_alloc_one_event_buffer(dwc, length);
345 dev_err(dwc->dev, "can't allocate event buffer\n");
354 * dwc3_event_buffers_setup - setup our allocated event buffers
355 * @dwc: pointer to our controller context structure
357 * Returns 0 on success otherwise negative errno.
359 static int dwc3_event_buffers_setup(struct dwc3 *dwc)
361 struct dwc3_event_buffer *evt;
365 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0),
366 lower_32_bits(evt->dma));
367 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0),
368 upper_32_bits(evt->dma));
369 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0),
370 DWC3_GEVNTSIZ_SIZE(evt->length));
371 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
376 static void dwc3_event_buffers_cleanup(struct dwc3 *dwc)
378 struct dwc3_event_buffer *evt;
384 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0), 0);
385 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0), 0);
386 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), DWC3_GEVNTSIZ_INTMASK
387 | DWC3_GEVNTSIZ_SIZE(0));
388 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
391 static int dwc3_alloc_scratch_buffers(struct dwc3 *dwc)
393 if (!dwc->has_hibernation)
396 if (!dwc->nr_scratch)
399 dwc->scratchbuf = kmalloc_array(dwc->nr_scratch,
400 DWC3_SCRATCHBUF_SIZE, GFP_KERNEL);
401 if (!dwc->scratchbuf)
407 static int dwc3_setup_scratch_buffers(struct dwc3 *dwc)
409 dma_addr_t scratch_addr;
413 if (!dwc->has_hibernation)
416 if (!dwc->nr_scratch)
419 /* should never fall here */
420 if (!WARN_ON(dwc->scratchbuf))
423 scratch_addr = dma_map_single(dwc->sysdev, dwc->scratchbuf,
424 dwc->nr_scratch * DWC3_SCRATCHBUF_SIZE,
426 if (dma_mapping_error(dwc->sysdev, scratch_addr)) {
427 dev_err(dwc->sysdev, "failed to map scratch buffer\n");
432 dwc->scratch_addr = scratch_addr;
434 param = lower_32_bits(scratch_addr);
436 ret = dwc3_send_gadget_generic_command(dwc,
437 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO, param);
441 param = upper_32_bits(scratch_addr);
443 ret = dwc3_send_gadget_generic_command(dwc,
444 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI, param);
451 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
452 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
458 static void dwc3_free_scratch_buffers(struct dwc3 *dwc)
460 if (!dwc->has_hibernation)
463 if (!dwc->nr_scratch)
466 /* should never fall here */
467 if (!WARN_ON(dwc->scratchbuf))
470 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
471 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
472 kfree(dwc->scratchbuf);
475 static void dwc3_core_num_eps(struct dwc3 *dwc)
477 struct dwc3_hwparams *parms = &dwc->hwparams;
479 dwc->num_eps = DWC3_NUM_EPS(parms);
482 static void dwc3_cache_hwparams(struct dwc3 *dwc)
484 struct dwc3_hwparams *parms = &dwc->hwparams;
486 parms->hwparams0 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS0);
487 parms->hwparams1 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS1);
488 parms->hwparams2 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS2);
489 parms->hwparams3 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS3);
490 parms->hwparams4 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS4);
491 parms->hwparams5 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS5);
492 parms->hwparams6 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS6);
493 parms->hwparams7 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS7);
494 parms->hwparams8 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS8);
498 * dwc3_phy_setup - Configure USB PHY Interface of DWC3 Core
499 * @dwc: Pointer to our controller context structure
501 * Returns 0 on success. The USB PHY interfaces are configured but not
502 * initialized. The PHY interfaces and the PHYs get initialized together with
503 * the core in dwc3_core_init.
505 static int dwc3_phy_setup(struct dwc3 *dwc)
510 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
513 * Make sure UX_EXIT_PX is cleared as that causes issues with some
514 * PHYs. Also, this bit is not supposed to be used in normal operation.
516 reg &= ~DWC3_GUSB3PIPECTL_UX_EXIT_PX;
519 * Above 1.94a, it is recommended to set DWC3_GUSB3PIPECTL_SUSPHY
520 * to '0' during coreConsultant configuration. So default value
521 * will be '0' when the core is reset. Application needs to set it
522 * to '1' after the core initialization is completed.
524 if (dwc->revision > DWC3_REVISION_194A)
525 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
527 if (dwc->u2ss_inp3_quirk)
528 reg |= DWC3_GUSB3PIPECTL_U2SSINP3OK;
530 if (dwc->dis_rxdet_inp3_quirk)
531 reg |= DWC3_GUSB3PIPECTL_DISRXDETINP3;
533 if (dwc->req_p1p2p3_quirk)
534 reg |= DWC3_GUSB3PIPECTL_REQP1P2P3;
536 if (dwc->del_p1p2p3_quirk)
537 reg |= DWC3_GUSB3PIPECTL_DEP1P2P3_EN;
539 if (dwc->del_phy_power_chg_quirk)
540 reg |= DWC3_GUSB3PIPECTL_DEPOCHANGE;
542 if (dwc->lfps_filter_quirk)
543 reg |= DWC3_GUSB3PIPECTL_LFPSFILT;
545 if (dwc->rx_detect_poll_quirk)
546 reg |= DWC3_GUSB3PIPECTL_RX_DETOPOLL;
548 if (dwc->tx_de_emphasis_quirk)
549 reg |= DWC3_GUSB3PIPECTL_TX_DEEPH(dwc->tx_de_emphasis);
551 if (dwc->dis_u3_susphy_quirk)
552 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
554 if (dwc->dis_del_phy_power_chg_quirk)
555 reg &= ~DWC3_GUSB3PIPECTL_DEPOCHANGE;
557 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
559 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
561 /* Select the HS PHY interface */
562 switch (DWC3_GHWPARAMS3_HSPHY_IFC(dwc->hwparams.hwparams3)) {
563 case DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI:
564 if (dwc->hsphy_interface &&
565 !strncmp(dwc->hsphy_interface, "utmi", 4)) {
566 reg &= ~DWC3_GUSB2PHYCFG_ULPI_UTMI;
568 } else if (dwc->hsphy_interface &&
569 !strncmp(dwc->hsphy_interface, "ulpi", 4)) {
570 reg |= DWC3_GUSB2PHYCFG_ULPI_UTMI;
571 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
573 /* Relying on default value. */
574 if (!(reg & DWC3_GUSB2PHYCFG_ULPI_UTMI))
578 case DWC3_GHWPARAMS3_HSPHY_IFC_ULPI:
579 ret = dwc3_ulpi_init(dwc);
587 switch (dwc->hsphy_mode) {
588 case USBPHY_INTERFACE_MODE_UTMI:
589 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
590 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
591 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_8_BIT) |
592 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_8_BIT);
594 case USBPHY_INTERFACE_MODE_UTMIW:
595 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
596 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
597 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_16_BIT) |
598 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_16_BIT);
605 * Above 1.94a, it is recommended to set DWC3_GUSB2PHYCFG_SUSPHY to
606 * '0' during coreConsultant configuration. So default value will
607 * be '0' when the core is reset. Application needs to set it to
608 * '1' after the core initialization is completed.
610 if (dwc->revision > DWC3_REVISION_194A)
611 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
613 if (dwc->dis_u2_susphy_quirk)
614 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
616 if (dwc->dis_enblslpm_quirk)
617 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
619 if (dwc->dis_u2_freeclk_exists_quirk)
620 reg &= ~DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS;
622 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
627 static void dwc3_core_exit(struct dwc3 *dwc)
629 dwc3_event_buffers_cleanup(dwc);
631 usb_phy_shutdown(dwc->usb2_phy);
632 usb_phy_shutdown(dwc->usb3_phy);
633 phy_exit(dwc->usb2_generic_phy);
634 phy_exit(dwc->usb3_generic_phy);
636 usb_phy_set_suspend(dwc->usb2_phy, 1);
637 usb_phy_set_suspend(dwc->usb3_phy, 1);
638 phy_power_off(dwc->usb2_generic_phy);
639 phy_power_off(dwc->usb3_generic_phy);
642 static bool dwc3_core_is_valid(struct dwc3 *dwc)
646 reg = dwc3_readl(dwc->regs, DWC3_GSNPSID);
648 /* This should read as U3 followed by revision number */
649 if ((reg & DWC3_GSNPSID_MASK) == 0x55330000) {
650 /* Detected DWC_usb3 IP */
652 } else if ((reg & DWC3_GSNPSID_MASK) == 0x33310000) {
653 /* Detected DWC_usb31 IP */
654 dwc->revision = dwc3_readl(dwc->regs, DWC3_VER_NUMBER);
655 dwc->revision |= DWC3_REVISION_IS_DWC31;
663 static void dwc3_core_setup_global_control(struct dwc3 *dwc)
665 u32 hwparams4 = dwc->hwparams.hwparams4;
668 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
669 reg &= ~DWC3_GCTL_SCALEDOWN_MASK;
671 switch (DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1)) {
672 case DWC3_GHWPARAMS1_EN_PWROPT_CLK:
674 * WORKAROUND: DWC3 revisions between 2.10a and 2.50a have an
675 * issue which would cause xHCI compliance tests to fail.
677 * Because of that we cannot enable clock gating on such
682 * STAR#9000588375: Clock Gating, SOF Issues when ref_clk-Based
685 if ((dwc->dr_mode == USB_DR_MODE_HOST ||
686 dwc->dr_mode == USB_DR_MODE_OTG) &&
687 (dwc->revision >= DWC3_REVISION_210A &&
688 dwc->revision <= DWC3_REVISION_250A))
689 reg |= DWC3_GCTL_DSBLCLKGTNG | DWC3_GCTL_SOFITPSYNC;
691 reg &= ~DWC3_GCTL_DSBLCLKGTNG;
693 case DWC3_GHWPARAMS1_EN_PWROPT_HIB:
694 /* enable hibernation here */
695 dwc->nr_scratch = DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(hwparams4);
698 * REVISIT Enabling this bit so that host-mode hibernation
699 * will work. Device-mode hibernation is not yet implemented.
701 reg |= DWC3_GCTL_GBLHIBERNATIONEN;
708 /* check if current dwc3 is on simulation board */
709 if (dwc->hwparams.hwparams6 & DWC3_GHWPARAMS6_EN_FPGA) {
710 dev_info(dwc->dev, "Running with FPGA optmizations\n");
714 WARN_ONCE(dwc->disable_scramble_quirk && !dwc->is_fpga,
715 "disable_scramble cannot be used on non-FPGA builds\n");
717 if (dwc->disable_scramble_quirk && dwc->is_fpga)
718 reg |= DWC3_GCTL_DISSCRAMBLE;
720 reg &= ~DWC3_GCTL_DISSCRAMBLE;
722 if (dwc->u2exit_lfps_quirk)
723 reg |= DWC3_GCTL_U2EXIT_LFPS;
726 * WORKAROUND: DWC3 revisions <1.90a have a bug
727 * where the device can fail to connect at SuperSpeed
728 * and falls back to high-speed mode which causes
729 * the device to enter a Connect/Disconnect loop
731 if (dwc->revision < DWC3_REVISION_190A)
732 reg |= DWC3_GCTL_U2RSTECN;
734 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
737 static int dwc3_core_get_phy(struct dwc3 *dwc);
740 * dwc3_core_init - Low-level initialization of DWC3 Core
741 * @dwc: Pointer to our controller context structure
743 * Returns 0 on success otherwise negative errno.
745 static int dwc3_core_init(struct dwc3 *dwc)
750 if (!dwc3_core_is_valid(dwc)) {
751 dev_err(dwc->dev, "this is not a DesignWare USB3 DRD Core\n");
757 * Write Linux Version Code to our GUID register so it's easy to figure
758 * out which kernel version a bug was found.
760 dwc3_writel(dwc->regs, DWC3_GUID, LINUX_VERSION_CODE);
762 /* Handle USB2.0-only core configuration */
763 if (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
764 DWC3_GHWPARAMS3_SSPHY_IFC_DIS) {
765 if (dwc->maximum_speed == USB_SPEED_SUPER)
766 dwc->maximum_speed = USB_SPEED_HIGH;
769 ret = dwc3_core_soft_reset(dwc);
773 ret = dwc3_phy_setup(dwc);
777 ret = dwc3_core_get_phy(dwc);
781 dwc3_core_setup_global_control(dwc);
782 dwc3_core_num_eps(dwc);
784 ret = dwc3_setup_scratch_buffers(dwc);
788 /* Adjust Frame Length */
789 dwc3_frame_length_adjustment(dwc);
791 usb_phy_set_suspend(dwc->usb2_phy, 0);
792 usb_phy_set_suspend(dwc->usb3_phy, 0);
793 ret = phy_power_on(dwc->usb2_generic_phy);
797 ret = phy_power_on(dwc->usb3_generic_phy);
801 ret = dwc3_event_buffers_setup(dwc);
803 dev_err(dwc->dev, "failed to setup event buffers\n");
808 * ENDXFER polling is available on version 3.10a and later of
809 * the DWC_usb3 controller. It is NOT available in the
810 * DWC_usb31 controller.
812 if (!dwc3_is_usb31(dwc) && dwc->revision >= DWC3_REVISION_310A) {
813 reg = dwc3_readl(dwc->regs, DWC3_GUCTL2);
814 reg |= DWC3_GUCTL2_RST_ACTBITLATER;
815 dwc3_writel(dwc->regs, DWC3_GUCTL2, reg);
818 if (dwc->revision >= DWC3_REVISION_250A) {
819 reg = dwc3_readl(dwc->regs, DWC3_GUCTL1);
822 * Enable hardware control of sending remote wakeup
823 * in HS when the device is in the L1 state.
825 if (dwc->revision >= DWC3_REVISION_290A)
826 reg |= DWC3_GUCTL1_DEV_L1_EXIT_BY_HW;
828 if (dwc->dis_tx_ipgap_linecheck_quirk)
829 reg |= DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS;
831 dwc3_writel(dwc->regs, DWC3_GUCTL1, reg);
837 phy_power_off(dwc->usb3_generic_phy);
840 phy_power_off(dwc->usb2_generic_phy);
843 usb_phy_set_suspend(dwc->usb2_phy, 1);
844 usb_phy_set_suspend(dwc->usb3_phy, 1);
847 usb_phy_shutdown(dwc->usb2_phy);
848 usb_phy_shutdown(dwc->usb3_phy);
849 phy_exit(dwc->usb2_generic_phy);
850 phy_exit(dwc->usb3_generic_phy);
856 static int dwc3_core_get_phy(struct dwc3 *dwc)
858 struct device *dev = dwc->dev;
859 struct device_node *node = dev->of_node;
863 dwc->usb2_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 0);
864 dwc->usb3_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 1);
866 dwc->usb2_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
867 dwc->usb3_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB3);
870 if (IS_ERR(dwc->usb2_phy)) {
871 ret = PTR_ERR(dwc->usb2_phy);
872 if (ret == -ENXIO || ret == -ENODEV) {
873 dwc->usb2_phy = NULL;
874 } else if (ret == -EPROBE_DEFER) {
877 dev_err(dev, "no usb2 phy configured\n");
882 if (IS_ERR(dwc->usb3_phy)) {
883 ret = PTR_ERR(dwc->usb3_phy);
884 if (ret == -ENXIO || ret == -ENODEV) {
885 dwc->usb3_phy = NULL;
886 } else if (ret == -EPROBE_DEFER) {
889 dev_err(dev, "no usb3 phy configured\n");
894 dwc->usb2_generic_phy = devm_phy_get(dev, "usb2-phy");
895 if (IS_ERR(dwc->usb2_generic_phy)) {
896 ret = PTR_ERR(dwc->usb2_generic_phy);
897 if (ret == -ENOSYS || ret == -ENODEV) {
898 dwc->usb2_generic_phy = NULL;
899 } else if (ret == -EPROBE_DEFER) {
902 dev_err(dev, "no usb2 phy configured\n");
907 dwc->usb3_generic_phy = devm_phy_get(dev, "usb3-phy");
908 if (IS_ERR(dwc->usb3_generic_phy)) {
909 ret = PTR_ERR(dwc->usb3_generic_phy);
910 if (ret == -ENOSYS || ret == -ENODEV) {
911 dwc->usb3_generic_phy = NULL;
912 } else if (ret == -EPROBE_DEFER) {
915 dev_err(dev, "no usb3 phy configured\n");
923 static int dwc3_core_init_mode(struct dwc3 *dwc)
925 struct device *dev = dwc->dev;
928 switch (dwc->dr_mode) {
929 case USB_DR_MODE_PERIPHERAL:
930 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_DEVICE);
933 otg_set_vbus(dwc->usb2_phy->otg, false);
934 if (dwc->usb2_generic_phy)
935 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_DEVICE);
937 ret = dwc3_gadget_init(dwc);
939 if (ret != -EPROBE_DEFER)
940 dev_err(dev, "failed to initialize gadget\n");
944 case USB_DR_MODE_HOST:
945 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_HOST);
948 otg_set_vbus(dwc->usb2_phy->otg, true);
949 if (dwc->usb2_generic_phy)
950 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_HOST);
952 ret = dwc3_host_init(dwc);
954 if (ret != -EPROBE_DEFER)
955 dev_err(dev, "failed to initialize host\n");
959 case USB_DR_MODE_OTG:
960 INIT_WORK(&dwc->drd_work, __dwc3_set_mode);
961 ret = dwc3_drd_init(dwc);
963 if (ret != -EPROBE_DEFER)
964 dev_err(dev, "failed to initialize dual-role\n");
969 dev_err(dev, "Unsupported mode of operation %d\n", dwc->dr_mode);
976 static void dwc3_core_exit_mode(struct dwc3 *dwc)
978 switch (dwc->dr_mode) {
979 case USB_DR_MODE_PERIPHERAL:
980 dwc3_gadget_exit(dwc);
982 case USB_DR_MODE_HOST:
985 case USB_DR_MODE_OTG:
994 static void dwc3_get_properties(struct dwc3 *dwc)
996 struct device *dev = dwc->dev;
997 u8 lpm_nyet_threshold;
1001 /* default to highest possible threshold */
1002 lpm_nyet_threshold = 0xff;
1004 /* default to -3.5dB de-emphasis */
1008 * default to assert utmi_sleep_n and use maximum allowed HIRD
1009 * threshold value of 0b1100
1011 hird_threshold = 12;
1013 dwc->maximum_speed = usb_get_maximum_speed(dev);
1014 dwc->dr_mode = usb_get_dr_mode(dev);
1015 dwc->hsphy_mode = of_usb_get_phy_mode(dev->of_node);
1017 dwc->sysdev_is_parent = device_property_read_bool(dev,
1018 "linux,sysdev_is_parent");
1019 if (dwc->sysdev_is_parent)
1020 dwc->sysdev = dwc->dev->parent;
1022 dwc->sysdev = dwc->dev;
1024 dwc->has_lpm_erratum = device_property_read_bool(dev,
1025 "snps,has-lpm-erratum");
1026 device_property_read_u8(dev, "snps,lpm-nyet-threshold",
1027 &lpm_nyet_threshold);
1028 dwc->is_utmi_l1_suspend = device_property_read_bool(dev,
1029 "snps,is-utmi-l1-suspend");
1030 device_property_read_u8(dev, "snps,hird-threshold",
1032 dwc->usb3_lpm_capable = device_property_read_bool(dev,
1033 "snps,usb3_lpm_capable");
1035 dwc->disable_scramble_quirk = device_property_read_bool(dev,
1036 "snps,disable_scramble_quirk");
1037 dwc->u2exit_lfps_quirk = device_property_read_bool(dev,
1038 "snps,u2exit_lfps_quirk");
1039 dwc->u2ss_inp3_quirk = device_property_read_bool(dev,
1040 "snps,u2ss_inp3_quirk");
1041 dwc->req_p1p2p3_quirk = device_property_read_bool(dev,
1042 "snps,req_p1p2p3_quirk");
1043 dwc->del_p1p2p3_quirk = device_property_read_bool(dev,
1044 "snps,del_p1p2p3_quirk");
1045 dwc->del_phy_power_chg_quirk = device_property_read_bool(dev,
1046 "snps,del_phy_power_chg_quirk");
1047 dwc->lfps_filter_quirk = device_property_read_bool(dev,
1048 "snps,lfps_filter_quirk");
1049 dwc->rx_detect_poll_quirk = device_property_read_bool(dev,
1050 "snps,rx_detect_poll_quirk");
1051 dwc->dis_u3_susphy_quirk = device_property_read_bool(dev,
1052 "snps,dis_u3_susphy_quirk");
1053 dwc->dis_u2_susphy_quirk = device_property_read_bool(dev,
1054 "snps,dis_u2_susphy_quirk");
1055 dwc->dis_enblslpm_quirk = device_property_read_bool(dev,
1056 "snps,dis_enblslpm_quirk");
1057 dwc->dis_rxdet_inp3_quirk = device_property_read_bool(dev,
1058 "snps,dis_rxdet_inp3_quirk");
1059 dwc->dis_u2_freeclk_exists_quirk = device_property_read_bool(dev,
1060 "snps,dis-u2-freeclk-exists-quirk");
1061 dwc->dis_del_phy_power_chg_quirk = device_property_read_bool(dev,
1062 "snps,dis-del-phy-power-chg-quirk");
1063 dwc->dis_tx_ipgap_linecheck_quirk = device_property_read_bool(dev,
1064 "snps,dis-tx-ipgap-linecheck-quirk");
1066 dwc->tx_de_emphasis_quirk = device_property_read_bool(dev,
1067 "snps,tx_de_emphasis_quirk");
1068 device_property_read_u8(dev, "snps,tx_de_emphasis",
1070 device_property_read_string(dev, "snps,hsphy_interface",
1071 &dwc->hsphy_interface);
1072 device_property_read_u32(dev, "snps,quirk-frame-length-adjustment",
1075 dwc->lpm_nyet_threshold = lpm_nyet_threshold;
1076 dwc->tx_de_emphasis = tx_de_emphasis;
1078 dwc->hird_threshold = hird_threshold
1079 | (dwc->is_utmi_l1_suspend << 4);
1081 dwc->imod_interval = 0;
1084 /* check whether the core supports IMOD */
1085 bool dwc3_has_imod(struct dwc3 *dwc)
1087 return ((dwc3_is_usb3(dwc) &&
1088 dwc->revision >= DWC3_REVISION_300A) ||
1089 (dwc3_is_usb31(dwc) &&
1090 dwc->revision >= DWC3_USB31_REVISION_120A));
1093 static void dwc3_check_params(struct dwc3 *dwc)
1095 struct device *dev = dwc->dev;
1097 /* Check for proper value of imod_interval */
1098 if (dwc->imod_interval && !dwc3_has_imod(dwc)) {
1099 dev_warn(dwc->dev, "Interrupt moderation not supported\n");
1100 dwc->imod_interval = 0;
1104 * Workaround for STAR 9000961433 which affects only version
1105 * 3.00a of the DWC_usb3 core. This prevents the controller
1106 * interrupt from being masked while handling events. IMOD
1107 * allows us to work around this issue. Enable it for the
1110 if (!dwc->imod_interval &&
1111 (dwc->revision == DWC3_REVISION_300A))
1112 dwc->imod_interval = 1;
1114 /* Check the maximum_speed parameter */
1115 switch (dwc->maximum_speed) {
1117 case USB_SPEED_FULL:
1118 case USB_SPEED_HIGH:
1119 case USB_SPEED_SUPER:
1120 case USB_SPEED_SUPER_PLUS:
1123 dev_err(dev, "invalid maximum_speed parameter %d\n",
1124 dwc->maximum_speed);
1126 case USB_SPEED_UNKNOWN:
1127 /* default to superspeed */
1128 dwc->maximum_speed = USB_SPEED_SUPER;
1131 * default to superspeed plus if we are capable.
1133 if (dwc3_is_usb31(dwc) &&
1134 (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
1135 DWC3_GHWPARAMS3_SSPHY_IFC_GEN2))
1136 dwc->maximum_speed = USB_SPEED_SUPER_PLUS;
1142 static int dwc3_probe(struct platform_device *pdev)
1144 struct device *dev = &pdev->dev;
1145 struct resource *res;
1152 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
1158 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1160 dev_err(dev, "missing memory resource\n");
1164 dwc->xhci_resources[0].start = res->start;
1165 dwc->xhci_resources[0].end = dwc->xhci_resources[0].start +
1167 dwc->xhci_resources[0].flags = res->flags;
1168 dwc->xhci_resources[0].name = res->name;
1170 res->start += DWC3_GLOBALS_REGS_START;
1173 * Request memory region but exclude xHCI regs,
1174 * since it will be requested by the xhci-plat driver.
1176 regs = devm_ioremap_resource(dev, res);
1178 ret = PTR_ERR(regs);
1183 dwc->regs_size = resource_size(res);
1185 dwc3_get_properties(dwc);
1187 platform_set_drvdata(pdev, dwc);
1188 dwc3_cache_hwparams(dwc);
1190 spin_lock_init(&dwc->lock);
1192 pm_runtime_set_active(dev);
1193 pm_runtime_use_autosuspend(dev);
1194 pm_runtime_set_autosuspend_delay(dev, DWC3_DEFAULT_AUTOSUSPEND_DELAY);
1195 pm_runtime_enable(dev);
1196 ret = pm_runtime_get_sync(dev);
1200 pm_runtime_forbid(dev);
1202 ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
1204 dev_err(dwc->dev, "failed to allocate event buffers\n");
1209 ret = dwc3_get_dr_mode(dwc);
1213 ret = dwc3_alloc_scratch_buffers(dwc);
1217 ret = dwc3_core_init(dwc);
1219 dev_err(dev, "failed to initialize core\n");
1223 dwc3_check_params(dwc);
1225 ret = dwc3_core_init_mode(dwc);
1229 dwc3_debugfs_init(dwc);
1230 pm_runtime_put(dev);
1235 dwc3_event_buffers_cleanup(dwc);
1238 dwc3_free_scratch_buffers(dwc);
1241 dwc3_free_event_buffers(dwc);
1242 dwc3_ulpi_exit(dwc);
1245 pm_runtime_allow(&pdev->dev);
1248 pm_runtime_put_sync(&pdev->dev);
1249 pm_runtime_disable(&pdev->dev);
1253 * restore res->start back to its original value so that, in case the
1254 * probe is deferred, we don't end up getting error in request the
1255 * memory region the next time probe is called.
1257 res->start -= DWC3_GLOBALS_REGS_START;
1262 static int dwc3_remove(struct platform_device *pdev)
1264 struct dwc3 *dwc = platform_get_drvdata(pdev);
1265 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1267 pm_runtime_get_sync(&pdev->dev);
1269 * restore res->start back to its original value so that, in case the
1270 * probe is deferred, we don't end up getting error in request the
1271 * memory region the next time probe is called.
1273 res->start -= DWC3_GLOBALS_REGS_START;
1275 dwc3_debugfs_exit(dwc);
1276 dwc3_core_exit_mode(dwc);
1278 dwc3_core_exit(dwc);
1279 dwc3_ulpi_exit(dwc);
1281 pm_runtime_put_sync(&pdev->dev);
1282 pm_runtime_allow(&pdev->dev);
1283 pm_runtime_disable(&pdev->dev);
1285 dwc3_free_event_buffers(dwc);
1286 dwc3_free_scratch_buffers(dwc);
1292 static int dwc3_suspend_common(struct dwc3 *dwc)
1294 unsigned long flags;
1296 switch (dwc->dr_mode) {
1297 case USB_DR_MODE_PERIPHERAL:
1298 case USB_DR_MODE_OTG:
1299 spin_lock_irqsave(&dwc->lock, flags);
1300 dwc3_gadget_suspend(dwc);
1301 spin_unlock_irqrestore(&dwc->lock, flags);
1303 case USB_DR_MODE_HOST:
1309 dwc3_core_exit(dwc);
1314 static int dwc3_resume_common(struct dwc3 *dwc)
1316 unsigned long flags;
1319 ret = dwc3_core_init(dwc);
1323 switch (dwc->dr_mode) {
1324 case USB_DR_MODE_PERIPHERAL:
1325 case USB_DR_MODE_OTG:
1326 spin_lock_irqsave(&dwc->lock, flags);
1327 dwc3_gadget_resume(dwc);
1328 spin_unlock_irqrestore(&dwc->lock, flags);
1330 case USB_DR_MODE_HOST:
1339 static int dwc3_runtime_checks(struct dwc3 *dwc)
1341 switch (dwc->dr_mode) {
1342 case USB_DR_MODE_PERIPHERAL:
1343 case USB_DR_MODE_OTG:
1347 case USB_DR_MODE_HOST:
1356 static int dwc3_runtime_suspend(struct device *dev)
1358 struct dwc3 *dwc = dev_get_drvdata(dev);
1361 if (dwc3_runtime_checks(dwc))
1364 ret = dwc3_suspend_common(dwc);
1368 device_init_wakeup(dev, true);
1373 static int dwc3_runtime_resume(struct device *dev)
1375 struct dwc3 *dwc = dev_get_drvdata(dev);
1378 device_init_wakeup(dev, false);
1380 ret = dwc3_resume_common(dwc);
1384 switch (dwc->dr_mode) {
1385 case USB_DR_MODE_PERIPHERAL:
1386 case USB_DR_MODE_OTG:
1387 dwc3_gadget_process_pending_events(dwc);
1389 case USB_DR_MODE_HOST:
1395 pm_runtime_mark_last_busy(dev);
1396 pm_runtime_put(dev);
1401 static int dwc3_runtime_idle(struct device *dev)
1403 struct dwc3 *dwc = dev_get_drvdata(dev);
1405 switch (dwc->dr_mode) {
1406 case USB_DR_MODE_PERIPHERAL:
1407 case USB_DR_MODE_OTG:
1408 if (dwc3_runtime_checks(dwc))
1411 case USB_DR_MODE_HOST:
1417 pm_runtime_mark_last_busy(dev);
1418 pm_runtime_autosuspend(dev);
1422 #endif /* CONFIG_PM */
1424 #ifdef CONFIG_PM_SLEEP
1425 static int dwc3_suspend(struct device *dev)
1427 struct dwc3 *dwc = dev_get_drvdata(dev);
1430 ret = dwc3_suspend_common(dwc);
1434 pinctrl_pm_select_sleep_state(dev);
1439 static int dwc3_resume(struct device *dev)
1441 struct dwc3 *dwc = dev_get_drvdata(dev);
1444 pinctrl_pm_select_default_state(dev);
1446 ret = dwc3_resume_common(dwc);
1450 pm_runtime_disable(dev);
1451 pm_runtime_set_active(dev);
1452 pm_runtime_enable(dev);
1456 #endif /* CONFIG_PM_SLEEP */
1458 static const struct dev_pm_ops dwc3_dev_pm_ops = {
1459 SET_SYSTEM_SLEEP_PM_OPS(dwc3_suspend, dwc3_resume)
1460 SET_RUNTIME_PM_OPS(dwc3_runtime_suspend, dwc3_runtime_resume,
1465 static const struct of_device_id of_dwc3_match[] = {
1467 .compatible = "snps,dwc3"
1470 .compatible = "synopsys,dwc3"
1474 MODULE_DEVICE_TABLE(of, of_dwc3_match);
1479 #define ACPI_ID_INTEL_BSW "808622B7"
1481 static const struct acpi_device_id dwc3_acpi_match[] = {
1482 { ACPI_ID_INTEL_BSW, 0 },
1485 MODULE_DEVICE_TABLE(acpi, dwc3_acpi_match);
1488 static struct platform_driver dwc3_driver = {
1489 .probe = dwc3_probe,
1490 .remove = dwc3_remove,
1493 .of_match_table = of_match_ptr(of_dwc3_match),
1494 .acpi_match_table = ACPI_PTR(dwc3_acpi_match),
1495 .pm = &dwc3_dev_pm_ops,
1499 module_platform_driver(dwc3_driver);
1501 MODULE_ALIAS("platform:dwc3");
1502 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
1503 MODULE_LICENSE("GPL v2");
1504 MODULE_DESCRIPTION("DesignWare USB3 DRD Controller Driver");