omninet.c 8.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 * USB ZyXEL omni.net LCD PLUS driver
 *
4 5 6
 *	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.
L
Linus Torvalds 已提交
7
 *
A
Alan Cox 已提交
8 9
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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>
A
Alan Cox 已提交
22
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
23
#include <linux/usb.h>
24
#include <linux/usb/serial.h>
L
Linus Torvalds 已提交
25

26
static bool debug;
L
Linus Torvalds 已提交
27 28 29 30 31 32 33 34 35 36

/*
 * 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
A
Alan Cox 已提交
37 38
/* This one seems to be a re-branded ZyXEL device */
#define BT_IGNITIONPRO_ID	0x2000
L
Linus Torvalds 已提交
39 40

/* function prototypes */
41
static int  omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
42
static void omninet_close(struct usb_serial_port *port);
A
Alan Cox 已提交
43 44 45 46 47
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);
48 49
static void omninet_disconnect(struct usb_serial *serial);
static void omninet_release(struct usb_serial *serial);
A
Alan Cox 已提交
50 51
static int omninet_attach(struct usb_serial *serial);

52
static const struct usb_device_id id_table[] = {
L
Linus Torvalds 已提交
53 54 55 56 57
	{ USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
	{ USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
	{ }						/* Terminating entry */
};

A
Alan Cox 已提交
58
MODULE_DEVICE_TABLE(usb, id_table);
L
Linus Torvalds 已提交
59 60 61 62 63 64 65 66 67

static struct usb_driver omninet_driver = {
	.name =		"omninet",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	id_table,
};


68
static struct usb_serial_driver zyxel_omninet_device = {
69 70
	.driver = {
		.owner =	THIS_MODULE,
71
		.name =		"omninet",
72
	},
73
	.description =		"ZyXEL - omni.net lcd plus usb",
L
Linus Torvalds 已提交
74 75
	.id_table =		id_table,
	.num_ports =		1,
76
	.attach =		omninet_attach,
L
Linus Torvalds 已提交
77 78 79 80 81 82
	.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,
83 84
	.disconnect =		omninet_disconnect,
	.release =		omninet_release,
L
Linus Torvalds 已提交
85 86
};

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

L
Linus Torvalds 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

/* 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.
 *
 */

A
Alan Cox 已提交
115
struct omninet_header {
L
Linus Torvalds 已提交
116 117 118 119 120 121
	__u8	oh_seq;
	__u8	oh_len;
	__u8	oh_xxx;
	__u8	oh_pad;
};

A
Alan Cox 已提交
122 123
struct omninet_data {
	__u8	od_outseq;	/* Sequence number for bulk_out URBs */
L
Linus Torvalds 已提交
124 125
};

A
Alan Cox 已提交
126
static int omninet_attach(struct usb_serial *serial)
127 128 129 130
{
	struct omninet_data *od;
	struct usb_serial_port *port = serial->port[0];

A
Alan Cox 已提交
131 132
	od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
	if (!od) {
133 134
		dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
			__func__, sizeof(struct omninet_data));
135 136 137 138 139 140
		return -ENOMEM;
	}
	usb_set_serial_port_data(port, od);
	return 0;
}

141
static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
L
Linus Torvalds 已提交
142 143 144 145 146
{
	struct usb_serial	*serial = port->serial;
	struct usb_serial_port	*wport;
	int			result = 0;

147
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
148 149

	wport = serial->port[1];
A
Alan Cox 已提交
150
	tty_port_tty_set(&wport->port, tty);
L
Linus Torvalds 已提交
151 152 153

	/* Start reading from the device */
	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
A
Alan Cox 已提交
154
	if (result)
155 156 157
		dev_err(&port->dev,
			"%s - failed submitting read urb, error %d\n",
			__func__, result);
L
Linus Torvalds 已提交
158 159 160
	return result;
}

161
static void omninet_close(struct usb_serial_port *port)
L
Linus Torvalds 已提交
162
{
163
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
164 165 166 167 168 169 170 171
	usb_kill_urb(port->read_urb);
}


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

A
Alan Cox 已提交
172
static void omninet_read_bulk_callback(struct urb *urb)
L
Linus Torvalds 已提交
173
{
174
	struct usb_serial_port 	*port 	= urb->context;
L
Linus Torvalds 已提交
175 176
	unsigned char 		*data 	= urb->transfer_buffer;
	struct omninet_header 	*header = (struct omninet_header *) &data[0];
177
	int status = urb->status;
L
Linus Torvalds 已提交
178
	int result;
A
Alan Cox 已提交
179
	int i;
L
Linus Torvalds 已提交
180

181
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
182

183 184
	if (status) {
		dbg("%s - nonzero read bulk status received: %d",
185
		    __func__, status);
L
Linus Torvalds 已提交
186 187 188
		return;
	}

A
Alan Cox 已提交
189
	if (debug && header->oh_xxx != 0x30) {
L
Linus Torvalds 已提交
190
		if (urb->actual_length) {
191 192
			printk(KERN_DEBUG "%s: omninet_read %d: ",
			       __FILE__, header->oh_len);
A
Alan Cox 已提交
193 194 195 196
			for (i = 0; i < (header->oh_len +
						OMNINET_HEADERLEN); i++)
				printk("%.2x ", data[i]);
			printk("\n");
L
Linus Torvalds 已提交
197 198 199 200
		}
	}

	if (urb->actual_length && header->oh_len) {
A
Alan Cox 已提交
201 202 203 204 205
		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);
L
Linus Torvalds 已提交
206 207 208 209 210
	}

	/* Continue trying to always read  */
	result = usb_submit_urb(urb, GFP_ATOMIC);
	if (result)
211 212 213
		dev_err(&port->dev,
			"%s - failed resubmitting read urb, error %d\n",
			__func__, result);
L
Linus Torvalds 已提交
214 215
}

