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