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

/*
 * f_obex.c -- USB CDC OBEX function driver
 *
 * Copyright (C) 2008 Nokia Corporation
 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
 *
 * Based on f_acm.c by Al Borchers and David Brownell.
 *
 * 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 VERBOSE_DEBUG */

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

#include "u_serial.h"
#include "gadget_chips.h"


/*
 * This CDC OBEX function support just packages a TTY-ish byte stream.
 * A user mode server will put it into "raw" mode and handle all the
 * relevant protocol details ... this is just a kernel passthrough.
 * When possible, we prevent gadget enumeration until that server is
 * ready to handle the commands.
 */

struct f_obex {
	struct gserial			port;
	u8				ctrl_id;
	u8				data_id;
	u8				port_num;
	u8				can_activate;
};

static inline struct f_obex *func_to_obex(struct usb_function *f)
{
	return container_of(f, struct f_obex, port.func);
}

static inline struct f_obex *port_to_obex(struct gserial *p)
{
	return container_of(p, struct f_obex, port);
}

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

#define OBEX_CTRL_IDX	0
#define OBEX_DATA_IDX	1

static struct usb_string obex_string_defs[] = {
	[OBEX_CTRL_IDX].s	= "CDC Object Exchange (OBEX)",
	[OBEX_DATA_IDX].s	= "CDC OBEX Data",
	{  },	/* end of list */
};

static struct usb_gadget_strings obex_string_table = {
	.language		= 0x0409,	/* en-US */
	.strings		= obex_string_defs,
};

static struct usb_gadget_strings *obex_strings[] = {
	&obex_string_table,
	NULL,
};

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

static struct usb_interface_descriptor obex_control_intf __initdata = {
	.bLength		= sizeof(obex_control_intf),
	.bDescriptorType	= USB_DT_INTERFACE,
	.bInterfaceNumber	= 0,

	.bAlternateSetting	= 0,
	.bNumEndpoints		= 0,
	.bInterfaceClass	= USB_CLASS_COMM,
	.bInterfaceSubClass	= USB_CDC_SUBCLASS_OBEX,
};

static struct usb_interface_descriptor obex_data_nop_intf __initdata = {
	.bLength		= sizeof(obex_data_nop_intf),
	.bDescriptorType	= USB_DT_INTERFACE,
	.bInterfaceNumber	= 1,

	.bAlternateSetting	= 0,
	.bNumEndpoints		= 0,
	.bInterfaceClass	= USB_CLASS_CDC_DATA,
};

static struct usb_interface_descriptor obex_data_intf __initdata = {
	.bLength		= sizeof(obex_data_intf),
	.bDescriptorType	= USB_DT_INTERFACE,
	.bInterfaceNumber	= 2,

	.bAlternateSetting	= 1,
	.bNumEndpoints		= 2,
	.bInterfaceClass	= USB_CLASS_CDC_DATA,
};

static struct usb_cdc_header_desc obex_cdc_header_desc __initdata = {
	.bLength		= sizeof(obex_cdc_header_desc),
	.bDescriptorType	= USB_DT_CS_INTERFACE,
	.bDescriptorSubType	= USB_CDC_HEADER_TYPE,
	.bcdCDC			= cpu_to_le16(0x0120),
};

static struct usb_cdc_union_desc obex_cdc_union_desc __initdata = {
	.bLength		= sizeof(obex_cdc_union_desc),
	.bDescriptorType	= USB_DT_CS_INTERFACE,
	.bDescriptorSubType	= USB_CDC_UNION_TYPE,
	.bMasterInterface0	= 1,
	.bSlaveInterface0	= 2,
};

static struct usb_cdc_obex_desc obex_desc __initdata = {
	.bLength		= sizeof(obex_desc),
	.bDescriptorType	= USB_DT_CS_INTERFACE,
	.bDescriptorSubType	= USB_CDC_OBEX_TYPE,
	.bcdVersion		= cpu_to_le16(0x0100),
};

/* High-Speed Support */

static struct usb_endpoint_descriptor obex_hs_ep_out_desc __initdata = {
	.bLength		= USB_DT_ENDPOINT_SIZE,
	.bDescriptorType	= USB_DT_ENDPOINT,

