[linux-2.6-block.git] / drivers / usb / gadget / udc-core.c

/**
 * udc.c - Core UDC Framework
 *
 * Copyright (C) 2010 Texas Instruments
 * Author: Felipe Balbi <balbi@ti.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2  of
 * the License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/list.h>
#include <linux/err.h>
#include <linux/dma-mapping.h>
#include <linux/workqueue.h>

#include <linux/usb/ch9.h>
#include <linux/usb/gadget.h>

/**
 * struct usb_udc - describes one usb device controller
 * @driver - the gadget driver pointer. For use by the class code
 * @dev - the child device to the actual controller
 * @gadget - the gadget. For use by the class code
 * @list - for use by the udc class driver
 *
 * This represents the internal data structure which is used by the UDC-class
 * to hold information about udc driver and gadget together.
 */
struct usb_udc {
	struct usb_gadget_driver	*driver;
	struct usb_gadget		*gadget;
	struct device			dev;
	struct list_head		list;
};

static struct class *udc_class;
static LIST_HEAD(udc_list);
static DEFINE_MUTEX(udc_lock);

/* ------------------------------------------------------------------------- */

#ifdef	CONFIG_HAS_DMA

int usb_gadget_map_request(struct usb_gadget *gadget,
		struct usb_request *req, int is_in)
{
	if (req->length == 0)
		return 0;

	if (req->num_sgs) {
		int     mapped;

		mapped = dma_map_sg(&gadget->dev, req->sg, req->num_sgs,
				is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
		if (mapped == 0) {
			dev_err(&gadget->dev, "failed to map SGs\n");
			return -EFAULT;
		}

		req->num_mapped_sgs = mapped;
	} else {
		req->dma = dma_map_single(&gadget->dev, req->buf, req->length,
				is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);

		if (dma_mapping_error(&gadget->dev, req->dma)) {
			dev_err(&gadget->dev, "failed to map buffer\n");
			return -EFAULT;
		}
	}

	return 0;
}
EXPORT_SYMBOL_GPL(usb_gadget_map_request);

void usb_gadget_unmap_request(struct usb_gadget *gadget,
		struct usb_request *req, int is_in)
{
	if (req->length == 0)
		return;

	if (req->num_mapped_sgs) {
		dma_unmap_sg(&gadget->dev, req->sg, req->num_mapped_sgs,
				is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);

		req->num_mapped_sgs = 0;
	} else {
		dma_unmap_single(&gadget->dev, req->dma, req->length,
				is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
	}
}
EXPORT_SYMBOL_GPL(usb_gadget_unmap_request);

#endif	/* CONFIG_HAS_DMA */

/* ------------------------------------------------------------------------- */

static void usb_gadget_state_work(struct work_struct *work)
{
	struct usb_gadget	*gadget = work_to_gadget(work);

	sysfs_notify(&gadget->dev.kobj, NULL, "state");
}

void usb_gadget_set_state(struct usb_gadget *gadget,
		enum usb_device_state state)
{
	gadget->state = state;
	schedule_work(&gadget->work);
}
EXPORT_SYMBOL_GPL(usb_gadget_set_state);

/* ------------------------------------------------------------------------- */

/**
 * usb_gadget_udc_start - tells usb device controller to start up
 * @gadget: The gadget we want to get started
 * @driver: The driver we want to bind to @gadget
 *
 * This call is issued by the UDC Class driver when it's about
 * to register a gadget driver to the device controller, before
 * calling gadget driver's bind() method.
 *
 * It allows the controller to be powered off until strictly
 * necessary to have it powered on.
 *
 * Returns zero on success, else negative errno.
 */
static inline int usb_gadget_udc_start(struct usb_gadget *gadget,
		struct usb_gadget_driver *driver)
{
	return gadget->ops->udc_start(gadget, driver);
}

/**
 * usb_gadget_udc_stop - tells usb device controller we don't need it anymore
 * @gadget: The device we want to stop activity
 * @driver: The driver to unbind from @gadget
 *
 * This call is issued by the UDC Class driver after calling
 * gadget driver's unbind() method.
 *
 * The details are implementation specific, but it can go as
 * far as powering off UDC completely and disable its data
 * line pullups.
 */
static inline void usb_gadget_udc_stop(struct usb_gadget *gadget,
		struct usb_gadget_driver *driver)
{
	gadget->ops->udc_stop(gadget, driver);
}

/**
 * usb_udc_release - release the usb_udc struct
 * @dev: the dev member within usb_udc
 *
 * This is called by driver's core in order to free memory once the last
 * reference is released.
 */
static void usb_udc_release(struct device *dev)
{
	struct usb_udc *udc;

	udc = container_of(dev, struct usb_udc, dev);
	dev_dbg(dev, "releasing '%s'\n", dev_name(dev));
	kfree(udc);
}

static const struct attribute_group *usb_udc_attr_groups[];

static void usb_udc_nop_release(struct device *dev)
{
	dev_vdbg(dev, "%s\n", __func__);
}

/**
 * usb_add_gadget_udc_release - adds a new gadget to the udc class driver list
 * @parent: the parent device to this udc. Usually the controller driver's
 * device.
 * @gadget: the gadget to be added to the list.
 * @release: a gadget release function.
 *
 * Returns zero on success, negative errno otherwise.
 */
int usb_add_gadget_udc_release(struct device *parent, struct usb_gadget *gadget,
		void (*release)(struct device *dev))
{
	struct usb_udc		*udc;
	int			ret = -ENOMEM;

	udc = kzalloc(sizeof(*udc), GFP_KERNEL);
	if (!udc)
		goto err1;

	dev_set_name(&gadget->dev, "gadget");
	INIT_WORK(&gadget->work, usb_gadget_state_work);
	gadget->dev.parent = parent;

#ifdef	CONFIG_HAS_DMA
	dma_set_coherent_mask(&gadget->dev, parent->coherent_dma_mask);
	gadget->dev.dma_parms = parent->dma_parms;
	gadget->dev.dma_mask = parent->dma_mask;
#endif

	if (release)
		gadget->dev.release = release;
	else
		gadget->dev.release = usb_udc_nop_release;

	ret = device_register(&gadget->dev);
	if (ret)
		goto err2;

	device_initialize(&udc->dev);
	udc->dev.release = usb_udc_release;
	udc->dev.class = udc_class;
	udc->dev.groups = usb_udc_attr_groups;
	udc->dev.parent = parent;
	ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj));
	if (ret)
		goto err3;

