Skip to contentSkip to conversation

Add support for MaxLinear/Exar USB to serial converters

PATCH Superseded [email protected] 4 participants 13 messages Apr 30, 2020 – Jun 6, 2020

Subsystems (4)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover Add support for MaxLinear/Exar USB to serial converters

From: Manivannan Sadhasivam <[email protected]>

Hello,

This series adds support for MaxLinear/Exar USB to serial converters. This driver only supports XR21V141X series but it can easily be extended to other series in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

This series has been tested with Hikey970 board hosting XR21V141X chip.

Thanks,
Mani

Changes in v3:

* Dropped the check for PID and also the reg_width property.

Changes in v2:

* Dropped the code related to handling variable register size. It's all u8 now.
* Dropped the header file and moved the contents to driver itself.
* Added Linus's reviewed-by tag for gpiochip patch.
* Added PID to gpiochip label
* Dropped gpiochip for interface 0

Manivannan Sadhasivam (2):
usb: serial: Add MaxLinear/Exar USB to Serial driver
usb: serial: xr_serial: Add gpiochip support

 drivers/usb/serial/Kconfig     |   9 +
 drivers/usb/serial/Makefile    |   1 +
 drivers/usb/serial/xr_serial.c | 821 +++++++++++++++++++++++++++++++++
 3 files changed, 831 insertions(+)
 create mode 100644 drivers/usb/serial/xr_serial.c
Signature · 1 line
2.17.1
#1 lore raw

PATCH v3 1/2 usb: serial: Add MaxLinear/Exar USB to Serial driver

From: Manivannan Sadhasivam <[email protected]>

Add support for MaxLinear/Exar USB to Serial converters. This driver only supports XR21V141X series but it can be extended to other series from Exar as well in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

---
 drivers/usb/serial/Kconfig     |   9 +
 drivers/usb/serial/Makefile    |   1 +
 drivers/usb/serial/xr_serial.c | 624 +++++++++++++++++++++++++++++++++
 3 files changed, 634 insertions(+)
 create mode 100644 drivers/usb/serial/xr_serial.c
drivers/usb/serial/Kconfig +9 -0
index 25d7e0c36d38..8f6ad9f94735 100644
@@ -644,6 +644,15 @@ config USB_SERIAL_UPD78F0730
 	  To compile this driver as a module, choose M here: the
 	  module will be called upd78f0730.
 
+config USB_SERIAL_XR
+	tristate "USB MaxLinear/Exar USB to Serial driver"
+	help
+	  Say Y here if you want to use MaxLinear/Exar USB to Serial converter
+	  devices.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called xr_serial.
+
 config USB_SERIAL_DEBUG
 	tristate "USB Debugging Device"
 	help
drivers/usb/serial/Makefile +1 -0
index 2d491e434f11..4f69c2a3aff3 100644
@@ -62,4 +62,5 @@ obj-$(CONFIG_USB_SERIAL_VISOR)			+= visor.o
 obj-$(CONFIG_USB_SERIAL_WISHBONE)		+= wishbone-serial.o
 obj-$(CONFIG_USB_SERIAL_WHITEHEAT)		+= whiteheat.o
 obj-$(CONFIG_USB_SERIAL_XIRCOM)			+= keyspan_pda.o
+obj-$(CONFIG_USB_SERIAL_XR)			+= xr_serial.o
 obj-$(CONFIG_USB_SERIAL_XSENS_MT)		+= xsens_mt.o
drivers/usb/serial/xr_serial.c new file +624 -0

624 lines not on this page · raw message

Signature · 1 line
2.17.1
#5 lore raw

PATCH v3 2/2 usb: serial: xr_serial: Add gpiochip support

In reply to [email protected]

From: Manivannan Sadhasivam <[email protected]>

Add gpiochip support for Maxlinear/Exar USB to serial converter for controlling the available gpios.

---
 drivers/usb/serial/xr_serial.c | 199 ++++++++++++++++++++++++++++++++-
 1 file changed, 198 insertions(+), 1 deletion(-)
drivers/usb/serial/xr_serial.c +198 -1
index fdb9ddf8bd95..255a30540b52 100644
@@ -7,6 +7,7 @@
  * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
  */
 
+#include <linux/gpio/driver.h>
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/slab.h>
@@ -32,6 +33,11 @@ struct xr_uart_regs {
 };
 
 struct xr_port_private {
+#ifdef CONFIG_GPIOLIB
+	struct gpio_chip gc;
+	bool gpio_registered;
+	u8 gpio_altfunc;
+#endif
 	const struct xr_uart_regs *regs;
 };
 
@@ -562,6 +568,196 @@ static void xr_break_ctl(struct tty_struct *tty, int break_state)
 		   state);
 }
 
+#ifdef CONFIG_GPIOLIB
+
+static int xr_gpio_request(struct gpio_chip *gc, unsigned int offset)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	/* Check if the requested GPIO is occupied */
+	if (port_priv->gpio_altfunc & BIT(offset))
+		return -ENODEV;
+
+	return 0;
+}
+
+static int xr_gpio_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_status;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_status, &gpio_status);
+	if (ret)
+		return ret;
+
+	return !!(gpio_status & BIT(gpio));
+}
+
+static void xr_gpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (val)
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_set, BIT(gpio));
+	else
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_clr, BIT(gpio));
+}
+
+static int xr_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	/* Logic 0 = input and Logic 1 = output */
+	return !(gpio_dir & BIT(gpio));
+}
+
+static int xr_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	gpio_dir &= ~BIT(gpio);
+
+	return xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			  port_priv->regs->gpio_dir, gpio_dir);
+}
+
+static int xr_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
+				    int val)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	gpio_dir |= BIT(gpio);
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, gpio_dir);
+	if (ret)
+		return ret;
+
+	xr_gpio_set(gc, gpio, val);
+
+	return 0;
+}
+
+static int xr21v141x_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_mode;
+
+	port_priv->gc.ngpio = 6;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return ret;
+
+	/* Mark all pins which are not in GPIO mode */
+	if (gpio_mode & UART_MODE_RTS_CTS)
+		port_priv->gpio_altfunc |= (BIT(4) | BIT(5));
+	else if (gpio_mode & UART_MODE_DTR_DSR)
+		port_priv->gpio_altfunc |= (BIT(2) | BIT(3));
+	else if (gpio_mode & UART_MODE_RS485)
+		port_priv->gpio_altfunc |= BIT(5);
+	else if (gpio_mode & UART_MODE_RS485_ADDR)
+		port_priv->gpio_altfunc |= BIT(5);
+	else
+		port_priv->gpio_altfunc = 0; /* All GPIOs are available */
+
+	return ret;
+}
+
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	struct usb_serial *serial = port->serial;
+	int ret = 0;
+	u16 pid;
+
+	/* Don't register gpiochip for interface 0 */
+	if (port->minor == 0)
+		return ret;
+
+	pid = le16_to_cpu(serial->dev->descriptor.idProduct);
+
+	ret = xr21v141x_gpio_init(port);
+	if (ret < 0)
+		return ret;
+
+	port_priv->gc.label = devm_kasprintf(&port->dev, GFP_KERNEL, "XR%04x",
+					     pid);
+	port_priv->gc.request = xr_gpio_request;
+	port_priv->gc.get_direction = xr_gpio_direction_get;
+	port_priv->gc.direction_input = xr_gpio_direction_input;
+	port_priv->gc.direction_output = xr_gpio_direction_output;
+	port_priv->gc.get = xr_gpio_get;
+	port_priv->gc.set = xr_gpio_set;
+	port_priv->gc.owner = THIS_MODULE;
+	port_priv->gc.parent = &port->dev;
+	port_priv->gc.base = -1;
+	port_priv->gc.can_sleep = true;
+
+	ret = gpiochip_add_data(&port_priv->gc, port);
+	if (!ret)
+		port_priv->gpio_registered = true;
+
+	return ret;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (port_priv->gpio_registered) {
+		gpiochip_remove(&port_priv->gc);
+		port_priv->gpio_registered = false;
+	}
+}
+
+#else
+
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	return 0;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	/* Nothing to do */
+}
+
+#endif
+
 static int xr_port_probe(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv;
@@ -575,13 +771,14 @@ static int xr_port_probe(struct usb_serial_port *port)
 
 	usb_set_serial_port_data(port, port_priv);
 
-	return 0;
+	return xr_gpio_init(port);
 }
 
 static int xr_port_remove(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
 
+	xr_gpio_remove(port);
 	kfree(port_priv);
 
 	return 0;
Signature · 1 line
2.17.1
#9 lore raw
In reply to [email protected]

Hi,

Quoted 12 lines · On Fri, May 01, 2020 at 12:19:22AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Hello,

This series adds support for MaxLinear/Exar USB to serial converters. This driver only supports XR21V141X series but it can easily be extended to other series in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

Quoted 8 lines

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

This series has been tested with Hikey970 board hosting XR21V141X chip.

Any update on this series?

Thanks,
Mani

Quoted 28 lines

Thanks,
Mani

Changes in v3:

* Dropped the check for PID and also the reg_width property.

Changes in v2:

* Dropped the code related to handling variable register size. It's all u8 now.
* Dropped the header file and moved the contents to driver itself.
* Added Linus's reviewed-by tag for gpiochip patch.
* Added PID to gpiochip label
* Dropped gpiochip for interface 0

Manivannan Sadhasivam (2):
usb: serial: Add MaxLinear/Exar USB to Serial driver
usb: serial: xr_serial: Add gpiochip support

 drivers/usb/serial/Kconfig     |   9 +
 drivers/usb/serial/Makefile    |   1 +
 drivers/usb/serial/xr_serial.c | 821 +++++++++++++++++++++++++++++++++
 3 files changed, 831 insertions(+)
 create mode 100644 drivers/usb/serial/xr_serial.c
Signature · 1 line
2.17.1
maintainer Reviewed-by on v3 1/2
#2 lore raw

Re: [PATCH v3 1/2] usb: serial: Add MaxLinear/Exar USB to Serial driver

In reply to [email protected]
Quoted 10 lines · On Fri, May 01, 2020 at 12:19:23AM +0530, [email protected] wrote:
drivers/usb/serial/xr_serial.c new file +10 -0
+static int xr_set_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 val)
+{
+	struct usb_serial *serial = port->serial;
+	int ret = -EINVAL;
+
+	/* XR21V141X uses custom command for writing UART registers */
+	ret = usb_control_msg(serial->dev,
+			      usb_sndctrlpipe(serial->dev, 0),
+			      XR_SET_XR21V141X,

drivers/usb/serial/xr_serial.c line 148

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+			      USB_DIR_OUT | USB_TYPE_VENDOR, val,
+			      reg | (block << 8), NULL, 0,
+			      USB_CTRL_SET_TIMEOUT);
+
+	if (ret < 0)
+		dev_err(&port->dev, "Failed to set reg 0x%x status: %d\n",
+			reg, ret);
+
+	return ret;
+}

So if this call is successful, it would return the number of bytes written in the control message. Which is 0. But that's kind of a hack, right? Why not just return 0 to make it more obvious and easier to read, instead of returning 'ret' and making the reader have to realize that you only are writing 0 bytes?

