usb:serial add Fintek F81532/534 driver

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 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.

It's can be controlled via gpiolib. We could found the gpio number from /sys/class/tty/ttyUSB[x]/device/gpiochap[yyy] where x is F81532/534 serial port and yyy is gpiochip number.

After we found chip number, we can export 3 gpios(M2/M1/M0) 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 [M0 value] > /sys/class/gpio/gpio[yyy]/value
      echo [M1 value] > /sys/class/gpio/gpio[yyy+1]/value
      echo [M2 value] > /sys/class/gpio/gpio[yyy+2]/value

which M0/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 M2/M1/M0 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 M2/M1/M0 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 M2/M1/M0 as 0/1/1

4. RS422 Mode
1. The RTS mode is dont care.
2. Set M2/M1/M0 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.

Changelog
v5
1. Change the configure data address F81534_CUSTOM_ADDRESS_START from 0x4000 to 0x2f00 (for MP F/W ver:AA66)
2. Change f81534_port_disable/enable() from H/W mode to S/W mode It'll skip all rx data when port is not opened.
3. Some function modifier add with static (Thanks for Paul Bolle)
4. 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

Signed-off-by Peter Hung <[email protected]>

---

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

drivers/usb/serial/Kconfig +10 -0

index 56ecb8b..0642864 100644
@@ -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

drivers/usb/serial/Makefile +1 -0

index 349d9df..9e43b7b 100644
@@ -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

drivers/usb/serial/f81534.c new file +1 -0

new file mode 100644
index 0000000..ee4b1f8
@@ -0,0 +1,3279 @@
+/*

drivers/usb/serial/f81534.c new file +64 -0

+ *
+ *
+ * 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.
+ *    It's can be controlled via gpiolib. We could found the gpio
+ *    number from /sys/class/tty/ttyUSB[x]/device/gpiochap[yyy] where
+ *    x is F81532/534 serial port and yyy is gpiochip number.
+ *
+ *    After we found chip number, we can export 3 gpios(M2/M1/M0) 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 [M0 value] > /sys/class/gpio/gpio[yyy]/value
+ *       echo [M1 value] > /sys/class/gpio/gpio[yyy+1]/value
+ *       echo [M2 value] > /sys/class/gpio/gpio[yyy+2]/value
+ *    which M0/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 M2/M1/M0 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 M2/M1/M0 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 M2/M1/M0 as 0/1/1

drivers/usb/serial/f81534.c new file +5 -0

+#include <linux/errno.h>
+#include <linux/init.h>
+#include <linux/slab.h>
+#include <linux/tty.h>
+#include <linux/tty_driver.h>

drivers/usb/serial/f81534.c new file +13 -0

+#include <linux/mutex.h>
+#include <linux/gpio.h>
+
+#define F81534_TIOCGET_RETRY	5
+
+/* 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 INTERRUPT_ENABLE_REGISTER	(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)

drivers/usb/serial/f81534.c new file +19 -0

+#define MSR_ACCESS_SHADOW_REG	0x5a00
+
+#define F81534_RESERVE_ADDRESS_START	0x3000
+#define F81534_RESERVE_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 */

drivers/usb/serial/f81534.c new file +24 -0

+#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

drivers/usb/serial/f81534.c new file +6 -0

+	eModeRS422,
+	eModeRS232,
+	eModeRS485,
+	eModeRS485_1,
+	eModeRS422_term,
+	eModeRS232_coexist,

drivers/usb/serial/f81534.c new file +14 -0

+};
+
+struct pin_data {
+	struct reg_value port_mode_1;
+	struct reg_value port_mode_0;
+	struct reg_value port_io;
+};
+
+struct out_pin {
+	struct pin_data m1;
+	struct pin_data m2;
+	struct pin_data sd;
+};
+

drivers/usb/serial/f81534.c new file +27 -0

