[ARM] Orion: add the option to support different ehci phy initialization
[linux-2.6.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 <plat/ehci-orion.h>
16
17 #define rdl(off)        __raw_readl(hcd->regs + (off))
18 #define wrl(off, val)   __raw_writel((val), hcd->regs + (off))
19
20 #define USB_CMD                 0x140
21 #define USB_MODE                0x1a8
22 #define USB_CAUSE               0x310
23 #define USB_MASK                0x314
24 #define USB_WINDOW_CTRL(i)      (0x320 + ((i) << 4))
25 #define USB_WINDOW_BASE(i)      (0x324 + ((i) << 4))
26 #define USB_IPG                 0x360
27 #define USB_PHY_PWR_CTRL        0x400
28 #define USB_PHY_TX_CTRL         0x420
29 #define USB_PHY_RX_CTRL         0x430
30 #define USB_PHY_IVREF_CTRL      0x440
31 #define USB_PHY_TST_GRP_CTRL    0x450
32
33 /*
34  * Implement Orion USB controller specification guidelines
35  */
36 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
37 {
38         /* The below GLs are according to the Orion Errata document */
39         /*
40          * Clear interrupt cause and mask
41          */
42         wrl(USB_CAUSE, 0);
43         wrl(USB_MASK, 0);
44
45         /*
46          * Reset controller
47          */
48         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
49         while (rdl(USB_CMD) & 0x2);
50
51         /*
52          * GL# USB-10: Set IPG for non start of frame packets
53          * Bits[14:8]=0xc
54          */
55         wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
56
57         /*
58          * GL# USB-9: USB 2.0 Power Control
59          * BG_VSEL[7:6]=0x1
60          */
61         wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
62
63         /*
64          * GL# USB-1: USB PHY Tx Control - force calibration to '8'
65          * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
66          */
67         wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
68
69         /*
70          * GL# USB-3 GL# USB-9: USB PHY Rx Control
71          * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
72          * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
73          */
74         wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
75
76         /*
77          * GL# USB-3 GL# USB-9: USB PHY IVREF Control
78          * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
79          */
80         wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
81
82         /*
83          * GL# USB-3 GL# USB-9: USB PHY Test Group Control
84          * REG_FIFO_SQ_RST[15]=0
85          */
86         wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
87
88         /*
89          * Stop and reset controller
90          */
91         wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
92         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
93         while (rdl(USB_CMD) & 0x2);
94
95         /*
96          * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
97          * TBD: This need to be done after each reset!
98          * GL# USB-4 Setup USB Host mode
99          */
100         wrl(USB_MODE, 0x13);
101 }
102
103 static int ehci_orion_setup(struct usb_hcd *hcd)
104 {
105         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
106         int retval;
107
108         retval = ehci_halt(ehci);
109         if (retval)
110                 return retval;
111
112         /*
113          * data structure init
114          */
115         retval = ehci_init(hcd);
116         if (retval)
117                 return retval;
118
119         hcd->has_tt = 1;
120
121         ehci_reset(ehci);
122         ehci_port_power(ehci, 0);
123
124         return retval;
125 }
126
127 static const struct hc_driver ehci_orion_hc_driver = {
128         .description = hcd_name,
129         .product_desc = "Marvell Orion EHCI",
130         .hcd_priv_size = sizeof(struct ehci_hcd),
131
132         /*
133          * generic hardware linkage
134          */
135         .irq = ehci_irq,
136         .flags = HCD_MEMORY | HCD_USB2,
137
138         /*
139          * basic lifecycle operations
140          */
141         .reset = ehci_orion_setup,
142         .start = ehci_run,
143         .stop = ehci_stop,
144         .shutdown = ehci_shutdown,
145
146         /*
147          * managing i/o requests and associated device resources
148          */
149         .urb_enqueue = ehci_urb_enqueue,
150         .urb_dequeue = ehci_urb_dequeue,
151         .endpoint_disable = ehci_endpoint_disable,
152
153         /*
154          * scheduling support
155          */
156         .get_frame_number = ehci_get_frame,
157
158         /*
159          * root hub support
160          */
161         .hub_status_data = ehci_hub_status_data,
162         .hub_control = ehci_hub_control,
163         .bus_suspend = ehci_bus_suspend,
164         .bus_resume = ehci_bus_resume,
165         .relinquish_port = ehci_relinquish_port,
166         .port_handed_over = ehci_port_handed_over,
167 };
168
169 static void __init
170 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
171                                 struct mbus_dram_target_info *dram)
172 {
173         int i;
174
175         for (i = 0; i < 4; i++) {
176                 wrl(USB_WINDOW_CTRL(i), 0);
177                 wrl(USB_WINDOW_BASE(i), 0);
178         }
179
180         for (i = 0; i < dram->num_cs; i++) {
181                 struct mbus_dram_window *cs = dram->cs + i;
182
183                 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
184                                         (cs->mbus_attr << 8) |
185                                         (dram->mbus_dram_target_id << 4) | 1);
186                 wrl(USB_WINDOW_BASE(i), cs->base);
187         }
188 }
189
190 static int __init ehci_orion_drv_probe(struct platform_device *pdev)
191 {
192         struct orion_ehci_data *pd = pdev->dev.platform_data;
193         struct resource *res;
194         struct usb_hcd *hcd;
195         struct ehci_hcd *ehci;
196         void __iomem *regs;
197         int irq, err;
198
199         if (usb_disabled())
200                 return -ENODEV;
201
202         pr_debug("Initializing Orion-SoC USB Host Controller\n");
203
204         irq = platform_get_irq(pdev, 0);
205         if (irq <= 0) {
206                 dev_err(&pdev->dev,
207                         "Found HC with no IRQ. Check %s setup!\n",
208                         dev_name(&pdev->dev));
209                 err = -ENODEV;
210                 goto err1;
211         }
212
213         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
214         if (!res) {
215                 dev_err(&pdev->dev,
216                         "Found HC with no register addr. Check %s setup!\n",
217                         dev_name(&pdev->dev));
218                 err = -ENODEV;
219                 goto err1;
220         }
221
222         if (!request_mem_region(res->start, res->end - res->start + 1,
223                                 ehci_orion_hc_driver.description)) {
224                 dev_dbg(&pdev->dev, "controller already in use\n");
225                 err = -EBUSY;
226                 goto err1;
227         }
228
229         regs = ioremap(res->start, res->end - res->start + 1);
230         if (regs == NULL) {
231                 dev_dbg(&pdev->dev, "error mapping memory\n");
232                 err = -EFAULT;
233                 goto err2;
234         }
235
236         hcd = usb_create_hcd(&ehci_orion_hc_driver,
237                         &pdev->dev, dev_name(&pdev->dev));
238         if (!hcd) {
239                 err = -ENOMEM;
240                 goto err3;
241         }
242
243         hcd->rsrc_start = res->start;
244         hcd->rsrc_len = res->end - res->start + 1;
245         hcd->regs = regs;
246
247         ehci = hcd_to_ehci(hcd);
248         ehci->caps = hcd->regs + 0x100;
249         ehci->regs = hcd->regs + 0x100 +
250                 HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
251         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
252         hcd->has_tt = 1;
253         ehci->sbrn = 0x20;
254
255         /*
256          * (Re-)program MBUS remapping windows if we are asked to.
257          */
258         if (pd != NULL && pd->dram != NULL)
259                 ehci_orion_conf_mbus_windows(hcd, pd->dram);
260
261         /*
262          * setup Orion USB controller.
263          */
264         switch (pd->phy_version) {
265         case EHCI_PHY_NA:       /* dont change USB phy settings */
266                 break;
267         case EHCI_PHY_ORION:
268                 orion_usb_phy_v1_setup(hcd);
269                 break;
270         case EHCI_PHY_DD:
271         case EHCI_PHY_KW:
272         default:
273                 printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
274         }
275
276         err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
277         if (err)
278                 goto err4;
279
280         return 0;
281
282 err4:
283         usb_put_hcd(hcd);
284 err3:
285         iounmap(regs);
286 err2:
287         release_mem_region(res->start, res->end - res->start + 1);
288 err1:
289         dev_err(&pdev->dev, "init %s fail, %d\n",
290                 dev_name(&pdev->dev), err);
291
292         return err;
293 }
294
295 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
296 {
297         struct usb_hcd *hcd = platform_get_drvdata(pdev);
298
299         usb_remove_hcd(hcd);
300         iounmap(hcd->regs);
301         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
302         usb_put_hcd(hcd);
303
304         return 0;
305 }
306
307 MODULE_ALIAS("platform:orion-ehci");
308
309 static struct platform_driver ehci_orion_driver = {
310         .probe          = ehci_orion_drv_probe,
311         .remove         = __exit_p(ehci_orion_drv_remove),
312         .shutdown       = usb_hcd_platform_shutdown,
313         .driver.name    = "orion-ehci",
314 };