drivers/usb/serial/xr_serial.c line 154

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+
+static int xr_get_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 *val)
+{
+	struct usb_serial *serial = port->serial;
+	void *dmabuf;

char *dmabuf; ?

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	int ret = -EINVAL;
+
+	dmabuf = kmalloc(1, GFP_KERNEL);
+	if (!dmabuf)
+		return -ENOMEM;
+

drivers/usb/serial/xr_serial.c line 170

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	/* XR21V141X uses custom command for reading UART registers */
+	ret = usb_control_msg(serial->dev,
+			      usb_rcvctrlpipe(serial->dev, 0),
+			      XR_GET_XR21V141X,
+			      USB_DIR_IN | USB_TYPE_VENDOR, 0,
+			      reg | (block << 8), dmabuf, 1,
+			      USB_CTRL_SET_TIMEOUT);
+
+	if (ret == 1) {
+		memcpy(val, dmabuf, 1);

*val = *dmabuf; ?

drivers/usb/serial/xr_serial.c line 182

Quoted 12 lines
drivers/usb/serial/xr_serial.c new file +12 -0
+		ret = 0;
+	} else {
+		dev_err(&port->dev, "Failed to get reg 0x%x status: %d\n",
+			reg, ret);
+		if (ret >= 0)
+			ret = -EIO;
+	}
+
+	kfree(dmabuf);
+
+	return ret;
+}

Anyway, other than these minor things, this looks good to me:

maintainer
#3 lore raw

Re: [PATCH v3 1/2] usb: serial: Add MaxLinear/Exar USB to Serial driver

In reply to [email protected]
Quoted 120 lines · On Fri, May 01, 2020 at 12:19:23AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Add support for MaxLinear/Exar USB to Serial converters. This driver only supports XR21V141X series but it can be extended to other series from Exar as well in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

---
 drivers/usb/serial/Kconfig     |   9 +
 drivers/usb/serial/Makefile    |   1 +
 drivers/usb/serial/xr_serial.c | 624 +++++++++++++++++++++++++++++++++
 3 files changed, 634 insertions(+)
 create mode 100644 drivers/usb/serial/xr_serial.c
drivers/usb/serial/Kconfig +9 -0
index 25d7e0c36d38..8f6ad9f94735 100644
@@ -644,6 +644,15 @@ config USB_SERIAL_UPD78F0730
 	  To compile this driver as a module, choose M here: the
 	  module will be called upd78f0730.
 
+config USB_SERIAL_XR
+	tristate "USB MaxLinear/Exar USB to Serial driver"
+	help
+	  Say Y here if you want to use MaxLinear/Exar USB to Serial converter
+	  devices.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called xr_serial.
+
 config USB_SERIAL_DEBUG
 	tristate "USB Debugging Device"
 	help
drivers/usb/serial/Makefile +1 -0
index 2d491e434f11..4f69c2a3aff3 100644
@@ -62,4 +62,5 @@ obj-$(CONFIG_USB_SERIAL_VISOR)			+= visor.o
 obj-$(CONFIG_USB_SERIAL_WISHBONE)		+= wishbone-serial.o
 obj-$(CONFIG_USB_SERIAL_WHITEHEAT)		+= whiteheat.o
 obj-$(CONFIG_USB_SERIAL_XIRCOM)			+= keyspan_pda.o
+obj-$(CONFIG_USB_SERIAL_XR)			+= xr_serial.o
 obj-$(CONFIG_USB_SERIAL_XSENS_MT)		+= xsens_mt.o
drivers/usb/serial/xr_serial.c new file +60 -0
new file mode 100644
index 000000000000..fdb9ddf8bd95
@@ -0,0 +1,624 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * MaxLinear/Exar USB to Serial driver
+ *
+ * Based on initial driver written by Patong Yang <[email protected]>
+ *
+ * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/tty.h>
+#include <linux/usb.h>
+#include <linux/usb/serial.h>
+
+struct xr_uart_regs {
+	u8 enable;
+	u8 format;
+	u8 flow_ctrl;
+	u8 xon_char;
+	u8 xoff_char;
+	u8 loopback;
+	u8 tx_break;
+	u8 rs485_delay;
+	u8 gpio_mode;
+	u8 gpio_dir;
+	u8 gpio_int_mask;
+	u8 gpio_set;
+	u8 gpio_clr;
+	u8 gpio_status;
+};
+
+struct xr_port_private {
+	const struct xr_uart_regs *regs;
+};
+
+struct xr_txrx_clk_mask {
+	u16 tx;
+	u16 rx0;
+	u16 rx1;
+};
+
+#define XR21V141X_ID			0x1410
+#define XR_INT_OSC_HZ			48000000
+
+/* USB Requests */
+#define XR_SET_XR21V141X		0
+#define XR_GET_XR21V141X		1
+
+#define XR21V141X_CLOCK_DIVISOR_0	0x4
+#define XR21V141X_CLOCK_DIVISOR_1	0x5
+#define XR21V141X_CLOCK_DIVISOR_2	0x6
+#define XR21V141X_TX_CLOCK_MASK_0	0x7
+#define XR21V141X_TX_CLOCK_MASK_1	0x8
+#define XR21V141X_RX_CLOCK_MASK_0	0x9
+#define XR21V141X_RX_CLOCK_MASK_1	0xa
+
+/* XR21V141X register blocks */
+#define XR21V141X_UART_REG_BLOCK	0

drivers/usb/serial/xr_serial.c line 70

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+#define XR21V141X_URM_REG_BLOCK		4
+#define XR21V141X_UART_CUSTOM_BLOCK	0x66
+
+/* XR21V141X UART Manager Registers */
+#define XR21V141X_URM_FIFO_ENABLE_REG	0x10
+#define XR21V141X_URM_ENABLE_TX_FIFO	0x1
+#define XR21V141X_URM_ENABLE_RX_FIFO	0x2
+
+#define XR21V141X_URM_RX_FIFO_RESET	0x18
+#define XR21V141X_URM_TX_FIFO_RESET	0x1c

Did you mean to use "UMR" above? What does URM stand for otherwise?

Quoted 47 lines
drivers/usb/serial/xr_serial.c new file +47 -0
+
+#define UART_ENABLE_TX			0x1
+#define UART_ENABLE_RX			0x2
+
+#define UART_MODE_RI			BIT(0)
+#define UART_MODE_CD			BIT(1)
+#define UART_MODE_DSR			BIT(2)
+#define UART_MODE_DTR			BIT(3)
+#define UART_MODE_CTS			BIT(4)
+#define UART_MODE_RTS			BIT(5)
+
+#define UART_BREAK_ON			0xff
+#define UART_BREAK_OFF			0
+
+#define UART_DATA_MASK			GENMASK(3, 0)
+#define UART_DATA_7			0x7
+#define UART_DATA_8			0x8
+
+#define UART_PARITY_MASK		GENMASK(6, 4)
+#define UART_PARITY_SHIFT		0x4
+#define UART_PARITY_NONE		0x0
+#define UART_PARITY_ODD			0x1
+#define UART_PARITY_EVEN		0x2
+#define UART_PARITY_MARK		0x3
+#define UART_PARITY_SPACE		0x4
+
+#define UART_STOP_MASK			BIT(7)
+#define UART_STOP_SHIFT			0x7
+#define UART_STOP_1			0x0
+#define UART_STOP_2			0x1
+
+#define UART_FLOW_MODE_NONE		0x0
+#define UART_FLOW_MODE_HW		0x1
+#define UART_FLOW_MODE_SW		0x2
+
+#define UART_MODE_GPIO			0x0
+#define UART_MODE_RTS_CTS		0x1
+#define UART_MODE_DTR_DSR		0x2
+#define UART_MODE_RS485			0x3
+#define UART_MODE_RS485_ADDR		0x4
+
+static const struct xr_uart_regs xr21v141x_regs = {
+	.enable = 0x03,
+	.format = 0x0b,
+	.flow_ctrl = 0x0c,
+	.xon_char = 0x10,
+	.xoff_char = 0x11,

drivers/usb/serial/xr_serial.c line 127

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	.loopback = 0x12,
+	.tx_break = 0x14,
+	.rs485_delay = 0x15,
+	.gpio_mode = 0x1a,
+	.gpio_dir = 0x1b,
+	.gpio_int_mask = 0x1c,
+	.gpio_set = 0x1d,
+	.gpio_clr = 0x1e,
+	.gpio_status = 0x1f,
+};

Do you expect there to be more models supported by this driver? Perhaps you shouldn't add this abstraction until then.

