[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / usb / serial / generic.c

/*
 * USB Serial Converter Generic functions
 *
 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
 *
 *	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/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
#include <asm/uaccess.h>

static int debug;

#ifdef CONFIG_USB_SERIAL_GENERIC
static __u16 vendor  = 0x05f9;
static __u16 product = 0xffff;

module_param(vendor, ushort, 0);
MODULE_PARM_DESC(vendor, "User specified USB idVendor");

module_param(product, ushort, 0);
MODULE_PARM_DESC(product, "User specified USB idProduct");

static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */

/* All of the device info needed for the Generic Serial Converter */
struct usb_serial_driver usb_serial_generic_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"generic",
	},
	.id_table =		generic_device_ids,
	.num_interrupt_in =	NUM_DONT_CARE,
	.num_bulk_in =		NUM_DONT_CARE,
	.num_bulk_out =		NUM_DONT_CARE,
	.num_ports =		1,
	.shutdown =		usb_serial_generic_shutdown,
};

/* we want to look at all devices, as the vendor/product id can change
 * depending on the command line argument */
static struct usb_device_id generic_serial_ids[] = {
	{.driver_info = 42},
	{}
};

static int generic_probe(struct usb_interface *interface,
			       const struct usb_device_id *id)
{
	const struct usb_device_id *id_pattern;

	id_pattern = usb_match_id(interface, generic_device_ids);
	if (id_pattern != NULL)
		return usb_serial_probe(interface, id);
	return -ENODEV;
}

static struct usb_driver generic_driver = {
	.name =		"usbserial_generic",
	.probe =	generic_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	generic_serial_ids,
	.no_dynamic_id = 	1,
};
#endif

int usb_serial_generic_register (int _debug)
{
	int retval = 0;

	debug = _debug;
#ifdef CONFIG_USB_SERIAL_GENERIC
	generic_device_ids[0].idVendor = vendor;
	generic_device_ids[0].idProduct = product;
	generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT;

	/* register our generic driver with ourselves */
	retval = usb_serial_register (&usb_serial_generic_device);
	if (retval)
		goto exit;
	retval = usb_register(&generic_driver);
	if (retval)
		usb_serial_deregister(&usb_serial_generic_device);
exit:
#endif
	return retval;
}

void usb_serial_generic_deregister (void)
{
#ifdef CONFIG_USB_SERIAL_GENERIC
	/* remove our generic driver */
	usb_deregister(&generic_driver);
	usb_serial_deregister (&usb_serial_generic_device);
#endif
}

int usb_serial_generic_open (struct usb_serial_port *port, struct file *filp)
{
	struct usb_serial *serial = port->serial;
	int result = 0;

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

	/* force low_latency on so that our tty_push actually forces the data through, 
	   otherwise it is scheduled, and with high data rates (like with OHCI) data
	   can get lost. */
	if (port->tty)
		port->tty->low_latency = 1;

	/* if we have a bulk interrupt, start reading from it */
	if (serial->num_bulk_in) {
		/* Start reading from the device */
		usb_fill_bulk_urb (port->read_urb, serial->dev,
				   usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress),
				   port->read_urb->transfer_buffer,
				   port->read_urb->transfer_buffer_length,
				   ((serial->type->read_bulk_callback) ?
				     serial->type->read_bulk_callback :
				     usb_serial_generic_read_bulk_callback),
				   port);
		result = usb_submit_urb(port->read_urb, GFP_KERNEL);
		if (result)
			dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
	}

	return result;
}
EXPORT_SYMBOL_GPL(usb_serial_generic_open);

static void generic_cleanup (struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;

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

	if (serial->dev) {
		/* shutdown any bulk reads that might be going on */
		if (serial->num_bulk_out)
			usb_kill_urb(port->write_urb);
		if (serial->num_bulk_in)
			usb_kill_urb(port->read_urb);
	}
}

void usb_serial_generic_close (struct usb_serial_port *port, struct file * filp)
{
	dbg("%s - port %d", __FUNCTION__, port->number);
	generic_cleanup (port);
}

