[deliverable/linux.git] / drivers / usb / serial / airprime.c

/*
 * AirPrime CDMA Wireless Serial USB driver
 *
 * Copyright (C) 2005-2006 Greg Kroah-Hartman <gregkh@suse.de>
 *
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License version
 *	2 as published by the Free Software Foundation.
 */

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>

static struct usb_device_id id_table [] = {
	{ USB_DEVICE(0x0c88, 0x17da) }, /* Kyocera Wireless KPC650/Passport */
	{ },
};
MODULE_DEVICE_TABLE(usb, id_table);

#define URB_TRANSFER_BUFFER_SIZE	4096
#define NUM_READ_URBS			4
#define NUM_WRITE_URBS			4
#define NUM_BULK_EPS			3
#define MAX_BULK_EPS			6

/* if overridden by the user, then use their value for the size of the
 * read and write urbs, and the number of endpoints */
static int buffer_size = URB_TRANSFER_BUFFER_SIZE;
static int endpoints = NUM_BULK_EPS;
static int debug;
struct airprime_private {
	spinlock_t lock;
	int outstanding_urbs;
	int throttled;
	struct urb *read_urbp[NUM_READ_URBS];

	/* Settings for the port */
	int rts_state;	/* Handshaking pins (outputs) */
	int dtr_state;
	int cts_state;	/* Handshaking pins (inputs) */
	int dsr_state;
	int dcd_state;
	int ri_state;
};

static int airprime_send_setup(struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	struct airprime_private *priv;

	dbg("%s", __func__);

	if (port->number != 0)
		return 0;

	priv = usb_get_serial_port_data(port);

	if (port->tty) {
		int val = 0;
		if (priv->dtr_state)
			val |= 0x01;
		if (priv->rts_state)
			val |= 0x02;

		return usb_control_msg(serial->dev,
				usb_rcvctrlpipe(serial->dev, 0),
				0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
	}

	return 0;
}

static void airprime_read_bulk_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	unsigned char *data = urb->transfer_buffer;
	struct tty_struct *tty;
	int result;
	int status = urb->status;

	dbg("%s - port %d", __func__, port->number);

	if (status) {
		dbg("%s - nonzero read bulk status received: %d",
		    __func__, status);
		return;
	}
	usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length, data);

	tty = port->tty;
	if (tty && urb->actual_length) {
		tty_insert_flip_string (tty, data, urb->actual_length);
		tty_flip_buffer_push (tty);
	}

	result = usb_submit_urb (urb, GFP_ATOMIC);
	if (result)
		dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n",
			__func__, result);
	return;
}

static void airprime_write_bulk_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct airprime_private *priv = usb_get_serial_port_data(port);
	int status = urb->status;
	unsigned long flags;

	dbg("%s - port %d", __func__, port->number);

	/* free up the transfer buffer, as usb_free_urb() does not do this */
	kfree (urb->transfer_buffer);

	if (status)
		dbg("%s - nonzero write bulk status received: %d",
		    __func__, status);
	spin_lock_irqsave(&priv->lock, flags);
	--priv->outstanding_urbs;
	spin_unlock_irqrestore(&priv->lock, flags);

	usb_serial_port_softint(port);
}

