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

/*
 * nokia.c -- Nokia Composite Gadget Driver
 *
 * Copyright (C) 2008-2010 Nokia Corporation
 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
 *
 * This gadget driver borrows from serial.c which is:
 *
 * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
 * Copyright (C) 2008 by David Brownell
 * Copyright (C) 2008 by Nokia Corporation
 *
 * This software is distributed under the terms of the GNU General
 * Public License ("GPL") as published by the Free Software Foundation,
 * version 2 of that License.
 */

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

#include "u_serial.h"
#include "u_ether.h"
#include "u_phonet.h"
#include "gadget_chips.h"

/* Defines */

#define NOKIA_VERSION_NUM		0x0211
#define NOKIA_LONG_NAME			"N900 (PC-Suite Mode)"

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

/*
 * 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.
 */
#define USB_FACM_INCLUDED
#include "f_acm.c"
#include "f_ecm.c"
#include "f_obex.c"
#include "f_serial.c"
#include "f_phonet.c"
#include "u_ether.c"

/*-------------------------------------------------------------------------*/
USB_GADGET_COMPOSITE_OPTIONS();

#define NOKIA_VENDOR_ID			0x0421	/* Nokia */
#define NOKIA_PRODUCT_ID		0x01c8	/* Nokia Gadget */

/* string IDs are assigned dynamically */

#define STRING_DESCRIPTION_IDX		USB_GADGET_FIRST_AVAIL_IDX

static char manufacturer_nokia[] = "Nokia";
static const char product_nokia[] = NOKIA_LONG_NAME;
static const char description_nokia[] = "PC-Suite Configuration";

static struct usb_string strings_dev[] = {
	[USB_GADGET_MANUFACTURER_IDX].s = manufacturer_nokia,
	[USB_GADGET_PRODUCT_IDX].s = NOKIA_LONG_NAME,
	[USB_GADGET_SERIAL_IDX].s = "",
	[STRING_DESCRIPTION_IDX].s = description_nokia,
	{  } /* 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_device_descriptor device_desc = {
	.bLength		= USB_DT_DEVICE_SIZE,
	.bDescriptorType	= USB_DT_DEVICE,
	.bcdUSB			= __constant_cpu_to_le16(0x0200),
	.bDeviceClass		= USB_CLASS_COMM,
	.idVendor		= __constant_cpu_to_le16(NOKIA_VENDOR_ID),
	.idProduct		= __constant_cpu_to_le16(NOKIA_PRODUCT_ID),
	.bcdDevice		= cpu_to_le16(NOKIA_VERSION_NUM),
	/* .iManufacturer = DYNAMIC */
	/* .iProduct = DYNAMIC */
	.bNumConfigurations =	1,
};

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

/* Module */
MODULE_DESCRIPTION("Nokia composite gadget driver for N900");
MODULE_AUTHOR("Felipe Balbi");
MODULE_LICENSE("GPL");

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

static u8 hostaddr[ETH_ALEN];

enum {
	TTY_PORT_OBEX0,
	TTY_PORT_OBEX1,
	TTY_PORT_ACM,
	TTY_PORTS_MAX,
};

static unsigned char tty_lines[TTY_PORTS_MAX];

static int __init nokia_bind_config(struct usb_configuration *c)
{
	int status = 0;

	status = phonet_bind_config(c);
	if (status)
		printk(KERN_DEBUG "could not bind phonet config\n");

	status = obex_bind_config(c, tty_lines[TTY_PORT_OBEX0]);
	if (status)
		printk(KERN_DEBUG "could not bind obex config %d\n", 0);

	status = obex_bind_config(c, tty_lines[TTY_PORT_OBEX1]);
	if (status)
		printk(KERN_DEBUG "could not bind obex config %d\n", 0);

	status = acm_bind_config(c, tty_lines[TTY_PORT_ACM]);
	if (status)
		printk(KERN_DEBUG "could not bind acm config\n");

	status = ecm_bind_config(c, hostaddr);
	if (status)
		printk(KERN_DEBUG "could not bind ecm config\n");

	return status;
}

static struct usb_configuration nokia_config_500ma_driver = {
	.label		= "Bus Powered",
	.bConfigurationValue = 1,
	/* .iConfiguration = DYNAMIC */
	.bmAttributes	= USB_CONFIG_ATT_ONE,
	.MaxPower	= 500,
};

