2 * USB ZyXEL omni.net LCD PLUS driver
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.
8 * See Documentation/usb/usb-serial.txt for more information on using this
11 * Please report both successes and troubles to the author at omninet@kroah.com
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>
22 #include <linux/uaccess.h>
23 #include <linux/usb.h>
24 #include <linux/usb/serial.h>
29 #define DRIVER_VERSION "v1.1"
30 #define DRIVER_AUTHOR "Alessandro Zummo"
31 #define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
33 #define ZYXEL_VENDOR_ID 0x0586
34 #define ZYXEL_OMNINET_ID 0x1000
35 /* This one seems to be a re-branded ZyXEL device */
36 #define BT_IGNITIONPRO_ID 0x2000
38 /* function prototypes */
39 static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
40 static void omninet_close(struct usb_serial_port *port);
41 static void omninet_read_bulk_callback(struct urb *urb);
42 static void omninet_write_bulk_callback(struct urb *urb);
43 static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
44 const unsigned char *buf, int count);
45 static int omninet_write_room(struct tty_struct *tty);
46 static void omninet_disconnect(struct usb_serial *serial);
47 static void omninet_release(struct usb_serial *serial);
48 static int omninet_attach(struct usb_serial *serial);
50 static const struct usb_device_id id_table[] = {
51 { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
52 { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
53 { } /* Terminating entry */
55 MODULE_DEVICE_TABLE(usb, id_table);
57 static struct usb_serial_driver zyxel_omninet_device = {
62 .description = "ZyXEL - omni.net lcd plus usb",
65 .attach = omninet_attach,
67 .close = omninet_close,
68 .write = omninet_write,
69 .write_room = omninet_write_room,
70 .read_bulk_callback = omninet_read_bulk_callback,
71 .write_bulk_callback = omninet_write_bulk_callback,
72 .disconnect = omninet_disconnect,
73 .release = omninet_release,
76 static struct usb_serial_driver * const serial_drivers[] = {
77 &zyxel_omninet_device, NULL
83 * The omni.net always exchange 64 bytes of data with the host. The first
84 * four bytes are the control header, you can see it in the above structure.
86 * oh_seq is a sequence number. Don't know if/how it's used.
87 * oh_len is the length of the data bytes in the packet.
88 * oh_xxx Bit-mapped, related to handshaking and status info.
89 * I normally set it to 0x03 in trasmitted frames.
90 * 7: Active when the TA is in a CONNECTed state.
92 * 5: handshaking, unknown
93 * 4: handshaking, unknown
94 * 3: unknown, usually 0
95 * 2: unknown, usually 0
96 * 1: handshaking, unknown, usually set to 1 in trasmitted frames
97 * 0: handshaking, unknown, usually set to 1 in trasmitted frames
98 * oh_pad Probably a pad byte.
100 * After the header you will find data bytes if oh_len was greater than zero.
104 struct omninet_header {
111 struct omninet_data {
112 __u8 od_outseq; /* Sequence number for bulk_out URBs */
115 static int omninet_attach(struct usb_serial *serial)
117 struct omninet_data *od;
118 struct usb_serial_port *port = serial->port[0];
120 od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
122 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
123 __func__, sizeof(struct omninet_data));
126 usb_set_serial_port_data(port, od);
130 static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
132 struct usb_serial *serial = port->serial;
133 struct usb_serial_port *wport;
136 wport = serial->port[1];
137 tty_port_tty_set(&wport->port, tty);
139 /* Start reading from the device */
140 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
143 "%s - failed submitting read urb, error %d\n",
148 static void omninet_close(struct usb_serial_port *port)
150 usb_kill_urb(port->read_urb);
154 #define OMNINET_DATAOFFSET 0x04
155 #define OMNINET_HEADERLEN sizeof(struct omninet_header)
156 #define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN)
158 static void omninet_read_bulk_callback(struct urb *urb)
160 struct usb_serial_port *port = urb->context;
161 unsigned char *data = urb->transfer_buffer;
162 struct omninet_header *header = (struct omninet_header *) &data[0];
163 int status = urb->status;
167 dev_dbg(&port->dev, "%s - nonzero read bulk status received: %d\n",
172 if (urb->actual_length && header->oh_len) {
173 struct tty_struct *tty = tty_port_tty_get(&port->port);
175 tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
177 tty_flip_buffer_push(tty);
182 /* Continue trying to always read */
183 result = usb_submit_urb(urb, GFP_ATOMIC);
186 "%s - failed resubmitting read urb, error %d\n",
190 static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
191 const unsigned char *buf, int count)
193 struct usb_serial *serial = port->serial;
194 struct usb_serial_port *wport = serial->port[1];
196 struct omninet_data *od = usb_get_serial_port_data(port);
197 struct omninet_header *header = (struct omninet_header *)
198 wport->write_urb->transfer_buffer;
203 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
207 if (!test_and_clear_bit(0, &port->write_urbs_free)) {
208 dev_dbg(&port->dev, "%s - already writing\n", __func__);
212 count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
214 memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
217 usb_serial_debug_data(&port->dev, __func__, count,
218 wport->write_urb->transfer_buffer);
220 header->oh_seq = od->od_outseq++;
221 header->oh_len = count;
222 header->oh_xxx = 0x03;
223 header->oh_pad = 0x00;
225 /* send the data out the bulk port, always 64 bytes */
226 wport->write_urb->transfer_buffer_length = 64;
228 result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
230 set_bit(0, &wport->write_urbs_free);
231 dev_err_console(port,
232 "%s - failed submitting write urb, error %d\n",
241 static int omninet_write_room(struct tty_struct *tty)
243 struct usb_serial_port *port = tty->driver_data;
244 struct usb_serial *serial = port->serial;
245 struct usb_serial_port *wport = serial->port[1];
247 int room = 0; /* Default: no room */
249 if (test_bit(0, &wport->write_urbs_free))
250 room = wport->bulk_out_size - OMNINET_HEADERLEN;
252 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
257 static void omninet_write_bulk_callback(struct urb *urb)
259 /* struct omninet_header *header = (struct omninet_header *)
260 urb->transfer_buffer; */
261 struct usb_serial_port *port = urb->context;
262 int status = urb->status;
264 set_bit(0, &port->write_urbs_free);
266 dev_dbg(&port->dev, "%s - nonzero write bulk status received: %d\n",
271 usb_serial_port_softint(port);
275 static void omninet_disconnect(struct usb_serial *serial)
277 struct usb_serial_port *wport = serial->port[1];
279 usb_kill_urb(wport->write_urb);
283 static void omninet_release(struct usb_serial *serial)
285 struct usb_serial_port *port = serial->port[0];
287 kfree(usb_get_serial_port_data(port));
290 module_usb_serial_driver(serial_drivers, id_table);
292 MODULE_AUTHOR(DRIVER_AUTHOR);
293 MODULE_DESCRIPTION(DRIVER_DESC);
294 MODULE_LICENSE("GPL");