static int airprime_open(struct usb_serial_port *port, struct file *filp)
{
	struct airprime_private *priv = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;
	struct urb *urb;
	char *buffer = NULL;
	int i;
	int result = 0;

	dbg("%s - port %d", __func__, port->number);

	/* initialize our private data structure if it isn't already created */
	if (!priv) {
		priv = kzalloc(sizeof(*priv), GFP_KERNEL);
		if (!priv) {
			result = -ENOMEM;
			goto out;
		}
		spin_lock_init(&priv->lock);
		usb_set_serial_port_data(port, priv);
	}

	/* Set some sane defaults */
	priv->rts_state = 1;
	priv->dtr_state = 1;

	for (i = 0; i < NUM_READ_URBS; ++i) {
		buffer = kmalloc(buffer_size, GFP_KERNEL);
		if (!buffer) {
			dev_err(&port->dev, "%s - out of memory.\n",
				__func__);
			result = -ENOMEM;
			goto errout;
		}
		urb = usb_alloc_urb(0, GFP_KERNEL);
		if (!urb) {
			kfree(buffer);
			dev_err(&port->dev, "%s - no more urbs?\n",
				__func__);
			result = -ENOMEM;
			goto errout;
		}
		usb_fill_bulk_urb(urb, serial->dev,
				  usb_rcvbulkpipe(serial->dev,
						  port->bulk_out_endpointAddress),
				  buffer, buffer_size,
				  airprime_read_bulk_callback, port);
		result = usb_submit_urb(urb, GFP_KERNEL);
		if (result) {
			usb_free_urb(urb);
			kfree(buffer);
			dev_err(&port->dev,
				"%s - failed submitting read urb %d for port %d, error %d\n",
				__func__, i, port->number, result);
			goto errout;
		}
		/* remember this urb so we can kill it when the port is closed */
		priv->read_urbp[i] = urb;
	}

	airprime_send_setup(port);

	goto out;

 errout:
	/* some error happened, cancel any submitted urbs and clean up anything that
	   got allocated successfully */

	while (i-- != 0) {
		urb = priv->read_urbp[i];
		buffer = urb->transfer_buffer;
		usb_kill_urb (urb);
		usb_free_urb (urb);
		kfree (buffer);
	}

 out:
	return result;
}

static void airprime_close(struct usb_serial_port *port, struct file * filp)
{
	struct airprime_private *priv = usb_get_serial_port_data(port);
	int i;

	dbg("%s - port %d", __func__, port->number);

	priv->rts_state = 0;
	priv->dtr_state = 0;

	mutex_lock(&port->serial->disc_mutex);
	if (!port->serial->disconnected)
		airprime_send_setup(port);
	mutex_lock(&port->serial->disc_mutex);

	for (i = 0; i < NUM_READ_URBS; ++i) {
		usb_kill_urb (priv->read_urbp[i]);
		kfree (priv->read_urbp[i]->transfer_buffer);
		usb_free_urb (priv->read_urbp[i]);
	}

	/* free up private structure */
	kfree (priv);
	usb_set_serial_port_data(port, NULL);
}

static int airprime_write(struct usb_serial_port *port,
			  const unsigned char *buf, int count)
{
	struct airprime_private *priv = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;
	struct urb *urb;
	unsigned char *buffer;
	unsigned long flags;
	int status;
	dbg("%s - port %d", __func__, port->number);

	spin_lock_irqsave(&priv->lock, flags);
	if (priv->outstanding_urbs > NUM_WRITE_URBS) {
		spin_unlock_irqrestore(&priv->lock, flags);
		dbg("%s - write limit hit\n", __func__);
		return 0;
	}
	spin_unlock_irqrestore(&priv->lock, flags);
	buffer = kmalloc(count, GFP_ATOMIC);
	if (!buffer) {
		dev_err(&port->dev, "out of memory\n");
		return -ENOMEM;
	}
	urb = usb_alloc_urb(0, GFP_ATOMIC);
	if (!urb) {
		dev_err(&port->dev, "no more free urbs\n");
		kfree (buffer);
		return -ENOMEM;
	}
	memcpy (buffer, buf, count);

	usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);

	usb_fill_bulk_urb(urb, serial->dev,
			  usb_sndbulkpipe(serial->dev,
					  port->bulk_out_endpointAddress),
			  buffer, count,
			  airprime_write_bulk_callback, port);

	/* send it down the pipe */
	status = usb_submit_urb(urb, GFP_ATOMIC);
	if (status) {
		dev_err(&port->dev,
			"%s - usb_submit_urb(write bulk) failed with status = %d\n",
			__func__, status);
		count = status;
		kfree (buffer);
	} else {
		spin_lock_irqsave(&priv->lock, flags);
		++priv->outstanding_urbs;
		spin_unlock_irqrestore(&priv->lock, flags);
	}
	/* we are done with this urb, so let the host driver
	 * really free it when it is finished with it */
	usb_free_urb (urb);
	return count;
}