+static struct io_map_value f81534_rs232_control = {
+	FINTEK_DEVICE_ID, F81534_NUM_PORT, eModeRS232,
+	{
+	 /* 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},},
+	  },
+	 },
+
+};

drivers/usb/serial/f81534.c new file +14 -0

+
+
+static const struct usb_device_id id_table[] = {
+	{USB_DEVICE(FINTEK_VENDOR_ID, FINTEK_DEVICE_ID)},
+	{}			/* Terminating entry */
+};
+
+MODULE_DEVICE_TABLE(usb, id_table);
+
+enum eIC_Type {
+	eIC_F81530,
+	eIC_F81531,
+	eIC_F81532,
+	eIC_F81533,

drivers/usb/serial/f81534.c new file +41 -0

+	unsigned long msr_time[F81534_NUM_PORT];
+	u8 port_mapping[F81534_NUM_PORT];
+	struct mutex msr_mutex;
+	struct mutex change_mode_mutex;
+	u8 reserve_data[F81534_RESERVE_SIZE];
+	u32 custom_idx;
+}
+
+struct f81534_port_private {
+	u8 shadowMCR;
+	u8 shadowLCR;
+	struct usb_serial_port *port;
+	u32 tx, rx;
+	u32 currentBaudRate;
+	struct f81534_pin_config_data port_pin_data;
+	struct gpio_chip f81534_gpio_chip;
+	atomic_t gpio_active;
+	atomic_t port_active;
+};
+
+static void f81534_update_msr(struct usb_serial_port *port,
+		unsigned char *ch);
+
+static int f81534_setup_urbs(struct usb_serial *serial);
+
+static int f81534_set_normal_register(struct usb_device *dev,
+			u16 reg, u8 data);
+
+static int f81534_get_normal_register(struct usb_device *dev,
+			u16 reg, u8 *data);
+
+static int f81534_getregister(struct usb_device *dev,
+			u8 uart, u16 reg, u8 *data);
+
+static void f81534_dtr_rts(struct usb_serial_port *port, int on);
+
+static int f81534_set_port_mode(struct usb_serial_port *port,
+			enum eUartMode eMode);
+
+static int f81534_save_configure_data(struct usb_serial_port *port);
+

drivers/usb/serial/f81534.c new file +18 -0

+	return F81534_UNUSED_PORT;
+}
+
+static int f81534_phy_to_logic_port(struct usb_serial *usbserial, int phy)
+{
+	int index;
+	struct f81534_serial_private *serial_priv =
+	    usb_get_serial_data(usbserial);
+
+	for (index = 0; index < F81534_NUM_PORT; ++index)
+		if (serial_priv->port_mapping[index] == phy)
+			return index;
+
+	dev_err(&usbserial->dev->dev, "%s could found mapping: phy: %x\n",
+			__func__, phy);
+	return F81534_UNUSED_PORT;
+}
+

drivers/usb/serial/f81534.c new file +4 -0

+static int f81534_command_delay(struct usb_serial *usbserial)
+{
+	unsigned int count = F81534_MAX_BUS_RETRY;
+	unsigned char tmp;

drivers/usb/serial/f81534.c new file +4 -0

+			return status;
+		}
+
+		if (tmp & F81534_BUS_BUSY)

drivers/usb/serial/f81534.c new file +6 -0

