[mirror_ubuntu-eoan-kernel.git] / drivers / usb / gadget / cdc2.c

/*
 * cdc2.c -- CDC Composite driver, with ECM and ACM support
 *
 * Copyright (C) 2008 David Brownell
 * Copyright (C) 2008 Nokia Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#include <linux/kernel.h>
#include <linux/module.h>

#include "u_ether.h"
#include "u_serial.h"
#include "u_ecm.h"


#define DRIVER_DESC		"CDC Composite Gadget"
#define DRIVER_VERSION		"King Kamehameha Day 2008"

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

/* DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
 * Instead:  allocate your own, using normal USB-IF procedures.
 */

/* Thanks to NetChip Technologies for donating this product ID.
 * It's for devices with only this composite CDC configuration.
 */
#define CDC_VENDOR_NUM		0x0525	/* NetChip */
#define CDC_PRODUCT_NUM		0xa4aa	/* CDC Composite: ECM + ACM */

USB_GADGET_COMPOSITE_OPTIONS();

USB_ETHERNET_MODULE_PARAMETERS();

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

static struct usb_device_descriptor device_desc = {
	.bLength =		sizeof device_desc,
	.bDescriptorType =	USB_DT_DEVICE,

	.bcdUSB =		cpu_to_le16(0x0200),

	.bDeviceClass =		USB_CLASS_COMM,
	.bDeviceSubClass =	0,
	.bDeviceProtocol =	0,
	/* .bMaxPacketSize0 = f(hardware) */

	/* Vendor and product id can be overridden by module parameters.  */
	.idVendor =		cpu_to_le16(CDC_VENDOR_NUM),
	.idProduct =		cpu_to_le16(CDC_PRODUCT_NUM),
	/* .bcdDevice = f(hardware) */
	/* .iManufacturer = DYNAMIC */
	/* .iProduct = DYNAMIC */
	/* NO SERIAL NUMBER */
	.bNumConfigurations =	1,
};

static struct usb_otg_descriptor otg_descriptor = {
	.bLength =		sizeof otg_descriptor,
	.bDescriptorType =	USB_DT_OTG,

	/* REVISIT SRP-only hardware is possible, although
	 * it would not be called "OTG" ...
	 */
	.bmAttributes =		USB_OTG_SRP | USB_OTG_HNP,
};

static const struct usb_descriptor_header *otg_desc[] = {
	(struct usb_descriptor_header *) &otg_descriptor,
	NULL,
};


/* string IDs are assigned dynamically */
static struct usb_string strings_dev[] = {
	[USB_GADGET_MANUFACTURER_IDX].s = "",
	[USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
	[USB_GADGET_SERIAL_IDX].s = "",
	{  } /* end of list */
};

static struct usb_gadget_strings stringtab_dev = {
	.language	= 0x0409,	/* en-us */
	.strings	= strings_dev,
};

static struct usb_gadget_strings *dev_strings[] = {
	&stringtab_dev,
	NULL,
};

/*-------------------------------------------------------------------------*/
static struct usb_function *f_acm;
static struct usb_function_instance *fi_serial;

static struct usb_function *f_ecm;
static struct usb_function_instance *fi_ecm;

/*
 * We _always_ have both CDC ECM and CDC ACM functions.
 */
static int __init cdc_do_config(struct usb_configuration *c)
{
	int	status;

	if (gadget_is_otg(c->cdev->gadget)) {
		c->descriptors = otg_desc;
		c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
	}

	f_ecm = usb_get_function(fi_ecm);
	if (IS_ERR(f_ecm)) {
		status = PTR_ERR(f_ecm);
		goto err_get_ecm;
	}

	status = usb_add_function(c, f_ecm);
	if (status)
		goto err_add_ecm;

	f_acm = usb_get_function(fi_serial);
	if (IS_ERR(f_acm)) {
		status = PTR_ERR(f_acm);
		goto err_get_acm;
	}

	status = usb_add_function(c, f_acm);
	if (status)
		goto err_add_acm;
	return 0;

err_add_acm:
	usb_put_function(f_acm);
err_get_acm:
	usb_remove_function(c, f_ecm);
err_add_ecm:
	usb_put_function(f_ecm);
err_get_ecm:
	return status;
}

static struct usb_configuration cdc_config_driver = {
	.label			= "CDC Composite (ECM + ACM)",
	.bConfigurationValue	= 1,
	/* .iConfiguration = DYNAMIC */
	.bmAttributes		= USB_CONFIG_ATT_SELFPOWER,
};

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

static int __init cdc_bind(struct usb_composite_dev *cdev)
{
	struct usb_gadget	*gadget = cdev->gadget;
	struct f_ecm_opts	*ecm_opts;
	int			status;

	if (!can_support_ecm(cdev->gadget)) {
		dev_err(&gadget->dev, "controller '%s' not usable\n",
				gadget->name);
		return -EINVAL;
	}

	fi_ecm = usb_get_function_instance("ecm");
	if (IS_ERR(fi_ecm))
		return PTR_ERR(fi_ecm);

	ecm_opts = container_of(fi_ecm, struct f_ecm_opts, func_inst);

	gether_set_qmult(ecm_opts->net, qmult);
	if (!gether_set_host_addr(ecm_opts->net, host_addr))
		pr_info("using host ethernet address: %s", host_addr);
	if (!gether_set_dev_addr(ecm_opts->net, dev_addr))
		pr_info("using self ethernet address: %s", dev_addr);

	fi_serial = usb_get_function_instance("acm");
	if (IS_ERR(fi_serial)) {
		status = PTR_ERR(fi_serial);
		goto fail;
	}

	/* Allocate string descriptor numbers ... note that string
	 * contents can be overridden by the composite_dev glue.
	 */

	status = usb_string_ids_tab(cdev, strings_dev);
	if (status < 0)
		goto fail1;
	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;

	/* register our configuration */
	status = usb_add_config(cdev, &cdc_config_driver, cdc_do_config);
	if (status < 0)
		goto fail1;

	usb_composite_overwrite_options(cdev, &coverwrite);
	dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
			DRIVER_DESC);