static struct usb_driver airprime_driver = {
	.name =		"airprime",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	id_table,
	.no_dynamic_id =	1,
};

static struct usb_serial_driver airprime_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"airprime",
	},
	.usb_driver =		&airprime_driver,
	.id_table =		id_table,
	.open =			airprime_open,
	.close =		airprime_close,
	.write =		airprime_write,
};

static int __init airprime_init(void)
{
	int retval;

	airprime_device.num_ports =
		(endpoints > 0 && endpoints <= MAX_BULK_EPS) ? endpoints : NUM_BULK_EPS;
	retval = usb_serial_register(&airprime_device);
	if (retval)
		return retval;
	retval = usb_register(&airprime_driver);
	if (retval)
		usb_serial_deregister(&airprime_device);
	return retval;
}

static void __exit airprime_exit(void)
{
	dbg("%s", __func__);

	usb_deregister(&airprime_driver);
	usb_serial_deregister(&airprime_device);
}

module_init(airprime_init);
module_exit(airprime_exit);
MODULE_LICENSE("GPL");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled");
module_param(buffer_size, int, 0);
MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers in bytes (default 4096)");
module_param(endpoints, int, 0);
MODULE_PARM_DESC(endpoints, "Number of bulk EPs to configure (default 3)");
Commit	Line	Data
3b86b202 GK	1	/*
	2	* AirPrime CDMA Wireless Serial USB driver
	3	*
5dda1712	4	* Copyright (C) 2005-2006 Greg Kroah-Hartman <gregkh@suse.de>
3b86b202 GK	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License version
	8	* 2 as published by the Free Software Foundation.
	9	*/
	10
	11	#include <linux/kernel.h>
	12	#include <linux/init.h>
	13	#include <linux/tty.h>
5dda1712	14	#include <linux/tty_flip.h>
3b86b202 GK	15	#include <linux/module.h>
3b86b202 GK	16	#include <linux/usb.h>
a969888c	17	#include <linux/usb/serial.h>
3b86b202 GK	18
3b86b202 GK	19	static struct usb_device_id id_table [] = {
34ab86e1	20	{ USB_DEVICE(0x0c88, 0x17da) }, /* Kyocera Wireless KPC650/Passport */
3b86b202 GK	21	{ },
	22	};
	23	MODULE_DEVICE_TABLE(usb, id_table);
	24