drivers/usb/serial/xr_serial.c line 133

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+static int xr_set_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 val)
+{
+	struct usb_serial *serial = port->serial;
+	int ret = -EINVAL;

Pointless init.

drivers/usb/serial/xr_serial.c line 134

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+
+	/* XR21V141X uses custom command for writing UART registers */

I'd drop this comment. These control messages are also used to access the EEPROM etc.

drivers/usb/serial/xr_serial.c line 142

Quoted 7 lines
drivers/usb/serial/xr_serial.c new file +7 -0
+	ret = usb_control_msg(serial->dev,
+			      usb_sndctrlpipe(serial->dev, 0),
+			      XR_SET_XR21V141X,
+			      USB_DIR_OUT | USB_TYPE_VENDOR, val,
+			      reg | (block << 8), NULL, 0,
+			      USB_CTRL_SET_TIMEOUT);
+

Remove this newline.

drivers/usb/serial/xr_serial.c line 144

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+	if (ret < 0)
+		dev_err(&port->dev, "Failed to set reg 0x%x status: %d\n",

%02x; and skip "status" like:

	dev_err(&port->dev, "failed to set reg 0x%02x: %d\n",

drivers/usb/serial/xr_serial.c line 147

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+			reg, ret);
+
+	return ret;

As Greg suggested, please return 0 explicitly here on success.

drivers/usb/serial/xr_serial.c line 155

Quoted 8 lines
drivers/usb/serial/xr_serial.c new file +8 -0
+}
+
+static int xr_get_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 *val)
+{
+	struct usb_serial *serial = port->serial;
+	void *dmabuf;
+	int ret = -EINVAL;

Unnecessary, again.

drivers/usb/serial/xr_serial.c line 161

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+
+	dmabuf = kmalloc(1, GFP_KERNEL);
+	if (!dmabuf)
+		return -ENOMEM;
+
+	/* XR21V141X uses custom command for reading UART registers */

Drop this.

drivers/usb/serial/xr_serial.c line 167

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	ret = usb_control_msg(serial->dev,
+			      usb_rcvctrlpipe(serial->dev, 0),
+			      XR_GET_XR21V141X,
+			      USB_DIR_IN | USB_TYPE_VENDOR, 0,
+			      reg | (block << 8), dmabuf, 1,
+			      USB_CTRL_SET_TIMEOUT);

s/SET/GET/

drivers/usb/serial/xr_serial.c line 167

Quoted 1 line
drivers/usb/serial/xr_serial.c new file +1 -0
+

No newline.

drivers/usb/serial/xr_serial.c line 170

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+	if (ret == 1) {
+		memcpy(val, dmabuf, 1);

Use u8 and assignment here as Greg suggested.

drivers/usb/serial/xr_serial.c line 173

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+		ret = 0;
+	} else {
+		dev_err(&port->dev, "Failed to get reg 0x%x status: %d\n",

As above.

Quoted 40 lines
drivers/usb/serial/xr_serial.c new file +40 -0
+			reg, ret);
+		if (ret >= 0)
+			ret = -EIO;
+	}
+
+	kfree(dmabuf);
+
+	return ret;
+}
+
+/* Tx and Rx clock mask values obtained from section 3.3.4 of datasheet */
+static const struct xr_txrx_clk_mask xr21v141x_txrx_clk_masks[] = {
+	{ 0x000, 0x000, 0x000 },
+	{ 0x000, 0x000, 0x000 },
+	{ 0x100, 0x000, 0x100 },
+	{ 0x020, 0x400, 0x020 },
+	{ 0x010, 0x100, 0x010 },
+	{ 0x208, 0x040, 0x208 },
+	{ 0x104, 0x820, 0x108 },
+	{ 0x844, 0x210, 0x884 },
+	{ 0x444, 0x110, 0x444 },
+	{ 0x122, 0x888, 0x224 },
+	{ 0x912, 0x448, 0x924 },
+	{ 0x492, 0x248, 0x492 },
+	{ 0x252, 0x928, 0x292 },
+	{ 0x94a, 0x4a4, 0xa52 },
+	{ 0x52a, 0xaa4, 0x54a },
+	{ 0xaaa, 0x954, 0x4aa },
+	{ 0xaaa, 0x554, 0xaaa },
+	{ 0x555, 0xad4, 0x5aa },
+	{ 0xb55, 0xab4, 0x55a },
+	{ 0x6b5, 0x5ac, 0xb56 },
+	{ 0x5b5, 0xd6c, 0x6d6 },
+	{ 0xb6d, 0xb6a, 0xdb6 },
+	{ 0x76d, 0x6da, 0xbb6 },
+	{ 0xedd, 0xdda, 0x76e },
+	{ 0xddd, 0xbba, 0xeee },
+	{ 0x7bb, 0xf7a, 0xdde },
+	{ 0xf7b, 0xef6, 0x7de },
+	{ 0xdf7, 0xbf6, 0xf7e },

drivers/usb/serial/xr_serial.c line 223

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	{ 0x7f7, 0xfee, 0xefe },
+	{ 0xfdf, 0xfbe, 0x7fe },
+	{ 0xf7f, 0xefe, 0xffe },
+	{ 0xfff, 0xffe, 0xffd },
+};
+
+static int xr_set_baudrate(struct tty_struct *tty,
+			   struct usb_serial_port *port)
+{
+	u32 divisor = XR_INT_OSC_HZ / tty->termios.c_ospeed;

Boom -- division by zero. B0 should drop DTR/RTS.

drivers/usb/serial/xr_serial.c line 227

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+	u32 idx = (32 * divisor) & 0x1f;
+	u16 tx_mask = xr21v141x_txrx_clk_masks[idx].tx;
+	u16 rx_mask = (divisor & 1) ? xr21v141x_txrx_clk_masks[idx].rx1 :
+				      xr21v141x_txrx_clk_masks[idx].rx0;

Don't do non-trivial initialisations like this as part of declaration. Avoid the ternary operator.

drivers/usb/serial/xr_serial.c line 230

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+	int ret;
+
+	dev_dbg(&port->dev, "Setting baud rate :%u\n", tty->termios.c_ospeed);

Space after ':', not before.

Quoted 61 lines
drivers/usb/serial/xr_serial.c new file +61 -0
+
+	/*
+	 * XR21V141X uses fractional baud rate generator with 48MHz internal
+	 * oscillator and 19-bit programmable divisor. So theoretically it can
+	 * generate most commonly used baud rates with high accuracy.
+	 */
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_0, (divisor & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_1, ((divisor >>  8) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_2, ((divisor >> 16) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_TX_CLOCK_MASK_0, (tx_mask & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_TX_CLOCK_MASK_1, ((tx_mask >>  8) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_RX_CLOCK_MASK_0, (rx_mask & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_RX_CLOCK_MASK_1, ((rx_mask >>  8) & 0xff));
+
+	return ret;
+}
+
+/*
+ * According to datasheet, below is the recommended sequence for enabling UART
+ * module in XR21V141X:
+ *
+ * Enable Tx FIFO
+ * Enable Tx and Rx
+ * Enable Rx FIFO
+ */
+static int xr_uart_enable(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG,
+			 XR21V141X_URM_ENABLE_TX_FIFO);
+	if (ret)
+		return ret;
+

drivers/usb/serial/xr_serial.c line 301

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->enable,
+			 UART_ENABLE_TX | UART_ENABLE_RX);
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG,
+			 XR21V141X_URM_ENABLE_TX_FIFO |
+			 XR21V141X_URM_ENABLE_RX_FIFO);

Should you be undoing these on errors?

Quoted 21 lines
drivers/usb/serial/xr_serial.c new file +21 -0
+
+	return ret;
+}
+
+static int xr_uart_disable(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->enable, 0);
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG, 0);
+
+	return ret;
+}
+
+static int xr_open(struct tty_struct *tty, struct usb_serial_port *port)

drivers/usb/serial/xr_serial.c line 332

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+{
+	int ret;
+
+	ret = xr_uart_enable(port);
+	if (ret) {
+		dev_err(&port->dev, "Failed to enable UART\n");
+		return ret;
+	}
+
+	ret = xr_set_baudrate(tty, port);

tty will be NULL when called by the console driver.

Why only init the line speed? Driver typically call set_termios() here when not used as a console.

drivers/usb/serial/xr_serial.c line 338

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	if (ret) {
+		dev_err(&port->dev, "Failed to set baudrate\n");
+		return ret;
+	}
+
+	return usb_serial_generic_open(tty, port);

Disable on errors?

Quoted 16 lines
drivers/usb/serial/xr_serial.c new file +16 -0
+}
+
+static void xr_close(struct usb_serial_port *port)
+{
+	usb_serial_generic_close(port);
+
+	xr_uart_disable(port);
+}
+
+static void xr_set_flow_mode(struct tty_struct *tty,
+			     struct usb_serial_port *port,
+			     unsigned int cflag)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	u8 flow, gpio_mode;
+	int ret;

drivers/usb/serial/xr_serial.c line 364

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return;
+
+	if (cflag & CRTSCTS) {
+		dev_dbg(&port->dev, "Enabling hardware flow ctrl\n");
+		flow = UART_FLOW_MODE_HW;
+		gpio_mode |= UART_MODE_RTS_CTS;

These modes are exclusive, you cannot use |= here.

drivers/usb/serial/xr_serial.c line 365

Quoted 1 line
drivers/usb/serial/xr_serial.c new file +1 -0
+	} else if (I_IXOFF(tty) || I_IXON(tty)) {

This should just be IXOFF(tty) (flow control on input).

drivers/usb/serial/xr_serial.c line 371

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+		u8 start_char = START_CHAR(tty);
+		u8 stop_char = STOP_CHAR(tty);
+
+		dev_dbg(&port->dev, "Enabling sw flow ctrl\n");
+		flow = UART_FLOW_MODE_SW;
+		gpio_mode |= UART_MODE_GPIO;

Same here, this is broken; ORing with 0 doesn't set mode 0.

drivers/usb/serial/xr_serial.c line 379

Quoted 8 lines
drivers/usb/serial/xr_serial.c new file +8 -0
+
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->xon_char, start_char);
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->xoff_char, stop_char);
+	} else {
+		dev_dbg(&port->dev, "No flow ctrl\n");
+		flow = UART_FLOW_MODE_NONE;

I assume you need to set UART_MODE_GPIO here too to be able to control RTS manually (default mode is RTS/CTS flow control).

drivers/usb/serial/xr_serial.c line 385

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	}
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->flow_ctrl, flow);
+	if (ret)
+		return;

The datasheet says that the flow control register can only be updated when the uart is disabled.

"These registers should only be written to when the UART is
disabled. Writing to the FLOW_CONTROL register when the UART is enabled will result in undefined behavior."

Quoted 15 lines
drivers/usb/serial/xr_serial.c new file +15 -0
+
+	xr_set_reg(port, XR21V141X_UART_REG_BLOCK, port_priv->regs->gpio_mode,
+		   gpio_mode);
+}
+
+static void xr_set_termios(struct tty_struct *tty,
+			   struct usb_serial_port *port,
+			   struct ktermios *old_termios)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	struct device *dev = &port->dev;
+	unsigned int cflag, old_cflag;
+	int ret;
+	u8 bits;
+

drivers/usb/serial/xr_serial.c line 410

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	cflag = tty->termios.c_cflag;
+	old_cflag = old_termios->c_cflag;
+
+	if (tty->termios.c_ospeed != old_termios->c_ospeed)
+		xr_set_baudrate(tty, port);
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->format, &bits);
+	if (ret)
+		return;

No need to retrieve the current settings.

drivers/usb/serial/xr_serial.c line 413

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+
+	/* If the number of data bits is to be updated */
+	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {

Use C_CSIZE(tty) and friends and set these unconditionally.

drivers/usb/serial/xr_serial.c line 424

Quoted 11 lines
drivers/usb/serial/xr_serial.c new file +11 -0
+		bits &= ~UART_DATA_MASK;
+		switch (cflag & CSIZE) {
+		case CS7:
+			bits |= UART_DATA_7;
+			dev_dbg(dev, "Setting data bits: 7\n");
+			break;
+		case CS8:
+		/* CS9 not supported */
+		default:
+			bits |= UART_DATA_8;
+			dev_dbg(dev, "Setting data bits: 8\n");

You should report back that you cannot set CS5 and CS6 by restoring the old setting in tty->termios.

drivers/usb/serial/xr_serial.c line 430

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+			break;
+		}
+	}
+
+	if ((cflag & (PARENB | PARODD | CMSPAR)) !=
+	    (old_cflag & (PARENB | PARODD | CMSPAR))) {

As above, determine these bits unconditionally.

drivers/usb/serial/xr_serial.c line 436

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+		bits &= ~UART_PARITY_MASK;
+		if (cflag & PARENB) {
+			if (cflag & CMSPAR) {
+				if (cflag & PARODD) {
+					bits |= (UART_PARITY_MARK <<
+						 UART_PARITY_SHIFT);

Parenthesis not need. Hopefully cleaner when you have reduced indentation.

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+					dev_dbg(dev, "Setting parity: MARK\n");
+				} else {
+					bits |= (UART_PARITY_SPACE <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: SPACE\n");

drivers/usb/serial/xr_serial.c line 451

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+				}
+			} else {
+				if (cflag & PARODD) {
+					bits |= (UART_PARITY_ODD <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: ODD\n");
+				} else {
+					bits |= (UART_PARITY_EVEN <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: EVEN\n");

And please drop all these dev_dbg (also for data bits).

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+				}
+			}
+		}
+	}
+

drivers/usb/serial/xr_serial.c line 466

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
+		bits &= ~UART_STOP_MASK;
+		if (cflag & CSTOPB) {
+			bits |= (UART_STOP_2 << UART_STOP_SHIFT);
+			dev_dbg(dev, "Setting stop bits: 2\n");
+		} else {
+			bits |= (UART_STOP_1 << UART_STOP_SHIFT);
+			dev_dbg(dev, "Setting stop bits: 1\n");
+		}
+	}

As above.

drivers/usb/serial/xr_serial.c line 469

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->format, (bits & 0xff));

bits is u8, no need to mask

drivers/usb/serial/xr_serial.c line 473

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+	if (ret)
+		return;
+
+	xr_set_flow_mode(tty, port, cflag);

cflag can be retreived from tty.

Quoted 14 lines
drivers/usb/serial/xr_serial.c new file +14 -0
+}
+
+static int xr_tiocmset_port(struct usb_serial_port *port,
+			    unsigned int set, unsigned int clear)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret = 0;
+	u8 gpio_set = 0;
+	u8 gpio_clr = 0;
+
+	/* Modem control pins are active low, so set & clr are swapped */
+	if (set & TIOCM_RTS)
+		gpio_clr |= UART_MODE_RTS;
+	if (set & TIOCM_DTR)

