linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver
@ 2015-12-02  7:18 Peter Hung
  2015-12-05 23:28 ` kbuild test robot
  2016-01-03 18:58 ` Johan Hovold
  0 siblings, 2 replies; 4+ messages in thread
From: Peter Hung @ 2015-12-02  7:18 UTC (permalink / raw)
  To: johan; +Cc: gregkh, linux-usb, linux-kernel, tom_tsai, peter_hong, Peter Hung

This driver is for Fintek F81532/F81534 USB to Serial Ports IC.

Features:
1. F81534 is 1-to-4 & F81532 is 1-to-2 serial ports IC
2. Support Baudrate from B50 to B1500000 (excluding B1000000).
3. The RTS signal can be transformed their behavior with
   configuration by ioctl TIOCGRS485/TIOCSRS485

   If the driver setting with SER_RS485_ENABLED, the RTS signal will
   high with not in TX and low with in TX.

   If the driver setting with SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND,
   the RTS signal will low with not in TX and high with in TX.

4. The 4x3 output-only open-drain pins for F81532/534 is designed for
   control outer devices (with our EVB for examples, the 4 sets of pins
   are designed to control transceiver mode). So it implements as
   gpiolib interface with output-only function.
5. It'll save the configuration in internal storage when uart/pins mode
   changed.

   Please reference https://bitbucket.org/hpeter/fintek-general/src/
   with f81534/tools to get set_gpio.c & set_mode.c to change F81532/534
   setting. Please use it carefully.

Signed-off-by: Peter Hung <hpeter+linux_kernel@gmail.com>
---
Changelog:
v7
    1. Make all gpiolib function with #ifdef CONFIG_GPIOLIB marco block.
       Due to F81532/534 could run without gpiolib, we implements
       f81534_prepare_gpio()/f81534_release_gpio() always success without
       CONFIG_GPIOLIB.
    2. Fix crash when receiving MSR change on driver load/unload. It's cause
       by f81534_process_read_urb() get read URB callback data, but port
       private data is not init complete or released. We solve with 2
       modifications.

       1. add null pointer check with f81534_process_read_urb(). We'll skip
          this report when port_priv = NULL.
       2. when "one" port f81534_port_remove() is called, kill the port-0
          read URB before kfree port_priv.

v6
    1. Re-implement the write()/resume() function. Due to this device cant be
       suitable with generic write(), we'll do the submit write URB when
       write()/received tx empty/set_termios()/resume()
    2. Logic/Phy Port mapping rewrite in f81534_port_probe() &
       f81534_phy_to_logic_port().
    3. Introduced "Port Hide" function. Some customer use F81532 reference
       design for HW layout, but really use F81534 IC. We'll check
       F81534_PORT_CONF_DISABLE_PORT flag with in uart mode field to do
       port hide with port not used. It can be avoid end-user to use not
       layouted port.
    4. The 4x3 output-only open-drain pins for F81532/534 is designed for
       control outer devices (with our EVB for examples, the 4 sets of pins
       are designed to control transceiver mode). So we decide to implement
       with gpiolib interface.
    5. Add device vendor id with 0x2c42

v5
    1. Change f81534_port_disable/enable() from H/W mode to S/W mode
       It'll skip all rx data when port is not opened.
    2. Some function modifier add with static (Thanks for Paul Bolle)
    3. It's will direct return when count=0 in f81534_write() to
       reduce spin_lock usage.

v4
    1. clearify f81534_process_read_urb() with
       f81534_process_per_serial_block(). (referenced from mxuport.c)
    2. We limited f81534_write() max tx kfifo with 124Bytes.
       Original subsystem is designed for auto tranmiting fifo data
       if available. But we must wait for tx_empty for next tx data
       (H/W design).

       With this kfifo size limit, we can use generic subsystem api with
       f81534_write(). When usb_serial_generic_write_start() called after
       first write URB complete, the fifo will no data. The generic
       subsystem of write will go to idle state. Until we received
       TX_EMPTY and release write spinlock, the fifo will fill max
       124Bytes by following f81534_write().

v3
    1. Migrate read, write and some routine from custom code to usbserial
       subsystem callback function.
    2. Use more defines to replece magic numbers to make it meaningful
    3. Make more comments as document in source code.

v2
    1. v1 version submit to staging tree, but Greg KH advised me to
       cleanup source code & re-submit it to correct subsystem
    2. Remove all custom ioctl commands

 drivers/usb/serial/Kconfig  |   10 +
 drivers/usb/serial/Makefile |    1 +
 drivers/usb/serial/f81534.c | 2945 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 2956 insertions(+)
 create mode 100644 drivers/usb/serial/f81534.c

diff --git a/drivers/usb/serial/Kconfig b/drivers/usb/serial/Kconfig
index 56ecb8b..0642864 100644
--- a/drivers/usb/serial/Kconfig
+++ b/drivers/usb/serial/Kconfig
@@ -255,6 +255,16 @@ config USB_SERIAL_F81232
 	  To compile this driver as a module, choose M here: the
 	  module will be called f81232.
 
+config USB_SERIAL_F8153X
+	tristate "USB Fintek F81532/534 Multi-Ports Serial Driver"
+	help
+	  Say Y here if you want to use the Fintek F81532/534 Multi-Ports
+	  usb to serial adapter.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called f81534.
+
+
 config USB_SERIAL_GARMIN
        tristate "USB Garmin GPS driver"
        help
diff --git a/drivers/usb/serial/Makefile b/drivers/usb/serial/Makefile
index 349d9df..9e43b7b 100644
--- a/drivers/usb/serial/Makefile
+++ b/drivers/usb/serial/Makefile
@@ -23,6 +23,7 @@ obj-$(CONFIG_USB_SERIAL_EDGEPORT)		+= io_edgeport.o
 obj-$(CONFIG_USB_SERIAL_EDGEPORT_TI)		+= io_ti.o
 obj-$(CONFIG_USB_SERIAL_EMPEG)			+= empeg.o
 obj-$(CONFIG_USB_SERIAL_F81232)			+= f81232.o
+obj-$(CONFIG_USB_SERIAL_F8153X)			+= f81534.o
 obj-$(CONFIG_USB_SERIAL_FTDI_SIO)		+= ftdi_sio.o
 obj-$(CONFIG_USB_SERIAL_GARMIN)			+= garmin_gps.o
 obj-$(CONFIG_USB_SERIAL_IPAQ)			+= ipaq.o
