drivers/usb/serial/ti_usb_3410_5052.c

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