[mirror_ubuntu-bionic-kernel.git] / drivers / usb / serial / omninet.c

/*
 * USB ZyXEL omni.net LCD PLUS driver
 *
 *	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.
 *
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
 *
 * Please report both successes and troubles to the author at omninet@kroah.com
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/uaccess.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>

static bool debug;

/*
 * Version Information
 */
#define DRIVER_VERSION "v1.1"
#define DRIVER_AUTHOR "Alessandro Zummo"
#define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"

#define ZYXEL_VENDOR_ID		0x0586
#define ZYXEL_OMNINET_ID	0x1000
/* This one seems to be a re-branded ZyXEL device */
#define BT_IGNITIONPRO_ID	0x2000

/* function prototypes */
static int  omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
static void omninet_close(struct usb_serial_port *port);
static void omninet_read_bulk_callback(struct urb *urb);
static void omninet_write_bulk_callback(struct urb *urb);
static int  omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
				const unsigned char *buf, int count);
static int  omninet_write_room(struct tty_struct *tty);
static void omninet_disconnect(struct usb_serial *serial);
static void omninet_release(struct usb_serial *serial);
static int omninet_attach(struct usb_serial *serial);

static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
	{ USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
	{ }						/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, id_table);

static struct usb_serial_driver zyxel_omninet_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"omninet",
	},
	.description =		"ZyXEL - omni.net lcd plus usb",
	.id_table =		id_table,
	.num_ports =		1,
	.attach =		omninet_attach,
	.open =			omninet_open,
	.close =		omninet_close,
	.write =		omninet_write,
	.write_room =		omninet_write_room,
	.read_bulk_callback =	omninet_read_bulk_callback,
	.write_bulk_callback =	omninet_write_bulk_callback,
	.disconnect =		omninet_disconnect,
	.release =		omninet_release,
};

static struct usb_serial_driver * const serial_drivers[] = {
	&zyxel_omninet_device, NULL
};


/* The protocol.
 *
 * The omni.net always exchange 64 bytes of data with the host. The first
 * four bytes are the control header, you can see it in the above structure.
 *
 * oh_seq is a sequence number. Don't know if/how it's used.
 * oh_len is the length of the data bytes in the packet.
 * oh_xxx Bit-mapped, related to handshaking and status info.
 *	I normally set it to 0x03 in trasmitted frames.
 *	7: Active when the TA is in a CONNECTed state.
 *	6: unknown
 *	5: handshaking, unknown
 *	4: handshaking, unknown
 *	3: unknown, usually 0
 *	2: unknown, usually 0
 *	1: handshaking, unknown, usually set to 1 in trasmitted frames
 *	0: handshaking, unknown, usually set to 1 in trasmitted frames
 * oh_pad Probably a pad byte.
 *
 * After the header you will find data bytes if oh_len was greater than zero.
 *
 */

struct omninet_header {
	__u8	oh_seq;
	__u8	oh_len;
	__u8	oh_xxx;
	__u8	oh_pad;
};

struct omninet_data {
	__u8	od_outseq;	/* Sequence number for bulk_out URBs */
};

static int omninet_attach(struct usb_serial *serial)
{
	struct omninet_data *od;
	struct usb_serial_port *port = serial->port[0];

	od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
	if (!od) {
		dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
			__func__, sizeof(struct omninet_data));
		return -ENOMEM;
	}
	usb_set_serial_port_data(port, od);
	return 0;
}

static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
{
	struct usb_serial	*serial = port->serial;
	struct usb_serial_port	*wport;
	int			result = 0;

	wport = serial->port[1];
	tty_port_tty_set(&wport->port, tty);

	/* Start reading from the device */
	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
	if (result)
		dev_err(&port->dev,
			"%s - failed submitting read urb, error %d\n",
			__func__, result);
	return result;
}

static void omninet_close(struct usb_serial_port *port)
{
	usb_kill_urb(port->read_urb);
}


#define OMNINET_DATAOFFSET	0x04
#define OMNINET_HEADERLEN	sizeof(struct omninet_header)
#define OMNINET_BULKOUTSIZE 	(64 - OMNINET_HEADERLEN)