int usb_serial_generic_write(struct usb_serial_port *port, const unsigned char *buf, int count)
{
	struct usb_serial *serial = port->serial;
	int result;
	unsigned char *data;

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

	if (count == 0) {
		dbg("%s - write request of 0 bytes", __FUNCTION__);
		return (0);
	}

	/* only do something if we have a bulk out endpoint */
	if (serial->num_bulk_out) {
		spin_lock_bh(&port->lock);
		if (port->write_urb_busy) {
			spin_unlock_bh(&port->lock);
			dbg("%s - already writing", __FUNCTION__);
			return 0;
		}
		port->write_urb_busy = 1;
		spin_unlock_bh(&port->lock);

		count = (count > port->bulk_out_size) ? port->bulk_out_size : count;

		memcpy (port->write_urb->transfer_buffer, buf, count);
		data = port->write_urb->transfer_buffer;
		usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, data);

		/* set up our urb */
		usb_fill_bulk_urb (port->write_urb, serial->dev,
				   usb_sndbulkpipe (serial->dev,
						    port->bulk_out_endpointAddress),
				   port->write_urb->transfer_buffer, count,
				   ((serial->type->write_bulk_callback) ? 
				     serial->type->write_bulk_callback :
				     usb_serial_generic_write_bulk_callback), port);

		/* send the data out the bulk port */
		port->write_urb_busy = 1;
		result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
		if (result) {
			dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
			/* don't have to grab the lock here, as we will retry if != 0 */
			port->write_urb_busy = 0;
		} else
			result = count;

		return result;
	}

	/* no bulk out, so return 0 bytes written */
	return 0;
}

int usb_serial_generic_write_room (struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	int room = 0;

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

	if (serial->num_bulk_out) {
		if (!(port->write_urb_busy))
			room = port->bulk_out_size;
	}

	dbg("%s - returns %d", __FUNCTION__, room);
	return (room);
}

int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	int chars = 0;

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

	if (serial->num_bulk_out) {
		if (port->write_urb_busy)
			chars = port->write_urb->transfer_buffer_length;
	}

	dbg("%s - returns %d", __FUNCTION__, chars);
	return (chars);
}

void usb_serial_generic_read_bulk_callback (struct urb *urb)
{
	struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
	struct usb_serial *serial = port->serial;
	struct tty_struct *tty;
	unsigned char *data = urb->transfer_buffer;
	int result;

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

	if (urb->status) {
		dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
		return;
	}

	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);

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

	/* Continue trying to always read  */
	usb_fill_bulk_urb (port->read_urb, serial->dev,
			   usb_rcvbulkpipe (serial->dev,
				   	    port->bulk_in_endpointAddress),
			   port->read_urb->transfer_buffer,
			   port->read_urb->transfer_buffer_length,
			   ((serial->type->read_bulk_callback) ? 
			     serial->type->read_bulk_callback : 
			     usb_serial_generic_read_bulk_callback), port);
	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
	if (result)
		dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
}
EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback);

void usb_serial_generic_write_bulk_callback (struct urb *urb)
{
	struct usb_serial_port *port = (struct usb_serial_port *)urb->context;

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

	port->write_urb_busy = 0;
	if (urb->status) {
		dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
		return;
	}

	usb_serial_port_softint(port);
}
EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback);

