ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / usb / serial / io_edgeport.c
1 /*
2  * Edgeport USB Serial Converter driver
3  *
4  * Copyright (C) 2000 Inside Out Networks, All rights reserved.
5  * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
6  *
7  *      This program is free software; you can redistribute it and/or modify
8  *      it under the terms of the GNU General Public License as published by
9  *      the Free Software Foundation; either version 2 of the License, or
10  *      (at your option) any later version.
11  *
12  * Supports the following devices:
13  *      Edgeport/4
14  *      Edgeport/4t
15  *      Edgeport/2
16  *      Edgeport/4i
17  *      Edgeport/2i
18  *      Edgeport/421
19  *      Edgeport/21
20  *      Rapidport/4
21  *      Edgeport/8
22  *      Edgeport/2D8
23  *      Edgeport/4D8
24  *      Edgeport/8i
25  *
26  * Version history:
27  * 
28  * 2003_04_03 al borchers
29  *  - fixed a bug (that shows up with dosemu) where the tty struct is
30  *    used in a callback after it has been freed
31  *
32  * 2.3 2002_03_08 greg kroah-hartman
33  *      - fixed bug when multiple devices were attached at the same time.
34  *
35  * 2.2 2001_11_14 greg kroah-hartman
36  *      - fixed bug in edge_close that kept the port from being used more
37  *        than once.
38  *      - fixed memory leak on device removal.
39  *      - fixed potential double free of memory when command urb submitting
40  *        failed.
41  *      - other small cleanups when the device is removed
42  *      
43  * 2.1 2001_07_09 greg kroah-hartman
44  *      - added support for TIOCMBIS and TIOCMBIC.
45  *
46  *     (04/08/2001) gb
47  *      - Identify version on module load.
48  *
49  * 2.0 2001_03_05 greg kroah-hartman
50  *      - reworked entire driver to fit properly in with the other usb-serial
51  *        drivers.  Occasional oopses still happen, but it's a good start.
52  *
53  * 1.2.3 (02/23/2001) greg kroah-hartman
54  *      - changed device table to work properly for 2.4.x final format.
55  *      - fixed problem with dropping data at high data rates.
56  *
57  * 1.2.2 (11/27/2000) greg kroah-hartman
58  *      - cleaned up more NTisms.
59  *      - Added device table for 2.4.0-test11
60  *
61  * 1.2.1 (11/08/2000) greg kroah-hartman
62  *      - Started to clean up NTisms.
63  *      - Fixed problem with dev field of urb for kernels >= 2.4.0-test9
64  *
65  * 1.2 (10/17/2000) David Iacovelli
66  *      Remove all EPIC code and GPL source
67  *  Fix RELEVANT_IFLAG macro to include flow control 
68  *  changes port configuration changes.
69  *  Fix redefinition of SERIAL_MAGIC
70  *  Change all timeout values to 5 seconds
71  *  Tried to fix the UHCI multiple urb submission, but failed miserably.
72  *  it seems to work fine with OHCI.
73  *  ( Greg take a look at the #if 0 at end of WriteCmdUsb() we must 
74  *    find a way to work arount this UHCI bug )
75  *
76  * 1.1 (10/11/2000) David Iacovelli
77  *  Fix XON/XOFF flow control to support both IXON and IXOFF
78  *
79  * 0.9.27 (06/30/2000) David Iacovelli
80  *  Added transmit queue and now allocate urb for command writes.
81  *
82  * 0.9.26 (06/29/2000) David Iacovelli
83  *  Add support for 80251 based edgeport
84  *
85  * 0.9.25 (06/27/2000) David Iacovelli
86  *  Do not close the port if it has multiple opens.
87  *
88  * 0.9.24 (05/26/2000) David Iacovelli
89  *  Add IOCTLs to support RXTX and JAVA POS 
90  *  and first cut at running BlackBox Demo
91  *
92  * 0.9.23 (05/24/2000) David Iacovelli
93  *  Add IOCTLs to support RXTX and JAVA POS
94  *
95  * 0.9.22 (05/23/2000) David Iacovelli
96  *  fixed bug in enumeration.  If epconfig turns on mapping by
97  *  path after a device is already plugged in, we now update
98  *  the mapping correctly
99  *
100  * 0.9.21 (05/16/2000) David Iacovelli
101  *  Added BlockUntilChaseResp() to also wait for txcredits
102  *  Updated the way we allocate and handle write URBs 
103  *      Add debug code to dump buffers
104  *
105  * 0.9.20 (05/01/2000) David Iacovelli
106  *      change driver to use usb/tts/
107  *
108  * 0.9.19 (05/01/2000) David Iacovelli
109  *  Update code to compile if DEBUG is off
110  *
111  * 0.9.18 (04/28/2000) David Iacovelli
112  *  cleanup and test tty_register with devfs
113  *
114  * 0.9.17 (04/27/2000) greg kroah-hartman
115  *      changed tty_register around to be like the way it
116  *      was before, but now it works properly with devfs.
117  *
118  * 0.9.16 (04/26/2000) david iacovelli
119  *  Fixed bug in GetProductInfo()
120  *
121  * 0.9.15 (04/25/2000) david iacovelli
122  *      Updated enumeration
123  *
124  * 0.9.14 (04/24/2000) david iacovelli
125  *  Removed all config/status IOCTLS and 
126  *  converted to using /proc/edgeport
127  *  still playing with devfs
128  *
129  * 0.9.13 (04/24/2000) david iacovelli
130  *  Removed configuration based on ttyUSB0
131  *  Added support for configuration using /prod/edgeport
132  *  first attempt at using devfs (not working yet!)
133  *  Added IOCTL to GetProductInfo()
134  *  Added support for custom baud rates
135  *      Add support for random port numbers
136  *
137  * 0.9.12 (04/18/2000) david iacovelli
138  *      added additional configuration IOCTLs
139  *  use ttyUSB0 for configuration
140  *
141  * 0.9.11 (04/17/2000) greg kroah-hartman
142  *      fixed module initialization race conditions.
143  *      made all urbs dynamically allocated.
144  *      made driver devfs compatible. now it only registers the tty device
145  *      when the device is actually plugged in.
146  *
147  * 0.9.10 (04/13/2000) greg kroah-hartman
148  *      added proc interface framework.
149  *
150  * 0.9.9 (04/13/2000) david iacovelli
151  *      added enumeration code and ioctls to configure the device
152  *
153  * 0.9.8 (04/12/2000) david iacovelli
154  *  Change interrupt read start when device is plugged in
155  *  and stop when device is removed
156  *      process interrupt reads when all ports are closed 
157  *  (keep value of rxBytesAvail consistent with the edgeport)
158  *  set the USB_BULK_QUEUE flag so that we can shove a bunch 
159  *  of urbs at once down the pipe 
160  *
161  * 0.9.7 (04/10/2000) david iacovelli
162  *      start to add enumeration code.
163  *  generate serial number for epic devices
164  *  add support for kdb
165  *
166  * 0.9.6 (03/30/2000) david iacovelli
167  *  add IOCTL to get string, manufacture, and boot descriptors
168  *
169  * 0.9.5 (03/14/2000) greg kroah-hartman
170  *      more error checking added to SerialOpen to try to fix UHCI open problem
171  *
172  * 0.9.4 (03/09/2000) greg kroah-hartman
173  *      added more error checking to handle oops when data is hanging
174  *      around and tty is abruptly closed.
175  *
176  * 0.9.3 (03/09/2000) david iacovelli
177  *      Add epic support for xon/xoff chars
178  *      play with performance
179  *
180  * 0.9.2 (03/08/2000) greg kroah-hartman
181  *      changed most "info" calls to "dbg"
182  *      implemented flow control properly in the termios call
183  *
184  * 0.9.1 (03/08/2000) david iacovelli
185  *      added EPIC support
186  *      enabled bootloader update
187  *
188  * 0.9 (03/08/2000) greg kroah-hartman
189  *      Release to IO networks.
190  *      Integrated changes that David made
191  *  made getting urbs for writing SMP safe
192  *
193  * 0.8 (03/07/2000) greg kroah-hartman
194  *      Release to IO networks.
195  *      Fixed problems that were seen in code by David.
196  *  Now both Edgeport/4 and Edgeport/2 works properly.
197  *  Changed most of the functions to use port instead of serial.
198  *
199  * 0.7 (02/27/2000) greg kroah-hartman
200  *      Milestone 3 release.
201  *      Release to IO Networks
202  *      ioctl for waiting on line change implemented.
203  *      ioctl for getting statistics implemented.
204  *      multiport support working.
205  *      lsr and msr registers are now handled properly.
206  *      change break now hooked up and working.
207  *      support for all known Edgeport devices.
208  *
209  * 0.6 (02/22/2000) greg kroah-hartman
210  *      Release to IO networks.
211  *      CHASE is implemented correctly when port is closed.
212  *      SerialOpen now blocks correctly until port is fully opened.
213  *
214  * 0.5 (02/20/2000) greg kroah-hartman
215  *      Release to IO networks.
216  *      Known problems:
217  *              modem status register changes are not sent on to the user
218  *              CHASE is not implemented when the port is closed.
219  *
220  * 0.4 (02/16/2000) greg kroah-hartman
221  *      Second cut at the CeBit demo.
222  *      Doesn't leak memory on every write to the port
223  *      Still small leaks on startup.
224  *      Added support for Edgeport/2 and Edgeport/8
225  *
226  * 0.3 (02/15/2000) greg kroah-hartman
227  *      CeBit demo release.
228  *      Force the line settings to 4800, 8, 1, e for the demo.
229  *      Warning! This version leaks memory like crazy!
230  *
231  * 0.2 (01/30/2000) greg kroah-hartman
232  *      Milestone 1 release.
233  *      Device is found by USB subsystem, enumerated, fimware is downloaded
234  *      and the descriptors are printed to the debug log, config is set, and
235  *      green light starts to blink. Open port works, and data can be sent
236  *      and received at the default settings of the UART. Loopback connector
237  *      and debug log confirms this.
238  * 
239  * 0.1 (01/23/2000) greg kroah-hartman
240  *      Initial release to help IO Networks try to set up their test system. 
241  *      Edgeport4 is recognized, firmware is downloaded, config is set so 
242  *      device blinks green light every 3 sec. Port is bound, but opening,
243  *      closing, and sending data do not work properly.
244  * 
245  */
246
247 #include <linux/config.h>
248 #include <linux/kernel.h>
249 #include <linux/jiffies.h>
250 #include <linux/errno.h>
251 #include <linux/init.h>
252 #include <linux/slab.h>
253 #include <linux/tty.h>
254 #include <linux/tty_driver.h>
255 #include <linux/tty_flip.h>
256 #include <linux/module.h>
257 #include <linux/spinlock.h>
258 #include <linux/serial.h>
259 #include <linux/ioctl.h>
260 #include <asm/uaccess.h>
261 #include <linux/usb.h>
262
263 #ifdef CONFIG_USB_SERIAL_DEBUG
264         static int debug = 1;
265 #else
266         static int debug;
267 #endif
268
269 #include "usb-serial.h"
270
271 #include "io_edgeport.h"
272 #include "io_ionsp.h"           /* info for the iosp messages */
273 #include "io_16654.h"           /* 16654 UART defines */
274
275 /*
276  * Version Information
277  */
278 #define DRIVER_VERSION "v2.3"
279 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
280 #define DRIVER_DESC "Edgeport USB Serial Driver"
281
282 /* First, the latest boot code - for first generation edgeports */
283 #define IMAGE_ARRAY_NAME        BootCodeImage_GEN1
284 #define IMAGE_VERSION_NAME      BootCodeImageVersion_GEN1
285 #include "io_fw_boot.h"         /* the bootloader firmware to download to a device, if it needs it */
286
287 /* for second generation edgeports */
288 #define IMAGE_ARRAY_NAME        BootCodeImage_GEN2
289 #define IMAGE_VERSION_NAME      BootCodeImageVersion_GEN2
290 #include "io_fw_boot2.h"        /* the bootloader firmware to download to a device, if it needs it */
291
292 /* Then finally the main run-time operational code - for first generation edgeports */
293 #define IMAGE_ARRAY_NAME        OperationalCodeImage_GEN1
294 #define IMAGE_VERSION_NAME      OperationalCodeImageVersion_GEN1
295 #include "io_fw_down.h"         /* Define array OperationalCodeImage[] */
296
297 /* for second generation edgeports */
298 #define IMAGE_ARRAY_NAME        OperationalCodeImage_GEN2
299 #define IMAGE_VERSION_NAME      OperationalCodeImageVersion_GEN2
300 #include "io_fw_down2.h"        /* Define array OperationalCodeImage[] */
301
302
303 #define MAX_NAME_LEN            64
304
305
306 #define CHASE_TIMEOUT           (5*HZ)          /* 5 seconds */
307 #define OPEN_TIMEOUT            (5*HZ)          /* 5 seconds */
308 #define COMMAND_TIMEOUT         (5*HZ)          /* 5 seconds */
309
310 #ifndef SERIAL_MAGIC
311         #define SERIAL_MAGIC    0x6702
312 #endif
313 #define PORT_MAGIC              0x7301
314
315
316 /* receive port state */
317 enum RXSTATE {
318         EXPECT_HDR1 = 0,        /* Expect header byte 1 */
319         EXPECT_HDR2 = 1,        /* Expect header byte 2 */
320         EXPECT_DATA = 2,        /* Expect 'RxBytesRemaining' data */
321         EXPECT_HDR3 = 3,        /* Expect header byte 3 (for status hdrs only) */
322 };
323
324
325 /* Transmit Fifo 
326  * This Transmit queue is an extension of the edgeport Rx buffer. 
327  * The maximum amount of data buffered in both the edgeport 
328  * Rx buffer (maxTxCredits) and this buffer will never exceed maxTxCredits.
329  */
330 struct TxFifo {
331         unsigned int    head;   /* index to head pointer (write) */
332         unsigned int    tail;   /* index to tail pointer (read)  */
333         unsigned int    count;  /* Bytes in queue */
334         unsigned int    size;   /* Max size of queue (equal to Max number of TxCredits) */
335         unsigned char   *fifo;  /* allocated Buffer */
336 };
337
338 /* This structure holds all of the local port information */
339 struct edgeport_port {
340         __u16                   txCredits;              /* our current credits for this port */
341         __u16                   maxTxCredits;           /* the max size of the port */
342
343         struct TxFifo           txfifo;                 /* transmit fifo -- size will be maxTxCredits */
344         struct urb              *write_urb;             /* write URB for this port */
345         char                    write_in_progress;      /* TRUE while a write URB is outstanding */
346
347         __u8                    shadowLCR;              /* last LCR value received */
348         __u8                    shadowMCR;              /* last MCR value received */
349         __u8                    shadowMSR;              /* last MSR value received */
350         __u8                    shadowLSR;              /* last LSR value received */
351         __u8                    shadowXonChar;          /* last value set as XON char in Edgeport */
352         __u8                    shadowXoffChar;         /* last value set as XOFF char in Edgeport */
353         __u8                    validDataMask;
354         __u32                   baudRate;
355
356         char                    open;
357         char                    openPending;
358         char                    commandPending;
359         char                    closePending;
360         char                    chaseResponsePending;
361
362         wait_queue_head_t       wait_chase;             /* for handling sleeping while waiting for chase to finish */
363         wait_queue_head_t       wait_open;              /* for handling sleeping while waiting for open to finish */
364         wait_queue_head_t       wait_command;           /* for handling sleeping while waiting for command to finish */
365         wait_queue_head_t       delta_msr_wait;         /* for handling sleeping while waiting for msr change to happen */
366
367         struct async_icount     icount;
368         struct usb_serial_port  *port;                  /* loop back to the owner of this object */
369 };
370
371
372 /* This structure holds all of the individual device information */
373 struct edgeport_serial {
374         char                    name[MAX_NAME_LEN+1];           /* string name of this device */
375
376         struct edge_manuf_descriptor    manuf_descriptor;       /* the manufacturer descriptor */
377         struct edge_boot_descriptor     boot_descriptor;        /* the boot firmware descriptor */
378         struct edgeport_product_info    product_info;           /* Product Info */
379
380         __u8                    interrupt_in_endpoint;          /* the interrupt endpoint handle */
381         unsigned char *         interrupt_in_buffer;            /* the buffer we use for the interrupt endpoint */
382         struct urb *            interrupt_read_urb;             /* our interrupt urb */
383
384         __u8                    bulk_in_endpoint;               /* the bulk in endpoint handle */
385         unsigned char *         bulk_in_buffer;                 /* the buffer we use for the bulk in endpoint */
386         struct urb *            read_urb;                       /* our bulk read urb */
387
388         __u8                    bulk_out_endpoint;              /* the bulk out endpoint handle */
389
390         __s16                   rxBytesAvail;                   /* the number of bytes that we need to read from this device */
391
392         enum RXSTATE            rxState;                        /* the current state of the bulk receive processor */
393         __u8                    rxHeader1;                      /* receive header byte 1 */
394         __u8                    rxHeader2;                      /* receive header byte 2 */
395         __u8                    rxHeader3;                      /* receive header byte 3 */
396         __u8                    rxPort;                         /* the port that we are currently receiving data for */
397         __u8                    rxStatusCode;                   /* the receive status code */
398         __u8                    rxStatusParam;                  /* the receive status paramater */
399         __s16                   rxBytesRemaining;               /* the number of port bytes left to read */
400         struct usb_serial       *serial;                        /* loop back to the owner of this object */
401 };
402
403 /* baud rate information */
404 struct divisor_table_entry {
405         __u32   BaudRate;
406         __u16  Divisor;
407 };
408
409 //
410 // Define table of divisors for Rev A EdgePort/4 hardware
411 // These assume a 3.6864MHz crystal, the standard /16, and
412 // MCR.7 = 0.
413 //
414 static struct divisor_table_entry divisor_table[] = {
415         {   50,         4608},  
416         {   75,         3072},  
417         {   110,        2095},          /* 2094.545455 => 230450   => .0217 % over */
418         {   134,        1713},          /* 1713.011152 => 230398.5 => .00065% under */
419         {   150,        1536},
420         {   300,        768},
421         {   600,        384},
422         {   1200,       192},
423         {   1800,       128},
424         {   2400,       96},
425         {   4800,       48},
426         {   7200,       32},
427         {   9600,       24},
428         {   14400,      16},
429         {   19200,      12},
430         {   38400,      6},
431         {   57600,      4},
432         {   115200,     2},
433         {   230400,     1},
434 };
435
436 /* local variables */
437 static int      CmdUrbs = 0;                                                    /* Number of outstanding Command Write Urbs */
438
439
440 /* local function prototypes */
441
442 /* function prototypes for all URB callbacks */
443 static void edge_interrupt_callback     (struct urb *urb, struct pt_regs *regs);
444 static void edge_bulk_in_callback       (struct urb *urb, struct pt_regs *regs);
445 static void edge_bulk_out_data_callback (struct urb *urb, struct pt_regs *regs);
446 static void edge_bulk_out_cmd_callback  (struct urb *urb, struct pt_regs *regs);
447
448 /* function prototypes for the usbserial callbacks */
449 static int  edge_open                   (struct usb_serial_port *port, struct file *filp);
450 static void edge_close                  (struct usb_serial_port *port, struct file *filp);
451 static int  edge_write                  (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
452 static int  edge_write_room             (struct usb_serial_port *port);
453 static int  edge_chars_in_buffer        (struct usb_serial_port *port);
454 static void edge_throttle               (struct usb_serial_port *port);
455 static void edge_unthrottle             (struct usb_serial_port *port);
456 static void edge_set_termios            (struct usb_serial_port *port, struct termios *old_termios);
457 static int  edge_ioctl                  (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg);
458 static void edge_break                  (struct usb_serial_port *port, int break_state);
459 static int  edge_tiocmget               (struct usb_serial_port *port, struct file *file);
460 static int  edge_tiocmset               (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
461 static int  edge_startup                (struct usb_serial *serial);
462 static void edge_shutdown               (struct usb_serial *serial);
463
464
465 #include "io_tables.h"  /* all of the devices that this driver supports */
466
467 static struct usb_driver io_driver = {
468         .owner =        THIS_MODULE,
469         .name =         "io_edgeport",
470         .probe =        usb_serial_probe,
471         .disconnect =   usb_serial_disconnect,
472         .id_table =     id_table_combined,
473 };
474
475 /* function prototypes for all of our local functions */
476 static int  process_rcvd_data           (struct edgeport_serial *edge_serial, unsigned char *buffer, __u16 bufferLength);
477 static void process_rcvd_status         (struct edgeport_serial *edge_serial, __u8 byte2, __u8 byte3);
478 static void handle_new_msr              (struct edgeport_port *edge_port, __u8 newMsr);
479 static void handle_new_lsr              (struct edgeport_port *edge_port, __u8 lsrData, __u8 lsr, __u8 data);
480 static int  send_iosp_ext_cmd           (struct edgeport_port *edge_port, __u8 command, __u8 param);
481 static int  calc_baud_rate_divisor      (int baud_rate, int *divisor);
482 static int  send_cmd_write_baud_rate    (struct edgeport_port *edge_port, int baudRate);
483 static void change_port_settings        (struct edgeport_port *edge_port, struct termios *old_termios);
484 static int  send_cmd_write_uart_register        (struct edgeport_port *edge_port, __u8 regNum, __u8 regValue);
485 static int  write_cmd_usb               (struct edgeport_port *edge_port, unsigned char *buffer, int writeLength);
486 static void send_more_port_data         (struct edgeport_serial *edge_serial, struct edgeport_port *edge_port);
487
488 static int  sram_write                  (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
489 static int  rom_read                    (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
490 static int  rom_write                   (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
491 static void get_manufacturing_desc      (struct edgeport_serial *edge_serial);
492 static void get_boot_desc               (struct edgeport_serial *edge_serial);
493 static void load_application_firmware   (struct edgeport_serial *edge_serial);
494
495
496 static void unicode_to_ascii            (char *string, short *unicode, int unicode_size);
497
498
499
500
501
502 // ************************************************************************
503 // ************************************************************************
504 // ************************************************************************
505 // ************************************************************************
506
507 /************************************************************************
508  *                                                                      *
509  * update_edgeport_E2PROM()     Compare current versions of             *
510  *                              Boot ROM and Manufacture                *
511  *                              Descriptors with versions               *
512  *                              embedded in this driver                 *
513  *                                                                      *
514  ************************************************************************/
515 static void update_edgeport_E2PROM (struct edgeport_serial *edge_serial)
516 {
517         __u32 BootCurVer;
518         __u32 BootNewVer;
519         __u8 BootMajorVersion;                  
520         __u8 BootMinorVersion;                  
521         __u16 BootBuildNumber;
522         __u8 *BootImage;      
523         __u32 BootSize;
524         struct edge_firmware_image_record *record;
525         unsigned char *firmware;
526         int response;
527
528
529         switch (edge_serial->product_info.iDownloadFile) {
530                 case EDGE_DOWNLOAD_FILE_I930:
531                         BootMajorVersion        = BootCodeImageVersion_GEN1.MajorVersion;
532                         BootMinorVersion        = BootCodeImageVersion_GEN1.MinorVersion;
533                         BootBuildNumber         = cpu_to_le16(BootCodeImageVersion_GEN1.BuildNumber);
534                         BootImage               = &BootCodeImage_GEN1[0];
535                         BootSize                = sizeof( BootCodeImage_GEN1 );
536                         break;
537
538                 case EDGE_DOWNLOAD_FILE_80251:
539                         BootMajorVersion        = BootCodeImageVersion_GEN2.MajorVersion;
540                         BootMinorVersion        = BootCodeImageVersion_GEN2.MinorVersion;
541                         BootBuildNumber         = cpu_to_le16(BootCodeImageVersion_GEN2.BuildNumber);
542                         BootImage               = &BootCodeImage_GEN2[0];
543                         BootSize                = sizeof( BootCodeImage_GEN2 );
544                         break;
545
546                 default:
547                         return;
548         }
549
550         // Check Boot Image Version
551         BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
552                      (edge_serial->boot_descriptor.MinorVersion << 16) +
553                       le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
554
555         BootNewVer = (BootMajorVersion << 24) +
556                      (BootMinorVersion << 16) +
557                       le16_to_cpu(BootBuildNumber);
558
559         dbg("Current Boot Image version %d.%d.%d",
560             edge_serial->boot_descriptor.MajorVersion,
561             edge_serial->boot_descriptor.MinorVersion,
562             le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
563
564
565         if (BootNewVer > BootCurVer) {
566                 dbg("**Update Boot Image from %d.%d.%d to %d.%d.%d",
567                     edge_serial->boot_descriptor.MajorVersion,
568                     edge_serial->boot_descriptor.MinorVersion,
569                     le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
570                     BootMajorVersion,
571                     BootMinorVersion,
572                     le16_to_cpu(BootBuildNumber));
573
574
575                 dbg("Downloading new Boot Image");
576
577                 firmware = BootImage;
578
579                 for (;;) {
580                         record = (struct edge_firmware_image_record *)firmware;
581                         response = rom_write (edge_serial->serial, le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len), &record->Data[0]);
582                         if (response < 0) {
583                                 dev_err(&edge_serial->serial->dev->dev, "rom_write failed (%x, %x, %d)\n", le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len));
584                                 break;
585                         }
586                         firmware += sizeof (struct edge_firmware_image_record) + le16_to_cpu(record->Len);
587                         if (firmware >= &BootImage[BootSize]) {
588                                 break;
589                         }
590                 }
591         } else {
592                 dbg("Boot Image -- already up to date");
593         }
594 }
595
596
597 /************************************************************************
598  *                                                                      *
599  *  Get string descriptor from device                                   *
600  *                                                                      *
601  ************************************************************************/
602 static int get_string (struct usb_device *dev, int Id, char *string)
603 {
604         struct usb_string_descriptor StringDesc;
605         struct usb_string_descriptor *pStringDesc;
606
607         dbg("%s - USB String ID = %d", __FUNCTION__, Id );
608
609         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc, sizeof(StringDesc))) {
610                 return 0;
611         }
612
613         pStringDesc = kmalloc (StringDesc.bLength, GFP_KERNEL);
614
615         if (!pStringDesc) {
616                 return 0;
617         }
618
619         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc, StringDesc.bLength )) {
620                 kfree(pStringDesc);
621                 return 0;
622         }
623
624         unicode_to_ascii(string,  pStringDesc->wData,     pStringDesc->bLength/2-1);
625
626         kfree(pStringDesc);
627         return strlen(string);
628 }
629
630
631 #if 0
632 /************************************************************************
633  *
634  *  Get string descriptor from device
635  *
636  ************************************************************************/
637 static int get_string_desc (struct usb_device *dev, int Id, struct usb_string_descriptor **pRetDesc)
638 {
639         struct usb_string_descriptor StringDesc;
640         struct usb_string_descriptor *pStringDesc;
641
642         dbg("%s - USB String ID = %d", __FUNCTION__, Id );
643
644         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc, sizeof(StringDesc))) {
645                 return 0;
646         }
647
648         pStringDesc = kmalloc (StringDesc.bLength, GFP_KERNEL);
649
650         if (!pStringDesc) {
651                 return -1;
652         }
653
654         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc, StringDesc.bLength )) {
655                 kfree(pStringDesc);
656                 return -1;
657         }
658
659         *pRetDesc = pStringDesc;
660         return 0;
661 }
662 #endif
663
664 static void get_product_info(struct edgeport_serial *edge_serial)
665 {
666         struct edgeport_product_info *product_info = &edge_serial->product_info;
667
668         memset (product_info, 0, sizeof(struct edgeport_product_info));
669
670         product_info->ProductId         = (__u16)(edge_serial->serial->dev->descriptor.idProduct & ~ION_DEVICE_ID_GENERATION_2);
671         product_info->NumPorts          = edge_serial->manuf_descriptor.NumPorts;
672         product_info->ProdInfoVer       = 0;
673
674         product_info->RomSize           = edge_serial->manuf_descriptor.RomSize;
675         product_info->RamSize           = edge_serial->manuf_descriptor.RamSize;
676         product_info->CpuRev            = edge_serial->manuf_descriptor.CpuRev;
677         product_info->BoardRev          = edge_serial->manuf_descriptor.BoardRev;
678
679         product_info->BootMajorVersion  = edge_serial->boot_descriptor.MajorVersion;
680         product_info->BootMinorVersion  = edge_serial->boot_descriptor.MinorVersion;
681         product_info->BootBuildNumber   = edge_serial->boot_descriptor.BuildNumber;
682
683         memcpy(product_info->ManufactureDescDate, edge_serial->manuf_descriptor.DescDate, sizeof(edge_serial->manuf_descriptor.DescDate));
684
685         // check if this is 2nd generation hardware
686         if (edge_serial->serial->dev->descriptor.idProduct & ION_DEVICE_ID_GENERATION_2) {
687                 product_info->FirmwareMajorVersion      = OperationalCodeImageVersion_GEN2.MajorVersion;
688                 product_info->FirmwareMinorVersion      = OperationalCodeImageVersion_GEN2.MinorVersion;
689                 product_info->FirmwareBuildNumber       = cpu_to_le16(OperationalCodeImageVersion_GEN2.BuildNumber);
690                 product_info->iDownloadFile             = EDGE_DOWNLOAD_FILE_80251;
691         } else {
692                 product_info->FirmwareMajorVersion      = OperationalCodeImageVersion_GEN1.MajorVersion;
693                 product_info->FirmwareMinorVersion      = OperationalCodeImageVersion_GEN1.MinorVersion;
694                 product_info->FirmwareBuildNumber       = cpu_to_le16(OperationalCodeImageVersion_GEN1.BuildNumber);
695                 product_info->iDownloadFile             = EDGE_DOWNLOAD_FILE_I930;
696         }
697
698         // Determine Product type and set appropriate flags
699         switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
700                 case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
701                 case ION_DEVICE_ID_EDGEPORT_4T:
702                 case ION_DEVICE_ID_EDGEPORT_4:
703                 case ION_DEVICE_ID_EDGEPORT_2:
704                 case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
705                 case ION_DEVICE_ID_EDGEPORT_8:
706                 case ION_DEVICE_ID_EDGEPORT_421:
707                 case ION_DEVICE_ID_EDGEPORT_21:
708                 case ION_DEVICE_ID_EDGEPORT_2_DIN:
709                 case ION_DEVICE_ID_EDGEPORT_4_DIN:
710                 case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
711                         product_info->IsRS232 = 1;
712                         break;
713
714                 case ION_DEVICE_ID_EDGEPORT_2I:                            // Edgeport/2 RS422/RS485
715                         product_info->IsRS422 = 1;
716                         product_info->IsRS485 = 1;
717                         break;
718
719                 case ION_DEVICE_ID_EDGEPORT_8I:                            // Edgeport/4 RS422
720                 case ION_DEVICE_ID_EDGEPORT_4I:                            // Edgeport/4 RS422
721                         product_info->IsRS422 = 1;
722                         break;
723         }
724
725         // Dump Product Info structure
726         dbg("**Product Information:");
727         dbg("  ProductId             %x", product_info->ProductId );
728         dbg("  NumPorts              %d", product_info->NumPorts );
729         dbg("  ProdInfoVer           %d", product_info->ProdInfoVer );
730         dbg("  IsServer              %d", product_info->IsServer);
731         dbg("  IsRS232               %d", product_info->IsRS232 );
732         dbg("  IsRS422               %d", product_info->IsRS422 );
733         dbg("  IsRS485               %d", product_info->IsRS485 );
734         dbg("  RomSize               %d", product_info->RomSize );
735         dbg("  RamSize               %d", product_info->RamSize );
736         dbg("  CpuRev                %x", product_info->CpuRev  );
737         dbg("  BoardRev              %x", product_info->BoardRev);
738         dbg("  BootMajorVersion      %d.%d.%d", product_info->BootMajorVersion,
739             product_info->BootMinorVersion,
740             le16_to_cpu(product_info->BootBuildNumber));
741         dbg("  FirmwareMajorVersion  %d.%d.%d", product_info->FirmwareMajorVersion,
742             product_info->FirmwareMinorVersion,
743             le16_to_cpu(product_info->FirmwareBuildNumber));
744         dbg("  ManufactureDescDate   %d/%d/%d", product_info->ManufactureDescDate[0],
745             product_info->ManufactureDescDate[1],
746             product_info->ManufactureDescDate[2]+1900);
747         dbg("  iDownloadFile         0x%x",     product_info->iDownloadFile);
748
749 }
750
751
752 /************************************************************************/
753 /************************************************************************/
754 /*            U S B  C A L L B A C K   F U N C T I O N S                */
755 /*            U S B  C A L L B A C K   F U N C T I O N S                */
756 /************************************************************************/
757 /************************************************************************/
758
759 /*****************************************************************************
760  * edge_interrupt_callback
761  *      this is the callback function for when we have received data on the 
762  *      interrupt endpoint.
763  *****************************************************************************/
764 static void edge_interrupt_callback (struct urb *urb, struct pt_regs *regs)
765 {
766         struct edgeport_serial  *edge_serial = (struct edgeport_serial *)urb->context;
767         struct edgeport_port *edge_port;
768         struct usb_serial_port *port;
769         unsigned char *data = urb->transfer_buffer;
770         int length = urb->actual_length;
771         int bytes_avail;
772         int position;
773         int txCredits;
774         int portNumber;
775         int result;
776
777         dbg("%s", __FUNCTION__);
778
779         if (serial_paranoia_check (edge_serial->serial, __FUNCTION__)) {
780                 return;
781         }
782
783         switch (urb->status) {
784         case 0:
785                 /* success */
786                 break;
787         case -ECONNRESET:
788         case -ENOENT:
789         case -ESHUTDOWN:
790                 /* this urb is terminated, clean up */
791                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
792                 return;
793         default:
794                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
795                 goto exit;
796         }
797
798         // process this interrupt-read even if there are no ports open
799         if (length) {
800                 usb_serial_debug_data (__FILE__, __FUNCTION__, length, data);
801
802                 if (length > 1) {
803                         bytes_avail = data[0] | (data[1] << 8);
804                         if (bytes_avail) {
805                                 edge_serial->rxBytesAvail += bytes_avail;
806                                 dbg("%s - bytes_avail = %d, rxBytesAvail %d", __FUNCTION__, bytes_avail, edge_serial->rxBytesAvail);
807
808                                 if ((edge_serial->rxBytesAvail > 0) &&
809                                     (edge_serial->read_urb->status != -EINPROGRESS)) {
810                                         dbg(" --- Posting a read");
811
812                                         /* we have pending bytes on the bulk in pipe, send a request */
813                                         edge_serial->read_urb->dev = edge_serial->serial->dev;
814                                         result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
815                                         if (result) {
816                                                 dbg("%s - usb_submit_urb(read bulk) failed with result = %d", __FUNCTION__, result);
817                                         }
818                                 }
819                         }
820                 }
821                 /* grab the txcredits for the ports if available */
822                 position = 2;
823                 portNumber = 0;
824                 while ((position < length) && (portNumber < edge_serial->serial->num_ports)) {
825                         txCredits = data[position] | (data[position+1] << 8);
826                         if (txCredits) {
827                                 port = edge_serial->serial->port[portNumber];
828                                 if (port_paranoia_check (port, __FUNCTION__) == 0) {
829                                         edge_port = usb_get_serial_port_data(port);
830                                         if (edge_port->open) {
831                                                 edge_port->txCredits += txCredits;
832                                                 dbg("%s - txcredits for port%d = %d", __FUNCTION__, portNumber, edge_port->txCredits);
833
834                                                 /* tell the tty driver that something has changed */
835                                                 if (edge_port->port->tty)
836                                                         wake_up_interruptible(&edge_port->port->tty->write_wait);
837
838                                                 // Since we have more credit, check if more data can be sent
839                                                 send_more_port_data(edge_serial, edge_port);
840                                         }
841                                 }
842                         }
843                         position += 2;
844                         ++portNumber;
845                 }
846         }
847
848 exit:
849         result = usb_submit_urb (urb, GFP_ATOMIC);
850         if (result) {
851                 dev_err(&urb->dev->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, result);
852         }
853 }
854
855
856 /*****************************************************************************
857  * edge_bulk_in_callback
858  *      this is the callback function for when we have received data on the 
859  *      bulk in endpoint.
860  *****************************************************************************/
861 static void edge_bulk_in_callback (struct urb *urb, struct pt_regs *regs)
862 {
863         struct edgeport_serial  *edge_serial = (struct edgeport_serial *)urb->context;
864         unsigned char           *data = urb->transfer_buffer;
865         int                     status;
866         __u16                   raw_data_length;
867
868         dbg("%s", __FUNCTION__);
869
870         if (serial_paranoia_check (edge_serial->serial, __FUNCTION__)) {
871                 return;
872         }
873
874         if (urb->status) {
875                 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
876                 return;
877         }
878
879         if (urb->actual_length) {
880                 raw_data_length = urb->actual_length;
881
882                 usb_serial_debug_data (__FILE__, __FUNCTION__, raw_data_length, data);
883
884                 /* decrement our rxBytes available by the number that we just got */
885                 edge_serial->rxBytesAvail -= raw_data_length;
886
887                 dbg("%s - Received = %d, rxBytesAvail %d", __FUNCTION__, raw_data_length, edge_serial->rxBytesAvail);
888
889                 process_rcvd_data (edge_serial, data, urb->actual_length);
890
891                 /* check to see if there's any more data for us to read */
892                 if ((edge_serial->rxBytesAvail > 0) &&
893                     (edge_serial->read_urb->status != -EINPROGRESS)) {
894                         dbg(" --- Posting a read");
895
896                         /* there is, so resubmit our urb */
897                         edge_serial->read_urb->dev = edge_serial->serial->dev;
898                         status = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
899                         if (status) {
900                                 dev_err(&urb->dev->dev, "%s - usb_submit_urb(read bulk) failed, status = %d\n", __FUNCTION__, status);
901                         }
902                 }
903         }
904 }
905
906
907 /*****************************************************************************
908  * edge_bulk_out_data_callback
909  *      this is the callback function for when we have finished sending serial data
910  *      on the bulk out endpoint.
911  *****************************************************************************/
912 static void edge_bulk_out_data_callback (struct urb *urb, struct pt_regs *regs)
913 {
914         struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
915         struct tty_struct *tty;
916
917         dbg("%s", __FUNCTION__);
918
919         if (port_paranoia_check (edge_port->port, __FUNCTION__)) {
920                 return;
921         }
922
923         if (urb->status) {
924                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
925         }
926
927         tty = edge_port->port->tty;
928
929         if (tty && edge_port->open) {
930                 /* let the tty driver wakeup if it has a special write_wakeup function */
931                 if ((tty->flags & (1 << TTY_DO_WRITE_WAKEUP)) && tty->ldisc.write_wakeup) {
932                         (tty->ldisc.write_wakeup)(tty);
933                 }
934
935                 /* tell the tty driver that something has changed */
936                 wake_up_interruptible(&tty->write_wait);
937         }
938
939         // Release the Write URB
940         edge_port->write_in_progress = FALSE;
941
942         // Check if more data needs to be sent
943         send_more_port_data((struct edgeport_serial *)(usb_get_serial_data(edge_port->port->serial)), edge_port);
944 }
945
946
947 /*****************************************************************************
948  * BulkOutCmdCallback
949  *      this is the callback function for when we have finished sending a command
950  *      on the bulk out endpoint.
951  *****************************************************************************/
952 static void edge_bulk_out_cmd_callback (struct urb *urb, struct pt_regs *regs)
953 {
954         struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
955         struct tty_struct *tty;
956         int status = urb->status;
957
958         dbg("%s", __FUNCTION__);
959
960         CmdUrbs--;
961         dbg("%s - FREE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
962
963
964         /* clean up the transfer buffer */
965         if (urb->transfer_buffer != NULL) {
966                 kfree(urb->transfer_buffer);
967         }
968
969         /* Free the command urb */
970         usb_free_urb (urb);
971
972         if (port_paranoia_check (edge_port->port, __FUNCTION__)) {
973                 return;
974         }
975
976         if (status) {
977                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, status);
978                 return;
979         }
980
981         /* Get pointer to tty */
982         tty = edge_port->port->tty;
983
984         /* tell the tty driver that something has changed */
985         if (tty && edge_port->open)
986                 wake_up_interruptible(&tty->write_wait);
987
988         /* we have completed the command */
989         edge_port->commandPending = FALSE;
990         wake_up_interruptible(&edge_port->wait_command);
991 }
992
993
994 /*****************************************************************************
995  * Driver tty interface functions
996  *****************************************************************************/
997
998 /*****************************************************************************
999  * SerialOpen
1000  *      this function is called by the tty driver when a port is opened
1001  *      If successful, we return 0
1002  *      Otherwise we return a negative error number.
1003  *****************************************************************************/
1004 static int edge_open (struct usb_serial_port *port, struct file * filp)
1005 {
1006         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1007         struct usb_serial *serial;
1008         struct edgeport_serial *edge_serial;
1009         int response;
1010         int timeout;
1011
1012         if (port_paranoia_check (port, __FUNCTION__))
1013                 return -ENODEV;
1014         
1015         dbg("%s - port %d", __FUNCTION__, port->number);
1016
1017         if (edge_port == NULL)
1018                 return -ENODEV;
1019
1020         /* force low_latency on so that our tty_push actually forces the data through, 
1021            otherwise it is scheduled, and with high data rates (like with OHCI) data
1022            can get lost. */
1023         if (port->tty)
1024                 port->tty->low_latency = 1;
1025
1026         /* see if we've set up our endpoint info yet (can't set it up in edge_startup
1027            as the structures were not set up at that time.) */
1028         serial = port->serial;
1029         edge_serial = usb_get_serial_data(serial);
1030         if (edge_serial == NULL) {
1031                 return -ENODEV;
1032         }
1033         if (edge_serial->interrupt_in_buffer == NULL) {
1034                 struct usb_serial_port *port0 = serial->port[0];
1035                 
1036                 /* not set up yet, so do it now */
1037                 edge_serial->interrupt_in_buffer = port0->interrupt_in_buffer;
1038                 edge_serial->interrupt_in_endpoint = port0->interrupt_in_endpointAddress;
1039                 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
1040                 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
1041                 edge_serial->bulk_in_endpoint = port0->bulk_in_endpointAddress;
1042                 edge_serial->read_urb = port0->read_urb;
1043                 edge_serial->bulk_out_endpoint = port0->bulk_out_endpointAddress;
1044         
1045                 /* set up our interrupt urb */
1046                 usb_fill_int_urb(edge_serial->interrupt_read_urb,
1047                                  serial->dev,
1048                                  usb_rcvintpipe(serial->dev,
1049                                                 port0->interrupt_in_endpointAddress),
1050                                  port0->interrupt_in_buffer,
1051                                  edge_serial->interrupt_read_urb->transfer_buffer_length,
1052                                  edge_interrupt_callback, edge_serial,
1053                                  edge_serial->interrupt_read_urb->interval);
1054                 
1055                 /* set up our bulk in urb */
1056                 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
1057                                   usb_rcvbulkpipe(serial->dev,
1058                                                   port0->bulk_in_endpointAddress),
1059                                   port0->bulk_in_buffer,
1060                                   edge_serial->read_urb->transfer_buffer_length,
1061                                   edge_bulk_in_callback, edge_serial);
1062
1063                 /* start interrupt read for this edgeport
1064                  * this interrupt will continue as long as the edgeport is connected */
1065                 response = usb_submit_urb (edge_serial->interrupt_read_urb, GFP_KERNEL);
1066                 if (response) {
1067                         dev_err(&port->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, response);
1068                 }
1069         }
1070         
1071         /* initialize our wait queues */
1072         init_waitqueue_head(&edge_port->wait_open);
1073         init_waitqueue_head(&edge_port->wait_chase);
1074         init_waitqueue_head(&edge_port->delta_msr_wait);
1075         init_waitqueue_head(&edge_port->wait_command);
1076
1077         /* initialize our icount structure */
1078         memset (&(edge_port->icount), 0x00, sizeof(edge_port->icount));
1079
1080         /* initialize our port settings */
1081         edge_port->txCredits            = 0;                    /* Can't send any data yet */
1082         edge_port->shadowMCR            = MCR_MASTER_IE;        /* Must always set this bit to enable ints! */
1083         edge_port->chaseResponsePending = FALSE;
1084
1085         /* send a open port command */
1086         edge_port->openPending = TRUE;
1087         edge_port->open        = FALSE;
1088         response = send_iosp_ext_cmd (edge_port, IOSP_CMD_OPEN_PORT, 0);
1089
1090         if (response < 0) {
1091                 dev_err(&port->dev, "%s - error sending open port command\n", __FUNCTION__);
1092                 edge_port->openPending = FALSE;
1093                 return -ENODEV;
1094         }
1095
1096         /* now wait for the port to be completely opened */
1097         timeout = OPEN_TIMEOUT;
1098         while (timeout && edge_port->openPending == TRUE) {
1099                 timeout = interruptible_sleep_on_timeout (&edge_port->wait_open, timeout);
1100         }
1101
1102         if (edge_port->open == FALSE) {
1103                 /* open timed out */
1104                 dbg("%s - open timedout", __FUNCTION__);
1105                 edge_port->openPending = FALSE;
1106                 return -ENODEV;
1107         }
1108
1109         /* create the txfifo */
1110         edge_port->txfifo.head  = 0;
1111         edge_port->txfifo.tail  = 0;
1112         edge_port->txfifo.count = 0;
1113         edge_port->txfifo.size  = edge_port->maxTxCredits;
1114         edge_port->txfifo.fifo  = kmalloc (edge_port->maxTxCredits, GFP_KERNEL);
1115
1116         if (!edge_port->txfifo.fifo) {
1117                 dbg("%s - no memory", __FUNCTION__);
1118                 edge_close (port, filp);
1119                 return -ENOMEM;
1120         }
1121
1122         /* Allocate a URB for the write */
1123         edge_port->write_urb = usb_alloc_urb (0, GFP_KERNEL);
1124
1125         if (!edge_port->write_urb) {
1126                 dbg("%s - no memory", __FUNCTION__);
1127                 edge_close (port, filp);
1128                 return -ENOMEM;
1129         }
1130
1131         dbg("%s(%d) - Initialize TX fifo to %d bytes", __FUNCTION__, port->number, edge_port->maxTxCredits);
1132
1133         dbg("%s exited", __FUNCTION__);
1134
1135         return 0;
1136 }
1137
1138
1139 /************************************************************************
1140  *
1141  * block_until_chase_response
1142  *
1143  *      This function will block the close until one of the following:
1144  *              1. Response to our Chase comes from Edgeport
1145  *              2. A timout of 10 seconds without activity has expired
1146  *                 (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
1147  *
1148  ************************************************************************/
1149 static void block_until_chase_response(struct edgeport_port *edge_port)
1150 {
1151         __u16 lastCredits;
1152         int timeout = 1*HZ;
1153         int wait = 10;
1154
1155         while (1) {
1156                 // Save Last credits
1157                 lastCredits = edge_port->txCredits;
1158
1159                 // Did we get our Chase response
1160                 if (edge_port->chaseResponsePending == FALSE) {
1161                         dbg("%s - Got Chase Response", __FUNCTION__);
1162
1163                         // did we get all of our credit back?
1164                         if (edge_port->txCredits == edge_port->maxTxCredits ) {
1165                                 dbg("%s - Got all credits", __FUNCTION__);
1166                                 return;
1167                         }
1168                 }
1169
1170                 // Block the thread for a while
1171                 interruptible_sleep_on_timeout (&edge_port->wait_chase, timeout);
1172
1173                 if (lastCredits == edge_port->txCredits) {
1174                         // No activity.. count down.
1175                         wait--;
1176                         if (wait == 0) {
1177                                 edge_port->chaseResponsePending = FALSE;
1178                                 dbg("%s - Chase TIMEOUT", __FUNCTION__);
1179                                 return;
1180                         }
1181                 } else {
1182                         // Reset timout value back to 10 seconds
1183                         dbg("%s - Last %d, Current %d", __FUNCTION__, lastCredits, edge_port->txCredits);
1184                         wait = 10;
1185                 }
1186         }
1187 }
1188
1189
1190 /************************************************************************
1191  *
1192  * block_until_tx_empty
1193  *
1194  *      This function will block the close until one of the following:
1195  *              1. TX count are 0
1196  *              2. The edgeport has stopped
1197  *              3. A timout of 3 seconds without activity has expired
1198  *
1199  ************************************************************************/
1200 static void block_until_tx_empty (struct edgeport_port *edge_port)
1201 {
1202         struct TxFifo *fifo = &edge_port->txfifo;
1203         __u32 lastCount;
1204         int timeout = HZ/10;
1205         int wait = 30;
1206
1207         while (1) {
1208                 // Save Last count
1209                 lastCount = fifo->count;
1210
1211                 // Is the Edgeport Buffer empty?
1212                 if (lastCount == 0) {
1213                         dbg("%s - TX Buffer Empty", __FUNCTION__);
1214                         return;
1215                 }
1216
1217                 // Block the thread for a while
1218                 interruptible_sleep_on_timeout (&edge_port->wait_chase, timeout);
1219
1220                 dbg("%s wait", __FUNCTION__);
1221
1222                 if (lastCount == fifo->count) {
1223                         // No activity.. count down.
1224                         wait--;
1225                         if (wait == 0) {
1226                                 dbg("%s - TIMEOUT", __FUNCTION__);
1227                                 return;
1228                         }
1229                 } else {
1230                         // Reset timout value back to seconds
1231                         wait = 30;
1232                 }
1233         }
1234 }
1235
1236
1237 /*****************************************************************************
1238  * edge_close
1239  *      this function is called by the tty driver when a port is closed
1240  *****************************************************************************/
1241 static void edge_close (struct usb_serial_port *port, struct file * filp)
1242 {
1243         struct usb_serial *serial;
1244         struct edgeport_serial *edge_serial;
1245         struct edgeport_port *edge_port;
1246         int status;
1247
1248         if (port_paranoia_check (port, __FUNCTION__))
1249                 return;
1250         
1251         dbg("%s - port %d", __FUNCTION__, port->number);
1252                          
1253         serial = get_usb_serial (port, __FUNCTION__);
1254         if (!serial)
1255                 return;
1256         
1257         edge_serial = usb_get_serial_data(serial);
1258         edge_port = usb_get_serial_port_data(port);
1259         if ((edge_serial == NULL) || (edge_port == NULL))
1260                 return;
1261         
1262         if (serial->dev) {
1263                 // block until tx is empty
1264                 block_until_tx_empty(edge_port);
1265
1266                 edge_port->closePending = TRUE;
1267
1268                 /* flush and chase */
1269                 edge_port->chaseResponsePending = TRUE;
1270
1271                 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1272                 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1273                 if (status == 0) {
1274                         // block until chase finished
1275                         block_until_chase_response(edge_port);
1276                 } else {
1277                         edge_port->chaseResponsePending = FALSE;
1278                 }
1279
1280                 /* close the port */
1281                 dbg("%s - Sending IOSP_CMD_CLOSE_PORT", __FUNCTION__);
1282                 send_iosp_ext_cmd (edge_port, IOSP_CMD_CLOSE_PORT, 0);
1283
1284                 //port->close = TRUE;
1285                 edge_port->closePending = FALSE;
1286                 edge_port->open = FALSE;
1287                 edge_port->openPending = FALSE;
1288
1289                 if (edge_port->write_urb) {
1290                         usb_unlink_urb (edge_port->write_urb);
1291                 }
1292         }
1293
1294         if (edge_port->write_urb) {
1295                 /* if this urb had a transfer buffer already (old transfer) free it */
1296                 if (edge_port->write_urb->transfer_buffer != NULL) {
1297                         kfree(edge_port->write_urb->transfer_buffer);
1298                 }
1299                 usb_free_urb   (edge_port->write_urb);
1300         }
1301         if (edge_port->txfifo.fifo) {
1302                 kfree(edge_port->txfifo.fifo);
1303         }
1304
1305         dbg("%s exited", __FUNCTION__);
1306 }   
1307
1308 /*****************************************************************************
1309  * SerialWrite
1310  *      this function is called by the tty driver when data should be written to
1311  *      the port.
1312  *      If successful, we return the number of bytes written, otherwise we return
1313  *      a negative error number.
1314  *****************************************************************************/
1315 static int edge_write (struct usb_serial_port *port, int from_user, const unsigned char *data, int count)
1316 {
1317         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1318         struct TxFifo *fifo;
1319         int copySize;
1320         int bytesleft;
1321         int firsthalf;
1322         int secondhalf;
1323
1324         dbg("%s - port %d", __FUNCTION__, port->number);
1325
1326         if (edge_port == NULL)
1327                 return -ENODEV;
1328
1329         // get a pointer to the Tx fifo
1330         fifo = &edge_port->txfifo;
1331
1332         // calculate number of bytes to put in fifo
1333         copySize = min ((unsigned int)count, (edge_port->txCredits - fifo->count));
1334
1335         dbg("%s(%d) of %d byte(s) Fifo room  %d -- will copy %d bytes", __FUNCTION__, 
1336             port->number, count, edge_port->txCredits - fifo->count, copySize);
1337
1338         /* catch writes of 0 bytes which the tty driver likes to give us, and when txCredits is empty */
1339         if (copySize == 0) {
1340                 dbg("%s - copySize = Zero", __FUNCTION__);
1341                 return 0;
1342         }
1343
1344         // queue the data       
1345         // since we can never overflow the buffer we do not have to check for full condition
1346
1347         // the copy is done is two parts -- first fill to the end of the buffer
1348         // then copy the reset from the start of the buffer 
1349
1350         bytesleft = fifo->size - fifo->head;
1351         firsthalf = min (bytesleft, copySize);
1352         dbg("%s - copy %d bytes of %d into fifo ", __FUNCTION__, firsthalf, bytesleft);
1353
1354         /* now copy our data */
1355         if (from_user) {
1356                 if (copy_from_user(&fifo->fifo[fifo->head], data, firsthalf))
1357                         return -EFAULT;
1358         } else {
1359                 memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1360         }  
1361         usb_serial_debug_data (__FILE__, __FUNCTION__, firsthalf, &fifo->fifo[fifo->head]);
1362
1363         // update the index and size
1364         fifo->head  += firsthalf;
1365         fifo->count += firsthalf;
1366
1367         // wrap the index
1368         if (fifo->head == fifo->size) {
1369                 fifo->head = 0;
1370         }
1371
1372         secondhalf = copySize-firsthalf;
1373
1374         if (secondhalf) {
1375                 dbg("%s - copy rest of data %d", __FUNCTION__, secondhalf);
1376                 if (from_user) {
1377                         if (copy_from_user(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf))
1378                                 return -EFAULT;
1379                 } else {
1380                         memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1381                 }
1382                 usb_serial_debug_data (__FILE__, __FUNCTION__, secondhalf, &fifo->fifo[fifo->head]);
1383                 // update the index and size
1384                 fifo->count += secondhalf;
1385                 fifo->head  += secondhalf;
1386                 // No need to check for wrap since we can not get to end of fifo in this part
1387         }
1388
1389         send_more_port_data((struct edgeport_serial *)usb_get_serial_data(port->serial), edge_port);
1390
1391         dbg("%s wrote %d byte(s) TxCredits %d, Fifo %d", __FUNCTION__, copySize, edge_port->txCredits, fifo->count);
1392
1393         return copySize;   
1394 }
1395
1396
1397 /************************************************************************
1398  *
1399  * send_more_port_data()
1400  *
1401  *      This routine attempts to write additional UART transmit data
1402  *      to a port over the USB bulk pipe. It is called (1) when new
1403  *      data has been written to a port's TxBuffer from higher layers
1404  *      (2) when the peripheral sends us additional TxCredits indicating
1405  *      that it can accept more Tx data for a given port; and (3) when
1406  *      a bulk write completes successfully and we want to see if we
1407  *      can transmit more.
1408  *
1409  ************************************************************************/
1410 static void send_more_port_data(struct edgeport_serial *edge_serial, struct edgeport_port *edge_port)
1411 {
1412         struct TxFifo   *fifo = &edge_port->txfifo;
1413         struct urb      *urb;
1414         unsigned char   *buffer;
1415         int             status;
1416         int             count;
1417         int             bytesleft;
1418         int             firsthalf;
1419         int             secondhalf;
1420
1421         dbg("%s(%d)", __FUNCTION__, edge_port->port->number);
1422
1423         if (edge_port->write_in_progress ||
1424             !edge_port->open             ||
1425             (fifo->count == 0)) {
1426                 dbg("%s(%d) EXIT - fifo %d, PendingWrite = %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->write_in_progress);
1427                 return;
1428         }
1429
1430         // since the amount of data in the fifo will always fit into the
1431         // edgeport buffer we do not need to check the write length
1432
1433         //      Do we have enough credits for this port to make it worthwhile
1434         //      to bother queueing a write. If it's too small, say a few bytes,
1435         //      it's better to wait for more credits so we can do a larger
1436         //      write.
1437         if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits)) {
1438                 dbg("%s(%d) Not enough credit - fifo %d TxCredit %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->txCredits );
1439                 return;
1440         }
1441
1442         // lock this write
1443         edge_port->write_in_progress = TRUE;
1444
1445         // get a pointer to the write_urb
1446         urb = edge_port->write_urb;
1447
1448         /* if this urb had a transfer buffer already (old transfer) free it */
1449         if (urb->transfer_buffer != NULL) {
1450                 kfree(urb->transfer_buffer);
1451                 urb->transfer_buffer = NULL;
1452         }
1453
1454         /* build the data header for the buffer and port that we are about to send out */
1455         count = fifo->count;
1456         buffer = kmalloc (count+2, GFP_ATOMIC);
1457         if (buffer == NULL) {
1458                 dev_err(&edge_serial->serial->dev->dev, "%s - no more kernel memory...\n", __FUNCTION__);
1459                 edge_port->write_in_progress = FALSE;
1460                 return;
1461         }
1462         buffer[0] = IOSP_BUILD_DATA_HDR1 (edge_port->port->number - edge_port->port->serial->minor, count);
1463         buffer[1] = IOSP_BUILD_DATA_HDR2 (edge_port->port->number - edge_port->port->serial->minor, count);
1464
1465         /* now copy our data */
1466         bytesleft =  fifo->size - fifo->tail;
1467         firsthalf = min (bytesleft, count);
1468         memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1469         fifo->tail  += firsthalf;
1470         fifo->count -= firsthalf;
1471         if (fifo->tail == fifo->size) {
1472                 fifo->tail = 0;
1473         }
1474
1475         secondhalf = count-firsthalf;
1476         if (secondhalf) {
1477                 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail], secondhalf);
1478                 fifo->tail  += secondhalf;
1479                 fifo->count -= secondhalf;
1480         }
1481
1482         if (count) {
1483                 usb_serial_debug_data (__FILE__, __FUNCTION__, count, &buffer[2]);
1484         }
1485
1486         /* fill up the urb with all of our data and submit it */
1487         usb_fill_bulk_urb (urb, edge_serial->serial->dev, 
1488                        usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
1489                        buffer, count+2, edge_bulk_out_data_callback, edge_port);
1490
1491         /* decrement the number of credits we have by the number we just sent */
1492         edge_port->txCredits -= count;
1493         edge_port->icount.tx += count;
1494
1495         urb->dev = edge_serial->serial->dev;
1496         status = usb_submit_urb(urb, GFP_ATOMIC);
1497         if (status) {
1498                 /* something went wrong */
1499                 dbg("%s - usb_submit_urb(write bulk) failed", __FUNCTION__);
1500                 edge_port->write_in_progress = FALSE;
1501
1502                 /* revert the credits as something bad happened. */
1503                 edge_port->txCredits += count;
1504                 edge_port->icount.tx -= count;
1505         }
1506         dbg("%s wrote %d byte(s) TxCredit %d, Fifo %d", __FUNCTION__, count, edge_port->txCredits, fifo->count);
1507 }
1508
1509
1510 /*****************************************************************************
1511  * edge_write_room
1512  *      this function is called by the tty driver when it wants to know how many
1513  *      bytes of data we can accept for a specific port.
1514  *      If successful, we return the amount of room that we have for this port
1515  *      (the txCredits), 
1516  *      Otherwise we return a negative error number.
1517  *****************************************************************************/
1518 static int edge_write_room (struct usb_serial_port *port)
1519 {
1520         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1521         int room;
1522
1523         dbg("%s", __FUNCTION__);
1524
1525         if (edge_port == NULL)
1526                 return -ENODEV;
1527         if (edge_port->closePending == TRUE)
1528                 return -ENODEV;
1529
1530         dbg("%s - port %d", __FUNCTION__, port->number);
1531
1532         if (!edge_port->open) {
1533                 dbg("%s - port not opened", __FUNCTION__);
1534                 return -EINVAL;
1535         }
1536
1537         // total of both buffers is still txCredit
1538         room = edge_port->txCredits - edge_port->txfifo.count;
1539
1540         dbg("%s - returns %d", __FUNCTION__, room);
1541         return room;
1542 }
1543
1544
1545 /*****************************************************************************
1546  * edge_chars_in_buffer
1547  *      this function is called by the tty driver when it wants to know how many
1548  *      bytes of data we currently have outstanding in the port (data that has
1549  *      been written, but hasn't made it out the port yet)
1550  *      If successful, we return the number of bytes left to be written in the 
1551  *      system, 
1552  *      Otherwise we return a negative error number.
1553  *****************************************************************************/
1554 static int edge_chars_in_buffer (struct usb_serial_port *port)
1555 {
1556         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1557         int num_chars;
1558
1559         dbg("%s", __FUNCTION__);
1560
1561         if (edge_port == NULL)
1562                 return -ENODEV;
1563         if (edge_port->closePending == TRUE)
1564                 return -ENODEV;
1565
1566         if (!edge_port->open) {
1567                 dbg("%s - port not opened", __FUNCTION__);
1568                 return -EINVAL;
1569         }
1570
1571         num_chars = edge_port->maxTxCredits - edge_port->txCredits + edge_port->txfifo.count;
1572         if (num_chars) {
1573                 dbg("%s(port %d) - returns %d", __FUNCTION__, port->number, num_chars);
1574         }
1575
1576         return num_chars;
1577 }
1578
1579
1580 /*****************************************************************************
1581  * SerialThrottle
1582  *      this function is called by the tty driver when it wants to stop the data
1583  *      being read from the port.
1584  *****************************************************************************/
1585 static void edge_throttle (struct usb_serial_port *port)
1586 {
1587         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1588         struct tty_struct *tty;
1589         int status;
1590
1591         dbg("%s - port %d", __FUNCTION__, port->number);
1592
1593         if (edge_port == NULL)
1594                 return;
1595
1596         if (!edge_port->open) {
1597                 dbg("%s - port not opened", __FUNCTION__);
1598                 return;
1599         }
1600
1601         tty = port->tty;
1602         if (!tty) {
1603                 dbg ("%s - no tty available", __FUNCTION__);
1604                 return;
1605         }
1606
1607         /* if we are implementing XON/XOFF, send the stop character */
1608         if (I_IXOFF(tty)) {
1609                 unsigned char stop_char = STOP_CHAR(tty);
1610                 status = edge_write (port, 0, &stop_char, 1);
1611                 if (status <= 0) {
1612                         return;
1613                 }
1614         }
1615
1616         /* if we are implementing RTS/CTS, toggle that line */
1617         if (tty->termios->c_cflag & CRTSCTS) {
1618                 edge_port->shadowMCR &= ~MCR_RTS;
1619                 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1620                 if (status != 0) {
1621                         return;
1622                 }
1623         }
1624
1625         return;
1626 }
1627
1628
1629 /*****************************************************************************
1630  * edge_unthrottle
1631  *      this function is called by the tty driver when it wants to resume the data
1632  *      being read from the port (called after SerialThrottle is called)
1633  *****************************************************************************/
1634 static void edge_unthrottle (struct usb_serial_port *port)
1635 {
1636         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1637         struct tty_struct *tty;
1638         int status;
1639
1640         dbg("%s - port %d", __FUNCTION__, port->number);
1641
1642         if (edge_port == NULL)
1643                 return;
1644
1645         if (!edge_port->open) {
1646                 dbg("%s - port not opened", __FUNCTION__);
1647                 return;
1648         }
1649
1650         tty = port->tty;
1651         if (!tty) {
1652                 dbg ("%s - no tty available", __FUNCTION__);
1653                 return;
1654         }
1655
1656         /* if we are implementing XON/XOFF, send the start character */
1657         if (I_IXOFF(tty)) {
1658                 unsigned char start_char = START_CHAR(tty);
1659                 status = edge_write (port, 0, &start_char, 1);
1660                 if (status <= 0) {
1661                         return;
1662                 }
1663         }
1664
1665         /* if we are implementing RTS/CTS, toggle that line */
1666         if (tty->termios->c_cflag & CRTSCTS) {
1667                 edge_port->shadowMCR |= MCR_RTS;
1668                 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1669                 if (status != 0) {
1670                         return;
1671                 }
1672         }
1673
1674         return;
1675 }
1676
1677
1678 /*****************************************************************************
1679  * SerialSetTermios
1680  *      this function is called by the tty driver when it wants to change the termios structure
1681  *****************************************************************************/
1682 static void edge_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1683 {
1684         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1685         struct tty_struct *tty = port->tty;
1686         unsigned int cflag;
1687
1688         if (!port->tty || !port->tty->termios) {
1689                 dbg ("%s - no tty or termios", __FUNCTION__);
1690                 return;
1691         }
1692
1693         cflag = tty->termios->c_cflag;
1694         /* check that they really want us to change something */
1695         if (old_termios) {
1696                 if ((cflag == old_termios->c_cflag) &&
1697                     (RELEVANT_IFLAG(tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
1698                         dbg("%s - nothing to change", __FUNCTION__);
1699                         return;
1700                 }
1701         }
1702
1703         dbg("%s - clfag %08x iflag %08x", __FUNCTION__, 
1704             tty->termios->c_cflag,
1705             RELEVANT_IFLAG(tty->termios->c_iflag));
1706         if (old_termios) {
1707                 dbg("%s - old clfag %08x old iflag %08x", __FUNCTION__,
1708                     old_termios->c_cflag,
1709                     RELEVANT_IFLAG(old_termios->c_iflag));
1710         }
1711
1712         dbg("%s - port %d", __FUNCTION__, port->number);
1713
1714         if (edge_port == NULL)
1715                 return;
1716
1717         if (!edge_port->open) {
1718                 dbg("%s - port not opened", __FUNCTION__);
1719                 return;
1720         }
1721
1722         /* change the port settings to the new ones specified */
1723         change_port_settings (edge_port, old_termios);
1724
1725         return;
1726 }
1727
1728
1729 /*****************************************************************************
1730  * get_lsr_info - get line status register info
1731  *
1732  * Purpose: Let user call ioctl() to get info when the UART physically
1733  *          is emptied.  On bus types like RS485, the transmitter must
1734  *          release the bus after transmitting. This must be done when
1735  *          the transmit shift register is empty, not be done when the
1736  *          transmit holding register is empty.  This functionality
1737  *          allows an RS485 driver to be written in user space. 
1738  *****************************************************************************/
1739 static int get_lsr_info(struct edgeport_port *edge_port, unsigned int *value)
1740 {
1741         unsigned int result = 0;
1742
1743         if (edge_port->maxTxCredits == edge_port->txCredits &&
1744             edge_port->txfifo.count == 0) {
1745                 dbg("%s -- Empty", __FUNCTION__);
1746                 result = TIOCSER_TEMT;
1747         }
1748
1749         if (copy_to_user(value, &result, sizeof(int)))
1750                 return -EFAULT;
1751         return 0;
1752 }
1753
1754 static int get_number_bytes_avail(struct edgeport_port *edge_port, unsigned int *value)
1755 {
1756         unsigned int result = 0;
1757         struct tty_struct *tty = edge_port->port->tty;
1758
1759         if (!tty)
1760                 return -ENOIOCTLCMD;
1761
1762         result = tty->read_cnt;
1763
1764         dbg("%s(%d) = %d", __FUNCTION__,  edge_port->port->number, result);
1765         if (copy_to_user(value, &result, sizeof(int)))
1766                 return -EFAULT;
1767         //return 0;
1768         return -ENOIOCTLCMD;
1769 }
1770
1771 static int edge_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear)
1772 {
1773         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1774         unsigned int mcr;
1775
1776         dbg("%s - port %d", __FUNCTION__, port->number);
1777
1778         mcr = edge_port->shadowMCR;
1779         if (set & TIOCM_RTS)
1780                 mcr |= MCR_RTS;
1781         if (set & TIOCM_DTR)
1782                 mcr |= MCR_DTR;
1783         if (set & TIOCM_LOOP)
1784                 mcr |= MCR_LOOPBACK;
1785
1786         if (clear & TIOCM_RTS)
1787                 mcr &= ~MCR_RTS;
1788         if (clear & TIOCM_DTR)
1789                 mcr &= ~MCR_DTR;
1790         if (clear & TIOCM_LOOP)
1791                 mcr &= ~MCR_LOOPBACK;
1792
1793         edge_port->shadowMCR = mcr;
1794
1795         send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1796
1797         return 0;
1798 }
1799
1800 static int edge_tiocmget(struct usb_serial_port *port, struct file *file)
1801 {
1802         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1803         unsigned int result = 0;
1804         unsigned int msr;
1805         unsigned int mcr;
1806
1807         dbg("%s - port %d", __FUNCTION__, port->number);
1808
1809         msr = edge_port->shadowMSR;
1810         mcr = edge_port->shadowMCR;
1811         result = ((mcr & MCR_DTR)       ? TIOCM_DTR: 0)   /* 0x002 */
1812                   | ((mcr & MCR_RTS)    ? TIOCM_RTS: 0)   /* 0x004 */
1813                   | ((msr & EDGEPORT_MSR_CTS)   ? TIOCM_CTS: 0)   /* 0x020 */
1814                   | ((msr & EDGEPORT_MSR_CD)    ? TIOCM_CAR: 0)   /* 0x040 */
1815                   | ((msr & EDGEPORT_MSR_RI)    ? TIOCM_RI:  0)   /* 0x080 */
1816                   | ((msr & EDGEPORT_MSR_DSR)   ? TIOCM_DSR: 0);  /* 0x100 */
1817
1818
1819         dbg("%s -- %x", __FUNCTION__, result);
1820
1821         return result;
1822 }
1823
1824 static int get_serial_info(struct edgeport_port *edge_port, struct serial_struct * retinfo)
1825 {
1826         struct serial_struct tmp;
1827
1828         if (!retinfo)
1829                 return -EFAULT;
1830
1831         memset(&tmp, 0, sizeof(tmp));
1832
1833         tmp.type                = PORT_16550A;
1834         tmp.line                = edge_port->port->serial->minor;
1835         tmp.port                = edge_port->port->number;
1836         tmp.irq                 = 0;
1837         tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1838         tmp.xmit_fifo_size      = edge_port->maxTxCredits;
1839         tmp.baud_base           = 9600;
1840         tmp.close_delay         = 5*HZ;
1841         tmp.closing_wait        = 30*HZ;
1842 //      tmp.custom_divisor      = state->custom_divisor;
1843 //      tmp.hub6                = state->hub6;
1844 //      tmp.io_type             = state->io_type;
1845
1846
1847         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1848                 return -EFAULT;
1849         return 0;
1850 }
1851
1852
1853
1854 /*****************************************************************************
1855  * SerialIoctl
1856  *      this function handles any ioctl calls to the driver
1857  *****************************************************************************/
1858 static int edge_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
1859 {
1860         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1861         struct async_icount cnow;
1862         struct async_icount cprev;
1863         struct serial_icounter_struct icount;
1864
1865
1866         dbg("%s - port %d, cmd = 0x%x", __FUNCTION__, port->number, cmd);
1867
1868         switch (cmd) {
1869                 // return number of bytes available
1870                 case TIOCINQ:
1871                         dbg("%s (%d) TIOCINQ", __FUNCTION__,  port->number);
1872                         return get_number_bytes_avail(edge_port, (unsigned int *) arg);
1873                         break;
1874
1875                 case TIOCSERGETLSR:
1876                         dbg("%s (%d) TIOCSERGETLSR", __FUNCTION__,  port->number);
1877                         return get_lsr_info(edge_port, (unsigned int *) arg);
1878                         return 0;
1879
1880                 case TIOCGSERIAL:
1881                         dbg("%s (%d) TIOCGSERIAL", __FUNCTION__,  port->number);
1882                         return get_serial_info(edge_port, (struct serial_struct *) arg);
1883
1884                 case TIOCSSERIAL:
1885                         dbg("%s (%d) TIOCSSERIAL", __FUNCTION__,  port->number);
1886                         break;
1887
1888                 case TIOCMIWAIT:
1889                         dbg("%s (%d) TIOCMIWAIT", __FUNCTION__,  port->number);
1890                         cprev = edge_port->icount;
1891                         while (1) {
1892                                 interruptible_sleep_on(&edge_port->delta_msr_wait);
1893                                 /* see if a signal did it */
1894                                 if (signal_pending(current))
1895                                         return -ERESTARTSYS;
1896                                 cnow = edge_port->icount;
1897                                 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1898                                     cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1899                                         return -EIO; /* no change => error */
1900                                 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1901                                     ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1902                                     ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
1903                                     ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts)) ) {
1904                                         return 0;
1905                                 }
1906                                 cprev = cnow;
1907                         }
1908                         /* NOTREACHED */
1909                         break;
1910
1911                 case TIOCGICOUNT:
1912                         cnow = edge_port->icount;
1913                         memset(&icount, 0, sizeof(icount));
1914                         icount.cts = cnow.cts;
1915                         icount.dsr = cnow.dsr;
1916                         icount.rng = cnow.rng;
1917                         icount.dcd = cnow.dcd;
1918                         icount.rx = cnow.rx;
1919                         icount.tx = cnow.tx;
1920                         icount.frame = cnow.frame;
1921                         icount.overrun = cnow.overrun;
1922                         icount.parity = cnow.parity;
1923                         icount.brk = cnow.brk;
1924                         icount.buf_overrun = cnow.buf_overrun;
1925
1926                         dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d", __FUNCTION__,  port->number, icount.rx, icount.tx );
1927                         if (copy_to_user((void *)arg, &icount, sizeof(icount)))
1928                                 return -EFAULT;
1929                         return 0;
1930         }
1931
1932         return -ENOIOCTLCMD;
1933 }
1934
1935
1936 /*****************************************************************************
1937  * SerialBreak
1938  *      this function sends a break to the port
1939  *****************************************************************************/
1940 static void edge_break (struct usb_serial_port *port, int break_state)
1941 {
1942         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1943         int status;
1944
1945         /* flush and chase */
1946         edge_port->chaseResponsePending = TRUE;
1947
1948         dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1949         status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1950         if (status == 0) {
1951                 // block until chase finished
1952                 block_until_chase_response(edge_port);
1953         } else {
1954                 edge_port->chaseResponsePending = FALSE;
1955         }
1956
1957         if (break_state == -1) {
1958                 dbg("%s - Sending IOSP_CMD_SET_BREAK", __FUNCTION__);
1959                 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_BREAK, 0);
1960         } else {
1961                 dbg("%s - Sending IOSP_CMD_CLEAR_BREAK", __FUNCTION__);
1962                 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CLEAR_BREAK, 0);
1963         }
1964         if (status) {
1965                 dbg("%s - error sending break set/clear command.", __FUNCTION__);
1966         }
1967
1968         return;
1969 }
1970
1971
1972 /*****************************************************************************
1973  * process_rcvd_data
1974  *      this function handles the data received on the bulk in pipe.
1975  *****************************************************************************/
1976 static int process_rcvd_data (struct edgeport_serial *edge_serial, unsigned char * buffer, __u16 bufferLength)
1977 {
1978         struct usb_serial_port *port;
1979         struct edgeport_port *edge_port;
1980         struct tty_struct *tty;
1981         __u16 lastBufferLength;
1982         __u16 rxLen;
1983         int i;
1984
1985         dbg("%s", __FUNCTION__);
1986
1987         lastBufferLength = bufferLength + 1;
1988
1989         while (bufferLength > 0) {
1990                 /* failsafe incase we get a message that we don't understand */
1991                 if (lastBufferLength == bufferLength) {
1992                         dbg("%s - stuck in loop, exiting it.", __FUNCTION__);
1993                         break;
1994                 }
1995                 lastBufferLength = bufferLength;
1996
1997                 switch (edge_serial->rxState) {
1998                         case EXPECT_HDR1:
1999                                 edge_serial->rxHeader1 = *buffer;
2000                                 ++buffer;
2001                                 --bufferLength;
2002
2003                                 if (bufferLength == 0) {
2004                                         edge_serial->rxState = EXPECT_HDR2;
2005                                         break;
2006                                 }
2007                                 /* otherwise, drop on through */
2008
2009                         case EXPECT_HDR2:
2010                                 edge_serial->rxHeader2 = *buffer;
2011                                 ++buffer;
2012                                 --bufferLength;
2013
2014                                 dbg("%s - Hdr1=%02X Hdr2=%02X", __FUNCTION__, edge_serial->rxHeader1, edge_serial->rxHeader2);
2015
2016                                 // Process depending on whether this header is
2017                                 // data or status
2018
2019                                 if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
2020                                         // Decode this status header and goto EXPECT_HDR1 (if we
2021                                         // can process the status with only 2 bytes), or goto
2022                                         // EXPECT_HDR3 to get the third byte.
2023
2024                                         edge_serial->rxPort       = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
2025                                         edge_serial->rxStatusCode = IOSP_GET_STATUS_CODE(edge_serial->rxHeader1);
2026
2027                                         if (!IOSP_STATUS_IS_2BYTE(edge_serial->rxStatusCode)) {
2028                                                 // This status needs additional bytes. Save what we have
2029                                                 // and then wait for more data.
2030                                                 edge_serial->rxStatusParam = edge_serial->rxHeader2;
2031
2032                                                 edge_serial->rxState = EXPECT_HDR3;
2033                                                 break;
2034                                         }
2035
2036                                         // We have all the header bytes, process the status now
2037                                         process_rcvd_status (edge_serial, edge_serial->rxHeader2, 0);
2038
2039                                         edge_serial->rxState = EXPECT_HDR1;
2040                                         break;
2041                                 } else {
2042                                         edge_serial->rxPort = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
2043                                         edge_serial->rxBytesRemaining = IOSP_GET_HDR_DATA_LEN(edge_serial->rxHeader1, edge_serial->rxHeader2);
2044
2045                                         dbg("%s - Data for Port %u Len %u", __FUNCTION__, edge_serial->rxPort, edge_serial->rxBytesRemaining);
2046
2047                                         //ASSERT( DevExt->RxPort < DevExt->NumPorts );
2048                                         //ASSERT( DevExt->RxBytesRemaining < IOSP_MAX_DATA_LENGTH );
2049
2050                                         if (bufferLength == 0 ) {
2051                                                 edge_serial->rxState = EXPECT_DATA;
2052                                                 break;
2053                                         }
2054                                         // Else, drop through
2055                                 }
2056
2057                         case EXPECT_DATA:       // Expect data
2058
2059                                 if (bufferLength < edge_serial->rxBytesRemaining) {
2060                                         rxLen = bufferLength;
2061                                         edge_serial->rxState = EXPECT_DATA;     // Expect data to start next buffer
2062                                 } else {
2063                                         // BufLen >= RxBytesRemaining
2064                                         rxLen = edge_serial->rxBytesRemaining;
2065                                         edge_serial->rxState = EXPECT_HDR1;     // Start another header next time
2066                                 }
2067
2068                                 bufferLength -= rxLen;
2069                                 edge_serial->rxBytesRemaining -= rxLen;
2070
2071                                 /* spit this data back into the tty driver if this port is open */
2072                                 if (rxLen) {
2073                                         port = edge_serial->serial->port[edge_serial->rxPort];
2074                                         if (port_paranoia_check (port, __FUNCTION__) == 0) {
2075                                                 edge_port = usb_get_serial_port_data(port);
2076                                                 if (edge_port->open) {
2077                                                         tty = edge_port->port->tty;
2078                                                         if (tty) {
2079                                                                 dbg("%s - Sending %d bytes to TTY for port %d", __FUNCTION__, rxLen, edge_serial->rxPort);
2080                                                                 for (i = 0; i < rxLen ; ++i) {
2081                                                                         /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
2082                                                                         if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
2083                                                                                 tty_flip_buffer_push(tty);
2084                                                                         }
2085                                                                         /* this doesn't actually push the data through unless tty->low_latency is set */
2086                                                                         tty_insert_flip_char(tty, buffer[i], 0);
2087                                                                 }
2088                                                                 tty_flip_buffer_push(tty);
2089                                                         }
2090                                                         edge_port->icount.rx += rxLen;
2091                                                 }
2092                                         }
2093                                         buffer += rxLen;
2094                                 }
2095
2096                                 break;
2097
2098                         case EXPECT_HDR3:                       // Expect 3rd byte of status header
2099                                 edge_serial->rxHeader3 = *buffer;
2100                                 ++buffer;
2101                                 --bufferLength;
2102
2103                                 // We have all the header bytes, process the status now
2104                                 process_rcvd_status (edge_serial, edge_serial->rxStatusParam, edge_serial->rxHeader3);
2105                                 edge_serial->rxState = EXPECT_HDR1;
2106                                 break;
2107
2108                 }
2109         }
2110
2111         return 0;
2112 }
2113
2114
2115 /*****************************************************************************
2116  * process_rcvd_status
2117  *      this function handles the any status messages received on the bulk in pipe.
2118  *****************************************************************************/
2119 static void process_rcvd_status (struct edgeport_serial *edge_serial, __u8 byte2, __u8 byte3)
2120 {
2121         struct usb_serial_port *port;
2122         struct edgeport_port *edge_port;
2123         __u8 code = edge_serial->rxStatusCode;
2124
2125         /* switch the port pointer to the one being currently talked about */
2126         port = edge_serial->serial->port[edge_serial->rxPort];
2127         if (port_paranoia_check (port, __FUNCTION__)) {
2128                 return;
2129         }
2130         edge_port = usb_get_serial_port_data(port);
2131         if (edge_port == NULL) {
2132                 dev_err(&edge_serial->serial->dev->dev, "%s - edge_port == NULL for port %d\n", __FUNCTION__, edge_serial->rxPort);
2133                 return;
2134         }
2135
2136         dbg("%s - port %d", __FUNCTION__, edge_serial->rxPort);
2137
2138         if (code == IOSP_EXT_STATUS) {
2139                 switch (byte2) {
2140                         case IOSP_EXT_STATUS_CHASE_RSP:
2141                                 // we want to do EXT status regardless of port open/closed 
2142                                 dbg("%s - Port %u EXT CHASE_RSP Data = %02x", __FUNCTION__, edge_serial->rxPort, byte3 );
2143                                 // Currently, the only EXT_STATUS is Chase, so process here instead of one more call
2144                                 // to one more subroutine. If/when more EXT_STATUS, there'll be more work to do.
2145                                 // Also, we currently clear flag and close the port regardless of content of above's Byte3.
2146                                 // We could choose to do something else when Byte3 says Timeout on Chase from Edgeport,
2147                                 // like wait longer in block_until_chase_response, but for now we don't. 
2148                                 edge_port->chaseResponsePending = FALSE;
2149                                 wake_up_interruptible (&edge_port->wait_chase);
2150                                 return;
2151
2152                         case IOSP_EXT_STATUS_RX_CHECK_RSP:
2153                                 dbg("%s ========== Port %u CHECK_RSP Sequence = %02x =============\n", __FUNCTION__, edge_serial->rxPort, byte3 );
2154                                 //Port->RxCheckRsp = TRUE;
2155                                 return;
2156                 }
2157         }
2158
2159         if (code == IOSP_STATUS_OPEN_RSP) {
2160                 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
2161                 edge_port->maxTxCredits = edge_port->txCredits;
2162                 dbg("%s - Port %u Open Response Inital MSR = %02x TxBufferSize = %d", __FUNCTION__, edge_serial->rxPort, byte2, edge_port->txCredits);
2163                 handle_new_msr (edge_port, byte2);
2164
2165                 /* send the current line settings to the port so we are in sync with any further termios calls */
2166                 if (edge_port->port->tty)
2167                         change_port_settings (edge_port, edge_port->port->tty->termios);
2168
2169                 /* we have completed the open */
2170                 edge_port->openPending = FALSE;
2171                 edge_port->open = TRUE;
2172                 wake_up_interruptible(&edge_port->wait_open);
2173                 return;
2174         }
2175
2176         // If port is closed, silently discard all rcvd status. We can
2177         // have cases where buffered status is received AFTER the close
2178         // port command is sent to the Edgeport.
2179         if ((!edge_port->open ) || (edge_port->closePending)) {
2180                 return;
2181         }
2182
2183         switch (code) {
2184                 // Not currently sent by Edgeport
2185                 case IOSP_STATUS_LSR:
2186                         dbg("%s - Port %u LSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
2187                         handle_new_lsr (edge_port, FALSE, byte2, 0);
2188                         break;
2189
2190                 case IOSP_STATUS_LSR_DATA:
2191                         dbg("%s - Port %u LSR Status = %02x, Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
2192                         // byte2 is LSR Register
2193                         // byte3 is broken data byte
2194                         handle_new_lsr (edge_port, TRUE, byte2, byte3);
2195                         break;
2196                         //
2197                         //      case IOSP_EXT_4_STATUS:
2198                         //              dbg("%s - Port %u LSR Status = %02x Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
2199                         //              break;
2200                         //
2201                 case IOSP_STATUS_MSR:
2202                         dbg("%s - Port %u MSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
2203
2204                         // Process this new modem status and generate appropriate
2205                         // events, etc, based on the new status. This routine
2206                         // also saves the MSR in Port->ShadowMsr.
2207                         handle_new_msr(edge_port, byte2);
2208                         break;
2209
2210                 default:
2211                         dbg("%s - Unrecognized IOSP status code %u\n", __FUNCTION__, code);
2212                         break;
2213         }
2214
2215         return;
2216 }
2217
2218
2219 /*****************************************************************************
2220  * handle_new_msr
2221  *      this function handles any change to the msr register for a port.
2222  *****************************************************************************/
2223 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
2224 {
2225         struct  async_icount *icount;
2226
2227         dbg("%s %02x", __FUNCTION__, newMsr);
2228
2229         if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR | EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
2230                 icount = &edge_port->icount;
2231
2232                 /* update input line counters */
2233                 if (newMsr & EDGEPORT_MSR_DELTA_CTS) {
2234                         icount->cts++;
2235                 }
2236                 if (newMsr & EDGEPORT_MSR_DELTA_DSR) {
2237                         icount->dsr++;
2238                 }
2239                 if (newMsr & EDGEPORT_MSR_DELTA_CD) {
2240                         icount->dcd++;
2241                 }
2242                 if (newMsr & EDGEPORT_MSR_DELTA_RI) {
2243                         icount->rng++;
2244                 }
2245                 wake_up_interruptible(&edge_port->delta_msr_wait);
2246         }
2247
2248         /* Save the new modem status */
2249         edge_port->shadowMSR = newMsr & 0xf0;
2250
2251         return;
2252 }
2253
2254
2255 /*****************************************************************************
2256  * handle_new_lsr
2257  *      this function handles any change to the lsr register for a port.
2258  *****************************************************************************/
2259 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData, __u8 lsr, __u8 data)
2260 {
2261         __u8    newLsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
2262         struct  async_icount *icount;
2263
2264         dbg("%s - %02x", __FUNCTION__, newLsr);
2265
2266         edge_port->shadowLSR = lsr;
2267
2268         if (newLsr & LSR_BREAK) {
2269                 //
2270                 // Parity and Framing errors only count if they
2271                 // occur exclusive of a break being
2272                 // received.
2273                 //
2274                 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
2275         }
2276
2277         /* Place LSR data byte into Rx buffer */
2278         if (lsrData && edge_port->port->tty) {
2279                 tty_insert_flip_char(edge_port->port->tty, data, 0);
2280                 tty_flip_buffer_push(edge_port->port->tty);
2281         }
2282
2283         /* update input line counters */
2284         icount = &edge_port->icount;
2285         if (newLsr & LSR_BREAK) {
2286                 icount->brk++;
2287         }
2288         if (newLsr & LSR_OVER_ERR) {
2289                 icount->overrun++;
2290         }
2291         if (newLsr & LSR_PAR_ERR) {
2292                 icount->parity++;
2293         }
2294         if (newLsr & LSR_FRM_ERR) {
2295                 icount->frame++;
2296         }
2297
2298         return;
2299 }
2300
2301
2302 /****************************************************************************
2303  * sram_write
2304  *      writes a number of bytes to the Edgeport device's sram starting at the 
2305  *      given address.
2306  *      If successful returns the number of bytes written, otherwise it returns
2307  *      a negative error number of the problem.
2308  ****************************************************************************/
2309 static int sram_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2310 {
2311         int result;
2312         __u16 current_length;
2313         unsigned char *transfer_buffer;
2314
2315         dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2316
2317         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2318         if (!transfer_buffer) {
2319                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2320                 return -ENOMEM;
2321         }
2322
2323         /* need to split these writes up into 64 byte chunks */
2324         result = 0;
2325         while (length > 0) {
2326                 if (length > 64) {
2327                         current_length = 64;
2328                 } else {
2329                         current_length = length;
2330                 }
2331 //              dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2332                 memcpy (transfer_buffer, data, current_length);
2333                 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_RAM, 
2334                                           0x40, addr, extAddr, transfer_buffer, current_length, 300);
2335                 if (result < 0)
2336                         break;
2337                 length -= current_length;
2338                 addr += current_length;
2339                 data += current_length;
2340         }       
2341
2342         kfree (transfer_buffer);
2343         return result;
2344 }
2345
2346
2347 /****************************************************************************
2348  * rom_write
2349  *      writes a number of bytes to the Edgeport device's ROM starting at the
2350  *      given address.
2351  *      If successful returns the number of bytes written, otherwise it returns
2352  *      a negative error number of the problem.
2353  ****************************************************************************/
2354 static int rom_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2355 {
2356         int result;
2357         __u16 current_length;
2358         unsigned char *transfer_buffer;
2359
2360 //      dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2361
2362         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2363         if (!transfer_buffer) {
2364                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2365                 return -ENOMEM;
2366         }
2367
2368         /* need to split these writes up into 64 byte chunks */
2369         result = 0;
2370         while (length > 0) {
2371                 if (length > 64) {
2372                         current_length = 64;
2373                 } else {
2374                         current_length = length;
2375                 }
2376 //              dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2377                 memcpy (transfer_buffer, data, current_length);
2378                 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_ROM, 
2379                                           0x40, addr, extAddr, transfer_buffer, current_length, 300);
2380                 if (result < 0)
2381                         break;
2382                 length -= current_length;
2383                 addr += current_length;
2384                 data += current_length;
2385         }       
2386
2387         kfree (transfer_buffer);
2388         return result;
2389 }
2390
2391
2392 /****************************************************************************
2393  * rom_read
2394  *      reads a number of bytes from the Edgeport device starting at the given
2395  *      address.
2396  *      If successful returns the number of bytes read, otherwise it returns
2397  *      a negative error number of the problem.
2398  ****************************************************************************/
2399 static int rom_read (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2400 {
2401         int result;
2402         __u16 current_length;
2403         unsigned char *transfer_buffer;
2404
2405         dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2406
2407         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2408         if (!transfer_buffer) {
2409                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2410                 return -ENOMEM;
2411         }
2412
2413         /* need to split these reads up into 64 byte chunks */
2414         result = 0;
2415         while (length > 0) {
2416                 if (length > 64) {
2417                         current_length = 64;
2418                 } else {
2419                         current_length = length;
2420                 }
2421 //              dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2422                 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0), USB_REQUEST_ION_READ_ROM, 
2423                                           0xC0, addr, extAddr, transfer_buffer, current_length, 300);
2424                 if (result < 0)
2425                         break;
2426                 memcpy (data, transfer_buffer, current_length);
2427                 length -= current_length;
2428                 addr += current_length;
2429                 data += current_length;
2430         }       
2431
2432         kfree (transfer_buffer);
2433         return result;
2434 }
2435
2436
2437 /****************************************************************************
2438  * send_iosp_ext_cmd
2439  *      Is used to send a IOSP message to the Edgeport device
2440  ****************************************************************************/
2441 static int send_iosp_ext_cmd (struct edgeport_port *edge_port, __u8 command, __u8 param)
2442 {
2443         unsigned char   *buffer;
2444         unsigned char   *currentCommand;
2445         int             length = 0;
2446         int             status = 0;
2447
2448         dbg("%s - %d, %d", __FUNCTION__, command, param);
2449
2450         buffer =  kmalloc (10, GFP_ATOMIC);
2451         if (!buffer) {
2452                 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 10);
2453                 return -ENOMEM;
2454         }
2455
2456         currentCommand = buffer;
2457
2458         MAKE_CMD_EXT_CMD (&currentCommand, &length,
2459                           edge_port->port->number - edge_port->port->serial->minor,
2460                           command, param);
2461
2462         status = write_cmd_usb (edge_port, buffer, length);
2463         if (status) {
2464                 /* something bad happened, let's free up the memory */
2465                 kfree(buffer);
2466         }
2467
2468         return status;
2469 }
2470
2471
2472 /*****************************************************************************
2473  * write_cmd_usb
2474  *      this function writes the given buffer out to the bulk write endpoint.
2475  *****************************************************************************/
2476 static int write_cmd_usb (struct edgeport_port *edge_port, unsigned char *buffer, int length)
2477 {
2478         struct edgeport_serial *edge_serial = usb_get_serial_data(edge_port->port->serial);
2479         int status = 0;
2480         struct urb *urb;
2481         int timeout;
2482
2483         usb_serial_debug_data (__FILE__, __FUNCTION__, length, buffer);
2484
2485         /* Allocate our next urb */
2486         urb = usb_alloc_urb (0, GFP_ATOMIC);
2487         if (!urb)
2488                 return -ENOMEM;
2489
2490         CmdUrbs++;
2491         dbg("%s - ALLOCATE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
2492
2493         usb_fill_bulk_urb (urb, edge_serial->serial->dev, 
2494                        usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
2495                        buffer, length, edge_bulk_out_cmd_callback, edge_port);
2496
2497         edge_port->commandPending = TRUE;
2498         status = usb_submit_urb(urb, GFP_ATOMIC);
2499
2500         if (status) {
2501                 /* something went wrong */
2502                 dbg("%s - usb_submit_urb(write bulk) failed", __FUNCTION__);
2503                 usb_unlink_urb (urb);
2504                 usb_free_urb   (urb);
2505                 return status;
2506         }
2507
2508         // wait for command to finish
2509         timeout = COMMAND_TIMEOUT;
2510 #if 0
2511         while (timeout && edge_port->commandPending == TRUE) {
2512                 timeout = interruptible_sleep_on_timeout (&edge_port->wait_command, timeout);
2513         }
2514
2515         if (edge_port->commandPending == TRUE) {
2516                 /* command timed out */
2517                 dbg("%s - command timed out", __FUNCTION__);
2518                 status = -EINVAL;
2519         }
2520 #endif
2521         return status;
2522 }
2523
2524
2525 /*****************************************************************************
2526  * send_cmd_write_baud_rate
2527  *      this function sends the proper command to change the baud rate of the
2528  *      specified port.
2529  *****************************************************************************/
2530 static int send_cmd_write_baud_rate (struct edgeport_port *edge_port, int baudRate)
2531 {
2532         unsigned char *cmdBuffer;
2533         unsigned char *currCmd;
2534         int cmdLen = 0;
2535         int divisor;
2536         int status;
2537         unsigned char number = edge_port->port->number - edge_port->port->serial->minor;
2538
2539         dbg("%s - port = %d, baud = %d", __FUNCTION__, edge_port->port->number, baudRate);
2540
2541         status = calc_baud_rate_divisor (baudRate, &divisor);
2542         if (status) {
2543                 dev_err(&edge_port->port->dev, "%s - bad baud rate\n", __FUNCTION__);
2544                 return status;
2545         }
2546
2547         // Alloc memory for the string of commands.
2548         cmdBuffer =  kmalloc (0x100, GFP_ATOMIC);
2549         if (!cmdBuffer) {
2550                 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 0x100);
2551                 return -ENOMEM;
2552         }
2553         currCmd = cmdBuffer;
2554
2555         // Enable access to divisor latch
2556         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE );
2557
2558         // Write the divisor itself
2559         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLL, LOW8 (divisor) );
2560         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLM, HIGH8(divisor) );
2561
2562         // Restore original value to disable access to divisor latch
2563         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, edge_port->shadowLCR);
2564
2565         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen );
2566         if (status) {
2567                 /* something bad happened, let's free up the memory */
2568                 kfree (cmdBuffer);
2569         }
2570
2571         return status;
2572 }
2573
2574
2575 /*****************************************************************************
2576  * calc_baud_rate_divisor
2577  *      this function calculates the proper baud rate divisor for the specified
2578  *      baud rate.
2579  *****************************************************************************/
2580 static int calc_baud_rate_divisor (int baudrate, int *divisor)
2581 {
2582         int i;
2583         __u16 custom;
2584         __u16 round1;
2585         __u16 round;
2586
2587
2588         dbg("%s - %d", __FUNCTION__, baudrate);
2589
2590         for (i = 0; i < NUM_ENTRIES(divisor_table); i++) {
2591                 if ( divisor_table[i].BaudRate == baudrate ) {
2592                         *divisor = divisor_table[i].Divisor;
2593                         return 0;
2594                 }
2595         }
2596
2597         // We have tried all of the standard baud rates
2598         // lets try to calculate the divisor for this baud rate
2599         // Make sure the baud rate is reasonable
2600         if (baudrate < 230400) {
2601                 // get divisor
2602                 custom = (__u16)(230400L  / baudrate);
2603
2604                 // Check for round off
2605                 round1 = (__u16)(2304000L / baudrate);
2606                 round = (__u16)(round1 - (custom * 10));
2607                 if (round > 4) {
2608                         custom++;
2609                 }
2610                 *divisor = custom;
2611
2612                 dbg("%s - Baud %d = %d\n", __FUNCTION__, baudrate, custom);
2613                 return 0;
2614         }
2615
2616         return -1;
2617 }
2618
2619
2620 /*****************************************************************************
2621  * send_cmd_write_uart_register
2622  *      this function builds up a uart register message and sends to to the device.
2623  *****************************************************************************/
2624 static int send_cmd_write_uart_register (struct edgeport_port *edge_port, __u8 regNum, __u8 regValue)
2625 {
2626         unsigned char *cmdBuffer;
2627         unsigned char *currCmd;
2628         unsigned long cmdLen = 0;
2629         int status;
2630
2631         dbg("%s - write to %s register 0x%02x", (regNum == MCR) ? "MCR" : "LCR", __FUNCTION__, regValue);
2632
2633         // Alloc memory for the string of commands.
2634         cmdBuffer = kmalloc (0x10, GFP_ATOMIC);
2635         if (cmdBuffer == NULL ) {
2636                 return -ENOMEM;
2637         }
2638
2639         currCmd = cmdBuffer;
2640
2641         // Build a cmd in the buffer to write the given register
2642         MAKE_CMD_WRITE_REG (&currCmd, &cmdLen,
2643                             edge_port->port->number - edge_port->port->serial->minor,
2644                             regNum, regValue);
2645
2646         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2647         if (status) {
2648                 /* something bad happened, let's free up the memory */
2649                 kfree (cmdBuffer);
2650         }
2651
2652         return status;
2653 }
2654
2655
2656 /*****************************************************************************
2657  * change_port_settings
2658  *      This routine is called to set the UART on the device to match the specified
2659  *      new settings.
2660  *****************************************************************************/
2661 static void change_port_settings (struct edgeport_port *edge_port, struct termios *old_termios)
2662 {
2663         struct tty_struct *tty;
2664         int baud;
2665         unsigned cflag;
2666         __u8 mask = 0xff;
2667         __u8 lData;
2668         __u8 lParity;
2669         __u8 lStop;
2670         __u8 rxFlow;
2671         __u8 txFlow;
2672         int status;
2673
2674         dbg("%s - port %d", __FUNCTION__, edge_port->port->number);
2675
2676         if ((!edge_port->open) &&
2677             (!edge_port->openPending)) {
2678                 dbg("%s - port not opened", __FUNCTION__);
2679                 return;
2680         }
2681
2682         tty = edge_port->port->tty;
2683         if ((!tty) ||
2684             (!tty->termios)) {
2685                 dbg("%s - no tty structures", __FUNCTION__);
2686                 return;
2687         }
2688
2689         cflag = tty->termios->c_cflag;
2690
2691         switch (cflag & CSIZE) {
2692                 case CS5:   lData = LCR_BITS_5; mask = 0x1f;    dbg("%s - data bits = 5", __FUNCTION__);   break;
2693                 case CS6:   lData = LCR_BITS_6; mask = 0x3f;    dbg("%s - data bits = 6", __FUNCTION__);   break;
2694                 case CS7:   lData = LCR_BITS_7; mask = 0x7f;    dbg("%s - data bits = 7", __FUNCTION__);   break;
2695                 default:
2696                 case CS8:   lData = LCR_BITS_8;                 dbg("%s - data bits = 8", __FUNCTION__);   break;
2697         }
2698
2699         lParity = LCR_PAR_NONE;
2700         if (cflag & PARENB) {
2701                 if (cflag & PARODD) {
2702                         lParity = LCR_PAR_ODD;
2703                         dbg("%s - parity = odd", __FUNCTION__);
2704                 } else {
2705                         lParity = LCR_PAR_EVEN;
2706                         dbg("%s - parity = even", __FUNCTION__);
2707                 }
2708         } else {
2709                 dbg("%s - parity = none", __FUNCTION__);
2710         }
2711
2712         if (cflag & CSTOPB) {
2713                 lStop = LCR_STOP_2;
2714                 dbg("%s - stop bits = 2", __FUNCTION__);
2715         } else {
2716                 lStop = LCR_STOP_1;
2717                 dbg("%s - stop bits = 1", __FUNCTION__);
2718         }
2719
2720         /* figure out the flow control settings */
2721         rxFlow = txFlow = 0x00;
2722         if (cflag & CRTSCTS) {
2723                 rxFlow |= IOSP_RX_FLOW_RTS;
2724                 txFlow |= IOSP_TX_FLOW_CTS;
2725                 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
2726         } else {
2727                 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
2728         }
2729
2730         /* if we are implementing XON/XOFF, set the start and stop character in the device */
2731         if (I_IXOFF(tty) || I_IXON(tty)) {
2732                 unsigned char stop_char  = STOP_CHAR(tty);
2733                 unsigned char start_char = START_CHAR(tty);
2734
2735                 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XON_CHAR, start_char);
2736                 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XOFF_CHAR, stop_char);
2737
2738                 /* if we are implementing INBOUND XON/XOFF */
2739                 if (I_IXOFF(tty)) {
2740                         rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2741                         dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2742                 } else {
2743                         dbg("%s - INBOUND XON/XOFF is disabled", __FUNCTION__);
2744                 }
2745
2746                 /* if we are implementing OUTBOUND XON/XOFF */
2747                 if (I_IXON(tty)) {
2748                         txFlow |= IOSP_TX_FLOW_XON_XOFF;
2749                         dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2750                 } else {
2751                         dbg("%s - OUTBOUND XON/XOFF is disabled", __FUNCTION__);
2752                 }
2753         }
2754
2755         /* Set flow control to the configured value */
2756         send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2757         send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2758
2759
2760         edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2761         edge_port->shadowLCR |= (lData | lParity | lStop);
2762
2763         edge_port->validDataMask = mask;
2764
2765         /* Send the updated LCR value to the EdgePort */
2766         status = send_cmd_write_uart_register(edge_port, LCR, edge_port->shadowLCR);
2767         if (status != 0) {
2768                 return;
2769         }
2770
2771         /* set up the MCR register and send it to the EdgePort */
2772         edge_port->shadowMCR = MCR_MASTER_IE;
2773         if (cflag & CBAUD) {
2774                 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2775         }
2776         status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
2777         if (status != 0) {
2778                 return;
2779         }
2780
2781         /* Determine divisor based on baud rate */
2782         baud = tty_get_baud_rate(tty);
2783         if (!baud) {
2784                 /* pick a default, any default... */
2785                 baud = 9600;
2786         }
2787
2788         dbg("%s - baud rate = %d", __FUNCTION__, baud);
2789         status = send_cmd_write_baud_rate (edge_port, baud);
2790
2791         return;
2792 }
2793
2794
2795 /****************************************************************************
2796  * unicode_to_ascii
2797  *      Turns a string from Unicode into ASCII.
2798  *      Doesn't do a good job with any characters that are outside the normal
2799  *      ASCII range, but it's only for debugging...
2800  *      NOTE: expects the unicode in LE format
2801  ****************************************************************************/
2802 static void unicode_to_ascii (char *string, short *unicode, int unicode_size)
2803 {
2804         int i;
2805         for (i = 0; i < unicode_size; ++i) {
2806                 string[i] = (char)(le16_to_cpu(unicode[i]));
2807         }
2808         string[unicode_size] = 0x00;
2809 }
2810
2811
2812 /****************************************************************************
2813  * get_manufacturing_desc
2814  *      reads in the manufacturing descriptor and stores it into the serial 
2815  *      structure.
2816  ****************************************************************************/
2817 static void get_manufacturing_desc (struct edgeport_serial *edge_serial)
2818 {
2819         int response;
2820
2821         dbg("getting manufacturer descriptor");
2822
2823         response = rom_read (edge_serial->serial, (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16, 
2824                             (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff), EDGE_MANUF_DESC_LEN,
2825                             (__u8 *)(&edge_serial->manuf_descriptor));
2826
2827         if (response < 1) {
2828                 dev_err(&edge_serial->serial->dev->dev, "error in getting manufacturer descriptor\n");
2829         } else {
2830                 char string[30];
2831                 dbg("**Manufacturer Descriptor");
2832                 dbg("  RomSize:        %dK", edge_serial->manuf_descriptor.RomSize);
2833                 dbg("  RamSize:        %dK", edge_serial->manuf_descriptor.RamSize);
2834                 dbg("  CpuRev:         %d", edge_serial->manuf_descriptor.CpuRev);
2835                 dbg("  BoardRev:       %d", edge_serial->manuf_descriptor.BoardRev);
2836                 dbg("  NumPorts:       %d", edge_serial->manuf_descriptor.NumPorts);
2837                 dbg("  DescDate:       %d/%d/%d", edge_serial->manuf_descriptor.DescDate[0], edge_serial->manuf_descriptor.DescDate[1], edge_serial->manuf_descriptor.DescDate[2]+1900);
2838                 unicode_to_ascii (string, edge_serial->manuf_descriptor.SerialNumber, edge_serial->manuf_descriptor.SerNumLength/2-1);
2839                 dbg("  SerialNumber: %s", string);
2840                 unicode_to_ascii (string, edge_serial->manuf_descriptor.AssemblyNumber, edge_serial->manuf_descriptor.AssemblyNumLength/2-1);
2841                 dbg("  AssemblyNumber: %s", string);
2842                 unicode_to_ascii (string, edge_serial->manuf_descriptor.OemAssyNumber, edge_serial->manuf_descriptor.OemAssyNumLength/2-1);
2843                 dbg("  OemAssyNumber:  %s", string);
2844                 dbg("  UartType:       %d", edge_serial->manuf_descriptor.UartType);
2845                 dbg("  IonPid:         %d", edge_serial->manuf_descriptor.IonPid);
2846                 dbg("  IonConfig:      %d", edge_serial->manuf_descriptor.IonConfig);
2847         }
2848 }
2849
2850
2851 /****************************************************************************
2852  * get_boot_desc
2853  *      reads in the bootloader descriptor and stores it into the serial 
2854  *      structure.
2855  ****************************************************************************/
2856 static void get_boot_desc (struct edgeport_serial *edge_serial)
2857 {
2858         int response;
2859
2860         dbg("getting boot descriptor");
2861
2862         response = rom_read (edge_serial->serial, (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16, 
2863                             (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff), EDGE_BOOT_DESC_LEN,
2864                             (__u8 *)(&edge_serial->boot_descriptor));
2865
2866         if (response < 1) {
2867                 dev_err(&edge_serial->serial->dev->dev, "error in getting boot descriptor\n");
2868         } else {
2869                 dbg("**Boot Descriptor:");
2870                 dbg("  BootCodeLength: %d", le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2871                 dbg("  MajorVersion:   %d", edge_serial->boot_descriptor.MajorVersion);
2872                 dbg("  MinorVersion:   %d", edge_serial->boot_descriptor.MinorVersion);
2873                 dbg("  BuildNumber:    %d", le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2874                 dbg("  Capabilities:   0x%x", le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2875                 dbg("  UConfig0:       %d", edge_serial->boot_descriptor.UConfig0);
2876                 dbg("  UConfig1:       %d", edge_serial->boot_descriptor.UConfig1);
2877         }
2878 }
2879
2880
2881 /****************************************************************************
2882  * load_application_firmware
2883  *      This is called to load the application firmware to the device
2884  ****************************************************************************/
2885 static void load_application_firmware (struct edgeport_serial *edge_serial)
2886 {
2887         struct edge_firmware_image_record *record;
2888         unsigned char *firmware;
2889         unsigned char *FirmwareImage;
2890         int ImageSize;
2891         int response;
2892
2893
2894         switch (edge_serial->product_info.iDownloadFile) {
2895                 case EDGE_DOWNLOAD_FILE_I930:
2896                         dbg("downloading firmware version (930) %d.%d.%d", 
2897                             OperationalCodeImageVersion_GEN1.MajorVersion, 
2898                             OperationalCodeImageVersion_GEN1.MinorVersion, 
2899                             OperationalCodeImageVersion_GEN1.BuildNumber);
2900                         firmware = &OperationalCodeImage_GEN1[0];
2901                         FirmwareImage = &OperationalCodeImage_GEN1[0];
2902                         ImageSize = sizeof(OperationalCodeImage_GEN1);
2903                         break;
2904
2905                 case EDGE_DOWNLOAD_FILE_80251:
2906                         dbg("downloading firmware version (80251) %d.%d.%d", 
2907                             OperationalCodeImageVersion_GEN2.MajorVersion, 
2908                             OperationalCodeImageVersion_GEN2.MinorVersion, 
2909                             OperationalCodeImageVersion_GEN2.BuildNumber);
2910                         firmware = &OperationalCodeImage_GEN2[0];
2911                         FirmwareImage = &OperationalCodeImage_GEN2[0];
2912                         ImageSize = sizeof(OperationalCodeImage_GEN2);
2913                         break;
2914
2915                 case EDGE_DOWNLOAD_FILE_NONE:
2916                         dbg     ("No download file specified, skipping download\n");
2917                         return;
2918
2919                 default:
2920                         return;
2921         }
2922
2923
2924         for (;;) {
2925                 record = (struct edge_firmware_image_record *)firmware;
2926                 response = sram_write (edge_serial->serial, le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len), &record->Data[0]);
2927                 if (response < 0) {
2928                         dev_err(&edge_serial->serial->dev->dev, "sram_write failed (%x, %x, %d)\n", le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), record->Len);
2929                         break;
2930                 }
2931                 firmware += sizeof (struct edge_firmware_image_record) + le16_to_cpu(record->Len);
2932                 if (firmware >= &FirmwareImage[ImageSize]) {
2933                         break;
2934                 }
2935         }
2936
2937         dbg("sending exec_dl_code");
2938         response = usb_control_msg (edge_serial->serial->dev, 
2939                                     usb_sndctrlpipe(edge_serial->serial->dev, 0), 
2940                                     USB_REQUEST_ION_EXEC_DL_CODE, 
2941                                     0x40, 0x4000, 0x0001, NULL, 0, 3000);
2942
2943         return;
2944 }
2945
2946
2947
2948
2949 /****************************************************************************
2950  * edge_startup
2951  ****************************************************************************/
2952 static int edge_startup (struct usb_serial *serial)
2953 {
2954         struct edgeport_serial *edge_serial;
2955         struct edgeport_port *edge_port;
2956         struct usb_device *dev;
2957         int i;
2958
2959         dev = serial->dev;
2960
2961         /* create our private serial structure */
2962         edge_serial = kmalloc (sizeof(struct edgeport_serial), GFP_KERNEL);
2963         if (edge_serial == NULL) {
2964                 dev_err(&serial->dev->dev, "%s - Out of memory", __FUNCTION__);
2965                 return -ENOMEM;
2966         }
2967         memset (edge_serial, 0, sizeof(struct edgeport_serial));
2968         edge_serial->serial = serial;
2969         usb_set_serial_data(serial, edge_serial);
2970
2971         /* get the name for the device from the device */
2972         if ( (i = get_string(dev, dev->descriptor.iManufacturer, &edge_serial->name[0])) != 0) {
2973                 edge_serial->name[i-1] = ' ';
2974         }
2975
2976         get_string(dev, dev->descriptor.iProduct, &edge_serial->name[i]);
2977
2978         dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2979
2980         /* get the manufacturing descriptor for this device */
2981         get_manufacturing_desc (edge_serial);
2982
2983         /* get the boot descriptor */
2984         get_boot_desc (edge_serial);
2985
2986         get_product_info(edge_serial);
2987
2988         /* set the number of ports from the manufacturing description */
2989         /* serial->num_ports = serial->product_info.NumPorts; */
2990         if (edge_serial->product_info.NumPorts != serial->num_ports) {
2991                 warn("%s - Device Reported %d serial ports vs core "
2992                      "thinking we have %d ports, email greg@kroah.com this info.",
2993                      __FUNCTION__, edge_serial->product_info.NumPorts, 
2994                      serial->num_ports);
2995         }
2996
2997         dbg("%s - time 1 %ld", __FUNCTION__, jiffies);
2998
2999         /* now load the application firmware into this device */
3000         load_application_firmware (edge_serial);
3001
3002         dbg("%s - time 2 %ld", __FUNCTION__, jiffies);
3003
3004         /* Check current Edgeport EEPROM and update if necessary */
3005         update_edgeport_E2PROM (edge_serial);
3006         
3007         dbg("%s - time 3 %ld", __FUNCTION__, jiffies);
3008
3009         /* set the configuration to use #1 */
3010 //      dbg("set_configuration 1");
3011 //      usb_set_configuration (dev, 1);
3012
3013         /* we set up the pointers to the endpoints in the edge_open function, 
3014          * as the structures aren't created yet. */
3015
3016         /* set up our port private structures */
3017         for (i = 0; i < serial->num_ports; ++i) {
3018                 edge_port = kmalloc (sizeof(struct edgeport_port), GFP_KERNEL);
3019                 if (edge_port == NULL) {
3020                         dev_err(&serial->dev->dev, "%s - Out of memory", __FUNCTION__);
3021                         usb_set_serial_data(serial, NULL);
3022                         kfree(edge_serial);
3023                         return -ENOMEM;
3024                 }
3025                 memset (edge_port, 0, sizeof(struct edgeport_port));
3026                 edge_port->port = serial->port[i];
3027                 usb_set_serial_port_data(serial->port[i], edge_port);
3028         }
3029         
3030         return 0;
3031 }
3032
3033
3034
3035 /****************************************************************************
3036  * edge_shutdown
3037  *      This function is called whenever the device is removed from the usb bus.
3038  ****************************************************************************/
3039 static void edge_shutdown (struct usb_serial *serial)
3040 {
3041         int i;
3042
3043         dbg("%s", __FUNCTION__);
3044
3045         /* stop reads and writes on all ports */
3046         for (i=0; i < serial->num_ports; ++i) {
3047                 kfree (usb_get_serial_port_data(serial->port[i]));
3048                 usb_set_serial_port_data(serial->port[i],  NULL);
3049         }
3050         kfree (usb_get_serial_data(serial));
3051         usb_set_serial_data(serial, NULL);
3052 }
3053
3054
3055 /****************************************************************************
3056  * edgeport_init
3057  *      This is called by the module subsystem, or on startup to initialize us
3058  ****************************************************************************/
3059 static int __init edgeport_init(void)
3060 {
3061         int retval;
3062         retval = usb_serial_register(&edgeport_1port_device);
3063         if (retval) 
3064                 goto failed_1port_device_register;
3065         retval = usb_serial_register(&edgeport_2port_device);
3066         if (retval)
3067                 goto failed_2port_device_register;
3068         retval = usb_serial_register(&edgeport_4port_device);
3069         if (retval)
3070                 goto failed_4port_device_register;
3071         retval = usb_serial_register(&edgeport_8port_device);
3072         if (retval)
3073                 goto failed_8port_device_register;
3074         retval = usb_register(&io_driver);
3075         if (retval) 
3076                 goto failed_usb_register;
3077         info(DRIVER_DESC " " DRIVER_VERSION);
3078         return 0;
3079 failed_usb_register:
3080         usb_serial_deregister(&edgeport_8port_device);
3081 failed_8port_device_register:
3082         usb_serial_deregister(&edgeport_4port_device);
3083 failed_4port_device_register:
3084         usb_serial_deregister(&edgeport_2port_device);
3085 failed_2port_device_register:
3086         usb_serial_deregister(&edgeport_1port_device);
3087 failed_1port_device_register:
3088         return retval;
3089 }
3090
3091
3092
3093 /****************************************************************************
3094  * edgeport_exit
3095  *      Called when the driver is about to be unloaded.
3096  ****************************************************************************/
3097 static void __exit edgeport_exit (void)
3098 {
3099         usb_deregister (&io_driver);
3100         usb_serial_deregister (&edgeport_1port_device);
3101         usb_serial_deregister (&edgeport_2port_device);
3102         usb_serial_deregister (&edgeport_4port_device);
3103         usb_serial_deregister (&edgeport_8port_device);
3104 }
3105
3106 module_init(edgeport_init);
3107 module_exit(edgeport_exit);
3108
3109 /* Module information */
3110 MODULE_AUTHOR( DRIVER_AUTHOR );
3111 MODULE_DESCRIPTION( DRIVER_DESC );
3112 MODULE_LICENSE("GPL");
3113
3114 MODULE_PARM(debug, "i");
3115 MODULE_PARM_DESC(debug, "Debug enabled or not");
3116