drivers/usb/serial/xr_serial.c line 497

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+		gpio_clr |= UART_MODE_DTR;
+	if (clear & TIOCM_RTS)
+		gpio_set |= UART_MODE_RTS;
+	if (clear & TIOCM_DTR)
+		gpio_set |= UART_MODE_DTR;
+
+	/* Writing '0' to gpio_{set/clr} bits has no effect, so no need to do */
+	if (gpio_clr)
+		ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+				 port_priv->regs->gpio_clr, gpio_clr);

Please add brackets since you have a multiline statement here.

drivers/usb/serial/xr_serial.c line 501

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+
+	if (gpio_set)
+		ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+				 port_priv->regs->gpio_set, gpio_set);

Same here.

Quoted 32 lines
drivers/usb/serial/xr_serial.c new file +32 -0
+
+	return ret;
+}
+
+static int xr_tiocmset(struct tty_struct *tty,
+		       unsigned int set, unsigned int clear)
+{
+	struct usb_serial_port *port = tty->driver_data;
+
+	return xr_tiocmset_port(port, set, clear);
+}
+
+static void xr_dtr_rts(struct usb_serial_port *port, int on)
+{
+	if (on)
+		xr_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
+	else
+		xr_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
+}
+
+static int xr_tiocmget(struct tty_struct *tty)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 status;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_status, &status);
+	if (ret)
+		return ret;
+

drivers/usb/serial/xr_serial.c line 543

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	/*
+	 * Modem control pins are active low, so reading '0' means it is active
+	 * and '1' means not active.
+	 */
+	ret = ((status & UART_MODE_DTR) ? 0 : TIOCM_DTR) |
+	      ((status & UART_MODE_RTS) ? 0 : TIOCM_RTS) |
+	      ((status & UART_MODE_CTS) ? 0 : TIOCM_CTS) |
+	      ((status & UART_MODE_DSR) ? 0 : TIOCM_DSR) |
+	      ((status & UART_MODE_RI) ? 0 : TIOCM_RI) |
+	      ((status & UART_MODE_CD) ? 0 : TIOCM_CD);

Can you read back also the outputs? Also in automatic mode?

Quoted 21 lines
drivers/usb/serial/xr_serial.c new file +21 -0
+
+	return ret;
+}
+
+static void xr_break_ctl(struct tty_struct *tty, int break_state)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	u8 state;
+
+	if (break_state == 0)
+		state = UART_BREAK_OFF;
+	else
+		state = UART_BREAK_ON;
+
+	dev_dbg(&port->dev, "Turning break %s\n",
+		state == UART_BREAK_OFF ? "off" : "on");
+	xr_set_reg(port, XR21V141X_UART_REG_BLOCK, port_priv->regs->tx_break,
+		   state);
+}
+

drivers/usb/serial/xr_serial.c line 574

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+static int xr_port_probe(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv;
+
+	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
+	if (!port_priv)
+		return -ENOMEM;
+
+	/* XR21V141X specific settings */
+	port_priv->regs = &xr21v141x_regs;

May not be needed.

Quoted 20 lines
drivers/usb/serial/xr_serial.c new file +20 -0
+
+	usb_set_serial_port_data(port, port_priv);
+
+	return 0;
+}
+
+static int xr_port_remove(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	kfree(port_priv);
+
+	return 0;
+}
+
+static const struct usb_device_id id_table[] = {
+	{ USB_DEVICE(0x04e2, 0x1410) }, /* XR21V141X */
+	{ }
+};
+MODULE_DEVICE_TABLE(usb, id_table);

drivers/usb/serial/xr_serial.c line 604

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+
+static struct usb_serial_driver xr_device = {
+	.driver = {
+		.owner = THIS_MODULE,
+		.name =	"xr_serial",
+	},
+	.id_table		= id_table,
+	.num_ports		= 1,
+	.bulk_in_size		= 384,
+	.bulk_out_size		= 128,

You should not necessarily set these to match the hardware fifo sizes. They default to the respective endpoint size, but may be increased for improved throughput.

drivers/usb/serial/xr_serial.c line 614

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	.open			= xr_open,
+	.close			= xr_close,
+	.break_ctl		= xr_break_ctl,
+	.set_termios		= xr_set_termios,
+	.tiocmget		= xr_tiocmget,
+	.tiocmset		= xr_tiocmset,
+	.port_probe		= xr_port_probe,
+	.port_remove		= xr_port_remove,
+	.dtr_rts		= xr_dtr_rts
+};

As I mentioned elsewhere, you should only register a tty device for the data interface, but still claim the control interface.

You probably should reject the control interface and claim it when probing the data interface (rather than return 1 from attach as I mentioned earlier).

drivers/usb/serial/xr_serial.c line 624

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+
+static struct usb_serial_driver * const serial_drivers[] = {
+	&xr_device, NULL
+};
+
+module_usb_serial_driver(serial_drivers, id_table);
+
+MODULE_AUTHOR("Manivannan Sadhasivam <[email protected]>");
+MODULE_DESCRIPTION("MaxLinear/Exar USB to Serial driver");
+MODULE_LICENSE("GPL");

Generally nice and clean overall.

Johan

maintainer
#6 lore raw

Re: [PATCH v3 2/2] usb: serial: xr_serial: Add gpiochip support

In reply to [email protected]
Quoted 4 lines · On Fri, May 01, 2020 at 12:19:24AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Add gpiochip support for Maxlinear/Exar USB to serial converter for controlling the available gpios.

You should mention that you've based this implementation on the other usb-serial gpio-chip implementations (e.g. cp210x).

Quoted 66 lines
---
 drivers/usb/serial/xr_serial.c | 199 ++++++++++++++++++++++++++++++++-
 1 file changed, 198 insertions(+), 1 deletion(-)
drivers/usb/serial/xr_serial.c +36 -0
index fdb9ddf8bd95..255a30540b52 100644
@@ -7,6 +7,7 @@
  * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
  */
 
+#include <linux/gpio/driver.h>
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/slab.h>
@@ -32,6 +33,11 @@ struct xr_uart_regs {
 };
 
 struct xr_port_private {
+#ifdef CONFIG_GPIOLIB
+	struct gpio_chip gc;
+	bool gpio_registered;
+	u8 gpio_altfunc;
+#endif
 	const struct xr_uart_regs *regs;
 };
 
@@ -562,6 +568,196 @@ static void xr_break_ctl(struct tty_struct *tty, int break_state)
 		   state);
 }
 
+#ifdef CONFIG_GPIOLIB
+
+static int xr_gpio_request(struct gpio_chip *gc, unsigned int offset)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	/* Check if the requested GPIO is occupied */
+	if (port_priv->gpio_altfunc & BIT(offset))
+		return -ENODEV;
+
+	return 0;
+}
+
+static int xr_gpio_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_status;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_status, &gpio_status);
+	if (ret)
+		return ret;
+
+	return !!(gpio_status & BIT(gpio));
+}
+
+static void xr_gpio_set(struct gpio_chip *gc, unsigned int gpio, int val)

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 610

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (val)
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_set, BIT(gpio));
+	else
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_clr, BIT(gpio));

I see no coordination with the serial driver which may toggle the DTR and RTS pins.

Quoted 47 lines
drivers/usb/serial/xr_serial.c +47 -0
+}
+
+static int xr_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	/* Logic 0 = input and Logic 1 = output */
+	return !(gpio_dir & BIT(gpio));
+}
+
+static int xr_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	gpio_dir &= ~BIT(gpio);
+
+	return xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			  port_priv->regs->gpio_dir, gpio_dir);
+}
+
+static int xr_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
+				    int val)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 667

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+		return ret;
+
+	gpio_dir |= BIT(gpio);
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, gpio_dir);
+	if (ret)
+		return ret;
+
+	xr_gpio_set(gc, gpio, val);

If it's possible to set the value before changing direction then that may be preferable.

Quoted 18 lines
drivers/usb/serial/xr_serial.c +18 -0
+
+	return 0;
+}
+
+static int xr21v141x_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_mode;
+
+	port_priv->gc.ngpio = 6;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return ret;
+
+	/* Mark all pins which are not in GPIO mode */

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 695

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+	if (gpio_mode & UART_MODE_RTS_CTS)
+		port_priv->gpio_altfunc |= (BIT(4) | BIT(5));
+	else if (gpio_mode & UART_MODE_DTR_DSR)
+		port_priv->gpio_altfunc |= (BIT(2) | BIT(3));
+	else if (gpio_mode & UART_MODE_RS485)
+		port_priv->gpio_altfunc |= BIT(5);
+	else if (gpio_mode & UART_MODE_RS485_ADDR)
+		port_priv->gpio_altfunc |= BIT(5);
+	else
+		port_priv->gpio_altfunc = 0; /* All GPIOs are available */

So this clearly isn't sufficient as the serial driver updates the gpio-mode settings at runtime, which means you may have the two drivers interfering with each other.

You probably need to reserve at least CTS/RTS (gpio 4 and 5) for use by the serial driver. But suddenly driving the DSR, RI and CD inputs probably isn't a good idea either.

How would you even what know what these pins are used for generally?

Perhaps refusing all gpio requests while the port is open and making sure that the serial driver never touches a requested pin could work (including indirectly through hardware flow control, etc).

Quoted 4 lines
drivers/usb/serial/xr_serial.c +4 -0
+
+	return ret;
+}
+

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 709

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	struct usb_serial *serial = port->serial;
+	int ret = 0;
+	u16 pid;
+
+	/* Don't register gpiochip for interface 0 */
+	if (port->minor == 0)
+		return ret;

Heh. Nice hack. Unfortunately entirely broken as it only works if this happens to be the first usb-serial device that is probed (port->minor is the usb-serial port minor number, not the interface number).

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 718

Quoted 9 lines
drivers/usb/serial/xr_serial.c +9 -0
+
+	pid = le16_to_cpu(serial->dev->descriptor.idProduct);
+
+	ret = xr21v141x_gpio_init(port);
+	if (ret < 0)
+		return ret;
+
+	port_priv->gc.label = devm_kasprintf(&port->dev, GFP_KERNEL, "XR%04x",
+					     pid);

No point in adding PID here.

Quoted 28 lines
drivers/usb/serial/xr_serial.c +28 -0
+	port_priv->gc.request = xr_gpio_request;
+	port_priv->gc.get_direction = xr_gpio_direction_get;
+	port_priv->gc.direction_input = xr_gpio_direction_input;
+	port_priv->gc.direction_output = xr_gpio_direction_output;
+	port_priv->gc.get = xr_gpio_get;
+	port_priv->gc.set = xr_gpio_set;
+	port_priv->gc.owner = THIS_MODULE;
+	port_priv->gc.parent = &port->dev;
+	port_priv->gc.base = -1;
+	port_priv->gc.can_sleep = true;
+
+	ret = gpiochip_add_data(&port_priv->gc, port);
+	if (!ret)
+		port_priv->gpio_registered = true;
+
+	return ret;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (port_priv->gpio_registered) {
+		gpiochip_remove(&port_priv->gc);
+		port_priv->gpio_registered = false;
+	}
+}
+

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 756

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+#else
+
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	return 0;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	/* Nothing to do */

