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