drivers/usb/serial/io_ti.c

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