	.bEndpointAddress	= USB_DIR_OUT,
	.bmAttributes		= USB_ENDPOINT_XFER_BULK,
	.wMaxPacketSize		= cpu_to_le16(512),
};

static struct usb_endpoint_descriptor obex_hs_ep_in_desc __initdata = {
	.bLength		= USB_DT_ENDPOINT_SIZE,
	.bDescriptorType	= USB_DT_ENDPOINT,

	.bEndpointAddress	= USB_DIR_IN,
	.bmAttributes		= USB_ENDPOINT_XFER_BULK,
	.wMaxPacketSize		= cpu_to_le16(512),
};

static struct usb_descriptor_header *hs_function[] __initdata = {
	(struct usb_descriptor_header *) &obex_control_intf,
	(struct usb_descriptor_header *) &obex_cdc_header_desc,
	(struct usb_descriptor_header *) &obex_desc,
	(struct usb_descriptor_header *) &obex_cdc_union_desc,

	(struct usb_descriptor_header *) &obex_data_nop_intf,
	(struct usb_descriptor_header *) &obex_data_intf,
	(struct usb_descriptor_header *) &obex_hs_ep_in_desc,
	(struct usb_descriptor_header *) &obex_hs_ep_out_desc,
	NULL,
};

/* Full-Speed Support */

static struct usb_endpoint_descriptor obex_fs_ep_in_desc __initdata = {
	.bLength		= USB_DT_ENDPOINT_SIZE,
	.bDescriptorType	= USB_DT_ENDPOINT,

	.bEndpointAddress	= USB_DIR_IN,
	.bmAttributes		= USB_ENDPOINT_XFER_BULK,
};

static struct usb_endpoint_descriptor obex_fs_ep_out_desc __initdata = {
	.bLength		= USB_DT_ENDPOINT_SIZE,
	.bDescriptorType	= USB_DT_ENDPOINT,

	.bEndpointAddress	= USB_DIR_OUT,
	.bmAttributes		= USB_ENDPOINT_XFER_BULK,
};

static struct usb_descriptor_header *fs_function[] __initdata = {
	(struct usb_descriptor_header *) &obex_control_intf,
	(struct usb_descriptor_header *) &obex_cdc_header_desc,
	(struct usb_descriptor_header *) &obex_desc,
	(struct usb_descriptor_header *) &obex_cdc_union_desc,

	(struct usb_descriptor_header *) &obex_data_nop_intf,
	(struct usb_descriptor_header *) &obex_data_intf,
	(struct usb_descriptor_header *) &obex_fs_ep_in_desc,
	(struct usb_descriptor_header *) &obex_fs_ep_out_desc,
	NULL,
};

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

static int obex_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
{
	struct f_obex		*obex = func_to_obex(f);
	struct usb_composite_dev *cdev = f->config->cdev;

	if (intf == obex->ctrl_id) {
		if (alt != 0)
			goto fail;
		/* NOP */
		DBG(cdev, "reset obex ttyGS%d control\n", obex->port_num);

	} else if (intf == obex->data_id) {
		if (alt > 1)
			goto fail;

		if (obex->port.in->driver_data) {
			DBG(cdev, "reset obex ttyGS%d\n", obex->port_num);
			gserial_disconnect(&obex->port);
		}

		if (!obex->port.in->desc || !obex->port.out->desc) {
			DBG(cdev, "init obex ttyGS%d\n", obex->port_num);
			if (config_ep_by_speed(cdev->gadget, f,
					       obex->port.in) ||
			    config_ep_by_speed(cdev->gadget, f,
					       obex->port.out)) {
				obex->port.out->desc = NULL;
				obex->port.in->desc = NULL;
				goto fail;
			}
		}

		if (alt == 1) {
			DBG(cdev, "activate obex ttyGS%d\n", obex->port_num);
			gserial_connect(&obex->port, obex->port_num);
		}

	} else
		goto fail;

	return 0;

fail:
	return -EINVAL;
}

