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 #include <linux/of_device.h>
19 #include <linux/of_irq.h>
21 #define rdl(off) __raw_readl(hcd->regs + (off))
22 #define wrl(off, val) __raw_writel((val), hcd->regs + (off))
25 #define USB_MODE 0x1a8
26 #define USB_CAUSE 0x310
27 #define USB_MASK 0x314
28 #define USB_WINDOW_CTRL(i) (0x320 + ((i) << 4))
29 #define USB_WINDOW_BASE(i) (0x324 + ((i) << 4))
31 #define USB_PHY_PWR_CTRL 0x400
32 #define USB_PHY_TX_CTRL 0x420
33 #define USB_PHY_RX_CTRL 0x430
34 #define USB_PHY_IVREF_CTRL 0x440
35 #define USB_PHY_TST_GRP_CTRL 0x450
38 * Implement Orion USB controller specification guidelines
40 static void orion_usb_phy_v1_setup(struct usb_hcd
*hcd
)
42 /* The below GLs are according to the Orion Errata document */
44 * Clear interrupt cause and mask
52 wrl(USB_CMD
, rdl(USB_CMD
) | 0x2);
53 while (rdl(USB_CMD
) & 0x2);
56 * GL# USB-10: Set IPG for non start of frame packets
59 wrl(USB_IPG
, (rdl(USB_IPG
) & ~0x7f00) | 0xc00);
62 * GL# USB-9: USB 2.0 Power Control
65 wrl(USB_PHY_PWR_CTRL
, (rdl(USB_PHY_PWR_CTRL
) & ~0xc0)| 0x40);
68 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
69 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
71 wrl(USB_PHY_TX_CTRL
, (rdl(USB_PHY_TX_CTRL
) & ~0x78) | 0x202040);
74 * GL# USB-3 GL# USB-9: USB PHY Rx Control
75 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
76 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
78 wrl(USB_PHY_RX_CTRL
, (rdl(USB_PHY_RX_CTRL
) & ~0xc2003f0) | 0xc0000010);
81 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
82 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
84 wrl(USB_PHY_IVREF_CTRL
, (rdl(USB_PHY_IVREF_CTRL
) & ~0x80003 ) | 0x32);
87 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
88 * REG_FIFO_SQ_RST[15]=0
90 wrl(USB_PHY_TST_GRP_CTRL
, rdl(USB_PHY_TST_GRP_CTRL
) & ~0x8000);
93 * Stop and reset controller
95 wrl(USB_CMD
, rdl(USB_CMD
) & ~0x1);
96 wrl(USB_CMD
, rdl(USB_CMD
) | 0x2);
97 while (rdl(USB_CMD
) & 0x2);
100 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
101 * TBD: This need to be done after each reset!
102 * GL# USB-4 Setup USB Host mode
107 static const struct hc_driver ehci_orion_hc_driver
= {
108 .description
= hcd_name
,
109 .product_desc
= "Marvell Orion EHCI",
110 .hcd_priv_size
= sizeof(struct ehci_hcd
),
113 * generic hardware linkage
116 .flags
= HCD_MEMORY
| HCD_USB2
,
119 * basic lifecycle operations
124 .shutdown
= ehci_shutdown
,
127 * managing i/o requests and associated device resources
129 .urb_enqueue
= ehci_urb_enqueue
,
130 .urb_dequeue
= ehci_urb_dequeue
,
131 .endpoint_disable
= ehci_endpoint_disable
,
132 .endpoint_reset
= ehci_endpoint_reset
,
137 .get_frame_number
= ehci_get_frame
,
142 .hub_status_data
= ehci_hub_status_data
,
143 .hub_control
= ehci_hub_control
,
144 .bus_suspend
= ehci_bus_suspend
,
145 .bus_resume
= ehci_bus_resume
,
146 .relinquish_port
= ehci_relinquish_port
,
147 .port_handed_over
= ehci_port_handed_over
,
149 .clear_tt_buffer_complete
= ehci_clear_tt_buffer_complete
,
153 ehci_orion_conf_mbus_windows(struct usb_hcd
*hcd
,
154 const struct mbus_dram_target_info
*dram
)
158 for (i
= 0; i
< 4; i
++) {
159 wrl(USB_WINDOW_CTRL(i
), 0);
160 wrl(USB_WINDOW_BASE(i
), 0);
163 for (i
= 0; i
< dram
->num_cs
; i
++) {
164 const struct mbus_dram_window
*cs
= dram
->cs
+ i
;
166 wrl(USB_WINDOW_CTRL(i
), ((cs
->size
- 1) & 0xffff0000) |
167 (cs
->mbus_attr
<< 8) |
168 (dram
->mbus_dram_target_id
<< 4) | 1);
169 wrl(USB_WINDOW_BASE(i
), cs
->base
);
173 static u64 ehci_orion_dma_mask
= DMA_BIT_MASK(32);
175 static int ehci_orion_drv_probe(struct platform_device
*pdev
)
177 struct orion_ehci_data
*pd
= pdev
->dev
.platform_data
;
178 const struct mbus_dram_target_info
*dram
;
179 struct resource
*res
;
181 struct ehci_hcd
*ehci
;
185 enum orion_ehci_phy_ver phy_version
;
190 pr_debug("Initializing Orion-SoC USB Host Controller\n");
192 if (pdev
->dev
.of_node
)
193 irq
= irq_of_parse_and_map(pdev
->dev
.of_node
, 0);
195 irq
= platform_get_irq(pdev
, 0);
198 "Found HC with no IRQ. Check %s setup!\n",
199 dev_name(&pdev
->dev
));
204 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
207 "Found HC with no register addr. Check %s setup!\n",
208 dev_name(&pdev
->dev
));
214 * Right now device-tree probed devices don't get dma_mask
215 * set. Since shared usb code relies on it, set it here for
216 * now. Once we have dma capability bindings this can go away.
218 if (!pdev
->dev
.dma_mask
)
219 pdev
->dev
.dma_mask
= &ehci_orion_dma_mask
;
221 if (!request_mem_region(res
->start
, resource_size(res
),
222 ehci_orion_hc_driver
.description
)) {
223 dev_dbg(&pdev
->dev
, "controller already in use\n");
228 regs
= ioremap(res
->start
, resource_size(res
));
230 dev_dbg(&pdev
->dev
, "error mapping memory\n");
235 /* Not all platforms can gate the clock, so it is not
236 an error if the clock does not exists. */
237 clk
= clk_get(&pdev
->dev
, NULL
);
239 clk_prepare_enable(clk
);
243 hcd
= usb_create_hcd(&ehci_orion_hc_driver
,
244 &pdev
->dev
, dev_name(&pdev
->dev
));
250 hcd
->rsrc_start
= res
->start
;
251 hcd
->rsrc_len
= resource_size(res
);
254 ehci
= hcd_to_ehci(hcd
);
255 ehci
->caps
= hcd
->regs
+ 0x100;
259 * (Re-)program MBUS remapping windows if we are asked to.
261 dram
= mv_mbus_dram_info();
263 ehci_orion_conf_mbus_windows(hcd
, dram
);
266 * setup Orion USB controller.
268 if (pdev
->dev
.of_node
)
269 phy_version
= EHCI_PHY_NA
;
271 phy_version
= pd
->phy_version
;
273 switch (phy_version
) {
274 case EHCI_PHY_NA
: /* dont change USB phy settings */
277 orion_usb_phy_v1_setup(hcd
);
282 printk(KERN_WARNING
"Orion ehci -USB phy version isn't supported.\n");
285 err
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
295 clk_disable_unprepare(clk
);
300 release_mem_region(res
->start
, resource_size(res
));
302 dev_err(&pdev
->dev
, "init %s fail, %d\n",
303 dev_name(&pdev
->dev
), err
);
308 static int __exit
ehci_orion_drv_remove(struct platform_device
*pdev
)
310 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
315 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
318 clk
= clk_get(&pdev
->dev
, NULL
);
320 clk_disable_unprepare(clk
);
326 MODULE_ALIAS("platform:orion-ehci");
328 static const struct of_device_id ehci_orion_dt_ids
[] = {
329 { .compatible
= "marvell,orion-ehci", },
332 MODULE_DEVICE_TABLE(of
, ehci_orion_dt_ids
);
334 static struct platform_driver ehci_orion_driver
= {
335 .probe
= ehci_orion_drv_probe
,
336 .remove
= __exit_p(ehci_orion_drv_remove
),
337 .shutdown
= usb_hcd_platform_shutdown
,
339 .name
= "orion-ehci",
340 .owner
= THIS_MODULE
,
341 .of_match_table
= of_match_ptr(ehci_orion_dt_ids
),