	udc->gadget = gadget;

	mutex_lock(&udc_lock);
	list_add_tail(&udc->list, &udc_list);

	ret = device_add(&udc->dev);
	if (ret)
		goto err4;

	usb_gadget_set_state(gadget, USB_STATE_NOTATTACHED);

	mutex_unlock(&udc_lock);

	return 0;

err4:
	list_del(&udc->list);
	mutex_unlock(&udc_lock);

err3:
	put_device(&udc->dev);

err2:
	put_device(&gadget->dev);
	kfree(udc);

err1:
	return ret;
}
EXPORT_SYMBOL_GPL(usb_add_gadget_udc_release);

/**
 * usb_add_gadget_udc - adds a new gadget to the udc class driver list
 * @parent: the parent device to this udc. Usually the controller
 * driver's device.
 * @gadget: the gadget to be added to the list
 *
 * Returns zero on success, negative errno otherwise.
 */
int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget)
{
	return usb_add_gadget_udc_release(parent, gadget, NULL);
}
EXPORT_SYMBOL_GPL(usb_add_gadget_udc);

static void usb_gadget_remove_driver(struct usb_udc *udc)
{
	dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n",
			udc->gadget->name);

	kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);

	usb_gadget_disconnect(udc->gadget);
	udc->driver->disconnect(udc->gadget);
	udc->driver->unbind(udc->gadget);
	usb_gadget_udc_stop(udc->gadget, NULL);

	udc->driver = NULL;
	udc->dev.driver = NULL;
	udc->gadget->dev.driver = NULL;
}

/**
 * usb_del_gadget_udc - deletes @udc from udc_list
 * @gadget: the gadget to be removed.
 *
 * This, will call usb_gadget_unregister_driver() if
 * the @udc is still busy.
 */
void usb_del_gadget_udc(struct usb_gadget *gadget)
{
	struct usb_udc		*udc = NULL;

	mutex_lock(&udc_lock);
	list_for_each_entry(udc, &udc_list, list)
		if (udc->gadget == gadget)
			goto found;

	dev_err(gadget->dev.parent, "gadget not registered.\n");
	mutex_unlock(&udc_lock);

	return;

found:
	dev_vdbg(gadget->dev.parent, "unregistering gadget\n");

	list_del(&udc->list);
	mutex_unlock(&udc_lock);

	if (udc->driver)
		usb_gadget_remove_driver(udc);

	kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE);
	flush_work(&gadget->work);
	device_unregister(&udc->dev);
	device_unregister(&gadget->dev);
}
EXPORT_SYMBOL_GPL(usb_del_gadget_udc);

/* ------------------------------------------------------------------------- */

