[mirror_ubuntu-artful-kernel.git] / drivers / usb / gadget / legacy / mass_storage.c

/*
 * mass_storage.c -- Mass Storage USB Gadget
 *
 * Copyright (C) 2003-2008 Alan Stern
 * Copyright (C) 2009 Samsung Electronics
 *                    Author: Michal Nazarewicz <mina86@mina86.com>
 * All rights reserved.
 *
 * 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.
 */


/*
 * The Mass Storage Gadget acts as a USB Mass Storage device,
 * appearing to the host as a disk drive or as a CD-ROM drive.  In
 * addition to providing an example of a genuinely useful gadget
 * driver for a USB device, it also illustrates a technique of
 * double-buffering for increased throughput.  Last but not least, it
 * gives an easy way to probe the behavior of the Mass Storage drivers
 * in a USB host.
 *
 * Since this file serves only administrative purposes and all the
 * business logic is implemented in f_mass_storage.* file.  Read
 * comments in this file for more detailed description.
 */


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

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

#define DRIVER_DESC		"Mass Storage Gadget"
#define DRIVER_VERSION		"2009/09/11"

/*
 * Thanks to NetChip Technologies for donating this product ID.
 *
 * DO NOT REUSE THESE IDs with any other driver!!  Ever!!
 * Instead:  allocate your own, using normal USB-IF procedures.
 */
#define FSG_VENDOR_ID	0x0525	/* NetChip */
#define FSG_PRODUCT_ID	0xa4a5	/* Linux-USB File-backed Storage Gadget */

#include "f_mass_storage.h"

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

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

	.bcdUSB =		cpu_to_le16(0x0200),
	.bDeviceClass =		USB_CLASS_PER_INTERFACE,

	/* Vendor and product id can be overridden by module parameters.  */
	.idVendor =		cpu_to_le16(FSG_VENDOR_ID),
	.idProduct =		cpu_to_le16(FSG_PRODUCT_ID),
	.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,
};

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_instance *fi_msg;
static struct usb_function *f_msg;

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

static struct fsg_module_parameters 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 */, mod_data);

static unsigned long msg_registered;
static void msg_cleanup(void);

static int msg_thread_exits(struct fsg_common *common)
{
	msg_cleanup();
	return 0;
}

static int msg_do_config(struct usb_configuration *c)
{
	struct fsg_opts *opts;
	int ret;

	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_msg = usb_get_function(fi_msg);
	if (IS_ERR(f_msg))
		return PTR_ERR(f_msg);

	ret = fsg_common_run_thread(opts->common);
	if (ret)
		goto put_func;

	ret = usb_add_function(c, f_msg);
	if (ret)
		goto put_func;

	return 0;

put_func:
	usb_put_function(f_msg);
	return ret;
}

static struct usb_configuration msg_config_driver = {
	.label			= "Linux File-Backed Storage",
	.bConfigurationValue	= 1,
	.bmAttributes		= USB_CONFIG_ATT_SELFPOWER,
};


/****************************** Gadget Bind ******************************/

static int msg_bind(struct usb_composite_dev *cdev)
{
	static const struct fsg_operations ops = {
		.thread_exits = msg_thread_exits,
	};
	struct fsg_opts *opts;
	struct fsg_config config;
	int status;

	fi_msg = usb_get_function_instance("mass_storage");
	if (IS_ERR(fi_msg))
		return PTR_ERR(fi_msg);

	fsg_config_from_params(&config, &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;

	fsg_common_set_ops(opts->common, &ops);

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

	status = usb_string_ids_tab(cdev, strings_dev);
	if (status < 0)
		goto fail_string_ids;
	msg_device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;

	status = usb_add_config(cdev, &msg_config_driver, msg_do_config);
	if (status < 0)
		goto fail_string_ids;

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

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);
	return status;
}

static int msg_unbind(struct usb_composite_dev *cdev)
{
	if (!IS_ERR(f_msg))
		usb_put_function(f_msg);

	if (!IS_ERR(fi_msg))
		usb_put_function_instance(fi_msg);

	return 0;
}