static int obex_get_alt(struct usb_function *f, unsigned intf)
{
	struct f_obex		*obex = func_to_obex(f);

	if (intf == obex->ctrl_id)
		return 0;

	return obex->port.in->driver_data ? 1 : 0;
}

static void obex_disable(struct usb_function *f)
{
	struct f_obex	*obex = func_to_obex(f);
	struct usb_composite_dev *cdev = f->config->cdev;

	DBG(cdev, "obex ttyGS%d disable\n", obex->port_num);
	gserial_disconnect(&obex->port);
}

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

static void obex_connect(struct gserial *g)
{
	struct f_obex		*obex = port_to_obex(g);
	struct usb_composite_dev *cdev = g->func.config->cdev;
	int			status;

	if (!obex->can_activate)
		return;

	status = usb_function_activate(&g->func);
	if (status)
		DBG(cdev, "obex ttyGS%d function activate --> %d\n",
			obex->port_num, status);
}

static void obex_disconnect(struct gserial *g)
{
	struct f_obex		*obex = port_to_obex(g);
	struct usb_composite_dev *cdev = g->func.config->cdev;
	int			status;

	if (!obex->can_activate)
		return;

	status = usb_function_deactivate(&g->func);
	if (status)
		DBG(cdev, "obex ttyGS%d function deactivate --> %d\n",
			obex->port_num, status);
}

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

static int __init
obex_bind(struct usb_configuration *c, struct usb_function *f)
{
	struct usb_composite_dev *cdev = c->cdev;
	struct f_obex		*obex = func_to_obex(f);
	int			status;
	struct usb_ep		*ep;

	/* allocate instance-specific interface IDs, and patch descriptors */

	status = usb_interface_id(c, f);
	if (status < 0)
		goto fail;
	obex->ctrl_id = status;

	obex_control_intf.bInterfaceNumber = status;
	obex_cdc_union_desc.bMasterInterface0 = status;

	status = usb_interface_id(c, f);
	if (status < 0)
		goto fail;
	obex->data_id = status;

	obex_data_nop_intf.bInterfaceNumber = status;
	obex_data_intf.bInterfaceNumber = status;
	obex_cdc_union_desc.bSlaveInterface0 = status;

	/* allocate instance-specific endpoints */

	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_in_desc);
	if (!ep)
		goto fail;
	obex->port.in = ep;
	ep->driver_data = cdev;	/* claim */

	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_out_desc);
	if (!ep)
		goto fail;
	obex->port.out = ep;
	ep->driver_data = cdev;	/* claim */

	/* support all relevant hardware speeds... we expect that when
	 * hardware is dual speed, all bulk-capable endpoints work at
	 * both speeds
	 */

	obex_hs_ep_in_desc.bEndpointAddress =
		obex_fs_ep_in_desc.bEndpointAddress;
	obex_hs_ep_out_desc.bEndpointAddress =
		obex_fs_ep_out_desc.bEndpointAddress;

	status = usb_assign_descriptors(f, fs_function, hs_function, NULL);
	if (status)
		goto fail;

	/* Avoid letting this gadget enumerate until the userspace
	 * OBEX server is active.
	 */
	status = usb_function_deactivate(f);
	if (status < 0)
		WARNING(cdev, "obex ttyGS%d: can't prevent enumeration, %d\n",
			obex->port_num, status);
	else
		obex->can_activate = true;


	DBG(cdev, "obex ttyGS%d: %s speed IN/%s OUT/%s\n",
			obex->port_num,
			gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
			obex->port.in->name, obex->port.out->name);

	return 0;

fail:
	usb_free_all_descriptors(f);
	/* we might as well release our claims on endpoints */
	if (obex->port.out)
		obex->port.out->driver_data = NULL;
	if (obex->port.in)
		obex->port.in->driver_data = NULL;

	ERROR(cdev, "%s/%p: can't bind, err %d\n", f->name, f, status);

	return status;
}

static void
obex_unbind(struct usb_configuration *c, struct usb_function *f)
{
	usb_free_all_descriptors(f);
	kfree(func_to_obex(f));
}

