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