+		return -EIO;
+	}
+
+	status = f81534_set_normal_register(dev, F81534_BUS_REG_STATUS,
+				tmp & ~F81534_BUS_IDLE);
+	if (status) {

drivers/usb/serial/f81534.c new file +17 -0

+{
+	unsigned int count = 0;
+	unsigned int read_size = 0;
+	unsigned int block = 0;
+	unsigned char *tmp_buf;
+	int status;
+	int offset;
+	struct usb_device *dev = usbserial->dev;
+
+	tmp_buf = kzalloc(F81534_MAX_DATA_BLOCK, GFP_KERNEL);
+	if (!tmp_buf)
+		return -ENOMEM;
+
+	status = f81534_command_delay(usbserial);
+	if (status) {
+		dev_err(&dev->dev, "%s: failed, %d\n",
+				__func__, __LINE__);

drivers/usb/serial/f81534.c new file +10 -0

+
+	status = f81534_command_delay(usbserial);
+	if (status) {
+		dev_err(&dev->dev, "%s: failed, %d\n",
+				__func__, __LINE__);
+		goto error;
+	}
 
+static int f81534_write_data(struct usb_serial *usbserial, int address,
+			     int size, unsigned char *buf)
+{

drivers/usb/serial/f81534.c new file +7 -0

+		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;

drivers/usb/serial/f81534.c new file +17 -0

+static int f81534_calc_baud_divisor(u32 baudrate, u32 clockrate, u32 *remain)
+{
+	u32 divisor, rem;
+
+	if (!baudrate)
+		return 0;
+
+	divisor = clockrate / baudrate;
+	rem = clockrate % baudrate;
+
+	if (remain)
+		*remain = rem;
+
+	/* Round to nearest divisor */
+	divisor = DIV_ROUND_CLOSEST(clockrate, baudrate);
+
+	return divisor;

drivers/usb/serial/f81534.c new file +33 -0

+	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) {
+			if (status == 0)
+				status = -EIO;
+		} else {
+			break;
+		}
+	}
+
+	if ((count <= 0) && (status <= 0)) {
+		dev_err(&dev->dev,
+			"%s ERROR reg:%x status:%i failed\n",
+			__func__, reg, status);
+		kfree(tmp);
+		return status;
+	}
+
+	*data = *tmp;

drivers/usb/serial/f81534.c new file +49 -0

+	tmp = kmalloc(sizeof(u8), GFP_KERNEL);
+	if (!tmp)
+		return -ENOMEM;
+
+	*tmp = data;
+
+	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) {
+			if (status == 0)
+				status = -EIO;
+		} else {
+			break;
+		}
+	}
+
+	if ((count <= 0) && status) {
+		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_setregister(struct usb_device *dev,
+				     u8 uart, u16 reg, u8 data)
+{
+	/* Our device maybe not reply when heavily loading,
+	 * We'll retry for F81534_USB_MAX_RETRY times
+	 */
+
+	int count = F81534_USB_MAX_RETRY;
+	int status;
+	u8 *tmp;
+
+	/* avoid smatch report: error: doing dma on the stack*/
+	tmp = kmalloc(sizeof(u8), GFP_KERNEL);
+	if (!tmp)
+		return -ENOMEM;
+

drivers/usb/serial/f81534.c new file +4 -0

+static int f81534_set_port_config(struct usb_device *dev,
+					 unsigned char port_number,
+					 struct usb_serial_port *port,
+					 u32 baudrate, u16 lcr)

drivers/usb/serial/f81534.c new file +14 -0

+static int f81534_getregister(struct usb_device *dev,
+				     u8 uart, u16 reg, u8 *data)
+{
+	int count = F81534_USB_MAX_RETRY;
+	int status;
+	u8 *tmp;
+
+	/* avoid smatch report: error: doing dma on the stack*/
+	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

drivers/usb/serial/f81534.c new file +12 -0

+		if (status <= 0) {
+			if (status == 0)
+				status = -EIO;
+		} else {
+			break;
+		}
+	}
+
+	if ((count <= 0) && (status <= 0)) {
+		dev_err(&dev->dev,
+			"%s ERROR port_number:%d reg:%x status:%i failed\n",
+			__func__, uart, reg + uart * 0x10, status);

drivers/usb/serial/f81534.c new file +21 -0

+		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 indicater, 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)

drivers/usb/serial/f81534.c new file +33 -0

+
+	/* read default board setting */
+	status = f81534_read_data(serial, F81534_RESERVE_ADDRESS_START,
+				  F81534_NUM_PORT, reserve);
+	if (status) {
+		dev_err(&serial->dev->dev,
+			"%s: f81534_read_data read failed!!\n", __func__);
+		return 0;
+	}
+
+	/* if had custom setting, override
+	 * 1st byte is a indicater, 0xff is empty, 0xf0f is had data
+	 * skip with 1st data
+	 */
+
+	if (serial_priv->custom_idx != F81534_CUSTOM_NO_CUSTOM_DATA) {
+		status = f81534_read_data(serial,
+					  F81534_CUSTOM_ADDRESS_START +
+					  F81534_CUSTOM_DATA_SIZE *
+					  serial_priv->custom_idx + 1,
+					  sizeof(reserve), reserve);
+		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__,
+			 serial_priv->custom_idx);
+	} else
+		dev_info(&serial->dev->dev, "%s: read configure default\n",
+			 __func__);

drivers/usb/serial/f81534.c new file +64 -0

+
+	/* old style */
+	if (num_port) {
+		dev_dbg(&serial->dev->dev, "%s: old style wtih %d ports",
+			__func__, num_port);
+		return num_port;
+	}
+
+	/*new style, find all possible ports */
+	num_port = 0;
+	for (index = 0; index < F81534_NUM_PORT; ++index) {
+		if (reserve[index] & BIT(7))
+			continue;
+
+		num_port += 1;
+	}
+
+	if (num_port)
+		return num_port;
+
+	dev_err(&serial->dev->dev, "Read Failed!!, default 4 ports\n");
+	return 4;		/* nothing found */
+}
+
+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;

drivers/usb/serial/f81534.c new file +6 -0

+			if (old_termios)
+				baud = old_termios->c_ospeed;
+			else
+				baud = F81534_DEFAULT_BAUD_RATE;
+		}
+

