[deliverable/linux.git] / drivers / usb / gadget / legacy / acm_ms.c

/*
 * acm_ms.c -- Composite driver, with ACM and mass storage support
 *
 * Copyright (C) 2008 David Brownell
 * Copyright (C) 2008 Nokia Corporation
 * Author: David Brownell
 * Modified: Klaus Schwarzkopf <schwarzkopf@sensortherm.de>
 *
 * Heavily based on multi.c and cdc2.c
 *
 * 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_serial.h"

#define DRIVER_DESC		"Composite Gadget (ACM + MS)"
#define DRIVER_VERSION		"2011/10/10"

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

/*
 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
 * Instead:  allocate your own, using normal USB-IF procedures.
 */
#define ACM_MS_VENDOR_NUM	0x1d6b	/* Linux Foundation */
#define ACM_MS_PRODUCT_NUM	0x0106	/* Composite Gadget: ACM + MS*/

#include "f_mass_storage.h"

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

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

	.bcdUSB =		cpu_to_le16(0x0200),

	.bDeviceClass =		USB_CLASS_MISC /* 0xEF */,
	.bDeviceSubClass =	2,
	.bDeviceProtocol =	1,

	/* .bMaxPacketSize0 = f(hardware) */

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

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,
};

/****************************** Configurations ******************************/

static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
#ifdef CONFIG_USB_GADGET_DEBUG_FILES

static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;

#else

/*
 * Number of buffers we will use.
 * 2 is usually enough for good buffering pipeline
 */
#define fsg_num_buffers	CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS

#endif /* CONFIG_USB_GADGET_DEBUG_FILES */

FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);

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

static struct usb_function_instance *fi_msg;
static struct usb_function *f_msg;

/*
 * We _always_ have both ACM and mass storage functions.
 */
static int acm_ms_do_config(struct usb_configuration *c)
{
	struct fsg_opts *opts;
	int	status;

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

	opts = fsg_opts_from_func_inst(fi_msg);

	f_acm = usb_get_function(f_acm_inst);
	if (IS_ERR(f_acm))
		return PTR_ERR(f_acm);

	f_msg = usb_get_function(fi_msg);
	if (IS_ERR(f_msg)) {
		status = PTR_ERR(f_msg);
		goto put_acm;
	}

	status = usb_add_function(c, f_acm);
	if (status < 0)
		goto put_msg;

	status = fsg_common_run_thread(opts->common);
	if (status)
		goto remove_acm;

	status = usb_add_function(c, f_msg);
	if (status)
		goto remove_acm;

	return 0;
remove_acm:
	usb_remove_function(c, f_acm);
put_msg:
	usb_put_function(f_msg);
put_acm:
	usb_put_function(f_acm);
	return status;
}

static struct usb_configuration acm_ms_config_driver = {
	.label			= DRIVER_DESC,
	.bConfigurationValue	= 1,
	/* .iConfiguration = DYNAMIC */
	.bmAttributes		= USB_CONFIG_ATT_SELFPOWER,
};

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

static int acm_ms_bind(struct usb_composite_dev *cdev)
{
	struct usb_gadget	*gadget = cdev->gadget;
	struct fsg_opts		*opts;
	struct fsg_config	config;
	int			status;

	f_acm_inst = usb_get_function_instance("acm");
	if (IS_ERR(f_acm_inst))
		return PTR_ERR(f_acm_inst);

	fi_msg = usb_get_function_instance("mass_storage");
	if (IS_ERR(fi_msg)) {
		status = PTR_ERR(fi_msg);
		goto fail_get_msg;
	}

	/* set up mass storage function */
	fsg_config_from_params(&config, &fsg_mod_data, fsg_num_buffers);
	opts = fsg_opts_from_func_inst(fi_msg);

	opts->no_configfs = true;
	status = fsg_common_set_num_buffers(opts->common, fsg_num_buffers);
	if (status)
		goto fail;

	status = fsg_common_set_nluns(opts->common, config.nluns);
	if (status)
		goto fail_set_nluns;

	status = fsg_common_set_cdev(opts->common, cdev, config.can_stall);
	if (status)
		goto fail_set_cdev;

	fsg_common_set_sysfs(opts->common, true);
	status = fsg_common_create_luns(opts->common, &config);
	if (status)
		goto fail_set_cdev;

	fsg_common_set_inquiry_string(opts->common, config.vendor_name,
				      config.product_name);
	/*
	 * 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 fail_string_ids;
	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, &acm_ms_config_driver, acm_ms_do_config);
	if (status < 0)
		goto fail_string_ids;

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

	/* error recovery */
fail_string_ids:
	fsg_common_remove_luns(opts->common);
fail_set_cdev:
	fsg_common_free_luns(opts->common);
fail_set_nluns:
	fsg_common_free_buffers(opts->common);
fail:
	usb_put_function_instance(fi_msg);
fail_get_msg:
	usb_put_function_instance(f_acm_inst);
	return status;
}

