[deliverable/linux.git] / drivers / usb / gadget / ncm.c

/*
 * ncm.c -- NCM gadget driver
 *
 * Copyright (C) 2010 Nokia Corporation
 * Contact: Yauheni Kaliuta <yauheni.kaliuta@nokia.com>
 *
 * The driver borrows from ether.c which is:
 *
 * Copyright (C) 2003-2005,2008 David Brownell
 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
 * 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.
 */

/* #define DEBUG */
/* #define VERBOSE_DEBUG */

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


#include "u_ether.h"

#define DRIVER_DESC		"NCM Gadget"

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

/*
 * Kbuild is not very cooperative with respect to linking separately
 * compiled library objects into one module.  So for now we won't use
 * separate compilation ... ensuring init/exit sections work to shrink
 * the runtime footprint, and giving us at least some parts of what
 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
 */
#include "composite.c"

#include "f_ncm.c"
#include "u_ether.c"

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

/* 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 CDC Ethernet configurations.
 */
#define CDC_VENDOR_NUM		0x0525	/* NetChip */
#define CDC_PRODUCT_NUM		0xa4a1	/* Linux-USB Ethernet Gadget */

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

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 defaults change according to what configs
	 * we support.  (As does bNumConfigurations.)  These values can
	 * also 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 */

#define STRING_MANUFACTURER_IDX		0
#define STRING_PRODUCT_IDX		1

static char manufacturer[50];

static struct usb_string strings_dev[] = {
	[STRING_MANUFACTURER_IDX].s = manufacturer,
	[STRING_PRODUCT_IDX].s = DRIVER_DESC,
	{  } /* 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 u8 hostaddr[ETH_ALEN];

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

static int __init ncm_do_config(struct usb_configuration *c)
{
	/* FIXME alloc iConfiguration string, set it in c->strings */

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

	return ncm_bind_config(c, hostaddr);
}

static struct usb_configuration ncm_config_driver = {
	/* .label = f(hardware) */
	.label			= "CDC Ethernet (NCM)",
	.bConfigurationValue	= 1,
	/* .iConfiguration = DYNAMIC */
	.bmAttributes		= USB_CONFIG_ATT_SELFPOWER,
};

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

static int __init gncm_bind(struct usb_composite_dev *cdev)
{
	int			gcnum;
	struct usb_gadget	*gadget = cdev->gadget;
	int			status;

	/* set up network link layer */
	status = gether_setup(cdev->gadget, hostaddr);
	if (status < 0)
		return status;

	gcnum = usb_gadget_controller_number(gadget);
	if (gcnum >= 0)
		device_desc.bcdDevice = cpu_to_le16(0x0300 | gcnum);
	else {
		/* We assume that can_support_ecm() tells the truth;
		 * but if the controller isn't recognized at all then
		 * that assumption is a bit more likely to be wrong.
		 */
		dev_warn(&gadget->dev,
			 "controller '%s' not recognized; trying %s\n",
			 gadget->name,
			 ncm_config_driver.label);
		device_desc.bcdDevice =
			cpu_to_le16(0x0300 | 0x0099);
	}


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

	/* device descriptor strings: manufacturer, product */
	snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
		init_utsname()->sysname, init_utsname()->release,
		gadget->name);
	status = usb_string_ids_tab(cdev, strings_dev);
	if (status < 0)
		goto fail;
	device_desc.iManufacturer = strings_dev[STRING_MANUFACTURER_IDX].id;
	device_desc.iProduct = strings_dev[STRING_PRODUCT_IDX].id;

	status = usb_add_config(cdev, &ncm_config_driver,
				ncm_do_config);
	if (status < 0)
		goto fail;

	dev_info(&gadget->dev, "%s\n", DRIVER_DESC);

	return 0;

fail:
	gether_cleanup();
	return status;
}

static int __exit gncm_unbind(struct usb_composite_dev *cdev)
{
	gether_cleanup();
	return 0;
}

static __refdata struct usb_composite_driver ncm_driver = {
	.name		= "g_ncm",
	.dev		= &device_desc,
	.strings	= dev_strings,
	.max_speed	= USB_SPEED_HIGH,
	.bind		= gncm_bind,
	.unbind		= __exit_p(gncm_unbind),
};

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("Yauheni Kaliuta");
MODULE_LICENSE("GPL");

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

