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

/*
 * zero.c -- Gadget Zero, for USB development
 *
 * Copyright (C) 2003-2008 David Brownell
 * Copyright (C) 2008 by 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.
 */

/*
 * Gadget Zero only needs two bulk endpoints, and is an example of how you
 * can write a hardware-agnostic gadget driver running inside a USB device.
 * Some hardware details are visible, but don't affect most of the driver.
 *
 * Use it with the Linux host/master side "usbtest" driver to get a basic
 * functional test of your device-side usb stack, or with "usb-skeleton".
 *
 * It supports two similar configurations.  One sinks whatever the usb host
 * writes, and in return sources zeroes.  The other loops whatever the host
 * writes back, so the host can read it.
 *
 * Many drivers will only have one configuration, letting them be much
 * simpler if they also don't support high speed operation (like this
 * driver does).
 *
 * Why is *this* driver using two configurations, rather than setting up
 * two interfaces with different functions?  To help verify that multiple
 * configuration infrastructure is working correctly; also, so that it can
 * work with low capability USB controllers without four bulk endpoints.
 */

/*
 * driver assumes self-powered hardware, and
 * has no way for users to trigger remote wakeup.
 */

/* #define VERBOSE_DEBUG */

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/device.h>
#include <linux/module.h>
#include <linux/err.h>
#include <linux/usb/composite.h>

#include "g_zero.h"
/*-------------------------------------------------------------------------*/
USB_GADGET_COMPOSITE_OPTIONS();

#define DRIVER_VERSION		"Cinco de Mayo 2008"

static const char longname[] = "Gadget Zero";

/*
 * Normally the "loopback" configuration is second (index 1) so
 * it's not the default.  Here's where to change that order, to
 * work better with hosts where config changes are problematic or
 * controllers (like original superh) that only support one config.
 */
static bool loopdefault = 0;
module_param(loopdefault, bool, S_IRUGO|S_IWUSR);

static struct usb_zero_options gzero_options = {
	.isoc_interval = GZERO_ISOC_INTERVAL,
	.isoc_maxpacket = GZERO_ISOC_MAXPACKET,
	.bulk_buflen = GZERO_BULK_BUFLEN,
	.qlen = GZERO_QLEN,
};

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

/* Thanks to NetChip Technologies for donating this product ID.
 *
 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
 * Instead:  allocate your own, using normal USB-IF procedures.
 */
#ifndef	CONFIG_USB_ZERO_HNPTEST
#define DRIVER_VENDOR_NUM	0x0525		/* NetChip */
#define DRIVER_PRODUCT_NUM	0xa4a0		/* Linux-USB "Gadget Zero" */
#define DEFAULT_AUTORESUME	0
#else
#define DRIVER_VENDOR_NUM	0x1a0a		/* OTG test device IDs */
#define DRIVER_PRODUCT_NUM	0xbadd
#define DEFAULT_AUTORESUME	5
#endif

/* If the optional "autoresume" mode is enabled, it provides good
 * functional coverage for the "USBCV" test harness from USB-IF.
 * It's always set if OTG mode is enabled.
 */
static unsigned autoresume = DEFAULT_AUTORESUME;
module_param(autoresume, uint, S_IRUGO);
MODULE_PARM_DESC(autoresume, "zero, or seconds before remote wakeup");

/* Maximum Autoresume time */
static unsigned max_autoresume;
module_param(max_autoresume, uint, S_IRUGO);
MODULE_PARM_DESC(max_autoresume, "maximum seconds before remote wakeup");

/* Interval between two remote wakeups */
static unsigned autoresume_interval_ms;
module_param(autoresume_interval_ms, uint, S_IRUGO);
MODULE_PARM_DESC(autoresume_interval_ms,
		"milliseconds to increase successive wakeup delays");

static unsigned autoresume_step_ms;
/*-------------------------------------------------------------------------*/

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

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

	.idVendor =		cpu_to_le16(DRIVER_VENDOR_NUM),
	.idProduct =		cpu_to_le16(DRIVER_PRODUCT_NUM),
	.bNumConfigurations =	2,
};

#ifdef CONFIG_USB_OTG
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,
};
#else
#define otg_desc	NULL
#endif

/* string IDs are assigned dynamically */
/* default serial number takes at least two packets */
static char serial[] = "0123456789.0123456789.0123456789";