5dda1712 AG	25	#define URB_TRANSFER_BUFFER_SIZE 4096
	26	#define NUM_READ_URBS 4
	27	#define NUM_WRITE_URBS 4
	28	#define NUM_BULK_EPS 3
	29	#define MAX_BULK_EPS 6
	30
	31	/* if overridden by the user, then use their value for the size of the
	32	* read and write urbs, and the number of endpoints */
	33	static int buffer_size = URB_TRANSFER_BUFFER_SIZE;
	34	static int endpoints = NUM_BULK_EPS;
	35	static int debug;
	36	struct airprime_private {
	37	spinlock_t lock;
	38	int outstanding_urbs;
	39	int throttled;
	40	struct urb *read_urbp[NUM_READ_URBS];
cf0cb1ae MS	41
	42	/* Settings for the port */
	43	int rts_state; /* Handshaking pins (outputs) */
	44	int dtr_state;
	45	int cts_state; /* Handshaking pins (inputs) */
	46	int dsr_state;
	47	int dcd_state;
	48	int ri_state;
5dda1712 AG	49	};
5dda1712 AG	50
cf0cb1ae MS	51	static int airprime_send_setup(struct usb_serial_port *port)
	52	{
	53	struct usb_serial *serial = port->serial;
	54	struct airprime_private *priv;
	55
441b62c1	56	dbg("%s", __func__);
cf0cb1ae MS	57
	58	if (port->number != 0)
	59	return 0;
	60
	61	priv = usb_get_serial_port_data(port);
	62
	63	if (port->tty) {
	64	int val = 0;
	65	if (priv->dtr_state)
	66	val \|= 0x01;
	67	if (priv->rts_state)
	68	val \|= 0x02;
	69
	70	return usb_control_msg(serial->dev,
	71	usb_rcvctrlpipe(serial->dev, 0),
	72	0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
	73	}
	74
	75	return 0;
	76	}
	77
7d12e780	78	static void airprime_read_bulk_callback(struct urb *urb)
5dda1712 AG	79	{
	80	struct usb_serial_port *port = urb->context;
	81	unsigned char *data = urb->transfer_buffer;
	82	struct tty_struct *tty;
	83	int result;
d3434cf6	84	int status = urb->status;
5dda1712	85
441b62c1	86	dbg("%s - port %d", __func__, port->number);
5dda1712	87
d3434cf6	88	if (status) {
5dda1712	89	dbg("%s - nonzero read bulk status received: %d",
441b62c1	90	__func__, status);
5dda1712 AG	91	return;
5dda1712 AG	92	}
441b62c1	93	usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length, data);
5dda1712 AG	94
	95	tty = port->tty;
	96	if (tty && urb->actual_length) {
	97	tty_insert_flip_string (tty, data, urb->actual_length);
	98	tty_flip_buffer_push (tty);
	99	}
	100
	101	result = usb_submit_urb (urb, GFP_ATOMIC);
	102	if (result)
	103	dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n",
441b62c1	104	__func__, result);
5dda1712 AG	105	return;
	106	}
	107