drivers/usb/serial/f81534.c new file +19 -0

+	}
+
+	port_priv->shadowLCR = new_lcr;
+	status =
+	    f81534_set_port_config(dev, f81534_port_to_phy_index(port), port,
+				   port_priv->currentBaudRate, new_lcr);
+	if (status < 0)
+		dev_err(&port->dev, "%s - f81534_set_port_config failed: %i\n",
+			__func__, status);
+
+}
+
+static int f81534_port_enable(struct usb_serial_port *port)
+{
+	struct f81534_port_private *port_priv =
+		usb_get_serial_port_data(port);
+
+	atomic_inc(&port_priv->port_active);
+	return 0;

drivers/usb/serial/f81534.c new file +12 -0

+
+	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) {
+		kfree(name);
+		dev_err(&port->dev, "%s: f81534_prepare_gpio failed:%d\n",
+				__func__, rc);
+		return rc;
+	}
+

drivers/usb/serial/f81534.c new file +31 -0

+	return 0;
+}
+
+static int f81534_open(struct tty_struct *tty, struct usb_serial_port *port)
+{
+	int status;
+
+	status = f81534_port_enable(port);
+	if (status)
+		return status;
+
+	if (tty)
+		f81534_set_termios(tty, port, &tty->termios);
+
+	return 0;
+}
+
+static void f81534_close(struct usb_serial_port *port)
+{
+	int i;
+	unsigned long flags;
+
+	f81534_port_disable(port);
+
+	/* 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);

drivers/usb/serial/f81534.c new file +9 -0

+
+	for (i = 0; i < ARRAY_SIZE(port0->read_urbs); ++i)
+		usb_kill_urb(port0->read_urbs[i]);
+}
+
+static int f81534_get_serial_info(struct usb_serial_port *port,
+				  struct serial_struct __user *retinfo)
+{
+	struct serial_struct tmp;

drivers/usb/serial/f81534.c new file +35 -0

+
+	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
+		return -EFAULT;
+
+	return 0;
+}
+
+#define READ_AND_SET_NORMAL(dev, register, mask, value) \
+	({	\
+		int status_tmp = 0 ; \
+		do {	\
+			char *err_str = "%s - error: %x, status: %d\n"; \
+			u8 urb_value_tmp = 0;	\
+			status_tmp = f81534_get_normal_register(dev, \
+					register, &urb_value_tmp); \
+			if (status_tmp < 0) {	\
+				dev_err(&dev->dev, \
+						err_str, \
+						__func__,  \
+						register, \
+						status_tmp); \
+				break; \
+			}; \
+			\
+			if ((value) != 0) \
+				urb_value_tmp |= \
+						((1L << mask) & (value)) ; \
+			else \
+				urb_value_tmp &=  \
+						~(1L << mask); \
+			\
+			status_tmp = f81534_set_normal_register(dev, \
+					register, \
+					urb_value_tmp); \
+			\

drivers/usb/serial/f81534.c new file +4 -0

+{
+	int x = f81534_port_to_phy_index(serial_port);
+	int y = 0;
+	int val;

drivers/usb/serial/f81534.c new file +13 -0

+
+	if (mode >= 8)
+		return -EINVAL;
+
+	for (y = 0; y < 3; ++y) {
+		val = pins[y]->port_io.reg_bit ? 0xff : 0x00;
+		status = READ_AND_SET_NORMAL(dev,
+					pins[y]->port_io.reg_address,
+					pins[y]->port_io.reg_offset,
+					val);
+		if (status) {
+			dev_err(&serial_port->dev,
+					"%s: failed, %d\n",

drivers/usb/serial/f81534.c new file +11 -0

+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (eMode > eModeInvalid)
+		return -1;
+
+	if (eMode != eModeInvalid) {
+		int data = 1;
+
+		status = f81534_getregister(port->serial->dev,
+					f81534_port_to_phy_index(port),
+					CLK_SEL_REGISTER,

drivers/usb/serial/f81534.c new file +37 -0

+static void f81534_process_per_serial_block(struct usb_serial_port *port,
+		unsigned char *data)
+{
+	unsigned char lsr = 0;
+	unsigned char msr, old_msr;
+	char tty_flag;
+	struct tty_struct *tty;
+	struct usb_serial *serial = port->serial;
+	struct f81534_serial_private *serial_priv =
+		usb_get_serial_data(serial);
+	struct f81534_port_private *port_priv =
+		usb_get_serial_port_data(port);
+	int phy_port_num = data[0];
+	int read_size = 0;
+	int i;
+
+	/* 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)
+	 *			meanful 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:
+		spin_lock(&serial_priv->write_urb_lock);
+		serial_priv->phy_port_in_use[phy_port_num] =
+			false;
+		spin_unlock(&serial_priv->write_urb_lock);
+		usb_serial_port_softint(port);
+		break;
+

drivers/usb/serial/f81534.c new file +35 -0

+		return;
+	}
+
+	do {
+		msr = data[3];
+		spin_lock(&serial_priv->msr_lock);
+
+		/* The MSR information can be get with any
+		 * 'correct' block data, but dont directly read MSR
+		 * from 16550A, our MCU will reported newest
+		 * or current data.
+		 *
+		 * We maybe received the same MSR. e.g.,
+		 * received MSR 0x11 and received 0x11 again.
+		 *
+		 * So we'll not use UART_MSR_ANY_DELTA to do check,
+		 * we directly compare their value.
+		 */
+		if (msr ==
+			serial_priv->shadowMSR[phy_port_num]) {
+			spin_unlock(&serial_priv->msr_lock);
+			break;
+		}
+
+		old_msr = serial_priv->shadowMSR[phy_port_num];
+		serial_priv->shadowMSR[phy_port_num] = msr;
+		serial_priv->msr_time[phy_port_num] = jiffies;
+
+		spin_unlock(&serial_priv->msr_lock);
+
+		dev_dbg(&port->dev,
+			"%s: DCD Changed: port %d from %x to %x.\n",
+			__func__, phy_port_num, old_msr,
+			msr);
+

drivers/usb/serial/f81534.c new file +42 -0

+		tty_flag = TTY_NORMAL;
+		lsr = data[i + 5];
+
+		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 + 4]))
+				continue;
+		}
+
+		tty_insert_flip_char(&port->port, data[i + 4], 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;

drivers/usb/serial/f81534.c new file +54 -0

+		phy_port_num = ch[i * F81534_RECEIVE_BLOCK_SIZE];
+		tty_port_num =
+			f81534_phy_to_logic_port(serial, phy_port_num);
+		port = serial->port[tty_port_num];
+		f81534_process_per_serial_block(port,
+				&ch[i * F81534_RECEIVE_BLOCK_SIZE]);
+	}
+}
+
+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);