Comment not needed.

drivers/usb/serial/xr_serial.c static int xr_port_probe(struct usb_serial_port *port) · line 774

Quoted 13 lines
drivers/usb/serial/xr_serial.c +5 -1
+}
+
+#endif
+
 static int xr_port_probe(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv;
@@ -575,13 +771,14 @@ static int xr_port_probe(struct usb_serial_port *port)
 
 	usb_set_serial_port_data(port, port_priv);
 
-	return 0;
+	return xr_gpio_init(port);

This is broken; you'll leak the port data on errors.

drivers/usb/serial/xr_serial.c static int xr_port_probe(struct usb_serial_port *port) · line 784

Quoted 10 lines
drivers/usb/serial/xr_serial.c +1 -0
 }
 
 static int xr_port_remove(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
 
+	xr_gpio_remove(port);
 	kfree(port_priv);
 
 	return 0;

Johan

#7 lore raw

Re: [PATCH v3 2/2] usb: serial: xr_serial: Add gpiochip support

Hi,

Quoted 174 lines · Johan Hovold
Quoted 4 lines · On Fri, May 01, 2020 at 12:19:24AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Add gpiochip support for Maxlinear/Exar USB to serial converter for controlling the available gpios.

You should mention that you've based this implementation on the other usb-serial gpio-chip implementations (e.g. cp210x).

Quoted 66 lines
---
 drivers/usb/serial/xr_serial.c | 199 ++++++++++++++++++++++++++++++++-
 1 file changed, 198 insertions(+), 1 deletion(-)
drivers/usb/serial/xr_serial.c +36 -0
index fdb9ddf8bd95..255a30540b52 100644
@@ -7,6 +7,7 @@
  * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
  */
 
+#include <linux/gpio/driver.h>
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/slab.h>
@@ -32,6 +33,11 @@ struct xr_uart_regs {
 };
 
 struct xr_port_private {
+#ifdef CONFIG_GPIOLIB
+	struct gpio_chip gc;
+	bool gpio_registered;
+	u8 gpio_altfunc;
+#endif
 	const struct xr_uart_regs *regs;
 };
 
@@ -562,6 +568,196 @@ static void xr_break_ctl(struct tty_struct *tty, int break_state)
 		   state);
 }
 
+#ifdef CONFIG_GPIOLIB
+
+static int xr_gpio_request(struct gpio_chip *gc, unsigned int offset)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	/* Check if the requested GPIO is occupied */
+	if (port_priv->gpio_altfunc & BIT(offset))
+		return -ENODEV;
+
+	return 0;
+}
+
+static int xr_gpio_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_status;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_status, &gpio_status);
+	if (ret)
+		return ret;
+
+	return !!(gpio_status & BIT(gpio));
+}
+
+static void xr_gpio_set(struct gpio_chip *gc, unsigned int gpio, int val)

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 610

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (val)
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_set, BIT(gpio));
+	else
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->gpio_clr, BIT(gpio));

I see no coordination with the serial driver which may toggle the DTR and RTS pins.

Quoted 47 lines
drivers/usb/serial/xr_serial.c +47 -0
+}
+
+static int xr_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	/* Logic 0 = input and Logic 1 = output */
+	return !(gpio_dir & BIT(gpio));
+}
+
+static int xr_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)
+		return ret;
+
+	gpio_dir &= ~BIT(gpio);
+
+	return xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			  port_priv->regs->gpio_dir, gpio_dir);
+}
+
+static int xr_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
+				    int val)
+{
+	struct usb_serial_port *port = gpiochip_get_data(gc);
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_dir;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, &gpio_dir);
+	if (ret)

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 667

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+		return ret;
+
+	gpio_dir |= BIT(gpio);
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_dir, gpio_dir);
+	if (ret)
+		return ret;
+
+	xr_gpio_set(gc, gpio, val);

If it's possible to set the value before changing direction then that may be preferable.

Quoted 24 lines
drivers/usb/serial/xr_serial.c +24 -0
+
+	return 0;
+}
+
+static int xr21v141x_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_mode;
+
+	port_priv->gc.ngpio = 6;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return ret;
+
+	/* Mark all pins which are not in GPIO mode */
+	if (gpio_mode & UART_MODE_RTS_CTS)
+		port_priv->gpio_altfunc |= (BIT(4) | BIT(5));
+	else if (gpio_mode & UART_MODE_DTR_DSR)
+		port_priv->gpio_altfunc |= (BIT(2) | BIT(3));
+	else if (gpio_mode & UART_MODE_RS485)
+		port_priv->gpio_altfunc |= BIT(5);
Quoted 9 lines

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 695

Quoted 4 lines
drivers/usb/serial/xr_serial.c +4 -0
+	else if (gpio_mode & UART_MODE_RS485_ADDR)
+		port_priv->gpio_altfunc |= BIT(5);
+	else
+		port_priv->gpio_altfunc = 0; /* All GPIOs are available */

So this clearly isn't sufficient as the serial driver updates the gpio-mode settings at runtime, which means you may have the two drivers interfering with each other.

Agree. I was not sure earlier on how to handle this.

Quoted 10 lines

You probably need to reserve at least CTS/RTS (gpio 4 and 5) for use by the serial driver. But suddenly driving the DSR, RI and CD inputs probably isn't a good idea either.

How would you even what know what these pins are used for generally?

Perhaps refusing all gpio requests while the port is open and making sure that the serial driver never touches a requested pin could work (including indirectly through hardware flow control, etc).

Is there an API or recommended way to check if the port is open? I just see a helper for tty...

Thanks,
Mani

Quoted 100 lines
Quoted 4 lines
drivers/usb/serial/xr_serial.c +4 -0
+
+	return ret;
+}
+

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 709

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	struct usb_serial *serial = port->serial;
+	int ret = 0;
+	u16 pid;
+
+	/* Don't register gpiochip for interface 0 */
+	if (port->minor == 0)
+		return ret;

Heh. Nice hack. Unfortunately entirely broken as it only works if this happens to be the first usb-serial device that is probed (port->minor is the usb-serial port minor number, not the interface number).

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 718

Quoted 9 lines
drivers/usb/serial/xr_serial.c +9 -0
+
+	pid = le16_to_cpu(serial->dev->descriptor.idProduct);
+
+	ret = xr21v141x_gpio_init(port);
+	if (ret < 0)
+		return ret;
+
+	port_priv->gc.label = devm_kasprintf(&port->dev, GFP_KERNEL, "XR%04x",
+					     pid);

No point in adding PID here.

Quoted 28 lines
drivers/usb/serial/xr_serial.c +28 -0
+	port_priv->gc.request = xr_gpio_request;
+	port_priv->gc.get_direction = xr_gpio_direction_get;
+	port_priv->gc.direction_input = xr_gpio_direction_input;
+	port_priv->gc.direction_output = xr_gpio_direction_output;
+	port_priv->gc.get = xr_gpio_get;
+	port_priv->gc.set = xr_gpio_set;
+	port_priv->gc.owner = THIS_MODULE;
+	port_priv->gc.parent = &port->dev;
+	port_priv->gc.base = -1;
+	port_priv->gc.can_sleep = true;
+
+	ret = gpiochip_add_data(&port_priv->gc, port);
+	if (!ret)
+		port_priv->gpio_registered = true;
+
+	return ret;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	if (port_priv->gpio_registered) {
+		gpiochip_remove(&port_priv->gc);
+		port_priv->gpio_registered = false;
+	}
+}
+

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 756

