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