drivers/usb/serial/f81534.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * F81532/F81534 USB to Serial Ports Bridge
   4  *
   5  * F81532 => 2 Serial Ports
   6  * F81534 => 4 Serial Ports
   7  *
   8  * Copyright (C) 2016 Feature Integration Technology Inc., (Fintek)
   9  * Copyright (C) 2016 Tom Tsai (Tom_Tsai@fintek.com.tw)
  10  * Copyright (C) 2016 Peter Hong (Peter_Hong@fintek.com.tw)
  11  *
  12  * The F81532/F81534 had 1 control endpoint for setting, 1 endpoint bulk-out
  13  * for all serial port TX and 1 endpoint bulk-in for all serial port read in
  14  * (Read Data/MSR/LSR).
  15  *
  16  * Write URB is fixed with 512bytes, per serial port used 128Bytes.
  17  * It can be described by f81534_prepare_write_buffer()
  18  *
  19  * Read URB is 512Bytes max, per serial port used 128Bytes.
  20  * It can be described by f81534_process_read_urb() and maybe received with
  21  * 128x1,2,3,4 bytes.
  22  *
  23  */
  24 #include <linux/slab.h>
  25 #include <linux/tty.h>
  26 #include <linux/tty_flip.h>
  27 #include <linux/usb.h>
  28 #include <linux/usb/serial.h>
  29 #include <linux/serial_reg.h>
  30 #include <linux/module.h>
  31 #include <linux/uaccess.h>
  32
  33 /* Serial Port register Address */
  34 #define F81534_UART_BASE_ADDRESS        0x1200
  35 #define F81534_UART_OFFSET              0x10
  36 #define F81534_DIVISOR_LSB_REG          (0x00 + F81534_UART_BASE_ADDRESS)
  37 #define F81534_DIVISOR_MSB_REG          (0x01 + F81534_UART_BASE_ADDRESS)
  38 #define F81534_INTERRUPT_ENABLE_REG     (0x01 + F81534_UART_BASE_ADDRESS)
  39 #define F81534_FIFO_CONTROL_REG         (0x02 + F81534_UART_BASE_ADDRESS)
  40 #define F81534_LINE_CONTROL_REG         (0x03 + F81534_UART_BASE_ADDRESS)
  41 #define F81534_MODEM_CONTROL_REG        (0x04 + F81534_UART_BASE_ADDRESS)
  42 #define F81534_LINE_STATUS_REG          (0x05 + F81534_UART_BASE_ADDRESS)
  43 #define F81534_MODEM_STATUS_REG         (0x06 + F81534_UART_BASE_ADDRESS)
  44 #define F81534_CLOCK_REG                (0x08 + F81534_UART_BASE_ADDRESS)
  45 #define F81534_CONFIG1_REG              (0x09 + F81534_UART_BASE_ADDRESS)
  46
  47 #define F81534_DEF_CONF_ADDRESS_START   0x3000
  48 #define F81534_DEF_CONF_SIZE            12
  49
  50 #define F81534_CUSTOM_ADDRESS_START     0x2f00
  51 #define F81534_CUSTOM_DATA_SIZE         0x10
  52 #define F81534_CUSTOM_NO_CUSTOM_DATA    0xff
  53 #define F81534_CUSTOM_VALID_TOKEN       0xf0
  54 #define F81534_CONF_OFFSET              1
  55 #define F81534_CONF_INIT_GPIO_OFFSET    4
  56 #define F81534_CONF_WORK_GPIO_OFFSET    8
  57 #define F81534_CONF_GPIO_SHUTDOWN       7
  58 #define F81534_CONF_GPIO_RS232          1
  59
  60 #define F81534_MAX_DATA_BLOCK           64
  61 #define F81534_MAX_BUS_RETRY            20
  62
  63 /* Default URB timeout for USB operations */
  64 #define F81534_USB_MAX_RETRY            10
  65 #define F81534_USB_TIMEOUT              2000
  66 #define F81534_SET_GET_REGISTER         0xA0
  67
  68 #define F81534_NUM_PORT                 4
  69 #define F81534_UNUSED_PORT              0xff
  70 #define F81534_WRITE_BUFFER_SIZE        512
  71
  72 #define DRIVER_DESC                     "Fintek F81532/F81534"
  73 #define FINTEK_VENDOR_ID_1              0x1934
  74 #define FINTEK_VENDOR_ID_2              0x2C42
  75 #define FINTEK_DEVICE_ID                0x1202
  76 #define F81534_MAX_TX_SIZE              124
  77 #define F81534_MAX_RX_SIZE              124
  78 #define F81534_RECEIVE_BLOCK_SIZE       128
  79 #define F81534_MAX_RECEIVE_BLOCK_SIZE   512
  80
  81 #define F81534_TOKEN_RECEIVE            0x01
  82 #define F81534_TOKEN_WRITE              0x02
  83 #define F81534_TOKEN_TX_EMPTY           0x03
  84 #define F81534_TOKEN_MSR_CHANGE         0x04
  85
  86 /*
  87  * We used interal SPI bus to access FLASH section. We must wait the SPI bus to
  88  * idle if we performed any command.
  89  *
  90  * SPI Bus status register: F81534_BUS_REG_STATUS
  91  *      Bit 0/1 : BUSY
  92  *      Bit 2   : IDLE
  93  */
  94 #define F81534_BUS_BUSY                 (BIT(0) | BIT(1))
  95 #define F81534_BUS_IDLE                 BIT(2)
  96 #define F81534_BUS_READ_DATA            0x1004
  97 #define F81534_BUS_REG_STATUS           0x1003
  98 #define F81534_BUS_REG_START            0x1002
  99 #define F81534_BUS_REG_END              0x1001
 100
 101 #define F81534_CMD_READ                 0x03
 102
 103 #define F81534_DEFAULT_BAUD_RATE        9600
 104
 105 #define F81534_PORT_CONF_RS232          0
 106 #define F81534_PORT_CONF_RS485          BIT(0)
 107 #define F81534_PORT_CONF_RS485_INVERT   (BIT(0) | BIT(1))
 108 #define F81534_PORT_CONF_MODE_MASK      GENMASK(1, 0)
 109 #define F81534_PORT_CONF_DISABLE_PORT   BIT(3)
 110 #define F81534_PORT_CONF_NOT_EXIST_PORT BIT(7)
 111 #define F81534_PORT_UNAVAILABLE         \
 112         (F81534_PORT_CONF_DISABLE_PORT | F81534_PORT_CONF_NOT_EXIST_PORT)
 113
 114
 115 #define F81534_1X_RXTRIGGER             0xc3
 116 #define F81534_8X_RXTRIGGER             0xcf
 117
 118 /*
 119  * F81532/534 Clock registers (offset +08h)
 120  *
 121  * Bit0:        UART Enable (always on)
 122  * Bit2-1:      Clock source selector
 123  *                      00: 1.846MHz.
 124  *                      01: 18.46MHz.
 125  *                      10: 24MHz.
 126  *                      11: 14.77MHz.
 127  * Bit4:        Auto direction(RTS) control (RTS pin Low when TX)
 128  * Bit5:        Invert direction(RTS) when Bit4 enabled (RTS pin high when TX)
 129  */
 130
 131 #define F81534_UART_EN                  BIT(0)
 132 #define F81534_CLK_1_846_MHZ            0
 133 #define F81534_CLK_18_46_MHZ            BIT(1)
 134 #define F81534_CLK_24_MHZ               BIT(2)
 135 #define F81534_CLK_14_77_MHZ            (BIT(1) | BIT(2))
 136 #define F81534_CLK_MASK                 GENMASK(2, 1)
 137 #define F81534_CLK_TX_DELAY_1BIT        BIT(3)
 138 #define F81534_CLK_RS485_MODE           BIT(4)
 139 #define F81534_CLK_RS485_INVERT         BIT(5)
 140
 141 static const struct usb_device_id f81534_id_table[] = {
 142         { USB_DEVICE(FINTEK_VENDOR_ID_1, FINTEK_DEVICE_ID) },
 143         { USB_DEVICE(FINTEK_VENDOR_ID_2, FINTEK_DEVICE_ID) },
 144         {}                      /* Terminating entry */
 145 };
 146
 147 #define F81534_TX_EMPTY_BIT             0
 148
 149 struct f81534_serial_private {
 150         u8 conf_data[F81534_DEF_CONF_SIZE];
 151         int tty_idx[F81534_NUM_PORT];
 152         u8 setting_idx;
 153         int opened_port;
 154         struct mutex urb_mutex;
 155 };
 156
 157 struct f81534_port_private {
 158         struct mutex mcr_mutex;
 159         struct mutex lcr_mutex;
 160         struct work_struct lsr_work;
 161         struct usb_serial_port *port;
 162         unsigned long tx_empty;
 163         spinlock_t msr_lock;
 164         u32 baud_base;
 165         u8 shadow_mcr;
 166         u8 shadow_lcr;
 167         u8 shadow_msr;
 168         u8 shadow_clk;
 169         u8 phy_num;
 170 };
 171
 172 struct f81534_pin_data {
 173         const u16 reg_addr;
 174         const u8 reg_mask;
 175 };
 176
 177 struct f81534_port_out_pin {
 178         struct f81534_pin_data pin[3];
 179 };
 180
 181 /* Pin output value for M2/M1/M0(SD) */
 182 static const struct f81534_port_out_pin f81534_port_out_pins[] = {
 183          { { { 0x2ae8, BIT(7) }, { 0x2a90, BIT(5) }, { 0x2a90, BIT(4) } } },
 184          { { { 0x2ae8, BIT(6) }, { 0x2ae8, BIT(0) }, { 0x2ae8, BIT(3) } } },
 185          { { { 0x2a90, BIT(0) }, { 0x2ae8, BIT(2) }, { 0x2a80, BIT(6) } } },
 186          { { { 0x2a90, BIT(3) }, { 0x2a90, BIT(2) }, { 0x2a90, BIT(1) } } },
 187 };
 188
 189 static u32 const baudrate_table[] = { 115200, 921600, 1152000, 1500000 };
 190 static u8 const clock_table[] = { F81534_CLK_1_846_MHZ, F81534_CLK_14_77_MHZ,
 191                                 F81534_CLK_18_46_MHZ, F81534_CLK_24_MHZ };
 192
 193 static int f81534_logic_to_phy_port(struct usb_serial *serial,
 194                                         struct usb_serial_port *port)
 195 {
 196         struct f81534_serial_private *serial_priv =
 197                         usb_get_serial_data(port->serial);
 198         int count = 0;
 199         int i;
 200
 201         for (i = 0; i < F81534_NUM_PORT; ++i) {
 202                 if (serial_priv->conf_data[i] & F81534_PORT_UNAVAILABLE)
 203                         continue;
 204
 205                 if (port->port_number == count)
 206                         return i;
 207
 208                 ++count;
 209         }
 210
 211         return -ENODEV;
 212 }
 213
 214 static int f81534_set_register(struct usb_serial *serial, u16 reg, u8 data)
 215 {
 216         struct usb_interface *interface = serial->interface;
 217         struct usb_device *dev = serial->dev;
 218         size_t count = F81534_USB_MAX_RETRY;
 219         int status;
 220         u8 *tmp;
 221
 222         tmp = kmalloc(sizeof(u8), GFP_KERNEL);
 223         if (!tmp)
 224                 return -ENOMEM;
 225
 226         *tmp = data;
 227
 228         /*
 229          * Our device maybe not reply when heavily loading, We'll retry for
 230          * F81534_USB_MAX_RETRY times.
 231          */
 232         while (count--) {
 233                 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 234                                          F81534_SET_GET_REGISTER,
 235                                          USB_TYPE_VENDOR | USB_DIR_OUT,
 236                                          reg, 0, tmp, sizeof(u8),
 237                                          F81534_USB_TIMEOUT);
 238                 if (status > 0) {
 239                         status = 0;
 240                         break;
 241                 } else if (status == 0) {
 242                         status = -EIO;
 243                 }
 244         }
 245
 246         if (status < 0) {
 247                 dev_err(&interface->dev, "%s: reg: %x data: %x failed: %d\n",
 248                                 __func__, reg, data, status);
 249         }
 250
 251         kfree(tmp);
 252         return status;
 253 }
 254
 255 static int f81534_get_register(struct usb_serial *serial, u16 reg, u8 *data)
 256 {
 257         struct usb_interface *interface = serial->interface;
 258         struct usb_device *dev = serial->dev;
 259         size_t count = F81534_USB_MAX_RETRY;
 260         int status;
 261         u8 *tmp;
 262
 263         tmp = kmalloc(sizeof(u8), GFP_KERNEL);
 264         if (!tmp)
 265                 return -ENOMEM;
 266
 267         /*
 268          * Our device maybe not reply when heavily loading, We'll retry for
 269          * F81534_USB_MAX_RETRY times.
 270          */
 271         while (count--) {
 272                 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 273                                          F81534_SET_GET_REGISTER,
 274                                          USB_TYPE_VENDOR | USB_DIR_IN,
 275                                          reg, 0, tmp, sizeof(u8),
 276                                          F81534_USB_TIMEOUT);
 277                 if (status > 0) {
 278                         status = 0;
 279                         break;
 280                 } else if (status == 0) {
 281                         status = -EIO;
 282                 }
 283         }
 284
 285         if (status < 0) {
 286                 dev_err(&interface->dev, "%s: reg: %x failed: %d\n", __func__,
 287                                 reg, status);
 288                 goto end;
 289         }
 290
 291         *data = *tmp;
 292
 293 end:
 294         kfree(tmp);
 295         return status;
 296 }
 297
 298 static int f81534_set_mask_register(struct usb_serial *serial, u16 reg,
 299                                         u8 mask, u8 data)
 300 {
 301         int status;
 302         u8 tmp;
 303
 304         status = f81534_get_register(serial, reg, &tmp);
 305         if (status)
 306                 return status;
 307
 308         tmp &= ~mask;
 309         tmp |= (mask & data);
 310
 311         return f81534_set_register(serial, reg, tmp);
 312 }
 313
 314 static int f81534_set_phy_port_register(struct usb_serial *serial, int phy,
 315                                         u16 reg, u8 data)
 316 {
 317         return f81534_set_register(serial, reg + F81534_UART_OFFSET * phy,
 318                                         data);
 319 }
 320
 321 static int f81534_get_phy_port_register(struct usb_serial *serial, int phy,
 322                                         u16 reg, u8 *data)
 323 {
 324         return f81534_get_register(serial, reg + F81534_UART_OFFSET * phy,
 325                                         data);
 326 }
 327
 328 static int f81534_set_port_register(struct usb_serial_port *port, u16 reg,
 329                                         u8 data)
 330 {
 331         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 332
 333         return f81534_set_register(port->serial,
 334                         reg + port_priv->phy_num * F81534_UART_OFFSET, data);
 335 }
 336
 337 static int f81534_get_port_register(struct usb_serial_port *port, u16 reg,
 338                                         u8 *data)
 339 {
 340         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 341
 342         return f81534_get_register(port->serial,
 343                         reg + port_priv->phy_num * F81534_UART_OFFSET, data);
 344 }
 345
 346 /*
 347  * If we try to access the internal flash via SPI bus, we should check the bus
 348  * status for every command. e.g., F81534_BUS_REG_START/F81534_BUS_REG_END
 349  */
 350 static int f81534_wait_for_spi_idle(struct usb_serial *serial)
 351 {
 352         size_t count = F81534_MAX_BUS_RETRY;
 353         u8 tmp;
 354         int status;
 355
 356         do {
 357                 status = f81534_get_register(serial, F81534_BUS_REG_STATUS,
 358                                                 &tmp);
 359                 if (status)
 360                         return status;
 361
 362                 if (tmp & F81534_BUS_BUSY)
 363                         continue;
 364
 365                 if (tmp & F81534_BUS_IDLE)
 366                         break;
 367
 368         } while (--count);
 369
 370         if (!count) {
 371                 dev_err(&serial->interface->dev,
 372                                 "%s: timed out waiting for idle SPI bus\n",
 373                                 __func__);
 374                 return -EIO;
 375         }
 376
 377         return f81534_set_register(serial, F81534_BUS_REG_STATUS,
 378                                 tmp & ~F81534_BUS_IDLE);
 379 }
 380
 381 static int f81534_get_spi_register(struct usb_serial *serial, u16 reg,
 382                                         u8 *data)
 383 {
 384         int status;
 385
 386         status = f81534_get_register(serial, reg, data);
 387         if (status)
 388                 return status;
 389
 390         return f81534_wait_for_spi_idle(serial);
 391 }
 392
 393 static int f81534_set_spi_register(struct usb_serial *serial, u16 reg, u8 data)
 394 {
 395         int status;
 396
 397         status = f81534_set_register(serial, reg, data);
 398         if (status)
 399                 return status;
 400
 401         return f81534_wait_for_spi_idle(serial);
 402 }
 403
 404 static int f81534_read_flash(struct usb_serial *serial, u32 address,
 405                                 size_t size, u8 *buf)
 406 {
 407         u8 tmp_buf[F81534_MAX_DATA_BLOCK];
 408         size_t block = 0;
 409         size_t read_size;
 410         size_t count;
 411         int status;
 412         int offset;
 413         u16 reg_tmp;
 414
 415         status = f81534_set_spi_register(serial, F81534_BUS_REG_START,
 416                                         F81534_CMD_READ);
 417         if (status)
 418                 return status;
 419
 420         status = f81534_set_spi_register(serial, F81534_BUS_REG_START,
 421                                         (address >> 16) & 0xff);
 422         if (status)
 423                 return status;
 424
 425         status = f81534_set_spi_register(serial, F81534_BUS_REG_START,
 426                                         (address >> 8) & 0xff);
 427         if (status)
 428                 return status;
 429
 430         status = f81534_set_spi_register(serial, F81534_BUS_REG_START,
 431                                         (address >> 0) & 0xff);
 432         if (status)
 433                 return status;
 434
 435         /* Continuous read mode */
 436         do {
 437                 read_size = min_t(size_t, F81534_MAX_DATA_BLOCK, size);
 438
 439                 for (count = 0; count < read_size; ++count) {
 440                         /* To write F81534_BUS_REG_END when final byte */
 441                         if (size <= F81534_MAX_DATA_BLOCK &&
 442                                         read_size == count + 1)
 443                                 reg_tmp = F81534_BUS_REG_END;
 444                         else
 445                                 reg_tmp = F81534_BUS_REG_START;
 446
 447                         /*
 448                          * Dummy code, force IC to generate a read pulse, the
 449                          * set of value 0xf1 is dont care (any value is ok)
 450                          */
 451                         status = f81534_set_spi_register(serial, reg_tmp,
 452                                         0xf1);
 453                         if (status)
 454                                 return status;
 455
 456                         status = f81534_get_spi_register(serial,
 457                                                 F81534_BUS_READ_DATA,
 458                                                 &tmp_buf[count]);
 459                         if (status)
 460                                 return status;
 461
 462                         offset = count + block * F81534_MAX_DATA_BLOCK;
 463                         buf[offset] = tmp_buf[count];
 464                 }
 465
 466                 size -= read_size;
 467                 ++block;
 468         } while (size);
 469
 470         return 0;
 471 }
 472
 473 static void f81534_prepare_write_buffer(struct usb_serial_port *port, u8 *buf)
 474 {
 475         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 476         int phy_num = port_priv->phy_num;
 477         u8 tx_len;
 478         int i;
 479
 480         /*
 481          * The block layout is fixed with 4x128 Bytes, per 128 Bytes a port.
 482          * index 0: port phy idx (e.g., 0,1,2,3)
 483          * index 1: only F81534_TOKEN_WRITE
 484          * index 2: serial TX out length
 485          * index 3: fix to 0
 486          * index 4~127: serial out data block
 487          */
 488         for (i = 0; i < F81534_NUM_PORT; ++i) {
 489                 buf[i * F81534_RECEIVE_BLOCK_SIZE] = i;
 490                 buf[i * F81534_RECEIVE_BLOCK_SIZE + 1] = F81534_TOKEN_WRITE;
 491                 buf[i * F81534_RECEIVE_BLOCK_SIZE + 2] = 0;
 492                 buf[i * F81534_RECEIVE_BLOCK_SIZE + 3] = 0;
 493         }
 494
 495         tx_len = kfifo_out_locked(&port->write_fifo,
 496                                 &buf[phy_num * F81534_RECEIVE_BLOCK_SIZE + 4],
 497                                 F81534_MAX_TX_SIZE, &port->lock);
 498
 499         buf[phy_num * F81534_RECEIVE_BLOCK_SIZE + 2] = tx_len;
 500 }
 501
 502 static int f81534_submit_writer(struct usb_serial_port *port, gfp_t mem_flags)
 503 {
 504         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 505         struct urb *urb;
 506         unsigned long flags;
 507         int result;
 508
 509         /* Check is any data in write_fifo */
 510         spin_lock_irqsave(&port->lock, flags);
 511
 512         if (kfifo_is_empty(&port->write_fifo)) {
 513                 spin_unlock_irqrestore(&port->lock, flags);
 514                 return 0;
 515         }
 516
 517         spin_unlock_irqrestore(&port->lock, flags);
 518
 519         /* Check H/W is TXEMPTY */
 520         if (!test_and_clear_bit(F81534_TX_EMPTY_BIT, &port_priv->tx_empty))
 521                 return 0;
 522
 523         urb = port->write_urbs[0];
 524         f81534_prepare_write_buffer(port, port->bulk_out_buffers[0]);
 525         urb->transfer_buffer_length = F81534_WRITE_BUFFER_SIZE;
 526
 527         result = usb_submit_urb(urb, mem_flags);
 528         if (result) {
 529                 set_bit(F81534_TX_EMPTY_BIT, &port_priv->tx_empty);
 530                 dev_err(&port->dev, "%s: submit failed: %d\n", __func__,
 531                                 result);
 532                 return result;
 533         }
 534
 535         usb_serial_port_softint(port);
 536         return 0;
 537 }
 538
 539 static u32 f81534_calc_baud_divisor(u32 baudrate, u32 clockrate)
 540 {
 541         /* Round to nearest divisor */
 542         return DIV_ROUND_CLOSEST(clockrate, baudrate);
 543 }
 544
 545 static int f81534_find_clk(u32 baudrate)
 546 {
 547         int idx;
 548
 549         for (idx = 0; idx < ARRAY_SIZE(baudrate_table); ++idx) {
 550                 if (baudrate <= baudrate_table[idx] &&
 551                                 baudrate_table[idx] % baudrate == 0)
 552                         return idx;
 553         }
 554
 555         return -EINVAL;
 556 }
 557
 558 static int f81534_set_port_config(struct usb_serial_port *port,
 559                 struct tty_struct *tty, u32 baudrate, u32 old_baudrate, u8 lcr)
 560 {
 561         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 562         u32 divisor;
 563         int status;
 564         int i;
 565         int idx;
 566         u8 value;
 567         u32 baud_list[] = {baudrate, old_baudrate, F81534_DEFAULT_BAUD_RATE};
 568
 569         for (i = 0; i < ARRAY_SIZE(baud_list); ++i) {
 570                 baudrate = baud_list[i];
 571                 if (baudrate == 0) {
 572                         tty_encode_baud_rate(tty, 0, 0);
 573                         return 0;
 574                 }
 575
 576                 idx = f81534_find_clk(baudrate);
 577                 if (idx >= 0) {
 578                         tty_encode_baud_rate(tty, baudrate, baudrate);
 579                         break;
 580                 }
 581         }
 582
 583         if (idx < 0)
 584                 return -EINVAL;
 585
 586         port_priv->baud_base = baudrate_table[idx];
 587         port_priv->shadow_clk &= ~F81534_CLK_MASK;
 588         port_priv->shadow_clk |= clock_table[idx];
 589
 590         status = f81534_set_port_register(port, F81534_CLOCK_REG,
 591                         port_priv->shadow_clk);
 592         if (status) {
 593                 dev_err(&port->dev, "CLOCK_REG setting failed\n");
 594                 return status;
 595         }
 596
 597         if (baudrate <= 1200)
 598                 value = F81534_1X_RXTRIGGER;    /* 128 FIFO & TL: 1x */
 599         else
 600                 value = F81534_8X_RXTRIGGER;    /* 128 FIFO & TL: 8x */
 601
 602         status = f81534_set_port_register(port, F81534_CONFIG1_REG, value);
 603         if (status) {
 604                 dev_err(&port->dev, "%s: CONFIG1 setting failed\n", __func__);
 605                 return status;
 606         }
 607
 608         if (baudrate <= 1200)
 609                 value = UART_FCR_TRIGGER_1 | UART_FCR_ENABLE_FIFO; /* TL: 1 */
 610         else
 611                 value = UART_FCR_TRIGGER_8 | UART_FCR_ENABLE_FIFO; /* TL: 8 */
 612
 613         status = f81534_set_port_register(port, F81534_FIFO_CONTROL_REG,
 614                                                 value);
 615         if (status) {
 616                 dev_err(&port->dev, "%s: FCR setting failed\n", __func__);
 617                 return status;
 618         }
 619
 620         divisor = f81534_calc_baud_divisor(baudrate, port_priv->baud_base);
 621
 622         mutex_lock(&port_priv->lcr_mutex);
 623
 624         value = UART_LCR_DLAB;
 625         status = f81534_set_port_register(port, F81534_LINE_CONTROL_REG,
 626                                                 value);
 627         if (status) {
 628                 dev_err(&port->dev, "%s: set LCR failed\n", __func__);
 629                 goto out_unlock;
 630         }
 631
 632         value = divisor & 0xff;
 633         status = f81534_set_port_register(port, F81534_DIVISOR_LSB_REG, value);
 634         if (status) {
 635                 dev_err(&port->dev, "%s: set DLAB LSB failed\n", __func__);
 636                 goto out_unlock;
 637         }
 638
 639         value = (divisor >> 8) & 0xff;
 640         status = f81534_set_port_register(port, F81534_DIVISOR_MSB_REG, value);
 641         if (status) {
 642                 dev_err(&port->dev, "%s: set DLAB MSB failed\n", __func__);
 643                 goto out_unlock;
 644         }
 645
 646         value = lcr | (port_priv->shadow_lcr & UART_LCR_SBC);
 647         status = f81534_set_port_register(port, F81534_LINE_CONTROL_REG,
 648                                                 value);
 649         if (status) {
 650                 dev_err(&port->dev, "%s: set LCR failed\n", __func__);
 651                 goto out_unlock;
 652         }
 653
 654         port_priv->shadow_lcr = value;
 655 out_unlock:
 656         mutex_unlock(&port_priv->lcr_mutex);
 657
 658         return status;
 659 }
 660
 661 static void f81534_break_ctl(struct tty_struct *tty, int break_state)
 662 {
 663         struct usb_serial_port *port = tty->driver_data;
 664         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 665         int status;
 666
 667         mutex_lock(&port_priv->lcr_mutex);
 668
 669         if (break_state)
 670                 port_priv->shadow_lcr |= UART_LCR_SBC;
 671         else
 672                 port_priv->shadow_lcr &= ~UART_LCR_SBC;
 673
 674         status = f81534_set_port_register(port, F81534_LINE_CONTROL_REG,
 675                                         port_priv->shadow_lcr);
 676         if (status)
 677                 dev_err(&port->dev, "set break failed: %d\n", status);
 678
 679         mutex_unlock(&port_priv->lcr_mutex);
 680 }
 681
 682 static int f81534_update_mctrl(struct usb_serial_port *port, unsigned int set,
 683                                 unsigned int clear)
 684 {
 685         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
 686         int status;
 687         u8 tmp;
 688
 689         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0)
 690                 return 0;       /* no change */
 691
 692         mutex_lock(&port_priv->mcr_mutex);
 693
 694         /* 'Set' takes precedence over 'Clear' */
 695         clear &= ~set;
 696
 697         /* Always enable UART_MCR_OUT2 */
 698         tmp = UART_MCR_OUT2 | port_priv->shadow_mcr;
 699
 700         if (clear & TIOCM_DTR)
 701                 tmp &= ~UART_MCR_DTR;
 702
 703         if (clear & TIOCM_RTS)
 704                 tmp &= ~UART_MCR_RTS;
 705
 706         if (set & TIOCM_DTR)
 707                 tmp |= UART_MCR_DTR;
 708
 709         if (set & TIOCM_RTS)
 710                 tmp |= UART_MCR_RTS;
 711
 712         status = f81534_set_port_register(port, F81534_MODEM_CONTROL_REG, tmp);
 713         if (status < 0) {
 714                 dev_err(&port->dev, "%s: MCR write failed\n", __func__);
 715                 mutex_unlock(&port_priv->mcr_mutex);
 716                 return status;
 717         }
 718
 719         port_priv->shadow_mcr = tmp;
 720         mutex_unlock(&port_priv->mcr_mutex);
 721         return 0;
 722 }
 723
 724 /*
 725  * This function will search the data area with token F81534_CUSTOM_VALID_TOKEN
 726  * for latest configuration index. If nothing found
 727  * (*index = F81534_CUSTOM_NO_CUSTOM_DATA), We'll load default configure in
 728  * F81534_DEF_CONF_ADDRESS_START section.
 729  *
 730  * Due to we only use block0 to save data, so *index should be 0 or
 731  * F81534_CUSTOM_NO_CUSTOM_DATA.
 732  */
 733 static int f81534_find_config_idx(struct usb_serial *serial, u8 *index)
 734 {
 735         u8 tmp;
 736         int status;
 737
 738         status = f81534_read_flash(serial, F81534_CUSTOM_ADDRESS_START, 1,
 739                                         &tmp);
 740         if (status) {
 741                 dev_err(&serial->interface->dev, "%s: read failed: %d\n",
 742                                 __func__, status);
 743                 return status;
 744         }
 745
 746         /* We'll use the custom data when the data is valid. */
 747         if (tmp == F81534_CUSTOM_VALID_TOKEN)
 748                 *index = 0;
 749         else
 750                 *index = F81534_CUSTOM_NO_CUSTOM_DATA;
 751
 752         return 0;
 753 }
 754
 755 /*
 756  * The F81532/534 will not report serial port to USB serial subsystem when
 757  * H/W DCD/DSR/CTS/RI/RX pin connected to ground.
 758  *
 759  * To detect RX pin status, we'll enable MCR interal loopback, disable it and
 760  * delayed for 60ms. It connected to ground If LSR register report UART_LSR_BI.
 761  */
 762 static bool f81534_check_port_hw_disabled(struct usb_serial *serial, int phy)
 763 {
 764         int status;
 765         u8 old_mcr;
 766         u8 msr;
 767         u8 lsr;
 768         u8 msr_mask;
 769
 770         msr_mask = UART_MSR_DCD | UART_MSR_RI | UART_MSR_DSR | UART_MSR_CTS;
 771
 772         status = f81534_get_phy_port_register(serial, phy,
 773                                 F81534_MODEM_STATUS_REG, &msr);
 774         if (status)
 775                 return false;
 776
 777         if ((msr & msr_mask) != msr_mask)
 778                 return false;
 779
 780         status = f81534_set_phy_port_register(serial, phy,
 781                                 F81534_FIFO_CONTROL_REG, UART_FCR_ENABLE_FIFO |
 782                                 UART_FCR_CLEAR_RCVR | UART_FCR_CLEAR_XMIT);
 783         if (status)
 784                 return false;
 785
 786         status = f81534_get_phy_port_register(serial, phy,
 787                                 F81534_MODEM_CONTROL_REG, &old_mcr);
 788         if (status)
 789                 return false;
 790
 791         status = f81534_set_phy_port_register(serial, phy,
 792                                 F81534_MODEM_CONTROL_REG, UART_MCR_LOOP);
 793         if (status)
 794                 return false;
 795
 796         status = f81534_set_phy_port_register(serial, phy,
 797                                 F81534_MODEM_CONTROL_REG, 0x0);
 798         if (status)
 799                 return false;
 800
 801         msleep(60);
 802
 803         status = f81534_get_phy_port_register(serial, phy,
 804                                 F81534_LINE_STATUS_REG, &lsr);
 805         if (status)
 806                 return false;
 807
 808         status = f81534_set_phy_port_register(serial, phy,
 809                                 F81534_MODEM_CONTROL_REG, old_mcr);
 810         if (status)
 811                 return false;
 812
 813         if ((lsr & UART_LSR_BI) == UART_LSR_BI)
 814                 return true;
 815
 816         return false;
 817 }
 818
 819 /*
 820  * We had 2 generation of F81532/534 IC. All has an internal storage.
 821  *
 822  * 1st is pure USB-to-TTL RS232 IC and designed for 4 ports only, no any
 823  * internal data will used. All mode and gpio control should manually set
 824  * by AP or Driver and all storage space value are 0xff. The
 825  * f81534_calc_num_ports() will run to final we marked as "oldest version"
 826  * for this IC.
 827  *
 828  * 2rd is designed to more generic to use any transceiver and this is our
 829  * mass production type. We'll save data in F81534_CUSTOM_ADDRESS_START
 830  * (0x2f00) with 9bytes. The 1st byte is a indicater. If the token is
 831  * F81534_CUSTOM_VALID_TOKEN(0xf0), the IC is 2nd gen type, the following
 832  * 4bytes save port mode (0:RS232/1:RS485 Invert/2:RS485), and the last
 833  * 4bytes save GPIO state(value from 0~7 to represent 3 GPIO output pin).
 834  * The f81534_calc_num_ports() will run to "new style" with checking
 835  * F81534_PORT_UNAVAILABLE section.
 836  */
 837 static int f81534_calc_num_ports(struct usb_serial *serial,
 838                                         struct usb_serial_endpoints *epds)
 839 {
 840         struct f81534_serial_private *serial_priv;
 841         struct device *dev = &serial->interface->dev;
 842         int size_bulk_in = usb_endpoint_maxp(epds->bulk_in[0]);
 843         int size_bulk_out = usb_endpoint_maxp(epds->bulk_out[0]);
 844         u8 num_port = 0;
 845         int index = 0;
 846         int status;
 847         int i;
 848
 849         if (size_bulk_out != F81534_WRITE_BUFFER_SIZE ||
 850                         size_bulk_in != F81534_MAX_RECEIVE_BLOCK_SIZE) {
 851                 dev_err(dev, "unsupported endpoint max packet size\n");
 852                 return -ENODEV;
 853         }
 854
 855         serial_priv = devm_kzalloc(&serial->interface->dev,
 856                                         sizeof(*serial_priv), GFP_KERNEL);
 857         if (!serial_priv)
 858                 return -ENOMEM;
 859
 860         usb_set_serial_data(serial, serial_priv);
 861         mutex_init(&serial_priv->urb_mutex);
 862
 863         /* Check had custom setting */
 864         status = f81534_find_config_idx(serial, &serial_priv->setting_idx);
 865         if (status) {
 866                 dev_err(&serial->interface->dev, "%s: find idx failed: %d\n",
 867                                 __func__, status);
 868                 return status;
 869         }
 870
 871         /*
 872          * We'll read custom data only when data available, otherwise we'll
 873          * read default value instead.
 874          */
 875         if (serial_priv->setting_idx != F81534_CUSTOM_NO_CUSTOM_DATA) {
 876                 status = f81534_read_flash(serial,
 877                                                 F81534_CUSTOM_ADDRESS_START +
 878                                                 F81534_CONF_OFFSET,
 879                                                 sizeof(serial_priv->conf_data),
 880                                                 serial_priv->conf_data);
 881                 if (status) {
 882                         dev_err(&serial->interface->dev,
 883                                         "%s: get custom data failed: %d\n",
 884                                         __func__, status);
 885                         return status;
 886                 }
 887
 888                 dev_dbg(&serial->interface->dev,
 889                                 "%s: read config from block: %d\n", __func__,
 890                                 serial_priv->setting_idx);
 891         } else {
 892                 /* Read default board setting */
 893                 status = f81534_read_flash(serial,
 894                                 F81534_DEF_CONF_ADDRESS_START,
 895                                 sizeof(serial_priv->conf_data),
 896                                 serial_priv->conf_data);
 897                 if (status) {
 898                         dev_err(&serial->interface->dev,
 899                                         "%s: read failed: %d\n", __func__,
 900                                         status);
 901                         return status;
 902                 }
 903
 904                 dev_dbg(&serial->interface->dev, "%s: read default config\n",
 905                                 __func__);
 906         }
 907
 908         /* New style, find all possible ports */
 909         for (i = 0; i < F81534_NUM_PORT; ++i) {
 910                 if (f81534_check_port_hw_disabled(serial, i))
 911                         serial_priv->conf_data[i] |= F81534_PORT_UNAVAILABLE;
 912
 913                 if (serial_priv->conf_data[i] & F81534_PORT_UNAVAILABLE)
 914                         continue;
 915
 916                 ++num_port;
 917         }
 918
 919         if (!num_port) {
 920                 dev_warn(&serial->interface->dev,
 921                         "no config found, assuming 4 ports\n");
 922                 num_port = 4;           /* Nothing found, oldest version IC */
 923         }
 924
 925         /* Assign phy-to-logic mapping */
 926         for (i = 0; i < F81534_NUM_PORT; ++i) {
 927                 if (serial_priv->conf_data[i] & F81534_PORT_UNAVAILABLE)
 928                         continue;
 929
 930                 serial_priv->tty_idx[i] = index++;
 931                 dev_dbg(&serial->interface->dev,
 932                                 "%s: phy_num: %d, tty_idx: %d\n", __func__, i,
 933                                 serial_priv->tty_idx[i]);
 934         }
 935
 936         /*
 937          * Setup bulk-out endpoint multiplexing. All ports share the same
 938          * bulk-out endpoint.
 939          */
 940         BUILD_BUG_ON(ARRAY_SIZE(epds->bulk_out) < F81534_NUM_PORT);
 941
 942         for (i = 1; i < num_port; ++i)
 943                 epds->bulk_out[i] = epds->bulk_out[0];
 944
 945         epds->num_bulk_out = num_port;
 946
 947         return num_port;
 948 }
 949
 950 static void f81534_set_termios(struct tty_struct *tty,
 951                                 struct usb_serial_port *port,
 952                                 struct ktermios *old_termios)
 953 {
 954         u8 new_lcr = 0;
 955         int status;
 956         u32 baud;
 957         u32 old_baud;
 958
 959         if (C_BAUD(tty) == B0)
 960                 f81534_update_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
 961         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 962                 f81534_update_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
 963
 964         if (C_PARENB(tty)) {
 965                 new_lcr |= UART_LCR_PARITY;
 966
 967                 if (!C_PARODD(tty))
 968                         new_lcr |= UART_LCR_EPAR;
 969
 970                 if (C_CMSPAR(tty))
 971                         new_lcr |= UART_LCR_SPAR;
 972         }
 973
 974         if (C_CSTOPB(tty))
 975                 new_lcr |= UART_LCR_STOP;
 976
 977         switch (C_CSIZE(tty)) {
 978         case CS5:
 979                 new_lcr |= UART_LCR_WLEN5;
 980                 break;
 981         case CS6:
 982                 new_lcr |= UART_LCR_WLEN6;
 983                 break;
 984         case CS7:
 985                 new_lcr |= UART_LCR_WLEN7;
 986                 break;
 987         default:
 988         case CS8:
 989                 new_lcr |= UART_LCR_WLEN8;
 990                 break;
 991         }
 992
 993         baud = tty_get_baud_rate(tty);
 994         if (!baud)
 995                 return;
 996
 997         if (old_termios)
 998                 old_baud = tty_termios_baud_rate(old_termios);
 999         else
1000                 old_baud = F81534_DEFAULT_BAUD_RATE;
1001
1002         dev_dbg(&port->dev, "%s: baud: %d\n", __func__, baud);
1003
1004         status = f81534_set_port_config(port, tty, baud, old_baud, new_lcr);
1005         if (status < 0) {
1006                 dev_err(&port->dev, "%s: set port config failed: %d\n",
1007                                 __func__, status);
1008         }
1009 }
1010
1011 static int f81534_submit_read_urb(struct usb_serial *serial, gfp_t flags)
1012 {
1013         return usb_serial_generic_submit_read_urbs(serial->port[0], flags);
1014 }
1015
1016 static void f81534_msr_changed(struct usb_serial_port *port, u8 msr)
1017 {
1018         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1019         struct tty_struct *tty;
1020         unsigned long flags;
1021         u8 old_msr;
1022
1023         if (!(msr & UART_MSR_ANY_DELTA))
1024                 return;
1025
1026         spin_lock_irqsave(&port_priv->msr_lock, flags);
1027         old_msr = port_priv->shadow_msr;
1028         port_priv->shadow_msr = msr;
1029         spin_unlock_irqrestore(&port_priv->msr_lock, flags);
1030
1031         dev_dbg(&port->dev, "%s: MSR from %02x to %02x\n", __func__, old_msr,
1032                         msr);
1033
1034         /* Update input line counters */
1035         if (msr & UART_MSR_DCTS)
1036                 port->icount.cts++;
1037         if (msr & UART_MSR_DDSR)
1038                 port->icount.dsr++;
1039         if (msr & UART_MSR_DDCD)
1040                 port->icount.dcd++;
1041         if (msr & UART_MSR_TERI)
1042                 port->icount.rng++;
1043
1044         wake_up_interruptible(&port->port.delta_msr_wait);
1045
1046         if (!(msr & UART_MSR_DDCD))
1047                 return;
1048
1049         dev_dbg(&port->dev, "%s: DCD Changed: phy_num: %d from %x to %x\n",
1050                         __func__, port_priv->phy_num, old_msr, msr);
1051
1052         tty = tty_port_tty_get(&port->port);
1053         if (!tty)
1054                 return;
1055
1056         usb_serial_handle_dcd_change(port, tty, msr & UART_MSR_DCD);
1057         tty_kref_put(tty);
1058 }
1059
1060 static int f81534_read_msr(struct usb_serial_port *port)
1061 {
1062         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1063         unsigned long flags;
1064         int status;
1065         u8 msr;
1066
1067         /* Get MSR initial value */
1068         status = f81534_get_port_register(port, F81534_MODEM_STATUS_REG, &msr);
1069         if (status)
1070                 return status;
1071
1072         /* Force update current state */
1073         spin_lock_irqsave(&port_priv->msr_lock, flags);
1074         port_priv->shadow_msr = msr;
1075         spin_unlock_irqrestore(&port_priv->msr_lock, flags);
1076
1077         return 0;
1078 }
1079
1080 static int f81534_open(struct tty_struct *tty, struct usb_serial_port *port)
1081 {
1082         struct f81534_serial_private *serial_priv =
1083                         usb_get_serial_data(port->serial);
1084         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1085         int status;
1086
1087         status = f81534_set_port_register(port,
1088                                 F81534_FIFO_CONTROL_REG, UART_FCR_ENABLE_FIFO |
1089                                 UART_FCR_CLEAR_RCVR | UART_FCR_CLEAR_XMIT);
1090         if (status) {
1091                 dev_err(&port->dev, "%s: Clear FIFO failed: %d\n", __func__,
1092                                 status);
1093                 return status;
1094         }
1095
1096         if (tty)
1097                 f81534_set_termios(tty, port, NULL);
1098
1099         status = f81534_read_msr(port);
1100         if (status)
1101                 return status;
1102
1103         mutex_lock(&serial_priv->urb_mutex);
1104
1105         /* Submit Read URBs for first port opened */
1106         if (!serial_priv->opened_port) {
1107                 status = f81534_submit_read_urb(port->serial, GFP_KERNEL);
1108                 if (status)
1109                         goto exit;
1110         }
1111
1112         serial_priv->opened_port++;
1113
1114 exit:
1115         mutex_unlock(&serial_priv->urb_mutex);
1116
1117         set_bit(F81534_TX_EMPTY_BIT, &port_priv->tx_empty);
1118         return status;
1119 }
1120
1121 static void f81534_close(struct usb_serial_port *port)
1122 {
1123         struct f81534_serial_private *serial_priv =
1124                         usb_get_serial_data(port->serial);
1125         struct usb_serial_port *port0 = port->serial->port[0];
1126         unsigned long flags;
1127         size_t i;
1128
1129         usb_kill_urb(port->write_urbs[0]);
1130
1131         spin_lock_irqsave(&port->lock, flags);
1132         kfifo_reset_out(&port->write_fifo);
1133         spin_unlock_irqrestore(&port->lock, flags);
1134
1135         /* Kill Read URBs when final port closed */
1136         mutex_lock(&serial_priv->urb_mutex);
1137         serial_priv->opened_port--;
1138
1139         if (!serial_priv->opened_port) {
1140                 for (i = 0; i < ARRAY_SIZE(port0->read_urbs); ++i)
1141                         usb_kill_urb(port0->read_urbs[i]);
1142         }
1143
1144         mutex_unlock(&serial_priv->urb_mutex);
1145 }
1146
1147 static int f81534_get_serial_info(struct usb_serial_port *port,
1148                                   struct serial_struct __user *retinfo)
1149 {
1150         struct f81534_port_private *port_priv;
1151         struct serial_struct tmp;
1152
1153         port_priv = usb_get_serial_port_data(port);
1154
1155         memset(&tmp, 0, sizeof(tmp));
1156
1157         tmp.type = PORT_16550A;
1158         tmp.port = port->port_number;
1159         tmp.line = port->minor;
1160         tmp.baud_base = port_priv->baud_base;
1161
1162         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1163                 return -EFAULT;
1164
1165         return 0;
1166 }
1167
1168 static int f81534_ioctl(struct tty_struct *tty, unsigned int cmd,
1169                         unsigned long arg)
1170 {
1171         struct usb_serial_port *port = tty->driver_data;
1172         struct serial_struct __user *buf = (struct serial_struct __user *)arg;
1173
1174         switch (cmd) {
1175         case TIOCGSERIAL:
1176                 return f81534_get_serial_info(port, buf);
1177         default:
1178                 break;
1179         }
1180
1181         return -ENOIOCTLCMD;
1182 }
1183
1184 static void f81534_process_per_serial_block(struct usb_serial_port *port,
1185                 u8 *data)
1186 {
1187         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1188         int phy_num = data[0];
1189         size_t read_size = 0;
1190         size_t i;
1191         char tty_flag;
1192         int status;
1193         u8 lsr;
1194
1195         /*
1196          * The block layout is 128 Bytes
1197          * index 0: port phy idx (e.g., 0,1,2,3),
1198          * index 1: It's could be
1199          *                      F81534_TOKEN_RECEIVE
1200          *                      F81534_TOKEN_TX_EMPTY
1201          *                      F81534_TOKEN_MSR_CHANGE
1202          * index 2: serial in size (data+lsr, must be even)
1203          *                      meaningful for F81534_TOKEN_RECEIVE only
1204          * index 3: current MSR with this device
1205          * index 4~127: serial in data block (data+lsr, must be even)
1206          */
1207         switch (data[1]) {
1208         case F81534_TOKEN_TX_EMPTY:
1209                 set_bit(F81534_TX_EMPTY_BIT, &port_priv->tx_empty);
1210
1211                 /* Try to submit writer */
1212                 status = f81534_submit_writer(port, GFP_ATOMIC);
1213                 if (status)
1214                         dev_err(&port->dev, "%s: submit failed\n", __func__);
1215                 return;
1216
1217         case F81534_TOKEN_MSR_CHANGE:
1218                 f81534_msr_changed(port, data[3]);
1219                 return;
1220
1221         case F81534_TOKEN_RECEIVE:
1222                 read_size = data[2];
1223                 if (read_size > F81534_MAX_RX_SIZE) {
1224                         dev_err(&port->dev,
1225                                 "%s: phy: %d read_size: %zu larger than: %d\n",
1226                                 __func__, phy_num, read_size,
1227                                 F81534_MAX_RX_SIZE);
1228                         return;
1229                 }
1230
1231                 break;
1232
1233         default:
1234                 dev_warn(&port->dev, "%s: unknown token: %02x\n", __func__,
1235                                 data[1]);
1236                 return;
1237         }
1238
1239         for (i = 4; i < 4 + read_size; i += 2) {
1240                 tty_flag = TTY_NORMAL;
1241                 lsr = data[i + 1];
1242
1243                 if (lsr & UART_LSR_BRK_ERROR_BITS) {
1244                         if (lsr & UART_LSR_BI) {
1245                                 tty_flag = TTY_BREAK;
1246                                 port->icount.brk++;
1247                                 usb_serial_handle_break(port);
1248                         } else if (lsr & UART_LSR_PE) {
1249                                 tty_flag = TTY_PARITY;
1250                                 port->icount.parity++;
1251                         } else if (lsr & UART_LSR_FE) {
1252                                 tty_flag = TTY_FRAME;
1253                                 port->icount.frame++;
1254                         }
1255
1256                         if (lsr & UART_LSR_OE) {
1257                                 port->icount.overrun++;
1258                                 tty_insert_flip_char(&port->port, 0,
1259                                                 TTY_OVERRUN);
1260                         }
1261
1262                         schedule_work(&port_priv->lsr_work);
1263                 }
1264
1265                 if (port->port.console && port->sysrq) {
1266                         if (usb_serial_handle_sysrq_char(port, data[i]))
1267                                 continue;
1268                 }
1269
1270                 tty_insert_flip_char(&port->port, data[i], tty_flag);
1271         }
1272
1273         tty_flip_buffer_push(&port->port);
1274 }
1275
1276 static void f81534_process_read_urb(struct urb *urb)
1277 {
1278         struct f81534_serial_private *serial_priv;
1279         struct usb_serial_port *port;
1280         struct usb_serial *serial;
1281         u8 *buf;
1282         int phy_port_num;
1283         int tty_port_num;
1284         size_t i;
1285
1286         if (!urb->actual_length ||
1287                         urb->actual_length % F81534_RECEIVE_BLOCK_SIZE) {
1288                 return;
1289         }
1290
1291         port = urb->context;
1292         serial = port->serial;
1293         buf = urb->transfer_buffer;
1294         serial_priv = usb_get_serial_data(serial);
1295
1296         for (i = 0; i < urb->actual_length; i += F81534_RECEIVE_BLOCK_SIZE) {
1297                 phy_port_num = buf[i];
1298                 if (phy_port_num >= F81534_NUM_PORT) {
1299                         dev_err(&port->dev,
1300                                 "%s: phy_port_num: %d larger than: %d\n",
1301                                 __func__, phy_port_num, F81534_NUM_PORT);
1302                         continue;
1303                 }
1304
1305                 tty_port_num = serial_priv->tty_idx[phy_port_num];
1306                 port = serial->port[tty_port_num];
1307
1308                 if (tty_port_initialized(&port->port))
1309                         f81534_process_per_serial_block(port, &buf[i]);
1310         }
1311 }
1312
1313 static void f81534_write_usb_callback(struct urb *urb)
1314 {
1315         struct usb_serial_port *port = urb->context;
1316
1317         switch (urb->status) {
1318         case 0:
1319                 break;
1320         case -ENOENT:
1321         case -ECONNRESET:
1322         case -ESHUTDOWN:
1323                 dev_dbg(&port->dev, "%s - urb stopped: %d\n",
1324                                 __func__, urb->status);
1325                 return;
1326         case -EPIPE:
1327                 dev_err(&port->dev, "%s - urb stopped: %d\n",
1328                                 __func__, urb->status);
1329                 return;
1330         default:
1331                 dev_dbg(&port->dev, "%s - nonzero urb status: %d\n",
1332                                 __func__, urb->status);
1333                 break;
1334         }
1335 }
1336
1337 static void f81534_lsr_worker(struct work_struct *work)
1338 {
1339         struct f81534_port_private *port_priv;
1340         struct usb_serial_port *port;
1341         int status;
1342         u8 tmp;
1343
1344         port_priv = container_of(work, struct f81534_port_private, lsr_work);
1345         port = port_priv->port;
1346
1347         status = f81534_get_port_register(port, F81534_LINE_STATUS_REG, &tmp);
1348         if (status)
1349                 dev_warn(&port->dev, "read LSR failed: %d\n", status);
1350 }
1351
1352 static int f81534_set_port_output_pin(struct usb_serial_port *port)
1353 {
1354         struct f81534_serial_private *serial_priv;
1355         struct f81534_port_private *port_priv;
1356         struct usb_serial *serial;
1357         const struct f81534_port_out_pin *pins;
1358         int status;
1359         int i;
1360         u8 value;
1361         u8 idx;
1362
1363         serial = port->serial;
1364         serial_priv = usb_get_serial_data(serial);
1365         port_priv = usb_get_serial_port_data(port);
1366
1367         idx = F81534_CONF_INIT_GPIO_OFFSET + port_priv->phy_num;
1368         value = serial_priv->conf_data[idx];
1369         if (value >= F81534_CONF_GPIO_SHUTDOWN) {
1370                 /*
1371                  * Newer IC configure will make transceiver in shutdown mode on
1372                  * initial power on. We need enable it before using UARTs.
1373                  */
1374                 idx = F81534_CONF_WORK_GPIO_OFFSET + port_priv->phy_num;
1375                 value = serial_priv->conf_data[idx];
1376                 if (value >= F81534_CONF_GPIO_SHUTDOWN)
1377                         value = F81534_CONF_GPIO_RS232;
1378         }
1379
1380         pins = &f81534_port_out_pins[port_priv->phy_num];
1381
1382         for (i = 0; i < ARRAY_SIZE(pins->pin); ++i) {
1383                 status = f81534_set_mask_register(serial,
1384                                 pins->pin[i].reg_addr, pins->pin[i].reg_mask,
1385                                 value & BIT(i) ? pins->pin[i].reg_mask : 0);
1386                 if (status)
1387                         return status;
1388         }
1389
1390         dev_dbg(&port->dev, "Output pin (M0/M1/M2): %d\n", value);
1391         return 0;
1392 }
1393
1394 static int f81534_port_probe(struct usb_serial_port *port)
1395 {
1396         struct f81534_serial_private *serial_priv;
1397         struct f81534_port_private *port_priv;
1398         int ret;
1399         u8 value;
1400
1401         serial_priv = usb_get_serial_data(port->serial);
1402         port_priv = devm_kzalloc(&port->dev, sizeof(*port_priv), GFP_KERNEL);
1403         if (!port_priv)
1404                 return -ENOMEM;
1405
1406         /*
1407          * We'll make tx frame error when baud rate from 384~500kps. So we'll
1408          * delay all tx data frame with 1bit.
1409          */
1410         port_priv->shadow_clk = F81534_UART_EN | F81534_CLK_TX_DELAY_1BIT;
1411         spin_lock_init(&port_priv->msr_lock);
1412         mutex_init(&port_priv->mcr_mutex);
1413         mutex_init(&port_priv->lcr_mutex);
1414         INIT_WORK(&port_priv->lsr_work, f81534_lsr_worker);
1415
1416         /* Assign logic-to-phy mapping */
1417         ret = f81534_logic_to_phy_port(port->serial, port);
1418         if (ret < 0)
1419                 return ret;
1420
1421         port_priv->phy_num = ret;
1422         port_priv->port = port;
1423         usb_set_serial_port_data(port, port_priv);
1424         dev_dbg(&port->dev, "%s: port_number: %d, phy_num: %d\n", __func__,
1425                         port->port_number, port_priv->phy_num);
1426
1427         /*
1428          * The F81532/534 will hang-up when enable LSR interrupt in IER and
1429          * occur data overrun. So we'll disable the LSR interrupt in probe()
1430          * and submit the LSR worker to clear LSR state when reported LSR error
1431          * bit with bulk-in data in f81534_process_per_serial_block().
1432          */
1433         ret = f81534_set_port_register(port, F81534_INTERRUPT_ENABLE_REG,
1434                         UART_IER_RDI | UART_IER_THRI | UART_IER_MSI);
1435         if (ret)
1436                 return ret;
1437
1438         value = serial_priv->conf_data[port_priv->phy_num];
1439         switch (value & F81534_PORT_CONF_MODE_MASK) {
1440         case F81534_PORT_CONF_RS485_INVERT:
1441                 port_priv->shadow_clk |= F81534_CLK_RS485_MODE |
1442                                         F81534_CLK_RS485_INVERT;
1443                 dev_dbg(&port->dev, "RS485 invert mode\n");
1444                 break;
1445         case F81534_PORT_CONF_RS485:
1446                 port_priv->shadow_clk |= F81534_CLK_RS485_MODE;
1447                 dev_dbg(&port->dev, "RS485 mode\n");
1448                 break;
1449
1450         default:
1451         case F81534_PORT_CONF_RS232:
1452                 dev_dbg(&port->dev, "RS232 mode\n");
1453                 break;
1454         }
1455
1456         return f81534_set_port_output_pin(port);
1457 }
1458
1459 static int f81534_port_remove(struct usb_serial_port *port)
1460 {
1461         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1462
1463         flush_work(&port_priv->lsr_work);
1464         return 0;
1465 }
1466
1467 static int f81534_tiocmget(struct tty_struct *tty)
1468 {
1469         struct usb_serial_port *port = tty->driver_data;
1470         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1471         int status;
1472         int r;
1473         u8 msr;
1474         u8 mcr;
1475
1476         /* Read current MSR from device */
1477         status = f81534_get_port_register(port, F81534_MODEM_STATUS_REG, &msr);
1478         if (status)
1479                 return status;
1480
1481         mutex_lock(&port_priv->mcr_mutex);
1482         mcr = port_priv->shadow_mcr;
1483         mutex_unlock(&port_priv->mcr_mutex);
1484
1485         r = (mcr & UART_MCR_DTR ? TIOCM_DTR : 0) |
1486             (mcr & UART_MCR_RTS ? TIOCM_RTS : 0) |
1487             (msr & UART_MSR_CTS ? TIOCM_CTS : 0) |
1488             (msr & UART_MSR_DCD ? TIOCM_CAR : 0) |
1489             (msr & UART_MSR_RI ? TIOCM_RI : 0) |
1490             (msr & UART_MSR_DSR ? TIOCM_DSR : 0);
1491
1492         return r;
1493 }
1494
1495 static int f81534_tiocmset(struct tty_struct *tty, unsigned int set,
1496                                 unsigned int clear)
1497 {
1498         struct usb_serial_port *port = tty->driver_data;
1499
1500         return f81534_update_mctrl(port, set, clear);
1501 }
1502
1503 static void f81534_dtr_rts(struct usb_serial_port *port, int on)
1504 {
1505         if (on)
1506                 f81534_update_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
1507         else
1508                 f81534_update_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
1509 }
1510
1511 static int f81534_write(struct tty_struct *tty, struct usb_serial_port *port,
1512                         const u8 *buf, int count)
1513 {
1514         int bytes_out, status;
1515
1516         if (!count)
1517                 return 0;
1518
1519         bytes_out = kfifo_in_locked(&port->write_fifo, buf, count,
1520                                         &port->lock);
1521
1522         status = f81534_submit_writer(port, GFP_ATOMIC);
1523         if (status) {
1524                 dev_err(&port->dev, "%s: submit failed\n", __func__);
1525                 return status;
1526         }
1527
1528         return bytes_out;
1529 }
1530
1531 static bool f81534_tx_empty(struct usb_serial_port *port)
1532 {
1533         struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
1534
1535         return test_bit(F81534_TX_EMPTY_BIT, &port_priv->tx_empty);
1536 }
1537
1538 static int f81534_resume(struct usb_serial *serial)
1539 {
1540         struct f81534_serial_private *serial_priv =
1541                         usb_get_serial_data(serial);
1542         struct usb_serial_port *port;
1543         int error = 0;
1544         int status;
1545         size_t i;
1546
1547         /*
1548          * We'll register port 0 bulkin when port had opened, It'll take all
1549          * port received data, MSR register change and TX_EMPTY information.
1550          */
1551         mutex_lock(&serial_priv->urb_mutex);
1552
1553         if (serial_priv->opened_port) {
1554                 status = f81534_submit_read_urb(serial, GFP_NOIO);
1555                 if (status) {
1556                         mutex_unlock(&serial_priv->urb_mutex);
1557                         return status;
1558                 }
1559         }
1560
1561         mutex_unlock(&serial_priv->urb_mutex);
1562
1563         for (i = 0; i < serial->num_ports; i++) {
1564                 port = serial->port[i];
1565                 if (!tty_port_initialized(&port->port))
1566                         continue;
1567
1568                 status = f81534_submit_writer(port, GFP_NOIO);
1569                 if (status) {
1570                         dev_err(&port->dev, "%s: submit failed\n", __func__);
1571                         ++error;
1572                 }
1573         }
1574
1575         if (error)
1576                 return -EIO;
1577
1578         return 0;
1579 }
1580
1581 static struct usb_serial_driver f81534_device = {
1582         .driver = {
1583                    .owner = THIS_MODULE,
1584                    .name = "f81534",
1585         },
1586         .description =          DRIVER_DESC,
1587         .id_table =             f81534_id_table,
1588         .num_bulk_in =          1,
1589         .num_bulk_out =         1,
1590         .open =                 f81534_open,
1591         .close =                f81534_close,
1592         .write =                f81534_write,
1593         .tx_empty =             f81534_tx_empty,
1594         .calc_num_ports =       f81534_calc_num_ports,
1595         .port_probe =           f81534_port_probe,
1596         .port_remove =          f81534_port_remove,
1597         .break_ctl =            f81534_break_ctl,
1598         .dtr_rts =              f81534_dtr_rts,
1599         .process_read_urb =     f81534_process_read_urb,
1600         .ioctl =                f81534_ioctl,
1601         .tiocmget =             f81534_tiocmget,
1602         .tiocmset =             f81534_tiocmset,
1603         .write_bulk_callback =  f81534_write_usb_callback,
1604         .set_termios =          f81534_set_termios,
1605         .resume =               f81534_resume,
1606 };
1607
1608 static struct usb_serial_driver *const serial_drivers[] = {
1609         &f81534_device, NULL
1610 };
1611
1612 module_usb_serial_driver(serial_drivers, f81534_id_table);
1613
1614 MODULE_DEVICE_TABLE(usb, f81534_id_table);
1615 MODULE_DESCRIPTION(DRIVER_DESC);
1616 MODULE_AUTHOR("Peter Hong <Peter_Hong@fintek.com.tw>");
1617 MODULE_AUTHOR("Tom Tsai <Tom_Tsai@fintek.com.tw>");
1618 MODULE_LICENSE("GPL");