/****************************** Some noise ******************************/

static struct usb_composite_driver msg_driver = {
	.name		= "g_mass_storage",
	.dev		= &msg_device_desc,
	.max_speed	= USB_SPEED_SUPER,
	.needs_serial	= 1,
	.strings	= dev_strings,
	.bind		= msg_bind,
	.unbind		= msg_unbind,
};

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("Michal Nazarewicz");
MODULE_LICENSE("GPL");

static int __init msg_init(void)
{
	return usb_composite_probe(&msg_driver);
}
module_init(msg_init);

static void msg_cleanup(void)
{
	if (test_and_clear_bit(0, &msg_registered))
		usb_composite_unregister(&msg_driver);
}
module_exit(msg_cleanup);
Commit	Line	Data
d23b0f08	1	/*
d26a6aa0	2	* mass_storage.c -- Mass Storage USB Gadget
d23b0f08 MN	3	*
d23b0f08 MN	4	* Copyright (C) 2003-2008 Alan Stern
d23b0f08	5	* Copyright (C) 2009 Samsung Electronics
54b8360f	6	* Author: Michal Nazarewicz <mina86@mina86.com>
d26a6aa0	7	* All rights reserved.
d23b0f08 MN	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
d23b0f08 MN	13	*/
	14
	15
	16	/*
	17	* The Mass Storage Gadget acts as a USB Mass Storage device,
	18	* appearing to the host as a disk drive or as a CD-ROM drive. In
	19	* addition to providing an example of a genuinely useful gadget
	20	* driver for a USB device, it also illustrates a technique of
	21	* double-buffering for increased throughput. Last but not least, it
	22	* gives an easy way to probe the behavior of the Mass Storage drivers
	23	* in a USB host.
	24	*
	25	* Since this file serves only administrative purposes and all the
	26	* business logic is implemented in f_mass_storage.* file. Read
	27	* comments in this file for more detailed description.
	28	*/
	29
	30
	31	#include <linux/kernel.h>
d23b0f08	32	#include <linux/usb/ch9.h>
721e2e91	33	#include <linux/module.h>
d23b0f08	34
d23b0f08 MN	35	/-------------------------------------------------------------------------/
	36
	37	#define DRIVER_DESC "Mass Storage Gadget"
d26a6aa0	38	#define DRIVER_VERSION "2009/09/11"
d23b0f08	39
6fdc5dd2 AP	40	/*
	41	* Thanks to NetChip Technologies for donating this product ID.
	42	*
	43	* DO NOT REUSE THESE IDs with any other driver!! Ever!!
	44	* Instead: allocate your own, using normal USB-IF procedures.
	45	*/
	46	#define FSG_VENDOR_ID 0x0525 /* NetChip */
	47	#define FSG_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
	48
2412fbf1	49	#include "f_mass_storage.h"
d23b0f08 MN	50
d23b0f08 MN	51	/-------------------------------------------------------------------------/
7d16e8d3	52	USB_GADGET_COMPOSITE_OPTIONS();
d23b0f08 MN	53
	54	static struct usb_device_descriptor msg_device_desc = {
	55	.bLength = sizeof msg_device_desc,
	56	.bDescriptorType = USB_DT_DEVICE,
	57
	58	.bcdUSB = cpu_to_le16(0x0200),
	59	.bDeviceClass = USB_CLASS_PER_INTERFACE,
	60
	61	/* Vendor and product id can be overridden by module parameters. */
	62	.idVendor = cpu_to_le16(FSG_VENDOR_ID),
	63	.idProduct = cpu_to_le16(FSG_PRODUCT_ID),
d23b0f08 MN	64	.bNumConfigurations = 1,
	65	};
	66
	67	static struct usb_otg_descriptor otg_descriptor = {
	68	.bLength = sizeof otg_descriptor,
	69	.bDescriptorType = USB_DT_OTG,
	70
7c2b61d0 MN	71	/*
7c2b61d0 MN	72	* REVISIT SRP-only hardware is possible, although
d23b0f08 MN	73	* it would not be called "OTG" ...
	74	*/
	75	.bmAttributes = USB_OTG_SRP \| USB_OTG_HNP,
	76	};
	77
	78	static const struct usb_descriptor_header *otg_desc[] = {
	79	(struct usb_descriptor_header *) &otg_descriptor,
	80	NULL,
	81	};
	82
