[PATCH] USB: Add uPD78F0730 USB to Serial Adaptor Driver

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The adaptor can be found on development boards for 78k, RL78 and V850
microcontrollers produced by Renesas Electronics Corporation.

This is not a full-featured USB to serial converter, however it allows
basic communication and simple control which is enough for programming of
on-board flash and debugging through a debug monitor.

uPD78F0730 is a USB-enabled microcontroller with USB-to-UART conversion
implemented in firmware.

This chip is also present in some debugging adaptors which use it for
USB-to-SPI conversion as well. The present driver doesn't cover SPI,
only USB-to-UART conversion is supported.

Signed-off-by: Maksim Salau <maksim.salau@xxxxxxxxx>
---
 drivers/usb/serial/Kconfig      |   9 +
 drivers/usb/serial/Makefile     |   1 +
 drivers/usb/serial/upd78f0730.c | 537 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 547 insertions(+)
 create mode 100644 drivers/usb/serial/upd78f0730.c

diff --git a/drivers/usb/serial/Kconfig b/drivers/usb/serial/Kconfig
index f612dda..f9c0950 100644
--- a/drivers/usb/serial/Kconfig
+++ b/drivers/usb/serial/Kconfig
@@ -719,6 +719,15 @@ config USB_SERIAL_QT2
 	  To compile this driver as a module, choose M here: the
 	  module will be called quatech-serial.
 
+config USB_SERIAL_UPD78F0730
+	tristate "USB Renesas uPD78F0730 Single Port Serial Driver"
+	help
+	  Say Y here if you want to use the Renesas uPD78F0730
+	  serial driver.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called upd78f0730.
+
 config USB_SERIAL_DEBUG
 	tristate "USB Debugging Device"
 	help