	return 0;

fail1:
	usb_put_function_instance(fi_serial);
fail:
	usb_put_function_instance(fi_ecm);
	return status;
}

static int __exit cdc_unbind(struct usb_composite_dev *cdev)
{
	usb_put_function(f_acm);
	usb_put_function_instance(fi_serial);
	if (!IS_ERR_OR_NULL(f_ecm))
		usb_put_function(f_ecm);
	if (!IS_ERR_OR_NULL(fi_ecm))
		usb_put_function_instance(fi_ecm);
	return 0;
}

static __refdata struct usb_composite_driver cdc_driver = {
	.name		= "g_cdc",
	.dev		= &device_desc,
	.strings	= dev_strings,
	.max_speed	= USB_SPEED_HIGH,
	.bind		= cdc_bind,
	.unbind		= __exit_p(cdc_unbind),
};

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("David Brownell");
MODULE_LICENSE("GPL");

static int __init init(void)
{
	return usb_composite_probe(&cdc_driver);
}
module_init(init);

static void __exit cleanup(void)
{
	usb_composite_unregister(&cdc_driver);
}
module_exit(cleanup);
Commit	Line	Data
19e20680 DB	1	/*
	2	* cdc2.c -- CDC Composite driver, with ECM and ACM support
	3	*
	4	* Copyright (C) 2008 David Brownell
	5	* Copyright (C) 2008 Nokia Corporation
	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 as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
19e20680 DB	11	*/
	12
	13	#include <linux/kernel.h>
6eb0de82	14	#include <linux/module.h>
19e20680 DB	15
	16	#include "u_ether.h"
	17	#include "u_serial.h"
a38a2750	18	#include "u_ecm.h"
19e20680 DB	19
	20
	21	#define DRIVER_DESC "CDC Composite Gadget"
	22	#define DRIVER_VERSION "King Kamehameha Day 2008"
	23
	24	/-------------------------------------------------------------------------/
	25
	26	/* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
	27	* Instead: allocate your own, using normal USB-IF procedures.
	28	*/
	29
	30	/* Thanks to NetChip Technologies for donating this product ID.
	31	* It's for devices with only this composite CDC configuration.
	32	*/
	33	#define CDC_VENDOR_NUM 0x0525 /* NetChip */
	34	#define CDC_PRODUCT_NUM 0xa4aa /* CDC Composite: ECM + ACM */
	35