static struct usb_configuration nokia_config_100ma_driver = {
	.label		= "Self Powered",
	.bConfigurationValue = 2,
	/* .iConfiguration = DYNAMIC */
	.bmAttributes	= USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
	.MaxPower	= 100,
};

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

	status = gphonet_setup(cdev->gadget);
	if (status < 0)
		goto err_phonet;

	for (cur_line = 0; cur_line < TTY_PORTS_MAX; cur_line++) {
		status = gserial_alloc_line(&tty_lines[cur_line]);
		if (status)
			goto err_ether;
	}

	status = gether_setup(cdev->gadget, hostaddr);
	if (status < 0)
		goto err_ether;

	status = usb_string_ids_tab(cdev, strings_dev);
	if (status < 0)
		goto err_usb;
	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
	status = strings_dev[STRING_DESCRIPTION_IDX].id;
	nokia_config_500ma_driver.iConfiguration = status;
	nokia_config_100ma_driver.iConfiguration = status;

	if (!gadget_supports_altsettings(gadget))
		goto err_usb;

	/* finally register the configuration */
	status = usb_add_config(cdev, &nokia_config_500ma_driver,
			nokia_bind_config);
	if (status < 0)
		goto err_usb;

	status = usb_add_config(cdev, &nokia_config_100ma_driver,
			nokia_bind_config);
	if (status < 0)
		goto err_usb;

	usb_composite_overwrite_options(cdev, &coverwrite);
	dev_info(&gadget->dev, "%s\n", NOKIA_LONG_NAME);

	return 0;

err_usb:
	gether_cleanup();
err_ether:
	cur_line--;
	while (cur_line >= 0)
		gserial_free_line(tty_lines[cur_line--]);

	gphonet_cleanup();
err_phonet:
	return status;
}

static int __exit nokia_unbind(struct usb_composite_dev *cdev)
{
	int i;

	gphonet_cleanup();

	for (i = 0; i < TTY_PORTS_MAX; i++)
		gserial_free_line(tty_lines[i]);

	gether_cleanup();

	return 0;
}

static __refdata struct usb_composite_driver nokia_driver = {
	.name		= "g_nokia",
	.dev		= &device_desc,
	.strings	= dev_strings,
	.max_speed	= USB_SPEED_HIGH,
	.bind		= nokia_bind,
	.unbind		= __exit_p(nokia_unbind),
};

static int __init nokia_init(void)
{
	return usb_composite_probe(&nokia_driver);
}
module_init(nokia_init);

static void __exit nokia_cleanup(void)
{
	usb_composite_unregister(&nokia_driver);
}
module_exit(nokia_cleanup);
Commit	Line	Data
f358f5b4 FB	1	/*
	2	* nokia.c -- Nokia Composite Gadget Driver
	3	*
	4	* Copyright (C) 2008-2010 Nokia Corporation
	5	* Contact: Felipe Balbi <felipe.balbi@nokia.com>
	6	*
	7	* This gadget driver borrows from serial.c which is:
	8	*
	9	* Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
	10	* Copyright (C) 2008 by David Brownell
	11	* Copyright (C) 2008 by Nokia Corporation
	12	*
	13	* This software is distributed under the terms of the GNU General
	14	* Public License ("GPL") as published by the Free Software Foundation,
	15	* version 2 of that License.
	16	*/
	17
	18	#include <linux/kernel.h>
f358f5b4 FB	19	#include <linux/device.h>
	20
	21	#include "u_serial.h"
	22	#include "u_ether.h"
	23	#include "u_phonet.h"
	24	#include "gadget_chips.h"
	25
	26	/* Defines */
	27
	28	#define NOKIA_VERSION_NUM 0x0211
	29	#define NOKIA_LONG_NAME "N900 (PC-Suite Mode)"
	30
	31	/-------------------------------------------------------------------------/
	32
	33	/*
	34	* Kbuild is not very cooperative with respect to linking separately
	35	* compiled library objects into one module. So for now we won't use
	36	* separate compilation ... ensuring init/exit sections work to shrink
	37	* the runtime footprint, and giving us at least some parts of what
	38	* a "gcc --combine ... part1.c part2.c part3.c ... " build would.
	39	*/
ff47f594	40	#define USB_FACM_INCLUDED
f358f5b4 FB	41	#include "f_acm.c"
	42	#include "f_ecm.c"
	43	#include "f_obex.c"
	44	#include "f_serial.c"
	45	#include "f_phonet.c"
	46	#include "u_ether.c"
	47
	48	/-------------------------------------------------------------------------/
