Merge branch 'sched/for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tip...
[linux-2.6] / drivers / usb / serial / omninet.c
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  * (05/30/2001) gkh
14  *      switched from using spinlock to a semaphore, which fixes lots of
15  *      problems.
16  *
17  * (04/08/2001) gb
18  *      Identify version on module load.
19  *
20  * (11/01/2000) Adam J. Richter
21  *      usb_device_id table support
22  *
23  * (10/05/2000) gkh
24  *      Fixed bug with urb->dev not being set properly, now that the usb
25  *      core needs it.
26  *
27  * (08/28/2000) gkh
28  *      Added locks for SMP safeness.
29  *      Fixed MOD_INC and MOD_DEC logic and the ability to open a port more
30  *      than once.
31  *      Fixed potential race in omninet_write_bulk_callback
32  *
33  * (07/19/2000) gkh
34  *      Added module_init and module_exit functions to handle the fact that this
35  *      driver is a loadable module now.
36  *
37  */
38
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 <linux/uaccess.h>
49 #include <linux/usb.h>
50 #include <linux/usb/serial.h>
51
52 static int debug;
53
54 /*
55  * Version Information
56  */
57 #define DRIVER_VERSION "v1.1"
58 #define DRIVER_AUTHOR "Alessandro Zummo"
59 #define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
60
61 #define ZYXEL_VENDOR_ID         0x0586
62 #define ZYXEL_OMNINET_ID        0x1000
63 /* This one seems to be a re-branded ZyXEL device */
64 #define BT_IGNITIONPRO_ID       0x2000
65
66 /* function prototypes */
67 static int  omninet_open(struct tty_struct *tty, struct usb_serial_port *port,
68                                                         struct file *filp);
69 static void omninet_close(struct tty_struct *tty, struct usb_serial_port *port,
70                                                         struct file *filp);
71 static void omninet_read_bulk_callback(struct urb *urb);
72 static void omninet_write_bulk_callback(struct urb *urb);
73 static int  omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
74                                 const unsigned char *buf, int count);
75 static int  omninet_write_room(struct tty_struct *tty);
76 static void omninet_shutdown(struct usb_serial *serial);
77 static int omninet_attach(struct usb_serial *serial);
78
79 static struct usb_device_id id_table[] = {
80         { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
81         { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
82         { }                                             /* Terminating entry */
83 };
84
85 MODULE_DEVICE_TABLE(usb, id_table);
86
87 static struct usb_driver omninet_driver = {
88         .name =         "omninet",
89         .probe =        usb_serial_probe,
90         .disconnect =   usb_serial_disconnect,
91         .id_table =     id_table,
92         .no_dynamic_id =        1,
93 };
94
95
96 static struct usb_serial_driver zyxel_omninet_device = {
97         .driver = {
98                 .owner =        THIS_MODULE,
99                 .name =         "omninet",
100         },
101         .description =          "ZyXEL - omni.net lcd plus usb",
102         .usb_driver =           &omninet_driver,
103         .id_table =             id_table,
104         .num_ports =            1,
105         .attach =               omninet_attach,
106         .open =                 omninet_open,
107         .close =                omninet_close,
108         .write =                omninet_write,
109         .write_room =           omninet_write_room,
110         .read_bulk_callback =   omninet_read_bulk_callback,
111         .write_bulk_callback =  omninet_write_bulk_callback,
112         .shutdown =             omninet_shutdown,
113 };
114
115
116 /* The protocol.
117  *
118  * The omni.net always exchange 64 bytes of data with the host. The first
119  * four bytes are the control header, you can see it in the above structure.
120  *
121  * oh_seq is a sequence number. Don't know if/how it's used.
122  * oh_len is the length of the data bytes in the packet.
123  * oh_xxx Bit-mapped, related to handshaking and status info.
124  *      I normally set it to 0x03 in trasmitted frames.
125  *      7: Active when the TA is in a CONNECTed state.
126  *      6: unknown
127  *      5: handshaking, unknown
128  *      4: handshaking, unknown
129  *      3: unknown, usually 0
130  *      2: unknown, usually 0
131  *      1: handshaking, unknown, usually set to 1 in trasmitted frames
132  *      0: handshaking, unknown, usually set to 1 in trasmitted frames
133  * oh_pad Probably a pad byte.
134  *
135  * After the header you will find data bytes if oh_len was greater than zero.
136  *
137  */
138
139 struct omninet_header {
140         __u8    oh_seq;
141         __u8    oh_len;
142         __u8    oh_xxx;
143         __u8    oh_pad;
144 };
145
146 struct omninet_data {
147         __u8    od_outseq;      /* Sequence number for bulk_out URBs */
148 };
149
150 static int omninet_attach(struct usb_serial *serial)
151 {
152         struct omninet_data *od;
153         struct usb_serial_port *port = serial->port[0];
154
155         od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
156         if (!od) {
157                 err("%s- kmalloc(%Zd) failed.",
158                                 __func__, sizeof(struct omninet_data));
159                 return -ENOMEM;
160         }
161         usb_set_serial_port_data(port, od);
162         return 0;
163 }
164
165 static int omninet_open(struct tty_struct *tty,
166                         struct usb_serial_port *port, struct file *filp)
167 {
168         struct usb_serial       *serial = port->serial;
169         struct usb_serial_port  *wport;
170         int                     result = 0;
171
172         dbg("%s - port %d", __func__, port->number);
173
174         wport = serial->port[1];
175         wport->port.tty = tty;          /* FIXME */
176
177         /* Start reading from the device */
178         usb_fill_bulk_urb(port->read_urb, serial->dev,
179                         usb_rcvbulkpipe(serial->dev,
180                                 port->bulk_in_endpointAddress),
181                         port->read_urb->transfer_buffer,
182                         port->read_urb->transfer_buffer_length,
183                         omninet_read_bulk_callback, port);
184         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
185         if (result)
186                 err("%s - failed submitting read urb, error %d",
187                                                         __func__, result);
188         return result;
189 }
190
191 static void omninet_close(struct tty_struct *tty,
192                         struct usb_serial_port *port, struct file *filp)
193 {
194         dbg("%s - port %d", __func__, port->number);
195         usb_kill_urb(port->read_urb);
196 }
197
198
199 #define OMNINET_DATAOFFSET      0x04
200 #define OMNINET_HEADERLEN       sizeof(struct omninet_header)
201 #define OMNINET_BULKOUTSIZE     (64 - OMNINET_HEADERLEN)
202
203 static void omninet_read_bulk_callback(struct urb *urb)
204 {
205         struct usb_serial_port  *port   = urb->context;
206         unsigned char           *data   = urb->transfer_buffer;
207         struct omninet_header   *header = (struct omninet_header *) &data[0];
208         int status = urb->status;
209         int result;
210         int i;
211
212         dbg("%s - port %d", __func__, port->number);
213
214         if (status) {
215                 dbg("%s - nonzero read bulk status received: %d",
216                     __func__, status);
217                 return;
218         }
219
220         if (debug && header->oh_xxx != 0x30) {
221                 if (urb->actual_length) {
222                         printk(KERN_DEBUG __FILE__
223                                         ": omninet_read %d: ", header->oh_len);
224                         for (i = 0; i < (header->oh_len +
225                                                 OMNINET_HEADERLEN); i++)
226                                 printk("%.2x ", data[i]);
227                         printk("\n");
228                 }
229         }
230
231         if (urb->actual_length && header->oh_len) {
232                 tty_insert_flip_string(port->port.tty,
233                         data + OMNINET_DATAOFFSET, header->oh_len);
234                 tty_flip_buffer_push(port->port.tty);
235         }
236
237         /* Continue trying to always read  */
238         usb_fill_bulk_urb(urb, port->serial->dev,
239                         usb_rcvbulkpipe(port->serial->dev,
240                                         port->bulk_in_endpointAddress),
241                         urb->transfer_buffer, urb->transfer_buffer_length,
242                         omninet_read_bulk_callback, port);
243         result = usb_submit_urb(urb, GFP_ATOMIC);
244         if (result)
245                 err("%s - failed resubmitting read urb, error %d",
246                                                 __func__, result);
247
248         return;
249 }
250
251 static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
252                                         const unsigned char *buf, int count)
253 {
254         struct usb_serial *serial = port->serial;
255         struct usb_serial_port *wport = serial->port[1];
256
257         struct omninet_data *od = usb_get_serial_port_data(port);
258         struct omninet_header *header = (struct omninet_header *)
259                                         wport->write_urb->transfer_buffer;
260
261         int                     result;
262
263         dbg("%s - port %d", __func__, port->number);
264
265         if (count == 0) {
266                 dbg("%s - write request of 0 bytes", __func__);
267                 return 0;
268         }
269
270         spin_lock_bh(&wport->lock);
271         if (wport->write_urb_busy) {
272                 spin_unlock_bh(&wport->lock);
273                 dbg("%s - already writing", __func__);
274                 return 0;
275         }
276         wport->write_urb_busy = 1;
277         spin_unlock_bh(&wport->lock);
278
279         count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
280
281         memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
282                                                                 buf, count);
283
284         usb_serial_debug_data(debug, &port->dev, __func__, count,
285                                         wport->write_urb->transfer_buffer);
286
287         header->oh_seq  = od->od_outseq++;
288         header->oh_len  = count;
289         header->oh_xxx  = 0x03;
290         header->oh_pad  = 0x00;
291
292         /* send the data out the bulk port, always 64 bytes */
293         wport->write_urb->transfer_buffer_length = 64;
294
295         wport->write_urb->dev = serial->dev;
296         result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
297         if (result) {
298                 wport->write_urb_busy = 0;
299                 err("%s - failed submitting write urb, error %d",
300                                                         __func__, result);
301         } else
302                 result = count;
303
304         return result;
305 }
306
307
308 static int omninet_write_room(struct tty_struct *tty)
309 {
310         struct usb_serial_port *port = tty->driver_data;
311         struct usb_serial       *serial = port->serial;
312         struct usb_serial_port  *wport  = serial->port[1];
313
314         int room = 0; /* Default: no room */
315
316         /* FIXME: no consistent locking for write_urb_busy */
317         if (wport->write_urb_busy)
318                 room = wport->bulk_out_size - OMNINET_HEADERLEN;
319
320         dbg("%s - returns %d", __func__, room);
321
322         return room;
323 }
324
325 static void omninet_write_bulk_callback(struct urb *urb)
326 {
327 /*      struct omninet_header   *header = (struct omninet_header  *)
328                                                 urb->transfer_buffer; */
329         struct usb_serial_port  *port   =  urb->context;
330         int status = urb->status;
331
332         dbg("%s - port %0x\n", __func__, port->number);
333
334         port->write_urb_busy = 0;
335         if (status) {
336                 dbg("%s - nonzero write bulk status received: %d",
337                     __func__, status);
338                 return;
339         }
340
341         usb_serial_port_softint(port);
342 }
343
344
345 static void omninet_shutdown(struct usb_serial *serial)
346 {
347         struct usb_serial_port *wport = serial->port[1];
348         struct usb_serial_port *port = serial->port[0];
349         dbg("%s", __func__);
350
351         usb_kill_urb(wport->write_urb);
352         kfree(usb_get_serial_port_data(port));
353 }
354
355
356 static int __init omninet_init(void)
357 {
358         int retval;
359         retval = usb_serial_register(&zyxel_omninet_device);
360         if (retval)
361                 goto failed_usb_serial_register;
362         retval = usb_register(&omninet_driver);
363         if (retval)
364                 goto failed_usb_register;
365         info(DRIVER_VERSION ":" DRIVER_DESC);
366         return 0;
367 failed_usb_register:
368         usb_serial_deregister(&zyxel_omninet_device);
369 failed_usb_serial_register:
370         return retval;
371 }
372
373
374 static void __exit omninet_exit(void)
375 {
376         usb_deregister(&omninet_driver);
377         usb_serial_deregister(&zyxel_omninet_device);
378 }
379
380
381 module_init(omninet_init);
382 module_exit(omninet_exit);
383
384 MODULE_AUTHOR(DRIVER_AUTHOR);
385 MODULE_DESCRIPTION(DRIVER_DESC);
386 MODULE_LICENSE("GPL");
387
388 module_param(debug, bool, S_IRUGO | S_IWUSR);
389 MODULE_PARM_DESC(debug, "Debug enabled or not");