7d16e8d3	36	USB_GADGET_COMPOSITE_OPTIONS();
19e20680	37
f1a1823f AP	38	USB_ETHERNET_MODULE_PARAMETERS();
f1a1823f AP	39
8a1ce2c0 DB	40	/-------------------------------------------------------------------------/
8a1ce2c0 DB	41
19e20680 DB	42	static struct usb_device_descriptor device_desc = {
	43	.bLength = sizeof device_desc,
	44	.bDescriptorType = USB_DT_DEVICE,
	45
551509d2	46	.bcdUSB = cpu_to_le16(0x0200),
19e20680 DB	47
	48	.bDeviceClass = USB_CLASS_COMM,
	49	.bDeviceSubClass = 0,
	50	.bDeviceProtocol = 0,
	51	/* .bMaxPacketSize0 = f(hardware) */
	52
	53	/* Vendor and product id can be overridden by module parameters. */
551509d2 HH	54	.idVendor = cpu_to_le16(CDC_VENDOR_NUM),
551509d2 HH	55	.idProduct = cpu_to_le16(CDC_PRODUCT_NUM),
19e20680 DB	56	/* .bcdDevice = f(hardware) */
	57	/* .iManufacturer = DYNAMIC */
	58	/* .iProduct = DYNAMIC */
	59	/* NO SERIAL NUMBER */
	60	.bNumConfigurations = 1,
	61	};
	62
	63	static struct usb_otg_descriptor otg_descriptor = {
	64	.bLength = sizeof otg_descriptor,
	65	.bDescriptorType = USB_DT_OTG,
	66
	67	/* REVISIT SRP-only hardware is possible, although
	68	* it would not be called "OTG" ...
	69	*/
	70	.bmAttributes = USB_OTG_SRP \| USB_OTG_HNP,
	71	};
	72
	73	static const struct usb_descriptor_header *otg_desc[] = {
	74	(struct usb_descriptor_header *) &otg_descriptor,
	75	NULL,
	76	};
	77
	78
	79	/* string IDs are assigned dynamically */
