2 * USB ZyXEL omni.net LCD PLUS driver
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * See Documentation/usb/usb-serial.txt for more information on using this driver
11 * Please report both successes and troubles to the author at omninet@kroah.com
14 * switched from using spinlock to a semaphore, which fixes lots of problems.
17 * Identify version on module load.
19 * (11/01/2000) Adam J. Richter
20 * usb_device_id table support
23 * Fixed bug with urb->dev not being set properly, now that the usb
27 * Added locks for SMP safeness.
28 * Fixed MOD_INC and MOD_DEC logic and the ability to open a port more
30 * Fixed potential race in omninet_write_bulk_callback
33 * Added module_init and module_exit functions to handle the fact that this
34 * driver is a loadable module now.
38 #include <linux/config.h>
39 #include <linux/kernel.h>
40 #include <linux/errno.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/tty.h>
44 #include <linux/tty_driver.h>
45 #include <linux/tty_flip.h>
46 #include <linux/module.h>
47 #include <linux/spinlock.h>
48 #include <asm/uaccess.h>
49 #include <linux/usb.h>
51 #ifdef CONFIG_USB_SERIAL_DEBUG
57 #include "usb-serial.h"
63 #define DRIVER_VERSION "v1.1"
64 #define DRIVER_AUTHOR "Anonymous"
65 #define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
67 #define ZYXEL_VENDOR_ID 0x0586
68 #define ZYXEL_OMNINET_ID 0x1000
70 /* function prototypes */
71 static int omninet_open (struct usb_serial_port *port, struct file *filp);
72 static void omninet_close (struct usb_serial_port *port, struct file *filp);
73 static void omninet_read_bulk_callback (struct urb *urb);
74 static void omninet_write_bulk_callback (struct urb *urb);
75 static int omninet_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
76 static int omninet_write_room (struct usb_serial_port *port);
77 static void omninet_shutdown (struct usb_serial *serial);
79 static struct usb_device_id id_table [] = {
80 { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
81 { } /* Terminating entry */
84 MODULE_DEVICE_TABLE (usb, id_table);
87 static struct usb_serial_device_type zyxel_omninet_device = {
89 .name = "ZyXEL - omni.net lcd plus usb",
91 .num_interrupt_in = 1,
96 .close = omninet_close,
97 .write = omninet_write,
98 .write_room = omninet_write_room,
99 .read_bulk_callback = omninet_read_bulk_callback,
100 .write_bulk_callback = omninet_write_bulk_callback,
101 .shutdown = omninet_shutdown,
107 * The omni.net always exchange 64 bytes of data with the host. The first
108 * four bytes are the control header, you can see it in the above structure.
110 * oh_seq is a sequence number. Don't know if/how it's used.
111 * oh_len is the length of the data bytes in the packet.
112 * oh_xxx Bit-mapped, related to handshaking and status info.
113 * I normally set it to 0x03 in trasmitted frames.
114 * 7: Active when the TA is in a CONNECTed state.
116 * 5: handshaking, unknown
117 * 4: handshaking, unknown
118 * 3: unknown, usually 0
119 * 2: unknown, usually 0
120 * 1: handshaking, unknown, usually set to 1 in trasmitted frames
121 * 0: handshaking, unknown, usually set to 1 in trasmitted frames
122 * oh_pad Probably a pad byte.
124 * After the header you will find data bytes if oh_len was greater than zero.
128 struct omninet_header
138 __u8 od_outseq; // Sequence number for bulk_out URBs
141 static int omninet_open (struct usb_serial_port *port, struct file *filp)
143 struct usb_serial *serial;
144 struct usb_serial_port *wport;
145 struct omninet_data *od;
148 if (port_paranoia_check (port, __FUNCTION__))
151 dbg("%s - port %d", __FUNCTION__, port->number);
153 serial = get_usb_serial (port, __FUNCTION__);
157 od = kmalloc( sizeof(struct omninet_data), GFP_KERNEL );
159 err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct omninet_data));
164 wport = &serial->port[1];
165 wport->tty = port->tty;
167 /* Start reading from the device */
168 FILL_BULK_URB(port->read_urb, serial->dev,
169 usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress),
170 port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
171 omninet_read_bulk_callback, port);
172 result = usb_submit_urb(port->read_urb);
174 err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
179 static void omninet_close (struct usb_serial_port *port, struct file * filp)
181 struct usb_serial *serial;
182 struct usb_serial_port *wport;
183 struct omninet_data *od;
185 if (port_paranoia_check (port, __FUNCTION__))
188 dbg("%s - port %d", __FUNCTION__, port->number);
190 serial = get_usb_serial (port, __FUNCTION__);
195 wport = &serial->port[1];
196 usb_unlink_urb (wport->write_urb);
197 usb_unlink_urb (port->read_urb);
200 od = (struct omninet_data *)port->private;
206 #define OMNINET_DATAOFFSET 0x04
207 #define OMNINET_HEADERLEN sizeof(struct omninet_header)
208 #define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN)
210 static void omninet_read_bulk_callback (struct urb *urb)
212 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
213 struct usb_serial *serial = get_usb_serial (port, __FUNCTION__);
215 unsigned char *data = urb->transfer_buffer;
216 struct omninet_header *header = (struct omninet_header *) &data[0];
221 // dbg("omninet_read_bulk_callback");
224 dbg("%s - bad serial pointer, exiting", __FUNCTION__);
229 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
233 if ((debug) && (header->oh_xxx != 0x30)) {
234 if (urb->actual_length) {
235 printk (KERN_DEBUG __FILE__ ": omninet_read %d: ", header->oh_len);
236 for (i = 0; i < (header->oh_len + OMNINET_HEADERLEN); i++) {
237 printk ("%.2x ", data[i]);
243 if (urb->actual_length && header->oh_len) {
244 for (i = 0; i < header->oh_len; i++) {
245 tty_insert_flip_char(port->tty, data[OMNINET_DATAOFFSET + i], 0);
247 tty_flip_buffer_push(port->tty);
250 /* Continue trying to always read */
251 FILL_BULK_URB(urb, serial->dev,
252 usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress),
253 urb->transfer_buffer, urb->transfer_buffer_length,
254 omninet_read_bulk_callback, port);
255 result = usb_submit_urb(urb);
257 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
262 static int omninet_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count)
264 struct usb_serial *serial = port->serial;
265 struct usb_serial_port *wport = &serial->port[1];
267 struct omninet_data *od = (struct omninet_data *) port->private;
268 struct omninet_header *header = (struct omninet_header *) wport->write_urb->transfer_buffer;
272 // dbg("omninet_write port %d", port->number);
275 dbg("%s - write request of 0 bytes", __FUNCTION__);
278 if (wport->write_urb->status == -EINPROGRESS) {
279 dbg("%s - already writing", __FUNCTION__);
283 count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
286 if (copy_from_user(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET, buf, count) != 0) {
292 memcpy (wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET, buf, count);
295 usb_serial_debug_data (__FILE__, __FUNCTION__, count, wport->write_urb->transfer_buffer);
297 header->oh_seq = od->od_outseq++;
298 header->oh_len = count;
299 header->oh_xxx = 0x03;
300 header->oh_pad = 0x00;
302 /* send the data out the bulk port, always 64 bytes */
303 wport->write_urb->transfer_buffer_length = 64;
305 wport->write_urb->dev = serial->dev;
306 result = usb_submit_urb(wport->write_urb);
308 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
317 static int omninet_write_room (struct usb_serial_port *port)
319 struct usb_serial *serial = port->serial;
320 struct usb_serial_port *wport = &serial->port[1];
322 int room = 0; // Default: no room
324 if (wport->write_urb->status != -EINPROGRESS)
325 room = wport->bulk_out_size - OMNINET_HEADERLEN;
327 // dbg("omninet_write_room returns %d", room);
332 static void omninet_write_bulk_callback (struct urb *urb)
334 /* struct omninet_header *header = (struct omninet_header *) urb->transfer_buffer; */
335 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
336 struct usb_serial *serial;
338 // dbg("omninet_write_bulk_callback, port %0x\n", port);
341 if (port_paranoia_check (port, __FUNCTION__)) {
345 serial = port->serial;
346 if (serial_paranoia_check (serial, __FUNCTION__)) {
351 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
355 queue_task(&port->tqueue, &tq_immediate);
356 mark_bh(IMMEDIATE_BH);
358 // dbg("omninet_write_bulk_callback, tty %0x\n", tty);
364 static void omninet_shutdown (struct usb_serial *serial)
366 dbg ("%s", __FUNCTION__);
370 static int __init omninet_init (void)
372 usb_serial_register (&zyxel_omninet_device);
373 info(DRIVER_VERSION ":" DRIVER_DESC);
378 static void __exit omninet_exit (void)
380 usb_serial_deregister (&zyxel_omninet_device);
384 module_init(omninet_init);
385 module_exit(omninet_exit);
387 MODULE_AUTHOR( DRIVER_AUTHOR );
388 MODULE_DESCRIPTION( DRIVER_DESC );
389 MODULE_LICENSE("GPL");
391 MODULE_PARM(debug, "i");
392 MODULE_PARM_DESC(debug, "Debug enabled or not");