static int udc_bind_to_driver(struct usb_udc *udc, struct usb_gadget_driver *driver)
{
	int ret;

	dev_dbg(&udc->dev, "registering UDC driver [%s]\n",
			driver->function);

	udc->driver = driver;
	udc->dev.driver = &driver->driver;
	udc->gadget->dev.driver = &driver->driver;

	ret = driver->bind(udc->gadget, driver);
	if (ret)
		goto err1;
	ret = usb_gadget_udc_start(udc->gadget, driver);
	if (ret) {
		driver->unbind(udc->gadget);
		goto err1;
	}
	usb_gadget_connect(udc->gadget);

	kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
	return 0;
err1:
	dev_err(&udc->dev, "failed to start %s: %d\n",
			udc->driver->function, ret);
	udc->driver = NULL;
	udc->dev.driver = NULL;
	udc->gadget->dev.driver = NULL;
	return ret;
}

int udc_attach_driver(const char *name, struct usb_gadget_driver *driver)
{
	struct usb_udc *udc = NULL;
	int ret = -ENODEV;

	mutex_lock(&udc_lock);
	list_for_each_entry(udc, &udc_list, list) {
		ret = strcmp(name, dev_name(&udc->dev));
		if (!ret)
			break;
	}
	if (ret) {
		ret = -ENODEV;
		goto out;
	}
	if (udc->driver) {
		ret = -EBUSY;
		goto out;
	}
	ret = udc_bind_to_driver(udc, driver);
out:
	mutex_unlock(&udc_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(udc_attach_driver);

int usb_gadget_probe_driver(struct usb_gadget_driver *driver)
{
	struct usb_udc		*udc = NULL;
	int			ret;

	if (!driver || !driver->bind || !driver->setup)
		return -EINVAL;

	mutex_lock(&udc_lock);
	list_for_each_entry(udc, &udc_list, list) {
		/* For now we take the first one */
		if (!udc->driver)
			goto found;
	}

	pr_debug("couldn't find an available UDC\n");
	mutex_unlock(&udc_lock);
	return -ENODEV;
found:
	ret = udc_bind_to_driver(udc, driver);
	mutex_unlock(&udc_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(usb_gadget_probe_driver);

int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
{
	struct usb_udc		*udc = NULL;
	int			ret = -ENODEV;

	if (!driver || !driver->unbind)
		return -EINVAL;

	mutex_lock(&udc_lock);
	list_for_each_entry(udc, &udc_list, list)
		if (udc->driver == driver) {
			usb_gadget_remove_driver(udc);
			ret = 0;
			break;
		}

	mutex_unlock(&udc_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver);

/* ------------------------------------------------------------------------- */

static ssize_t usb_udc_srp_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t n)
{
	struct usb_udc		*udc = container_of(dev, struct usb_udc, dev);

	if (sysfs_streq(buf, "1"))
		usb_gadget_wakeup(udc->gadget);

	return n;
}
static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store);

static ssize_t usb_udc_softconn_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t n)
{
	struct usb_udc		*udc = container_of(dev, struct usb_udc, dev);

	if (sysfs_streq(buf, "connect")) {
		usb_gadget_udc_start(udc->gadget, udc->driver);
		usb_gadget_connect(udc->gadget);
	} else if (sysfs_streq(buf, "disconnect")) {
		usb_gadget_disconnect(udc->gadget);
		usb_gadget_udc_stop(udc->gadget, udc->driver);
	} else {
		dev_err(dev, "unsupported command '%s'\n", buf);
		return -EINVAL;
	}

	return n;
}
static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store);

static ssize_t state_show(struct device *dev, struct device_attribute *attr,
			  char *buf)
{
	struct usb_udc		*udc = container_of(dev, struct usb_udc, dev);
	struct usb_gadget	*gadget = udc->gadget;

	return sprintf(buf, "%s\n", usb_state_string(gadget->state));
}
static DEVICE_ATTR_RO(state);

#define USB_UDC_SPEED_ATTR(name, param)					\
ssize_t name##_show(struct device *dev,					\
		struct device_attribute *attr, char *buf)		\
{									\
	struct usb_udc *udc = container_of(dev, struct usb_udc, dev);	\
	return snprintf(buf, PAGE_SIZE, "%s\n",				\
			usb_speed_string(udc->gadget->param));		\
}									\
static DEVICE_ATTR_RO(name)

static USB_UDC_SPEED_ATTR(current_speed, speed);
static USB_UDC_SPEED_ATTR(maximum_speed, max_speed);

#define USB_UDC_ATTR(name)					\
ssize_t name##_show(struct device *dev,				\
		struct device_attribute *attr, char *buf)	\
{								\
	struct usb_udc		*udc = container_of(dev, struct usb_udc, dev); \
	struct usb_gadget	*gadget = udc->gadget;		\
								\
	return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name);	\
}								\
static DEVICE_ATTR_RO(name)