7d16e8d3	49	USB_GADGET_COMPOSITE_OPTIONS();
f358f5b4 FB	50
	51	#define NOKIA_VENDOR_ID 0x0421 /* Nokia */
	52	#define NOKIA_PRODUCT_ID 0x01c8 /* Nokia Gadget */
	53
	54	/* string IDs are assigned dynamically */
	55
276e2e4f	56	#define STRING_DESCRIPTION_IDX USB_GADGET_FIRST_AVAIL_IDX
f358f5b4 FB	57
	58	static char manufacturer_nokia[] = "Nokia";
	59	static const char product_nokia[] = NOKIA_LONG_NAME;
	60	static const char description_nokia[] = "PC-Suite Configuration";
	61
	62	static struct usb_string strings_dev[] = {
276e2e4f SAS	63	[USB_GADGET_MANUFACTURER_IDX].s = manufacturer_nokia,
	64	[USB_GADGET_PRODUCT_IDX].s = NOKIA_LONG_NAME,
	65	[USB_GADGET_SERIAL_IDX].s = "",
f358f5b4 FB	66	[STRING_DESCRIPTION_IDX].s = description_nokia,
	67	{ } /* end of list */
	68	};
	69
	70	static struct usb_gadget_strings stringtab_dev = {
	71	.language = 0x0409, /* en-us */
	72	.strings = strings_dev,
	73	};
	74
	75	static struct usb_gadget_strings *dev_strings[] = {
	76	&stringtab_dev,
	77	NULL,
	78	};
	79
	80	static struct usb_device_descriptor device_desc = {
	81	.bLength = USB_DT_DEVICE_SIZE,
	82	.bDescriptorType = USB_DT_DEVICE,
	83	.bcdUSB = __constant_cpu_to_le16(0x0200),
	84	.bDeviceClass = USB_CLASS_COMM,
	85	.idVendor = __constant_cpu_to_le16(NOKIA_VENDOR_ID),
	86	.idProduct = __constant_cpu_to_le16(NOKIA_PRODUCT_ID),
ed9cbda6	87	.bcdDevice = cpu_to_le16(NOKIA_VERSION_NUM),
f358f5b4 FB	88	/* .iManufacturer = DYNAMIC */
	89	/* .iProduct = DYNAMIC */
	90	.bNumConfigurations = 1,
	91	};
	92
	93	/-------------------------------------------------------------------------/
	94
	95	/* Module */
	96	MODULE_DESCRIPTION("Nokia composite gadget driver for N900");
	97	MODULE_AUTHOR("Felipe Balbi");
	98	MODULE_LICENSE("GPL");
	99
	100	/-------------------------------------------------------------------------/
	101
	102	static u8 hostaddr[ETH_ALEN];
	103
19b10a88 SAS	104	enum {
	105	TTY_PORT_OBEX0,
	106	TTY_PORT_OBEX1,
	107	TTY_PORT_ACM,
	108	TTY_PORTS_MAX,
	109	};
	110
	111	static unsigned char tty_lines[TTY_PORTS_MAX];
	112
