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         switch (urb->status) {
 780         case 0:
 781                 /* success */
 782                 break;
 783         case -ECONNRESET:
 784         case -ENOENT:
 785         case -ESHUTDOWN:
 786                 /* this urb is terminated, clean up */
 787                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 788                 return;
 789         default:
 790                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
 791                 goto exit;
 792         }
 793
 794         // process this interrupt-read even if there are no ports open
 795         if (length) {
 796                 usb_serial_debug_data (__FILE__, __FUNCTION__, length, data);
 797
 798                 if (length > 1) {
 799                         bytes_avail = data[0] | (data[1] << 8);
 800                         if (bytes_avail) {
 801                                 edge_serial->rxBytesAvail += bytes_avail;
 802                                 dbg("%s - bytes_avail = %d, rxBytesAvail %d", __FUNCTION__, bytes_avail, edge_serial->rxBytesAvail);
 803
 804                                 if ((edge_serial->rxBytesAvail > 0) &&
 805                                     (edge_serial->read_urb->status != -EINPROGRESS)) {
 806                                         dbg(" --- Posting a read");
 807
 808                                         /* we have pending bytes on the bulk in pipe, send a request */
 809                                         edge_serial->read_urb->dev = edge_serial->serial->dev;
 810                                         result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
 811                                         if (result) {
 812                                                 dbg("%s - usb_submit_urb(read bulk) failed with result = %d", __FUNCTION__, result);
 813                                         }
 814                                 }
 815                         }
 816                 }
 817                 /* grab the txcredits for the ports if available */
 818                 position = 2;
 819                 portNumber = 0;
 820                 while ((position < length) && (portNumber < edge_serial->serial->num_ports)) {
 821                         txCredits = data[position] | (data[position+1] << 8);
 822                         if (txCredits) {
 823                                 port = edge_serial->serial->port[portNumber];
 824                                 edge_port = usb_get_serial_port_data(port);
 825                                 if (edge_port->open) {
 826                                         edge_port->txCredits += txCredits;
 827                                         dbg("%s - txcredits for port%d = %d", __FUNCTION__, portNumber, edge_port->txCredits);
 828
 829                                         /* tell the tty driver that something has changed */
 830                                         if (edge_port->port->tty)
 831                                                 wake_up_interruptible(&edge_port->port->tty->write_wait);
 832
 833                                         // Since we have more credit, check if more data can be sent
 834                                         send_more_port_data(edge_serial, edge_port);
 835                                 }
 836                         }
 837                         position += 2;
 838                         ++portNumber;
 839                 }
 840         }
 841
 842 exit:
 843         result = usb_submit_urb (urb, GFP_ATOMIC);
 844         if (result) {
 845                 dev_err(&urb->dev->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, result);
 846         }
 847 }
 848
 849
 850 /*****************************************************************************
 851  * edge_bulk_in_callback
 852  *      this is the callback function for when we have received data on the
 853  *      bulk in endpoint.
 854  *****************************************************************************/
 855 static void edge_bulk_in_callback (struct urb *urb, struct pt_regs *regs)
 856 {
 857         struct edgeport_serial  *edge_serial = (struct edgeport_serial *)urb->context;
 858         unsigned char           *data = urb->transfer_buffer;
 859         int                     status;
 860         __u16                   raw_data_length;
 861
 862         dbg("%s", __FUNCTION__);
 863
 864         if (urb->status) {
 865                 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
 866                 return;
 867         }
 868
 869         if (urb->actual_length) {
 870                 raw_data_length = urb->actual_length;
 871
 872                 usb_serial_debug_data (__FILE__, __FUNCTION__, raw_data_length, data);
 873
 874                 /* decrement our rxBytes available by the number that we just got */
 875                 edge_serial->rxBytesAvail -= raw_data_length;
 876
 877                 dbg("%s - Received = %d, rxBytesAvail %d", __FUNCTION__, raw_data_length, edge_serial->rxBytesAvail);
 878
 879                 process_rcvd_data (edge_serial, data, urb->actual_length);
 880
 881                 /* check to see if there's any more data for us to read */
 882                 if ((edge_serial->rxBytesAvail > 0) &&
 883                     (edge_serial->read_urb->status != -EINPROGRESS)) {
 884                         dbg(" --- Posting a read");
 885
 886                         /* there is, so resubmit our urb */
 887                         edge_serial->read_urb->dev = edge_serial->serial->dev;
 888                         status = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
 889                         if (status) {
 890                                 dev_err(&urb->dev->dev, "%s - usb_submit_urb(read bulk) failed, status = %d\n", __FUNCTION__, status);
 891                         }
 892                 }
 893         }
 894 }
 895
 896
 897 /*****************************************************************************
 898  * edge_bulk_out_data_callback
 899  *      this is the callback function for when we have finished sending serial data
 900  *      on the bulk out endpoint.
 901  *****************************************************************************/
 902 static void edge_bulk_out_data_callback (struct urb *urb, struct pt_regs *regs)
 903 {
 904         struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
 905         struct tty_struct *tty;
 906
 907         dbg("%s", __FUNCTION__);
 908
 909         if (urb->status) {
 910                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
 911         }
 912
 913         tty = edge_port->port->tty;
 914
 915         if (tty && edge_port->open) {
 916                 /* let the tty driver wakeup if it has a special write_wakeup function */
 917                 if ((tty->flags & (1 << TTY_DO_WRITE_WAKEUP)) && tty->ldisc.write_wakeup) {
 918                         (tty->ldisc.write_wakeup)(tty);
 919                 }
 920
 921                 /* tell the tty driver that something has changed */
 922                 wake_up_interruptible(&tty->write_wait);
 923         }
 924
 925         // Release the Write URB
 926         edge_port->write_in_progress = FALSE;
 927
 928         // Check if more data needs to be sent
 929         send_more_port_data((struct edgeport_serial *)(usb_get_serial_data(edge_port->port->serial)), edge_port);
 930 }
 931
 932
 933 /*****************************************************************************
 934  * BulkOutCmdCallback
 935  *      this is the callback function for when we have finished sending a command
 936  *      on the bulk out endpoint.
 937  *****************************************************************************/
 938 static void edge_bulk_out_cmd_callback (struct urb *urb, struct pt_regs *regs)
 939 {
 940         struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
 941         struct tty_struct *tty;
 942         int status = urb->status;
 943
 944         dbg("%s", __FUNCTION__);
 945
 946         CmdUrbs--;
 947         dbg("%s - FREE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
 948
 949
 950         /* clean up the transfer buffer */
 951         if (urb->transfer_buffer != NULL) {
 952                 kfree(urb->transfer_buffer);
 953         }
 954
 955         /* Free the command urb */
 956         usb_free_urb (urb);
 957
 958         if (status) {
 959                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, status);
 960                 return;
 961         }
 962
 963         /* Get pointer to tty */
 964         tty = edge_port->port->tty;
 965
 966         /* tell the tty driver that something has changed */
 967         if (tty && edge_port->open)
 968                 wake_up_interruptible(&tty->write_wait);
 969
 970         /* we have completed the command */
 971         edge_port->commandPending = FALSE;
 972         wake_up_interruptible(&edge_port->wait_command);
 973 }
 974
 975
 976 /*****************************************************************************
 977  * Driver tty interface functions
 978  *****************************************************************************/
 979
 980 /*****************************************************************************
 981  * SerialOpen
 982  *      this function is called by the tty driver when a port is opened
 983  *      If successful, we return 0
 984  *      Otherwise we return a negative error number.
 985  *****************************************************************************/
 986 static int edge_open (struct usb_serial_port *port, struct file * filp)
 987 {
 988         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 989         struct usb_serial *serial;
 990         struct edgeport_serial *edge_serial;
 991         int response;
 992         int timeout;
 993
 994         dbg("%s - port %d", __FUNCTION__, port->number);
 995
 996         if (edge_port == NULL)
 997                 return -ENODEV;
 998
 999         /* force low_latency on so that our tty_push actually forces the data through,
1000            otherwise it is scheduled, and with high data rates (like with OHCI) data
1001            can get lost. */
1002         if (port->tty)
1003                 port->tty->low_latency = 1;
1004
1005         /* see if we've set up our endpoint info yet (can't set it up in edge_startup
1006            as the structures were not set up at that time.) */
1007         serial = port->serial;
1008         edge_serial = usb_get_serial_data(serial);
1009         if (edge_serial == NULL) {
1010                 return -ENODEV;
1011         }
1012         if (edge_serial->interrupt_in_buffer == NULL) {
1013                 struct usb_serial_port *port0 = serial->port[0];
1014
1015                 /* not set up yet, so do it now */
1016                 edge_serial->interrupt_in_buffer = port0->interrupt_in_buffer;
1017                 edge_serial->interrupt_in_endpoint = port0->interrupt_in_endpointAddress;
1018                 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
1019                 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
1020                 edge_serial->bulk_in_endpoint = port0->bulk_in_endpointAddress;
1021                 edge_serial->read_urb = port0->read_urb;
1022                 edge_serial->bulk_out_endpoint = port0->bulk_out_endpointAddress;
1023
1024                 /* set up our interrupt urb */
1025                 usb_fill_int_urb(edge_serial->interrupt_read_urb,
1026                                  serial->dev,
1027                                  usb_rcvintpipe(serial->dev,
1028                                                 port0->interrupt_in_endpointAddress),
1029                                  port0->interrupt_in_buffer,
1030                                  edge_serial->interrupt_read_urb->transfer_buffer_length,
1031                                  edge_interrupt_callback, edge_serial,
1032                                  edge_serial->interrupt_read_urb->interval);
1033
1034                 /* set up our bulk in urb */
1035                 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
1036                                   usb_rcvbulkpipe(serial->dev,
1037                                                   port0->bulk_in_endpointAddress),
1038                                   port0->bulk_in_buffer,
1039                                   edge_serial->read_urb->transfer_buffer_length,
1040                                   edge_bulk_in_callback, edge_serial);
1041
1042                 /* start interrupt read for this edgeport
1043                  * this interrupt will continue as long as the edgeport is connected */
1044                 response = usb_submit_urb (edge_serial->interrupt_read_urb, GFP_KERNEL);
1045                 if (response) {
1046                         dev_err(&port->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, response);
1047                 }
1048         }
1049
1050         /* initialize our wait queues */
1051         init_waitqueue_head(&edge_port->wait_open);
1052         init_waitqueue_head(&edge_port->wait_chase);
1053         init_waitqueue_head(&edge_port->delta_msr_wait);
1054         init_waitqueue_head(&edge_port->wait_command);
1055
1056         /* initialize our icount structure */
1057         memset (&(edge_port->icount), 0x00, sizeof(edge_port->icount));
1058
1059         /* initialize our port settings */
1060         edge_port->txCredits            = 0;                    /* Can't send any data yet */
1061         edge_port->shadowMCR            = MCR_MASTER_IE;        /* Must always set this bit to enable ints! */
1062         edge_port->chaseResponsePending = FALSE;
1063
1064         /* send a open port command */
1065         edge_port->openPending = TRUE;
1066         edge_port->open        = FALSE;
1067         response = send_iosp_ext_cmd (edge_port, IOSP_CMD_OPEN_PORT, 0);
1068
1069         if (response < 0) {
1070                 dev_err(&port->dev, "%s - error sending open port command\n", __FUNCTION__);
1071                 edge_port->openPending = FALSE;
1072                 return -ENODEV;
1073         }
1074
1075         /* now wait for the port to be completely opened */
1076         timeout = OPEN_TIMEOUT;
1077         while (timeout && edge_port->openPending == TRUE) {
1078                 timeout = interruptible_sleep_on_timeout (&edge_port->wait_open, timeout);
1079         }
1080
1081         if (edge_port->open == FALSE) {
1082                 /* open timed out */
1083                 dbg("%s - open timedout", __FUNCTION__);
1084                 edge_port->openPending = FALSE;
1085                 return -ENODEV;
1086         }
1087
1088         /* create the txfifo */
1089         edge_port->txfifo.head  = 0;
1090         edge_port->txfifo.tail  = 0;
1091         edge_port->txfifo.count = 0;
1092         edge_port->txfifo.size  = edge_port->maxTxCredits;
1093         edge_port->txfifo.fifo  = kmalloc (edge_port->maxTxCredits, GFP_KERNEL);
1094
1095         if (!edge_port->txfifo.fifo) {
1096                 dbg("%s - no memory", __FUNCTION__);
1097                 edge_close (port, filp);
1098                 return -ENOMEM;
1099         }
1100
1101         /* Allocate a URB for the write */
1102         edge_port->write_urb = usb_alloc_urb (0, GFP_KERNEL);
1103
1104         if (!edge_port->write_urb) {
1105                 dbg("%s - no memory", __FUNCTION__);
1106                 edge_close (port, filp);
1107                 return -ENOMEM;
1108         }
1109
1110         dbg("%s(%d) - Initialize TX fifo to %d bytes", __FUNCTION__, port->number, edge_port->maxTxCredits);
1111
1112         dbg("%s exited", __FUNCTION__);
1113
1114         return 0;
1115 }
1116
1117
1118 /************************************************************************
1119  *
1120  * block_until_chase_response
1121  *
1122  *      This function will block the close until one of the following:
1123  *              1. Response to our Chase comes from Edgeport
1124  *              2. A timout of 10 seconds without activity has expired
1125  *                 (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
1126  *
1127  ************************************************************************/
1128 static void block_until_chase_response(struct edgeport_port *edge_port)
1129 {
1130         __u16 lastCredits;
1131         int timeout = 1*HZ;
1132         int wait = 10;
1133
1134         while (1) {
1135                 // Save Last credits
1136                 lastCredits = edge_port->txCredits;
1137
1138                 // Did we get our Chase response
1139                 if (edge_port->chaseResponsePending == FALSE) {
1140                         dbg("%s - Got Chase Response", __FUNCTION__);
1141
1142                         // did we get all of our credit back?
1143                         if (edge_port->txCredits == edge_port->maxTxCredits ) {
1144                                 dbg("%s - Got all credits", __FUNCTION__);
1145                                 return;
1146                         }
1147                 }
1148
1149                 // Block the thread for a while
1150                 interruptible_sleep_on_timeout (&edge_port->wait_chase, timeout);
1151
1152                 if (lastCredits == edge_port->txCredits) {
1153                         // No activity.. count down.
1154                         wait--;
1155                         if (wait == 0) {
1156                                 edge_port->chaseResponsePending = FALSE;
1157                                 dbg("%s - Chase TIMEOUT", __FUNCTION__);
1158                                 return;
1159                         }
1160                 } else {
1161                         // Reset timout value back to 10 seconds
1162                         dbg("%s - Last %d, Current %d", __FUNCTION__, lastCredits, edge_port->txCredits);
1163                         wait = 10;
1164                 }
1165         }
1166 }
1167
1168
1169 /************************************************************************
1170  *
1171  * block_until_tx_empty
1172  *
1173  *      This function will block the close until one of the following:
1174  *              1. TX count are 0
1175  *              2. The edgeport has stopped
1176  *              3. A timout of 3 seconds without activity has expired
1177  *
1178  ************************************************************************/
1179 static void block_until_tx_empty (struct edgeport_port *edge_port)
1180 {
1181         struct TxFifo *fifo = &edge_port->txfifo;
1182         __u32 lastCount;
1183         int timeout = HZ/10;
1184         int wait = 30;
1185
1186         while (1) {
1187                 // Save Last count
1188                 lastCount = fifo->count;
1189
1190                 // Is the Edgeport Buffer empty?
1191                 if (lastCount == 0) {
1192                         dbg("%s - TX Buffer Empty", __FUNCTION__);
1193                         return;
1194                 }
1195
1196                 // Block the thread for a while
1197                 interruptible_sleep_on_timeout (&edge_port->wait_chase, timeout);
1198
1199                 dbg("%s wait", __FUNCTION__);
1200
1201                 if (lastCount == fifo->count) {
1202                         // No activity.. count down.
1203                         wait--;
1204                         if (wait == 0) {
1205                                 dbg("%s - TIMEOUT", __FUNCTION__);
1206                                 return;
1207                         }
1208                 } else {
1209                         // Reset timout value back to seconds
1210                         wait = 30;
1211                 }
1212         }
1213 }
1214
1215
1216 /*****************************************************************************
1217  * edge_close
1218  *      this function is called by the tty driver when a port is closed
1219  *****************************************************************************/
1220 static void edge_close (struct usb_serial_port *port, struct file * filp)
1221 {
1222         struct edgeport_serial *edge_serial;
1223         struct edgeport_port *edge_port;
1224         int status;
1225
1226         dbg("%s - port %d", __FUNCTION__, port->number);
1227
1228         edge_serial = usb_get_serial_data(port->serial);
1229         edge_port = usb_get_serial_port_data(port);
1230         if ((edge_serial == NULL) || (edge_port == NULL))
1231                 return;
1232
1233         // block until tx is empty
1234         block_until_tx_empty(edge_port);
1235
1236         edge_port->closePending = TRUE;
1237
1238         /* flush and chase */
1239         edge_port->chaseResponsePending = TRUE;
1240
1241         dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1242         status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1243         if (status == 0) {
1244                 // block until chase finished
1245                 block_until_chase_response(edge_port);
1246         } else {
1247                 edge_port->chaseResponsePending = FALSE;
1248         }
1249
1250         /* close the port */
1251         dbg("%s - Sending IOSP_CMD_CLOSE_PORT", __FUNCTION__);
1252         send_iosp_ext_cmd (edge_port, IOSP_CMD_CLOSE_PORT, 0);
1253
1254         //port->close = TRUE;
1255         edge_port->closePending = FALSE;
1256         edge_port->open = FALSE;
1257         edge_port->openPending = FALSE;
1258
1259         if (edge_port->write_urb) {
1260                 usb_unlink_urb (edge_port->write_urb);
1261         }
1262
1263         if (edge_port->write_urb) {
1264                 /* if this urb had a transfer buffer already (old transfer) free it */
1265                 if (edge_port->write_urb->transfer_buffer != NULL) {
1266                         kfree(edge_port->write_urb->transfer_buffer);
1267                 }
1268                 usb_free_urb   (edge_port->write_urb);
1269         }
1270         if (edge_port->txfifo.fifo) {
1271                 kfree(edge_port->txfifo.fifo);
1272         }
1273
1274         dbg("%s exited", __FUNCTION__);
1275 }
1276
1277 /*****************************************************************************
1278  * SerialWrite
1279  *      this function is called by the tty driver when data should be written to
1280  *      the port.
1281  *      If successful, we return the number of bytes written, otherwise we return
1282  *      a negative error number.
1283  *****************************************************************************/
1284 static int edge_write (struct usb_serial_port *port, int from_user, const unsigned char *data, int count)
1285 {
1286         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1287         struct TxFifo *fifo;
1288         int copySize;
1289         int bytesleft;
1290         int firsthalf;
1291         int secondhalf;
1292
1293         dbg("%s - port %d", __FUNCTION__, port->number);
1294
1295         if (edge_port == NULL)
1296                 return -ENODEV;
1297
1298         // get a pointer to the Tx fifo
1299         fifo = &edge_port->txfifo;
1300
1301         // calculate number of bytes to put in fifo
1302         copySize = min ((unsigned int)count, (edge_port->txCredits - fifo->count));
1303
1304         dbg("%s(%d) of %d byte(s) Fifo room  %d -- will copy %d bytes", __FUNCTION__,
1305             port->number, count, edge_port->txCredits - fifo->count, copySize);
1306
1307         /* catch writes of 0 bytes which the tty driver likes to give us, and when txCredits is empty */
1308         if (copySize == 0) {
1309                 dbg("%s - copySize = Zero", __FUNCTION__);
1310                 return 0;
1311         }
1312
1313         // queue the data
1314         // since we can never overflow the buffer we do not have to check for full condition
1315
1316         // the copy is done is two parts -- first fill to the end of the buffer
1317         // then copy the reset from the start of the buffer
1318
1319         bytesleft = fifo->size - fifo->head;
1320         firsthalf = min (bytesleft, copySize);
1321         dbg("%s - copy %d bytes of %d into fifo ", __FUNCTION__, firsthalf, bytesleft);
1322
1323         /* now copy our data */
1324         if (from_user) {
1325                 if (copy_from_user(&fifo->fifo[fifo->head], data, firsthalf))
1326                         return -EFAULT;
1327         } else {
1328                 memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1329         }
1330         usb_serial_debug_data (__FILE__, __FUNCTION__, firsthalf, &fifo->fifo[fifo->head]);
1331
1332         // update the index and size
1333         fifo->head  += firsthalf;
1334         fifo->count += firsthalf;
1335
1336         // wrap the index
1337         if (fifo->head == fifo->size) {
1338                 fifo->head = 0;
1339         }
1340
1341         secondhalf = copySize-firsthalf;
1342
1343         if (secondhalf) {
1344                 dbg("%s - copy rest of data %d", __FUNCTION__, secondhalf);
1345                 if (from_user) {
1346                         if (copy_from_user(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf))
1347                                 return -EFAULT;
1348                 } else {
1349                         memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1350                 }
1351                 usb_serial_debug_data (__FILE__, __FUNCTION__, secondhalf, &fifo->fifo[fifo->head]);
1352                 // update the index and size
1353                 fifo->count += secondhalf;
1354                 fifo->head  += secondhalf;
1355                 // No need to check for wrap since we can not get to end of fifo in this part
1356         }
1357
1358         send_more_port_data((struct edgeport_serial *)usb_get_serial_data(port->serial), edge_port);
1359
1360         dbg("%s wrote %d byte(s) TxCredits %d, Fifo %d", __FUNCTION__, copySize, edge_port->txCredits, fifo->count);
1361
1362         return copySize;
1363 }
1364
1365
1366 /************************************************************************
1367  *
1368  * send_more_port_data()
1369  *
1370  *      This routine attempts to write additional UART transmit data
1371  *      to a port over the USB bulk pipe. It is called (1) when new
1372  *      data has been written to a port's TxBuffer from higher layers
1373  *      (2) when the peripheral sends us additional TxCredits indicating
1374  *      that it can accept more Tx data for a given port; and (3) when
1375  *      a bulk write completes successfully and we want to see if we
1376  *      can transmit more.
1377  *
1378  ************************************************************************/
1379 static void send_more_port_data(struct edgeport_serial *edge_serial, struct edgeport_port *edge_port)
1380 {
1381         struct TxFifo   *fifo = &edge_port->txfifo;
1382         struct urb      *urb;
1383         unsigned char   *buffer;
1384         int             status;
1385         int             count;
1386         int             bytesleft;
1387         int             firsthalf;
1388         int             secondhalf;
1389
1390         dbg("%s(%d)", __FUNCTION__, edge_port->port->number);
1391
1392         if (edge_port->write_in_progress ||
1393             !edge_port->open             ||
1394             (fifo->count == 0)) {
1395                 dbg("%s(%d) EXIT - fifo %d, PendingWrite = %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->write_in_progress);
1396                 return;
1397         }
1398
1399         // since the amount of data in the fifo will always fit into the
1400         // edgeport buffer we do not need to check the write length
1401
1402         //      Do we have enough credits for this port to make it worthwhile
1403         //      to bother queueing a write. If it's too small, say a few bytes,
1404         //      it's better to wait for more credits so we can do a larger
1405         //      write.
1406         if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits)) {
1407                 dbg("%s(%d) Not enough credit - fifo %d TxCredit %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->txCredits );
1408                 return;
1409         }
1410
1411         // lock this write
1412         edge_port->write_in_progress = TRUE;
1413
1414         // get a pointer to the write_urb
1415         urb = edge_port->write_urb;
1416
1417         /* if this urb had a transfer buffer already (old transfer) free it */
1418         if (urb->transfer_buffer != NULL) {
1419                 kfree(urb->transfer_buffer);
1420                 urb->transfer_buffer = NULL;
1421         }
1422
1423         /* build the data header for the buffer and port that we are about to send out */
1424         count = fifo->count;
1425         buffer = kmalloc (count+2, GFP_ATOMIC);
1426         if (buffer == NULL) {
1427                 dev_err(&edge_serial->serial->dev->dev, "%s - no more kernel memory...\n", __FUNCTION__);
1428                 edge_port->write_in_progress = FALSE;
1429                 return;
1430         }
1431         buffer[0] = IOSP_BUILD_DATA_HDR1 (edge_port->port->number - edge_port->port->serial->minor, count);
1432         buffer[1] = IOSP_BUILD_DATA_HDR2 (edge_port->port->number - edge_port->port->serial->minor, count);
1433
1434         /* now copy our data */
1435         bytesleft =  fifo->size - fifo->tail;
1436         firsthalf = min (bytesleft, count);
1437         memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1438         fifo->tail  += firsthalf;
1439         fifo->count -= firsthalf;
1440         if (fifo->tail == fifo->size) {
1441                 fifo->tail = 0;
1442         }
1443
1444         secondhalf = count-firsthalf;
1445         if (secondhalf) {
1446                 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail], secondhalf);
1447                 fifo->tail  += secondhalf;
1448                 fifo->count -= secondhalf;
1449         }
1450
1451         if (count) {
1452                 usb_serial_debug_data (__FILE__, __FUNCTION__, count, &buffer[2]);
1453         }
1454
1455         /* fill up the urb with all of our data and submit it */
1456         usb_fill_bulk_urb (urb, edge_serial->serial->dev,
1457                        usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
1458                        buffer, count+2, edge_bulk_out_data_callback, edge_port);
1459
1460         /* decrement the number of credits we have by the number we just sent */
1461         edge_port->txCredits -= count;
1462         edge_port->icount.tx += count;
1463
1464         urb->dev = edge_serial->serial->dev;
1465         status = usb_submit_urb(urb, GFP_ATOMIC);
1466         if (status) {
1467                 /* something went wrong */
1468                 dbg("%s - usb_submit_urb(write bulk) failed", __FUNCTION__);
1469                 edge_port->write_in_progress = FALSE;
1470
1471                 /* revert the credits as something bad happened. */
1472                 edge_port->txCredits += count;
1473                 edge_port->icount.tx -= count;
1474         }
1475         dbg("%s wrote %d byte(s) TxCredit %d, Fifo %d", __FUNCTION__, count, edge_port->txCredits, fifo->count);
1476 }
1477
1478
1479 /*****************************************************************************
1480  * edge_write_room
1481  *      this function is called by the tty driver when it wants to know how many
1482  *      bytes of data we can accept for a specific port.
1483  *      If successful, we return the amount of room that we have for this port
1484  *      (the txCredits),
1485  *      Otherwise we return a negative error number.
1486  *****************************************************************************/
1487 static int edge_write_room (struct usb_serial_port *port)
1488 {
1489         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1490         int room;
1491
1492         dbg("%s", __FUNCTION__);
1493
1494         if (edge_port == NULL)
1495                 return -ENODEV;
1496         if (edge_port->closePending == TRUE)
1497                 return -ENODEV;
1498
1499         dbg("%s - port %d", __FUNCTION__, port->number);
1500
1501         if (!edge_port->open) {
1502                 dbg("%s - port not opened", __FUNCTION__);
1503                 return -EINVAL;
1504         }
1505
1506         // total of both buffers is still txCredit
1507         room = edge_port->txCredits - edge_port->txfifo.count;
1508
1509         dbg("%s - returns %d", __FUNCTION__, room);
1510         return room;
1511 }
1512
1513
1514 /*****************************************************************************
1515  * edge_chars_in_buffer
1516  *      this function is called by the tty driver when it wants to know how many
1517  *      bytes of data we currently have outstanding in the port (data that has
1518  *      been written, but hasn't made it out the port yet)
1519  *      If successful, we return the number of bytes left to be written in the
1520  *      system,
1521  *      Otherwise we return a negative error number.
1522  *****************************************************************************/
1523 static int edge_chars_in_buffer (struct usb_serial_port *port)
1524 {
1525         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1526         int num_chars;
1527
1528         dbg("%s", __FUNCTION__);
1529
1530         if (edge_port == NULL)
1531                 return -ENODEV;
1532         if (edge_port->closePending == TRUE)
1533                 return -ENODEV;
1534
1535         if (!edge_port->open) {
1536                 dbg("%s - port not opened", __FUNCTION__);
1537                 return -EINVAL;
1538         }
1539
1540         num_chars = edge_port->maxTxCredits - edge_port->txCredits + edge_port->txfifo.count;
1541         if (num_chars) {
1542                 dbg("%s(port %d) - returns %d", __FUNCTION__, port->number, num_chars);
1543         }
1544
1545         return num_chars;
1546 }
1547
1548
1549 /*****************************************************************************
1550  * SerialThrottle
1551  *      this function is called by the tty driver when it wants to stop the data
1552  *      being read from the port.
1553  *****************************************************************************/
1554 static void edge_throttle (struct usb_serial_port *port)
1555 {
1556         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1557         struct tty_struct *tty;
1558         int status;
1559
1560         dbg("%s - port %d", __FUNCTION__, port->number);
1561
1562         if (edge_port == NULL)
1563                 return;
1564
1565         if (!edge_port->open) {
1566                 dbg("%s - port not opened", __FUNCTION__);
1567                 return;
1568         }
1569
1570         tty = port->tty;
1571         if (!tty) {
1572                 dbg ("%s - no tty available", __FUNCTION__);
1573                 return;
1574         }
1575
1576         /* if we are implementing XON/XOFF, send the stop character */
1577         if (I_IXOFF(tty)) {
1578                 unsigned char stop_char = STOP_CHAR(tty);
1579                 status = edge_write (port, 0, &stop_char, 1);
1580                 if (status <= 0) {
1581                         return;
1582                 }
1583         }
1584
1585         /* if we are implementing RTS/CTS, toggle that line */
1586         if (tty->termios->c_cflag & CRTSCTS) {
1587                 edge_port->shadowMCR &= ~MCR_RTS;
1588                 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1589                 if (status != 0) {
1590                         return;
1591                 }
1592         }
1593
1594         return;
1595 }
1596
1597
1598 /*****************************************************************************
1599  * edge_unthrottle
1600  *      this function is called by the tty driver when it wants to resume the data
1601  *      being read from the port (called after SerialThrottle is called)
1602  *****************************************************************************/
1603 static void edge_unthrottle (struct usb_serial_port *port)
1604 {
1605         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1606         struct tty_struct *tty;
1607         int status;
1608
1609         dbg("%s - port %d", __FUNCTION__, port->number);
1610
1611         if (edge_port == NULL)
1612                 return;
1613
1614         if (!edge_port->open) {
1615                 dbg("%s - port not opened", __FUNCTION__);
1616                 return;
1617         }
1618
1619         tty = port->tty;
1620         if (!tty) {
1621                 dbg ("%s - no tty available", __FUNCTION__);
1622                 return;
1623         }
1624
1625         /* if we are implementing XON/XOFF, send the start character */
1626         if (I_IXOFF(tty)) {
1627                 unsigned char start_char = START_CHAR(tty);
1628                 status = edge_write (port, 0, &start_char, 1);
1629                 if (status <= 0) {
1630                         return;
1631                 }
1632         }
1633
1634         /* if we are implementing RTS/CTS, toggle that line */
1635         if (tty->termios->c_cflag & CRTSCTS) {
1636                 edge_port->shadowMCR |= MCR_RTS;
1637                 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1638                 if (status != 0) {
1639                         return;
1640                 }
1641         }
1642
1643         return;
1644 }
1645
1646
1647 /*****************************************************************************
1648  * SerialSetTermios
1649  *      this function is called by the tty driver when it wants to change the termios structure
1650  *****************************************************************************/
1651 static void edge_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1652 {
1653         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1654         struct tty_struct *tty = port->tty;
1655         unsigned int cflag;
1656
1657         if (!port->tty || !port->tty->termios) {
1658                 dbg ("%s - no tty or termios", __FUNCTION__);
1659                 return;
1660         }
1661
1662         cflag = tty->termios->c_cflag;
1663         /* check that they really want us to change something */
1664         if (old_termios) {
1665                 if ((cflag == old_termios->c_cflag) &&
1666                     (RELEVANT_IFLAG(tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
1667                         dbg("%s - nothing to change", __FUNCTION__);
1668                         return;
1669                 }
1670         }
1671
1672         dbg("%s - clfag %08x iflag %08x", __FUNCTION__,
1673             tty->termios->c_cflag,
1674             RELEVANT_IFLAG(tty->termios->c_iflag));
1675         if (old_termios) {
1676                 dbg("%s - old clfag %08x old iflag %08x", __FUNCTION__,
1677                     old_termios->c_cflag,
1678                     RELEVANT_IFLAG(old_termios->c_iflag));
1679         }
1680
1681         dbg("%s - port %d", __FUNCTION__, port->number);
1682
1683         if (edge_port == NULL)
1684                 return;
1685
1686         if (!edge_port->open) {
1687                 dbg("%s - port not opened", __FUNCTION__);
1688                 return;
1689         }
1690
1691         /* change the port settings to the new ones specified */
1692         change_port_settings (edge_port, old_termios);
1693
1694         return;
1695 }
1696
1697
1698 /*****************************************************************************
1699  * get_lsr_info - get line status register info
1700  *
1701  * Purpose: Let user call ioctl() to get info when the UART physically
1702  *          is emptied.  On bus types like RS485, the transmitter must
1703  *          release the bus after transmitting. This must be done when
1704  *          the transmit shift register is empty, not be done when the
1705  *          transmit holding register is empty.  This functionality
1706  *          allows an RS485 driver to be written in user space.
1707  *****************************************************************************/
1708 static int get_lsr_info(struct edgeport_port *edge_port, unsigned int *value)
1709 {
1710         unsigned int result = 0;
1711
1712         if (edge_port->maxTxCredits == edge_port->txCredits &&
1713             edge_port->txfifo.count == 0) {
1714                 dbg("%s -- Empty", __FUNCTION__);
1715                 result = TIOCSER_TEMT;
1716         }
1717
1718         if (copy_to_user(value, &result, sizeof(int)))
1719                 return -EFAULT;
1720         return 0;
1721 }
1722
1723 static int get_number_bytes_avail(struct edgeport_port *edge_port, unsigned int *value)
1724 {
1725         unsigned int result = 0;
1726         struct tty_struct *tty = edge_port->port->tty;
1727
1728         if (!tty)
1729                 return -ENOIOCTLCMD;
1730
1731         result = tty->read_cnt;
1732
1733         dbg("%s(%d) = %d", __FUNCTION__,  edge_port->port->number, result);
1734         if (copy_to_user(value, &result, sizeof(int)))
1735                 return -EFAULT;
1736         //return 0;
1737         return -ENOIOCTLCMD;
1738 }
1739
1740 static int edge_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear)
1741 {
1742         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1743         unsigned int mcr;
1744
1745         dbg("%s - port %d", __FUNCTION__, port->number);
1746
1747         mcr = edge_port->shadowMCR;
1748         if (set & TIOCM_RTS)
1749                 mcr |= MCR_RTS;
1750         if (set & TIOCM_DTR)
1751                 mcr |= MCR_DTR;
1752         if (set & TIOCM_LOOP)
1753                 mcr |= MCR_LOOPBACK;
1754
1755         if (clear & TIOCM_RTS)
1756                 mcr &= ~MCR_RTS;
1757         if (clear & TIOCM_DTR)
1758                 mcr &= ~MCR_DTR;
1759         if (clear & TIOCM_LOOP)
1760                 mcr &= ~MCR_LOOPBACK;
1761
1762         edge_port->shadowMCR = mcr;
1763
1764         send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1765
1766         return 0;
1767 }
1768
1769 static int edge_tiocmget(struct usb_serial_port *port, struct file *file)
1770 {
1771         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1772         unsigned int result = 0;
1773         unsigned int msr;
1774         unsigned int mcr;
1775
1776         dbg("%s - port %d", __FUNCTION__, port->number);
1777
1778         msr = edge_port->shadowMSR;
1779         mcr = edge_port->shadowMCR;
1780         result = ((mcr & MCR_DTR)       ? TIOCM_DTR: 0)   /* 0x002 */
1781                   | ((mcr & MCR_RTS)    ? TIOCM_RTS: 0)   /* 0x004 */
1782                   | ((msr & EDGEPORT_MSR_CTS)   ? TIOCM_CTS: 0)   /* 0x020 */
1783                   | ((msr & EDGEPORT_MSR_CD)    ? TIOCM_CAR: 0)   /* 0x040 */
1784                   | ((msr & EDGEPORT_MSR_RI)    ? TIOCM_RI:  0)   /* 0x080 */
1785                   | ((msr & EDGEPORT_MSR_DSR)   ? TIOCM_DSR: 0);  /* 0x100 */
1786
1787
1788         dbg("%s -- %x", __FUNCTION__, result);
1789
1790         return result;
1791 }
1792
1793 static int get_serial_info(struct edgeport_port *edge_port, struct serial_struct * retinfo)
1794 {
1795         struct serial_struct tmp;
1796
1797         if (!retinfo)
1798                 return -EFAULT;
1799
1800         memset(&tmp, 0, sizeof(tmp));
1801
1802         tmp.type                = PORT_16550A;
1803         tmp.line                = edge_port->port->serial->minor;
1804         tmp.port                = edge_port->port->number;
1805         tmp.irq                 = 0;
1806         tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1807         tmp.xmit_fifo_size      = edge_port->maxTxCredits;
1808         tmp.baud_base           = 9600;
1809         tmp.close_delay         = 5*HZ;
1810         tmp.closing_wait        = 30*HZ;
1811 //      tmp.custom_divisor      = state->custom_divisor;
1812 //      tmp.hub6                = state->hub6;
1813 //      tmp.io_type             = state->io_type;
1814
1815
1816         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1817                 return -EFAULT;
1818         return 0;
1819 }
1820
1821
1822
1823 /*****************************************************************************
1824  * SerialIoctl
1825  *      this function handles any ioctl calls to the driver
1826  *****************************************************************************/
1827 static int edge_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
1828 {
1829         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1830         struct async_icount cnow;
1831         struct async_icount cprev;
1832         struct serial_icounter_struct icount;
1833
1834
1835         dbg("%s - port %d, cmd = 0x%x", __FUNCTION__, port->number, cmd);
1836
1837         switch (cmd) {
1838                 // return number of bytes available
1839                 case TIOCINQ:
1840                         dbg("%s (%d) TIOCINQ", __FUNCTION__,  port->number);
1841                         return get_number_bytes_avail(edge_port, (unsigned int *) arg);
1842                         break;
1843
1844                 case TIOCSERGETLSR:
1845                         dbg("%s (%d) TIOCSERGETLSR", __FUNCTION__,  port->number);
1846                         return get_lsr_info(edge_port, (unsigned int *) arg);
1847                         return 0;
1848
1849                 case TIOCGSERIAL:
1850                         dbg("%s (%d) TIOCGSERIAL", __FUNCTION__,  port->number);
1851                         return get_serial_info(edge_port, (struct serial_struct *) arg);
1852
1853                 case TIOCSSERIAL:
1854                         dbg("%s (%d) TIOCSSERIAL", __FUNCTION__,  port->number);
1855                         break;
1856
1857                 case TIOCMIWAIT:
1858                         dbg("%s (%d) TIOCMIWAIT", __FUNCTION__,  port->number);
1859                         cprev = edge_port->icount;
1860                         while (1) {
1861                                 interruptible_sleep_on(&edge_port->delta_msr_wait);
1862                                 /* see if a signal did it */
1863                                 if (signal_pending(current))
1864                                         return -ERESTARTSYS;
1865                                 cnow = edge_port->icount;
1866                                 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1867                                     cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1868                                         return -EIO; /* no change => error */
1869                                 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1870                                     ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1871                                     ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
1872                                     ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts)) ) {
1873                                         return 0;
1874                                 }
1875                                 cprev = cnow;
1876                         }
1877                         /* NOTREACHED */
1878                         break;
1879
1880                 case TIOCGICOUNT:
1881                         cnow = edge_port->icount;
1882                         memset(&icount, 0, sizeof(icount));
1883                         icount.cts = cnow.cts;
1884                         icount.dsr = cnow.dsr;
1885                         icount.rng = cnow.rng;
1886                         icount.dcd = cnow.dcd;
1887                         icount.rx = cnow.rx;
1888                         icount.tx = cnow.tx;
1889                         icount.frame = cnow.frame;
1890                         icount.overrun = cnow.overrun;
1891                         icount.parity = cnow.parity;
1892                         icount.brk = cnow.brk;
1893                         icount.buf_overrun = cnow.buf_overrun;
1894
1895                         dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d", __FUNCTION__,  port->number, icount.rx, icount.tx );
1896                         if (copy_to_user((void *)arg, &icount, sizeof(icount)))
1897                                 return -EFAULT;
1898                         return 0;
1899         }
1900
1901         return -ENOIOCTLCMD;
1902 }
1903
1904
1905 /*****************************************************************************
1906  * SerialBreak
1907  *      this function sends a break to the port
1908  *****************************************************************************/
1909 static void edge_break (struct usb_serial_port *port, int break_state)
1910 {
1911         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1912         int status;
1913
1914         /* flush and chase */
1915         edge_port->chaseResponsePending = TRUE;
1916
1917         dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1918         status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1919         if (status == 0) {
1920                 // block until chase finished
1921                 block_until_chase_response(edge_port);
1922         } else {
1923                 edge_port->chaseResponsePending = FALSE;
1924         }
1925
1926         if (break_state == -1) {
1927                 dbg("%s - Sending IOSP_CMD_SET_BREAK", __FUNCTION__);
1928                 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_BREAK, 0);
1929         } else {
1930                 dbg("%s - Sending IOSP_CMD_CLEAR_BREAK", __FUNCTION__);
1931                 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CLEAR_BREAK, 0);
1932         }
1933         if (status) {
1934                 dbg("%s - error sending break set/clear command.", __FUNCTION__);
1935         }
1936
1937         return;
1938 }
1939
1940
1941 /*****************************************************************************
1942  * process_rcvd_data
1943  *      this function handles the data received on the bulk in pipe.
1944  *****************************************************************************/
1945 static int process_rcvd_data (struct edgeport_serial *edge_serial, unsigned char * buffer, __u16 bufferLength)
1946 {
1947         struct usb_serial_port *port;
1948         struct edgeport_port *edge_port;
1949         struct tty_struct *tty;
1950         __u16 lastBufferLength;
1951         __u16 rxLen;
1952         int i;
1953
1954         dbg("%s", __FUNCTION__);
1955
1956         lastBufferLength = bufferLength + 1;
1957
1958         while (bufferLength > 0) {
1959                 /* failsafe incase we get a message that we don't understand */
1960                 if (lastBufferLength == bufferLength) {
1961                         dbg("%s - stuck in loop, exiting it.", __FUNCTION__);
1962                         break;
1963                 }
1964                 lastBufferLength = bufferLength;
1965
1966                 switch (edge_serial->rxState) {
1967                         case EXPECT_HDR1:
1968                                 edge_serial->rxHeader1 = *buffer;
1969                                 ++buffer;
1970                                 --bufferLength;
1971
1972                                 if (bufferLength == 0) {
1973                                         edge_serial->rxState = EXPECT_HDR2;
1974                                         break;
1975                                 }
1976                                 /* otherwise, drop on through */
1977
1978                         case EXPECT_HDR2:
1979                                 edge_serial->rxHeader2 = *buffer;
1980                                 ++buffer;
1981                                 --bufferLength;
1982
1983                                 dbg("%s - Hdr1=%02X Hdr2=%02X", __FUNCTION__, edge_serial->rxHeader1, edge_serial->rxHeader2);
1984
1985                                 // Process depending on whether this header is
1986                                 // data or status
1987
1988                                 if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
1989                                         // Decode this status header and goto EXPECT_HDR1 (if we
1990                                         // can process the status with only 2 bytes), or goto
1991                                         // EXPECT_HDR3 to get the third byte.
1992
1993                                         edge_serial->rxPort       = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1994                                         edge_serial->rxStatusCode = IOSP_GET_STATUS_CODE(edge_serial->rxHeader1);
1995
1996                                         if (!IOSP_STATUS_IS_2BYTE(edge_serial->rxStatusCode)) {
1997                                                 // This status needs additional bytes. Save what we have
1998                                                 // and then wait for more data.
1999                                                 edge_serial->rxStatusParam = edge_serial->rxHeader2;
2000
2001                                                 edge_serial->rxState = EXPECT_HDR3;
2002                                                 break;
2003                                         }
2004
2005                                         // We have all the header bytes, process the status now
2006                                         process_rcvd_status (edge_serial, edge_serial->rxHeader2, 0);
2007
2008                                         edge_serial->rxState = EXPECT_HDR1;
2009                                         break;
2010                                 } else {
2011                                         edge_serial->rxPort = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
2012                                         edge_serial->rxBytesRemaining = IOSP_GET_HDR_DATA_LEN(edge_serial->rxHeader1, edge_serial->rxHeader2);
2013
2014                                         dbg("%s - Data for Port %u Len %u", __FUNCTION__, edge_serial->rxPort, edge_serial->rxBytesRemaining);
2015
2016                                         //ASSERT( DevExt->RxPort < DevExt->NumPorts );
2017                                         //ASSERT( DevExt->RxBytesRemaining < IOSP_MAX_DATA_LENGTH );
2018
2019                                         if (bufferLength == 0 ) {
2020                                                 edge_serial->rxState = EXPECT_DATA;
2021                                                 break;
2022                                         }
2023                                         // Else, drop through
2024                                 }
2025
2026                         case EXPECT_DATA:       // Expect data
2027
2028                                 if (bufferLength < edge_serial->rxBytesRemaining) {
2029                                         rxLen = bufferLength;
2030                                         edge_serial->rxState = EXPECT_DATA;     // Expect data to start next buffer
2031                                 } else {
2032                                         // BufLen >= RxBytesRemaining
2033                                         rxLen = edge_serial->rxBytesRemaining;
2034                                         edge_serial->rxState = EXPECT_HDR1;     // Start another header next time
2035                                 }
2036
2037                                 bufferLength -= rxLen;
2038                                 edge_serial->rxBytesRemaining -= rxLen;
2039
2040                                 /* spit this data back into the tty driver if this port is open */
2041                                 if (rxLen) {
2042                                         port = edge_serial->serial->port[edge_serial->rxPort];
2043                                         edge_port = usb_get_serial_port_data(port);
2044                                         if (edge_port->open) {
2045                                                 tty = edge_port->port->tty;
2046                                                 if (tty) {
2047                                                         dbg("%s - Sending %d bytes to TTY for port %d", __FUNCTION__, rxLen, edge_serial->rxPort);
2048                                                         for (i = 0; i < rxLen ; ++i) {
2049                                                                 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
2050                                                                 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
2051                                                                         tty_flip_buffer_push(tty);
2052                                                                 }
2053                                                                 /* this doesn't actually push the data through unless tty->low_latency is set */
2054                                                                 tty_insert_flip_char(tty, buffer[i], 0);
2055                                                         }
2056                                                         tty_flip_buffer_push(tty);
2057                                                 }
2058                                                 edge_port->icount.rx += rxLen;
2059                                         }
2060                                         buffer += rxLen;
2061                                 }
2062
2063                                 break;
2064
2065                         case EXPECT_HDR3:                       // Expect 3rd byte of status header
2066                                 edge_serial->rxHeader3 = *buffer;
2067                                 ++buffer;
2068                                 --bufferLength;
2069
2070                                 // We have all the header bytes, process the status now
2071                                 process_rcvd_status (edge_serial, edge_serial->rxStatusParam, edge_serial->rxHeader3);
2072                                 edge_serial->rxState = EXPECT_HDR1;
2073                                 break;
2074
2075                 }
2076         }
2077
2078         return 0;
2079 }
2080
2081
2082 /*****************************************************************************
2083  * process_rcvd_status
2084  *      this function handles the any status messages received on the bulk in pipe.
2085  *****************************************************************************/
2086 static void process_rcvd_status (struct edgeport_serial *edge_serial, __u8 byte2, __u8 byte3)
2087 {
2088         struct usb_serial_port *port;
2089         struct edgeport_port *edge_port;
2090         __u8 code = edge_serial->rxStatusCode;
2091
2092         /* switch the port pointer to the one being currently talked about */
2093         port = edge_serial->serial->port[edge_serial->rxPort];
2094         edge_port = usb_get_serial_port_data(port);
2095         if (edge_port == NULL) {
2096                 dev_err(&edge_serial->serial->dev->dev, "%s - edge_port == NULL for port %d\n", __FUNCTION__, edge_serial->rxPort);
2097                 return;
2098         }
2099
2100         dbg("%s - port %d", __FUNCTION__, edge_serial->rxPort);
2101
2102         if (code == IOSP_EXT_STATUS) {
2103                 switch (byte2) {
2104                         case IOSP_EXT_STATUS_CHASE_RSP:
2105                                 // we want to do EXT status regardless of port open/closed
2106                                 dbg("%s - Port %u EXT CHASE_RSP Data = %02x", __FUNCTION__, edge_serial->rxPort, byte3 );
2107                                 // Currently, the only EXT_STATUS is Chase, so process here instead of one more call
2108                                 // to one more subroutine. If/when more EXT_STATUS, there'll be more work to do.
2109                                 // Also, we currently clear flag and close the port regardless of content of above's Byte3.
2110                                 // We could choose to do something else when Byte3 says Timeout on Chase from Edgeport,
2111                                 // like wait longer in block_until_chase_response, but for now we don't.
2112                                 edge_port->chaseResponsePending = FALSE;
2113                                 wake_up_interruptible (&edge_port->wait_chase);
2114                                 return;
2115
2116                         case IOSP_EXT_STATUS_RX_CHECK_RSP:
2117                                 dbg("%s ========== Port %u CHECK_RSP Sequence = %02x =============\n", __FUNCTION__, edge_serial->rxPort, byte3 );
2118                                 //Port->RxCheckRsp = TRUE;
2119                                 return;
2120                 }
2121         }
2122
2123         if (code == IOSP_STATUS_OPEN_RSP) {
2124                 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
2125                 edge_port->maxTxCredits = edge_port->txCredits;
2126                 dbg("%s - Port %u Open Response Inital MSR = %02x TxBufferSize = %d", __FUNCTION__, edge_serial->rxPort, byte2, edge_port->txCredits);
2127                 handle_new_msr (edge_port, byte2);
2128
2129                 /* send the current line settings to the port so we are in sync with any further termios calls */
2130                 if (edge_port->port->tty)
2131                         change_port_settings (edge_port, edge_port->port->tty->termios);
2132
2133                 /* we have completed the open */
2134                 edge_port->openPending = FALSE;
2135                 edge_port->open = TRUE;
2136                 wake_up_interruptible(&edge_port->wait_open);
2137                 return;
2138         }
2139
2140         // If port is closed, silently discard all rcvd status. We can
2141         // have cases where buffered status is received AFTER the close
2142         // port command is sent to the Edgeport.
2143         if ((!edge_port->open ) || (edge_port->closePending)) {
2144                 return;
2145         }
2146
2147         switch (code) {
2148                 // Not currently sent by Edgeport
2149                 case IOSP_STATUS_LSR:
2150                         dbg("%s - Port %u LSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
2151                         handle_new_lsr (edge_port, FALSE, byte2, 0);
2152                         break;
2153
2154                 case IOSP_STATUS_LSR_DATA:
2155                         dbg("%s - Port %u LSR Status = %02x, Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
2156                         // byte2 is LSR Register
2157                         // byte3 is broken data byte
2158                         handle_new_lsr (edge_port, TRUE, byte2, byte3);
2159                         break;
2160                         //
2161                         //      case IOSP_EXT_4_STATUS:
2162                         //              dbg("%s - Port %u LSR Status = %02x Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
2163                         //              break;
2164                         //
2165                 case IOSP_STATUS_MSR:
2166                         dbg("%s - Port %u MSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
2167
2168                         // Process this new modem status and generate appropriate
2169                         // events, etc, based on the new status. This routine
2170                         // also saves the MSR in Port->ShadowMsr.
2171                         handle_new_msr(edge_port, byte2);
2172                         break;
2173
2174                 default:
2175                         dbg("%s - Unrecognized IOSP status code %u\n", __FUNCTION__, code);
2176                         break;
2177         }
2178
2179         return;
2180 }
2181
2182
2183 /*****************************************************************************
2184  * handle_new_msr
2185  *      this function handles any change to the msr register for a port.
2186  *****************************************************************************/
2187 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
2188 {
2189         struct  async_icount *icount;
2190
2191         dbg("%s %02x", __FUNCTION__, newMsr);
2192
2193         if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR | EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
2194                 icount = &edge_port->icount;
2195
2196                 /* update input line counters */
2197                 if (newMsr & EDGEPORT_MSR_DELTA_CTS) {
2198                         icount->cts++;
2199                 }
2200                 if (newMsr & EDGEPORT_MSR_DELTA_DSR) {
2201                         icount->dsr++;
2202                 }
2203                 if (newMsr & EDGEPORT_MSR_DELTA_CD) {
2204                         icount->dcd++;
2205                 }
2206                 if (newMsr & EDGEPORT_MSR_DELTA_RI) {
2207                         icount->rng++;
2208                 }
2209                 wake_up_interruptible(&edge_port->delta_msr_wait);
2210         }
2211
2212         /* Save the new modem status */
2213         edge_port->shadowMSR = newMsr & 0xf0;
2214
2215         return;
2216 }
2217
2218
2219 /*****************************************************************************
2220  * handle_new_lsr
2221  *      this function handles any change to the lsr register for a port.
2222  *****************************************************************************/
2223 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData, __u8 lsr, __u8 data)
2224 {
2225         __u8    newLsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
2226         struct  async_icount *icount;
2227
2228         dbg("%s - %02x", __FUNCTION__, newLsr);
2229
2230         edge_port->shadowLSR = lsr;
2231
2232         if (newLsr & LSR_BREAK) {
2233                 //
2234                 // Parity and Framing errors only count if they
2235                 // occur exclusive of a break being
2236                 // received.
2237                 //
2238                 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
2239         }
2240
2241         /* Place LSR data byte into Rx buffer */
2242         if (lsrData && edge_port->port->tty) {
2243                 tty_insert_flip_char(edge_port->port->tty, data, 0);
2244                 tty_flip_buffer_push(edge_port->port->tty);
2245         }
2246
2247         /* update input line counters */
2248         icount = &edge_port->icount;
2249         if (newLsr & LSR_BREAK) {
2250                 icount->brk++;
2251         }
2252         if (newLsr & LSR_OVER_ERR) {
2253                 icount->overrun++;
2254         }
2255         if (newLsr & LSR_PAR_ERR) {
2256                 icount->parity++;
2257         }
2258         if (newLsr & LSR_FRM_ERR) {
2259                 icount->frame++;
2260         }
2261
2262         return;
2263 }
2264
2265
2266 /****************************************************************************
2267  * sram_write
2268  *      writes a number of bytes to the Edgeport device's sram starting at the
2269  *      given address.
2270  *      If successful returns the number of bytes written, otherwise it returns
2271  *      a negative error number of the problem.
2272  ****************************************************************************/
2273 static int sram_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2274 {
2275         int result;
2276         __u16 current_length;
2277         unsigned char *transfer_buffer;
2278
2279         dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2280
2281         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2282         if (!transfer_buffer) {
2283                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2284                 return -ENOMEM;
2285         }
2286
2287         /* need to split these writes up into 64 byte chunks */
2288         result = 0;
2289         while (length > 0) {
2290                 if (length > 64) {
2291                         current_length = 64;
2292                 } else {
2293                         current_length = length;
2294                 }
2295 //              dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2296                 memcpy (transfer_buffer, data, current_length);
2297                 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_RAM,
2298                                           0x40, addr, extAddr, transfer_buffer, current_length, 300);
2299                 if (result < 0)
2300                         break;
2301                 length -= current_length;
2302                 addr += current_length;
2303                 data += current_length;
2304         }
2305
2306         kfree (transfer_buffer);
2307         return result;
2308 }
2309
2310
2311 /****************************************************************************
2312  * rom_write
2313  *      writes a number of bytes to the Edgeport device's ROM starting at the
2314  *      given address.
2315  *      If successful returns the number of bytes written, otherwise it returns
2316  *      a negative error number of the problem.
2317  ****************************************************************************/
2318 static int rom_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2319 {
2320         int result;
2321         __u16 current_length;
2322         unsigned char *transfer_buffer;
2323
2324 //      dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2325
2326         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2327         if (!transfer_buffer) {
2328                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2329                 return -ENOMEM;
2330         }
2331
2332         /* need to split these writes up into 64 byte chunks */
2333         result = 0;
2334         while (length > 0) {
2335                 if (length > 64) {
2336                         current_length = 64;
2337                 } else {
2338                         current_length = length;
2339                 }
2340 //              dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2341                 memcpy (transfer_buffer, data, current_length);
2342                 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_ROM,
2343                                           0x40, addr, extAddr, transfer_buffer, current_length, 300);
2344                 if (result < 0)
2345                         break;
2346                 length -= current_length;
2347                 addr += current_length;
2348                 data += current_length;
2349         }
2350
2351         kfree (transfer_buffer);
2352         return result;
2353 }
2354
2355
2356 /****************************************************************************
2357  * rom_read
2358  *      reads a number of bytes from the Edgeport device starting at the given
2359  *      address.
2360  *      If successful returns the number of bytes read, otherwise it returns
2361  *      a negative error number of the problem.
2362  ****************************************************************************/
2363 static int rom_read (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2364 {
2365         int result;
2366         __u16 current_length;
2367         unsigned char *transfer_buffer;
2368
2369         dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2370
2371         transfer_buffer =  kmalloc (64, GFP_KERNEL);
2372         if (!transfer_buffer) {
2373                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2374                 return -ENOMEM;
2375         }
2376
2377         /* need to split these reads up into 64 byte chunks */
2378         result = 0;
2379         while (length > 0) {
2380                 if (length > 64) {
2381                         current_length = 64;
2382                 } else {
2383                         current_length = length;
2384                 }
2385 //              dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2386                 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0), USB_REQUEST_ION_READ_ROM,
2387                                           0xC0, addr, extAddr, transfer_buffer, current_length, 300);
2388                 if (result < 0)
2389                         break;
2390                 memcpy (data, transfer_buffer, current_length);
2391                 length -= current_length;
2392                 addr += current_length;
2393                 data += current_length;
2394         }
2395
2396         kfree (transfer_buffer);
2397         return result;
2398 }
2399
2400
2401 /****************************************************************************
2402  * send_iosp_ext_cmd
2403  *      Is used to send a IOSP message to the Edgeport device
2404  ****************************************************************************/
2405 static int send_iosp_ext_cmd (struct edgeport_port *edge_port, __u8 command, __u8 param)
2406 {
2407         unsigned char   *buffer;
2408         unsigned char   *currentCommand;
2409         int             length = 0;
2410         int             status = 0;
2411
2412         dbg("%s - %d, %d", __FUNCTION__, command, param);
2413
2414         buffer =  kmalloc (10, GFP_ATOMIC);
2415         if (!buffer) {
2416                 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 10);
2417                 return -ENOMEM;
2418         }
2419
2420         currentCommand = buffer;
2421
2422         MAKE_CMD_EXT_CMD (&currentCommand, &length,
2423                           edge_port->port->number - edge_port->port->serial->minor,
2424                           command, param);
2425
2426         status = write_cmd_usb (edge_port, buffer, length);
2427         if (status) {
2428                 /* something bad happened, let's free up the memory */
2429                 kfree(buffer);
2430         }
2431
2432         return status;
2433 }
2434
2435
2436 /*****************************************************************************
2437  * write_cmd_usb
2438  *      this function writes the given buffer out to the bulk write endpoint.
2439  *****************************************************************************/
2440 static int write_cmd_usb (struct edgeport_port *edge_port, unsigned char *buffer, int length)
2441 {
2442         struct edgeport_serial *edge_serial = usb_get_serial_data(edge_port->port->serial);
2443         int status = 0;
2444         struct urb *urb;
2445         int timeout;
2446
2447         usb_serial_debug_data (__FILE__, __FUNCTION__, length, buffer);
2448
2449         /* Allocate our next urb */
2450         urb = usb_alloc_urb (0, GFP_ATOMIC);
2451         if (!urb)
2452                 return -ENOMEM;
2453
2454         CmdUrbs++;
2455         dbg("%s - ALLOCATE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
2456
2457         usb_fill_bulk_urb (urb, edge_serial->serial->dev,
2458                        usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
2459                        buffer, length, edge_bulk_out_cmd_callback, edge_port);
2460
2461         edge_port->commandPending = TRUE;
2462         status = usb_submit_urb(urb, GFP_ATOMIC);
2463
2464         if (status) {
2465                 /* something went wrong */
2466                 dbg("%s - usb_submit_urb(write bulk) failed", __FUNCTION__);
2467                 usb_unlink_urb (urb);
2468                 usb_free_urb   (urb);
2469                 return status;
2470         }
2471
2472         // wait for command to finish
2473         timeout = COMMAND_TIMEOUT;
2474 #if 0
2475         while (timeout && edge_port->commandPending == TRUE) {
2476                 timeout = interruptible_sleep_on_timeout (&edge_port->wait_command, timeout);
2477         }
2478
2479         if (edge_port->commandPending == TRUE) {
2480                 /* command timed out */
2481                 dbg("%s - command timed out", __FUNCTION__);
2482                 status = -EINVAL;
2483         }
2484 #endif
2485         return status;
2486 }
2487
2488
2489 /*****************************************************************************
2490  * send_cmd_write_baud_rate
2491  *      this function sends the proper command to change the baud rate of the
2492  *      specified port.
2493  *****************************************************************************/
2494 static int send_cmd_write_baud_rate (struct edgeport_port *edge_port, int baudRate)
2495 {
2496         unsigned char *cmdBuffer;
2497         unsigned char *currCmd;
2498         int cmdLen = 0;
2499         int divisor;
2500         int status;
2501         unsigned char number = edge_port->port->number - edge_port->port->serial->minor;
2502
2503         dbg("%s - port = %d, baud = %d", __FUNCTION__, edge_port->port->number, baudRate);
2504
2505         status = calc_baud_rate_divisor (baudRate, &divisor);
2506         if (status) {
2507                 dev_err(&edge_port->port->dev, "%s - bad baud rate\n", __FUNCTION__);
2508                 return status;
2509         }
2510
2511         // Alloc memory for the string of commands.
2512         cmdBuffer =  kmalloc (0x100, GFP_ATOMIC);
2513         if (!cmdBuffer) {
2514                 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 0x100);
2515                 return -ENOMEM;
2516         }
2517         currCmd = cmdBuffer;
2518
2519         // Enable access to divisor latch
2520         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE );
2521
2522         // Write the divisor itself
2523         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLL, LOW8 (divisor) );
2524         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLM, HIGH8(divisor) );
2525
2526         // Restore original value to disable access to divisor latch
2527         MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, edge_port->shadowLCR);
2528
2529         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen );
2530         if (status) {
2531                 /* something bad happened, let's free up the memory */
2532                 kfree (cmdBuffer);
2533         }
2534
2535         return status;
2536 }
2537
2538
2539 /*****************************************************************************
2540  * calc_baud_rate_divisor
2541  *      this function calculates the proper baud rate divisor for the specified
2542  *      baud rate.
2543  *****************************************************************************/
2544 static int calc_baud_rate_divisor (int baudrate, int *divisor)
2545 {
2546         int i;
2547         __u16 custom;
2548         __u16 round1;
2549         __u16 round;
2550
2551
2552         dbg("%s - %d", __FUNCTION__, baudrate);
2553
2554         for (i = 0; i < NUM_ENTRIES(divisor_table); i++) {
2555                 if ( divisor_table[i].BaudRate == baudrate ) {
2556                         *divisor = divisor_table[i].Divisor;
2557                         return 0;
2558                 }
2559         }
2560
2561         // We have tried all of the standard baud rates
2562         // lets try to calculate the divisor for this baud rate
2563         // Make sure the baud rate is reasonable
2564         if (baudrate < 230400) {
2565                 // get divisor
2566                 custom = (__u16)(230400L  / baudrate);
2567
2568                 // Check for round off
2569                 round1 = (__u16)(2304000L / baudrate);
2570                 round = (__u16)(round1 - (custom * 10));
2571                 if (round > 4) {
2572                         custom++;
2573                 }
2574                 *divisor = custom;
2575
2576                 dbg("%s - Baud %d = %d\n", __FUNCTION__, baudrate, custom);
2577                 return 0;
2578         }
2579
2580         return -1;
2581 }
2582
2583
2584 /*****************************************************************************
2585  * send_cmd_write_uart_register
2586  *      this function builds up a uart register message and sends to to the device.
2587  *****************************************************************************/
2588 static int send_cmd_write_uart_register (struct edgeport_port *edge_port, __u8 regNum, __u8 regValue)
2589 {
2590         unsigned char *cmdBuffer;
2591         unsigned char *currCmd;
2592         unsigned long cmdLen = 0;
2593         int status;
2594
2595         dbg("%s - write to %s register 0x%02x", (regNum == MCR) ? "MCR" : "LCR", __FUNCTION__, regValue);
2596
2597         // Alloc memory for the string of commands.
2598         cmdBuffer = kmalloc (0x10, GFP_ATOMIC);
2599         if (cmdBuffer == NULL ) {
2600                 return -ENOMEM;
2601         }
2602
2603         currCmd = cmdBuffer;
2604
2605         // Build a cmd in the buffer to write the given register
2606         MAKE_CMD_WRITE_REG (&currCmd, &cmdLen,
2607                             edge_port->port->number - edge_port->port->serial->minor,
2608                             regNum, regValue);
2609
2610         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2611         if (status) {
2612                 /* something bad happened, let's free up the memory */
2613                 kfree (cmdBuffer);
2614         }
2615
2616         return status;
2617 }
2618
2619
2620 /*****************************************************************************
2621  * change_port_settings
2622  *      This routine is called to set the UART on the device to match the specified
2623  *      new settings.
2624  *****************************************************************************/
2625 static void change_port_settings (struct edgeport_port *edge_port, struct termios *old_termios)
2626 {
2627         struct tty_struct *tty;
2628         int baud;
2629         unsigned cflag;
2630         __u8 mask = 0xff;
2631         __u8 lData;
2632         __u8 lParity;
2633         __u8 lStop;
2634         __u8 rxFlow;
2635         __u8 txFlow;
2636         int status;
2637
2638         dbg("%s - port %d", __FUNCTION__, edge_port->port->number);
2639
2640         if ((!edge_port->open) &&
2641             (!edge_port->openPending)) {
2642                 dbg("%s - port not opened", __FUNCTION__);
2643                 return;
2644         }
2645
2646         tty = edge_port->port->tty;
2647         if ((!tty) ||
2648             (!tty->termios)) {
2649                 dbg("%s - no tty structures", __FUNCTION__);
2650                 return;
2651         }
2652
2653         cflag = tty->termios->c_cflag;
2654
2655         switch (cflag & CSIZE) {
2656                 case CS5:   lData = LCR_BITS_5; mask = 0x1f;    dbg("%s - data bits = 5", __FUNCTION__);   break;
2657                 case CS6:   lData = LCR_BITS_6; mask = 0x3f;    dbg("%s - data bits = 6", __FUNCTION__);   break;
2658                 case CS7:   lData = LCR_BITS_7; mask = 0x7f;    dbg("%s - data bits = 7", __FUNCTION__);   break;
2659                 default:
2660                 case CS8:   lData = LCR_BITS_8;                 dbg("%s - data bits = 8", __FUNCTION__);   break;
2661         }
2662
2663         lParity = LCR_PAR_NONE;
2664         if (cflag & PARENB) {
2665                 if (cflag & PARODD) {
2666                         lParity = LCR_PAR_ODD;
2667                         dbg("%s - parity = odd", __FUNCTION__);
2668                 } else {
2669                         lParity = LCR_PAR_EVEN;
2670                         dbg("%s - parity = even", __FUNCTION__);
2671                 }
2672         } else {
2673                 dbg("%s - parity = none", __FUNCTION__);
2674         }
2675
2676         if (cflag & CSTOPB) {
2677                 lStop = LCR_STOP_2;
2678                 dbg("%s - stop bits = 2", __FUNCTION__);
2679         } else {
2680                 lStop = LCR_STOP_1;
2681                 dbg("%s - stop bits = 1", __FUNCTION__);
2682         }
2683
2684         /* figure out the flow control settings */
2685         rxFlow = txFlow = 0x00;
2686         if (cflag & CRTSCTS) {
2687                 rxFlow |= IOSP_RX_FLOW_RTS;
2688                 txFlow |= IOSP_TX_FLOW_CTS;
2689                 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
2690         } else {
2691                 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
2692         }
2693
2694         /* if we are implementing XON/XOFF, set the start and stop character in the device */
2695         if (I_IXOFF(tty) || I_IXON(tty)) {
2696                 unsigned char stop_char  = STOP_CHAR(tty);
2697                 unsigned char start_char = START_CHAR(tty);
2698
2699                 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XON_CHAR, start_char);
2700                 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XOFF_CHAR, stop_char);
2701
2702                 /* if we are implementing INBOUND XON/XOFF */
2703                 if (I_IXOFF(tty)) {
2704                         rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2705                         dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2706                 } else {
2707                         dbg("%s - INBOUND XON/XOFF is disabled", __FUNCTION__);
2708                 }
2709
2710                 /* if we are implementing OUTBOUND XON/XOFF */
2711                 if (I_IXON(tty)) {
2712                         txFlow |= IOSP_TX_FLOW_XON_XOFF;
2713                         dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2714                 } else {
2715                         dbg("%s - OUTBOUND XON/XOFF is disabled", __FUNCTION__);
2716                 }
2717         }
2718
2719         /* Set flow control to the configured value */
2720         send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2721         send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2722
2723
2724         edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2725         edge_port->shadowLCR |= (lData | lParity | lStop);
2726
2727         edge_port->validDataMask = mask;
2728
2729         /* Send the updated LCR value to the EdgePort */
2730         status = send_cmd_write_uart_register(edge_port, LCR, edge_port->shadowLCR);
2731         if (status != 0) {
2732                 return;
2733         }
2734
2735         /* set up the MCR register and send it to the EdgePort */
2736         edge_port->shadowMCR = MCR_MASTER_IE;
2737         if (cflag & CBAUD) {
2738                 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2739         }
2740         status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
2741         if (status != 0) {
2742                 return;
2743         }
2744
2745         /* Determine divisor based on baud rate */
2746         baud = tty_get_baud_rate(tty);
2747         if (!baud) {
2748                 /* pick a default, any default... */
2749                 baud = 9600;
2750         }
2751
2752         dbg("%s - baud rate = %d", __FUNCTION__, baud);
2753         status = send_cmd_write_baud_rate (edge_port, baud);
2754
2755         return;
2756 }
2757
2758
2759 /****************************************************************************
2760  * unicode_to_ascii
2761  *      Turns a string from Unicode into ASCII.
2762  *      Doesn't do a good job with any characters that are outside the normal
2763  *      ASCII range, but it's only for debugging...
2764  *      NOTE: expects the unicode in LE format
2765  ****************************************************************************/
2766 static void unicode_to_ascii (char *string, short *unicode, int unicode_size)
2767 {
2768         int i;
2769         for (i = 0; i < unicode_size; ++i) {
2770                 string[i] = (char)(le16_to_cpu(unicode[i]));
2771         }
2772         string[unicode_size] = 0x00;
2773 }
2774
2775
2776 /****************************************************************************
2777  * get_manufacturing_desc
2778  *      reads in the manufacturing descriptor and stores it into the serial
2779  *      structure.
2780  ****************************************************************************/
2781 static void get_manufacturing_desc (struct edgeport_serial *edge_serial)
2782 {
2783         int response;
2784
2785         dbg("getting manufacturer descriptor");
2786
2787         response = rom_read (edge_serial->serial, (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
2788                             (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff), EDGE_MANUF_DESC_LEN,
2789                             (__u8 *)(&edge_serial->manuf_descriptor));
2790
2791         if (response < 1) {
2792                 dev_err(&edge_serial->serial->dev->dev, "error in getting manufacturer descriptor\n");
2793         } else {
2794                 char string[30];
2795                 dbg("**Manufacturer Descriptor");
2796                 dbg("  RomSize:        %dK", edge_serial->manuf_descriptor.RomSize);
2797                 dbg("  RamSize:        %dK", edge_serial->manuf_descriptor.RamSize);
2798                 dbg("  CpuRev:         %d", edge_serial->manuf_descriptor.CpuRev);
2799                 dbg("  BoardRev:       %d", edge_serial->manuf_descriptor.BoardRev);
2800                 dbg("  NumPorts:       %d", edge_serial->manuf_descriptor.NumPorts);
2801                 dbg("  DescDate:       %d/%d/%d", edge_serial->manuf_descriptor.DescDate[0], edge_serial->manuf_descriptor.DescDate[1], edge_serial->manuf_descriptor.DescDate[2]+1900);
2802                 unicode_to_ascii (string, edge_serial->manuf_descriptor.SerialNumber, edge_serial->manuf_descriptor.SerNumLength/2-1);
2803                 dbg("  SerialNumber: %s", string);
2804                 unicode_to_ascii (string, edge_serial->manuf_descriptor.AssemblyNumber, edge_serial->manuf_descriptor.AssemblyNumLength/2-1);
2805                 dbg("  AssemblyNumber: %s", string);
2806                 unicode_to_ascii (string, edge_serial->manuf_descriptor.OemAssyNumber, edge_serial->manuf_descriptor.OemAssyNumLength/2-1);
2807                 dbg("  OemAssyNumber:  %s", string);
2808                 dbg("  UartType:       %d", edge_serial->manuf_descriptor.UartType);
2809                 dbg("  IonPid:         %d", edge_serial->manuf_descriptor.IonPid);
2810                 dbg("  IonConfig:      %d", edge_serial->manuf_descriptor.IonConfig);
2811         }
2812 }
2813
2814
2815 /****************************************************************************
2816  * get_boot_desc
2817  *      reads in the bootloader descriptor and stores it into the serial
2818  *      structure.
2819  ****************************************************************************/
2820 static void get_boot_desc (struct edgeport_serial *edge_serial)
2821 {
2822         int response;
2823
2824         dbg("getting boot descriptor");
2825
2826         response = rom_read (edge_serial->serial, (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
2827                             (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff), EDGE_BOOT_DESC_LEN,
2828                             (__u8 *)(&edge_serial->boot_descriptor));
2829
2830         if (response < 1) {
2831                 dev_err(&edge_serial->serial->dev->dev, "error in getting boot descriptor\n");
2832         } else {
2833                 dbg("**Boot Descriptor:");
2834                 dbg("  BootCodeLength: %d", le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2835                 dbg("  MajorVersion:   %d", edge_serial->boot_descriptor.MajorVersion);
2836                 dbg("  MinorVersion:   %d", edge_serial->boot_descriptor.MinorVersion);
2837                 dbg("  BuildNumber:    %d", le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2838                 dbg("  Capabilities:   0x%x", le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2839                 dbg("  UConfig0:       %d", edge_serial->boot_descriptor.UConfig0);
2840                 dbg("  UConfig1:       %d", edge_serial->boot_descriptor.UConfig1);
2841         }
2842 }
2843
2844
2845 /****************************************************************************
2846  * load_application_firmware
2847  *      This is called to load the application firmware to the device
2848  ****************************************************************************/
2849 static void load_application_firmware (struct edgeport_serial *edge_serial)
2850 {
2851         struct edge_firmware_image_record *record;
2852         unsigned char *firmware;
2853         unsigned char *FirmwareImage;
2854         int ImageSize;
2855         int response;
2856
2857
2858         switch (edge_serial->product_info.iDownloadFile) {
2859                 case EDGE_DOWNLOAD_FILE_I930:
2860                         dbg("downloading firmware version (930) %d.%d.%d",
2861                             OperationalCodeImageVersion_GEN1.MajorVersion,
2862                             OperationalCodeImageVersion_GEN1.MinorVersion,
2863                             OperationalCodeImageVersion_GEN1.BuildNumber);
2864                         firmware = &OperationalCodeImage_GEN1[0];
2865                         FirmwareImage = &OperationalCodeImage_GEN1[0];
2866                         ImageSize = sizeof(OperationalCodeImage_GEN1);
2867                         break;
2868
2869                 case EDGE_DOWNLOAD_FILE_80251:
2870                         dbg("downloading firmware version (80251) %d.%d.%d",
2871                             OperationalCodeImageVersion_GEN2.MajorVersion,
2872                             OperationalCodeImageVersion_GEN2.MinorVersion,
2873                             OperationalCodeImageVersion_GEN2.BuildNumber);
2874                         firmware = &OperationalCodeImage_GEN2[0];
2875                         FirmwareImage = &OperationalCodeImage_GEN2[0];
2876                         ImageSize = sizeof(OperationalCodeImage_GEN2);
2877                         break;
2878
2879                 case EDGE_DOWNLOAD_FILE_NONE:
2880                         dbg     ("No download file specified, skipping download\n");
2881                         return;
2882
2883                 default:
2884                         return;
2885         }
2886
2887
2888         for (;;) {
2889                 record = (struct edge_firmware_image_record *)firmware;
2890                 response = sram_write (edge_serial->serial, le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len), &record->Data[0]);
2891                 if (response < 0) {
2892                         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);
2893                         break;
2894                 }
2895                 firmware += sizeof (struct edge_firmware_image_record) + le16_to_cpu(record->Len);
2896                 if (firmware >= &FirmwareImage[ImageSize]) {
2897                         break;
2898                 }
2899         }
2900
2901         dbg("sending exec_dl_code");
2902         response = usb_control_msg (edge_serial->serial->dev,
2903                                     usb_sndctrlpipe(edge_serial->serial->dev, 0),
2904                                     USB_REQUEST_ION_EXEC_DL_CODE,
2905                                     0x40, 0x4000, 0x0001, NULL, 0, 3000);
2906
2907         return;
2908 }
2909
2910
2911
2912
2913 /****************************************************************************
2914  * edge_startup
2915  ****************************************************************************/
2916 static int edge_startup (struct usb_serial *serial)
2917 {
2918         struct edgeport_serial *edge_serial;
2919         struct edgeport_port *edge_port;
2920         struct usb_device *dev;
2921         int i;
2922
2923         dev = serial->dev;
2924
2925         /* create our private serial structure */
2926         edge_serial = kmalloc (sizeof(struct edgeport_serial), GFP_KERNEL);
2927         if (edge_serial == NULL) {
2928                 dev_err(&serial->dev->dev, "%s - Out of memory", __FUNCTION__);
2929                 return -ENOMEM;
2930         }
2931         memset (edge_serial, 0, sizeof(struct edgeport_serial));
2932         edge_serial->serial = serial;
2933         usb_set_serial_data(serial, edge_serial);
2934
2935         /* get the name for the device from the device */
2936         if ( (i = get_string(dev, dev->descriptor.iManufacturer, &edge_serial->name[0])) != 0) {
2937                 edge_serial->name[i-1] = ' ';
2938         }
2939
2940         get_string(dev, dev->descriptor.iProduct, &edge_serial->name[i]);
2941
2942         dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2943
2944         /* get the manufacturing descriptor for this device */
2945         get_manufacturing_desc (edge_serial);
2946
2947         /* get the boot descriptor */
2948         get_boot_desc (edge_serial);
2949
2950         get_product_info(edge_serial);
2951
2952         /* set the number of ports from the manufacturing description */
2953         /* serial->num_ports = serial->product_info.NumPorts; */
2954         if (edge_serial->product_info.NumPorts != serial->num_ports) {
2955                 warn("%s - Device Reported %d serial ports vs core "
2956                      "thinking we have %d ports, email greg@kroah.com this info.",
2957                      __FUNCTION__, edge_serial->product_info.NumPorts,
2958                      serial->num_ports);
2959         }
2960
2961         dbg("%s - time 1 %ld", __FUNCTION__, jiffies);
2962
2963         /* now load the application firmware into this device */
2964         load_application_firmware (edge_serial);
2965
2966         dbg("%s - time 2 %ld", __FUNCTION__, jiffies);
2967
2968         /* Check current Edgeport EEPROM and update if necessary */
2969         update_edgeport_E2PROM (edge_serial);
2970
2971         dbg("%s - time 3 %ld", __FUNCTION__, jiffies);
2972
2973         /* set the configuration to use #1 */
2974 //      dbg("set_configuration 1");
2975 //      usb_set_configuration (dev, 1);
2976
2977         /* we set up the pointers to the endpoints in the edge_open function,
2978          * as the structures aren't created yet. */
2979
2980         /* set up our port private structures */
2981         for (i = 0; i < serial->num_ports; ++i) {
2982                 edge_port = kmalloc (sizeof(struct edgeport_port), GFP_KERNEL);
2983                 if (edge_port == NULL) {
2984                         dev_err(&serial->dev->dev, "%s - Out of memory", __FUNCTION__);
2985                         usb_set_serial_data(serial, NULL);
2986                         kfree(edge_serial);
2987                         return -ENOMEM;
2988                 }
2989                 memset (edge_port, 0, sizeof(struct edgeport_port));
2990                 edge_port->port = serial->port[i];
2991                 usb_set_serial_port_data(serial->port[i], edge_port);
2992         }
2993
2994         return 0;
2995 }
2996
2997
2998
2999 /****************************************************************************
3000  * edge_shutdown
3001  *      This function is called whenever the device is removed from the usb bus.
3002  ****************************************************************************/
3003 static void edge_shutdown (struct usb_serial *serial)
3004 {
3005         int i;
3006
3007         dbg("%s", __FUNCTION__);
3008
3009         /* stop reads and writes on all ports */
3010         for (i=0; i < serial->num_ports; ++i) {
3011                 kfree (usb_get_serial_port_data(serial->port[i]));
3012                 usb_set_serial_port_data(serial->port[i],  NULL);
3013         }
3014         kfree (usb_get_serial_data(serial));
3015         usb_set_serial_data(serial, NULL);
3016 }
3017
3018
3019 /****************************************************************************
3020  * edgeport_init
3021  *      This is called by the module subsystem, or on startup to initialize us
3022  ****************************************************************************/
3023 static int __init edgeport_init(void)
3024 {
3025         int retval;
3026         retval = usb_serial_register(&edgeport_1port_device);
3027         if (retval)
3028                 goto failed_1port_device_register;
3029         retval = usb_serial_register(&edgeport_2port_device);
3030         if (retval)
3031                 goto failed_2port_device_register;
3032         retval = usb_serial_register(&edgeport_4port_device);
3033         if (retval)
3034                 goto failed_4port_device_register;
3035         retval = usb_serial_register(&edgeport_8port_device);
3036         if (retval)
3037                 goto failed_8port_device_register;
3038         retval = usb_register(&io_driver);
3039         if (retval)
3040                 goto failed_usb_register;
3041         info(DRIVER_DESC " " DRIVER_VERSION);
3042         return 0;
3043 failed_usb_register:
3044         usb_serial_deregister(&edgeport_8port_device);
3045 failed_8port_device_register:
3046         usb_serial_deregister(&edgeport_4port_device);
3047 failed_4port_device_register:
3048         usb_serial_deregister(&edgeport_2port_device);
3049 failed_2port_device_register:
3050         usb_serial_deregister(&edgeport_1port_device);
3051 failed_1port_device_register:
3052         return retval;
3053 }
3054
3055
3056
3057 /****************************************************************************
3058  * edgeport_exit
3059  *      Called when the driver is about to be unloaded.
3060  ****************************************************************************/
3061 static void __exit edgeport_exit (void)
3062 {
3063         usb_deregister (&io_driver);
3064         usb_serial_deregister (&edgeport_1port_device);
3065         usb_serial_deregister (&edgeport_2port_device);
3066         usb_serial_deregister (&edgeport_4port_device);
3067         usb_serial_deregister (&edgeport_8port_device);
3068 }
3069
3070 module_init(edgeport_init);
3071 module_exit(edgeport_exit);
3072
3073 /* Module information */
3074 MODULE_AUTHOR( DRIVER_AUTHOR );
3075 MODULE_DESCRIPTION( DRIVER_DESC );
3076 MODULE_LICENSE("GPL");
3077
3078 MODULE_PARM(debug, "i");
3079 MODULE_PARM_DESC(debug, "Debug enabled or not");
3080