static void omninet_read_bulk_callback(struct urb *urb)
{
	struct usb_serial_port 	*port 	= urb->context;
	unsigned char 		*data 	= urb->transfer_buffer;
	struct omninet_header 	*header = (struct omninet_header *) &data[0];
	int status = urb->status;
	int result;
	int i;

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

	if (debug && header->oh_xxx != 0x30) {
		if (urb->actual_length) {
			printk(KERN_DEBUG "%s: omninet_read %d: ",
			       __FILE__, header->oh_len);
			for (i = 0; i < (header->oh_len +
						OMNINET_HEADERLEN); i++)
				printk("%.2x ", data[i]);
			printk("\n");
		}
	}

	if (urb->actual_length && header->oh_len) {
		struct tty_struct *tty = tty_port_tty_get(&port->port);
		tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
							header->oh_len);
		tty_flip_buffer_push(tty);
		tty_kref_put(tty);
	}

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

static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
					const unsigned char *buf, int count)
{
	struct usb_serial *serial = port->serial;
	struct usb_serial_port *wport = serial->port[1];

	struct omninet_data *od = usb_get_serial_port_data(port);
	struct omninet_header *header = (struct omninet_header *)
					wport->write_urb->transfer_buffer;

	int			result;

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

	if (!test_and_clear_bit(0, &port->write_urbs_free)) {
		dbg("%s - already writing", __func__);
		return 0;
	}

	count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;

	memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
								buf, count);

	usb_serial_debug_data(debug, &port->dev, __func__, count,
					wport->write_urb->transfer_buffer);

	header->oh_seq 	= od->od_outseq++;
	header->oh_len 	= count;
	header->oh_xxx  = 0x03;
	header->oh_pad 	= 0x00;

	/* send the data out the bulk port, always 64 bytes */
	wport->write_urb->transfer_buffer_length = 64;

	result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
	if (result) {
		set_bit(0, &wport->write_urbs_free);
		dev_err_console(port,
			"%s - failed submitting write urb, error %d\n",
			__func__, result);
	} else
		result = count;

	return result;
}


static int omninet_write_room(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct usb_serial 	*serial = port->serial;
	struct usb_serial_port 	*wport 	= serial->port[1];

	int room = 0; /* Default: no room */

	if (test_bit(0, &wport->write_urbs_free))
		room = wport->bulk_out_size - OMNINET_HEADERLEN;

	dbg("%s - returns %d", __func__, room);

	return room;
}

static void omninet_write_bulk_callback(struct urb *urb)
{
/*	struct omninet_header	*header = (struct omninet_header  *)
						urb->transfer_buffer; */
	struct usb_serial_port 	*port   =  urb->context;
	int status = urb->status;

	set_bit(0, &port->write_urbs_free);
	if (status) {
		dbg("%s - nonzero write bulk status received: %d",
		    __func__, status);
		return;
	}

	usb_serial_port_softint(port);
}


static void omninet_disconnect(struct usb_serial *serial)
{
	struct usb_serial_port *wport = serial->port[1];

	usb_kill_urb(wport->write_urb);
}


static void omninet_release(struct usb_serial *serial)
{
	struct usb_serial_port *port = serial->port[0];

	kfree(usb_get_serial_port_data(port));
}

module_usb_serial_driver(serial_drivers, id_table);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* USB ZyXEL omni.net LCD PLUS driver
	3	*
4d0dce3e GKH	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License version
	6	* 2 as published by the Free Software Foundation.
1da177e4	7	*
f89d0dff AC	8	* See Documentation/usb/usb-serial.txt for more information on using this
f89d0dff AC	9	* driver
1da177e4 LT	10	*
1da177e4 LT	11	* Please report both successes and troubles to the author at omninet@kroah.com
1da177e4 LT	12	*/
1da177e4 LT	13
1da177e4 LT	14	#include <linux/kernel.h>
	15	#include <linux/errno.h>
	16	#include <linux/init.h>
	17	#include <linux/slab.h>
	18	#include <linux/tty.h>
	19	#include <linux/tty_driver.h>
	20	#include <linux/tty_flip.h>
	21	#include <linux/module.h>