19e20680	80	static struct usb_string strings_dev[] = {
cc2683c3	81	[USB_GADGET_MANUFACTURER_IDX].s = "",
276e2e4f SAS	82	[USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
276e2e4f SAS	83	[USB_GADGET_SERIAL_IDX].s = "",
19e20680 DB	84	{ } /* end of list */
	85	};
	86
	87	static struct usb_gadget_strings stringtab_dev = {
	88	.language = 0x0409, /* en-us */
	89	.strings = strings_dev,
	90	};
	91
	92	static struct usb_gadget_strings *dev_strings[] = {
	93	&stringtab_dev,
	94	NULL,
	95	};
	96
19e20680	97	/-------------------------------------------------------------------------/
29a6645f SAS	98	static struct usb_function *f_acm;
29a6645f SAS	99	static struct usb_function_instance *fi_serial;
19e20680	100
a38a2750 AP	101	static struct usb_function *f_ecm;
	102	static struct usb_function_instance *fi_ecm;
	103
19e20680 DB	104	/*
	105	* We _always_ have both CDC ECM and CDC ACM functions.
	106	*/
e12995ec	107	static int __init cdc_do_config(struct usb_configuration *c)
19e20680 DB	108	{
	109	int status;
	110
	111	if (gadget_is_otg(c->cdev->gadget)) {
	112	c->descriptors = otg_desc;
	113	c->bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
	114	}
	115
a38a2750 AP	116	f_ecm = usb_get_function(fi_ecm);
	117	if (IS_ERR(f_ecm)) {
	118	status = PTR_ERR(f_ecm);
	119	goto err_get_ecm;
	120	}
	121
	122	status = usb_add_function(c, f_ecm);
	123	if (status)
	124	goto err_add_ecm;
19e20680	125
29a6645f	126	f_acm = usb_get_function(fi_serial);
8d6f51bd WY	127	if (IS_ERR(f_acm)) {
8d6f51bd WY	128	status = PTR_ERR(f_acm);
d2ff4059	129	goto err_get_acm;
8d6f51bd	130	}
29a6645f SAS	131
	132	status = usb_add_function(c, f_acm);
	133	if (status)
a38a2750	134	goto err_add_acm;
19e20680	135	return 0;
a38a2750 AP	136
a38a2750 AP	137	err_add_acm:
29a6645f	138	usb_put_function(f_acm);
a38a2750 AP	139	err_get_acm:
	140	usb_remove_function(c, f_ecm);
	141	err_add_ecm:
	142	usb_put_function(f_ecm);
	143	err_get_ecm:
29a6645f	144	return status;
19e20680 DB	145	}
	146
	147	static struct usb_configuration cdc_config_driver = {
	148	.label = "CDC Composite (ECM + ACM)",
19e20680 DB	149	.bConfigurationValue = 1,
	150	/* .iConfiguration = DYNAMIC */
	151	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
19e20680 DB	152	};
	153
	154	/-------------------------------------------------------------------------/
	155
e12995ec	156	static int __init cdc_bind(struct usb_composite_dev *cdev)
19e20680	157	{
19e20680	158	struct usb_gadget *gadget = cdev->gadget;
a38a2750	159	struct f_ecm_opts *ecm_opts;
19e20680 DB	160	int status;
	161
	162	if (!can_support_ecm(cdev->gadget)) {
8a1ce2c0 DB	163	dev_err(&gadget->dev, "controller '%s' not usable\n",
8a1ce2c0 DB	164	gadget->name);
19e20680 DB	165	return -EINVAL;
	166	}
	167
a38a2750 AP	168	fi_ecm = usb_get_function_instance("ecm");
	169	if (IS_ERR(fi_ecm))
	170	return PTR_ERR(fi_ecm);
	171
	172	ecm_opts = container_of(fi_ecm, struct f_ecm_opts, func_inst);
	173
	174	gether_set_qmult(ecm_opts->net, qmult);
	175	if (!gether_set_host_addr(ecm_opts->net, host_addr))
	176	pr_info("using host ethernet address: %s", host_addr);
	177	if (!gether_set_dev_addr(ecm_opts->net, dev_addr))
	178	pr_info("using self ethernet address: %s", dev_addr);
	179
	180	fi_serial = usb_get_function_instance("acm");
	181	if (IS_ERR(fi_serial)) {
	182	status = PTR_ERR(fi_serial);
	183	goto fail;
	184	}
19e20680	185
19e20680 DB	186	/* Allocate string descriptor numbers ... note that string
	187	* contents can be overridden by the composite_dev glue.
	188	*/
	189
e1f15ccb	190	status = usb_string_ids_tab(cdev, strings_dev);
19e20680 DB	191	if (status < 0)
19e20680 DB	192	goto fail1;
276e2e4f SAS	193	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
276e2e4f SAS	194	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
19e20680 DB	195
19e20680 DB	196	/* register our configuration */
c9bfff9c	197	status = usb_add_config(cdev, &cdc_config_driver, cdc_do_config);
19e20680 DB	198	if (status < 0)
	199	goto fail1;
	200
7d16e8d3	201	usb_composite_overwrite_options(cdev, &coverwrite);
8a1ce2c0 DB	202	dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
8a1ce2c0 DB	203	DRIVER_DESC);
19e20680 DB	204
	205	return 0;
	206
	207	fail1:
a38a2750 AP	208	usb_put_function_instance(fi_serial);
	209	fail:
	210	usb_put_function_instance(fi_ecm);
19e20680 DB	211	return status;
	212	}
	213
	214	static int __exit cdc_unbind(struct usb_composite_dev *cdev)
	215	{
29a6645f SAS	216	usb_put_function(f_acm);
29a6645f SAS	217	usb_put_function_instance(fi_serial);
a38a2750 AP	218	if (!IS_ERR_OR_NULL(f_ecm))
	219	usb_put_function(f_ecm);
	220	if (!IS_ERR_OR_NULL(fi_ecm))
	221	usb_put_function_instance(fi_ecm);
19e20680 DB	222	return 0;
	223	}
	224
c2ec75c2	225	static __refdata struct usb_composite_driver cdc_driver = {
19e20680 DB	226	.name = "g_cdc",
	227	.dev = &device_desc,
	228	.strings = dev_strings,
35a0e0bf	229	.max_speed = USB_SPEED_HIGH,
03e42bd5	230	.bind = cdc_bind,
19e20680 DB	231	.unbind = __exit_p(cdc_unbind),
	232	};
	233
	234	MODULE_DESCRIPTION(DRIVER_DESC);
	235	MODULE_AUTHOR("David Brownell");
	236	MODULE_LICENSE("GPL");
	237
	238	static int __init init(void)
	239	{
03e42bd5	240	return usb_composite_probe(&cdc_driver);
19e20680 DB	241	}
	242	module_init(init);
	243
	244	static void __exit cleanup(void)
	245	{
	246	usb_composite_unregister(&cdc_driver);
	247	}
	248	module_exit(cleanup);