Quoted 10 lines
drivers/usb/serial/xr_serial.c +10 -0
+#else
+
+static int xr_gpio_init(struct usb_serial_port *port)
+{
+	return 0;
+}
+
+static void xr_gpio_remove(struct usb_serial_port *port)
+{
+	/* Nothing to do */

Comment not needed.

drivers/usb/serial/xr_serial.c static int xr_port_probe(struct usb_serial_port *port) · line 774

Quoted 13 lines
drivers/usb/serial/xr_serial.c +5 -1
+}
+
+#endif
+
 static int xr_port_probe(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv;
@@ -575,13 +771,14 @@ static int xr_port_probe(struct usb_serial_port *port)
 
 	usb_set_serial_port_data(port, port_priv);
 
-	return 0;
+	return xr_gpio_init(port);

This is broken; you'll leak the port data on errors.

drivers/usb/serial/xr_serial.c static int xr_port_probe(struct usb_serial_port *port) · line 784

Quoted 10 lines
drivers/usb/serial/xr_serial.c +1 -0
 }
 
 static int xr_port_remove(struct usb_serial_port *port)
 {
 	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
 
+	xr_gpio_remove(port);
 	kfree(port_priv);
 
 	return 0;

Johan

maintainer
#8 lore raw

Re: [PATCH v3 2/2] usb: serial: xr_serial: Add gpiochip support

Quoted 44 lines · Manivannan Sadhasivam

Hi,

Quoted 26 lines · Johan Hovold
Quoted 25 lines · On Fri, May 01, 2020 at 12:19:24AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Add gpiochip support for Maxlinear/Exar USB to serial converter for controlling the available gpios.

drivers/usb/serial/xr_serial.c +20 -0
+static int xr21v141x_gpio_init(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 gpio_mode;
+
+	port_priv->gc.ngpio = 6;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return ret;
+
+	/* Mark all pins which are not in GPIO mode */
+	if (gpio_mode & UART_MODE_RTS_CTS)
+		port_priv->gpio_altfunc |= (BIT(4) | BIT(5));
+	else if (gpio_mode & UART_MODE_DTR_DSR)
+		port_priv->gpio_altfunc |= (BIT(2) | BIT(3));
+	else if (gpio_mode & UART_MODE_RS485)
+		port_priv->gpio_altfunc |= BIT(5);
Quoted 8 lines

drivers/usb/serial/xr_serial.c static void xr_break_ctl(struct tty_struct *tty, int break_state) · line 695

Quoted 4 lines
drivers/usb/serial/xr_serial.c +4 -0
+	else if (gpio_mode & UART_MODE_RS485_ADDR)
+		port_priv->gpio_altfunc |= BIT(5);
+	else
+		port_priv->gpio_altfunc = 0; /* All GPIOs are available */

So this clearly isn't sufficient as the serial driver updates the gpio-mode settings at runtime, which means you may have the two drivers interfering with each other.

Agree. I was not sure earlier on how to handle this.

Quoted 4 lines

You probably need to reserve at least CTS/RTS (gpio 4 and 5) for use by the serial driver. But suddenly driving the DSR, RI and CD inputs probably isn't a good idea either.

Quoted 8 lines
Quoted 5 lines

How would you even what know what these pins are used for generally?

Perhaps refusing all gpio requests while the port is open and making sure that the serial driver never touches a requested pin could work (including indirectly through hardware flow control, etc).

Is there an API or recommended way to check if the port is open? I just see a helper for tty...

You're gonna need to add your own flag and locking as you're coordinating two distinct drivers.

Johan

#10 lore raw
In reply to [email protected]

Em Fri, 1 May 2020 00:19:22 +0530
[email protected] escreveu:

Quoted 10 lines

From: Manivannan Sadhasivam <[email protected]>

Hello,

This series adds support for MaxLinear/Exar USB to serial converters. This driver only supports XR21V141X series but it can easily be extended to other series in future.

This driver is inspired from the initial one submitted by Patong Yang:

Quoted 7 lines

https://patchwork.kernel.org/patch/10543261/

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

Hmm... I guess you also need the enclosed patch, to ensure that cdc_acm won't try to hijack it, when the Kernel is built with both drivers.

Thanks,
Mauro

[PATCH] usb: cdc-acm: ignore Exar XR21V141X when serial driver is
built

The RTS/CTS line discipline for this device doesn't follow the standard. So, in order to properly support TX, a separate driver is needed.

Ensure that cdc_acm will ignore it during probe time, if the Kernel is built with support for it.

drivers/usb/class/cdc-acm.c +5 -1
index ded8d93834ca..f87288834ded 100644
@@ -1889,7 +1889,11 @@ static const struct usb_device_id acm_ids[] = {
 	.driver_info = IGNORE_DEVICE,
 	},
 #endif
-
+#if IS_ENABLED(CONFIG_USB_SERIAL_XR)
+	{ USB_DEVICE(0x04e2, 0x1410),   /* XR21V141X uses a different rts/cts discipline */
+	.driver_info = IGNORE_DEVICE,
+	},
+#endif
 	/*Samsung phone in firmware update mode */
 	{ USB_DEVICE(0x04e8, 0x685d),
 	.driver_info = IGNORE_DEVICE,
Tested-by on the v3 series
#12 lore raw
In reply to [email protected]

Em Fri, 1 May 2020 00:19:22 +0530
[email protected] escreveu:

Quoted 12 lines

From: Manivannan Sadhasivam <[email protected]>

Hello,

This series adds support for MaxLinear/Exar USB to serial converters. This driver only supports XR21V141X series but it can easily be extended to other series in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

Quoted 7 lines

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

This series has been tested with Hikey970 board hosting XR21V141X chip.

I applied this series on the top of Kernel 5.7 (x86_64), and I'm using it to access the Hikey970 console.

Seems to be working fine. So, feel free to add:

Thanks,
Mauro

#11 lore raw
In reply to Mauro Carvalho Chehab

Hi Mauro,

Quoted 15 lines · Mauro Carvalho Chehab

Em Fri, 1 May 2020 00:19:22 +0530
[email protected] escreveu:

Quoted 12 lines

From: Manivannan Sadhasivam <[email protected]>

Hello,

This series adds support for MaxLinear/Exar USB to serial converters. This driver only supports XR21V141X series but it can easily be extended to other series in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

Quoted 9 lines
Quoted 5 lines

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

Hmm... I guess you also need the enclosed patch, to ensure that cdc_acm won't try to hijack it, when the Kernel is built with both drivers.

Ah right. I will include this patch in next iteration. Many thanks!

Regards,
Mani

Quoted 33 lines

Thanks,
Mauro

[PATCH] usb: cdc-acm: ignore Exar XR21V141X when serial driver is
built

The RTS/CTS line discipline for this device doesn't follow the standard. So, in order to properly support TX, a separate driver is needed.

Ensure that cdc_acm will ignore it during probe time, if the Kernel is built with support for it.

drivers/usb/class/cdc-acm.c +5 -1
index ded8d93834ca..f87288834ded 100644
@@ -1889,7 +1889,11 @@ static const struct usb_device_id acm_ids[] = {
 	.driver_info = IGNORE_DEVICE,
 	},
 #endif
-
+#if IS_ENABLED(CONFIG_USB_SERIAL_XR)
+	{ USB_DEVICE(0x04e2, 0x1410),   /* XR21V141X uses a different rts/cts discipline */
+	.driver_info = IGNORE_DEVICE,
+	},
+#endif
 	/*Samsung phone in firmware update mode */
 	{ USB_DEVICE(0x04e8, 0x685d),
 	.driver_info = IGNORE_DEVICE,
#4 lore raw

Re: [PATCH v3 1/2] usb: serial: Add MaxLinear/Exar USB to Serial driver

In reply to Johan Hovold

Hi Johan,

Thanks for the review. Please find the replies inline.

Quoted 125 lines · Johan Hovold
Quoted 124 lines · On Fri, May 01, 2020 at 12:19:23AM +0530, [email protected] wrote:

From: Manivannan Sadhasivam <[email protected]>

Add support for MaxLinear/Exar USB to Serial converters. This driver only supports XR21V141X series but it can be extended to other series from Exar as well in future.

This driver is inspired from the initial one submitted by Patong Yang:

https://patchwork.kernel.org/patch/10543261/

While the initial driver was a custom tty USB driver exposing whole new serial interface ttyXRUSBn, this version is completely based on USB serial core thus exposing the interfaces as ttyUSBn. This will avoid the overhead of exposing a new USB serial interface which the userspace tools are unaware of.

---
 drivers/usb/serial/Kconfig     |   9 +
 drivers/usb/serial/Makefile    |   1 +
 drivers/usb/serial/xr_serial.c | 624 +++++++++++++++++++++++++++++++++
 3 files changed, 634 insertions(+)
 create mode 100644 drivers/usb/serial/xr_serial.c
drivers/usb/serial/Kconfig +9 -0
index 25d7e0c36d38..8f6ad9f94735 100644
@@ -644,6 +644,15 @@ config USB_SERIAL_UPD78F0730
 	  To compile this driver as a module, choose M here: the
 	  module will be called upd78f0730.
 
+config USB_SERIAL_XR
+	tristate "USB MaxLinear/Exar USB to Serial driver"
+	help
+	  Say Y here if you want to use MaxLinear/Exar USB to Serial converter
+	  devices.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called xr_serial.
+
 config USB_SERIAL_DEBUG
 	tristate "USB Debugging Device"
 	help
drivers/usb/serial/Makefile +1 -0
index 2d491e434f11..4f69c2a3aff3 100644
@@ -62,4 +62,5 @@ obj-$(CONFIG_USB_SERIAL_VISOR)			+= visor.o
 obj-$(CONFIG_USB_SERIAL_WISHBONE)		+= wishbone-serial.o
 obj-$(CONFIG_USB_SERIAL_WHITEHEAT)		+= whiteheat.o
 obj-$(CONFIG_USB_SERIAL_XIRCOM)			+= keyspan_pda.o
+obj-$(CONFIG_USB_SERIAL_XR)			+= xr_serial.o
 obj-$(CONFIG_USB_SERIAL_XSENS_MT)		+= xsens_mt.o
drivers/usb/serial/xr_serial.c new file +64 -0
new file mode 100644
index 000000000000..fdb9ddf8bd95
@@ -0,0 +1,624 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * MaxLinear/Exar USB to Serial driver
+ *
+ * Based on initial driver written by Patong Yang <[email protected]>
+ *
+ * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/tty.h>
+#include <linux/usb.h>
+#include <linux/usb/serial.h>
+
+struct xr_uart_regs {
+	u8 enable;
+	u8 format;
+	u8 flow_ctrl;
+	u8 xon_char;
+	u8 xoff_char;
+	u8 loopback;
+	u8 tx_break;
+	u8 rs485_delay;
+	u8 gpio_mode;
+	u8 gpio_dir;
+	u8 gpio_int_mask;
+	u8 gpio_set;
+	u8 gpio_clr;
+	u8 gpio_status;
+};
+
+struct xr_port_private {
+	const struct xr_uart_regs *regs;
+};
+
+struct xr_txrx_clk_mask {
+	u16 tx;
+	u16 rx0;
+	u16 rx1;
+};
+
+#define XR21V141X_ID			0x1410
+#define XR_INT_OSC_HZ			48000000
+
+/* USB Requests */
+#define XR_SET_XR21V141X		0
+#define XR_GET_XR21V141X		1
+
+#define XR21V141X_CLOCK_DIVISOR_0	0x4
+#define XR21V141X_CLOCK_DIVISOR_1	0x5
+#define XR21V141X_CLOCK_DIVISOR_2	0x6
+#define XR21V141X_TX_CLOCK_MASK_0	0x7
+#define XR21V141X_TX_CLOCK_MASK_1	0x8
+#define XR21V141X_RX_CLOCK_MASK_0	0x9
+#define XR21V141X_RX_CLOCK_MASK_1	0xa
+
+/* XR21V141X register blocks */
+#define XR21V141X_UART_REG_BLOCK	0
+#define XR21V141X_URM_REG_BLOCK		4
+#define XR21V141X_UART_CUSTOM_BLOCK	0x66
+
+/* XR21V141X UART Manager Registers */
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 70

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+#define XR21V141X_URM_FIFO_ENABLE_REG	0x10
+#define XR21V141X_URM_ENABLE_TX_FIFO	0x1
+#define XR21V141X_URM_ENABLE_RX_FIFO	0x2
+
+#define XR21V141X_URM_RX_FIFO_RESET	0x18
+#define XR21V141X_URM_TX_FIFO_RESET	0x1c

Did you mean to use "UMR" above? What does URM stand for otherwise?

UART Manager. I'll just use 'UART_MANAGER' to make it more explicit.

Quoted 52 lines
Quoted 52 lines
drivers/usb/serial/xr_serial.c new file +52 -0
+
+#define UART_ENABLE_TX			0x1
+#define UART_ENABLE_RX			0x2
+
+#define UART_MODE_RI			BIT(0)
+#define UART_MODE_CD			BIT(1)
+#define UART_MODE_DSR			BIT(2)
+#define UART_MODE_DTR			BIT(3)
+#define UART_MODE_CTS			BIT(4)
+#define UART_MODE_RTS			BIT(5)
+
+#define UART_BREAK_ON			0xff
+#define UART_BREAK_OFF			0
+
+#define UART_DATA_MASK			GENMASK(3, 0)
+#define UART_DATA_7			0x7
+#define UART_DATA_8			0x8
+
+#define UART_PARITY_MASK		GENMASK(6, 4)
+#define UART_PARITY_SHIFT		0x4
+#define UART_PARITY_NONE		0x0
+#define UART_PARITY_ODD			0x1
+#define UART_PARITY_EVEN		0x2
+#define UART_PARITY_MARK		0x3
+#define UART_PARITY_SPACE		0x4
+
+#define UART_STOP_MASK			BIT(7)
+#define UART_STOP_SHIFT			0x7
+#define UART_STOP_1			0x0
+#define UART_STOP_2			0x1
+
+#define UART_FLOW_MODE_NONE		0x0
+#define UART_FLOW_MODE_HW		0x1
+#define UART_FLOW_MODE_SW		0x2
+
+#define UART_MODE_GPIO			0x0
+#define UART_MODE_RTS_CTS		0x1
+#define UART_MODE_DTR_DSR		0x2
+#define UART_MODE_RS485			0x3
+#define UART_MODE_RS485_ADDR		0x4
+
+static const struct xr_uart_regs xr21v141x_regs = {
+	.enable = 0x03,
+	.format = 0x0b,
+	.flow_ctrl = 0x0c,
+	.xon_char = 0x10,
+	.xoff_char = 0x11,
+	.loopback = 0x12,
+	.tx_break = 0x14,
+	.rs485_delay = 0x15,
+	.gpio_mode = 0x1a,
+	.gpio_dir = 0x1b,
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 127

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+	.gpio_int_mask = 0x1c,
+	.gpio_set = 0x1d,
+	.gpio_clr = 0x1e,
+	.gpio_status = 0x1f,
+};

Do you expect there to be more models supported by this driver? Perhaps you shouldn't add this abstraction until then.

Yes, I do expect more revisions to get added in future.

Quoted 125 lines

drivers/usb/serial/xr_serial.c line 133

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+static int xr_set_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 val)
+{
+	struct usb_serial *serial = port->serial;
+	int ret = -EINVAL;

Pointless init.

drivers/usb/serial/xr_serial.c line 134

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+
+	/* XR21V141X uses custom command for writing UART registers */

I'd drop this comment. These control messages are also used to access the EEPROM etc.

drivers/usb/serial/xr_serial.c line 142

Quoted 7 lines
drivers/usb/serial/xr_serial.c new file +7 -0
+	ret = usb_control_msg(serial->dev,
+			      usb_sndctrlpipe(serial->dev, 0),
+			      XR_SET_XR21V141X,
+			      USB_DIR_OUT | USB_TYPE_VENDOR, val,
+			      reg | (block << 8), NULL, 0,
+			      USB_CTRL_SET_TIMEOUT);
+

Remove this newline.

drivers/usb/serial/xr_serial.c line 144

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+	if (ret < 0)
+		dev_err(&port->dev, "Failed to set reg 0x%x status: %d\n",

%02x; and skip "status" like:

	dev_err(&port->dev, "failed to set reg 0x%02x: %d\n",

drivers/usb/serial/xr_serial.c line 147

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+			reg, ret);
+
+	return ret;

As Greg suggested, please return 0 explicitly here on success.

drivers/usb/serial/xr_serial.c line 155

Quoted 8 lines
drivers/usb/serial/xr_serial.c new file +8 -0
+}
+
+static int xr_get_reg(struct usb_serial_port *port, u8 block, u8 reg,
+		      u8 *val)
+{
+	struct usb_serial *serial = port->serial;
+	void *dmabuf;
+	int ret = -EINVAL;

Unnecessary, again.

drivers/usb/serial/xr_serial.c line 161

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+
+	dmabuf = kmalloc(1, GFP_KERNEL);
+	if (!dmabuf)
+		return -ENOMEM;
+
+	/* XR21V141X uses custom command for reading UART registers */

Drop this.

drivers/usb/serial/xr_serial.c line 167

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	ret = usb_control_msg(serial->dev,
+			      usb_rcvctrlpipe(serial->dev, 0),
+			      XR_GET_XR21V141X,
+			      USB_DIR_IN | USB_TYPE_VENDOR, 0,
+			      reg | (block << 8), dmabuf, 1,
+			      USB_CTRL_SET_TIMEOUT);

s/SET/GET/

drivers/usb/serial/xr_serial.c line 167

Quoted 1 line
drivers/usb/serial/xr_serial.c new file +1 -0
+

No newline.

drivers/usb/serial/xr_serial.c line 170

Quoted 2 lines
drivers/usb/serial/xr_serial.c new file +2 -0
+	if (ret == 1) {
+		memcpy(val, dmabuf, 1);

Use u8 and assignment here as Greg suggested.

drivers/usb/serial/xr_serial.c line 173

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+		ret = 0;
+	} else {
+		dev_err(&port->dev, "Failed to get reg 0x%x status: %d\n",

As above.

Quoted 44 lines
drivers/usb/serial/xr_serial.c new file +44 -0
+			reg, ret);
+		if (ret >= 0)
+			ret = -EIO;
+	}
+
+	kfree(dmabuf);
+
+	return ret;
+}
+
+/* Tx and Rx clock mask values obtained from section 3.3.4 of datasheet */
+static const struct xr_txrx_clk_mask xr21v141x_txrx_clk_masks[] = {
+	{ 0x000, 0x000, 0x000 },
+	{ 0x000, 0x000, 0x000 },
+	{ 0x100, 0x000, 0x100 },
+	{ 0x020, 0x400, 0x020 },
+	{ 0x010, 0x100, 0x010 },
+	{ 0x208, 0x040, 0x208 },
+	{ 0x104, 0x820, 0x108 },
+	{ 0x844, 0x210, 0x884 },
+	{ 0x444, 0x110, 0x444 },
+	{ 0x122, 0x888, 0x224 },
+	{ 0x912, 0x448, 0x924 },
+	{ 0x492, 0x248, 0x492 },
+	{ 0x252, 0x928, 0x292 },
+	{ 0x94a, 0x4a4, 0xa52 },
+	{ 0x52a, 0xaa4, 0x54a },
+	{ 0xaaa, 0x954, 0x4aa },
+	{ 0xaaa, 0x554, 0xaaa },
+	{ 0x555, 0xad4, 0x5aa },
+	{ 0xb55, 0xab4, 0x55a },
+	{ 0x6b5, 0x5ac, 0xb56 },
+	{ 0x5b5, 0xd6c, 0x6d6 },
+	{ 0xb6d, 0xb6a, 0xdb6 },
+	{ 0x76d, 0x6da, 0xbb6 },
+	{ 0xedd, 0xdda, 0x76e },
+	{ 0xddd, 0xbba, 0xeee },
+	{ 0x7bb, 0xf7a, 0xdde },
+	{ 0xf7b, 0xef6, 0x7de },
+	{ 0xdf7, 0xbf6, 0xf7e },
+	{ 0x7f7, 0xfee, 0xefe },
+	{ 0xfdf, 0xfbe, 0x7fe },
+	{ 0xf7f, 0xefe, 0xffe },
+	{ 0xfff, 0xffe, 0xffd },
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 223

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+};
+
+static int xr_set_baudrate(struct tty_struct *tty,
+			   struct usb_serial_port *port)
+{
+	u32 divisor = XR_INT_OSC_HZ / tty->termios.c_ospeed;

Boom -- division by zero. B0 should drop DTR/RTS.

Ah right. Will clamp the baud rate based on min and max values.

Quoted 8 lines

drivers/usb/serial/xr_serial.c line 227

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+	u32 idx = (32 * divisor) & 0x1f;
+	u16 tx_mask = xr21v141x_txrx_clk_masks[idx].tx;
+	u16 rx_mask = (divisor & 1) ? xr21v141x_txrx_clk_masks[idx].rx1 :
+				      xr21v141x_txrx_clk_masks[idx].rx0;

Don't do non-trivial initialisations like this as part of declaration. Avoid the ternary operator.

Okay.

Quoted 71 lines

drivers/usb/serial/xr_serial.c line 230

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+	int ret;
+
+	dev_dbg(&port->dev, "Setting baud rate :%u\n", tty->termios.c_ospeed);

Space after ':', not before.

Quoted 65 lines
drivers/usb/serial/xr_serial.c new file +65 -0
+
+	/*
+	 * XR21V141X uses fractional baud rate generator with 48MHz internal
+	 * oscillator and 19-bit programmable divisor. So theoretically it can
+	 * generate most commonly used baud rates with high accuracy.
+	 */
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_0, (divisor & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_1, ((divisor >>  8) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_CLOCK_DIVISOR_2, ((divisor >> 16) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_TX_CLOCK_MASK_0, (tx_mask & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_TX_CLOCK_MASK_1, ((tx_mask >>  8) & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_RX_CLOCK_MASK_0, (rx_mask & 0xff));
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 XR21V141X_RX_CLOCK_MASK_1, ((rx_mask >>  8) & 0xff));
+
+	return ret;
+}
+
+/*
+ * According to datasheet, below is the recommended sequence for enabling UART
+ * module in XR21V141X:
+ *
+ * Enable Tx FIFO
+ * Enable Tx and Rx
+ * Enable Rx FIFO
+ */
+static int xr_uart_enable(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG,
+			 XR21V141X_URM_ENABLE_TX_FIFO);
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->enable,
+			 UART_ENABLE_TX | UART_ENABLE_RX);
+	if (ret)
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 301

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG,
+			 XR21V141X_URM_ENABLE_TX_FIFO |
+			 XR21V141X_URM_ENABLE_RX_FIFO);

Should you be undoing these on errors?

If it happens then most probably the connection got lost. Should we still try to set registers?

Quoted 34 lines
Quoted 21 lines
drivers/usb/serial/xr_serial.c new file +21 -0
+
+	return ret;
+}
+
+static int xr_uart_disable(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->enable, 0);
+	if (ret)
+		return ret;
+
+	ret = xr_set_reg(port, XR21V141X_URM_REG_BLOCK,
+			 XR21V141X_URM_FIFO_ENABLE_REG, 0);
+
+	return ret;
+}
+
+static int xr_open(struct tty_struct *tty, struct usb_serial_port *port)

drivers/usb/serial/xr_serial.c line 332

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+{
+	int ret;
+
+	ret = xr_uart_enable(port);
+	if (ret) {
+		dev_err(&port->dev, "Failed to enable UART\n");
+		return ret;
+	}
+
+	ret = xr_set_baudrate(tty, port);

tty will be NULL when called by the console driver.

Quoted 3 lines

Why only init the line speed? Driver typically call set_termios() here when not used as a console.

Will fix this.

Quoted 9 lines

drivers/usb/serial/xr_serial.c line 338

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	if (ret) {
+		dev_err(&port->dev, "Failed to set baudrate\n");
+		return ret;
+	}
+
+	return usb_serial_generic_open(tty, port);

Disable on errors?

Ack.

Quoted 64 lines
Quoted 16 lines
drivers/usb/serial/xr_serial.c new file +16 -0
+}
+
+static void xr_close(struct usb_serial_port *port)
+{
+	usb_serial_generic_close(port);
+
+	xr_uart_disable(port);
+}
+
+static void xr_set_flow_mode(struct tty_struct *tty,
+			     struct usb_serial_port *port,
+			     unsigned int cflag)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	u8 flow, gpio_mode;
+	int ret;

drivers/usb/serial/xr_serial.c line 364

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_mode, &gpio_mode);
+	if (ret)
+		return;
+
+	if (cflag & CRTSCTS) {
+		dev_dbg(&port->dev, "Enabling hardware flow ctrl\n");
+		flow = UART_FLOW_MODE_HW;
+		gpio_mode |= UART_MODE_RTS_CTS;

These modes are exclusive, you cannot use |= here.

drivers/usb/serial/xr_serial.c line 365

Quoted 1 line
drivers/usb/serial/xr_serial.c new file +1 -0
+	} else if (I_IXOFF(tty) || I_IXON(tty)) {

This should just be IXOFF(tty) (flow control on input).

drivers/usb/serial/xr_serial.c line 371

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+		u8 start_char = START_CHAR(tty);
+		u8 stop_char = STOP_CHAR(tty);
+
+		dev_dbg(&port->dev, "Enabling sw flow ctrl\n");
+		flow = UART_FLOW_MODE_SW;
+		gpio_mode |= UART_MODE_GPIO;

Same here, this is broken; ORing with 0 doesn't set mode 0.

drivers/usb/serial/xr_serial.c line 379

Quoted 8 lines
drivers/usb/serial/xr_serial.c new file +8 -0
+
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->xon_char, start_char);
+		xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			   port_priv->regs->xoff_char, stop_char);
+	} else {
+		dev_dbg(&port->dev, "No flow ctrl\n");
+		flow = UART_FLOW_MODE_NONE;

I assume you need to set UART_MODE_GPIO here too to be able to control RTS manually (default mode is RTS/CTS flow control).

drivers/usb/serial/xr_serial.c line 385

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	}
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->flow_ctrl, flow);
+	if (ret)
+		return;