7d12e780	108	static void airprime_write_bulk_callback(struct urb *urb)
5dda1712 AG	109	{
	110	struct usb_serial_port *port = urb->context;
	111	struct airprime_private *priv = usb_get_serial_port_data(port);
d3434cf6	112	int status = urb->status;
5dda1712 AG	113	unsigned long flags;
5dda1712 AG	114
441b62c1	115	dbg("%s - port %d", __func__, port->number);
5dda1712 AG	116
	117	/* free up the transfer buffer, as usb_free_urb() does not do this */
	118	kfree (urb->transfer_buffer);
	119
d3434cf6	120	if (status)
5dda1712	121	dbg("%s - nonzero write bulk status received: %d",
441b62c1	122	__func__, status);
5dda1712 AG	123	spin_lock_irqsave(&priv->lock, flags);
	124	--priv->outstanding_urbs;
	125	spin_unlock_irqrestore(&priv->lock, flags);
	126
	127	usb_serial_port_softint(port);
	128	}
	129
	130	static int airprime_open(struct usb_serial_port port, struct file filp)
	131	{
	132	struct airprime_private *priv = usb_get_serial_port_data(port);
	133	struct usb_serial *serial = port->serial;
	134	struct urb *urb;
	135	char *buffer = NULL;
	136	int i;
	137	int result = 0;
	138
441b62c1	139	dbg("%s - port %d", __func__, port->number);
5dda1712 AG	140
	141	/* initialize our private data structure if it isn't already created */
	142	if (!priv) {
	143	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	144	if (!priv) {
	145	result = -ENOMEM;
	146	goto out;
	147	}
	148	spin_lock_init(&priv->lock);
	149	usb_set_serial_port_data(port, priv);
	150	}
	151
cf0cb1ae MS	152	/* Set some sane defaults */
	153	priv->rts_state = 1;
	154	priv->dtr_state = 1;
	155
5dda1712 AG	156	for (i = 0; i < NUM_READ_URBS; ++i) {
	157	buffer = kmalloc(buffer_size, GFP_KERNEL);
	158	if (!buffer) {
	159	dev_err(&port->dev, "%s - out of memory.\n",
441b62c1	160	__func__);
5dda1712 AG	161	result = -ENOMEM;
	162	goto errout;
	163	}
	164	urb = usb_alloc_urb(0, GFP_KERNEL);
	165	if (!urb) {
0e185b79	166	kfree(buffer);
5dda1712	167	dev_err(&port->dev, "%s - no more urbs?\n",
441b62c1	168	__func__);
5dda1712 AG	169	result = -ENOMEM;
	170	goto errout;
	171	}
	172	usb_fill_bulk_urb(urb, serial->dev,
	173	usb_rcvbulkpipe(serial->dev,
	174	port->bulk_out_endpointAddress),
	175	buffer, buffer_size,
	176	airprime_read_bulk_callback, port);
	177	result = usb_submit_urb(urb, GFP_KERNEL);
	178	if (result) {
af59cf40 PZ	179	usb_free_urb(urb);
af59cf40 PZ	180	kfree(buffer);
5dda1712 AG	181	dev_err(&port->dev,
5dda1712 AG	182	"%s - failed submitting read urb %d for port %d, error %d\n",
441b62c1	183	__func__, i, port->number, result);
5dda1712 AG	184	goto errout;
	185	}
	186	/* remember this urb so we can kill it when the port is closed */
	187	priv->read_urbp[i] = urb;
	188	}
cf0cb1ae MS	189
	190	airprime_send_setup(port);
	191
5dda1712 AG	192	goto out;
	193
	194	errout:
	195	/* some error happened, cancel any submitted urbs and clean up anything that
	196	got allocated successfully */
	197
af59cf40	198	while (i-- != 0) {
5dda1712	199	urb = priv->read_urbp[i];
af59cf40 PZ	200	buffer = urb->transfer_buffer;
	201	usb_kill_urb (urb);
	202	usb_free_urb (urb);
	203	kfree (buffer);
5dda1712 AG	204	}
	205
	206	out:
	207	return result;
	208	}
	209
	210	static void airprime_close(struct usb_serial_port port, struct file filp)
	211	{
	212	struct airprime_private *priv = usb_get_serial_port_data(port);
	213	int i;
	214
441b62c1	215	dbg("%s - port %d", __func__, port->number);
5dda1712	216
cf0cb1ae MS	217	priv->rts_state = 0;
	218	priv->dtr_state = 0;
	219
95bef012 ON	220	mutex_lock(&port->serial->disc_mutex);
	221	if (!port->serial->disconnected)
	222	airprime_send_setup(port);
	223	mutex_lock(&port->serial->disc_mutex);
cf0cb1ae	224
5dda1712 AG	225	for (i = 0; i < NUM_READ_URBS; ++i) {
5dda1712 AG	226	usb_kill_urb (priv->read_urbp[i]);
af59cf40	227	kfree (priv->read_urbp[i]->transfer_buffer);
5dda1712 AG	228	usb_free_urb (priv->read_urbp[i]);
	229	}
	230
	231	/* free up private structure */
	232	kfree (priv);
	233	usb_set_serial_port_data(port, NULL);
	234	}
	235
	236	static int airprime_write(struct usb_serial_port *port,
	237	const unsigned char *buf, int count)
	238	{
	239	struct airprime_private *priv = usb_get_serial_port_data(port);
	240	struct usb_serial *serial = port->serial;
	241	struct urb *urb;
	242	unsigned char *buffer;
	243	unsigned long flags;
	244	int status;
441b62c1	245	dbg("%s - port %d", __func__, port->number);
5dda1712 AG	246
	247	spin_lock_irqsave(&priv->lock, flags);
	248	if (priv->outstanding_urbs > NUM_WRITE_URBS) {
	249	spin_unlock_irqrestore(&priv->lock, flags);
441b62c1	250	dbg("%s - write limit hit\n", __func__);
5dda1712 AG	251	return 0;
	252	}
	253	spin_unlock_irqrestore(&priv->lock, flags);
	254	buffer = kmalloc(count, GFP_ATOMIC);
	255	if (!buffer) {
	256	dev_err(&port->dev, "out of memory\n");
	257	return -ENOMEM;
	258	}
	259	urb = usb_alloc_urb(0, GFP_ATOMIC);
	260	if (!urb) {
	261	dev_err(&port->dev, "no more free urbs\n");
	262	kfree (buffer);
	263	return -ENOMEM;
	264	}
	265	memcpy (buffer, buf, count);
	266
441b62c1	267	usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
5dda1712 AG	268
	269	usb_fill_bulk_urb(urb, serial->dev,
	270	usb_sndbulkpipe(serial->dev,
	271	port->bulk_out_endpointAddress),
	272	buffer, count,
	273	airprime_write_bulk_callback, port);
	274
	275	/* send it down the pipe */
	276	status = usb_submit_urb(urb, GFP_ATOMIC);
	277	if (status) {
	278	dev_err(&port->dev,
	279	"%s - usb_submit_urb(write bulk) failed with status = %d\n",
441b62c1	280	__func__, status);
5dda1712 AG	281	count = status;
	282	kfree (buffer);
	283	} else {
	284	spin_lock_irqsave(&priv->lock, flags);
	285	++priv->outstanding_urbs;
	286	spin_unlock_irqrestore(&priv->lock, flags);
	287	}
	288	/* we are done with this urb, so let the host driver
	289	* really free it when it is finished with it */
	290	usb_free_urb (urb);
	291	return count;
	292	}
	293
