Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Driver for EHCI UHP on Atmel chips
4 *
5 * Copyright (C) 2009 Atmel Corporation,
6 * Nicolas Ferre <nicolas.ferre@atmel.com>
7 *
8 * Based on various ehci-*.c drivers
9 */
10
11#include <linux/clk.h>
12#include <linux/dma-mapping.h>
13#include <linux/io.h>
14#include <linux/kernel.h>
15#include <linux/module.h>
16#include <linux/of.h>
17#include <linux/of_platform.h>
18#include <linux/platform_device.h>
19#include <linux/usb.h>
20#include <linux/usb/hcd.h>
21#include <linux/usb/phy.h>
22#include <linux/usb/of.h>
23
24#include "ehci.h"
25
26#define DRIVER_DESC "EHCI Atmel driver"
27
28#define EHCI_INSNREG(index) ((index) * 4 + 0x90)
29#define EHCI_INSNREG08_HSIC_EN BIT(2)
30
31/* interface and function clocks */
32#define hcd_to_atmel_ehci_priv(h) \
33 ((struct atmel_ehci_priv *)hcd_to_ehci(h)->priv)
34
35struct atmel_ehci_priv {
36 struct clk *iclk;
37 struct clk *uclk;
38 bool clocked;
39};
40
41static struct hc_driver __read_mostly ehci_atmel_hc_driver;
42
43static const struct ehci_driver_overrides ehci_atmel_drv_overrides __initconst = {
44 .extra_priv_size = sizeof(struct atmel_ehci_priv),
45};
46
47/*-------------------------------------------------------------------------*/
48
49static void atmel_start_clock(struct atmel_ehci_priv *atmel_ehci)
50{
51 if (atmel_ehci->clocked)
52 return;
53
54 clk_prepare_enable(atmel_ehci->uclk);
55 clk_prepare_enable(atmel_ehci->iclk);
56 atmel_ehci->clocked = true;
57}
58
59static void atmel_stop_clock(struct atmel_ehci_priv *atmel_ehci)
60{
61 if (!atmel_ehci->clocked)
62 return;
63
64 clk_disable_unprepare(atmel_ehci->iclk);
65 clk_disable_unprepare(atmel_ehci->uclk);
66 atmel_ehci->clocked = false;
67}
68
69static void atmel_start_ehci(struct platform_device *pdev)
70{
71 struct usb_hcd *hcd = platform_get_drvdata(pdev);
72 struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
73
74 dev_dbg(&pdev->dev, "start\n");
75 atmel_start_clock(atmel_ehci);
76}
77
78static void atmel_stop_ehci(struct platform_device *pdev)
79{
80 struct usb_hcd *hcd = platform_get_drvdata(pdev);
81 struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
82
83 dev_dbg(&pdev->dev, "stop\n");
84 atmel_stop_clock(atmel_ehci);
85}
86
87/*-------------------------------------------------------------------------*/
88
89static int ehci_atmel_drv_probe(struct platform_device *pdev)
90{
91 struct usb_hcd *hcd;
92 const struct hc_driver *driver = &ehci_atmel_hc_driver;
93 struct resource *res;
94 struct ehci_hcd *ehci;
95 struct atmel_ehci_priv *atmel_ehci;
96 int irq;
97 int retval;
98
99 if (usb_disabled())
100 return -ENODEV;
101
102 pr_debug("Initializing Atmel-SoC USB Host Controller\n");
103
104 irq = platform_get_irq(pdev, 0);
105 if (irq < 0) {
106 retval = irq;
107 goto fail_create_hcd;
108 }
109
110 /* Right now device-tree probed devices don't get dma_mask set.
111 * Since shared usb code relies on it, set it here for now.
112 * Once we have dma capability bindings this can go away.
113 */
114 retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
115 if (retval)
116 goto fail_create_hcd;
117
118 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
119 if (!hcd) {
120 retval = -ENOMEM;
121 goto fail_create_hcd;
122 }
123 atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
124
125 hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
126 if (IS_ERR(hcd->regs)) {
127 retval = PTR_ERR(hcd->regs);
128 goto fail_request_resource;
129 }
130
131 hcd->rsrc_start = res->start;
132 hcd->rsrc_len = resource_size(res);
133
134 atmel_ehci->iclk = devm_clk_get(&pdev->dev, "ehci_clk");
135 if (IS_ERR(atmel_ehci->iclk)) {
136 dev_err(&pdev->dev, "Error getting interface clock\n");
137 retval = -ENOENT;
138 goto fail_request_resource;
139 }
140
141 atmel_ehci->uclk = devm_clk_get(&pdev->dev, "usb_clk");
142 if (IS_ERR(atmel_ehci->uclk)) {
143 dev_err(&pdev->dev, "failed to get uclk\n");
144 retval = PTR_ERR(atmel_ehci->uclk);
145 goto fail_request_resource;
146 }
147
148 ehci = hcd_to_ehci(hcd);
149 /* registers start at offset 0x0 */
150 ehci->caps = hcd->regs;
151
152 atmel_start_ehci(pdev);
153
154 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
155 if (retval)
156 goto fail_add_hcd;
157 device_wakeup_enable(hcd->self.controller);
158
159 if (of_usb_get_phy_mode(pdev->dev.of_node) == USBPHY_INTERFACE_MODE_HSIC)
160 writel(EHCI_INSNREG08_HSIC_EN, hcd->regs + EHCI_INSNREG(8));
161
162 return retval;
163
164fail_add_hcd:
165 atmel_stop_ehci(pdev);
166fail_request_resource:
167 usb_put_hcd(hcd);
168fail_create_hcd:
169 dev_err(&pdev->dev, "init %s fail, %d\n",
170 dev_name(&pdev->dev), retval);
171
172 return retval;
173}
174
175static void ehci_atmel_drv_remove(struct platform_device *pdev)
176{
177 struct usb_hcd *hcd = platform_get_drvdata(pdev);
178
179 usb_remove_hcd(hcd);
180 usb_put_hcd(hcd);
181
182 atmel_stop_ehci(pdev);
183}
184
185static int __maybe_unused ehci_atmel_drv_suspend(struct device *dev)
186{
187 struct usb_hcd *hcd = dev_get_drvdata(dev);
188 struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
189 int ret;
190
191 ret = ehci_suspend(hcd, false);
192 if (ret)
193 return ret;
194
195 atmel_stop_clock(atmel_ehci);
196 return 0;
197}
198
199static int __maybe_unused ehci_atmel_drv_resume(struct device *dev)
200{
201 struct usb_hcd *hcd = dev_get_drvdata(dev);
202 struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
203
204 atmel_start_clock(atmel_ehci);
205 ehci_resume(hcd, false);
206 return 0;
207}
208
209#ifdef CONFIG_OF
210static const struct of_device_id atmel_ehci_dt_ids[] = {
211 { .compatible = "atmel,at91sam9g45-ehci" },
212 { /* sentinel */ }
213};
214
215MODULE_DEVICE_TABLE(of, atmel_ehci_dt_ids);
216#endif
217
218static SIMPLE_DEV_PM_OPS(ehci_atmel_pm_ops, ehci_atmel_drv_suspend,
219 ehci_atmel_drv_resume);
220
221static struct platform_driver ehci_atmel_driver = {
222 .probe = ehci_atmel_drv_probe,
223 .remove_new = ehci_atmel_drv_remove,
224 .shutdown = usb_hcd_platform_shutdown,
225 .driver = {
226 .name = "atmel-ehci",
227 .pm = &ehci_atmel_pm_ops,
228 .of_match_table = of_match_ptr(atmel_ehci_dt_ids),
229 },
230};
231
232static int __init ehci_atmel_init(void)
233{
234 if (usb_disabled())
235 return -ENODEV;
236
237 ehci_init_driver(&ehci_atmel_hc_driver, &ehci_atmel_drv_overrides);
238 return platform_driver_register(&ehci_atmel_driver);
239}
240module_init(ehci_atmel_init);
241
242static void __exit ehci_atmel_cleanup(void)
243{
244 platform_driver_unregister(&ehci_atmel_driver);
245}
246module_exit(ehci_atmel_cleanup);
247
248MODULE_DESCRIPTION(DRIVER_DESC);
249MODULE_ALIAS("platform:atmel-ehci");
250MODULE_AUTHOR("Nicolas Ferre");
251MODULE_LICENSE("GPL");
1/*
2 * Driver for EHCI UHP on Atmel chips
3 *
4 * Copyright (C) 2009 Atmel Corporation,
5 * Nicolas Ferre <nicolas.ferre@atmel.com>
6 *
7 * Based on various ehci-*.c drivers
8 *
9 * This file is subject to the terms and conditions of the GNU General Public
10 * License. See the file COPYING in the main directory of this archive for
11 * more details.
12 */
13
14#include <linux/clk.h>
15#include <linux/platform_device.h>
16
17/* interface and function clocks */
18static struct clk *iclk, *fclk;
19static int clocked;
20
21/*-------------------------------------------------------------------------*/
22
23static void atmel_start_clock(void)
24{
25 clk_enable(iclk);
26 clk_enable(fclk);
27 clocked = 1;
28}
29
30static void atmel_stop_clock(void)
31{
32 clk_disable(fclk);
33 clk_disable(iclk);
34 clocked = 0;
35}
36
37static void atmel_start_ehci(struct platform_device *pdev)
38{
39 dev_dbg(&pdev->dev, "start\n");
40 atmel_start_clock();
41}
42
43static void atmel_stop_ehci(struct platform_device *pdev)
44{
45 dev_dbg(&pdev->dev, "stop\n");
46 atmel_stop_clock();
47}
48
49/*-------------------------------------------------------------------------*/
50
51static int ehci_atmel_setup(struct usb_hcd *hcd)
52{
53 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
54 int retval = 0;
55
56 /* registers start at offset 0x0 */
57 ehci->caps = hcd->regs;
58 ehci->regs = hcd->regs +
59 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
60 dbg_hcs_params(ehci, "reset");
61 dbg_hcc_params(ehci, "reset");
62
63 /* cache this readonly data; minimize chip reads */
64 ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
65
66 retval = ehci_halt(ehci);
67 if (retval)
68 return retval;
69
70 /* data structure init */
71 retval = ehci_init(hcd);
72 if (retval)
73 return retval;
74
75 ehci->sbrn = 0x20;
76
77 ehci_reset(ehci);
78 ehci_port_power(ehci, 0);
79
80 return retval;
81}
82
83static const struct hc_driver ehci_atmel_hc_driver = {
84 .description = hcd_name,
85 .product_desc = "Atmel EHCI UHP HS",
86 .hcd_priv_size = sizeof(struct ehci_hcd),
87
88 /* generic hardware linkage */
89 .irq = ehci_irq,
90 .flags = HCD_MEMORY | HCD_USB2,
91
92 /* basic lifecycle operations */
93 .reset = ehci_atmel_setup,
94 .start = ehci_run,
95 .stop = ehci_stop,
96 .shutdown = ehci_shutdown,
97
98 /* managing i/o requests and associated device resources */
99 .urb_enqueue = ehci_urb_enqueue,
100 .urb_dequeue = ehci_urb_dequeue,
101 .endpoint_disable = ehci_endpoint_disable,
102 .endpoint_reset = ehci_endpoint_reset,
103
104 /* scheduling support */
105 .get_frame_number = ehci_get_frame,
106
107 /* root hub support */
108 .hub_status_data = ehci_hub_status_data,
109 .hub_control = ehci_hub_control,
110 .bus_suspend = ehci_bus_suspend,
111 .bus_resume = ehci_bus_resume,
112 .relinquish_port = ehci_relinquish_port,
113 .port_handed_over = ehci_port_handed_over,
114
115 .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
116};
117
118static int __devinit ehci_atmel_drv_probe(struct platform_device *pdev)
119{
120 struct usb_hcd *hcd;
121 const struct hc_driver *driver = &ehci_atmel_hc_driver;
122 struct resource *res;
123 int irq;
124 int retval;
125
126 if (usb_disabled())
127 return -ENODEV;
128
129 pr_debug("Initializing Atmel-SoC USB Host Controller\n");
130
131 irq = platform_get_irq(pdev, 0);
132 if (irq <= 0) {
133 dev_err(&pdev->dev,
134 "Found HC with no IRQ. Check %s setup!\n",
135 dev_name(&pdev->dev));
136 retval = -ENODEV;
137 goto fail_create_hcd;
138 }
139
140 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
141 if (!hcd) {
142 retval = -ENOMEM;
143 goto fail_create_hcd;
144 }
145
146 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
147 if (!res) {
148 dev_err(&pdev->dev,
149 "Found HC with no register addr. Check %s setup!\n",
150 dev_name(&pdev->dev));
151 retval = -ENODEV;
152 goto fail_request_resource;
153 }
154 hcd->rsrc_start = res->start;
155 hcd->rsrc_len = resource_size(res);
156
157 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
158 driver->description)) {
159 dev_dbg(&pdev->dev, "controller already in use\n");
160 retval = -EBUSY;
161 goto fail_request_resource;
162 }
163
164 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
165 if (hcd->regs == NULL) {
166 dev_dbg(&pdev->dev, "error mapping memory\n");
167 retval = -EFAULT;
168 goto fail_ioremap;
169 }
170
171 iclk = clk_get(&pdev->dev, "ehci_clk");
172 if (IS_ERR(iclk)) {
173 dev_err(&pdev->dev, "Error getting interface clock\n");
174 retval = -ENOENT;
175 goto fail_get_iclk;
176 }
177 fclk = clk_get(&pdev->dev, "uhpck");
178 if (IS_ERR(fclk)) {
179 dev_err(&pdev->dev, "Error getting function clock\n");
180 retval = -ENOENT;
181 goto fail_get_fclk;
182 }
183
184 atmel_start_ehci(pdev);
185
186 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
187 if (retval)
188 goto fail_add_hcd;
189
190 return retval;
191
192fail_add_hcd:
193 atmel_stop_ehci(pdev);
194 clk_put(fclk);
195fail_get_fclk:
196 clk_put(iclk);
197fail_get_iclk:
198 iounmap(hcd->regs);
199fail_ioremap:
200 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
201fail_request_resource:
202 usb_put_hcd(hcd);
203fail_create_hcd:
204 dev_err(&pdev->dev, "init %s fail, %d\n",
205 dev_name(&pdev->dev), retval);
206
207 return retval;
208}
209
210static int __devexit ehci_atmel_drv_remove(struct platform_device *pdev)
211{
212 struct usb_hcd *hcd = platform_get_drvdata(pdev);
213
214 ehci_shutdown(hcd);
215 usb_remove_hcd(hcd);
216 iounmap(hcd->regs);
217 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
218 usb_put_hcd(hcd);
219
220 atmel_stop_ehci(pdev);
221 clk_put(fclk);
222 clk_put(iclk);
223 fclk = iclk = NULL;
224
225 return 0;
226}
227
228static struct platform_driver ehci_atmel_driver = {
229 .probe = ehci_atmel_drv_probe,
230 .remove = __devexit_p(ehci_atmel_drv_remove),
231 .shutdown = usb_hcd_platform_shutdown,
232 .driver.name = "atmel-ehci",
233};