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