void usb_serial_generic_shutdown (struct usb_serial *serial)
{
	int i;

	dbg("%s", __FUNCTION__);

	/* stop reads and writes on all ports */
	for (i=0; i < serial->num_ports; ++i) {
		generic_cleanup(serial->port[i]);
	}
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* USB Serial Converter Generic functions
	3	*
	4	* Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
	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
1da177e4 LT	12	#include <linux/kernel.h>
	13	#include <linux/errno.h>
	14	#include <linux/slab.h>
	15	#include <linux/tty.h>
	16	#include <linux/tty_flip.h>
	17	#include <linux/module.h>
	18	#include <linux/moduleparam.h>
	19	#include <linux/usb.h>
a969888c	20	#include <linux/usb/serial.h>
1da177e4	21	#include <asm/uaccess.h>
1da177e4 LT	22
	23	static int debug;
	24
	25	#ifdef CONFIG_USB_SERIAL_GENERIC
	26	static __u16 vendor = 0x05f9;
	27	static __u16 product = 0xffff;
	28
	29	module_param(vendor, ushort, 0);
	30	MODULE_PARM_DESC(vendor, "User specified USB idVendor");
	31
	32	module_param(product, ushort, 0);
	33	MODULE_PARM_DESC(product, "User specified USB idProduct");
	34
	35	static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */
	36
	37	/* All of the device info needed for the Generic Serial Converter */
ea65370d	38	struct usb_serial_driver usb_serial_generic_device = {
18fcac35 GKH	39	.driver = {
18fcac35 GKH	40	.owner = THIS_MODULE,
269bda1c	41	.name = "generic",
18fcac35	42	},
1da177e4 LT	43	.id_table = generic_device_ids,
	44	.num_interrupt_in = NUM_DONT_CARE,
	45	.num_bulk_in = NUM_DONT_CARE,
	46	.num_bulk_out = NUM_DONT_CARE,
	47	.num_ports = 1,
	48	.shutdown = usb_serial_generic_shutdown,
	49	};
	50
	51	/* we want to look at all devices, as the vendor/product id can change
	52	* depending on the command line argument */
	53	static struct usb_device_id generic_serial_ids[] = {
	54	{.driver_info = 42},
	55	{}
	56	};
	57
	58	static int generic_probe(struct usb_interface *interface,
	59	const struct usb_device_id *id)
	60	{
	61	const struct usb_device_id *id_pattern;
	62
	63	id_pattern = usb_match_id(interface, generic_device_ids);
	64	if (id_pattern != NULL)
	65	return usb_serial_probe(interface, id);
	66	return -ENODEV;
	67	}
	68
	69	static struct usb_driver generic_driver = {
1da177e4 LT	70	.name = "usbserial_generic",
	71	.probe = generic_probe,
	72	.disconnect = usb_serial_disconnect,
	73	.id_table = generic_serial_ids,
ba9dc657	74	.no_dynamic_id = 1,
1da177e4 LT	75	};
	76	#endif
	77
	78	int usb_serial_generic_register (int _debug)
	79	{
	80	int retval = 0;
	81
	82	debug = _debug;
	83	#ifdef CONFIG_USB_SERIAL_GENERIC
	84	generic_device_ids[0].idVendor = vendor;
	85	generic_device_ids[0].idProduct = product;
	86	generic_device_ids[0].match_flags = USB_DEVICE_ID_MATCH_VENDOR \| USB_DEVICE_ID_MATCH_PRODUCT;
	87
	88	/* register our generic driver with ourselves */
	89	retval = usb_serial_register (&usb_serial_generic_device);
	90	if (retval)
	91	goto exit;
	92	retval = usb_register(&generic_driver);
	93	if (retval)
	94	usb_serial_deregister(&usb_serial_generic_device);
	95	exit:
	96	#endif
	97	return retval;
	98	}
	99
	100	void usb_serial_generic_deregister (void)
	101	{
	102	#ifdef CONFIG_USB_SERIAL_GENERIC
	103	/* remove our generic driver */
	104	usb_deregister(&generic_driver);
	105	usb_serial_deregister (&usb_serial_generic_device);
	106	#endif
	107	}
	108
	109	int usb_serial_generic_open (struct usb_serial_port port, struct file filp)
	110	{
	111	struct usb_serial *serial = port->serial;
	112	int result = 0;
	113
	114	dbg("%s - port %d", __FUNCTION__, port->number);
	115
	116	/* force low_latency on so that our tty_push actually forces the data through,
	117	otherwise it is scheduled, and with high data rates (like with OHCI) data
	118	can get lost. */
	119	if (port->tty)
	120	port->tty->low_latency = 1;
	121
	122	/* if we have a bulk interrupt, start reading from it */
	123	if (serial->num_bulk_in) {
	124	/* Start reading from the device */
	125	usb_fill_bulk_urb (port->read_urb, serial->dev,
	126	usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress),
	127	port->read_urb->transfer_buffer,
	128	port->read_urb->transfer_buffer_length,
	129	((serial->type->read_bulk_callback) ?
	130	serial->type->read_bulk_callback :
	131	usb_serial_generic_read_bulk_callback),
	132	port);
	133	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
	134	if (result)
	135	dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
	136	}
	137
	138	return result;
139	}
815ddc99	140	EXPORT_SYMBOL_GPL(usb_serial_generic_open);
1da177e4 LT	141
	142	static void generic_cleanup (struct usb_serial_port *port)
	143	{
	144	struct usb_serial *serial = port->serial;
	145
	146	dbg("%s - port %d", __FUNCTION__, port->number);
	147
	148	if (serial->dev) {
	149	/* shutdown any bulk reads that might be going on */
	150	if (serial->num_bulk_out)
	151	usb_kill_urb(port->write_urb);
	152	if (serial->num_bulk_in)
	153	usb_kill_urb(port->read_urb);
	154	}
	155	}
	156
	157	void usb_serial_generic_close (struct usb_serial_port port, struct file filp)
	158	{
	159	dbg("%s - port %d", __FUNCTION__, port->number);
	160	generic_cleanup (port);
	161	}
	162
	163	int usb_serial_generic_write(struct usb_serial_port port, const unsigned char buf, int count)
	164	{
	165	struct usb_serial *serial = port->serial;
	166	int result;
	167	unsigned char *data;
	168
	169	dbg("%s - port %d", __FUNCTION__, port->number);
	170
	171	if (count == 0) {
	172	dbg("%s - write request of 0 bytes", __FUNCTION__);
	173	return (0);
	174	}
	175
	176	/* only do something if we have a bulk out endpoint */
	177	if (serial->num_bulk_out) {
e81ee637	178	spin_lock_bh(&port->lock);
507ca9bc	179	if (port->write_urb_busy) {
e81ee637	180	spin_unlock_bh(&port->lock);
1da177e4	181	dbg("%s - already writing", __FUNCTION__);
507ca9bc	182	return 0;
1da177e4	183	}
507ca9bc	184	port->write_urb_busy = 1;
e81ee637	185	spin_unlock_bh(&port->lock);
1da177e4 LT	186
	187	count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
	188
	189	memcpy (port->write_urb->transfer_buffer, buf, count);
	190	data = port->write_urb->transfer_buffer;
	191	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, data);
	192
	193	/* set up our urb */
	194	usb_fill_bulk_urb (port->write_urb, serial->dev,
	195	usb_sndbulkpipe (serial->dev,
	196	port->bulk_out_endpointAddress),
	197	port->write_urb->transfer_buffer, count,
	198	((serial->type->write_bulk_callback) ?
	199	serial->type->write_bulk_callback :
	200	usb_serial_generic_write_bulk_callback), port);
	201
	202	/* send the data out the bulk port */
507ca9bc	203	port->write_urb_busy = 1;
1da177e4	204	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
507ca9bc	205	if (result) {
1da177e4	206	dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
507ca9bc GKH	207	/* don't have to grab the lock here, as we will retry if != 0 */
	208	port->write_urb_busy = 0;
	209	} else
1da177e4 LT	210	result = count;
	211
	212	return result;
	213	}
	214
	215	/* no bulk out, so return 0 bytes written */
