[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 */
	{ USB_DEVICE(0x0f3d, 0x0112) }, /* AirPrime CDMA Wireless PC Card */
	{ USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
	{ USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless Aircard 580 */
	{ USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
	{ USB_DEVICE(0x1410, 0x1110) }, /* Novatel Wireless Merlin CDMA */
	{ },
};
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];
};

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

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

	if (urb->status) {
		dbg("%s - nonzero read bulk status received: %d",
		    __FUNCTION__, urb->status);
		/* something happened, so free up the memory for this urb */
		if (urb->transfer_buffer) {
			kfree (urb->transfer_buffer);
			urb->transfer_buffer = NULL;
		}
		return;
	}
	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, 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",
			__FUNCTION__, result);
	return;
}

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

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

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

	if (urb->status)
		dbg("%s - nonzero write bulk status received: %d",
		    __FUNCTION__, urb->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", __FUNCTION__, 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);
	}

	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",
				__FUNCTION__);
			result = -ENOMEM;
			goto errout;
		}
		urb = usb_alloc_urb(0, GFP_KERNEL);
		if (!urb) {
			dev_err(&port->dev, "%s - no more urbs?\n",
				__FUNCTION__);
			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) {
			dev_err(&port->dev,
				"%s - failed submitting read urb %d for port %d, error %d\n",
				__FUNCTION__, i, port->number, result);
			goto errout;
		}
		/* remember this urb so we can kill it when the port is closed */
		priv->read_urbp[i] = urb;
	}
	goto out;

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

	for ( ; i >= 0; --i) {
		urb = priv->read_urbp[i];
		if (urb) {
			/* This urb was submitted successfully. So we have to
			   cancel it.
			   Unlinking the urb will invoke read_bulk_callback()
			   with an error status, so its transfer buffer will
			   be freed there */
			if (usb_unlink_urb (urb) != -EINPROGRESS) {
				/* comments in drivers/usb/core/urb.c say this
				   can only happen if the urb was never submitted,
				   or has completed already.
				   Either way we may have to free the transfer
				   buffer here. */
				if (urb->transfer_buffer) {
					kfree (urb->transfer_buffer);
					urb->transfer_buffer = NULL;
				}
			}
			usb_free_urb (urb);
		}
	}

 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", __FUNCTION__, port->number);

	/* killing the urb will invoke read_bulk_callback() with an error status,
	   so the transfer buffer will be freed there */
	for (i = 0; i < NUM_READ_URBS; ++i) {
		usb_kill_urb (priv->read_urbp[i]);
		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", __FUNCTION__, 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", __FUNCTION__);
		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, __FUNCTION__, 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",
			__FUNCTION__, 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",
	},
	.id_table =		id_table,
	.num_interrupt_in =	NUM_DONT_CARE,
	.num_bulk_in =		NUM_DONT_CARE,
	.num_bulk_out =		NUM_DONT_CARE,
	.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", __FUNCTION__);

	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 */
