drivers/usb/serial/ti_usb_3410_5052.c

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