#define USB_GZERO_SS_DESC	(USB_GADGET_FIRST_AVAIL_IDX + 0)
#define USB_GZERO_LB_DESC	(USB_GADGET_FIRST_AVAIL_IDX + 1)

static struct usb_string strings_dev[] = {
	[USB_GADGET_MANUFACTURER_IDX].s = "",
	[USB_GADGET_PRODUCT_IDX].s = longname,
	[USB_GADGET_SERIAL_IDX].s = serial,
	[USB_GZERO_SS_DESC].s	= "source and sink data",
	[USB_GZERO_LB_DESC].s	= "loop input to output",
	{  }			/* 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 timer_list	autoresume_timer;

static void zero_autoresume(unsigned long _c)
{
	struct usb_composite_dev	*cdev = (void *)_c;
	struct usb_gadget		*g = cdev->gadget;

	/* unconfigured devices can't issue wakeups */
	if (!cdev->config)
		return;

	/* Normally the host would be woken up for something
	 * more significant than just a timer firing; likely
	 * because of some direct user request.
	 */
	if (g->speed != USB_SPEED_UNKNOWN) {
		int status = usb_gadget_wakeup(g);
		INFO(cdev, "%s --> %d\n", __func__, status);
	}
}

static void zero_suspend(struct usb_composite_dev *cdev)
{
	if (cdev->gadget->speed == USB_SPEED_UNKNOWN)
		return;

	if (autoresume) {
		if (max_autoresume &&
			(autoresume_step_ms > max_autoresume * 1000))
				autoresume_step_ms = autoresume * 1000;

		mod_timer(&autoresume_timer, jiffies +
			msecs_to_jiffies(autoresume_step_ms));
		DBG(cdev, "suspend, wakeup in %d milliseconds\n",
			autoresume_step_ms);

		autoresume_step_ms += autoresume_interval_ms;
	} else
		DBG(cdev, "%s\n", __func__);
}

static void zero_resume(struct usb_composite_dev *cdev)
{
	DBG(cdev, "%s\n", __func__);
	del_timer(&autoresume_timer);
}

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

static struct usb_configuration loopback_driver = {
	.label          = "loopback",
	.bConfigurationValue = 2,
	.bmAttributes   = USB_CONFIG_ATT_SELFPOWER,
	/* .iConfiguration = DYNAMIC */
};

static struct usb_function *func_ss;
static struct usb_function_instance *func_inst_ss;

static int ss_config_setup(struct usb_configuration *c,
		const struct usb_ctrlrequest *ctrl)
{
	switch (ctrl->bRequest) {
	case 0x5b:
	case 0x5c:
		return func_ss->setup(func_ss, ctrl);
	default:
		return -EOPNOTSUPP;
	}
}

static struct usb_configuration sourcesink_driver = {
	.label                  = "source/sink",
	.setup                  = ss_config_setup,
	.bConfigurationValue    = 3,
	.bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
	/* .iConfiguration      = DYNAMIC */
};

