Commit | Line | Data |
---|---|---|
2ccea03a FB |
1 | /** |
2 | * udc.c - Core UDC Framework | |
3 | * | |
4 | * Copyright (C) 2010 Texas Instruments | |
5 | * Author: Felipe Balbi <balbi@ti.com> | |
6 | * | |
7 | * This program is free software: you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License version 2 of | |
9 | * the License as published by the Free Software Foundation. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <linux/kernel.h> | |
21 | #include <linux/module.h> | |
22 | #include <linux/device.h> | |
23 | #include <linux/list.h> | |
24 | #include <linux/err.h> | |
a698908d | 25 | #include <linux/dma-mapping.h> |
2ccea03a FB |
26 | |
27 | #include <linux/usb/ch9.h> | |
28 | #include <linux/usb/gadget.h> | |
29 | ||
30 | /** | |
31 | * struct usb_udc - describes one usb device controller | |
32 | * @driver - the gadget driver pointer. For use by the class code | |
33 | * @dev - the child device to the actual controller | |
34 | * @gadget - the gadget. For use by the class code | |
35 | * @list - for use by the udc class driver | |
36 | * | |
37 | * This represents the internal data structure which is used by the UDC-class | |
38 | * to hold information about udc driver and gadget together. | |
39 | */ | |
40 | struct usb_udc { | |
41 | struct usb_gadget_driver *driver; | |
42 | struct usb_gadget *gadget; | |
43 | struct device dev; | |
44 | struct list_head list; | |
45 | }; | |
46 | ||
47 | static struct class *udc_class; | |
2ccea03a FB |
48 | static LIST_HEAD(udc_list); |
49 | static DEFINE_MUTEX(udc_lock); | |
50 | ||
51 | /* ------------------------------------------------------------------------- */ | |
52 | ||
a698908d FB |
53 | int usb_gadget_map_request(struct usb_gadget *gadget, |
54 | struct usb_request *req, int is_in) | |
55 | { | |
56 | if (req->length == 0) | |
57 | return 0; | |
58 | ||
59 | if (req->num_sgs) { | |
60 | int mapped; | |
61 | ||
62 | mapped = dma_map_sg(&gadget->dev, req->sg, req->num_sgs, | |
63 | is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE); | |
64 | if (mapped == 0) { | |
65 | dev_err(&gadget->dev, "failed to map SGs\n"); | |
66 | return -EFAULT; | |
67 | } | |
68 | ||
69 | req->num_mapped_sgs = mapped; | |
70 | } else { | |
71 | req->dma = dma_map_single(&gadget->dev, req->buf, req->length, | |
72 | is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE); | |
73 | ||
74 | if (dma_mapping_error(&gadget->dev, req->dma)) { | |
75 | dev_err(&gadget->dev, "failed to map buffer\n"); | |
76 | return -EFAULT; | |
77 | } | |
78 | } | |
79 | ||
80 | return 0; | |
81 | } | |
82 | EXPORT_SYMBOL_GPL(usb_gadget_map_request); | |
83 | ||
84 | void usb_gadget_unmap_request(struct usb_gadget *gadget, | |
85 | struct usb_request *req, int is_in) | |
86 | { | |
87 | if (req->length == 0) | |
88 | return; | |
89 | ||
90 | if (req->num_mapped_sgs) { | |
91 | dma_unmap_sg(&gadget->dev, req->sg, req->num_mapped_sgs, | |
92 | is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE); | |
93 | ||
94 | req->num_mapped_sgs = 0; | |
95 | } else { | |
96 | dma_unmap_single(&gadget->dev, req->dma, req->length, | |
97 | is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE); | |
98 | } | |
99 | } | |
100 | EXPORT_SYMBOL_GPL(usb_gadget_unmap_request); | |
101 | ||
102 | /* ------------------------------------------------------------------------- */ | |
103 | ||
49401f41 FB |
104 | void usb_gadget_set_state(struct usb_gadget *gadget, |
105 | enum usb_device_state state) | |
106 | { | |
107 | gadget->state = state; | |
108 | sysfs_notify(&gadget->dev.kobj, NULL, "status"); | |
109 | } | |
110 | EXPORT_SYMBOL_GPL(usb_gadget_set_state); | |
111 | ||
112 | /* ------------------------------------------------------------------------- */ | |
113 | ||
352c2dc8 SAS |
114 | /** |
115 | * usb_gadget_udc_start - tells usb device controller to start up | |
116 | * @gadget: The gadget we want to get started | |
117 | * @driver: The driver we want to bind to @gadget | |
118 | * | |
119 | * This call is issued by the UDC Class driver when it's about | |
120 | * to register a gadget driver to the device controller, before | |
121 | * calling gadget driver's bind() method. | |
122 | * | |
123 | * It allows the controller to be powered off until strictly | |
124 | * necessary to have it powered on. | |
125 | * | |
126 | * Returns zero on success, else negative errno. | |
127 | */ | |
128 | static inline int usb_gadget_udc_start(struct usb_gadget *gadget, | |
129 | struct usb_gadget_driver *driver) | |
130 | { | |
131 | return gadget->ops->udc_start(gadget, driver); | |
132 | } | |
133 | ||
352c2dc8 SAS |
134 | /** |
135 | * usb_gadget_udc_stop - tells usb device controller we don't need it anymore | |
136 | * @gadget: The device we want to stop activity | |
137 | * @driver: The driver to unbind from @gadget | |
138 | * | |
139 | * This call is issued by the UDC Class driver after calling | |
140 | * gadget driver's unbind() method. | |
141 | * | |
142 | * The details are implementation specific, but it can go as | |
143 | * far as powering off UDC completely and disable its data | |
144 | * line pullups. | |
145 | */ | |
146 | static inline void usb_gadget_udc_stop(struct usb_gadget *gadget, | |
147 | struct usb_gadget_driver *driver) | |
148 | { | |
149 | gadget->ops->udc_stop(gadget, driver); | |
150 | } | |
151 | ||
2ccea03a FB |
152 | /** |
153 | * usb_udc_release - release the usb_udc struct | |
154 | * @dev: the dev member within usb_udc | |
155 | * | |
156 | * This is called by driver's core in order to free memory once the last | |
157 | * reference is released. | |
158 | */ | |
159 | static void usb_udc_release(struct device *dev) | |
160 | { | |
161 | struct usb_udc *udc; | |
162 | ||
163 | udc = container_of(dev, struct usb_udc, dev); | |
164 | dev_dbg(dev, "releasing '%s'\n", dev_name(dev)); | |
165 | kfree(udc); | |
166 | } | |
167 | ||
019f976e | 168 | static const struct attribute_group *usb_udc_attr_groups[]; |
2ccea03a FB |
169 | /** |
170 | * usb_add_gadget_udc - adds a new gadget to the udc class driver list | |
171 | * @parent: the parent device to this udc. Usually the controller | |
172 | * driver's device. | |
173 | * @gadget: the gadget to be added to the list | |
174 | * | |
175 | * Returns zero on success, negative errno otherwise. | |
176 | */ | |
177 | int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget) | |
178 | { | |
179 | struct usb_udc *udc; | |
180 | int ret = -ENOMEM; | |
181 | ||
182 | udc = kzalloc(sizeof(*udc), GFP_KERNEL); | |
183 | if (!udc) | |
184 | goto err1; | |
185 | ||
7bce401c | 186 | dev_set_name(&gadget->dev, "gadget"); |
2ed14320 | 187 | gadget->dev.parent = parent; |
f07bd56b | 188 | |
658c8cf1 FB |
189 | dma_set_coherent_mask(&gadget->dev, parent->coherent_dma_mask); |
190 | gadget->dev.dma_parms = parent->dma_parms; | |
191 | gadget->dev.dma_mask = parent->dma_mask; | |
192 | ||
7bce401c FB |
193 | ret = device_register(&gadget->dev); |
194 | if (ret) | |
195 | goto err2; | |
f07bd56b | 196 | |
2ccea03a FB |
197 | device_initialize(&udc->dev); |
198 | udc->dev.release = usb_udc_release; | |
199 | udc->dev.class = udc_class; | |
019f976e | 200 | udc->dev.groups = usb_udc_attr_groups; |
2ccea03a FB |
201 | udc->dev.parent = parent; |
202 | ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj)); | |
203 | if (ret) | |
f07bd56b | 204 | goto err3; |
2ccea03a FB |
205 | |
206 | udc->gadget = gadget; | |
207 | ||
208 | mutex_lock(&udc_lock); | |
209 | list_add_tail(&udc->list, &udc_list); | |
210 | ||
211 | ret = device_add(&udc->dev); | |
212 | if (ret) | |
f07bd56b | 213 | goto err4; |
2ccea03a | 214 | |
49401f41 FB |
215 | usb_gadget_set_state(gadget, USB_STATE_NOTATTACHED); |
216 | ||
2ccea03a FB |
217 | mutex_unlock(&udc_lock); |
218 | ||
219 | return 0; | |
f07bd56b FB |
220 | |
221 | err4: | |
2ccea03a FB |
222 | list_del(&udc->list); |
223 | mutex_unlock(&udc_lock); | |
224 | ||
f07bd56b | 225 | err3: |
2ccea03a FB |
226 | put_device(&udc->dev); |
227 | ||
f07bd56b | 228 | err2: |
7bce401c FB |
229 | put_device(&gadget->dev); |
230 | ||
2ccea03a FB |
231 | err1: |
232 | return ret; | |
233 | } | |
234 | EXPORT_SYMBOL_GPL(usb_add_gadget_udc); | |
235 | ||
236 | static void usb_gadget_remove_driver(struct usb_udc *udc) | |
237 | { | |
238 | dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n", | |
239 | udc->gadget->name); | |
240 | ||
241 | kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE); | |
242 | ||
2d7ebbb0 FB |
243 | usb_gadget_disconnect(udc->gadget); |
244 | udc->driver->disconnect(udc->gadget); | |
245 | udc->driver->unbind(udc->gadget); | |
246 | usb_gadget_udc_stop(udc->gadget, udc->driver); | |
2ccea03a FB |
247 | |
248 | udc->driver = NULL; | |
249 | udc->dev.driver = NULL; | |
70d3a498 | 250 | udc->gadget->dev.driver = NULL; |
2ccea03a FB |
251 | } |
252 | ||
253 | /** | |
254 | * usb_del_gadget_udc - deletes @udc from udc_list | |
255 | * @gadget: the gadget to be removed. | |
256 | * | |
257 | * This, will call usb_gadget_unregister_driver() if | |
258 | * the @udc is still busy. | |
259 | */ | |
260 | void usb_del_gadget_udc(struct usb_gadget *gadget) | |
261 | { | |
262 | struct usb_udc *udc = NULL; | |
263 | ||
264 | mutex_lock(&udc_lock); | |
265 | list_for_each_entry(udc, &udc_list, list) | |
266 | if (udc->gadget == gadget) | |
267 | goto found; | |
268 | ||
269 | dev_err(gadget->dev.parent, "gadget not registered.\n"); | |
270 | mutex_unlock(&udc_lock); | |
271 | ||
272 | return; | |
273 | ||
274 | found: | |
275 | dev_vdbg(gadget->dev.parent, "unregistering gadget\n"); | |
276 | ||
277 | list_del(&udc->list); | |
278 | mutex_unlock(&udc_lock); | |
279 | ||
280 | if (udc->driver) | |
281 | usb_gadget_remove_driver(udc); | |
282 | ||
283 | kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE); | |
284 | device_unregister(&udc->dev); | |
7bce401c | 285 | device_unregister(&gadget->dev); |
2ccea03a FB |
286 | } |
287 | EXPORT_SYMBOL_GPL(usb_del_gadget_udc); | |
288 | ||
289 | /* ------------------------------------------------------------------------- */ | |
290 | ||
4c49a5f0 | 291 | static int udc_bind_to_driver(struct usb_udc *udc, struct usb_gadget_driver *driver) |
2ccea03a | 292 | { |
4c49a5f0 | 293 | int ret; |
2ccea03a | 294 | |
2ccea03a FB |
295 | dev_dbg(&udc->dev, "registering UDC driver [%s]\n", |
296 | driver->function); | |
297 | ||
298 | udc->driver = driver; | |
299 | udc->dev.driver = &driver->driver; | |
70d3a498 | 300 | udc->gadget->dev.driver = &driver->driver; |
2ccea03a | 301 | |
2d7ebbb0 FB |
302 | ret = driver->bind(udc->gadget, driver); |
303 | if (ret) | |
304 | goto err1; | |
305 | ret = usb_gadget_udc_start(udc->gadget, driver); | |
306 | if (ret) { | |
307 | driver->unbind(udc->gadget); | |
308 | goto err1; | |
352c2dc8 | 309 | } |
2d7ebbb0 | 310 | usb_gadget_connect(udc->gadget); |
2ccea03a FB |
311 | |
312 | kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE); | |
2ccea03a | 313 | return 0; |
2ccea03a FB |
314 | err1: |
315 | dev_err(&udc->dev, "failed to start %s: %d\n", | |
316 | udc->driver->function, ret); | |
317 | udc->driver = NULL; | |
318 | udc->dev.driver = NULL; | |
70d3a498 | 319 | udc->gadget->dev.driver = NULL; |
4c49a5f0 SAS |
320 | return ret; |
321 | } | |
322 | ||
323 | int udc_attach_driver(const char *name, struct usb_gadget_driver *driver) | |
324 | { | |
325 | struct usb_udc *udc = NULL; | |
326 | int ret = -ENODEV; | |
327 | ||
328 | mutex_lock(&udc_lock); | |
329 | list_for_each_entry(udc, &udc_list, list) { | |
330 | ret = strcmp(name, dev_name(&udc->dev)); | |
331 | if (!ret) | |
332 | break; | |
333 | } | |
334 | if (ret) { | |
335 | ret = -ENODEV; | |
336 | goto out; | |
337 | } | |
338 | if (udc->driver) { | |
339 | ret = -EBUSY; | |
340 | goto out; | |
341 | } | |
342 | ret = udc_bind_to_driver(udc, driver); | |
343 | out: | |
344 | mutex_unlock(&udc_lock); | |
345 | return ret; | |
346 | } | |
347 | EXPORT_SYMBOL_GPL(udc_attach_driver); | |
348 | ||
349 | int usb_gadget_probe_driver(struct usb_gadget_driver *driver) | |
350 | { | |
351 | struct usb_udc *udc = NULL; | |
352 | int ret; | |
353 | ||
354 | if (!driver || !driver->bind || !driver->setup) | |
355 | return -EINVAL; | |
356 | ||
357 | mutex_lock(&udc_lock); | |
358 | list_for_each_entry(udc, &udc_list, list) { | |
359 | /* For now we take the first one */ | |
360 | if (!udc->driver) | |
361 | goto found; | |
362 | } | |
363 | ||
364 | pr_debug("couldn't find an available UDC\n"); | |
365 | mutex_unlock(&udc_lock); | |
366 | return -ENODEV; | |
367 | found: | |
368 | ret = udc_bind_to_driver(udc, driver); | |
2ccea03a FB |
369 | mutex_unlock(&udc_lock); |
370 | return ret; | |
371 | } | |
372 | EXPORT_SYMBOL_GPL(usb_gadget_probe_driver); | |
373 | ||
374 | int usb_gadget_unregister_driver(struct usb_gadget_driver *driver) | |
375 | { | |
376 | struct usb_udc *udc = NULL; | |
377 | int ret = -ENODEV; | |
378 | ||
379 | if (!driver || !driver->unbind) | |
380 | return -EINVAL; | |
381 | ||
382 | mutex_lock(&udc_lock); | |
383 | list_for_each_entry(udc, &udc_list, list) | |
384 | if (udc->driver == driver) { | |
385 | usb_gadget_remove_driver(udc); | |
386 | ret = 0; | |
387 | break; | |
388 | } | |
389 | ||
390 | mutex_unlock(&udc_lock); | |
391 | return ret; | |
392 | } | |
393 | EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver); | |
394 | ||
395 | /* ------------------------------------------------------------------------- */ | |
396 | ||
397 | static ssize_t usb_udc_srp_store(struct device *dev, | |
398 | struct device_attribute *attr, const char *buf, size_t n) | |
399 | { | |
1d91a962 | 400 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); |
2ccea03a FB |
401 | |
402 | if (sysfs_streq(buf, "1")) | |
403 | usb_gadget_wakeup(udc->gadget); | |
404 | ||
405 | return n; | |
406 | } | |
407 | static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store); | |
408 | ||
409 | static ssize_t usb_udc_softconn_store(struct device *dev, | |
410 | struct device_attribute *attr, const char *buf, size_t n) | |
411 | { | |
865569ba | 412 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); |
2ccea03a FB |
413 | |
414 | if (sysfs_streq(buf, "connect")) { | |
2d7ebbb0 | 415 | usb_gadget_udc_start(udc->gadget, udc->driver); |
2ccea03a FB |
416 | usb_gadget_connect(udc->gadget); |
417 | } else if (sysfs_streq(buf, "disconnect")) { | |
83a787a7 | 418 | usb_gadget_disconnect(udc->gadget); |
2d7ebbb0 | 419 | usb_gadget_udc_stop(udc->gadget, udc->driver); |
2ccea03a FB |
420 | } else { |
421 | dev_err(dev, "unsupported command '%s'\n", buf); | |
422 | return -EINVAL; | |
423 | } | |
424 | ||
425 | return n; | |
426 | } | |
427 | static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store); | |
428 | ||
49401f41 FB |
429 | static ssize_t usb_gadget_state_show(struct device *dev, |
430 | struct device_attribute *attr, char *buf) | |
431 | { | |
432 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); | |
433 | struct usb_gadget *gadget = udc->gadget; | |
434 | ||
435 | return sprintf(buf, "%s\n", usb_state_string(gadget->state)); | |
436 | } | |
437 | static DEVICE_ATTR(state, S_IRUGO, usb_gadget_state_show, NULL); | |
438 | ||
d327ab5b MN |
439 | #define USB_UDC_SPEED_ATTR(name, param) \ |
440 | ssize_t usb_udc_##param##_show(struct device *dev, \ | |
441 | struct device_attribute *attr, char *buf) \ | |
442 | { \ | |
443 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \ | |
444 | return snprintf(buf, PAGE_SIZE, "%s\n", \ | |
445 | usb_speed_string(udc->gadget->param)); \ | |
446 | } \ | |
447 | static DEVICE_ATTR(name, S_IRUSR, usb_udc_##param##_show, NULL) | |
448 | ||
449 | static USB_UDC_SPEED_ATTR(current_speed, speed); | |
450 | static USB_UDC_SPEED_ATTR(maximum_speed, max_speed); | |
451 | ||
2ccea03a FB |
452 | #define USB_UDC_ATTR(name) \ |
453 | ssize_t usb_udc_##name##_show(struct device *dev, \ | |
454 | struct device_attribute *attr, char *buf) \ | |
455 | { \ | |
019f976e | 456 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \ |
2ccea03a FB |
457 | struct usb_gadget *gadget = udc->gadget; \ |
458 | \ | |
459 | return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \ | |
460 | } \ | |
59d81f81 | 461 | static DEVICE_ATTR(name, S_IRUGO, usb_udc_##name##_show, NULL) |
2ccea03a | 462 | |
2ccea03a FB |
463 | static USB_UDC_ATTR(is_otg); |
464 | static USB_UDC_ATTR(is_a_peripheral); | |
465 | static USB_UDC_ATTR(b_hnp_enable); | |
466 | static USB_UDC_ATTR(a_hnp_support); | |
467 | static USB_UDC_ATTR(a_alt_hnp_support); | |
468 | ||
469 | static struct attribute *usb_udc_attrs[] = { | |
470 | &dev_attr_srp.attr, | |
471 | &dev_attr_soft_connect.attr, | |
49401f41 | 472 | &dev_attr_state.attr, |
d327ab5b MN |
473 | &dev_attr_current_speed.attr, |
474 | &dev_attr_maximum_speed.attr, | |
2ccea03a | 475 | |
2ccea03a FB |
476 | &dev_attr_is_otg.attr, |
477 | &dev_attr_is_a_peripheral.attr, | |
478 | &dev_attr_b_hnp_enable.attr, | |
479 | &dev_attr_a_hnp_support.attr, | |
480 | &dev_attr_a_alt_hnp_support.attr, | |
481 | NULL, | |
482 | }; | |
483 | ||
484 | static const struct attribute_group usb_udc_attr_group = { | |
485 | .attrs = usb_udc_attrs, | |
486 | }; | |
487 | ||
488 | static const struct attribute_group *usb_udc_attr_groups[] = { | |
489 | &usb_udc_attr_group, | |
490 | NULL, | |
491 | }; | |
492 | ||
493 | static int usb_udc_uevent(struct device *dev, struct kobj_uevent_env *env) | |
494 | { | |
495 | struct usb_udc *udc = container_of(dev, struct usb_udc, dev); | |
496 | int ret; | |
497 | ||
498 | ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name); | |
499 | if (ret) { | |
500 | dev_err(dev, "failed to add uevent USB_UDC_NAME\n"); | |
501 | return ret; | |
502 | } | |
503 | ||
504 | if (udc->driver) { | |
505 | ret = add_uevent_var(env, "USB_UDC_DRIVER=%s", | |
506 | udc->driver->function); | |
507 | if (ret) { | |
508 | dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n"); | |
509 | return ret; | |
510 | } | |
511 | } | |
512 | ||
513 | return 0; | |
514 | } | |
515 | ||
516 | static int __init usb_udc_init(void) | |
517 | { | |
518 | udc_class = class_create(THIS_MODULE, "udc"); | |
519 | if (IS_ERR(udc_class)) { | |
520 | pr_err("failed to create udc class --> %ld\n", | |
521 | PTR_ERR(udc_class)); | |
522 | return PTR_ERR(udc_class); | |
523 | } | |
524 | ||
525 | udc_class->dev_uevent = usb_udc_uevent; | |
2ccea03a FB |
526 | return 0; |
527 | } | |
528 | subsys_initcall(usb_udc_init); | |
529 | ||
530 | static void __exit usb_udc_exit(void) | |
531 | { | |
532 | class_destroy(udc_class); | |
533 | } | |
534 | module_exit(usb_udc_exit); | |
535 | ||
536 | MODULE_DESCRIPTION("UDC Framework"); | |
537 | MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>"); | |
538 | MODULE_LICENSE("GPL v2"); |