linux/drivers/usb/serial/ti_usb_3410_5052.c
<<
>>
Prefs
   1/*
   2 * TI 3410/5052 USB Serial Driver
   3 *
   4 * Copyright (C) 2004 Texas Instruments
   5 *
   6 * This driver is based on the Linux io_ti driver, which is
   7 *   Copyright (C) 2000-2002 Inside Out Networks
   8 *   Copyright (C) 2001-2002 Greg Kroah-Hartman
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License as published by
  12 * the Free Software Foundation; either version 2 of the License, or
  13 * (at your option) any later version.
  14 *
  15 * For questions or problems with this driver, contact Texas Instruments
  16 * technical support, or Al Borchers <alborchers@steinerpoint.com>, or
  17 * Peter Berger <pberger@brimson.com>.
  18 */
  19
  20#include <linux/kernel.h>
  21#include <linux/errno.h>
  22#include <linux/firmware.h>
  23#include <linux/slab.h>
  24#include <linux/tty.h>
  25#include <linux/tty_driver.h>
  26#include <linux/tty_flip.h>
  27#include <linux/module.h>
  28#include <linux/spinlock.h>
  29#include <linux/ioctl.h>
  30#include <linux/serial.h>
  31#include <linux/kfifo.h>
  32#include <linux/mutex.h>
  33#include <linux/uaccess.h>
  34#include <linux/usb.h>
  35#include <linux/usb/serial.h>
  36
  37/* Configuration ids */
  38#define TI_BOOT_CONFIG                  1
  39#define TI_ACTIVE_CONFIG                2
  40
  41/* Vendor and product ids */
  42#define TI_VENDOR_ID                    0x0451
  43#define IBM_VENDOR_ID                   0x04b3
  44#define TI_3410_PRODUCT_ID              0x3410
  45#define IBM_4543_PRODUCT_ID             0x4543
  46#define IBM_454B_PRODUCT_ID             0x454b
  47#define IBM_454C_PRODUCT_ID             0x454c
  48#define TI_3410_EZ430_ID                0xF430  /* TI ez430 development tool */
  49#define TI_5052_BOOT_PRODUCT_ID         0x5052  /* no EEPROM, no firmware */
  50#define TI_5152_BOOT_PRODUCT_ID         0x5152  /* no EEPROM, no firmware */
  51#define TI_5052_EEPROM_PRODUCT_ID       0x505A  /* EEPROM, no firmware */
  52#define TI_5052_FIRMWARE_PRODUCT_ID     0x505F  /* firmware is running */
  53#define FRI2_PRODUCT_ID                 0x5053  /* Fish River Island II */
  54
  55/* Multi-Tech vendor and product ids */
  56#define MTS_VENDOR_ID                   0x06E0
  57#define MTS_GSM_NO_FW_PRODUCT_ID        0xF108
  58#define MTS_CDMA_NO_FW_PRODUCT_ID       0xF109
  59#define MTS_CDMA_PRODUCT_ID             0xF110
  60#define MTS_GSM_PRODUCT_ID              0xF111
  61#define MTS_EDGE_PRODUCT_ID             0xF112
  62#define MTS_MT9234MU_PRODUCT_ID         0xF114
  63#define MTS_MT9234ZBA_PRODUCT_ID        0xF115
  64#define MTS_MT9234ZBAOLD_PRODUCT_ID     0x0319
  65
  66/* Abbott Diabetics vendor and product ids */
  67#define ABBOTT_VENDOR_ID                0x1a61
  68#define ABBOTT_STEREO_PLUG_ID           0x3410
  69#define ABBOTT_PRODUCT_ID               ABBOTT_STEREO_PLUG_ID
  70#define ABBOTT_STRIP_PORT_ID            0x3420
  71
  72/* Honeywell vendor and product IDs */
  73#define HONEYWELL_VENDOR_ID             0x10ac
  74#define HONEYWELL_HGI80_PRODUCT_ID      0x0102  /* Honeywell HGI80 */
  75
  76/* Moxa UPORT 11x0 vendor and product IDs */
  77#define MXU1_VENDOR_ID                          0x110a
  78#define MXU1_1110_PRODUCT_ID                    0x1110
  79#define MXU1_1130_PRODUCT_ID                    0x1130
  80#define MXU1_1150_PRODUCT_ID                    0x1150
  81#define MXU1_1151_PRODUCT_ID                    0x1151
  82#define MXU1_1131_PRODUCT_ID                    0x1131
  83
  84/* Commands */
  85#define TI_GET_VERSION                  0x01
  86#define TI_GET_PORT_STATUS              0x02
  87#define TI_GET_PORT_DEV_INFO            0x03
  88#define TI_GET_CONFIG                   0x04
  89#define TI_SET_CONFIG                   0x05
  90#define TI_OPEN_PORT                    0x06
  91#define TI_CLOSE_PORT                   0x07
  92#define TI_START_PORT                   0x08
  93#define TI_STOP_PORT                    0x09
  94#define TI_TEST_PORT                    0x0A
  95#define TI_PURGE_PORT                   0x0B
  96#define TI_RESET_EXT_DEVICE             0x0C
  97#define TI_WRITE_DATA                   0x80
  98#define TI_READ_DATA                    0x81
  99#define TI_REQ_TYPE_CLASS               0x82
 100
 101/* Module identifiers */
 102#define TI_I2C_PORT                     0x01
 103#define TI_IEEE1284_PORT                0x02
 104#define TI_UART1_PORT                   0x03
 105#define TI_UART2_PORT                   0x04
 106#define TI_RAM_PORT                     0x05
 107
 108/* Modem status */
 109#define TI_MSR_DELTA_CTS                0x01
 110#define TI_MSR_DELTA_DSR                0x02
 111#define TI_MSR_DELTA_RI                 0x04
 112#define TI_MSR_DELTA_CD                 0x08
 113#define TI_MSR_CTS                      0x10
 114#define TI_MSR_DSR                      0x20
 115#define TI_MSR_RI                       0x40
 116#define TI_MSR_CD                       0x80
 117#define TI_MSR_DELTA_MASK               0x0F
 118#define TI_MSR_MASK                     0xF0
 119
 120/* Line status */
 121#define TI_LSR_OVERRUN_ERROR            0x01
 122#define TI_LSR_PARITY_ERROR             0x02
 123#define TI_LSR_FRAMING_ERROR            0x04
 124#define TI_LSR_BREAK                    0x08
 125#define TI_LSR_ERROR                    0x0F
 126#define TI_LSR_RX_FULL                  0x10
 127#define TI_LSR_TX_EMPTY                 0x20
 128
 129/* Line control */
 130#define TI_LCR_BREAK                    0x40
 131
 132/* Modem control */
 133#define TI_MCR_LOOP                     0x04
 134#define TI_MCR_DTR                      0x10
 135#define TI_MCR_RTS                      0x20
 136
 137/* Mask settings */
 138#define TI_UART_ENABLE_RTS_IN           0x0001
 139#define TI_UART_DISABLE_RTS             0x0002
 140#define TI_UART_ENABLE_PARITY_CHECKING  0x0008
 141#define TI_UART_ENABLE_DSR_OUT          0x0010
 142#define TI_UART_ENABLE_CTS_OUT          0x0020
 143#define TI_UART_ENABLE_X_OUT            0x0040
 144#define TI_UART_ENABLE_XA_OUT           0x0080
 145#define TI_UART_ENABLE_X_IN             0x0100
 146#define TI_UART_ENABLE_DTR_IN           0x0800
 147#define TI_UART_DISABLE_DTR             0x1000
 148#define TI_UART_ENABLE_MS_INTS          0x2000
 149#define TI_UART_ENABLE_AUTO_START_DMA   0x4000
 150
 151/* Parity */
 152#define TI_UART_NO_PARITY               0x00
 153#define TI_UART_ODD_PARITY              0x01
 154#define TI_UART_EVEN_PARITY             0x02
 155#define TI_UART_MARK_PARITY             0x03
 156#define TI_UART_SPACE_PARITY            0x04
 157
 158/* Stop bits */
 159#define TI_UART_1_STOP_BITS             0x00
 160#define TI_UART_1_5_STOP_BITS           0x01
 161#define TI_UART_2_STOP_BITS             0x02
 162
 163/* Bits per character */
 164#define TI_UART_5_DATA_BITS             0x00
 165#define TI_UART_6_DATA_BITS             0x01
 166#define TI_UART_7_DATA_BITS             0x02
 167#define TI_UART_8_DATA_BITS             0x03
 168
 169/* 232/485 modes */
 170#define TI_UART_232                     0x00
 171#define TI_UART_485_RECEIVER_DISABLED   0x01
 172#define TI_UART_485_RECEIVER_ENABLED    0x02
 173
 174/* Pipe transfer mode and timeout */
 175#define TI_PIPE_MODE_CONTINUOUS         0x01
 176#define TI_PIPE_MODE_MASK               0x03
 177#define TI_PIPE_TIMEOUT_MASK            0x7C
 178#define TI_PIPE_TIMEOUT_ENABLE          0x80
 179
 180/* Config struct */
 181struct ti_uart_config {
 182        __be16  wBaudRate;
 183        __be16  wFlags;
 184        u8      bDataBits;
 185        u8      bParity;
 186        u8      bStopBits;
 187        char    cXon;
 188        char    cXoff;
 189        u8      bUartMode;
 190} __packed;
 191
 192/* Get port status */
 193struct ti_port_status {
 194        u8 bCmdCode;
 195        u8 bModuleId;
 196        u8 bErrorCode;
 197        u8 bMSR;
 198        u8 bLSR;
 199} __packed;
 200
 201/* Purge modes */
 202#define TI_PURGE_OUTPUT                 0x00
 203#define TI_PURGE_INPUT                  0x80
 204
 205/* Read/Write data */
 206#define TI_RW_DATA_ADDR_SFR             0x10
 207#define TI_RW_DATA_ADDR_IDATA           0x20
 208#define TI_RW_DATA_ADDR_XDATA           0x30
 209#define TI_RW_DATA_ADDR_CODE            0x40
 210#define TI_RW_DATA_ADDR_GPIO            0x50
 211#define TI_RW_DATA_ADDR_I2C             0x60
 212#define TI_RW_DATA_ADDR_FLASH           0x70
 213#define TI_RW_DATA_ADDR_DSP             0x80
 214
 215#define TI_RW_DATA_UNSPECIFIED          0x00
 216#define TI_RW_DATA_BYTE                 0x01
 217#define TI_RW_DATA_WORD                 0x02
 218#define TI_RW_DATA_DOUBLE_WORD          0x04
 219
 220struct ti_write_data_bytes {
 221        u8      bAddrType;
 222        u8      bDataType;
 223        u8      bDataCounter;
 224        __be16  wBaseAddrHi;
 225        __be16  wBaseAddrLo;
 226        u8      bData[0];
 227} __packed;
 228
 229struct ti_read_data_request {
 230        __u8    bAddrType;
 231        __u8    bDataType;
 232        __u8    bDataCounter;
 233        __be16  wBaseAddrHi;
 234        __be16  wBaseAddrLo;
 235} __packed;
 236
 237struct ti_read_data_bytes {
 238        __u8    bCmdCode;
 239        __u8    bModuleId;
 240        __u8    bErrorCode;
 241        __u8    bData[0];
 242} __packed;
 243
 244/* Interrupt struct */
 245struct ti_interrupt {
 246        __u8    bICode;
 247        __u8    bIInfo;
 248} __packed;
 249
 250/* Interrupt codes */
 251#define TI_CODE_HARDWARE_ERROR          0xFF
 252#define TI_CODE_DATA_ERROR              0x03
 253#define TI_CODE_MODEM_STATUS            0x04
 254
 255/* Download firmware max packet size */
 256#define TI_DOWNLOAD_MAX_PACKET_SIZE     64
 257
 258/* Firmware image header */
 259struct ti_firmware_header {
 260        __le16  wLength;
 261        u8      bCheckSum;
 262} __packed;
 263
 264/* UART addresses */
 265#define TI_UART1_BASE_ADDR              0xFFA0  /* UART 1 base address */
 266#define TI_UART2_BASE_ADDR              0xFFB0  /* UART 2 base address */
 267#define TI_UART_OFFSET_LCR              0x0002  /* UART MCR register offset */
 268#define TI_UART_OFFSET_MCR              0x0004  /* UART MCR register offset */
 269
 270#define TI_DRIVER_AUTHOR        "Al Borchers <alborchers@steinerpoint.com>"
 271#define TI_DRIVER_DESC          "TI USB 3410/5052 Serial Driver"
 272
 273#define TI_FIRMWARE_BUF_SIZE    16284
 274
 275#define TI_TRANSFER_TIMEOUT     2
 276
 277#define TI_DEFAULT_CLOSING_WAIT 4000            /* in .01 secs */
 278
 279/* read urb states */
 280#define TI_READ_URB_RUNNING     0
 281#define TI_READ_URB_STOPPING    1
 282#define TI_READ_URB_STOPPED     2
 283
 284#define TI_EXTRA_VID_PID_COUNT  5
 285
 286struct ti_port {
 287        int                     tp_is_open;
 288        u8                      tp_msr;
 289        u8                      tp_shadow_mcr;
 290        u8                      tp_uart_mode;   /* 232 or 485 modes */
 291        unsigned int            tp_uart_base_addr;
 292        struct ti_device        *tp_tdev;
 293        struct usb_serial_port  *tp_port;
 294        spinlock_t              tp_lock;
 295        int                     tp_read_urb_state;
 296        int                     tp_write_urb_in_use;
 297};
 298
 299struct ti_device {
 300        struct mutex            td_open_close_lock;
 301        int                     td_open_port_count;
 302        struct usb_serial       *td_serial;
 303        int                     td_is_3410;
 304        bool                    td_rs485_only;
 305};
 306
 307static int ti_startup(struct usb_serial *serial);
 308static void ti_release(struct usb_serial *serial);
 309static int ti_port_probe(struct usb_serial_port *port);
 310static int ti_port_remove(struct usb_serial_port *port);
 311static int ti_open(struct tty_struct *tty, struct usb_serial_port *port);
 312static void ti_close(struct usb_serial_port *port);
 313static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
 314                const unsigned char *data, int count);
 315static int ti_write_room(struct tty_struct *tty);
 316static int ti_chars_in_buffer(struct tty_struct *tty);
 317static bool ti_tx_empty(struct usb_serial_port *port);
 318static void ti_throttle(struct tty_struct *tty);
 319static void ti_unthrottle(struct tty_struct *tty);
 320static int ti_ioctl(struct tty_struct *tty,
 321                unsigned int cmd, unsigned long arg);
 322static void ti_set_termios(struct tty_struct *tty,
 323                struct usb_serial_port *port, struct ktermios *old_termios);
 324static int ti_tiocmget(struct tty_struct *tty);
 325static int ti_tiocmset(struct tty_struct *tty,
 326                unsigned int set, unsigned int clear);
 327static void ti_break(struct tty_struct *tty, int break_state);
 328static void ti_interrupt_callback(struct urb *urb);
 329static void ti_bulk_in_callback(struct urb *urb);
 330static void ti_bulk_out_callback(struct urb *urb);
 331
 332static void ti_recv(struct usb_serial_port *port, unsigned char *data,
 333                int length);
 334static void ti_send(struct ti_port *tport);
 335static int ti_set_mcr(struct ti_port *tport, unsigned int mcr);
 336static int ti_get_lsr(struct ti_port *tport, u8 *lsr);
 337static int ti_get_serial_info(struct ti_port *tport,
 338        struct serial_struct __user *ret_arg);
 339static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
 340        struct serial_struct __user *new_arg);
 341static void ti_handle_new_msr(struct ti_port *tport, u8 msr);
 342
 343static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty);
 344static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty);
 345
 346static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
 347        __u16 moduleid, __u16 value, __u8 *data, int size);
 348static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
 349        __u16 moduleid, __u16 value, __u8 *data, int size);
 350
 351static int ti_write_byte(struct usb_serial_port *port, struct ti_device *tdev,
 352                         unsigned long addr, u8 mask, u8 byte);
 353
 354static int ti_download_firmware(struct ti_device *tdev);
 355
 356static int closing_wait = TI_DEFAULT_CLOSING_WAIT;
 357
 358static const struct usb_device_id ti_id_table_3410[] = {
 359        { USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
 360        { USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
 361        { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
 362        { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
 363        { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
 364        { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
 365        { USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
 366        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
 367        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
 368        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
 369        { USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
 370        { USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
 371        { USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
 372        { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STEREO_PLUG_ID) },
 373        { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
 374        { USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
 375        { USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
 376        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
 377        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
 378        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
 379        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
 380        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
 381        { }     /* terminator */
 382};
 383
 384static const struct usb_device_id ti_id_table_5052[] = {
 385        { USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
 386        { USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
 387        { USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
 388        { USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
 389        { }
 390};
 391
 392static const struct usb_device_id ti_id_table_combined[] = {
 393        { USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
 394        { USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
 395        { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
 396        { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
 397        { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
 398        { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
 399        { USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
 400        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
 401        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
 402        { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
 403        { USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
 404        { USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
 405        { USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
 406        { USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
 407        { USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
 408        { USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
 409        { USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
 410        { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_PRODUCT_ID) },
 411        { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
 412        { USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
 413        { USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
 414        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
 415        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
 416        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
 417        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
 418        { USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
 419        { }     /* terminator */
 420};
 421
 422static struct usb_serial_driver ti_1port_device = {
 423        .driver = {
 424                .owner          = THIS_MODULE,
 425                .name           = "ti_usb_3410_5052_1",
 426        },
 427        .description            = "TI USB 3410 1 port adapter",
 428        .id_table               = ti_id_table_3410,
 429        .num_ports              = 1,
 430        .num_bulk_out           = 1,
 431        .attach                 = ti_startup,
 432        .release                = ti_release,
 433        .port_probe             = ti_port_probe,
 434        .port_remove            = ti_port_remove,
 435        .open                   = ti_open,
 436        .close                  = ti_close,
 437        .write                  = ti_write,
 438        .write_room             = ti_write_room,
 439        .chars_in_buffer        = ti_chars_in_buffer,
 440        .tx_empty               = ti_tx_empty,
 441        .throttle               = ti_throttle,
 442        .unthrottle             = ti_unthrottle,
 443        .ioctl                  = ti_ioctl,
 444        .set_termios            = ti_set_termios,
 445        .tiocmget               = ti_tiocmget,
 446        .tiocmset               = ti_tiocmset,
 447        .tiocmiwait             = usb_serial_generic_tiocmiwait,
 448        .get_icount             = usb_serial_generic_get_icount,
 449        .break_ctl              = ti_break,
 450        .read_int_callback      = ti_interrupt_callback,
 451        .read_bulk_callback     = ti_bulk_in_callback,
 452        .write_bulk_callback    = ti_bulk_out_callback,
 453};
 454
 455static struct usb_serial_driver ti_2port_device = {
 456        .driver = {
 457                .owner          = THIS_MODULE,
 458                .name           = "ti_usb_3410_5052_2",
 459        },
 460        .description            = "TI USB 5052 2 port adapter",
 461        .id_table               = ti_id_table_5052,
 462        .num_ports              = 2,
 463        .num_bulk_out           = 1,
 464        .attach                 = ti_startup,
 465        .release                = ti_release,
 466        .port_probe             = ti_port_probe,
 467        .port_remove            = ti_port_remove,
 468        .open                   = ti_open,
 469        .close                  = ti_close,
 470        .write                  = ti_write,
 471        .write_room             = ti_write_room,
 472        .chars_in_buffer        = ti_chars_in_buffer,
 473        .tx_empty               = ti_tx_empty,
 474        .throttle               = ti_throttle,
 475        .unthrottle             = ti_unthrottle,
 476        .ioctl                  = ti_ioctl,
 477        .set_termios            = ti_set_termios,
 478        .tiocmget               = ti_tiocmget,
 479        .tiocmset               = ti_tiocmset,
 480        .tiocmiwait             = usb_serial_generic_tiocmiwait,
 481        .get_icount             = usb_serial_generic_get_icount,
 482        .break_ctl              = ti_break,
 483        .read_int_callback      = ti_interrupt_callback,
 484        .read_bulk_callback     = ti_bulk_in_callback,
 485        .write_bulk_callback    = ti_bulk_out_callback,
 486};
 487
 488static struct usb_serial_driver * const serial_drivers[] = {
 489        &ti_1port_device, &ti_2port_device, NULL
 490};
 491
 492MODULE_AUTHOR(TI_DRIVER_AUTHOR);
 493MODULE_DESCRIPTION(TI_DRIVER_DESC);
 494MODULE_LICENSE("GPL");
 495
 496MODULE_FIRMWARE("ti_3410.fw");
 497MODULE_FIRMWARE("ti_5052.fw");
 498MODULE_FIRMWARE("mts_cdma.fw");
 499MODULE_FIRMWARE("mts_gsm.fw");
 500MODULE_FIRMWARE("mts_edge.fw");
 501MODULE_FIRMWARE("mts_mt9234mu.fw");
 502MODULE_FIRMWARE("mts_mt9234zba.fw");
 503MODULE_FIRMWARE("moxa/moxa-1110.fw");
 504MODULE_FIRMWARE("moxa/moxa-1130.fw");
 505MODULE_FIRMWARE("moxa/moxa-1131.fw");
 506MODULE_FIRMWARE("moxa/moxa-1150.fw");
 507MODULE_FIRMWARE("moxa/moxa-1151.fw");
 508
 509module_param(closing_wait, int, S_IRUGO | S_IWUSR);
 510MODULE_PARM_DESC(closing_wait,
 511    "Maximum wait for data to drain in close, in .01 secs, default is 4000");
 512
 513MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
 514
 515module_usb_serial_driver(serial_drivers, ti_id_table_combined);
 516
 517static int ti_startup(struct usb_serial *serial)
 518{
 519        struct ti_device *tdev;
 520        struct usb_device *dev = serial->dev;
 521        struct usb_host_interface *cur_altsetting;
 522        int num_endpoints;
 523        u16 vid, pid;
 524        int status;
 525
 526        dev_dbg(&dev->dev,
 527                "%s - product 0x%4X, num configurations %d, configuration value %d\n",
 528                __func__, le16_to_cpu(dev->descriptor.idProduct),
 529                dev->descriptor.bNumConfigurations,
 530                dev->actconfig->desc.bConfigurationValue);
 531
 532        tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
 533        if (!tdev)
 534                return -ENOMEM;
 535
 536        mutex_init(&tdev->td_open_close_lock);
 537        tdev->td_serial = serial;
 538        usb_set_serial_data(serial, tdev);
 539
 540        /* determine device type */
 541        if (serial->type == &ti_1port_device)
 542                tdev->td_is_3410 = 1;
 543        dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
 544                tdev->td_is_3410 ? "3410" : "5052");
 545
 546        vid = le16_to_cpu(dev->descriptor.idVendor);
 547        pid = le16_to_cpu(dev->descriptor.idProduct);
 548        if (vid == MXU1_VENDOR_ID) {
 549                switch (pid) {
 550                case MXU1_1130_PRODUCT_ID:
 551                case MXU1_1131_PRODUCT_ID:
 552                        tdev->td_rs485_only = true;
 553                        break;
 554                }
 555        }
 556
 557        cur_altsetting = serial->interface->cur_altsetting;
 558        num_endpoints = cur_altsetting->desc.bNumEndpoints;
 559
 560        /* if we have only 1 configuration and 1 endpoint, download firmware */
 561        if (dev->descriptor.bNumConfigurations == 1 && num_endpoints == 1) {
 562                status = ti_download_firmware(tdev);
 563
 564                if (status != 0)
 565                        goto free_tdev;
 566
 567                /* 3410 must be reset, 5052 resets itself */
 568                if (tdev->td_is_3410) {
 569                        msleep_interruptible(100);
 570                        usb_reset_device(dev);
 571                }
 572
 573                status = -ENODEV;
 574                goto free_tdev;
 575        }
 576
 577        /* the second configuration must be set */
 578        if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
 579                status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
 580                status = status ? status : -ENODEV;
 581                goto free_tdev;
 582        }
 583
 584        if (serial->num_bulk_in < serial->num_ports ||
 585                        serial->num_bulk_out < serial->num_ports) {
 586                dev_err(&serial->interface->dev, "missing endpoints\n");
 587                status = -ENODEV;
 588                goto free_tdev;
 589        }
 590
 591        return 0;
 592
 593free_tdev:
 594        kfree(tdev);
 595        usb_set_serial_data(serial, NULL);
 596        return status;
 597}
 598
 599
 600static void ti_release(struct usb_serial *serial)
 601{
 602        struct ti_device *tdev = usb_get_serial_data(serial);
 603
 604        kfree(tdev);
 605}
 606
 607static int ti_port_probe(struct usb_serial_port *port)
 608{
 609        struct ti_port *tport;
 610
 611        tport = kzalloc(sizeof(*tport), GFP_KERNEL);
 612        if (!tport)
 613                return -ENOMEM;
 614
 615        spin_lock_init(&tport->tp_lock);
 616        if (port == port->serial->port[0])
 617                tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
 618        else
 619                tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
 620        port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
 621        tport->tp_port = port;
 622        tport->tp_tdev = usb_get_serial_data(port->serial);
 623
 624        if (tport->tp_tdev->td_rs485_only)
 625                tport->tp_uart_mode = TI_UART_485_RECEIVER_DISABLED;
 626        else
 627                tport->tp_uart_mode = TI_UART_232;
 628
 629        usb_set_serial_port_data(port, tport);
 630
 631        port->port.drain_delay = 3;
 632
 633        return 0;
 634}
 635
 636static int ti_port_remove(struct usb_serial_port *port)
 637{
 638        struct ti_port *tport;
 639
 640        tport = usb_get_serial_port_data(port);
 641        kfree(tport);
 642
 643        return 0;
 644}
 645
 646static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
 647{
 648        struct ti_port *tport = usb_get_serial_port_data(port);
 649        struct ti_device *tdev;
 650        struct usb_device *dev;
 651        struct urb *urb;
 652        int port_number;
 653        int status;
 654        u16 open_settings;
 655
 656        open_settings = (TI_PIPE_MODE_CONTINUOUS |
 657                         TI_PIPE_TIMEOUT_ENABLE |
 658                         (TI_TRANSFER_TIMEOUT << 2));
 659
 660        dev = port->serial->dev;
 661        tdev = tport->tp_tdev;
 662
 663        /* only one open on any port on a device at a time */
 664        if (mutex_lock_interruptible(&tdev->td_open_close_lock))
 665                return -ERESTARTSYS;
 666
 667        port_number = port->port_number;
 668
 669        tport->tp_msr = 0;
 670        tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
 671
 672        /* start interrupt urb the first time a port is opened on this device */
 673        if (tdev->td_open_port_count == 0) {
 674                dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
 675                urb = tdev->td_serial->port[0]->interrupt_in_urb;
 676                if (!urb) {
 677                        dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
 678                        status = -EINVAL;
 679                        goto release_lock;
 680                }
 681                urb->context = tdev;
 682                status = usb_submit_urb(urb, GFP_KERNEL);
 683                if (status) {
 684                        dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
 685                        goto release_lock;
 686                }
 687        }
 688
 689        if (tty)
 690                ti_set_termios(tty, port, &tty->termios);
 691
 692        status = ti_command_out_sync(tdev, TI_OPEN_PORT,
 693                (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
 694        if (status) {
 695                dev_err(&port->dev, "%s - cannot send open command, %d\n",
 696                        __func__, status);
 697                goto unlink_int_urb;
 698        }
 699
 700        status = ti_command_out_sync(tdev, TI_START_PORT,
 701                (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 702        if (status) {
 703                dev_err(&port->dev, "%s - cannot send start command, %d\n",
 704                                                        __func__, status);
 705                goto unlink_int_urb;
 706        }
 707
 708        status = ti_command_out_sync(tdev, TI_PURGE_PORT,
 709                (__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
 710        if (status) {
 711                dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
 712                                                        __func__, status);
 713                goto unlink_int_urb;
 714        }
 715        status = ti_command_out_sync(tdev, TI_PURGE_PORT,
 716                (__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
 717        if (status) {
 718                dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
 719                                                        __func__, status);
 720                goto unlink_int_urb;
 721        }
 722
 723        /* reset the data toggle on the bulk endpoints to work around bug in
 724         * host controllers where things get out of sync some times */
 725        usb_clear_halt(dev, port->write_urb->pipe);
 726        usb_clear_halt(dev, port->read_urb->pipe);
 727
 728        if (tty)
 729                ti_set_termios(tty, port, &tty->termios);
 730
 731        status = ti_command_out_sync(tdev, TI_OPEN_PORT,
 732                (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
 733        if (status) {
 734                dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
 735                                                        __func__, status);
 736                goto unlink_int_urb;
 737        }
 738
 739        status = ti_command_out_sync(tdev, TI_START_PORT,
 740                (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 741        if (status) {
 742                dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
 743                                                        __func__, status);
 744                goto unlink_int_urb;
 745        }
 746
 747        /* start read urb */
 748        urb = port->read_urb;
 749        if (!urb) {
 750                dev_err(&port->dev, "%s - no read urb\n", __func__);
 751                status = -EINVAL;
 752                goto unlink_int_urb;
 753        }
 754        tport->tp_read_urb_state = TI_READ_URB_RUNNING;
 755        urb->context = tport;
 756        status = usb_submit_urb(urb, GFP_KERNEL);
 757        if (status) {
 758                dev_err(&port->dev, "%s - submit read urb failed, %d\n",
 759                                                        __func__, status);
 760                goto unlink_int_urb;
 761        }
 762
 763        tport->tp_is_open = 1;
 764        ++tdev->td_open_port_count;
 765
 766        goto release_lock;
 767
 768unlink_int_urb:
 769        if (tdev->td_open_port_count == 0)
 770                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
 771release_lock:
 772        mutex_unlock(&tdev->td_open_close_lock);
 773        return status;
 774}
 775
 776
 777static void ti_close(struct usb_serial_port *port)
 778{
 779        struct ti_device *tdev;
 780        struct ti_port *tport;
 781        int port_number;
 782        int status;
 783        int do_unlock;
 784        unsigned long flags;
 785
 786        tdev = usb_get_serial_data(port->serial);
 787        tport = usb_get_serial_port_data(port);
 788
 789        tport->tp_is_open = 0;
 790
 791        usb_kill_urb(port->read_urb);
 792        usb_kill_urb(port->write_urb);
 793        tport->tp_write_urb_in_use = 0;
 794        spin_lock_irqsave(&tport->tp_lock, flags);
 795        kfifo_reset_out(&port->write_fifo);
 796        spin_unlock_irqrestore(&tport->tp_lock, flags);
 797
 798        port_number = port->port_number;
 799
 800        status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
 801                     (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 802        if (status)
 803                dev_err(&port->dev,
 804                        "%s - cannot send close port command, %d\n"
 805                                                        , __func__, status);
 806
 807        /* if mutex_lock is interrupted, continue anyway */
 808        do_unlock = !mutex_lock_interruptible(&tdev->td_open_close_lock);
 809        --tport->tp_tdev->td_open_port_count;
 810        if (tport->tp_tdev->td_open_port_count <= 0) {
 811                /* last port is closed, shut down interrupt urb */
 812                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
 813                tport->tp_tdev->td_open_port_count = 0;
 814        }
 815        if (do_unlock)
 816                mutex_unlock(&tdev->td_open_close_lock);
 817}
 818
 819
 820static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
 821                        const unsigned char *data, int count)
 822{
 823        struct ti_port *tport = usb_get_serial_port_data(port);
 824
 825        if (count == 0) {
 826                return 0;
 827        }
 828
 829        if (!tport->tp_is_open)
 830                return -ENODEV;
 831
 832        count = kfifo_in_locked(&port->write_fifo, data, count,
 833                                                        &tport->tp_lock);
 834        ti_send(tport);
 835
 836        return count;
 837}
 838
 839
 840static int ti_write_room(struct tty_struct *tty)
 841{
 842        struct usb_serial_port *port = tty->driver_data;
 843        struct ti_port *tport = usb_get_serial_port_data(port);
 844        int room = 0;
 845        unsigned long flags;
 846
 847        spin_lock_irqsave(&tport->tp_lock, flags);
 848        room = kfifo_avail(&port->write_fifo);
 849        spin_unlock_irqrestore(&tport->tp_lock, flags);
 850
 851        dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
 852        return room;
 853}
 854
 855
 856static int ti_chars_in_buffer(struct tty_struct *tty)
 857{
 858        struct usb_serial_port *port = tty->driver_data;
 859        struct ti_port *tport = usb_get_serial_port_data(port);
 860        int chars = 0;
 861        unsigned long flags;
 862
 863        spin_lock_irqsave(&tport->tp_lock, flags);
 864        chars = kfifo_len(&port->write_fifo);
 865        spin_unlock_irqrestore(&tport->tp_lock, flags);
 866
 867        dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
 868        return chars;
 869}
 870
 871static bool ti_tx_empty(struct usb_serial_port *port)
 872{
 873        struct ti_port *tport = usb_get_serial_port_data(port);
 874        int ret;
 875        u8 lsr;
 876
 877        ret = ti_get_lsr(tport, &lsr);
 878        if (!ret && !(lsr & TI_LSR_TX_EMPTY))
 879                return false;
 880
 881        return true;
 882}
 883
 884static void ti_throttle(struct tty_struct *tty)
 885{
 886        struct usb_serial_port *port = tty->driver_data;
 887        struct ti_port *tport = usb_get_serial_port_data(port);
 888
 889        if (I_IXOFF(tty) || C_CRTSCTS(tty))
 890                ti_stop_read(tport, tty);
 891
 892}
 893
 894
 895static void ti_unthrottle(struct tty_struct *tty)
 896{
 897        struct usb_serial_port *port = tty->driver_data;
 898        struct ti_port *tport = usb_get_serial_port_data(port);
 899        int status;
 900
 901        if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
 902                status = ti_restart_read(tport, tty);
 903                if (status)
 904                        dev_err(&port->dev, "%s - cannot restart read, %d\n",
 905                                                        __func__, status);
 906        }
 907}
 908
 909static int ti_ioctl(struct tty_struct *tty,
 910        unsigned int cmd, unsigned long arg)
 911{
 912        struct usb_serial_port *port = tty->driver_data;
 913        struct ti_port *tport = usb_get_serial_port_data(port);
 914
 915        switch (cmd) {
 916        case TIOCGSERIAL:
 917                return ti_get_serial_info(tport,
 918                                (struct serial_struct __user *)arg);
 919        case TIOCSSERIAL:
 920                return ti_set_serial_info(tty, tport,
 921                                (struct serial_struct __user *)arg);
 922        }
 923        return -ENOIOCTLCMD;
 924}
 925
 926
 927static void ti_set_termios(struct tty_struct *tty,
 928                struct usb_serial_port *port, struct ktermios *old_termios)
 929{
 930        struct ti_port *tport = usb_get_serial_port_data(port);
 931        struct ti_uart_config *config;
 932        int baud;
 933        int status;
 934        int port_number = port->port_number;
 935        unsigned int mcr;
 936        u16 wbaudrate;
 937        u16 wflags = 0;
 938
 939        config = kmalloc(sizeof(*config), GFP_KERNEL);
 940        if (!config)
 941                return;
 942
 943        /* these flags must be set */
 944        wflags |= TI_UART_ENABLE_MS_INTS;
 945        wflags |= TI_UART_ENABLE_AUTO_START_DMA;
 946        config->bUartMode = tport->tp_uart_mode;
 947
 948        switch (C_CSIZE(tty)) {
 949        case CS5:
 950                    config->bDataBits = TI_UART_5_DATA_BITS;
 951                    break;
 952        case CS6:
 953                    config->bDataBits = TI_UART_6_DATA_BITS;
 954                    break;
 955        case CS7:
 956                    config->bDataBits = TI_UART_7_DATA_BITS;
 957                    break;
 958        default:
 959        case CS8:
 960                    config->bDataBits = TI_UART_8_DATA_BITS;
 961                    break;
 962        }
 963
 964        /* CMSPAR isn't supported by this driver */
 965        tty->termios.c_cflag &= ~CMSPAR;
 966
 967        if (C_PARENB(tty)) {
 968                if (C_PARODD(tty)) {
 969                        wflags |= TI_UART_ENABLE_PARITY_CHECKING;
 970                        config->bParity = TI_UART_ODD_PARITY;
 971                } else {
 972                        wflags |= TI_UART_ENABLE_PARITY_CHECKING;
 973                        config->bParity = TI_UART_EVEN_PARITY;
 974                }
 975        } else {
 976                wflags &= ~TI_UART_ENABLE_PARITY_CHECKING;
 977                config->bParity = TI_UART_NO_PARITY;
 978        }
 979
 980        if (C_CSTOPB(tty))
 981                config->bStopBits = TI_UART_2_STOP_BITS;
 982        else
 983                config->bStopBits = TI_UART_1_STOP_BITS;
 984
 985        if (C_CRTSCTS(tty)) {
 986                /* RTS flow control must be off to drop RTS for baud rate B0 */
 987                if ((C_BAUD(tty)) != B0)
 988                        wflags |= TI_UART_ENABLE_RTS_IN;
 989                wflags |= TI_UART_ENABLE_CTS_OUT;
 990        } else {
 991                ti_restart_read(tport, tty);
 992        }
 993
 994        if (I_IXOFF(tty) || I_IXON(tty)) {
 995                config->cXon  = START_CHAR(tty);
 996                config->cXoff = STOP_CHAR(tty);
 997
 998                if (I_IXOFF(tty))
 999                        wflags |= TI_UART_ENABLE_X_IN;
1000                else
1001                        ti_restart_read(tport, tty);
1002
1003                if (I_IXON(tty))
1004                        wflags |= TI_UART_ENABLE_X_OUT;
1005        }
1006
1007        baud = tty_get_baud_rate(tty);
1008        if (!baud)
1009                baud = 9600;
1010        if (tport->tp_tdev->td_is_3410)
1011                wbaudrate = (923077 + baud/2) / baud;
1012        else
1013                wbaudrate = (461538 + baud/2) / baud;
1014
1015        /* FIXME: Should calculate resulting baud here and report it back */
1016        if ((C_BAUD(tty)) != B0)
1017                tty_encode_baud_rate(tty, baud, baud);
1018
1019        dev_dbg(&port->dev,
1020                "%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
1021                __func__, baud, wbaudrate, wflags,
1022                config->bDataBits, config->bParity, config->bStopBits,
1023                config->cXon, config->cXoff, config->bUartMode);
1024
1025        config->wBaudRate = cpu_to_be16(wbaudrate);
1026        config->wFlags = cpu_to_be16(wflags);
1027
1028        status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
1029                (__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
1030                sizeof(*config));
1031        if (status)
1032                dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
1033                                        __func__, port_number, status);
1034
1035        /* SET_CONFIG asserts RTS and DTR, reset them correctly */
1036        mcr = tport->tp_shadow_mcr;
1037        /* if baud rate is B0, clear RTS and DTR */
1038        if (C_BAUD(tty) == B0)
1039                mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
1040        status = ti_set_mcr(tport, mcr);
1041        if (status)
1042                dev_err(&port->dev,
1043                        "%s - cannot set modem control on port %d, %d\n",
1044                                                __func__, port_number, status);
1045
1046        kfree(config);
1047}
1048
1049
1050static int ti_tiocmget(struct tty_struct *tty)
1051{
1052        struct usb_serial_port *port = tty->driver_data;
1053        struct ti_port *tport = usb_get_serial_port_data(port);
1054        unsigned int result;
1055        unsigned int msr;
1056        unsigned int mcr;
1057        unsigned long flags;
1058
1059        spin_lock_irqsave(&tport->tp_lock, flags);
1060        msr = tport->tp_msr;
1061        mcr = tport->tp_shadow_mcr;
1062        spin_unlock_irqrestore(&tport->tp_lock, flags);
1063
1064        result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
1065                | ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
1066                | ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
1067                | ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
1068                | ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
1069                | ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
1070                | ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
1071
1072        dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
1073
1074        return result;
1075}
1076
1077
1078static int ti_tiocmset(struct tty_struct *tty,
1079                                unsigned int set, unsigned int clear)
1080{
1081        struct usb_serial_port *port = tty->driver_data;
1082        struct ti_port *tport = usb_get_serial_port_data(port);
1083        unsigned int mcr;
1084        unsigned long flags;
1085
1086        spin_lock_irqsave(&tport->tp_lock, flags);
1087        mcr = tport->tp_shadow_mcr;
1088
1089        if (set & TIOCM_RTS)
1090                mcr |= TI_MCR_RTS;
1091        if (set & TIOCM_DTR)
1092                mcr |= TI_MCR_DTR;
1093        if (set & TIOCM_LOOP)
1094                mcr |= TI_MCR_LOOP;
1095
1096        if (clear & TIOCM_RTS)
1097                mcr &= ~TI_MCR_RTS;
1098        if (clear & TIOCM_DTR)
1099                mcr &= ~TI_MCR_DTR;
1100        if (clear & TIOCM_LOOP)
1101                mcr &= ~TI_MCR_LOOP;
1102        spin_unlock_irqrestore(&tport->tp_lock, flags);
1103
1104        return ti_set_mcr(tport, mcr);
1105}
1106
1107
1108static void ti_break(struct tty_struct *tty, int break_state)
1109{
1110        struct usb_serial_port *port = tty->driver_data;
1111        struct ti_port *tport = usb_get_serial_port_data(port);
1112        int status;
1113
1114        dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
1115
1116        status = ti_write_byte(port, tport->tp_tdev,
1117                tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
1118                TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
1119
1120        if (status)
1121                dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
1122}
1123
1124static int ti_get_port_from_code(unsigned char code)
1125{
1126        return (code >> 4) - 3;
1127}
1128
1129static int ti_get_func_from_code(unsigned char code)
1130{
1131        return code & 0x0f;
1132}
1133
1134static void ti_interrupt_callback(struct urb *urb)
1135{
1136        struct ti_device *tdev = urb->context;
1137        struct usb_serial_port *port;
1138        struct usb_serial *serial = tdev->td_serial;
1139        struct ti_port *tport;
1140        struct device *dev = &urb->dev->dev;
1141        unsigned char *data = urb->transfer_buffer;
1142        int length = urb->actual_length;
1143        int port_number;
1144        int function;
1145        int status = urb->status;
1146        int retval;
1147        u8 msr;
1148
1149        switch (status) {
1150        case 0:
1151                break;
1152        case -ECONNRESET:
1153        case -ENOENT:
1154        case -ESHUTDOWN:
1155                dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1156                return;
1157        default:
1158                dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
1159                goto exit;
1160        }
1161
1162        if (length != 2) {
1163                dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
1164                goto exit;
1165        }
1166
1167        if (data[0] == TI_CODE_HARDWARE_ERROR) {
1168                dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
1169                goto exit;
1170        }
1171
1172        port_number = ti_get_port_from_code(data[0]);
1173        function = ti_get_func_from_code(data[0]);
1174
1175        dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
1176                __func__, port_number, function, data[1]);
1177
1178        if (port_number >= serial->num_ports) {
1179                dev_err(dev, "%s - bad port number, %d\n",
1180                                                __func__, port_number);
1181                goto exit;
1182        }
1183
1184        port = serial->port[port_number];
1185
1186        tport = usb_get_serial_port_data(port);
1187        if (!tport)
1188                goto exit;
1189
1190        switch (function) {
1191        case TI_CODE_DATA_ERROR:
1192                dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
1193                        __func__, port_number, data[1]);
1194                break;
1195
1196        case TI_CODE_MODEM_STATUS:
1197                msr = data[1];
1198                dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
1199                ti_handle_new_msr(tport, msr);
1200                break;
1201
1202        default:
1203                dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1204                                                        __func__, data[1]);
1205                break;
1206        }
1207
1208exit:
1209        retval = usb_submit_urb(urb, GFP_ATOMIC);
1210        if (retval)
1211                dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1212                        __func__, retval);
1213}
1214
1215
1216static void ti_bulk_in_callback(struct urb *urb)
1217{
1218        struct ti_port *tport = urb->context;
1219        struct usb_serial_port *port = tport->tp_port;
1220        struct device *dev = &urb->dev->dev;
1221        int status = urb->status;
1222        int retval = 0;
1223
1224        switch (status) {
1225        case 0:
1226                break;
1227        case -ECONNRESET:
1228        case -ENOENT:
1229        case -ESHUTDOWN:
1230                dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1231                return;
1232        default:
1233                dev_err(dev, "%s - nonzero urb status, %d\n",
1234                        __func__, status);
1235        }
1236
1237        if (status == -EPIPE)
1238                goto exit;
1239
1240        if (status) {
1241                dev_err(dev, "%s - stopping read!\n", __func__);
1242                return;
1243        }
1244
1245        if (urb->actual_length) {
1246                usb_serial_debug_data(dev, __func__, urb->actual_length,
1247                                      urb->transfer_buffer);
1248
1249                if (!tport->tp_is_open)
1250                        dev_dbg(dev, "%s - port closed, dropping data\n",
1251                                __func__);
1252                else
1253                        ti_recv(port, urb->transfer_buffer, urb->actual_length);
1254                spin_lock(&tport->tp_lock);
1255                port->icount.rx += urb->actual_length;
1256                spin_unlock(&tport->tp_lock);
1257        }
1258
1259exit:
1260        /* continue to read unless stopping */
1261        spin_lock(&tport->tp_lock);
1262        if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1263                retval = usb_submit_urb(urb, GFP_ATOMIC);
1264        else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1265                tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1266
1267        spin_unlock(&tport->tp_lock);
1268        if (retval)
1269                dev_err(dev, "%s - resubmit read urb failed, %d\n",
1270                        __func__, retval);
1271}
1272
1273
1274static void ti_bulk_out_callback(struct urb *urb)
1275{
1276        struct ti_port *tport = urb->context;
1277        struct usb_serial_port *port = tport->tp_port;
1278        int status = urb->status;
1279
1280        tport->tp_write_urb_in_use = 0;
1281
1282        switch (status) {
1283        case 0:
1284                break;
1285        case -ECONNRESET:
1286        case -ENOENT:
1287        case -ESHUTDOWN:
1288                dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1289                return;
1290        default:
1291                dev_err_console(port, "%s - nonzero urb status, %d\n",
1292                        __func__, status);
1293        }
1294
1295        /* send any buffered data */
1296        ti_send(tport);
1297}
1298
1299
1300static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1301                int length)
1302{
1303        int cnt;
1304
1305        do {
1306                cnt = tty_insert_flip_string(&port->port, data, length);
1307                if (cnt < length) {
1308                        dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1309                                                __func__, length - cnt);
1310                        if (cnt == 0)
1311                                break;
1312                }
1313                tty_flip_buffer_push(&port->port);
1314                data += cnt;
1315                length -= cnt;
1316        } while (length > 0);
1317}
1318
1319
1320static void ti_send(struct ti_port *tport)
1321{
1322        int count, result;
1323        struct usb_serial_port *port = tport->tp_port;
1324        unsigned long flags;
1325
1326        spin_lock_irqsave(&tport->tp_lock, flags);
1327
1328        if (tport->tp_write_urb_in_use)
1329                goto unlock;
1330
1331        count = kfifo_out(&port->write_fifo,
1332                                port->write_urb->transfer_buffer,
1333                                port->bulk_out_size);
1334
1335        if (count == 0)
1336                goto unlock;
1337
1338        tport->tp_write_urb_in_use = 1;
1339
1340        spin_unlock_irqrestore(&tport->tp_lock, flags);
1341
1342        usb_serial_debug_data(&port->dev, __func__, count,
1343                              port->write_urb->transfer_buffer);
1344
1345        usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1346                           usb_sndbulkpipe(port->serial->dev,
1347                                            port->bulk_out_endpointAddress),
1348                           port->write_urb->transfer_buffer, count,
1349                           ti_bulk_out_callback, tport);
1350
1351        result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1352        if (result) {
1353                dev_err_console(port, "%s - submit write urb failed, %d\n",
1354                                                        __func__, result);
1355                tport->tp_write_urb_in_use = 0;
1356                /* TODO: reschedule ti_send */
1357        } else {
1358                spin_lock_irqsave(&tport->tp_lock, flags);
1359                port->icount.tx += count;
1360                spin_unlock_irqrestore(&tport->tp_lock, flags);
1361        }
1362
1363        /* more room in the buffer for new writes, wakeup */
1364        tty_port_tty_wakeup(&port->port);
1365
1366        return;
1367unlock:
1368        spin_unlock_irqrestore(&tport->tp_lock, flags);
1369        return;
1370}
1371
1372
1373static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1374{
1375        unsigned long flags;
1376        int status;
1377
1378        status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1379                tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1380                TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1381
1382        spin_lock_irqsave(&tport->tp_lock, flags);
1383        if (!status)
1384                tport->tp_shadow_mcr = mcr;
1385        spin_unlock_irqrestore(&tport->tp_lock, flags);
1386
1387        return status;
1388}
1389
1390
1391static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1392{
1393        int size, status;
1394        struct ti_device *tdev = tport->tp_tdev;
1395        struct usb_serial_port *port = tport->tp_port;
1396        int port_number = port->port_number;
1397        struct ti_port_status *data;
1398
1399        size = sizeof(struct ti_port_status);
1400        data = kmalloc(size, GFP_KERNEL);
1401        if (!data)
1402                return -ENOMEM;
1403
1404        status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1405                (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1406        if (status) {
1407                dev_err(&port->dev,
1408                        "%s - get port status command failed, %d\n",
1409                                                        __func__, status);
1410                goto free_data;
1411        }
1412
1413        dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1414
1415        *lsr = data->bLSR;
1416
1417free_data:
1418        kfree(data);
1419        return status;
1420}
1421
1422
1423static int ti_get_serial_info(struct ti_port *tport,
1424        struct serial_struct __user *ret_arg)
1425{
1426        struct usb_serial_port *port = tport->tp_port;
1427        struct serial_struct ret_serial;
1428        unsigned cwait;
1429
1430        cwait = port->port.closing_wait;
1431        if (cwait != ASYNC_CLOSING_WAIT_NONE)
1432                cwait = jiffies_to_msecs(cwait) / 10;
1433
1434        memset(&ret_serial, 0, sizeof(ret_serial));
1435
1436        ret_serial.type = PORT_16550A;
1437        ret_serial.line = port->minor;
1438        ret_serial.port = port->port_number;
1439        ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1440        ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1441        ret_serial.closing_wait = cwait;
1442
1443        if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1444                return -EFAULT;
1445
1446        return 0;
1447}
1448
1449
1450static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1451        struct serial_struct __user *new_arg)
1452{
1453        struct serial_struct new_serial;
1454        unsigned cwait;
1455
1456        if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1457                return -EFAULT;
1458
1459        cwait = new_serial.closing_wait;
1460        if (cwait != ASYNC_CLOSING_WAIT_NONE)
1461                cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1462
1463        tport->tp_port->port.closing_wait = cwait;
1464
1465        return 0;
1466}
1467
1468
1469static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1470{
1471        struct async_icount *icount;
1472        struct tty_struct *tty;
1473        unsigned long flags;
1474
1475        dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1476
1477        if (msr & TI_MSR_DELTA_MASK) {
1478                spin_lock_irqsave(&tport->tp_lock, flags);
1479                icount = &tport->tp_port->icount;
1480                if (msr & TI_MSR_DELTA_CTS)
1481                        icount->cts++;
1482                if (msr & TI_MSR_DELTA_DSR)
1483                        icount->dsr++;
1484                if (msr & TI_MSR_DELTA_CD)
1485                        icount->dcd++;
1486                if (msr & TI_MSR_DELTA_RI)
1487                        icount->rng++;
1488                wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1489                spin_unlock_irqrestore(&tport->tp_lock, flags);
1490        }
1491
1492        tport->tp_msr = msr & TI_MSR_MASK;
1493
1494        /* handle CTS flow control */
1495        tty = tty_port_tty_get(&tport->tp_port->port);
1496        if (tty && C_CRTSCTS(tty)) {
1497                if (msr & TI_MSR_CTS)
1498                        tty_wakeup(tty);
1499        }
1500        tty_kref_put(tty);
1501}
1502
1503
1504static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1505{
1506        unsigned long flags;
1507
1508        spin_lock_irqsave(&tport->tp_lock, flags);
1509
1510        if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1511                tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1512
1513        spin_unlock_irqrestore(&tport->tp_lock, flags);
1514}
1515
1516
1517static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1518{
1519        struct urb *urb;
1520        int status = 0;
1521        unsigned long flags;
1522
1523        spin_lock_irqsave(&tport->tp_lock, flags);
1524
1525        if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1526                tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1527                urb = tport->tp_port->read_urb;
1528                spin_unlock_irqrestore(&tport->tp_lock, flags);
1529                urb->context = tport;
1530                status = usb_submit_urb(urb, GFP_KERNEL);
1531        } else  {
1532                tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1533                spin_unlock_irqrestore(&tport->tp_lock, flags);
1534        }
1535
1536        return status;
1537}
1538
1539
1540static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1541        __u16 moduleid, __u16 value, __u8 *data, int size)
1542{
1543        int status;
1544
1545        status = usb_control_msg(tdev->td_serial->dev,
1546                usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1547                (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1548                value, moduleid, data, size, 1000);
1549
1550        if (status < 0)
1551                return status;
1552
1553        return 0;
1554}
1555
1556
1557static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1558        __u16 moduleid, __u16 value, __u8 *data, int size)
1559{
1560        int status;
1561
1562        status = usb_control_msg(tdev->td_serial->dev,
1563                usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1564                (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1565                value, moduleid, data, size, 1000);
1566
1567        if (status == size)
1568                status = 0;
1569        else if (status >= 0)
1570                status = -ECOMM;
1571
1572        return status;
1573}
1574
1575
1576static int ti_write_byte(struct usb_serial_port *port,
1577                         struct ti_device *tdev, unsigned long addr,
1578                         u8 mask, u8 byte)
1579{
1580        int status;
1581        unsigned int size;
1582        struct ti_write_data_bytes *data;
1583
1584        dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1585                addr, mask, byte);
1586
1587        size = sizeof(struct ti_write_data_bytes) + 2;
1588        data = kmalloc(size, GFP_KERNEL);
1589        if (!data)
1590                return -ENOMEM;
1591
1592        data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1593        data->bDataType = TI_RW_DATA_BYTE;
1594        data->bDataCounter = 1;
1595        data->wBaseAddrHi = cpu_to_be16(addr>>16);
1596        data->wBaseAddrLo = cpu_to_be16(addr);
1597        data->bData[0] = mask;
1598        data->bData[1] = byte;
1599
1600        status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1601                (__u8 *)data, size);
1602
1603        if (status < 0)
1604                dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1605
1606        kfree(data);
1607
1608        return status;
1609}
1610
1611static int ti_do_download(struct usb_device *dev, int pipe,
1612                                                u8 *buffer, int size)
1613{
1614        int pos;
1615        u8 cs = 0;
1616        int done;
1617        struct ti_firmware_header *header;
1618        int status = 0;
1619        int len;
1620
1621        for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1622                cs = (u8)(cs + buffer[pos]);
1623
1624        header = (struct ti_firmware_header *)buffer;
1625        header->wLength = cpu_to_le16(size - sizeof(*header));
1626        header->bCheckSum = cs;
1627
1628        dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1629        for (pos = 0; pos < size; pos += done) {
1630                len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1631                status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1632                                                                &done, 1000);
1633                if (status)
1634                        break;
1635        }
1636        return status;
1637}
1638
1639static int ti_download_firmware(struct ti_device *tdev)
1640{
1641        int status;
1642        int buffer_size;
1643        u8 *buffer;
1644        struct usb_device *dev = tdev->td_serial->dev;
1645        unsigned int pipe = usb_sndbulkpipe(dev,
1646                tdev->td_serial->port[0]->bulk_out_endpointAddress);
1647        const struct firmware *fw_p;
1648        char buf[32];
1649
1650        if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1651                snprintf(buf,
1652                        sizeof(buf),
1653                        "moxa/moxa-%04x.fw",
1654                        le16_to_cpu(dev->descriptor.idProduct));
1655
1656                status = request_firmware(&fw_p, buf, &dev->dev);
1657                goto check_firmware;
1658        }
1659
1660        /* try ID specific firmware first, then try generic firmware */
1661        sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1662                        le16_to_cpu(dev->descriptor.idVendor),
1663                        le16_to_cpu(dev->descriptor.idProduct));
1664        status = request_firmware(&fw_p, buf, &dev->dev);
1665
1666        if (status != 0) {
1667                buf[0] = '\0';
1668                if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1669                        switch (le16_to_cpu(dev->descriptor.idProduct)) {
1670                        case MTS_CDMA_PRODUCT_ID:
1671                                strcpy(buf, "mts_cdma.fw");
1672                                break;
1673                        case MTS_GSM_PRODUCT_ID:
1674                                strcpy(buf, "mts_gsm.fw");
1675                                break;
1676                        case MTS_EDGE_PRODUCT_ID:
1677                                strcpy(buf, "mts_edge.fw");
1678                                break;
1679                        case MTS_MT9234MU_PRODUCT_ID:
1680                                strcpy(buf, "mts_mt9234mu.fw");
1681                                break;
1682                        case MTS_MT9234ZBA_PRODUCT_ID:
1683                                strcpy(buf, "mts_mt9234zba.fw");
1684                                break;
1685                        case MTS_MT9234ZBAOLD_PRODUCT_ID:
1686                                strcpy(buf, "mts_mt9234zba.fw");
1687                                break;                  }
1688                }
1689                if (buf[0] == '\0') {
1690                        if (tdev->td_is_3410)
1691                                strcpy(buf, "ti_3410.fw");
1692                        else
1693                                strcpy(buf, "ti_5052.fw");
1694                }
1695                status = request_firmware(&fw_p, buf, &dev->dev);
1696        }
1697
1698check_firmware:
1699        if (status) {
1700                dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1701                return -ENOENT;
1702        }
1703        if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1704                dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1705                release_firmware(fw_p);
1706                return -ENOENT;
1707        }
1708
1709        buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1710        buffer = kmalloc(buffer_size, GFP_KERNEL);
1711        if (buffer) {
1712                memcpy(buffer, fw_p->data, fw_p->size);
1713                memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1714                status = ti_do_download(dev, pipe, buffer, fw_p->size);
1715                kfree(buffer);
1716        } else {
1717                status = -ENOMEM;
1718        }
1719        release_firmware(fw_p);
1720        if (status) {
1721                dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1722                                                        __func__, status);
1723                return status;
1724        }
1725
1726        dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1727
1728        return 0;
1729}
1730