usb: gadget: s3c2410: convert to udc_start/udc_stop
[linux-2.6-block.git] / drivers / usb / gadget / udc-core.c
CommitLineData
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 */
40struct usb_udc {
41 struct usb_gadget_driver *driver;
42 struct usb_gadget *gadget;
43 struct device dev;
44 struct list_head list;
45};
46
47static struct class *udc_class;
2ccea03a
FB
48static LIST_HEAD(udc_list);
49static DEFINE_MUTEX(udc_lock);
50
51/* ------------------------------------------------------------------------- */
52
a698908d
FB
53int 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}
82EXPORT_SYMBOL_GPL(usb_gadget_map_request);
83
84void 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}
100EXPORT_SYMBOL_GPL(usb_gadget_unmap_request);
101
102/* ------------------------------------------------------------------------- */
103
2ccea03a
FB
104/**
105 * usb_gadget_start - tells usb device controller to start up
106 * @gadget: The gadget we want to get started
107 * @driver: The driver we want to bind to @gadget
108 * @bind: The bind function for @driver
109 *
110 * This call is issued by the UDC Class driver when it's about
111 * to register a gadget driver to the device controller, before
112 * calling gadget driver's bind() method.
113 *
114 * It allows the controller to be powered off until strictly
115 * necessary to have it powered on.
116 *
117 * Returns zero on success, else negative errno.
118 */
119static inline int usb_gadget_start(struct usb_gadget *gadget,
120 struct usb_gadget_driver *driver,
ffe0b335 121 int (*bind)(struct usb_gadget *, struct usb_gadget_driver *))
2ccea03a
FB
122{
123 return gadget->ops->start(driver, bind);
124}
125
352c2dc8
SAS
126/**
127 * usb_gadget_udc_start - tells usb device controller to start up
128 * @gadget: The gadget we want to get started
129 * @driver: The driver we want to bind to @gadget
130 *
131 * This call is issued by the UDC Class driver when it's about
132 * to register a gadget driver to the device controller, before
133 * calling gadget driver's bind() method.
134 *
135 * It allows the controller to be powered off until strictly
136 * necessary to have it powered on.
137 *
138 * Returns zero on success, else negative errno.
139 */
140static inline int usb_gadget_udc_start(struct usb_gadget *gadget,
141 struct usb_gadget_driver *driver)
142{
143 return gadget->ops->udc_start(gadget, driver);
144}
145
2ccea03a
FB
146/**
147 * usb_gadget_stop - tells usb device controller we don't need it anymore
148 * @gadget: The device we want to stop activity
149 * @driver: The driver to unbind from @gadget
150 *
151 * This call is issued by the UDC Class driver after calling
152 * gadget driver's unbind() method.
153 *
154 * The details are implementation specific, but it can go as
155 * far as powering off UDC completely and disable its data
156 * line pullups.
157 */
158static inline void usb_gadget_stop(struct usb_gadget *gadget,
159 struct usb_gadget_driver *driver)
160{
161 gadget->ops->stop(driver);
162}
163
352c2dc8
SAS
164/**
165 * usb_gadget_udc_stop - tells usb device controller we don't need it anymore
166 * @gadget: The device we want to stop activity
167 * @driver: The driver to unbind from @gadget
168 *
169 * This call is issued by the UDC Class driver after calling
170 * gadget driver's unbind() method.
171 *
172 * The details are implementation specific, but it can go as
173 * far as powering off UDC completely and disable its data
174 * line pullups.
175 */
176static inline void usb_gadget_udc_stop(struct usb_gadget *gadget,
177 struct usb_gadget_driver *driver)
178{
179 gadget->ops->udc_stop(gadget, driver);
180}
181
2ccea03a
FB
182/**
183 * usb_udc_release - release the usb_udc struct
184 * @dev: the dev member within usb_udc
185 *
186 * This is called by driver's core in order to free memory once the last
187 * reference is released.
188 */
189static void usb_udc_release(struct device *dev)
190{
191 struct usb_udc *udc;
192
193 udc = container_of(dev, struct usb_udc, dev);
194 dev_dbg(dev, "releasing '%s'\n", dev_name(dev));
195 kfree(udc);
196}
197
019f976e 198static const struct attribute_group *usb_udc_attr_groups[];
2ccea03a
FB
199/**
200 * usb_add_gadget_udc - adds a new gadget to the udc class driver list
201 * @parent: the parent device to this udc. Usually the controller
202 * driver's device.
203 * @gadget: the gadget to be added to the list
204 *
205 * Returns zero on success, negative errno otherwise.
206 */
207int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget)
208{
209 struct usb_udc *udc;
210 int ret = -ENOMEM;
211
212 udc = kzalloc(sizeof(*udc), GFP_KERNEL);
213 if (!udc)
214 goto err1;
215
216 device_initialize(&udc->dev);
217 udc->dev.release = usb_udc_release;
218 udc->dev.class = udc_class;
019f976e 219 udc->dev.groups = usb_udc_attr_groups;
2ccea03a
FB
220 udc->dev.parent = parent;
221 ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj));
222 if (ret)
223 goto err2;
224
225 udc->gadget = gadget;
226
227 mutex_lock(&udc_lock);
228 list_add_tail(&udc->list, &udc_list);
229
230 ret = device_add(&udc->dev);
231 if (ret)
232 goto err3;
233
234 mutex_unlock(&udc_lock);
235
236 return 0;
237err3:
238 list_del(&udc->list);
239 mutex_unlock(&udc_lock);
240
241err2:
242 put_device(&udc->dev);
243
244err1:
245 return ret;
246}
247EXPORT_SYMBOL_GPL(usb_add_gadget_udc);
248
352c2dc8
SAS
249static int udc_is_newstyle(struct usb_udc *udc)
250{
251 if (udc->gadget->ops->udc_start && udc->gadget->ops->udc_stop)
252 return 1;
253 return 0;
254}
255
256
2ccea03a
FB
257static void usb_gadget_remove_driver(struct usb_udc *udc)
258{
259 dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n",
260 udc->gadget->name);
261
262 kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
263
352c2dc8 264 if (udc_is_newstyle(udc)) {
6f39504d 265 usb_gadget_disconnect(udc->gadget);
974e9323 266 udc->driver->disconnect(udc->gadget);
320cd1e7 267 udc->driver->unbind(udc->gadget);
8ae8090c 268 usb_gadget_udc_stop(udc->gadget, udc->driver);
352c2dc8
SAS
269 } else {
270 usb_gadget_stop(udc->gadget, udc->driver);
271 }
2ccea03a
FB
272
273 udc->driver = NULL;
274 udc->dev.driver = NULL;
275}
276
277/**
278 * usb_del_gadget_udc - deletes @udc from udc_list
279 * @gadget: the gadget to be removed.
280 *
281 * This, will call usb_gadget_unregister_driver() if
282 * the @udc is still busy.
283 */
284void usb_del_gadget_udc(struct usb_gadget *gadget)
285{
286 struct usb_udc *udc = NULL;
287
288 mutex_lock(&udc_lock);
289 list_for_each_entry(udc, &udc_list, list)
290 if (udc->gadget == gadget)
291 goto found;
292
293 dev_err(gadget->dev.parent, "gadget not registered.\n");
294 mutex_unlock(&udc_lock);
295
296 return;
297
298found:
299 dev_vdbg(gadget->dev.parent, "unregistering gadget\n");
300
301 list_del(&udc->list);
302 mutex_unlock(&udc_lock);
303
304 if (udc->driver)
305 usb_gadget_remove_driver(udc);
306
307 kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE);
308 device_unregister(&udc->dev);
309}
310EXPORT_SYMBOL_GPL(usb_del_gadget_udc);
311
312/* ------------------------------------------------------------------------- */
313
4c49a5f0 314static int udc_bind_to_driver(struct usb_udc *udc, struct usb_gadget_driver *driver)
2ccea03a 315{
4c49a5f0 316 int ret;
2ccea03a 317
2ccea03a
FB
318 dev_dbg(&udc->dev, "registering UDC driver [%s]\n",
319 driver->function);
320
321 udc->driver = driver;
322 udc->dev.driver = &driver->driver;
323
352c2dc8 324 if (udc_is_newstyle(udc)) {
ffe0b335 325 ret = driver->bind(udc->gadget, driver);
352c2dc8
SAS
326 if (ret)
327 goto err1;
328 ret = usb_gadget_udc_start(udc->gadget, driver);
329 if (ret) {
330 driver->unbind(udc->gadget);
331 goto err1;
332 }
333 usb_gadget_connect(udc->gadget);
334 } else {
335
93952956 336 ret = usb_gadget_start(udc->gadget, driver, driver->bind);
352c2dc8
SAS
337 if (ret)
338 goto err1;
352c2dc8 339 }
2ccea03a
FB
340
341 kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
2ccea03a 342 return 0;
2ccea03a
FB
343err1:
344 dev_err(&udc->dev, "failed to start %s: %d\n",
345 udc->driver->function, ret);
346 udc->driver = NULL;
347 udc->dev.driver = NULL;
4c49a5f0
SAS
348 return ret;
349}
350
351int udc_attach_driver(const char *name, struct usb_gadget_driver *driver)
352{
353 struct usb_udc *udc = NULL;
354 int ret = -ENODEV;
355
356 mutex_lock(&udc_lock);
357 list_for_each_entry(udc, &udc_list, list) {
358 ret = strcmp(name, dev_name(&udc->dev));
359 if (!ret)
360 break;
361 }
362 if (ret) {
363 ret = -ENODEV;
364 goto out;
365 }
366 if (udc->driver) {
367 ret = -EBUSY;
368 goto out;
369 }
370 ret = udc_bind_to_driver(udc, driver);
371out:
372 mutex_unlock(&udc_lock);
373 return ret;
374}
375EXPORT_SYMBOL_GPL(udc_attach_driver);
376
377int usb_gadget_probe_driver(struct usb_gadget_driver *driver)
378{
379 struct usb_udc *udc = NULL;
380 int ret;
381
382 if (!driver || !driver->bind || !driver->setup)
383 return -EINVAL;
384
385 mutex_lock(&udc_lock);
386 list_for_each_entry(udc, &udc_list, list) {
387 /* For now we take the first one */
388 if (!udc->driver)
389 goto found;
390 }
391
392 pr_debug("couldn't find an available UDC\n");
393 mutex_unlock(&udc_lock);
394 return -ENODEV;
395found:
396 ret = udc_bind_to_driver(udc, driver);
2ccea03a
FB
397 mutex_unlock(&udc_lock);
398 return ret;
399}
400EXPORT_SYMBOL_GPL(usb_gadget_probe_driver);
401
402int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
403{
404 struct usb_udc *udc = NULL;
405 int ret = -ENODEV;
406
407 if (!driver || !driver->unbind)
408 return -EINVAL;
409
410 mutex_lock(&udc_lock);
411 list_for_each_entry(udc, &udc_list, list)
412 if (udc->driver == driver) {
413 usb_gadget_remove_driver(udc);
414 ret = 0;
415 break;
416 }
417
418 mutex_unlock(&udc_lock);
419 return ret;
420}
421EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver);
422
423/* ------------------------------------------------------------------------- */
424
425static ssize_t usb_udc_srp_store(struct device *dev,
426 struct device_attribute *attr, const char *buf, size_t n)
427{
1d91a962 428 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a
FB
429
430 if (sysfs_streq(buf, "1"))
431 usb_gadget_wakeup(udc->gadget);
432
433 return n;
434}
435static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store);
436
437static ssize_t usb_udc_softconn_store(struct device *dev,
438 struct device_attribute *attr, const char *buf, size_t n)
439{
865569ba 440 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a
FB
441
442 if (sysfs_streq(buf, "connect")) {
6d258a4c
FB
443 if (udc_is_newstyle(udc))
444 usb_gadget_udc_start(udc->gadget, udc->driver);
2ccea03a
FB
445 usb_gadget_connect(udc->gadget);
446 } else if (sysfs_streq(buf, "disconnect")) {
83a787a7 447 usb_gadget_disconnect(udc->gadget);
6d258a4c
FB
448 if (udc_is_newstyle(udc))
449 usb_gadget_udc_stop(udc->gadget, udc->driver);
2ccea03a
FB
450 } else {
451 dev_err(dev, "unsupported command '%s'\n", buf);
452 return -EINVAL;
453 }
454
455 return n;
456}
457static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store);
458
d327ab5b
MN
459#define USB_UDC_SPEED_ATTR(name, param) \
460ssize_t usb_udc_##param##_show(struct device *dev, \
461 struct device_attribute *attr, char *buf) \
462{ \
463 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
464 return snprintf(buf, PAGE_SIZE, "%s\n", \
465 usb_speed_string(udc->gadget->param)); \
466} \
467static DEVICE_ATTR(name, S_IRUSR, usb_udc_##param##_show, NULL)
468
469static USB_UDC_SPEED_ATTR(current_speed, speed);
470static USB_UDC_SPEED_ATTR(maximum_speed, max_speed);
471
2ccea03a
FB
472#define USB_UDC_ATTR(name) \
473ssize_t usb_udc_##name##_show(struct device *dev, \
474 struct device_attribute *attr, char *buf) \
475{ \
019f976e 476 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
2ccea03a
FB
477 struct usb_gadget *gadget = udc->gadget; \
478 \
479 return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \
480} \
59d81f81 481static DEVICE_ATTR(name, S_IRUGO, usb_udc_##name##_show, NULL)
2ccea03a 482
2ccea03a
FB
483static USB_UDC_ATTR(is_otg);
484static USB_UDC_ATTR(is_a_peripheral);
485static USB_UDC_ATTR(b_hnp_enable);
486static USB_UDC_ATTR(a_hnp_support);
487static USB_UDC_ATTR(a_alt_hnp_support);
488
489static struct attribute *usb_udc_attrs[] = {
490 &dev_attr_srp.attr,
491 &dev_attr_soft_connect.attr,
d327ab5b
MN
492 &dev_attr_current_speed.attr,
493 &dev_attr_maximum_speed.attr,
2ccea03a 494
2ccea03a
FB
495 &dev_attr_is_otg.attr,
496 &dev_attr_is_a_peripheral.attr,
497 &dev_attr_b_hnp_enable.attr,
498 &dev_attr_a_hnp_support.attr,
499 &dev_attr_a_alt_hnp_support.attr,
500 NULL,
501};
502
503static const struct attribute_group usb_udc_attr_group = {
504 .attrs = usb_udc_attrs,
505};
506
507static const struct attribute_group *usb_udc_attr_groups[] = {
508 &usb_udc_attr_group,
509 NULL,
510};
511
512static int usb_udc_uevent(struct device *dev, struct kobj_uevent_env *env)
513{
514 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
515 int ret;
516
517 ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name);
518 if (ret) {
519 dev_err(dev, "failed to add uevent USB_UDC_NAME\n");
520 return ret;
521 }
522
523 if (udc->driver) {
524 ret = add_uevent_var(env, "USB_UDC_DRIVER=%s",
525 udc->driver->function);
526 if (ret) {
527 dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n");
528 return ret;
529 }
530 }
531
532 return 0;
533}
534
535static int __init usb_udc_init(void)
536{
537 udc_class = class_create(THIS_MODULE, "udc");
538 if (IS_ERR(udc_class)) {
539 pr_err("failed to create udc class --> %ld\n",
540 PTR_ERR(udc_class));
541 return PTR_ERR(udc_class);
542 }
543
544 udc_class->dev_uevent = usb_udc_uevent;
2ccea03a
FB
545 return 0;
546}
547subsys_initcall(usb_udc_init);
548
549static void __exit usb_udc_exit(void)
550{
551 class_destroy(udc_class);
552}
553module_exit(usb_udc_exit);
554
555MODULE_DESCRIPTION("UDC Framework");
556MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
557MODULE_LICENSE("GPL v2");