2 * udc.c - Core UDC Framework
4 * Copyright (C) 2010 Texas Instruments
5 * Author: Felipe Balbi <balbi@ti.com>
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.
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.
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/>.
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>
25 #include <linux/dma-mapping.h>
27 #include <linux/usb/ch9.h>
28 #include <linux/usb/gadget.h>
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
37 * This represents the internal data structure which is used by the UDC-class
38 * to hold information about udc driver and gadget together.
41 struct usb_gadget_driver
*driver
;
42 struct usb_gadget
*gadget
;
44 struct list_head list
;
47 static struct class *udc_class
;
48 static LIST_HEAD(udc_list
);
49 static DEFINE_MUTEX(udc_lock
);
51 /* ------------------------------------------------------------------------- */
53 int usb_gadget_map_request(struct usb_gadget
*gadget
,
54 struct usb_request
*req
, int is_in
)
62 mapped
= dma_map_sg(&gadget
->dev
, req
->sg
, req
->num_sgs
,
63 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
65 dev_err(&gadget
->dev
, "failed to map SGs\n");
69 req
->num_mapped_sgs
= mapped
;
71 req
->dma
= dma_map_single(&gadget
->dev
, req
->buf
, req
->length
,
72 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
74 if (dma_mapping_error(&gadget
->dev
, req
->dma
)) {
75 dev_err(&gadget
->dev
, "failed to map buffer\n");
82 EXPORT_SYMBOL_GPL(usb_gadget_map_request
);
84 void usb_gadget_unmap_request(struct usb_gadget
*gadget
,
85 struct usb_request
*req
, int is_in
)
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
);
94 req
->num_mapped_sgs
= 0;
96 dma_unmap_single(&gadget
->dev
, req
->dma
, req
->length
,
97 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
100 EXPORT_SYMBOL_GPL(usb_gadget_unmap_request
);
102 /* ------------------------------------------------------------------------- */
104 void usb_gadget_set_state(struct usb_gadget
*gadget
,
105 enum usb_device_state state
)
107 gadget
->state
= state
;
108 sysfs_notify(&gadget
->dev
.kobj
, NULL
, "status");
110 EXPORT_SYMBOL_GPL(usb_gadget_set_state
);
112 /* ------------------------------------------------------------------------- */
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
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.
123 * It allows the controller to be powered off until strictly
124 * necessary to have it powered on.
126 * Returns zero on success, else negative errno.
128 static inline int usb_gadget_udc_start(struct usb_gadget
*gadget
,
129 struct usb_gadget_driver
*driver
)
131 return gadget
->ops
->udc_start(gadget
, driver
);
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
139 * This call is issued by the UDC Class driver after calling
140 * gadget driver's unbind() method.
142 * The details are implementation specific, but it can go as
143 * far as powering off UDC completely and disable its data
146 static inline void usb_gadget_udc_stop(struct usb_gadget
*gadget
,
147 struct usb_gadget_driver
*driver
)
149 gadget
->ops
->udc_stop(gadget
, driver
);
153 * usb_udc_release - release the usb_udc struct
154 * @dev: the dev member within usb_udc
156 * This is called by driver's core in order to free memory once the last
157 * reference is released.
159 static void usb_udc_release(struct device
*dev
)
163 udc
= container_of(dev
, struct usb_udc
, dev
);
164 dev_dbg(dev
, "releasing '%s'\n", dev_name(dev
));
168 static const struct attribute_group
*usb_udc_attr_groups
[];
170 static void usb_udc_nop_release(struct device
*dev
)
172 dev_vdbg(dev
, "%s\n", __func__
);
176 * usb_add_gadget_udc_release - adds a new gadget to the udc class driver list
177 * @parent: the parent device to this udc. Usually the controller driver's
179 * @gadget: the gadget to be added to the list.
180 * @release: a gadget release function.
182 * Returns zero on success, negative errno otherwise.
184 int usb_add_gadget_udc_release(struct device
*parent
, struct usb_gadget
*gadget
,
185 void (*release
)(struct device
*dev
))
190 udc
= kzalloc(sizeof(*udc
), GFP_KERNEL
);
194 dev_set_name(&gadget
->dev
, "gadget");
195 gadget
->dev
.parent
= parent
;
197 dma_set_coherent_mask(&gadget
->dev
, parent
->coherent_dma_mask
);
198 gadget
->dev
.dma_parms
= parent
->dma_parms
;
199 gadget
->dev
.dma_mask
= parent
->dma_mask
;
202 gadget
->dev
.release
= release
;
204 gadget
->dev
.release
= usb_udc_nop_release
;
206 ret
= device_register(&gadget
->dev
);
210 device_initialize(&udc
->dev
);
211 udc
->dev
.release
= usb_udc_release
;
212 udc
->dev
.class = udc_class
;
213 udc
->dev
.groups
= usb_udc_attr_groups
;
214 udc
->dev
.parent
= parent
;
215 ret
= dev_set_name(&udc
->dev
, "%s", kobject_name(&parent
->kobj
));
219 udc
->gadget
= gadget
;
221 mutex_lock(&udc_lock
);
222 list_add_tail(&udc
->list
, &udc_list
);
224 ret
= device_add(&udc
->dev
);
228 usb_gadget_set_state(gadget
, USB_STATE_NOTATTACHED
);
230 mutex_unlock(&udc_lock
);
235 list_del(&udc
->list
);
236 mutex_unlock(&udc_lock
);
239 put_device(&udc
->dev
);
242 put_device(&gadget
->dev
);
248 EXPORT_SYMBOL_GPL(usb_add_gadget_udc_release
);
251 * usb_add_gadget_udc - adds a new gadget to the udc class driver list
252 * @parent: the parent device to this udc. Usually the controller
254 * @gadget: the gadget to be added to the list
256 * Returns zero on success, negative errno otherwise.
258 int usb_add_gadget_udc(struct device
*parent
, struct usb_gadget
*gadget
)
260 return usb_add_gadget_udc_release(parent
, gadget
, NULL
);
262 EXPORT_SYMBOL_GPL(usb_add_gadget_udc
);
264 static void usb_gadget_remove_driver(struct usb_udc
*udc
)
266 dev_dbg(&udc
->dev
, "unregistering UDC driver [%s]\n",
269 kobject_uevent(&udc
->dev
.kobj
, KOBJ_CHANGE
);
271 usb_gadget_disconnect(udc
->gadget
);
272 udc
->driver
->disconnect(udc
->gadget
);
273 udc
->driver
->unbind(udc
->gadget
);
274 usb_gadget_udc_stop(udc
->gadget
, NULL
);
277 udc
->dev
.driver
= NULL
;
278 udc
->gadget
->dev
.driver
= NULL
;
282 * usb_del_gadget_udc - deletes @udc from udc_list
283 * @gadget: the gadget to be removed.
285 * This, will call usb_gadget_unregister_driver() if
286 * the @udc is still busy.
288 void usb_del_gadget_udc(struct usb_gadget
*gadget
)
290 struct usb_udc
*udc
= NULL
;
292 mutex_lock(&udc_lock
);
293 list_for_each_entry(udc
, &udc_list
, list
)
294 if (udc
->gadget
== gadget
)
297 dev_err(gadget
->dev
.parent
, "gadget not registered.\n");
298 mutex_unlock(&udc_lock
);
303 dev_vdbg(gadget
->dev
.parent
, "unregistering gadget\n");
305 list_del(&udc
->list
);
306 mutex_unlock(&udc_lock
);
309 usb_gadget_remove_driver(udc
);
311 kobject_uevent(&udc
->dev
.kobj
, KOBJ_REMOVE
);
312 device_unregister(&udc
->dev
);
313 device_unregister(&gadget
->dev
);
315 EXPORT_SYMBOL_GPL(usb_del_gadget_udc
);
317 /* ------------------------------------------------------------------------- */
319 static int udc_bind_to_driver(struct usb_udc
*udc
, struct usb_gadget_driver
*driver
)
323 dev_dbg(&udc
->dev
, "registering UDC driver [%s]\n",
326 udc
->driver
= driver
;
327 udc
->dev
.driver
= &driver
->driver
;
328 udc
->gadget
->dev
.driver
= &driver
->driver
;
330 ret
= driver
->bind(udc
->gadget
, driver
);
333 ret
= usb_gadget_udc_start(udc
->gadget
, driver
);
335 driver
->unbind(udc
->gadget
);
338 usb_gadget_connect(udc
->gadget
);
340 kobject_uevent(&udc
->dev
.kobj
, KOBJ_CHANGE
);
343 dev_err(&udc
->dev
, "failed to start %s: %d\n",
344 udc
->driver
->function
, ret
);
346 udc
->dev
.driver
= NULL
;
347 udc
->gadget
->dev
.driver
= NULL
;
351 int udc_attach_driver(const char *name
, struct usb_gadget_driver
*driver
)
353 struct usb_udc
*udc
= NULL
;
356 mutex_lock(&udc_lock
);
357 list_for_each_entry(udc
, &udc_list
, list
) {
358 ret
= strcmp(name
, dev_name(&udc
->dev
));
370 ret
= udc_bind_to_driver(udc
, driver
);
372 mutex_unlock(&udc_lock
);
375 EXPORT_SYMBOL_GPL(udc_attach_driver
);
377 int usb_gadget_probe_driver(struct usb_gadget_driver
*driver
)
379 struct usb_udc
*udc
= NULL
;
382 if (!driver
|| !driver
->bind
|| !driver
->setup
)
385 mutex_lock(&udc_lock
);
386 list_for_each_entry(udc
, &udc_list
, list
) {
387 /* For now we take the first one */
392 pr_debug("couldn't find an available UDC\n");
393 mutex_unlock(&udc_lock
);
396 ret
= udc_bind_to_driver(udc
, driver
);
397 mutex_unlock(&udc_lock
);
400 EXPORT_SYMBOL_GPL(usb_gadget_probe_driver
);
402 int usb_gadget_unregister_driver(struct usb_gadget_driver
*driver
)
404 struct usb_udc
*udc
= NULL
;
407 if (!driver
|| !driver
->unbind
)
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
);
418 mutex_unlock(&udc_lock
);
421 EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver
);
423 /* ------------------------------------------------------------------------- */
425 static ssize_t
usb_udc_srp_store(struct device
*dev
,
426 struct device_attribute
*attr
, const char *buf
, size_t n
)
428 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
430 if (sysfs_streq(buf
, "1"))
431 usb_gadget_wakeup(udc
->gadget
);
435 static DEVICE_ATTR(srp
, S_IWUSR
, NULL
, usb_udc_srp_store
);
437 static ssize_t
usb_udc_softconn_store(struct device
*dev
,
438 struct device_attribute
*attr
, const char *buf
, size_t n
)
440 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
442 if (sysfs_streq(buf
, "connect")) {
443 usb_gadget_udc_start(udc
->gadget
, udc
->driver
);
444 usb_gadget_connect(udc
->gadget
);
445 } else if (sysfs_streq(buf
, "disconnect")) {
446 usb_gadget_disconnect(udc
->gadget
);
447 usb_gadget_udc_stop(udc
->gadget
, udc
->driver
);
449 dev_err(dev
, "unsupported command '%s'\n", buf
);
455 static DEVICE_ATTR(soft_connect
, S_IWUSR
, NULL
, usb_udc_softconn_store
);
457 static ssize_t
usb_gadget_state_show(struct device
*dev
,
458 struct device_attribute
*attr
, char *buf
)
460 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
461 struct usb_gadget
*gadget
= udc
->gadget
;
463 return sprintf(buf
, "%s\n", usb_state_string(gadget
->state
));
465 static DEVICE_ATTR(state
, S_IRUGO
, usb_gadget_state_show
, NULL
);
467 #define USB_UDC_SPEED_ATTR(name, param) \
468 ssize_t usb_udc_##param##_show(struct device *dev, \
469 struct device_attribute *attr, char *buf) \
471 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
472 return snprintf(buf, PAGE_SIZE, "%s\n", \
473 usb_speed_string(udc->gadget->param)); \
475 static DEVICE_ATTR(name, S_IRUGO, usb_udc_##param##_show, NULL)
477 static USB_UDC_SPEED_ATTR(current_speed
, speed
);
478 static USB_UDC_SPEED_ATTR(maximum_speed
, max_speed
);
480 #define USB_UDC_ATTR(name) \
481 ssize_t usb_udc_##name##_show(struct device *dev, \
482 struct device_attribute *attr, char *buf) \
484 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
485 struct usb_gadget *gadget = udc->gadget; \
487 return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \
489 static DEVICE_ATTR(name, S_IRUGO, usb_udc_##name##_show, NULL)
491 static USB_UDC_ATTR(is_otg
);
492 static USB_UDC_ATTR(is_a_peripheral
);
493 static USB_UDC_ATTR(b_hnp_enable
);
494 static USB_UDC_ATTR(a_hnp_support
);
495 static USB_UDC_ATTR(a_alt_hnp_support
);
497 static struct attribute
*usb_udc_attrs
[] = {
499 &dev_attr_soft_connect
.attr
,
500 &dev_attr_state
.attr
,
501 &dev_attr_current_speed
.attr
,
502 &dev_attr_maximum_speed
.attr
,
504 &dev_attr_is_otg
.attr
,
505 &dev_attr_is_a_peripheral
.attr
,
506 &dev_attr_b_hnp_enable
.attr
,
507 &dev_attr_a_hnp_support
.attr
,
508 &dev_attr_a_alt_hnp_support
.attr
,
512 static const struct attribute_group usb_udc_attr_group
= {
513 .attrs
= usb_udc_attrs
,
516 static const struct attribute_group
*usb_udc_attr_groups
[] = {
521 static int usb_udc_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
523 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
526 ret
= add_uevent_var(env
, "USB_UDC_NAME=%s", udc
->gadget
->name
);
528 dev_err(dev
, "failed to add uevent USB_UDC_NAME\n");
533 ret
= add_uevent_var(env
, "USB_UDC_DRIVER=%s",
534 udc
->driver
->function
);
536 dev_err(dev
, "failed to add uevent USB_UDC_DRIVER\n");
544 static int __init
usb_udc_init(void)
546 udc_class
= class_create(THIS_MODULE
, "udc");
547 if (IS_ERR(udc_class
)) {
548 pr_err("failed to create udc class --> %ld\n",
550 return PTR_ERR(udc_class
);
553 udc_class
->dev_uevent
= usb_udc_uevent
;
556 subsys_initcall(usb_udc_init
);
558 static void __exit
usb_udc_exit(void)
560 class_destroy(udc_class
);
562 module_exit(usb_udc_exit
);
564 MODULE_DESCRIPTION("UDC Framework");
565 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
566 MODULE_LICENSE("GPL v2");