The datasheet says that the flow control register can only be updated when the uart is disabled.

Quoted 4 lines

"These registers should only be written to when the UART is
disabled. Writing to the FLOW_CONTROL register when the UART is enabled will result in undefined behavior."

Ack.

Quoted 34 lines
Quoted 15 lines
drivers/usb/serial/xr_serial.c new file +15 -0
+
+	xr_set_reg(port, XR21V141X_UART_REG_BLOCK, port_priv->regs->gpio_mode,
+		   gpio_mode);
+}
+
+static void xr_set_termios(struct tty_struct *tty,
+			   struct usb_serial_port *port,
+			   struct ktermios *old_termios)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	struct device *dev = &port->dev;
+	unsigned int cflag, old_cflag;
+	int ret;
+	u8 bits;
+

drivers/usb/serial/xr_serial.c line 410

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	cflag = tty->termios.c_cflag;
+	old_cflag = old_termios->c_cflag;
+
+	if (tty->termios.c_ospeed != old_termios->c_ospeed)
+		xr_set_baudrate(tty, port);
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->format, &bits);
+	if (ret)
+		return;

No need to retrieve the current settings.

drivers/usb/serial/xr_serial.c line 413

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+
+	/* If the number of data bits is to be updated */
+	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {

Use C_CSIZE(tty) and friends and set these unconditionally.

Quoted 15 lines

drivers/usb/serial/xr_serial.c line 424

Quoted 11 lines
drivers/usb/serial/xr_serial.c new file +11 -0
+		bits &= ~UART_DATA_MASK;
+		switch (cflag & CSIZE) {
+		case CS7:
+			bits |= UART_DATA_7;
+			dev_dbg(dev, "Setting data bits: 7\n");
+			break;
+		case CS8:
+		/* CS9 not supported */
+		default:
+			bits |= UART_DATA_8;
+			dev_dbg(dev, "Setting data bits: 8\n");

You should report back that you cannot set CS5 and CS6 by restoring the old setting in tty->termios.

Okay.

Quoted 61 lines

drivers/usb/serial/xr_serial.c line 430

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+			break;
+		}
+	}
+
+	if ((cflag & (PARENB | PARODD | CMSPAR)) !=
+	    (old_cflag & (PARENB | PARODD | CMSPAR))) {

As above, determine these bits unconditionally.

drivers/usb/serial/xr_serial.c line 436

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+		bits &= ~UART_PARITY_MASK;
+		if (cflag & PARENB) {
+			if (cflag & CMSPAR) {
+				if (cflag & PARODD) {
+					bits |= (UART_PARITY_MARK <<
+						 UART_PARITY_SHIFT);

Parenthesis not need. Hopefully cleaner when you have reduced indentation.

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+					dev_dbg(dev, "Setting parity: MARK\n");
+				} else {
+					bits |= (UART_PARITY_SPACE <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: SPACE\n");

drivers/usb/serial/xr_serial.c line 451

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+				}
+			} else {
+				if (cflag & PARODD) {
+					bits |= (UART_PARITY_ODD <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: ODD\n");
+				} else {
+					bits |= (UART_PARITY_EVEN <<
+						 UART_PARITY_SHIFT);
+					dev_dbg(dev, "Setting parity: EVEN\n");

And please drop all these dev_dbg (also for data bits).

Quoted 5 lines
drivers/usb/serial/xr_serial.c new file +5 -0
+				}
+			}
+		}
+	}
+

drivers/usb/serial/xr_serial.c line 466

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
+		bits &= ~UART_STOP_MASK;
+		if (cflag & CSTOPB) {
+			bits |= (UART_STOP_2 << UART_STOP_SHIFT);
+			dev_dbg(dev, "Setting stop bits: 2\n");
+		} else {
+			bits |= (UART_STOP_1 << UART_STOP_SHIFT);
+			dev_dbg(dev, "Setting stop bits: 1\n");
+		}
+	}

As above.

drivers/usb/serial/xr_serial.c line 469

Quoted 3 lines
drivers/usb/serial/xr_serial.c new file +3 -0
+
+	ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->format, (bits & 0xff));

