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