static int acm_ms_unbind(struct usb_composite_dev *cdev)
{
	usb_put_function(f_msg);
	usb_put_function_instance(fi_msg);
	usb_put_function(f_acm);
	usb_put_function_instance(f_acm_inst);
	return 0;
}

static struct usb_composite_driver acm_ms_driver = {
	.name		= "g_acm_ms",
	.dev		= &device_desc,
	.max_speed	= USB_SPEED_SUPER,
	.strings	= dev_strings,
	.bind		= acm_ms_bind,
	.unbind		= acm_ms_unbind,
};

module_usb_composite_driver(acm_ms_driver);

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("Klaus Schwarzkopf <schwarzkopf@sensortherm.de>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
fa3ae0c1 KS	1	/*
	2	* acm_ms.c -- Composite driver, with ACM and mass storage support
	3	*
	4	* Copyright (C) 2008 David Brownell
	5	* Copyright (C) 2008 Nokia Corporation
	6	* Author: David Brownell
	7	* Modified: Klaus Schwarzkopf <schwarzkopf@sensortherm.de>
	8	*
	9	* Heavily based on multi.c and cdc2.c
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2 of the License, or
	14	* (at your option) any later version.
	15	*/
	16
	17	#include <linux/kernel.h>
721e2e91	18	#include <linux/module.h>
fa3ae0c1 KS	19
	20	#include "u_serial.h"
	21
	22	#define DRIVER_DESC "Composite Gadget (ACM + MS)"
	23	#define DRIVER_VERSION "2011/10/10"
	24
	25	/-------------------------------------------------------------------------/
	26
	27	/*
	28	* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
	29	* Instead: allocate your own, using normal USB-IF procedures.
	30	*/
	31	#define ACM_MS_VENDOR_NUM 0x1d6b /* Linux Foundation */
	32	#define ACM_MS_PRODUCT_NUM 0x0106 /* Composite Gadget: ACM + MS*/
	33
e6c661ef	34	#include "f_mass_storage.h"
fa3ae0c1 KS	35
fa3ae0c1 KS	36	/-------------------------------------------------------------------------/
7d16e8d3	37	USB_GADGET_COMPOSITE_OPTIONS();
fa3ae0c1 KS	38
	39	static struct usb_device_descriptor device_desc = {
	40	.bLength = sizeof device_desc,
	41	.bDescriptorType = USB_DT_DEVICE,
	42
	43	.bcdUSB = cpu_to_le16(0x0200),
	44
	45	.bDeviceClass = USB_CLASS_MISC /* 0xEF */,
	46	.bDeviceSubClass = 2,
	47	.bDeviceProtocol = 1,
	48
	49	/* .bMaxPacketSize0 = f(hardware) */
	50
	51	/* Vendor and product id can be overridden by module parameters. */
	52	.idVendor = cpu_to_le16(ACM_MS_VENDOR_NUM),
	53	.idProduct = cpu_to_le16(ACM_MS_PRODUCT_NUM),
	54	/* .bcdDevice = f(hardware) */
	55	/* .iManufacturer = DYNAMIC */
	56	/* .iProduct = DYNAMIC */
	57	/* NO SERIAL NUMBER */
	58	/.bNumConfigurations = DYNAMIC/
	59	};
	60
	61	static struct usb_otg_descriptor otg_descriptor = {
	62	.bLength = sizeof otg_descriptor,
	63	.bDescriptorType = USB_DT_OTG,
	64
	65	/*
	66	* REVISIT SRP-only hardware is possible, although
	67	* it would not be called "OTG" ...
	68	*/
	69	.bmAttributes = USB_OTG_SRP \| USB_OTG_HNP,
	70	};
	71
	72	static const struct usb_descriptor_header *otg_desc[] = {
	73	(struct usb_descriptor_header *) &otg_descriptor,
	74	NULL,
	75	};
	76
fa3ae0c1	77	/* string IDs are assigned dynamically */
fa3ae0c1	78	static struct usb_string strings_dev[] = {
cc2683c3	79	[USB_GADGET_MANUFACTURER_IDX].s = "",
276e2e4f SAS	80	[USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
276e2e4f SAS	81	[USB_GADGET_SERIAL_IDX].s = "",
fa3ae0c1 KS	82	{ } /* end of list */
	83	};
	84
	85	static struct usb_gadget_strings stringtab_dev = {
	86	.language = 0x0409, /* en-us */
	87	.strings = strings_dev,
	88	};
	89
	90	static struct usb_gadget_strings *dev_strings[] = {
	91	&stringtab_dev,
	92	NULL,
	93	};
	94
	95	/**************************** Configurations ****************************/
	96
	97	static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
6fdc5dd2 AP	98	#ifdef CONFIG_USB_GADGET_DEBUG_FILES
	99
	100	static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
	101
	102	#else
	103
	104	/*
	105	* Number of buffers we will use.
	106	* 2 is usually enough for good buffering pipeline
	107	*/
	108	#define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
	109
0c8b1992	110	#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
6fdc5dd2	111
fa3ae0c1 KS	112	FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
fa3ae0c1 KS	113
fa3ae0c1	114	/-------------------------------------------------------------------------/
5f72bbfd SAS	115	static struct usb_function *f_acm;
5f72bbfd SAS	116	static struct usb_function_instance *f_acm_inst;
e6c661ef AP	117
	118	static struct usb_function_instance *fi_msg;
	119	static struct usb_function *f_msg;
	120
fa3ae0c1 KS	121	/*
	122	* We _always_ have both ACM and mass storage functions.
	123	*/
c94e289f	124	static int acm_ms_do_config(struct usb_configuration *c)
fa3ae0c1	125	{
e6c661ef	126	struct fsg_opts *opts;
fa3ae0c1 KS	127	int status;
	128
	129	if (gadget_is_otg(c->cdev->gadget)) {
	130	c->descriptors = otg_desc;
	131	c->bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
	132	}
	133
e6c661ef	134	opts = fsg_opts_from_func_inst(fi_msg);
5f72bbfd	135
5f72bbfd	136	f_acm = usb_get_function(f_acm_inst);
e6c661ef AP	137	if (IS_ERR(f_acm))
	138	return PTR_ERR(f_acm);
	139
	140	f_msg = usb_get_function(fi_msg);
	141	if (IS_ERR(f_msg)) {
	142	status = PTR_ERR(f_msg);
	143	goto put_acm;
5f72bbfd	144	}
fa3ae0c1	145
5f72bbfd	146	status = usb_add_function(c, f_acm);
fa3ae0c1	147	if (status < 0)
e6c661ef	148	goto put_msg;
fa3ae0c1	149
e6c661ef AP	150	status = fsg_common_run_thread(opts->common);
	151	if (status)
	152	goto remove_acm;
	153
	154	status = usb_add_function(c, f_msg);
	155	if (status)
	156	goto remove_acm;
fa3ae0c1 KS	157
fa3ae0c1 KS	158	return 0;
e6c661ef	159	remove_acm:
5f72bbfd	160	usb_remove_function(c, f_acm);
e6c661ef AP	161	put_msg:
	162	usb_put_function(f_msg);
	163	put_acm:
5f72bbfd	164	usb_put_function(f_acm);
5f72bbfd	165	return status;
fa3ae0c1 KS	166	}
	167
	168	static struct usb_configuration acm_ms_config_driver = {
	169	.label = DRIVER_DESC,
	170	.bConfigurationValue = 1,
	171	/* .iConfiguration = DYNAMIC */
	172	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
	173	};
	174
	175	/-------------------------------------------------------------------------/
	176
c94e289f	177	static int acm_ms_bind(struct usb_composite_dev *cdev)
fa3ae0c1	178	{
fa3ae0c1	179	struct usb_gadget *gadget = cdev->gadget;
e6c661ef AP	180	struct fsg_opts *opts;
e6c661ef AP	181	struct fsg_config config;
fa3ae0c1	182	int status;
fa3ae0c1	183
e6c661ef AP	184	f_acm_inst = usb_get_function_instance("acm");
	185	if (IS_ERR(f_acm_inst))
	186	return PTR_ERR(f_acm_inst);
	187
	188	fi_msg = usb_get_function_instance("mass_storage");
	189	if (IS_ERR(fi_msg)) {
	190	status = PTR_ERR(fi_msg);
	191	goto fail_get_msg;
fa3ae0c1 KS	192	}
fa3ae0c1 KS	193
e6c661ef AP	194	/* set up mass storage function */
	195	fsg_config_from_params(&config, &fsg_mod_data, fsg_num_buffers);
	196	opts = fsg_opts_from_func_inst(fi_msg);
	197
	198	opts->no_configfs = true;
	199	status = fsg_common_set_num_buffers(opts->common, fsg_num_buffers);
	200	if (status)
	201	goto fail;
	202
	203	status = fsg_common_set_nluns(opts->common, config.nluns);
	204	if (status)
	205	goto fail_set_nluns;
	206
	207	status = fsg_common_set_cdev(opts->common, cdev, config.can_stall);
	208	if (status)
	209	goto fail_set_cdev;
	210
	211	fsg_common_set_sysfs(opts->common, true);
	212	status = fsg_common_create_luns(opts->common, &config);
	213	if (status)
	214	goto fail_set_cdev;
	215
	216	fsg_common_set_inquiry_string(opts->common, config.vendor_name,
	217	config.product_name);
fa3ae0c1 KS	218	/*
	219	* Allocate string descriptor numbers ... note that string
	220	* contents can be overridden by the composite_dev glue.
	221	*/
e1f15ccb	222	status = usb_string_ids_tab(cdev, strings_dev);
fa3ae0c1	223	if (status < 0)
e6c661ef	224	goto fail_string_ids;
276e2e4f SAS	225	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
276e2e4f SAS	226	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
fa3ae0c1 KS	227
	228	/* register our configuration */
	229	status = usb_add_config(cdev, &acm_ms_config_driver, acm_ms_do_config);
	230	if (status < 0)
e6c661ef	231	goto fail_string_ids;
fa3ae0c1	232
7d16e8d3	233	usb_composite_overwrite_options(cdev, &coverwrite);
fa3ae0c1 KS	234	dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
fa3ae0c1 KS	235	DRIVER_DESC);
fa3ae0c1 KS	236	return 0;
	237
	238	/* error recovery */
e6c661ef AP	239	fail_string_ids:
	240	fsg_common_remove_luns(opts->common);
	241	fail_set_cdev:
	242	fsg_common_free_luns(opts->common);
	243	fail_set_nluns:
	244	fsg_common_free_buffers(opts->common);
	245	fail:
	246	usb_put_function_instance(fi_msg);
	247	fail_get_msg:
	248	usb_put_function_instance(f_acm_inst);
fa3ae0c1 KS	249	return status;
	250	}
	251
c94e289f	252	static int acm_ms_unbind(struct usb_composite_dev *cdev)
fa3ae0c1	253	{
e6c661ef AP	254	usb_put_function(f_msg);
e6c661ef AP	255	usb_put_function_instance(fi_msg);
5f72bbfd SAS	256	usb_put_function(f_acm);
5f72bbfd SAS	257	usb_put_function_instance(f_acm_inst);
fa3ae0c1 KS	258	return 0;
	259	}
	260
c94e289f	261	static struct usb_composite_driver acm_ms_driver = {
fa3ae0c1 KS	262	.name = "g_acm_ms",
fa3ae0c1 KS	263	.dev = &device_desc,
6f47209b	264	.max_speed = USB_SPEED_SUPER,
fa3ae0c1	265	.strings = dev_strings,
03e42bd5	266	.bind = acm_ms_bind,
c94e289f	267	.unbind = acm_ms_unbind,
fa3ae0c1 KS	268	};
fa3ae0c1 KS	269
909346a8 TK	270	module_usb_composite_driver(acm_ms_driver);
909346a8 TK	271
fa3ae0c1 KS	272	MODULE_DESCRIPTION(DRIVER_DESC);
	273	MODULE_AUTHOR("Klaus Schwarzkopf <schwarzkopf@sensortherm.de>");
	274	MODULE_LICENSE("GPL v2");