/* Some controllers can't support CDC OBEX ... */
static inline bool can_support_obex(struct usb_configuration *c)
{
	/* Since the first interface is a NOP, we can ignore the
	 * issue of multi-interface support on most controllers.
	 *
	 * Altsettings are mandatory, however...
	 */
	if (!gadget_supports_altsettings(c->cdev->gadget))
		return false;

	/* everything else is *probably* fine ... */
	return true;
}

/**
 * obex_bind_config - add a CDC OBEX function to a configuration
 * @c: the configuration to support the CDC OBEX instance
 * @port_num: /dev/ttyGS* port this interface will use
 * Context: single threaded during gadget setup
 *
 * Returns zero on success, else negative errno.
 *
 * Caller must have called @gserial_setup() with enough ports to
 * handle all the ones it binds.  Caller is also responsible
 * for calling @gserial_cleanup() before module unload.
 */
int __init obex_bind_config(struct usb_configuration *c, u8 port_num)
{
	struct f_obex	*obex;
	int		status;

	if (!can_support_obex(c))
		return -EINVAL;

	/* maybe allocate device-global string IDs, and patch descriptors */
	if (obex_string_defs[OBEX_CTRL_IDX].id == 0) {
		status = usb_string_id(c->cdev);
		if (status < 0)
			return status;
		obex_string_defs[OBEX_CTRL_IDX].id = status;

		obex_control_intf.iInterface = status;

		status = usb_string_id(c->cdev);
		if (status < 0)
			return status;
		obex_string_defs[OBEX_DATA_IDX].id = status;

		obex_data_nop_intf.iInterface =
			obex_data_intf.iInterface = status;
	}

	/* allocate and initialize one new instance */
	obex = kzalloc(sizeof *obex, GFP_KERNEL);
	if (!obex)
		return -ENOMEM;

	obex->port_num = port_num;

	obex->port.connect = obex_connect;
	obex->port.disconnect = obex_disconnect;

	obex->port.func.name = "obex";
	obex->port.func.strings = obex_strings;
	/* descriptors are per-instance copies */
	obex->port.func.bind = obex_bind;
	obex->port.func.unbind = obex_unbind;
	obex->port.func.set_alt = obex_set_alt;
	obex->port.func.get_alt = obex_get_alt;
	obex->port.func.disable = obex_disable;

	status = usb_add_function(c, &obex->port.func);
	if (status)
		kfree(obex);

	return status;
}

MODULE_AUTHOR("Felipe Balbi");
MODULE_LICENSE("GPL");
Commit	Line	Data
3086775a FB	1	/*
	2	* f_obex.c -- USB CDC OBEX function driver
	3	*
	4	* Copyright (C) 2008 Nokia Corporation
	5	* Contact: Felipe Balbi <felipe.balbi@nokia.com>
	6	*
	7	* Based on f_acm.c by Al Borchers and David Brownell.
	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.
3086775a FB	13	*/
	14
	15	/* #define VERBOSE_DEBUG */
	16
5a0e3ad6	17	#include <linux/slab.h>
3086775a	18	#include <linux/kernel.h>
3086775a	19	#include <linux/device.h>
6eb0de82	20	#include <linux/module.h>
3086775a FB	21
	22	#include "u_serial.h"
	23	#include "gadget_chips.h"
	24
	25
	26	/*
	27	* This CDC OBEX function support just packages a TTY-ish byte stream.
	28	* A user mode server will put it into "raw" mode and handle all the
	29	* relevant protocol details ... this is just a kernel passthrough.
21214278 DB	30	* When possible, we prevent gadget enumeration until that server is
21214278 DB	31	* ready to handle the commands.
3086775a FB	32	*/
3086775a FB	33
3086775a FB	34	struct f_obex {
	35	struct gserial port;
	36	u8 ctrl_id;
	37	u8 data_id;
	38	u8 port_num;
21214278	39	u8 can_activate;
3086775a FB	40	};
	41
	42	static inline struct f_obex func_to_obex(struct usb_function f)
	43	{
	44	return container_of(f, struct f_obex, port.func);
	45	}
	46
21214278 DB	47	static inline struct f_obex port_to_obex(struct gserial p)
	48	{
	49	return container_of(p, struct f_obex, port);
	50	}
	51