1cf0d264 SAS	83	static struct usb_string strings_dev[] = {
1cf0d264 SAS	84	[USB_GADGET_MANUFACTURER_IDX].s = "",
d33f74fc	85	[USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
1cf0d264 SAS	86	[USB_GADGET_SERIAL_IDX].s = "",
	87	{ } /* end of list */
	88	};
	89
	90	static struct usb_gadget_strings stringtab_dev = {
	91	.language = 0x0409, /* en-us */
	92	.strings = strings_dev,
	93	};
	94
	95	static struct usb_gadget_strings *dev_strings[] = {
	96	&stringtab_dev,
	97	NULL,
	98	};
d23b0f08	99
2412fbf1 AP	100	static struct usb_function_instance *fi_msg;
	101	static struct usb_function *f_msg;
	102
d23b0f08 MN	103	/**************************** Configurations ****************************/
d23b0f08 MN	104
481e4929 MN	105	static struct fsg_module_parameters mod_data = {
	106	.stall = 1
	107	};
6fdc5dd2 AP	108	#ifdef CONFIG_USB_GADGET_DEBUG_FILES
	109
	110	static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
	111
	112	#else
	113
	114	/*
	115	* Number of buffers we will use.
	116	* 2 is usually enough for good buffering pipeline
	117	*/
	118	#define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
	119
	120	#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
	121
481e4929 MN	122	FSG_MODULE_PARAMETERS(/* no prefix */, mod_data);
481e4929 MN	123
b73af61e	124	static unsigned long msg_registered;
c85efcb9 MN	125	static void msg_cleanup(void);
c85efcb9 MN	126
7f1ee826 MN	127	static int msg_thread_exits(struct fsg_common *common)
	128	{
	129	msg_cleanup();
	130	return 0;
	131	}
	132
c94e289f	133	static int msg_do_config(struct usb_configuration *c)
d23b0f08	134	{
2412fbf1	135	struct fsg_opts *opts;
d23b0f08 MN	136	int ret;
	137
	138	if (gadget_is_otg(c->cdev->gadget)) {
	139	c->descriptors = otg_desc;
	140	c->bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
	141	}
	142
2412fbf1 AP	143	opts = fsg_opts_from_func_inst(fi_msg);
	144
	145	f_msg = usb_get_function(fi_msg);
	146	if (IS_ERR(f_msg))
	147	return PTR_ERR(f_msg);
d23b0f08	148
2412fbf1 AP	149	ret = fsg_common_run_thread(opts->common);
	150	if (ret)
	151	goto put_func;
26eca10e	152
2412fbf1 AP	153	ret = usb_add_function(c, f_msg);
	154	if (ret)
	155	goto put_func;
	156
	157	return 0;
	158
	159	put_func:
	160	usb_put_function(f_msg);
d23b0f08 MN	161	return ret;
	162	}
	163
	164	static struct usb_configuration msg_config_driver = {
	165	.label = "Linux File-Backed Storage",
d23b0f08	166	.bConfigurationValue = 1,
d23b0f08 MN	167	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
	168	};
	169
	170
d23b0f08 MN	171	/**************************** Gadget Bind ****************************/
d23b0f08 MN	172
c94e289f	173	static int msg_bind(struct usb_composite_dev *cdev)
d23b0f08	174	{
2412fbf1 AP	175	static const struct fsg_operations ops = {
	176	.thread_exits = msg_thread_exits,
	177	};
	178	struct fsg_opts *opts;
	179	struct fsg_config config;
d23b0f08 MN	180	int status;
d23b0f08 MN	181
2412fbf1 AP	182	fi_msg = usb_get_function_instance("mass_storage");
	183	if (IS_ERR(fi_msg))
	184	return PTR_ERR(fi_msg);
	185
	186	fsg_config_from_params(&config, &mod_data, fsg_num_buffers);
	187	opts = fsg_opts_from_func_inst(fi_msg);
	188
	189	opts->no_configfs = true;
	190	status = fsg_common_set_num_buffers(opts->common, fsg_num_buffers);
	191	if (status)
	192	goto fail;
	193
	194	status = fsg_common_set_nluns(opts->common, config.nluns);
	195	if (status)
	196	goto fail_set_nluns;
	197
	198	fsg_common_set_ops(opts->common, &ops);
	199
	200	status = fsg_common_set_cdev(opts->common, cdev, config.can_stall);
	201	if (status)
	202	goto fail_set_cdev;
	203
	204	fsg_common_set_sysfs(opts->common, true);
	205	status = fsg_common_create_luns(opts->common, &config);
	206	if (status)
	207	goto fail_set_cdev;
	208
	209	fsg_common_set_inquiry_string(opts->common, config.vendor_name,
	210	config.product_name);
	211
1cf0d264 SAS	212	status = usb_string_ids_tab(cdev, strings_dev);
1cf0d264 SAS	213	if (status < 0)
2412fbf1	214	goto fail_string_ids;
d33f74fc	215	msg_device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
1cf0d264	216
c9bfff9c	217	status = usb_add_config(cdev, &msg_config_driver, msg_do_config);
d23b0f08	218	if (status < 0)
2412fbf1 AP	219	goto fail_string_ids;
2412fbf1 AP	220
7d16e8d3	221	usb_composite_overwrite_options(cdev, &coverwrite);
7c2b61d0 MN	222	dev_info(&cdev->gadget->dev,
7c2b61d0 MN	223	DRIVER_DESC ", version: " DRIVER_VERSION "\n");
c85efcb9	224	set_bit(0, &msg_registered);
d23b0f08	225	return 0;
2412fbf1 AP	226
	227	fail_string_ids:
	228	fsg_common_remove_luns(opts->common);
	229	fail_set_cdev:
	230	fsg_common_free_luns(opts->common);
	231	fail_set_nluns:
	232	fsg_common_free_buffers(opts->common);
	233	fail:
	234	usb_put_function_instance(fi_msg);
	235	return status;
d23b0f08 MN	236	}
d23b0f08 MN	237
2412fbf1 AP	238	static int msg_unbind(struct usb_composite_dev *cdev)
	239	{
	240	if (!IS_ERR(f_msg))
	241	usb_put_function(f_msg);
	242
	243	if (!IS_ERR(fi_msg))
	244	usb_put_function_instance(fi_msg);
	245
	246	return 0;
	247	}
d23b0f08 MN	248
	249	/**************************** Some noise ****************************/
	250
c94e289f	251	static struct usb_composite_driver msg_driver = {
d23b0f08 MN	252	.name = "g_mass_storage",
d23b0f08 MN	253	.dev = &msg_device_desc,
4bb99b7c	254	.max_speed = USB_SPEED_SUPER,
7c2b61d0	255	.needs_serial = 1,
1cf0d264	256	.strings = dev_strings,
03e42bd5	257	.bind = msg_bind,
2412fbf1	258	.unbind = msg_unbind,
d23b0f08 MN	259	};
	260
	261	MODULE_DESCRIPTION(DRIVER_DESC);
	262	MODULE_AUTHOR("Michal Nazarewicz");
	263	MODULE_LICENSE("GPL");
	264
	265	static int __init msg_init(void)
	266	{
03e42bd5	267	return usb_composite_probe(&msg_driver);
d23b0f08 MN	268	}
	269	module_init(msg_init);
	270
c85efcb9	271	static void msg_cleanup(void)
d23b0f08	272	{
c85efcb9 MN	273	if (test_and_clear_bit(0, &msg_registered))
c85efcb9 MN	274	usb_composite_unregister(&msg_driver);
d23b0f08 MN	275	}
d23b0f08 MN	276	module_exit(msg_cleanup);