drivers/usb/serial/io_edgeport.c

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