f358f5b4 FB	113	static int __init nokia_bind_config(struct usb_configuration *c)
	114	{
	115	int status = 0;
	116
	117	status = phonet_bind_config(c);
	118	if (status)
	119	printk(KERN_DEBUG "could not bind phonet config\n");
	120
19b10a88	121	status = obex_bind_config(c, tty_lines[TTY_PORT_OBEX0]);
f358f5b4 FB	122	if (status)
	123	printk(KERN_DEBUG "could not bind obex config %d\n", 0);
	124
19b10a88	125	status = obex_bind_config(c, tty_lines[TTY_PORT_OBEX1]);
f358f5b4 FB	126	if (status)
	127	printk(KERN_DEBUG "could not bind obex config %d\n", 0);
	128
19b10a88	129	status = acm_bind_config(c, tty_lines[TTY_PORT_ACM]);
f358f5b4 FB	130	if (status)
	131	printk(KERN_DEBUG "could not bind acm config\n");
	132
	133	status = ecm_bind_config(c, hostaddr);
	134	if (status)
	135	printk(KERN_DEBUG "could not bind ecm config\n");
	136
	137	return status;
	138	}
	139
	140	static struct usb_configuration nokia_config_500ma_driver = {
	141	.label = "Bus Powered",
f358f5b4 FB	142	.bConfigurationValue = 1,
	143	/* .iConfiguration = DYNAMIC */
	144	.bmAttributes = USB_CONFIG_ATT_ONE,
8f900a9a	145	.MaxPower = 500,
f358f5b4 FB	146	};
	147
	148	static struct usb_configuration nokia_config_100ma_driver = {
	149	.label = "Self Powered",
f358f5b4 FB	150	.bConfigurationValue = 2,
	151	/* .iConfiguration = DYNAMIC */
	152	.bmAttributes = USB_CONFIG_ATT_ONE \| USB_CONFIG_ATT_SELFPOWER,
8f900a9a	153	.MaxPower = 100,
f358f5b4 FB	154	};
	155
	156	static int __init nokia_bind(struct usb_composite_dev *cdev)
	157	{
f358f5b4 FB	158	struct usb_gadget *gadget = cdev->gadget;
f358f5b4 FB	159	int status;
19b10a88	160	int cur_line;
f358f5b4 FB	161
	162	status = gphonet_setup(cdev->gadget);
	163	if (status < 0)
	164	goto err_phonet;
	165
19b10a88 SAS	166	for (cur_line = 0; cur_line < TTY_PORTS_MAX; cur_line++) {
	167	status = gserial_alloc_line(&tty_lines[cur_line]);
	168	if (status)
	169	goto err_ether;
	170	}
f358f5b4 FB	171
	172	status = gether_setup(cdev->gadget, hostaddr);
	173	if (status < 0)
	174	goto err_ether;
	175
e1f15ccb	176	status = usb_string_ids_tab(cdev, strings_dev);
f358f5b4 FB	177	if (status < 0)
f358f5b4 FB	178	goto err_usb;
276e2e4f SAS	179	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
276e2e4f SAS	180	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
e1f15ccb	181	status = strings_dev[STRING_DESCRIPTION_IDX].id;
f358f5b4 FB	182	nokia_config_500ma_driver.iConfiguration = status;
	183	nokia_config_100ma_driver.iConfiguration = status;
	184
ed9cbda6	185	if (!gadget_supports_altsettings(gadget))
f358f5b4	186	goto err_usb;
f358f5b4	187
25985edc	188	/* finally register the configuration */
c9bfff9c UKK	189	status = usb_add_config(cdev, &nokia_config_500ma_driver,
c9bfff9c UKK	190	nokia_bind_config);
f358f5b4 FB	191	if (status < 0)
	192	goto err_usb;
	193
c9bfff9c UKK	194	status = usb_add_config(cdev, &nokia_config_100ma_driver,
c9bfff9c UKK	195	nokia_bind_config);
f358f5b4 FB	196	if (status < 0)
	197	goto err_usb;
	198
7d16e8d3	199	usb_composite_overwrite_options(cdev, &coverwrite);
f358f5b4 FB	200	dev_info(&gadget->dev, "%s\n", NOKIA_LONG_NAME);
	201
	202	return 0;
	203
	204	err_usb:
	205	gether_cleanup();
	206	err_ether:
19b10a88 SAS	207	cur_line--;
	208	while (cur_line >= 0)
	209	gserial_free_line(tty_lines[cur_line--]);
	210
f358f5b4 FB	211	gphonet_cleanup();
	212	err_phonet:
	213	return status;
	214	}
	215
	216	static int __exit nokia_unbind(struct usb_composite_dev *cdev)
	217	{
19b10a88 SAS	218	int i;
19b10a88 SAS	219
f358f5b4	220	gphonet_cleanup();
19b10a88 SAS	221
	222	for (i = 0; i < TTY_PORTS_MAX; i++)
	223	gserial_free_line(tty_lines[i]);
	224
f358f5b4 FB	225	gether_cleanup();
	226
	227	return 0;
	228	}
	229
c2ec75c2	230	static __refdata struct usb_composite_driver nokia_driver = {
f358f5b4 FB	231	.name = "g_nokia",
	232	.dev = &device_desc,
	233	.strings = dev_strings,
35a0e0bf	234	.max_speed = USB_SPEED_HIGH,
03e42bd5	235	.bind = nokia_bind,
f358f5b4 FB	236	.unbind = __exit_p(nokia_unbind),
	237	};
	238
	239	static int __init nokia_init(void)
	240	{
03e42bd5	241	return usb_composite_probe(&nokia_driver);
f358f5b4 FB	242	}
	243	module_init(nokia_init);
	244
	245	static void __exit nokia_cleanup(void)
	246	{
	247	usb_composite_unregister(&nokia_driver);
	248	}
	249	module_exit(nokia_cleanup);
	250