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