linux/drivers/usb/serial/io_ti.c
<<
>>
Prefs
   1/*
   2 * Edgeport USB Serial Converter driver
   3 *
   4 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
   5 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
   6 *
   7 *      This program is free software; you can redistribute it and/or modify
   8 *      it under the terms of the GNU General Public License as published by
   9 *      the Free Software Foundation; either version 2 of the License, or
  10 *      (at your option) any later version.
  11 *
  12 * Supports the following devices:
  13 *      EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
  14 *
  15 * For questions or problems with this driver, contact Inside Out
  16 * Networks technical support, or Peter Berger <pberger@brimson.com>,
  17 * or Al Borchers <alborchers@steinerpoint.com>.
  18 *
  19 * Version history:
  20 *
  21 *      July 11, 2002   Removed 4 port device structure since all TI UMP
  22 *                      chips have only 2 ports
  23 *                      David Iacovelli (davidi@ionetworks.com)
  24 *
  25 */
  26
  27#include <linux/kernel.h>
  28#include <linux/jiffies.h>
  29#include <linux/errno.h>
  30#include <linux/init.h>
  31#include <linux/slab.h>
  32#include <linux/tty.h>
  33#include <linux/tty_driver.h>
  34#include <linux/tty_flip.h>
  35#include <linux/module.h>
  36#include <linux/spinlock.h>
  37#include <linux/mutex.h>
  38#include <linux/serial.h>
  39#include <linux/ioctl.h>
  40#include <linux/firmware.h>
  41#include <linux/uaccess.h>
  42#include <linux/usb.h>
  43#include <linux/usb/serial.h>
  44
  45#include "io_16654.h"
  46#include "io_usbvend.h"
  47#include "io_ti.h"
  48
  49/*
  50 * Version Information
  51 */
  52#define DRIVER_VERSION "v0.7mode043006"
  53#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
  54#define DRIVER_DESC "Edgeport USB Serial Driver"
  55
  56#define EPROM_PAGE_SIZE         64
  57
  58
  59struct edgeport_uart_buf_desc {
  60        __u32 count;            /* Number of bytes currently in buffer */
  61};
  62
  63/* different hardware types */
  64#define HARDWARE_TYPE_930       0
  65#define HARDWARE_TYPE_TIUMP     1
  66
  67/* IOCTL_PRIVATE_TI_GET_MODE Definitions */
  68#define TI_MODE_CONFIGURING     0   /* Device has not entered start device */
  69#define TI_MODE_BOOT            1   /* Staying in boot mode                */
  70#define TI_MODE_DOWNLOAD        2   /* Made it to download mode            */
  71#define TI_MODE_TRANSITIONING   3   /* Currently in boot mode but
  72                                       transitioning to download mode      */
  73
  74/* read urb state */
  75#define EDGE_READ_URB_RUNNING   0
  76#define EDGE_READ_URB_STOPPING  1
  77#define EDGE_READ_URB_STOPPED   2
  78
  79#define EDGE_CLOSING_WAIT       4000    /* in .01 sec */
  80
  81#define EDGE_OUT_BUF_SIZE       1024
  82
  83
  84/* Product information read from the Edgeport */
  85struct product_info {
  86        int     TiMode;                 /* Current TI Mode  */
  87        __u8    hardware_type;          /* Type of hardware */
  88} __attribute__((packed));
  89
  90/* circular buffer */
  91struct edge_buf {
  92        unsigned int    buf_size;
  93        char            *buf_buf;
  94        char            *buf_get;
  95        char            *buf_put;
  96};
  97
  98struct edgeport_port {
  99        __u16 uart_base;
 100        __u16 dma_address;
 101        __u8 shadow_msr;
 102        __u8 shadow_mcr;
 103        __u8 shadow_lsr;
 104        __u8 lsr_mask;
 105        __u32 ump_read_timeout;         /* Number of milliseconds the UMP will
 106                                           wait without data before completing
 107                                           a read short */
 108        int baud_rate;
 109        int close_pending;
 110        int lsr_event;
 111        struct edgeport_uart_buf_desc tx;
 112        struct async_icount     icount;
 113        wait_queue_head_t       delta_msr_wait; /* for handling sleeping while
 114                                                   waiting for msr change to
 115                                                   happen */
 116        struct edgeport_serial  *edge_serial;
 117        struct usb_serial_port  *port;
 118        __u8 bUartMode;         /* Port type, 0: RS232, etc. */
 119        spinlock_t ep_lock;
 120        int ep_read_urb_state;
 121        int ep_write_urb_in_use;
 122        struct edge_buf *ep_out_buf;
 123};
 124
 125struct edgeport_serial {
 126        struct product_info product_info;
 127        u8 TI_I2C_Type;                 /* Type of I2C in UMP */
 128        u8 TiReadI2C;                   /* Set to TRUE if we have read the
 129                                           I2c in Boot Mode */
 130        struct mutex es_lock;
 131        int num_ports_open;
 132        struct usb_serial *serial;
 133};
 134
 135
 136/* Devices that this driver supports */
 137static struct usb_device_id edgeport_1port_id_table [] = {
 138        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
 139        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
 140        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
 141        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
 142        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
 143        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
 144        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
 145        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
 146        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
 147        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
 148        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
 149        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
 150        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
 151        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
 152        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
 153        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
 154        { }
 155};
 156
 157static struct usb_device_id edgeport_2port_id_table [] = {
 158        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
 159        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
 160        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
 161        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
 162        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
 163        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
 164        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
 165        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
 166        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
 167        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
 168        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
 169        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
 170        /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
 171        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
 172        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
 173        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
 174        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
 175        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
 176        { }
 177};
 178
 179/* Devices that this driver supports */
 180static struct usb_device_id id_table_combined [] = {
 181        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
 182        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
 183        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
 184        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
 185        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
 186        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
 187        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
 188        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
 189        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
 190        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
 191        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
 192        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
 193        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
 194        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
 195        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
 196        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
 197        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
 198        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
 199        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
 200        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
 201        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
 202        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
 203        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
 204        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
 205        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
 206        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
 207        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
 208        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
 209        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
 210        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
 211        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
 212        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
 213        { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
 214        { }
 215};
 216
 217MODULE_DEVICE_TABLE(usb, id_table_combined);
 218
 219static struct usb_driver io_driver = {
 220        .name =         "io_ti",
 221        .probe =        usb_serial_probe,
 222        .disconnect =   usb_serial_disconnect,
 223        .id_table =     id_table_combined,
 224        .no_dynamic_id =        1,
 225};
 226
 227
 228static unsigned char OperationalMajorVersion;
 229static unsigned char OperationalMinorVersion;
 230static unsigned short OperationalBuildNumber;
 231
 232static int debug;
 233
 234static int closing_wait = EDGE_CLOSING_WAIT;
 235static int ignore_cpu_rev;
 236static int default_uart_mode;           /* RS232 */
 237
 238static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
 239                          unsigned char *data, int length);
 240
 241static void stop_read(struct edgeport_port *edge_port);
 242static int restart_read(struct edgeport_port *edge_port);
 243
 244static void edge_set_termios(struct tty_struct *tty,
 245                struct usb_serial_port *port, struct ktermios *old_termios);
 246static void edge_send(struct tty_struct *tty);
 247
 248/* sysfs attributes */
 249static int edge_create_sysfs_attrs(struct usb_serial_port *port);
 250static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
 251
 252/* circular buffer */
 253static struct edge_buf *edge_buf_alloc(unsigned int size);
 254static void edge_buf_free(struct edge_buf *eb);
 255static void edge_buf_clear(struct edge_buf *eb);
 256static unsigned int edge_buf_data_avail(struct edge_buf *eb);
 257static unsigned int edge_buf_space_avail(struct edge_buf *eb);
 258static unsigned int edge_buf_put(struct edge_buf *eb, const char *buf,
 259        unsigned int count);
 260static unsigned int edge_buf_get(struct edge_buf *eb, char *buf,
 261        unsigned int count);
 262
 263
 264static int ti_vread_sync(struct usb_device *dev, __u8 request,
 265                                __u16 value, __u16 index, u8 *data, int size)
 266{
 267        int status;
 268
 269        status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
 270                        (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
 271                        value, index, data, size, 1000);
 272        if (status < 0)
 273                return status;
 274        if (status != size) {
 275                dbg("%s - wanted to write %d, but only wrote %d",
 276                                             __func__, size, status);
 277                return -ECOMM;
 278        }
 279        return 0;
 280}
 281
 282static int ti_vsend_sync(struct usb_device *dev, __u8 request,
 283                                __u16 value, __u16 index, u8 *data, int size)
 284{
 285        int status;
 286
 287        status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
 288                        (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
 289                        value, index, data, size, 1000);
 290        if (status < 0)
 291                return status;
 292        if (status != size) {
 293                dbg("%s - wanted to write %d, but only wrote %d",
 294                     __func__, size, status);
 295                return -ECOMM;
 296        }
 297        return 0;
 298}
 299
 300static int send_cmd(struct usb_device *dev, __u8 command,
 301                                __u8 moduleid, __u16 value, u8 *data,
 302                                int size)
 303{
 304        return ti_vsend_sync(dev, command, value, moduleid, data, size);
 305}
 306
 307/* clear tx/rx buffers and fifo in TI UMP */
 308static int purge_port(struct usb_serial_port *port, __u16 mask)
 309{
 310        int port_number = port->number - port->serial->minor;
 311
 312        dbg("%s - port %d, mask %x", __func__, port_number, mask);
 313
 314        return send_cmd(port->serial->dev,
 315                                        UMPC_PURGE_PORT,
 316                                        (__u8)(UMPM_UART1_PORT + port_number),
 317                                        mask,
 318                                        NULL,
 319                                        0);
 320}
 321
 322/**
 323 * read_download_mem - Read edgeport memory from TI chip
 324 * @dev: usb device pointer
 325 * @start_address: Device CPU address at which to read
 326 * @length: Length of above data
 327 * @address_type: Can read both XDATA and I2C
 328 * @buffer: pointer to input data buffer
 329 */
 330static int read_download_mem(struct usb_device *dev, int start_address,
 331                                int length, __u8 address_type, __u8 *buffer)
 332{
 333        int status = 0;
 334        __u8 read_length;
 335        __be16 be_start_address;
 336
 337        dbg("%s - @ %x for %d", __func__, start_address, length);
 338
 339        /* Read in blocks of 64 bytes
 340         * (TI firmware can't handle more than 64 byte reads)
 341         */
 342        while (length) {
 343                if (length > 64)
 344                        read_length = 64;
 345                else
 346                        read_length = (__u8)length;
 347
 348                if (read_length > 1) {
 349                        dbg("%s - @ %x for %d", __func__,
 350                             start_address, read_length);
 351                }
 352                be_start_address = cpu_to_be16(start_address);
 353                status = ti_vread_sync(dev, UMPC_MEMORY_READ,
 354                                        (__u16)address_type,
 355                                        (__force __u16)be_start_address,
 356                                        buffer, read_length);
 357
 358                if (status) {
 359                        dbg("%s - ERROR %x", __func__, status);
 360                        return status;
 361                }
 362
 363                if (read_length > 1)
 364                        usb_serial_debug_data(debug, &dev->dev, __func__,
 365                                              read_length, buffer);
 366
 367                /* Update pointers/length */
 368                start_address += read_length;
 369                buffer += read_length;
 370                length -= read_length;
 371        }
 372
 373        return status;
 374}
 375
 376static int read_ram(struct usb_device *dev, int start_address,
 377                                                int length, __u8 *buffer)
 378{
 379        return read_download_mem(dev, start_address, length,
 380                                        DTK_ADDR_SPACE_XDATA, buffer);
 381}
 382
 383/* Read edgeport memory to a given block */
 384static int read_boot_mem(struct edgeport_serial *serial,
 385                                int start_address, int length, __u8 *buffer)
 386{
 387        int status = 0;
 388        int i;
 389
 390        for (i = 0; i < length; i++) {
 391                status = ti_vread_sync(serial->serial->dev,
 392                                UMPC_MEMORY_READ, serial->TI_I2C_Type,
 393                                (__u16)(start_address+i), &buffer[i], 0x01);
 394                if (status) {
 395                        dbg("%s - ERROR %x", __func__, status);
 396                        return status;
 397                }
 398        }
 399
 400        dbg("%s - start_address = %x, length = %d",
 401                                        __func__, start_address, length);
 402        usb_serial_debug_data(debug, &serial->serial->dev->dev,
 403                                        __func__, length, buffer);
 404
 405        serial->TiReadI2C = 1;
 406
 407        return status;
 408}
 409
 410/* Write given block to TI EPROM memory */
 411static int write_boot_mem(struct edgeport_serial *serial,
 412                                int start_address, int length, __u8 *buffer)
 413{
 414        int status = 0;
 415        int i;
 416        __u8 temp;
 417
 418        /* Must do a read before write */
 419        if (!serial->TiReadI2C) {
 420                status = read_boot_mem(serial, 0, 1, &temp);
 421                if (status)
 422                        return status;
 423        }
 424
 425        for (i = 0; i < length; ++i) {
 426                status = ti_vsend_sync(serial->serial->dev,
 427                                UMPC_MEMORY_WRITE, buffer[i],
 428                                (__u16)(i + start_address), NULL, 0);
 429                if (status)
 430                        return status;
 431        }
 432
 433        dbg("%s - start_sddr = %x, length = %d",
 434                                        __func__, start_address, length);
 435        usb_serial_debug_data(debug, &serial->serial->dev->dev,
 436                                        __func__, length, buffer);
 437
 438        return status;
 439}
 440
 441
 442/* Write edgeport I2C memory to TI chip */
 443static int write_i2c_mem(struct edgeport_serial *serial,
 444                int start_address, int length, __u8 address_type, __u8 *buffer)
 445{
 446        int status = 0;
 447        int write_length;
 448        __be16 be_start_address;
 449
 450        /* We can only send a maximum of 1 aligned byte page at a time */
 451
 452        /* calulate the number of bytes left in the first page */
 453        write_length = EPROM_PAGE_SIZE -
 454                                (start_address & (EPROM_PAGE_SIZE - 1));
 455
 456        if (write_length > length)
 457                write_length = length;
 458
 459        dbg("%s - BytesInFirstPage Addr = %x, length = %d",
 460                                        __func__, start_address, write_length);
 461        usb_serial_debug_data(debug, &serial->serial->dev->dev,
 462                                                __func__, write_length, buffer);
 463
 464        /* Write first page */
 465        be_start_address = cpu_to_be16(start_address);
 466        status = ti_vsend_sync(serial->serial->dev,
 467                                UMPC_MEMORY_WRITE, (__u16)address_type,
 468                                (__force __u16)be_start_address,
 469                                buffer, write_length);
 470        if (status) {
 471                dbg("%s - ERROR %d", __func__, status);
 472                return status;
 473        }
 474
 475        length          -= write_length;
 476        start_address   += write_length;
 477        buffer          += write_length;
 478
 479        /* We should be aligned now -- can write
 480           max page size bytes at a time */
 481        while (length) {
 482                if (length > EPROM_PAGE_SIZE)
 483                        write_length = EPROM_PAGE_SIZE;
 484                else
 485                        write_length = length;
 486
 487                dbg("%s - Page Write Addr = %x, length = %d",
 488                                        __func__, start_address, write_length);
 489                usb_serial_debug_data(debug, &serial->serial->dev->dev,
 490                                        __func__, write_length, buffer);
 491
 492                /* Write next page */
 493                be_start_address = cpu_to_be16(start_address);
 494                status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
 495                                (__u16)address_type,
 496                                (__force __u16)be_start_address,
 497                                buffer, write_length);
 498                if (status) {
 499                        dev_err(&serial->serial->dev->dev, "%s - ERROR %d\n",
 500                                        __func__, status);
 501                        return status;
 502                }
 503
 504                length          -= write_length;
 505                start_address   += write_length;
 506                buffer          += write_length;
 507        }
 508        return status;
 509}
 510
 511/* Examine the UMP DMA registers and LSR
 512 *
 513 * Check the MSBit of the X and Y DMA byte count registers.
 514 * A zero in this bit indicates that the TX DMA buffers are empty
 515 * then check the TX Empty bit in the UART.
 516 */
 517static int tx_active(struct edgeport_port *port)
 518{
 519        int status;
 520        struct out_endpoint_desc_block *oedb;
 521        __u8 *lsr;
 522        int bytes_left = 0;
 523
 524        oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
 525        if (!oedb) {
 526                dev_err(&port->port->dev, "%s - out of memory\n", __func__);
 527                return -ENOMEM;
 528        }
 529
 530        lsr = kmalloc(1, GFP_KERNEL);   /* Sigh, that's right, just one byte,
 531                                           as not all platforms can do DMA
 532                                           from stack */
 533        if (!lsr) {
 534                kfree(oedb);
 535                return -ENOMEM;
 536        }
 537        /* Read the DMA Count Registers */
 538        status = read_ram(port->port->serial->dev, port->dma_address,
 539                                                sizeof(*oedb), (void *)oedb);
 540        if (status)
 541                goto exit_is_tx_active;
 542
 543        dbg("%s - XByteCount    0x%X", __func__, oedb->XByteCount);
 544
 545        /* and the LSR */
 546        status = read_ram(port->port->serial->dev,
 547                        port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
 548
 549        if (status)
 550                goto exit_is_tx_active;
 551        dbg("%s - LSR = 0x%X", __func__, *lsr);
 552
 553        /* If either buffer has data or we are transmitting then return TRUE */
 554        if ((oedb->XByteCount & 0x80) != 0)
 555                bytes_left += 64;
 556
 557        if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
 558                bytes_left += 1;
 559
 560        /* We return Not Active if we get any kind of error */
 561exit_is_tx_active:
 562        dbg("%s - return %d", __func__, bytes_left);
 563
 564        kfree(lsr);
 565        kfree(oedb);
 566        return bytes_left;
 567}
 568
 569static void chase_port(struct edgeport_port *port, unsigned long timeout,
 570                                                                int flush)
 571{
 572        int baud_rate;
 573        struct tty_struct *tty = tty_port_tty_get(&port->port->port);
 574        wait_queue_t wait;
 575        unsigned long flags;
 576
 577        if (!timeout)
 578                timeout = (HZ * EDGE_CLOSING_WAIT)/100;
 579
 580        /* wait for data to drain from the buffer */
 581        spin_lock_irqsave(&port->ep_lock, flags);
 582        init_waitqueue_entry(&wait, current);
 583        add_wait_queue(&tty->write_wait, &wait);
 584        for (;;) {
 585                set_current_state(TASK_INTERRUPTIBLE);
 586                if (edge_buf_data_avail(port->ep_out_buf) == 0
 587                || timeout == 0 || signal_pending(current)
 588                || !usb_get_intfdata(port->port->serial->interface))
 589                        /* disconnect */
 590                        break;
 591                spin_unlock_irqrestore(&port->ep_lock, flags);
 592                timeout = schedule_timeout(timeout);
 593                spin_lock_irqsave(&port->ep_lock, flags);
 594        }
 595        set_current_state(TASK_RUNNING);
 596        remove_wait_queue(&tty->write_wait, &wait);
 597        if (flush)
 598                edge_buf_clear(port->ep_out_buf);
 599        spin_unlock_irqrestore(&port->ep_lock, flags);
 600        tty_kref_put(tty);
 601
 602        /* wait for data to drain from the device */
 603        timeout += jiffies;
 604        while ((long)(jiffies - timeout) < 0 && !signal_pending(current)
 605        && usb_get_intfdata(port->port->serial->interface)) {
 606                /* not disconnected */
 607                if (!tx_active(port))
 608                        break;
 609                msleep(10);
 610        }
 611
 612        /* disconnected */
 613        if (!usb_get_intfdata(port->port->serial->interface))
 614                return;
 615
 616        /* wait one more character time, based on baud rate */
 617        /* (tx_active doesn't seem to wait for the last byte) */
 618        baud_rate = port->baud_rate;
 619        if (baud_rate == 0)
 620                baud_rate = 50;
 621        msleep(max(1, DIV_ROUND_UP(10000, baud_rate)));
 622}
 623
 624static int choose_config(struct usb_device *dev)
 625{
 626        /*
 627         * There may be multiple configurations on this device, in which case
 628         * we would need to read and parse all of them to find out which one
 629         * we want. However, we just support one config at this point,
 630         * configuration # 1, which is Config Descriptor 0.
 631         */
 632
 633        dbg("%s - Number of Interfaces = %d",
 634                                __func__, dev->config->desc.bNumInterfaces);
 635        dbg("%s - MAX Power            = %d",
 636                                __func__, dev->config->desc.bMaxPower * 2);
 637
 638        if (dev->config->desc.bNumInterfaces != 1) {
 639                dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n",
 640                                                                __func__);
 641                return -ENODEV;
 642        }
 643
 644        return 0;
 645}
 646
 647static int read_rom(struct edgeport_serial *serial,
 648                                int start_address, int length, __u8 *buffer)
 649{
 650        int status;
 651
 652        if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
 653                status = read_download_mem(serial->serial->dev,
 654                                               start_address,
 655                                               length,
 656                                               serial->TI_I2C_Type,
 657                                               buffer);
 658        } else {
 659                status = read_boot_mem(serial, start_address, length,
 660                                                                buffer);
 661        }
 662        return status;
 663}
 664
 665static int write_rom(struct edgeport_serial *serial, int start_address,
 666                                                int length, __u8 *buffer)
 667{
 668        if (serial->product_info.TiMode == TI_MODE_BOOT)
 669                return write_boot_mem(serial, start_address, length,
 670                                                                buffer);
 671
 672        if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
 673                return write_i2c_mem(serial, start_address, length,
 674                                                serial->TI_I2C_Type, buffer);
 675        return -EINVAL;
 676}
 677
 678
 679
 680/* Read a descriptor header from I2C based on type */
 681static int get_descriptor_addr(struct edgeport_serial *serial,
 682                                int desc_type, struct ti_i2c_desc *rom_desc)
 683{
 684        int start_address;
 685        int status;
 686
 687        /* Search for requested descriptor in I2C */
 688        start_address = 2;
 689        do {
 690                status = read_rom(serial,
 691                                   start_address,
 692                                   sizeof(struct ti_i2c_desc),
 693                                   (__u8 *)rom_desc);
 694                if (status)
 695                        return 0;
 696
 697                if (rom_desc->Type == desc_type)
 698                        return start_address;
 699
 700                start_address = start_address + sizeof(struct ti_i2c_desc)
 701                                                        + rom_desc->Size;
 702
 703        } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
 704
 705        return 0;
 706}
 707
 708/* Validate descriptor checksum */
 709static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
 710{
 711        __u16 i;
 712        __u8 cs = 0;
 713
 714        for (i = 0; i < rom_desc->Size; i++)
 715                cs = (__u8)(cs + buffer[i]);
 716
 717        if (cs != rom_desc->CheckSum) {
 718                dbg("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
 719                return -EINVAL;
 720        }
 721        return 0;
 722}
 723
 724/* Make sure that the I2C image is good */
 725static int check_i2c_image(struct edgeport_serial *serial)
 726{
 727        struct device *dev = &serial->serial->dev->dev;
 728        int status = 0;
 729        struct ti_i2c_desc *rom_desc;
 730        int start_address = 2;
 731        __u8 *buffer;
 732        __u16 ttype;
 733
 734        rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
 735        if (!rom_desc) {
 736                dev_err(dev, "%s - out of memory\n", __func__);
 737                return -ENOMEM;
 738        }
 739        buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
 740        if (!buffer) {
 741                dev_err(dev, "%s - out of memory when allocating buffer\n",
 742                                                                __func__);
 743                kfree(rom_desc);
 744                return -ENOMEM;
 745        }
 746
 747        /* Read the first byte (Signature0) must be 0x52 or 0x10 */
 748        status = read_rom(serial, 0, 1, buffer);
 749        if (status)
 750                goto out;
 751
 752        if (*buffer != UMP5152 && *buffer != UMP3410) {
 753                dev_err(dev, "%s - invalid buffer signature\n", __func__);
 754                status = -ENODEV;
 755                goto out;
 756        }
 757
 758        do {
 759                /* Validate the I2C */
 760                status = read_rom(serial,
 761                                start_address,
 762                                sizeof(struct ti_i2c_desc),
 763                                (__u8 *)rom_desc);
 764                if (status)
 765                        break;
 766
 767                if ((start_address + sizeof(struct ti_i2c_desc) +
 768                                        rom_desc->Size) > TI_MAX_I2C_SIZE) {
 769                        status = -ENODEV;
 770                        dbg("%s - structure too big, erroring out.", __func__);
 771                        break;
 772                }
 773
 774                dbg("%s Type = 0x%x", __func__, rom_desc->Type);
 775
 776                /* Skip type 2 record */
 777                ttype = rom_desc->Type & 0x0f;
 778                if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
 779                        && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
 780                        /* Read the descriptor data */
 781                        status = read_rom(serial, start_address +
 782                                                sizeof(struct ti_i2c_desc),
 783                                                rom_desc->Size, buffer);
 784                        if (status)
 785                                break;
 786
 787                        status = valid_csum(rom_desc, buffer);
 788                        if (status)
 789                                break;
 790                }
 791                start_address = start_address + sizeof(struct ti_i2c_desc) +
 792                                                                rom_desc->Size;
 793
 794        } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
 795                                (start_address < TI_MAX_I2C_SIZE));
 796
 797        if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
 798                                (start_address > TI_MAX_I2C_SIZE))
 799                status = -ENODEV;
 800
 801out:
 802        kfree(buffer);
 803        kfree(rom_desc);
 804        return status;
 805}
 806
 807static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
 808{
 809        int status;
 810        int start_address;
 811        struct ti_i2c_desc *rom_desc;
 812        struct edge_ti_manuf_descriptor *desc;
 813
 814        rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
 815        if (!rom_desc) {
 816                dev_err(&serial->serial->dev->dev, "%s - out of memory\n",
 817                                                                __func__);
 818                return -ENOMEM;
 819        }
 820        start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
 821                                                                rom_desc);
 822
 823        if (!start_address) {
 824                dbg("%s - Edge Descriptor not found in I2C", __func__);
 825                status = -ENODEV;
 826                goto exit;
 827        }
 828
 829        /* Read the descriptor data */
 830        status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
 831                                                rom_desc->Size, buffer);
 832        if (status)
 833                goto exit;
 834
 835        status = valid_csum(rom_desc, buffer);
 836
 837        desc = (struct edge_ti_manuf_descriptor *)buffer;
 838        dbg("%s - IonConfig      0x%x", __func__, desc->IonConfig);
 839        dbg("%s - Version          %d", __func__, desc->Version);
 840        dbg("%s - Cpu/Board      0x%x", __func__, desc->CpuRev_BoardRev);
 841        dbg("%s - NumPorts         %d", __func__, desc->NumPorts);
 842        dbg("%s - NumVirtualPorts  %d", __func__, desc->NumVirtualPorts);
 843        dbg("%s - TotalPorts       %d", __func__, desc->TotalPorts);
 844
 845exit:
 846        kfree(rom_desc);
 847        return status;
 848}
 849
 850/* Build firmware header used for firmware update */
 851static int build_i2c_fw_hdr(__u8 *header, struct device *dev)
 852{
 853        __u8 *buffer;
 854        int buffer_size;
 855        int i;
 856        int err;
 857        __u8 cs = 0;
 858        struct ti_i2c_desc *i2c_header;
 859        struct ti_i2c_image_header *img_header;
 860        struct ti_i2c_firmware_rec *firmware_rec;
 861        const struct firmware *fw;
 862        const char *fw_name = "edgeport/down3.bin";
 863
 864        /* In order to update the I2C firmware we must change the type 2 record
 865         * to type 0xF2.  This will force the UMP to come up in Boot Mode.
 866         * Then while in boot mode, the driver will download the latest
 867         * firmware (padded to 15.5k) into the UMP ram.  And finally when the
 868         * device comes back up in download mode the driver will cause the new
 869         * firmware to be copied from the UMP Ram to I2C and the firmware will
 870         * update the record type from 0xf2 to 0x02.
 871         */
 872
 873        /* Allocate a 15.5k buffer + 2 bytes for version number
 874         * (Firmware Record) */
 875        buffer_size = (((1024 * 16) - 512 ) +
 876                        sizeof(struct ti_i2c_firmware_rec));
 877
 878        buffer = kmalloc(buffer_size, GFP_KERNEL);
 879        if (!buffer) {
 880                dev_err(dev, "%s - out of memory\n", __func__);
 881                return -ENOMEM;
 882        }
 883
 884        // Set entire image of 0xffs
 885        memset(buffer, 0xff, buffer_size);
 886
 887        err = request_firmware(&fw, fw_name, dev);
 888        if (err) {
 889                printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
 890                       fw_name, err);
 891                kfree(buffer);
 892                return err;
 893        }
 894
 895        /* Save Download Version Number */
 896        OperationalMajorVersion = fw->data[0];
 897        OperationalMinorVersion = fw->data[1];
 898        OperationalBuildNumber = fw->data[2] | (fw->data[3] << 8);
 899
 900        /* Copy version number into firmware record */
 901        firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
 902
 903        firmware_rec->Ver_Major = OperationalMajorVersion;
 904        firmware_rec->Ver_Minor = OperationalMinorVersion;
 905
 906        /* Pointer to fw_down memory image */
 907        img_header = (struct ti_i2c_image_header *)&fw->data[4];
 908
 909        memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
 910                &fw->data[4 + sizeof(struct ti_i2c_image_header)],
 911                le16_to_cpu(img_header->Length));
 912
 913        release_firmware(fw);
 914
 915        for (i=0; i < buffer_size; i++) {
 916                cs = (__u8)(cs + buffer[i]);
 917        }
 918
 919        kfree(buffer);
 920
 921        /* Build new header */
 922        i2c_header =  (struct ti_i2c_desc *)header;
 923        firmware_rec =  (struct ti_i2c_firmware_rec*)i2c_header->Data;
 924
 925        i2c_header->Type        = I2C_DESC_TYPE_FIRMWARE_BLANK;
 926        i2c_header->Size        = (__u16)buffer_size;
 927        i2c_header->CheckSum    = cs;
 928        firmware_rec->Ver_Major = OperationalMajorVersion;
 929        firmware_rec->Ver_Minor = OperationalMinorVersion;
 930
 931        return 0;
 932}
 933
 934/* Try to figure out what type of I2c we have */
 935static int i2c_type_bootmode(struct edgeport_serial *serial)
 936{
 937        int status;
 938        __u8 data;
 939
 940        /* Try to read type 2 */
 941        status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
 942                                DTK_ADDR_SPACE_I2C_TYPE_II, 0, &data, 0x01);
 943        if (status)
 944                dbg("%s - read 2 status error = %d", __func__, status);
 945        else
 946                dbg("%s - read 2 data = 0x%x", __func__, data);
 947        if ((!status) && (data == UMP5152 || data == UMP3410)) {
 948                dbg("%s - ROM_TYPE_II", __func__);
 949                serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
 950                return 0;
 951        }
 952
 953        /* Try to read type 3 */
 954        status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
 955                                DTK_ADDR_SPACE_I2C_TYPE_III, 0, &data, 0x01);
 956        if (status)
 957                dbg("%s - read 3 status error = %d", __func__, status);
 958        else
 959                dbg("%s - read 2 data = 0x%x", __func__, data);
 960        if ((!status) && (data == UMP5152 || data == UMP3410)) {
 961                dbg("%s - ROM_TYPE_III", __func__);
 962                serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
 963                return 0;
 964        }
 965
 966        dbg("%s - Unknown", __func__);
 967        serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
 968        return -ENODEV;
 969}
 970
 971static int bulk_xfer(struct usb_serial *serial, void *buffer,
 972                                                int length, int *num_sent)
 973{
 974        int status;
 975
 976        status = usb_bulk_msg(serial->dev,
 977                        usb_sndbulkpipe(serial->dev,
 978                                serial->port[0]->bulk_out_endpointAddress),
 979                        buffer, length, num_sent, 1000);
 980        return status;
 981}
 982
 983/* Download given firmware image to the device (IN BOOT MODE) */
 984static int download_code(struct edgeport_serial *serial, __u8 *image,
 985                                                        int image_length)
 986{
 987        int status = 0;
 988        int pos;
 989        int transfer;
 990        int done;
 991
 992        /* Transfer firmware image */
 993        for (pos = 0; pos < image_length; ) {
 994                /* Read the next buffer from file */
 995                transfer = image_length - pos;
 996                if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
 997                        transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
 998
 999                /* Transfer data */
1000                status = bulk_xfer(serial->serial, &image[pos],
1001                                                        transfer, &done);
1002                if (status)
1003                        break;
1004                /* Advance buffer pointer */
1005                pos += done;
1006        }
1007
1008        return status;
1009}
1010
1011/* FIXME!!! */
1012static int config_boot_dev(struct usb_device *dev)
1013{
1014        return 0;
1015}
1016
1017static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
1018{
1019        return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
1020}
1021
1022/**
1023 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
1024 *
1025 * This routine downloads the main operating code into the TI5052, using the
1026 * boot code already burned into E2PROM or ROM.
1027 */
1028static int download_fw(struct edgeport_serial *serial)
1029{
1030        struct device *dev = &serial->serial->dev->dev;
1031        int status = 0;
1032        int start_address;
1033        struct edge_ti_manuf_descriptor *ti_manuf_desc;
1034        struct usb_interface_descriptor *interface;
1035        int download_cur_ver;
1036        int download_new_ver;
1037
1038        /* This routine is entered by both the BOOT mode and the Download mode
1039         * We can determine which code is running by the reading the config
1040         * descriptor and if we have only one bulk pipe it is in boot mode
1041         */
1042        serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1043
1044        /* Default to type 2 i2c */
1045        serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1046
1047        status = choose_config(serial->serial->dev);
1048        if (status)
1049                return status;
1050
1051        interface = &serial->serial->interface->cur_altsetting->desc;
1052        if (!interface) {
1053                dev_err(dev, "%s - no interface set, error!\n", __func__);
1054                return -ENODEV;
1055        }
1056
1057        /*
1058         * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1059         * if we have more than one endpoint we are definitely in download
1060         * mode
1061         */
1062        if (interface->bNumEndpoints > 1)
1063                serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1064        else
1065                /* Otherwise we will remain in configuring mode */
1066                serial->product_info.TiMode = TI_MODE_CONFIGURING;
1067
1068        /********************************************************************/
1069        /* Download Mode */
1070        /********************************************************************/
1071        if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
1072                struct ti_i2c_desc *rom_desc;
1073
1074                dbg("%s - RUNNING IN DOWNLOAD MODE", __func__);
1075
1076                status = check_i2c_image(serial);
1077                if (status) {
1078                        dbg("%s - DOWNLOAD MODE -- BAD I2C", __func__);
1079                        return status;
1080                }
1081
1082                /* Validate Hardware version number
1083                 * Read Manufacturing Descriptor from TI Based Edgeport
1084                 */
1085                ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1086                if (!ti_manuf_desc) {
1087                        dev_err(dev, "%s - out of memory.\n", __func__);
1088                        return -ENOMEM;
1089                }
1090                status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1091                if (status) {
1092                        kfree(ti_manuf_desc);
1093                        return status;
1094                }
1095
1096                /* Check version number of ION descriptor */
1097                if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1098                        dbg("%s - Wrong CPU Rev %d (Must be 2)",
1099                                __func__, ti_cpu_rev(ti_manuf_desc));
1100                        kfree(ti_manuf_desc);
1101                        return -EINVAL;
1102                }
1103
1104                rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1105                if (!rom_desc) {
1106                        dev_err(dev, "%s - out of memory.\n", __func__);
1107                        kfree(ti_manuf_desc);
1108                        return -ENOMEM;
1109                }
1110
1111                /* Search for type 2 record (firmware record) */
1112                start_address = get_descriptor_addr(serial,
1113                                I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1114                if (start_address != 0) {
1115                        struct ti_i2c_firmware_rec *firmware_version;
1116                        __u8 record;
1117
1118                        dbg("%s - Found Type FIRMWARE (Type 2) record",
1119                                                                __func__);
1120
1121                        firmware_version = kmalloc(sizeof(*firmware_version),
1122                                                                GFP_KERNEL);
1123                        if (!firmware_version) {
1124                                dev_err(dev, "%s - out of memory.\n", __func__);
1125                                kfree(rom_desc);
1126                                kfree(ti_manuf_desc);
1127                                return -ENOMEM;
1128                        }
1129
1130                        /* Validate version number
1131                         * Read the descriptor data
1132                         */
1133                        status = read_rom(serial, start_address +
1134                                        sizeof(struct ti_i2c_desc),
1135                                        sizeof(struct ti_i2c_firmware_rec),
1136                                        (__u8 *)firmware_version);
1137                        if (status) {
1138                                kfree(firmware_version);
1139                                kfree(rom_desc);
1140                                kfree(ti_manuf_desc);
1141                                return status;
1142                        }
1143
1144                        /* Check version number of download with current
1145                           version in I2c */
1146                        download_cur_ver = (firmware_version->Ver_Major << 8) +
1147                                           (firmware_version->Ver_Minor);
1148                        download_new_ver = (OperationalMajorVersion << 8) +
1149                                           (OperationalMinorVersion);
1150
1151                        dbg("%s - >> FW Versions Device %d.%d  Driver %d.%d",
1152                            __func__,
1153                            firmware_version->Ver_Major,
1154                            firmware_version->Ver_Minor,
1155                            OperationalMajorVersion,
1156                            OperationalMinorVersion);
1157
1158                        /* Check if we have an old version in the I2C and
1159                           update if necessary */
1160                        if (download_cur_ver != download_new_ver) {
1161                                dbg("%s - Update I2C dld from %d.%d to %d.%d",
1162                                    __func__,
1163                                    firmware_version->Ver_Major,
1164                                    firmware_version->Ver_Minor,
1165                                    OperationalMajorVersion,
1166                                    OperationalMinorVersion);
1167
1168                                /* In order to update the I2C firmware we must
1169                                 * change the type 2 record to type 0xF2. This
1170                                 * will force the UMP to come up in Boot Mode.
1171                                 * Then while in boot mode, the driver will
1172                                 * download the latest firmware (padded to
1173                                 * 15.5k) into the UMP ram. Finally when the
1174                                 * device comes back up in download mode the
1175                                 * driver will cause the new firmware to be
1176                                 * copied from the UMP Ram to I2C and the
1177                                 * firmware will update the record type from
1178                                 * 0xf2 to 0x02.
1179                                 */
1180                                record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1181
1182                                /* Change the I2C Firmware record type to
1183                                   0xf2 to trigger an update */
1184                                status = write_rom(serial, start_address,
1185                                                sizeof(record), &record);
1186                                if (status) {
1187                                        kfree(firmware_version);
1188                                        kfree(rom_desc);
1189                                        kfree(ti_manuf_desc);
1190                                        return status;
1191                                }
1192
1193                                /* verify the write -- must do this in order
1194                                 * for write to complete before we do the
1195                                 * hardware reset
1196                                 */
1197                                status = read_rom(serial,
1198                                                        start_address,
1199                                                        sizeof(record),
1200                                                        &record);
1201                                if (status) {
1202                                        kfree(firmware_version);
1203                                        kfree(rom_desc);
1204                                        kfree(ti_manuf_desc);
1205                                        return status;
1206                                }
1207
1208                                if (record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1209                                        dev_err(dev,
1210                                                "%s - error resetting device\n",
1211                                                __func__);
1212                                        kfree(firmware_version);
1213                                        kfree(rom_desc);
1214                                        kfree(ti_manuf_desc);
1215                                        return -ENODEV;
1216                                }
1217
1218                                dbg("%s - HARDWARE RESET", __func__);
1219
1220                                /* Reset UMP -- Back to BOOT MODE */
1221                                status = ti_vsend_sync(serial->serial->dev,
1222                                                UMPC_HARDWARE_RESET,
1223                                                0, 0, NULL, 0);
1224
1225                                dbg("%s - HARDWARE RESET return %d",
1226                                                __func__, status);
1227
1228                                /* return an error on purpose. */
1229                                kfree(firmware_version);
1230                                kfree(rom_desc);
1231                                kfree(ti_manuf_desc);
1232                                return -ENODEV;
1233                        }
1234                        kfree(firmware_version);
1235                }
1236                /* Search for type 0xF2 record (firmware blank record) */
1237                else if ((start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc)) != 0) {
1238#define HEADER_SIZE     (sizeof(struct ti_i2c_desc) + \
1239                                        sizeof(struct ti_i2c_firmware_rec))
1240                        __u8 *header;
1241                        __u8 *vheader;
1242
1243                        header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1244                        if (!header) {
1245                                dev_err(dev, "%s - out of memory.\n", __func__);
1246                                kfree(rom_desc);
1247                                kfree(ti_manuf_desc);
1248                                return -ENOMEM;
1249                        }
1250
1251                        vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1252                        if (!vheader) {
1253                                dev_err(dev, "%s - out of memory.\n", __func__);
1254                                kfree(header);
1255                                kfree(rom_desc);
1256                                kfree(ti_manuf_desc);
1257                                return -ENOMEM;
1258                        }
1259
1260                        dbg("%s - Found Type BLANK FIRMWARE (Type F2) record",
1261                                                                __func__);
1262
1263                        /*
1264                         * In order to update the I2C firmware we must change
1265                         * the type 2 record to type 0xF2. This will force the
1266                         * UMP to come up in Boot Mode.  Then while in boot
1267                         * mode, the driver will download the latest firmware
1268                         * (padded to 15.5k) into the UMP ram. Finally when the
1269                         * device comes back up in download mode the driver
1270                         * will cause the new firmware to be copied from the
1271                         * UMP Ram to I2C and the firmware will update the
1272                         * record type from 0xf2 to 0x02.
1273                         */
1274                        status = build_i2c_fw_hdr(header, dev);
1275                        if (status) {
1276                                kfree(vheader);
1277                                kfree(header);
1278                                kfree(rom_desc);
1279                                kfree(ti_manuf_desc);
1280                                return status;
1281                        }
1282
1283                        /* Update I2C with type 0xf2 record with correct
1284                           size and checksum */
1285                        status = write_rom(serial,
1286                                                start_address,
1287                                                HEADER_SIZE,
1288                                                header);
1289                        if (status) {
1290                                kfree(vheader);
1291                                kfree(header);
1292                                kfree(rom_desc);
1293                                kfree(ti_manuf_desc);
1294                                return status;
1295                        }
1296
1297                        /* verify the write -- must do this in order for
1298                           write to complete before we do the hardware reset */
1299                        status = read_rom(serial, start_address,
1300                                                        HEADER_SIZE, vheader);
1301
1302                        if (status) {
1303                                dbg("%s - can't read header back", __func__);
1304                                kfree(vheader);
1305                                kfree(header);
1306                                kfree(rom_desc);
1307                                kfree(ti_manuf_desc);
1308                                return status;
1309                        }
1310                        if (memcmp(vheader, header, HEADER_SIZE)) {
1311                                dbg("%s - write download record failed",
1312                                        __func__);
1313                                kfree(vheader);
1314                                kfree(header);
1315                                kfree(rom_desc);
1316                                kfree(ti_manuf_desc);
1317                                return status;
1318                        }
1319
1320                        kfree(vheader);
1321                        kfree(header);
1322
1323                        dbg("%s - Start firmware update", __func__);
1324
1325                        /* Tell firmware to copy download image into I2C */
1326                        status = ti_vsend_sync(serial->serial->dev,
1327                                        UMPC_COPY_DNLD_TO_I2C, 0, 0, NULL, 0);
1328
1329                        dbg("%s - Update complete 0x%x", __func__, status);
1330                        if (status) {
1331                                dev_err(dev,
1332                                        "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1333                                                                __func__);
1334                                kfree(rom_desc);
1335                                kfree(ti_manuf_desc);
1336                                return status;
1337                        }
1338                }
1339
1340                // The device is running the download code
1341                kfree(rom_desc);
1342                kfree(ti_manuf_desc);
1343                return 0;
1344        }
1345
1346        /********************************************************************/
1347        /* Boot Mode */
1348        /********************************************************************/
1349        dbg("%s - RUNNING IN BOOT MODE", __func__);
1350
1351        /* Configure the TI device so we can use the BULK pipes for download */
1352        status = config_boot_dev(serial->serial->dev);
1353        if (status)
1354                return status;
1355
1356        if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1357                                                        != USB_VENDOR_ID_ION) {
1358                dbg("%s - VID = 0x%x", __func__,
1359                     le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1360                serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1361                goto stayinbootmode;
1362        }
1363
1364        /* We have an ION device (I2c Must be programmed)
1365           Determine I2C image type */
1366        if (i2c_type_bootmode(serial))
1367                goto stayinbootmode;
1368
1369        /* Check for ION Vendor ID and that the I2C is valid */
1370        if (!check_i2c_image(serial)) {
1371                struct ti_i2c_image_header *header;
1372                int i;
1373                __u8 cs = 0;
1374                __u8 *buffer;
1375                int buffer_size;
1376                int err;
1377                const struct firmware *fw;
1378                const char *fw_name = "edgeport/down3.bin";
1379
1380                /* Validate Hardware version number
1381                 * Read Manufacturing Descriptor from TI Based Edgeport
1382                 */
1383                ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1384                if (!ti_manuf_desc) {
1385                        dev_err(dev, "%s - out of memory.\n", __func__);
1386                        return -ENOMEM;
1387                }
1388                status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1389                if (status) {
1390                        kfree(ti_manuf_desc);
1391                        goto stayinbootmode;
1392                }
1393
1394                /* Check for version 2 */
1395                if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1396                        dbg("%s - Wrong CPU Rev %d (Must be 2)",
1397                                        __func__, ti_cpu_rev(ti_manuf_desc));
1398                        kfree(ti_manuf_desc);
1399                        goto stayinbootmode;
1400                }
1401
1402                kfree(ti_manuf_desc);
1403
1404                /*
1405                 * In order to update the I2C firmware we must change the type
1406                 * 2 record to type 0xF2. This will force the UMP to come up
1407                 * in Boot Mode.  Then while in boot mode, the driver will
1408                 * download the latest firmware (padded to 15.5k) into the
1409                 * UMP ram. Finally when the device comes back up in download
1410                 * mode the driver will cause the new firmware to be copied
1411                 * from the UMP Ram to I2C and the firmware will update the
1412                 * record type from 0xf2 to 0x02.
1413                 *
1414                 * Do we really have to copy the whole firmware image,
1415                 * or could we do this in place!
1416                 */
1417
1418                /* Allocate a 15.5k buffer + 3 byte header */
1419                buffer_size = (((1024 * 16) - 512) +
1420                                        sizeof(struct ti_i2c_image_header));
1421                buffer = kmalloc(buffer_size, GFP_KERNEL);
1422                if (!buffer) {
1423                        dev_err(dev, "%s - out of memory\n", __func__);
1424                        return -ENOMEM;
1425                }
1426
1427                /* Initialize the buffer to 0xff (pad the buffer) */
1428                memset(buffer, 0xff, buffer_size);
1429
1430                err = request_firmware(&fw, fw_name, dev);
1431                if (err) {
1432                        printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
1433                               fw_name, err);
1434                        kfree(buffer);
1435                        return err;
1436                }
1437                memcpy(buffer, &fw->data[4], fw->size - 4);
1438                release_firmware(fw);
1439
1440                for (i = sizeof(struct ti_i2c_image_header);
1441                                i < buffer_size; i++) {
1442                        cs = (__u8)(cs + buffer[i]);
1443                }
1444
1445                header = (struct ti_i2c_image_header *)buffer;
1446
1447                /* update length and checksum after padding */
1448                header->Length   = cpu_to_le16((__u16)(buffer_size -
1449                                        sizeof(struct ti_i2c_image_header)));
1450                header->CheckSum = cs;
1451
1452                /* Download the operational code  */
1453                dbg("%s - Downloading operational code image (TI UMP)",
1454                                                                __func__);
1455                status = download_code(serial, buffer, buffer_size);
1456
1457                kfree(buffer);
1458
1459                if (status) {
1460                        dbg("%s - Error downloading operational code image",
1461                                                                __func__);
1462                        return status;
1463                }
1464
1465                /* Device will reboot */
1466                serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1467
1468                dbg("%s - Download successful -- Device rebooting...",
1469                                                                __func__);
1470
1471                /* return an error on purpose */
1472                return -ENODEV;
1473        }
1474
1475stayinbootmode:
1476        /* Eprom is invalid or blank stay in boot mode */
1477        dbg("%s - STAYING IN BOOT MODE", __func__);
1478        serial->product_info.TiMode = TI_MODE_BOOT;
1479
1480        return 0;
1481}
1482
1483
1484static int ti_do_config(struct edgeport_port *port, int feature, int on)
1485{
1486        int port_number = port->port->number - port->port->serial->minor;
1487        on = !!on;      /* 1 or 0 not bitmask */
1488        return send_cmd(port->port->serial->dev,
1489                        feature, (__u8)(UMPM_UART1_PORT + port_number),
1490                        on, NULL, 0);
1491}
1492
1493
1494static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1495{
1496        int status = 0;
1497
1498        dbg("%s - %x", __func__, mcr);
1499
1500        status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1501        if (status)
1502                return status;
1503        status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1504        if (status)
1505                return status;
1506        return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1507}
1508
1509/* Convert TI LSR to standard UART flags */
1510static __u8 map_line_status(__u8 ti_lsr)
1511{
1512        __u8 lsr = 0;
1513
1514#define MAP_FLAG(flagUmp, flagUart)    \
1515        if (ti_lsr & flagUmp) \
1516                lsr |= flagUart;
1517
1518        MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR)    /* overrun */
1519        MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR)     /* parity error */
1520        MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR)     /* framing error */
1521        MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK)       /* break detected */
1522        MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL)    /* rx data available */
1523        MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY)    /* tx hold reg empty */
1524
1525#undef MAP_FLAG
1526
1527        return lsr;
1528}
1529
1530static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1531{
1532        struct async_icount *icount;
1533        struct tty_struct *tty;
1534
1535        dbg("%s - %02x", __func__, msr);
1536
1537        if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1538                        EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1539                icount = &edge_port->icount;
1540
1541                /* update input line counters */
1542                if (msr & EDGEPORT_MSR_DELTA_CTS)
1543                        icount->cts++;
1544                if (msr & EDGEPORT_MSR_DELTA_DSR)
1545                        icount->dsr++;
1546                if (msr & EDGEPORT_MSR_DELTA_CD)
1547                        icount->dcd++;
1548                if (msr & EDGEPORT_MSR_DELTA_RI)
1549                        icount->rng++;
1550                wake_up_interruptible(&edge_port->delta_msr_wait);
1551        }
1552
1553        /* Save the new modem status */
1554        edge_port->shadow_msr = msr & 0xf0;
1555
1556        tty = tty_port_tty_get(&edge_port->port->port);
1557        /* handle CTS flow control */
1558        if (tty && C_CRTSCTS(tty)) {
1559                if (msr & EDGEPORT_MSR_CTS) {
1560                        tty->hw_stopped = 0;
1561                        tty_wakeup(tty);
1562                } else {
1563                        tty->hw_stopped = 1;
1564                }
1565        }
1566        tty_kref_put(tty);
1567
1568        return;
1569}
1570
1571static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1572                                                        __u8 lsr, __u8 data)
1573{
1574        struct async_icount *icount;
1575        __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1576                                                LSR_FRM_ERR | LSR_BREAK));
1577        struct tty_struct *tty;
1578
1579        dbg("%s - %02x", __func__, new_lsr);
1580
1581        edge_port->shadow_lsr = lsr;
1582
1583        if (new_lsr & LSR_BREAK)
1584                /*
1585                 * Parity and Framing errors only count if they
1586                 * occur exclusive of a break being received.
1587                 */
1588                new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1589
1590        /* Place LSR data byte into Rx buffer */
1591        if (lsr_data) {
1592                tty = tty_port_tty_get(&edge_port->port->port);
1593                if (tty) {
1594                        edge_tty_recv(&edge_port->port->dev, tty, &data, 1);
1595                        tty_kref_put(tty);
1596                }
1597        }
1598
1599        /* update input line counters */
1600        icount = &edge_port->icount;
1601        if (new_lsr & LSR_BREAK)
1602                icount->brk++;
1603        if (new_lsr & LSR_OVER_ERR)
1604                icount->overrun++;
1605        if (new_lsr & LSR_PAR_ERR)
1606                icount->parity++;
1607        if (new_lsr & LSR_FRM_ERR)
1608                icount->frame++;
1609}
1610
1611
1612static void edge_interrupt_callback(struct urb *urb)
1613{
1614        struct edgeport_serial *edge_serial = urb->context;
1615        struct usb_serial_port *port;
1616        struct edgeport_port *edge_port;
1617        unsigned char *data = urb->transfer_buffer;
1618        int length = urb->actual_length;
1619        int port_number;
1620        int function;
1621        int retval;
1622        __u8 lsr;
1623        __u8 msr;
1624        int status = urb->status;
1625
1626        dbg("%s", __func__);
1627
1628        switch (status) {
1629        case 0:
1630                /* success */
1631                break;
1632        case -ECONNRESET:
1633        case -ENOENT:
1634        case -ESHUTDOWN:
1635                /* this urb is terminated, clean up */
1636                dbg("%s - urb shutting down with status: %d",
1637                    __func__, status);
1638                return;
1639        default:
1640                dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1641                        "%d\n", __func__, status);
1642                goto exit;
1643        }
1644
1645        if (!length) {
1646                dbg("%s - no data in urb", __func__);
1647                goto exit;
1648        }
1649
1650        usb_serial_debug_data(debug, &edge_serial->serial->dev->dev,
1651                                                __func__, length, data);
1652
1653        if (length != 2) {
1654                dbg("%s - expecting packet of size 2, got %d",
1655                                                        __func__, length);
1656                goto exit;
1657        }
1658
1659        port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1660        function    = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1661        dbg("%s - port_number %d, function %d, info 0x%x",
1662             __func__, port_number, function, data[1]);
1663        port = edge_serial->serial->port[port_number];
1664        edge_port = usb_get_serial_port_data(port);
1665        if (!edge_port) {
1666                dbg("%s - edge_port not found", __func__);
1667                return;
1668        }
1669        switch (function) {
1670        case TIUMP_INTERRUPT_CODE_LSR:
1671                lsr = map_line_status(data[1]);
1672                if (lsr & UMP_UART_LSR_DATA_MASK) {
1673                        /* Save the LSR event for bulk read
1674                           completion routine */
1675                        dbg("%s - LSR Event Port %u LSR Status = %02x",
1676                             __func__, port_number, lsr);
1677                        edge_port->lsr_event = 1;
1678                        edge_port->lsr_mask = lsr;
1679                } else {
1680                        dbg("%s - ===== Port %d LSR Status = %02x ======",
1681                             __func__, port_number, lsr);
1682                        handle_new_lsr(edge_port, 0, lsr, 0);
1683                }
1684                break;
1685
1686        case TIUMP_INTERRUPT_CODE_MSR:  /* MSR */
1687                /* Copy MSR from UMP */
1688                msr = data[1];
1689                dbg("%s - ===== Port %u MSR Status = %02x ======\n",
1690                     __func__, port_number, msr);
1691                handle_new_msr(edge_port, msr);
1692                break;
1693
1694        default:
1695                dev_err(&urb->dev->dev,
1696                        "%s - Unknown Interrupt code from UMP %x\n",
1697                        __func__, data[1]);
1698                break;
1699
1700        }
1701
1702exit:
1703        retval = usb_submit_urb(urb, GFP_ATOMIC);
1704        if (retval)
1705                dev_err(&urb->dev->dev,
1706                        "%s - usb_submit_urb failed with result %d\n",
1707                         __func__, retval);
1708}
1709
1710static void edge_bulk_in_callback(struct urb *urb)
1711{
1712        struct edgeport_port *edge_port = urb->context;
1713        unsigned char *data = urb->transfer_buffer;
1714        struct tty_struct *tty;
1715        int retval = 0;
1716        int port_number;
1717        int status = urb->status;
1718
1719        dbg("%s", __func__);
1720
1721        switch (status) {
1722        case 0:
1723                /* success */
1724                break;
1725        case -ECONNRESET:
1726        case -ENOENT:
1727        case -ESHUTDOWN:
1728                /* this urb is terminated, clean up */
1729                dbg("%s - urb shutting down with status: %d",
1730                    __func__, status);
1731                return;
1732        default:
1733                dev_err(&urb->dev->dev,
1734                        "%s - nonzero read bulk status received: %d\n",
1735                             __func__, status);
1736        }
1737
1738        if (status == -EPIPE)
1739                goto exit;
1740
1741        if (status) {
1742                dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1743                return;
1744        }
1745
1746        port_number = edge_port->port->number - edge_port->port->serial->minor;
1747
1748        if (edge_port->lsr_event) {
1749                edge_port->lsr_event = 0;
1750                dbg("%s ===== Port %u LSR Status = %02x, Data = %02x ======",
1751                     __func__, port_number, edge_port->lsr_mask, *data);
1752                handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1753                /* Adjust buffer length/pointer */
1754                --urb->actual_length;
1755                ++data;
1756        }
1757
1758        tty = tty_port_tty_get(&edge_port->port->port);
1759        if (tty && urb->actual_length) {
1760                usb_serial_debug_data(debug, &edge_port->port->dev,
1761                                        __func__, urb->actual_length, data);
1762                if (edge_port->close_pending)
1763                        dbg("%s - close pending, dropping data on the floor",
1764                                                                __func__);
1765                else
1766                        edge_tty_recv(&edge_port->port->dev, tty, data,
1767                                                        urb->actual_length);
1768                edge_port->icount.rx += urb->actual_length;
1769        }
1770        tty_kref_put(tty);
1771
1772exit:
1773        /* continue read unless stopped */
1774        spin_lock(&edge_port->ep_lock);
1775        if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING) {
1776                urb->dev = edge_port->port->serial->dev;
1777                retval = usb_submit_urb(urb, GFP_ATOMIC);
1778        } else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING) {
1779                edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1780        }
1781        spin_unlock(&edge_port->ep_lock);
1782        if (retval)
1783                dev_err(&urb->dev->dev,
1784                        "%s - usb_submit_urb failed with result %d\n",
1785                         __func__, retval);
1786}
1787
1788static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
1789                                        unsigned char *data, int length)
1790{
1791        int queued;
1792
1793        tty_buffer_request_room(tty, length);
1794        queued = tty_insert_flip_string(tty, data, length);
1795        if (queued < length)
1796                dev_err(dev, "%s - dropping data, %d bytes lost\n",
1797                        __func__, length - queued);
1798        tty_flip_buffer_push(tty);
1799}
1800
1801static void edge_bulk_out_callback(struct urb *urb)
1802{
1803        struct usb_serial_port *port = urb->context;
1804        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1805        int status = urb->status;
1806        struct tty_struct *tty;
1807
1808        dbg("%s - port %d", __func__, port->number);
1809
1810        edge_port->ep_write_urb_in_use = 0;
1811
1812        switch (status) {
1813        case 0:
1814                /* success */
1815                break;
1816        case -ECONNRESET:
1817        case -ENOENT:
1818        case -ESHUTDOWN:
1819                /* this urb is terminated, clean up */
1820                dbg("%s - urb shutting down with status: %d",
1821                    __func__, status);
1822                return;
1823        default:
1824                dev_err(&urb->dev->dev, "%s - nonzero write bulk status "
1825                        "received: %d\n", __func__, status);
1826        }
1827
1828        /* send any buffered data */
1829        tty = tty_port_tty_get(&port->port);
1830        edge_send(tty);
1831        tty_kref_put(tty);
1832}
1833
1834static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1835{
1836        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1837        struct edgeport_serial *edge_serial;
1838        struct usb_device *dev;
1839        struct urb *urb;
1840        int port_number;
1841        int status;
1842        u16 open_settings;
1843        u8 transaction_timeout;
1844
1845        dbg("%s - port %d", __func__, port->number);
1846
1847        if (edge_port == NULL)
1848                return -ENODEV;
1849
1850        port_number = port->number - port->serial->minor;
1851        switch (port_number) {
1852        case 0:
1853                edge_port->uart_base = UMPMEM_BASE_UART1;
1854                edge_port->dma_address = UMPD_OEDB1_ADDRESS;
1855                break;
1856        case 1:
1857                edge_port->uart_base = UMPMEM_BASE_UART2;
1858                edge_port->dma_address = UMPD_OEDB2_ADDRESS;
1859                break;
1860        default:
1861                dev_err(&port->dev, "Unknown port number!!!\n");
1862                return -ENODEV;
1863        }
1864
1865        dbg("%s - port_number = %d, uart_base = %04x, dma_address = %04x",
1866                                __func__, port_number, edge_port->uart_base,
1867                                edge_port->dma_address);
1868
1869        dev = port->serial->dev;
1870
1871        memset(&(edge_port->icount), 0x00, sizeof(edge_port->icount));
1872        init_waitqueue_head(&edge_port->delta_msr_wait);
1873
1874        /* turn off loopback */
1875        status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1876        if (status) {
1877                dev_err(&port->dev,
1878                                "%s - cannot send clear loopback command, %d\n",
1879                        __func__, status);
1880                return status;
1881        }
1882
1883        /* set up the port settings */
1884        if (tty)
1885                edge_set_termios(tty, port, tty->termios);
1886
1887        /* open up the port */
1888
1889        /* milliseconds to timeout for DMA transfer */
1890        transaction_timeout = 2;
1891
1892        edge_port->ump_read_timeout =
1893                                max(20, ((transaction_timeout * 3) / 2));
1894
1895        /* milliseconds to timeout for DMA transfer */
1896        open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1897                             UMP_PIPE_TRANS_TIMEOUT_ENA |
1898                             (transaction_timeout << 2));
1899
1900        dbg("%s - Sending UMPC_OPEN_PORT", __func__);
1901
1902        /* Tell TI to open and start the port */
1903        status = send_cmd(dev, UMPC_OPEN_PORT,
1904                (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1905        if (status) {
1906                dev_err(&port->dev, "%s - cannot send open command, %d\n",
1907                                                        __func__, status);
1908                return status;
1909        }
1910
1911        /* Start the DMA? */
1912        status = send_cmd(dev, UMPC_START_PORT,
1913                (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1914        if (status) {
1915                dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1916                                                        __func__, status);
1917                return status;
1918        }
1919
1920        /* Clear TX and RX buffers in UMP */
1921        status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1922        if (status) {
1923                dev_err(&port->dev,
1924                        "%s - cannot send clear buffers command, %d\n",
1925                        __func__, status);
1926                return status;
1927        }
1928
1929        /* Read Initial MSR */
1930        status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1931                                (__u16)(UMPM_UART1_PORT + port_number),
1932                                &edge_port->shadow_msr, 1);
1933        if (status) {
1934                dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1935                                                        __func__, status);
1936                return status;
1937        }
1938
1939        dbg("ShadowMSR 0x%X", edge_port->shadow_msr);
1940
1941        /* Set Initial MCR */
1942        edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1943        dbg("ShadowMCR 0x%X", edge_port->shadow_mcr);
1944
1945        edge_serial = edge_port->edge_serial;
1946        if (mutex_lock_interruptible(&edge_serial->es_lock))
1947                return -ERESTARTSYS;
1948        if (edge_serial->num_ports_open == 0) {
1949                /* we are the first port to open, post the interrupt urb */
1950                urb = edge_serial->serial->port[0]->interrupt_in_urb;
1951                if (!urb) {
1952                        dev_err(&port->dev,
1953                                "%s - no interrupt urb present, exiting\n",
1954                                __func__);
1955                        status = -EINVAL;
1956                        goto release_es_lock;
1957                }
1958                urb->complete = edge_interrupt_callback;
1959                urb->context = edge_serial;
1960                urb->dev = dev;
1961                status = usb_submit_urb(urb, GFP_KERNEL);
1962                if (status) {
1963                        dev_err(&port->dev,
1964                                "%s - usb_submit_urb failed with value %d\n",
1965                                        __func__, status);
1966                        goto release_es_lock;
1967                }
1968        }
1969
1970        /*
1971         * reset the data toggle on the bulk endpoints to work around bug in
1972         * host controllers where things get out of sync some times
1973         */
1974        usb_clear_halt(dev, port->write_urb->pipe);
1975        usb_clear_halt(dev, port->read_urb->pipe);
1976
1977        /* start up our bulk read urb */
1978        urb = port->read_urb;
1979        if (!urb) {
1980                dev_err(&port->dev, "%s - no read urb present, exiting\n",
1981                                                                __func__);
1982                status = -EINVAL;
1983                goto unlink_int_urb;
1984        }
1985        edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1986        urb->complete = edge_bulk_in_callback;
1987        urb->context = edge_port;
1988        urb->dev = dev;
1989        status = usb_submit_urb(urb, GFP_KERNEL);
1990        if (status) {
1991                dev_err(&port->dev,
1992                        "%s - read bulk usb_submit_urb failed with value %d\n",
1993                                __func__, status);
1994                goto unlink_int_urb;
1995        }
1996
1997        ++edge_serial->num_ports_open;
1998
1999        dbg("%s - exited", __func__);
2000
2001        goto release_es_lock;
2002
2003unlink_int_urb:
2004        if (edge_port->edge_serial->num_ports_open == 0)
2005                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2006release_es_lock:
2007        mutex_unlock(&edge_serial->es_lock);
2008        return status;
2009}
2010
2011static void edge_close(struct usb_serial_port *port)
2012{
2013        struct edgeport_serial *edge_serial;
2014        struct edgeport_port *edge_port;
2015        int port_number;
2016        int status;
2017
2018        dbg("%s - port %d", __func__, port->number);
2019
2020        edge_serial = usb_get_serial_data(port->serial);
2021        edge_port = usb_get_serial_port_data(port);
2022        if (edge_serial == NULL || edge_port == NULL)
2023                return;
2024
2025        /* The bulkreadcompletion routine will check
2026         * this flag and dump add read data */
2027        edge_port->close_pending = 1;
2028
2029        /* chase the port close and flush */
2030        chase_port(edge_port, (HZ * closing_wait) / 100, 1);
2031
2032        usb_kill_urb(port->read_urb);
2033        usb_kill_urb(port->write_urb);
2034        edge_port->ep_write_urb_in_use = 0;
2035
2036        /* assuming we can still talk to the device,
2037         * send a close port command to it */
2038        dbg("%s - send umpc_close_port", __func__);
2039        port_number = port->number - port->serial->minor;
2040        status = send_cmd(port->serial->dev,
2041                                     UMPC_CLOSE_PORT,
2042                                     (__u8)(UMPM_UART1_PORT + port_number),
2043                                     0,
2044                                     NULL,
2045                                     0);
2046        mutex_lock(&edge_serial->es_lock);
2047        --edge_port->edge_serial->num_ports_open;
2048        if (edge_port->edge_serial->num_ports_open <= 0) {
2049                /* last port is now closed, let's shut down our interrupt urb */
2050                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2051                edge_port->edge_serial->num_ports_open = 0;
2052        }
2053        mutex_unlock(&edge_serial->es_lock);
2054        edge_port->close_pending = 0;
2055
2056        dbg("%s - exited", __func__);
2057}
2058
2059static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2060                                const unsigned char *data, int count)
2061{
2062        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2063        unsigned long flags;
2064
2065        dbg("%s - port %d", __func__, port->number);
2066
2067        if (count == 0) {
2068                dbg("%s - write request of 0 bytes", __func__);
2069                return 0;
2070        }
2071
2072        if (edge_port == NULL)
2073                return -ENODEV;
2074        if (edge_port->close_pending == 1)
2075                return -ENODEV;
2076
2077        spin_lock_irqsave(&edge_port->ep_lock, flags);
2078        count = edge_buf_put(edge_port->ep_out_buf, data, count);
2079        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2080
2081        edge_send(tty);
2082
2083        return count;
2084}
2085
2086static void edge_send(struct tty_struct *tty)
2087{
2088        struct usb_serial_port *port = tty->driver_data;
2089        int count, result;
2090        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2091        unsigned long flags;
2092
2093
2094        dbg("%s - port %d", __func__, port->number);
2095
2096        spin_lock_irqsave(&edge_port->ep_lock, flags);
2097
2098        if (edge_port->ep_write_urb_in_use) {
2099                spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2100                return;
2101        }
2102
2103        count = edge_buf_get(edge_port->ep_out_buf,
2104                                port->write_urb->transfer_buffer,
2105                                port->bulk_out_size);
2106
2107        if (count == 0) {
2108                spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2109                return;
2110        }
2111
2112        edge_port->ep_write_urb_in_use = 1;
2113
2114        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2115
2116        usb_serial_debug_data(debug, &port->dev, __func__, count,
2117                                port->write_urb->transfer_buffer);
2118
2119        /* set up our urb */
2120        usb_fill_bulk_urb(port->write_urb, port->serial->dev,
2121                           usb_sndbulkpipe(port->serial->dev,
2122                                            port->bulk_out_endpointAddress),
2123                           port->write_urb->transfer_buffer, count,
2124                           edge_bulk_out_callback,
2125                           port);
2126
2127        /* send the data out the bulk port */
2128        result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2129        if (result) {
2130                dev_err(&port->dev,
2131                        "%s - failed submitting write urb, error %d\n",
2132                                __func__, result);
2133                edge_port->ep_write_urb_in_use = 0;
2134                /* TODO: reschedule edge_send */
2135        } else
2136                edge_port->icount.tx += count;
2137
2138        /* wakeup any process waiting for writes to complete */
2139        /* there is now more room in the buffer for new writes */
2140        if (tty)
2141                tty_wakeup(tty);
2142}
2143
2144static int edge_write_room(struct tty_struct *tty)
2145{
2146        struct usb_serial_port *port = tty->driver_data;
2147        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2148        int room = 0;
2149        unsigned long flags;
2150
2151        dbg("%s - port %d", __func__, port->number);
2152
2153        if (edge_port == NULL)
2154                return 0;
2155        if (edge_port->close_pending == 1)
2156                return 0;
2157
2158        spin_lock_irqsave(&edge_port->ep_lock, flags);
2159        room = edge_buf_space_avail(edge_port->ep_out_buf);
2160        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2161
2162        dbg("%s - returns %d", __func__, room);
2163        return room;
2164}
2165
2166static int edge_chars_in_buffer(struct tty_struct *tty)
2167{
2168        struct usb_serial_port *port = tty->driver_data;
2169        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2170        int chars = 0;
2171        unsigned long flags;
2172
2173        dbg("%s - port %d", __func__, port->number);
2174
2175        if (edge_port == NULL)
2176                return 0;
2177        if (edge_port->close_pending == 1)
2178                return 0;
2179
2180        spin_lock_irqsave(&edge_port->ep_lock, flags);
2181        chars = edge_buf_data_avail(edge_port->ep_out_buf);
2182        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2183
2184        dbg("%s - returns %d", __func__, chars);
2185        return chars;
2186}
2187
2188static void edge_throttle(struct tty_struct *tty)
2189{
2190        struct usb_serial_port *port = tty->driver_data;
2191        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2192        int status;
2193
2194        dbg("%s - port %d", __func__, port->number);
2195
2196        if (edge_port == NULL)
2197                return;
2198
2199        /* if we are implementing XON/XOFF, send the stop character */
2200        if (I_IXOFF(tty)) {
2201                unsigned char stop_char = STOP_CHAR(tty);
2202                status = edge_write(tty, port, &stop_char, 1);
2203                if (status <= 0) {
2204                        dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2205                }
2206        }
2207
2208        /* if we are implementing RTS/CTS, stop reads */
2209        /* and the Edgeport will clear the RTS line */
2210        if (C_CRTSCTS(tty))
2211                stop_read(edge_port);
2212
2213}
2214
2215static void edge_unthrottle(struct tty_struct *tty)
2216{
2217        struct usb_serial_port *port = tty->driver_data;
2218        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2219        int status;
2220
2221        dbg("%s - port %d", __func__, port->number);
2222
2223        if (edge_port == NULL)
2224                return;
2225
2226        /* if we are implementing XON/XOFF, send the start character */
2227        if (I_IXOFF(tty)) {
2228                unsigned char start_char = START_CHAR(tty);
2229                status = edge_write(tty, port, &start_char, 1);
2230                if (status <= 0) {
2231                        dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2232                }
2233        }
2234        /* if we are implementing RTS/CTS, restart reads */
2235        /* are the Edgeport will assert the RTS line */
2236        if (C_CRTSCTS(tty)) {
2237                status = restart_read(edge_port);
2238                if (status)
2239                        dev_err(&port->dev,
2240                                "%s - read bulk usb_submit_urb failed: %d\n",
2241                                                        __func__, status);
2242        }
2243
2244}
2245
2246static void stop_read(struct edgeport_port *edge_port)
2247{
2248        unsigned long flags;
2249
2250        spin_lock_irqsave(&edge_port->ep_lock, flags);
2251
2252        if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2253                edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2254        edge_port->shadow_mcr &= ~MCR_RTS;
2255
2256        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2257}
2258
2259static int restart_read(struct edgeport_port *edge_port)
2260{
2261        struct urb *urb;
2262        int status = 0;
2263        unsigned long flags;
2264
2265        spin_lock_irqsave(&edge_port->ep_lock, flags);
2266
2267        if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2268                urb = edge_port->port->read_urb;
2269                urb->complete = edge_bulk_in_callback;
2270                urb->context = edge_port;
2271                urb->dev = edge_port->port->serial->dev;
2272                status = usb_submit_urb(urb, GFP_ATOMIC);
2273        }
2274        edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2275        edge_port->shadow_mcr |= MCR_RTS;
2276
2277        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2278
2279        return status;
2280}
2281
2282static void change_port_settings(struct tty_struct *tty,
2283                struct edgeport_port *edge_port, struct ktermios *old_termios)
2284{
2285        struct ump_uart_config *config;
2286        int baud;
2287        unsigned cflag;
2288        int status;
2289        int port_number = edge_port->port->number -
2290                                        edge_port->port->serial->minor;
2291
2292        dbg("%s - port %d", __func__, edge_port->port->number);
2293
2294        config = kmalloc (sizeof (*config), GFP_KERNEL);
2295        if (!config) {
2296                *tty->termios = *old_termios;
2297                dev_err(&edge_port->port->dev, "%s - out of memory\n",
2298                                                                __func__);
2299                return;
2300        }
2301
2302        cflag = tty->termios->c_cflag;
2303
2304        config->wFlags = 0;
2305
2306        /* These flags must be set */
2307        config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2308        config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2309        config->bUartMode = (__u8)(edge_port->bUartMode);
2310
2311        switch (cflag & CSIZE) {
2312        case CS5:
2313                    config->bDataBits = UMP_UART_CHAR5BITS;
2314                    dbg("%s - data bits = 5", __func__);
2315                    break;
2316        case CS6:
2317                    config->bDataBits = UMP_UART_CHAR6BITS;
2318                    dbg("%s - data bits = 6", __func__);
2319                    break;
2320        case CS7:
2321                    config->bDataBits = UMP_UART_CHAR7BITS;
2322                    dbg("%s - data bits = 7", __func__);
2323                    break;
2324        default:
2325        case CS8:
2326                    config->bDataBits = UMP_UART_CHAR8BITS;
2327                    dbg("%s - data bits = 8", __func__);
2328                            break;
2329        }
2330
2331        if (cflag & PARENB) {
2332                if (cflag & PARODD) {
2333                        config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2334                        config->bParity = UMP_UART_ODDPARITY;
2335                        dbg("%s - parity = odd", __func__);
2336                } else {
2337                        config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2338                        config->bParity = UMP_UART_EVENPARITY;
2339                        dbg("%s - parity = even", __func__);
2340                }
2341        } else {
2342                config->bParity = UMP_UART_NOPARITY;
2343                dbg("%s - parity = none", __func__);
2344        }
2345
2346        if (cflag & CSTOPB) {
2347                config->bStopBits = UMP_UART_STOPBIT2;
2348                dbg("%s - stop bits = 2", __func__);
2349        } else {
2350                config->bStopBits = UMP_UART_STOPBIT1;
2351                dbg("%s - stop bits = 1", __func__);
2352        }
2353
2354        /* figure out the flow control settings */
2355        if (cflag & CRTSCTS) {
2356                config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2357                config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2358                dbg("%s - RTS/CTS is enabled", __func__);
2359        } else {
2360                dbg("%s - RTS/CTS is disabled", __func__);
2361                tty->hw_stopped = 0;
2362                restart_read(edge_port);
2363        }
2364
2365        /* if we are implementing XON/XOFF, set the start and stop
2366           character in the device */
2367        config->cXon  = START_CHAR(tty);
2368        config->cXoff = STOP_CHAR(tty);
2369
2370        /* if we are implementing INBOUND XON/XOFF */
2371        if (I_IXOFF(tty)) {
2372                config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2373                dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
2374                     __func__, config->cXon, config->cXoff);
2375        } else
2376                dbg("%s - INBOUND XON/XOFF is disabled", __func__);
2377
2378        /* if we are implementing OUTBOUND XON/XOFF */
2379        if (I_IXON(tty)) {
2380                config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2381                dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
2382                     __func__, config->cXon, config->cXoff);
2383        } else
2384                dbg("%s - OUTBOUND XON/XOFF is disabled", __func__);
2385
2386        tty->termios->c_cflag &= ~CMSPAR;
2387
2388        /* Round the baud rate */
2389        baud = tty_get_baud_rate(tty);
2390        if (!baud) {
2391                /* pick a default, any default... */
2392                baud = 9600;
2393        } else
2394                tty_encode_baud_rate(tty, baud, baud);
2395
2396        edge_port->baud_rate = baud;
2397        config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2398
2399        /* FIXME: Recompute actual baud from divisor here */
2400
2401        dbg("%s - baud rate = %d, wBaudRate = %d", __func__, baud,
2402                                                        config->wBaudRate);
2403
2404        dbg("wBaudRate:   %d", (int)(461550L / config->wBaudRate));
2405        dbg("wFlags:    0x%x", config->wFlags);
2406        dbg("bDataBits:   %d", config->bDataBits);
2407        dbg("bParity:     %d", config->bParity);
2408        dbg("bStopBits:   %d", config->bStopBits);
2409        dbg("cXon:        %d", config->cXon);
2410        dbg("cXoff:       %d", config->cXoff);
2411        dbg("bUartMode:   %d", config->bUartMode);
2412
2413        /* move the word values into big endian mode */
2414        cpu_to_be16s(&config->wFlags);
2415        cpu_to_be16s(&config->wBaudRate);
2416
2417        status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2418                                (__u8)(UMPM_UART1_PORT + port_number),
2419                                0, (__u8 *)config, sizeof(*config));
2420        if (status)
2421                dbg("%s - error %d when trying to write config to device",
2422                     __func__, status);
2423        kfree(config);
2424        return;
2425}
2426
2427static void edge_set_termios(struct tty_struct *tty,
2428                struct usb_serial_port *port, struct ktermios *old_termios)
2429{
2430        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2431        unsigned int cflag;
2432
2433        cflag = tty->termios->c_cflag;
2434
2435        dbg("%s - clfag %08x iflag %08x", __func__,
2436            tty->termios->c_cflag, tty->termios->c_iflag);
2437        dbg("%s - old clfag %08x old iflag %08x", __func__,
2438            old_termios->c_cflag, old_termios->c_iflag);
2439        dbg("%s - port %d", __func__, port->number);
2440
2441        if (edge_port == NULL)
2442                return;
2443        /* change the port settings to the new ones specified */
2444        change_port_settings(tty, edge_port, old_termios);
2445        return;
2446}
2447
2448static int edge_tiocmset(struct tty_struct *tty, struct file *file,
2449                                        unsigned int set, unsigned int clear)
2450{
2451        struct usb_serial_port *port = tty->driver_data;
2452        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2453        unsigned int mcr;
2454        unsigned long flags;
2455
2456        dbg("%s - port %d", __func__, port->number);
2457
2458        spin_lock_irqsave(&edge_port->ep_lock, flags);
2459        mcr = edge_port->shadow_mcr;
2460        if (set & TIOCM_RTS)
2461                mcr |= MCR_RTS;
2462        if (set & TIOCM_DTR)
2463                mcr |= MCR_DTR;
2464        if (set & TIOCM_LOOP)
2465                mcr |= MCR_LOOPBACK;
2466
2467        if (clear & TIOCM_RTS)
2468                mcr &= ~MCR_RTS;
2469        if (clear & TIOCM_DTR)
2470                mcr &= ~MCR_DTR;
2471        if (clear & TIOCM_LOOP)
2472                mcr &= ~MCR_LOOPBACK;
2473
2474        edge_port->shadow_mcr = mcr;
2475        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2476
2477        restore_mcr(edge_port, mcr);
2478        return 0;
2479}
2480
2481static int edge_tiocmget(struct tty_struct *tty, struct file *file)
2482{
2483        struct usb_serial_port *port = tty->driver_data;
2484        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2485        unsigned int result = 0;
2486        unsigned int msr;
2487        unsigned int mcr;
2488        unsigned long flags;
2489
2490        dbg("%s - port %d", __func__, port->number);
2491
2492        spin_lock_irqsave(&edge_port->ep_lock, flags);
2493
2494        msr = edge_port->shadow_msr;
2495        mcr = edge_port->shadow_mcr;
2496        result = ((mcr & MCR_DTR)       ? TIOCM_DTR: 0)   /* 0x002 */
2497                  | ((mcr & MCR_RTS)    ? TIOCM_RTS: 0)   /* 0x004 */
2498                  | ((msr & EDGEPORT_MSR_CTS)   ? TIOCM_CTS: 0)   /* 0x020 */
2499                  | ((msr & EDGEPORT_MSR_CD)    ? TIOCM_CAR: 0)   /* 0x040 */
2500                  | ((msr & EDGEPORT_MSR_RI)    ? TIOCM_RI:  0)   /* 0x080 */
2501                  | ((msr & EDGEPORT_MSR_DSR)   ? TIOCM_DSR: 0);  /* 0x100 */
2502
2503
2504        dbg("%s -- %x", __func__, result);
2505        spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2506
2507        return result;
2508}
2509
2510static int get_serial_info(struct edgeport_port *edge_port,
2511                                struct serial_struct __user *retinfo)
2512{
2513        struct serial_struct tmp;
2514
2515        if (!retinfo)
2516                return -EFAULT;
2517
2518        memset(&tmp, 0, sizeof(tmp));
2519
2520        tmp.type                = PORT_16550A;
2521        tmp.line                = edge_port->port->serial->minor;
2522        tmp.port                = edge_port->port->number;
2523        tmp.irq                 = 0;
2524        tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
2525        tmp.xmit_fifo_size      = edge_port->port->bulk_out_size;
2526        tmp.baud_base           = 9600;
2527        tmp.close_delay         = 5*HZ;
2528        tmp.closing_wait        = closing_wait;
2529
2530        if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
2531                return -EFAULT;
2532        return 0;
2533}
2534
2535static int edge_ioctl(struct tty_struct *tty, struct file *file,
2536                                        unsigned int cmd, unsigned long arg)
2537{
2538        struct usb_serial_port *port = tty->driver_data;
2539        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2540        struct async_icount cnow;
2541        struct async_icount cprev;
2542
2543        dbg("%s - port %d, cmd = 0x%x", __func__, port->number, cmd);
2544
2545        switch (cmd) {
2546        case TIOCGSERIAL:
2547                dbg("%s - (%d) TIOCGSERIAL", __func__, port->number);
2548                return get_serial_info(edge_port,
2549                                (struct serial_struct __user *) arg);
2550        case TIOCMIWAIT:
2551                dbg("%s - (%d) TIOCMIWAIT", __func__, port->number);
2552                cprev = edge_port->icount;
2553                while (1) {
2554                        interruptible_sleep_on(&edge_port->delta_msr_wait);
2555                        /* see if a signal did it */
2556                        if (signal_pending(current))
2557                                return -ERESTARTSYS;
2558                        cnow = edge_port->icount;
2559                        if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
2560                            cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
2561                                return -EIO; /* no change => error */
2562                        if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
2563                            ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
2564                            ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
2565                            ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
2566                                return 0;
2567                        }
2568                        cprev = cnow;
2569                }
2570                /* not reached */
2571                break;
2572        case TIOCGICOUNT:
2573                dbg("%s - (%d) TIOCGICOUNT RX=%d, TX=%d", __func__,
2574                     port->number, edge_port->icount.rx, edge_port->icount.tx);
2575                if (copy_to_user((void __user *)arg, &edge_port->icount,
2576                                sizeof(edge_port->icount)))
2577                        return -EFAULT;
2578                return 0;
2579        }
2580        return -ENOIOCTLCMD;
2581}
2582
2583static void edge_break(struct tty_struct *tty, int break_state)
2584{
2585        struct usb_serial_port *port = tty->driver_data;
2586        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2587        int status;
2588        int bv = 0;     /* Off */
2589
2590        dbg("%s - state = %d", __func__, break_state);
2591
2592        /* chase the port close */
2593        chase_port(edge_port, 0, 0);
2594
2595        if (break_state == -1)
2596                bv = 1; /* On */
2597        status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2598        if (status)
2599                dbg("%s - error %d sending break set/clear command.",
2600                     __func__, status);
2601}
2602
2603static int edge_startup(struct usb_serial *serial)
2604{
2605        struct edgeport_serial *edge_serial;
2606        struct edgeport_port *edge_port;
2607        struct usb_device *dev;
2608        int status;
2609        int i;
2610
2611        dev = serial->dev;
2612
2613        /* create our private serial structure */
2614        edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2615        if (edge_serial == NULL) {
2616                dev_err(&serial->dev->dev, "%s - Out of memory\n", __func__);
2617                return -ENOMEM;
2618        }
2619        mutex_init(&edge_serial->es_lock);
2620        edge_serial->serial = serial;
2621        usb_set_serial_data(serial, edge_serial);
2622
2623        status = download_fw(edge_serial);
2624        if (status) {
2625                kfree(edge_serial);
2626                return status;
2627        }
2628
2629        /* set up our port private structures */
2630        for (i = 0; i < serial->num_ports; ++i) {
2631                edge_port = kzalloc(sizeof(struct edgeport_port), GFP_KERNEL);
2632                if (edge_port == NULL) {
2633                        dev_err(&serial->dev->dev, "%s - Out of memory\n",
2634                                                                __func__);
2635                        goto cleanup;
2636                }
2637                spin_lock_init(&edge_port->ep_lock);
2638                edge_port->ep_out_buf = edge_buf_alloc(EDGE_OUT_BUF_SIZE);
2639                if (edge_port->ep_out_buf == NULL) {
2640                        dev_err(&serial->dev->dev, "%s - Out of memory\n",
2641                                                                __func__);
2642                        kfree(edge_port);
2643                        goto cleanup;
2644                }
2645                edge_port->port = serial->port[i];
2646                edge_port->edge_serial = edge_serial;
2647                usb_set_serial_port_data(serial->port[i], edge_port);
2648                edge_port->bUartMode = default_uart_mode;
2649        }
2650
2651        return 0;
2652
2653cleanup:
2654        for (--i; i >= 0; --i) {
2655                edge_port = usb_get_serial_port_data(serial->port[i]);
2656                edge_buf_free(edge_port->ep_out_buf);
2657                kfree(edge_port);
2658                usb_set_serial_port_data(serial->port[i], NULL);
2659        }
2660        kfree(edge_serial);
2661        usb_set_serial_data(serial, NULL);
2662        return -ENOMEM;
2663}
2664
2665static void edge_disconnect(struct usb_serial *serial)
2666{
2667        int i;
2668        struct edgeport_port *edge_port;
2669
2670        dbg("%s", __func__);
2671
2672        for (i = 0; i < serial->num_ports; ++i) {
2673                edge_port = usb_get_serial_port_data(serial->port[i]);
2674                edge_remove_sysfs_attrs(edge_port->port);
2675        }
2676}
2677
2678static void edge_release(struct usb_serial *serial)
2679{
2680        int i;
2681        struct edgeport_port *edge_port;
2682
2683        dbg("%s", __func__);
2684
2685        for (i = 0; i < serial->num_ports; ++i) {
2686                edge_port = usb_get_serial_port_data(serial->port[i]);
2687                edge_buf_free(edge_port->ep_out_buf);
2688                kfree(edge_port);
2689        }
2690        kfree(usb_get_serial_data(serial));
2691}
2692
2693
2694/* Sysfs Attributes */
2695
2696static ssize_t show_uart_mode(struct device *dev,
2697        struct device_attribute *attr, char *buf)
2698{
2699        struct usb_serial_port *port = to_usb_serial_port(dev);
2700        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2701
2702        return sprintf(buf, "%d\n", edge_port->bUartMode);
2703}
2704
2705static ssize_t store_uart_mode(struct device *dev,
2706        struct device_attribute *attr, const char *valbuf, size_t count)
2707{
2708        struct usb_serial_port *port = to_usb_serial_port(dev);
2709        struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2710        unsigned int v = simple_strtoul(valbuf, NULL, 0);
2711
2712        dbg("%s: setting uart_mode = %d", __func__, v);
2713
2714        if (v < 256)
2715                edge_port->bUartMode = v;
2716        else
2717                dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2718
2719        return count;
2720}
2721
2722static DEVICE_ATTR(uart_mode, S_IWUSR | S_IRUGO, show_uart_mode,
2723                                                        store_uart_mode);
2724
2725static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2726{
2727        return device_create_file(&port->dev, &dev_attr_uart_mode);
2728}
2729
2730static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2731{
2732        device_remove_file(&port->dev, &dev_attr_uart_mode);
2733        return 0;
2734}
2735
2736
2737/* Circular Buffer */
2738
2739/*
2740 * edge_buf_alloc
2741 *
2742 * Allocate a circular buffer and all associated memory.
2743 */
2744
2745static struct edge_buf *edge_buf_alloc(unsigned int size)
2746{
2747        struct edge_buf *eb;
2748
2749
2750        if (size == 0)
2751                return NULL;
2752
2753        eb = kmalloc(sizeof(struct edge_buf), GFP_KERNEL);
2754        if (eb == NULL)
2755                return NULL;
2756
2757        eb->buf_buf = kmalloc(size, GFP_KERNEL);
2758        if (eb->buf_buf == NULL) {
2759                kfree(eb);
2760                return NULL;
2761        }
2762
2763        eb->buf_size = size;
2764        eb->buf_get = eb->buf_put = eb->buf_buf;
2765
2766        return eb;
2767}
2768
2769
2770/*
2771 * edge_buf_free
2772 *
2773 * Free the buffer and all associated memory.
2774 */
2775
2776static void edge_buf_free(struct edge_buf *eb)
2777{
2778        if (eb) {
2779                kfree(eb->buf_buf);
2780                kfree(eb);
2781        }
2782}
2783
2784
2785/*
2786 * edge_buf_clear
2787 *
2788 * Clear out all data in the circular buffer.
2789 */
2790
2791static void edge_buf_clear(struct edge_buf *eb)
2792{
2793        if (eb != NULL)
2794                eb->buf_get = eb->buf_put;
2795        /* equivalent to a get of all data available */
2796}
2797
2798
2799/*
2800 * edge_buf_data_avail
2801 *
2802 * Return the number of bytes of data available in the circular
2803 * buffer.
2804 */
2805
2806static unsigned int edge_buf_data_avail(struct edge_buf *eb)
2807{
2808        if (eb == NULL)
2809                return 0;
2810        return ((eb->buf_size + eb->buf_put - eb->buf_get) % eb->buf_size);
2811}
2812
2813
2814/*
2815 * edge_buf_space_avail
2816 *
2817 * Return the number of bytes of space available in the circular
2818 * buffer.
2819 */
2820
2821static unsigned int edge_buf_space_avail(struct edge_buf *eb)
2822{
2823        if (eb == NULL)
2824                return 0;
2825        return ((eb->buf_size + eb->buf_get - eb->buf_put - 1) % eb->buf_size);
2826}
2827
2828
2829/*
2830 * edge_buf_put
2831 *
2832 * Copy data data from a user buffer and put it into the circular buffer.
2833 * Restrict to the amount of space available.
2834 *
2835 * Return the number of bytes copied.
2836 */
2837
2838static unsigned int edge_buf_put(struct edge_buf *eb, const char *buf,
2839        unsigned int count)
2840{
2841        unsigned int len;
2842
2843
2844        if (eb == NULL)
2845                return 0;
2846
2847        len  = edge_buf_space_avail(eb);
2848        if (count > len)
2849                count = len;
2850
2851        if (count == 0)
2852                return 0;
2853
2854        len = eb->buf_buf + eb->buf_size - eb->buf_put;
2855        if (count > len) {
2856                memcpy(eb->buf_put, buf, len);
2857                memcpy(eb->buf_buf, buf+len, count - len);
2858                eb->buf_put = eb->buf_buf + count - len;
2859        } else {
2860                memcpy(eb->buf_put, buf, count);
2861                if (count < len)
2862                        eb->buf_put += count;
2863                else /* count == len */
2864                        eb->buf_put = eb->buf_buf;
2865        }
2866
2867        return count;
2868}
2869
2870
2871/*
2872 * edge_buf_get
2873 *
2874 * Get data from the circular buffer and copy to the given buffer.
2875 * Restrict to the amount of data available.
2876 *
2877 * Return the number of bytes copied.
2878 */
2879
2880static unsigned int edge_buf_get(struct edge_buf *eb, char *buf,
2881        unsigned int count)
2882{
2883        unsigned int len;
2884
2885
2886        if (eb == NULL)
2887                return 0;
2888
2889        len = edge_buf_data_avail(eb);
2890        if (count > len)
2891                count = len;
2892
2893        if (count == 0)
2894                return 0;
2895
2896        len = eb->buf_buf + eb->buf_size - eb->buf_get;
2897        if (count > len) {
2898                memcpy(buf, eb->buf_get, len);
2899                memcpy(buf+len, eb->buf_buf, count - len);
2900                eb->buf_get = eb->buf_buf + count - len;
2901        } else {
2902                memcpy(buf, eb->buf_get, count);
2903                if (count < len)
2904                        eb->buf_get += count;
2905                else /* count == len */
2906                        eb->buf_get = eb->buf_buf;
2907        }
2908
2909        return count;
2910}
2911
2912
2913static struct usb_serial_driver edgeport_1port_device = {
2914        .driver = {
2915                .owner          = THIS_MODULE,
2916                .name           = "edgeport_ti_1",
2917        },
2918        .description            = "Edgeport TI 1 port adapter",
2919        .usb_driver             = &io_driver,
2920        .id_table               = edgeport_1port_id_table,
2921        .num_ports              = 1,
2922        .open                   = edge_open,
2923        .close                  = edge_close,
2924        .throttle               = edge_throttle,
2925        .unthrottle             = edge_unthrottle,
2926        .attach                 = edge_startup,
2927        .disconnect             = edge_disconnect,
2928        .release                = edge_release,
2929        .port_probe             = edge_create_sysfs_attrs,
2930        .ioctl                  = edge_ioctl,
2931        .set_termios            = edge_set_termios,
2932        .tiocmget               = edge_tiocmget,
2933        .tiocmset               = edge_tiocmset,
2934        .write                  = edge_write,
2935        .write_room             = edge_write_room,
2936        .chars_in_buffer        = edge_chars_in_buffer,
2937        .break_ctl              = edge_break,
2938        .read_int_callback      = edge_interrupt_callback,
2939        .read_bulk_callback     = edge_bulk_in_callback,
2940        .write_bulk_callback    = edge_bulk_out_callback,
2941};
2942
2943static struct usb_serial_driver edgeport_2port_device = {
2944        .driver = {
2945                .owner          = THIS_MODULE,
2946                .name           = "edgeport_ti_2",
2947        },
2948        .description            = "Edgeport TI 2 port adapter",
2949        .usb_driver             = &io_driver,
2950        .id_table               = edgeport_2port_id_table,
2951        .num_ports              = 2,
2952        .open                   = edge_open,
2953        .close                  = edge_close,
2954        .throttle               = edge_throttle,
2955        .unthrottle             = edge_unthrottle,
2956        .attach                 = edge_startup,
2957        .disconnect             = edge_disconnect,
2958        .release                = edge_release,
2959        .port_probe             = edge_create_sysfs_attrs,
2960        .ioctl                  = edge_ioctl,
2961        .set_termios            = edge_set_termios,
2962        .tiocmget               = edge_tiocmget,
2963        .tiocmset               = edge_tiocmset,
2964        .write                  = edge_write,
2965        .write_room             = edge_write_room,
2966        .chars_in_buffer        = edge_chars_in_buffer,
2967        .break_ctl              = edge_break,
2968        .read_int_callback      = edge_interrupt_callback,
2969        .read_bulk_callback     = edge_bulk_in_callback,
2970        .write_bulk_callback    = edge_bulk_out_callback,
2971};
2972
2973
2974static int __init edgeport_init(void)
2975{
2976        int retval;
2977        retval = usb_serial_register(&edgeport_1port_device);
2978        if (retval)
2979                goto failed_1port_device_register;
2980        retval = usb_serial_register(&edgeport_2port_device);
2981        if (retval)
2982                goto failed_2port_device_register;
2983        retval = usb_register(&io_driver);
2984        if (retval)
2985                goto failed_usb_register;
2986        printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
2987               DRIVER_DESC "\n");
2988        return 0;
2989failed_usb_register:
2990        usb_serial_deregister(&edgeport_2port_device);
2991failed_2port_device_register:
2992        usb_serial_deregister(&edgeport_1port_device);
2993failed_1port_device_register:
2994        return retval;
2995}
2996
2997static void __exit edgeport_exit(void)
2998{
2999        usb_deregister(&io_driver);
3000        usb_serial_deregister(&edgeport_1port_device);
3001        usb_serial_deregister(&edgeport_2port_device);
3002}
3003
3004module_init(edgeport_init);
3005module_exit(edgeport_exit);
3006
3007/* Module information */
3008MODULE_AUTHOR(DRIVER_AUTHOR);
3009MODULE_DESCRIPTION(DRIVER_DESC);
3010MODULE_LICENSE("GPL");
3011MODULE_FIRMWARE("edgeport/down3.bin");
3012
3013module_param(debug, bool, S_IRUGO | S_IWUSR);
3014MODULE_PARM_DESC(debug, "Debug enabled or not");
3015
3016module_param(closing_wait, int, S_IRUGO | S_IWUSR);
3017MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
3018
3019module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
3020MODULE_PARM_DESC(ignore_cpu_rev,
3021                        "Ignore the cpu revision when connecting to a device");
3022
3023module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
3024MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");
3025