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>
44 #include "platform_data.h"
51 /* -------------------------------------------------------------------------- */
53 void dwc3_set_mode(struct dwc3 *dwc, u32 mode)
57 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
58 reg &= ~(DWC3_GCTL_PRTCAPDIR(DWC3_GCTL_PRTCAP_OTG));
59 reg |= DWC3_GCTL_PRTCAPDIR(mode);
60 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
64 * dwc3_core_soft_reset - Issues core soft reset and PHY reset
65 * @dwc: pointer to our context structure
67 static int dwc3_core_soft_reset(struct dwc3 *dwc)
73 usb_phy_init(dwc->usb2_phy);
74 usb_phy_init(dwc->usb3_phy);
75 ret = phy_init(dwc->usb2_generic_phy);
79 ret = phy_init(dwc->usb3_generic_phy);
81 phy_exit(dwc->usb2_generic_phy);
86 * We're resetting only the device side because, if we're in host mode,
87 * XHCI driver will reset the host block. If dwc3 was configured for
88 * host-only mode, then we can return early.
90 if (dwc->dr_mode == USB_DR_MODE_HOST)
93 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
94 reg |= DWC3_DCTL_CSFTRST;
95 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
98 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
99 if (!(reg & DWC3_DCTL_CSFTRST))
109 * dwc3_soft_reset - Issue soft reset
110 * @dwc: Pointer to our controller context structure
112 static int dwc3_soft_reset(struct dwc3 *dwc)
114 unsigned long timeout;
117 timeout = jiffies + msecs_to_jiffies(500);
118 dwc3_writel(dwc->regs, DWC3_DCTL, DWC3_DCTL_CSFTRST);
120 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
121 if (!(reg & DWC3_DCTL_CSFTRST))
124 if (time_after(jiffies, timeout)) {
125 dev_err(dwc->dev, "Reset Timed Out\n");
136 * dwc3_frame_length_adjustment - Adjusts frame length if required
137 * @dwc3: Pointer to our controller context structure
138 * @fladj: Value of GFLADJ_30MHZ to adjust frame length
140 static void dwc3_frame_length_adjustment(struct dwc3 *dwc, u32 fladj)
145 if (dwc->revision < DWC3_REVISION_250A)
151 reg = dwc3_readl(dwc->regs, DWC3_GFLADJ);
152 dft = reg & DWC3_GFLADJ_30MHZ_MASK;
153 if (!dev_WARN_ONCE(dwc->dev, dft == fladj,
154 "request value same as default, ignoring\n")) {
155 reg &= ~DWC3_GFLADJ_30MHZ_MASK;
156 reg |= DWC3_GFLADJ_30MHZ_SDBND_SEL | fladj;
157 dwc3_writel(dwc->regs, DWC3_GFLADJ, reg);
162 * dwc3_free_one_event_buffer - Frees one event buffer
163 * @dwc: Pointer to our controller context structure
164 * @evt: Pointer to event buffer to be freed
166 static void dwc3_free_one_event_buffer(struct dwc3 *dwc,
167 struct dwc3_event_buffer *evt)
169 dma_free_coherent(dwc->dev, evt->length, evt->buf, evt->dma);
173 * dwc3_alloc_one_event_buffer - Allocates one event buffer structure
174 * @dwc: Pointer to our controller context structure
175 * @length: size of the event buffer
177 * Returns a pointer to the allocated event buffer structure on success
178 * otherwise ERR_PTR(errno).
180 static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
183 struct dwc3_event_buffer *evt;
185 evt = devm_kzalloc(dwc->dev, sizeof(*evt), GFP_KERNEL);
187 return ERR_PTR(-ENOMEM);
190 evt->length = length;
191 evt->buf = dma_alloc_coherent(dwc->dev, length,
192 &evt->dma, GFP_KERNEL);
194 return ERR_PTR(-ENOMEM);
200 * dwc3_free_event_buffers - frees all allocated event buffers
201 * @dwc: Pointer to our controller context structure
203 static void dwc3_free_event_buffers(struct dwc3 *dwc)
205 struct dwc3_event_buffer *evt;
208 for (i = 0; i < dwc->num_event_buffers; i++) {
209 evt = dwc->ev_buffs[i];
211 dwc3_free_one_event_buffer(dwc, evt);
216 * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
217 * @dwc: pointer to our controller context structure
218 * @length: size of event buffer
220 * Returns 0 on success otherwise negative errno. In the error case, dwc
221 * may contain some buffers allocated but not all which were requested.
223 static int dwc3_alloc_event_buffers(struct dwc3 *dwc, unsigned length)
228 num = DWC3_NUM_INT(dwc->hwparams.hwparams1);
229 dwc->num_event_buffers = num;
231 dwc->ev_buffs = devm_kzalloc(dwc->dev, sizeof(*dwc->ev_buffs) * num,
236 for (i = 0; i < num; i++) {
237 struct dwc3_event_buffer *evt;
239 evt = dwc3_alloc_one_event_buffer(dwc, length);
241 dev_err(dwc->dev, "can't allocate event buffer\n");
244 dwc->ev_buffs[i] = evt;
251 * dwc3_event_buffers_setup - setup our allocated event buffers
252 * @dwc: pointer to our controller context structure
254 * Returns 0 on success otherwise negative errno.
256 static int dwc3_event_buffers_setup(struct dwc3 *dwc)
258 struct dwc3_event_buffer *evt;
261 for (n = 0; n < dwc->num_event_buffers; n++) {
262 evt = dwc->ev_buffs[n];
263 dwc3_trace(trace_dwc3_core,
264 "Event buf %p dma %08llx length %d\n",
265 evt->buf, (unsigned long long) evt->dma,
270 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(n),
271 lower_32_bits(evt->dma));
272 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(n),
273 upper_32_bits(evt->dma));
274 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(n),
275 DWC3_GEVNTSIZ_SIZE(evt->length));
276 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(n), 0);
282 static void dwc3_event_buffers_cleanup(struct dwc3 *dwc)
284 struct dwc3_event_buffer *evt;
287 for (n = 0; n < dwc->num_event_buffers; n++) {
288 evt = dwc->ev_buffs[n];
292 dwc3_writel(dwc->regs, DWC3_GEVNTADRLO(n), 0);
293 dwc3_writel(dwc->regs, DWC3_GEVNTADRHI(n), 0);
294 dwc3_writel(dwc->regs, DWC3_GEVNTSIZ(n), DWC3_GEVNTSIZ_INTMASK
295 | DWC3_GEVNTSIZ_SIZE(0));
296 dwc3_writel(dwc->regs, DWC3_GEVNTCOUNT(n), 0);
300 static int dwc3_alloc_scratch_buffers(struct dwc3 *dwc)
302 if (!dwc->has_hibernation)
305 if (!dwc->nr_scratch)
308 dwc->scratchbuf = kmalloc_array(dwc->nr_scratch,
309 DWC3_SCRATCHBUF_SIZE, GFP_KERNEL);
310 if (!dwc->scratchbuf)
316 static int dwc3_setup_scratch_buffers(struct dwc3 *dwc)
318 dma_addr_t scratch_addr;
322 if (!dwc->has_hibernation)
325 if (!dwc->nr_scratch)
328 /* should never fall here */
329 if (!WARN_ON(dwc->scratchbuf))
332 scratch_addr = dma_map_single(dwc->dev, dwc->scratchbuf,
333 dwc->nr_scratch * DWC3_SCRATCHBUF_SIZE,
335 if (dma_mapping_error(dwc->dev, scratch_addr)) {
336 dev_err(dwc->dev, "failed to map scratch buffer\n");
341 dwc->scratch_addr = scratch_addr;
343 param = lower_32_bits(scratch_addr);
345 ret = dwc3_send_gadget_generic_command(dwc,
346 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO, param);
350 param = upper_32_bits(scratch_addr);
352 ret = dwc3_send_gadget_generic_command(dwc,
353 DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI, param);
360 dma_unmap_single(dwc->dev, dwc->scratch_addr, dwc->nr_scratch *
361 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
367 static void dwc3_free_scratch_buffers(struct dwc3 *dwc)
369 if (!dwc->has_hibernation)
372 if (!dwc->nr_scratch)
375 /* should never fall here */
376 if (!WARN_ON(dwc->scratchbuf))
379 dma_unmap_single(dwc->dev, dwc->scratch_addr, dwc->nr_scratch *
380 DWC3_SCRATCHBUF_SIZE, DMA_BIDIRECTIONAL);
381 kfree(dwc->scratchbuf);
384 static void dwc3_core_num_eps(struct dwc3 *dwc)
386 struct dwc3_hwparams *parms = &dwc->hwparams;
388 dwc->num_in_eps = DWC3_NUM_IN_EPS(parms);
389 dwc->num_out_eps = DWC3_NUM_EPS(parms) - dwc->num_in_eps;
391 dwc3_trace(trace_dwc3_core, "found %d IN and %d OUT endpoints",
392 dwc->num_in_eps, dwc->num_out_eps);
395 static void dwc3_cache_hwparams(struct dwc3 *dwc)
397 struct dwc3_hwparams *parms = &dwc->hwparams;
399 parms->hwparams0 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS0);
400 parms->hwparams1 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS1);
401 parms->hwparams2 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS2);
402 parms->hwparams3 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS3);
403 parms->hwparams4 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS4);
404 parms->hwparams5 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS5);
405 parms->hwparams6 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS6);
406 parms->hwparams7 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS7);
407 parms->hwparams8 = dwc3_readl(dwc->regs, DWC3_GHWPARAMS8);
411 * dwc3_phy_setup - Configure USB PHY Interface of DWC3 Core
412 * @dwc: Pointer to our controller context structure
414 * Returns 0 on success. The USB PHY interfaces are configured but not
415 * initialized. The PHY interfaces and the PHYs get initialized together with
416 * the core in dwc3_core_init.
418 static int dwc3_phy_setup(struct dwc3 *dwc)
424 reg = dwc3_readl(dwc->regs, DWC3_GUSB3PIPECTL(0));
427 * Above 1.94a, it is recommended to set DWC3_GUSB3PIPECTL_SUSPHY
428 * to '0' during coreConsultant configuration. So default value
429 * will be '0' when the core is reset. Application needs to set it
430 * to '1' after the core initialization is completed.
432 if (dwc->revision > DWC3_REVISION_194A)
433 reg |= DWC3_GUSB3PIPECTL_SUSPHY;
435 if (dwc->u2ss_inp3_quirk)
436 reg |= DWC3_GUSB3PIPECTL_U2SSINP3OK;
438 if (dwc->req_p1p2p3_quirk)
439 reg |= DWC3_GUSB3PIPECTL_REQP1P2P3;
441 if (dwc->del_p1p2p3_quirk)
442 reg |= DWC3_GUSB3PIPECTL_DEP1P2P3_EN;
444 if (dwc->del_phy_power_chg_quirk)
445 reg |= DWC3_GUSB3PIPECTL_DEPOCHANGE;
447 if (dwc->lfps_filter_quirk)
448 reg |= DWC3_GUSB3PIPECTL_LFPSFILT;
450 if (dwc->rx_detect_poll_quirk)
451 reg |= DWC3_GUSB3PIPECTL_RX_DETOPOLL;
453 if (dwc->tx_de_emphasis_quirk)
454 reg |= DWC3_GUSB3PIPECTL_TX_DEEPH(dwc->tx_de_emphasis);
456 if (dwc->dis_u3_susphy_quirk)
457 reg &= ~DWC3_GUSB3PIPECTL_SUSPHY;
459 dwc3_writel(dwc->regs, DWC3_GUSB3PIPECTL(0), reg);
461 reg = dwc3_readl(dwc->regs, DWC3_GUSB2PHYCFG(0));
463 /* Select the HS PHY interface */
464 switch (DWC3_GHWPARAMS3_HSPHY_IFC(dwc->hwparams.hwparams3)) {
465 case DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI:
466 if (dwc->hsphy_interface &&
467 !strncmp(dwc->hsphy_interface, "utmi", 4)) {
468 reg &= ~DWC3_GUSB2PHYCFG_ULPI_UTMI;
470 } else if (dwc->hsphy_interface &&
471 !strncmp(dwc->hsphy_interface, "ulpi", 4)) {
472 reg |= DWC3_GUSB2PHYCFG_ULPI_UTMI;
473 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
475 /* Relying on default value. */
476 if (!(reg & DWC3_GUSB2PHYCFG_ULPI_UTMI))
480 case DWC3_GHWPARAMS3_HSPHY_IFC_ULPI:
481 /* Making sure the interface and PHY are operational */
482 ret = dwc3_soft_reset(dwc);
488 ret = dwc3_ulpi_init(dwc);
497 * Above 1.94a, it is recommended to set DWC3_GUSB2PHYCFG_SUSPHY to
498 * '0' during coreConsultant configuration. So default value will
499 * be '0' when the core is reset. Application needs to set it to
500 * '1' after the core initialization is completed.
502 if (dwc->revision > DWC3_REVISION_194A)
503 reg |= DWC3_GUSB2PHYCFG_SUSPHY;
505 if (dwc->dis_u2_susphy_quirk)
506 reg &= ~DWC3_GUSB2PHYCFG_SUSPHY;
508 if (dwc->dis_enblslpm_quirk)
509 reg &= ~DWC3_GUSB2PHYCFG_ENBLSLPM;
511 if (dwc->dis_u2_freeclk_exists_quirk)
512 reg &= ~DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS;
514 if (dwc->phyif_utmi_16_bits)
515 reg |= DWC3_GUSB2PHYCFG_PHYIF;
517 usbtrdtim = (reg & DWC3_GUSB2PHYCFG_PHYIF) ?
518 USBTRDTIM_UTMI_16_BIT : USBTRDTIM_UTMI_8_BIT;
520 reg &= ~DWC3_GUSB2PHYCFG_USBTRDTIM_MASK;
521 reg |= (usbtrdtim << DWC3_GUSB2PHYCFG_USBTRDTIM_SHIFT);
523 dwc3_writel(dwc->regs, DWC3_GUSB2PHYCFG(0), reg);
529 * dwc3_core_init - Low-level initialization of DWC3 Core
530 * @dwc: Pointer to our controller context structure
532 * Returns 0 on success otherwise negative errno.
534 static int dwc3_core_init(struct dwc3 *dwc)
536 u32 hwparams4 = dwc->hwparams.hwparams4;
540 reg = dwc3_readl(dwc->regs, DWC3_GSNPSID);
541 /* This should read as U3 followed by revision number */
542 if ((reg & DWC3_GSNPSID_MASK) == 0x55330000) {
543 /* Detected DWC_usb3 IP */
545 } else if ((reg & DWC3_GSNPSID_MASK) == 0x33310000) {
546 /* Detected DWC_usb31 IP */
547 dwc->revision = dwc3_readl(dwc->regs, DWC3_VER_NUMBER);
548 dwc->revision |= DWC3_REVISION_IS_DWC31;
550 dev_err(dwc->dev, "this is not a DesignWare USB3 DRD Core\n");
556 * Write Linux Version Code to our GUID register so it's easy to figure
557 * out which kernel version a bug was found.
559 dwc3_writel(dwc->regs, DWC3_GUID, LINUX_VERSION_CODE);
561 /* Handle USB2.0-only core configuration */
562 if (DWC3_GHWPARAMS3_SSPHY_IFC(dwc->hwparams.hwparams3) ==
563 DWC3_GHWPARAMS3_SSPHY_IFC_DIS) {
564 if (dwc->maximum_speed == USB_SPEED_SUPER)
565 dwc->maximum_speed = USB_SPEED_HIGH;
568 /* issue device SoftReset too */
569 ret = dwc3_soft_reset(dwc);
573 ret = dwc3_core_soft_reset(dwc);
577 reg = dwc3_readl(dwc->regs, DWC3_GCTL);
578 reg &= ~DWC3_GCTL_SCALEDOWN_MASK;
580 switch (DWC3_GHWPARAMS1_EN_PWROPT(dwc->hwparams.hwparams1)) {
581 case DWC3_GHWPARAMS1_EN_PWROPT_CLK:
583 * WORKAROUND: DWC3 revisions between 2.10a and 2.50a have an
584 * issue which would cause xHCI compliance tests to fail.
586 * Because of that we cannot enable clock gating on such
591 * STAR#9000588375: Clock Gating, SOF Issues when ref_clk-Based
594 if ((dwc->dr_mode == USB_DR_MODE_HOST ||
595 dwc->dr_mode == USB_DR_MODE_OTG) &&
596 (dwc->revision >= DWC3_REVISION_210A &&
597 dwc->revision <= DWC3_REVISION_250A))
598 reg |= DWC3_GCTL_DSBLCLKGTNG | DWC3_GCTL_SOFITPSYNC;
600 reg &= ~DWC3_GCTL_DSBLCLKGTNG;
602 case DWC3_GHWPARAMS1_EN_PWROPT_HIB:
603 /* enable hibernation here */
604 dwc->nr_scratch = DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(hwparams4);
607 * REVISIT Enabling this bit so that host-mode hibernation
608 * will work. Device-mode hibernation is not yet implemented.
610 reg |= DWC3_GCTL_GBLHIBERNATIONEN;
613 dwc3_trace(trace_dwc3_core, "No power optimization available\n");
616 /* check if current dwc3 is on simulation board */
617 if (dwc->hwparams.hwparams6 & DWC3_GHWPARAMS6_EN_FPGA) {
618 dwc3_trace(trace_dwc3_core,
619 "running on FPGA platform\n");
623 WARN_ONCE(dwc->disable_scramble_quirk && !dwc->is_fpga,
624 "disable_scramble cannot be used on non-FPGA builds\n");
626 if (dwc->disable_scramble_quirk && dwc->is_fpga)
627 reg |= DWC3_GCTL_DISSCRAMBLE;
629 reg &= ~DWC3_GCTL_DISSCRAMBLE;
631 if (dwc->u2exit_lfps_quirk)
632 reg |= DWC3_GCTL_U2EXIT_LFPS;
635 * WORKAROUND: DWC3 revisions <1.90a have a bug
636 * where the device can fail to connect at SuperSpeed
637 * and falls back to high-speed mode which causes
638 * the device to enter a Connect/Disconnect loop
640 if (dwc->revision < DWC3_REVISION_190A)
641 reg |= DWC3_GCTL_U2RSTECN;
643 dwc3_core_num_eps(dwc);
645 dwc3_writel(dwc->regs, DWC3_GCTL, reg);
647 ret = dwc3_alloc_scratch_buffers(dwc);
651 ret = dwc3_setup_scratch_buffers(dwc);
658 dwc3_free_scratch_buffers(dwc);
661 usb_phy_shutdown(dwc->usb2_phy);
662 usb_phy_shutdown(dwc->usb3_phy);
663 phy_exit(dwc->usb2_generic_phy);
664 phy_exit(dwc->usb3_generic_phy);
670 static void dwc3_core_exit(struct dwc3 *dwc)
672 dwc3_free_scratch_buffers(dwc);
673 usb_phy_shutdown(dwc->usb2_phy);
674 usb_phy_shutdown(dwc->usb3_phy);
675 phy_exit(dwc->usb2_generic_phy);
676 phy_exit(dwc->usb3_generic_phy);
679 static int dwc3_core_get_phy(struct dwc3 *dwc)
681 struct device *dev = dwc->dev;
682 struct device_node *node = dev->of_node;
686 dwc->usb2_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 0);
687 dwc->usb3_phy = devm_usb_get_phy_by_phandle(dev, "usb-phy", 1);
689 dwc->usb2_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
690 dwc->usb3_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB3);
693 if (IS_ERR(dwc->usb2_phy)) {
694 ret = PTR_ERR(dwc->usb2_phy);
695 if (ret == -ENXIO || ret == -ENODEV) {
696 dwc->usb2_phy = NULL;
697 } else if (ret == -EPROBE_DEFER) {
700 dev_err(dev, "no usb2 phy configured\n");
705 if (IS_ERR(dwc->usb3_phy)) {
706 ret = PTR_ERR(dwc->usb3_phy);
707 if (ret == -ENXIO || ret == -ENODEV) {
708 dwc->usb3_phy = NULL;
709 } else if (ret == -EPROBE_DEFER) {
712 dev_err(dev, "no usb3 phy configured\n");
717 dwc->usb2_generic_phy = devm_phy_get(dev, "usb2-phy");
718 if (IS_ERR(dwc->usb2_generic_phy)) {
719 ret = PTR_ERR(dwc->usb2_generic_phy);
720 if (ret == -ENOSYS || ret == -ENODEV) {
721 dwc->usb2_generic_phy = NULL;
722 } else if (ret == -EPROBE_DEFER) {
725 dev_err(dev, "no usb2 phy configured\n");
730 dwc->usb3_generic_phy = devm_phy_get(dev, "usb3-phy");
731 if (IS_ERR(dwc->usb3_generic_phy)) {
732 ret = PTR_ERR(dwc->usb3_generic_phy);
733 if (ret == -ENOSYS || ret == -ENODEV) {
734 dwc->usb3_generic_phy = NULL;
735 } else if (ret == -EPROBE_DEFER) {
738 dev_err(dev, "no usb3 phy configured\n");
746 static int dwc3_core_init_mode(struct dwc3 *dwc)
748 struct device *dev = dwc->dev;
751 switch (dwc->dr_mode) {
752 case USB_DR_MODE_PERIPHERAL:
753 dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_DEVICE);
754 ret = dwc3_gadget_init(dwc);
756 dev_err(dev, "failed to initialize gadget\n");
760 case USB_DR_MODE_HOST:
761 dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_HOST);
762 ret = dwc3_host_init(dwc);
764 dev_err(dev, "failed to initialize host\n");
768 case USB_DR_MODE_OTG:
769 dwc3_set_mode(dwc, DWC3_GCTL_PRTCAP_OTG);
770 ret = dwc3_host_init(dwc);
772 dev_err(dev, "failed to initialize host\n");
776 ret = dwc3_gadget_init(dwc);
778 dev_err(dev, "failed to initialize gadget\n");
783 dev_err(dev, "Unsupported mode of operation %d\n", dwc->dr_mode);
790 static void dwc3_core_exit_mode(struct dwc3 *dwc)
792 switch (dwc->dr_mode) {
793 case USB_DR_MODE_PERIPHERAL:
794 dwc3_gadget_exit(dwc);
796 case USB_DR_MODE_HOST:
799 case USB_DR_MODE_OTG:
801 dwc3_gadget_exit(dwc);
809 #define DWC3_ALIGN_MASK (16 - 1)
811 static int dwc3_probe(struct platform_device *pdev)
813 struct device *dev = &pdev->dev;
814 struct dwc3_platform_data *pdata = dev_get_platdata(dev);
815 struct resource *res;
817 u8 lpm_nyet_threshold;
827 mem = devm_kzalloc(dev, sizeof(*dwc) + DWC3_ALIGN_MASK, GFP_KERNEL);
831 dwc = PTR_ALIGN(mem, DWC3_ALIGN_MASK + 1);
835 /* Try to set 64-bit DMA first */
836 if (!pdev->dev.dma_mask)
837 /* Platform did not initialize dma_mask */
838 ret = dma_coerce_mask_and_coherent(&pdev->dev,
841 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
843 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
845 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
850 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
852 dev_err(dev, "missing IRQ\n");
855 dwc->xhci_resources[1].start = res->start;
856 dwc->xhci_resources[1].end = res->end;
857 dwc->xhci_resources[1].flags = res->flags;
858 dwc->xhci_resources[1].name = res->name;
860 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
862 dev_err(dev, "missing memory resource\n");
866 dwc->xhci_resources[0].start = res->start;
867 dwc->xhci_resources[0].end = dwc->xhci_resources[0].start +
869 dwc->xhci_resources[0].flags = res->flags;
870 dwc->xhci_resources[0].name = res->name;
872 res->start += DWC3_GLOBALS_REGS_START;
875 * Request memory region but exclude xHCI regs,
876 * since it will be requested by the xhci-plat driver.
878 regs = devm_ioremap_resource(dev, res);
885 dwc->regs_size = resource_size(res);
887 /* default to highest possible threshold */
888 lpm_nyet_threshold = 0xff;
890 /* default to -3.5dB de-emphasis */
894 * default to assert utmi_sleep_n and use maximum allowed HIRD
895 * threshold value of 0b1100
899 dwc->maximum_speed = usb_get_maximum_speed(dev);
900 dwc->dr_mode = usb_get_dr_mode(dev);
902 dwc->has_lpm_erratum = device_property_read_bool(dev,
903 "snps,has-lpm-erratum");
904 device_property_read_u8(dev, "snps,lpm-nyet-threshold",
905 &lpm_nyet_threshold);
906 dwc->is_utmi_l1_suspend = device_property_read_bool(dev,
907 "snps,is-utmi-l1-suspend");
908 device_property_read_u8(dev, "snps,hird-threshold",
910 dwc->usb3_lpm_capable = device_property_read_bool(dev,
911 "snps,usb3_lpm_capable");
913 dwc->needs_fifo_resize = device_property_read_bool(dev,
916 dwc->disable_scramble_quirk = device_property_read_bool(dev,
917 "snps,disable_scramble_quirk");
918 dwc->u2exit_lfps_quirk = device_property_read_bool(dev,
919 "snps,u2exit_lfps_quirk");
920 dwc->u2ss_inp3_quirk = device_property_read_bool(dev,
921 "snps,u2ss_inp3_quirk");
922 dwc->req_p1p2p3_quirk = device_property_read_bool(dev,
923 "snps,req_p1p2p3_quirk");
924 dwc->del_p1p2p3_quirk = device_property_read_bool(dev,
925 "snps,del_p1p2p3_quirk");
926 dwc->del_phy_power_chg_quirk = device_property_read_bool(dev,
927 "snps,del_phy_power_chg_quirk");
928 dwc->lfps_filter_quirk = device_property_read_bool(dev,
929 "snps,lfps_filter_quirk");
930 dwc->rx_detect_poll_quirk = device_property_read_bool(dev,
931 "snps,rx_detect_poll_quirk");
932 dwc->dis_u3_susphy_quirk = device_property_read_bool(dev,
933 "snps,dis_u3_susphy_quirk");
934 dwc->dis_u2_susphy_quirk = device_property_read_bool(dev,
935 "snps,dis_u2_susphy_quirk");
936 dwc->dis_enblslpm_quirk = device_property_read_bool(dev,
937 "snps,dis_enblslpm_quirk");
938 dwc->dis_u2_freeclk_exists_quirk = device_property_read_bool(dev,
939 "snps,dis_u2_freeclk_exists_quirk");
940 dwc->phyif_utmi_16_bits = device_property_read_bool(dev,
941 "snps,phyif_utmi_16_bits");
943 dwc->tx_de_emphasis_quirk = device_property_read_bool(dev,
944 "snps,tx_de_emphasis_quirk");
945 device_property_read_u8(dev, "snps,tx_de_emphasis",
947 device_property_read_string(dev, "snps,hsphy_interface",
948 &dwc->hsphy_interface);
949 device_property_read_u32(dev, "snps,quirk-frame-length-adjustment",
953 dwc->maximum_speed = pdata->maximum_speed;
954 dwc->has_lpm_erratum = pdata->has_lpm_erratum;
955 if (pdata->lpm_nyet_threshold)
956 lpm_nyet_threshold = pdata->lpm_nyet_threshold;
957 dwc->is_utmi_l1_suspend = pdata->is_utmi_l1_suspend;
958 if (pdata->hird_threshold)
959 hird_threshold = pdata->hird_threshold;
961 dwc->needs_fifo_resize = pdata->tx_fifo_resize;
962 dwc->usb3_lpm_capable = pdata->usb3_lpm_capable;
963 dwc->dr_mode = pdata->dr_mode;
965 dwc->disable_scramble_quirk = pdata->disable_scramble_quirk;
966 dwc->u2exit_lfps_quirk = pdata->u2exit_lfps_quirk;
967 dwc->u2ss_inp3_quirk = pdata->u2ss_inp3_quirk;
968 dwc->req_p1p2p3_quirk = pdata->req_p1p2p3_quirk;
969 dwc->del_p1p2p3_quirk = pdata->del_p1p2p3_quirk;
970 dwc->del_phy_power_chg_quirk = pdata->del_phy_power_chg_quirk;
971 dwc->lfps_filter_quirk = pdata->lfps_filter_quirk;
972 dwc->rx_detect_poll_quirk = pdata->rx_detect_poll_quirk;
973 dwc->dis_u3_susphy_quirk = pdata->dis_u3_susphy_quirk;
974 dwc->dis_u2_susphy_quirk = pdata->dis_u2_susphy_quirk;
975 dwc->dis_enblslpm_quirk = pdata->dis_enblslpm_quirk;
976 dwc->dis_u2_freeclk_exists_quirk =
977 pdata->dis_u2_freeclk_exists_quirk;
978 dwc->phyif_utmi_16_bits = pdata->phyif_utmi_16_bits;
980 dwc->tx_de_emphasis_quirk = pdata->tx_de_emphasis_quirk;
981 if (pdata->tx_de_emphasis)
982 tx_de_emphasis = pdata->tx_de_emphasis;
984 dwc->hsphy_interface = pdata->hsphy_interface;
985 fladj = pdata->fladj_value;
988 /* default to superspeed if no maximum_speed passed */
989 if (dwc->maximum_speed == USB_SPEED_UNKNOWN)
990 dwc->maximum_speed = USB_SPEED_SUPER;
992 dwc->lpm_nyet_threshold = lpm_nyet_threshold;
993 dwc->tx_de_emphasis = tx_de_emphasis;
995 dwc->hird_threshold = hird_threshold
996 | (dwc->is_utmi_l1_suspend << 4);
998 platform_set_drvdata(pdev, dwc);
999 dwc3_cache_hwparams(dwc);
1001 ret = dwc3_phy_setup(dwc);
1005 ret = dwc3_core_get_phy(dwc);
1009 spin_lock_init(&dwc->lock);
1011 if (!dev->dma_mask) {
1012 dev->dma_mask = dev->parent->dma_mask;
1013 dev->dma_parms = dev->parent->dma_parms;
1014 dma_set_coherent_mask(dev, dev->parent->coherent_dma_mask);
1017 pm_runtime_enable(dev);
1018 pm_runtime_get_sync(dev);
1019 pm_runtime_forbid(dev);
1021 ret = dwc3_alloc_event_buffers(dwc, DWC3_EVENT_BUFFERS_SIZE);
1023 dev_err(dwc->dev, "failed to allocate event buffers\n");
1028 if (IS_ENABLED(CONFIG_USB_DWC3_HOST))
1029 dwc->dr_mode = USB_DR_MODE_HOST;
1030 else if (IS_ENABLED(CONFIG_USB_DWC3_GADGET))
1031 dwc->dr_mode = USB_DR_MODE_PERIPHERAL;
1033 if (dwc->dr_mode == USB_DR_MODE_UNKNOWN)
1034 dwc->dr_mode = USB_DR_MODE_OTG;
1036 ret = dwc3_core_init(dwc);
1038 dev_err(dev, "failed to initialize core\n");
1042 /* Adjust Frame Length */
1043 dwc3_frame_length_adjustment(dwc, fladj);
1045 usb_phy_set_suspend(dwc->usb2_phy, 0);
1046 usb_phy_set_suspend(dwc->usb3_phy, 0);
1047 ret = phy_power_on(dwc->usb2_generic_phy);
1051 ret = phy_power_on(dwc->usb3_generic_phy);
1055 ret = dwc3_event_buffers_setup(dwc);
1057 dev_err(dwc->dev, "failed to setup event buffers\n");
1061 ret = dwc3_core_init_mode(dwc);
1065 ret = dwc3_debugfs_init(dwc);
1067 dev_err(dev, "failed to initialize debugfs\n");
1071 pm_runtime_allow(dev);
1076 dwc3_core_exit_mode(dwc);
1079 dwc3_event_buffers_cleanup(dwc);
1082 phy_power_off(dwc->usb3_generic_phy);
1085 phy_power_off(dwc->usb2_generic_phy);
1088 usb_phy_set_suspend(dwc->usb2_phy, 1);
1089 usb_phy_set_suspend(dwc->usb3_phy, 1);
1090 dwc3_core_exit(dwc);
1093 dwc3_free_event_buffers(dwc);
1094 dwc3_ulpi_exit(dwc);
1098 * restore res->start back to its original value so that, in case the
1099 * probe is deferred, we don't end up getting error in request the
1100 * memory region the next time probe is called.
1102 res->start -= DWC3_GLOBALS_REGS_START;
1107 static int dwc3_remove(struct platform_device *pdev)
1109 struct dwc3 *dwc = platform_get_drvdata(pdev);
1110 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1113 * restore res->start back to its original value so that, in case the
1114 * probe is deferred, we don't end up getting error in request the
1115 * memory region the next time probe is called.
1117 res->start -= DWC3_GLOBALS_REGS_START;
1119 dwc3_debugfs_exit(dwc);
1120 dwc3_core_exit_mode(dwc);
1121 dwc3_event_buffers_cleanup(dwc);
1122 dwc3_free_event_buffers(dwc);
1124 usb_phy_set_suspend(dwc->usb2_phy, 1);
1125 usb_phy_set_suspend(dwc->usb3_phy, 1);
1126 phy_power_off(dwc->usb2_generic_phy);
1127 phy_power_off(dwc->usb3_generic_phy);
1129 dwc3_core_exit(dwc);
1130 dwc3_ulpi_exit(dwc);
1132 pm_runtime_put_sync(&pdev->dev);
1133 pm_runtime_disable(&pdev->dev);
1138 #ifdef CONFIG_PM_SLEEP
1139 static int dwc3_suspend(struct device *dev)
1141 struct dwc3 *dwc = dev_get_drvdata(dev);
1142 unsigned long flags;
1144 spin_lock_irqsave(&dwc->lock, flags);
1146 switch (dwc->dr_mode) {
1147 case USB_DR_MODE_PERIPHERAL:
1148 case USB_DR_MODE_OTG:
1149 dwc3_gadget_suspend(dwc);
1151 case USB_DR_MODE_HOST:
1153 dwc3_event_buffers_cleanup(dwc);
1157 dwc->gctl = dwc3_readl(dwc->regs, DWC3_GCTL);
1158 spin_unlock_irqrestore(&dwc->lock, flags);
1160 usb_phy_shutdown(dwc->usb3_phy);
1161 usb_phy_shutdown(dwc->usb2_phy);
1162 phy_exit(dwc->usb2_generic_phy);
1163 phy_exit(dwc->usb3_generic_phy);
1165 pinctrl_pm_select_sleep_state(dev);
1170 static int dwc3_resume(struct device *dev)
1172 struct dwc3 *dwc = dev_get_drvdata(dev);
1173 unsigned long flags;
1176 pinctrl_pm_select_default_state(dev);
1178 usb_phy_init(dwc->usb3_phy);
1179 usb_phy_init(dwc->usb2_phy);
1180 ret = phy_init(dwc->usb2_generic_phy);
1184 ret = phy_init(dwc->usb3_generic_phy);
1186 goto err_usb2phy_init;
1188 spin_lock_irqsave(&dwc->lock, flags);
1190 dwc3_event_buffers_setup(dwc);
1191 dwc3_writel(dwc->regs, DWC3_GCTL, dwc->gctl);
1193 switch (dwc->dr_mode) {
1194 case USB_DR_MODE_PERIPHERAL:
1195 case USB_DR_MODE_OTG:
1196 dwc3_gadget_resume(dwc);
1198 case USB_DR_MODE_HOST:
1204 spin_unlock_irqrestore(&dwc->lock, flags);
1206 pm_runtime_disable(dev);
1207 pm_runtime_set_active(dev);
1208 pm_runtime_enable(dev);
1213 phy_exit(dwc->usb2_generic_phy);
1218 static const struct dev_pm_ops dwc3_dev_pm_ops = {
1219 SET_SYSTEM_SLEEP_PM_OPS(dwc3_suspend, dwc3_resume)
1222 #define DWC3_PM_OPS &(dwc3_dev_pm_ops)
1224 #define DWC3_PM_OPS NULL
1228 static const struct of_device_id of_dwc3_match[] = {
1230 .compatible = "snps,dwc3"
1233 .compatible = "synopsys,dwc3"
1237 MODULE_DEVICE_TABLE(of, of_dwc3_match);
1242 #define ACPI_ID_INTEL_BSW "808622B7"
1244 static const struct acpi_device_id dwc3_acpi_match[] = {
1245 { ACPI_ID_INTEL_BSW, 0 },
1248 MODULE_DEVICE_TABLE(acpi, dwc3_acpi_match);
1251 static struct platform_driver dwc3_driver = {
1252 .probe = dwc3_probe,
1253 .remove = dwc3_remove,
1256 .of_match_table = of_match_ptr(of_dwc3_match),
1257 .acpi_match_table = ACPI_PTR(dwc3_acpi_match),
1262 module_platform_driver(dwc3_driver);
1264 MODULE_ALIAS("platform:dwc3");
1265 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
1266 MODULE_LICENSE("GPL v2");
1267 MODULE_DESCRIPTION("DesignWare USB3 DRD Controller Driver");