static USB_UDC_ATTR(is_otg);
static USB_UDC_ATTR(is_a_peripheral);
static USB_UDC_ATTR(b_hnp_enable);
static USB_UDC_ATTR(a_hnp_support);
static USB_UDC_ATTR(a_alt_hnp_support);

static struct attribute *usb_udc_attrs[] = {
	&dev_attr_srp.attr,
	&dev_attr_soft_connect.attr,
	&dev_attr_state.attr,
	&dev_attr_current_speed.attr,
	&dev_attr_maximum_speed.attr,

	&dev_attr_is_otg.attr,
	&dev_attr_is_a_peripheral.attr,
	&dev_attr_b_hnp_enable.attr,
	&dev_attr_a_hnp_support.attr,
	&dev_attr_a_alt_hnp_support.attr,
	NULL,
};

static const struct attribute_group usb_udc_attr_group = {
	.attrs = usb_udc_attrs,
};

static const struct attribute_group *usb_udc_attr_groups[] = {
	&usb_udc_attr_group,
	NULL,
};

static int usb_udc_uevent(struct device *dev, struct kobj_uevent_env *env)
{
	struct usb_udc		*udc = container_of(dev, struct usb_udc, dev);
	int			ret;

	ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name);
	if (ret) {
		dev_err(dev, "failed to add uevent USB_UDC_NAME\n");
		return ret;
	}

	if (udc->driver) {
		ret = add_uevent_var(env, "USB_UDC_DRIVER=%s",
				udc->driver->function);
		if (ret) {
			dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n");
			return ret;
		}
	}

	return 0;
}

static int __init usb_udc_init(void)
{
	udc_class = class_create(THIS_MODULE, "udc");
	if (IS_ERR(udc_class)) {
		pr_err("failed to create udc class --> %ld\n",
				PTR_ERR(udc_class));
		return PTR_ERR(udc_class);
	}

	udc_class->dev_uevent = usb_udc_uevent;
	return 0;
}
subsys_initcall(usb_udc_init);

static void __exit usb_udc_exit(void)
{
	class_destroy(udc_class);
}
module_exit(usb_udc_exit);

MODULE_DESCRIPTION("UDC Framework");
MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
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>
5702f753	26	#include <linux/workqueue.h>
2ccea03a FB	27
	28	#include <linux/usb/ch9.h>
	29	#include <linux/usb/gadget.h>
	30
	31	/**
	32	* struct usb_udc - describes one usb device controller
	33	* @driver - the gadget driver pointer. For use by the class code
	34	* @dev - the child device to the actual controller
	35	* @gadget - the gadget. For use by the class code
	36	* @list - for use by the udc class driver
	37	*
	38	* This represents the internal data structure which is used by the UDC-class
	39	* to hold information about udc driver and gadget together.
	40	*/
	41	struct usb_udc {
	42	struct usb_gadget_driver *driver;
	43	struct usb_gadget *gadget;
	44	struct device dev;
	45	struct list_head list;
	46	};
	47
	48	static struct class *udc_class;
2ccea03a FB	49	static LIST_HEAD(udc_list);
	50	static DEFINE_MUTEX(udc_lock);
	51
	52	/* ------------------------------------------------------------------------- */
	53