f89d0dff	22	#include <linux/uaccess.h>
1da177e4	23	#include <linux/usb.h>
a969888c	24	#include <linux/usb/serial.h>
1da177e4	25
90ab5ee9	26	static bool debug;
1da177e4 LT	27
	28	/*
	29	* Version Information
	30	*/
	31	#define DRIVER_VERSION "v1.1"
	32	#define DRIVER_AUTHOR "Alessandro Zummo"
	33	#define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
	34
	35	#define ZYXEL_VENDOR_ID 0x0586
	36	#define ZYXEL_OMNINET_ID 0x1000
f89d0dff AC	37	/* This one seems to be a re-branded ZyXEL device */
f89d0dff AC	38	#define BT_IGNITIONPRO_ID 0x2000
1da177e4 LT	39
1da177e4 LT	40	/* function prototypes */
a509a7e4	41	static int omninet_open(struct tty_struct tty, struct usb_serial_port port);
335f8514	42	static void omninet_close(struct usb_serial_port *port);
f89d0dff AC	43	static void omninet_read_bulk_callback(struct urb *urb);
	44	static void omninet_write_bulk_callback(struct urb *urb);
	45	static int omninet_write(struct tty_struct tty, struct usb_serial_port port,
	46	const unsigned char *buf, int count);
	47	static int omninet_write_room(struct tty_struct *tty);
