1 /* 2 * USB ZyXEL omni.net LCD PLUS driver 3 * 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. 7 * 8 * See Documentation/usb/usb-serial.txt for more information on using this 9 * driver 10 * 11 * Please report both successes and troubles to the author at omninet@kroah.com 12 */ 13 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> 25 26 static bool debug; 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 37 /* This one seems to be a re-branded ZyXEL device */ 38 #define BT_IGNITIONPRO_ID 0x2000 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); 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); 48 static void omninet_disconnect(struct usb_serial *serial); 49 static void omninet_release(struct usb_serial *serial); 50 static int omninet_attach(struct usb_serial *serial); 51 52 static const struct usb_device_id id_table[] = { 53 { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) }, 54 { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) }, 55 { } /* Terminating entry */ 56 }; 57 58 MODULE_DEVICE_TABLE(usb, id_table); 59 60 static struct usb_driver omninet_driver = { 61 .name = "omninet", 62 .probe = usb_serial_probe, 63 .disconnect = usb_serial_disconnect, 64 .id_table = id_table, 65 }; 66 67 68 static struct usb_serial_driver zyxel_omninet_device = { 69 .driver = { 70 .owner = THIS_MODULE, 71 .name = "omninet", 72 }, 73 .description = "ZyXEL - omni.net lcd plus usb", 74 .id_table = id_table, 75 .num_ports = 1, 76 .attach = omninet_attach, 77 .open = omninet_open, 78 .close = omninet_close, 79 .write = omninet_write, 80 .write_room = omninet_write_room, 81 .read_bulk_callback = omninet_read_bulk_callback, 82 .write_bulk_callback = omninet_write_bulk_callback, 83 .disconnect = omninet_disconnect, 84 .release = omninet_release, 85 }; 86 87 static struct usb_serial_driver * const serial_drivers[] = { 88 &zyxel_omninet_device, NULL 89 }; 90 91 92 /* The protocol. 93 * 94 * The omni.net always exchange 64 bytes of data with the host. The first 95 * four bytes are the control header, you can see it in the above structure. 96 * 97 * oh_seq is a sequence number. Don't know if/how it's used. 98 * oh_len is the length of the data bytes in the packet. 99 * oh_xxx Bit-mapped, related to handshaking and status info. 100 * I normally set it to 0x03 in trasmitted frames. 101 * 7: Active when the TA is in a CONNECTed state. 102 * 6: unknown 103 * 5: handshaking, unknown 104 * 4: handshaking, unknown 105 * 3: unknown, usually 0 106 * 2: unknown, usually 0 107 * 1: handshaking, unknown, usually set to 1 in trasmitted frames 108 * 0: handshaking, unknown, usually set to 1 in trasmitted frames 109 * oh_pad Probably a pad byte. 110 * 111 * After the header you will find data bytes if oh_len was greater than zero. 112 * 113 */ 114 115 struct omninet_header { 116 __u8 oh_seq; 117 __u8 oh_len; 118 __u8 oh_xxx; 119 __u8 oh_pad; 120 }; 121 122 struct omninet_data { 123 __u8 od_outseq; /* Sequence number for bulk_out URBs */ 124 }; 125 126 static int omninet_attach(struct usb_serial *serial) 127 { 128 struct omninet_data *od; 129 struct usb_serial_port *port = serial->port[0]; 130 131 od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL); 132 if (!od) { 133 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", 134 __func__, sizeof(struct omninet_data)); 135 return -ENOMEM; 136 } 137 usb_set_serial_port_data(port, od); 138 return 0; 139 } 140 141 static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port) 142 { 143 struct usb_serial *serial = port->serial; 144 struct usb_serial_port *wport; 145 int result = 0; 146 147 dbg("%s - port %d", __func__, port->number); 148 149 wport = serial->port[1]; 150 tty_port_tty_set(&wport->port, tty); 151 152 /* Start reading from the device */ 153 result = usb_submit_urb(port->read_urb, GFP_KERNEL); 154 if (result) 155 dev_err(&port->dev, 156 "%s - failed submitting read urb, error %d\n", 157 __func__, result); 158 return result; 159 } 160 161 static void omninet_close(struct usb_serial_port *port) 162 { 163 dbg("%s - port %d", __func__, port->number); 164 usb_kill_urb(port->read_urb); 165 } 166 167 168 #define OMNINET_DATAOFFSET 0x04 169 #define OMNINET_HEADERLEN sizeof(struct omninet_header) 170 #define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN) 171 172 static void omninet_read_bulk_callback(struct urb *urb) 173 { 174 struct usb_serial_port *port = urb->context; 175 unsigned char *data = urb->transfer_buffer; 176 struct omninet_header *header = (struct omninet_header *) &data[0]; 177 int status = urb->status; 178 int result; 179 int i; 180 181 dbg("%s - port %d", __func__, port->number); 182 183 if (status) { 184 dbg("%s - nonzero read bulk status received: %d", 185 __func__, status); 186 return; 187 } 188 189 if (debug && header->oh_xxx != 0x30) { 190 if (urb->actual_length) { 191 printk(KERN_DEBUG "%s: omninet_read %d: ", 192 __FILE__, header->oh_len); 193 for (i = 0; i < (header->oh_len + 194 OMNINET_HEADERLEN); i++) 195 printk("%.2x ", data[i]); 196 printk("\n"); 197 } 198 } 199 200 if (urb->actual_length && header->oh_len) { 201 struct tty_struct *tty = tty_port_tty_get(&port->port); 202 tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET, 203 header->oh_len); 204 tty_flip_buffer_push(tty); 205 tty_kref_put(tty); 206 } 207 208 /* Continue trying to always read */ 209 result = usb_submit_urb(urb, GFP_ATOMIC); 210 if (result) 211 dev_err(&port->dev, 212 "%s - failed resubmitting read urb, error %d\n", 213 __func__, result); 214 } 215 216 static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port, 217 const unsigned char *buf, int count) 218 { 219 struct usb_serial *serial = port->serial; 220 struct usb_serial_port *wport = serial->port[1]; 221 222 struct omninet_data *od = usb_get_serial_port_data(port); 223 struct omninet_header *header = (struct omninet_header *) 224 wport->write_urb->transfer_buffer; 225 226 int result; 227 228 dbg("%s - port %d", __func__, port->number); 229 230 if (count == 0) { 231 dbg("%s - write request of 0 bytes", __func__); 232 return 0; 233 } 234 235 if (!test_and_clear_bit(0, &port->write_urbs_free)) { 236 dbg("%s - already writing", __func__); 237 return 0; 238 } 239 240 count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count; 241 242 memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET, 243 buf, count); 244 245 usb_serial_debug_data(debug, &port->dev, __func__, count, 246 wport->write_urb->transfer_buffer); 247 248 header->oh_seq = od->od_outseq++; 249 header->oh_len = count; 250 header->oh_xxx = 0x03; 251 header->oh_pad = 0x00; 252 253 /* send the data out the bulk port, always 64 bytes */ 254 wport->write_urb->transfer_buffer_length = 64; 255 256 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 "%s - failed submitting write urb, error %d\n", 261 __func__, result); 262 } else 263 result = count; 264 265 return result; 266 } 267 268 269 static int omninet_write_room(struct tty_struct *tty) 270 { 271 struct usb_serial_port *port = tty->driver_data; 272 struct usb_serial *serial = port->serial; 273 struct usb_serial_port *wport = serial->port[1]; 274 275 int room = 0; /* Default: no room */ 276 277 if (test_bit(0, &wport->write_urbs_free)) 278 room = wport->bulk_out_size - OMNINET_HEADERLEN; 279 280 dbg("%s - returns %d", __func__, room); 281 282 return room; 283 } 284 285 static void omninet_write_bulk_callback(struct urb *urb) 286 { 287 /* struct omninet_header *header = (struct omninet_header *) 288 urb->transfer_buffer; */ 289 struct usb_serial_port *port = urb->context; 290 int status = urb->status; 291 292 dbg("%s - port %0x", __func__, port->number); 293 294 set_bit(0, &port->write_urbs_free); 295 if (status) { 296 dbg("%s - nonzero write bulk status received: %d", 297 __func__, status); 298 return; 299 } 300 301 usb_serial_port_softint(port); 302 } 303 304 305 static void omninet_disconnect(struct usb_serial *serial) 306 { 307 struct usb_serial_port *wport = serial->port[1]; 308 309 dbg("%s", __func__); 310 311 usb_kill_urb(wport->write_urb); 312 } 313 314 315 static void omninet_release(struct usb_serial *serial) 316 { 317 struct usb_serial_port *port = serial->port[0]; 318 319 dbg("%s", __func__); 320 321 kfree(usb_get_serial_port_data(port)); 322 } 323 324 module_usb_serial_driver(omninet_driver, serial_drivers); 325 326 MODULE_AUTHOR(DRIVER_AUTHOR); 327 MODULE_DESCRIPTION(DRIVER_DESC); 328 MODULE_LICENSE("GPL"); 329 330 module_param(debug, bool, S_IRUGO | S_IWUSR); 331 MODULE_PARM_DESC(debug, "Debug enabled or not"); 332