Loading...
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 */
36static 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
103static int ehci_orion_setup(struct usb_hcd *hcd)
104{
105 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
106 int retval;
107
108 hcd->has_tt = 1;
109
110 retval = ehci_halt(ehci);
111 if (retval)
112 return retval;
113
114 /*
115 * data structure init
116 */
117 retval = ehci_init(hcd);
118 if (retval)
119 return retval;
120
121 ehci_reset(ehci);
122
123 ehci_port_power(ehci, 0);
124
125 return retval;
126}
127
128static const struct hc_driver ehci_orion_hc_driver = {
129 .description = hcd_name,
130 .product_desc = "Marvell Orion EHCI",
131 .hcd_priv_size = sizeof(struct ehci_hcd),
132
133 /*
134 * generic hardware linkage
135 */
136 .irq = ehci_irq,
137 .flags = HCD_MEMORY | HCD_USB2,
138
139 /*
140 * basic lifecycle operations
141 */
142 .reset = ehci_orion_setup,
143 .start = ehci_run,
144 .stop = ehci_stop,
145 .shutdown = ehci_shutdown,
146
147 /*
148 * managing i/o requests and associated device resources
149 */
150 .urb_enqueue = ehci_urb_enqueue,
151 .urb_dequeue = ehci_urb_dequeue,
152 .endpoint_disable = ehci_endpoint_disable,
153 .endpoint_reset = ehci_endpoint_reset,
154
155 /*
156 * scheduling support
157 */
158 .get_frame_number = ehci_get_frame,
159
160 /*
161 * root hub support
162 */
163 .hub_status_data = ehci_hub_status_data,
164 .hub_control = ehci_hub_control,
165 .bus_suspend = ehci_bus_suspend,
166 .bus_resume = ehci_bus_resume,
167 .relinquish_port = ehci_relinquish_port,
168 .port_handed_over = ehci_port_handed_over,
169
170 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
171};
172
173static void __init
174ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
175 struct mbus_dram_target_info *dram)
176{
177 int i;
178
179 for (i = 0; i < 4; i++) {
180 wrl(USB_WINDOW_CTRL(i), 0);
181 wrl(USB_WINDOW_BASE(i), 0);
182 }
183
184 for (i = 0; i < dram->num_cs; i++) {
185 struct mbus_dram_window *cs = dram->cs + i;
186
187 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
188 (cs->mbus_attr << 8) |
189 (dram->mbus_dram_target_id << 4) | 1);
190 wrl(USB_WINDOW_BASE(i), cs->base);
191 }
192}
193
194static int __devinit ehci_orion_drv_probe(struct platform_device *pdev)
195{
196 struct orion_ehci_data *pd = pdev->dev.platform_data;
197 struct resource *res;
198 struct usb_hcd *hcd;
199 struct ehci_hcd *ehci;
200 void __iomem *regs;
201 int irq, err;
202
203 if (usb_disabled())
204 return -ENODEV;
205
206 pr_debug("Initializing Orion-SoC USB Host Controller\n");
207
208 irq = platform_get_irq(pdev, 0);
209 if (irq <= 0) {
210 dev_err(&pdev->dev,
211 "Found HC with no IRQ. Check %s setup!\n",
212 dev_name(&pdev->dev));
213 err = -ENODEV;
214 goto err1;
215 }
216
217 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
218 if (!res) {
219 dev_err(&pdev->dev,
220 "Found HC with no register addr. Check %s setup!\n",
221 dev_name(&pdev->dev));
222 err = -ENODEV;
223 goto err1;
224 }
225
226 if (!request_mem_region(res->start, resource_size(res),
227 ehci_orion_hc_driver.description)) {
228 dev_dbg(&pdev->dev, "controller already in use\n");
229 err = -EBUSY;
230 goto err1;
231 }
232
233 regs = ioremap(res->start, resource_size(res));
234 if (regs == NULL) {
235 dev_dbg(&pdev->dev, "error mapping memory\n");
236 err = -EFAULT;
237 goto err2;
238 }
239
240 hcd = usb_create_hcd(&ehci_orion_hc_driver,
241 &pdev->dev, dev_name(&pdev->dev));
242 if (!hcd) {
243 err = -ENOMEM;
244 goto err3;
245 }
246
247 hcd->rsrc_start = res->start;
248 hcd->rsrc_len = resource_size(res);
249 hcd->regs = regs;
250
251 ehci = hcd_to_ehci(hcd);
252 ehci->caps = hcd->regs + 0x100;
253 ehci->regs = hcd->regs + 0x100 +
254 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
255 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
256 hcd->has_tt = 1;
257 ehci->sbrn = 0x20;
258
259 /*
260 * (Re-)program MBUS remapping windows if we are asked to.
261 */
262 if (pd != NULL && pd->dram != NULL)
263 ehci_orion_conf_mbus_windows(hcd, pd->dram);
264
265 /*
266 * setup Orion USB controller.
267 */
268 switch (pd->phy_version) {
269 case EHCI_PHY_NA: /* dont change USB phy settings */
270 break;
271 case EHCI_PHY_ORION:
272 orion_usb_phy_v1_setup(hcd);
273 break;
274 case EHCI_PHY_DD:
275 case EHCI_PHY_KW:
276 default:
277 printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
278 }
279
280 err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
281 if (err)
282 goto err4;
283
284 return 0;
285
286err4:
287 usb_put_hcd(hcd);
288err3:
289 iounmap(regs);
290err2:
291 release_mem_region(res->start, resource_size(res));
292err1:
293 dev_err(&pdev->dev, "init %s fail, %d\n",
294 dev_name(&pdev->dev), err);
295
296 return err;
297}
298
299static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
300{
301 struct usb_hcd *hcd = platform_get_drvdata(pdev);
302
303 usb_remove_hcd(hcd);
304 iounmap(hcd->regs);
305 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
306 usb_put_hcd(hcd);
307
308 return 0;
309}
310
311MODULE_ALIAS("platform:orion-ehci");
312
313static struct platform_driver ehci_orion_driver = {
314 .probe = ehci_orion_drv_probe,
315 .remove = __exit_p(ehci_orion_drv_remove),
316 .shutdown = usb_hcd_platform_shutdown,
317 .driver.name = "orion-ehci",
318};
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
45static const char hcd_name[] = "ehci-orion";
46
47static struct hc_driver __read_mostly ehci_orion_hc_driver;
48
49/*
50 * Implement Orion USB controller specification guidelines
51 */
52static 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
119static void
120ehci_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
140static int ehci_orion_drv_probe(struct platform_device *pdev)
141{
142 struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
143 const struct mbus_dram_target_info *dram;
144 struct resource *res;
145 struct usb_hcd *hcd;
146 struct ehci_hcd *ehci;
147 struct clk *clk;
148 void __iomem *regs;
149 int irq, err;
150 enum orion_ehci_phy_ver phy_version;
151
152 if (usb_disabled())
153 return -ENODEV;
154
155 pr_debug("Initializing Orion-SoC USB Host Controller\n");
156
157 if (pdev->dev.of_node)
158 irq = irq_of_parse_and_map(pdev->dev.of_node, 0);
159 else
160 irq = platform_get_irq(pdev, 0);
161 if (irq <= 0) {
162 dev_err(&pdev->dev,
163 "Found HC with no IRQ. Check %s setup!\n",
164 dev_name(&pdev->dev));
165 err = -ENODEV;
166 goto err1;
167 }
168
169 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
170 if (!res) {
171 dev_err(&pdev->dev,
172 "Found HC with no register addr. Check %s setup!\n",
173 dev_name(&pdev->dev));
174 err = -ENODEV;
175 goto err1;
176 }
177
178 /*
179 * Right now device-tree probed devices don't get dma_mask
180 * set. Since shared usb code relies on it, set it here for
181 * now. Once we have dma capability bindings this can go away.
182 */
183 err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
184 if (err)
185 goto err1;
186
187 regs = devm_ioremap_resource(&pdev->dev, res);
188 if (IS_ERR(regs)) {
189 err = PTR_ERR(regs);
190 goto err1;
191 }
192
193 /* Not all platforms can gate the clock, so it is not
194 an error if the clock does not exists. */
195 clk = devm_clk_get(&pdev->dev, NULL);
196 if (!IS_ERR(clk))
197 clk_prepare_enable(clk);
198
199 hcd = usb_create_hcd(&ehci_orion_hc_driver,
200 &pdev->dev, dev_name(&pdev->dev));
201 if (!hcd) {
202 err = -ENOMEM;
203 goto err2;
204 }
205
206 hcd->rsrc_start = res->start;
207 hcd->rsrc_len = resource_size(res);
208 hcd->regs = regs;
209
210 ehci = hcd_to_ehci(hcd);
211 ehci->caps = hcd->regs + 0x100;
212 hcd->has_tt = 1;
213
214 /*
215 * (Re-)program MBUS remapping windows if we are asked to.
216 */
217 dram = mv_mbus_dram_info();
218 if (dram)
219 ehci_orion_conf_mbus_windows(hcd, dram);
220
221 /*
222 * setup Orion USB controller.
223 */
224 if (pdev->dev.of_node)
225 phy_version = EHCI_PHY_NA;
226 else
227 phy_version = pd->phy_version;
228
229 switch (phy_version) {
230 case EHCI_PHY_NA: /* dont change USB phy settings */
231 break;
232 case EHCI_PHY_ORION:
233 orion_usb_phy_v1_setup(hcd);
234 break;
235 case EHCI_PHY_DD:
236 case EHCI_PHY_KW:
237 default:
238 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
239 }
240
241 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
242 if (err)
243 goto err3;
244
245 device_wakeup_enable(hcd->self.controller);
246 return 0;
247
248err3:
249 usb_put_hcd(hcd);
250err2:
251 if (!IS_ERR(clk))
252 clk_disable_unprepare(clk);
253err1:
254 dev_err(&pdev->dev, "init %s fail, %d\n",
255 dev_name(&pdev->dev), err);
256
257 return err;
258}
259
260static int ehci_orion_drv_remove(struct platform_device *pdev)
261{
262 struct usb_hcd *hcd = platform_get_drvdata(pdev);
263 struct clk *clk;
264
265 usb_remove_hcd(hcd);
266 usb_put_hcd(hcd);
267
268 clk = devm_clk_get(&pdev->dev, NULL);
269 if (!IS_ERR(clk))
270 clk_disable_unprepare(clk);
271 return 0;
272}
273
274static const struct of_device_id ehci_orion_dt_ids[] = {
275 { .compatible = "marvell,orion-ehci", },
276 {},
277};
278MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
279
280static struct platform_driver ehci_orion_driver = {
281 .probe = ehci_orion_drv_probe,
282 .remove = ehci_orion_drv_remove,
283 .shutdown = usb_hcd_platform_shutdown,
284 .driver = {
285 .name = "orion-ehci",
286 .owner = THIS_MODULE,
287 .of_match_table = ehci_orion_dt_ids,
288 },
289};
290
291static int __init ehci_orion_init(void)
292{
293 if (usb_disabled())
294 return -ENODEV;
295
296 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
297
298 ehci_init_driver(&ehci_orion_hc_driver, NULL);
299 return platform_driver_register(&ehci_orion_driver);
300}
301module_init(ehci_orion_init);
302
303static void __exit ehci_orion_cleanup(void)
304{
305 platform_driver_unregister(&ehci_orion_driver);
306}
307module_exit(ehci_orion_cleanup);
308
309MODULE_DESCRIPTION(DRIVER_DESC);
310MODULE_ALIAS("platform:orion-ehci");
311MODULE_AUTHOR("Tzachi Perelstein");
312MODULE_LICENSE("GPL v2");