5dda1712 AG	21	{ USB_DEVICE(0x0f3d, 0x0112) }, /* AirPrime CDMA Wireless PC Card */
	22	{ USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
	23	{ USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
b68f7de0	24	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless Aircard 580 */
b10cee9d	25	{ USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
5dda1712	26	{ USB_DEVICE(0x1410, 0x1110) }, /* Novatel Wireless Merlin CDMA */
3b86b202 GK	27	{ },
	28	};
	29	MODULE_DEVICE_TABLE(usb, id_table);
	30
5dda1712 AG	31	#define URB_TRANSFER_BUFFER_SIZE 4096
	32	#define NUM_READ_URBS 4
	33	#define NUM_WRITE_URBS 4
	34	#define NUM_BULK_EPS 3
	35	#define MAX_BULK_EPS 6
	36
	37	/* if overridden by the user, then use their value for the size of the
	38	* read and write urbs, and the number of endpoints */
	39	static int buffer_size = URB_TRANSFER_BUFFER_SIZE;
	40	static int endpoints = NUM_BULK_EPS;
	41	static int debug;
	42	struct airprime_private {
	43	spinlock_t lock;
	44	int outstanding_urbs;
	45	int throttled;
	46	struct urb *read_urbp[NUM_READ_URBS];
	47	};
	48
	49	static void airprime_read_bulk_callback(struct urb urb, struct pt_regs regs)
	50	{
	51	struct usb_serial_port *port = urb->context;
	52	unsigned char *data = urb->transfer_buffer;
	53	struct tty_struct *tty;
	54	int result;
	55
	56	dbg("%s - port %d", __FUNCTION__, port->number);
	57
	58	if (urb->status) {
	59	dbg("%s - nonzero read bulk status received: %d",
	60	__FUNCTION__, urb->status);
	61	/* something happened, so free up the memory for this urb */
	62	if (urb->transfer_buffer) {
	63	kfree (urb->transfer_buffer);
	64	urb->transfer_buffer = NULL;
	65	}
	66	return;
	67	}
	68	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
	69
	70	tty = port->tty;
	71	if (tty && urb->actual_length) {
	72	tty_insert_flip_string (tty, data, urb->actual_length);
	73	tty_flip_buffer_push (tty);
	74	}
	75
	76	result = usb_submit_urb (urb, GFP_ATOMIC);
	77	if (result)
	78	dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n",
	79	__FUNCTION__, result);
	80	return;
	81	}
	82
	83	static void airprime_write_bulk_callback(struct urb urb, struct pt_regs regs)
	84	{
	85	struct usb_serial_port *port = urb->context;
	86	struct airprime_private *priv = usb_get_serial_port_data(port);
	87	unsigned long flags;
	88
	89	dbg("%s - port %d", __FUNCTION__, port->number);
	90
	91	/* free up the transfer buffer, as usb_free_urb() does not do this */
	92	kfree (urb->transfer_buffer);
	93
	94	if (urb->status)
95	dbg("%s - nonzero write bulk status received: %d",
96	__FUNCTION__, urb->status);
97	spin_lock_irqsave(&priv->lock, flags);
98	--priv->outstanding_urbs;
99	spin_unlock_irqrestore(&priv->lock, flags);
100
101	usb_serial_port_softint(port);
102	}
103
104	static int airprime_open(struct usb_serial_port port, struct file filp)
105	{
106	struct airprime_private *priv = usb_get_serial_port_data(port);
107	struct usb_serial *serial = port->serial;
108	struct urb *urb;
109	char *buffer = NULL;
110	int i;
111	int result = 0;
112
113	dbg("%s - port %d", __FUNCTION__, port->number);
114
115	/* initialize our private data structure if it isn't already created */
116	if (!priv) {
117	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
118	if (!priv) {
119	result = -ENOMEM;
120	goto out;
121	}
122	spin_lock_init(&priv->lock);
123	usb_set_serial_port_data(port, priv);
124	}
125
126	for (i = 0; i < NUM_READ_URBS; ++i) {
127	buffer = kmalloc(buffer_size, GFP_KERNEL);
128	if (!buffer) {
129	dev_err(&port->dev, "%s - out of memory.\n",
130	__FUNCTION__);
131	result = -ENOMEM;
132	goto errout;
133	}
134	urb = usb_alloc_urb(0, GFP_KERNEL);
135	if (!urb) {
136	dev_err(&port->dev, "%s - no more urbs?\n",
137	__FUNCTION__);
138	result = -ENOMEM;
139	goto errout;
140	}
141	usb_fill_bulk_urb(urb, serial->dev,
142	usb_rcvbulkpipe(serial->dev,
143	port->bulk_out_endpointAddress),
144	buffer, buffer_size,
145	airprime_read_bulk_callback, port);
146	result = usb_submit_urb(urb, GFP_KERNEL);
147	if (result) {
148	dev_err(&port->dev,
149	"%s - failed submitting read urb %d for port %d, error %d\n",
150	__FUNCTION__, i, port->number, result);
151	goto errout;
152	}
153	/* remember this urb so we can kill it when the port is closed */
154	priv->read_urbp[i] = urb;
155	}
156	goto out;
157
158	errout:
159	/* some error happened, cancel any submitted urbs and clean up anything that
160	got allocated successfully */
161
162	for ( ; i >= 0; --i) {
163	urb = priv->read_urbp[i];
164	if (urb) {
165	/* This urb was submitted successfully. So we have to
166	cancel it.
167	Unlinking the urb will invoke read_bulk_callback()
168	with an error status, so its transfer buffer will
169	be freed there */
170	if (usb_unlink_urb (urb) != -EINPROGRESS) {
171	/* comments in drivers/usb/core/urb.c say this
172	can only happen if the urb was never submitted,
173	or has completed already.
174	Either way we may have to free the transfer
175	buffer here. */
176	if (urb->transfer_buffer) {
177	kfree (urb->transfer_buffer);
178	urb->transfer_buffer = NULL;
179	}
180	}
181	usb_free_urb (urb);
182	}
183	}
184
185	out:
186	return result;
187	}
188
189	static void airprime_close(struct usb_serial_port port, struct file filp)
190	{
191	struct airprime_private *priv = usb_get_serial_port_data(port);
192	int i;
193
194	dbg("%s - port %d", __FUNCTION__, port->number);
195
196	/* killing the urb will invoke read_bulk_callback() with an error status,
197	so the transfer buffer will be freed there */
198	for (i = 0; i < NUM_READ_URBS; ++i) {
199	usb_kill_urb (priv->read_urbp[i]);
200	usb_free_urb (priv->read_urbp[i]);
201	}
202
203	/* free up private structure */
204	kfree (priv);
205	usb_set_serial_port_data(port, NULL);
206	}
207
208	static int airprime_write(struct usb_serial_port *port,
209	const unsigned char *buf, int count)
210	{
211	struct airprime_private *priv = usb_get_serial_port_data(port);
212	struct usb_serial *serial = port->serial;
213	struct urb *urb;
214	unsigned char *buffer;
215	unsigned long flags;
216	int status;
217	dbg("%s - port %d", __FUNCTION__, port->number);
218
219	spin_lock_irqsave(&priv->lock, flags);
220	if (priv->outstanding_urbs > NUM_WRITE_URBS) {
221	spin_unlock_irqrestore(&priv->lock, flags);
222	dbg("%s - write limit hit\n", __FUNCTION__);
223	return 0;
224	}
225	spin_unlock_irqrestore(&priv->lock, flags);
226	buffer = kmalloc(count, GFP_ATOMIC);
227	if (!buffer) {
228	dev_err(&port->dev, "out of memory\n");
229	return -ENOMEM;
230	}
231	urb = usb_alloc_urb(0, GFP_ATOMIC);
232	if (!urb) {
233	dev_err(&port->dev, "no more free urbs\n");
234	kfree (buffer);
235	return -ENOMEM;
236	}
237	memcpy (buffer, buf, count);
238
239	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
240
241	usb_fill_bulk_urb(urb, serial->dev,
242	usb_sndbulkpipe(serial->dev,
243	port->bulk_out_endpointAddress),
244	buffer, count,
245	airprime_write_bulk_callback, port);
246
247	/* send it down the pipe */
248	status = usb_submit_urb(urb, GFP_ATOMIC);
249	if (status) {
250	dev_err(&port->dev,
251	"%s - usb_submit_urb(write bulk) failed with status = %d\n",
252	__FUNCTION__, status);
253	count = status;
254	kfree (buffer);
255	} else {
256	spin_lock_irqsave(&priv->lock, flags);
257	++priv->outstanding_urbs;
258	spin_unlock_irqrestore(&priv->lock, flags);
259	}
260	/* we are done with this urb, so let the host driver
261	* really free it when it is finished with it */
262	usb_free_urb (urb);
263	return count;
264	}
265
3b86b202	266	static struct usb_driver airprime_driver = {
3b86b202 GK	267	.name = "airprime",
	268	.probe = usb_serial_probe,
	269	.disconnect = usb_serial_disconnect,
	270	.id_table = id_table,
5dda1712	271	.no_dynamic_id = 1,
3b86b202 GK	272	};
3b86b202 GK	273
ea65370d	274	static struct usb_serial_driver airprime_device = {
18fcac35 GKH	275	.driver = {
18fcac35 GKH	276	.owner = THIS_MODULE,
269bda1c	277	.name = "airprime",
18fcac35	278	},
3b86b202 GK	279	.id_table = id_table,
	280	.num_interrupt_in = NUM_DONT_CARE,
	281	.num_bulk_in = NUM_DONT_CARE,
	282	.num_bulk_out = NUM_DONT_CARE,
5dda1712 AG	283	.open = airprime_open,
	284	.close = airprime_close,
	285	.write = airprime_write,
3b86b202 GK	286	};
	287
	288	static int __init airprime_init(void)
	289	{
	290	int retval;
	291
5dda1712 AG	292	airprime_device.num_ports =
5dda1712 AG	293	(endpoints > 0 && endpoints <= MAX_BULK_EPS) ? endpoints : NUM_BULK_EPS;
3b86b202 GK	294	retval = usb_serial_register(&airprime_device);
	295	if (retval)
	296	return retval;
	297	retval = usb_register(&airprime_driver);
	298	if (retval)
	299	usb_serial_deregister(&airprime_device);
	300	return retval;
	301	}
	302
	303	static void __exit airprime_exit(void)
	304	{
5dda1712 AG	305	dbg("%s", __FUNCTION__);
5dda1712 AG	306
3b86b202 GK	307	usb_deregister(&airprime_driver);
	308	usb_serial_deregister(&airprime_device);
	309	}
	310
	311	module_init(airprime_init);
	312	module_exit(airprime_exit);
	313	MODULE_LICENSE("GPL");
5dda1712 AG	314
	315	module_param(debug, bool, S_IRUGO \| S_IWUSR);
	316	MODULE_PARM_DESC(debug, "Debug enabled");
	317	module_param(buffer_size, int, 0);
	318	MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers in bytes (default 4096)");
	319	module_param(endpoints, int, 0);
	320	MODULE_PARM_DESC(endpoints, "Number of bulk EPs to configure (default 3)");