1 | // SPDX-License-Identifier: GPL-2.0 |
2 | /* |
3 | * drivers/usb/host/ehci-orion.c |
4 | * |
5 | * Tzachi Perelstein <tzachi@marvell.com> |
6 | */ |
7 | |
8 | #include <linux/kernel.h> |
9 | #include <linux/module.h> |
10 | #include <linux/platform_device.h> |
11 | #include <linux/mbus.h> |
12 | #include <linux/clk.h> |
13 | #include <linux/platform_data/usb-ehci-orion.h> |
14 | #include <linux/of.h> |
15 | #include <linux/phy/phy.h> |
16 | #include <linux/usb.h> |
17 | #include <linux/usb/hcd.h> |
18 | #include <linux/io.h> |
19 | #include <linux/dma-mapping.h> |
20 | |
21 | #include "ehci.h" |
22 | |
23 | #define rdl(off) readl_relaxed(hcd->regs + (off)) |
24 | #define wrl(off, val) writel_relaxed((val), hcd->regs + (off)) |
25 | |
26 | #define USB_CMD 0x140 |
27 | #define USB_CMD_RUN BIT(0) |
28 | #define USB_CMD_RESET BIT(1) |
29 | #define USB_MODE 0x1a8 |
30 | #define USB_MODE_MASK GENMASK(1, 0) |
31 | #define USB_MODE_DEVICE 0x2 |
32 | #define USB_MODE_HOST 0x3 |
33 | #define USB_MODE_SDIS BIT(4) |
34 | #define USB_CAUSE 0x310 |
35 | #define USB_MASK 0x314 |
36 | #define USB_WINDOW_CTRL(i) (0x320 + ((i) << 4)) |
37 | #define USB_WINDOW_BASE(i) (0x324 + ((i) << 4)) |
38 | #define USB_IPG 0x360 |
39 | #define USB_PHY_PWR_CTRL 0x400 |
40 | #define USB_PHY_TX_CTRL 0x420 |
41 | #define USB_PHY_RX_CTRL 0x430 |
42 | #define USB_PHY_IVREF_CTRL 0x440 |
43 | #define USB_PHY_TST_GRP_CTRL 0x450 |
44 | |
45 | #define USB_SBUSCFG 0x90 |
46 | |
47 | /* BAWR = BARD = 3 : Align read/write bursts packets larger than 128 bytes */ |
48 | #define USB_SBUSCFG_BAWR_ALIGN_128B (0x3 << 6) |
49 | #define USB_SBUSCFG_BARD_ALIGN_128B (0x3 << 3) |
50 | /* AHBBRST = 3 : Align AHB Burst to INCR16 (64 bytes) */ |
51 | #define USB_SBUSCFG_AHBBRST_INCR16 (0x3 << 0) |
52 | |
53 | #define USB_SBUSCFG_DEF_VAL (USB_SBUSCFG_BAWR_ALIGN_128B \ |
54 | | USB_SBUSCFG_BARD_ALIGN_128B \ |
55 | | USB_SBUSCFG_AHBBRST_INCR16) |
56 | |
57 | #define DRIVER_DESC "EHCI orion driver" |
58 | |
59 | #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv) |
60 | |
61 | struct orion_ehci_hcd { |
62 | struct clk *clk; |
63 | struct phy *phy; |
64 | }; |
65 | |
66 | static struct hc_driver __read_mostly ehci_orion_hc_driver; |
67 | |
68 | /* |
69 | * Implement Orion USB controller specification guidelines |
70 | */ |
71 | static void orion_usb_phy_v1_setup(struct usb_hcd *hcd) |
72 | { |
73 | /* The below GLs are according to the Orion Errata document */ |
74 | /* |
75 | * Clear interrupt cause and mask |
76 | */ |
77 | wrl(USB_CAUSE, 0); |
78 | wrl(USB_MASK, 0); |
79 | |
80 | /* |
81 | * Reset controller |
82 | */ |
83 | wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET); |
84 | while (rdl(USB_CMD) & USB_CMD_RESET); |
85 | |
86 | /* |
87 | * GL# USB-10: Set IPG for non start of frame packets |
88 | * Bits[14:8]=0xc |
89 | */ |
90 | wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00); |
91 | |
92 | /* |
93 | * GL# USB-9: USB 2.0 Power Control |
94 | * BG_VSEL[7:6]=0x1 |
95 | */ |
96 | wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40); |
97 | |
98 | /* |
99 | * GL# USB-1: USB PHY Tx Control - force calibration to '8' |
100 | * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8 |
101 | */ |
102 | wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040); |
103 | |
104 | /* |
105 | * GL# USB-3 GL# USB-9: USB PHY Rx Control |
106 | * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0, |
107 | * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1 |
108 | */ |
109 | wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010); |
110 | |
111 | /* |
112 | * GL# USB-3 GL# USB-9: USB PHY IVREF Control |
113 | * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0 |
114 | */ |
115 | wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32); |
116 | |
117 | /* |
118 | * GL# USB-3 GL# USB-9: USB PHY Test Group Control |
119 | * REG_FIFO_SQ_RST[15]=0 |
120 | */ |
121 | wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000); |
122 | |
123 | /* |
124 | * Stop and reset controller |
125 | */ |
126 | wrl(USB_CMD, rdl(USB_CMD) & ~USB_CMD_RUN); |
127 | wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET); |
128 | while (rdl(USB_CMD) & USB_CMD_RESET); |
129 | |
130 | /* |
131 | * GL# USB-5 Streaming disable REG_USB_MODE[4]=1 |
132 | * TBD: This need to be done after each reset! |
133 | * GL# USB-4 Setup USB Host mode |
134 | */ |
135 | wrl(USB_MODE, USB_MODE_SDIS | USB_MODE_HOST); |
136 | } |
137 | |
138 | static void |
139 | ehci_orion_conf_mbus_windows(struct usb_hcd *hcd, |
140 | const struct mbus_dram_target_info *dram) |
141 | { |
142 | int i; |
143 | |
144 | for (i = 0; i < 4; i++) { |
145 | wrl(USB_WINDOW_CTRL(i), 0); |
146 | wrl(USB_WINDOW_BASE(i), 0); |
147 | } |
148 | |
149 | for (i = 0; i < dram->num_cs; i++) { |
150 | const struct mbus_dram_window *cs = dram->cs + i; |
151 | |
152 | wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) | |
153 | (cs->mbus_attr << 8) | |
154 | (dram->mbus_dram_target_id << 4) | 1); |
155 | wrl(USB_WINDOW_BASE(i), cs->base); |
156 | } |
157 | } |
158 | |
159 | static int ehci_orion_drv_reset(struct usb_hcd *hcd) |
160 | { |
161 | struct device *dev = hcd->self.controller; |
162 | int ret; |
163 | |
164 | ret = ehci_setup(hcd); |
165 | if (ret) |
166 | return ret; |
167 | |
168 | /* |
169 | * For SoC without hlock, need to program sbuscfg value to guarantee |
170 | * AHB master's burst would not overrun or underrun FIFO. |
171 | * |
172 | * sbuscfg reg has to be set after usb controller reset, otherwise |
173 | * the value would be override to 0. |
174 | */ |
175 | if (of_device_is_compatible(device: dev->of_node, "marvell,armada-3700-ehci" )) |
176 | wrl(USB_SBUSCFG, USB_SBUSCFG_DEF_VAL); |
177 | |
178 | return ret; |
179 | } |
180 | |
181 | static int __maybe_unused ehci_orion_drv_suspend(struct device *dev) |
182 | { |
183 | struct usb_hcd *hcd = dev_get_drvdata(dev); |
184 | |
185 | return ehci_suspend(hcd, do_wakeup: device_may_wakeup(dev)); |
186 | } |
187 | |
188 | static int __maybe_unused ehci_orion_drv_resume(struct device *dev) |
189 | { |
190 | struct usb_hcd *hcd = dev_get_drvdata(dev); |
191 | |
192 | return ehci_resume(hcd, force_reset: false); |
193 | } |
194 | |
195 | static SIMPLE_DEV_PM_OPS(ehci_orion_pm_ops, ehci_orion_drv_suspend, |
196 | ehci_orion_drv_resume); |
197 | |
198 | static const struct ehci_driver_overrides orion_overrides __initconst = { |
199 | .extra_priv_size = sizeof(struct orion_ehci_hcd), |
200 | .reset = ehci_orion_drv_reset, |
201 | }; |
202 | |
203 | static int ehci_orion_drv_probe(struct platform_device *pdev) |
204 | { |
205 | struct orion_ehci_data *pd = dev_get_platdata(dev: &pdev->dev); |
206 | const struct mbus_dram_target_info *dram; |
207 | struct resource *res; |
208 | struct usb_hcd *hcd; |
209 | struct ehci_hcd *ehci; |
210 | void __iomem *regs; |
211 | int irq, err; |
212 | enum orion_ehci_phy_ver phy_version; |
213 | struct orion_ehci_hcd *priv; |
214 | |
215 | if (usb_disabled()) |
216 | return -ENODEV; |
217 | |
218 | pr_debug("Initializing Orion-SoC USB Host Controller\n" ); |
219 | |
220 | irq = platform_get_irq(pdev, 0); |
221 | if (irq < 0) { |
222 | err = irq; |
223 | goto err; |
224 | } |
225 | |
226 | /* |
227 | * Right now device-tree probed devices don't get dma_mask |
228 | * set. Since shared usb code relies on it, set it here for |
229 | * now. Once we have dma capability bindings this can go away. |
230 | */ |
231 | err = dma_coerce_mask_and_coherent(dev: &pdev->dev, DMA_BIT_MASK(32)); |
232 | if (err) |
233 | goto err; |
234 | |
235 | regs = devm_platform_get_and_ioremap_resource(pdev, index: 0, res: &res); |
236 | if (IS_ERR(ptr: regs)) { |
237 | err = PTR_ERR(ptr: regs); |
238 | goto err; |
239 | } |
240 | |
241 | hcd = usb_create_hcd(driver: &ehci_orion_hc_driver, |
242 | dev: &pdev->dev, bus_name: dev_name(dev: &pdev->dev)); |
243 | if (!hcd) { |
244 | err = -ENOMEM; |
245 | goto err; |
246 | } |
247 | |
248 | hcd->rsrc_start = res->start; |
249 | hcd->rsrc_len = resource_size(res); |
250 | hcd->regs = regs; |
251 | |
252 | ehci = hcd_to_ehci(hcd); |
253 | ehci->caps = hcd->regs + 0x100; |
254 | hcd->has_tt = 1; |
255 | |
256 | priv = hcd_to_orion_priv(hcd); |
257 | /* |
258 | * Not all platforms can gate the clock, so it is not an error if |
259 | * the clock does not exists. |
260 | */ |
261 | priv->clk = devm_clk_get(dev: &pdev->dev, NULL); |
262 | if (!IS_ERR(ptr: priv->clk)) { |
263 | err = clk_prepare_enable(clk: priv->clk); |
264 | if (err) |
265 | goto err_put_hcd; |
266 | } |
267 | |
268 | priv->phy = devm_phy_optional_get(dev: &pdev->dev, string: "usb" ); |
269 | if (IS_ERR(ptr: priv->phy)) { |
270 | err = PTR_ERR(ptr: priv->phy); |
271 | if (err != -ENOSYS) |
272 | goto err_dis_clk; |
273 | } |
274 | |
275 | /* |
276 | * (Re-)program MBUS remapping windows if we are asked to. |
277 | */ |
278 | dram = mv_mbus_dram_info(); |
279 | if (dram) |
280 | ehci_orion_conf_mbus_windows(hcd, dram); |
281 | |
282 | /* |
283 | * setup Orion USB controller. |
284 | */ |
285 | if (pdev->dev.of_node) |
286 | phy_version = EHCI_PHY_NA; |
287 | else |
288 | phy_version = pd->phy_version; |
289 | |
290 | switch (phy_version) { |
291 | case EHCI_PHY_NA: /* dont change USB phy settings */ |
292 | break; |
293 | case EHCI_PHY_ORION: |
294 | orion_usb_phy_v1_setup(hcd); |
295 | break; |
296 | case EHCI_PHY_DD: |
297 | case EHCI_PHY_KW: |
298 | default: |
299 | dev_warn(&pdev->dev, "USB phy version isn't supported.\n" ); |
300 | } |
301 | |
302 | err = usb_add_hcd(hcd, irqnum: irq, IRQF_SHARED); |
303 | if (err) |
304 | goto err_dis_clk; |
305 | |
306 | device_wakeup_enable(dev: hcd->self.controller); |
307 | return 0; |
308 | |
309 | err_dis_clk: |
310 | if (!IS_ERR(ptr: priv->clk)) |
311 | clk_disable_unprepare(clk: priv->clk); |
312 | err_put_hcd: |
313 | usb_put_hcd(hcd); |
314 | err: |
315 | dev_err(&pdev->dev, "init %s fail, %d\n" , |
316 | dev_name(&pdev->dev), err); |
317 | |
318 | return err; |
319 | } |
320 | |
321 | static void ehci_orion_drv_remove(struct platform_device *pdev) |
322 | { |
323 | struct usb_hcd *hcd = platform_get_drvdata(pdev); |
324 | struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd); |
325 | |
326 | usb_remove_hcd(hcd); |
327 | |
328 | if (!IS_ERR(ptr: priv->clk)) |
329 | clk_disable_unprepare(clk: priv->clk); |
330 | |
331 | usb_put_hcd(hcd); |
332 | } |
333 | |
334 | static const struct of_device_id ehci_orion_dt_ids[] = { |
335 | { .compatible = "marvell,orion-ehci" , }, |
336 | { .compatible = "marvell,armada-3700-ehci" , }, |
337 | {}, |
338 | }; |
339 | MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids); |
340 | |
341 | static struct platform_driver ehci_orion_driver = { |
342 | .probe = ehci_orion_drv_probe, |
343 | .remove_new = ehci_orion_drv_remove, |
344 | .shutdown = usb_hcd_platform_shutdown, |
345 | .driver = { |
346 | .name = "orion-ehci" , |
347 | .of_match_table = ehci_orion_dt_ids, |
348 | .pm = &ehci_orion_pm_ops, |
349 | }, |
350 | }; |
351 | |
352 | static int __init ehci_orion_init(void) |
353 | { |
354 | if (usb_disabled()) |
355 | return -ENODEV; |
356 | |
357 | ehci_init_driver(drv: &ehci_orion_hc_driver, over: &orion_overrides); |
358 | return platform_driver_register(&ehci_orion_driver); |
359 | } |
360 | module_init(ehci_orion_init); |
361 | |
362 | static void __exit ehci_orion_cleanup(void) |
363 | { |
364 | platform_driver_unregister(&ehci_orion_driver); |
365 | } |
366 | module_exit(ehci_orion_cleanup); |
367 | |
368 | MODULE_DESCRIPTION(DRIVER_DESC); |
369 | MODULE_ALIAS("platform:orion-ehci" ); |
370 | MODULE_AUTHOR("Tzachi Perelstein" ); |
371 | MODULE_LICENSE("GPL v2" ); |
372 | |