3086775a FB	52	/-------------------------------------------------------------------------/
	53
	54	#define OBEX_CTRL_IDX 0
	55	#define OBEX_DATA_IDX 1
	56
	57	static struct usb_string obex_string_defs[] = {
	58	[OBEX_CTRL_IDX].s = "CDC Object Exchange (OBEX)",
	59	[OBEX_DATA_IDX].s = "CDC OBEX Data",
	60	{ }, /* end of list */
	61	};
	62
	63	static struct usb_gadget_strings obex_string_table = {
	64	.language = 0x0409, /* en-US */
	65	.strings = obex_string_defs,
	66	};
	67
	68	static struct usb_gadget_strings *obex_strings[] = {
	69	&obex_string_table,
	70	NULL,
	71	};
	72
	73	/-------------------------------------------------------------------------/
	74
	75	static struct usb_interface_descriptor obex_control_intf __initdata = {
	76	.bLength = sizeof(obex_control_intf),
	77	.bDescriptorType = USB_DT_INTERFACE,
	78	.bInterfaceNumber = 0,
	79
	80	.bAlternateSetting = 0,
	81	.bNumEndpoints = 0,
	82	.bInterfaceClass = USB_CLASS_COMM,
	83	.bInterfaceSubClass = USB_CDC_SUBCLASS_OBEX,
	84	};
	85
	86	static struct usb_interface_descriptor obex_data_nop_intf __initdata = {
	87	.bLength = sizeof(obex_data_nop_intf),
	88	.bDescriptorType = USB_DT_INTERFACE,
	89	.bInterfaceNumber = 1,
	90
	91	.bAlternateSetting = 0,
	92	.bNumEndpoints = 0,
	93	.bInterfaceClass = USB_CLASS_CDC_DATA,
	94	};
	95
	96	static struct usb_interface_descriptor obex_data_intf __initdata = {
	97	.bLength = sizeof(obex_data_intf),
	98	.bDescriptorType = USB_DT_INTERFACE,
	99	.bInterfaceNumber = 2,
	100
	101	.bAlternateSetting = 1,
	102	.bNumEndpoints = 2,
	103	.bInterfaceClass = USB_CLASS_CDC_DATA,
	104	};
	105
	106	static struct usb_cdc_header_desc obex_cdc_header_desc __initdata = {
	107	.bLength = sizeof(obex_cdc_header_desc),
	108	.bDescriptorType = USB_DT_CS_INTERFACE,
	109	.bDescriptorSubType = USB_CDC_HEADER_TYPE,
551509d2	110	.bcdCDC = cpu_to_le16(0x0120),
3086775a FB	111	};
	112
	113	static struct usb_cdc_union_desc obex_cdc_union_desc __initdata = {
	114	.bLength = sizeof(obex_cdc_union_desc),
	115	.bDescriptorType = USB_DT_CS_INTERFACE,
	116	.bDescriptorSubType = USB_CDC_UNION_TYPE,
	117	.bMasterInterface0 = 1,
	118	.bSlaveInterface0 = 2,
	119	};
	120
	121	static struct usb_cdc_obex_desc obex_desc __initdata = {
	122	.bLength = sizeof(obex_desc),
	123	.bDescriptorType = USB_DT_CS_INTERFACE,
	124	.bDescriptorSubType = USB_CDC_OBEX_TYPE,
551509d2	125	.bcdVersion = cpu_to_le16(0x0100),
3086775a FB	126	};
	127
	128	/* High-Speed Support */
	129
	130	static struct usb_endpoint_descriptor obex_hs_ep_out_desc __initdata = {
	131	.bLength = USB_DT_ENDPOINT_SIZE,
	132	.bDescriptorType = USB_DT_ENDPOINT,
	133
	134	.bEndpointAddress = USB_DIR_OUT,
	135	.bmAttributes = USB_ENDPOINT_XFER_BULK,
551509d2	136	.wMaxPacketSize = cpu_to_le16(512),
3086775a FB	137	};
	138
	139	static struct usb_endpoint_descriptor obex_hs_ep_in_desc __initdata = {
	140	.bLength = USB_DT_ENDPOINT_SIZE,
	141	.bDescriptorType = USB_DT_ENDPOINT,
	142
	143	.bEndpointAddress = USB_DIR_IN,
	144	.bmAttributes = USB_ENDPOINT_XFER_BULK,
551509d2	145	.wMaxPacketSize = cpu_to_le16(512),
3086775a FB	146	};
	147
	148	static struct usb_descriptor_header *hs_function[] __initdata = {
	149	(struct usb_descriptor_header *) &obex_control_intf,
	150	(struct usb_descriptor_header *) &obex_cdc_header_desc,
	151	(struct usb_descriptor_header *) &obex_desc,
	152	(struct usb_descriptor_header *) &obex_cdc_union_desc,
	153
	154	(struct usb_descriptor_header *) &obex_data_nop_intf,
	155	(struct usb_descriptor_header *) &obex_data_intf,
	156	(struct usb_descriptor_header *) &obex_hs_ep_in_desc,
	157	(struct usb_descriptor_header *) &obex_hs_ep_out_desc,
	158	NULL,
	159	};
	160
	161	/* Full-Speed Support */
	162
	163	static struct usb_endpoint_descriptor obex_fs_ep_in_desc __initdata = {
	164	.bLength = USB_DT_ENDPOINT_SIZE,
	165	.bDescriptorType = USB_DT_ENDPOINT,
	166
	167	.bEndpointAddress = USB_DIR_IN,
	168	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	169	};
	170
	171	static struct usb_endpoint_descriptor obex_fs_ep_out_desc __initdata = {
	172	.bLength = USB_DT_ENDPOINT_SIZE,
	173	.bDescriptorType = USB_DT_ENDPOINT,
	174
	175	.bEndpointAddress = USB_DIR_OUT,
	176	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	177	};
	178
	179	static struct usb_descriptor_header *fs_function[] __initdata = {
	180	(struct usb_descriptor_header *) &obex_control_intf,
	181	(struct usb_descriptor_header *) &obex_cdc_header_desc,
	182	(struct usb_descriptor_header *) &obex_desc,
	183	(struct usb_descriptor_header *) &obex_cdc_union_desc,
	184
	185	(struct usb_descriptor_header *) &obex_data_nop_intf,
	186	(struct usb_descriptor_header *) &obex_data_intf,
	187	(struct usb_descriptor_header *) &obex_fs_ep_in_desc,
	188	(struct usb_descriptor_header *) &obex_fs_ep_out_desc,
	189	NULL,
	190	};
	191
	192	/-------------------------------------------------------------------------/
	193
	194	static int obex_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
	195	{
	196	struct f_obex *obex = func_to_obex(f);
	197	struct usb_composite_dev *cdev = f->config->cdev;
	198
	199	if (intf == obex->ctrl_id) {
	200	if (alt != 0)
	201	goto fail;
	202	/* NOP */
	203	DBG(cdev, "reset obex ttyGS%d control\n", obex->port_num);
	204
	205	} else if (intf == obex->data_id) {
	206	if (alt > 1)
	207	goto fail;
	208
	209	if (obex->port.in->driver_data) {
210	DBG(cdev, "reset obex ttyGS%d\n", obex->port_num);
211	gserial_disconnect(&obex->port);
212	}
213
ea2a1df7	214	if (!obex->port.in->desc \|\| !obex->port.out->desc) {
3086775a	215	DBG(cdev, "init obex ttyGS%d\n", obex->port_num);
ea2a1df7 TB	216	if (config_ep_by_speed(cdev->gadget, f,
	217	obex->port.in) \|\|
	218	config_ep_by_speed(cdev->gadget, f,
	219	obex->port.out)) {
	220	obex->port.out->desc = NULL;
	221	obex->port.in->desc = NULL;
	222	goto fail;
	223	}
3086775a FB	224	}
	225
	226	if (alt == 1) {
	227	DBG(cdev, "activate obex ttyGS%d\n", obex->port_num);
	228	gserial_connect(&obex->port, obex->port_num);
	229	}
	230
	231	} else
	232	goto fail;
	233
	234	return 0;
	235
	236	fail:
	237	return -EINVAL;
	238	}
	239
	240	static int obex_get_alt(struct usb_function *f, unsigned intf)
	241	{
	242	struct f_obex *obex = func_to_obex(f);
	243
	244	if (intf == obex->ctrl_id)
	245	return 0;
	246
	247	return obex->port.in->driver_data ? 1 : 0;
	248	}
	249
	250	static void obex_disable(struct usb_function *f)
	251	{
	252	struct f_obex *obex = func_to_obex(f);
	253	struct usb_composite_dev *cdev = f->config->cdev;
	254
	255	DBG(cdev, "obex ttyGS%d disable\n", obex->port_num);
	256	gserial_disconnect(&obex->port);
	257	}
	258
	259	/-------------------------------------------------------------------------/
	260
