[mirror_ubuntu-jammy-kernel.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/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);

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

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);

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

void usb_gadget_set_state(struct usb_gadget *gadget,
		enum usb_device_state state)
{
	gadget->state = state;
	sysfs_notify(&gadget->dev.kobj, NULL, "status");
}
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");
	gadget->dev.parent = parent;

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

	if (release) {
		gadget->dev.release = release;
	} else {
		if (!gadget->dev.release)
			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);

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, udc->driver);

	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);
	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 usb_gadget_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(state, S_IRUGO, usb_gadget_state_show, NULL);

#define USB_UDC_SPEED_ATTR(name, param)					\
ssize_t usb_udc_##param##_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(name, S_IRUSR, usb_udc_##param##_show, NULL)

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

#define USB_UDC_ATTR(name)					\
ssize_t usb_udc_##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(name, S_IRUGO, usb_udc_##name##_show, NULL)

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