module_param_named(buflen, gzero_options.bulk_buflen, uint, 0);
module_param_named(pattern, gzero_options.pattern, uint, S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(pattern, "0 = all zeroes, 1 = mod63, 2 = none");

module_param_named(isoc_interval, gzero_options.isoc_interval, uint,
		S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(isoc_interval, "1 - 16");

module_param_named(isoc_maxpacket, gzero_options.isoc_maxpacket, uint,
		S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(isoc_maxpacket, "0 - 1023 (fs), 0 - 1024 (hs/ss)");

module_param_named(isoc_mult, gzero_options.isoc_mult, uint, S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(isoc_mult, "0 - 2 (hs/ss only)");

module_param_named(isoc_maxburst, gzero_options.isoc_maxburst, uint,
		S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(isoc_maxburst, "0 - 15 (ss only)");

static struct usb_function *func_lb;
static struct usb_function_instance *func_inst_lb;

module_param_named(qlen, gzero_options.qlen, uint, S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(qlen, "depth of loopback queue");

static int zero_bind(struct usb_composite_dev *cdev)
{
	struct f_ss_opts	*ss_opts;
	struct f_lb_opts	*lb_opts;
	int			status;

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

	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
	device_desc.iSerialNumber = strings_dev[USB_GADGET_SERIAL_IDX].id;

	setup_timer(&autoresume_timer, zero_autoresume, (unsigned long) cdev);

	func_inst_ss = usb_get_function_instance("SourceSink");
	if (IS_ERR(func_inst_ss))
		return PTR_ERR(func_inst_ss);

	ss_opts =  container_of(func_inst_ss, struct f_ss_opts, func_inst);
	ss_opts->pattern = gzero_options.pattern;
	ss_opts->isoc_interval = gzero_options.isoc_interval;
	ss_opts->isoc_maxpacket = gzero_options.isoc_maxpacket;
	ss_opts->isoc_mult = gzero_options.isoc_mult;
	ss_opts->isoc_maxburst = gzero_options.isoc_maxburst;
	ss_opts->bulk_buflen = gzero_options.bulk_buflen;

	func_ss = usb_get_function(func_inst_ss);
	if (IS_ERR(func_ss)) {
		status = PTR_ERR(func_ss);
		goto err_put_func_inst_ss;
	}

	func_inst_lb = usb_get_function_instance("Loopback");
	if (IS_ERR(func_inst_lb)) {
		status = PTR_ERR(func_inst_lb);
		goto err_put_func_ss;
	}

	lb_opts = container_of(func_inst_lb, struct f_lb_opts, func_inst);
	lb_opts->bulk_buflen = gzero_options.bulk_buflen;
	lb_opts->qlen = gzero_options.qlen;

	func_lb = usb_get_function(func_inst_lb);
	if (IS_ERR(func_lb)) {
		status = PTR_ERR(func_lb);
		goto err_put_func_inst_lb;
	}

	sourcesink_driver.iConfiguration = strings_dev[USB_GZERO_SS_DESC].id;
	loopback_driver.iConfiguration = strings_dev[USB_GZERO_LB_DESC].id;

	/* support autoresume for remote wakeup testing */
	sourcesink_driver.bmAttributes &= ~USB_CONFIG_ATT_WAKEUP;
	loopback_driver.bmAttributes &= ~USB_CONFIG_ATT_WAKEUP;
	sourcesink_driver.descriptors = NULL;
	loopback_driver.descriptors = NULL;
	if (autoresume) {
		sourcesink_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
		loopback_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
		autoresume_step_ms = autoresume * 1000;
	}

	/* support OTG systems */
	if (gadget_is_otg(cdev->gadget)) {
		sourcesink_driver.descriptors = otg_desc;
		sourcesink_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
		loopback_driver.descriptors = otg_desc;
		loopback_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
	}

	/* Register primary, then secondary configuration.  Note that
	 * SH3 only allows one config...
	 */
	if (loopdefault) {
		usb_add_config_only(cdev, &loopback_driver);
		usb_add_config_only(cdev, &sourcesink_driver);
	} else {
		usb_add_config_only(cdev, &sourcesink_driver);
		usb_add_config_only(cdev, &loopback_driver);
	}
	status = usb_add_function(&sourcesink_driver, func_ss);
	if (status)
		goto err_conf_flb;

	usb_ep_autoconfig_reset(cdev->gadget);
	status = usb_add_function(&loopback_driver, func_lb);
	if (status)
		goto err_conf_flb;

	usb_ep_autoconfig_reset(cdev->gadget);
	usb_composite_overwrite_options(cdev, &coverwrite);

	INFO(cdev, "%s, version: " DRIVER_VERSION "\n", longname);

	return 0;

err_conf_flb:
	usb_put_function(func_lb);
	func_lb = NULL;
err_put_func_inst_lb:
	usb_put_function_instance(func_inst_lb);
	func_inst_lb = NULL;
err_put_func_ss:
	usb_put_function(func_ss);
	func_ss = NULL;
err_put_func_inst_ss:
	usb_put_function_instance(func_inst_ss);
	func_inst_ss = NULL;
	return status;
}

static int zero_unbind(struct usb_composite_dev *cdev)
{
	del_timer_sync(&autoresume_timer);
	if (!IS_ERR_OR_NULL(func_ss))
		usb_put_function(func_ss);
	usb_put_function_instance(func_inst_ss);
	if (!IS_ERR_OR_NULL(func_lb))
		usb_put_function(func_lb);
	usb_put_function_instance(func_inst_lb);
	return 0;
}

static struct usb_composite_driver zero_driver = {
	.name		= "zero",
	.dev		= &device_desc,
	.strings	= dev_strings,
	.max_speed	= USB_SPEED_SUPER,
	.bind		= zero_bind,
	.unbind		= zero_unbind,
	.suspend	= zero_suspend,
	.resume		= zero_resume,
};

module_usb_composite_driver(zero_driver);

MODULE_AUTHOR("David Brownell");
MODULE_LICENSE("GPL");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* zero.c -- Gadget Zero, for USB development
	3	*
097db1d0 DB	4	* Copyright (C) 2003-2008 David Brownell
097db1d0 DB	5	* Copyright (C) 2008 by Nokia Corporation
1da177e4	6	*
ca2bdf4b DB	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.
1da177e4 LT	11	*/
1da177e4 LT	12
1da177e4 LT	13	/*
	14	* Gadget Zero only needs two bulk endpoints, and is an example of how you
	15	* can write a hardware-agnostic gadget driver running inside a USB device.
7472f38b	16	* Some hardware details are visible, but don't affect most of the driver.
1da177e4 LT	17	*
	18	* Use it with the Linux host/master side "usbtest" driver to get a basic
	19	* functional test of your device-side usb stack, or with "usb-skeleton".
	20	*
	21	* It supports two similar configurations. One sinks whatever the usb host
	22	* writes, and in return sources zeroes. The other loops whatever the host
097db1d0	23	* writes back, so the host can read it.
1da177e4 LT	24	*
	25	* Many drivers will only have one configuration, letting them be much
	26	* simpler if they also don't support high speed operation (like this
	27	* driver does).
ca2bdf4b DB	28	*
	29	* Why is this driver using two configurations, rather than setting up
	30	* two interfaces with different functions? To help verify that multiple
b8bcf32a	31	* configuration infrastructure is working correctly; also, so that it can
ca2bdf4b	32	* work with low capability USB controllers without four bulk endpoints.
1da177e4 LT	33	*/
1da177e4 LT	34
097db1d0 DB	35	/*
	36	* driver assumes self-powered hardware, and
	37	* has no way for users to trigger remote wakeup.
	38	*/
	39
ca2bdf4b	40	/* #define VERBOSE_DEBUG */
1da177e4	41
1da177e4	42	#include <linux/kernel.h>
5a0e3ad6	43	#include <linux/slab.h>
1da177e4	44	#include <linux/device.h>
cf9a08ae SAS	45	#include <linux/module.h>
	46	#include <linux/err.h>
	47	#include <linux/usb/composite.h>
1da177e4	48
097db1d0	49	#include "g_zero.h"
1da177e4	50	/-------------------------------------------------------------------------/
7d16e8d3	51	USB_GADGET_COMPOSITE_OPTIONS();
1da177e4	52
097db1d0	53	#define DRIVER_VERSION "Cinco de Mayo 2008"
1da177e4	54
7472f38b	55	static const char longname[] = "Gadget Zero";
1da177e4	56
1da177e4 LT	57	/*
	58	* Normally the "loopback" configuration is second (index 1) so
	59	* it's not the default. Here's where to change that order, to
097db1d0 DB	60	* work better with hosts where config changes are problematic or
097db1d0 DB	61	* controllers (like original superh) that only support one config.
1da177e4	62	*/
90ab5ee9	63	static bool loopdefault = 0;
7472f38b	64	module_param(loopdefault, bool, S_IRUGO\|S_IWUSR);
1da177e4	65
38b3ad56	66	static struct usb_zero_options gzero_options = {
25d80151 AP	67	.isoc_interval = GZERO_ISOC_INTERVAL,
25d80151 AP	68	.isoc_maxpacket = GZERO_ISOC_MAXPACKET,
c0501f47 AP	69	.bulk_buflen = GZERO_BULK_BUFLEN,
c0501f47 AP	70	.qlen = GZERO_QLEN,
cf9a08ae SAS	71	};
cf9a08ae SAS	72
1da177e4 LT	73	/-------------------------------------------------------------------------/
	74
	75	/* Thanks to NetChip Technologies for donating this product ID.
	76	*
	77	* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
	78	* Instead: allocate your own, using normal USB-IF procedures.
	79	*/
	80	#ifndef CONFIG_USB_ZERO_HNPTEST
	81	#define DRIVER_VENDOR_NUM 0x0525 /* NetChip */
	82	#define DRIVER_PRODUCT_NUM 0xa4a0 /* Linux-USB "Gadget Zero" */
ab943a2e	83	#define DEFAULT_AUTORESUME 0
1da177e4 LT	84	#else
	85	#define DRIVER_VENDOR_NUM 0x1a0a /* OTG test device IDs */
	86	#define DRIVER_PRODUCT_NUM 0xbadd
ab943a2e	87	#define DEFAULT_AUTORESUME 5
1da177e4 LT	88	#endif
1da177e4 LT	89
ab943a2e DB	90	/* If the optional "autoresume" mode is enabled, it provides good
	91	* functional coverage for the "USBCV" test harness from USB-IF.
	92	* It's always set if OTG mode is enabled.
	93	*/
d07a5901	94	static unsigned autoresume = DEFAULT_AUTORESUME;
ab943a2e DB	95	module_param(autoresume, uint, S_IRUGO);
	96	MODULE_PARM_DESC(autoresume, "zero, or seconds before remote wakeup");
	97
36ed03f7	98	/* Maximum Autoresume time */
d07a5901	99	static unsigned max_autoresume;
36ed03f7 PC	100	module_param(max_autoresume, uint, S_IRUGO);
	101	MODULE_PARM_DESC(max_autoresume, "maximum seconds before remote wakeup");
	102
	103	/* Interval between two remote wakeups */
d07a5901	104	static unsigned autoresume_interval_ms;
36ed03f7 PC	105	module_param(autoresume_interval_ms, uint, S_IRUGO);
	106	MODULE_PARM_DESC(autoresume_interval_ms,
	107	"milliseconds to increase successive wakeup delays");
	108
	109	static unsigned autoresume_step_ms;
1da177e4 LT	110	/-------------------------------------------------------------------------/
1da177e4 LT	111
7472f38b	112	static struct usb_device_descriptor device_desc = {
1da177e4 LT	113	.bLength = sizeof device_desc,
	114	.bDescriptorType = USB_DT_DEVICE,
	115
551509d2	116	.bcdUSB = cpu_to_le16(0x0200),
1da177e4 LT	117	.bDeviceClass = USB_CLASS_VENDOR_SPEC,
1da177e4 LT	118
551509d2 HH	119	.idVendor = cpu_to_le16(DRIVER_VENDOR_NUM),
551509d2 HH	120	.idProduct = cpu_to_le16(DRIVER_PRODUCT_NUM),
1da177e4 LT	121	.bNumConfigurations = 2,
	122	};
	123
097db1d0	124	#ifdef CONFIG_USB_OTG
7472f38b	125	static struct usb_otg_descriptor otg_descriptor = {
1da177e4 LT	126	.bLength = sizeof otg_descriptor,
	127	.bDescriptorType = USB_DT_OTG,
	128
097db1d0 DB	129	/* REVISIT SRP-only hardware is possible, although
	130	* it would not be called "OTG" ...
	131	*/
	132	.bmAttributes = USB_OTG_SRP \| USB_OTG_HNP,
1da177e4 LT	133	};
1da177e4 LT	134
cf9a08ae	135	static const struct usb_descriptor_header *otg_desc[] = {
1da177e4	136	(struct usb_descriptor_header *) &otg_descriptor,
1da177e4 LT	137	NULL,
1da177e4 LT	138	};
cf9a08ae SAS	139	#else
cf9a08ae SAS	140	#define otg_desc NULL
097db1d0	141	#endif
1da177e4	142
097db1d0	143	/* string IDs are assigned dynamically */
ca2bdf4b DB	144	/* default serial number takes at least two packets */
ca2bdf4b DB	145	static char serial[] = "0123456789.0123456789.0123456789";
1da177e4	146
eeae5407	147	#define USB_GZERO_SS_DESC (USB_GADGET_FIRST_AVAIL_IDX + 0)
78f46f09	148	#define USB_GZERO_LB_DESC (USB_GADGET_FIRST_AVAIL_IDX + 1)
eeae5407	149
097db1d0	150	static struct usb_string strings_dev[] = {
cc2683c3	151	[USB_GADGET_MANUFACTURER_IDX].s = "",
276e2e4f SAS	152	[USB_GADGET_PRODUCT_IDX].s = longname,
276e2e4f SAS	153	[USB_GADGET_SERIAL_IDX].s = serial,
eeae5407	154	[USB_GZERO_SS_DESC].s = "source and sink data",
78f46f09	155	[USB_GZERO_LB_DESC].s = "loop input to output",
1da177e4 LT	156	{ } /* end of list */
	157	};
	158
097db1d0	159	static struct usb_gadget_strings stringtab_dev = {
1da177e4	160	.language = 0x0409, /* en-us */
097db1d0	161	.strings = strings_dev,
1da177e4 LT	162	};
1da177e4 LT	163
097db1d0 DB	164	static struct usb_gadget_strings *dev_strings[] = {
	165	&stringtab_dev,
	166	NULL,
	167	};
1da177e4 LT	168
	169	/-------------------------------------------------------------------------/
	170
ab943a2e DB	171	static struct timer_list autoresume_timer;
	172
	173	static void zero_autoresume(unsigned long _c)
	174	{
	175	struct usb_composite_dev cdev = (void )_c;
	176	struct usb_gadget *g = cdev->gadget;
	177
	178	/* unconfigured devices can't issue wakeups */
	179	if (!cdev->config)
	180	return;
	181
	182	/* Normally the host would be woken up for something
	183	* more significant than just a timer firing; likely
	184	* because of some direct user request.
	185	*/
	186	if (g->speed != USB_SPEED_UNKNOWN) {
	187	int status = usb_gadget_wakeup(g);
	188	INFO(cdev, "%s --> %d\n", __func__, status);
	189	}
	190	}
	191
	192	static void zero_suspend(struct usb_composite_dev *cdev)
	193	{
	194	if (cdev->gadget->speed == USB_SPEED_UNKNOWN)
	195	return;
	196
	197	if (autoresume) {
36ed03f7 PC	198	if (max_autoresume &&
	199	(autoresume_step_ms > max_autoresume * 1000))
	200	autoresume_step_ms = autoresume * 1000;
	201
	202	mod_timer(&autoresume_timer, jiffies +
	203	msecs_to_jiffies(autoresume_step_ms));
	204	DBG(cdev, "suspend, wakeup in %d milliseconds\n",
	205	autoresume_step_ms);
	206
	207	autoresume_step_ms += autoresume_interval_ms;
ab943a2e DB	208	} else
	209	DBG(cdev, "%s\n", __func__);
	210	}
	211
	212	static void zero_resume(struct usb_composite_dev *cdev)
	213	{
	214	DBG(cdev, "%s\n", __func__);
	215	del_timer(&autoresume_timer);
	216	}
	217
	218	/-------------------------------------------------------------------------/
	219
78f46f09 SAS	220	static struct usb_configuration loopback_driver = {
78f46f09 SAS	221	.label = "loopback",
78f46f09 SAS	222	.bConfigurationValue = 2,
	223	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
	224	/* .iConfiguration = DYNAMIC */
	225	};
	226
cf9a08ae SAS	227	static struct usb_function *func_ss;
	228	static struct usb_function_instance *func_inst_ss;
	229
	230	static int ss_config_setup(struct usb_configuration *c,
	231	const struct usb_ctrlrequest *ctrl)
	232	{
	233	switch (ctrl->bRequest) {
	234	case 0x5b:
	235	case 0x5c:
	236	return func_ss->setup(func_ss, ctrl);
	237	default:
	238	return -EOPNOTSUPP;
	239	}
	240	}
	241
eeae5407 SAS	242	static struct usb_configuration sourcesink_driver = {
eeae5407 SAS	243	.label = "source/sink",
eeae5407 SAS	244	.setup = ss_config_setup,
	245	.bConfigurationValue = 3,
	246	.bmAttributes = USB_CONFIG_ATT_SELFPOWER,
	247	/* .iConfiguration = DYNAMIC */
	248	};
	249
cf9a08ae SAS	250	module_param_named(buflen, gzero_options.bulk_buflen, uint, 0);
	251	module_param_named(pattern, gzero_options.pattern, uint, S_IRUGO\|S_IWUSR);
	252	MODULE_PARM_DESC(pattern, "0 = all zeroes, 1 = mod63, 2 = none");
	253
	254	module_param_named(isoc_interval, gzero_options.isoc_interval, uint,
	255	S_IRUGO\|S_IWUSR);
	256	MODULE_PARM_DESC(isoc_interval, "1 - 16");
	257
	258	module_param_named(isoc_maxpacket, gzero_options.isoc_maxpacket, uint,
	259	S_IRUGO\|S_IWUSR);
	260	MODULE_PARM_DESC(isoc_maxpacket, "0 - 1023 (fs), 0 - 1024 (hs/ss)");
	261
	262	module_param_named(isoc_mult, gzero_options.isoc_mult, uint, S_IRUGO\|S_IWUSR);
	263	MODULE_PARM_DESC(isoc_mult, "0 - 2 (hs/ss only)");
	264
	265	module_param_named(isoc_maxburst, gzero_options.isoc_maxburst, uint,
	266	S_IRUGO\|S_IWUSR);
	267	MODULE_PARM_DESC(isoc_maxburst, "0 - 15 (ss only)");
	268
	269	static struct usb_function *func_lb;
	270	static struct usb_function_instance *func_inst_lb;
	271
	272	module_param_named(qlen, gzero_options.qlen, uint, S_IRUGO\|S_IWUSR);
	273	MODULE_PARM_DESC(qlen, "depth of loopback queue");
	274
c94e289f	275	static int zero_bind(struct usb_composite_dev *cdev)
1da177e4	276	{
cf9a08ae SAS	277	struct f_ss_opts *ss_opts;
cf9a08ae SAS	278	struct f_lb_opts *lb_opts;
e1f15ccb	279	int status;
91e79c91	280
097db1d0 DB	281	/* Allocate string descriptor numbers ... note that string
097db1d0 DB	282	* contents can be overridden by the composite_dev glue.
91e79c91	283	*/
e1f15ccb SAS	284	status = usb_string_ids_tab(cdev, strings_dev);
	285	if (status < 0)
	286	return status;
	287
276e2e4f SAS	288	device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
	289	device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
	290	device_desc.iSerialNumber = strings_dev[USB_GADGET_SERIAL_IDX].id;
097db1d0	291
ab943a2e DB	292	setup_timer(&autoresume_timer, zero_autoresume, (unsigned long) cdev);
ab943a2e DB	293
cf9a08ae SAS	294	func_inst_ss = usb_get_function_instance("SourceSink");
	295	if (IS_ERR(func_inst_ss))
	296	return PTR_ERR(func_inst_ss);
	297
	298	ss_opts = container_of(func_inst_ss, struct f_ss_opts, func_inst);
	299	ss_opts->pattern = gzero_options.pattern;
	300	ss_opts->isoc_interval = gzero_options.isoc_interval;
	301	ss_opts->isoc_maxpacket = gzero_options.isoc_maxpacket;
	302	ss_opts->isoc_mult = gzero_options.isoc_mult;
9c1b7036	303	ss_opts->isoc_maxburst = gzero_options.isoc_maxburst;
cf9a08ae SAS	304	ss_opts->bulk_buflen = gzero_options.bulk_buflen;
	305
	306	func_ss = usb_get_function(func_inst_ss);
c8c18883 WY	307	if (IS_ERR(func_ss)) {
c8c18883 WY	308	status = PTR_ERR(func_ss);
cf9a08ae	309	goto err_put_func_inst_ss;
c8c18883	310	}
cf9a08ae SAS	311
cf9a08ae SAS	312	func_inst_lb = usb_get_function_instance("Loopback");
c8c18883 WY	313	if (IS_ERR(func_inst_lb)) {
c8c18883 WY	314	status = PTR_ERR(func_inst_lb);
cf9a08ae	315	goto err_put_func_ss;
c8c18883	316	}
cf9a08ae SAS	317
	318	lb_opts = container_of(func_inst_lb, struct f_lb_opts, func_inst);
	319	lb_opts->bulk_buflen = gzero_options.bulk_buflen;
	320	lb_opts->qlen = gzero_options.qlen;
	321
	322	func_lb = usb_get_function(func_inst_lb);
	323	if (IS_ERR(func_lb)) {
	324	status = PTR_ERR(func_lb);
	325	goto err_put_func_inst_lb;
	326	}
	327
eeae5407	328	sourcesink_driver.iConfiguration = strings_dev[USB_GZERO_SS_DESC].id;
78f46f09 SAS	329	loopback_driver.iConfiguration = strings_dev[USB_GZERO_LB_DESC].id;
78f46f09 SAS	330
eeae5407 SAS	331	/* support autoresume for remote wakeup testing */
eeae5407 SAS	332	sourcesink_driver.bmAttributes &= ~USB_CONFIG_ATT_WAKEUP;
78f46f09	333	loopback_driver.bmAttributes &= ~USB_CONFIG_ATT_WAKEUP;
eeae5407	334	sourcesink_driver.descriptors = NULL;
78f46f09 SAS	335	loopback_driver.descriptors = NULL;
78f46f09 SAS	336	if (autoresume) {
eeae5407	337	sourcesink_driver.bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
78f46f09	338	loopback_driver.bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
36ed03f7	339	autoresume_step_ms = autoresume * 1000;
78f46f09	340	}
eeae5407 SAS	341
	342	/* support OTG systems */
	343	if (gadget_is_otg(cdev->gadget)) {
	344	sourcesink_driver.descriptors = otg_desc;
	345	sourcesink_driver.bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
78f46f09 SAS	346	loopback_driver.descriptors = otg_desc;
78f46f09 SAS	347	loopback_driver.bmAttributes \|= USB_CONFIG_ATT_WAKEUP;
eeae5407 SAS	348	}
eeae5407 SAS	349
097db1d0 DB	350	/* Register primary, then secondary configuration. Note that
097db1d0 DB	351	* SH3 only allows one config...
1da177e4	352	*/
097db1d0	353	if (loopdefault) {
cf9a08ae SAS	354	usb_add_config_only(cdev, &loopback_driver);
cf9a08ae SAS	355	usb_add_config_only(cdev, &sourcesink_driver);
097db1d0	356	} else {
cf9a08ae SAS	357	usb_add_config_only(cdev, &sourcesink_driver);
cf9a08ae SAS	358	usb_add_config_only(cdev, &loopback_driver);
1da177e4	359	}
cf9a08ae SAS	360	status = usb_add_function(&sourcesink_driver, func_ss);
	361	if (status)
	362	goto err_conf_flb;
1da177e4	363
cf9a08ae SAS	364	usb_ep_autoconfig_reset(cdev->gadget);
	365	status = usb_add_function(&loopback_driver, func_lb);
	366	if (status)
	367	goto err_conf_flb;
	368
	369	usb_ep_autoconfig_reset(cdev->gadget);
7d16e8d3	370	usb_composite_overwrite_options(cdev, &coverwrite);
1da177e4	371
097db1d0	372	INFO(cdev, "%s, version: " DRIVER_VERSION "\n", longname);
1da177e4	373
1da177e4	374	return 0;
cf9a08ae SAS	375
	376	err_conf_flb:
	377	usb_put_function(func_lb);
	378	func_lb = NULL;
	379	err_put_func_inst_lb:
	380	usb_put_function_instance(func_inst_lb);
	381	func_inst_lb = NULL;
	382	err_put_func_ss:
	383	usb_put_function(func_ss);
	384	func_ss = NULL;
	385	err_put_func_inst_ss:
	386	usb_put_function_instance(func_inst_ss);
	387	func_inst_ss = NULL;
	388	return status;
1da177e4 LT	389	}
1da177e4 LT	390
ab943a2e DB	391	static int zero_unbind(struct usb_composite_dev *cdev)
	392	{
	393	del_timer_sync(&autoresume_timer);
cf9a08ae SAS	394	if (!IS_ERR_OR_NULL(func_ss))
cf9a08ae SAS	395	usb_put_function(func_ss);
abe7a409	396	usb_put_function_instance(func_inst_ss);
cf9a08ae SAS	397	if (!IS_ERR_OR_NULL(func_lb))
cf9a08ae SAS	398	usb_put_function(func_lb);
abe7a409	399	usb_put_function_instance(func_inst_lb);
ab943a2e DB	400	return 0;
	401	}
	402
c94e289f	403	static struct usb_composite_driver zero_driver = {
097db1d0 DB	404	.name = "zero",
	405	.dev = &device_desc,
	406	.strings = dev_strings,
57c97c02	407	.max_speed = USB_SPEED_SUPER,
03e42bd5	408	.bind = zero_bind,
ab943a2e DB	409	.unbind = zero_unbind,
	410	.suspend = zero_suspend,
	411	.resume = zero_resume,
1da177e4 LT	412	};
1da177e4 LT	413
909346a8 TK	414	module_usb_composite_driver(zero_driver);
909346a8 TK	415
ca2bdf4b DB	416	MODULE_AUTHOR("David Brownell");
ca2bdf4b DB	417	MODULE_LICENSE("GPL");