21214278 DB	261	static void obex_connect(struct gserial *g)
	262	{
	263	struct f_obex *obex = port_to_obex(g);
	264	struct usb_composite_dev *cdev = g->func.config->cdev;
	265	int status;
	266
	267	if (!obex->can_activate)
	268	return;
	269
	270	status = usb_function_activate(&g->func);
	271	if (status)
	272	DBG(cdev, "obex ttyGS%d function activate --> %d\n",
	273	obex->port_num, status);
	274	}
	275
	276	static void obex_disconnect(struct gserial *g)
	277	{
	278	struct f_obex *obex = port_to_obex(g);
	279	struct usb_composite_dev *cdev = g->func.config->cdev;
	280	int status;
	281
	282	if (!obex->can_activate)
	283	return;
	284
	285	status = usb_function_deactivate(&g->func);
	286	if (status)
	287	DBG(cdev, "obex ttyGS%d function deactivate --> %d\n",
	288	obex->port_num, status);
	289	}
	290
	291	/-------------------------------------------------------------------------/
	292
3086775a FB	293	static int __init
	294	obex_bind(struct usb_configuration c, struct usb_function f)
	295	{
	296	struct usb_composite_dev *cdev = c->cdev;
	297	struct f_obex *obex = func_to_obex(f);
	298	int status;
	299	struct usb_ep *ep;
	300
	301	/* allocate instance-specific interface IDs, and patch descriptors */
	302
	303	status = usb_interface_id(c, f);
	304	if (status < 0)
	305	goto fail;
	306	obex->ctrl_id = status;
	307
	308	obex_control_intf.bInterfaceNumber = status;
	309	obex_cdc_union_desc.bMasterInterface0 = status;
	310
	311	status = usb_interface_id(c, f);
	312	if (status < 0)
	313	goto fail;
	314	obex->data_id = status;
	315
	316	obex_data_nop_intf.bInterfaceNumber = status;
	317	obex_data_intf.bInterfaceNumber = status;
	318	obex_cdc_union_desc.bSlaveInterface0 = status;
	319
	320	/* allocate instance-specific endpoints */
	321
	322	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_in_desc);
	323	if (!ep)
	324	goto fail;
	325	obex->port.in = ep;
	326	ep->driver_data = cdev; /* claim */
	327
	328	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_out_desc);
	329	if (!ep)
	330	goto fail;
	331	obex->port.out = ep;
	332	ep->driver_data = cdev; /* claim */
	333