diff --git a/drivers/usb/serial/Makefile b/drivers/usb/serial/Makefile
index f3fa5e5..7fcb758 100644
--- a/drivers/usb/serial/Makefile
+++ b/drivers/usb/serial/Makefile
@@ -61,3 +61,4 @@ 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_XSENS_MT)		+= xsens_mt.o
+obj-$(CONFIG_USB_SERIAL_UPD78F0730)		+= upd78f0730.o
diff --git a/drivers/usb/serial/upd78f0730.c b/drivers/usb/serial/upd78f0730.c
new file mode 100644
index 0000000..6d90199
--- /dev/null
+++ b/drivers/usb/serial/upd78f0730.c
@@ -0,0 +1,537 @@
+/*
+ * Renesas Electronics uPD78F0730 USB to serial converter driver
+ *
+ * Copyright (C) 2014,2016 Maksim Salau <maksim.salau@xxxxxxxxx>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation.
+ *
+ * Protocol of the adaptor is described in the application note U19660EJ1V0AN00
+ * μPD78F0730 8-bit Single-Chip Microcontroller
+ * USB-to-Serial Conversion Software
+ * <http://documentation.renesas.com/doc/DocumentServer/U19660EJ1V0AN00.pdf>
+ *
+ * The adaptor functionality is limited to the following:
+ * - data bits: 7 or 8
+ * - stop bits: 1 or 2
+ * - parity: even, odd or none
+ * - flow control: XON/XOFF or none
+ * - baudrates: 2400, 4800, 9600, 19200, 38400, 57600, 115200
+ * - signals: DTS, RTS and BREAK
+ * - there is an option to enable parity error character substitution,
+ *   but it is not supported by this driver
+ */
+
+#include <linux/kernel.h>
+#include <linux/string.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/spinlock.h>
+#include <linux/tty.h>
+#include <linux/usb.h>
+#include <linux/usb/serial.h>
+
+#define DRIVER_DESC "Renesas uPD78F0730 USB to serial converter driver"
+
+#define DRIVER_AUTHOR "Maksim Salau <maksim.salau@xxxxxxxxx>"
+
+static const struct usb_device_id id_table[] = {
+	{ USB_DEVICE(0x045B, 0x0212) }, /* YRPBRL78G13, YRPBRL78G14 */
+	{ USB_DEVICE(0x0409, 0x0063) }, /* V850ESJX3-STICK */
+	{}
+};
+
+MODULE_DEVICE_TABLE(usb, id_table);
+
+/*
+ * Private data structure type declaration.
+ * Each adaptor is associated with a private structure, that holds the current
+ * state of control signals (DTR, RTS and BREAK).
+ */
+struct upd78f0730_serial_private {
+	spinlock_t	lock;
+	__u8		line_signals;
+};
+
+/* Function prototypes */
+static int upd78f0730_send_ctl(struct usb_serial_port *port,
+			void *data, int size);
+static int upd78f0730_attach(struct usb_serial *serial);
+static void upd78f0730_release(struct usb_serial *serial);
+static int upd78f0730_open(struct tty_struct *tty,
+			struct usb_serial_port *port);
+static void upd78f0730_close(struct usb_serial_port *port);
+static void upd78f0730_set_termios(struct tty_struct *tty,
+				struct usb_serial_port *port,
+				struct ktermios *old_termios);
+static int upd78f0730_tiocmget(struct tty_struct *tty);
+static int upd78f0730_tiocmset(struct tty_struct *tty,
+			unsigned int set, unsigned int clear);
+static void upd78f0730_dtr_rts(struct usb_serial_port *port, int on);
+static void upd78f0730_break_ctl(struct tty_struct *tty, int break_state);
+
+static struct usb_serial_driver upd78f0730_device = {
+	.driver	 = {
+		.owner	= THIS_MODULE,
+		.name	= "upd78f0730",
+	},
+	.id_table	= id_table,
+	.num_ports	= 1,
+	.bulk_in_size	= 64,
+	.bulk_out_size	= 64,
+	.attach		= upd78f0730_attach,
+	.release	= upd78f0730_release,
+	.open		= upd78f0730_open,
+	.close		= upd78f0730_close,
+	.set_termios	= upd78f0730_set_termios,
+	.tiocmget	= upd78f0730_tiocmget,
+	.tiocmset	= upd78f0730_tiocmset,
+	.dtr_rts	= upd78f0730_dtr_rts,
+	.break_ctl	= upd78f0730_break_ctl,
+};
+
+static struct usb_serial_driver * const serial_drivers[] = {
+	&upd78f0730_device,
+	NULL
+};
+
+/* Opcodes of control commands */
+#define LINE_CONTROL		0x00
+#define SET_DTR_RTS		0x01
+#define SET_XON_XOFF_CHR	0x02
+#define OPEN_CLOSE		0x03
+#define SET_ERR_CHR		0x04
+
+/* Data sizes in LINE_CONTROL command */
+#define DATA_SIZE_7_BITS	0x00
+#define DATA_SIZE_8_BITS	0x01
+#define DATA_SIZE_MASK		0x01
+
+/* Stop-bit modes in LINE_CONTROL command */
+#define STOP_BIT_1_BIT	0x00
+#define STOP_BIT_2_BIT	0x02
+#define STOP_BIT_MASK	0x02
+
+/* Parity modes in LINE_CONTROL command */
+#define PARITY_NONE	0x00
+#define PARITY_EVEN	0x04
+#define PARITY_ODD	0x08
+#define PARITY_MASK	0x0C
+
+/* Flow control modes in LINE_CONTROL command */
+#define FLOW_CONTROL_NONE	0x00
+#define FLOW_CONTROL_HW		0x10
+#define FLOW_CONTROL_SW		0x20
+#define FLOW_CONTROL_MASK	0x30
+
+/* Control signal bits in SET_DTR_RTS command */
+#define RESET_RTS	0x01
+#define RESET_DTR	0x02
+#define SET_BREAK	0x04
+
+/* Port modes in OPEN_CLOSE command */
+#define PORT_CLOSE	0x00
+#define PORT_OPEN	0x01
+
+/* Error character substitution modes in SET_ERR_CHR command */
+#define ERR_CHR_DISABLED	0x00
+#define ERR_CHR_ENABLED		0x01
+
+/*
+ * Declaration of command structures
+ */
+
+/* LINE_CONTROL command */
+struct line_control {
+	__u8	opcode;
+	__le32	baud_rate;
+	__u8	params;
+} __packed;
+
+/* SET_DTR_RTS command */
+struct set_dtr_rts {
+	__u8 opcode;
+	__u8 params;
+};
+
+/* SET_XON_OFF_CHR command */
+struct set_xon_xoff_chr {
+	__u8 opcode;
+	__u8 xon;
+	__u8 xoff;
+};
+
+/* OPEN_CLOSE command */
+struct open_close {
+	__u8 opcode;
+	__u8 state;
+};
+
+/* SET_ERR_CHR command */
+struct set_err_chr {
+	__u8 opcode;
+	__u8 state;
+	__u8 err_char;
+};
+
+/*
+ * upd78f0730_send_ctl
+ * Send a control command to the adaptor.
+ * The data argument points to a command structure in memory,
+ * which is 'size' bytes long.
+ * On success 0 is returned, or negative value otherwise.
+ */
+static int upd78f0730_send_ctl(struct usb_serial_port *port,
+			void *data, int size)
+{
+	int res;
+	struct device *dev = &port->dev;
+	struct usb_device *usbdev = port->serial->dev;
+
+	if (port == NULL || data == NULL || size == 0) {
+		dev_err(dev, "%s - invalid arguments\n", __func__);
+		return -EINVAL;
+	}
+
+	res = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x00,
+			USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
+			0x0000, 0x0000, data, size, USB_CTRL_SET_TIMEOUT);
+
+	if (res < 0 || res != size) {
+		dev_err(dev, "%s - failed to send request opcode=%02x, size=%d res=%d\n",
+			__func__, *(__u8 *)data, size, res);
+		return -EIO;
+	}
+
+	return 0;
+}
+
+/*
+ * upd78f0730_attach
+ * The function is called when a new adaptor is connected to the host.
+ * The function allocates the private structure for the adaptor.
+ */
+static int upd78f0730_attach(struct usb_serial *serial)
+{
+	struct upd78f0730_serial_private *private;
+	struct device *dev = &serial->dev->dev;
+
+	dev_dbg(dev, "%s\n", __func__);
+	private = kzalloc(sizeof(*private), GFP_KERNEL);
+	if (private == NULL) {
+		dev_err(dev, "%s - unable to allocate memory for private data\n",
+			__func__);
+		return -ENOMEM;
+	}
+	spin_lock_init(&private->lock);
+	private->line_signals = RESET_DTR | RESET_RTS;
+	usb_set_serial_data(serial, private);
+	return 0;
+}
+
+/*
+ * upd78f0730_release
+ * The function is called when the adaptor is detached from the host.
+ * The function de-allocates memory occupied by the private structure
+ * associated with the adaptor.
+ */
+static void upd78f0730_release(struct usb_serial *serial)
+{
+	struct upd78f0730_serial_private *private;
+
+	dev_dbg(&serial->dev->dev, "%s\n", __func__);
+	private = usb_get_serial_data(serial);
+	kfree(private);
+}
+
+/*
+ * upd78f0730_open
+ * The function is called when software opens the port
+ * that is associated with the adaptor.
+ * The function performs basic initialization of the adaptor:
+ *  1. opens port;
+ *  2. sets initial state for DTR and RTS;
+ *  3. disables error character substitution.
+ * The driver can control the state of the adaptor only if the port is opened.
+ */
+static int upd78f0730_open(struct tty_struct *tty, struct usb_serial_port *port)
+{
+	int res;
+	unsigned long flags;
+	struct upd78f0730_serial_private *private;
+	struct open_close request_open = {
+		.opcode = OPEN_CLOSE,
+		.state = PORT_OPEN
+	};
+	struct set_dtr_rts request_set_dtr_rts = {
+		.opcode = SET_DTR_RTS,
+		.params = RESET_DTR | RESET_RTS
+	};
+	struct set_err_chr request_set_err_chr = {
+		.opcode = SET_ERR_CHR,
+		.state = ERR_CHR_DISABLED,
+		.err_char = 0
+	};
+
+	struct {
+		void	*data;
+		int	size;
+	} *request, requests[] = {
+		{ &request_open, sizeof(request_open) },
+		{ &request_set_dtr_rts, sizeof(request_set_dtr_rts) },
+		{ &request_set_err_chr, sizeof(request_set_err_chr) },
+		{ }
+	};
+
+	dev_dbg(&port->dev, "%s\n", __func__);
+	private = usb_get_serial_data(port->serial);
+	spin_lock_irqsave(&private->lock, flags);
+	request_set_dtr_rts.params = private->line_signals;
+	spin_unlock_irqrestore(&private->lock, flags);
+
+	request = requests;
+	do {
+		res = upd78f0730_send_ctl(port, request->data, request->size);
+		if (res)
+			return res;
+		++request;
+	} while (request->data != NULL);
+
+	upd78f0730_set_termios(tty, port, NULL);
+
+	return usb_serial_generic_open(tty, port);
+}
+
+/*
+ * upd78f0730_close
+ * The function is called when the port associated with the adaptor is closed
+ * by the host software.
+ * The function sends close command to the adaptor. From that moment,
+ * driver can't control state of the adaptor
+ * (e.g. state of the control signals).
+ */
+static void upd78f0730_close(struct usb_serial_port *port)
+{
+	struct open_close request_close = {
+		.opcode = OPEN_CLOSE,
+		.state = PORT_CLOSE
+	};
+
+	dev_dbg(&port->dev, "%s\n", __func__);
+	usb_serial_generic_close(port);
+	upd78f0730_send_ctl(port, &request_close, sizeof(request_close));
+}
+
+/*
+ * upd78f0730_set_termios
+ * Configure the adaptor according to software needs.
+ * The driver is not aware of the current configuration of the adaptor,
+ * and performs full reconfiguration every time.
+ * Note: Original devices support baudrates from 2400 up to 115200,
+ * but the driver doesn't limit the user in his desires.
+ */
+static void upd78f0730_set_termios(struct tty_struct *tty,
+				struct usb_serial_port *port,
+				struct ktermios *old_termios)
+{
+	struct device *dev = &port->dev;
+	struct line_control request = { .opcode = LINE_CONTROL };
+	struct set_xon_xoff_chr request_xchr = { .opcode = SET_XON_XOFF_CHR };
+	tcflag_t cflag = tty->termios.c_cflag;
+	speed_t baud_rate = tty_get_baud_rate(tty);
+
+	request.baud_rate = cpu_to_le32(baud_rate);
+	dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud_rate);
+
+	request_xchr.xon = START_CHAR(tty);
+	request_xchr.xoff = STOP_CHAR(tty);
+	dev_dbg(dev, "%s - XON = %02X, XOFF = %02X\n", __func__,
+		request_xchr.xon, request_xchr.xoff);
+
+	request.params = 0;
+	switch (cflag & CSIZE) {
+	case CS7:
+		request.params |= DATA_SIZE_7_BITS;
+		dev_dbg(dev, "%s - 7 data bits\n", __func__);
+		break;
+	case CS8:
+		request.params |= DATA_SIZE_8_BITS;
+		dev_dbg(dev, "%s - 8 data bits\n", __func__);
+		break;
+	default:
+		request.params |= DATA_SIZE_8_BITS;
+		dev_err(dev, "%s - data size is not supported, falling back to 8 bits\n",
+			__func__);
+		break;
+	}
+	if (cflag & PARENB) {
+		if (cflag & PARODD) {
+			request.params |= PARITY_ODD;
+			dev_dbg(dev, "%s - odd parity\n", __func__);
+		} else {
+			request.params |= PARITY_EVEN;
+			dev_dbg(dev, "%s - even parity\n", __func__);
+		}
+	} else {
+		request.params |= PARITY_NONE;
+		dev_dbg(dev, "%s - no parity\n", __func__);
+	}
+	if (cflag & CSTOPB) {
+		request.params |= STOP_BIT_2_BIT;
+		dev_dbg(dev, "%s - 2 stop bits\n", __func__);
+	} else {
+		request.params |= STOP_BIT_1_BIT;
+		dev_dbg(dev, "%s - 1 stop bit\n", __func__);
+	}
+	if (cflag & CRTSCTS) {
+		dev_err(dev, "%s - hardware flow control is not supported\n",
+			__func__);
+	}
+	if (I_IXOFF(tty) || I_IXON(tty)) {
+		request.params |= FLOW_CONTROL_SW;
+		dev_dbg(dev, "%s - software flow control\n", __func__);
+	} else {
+		request.params |= FLOW_CONTROL_NONE;
+		dev_dbg(dev, "%s - no flow control\n", __func__);
+	}
+
+	upd78f0730_send_ctl(port, &request, sizeof(request));
+	upd78f0730_send_ctl(port, &request_xchr, sizeof(request_xchr));
+}
+
+/*
+ * upd78f0730_tiocmget
+ * Read current state of DTR and RTS.
+ * Other signals are not present and the values associated with them
+ * shall be ignored.
+ */
+static int upd78f0730_tiocmget(struct tty_struct *tty)
+{
+	int res = 0;
+	int signals;
+	unsigned long flags;
+	struct device *dev = tty->dev;
+	struct upd78f0730_serial_private *private;
+	struct usb_serial_port *port = tty->driver_data;
+
+	private = usb_get_serial_data(port->serial);
+
+	spin_lock_irqsave(&private->lock, flags);
+	signals = private->line_signals;
+	spin_unlock_irqrestore(&private->lock, flags);
+
+	res = ((signals & RESET_DTR) ? 0 : TIOCM_DTR)
+		| ((signals & RESET_RTS) ? 0 : TIOCM_RTS);
+
+	dev_dbg(dev, "%s - res = %x\n", __func__, res);
+
+	return res;
+}
+
+/*
+ * upd78f0730_tiocmset
+ * Set state of DTR and RTS.
+ * Requests for other signals are ignored without reporting a failure.
+ */
+static int upd78f0730_tiocmset(struct tty_struct *tty,
+			unsigned int set, unsigned int clear)
+{
+	int res;
+	unsigned long flags;
+	struct device *dev = tty->dev;
+	struct upd78f0730_serial_private *private;
+	struct usb_serial_port *port = tty->driver_data;
+	struct set_dtr_rts request = { .opcode = SET_DTR_RTS };
+
+	private = usb_get_serial_data(port->serial);
+
+	dev_dbg(dev, "%s\n", __func__);
+	spin_lock_irqsave(&private->lock, flags);
+	if (set & TIOCM_DTR) {
+		private->line_signals &= ~RESET_DTR;
+		dev_dbg(dev, "%s - set DTR\n", __func__);
+	}
+	if (set & TIOCM_RTS) {
+		private->line_signals &= ~RESET_RTS;
+		dev_dbg(dev, "%s - set RTS\n", __func__);
+	}
+	if (clear & TIOCM_DTR) {
+		private->line_signals |= RESET_DTR;
+		dev_dbg(dev, "%s - reset DTR\n", __func__);
+	}
+	if (clear & TIOCM_RTS) {
+		private->line_signals |= RESET_RTS;
+		dev_dbg(dev, "%s - reset RTS\n", __func__);
+	}
+	request.params = private->line_signals;
+	spin_unlock_irqrestore(&private->lock, flags);
+
+	res = upd78f0730_send_ctl(port, &request, sizeof(request));
+
+	return res;
+}
+
+/*
+ * upd78f0730_dtr_rts
+ * Initialize both DTR and RTS to a value passed as argument.
+ */
+static void upd78f0730_dtr_rts(struct usb_serial_port *port, int on)
+{
+	unsigned long flags;
+	struct device *dev = &port->dev;
+	struct upd78f0730_serial_private *private;
+	struct set_dtr_rts request = { .opcode = SET_DTR_RTS };
+
+	private = usb_get_serial_data(port->serial);
+
+	spin_lock_irqsave(&private->lock, flags);
+	if (on) {
+		private->line_signals &= ~(RESET_DTR | RESET_RTS);
+		dev_dbg(dev, "%s - set DTR and RTS\n", __func__);
+	} else {
+		private->line_signals |= RESET_DTR | RESET_RTS;
+		dev_dbg(dev, "%s - reset DTR and RTS\n", __func__);
+	}
+	request.params = private->line_signals;
+	spin_unlock_irqrestore(&private->lock, flags);
+
+	upd78f0730_send_ctl(port, &request, sizeof(request));
+}
+
+/*
+ * upd78f0730_break_ctl
+ * Control BREAK signal.
+ * The BREAK signal is not covered in the specification of the adaptor.
+ * It's behavior was sniffed from the original driver for Windows.
+ * BREAK is controlled by a bit in the 'params' field of SET_DTR_RTS command.
+ */
+static void upd78f0730_break_ctl(struct tty_struct *tty, int break_state)
+{
+	unsigned long flags;
+	struct device *dev = tty->dev;
+	struct upd78f0730_serial_private *private;
+	struct usb_serial_port *port = tty->driver_data;
+	struct set_dtr_rts request = { .opcode = SET_DTR_RTS };
+
+	private = usb_get_serial_data(port->serial);
+
+	spin_lock_irqsave(&private->lock, flags);
+	if (break_state) {
+		private->line_signals |= SET_BREAK;
+		dev_dbg(dev, "%s - set BREAK\n", __func__);
+	} else {
+		private->line_signals &= ~SET_BREAK;
+		dev_dbg(dev, "%s - reset BREAK\n", __func__);
+	}
+	request.params = private->line_signals;
+	spin_unlock_irqrestore(&private->lock, flags);
+
+	upd78f0730_send_ctl(port, &request, sizeof(request));
+}
+
+module_usb_serial_driver(serial_drivers, id_table);
+
+MODULE_DESCRIPTION(DRIVER_DESC);
+MODULE_AUTHOR(DRIVER_AUTHOR);
+MODULE_LICENSE("GPL");
-- 
2.5.0

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux