1 // SPDX-License-Identifier: GPL-2.0
3 * core.c - DesignWare USB3 DRD Controller Core file
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
11 #include <linux/clk.h>
12 #include <linux/version.h>
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/slab.h>
16 #include <linux/spinlock.h>
17 #include <linux/platform_device.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/interrupt.h>
20 #include <linux/ioport.h>
22 #include <linux/list.h>
23 #include <linux/delay.h>
24 #include <linux/dma-mapping.h>
26 #include <linux/acpi.h>
27 #include <linux/pinctrl/consumer.h>
28 #include <linux/reset.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
32 #include <linux/usb/of.h>
33 #include <linux/usb/otg.h>
41 #define DWC3_DEFAULT_AUTOSUSPEND_DELAY 5000 /* ms */
44 * dwc3_get_dr_mode - Validates and sets dr_mode
45 * @dwc: pointer to our context structure
47 static int dwc3_get_dr_mode(struct dwc3 *dwc)
49 enum usb_dr_mode mode;
50 struct device *dev = dwc->dev;
53 if (dwc->dr_mode == USB_DR_MODE_UNKNOWN)
54 dwc->dr_mode = USB_DR_MODE_OTG;
57 hw_mode = DWC3_GHWPARAMS0_MODE(dwc->hwparams.hwparams0);
60 case DWC3_GHWPARAMS0_MODE_GADGET:
61 if (IS_ENABLED(CONFIG_USB_DWC3_HOST)) {
63 "Controller does not support host mode.\n");
66 mode = USB_DR_MODE_PERIPHERAL;
68 case DWC3_GHWPARAMS0_MODE_HOST:
69 if (IS_ENABLED(CONFIG_USB_DWC3_GADGET)) {
71 "Controller does not support device mode.\n");
74 mode = USB_DR_MODE_HOST;
77 if (IS_ENABLED(CONFIG_USB_DWC3_HOST))
78 mode = USB_DR_MODE_HOST;
79 else if (IS_ENABLED(CONFIG_USB_DWC3_GADGET))
80 mode = USB_DR_MODE_PERIPHERAL;
83 * DWC_usb31 and DWC_usb3 v3.30a and higher do not support OTG
84 * mode. If the controller supports DRD but the dr_mode is not
85 * specified or set to OTG, then set the mode to peripheral.
87 if (mode == USB_DR_MODE_OTG &&
88 (!IS_ENABLED(CONFIG_USB_ROLE_SWITCH) ||
89 !device_property_read_bool(dwc->dev, "usb-role-switch")) &&
90 !DWC3_VER_IS_PRIOR(DWC3, 330A))
91 mode = USB_DR_MODE_PERIPHERAL;
94 if (mode != dwc->dr_mode) {
96 "Configuration mismatch. dr_mode forced to %s\n",
97 mode == USB_DR_MODE_HOST ? "host" : "gadget");
105 void dwc3_set_prtcap(struct dwc3 *dwc, u32 mode)
109 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
110 reg &= ~(DWC3_GCTL_PRTCAPDIR(DWC3_GCTL_PRTCAP_OTG));
111 reg |= DWC3_GCTL_PRTCAPDIR(mode);
112 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
114 dwc->current_dr_role = mode;
117 static int dwc3_core_soft_reset(struct dwc3 *dwc);
119 static void __dwc3_set_mode(struct work_struct *work)
121 struct dwc3 *dwc = work_to_dwc(work);
126 mutex_lock(&dwc->mutex);
128 pm_runtime_get_sync(dwc->dev);
130 if (dwc->current_dr_role == DWC3_GCTL_PRTCAP_OTG)
131 dwc3_otg_update(dwc, 0);
133 if (!dwc->desired_dr_role)
136 if (dwc->desired_dr_role == dwc->current_dr_role)
139 if (dwc->desired_dr_role == DWC3_GCTL_PRTCAP_OTG && dwc->edev)
142 switch (dwc->current_dr_role) {
143 case DWC3_GCTL_PRTCAP_HOST:
146 case DWC3_GCTL_PRTCAP_DEVICE:
147 dwc3_gadget_exit(dwc);
148 dwc3_event_buffers_cleanup(dwc);
150 case DWC3_GCTL_PRTCAP_OTG:
152 spin_lock_irqsave(&dwc->lock, flags);
153 dwc->desired_otg_role = DWC3_OTG_ROLE_IDLE;
154 spin_unlock_irqrestore(&dwc->lock, flags);
155 dwc3_otg_update(dwc, 1);
161 /* For DRD host or device mode only */
162 if (dwc->desired_dr_role != DWC3_GCTL_PRTCAP_OTG) {
163 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
164 reg |= DWC3_GCTL_CORESOFTRESET;
165 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
168 * Wait for internal clocks to synchronized. DWC_usb31 and
169 * DWC_usb32 may need at least 50ms (less for DWC_usb3). To
170 * keep it consistent across different IPs, let's wait up to
171 * 100ms before clearing GCTL.CORESOFTRESET.
175 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
176 reg &= ~DWC3_GCTL_CORESOFTRESET;
177 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
180 spin_lock_irqsave(&dwc->lock, flags);
182 dwc3_set_prtcap(dwc, dwc->desired_dr_role);
184 spin_unlock_irqrestore(&dwc->lock, flags);
186 switch (dwc->desired_dr_role) {
187 case DWC3_GCTL_PRTCAP_HOST:
188 ret = dwc3_host_init(dwc);
190 dev_err(dwc->dev, "failed to initialize host\n");
193 otg_set_vbus(dwc->usb2_phy->otg, true);
194 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_HOST);
195 phy_set_mode(dwc->usb3_generic_phy, PHY_MODE_USB_HOST);
196 if (dwc->dis_split_quirk) {
197 reg = dwc3_readl(dwc->regs, DWC3_GUCTL3);
198 reg |= DWC3_GUCTL3_SPLITDISABLE;
199 dwc3_writel(dwc->regs, DWC3_GUCTL3, reg);
203 case DWC3_GCTL_PRTCAP_DEVICE:
204 dwc3_core_soft_reset(dwc);
206 dwc3_event_buffers_setup(dwc);
209 otg_set_vbus(dwc->usb2_phy->otg, false);
210 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_DEVICE);
211 phy_set_mode(dwc->usb3_generic_phy, PHY_MODE_USB_DEVICE);
213 ret = dwc3_gadget_init(dwc);
215 dev_err(dwc->dev, "failed to initialize peripheral\n");
217 case DWC3_GCTL_PRTCAP_OTG:
219 dwc3_otg_update(dwc, 0);
226 pm_runtime_mark_last_busy(dwc->dev);
227 pm_runtime_put_autosuspend(dwc->dev);
228 mutex_unlock(&dwc->mutex);
231 void dwc3_set_mode(struct dwc3 *dwc, u32 mode)
235 if (dwc->dr_mode != USB_DR_MODE_OTG)
238 spin_lock_irqsave(&dwc->lock, flags);
239 dwc->desired_dr_role = mode;
240 spin_unlock_irqrestore(&dwc->lock, flags);
242 queue_work(system_freezable_wq, &dwc->drd_work);
245 u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type)
247 struct dwc3 *dwc = dep->dwc;
250 dwc3_writel(dwc->regs, DWC3_GDBGFIFOSPACE,
251 DWC3_GDBGFIFOSPACE_NUM(dep->number) |
252 DWC3_GDBGFIFOSPACE_TYPE(type));
254 reg = dwc3_readl(dwc->regs, DWC3_GDBGFIFOSPACE);
256 return DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(reg);
260 * dwc3_core_soft_reset - Issues core soft reset and PHY reset
261 * @dwc: pointer to our context structure
263 static int dwc3_core_soft_reset(struct dwc3 *dwc)
269 usb_phy_init(dwc->usb2_phy);
270 usb_phy_init(dwc->usb3_phy);
271 ret = phy_init(dwc->usb2_generic_phy);
275 ret = phy_init(dwc->usb3_generic_phy);
277 phy_exit(dwc->usb2_generic_phy);
282 * We're resetting only the device side because, if we're in host mode,
283 * XHCI driver will reset the host block. If dwc3 was configured for
284 * host-only mode, then we can return early.
286 if (dwc->current_dr_role == DWC3_GCTL_PRTCAP_HOST)
289 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
290 reg |= DWC3_DCTL_CSFTRST;
291 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
294 * For DWC_usb31 controller 1.90a and later, the DCTL.CSFRST bit
295 * is cleared only after all the clocks are synchronized. This can
296 * take a little more than 50ms. Set the polling rate at 20ms
297 * for 10 times instead.
299 if (DWC3_VER_IS_WITHIN(DWC31, 190A, ANY) || DWC3_IP_IS(DWC32))
303 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
304 if (!(reg & DWC3_DCTL_CSFTRST))
307 if (DWC3_VER_IS_WITHIN(DWC31, 190A, ANY) || DWC3_IP_IS(DWC32))
313 phy_exit(dwc->usb3_generic_phy);
314 phy_exit(dwc->usb2_generic_phy);
320 * For DWC_usb31 controller 1.80a and prior, once DCTL.CSFRST bit
321 * is cleared, we must wait at least 50ms before accessing the PHY
322 * domain (synchronization delay).
324 if (DWC3_VER_IS_WITHIN(DWC31, ANY, 180A))
331 * dwc3_frame_length_adjustment - Adjusts frame length if required
332 * @dwc3: Pointer to our controller context structure
334 static void dwc3_frame_length_adjustment(struct dwc3 *dwc)
339 if (DWC3_VER_IS_PRIOR(DWC3, 250A))
345 reg = dwc3_readl(dwc->regs, DWC3_GFLADJ);
346 dft = reg & DWC3_GFLADJ_30MHZ_MASK;
347 if (dft != dwc->fladj) {
348 reg &= ~DWC3_GFLADJ_30MHZ_MASK;
349 reg |= DWC3_GFLADJ_30MHZ_SDBND_SEL | dwc->fladj;
350 dwc3_writel(dwc->regs, DWC3_GFLADJ, reg);
355 * dwc3_free_one_event_buffer - Frees one event buffer
356 * @dwc: Pointer to our controller context structure
357 * @evt: Pointer to event buffer to be freed
359 static void dwc3_free_one_event_buffer(struct dwc3 *dwc,
360 struct dwc3_event_buffer *evt)
362 dma_free_coherent(dwc->sysdev, evt->length, evt->buf, evt->dma);
366 * dwc3_alloc_one_event_buffer - Allocates one event buffer structure
367 * @dwc: Pointer to our controller context structure
368 * @length: size of the event buffer
370 * Returns a pointer to the allocated event buffer structure on success
371 * otherwise ERR_PTR(errno).
373 static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
376 struct dwc3_event_buffer *evt;
378 evt = devm_kzalloc(dwc->dev, sizeof(*evt), GFP_KERNEL);
380 return ERR_PTR(-ENOMEM);
383 evt->length = length;
384 evt->cache = devm_kzalloc(dwc->dev, length, GFP_KERNEL);
386 return ERR_PTR(-ENOMEM);
388 evt->buf = dma_alloc_coherent(dwc->sysdev, length,
389 &evt->dma, GFP_KERNEL);
391 return ERR_PTR(-ENOMEM);
397 * dwc3_free_event_buffers - frees all allocated event buffers
398 * @dwc: Pointer to our controller context structure
400 static void dwc3_free_event_buffers(struct dwc3 *dwc)
402 struct dwc3_event_buffer *evt;
406 dwc3_free_one_event_buffer(dwc, evt);
410 * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
411 * @dwc: pointer to our controller context structure
412 * @length: size of event buffer
414 * Returns 0 on success otherwise negative errno. In the error case, dwc
415 * may contain some buffers allocated but not all which were requested.
417 static int dwc3_alloc_event_buffers(struct dwc3 *dwc, unsigned length)
419 struct dwc3_event_buffer *evt;
421 evt = dwc3_alloc_one_event_buffer(dwc, length);
423 dev_err(dwc->dev, "can't allocate event buffer\n");
432 * dwc3_event_buffers_setup - setup our allocated event buffers
433 * @dwc: pointer to our controller context structure
435 * Returns 0 on success otherwise negative errno.
437 int dwc3_event_buffers_setup(struct dwc3 *dwc)
439 struct dwc3_event_buffer *evt;
443 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0),
444 lower_32_bits(evt->dma));
445 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0),
446 upper_32_bits(evt->dma));
447 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0),
448 DWC3_GEVNTSIZ_SIZE(evt->length));
449 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
454 void dwc3_event_buffers_cleanup(struct dwc3 *dwc)
456 struct dwc3_event_buffer *evt;
462 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(0), 0);
463 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(0), 0);
464 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(0), DWC3_GEVNTSIZ_INTMASK
465 | DWC3_GEVNTSIZ_SIZE(0));
466 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(0), 0);
469 static int dwc3_alloc_scratch_buffers(struct dwc3 *dwc)
471 if (!dwc->has_hibernation)
474 if (!dwc->nr_scratch)
477 dwc->scratchbuf = kmalloc_array(dwc->nr_scratch,
478 DWC3_SCRATCHBUF_SIZE, GFP_KERNEL);
479 if (!dwc->scratchbuf)
485 static int dwc3_setup_scratch_buffers(struct dwc3 *dwc)
487 dma_addr_t scratch_addr;
491 if (!dwc->has_hibernation)
494 if (!dwc->nr_scratch)
497 /* should never fall here */
498 if (!WARN_ON(dwc->scratchbuf))
501 scratch_addr = dma_map_single(dwc->sysdev, dwc->scratchbuf,
502 dwc->nr_scratch * DWC3_SCRATCHBUF_SIZE,
504 if (dma_mapping_error(dwc->sysdev, scratch_addr)) {
505 dev_err(dwc->sysdev, "failed to map scratch buffer\n");
510 dwc->scratch_addr = scratch_addr;
512 param = lower_32_bits(scratch_addr);
514 ret = dwc3_send_gadget_generic_command(dwc,
515 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO, param);
519 param = upper_32_bits(scratch_addr);
521 ret = dwc3_send_gadget_generic_command(dwc,
522 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI, param);
529 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
530 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
536 static void dwc3_free_scratch_buffers(struct dwc3 *dwc)
538 if (!dwc->has_hibernation)
541 if (!dwc->nr_scratch)
544 /* should never fall here */
545 if (!WARN_ON(dwc->scratchbuf))
548 dma_unmap_single(dwc->sysdev, dwc->scratch_addr, dwc->nr_scratch *
549 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
550 kfree(dwc->scratchbuf);
553 static void dwc3_core_num_eps(struct dwc3 *dwc)
555 struct dwc3_hwparams *parms = &dwc->hwparams;
557 dwc->num_eps = DWC3_NUM_EPS(parms);
560 static void dwc3_cache_hwparams(struct dwc3 *dwc)
562 struct dwc3_hwparams *parms = &dwc->hwparams;
564 parms->hwparams0 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS0);
565 parms->hwparams1 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS1);
566 parms->hwparams2 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS2);
567 parms->hwparams3 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS3);
568 parms->hwparams4 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS4);
569 parms->hwparams5 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS5);
570 parms->hwparams6 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS6);
571 parms->hwparams7 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS7);
572 parms->hwparams8 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS8);
574 if (DWC3_IP_IS(DWC32))
575 parms->hwparams9 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS9);
578 static int dwc3_core_ulpi_init(struct dwc3 *dwc)
583 intf = DWC3_GHWPARAMS3_HSPHY_IFC(dwc->hwparams.hwparams3);
585 if (intf == DWC3_GHWPARAMS3_HSPHY_IFC_ULPI ||
586 (intf == DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI &&
587 dwc->hsphy_interface &&
588 !strncmp(dwc->hsphy_interface, "ulpi", 4)))
589 ret = dwc3_ulpi_init(dwc);
595 * dwc3_phy_setup - Configure USB PHY Interface of DWC3 Core
596 * @dwc: Pointer to our controller context structure
598 * Returns 0 on success. The USB PHY interfaces are configured but not
599 * initialized. The PHY interfaces and the PHYs get initialized together with
600 * the core in dwc3_core_init.
602 static int dwc3_phy_setup(struct dwc3 *dwc)
604 unsigned int hw_mode;
607 hw_mode = DWC3_GHWPARAMS0_MODE(dwc->hwparams.hwparams0);
609 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
612 * Make sure UX_EXIT_PX is cleared as that causes issues with some
613 * PHYs. Also, this bit is not supposed to be used in normal operation.
615 reg &= ~DWC3_GUSB3PIPECTL_UX_EXIT_PX;
618 * Above 1.94a, it is recommended to set DWC3_GUSB3PIPECTL_SUSPHY
619 * to '0' during coreConsultant configuration. So default value
620 * will be '0' when the core is reset. Application needs to set it
621 * to '1' after the core initialization is completed.
623 if (!DWC3_VER_IS_WITHIN(DWC3, ANY, 194A))
624 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
627 * For DRD controllers, GUSB3PIPECTL.SUSPENDENABLE must be cleared after
628 * power-on reset, and it can be set after core initialization, which is
629 * after device soft-reset during initialization.
631 if (hw_mode == DWC3_GHWPARAMS0_MODE_DRD)
632 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
634 if (dwc->u2ss_inp3_quirk)
635 reg |= DWC3_GUSB3PIPECTL_U2SSINP3OK;
637 if (dwc->dis_rxdet_inp3_quirk)
638 reg |= DWC3_GUSB3PIPECTL_DISRXDETINP3;
640 if (dwc->req_p1p2p3_quirk)
641 reg |= DWC3_GUSB3PIPECTL_REQP1P2P3;
643 if (dwc->del_p1p2p3_quirk)
644 reg |= DWC3_GUSB3PIPECTL_DEP1P2P3_EN;
646 if (dwc->del_phy_power_chg_quirk)
647 reg |= DWC3_GUSB3PIPECTL_DEPOCHANGE;
649 if (dwc->lfps_filter_quirk)
650 reg |= DWC3_GUSB3PIPECTL_LFPSFILT;
652 if (dwc->rx_detect_poll_quirk)
653 reg |= DWC3_GUSB3PIPECTL_RX_DETOPOLL;
655 if (dwc->tx_de_emphasis_quirk)
656 reg |= DWC3_GUSB3PIPECTL_TX_DEEPH(dwc->tx_de_emphasis);
658 if (dwc->dis_u3_susphy_quirk)
659 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
661 if (dwc->dis_del_phy_power_chg_quirk)
662 reg &= ~DWC3_GUSB3PIPECTL_DEPOCHANGE;
664 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
666 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
668 /* Select the HS PHY interface */
669 switch (DWC3_GHWPARAMS3_HSPHY_IFC(dwc->hwparams.hwparams3)) {
670 case DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI:
671 if (dwc->hsphy_interface &&
672 !strncmp(dwc->hsphy_interface, "utmi", 4)) {
673 reg &= ~DWC3_GUSB2PHYCFG_ULPI_UTMI;
675 } else if (dwc->hsphy_interface &&
676 !strncmp(dwc->hsphy_interface, "ulpi", 4)) {
677 reg |= DWC3_GUSB2PHYCFG_ULPI_UTMI;
678 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
680 /* Relying on default value. */
681 if (!(reg & DWC3_GUSB2PHYCFG_ULPI_UTMI))
685 case DWC3_GHWPARAMS3_HSPHY_IFC_ULPI:
690 switch (dwc->hsphy_mode) {
691 case USBPHY_INTERFACE_MODE_UTMI:
692 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
693 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
694 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_8_BIT) |
695 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_8_BIT);
697 case USBPHY_INTERFACE_MODE_UTMIW:
698 reg &= ~(DWC3_GUSB2PHYCFG_PHYIF_MASK |
699 DWC3_GUSB2PHYCFG_USBTRDTIM_MASK);
700 reg |= DWC3_GUSB2PHYCFG_PHYIF(UTMI_PHYIF_16_BIT) |
701 DWC3_GUSB2PHYCFG_USBTRDTIM(USBTRDTIM_UTMI_16_BIT);
708 * Above 1.94a, it is recommended to set DWC3_GUSB2PHYCFG_SUSPHY to
709 * '0' during coreConsultant configuration. So default value will
710 * be '0' when the core is reset. Application needs to set it to
711 * '1' after the core initialization is completed.
713 if (!DWC3_VER_IS_WITHIN(DWC3, ANY, 194A))
714 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
717 * For DRD controllers, GUSB2PHYCFG.SUSPHY must be cleared after
718 * power-on reset, and it can be set after core initialization, which is
719 * after device soft-reset during initialization.
721 if (hw_mode == DWC3_GHWPARAMS0_MODE_DRD)
722 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
724 if (dwc->dis_u2_susphy_quirk)
725 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
727 if (dwc->dis_enblslpm_quirk)
728 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
730 reg |= DWC3_GUSB2PHYCFG_ENBLSLPM;
732 if (dwc->dis_u2_freeclk_exists_quirk)
733 reg &= ~DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS;
735 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
740 static void dwc3_core_exit(struct dwc3 *dwc)
742 dwc3_event_buffers_cleanup(dwc);
744 usb_phy_shutdown(dwc->usb2_phy);
745 usb_phy_shutdown(dwc->usb3_phy);
746 phy_exit(dwc->usb2_generic_phy);
747 phy_exit(dwc->usb3_generic_phy);
749 usb_phy_set_suspend(dwc->usb2_phy, 1);
750 usb_phy_set_suspend(dwc->usb3_phy, 1);
751 phy_power_off(dwc->usb2_generic_phy);
752 phy_power_off(dwc->usb3_generic_phy);
753 clk_bulk_disable_unprepare(dwc->num_clks, dwc->clks);
754 reset_control_assert(dwc->reset);
757 static bool dwc3_core_is_valid(struct dwc3 *dwc)
761 reg = dwc3_readl(dwc->regs, DWC3_GSNPSID);
762 dwc->ip = DWC3_GSNPS_ID(reg);
764 /* This should read as U3 followed by revision number */
765 if (DWC3_IP_IS(DWC3)) {
767 } else if (DWC3_IP_IS(DWC31) || DWC3_IP_IS(DWC32)) {
768 dwc->revision = dwc3_readl(dwc->regs, DWC3_VER_NUMBER);
769 dwc->version_type = dwc3_readl(dwc->regs, DWC3_VER_TYPE);
777 static void dwc3_core_setup_global_control(struct dwc3 *dwc)
779 u32 hwparams4 = dwc->hwparams.hwparams4;
782 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
783 reg &= ~DWC3_GCTL_SCALEDOWN_MASK;
785 switch (DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1)) {
786 case DWC3_GHWPARAMS1_EN_PWROPT_CLK:
788 * WORKAROUND: DWC3 revisions between 2.10a and 2.50a have an
789 * issue which would cause xHCI compliance tests to fail.
791 * Because of that we cannot enable clock gating on such
796 * STAR#9000588375: Clock Gating, SOF Issues when ref_clk-Based
799 if ((dwc->dr_mode == USB_DR_MODE_HOST ||
800 dwc->dr_mode == USB_DR_MODE_OTG) &&
801 DWC3_VER_IS_WITHIN(DWC3, 210A, 250A))
802 reg |= DWC3_GCTL_DSBLCLKGTNG | DWC3_GCTL_SOFITPSYNC;
804 reg &= ~DWC3_GCTL_DSBLCLKGTNG;
806 case DWC3_GHWPARAMS1_EN_PWROPT_HIB:
807 /* enable hibernation here */
808 dwc->nr_scratch = DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(hwparams4);
811 * REVISIT Enabling this bit so that host-mode hibernation
812 * will work. Device-mode hibernation is not yet implemented.
814 reg |= DWC3_GCTL_GBLHIBERNATIONEN;
821 /* check if current dwc3 is on simulation board */
822 if (dwc->hwparams.hwparams6 & DWC3_GHWPARAMS6_EN_FPGA) {
823 dev_info(dwc->dev, "Running with FPGA optimizations\n");
827 WARN_ONCE(dwc->disable_scramble_quirk && !dwc->is_fpga,
828 "disable_scramble cannot be used on non-FPGA builds\n");
830 if (dwc->disable_scramble_quirk && dwc->is_fpga)
831 reg |= DWC3_GCTL_DISSCRAMBLE;
833 reg &= ~DWC3_GCTL_DISSCRAMBLE;
835 if (dwc->u2exit_lfps_quirk)
836 reg |= DWC3_GCTL_U2EXIT_LFPS;
839 * WORKAROUND: DWC3 revisions <1.90a have a bug
840 * where the device can fail to connect at SuperSpeed
841 * and falls back to high-speed mode which causes
842 * the device to enter a Connect/Disconnect loop
844 if (DWC3_VER_IS_PRIOR(DWC3, 190A))
845 reg |= DWC3_GCTL_U2RSTECN;
847 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
850 static int dwc3_core_get_phy(struct dwc3 *dwc);
851 static int dwc3_core_ulpi_init(struct dwc3 *dwc);
853 /* set global incr burst type configuration registers */
854 static void dwc3_set_incr_burst_type(struct dwc3 *dwc)
856 struct device *dev = dwc->dev;
857 /* incrx_mode : for INCR burst type. */
859 /* incrx_size : for size of INCRX burst. */
867 cfg = dwc3_readl(dwc->regs, DWC3_GSBUSCFG0);
870 * Handle property "snps,incr-burst-type-adjustment".
871 * Get the number of value from this property:
872 * result <= 0, means this property is not supported.
873 * result = 1, means INCRx burst mode supported.
874 * result > 1, means undefined length burst mode supported.
876 ntype = device_property_count_u32(dev, "snps,incr-burst-type-adjustment");
880 vals = kcalloc(ntype, sizeof(u32), GFP_KERNEL);
882 dev_err(dev, "Error to get memory\n");
886 /* Get INCR burst type, and parse it */
887 ret = device_property_read_u32_array(dev,
888 "snps,incr-burst-type-adjustment", vals, ntype);
891 dev_err(dev, "Error to get property\n");
898 /* INCRX (undefined length) burst mode */
899 incrx_mode = INCRX_UNDEF_LENGTH_BURST_MODE;
900 for (i = 1; i < ntype; i++) {
901 if (vals[i] > incrx_size)
902 incrx_size = vals[i];
905 /* INCRX burst mode */
906 incrx_mode = INCRX_BURST_MODE;
911 /* Enable Undefined Length INCR Burst and Enable INCRx Burst */
912 cfg &= ~DWC3_GSBUSCFG0_INCRBRST_MASK;
914 cfg |= DWC3_GSBUSCFG0_INCRBRSTENA;
915 switch (incrx_size) {
917 cfg |= DWC3_GSBUSCFG0_INCR256BRSTENA;
920 cfg |= DWC3_GSBUSCFG0_INCR128BRSTENA;
923 cfg |= DWC3_GSBUSCFG0_INCR64BRSTENA;
926 cfg |= DWC3_GSBUSCFG0_INCR32BRSTENA;
929 cfg |= DWC3_GSBUSCFG0_INCR16BRSTENA;
932 cfg |= DWC3_GSBUSCFG0_INCR8BRSTENA;
935 cfg |= DWC3_GSBUSCFG0_INCR4BRSTENA;
940 dev_err(dev, "Invalid property\n");
944 dwc3_writel(dwc->regs, DWC3_GSBUSCFG0, cfg);
948 * dwc3_core_init - Low-level initialization of DWC3 Core
949 * @dwc: Pointer to our controller context structure
951 * Returns 0 on success otherwise negative errno.
953 static int dwc3_core_init(struct dwc3 *dwc)
955 unsigned int hw_mode;
959 hw_mode = DWC3_GHWPARAMS0_MODE(dwc->hwparams.hwparams0);
962 * Write Linux Version Code to our GUID register so it's easy to figure
963 * out which kernel version a bug was found.
965 dwc3_writel(dwc->regs, DWC3_GUID, LINUX_VERSION_CODE);
967 ret = dwc3_phy_setup(dwc);
971 if (!dwc->ulpi_ready) {
972 ret = dwc3_core_ulpi_init(dwc);
975 dwc->ulpi_ready = true;
978 if (!dwc->phys_ready) {
979 ret = dwc3_core_get_phy(dwc);
982 dwc->phys_ready = true;
985 ret = dwc3_core_soft_reset(dwc);
989 if (hw_mode == DWC3_GHWPARAMS0_MODE_DRD &&
990 !DWC3_VER_IS_WITHIN(DWC3, ANY, 194A)) {
991 if (!dwc->dis_u3_susphy_quirk) {
992 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
993 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
994 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
997 if (!dwc->dis_u2_susphy_quirk) {
998 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
999 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
1000 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
1004 dwc3_core_setup_global_control(dwc);
1005 dwc3_core_num_eps(dwc);
1007 ret = dwc3_setup_scratch_buffers(dwc);
1011 /* Adjust Frame Length */
1012 dwc3_frame_length_adjustment(dwc);
1014 dwc3_set_incr_burst_type(dwc);
1016 usb_phy_set_suspend(dwc->usb2_phy, 0);
1017 usb_phy_set_suspend(dwc->usb3_phy, 0);
1018 ret = phy_power_on(dwc->usb2_generic_phy);
1022 ret = phy_power_on(dwc->usb3_generic_phy);
1026 ret = dwc3_event_buffers_setup(dwc);
1028 dev_err(dwc->dev, "failed to setup event buffers\n");
1033 * ENDXFER polling is available on version 3.10a and later of
1034 * the DWC_usb3 controller. It is NOT available in the
1035 * DWC_usb31 controller.
1037 if (DWC3_VER_IS_WITHIN(DWC3, 310A, ANY)) {
1038 reg = dwc3_readl(dwc->regs, DWC3_GUCTL2);
1039 reg |= DWC3_GUCTL2_RST_ACTBITLATER;
1040 dwc3_writel(dwc->regs, DWC3_GUCTL2, reg);
1043 if (!DWC3_VER_IS_PRIOR(DWC3, 250A)) {
1044 reg = dwc3_readl(dwc->regs, DWC3_GUCTL1);
1047 * Enable hardware control of sending remote wakeup
1048 * in HS when the device is in the L1 state.
1050 if (!DWC3_VER_IS_PRIOR(DWC3, 290A))
1051 reg |= DWC3_GUCTL1_DEV_L1_EXIT_BY_HW;
1053 if (dwc->dis_tx_ipgap_linecheck_quirk)
1054 reg |= DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS;
1056 if (dwc->parkmode_disable_ss_quirk)
1057 reg |= DWC3_GUCTL1_PARKMODE_DISABLE_SS;
1059 dwc3_writel(dwc->regs, DWC3_GUCTL1, reg);
1062 if (dwc->dr_mode == USB_DR_MODE_HOST ||
1063 dwc->dr_mode == USB_DR_MODE_OTG) {
1064 reg = dwc3_readl(dwc->regs, DWC3_GUCTL);
1067 * Enable Auto retry Feature to make the controller operating in
1068 * Host mode on seeing transaction errors(CRC errors or internal
1069 * overrun scenerios) on IN transfers to reply to the device
1070 * with a non-terminating retry ACK (i.e, an ACK transcation
1071 * packet with Retry=1 & Nump != 0)
1073 reg |= DWC3_GUCTL_HSTINAUTORETRY;
1075 dwc3_writel(dwc->regs, DWC3_GUCTL, reg);
1079 * Must config both number of packets and max burst settings to enable
1080 * RX and/or TX threshold.
1082 if (!DWC3_IP_IS(DWC3) && dwc->dr_mode == USB_DR_MODE_HOST) {
1083 u8 rx_thr_num = dwc->rx_thr_num_pkt_prd;
1084 u8 rx_maxburst = dwc->rx_max_burst_prd;
1085 u8 tx_thr_num = dwc->tx_thr_num_pkt_prd;
1086 u8 tx_maxburst = dwc->tx_max_burst_prd;
1088 if (rx_thr_num && rx_maxburst) {
1089 reg = dwc3_readl(dwc->regs, DWC3_GRXTHRCFG);
1090 reg |= DWC31_RXTHRNUMPKTSEL_PRD;
1092 reg &= ~DWC31_RXTHRNUMPKT_PRD(~0);
1093 reg |= DWC31_RXTHRNUMPKT_PRD(rx_thr_num);
1095 reg &= ~DWC31_MAXRXBURSTSIZE_PRD(~0);
1096 reg |= DWC31_MAXRXBURSTSIZE_PRD(rx_maxburst);
1098 dwc3_writel(dwc->regs, DWC3_GRXTHRCFG, reg);
1101 if (tx_thr_num && tx_maxburst) {
1102 reg = dwc3_readl(dwc->regs, DWC3_GTXTHRCFG);
1103 reg |= DWC31_TXTHRNUMPKTSEL_PRD;
1105 reg &= ~DWC31_TXTHRNUMPKT_PRD(~0);
1106 reg |= DWC31_TXTHRNUMPKT_PRD(tx_thr_num);
1108 reg &= ~DWC31_MAXTXBURSTSIZE_PRD(~0);
1109 reg |= DWC31_MAXTXBURSTSIZE_PRD(tx_maxburst);
1111 dwc3_writel(dwc->regs, DWC3_GTXTHRCFG, reg);
1118 phy_power_off(dwc->usb3_generic_phy);
1121 phy_power_off(dwc->usb2_generic_phy);
1124 usb_phy_set_suspend(dwc->usb2_phy, 1);
1125 usb_phy_set_suspend(dwc->usb3_phy, 1);
1128 usb_phy_shutdown(dwc->usb2_phy);
1129 usb_phy_shutdown(dwc->usb3_phy);
1130 phy_exit(dwc->usb2_generic_phy);
1131 phy_exit(dwc->usb3_generic_phy);
1134 dwc3_ulpi_exit(dwc);
1140 static int dwc3_core_get_phy(struct dwc3 *dwc)
1142 struct device *dev = dwc->dev;
1143 struct device_node *node = dev->of_node;
1147 dwc->usb2_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 0);
1148 dwc->usb3_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 1);
1150 dwc->usb2_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
1151 dwc->usb3_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB3);
1154 if (IS_ERR(dwc->usb2_phy)) {
1155 ret = PTR_ERR(dwc->usb2_phy);
1156 if (ret == -ENXIO || ret == -ENODEV) {
1157 dwc->usb2_phy = NULL;
1159 return dev_err_probe(dev, ret, "no usb2 phy configured\n");
1163 if (IS_ERR(dwc->usb3_phy)) {
1164 ret = PTR_ERR(dwc->usb3_phy);
1165 if (ret == -ENXIO || ret == -ENODEV) {
1166 dwc->usb3_phy = NULL;
1168 return dev_err_probe(dev, ret, "no usb3 phy configured\n");
1172 dwc->usb2_generic_phy = devm_phy_get(dev, "usb2-phy");
1173 if (IS_ERR(dwc->usb2_generic_phy)) {
1174 ret = PTR_ERR(dwc->usb2_generic_phy);
1175 if (ret == -ENOSYS || ret == -ENODEV) {
1176 dwc->usb2_generic_phy = NULL;
1178 return dev_err_probe(dev, ret, "no usb2 phy configured\n");
1182 dwc->usb3_generic_phy = devm_phy_get(dev, "usb3-phy");
1183 if (IS_ERR(dwc->usb3_generic_phy)) {
1184 ret = PTR_ERR(dwc->usb3_generic_phy);
1185 if (ret == -ENOSYS || ret == -ENODEV) {
1186 dwc->usb3_generic_phy = NULL;
1188 return dev_err_probe(dev, ret, "no usb3 phy configured\n");
1195 static int dwc3_core_init_mode(struct dwc3 *dwc)
1197 struct device *dev = dwc->dev;
1200 switch (dwc->dr_mode) {
1201 case USB_DR_MODE_PERIPHERAL:
1202 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_DEVICE);
1205 otg_set_vbus(dwc->usb2_phy->otg, false);
1206 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_DEVICE);
1207 phy_set_mode(dwc->usb3_generic_phy, PHY_MODE_USB_DEVICE);
1209 ret = dwc3_gadget_init(dwc);
1211 return dev_err_probe(dev, ret, "failed to initialize gadget\n");
1213 case USB_DR_MODE_HOST:
1214 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_HOST);
1217 otg_set_vbus(dwc->usb2_phy->otg, true);
1218 phy_set_mode(dwc->usb2_generic_phy, PHY_MODE_USB_HOST);
1219 phy_set_mode(dwc->usb3_generic_phy, PHY_MODE_USB_HOST);
1221 ret = dwc3_host_init(dwc);
1223 return dev_err_probe(dev, ret, "failed to initialize host\n");
1225 case USB_DR_MODE_OTG:
1226 INIT_WORK(&dwc->drd_work, __dwc3_set_mode);
1227 ret = dwc3_drd_init(dwc);
1229 return dev_err_probe(dev, ret, "failed to initialize dual-role\n");
1232 dev_err(dev, "Unsupported mode of operation %d\n", dwc->dr_mode);
1239 static void dwc3_core_exit_mode(struct dwc3 *dwc)
1241 switch (dwc->dr_mode) {
1242 case USB_DR_MODE_PERIPHERAL:
1243 dwc3_gadget_exit(dwc);
1245 case USB_DR_MODE_HOST:
1246 dwc3_host_exit(dwc);
1248 case USB_DR_MODE_OTG:
1256 /* de-assert DRVVBUS for HOST and OTG mode */
1257 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_DEVICE);
1260 static void dwc3_get_properties(struct dwc3 *dwc)
1262 struct device *dev = dwc->dev;
1263 u8 lpm_nyet_threshold;
1266 u8 rx_thr_num_pkt_prd;
1267 u8 rx_max_burst_prd;
1268 u8 tx_thr_num_pkt_prd;
1269 u8 tx_max_burst_prd;
1270 const char *usb_psy_name;
1273 /* default to highest possible threshold */
1274 lpm_nyet_threshold = 0xf;
1276 /* default to -3.5dB de-emphasis */
1280 * default to assert utmi_sleep_n and use maximum allowed HIRD
1281 * threshold value of 0b1100
1283 hird_threshold = 12;
1285 dwc->maximum_speed = usb_get_maximum_speed(dev);
1286 dwc->max_ssp_rate = usb_get_maximum_ssp_rate(dev);
1287 dwc->dr_mode = usb_get_dr_mode(dev);
1288 dwc->hsphy_mode = of_usb_get_phy_mode(dev->of_node);
1290 dwc->sysdev_is_parent = device_property_read_bool(dev,
1291 "linux,sysdev_is_parent");
1292 if (dwc->sysdev_is_parent)
1293 dwc->sysdev = dwc->dev->parent;
1295 dwc->sysdev = dwc->dev;
1297 ret = device_property_read_string(dev, "usb-psy-name", &usb_psy_name);
1299 dwc->usb_psy = power_supply_get_by_name(usb_psy_name);
1301 dev_err(dev, "couldn't get usb power supply\n");
1304 dwc->has_lpm_erratum = device_property_read_bool(dev,
1305 "snps,has-lpm-erratum");
1306 device_property_read_u8(dev, "snps,lpm-nyet-threshold",
1307 &lpm_nyet_threshold);
1308 dwc->is_utmi_l1_suspend = device_property_read_bool(dev,
1309 "snps,is-utmi-l1-suspend");
1310 device_property_read_u8(dev, "snps,hird-threshold",
1312 dwc->dis_start_transfer_quirk = device_property_read_bool(dev,
1313 "snps,dis-start-transfer-quirk");
1314 dwc->usb3_lpm_capable = device_property_read_bool(dev,
1315 "snps,usb3_lpm_capable");
1316 dwc->usb2_lpm_disable = device_property_read_bool(dev,
1317 "snps,usb2-lpm-disable");
1318 dwc->usb2_gadget_lpm_disable = device_property_read_bool(dev,
1319 "snps,usb2-gadget-lpm-disable");
1320 device_property_read_u8(dev, "snps,rx-thr-num-pkt-prd",
1321 &rx_thr_num_pkt_prd);
1322 device_property_read_u8(dev, "snps,rx-max-burst-prd",
1324 device_property_read_u8(dev, "snps,tx-thr-num-pkt-prd",
1325 &tx_thr_num_pkt_prd);
1326 device_property_read_u8(dev, "snps,tx-max-burst-prd",
1329 dwc->disable_scramble_quirk = device_property_read_bool(dev,
1330 "snps,disable_scramble_quirk");
1331 dwc->u2exit_lfps_quirk = device_property_read_bool(dev,
1332 "snps,u2exit_lfps_quirk");
1333 dwc->u2ss_inp3_quirk = device_property_read_bool(dev,
1334 "snps,u2ss_inp3_quirk");
1335 dwc->req_p1p2p3_quirk = device_property_read_bool(dev,
1336 "snps,req_p1p2p3_quirk");
1337 dwc->del_p1p2p3_quirk = device_property_read_bool(dev,
1338 "snps,del_p1p2p3_quirk");
1339 dwc->del_phy_power_chg_quirk = device_property_read_bool(dev,
1340 "snps,del_phy_power_chg_quirk");
1341 dwc->lfps_filter_quirk = device_property_read_bool(dev,
1342 "snps,lfps_filter_quirk");
1343 dwc->rx_detect_poll_quirk = device_property_read_bool(dev,
1344 "snps,rx_detect_poll_quirk");
1345 dwc->dis_u3_susphy_quirk = device_property_read_bool(dev,
1346 "snps,dis_u3_susphy_quirk");
1347 dwc->dis_u2_susphy_quirk = device_property_read_bool(dev,
1348 "snps,dis_u2_susphy_quirk");
1349 dwc->dis_enblslpm_quirk = device_property_read_bool(dev,
1350 "snps,dis_enblslpm_quirk");
1351 dwc->dis_u1_entry_quirk = device_property_read_bool(dev,
1352 "snps,dis-u1-entry-quirk");
1353 dwc->dis_u2_entry_quirk = device_property_read_bool(dev,
1354 "snps,dis-u2-entry-quirk");
1355 dwc->dis_rxdet_inp3_quirk = device_property_read_bool(dev,
1356 "snps,dis_rxdet_inp3_quirk");
1357 dwc->dis_u2_freeclk_exists_quirk = device_property_read_bool(dev,
1358 "snps,dis-u2-freeclk-exists-quirk");
1359 dwc->dis_del_phy_power_chg_quirk = device_property_read_bool(dev,
1360 "snps,dis-del-phy-power-chg-quirk");
1361 dwc->dis_tx_ipgap_linecheck_quirk = device_property_read_bool(dev,
1362 "snps,dis-tx-ipgap-linecheck-quirk");
1363 dwc->parkmode_disable_ss_quirk = device_property_read_bool(dev,
1364 "snps,parkmode-disable-ss-quirk");
1366 dwc->tx_de_emphasis_quirk = device_property_read_bool(dev,
1367 "snps,tx_de_emphasis_quirk");
1368 device_property_read_u8(dev, "snps,tx_de_emphasis",
1370 device_property_read_string(dev, "snps,hsphy_interface",
1371 &dwc->hsphy_interface);
1372 device_property_read_u32(dev, "snps,quirk-frame-length-adjustment",
1375 dwc->dis_metastability_quirk = device_property_read_bool(dev,
1376 "snps,dis_metastability_quirk");
1378 dwc->dis_split_quirk = device_property_read_bool(dev,
1379 "snps,dis-split-quirk");
1381 dwc->lpm_nyet_threshold = lpm_nyet_threshold;
1382 dwc->tx_de_emphasis = tx_de_emphasis;
1384 dwc->hird_threshold = hird_threshold;
1386 dwc->rx_thr_num_pkt_prd = rx_thr_num_pkt_prd;
1387 dwc->rx_max_burst_prd = rx_max_burst_prd;
1389 dwc->tx_thr_num_pkt_prd = tx_thr_num_pkt_prd;
1390 dwc->tx_max_burst_prd = tx_max_burst_prd;
1392 dwc->imod_interval = 0;
1395 /* check whether the core supports IMOD */
1396 bool dwc3_has_imod(struct dwc3 *dwc)
1398 return DWC3_VER_IS_WITHIN(DWC3, 300A, ANY) ||
1399 DWC3_VER_IS_WITHIN(DWC31, 120A, ANY) ||
1403 static void dwc3_check_params(struct dwc3 *dwc)
1405 struct device *dev = dwc->dev;
1406 unsigned int hwparam_gen =
1407 DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3);
1409 /* Check for proper value of imod_interval */
1410 if (dwc->imod_interval && !dwc3_has_imod(dwc)) {
1411 dev_warn(dwc->dev, "Interrupt moderation not supported\n");
1412 dwc->imod_interval = 0;
1416 * Workaround for STAR 9000961433 which affects only version
1417 * 3.00a of the DWC_usb3 core. This prevents the controller
1418 * interrupt from being masked while handling events. IMOD
1419 * allows us to work around this issue. Enable it for the
1422 if (!dwc->imod_interval &&
1423 DWC3_VER_IS(DWC3, 300A))
1424 dwc->imod_interval = 1;
1426 /* Check the maximum_speed parameter */
1427 switch (dwc->maximum_speed) {
1428 case USB_SPEED_FULL:
1429 case USB_SPEED_HIGH:
1431 case USB_SPEED_SUPER:
1432 if (hwparam_gen == DWC3_GHWPARAMS3_SSPHY_IFC_DIS)
1433 dev_warn(dev, "UDC doesn't support Gen 1\n");
1435 case USB_SPEED_SUPER_PLUS:
1436 if ((DWC3_IP_IS(DWC32) &&
1437 hwparam_gen == DWC3_GHWPARAMS3_SSPHY_IFC_DIS) ||
1438 (!DWC3_IP_IS(DWC32) &&
1439 hwparam_gen != DWC3_GHWPARAMS3_SSPHY_IFC_GEN2))
1440 dev_warn(dev, "UDC doesn't support SSP\n");
1443 dev_err(dev, "invalid maximum_speed parameter %d\n",
1444 dwc->maximum_speed);
1446 case USB_SPEED_UNKNOWN:
1447 switch (hwparam_gen) {
1448 case DWC3_GHWPARAMS3_SSPHY_IFC_GEN2:
1449 dwc->maximum_speed = USB_SPEED_SUPER_PLUS;
1451 case DWC3_GHWPARAMS3_SSPHY_IFC_GEN1:
1452 if (DWC3_IP_IS(DWC32))
1453 dwc->maximum_speed = USB_SPEED_SUPER_PLUS;
1455 dwc->maximum_speed = USB_SPEED_SUPER;
1457 case DWC3_GHWPARAMS3_SSPHY_IFC_DIS:
1458 dwc->maximum_speed = USB_SPEED_HIGH;
1461 dwc->maximum_speed = USB_SPEED_SUPER;
1468 * Currently the controller does not have visibility into the HW
1469 * parameter to determine the maximum number of lanes the HW supports.
1470 * If the number of lanes is not specified in the device property, then
1471 * set the default to support dual-lane for DWC_usb32 and single-lane
1472 * for DWC_usb31 for super-speed-plus.
1474 if (dwc->maximum_speed == USB_SPEED_SUPER_PLUS) {
1475 switch (dwc->max_ssp_rate) {
1476 case USB_SSP_GEN_2x1:
1477 if (hwparam_gen == DWC3_GHWPARAMS3_SSPHY_IFC_GEN1)
1478 dev_warn(dev, "UDC only supports Gen 1\n");
1480 case USB_SSP_GEN_1x2:
1481 case USB_SSP_GEN_2x2:
1482 if (DWC3_IP_IS(DWC31))
1483 dev_warn(dev, "UDC only supports single lane\n");
1485 case USB_SSP_GEN_UNKNOWN:
1487 switch (hwparam_gen) {
1488 case DWC3_GHWPARAMS3_SSPHY_IFC_GEN2:
1489 if (DWC3_IP_IS(DWC32))
1490 dwc->max_ssp_rate = USB_SSP_GEN_2x2;
1492 dwc->max_ssp_rate = USB_SSP_GEN_2x1;
1494 case DWC3_GHWPARAMS3_SSPHY_IFC_GEN1:
1495 if (DWC3_IP_IS(DWC32))
1496 dwc->max_ssp_rate = USB_SSP_GEN_1x2;
1504 static int dwc3_probe(struct platform_device *pdev)
1506 struct device *dev = &pdev->dev;
1507 struct resource *res, dwc_res;
1514 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
1520 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1522 dev_err(dev, "missing memory resource\n");
1526 dwc->xhci_resources[0].start = res->start;
1527 dwc->xhci_resources[0].end = dwc->xhci_resources[0].start +
1529 dwc->xhci_resources[0].flags = res->flags;
1530 dwc->xhci_resources[0].name = res->name;
1533 * Request memory region but exclude xHCI regs,
1534 * since it will be requested by the xhci-plat driver.
1537 dwc_res.start += DWC3_GLOBALS_REGS_START;
1539 regs = devm_ioremap_resource(dev, &dwc_res);
1541 return PTR_ERR(regs);
1544 dwc->regs_size = resource_size(&dwc_res);
1546 dwc3_get_properties(dwc);
1548 ret = dma_set_mask_and_coherent(dwc->sysdev, DMA_BIT_MASK(64));
1552 dwc->reset = devm_reset_control_array_get_optional_shared(dev);
1553 if (IS_ERR(dwc->reset))
1554 return PTR_ERR(dwc->reset);
1557 ret = devm_clk_bulk_get_all(dev, &dwc->clks);
1558 if (ret == -EPROBE_DEFER)
1561 * Clocks are optional, but new DT platforms should support all
1562 * clocks as required by the DT-binding.
1567 dwc->num_clks = ret;
1571 ret = reset_control_deassert(dwc->reset);
1575 ret = clk_bulk_prepare_enable(dwc->num_clks, dwc->clks);
1579 if (!dwc3_core_is_valid(dwc)) {
1580 dev_err(dwc->dev, "this is not a DesignWare USB3 DRD Core\n");
1585 platform_set_drvdata(pdev, dwc);
1586 dwc3_cache_hwparams(dwc);
1588 spin_lock_init(&dwc->lock);
1589 mutex_init(&dwc->mutex);
1591 pm_runtime_set_active(dev);
1592 pm_runtime_use_autosuspend(dev);
1593 pm_runtime_set_autosuspend_delay(dev, DWC3_DEFAULT_AUTOSUSPEND_DELAY);
1594 pm_runtime_enable(dev);
1595 ret = pm_runtime_get_sync(dev);
1599 pm_runtime_forbid(dev);
1601 ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
1603 dev_err(dwc->dev, "failed to allocate event buffers\n");
1608 ret = dwc3_get_dr_mode(dwc);
1612 ret = dwc3_alloc_scratch_buffers(dwc);
1616 ret = dwc3_core_init(dwc);
1618 dev_err_probe(dev, ret, "failed to initialize core\n");
1622 dwc3_check_params(dwc);
1623 dwc3_debugfs_init(dwc);
1625 ret = dwc3_core_init_mode(dwc);
1629 pm_runtime_put(dev);
1634 dwc3_debugfs_exit(dwc);
1635 dwc3_event_buffers_cleanup(dwc);
1637 usb_phy_shutdown(dwc->usb2_phy);
1638 usb_phy_shutdown(dwc->usb3_phy);
1639 phy_exit(dwc->usb2_generic_phy);
1640 phy_exit(dwc->usb3_generic_phy);
1642 usb_phy_set_suspend(dwc->usb2_phy, 1);
1643 usb_phy_set_suspend(dwc->usb3_phy, 1);
1644 phy_power_off(dwc->usb2_generic_phy);
1645 phy_power_off(dwc->usb3_generic_phy);
1647 dwc3_ulpi_exit(dwc);
1650 dwc3_free_scratch_buffers(dwc);
1653 dwc3_free_event_buffers(dwc);
1656 pm_runtime_allow(&pdev->dev);
1659 pm_runtime_put_sync(&pdev->dev);
1660 pm_runtime_disable(&pdev->dev);
1663 clk_bulk_disable_unprepare(dwc->num_clks, dwc->clks);
1665 reset_control_assert(dwc->reset);
1668 power_supply_put(dwc->usb_psy);
1673 static int dwc3_remove(struct platform_device *pdev)
1675 struct dwc3 *dwc = platform_get_drvdata(pdev);
1677 pm_runtime_get_sync(&pdev->dev);
1679 dwc3_core_exit_mode(dwc);
1680 dwc3_debugfs_exit(dwc);
1682 dwc3_core_exit(dwc);
1683 dwc3_ulpi_exit(dwc);
1685 pm_runtime_disable(&pdev->dev);
1686 pm_runtime_put_noidle(&pdev->dev);
1687 pm_runtime_set_suspended(&pdev->dev);
1689 dwc3_free_event_buffers(dwc);
1690 dwc3_free_scratch_buffers(dwc);
1693 power_supply_put(dwc->usb_psy);
1699 static int dwc3_core_init_for_resume(struct dwc3 *dwc)
1703 ret = reset_control_deassert(dwc->reset);
1707 ret = clk_bulk_prepare_enable(dwc->num_clks, dwc->clks);
1711 ret = dwc3_core_init(dwc);
1718 clk_bulk_disable_unprepare(dwc->num_clks, dwc->clks);
1720 reset_control_assert(dwc->reset);
1725 static int dwc3_suspend_common(struct dwc3 *dwc, pm_message_t msg)
1727 unsigned long flags;
1730 switch (dwc->current_dr_role) {
1731 case DWC3_GCTL_PRTCAP_DEVICE:
1732 if (pm_runtime_suspended(dwc->dev))
1734 spin_lock_irqsave(&dwc->lock, flags);
1735 dwc3_gadget_suspend(dwc);
1736 spin_unlock_irqrestore(&dwc->lock, flags);
1737 synchronize_irq(dwc->irq_gadget);
1738 dwc3_core_exit(dwc);
1740 case DWC3_GCTL_PRTCAP_HOST:
1741 if (!PMSG_IS_AUTO(msg)) {
1742 dwc3_core_exit(dwc);
1746 /* Let controller to suspend HSPHY before PHY driver suspends */
1747 if (dwc->dis_u2_susphy_quirk ||
1748 dwc->dis_enblslpm_quirk) {
1749 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
1750 reg |= DWC3_GUSB2PHYCFG_ENBLSLPM |
1751 DWC3_GUSB2PHYCFG_SUSPHY;
1752 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
1754 /* Give some time for USB2 PHY to suspend */
1755 usleep_range(5000, 6000);
1758 phy_pm_runtime_put_sync(dwc->usb2_generic_phy);
1759 phy_pm_runtime_put_sync(dwc->usb3_generic_phy);
1761 case DWC3_GCTL_PRTCAP_OTG:
1762 /* do nothing during runtime_suspend */
1763 if (PMSG_IS_AUTO(msg))
1766 if (dwc->current_otg_role == DWC3_OTG_ROLE_DEVICE) {
1767 spin_lock_irqsave(&dwc->lock, flags);
1768 dwc3_gadget_suspend(dwc);
1769 spin_unlock_irqrestore(&dwc->lock, flags);
1770 synchronize_irq(dwc->irq_gadget);
1774 dwc3_core_exit(dwc);
1784 static int dwc3_resume_common(struct dwc3 *dwc, pm_message_t msg)
1786 unsigned long flags;
1790 switch (dwc->current_dr_role) {
1791 case DWC3_GCTL_PRTCAP_DEVICE:
1792 ret = dwc3_core_init_for_resume(dwc);
1796 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_DEVICE);
1797 spin_lock_irqsave(&dwc->lock, flags);
1798 dwc3_gadget_resume(dwc);
1799 spin_unlock_irqrestore(&dwc->lock, flags);
1801 case DWC3_GCTL_PRTCAP_HOST:
1802 if (!PMSG_IS_AUTO(msg)) {
1803 ret = dwc3_core_init_for_resume(dwc);
1806 dwc3_set_prtcap(dwc, DWC3_GCTL_PRTCAP_HOST);
1809 /* Restore GUSB2PHYCFG bits that were modified in suspend */
1810 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
1811 if (dwc->dis_u2_susphy_quirk)
1812 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
1814 if (dwc->dis_enblslpm_quirk)
1815 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
1817 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
1819 phy_pm_runtime_get_sync(dwc->usb2_generic_phy);
1820 phy_pm_runtime_get_sync(dwc->usb3_generic_phy);
1822 case DWC3_GCTL_PRTCAP_OTG:
1823 /* nothing to do on runtime_resume */
1824 if (PMSG_IS_AUTO(msg))
1827 ret = dwc3_core_init_for_resume(dwc);
1831 dwc3_set_prtcap(dwc, dwc->current_dr_role);
1834 if (dwc->current_otg_role == DWC3_OTG_ROLE_HOST) {
1835 dwc3_otg_host_init(dwc);
1836 } else if (dwc->current_otg_role == DWC3_OTG_ROLE_DEVICE) {
1837 spin_lock_irqsave(&dwc->lock, flags);
1838 dwc3_gadget_resume(dwc);
1839 spin_unlock_irqrestore(&dwc->lock, flags);
1851 static int dwc3_runtime_checks(struct dwc3 *dwc)
1853 switch (dwc->current_dr_role) {
1854 case DWC3_GCTL_PRTCAP_DEVICE:
1858 case DWC3_GCTL_PRTCAP_HOST:
1867 static int dwc3_runtime_suspend(struct device *dev)
1869 struct dwc3 *dwc = dev_get_drvdata(dev);
1872 if (dwc3_runtime_checks(dwc))
1875 ret = dwc3_suspend_common(dwc, PMSG_AUTO_SUSPEND);
1879 device_init_wakeup(dev, true);
1884 static int dwc3_runtime_resume(struct device *dev)
1886 struct dwc3 *dwc = dev_get_drvdata(dev);
1889 device_init_wakeup(dev, false);
1891 ret = dwc3_resume_common(dwc, PMSG_AUTO_RESUME);
1895 switch (dwc->current_dr_role) {
1896 case DWC3_GCTL_PRTCAP_DEVICE:
1897 dwc3_gadget_process_pending_events(dwc);
1899 case DWC3_GCTL_PRTCAP_HOST:
1905 pm_runtime_mark_last_busy(dev);
1910 static int dwc3_runtime_idle(struct device *dev)
1912 struct dwc3 *dwc = dev_get_drvdata(dev);
1914 switch (dwc->current_dr_role) {
1915 case DWC3_GCTL_PRTCAP_DEVICE:
1916 if (dwc3_runtime_checks(dwc))
1919 case DWC3_GCTL_PRTCAP_HOST:
1925 pm_runtime_mark_last_busy(dev);
1926 pm_runtime_autosuspend(dev);
1930 #endif /* CONFIG_PM */
1932 #ifdef CONFIG_PM_SLEEP
1933 static int dwc3_suspend(struct device *dev)
1935 struct dwc3 *dwc = dev_get_drvdata(dev);
1938 ret = dwc3_suspend_common(dwc, PMSG_SUSPEND);
1942 pinctrl_pm_select_sleep_state(dev);
1947 static int dwc3_resume(struct device *dev)
1949 struct dwc3 *dwc = dev_get_drvdata(dev);
1952 pinctrl_pm_select_default_state(dev);
1954 ret = dwc3_resume_common(dwc, PMSG_RESUME);
1958 pm_runtime_disable(dev);
1959 pm_runtime_set_active(dev);
1960 pm_runtime_enable(dev);
1965 static void dwc3_complete(struct device *dev)
1967 struct dwc3 *dwc = dev_get_drvdata(dev);
1970 if (dwc->current_dr_role == DWC3_GCTL_PRTCAP_HOST &&
1971 dwc->dis_split_quirk) {
1972 reg = dwc3_readl(dwc->regs, DWC3_GUCTL3);
1973 reg |= DWC3_GUCTL3_SPLITDISABLE;
1974 dwc3_writel(dwc->regs, DWC3_GUCTL3, reg);
1978 #define dwc3_complete NULL
1979 #endif /* CONFIG_PM_SLEEP */
1981 static const struct dev_pm_ops dwc3_dev_pm_ops = {
1982 SET_SYSTEM_SLEEP_PM_OPS(dwc3_suspend, dwc3_resume)
1983 .complete = dwc3_complete,
1984 SET_RUNTIME_PM_OPS(dwc3_runtime_suspend, dwc3_runtime_resume,
1989 static const struct of_device_id of_dwc3_match[] = {
1991 .compatible = "snps,dwc3"
1994 .compatible = "synopsys,dwc3"
1998 MODULE_DEVICE_TABLE(of, of_dwc3_match);
2003 #define ACPI_ID_INTEL_BSW "808622B7"
2005 static const struct acpi_device_id dwc3_acpi_match[] = {
2006 { ACPI_ID_INTEL_BSW, 0 },
2009 MODULE_DEVICE_TABLE(acpi, dwc3_acpi_match);
2012 static struct platform_driver dwc3_driver = {
2013 .probe = dwc3_probe,
2014 .remove = dwc3_remove,
2017 .of_match_table = of_match_ptr(of_dwc3_match),
2018 .acpi_match_table = ACPI_PTR(dwc3_acpi_match),
2019 .pm = &dwc3_dev_pm_ops,
2023 module_platform_driver(dwc3_driver);
2025 MODULE_ALIAS("platform:dwc3");
2027 MODULE_LICENSE("GPL v2");
2028 MODULE_DESCRIPTION("DesignWare USB3 DRD Controller Driver");