bits is u8, no need to mask

Quoted 7 lines

drivers/usb/serial/xr_serial.c line 473

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+	if (ret)
+		return;
+
+	xr_set_flow_mode(tty, port, cflag);

cflag can be retreived from tty.

Ack.

Quoted 70 lines
Quoted 14 lines
drivers/usb/serial/xr_serial.c new file +14 -0
+}
+
+static int xr_tiocmset_port(struct usb_serial_port *port,
+			    unsigned int set, unsigned int clear)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret = 0;
+	u8 gpio_set = 0;
+	u8 gpio_clr = 0;
+
+	/* Modem control pins are active low, so set & clr are swapped */
+	if (set & TIOCM_RTS)
+		gpio_clr |= UART_MODE_RTS;
+	if (set & TIOCM_DTR)

drivers/usb/serial/xr_serial.c line 497

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+		gpio_clr |= UART_MODE_DTR;
+	if (clear & TIOCM_RTS)
+		gpio_set |= UART_MODE_RTS;
+	if (clear & TIOCM_DTR)
+		gpio_set |= UART_MODE_DTR;
+
+	/* Writing '0' to gpio_{set/clr} bits has no effect, so no need to do */
+	if (gpio_clr)
+		ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+				 port_priv->regs->gpio_clr, gpio_clr);

Please add brackets since you have a multiline statement here.

drivers/usb/serial/xr_serial.c line 501

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+
+	if (gpio_set)
+		ret = xr_set_reg(port, XR21V141X_UART_REG_BLOCK,
+				 port_priv->regs->gpio_set, gpio_set);

Same here.

Quoted 36 lines
drivers/usb/serial/xr_serial.c new file +36 -0
+
+	return ret;
+}
+
+static int xr_tiocmset(struct tty_struct *tty,
+		       unsigned int set, unsigned int clear)
+{
+	struct usb_serial_port *port = tty->driver_data;
+
+	return xr_tiocmset_port(port, set, clear);
+}
+
+static void xr_dtr_rts(struct usb_serial_port *port, int on)
+{
+	if (on)
+		xr_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
+	else
+		xr_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
+}
+
+static int xr_tiocmget(struct tty_struct *tty)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	int ret;
+	u8 status;
+
+	ret = xr_get_reg(port, XR21V141X_UART_REG_BLOCK,
+			 port_priv->regs->gpio_status, &status);
+	if (ret)
+		return ret;
+
+	/*
+	 * Modem control pins are active low, so reading '0' means it is active
+	 * and '1' means not active.
+	 */
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 543

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	ret = ((status & UART_MODE_DTR) ? 0 : TIOCM_DTR) |
+	      ((status & UART_MODE_RTS) ? 0 : TIOCM_RTS) |
+	      ((status & UART_MODE_CTS) ? 0 : TIOCM_CTS) |
+	      ((status & UART_MODE_DSR) ? 0 : TIOCM_DSR) |
+	      ((status & UART_MODE_RI) ? 0 : TIOCM_RI) |
+	      ((status & UART_MODE_CD) ? 0 : TIOCM_CD);

Can you read back also the outputs? Also in automatic mode?

Yes I guess. The datasheet doesn't specify any limitation here afaik.

Quoted 25 lines
Quoted 25 lines
drivers/usb/serial/xr_serial.c new file +25 -0
+
+	return ret;
+}
+
+static void xr_break_ctl(struct tty_struct *tty, int break_state)
+{
+	struct usb_serial_port *port = tty->driver_data;
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+	u8 state;
+
+	if (break_state == 0)
+		state = UART_BREAK_OFF;
+	else
+		state = UART_BREAK_ON;
+
+	dev_dbg(&port->dev, "Turning break %s\n",
+		state == UART_BREAK_OFF ? "off" : "on");
+	xr_set_reg(port, XR21V141X_UART_REG_BLOCK, port_priv->regs->tx_break,
+		   state);
+}
+
+static int xr_port_probe(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv;
+
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 574

Quoted 6 lines
drivers/usb/serial/xr_serial.c new file +6 -0
+	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
+	if (!port_priv)
+		return -ENOMEM;
+
+	/* XR21V141X specific settings */
+	port_priv->regs = &xr21v141x_regs;

May not be needed.

I'd like to keep some sort of generalism to ease adding more revisions in future.

Quoted 26 lines
Quoted 26 lines
drivers/usb/serial/xr_serial.c new file +26 -0
+
+	usb_set_serial_port_data(port, port_priv);
+
+	return 0;
+}
+
+static int xr_port_remove(struct usb_serial_port *port)
+{
+	struct xr_port_private *port_priv = usb_get_serial_port_data(port);
+
+	kfree(port_priv);
+
+	return 0;
+}
+
+static const struct usb_device_id id_table[] = {
+	{ USB_DEVICE(0x04e2, 0x1410) }, /* XR21V141X */
+	{ }
+};
+MODULE_DEVICE_TABLE(usb, id_table);
+
+static struct usb_serial_driver xr_device = {
+	.driver = {
+		.owner = THIS_MODULE,
+		.name =	"xr_serial",
+	},
Quoted 9 lines

drivers/usb/serial/xr_serial.c line 604

Quoted 4 lines
drivers/usb/serial/xr_serial.c new file +4 -0
+	.id_table		= id_table,
+	.num_ports		= 1,
+	.bulk_in_size		= 384,
+	.bulk_out_size		= 128,

You should not necessarily set these to match the hardware fifo sizes. They default to the respective endpoint size, but may be increased for improved throughput.

Okay.

Quoted 14 lines

drivers/usb/serial/xr_serial.c line 614

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+	.open			= xr_open,
+	.close			= xr_close,
+	.break_ctl		= xr_break_ctl,
+	.set_termios		= xr_set_termios,
+	.tiocmget		= xr_tiocmget,
+	.tiocmset		= xr_tiocmset,
+	.port_probe		= xr_port_probe,
+	.port_remove		= xr_port_remove,
+	.dtr_rts		= xr_dtr_rts
+};

As I mentioned elsewhere, you should only register a tty device for the data interface, but still claim the control interface.

Quoted 4 lines

You probably should reject the control interface and claim it when probing the data interface (rather than return 1 from attach as I mentioned earlier).

This seems to be a much more cleaner solution. Will stick to it.

Thanks,
Mani

Quoted 14 lines

drivers/usb/serial/xr_serial.c line 624

Quoted 10 lines
drivers/usb/serial/xr_serial.c new file +10 -0
+
+static struct usb_serial_driver * const serial_drivers[] = {
+	&xr_device, NULL
+};
+
+module_usb_serial_driver(serial_drivers, id_table);
+
+MODULE_AUTHOR("Manivannan Sadhasivam <[email protected]>");
+MODULE_DESCRIPTION("MaxLinear/Exar USB to Serial driver");
+MODULE_LICENSE("GPL");

Generally nice and clean overall.

Johan