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