1 // SPDX-License-Identifier: GPL-2.0
3 * xHCI host controller driver for R-Car SoCs
5 * Copyright (C) 2014 Renesas Electronics Corporation
8 #include <linux/firmware.h>
9 #include <linux/iopoll.h>
10 #include <linux/module.h>
11 #include <linux/platform_device.h>
13 #include <linux/usb/phy.h>
14 #include <linux/sys_soc.h>
17 #include "xhci-plat.h"
18 #include "xhci-rcar.h"
21 * - The V3 firmware is for almost all R-Car Gen3 (except r8a7795 ES1.x)
22 * - The V2 firmware is for r8a7795 ES1.x.
23 * - The V2 firmware is possible to use on R-Car Gen2. However, the V2 causes
24 * performance degradation. So, this driver continues to use the V1 if R-Car
26 * - The V1 firmware is impossible to use on R-Car Gen3.
30 /*** Register Offset ***/
31 #define RCAR_USB3_AXH_STA 0x104 /* AXI Host Control Status */
32 #define RCAR_USB3_INT_ENA 0x224 /* Interrupt Enable */
33 #define RCAR_USB3_DL_CTRL 0x250 /* FW Download Control & Status */
34 #define RCAR_USB3_FW_DATA0 0x258 /* FW Data0 */
36 #define RCAR_USB3_LCLK 0xa44 /* LCLK Select */
37 #define RCAR_USB3_CONF1 0xa48 /* USB3.0 Configuration1 */
38 #define RCAR_USB3_CONF2 0xa5c /* USB3.0 Configuration2 */
39 #define RCAR_USB3_CONF3 0xaa8 /* USB3.0 Configuration3 */
40 #define RCAR_USB3_RX_POL 0xab0 /* USB3.0 RX Polarity */
41 #define RCAR_USB3_TX_POL 0xab8 /* USB3.0 TX Polarity */
43 /*** Register Settings ***/
44 /* AXI Host Control Status */
45 #define RCAR_USB3_AXH_STA_B3_PLL_ACTIVE 0x00010000
46 #define RCAR_USB3_AXH_STA_B2_PLL_ACTIVE 0x00000001
47 #define RCAR_USB3_AXH_STA_PLL_ACTIVE_MASK (RCAR_USB3_AXH_STA_B3_PLL_ACTIVE | \
48 RCAR_USB3_AXH_STA_B2_PLL_ACTIVE)
50 /* Interrupt Enable */
51 #define RCAR_USB3_INT_XHC_ENA 0x00000001
52 #define RCAR_USB3_INT_PME_ENA 0x00000002
53 #define RCAR_USB3_INT_HSE_ENA 0x00000004
54 #define RCAR_USB3_INT_ENA_VAL (RCAR_USB3_INT_XHC_ENA | \
55 RCAR_USB3_INT_PME_ENA | RCAR_USB3_INT_HSE_ENA)
57 /* FW Download Control & Status */
58 #define RCAR_USB3_DL_CTRL_ENABLE 0x00000001
59 #define RCAR_USB3_DL_CTRL_FW_SUCCESS 0x00000010
60 #define RCAR_USB3_DL_CTRL_FW_SET_DATA0 0x00000100
63 #define RCAR_USB3_LCLK_ENA_VAL 0x01030001
65 /* USB3.0 Configuration */
66 #define RCAR_USB3_CONF1_VAL 0x00030204
67 #define RCAR_USB3_CONF2_VAL 0x00030300
68 #define RCAR_USB3_CONF3_VAL 0x13802007
71 #define RCAR_USB3_RX_POL_VAL BIT(21)
72 #define RCAR_USB3_TX_POL_VAL BIT(4)
74 /* For soc_device_attribute */
75 #define RCAR_XHCI_FIRMWARE_V2 BIT(0) /* FIRMWARE V2 */
76 #define RCAR_XHCI_FIRMWARE_V3 BIT(1) /* FIRMWARE V3 */
78 static const struct soc_device_attribute rcar_quirks_match[] = {
80 .soc_id = "r8a7795", .revision = "ES1.*",
81 .data = (void *)RCAR_XHCI_FIRMWARE_V2,
86 static void xhci_rcar_start_gen2(struct usb_hcd *hcd)
89 writel(RCAR_USB3_LCLK_ENA_VAL, hcd->regs + RCAR_USB3_LCLK);
90 /* USB3.0 Configuration */
91 writel(RCAR_USB3_CONF1_VAL, hcd->regs + RCAR_USB3_CONF1);
92 writel(RCAR_USB3_CONF2_VAL, hcd->regs + RCAR_USB3_CONF2);
93 writel(RCAR_USB3_CONF3_VAL, hcd->regs + RCAR_USB3_CONF3);
95 writel(RCAR_USB3_RX_POL_VAL, hcd->regs + RCAR_USB3_RX_POL);
96 writel(RCAR_USB3_TX_POL_VAL, hcd->regs + RCAR_USB3_TX_POL);
99 static int xhci_rcar_is_gen2(struct device *dev)
101 struct device_node *node = dev->of_node;
103 return of_device_is_compatible(node, "renesas,xhci-r8a7790") ||
104 of_device_is_compatible(node, "renesas,xhci-r8a7791") ||
105 of_device_is_compatible(node, "renesas,xhci-r8a7793") ||
106 of_device_is_compatible(node, "renesas,rcar-gen2-xhci");
109 void xhci_rcar_start(struct usb_hcd *hcd)
113 if (hcd->regs != NULL) {
114 /* Interrupt Enable */
115 temp = readl(hcd->regs + RCAR_USB3_INT_ENA);
116 temp |= RCAR_USB3_INT_ENA_VAL;
117 writel(temp, hcd->regs + RCAR_USB3_INT_ENA);
118 if (xhci_rcar_is_gen2(hcd->self.controller))
119 xhci_rcar_start_gen2(hcd);
123 static int xhci_rcar_download_firmware(struct usb_hcd *hcd)
125 struct device *dev = hcd->self.controller;
126 void __iomem *regs = hcd->regs;
127 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
128 const struct firmware *fw;
129 int retval, index, j;
132 const struct soc_device_attribute *attr;
133 const char *firmware_name;
136 * According to the datasheet, "Upon the completion of FW Download,
137 * there is no need to write or reload FW".
139 if (readl(regs + RCAR_USB3_DL_CTRL) & RCAR_USB3_DL_CTRL_FW_SUCCESS)
142 attr = soc_device_match(rcar_quirks_match);
144 quirks = (uintptr_t)attr->data;
146 if (quirks & RCAR_XHCI_FIRMWARE_V2)
147 firmware_name = XHCI_RCAR_FIRMWARE_NAME_V2;
148 else if (quirks & RCAR_XHCI_FIRMWARE_V3)
149 firmware_name = XHCI_RCAR_FIRMWARE_NAME_V3;
151 firmware_name = priv->firmware_name;
153 /* request R-Car USB3.0 firmware */
154 retval = reject_firmware(&fw, firmware_name, dev);
158 /* download R-Car USB3.0 firmware */
159 temp = readl(regs + RCAR_USB3_DL_CTRL);
160 temp |= RCAR_USB3_DL_CTRL_ENABLE;
161 writel(temp, regs + RCAR_USB3_DL_CTRL);
163 for (index = 0; index < fw->size; index += 4) {
164 /* to avoid reading beyond the end of the buffer */
165 for (data = 0, j = 3; j >= 0; j--) {
166 if ((j + index) < fw->size)
167 data |= fw->data[index + j] << (8 * j);
169 writel(data, regs + RCAR_USB3_FW_DATA0);
170 temp = readl(regs + RCAR_USB3_DL_CTRL);
171 temp |= RCAR_USB3_DL_CTRL_FW_SET_DATA0;
172 writel(temp, regs + RCAR_USB3_DL_CTRL);
174 retval = readl_poll_timeout_atomic(regs + RCAR_USB3_DL_CTRL,
175 val, !(val & RCAR_USB3_DL_CTRL_FW_SET_DATA0),
181 temp = readl(regs + RCAR_USB3_DL_CTRL);
182 temp &= ~RCAR_USB3_DL_CTRL_ENABLE;
183 writel(temp, regs + RCAR_USB3_DL_CTRL);
185 retval = readl_poll_timeout_atomic((regs + RCAR_USB3_DL_CTRL),
186 val, val & RCAR_USB3_DL_CTRL_FW_SUCCESS, 1, 10000);
188 release_firmware(fw);
193 static bool xhci_rcar_wait_for_pll_active(struct usb_hcd *hcd)
196 u32 val, mask = RCAR_USB3_AXH_STA_PLL_ACTIVE_MASK;
198 retval = readl_poll_timeout_atomic(hcd->regs + RCAR_USB3_AXH_STA,
199 val, (val & mask) == mask, 1, 1000);
203 /* This function needs to initialize a "phy" of usb before */
204 int xhci_rcar_init_quirk(struct usb_hcd *hcd)
206 /* If hcd->regs is NULL, we don't just call the following function */
210 if (!xhci_rcar_wait_for_pll_active(hcd))
213 return xhci_rcar_download_firmware(hcd);
216 int xhci_rcar_resume_quirk(struct usb_hcd *hcd)
220 ret = xhci_rcar_download_firmware(hcd);
222 xhci_rcar_start(hcd);