1 | // SPDX-License-Identifier: GPL-1.0+ |
2 | /* |
3 | * OHCI HCD (Host Controller Driver) for USB. |
4 | * |
5 | * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at> |
6 | * (C) Copyright 2000-2005 David Brownell |
7 | * (C) Copyright 2002 Hewlett-Packard Company |
8 | * (C) Copyright 2008 Magnus Damm |
9 | * |
10 | * SM501 Bus Glue - based on ohci-omap.c |
11 | * |
12 | * This file is licenced under the GPL. |
13 | */ |
14 | |
15 | #include <linux/interrupt.h> |
16 | #include <linux/jiffies.h> |
17 | #include <linux/platform_device.h> |
18 | #include <linux/dma-mapping.h> |
19 | #include <linux/sm501.h> |
20 | #include <linux/sm501-regs.h> |
21 | |
22 | static int ohci_sm501_init(struct usb_hcd *hcd) |
23 | { |
24 | return ohci_init(ohci: hcd_to_ohci(hcd)); |
25 | } |
26 | |
27 | static int ohci_sm501_start(struct usb_hcd *hcd) |
28 | { |
29 | struct device *dev = hcd->self.controller; |
30 | int ret; |
31 | |
32 | ret = ohci_run(ohci: hcd_to_ohci(hcd)); |
33 | if (ret < 0) { |
34 | dev_err(dev, "can't start %s" , hcd->self.bus_name); |
35 | ohci_stop(hcd); |
36 | } |
37 | |
38 | return ret; |
39 | } |
40 | |
41 | /*-------------------------------------------------------------------------*/ |
42 | |
43 | static const struct hc_driver ohci_sm501_hc_driver = { |
44 | .description = hcd_name, |
45 | .product_desc = "SM501 OHCI" , |
46 | .hcd_priv_size = sizeof(struct ohci_hcd), |
47 | |
48 | /* |
49 | * generic hardware linkage |
50 | */ |
51 | .irq = ohci_irq, |
52 | .flags = HCD_USB11 | HCD_MEMORY, |
53 | |
54 | /* |
55 | * basic lifecycle operations |
56 | */ |
57 | .reset = ohci_sm501_init, |
58 | .start = ohci_sm501_start, |
59 | .stop = ohci_stop, |
60 | .shutdown = ohci_shutdown, |
61 | |
62 | /* |
63 | * managing i/o requests and associated device resources |
64 | */ |
65 | .urb_enqueue = ohci_urb_enqueue, |
66 | .urb_dequeue = ohci_urb_dequeue, |
67 | .endpoint_disable = ohci_endpoint_disable, |
68 | |
69 | /* |
70 | * scheduling support |
71 | */ |
72 | .get_frame_number = ohci_get_frame, |
73 | |
74 | /* |
75 | * root hub support |
76 | */ |
77 | .hub_status_data = ohci_hub_status_data, |
78 | .hub_control = ohci_hub_control, |
79 | #ifdef CONFIG_PM |
80 | .bus_suspend = ohci_bus_suspend, |
81 | .bus_resume = ohci_bus_resume, |
82 | #endif |
83 | .start_port_reset = ohci_start_port_reset, |
84 | }; |
85 | |
86 | /*-------------------------------------------------------------------------*/ |
87 | |
88 | static int ohci_hcd_sm501_drv_probe(struct platform_device *pdev) |
89 | { |
90 | const struct hc_driver *driver = &ohci_sm501_hc_driver; |
91 | struct device *dev = &pdev->dev; |
92 | struct resource *res, *mem; |
93 | int retval, irq; |
94 | struct usb_hcd *hcd = NULL; |
95 | |
96 | irq = retval = platform_get_irq(pdev, 0); |
97 | if (retval < 0) |
98 | goto err0; |
99 | |
100 | mem = platform_get_resource(pdev, IORESOURCE_MEM, 1); |
101 | if (mem == NULL) { |
102 | dev_err(dev, "no resource definition for memory\n" ); |
103 | retval = -ENOENT; |
104 | goto err0; |
105 | } |
106 | |
107 | if (!request_mem_region(mem->start, resource_size(mem), pdev->name)) { |
108 | dev_err(dev, "request_mem_region failed\n" ); |
109 | retval = -EBUSY; |
110 | goto err0; |
111 | } |
112 | |
113 | /* allocate, reserve and remap resources for registers */ |
114 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
115 | if (res == NULL) { |
116 | dev_err(dev, "no resource definition for registers\n" ); |
117 | retval = -ENOENT; |
118 | goto err1; |
119 | } |
120 | |
121 | hcd = usb_create_hcd(driver, dev: &pdev->dev, bus_name: dev_name(dev: &pdev->dev)); |
122 | if (!hcd) { |
123 | retval = -ENOMEM; |
124 | goto err1; |
125 | } |
126 | |
127 | hcd->rsrc_start = res->start; |
128 | hcd->rsrc_len = resource_size(res); |
129 | |
130 | if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, pdev->name)) { |
131 | dev_err(dev, "request_mem_region failed\n" ); |
132 | retval = -EBUSY; |
133 | goto err3; |
134 | } |
135 | |
136 | hcd->regs = ioremap(offset: hcd->rsrc_start, size: hcd->rsrc_len); |
137 | if (hcd->regs == NULL) { |
138 | dev_err(dev, "cannot remap registers\n" ); |
139 | retval = -ENXIO; |
140 | goto err4; |
141 | } |
142 | |
143 | ohci_hcd_init(ohci: hcd_to_ohci(hcd)); |
144 | |
145 | /* The sm501 chip is equipped with local memory that may be used |
146 | * by on-chip devices such as the video controller and the usb host. |
147 | * This driver uses genalloc so that usb allocations with |
148 | * gen_pool_dma_alloc() allocate from this local memory. The dma_handle |
149 | * returned by gen_pool_dma_alloc() will be an offset starting from 0 |
150 | * for the first local memory byte. |
151 | * |
152 | * So as long as data is allocated using gen_pool_dma_alloc() all is |
153 | * fine. This is however not always the case - buffers may be allocated |
154 | * using kmalloc() - so the usb core needs to be told that it must copy |
155 | * data into our local memory if the buffers happen to be placed in |
156 | * regular memory. A non-null hcd->localmem_pool initialized by |
157 | * the call to usb_hcd_setup_local_mem() below does just that. |
158 | */ |
159 | |
160 | retval = usb_hcd_setup_local_mem(hcd, phys_addr: mem->start, |
161 | dma: mem->start - mem->parent->start, |
162 | size: resource_size(res: mem)); |
163 | if (retval < 0) |
164 | goto err5; |
165 | retval = usb_add_hcd(hcd, irqnum: irq, IRQF_SHARED); |
166 | if (retval) |
167 | goto err5; |
168 | device_wakeup_enable(dev: hcd->self.controller); |
169 | |
170 | /* enable power and unmask interrupts */ |
171 | |
172 | sm501_unit_power(dev: dev->parent, SM501_GATE_USB_HOST, to: 1); |
173 | sm501_modify_reg(dev: dev->parent, SM501_IRQ_MASK, set: 1 << 6, clear: 0); |
174 | |
175 | return 0; |
176 | err5: |
177 | iounmap(addr: hcd->regs); |
178 | err4: |
179 | release_mem_region(hcd->rsrc_start, hcd->rsrc_len); |
180 | err3: |
181 | usb_put_hcd(hcd); |
182 | err1: |
183 | release_mem_region(mem->start, resource_size(mem)); |
184 | err0: |
185 | return retval; |
186 | } |
187 | |
188 | static void ohci_hcd_sm501_drv_remove(struct platform_device *pdev) |
189 | { |
190 | struct usb_hcd *hcd = platform_get_drvdata(pdev); |
191 | struct resource *mem; |
192 | |
193 | usb_remove_hcd(hcd); |
194 | iounmap(addr: hcd->regs); |
195 | release_mem_region(hcd->rsrc_start, hcd->rsrc_len); |
196 | usb_put_hcd(hcd); |
197 | mem = platform_get_resource(pdev, IORESOURCE_MEM, 1); |
198 | release_mem_region(mem->start, resource_size(mem)); |
199 | |
200 | /* mask interrupts and disable power */ |
201 | |
202 | sm501_modify_reg(dev: pdev->dev.parent, SM501_IRQ_MASK, set: 0, clear: 1 << 6); |
203 | sm501_unit_power(dev: pdev->dev.parent, SM501_GATE_USB_HOST, to: 0); |
204 | } |
205 | |
206 | /*-------------------------------------------------------------------------*/ |
207 | |
208 | #ifdef CONFIG_PM |
209 | static int ohci_sm501_suspend(struct platform_device *pdev, pm_message_t msg) |
210 | { |
211 | struct device *dev = &pdev->dev; |
212 | struct usb_hcd *hcd = platform_get_drvdata(pdev); |
213 | struct ohci_hcd *ohci = hcd_to_ohci(hcd); |
214 | bool do_wakeup = device_may_wakeup(dev); |
215 | int ret; |
216 | |
217 | if (time_before(jiffies, ohci->next_statechange)) |
218 | msleep(msecs: 5); |
219 | ohci->next_statechange = jiffies; |
220 | |
221 | ret = ohci_suspend(hcd, do_wakeup); |
222 | if (ret) |
223 | return ret; |
224 | |
225 | sm501_unit_power(dev: dev->parent, SM501_GATE_USB_HOST, to: 0); |
226 | return ret; |
227 | } |
228 | |
229 | static int ohci_sm501_resume(struct platform_device *pdev) |
230 | { |
231 | struct device *dev = &pdev->dev; |
232 | struct usb_hcd *hcd = platform_get_drvdata(pdev); |
233 | struct ohci_hcd *ohci = hcd_to_ohci(hcd); |
234 | |
235 | if (time_before(jiffies, ohci->next_statechange)) |
236 | msleep(msecs: 5); |
237 | ohci->next_statechange = jiffies; |
238 | |
239 | sm501_unit_power(dev: dev->parent, SM501_GATE_USB_HOST, to: 1); |
240 | ohci_resume(hcd, false); |
241 | return 0; |
242 | } |
243 | #else |
244 | #define ohci_sm501_suspend NULL |
245 | #define ohci_sm501_resume NULL |
246 | #endif |
247 | |
248 | /*-------------------------------------------------------------------------*/ |
249 | |
250 | /* |
251 | * Driver definition to register with the SM501 bus |
252 | */ |
253 | static struct platform_driver ohci_hcd_sm501_driver = { |
254 | .probe = ohci_hcd_sm501_drv_probe, |
255 | .remove_new = ohci_hcd_sm501_drv_remove, |
256 | .shutdown = usb_hcd_platform_shutdown, |
257 | .suspend = ohci_sm501_suspend, |
258 | .resume = ohci_sm501_resume, |
259 | .driver = { |
260 | .name = "sm501-usb" , |
261 | }, |
262 | }; |
263 | MODULE_ALIAS("platform:sm501-usb" ); |
264 | |