908b9613 AS	54	#ifdef CONFIG_HAS_DMA
908b9613 AS	55
a698908d FB	56	int usb_gadget_map_request(struct usb_gadget *gadget,
	57	struct usb_request *req, int is_in)
	58	{
	59	if (req->length == 0)
	60	return 0;
	61
	62	if (req->num_sgs) {
	63	int mapped;
	64
	65	mapped = dma_map_sg(&gadget->dev, req->sg, req->num_sgs,
	66	is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
	67	if (mapped == 0) {
	68	dev_err(&gadget->dev, "failed to map SGs\n");
	69	return -EFAULT;
	70	}
	71
	72	req->num_mapped_sgs = mapped;
	73	} else {
	74	req->dma = dma_map_single(&gadget->dev, req->buf, req->length,
	75	is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
	76
	77	if (dma_mapping_error(&gadget->dev, req->dma)) {
	78	dev_err(&gadget->dev, "failed to map buffer\n");
	79	return -EFAULT;
	80	}
	81	}
	82
	83	return 0;
	84	}
	85	EXPORT_SYMBOL_GPL(usb_gadget_map_request);
	86
	87	void usb_gadget_unmap_request(struct usb_gadget *gadget,
	88	struct usb_request *req, int is_in)
	89	{
	90	if (req->length == 0)
	91	return;
	92
	93	if (req->num_mapped_sgs) {
	94	dma_unmap_sg(&gadget->dev, req->sg, req->num_mapped_sgs,
	95	is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
	96
	97	req->num_mapped_sgs = 0;
	98	} else {
	99	dma_unmap_single(&gadget->dev, req->dma, req->length,
	100	is_in ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
	101	}
	102	}
	103	EXPORT_SYMBOL_GPL(usb_gadget_unmap_request);
	104
908b9613 AS	105	#endif /* CONFIG_HAS_DMA */
908b9613 AS	106
a698908d FB	107	/* ------------------------------------------------------------------------- */
a698908d FB	108
5702f753 FB	109	static void usb_gadget_state_work(struct work_struct *work)
	110	{
	111	struct usb_gadget *gadget = work_to_gadget(work);
	112
165f6064	113	sysfs_notify(&gadget->dev.kobj, NULL, "state");
5702f753 FB	114	}
5702f753 FB	115
49401f41 FB	116	void usb_gadget_set_state(struct usb_gadget *gadget,
	117	enum usb_device_state state)
	118	{
	119	gadget->state = state;
5702f753	120	schedule_work(&gadget->work);
49401f41 FB	121	}
	122	EXPORT_SYMBOL_GPL(usb_gadget_set_state);
	123
	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	*/
	140	static 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
352c2dc8 SAS	146	/**
	147	* usb_gadget_udc_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	*/
	158	static inline void usb_gadget_udc_stop(struct usb_gadget *gadget,
	159	struct usb_gadget_driver *driver)
	160	{
	161	gadget->ops->udc_stop(gadget, driver);
	162	}
	163
2ccea03a FB	164	/**
	165	* usb_udc_release - release the usb_udc struct
	166	* @dev: the dev member within usb_udc
	167	*
	168	* This is called by driver's core in order to free memory once the last
	169	* reference is released.
	170	*/
	171	static void usb_udc_release(struct device *dev)
	172	{
	173	struct usb_udc *udc;
	174
	175	udc = container_of(dev, struct usb_udc, dev);
	176	dev_dbg(dev, "releasing '%s'\n", dev_name(dev));
	177	kfree(udc);
	178	}
	179
019f976e	180	static const struct attribute_group *usb_udc_attr_groups[];
792bfcf7 FB	181
	182	static void usb_udc_nop_release(struct device *dev)
	183	{
	184	dev_vdbg(dev, "%s\n", __func__);
	185	}
	186
2ccea03a	187	/**
792bfcf7 FB	188	* usb_add_gadget_udc_release - adds a new gadget to the udc class driver list
	189	* @parent: the parent device to this udc. Usually the controller driver's
	190	* device.
	191	* @gadget: the gadget to be added to the list.
	192	* @release: a gadget release function.
2ccea03a FB	193	*
	194	* Returns zero on success, negative errno otherwise.
	195	*/
792bfcf7 FB	196	int usb_add_gadget_udc_release(struct device parent, struct usb_gadget gadget,
792bfcf7 FB	197	void (release)(struct device dev))
2ccea03a FB	198	{
	199	struct usb_udc *udc;
	200	int ret = -ENOMEM;
	201
	202	udc = kzalloc(sizeof(*udc), GFP_KERNEL);
	203	if (!udc)
	204	goto err1;
	205
7bce401c	206	dev_set_name(&gadget->dev, "gadget");
5702f753	207	INIT_WORK(&gadget->work, usb_gadget_state_work);
2ed14320	208	gadget->dev.parent = parent;
f07bd56b	209
908b9613	210	#ifdef CONFIG_HAS_DMA
658c8cf1 FB	211	dma_set_coherent_mask(&gadget->dev, parent->coherent_dma_mask);
	212	gadget->dev.dma_parms = parent->dma_parms;
	213	gadget->dev.dma_mask = parent->dma_mask;
908b9613	214	#endif
658c8cf1	215
ddf47ccb	216	if (release)
792bfcf7	217	gadget->dev.release = release;
ddf47ccb FB	218	else
ddf47ccb FB	219	gadget->dev.release = usb_udc_nop_release;
792bfcf7	220
7bce401c FB	221	ret = device_register(&gadget->dev);
	222	if (ret)
	223	goto err2;
f07bd56b	224
2ccea03a FB	225	device_initialize(&udc->dev);
	226	udc->dev.release = usb_udc_release;
	227	udc->dev.class = udc_class;
019f976e	228	udc->dev.groups = usb_udc_attr_groups;
2ccea03a FB	229	udc->dev.parent = parent;
	230	ret = dev_set_name(&udc->dev, "%s", kobject_name(&parent->kobj));
	231	if (ret)
f07bd56b	232	goto err3;
2ccea03a FB	233
	234	udc->gadget = gadget;
	235
	236	mutex_lock(&udc_lock);
	237	list_add_tail(&udc->list, &udc_list);
	238
	239	ret = device_add(&udc->dev);
	240	if (ret)
f07bd56b	241	goto err4;
2ccea03a	242
49401f41	243	usb_gadget_set_state(gadget, USB_STATE_NOTATTACHED);
2ccea03a FB	244
	245	mutex_unlock(&udc_lock);
	246
	247	return 0;
f07bd56b FB	248
f07bd56b FB	249	err4:
2ccea03a FB	250	list_del(&udc->list);
	251	mutex_unlock(&udc_lock);
	252
f07bd56b	253	err3:
2ccea03a FB	254	put_device(&udc->dev);
2ccea03a FB	255
f07bd56b	256	err2:
7bce401c	257	put_device(&gadget->dev);
c5dbc220	258	kfree(udc);
7bce401c	259
2ccea03a FB	260	err1:
	261	return ret;
	262	}
792bfcf7 FB	263	EXPORT_SYMBOL_GPL(usb_add_gadget_udc_release);
	264
	265	/**
	266	* usb_add_gadget_udc - adds a new gadget to the udc class driver list
	267	* @parent: the parent device to this udc. Usually the controller
	268	* driver's device.
	269	* @gadget: the gadget to be added to the list
	270	*
	271	* Returns zero on success, negative errno otherwise.
	272	*/
	273	int usb_add_gadget_udc(struct device parent, struct usb_gadget gadget)
	274	{
	275	return usb_add_gadget_udc_release(parent, gadget, NULL);
	276	}
2ccea03a FB	277	EXPORT_SYMBOL_GPL(usb_add_gadget_udc);
	278
	279	static void usb_gadget_remove_driver(struct usb_udc *udc)
	280	{
	281	dev_dbg(&udc->dev, "unregistering UDC driver [%s]\n",
	282	udc->gadget->name);
	283
	284	kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
	285
2d7ebbb0 FB	286	usb_gadget_disconnect(udc->gadget);
	287	udc->driver->disconnect(udc->gadget);
	288	udc->driver->unbind(udc->gadget);
511f3c53	289	usb_gadget_udc_stop(udc->gadget, NULL);
2ccea03a FB	290
	291	udc->driver = NULL;
	292	udc->dev.driver = NULL;
70d3a498	293	udc->gadget->dev.driver = NULL;
2ccea03a FB	294	}
	295
	296	/**
	297	* usb_del_gadget_udc - deletes @udc from udc_list
	298	* @gadget: the gadget to be removed.
	299	*
	300	* This, will call usb_gadget_unregister_driver() if
	301	* the @udc is still busy.
	302	*/
	303	void usb_del_gadget_udc(struct usb_gadget *gadget)
	304	{
	305	struct usb_udc *udc = NULL;
	306
	307	mutex_lock(&udc_lock);
	308	list_for_each_entry(udc, &udc_list, list)
	309	if (udc->gadget == gadget)
	310	goto found;
	311
	312	dev_err(gadget->dev.parent, "gadget not registered.\n");
	313	mutex_unlock(&udc_lock);
	314
	315	return;
	316
	317	found:
	318	dev_vdbg(gadget->dev.parent, "unregistering gadget\n");
	319
	320	list_del(&udc->list);
	321	mutex_unlock(&udc_lock);
	322
	323	if (udc->driver)
	324	usb_gadget_remove_driver(udc);
	325
	326	kobject_uevent(&udc->dev.kobj, KOBJ_REMOVE);
5702f753	327	flush_work(&gadget->work);
2ccea03a	328	device_unregister(&udc->dev);
7bce401c	329	device_unregister(&gadget->dev);
2ccea03a FB	330	}
	331	EXPORT_SYMBOL_GPL(usb_del_gadget_udc);
	332
	333	/* ------------------------------------------------------------------------- */
	334
4c49a5f0	335	static int udc_bind_to_driver(struct usb_udc udc, struct usb_gadget_driver driver)
2ccea03a	336	{
4c49a5f0	337	int ret;
2ccea03a	338
2ccea03a FB	339	dev_dbg(&udc->dev, "registering UDC driver [%s]\n",
	340	driver->function);
	341
	342	udc->driver = driver;
	343	udc->dev.driver = &driver->driver;
70d3a498	344	udc->gadget->dev.driver = &driver->driver;
2ccea03a	345
2d7ebbb0 FB	346	ret = driver->bind(udc->gadget, driver);
	347	if (ret)
	348	goto err1;
	349	ret = usb_gadget_udc_start(udc->gadget, driver);
	350	if (ret) {
	351	driver->unbind(udc->gadget);
	352	goto err1;
352c2dc8	353	}
2d7ebbb0	354	usb_gadget_connect(udc->gadget);
2ccea03a FB	355
2ccea03a FB	356	kobject_uevent(&udc->dev.kobj, KOBJ_CHANGE);
2ccea03a	357	return 0;
2ccea03a FB	358	err1:
	359	dev_err(&udc->dev, "failed to start %s: %d\n",
	360	udc->driver->function, ret);
	361	udc->driver = NULL;
	362	udc->dev.driver = NULL;
70d3a498	363	udc->gadget->dev.driver = NULL;
4c49a5f0 SAS	364	return ret;
	365	}
	366
	367	int udc_attach_driver(const char name, struct usb_gadget_driver driver)
	368	{
	369	struct usb_udc *udc = NULL;
	370	int ret = -ENODEV;
	371
	372	mutex_lock(&udc_lock);
	373	list_for_each_entry(udc, &udc_list, list) {
	374	ret = strcmp(name, dev_name(&udc->dev));
	375	if (!ret)
	376	break;
	377	}
	378	if (ret) {
	379	ret = -ENODEV;
	380	goto out;
	381	}
	382	if (udc->driver) {
	383	ret = -EBUSY;
	384	goto out;
	385	}
	386	ret = udc_bind_to_driver(udc, driver);
	387	out:
	388	mutex_unlock(&udc_lock);
	389	return ret;
	390	}
	391	EXPORT_SYMBOL_GPL(udc_attach_driver);
	392
	393	int usb_gadget_probe_driver(struct usb_gadget_driver *driver)
	394	{
	395	struct usb_udc *udc = NULL;
	396	int ret;
	397
	398	if (!driver \|\| !driver->bind \|\| !driver->setup)
	399	return -EINVAL;
	400
	401	mutex_lock(&udc_lock);
	402	list_for_each_entry(udc, &udc_list, list) {
	403	/* For now we take the first one */
	404	if (!udc->driver)
	405	goto found;
	406	}
	407
	408	pr_debug("couldn't find an available UDC\n");
	409	mutex_unlock(&udc_lock);
	410	return -ENODEV;
	411	found:
	412	ret = udc_bind_to_driver(udc, driver);
2ccea03a FB	413	mutex_unlock(&udc_lock);
	414	return ret;
	415	}
	416	EXPORT_SYMBOL_GPL(usb_gadget_probe_driver);
	417
	418	int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
	419	{
	420	struct usb_udc *udc = NULL;
	421	int ret = -ENODEV;
	422
	423	if (!driver \|\| !driver->unbind)
	424	return -EINVAL;
	425
	426	mutex_lock(&udc_lock);
	427	list_for_each_entry(udc, &udc_list, list)
	428	if (udc->driver == driver) {
	429	usb_gadget_remove_driver(udc);
	430	ret = 0;
	431	break;
	432	}
	433
	434	mutex_unlock(&udc_lock);
	435	return ret;
	436	}
	437	EXPORT_SYMBOL_GPL(usb_gadget_unregister_driver);
	438
	439	/* ------------------------------------------------------------------------- */
	440
	441	static ssize_t usb_udc_srp_store(struct device *dev,
	442	struct device_attribute attr, const char buf, size_t n)
	443	{
1d91a962	444	struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a FB	445
	446	if (sysfs_streq(buf, "1"))
	447	usb_gadget_wakeup(udc->gadget);
	448
	449	return n;
	450	}
	451	static DEVICE_ATTR(srp, S_IWUSR, NULL, usb_udc_srp_store);
	452
	453	static ssize_t usb_udc_softconn_store(struct device *dev,
	454	struct device_attribute attr, const char buf, size_t n)
	455	{
865569ba	456	struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
2ccea03a FB	457
2ccea03a FB	458	if (sysfs_streq(buf, "connect")) {
2d7ebbb0	459	usb_gadget_udc_start(udc->gadget, udc->driver);
2ccea03a FB	460	usb_gadget_connect(udc->gadget);
2ccea03a FB	461	} else if (sysfs_streq(buf, "disconnect")) {
83a787a7	462	usb_gadget_disconnect(udc->gadget);
2d7ebbb0	463	usb_gadget_udc_stop(udc->gadget, udc->driver);
2ccea03a FB	464	} else {
	465	dev_err(dev, "unsupported command '%s'\n", buf);
	466	return -EINVAL;
	467	}
	468
	469	return n;
	470	}
	471	static DEVICE_ATTR(soft_connect, S_IWUSR, NULL, usb_udc_softconn_store);
	472
ce26bd23 GKH	473	static ssize_t state_show(struct device dev, struct device_attribute attr,
ce26bd23 GKH	474	char *buf)
49401f41 FB	475	{
	476	struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
	477	struct usb_gadget *gadget = udc->gadget;
	478
	479	return sprintf(buf, "%s\n", usb_state_string(gadget->state));
	480	}
ce26bd23	481	static DEVICE_ATTR_RO(state);
49401f41	482
d327ab5b	483	#define USB_UDC_SPEED_ATTR(name, param) \
ce26bd23	484	ssize_t name##_show(struct device *dev, \
d327ab5b MN	485	struct device_attribute attr, char buf) \
	486	{ \
	487	struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
	488	return snprintf(buf, PAGE_SIZE, "%s\n", \
	489	usb_speed_string(udc->gadget->param)); \
	490	} \
ce26bd23	491	static DEVICE_ATTR_RO(name)
d327ab5b MN	492
	493	static USB_UDC_SPEED_ATTR(current_speed, speed);
	494	static USB_UDC_SPEED_ATTR(maximum_speed, max_speed);
	495
2ccea03a	496	#define USB_UDC_ATTR(name) \
ce26bd23	497	ssize_t name##_show(struct device *dev, \
2ccea03a FB	498	struct device_attribute attr, char buf) \
2ccea03a FB	499	{ \
019f976e	500	struct usb_udc *udc = container_of(dev, struct usb_udc, dev); \
2ccea03a FB	501	struct usb_gadget *gadget = udc->gadget; \
	502	\
	503	return snprintf(buf, PAGE_SIZE, "%d\n", gadget->name); \
	504	} \
ce26bd23	505	static DEVICE_ATTR_RO(name)
2ccea03a	506
2ccea03a FB	507	static USB_UDC_ATTR(is_otg);
	508	static USB_UDC_ATTR(is_a_peripheral);
	509	static USB_UDC_ATTR(b_hnp_enable);
	510	static USB_UDC_ATTR(a_hnp_support);
	511	static USB_UDC_ATTR(a_alt_hnp_support);
	512
	513	static struct attribute *usb_udc_attrs[] = {
	514	&dev_attr_srp.attr,
	515	&dev_attr_soft_connect.attr,
49401f41	516	&dev_attr_state.attr,
d327ab5b MN	517	&dev_attr_current_speed.attr,
d327ab5b MN	518	&dev_attr_maximum_speed.attr,
2ccea03a	519
2ccea03a FB	520	&dev_attr_is_otg.attr,
	521	&dev_attr_is_a_peripheral.attr,
	522	&dev_attr_b_hnp_enable.attr,
	523	&dev_attr_a_hnp_support.attr,
	524	&dev_attr_a_alt_hnp_support.attr,
	525	NULL,
	526	};
	527
	528	static const struct attribute_group usb_udc_attr_group = {
	529	.attrs = usb_udc_attrs,
	530	};
	531
	532	static const struct attribute_group *usb_udc_attr_groups[] = {
	533	&usb_udc_attr_group,
	534	NULL,
	535	};
	536
	537	static int usb_udc_uevent(struct device dev, struct kobj_uevent_env env)
	538	{
	539	struct usb_udc *udc = container_of(dev, struct usb_udc, dev);
	540	int ret;
	541
	542	ret = add_uevent_var(env, "USB_UDC_NAME=%s", udc->gadget->name);
	543	if (ret) {
	544	dev_err(dev, "failed to add uevent USB_UDC_NAME\n");
	545	return ret;
	546	}
	547
	548	if (udc->driver) {
	549	ret = add_uevent_var(env, "USB_UDC_DRIVER=%s",
	550	udc->driver->function);
	551	if (ret) {
	552	dev_err(dev, "failed to add uevent USB_UDC_DRIVER\n");
	553	return ret;
	554	}
	555	}
	556
	557	return 0;
	558	}
	559
	560	static int __init usb_udc_init(void)
	561	{
	562	udc_class = class_create(THIS_MODULE, "udc");
	563	if (IS_ERR(udc_class)) {
	564	pr_err("failed to create udc class --> %ld\n",
	565	PTR_ERR(udc_class));
	566	return PTR_ERR(udc_class);
	567	}
	568
	569	udc_class->dev_uevent = usb_udc_uevent;
2ccea03a FB	570	return 0;
	571	}
	572	subsys_initcall(usb_udc_init);
	573
	574	static void __exit usb_udc_exit(void)
	575	{
	576	class_destroy(udc_class);
	577	}
	578	module_exit(usb_udc_exit);
	579
	580	MODULE_DESCRIPTION("UDC Framework");
	581	MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
	582	MODULE_LICENSE("GPL v2");