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>
26 #include <linux/workqueue.h>
28 #include <linux/usb/ch9.h>
29 #include <linux/usb/gadget.h>
30 #include <linux/usb.h>
33 * struct usb_udc - describes one usb device controller
34 * @driver - the gadget driver pointer. For use by the class code
35 * @dev - the child device to the actual controller
36 * @gadget - the gadget. For use by the class code
37 * @list - for use by the udc class driver
38 * @vbus - for udcs who care about vbus status, this value is real vbus status;
39 * for udcs who do not care about vbus status, this value is always true
41 * This represents the internal data structure which is used by the UDC-class
42 * to hold information about udc driver and gadget together.
45 struct usb_gadget_driver
*driver
;
46 struct usb_gadget
*gadget
;
48 struct list_head list
;
52 static struct class *udc_class
;
53 static LIST_HEAD(udc_list
);
54 static DEFINE_MUTEX(udc_lock
);
56 /* ------------------------------------------------------------------------- */
60 int usb_gadget_map_request(struct usb_gadget
*gadget
,
61 struct usb_request
*req
, int is_in
)
63 struct device
*dev
= gadget
->dev
.parent
;
71 mapped
= dma_map_sg(dev
, req
->sg
, req
->num_sgs
,
72 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
74 dev_err(&gadget
->dev
, "failed to map SGs\n");
78 req
->num_mapped_sgs
= mapped
;
80 req
->dma
= dma_map_single(dev
, req
->buf
, req
->length
,
81 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
83 if (dma_mapping_error(dev
, req
->dma
)) {
84 dev_err(dev
, "failed to map buffer\n");
91 EXPORT_SYMBOL_GPL(usb_gadget_map_request
);
93 void usb_gadget_unmap_request(struct usb_gadget
*gadget
,
94 struct usb_request
*req
, int is_in
)
99 if (req
->num_mapped_sgs
) {
100 dma_unmap_sg(gadget
->dev
.parent
, req
->sg
, req
->num_mapped_sgs
,
101 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
103 req
->num_mapped_sgs
= 0;
105 dma_unmap_single(gadget
->dev
.parent
, req
->dma
, req
->length
,
106 is_in
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
109 EXPORT_SYMBOL_GPL(usb_gadget_unmap_request
);
111 #endif /* CONFIG_HAS_DMA */
113 /* ------------------------------------------------------------------------- */
116 * usb_gadget_giveback_request - give the request back to the gadget layer
117 * Context: in_interrupt()
119 * This is called by device controller drivers in order to return the
120 * completed request back to the gadget layer.
122 void usb_gadget_giveback_request(struct usb_ep
*ep
,
123 struct usb_request
*req
)
125 if (likely(req
->status
== 0))
126 usb_led_activity(USB_LED_EVENT_GADGET
);
128 req
->complete(ep
, req
);
130 EXPORT_SYMBOL_GPL(usb_gadget_giveback_request
);
132 /* ------------------------------------------------------------------------- */
134 int usb_gadget_ep_match_desc(struct usb_gadget
*gadget
,
135 struct usb_ep
*ep
, struct usb_endpoint_descriptor
*desc
,
136 struct usb_ss_ep_comp_descriptor
*ep_comp
)
140 int num_req_streams
= 0;
142 /* endpoint already claimed? */
146 type
= usb_endpoint_type(desc
);
147 max
= 0x7ff & usb_endpoint_maxp(desc
);
149 if (usb_endpoint_dir_in(desc
) && !ep
->caps
.dir_in
)
151 if (usb_endpoint_dir_out(desc
) && !ep
->caps
.dir_out
)
154 if (max
> ep
->maxpacket_limit
)
157 /* "high bandwidth" works only at high speed */
158 if (!gadget_is_dualspeed(gadget
) && usb_endpoint_maxp(desc
) & (3<<11))
162 case USB_ENDPOINT_XFER_CONTROL
:
163 /* only support ep0 for portable CONTROL traffic */
165 case USB_ENDPOINT_XFER_ISOC
:
166 if (!ep
->caps
.type_iso
)
168 /* ISO: limit 1023 bytes full speed, 1024 high/super speed */
169 if (!gadget_is_dualspeed(gadget
) && max
> 1023)
172 case USB_ENDPOINT_XFER_BULK
:
173 if (!ep
->caps
.type_bulk
)
175 if (ep_comp
&& gadget_is_superspeed(gadget
)) {
176 /* Get the number of required streams from the
177 * EP companion descriptor and see if the EP
180 num_req_streams
= ep_comp
->bmAttributes
& 0x1f;
181 if (num_req_streams
> ep
->max_streams
)
185 case USB_ENDPOINT_XFER_INT
:
186 /* Bulk endpoints handle interrupt transfers,
187 * except the toggle-quirky iso-synch kind
189 if (!ep
->caps
.type_int
&& !ep
->caps
.type_bulk
)
191 /* INT: limit 64 bytes full speed, 1024 high/super speed */
192 if (!gadget_is_dualspeed(gadget
) && max
> 64)
199 EXPORT_SYMBOL_GPL(usb_gadget_ep_match_desc
);
201 /* ------------------------------------------------------------------------- */
203 static void usb_gadget_state_work(struct work_struct
*work
)
205 struct usb_gadget
*gadget
= work_to_gadget(work
);
206 struct usb_udc
*udc
= gadget
->udc
;
209 sysfs_notify(&udc
->dev
.kobj
, NULL
, "state");
212 void usb_gadget_set_state(struct usb_gadget
*gadget
,
213 enum usb_device_state state
)
215 gadget
->state
= state
;
216 schedule_work(&gadget
->work
);
218 EXPORT_SYMBOL_GPL(usb_gadget_set_state
);
220 /* ------------------------------------------------------------------------- */
222 static void usb_udc_connect_control(struct usb_udc
*udc
)
225 usb_gadget_connect(udc
->gadget
);
227 usb_gadget_disconnect(udc
->gadget
);
231 * usb_udc_vbus_handler - updates the udc core vbus status, and try to
232 * connect or disconnect gadget
233 * @gadget: The gadget which vbus change occurs
234 * @status: The vbus status
236 * The udc driver calls it when it wants to connect or disconnect gadget
237 * according to vbus status.
239 void usb_udc_vbus_handler(struct usb_gadget
*gadget
, bool status
)
241 struct usb_udc
*udc
= gadget
->udc
;
245 usb_udc_connect_control(udc
);
248 EXPORT_SYMBOL_GPL(usb_udc_vbus_handler
);
251 * usb_gadget_udc_reset - notifies the udc core that bus reset occurs
252 * @gadget: The gadget which bus reset occurs
253 * @driver: The gadget driver we want to notify
255 * If the udc driver has bus reset handler, it needs to call this when the bus
256 * reset occurs, it notifies the gadget driver that the bus reset occurs as
257 * well as updates gadget state.
259 void usb_gadget_udc_reset(struct usb_gadget
*gadget
,
260 struct usb_gadget_driver
*driver
)
262 driver
->reset(gadget
);
263 usb_gadget_set_state(gadget
, USB_STATE_DEFAULT
);
265 EXPORT_SYMBOL_GPL(usb_gadget_udc_reset
);
268 * usb_gadget_udc_start - tells usb device controller to start up
269 * @udc: The UDC to be started
271 * This call is issued by the UDC Class driver when it's about
272 * to register a gadget driver to the device controller, before
273 * calling gadget driver's bind() method.
275 * It allows the controller to be powered off until strictly
276 * necessary to have it powered on.
278 * Returns zero on success, else negative errno.
280 static inline int usb_gadget_udc_start(struct usb_udc
*udc
)
282 return udc
->gadget
->ops
->udc_start(udc
->gadget
, udc
->driver
);
286 * usb_gadget_udc_stop - tells usb device controller we don't need it anymore
287 * @gadget: The device we want to stop activity
288 * @driver: The driver to unbind from @gadget
290 * This call is issued by the UDC Class driver after calling
291 * gadget driver's unbind() method.
293 * The details are implementation specific, but it can go as
294 * far as powering off UDC completely and disable its data
297 static inline void usb_gadget_udc_stop(struct usb_udc
*udc
)
299 udc
->gadget
->ops
->udc_stop(udc
->gadget
);
303 * usb_udc_release - release the usb_udc struct
304 * @dev: the dev member within usb_udc
306 * This is called by driver's core in order to free memory once the last
307 * reference is released.
309 static void usb_udc_release(struct device
*dev
)
313 udc
= container_of(dev
, struct usb_udc
, dev
);
314 dev_dbg(dev
, "releasing '%s'\n", dev_name(dev
));
318 static const struct attribute_group
*usb_udc_attr_groups
[];
320 static void usb_udc_nop_release(struct device
*dev
)
322 dev_vdbg(dev
, "%s\n", __func__
);
326 * usb_add_gadget_udc_release - adds a new gadget to the udc class driver list
327 * @parent: the parent device to this udc. Usually the controller driver's
329 * @gadget: the gadget to be added to the list.
330 * @release: a gadget release function.
332 * Returns zero on success, negative errno otherwise.
334 int usb_add_gadget_udc_release(struct device
*parent
, struct usb_gadget
*gadget
,
335 void (*release
)(struct device
*dev
))
340 udc
= kzalloc(sizeof(*udc
), GFP_KERNEL
);
344 dev_set_name(&gadget
->dev
, "gadget");
345 INIT_WORK(&gadget
->work
, usb_gadget_state_work
);
346 gadget
->dev
.parent
= parent
;
348 #ifdef CONFIG_HAS_DMA
349 dma_set_coherent_mask(&gadget
->dev
, parent
->coherent_dma_mask
);
350 gadget
->dev
.dma_parms
= parent
->dma_parms
;
351 gadget
->dev
.dma_mask
= parent
->dma_mask
;
355 gadget
->dev
.release
= release
;
357 gadget
->dev
.release
= usb_udc_nop_release
;
359 ret
= device_register(&gadget
->dev
);
363 device_initialize(&udc
->dev
);
364 udc
->dev
.release
= usb_udc_release
;
365 udc
->dev
.class = udc_class
;
366 udc
->dev
.groups
= usb_udc_attr_groups
;
367 udc
->dev
.parent
= parent
;
368 ret
= dev_set_name(&udc
->dev
, "%s", kobject_name(&parent
->kobj
));
372 udc
->gadget
= gadget
;
375 mutex_lock(&udc_lock
);
376 list_add_tail(&udc
->list
, &udc_list
);
378 ret
= device_add(&udc
->dev
);
382 usb_gadget_set_state(gadget
, USB_STATE_NOTATTACHED
);
385 mutex_unlock(&udc_lock
);
390 list_del(&udc
->list
);
391 mutex_unlock(&udc_lock
);
394 put_device(&udc
->dev
);
397 put_device(&gadget
->dev
);
403 EXPORT_SYMBOL_GPL(usb_add_gadget_udc_release
);
406 * usb_add_gadget_udc - adds a new gadget to the udc class driver list
407 * @parent: the parent device to this udc. Usually the controller
409 * @gadget: the gadget to be added to the list
411 * Returns zero on success, negative errno otherwise.
413 int usb_add_gadget_udc(struct device
*parent
, struct usb_gadget
*gadget
)
415 return usb_add_gadget_udc_release(parent
, gadget
, NULL
);
417 EXPORT_SYMBOL_GPL(usb_add_gadget_udc
);
419 static void usb_gadget_remove_driver(struct usb_udc
*udc
)
421 dev_dbg(&udc
->dev
, "unregistering UDC driver [%s]\n",
422 udc
->driver
->function
);
424 kobject_uevent(&udc
->dev
.kobj
, KOBJ_CHANGE
);
426 usb_gadget_disconnect(udc
->gadget
);
427 udc
->driver
->disconnect(udc
->gadget
);
428 udc
->driver
->unbind(udc
->gadget
);
429 usb_gadget_udc_stop(udc
);
432 udc
->dev
.driver
= NULL
;
433 udc
->gadget
->dev
.driver
= NULL
;
437 * usb_del_gadget_udc - deletes @udc from udc_list
438 * @gadget: the gadget to be removed.
440 * This, will call usb_gadget_unregister_driver() if
441 * the @udc is still busy.
443 void usb_del_gadget_udc(struct usb_gadget
*gadget
)
445 struct usb_udc
*udc
= gadget
->udc
;
450 dev_vdbg(gadget
->dev
.parent
, "unregistering gadget\n");
452 mutex_lock(&udc_lock
);
453 list_del(&udc
->list
);
454 mutex_unlock(&udc_lock
);
457 usb_gadget_remove_driver(udc
);
459 kobject_uevent(&udc
->dev
.kobj
, KOBJ_REMOVE
);
460 flush_work(&gadget
->work
);
461 device_unregister(&udc
->dev
);
462 device_unregister(&gadget
->dev
);
464 EXPORT_SYMBOL_GPL(usb_del_gadget_udc
);
466 /* ------------------------------------------------------------------------- */
468 static int udc_bind_to_driver(struct usb_udc
*udc
, struct usb_gadget_driver
*driver
)
472 dev_dbg(&udc
->dev
, "registering UDC driver [%s]\n",
475 udc
->driver
= driver
;
476 udc
->dev
.driver
= &driver
->driver
;
477 udc
->gadget
->dev
.driver
= &driver
->driver
;
479 ret
= driver
->bind(udc
->gadget
, driver
);
482 ret
= usb_gadget_udc_start(udc
);
484 driver
->unbind(udc
->gadget
);
487 usb_udc_connect_control(udc
);
489 kobject_uevent(&udc
->dev
.kobj
, KOBJ_CHANGE
);
493 dev_err(&udc
->dev
, "failed to start %s: %d\n",
494 udc
->driver
->function
, ret
);
496 udc
->dev
.driver
= NULL
;
497 udc
->gadget
->dev
.driver
= NULL
;
501 int usb_udc_attach_driver(const char *name
, struct usb_gadget_driver
*driver
)
503 struct usb_udc
*udc
= NULL
;
506 mutex_lock(&udc_lock
);
507 list_for_each_entry(udc
, &udc_list
, list
) {
508 ret
= strcmp(name
, dev_name(&udc
->dev
));
520 ret
= udc_bind_to_driver(udc
, driver
);
522 mutex_unlock(&udc_lock
);
525 EXPORT_SYMBOL_GPL(usb_udc_attach_driver
);
527 int usb_gadget_probe_driver(struct usb_gadget_driver
*driver
)
529 struct usb_udc
*udc
= NULL
;
532 if (!driver
|| !driver
->bind
|| !driver
->setup
)
535 mutex_lock(&udc_lock
);
536 list_for_each_entry(udc
, &udc_list
, list
) {
537 /* For now we take the first one */
542 pr_debug("couldn't find an available UDC\n");
543 mutex_unlock(&udc_lock
);
546 ret
= udc_bind_to_driver(udc
, driver
);
547 mutex_unlock(&udc_lock
);
550 EXPORT_SYMBOL_GPL(usb_gadget_probe_driver
);
552 int usb_gadget_unregister_driver(struct usb_gadget_driver
*driver
)
554 struct usb_udc
*udc
= NULL
;
557 if (!driver
|| !driver
->unbind
)
560 mutex_lock(&udc_lock
);
561 list_for_each_entry(udc
, &udc_list
, list
)
562 if (udc
->driver
== driver
) {
563 usb_gadget_remove_driver(udc
);
564 usb_gadget_set_state(udc
->gadget
,
565 USB_STATE_NOTATTACHED
);
570 mutex_unlock(&udc_lock
);
573 EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver
);
575 /* ------------------------------------------------------------------------- */
577 static ssize_t
usb_udc_srp_store(struct device
*dev
,
578 struct device_attribute
*attr
, const char *buf
, size_t n
)
580 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
582 if (sysfs_streq(buf
, "1"))
583 usb_gadget_wakeup(udc
->gadget
);
587 static DEVICE_ATTR(srp
, S_IWUSR
, NULL
, usb_udc_srp_store
);
589 static ssize_t
usb_udc_softconn_store(struct device
*dev
,
590 struct device_attribute
*attr
, const char *buf
, size_t n
)
592 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
595 dev_err(dev
, "soft-connect without a gadget driver\n");
599 if (sysfs_streq(buf
, "connect")) {
600 usb_gadget_udc_start(udc
);
601 usb_gadget_connect(udc
->gadget
);
602 } else if (sysfs_streq(buf
, "disconnect")) {
603 usb_gadget_disconnect(udc
->gadget
);
604 udc
->driver
->disconnect(udc
->gadget
);
605 usb_gadget_udc_stop(udc
);
607 dev_err(dev
, "unsupported command '%s'\n", buf
);
613 static DEVICE_ATTR(soft_connect
, S_IWUSR
, NULL
, usb_udc_softconn_store
);
615 static ssize_t
state_show(struct device
*dev
, struct device_attribute
*attr
,
618 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
619 struct usb_gadget
*gadget
= udc
->gadget
;
621 return sprintf(buf
, "%s\n", usb_state_string(gadget
->state
));
623 static DEVICE_ATTR_RO(state
);
625 #define USB_UDC_SPEED_ATTR(name, param) \
626 ssize_t name##_show(struct device *dev, \
627 struct device_attribute *attr, char *buf) \
629 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
630 return snprintf(buf, PAGE_SIZE, "%s\n", \
631 usb_speed_string(udc->gadget->param)); \
633 static DEVICE_ATTR_RO(name)
635 static USB_UDC_SPEED_ATTR(current_speed
, speed
);
636 static USB_UDC_SPEED_ATTR(maximum_speed
, max_speed
);
638 #define USB_UDC_ATTR(name) \
639 ssize_t name##_show(struct device *dev, \
640 struct device_attribute *attr, char *buf) \
642 struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
643 struct usb_gadget *gadget = udc->gadget; \
645 return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \
647 static DEVICE_ATTR_RO(name)
649 static USB_UDC_ATTR(is_otg
);
650 static USB_UDC_ATTR(is_a_peripheral
);
651 static USB_UDC_ATTR(b_hnp_enable
);
652 static USB_UDC_ATTR(a_hnp_support
);
653 static USB_UDC_ATTR(a_alt_hnp_support
);
654 static USB_UDC_ATTR(is_selfpowered
);
656 static struct attribute
*usb_udc_attrs
[] = {
658 &dev_attr_soft_connect
.attr
,
659 &dev_attr_state
.attr
,
660 &dev_attr_current_speed
.attr
,
661 &dev_attr_maximum_speed
.attr
,
663 &dev_attr_is_otg
.attr
,
664 &dev_attr_is_a_peripheral
.attr
,
665 &dev_attr_b_hnp_enable
.attr
,
666 &dev_attr_a_hnp_support
.attr
,
667 &dev_attr_a_alt_hnp_support
.attr
,
668 &dev_attr_is_selfpowered
.attr
,
672 static const struct attribute_group usb_udc_attr_group
= {
673 .attrs
= usb_udc_attrs
,
676 static const struct attribute_group
*usb_udc_attr_groups
[] = {
681 static int usb_udc_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
683 struct usb_udc
*udc
= container_of(dev
, struct usb_udc
, dev
);
686 ret
= add_uevent_var(env
, "USB_UDC_NAME=%s", udc
->gadget
->name
);
688 dev_err(dev
, "failed to add uevent USB_UDC_NAME\n");
693 ret
= add_uevent_var(env
, "USB_UDC_DRIVER=%s",
694 udc
->driver
->function
);
696 dev_err(dev
, "failed to add uevent USB_UDC_DRIVER\n");
704 static int __init
usb_udc_init(void)
706 udc_class
= class_create(THIS_MODULE
, "udc");
707 if (IS_ERR(udc_class
)) {
708 pr_err("failed to create udc class --> %ld\n",
710 return PTR_ERR(udc_class
);
713 udc_class
->dev_uevent
= usb_udc_uevent
;
716 subsys_initcall(usb_udc_init
);
718 static void __exit
usb_udc_exit(void)
720 class_destroy(udc_class
);
722 module_exit(usb_udc_exit
);
724 MODULE_DESCRIPTION("UDC Framework");
725 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
726 MODULE_LICENSE("GPL v2");