3086775a FB	334	/* support all relevant hardware speeds... we expect that when
	335	* hardware is dual speed, all bulk-capable endpoints work at
	336	* both speeds
	337	*/
3086775a	338
10287bae SAS	339	obex_hs_ep_in_desc.bEndpointAddress =
	340	obex_fs_ep_in_desc.bEndpointAddress;
	341	obex_hs_ep_out_desc.bEndpointAddress =
	342	obex_fs_ep_out_desc.bEndpointAddress;
3086775a	343
10287bae SAS	344	status = usb_assign_descriptors(f, fs_function, hs_function, NULL);
	345	if (status)
	346	goto fail;
3086775a	347
21214278 DB	348	/* Avoid letting this gadget enumerate until the userspace
	349	* OBEX server is active.
	350	*/
	351	status = usb_function_deactivate(f);
	352	if (status < 0)
	353	WARNING(cdev, "obex ttyGS%d: can't prevent enumeration, %d\n",
	354	obex->port_num, status);
	355	else
	356	obex->can_activate = true;
	357
	358
3086775a FB	359	DBG(cdev, "obex ttyGS%d: %s speed IN/%s OUT/%s\n",
	360	obex->port_num,
	361	gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
	362	obex->port.in->name, obex->port.out->name);
	363
	364	return 0;
	365
	366	fail:
10287bae	367	usb_free_all_descriptors(f);
3086775a FB	368	/* we might as well release our claims on endpoints */
	369	if (obex->port.out)
	370	obex->port.out->driver_data = NULL;
	371	if (obex->port.in)
	372	obex->port.in->driver_data = NULL;
	373
	374	ERROR(cdev, "%s/%p: can't bind, err %d\n", f->name, f, status);
	375
	376	return status;
	377	}
	378
	379	static void
	380	obex_unbind(struct usb_configuration c, struct usb_function f)
	381	{
10287bae	382	usb_free_all_descriptors(f);
3086775a FB	383	kfree(func_to_obex(f));
	384	}
	385
	386	/* Some controllers can't support CDC OBEX ... */
	387	static inline bool can_support_obex(struct usb_configuration *c)
	388	{
	389	/* Since the first interface is a NOP, we can ignore the
	390	* issue of multi-interface support on most controllers.
	391	*
	392	* Altsettings are mandatory, however...
	393	*/
	394	if (!gadget_supports_altsettings(c->cdev->gadget))
	395	return false;
	396
	397	/* everything else is probably fine ... */
	398	return true;
	399	}
	400
	401	/**
	402	* obex_bind_config - add a CDC OBEX function to a configuration
	403	* @c: the configuration to support the CDC OBEX instance
	404	* @port_num: /dev/ttyGS* port this interface will use
	405	* Context: single threaded during gadget setup
	406	*
	407	* Returns zero on success, else negative errno.
	408	*
	409	* Caller must have called @gserial_setup() with enough ports to
	410	* handle all the ones it binds. Caller is also responsible
	411	* for calling @gserial_cleanup() before module unload.
	412	*/
	413	int __init obex_bind_config(struct usb_configuration *c, u8 port_num)
	414	{
	415	struct f_obex *obex;
	416	int status;
	417
	418	if (!can_support_obex(c))
	419	return -EINVAL;
	420
	421	/* maybe allocate device-global string IDs, and patch descriptors */
	422	if (obex_string_defs[OBEX_CTRL_IDX].id == 0) {
	423	status = usb_string_id(c->cdev);
	424	if (status < 0)
	425	return status;
	426	obex_string_defs[OBEX_CTRL_IDX].id = status;
	427
	428	obex_control_intf.iInterface = status;
	429
	430	status = usb_string_id(c->cdev);
	431	if (status < 0)
	432	return status;
	433	obex_string_defs[OBEX_DATA_IDX].id = status;
	434
	435	obex_data_nop_intf.iInterface =
	436	obex_data_intf.iInterface = status;
	437	}
	438
	439	/* allocate and initialize one new instance */
	440	obex = kzalloc(sizeof *obex, GFP_KERNEL);
	441	if (!obex)
	442	return -ENOMEM;
	443
	444	obex->port_num = port_num;
	445
21214278 DB	446	obex->port.connect = obex_connect;
	447	obex->port.disconnect = obex_disconnect;
	448
3086775a FB	449	obex->port.func.name = "obex";
	450	obex->port.func.strings = obex_strings;
	451	/* descriptors are per-instance copies */
	452	obex->port.func.bind = obex_bind;
	453	obex->port.func.unbind = obex_unbind;
	454	obex->port.func.set_alt = obex_set_alt;
	455	obex->port.func.get_alt = obex_get_alt;
	456	obex->port.func.disable = obex_disable;
	457
	458	status = usb_add_function(c, &obex->port.func);
	459	if (status)
	460	kfree(obex);
	461
	462	return status;
	463	}
	464
	465	MODULE_AUTHOR("Felipe Balbi");
	466	MODULE_LICENSE("GPL");