3b86b202	294	static struct usb_driver airprime_driver = {
3b86b202 GK	295	.name = "airprime",
	296	.probe = usb_serial_probe,
	297	.disconnect = usb_serial_disconnect,
	298	.id_table = id_table,
5dda1712	299	.no_dynamic_id = 1,
3b86b202 GK	300	};
3b86b202 GK	301
ea65370d	302	static struct usb_serial_driver airprime_device = {
18fcac35 GKH	303	.driver = {
18fcac35 GKH	304	.owner = THIS_MODULE,
269bda1c	305	.name = "airprime",
18fcac35	306	},
d9b1b787	307	.usb_driver = &airprime_driver,
3b86b202	308	.id_table = id_table,
5dda1712 AG	309	.open = airprime_open,
	310	.close = airprime_close,
	311	.write = airprime_write,
3b86b202 GK	312	};
	313
	314	static int __init airprime_init(void)
	315	{
	316	int retval;
	317
5dda1712 AG	318	airprime_device.num_ports =
5dda1712 AG	319	(endpoints > 0 && endpoints <= MAX_BULK_EPS) ? endpoints : NUM_BULK_EPS;
3b86b202 GK	320	retval = usb_serial_register(&airprime_device);
	321	if (retval)
	322	return retval;
	323	retval = usb_register(&airprime_driver);
	324	if (retval)
	325	usb_serial_deregister(&airprime_device);
	326	return retval;
	327	}
	328
	329	static void __exit airprime_exit(void)
	330	{
441b62c1	331	dbg("%s", __func__);
5dda1712	332
3b86b202 GK	333	usb_deregister(&airprime_driver);
	334	usb_serial_deregister(&airprime_device);
	335	}
	336
	337	module_init(airprime_init);
	338	module_exit(airprime_exit);
	339	MODULE_LICENSE("GPL");
5dda1712 AG	340
	341	module_param(debug, bool, S_IRUGO \| S_IWUSR);
	342	MODULE_PARM_DESC(debug, "Debug enabled");
	343	module_param(buffer_size, int, 0);
	344	MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers in bytes (default 4096)");
	345	module_param(endpoints, int, 0);
	346	MODULE_PARM_DESC(endpoints, "Number of bulk EPs to configure (default 3)");