f9c99bb8 AS	48	static void omninet_disconnect(struct usb_serial *serial);
f9c99bb8 AS	49	static void omninet_release(struct usb_serial *serial);
f89d0dff AC	50	static int omninet_attach(struct usb_serial *serial);
f89d0dff AC	51
7d40d7e8	52	static const struct usb_device_id id_table[] = {
1da177e4 LT	53	{ USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
	54	{ USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
	55	{ } /* Terminating entry */
	56	};
f89d0dff	57	MODULE_DEVICE_TABLE(usb, id_table);
1da177e4	58
ea65370d	59	static struct usb_serial_driver zyxel_omninet_device = {
18fcac35 GKH	60	.driver = {
18fcac35 GKH	61	.owner = THIS_MODULE,
269bda1c	62	.name = "omninet",
18fcac35	63	},
269bda1c	64	.description = "ZyXEL - omni.net lcd plus usb",
1da177e4	65	.id_table = id_table,
1da177e4	66	.num_ports = 1,
5ec1862e	67	.attach = omninet_attach,
1da177e4 LT	68	.open = omninet_open,
	69	.close = omninet_close,
	70	.write = omninet_write,
	71	.write_room = omninet_write_room,
	72	.read_bulk_callback = omninet_read_bulk_callback,
	73	.write_bulk_callback = omninet_write_bulk_callback,
f9c99bb8 AS	74	.disconnect = omninet_disconnect,
f9c99bb8 AS	75	.release = omninet_release,
1da177e4 LT	76	};
1da177e4 LT	77
f667ddad AS	78	static struct usb_serial_driver * const serial_drivers[] = {
	79	&zyxel_omninet_device, NULL
	80	};
	81
1da177e4 LT	82
	83	/* The protocol.
	84	*
	85	* The omni.net always exchange 64 bytes of data with the host. The first
	86	* four bytes are the control header, you can see it in the above structure.
	87	*
	88	* oh_seq is a sequence number. Don't know if/how it's used.
	89	* oh_len is the length of the data bytes in the packet.
	90	* oh_xxx Bit-mapped, related to handshaking and status info.
	91	* I normally set it to 0x03 in trasmitted frames.
	92	* 7: Active when the TA is in a CONNECTed state.
	93	* 6: unknown
	94	* 5: handshaking, unknown
	95	* 4: handshaking, unknown
	96	* 3: unknown, usually 0
	97	* 2: unknown, usually 0
	98	* 1: handshaking, unknown, usually set to 1 in trasmitted frames
	99	* 0: handshaking, unknown, usually set to 1 in trasmitted frames
	100	* oh_pad Probably a pad byte.
	101	*
	102	* After the header you will find data bytes if oh_len was greater than zero.
	103	*
	104	*/
	105
f89d0dff	106	struct omninet_header {
1da177e4 LT	107	__u8 oh_seq;
	108	__u8 oh_len;
	109	__u8 oh_xxx;
	110	__u8 oh_pad;
	111	};
	112
f89d0dff AC	113	struct omninet_data {
f89d0dff AC	114	__u8 od_outseq; /* Sequence number for bulk_out URBs */
1da177e4 LT	115	};
1da177e4 LT	116
f89d0dff	117	static int omninet_attach(struct usb_serial *serial)
5ec1862e ON	118	{
	119	struct omninet_data *od;
	120	struct usb_serial_port *port = serial->port[0];
	121
f89d0dff AC	122	od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
f89d0dff AC	123	if (!od) {
194343d9 GKH	124	dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
194343d9 GKH	125	__func__, sizeof(struct omninet_data));
5ec1862e ON	126	return -ENOMEM;
	127	}
	128	usb_set_serial_port_data(port, od);
	129	return 0;
	130	}
	131
a509a7e4	132	static int omninet_open(struct tty_struct tty, struct usb_serial_port port)
1da177e4 LT	133	{
	134	struct usb_serial *serial = port->serial;
	135	struct usb_serial_port *wport;
1da177e4 LT	136	int result = 0;
1da177e4 LT	137
1da177e4	138	wport = serial->port[1];
4a90f09b	139	tty_port_tty_set(&wport->port, tty);
1da177e4 LT	140
1da177e4 LT	141	/* Start reading from the device */
1da177e4	142	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
f89d0dff	143	if (result)
194343d9 GKH	144	dev_err(&port->dev,
	145	"%s - failed submitting read urb, error %d\n",
	146	__func__, result);
1da177e4 LT	147	return result;
	148	}
	149
335f8514	150	static void omninet_close(struct usb_serial_port *port)
1da177e4	151	{
1da177e4	152	usb_kill_urb(port->read_urb);
1da177e4 LT	153	}
	154
	155
	156	#define OMNINET_DATAOFFSET 0x04
	157	#define OMNINET_HEADERLEN sizeof(struct omninet_header)
	158	#define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN)
	159
f89d0dff	160	static void omninet_read_bulk_callback(struct urb *urb)
1da177e4	161	{
cdc97792	162	struct usb_serial_port *port = urb->context;
1da177e4 LT	163	unsigned char *data = urb->transfer_buffer;
1da177e4 LT	164	struct omninet_header header = (struct omninet_header ) &data[0];
fdc2deb3	165	int status = urb->status;
1da177e4	166	int result;
4944d400	167	int i;
1da177e4	168
fdc2deb3 GKH	169	if (status) {
fdc2deb3 GKH	170	dbg("%s - nonzero read bulk status received: %d",
441b62c1	171	__func__, status);
1da177e4 LT	172	return;
	173	}
	174
f89d0dff	175	if (debug && header->oh_xxx != 0x30) {
1da177e4	176	if (urb->actual_length) {
f45ba776 JP	177	printk(KERN_DEBUG "%s: omninet_read %d: ",
f45ba776 JP	178	__FILE__, header->oh_len);
f89d0dff AC	179	for (i = 0; i < (header->oh_len +
	180	OMNINET_HEADERLEN); i++)
	181	printk("%.2x ", data[i]);
	182	printk("\n");
1da177e4 LT	183	}
	184	}
	185
	186	if (urb->actual_length && header->oh_len) {
4a90f09b AC	187	struct tty_struct *tty = tty_port_tty_get(&port->port);
	188	tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
	189	header->oh_len);
	190	tty_flip_buffer_push(tty);
	191	tty_kref_put(tty);
1da177e4 LT	192	}
	193
	194	/* Continue trying to always read */
1da177e4 LT	195	result = usb_submit_urb(urb, GFP_ATOMIC);
1da177e4 LT	196	if (result)
194343d9 GKH	197	dev_err(&port->dev,
	198	"%s - failed resubmitting read urb, error %d\n",
	199	__func__, result);
1da177e4 LT	200	}
1da177e4 LT	201
95da310e AC	202	static int omninet_write(struct tty_struct tty, struct usb_serial_port port,
95da310e AC	203	const unsigned char *buf, int count)
1da177e4	204	{
f89d0dff AC	205	struct usb_serial *serial = port->serial;
f89d0dff AC	206	struct usb_serial_port *wport = serial->port[1];
1da177e4	207
f89d0dff AC	208	struct omninet_data *od = usb_get_serial_port_data(port);
	209	struct omninet_header header = (struct omninet_header )
	210	wport->write_urb->transfer_buffer;
1da177e4 LT	211
	212	int result;
	213
1da177e4	214	if (count == 0) {
441b62c1	215	dbg("%s - write request of 0 bytes", __func__);
f89d0dff	216	return 0;
1da177e4	217	}
507ca9bc	218
120f9dbc	219	if (!test_and_clear_bit(0, &port->write_urbs_free)) {
441b62c1	220	dbg("%s - already writing", __func__);
507ca9bc	221	return 0;
1da177e4 LT	222	}
	223
	224	count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
	225
f89d0dff AC	226	memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
f89d0dff AC	227	buf, count);
1da177e4	228
f89d0dff AC	229	usb_serial_debug_data(debug, &port->dev, __func__, count,
f89d0dff AC	230	wport->write_urb->transfer_buffer);
1da177e4 LT	231
	232	header->oh_seq = od->od_outseq++;
	233	header->oh_len = count;
	234	header->oh_xxx = 0x03;
	235	header->oh_pad = 0x00;
	236
	237	/* send the data out the bulk port, always 64 bytes */
	238	wport->write_urb->transfer_buffer_length = 64;
	239
