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        .attach                 = ti_startup,
 431        .release                = ti_release,
 432        .port_probe             = ti_port_probe,
 433        .port_remove            = ti_port_remove,
 434        .open                   = ti_open,
 435        .close                  = ti_close,
 436        .write                  = ti_write,
 437        .write_room             = ti_write_room,
 438        .chars_in_buffer        = ti_chars_in_buffer,
 439        .tx_empty               = ti_tx_empty,
 440        .throttle               = ti_throttle,
 441        .unthrottle             = ti_unthrottle,
 442        .ioctl                  = ti_ioctl,
 443        .set_termios            = ti_set_termios,
 444        .tiocmget               = ti_tiocmget,
 445        .tiocmset               = ti_tiocmset,
 446        .tiocmiwait             = usb_serial_generic_tiocmiwait,
 447        .get_icount             = usb_serial_generic_get_icount,
 448        .break_ctl              = ti_break,
 449        .read_int_callback      = ti_interrupt_callback,
 450        .read_bulk_callback     = ti_bulk_in_callback,
 451        .write_bulk_callback    = ti_bulk_out_callback,
 452};
 453
 454static struct usb_serial_driver ti_2port_device = {
 455        .driver = {
 456                .owner          = THIS_MODULE,
 457                .name           = "ti_usb_3410_5052_2",
 458        },
 459        .description            = "TI USB 5052 2 port adapter",
 460        .id_table               = ti_id_table_5052,
 461        .num_ports              = 2,
 462        .attach                 = ti_startup,
 463        .release                = ti_release,
 464        .port_probe             = ti_port_probe,
 465        .port_remove            = ti_port_remove,
 466        .open                   = ti_open,
 467        .close                  = ti_close,
 468        .write                  = ti_write,
 469        .write_room             = ti_write_room,
 470        .chars_in_buffer        = ti_chars_in_buffer,
 471        .tx_empty               = ti_tx_empty,
 472        .throttle               = ti_throttle,
 473        .unthrottle             = ti_unthrottle,
 474        .ioctl                  = ti_ioctl,
 475        .set_termios            = ti_set_termios,
 476        .tiocmget               = ti_tiocmget,
 477        .tiocmset               = ti_tiocmset,
 478        .tiocmiwait             = usb_serial_generic_tiocmiwait,
 479        .get_icount             = usb_serial_generic_get_icount,
 480        .break_ctl              = ti_break,
 481        .read_int_callback      = ti_interrupt_callback,
 482        .read_bulk_callback     = ti_bulk_in_callback,
 483        .write_bulk_callback    = ti_bulk_out_callback,
 484};
 485
 486static struct usb_serial_driver * const serial_drivers[] = {
 487        &ti_1port_device, &ti_2port_device, NULL
 488};
 489
 490MODULE_AUTHOR(TI_DRIVER_AUTHOR);
 491MODULE_DESCRIPTION(TI_DRIVER_DESC);
 492MODULE_LICENSE("GPL");
 493
 494MODULE_FIRMWARE("ti_3410.fw");
 495MODULE_FIRMWARE("ti_5052.fw");
 496MODULE_FIRMWARE("mts_cdma.fw");
 497MODULE_FIRMWARE("mts_gsm.fw");
 498MODULE_FIRMWARE("mts_edge.fw");
 499MODULE_FIRMWARE("mts_mt9234mu.fw");
 500MODULE_FIRMWARE("mts_mt9234zba.fw");
 501MODULE_FIRMWARE("moxa/moxa-1110.fw");
 502MODULE_FIRMWARE("moxa/moxa-1130.fw");
 503MODULE_FIRMWARE("moxa/moxa-1131.fw");
 504MODULE_FIRMWARE("moxa/moxa-1150.fw");
 505MODULE_FIRMWARE("moxa/moxa-1151.fw");
 506
 507module_param(closing_wait, int, S_IRUGO | S_IWUSR);
 508MODULE_PARM_DESC(closing_wait,
 509    "Maximum wait for data to drain in close, in .01 secs, default is 4000");
 510
 511MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
 512
 513module_usb_serial_driver(serial_drivers, ti_id_table_combined);
 514
 515static int ti_startup(struct usb_serial *serial)
 516{
 517        struct ti_device *tdev;
 518        struct usb_device *dev = serial->dev;
 519        struct usb_host_interface *cur_altsetting;
 520        int num_endpoints;
 521        u16 vid, pid;
 522        int status;
 523
 524        dev_dbg(&dev->dev,
 525                "%s - product 0x%4X, num configurations %d, configuration value %d\n",
 526                __func__, le16_to_cpu(dev->descriptor.idProduct),
 527                dev->descriptor.bNumConfigurations,
 528                dev->actconfig->desc.bConfigurationValue);
 529
 530        tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
 531        if (!tdev)
 532                return -ENOMEM;
 533
 534        mutex_init(&tdev->td_open_close_lock);
 535        tdev->td_serial = serial;
 536        usb_set_serial_data(serial, tdev);
 537
 538        /* determine device type */
 539        if (serial->type == &ti_1port_device)
 540                tdev->td_is_3410 = 1;
 541        dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
 542                tdev->td_is_3410 ? "3410" : "5052");
 543
 544        vid = le16_to_cpu(dev->descriptor.idVendor);
 545        pid = le16_to_cpu(dev->descriptor.idProduct);
 546        if (vid == MXU1_VENDOR_ID) {
 547                switch (pid) {
 548                case MXU1_1130_PRODUCT_ID:
 549                case MXU1_1131_PRODUCT_ID:
 550                        tdev->td_rs485_only = true;
 551                        break;
 552                }
 553        }
 554
 555        cur_altsetting = serial->interface->cur_altsetting;
 556        num_endpoints = cur_altsetting->desc.bNumEndpoints;
 557
 558        /* if we have only 1 configuration and 1 endpoint, download firmware */
 559        if (dev->descriptor.bNumConfigurations == 1 && num_endpoints == 1) {
 560                status = ti_download_firmware(tdev);
 561
 562                if (status != 0)
 563                        goto free_tdev;
 564
 565                /* 3410 must be reset, 5052 resets itself */
 566                if (tdev->td_is_3410) {
 567                        msleep_interruptible(100);
 568                        usb_reset_device(dev);
 569                }
 570
 571                status = -ENODEV;
 572                goto free_tdev;
 573        }
 574
 575        /* the second configuration must be set */
 576        if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
 577                status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
 578                status = status ? status : -ENODEV;
 579                goto free_tdev;
 580        }
 581
 582        if (serial->num_bulk_in < serial->num_ports ||
 583                        serial->num_bulk_out < serial->num_ports) {
 584                dev_err(&serial->interface->dev, "missing endpoints\n");
 585                status = -ENODEV;
 586                goto free_tdev;
 587        }
 588
 589        return 0;
 590
 591free_tdev:
 592        kfree(tdev);
 593        usb_set_serial_data(serial, NULL);
 594        return status;
 595}
 596
 597
 598static void ti_release(struct usb_serial *serial)
 599{
 600        struct ti_device *tdev = usb_get_serial_data(serial);
 601
 602        kfree(tdev);
 603}
 604
 605static int ti_port_probe(struct usb_serial_port *port)
 606{
 607        struct ti_port *tport;
 608
 609        tport = kzalloc(sizeof(*tport), GFP_KERNEL);
 610        if (!tport)
 611                return -ENOMEM;
 612
 613        spin_lock_init(&tport->tp_lock);
 614        if (port == port->serial->port[0])
 615                tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
 616        else
 617                tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
 618        port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
 619        tport->tp_port = port;
 620        tport->tp_tdev = usb_get_serial_data(port->serial);
 621
 622        if (tport->tp_tdev->td_rs485_only)
 623                tport->tp_uart_mode = TI_UART_485_RECEIVER_DISABLED;
 624        else
 625                tport->tp_uart_mode = TI_UART_232;
 626
 627        usb_set_serial_port_data(port, tport);
 628
 629        port->port.drain_delay = 3;
 630
 631        return 0;
 632}
 633
 634static int ti_port_remove(struct usb_serial_port *port)
 635{
 636        struct ti_port *tport;
 637
 638        tport = usb_get_serial_port_data(port);
 639        kfree(tport);
 640
 641        return 0;
 642}
 643
 644static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
 645{
 646        struct ti_port *tport = usb_get_serial_port_data(port);
 647        struct ti_device *tdev;
 648        struct usb_device *dev;
 649        struct urb *urb;
 650        int port_number;
 651        int status;
 652        u16 open_settings;
 653
 654        open_settings = (TI_PIPE_MODE_CONTINUOUS |
 655                         TI_PIPE_TIMEOUT_ENABLE |
 656                         (TI_TRANSFER_TIMEOUT << 2));
 657
 658        dev = port->serial->dev;
 659        tdev = tport->tp_tdev;
 660
 661        /* only one open on any port on a device at a time */
 662        if (mutex_lock_interruptible(&tdev->td_open_close_lock))
 663                return -ERESTARTSYS;
 664
 665        port_number = port->port_number;
 666
 667        tport->tp_msr = 0;
 668        tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
 669
 670        /* start interrupt urb the first time a port is opened on this device */
 671        if (tdev->td_open_port_count == 0) {
 672                dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
 673                urb = tdev->td_serial->port[0]->interrupt_in_urb;
 674                if (!urb) {
 675                        dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
 676                        status = -EINVAL;
 677                        goto release_lock;
 678                }
 679                urb->context = tdev;
 680                status = usb_submit_urb(urb, GFP_KERNEL);
 681                if (status) {
 682                        dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
 683                        goto release_lock;
 684                }
 685        }
 686
 687        if (tty)
 688                ti_set_termios(tty, port, &tty->termios);
 689
 690        status = ti_command_out_sync(tdev, TI_OPEN_PORT,
 691                (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
 692        if (status) {
 693                dev_err(&port->dev, "%s - cannot send open command, %d\n",
 694                        __func__, status);
 695                goto unlink_int_urb;
 696        }
 697
 698        status = ti_command_out_sync(tdev, TI_START_PORT,
 699                (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 700        if (status) {
 701                dev_err(&port->dev, "%s - cannot send start command, %d\n",
 702                                                        __func__, status);
 703                goto unlink_int_urb;
 704        }
 705
 706        status = ti_command_out_sync(tdev, TI_PURGE_PORT,
 707                (__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
 708        if (status) {
 709                dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
 710                                                        __func__, status);
 711                goto unlink_int_urb;
 712        }
 713        status = ti_command_out_sync(tdev, TI_PURGE_PORT,
 714                (__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
 715        if (status) {
 716                dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
 717                                                        __func__, status);
 718                goto unlink_int_urb;
 719        }
 720
 721        /* reset the data toggle on the bulk endpoints to work around bug in
 722         * host controllers where things get out of sync some times */
 723        usb_clear_halt(dev, port->write_urb->pipe);
 724        usb_clear_halt(dev, port->read_urb->pipe);
 725
 726        if (tty)
 727                ti_set_termios(tty, port, &tty->termios);
 728
 729        status = ti_command_out_sync(tdev, TI_OPEN_PORT,
 730                (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
 731        if (status) {
 732                dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
 733                                                        __func__, status);
 734                goto unlink_int_urb;
 735        }
 736
 737        status = ti_command_out_sync(tdev, TI_START_PORT,
 738                (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 739        if (status) {
 740                dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
 741                                                        __func__, status);
 742                goto unlink_int_urb;
 743        }
 744
 745        /* start read urb */
 746        urb = port->read_urb;
 747        if (!urb) {
 748                dev_err(&port->dev, "%s - no read urb\n", __func__);
 749                status = -EINVAL;
 750                goto unlink_int_urb;
 751        }
 752        tport->tp_read_urb_state = TI_READ_URB_RUNNING;
 753        urb->context = tport;
 754        status = usb_submit_urb(urb, GFP_KERNEL);
 755        if (status) {
 756                dev_err(&port->dev, "%s - submit read urb failed, %d\n",
 757                                                        __func__, status);
 758                goto unlink_int_urb;
 759        }
 760
 761        tport->tp_is_open = 1;
 762        ++tdev->td_open_port_count;
 763
 764        goto release_lock;
 765
 766unlink_int_urb:
 767        if (tdev->td_open_port_count == 0)
 768                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
 769release_lock:
 770        mutex_unlock(&tdev->td_open_close_lock);
 771        return status;
 772}
 773
 774
 775static void ti_close(struct usb_serial_port *port)
 776{
 777        struct ti_device *tdev;
 778        struct ti_port *tport;
 779        int port_number;
 780        int status;
 781        int do_unlock;
 782        unsigned long flags;
 783
 784        tdev = usb_get_serial_data(port->serial);
 785        tport = usb_get_serial_port_data(port);
 786
 787        tport->tp_is_open = 0;
 788
 789        usb_kill_urb(port->read_urb);
 790        usb_kill_urb(port->write_urb);
 791        tport->tp_write_urb_in_use = 0;
 792        spin_lock_irqsave(&tport->tp_lock, flags);
 793        kfifo_reset_out(&port->write_fifo);
 794        spin_unlock_irqrestore(&tport->tp_lock, flags);
 795
 796        port_number = port->port_number;
 797
 798        status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
 799                     (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
 800        if (status)
 801                dev_err(&port->dev,
 802                        "%s - cannot send close port command, %d\n"
 803                                                        , __func__, status);
 804
 805        /* if mutex_lock is interrupted, continue anyway */
 806        do_unlock = !mutex_lock_interruptible(&tdev->td_open_close_lock);
 807        --tport->tp_tdev->td_open_port_count;
 808        if (tport->tp_tdev->td_open_port_count <= 0) {
 809                /* last port is closed, shut down interrupt urb */
 810                usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
 811                tport->tp_tdev->td_open_port_count = 0;
 812        }
 813        if (do_unlock)
 814                mutex_unlock(&tdev->td_open_close_lock);
 815}
 816
 817
 818static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
 819                        const unsigned char *data, int count)
 820{
 821        struct ti_port *tport = usb_get_serial_port_data(port);
 822
 823        if (count == 0) {
 824                return 0;
 825        }
 826
 827        if (!tport->tp_is_open)
 828                return -ENODEV;
 829
 830        count = kfifo_in_locked(&port->write_fifo, data, count,
 831                                                        &tport->tp_lock);
 832        ti_send(tport);
 833
 834        return count;
 835}
 836
 837
 838static int ti_write_room(struct tty_struct *tty)
 839{
 840        struct usb_serial_port *port = tty->driver_data;
 841        struct ti_port *tport = usb_get_serial_port_data(port);
 842        int room = 0;
 843        unsigned long flags;
 844
 845        spin_lock_irqsave(&tport->tp_lock, flags);
 846        room = kfifo_avail(&port->write_fifo);
 847        spin_unlock_irqrestore(&tport->tp_lock, flags);
 848
 849        dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
 850        return room;
 851}
 852
 853
 854static int ti_chars_in_buffer(struct tty_struct *tty)
 855{
 856        struct usb_serial_port *port = tty->driver_data;
 857        struct ti_port *tport = usb_get_serial_port_data(port);
 858        int chars = 0;
 859        unsigned long flags;
 860
 861        spin_lock_irqsave(&tport->tp_lock, flags);
 862        chars = kfifo_len(&port->write_fifo);
 863        spin_unlock_irqrestore(&tport->tp_lock, flags);
 864
 865        dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
 866        return chars;
 867}
 868
 869static bool ti_tx_empty(struct usb_serial_port *port)
 870{
 871        struct ti_port *tport = usb_get_serial_port_data(port);
 872        int ret;
 873        u8 lsr;
 874
 875        ret = ti_get_lsr(tport, &lsr);
 876        if (!ret && !(lsr & TI_LSR_TX_EMPTY))
 877                return false;
 878
 879        return true;
 880}
 881
 882static void ti_throttle(struct tty_struct *tty)
 883{
 884        struct usb_serial_port *port = tty->driver_data;
 885        struct ti_port *tport = usb_get_serial_port_data(port);
 886
 887        if (I_IXOFF(tty) || C_CRTSCTS(tty))
 888                ti_stop_read(tport, tty);
 889
 890}
 891
 892
 893static void ti_unthrottle(struct tty_struct *tty)
 894{
 895        struct usb_serial_port *port = tty->driver_data;
 896        struct ti_port *tport = usb_get_serial_port_data(port);
 897        int status;
 898
 899        if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
 900                status = ti_restart_read(tport, tty);
 901                if (status)
 902                        dev_err(&port->dev, "%s - cannot restart read, %d\n",
 903                                                        __func__, status);
 904        }
 905}
 906
 907static int ti_ioctl(struct tty_struct *tty,
 908        unsigned int cmd, unsigned long arg)
 909{
 910        struct usb_serial_port *port = tty->driver_data;
 911        struct ti_port *tport = usb_get_serial_port_data(port);
 912
 913        switch (cmd) {
 914        case TIOCGSERIAL:
 915                return ti_get_serial_info(tport,
 916                                (struct serial_struct __user *)arg);
 917        case TIOCSSERIAL:
 918                return ti_set_serial_info(tty, tport,
 919                                (struct serial_struct __user *)arg);
 920        }
 921        return -ENOIOCTLCMD;
 922}
 923
 924
 925static void ti_set_termios(struct tty_struct *tty,
 926                struct usb_serial_port *port, struct ktermios *old_termios)
 927{
 928        struct ti_port *tport = usb_get_serial_port_data(port);
 929        struct ti_uart_config *config;
 930        tcflag_t cflag, iflag;
 931        int baud;
 932        int status;
 933        int port_number = port->port_number;
 934        unsigned int mcr;
 935        u16 wbaudrate;
 936        u16 wflags = 0;
 937
 938        cflag = tty->termios.c_cflag;
 939        iflag = tty->termios.c_iflag;
 940
 941        dev_dbg(&port->dev, "%s - cflag %08x, iflag %08x\n", __func__, cflag, iflag);
 942        dev_dbg(&port->dev, "%s - old clfag %08x, old iflag %08x\n", __func__,
 943                old_termios->c_cflag, old_termios->c_iflag);
 944
 945        config = kmalloc(sizeof(*config), GFP_KERNEL);
 946        if (!config)
 947                return;
 948
 949        /* these flags must be set */
 950        wflags |= TI_UART_ENABLE_MS_INTS;
 951        wflags |= TI_UART_ENABLE_AUTO_START_DMA;
 952        config->bUartMode = tport->tp_uart_mode;
 953
 954        switch (C_CSIZE(tty)) {
 955        case CS5:
 956                    config->bDataBits = TI_UART_5_DATA_BITS;
 957                    break;
 958        case CS6:
 959                    config->bDataBits = TI_UART_6_DATA_BITS;
 960                    break;
 961        case CS7:
 962                    config->bDataBits = TI_UART_7_DATA_BITS;
 963                    break;
 964        default:
 965        case CS8:
 966                    config->bDataBits = TI_UART_8_DATA_BITS;
 967                    break;
 968        }
 969
 970        /* CMSPAR isn't supported by this driver */
 971        tty->termios.c_cflag &= ~CMSPAR;
 972
 973        if (C_PARENB(tty)) {
 974                if (C_PARODD(tty)) {
 975                        wflags |= TI_UART_ENABLE_PARITY_CHECKING;
 976                        config->bParity = TI_UART_ODD_PARITY;
 977                } else {
 978                        wflags |= TI_UART_ENABLE_PARITY_CHECKING;
 979                        config->bParity = TI_UART_EVEN_PARITY;
 980                }
 981        } else {
 982                wflags &= ~TI_UART_ENABLE_PARITY_CHECKING;
 983                config->bParity = TI_UART_NO_PARITY;
 984        }
 985
 986        if (C_CSTOPB(tty))
 987                config->bStopBits = TI_UART_2_STOP_BITS;
 988        else
 989                config->bStopBits = TI_UART_1_STOP_BITS;
 990
 991        if (C_CRTSCTS(tty)) {
 992                /* RTS flow control must be off to drop RTS for baud rate B0 */
 993                if ((C_BAUD(tty)) != B0)
 994                        wflags |= TI_UART_ENABLE_RTS_IN;
 995                wflags |= TI_UART_ENABLE_CTS_OUT;
 996        } else {
 997                ti_restart_read(tport, tty);
 998        }
 999
1000        if (I_IXOFF(tty) || I_IXON(tty)) {
1001                config->cXon  = START_CHAR(tty);
1002                config->cXoff = STOP_CHAR(tty);
1003
1004                if (I_IXOFF(tty))
1005                        wflags |= TI_UART_ENABLE_X_IN;
1006                else
1007                        ti_restart_read(tport, tty);
1008
1009                if (I_IXON(tty))
1010                        wflags |= TI_UART_ENABLE_X_OUT;
1011        }
1012
1013        baud = tty_get_baud_rate(tty);
1014        if (!baud)
1015                baud = 9600;
1016        if (tport->tp_tdev->td_is_3410)
1017                wbaudrate = (923077 + baud/2) / baud;
1018        else
1019                wbaudrate = (461538 + baud/2) / baud;
1020
1021        /* FIXME: Should calculate resulting baud here and report it back */
1022        if ((C_BAUD(tty)) != B0)
1023                tty_encode_baud_rate(tty, baud, baud);
1024
1025        dev_dbg(&port->dev,
1026                "%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
1027                __func__, baud, wbaudrate, wflags,
1028                config->bDataBits, config->bParity, config->bStopBits,
1029                config->cXon, config->cXoff, config->bUartMode);
1030
1031        config->wBaudRate = cpu_to_be16(wbaudrate);
1032        config->wFlags = cpu_to_be16(wflags);
1033
1034        status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
1035                (__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
1036                sizeof(*config));
1037        if (status)
1038                dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
1039                                        __func__, port_number, status);
1040
1041        /* SET_CONFIG asserts RTS and DTR, reset them correctly */
1042        mcr = tport->tp_shadow_mcr;
1043        /* if baud rate is B0, clear RTS and DTR */
1044        if (C_BAUD(tty) == B0)
1045                mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
1046        status = ti_set_mcr(tport, mcr);
1047        if (status)
1048                dev_err(&port->dev,
1049                        "%s - cannot set modem control on port %d, %d\n",
1050                                                __func__, port_number, status);
1051
1052        kfree(config);
1053}
1054
1055
1056static int ti_tiocmget(struct tty_struct *tty)
1057{
1058        struct usb_serial_port *port = tty->driver_data;
1059        struct ti_port *tport = usb_get_serial_port_data(port);
1060        unsigned int result;
1061        unsigned int msr;
1062        unsigned int mcr;
1063        unsigned long flags;
1064
1065        spin_lock_irqsave(&tport->tp_lock, flags);
1066        msr = tport->tp_msr;
1067        mcr = tport->tp_shadow_mcr;
1068        spin_unlock_irqrestore(&tport->tp_lock, flags);
1069
1070        result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
1071                | ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
1072                | ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
1073                | ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
1074                | ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
1075                | ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
1076                | ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
1077
1078        dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
1079
1080        return result;
1081}
1082
1083
1084static int ti_tiocmset(struct tty_struct *tty,
1085                                unsigned int set, unsigned int clear)
1086{
1087        struct usb_serial_port *port = tty->driver_data;
1088        struct ti_port *tport = usb_get_serial_port_data(port);
1089        unsigned int mcr;
1090        unsigned long flags;
1091
1092        spin_lock_irqsave(&tport->tp_lock, flags);
1093        mcr = tport->tp_shadow_mcr;
1094
1095        if (set & TIOCM_RTS)
1096                mcr |= TI_MCR_RTS;
1097        if (set & TIOCM_DTR)
1098                mcr |= TI_MCR_DTR;
1099        if (set & TIOCM_LOOP)
1100                mcr |= TI_MCR_LOOP;
1101
1102        if (clear & TIOCM_RTS)
1103                mcr &= ~TI_MCR_RTS;
1104        if (clear & TIOCM_DTR)
1105                mcr &= ~TI_MCR_DTR;
1106        if (clear & TIOCM_LOOP)
1107                mcr &= ~TI_MCR_LOOP;
1108        spin_unlock_irqrestore(&tport->tp_lock, flags);
1109
1110        return ti_set_mcr(tport, mcr);
1111}
1112
1113
1114static void ti_break(struct tty_struct *tty, int break_state)
1115{
1116        struct usb_serial_port *port = tty->driver_data;
1117        struct ti_port *tport = usb_get_serial_port_data(port);
1118        int status;
1119
1120        dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
1121
1122        status = ti_write_byte(port, tport->tp_tdev,
1123                tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
1124                TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
1125
1126        if (status)
1127                dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
1128}
1129
1130static int ti_get_port_from_code(unsigned char code)
1131{
1132        return (code >> 4) - 3;
1133}
1134
1135static int ti_get_func_from_code(unsigned char code)
1136{
1137        return code & 0x0f;
1138}
1139
1140static void ti_interrupt_callback(struct urb *urb)
1141{
1142        struct ti_device *tdev = urb->context;
1143        struct usb_serial_port *port;
1144        struct usb_serial *serial = tdev->td_serial;
1145        struct ti_port *tport;
1146        struct device *dev = &urb->dev->dev;
1147        unsigned char *data = urb->transfer_buffer;
1148        int length = urb->actual_length;
1149        int port_number;
1150        int function;
1151        int status = urb->status;
1152        int retval;
1153        u8 msr;
1154
1155        switch (status) {
1156        case 0:
1157                break;
1158        case -ECONNRESET:
1159        case -ENOENT:
1160        case -ESHUTDOWN:
1161                dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1162                return;
1163        default:
1164                dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
1165                goto exit;
1166        }
1167
1168        if (length != 2) {
1169                dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
1170                goto exit;
1171        }
1172
1173        if (data[0] == TI_CODE_HARDWARE_ERROR) {
1174                dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
1175                goto exit;
1176        }
1177
1178        port_number = ti_get_port_from_code(data[0]);
1179        function = ti_get_func_from_code(data[0]);
1180
1181        dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
1182                __func__, port_number, function, data[1]);
1183
1184        if (port_number >= serial->num_ports) {
1185                dev_err(dev, "%s - bad port number, %d\n",
1186                                                __func__, port_number);
1187                goto exit;
1188        }
1189
1190        port = serial->port[port_number];
1191
1192        tport = usb_get_serial_port_data(port);
1193        if (!tport)
1194                goto exit;
1195
1196        switch (function) {
1197        case TI_CODE_DATA_ERROR:
1198                dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
1199                        __func__, port_number, data[1]);
1200                break;
1201
1202        case TI_CODE_MODEM_STATUS:
1203                msr = data[1];
1204                dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
1205                ti_handle_new_msr(tport, msr);
1206                break;
1207
1208        default:
1209                dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1210                                                        __func__, data[1]);
1211                break;
1212        }
1213
1214exit:
1215        retval = usb_submit_urb(urb, GFP_ATOMIC);
1216        if (retval)
1217                dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1218                        __func__, retval);
1219}
1220
1221
1222static void ti_bulk_in_callback(struct urb *urb)
1223{
1224        struct ti_port *tport = urb->context;
1225        struct usb_serial_port *port = tport->tp_port;
1226        struct device *dev = &urb->dev->dev;
1227        int status = urb->status;
1228        int retval = 0;
1229
1230        switch (status) {
1231        case 0:
1232                break;
1233        case -ECONNRESET:
1234        case -ENOENT:
1235        case -ESHUTDOWN:
1236                dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1237                return;
1238        default:
1239                dev_err(dev, "%s - nonzero urb status, %d\n",
1240                        __func__, status);
1241        }
1242
1243        if (status == -EPIPE)
1244                goto exit;
1245
1246        if (status) {
1247                dev_err(dev, "%s - stopping read!\n", __func__);
1248                return;
1249        }
1250
1251        if (urb->actual_length) {
1252                usb_serial_debug_data(dev, __func__, urb->actual_length,
1253                                      urb->transfer_buffer);
1254
1255                if (!tport->tp_is_open)
1256                        dev_dbg(dev, "%s - port closed, dropping data\n",
1257                                __func__);
1258                else
1259                        ti_recv(port, urb->transfer_buffer, urb->actual_length);
1260                spin_lock(&tport->tp_lock);
1261                port->icount.rx += urb->actual_length;
1262                spin_unlock(&tport->tp_lock);
1263        }
1264
1265exit:
1266        /* continue to read unless stopping */
1267        spin_lock(&tport->tp_lock);
1268        if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1269                retval = usb_submit_urb(urb, GFP_ATOMIC);
1270        else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1271                tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1272
1273        spin_unlock(&tport->tp_lock);
1274        if (retval)
1275                dev_err(dev, "%s - resubmit read urb failed, %d\n",
1276                        __func__, retval);
1277}
1278
1279
1280static void ti_bulk_out_callback(struct urb *urb)
1281{
1282        struct ti_port *tport = urb->context;
1283        struct usb_serial_port *port = tport->tp_port;
1284        int status = urb->status;
1285
1286        tport->tp_write_urb_in_use = 0;
1287
1288        switch (status) {
1289        case 0:
1290                break;
1291        case -ECONNRESET:
1292        case -ENOENT:
1293        case -ESHUTDOWN:
1294                dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1295                return;
1296        default:
1297                dev_err_console(port, "%s - nonzero urb status, %d\n",
1298                        __func__, status);
1299        }
1300
1301        /* send any buffered data */
1302        ti_send(tport);
1303}
1304
1305
1306static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1307                int length)
1308{
1309        int cnt;
1310
1311        do {
1312                cnt = tty_insert_flip_string(&port->port, data, length);
1313                if (cnt < length) {
1314                        dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1315                                                __func__, length - cnt);
1316                        if (cnt == 0)
1317                                break;
1318                }
1319                tty_flip_buffer_push(&port->port);
1320                data += cnt;
1321                length -= cnt;
1322        } while (length > 0);
1323}
1324
1325
1326static void ti_send(struct ti_port *tport)
1327{
1328        int count, result;
1329        struct usb_serial_port *port = tport->tp_port;
1330        unsigned long flags;
1331
1332        spin_lock_irqsave(&tport->tp_lock, flags);
1333
1334        if (tport->tp_write_urb_in_use)
1335                goto unlock;
1336
1337        count = kfifo_out(&port->write_fifo,
1338                                port->write_urb->transfer_buffer,
1339                                port->bulk_out_size);
1340
1341        if (count == 0)
1342                goto unlock;
1343
1344        tport->tp_write_urb_in_use = 1;
1345
1346        spin_unlock_irqrestore(&tport->tp_lock, flags);
1347
1348        usb_serial_debug_data(&port->dev, __func__, count,
1349                              port->write_urb->transfer_buffer);
1350
1351        usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1352                           usb_sndbulkpipe(port->serial->dev,
1353                                            port->bulk_out_endpointAddress),
1354                           port->write_urb->transfer_buffer, count,
1355                           ti_bulk_out_callback, tport);
1356
1357        result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1358        if (result) {
1359                dev_err_console(port, "%s - submit write urb failed, %d\n",
1360                                                        __func__, result);
1361                tport->tp_write_urb_in_use = 0;
1362                /* TODO: reschedule ti_send */
1363        } else {
1364                spin_lock_irqsave(&tport->tp_lock, flags);
1365                port->icount.tx += count;
1366                spin_unlock_irqrestore(&tport->tp_lock, flags);
1367        }
1368
1369        /* more room in the buffer for new writes, wakeup */
1370        tty_port_tty_wakeup(&port->port);
1371
1372        return;
1373unlock:
1374        spin_unlock_irqrestore(&tport->tp_lock, flags);
1375        return;
1376}
1377
1378
1379static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1380{
1381        unsigned long flags;
1382        int status;
1383
1384        status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1385                tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1386                TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1387
1388        spin_lock_irqsave(&tport->tp_lock, flags);
1389        if (!status)
1390                tport->tp_shadow_mcr = mcr;
1391        spin_unlock_irqrestore(&tport->tp_lock, flags);
1392
1393        return status;
1394}
1395
1396
1397static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1398{
1399        int size, status;
1400        struct ti_device *tdev = tport->tp_tdev;
1401        struct usb_serial_port *port = tport->tp_port;
1402        int port_number = port->port_number;
1403        struct ti_port_status *data;
1404
1405        size = sizeof(struct ti_port_status);
1406        data = kmalloc(size, GFP_KERNEL);
1407        if (!data)
1408                return -ENOMEM;
1409
1410        status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1411                (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1412        if (status) {
1413                dev_err(&port->dev,
1414                        "%s - get port status command failed, %d\n",
1415                                                        __func__, status);
1416                goto free_data;
1417        }
1418
1419        dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1420
1421        *lsr = data->bLSR;
1422
1423free_data:
1424        kfree(data);
1425        return status;
1426}
1427
1428
1429static int ti_get_serial_info(struct ti_port *tport,
1430        struct serial_struct __user *ret_arg)
1431{
1432        struct usb_serial_port *port = tport->tp_port;
1433        struct serial_struct ret_serial;
1434        unsigned cwait;
1435
1436        cwait = port->port.closing_wait;
1437        if (cwait != ASYNC_CLOSING_WAIT_NONE)
1438                cwait = jiffies_to_msecs(cwait) / 10;
1439
1440        memset(&ret_serial, 0, sizeof(ret_serial));
1441
1442        ret_serial.type = PORT_16550A;
1443        ret_serial.line = port->minor;
1444        ret_serial.port = port->port_number;
1445        ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1446        ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1447        ret_serial.closing_wait = cwait;
1448
1449        if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1450                return -EFAULT;
1451
1452        return 0;
1453}
1454
1455
1456static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1457        struct serial_struct __user *new_arg)
1458{
1459        struct serial_struct new_serial;
1460        unsigned cwait;
1461
1462        if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1463                return -EFAULT;
1464
1465        cwait = new_serial.closing_wait;
1466        if (cwait != ASYNC_CLOSING_WAIT_NONE)
1467                cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1468
1469        tport->tp_port->port.closing_wait = cwait;
1470
1471        return 0;
1472}
1473
1474
1475static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1476{
1477        struct async_icount *icount;
1478        struct tty_struct *tty;
1479        unsigned long flags;
1480
1481        dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1482
1483        if (msr & TI_MSR_DELTA_MASK) {
1484                spin_lock_irqsave(&tport->tp_lock, flags);
1485                icount = &tport->tp_port->icount;
1486                if (msr & TI_MSR_DELTA_CTS)
1487                        icount->cts++;
1488                if (msr & TI_MSR_DELTA_DSR)
1489                        icount->dsr++;
1490                if (msr & TI_MSR_DELTA_CD)
1491                        icount->dcd++;
1492                if (msr & TI_MSR_DELTA_RI)
1493                        icount->rng++;
1494                wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1495                spin_unlock_irqrestore(&tport->tp_lock, flags);
1496        }
1497
1498        tport->tp_msr = msr & TI_MSR_MASK;
1499
1500        /* handle CTS flow control */
1501        tty = tty_port_tty_get(&tport->tp_port->port);
1502        if (tty && C_CRTSCTS(tty)) {
1503                if (msr & TI_MSR_CTS)
1504                        tty_wakeup(tty);
1505        }
1506        tty_kref_put(tty);
1507}
1508
1509
1510static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1511{
1512        unsigned long flags;
1513
1514        spin_lock_irqsave(&tport->tp_lock, flags);
1515
1516        if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1517                tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1518
1519        spin_unlock_irqrestore(&tport->tp_lock, flags);
1520}
1521
1522
1523static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1524{
1525        struct urb *urb;
1526        int status = 0;
1527        unsigned long flags;
1528
1529        spin_lock_irqsave(&tport->tp_lock, flags);
1530
1531        if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1532                tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1533                urb = tport->tp_port->read_urb;
1534                spin_unlock_irqrestore(&tport->tp_lock, flags);
1535                urb->context = tport;
1536                status = usb_submit_urb(urb, GFP_KERNEL);
1537        } else  {
1538                tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1539                spin_unlock_irqrestore(&tport->tp_lock, flags);
1540        }
1541
1542        return status;
1543}
1544
1545
1546static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1547        __u16 moduleid, __u16 value, __u8 *data, int size)
1548{
1549        int status;
1550
1551        status = usb_control_msg(tdev->td_serial->dev,
1552                usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1553                (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1554                value, moduleid, data, size, 1000);
1555
1556        if (status < 0)
1557                return status;
1558
1559        return 0;
1560}
1561
1562
1563static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1564        __u16 moduleid, __u16 value, __u8 *data, int size)
1565{
1566        int status;
1567
1568        status = usb_control_msg(tdev->td_serial->dev,
1569                usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1570                (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1571                value, moduleid, data, size, 1000);
1572
1573        if (status == size)
1574                status = 0;
1575        else if (status >= 0)
1576                status = -ECOMM;
1577
1578        return status;
1579}
1580
1581
1582static int ti_write_byte(struct usb_serial_port *port,
1583                         struct ti_device *tdev, unsigned long addr,
1584                         u8 mask, u8 byte)
1585{
1586        int status;
1587        unsigned int size;
1588        struct ti_write_data_bytes *data;
1589
1590        dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1591                addr, mask, byte);
1592
1593        size = sizeof(struct ti_write_data_bytes) + 2;
1594        data = kmalloc(size, GFP_KERNEL);
1595        if (!data)
1596                return -ENOMEM;
1597
1598        data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1599        data->bDataType = TI_RW_DATA_BYTE;
1600        data->bDataCounter = 1;
1601        data->wBaseAddrHi = cpu_to_be16(addr>>16);
1602        data->wBaseAddrLo = cpu_to_be16(addr);
1603        data->bData[0] = mask;
1604        data->bData[1] = byte;
1605
1606        status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1607                (__u8 *)data, size);
1608
1609        if (status < 0)
1610                dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1611
1612        kfree(data);
1613
1614        return status;
1615}
1616
1617static int ti_do_download(struct usb_device *dev, int pipe,
1618                                                u8 *buffer, int size)
1619{
1620        int pos;
1621        u8 cs = 0;
1622        int done;
1623        struct ti_firmware_header *header;
1624        int status = 0;
1625        int len;
1626
1627        for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1628                cs = (u8)(cs + buffer[pos]);
1629
1630        header = (struct ti_firmware_header *)buffer;
1631        header->wLength = cpu_to_le16(size - sizeof(*header));
1632        header->bCheckSum = cs;
1633
1634        dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1635        for (pos = 0; pos < size; pos += done) {
1636                len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1637                status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1638                                                                &done, 1000);
1639                if (status)
1640                        break;
1641        }
1642        return status;
1643}
1644
1645static int ti_download_firmware(struct ti_device *tdev)
1646{
1647        int status;
1648        int buffer_size;
1649        u8 *buffer;
1650        struct usb_device *dev = tdev->td_serial->dev;
1651        unsigned int pipe = usb_sndbulkpipe(dev,
1652                tdev->td_serial->port[0]->bulk_out_endpointAddress);
1653        const struct firmware *fw_p;
1654        char buf[32];
1655
1656        if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1657                snprintf(buf,
1658                        sizeof(buf),
1659                        "moxa/moxa-%04x.fw",
1660                        le16_to_cpu(dev->descriptor.idProduct));
1661
1662                status = request_firmware(&fw_p, buf, &dev->dev);
1663                goto check_firmware;
1664        }
1665
1666        /* try ID specific firmware first, then try generic firmware */
1667        sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1668                        le16_to_cpu(dev->descriptor.idVendor),
1669                        le16_to_cpu(dev->descriptor.idProduct));
1670        status = request_firmware(&fw_p, buf, &dev->dev);
1671
1672        if (status != 0) {
1673                buf[0] = '\0';
1674                if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1675                        switch (le16_to_cpu(dev->descriptor.idProduct)) {
1676                        case MTS_CDMA_PRODUCT_ID:
1677                                strcpy(buf, "mts_cdma.fw");
1678                                break;
1679                        case MTS_GSM_PRODUCT_ID:
1680                                strcpy(buf, "mts_gsm.fw");
1681                                break;
1682                        case MTS_EDGE_PRODUCT_ID:
1683                                strcpy(buf, "mts_edge.fw");
1684                                break;
1685                        case MTS_MT9234MU_PRODUCT_ID:
1686                                strcpy(buf, "mts_mt9234mu.fw");
1687                                break;
1688                        case MTS_MT9234ZBA_PRODUCT_ID:
1689                                strcpy(buf, "mts_mt9234zba.fw");
1690                                break;
1691                        case MTS_MT9234ZBAOLD_PRODUCT_ID:
1692                                strcpy(buf, "mts_mt9234zba.fw");
1693                                break;                  }
1694                }
1695                if (buf[0] == '\0') {
1696                        if (tdev->td_is_3410)
1697                                strcpy(buf, "ti_3410.fw");
1698                        else
1699                                strcpy(buf, "ti_5052.fw");
1700                }
1701                status = request_firmware(&fw_p, buf, &dev->dev);
1702        }
1703
1704check_firmware:
1705        if (status) {
1706                dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1707                return -ENOENT;
1708        }
1709        if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1710                dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1711                release_firmware(fw_p);
1712                return -ENOENT;
1713        }
1714
1715        buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1716        buffer = kmalloc(buffer_size, GFP_KERNEL);
1717        if (buffer) {
1718                memcpy(buffer, fw_p->data, fw_p->size);
1719                memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1720                status = ti_do_download(dev, pipe, buffer, fw_p->size);
1721                kfree(buffer);
1722        } else {
1723                status = -ENOMEM;
1724        }
1725        release_firmware(fw_p);
1726        if (status) {
1727                dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1728                                                        __func__, status);
1729                return status;
1730        }
1731
1732        dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1733
1734        return 0;
1735}
1736