IRQ: Maintain regs pointer globally rather than passing to IRQ handlers
[linux-2.6.git] / drivers / usb / serial / keyspan_pda.c
1 /*
2  * USB Keyspan PDA / Xircom / Entregra Converter driver
3  *
4  * Copyright (C) 1999 - 2001 Greg Kroah-Hartman <greg@kroah.com>
5  * Copyright (C) 1999, 2000 Brian Warner        <warner@lothar.com>
6  * Copyright (C) 2000 Al Borchers               <borchers@steinerpoint.com>
7  *
8  *      This program is free software; you can redistribute it and/or modify
9  *      it under the terms of the GNU General Public License as published by
10  *      the Free Software Foundation; either version 2 of the License, or
11  *      (at your option) any later version.
12  *
13  * See Documentation/usb/usb-serial.txt for more information on using this driver
14  * 
15  * (09/07/2001) gkh
16  *      cleaned up the Xircom support.  Added ids for Entregra device which is
17  *      the same as the Xircom device.  Enabled the code to be compiled for
18  *      either Xircom or Keyspan devices.
19  *
20  * (08/11/2001) Cristian M. Craciunescu
21  *      support for Xircom PGSDB9
22  *
23  * (05/31/2001) gkh
24  *      switched from using spinlock to a semaphore, which fixes lots of problems.
25  *
26  * (04/08/2001) gb
27  *      Identify version on module load.
28  * 
29  * (11/01/2000) Adam J. Richter
30  *      usb_device_id table support
31  * 
32  * (10/05/2000) gkh
33  *      Fixed bug with urb->dev not being set properly, now that the usb
34  *      core needs it.
35  * 
36  * (08/28/2000) gkh
37  *      Added locks for SMP safeness.
38  *      Fixed MOD_INC and MOD_DEC logic and the ability to open a port more 
39  *      than once.
40  * 
41  * (07/20/2000) borchers
42  *      - keyspan_pda_write no longer sleeps if it is called on interrupt time;
43  *        PPP and the line discipline with stty echo on can call write on
44  *        interrupt time and this would cause an oops if write slept
45  *      - if keyspan_pda_write is in an interrupt, it will not call
46  *        usb_control_msg (which sleeps) to query the room in the device
47  *        buffer, it simply uses the current room value it has
48  *      - if the urb is busy or if it is throttled keyspan_pda_write just
49  *        returns 0, rather than sleeping to wait for this to change; the
50  *        write_chan code in n_tty.c will sleep if needed before calling
51  *        keyspan_pda_write again
52  *      - if the device needs to be unthrottled, write now queues up the
53  *        call to usb_control_msg (which sleeps) to unthrottle the device
54  *      - the wakeups from keyspan_pda_write_bulk_callback are queued rather
55  *        than done directly from the callback to avoid the race in write_chan
56  *      - keyspan_pda_chars_in_buffer also indicates its buffer is full if the
57  *        urb status is -EINPROGRESS, meaning it cannot write at the moment
58  *      
59  * (07/19/2000) gkh
60  *      Added module_init and module_exit functions to handle the fact that this
61  *      driver is a loadable module now.
62  *
63  * (03/26/2000) gkh
64  *      Split driver up into device specific pieces.
65  * 
66  */
67
68
69 #include <linux/kernel.h>
70 #include <linux/errno.h>
71 #include <linux/init.h>
72 #include <linux/slab.h>
73 #include <linux/tty.h>
74 #include <linux/tty_driver.h>
75 #include <linux/tty_flip.h>
76 #include <linux/module.h>
77 #include <linux/spinlock.h>
78 #include <linux/workqueue.h>
79 #include <asm/uaccess.h>
80 #include <linux/usb.h>
81 #include <linux/usb/serial.h>
82
83 static int debug;
84
85 struct ezusb_hex_record {
86         __u16 address;
87         __u8 data_size;
88         __u8 data[16];
89 };
90
91 /* make a simple define to handle if we are compiling keyspan_pda or xircom support */
92 #if defined(CONFIG_USB_SERIAL_KEYSPAN_PDA) || defined(CONFIG_USB_SERIAL_KEYSPAN_PDA_MODULE)
93         #define KEYSPAN
94 #else
95         #undef KEYSPAN
96 #endif
97 #if defined(CONFIG_USB_SERIAL_XIRCOM) || defined(CONFIG_USB_SERIAL_XIRCOM_MODULE)
98         #define XIRCOM
99 #else
100         #undef XIRCOM
101 #endif
102
103 #ifdef KEYSPAN
104 #include "keyspan_pda_fw.h"
105 #endif
106
107 #ifdef XIRCOM
108 #include "xircom_pgs_fw.h"
109 #endif
110
111 /*
112  * Version Information
113  */
114 #define DRIVER_VERSION "v1.1"
115 #define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
116 #define DRIVER_DESC "USB Keyspan PDA Converter driver"
117
118 struct keyspan_pda_private {
119         int                     tx_room;
120         int                     tx_throttled;
121         struct work_struct                      wakeup_work;
122         struct work_struct                      unthrottle_work;
123 };
124
125
126 #define KEYSPAN_VENDOR_ID               0x06cd
127 #define KEYSPAN_PDA_FAKE_ID             0x0103
128 #define KEYSPAN_PDA_ID                  0x0104 /* no clue */
129
130 /* For Xircom PGSDB9 and older Entregra version of the same device */
131 #define XIRCOM_VENDOR_ID                0x085a
132 #define XIRCOM_FAKE_ID                  0x8027
133 #define ENTREGRA_VENDOR_ID              0x1645
134 #define ENTREGRA_FAKE_ID                0x8093
135
136 static struct usb_device_id id_table_combined [] = {
137 #ifdef KEYSPAN
138         { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
139 #endif
140 #ifdef XIRCOM
141         { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
142         { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
143 #endif
144         { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
145         { }                                             /* Terminating entry */
146 };
147
148 MODULE_DEVICE_TABLE (usb, id_table_combined);
149
150 static struct usb_driver keyspan_pda_driver = {
151         .name =         "keyspan_pda",
152         .probe =        usb_serial_probe,
153         .disconnect =   usb_serial_disconnect,
154         .id_table =     id_table_combined,
155         .no_dynamic_id =        1,
156 };
157
158 static struct usb_device_id id_table_std [] = {
159         { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
160         { }                                             /* Terminating entry */
161 };
162
163 #ifdef KEYSPAN
164 static struct usb_device_id id_table_fake [] = {
165         { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
166         { }                                             /* Terminating entry */
167 };
168 #endif
169
170 #ifdef XIRCOM
171 static struct usb_device_id id_table_fake_xircom [] = {
172         { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
173         { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
174         { }                                             
175 };
176 #endif
177
178 static void keyspan_pda_wakeup_write( struct usb_serial_port *port )
179 {
180
181         struct tty_struct *tty = port->tty;
182
183         /* wake up port processes */
184         wake_up_interruptible( &port->write_wait );
185
186         /* wake up line discipline */
187         tty_wakeup(tty);
188 }
189
190 static void keyspan_pda_request_unthrottle( struct usb_serial *serial )
191 {
192         int result;
193
194         dbg(" request_unthrottle");
195         /* ask the device to tell us when the tx buffer becomes
196            sufficiently empty */
197         result = usb_control_msg(serial->dev, 
198                                  usb_sndctrlpipe(serial->dev, 0),
199                                  7, /* request_unthrottle */
200                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE
201                                  | USB_DIR_OUT,
202                                  16, /* value: threshold */
203                                  0, /* index */
204                                  NULL,
205                                  0,
206                                  2000);
207         if (result < 0)
208                 dbg("%s - error %d from usb_control_msg", 
209                     __FUNCTION__, result);
210 }
211
212
213 static void keyspan_pda_rx_interrupt (struct urb *urb)
214 {
215         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
216         struct tty_struct *tty = port->tty;
217         unsigned char *data = urb->transfer_buffer;
218         int i;
219         int status;
220         struct keyspan_pda_private *priv;
221         priv = usb_get_serial_port_data(port);
222
223         switch (urb->status) {
224         case 0:
225                 /* success */
226                 break;
227         case -ECONNRESET:
228         case -ENOENT:
229         case -ESHUTDOWN:
230                 /* this urb is terminated, clean up */
231                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
232                 return;
233         default:
234                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
235                 goto exit;
236         }
237
238         /* see if the message is data or a status interrupt */
239         switch (data[0]) {
240         case 0:
241                 /* rest of message is rx data */
242                 if (urb->actual_length) {
243                         for (i = 1; i < urb->actual_length ; ++i) {
244                                 tty_insert_flip_char(tty, data[i], 0);
245                         }
246                         tty_flip_buffer_push(tty);
247                 }
248                 break;
249         case 1:
250                 /* status interrupt */
251                 dbg(" rx int, d1=%d, d2=%d", data[1], data[2]);
252                 switch (data[1]) {
253                 case 1: /* modemline change */
254                         break;
255                 case 2: /* tx unthrottle interrupt */
256                         priv->tx_throttled = 0;
257                         /* queue up a wakeup at scheduler time */
258                         schedule_work(&priv->wakeup_work);
259                         break;
260                 default:
261                         break;
262                 }
263                 break;
264         default:
265                 break;
266         }
267
268 exit:
269         status = usb_submit_urb (urb, GFP_ATOMIC);
270         if (status)
271                 err ("%s - usb_submit_urb failed with result %d",
272                      __FUNCTION__, status);
273 }
274
275
276 static void keyspan_pda_rx_throttle (struct usb_serial_port *port)
277 {
278         /* stop receiving characters. We just turn off the URB request, and
279            let chars pile up in the device. If we're doing hardware
280            flowcontrol, the device will signal the other end when its buffer
281            fills up. If we're doing XON/XOFF, this would be a good time to
282            send an XOFF, although it might make sense to foist that off
283            upon the device too. */
284
285         dbg("keyspan_pda_rx_throttle port %d", port->number);
286         usb_kill_urb(port->interrupt_in_urb);
287 }
288
289
290 static void keyspan_pda_rx_unthrottle (struct usb_serial_port *port)
291 {
292         /* just restart the receive interrupt URB */
293         dbg("keyspan_pda_rx_unthrottle port %d", port->number);
294         port->interrupt_in_urb->dev = port->serial->dev;
295         if (usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC))
296                 dbg(" usb_submit_urb(read urb) failed");
297         return;
298 }
299
300
301 static int keyspan_pda_setbaud (struct usb_serial *serial, int baud)
302 {
303         int rc;
304         int bindex;
305
306         switch(baud) {
307                 case 110: bindex = 0; break;
308                 case 300: bindex = 1; break;
309                 case 1200: bindex = 2; break;
310                 case 2400: bindex = 3; break;
311                 case 4800: bindex = 4; break;
312                 case 9600: bindex = 5; break;
313                 case 19200: bindex = 6; break;
314                 case 38400: bindex = 7; break;
315                 case 57600: bindex = 8; break;
316                 case 115200: bindex = 9; break;
317                 default: return -EINVAL;
318         }
319
320         /* rather than figure out how to sleep while waiting for this
321            to complete, I just use the "legacy" API. */
322         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
323                              0, /* set baud */
324                              USB_TYPE_VENDOR 
325                              | USB_RECIP_INTERFACE
326                              | USB_DIR_OUT, /* type */
327                              bindex, /* value */
328                              0, /* index */
329                              NULL, /* &data */
330                              0, /* size */
331                              2000); /* timeout */
332         return(rc);
333 }
334
335
336 static void keyspan_pda_break_ctl (struct usb_serial_port *port, int break_state)
337 {
338         struct usb_serial *serial = port->serial;
339         int value;
340         int result;
341
342         if (break_state == -1)
343                 value = 1; /* start break */
344         else
345                 value = 0; /* clear break */
346         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
347                                 4, /* set break */
348                                 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
349                                 value, 0, NULL, 0, 2000);
350         if (result < 0)
351                 dbg("%s - error %d from usb_control_msg", 
352                     __FUNCTION__, result);
353         /* there is something funky about this.. the TCSBRK that 'cu' performs
354            ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
355            seconds apart, but it feels like the break sent isn't as long as it
356            is on /dev/ttyS0 */
357 }
358
359
360 static void keyspan_pda_set_termios (struct usb_serial_port *port, 
361                                      struct termios *old_termios)
362 {
363         struct usb_serial *serial = port->serial;
364         unsigned int cflag = port->tty->termios->c_cflag;
365
366         /* cflag specifies lots of stuff: number of stop bits, parity, number
367            of data bits, baud. What can the device actually handle?:
368            CSTOPB (1 stop bit or 2)
369            PARENB (parity)
370            CSIZE (5bit .. 8bit)
371            There is minimal hw support for parity (a PSW bit seems to hold the
372            parity of whatever is in the accumulator). The UART either deals
373            with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
374            1 special, stop). So, with firmware changes, we could do:
375            8N1: 10 bit
376            8N2: 11 bit, extra bit always (mark?)
377            8[EOMS]1: 11 bit, extra bit is parity
378            7[EOMS]1: 10 bit, b0/b7 is parity
379            7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
380
381            HW flow control is dictated by the tty->termios->c_cflags & CRTSCTS
382            bit.
383
384            For now, just do baud. */
385
386         switch (cflag & CBAUD) {
387                 /* we could support more values here, just need to calculate
388                    the necessary divisors in the firmware. <asm/termbits.h>
389                    has the Bnnn constants. */
390                 case B110: keyspan_pda_setbaud(serial, 110); break;
391                 case B300: keyspan_pda_setbaud(serial, 300); break;
392                 case B1200: keyspan_pda_setbaud(serial, 1200); break;
393                 case B2400: keyspan_pda_setbaud(serial, 2400); break;
394                 case B4800: keyspan_pda_setbaud(serial, 4800); break;
395                 case B9600: keyspan_pda_setbaud(serial, 9600); break;
396                 case B19200: keyspan_pda_setbaud(serial, 19200); break;
397                 case B38400: keyspan_pda_setbaud(serial, 38400); break;
398                 case B57600: keyspan_pda_setbaud(serial, 57600); break;
399                 case B115200: keyspan_pda_setbaud(serial, 115200); break;
400                 default: dbg("can't handle requested baud rate"); break;
401         }
402 }
403
404
405 /* modem control pins: DTR and RTS are outputs and can be controlled.
406    DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
407    read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
408
409 static int keyspan_pda_get_modem_info(struct usb_serial *serial,
410                                       unsigned char *value)
411 {
412         int rc;
413         unsigned char data;
414         rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
415                              3, /* get pins */
416                              USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
417                              0, 0, &data, 1, 2000);
418         if (rc > 0)
419                 *value = data;
420         return rc;
421 }
422
423
424 static int keyspan_pda_set_modem_info(struct usb_serial *serial,
425                                       unsigned char value)
426 {
427         int rc;
428         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
429                              3, /* set pins */
430                              USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
431                              value, 0, NULL, 0, 2000);
432         return rc;
433 }
434
435 static int keyspan_pda_tiocmget(struct usb_serial_port *port, struct file *file)
436 {
437         struct usb_serial *serial = port->serial;
438         int rc;
439         unsigned char status;
440         int value;
441
442         rc = keyspan_pda_get_modem_info(serial, &status);
443         if (rc < 0)
444                 return rc;
445         value =
446                 ((status & (1<<7)) ? TIOCM_DTR : 0) |
447                 ((status & (1<<6)) ? TIOCM_CAR : 0) |
448                 ((status & (1<<5)) ? TIOCM_RNG : 0) |
449                 ((status & (1<<4)) ? TIOCM_DSR : 0) |
450                 ((status & (1<<3)) ? TIOCM_CTS : 0) |
451                 ((status & (1<<2)) ? TIOCM_RTS : 0);
452         return value;
453 }
454
455 static int keyspan_pda_tiocmset(struct usb_serial_port *port, struct file *file,
456                                 unsigned int set, unsigned int clear)
457 {
458         struct usb_serial *serial = port->serial;
459         int rc;
460         unsigned char status;
461
462         rc = keyspan_pda_get_modem_info(serial, &status);
463         if (rc < 0)
464                 return rc;
465
466         if (set & TIOCM_RTS)
467                 status |= (1<<2);
468         if (set & TIOCM_DTR)
469                 status |= (1<<7);
470
471         if (clear & TIOCM_RTS)
472                 status &= ~(1<<2);
473         if (clear & TIOCM_DTR)
474                 status &= ~(1<<7);
475         rc = keyspan_pda_set_modem_info(serial, status);
476         return rc;
477 }
478
479 static int keyspan_pda_ioctl(struct usb_serial_port *port, struct file *file,
480                              unsigned int cmd, unsigned long arg)
481 {
482         switch (cmd) {
483         case TIOCMIWAIT:
484                 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
485                 /* TODO */
486         case TIOCGICOUNT:
487                 /* return count of modemline transitions */
488                 return 0; /* TODO */
489         }
490         
491         return -ENOIOCTLCMD;
492 }
493
494 static int keyspan_pda_write(struct usb_serial_port *port, 
495                              const unsigned char *buf, int count)
496 {
497         struct usb_serial *serial = port->serial;
498         int request_unthrottle = 0;
499         int rc = 0;
500         struct keyspan_pda_private *priv;
501
502         priv = usb_get_serial_port_data(port);
503         /* guess how much room is left in the device's ring buffer, and if we
504            want to send more than that, check first, updating our notion of
505            what is left. If our write will result in no room left, ask the
506            device to give us an interrupt when the room available rises above
507            a threshold, and hold off all writers (eventually, those using
508            select() or poll() too) until we receive that unthrottle interrupt.
509            Block if we can't write anything at all, otherwise write as much as
510            we can. */
511         dbg("keyspan_pda_write(%d)",count);
512         if (count == 0) {
513                 dbg(" write request of 0 bytes");
514                 return (0);
515         }
516
517         /* we might block because of:
518            the TX urb is in-flight (wait until it completes)
519            the device is full (wait until it says there is room)
520         */
521         spin_lock_bh(&port->lock);
522         if (port->write_urb_busy || priv->tx_throttled) {
523                 spin_unlock_bh(&port->lock);
524                 return 0;
525         }
526         port->write_urb_busy = 1;
527         spin_unlock_bh(&port->lock);
528
529         /* At this point the URB is in our control, nobody else can submit it
530            again (the only sudden transition was the one from EINPROGRESS to
531            finished).  Also, the tx process is not throttled. So we are
532            ready to write. */
533
534         count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
535
536         /* Check if we might overrun the Tx buffer.   If so, ask the
537            device how much room it really has.  This is done only on
538            scheduler time, since usb_control_msg() sleeps. */
539         if (count > priv->tx_room && !in_interrupt()) {
540                 unsigned char room;
541                 rc = usb_control_msg(serial->dev, 
542                                      usb_rcvctrlpipe(serial->dev, 0),
543                                      6, /* write_room */
544                                      USB_TYPE_VENDOR | USB_RECIP_INTERFACE
545                                      | USB_DIR_IN,
546                                      0, /* value: 0 means "remaining room" */
547                                      0, /* index */
548                                      &room,
549                                      1,
550                                      2000);
551                 if (rc < 0) {
552                         dbg(" roomquery failed");
553                         goto exit;
554                 }
555                 if (rc == 0) {
556                         dbg(" roomquery returned 0 bytes");
557                         rc = -EIO; /* device didn't return any data */
558                         goto exit;
559                 }
560                 dbg(" roomquery says %d", room);
561                 priv->tx_room = room;
562         }
563         if (count > priv->tx_room) {
564                 /* we're about to completely fill the Tx buffer, so
565                    we'll be throttled afterwards. */
566                 count = priv->tx_room;
567                 request_unthrottle = 1;
568         }
569
570         if (count) {
571                 /* now transfer data */
572                 memcpy (port->write_urb->transfer_buffer, buf, count);
573                 /* send the data out the bulk port */
574                 port->write_urb->transfer_buffer_length = count;
575
576                 priv->tx_room -= count;
577
578                 port->write_urb->dev = port->serial->dev;
579                 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
580                 if (rc) {
581                         dbg(" usb_submit_urb(write bulk) failed");
582                         goto exit;
583                 }
584         }
585         else {
586                 /* There wasn't any room left, so we are throttled until
587                    the buffer empties a bit */
588                 request_unthrottle = 1;
589         }
590
591         if (request_unthrottle) {
592                 priv->tx_throttled = 1; /* block writers */
593                 schedule_work(&priv->unthrottle_work);
594         }
595
596         rc = count;
597 exit:
598         if (rc < 0)
599                 port->write_urb_busy = 0;
600         return rc;
601 }
602
603
604 static void keyspan_pda_write_bulk_callback (struct urb *urb)
605 {
606         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
607         struct keyspan_pda_private *priv;
608
609         port->write_urb_busy = 0;
610         priv = usb_get_serial_port_data(port);
611
612         /* queue up a wakeup at scheduler time */
613         schedule_work(&priv->wakeup_work);
614 }
615
616
617 static int keyspan_pda_write_room (struct usb_serial_port *port)
618 {
619         struct keyspan_pda_private *priv;
620
621         priv = usb_get_serial_port_data(port);
622
623         /* used by n_tty.c for processing of tabs and such. Giving it our
624            conservative guess is probably good enough, but needs testing by
625            running a console through the device. */
626
627         return (priv->tx_room);
628 }
629
630
631 static int keyspan_pda_chars_in_buffer (struct usb_serial_port *port)
632 {
633         struct keyspan_pda_private *priv;
634
635         priv = usb_get_serial_port_data(port);
636
637         /* when throttled, return at least WAKEUP_CHARS to tell select() (via
638            n_tty.c:normal_poll() ) that we're not writeable. */
639         if (port->write_urb_busy || priv->tx_throttled)
640                 return 256;
641         return 0;
642 }
643
644
645 static int keyspan_pda_open (struct usb_serial_port *port, struct file *filp)
646 {
647         struct usb_serial *serial = port->serial;
648         unsigned char room;
649         int rc = 0;
650         struct keyspan_pda_private *priv;
651
652         /* find out how much room is in the Tx ring */
653         rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
654                              6, /* write_room */
655                              USB_TYPE_VENDOR | USB_RECIP_INTERFACE
656                              | USB_DIR_IN,
657                              0, /* value */
658                              0, /* index */
659                              &room,
660                              1,
661                              2000);
662         if (rc < 0) {
663                 dbg("%s - roomquery failed", __FUNCTION__);
664                 goto error;
665         }
666         if (rc == 0) {
667                 dbg("%s - roomquery returned 0 bytes", __FUNCTION__);
668                 rc = -EIO;
669                 goto error;
670         }
671         priv = usb_get_serial_port_data(port);
672         priv->tx_room = room;
673         priv->tx_throttled = room ? 0 : 1;
674
675         /* the normal serial device seems to always turn on DTR and RTS here,
676            so do the same */
677         if (port->tty->termios->c_cflag & CBAUD)
678                 keyspan_pda_set_modem_info(serial, (1<<7) | (1<<2) );
679         else
680                 keyspan_pda_set_modem_info(serial, 0);
681
682         /*Start reading from the device*/
683         port->interrupt_in_urb->dev = serial->dev;
684         rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
685         if (rc) {
686                 dbg("%s - usb_submit_urb(read int) failed", __FUNCTION__);
687                 goto error;
688         }
689
690 error:
691         return rc;
692 }
693
694
695 static void keyspan_pda_close(struct usb_serial_port *port, struct file *filp)
696 {
697         struct usb_serial *serial = port->serial;
698
699         if (serial->dev) {
700                 /* the normal serial device seems to always shut off DTR and RTS now */
701                 if (port->tty->termios->c_cflag & HUPCL)
702                         keyspan_pda_set_modem_info(serial, 0);
703
704                 /* shutdown our bulk reads and writes */
705                 usb_kill_urb(port->write_urb);
706                 usb_kill_urb(port->interrupt_in_urb);
707         }
708 }
709
710
711 /* download the firmware to a "fake" device (pre-renumeration) */
712 static int keyspan_pda_fake_startup (struct usb_serial *serial)
713 {
714         int response;
715         const struct ezusb_hex_record *record = NULL;
716
717         /* download the firmware here ... */
718         response = ezusb_set_reset(serial, 1);
719
720 #ifdef KEYSPAN
721         if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
722                 record = &keyspan_pda_firmware[0];
723 #endif
724 #ifdef XIRCOM
725         if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
726             (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGRA_VENDOR_ID))
727                 record = &xircom_pgs_firmware[0];
728 #endif
729         if (record == NULL) {
730                 err("%s: unknown vendor, aborting.", __FUNCTION__);
731                 return -ENODEV;
732         }
733
734         while(record->address != 0xffff) {
735                 response = ezusb_writememory(serial, record->address,
736                                              (unsigned char *)record->data,
737                                              record->data_size, 0xa0);
738                 if (response < 0) {
739                         err("ezusb_writememory failed for Keyspan PDA "
740                             "firmware (%d %04X %p %d)",
741                             response, 
742                             record->address, record->data, record->data_size);
743                         break;
744                 }
745                 record++;
746         }
747         /* bring device out of reset. Renumeration will occur in a moment
748            and the new device will bind to the real driver */
749         response = ezusb_set_reset(serial, 0);
750
751         /* we want this device to fail to have a driver assigned to it. */
752         return (1);
753 }
754
755 static int keyspan_pda_startup (struct usb_serial *serial)
756 {
757
758         struct keyspan_pda_private *priv;
759
760         /* allocate the private data structures for all ports. Well, for all
761            one ports. */
762
763         priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
764         if (!priv)
765                 return (1); /* error */
766         usb_set_serial_port_data(serial->port[0], priv);
767         init_waitqueue_head(&serial->port[0]->write_wait);
768         INIT_WORK(&priv->wakeup_work, (void *)keyspan_pda_wakeup_write,
769                         (void *)(serial->port[0]));
770         INIT_WORK(&priv->unthrottle_work,
771                         (void *)keyspan_pda_request_unthrottle,
772                         (void *)(serial));
773         return (0);
774 }
775
776 static void keyspan_pda_shutdown (struct usb_serial *serial)
777 {
778         dbg("%s", __FUNCTION__);
779         
780         kfree(usb_get_serial_port_data(serial->port[0]));
781 }
782
783 #ifdef KEYSPAN
784 static struct usb_serial_driver keyspan_pda_fake_device = {
785         .driver = {
786                 .owner =        THIS_MODULE,
787                 .name =         "keyspan_pda_pre",
788         },
789         .description =          "Keyspan PDA - (prerenumeration)",
790         .id_table =             id_table_fake,
791         .num_interrupt_in =     NUM_DONT_CARE,
792         .num_bulk_in =          NUM_DONT_CARE,
793         .num_bulk_out =         NUM_DONT_CARE,
794         .num_ports =            1,
795         .attach =               keyspan_pda_fake_startup,
796 };
797 #endif
798
799 #ifdef XIRCOM
800 static struct usb_serial_driver xircom_pgs_fake_device = {
801         .driver = {
802                 .owner =        THIS_MODULE,
803                 .name =         "xircom_no_firm",
804         },
805         .description =          "Xircom / Entregra PGS - (prerenumeration)",
806         .id_table =             id_table_fake_xircom,
807         .num_interrupt_in =     NUM_DONT_CARE,
808         .num_bulk_in =          NUM_DONT_CARE,
809         .num_bulk_out =         NUM_DONT_CARE,
810         .num_ports =            1,
811         .attach =               keyspan_pda_fake_startup,
812 };
813 #endif
814
815 static struct usb_serial_driver keyspan_pda_device = {
816         .driver = {
817                 .owner =        THIS_MODULE,
818                 .name =         "keyspan_pda",
819         },
820         .description =          "Keyspan PDA",
821         .id_table =             id_table_std,
822         .num_interrupt_in =     1,
823         .num_bulk_in =          0,
824         .num_bulk_out =         1,
825         .num_ports =            1,
826         .open =                 keyspan_pda_open,
827         .close =                keyspan_pda_close,
828         .write =                keyspan_pda_write,
829         .write_room =           keyspan_pda_write_room,
830         .write_bulk_callback =  keyspan_pda_write_bulk_callback,
831         .read_int_callback =    keyspan_pda_rx_interrupt,
832         .chars_in_buffer =      keyspan_pda_chars_in_buffer,
833         .throttle =             keyspan_pda_rx_throttle,
834         .unthrottle =           keyspan_pda_rx_unthrottle,
835         .ioctl =                keyspan_pda_ioctl,
836         .set_termios =          keyspan_pda_set_termios,
837         .break_ctl =            keyspan_pda_break_ctl,
838         .tiocmget =             keyspan_pda_tiocmget,
839         .tiocmset =             keyspan_pda_tiocmset,
840         .attach =               keyspan_pda_startup,
841         .shutdown =             keyspan_pda_shutdown,
842 };
843
844
845 static int __init keyspan_pda_init (void)
846 {
847         int retval;
848         retval = usb_serial_register(&keyspan_pda_device);
849         if (retval)
850                 goto failed_pda_register;
851 #ifdef KEYSPAN
852         retval = usb_serial_register(&keyspan_pda_fake_device);
853         if (retval)
854                 goto failed_pda_fake_register;
855 #endif
856 #ifdef XIRCOM
857         retval = usb_serial_register(&xircom_pgs_fake_device);
858         if (retval)
859                 goto failed_xircom_register;
860 #endif
861         retval = usb_register(&keyspan_pda_driver);
862         if (retval)
863                 goto failed_usb_register;
864         info(DRIVER_DESC " " DRIVER_VERSION);
865         return 0;
866 failed_usb_register:    
867 #ifdef XIRCOM
868         usb_serial_deregister(&xircom_pgs_fake_device);
869 failed_xircom_register:
870 #endif /* XIRCOM */
871 #ifdef KEYSPAN
872         usb_serial_deregister(&keyspan_pda_fake_device);
873 #endif
874 #ifdef KEYSPAN
875 failed_pda_fake_register:
876 #endif
877         usb_serial_deregister(&keyspan_pda_device);
878 failed_pda_register:
879         return retval;
880 }
881
882
883 static void __exit keyspan_pda_exit (void)
884 {
885         usb_deregister (&keyspan_pda_driver);
886         usb_serial_deregister (&keyspan_pda_device);
887 #ifdef KEYSPAN
888         usb_serial_deregister (&keyspan_pda_fake_device);
889 #endif
890 #ifdef XIRCOM
891         usb_serial_deregister (&xircom_pgs_fake_device);
892 #endif
893 }
894
895
896 module_init(keyspan_pda_init);
897 module_exit(keyspan_pda_exit);
898
899 MODULE_AUTHOR( DRIVER_AUTHOR );
900 MODULE_DESCRIPTION( DRIVER_DESC );
901 MODULE_LICENSE("GPL");
902
903 module_param(debug, bool, S_IRUGO | S_IWUSR);
904 MODULE_PARM_DESC(debug, "Debug enabled or not");
905