A
Alan Cox 已提交
216 217
static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
					const unsigned char *buf, int count)
L
Linus Torvalds 已提交
218
{
A
Alan Cox 已提交
219 220
	struct usb_serial *serial = port->serial;
	struct usb_serial_port *wport = serial->port[1];
L
Linus Torvalds 已提交
221

A
Alan Cox 已提交
222 223 224
	struct omninet_data *od = usb_get_serial_port_data(port);
	struct omninet_header *header = (struct omninet_header *)
					wport->write_urb->transfer_buffer;
L
Linus Torvalds 已提交
225 226 227

	int			result;

228
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
229 230

	if (count == 0) {
231
		dbg("%s - write request of 0 bytes", __func__);
A
Alan Cox 已提交
232
		return 0;
L
Linus Torvalds 已提交
233
	}
234

235
	if (!test_and_clear_bit(0, &port->write_urbs_free)) {
236
		dbg("%s - already writing", __func__);
237
		return 0;
L
Linus Torvalds 已提交
238 239 240 241
	}

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

A
Alan Cox 已提交
242 243
	memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
								buf, count);
L
Linus Torvalds 已提交
244

A
Alan Cox 已提交
245 246
	usb_serial_debug_data(debug, &port->dev, __func__, count,
					wport->write_urb->transfer_buffer);
L
Linus Torvalds 已提交
247 248 249 250 251 252 253 254 255 256

	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);
257
	if (result) {
258
		set_bit(0, &wport->write_urbs_free);
259
		dev_err_console(port,
260 261
			"%s - failed submitting write urb, error %d\n",
			__func__, result);
262
	} else
L
Linus Torvalds 已提交
263 264 265 266 267 268
		result = count;

	return result;
}


A
Alan Cox 已提交
269
static int omninet_write_room(struct tty_struct *tty)
L
Linus Torvalds 已提交
270
{
A
Alan Cox 已提交
271
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
272 273 274
	struct usb_serial 	*serial = port->serial;
	struct usb_serial_port 	*wport 	= serial->port[1];

275
	int room = 0; /* Default: no room */
L
Linus Torvalds 已提交
276

277
	if (test_bit(0, &wport->write_urbs_free))
L
Linus Torvalds 已提交
278 279
		room = wport->bulk_out_size - OMNINET_HEADERLEN;

280
	dbg("%s - returns %d", __func__, room);
L
Linus Torvalds 已提交
281

A
Alan Cox 已提交
282
	return room;
L
Linus Torvalds 已提交
283 284
}

A
Alan Cox 已提交
285
static void omninet_write_bulk_callback(struct urb *urb)
L
Linus Torvalds 已提交
286
{
A
Alan Cox 已提交
287 288
/*	struct omninet_header	*header = (struct omninet_header  *)
						urb->transfer_buffer; */
289
	struct usb_serial_port 	*port   =  urb->context;
290
	int status = urb->status;
L
Linus Torvalds 已提交
291

292
	dbg("%s - port %0x", __func__, port->number);
L
Linus Torvalds 已提交
293

294
	set_bit(0, &port->write_urbs_free);
295 296
	if (status) {
		dbg("%s - nonzero write bulk status received: %d",
297
		    __func__, status);
L
Linus Torvalds 已提交
298 299 300
		return;
	}

301
	usb_serial_port_softint(port);
L
Linus Torvalds 已提交
302 303 304
}


305
static void omninet_disconnect(struct usb_serial *serial)
L
Linus Torvalds 已提交
306
{
307
	struct usb_serial_port *wport = serial->port[1];
308

A
Alan Cox 已提交
309
	dbg("%s", __func__);
310 311

	usb_kill_urb(wport->write_urb);
312 313 314 315 316 317 318 319 320
}


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

	dbg("%s", __func__);

321
	kfree(usb_get_serial_port_data(port));
L
Linus Torvalds 已提交
322 323
}

324
module_usb_serial_driver(omninet_driver, serial_drivers);
L
Linus Torvalds 已提交
325

A
Alan Cox 已提交
326 327
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
L
Linus Torvalds 已提交
328 329 330 331
MODULE_LICENSE("GPL");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");