usb: gadget: pxa27x_udc: switch over to module_platform_driver
[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
49401f41
FB
104void 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}
110EXPORT_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 */
128static 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 */
146static 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 */
159static 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 168static 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 */
177int 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");
f07bd56b 187
7bce401c
FB
188 ret = device_register(&gadget->dev);
189 if (ret)
190 goto err2;
f07bd56b 191
2ccea03a
FB
192 device_initialize(&udc->dev);
193 udc->dev.release = usb_udc_release;
194 udc->dev.class = udc_class;
019f976e 195 udc->dev.groups = usb_udc_attr_groups;
2ccea03a
FB
196 udc->dev.parent = parent;
197 ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj));
198 if (ret)
f07bd56b 199 goto err3;
2ccea03a
FB
200
201 udc->gadget = gadget;
202
203 mutex_lock(&udc_lock);
204 list_add_tail(&udc->list, &udc_list);
205
206 ret = device_add(&udc->dev);
207 if (ret)
f07bd56b 208 goto err4;
2ccea03a 209
49401f41
FB
210 usb_gadget_set_state(gadget, USB_STATE_NOTATTACHED);
211
2ccea03a
FB
212 mutex_unlock(&udc_lock);
213
214 return 0;
f07bd56b
FB
215
216err4:
2ccea03a
FB
217 list_del(&udc->list);
218 mutex_unlock(&udc_lock);
219
f07bd56b 220err3:
2ccea03a
FB
221 put_device(&udc->dev);
222
f07bd56b 223err2:
7bce401c
FB
224 put_device(&gadget->dev);
225
2ccea03a
FB
226err1:
227 return ret;
228}
229EXPORT_SYMBOL_GPL(usb_add_gadget_udc);
230
231static void usb_gadget_remove_driver(struct usb_udc *udc)
232{
233 dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n",
234 udc->gadget->name);
235
236 kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
237
2d7ebbb0
FB
238 usb_gadget_disconnect(udc->gadget);
239 udc->driver->disconnect(udc->gadget);
240 udc->driver->unbind(udc->gadget);
241 usb_gadget_udc_stop(udc->gadget, udc->driver);
2ccea03a
FB
242
243 udc->driver = NULL;
244 udc->dev.driver = NULL;
245}
246
247/**
248 * usb_del_gadget_udc - deletes @udc from udc_list
249 * @gadget: the gadget to be removed.
250 *
251 * This, will call usb_gadget_unregister_driver() if
252 * the @udc is still busy.
253 */
254void usb_del_gadget_udc(struct usb_gadget *gadget)
255{
256 struct usb_udc *udc = NULL;
257
258 mutex_lock(&udc_lock);
259 list_for_each_entry(udc, &udc_list, list)
260 if (udc->gadget == gadget)
261 goto found;
262
263 dev_err(gadget->dev.parent, "gadget not registered.\n");
264 mutex_unlock(&udc_lock);
265
266 return;
267
268found:
269 dev_vdbg(gadget->dev.parent, "unregistering gadget\n");
270
271 list_del(&udc->list);
272 mutex_unlock(&udc_lock);
273
274 if (udc->driver)
275 usb_gadget_remove_driver(udc);
276
277 kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE);
278 device_unregister(&udc->dev);
7bce401c 279 device_unregister(&gadget->dev);
2ccea03a
FB
280}
281EXPORT_SYMBOL_GPL(usb_del_gadget_udc);
282
283/* ------------------------------------------------------------------------- */
284
4c49a5f0 285static int udc_bind_to_driver(struct usb_udc *udc, struct usb_gadget_driver *driver)
2ccea03a 286{
4c49a5f0 287 int ret;
2ccea03a 288
2ccea03a
FB
289 dev_dbg(&udc->dev, "registering UDC driver [%s]\n",
290 driver->function);
291
292 udc->driver = driver;
293 udc->dev.driver = &driver->driver;
294
2d7ebbb0
FB
295 ret = driver->bind(udc->gadget, driver);
296 if (ret)
297 goto err1;
298 ret = usb_gadget_udc_start(udc->gadget, driver);
299 if (ret) {
300 driver->unbind(udc->gadget);
301 goto err1;
352c2dc8 302 }
2d7ebbb0 303 usb_gadget_connect(udc->gadget);
2ccea03a
FB
304
305 kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
2ccea03a 306 return 0;
2ccea03a
FB
307err1:
308 dev_err(&udc->dev, "failed to start %s: %d\n",
309 udc->driver->function, ret);
310 udc->driver = NULL;
311 udc->dev.driver = NULL;
4c49a5f0
SAS
312 return ret;
313}
314
315int udc_attach_driver(const char *name, struct usb_gadget_driver *driver)
316{
317 struct usb_udc *udc = NULL;
318 int ret = -ENODEV;
319
320 mutex_lock(&udc_lock);
321 list_for_each_entry(udc, &udc_list, list) {
322 ret = strcmp(name, dev_name(&udc->dev));
323 if (!ret)
324 break;
325 }
326 if (ret) {
327 ret = -ENODEV;
328 goto out;
329 }
330 if (udc->driver) {
331 ret = -EBUSY;
332 goto out;
333 }
334 ret = udc_bind_to_driver(udc, driver);
335out:
336 mutex_unlock(&udc_lock);
337 return ret;
338}
339EXPORT_SYMBOL_GPL(udc_attach_driver);
340
341int usb_gadget_probe_driver(struct usb_gadget_driver *driver)
342{
343 struct usb_udc *udc = NULL;
344 int ret;
345
346 if (!driver || !driver->bind || !driver->setup)
347 return -EINVAL;
348
349 mutex_lock(&udc_lock);
350 list_for_each_entry(udc, &udc_list, list) {
351 /* For now we take the first one */
352 if (!udc->driver)
353 goto found;
354 }
355
356 pr_debug("couldn't find an available UDC\n");
357 mutex_unlock(&udc_lock);
358 return -ENODEV;
359found:
360 ret = udc_bind_to_driver(udc, driver);
2ccea03a
FB
361 mutex_unlock(&udc_lock);
362 return ret;
363}
364EXPORT_SYMBOL_GPL(usb_gadget_probe_driver);
365
366int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
367{
368 struct usb_udc *udc = NULL;
369 int ret = -ENODEV;
370
371 if (!driver || !driver->unbind)
372 return -EINVAL;
373
374 mutex_lock(&udc_lock);
375 list_for_each_entry(udc, &udc_list, list)
376 if (udc->driver == driver) {
377 usb_gadget_remove_driver(udc);
378 ret = 0;
379 break;
380 }
381
382 mutex_unlock(&udc_lock);
383 return ret;
384}
385EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver);
386
387/* ------------------------------------------------------------------------- */
388
389static ssize_t usb_udc_srp_store(struct device *dev,
390 struct device_attribute *attr, const char *buf, size_t n)
391{
1d91a962 392 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a
FB
393
394 if (sysfs_streq(buf, "1"))
395 usb_gadget_wakeup(udc->gadget);
396
397 return n;
398}
399static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store);
400
401static ssize_t usb_udc_softconn_store(struct device *dev,
402 struct device_attribute *attr, const char *buf, size_t n)
403{
865569ba 404 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a
FB
405
406 if (sysfs_streq(buf, "connect")) {
2d7ebbb0 407 usb_gadget_udc_start(udc->gadget, udc->driver);
2ccea03a
FB
408 usb_gadget_connect(udc->gadget);
409 } else if (sysfs_streq(buf, "disconnect")) {
83a787a7 410 usb_gadget_disconnect(udc->gadget);
2d7ebbb0 411 usb_gadget_udc_stop(udc->gadget, udc->driver);
2ccea03a
FB
412 } else {
413 dev_err(dev, "unsupported command '%s'\n", buf);
414 return -EINVAL;
415 }
416
417 return n;
418}
419static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store);
420
49401f41
FB
421static ssize_t usb_gadget_state_show(struct device *dev,
422 struct device_attribute *attr, char *buf)
423{
424 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
425 struct usb_gadget *gadget = udc->gadget;
426
427 return sprintf(buf, "%s\n", usb_state_string(gadget->state));
428}
429static DEVICE_ATTR(state, S_IRUGO, usb_gadget_state_show, NULL);
430
d327ab5b
MN
431#define USB_UDC_SPEED_ATTR(name, param) \
432ssize_t usb_udc_##param##_show(struct device *dev, \
433 struct device_attribute *attr, char *buf) \
434{ \
435 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
436 return snprintf(buf, PAGE_SIZE, "%s\n", \
437 usb_speed_string(udc->gadget->param)); \
438} \
439static DEVICE_ATTR(name, S_IRUSR, usb_udc_##param##_show, NULL)
440
441static USB_UDC_SPEED_ATTR(current_speed, speed);
442static USB_UDC_SPEED_ATTR(maximum_speed, max_speed);
443
2ccea03a
FB
444#define USB_UDC_ATTR(name) \
445ssize_t usb_udc_##name##_show(struct device *dev, \
446 struct device_attribute *attr, char *buf) \
447{ \
019f976e 448 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
2ccea03a
FB
449 struct usb_gadget *gadget = udc->gadget; \
450 \
451 return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \
452} \
59d81f81 453static DEVICE_ATTR(name, S_IRUGO, usb_udc_##name##_show, NULL)
2ccea03a 454
2ccea03a
FB
455static USB_UDC_ATTR(is_otg);
456static USB_UDC_ATTR(is_a_peripheral);
457static USB_UDC_ATTR(b_hnp_enable);
458static USB_UDC_ATTR(a_hnp_support);
459static USB_UDC_ATTR(a_alt_hnp_support);
460
461static struct attribute *usb_udc_attrs[] = {
462 &dev_attr_srp.attr,
463 &dev_attr_soft_connect.attr,
49401f41 464 &dev_attr_state.attr,
d327ab5b
MN
465 &dev_attr_current_speed.attr,
466 &dev_attr_maximum_speed.attr,
2ccea03a 467
2ccea03a
FB
468 &dev_attr_is_otg.attr,
469 &dev_attr_is_a_peripheral.attr,
470 &dev_attr_b_hnp_enable.attr,
471 &dev_attr_a_hnp_support.attr,
472 &dev_attr_a_alt_hnp_support.attr,
473 NULL,
474};
475
476static const struct attribute_group usb_udc_attr_group = {
477 .attrs = usb_udc_attrs,
478};
479
480static const struct attribute_group *usb_udc_attr_groups[] = {
481 &usb_udc_attr_group,
482 NULL,
483};
484
485static int usb_udc_uevent(struct device *dev, struct kobj_uevent_env *env)
486{
487 struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
488 int ret;
489
490 ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name);
491 if (ret) {
492 dev_err(dev, "failed to add uevent USB_UDC_NAME\n");
493 return ret;
494 }
495
496 if (udc->driver) {
497 ret = add_uevent_var(env, "USB_UDC_DRIVER=%s",
498 udc->driver->function);
499 if (ret) {
500 dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n");
501 return ret;
502 }
503 }
504
505 return 0;
506}
507
508static int __init usb_udc_init(void)
509{
510 udc_class = class_create(THIS_MODULE, "udc");
511 if (IS_ERR(udc_class)) {
512 pr_err("failed to create udc class --> %ld\n",
513 PTR_ERR(udc_class));
514 return PTR_ERR(udc_class);
515 }
516
517 udc_class->dev_uevent = usb_udc_uevent;
2ccea03a
FB
518 return 0;
519}
520subsys_initcall(usb_udc_init);
521
522static void __exit usb_udc_exit(void)
523{
524 class_destroy(udc_class);
525}
526module_exit(usb_udc_exit);
527
528MODULE_DESCRIPTION("UDC Framework");
529MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
530MODULE_LICENSE("GPL v2");