1da177e4	240	result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
507ca9bc	241	if (result) {
120f9dbc	242	set_bit(0, &wport->write_urbs_free);
22a416c4	243	dev_err_console(port,
194343d9 GKH	244	"%s - failed submitting write urb, error %d\n",
194343d9 GKH	245	__func__, result);
507ca9bc	246	} else
1da177e4 LT	247	result = count;
	248
	249	return result;
	250	}
	251
	252
f89d0dff	253	static int omninet_write_room(struct tty_struct *tty)
1da177e4	254	{
95da310e	255	struct usb_serial_port *port = tty->driver_data;
1da177e4 LT	256	struct usb_serial *serial = port->serial;
	257	struct usb_serial_port *wport = serial->port[1];
	258
a5b6f60c	259	int room = 0; /* Default: no room */
1da177e4	260
120f9dbc	261	if (test_bit(0, &wport->write_urbs_free))
1da177e4 LT	262	room = wport->bulk_out_size - OMNINET_HEADERLEN;
1da177e4 LT	263
441b62c1	264	dbg("%s - returns %d", __func__, room);
1da177e4	265
f89d0dff	266	return room;
1da177e4 LT	267	}
1da177e4 LT	268
f89d0dff	269	static void omninet_write_bulk_callback(struct urb *urb)
1da177e4	270	{
f89d0dff AC	271	/* struct omninet_header header = (struct omninet_header )
f89d0dff AC	272	urb->transfer_buffer; */
cdc97792	273	struct usb_serial_port *port = urb->context;
fdc2deb3	274	int status = urb->status;
1da177e4	275
120f9dbc	276	set_bit(0, &port->write_urbs_free);
fdc2deb3 GKH	277	if (status) {
fdc2deb3 GKH	278	dbg("%s - nonzero write bulk status received: %d",
441b62c1	279	__func__, status);
1da177e4 LT	280	return;
	281	}
	282
cf2c7481	283	usb_serial_port_softint(port);
1da177e4 LT	284	}
	285
	286
f9c99bb8	287	static void omninet_disconnect(struct usb_serial *serial)
1da177e4	288	{
5ec1862e	289	struct usb_serial_port *wport = serial->port[1];
f9c99bb8	290
5ec1862e	291	usb_kill_urb(wport->write_urb);
f9c99bb8 AS	292	}
	293
	294
	295	static void omninet_release(struct usb_serial *serial)
	296	{
	297	struct usb_serial_port *port = serial->port[0];
	298
5ec1862e	299	kfree(usb_get_serial_port_data(port));
1da177e4 LT	300	}
1da177e4 LT	301
68e24113	302	module_usb_serial_driver(serial_drivers, id_table);
1da177e4	303
f89d0dff AC	304	MODULE_AUTHOR(DRIVER_AUTHOR);
f89d0dff AC	305	MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4 LT	306	MODULE_LICENSE("GPL");
	307
	308	module_param(debug, bool, S_IRUGO \| S_IWUSR);
	309	MODULE_PARM_DESC(debug, "Debug enabled or not");