+static int f81534_save_configure_data(struct usb_serial_port *port)

drivers/usb/serial/f81534.c new file +8 -0

+static int f81534_load_configure_data(struct usb_serial_port *port)
+{
+	int status;
+	int offset;
+	unsigned char uart_flag, gpio_mode;
+	int device_port = f81534_port_to_phy_index(port);
+	struct f81534_port_private *port_priv = usb_get_serial_port_data(port);
+	struct f81534_serial_private *serial_priv =

drivers/usb/serial/f81534.c new file +37 -0

+static int f81534_attach(struct usb_serial *serial)
+{
+	struct f81534_serial_private *serial_priv =
+		usb_get_serial_data(serial);
+	int status;
+	int i;
+	int offset;
+	int num_port = serial->num_ports;
+
+	serial_priv->serial = serial;
+	memset(serial_priv->port_mapping, F81534_UNUSED_PORT,
+	       sizeof(serial_priv->port_mapping));
+
+	switch (num_port) {
+	case eIC_F81532:
+	case eIC_F81534:
+		serial_priv->ic_type = num_port;
+		dev_info(&serial->dev->dev, "%s detected\n",
+			 m_ic_name[num_port]);
+		break;
+	default:
+		return -EINVAL;
+	}
+
+	for (i = 0; i < F81534_NUM_PORT; ++i)
+		serial_priv->port_mapping[i] = i;
+
+	switch (num_port) {
+	case 4:
+		break;
+	case 2:
+		serial_priv->port_mapping[1] = 3;
+		serial_priv->port_mapping[2] = F81534_UNUSED_PORT;
+		serial_priv->port_mapping[3] = F81534_UNUSED_PORT;
+		break;
+	case 1:
+		serial_priv->port_mapping[1] = F81534_UNUSED_PORT;

drivers/usb/serial/f81534.c new file +17 -0

+	for (i = 0; i < F81534_NUM_PORT; ++i) {
+		/* clear fifo when plug in */
+		status = f81534_setregister(serial->dev,
+				i, FIFO_CONTROL_REGISTER,
+				UART_FCR_R_TRIG_11 |
+				UART_FCR_ENABLE_FIFO |
+				UART_FCR_CLEAR_RCVR |
+				UART_FCR_CLEAR_XMIT);
+		if (status) {
+			dev_err(&serial->dev->dev,
+				"%s FCR init error:%x failed\n", __func__, i);
+			goto failed;
+		}
+
+		/* Get MSR initial value*/
+		status = f81534_get_normal_register(serial->dev,
+					MSR_ACCESS_SHADOW_REG + i,

drivers/usb/serial/f81534.c new file +8 -0

+	spin_lock_init(&serial_priv->write_urb_lock);
+	spin_lock_init(&serial_priv->msr_lock);
+	mutex_init(&serial_priv->msr_mutex);
+	mutex_init(&serial_priv->change_mode_mutex);
+
+	status = f81534_setup_urbs(serial);
+	if (status != 0)
+		goto failed;

drivers/usb/serial/f81534.c new file +38 -0

+
+	offset = F81534_CUSTOM_ADDRESS_START +
+			F81534_CUSTOM_DATA_SIZE * serial_priv->custom_idx + 1;
+	/* only read 8 bytes for mode & GPIO */
+	status = f81534_read_data(serial,
+			offset,
+			sizeof(serial_priv->reserve_data),
+			serial_priv->reserve_data);
+	if (status) {
+		dev_err(&serial->dev->dev,
+			"%s: get custom data failed, idx:%d, status:%d!!\n",
+			__func__, serial_priv->custom_idx, status);
+		goto failed;
+	}
+
+	/* We'll register port 0 bulkin only once, It'll take all port read
+	 * and information.
+	 */
+	status = usb_serial_generic_submit_read_urbs(serial->port[0],
+				GFP_KERNEL);
+	if (status) {
+		dev_err(&serial->dev->dev,
+			"%s: submit read urbs failed!! status:%d!!\n",
+			__func__, status);
+		goto failed;
+	}
+
+	return 0;
+
+failed:
+	kfree(serial_priv);
+	return status;
+}
+
 
+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);

drivers/usb/serial/f81534.c new file +10 -0

+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)
+{

drivers/usb/serial/f81534.c new file +29 -0

+
+	if (newMSR & UART_MSR_ANY_DELTA) {
+		/* update input line counters */
+		if (newMSR & UART_MSR_DCTS)
+			port->icount.cts++;
+		if (newMSR & UART_MSR_DDSR)
+			port->icount.dsr++;
+		if (newMSR & UART_MSR_DDCD)
+			port->icount.dcd++;
+		if (newMSR & UART_MSR_TERI)
+			port->icount.rng++;
+
+		wake_up_interruptible(&port->port.delta_msr_wait);
+	}
+}
+
+static int f81534_write_room(struct tty_struct *tty)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct f81534_port_private *port_priv;
+	struct f81534_serial_private *serial_priv =
+	    usb_get_serial_data(port->serial);
+	int port_num = f81534_port_to_phy_index(port);
+	unsigned long flags = 0;
+	int r;
+
+	port_priv = usb_get_serial_port_data(port);
+
+	spin_lock_irqsave(&serial_priv->write_urb_lock, flags);

drivers/usb/serial/f81534.c new file +57 -0

+
+static int f81534_prepare_write_buffer(struct usb_serial_port *port,
+						void *dest, size_t size)
+{
+	unsigned char *ptr = (unsigned char *) dest;
+	int port_num = f81534_port_to_phy_index(port);
+	struct usb_serial *serial = port->serial;
+
+	WARN_ON(size != serial->port[0]->bulk_out_size);
+
+	if (size != F81534_WRITE_BUFFER_SIZE) {
+		WARN_ON(size != F81534_WRITE_BUFFER_SIZE);
+		return 0;
+	}
+
+	/* 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[0] = 0;
+	ptr[128] = 1;
+	ptr[256] = 2;
+	ptr[384] = 3;
+	ptr[128 * port_num + 0] = port_num;
+	ptr[128 * port_num + 1] = F81534_TOKEN_WRITE;
+	ptr[128 * port_num + 3] = 0;
+	ptr[128 * port_num + 2] =
+		kfifo_out_locked(&port->write_fifo,
+				&ptr[128 * port_num + 4],
+				m_f81534_max_tx_size,
+				&port->lock);
+
+	return F81534_WRITE_BUFFER_SIZE;
+}
+
+static int f81534_write(struct tty_struct *tty,
+			struct usb_serial_port *port,
+			const unsigned char *buf, int count)
+{
+	int bytes_out = 0;
+	unsigned long flags;
+	bool bCouldWrite = true;
+	int port_num = f81534_port_to_phy_index(port);
+	int updating_data;
+	struct f81534_serial_private *serial_priv =
+	    usb_get_serial_data(port->serial);
+
+	if (!count)
+		return 0;
+
+	updating_data = mutex_is_locked(&serial_priv->change_mode_mutex);
+	if (updating_data) /*someone is changing setting */

Quoted 2 lines

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

So as I mentioned above, always accept data if there's room in the fifo. Then kick of a write urb, if TX_EMPTY is set for any of the ports and fill the urb based on those flags as well.

Quoted 4 lines

4. RS422 Mode
1. The RTS mode is dont care.
2. Set M2/M1/M0 as 0/0/0

I don't think all gpios should be exported for these ports if they have special functions that the driver could control transparently (e.g. for SER_RS485_RTS_ON_SEND).

drivers/usb/serial/f81534.c line 1150

Quoted 7 lines

drivers/usb/serial/f81534.c new file +7 -0

+	current_mode &= BIT(gpio_num);
+
+	mutex_unlock(&serial_priv->change_mode_mutex);
+	f81534_wakeup_all_port(port->serial);
+
+	return !!current_mode;
+}

Your gpio implementation looks wrong, but let's get back to that after you explain how these pins are used.

If they are not really general purpose pins, then this isn't the right interface.

Hi Johan,

Johan Hovold 於 2015/9/14 下午 09:33 寫道:

Quoted 9 lines · Peter Hung

Quoted 4 lines

4. RS422 Mode
1. The RTS mode is dont care.
2. Set M2/M1/M0 as 0/0/0

I don't think all gpios should be exported for these ports if they have special functions that the driver could control transparently (e.g. for SER_RS485_RTS_ON_SEND).

Surely, we can hide some setting with definitely setting like RS232/RS485, but the settings is only apply to our evaluation board.

Some customers will use our F81532/534 with other brand transceiver IC. The pins setting maybe changed, so we decided to separate UART & pins settings and let the 3 output pins controllable for customer.

Could I preserve currently UART & pins setting mode ?