[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 = {
	.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 = {
	.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 = {
	.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 = {
	.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 = {
	.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 = {
	.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 = {
	.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 = {
	.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[] = {
	(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 = {
	.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 = {
	.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[] = {
	(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);
}

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

/* 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;
}

static int 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;

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

	if (obex_string_defs[OBEX_CTRL_IDX].id == 0) {
		status = usb_string_ids_tab(c->cdev, obex_string_defs);
		if (status < 0)
			return status;
		obex_control_intf.iInterface =
			obex_string_defs[OBEX_CTRL_IDX].id;

		status = obex_string_defs[OBEX_DATA_IDX].id;
		obex_data_nop_intf.iInterface = status;
		obex_data_intf.iInterface = status;
	}

	/* 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;
}

#ifdef USBF_OBEX_INCLUDED

static void
obex_old_unbind(struct usb_configuration *c, struct usb_function *f)
{
	obex_string_defs[OBEX_CTRL_IDX].id = 0;
	usb_free_all_descriptors(f);
	kfree(func_to_obex(f));
}

/**
 * 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.
 */
int __init obex_bind_config(struct usb_configuration *c, u8 port_num)
{
	struct f_obex	*obex;
	int		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_old_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;
}

#else

static void obex_free_inst(struct usb_function_instance *f)
{
	struct f_serial_opts *opts;

	opts = container_of(f, struct f_serial_opts, func_inst);
	gserial_free_line(opts->port_num);
	kfree(opts);
}

static struct usb_function_instance *obex_alloc_inst(void)
{
	struct f_serial_opts *opts;
	int ret;

	opts = kzalloc(sizeof(*opts), GFP_KERNEL);
	if (!opts)
		return ERR_PTR(-ENOMEM);

	opts->func_inst.free_func_inst = obex_free_inst;
	ret = gserial_alloc_line(&opts->port_num);
	if (ret) {
		kfree(opts);
		return ERR_PTR(ret);
	}

	return &opts->func_inst;
}

static void obex_free(struct usb_function *f)
{
	struct f_obex *obex;

	obex = func_to_obex(f);
	kfree(obex);
}

static void obex_unbind(struct usb_configuration *c, struct usb_function *f)
{
	obex_string_defs[OBEX_CTRL_IDX].id = 0;
	usb_free_all_descriptors(f);
}

struct usb_function *obex_alloc(struct usb_function_instance *fi)
{
	struct f_obex	*obex;
	struct f_serial_opts *opts;

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

	opts = container_of(fi, struct f_serial_opts, func_inst);

	obex->port_num = opts->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;
	obex->port.func.free_func = obex_free;

	return &obex->port.func;
}

DECLARE_USB_FUNCTION_INIT(obex, obex_alloc_inst, obex_alloc);

#endif

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
1d8fc251	75	static struct usb_interface_descriptor obex_control_intf = {
3086775a FB	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
1d8fc251	86	static struct usb_interface_descriptor obex_data_nop_intf = {
3086775a FB	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
1d8fc251	96	static struct usb_interface_descriptor obex_data_intf = {
3086775a FB	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
1d8fc251	106	static struct usb_cdc_header_desc obex_cdc_header_desc = {
3086775a FB	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	};
3086775a FB	112
1d8fc251	113	static struct usb_cdc_union_desc obex_cdc_union_desc = {
3086775a FB	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
1d8fc251	121	static struct usb_cdc_obex_desc obex_desc = {
3086775a FB	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
1d8fc251	130	static struct usb_endpoint_descriptor obex_hs_ep_out_desc = {
3086775a FB	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	};
3086775a FB	138
1d8fc251	139	static struct usb_endpoint_descriptor obex_hs_ep_in_desc = {
3086775a FB	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	};
3086775a FB	147
1d8fc251	148	static struct usb_descriptor_header *hs_function[] = {
3086775a FB	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
1d8fc251	163	static struct usb_endpoint_descriptor obex_fs_ep_in_desc = {
3086775a FB	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
1d8fc251	171	static struct usb_endpoint_descriptor obex_fs_ep_out_desc = {
3086775a FB	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
1d8fc251	179	static struct usb_descriptor_header *fs_function[] = {
3086775a FB	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
1d8fc251 AP	293	/* Some controllers can't support CDC OBEX ... */
	294	static inline bool can_support_obex(struct usb_configuration *c)
	295	{
	296	/* Since the first interface is a NOP, we can ignore the
	297	* issue of multi-interface support on most controllers.
	298	*
	299	* Altsettings are mandatory, however...
	300	*/
	301	if (!gadget_supports_altsettings(c->cdev->gadget))
	302	return false;
	303
	304	/* everything else is probably fine ... */
	305	return true;
	306	}
	307
	308	static int obex_bind(struct usb_configuration c, struct usb_function f)
3086775a FB	309	{
	310	struct usb_composite_dev *cdev = c->cdev;
	311	struct f_obex *obex = func_to_obex(f);
	312	int status;
	313	struct usb_ep *ep;
	314
1d8fc251 AP	315	if (!can_support_obex(c))
	316	return -EINVAL;
	317
	318	if (obex_string_defs[OBEX_CTRL_IDX].id == 0) {
	319	status = usb_string_ids_tab(c->cdev, obex_string_defs);
	320	if (status < 0)
	321	return status;
	322	obex_control_intf.iInterface =
	323	obex_string_defs[OBEX_CTRL_IDX].id;
	324
	325	status = obex_string_defs[OBEX_DATA_IDX].id;
	326	obex_data_nop_intf.iInterface = status;
	327	obex_data_intf.iInterface = status;
	328	}
	329
3086775a FB	330	/* allocate instance-specific interface IDs, and patch descriptors */
	331
	332	status = usb_interface_id(c, f);
	333	if (status < 0)
	334	goto fail;
	335	obex->ctrl_id = status;
	336
	337	obex_control_intf.bInterfaceNumber = status;
	338	obex_cdc_union_desc.bMasterInterface0 = status;
	339
	340	status = usb_interface_id(c, f);
	341	if (status < 0)
	342	goto fail;
	343	obex->data_id = status;
	344
	345	obex_data_nop_intf.bInterfaceNumber = status;
	346	obex_data_intf.bInterfaceNumber = status;
	347	obex_cdc_union_desc.bSlaveInterface0 = status;
	348
	349	/* allocate instance-specific endpoints */
	350
	351	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_in_desc);
	352	if (!ep)
	353	goto fail;
	354	obex->port.in = ep;
	355	ep->driver_data = cdev; /* claim */
	356
	357	ep = usb_ep_autoconfig(cdev->gadget, &obex_fs_ep_out_desc);
	358	if (!ep)
	359	goto fail;
	360	obex->port.out = ep;
	361	ep->driver_data = cdev; /* claim */
	362
3086775a FB	363	/* support all relevant hardware speeds... we expect that when
	364	* hardware is dual speed, all bulk-capable endpoints work at
	365	* both speeds
	366	*/
3086775a	367
10287bae SAS	368	obex_hs_ep_in_desc.bEndpointAddress =
	369	obex_fs_ep_in_desc.bEndpointAddress;
	370	obex_hs_ep_out_desc.bEndpointAddress =
	371	obex_fs_ep_out_desc.bEndpointAddress;
3086775a	372
10287bae SAS	373	status = usb_assign_descriptors(f, fs_function, hs_function, NULL);
	374	if (status)
	375	goto fail;
3086775a	376
21214278 DB	377	/* Avoid letting this gadget enumerate until the userspace
	378	* OBEX server is active.
	379	*/
	380	status = usb_function_deactivate(f);
	381	if (status < 0)
	382	WARNING(cdev, "obex ttyGS%d: can't prevent enumeration, %d\n",
	383	obex->port_num, status);
	384	else
	385	obex->can_activate = true;
	386
	387
3086775a FB	388	DBG(cdev, "obex ttyGS%d: %s speed IN/%s OUT/%s\n",
	389	obex->port_num,
	390	gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
	391	obex->port.in->name, obex->port.out->name);
	392
	393	return 0;
	394
	395	fail:
10287bae	396	usb_free_all_descriptors(f);
3086775a FB	397	/* we might as well release our claims on endpoints */
	398	if (obex->port.out)
	399	obex->port.out->driver_data = NULL;
	400	if (obex->port.in)
	401	obex->port.in->driver_data = NULL;
	402
	403	ERROR(cdev, "%s/%p: can't bind, err %d\n", f->name, f, status);
	404
	405	return status;
	406	}
	407
1d8fc251 AP	408	#ifdef USBF_OBEX_INCLUDED
1d8fc251 AP	409
3086775a	410	static void
1d8fc251	411	obex_old_unbind(struct usb_configuration c, struct usb_function f)
3086775a	412	{
1616e99d	413	obex_string_defs[OBEX_CTRL_IDX].id = 0;
10287bae	414	usb_free_all_descriptors(f);
3086775a FB	415	kfree(func_to_obex(f));
	416	}
	417
3086775a FB	418	/**
	419	* obex_bind_config - add a CDC OBEX function to a configuration
	420	* @c: the configuration to support the CDC OBEX instance
	421	* @port_num: /dev/ttyGS* port this interface will use
	422	* Context: single threaded during gadget setup
	423	*
	424	* Returns zero on success, else negative errno.
3086775a FB	425	*/
	426	int __init obex_bind_config(struct usb_configuration *c, u8 port_num)
	427	{
	428	struct f_obex *obex;
	429	int status;
	430
3086775a FB	431	/* allocate and initialize one new instance */
	432	obex = kzalloc(sizeof *obex, GFP_KERNEL);
	433	if (!obex)
	434	return -ENOMEM;
	435
	436	obex->port_num = port_num;
	437
21214278 DB	438	obex->port.connect = obex_connect;
	439	obex->port.disconnect = obex_disconnect;
	440
3086775a FB	441	obex->port.func.name = "obex";
	442	obex->port.func.strings = obex_strings;
	443	/* descriptors are per-instance copies */
	444	obex->port.func.bind = obex_bind;
1d8fc251	445	obex->port.func.unbind = obex_old_unbind;
3086775a FB	446	obex->port.func.set_alt = obex_set_alt;
	447	obex->port.func.get_alt = obex_get_alt;
	448	obex->port.func.disable = obex_disable;
	449
	450	status = usb_add_function(c, &obex->port.func);
	451	if (status)
	452	kfree(obex);
	453
	454	return status;
	455	}
	456
1d8fc251 AP	457	#else
	458
	459	static void obex_free_inst(struct usb_function_instance *f)
	460	{
	461	struct f_serial_opts *opts;
	462
	463	opts = container_of(f, struct f_serial_opts, func_inst);
	464	gserial_free_line(opts->port_num);
	465	kfree(opts);
	466	}
	467
	468	static struct usb_function_instance *obex_alloc_inst(void)
	469	{
	470	struct f_serial_opts *opts;
	471	int ret;
	472
	473	opts = kzalloc(sizeof(*opts), GFP_KERNEL);
	474	if (!opts)
	475	return ERR_PTR(-ENOMEM);
	476
	477	opts->func_inst.free_func_inst = obex_free_inst;
	478	ret = gserial_alloc_line(&opts->port_num);
	479	if (ret) {
	480	kfree(opts);
	481	return ERR_PTR(ret);
	482	}
	483
	484	return &opts->func_inst;
	485	}
	486
	487	static void obex_free(struct usb_function *f)
	488	{
	489	struct f_obex *obex;
	490
	491	obex = func_to_obex(f);
	492	kfree(obex);
	493	}
	494
	495	static void obex_unbind(struct usb_configuration c, struct usb_function f)
	496	{
	497	obex_string_defs[OBEX_CTRL_IDX].id = 0;
	498	usb_free_all_descriptors(f);
	499	}
	500
	501	struct usb_function obex_alloc(struct usb_function_instance fi)
	502	{
	503	struct f_obex *obex;
	504	struct f_serial_opts *opts;
	505
	506	/* allocate and initialize one new instance */
	507	obex = kzalloc(sizeof(*obex), GFP_KERNEL);
	508	if (!obex)
	509	return ERR_PTR(-ENOMEM);
	510
	511	opts = container_of(fi, struct f_serial_opts, func_inst);
	512
	513	obex->port_num = opts->port_num;
	514
	515	obex->port.connect = obex_connect;
	516	obex->port.disconnect = obex_disconnect;
	517
	518	obex->port.func.name = "obex";
	519	obex->port.func.strings = obex_strings;
	520	/* descriptors are per-instance copies */
521	obex->port.func.bind = obex_bind;
522	obex->port.func.unbind = obex_unbind;
523	obex->port.func.set_alt = obex_set_alt;
524	obex->port.func.get_alt = obex_get_alt;
525	obex->port.func.disable = obex_disable;
526	obex->port.func.free_func = obex_free;
527
528	return &obex->port.func;
529	}
530
531	DECLARE_USB_FUNCTION_INIT(obex, obex_alloc_inst, obex_alloc);
532
533	#endif
534
3086775a FB	535	MODULE_AUTHOR("Felipe Balbi");
3086775a FB	536	MODULE_LICENSE("GPL");