5c7abfb9aea7d06a5a47a1789ca3664cc68eb162
[pandora-kernel.git] / 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 static void omninet_close(struct usb_serial_port *port);
69 static void omninet_read_bulk_callback(struct urb *urb);
70 static void omninet_write_bulk_callback(struct urb *urb);
71 static int  omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
72                                 const unsigned char *buf, int count);
73 static int  omninet_write_room(struct tty_struct *tty);
74 static void omninet_disconnect(struct usb_serial *serial);
75 static void omninet_release(struct usb_serial *serial);
76 static int omninet_attach(struct usb_serial *serial);
77
78 static const struct usb_device_id id_table[] = {
79         { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
80         { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
81         { }                                             /* Terminating entry */
82 };
83
84 MODULE_DEVICE_TABLE(usb, id_table);
85
86 static struct usb_driver omninet_driver = {
87         .name =         "omninet",
88         .probe =        usb_serial_probe,
89         .disconnect =   usb_serial_disconnect,
90         .id_table =     id_table,
91         .no_dynamic_id =        1,
92 };
93
94
95 static struct usb_serial_driver zyxel_omninet_device = {
96         .driver = {
97                 .owner =        THIS_MODULE,
98                 .name =         "omninet",
99         },
100         .description =          "ZyXEL - omni.net lcd plus usb",
101         .usb_driver =           &omninet_driver,
102         .id_table =             id_table,
103         .num_ports =            1,
104         .attach =               omninet_attach,
105         .open =                 omninet_open,
106         .close =                omninet_close,
107         .write =                omninet_write,
108         .write_room =           omninet_write_room,
109         .read_bulk_callback =   omninet_read_bulk_callback,
110         .write_bulk_callback =  omninet_write_bulk_callback,
111         .disconnect =           omninet_disconnect,
112         .release =              omninet_release,
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         /* The second bulk-out endpoint is used for writing. */
156         if (serial->num_bulk_out < 2) {
157                 dev_err(&serial->interface->dev, "missing endpoints\n");
158                 return -ENODEV;
159         }
160
161         od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
162         if (!od) {
163                 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
164                         __func__, sizeof(struct omninet_data));
165                 return -ENOMEM;
166         }
167         usb_set_serial_port_data(port, od);
168         return 0;
169 }
170
171 static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
172 {
173         struct usb_serial       *serial = port->serial;
174         struct usb_serial_port  *wport;
175         int                     result = 0;
176
177         dbg("%s - port %d", __func__, port->number);
178
179         wport = serial->port[1];
180         tty_port_tty_set(&wport->port, tty);
181
182         /* Start reading from the device */
183         usb_fill_bulk_urb(port->read_urb, serial->dev,
184                         usb_rcvbulkpipe(serial->dev,
185                                 port->bulk_in_endpointAddress),
186                         port->read_urb->transfer_buffer,
187                         port->read_urb->transfer_buffer_length,
188                         omninet_read_bulk_callback, port);
189         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
190         if (result)
191                 dev_err(&port->dev,
192                         "%s - failed submitting read urb, error %d\n",
193                         __func__, result);
194         return result;
195 }
196
197 static void omninet_close(struct usb_serial_port *port)
198 {
199         dbg("%s - port %d", __func__, port->number);
200         usb_kill_urb(port->read_urb);
201 }
202
203
204 #define OMNINET_DATAOFFSET      0x04
205 #define OMNINET_HEADERLEN       sizeof(struct omninet_header)
206 #define OMNINET_BULKOUTSIZE     (64 - OMNINET_HEADERLEN)
207
208 static void omninet_read_bulk_callback(struct urb *urb)
209 {
210         struct usb_serial_port  *port   = urb->context;
211         unsigned char           *data   = urb->transfer_buffer;
212         struct omninet_header   *header = (struct omninet_header *) &data[0];
213         int status = urb->status;
214         int result;
215         int i;
216
217         dbg("%s - port %d", __func__, port->number);
218
219         if (status) {
220                 dbg("%s - nonzero read bulk status received: %d",
221                     __func__, status);
222                 return;
223         }
224
225         if (debug && header->oh_xxx != 0x30) {
226                 if (urb->actual_length) {
227                         printk(KERN_DEBUG "%s: omninet_read %d: ",
228                                __FILE__, header->oh_len);
229                         for (i = 0; i < (header->oh_len +
230                                                 OMNINET_HEADERLEN); i++)
231                                 printk("%.2x ", data[i]);
232                         printk("\n");
233                 }
234         }
235
236         if (urb->actual_length && header->oh_len) {
237                 struct tty_struct *tty = tty_port_tty_get(&port->port);
238                 tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
239                                                         header->oh_len);
240                 tty_flip_buffer_push(tty);
241                 tty_kref_put(tty);
242         }
243
244         /* Continue trying to always read  */
245         usb_fill_bulk_urb(urb, port->serial->dev,
246                         usb_rcvbulkpipe(port->serial->dev,
247                                         port->bulk_in_endpointAddress),
248                         urb->transfer_buffer, urb->transfer_buffer_length,
249                         omninet_read_bulk_callback, port);
250         result = usb_submit_urb(urb, GFP_ATOMIC);
251         if (result)
252                 dev_err(&port->dev,
253                         "%s - failed resubmitting read urb, error %d\n",
254                         __func__, result);
255 }
256
257 static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
258                                         const unsigned char *buf, int count)
259 {
260         struct usb_serial *serial = port->serial;
261         struct usb_serial_port *wport = serial->port[1];
262
263         struct omninet_data *od = usb_get_serial_port_data(port);
264         struct omninet_header *header = (struct omninet_header *)
265                                         wport->write_urb->transfer_buffer;
266
267         int                     result;
268
269         dbg("%s - port %d", __func__, port->number);
270
271         if (count == 0) {
272                 dbg("%s - write request of 0 bytes", __func__);
273                 return 0;
274         }
275
276         spin_lock_bh(&wport->lock);
277         if (wport->write_urb_busy) {
278                 spin_unlock_bh(&wport->lock);
279                 dbg("%s - already writing", __func__);
280                 return 0;
281         }
282         wport->write_urb_busy = 1;
283         spin_unlock_bh(&wport->lock);
284
285         count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
286
287         memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
288                                                                 buf, count);
289
290         usb_serial_debug_data(debug, &port->dev, __func__, count,
291                                         wport->write_urb->transfer_buffer);
292
293         header->oh_seq  = od->od_outseq++;
294         header->oh_len  = count;
295         header->oh_xxx  = 0x03;
296         header->oh_pad  = 0x00;
297
298         /* send the data out the bulk port, always 64 bytes */
299         wport->write_urb->transfer_buffer_length = 64;
300
301         wport->write_urb->dev = serial->dev;
302         result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
303         if (result) {
304                 wport->write_urb_busy = 0;
305                 dev_err(&port->dev,
306                         "%s - failed submitting write urb, error %d\n",
307                         __func__, result);
308         } else
309                 result = count;
310
311         return result;
312 }
313
314
315 static int omninet_write_room(struct tty_struct *tty)
316 {
317         struct usb_serial_port *port = tty->driver_data;
318         struct usb_serial       *serial = port->serial;
319         struct usb_serial_port  *wport  = serial->port[1];
320
321         int room = 0; /* Default: no room */
322
323         /* FIXME: no consistent locking for write_urb_busy */
324         if (!wport->write_urb_busy)
325                 room = wport->bulk_out_size - OMNINET_HEADERLEN;
326
327         dbg("%s - returns %d", __func__, room);
328
329         return room;
330 }
331
332 static void omninet_write_bulk_callback(struct urb *urb)
333 {
334 /*      struct omninet_header   *header = (struct omninet_header  *)
335                                                 urb->transfer_buffer; */
336         struct usb_serial_port  *port   =  urb->context;
337         int status = urb->status;
338
339         dbg("%s - port %0x", __func__, port->number);
340
341         port->write_urb_busy = 0;
342         if (status) {
343                 dbg("%s - nonzero write bulk status received: %d",
344                     __func__, status);
345                 return;
346         }
347
348         usb_serial_port_softint(port);
349 }
350
351
352 static void omninet_disconnect(struct usb_serial *serial)
353 {
354         struct usb_serial_port *wport = serial->port[1];
355
356         dbg("%s", __func__);
357
358         usb_kill_urb(wport->write_urb);
359 }
360
361
362 static void omninet_release(struct usb_serial *serial)
363 {
364         struct usb_serial_port *port = serial->port[0];
365
366         dbg("%s", __func__);
367
368         kfree(usb_get_serial_port_data(port));
369 }
370
371
372 static int __init omninet_init(void)
373 {
374         int retval;
375         retval = usb_serial_register(&zyxel_omninet_device);
376         if (retval)
377                 goto failed_usb_serial_register;
378         retval = usb_register(&omninet_driver);
379         if (retval)
380                 goto failed_usb_register;
381         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
382                DRIVER_DESC "\n");
383         return 0;
384 failed_usb_register:
385         usb_serial_deregister(&zyxel_omninet_device);
386 failed_usb_serial_register:
387         return retval;
388 }
389
390
391 static void __exit omninet_exit(void)
392 {
393         usb_deregister(&omninet_driver);
394         usb_serial_deregister(&zyxel_omninet_device);
395 }
396
397
398 module_init(omninet_init);
399 module_exit(omninet_exit);
400
401 MODULE_AUTHOR(DRIVER_AUTHOR);
402 MODULE_DESCRIPTION(DRIVER_DESC);
403 MODULE_LICENSE("GPL");
404
405 module_param(debug, bool, S_IRUGO | S_IWUSR);
406 MODULE_PARM_DESC(debug, "Debug enabled or not");