2 * drivers/usb/host/ehci-orion.c
4 * Tzachi Perelstein <tzachi@marvell.com>
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.
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>
18 #define rdl(off) __raw_readl(hcd->regs + (off))
19 #define wrl(off, val) __raw_writel((val), hcd->regs + (off))
22 #define USB_MODE 0x1a8
23 #define USB_CAUSE 0x310
24 #define USB_MASK 0x314
25 #define USB_WINDOW_CTRL(i) (0x320 + ((i) << 4))
26 #define USB_WINDOW_BASE(i) (0x324 + ((i) << 4))
28 #define USB_PHY_PWR_CTRL 0x400
29 #define USB_PHY_TX_CTRL 0x420
30 #define USB_PHY_RX_CTRL 0x430
31 #define USB_PHY_IVREF_CTRL 0x440
32 #define USB_PHY_TST_GRP_CTRL 0x450
35 * Implement Orion USB controller specification guidelines
37 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
39 /* The below GLs are according to the Orion Errata document */
41 * Clear interrupt cause and mask
49 wrl(USB_CMD, rdl(USB_CMD) | 0x2);
50 while (rdl(USB_CMD) & 0x2);
53 * GL# USB-10: Set IPG for non start of frame packets
56 wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
59 * GL# USB-9: USB 2.0 Power Control
62 wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
65 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
66 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
68 wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
71 * GL# USB-3 GL# USB-9: USB PHY Rx Control
72 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
73 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
75 wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
78 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
79 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
81 wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
84 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
85 * REG_FIFO_SQ_RST[15]=0
87 wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
90 * Stop and reset controller
92 wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
93 wrl(USB_CMD, rdl(USB_CMD) | 0x2);
94 while (rdl(USB_CMD) & 0x2);
97 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
98 * TBD: This need to be done after each reset!
99 * GL# USB-4 Setup USB Host mode
104 static const struct hc_driver ehci_orion_hc_driver = {
105 .description = hcd_name,
106 .product_desc = "Marvell Orion EHCI",
107 .hcd_priv_size = sizeof(struct ehci_hcd),
110 * generic hardware linkage
113 .flags = HCD_MEMORY | HCD_USB2,
116 * basic lifecycle operations
121 .shutdown = ehci_shutdown,
124 * managing i/o requests and associated device resources
126 .urb_enqueue = ehci_urb_enqueue,
127 .urb_dequeue = ehci_urb_dequeue,
128 .endpoint_disable = ehci_endpoint_disable,
129 .endpoint_reset = ehci_endpoint_reset,
134 .get_frame_number = ehci_get_frame,
139 .hub_status_data = ehci_hub_status_data,
140 .hub_control = ehci_hub_control,
141 .bus_suspend = ehci_bus_suspend,
142 .bus_resume = ehci_bus_resume,
143 .relinquish_port = ehci_relinquish_port,
144 .port_handed_over = ehci_port_handed_over,
146 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
150 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
151 const struct mbus_dram_target_info *dram)
155 for (i = 0; i < 4; i++) {
156 wrl(USB_WINDOW_CTRL(i), 0);
157 wrl(USB_WINDOW_BASE(i), 0);
160 for (i = 0; i < dram->num_cs; i++) {
161 const struct mbus_dram_window *cs = dram->cs + i;
163 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
164 (cs->mbus_attr << 8) |
165 (dram->mbus_dram_target_id << 4) | 1);
166 wrl(USB_WINDOW_BASE(i), cs->base);
170 static int ehci_orion_drv_probe(struct platform_device *pdev)
172 struct orion_ehci_data *pd = pdev->dev.platform_data;
173 const struct mbus_dram_target_info *dram;
174 struct resource *res;
176 struct ehci_hcd *ehci;
184 pr_debug("Initializing Orion-SoC USB Host Controller\n");
186 irq = platform_get_irq(pdev, 0);
189 "Found HC with no IRQ. Check %s setup!\n",
190 dev_name(&pdev->dev));
195 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
198 "Found HC with no register addr. Check %s setup!\n",
199 dev_name(&pdev->dev));
204 if (!request_mem_region(res->start, resource_size(res),
205 ehci_orion_hc_driver.description)) {
206 dev_dbg(&pdev->dev, "controller already in use\n");
211 regs = ioremap(res->start, resource_size(res));
213 dev_dbg(&pdev->dev, "error mapping memory\n");
218 /* Not all platforms can gate the clock, so it is not
219 an error if the clock does not exists. */
220 clk = clk_get(&pdev->dev, NULL);
222 clk_prepare_enable(clk);
226 hcd = usb_create_hcd(&ehci_orion_hc_driver,
227 &pdev->dev, dev_name(&pdev->dev));
233 hcd->rsrc_start = res->start;
234 hcd->rsrc_len = resource_size(res);
237 ehci = hcd_to_ehci(hcd);
238 ehci->caps = hcd->regs + 0x100;
242 * (Re-)program MBUS remapping windows if we are asked to.
244 dram = mv_mbus_dram_info();
246 ehci_orion_conf_mbus_windows(hcd, dram);
249 * setup Orion USB controller.
251 switch (pd->phy_version) {
252 case EHCI_PHY_NA: /* dont change USB phy settings */
255 orion_usb_phy_v1_setup(hcd);
260 printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
263 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
273 clk_disable_unprepare(clk);
278 release_mem_region(res->start, resource_size(res));
280 dev_err(&pdev->dev, "init %s fail, %d\n",
281 dev_name(&pdev->dev), err);
286 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
288 struct usb_hcd *hcd = platform_get_drvdata(pdev);
293 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
296 clk = clk_get(&pdev->dev, NULL);
298 clk_disable_unprepare(clk);
304 MODULE_ALIAS("platform:orion-ehci");
306 static struct platform_driver ehci_orion_driver = {
307 .probe = ehci_orion_drv_probe,
308 .remove = __exit_p(ehci_orion_drv_remove),
309 .shutdown = usb_hcd_platform_shutdown,
310 .driver.name = "orion-ehci",