507ca9bc	216	return 0;
1da177e4 LT	217	}
	218
	219	int usb_serial_generic_write_room (struct usb_serial_port *port)
	220	{
	221	struct usb_serial *serial = port->serial;
	222	int room = 0;
	223
	224	dbg("%s - port %d", __FUNCTION__, port->number);
507ca9bc	225
1da177e4	226	if (serial->num_bulk_out) {
7a3ca7d2	227	if (!(port->write_urb_busy))
1da177e4 LT	228	room = port->bulk_out_size;
	229	}
	230
	231	dbg("%s - returns %d", __FUNCTION__, room);
	232	return (room);
	233	}
	234
	235	int usb_serial_generic_chars_in_buffer (struct usb_serial_port *port)
	236	{
	237	struct usb_serial *serial = port->serial;
	238	int chars = 0;
	239
	240	dbg("%s - port %d", __FUNCTION__, port->number);
	241
	242	if (serial->num_bulk_out) {
507ca9bc	243	if (port->write_urb_busy)
1da177e4 LT	244	chars = port->write_urb->transfer_buffer_length;
	245	}
	246
	247	dbg("%s - returns %d", __FUNCTION__, chars);
	248	return (chars);
	249	}
	250
7d12e780	251	void usb_serial_generic_read_bulk_callback (struct urb *urb)
1da177e4 LT	252	{
	253	struct usb_serial_port port = (struct usb_serial_port )urb->context;
	254	struct usb_serial *serial = port->serial;
	255	struct tty_struct *tty;
	256	unsigned char *data = urb->transfer_buffer;
1da177e4 LT	257	int result;
	258
	259	dbg("%s - port %d", __FUNCTION__, port->number);
	260
	261	if (urb->status) {
	262	dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
	263	return;
	264	}
	265
	266	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
	267
	268	tty = port->tty;
	269	if (tty && urb->actual_length) {
33f0f88f AC	270	tty_buffer_request_room(tty, urb->actual_length);
33f0f88f AC	271	tty_insert_flip_string(tty, data, urb->actual_length);
1da177e4 LT	272	tty_flip_buffer_push(tty);
	273	}
	274
	275	/* Continue trying to always read */
	276	usb_fill_bulk_urb (port->read_urb, serial->dev,
	277	usb_rcvbulkpipe (serial->dev,
	278	port->bulk_in_endpointAddress),
	279	port->read_urb->transfer_buffer,
	280	port->read_urb->transfer_buffer_length,
	281	((serial->type->read_bulk_callback) ?
	282	serial->type->read_bulk_callback :
	283	usb_serial_generic_read_bulk_callback), port);
	284	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
	285	if (result)
	286	dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
	287	}
166ffccf	288	EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback);
1da177e4	289
7d12e780	290	void usb_serial_generic_write_bulk_callback (struct urb *urb)
1da177e4 LT	291	{
	292	struct usb_serial_port port = (struct usb_serial_port )urb->context;
	293
	294	dbg("%s - port %d", __FUNCTION__, port->number);
	295
507ca9bc	296	port->write_urb_busy = 0;
1da177e4 LT	297	if (urb->status) {
	298	dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
	299	return;
	300	}
	301
cf2c7481	302	usb_serial_port_softint(port);
1da177e4	303	}
bb833986	304	EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback);
1da177e4 LT	305
	306	void usb_serial_generic_shutdown (struct usb_serial *serial)
	307	{
	308	int i;
	309
	310	dbg("%s", __FUNCTION__);
	311
	312	/* stop reads and writes on all ports */
	313	for (i=0; i < serial->num_ports; ++i) {
	314	generic_cleanup(serial->port[i]);
	315	}
	316	}
	317