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