955 lines · 23.5 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0/* * usb-serial driver for Quatech USB 2 devices * * Copyright (C) 2012 Bill Pemberton (wfp5p@virginia.edu) * *  These devices all have only 1 bulk in and 1 bulk out that is shared *  for all serial ports. * */ #include <linux/unaligned.h>#include <linux/errno.h>#include <linux/slab.h>#include <linux/tty.h>#include <linux/tty_flip.h>#include <linux/module.h>#include <linux/serial.h>#include <linux/usb.h>#include <linux/usb/serial.h>#include <linux/serial_reg.h> /* default urb timeout for usb operations */#define QT2_USB_TIMEOUT USB_CTRL_SET_TIMEOUT #define QT_OPEN_CLOSE_CHANNEL       0xca#define QT_SET_GET_DEVICE           0xc2#define QT_SET_GET_REGISTER         0xc0#define QT_GET_SET_PREBUF_TRIG_LVL  0xcc#define QT_SET_ATF                  0xcd#define QT_TRANSFER_IN              0xc0#define QT_HW_FLOW_CONTROL_MASK     0xc5#define QT_SW_FLOW_CONTROL_MASK     0xc6#define QT2_BREAK_CONTROL	    0xc8#define QT2_GET_SET_UART            0xc1#define QT2_FLUSH_DEVICE	    0xc4#define QT2_GET_SET_QMCR            0xe1#define QT2_QMCR_RS232              0x40#define QT2_QMCR_RS422              0x10 #define  SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS) #define  SERIAL_EVEN_PARITY         (UART_LCR_PARITY | UART_LCR_EPAR) /* status bytes for the device */#define QT2_CONTROL_BYTE    0x1b#define QT2_LINE_STATUS     0x00  /* following 1 byte is line status */#define QT2_MODEM_STATUS    0x01  /* following 1 byte is modem status */#define QT2_XMIT_HOLD       0x02  /* following 2 bytes are ?? */#define QT2_CHANGE_PORT     0x03  /* following 1 byte is port to change to */#define QT2_REC_FLUSH       0x04  /* no following info */#define QT2_XMIT_FLUSH      0x05  /* no following info */#define QT2_CONTROL_ESCAPE  0xff  /* pass through previous 2 control bytes */ #define  MAX_BAUD_RATE              921600#define  DEFAULT_BAUD_RATE          9600 #define QT2_READ_BUFFER_SIZE    512  /* size of read buffer */#define QT2_WRITE_BUFFER_SIZE   512  /* size of write buffer */#define QT2_WRITE_CONTROL_SIZE  5    /* control bytes used for a write */ #define DRIVER_DESC "Quatech 2nd gen USB to Serial Driver" #define	USB_VENDOR_ID_QUATECH	0x061d#define QUATECH_SSU2_100	0xC120	/* RS232 single port */#define QUATECH_DSU2_100	0xC140	/* RS232 dual port */#define QUATECH_DSU2_400	0xC150	/* RS232/422/485 dual port */#define QUATECH_QSU2_100	0xC160	/* RS232 four port */#define QUATECH_QSU2_400	0xC170	/* RS232/422/485 four port */#define QUATECH_ESU2_100	0xC1A0	/* RS232 eight port */#define QUATECH_ESU2_400	0xC180	/* RS232/422/485 eight port */ struct qt2_device_detail {	int product_id;	int num_ports;}; #define QT_DETAILS(prod, ports)	\	.product_id = (prod),   \	.num_ports = (ports) static const struct qt2_device_detail qt2_device_details[] = {	{QT_DETAILS(QUATECH_SSU2_100, 1)},	{QT_DETAILS(QUATECH_DSU2_400, 2)},	{QT_DETAILS(QUATECH_DSU2_100, 2)},	{QT_DETAILS(QUATECH_QSU2_400, 4)},	{QT_DETAILS(QUATECH_QSU2_100, 4)},	{QT_DETAILS(QUATECH_ESU2_400, 8)},	{QT_DETAILS(QUATECH_ESU2_100, 8)},	{QT_DETAILS(0, 0)}	/* Terminating entry */}; static const struct usb_device_id id_table[] = {	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU2_100)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_100)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_400)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_100)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_400)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_100)},	{USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_400)},	{}			/* Terminating entry */};MODULE_DEVICE_TABLE(usb, id_table); struct qt2_serial_private {	unsigned char current_port;  /* current port for incoming data */ 	struct urb	*read_urb;   /* shared among all ports */	char		*read_buffer;}; struct qt2_port_private {	u8   device_port; 	spinlock_t urb_lock;	bool       urb_in_use;	struct urb *write_urb;	char       *write_buffer; 	spinlock_t  lock;	u8          shadowLSR;	u8          shadowMSR; 	struct usb_serial_port *port;}; static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch);static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch);static void qt2_write_bulk_callback(struct urb *urb);static void qt2_read_bulk_callback(struct urb *urb); static void qt2_release(struct usb_serial *serial){	struct qt2_serial_private *serial_priv; 	serial_priv = usb_get_serial_data(serial); 	usb_kill_urb(serial_priv->read_urb);	usb_free_urb(serial_priv->read_urb);	kfree(serial_priv->read_buffer);	kfree(serial_priv);} static inline int calc_baud_divisor(int baudrate){	int divisor, rem; 	divisor = MAX_BAUD_RATE / baudrate;	rem = MAX_BAUD_RATE % baudrate;	/* Round to nearest divisor */	if (((rem * 2) >= baudrate) && (baudrate != 110))		divisor++; 	return divisor;} static inline int qt2_set_port_config(struct usb_device *dev,				      unsigned char port_number,				      u16 baudrate, u16 lcr){	int divisor = calc_baud_divisor(baudrate);	u16 index = ((u16) (lcr << 8) | (u16) (port_number)); 	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),			       QT2_GET_SET_UART, 0x40,			       divisor, index, NULL, 0, QT2_USB_TIMEOUT);} static inline int qt2_control_msg(struct usb_device *dev,				  u8 request, u16 data, u16 index){	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),			       request, 0x40, data, index,			       NULL, 0, QT2_USB_TIMEOUT);} static inline int qt2_getregister(struct usb_device *dev,				  u8 uart,				  u8 reg,				  u8 *data){	int ret; 	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),			      QT_SET_GET_REGISTER, 0xc0, reg,			      uart, data, sizeof(*data), QT2_USB_TIMEOUT);	if (ret < (int)sizeof(*data)) {		if (ret >= 0)			ret = -EIO;	} 	return ret;} static inline int qt2_setregister(struct usb_device *dev,				  u8 uart, u8 reg, u16 data){	u16 value = (data << 8) | reg; 	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),			       QT_SET_GET_REGISTER, 0x40, value, uart,			       NULL, 0, QT2_USB_TIMEOUT);} static inline int update_mctrl(struct qt2_port_private *port_priv,			       unsigned int set, unsigned int clear){	struct usb_serial_port *port = port_priv->port;	struct usb_device *dev = port->serial->dev;	unsigned urb_value;	int status; 	if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {		dev_dbg(&port->dev,			"update_mctrl - DTR|RTS not being set|cleared\n");		return 0;	/* no change */	} 	clear &= ~set;	/* 'set' takes precedence over 'clear' */	urb_value = 0;	if (set & TIOCM_DTR)		urb_value |= UART_MCR_DTR;	if (set & TIOCM_RTS)		urb_value |= UART_MCR_RTS; 	status = qt2_setregister(dev, port_priv->device_port, UART_MCR,				 urb_value);	if (status < 0)		dev_err(&port->dev,			"update_mctrl - Error from MODEM_CTRL urb: %i\n",			status);	return status;} static int qt2_calc_num_ports(struct usb_serial *serial,					struct usb_serial_endpoints *epds){	struct qt2_device_detail d;	int i; 	for (i = 0; d = qt2_device_details[i], d.product_id != 0; i++) {		if (d.product_id == le16_to_cpu(serial->dev->descriptor.idProduct))			return d.num_ports;	} 	/* we didn't recognize the device */	dev_err(&serial->dev->dev,		 "don't know the number of ports, assuming 1\n"); 	return 1;} static void qt2_set_termios(struct tty_struct *tty,		            struct usb_serial_port *port,		            const struct ktermios *old_termios){	struct usb_device *dev = port->serial->dev;	struct qt2_port_private *port_priv;	struct ktermios *termios = &tty->termios;	u16 baud;	unsigned int cflag = termios->c_cflag;	u16 new_lcr = 0;	int status; 	port_priv = usb_get_serial_port_data(port); 	if (cflag & PARENB) {		if (cflag & PARODD)			new_lcr |= UART_LCR_PARITY;		else			new_lcr |= SERIAL_EVEN_PARITY;	} 	new_lcr |= UART_LCR_WLEN(tty_get_char_size(cflag)); 	baud = tty_get_baud_rate(tty);	if (!baud)		baud = 9600; 	status = qt2_set_port_config(dev, port_priv->device_port, baud,				     new_lcr);	if (status < 0)		dev_err(&port->dev, "%s - qt2_set_port_config failed: %i\n",			__func__, status); 	if (cflag & CRTSCTS)		status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,					 SERIAL_CRTSCTS,					 port_priv->device_port);	else		status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,					 0, port_priv->device_port);	if (status < 0)		dev_err(&port->dev, "%s - set HW flow control failed: %i\n",			__func__, status); 	if (I_IXOFF(tty) || I_IXON(tty)) {		u16 x = ((u16) (START_CHAR(tty) << 8) | (u16) (STOP_CHAR(tty))); 		status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,					 x, port_priv->device_port);	} else		status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,					 0, port_priv->device_port); 	if (status < 0)		dev_err(&port->dev, "%s - set SW flow control failed: %i\n",			__func__, status); } static int qt2_open(struct tty_struct *tty, struct usb_serial_port *port){	struct usb_serial *serial;	struct qt2_port_private *port_priv;	u8 *data;	u16 device_port;	int status;	unsigned long flags; 	device_port = port->port_number; 	serial = port->serial; 	port_priv = usb_get_serial_port_data(port); 	/* set the port to RS232 mode */	status = qt2_control_msg(serial->dev, QT2_GET_SET_QMCR,				 QT2_QMCR_RS232, device_port);	if (status < 0) {		dev_err(&port->dev,			"%s failed to set RS232 mode for port %i error %i\n",			__func__, device_port, status);		return status;	} 	data = kzalloc(2, GFP_KERNEL);	if (!data)		return -ENOMEM; 	/* open the port */	status = usb_control_msg(serial->dev,				 usb_rcvctrlpipe(serial->dev, 0),				 QT_OPEN_CLOSE_CHANNEL,				 0xc0, 0,				 device_port, data, 2, QT2_USB_TIMEOUT); 	if (status < 2) {		dev_err(&port->dev, "%s - open port failed %i\n", __func__,			status);		if (status >= 0)			status = -EIO;		kfree(data);		return status;	} 	spin_lock_irqsave(&port_priv->lock, flags);	port_priv->shadowLSR = data[0];	port_priv->shadowMSR = data[1];	spin_unlock_irqrestore(&port_priv->lock, flags); 	kfree(data); 	/* set to default speed and 8bit word size */	status = qt2_set_port_config(serial->dev, device_port,				     DEFAULT_BAUD_RATE, UART_LCR_WLEN8);	if (status < 0) {		dev_err(&port->dev, "%s - initial setup failed (%i)\n",			__func__, device_port);		return status;	} 	port_priv->device_port = (u8) device_port; 	if (tty)		qt2_set_termios(tty, port, &tty->termios); 	return 0; } static void qt2_close(struct usb_serial_port *port){	struct usb_serial *serial;	struct qt2_port_private *port_priv;	int i; 	serial = port->serial;	port_priv = usb_get_serial_port_data(port); 	usb_kill_urb(port_priv->write_urb); 	/* flush the port transmit buffer */	i = usb_control_msg(serial->dev,			    usb_sndctrlpipe(serial->dev, 0),			    QT2_FLUSH_DEVICE, 0x40, 1,			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT); 	if (i < 0)		dev_err(&port->dev, "%s - transmit buffer flush failed: %i\n",			__func__, i); 	/* flush the port receive buffer */	i = usb_control_msg(serial->dev,			    usb_sndctrlpipe(serial->dev, 0),			    QT2_FLUSH_DEVICE, 0x40, 0,			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT); 	if (i < 0)		dev_err(&port->dev, "%s - receive buffer flush failed: %i\n",			__func__, i); 	/* close the port */	i = usb_control_msg(serial->dev,			    usb_sndctrlpipe(serial->dev, 0),			    QT_OPEN_CLOSE_CHANNEL,			    0x40, 0,			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT); 	if (i < 0)		dev_err(&port->dev, "%s - close port failed %i\n",			__func__, i);} static void qt2_disconnect(struct usb_serial *serial){	struct qt2_serial_private *serial_priv = usb_get_serial_data(serial); 	usb_kill_urb(serial_priv->read_urb);} static void qt2_process_status(struct usb_serial_port *port, unsigned char *ch){	switch (*ch) {	case QT2_LINE_STATUS:		qt2_update_lsr(port, ch + 1);		break;	case QT2_MODEM_STATUS:		qt2_update_msr(port, ch + 1);		break;	}} static void qt2_process_read_urb(struct urb *urb){	struct usb_serial *serial;	struct qt2_serial_private *serial_priv;	struct usb_serial_port *port;	bool escapeflag;	unsigned char *ch;	int i;	unsigned char newport;	int len = urb->actual_length; 	if (!len)		return; 	ch = urb->transfer_buffer;	serial = urb->context;	serial_priv = usb_get_serial_data(serial);	port = serial->port[serial_priv->current_port]; 	for (i = 0; i < urb->actual_length; i++) {		ch = (unsigned char *)urb->transfer_buffer + i;		if ((i <= (len - 3)) &&		    (*ch == QT2_CONTROL_BYTE) &&		    (*(ch + 1) == QT2_CONTROL_BYTE)) {			escapeflag = false;			switch (*(ch + 2)) {			case QT2_LINE_STATUS:			case QT2_MODEM_STATUS:				if (i > (len - 4)) {					dev_warn(&port->dev,						 "%s - status message too short\n",						__func__);					break;				}				qt2_process_status(port, ch + 2);				i += 3;				escapeflag = true;				break;			case QT2_XMIT_HOLD:				if (i > (len - 5)) {					dev_warn(&port->dev,						 "%s - xmit_empty message too short\n",						 __func__);					break;				}				/* bytes_written = (ch[1] << 4) + ch[0]; */				i += 4;				escapeflag = true;				break;			case QT2_CHANGE_PORT:				if (i > (len - 4)) {					dev_warn(&port->dev,						 "%s - change_port message too short\n",						 __func__);					break;				}				tty_flip_buffer_push(&port->port);

Lines 1–500 of 955.