2  * Edgeport USB Serial Converter driver
 
   4  * Copyright (C) 2000 Inside Out Networks, All rights reserved.
 
   5  * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
 
   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.
 
  12  * Supports the following devices:
 
  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>.
 
  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 */
 
  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"
 
  61 #define MAX_NAME_LEN            64
 
  63 #define CHASE_TIMEOUT           (5*HZ)          /* 5 seconds */
 
  64 #define OPEN_TIMEOUT            (5*HZ)          /* 5 seconds */
 
  65 #define COMMAND_TIMEOUT         (5*HZ)          /* 5 seconds */
 
  67 /* receive port state */
 
  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) */
 
  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.
 
  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 */
 
  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 */
 
  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 */
 
  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 */
 
 112         bool                    chaseResponsePending;
 
 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 */
 
 119         struct async_icount     icount;
 
 120         struct usb_serial_port  *port;                  /* loop back to the owner of this object */
 
 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 */
 
 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 */
 
 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 */
 
 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;
 
 144         __u8                    bulk_out_endpoint;              /* the bulk out endpoint handle */
 
 146         __s16                   rxBytesAvail;                   /* the number of bytes that we need to read from this device */
 
 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 */
 
 159 /* baud rate information */
 
 160 struct divisor_table_entry {
 
 166  * Define table of divisors for Rev A EdgePort/4 hardware
 
 167  * These assume a 3.6864MHz crystal, the standard /16, and
 
 171 static const struct divisor_table_entry divisor_table[] = {
 
 174         {   110,        2095},  /* 2094.545455 => 230450   => .0217 % over */
 
 175         {   134,        1713},  /* 1713.011152 => 230398.5 => .00065% under */
 
 193 /* local variables */
 
 196 static atomic_t CmdUrbs;        /* Number of outstanding Command Write Urbs */
 
 199 /* local function prototypes */
 
 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);
 
 207 /* function prototypes for the usbserial callbacks */
 
 208 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port,
 
 210 static void edge_close(struct tty_struct *tty, struct usb_serial_port *port,
 
 212 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
 
 213                                         const unsigned char *buf, int count);
 
 214 static int edge_write_room(struct tty_struct *tty);
 
 215 static int edge_chars_in_buffer(struct tty_struct *tty);
 
 216 static void edge_throttle(struct tty_struct *tty);
 
 217 static void edge_unthrottle(struct tty_struct *tty);
 
 218 static void edge_set_termios(struct tty_struct *tty,
 
 219                                         struct usb_serial_port *port,
 
 220                                         struct ktermios *old_termios);
 
 221 static int  edge_ioctl(struct tty_struct *tty, struct file *file,
 
 222                                         unsigned int cmd, unsigned long arg);
 
 223 static void edge_break(struct tty_struct *tty, int break_state);
 
 224 static int  edge_tiocmget(struct tty_struct *tty, struct file *file);
 
 225 static int  edge_tiocmset(struct tty_struct *tty, struct file *file,
 
 226                                         unsigned int set, unsigned int clear);
 
 227 static int  edge_startup(struct usb_serial *serial);
 
 228 static void edge_shutdown(struct usb_serial *serial);
 
 230 #include "io_tables.h"  /* all of the devices that this driver supports */
 
 232 /* function prototypes for all of our local functions */
 
 234 static void  process_rcvd_data(struct edgeport_serial *edge_serial,
 
 235                                 unsigned char *buffer, __u16 bufferLength);
 
 236 static void process_rcvd_status(struct edgeport_serial *edge_serial,
 
 237                                 __u8 byte2, __u8 byte3);
 
 238 static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
 
 239                                 unsigned char *data, int length);
 
 240 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr);
 
 241 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
 
 242                                 __u8 lsr, __u8 data);
 
 243 static int  send_iosp_ext_cmd(struct edgeport_port *edge_port, __u8 command,
 
 245 static int  calc_baud_rate_divisor(int baud_rate, int *divisor);
 
 246 static int  send_cmd_write_baud_rate(struct edgeport_port *edge_port,
 
 248 static void change_port_settings(struct tty_struct *tty,
 
 249                                 struct edgeport_port *edge_port,
 
 250                                 struct ktermios *old_termios);
 
 251 static int  send_cmd_write_uart_register(struct edgeport_port *edge_port,
 
 252                                 __u8 regNum, __u8 regValue);
 
 253 static int  write_cmd_usb(struct edgeport_port *edge_port,
 
 254                                 unsigned char *buffer, int writeLength);
 
 255 static void send_more_port_data(struct edgeport_serial *edge_serial,
 
 256                                 struct edgeport_port *edge_port);
 
 258 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
 
 259                                         __u16 length, const __u8 *data);
 
 260 static int rom_read(struct usb_serial *serial, __u16 extAddr, __u16 addr,
 
 261                                                 __u16 length, __u8 *data);
 
 262 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
 
 263                                         __u16 length, const __u8 *data);
 
 264 static void get_manufacturing_desc(struct edgeport_serial *edge_serial);
 
 265 static void get_boot_desc(struct edgeport_serial *edge_serial);
 
 266 static void load_application_firmware(struct edgeport_serial *edge_serial);
 
 268 static void unicode_to_ascii(char *string, int buflen,
 
 269                                 __le16 *unicode, int unicode_size);
 
 272 /* ************************************************************************ */
 
 273 /* ************************************************************************ */
 
 274 /* ************************************************************************ */
 
 275 /* ************************************************************************ */
 
 277 /************************************************************************
 
 279  * update_edgeport_E2PROM()     Compare current versions of             *
 
 280  *                              Boot ROM and Manufacture                *
 
 281  *                              Descriptors with versions               *
 
 282  *                              embedded in this driver                 *
 
 284  ************************************************************************/
 
 285 static void update_edgeport_E2PROM(struct edgeport_serial *edge_serial)
 
 289         __u8 BootMajorVersion;
 
 290         __u8 BootMinorVersion;
 
 291         __u16 BootBuildNumber;
 
 293         const struct ihex_binrec *rec;
 
 294         const struct firmware *fw;
 
 298         switch (edge_serial->product_info.iDownloadFile) {
 
 299         case EDGE_DOWNLOAD_FILE_I930:
 
 300                 fw_name = "edgeport/boot.fw";
 
 302         case EDGE_DOWNLOAD_FILE_80251:
 
 303                 fw_name = "edgeport/boot2.fw";
 
 309         response = request_ihex_firmware(&fw, fw_name,
 
 310                                          &edge_serial->serial->dev->dev);
 
 312                 printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
 
 317         rec = (const struct ihex_binrec *)fw->data;
 
 318         BootMajorVersion = rec->data[0];
 
 319         BootMinorVersion = rec->data[1];
 
 320         BootBuildNumber = (rec->data[2] << 8) | rec->data[3];
 
 322         /* Check Boot Image Version */
 
 323         BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
 
 324                      (edge_serial->boot_descriptor.MinorVersion << 16) +
 
 325                       le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
 
 327         BootNewVer = (BootMajorVersion << 24) +
 
 328                      (BootMinorVersion << 16) +
 
 331         dbg("Current Boot Image version %d.%d.%d",
 
 332             edge_serial->boot_descriptor.MajorVersion,
 
 333             edge_serial->boot_descriptor.MinorVersion,
 
 334             le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
 
 337         if (BootNewVer > BootCurVer) {
 
 338                 dbg("**Update Boot Image from %d.%d.%d to %d.%d.%d",
 
 339                     edge_serial->boot_descriptor.MajorVersion,
 
 340                     edge_serial->boot_descriptor.MinorVersion,
 
 341                     le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
 
 342                     BootMajorVersion, BootMinorVersion, BootBuildNumber);
 
 344                 dbg("Downloading new Boot Image");
 
 346                 for (rec = ihex_next_binrec(rec); rec;
 
 347                      rec = ihex_next_binrec(rec)) {
 
 348                         Bootaddr = be32_to_cpu(rec->addr);
 
 349                         response = rom_write(edge_serial->serial,
 
 352                                              be16_to_cpu(rec->len),
 
 355                                 dev_err(&edge_serial->serial->dev->dev,
 
 356                                         "rom_write failed (%x, %x, %d)\n",
 
 357                                         Bootaddr >> 16, Bootaddr & 0xFFFF,
 
 358                                         be16_to_cpu(rec->len));
 
 363                 dbg("Boot Image -- already up to date");
 
 365         release_firmware(fw);
 
 369 /************************************************************************
 
 371  *  Get string descriptor from device                                   *
 
 373  ************************************************************************/
 
 374 static int get_string(struct usb_device *dev, int Id, char *string, int buflen)
 
 376         struct usb_string_descriptor StringDesc;
 
 377         struct usb_string_descriptor *pStringDesc;
 
 379         dbg("%s - USB String ID = %d", __func__, Id);
 
 381         if (!usb_get_descriptor(dev, USB_DT_STRING, Id,
 
 382                                         &StringDesc, sizeof(StringDesc)))
 
 385         pStringDesc = kmalloc(StringDesc.bLength, GFP_KERNEL);
 
 389         if (!usb_get_descriptor(dev, USB_DT_STRING, Id,
 
 390                                         pStringDesc, StringDesc.bLength)) {
 
 395         unicode_to_ascii(string, buflen,
 
 396                                 pStringDesc->wData, pStringDesc->bLength/2);
 
 399         dbg("%s - USB String %s", __func__, string);
 
 400         return strlen(string);
 
 405 /************************************************************************
 
 407  *  Get string descriptor from device
 
 409  ************************************************************************/
 
 410 static int get_string_desc(struct usb_device *dev, int Id,
 
 411                                 struct usb_string_descriptor **pRetDesc)
 
 413         struct usb_string_descriptor StringDesc;
 
 414         struct usb_string_descriptor *pStringDesc;
 
 416         dbg("%s - USB String ID = %d", __func__, Id);
 
 418         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc,
 
 422         pStringDesc = kmalloc(StringDesc.bLength, GFP_KERNEL);
 
 426         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc,
 
 427                                                         StringDesc.bLength)) {
 
 432         *pRetDesc = pStringDesc;
 
 437 static void dump_product_info(struct edgeport_product_info *product_info)
 
 439         /* Dump Product Info structure */
 
 440         dbg("**Product Information:");
 
 441         dbg("  ProductId             %x", product_info->ProductId);
 
 442         dbg("  NumPorts              %d", product_info->NumPorts);
 
 443         dbg("  ProdInfoVer           %d", product_info->ProdInfoVer);
 
 444         dbg("  IsServer              %d", product_info->IsServer);
 
 445         dbg("  IsRS232               %d", product_info->IsRS232);
 
 446         dbg("  IsRS422               %d", product_info->IsRS422);
 
 447         dbg("  IsRS485               %d", product_info->IsRS485);
 
 448         dbg("  RomSize               %d", product_info->RomSize);
 
 449         dbg("  RamSize               %d", product_info->RamSize);
 
 450         dbg("  CpuRev                %x", product_info->CpuRev);
 
 451         dbg("  BoardRev              %x", product_info->BoardRev);
 
 452         dbg("  BootMajorVersion      %d.%d.%d", product_info->BootMajorVersion,
 
 453             product_info->BootMinorVersion,
 
 454             le16_to_cpu(product_info->BootBuildNumber));
 
 455         dbg("  FirmwareMajorVersion  %d.%d.%d",
 
 456                         product_info->FirmwareMajorVersion,
 
 457                         product_info->FirmwareMinorVersion,
 
 458                         le16_to_cpu(product_info->FirmwareBuildNumber));
 
 459         dbg("  ManufactureDescDate   %d/%d/%d",
 
 460                         product_info->ManufactureDescDate[0],
 
 461                         product_info->ManufactureDescDate[1],
 
 462                         product_info->ManufactureDescDate[2]+1900);
 
 463         dbg("  iDownloadFile         0x%x", product_info->iDownloadFile);
 
 464         dbg("  EpicVer               %d", product_info->EpicVer);
 
 467 static void get_product_info(struct edgeport_serial *edge_serial)
 
 469         struct edgeport_product_info *product_info = &edge_serial->product_info;
 
 471         memset(product_info, 0, sizeof(struct edgeport_product_info));
 
 473         product_info->ProductId = (__u16)(le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ~ION_DEVICE_ID_80251_NETCHIP);
 
 474         product_info->NumPorts = edge_serial->manuf_descriptor.NumPorts;
 
 475         product_info->ProdInfoVer = 0;
 
 477         product_info->RomSize = edge_serial->manuf_descriptor.RomSize;
 
 478         product_info->RamSize = edge_serial->manuf_descriptor.RamSize;
 
 479         product_info->CpuRev = edge_serial->manuf_descriptor.CpuRev;
 
 480         product_info->BoardRev = edge_serial->manuf_descriptor.BoardRev;
 
 482         product_info->BootMajorVersion =
 
 483                                 edge_serial->boot_descriptor.MajorVersion;
 
 484         product_info->BootMinorVersion =
 
 485                                 edge_serial->boot_descriptor.MinorVersion;
 
 486         product_info->BootBuildNumber =
 
 487                                 edge_serial->boot_descriptor.BuildNumber;
 
 489         memcpy(product_info->ManufactureDescDate,
 
 490                         edge_serial->manuf_descriptor.DescDate,
 
 491                         sizeof(edge_serial->manuf_descriptor.DescDate));
 
 493         /* check if this is 2nd generation hardware */
 
 494         if (le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct)
 
 495                                             & ION_DEVICE_ID_80251_NETCHIP)
 
 496                 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_80251;
 
 498                 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_I930;
 
 500         /* Determine Product type and set appropriate flags */
 
 501         switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
 
 502         case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
 
 503         case ION_DEVICE_ID_EDGEPORT_4T:
 
 504         case ION_DEVICE_ID_EDGEPORT_4:
 
 505         case ION_DEVICE_ID_EDGEPORT_2:
 
 506         case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
 
 507         case ION_DEVICE_ID_EDGEPORT_8:
 
 508         case ION_DEVICE_ID_EDGEPORT_421:
 
 509         case ION_DEVICE_ID_EDGEPORT_21:
 
 510         case ION_DEVICE_ID_EDGEPORT_2_DIN:
 
 511         case ION_DEVICE_ID_EDGEPORT_4_DIN:
 
 512         case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
 
 513                 product_info->IsRS232 = 1;
 
 516         case ION_DEVICE_ID_EDGEPORT_2I: /* Edgeport/2 RS422/RS485 */
 
 517                 product_info->IsRS422 = 1;
 
 518                 product_info->IsRS485 = 1;
 
 521         case ION_DEVICE_ID_EDGEPORT_8I: /* Edgeport/4 RS422 */
 
 522         case ION_DEVICE_ID_EDGEPORT_4I: /* Edgeport/4 RS422 */
 
 523                 product_info->IsRS422 = 1;
 
 527         dump_product_info(product_info);
 
 530 static int get_epic_descriptor(struct edgeport_serial *ep)
 
 533         struct usb_serial *serial = ep->serial;
 
 534         struct edgeport_product_info *product_info = &ep->product_info;
 
 535         struct edge_compatibility_descriptor *epic = &ep->epic_descriptor;
 
 536         struct edge_compatibility_bits *bits;
 
 539         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 
 540                                  USB_REQUEST_ION_GET_EPIC_DESC,
 
 542                                  &ep->epic_descriptor,
 
 543                                  sizeof(struct edge_compatibility_descriptor),
 
 546         dbg("%s result = %d", __func__, result);
 
 550                 memset(product_info, 0, sizeof(struct edgeport_product_info));
 
 552                 product_info->NumPorts = epic->NumPorts;
 
 553                 product_info->ProdInfoVer = 0;
 
 554                 product_info->FirmwareMajorVersion = epic->MajorVersion;
 
 555                 product_info->FirmwareMinorVersion = epic->MinorVersion;
 
 556                 product_info->FirmwareBuildNumber = epic->BuildNumber;
 
 557                 product_info->iDownloadFile = epic->iDownloadFile;
 
 558                 product_info->EpicVer = epic->EpicVer;
 
 559                 product_info->Epic = epic->Supports;
 
 560                 product_info->ProductId = ION_DEVICE_ID_EDGEPORT_COMPATIBLE;
 
 561                 dump_product_info(product_info);
 
 563                 bits = &ep->epic_descriptor.Supports;
 
 564                 dbg("**EPIC descriptor:");
 
 565                 dbg("  VendEnableSuspend: %s", bits->VendEnableSuspend  ? "TRUE": "FALSE");
 
 566                 dbg("  IOSPOpen         : %s", bits->IOSPOpen           ? "TRUE": "FALSE");
 
 567                 dbg("  IOSPClose        : %s", bits->IOSPClose          ? "TRUE": "FALSE");
 
 568                 dbg("  IOSPChase        : %s", bits->IOSPChase          ? "TRUE": "FALSE");
 
 569                 dbg("  IOSPSetRxFlow    : %s", bits->IOSPSetRxFlow      ? "TRUE": "FALSE");
 
 570                 dbg("  IOSPSetTxFlow    : %s", bits->IOSPSetTxFlow      ? "TRUE": "FALSE");
 
 571                 dbg("  IOSPSetXChar     : %s", bits->IOSPSetXChar       ? "TRUE": "FALSE");
 
 572                 dbg("  IOSPRxCheck      : %s", bits->IOSPRxCheck        ? "TRUE": "FALSE");
 
 573                 dbg("  IOSPSetClrBreak  : %s", bits->IOSPSetClrBreak    ? "TRUE": "FALSE");
 
 574                 dbg("  IOSPWriteMCR     : %s", bits->IOSPWriteMCR       ? "TRUE": "FALSE");
 
 575                 dbg("  IOSPWriteLCR     : %s", bits->IOSPWriteLCR       ? "TRUE": "FALSE");
 
 576                 dbg("  IOSPSetBaudRate  : %s", bits->IOSPSetBaudRate    ? "TRUE": "FALSE");
 
 577                 dbg("  TrueEdgeport     : %s", bits->TrueEdgeport       ? "TRUE": "FALSE");
 
 584 /************************************************************************/
 
 585 /************************************************************************/
 
 586 /*            U S B  C A L L B A C K   F U N C T I O N S                */
 
 587 /*            U S B  C A L L B A C K   F U N C T I O N S                */
 
 588 /************************************************************************/
 
 589 /************************************************************************/
 
 591 /*****************************************************************************
 
 592  * edge_interrupt_callback
 
 593  *      this is the callback function for when we have received data on the
 
 594  *      interrupt endpoint.
 
 595  *****************************************************************************/
 
 596 static void edge_interrupt_callback(struct urb *urb)
 
 598         struct edgeport_serial  *edge_serial = urb->context;
 
 599         struct edgeport_port *edge_port;
 
 600         struct usb_serial_port *port;
 
 601         struct tty_struct *tty;
 
 602         unsigned char *data = urb->transfer_buffer;
 
 603         int length = urb->actual_length;
 
 609         int status = urb->status;
 
 620                 /* this urb is terminated, clean up */
 
 621                 dbg("%s - urb shutting down with status: %d",
 
 625                 dbg("%s - nonzero urb status received: %d", __func__, status);
 
 629         /* process this interrupt-read even if there are no ports open */
 
 631                 usb_serial_debug_data(debug, &edge_serial->serial->dev->dev,
 
 632                                                 __func__, length, data);
 
 635                         bytes_avail = data[0] | (data[1] << 8);
 
 637                                 spin_lock(&edge_serial->es_lock);
 
 638                                 edge_serial->rxBytesAvail += bytes_avail;
 
 639                                 dbg("%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d", __func__, bytes_avail, edge_serial->rxBytesAvail, edge_serial->read_in_progress);
 
 641                                 if (edge_serial->rxBytesAvail > 0 &&
 
 642                                     !edge_serial->read_in_progress) {
 
 643                                         dbg("%s - posting a read", __func__);
 
 644                                         edge_serial->read_in_progress = true;
 
 646                                         /* we have pending bytes on the
 
 647                                            bulk in pipe, send a request */
 
 648                                         edge_serial->read_urb->dev = edge_serial->serial->dev;
 
 649                                         result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
 
 651                                                 dev_err(&edge_serial->serial->dev->dev, "%s - usb_submit_urb(read bulk) failed with result = %d\n", __func__, result);
 
 652                                                 edge_serial->read_in_progress = false;
 
 655                                 spin_unlock(&edge_serial->es_lock);
 
 658                 /* grab the txcredits for the ports if available */
 
 661                 while ((position < length) &&
 
 662                                 (portNumber < edge_serial->serial->num_ports)) {
 
 663                         txCredits = data[position] | (data[position+1] << 8);
 
 665                                 port = edge_serial->serial->port[portNumber];
 
 666                                 edge_port = usb_get_serial_port_data(port);
 
 667                                 if (edge_port->open) {
 
 668                                         spin_lock(&edge_port->ep_lock);
 
 669                                         edge_port->txCredits += txCredits;
 
 670                                         spin_unlock(&edge_port->ep_lock);
 
 671                                         dbg("%s - txcredits for port%d = %d",
 
 672                                                         __func__, portNumber,
 
 673                                                         edge_port->txCredits);
 
 675                                         /* tell the tty driver that something
 
 677                                         tty = tty_port_tty_get(
 
 678                                                 &edge_port->port->port);
 
 683                                         /* Since we have more credit, check
 
 684                                            if more data can be sent */
 
 685                                         send_more_port_data(edge_serial,
 
 695         result = usb_submit_urb(urb, GFP_ATOMIC);
 
 697                 dev_err(&urb->dev->dev,
 
 698                         "%s - Error %d submitting control urb\n",
 
 703 /*****************************************************************************
 
 704  * edge_bulk_in_callback
 
 705  *      this is the callback function for when we have received data on the
 
 707  *****************************************************************************/
 
 708 static void edge_bulk_in_callback(struct urb *urb)
 
 710         struct edgeport_serial  *edge_serial = urb->context;
 
 711         unsigned char           *data = urb->transfer_buffer;
 
 713         __u16                   raw_data_length;
 
 714         int status = urb->status;
 
 719                 dbg("%s - nonzero read bulk status received: %d",
 
 721                 edge_serial->read_in_progress = false;
 
 725         if (urb->actual_length == 0) {
 
 726                 dbg("%s - read bulk callback with no data", __func__);
 
 727                 edge_serial->read_in_progress = false;
 
 731         raw_data_length = urb->actual_length;
 
 733         usb_serial_debug_data(debug, &edge_serial->serial->dev->dev,
 
 734                                         __func__, raw_data_length, data);
 
 736         spin_lock(&edge_serial->es_lock);
 
 738         /* decrement our rxBytes available by the number that we just got */
 
 739         edge_serial->rxBytesAvail -= raw_data_length;
 
 741         dbg("%s - Received = %d, rxBytesAvail %d", __func__,
 
 742                                 raw_data_length, edge_serial->rxBytesAvail);
 
 744         process_rcvd_data(edge_serial, data, urb->actual_length);
 
 746         /* check to see if there's any more data for us to read */
 
 747         if (edge_serial->rxBytesAvail > 0) {
 
 748                 dbg("%s - posting a read", __func__);
 
 749                 edge_serial->read_urb->dev = edge_serial->serial->dev;
 
 750                 retval = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
 
 752                         dev_err(&urb->dev->dev,
 
 753                                 "%s - usb_submit_urb(read bulk) failed, "
 
 754                                 "retval = %d\n", __func__, retval);
 
 755                         edge_serial->read_in_progress = false;
 
 758                 edge_serial->read_in_progress = false;
 
 761         spin_unlock(&edge_serial->es_lock);
 
 765 /*****************************************************************************
 
 766  * edge_bulk_out_data_callback
 
 767  *      this is the callback function for when we have finished sending
 
 768  *      serial data on the bulk out endpoint.
 
 769  *****************************************************************************/
 
 770 static void edge_bulk_out_data_callback(struct urb *urb)
 
 772         struct edgeport_port *edge_port = urb->context;
 
 773         struct tty_struct *tty;
 
 774         int status = urb->status;
 
 779                 dbg("%s - nonzero write bulk status received: %d",
 
 783         tty = tty_port_tty_get(&edge_port->port->port);
 
 785         if (tty && edge_port->open) {
 
 786                 /* let the tty driver wakeup if it has a special
 
 787                    write_wakeup function */
 
 792         /* Release the Write URB */
 
 793         edge_port->write_in_progress = false;
 
 795         /* Check if more data needs to be sent */
 
 796         send_more_port_data((struct edgeport_serial *)
 
 797                 (usb_get_serial_data(edge_port->port->serial)), edge_port);
 
 801 /*****************************************************************************
 
 803  *      this is the callback function for when we have finished sending a
 
 804  *      command on the bulk out endpoint.
 
 805  *****************************************************************************/
 
 806 static void edge_bulk_out_cmd_callback(struct urb *urb)
 
 808         struct edgeport_port *edge_port = urb->context;
 
 809         struct tty_struct *tty;
 
 810         int status = urb->status;
 
 814         atomic_dec(&CmdUrbs);
 
 815         dbg("%s - FREE URB %p (outstanding %d)", __func__,
 
 816                                         urb, atomic_read(&CmdUrbs));
 
 819         /* clean up the transfer buffer */
 
 820         kfree(urb->transfer_buffer);
 
 822         /* Free the command urb */
 
 826                 dbg("%s - nonzero write bulk status received: %d",
 
 831         /* Get pointer to tty */
 
 832         tty = tty_port_tty_get(&edge_port->port->port);
 
 834         /* tell the tty driver that something has changed */
 
 835         if (tty && edge_port->open)
 
 839         /* we have completed the command */
 
 840         edge_port->commandPending = false;
 
 841         wake_up(&edge_port->wait_command);
 
 845 /*****************************************************************************
 
 846  * Driver tty interface functions
 
 847  *****************************************************************************/
 
 849 /*****************************************************************************
 
 851  *      this function is called by the tty driver when a port is opened
 
 852  *      If successful, we return 0
 
 853  *      Otherwise we return a negative error number.
 
 854  *****************************************************************************/
 
 855 static int edge_open(struct tty_struct *tty,
 
 856                         struct usb_serial_port *port, struct file *filp)
 
 858         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
 859         struct usb_serial *serial;
 
 860         struct edgeport_serial *edge_serial;
 
 863         dbg("%s - port %d", __func__, port->number);
 
 865         if (edge_port == NULL)
 
 868         /* see if we've set up our endpoint info yet (can't set it up
 
 869            in edge_startup as the structures were not set up at that time.) */
 
 870         serial = port->serial;
 
 871         edge_serial = usb_get_serial_data(serial);
 
 872         if (edge_serial == NULL)
 
 874         if (edge_serial->interrupt_in_buffer == NULL) {
 
 875                 struct usb_serial_port *port0 = serial->port[0];
 
 877                 /* not set up yet, so do it now */
 
 878                 edge_serial->interrupt_in_buffer =
 
 879                                         port0->interrupt_in_buffer;
 
 880                 edge_serial->interrupt_in_endpoint =
 
 881                                         port0->interrupt_in_endpointAddress;
 
 882                 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
 
 883                 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
 
 884                 edge_serial->bulk_in_endpoint =
 
 885                                         port0->bulk_in_endpointAddress;
 
 886                 edge_serial->read_urb = port0->read_urb;
 
 887                 edge_serial->bulk_out_endpoint =
 
 888                                         port0->bulk_out_endpointAddress;
 
 890                 /* set up our interrupt urb */
 
 891                 usb_fill_int_urb(edge_serial->interrupt_read_urb,
 
 893                       usb_rcvintpipe(serial->dev,
 
 894                                 port0->interrupt_in_endpointAddress),
 
 895                       port0->interrupt_in_buffer,
 
 896                       edge_serial->interrupt_read_urb->transfer_buffer_length,
 
 897                       edge_interrupt_callback, edge_serial,
 
 898                       edge_serial->interrupt_read_urb->interval);
 
 900                 /* set up our bulk in urb */
 
 901                 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
 
 902                         usb_rcvbulkpipe(serial->dev,
 
 903                                 port0->bulk_in_endpointAddress),
 
 904                         port0->bulk_in_buffer,
 
 905                         edge_serial->read_urb->transfer_buffer_length,
 
 906                         edge_bulk_in_callback, edge_serial);
 
 907                 edge_serial->read_in_progress = false;
 
 909                 /* start interrupt read for this edgeport
 
 910                  * this interrupt will continue as long
 
 911                  * as the edgeport is connected */
 
 912                 response = usb_submit_urb(edge_serial->interrupt_read_urb,
 
 916                                 "%s - Error %d submitting control urb\n",
 
 921         /* initialize our wait queues */
 
 922         init_waitqueue_head(&edge_port->wait_open);
 
 923         init_waitqueue_head(&edge_port->wait_chase);
 
 924         init_waitqueue_head(&edge_port->delta_msr_wait);
 
 925         init_waitqueue_head(&edge_port->wait_command);
 
 927         /* initialize our icount structure */
 
 928         memset(&(edge_port->icount), 0x00, sizeof(edge_port->icount));
 
 930         /* initialize our port settings */
 
 931         edge_port->txCredits = 0;       /* Can't send any data yet */
 
 932         /* Must always set this bit to enable ints! */
 
 933         edge_port->shadowMCR = MCR_MASTER_IE;
 
 934         edge_port->chaseResponsePending = false;
 
 936         /* send a open port command */
 
 937         edge_port->openPending = true;
 
 938         edge_port->open        = false;
 
 939         response = send_iosp_ext_cmd(edge_port, IOSP_CMD_OPEN_PORT, 0);
 
 942                 dev_err(&port->dev, "%s - error sending open port command\n",
 
 944                 edge_port->openPending = false;
 
 948         /* now wait for the port to be completely opened */
 
 949         wait_event_timeout(edge_port->wait_open, !edge_port->openPending,
 
 952         if (!edge_port->open) {
 
 954                 dbg("%s - open timedout", __func__);
 
 955                 edge_port->openPending = false;
 
 959         /* create the txfifo */
 
 960         edge_port->txfifo.head  = 0;
 
 961         edge_port->txfifo.tail  = 0;
 
 962         edge_port->txfifo.count = 0;
 
 963         edge_port->txfifo.size  = edge_port->maxTxCredits;
 
 964         edge_port->txfifo.fifo  = kmalloc(edge_port->maxTxCredits, GFP_KERNEL);
 
 966         if (!edge_port->txfifo.fifo) {
 
 967                 dbg("%s - no memory", __func__);
 
 968                 edge_close(tty, port, filp);
 
 972         /* Allocate a URB for the write */
 
 973         edge_port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
 
 974         edge_port->write_in_progress = false;
 
 976         if (!edge_port->write_urb) {
 
 977                 dbg("%s - no memory", __func__);
 
 978                 edge_close(tty, port, filp);
 
 982         dbg("%s(%d) - Initialize TX fifo to %d bytes",
 
 983                         __func__, port->number, edge_port->maxTxCredits);
 
 985         dbg("%s exited", __func__);
 
 991 /************************************************************************
 
 993  * block_until_chase_response
 
 995  *      This function will block the close until one of the following:
 
 996  *              1. Response to our Chase comes from Edgeport
 
 997  *              2. A timeout of 10 seconds without activity has expired
 
 998  *                 (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
 
1000  ************************************************************************/
 
1001 static void block_until_chase_response(struct edgeport_port *edge_port)
 
1009                 /* Save Last credits */
 
1010                 lastCredits = edge_port->txCredits;
 
1012                 /* Did we get our Chase response */
 
1013                 if (!edge_port->chaseResponsePending) {
 
1014                         dbg("%s - Got Chase Response", __func__);
 
1016                         /* did we get all of our credit back? */
 
1017                         if (edge_port->txCredits == edge_port->maxTxCredits) {
 
1018                                 dbg("%s - Got all credits", __func__);
 
1023                 /* Block the thread for a while */
 
1024                 prepare_to_wait(&edge_port->wait_chase, &wait,
 
1025                                                 TASK_UNINTERRUPTIBLE);
 
1026                 schedule_timeout(timeout);
 
1027                 finish_wait(&edge_port->wait_chase, &wait);
 
1029                 if (lastCredits == edge_port->txCredits) {
 
1030                         /* No activity.. count down. */
 
1033                                 edge_port->chaseResponsePending = false;
 
1034                                 dbg("%s - Chase TIMEOUT", __func__);
 
1038                         /* Reset timeout value back to 10 seconds */
 
1039                         dbg("%s - Last %d, Current %d", __func__,
 
1040                                         lastCredits, edge_port->txCredits);
 
1047 /************************************************************************
 
1049  * block_until_tx_empty
 
1051  *      This function will block the close until one of the following:
 
1053  *              2. The edgeport has stopped
 
1054  *              3. A timeout of 3 seconds without activity has expired
 
1056  ************************************************************************/
 
1057 static void block_until_tx_empty(struct edgeport_port *edge_port)
 
1060         struct TxFifo *fifo = &edge_port->txfifo;
 
1062         int timeout = HZ/10;
 
1066                 /* Save Last count */
 
1067                 lastCount = fifo->count;
 
1069                 /* Is the Edgeport Buffer empty? */
 
1070                 if (lastCount == 0) {
 
1071                         dbg("%s - TX Buffer Empty", __func__);
 
1075                 /* Block the thread for a while */
 
1076                 prepare_to_wait(&edge_port->wait_chase, &wait,
 
1077                                                 TASK_UNINTERRUPTIBLE);
 
1078                 schedule_timeout(timeout);
 
1079                 finish_wait(&edge_port->wait_chase, &wait);
 
1081                 dbg("%s wait", __func__);
 
1083                 if (lastCount == fifo->count) {
 
1084                         /* No activity.. count down. */
 
1087                                 dbg("%s - TIMEOUT", __func__);
 
1091                         /* Reset timeout value back to seconds */
 
1098 /*****************************************************************************
 
1100  *      this function is called by the tty driver when a port is closed
 
1101  *****************************************************************************/
 
1102 static void edge_close(struct tty_struct *tty,
 
1103                         struct usb_serial_port *port, struct file *filp)
 
1105         struct edgeport_serial *edge_serial;
 
1106         struct edgeport_port *edge_port;
 
1109         dbg("%s - port %d", __func__, port->number);
 
1111         edge_serial = usb_get_serial_data(port->serial);
 
1112         edge_port = usb_get_serial_port_data(port);
 
1113         if (edge_serial == NULL || edge_port == NULL)
 
1116         /* block until tx is empty */
 
1117         block_until_tx_empty(edge_port);
 
1119         edge_port->closePending = true;
 
1121         if ((!edge_serial->is_epic) ||
 
1122             ((edge_serial->is_epic) &&
 
1123              (edge_serial->epic_descriptor.Supports.IOSPChase))) {
 
1124                 /* flush and chase */
 
1125                 edge_port->chaseResponsePending = true;
 
1127                 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __func__);
 
1128                 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
 
1130                         /* block until chase finished */
 
1131                         block_until_chase_response(edge_port);
 
1133                         edge_port->chaseResponsePending = false;
 
1136         if ((!edge_serial->is_epic) ||
 
1137             ((edge_serial->is_epic) &&
 
1138              (edge_serial->epic_descriptor.Supports.IOSPClose))) {
 
1139                /* close the port */
 
1140                 dbg("%s - Sending IOSP_CMD_CLOSE_PORT", __func__);
 
1141                 send_iosp_ext_cmd(edge_port, IOSP_CMD_CLOSE_PORT, 0);
 
1144         /* port->close = true; */
 
1145         edge_port->closePending = false;
 
1146         edge_port->open = false;
 
1147         edge_port->openPending = false;
 
1149         usb_kill_urb(edge_port->write_urb);
 
1151         if (edge_port->write_urb) {
 
1152                 /* if this urb had a transfer buffer already
 
1153                                 (old transfer) free it */
 
1154                 kfree(edge_port->write_urb->transfer_buffer);
 
1155                 usb_free_urb(edge_port->write_urb);
 
1156                 edge_port->write_urb = NULL;
 
1158         kfree(edge_port->txfifo.fifo);
 
1159         edge_port->txfifo.fifo = NULL;
 
1161         dbg("%s exited", __func__);
 
1164 /*****************************************************************************
 
1166  *      this function is called by the tty driver when data should be written
 
1168  *      If successful, we return the number of bytes written, otherwise we
 
1169  *      return a negative error number.
 
1170  *****************************************************************************/
 
1171 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
 
1172                                         const unsigned char *data, int count)
 
1174         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1175         struct TxFifo *fifo;
 
1180         unsigned long flags;
 
1182         dbg("%s - port %d", __func__, port->number);
 
1184         if (edge_port == NULL)
 
1187         /* get a pointer to the Tx fifo */
 
1188         fifo = &edge_port->txfifo;
 
1190         spin_lock_irqsave(&edge_port->ep_lock, flags);
 
1192         /* calculate number of bytes to put in fifo */
 
1193         copySize = min((unsigned int)count,
 
1194                                 (edge_port->txCredits - fifo->count));
 
1196         dbg("%s(%d) of %d byte(s) Fifo room  %d -- will copy %d bytes",
 
1197                         __func__, port->number, count,
 
1198                         edge_port->txCredits - fifo->count, copySize);
 
1200         /* catch writes of 0 bytes which the tty driver likes to give us,
 
1201            and when txCredits is empty */
 
1202         if (copySize == 0) {
 
1203                 dbg("%s - copySize = Zero", __func__);
 
1208          * since we can never overflow the buffer we do not have to check for a
 
1211          * the copy is done is two parts -- first fill to the end of the buffer
 
1212          * then copy the reset from the start of the buffer
 
1214         bytesleft = fifo->size - fifo->head;
 
1215         firsthalf = min(bytesleft, copySize);
 
1216         dbg("%s - copy %d bytes of %d into fifo ", __func__,
 
1217                                         firsthalf, bytesleft);
 
1219         /* now copy our data */
 
1220         memcpy(&fifo->fifo[fifo->head], data, firsthalf);
 
1221         usb_serial_debug_data(debug, &port->dev, __func__,
 
1222                                         firsthalf, &fifo->fifo[fifo->head]);
 
1224         /* update the index and size */
 
1225         fifo->head  += firsthalf;
 
1226         fifo->count += firsthalf;
 
1228         /* wrap the index */
 
1229         if (fifo->head == fifo->size)
 
1232         secondhalf = copySize-firsthalf;
 
1235                 dbg("%s - copy rest of data %d", __func__, secondhalf);
 
1236                 memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
 
1237                 usb_serial_debug_data(debug, &port->dev, __func__,
 
1238                                         secondhalf, &fifo->fifo[fifo->head]);
 
1239                 /* update the index and size */
 
1240                 fifo->count += secondhalf;
 
1241                 fifo->head  += secondhalf;
 
1242                 /* No need to check for wrap since we can not get to end of
 
1243                  * the fifo in this part
 
1248         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
 
1250         send_more_port_data((struct edgeport_serial *)
 
1251                         usb_get_serial_data(port->serial), edge_port);
 
1253         dbg("%s wrote %d byte(s) TxCredits %d, Fifo %d", __func__,
 
1254                                 copySize, edge_port->txCredits, fifo->count);
 
1260 /************************************************************************
 
1262  * send_more_port_data()
 
1264  *      This routine attempts to write additional UART transmit data
 
1265  *      to a port over the USB bulk pipe. It is called (1) when new
 
1266  *      data has been written to a port's TxBuffer from higher layers
 
1267  *      (2) when the peripheral sends us additional TxCredits indicating
 
1268  *      that it can accept more Tx data for a given port; and (3) when
 
1269  *      a bulk write completes successfully and we want to see if we
 
1270  *      can transmit more.
 
1272  ************************************************************************/
 
1273 static void send_more_port_data(struct edgeport_serial *edge_serial,
 
1274                                         struct edgeport_port *edge_port)
 
1276         struct TxFifo   *fifo = &edge_port->txfifo;
 
1278         unsigned char   *buffer;
 
1284         unsigned long   flags;
 
1286         dbg("%s(%d)", __func__, edge_port->port->number);
 
1288         spin_lock_irqsave(&edge_port->ep_lock, flags);
 
1290         if (edge_port->write_in_progress ||
 
1292             (fifo->count == 0)) {
 
1293                 dbg("%s(%d) EXIT - fifo %d, PendingWrite = %d",
 
1294                                 __func__, edge_port->port->number,
 
1295                                 fifo->count, edge_port->write_in_progress);
 
1299         /* since the amount of data in the fifo will always fit into the
 
1300          * edgeport buffer we do not need to check the write length
 
1302          * Do we have enough credits for this port to make it worthwhile
 
1303          * to bother queueing a write. If it's too small, say a few bytes,
 
1304          * it's better to wait for more credits so we can do a larger write.
 
1306         if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits, EDGE_FW_BULK_MAX_PACKET_SIZE)) {
 
1307                 dbg("%s(%d) Not enough credit - fifo %d TxCredit %d",
 
1308                         __func__, edge_port->port->number, fifo->count,
 
1309                         edge_port->txCredits);
 
1313         /* lock this write */
 
1314         edge_port->write_in_progress = true;
 
1316         /* get a pointer to the write_urb */
 
1317         urb = edge_port->write_urb;
 
1319         /* make sure transfer buffer is freed */
 
1320         kfree(urb->transfer_buffer);
 
1321         urb->transfer_buffer = NULL;
 
1323         /* build the data header for the buffer and port that we are about
 
1325         count = fifo->count;
 
1326         buffer = kmalloc(count+2, GFP_ATOMIC);
 
1327         if (buffer == NULL) {
 
1328                 dev_err(&edge_port->port->dev,
 
1329                                 "%s - no more kernel memory...\n", __func__);
 
1330                 edge_port->write_in_progress = false;
 
1333         buffer[0] = IOSP_BUILD_DATA_HDR1(edge_port->port->number
 
1334                                 - edge_port->port->serial->minor, count);
 
1335         buffer[1] = IOSP_BUILD_DATA_HDR2(edge_port->port->number
 
1336                                 - edge_port->port->serial->minor, count);
 
1338         /* now copy our data */
 
1339         bytesleft =  fifo->size - fifo->tail;
 
1340         firsthalf = min(bytesleft, count);
 
1341         memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
 
1342         fifo->tail  += firsthalf;
 
1343         fifo->count -= firsthalf;
 
1344         if (fifo->tail == fifo->size)
 
1347         secondhalf = count-firsthalf;
 
1349                 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail],
 
1351                 fifo->tail  += secondhalf;
 
1352                 fifo->count -= secondhalf;
 
1356                 usb_serial_debug_data(debug, &edge_port->port->dev,
 
1357                                                 __func__, count, &buffer[2]);
 
1359         /* fill up the urb with all of our data and submit it */
 
1360         usb_fill_bulk_urb(urb, edge_serial->serial->dev,
 
1361                         usb_sndbulkpipe(edge_serial->serial->dev,
 
1362                                         edge_serial->bulk_out_endpoint),
 
1364                         edge_bulk_out_data_callback, edge_port);
 
1366         /* decrement the number of credits we have by the number we just sent */
 
1367         edge_port->txCredits -= count;
 
1368         edge_port->icount.tx += count;
 
1370         urb->dev = edge_serial->serial->dev;
 
1371         status = usb_submit_urb(urb, GFP_ATOMIC);
 
1373                 /* something went wrong */
 
1374                 dev_err(&edge_port->port->dev,
 
1375                         "%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n",
 
1377                 edge_port->write_in_progress = false;
 
1379                 /* revert the credits as something bad happened. */
 
1380                 edge_port->txCredits += count;
 
1381                 edge_port->icount.tx -= count;
 
1383         dbg("%s wrote %d byte(s) TxCredit %d, Fifo %d",
 
1384                         __func__, count, edge_port->txCredits, fifo->count);
 
1387         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
 
1391 /*****************************************************************************
 
1393  *      this function is called by the tty driver when it wants to know how
 
1394  *      many bytes of data we can accept for a specific port. If successful,
 
1395  *      we return the amount of room that we have for this port (the txCredits)
 
1396  *      otherwise we return a negative error number.
 
1397  *****************************************************************************/
 
1398 static int edge_write_room(struct tty_struct *tty)
 
1400         struct usb_serial_port *port = tty->driver_data;
 
1401         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1403         unsigned long flags;
 
1405         dbg("%s", __func__);
 
1407         if (edge_port == NULL)
 
1409         if (edge_port->closePending)
 
1412         dbg("%s - port %d", __func__, port->number);
 
1414         if (!edge_port->open) {
 
1415                 dbg("%s - port not opened", __func__);
 
1419         /* total of both buffers is still txCredit */
 
1420         spin_lock_irqsave(&edge_port->ep_lock, flags);
 
1421         room = edge_port->txCredits - edge_port->txfifo.count;
 
1422         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
 
1424         dbg("%s - returns %d", __func__, room);
 
1429 /*****************************************************************************
 
1430  * edge_chars_in_buffer
 
1431  *      this function is called by the tty driver when it wants to know how
 
1432  *      many bytes of data we currently have outstanding in the port (data that
 
1433  *      has been written, but hasn't made it out the port yet)
 
1434  *      If successful, we return the number of bytes left to be written in the
 
1436  *      Otherwise we return a negative error number.
 
1437  *****************************************************************************/
 
1438 static int edge_chars_in_buffer(struct tty_struct *tty)
 
1440         struct usb_serial_port *port = tty->driver_data;
 
1441         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1443         unsigned long flags;
 
1445         dbg("%s", __func__);
 
1447         if (edge_port == NULL)
 
1449         if (edge_port->closePending)
 
1452         if (!edge_port->open) {
 
1453                 dbg("%s - port not opened", __func__);
 
1457         spin_lock_irqsave(&edge_port->ep_lock, flags);
 
1458         num_chars = edge_port->maxTxCredits - edge_port->txCredits +
 
1459                                                 edge_port->txfifo.count;
 
1460         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
 
1462                 dbg("%s(port %d) - returns %d", __func__,
 
1463                                                 port->number, num_chars);
 
1470 /*****************************************************************************
 
1472  *      this function is called by the tty driver when it wants to stop the data
 
1473  *      being read from the port.
 
1474  *****************************************************************************/
 
1475 static void edge_throttle(struct tty_struct *tty)
 
1477         struct usb_serial_port *port = tty->driver_data;
 
1478         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1481         dbg("%s - port %d", __func__, port->number);
 
1483         if (edge_port == NULL)
 
1486         if (!edge_port->open) {
 
1487                 dbg("%s - port not opened", __func__);
 
1491         /* if we are implementing XON/XOFF, send the stop character */
 
1493                 unsigned char stop_char = STOP_CHAR(tty);
 
1494                 status = edge_write(tty, port, &stop_char, 1);
 
1499         /* if we are implementing RTS/CTS, toggle that line */
 
1500         if (tty->termios->c_cflag & CRTSCTS) {
 
1501                 edge_port->shadowMCR &= ~MCR_RTS;
 
1502                 status = send_cmd_write_uart_register(edge_port, MCR,
 
1503                                                         edge_port->shadowMCR);
 
1512 /*****************************************************************************
 
1514  *      this function is called by the tty driver when it wants to resume the
 
1515  *      data being read from the port (called after SerialThrottle is called)
 
1516  *****************************************************************************/
 
1517 static void edge_unthrottle(struct tty_struct *tty)
 
1519         struct usb_serial_port *port = tty->driver_data;
 
1520         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1523         dbg("%s - port %d", __func__, port->number);
 
1525         if (edge_port == NULL)
 
1528         if (!edge_port->open) {
 
1529                 dbg("%s - port not opened", __func__);
 
1533         /* if we are implementing XON/XOFF, send the start character */
 
1535                 unsigned char start_char = START_CHAR(tty);
 
1536                 status = edge_write(tty, port, &start_char, 1);
 
1540         /* if we are implementing RTS/CTS, toggle that line */
 
1541         if (tty->termios->c_cflag & CRTSCTS) {
 
1542                 edge_port->shadowMCR |= MCR_RTS;
 
1543                 send_cmd_write_uart_register(edge_port, MCR,
 
1544                                                 edge_port->shadowMCR);
 
1549 /*****************************************************************************
 
1551  *      this function is called by the tty driver when it wants to change
 
1552  * the termios structure
 
1553  *****************************************************************************/
 
1554 static void edge_set_termios(struct tty_struct *tty,
 
1555         struct usb_serial_port *port, struct ktermios *old_termios)
 
1557         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1560         cflag = tty->termios->c_cflag;
 
1561         dbg("%s - clfag %08x iflag %08x", __func__,
 
1562             tty->termios->c_cflag, tty->termios->c_iflag);
 
1563         dbg("%s - old clfag %08x old iflag %08x", __func__,
 
1564             old_termios->c_cflag, old_termios->c_iflag);
 
1566         dbg("%s - port %d", __func__, port->number);
 
1568         if (edge_port == NULL)
 
1571         if (!edge_port->open) {
 
1572                 dbg("%s - port not opened", __func__);
 
1576         /* change the port settings to the new ones specified */
 
1577         change_port_settings(tty, edge_port, old_termios);
 
1581 /*****************************************************************************
 
1582  * get_lsr_info - get line status register info
 
1584  * Purpose: Let user call ioctl() to get info when the UART physically
 
1585  *          is emptied.  On bus types like RS485, the transmitter must
 
1586  *          release the bus after transmitting. This must be done when
 
1587  *          the transmit shift register is empty, not be done when the
 
1588  *          transmit holding register is empty.  This functionality
 
1589  *          allows an RS485 driver to be written in user space.
 
1590  *****************************************************************************/
 
1591 static int get_lsr_info(struct edgeport_port *edge_port,
 
1592                                                 unsigned int __user *value)
 
1594         unsigned int result = 0;
 
1595         unsigned long flags;
 
1597         spin_lock_irqsave(&edge_port->ep_lock, flags);
 
1598         if (edge_port->maxTxCredits == edge_port->txCredits &&
 
1599             edge_port->txfifo.count == 0) {
 
1600                 dbg("%s -- Empty", __func__);
 
1601                 result = TIOCSER_TEMT;
 
1603         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
 
1605         if (copy_to_user(value, &result, sizeof(int)))
 
1610 static int edge_tiocmset(struct tty_struct *tty, struct file *file,
 
1611                                         unsigned int set, unsigned int clear)
 
1613         struct usb_serial_port *port = tty->driver_data;
 
1614         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1617         dbg("%s - port %d", __func__, port->number);
 
1619         mcr = edge_port->shadowMCR;
 
1620         if (set & TIOCM_RTS)
 
1622         if (set & TIOCM_DTR)
 
1624         if (set & TIOCM_LOOP)
 
1625                 mcr |= MCR_LOOPBACK;
 
1627         if (clear & TIOCM_RTS)
 
1629         if (clear & TIOCM_DTR)
 
1631         if (clear & TIOCM_LOOP)
 
1632                 mcr &= ~MCR_LOOPBACK;
 
1634         edge_port->shadowMCR = mcr;
 
1636         send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
 
1641 static int edge_tiocmget(struct tty_struct *tty, struct file *file)
 
1643         struct usb_serial_port *port = tty->driver_data;
 
1644         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1645         unsigned int result = 0;
 
1649         dbg("%s - port %d", __func__, port->number);
 
1651         msr = edge_port->shadowMSR;
 
1652         mcr = edge_port->shadowMCR;
 
1653         result = ((mcr & MCR_DTR)       ? TIOCM_DTR: 0)   /* 0x002 */
 
1654                   | ((mcr & MCR_RTS)    ? TIOCM_RTS: 0)   /* 0x004 */
 
1655                   | ((msr & EDGEPORT_MSR_CTS)   ? TIOCM_CTS: 0)   /* 0x020 */
 
1656                   | ((msr & EDGEPORT_MSR_CD)    ? TIOCM_CAR: 0)   /* 0x040 */
 
1657                   | ((msr & EDGEPORT_MSR_RI)    ? TIOCM_RI:  0)   /* 0x080 */
 
1658                   | ((msr & EDGEPORT_MSR_DSR)   ? TIOCM_DSR: 0);  /* 0x100 */
 
1661         dbg("%s -- %x", __func__, result);
 
1666 static int get_serial_info(struct edgeport_port *edge_port,
 
1667                                 struct serial_struct __user *retinfo)
 
1669         struct serial_struct tmp;
 
1674         memset(&tmp, 0, sizeof(tmp));
 
1676         tmp.type                = PORT_16550A;
 
1677         tmp.line                = edge_port->port->serial->minor;
 
1678         tmp.port                = edge_port->port->number;
 
1680         tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
 
1681         tmp.xmit_fifo_size      = edge_port->maxTxCredits;
 
1682         tmp.baud_base           = 9600;
 
1683         tmp.close_delay         = 5*HZ;
 
1684         tmp.closing_wait        = 30*HZ;
 
1686         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
 
1693 /*****************************************************************************
 
1695  *      this function handles any ioctl calls to the driver
 
1696  *****************************************************************************/
 
1697 static int edge_ioctl(struct tty_struct *tty, struct file *file,
 
1698                                         unsigned int cmd, unsigned long arg)
 
1700         struct usb_serial_port *port = tty->driver_data;
 
1702         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1703         struct async_icount cnow;
 
1704         struct async_icount cprev;
 
1705         struct serial_icounter_struct icount;
 
1707         dbg("%s - port %d, cmd = 0x%x", __func__, port->number, cmd);
 
1711                 dbg("%s (%d) TIOCSERGETLSR", __func__,  port->number);
 
1712                 return get_lsr_info(edge_port, (unsigned int __user *) arg);
 
1715                 dbg("%s (%d) TIOCGSERIAL", __func__,  port->number);
 
1716                 return get_serial_info(edge_port, (struct serial_struct __user *) arg);
 
1719                 dbg("%s (%d) TIOCMIWAIT", __func__,  port->number);
 
1720                 cprev = edge_port->icount;
 
1722                         prepare_to_wait(&edge_port->delta_msr_wait,
 
1723                                                 &wait, TASK_INTERRUPTIBLE);
 
1725                         finish_wait(&edge_port->delta_msr_wait, &wait);
 
1726                         /* see if a signal did it */
 
1727                         if (signal_pending(current))
 
1728                                 return -ERESTARTSYS;
 
1729                         cnow = edge_port->icount;
 
1730                         if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
 
1731                             cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
 
1732                                 return -EIO; /* no change => error */
 
1733                         if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
 
1734                             ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
 
1735                             ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
 
1736                             ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
 
1745                 cnow = edge_port->icount;
 
1746                 memset(&icount, 0, sizeof(icount));
 
1747                 icount.cts = cnow.cts;
 
1748                 icount.dsr = cnow.dsr;
 
1749                 icount.rng = cnow.rng;
 
1750                 icount.dcd = cnow.dcd;
 
1751                 icount.rx = cnow.rx;
 
1752                 icount.tx = cnow.tx;
 
1753                 icount.frame = cnow.frame;
 
1754                 icount.overrun = cnow.overrun;
 
1755                 icount.parity = cnow.parity;
 
1756                 icount.brk = cnow.brk;
 
1757                 icount.buf_overrun = cnow.buf_overrun;
 
1759                 dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d",
 
1760                                 __func__,  port->number, icount.rx, icount.tx);
 
1761                 if (copy_to_user((void __user *)arg, &icount, sizeof(icount)))
 
1765         return -ENOIOCTLCMD;
 
1769 /*****************************************************************************
 
1771  *      this function sends a break to the port
 
1772  *****************************************************************************/
 
1773 static void edge_break(struct tty_struct *tty, int break_state)
 
1775         struct usb_serial_port *port = tty->driver_data;
 
1776         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
 
1777         struct edgeport_serial *edge_serial = usb_get_serial_data(port->serial);
 
1780         if ((!edge_serial->is_epic) ||
 
1781             ((edge_serial->is_epic) &&
 
1782              (edge_serial->epic_descriptor.Supports.IOSPChase))) {
 
1783                 /* flush and chase */
 
1784                 edge_port->chaseResponsePending = true;
 
1786                 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __func__);
 
1787                 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
 
1789                         /* block until chase finished */
 
1790                         block_until_chase_response(edge_port);
 
1792                         edge_port->chaseResponsePending = false;
 
1796         if ((!edge_serial->is_epic) ||
 
1797             ((edge_serial->is_epic) &&
 
1798              (edge_serial->epic_descriptor.Supports.IOSPSetClrBreak))) {
 
1799                 if (break_state == -1) {
 
1800                         dbg("%s - Sending IOSP_CMD_SET_BREAK", __func__);
 
1801                         status = send_iosp_ext_cmd(edge_port,
 
1802                                                 IOSP_CMD_SET_BREAK, 0);
 
1804                         dbg("%s - Sending IOSP_CMD_CLEAR_BREAK", __func__);
 
1805                         status = send_iosp_ext_cmd(edge_port,
 
1806                                                 IOSP_CMD_CLEAR_BREAK, 0);
 
1809                         dbg("%s - error sending break set/clear command.",
 
1817 /*****************************************************************************
 
1819  *      this function handles the data received on the bulk in pipe.
 
1820  *****************************************************************************/
 
1821 static void process_rcvd_data(struct edgeport_serial *edge_serial,
 
1822                                 unsigned char *buffer, __u16 bufferLength)
 
1824         struct usb_serial_port *port;
 
1825         struct edgeport_port *edge_port;
 
1826         struct tty_struct *tty;
 
1827         __u16 lastBufferLength;
 
1830         dbg("%s", __func__);
 
1832         lastBufferLength = bufferLength + 1;
 
1834         while (bufferLength > 0) {
 
1835                 /* failsafe incase we get a message that we don't understand */
 
1836                 if (lastBufferLength == bufferLength) {
 
1837                         dbg("%s - stuck in loop, exiting it.", __func__);
 
1840                 lastBufferLength = bufferLength;
 
1842                 switch (edge_serial->rxState) {
 
1844                         edge_serial->rxHeader1 = *buffer;
 
1848                         if (bufferLength == 0) {
 
1849                                 edge_serial->rxState = EXPECT_HDR2;
 
1852                         /* otherwise, drop on through */
 
1854                         edge_serial->rxHeader2 = *buffer;
 
1858                         dbg("%s - Hdr1=%02X Hdr2=%02X", __func__,
 
1859                             edge_serial->rxHeader1, edge_serial->rxHeader2);
 
1860                         /* Process depending on whether this header is
 
1863                         if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
 
1864                                 /* Decode this status header and go to
 
1865                                  * EXPECT_HDR1 (if we can process the status
 
1866                                  * with only 2 bytes), or go to EXPECT_HDR3 to
 
1867                                  * get the third byte. */
 
1868                                 edge_serial->rxPort =
 
1869                                     IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
 
1870                                 edge_serial->rxStatusCode =
 
1871                                     IOSP_GET_STATUS_CODE(
 
1872                                                 edge_serial->rxHeader1);
 
1874                                 if (!IOSP_STATUS_IS_2BYTE(
 
1875                                                 edge_serial->rxStatusCode)) {
 
1876                                         /* This status needs additional bytes.
 
1877                                          * Save what we have and then wait for
 
1880                                         edge_serial->rxStatusParam
 
1881                                                 = edge_serial->rxHeader2;
 
1882                                         edge_serial->rxState = EXPECT_HDR3;
 
1885                                 /* We have all the header bytes, process the
 
1887                                 process_rcvd_status(edge_serial,
 
1888                                                 edge_serial->rxHeader2, 0);
 
1889                                 edge_serial->rxState = EXPECT_HDR1;
 
1892                                 edge_serial->rxPort =
 
1893                                     IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
 
1894                                 edge_serial->rxBytesRemaining =
 
1895                                     IOSP_GET_HDR_DATA_LEN(
 
1896                                                 edge_serial->rxHeader1,
 
1897                                                 edge_serial->rxHeader2);
 
1898                                 dbg("%s - Data for Port %u Len %u",
 
1900                                                 edge_serial->rxPort,
 
1901                                                 edge_serial->rxBytesRemaining);
 
1903                                 /* ASSERT(DevExt->RxPort < DevExt->NumPorts);
 
1904                                  * ASSERT(DevExt->RxBytesRemaining <
 
1905                                  *              IOSP_MAX_DATA_LENGTH);
 
1908                                 if (bufferLength == 0) {
 
1909                                         edge_serial->rxState = EXPECT_DATA;
 
1912                                 /* Else, drop through */
 
1914                 case EXPECT_DATA: /* Expect data */
 
1915                         if (bufferLength < edge_serial->rxBytesRemaining) {
 
1916                                 rxLen = bufferLength;
 
1917                                 /* Expect data to start next buffer */
 
1918                                 edge_serial->rxState = EXPECT_DATA;
 
1920                                 /* BufLen >= RxBytesRemaining */
 
1921                                 rxLen = edge_serial->rxBytesRemaining;
 
1922                                 /* Start another header next time */
 
1923                                 edge_serial->rxState = EXPECT_HDR1;
 
1926                         bufferLength -= rxLen;
 
1927                         edge_serial->rxBytesRemaining -= rxLen;
 
1929                         /* spit this data back into the tty driver if this
 
1932                                 port = edge_serial->serial->port[
 
1933                                                         edge_serial->rxPort];
 
1934                                 edge_port = usb_get_serial_port_data(port);
 
1935                                 if (edge_port->open) {
 
1936                                         tty = tty_port_tty_get(
 
1937                                                 &edge_port->port->port);
 
1939                                                 dbg("%s - Sending %d bytes to TTY for port %d",
 
1940                                                         __func__, rxLen, edge_serial->rxPort);
 
1941                                                 edge_tty_recv(&edge_serial->serial->dev->dev, tty, buffer, rxLen);
 
1944                                         edge_port->icount.rx += rxLen;
 
1950                 case EXPECT_HDR3:       /* Expect 3rd byte of status header */
 
1951                         edge_serial->rxHeader3 = *buffer;
 
1955                         /* We have all the header bytes, process the
 
1957                         process_rcvd_status(edge_serial,
 
1958                                 edge_serial->rxStatusParam,
 
1959                                 edge_serial->rxHeader3);
 
1960                         edge_serial->rxState = EXPECT_HDR1;
 
1967 /*****************************************************************************
 
1968  * process_rcvd_status
 
1969  *      this function handles the any status messages received on the
 
1971  *****************************************************************************/
 
1972 static void process_rcvd_status(struct edgeport_serial *edge_serial,
 
1973                                                 __u8 byte2, __u8 byte3)
 
1975         struct usb_serial_port *port;
 
1976         struct edgeport_port *edge_port;
 
1977         struct tty_struct *tty;
 
1978         __u8 code = edge_serial->rxStatusCode;
 
1980         /* switch the port pointer to the one being currently talked about */
 
1981         port = edge_serial->serial->port[edge_serial->rxPort];
 
1982         edge_port = usb_get_serial_port_data(port);
 
1983         if (edge_port == NULL) {
 
1984                 dev_err(&edge_serial->serial->dev->dev,
 
1985                         "%s - edge_port == NULL for port %d\n",
 
1986                                         __func__, edge_serial->rxPort);
 
1990         dbg("%s - port %d", __func__, edge_serial->rxPort);
 
1992         if (code == IOSP_EXT_STATUS) {
 
1994                 case IOSP_EXT_STATUS_CHASE_RSP:
 
1995                         /* we want to do EXT status regardless of port
 
1997                         dbg("%s - Port %u EXT CHASE_RSP Data = %02x",
 
1998                                         __func__, edge_serial->rxPort, byte3);
 
1999                         /* Currently, the only EXT_STATUS is Chase, so process
 
2000                          * here instead of one more call to one more subroutine
 
2001                          * If/when more EXT_STATUS, there'll be more work to do
 
2002                          * Also, we currently clear flag and close the port
 
2003                          * regardless of content of above's Byte3.
 
2004                          * We could choose to do something else when Byte3 says
 
2005                          * Timeout on Chase from Edgeport, like wait longer in
 
2006                          * block_until_chase_response, but for now we don't.
 
2008                         edge_port->chaseResponsePending = false;
 
2009                         wake_up(&edge_port->wait_chase);
 
2012                 case IOSP_EXT_STATUS_RX_CHECK_RSP:
 
2013                         dbg("%s ========== Port %u CHECK_RSP Sequence = %02x =============\n", __func__, edge_serial->rxPort, byte3);
 
2014                         /* Port->RxCheckRsp = true; */
 
2019         if (code == IOSP_STATUS_OPEN_RSP) {
 
2020                 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
 
2021                 edge_port->maxTxCredits = edge_port->txCredits;
 
2022                 dbg("%s - Port %u Open Response Inital MSR = %02x TxBufferSize = %d", __func__, edge_serial->rxPort, byte2, edge_port->txCredits);
 
2023                 handle_new_msr(edge_port, byte2);
 
2025                 /* send the current line settings to the port so we are
 
2026                    in sync with any further termios calls */
 
2027                 tty = tty_port_tty_get(&edge_port->port->port);
 
2029                         change_port_settings(tty,
 
2030                                 edge_port, tty->termios);
 
2034                 /* we have completed the open */
 
2035                 edge_port->openPending = false;
 
2036                 edge_port->open = true;
 
2037                 wake_up(&edge_port->wait_open);
 
2041         /* If port is closed, silently discard all rcvd status. We can
 
2042          * have cases where buffered status is received AFTER the close
 
2043          * port command is sent to the Edgeport.
 
2045         if (!edge_port->open || edge_port->closePending)
 
2049         /* Not currently sent by Edgeport */
 
2050         case IOSP_STATUS_LSR:
 
2051                 dbg("%s - Port %u LSR Status = %02x",
 
2052                                         __func__, edge_serial->rxPort, byte2);
 
2053                 handle_new_lsr(edge_port, false, byte2, 0);
 
2056         case IOSP_STATUS_LSR_DATA:
 
2057                 dbg("%s - Port %u LSR Status = %02x, Data = %02x",
 
2058                                 __func__, edge_serial->rxPort, byte2, byte3);
 
2059                 /* byte2 is LSR Register */
 
2060                 /* byte3 is broken data byte */
 
2061                 handle_new_lsr(edge_port, true, byte2, byte3);
 
2064          *      case IOSP_EXT_4_STATUS:
 
2065          *              dbg("%s - Port %u LSR Status = %02x Data = %02x",
 
2066          *                      __func__, edge_serial->rxPort, byte2, byte3);
 
2069         case IOSP_STATUS_MSR:
 
2070                 dbg("%s - Port %u MSR Status = %02x",
 
2071                                         __func__, edge_serial->rxPort, byte2);
 
2073                  * Process this new modem status and generate appropriate
 
2074                  * events, etc, based on the new status. This routine
 
2075                  * also saves the MSR in Port->ShadowMsr.
 
2077                 handle_new_msr(edge_port, byte2);
 
2081                 dbg("%s - Unrecognized IOSP status code %u\n", __func__, code);
 
2088 /*****************************************************************************
 
2090  *      this function passes data on to the tty flip buffer
 
2091  *****************************************************************************/
 
2092 static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
 
2093                                         unsigned char *data, int length)
 
2098                 cnt = tty_buffer_request_room(tty, length);
 
2100                         dev_err(dev, "%s - dropping data, %d bytes lost\n",
 
2101                                         __func__, length - cnt);
 
2105                 tty_insert_flip_string(tty, data, cnt);
 
2108         } while (length > 0);
 
2110         tty_flip_buffer_push(tty);
 
2114 /*****************************************************************************
 
2116  *      this function handles any change to the msr register for a port.
 
2117  *****************************************************************************/
 
2118 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
 
2120         struct  async_icount *icount;
 
2122         dbg("%s %02x", __func__, newMsr);
 
2124         if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
 
2125                         EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
 
2126                 icount = &edge_port->icount;
 
2128                 /* update input line counters */
 
2129                 if (newMsr & EDGEPORT_MSR_DELTA_CTS)
 
2131                 if (newMsr & EDGEPORT_MSR_DELTA_DSR)
 
2133                 if (newMsr & EDGEPORT_MSR_DELTA_CD)
 
2135                 if (newMsr & EDGEPORT_MSR_DELTA_RI)
 
2137                 wake_up_interruptible(&edge_port->delta_msr_wait);
 
2140         /* Save the new modem status */
 
2141         edge_port->shadowMSR = newMsr & 0xf0;
 
2147 /*****************************************************************************
 
2149  *      this function handles any change to the lsr register for a port.
 
2150  *****************************************************************************/
 
2151 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
 
2152                                                         __u8 lsr, __u8 data)
 
2154         __u8 newLsr = (__u8) (lsr & (__u8)
 
2155                 (LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
 
2156         struct async_icount *icount;
 
2158         dbg("%s - %02x", __func__, newLsr);
 
2160         edge_port->shadowLSR = lsr;
 
2162         if (newLsr & LSR_BREAK) {
 
2164                  * Parity and Framing errors only count if they
 
2165                  * occur exclusive of a break being
 
2168                 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
 
2171         /* Place LSR data byte into Rx buffer */
 
2173                 struct tty_struct *tty =
 
2174                                 tty_port_tty_get(&edge_port->port->port);
 
2176                         edge_tty_recv(&edge_port->port->dev, tty, &data, 1);
 
2180         /* update input line counters */
 
2181         icount = &edge_port->icount;
 
2182         if (newLsr & LSR_BREAK)
 
2184         if (newLsr & LSR_OVER_ERR)
 
2186         if (newLsr & LSR_PAR_ERR)
 
2188         if (newLsr & LSR_FRM_ERR)
 
2195 /****************************************************************************
 
2197  *      writes a number of bytes to the Edgeport device's sram starting at the
 
2199  *      If successful returns the number of bytes written, otherwise it returns
 
2200  *      a negative error number of the problem.
 
2201  ****************************************************************************/
 
2202 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
 
2203                                         __u16 length, const __u8 *data)
 
2206         __u16 current_length;
 
2207         unsigned char *transfer_buffer;
 
2209         dbg("%s - %x, %x, %d", __func__, extAddr, addr, length);
 
2211         transfer_buffer =  kmalloc(64, GFP_KERNEL);
 
2212         if (!transfer_buffer) {
 
2213                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n",
 
2218         /* need to split these writes up into 64 byte chunks */
 
2220         while (length > 0) {
 
2222                         current_length = 64;
 
2224                         current_length = length;
 
2226 /*              dbg("%s - writing %x, %x, %d", __func__,
 
2227                                         extAddr, addr, current_length); */
 
2228                 memcpy(transfer_buffer, data, current_length);
 
2229                 result = usb_control_msg(serial->dev,
 
2230                                         usb_sndctrlpipe(serial->dev, 0),
 
2231                                         USB_REQUEST_ION_WRITE_RAM,
 
2232                                         0x40, addr, extAddr, transfer_buffer,
 
2233                                         current_length, 300);
 
2236                 length -= current_length;
 
2237                 addr += current_length;
 
2238                 data += current_length;
 
2241         kfree(transfer_buffer);
 
2246 /****************************************************************************
 
2248  *      writes a number of bytes to the Edgeport device's ROM starting at the
 
2250  *      If successful returns the number of bytes written, otherwise it returns
 
2251  *      a negative error number of the problem.
 
2252  ****************************************************************************/
 
2253 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
 
2254                                         __u16 length, const __u8 *data)
 
2257         __u16 current_length;
 
2258         unsigned char *transfer_buffer;
 
2260 /*      dbg("%s - %x, %x, %d", __func__, extAddr, addr, length); */
 
2262         transfer_buffer =  kmalloc(64, GFP_KERNEL);
 
2263         if (!transfer_buffer) {
 
2264                 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n",
 
2269         /* need to split these writes up into 64 byte chunks */
 
2271         while (length > 0) {
 
2273                         current_length = 64;
 
2275                         current_length = length;
 
2276 /*              dbg("%s - writing %x, %x, %d", __func__,
 
2277                                         extAddr, addr, current_length); */
 
2278                 memcpy(transfer_buffer, data, current_length);
 
2279                 result = usb_control_msg(serial->dev,
 
2280                                         usb_sndctrlpipe(serial->dev, 0),
 
2281                                         USB_REQUEST_ION_WRITE_ROM, 0x40,
 
2283                                         transfer_buffer, current_length, 300);
 
2286                 length -= current_length;
 
2287                 addr += current_length;
 
2288                 data += current_length;
 
2291         kfree(transfer_buffer);
 
2296 /****************************************************************************
 
2298  *      reads a number of bytes from the Edgeport device starting at the given
 
2300  *      If successful returns the number of bytes read, otherwise it returns
 
2301  *      a negative error number of the problem.
 
2302  ****************************************************************************/
 
2303 static int rom_read(struct usb_serial *serial, __u16 extAddr,
 
2304                                         __u16 addr, __u16 length, __u8 *data)
 
2307         __u16 current_length;
 
2308         unsigned char *transfer_buffer;
 
2310         dbg("%s - %x, %x, %d", __func__, extAddr, addr, length);
 
2312         transfer_buffer =  kmalloc(64, GFP_KERNEL);
 
2313         if (!transfer_buffer) {
 
2314                 dev_err(&serial->dev->dev,
 
2315                         "%s - kmalloc(%d) failed.\n", __func__, 64);
 
2319         /* need to split these reads up into 64 byte chunks */
 
2321         while (length > 0) {
 
2323                         current_length = 64;
 
2325                         current_length = length;
 
2326 /*              dbg("%s - %x, %x, %d", __func__,
 
2327                                 extAddr, addr, current_length); */
 
2328                 result = usb_control_msg(serial->dev,
 
2329                                         usb_rcvctrlpipe(serial->dev, 0),
 
2330                                         USB_REQUEST_ION_READ_ROM,
 
2331                                         0xC0, addr, extAddr, transfer_buffer,
 
2332                                         current_length, 300);
 
2335                 memcpy(data, transfer_buffer, current_length);
 
2336                 length -= current_length;
 
2337                 addr += current_length;
 
2338                 data += current_length;
 
2341         kfree(transfer_buffer);
 
2346 /****************************************************************************
 
2348  *      Is used to send a IOSP message to the Edgeport device
 
2349  ****************************************************************************/
 
2350 static int send_iosp_ext_cmd(struct edgeport_port *edge_port,
 
2351                                                 __u8 command, __u8 param)
 
2353         unsigned char   *buffer;
 
2354         unsigned char   *currentCommand;
 
2358         dbg("%s - %d, %d", __func__, command, param);
 
2360         buffer = kmalloc(10, GFP_ATOMIC);
 
2362                 dev_err(&edge_port->port->dev,
 
2363                                 "%s - kmalloc(%d) failed.\n", __func__, 10);
 
2367         currentCommand = buffer;
 
2369         MAKE_CMD_EXT_CMD(¤tCommand, &length,
 
2370                 edge_port->port->number - edge_port->port->serial->minor,
 
2373         status = write_cmd_usb(edge_port, buffer, length);
 
2375                 /* something bad happened, let's free up the memory */
 
2383 /*****************************************************************************
 
2385  *      this function writes the given buffer out to the bulk write endpoint.
 
2386  *****************************************************************************/
 
2387 static int write_cmd_usb(struct edgeport_port *edge_port,
 
2388                                         unsigned char *buffer, int length)
 
2390         struct edgeport_serial *edge_serial =
 
2391                                 usb_get_serial_data(edge_port->port->serial);
 
2396         usb_serial_debug_data(debug, &edge_port->port->dev,
 
2397                                                 __func__, length, buffer);
 
2399         /* Allocate our next urb */
 
2400         urb = usb_alloc_urb(0, GFP_ATOMIC);
 
2404         atomic_inc(&CmdUrbs);
 
2405         dbg("%s - ALLOCATE URB %p (outstanding %d)",
 
2406                                 __func__, urb, atomic_read(&CmdUrbs));
 
2408         usb_fill_bulk_urb(urb, edge_serial->serial->dev,
 
2409                         usb_sndbulkpipe(edge_serial->serial->dev,
 
2410                                         edge_serial->bulk_out_endpoint),
 
2411                         buffer, length, edge_bulk_out_cmd_callback, edge_port);
 
2413         edge_port->commandPending = true;
 
2414         status = usb_submit_urb(urb, GFP_ATOMIC);
 
2417                 /* something went wrong */
 
2418                 dev_err(&edge_port->port->dev,
 
2419                     "%s - usb_submit_urb(write command) failed, status = %d\n",
 
2423                 atomic_dec(&CmdUrbs);
 
2427         /* wait for command to finish */
 
2428         timeout = COMMAND_TIMEOUT;
 
2430         wait_event(&edge_port->wait_command, !edge_port->commandPending);
 
2432         if (edge_port->commandPending) {
 
2433                 /* command timed out */
 
2434                 dbg("%s - command timed out", __func__);
 
2442 /*****************************************************************************
 
2443  * send_cmd_write_baud_rate
 
2444  *      this function sends the proper command to change the baud rate of the
 
2446  *****************************************************************************/
 
2447 static int send_cmd_write_baud_rate(struct edgeport_port *edge_port,
 
2450         struct edgeport_serial *edge_serial =
 
2451                                 usb_get_serial_data(edge_port->port->serial);
 
2452         unsigned char *cmdBuffer;
 
2453         unsigned char *currCmd;
 
2457         unsigned char number =
 
2458                 edge_port->port->number - edge_port->port->serial->minor;
 
2460         if (edge_serial->is_epic &&
 
2461             !edge_serial->epic_descriptor.Supports.IOSPSetBaudRate) {
 
2462                 dbg("SendCmdWriteBaudRate - NOT Setting baud rate for port = %d, baud = %d",
 
2463                     edge_port->port->number, baudRate);
 
2467         dbg("%s - port = %d, baud = %d", __func__,
 
2468                                         edge_port->port->number, baudRate);
 
2470         status = calc_baud_rate_divisor(baudRate, &divisor);
 
2472                 dev_err(&edge_port->port->dev, "%s - bad baud rate\n",
 
2477         /* Alloc memory for the string of commands. */
 
2478         cmdBuffer =  kmalloc(0x100, GFP_ATOMIC);
 
2480                 dev_err(&edge_port->port->dev,
 
2481                         "%s - kmalloc(%d) failed.\n", __func__, 0x100);
 
2484         currCmd = cmdBuffer;
 
2486         /* Enable access to divisor latch */
 
2487         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE);
 
2489         /* Write the divisor itself */
 
2490         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLL, LOW8(divisor));
 
2491         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLM, HIGH8(divisor));
 
2493         /* Restore original value to disable access to divisor latch */
 
2494         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR,
 
2495                                                 edge_port->shadowLCR);
 
2497         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
 
2499                 /* something bad happened, let's free up the memory */
 
2507 /*****************************************************************************
 
2508  * calc_baud_rate_divisor
 
2509  *      this function calculates the proper baud rate divisor for the specified
 
2511  *****************************************************************************/
 
2512 static int calc_baud_rate_divisor(int baudrate, int *divisor)
 
2518         dbg("%s - %d", __func__, baudrate);
 
2520         for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
 
2521                 if (divisor_table[i].BaudRate == baudrate) {
 
2522                         *divisor = divisor_table[i].Divisor;
 
2527         /* We have tried all of the standard baud rates
 
2528          * lets try to calculate the divisor for this baud rate
 
2529          * Make sure the baud rate is reasonable */
 
2530         if (baudrate > 50 && baudrate < 230400) {
 
2532                 custom = (__u16)((230400L + baudrate/2) / baudrate);
 
2536                 dbg("%s - Baud %d = %d\n", __func__, baudrate, custom);
 
2544 /*****************************************************************************
 
2545  * send_cmd_write_uart_register
 
2546  *  this function builds up a uart register message and sends to to the device.
 
2547  *****************************************************************************/
 
2548 static int send_cmd_write_uart_register(struct edgeport_port *edge_port,
 
2549                                                 __u8 regNum, __u8 regValue)
 
2551         struct edgeport_serial *edge_serial =
 
2552                                 usb_get_serial_data(edge_port->port->serial);
 
2553         unsigned char *cmdBuffer;
 
2554         unsigned char *currCmd;
 
2555         unsigned long cmdLen = 0;
 
2558         dbg("%s - write to %s register 0x%02x",
 
2559                         (regNum == MCR) ? "MCR" : "LCR", __func__, regValue);
 
2561         if (edge_serial->is_epic &&
 
2562             !edge_serial->epic_descriptor.Supports.IOSPWriteMCR &&
 
2564                 dbg("SendCmdWriteUartReg - Not writing to MCR Register");
 
2568         if (edge_serial->is_epic &&
 
2569             !edge_serial->epic_descriptor.Supports.IOSPWriteLCR &&
 
2571                 dbg("SendCmdWriteUartReg - Not writing to LCR Register");
 
2575         /* Alloc memory for the string of commands. */
 
2576         cmdBuffer = kmalloc(0x10, GFP_ATOMIC);
 
2577         if (cmdBuffer == NULL)
 
2580         currCmd = cmdBuffer;
 
2582         /* Build a cmd in the buffer to write the given register */
 
2583         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen,
 
2584                 edge_port->port->number - edge_port->port->serial->minor,
 
2587         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
 
2589                 /* something bad happened, let's free up the memory */
 
2597 /*****************************************************************************
 
2598  * change_port_settings
 
2599  *      This routine is called to set the UART on the device to match the
 
2600  *      specified new settings.
 
2601  *****************************************************************************/
 
2603 static void change_port_settings(struct tty_struct *tty,
 
2604         struct edgeport_port *edge_port, struct ktermios *old_termios)
 
2606         struct edgeport_serial *edge_serial =
 
2607                         usb_get_serial_data(edge_port->port->serial);
 
2618         dbg("%s - port %d", __func__, edge_port->port->number);
 
2620         if (!edge_port->open &&
 
2621             !edge_port->openPending) {
 
2622                 dbg("%s - port not opened", __func__);
 
2626         cflag = tty->termios->c_cflag;
 
2628         switch (cflag & CSIZE) {
 
2630                 lData = LCR_BITS_5; mask = 0x1f;
 
2631                 dbg("%s - data bits = 5", __func__);
 
2634                 lData = LCR_BITS_6; mask = 0x3f;
 
2635                 dbg("%s - data bits = 6", __func__);
 
2638                 lData = LCR_BITS_7; mask = 0x7f;
 
2639                 dbg("%s - data bits = 7", __func__);
 
2644                 dbg("%s - data bits = 8", __func__);
 
2648         lParity = LCR_PAR_NONE;
 
2649         if (cflag & PARENB) {
 
2650                 if (cflag & CMSPAR) {
 
2651                         if (cflag & PARODD) {
 
2652                                 lParity = LCR_PAR_MARK;
 
2653                                 dbg("%s - parity = mark", __func__);
 
2655                                 lParity = LCR_PAR_SPACE;
 
2656                                 dbg("%s - parity = space", __func__);
 
2658                 } else if (cflag & PARODD) {
 
2659                         lParity = LCR_PAR_ODD;
 
2660                         dbg("%s - parity = odd", __func__);
 
2662                         lParity = LCR_PAR_EVEN;
 
2663                         dbg("%s - parity = even", __func__);
 
2666                 dbg("%s - parity = none", __func__);
 
2669         if (cflag & CSTOPB) {
 
2671                 dbg("%s - stop bits = 2", __func__);
 
2674                 dbg("%s - stop bits = 1", __func__);
 
2677         /* figure out the flow control settings */
 
2678         rxFlow = txFlow = 0x00;
 
2679         if (cflag & CRTSCTS) {
 
2680                 rxFlow |= IOSP_RX_FLOW_RTS;
 
2681                 txFlow |= IOSP_TX_FLOW_CTS;
 
2682                 dbg("%s - RTS/CTS is enabled", __func__);
 
2684                 dbg("%s - RTS/CTS is disabled", __func__);
 
2687         /* if we are implementing XON/XOFF, set the start and stop character
 
2689         if (I_IXOFF(tty) || I_IXON(tty)) {
 
2690                 unsigned char stop_char  = STOP_CHAR(tty);
 
2691                 unsigned char start_char = START_CHAR(tty);
 
2693                 if ((!edge_serial->is_epic) ||
 
2694                     ((edge_serial->is_epic) &&
 
2695                      (edge_serial->epic_descriptor.Supports.IOSPSetXChar))) {
 
2696                         send_iosp_ext_cmd(edge_port,
 
2697                                         IOSP_CMD_SET_XON_CHAR, start_char);
 
2698                         send_iosp_ext_cmd(edge_port,
 
2699                                         IOSP_CMD_SET_XOFF_CHAR, stop_char);
 
2702                 /* if we are implementing INBOUND XON/XOFF */
 
2704                         rxFlow |= IOSP_RX_FLOW_XON_XOFF;
 
2705                         dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
 
2706                                         __func__, start_char, stop_char);
 
2708                         dbg("%s - INBOUND XON/XOFF is disabled", __func__);
 
2711                 /* if we are implementing OUTBOUND XON/XOFF */
 
2713                         txFlow |= IOSP_TX_FLOW_XON_XOFF;
 
2714                         dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
 
2715                                         __func__, start_char, stop_char);
 
2717                         dbg("%s - OUTBOUND XON/XOFF is disabled", __func__);
 
2721         /* Set flow control to the configured value */
 
2722         if ((!edge_serial->is_epic) ||
 
2723             ((edge_serial->is_epic) &&
 
2724              (edge_serial->epic_descriptor.Supports.IOSPSetRxFlow)))
 
2725                 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
 
2726         if ((!edge_serial->is_epic) ||
 
2727             ((edge_serial->is_epic) &&
 
2728              (edge_serial->epic_descriptor.Supports.IOSPSetTxFlow)))
 
2729                 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
 
2732         edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
 
2733         edge_port->shadowLCR |= (lData | lParity | lStop);
 
2735         edge_port->validDataMask = mask;
 
2737         /* Send the updated LCR value to the EdgePort */
 
2738         status = send_cmd_write_uart_register(edge_port, LCR,
 
2739                                                         edge_port->shadowLCR);
 
2743         /* set up the MCR register and send it to the EdgePort */
 
2744         edge_port->shadowMCR = MCR_MASTER_IE;
 
2746                 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
 
2748         status = send_cmd_write_uart_register(edge_port, MCR,
 
2749                                                 edge_port->shadowMCR);
 
2753         /* Determine divisor based on baud rate */
 
2754         baud = tty_get_baud_rate(tty);
 
2756                 /* pick a default, any default... */
 
2760         dbg("%s - baud rate = %d", __func__, baud);
 
2761         status = send_cmd_write_baud_rate(edge_port, baud);
 
2763                 /* Speed change was not possible - put back the old speed */
 
2764                 baud = tty_termios_baud_rate(old_termios);
 
2765                 tty_encode_baud_rate(tty, baud, baud);
 
2771 /****************************************************************************
 
2773  *      Turns a string from Unicode into ASCII.
 
2774  *      Doesn't do a good job with any characters that are outside the normal
 
2775  *      ASCII range, but it's only for debugging...
 
2776  *      NOTE: expects the unicode in LE format
 
2777  ****************************************************************************/
 
2778 static void unicode_to_ascii(char *string, int buflen,
 
2779                                         __le16 *unicode, int unicode_size)
 
2783         if (buflen <= 0)        /* never happens, but... */
 
2785         --buflen;               /* space for nul */
 
2787         for (i = 0; i < unicode_size; i++) {
 
2790                 string[i] = (char)(le16_to_cpu(unicode[i]));
 
2796 /****************************************************************************
 
2797  * get_manufacturing_desc
 
2798  *      reads in the manufacturing descriptor and stores it into the serial
 
2800  ****************************************************************************/
 
2801 static void get_manufacturing_desc(struct edgeport_serial *edge_serial)
 
2805         dbg("getting manufacturer descriptor");
 
2807         response = rom_read(edge_serial->serial,
 
2808                                 (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
 
2809                                 (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff),
 
2810                                 EDGE_MANUF_DESC_LEN,
 
2811                                 (__u8 *)(&edge_serial->manuf_descriptor));
 
2814                 dev_err(&edge_serial->serial->dev->dev,
 
2815                         "error in getting manufacturer descriptor\n");
 
2818                 dbg("**Manufacturer Descriptor");
 
2819                 dbg("  RomSize:        %dK",
 
2820                         edge_serial->manuf_descriptor.RomSize);
 
2821                 dbg("  RamSize:        %dK",
 
2822                         edge_serial->manuf_descriptor.RamSize);
 
2824                         edge_serial->manuf_descriptor.CpuRev);
 
2825                 dbg("  BoardRev:       %d",
 
2826                         edge_serial->manuf_descriptor.BoardRev);
 
2827                 dbg("  NumPorts:       %d",
 
2828                         edge_serial->manuf_descriptor.NumPorts);
 
2829                 dbg("  DescDate:       %d/%d/%d",
 
2830                         edge_serial->manuf_descriptor.DescDate[0],
 
2831                         edge_serial->manuf_descriptor.DescDate[1],
 
2832                         edge_serial->manuf_descriptor.DescDate[2]+1900);
 
2833                 unicode_to_ascii(string, sizeof(string),
 
2834                         edge_serial->manuf_descriptor.SerialNumber,
 
2835                         edge_serial->manuf_descriptor.SerNumLength/2);
 
2836                 dbg("  SerialNumber: %s", string);
 
2837                 unicode_to_ascii(string, sizeof(string),
 
2838                         edge_serial->manuf_descriptor.AssemblyNumber,
 
2839                         edge_serial->manuf_descriptor.AssemblyNumLength/2);
 
2840                 dbg("  AssemblyNumber: %s", string);
 
2841                 unicode_to_ascii(string, sizeof(string),
 
2842                     edge_serial->manuf_descriptor.OemAssyNumber,
 
2843                     edge_serial->manuf_descriptor.OemAssyNumLength/2);
 
2844                 dbg("  OemAssyNumber:  %s", string);
 
2845                 dbg("  UartType:       %d",
 
2846                         edge_serial->manuf_descriptor.UartType);
 
2848                         edge_serial->manuf_descriptor.IonPid);
 
2849                 dbg("  IonConfig:      %d",
 
2850                         edge_serial->manuf_descriptor.IonConfig);
 
2855 /****************************************************************************
 
2857  *      reads in the bootloader descriptor and stores it into the serial
 
2859  ****************************************************************************/
 
2860 static void get_boot_desc(struct edgeport_serial *edge_serial)
 
2864         dbg("getting boot descriptor");
 
2866         response = rom_read(edge_serial->serial,
 
2867                                 (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
 
2868                                 (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff),
 
2870                                 (__u8 *)(&edge_serial->boot_descriptor));
 
2873                 dev_err(&edge_serial->serial->dev->dev,
 
2874                                 "error in getting boot descriptor\n");
 
2876                 dbg("**Boot Descriptor:");
 
2877                 dbg("  BootCodeLength: %d",
 
2878                     le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
 
2879                 dbg("  MajorVersion:   %d",
 
2880                         edge_serial->boot_descriptor.MajorVersion);
 
2881                 dbg("  MinorVersion:   %d",
 
2882                         edge_serial->boot_descriptor.MinorVersion);
 
2883                 dbg("  BuildNumber:    %d",
 
2884                         le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
 
2885                 dbg("  Capabilities:   0x%x",
 
2886                       le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
 
2887                 dbg("  UConfig0:       %d",
 
2888                         edge_serial->boot_descriptor.UConfig0);
 
2889                 dbg("  UConfig1:       %d",
 
2890                         edge_serial->boot_descriptor.UConfig1);
 
2895 /****************************************************************************
 
2896  * load_application_firmware
 
2897  *      This is called to load the application firmware to the device
 
2898  ****************************************************************************/
 
2899 static void load_application_firmware(struct edgeport_serial *edge_serial)
 
2901         const struct ihex_binrec *rec;
 
2902         const struct firmware *fw;
 
2903         const char *fw_name;
 
2904         const char *fw_info;
 
2909         switch (edge_serial->product_info.iDownloadFile) {
 
2910                 case EDGE_DOWNLOAD_FILE_I930:
 
2911                         fw_info = "downloading firmware version (930)";
 
2912                         fw_name = "edgeport/down.fw";
 
2915                 case EDGE_DOWNLOAD_FILE_80251:
 
2916                         fw_info = "downloading firmware version (80251)";
 
2917                         fw_name = "edgeport/down2.fw";
 
2920                 case EDGE_DOWNLOAD_FILE_NONE:
 
2921                         dbg     ("No download file specified, skipping download\n");
 
2928         response = request_ihex_firmware(&fw, fw_name,
 
2929                                     &edge_serial->serial->dev->dev);
 
2931                 printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
 
2936         rec = (const struct ihex_binrec *)fw->data;
 
2937         build = (rec->data[2] << 8) | rec->data[3];
 
2939         dbg("%s %d.%d.%d", fw_info, rec->data[0], rec->data[1], build);
 
2941         edge_serial->product_info.FirmwareMajorVersion = fw->data[0];
 
2942         edge_serial->product_info.FirmwareMinorVersion = fw->data[1];
 
2943         edge_serial->product_info.FirmwareBuildNumber = cpu_to_le16(build);
 
2945         for (rec = ihex_next_binrec(rec); rec;
 
2946              rec = ihex_next_binrec(rec)) {
 
2947                 Operaddr = be32_to_cpu(rec->addr);
 
2948                 response = sram_write(edge_serial->serial,
 
2951                                      be16_to_cpu(rec->len),
 
2954                         dev_err(&edge_serial->serial->dev->dev,
 
2955                                 "sram_write failed (%x, %x, %d)\n",
 
2956                                 Operaddr >> 16, Operaddr & 0xFFFF,
 
2957                                 be16_to_cpu(rec->len));
 
2962         dbg("sending exec_dl_code");
 
2963         response = usb_control_msg (edge_serial->serial->dev, 
 
2964                                     usb_sndctrlpipe(edge_serial->serial->dev, 0), 
 
2965                                     USB_REQUEST_ION_EXEC_DL_CODE, 
 
2966                                     0x40, 0x4000, 0x0001, NULL, 0, 3000);
 
2968         release_firmware(fw);
 
2973 /****************************************************************************
 
2975  ****************************************************************************/
 
2976 static int edge_startup(struct usb_serial *serial)
 
2978         struct edgeport_serial *edge_serial;
 
2979         struct edgeport_port *edge_port;
 
2980         struct usb_device *dev;
 
2983         bool interrupt_in_found;
 
2985         bool bulk_out_found;
 
2986         static __u32 descriptor[3] = {  EDGE_COMPATIBILITY_MASK0,
 
2987                                         EDGE_COMPATIBILITY_MASK1,
 
2988                                         EDGE_COMPATIBILITY_MASK2 };
 
2992         /* create our private serial structure */
 
2993         edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
 
2994         if (edge_serial == NULL) {
 
2995                 dev_err(&serial->dev->dev, "%s - Out of memory\n", __func__);
 
2998         spin_lock_init(&edge_serial->es_lock);
 
2999         edge_serial->serial = serial;
 
3000         usb_set_serial_data(serial, edge_serial);
 
3002         /* get the name for the device from the device */
 
3003         i = get_string(dev, dev->descriptor.iManufacturer,
 
3004             &edge_serial->name[0], MAX_NAME_LEN+1);
 
3005         edge_serial->name[i++] = ' ';
 
3006         get_string(dev, dev->descriptor.iProduct,
 
3007             &edge_serial->name[i], MAX_NAME_LEN+2 - i);
 
3009         dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
 
3011         /* Read the epic descriptor */
 
3012         if (get_epic_descriptor(edge_serial) <= 0) {
 
3013                 /* memcpy descriptor to Supports structures */
 
3014                 memcpy(&edge_serial->epic_descriptor.Supports, descriptor,
 
3015                        sizeof(struct edge_compatibility_bits));
 
3017                 /* get the manufacturing descriptor for this device */
 
3018                 get_manufacturing_desc(edge_serial);
 
3020                 /* get the boot descriptor */
 
3021                 get_boot_desc(edge_serial);
 
3023                 get_product_info(edge_serial);
 
3026         /* set the number of ports from the manufacturing description */
 
3027         /* serial->num_ports = serial->product_info.NumPorts; */
 
3028         if ((!edge_serial->is_epic) &&
 
3029             (edge_serial->product_info.NumPorts != serial->num_ports)) {
 
3030                 dev_warn(&serial->dev->dev, "Device Reported %d serial ports "
 
3031                          "vs. core thinking we have %d ports, email "
 
3032                          "greg@kroah.com this information.\n",
 
3033                          edge_serial->product_info.NumPorts,
 
3037         dbg("%s - time 1 %ld", __func__, jiffies);
 
3039         /* If not an EPiC device */
 
3040         if (!edge_serial->is_epic) {
 
3041                 /* now load the application firmware into this device */
 
3042                 load_application_firmware(edge_serial);
 
3044                 dbg("%s - time 2 %ld", __func__, jiffies);
 
3046                 /* Check current Edgeport EEPROM and update if necessary */
 
3047                 update_edgeport_E2PROM(edge_serial);
 
3049                 dbg("%s - time 3 %ld", __func__, jiffies);
 
3051                 /* set the configuration to use #1 */
 
3052 /*              dbg("set_configuration 1"); */
 
3053 /*              usb_set_configuration (dev, 1); */
 
3055         dbg("  FirmwareMajorVersion  %d.%d.%d",
 
3056             edge_serial->product_info.FirmwareMajorVersion,
 
3057             edge_serial->product_info.FirmwareMinorVersion,
 
3058             le16_to_cpu(edge_serial->product_info.FirmwareBuildNumber));
 
3060         /* we set up the pointers to the endpoints in the edge_open function,
 
3061          * as the structures aren't created yet. */
 
3063         /* set up our port private structures */
 
3064         for (i = 0; i < serial->num_ports; ++i) {
 
3065                 edge_port = kmalloc(sizeof(struct edgeport_port), GFP_KERNEL);
 
3066                 if (edge_port == NULL) {
 
3067                         dev_err(&serial->dev->dev, "%s - Out of memory\n",
 
3069                         for (j = 0; j < i; ++j) {
 
3070                                 kfree(usb_get_serial_port_data(serial->port[j]));
 
3071                                 usb_set_serial_port_data(serial->port[j],
 
3074                         usb_set_serial_data(serial, NULL);
 
3078                 memset(edge_port, 0, sizeof(struct edgeport_port));
 
3079                 spin_lock_init(&edge_port->ep_lock);
 
3080                 edge_port->port = serial->port[i];
 
3081                 usb_set_serial_port_data(serial->port[i], edge_port);
 
3086         if (edge_serial->is_epic) {
 
3087                 /* EPIC thing, set up our interrupt polling now and our read
 
3088                  * urb, so that the device knows it really is connected. */
 
3089                 interrupt_in_found = bulk_in_found = bulk_out_found = false;
 
3090                 for (i = 0; i < serial->interface->altsetting[0]
 
3091                                                 .desc.bNumEndpoints; ++i) {
 
3092                         struct usb_endpoint_descriptor *endpoint;
 
3095                         endpoint = &serial->interface->altsetting[0].
 
3097                         buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
 
3098                         if (!interrupt_in_found &&
 
3099                             (usb_endpoint_is_int_in(endpoint))) {
 
3100                                 /* we found a interrupt in endpoint */
 
3101                                 dbg("found interrupt in");
 
3103                                 /* not set up yet, so do it now */
 
3104                                 edge_serial->interrupt_read_urb =
 
3105                                                 usb_alloc_urb(0, GFP_KERNEL);
 
3106                                 if (!edge_serial->interrupt_read_urb) {
 
3107                                         dev_err(&dev->dev, "out of memory\n");
 
3110                                 edge_serial->interrupt_in_buffer =
 
3111                                         kmalloc(buffer_size, GFP_KERNEL);
 
3112                                 if (!edge_serial->interrupt_in_buffer) {
 
3113                                         dev_err(&dev->dev, "out of memory\n");
 
3114                                         usb_free_urb(edge_serial->interrupt_read_urb);
 
3117                                 edge_serial->interrupt_in_endpoint =
 
3118                                                 endpoint->bEndpointAddress;
 
3120                                 /* set up our interrupt urb */
 
3122                                         edge_serial->interrupt_read_urb,
 
3125                                                 endpoint->bEndpointAddress),
 
3126                                         edge_serial->interrupt_in_buffer,
 
3128                                         edge_interrupt_callback,
 
3130                                         endpoint->bInterval);
 
3132                                 interrupt_in_found = true;
 
3135                         if (!bulk_in_found &&
 
3136                                 (usb_endpoint_is_bulk_in(endpoint))) {
 
3137                                 /* we found a bulk in endpoint */
 
3138                                 dbg("found bulk in");
 
3140                                 /* not set up yet, so do it now */
 
3141                                 edge_serial->read_urb =
 
3142                                                 usb_alloc_urb(0, GFP_KERNEL);
 
3143                                 if (!edge_serial->read_urb) {
 
3144                                         dev_err(&dev->dev, "out of memory\n");
 
3147                                 edge_serial->bulk_in_buffer =
 
3148                                         kmalloc(buffer_size, GFP_KERNEL);
 
3149                                 if (!edge_serial->bulk_in_buffer) {
 
3150                                         dev_err(&dev->dev, "out of memory\n");
 
3151                                         usb_free_urb(edge_serial->read_urb);
 
3154                                 edge_serial->bulk_in_endpoint =
 
3155                                                 endpoint->bEndpointAddress;
 
3157                                 /* set up our bulk in urb */
 
3158                                 usb_fill_bulk_urb(edge_serial->read_urb, dev,
 
3159                                         usb_rcvbulkpipe(dev,
 
3160                                                 endpoint->bEndpointAddress),
 
3161                                         edge_serial->bulk_in_buffer,
 
3162                                         le16_to_cpu(endpoint->wMaxPacketSize),
 
3163                                         edge_bulk_in_callback,
 
3165                                 bulk_in_found = true;
 
3168                         if (!bulk_out_found &&
 
3169                             (usb_endpoint_is_bulk_out(endpoint))) {
 
3170                                 /* we found a bulk out endpoint */
 
3171                                 dbg("found bulk out");
 
3172                                 edge_serial->bulk_out_endpoint =
 
3173                                                 endpoint->bEndpointAddress;
 
3174                                 bulk_out_found = true;
 
3178                 if (!interrupt_in_found || !bulk_in_found || !bulk_out_found) {
 
3179                         dev_err(&dev->dev, "Error - the proper endpoints "
 
3180                                 "were not found!\n");
 
3184                 /* start interrupt read for this edgeport this interrupt will
 
3185                  * continue as long as the edgeport is connected */
 
3186                 response = usb_submit_urb(edge_serial->interrupt_read_urb,
 
3190                                 "%s - Error %d submitting control urb\n",
 
3191                                 __func__, response);
 
3197 /****************************************************************************
 
3199  *      This function is called whenever the device is removed from the usb bus.
 
3200  ****************************************************************************/
 
3201 static void edge_shutdown(struct usb_serial *serial)
 
3203         struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
 
3206         dbg("%s", __func__);
 
3208         /* stop reads and writes on all ports */
 
3209         for (i = 0; i < serial->num_ports; ++i) {
 
3210                 kfree(usb_get_serial_port_data(serial->port[i]));
 
3211                 usb_set_serial_port_data(serial->port[i],  NULL);
 
3213         /* free up our endpoint stuff */
 
3214         if (edge_serial->is_epic) {
 
3215                 usb_kill_urb(edge_serial->interrupt_read_urb);
 
3216                 usb_free_urb(edge_serial->interrupt_read_urb);
 
3217                 kfree(edge_serial->interrupt_in_buffer);
 
3219                 usb_kill_urb(edge_serial->read_urb);
 
3220                 usb_free_urb(edge_serial->read_urb);
 
3221                 kfree(edge_serial->bulk_in_buffer);
 
3225         usb_set_serial_data(serial, NULL);
 
3229 /****************************************************************************
 
3231  *      This is called by the module subsystem, or on startup to initialize us
 
3232  ****************************************************************************/
 
3233 static int __init edgeport_init(void)
 
3237         retval = usb_serial_register(&edgeport_2port_device);
 
3239                 goto failed_2port_device_register;
 
3240         retval = usb_serial_register(&edgeport_4port_device);
 
3242                 goto failed_4port_device_register;
 
3243         retval = usb_serial_register(&edgeport_8port_device);
 
3245                 goto failed_8port_device_register;
 
3246         retval = usb_serial_register(&epic_device);
 
3248                 goto failed_epic_device_register;
 
3249         retval = usb_register(&io_driver);
 
3251                 goto failed_usb_register;
 
3252         atomic_set(&CmdUrbs, 0);
 
3253         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 
3257 failed_usb_register:
 
3258         usb_serial_deregister(&epic_device);
 
3259 failed_epic_device_register:
 
3260         usb_serial_deregister(&edgeport_8port_device);
 
3261 failed_8port_device_register:
 
3262         usb_serial_deregister(&edgeport_4port_device);
 
3263 failed_4port_device_register:
 
3264         usb_serial_deregister(&edgeport_2port_device);
 
3265 failed_2port_device_register:
 
3270 /****************************************************************************
 
3272  *      Called when the driver is about to be unloaded.
 
3273  ****************************************************************************/
 
3274 static void __exit edgeport_exit (void)
 
3276         usb_deregister(&io_driver);
 
3277         usb_serial_deregister(&edgeport_2port_device);
 
3278         usb_serial_deregister(&edgeport_4port_device);
 
3279         usb_serial_deregister(&edgeport_8port_device);
 
3280         usb_serial_deregister(&epic_device);
 
3283 module_init(edgeport_init);
 
3284 module_exit(edgeport_exit);
 
3286 /* Module information */
 
3287 MODULE_AUTHOR(DRIVER_AUTHOR);
 
3288 MODULE_DESCRIPTION(DRIVER_DESC);
 
3289 MODULE_LICENSE("GPL");
 
3290 MODULE_FIRMWARE("edgeport/boot.fw");
 
3291 MODULE_FIRMWARE("edgeport/boot2.fw");
 
3292 MODULE_FIRMWARE("edgeport/down.fw");
 
3293 MODULE_FIRMWARE("edgeport/down2.fw");
 
3295 module_param(debug, bool, S_IRUGO | S_IWUSR);
 
3296 MODULE_PARM_DESC(debug, "Debug enabled or not");