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");
157 case DWC3_GCTL_PRTCAP_DEVICE:
158 dwc3_event_buffers_setup(dwc);
159 ret = dwc3_gadget_init(dwc);
161 dev_err(dwc->dev, "failed to initialize peripheral\n");
168 void dwc3_set_mode(struct dwc3 *dwc, u32 mode)
172 spin_lock_irqsave(&dwc->lock, flags);
173 dwc->desired_dr_role = mode;
174 spin_unlock_irqrestore(&dwc->lock, flags);
176 queue_work(system_power_efficient_wq, &dwc->drd_work);
179 u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type)
181 struct dwc3 *dwc = dep->dwc;
184 dwc3_writel(dwc->regs, DWC3_GDBGFIFOSPACE,
185 DWC3_GDBGFIFOSPACE_NUM(dep->number) |
186 DWC3_GDBGFIFOSPACE_TYPE(type));
188 reg = dwc3_readl(dwc->regs, DWC3_GDBGFIFOSPACE);
190 return DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(reg);
194 * dwc3_core_soft_reset - Issues core soft reset and PHY reset
195 * @dwc: pointer to our context structure
197 static int dwc3_core_soft_reset(struct dwc3 *dwc)
203 usb_phy_init(dwc->usb2_phy);
204 usb_phy_init(dwc->usb3_phy);
205 ret = phy_init(dwc->usb2_generic_phy);
209 ret = phy_init(dwc->usb3_generic_phy);
211 phy_exit(dwc->usb2_generic_phy);
216 * We're resetting only the device side because, if we're in host mode,
217 * XHCI driver will reset the host block. If dwc3 was configured for
218 * host-only mode, then we can return early.
220 if (dwc->dr_mode == USB_DR_MODE_HOST)
223 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
224 reg |= DWC3_DCTL_CSFTRST;
225 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
228 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
229 if (!(reg & DWC3_DCTL_CSFTRST))
239 * dwc3_frame_length_adjustment - Adjusts frame length if required
240 * @dwc3: Pointer to our controller context structure
242 static void dwc3_frame_length_adjustment(struct dwc3 *dwc)
247 if (dwc->revision < DWC3_REVISION_250A)
253 reg = dwc3_readl(dwc->regs, DWC3_GFLADJ);
254 dft = reg & DWC3_GFLADJ_30MHZ_MASK;
255 if (!dev_WARN_ONCE(dwc->dev, dft == dwc->fladj,
256 "request value same as default, ignoring\n")) {
257 reg &= ~DWC3_GFLADJ_30MHZ_MASK;
258 reg |= DWC3_GFLADJ_30MHZ_SDBND_SEL | dwc->fladj;
259 dwc3_writel(dwc->regs, DWC3_GFLADJ, reg);
264 * dwc3_free_one_event_buffer - Frees one event buffer
265 * @dwc: Pointer to our controller context structure
266 * @evt: Pointer to event buffer to be freed
268 static void dwc3_free_one_event_buffer(struct dwc3 *dwc,
269 struct dwc3_event_buffer *evt)
271 dma_free_coherent(dwc->sysdev, evt->length, evt->buf, evt->dma);
275 * dwc3_alloc_one_event_buffer - Allocates one event buffer structure
276 * @dwc: Pointer to our controller context structure
277 * @length: size of the event buffer
279 * Returns a pointer to the allocated event buffer structure on success
280 * otherwise ERR_PTR(errno).
282 static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
285 struct dwc3_event_buffer *evt;
287 evt = devm_kzalloc(dwc->dev, sizeof(*evt), GFP_KERNEL);
289 return ERR_PTR(-ENOMEM);
292 evt->length = length;
293 evt->cache = devm_kzalloc(dwc->dev, length, GFP_KERNEL);
295 return ERR_PTR(-ENOMEM);
297 evt->buf = dma_alloc_coherent(dwc->sysdev, length,
298 &evt->dma, GFP_KERNEL);
300 return ERR_PTR(-ENOMEM);
306 * dwc3_free_event_buffers - frees all allocated event buffers
307 * @dwc: Pointer to our controller context structure
309 static void dwc3_free_event_buffers(struct dwc3 *dwc)
311 struct dwc3_event_buffer *evt;
315 dwc3_free_one_event_buffer(dwc, evt);
319 * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
320 * @dwc: pointer to our controller context structure
321 * @length: size of event buffer
323 * Returns 0 on success otherwise negative errno. In the error case, dwc
324 * may contain some buffers allocated but not all which were requested.
326 static int dwc3_alloc_event_buffers(struct dwc3 *dwc, unsigned length)
328 struct dwc3_event_buffer *evt;
330 evt = dwc3_alloc_one_event_buffer(dwc, length);
332 dev_err(dwc->dev, "can't allocate event buffer\n");
341 * dwc3_event_buffers_setup - setup our allocated event buffers
342 * @dwc: pointer to our controller context structure
344 * Returns 0 on success otherwise negative errno.
346 static int dwc3_event_buffers_setup(struct dwc3 *dwc)
348 struct dwc3_event_buffer *evt;
352 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0),
353 lower_32_bits(evt->dma));
354 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0),
355 upper_32_bits(evt->dma));
356 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0),
357 DWC3_GEVNTSIZ_SIZE(evt->length));
358 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
363 static void dwc3_event_buffers_cleanup(struct dwc3 *dwc)
365 struct dwc3_event_buffer *evt;
371 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0), 0);
372 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0), 0);
373 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), DWC3_GEVNTSIZ_INTMASK
374 | DWC3_GEVNTSIZ_SIZE(0));
375 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
378 static int dwc3_alloc_scratch_buffers(struct dwc3 *dwc)
380 if (!dwc->has_hibernation)
383 if (!dwc->nr_scratch)
386 dwc->scratchbuf = kmalloc_array(dwc->nr_scratch,
387 DWC3_SCRATCHBUF_SIZE, GFP_KERNEL);
388 if (!dwc->scratchbuf)
394 static int dwc3_setup_scratch_buffers(struct dwc3 *dwc)
396 dma_addr_t scratch_addr;
400 if (!dwc->has_hibernation)
403 if (!dwc->nr_scratch)
406 /* should never fall here */
407 if (!WARN_ON(dwc->scratchbuf))
410 scratch_addr = dma_map_single(dwc->sysdev, dwc->scratchbuf,
411 dwc->nr_scratch * DWC3_SCRATCHBUF_SIZE,
413 if (dma_mapping_error(dwc->sysdev, scratch_addr)) {
414 dev_err(dwc->sysdev, "failed to map scratch buffer\n");
419 dwc->scratch_addr = scratch_addr;
421 param = lower_32_bits(scratch_addr);
423 ret = dwc3_send_gadget_generic_command(dwc,
424 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO, param);
428 param = upper_32_bits(scratch_addr);
430 ret = dwc3_send_gadget_generic_command(dwc,
431 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI, param);
438 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
439 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
445 static void dwc3_free_scratch_buffers(struct dwc3 *dwc)
447 if (!dwc->has_hibernation)
450 if (!dwc->nr_scratch)
453 /* should never fall here */
454 if (!WARN_ON(dwc->scratchbuf))
457 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
458 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
459 kfree(dwc->scratchbuf);
462 static void dwc3_core_num_eps(struct dwc3 *dwc)
464 struct dwc3_hwparams *parms = &dwc->hwparams;
466 dwc->num_eps = DWC3_NUM_EPS(parms);
469 static void dwc3_cache_hwparams(struct dwc3 *dwc)
471 struct dwc3_hwparams *parms = &dwc->hwparams;
473 parms->hwparams0 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS0);
474 parms->hwparams1 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS1);
475 parms->hwparams2 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS2);
476 parms->hwparams3 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS3);
477 parms->hwparams4 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS4);
478 parms->hwparams5 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS5);
479 parms->hwparams6 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS6);
480 parms->hwparams7 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS7);
481 parms->hwparams8 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS8);
485 * dwc3_phy_setup - Configure USB PHY Interface of DWC3 Core
486 * @dwc: Pointer to our controller context structure
488 * Returns 0 on success. The USB PHY interfaces are configured but not
489 * initialized. The PHY interfaces and the PHYs get initialized together with
490 * the core in dwc3_core_init.
492 static int dwc3_phy_setup(struct dwc3 *dwc)
497 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
500 * Make sure UX_EXIT_PX is cleared as that causes issues with some
501 * PHYs. Also, this bit is not supposed to be used in normal operation.
503 reg &= ~DWC3_GUSB3PIPECTL_UX_EXIT_PX;
506 * Above 1.94a, it is recommended to set DWC3_GUSB3PIPECTL_SUSPHY
507 * to '0' during coreConsultant configuration. So default value
508 * will be '0' when the core is reset. Application needs to set it
509 * to '1' after the core initialization is completed.
511 if (dwc->revision > DWC3_REVISION_194A)
512 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
514 if (dwc->u2ss_inp3_quirk)
515 reg |= DWC3_GUSB3PIPECTL_U2SSINP3OK;
517 if (dwc->dis_rxdet_inp3_quirk)
518 reg |= DWC3_GUSB3PIPECTL_DISRXDETINP3;
520 if (dwc->req_p1p2p3_quirk)
521 reg |= DWC3_GUSB3PIPECTL_REQP1P2P3;
523 if (dwc->del_p1p2p3_quirk)
524 reg |= DWC3_GUSB3PIPECTL_DEP1P2P3_EN;
526 if (dwc->del_phy_power_chg_quirk)
527 reg |= DWC3_GUSB3PIPECTL_DEPOCHANGE;
529 if (dwc->lfps_filter_quirk)
530 reg |= DWC3_GUSB3PIPECTL_LFPSFILT;
532 if (dwc->rx_detect_poll_quirk)
533 reg |= DWC3_GUSB3PIPECTL_RX_DETOPOLL;
535 if (dwc->tx_de_emphasis_quirk)
536 reg |= DWC3_GUSB3PIPECTL_TX_DEEPH(dwc->tx_de_emphasis);
538 if (dwc->dis_u3_susphy_quirk)
539 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
541 if (dwc->dis_del_phy_power_chg_quirk)
542 reg &= ~DWC3_GUSB3PIPECTL_DEPOCHANGE;
544 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
546 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
548 /* Select the HS PHY interface */
549 switch (DWC3_GHWPARAMS3_HSPHY_IFC(dwc->hwparams.hwparams3)) {
550 case DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI:
551 if (dwc->hsphy_interface &&
552 !strncmp(dwc->hsphy_interface, "utmi", 4)) {
553 reg &= ~DWC3_GUSB2PHYCFG_ULPI_UTMI;
555 } else if (dwc->hsphy_interface &&
556 !strncmp(dwc->hsphy_interface, "ulpi", 4)) {
557 reg |= DWC3_GUSB2PHYCFG_ULPI_UTMI;
558 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
560 /* Relying on default value. */
561 if (!(reg & DWC3_GUSB2PHYCFG_ULPI_UTMI))
565 case DWC3_GHWPARAMS3_HSPHY_IFC_ULPI:
566 ret = dwc3_ulpi_init(dwc);
574 switch (dwc->hsphy_mode) {
575 case USBPHY_INTERFACE_MODE_UTMI:
576 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
577 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
578 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_8_BIT) |
579 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_8_BIT);
581 case USBPHY_INTERFACE_MODE_UTMIW:
582 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
583 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
584 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_16_BIT) |
585 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_16_BIT);
592 * Above 1.94a, it is recommended to set DWC3_GUSB2PHYCFG_SUSPHY to
593 * '0' during coreConsultant configuration. So default value will
594 * be '0' when the core is reset. Application needs to set it to
595 * '1' after the core initialization is completed.
597 if (dwc->revision > DWC3_REVISION_194A)
598 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
600 if (dwc->dis_u2_susphy_quirk)
601 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
603 if (dwc->dis_enblslpm_quirk)
604 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
606 if (dwc->dis_u2_freeclk_exists_quirk)
607 reg &= ~DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS;
609 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
614 static void dwc3_core_exit(struct dwc3 *dwc)
616 dwc3_event_buffers_cleanup(dwc);
618 usb_phy_shutdown(dwc->usb2_phy);
619 usb_phy_shutdown(dwc->usb3_phy);
620 phy_exit(dwc->usb2_generic_phy);
621 phy_exit(dwc->usb3_generic_phy);
623 usb_phy_set_suspend(dwc->usb2_phy, 1);
624 usb_phy_set_suspend(dwc->usb3_phy, 1);
625 phy_power_off(dwc->usb2_generic_phy);
626 phy_power_off(dwc->usb3_generic_phy);
629 static bool dwc3_core_is_valid(struct dwc3 *dwc)
633 reg = dwc3_readl(dwc->regs, DWC3_GSNPSID);
635 /* This should read as U3 followed by revision number */
636 if ((reg & DWC3_GSNPSID_MASK) == 0x55330000) {
637 /* Detected DWC_usb3 IP */
639 } else if ((reg & DWC3_GSNPSID_MASK) == 0x33310000) {
640 /* Detected DWC_usb31 IP */
641 dwc->revision = dwc3_readl(dwc->regs, DWC3_VER_NUMBER);
642 dwc->revision |= DWC3_REVISION_IS_DWC31;
650 static void dwc3_core_setup_global_control(struct dwc3 *dwc)
652 u32 hwparams4 = dwc->hwparams.hwparams4;
655 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
656 reg &= ~DWC3_GCTL_SCALEDOWN_MASK;
658 switch (DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1)) {
659 case DWC3_GHWPARAMS1_EN_PWROPT_CLK:
661 * WORKAROUND: DWC3 revisions between 2.10a and 2.50a have an
662 * issue which would cause xHCI compliance tests to fail.
664 * Because of that we cannot enable clock gating on such
669 * STAR#9000588375: Clock Gating, SOF Issues when ref_clk-Based
672 if ((dwc->dr_mode == USB_DR_MODE_HOST ||
673 dwc->dr_mode == USB_DR_MODE_OTG) &&
674 (dwc->revision >= DWC3_REVISION_210A &&
675 dwc->revision <= DWC3_REVISION_250A))
676 reg |= DWC3_GCTL_DSBLCLKGTNG | DWC3_GCTL_SOFITPSYNC;
678 reg &= ~DWC3_GCTL_DSBLCLKGTNG;
680 case DWC3_GHWPARAMS1_EN_PWROPT_HIB:
681 /* enable hibernation here */
682 dwc->nr_scratch = DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(hwparams4);
685 * REVISIT Enabling this bit so that host-mode hibernation
686 * will work. Device-mode hibernation is not yet implemented.
688 reg |= DWC3_GCTL_GBLHIBERNATIONEN;
695 /* check if current dwc3 is on simulation board */
696 if (dwc->hwparams.hwparams6 & DWC3_GHWPARAMS6_EN_FPGA) {
697 dev_info(dwc->dev, "Running with FPGA optmizations\n");
701 WARN_ONCE(dwc->disable_scramble_quirk && !dwc->is_fpga,
702 "disable_scramble cannot be used on non-FPGA builds\n");
704 if (dwc->disable_scramble_quirk && dwc->is_fpga)
705 reg |= DWC3_GCTL_DISSCRAMBLE;
707 reg &= ~DWC3_GCTL_DISSCRAMBLE;
709 if (dwc->u2exit_lfps_quirk)
710 reg |= DWC3_GCTL_U2EXIT_LFPS;
713 * WORKAROUND: DWC3 revisions <1.90a have a bug
714 * where the device can fail to connect at SuperSpeed
715 * and falls back to high-speed mode which causes
716 * the device to enter a Connect/Disconnect loop
718 if (dwc->revision < DWC3_REVISION_190A)
719 reg |= DWC3_GCTL_U2RSTECN;
721 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
725 * dwc3_core_init - Low-level initialization of DWC3 Core
726 * @dwc: Pointer to our controller context structure
728 * Returns 0 on success otherwise negative errno.
730 static int dwc3_core_init(struct dwc3 *dwc)
735 if (!dwc3_core_is_valid(dwc)) {
736 dev_err(dwc->dev, "this is not a DesignWare USB3 DRD Core\n");
742 * Write Linux Version Code to our GUID register so it's easy to figure
743 * out which kernel version a bug was found.
745 dwc3_writel(dwc->regs, DWC3_GUID, LINUX_VERSION_CODE);
747 /* Handle USB2.0-only core configuration */
748 if (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
749 DWC3_GHWPARAMS3_SSPHY_IFC_DIS) {
750 if (dwc->maximum_speed == USB_SPEED_SUPER)
751 dwc->maximum_speed = USB_SPEED_HIGH;
754 ret = dwc3_core_soft_reset(dwc);
758 ret = dwc3_phy_setup(dwc);
762 dwc3_core_setup_global_control(dwc);
763 dwc3_core_num_eps(dwc);
765 ret = dwc3_setup_scratch_buffers(dwc);
769 /* Adjust Frame Length */
770 dwc3_frame_length_adjustment(dwc);
772 usb_phy_set_suspend(dwc->usb2_phy, 0);
773 usb_phy_set_suspend(dwc->usb3_phy, 0);
774 ret = phy_power_on(dwc->usb2_generic_phy);
778 ret = phy_power_on(dwc->usb3_generic_phy);
782 ret = dwc3_event_buffers_setup(dwc);
784 dev_err(dwc->dev, "failed to setup event buffers\n");
789 * ENDXFER polling is available on version 3.10a and later of
790 * the DWC_usb3 controller. It is NOT available in the
791 * DWC_usb31 controller.
793 if (!dwc3_is_usb31(dwc) && dwc->revision >= DWC3_REVISION_310A) {
794 reg = dwc3_readl(dwc->regs, DWC3_GUCTL2);
795 reg |= DWC3_GUCTL2_RST_ACTBITLATER;
796 dwc3_writel(dwc->regs, DWC3_GUCTL2, reg);
800 * Enable hardware control of sending remote wakeup in HS when
801 * the device is in the L1 state.
803 if (dwc->revision >= DWC3_REVISION_290A) {
804 reg = dwc3_readl(dwc->regs, DWC3_GUCTL1);
805 reg |= DWC3_GUCTL1_DEV_L1_EXIT_BY_HW;
806 dwc3_writel(dwc->regs, DWC3_GUCTL1, reg);
812 phy_power_off(dwc->usb3_generic_phy);
815 phy_power_off(dwc->usb2_generic_phy);
818 usb_phy_set_suspend(dwc->usb2_phy, 1);
819 usb_phy_set_suspend(dwc->usb3_phy, 1);
822 usb_phy_shutdown(dwc->usb2_phy);
823 usb_phy_shutdown(dwc->usb3_phy);
824 phy_exit(dwc->usb2_generic_phy);
825 phy_exit(dwc->usb3_generic_phy);
831 static int dwc3_core_get_phy(struct dwc3 *dwc)
833 struct device *dev = dwc->dev;
834 struct device_node *node = dev->of_node;
838 dwc->usb2_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 0);
839 dwc->usb3_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 1);
841 dwc->usb2_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
842 dwc->usb3_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB3);
845 if (IS_ERR(dwc->usb2_phy)) {
846 ret = PTR_ERR(dwc->usb2_phy);
847 if (ret == -ENXIO || ret == -ENODEV) {
848 dwc->usb2_phy = NULL;
849 } else if (ret == -EPROBE_DEFER) {
852 dev_err(dev, "no usb2 phy configured\n");
857 if (IS_ERR(dwc->usb3_phy)) {
858 ret = PTR_ERR(dwc->usb3_phy);
859 if (ret == -ENXIO || ret == -ENODEV) {
860 dwc->usb3_phy = NULL;
861 } else if (ret == -EPROBE_DEFER) {
864 dev_err(dev, "no usb3 phy configured\n");
869 dwc->usb2_generic_phy = devm_phy_get(dev, "usb2-phy");
870 if (IS_ERR(dwc->usb2_generic_phy)) {
871 ret = PTR_ERR(dwc->usb2_generic_phy);
872 if (ret == -ENOSYS || ret == -ENODEV) {
873 dwc->usb2_generic_phy = NULL;
874 } else if (ret == -EPROBE_DEFER) {
877 dev_err(dev, "no usb2 phy configured\n");
882 dwc->usb3_generic_phy = devm_phy_get(dev, "usb3-phy");
883 if (IS_ERR(dwc->usb3_generic_phy)) {
884 ret = PTR_ERR(dwc->usb3_generic_phy);
885 if (ret == -ENOSYS || ret == -ENODEV) {
886 dwc->usb3_generic_phy = NULL;
887 } else if (ret == -EPROBE_DEFER) {
890 dev_err(dev, "no usb3 phy configured\n");
898 static int dwc3_core_init_mode(struct dwc3 *dwc)
900 struct device *dev = dwc->dev;
903 switch (dwc->dr_mode) {
904 case USB_DR_MODE_PERIPHERAL:
905 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_DEVICE);
906 ret = dwc3_gadget_init(dwc);
908 if (ret != -EPROBE_DEFER)
909 dev_err(dev, "failed to initialize gadget\n");
913 case USB_DR_MODE_HOST:
914 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_HOST);
915 ret = dwc3_host_init(dwc);
917 if (ret != -EPROBE_DEFER)
918 dev_err(dev, "failed to initialize host\n");
922 case USB_DR_MODE_OTG:
923 INIT_WORK(&dwc->drd_work, __dwc3_set_mode);
924 dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_DEVICE);
927 dev_err(dev, "Unsupported mode of operation %d\n", dwc->dr_mode);
934 static void dwc3_core_exit_mode(struct dwc3 *dwc)
936 switch (dwc->dr_mode) {
937 case USB_DR_MODE_PERIPHERAL:
938 dwc3_gadget_exit(dwc);
940 case USB_DR_MODE_HOST:
943 case USB_DR_MODE_OTG:
944 dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_DEVICE);
945 dwc3_gadget_exit(dwc);
946 flush_work(&dwc->drd_work);
954 static void dwc3_get_properties(struct dwc3 *dwc)
956 struct device *dev = dwc->dev;
957 u8 lpm_nyet_threshold;
961 /* default to highest possible threshold */
962 lpm_nyet_threshold = 0xff;
964 /* default to -3.5dB de-emphasis */
968 * default to assert utmi_sleep_n and use maximum allowed HIRD
969 * threshold value of 0b1100
973 dwc->maximum_speed = usb_get_maximum_speed(dev);
974 dwc->dr_mode = usb_get_dr_mode(dev);
975 dwc->hsphy_mode = of_usb_get_phy_mode(dev->of_node);
977 dwc->sysdev_is_parent = device_property_read_bool(dev,
978 "linux,sysdev_is_parent");
979 if (dwc->sysdev_is_parent)
980 dwc->sysdev = dwc->dev->parent;
982 dwc->sysdev = dwc->dev;
984 dwc->has_lpm_erratum = device_property_read_bool(dev,
985 "snps,has-lpm-erratum");
986 device_property_read_u8(dev, "snps,lpm-nyet-threshold",
987 &lpm_nyet_threshold);
988 dwc->is_utmi_l1_suspend = device_property_read_bool(dev,
989 "snps,is-utmi-l1-suspend");
990 device_property_read_u8(dev, "snps,hird-threshold",
992 dwc->usb3_lpm_capable = device_property_read_bool(dev,
993 "snps,usb3_lpm_capable");
995 dwc->disable_scramble_quirk = device_property_read_bool(dev,
996 "snps,disable_scramble_quirk");
997 dwc->u2exit_lfps_quirk = device_property_read_bool(dev,
998 "snps,u2exit_lfps_quirk");
999 dwc->u2ss_inp3_quirk = device_property_read_bool(dev,
1000 "snps,u2ss_inp3_quirk");
1001 dwc->req_p1p2p3_quirk = device_property_read_bool(dev,
1002 "snps,req_p1p2p3_quirk");
1003 dwc->del_p1p2p3_quirk = device_property_read_bool(dev,
1004 "snps,del_p1p2p3_quirk");
1005 dwc->del_phy_power_chg_quirk = device_property_read_bool(dev,
1006 "snps,del_phy_power_chg_quirk");
1007 dwc->lfps_filter_quirk = device_property_read_bool(dev,
1008 "snps,lfps_filter_quirk");
1009 dwc->rx_detect_poll_quirk = device_property_read_bool(dev,
1010 "snps,rx_detect_poll_quirk");
1011 dwc->dis_u3_susphy_quirk = device_property_read_bool(dev,
1012 "snps,dis_u3_susphy_quirk");
1013 dwc->dis_u2_susphy_quirk = device_property_read_bool(dev,
1014 "snps,dis_u2_susphy_quirk");
1015 dwc->dis_enblslpm_quirk = device_property_read_bool(dev,
1016 "snps,dis_enblslpm_quirk");
1017 dwc->dis_rxdet_inp3_quirk = device_property_read_bool(dev,
1018 "snps,dis_rxdet_inp3_quirk");
1019 dwc->dis_u2_freeclk_exists_quirk = device_property_read_bool(dev,
1020 "snps,dis-u2-freeclk-exists-quirk");
1021 dwc->dis_del_phy_power_chg_quirk = device_property_read_bool(dev,
1022 "snps,dis-del-phy-power-chg-quirk");
1024 dwc->tx_de_emphasis_quirk = device_property_read_bool(dev,
1025 "snps,tx_de_emphasis_quirk");
1026 device_property_read_u8(dev, "snps,tx_de_emphasis",
1028 device_property_read_string(dev, "snps,hsphy_interface",
1029 &dwc->hsphy_interface);
1030 device_property_read_u32(dev, "snps,quirk-frame-length-adjustment",
1033 dwc->lpm_nyet_threshold = lpm_nyet_threshold;
1034 dwc->tx_de_emphasis = tx_de_emphasis;
1036 dwc->hird_threshold = hird_threshold
1037 | (dwc->is_utmi_l1_suspend << 4);
1039 dwc->imod_interval = 0;
1042 /* check whether the core supports IMOD */
1043 bool dwc3_has_imod(struct dwc3 *dwc)
1045 return ((dwc3_is_usb3(dwc) &&
1046 dwc->revision >= DWC3_REVISION_300A) ||
1047 (dwc3_is_usb31(dwc) &&
1048 dwc->revision >= DWC3_USB31_REVISION_120A));
1051 static void dwc3_check_params(struct dwc3 *dwc)
1053 struct device *dev = dwc->dev;
1055 /* Check for proper value of imod_interval */
1056 if (dwc->imod_interval && !dwc3_has_imod(dwc)) {
1057 dev_warn(dwc->dev, "Interrupt moderation not supported\n");
1058 dwc->imod_interval = 0;
1062 * Workaround for STAR 9000961433 which affects only version
1063 * 3.00a of the DWC_usb3 core. This prevents the controller
1064 * interrupt from being masked while handling events. IMOD
1065 * allows us to work around this issue. Enable it for the
1068 if (!dwc->imod_interval &&
1069 (dwc->revision == DWC3_REVISION_300A))
1070 dwc->imod_interval = 1;
1072 /* Check the maximum_speed parameter */
1073 switch (dwc->maximum_speed) {
1075 case USB_SPEED_FULL:
1076 case USB_SPEED_HIGH:
1077 case USB_SPEED_SUPER:
1078 case USB_SPEED_SUPER_PLUS:
1081 dev_err(dev, "invalid maximum_speed parameter %d\n",
1082 dwc->maximum_speed);
1084 case USB_SPEED_UNKNOWN:
1085 /* default to superspeed */
1086 dwc->maximum_speed = USB_SPEED_SUPER;
1089 * default to superspeed plus if we are capable.
1091 if (dwc3_is_usb31(dwc) &&
1092 (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
1093 DWC3_GHWPARAMS3_SSPHY_IFC_GEN2))
1094 dwc->maximum_speed = USB_SPEED_SUPER_PLUS;
1100 static int dwc3_probe(struct platform_device *pdev)
1102 struct device *dev = &pdev->dev;
1103 struct resource *res;
1110 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
1116 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1118 dev_err(dev, "missing memory resource\n");
1122 dwc->xhci_resources[0].start = res->start;
1123 dwc->xhci_resources[0].end = dwc->xhci_resources[0].start +
1125 dwc->xhci_resources[0].flags = res->flags;
1126 dwc->xhci_resources[0].name = res->name;
1128 res->start += DWC3_GLOBALS_REGS_START;
1131 * Request memory region but exclude xHCI regs,
1132 * since it will be requested by the xhci-plat driver.
1134 regs = devm_ioremap_resource(dev, res);
1136 ret = PTR_ERR(regs);
1141 dwc->regs_size = resource_size(res);
1143 dwc3_get_properties(dwc);
1145 platform_set_drvdata(pdev, dwc);
1146 dwc3_cache_hwparams(dwc);
1148 ret = dwc3_core_get_phy(dwc);
1152 spin_lock_init(&dwc->lock);
1154 pm_runtime_set_active(dev);
1155 pm_runtime_use_autosuspend(dev);
1156 pm_runtime_set_autosuspend_delay(dev, DWC3_DEFAULT_AUTOSUSPEND_DELAY);
1157 pm_runtime_enable(dev);
1158 ret = pm_runtime_get_sync(dev);
1162 pm_runtime_forbid(dev);
1164 ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
1166 dev_err(dwc->dev, "failed to allocate event buffers\n");
1171 ret = dwc3_get_dr_mode(dwc);
1175 ret = dwc3_alloc_scratch_buffers(dwc);
1179 ret = dwc3_core_init(dwc);
1181 dev_err(dev, "failed to initialize core\n");
1185 dwc3_check_params(dwc);
1187 ret = dwc3_core_init_mode(dwc);
1191 dwc3_debugfs_init(dwc);
1192 pm_runtime_put(dev);
1197 dwc3_event_buffers_cleanup(dwc);
1200 dwc3_free_scratch_buffers(dwc);
1203 dwc3_free_event_buffers(dwc);
1204 dwc3_ulpi_exit(dwc);
1207 pm_runtime_allow(&pdev->dev);
1210 pm_runtime_put_sync(&pdev->dev);
1211 pm_runtime_disable(&pdev->dev);
1215 * restore res->start back to its original value so that, in case the
1216 * probe is deferred, we don't end up getting error in request the
1217 * memory region the next time probe is called.
1219 res->start -= DWC3_GLOBALS_REGS_START;
1224 static int dwc3_remove(struct platform_device *pdev)
1226 struct dwc3 *dwc = platform_get_drvdata(pdev);
1227 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1229 pm_runtime_get_sync(&pdev->dev);
1231 * restore res->start back to its original value so that, in case the
1232 * probe is deferred, we don't end up getting error in request the
1233 * memory region the next time probe is called.
1235 res->start -= DWC3_GLOBALS_REGS_START;
1237 dwc3_debugfs_exit(dwc);
1238 dwc3_core_exit_mode(dwc);
1240 dwc3_core_exit(dwc);
1241 dwc3_ulpi_exit(dwc);
1243 pm_runtime_put_sync(&pdev->dev);
1244 pm_runtime_allow(&pdev->dev);
1245 pm_runtime_disable(&pdev->dev);
1247 dwc3_free_event_buffers(dwc);
1248 dwc3_free_scratch_buffers(dwc);
1254 static int dwc3_suspend_common(struct dwc3 *dwc)
1256 unsigned long flags;
1258 switch (dwc->dr_mode) {
1259 case USB_DR_MODE_PERIPHERAL:
1260 case USB_DR_MODE_OTG:
1261 spin_lock_irqsave(&dwc->lock, flags);
1262 dwc3_gadget_suspend(dwc);
1263 spin_unlock_irqrestore(&dwc->lock, flags);
1265 case USB_DR_MODE_HOST:
1271 dwc3_core_exit(dwc);
1276 static int dwc3_resume_common(struct dwc3 *dwc)
1278 unsigned long flags;
1281 ret = dwc3_core_init(dwc);
1285 switch (dwc->dr_mode) {
1286 case USB_DR_MODE_PERIPHERAL:
1287 case USB_DR_MODE_OTG:
1288 spin_lock_irqsave(&dwc->lock, flags);
1289 dwc3_gadget_resume(dwc);
1290 spin_unlock_irqrestore(&dwc->lock, flags);
1292 case USB_DR_MODE_HOST:
1301 static int dwc3_runtime_checks(struct dwc3 *dwc)
1303 switch (dwc->dr_mode) {
1304 case USB_DR_MODE_PERIPHERAL:
1305 case USB_DR_MODE_OTG:
1309 case USB_DR_MODE_HOST:
1318 static int dwc3_runtime_suspend(struct device *dev)
1320 struct dwc3 *dwc = dev_get_drvdata(dev);
1323 if (dwc3_runtime_checks(dwc))
1326 ret = dwc3_suspend_common(dwc);
1330 device_init_wakeup(dev, true);
1335 static int dwc3_runtime_resume(struct device *dev)
1337 struct dwc3 *dwc = dev_get_drvdata(dev);
1340 device_init_wakeup(dev, false);
1342 ret = dwc3_resume_common(dwc);
1346 switch (dwc->dr_mode) {
1347 case USB_DR_MODE_PERIPHERAL:
1348 case USB_DR_MODE_OTG:
1349 dwc3_gadget_process_pending_events(dwc);
1351 case USB_DR_MODE_HOST:
1357 pm_runtime_mark_last_busy(dev);
1358 pm_runtime_put(dev);
1363 static int dwc3_runtime_idle(struct device *dev)
1365 struct dwc3 *dwc = dev_get_drvdata(dev);
1367 switch (dwc->dr_mode) {
1368 case USB_DR_MODE_PERIPHERAL:
1369 case USB_DR_MODE_OTG:
1370 if (dwc3_runtime_checks(dwc))
1373 case USB_DR_MODE_HOST:
1379 pm_runtime_mark_last_busy(dev);
1380 pm_runtime_autosuspend(dev);
1384 #endif /* CONFIG_PM */
1386 #ifdef CONFIG_PM_SLEEP
1387 static int dwc3_suspend(struct device *dev)
1389 struct dwc3 *dwc = dev_get_drvdata(dev);
1392 ret = dwc3_suspend_common(dwc);
1396 pinctrl_pm_select_sleep_state(dev);
1401 static int dwc3_resume(struct device *dev)
1403 struct dwc3 *dwc = dev_get_drvdata(dev);
1406 pinctrl_pm_select_default_state(dev);
1408 ret = dwc3_resume_common(dwc);
1412 pm_runtime_disable(dev);
1413 pm_runtime_set_active(dev);
1414 pm_runtime_enable(dev);
1418 #endif /* CONFIG_PM_SLEEP */
1420 static const struct dev_pm_ops dwc3_dev_pm_ops = {
1421 SET_SYSTEM_SLEEP_PM_OPS(dwc3_suspend, dwc3_resume)
1422 SET_RUNTIME_PM_OPS(dwc3_runtime_suspend, dwc3_runtime_resume,
1427 static const struct of_device_id of_dwc3_match[] = {
1429 .compatible = "snps,dwc3"
1432 .compatible = "synopsys,dwc3"
1436 MODULE_DEVICE_TABLE(of, of_dwc3_match);
1441 #define ACPI_ID_INTEL_BSW "808622B7"
1443 static const struct acpi_device_id dwc3_acpi_match[] = {
1444 { ACPI_ID_INTEL_BSW, 0 },
1447 MODULE_DEVICE_TABLE(acpi, dwc3_acpi_match);
1450 static struct platform_driver dwc3_driver = {
1451 .probe = dwc3_probe,
1452 .remove = dwc3_remove,
1455 .of_match_table = of_match_ptr(of_dwc3_match),
1456 .acpi_match_table = ACPI_PTR(dwc3_acpi_match),
1457 .pm = &dwc3_dev_pm_ops,
1461 module_platform_driver(dwc3_driver);
1463 MODULE_ALIAS("platform:dwc3");
1464 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
1465 MODULE_LICENSE("GPL v2");
1466 MODULE_DESCRIPTION("DesignWare USB3 DRD Controller Driver");