static void __exit cleanup(void)
{
	usb_composite_unregister(&ncm_driver);
}
module_exit(cleanup);
Commit	Line	Data
6c34d288 YK	1	/*
	2	* ncm.c -- NCM gadget driver
	3	*
	4	* Copyright (C) 2010 Nokia Corporation
	5	* Contact: Yauheni Kaliuta <yauheni.kaliuta@nokia.com>
	6	*
	7	* The driver borrows from ether.c which is:
	8	*
	9	* Copyright (C) 2003-2005,2008 David Brownell
	10	* Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
	11	* Copyright (C) 2008 Nokia Corporation
	12	*
	13	* This program is free software; you can redistribute it and/or modify
	14	* it under the terms of the GNU General Public License as published by
	15	* the Free Software Foundation; either version 2 of the License, or
	16	* (at your option) any later version.
6c34d288 YK	17	*/
	18
	19	/* #define DEBUG */
	20	/* #define VERBOSE_DEBUG */
	21
	22	#include <linux/kernel.h>
	23	#include <linux/utsname.h>
	24
	25
	26	#include "u_ether.h"
	27
	28	#define DRIVER_DESC "NCM Gadget"
	29
	30	/-------------------------------------------------------------------------/
	31
	32	/*
	33	* Kbuild is not very cooperative with respect to linking separately
	34	* compiled library objects into one module. So for now we won't use
	35	* separate compilation ... ensuring init/exit sections work to shrink
	36	* the runtime footprint, and giving us at least some parts of what
	37	* a "gcc --combine ... part1.c part2.c part3.c ... " build would.
	38	*/
	39	#include "composite.c"
6c34d288 YK	40
	41	#include "f_ncm.c"
	42	#include "u_ether.c"
	43
	44	/-------------------------------------------------------------------------/
	45
	46	/* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
	47	* Instead: allocate your own, using normal USB-IF procedures.
	48	*/
	49
	50	/* Thanks to NetChip Technologies for donating this product ID.
	51	* It's for devices with only CDC Ethernet configurations.
	52	*/
	53	#define CDC_VENDOR_NUM 0x0525 /* NetChip */
	54	#define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
	55
	56	/-------------------------------------------------------------------------/
	57
	58	static struct usb_device_descriptor device_desc = {
	59	.bLength = sizeof device_desc,
	60	.bDescriptorType = USB_DT_DEVICE,
	61
	62	.bcdUSB = cpu_to_le16 (0x0200),
	63
	64	.bDeviceClass = USB_CLASS_COMM,
	65	.bDeviceSubClass = 0,
	66	.bDeviceProtocol = 0,
	67	/* .bMaxPacketSize0 = f(hardware) */
	68
	69	/* Vendor and product id defaults change according to what configs
	70	* we support. (As does bNumConfigurations.) These values can
	71	* also be overridden by module parameters.
	72	*/
	73	.idVendor = cpu_to_le16 (CDC_VENDOR_NUM),
	74	.idProduct = cpu_to_le16 (CDC_PRODUCT_NUM),
	75	/* .bcdDevice = f(hardware) */
	76	/* .iManufacturer = DYNAMIC */
	77	/* .iProduct = DYNAMIC */
	78	/* NO SERIAL NUMBER */
	79	.bNumConfigurations = 1,
	80	};
	81
	82	static struct usb_otg_descriptor otg_descriptor = {
	83	.bLength = sizeof otg_descriptor,
	84	.bDescriptorType = USB_DT_OTG,
	85
	86	/* REVISIT SRP-only hardware is possible, although
	87	* it would not be called "OTG" ...
	88	*/
	89	.bmAttributes = USB_OTG_SRP \| USB_OTG_HNP,
	90	};
	91
	92	static const struct usb_descriptor_header *otg_desc[] = {
	93	(struct usb_descriptor_header *) &otg_descriptor,
	94	NULL,
	95	};
	96
	97
	98	/* string IDs are assigned dynamically */
	99
	100	#define STRING_MANUFACTURER_IDX 0
	101	#define STRING_PRODUCT_IDX 1
	102
	103	static char manufacturer[50];
