Merge commit 'kumar/kumar-next' into next
[linux-2.6-block.git] / drivers / usb / serial / omninet.c
CommitLineData
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
f89d0dff 12 *
1da177e4 13 * (05/30/2001) gkh
f89d0dff
AC
14 * switched from using spinlock to a semaphore, which fixes lots of
15 * problems.
1da177e4
LT
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
f89d0dff 22 *
1da177e4
LT
23 * (10/05/2000) gkh
24 * Fixed bug with urb->dev not being set properly, now that the usb
25 * core needs it.
f89d0dff 26 *
1da177e4
LT
27 * (08/28/2000) gkh
28 * Added locks for SMP safeness.
f89d0dff 29 * Fixed MOD_INC and MOD_DEC logic and the ability to open a port more
1da177e4
LT
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
1da177e4
LT
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>
f89d0dff 48#include <linux/uaccess.h>
1da177e4 49#include <linux/usb.h>
a969888c 50#include <linux/usb/serial.h>
1da177e4
LT
51
52static 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
f89d0dff
AC
63/* This one seems to be a re-branded ZyXEL device */
64#define BT_IGNITIONPRO_ID 0x2000
1da177e4
LT
65
66/* function prototypes */
f89d0dff
AC
67static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port,
68 struct file *filp);
69static void omninet_close(struct tty_struct *tty, struct usb_serial_port *port,
70 struct file *filp);
71static void omninet_read_bulk_callback(struct urb *urb);
72static void omninet_write_bulk_callback(struct urb *urb);
73static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
74 const unsigned char *buf, int count);
75static int omninet_write_room(struct tty_struct *tty);
76static void omninet_shutdown(struct usb_serial *serial);
77static int omninet_attach(struct usb_serial *serial);
78
79static struct usb_device_id id_table[] = {
1da177e4
LT
80 { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
81 { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
82 { } /* Terminating entry */
83};
84
f89d0dff 85MODULE_DEVICE_TABLE(usb, id_table);
1da177e4
LT
86
87static struct usb_driver omninet_driver = {
1da177e4
LT
88 .name = "omninet",
89 .probe = usb_serial_probe,
90 .disconnect = usb_serial_disconnect,
91 .id_table = id_table,
ba9dc657 92 .no_dynamic_id = 1,
1da177e4
LT
93};
94
95
ea65370d 96static struct usb_serial_driver zyxel_omninet_device = {
18fcac35
GKH
97 .driver = {
98 .owner = THIS_MODULE,
269bda1c 99 .name = "omninet",
18fcac35 100 },
269bda1c 101 .description = "ZyXEL - omni.net lcd plus usb",
d9b1b787 102 .usb_driver = &omninet_driver,
1da177e4 103 .id_table = id_table,
1da177e4 104 .num_ports = 1,
5ec1862e 105 .attach = omninet_attach,
1da177e4
LT
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
f89d0dff 139struct omninet_header {
1da177e4
LT
140 __u8 oh_seq;
141 __u8 oh_len;
142 __u8 oh_xxx;
143 __u8 oh_pad;
144};
145
f89d0dff
AC
146struct omninet_data {
147 __u8 od_outseq; /* Sequence number for bulk_out URBs */
1da177e4
LT
148};
149
f89d0dff 150static int omninet_attach(struct usb_serial *serial)
5ec1862e
ON
151{
152 struct omninet_data *od;
153 struct usb_serial_port *port = serial->port[0];
154
f89d0dff
AC
155 od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
156 if (!od) {
194343d9
GKH
157 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
158 __func__, sizeof(struct omninet_data));
5ec1862e
ON
159 return -ENOMEM;
160 }
161 usb_set_serial_port_data(port, od);
162 return 0;
163}
164
95da310e
AC
165static int omninet_open(struct tty_struct *tty,
166 struct usb_serial_port *port, struct file *filp)
1da177e4
LT
167{
168 struct usb_serial *serial = port->serial;
169 struct usb_serial_port *wport;
1da177e4
LT
170 int result = 0;
171
441b62c1 172 dbg("%s - port %d", __func__, port->number);
1da177e4 173
1da177e4 174 wport = serial->port[1];
4a90f09b 175 tty_port_tty_set(&wport->port, tty);
1da177e4
LT
176
177 /* Start reading from the device */
f89d0dff
AC
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);
1da177e4 184 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
f89d0dff 185 if (result)
194343d9
GKH
186 dev_err(&port->dev,
187 "%s - failed submitting read urb, error %d\n",
188 __func__, result);
1da177e4
LT
189 return result;
190}
191
95da310e 192static void omninet_close(struct tty_struct *tty,
f89d0dff 193 struct usb_serial_port *port, struct file *filp)
1da177e4 194{
441b62c1 195 dbg("%s - port %d", __func__, port->number);
1da177e4 196 usb_kill_urb(port->read_urb);
1da177e4
LT
197}
198
199
200#define OMNINET_DATAOFFSET 0x04
201#define OMNINET_HEADERLEN sizeof(struct omninet_header)
202#define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN)
203
f89d0dff 204static void omninet_read_bulk_callback(struct urb *urb)
1da177e4 205{
cdc97792 206 struct usb_serial_port *port = urb->context;
1da177e4
LT
207 unsigned char *data = urb->transfer_buffer;
208 struct omninet_header *header = (struct omninet_header *) &data[0];
fdc2deb3 209 int status = urb->status;
1da177e4 210 int result;
4944d400 211 int i;
1da177e4 212
441b62c1 213 dbg("%s - port %d", __func__, port->number);
1da177e4 214
fdc2deb3
GKH
215 if (status) {
216 dbg("%s - nonzero read bulk status received: %d",
441b62c1 217 __func__, status);
1da177e4
LT
218 return;
219 }
220
f89d0dff 221 if (debug && header->oh_xxx != 0x30) {
1da177e4 222 if (urb->actual_length) {
f89d0dff
AC
223 printk(KERN_DEBUG __FILE__
224 ": omninet_read %d: ", header->oh_len);
225 for (i = 0; i < (header->oh_len +
226 OMNINET_HEADERLEN); i++)
227 printk("%.2x ", data[i]);
228 printk("\n");
1da177e4
LT
229 }
230 }
231
232 if (urb->actual_length && header->oh_len) {
4a90f09b
AC
233 struct tty_struct *tty = tty_port_tty_get(&port->port);
234 tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
235 header->oh_len);
236 tty_flip_buffer_push(tty);
237 tty_kref_put(tty);
1da177e4
LT
238 }
239
240 /* Continue trying to always read */
f89d0dff
AC
241 usb_fill_bulk_urb(urb, port->serial->dev,
242 usb_rcvbulkpipe(port->serial->dev,
243 port->bulk_in_endpointAddress),
244 urb->transfer_buffer, urb->transfer_buffer_length,
245 omninet_read_bulk_callback, port);
1da177e4
LT
246 result = usb_submit_urb(urb, GFP_ATOMIC);
247 if (result)
194343d9
GKH
248 dev_err(&port->dev,
249 "%s - failed resubmitting read urb, error %d\n",
250 __func__, result);
1da177e4
LT
251
252 return;
253}
254
95da310e
AC
255static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
256 const unsigned char *buf, int count)
1da177e4 257{
f89d0dff
AC
258 struct usb_serial *serial = port->serial;
259 struct usb_serial_port *wport = serial->port[1];
1da177e4 260
f89d0dff
AC
261 struct omninet_data *od = usb_get_serial_port_data(port);
262 struct omninet_header *header = (struct omninet_header *)
263 wport->write_urb->transfer_buffer;
1da177e4
LT
264
265 int result;
266
441b62c1 267 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
268
269 if (count == 0) {
441b62c1 270 dbg("%s - write request of 0 bytes", __func__);
f89d0dff 271 return 0;
1da177e4 272 }
507ca9bc 273
e81ee637 274 spin_lock_bh(&wport->lock);
df3fccb1 275 if (wport->write_urb_busy) {
e81ee637 276 spin_unlock_bh(&wport->lock);
441b62c1 277 dbg("%s - already writing", __func__);
507ca9bc 278 return 0;
1da177e4 279 }
df3fccb1 280 wport->write_urb_busy = 1;
e81ee637 281 spin_unlock_bh(&wport->lock);
1da177e4
LT
282
283 count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
284
f89d0dff
AC
285 memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
286 buf, count);
1da177e4 287
f89d0dff
AC
288 usb_serial_debug_data(debug, &port->dev, __func__, count,
289 wport->write_urb->transfer_buffer);
1da177e4
LT
290
291 header->oh_seq = od->od_outseq++;
292 header->oh_len = count;
293 header->oh_xxx = 0x03;
294 header->oh_pad = 0x00;
295
296 /* send the data out the bulk port, always 64 bytes */
297 wport->write_urb->transfer_buffer_length = 64;
298
299 wport->write_urb->dev = serial->dev;
300 result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
507ca9bc 301 if (result) {
df3fccb1 302 wport->write_urb_busy = 0;
194343d9
GKH
303 dev_err(&port->dev,
304 "%s - failed submitting write urb, error %d\n",
305 __func__, result);
507ca9bc 306 } else
1da177e4
LT
307 result = count;
308
309 return result;
310}
311
312
f89d0dff 313static int omninet_write_room(struct tty_struct *tty)
1da177e4 314{
95da310e 315 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
316 struct usb_serial *serial = port->serial;
317 struct usb_serial_port *wport = serial->port[1];
318
a5b6f60c 319 int room = 0; /* Default: no room */
1da177e4 320
a5b6f60c 321 /* FIXME: no consistent locking for write_urb_busy */
507ca9bc 322 if (wport->write_urb_busy)
1da177e4
LT
323 room = wport->bulk_out_size - OMNINET_HEADERLEN;
324
441b62c1 325 dbg("%s - returns %d", __func__, room);
1da177e4 326
f89d0dff 327 return room;
1da177e4
LT
328}
329
f89d0dff 330static void omninet_write_bulk_callback(struct urb *urb)
1da177e4 331{
f89d0dff
AC
332/* struct omninet_header *header = (struct omninet_header *)
333 urb->transfer_buffer; */
cdc97792 334 struct usb_serial_port *port = urb->context;
fdc2deb3 335 int status = urb->status;
1da177e4 336
441b62c1 337 dbg("%s - port %0x\n", __func__, port->number);
1da177e4 338
507ca9bc 339 port->write_urb_busy = 0;
fdc2deb3
GKH
340 if (status) {
341 dbg("%s - nonzero write bulk status received: %d",
441b62c1 342 __func__, status);
1da177e4
LT
343 return;
344 }
345
cf2c7481 346 usb_serial_port_softint(port);
1da177e4
LT
347}
348
349
f89d0dff 350static void omninet_shutdown(struct usb_serial *serial)
1da177e4 351{
5ec1862e
ON
352 struct usb_serial_port *wport = serial->port[1];
353 struct usb_serial_port *port = serial->port[0];
f89d0dff 354 dbg("%s", __func__);
5ec1862e
ON
355
356 usb_kill_urb(wport->write_urb);
357 kfree(usb_get_serial_port_data(port));
1da177e4
LT
358}
359
360
f89d0dff 361static int __init omninet_init(void)
1da177e4
LT
362{
363 int retval;
364 retval = usb_serial_register(&zyxel_omninet_device);
365 if (retval)
366 goto failed_usb_serial_register;
367 retval = usb_register(&omninet_driver);
368 if (retval)
369 goto failed_usb_register;
c197a8db
GKH
370 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
371 DRIVER_DESC "\n");
1da177e4
LT
372 return 0;
373failed_usb_register:
374 usb_serial_deregister(&zyxel_omninet_device);
375failed_usb_serial_register:
376 return retval;
377}
378
379
f89d0dff 380static void __exit omninet_exit(void)
1da177e4 381{
f89d0dff
AC
382 usb_deregister(&omninet_driver);
383 usb_serial_deregister(&zyxel_omninet_device);
1da177e4
LT
384}
385
386
387module_init(omninet_init);
388module_exit(omninet_exit);
389
f89d0dff
AC
390MODULE_AUTHOR(DRIVER_AUTHOR);
391MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4
LT
392MODULE_LICENSE("GPL");
393
394module_param(debug, bool, S_IRUGO | S_IWUSR);
395MODULE_PARM_DESC(debug, "Debug enabled or not");