diff --git a/drivers/usb/serial/f81534.c b/drivers/usb/serial/f81534.c
new file mode 100644
index 0000000..1bbcb1c
--- /dev/null
+++ b/drivers/usb/serial/f81534.c
@@ -0,0 +1,2945 @@
+/*
+ * F81532/F81534 USB to Serial Ports Bridge
+ *
+ * F81532 => 2 Serial Ports
+ * F81534 => 4 Serial Ports
+ *
+ * Copyright (C) 2014 Tom Tsai (Tom_Tsai@fintek.com.tw)
+ *
+ * The F81532/F81534 had 1 control endpoint for setting,
+ * 1 endpoint bulk-out for all serial port write out and
+ * 1 endpoint bulk-in for all serial port read in.
+ *
+ * write URB is fixed with 512bytes, per serial port used 128Bytes.
+ * is can be described by f81534_prepare_write_buffer()
+ *
+ * read URB is 512Bytes max. per serial port used 128Bytes.
+ * is can be described by f81534_process_read_urb(), it' maybe
+ * received with 128x1,2,3,4 bytes.
+ *
+ * We can control M0(SD)/M1/M2 per ports by gpiolib, This IC contains a
+ * internal flash to save configuration. Due to reduce erase/write operation,
+ * it's recommend sequence to request 3 pins, change value and release 3 gpio
+ * pins. We'll really save configurations when M0(SD)/M1/M2 pin all released
+ * for a port.
+ *
+ * Features:
+ * 1. F81534 is 1-to-4 & F81532 is 1-to-2 serial ports IC
+ * 2. Support Baudrate from B50 to B1500000 (excluding B1000000).
+ * 3. The RTS signal can be transformed their behavior with
+ *    configuration by default ioctl TIOCGRS485/TIOCSRS485
+ *    (for RS232/RS485/RS422 with transceiver)
+ *
+ *    If the driver setting with SER_RS485_ENABLED, the RTS signal will
+ *    high with not in TX and low with in TX.
+ *
+ *    If the driver setting with SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND,
+ *    the RTS signal will low with not in TX and high with in TX.
+ *
+ * 4. There are 4x3 output-only ic pins to control transceiver mode with our
+ *    EVB Board. It's can be controlled via gpiolib. We could found the gpio
+ *    number from /sys/class/tty/ttyUSB[x]/device/gpiochip[yyy] where
+ *    x is F81532/534 serial port and yyy is gpiochip number.
+ *
+ *    After we found chip number, we can export 3 gpios(M0(SD)/M1/M2) per
+ *    serial port by
+ *       echo yyy > /sys/class/gpio/export
+ *       echo yyy+1 > /sys/class/gpio/export
+ *       echo yyy+2 > /sys/class/gpio/export
+ *
+ *    then we can control it with
+ *       echo [M2 value] > /sys/class/gpio/gpio[yyy]/value
+ *       echo [M1 value] > /sys/class/gpio/gpio[yyy+1]/value
+ *       echo [M0(SD) value] > /sys/class/gpio/gpio[yyy+2]/value
+ *    which M0(SD)/M1/M2 as your desired value, value is only 0 or 1.
+ *
+ *    When configure complete, It's a must to free all gpio by
+ *       echo yyy > /sys/class/gpio/unexport
+ *       echo yyy+1 > /sys/class/gpio/unexport
+ *       echo yyy+2 > /sys/class/gpio/unexport
+ *
+ *    The driver will "save" gpio configure after we release
+ *    all gpio of a serial port.
+ *
+ *    For examples to change mode & gpio with F81532/534
+ *    Evalaution Board.
+ *
+ *    F81532 EVB
+ *       port0: F81437 (RS232 only)
+ *       port1: F81439 (RS232/RS485/RS422 ... etc.)
+ *    F81534 EVB
+ *       port0/1: F81437 (RS232 only)
+ *       port2/3: F81439 (RS232/RS485/RS422 ... etc.)
+ *
+ *       1. RS232 Mode (Default IC Mode)
+ *          1. Set struct serial_rs485 flags "without" SER_RS485_ENABLED
+ *             (control F81532/534 RTS control)
+ *          2. Set M0(SD)/M1/M2 as 0/0/1
+ *             (control F81532/534 output pin to control transceiver mode)
+ *
+ *       2. RS485 Mode (RTS Low when TX Mode)
+ *          1. Set struct serial_rs485 flags with SER_RS485_ENABLED
+ *          2. Set M0(SD)/M1/M2 as 0/1/0
+ *
+ *       3. RS485 Mode (RTS High when TX Mode)
+ *          1. Set struct serial_rs485 flags with SER_RS485_ENABLED and
+ *             SER_RS485_RTS_ON_SEND
+ *          2. Set M0(SD)/M1/M2 as 0/1/1
+ *
+ *       4. RS422 Mode
+ *          1. The RTS mode is dont care.
+ *          2. Set M0(SD)/M1/M2 as 0/0/0
+ *
+ *    Please reference https://bitbucket.org/hpeter/fintek-general/src/
+ *    with f81534/tools to get set_gpio.c & set_mode.c. Please use it
+ *    carefully.
+ */
+#include <linux/errno.h>
+#include <linux/slab.h>
+#include <linux/tty.h>
+#include <linux/tty_flip.h>
+#include <linux/serial.h>
+#include <linux/usb.h>
+#include <linux/usb/serial.h>
+#include <linux/serial_reg.h>
+#include <linux/kfifo.h>
+#include <linux/gpio.h>
+
+/* Serial Port register Address */
+#define SERIAL_BASE_ADDRESS		0x1200
+#define RECEIVE_BUFFER_REGISTER		(0x00 + SERIAL_BASE_ADDRESS)
+#define TRANSMIT_HOLDING_REGISTER	(0x00 + SERIAL_BASE_ADDRESS)
+#define DIVISOR_LATCH_LSB		(0x00 + SERIAL_BASE_ADDRESS)
+#define INTERRUPT_ENABLE_REGISTER	(0x01 + SERIAL_BASE_ADDRESS)
+#define DIVISOR_LATCH_MSB		(0x01 + SERIAL_BASE_ADDRESS)
+#define INTERRUPT_IDENT_REGISTER	(0x02 + SERIAL_BASE_ADDRESS)
+#define FIFO_CONTROL_REGISTER		(0x02 + SERIAL_BASE_ADDRESS)
+#define LINE_CONTROL_REGISTER		(0x03 + SERIAL_BASE_ADDRESS)
+#define MODEM_CONTROL_REGISTER		(0x04 + SERIAL_BASE_ADDRESS)
+#define LINE_STATUS_REGISTER		(0x05 + SERIAL_BASE_ADDRESS)
+#define MODEM_STATUS_REGISTER		(0x06 + SERIAL_BASE_ADDRESS)
+#define CLK_SEL_REGISTER		(0x08 + SERIAL_BASE_ADDRESS)
+#define CONFIG1_REGISTER		(0x09 + SERIAL_BASE_ADDRESS)
+#define SADDRESS_REGISTER		(0x0a + SERIAL_BASE_ADDRESS)
+#define SADEN_REGISTER			(0x0b + SERIAL_BASE_ADDRESS)
+
+#define F81534_DEF_CONF_ADDRESS_START	0x3000
+#define F81534_DEF_CONF_SIZE		8
+
+#define F81534_CUSTOM_ADDRESS_START	0x2f00
+#define F81534_CUSTOM_TOTAL_SIZE	0x10
+#define F81534_CUSTOM_DATA_SIZE		0x10
+#define F81534_CUSTOM_MAX_IDX		\
+			(F81534_CUSTOM_TOTAL_SIZE/F81534_CUSTOM_DATA_SIZE)
+#define F81534_CUSTOM_NO_CUSTOM_DATA	(-1)
+#define F81534_CUSTOM_VALID_TOKEN	0xf0
+#define F81534_CONF_OFFSET		1
+#define F81534_CONF_SIZE		4
+
+#define F81534_MAX_DATA_BLOCK		64
+#define F81534_MAX_BUS_RETRY		2000
+
+/* default URB timeout for usb operations */
+#define F81534_USB_MAX_RETRY		10
+#define F81534_USB_TIMEOUT		1000
+#define F81534_CONTROL_BYTE		0x1B
+#define F81534_SET_GET_REGISTER		0xA0
+
+#define F81534_NUM_PORT			4
+#define F81534_UNUSED_PORT		0xff
+#define F81534_WRITE_BUFFER_SIZE	512
+
+#define IC_NAME				"f81534"
+#define DRIVER_DESC \
+	"Fintek USB to Serial Ports Driver (F81532/F81534-Evaluation Board)"
+#define FINTEK_VENDOR_ID_1		0x1934
+#define FINTEK_VENDOR_ID_2		0x2C42
+#define FINTEK_DEVICE_ID		0x1202	/* RS232 four port */
+#define F81534_MAX_TX_SIZE		100
+#define F81534_FIFO_SIZE		128
+#define F81534_RECEIVE_BLOCK_SIZE	128
+
+#define F81534_TOKEN_RECEIVE		0x01
+#define F81534_TOKEN_WRITE		0x02
+#define F81534_TOKEN_TX_EMPTY		0x03
+#define F81534_TOKEN_MSR_CHANGE		0x04
+
+#define F81534_BUS_BUSY			0x03
+#define F81534_BUS_IDLE			0x04
+#define F81534_BUS_READ_DATA		0x1004
+#define F81534_BUS_REG_STATUS		0x1003
+#define F81534_BUS_REG_START		0x1002
+#define F81534_BUS_REG_END		0x1001
+
+#define F81534_CMD_READ			0x03
+#define F81534_CMD_ENABLE_WR		0x06
+#define F81534_CMD_PROGRAM		0x02
+#define F81534_CMD_ERASE		0x20
+#define F81534_CMD_READ_STATUS		0x05
+
+#define F81534_MEDIA_BUSY_STATUS	0x03
+
+#define F81534_1X_RXTRIGGER		0xc3
+#define F81534_8X_RXTRIGGER		0xcf
+
+#define F81534_DEFAULT_BAUD_RATE	9600
+#define F81534_MAX_BAUDRATE		1500000
+
+#define F81534_DELAY_READ_MSR		10
+
+#define F81534_RS232_FLAG		0x00
+#define F81534_RS485_FLAG		0x03
+#define F81534_RS485_1_FLAG		0x01
+#define F81534_MODE_MASK		0x03
+#define F81534_PORT_CONF_RS485		BIT(0)
+#define F81534_PORT_CONF_RS485_INVERT	BIT(1)
+#define F81534_PORT_CONF_DISABLE_PORT	BIT(3)
+#define F81534_PORT_CONF_NOT_EXIST_PORT	BIT(7)
+#define F81534_PORT_UNAVAILABLE		\
+	(F81534_PORT_CONF_DISABLE_PORT | F81534_PORT_CONF_NOT_EXIST_PORT)
+
+#define F81534_RS485_MODE	BIT(4)
+#define F81534_RS485_INVERT	BIT(5)
+
+#define F81534_PIN_SET_DEFAULT	0x01
+#define F81534_PIN_SET_MAX	0x07
+#define F81534_PIN_SET_MIN	0x00
+
+/*
+ * For older configuration use. We'll transform it to newer setting after
+ * load it.
+ */
+#define F81534_OLD_CONFIG_37	0x37
+#define F81534_OLD_CONFIG_38	0x38
+#define F81534_OLD_CONFIG_39	0x39
+
+/*
+ * Clock rate selector, always or-ed with CLKSEL_ENABLE_UART to enable
+ * UART functional.
+ */
+#define CLKSEL_ENABLE_UART	BIT(0)
+#define CLKSEL_1DOT846_MHZ	CLKSEL_ENABLE_UART
+#define CLKSEL_18DOT46_MHZ	(BIT(1) | CLKSEL_ENABLE_UART)
+#define CLKSEL_24_MHZ		(BIT(2) | CLKSEL_ENABLE_UART)
+#define CLKSEL_14DOT77_MHZ	(BIT(1) | BIT(2) | CLKSEL_ENABLE_UART)
+
+#ifndef C_CMSPAR
+#define C_CMSPAR(tty)   _C_FLAG((tty), CMSPAR)
+#endif
+
+enum uart_mode {
+	uart_mode_rs422,
+	uart_mode_rs232,
+	uart_mode_rs485,
+	uart_mode_rs485_1,
+	uart_mode_rs422_term,
+	uart_mode_rs232_coexist,
+	uart_mode_rs485_1_term,
+	uart_mode_shutdown,
+	uart_mode_invalid,
+};
+
+struct f81534_pin_config_data {
+	enum uart_mode force_uart_mode;
+	u8 gpio_mode;
+	const int address[9];
+	const int offset[9];
+};
+
+/* Save for a control register and bit offset */
+struct reg_value {
+	const u16 reg_address;
+	const u16 reg_offset;
+	const u16 reg_bit;
+};
+
+/* 3 control register to configuration a output pin mode and value */
+struct pin_data {
+	struct reg_value port_mode_1;
+	struct reg_value port_mode_0;
+	struct reg_value port_io;
+};
+
+/* 3 output pins to control transceiver mode */
+struct out_pin {
+	struct pin_data m1;
+	struct pin_data m2;
+	struct pin_data m0_sd;
+};
+
+struct io_map_value {
+	int product_id;
+	int max_port;
+	enum uart_mode mode;
+	struct out_pin port[MAX_NUM_PORTS + 1];
+};
+
+/*
+ * The following magic numbers is F81532/534 output pin
+ * register maps
+ */
+static const struct io_map_value f81534_rs232_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs232,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 0},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 0},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 1},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 0},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 0},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 1},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 0},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 0},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 1},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 0},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 0},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 1},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs485_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs485,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 0},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 1},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 0},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 0},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 1},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 0},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 0},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 1},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 0},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 0},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 1},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 0},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs485_1_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs485_1,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 0},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 1},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 1},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 0},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 1},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 1},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 0},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 1},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 1},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 0},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 1},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 1},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs422_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs422,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 0},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 0},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 0},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 0},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 0},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 0},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 0},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 0},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 0},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 0},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 0},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 0},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_shutdown_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_shutdown,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 1},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 1},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 1},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 1},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 1},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 1},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 1},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 1},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 1},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 1},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 1},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 1},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs422_term_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_shutdown,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 1},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 0},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 0},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 1},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 0},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 0},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 1},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 0},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 0},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 1},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 0},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 0},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs232_coexist_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_shutdown,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 1},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 0},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 1},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 1},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 0},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 1},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 1},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 0},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 1},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 1},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 0},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 1},},
+	  },
+	 },
+};
+
+static const struct io_map_value f81534_rs485_1_term_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_shutdown,
+	{
+	 /* please reference f81439 io port */
+	 {
+	  {{0x2ad5, 4, 0}, {0x2ad4, 4, 1}, {0x2a90, 4, 1},},
+	  {{0x2ad5, 5, 0}, {0x2ad4, 5, 1}, {0x2a90, 5, 1},},
+	  {{0x2add, 7, 0}, {0x2adc, 7, 1}, {0x2ae8, 7, 0},},
+	  },
+	 {
+	  {{0x2add, 3, 0}, {0x2adc, 3, 1}, {0x2ae8, 3, 1},},
+	  {{0x2add, 0, 0}, {0x2adc, 0, 1}, {0x2ae8, 0, 1},},
+	  {{0x2add, 6, 0}, {0x2adc, 6, 1}, {0x2ae8, 6, 0},},
+	  },
+	 {
+	  {{0x2ad3, 6, 0}, {0x2ad2, 6, 1}, {0x2a80, 6, 1},},
+	  {{0x2add, 2, 0}, {0x2adc, 2, 1}, {0x2ae8, 2, 1},},
+	  {{0x2ad5, 0, 0}, {0x2ad4, 0, 1}, {0x2a90, 0, 0},},
+	  },
+	 {
+	  {{0x2ad5, 1, 0}, {0x2ad4, 1, 1}, {0x2a90, 1, 1},},
+	  {{0x2ad5, 2, 0}, {0x2ad4, 2, 1}, {0x2a90, 2, 1},},
+	  {{0x2ad5, 3, 0}, {0x2ad4, 3, 1}, {0x2a90, 3, 0},},
+	  },
+	 },
+};
+
+static const struct io_map_value *f81534_mode_control[uart_mode_invalid] = {
+	&f81534_rs422_control,
+	&f81534_rs232_control,
+	&f81534_rs485_control,
+	&f81534_rs485_1_control,
+	&f81534_rs422_term_control,
+	&f81534_rs232_coexist_control,
+	&f81534_rs485_1_term_control,
+	&f81534_shutdown_control,
+};
+
+static const struct usb_device_id id_table[] = {
+	{USB_DEVICE(FINTEK_VENDOR_ID_1, FINTEK_DEVICE_ID)},
+	{USB_DEVICE(FINTEK_VENDOR_ID_2, FINTEK_DEVICE_ID)},
+	{}			/* Terminating entry */
+};
+
+MODULE_DEVICE_TABLE(usb, id_table);
+
+struct f81534_serial_private {
+	bool is_phy_port_not_empty[F81534_NUM_PORT];
+	spinlock_t tx_empty_lock;
+	struct mutex change_mode_mutex;
+	u8 default_conf_data[F81534_DEF_CONF_SIZE];
+	u32 setting_idx;
+	atomic_t port_active[F81534_NUM_PORT];
+};
+
+struct f81534_port_private {
+	u8 phy;
+	u8 shadow_mcr;
+	u8 shadow_lcr;
+	u32 current_baud_rate;
+	u32 current_baud_base;
+	struct f81534_pin_config_data port_pin_data;
+#ifdef CONFIG_GPIOLIB
+	struct gpio_chip f81534_gpio_chip;
+#endif
+	atomic_t gpio_active;
+	spinlock_t msr_lock;
+	struct mutex msr_mutex;
+	u8 shadow_msr;
+};
+
+/*
+ * Get the current port index of this device. e.g., 0 is the start index of
+ * this device.
+ */
+static int f81534_port_index(struct usb_serial_port *port)
+{
+	return port->port_number;
+}
+
+/*
+ * Find logic serial port index with H/W phy index mapping
+ */
+static int f81534_phy_to_logic_port(struct usb_serial *serial, int phy)
+{
+	int count = 0, i;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+
+	for (i = 0; i < phy; ++i) {
+		if (serial_priv->default_conf_data[i] &
+				F81534_PORT_UNAVAILABLE)
+			continue;
+
+		++count;
+	}
+
+	dev_dbg(&serial->dev->dev, "%s: phy:%d count:%d\n", __func__, phy,
+			count);
+	return count;
+}
+
+static int f81534_set_normal_register(struct usb_device *dev, u16 reg, u8 data)
+{
+	int count = F81534_USB_MAX_RETRY;
+	int status = 0;
+	u8 *tmp;
+
+	tmp = kmalloc(sizeof(u8), GFP_KERNEL);
+	if (!tmp)
+		return -ENOMEM;
+
+	*tmp = data;
+
+	/*
+	 * Our device maybe not reply when heavily loading,
+	 * We'll retry for F81534_USB_MAX_RETRY times
+	 */
+	while (count--) {
+		status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
+					 F81534_SET_GET_REGISTER,
+					 USB_TYPE_VENDOR | USB_DIR_OUT,
+					 reg, 0, tmp, sizeof(u8),
+					 F81534_USB_TIMEOUT);
+		if (status > 0)
+			break;
+
+		if (status == 0)
+			status = -EIO;
+	}
+
+	if (status < 0) {
+		dev_err(&dev->dev,
+				"%s ERROR reg:%x data:0x%x status:%i failed\n",
+				__func__, reg, data, status);
+		kfree(tmp);
+		return status;
+	}
+
+	kfree(tmp);
+	return 0;
+}
+
+static int f81534_get_normal_register(struct usb_device *dev, u16 reg,
+					u8 *data)
+{
+	int count = F81534_USB_MAX_RETRY;
+	int status;
+	u8 *tmp;
+
+	tmp = kmalloc(sizeof(u8), GFP_KERNEL);
+	if (!tmp)
+		return -ENOMEM;
+
+	/*
+	 * Our device maybe not reply when heavily loading,
+	 * We'll retry for F81534_USB_MAX_RETRY times
+	 */
+	while (count--) {
+		status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
+					 F81534_SET_GET_REGISTER,
+					 USB_TYPE_VENDOR | USB_DIR_IN,
+					 reg, 0, tmp, sizeof(u8),
+					 F81534_USB_TIMEOUT);
+		if (status > 0)
+			break;
+
+		if (status == 0)
+			status = -EIO;
+	}
+
+	if (status < 0) {
+		dev_err(&dev->dev, "%s ERROR reg:%x status:%i failed\n",
+				__func__, reg, status);
+		kfree(tmp);
+		return status;
+	}
+
+	*data = *tmp;
+	kfree(tmp);
+	return 0;
+}
+
+static int f81534_set_mask_normal_register(struct usb_device *dev, u16 reg,
+						u8 mask, u8 data)
+{
+	int status;
+	u8 tmp;
+
+	status = f81534_get_normal_register(dev, reg, &tmp);
+	if (status)
+		return status;
+
+	tmp = (tmp & ~mask) | (mask & data);
+
+	status = f81534_set_normal_register(dev, reg, tmp);
+	if (status)
+		return status;
+
+	return 0;
+}
+
+static int f81534_command_delay(struct usb_serial *usbserial)
+{
+	unsigned int count = F81534_MAX_BUS_RETRY;
+	unsigned char tmp;
+	int status;
+	struct usb_device *dev = usbserial->dev;
+
+	do {
+		status = f81534_get_normal_register(dev, F81534_BUS_REG_STATUS,
+							&tmp);
+		if (status)
+			return status;
+
+		if (tmp & F81534_BUS_BUSY)
+			continue;
+
+		if (tmp & F81534_BUS_IDLE)
+			break;
+
+	} while (--count);
+
+	if (!count)
+		return -EIO;
+
+	status = f81534_set_normal_register(dev, F81534_BUS_REG_STATUS,
+				tmp & ~F81534_BUS_IDLE);
+	if (status)
+		return status;
+
+	return 0;
+}
+
+static int f81534_get_normal_register_with_delay(struct usb_serial *usbserial,
+							u16 reg, u8 *data)
+{
+	int status;
+	struct usb_device *dev = usbserial->dev;
+
+	status = f81534_get_normal_register(dev, reg, data);
+	if (status)
+		return status;
+
+	status = f81534_command_delay(usbserial);
+	if (status)
+		return status;
+
+	return 0;
+}
+
+static int f81534_set_normal_register_with_delay(struct usb_serial *usbserial,
+							u16 reg, u8 data)
+{
+	int status;
+	struct usb_device *dev = usbserial->dev;
+
+	status = f81534_set_normal_register(dev, reg, data);
+	if (status)
+		return status;
+
+	status = f81534_command_delay(usbserial);
+	if (status)
+		return status;
+
+	return 0;
+}
+
+static int f81534_read_data(struct usb_serial *usbserial, u32 address,
+				u32 size, unsigned char *buf)
+{
+	u32 read_size, count;
+	u32 block = 0;
+	u16 reg_tmp;
+	u8 tmp_buf[F81534_MAX_DATA_BLOCK];
+	int status, offset;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, F81534_CMD_READ);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 16) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 8) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 0) & 0xff);
+	if (status)
+		return status;
+
+	/* continuous read mode */
+	do {
+		read_size = min_t(u32, F81534_MAX_DATA_BLOCK, size);
+
+		for (count = 0; count < read_size; ++count) {
+			/* We need write F81534_BUS_REG_END when final byte */
+			if ((size <= F81534_MAX_DATA_BLOCK) &&
+					(read_size == (count + 1)))
+				reg_tmp = F81534_BUS_REG_END;
+			else
+				reg_tmp = F81534_BUS_REG_START;
+
+			/*
+			 * dummy code, force IC to generate a read
+			 * pulse, the set of value 0xf1 is dont care
+			 * (any value is ok)
+			 */
+			status = f81534_set_normal_register_with_delay(
+					usbserial, reg_tmp, 0xf1);
+			if (status)
+				return status;
+
+			status = f81534_get_normal_register_with_delay(
+						usbserial,
+						F81534_BUS_READ_DATA,
+						&tmp_buf[count]);
+			if (status)
+				return status;
+
+			offset = count + block * F81534_MAX_DATA_BLOCK;
+			buf[offset] = tmp_buf[count];
+		}
+
+		size -= read_size;
+		++block;
+	} while (size);
+
+	return 0;
+}
+
+/*
+ * This function maybe cause IC no workable, Please take this carefully.
+ *
+ * The function is used to modify the configuration area of this device
+ * (F81534_CUSTOM_ADDRESS_START). If wrong operation with this function, it'll
+ * make the device malfuncional.
+ */
+static int f81534_write_data(struct usb_serial *usbserial, u32 address,
+			     u32 size, unsigned char *buf)
+{
+	u32 count, write_size;
+	u32 block = 0;
+	u16 reg_tmp;
+	int offset, status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_END, F81534_CMD_ENABLE_WR);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, F81534_CMD_PROGRAM);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 16) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 8) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_START, (address >> 0) & 0xff);
+	if (status)
+		return status;
+
+	do {
+		write_size = min_t(u32, F81534_MAX_DATA_BLOCK, size);
+
+		for (count = 0; count < write_size; ++count) {
+			offset = count + block * F81534_MAX_DATA_BLOCK;
+
+			if ((size <= F81534_MAX_DATA_BLOCK)
+					&& (write_size == (count + 1)))
+				reg_tmp = F81534_BUS_REG_END;
+			else
+				reg_tmp = F81534_BUS_REG_START;
+
+			status = f81534_set_normal_register_with_delay(
+						usbserial, reg_tmp,
+						buf[offset]);
+			if (status)
+				return status;
+		}
+
+		size -= write_size;
+		++block;
+	} while (size);
+
+	return 0;
+}
+
+/*
+ * This function maybe cause IC no workable, Please take this carefully.
+ *
+ * The function is used to clear the configuration area of this device
+ * (F81534_CUSTOM_ADDRESS_START). If wrong operation with this function, it'll
+ * make the device malfuncional.
+ */
+static int f81534_erase_sector(struct usb_serial *usbserial, int address)
+{
+	u8 current_status = 0;
+	int status;
+	unsigned int count = F81534_MAX_BUS_RETRY;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_END, F81534_CMD_ENABLE_WR);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+			F81534_BUS_REG_START, F81534_CMD_ERASE);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+			F81534_BUS_REG_START, (address >> 16) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+			F81534_BUS_REG_START, (address >> 8) & 0xff);
+	if (status)
+		return status;
+
+	status = f81534_set_normal_register_with_delay(usbserial,
+			F81534_BUS_REG_END, (address >> 0) & 0xff);
+	if (status)
+		return status;
+
+	while (--count) {
+		status = f81534_set_normal_register_with_delay(usbserial,
+						F81534_BUS_REG_START,
+						F81534_CMD_READ_STATUS);
+		if (status)
+			return status;
+
+		/* dummy write, any value is acceptable */
+		status = f81534_set_normal_register_with_delay(usbserial,
+				F81534_BUS_REG_END, 0xff);
+		if (status)
+			return status;
+
+		status = f81534_get_normal_register_with_delay(usbserial,
+					F81534_BUS_READ_DATA, &current_status);
+		if (status)
+			return status;
+
+		if (!(F81534_MEDIA_BUSY_STATUS & current_status)) {
+			dev_dbg(&usbserial->dev->dev,
+					"%s: data:%x, count:%d, ok\n",
+					__func__, current_status, count);
+			break;
+		}
+	}
+
+	return 0;
+}
+
+static int f81534_prepare_write_buffer(struct usb_serial_port *port,
+					void *dest, size_t size)
+{
+	unsigned char *ptr = (unsigned char *) dest;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	int port_num = port_priv->phy;
+	struct usb_serial *serial = port->serial;
+
+	WARN_ON(size != serial->port[0]->bulk_out_size);
+
+	/*
+	 * The block layout is fixed with 4x128 Bytes, per 128 Bytes
+	 * for a port.
+	 * index 0: port phy idx (e.g., 0,1,2,3)
+	 * index 1: only F81534_TOKEN_WRITE
+	 * index 2: serial out size
+	 * index 3: fix to 0
+	 * index 4~127: serial out data block
+	 */
+	ptr[F81534_RECEIVE_BLOCK_SIZE * 0] = 0;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * 1] = 1;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * 2] = 2;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * 3] = 3;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * port_num + 1] = F81534_TOKEN_WRITE;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * port_num + 3] = 0;
+	ptr[F81534_RECEIVE_BLOCK_SIZE * port_num + 2] =
+		kfifo_out_locked(&port->write_fifo,
+				&ptr[F81534_RECEIVE_BLOCK_SIZE * port_num + 4],
+				F81534_MAX_TX_SIZE, &port->lock);
+
+	return F81534_WRITE_BUFFER_SIZE;
+}
+
+static int f81534_submit_writer(struct usb_serial_port *port, gfp_t mem_flags)
+{
+	struct usb_serial *serial = port->serial;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+	struct tty_struct *tty;
+	struct urb *urb;
+	bool cts_status = true;
+	unsigned long flags;
+	int updating_data, result;
+
+	tty = tty_port_tty_get(&port->port);
+	if (!tty)
+		return 0;
+
+	/* check H/W Flow status */
+	if (C_CRTSCTS(tty)) {
+		spin_lock_irqsave(&port_priv->msr_lock, flags);
+		cts_status = !!(port_priv->shadow_msr & UART_MSR_CTS);
+		spin_unlock_irqrestore(&port_priv->msr_lock, flags);
+	}
+
+	tty_kref_put(tty);
+
+	if (!cts_status)
+		return 0;
+
+	/* someone is changing setting, pause TX */
+	updating_data = mutex_is_locked(&serial_priv->change_mode_mutex);
+	if (updating_data)
+		return 0;
+
+	/* check is any data in write_fifo */
+	spin_lock_irqsave(&port->lock, flags);
+
+	if (kfifo_is_empty(&port->write_fifo)) {
+		spin_unlock_irqrestore(&port->lock, flags);
+		return 0;
+	}
+
+	spin_unlock_irqrestore(&port->lock, flags);
+
+	/* check H/W is TXEMPTY */
+	spin_lock_irqsave(&serial_priv->tx_empty_lock, flags);
+
+	if (serial_priv->is_phy_port_not_empty[port_priv->phy]) {
+		spin_unlock_irqrestore(&serial_priv->tx_empty_lock, flags);
+		return 0;
+	}
+
+	serial_priv->is_phy_port_not_empty[port_priv->phy] = true;
+	spin_unlock_irqrestore(&serial_priv->tx_empty_lock, flags);
+
+	urb = port->write_urbs[0];
+	f81534_prepare_write_buffer(port, port->bulk_out_buffers[0],
+					port->bulk_out_size);
+	urb->transfer_buffer_length = F81534_WRITE_BUFFER_SIZE;
+
+	result = usb_submit_urb(urb, mem_flags);
+	if (result) {
+		dev_err(&port->dev, "%s: submit error, result:%d\n", __func__,
+				result);
+		return result;
+	}
+
+	return 0;
+}
+
+static void f81534_wakeup_all_port(struct usb_serial *serial)
+{
+	int i, status;
+
+	for (i = 0; i < serial->num_ports; ++i) {
+		if (!serial->port[i])
+			continue;
+
+		status = f81534_submit_writer(serial->port[i], GFP_KERNEL);
+		if (status) {
+			dev_err(&serial->port[i]->dev, "%s: submit failed\n",
+					__func__);
+		}
+	}
+}
+
+static int f81534_switch_gpio_mode(struct usb_serial_port *port, u8 mode)
+{
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	int x = port_priv->phy;
+	int y;
+	int val;
+	int status;
+	int idx = (mode > F81534_PIN_SET_MAX) ? F81534_PIN_SET_DEFAULT : mode;
+	struct usb_device *dev = port->serial->dev;
+	const struct io_map_value *request_mode = f81534_mode_control[idx];
+	/* our EVB m0 sometime will print as SD(Shutdown) */
+	const struct pin_data *pins[3] = {&request_mode->port[x].m1,
+						&request_mode->port[x].m2,
+						&request_mode->port[x].m0_sd};
+
+	if (mode > F81534_PIN_SET_MAX)
+		return -EINVAL;
+
+	for (y = 0; y < ARRAY_SIZE(pins); ++y) {
+		val = pins[y]->port_io.reg_bit ? 0xff : 0x00;
+		status = f81534_set_mask_normal_register(dev,
+					pins[y]->port_io.reg_address,
+					BIT(pins[y]->port_io.reg_offset), val);
+		if (status) {
+			dev_err(&port->dev, "%s: failed, index:%d\n", __func__,
+					y);
+			return status;
+		}
+	}
+
+	return 0;
+}
+
+/*
+ * This function could be executed when
+ *	1. Port configuration change. (e.g., UART/GPIO Mode changed)
+ *	2. Old IC or configuration detected.
+ *         During the port probe(), We'll check the current port is final port.
+ *	   If we found a old style configuration value, the
+ *	   f81534_load_configure_data() will transform old to new default
+ *	   setting to RAM, then f81534_save_configure_data() will compare the
+ *	   flash & RAM setting, If not the same, write it with new data with
+ *	   final port probe().
+ */
+static int f81534_save_configure_data(struct usb_serial_port *port)
+{
+	int status;
+	int count;
+	int phy;
+	int gpio_address, uart_address;
+	int offset;
+	bool reConfigure = false;
+	u8 uart_mode, gpio_mode;
+	u8 data[F81534_DEF_CONF_SIZE + 1];
+	u8 tmp[F81534_DEF_CONF_SIZE];
+	enum uart_mode current_mode;
+	struct usb_serial *serial = port->serial;
+	struct f81534_port_private *port_priv;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+
+	/* compare memory with ic data */
+	for (count = 0; count < serial->num_ports; ++count) {
+		port_priv = usb_get_serial_port_data(serial->port[count]);
+
+		if (!port_priv) {
+			dev_err(&port->dev, "%s: port_priv == NULL\n",
+					__func__);
+			continue;
+		}
+
+		phy = port_priv->phy;
+
+		if (serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA) {
+			uart_address = F81534_DEF_CONF_ADDRESS_START + phy;
+			gpio_address = F81534_DEF_CONF_ADDRESS_START + phy +
+							F81534_CONF_SIZE;
+		} else {
+			/*
+			 * if had custom setting, override
+			 * 1st byte is a indicator, 0xff is empty,
+			 * 0xf0 is had data. Skip with 1st data
+			 */
+
+			uart_address = F81534_CUSTOM_ADDRESS_START +
+				serial_priv->setting_idx *
+				F81534_CUSTOM_DATA_SIZE + phy +
+				F81534_CONF_OFFSET;
+
+			gpio_address = F81534_CUSTOM_ADDRESS_START +
+				serial_priv->setting_idx *
+				F81534_CUSTOM_DATA_SIZE + phy +
+				F81534_CONF_SIZE + F81534_CONF_OFFSET;
+		}
+
+		status = f81534_read_data(port->serial, uart_address, 1,
+						&uart_mode);
+		if (status) {
+			dev_err(&port->dev,
+					"%s: read uart data fail. status:%d\n",
+					__func__, status);
+			return status;
+		}
+
+		status = f81534_read_data(port->serial, gpio_address, 1,
+						&gpio_mode);
+		if (status) {
+			dev_err(&port->dev,
+					"%s: read gpio data fail. status:%d\n",
+					__func__, status);
+			return status;
+		}
+
+		if (port_priv->port_pin_data.gpio_mode != gpio_mode)
+			reConfigure = true;
+
+		/* check uart flag */
+		if (port_priv->port_pin_data.force_uart_mode ==
+				uart_mode_rs232) {
+			if ((uart_mode & F81534_MODE_MASK) !=
+					F81534_RS232_FLAG)
+				reConfigure = true;
+		} else if (port_priv->port_pin_data.force_uart_mode ==
+					uart_mode_rs485_1) {
+			if ((uart_mode & F81534_MODE_MASK) !=
+					F81534_RS485_1_FLAG)
+				reConfigure = true;
+		} else if (port_priv->port_pin_data.force_uart_mode ==
+			   uart_mode_rs485) {
+			if ((uart_mode & F81534_MODE_MASK) !=
+					F81534_RS485_FLAG)
+				reConfigure = true;
+		} else {
+			reConfigure = true;
+		}
+
+		if (reConfigure)
+			break;
+	}
+
+	if (serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA) {
+		dev_info(&serial->dev->dev, "%s: force to reconfigure\n",
+					__func__);
+	} else if (!reConfigure) {
+		dev_dbg(&serial->dev->dev, "%s: update-to-date\n", __func__);
+		return 0;
+	}
+
+	dev_info(&serial->dev->dev, "%s: updating\n", __func__);
+
+	/* next setting block */
+	serial_priv->setting_idx =
+			(serial_priv->setting_idx + 1) % F81534_CUSTOM_MAX_IDX;
+	dev_info(&serial->dev->dev, "%s: saving to block index:%d\n", __func__,
+			serial_priv->setting_idx);
+
+	/* erase when start block is 0 */
+	if (!serial_priv->setting_idx) {
+		dev_dbg(&serial->dev->dev, "%s: need erase\n", __func__);
+
+		/* erase */
+		status = f81534_erase_sector(serial,
+					F81534_CUSTOM_ADDRESS_START);
+		if (status) {
+			dev_err(&port->dev,
+					"%s: erase sector failed! status:%d\n",
+					__func__, status);
+			return status;
+		}
+	} else {
+		dev_dbg(&serial->dev->dev,
+				"%s: dont need erase\n", __func__);
+	}
+
+	/* reprogram */
+	for (count = 0; count < serial->num_ports; ++count) {
+		port_priv = usb_get_serial_port_data(serial->port[count]);
+		phy = port_priv->phy;
+		current_mode = port_priv->port_pin_data.force_uart_mode;
+		gpio_mode = port_priv->port_pin_data.gpio_mode;
+
+		serial_priv->default_conf_data[phy + F81534_CONF_SIZE] =
+								gpio_mode;
+		serial_priv->default_conf_data[phy] &= ~(F81534_MODE_MASK);
+
+		/* check uart flag */
+		if (current_mode == uart_mode_rs232) {
+			serial_priv->default_conf_data[phy] |=
+					F81534_RS232_FLAG;
+		} else if (current_mode == uart_mode_rs485_1) {
+			serial_priv->default_conf_data[phy] |=
+					F81534_RS485_1_FLAG;
+		} else if (current_mode == uart_mode_rs485) {
+			serial_priv->default_conf_data[phy] |=
+					F81534_RS485_FLAG;
+		} else {
+			dev_err(&serial->dev->dev,
+					"%s: current_mode error, value:%d\n",
+					__func__, current_mode);
+		}
+
+		dev_info(&serial->dev->dev,
+				"%s: port:%d uart_mode:%x, gpio_mode:%x\n",
+				__func__, count,
+				serial_priv->default_conf_data[phy + 0],
+				gpio_mode);
+	}
+
+	/*
+	 * 1st byte is a indicator, 0xff is empty, 0xf0 is had data
+	 * only write 8 bytes of total 4 port uart & gpio mode
+	 * so we need write 1+8 data
+	 */
+
+	/* token of data exist */
+	data[0] = F81534_CUSTOM_VALID_TOKEN;
+	memcpy(&data[1], serial_priv->default_conf_data, F81534_DEF_CONF_SIZE);
+
+	offset = F81534_CUSTOM_ADDRESS_START +
+			F81534_CUSTOM_DATA_SIZE * serial_priv->setting_idx;
+
+	status = f81534_write_data(serial, offset, sizeof(data), data);
+	if (status) {
+		dev_err(&port->dev,
+				"%s: f81534_write_data failed!! status:%d\n",
+				__func__, status);
+		return status;
+	}
+
+	/* recheck save & memory data */
+	memset(tmp, 0, sizeof(tmp));
+
+	status = f81534_read_data(serial,
+				  F81534_CUSTOM_ADDRESS_START +
+				  F81534_CUSTOM_DATA_SIZE *
+				  serial_priv->setting_idx + 1, sizeof(tmp),
+				  tmp);
+	if (status) {
+		dev_err(&port->dev,
+				"%s: f81534_read_data failed!! status:%d\n",
+				__func__, status);
+		return status;
+	}
+
+	for (count = 0; count < F81534_DEF_CONF_SIZE; ++count) {
+		if (tmp[count] == serial_priv->default_conf_data[count])
+			continue;
+
+		dev_err(&port->dev,
+				"%s:read data error, count:%d, data:%x %x\n",
+				__func__, count, tmp[count],
+				serial_priv->default_conf_data[count]);
+	}
+
+	dev_dbg(&serial->dev->dev, "%s: complete\n", __func__);
+
+	return 0;
+}
+
+#ifdef CONFIG_GPIOLIB
+static int f81534_gpio_get(struct gpio_chip *chip, unsigned gpio_num)
+{
+	struct usb_serial_port *port =
+			container_of(chip->dev, struct usb_serial_port, dev);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	int current_mode;
+	int status;
+
+	status = mutex_lock_killable(&serial_priv->change_mode_mutex);
+	if (status) {
+		dev_err(&port->dev, "%s: interrupted!\n", __func__);
+		return status;
+	}
+
+	current_mode = port_priv->port_pin_data.gpio_mode & BIT(gpio_num);
+
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+
+	return !!current_mode;
+}
+
+static int f81534_gpio_direction_in(struct gpio_chip *chip, unsigned gpio_num)
+{
+	/* always failed */
+	return -EINVAL;
+}
+
+static int f81534_gpio_direction_out(struct gpio_chip *chip,
+				     unsigned gpio_num, int val)
+{
+	/* always successful */
+	return 0;
+}
+
+static void f81534_gpio_set(struct gpio_chip *chip, unsigned gpio_num, int val)
+{
+	struct usb_serial_port *port = container_of(
+			chip->dev, struct usb_serial_port, dev);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	int current_mode;
+	int status;
+
+	status = mutex_lock_killable(&serial_priv->change_mode_mutex);
+	if (status) {
+		dev_err(&port->dev, "%s: interrupted!\n", __func__);
+		return;
+	}
+
+	current_mode = port_priv->port_pin_data.gpio_mode;
+	current_mode &= ~BIT(gpio_num);
+	current_mode |= val ? BIT(gpio_num) : 0;
+
+	status = f81534_switch_gpio_mode(port, current_mode);
+	if (status) {
+		dev_err(&port->dev, "%s: set gpio error!!\n", __func__);
+		goto out;
+	}
+
+	dev_dbg(&port->dev, "%s: num: %d, val:%d\n", __func__, gpio_num, val);
+	port_priv->port_pin_data.gpio_mode = current_mode;
+
+out:
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+}
+
+static int f81534_gpio_get_direction(struct gpio_chip *chip, unsigned offset)
+{
+	/* F81532/534 provide output only output port */
+	return GPIOF_DIR_OUT;
+}
+
+static int f81534_gpio_request(struct gpio_chip *chip, unsigned offset)
+{
+	struct usb_serial_port *port = container_of(chip->dev,
+						struct usb_serial_port, dev);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+
+	/* add current actives gpio */
+	atomic_inc(&port_priv->gpio_active);
+	return 0;
+}
+
+static void f81534_gpio_free(struct gpio_chip *chip, unsigned offset)
+{
+	struct usb_serial_port *port = container_of(chip->dev,
+						struct usb_serial_port, dev);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	int status;
+
+	/* if no current actives gpio, save to IC */
+	if (atomic_dec_return(&port_priv->gpio_active) != 0)
+		return;
+
+	status = mutex_lock_killable(&serial_priv->change_mode_mutex);
+	if (status) {
+		dev_err(&port->dev, "%s: interrupted!\n", __func__);
+		return;
+	}
+
+	f81534_save_configure_data(port);
+
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+}
+
+static struct gpio_chip f81534_gpio_chip_templete = {
+	.owner = THIS_MODULE,
+	.get_direction = f81534_gpio_get_direction,
+	.get = f81534_gpio_get,
+	.direction_input = f81534_gpio_direction_in,
+	.set = f81534_gpio_set,
+	.direction_output = f81534_gpio_direction_out,
+	.request = f81534_gpio_request,
+	.free = f81534_gpio_free,
+	.ngpio = 3, /* M0(SD)/M1/M2 */
+	.base = -1,
+};
+
+static int f81534_prepare_gpio(struct usb_serial_port *port)
+{
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	int max_name = 32;
+	char *name = NULL;
+	int idx = port->minor;
+	int rc;
+
+	name = devm_kzalloc(&port->dev, max_name, GFP_KERNEL);
+	if (!name)
+		return -ENOMEM;
+
+	memcpy(&port_priv->f81534_gpio_chip, &f81534_gpio_chip_templete,
+			sizeof(f81534_gpio_chip_templete));
+
+	snprintf(name, max_name - 1, "%s-%d", IC_NAME, idx);
+
+	port_priv->f81534_gpio_chip.label = name;
+	port_priv->f81534_gpio_chip.dev = &port->dev;
+
+	rc = gpiochip_add(&port_priv->f81534_gpio_chip);
+	if (rc) {
+		dev_err(&port->dev, "%s: f81534_prepare_gpio failed:%d\n",
+				__func__, rc);
+		return rc;
+	}
+
+	return 0;
+}
+
+static int f81534_release_gpio(struct usb_serial_port *port)
+{
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+
+	gpiochip_remove(&port_priv->f81534_gpio_chip);
+	return 0;
+}
+#else
+static int f81534_prepare_gpio(struct usb_serial_port *port)
+{
+	dev_info(&port->dev, "CONFIG_GPIOLIB is not enabled\n");
+	dev_info(&port->dev, "The GPIOLIB interface will not register\n");
+	return 0;
+}
+
+static int f81534_release_gpio(struct usb_serial_port *port)
+{
+	return 0;
+}
+#endif
+
+static int f81534_calc_baud_divisor(u32 baudrate, u32 clockrate, u32 *remain)
+{
+	u32 divisor, rem;
+
+	if (!baudrate)
+		return 0;
+
+	rem = clockrate % baudrate;
+
+	if (remain)
+		*remain = rem;
+
+	/* Round to nearest divisor */
+	divisor = DIV_ROUND_CLOSEST(clockrate, baudrate);
+
+	return divisor;
+}
+
+static int f81534_setregister(struct usb_device *dev, u8 uart, u16 reg,
+				u8 data)
+{
+	return f81534_set_normal_register(dev, reg + uart * 0x10, data);
+}
+
+static int f81534_set_port_config(struct usb_device *dev, u8 port_number,
+					 struct usb_serial_port *port,
+					 u32 baudrate, u16 lcr)
+{
+	struct usb_serial *serial = port->serial;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	u16 device_port = port_priv->phy;
+	u32 divisor;
+	u32 rem, baud_base;
+	int status, count;
+	u8 value;
+	bool is_485_mode = false;
+	bool is_need_invert = false;
+	static u32 const baudrate_table[3] = { 1500000, 1152000, 921600};
+	static u8 const clock_table[3] = { CLKSEL_24_MHZ, CLKSEL_18DOT46_MHZ,
+						CLKSEL_14DOT77_MHZ};
+
+	switch (port_priv->port_pin_data.force_uart_mode) {
+	case uart_mode_rs232:
+	case uart_mode_shutdown:
+	case uart_mode_rs232_coexist:
+	case uart_mode_invalid:
+		break;
+	case uart_mode_rs485:
+		is_need_invert = true;
+	default:
+		is_485_mode = true;
+		break;
+	}
+
+	/*
+	 * This device clock rate is configured by CLK_SEL_REGISTER bit 2~1.
+	 * The following list is the list of clock rate.
+	 *
+	 * bit 2~1 = 00: 1.8461 MHz
+	 * bit 2~1 = 01: 18.461 MHz
+	 * bit 2~1 = 10: 24 MHz
+	 * bit 2~1 = 11: 14.77 MHz
+	 */
+	if (baudrate <= 115200) {
+		/* clock rate fixed 1.8461 MHz when below or equal 115200bps */
+		value = CLKSEL_1DOT846_MHZ;
+		divisor = f81534_calc_baud_divisor(baudrate, 115200, NULL);
+		port_priv->current_baud_base = 115200;
+	} else {
+		/* Higher than 115200bps need calculate suitable clock rate */
+		for (count = 0; count < ARRAY_SIZE(baudrate_table) ; ++count) {
+			baud_base = baudrate_table[count];
+			divisor = f81534_calc_baud_divisor(baudrate, baud_base,
+								&rem);
+			if (!rem) {
+				dev_dbg(&port->dev, "%s: found clockbase %d\n",
+						__func__,
+						baudrate_table[count]);
+				value = clock_table[count];
+				port_priv->current_baud_base = baud_base;
+				break;
+			}
+		}
+
+		if (count >= ARRAY_SIZE(baudrate_table)) {
+			dev_err(&port->dev,
+					"%s: cant find suitable clockbase\n",
+					__func__);
+			return -EINVAL;
+		}
+	}
+
+	value &= ~(F81534_RS485_MODE | F81534_RS485_INVERT);
+	value |= is_485_mode ? F81534_RS485_MODE : 0;
+	value |= is_need_invert ? F81534_RS485_INVERT : 0;
+
+	status = f81534_setregister(serial->dev, device_port, CLK_SEL_REGISTER,
+					value);
+	if (status) {
+		dev_err(&port->dev, "%s: CLK REG setting failed\n", __func__);
+		return status;
+	}
+
+	if (baudrate <= 1200)
+		value = F81534_1X_RXTRIGGER;	/* 128 FIFO & TL: 1x */
+	else
+		value = F81534_8X_RXTRIGGER;	/* 128 FIFO & TL: 8x */
+
+	status = f81534_setregister(serial->dev, device_port, CONFIG1_REGISTER,
+					value);
+	if (status) {
+		dev_err(&port->dev, "%s: CONFIG1 setting failed\n", __func__);
+		return status;
+	}
+
+	if (baudrate <= 1200)
+		value = UART_FCR_TRIGGER_1 | UART_FCR_ENABLE_FIFO; /* TL: 1 */
+	else if (baudrate >= 1152000)
+		value = UART_FCR_R_TRIG_10 | UART_FCR_ENABLE_FIFO; /* TL: 8 */
+	else
+		value = UART_FCR_R_TRIG_11 | UART_FCR_ENABLE_FIFO; /* TL: 14 */
+
+	status = f81534_setregister(serial->dev, device_port,
+					    FIFO_CONTROL_REGISTER, value);
+	if (status) {
+		dev_err(&port->dev, "%s: FCR setting failed\n", __func__);
+		return status;
+	}
+
+	value = UART_LCR_DLAB;
+	status = f81534_setregister(serial->dev, device_port,
+						LINE_CONTROL_REGISTER, value);
+	if (status) {
+		dev_err(&port->dev, "%s: set LCR failed, %d\n", __func__,
+				status);
+		return status;
+	}
+
+	value = divisor & 0xFF;
+	status = f81534_setregister(serial->dev, device_port,
+					DIVISOR_LATCH_LSB, value);
+	if (status) {
+		dev_err(&port->dev, "%s: set DLAB LSB failed, %d\n", __func__,
+				status);
+		return status;
+	}
+
+	value = (divisor >> 8) & 0xFF;
+	status = f81534_setregister(serial->dev, device_port,
+					DIVISOR_LATCH_MSB, value);
+	if (status) {
+		dev_err(&port->dev, "%s: set DLAB MSB failed, %d\n", __func__,
+				status);
+		return status;
+	}
+
+	status = f81534_setregister(serial->dev, device_port,
+						LINE_CONTROL_REGISTER, lcr);
+	if (status) {
+		dev_err(&port->dev, "%s: set LCR failed, %d\n", __func__,
+				status);
+		return status;
+	}
+
+	return 0;
+}
+
+static int f81534_getregister(struct usb_device *dev, u8 uart, u16 reg,
+				u8 *data)
+{
+	return f81534_get_normal_register(dev, reg + uart * 0x10, data);
+}
+
+static int f81534_update_mctrl(struct usb_serial_port *port, unsigned int set,
+				unsigned int clear)
+{
+	struct usb_device *dev = port->serial->dev;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	u8 tmp;
+	int status;
+
+	status = mutex_lock_killable(&port_priv->msr_mutex);
+	if (status) {
+		dev_info(&port->dev, "%s: interrupted!\n", __func__);
+		return status;
+	}
+
+	if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
+		dev_dbg(&dev->dev, "%s -DTR|RTS not being set|cleared\n",
+				__func__);
+		mutex_unlock(&port_priv->msr_mutex);
+		return 0;	/* no change */
+	}
+
+	/* 'set' takes precedence over 'clear' */
+	clear &= ~set;
+
+	/* always enable UART_MCR_OUT2 */
+	tmp = UART_MCR_OUT2 | port_priv->shadow_mcr;
+
+	if (clear & TIOCM_DTR) {
+		tmp &= ~UART_MCR_DTR;
+		dev_dbg(&dev->dev, "%s: port:%d clear DTR\n", __func__,
+				port_priv->phy);
+	}
+
+	if (clear & TIOCM_RTS) {
+		tmp &= ~UART_MCR_RTS;
+		dev_dbg(&dev->dev, "%s: port:%d clear RTS\n", __func__,
+				port_priv->phy);
+
+	}
+
+	if (set & TIOCM_DTR) {
+		tmp |= UART_MCR_DTR;
+		dev_dbg(&dev->dev, "%s: port:%d set DTR\n", __func__,
+				port_priv->phy);
+
+	}
+
+	if (set & TIOCM_RTS) {
+		tmp |= UART_MCR_RTS;
+		dev_dbg(&dev->dev, "%s: port:%d set RTS\n", __func__,
+				port_priv->phy);
+	}
+
+	status = f81534_setregister(dev, port_priv->phy,
+					MODEM_CONTROL_REGISTER, tmp);
+	if (status < 0) {
+		dev_err(&port->dev, "%s- Error from MODEM_CTRL URB: %i\n",
+				__func__, status);
+		mutex_unlock(&port_priv->msr_mutex);
+		return status;
+	}
+
+	port_priv->shadow_mcr = tmp;
+	mutex_unlock(&port_priv->msr_mutex);
+	return 0;
+}
+
+/*
+ * This function will search the data area with token F81534_CUSTOM_VALID_TOKEN
+ * for latest configuration index. If nothing found (*index = -1), the caller
+ * will load default configure in F81534_DEF_CONF_ADDRESS_START section
+ */
+static int f81534_find_config_idx(struct usb_serial *serial, uintptr_t *index)
+{
+	int idx, status;
+	u8 custom_data;
+	int offset;
+
+	for (idx = F81534_CUSTOM_MAX_IDX - 1; idx >= 0; --idx) {
+		offset = F81534_CUSTOM_ADDRESS_START +
+					F81534_CUSTOM_DATA_SIZE * idx;
+		status = f81534_read_data(serial, offset, 1, &custom_data);
+		if (status) {
+			dev_err(&serial->dev->dev,
+					"%s: read error, idx:%d, status:%d\n",
+					__func__, idx, status);
+			return status;
+		}
+
+		/*
+		 * if had custom setting, override
+		 * 1st byte is a indicator, 0xff is empty, 0xf0 is had data
+		 */
+
+		/* found */
+		if (custom_data == F81534_CUSTOM_VALID_TOKEN)
+			break;
+	}
+
+	*index = idx;
+	return 0;
+}
+
+static int f81534_calc_num_ports(struct usb_serial *serial)
+{
+	uintptr_t setting_idx;
+	int i;
+	u8 num_port = 0;
+	int status;
+	unsigned char setting[F81534_CUSTOM_DATA_SIZE + 1];
+
+	/* check had custom setting */
+	status = f81534_find_config_idx(serial, &setting_idx);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: f81534_find_config_idx read failed!!\n",
+				__func__);
+		return 0;
+	}
+
+	/* Save the configuration area idx as private data for attach() */
+	usb_set_serial_data(serial, (void *) setting_idx);
+
+	/* read default board setting */
+	status = f81534_read_data(serial, F81534_DEF_CONF_ADDRESS_START,
+				  F81534_NUM_PORT, setting);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: f81534_read_data read failed!!\n",
+				__func__);
+		return 0;
+	}
+
+	/*
+	 * if had custom setting, override it.
+	 * 1st byte is a indicator, 0xff is empty, F81534_CUSTOM_VALID_TOKEN
+	 * is had data, then skip with 1st data
+	 */
+	if (setting_idx != F81534_CUSTOM_NO_CUSTOM_DATA) {
+		status = f81534_read_data(serial,
+					  F81534_CUSTOM_ADDRESS_START +
+					  F81534_CUSTOM_DATA_SIZE *
+					  setting_idx + 1, sizeof(setting),
+					  setting);
+		if (status) {
+			dev_err(&serial->dev->dev,
+					"%s: get custom data failed!!\n",
+					__func__);
+			return 0;
+		}
+
+		dev_info(&serial->dev->dev,
+				"%s: read configure from block:%d\n", __func__,
+				(int) setting_idx);
+	} else {
+		dev_info(&serial->dev->dev, "%s: read configure default\n",
+				__func__);
+	}
+
+	for (i = 0; i < F81534_NUM_PORT; ++i) {
+		/*
+		 * For older configuration use. We'll transform it to newer
+		 * setting after load it with final port probed.
+		 */
+		switch (setting[i]) {
+		case F81534_OLD_CONFIG_37:
+		case F81534_OLD_CONFIG_38:
+		case F81534_OLD_CONFIG_39:
+			++num_port;
+			break;
+		}
+	}
+
+	if (num_port) {
+		dev_dbg(&serial->dev->dev, "%s: old style with %d ports",
+				__func__, num_port);
+		return num_port;
+	}
+
+	/* new style, find all possible ports */
+	num_port = 0;
+	for (i = 0; i < F81534_NUM_PORT; ++i) {
+		if (setting[i] & F81534_PORT_UNAVAILABLE)
+			continue;
+
+		++num_port;
+	}
+
+	if (num_port)
+		return num_port;
+
+	dev_err(&serial->dev->dev, "Read Failed!!, default 4 ports\n");
+	return 4;		/* nothing found, oldest version IC */
+}
+
+static void f81534_set_termios(struct tty_struct *tty,
+				struct usb_serial_port *port,
+				struct ktermios *old_termios)
+{
+	struct usb_device *dev = port->serial->dev;
+	struct f81534_port_private *port_priv;
+	u32 baud;
+	u16 new_lcr = 0;
+	int status;
+
+	port_priv = usb_get_serial_port_data(port);
+
+	if (C_BAUD(tty) == B0)
+		f81534_update_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
+	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
+		f81534_update_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
+
+	if (C_PARENB(tty)) {
+		new_lcr |= UART_LCR_PARITY;
+
+		if (!C_PARODD(tty))
+			new_lcr |= UART_LCR_EPAR;
+
+		if (C_CMSPAR(tty))
+			new_lcr |= UART_LCR_SPAR;
+	}
+
+	if (C_CSTOPB(tty))
+		new_lcr |= UART_LCR_STOP;
+
+	switch (C_CSIZE(tty)) {
+	case CS5:
+		new_lcr |= UART_LCR_WLEN5;
+		break;
+	case CS6:
+		new_lcr |= UART_LCR_WLEN6;
+		break;
+	case CS7:
+		new_lcr |= UART_LCR_WLEN7;
+		break;
+	default:
+	case CS8:
+		new_lcr |= UART_LCR_WLEN8;
+		break;
+	}
+
+	baud = tty_get_baud_rate(tty);
+
+	if (baud) {
+		/* Our device is not support for 1Mbps baudrate */
+		if ((baud == 1000000) || (baud > F81534_MAX_BAUDRATE)) {
+			if (old_termios)
+				baud = old_termios->c_ospeed;
+			else
+				baud = F81534_DEFAULT_BAUD_RATE;
+		}
+
+		dev_dbg(&dev->dev, "%s-baud: %d\n", __func__, baud);
+		tty_encode_baud_rate(tty, baud, baud);
+
+		port_priv->current_baud_rate = baud;
+	}
+
+	port_priv->shadow_lcr = new_lcr;
+	status = f81534_set_port_config(dev, port_priv->phy, port,
+					port_priv->current_baud_rate, new_lcr);
+	if (status < 0)
+		dev_err(&port->dev, "%s - f81534_set_port_config failed: %i\n",
+				__func__, status);
+
+	/* Re-Enable writer for to check H/W flow Control */
+	status = f81534_submit_writer(port, GFP_KERNEL);
+	if (status)
+		dev_err(&port->dev, "%s: submit failed\n", __func__);
+}
+
+static int f81534_open(struct tty_struct *tty, struct usb_serial_port *port)
+{
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	int phy = port_priv->phy;
+
+	if (tty)
+		f81534_set_termios(tty, port, &tty->termios);
+
+	atomic_inc(&serial_priv->port_active[phy]);
+	return 0;
+}
+
+static void f81534_close(struct usb_serial_port *port)
+{
+	int i;
+	unsigned long flags;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	int phy = port_priv->phy;
+
+	atomic_dec(&serial_priv->port_active[phy]);
+
+	/* referenced from usb_serial_generic_close() */
+	for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
+		usb_kill_urb(port->write_urbs[i]);
+
+	spin_lock_irqsave(&port->lock, flags);
+	kfifo_reset_out(&port->write_fifo);
+	spin_unlock_irqrestore(&port->lock, flags);
+}
+
+static void f81534_release(struct usb_serial *serial)
+{
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+
+	kfree(serial_priv);
+}
+
+static int f81534_get_serial_info(struct usb_serial_port *port,
+				  struct serial_struct __user *retinfo)
+{
+	struct serial_struct tmp;
+	struct f81534_port_private *port_priv;
+
+	port_priv = usb_get_serial_port_data(port);
+	if (!port_priv)
+		return -EFAULT;
+
+	if (!retinfo)
+		return -EFAULT;
+
+	memset(&tmp, 0, sizeof(tmp));
+
+	tmp.type = PORT_16550A;
+	tmp.port = port->port_number;
+	tmp.line = port->minor;
+	tmp.baud_base = port_priv->current_baud_base;
+
+	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
+		return -EFAULT;
+
+	return 0;
+}
+
+static int f81534_set_port_mode(struct usb_serial_port *port,
+		enum uart_mode eMode)
+{
+	int status;
+	u8 tmp;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (eMode > uart_mode_invalid)
+		return -EINVAL;
+
+	if (eMode != uart_mode_invalid) {
+		status = f81534_getregister(port->serial->dev, port_priv->phy,
+						CLK_SEL_REGISTER, &tmp);
+		if (status)
+			return status;
+
+		tmp &= ~(F81534_RS485_MODE | F81534_RS485_INVERT);
+
+		switch (port_priv->port_pin_data.force_uart_mode) {
+		case uart_mode_rs232:
+		case uart_mode_shutdown:
+		case uart_mode_rs232_coexist:
+			break;
+
+		case uart_mode_rs485:
+			tmp |= (F81534_RS485_MODE | F81534_RS485_INVERT);
+			dev_dbg(&port->dev, "%s: uart_mode_rs485 URB:%x\n",
+					__func__, tmp);
+			break;
+
+		default:
+			tmp |= F81534_RS485_MODE;
+			dev_dbg(&port->dev, "%s others URB:%x\n",
+					__func__, tmp);
+			break;
+
+		}
+
+		status = f81534_setregister(port->serial->dev, port_priv->phy,
+						CLK_SEL_REGISTER, tmp);
+		if (status)
+			return status;
+	}
+
+	port_priv->port_pin_data.force_uart_mode = eMode;
+	return 0;
+}
+
+static int f81534_ioctl_set_rs485(struct usb_serial_port *port,
+					struct serial_rs485 __user *arg)
+{
+
+	struct serial_rs485 data;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	struct usb_device *usb_dev = port->serial->dev;
+	u16 device_port = port_priv->phy;
+	int status;
+
+	status = mutex_lock_killable(&serial_priv->change_mode_mutex);
+	if (status) {
+		dev_info(&port->dev, "%s: interrupted!\n", __func__);
+		return status;
+	}
+
+	status = copy_from_user(&data, (struct serial_rs485 __user *)arg,
+				sizeof(data));
+	if (status) {
+		status = -EFAULT;
+		goto finish;
+	}
+
+	if (data.flags & SER_RS485_ENABLED) {
+		if (data.flags & SER_RS485_RTS_ON_SEND) {
+			dev_dbg(&port->dev, "%s: uart_mode_rs485_1\n",
+					__func__);
+			port_priv->port_pin_data.force_uart_mode =
+					uart_mode_rs485_1;
+		} else {
+			dev_dbg(&port->dev, "%s: uart_mode_rs485\n", __func__);
+			port_priv->port_pin_data.force_uart_mode =
+					uart_mode_rs485;
+		}
+	} else {
+		dev_dbg(&port->dev, "%s: uart_mode_rs232\n", __func__);
+		port_priv->port_pin_data.force_uart_mode = uart_mode_rs232;
+	}
+
+	status = f81534_set_port_config(usb_dev, device_port, port,
+					port_priv->current_baud_rate,
+					port_priv->shadow_lcr);
+	if (status) {
+		dev_err(&usb_dev->dev, "%s: set port error!!\n", __func__);
+		goto finish;
+	}
+
+	status = f81534_save_configure_data(port);
+
+finish:
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+
+	return status;
+}
+
+static int f81534_ioctl_get_rs485(struct usb_serial_port *port,
+					struct serial_rs485 __user *arg)
+{
+	int status;
+	struct serial_rs485 data;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+
+	status = mutex_lock_killable(&serial_priv->change_mode_mutex);
+	if (status) {
+		dev_info(&port->dev, "%s: interrupted!\n", __func__);
+		return status;
+	}
+
+	memset(&data, 0, sizeof(data));
+
+	switch (port_priv->port_pin_data.force_uart_mode) {
+	case uart_mode_rs485:
+		dev_dbg(&port->dev, "%s: uart_mode_rs485\n", __func__);
+		data.flags = SER_RS485_ENABLED;
+		break;
+	case uart_mode_rs485_1:
+		dev_dbg(&port->dev, "%s: uart_mode_rs485_1\n", __func__);
+		data.flags = SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND;
+		break;
+	default:
+		dev_dbg(&port->dev, "%s: uart_mode_rs232\n", __func__);
+		break;
+	}
+
+	if (copy_to_user((struct serial_rs485 *)arg, &data,
+			sizeof(struct serial_rs485)))
+		status = -EFAULT;
+
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+
+	return status;
+}
+
+static int f81534_ioctl(struct tty_struct *tty, unsigned int cmd,
+			unsigned long arg)
+{
+	struct usb_serial_port *port = tty->driver_data;
+
+	switch (cmd) {
+	case TIOCGRS485:
+		return f81534_ioctl_get_rs485(port,
+						(struct serial_rs485 __user *)
+						arg);
+
+	case TIOCSRS485:
+		return f81534_ioctl_set_rs485(port,
+						(struct serial_rs485 __user *)
+						arg);
+
+	case TIOCGSERIAL:
+		return f81534_get_serial_info(port,
+						(struct serial_struct __user *)
+						arg);
+	default:
+		break;
+	}
+
+	return -ENOIOCTLCMD;
+}
+
+static void f81534_compare_msr(struct usb_serial_port *port, u8 msr,
+				bool is_port_open)
+{
+	u8 old_msr;
+	struct tty_struct *tty = NULL;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	unsigned long flags;
+	int status;
+
+	if (!(msr & UART_MSR_ANY_DELTA))
+		return;
+
+	spin_lock_irqsave(&port_priv->msr_lock, flags);
+	old_msr = port_priv->shadow_msr;
+	port_priv->shadow_msr = msr;
+	spin_unlock_irqrestore(&port_priv->msr_lock, flags);
+
+	if ((msr & (UART_MSR_CTS | UART_MSR_DCTS)) ==
+			(UART_MSR_CTS | UART_MSR_DCTS)) {
+		/* CTS changed, wakeup writer to re-check flow control */
+		if (is_port_open) {
+			status = f81534_submit_writer(port, GFP_ATOMIC);
+			if (status) {
+				dev_err(&port->dev, "%s: submit failed\n",
+						__func__);
+			}
+		}
+		dev_dbg(&port->dev, "%s: CTS Flag changed, value: %x\n",
+				__func__, !!(msr & UART_MSR_CTS));
+	}
+
+	dev_dbg(&port->dev, "%s: MSR from %02x to %02x\n", __func__, old_msr,
+			msr);
+
+	if (!is_port_open)
+		return;
+
+	/* update input line counters */
+	if (msr & UART_MSR_DCTS)
+		port->icount.cts++;
+	if (msr & UART_MSR_DDSR)
+		port->icount.dsr++;
+	if (msr & UART_MSR_DDCD)
+		port->icount.dcd++;
+	if (msr & UART_MSR_TERI)
+		port->icount.rng++;
+
+	wake_up_interruptible(&port->port.delta_msr_wait);
+
+	if (!(msr & UART_MSR_DDCD))
+		return;
+
+	dev_dbg(&port->dev, "%s: DCD Changed: port %d from %x to %x.\n",
+			__func__, port_priv->phy, old_msr, msr);
+
+	tty = tty_port_tty_get(&port->port);
+	if (!tty)
+		return;
+
+	usb_serial_handle_dcd_change(port, tty, msr & UART_MSR_DCD);
+	tty_kref_put(tty);
+}
+
+static void f81534_process_per_serial_block(struct usb_serial_port *port,
+		unsigned char *data)
+{
+	u8 lsr;
+	char tty_flag;
+	struct usb_serial *serial = port->serial;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+	int status;
+	int phy_port_num = data[0];
+	int read_size = 0;
+	int i;
+	unsigned long flags;
+	bool available = !!atomic_read(
+				&serial_priv->port_active[phy_port_num]);
+
+	/*
+	 * The block layout is 128 Bytes
+	 * index 0: port phy idx (e.g., 0,1,2,3),
+	 * index 1: It's could be
+	 *			F81534_TOKEN_RECEIVE
+	 *			F81534_TOKEN_TX_EMPTY
+	 *			F81534_TOKEN_MSR_CHANGE
+	 * index 2: serial in size (data+lsr, must be even)
+	 *			meaningful for F81534_TOKEN_RECEIVE only
+	 * index 3: current MSR with device read
+	 * index 4~127: serial in data block (data+lsr, must be even)
+	 */
+	switch (data[1]) {
+	case F81534_TOKEN_TX_EMPTY:
+		/*
+		 * We should record TX_EMPTY flag even the port is not opened
+		 */
+		spin_lock_irqsave(&serial_priv->tx_empty_lock, flags);
+		serial_priv->is_phy_port_not_empty[phy_port_num] = false;
+		spin_unlock_irqrestore(&serial_priv->tx_empty_lock, flags);
+		usb_serial_port_softint(port);
+		break;
+
+	case F81534_TOKEN_MSR_CHANGE:
+		/*
+		 * We'll save MSR value when device reported even when port
+		 * is not opened. If the port is not opened, the MSR will only
+		 * recorded without any future process.
+		 */
+		f81534_compare_msr(port, data[3], available);
+		break;
+
+	case F81534_TOKEN_RECEIVE:
+		read_size = data[2];
+		break;
+
+	default:
+		dev_warn(&port->dev, "%s: unknown token:%02x\n", __func__,
+				data[1]);
+		return;
+	}
+
+	/* if the port not had open, dont do future process */
+	if (!available)
+		return;
+
+	/* Wakeup writer workqueue only when port is opened */
+	if (data[1] == F81534_TOKEN_TX_EMPTY) {
+		status = f81534_submit_writer(port, GFP_ATOMIC);
+		if (status)
+			dev_err(&port->dev, "%s: submit failed\n", __func__);
+	}
+
+	if (data[1] != F81534_TOKEN_RECEIVE)
+		return;
+
+	for (i = 4; i < 4 + read_size; i += 2) {
+		tty_flag = TTY_NORMAL;
+		lsr = data[i + 1];
+
+		if (lsr & UART_LSR_BRK_ERROR_BITS) {
+			if (lsr & UART_LSR_BI) {
+				tty_flag = TTY_BREAK;
+				port->icount.brk++;
+				usb_serial_handle_break(port);
+			} else if (lsr & UART_LSR_PE) {
+				tty_flag = TTY_PARITY;
+				port->icount.parity++;
+			} else if (lsr & UART_LSR_FE) {
+				tty_flag = TTY_FRAME;
+				port->icount.frame++;
+			}
+
+			if (lsr & UART_LSR_OE) {
+				port->icount.overrun++;
+				tty_insert_flip_char(&port->port, 0,
+						TTY_OVERRUN);
+			}
+		}
+
+		if (port->port.console && port->sysrq) {
+			if (usb_serial_handle_sysrq_char(port, data[i]))
+				continue;
+		}
+
+		tty_insert_flip_char(&port->port, data[i], tty_flag);
+	}
+
+	tty_flip_buffer_push(&port->port);
+}
+
+static void f81534_process_read_urb(struct urb *urb)
+{
+	int i;
+	int phy_port_num;
+	int tty_port_num;
+	unsigned char *ch;
+	struct usb_serial *serial;
+	struct usb_serial_port *port = NULL;
+	struct f81534_port_private *port_priv = NULL;
+
+	if (!urb->actual_length)
+		return;
+
+	port = urb->context;
+	serial = port->serial;
+	ch = urb->transfer_buffer;
+
+	for (i = 0; i < urb->actual_length; i += F81534_RECEIVE_BLOCK_SIZE) {
+		phy_port_num = ch[i];
+		tty_port_num = f81534_phy_to_logic_port(serial, phy_port_num);
+		port = serial->port[tty_port_num];
+
+		/*
+		 * The device will send back all information when we submitted
+		 * a read URB (MSR/DATA/TX_EMPTY). But it maybe get callback
+		 * before port_probe() or after port_remove().
+		 *
+		 * So we'll verify the pointer. If the pointer is NULL, it's
+		 * mean the port not init complete and the block will skip.
+		 */
+		port_priv = usb_get_serial_port_data(port);
+		if (!port_priv) {
+			dev_warn(&serial->dev->dev,
+					"%s: phy: %d not ready!\n", __func__,
+					phy_port_num);
+			continue;
+		}
+
+		f81534_process_per_serial_block(port, &ch[i]);
+	}
+}
+
+static void f81534_write_usb_callback(struct urb *urb)
+{
+	struct usb_serial_port *port = urb->context;
+	int status = urb->status;
+
+	if (status) {
+		dev_warn(&port->dev, "%s - non-zero URB status: %d\n",
+				__func__, status);
+	} else {
+		usb_serial_port_softint(port);
+	}
+}
+
+static int f81534_setup_urbs(struct usb_serial *serial)
+{
+	int i = 0;
+	u8 port0_out_address;
+	int j;
+	int buffer_size;
+	struct usb_serial_port *port = NULL;
+
+	/*
+	 * In our system architecture, we had 4 or 2 serial ports,
+	 * but only get 1 set of bulk in/out endpoints.
+	 *
+	 * The usb-serial subsystem will generate port 0 data,
+	 * but port 1/2/3 will not. It's will generate write URB and buffer
+	 * by following code
+	 */
+	for (i = 1; i < serial->num_ports; ++i) {
+		port0_out_address = serial->port[0]->bulk_out_endpointAddress;
+		buffer_size = serial->port[0]->bulk_out_size;
+		port = serial->port[i];
+
+		if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
+			goto failed;
+
+		port->bulk_out_size = buffer_size;
+		port->bulk_out_endpointAddress = port0_out_address;
+
+		for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j) {
+			set_bit(j, &port->write_urbs_free);
+
+			port->write_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
+			if (!port->write_urbs[j])
+				goto failed;
+
+			port->bulk_out_buffers[j] = kmalloc(buffer_size,
+								GFP_KERNEL);
+			if (!port->bulk_out_buffers[j])
+				goto failed;
+
+			usb_fill_bulk_urb(port->write_urbs[j], serial->dev,
+					usb_sndbulkpipe(serial->dev,
+						port0_out_address),
+					port->bulk_out_buffers[j], buffer_size,
+					serial->type->write_bulk_callback,
+					port);
+		}
+
+		port->write_urb = port->write_urbs[0];
+		port->bulk_out_buffer = port->bulk_out_buffers[0];
+	}
+
+	return 0;
+failed:
+	return -ENOMEM;
+}
+
+static int f81534_submit_read_urb(struct usb_serial *serial, gfp_t mem_flags)
+{
+	int status;
+
+	status = usb_serial_generic_submit_read_urbs(serial->port[0],
+				mem_flags);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: submit read URB failed!! status:%d!!\n",
+				__func__, status);
+		return status;
+	}
+
+	return 0;
+}
+
+static int f81534_load_configure_data(struct usb_serial_port *port)
+{
+	int status;
+	int offset;
+	u8 uart_flag, gpio_mode;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(port->serial);
+	int device_port = port_priv->phy;
+
+	uart_flag = serial_priv->default_conf_data[device_port];
+	gpio_mode = serial_priv->default_conf_data[device_port +
+							F81534_CONF_SIZE];
+
+	switch (uart_flag) {
+	/*
+	 * For older configuration use. We'll transform it to newer setting
+	 * after load it with final port probed.
+	 */
+	case F81534_OLD_CONFIG_37:
+	case F81534_OLD_CONFIG_38:
+	case F81534_OLD_CONFIG_39:
+		offset = device_port + F81534_CONF_SIZE;
+		serial_priv->default_conf_data[device_port] =
+							F81534_RS232_FLAG;
+		gpio_mode = serial_priv->default_conf_data[offset] =
+							F81534_PIN_SET_DEFAULT;
+		port_priv->port_pin_data.force_uart_mode = uart_mode_rs232;
+		port_priv->port_pin_data.gpio_mode = F81534_PIN_SET_DEFAULT;
+		dev_info(&port->dev, "transceiver setting need upgrading\n");
+		break;
+
+	/* MP style setting */
+	default:
+		if (uart_flag & F81534_PORT_CONF_RS485) {
+			if (uart_flag & F81534_PORT_CONF_RS485_INVERT)
+				port_priv->port_pin_data.force_uart_mode =
+						uart_mode_rs485;
+			else
+				port_priv->port_pin_data.force_uart_mode =
+						uart_mode_rs485_1;
+		} else {
+			port_priv->port_pin_data.force_uart_mode =
+					uart_mode_rs232;
+		}
+
+		break;
+	}
+
+	if ((gpio_mode >= F81534_PIN_SET_MIN) &&
+			(gpio_mode <= F81534_PIN_SET_MAX)) {
+		port_priv->port_pin_data.gpio_mode = gpio_mode;
+		dev_dbg(&port->dev, "gpio set to %d\n", gpio_mode);
+	} else {
+		port_priv->port_pin_data.gpio_mode = F81534_PIN_SET_DEFAULT;
+		dev_info(&port->dev, "unknown gpio %d, setting to %d\n",
+				gpio_mode, F81534_PIN_SET_DEFAULT);
+	}
+
+	status =
+	    f81534_switch_gpio_mode(port, port_priv->port_pin_data.gpio_mode);
+	if (status) {
+		dev_err(&port->dev,
+				"%s: switch gpio mode failed!! status:%d\n",
+				__func__, status);
+		return status;
+	}
+
+	return 0;
+}
+
+static void dump_configure(struct usb_serial *serial)
+{
+	unsigned char transceiver, mode;
+	int count;
+	int index;
+	int gpio_address, uart_address;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+
+	index = serial_priv->setting_idx;
+
+	for (count = 0; count < 4; ++count) {
+		if (index == F81534_CUSTOM_NO_CUSTOM_DATA) {
+			uart_address = F81534_DEF_CONF_ADDRESS_START + count;
+			gpio_address = F81534_DEF_CONF_ADDRESS_START + count +
+						F81534_CONF_SIZE;
+		} else {
+
+			/*
+			 * if had custom setting, override
+			 * 1st byte is a indicator.
+			 * 0xff is empty, 0xf0 is had data.
+			 * read and skip with 1st data.
+			 */
+
+			uart_address = F81534_CUSTOM_ADDRESS_START +
+					F81534_CUSTOM_DATA_SIZE * index +
+					count + F81534_CONF_OFFSET;
+
+			gpio_address = F81534_CUSTOM_ADDRESS_START +
+					F81534_CUSTOM_DATA_SIZE * index +
+					count + F81534_CONF_SIZE +
+					F81534_CONF_OFFSET;
+		}
+
+		f81534_read_data(serial, uart_address, 1, &transceiver);
+		f81534_read_data(serial, gpio_address, 1, &mode);
+
+		dev_info(&serial->dev->dev,
+				"%s: port:%d uart_flag:%x gpio:%x\n", __func__,
+				count, transceiver, mode);
+	}
+}
+
+static int f81534_attach(struct usb_serial *serial)
+{
+	struct f81534_serial_private *serial_priv = NULL;
+	int status;
+	int i;
+	int offset;
+	uintptr_t setting_idx = (uintptr_t) usb_get_serial_data(serial);
+
+	serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
+	if (!serial_priv)
+		return -ENOMEM;
+
+	usb_set_serial_data(serial, serial_priv);
+	serial_priv->setting_idx = setting_idx;
+
+	for (i = 0; i < F81534_NUM_PORT; ++i)
+		atomic_set(&serial_priv->port_active[i], 0);
+
+	spin_lock_init(&serial_priv->tx_empty_lock);
+	mutex_init(&serial_priv->change_mode_mutex);
+
+	status = f81534_setup_urbs(serial);
+	if (status)
+		goto failed;
+
+	/*
+	 * The configuration layout:
+	 *	byte 0/1/2/3: uart setting
+	 *	byte 4/5/6/7: gpio setting
+	 *
+	 * We can reference from f81534_load_configure_data().
+	 */
+	status = f81534_read_data(serial, F81534_DEF_CONF_ADDRESS_START,
+				F81534_DEF_CONF_SIZE,
+				serial_priv->default_conf_data);
+	if (status) {
+		dev_err(&serial->dev->dev, "%s read reserve data failed\n",
+				__func__);
+		goto failed;
+	}
+
+	/*
+	 * if had custom setting, override
+	 * 1st byte is a indicator, 0xff is empty, 0xf0 is had data
+	 * skip with 1st data
+	 *
+	 * if serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA
+	 * it's mean for no configuration is custom section, so we'll use
+	 * default config read from F81534_DEF_CONF_ADDRESS_START
+	 */
+	if (serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA)
+		return 0;
+
+	offset = F81534_CUSTOM_ADDRESS_START +
+			F81534_CUSTOM_DATA_SIZE * serial_priv->setting_idx + 1;
+	/* only read 8 bytes for mode & GPIO */
+	status = f81534_read_data(serial, offset,
+					sizeof(serial_priv->default_conf_data),
+					serial_priv->default_conf_data);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: get data failed, idx:%d, status:%d!!\n",
+				__func__, serial_priv->setting_idx, status);
+		goto failed;
+	}
+
+	/*
+	 * We'll register port 0 bulkin only once, It'll take all port received
+	 * data, MSR register change and TX_EMPTY information.
+	 */
+	status = f81534_submit_read_urb(serial, GFP_KERNEL);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: submit read URB failed!! status:%d!!\n",
+				__func__, status);
+		goto failed;
+	}
+
+	return 0;
+failed:
+	kfree(serial_priv);
+	return status;
+}
+
+static int f81534_init_msr(struct usb_serial_port *port)
+{
+	int status;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct usb_serial *serial = port->serial;
+	unsigned long flags;
+	int phy = port_priv->phy;
+	u8 msr;
+
+	/* Get MSR initial value*/
+	status = f81534_getregister(serial->dev, phy, MODEM_STATUS_REGISTER,
+					&msr);
+	if (status)
+		return status;
+
+	spin_lock_irqsave(&port_priv->msr_lock, flags);
+	port_priv->shadow_msr = msr;
+	spin_unlock_irqrestore(&port_priv->msr_lock, flags);
+	return 0;
+}
+
+static int f81534_port_probe(struct usb_serial_port *port)
+{
+	struct usb_serial *serial = port->serial;
+	struct f81534_serial_private *serial_priv =
+			usb_get_serial_data(serial);
+	struct f81534_port_private *port_priv = NULL;
+	int status, i, count = 0;
+	int port_index = f81534_port_index(port);
+
+	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
+	if (!port_priv)
+		return -ENOMEM;
+
+	atomic_set(&port_priv->gpio_active, 0);
+	spin_lock_init(&port_priv->msr_lock);
+	mutex_init(&port_priv->msr_mutex);
+
+	/* assign logic-to-phy mapping */
+	port_priv->phy = F81534_UNUSED_PORT;
+
+	for (i = 0; i < F81534_NUM_PORT; ++i) {
+		if (serial_priv->default_conf_data[i] &
+				F81534_PORT_UNAVAILABLE)
+			continue;
+
+		if (port_index == count) {
+			port_priv->phy = i;
+			break;
+		}
+
+		++count;
+	}
+
+	if (port_priv->phy == F81534_UNUSED_PORT) {
+		status = -ENODEV;
+		goto port_fail;
+	}
+
+	usb_set_serial_port_data(port, port_priv);
+	dev_dbg(&port->dev, "%s: mapping to phy: %d\n", __func__,
+			port_priv->phy);
+
+	/*
+	 * We'll read MSR reg only with port_porbe() for initial once, then
+	 * the MSR will received from read URB with token
+	 * F81534_TOKEN_MSR_CHANGE when MSR is changed.
+	 */
+	status = f81534_init_msr(port);
+	if (status)
+		goto port_fail;
+
+	status = f81534_prepare_gpio(port);
+	if (status)
+		goto port_fail;
+
+	status = f81534_load_configure_data(port);
+	if (status)
+		goto port_fail;
+
+	/*
+	 * Driver will compare memory & flash configure. If it not the same,
+	 * We'll save it when final port probed.
+	 */
+	if ((serial->num_ports - 1) == f81534_port_index(port)) {
+		f81534_save_configure_data(port);
+		dump_configure(serial);
+	}
+
+	status = f81534_set_port_mode(port,
+				port_priv->port_pin_data.force_uart_mode);
+	if (status < 0) {
+		dev_err(&port->dev, "%s: initial setup failed phy: (%i)\n",
+				__func__, port_priv->phy);
+		goto port_fail;
+	}
+
+	return 0;
+port_fail:
+	dev_err(&port->dev, "%s: failed, %d\n", __func__, status);
+	kfree(port_priv);
+	return status;
+}
+
+static int f81534_port_remove(struct usb_serial_port *port)
+{
+	int i;
+	struct f81534_port_private *port_priv;
+	struct usb_serial *serial = port->serial;
+	struct usb_serial_port *port0 = serial->port[0];
+
+	/*
+	 * Cancel "port0" read URB to avoid reference to a freed pointer on
+	 * f81534_process_read_urb()
+	 */
+	for (i = 0; i < ARRAY_SIZE(port0->read_urbs); ++i)
+		usb_kill_urb(port0->read_urbs[i]);
+
+	f81534_release_gpio(port);
+	port_priv = usb_get_serial_port_data(port);
+	kfree(port_priv);
+
+	return 0;
+}
+
+static int f81534_tiocmget(struct tty_struct *tty)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	unsigned long flags;
+	int r;
+	u8 msr, mcr;
+
+	/*
+	 * We'll avoid to direct read MSR register. The IC will read the MSR
+	 * changed and report it f81534_process_per_serial_block() by
+	 * F81534_TOKEN_MSR_CHANGE.
+	 *
+	 * When this device in heavy loading (e.g., BurnInTest Loopback Test)
+	 * The report of MSR register will delay received a bit. It's due to
+	 * MSR interrupt is lowest priority in 16550A. So we decide to sleep
+	 * a little time to pass the test.
+	 */
+	if (schedule_timeout_killable(
+			msecs_to_jiffies(F81534_DELAY_READ_MSR))) {
+		dev_info(&port->dev, "%s: breaked !!\n", __func__);
+		return -EINTR;
+	}
+
+	mutex_lock(&port_priv->msr_mutex);
+	spin_lock_irqsave(&port_priv->msr_lock, flags);
+
+	msr = port_priv->shadow_msr;
+	mcr = port_priv->shadow_mcr;
+
+	spin_unlock_irqrestore(&port_priv->msr_lock, flags);
+	mutex_unlock(&port_priv->msr_mutex);
+
+	r = (mcr & UART_MCR_DTR ? TIOCM_DTR : 0) |
+	    (mcr & UART_MCR_RTS ? TIOCM_RTS : 0) |
+	    (msr & UART_MSR_CTS ? TIOCM_CTS : 0) |
+	    (msr & UART_MSR_DCD ? TIOCM_CAR : 0) |
+	    (msr & UART_MSR_RI ? TIOCM_RI : 0) |
+	    (msr & UART_MSR_DSR ? TIOCM_DSR : 0);
+
+	return r;
+}
+
+static int f81534_tiocmset(struct tty_struct *tty,
+			   unsigned int set, unsigned int clear)
+{
+	struct usb_serial_port *port = tty->driver_data;
+
+	return f81534_update_mctrl(port, set, clear);
+}
+
+static void f81534_dtr_rts(struct usb_serial_port *port, int on)
+{
+	if (on)
+		f81534_update_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
+	else
+		f81534_update_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
+}
+
+static int f81534_write(struct tty_struct *tty,
+			struct usb_serial_port *port,
+			const unsigned char *buf, int count)
+{
+	int bytes_out, status;
+
+	if (!count)
+		return 0;
+
+	bytes_out = kfifo_in_locked(&port->write_fifo, buf, count,
+					&port->lock);
+
+	status = f81534_submit_writer(port, GFP_KERNEL);
+	if (status) {
+		dev_err(&port->dev, "%s: submit failed\n", __func__);
+		return status;
+	}
+
+	return bytes_out;
+}
+
+static int f81534_resume(struct usb_serial *serial)
+{
+	struct usb_serial_port *port;
+	int status, error = 0;
+	int i;
+
+	status = f81534_submit_read_urb(serial, GFP_NOIO);
+	if (status) {
+		dev_err(&serial->dev->dev,
+				"%s: submit read URB failed!! status:%d!!\n",
+				__func__, status);
+		return status;
+	}
+
+	for (i = 0; i < serial->num_ports; i++) {
+		port = serial->port[i];
+		if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
+			continue;
+
+		status = f81534_submit_writer(port, GFP_NOIO);
+		if (status) {
+			dev_err(&port->dev, "%s: submit failed\n", __func__);
+			++error;
+		}
+	}
+
+	return error ? -EIO : 0;
+}
+
+static struct usb_serial_driver f81534_device = {
+	.driver = {
+		   .owner = THIS_MODULE,
+		   .name = IC_NAME,
+		   },
+	.description = DRIVER_DESC,
+	.id_table = id_table,
+	.open = f81534_open,
+	.close = f81534_close,
+	.write = f81534_write,
+	.calc_num_ports = f81534_calc_num_ports,
+	.attach = f81534_attach,
+	.release = f81534_release,
+	.port_probe = f81534_port_probe,
+	.port_remove = f81534_port_remove,
+	.dtr_rts = f81534_dtr_rts,
+	.process_read_urb = f81534_process_read_urb,
+	.ioctl = f81534_ioctl,
+	.tiocmget = f81534_tiocmget,
+	.tiocmset = f81534_tiocmset,
+	.write_bulk_callback = f81534_write_usb_callback,
+	.set_termios = f81534_set_termios,
+	.resume = f81534_resume,
+};
+
+static struct usb_serial_driver *const serial_drivers[] = {
+	&f81534_device, NULL
+};
+
+module_usb_serial_driver(serial_drivers, id_table);
+
+MODULE_DESCRIPTION(DRIVER_DESC);
+MODULE_AUTHOR("Peter Hong <Peter_Hong@fintek.com.tw>");
+MODULE_AUTHOR("Tom Tsai <Tom_Tsai@fintek.com.tw>");
+MODULE_LICENSE("GPL");
-- 
1.9.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver
  2015-12-02  7:18 [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver Peter Hung
@ 2015-12-05 23:28 ` kbuild test robot
  2016-01-03 18:58 ` Johan Hovold
  1 sibling, 0 replies; 4+ messages in thread
From: kbuild test robot @ 2015-12-05 23:28 UTC (permalink / raw)
  To: Peter Hung
  Cc: kbuild-all, johan, gregkh, linux-usb, linux-kernel, tom_tsai,
	peter_hong, Peter Hung

[-- Attachment #1: Type: text/plain, Size: 5861 bytes --]

Hi Peter,

[auto build test ERROR on usb/usb-testing]
[also build test ERROR on v4.4-rc3 next-20151203]

url:    https://github.com/0day-ci/linux/commits/Peter-Hung/usb-serial-Add-Fintek-F81532-534-driver/20151202-152239
base:   https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb.git usb-testing
config: mips-allmodconfig (attached as .config)
reproduce:
        wget https://git.kernel.org/cgit/linux/kernel/git/wfg/lkp-tests.git/plain/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # save the attached .config to linux build tree
        make.cross ARCH=mips 

All errors (new ones prefixed by >>):

   drivers/usb/serial/f81534.c:514:1: warning: data definition has no type or storage class
    MODULE_DEVICE_TABLE(usb, id_table);
    ^
>> drivers/usb/serial/f81534.c:514:1: error: type defaults to 'int' in declaration of 'MODULE_DEVICE_TABLE' [-Werror=implicit-int]
   drivers/usb/serial/f81534.c:514:1: warning: parameter names (without types) in function declaration
   In file included from drivers/usb/serial/f81534.c:103:0:
   include/linux/usb/serial.h:403:1: warning: data definition has no type or storage class
    module_init(usb_serial_module_init);     \
    ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
>> include/linux/usb/serial.h:403:1: error: type defaults to 'int' in declaration of 'module_init' [-Werror=implicit-int]
    module_init(usb_serial_module_init);     \
    ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
   drivers/usb/serial/f81534.c:2940:1: warning: parameter names (without types) in function declaration
   In file included from drivers/usb/serial/f81534.c:103:0:
   include/linux/usb/serial.h:408:1: warning: data definition has no type or storage class
    module_exit(usb_serial_module_exit);
    ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
>> include/linux/usb/serial.h:408:1: error: type defaults to 'int' in declaration of 'module_exit' [-Werror=implicit-int]
    module_exit(usb_serial_module_exit);
    ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
   drivers/usb/serial/f81534.c:2940:1: warning: parameter names (without types) in function declaration
>> drivers/usb/serial/f81534.c:154:2: error: expected declaration specifiers or '...' before string constant
     "Fintek USB to Serial Ports Driver (F81532/F81534-Evaluation Board)"
     ^
   drivers/usb/serial/f81534.c:2942:20: note: in expansion of macro 'DRIVER_DESC'
    MODULE_DESCRIPTION(DRIVER_DESC);
                       ^
   drivers/usb/serial/f81534.c:2943:15: error: expected declaration specifiers or '...' before string constant
    MODULE_AUTHOR("Peter Hong <Peter_Hong@fintek.com.tw>");
                  ^
   drivers/usb/serial/f81534.c:2944:15: error: expected declaration specifiers or '...' before string constant
    MODULE_AUTHOR("Tom Tsai <Tom_Tsai@fintek.com.tw>");
                  ^
   drivers/usb/serial/f81534.c:2945:16: error: expected declaration specifiers or '...' before string constant
    MODULE_LICENSE("GPL");
                   ^
   In file included from drivers/usb/serial/f81534.c:103:0:
   include/linux/usb/serial.h:398:19: warning: 'usb_serial_module_init' defined but not used [-Wunused-function]
    static int __init usb_serial_module_init(void)    \
                      ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
   include/linux/usb/serial.h:404:20: warning: 'usb_serial_module_exit' defined but not used [-Wunused-function]
    static void __exit usb_serial_module_exit(void)    \
                       ^
   include/linux/usb/serial.h:411:2: note: in expansion of macro 'usb_serial_module_driver'
     usb_serial_module_driver(KBUILD_MODNAME, __serial_drivers, __ids)
     ^
   drivers/usb/serial/f81534.c:2940:1: note: in expansion of macro 'module_usb_serial_driver'
    module_usb_serial_driver(serial_drivers, id_table);
    ^
   cc1: some warnings being treated as errors

vim +514 drivers/usb/serial/f81534.c

   508	static const struct usb_device_id id_table[] = {
   509		{USB_DEVICE(FINTEK_VENDOR_ID_1, FINTEK_DEVICE_ID)},
   510		{USB_DEVICE(FINTEK_VENDOR_ID_2, FINTEK_DEVICE_ID)},
   511		{}			/* Terminating entry */
   512	};
   513	
 > 514	MODULE_DEVICE_TABLE(usb, id_table);
   515	
   516	struct f81534_serial_private {
   517		bool is_phy_port_not_empty[F81534_NUM_PORT];

---
0-DAY kernel test infrastructure                Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all                   Intel Corporation

[-- Attachment #2: .config.gz --]
[-- Type: application/octet-stream, Size: 39731 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver
  2015-12-02  7:18 [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver Peter Hung
  2015-12-05 23:28 ` kbuild test robot
@ 2016-01-03 18:58 ` Johan Hovold
  2016-01-11  6:06   ` Peter Hung
  1 sibling, 1 reply; 4+ messages in thread
From: Johan Hovold @ 2016-01-03 18:58 UTC (permalink / raw)
  To: Peter Hung
  Cc: johan, gregkh, linux-usb, linux-kernel, tom_tsai, peter_hong, Peter Hung

On Wed, Dec 02, 2015 at 03:18:59PM +0800, Peter Hung wrote:
> This driver is for Fintek F81532/F81534 USB to Serial Ports IC.

Do you have a pointer to datasheets and/or information about these
devices? Can't seem to find anything on Fintek's homepage.

> Features:
> 1. F81534 is 1-to-4 & F81532 is 1-to-2 serial ports IC
> 2. Support Baudrate from B50 to B1500000 (excluding B1000000).
> 3. The RTS signal can be transformed their behavior with
>    configuration by ioctl TIOCGRS485/TIOCSRS485
> 
>    If the driver setting with SER_RS485_ENABLED, the RTS signal will
>    high with not in TX and low with in TX.
> 
>    If the driver setting with SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND,
>    the RTS signal will low with not in TX and high with in TX.
> 
> 4. The 4x3 output-only open-drain pins for F81532/534 is designed for
>    control outer devices (with our EVB for examples, the 4 sets of pins
>    are designed to control transceiver mode). So it implements as
>    gpiolib interface with output-only function.
> 5. It'll save the configuration in internal storage when uart/pins mode
>    changed.
> 
>    Please reference https://bitbucket.org/hpeter/fintek-general/src/
>    with f81534/tools to get set_gpio.c & set_mode.c to change F81532/534
>    setting. Please use it carefully.
> 
> Signed-off-by: Peter Hung <hpeter+linux_kernel@gmail.com>
> ---
> Changelog:
> v7
>     1. Make all gpiolib function with #ifdef CONFIG_GPIOLIB marco block.
>        Due to F81532/534 could run without gpiolib, we implements
>        f81534_prepare_gpio()/f81534_release_gpio() always success without
>        CONFIG_GPIOLIB.
>     2. Fix crash when receiving MSR change on driver load/unload. It's cause
>        by f81534_process_read_urb() get read URB callback data, but port
>        private data is not init complete or released. We solve with 2
>        modifications.
> 
>        1. add null pointer check with f81534_process_read_urb(). We'll skip
>           this report when port_priv = NULL.
>        2. when "one" port f81534_port_remove() is called, kill the port-0
>           read URB before kfree port_priv.
> 
> v6
>     1. Re-implement the write()/resume() function. Due to this device cant be
>        suitable with generic write(), we'll do the submit write URB when
>        write()/received tx empty/set_termios()/resume()
>     2. Logic/Phy Port mapping rewrite in f81534_port_probe() &
>        f81534_phy_to_logic_port().
>     3. Introduced "Port Hide" function. Some customer use F81532 reference
>        design for HW layout, but really use F81534 IC. We'll check
>        F81534_PORT_CONF_DISABLE_PORT flag with in uart mode field to do
>        port hide with port not used. It can be avoid end-user to use not
>        layouted port.
>     4. The 4x3 output-only open-drain pins for F81532/534 is designed for
>        control outer devices (with our EVB for examples, the 4 sets of pins
>        are designed to control transceiver mode). So we decide to implement
>        with gpiolib interface.
>     5. Add device vendor id with 0x2c42

Thanks for the update.

I noticed that you have not considered all my comments on earlier
revisions of this driver. Please make sure to address all issues raised.

Also note that a review comment generally applies to all instances of
a particular issue throughout the driver even when it is not
specifically mentioned.

In order to get this driver merged, I think you should consider starting
with a subset of the functionality.

We may need to come up with a generic interface for switching tranceiver
modes as there are more drivers that could benefit from this. I think we
should prevent mode switching for a port that is open as does not seem
to make much sense.

How about you drop mode-switching support completely for now (e.g.
gpiolib and rs485-ioctl) and focus on getting the basic functionality
right first?

You could also consider extending you user-space tool and use that to
switch modes (e.g. reprogram the device eeprom) through libudev, at
least until a generic interface is in place.

As for the basic design, you should use per-interface read and write
urbs. Submit the read urb(s) when the first port is opened, and kill
them when the last device is closed. Similarly for the write urbs,
submit one when there's at least one port with data in its fifo that it
non-busy (TX_EMPTY is set).

> +#define F81534_CUSTOM_ADDRESS_START	0x2f00
> +#define F81534_CUSTOM_TOTAL_SIZE	0x10
> +#define F81534_CUSTOM_DATA_SIZE		0x10
> +#define F81534_CUSTOM_MAX_IDX		\
> +			(F81534_CUSTOM_TOTAL_SIZE/F81534_CUSTOM_DATA_SIZE)

Do you really expect F81534_CUSTOM_MAX_IDX to be 1?

> +#ifndef C_CMSPAR
> +#define C_CMSPAR(tty)   _C_FLAG((tty), CMSPAR)
> +#endif

Drop this.

> +/*
> + * The following magic numbers is F81532/534 output pin
> + * register maps
> + */
> +static const struct io_map_value f81534_rs232_control = {
> +	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs232,
> +	{
> +	 /* please reference f81439 io port */

I can't seem to find anything about a f81439 io port. Do you have a
link?

I believe I already asked you to describe the following function in a
comment here.

> +static int f81534_command_delay(struct usb_serial *usbserial)
> +{
> +	unsigned int count = F81534_MAX_BUS_RETRY;
> +	unsigned char tmp;
> +	int status;
> +	struct usb_device *dev = usbserial->dev;
> +
> +	do {
> +		status = f81534_get_normal_register(dev, F81534_BUS_REG_STATUS,
> +							&tmp);
> +		if (status)
> +			return status;
> +
> +		if (tmp & F81534_BUS_BUSY)
> +			continue;
> +
> +		if (tmp & F81534_BUS_IDLE)
> +			break;
> +
> +	} while (--count);
> +
> +	if (!count)
> +		return -EIO;
> +
> +	status = f81534_set_normal_register(dev, F81534_BUS_REG_STATUS,
> +				tmp & ~F81534_BUS_IDLE);
> +	if (status)
> +		return status;
> +
> +	return 0;
> +}

> +static int f81534_read_data(struct usb_serial *usbserial, u32 address,
> +				u32 size, unsigned char *buf)
> +{
> +	u32 read_size, count;
> +	u32 block = 0;

Please use size_t for the size, count and block variables (throughout).

> +	u16 reg_tmp;
> +	u8 tmp_buf[F81534_MAX_DATA_BLOCK];
> +	int status, offset;

> +static int f81534_submit_writer(struct usb_serial_port *port, gfp_t mem_flags)
> +{
> +	struct usb_serial *serial = port->serial;
> +	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
> +	struct f81534_serial_private *serial_priv =
> +			usb_get_serial_data(serial);
> +	struct tty_struct *tty;
> +	struct urb *urb;
> +	bool cts_status = true;
> +	unsigned long flags;
> +	int updating_data, result;
> +
> +	tty = tty_port_tty_get(&port->port);
> +	if (!tty)
> +		return 0;
> +
> +	/* check H/W Flow status */
> +	if (C_CRTSCTS(tty)) {
> +		spin_lock_irqsave(&port_priv->msr_lock, flags);
> +		cts_status = !!(port_priv->shadow_msr & UART_MSR_CTS);
> +		spin_unlock_irqrestore(&port_priv->msr_lock, flags);
> +	}
> +
> +	tty_kref_put(tty);
> +
> +	if (!cts_status)
> +		return 0;
> +
> +	/* someone is changing setting, pause TX */
> +	updating_data = mutex_is_locked(&serial_priv->change_mode_mutex);
> +	if (updating_data)
> +		return 0;

This cannot be done in a race-free way. You should just prevent mode
changes while the port is open.

> +
> +	/* check is any data in write_fifo */
> +	spin_lock_irqsave(&port->lock, flags);
> +
> +	if (kfifo_is_empty(&port->write_fifo)) {
> +		spin_unlock_irqrestore(&port->lock, flags);
> +		return 0;
> +	}
> +
> +	spin_unlock_irqrestore(&port->lock, flags);
> +
> +	/* check H/W is TXEMPTY */
> +	spin_lock_irqsave(&serial_priv->tx_empty_lock, flags);
> +
> +	if (serial_priv->is_phy_port_not_empty[port_priv->phy]) {
> +		spin_unlock_irqrestore(&serial_priv->tx_empty_lock, flags);
> +		return 0;
> +	}
> +
> +	serial_priv->is_phy_port_not_empty[port_priv->phy] = true;
> +	spin_unlock_irqrestore(&serial_priv->tx_empty_lock, flags);
> +
> +	urb = port->write_urbs[0];
> +	f81534_prepare_write_buffer(port, port->bulk_out_buffers[0],
> +					port->bulk_out_size);
> +	urb->transfer_buffer_length = F81534_WRITE_BUFFER_SIZE;
> +
> +	result = usb_submit_urb(urb, mem_flags);
> +	if (result) {
> +		dev_err(&port->dev, "%s: submit error, result:%d\n", __func__,
> +				result);
> +		return result;
> +	}
> +
> +	return 0;
> +}

> +/*
> + * This function could be executed when
> + *	1. Port configuration change. (e.g., UART/GPIO Mode changed)
> + *	2. Old IC or configuration detected.
> + *         During the port probe(), We'll check the current port is final port.
> + *	   If we found a old style configuration value, the
> + *	   f81534_load_configure_data() will transform old to new default
> + *	   setting to RAM, then f81534_save_configure_data() will compare the
> + *	   flash & RAM setting, If not the same, write it with new data with
> + *	   final port probe().
> + */
> +static int f81534_save_configure_data(struct usb_serial_port *port)
> +{
> +	int status;
> +	int count;
> +	int phy;
> +	int gpio_address, uart_address;
> +	int offset;
> +	bool reConfigure = false;

Again, please remove all CamelCase.

> +	u8 uart_mode, gpio_mode;
> +	u8 data[F81534_DEF_CONF_SIZE + 1];
> +	u8 tmp[F81534_DEF_CONF_SIZE];
> +	enum uart_mode current_mode;
> +	struct usb_serial *serial = port->serial;
> +	struct f81534_port_private *port_priv;
> +	struct f81534_serial_private *serial_priv =
> +			usb_get_serial_data(serial);
> +
> +	/* compare memory with ic data */
> +	for (count = 0; count < serial->num_ports; ++count) {
> +		port_priv = usb_get_serial_port_data(serial->port[count]);
> +
> +		if (!port_priv) {
> +			dev_err(&port->dev, "%s: port_priv == NULL\n",
> +					__func__);
> +			continue;
> +		}
> +
> +		phy = port_priv->phy;
> +
> +		if (serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA) {
> +			uart_address = F81534_DEF_CONF_ADDRESS_START + phy;
> +			gpio_address = F81534_DEF_CONF_ADDRESS_START + phy +
> +							F81534_CONF_SIZE;
> +		} else {
> +			/*
> +			 * if had custom setting, override
> +			 * 1st byte is a indicator, 0xff is empty,
> +			 * 0xf0 is had data. Skip with 1st data
> +			 */
> +
> +			uart_address = F81534_CUSTOM_ADDRESS_START +
> +				serial_priv->setting_idx *
> +				F81534_CUSTOM_DATA_SIZE + phy +
> +				F81534_CONF_OFFSET;
> +
> +			gpio_address = F81534_CUSTOM_ADDRESS_START +
> +				serial_priv->setting_idx *
> +				F81534_CUSTOM_DATA_SIZE + phy +
> +				F81534_CONF_SIZE + F81534_CONF_OFFSET;
> +		}
> +
> +		status = f81534_read_data(port->serial, uart_address, 1,
> +						&uart_mode);
> +		if (status) {
> +			dev_err(&port->dev,
> +					"%s: read uart data fail. status:%d\n",
> +					__func__, status);
> +			return status;
> +		}
> +
> +		status = f81534_read_data(port->serial, gpio_address, 1,
> +						&gpio_mode);
> +		if (status) {
> +			dev_err(&port->dev,
> +					"%s: read gpio data fail. status:%d\n",
> +					__func__, status);
> +			return status;
> +		}
> +
> +		if (port_priv->port_pin_data.gpio_mode != gpio_mode)
> +			reConfigure = true;
> +
> +		/* check uart flag */
> +		if (port_priv->port_pin_data.force_uart_mode ==
> +				uart_mode_rs232) {
> +			if ((uart_mode & F81534_MODE_MASK) !=
> +					F81534_RS232_FLAG)
> +				reConfigure = true;
> +		} else if (port_priv->port_pin_data.force_uart_mode ==
> +					uart_mode_rs485_1) {
> +			if ((uart_mode & F81534_MODE_MASK) !=
> +					F81534_RS485_1_FLAG)
> +				reConfigure = true;
> +		} else if (port_priv->port_pin_data.force_uart_mode ==
> +			   uart_mode_rs485) {
> +			if ((uart_mode & F81534_MODE_MASK) !=
> +					F81534_RS485_FLAG)
> +				reConfigure = true;
> +		} else {
> +			reConfigure = true;
> +		}
> +
> +		if (reConfigure)
> +			break;
> +	}
> +
> +	if (serial_priv->setting_idx == F81534_CUSTOM_NO_CUSTOM_DATA) {
> +		dev_info(&serial->dev->dev, "%s: force to reconfigure\n",
> +					__func__);
> +	} else if (!reConfigure) {
> +		dev_dbg(&serial->dev->dev, "%s: update-to-date\n", __func__);
> +		return 0;
> +	}
> +
> +	dev_info(&serial->dev->dev, "%s: updating\n", __func__);
> +
> +	/* next setting block */
> +	serial_priv->setting_idx =
> +			(serial_priv->setting_idx + 1) % F81534_CUSTOM_MAX_IDX;
> +	dev_info(&serial->dev->dev, "%s: saving to block index:%d\n", __func__,
> +			serial_priv->setting_idx);
> +
> +	/* erase when start block is 0 */
> +	if (!serial_priv->setting_idx) {
> +		dev_dbg(&serial->dev->dev, "%s: need erase\n", __func__);
> +
> +		/* erase */
> +		status = f81534_erase_sector(serial,
> +					F81534_CUSTOM_ADDRESS_START);
> +		if (status) {
> +			dev_err(&port->dev,
> +					"%s: erase sector failed! status:%d\n",
> +					__func__, status);
> +			return status;
> +		}
> +	} else {
> +		dev_dbg(&serial->dev->dev,
> +				"%s: dont need erase\n", __func__);
> +	}
> +
> +	/* reprogram */
> +	for (count = 0; count < serial->num_ports; ++count) {
> +		port_priv = usb_get_serial_port_data(serial->port[count]);
> +		phy = port_priv->phy;
> +		current_mode = port_priv->port_pin_data.force_uart_mode;
> +		gpio_mode = port_priv->port_pin_data.gpio_mode;
> +
> +		serial_priv->default_conf_data[phy + F81534_CONF_SIZE] =
> +								gpio_mode;
> +		serial_priv->default_conf_data[phy] &= ~(F81534_MODE_MASK);
> +
> +		/* check uart flag */
> +		if (current_mode == uart_mode_rs232) {
> +			serial_priv->default_conf_data[phy] |=
> +					F81534_RS232_FLAG;
> +		} else if (current_mode == uart_mode_rs485_1) {
> +			serial_priv->default_conf_data[phy] |=
> +					F81534_RS485_1_FLAG;
> +		} else if (current_mode == uart_mode_rs485) {
> +			serial_priv->default_conf_data[phy] |=
> +					F81534_RS485_FLAG;
> +		} else {
> +			dev_err(&serial->dev->dev,
> +					"%s: current_mode error, value:%d\n",
> +					__func__, current_mode);
> +		}
> +
> +		dev_info(&serial->dev->dev,
> +				"%s: port:%d uart_mode:%x, gpio_mode:%x\n",
> +				__func__, count,
> +				serial_priv->default_conf_data[phy + 0],
> +				gpio_mode);
> +	}
> +
> +	/*
> +	 * 1st byte is a indicator, 0xff is empty, 0xf0 is had data
> +	 * only write 8 bytes of total 4 port uart & gpio mode
> +	 * so we need write 1+8 data
> +	 */
> +
> +	/* token of data exist */
> +	data[0] = F81534_CUSTOM_VALID_TOKEN;
> +	memcpy(&data[1], serial_priv->default_conf_data, F81534_DEF_CONF_SIZE);
> +
> +	offset = F81534_CUSTOM_ADDRESS_START +
> +			F81534_CUSTOM_DATA_SIZE * serial_priv->setting_idx;
> +
> +	status = f81534_write_data(serial, offset, sizeof(data), data);
> +	if (status) {
> +		dev_err(&port->dev,
> +				"%s: f81534_write_data failed!! status:%d\n",

Please remove all exclamation marks (!) from all error messages.

Please also try to spell out what went wrong instead of relying on the
function name, for example in this case:

"failed to save configuration data: %d\n"

Also add a space between the final colon (:) and the error code.

> +				__func__, status);
> +		return status;
> +	}
> +
> +	/* recheck save & memory data */
> +	memset(tmp, 0, sizeof(tmp));
> +
> +	status = f81534_read_data(serial,
> +				  F81534_CUSTOM_ADDRESS_START +
> +				  F81534_CUSTOM_DATA_SIZE *
> +				  serial_priv->setting_idx + 1, sizeof(tmp),
> +				  tmp);
> +	if (status) {
> +		dev_err(&port->dev,
> +				"%s: f81534_read_data failed!! status:%d\n",
> +				__func__, status);
> +		return status;
> +	}
> +
> +	for (count = 0; count < F81534_DEF_CONF_SIZE; ++count) {
> +		if (tmp[count] == serial_priv->default_conf_data[count])
> +			continue;
> +
> +		dev_err(&port->dev,
> +				"%s:read data error, count:%d, data:%x %x\n",
> +				__func__, count, tmp[count],
> +				serial_priv->default_conf_data[count]);
> +	}
> +
> +	dev_dbg(&serial->dev->dev, "%s: complete\n", __func__);
> +
> +	return 0;
> +}

> +static int f81534_prepare_gpio(struct usb_serial_port *port)
> +{
> +	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
> +	int max_name = 32;
> +	char *name = NULL;
> +	int idx = port->minor;
> +	int rc;
> +
> +	name = devm_kzalloc(&port->dev, max_name, GFP_KERNEL);
> +	if (!name)
> +		return -ENOMEM;
> +
> +	memcpy(&port_priv->f81534_gpio_chip, &f81534_gpio_chip_templete,
> +			sizeof(f81534_gpio_chip_templete));
> +
> +	snprintf(name, max_name - 1, "%s-%d", IC_NAME, idx);

The size includes the trailing NUL so use max_name only here.

> +
> +	port_priv->f81534_gpio_chip.label = name;
> +	port_priv->f81534_gpio_chip.dev = &port->dev;
> +
> +	rc = gpiochip_add(&port_priv->f81534_gpio_chip);
> +	if (rc) {
> +		dev_err(&port->dev, "%s: f81534_prepare_gpio failed:%d\n",
> +				__func__, rc);
> +		return rc;
> +	}
> +
> +	return 0;
> +}

> +/*
> + * This function will search the data area with token F81534_CUSTOM_VALID_TOKEN
> + * for latest configuration index. If nothing found (*index = -1), the caller
> + * will load default configure in F81534_DEF_CONF_ADDRESS_START section
> + */
> +static int f81534_find_config_idx(struct usb_serial *serial, uintptr_t *index)
> +{
> +	int idx, status;
> +	u8 custom_data;
> +	int offset;
> +
> +	for (idx = F81534_CUSTOM_MAX_IDX - 1; idx >= 0; --idx) {

Why go through all this trouble when F81534_CUSTOM_MAX_IDX is a constant
defined as 1?

> +		offset = F81534_CUSTOM_ADDRESS_START +
> +					F81534_CUSTOM_DATA_SIZE * idx;
> +		status = f81534_read_data(serial, offset, 1, &custom_data);
> +		if (status) {
> +			dev_err(&serial->dev->dev,
> +					"%s: read error, idx:%d, status:%d\n",
> +					__func__, idx, status);
> +			return status;
> +		}
> +
> +		/*
> +		 * if had custom setting, override
> +		 * 1st byte is a indicator, 0xff is empty, 0xf0 is had data
> +		 */
> +
> +		/* found */
> +		if (custom_data == F81534_CUSTOM_VALID_TOKEN)
> +			break;
> +	}
> +
> +	*index = idx;
> +	return 0;
> +}
> +
> +static int f81534_calc_num_ports(struct usb_serial *serial)
> +{
> +	uintptr_t setting_idx;
> +	int i;
> +	u8 num_port = 0;
> +	int status;
> +	unsigned char setting[F81534_CUSTOM_DATA_SIZE + 1];
> +
> +	/* check had custom setting */
> +	status = f81534_find_config_idx(serial, &setting_idx);
> +	if (status) {
> +		dev_err(&serial->dev->dev,
> +				"%s: f81534_find_config_idx read failed!!\n",
> +				__func__);
> +		return 0;
> +	}
> +
> +	/* Save the configuration area idx as private data for attach() */
> +	usb_set_serial_data(serial, (void *) setting_idx);

No space after casts.

> +
> +	/* read default board setting */
> +	status = f81534_read_data(serial, F81534_DEF_CONF_ADDRESS_START,
> +				  F81534_NUM_PORT, setting);
> +	if (status) {
> +		dev_err(&serial->dev->dev,
> +				"%s: f81534_read_data read failed!!\n",
> +				__func__);
> +		return 0;
> +	}
> +
> +	/*
> +	 * if had custom setting, override it.
> +	 * 1st byte is a indicator, 0xff is empty, F81534_CUSTOM_VALID_TOKEN
> +	 * is had data, then skip with 1st data
> +	 */
> +	if (setting_idx != F81534_CUSTOM_NO_CUSTOM_DATA) {
> +		status = f81534_read_data(serial,
> +					  F81534_CUSTOM_ADDRESS_START +
> +					  F81534_CUSTOM_DATA_SIZE *
> +					  setting_idx + 1, sizeof(setting),
> +					  setting);
> +		if (status) {
> +			dev_err(&serial->dev->dev,
> +					"%s: get custom data failed!!\n",
> +					__func__);
> +			return 0;
> +		}
> +
> +		dev_info(&serial->dev->dev,
> +				"%s: read configure from block:%d\n", __func__,
> +				(int) setting_idx);
> +	} else {
> +		dev_info(&serial->dev->dev, "%s: read configure default\n",
> +				__func__);
> +	}

Demote these info messages to debug level.

> +
> +	for (i = 0; i < F81534_NUM_PORT; ++i) {
> +		/*
> +		 * For older configuration use. We'll transform it to newer
> +		 * setting after load it with final port probed.
> +		 */
> +		switch (setting[i]) {
> +		case F81534_OLD_CONFIG_37:
> +		case F81534_OLD_CONFIG_38:
> +		case F81534_OLD_CONFIG_39:
> +			++num_port;
> +			break;
> +		}
> +	}

Please explain what this old and new configuration style is and why you
need it.

Please also document the format of your configuration data.

> +
> +	if (num_port) {
> +		dev_dbg(&serial->dev->dev, "%s: old style with %d ports",
> +				__func__, num_port);
> +		return num_port;
> +	}
> +
> +	/* new style, find all possible ports */
> +	num_port = 0;
> +	for (i = 0; i < F81534_NUM_PORT; ++i) {
> +		if (setting[i] & F81534_PORT_UNAVAILABLE)
> +			continue;
> +
> +		++num_port;
> +	}
> +
> +	if (num_port)
> +		return num_port;
> +
> +	dev_err(&serial->dev->dev, "Read Failed!!, default 4 ports\n");

If this is really an error you should bail out and return 0, otherwise
use dev_dbg or possible _warn here.

> +	return 4;		/* nothing found, oldest version IC */
> +}
> +

> +static void f81534_close(struct usb_serial_port *port)
> +{
> +	int i;
> +	unsigned long flags;
> +	struct f81534_serial_private *serial_priv =
> +			usb_get_serial_data(port->serial);
> +	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
> +	int phy = port_priv->phy;
> +
> +	atomic_dec(&serial_priv->port_active[phy]);
> +
> +	/* referenced from usb_serial_generic_close() */
> +	for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
> +		usb_kill_urb(port->write_urbs[i]);
> +
> +	spin_lock_irqsave(&port->lock, flags);
> +	kfifo_reset_out(&port->write_fifo);
> +	spin_unlock_irqrestore(&port->lock, flags);
> +}
> +
> +static void f81534_release(struct usb_serial *serial)
> +{
> +	struct f81534_serial_private *serial_priv =
> +			usb_get_serial_data(serial);
> +
> +	kfree(serial_priv);
> +}

Please try to keep related function together. Place the release callback
after f81534_attach().

> +static int f81534_get_serial_info(struct usb_serial_port *port,
> +				  struct serial_struct __user *retinfo)
> +{
> +	struct serial_struct tmp;
> +	struct f81534_port_private *port_priv;
> +
> +	port_priv = usb_get_serial_port_data(port);
> +	if (!port_priv)
> +		return -EFAULT;
> +
> +	if (!retinfo)
> +		return -EFAULT;
> +
> +	memset(&tmp, 0, sizeof(tmp));
> +
> +	tmp.type = PORT_16550A;
> +	tmp.port = port->port_number;
> +	tmp.line = port->minor;
> +	tmp.baud_base = port_priv->current_baud_base;
> +
> +	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
> +		return -EFAULT;
> +
> +	return 0;
> +}
> +
> +static int f81534_set_port_mode(struct usb_serial_port *port,
> +		enum uart_mode eMode)

CamelCase

> +{
> +	int status;
> +	u8 tmp;
> +	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
> +
> +	if (eMode > uart_mode_invalid)
> +		return -EINVAL;
> +
> +	if (eMode != uart_mode_invalid) {
> +		status = f81534_getregister(port->serial->dev, port_priv->phy,
> +						CLK_SEL_REGISTER, &tmp);
> +		if (status)
> +			return status;
> +
> +		tmp &= ~(F81534_RS485_MODE | F81534_RS485_INVERT);
> +
> +		switch (port_priv->port_pin_data.force_uart_mode) {
> +		case uart_mode_rs232:
> +		case uart_mode_shutdown:
> +		case uart_mode_rs232_coexist:
> +			break;
> +
> +		case uart_mode_rs485:
> +			tmp |= (F81534_RS485_MODE | F81534_RS485_INVERT);
> +			dev_dbg(&port->dev, "%s: uart_mode_rs485 URB:%x\n",
> +					__func__, tmp);
> +			break;
> +
> +		default:
> +			tmp |= F81534_RS485_MODE;
> +			dev_dbg(&port->dev, "%s others URB:%x\n",
> +					__func__, tmp);
> +			break;
> +
> +		}
> +
> +		status = f81534_setregister(port->serial->dev, port_priv->phy,
> +						CLK_SEL_REGISTER, tmp);
> +		if (status)
> +			return status;
> +	}
> +
> +	port_priv->port_pin_data.force_uart_mode = eMode;
> +	return 0;
> +}

> +static int f81534_setup_urbs(struct usb_serial *serial)

Rename f81534_setup_ports.

> +{
> +	int i = 0;
> +	u8 port0_out_address;
> +	int j;
> +	int buffer_size;
> +	struct usb_serial_port *port = NULL;
> +
> +	/*
> +	 * In our system architecture, we had 4 or 2 serial ports,
> +	 * but only get 1 set of bulk in/out endpoints.
> +	 *
> +	 * The usb-serial subsystem will generate port 0 data,
> +	 * but port 1/2/3 will not. It's will generate write URB and buffer
> +	 * by following code
> +	 */
> +	for (i = 1; i < serial->num_ports; ++i) {
> +		port0_out_address = serial->port[0]->bulk_out_endpointAddress;
> +		buffer_size = serial->port[0]->bulk_out_size;
> +		port = serial->port[i];
> +
> +		if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
> +			goto failed;
> +
> +		port->bulk_out_size = buffer_size;
> +		port->bulk_out_endpointAddress = port0_out_address;
> +
> +		for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j) {
> +			set_bit(j, &port->write_urbs_free);
> +
> +			port->write_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
> +			if (!port->write_urbs[j])
> +				goto failed;
> +
> +			port->bulk_out_buffers[j] = kmalloc(buffer_size,
> +								GFP_KERNEL);
> +			if (!port->bulk_out_buffers[j])
> +				goto failed;
> +
> +			usb_fill_bulk_urb(port->write_urbs[j], serial->dev,
> +					usb_sndbulkpipe(serial->dev,
> +						port0_out_address),
> +					port->bulk_out_buffers[j], buffer_size,
> +					serial->type->write_bulk_callback,
> +					port);
> +		}
> +
> +		port->write_urb = port->write_urbs[0];
> +		port->bulk_out_buffer = port->bulk_out_buffers[0];
> +	}
> +
> +	return 0;
> +failed:
> +	return -ENOMEM;
> +}

> +static int f81534_write(struct tty_struct *tty,
> +			struct usb_serial_port *port,
> +			const unsigned char *buf, int count)
> +{
> +	int bytes_out, status;
> +
> +	if (!count)
> +		return 0;
> +
> +	bytes_out = kfifo_in_locked(&port->write_fifo, buf, count,
> +					&port->lock);
> +
> +	status = f81534_submit_writer(port, GFP_KERNEL);

You must use GFP_ATOMIC here.

> +	if (status) {
> +		dev_err(&port->dev, "%s: submit failed\n", __func__);
> +		return status;
> +	}
> +
> +	return bytes_out;
> +}

> +static struct usb_serial_driver f81534_device = {
> +	.driver = {
> +		   .owner = THIS_MODULE,
> +		   .name = IC_NAME,
> +		   },
> +	.description = DRIVER_DESC,

Please use a concise description here (e.g. "Fintek F81532/F81534")
here.

Thanks,
Johan

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver
  2016-01-03 18:58 ` Johan Hovold
@ 2016-01-11  6:06   ` Peter Hung
  0 siblings, 0 replies; 4+ messages in thread
From: Peter Hung @ 2016-01-11  6:06 UTC (permalink / raw)
  To: Johan Hovold
  Cc: gregkh, linux-usb, linux-kernel, tom_tsai, peter_hong, Peter Hung

Hi Johan,

Johan Hovold 於 2016/1/4 上午 02:58 寫道:
> On Wed, Dec 02, 2015 at 03:18:59PM +0800, Peter Hung wrote:
>> This driver is for Fintek F81532/F81534 USB to Serial Ports IC.
>
> Do you have a pointer to datasheets and/or information about these
> devices? Can't seem to find anything on Fintek's homepage.

F81532
https://drive.google.com/file/d/0B8vRwwYO7aMFOTRRMmhWQVNvajQ/view?usp=sharing

F81534
https://drive.google.com/file/d/0B8vRwwYO7aMFV29pQWJqbVBNc00/view?usp=sharing

> I noticed that you have not considered all my comments on earlier
> revisions of this driver. Please make sure to address all issues raised.

I'll recheck it again.


> We may need to come up with a generic interface for switching tranceiver
> modes as there are more drivers that could benefit from this. I think we
> should prevent mode switching for a port that is open as does not seem
> to make much sense.
>
> How about you drop mode-switching support completely for now (e.g.
> gpiolib and rs485-ioctl) and focus on getting the basic functionality
> right first?

> You could also consider extending you user-space tool and use that to
> switch modes (e.g. reprogram the device eeprom) through libudev, at
> least until a generic interface is in place.

Ok, we'll remove gpiolib & rs485-ioctl with next version and only remain
the initialization of gpio/mode control on attach() once.

Also we'll provide tools via libusb to modify the configuration data on
bitbucket.

> As for the basic design, you should use per-interface read and write
> urbs. Submit the read urb(s) when the first port is opened, and kill
> them when the last device is closed. Similarly for the write urbs,
> submit one when there's at least one port with data in its fifo that it
> non-busy (TX_EMPTY is set).

The method you mentioned is more make sense, but it'll changes the
driver tx flow and makes it more difficultly to maintain.

Could I preserve current flow? The current is 1 read-urb submits on
attach() & resume() and per-port write-urb submits on write() or
read-urb callback TX_EMPTY. The style is the same with "mxuport.c".


>> +#define F81534_CUSTOM_ADDRESS_START	0x2f00
>> +#define F81534_CUSTOM_TOTAL_SIZE	0x10
>> +#define F81534_CUSTOM_DATA_SIZE		0x10
>> +#define F81534_CUSTOM_MAX_IDX		\
>> +			(F81534_CUSTOM_TOTAL_SIZE/F81534_CUSTOM_DATA_SIZE)
>
> Do you really expect F81534_CUSTOM_MAX_IDX to be 1?

Yes, we'll remove the TOTAL_SIZE and set MAX_IDX = 1 with next version.

>> +#ifndef C_CMSPAR
>> +#define C_CMSPAR(tty)   _C_FLAG((tty), CMSPAR)
>> +#endif
>
> Drop this.

OK


>> +/*
>> + * The following magic numbers is F81532/534 output pin
>> + * register maps
>> + */
>> +static const struct io_map_value f81534_rs232_control = {
>> +	FINTEK_DEVICE_ID, F81534_NUM_PORT, uart_mode_rs232,
>> +	{
>> +	 /* please reference f81439 io port */
>
> I can't seem to find anything about a f81439 io port. Do you have a
> link?
>
> I believe I already asked you to describe the following function in a
> comment here.

On next version we'll add more documents with this section and
change it to "f81534_pin_control". It controls F81532/534 output pin.
The pin default value can be changed with user-space tools.


>> +static int f81534_read_data(struct usb_serial *usbserial, u32 address,
>> +				u32 size, unsigned char *buf)
>> +{
>> +	u32 read_size, count;
>> +	u32 block = 0;
>
> Please use size_t for the size, count and block variables (throughout).

OK.

>> +	/* someone is changing setting, pause TX */
>> +	updating_data = mutex_is_locked(&serial_priv->change_mode_mutex);
>> +	if (updating_data)
>> +		return 0;
>
> This cannot be done in a race-free way. You should just prevent mode
> changes while the port is open.

OK, we'll remove it next version.


>> +	bool reConfigure = false;
>
> Again, please remove all CamelCase.

OK.


>> +	if (status) {
>> +		dev_err(&port->dev,
>> +				"%s: f81534_write_data failed!! status:%d\n",
>
> Please remove all exclamation marks (!) from all error messages.
>
> Please also try to spell out what went wrong instead of relying on the
> function name, for example in this case:
>
> "failed to save configuration data: %d\n"
>
> Also add a space between the final colon (:) and the error code.

OK.


>> +	memcpy(&port_priv->f81534_gpio_chip, &f81534_gpio_chip_templete,
>> +			sizeof(f81534_gpio_chip_templete));
>> +
>> +	snprintf(name, max_name - 1, "%s-%d", IC_NAME, idx);
>
> The size includes the trailing NUL so use max_name only here.

OK, but this section will be removed next version.


>> +static int f81534_find_config_idx(struct usb_serial *serial, uintptr_t *index)
>> +{
>> +	int idx, status;
>> +	u8 custom_data;
>> +	int offset;
>> +
>> +	for (idx = F81534_CUSTOM_MAX_IDX - 1; idx >= 0; --idx) {
>
> Why go through all this trouble when F81534_CUSTOM_MAX_IDX is a constant
> defined as 1?

The define is for the historical, we original designed for a section to
store the data (about 0x100 / 0x10 = 0x10 set of data), but It makes
more difficulty for H/W design. So we reduce from 0x100 to 0x10,
only 1 set of data remained with MP IC.

I'll reduce the code for next version.


>> +	/* Save the configuration area idx as private data for attach() */
>> +	usb_set_serial_data(serial, (void *) setting_idx);
>
> No space after casts.

OK.


>> +		dev_info(&serial->dev->dev,
>> +				"%s: read configure from block:%d\n", __func__,
>> +				(int) setting_idx);
>> +	} else {
>> +		dev_info(&serial->dev->dev, "%s: read configure default\n",
>> +				__func__);
>> +	}
>
> Demote these info messages to debug level.

OK.


>> +
>> +	for (i = 0; i < F81534_NUM_PORT; ++i) {
>> +		/*
>> +		 * For older configuration use. We'll transform it to newer
>> +		 * setting after load it with final port probed.
>> +		 */
>> +		switch (setting[i]) {
>> +		case F81534_OLD_CONFIG_37:
>> +		case F81534_OLD_CONFIG_38:
>> +		case F81534_OLD_CONFIG_39:
>> +			++num_port;
>> +			break;
>> +		}
>> +	}
>
> Please explain what this old and new configuration style is and why you
> need it.
>
> Please also document the format of your configuration data.

We had 3 generation of F81532/534. All gen has an internal storage.

1st is pure USB-to-TTL RS232 IC and designed for 4 ports only, no any
internal data will used. All mode and gpio control should manually set
by AP or Driver and all storage space value are 0xff. The
f81534_calc_num_ports() will run to final we marked as "oldest version"
for this IC.

2nd is designed to match our transceivers(F81437/438/439). We'll save 
data in F81534_DEF_CONF_ADDRESS_START(0x3000) with 8bytes. The first
4bytes is transceiver type, value is only 0x37/0x38/0x39 to
represent F81437/438/439, and the following 4bytes are save mode & gpio
state, the last 4bytes will be limited by the first 4bytes transceiver
type. The f81534_calc_num_ports() will run to "older configuration"
with checking F81534_OLD_CONFIG_37/F81534_OLD_CONFIG_38
/F81534_OLD_CONFIG_39 section.

3rd is designed to more generic to use any transceiver and this is our
mass production type. We'll save data in F81534_CUSTOM_ADDRESS_START
(0x2f00) with 9bytes. The 1st byte is a indicater. If the token is not
F81534_CUSTOM_VALID_TOKEN(0xf0), the IC is 2nd gen type, the following
4bytes save port mode (0:RS232/1:RS485 Invert/2:RS485), and the last
4bytes save GPIO state(value from 0~7 to represent 3 GPIO output pin).
The f81534_calc_num_ports() will run to "new style" with checking
F81534_PORT_UNAVAILABLE section.

I'll add this document in code with next version.


>> +	if (num_port)
>> +		return num_port;
>> +
>> +	dev_err(&serial->dev->dev, "Read Failed!!, default 4 ports\n");
>
> If this is really an error you should bail out and return 0, otherwise
> use dev_dbg or possible _warn here.

OK, we'll change it as dev_warn().


>> +static void f81534_release(struct usb_serial *serial)
>> +{
>> +	struct f81534_serial_private *serial_priv =
>> +			usb_get_serial_data(serial);
>> +
>> +	kfree(serial_priv);
>> +}
>
> Please try to keep related function together. Place the release callback
> after f81534_attach().

OK.


>> +static int f81534_set_port_mode(struct usb_serial_port *port,
>> +		enum uart_mode eMode)
>
> CamelCase

OK.


>> +static int f81534_setup_urbs(struct usb_serial *serial)
>
> Rename f81534_setup_ports.

OK.

>> +static int f81534_write(struct tty_struct *tty,
>> +			struct usb_serial_port *port,
>> +			const unsigned char *buf, int count)
>> +{
>> +	int bytes_out, status;
>> +
>> +	if (!count)
>> +		return 0;
>> +
>> +	bytes_out = kfifo_in_locked(&port->write_fifo, buf, count,
>> +					&port->lock);
>> +
>> +	status = f81534_submit_writer(port, GFP_KERNEL);
>
> You must use GFP_ATOMIC here.

OK.

> Please use a concise description here (e.g. "Fintek F81532/F81534")
> here.
>

OK.

Thanks for your advices.
-- 
With Best Regards,
Peter Hung

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2016-01-11  6:06 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-12-02  7:18 [PATCH V7 1/1] usb:serial: Add Fintek F81532/534 driver Peter Hung
2015-12-05 23:28 ` kbuild test robot
2016-01-03 18:58 ` Johan Hovold
2016-01-11  6:06   ` Peter Hung

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).