104
105	static struct usb_string strings_dev[] = {
106	[STRING_MANUFACTURER_IDX].s = manufacturer,
107	[STRING_PRODUCT_IDX].s = DRIVER_DESC,
108	{ } /* end of list */
109	};
110
111	static struct usb_gadget_strings stringtab_dev = {
112	.language = 0x0409, /* en-us */
113	.strings = strings_dev,
114	};
115
116	static struct usb_gadget_strings *dev_strings[] = {
117	&stringtab_dev,
118	NULL,
119	};
120
121	static u8 hostaddr[ETH_ALEN];
122
123	/-------------------------------------------------------------------------/
124
125	static int __init ncm_do_config(struct usb_configuration *c)
126	{
127	/* FIXME alloc iConfiguration string, set it in c->strings */
128
129	if (gadget_is_otg(c->cdev->gadget)) {
130	c->descriptors = otg_desc;
131	c->bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
132	}
133
134	return ncm_bind_config(c, hostaddr);
135	}
136
137	static struct usb_configuration ncm_config_driver = {
138	/* .label = f(hardware) */
139	.label = "CDC Ethernet (NCM)",
140	.bConfigurationValue = 1,
141	/* .iConfiguration = DYNAMIC */
142	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
143	};
144
145	/-------------------------------------------------------------------------/
146
147	static int __init gncm_bind(struct usb_composite_dev *cdev)
148	{
149	int gcnum;
150	struct usb_gadget *gadget = cdev->gadget;
151	int status;
152
153	/* set up network link layer */
154	status = gether_setup(cdev->gadget, hostaddr);
155	if (status < 0)
156	return status;
157
158	gcnum = usb_gadget_controller_number(gadget);
159	if (gcnum >= 0)
160	device_desc.bcdDevice = cpu_to_le16(0x0300 \| gcnum);
161	else {
162	/* We assume that can_support_ecm() tells the truth;
163	* but if the controller isn't recognized at all then
164	* that assumption is a bit more likely to be wrong.
165	*/
166	dev_warn(&gadget->dev,
167	"controller '%s' not recognized; trying %s\n",
168	gadget->name,
169	ncm_config_driver.label);
170	device_desc.bcdDevice =
171	cpu_to_le16(0x0300 \| 0x0099);
172	}
173
174
175	/* Allocate string descriptor numbers ... note that string
176	* contents can be overridden by the composite_dev glue.
177	*/
178
179	/* device descriptor strings: manufacturer, product */
180	snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
181	init_utsname()->sysname, init_utsname()->release,
182	gadget->name);
e1f15ccb	183	status = usb_string_ids_tab(cdev, strings_dev);
6c34d288 YK	184	if (status < 0)
6c34d288 YK	185	goto fail;
e1f15ccb SAS	186	device_desc.iManufacturer = strings_dev[STRING_MANUFACTURER_IDX].id;
e1f15ccb SAS	187	device_desc.iProduct = strings_dev[STRING_PRODUCT_IDX].id;
6c34d288 YK	188
	189	status = usb_add_config(cdev, &ncm_config_driver,
	190	ncm_do_config);
	191	if (status < 0)
	192	goto fail;
	193
	194	dev_info(&gadget->dev, "%s\n", DRIVER_DESC);
	195
	196	return 0;
	197
	198	fail:
	199	gether_cleanup();
	200	return status;
	201	}
	202
	203	static int __exit gncm_unbind(struct usb_composite_dev *cdev)
	204	{
	205	gether_cleanup();
	206	return 0;
	207	}
	208
c2ec75c2	209	static __refdata struct usb_composite_driver ncm_driver = {
6c34d288 YK	210	.name = "g_ncm",
	211	.dev = &device_desc,
	212	.strings = dev_strings,
35a0e0bf	213	.max_speed = USB_SPEED_HIGH,
03e42bd5	214	.bind = gncm_bind,
6c34d288 YK	215	.unbind = __exit_p(gncm_unbind),
	216	};
	217
	218	MODULE_DESCRIPTION(DRIVER_DESC);
	219	MODULE_AUTHOR("Yauheni Kaliuta");
	220	MODULE_LICENSE("GPL");
	221
	222	static int __init init(void)
	223	{
03e42bd5	224	return usb_composite_probe(&ncm_driver);
6c34d288 YK	225	}
	226	module_init(init);
	227
	228	static void __exit cleanup(void)
	229	{
	230	usb_composite_unregister(&ncm_driver);
	231	}
	232	module_exit(cleanup);