[linux-2.6-block.git] / drivers / usb / serial / belkin_sa.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Belkin USB Serial Adapter Driver
 *
 *  Copyright (C) 2000		William Greathouse (wgreathouse@smva.com)
 *  Copyright (C) 2000-2001	Greg Kroah-Hartman (greg@kroah.com)
 *  Copyright (C) 2010		Johan Hovold (jhovold@gmail.com)
 *
 *  This program is largely derived from work by the linux-usb group
 *  and associated source files.  Please see the usb/serial files for
 *  individual credits and copyrights.
 *
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
 *
 * TODO:
 * -- Add true modem control line query capability.  Currently we track the
 *    states reported by the interrupt and the states we request.
 * -- Add support for flush commands
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/uaccess.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
#include "belkin_sa.h"

#define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
#define DRIVER_DESC "USB Belkin Serial converter driver"

/* function prototypes for a Belkin USB Serial Adapter F5U103 */
static int belkin_sa_port_probe(struct usb_serial_port *port);
static int belkin_sa_port_remove(struct usb_serial_port *port);
static int  belkin_sa_open(struct tty_struct *tty,
			struct usb_serial_port *port);
static void belkin_sa_close(struct usb_serial_port *port);
static void belkin_sa_read_int_callback(struct urb *urb);
static void belkin_sa_process_read_urb(struct urb *urb);
static void belkin_sa_set_termios(struct tty_struct *tty,
			struct usb_serial_port *port, struct ktermios * old);
static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
static int  belkin_sa_tiocmget(struct tty_struct *tty);
static int  belkin_sa_tiocmset(struct tty_struct *tty,
					unsigned int set, unsigned int clear);


static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
	{ USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
	{ USB_DEVICE(PERACOM_VID, PERACOM_PID) },
	{ USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
	{ USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
	{ USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
	{ }	/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, id_table);

/* All of the device info needed for the serial converters */
static struct usb_serial_driver belkin_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"belkin",
	},
	.description =		"Belkin / Peracom / GoHubs USB Serial Adapter",
	.id_table =		id_table,
	.num_ports =		1,
	.open =			belkin_sa_open,
	.close =		belkin_sa_close,
	.read_int_callback =	belkin_sa_read_int_callback,
	.process_read_urb =	belkin_sa_process_read_urb,
	.set_termios =		belkin_sa_set_termios,
	.break_ctl =		belkin_sa_break_ctl,
	.tiocmget =		belkin_sa_tiocmget,
	.tiocmset =		belkin_sa_tiocmset,
	.port_probe =		belkin_sa_port_probe,
	.port_remove =		belkin_sa_port_remove,
};

static struct usb_serial_driver * const serial_drivers[] = {
	&belkin_device, NULL
};

struct belkin_sa_private {
	spinlock_t		lock;
	unsigned long		control_state;
	unsigned char		last_lsr;
	unsigned char		last_msr;
	int			bad_flow_control;
};


/*
 * ***************************************************************************
 * Belkin USB Serial Adapter F5U103 specific driver functions
 * ***************************************************************************
 */

#define WDR_TIMEOUT 5000 /* default urb timeout */

/* assumes that struct usb_serial *serial is available */
#define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
					    (c), BELKIN_SA_SET_REQUEST_TYPE, \
					    (v), 0, NULL, 0, WDR_TIMEOUT)

static int belkin_sa_port_probe(struct usb_serial_port *port)
{
	struct usb_device *dev = port->serial->dev;
	struct belkin_sa_private *priv;

	priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
	if (!priv)
		return -ENOMEM;

	spin_lock_init(&priv->lock);
	priv->control_state = 0;
	priv->last_lsr = 0;
	priv->last_msr = 0;
	/* see comments at top of file */
	priv->bad_flow_control =
		(le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
	dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
					le16_to_cpu(dev->descriptor.bcdDevice),
					priv->bad_flow_control);

	usb_set_serial_port_data(port, priv);

	return 0;
}

static int belkin_sa_port_remove(struct usb_serial_port *port)
{
	struct belkin_sa_private *priv;

	priv = usb_get_serial_port_data(port);
	kfree(priv);

	return 0;
}

static int belkin_sa_open(struct tty_struct *tty,
					struct usb_serial_port *port)
{
	int retval;

	retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
	if (retval) {
		dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
		return retval;
	}

	retval = usb_serial_generic_open(tty, port);
	if (retval)
		usb_kill_urb(port->interrupt_in_urb);

	return retval;
}

static void belkin_sa_close(struct usb_serial_port *port)
{
	usb_serial_generic_close(port);
	usb_kill_urb(port->interrupt_in_urb);
}

static void belkin_sa_read_int_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct belkin_sa_private *priv;
	unsigned char *data = urb->transfer_buffer;
	int retval;
	int status = urb->status;
	unsigned long flags;

	switch (status) {
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
		return;
	default:
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
		goto exit;
	}

	usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);

	/* Handle known interrupt data */
	/* ignore data[0] and data[1] */

	priv = usb_get_serial_port_data(port);
	spin_lock_irqsave(&priv->lock, flags);
	priv->last_msr = data[BELKIN_SA_MSR_INDEX];

	/* Record Control Line states */
	if (priv->last_msr & BELKIN_SA_MSR_DSR)
		priv->control_state |= TIOCM_DSR;
	else
		priv->control_state &= ~TIOCM_DSR;

	if (priv->last_msr & BELKIN_SA_MSR_CTS)
		priv->control_state |= TIOCM_CTS;
	else
		priv->control_state &= ~TIOCM_CTS;

	if (priv->last_msr & BELKIN_SA_MSR_RI)
		priv->control_state |= TIOCM_RI;
	else
		priv->control_state &= ~TIOCM_RI;

	if (priv->last_msr & BELKIN_SA_MSR_CD)
		priv->control_state |= TIOCM_CD;
	else
		priv->control_state &= ~TIOCM_CD;

	priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
	spin_unlock_irqrestore(&priv->lock, flags);
exit:
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval)
		dev_err(&port->dev, "%s - usb_submit_urb failed with "
			"result %d\n", __func__, retval);
}

static void belkin_sa_process_read_urb(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	unsigned char *data = urb->transfer_buffer;
	unsigned long flags;
	unsigned char status;
	char tty_flag;

	/* Update line status */
	tty_flag = TTY_NORMAL;

	spin_lock_irqsave(&priv->lock, flags);
	status = priv->last_lsr;
	priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
	spin_unlock_irqrestore(&priv->lock, flags);

	if (!urb->actual_length)
		return;

	if (status & BELKIN_SA_LSR_ERR) {
		/* Break takes precedence over parity, which takes precedence
		 * over framing errors. */
		if (status & BELKIN_SA_LSR_BI)
			tty_flag = TTY_BREAK;
		else if (status & BELKIN_SA_LSR_PE)
			tty_flag = TTY_PARITY;
		else if (status & BELKIN_SA_LSR_FE)
			tty_flag = TTY_FRAME;
		dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);

		/* Overrun is special, not associated with a char. */
		if (status & BELKIN_SA_LSR_OE)
			tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
	}

	tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
							urb->actual_length);
	tty_flip_buffer_push(&port->port);
}

static void belkin_sa_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
{
	struct usb_serial *serial = port->serial;
	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	unsigned int iflag;
	unsigned int cflag;
	unsigned int old_iflag = 0;
	unsigned int old_cflag = 0;
	__u16 urb_value = 0; /* Will hold the new flags */
	unsigned long flags;
	unsigned long control_state;
	int bad_flow_control;
	speed_t baud;
	struct ktermios *termios = &tty->termios;

	iflag = termios->c_iflag;
	cflag = termios->c_cflag;

	termios->c_cflag &= ~CMSPAR;

	/* get a local copy of the current port settings */
	spin_lock_irqsave(&priv->lock, flags);
	control_state = priv->control_state;
	bad_flow_control = priv->bad_flow_control;
	spin_unlock_irqrestore(&priv->lock, flags);

	old_iflag = old_termios->c_iflag;
	old_cflag = old_termios->c_cflag;

	/* Set the baud rate */
	if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
		/* reassert DTR and (maybe) RTS on transition from B0 */
		if ((old_cflag & CBAUD) == B0) {
			control_state |= (TIOCM_DTR|TIOCM_RTS);
			if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
				dev_err(&port->dev, "Set DTR error\n");
			/* don't set RTS if using hardware flow control */
			if (!(old_cflag & CRTSCTS))
				if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
								, 1) < 0)
					dev_err(&port->dev, "Set RTS error\n");
		}
	}

	baud = tty_get_baud_rate(tty);
	if (baud) {
		urb_value = BELKIN_SA_BAUD(baud);
		/* Clip to maximum speed */
		if (urb_value == 0)
			urb_value = 1;
		/* Turn it back into a resulting real baud rate */
		baud = BELKIN_SA_BAUD(urb_value);

		/* Report the actual baud rate back to the caller */
		tty_encode_baud_rate(tty, baud, baud);
		if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
			dev_err(&port->dev, "Set baudrate error\n");
	} else {
		/* Disable flow control */
		if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
						BELKIN_SA_FLOW_NONE) < 0)
			dev_err(&port->dev, "Disable flowcontrol error\n");
		/* Drop RTS and DTR */
		control_state &= ~(TIOCM_DTR | TIOCM_RTS);
		if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
			dev_err(&port->dev, "DTR LOW error\n");
		if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
			dev_err(&port->dev, "RTS LOW error\n");
	}

	/* set the parity */
	if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
		if (cflag & PARENB)
			urb_value = (cflag & PARODD) ?  BELKIN_SA_PARITY_ODD
						: BELKIN_SA_PARITY_EVEN;
		else
			urb_value = BELKIN_SA_PARITY_NONE;
		if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
			dev_err(&port->dev, "Set parity error\n");
	}

	/* set the number of data bits */
	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
		switch (cflag & CSIZE) {
		case CS5:
			urb_value = BELKIN_SA_DATA_BITS(5);
			break;
		case CS6:
			urb_value = BELKIN_SA_DATA_BITS(6);
			break;
		case CS7:
			urb_value = BELKIN_SA_DATA_BITS(7);
			break;
		case CS8:
			urb_value = BELKIN_SA_DATA_BITS(8);
			break;
		default:
			dev_dbg(&port->dev,
				"CSIZE was not CS5-CS8, using default of 8\n");
			urb_value = BELKIN_SA_DATA_BITS(8);
			break;
		}
		if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
			dev_err(&port->dev, "Set data bits error\n");
	}

	/* set the number of stop bits */
	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
		urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
						: BELKIN_SA_STOP_BITS(1);
		if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
							urb_value) < 0)
			dev_err(&port->dev, "Set stop bits error\n");
	}

	/* Set flow control */
	if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
		((cflag ^ old_cflag) & CRTSCTS)) {
		urb_value = 0;
		if ((iflag & IXOFF) || (iflag & IXON))
			urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
		else
			urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);

		if (cflag & CRTSCTS)
			urb_value |=  (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
		else
			urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);

		if (bad_flow_control)
			urb_value &= ~(BELKIN_SA_FLOW_IRTS);

		if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
			dev_err(&port->dev, "Set flow control error\n");
	}

	/* save off the modified port settings */
	spin_lock_irqsave(&priv->lock, flags);
	priv->control_state = control_state;
	spin_unlock_irqrestore(&priv->lock, flags);
}

static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
{
	struct usb_serial_port *port = tty->driver_data;
	struct usb_serial *serial = port->serial;

	if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
		dev_err(&port->dev, "Set break_ctl %d\n", break_state);
}

static int belkin_sa_tiocmget(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	unsigned long control_state;
	unsigned long flags;

	spin_lock_irqsave(&priv->lock, flags);
	control_state = priv->control_state;
	spin_unlock_irqrestore(&priv->lock, flags);

	return control_state;
}

static int belkin_sa_tiocmset(struct tty_struct *tty,
			       unsigned int set, unsigned int clear)
{
	struct usb_serial_port *port = tty->driver_data;
	struct usb_serial *serial = port->serial;
	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	unsigned long control_state;
	unsigned long flags;
	int retval;
	int rts = 0;
	int dtr = 0;

	spin_lock_irqsave(&priv->lock, flags);
	control_state = priv->control_state;

	if (set & TIOCM_RTS) {
		control_state |= TIOCM_RTS;
		rts = 1;
	}
	if (set & TIOCM_DTR) {
		control_state |= TIOCM_DTR;
		dtr = 1;
	}
	if (clear & TIOCM_RTS) {
		control_state &= ~TIOCM_RTS;
		rts = 0;
	}
	if (clear & TIOCM_DTR) {
		control_state &= ~TIOCM_DTR;
		dtr = 0;
	}

	priv->control_state = control_state;
	spin_unlock_irqrestore(&priv->lock, flags);

	retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
	if (retval < 0) {
		dev_err(&port->dev, "Set RTS error %d\n", retval);
		goto exit;
	}

	retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
	if (retval < 0) {
		dev_err(&port->dev, "Set DTR error %d\n", retval);
		goto exit;
	}
exit:
	return retval;
}

module_usb_serial_driver(serial_drivers, id_table);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0+
1da177e4 LT	2	/*
	3	* Belkin USB Serial Adapter Driver
	4	*
	5	* Copyright (C) 2000 William Greathouse (wgreathouse@smva.com)
70f3c758	6	* Copyright (C) 2000-2001 Greg Kroah-Hartman (greg@kroah.com)
2afd8287	7	* Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
1da177e4 LT	8	*
	9	* This program is largely derived from work by the linux-usb group
	10	* and associated source files. Please see the usb/serial files for
	11	* individual credits and copyrights.
b69c1499	12	*
b69c1499 AC	13	* See Documentation/usb/usb-serial.txt for more information on using this
b69c1499 AC	14	* driver
1da177e4 LT	15	*
1da177e4 LT	16	* TODO:
cd8c5053	17	* -- Add true modem control line query capability. Currently we track the
1da177e4	18	* states reported by the interrupt and the states we request.
1da177e4	19	* -- Add support for flush commands
1da177e4 LT	20	*/
1da177e4 LT	21
1da177e4 LT	22	#include <linux/kernel.h>
1da177e4 LT	23	#include <linux/errno.h>
1da177e4 LT	24	#include <linux/slab.h>
	25	#include <linux/tty.h>
	26	#include <linux/tty_driver.h>
	27	#include <linux/tty_flip.h>
	28	#include <linux/module.h>
	29	#include <linux/spinlock.h>
b69c1499	30	#include <linux/uaccess.h>
1da177e4	31	#include <linux/usb.h>
a969888c	32	#include <linux/usb/serial.h>
1da177e4 LT	33	#include "belkin_sa.h"
1da177e4 LT	34
1da177e4 LT	35	#define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
	36	#define DRIVER_DESC "USB Belkin Serial converter driver"
	37
	38	/* function prototypes for a Belkin USB Serial Adapter F5U103 */
fa919751 JH	39	static int belkin_sa_port_probe(struct usb_serial_port *port);
fa919751 JH	40	static int belkin_sa_port_remove(struct usb_serial_port *port);
b69c1499	41	static int belkin_sa_open(struct tty_struct *tty,
a509a7e4	42	struct usb_serial_port *port);
335f8514	43	static void belkin_sa_close(struct usb_serial_port *port);
b69c1499	44	static void belkin_sa_read_int_callback(struct urb *urb);
2afd8287	45	static void belkin_sa_process_read_urb(struct urb *urb);
b69c1499 AC	46	static void belkin_sa_set_termios(struct tty_struct *tty,
	47	struct usb_serial_port port, struct ktermios old);
	48	static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
60b33c13	49	static int belkin_sa_tiocmget(struct tty_struct *tty);
20b9d177	50	static int belkin_sa_tiocmset(struct tty_struct *tty,
b69c1499	51	unsigned int set, unsigned int clear);
1da177e4 LT	52
1da177e4 LT	53
68e24113	54	static const struct usb_device_id id_table[] = {
1da177e4 LT	55	{ USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
	56	{ USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
	57	{ USB_DEVICE(PERACOM_VID, PERACOM_PID) },
	58	{ USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
	59	{ USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
	60	{ USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
b69c1499	61	{ } /* Terminating entry */
1da177e4	62	};
68e24113	63	MODULE_DEVICE_TABLE(usb, id_table);
1da177e4 LT	64
1da177e4 LT	65	/* All of the device info needed for the serial converters */
ea65370d	66	static struct usb_serial_driver belkin_device = {
18fcac35 GKH	67	.driver = {
18fcac35 GKH	68	.owner = THIS_MODULE,
269bda1c	69	.name = "belkin",
18fcac35	70	},
269bda1c	71	.description = "Belkin / Peracom / GoHubs USB Serial Adapter",
68e24113	72	.id_table = id_table,
1da177e4 LT	73	.num_ports = 1,
	74	.open = belkin_sa_open,
	75	.close = belkin_sa_close,
b69c1499	76	.read_int_callback = belkin_sa_read_int_callback,
2afd8287	77	.process_read_urb = belkin_sa_process_read_urb,
1da177e4 LT	78	.set_termios = belkin_sa_set_termios,
	79	.break_ctl = belkin_sa_break_ctl,
	80	.tiocmget = belkin_sa_tiocmget,
	81	.tiocmset = belkin_sa_tiocmset,
fa919751 JH	82	.port_probe = belkin_sa_port_probe,
fa919751 JH	83	.port_remove = belkin_sa_port_remove,
1da177e4 LT	84	};
1da177e4 LT	85
08a4f6bc AS	86	static struct usb_serial_driver * const serial_drivers[] = {
	87	&belkin_device, NULL
	88	};
	89
1da177e4 LT	90	struct belkin_sa_private {
	91	spinlock_t lock;
	92	unsigned long control_state;
	93	unsigned char last_lsr;
	94	unsigned char last_msr;
	95	int bad_flow_control;
	96	};
	97
	98
	99	/*
	100	* ***************************************************************************
	101	* Belkin USB Serial Adapter F5U103 specific driver functions
	102	* ***************************************************************************
	103	*/
	104
	105	#define WDR_TIMEOUT 5000 /* default urb timeout */
	106
	107	/* assumes that struct usb_serial serial is available /
b69c1499	108	#define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
1da177e4 LT	109	(c), BELKIN_SA_SET_REQUEST_TYPE, \
	110	(v), 0, NULL, 0, WDR_TIMEOUT)
	111
fa919751	112	static int belkin_sa_port_probe(struct usb_serial_port *port)
1da177e4	113	{
fa919751	114	struct usb_device *dev = port->serial->dev;
1da177e4 LT	115	struct belkin_sa_private *priv;
1da177e4 LT	116
1da177e4 LT	117	priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
1da177e4 LT	118	if (!priv)
fa919751 JH	119	return -ENOMEM;
fa919751 JH	120
1da177e4 LT	121	spin_lock_init(&priv->lock);
	122	priv->control_state = 0;
	123	priv->last_lsr = 0;
	124	priv->last_msr = 0;
	125	/* see comments at top of file */
b69c1499 AC	126	priv->bad_flow_control =
b69c1499 AC	127	(le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
c197a8db	128	dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
b69c1499 AC	129	le16_to_cpu(dev->descriptor.bcdDevice),
b69c1499 AC	130	priv->bad_flow_control);
1da177e4	131
fa919751	132	usb_set_serial_port_data(port, priv);
b69c1499 AC	133
b69c1499 AC	134	return 0;
1da177e4 LT	135	}
1da177e4 LT	136
fa919751	137	static int belkin_sa_port_remove(struct usb_serial_port *port)
1da177e4	138	{
fa919751	139	struct belkin_sa_private *priv;
b69c1499	140
fa919751 JH	141	priv = usb_get_serial_port_data(port);
	142	kfree(priv);
	143
	144	return 0;
1da177e4 LT	145	}
1da177e4 LT	146
726ef428	147	static int belkin_sa_open(struct tty_struct *tty,
a509a7e4	148	struct usb_serial_port *port)
1da177e4	149	{
f2f8b7fe	150	int retval;
1da177e4	151
1da177e4 LT	152	retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1da177e4 LT	153	if (retval) {
194343d9	154	dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
f2f8b7fe	155	return retval;
1da177e4 LT	156	}
1da177e4 LT	157
f2f8b7fe JH	158	retval = usb_serial_generic_open(tty, port);
	159	if (retval)
	160	usb_kill_urb(port->interrupt_in_urb);
	161
1da177e4	162	return retval;
726ef428	163	}
1da177e4	164
335f8514	165	static void belkin_sa_close(struct usb_serial_port *port)
1da177e4	166	{
f26788da	167	usb_serial_generic_close(port);
1da177e4	168	usb_kill_urb(port->interrupt_in_urb);
726ef428	169	}
1da177e4	170
95da310e	171	static void belkin_sa_read_int_callback(struct urb *urb)
1da177e4	172	{
cdc97792	173	struct usb_serial_port *port = urb->context;
1da177e4 LT	174	struct belkin_sa_private *priv;
	175	unsigned char *data = urb->transfer_buffer;
	176	int retval;
f26aad25	177	int status = urb->status;
1da177e4 LT	178	unsigned long flags;
1da177e4 LT	179
f26aad25	180	switch (status) {
1da177e4 LT	181	case 0:
	182	/* success */
	183	break;
	184	case -ECONNRESET:
	185	case -ENOENT:
	186	case -ESHUTDOWN:
	187	/* this urb is terminated, clean up */
c89aa638 GKH	188	dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
c89aa638 GKH	189	__func__, status);
1da177e4 LT	190	return;
1da177e4 LT	191	default:
c89aa638 GKH	192	dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
c89aa638 GKH	193	__func__, status);
1da177e4 LT	194	goto exit;
	195	}
	196
59d33f2f	197	usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1da177e4 LT	198
	199	/* Handle known interrupt data */
	200	/* ignore data[0] and data[1] */
	201
	202	priv = usb_get_serial_port_data(port);
	203	spin_lock_irqsave(&priv->lock, flags);
	204	priv->last_msr = data[BELKIN_SA_MSR_INDEX];
b69c1499	205
1da177e4 LT	206	/* Record Control Line states */
	207	if (priv->last_msr & BELKIN_SA_MSR_DSR)
	208	priv->control_state \|= TIOCM_DSR;
	209	else
	210	priv->control_state &= ~TIOCM_DSR;
	211
	212	if (priv->last_msr & BELKIN_SA_MSR_CTS)
	213	priv->control_state \|= TIOCM_CTS;
	214	else
	215	priv->control_state &= ~TIOCM_CTS;
	216
	217	if (priv->last_msr & BELKIN_SA_MSR_RI)
	218	priv->control_state \|= TIOCM_RI;
	219	else
	220	priv->control_state &= ~TIOCM_RI;
	221
	222	if (priv->last_msr & BELKIN_SA_MSR_CD)
	223	priv->control_state \|= TIOCM_CD;
	224	else
	225	priv->control_state &= ~TIOCM_CD;
	226
1da177e4	227	priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
1da177e4 LT	228	spin_unlock_irqrestore(&priv->lock, flags);
1da177e4 LT	229	exit:
b69c1499	230	retval = usb_submit_urb(urb, GFP_ATOMIC);
1da177e4	231	if (retval)
194343d9 GKH	232	dev_err(&port->dev, "%s - usb_submit_urb failed with "
194343d9 GKH	233	"result %d\n", __func__, retval);
1da177e4 LT	234	}
1da177e4 LT	235
2afd8287 JH	236	static void belkin_sa_process_read_urb(struct urb *urb)
	237	{
	238	struct usb_serial_port *port = urb->context;
	239	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
2afd8287 JH	240	unsigned char *data = urb->transfer_buffer;
	241	unsigned long flags;
	242	unsigned char status;
	243	char tty_flag;
	244
	245	/* Update line status */
	246	tty_flag = TTY_NORMAL;
	247
	248	spin_lock_irqsave(&priv->lock, flags);
	249	status = priv->last_lsr;
	250	priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
	251	spin_unlock_irqrestore(&priv->lock, flags);
	252
	253	if (!urb->actual_length)
	254	return;
	255
2afd8287 JH	256	if (status & BELKIN_SA_LSR_ERR) {
	257	/* Break takes precedence over parity, which takes precedence
	258	* over framing errors. */
	259	if (status & BELKIN_SA_LSR_BI)
	260	tty_flag = TTY_BREAK;
	261	else if (status & BELKIN_SA_LSR_PE)
	262	tty_flag = TTY_PARITY;
	263	else if (status & BELKIN_SA_LSR_FE)
	264	tty_flag = TTY_FRAME;
	265	dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
	266
	267	/* Overrun is special, not associated with a char. */
	268	if (status & BELKIN_SA_LSR_OE)
92a19f9c	269	tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
2afd8287 JH	270	}
2afd8287 JH	271
2f693357	272	tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
2afd8287	273	urb->actual_length);
2e124b4a	274	tty_flip_buffer_push(&port->port);
2afd8287 JH	275	}
2afd8287 JH	276
95da310e AC	277	static void belkin_sa_set_termios(struct tty_struct *tty,
95da310e AC	278	struct usb_serial_port port, struct ktermios old_termios)
1da177e4 LT	279	{
	280	struct usb_serial *serial = port->serial;
	281	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	282	unsigned int iflag;
	283	unsigned int cflag;
	284	unsigned int old_iflag = 0;
	285	unsigned int old_cflag = 0;
	286	__u16 urb_value = 0; /* Will hold the new flags */
	287	unsigned long flags;
	288	unsigned long control_state;
	289	int bad_flow_control;
9a8baec7	290	speed_t baud;
adc8d746	291	struct ktermios *termios = &tty->termios;
b69c1499	292
3ec466b4 AC	293	iflag = termios->c_iflag;
3ec466b4 AC	294	cflag = termios->c_cflag;
1da177e4	295
3ec466b4	296	termios->c_cflag &= ~CMSPAR;
1da177e4 LT	297
	298	/* get a local copy of the current port settings */
	299	spin_lock_irqsave(&priv->lock, flags);
	300	control_state = priv->control_state;
	301	bad_flow_control = priv->bad_flow_control;
	302	spin_unlock_irqrestore(&priv->lock, flags);
b69c1499	303
9a8baec7 AC	304	old_iflag = old_termios->c_iflag;
9a8baec7 AC	305	old_cflag = old_termios->c_cflag;
1da177e4 LT	306
1da177e4 LT	307	/* Set the baud rate */
3ec466b4	308	if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
1da177e4	309	/* reassert DTR and (maybe) RTS on transition from B0 */
b69c1499	310	if ((old_cflag & CBAUD) == B0) {
1da177e4 LT	311	control_state \|= (TIOCM_DTR\|TIOCM_RTS);
1da177e4 LT	312	if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
194343d9	313	dev_err(&port->dev, "Set DTR error\n");
1da177e4	314	/* don't set RTS if using hardware flow control */
3ec466b4	315	if (!(old_cflag & CRTSCTS))
b69c1499 AC	316	if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
b69c1499 AC	317	, 1) < 0)
194343d9	318	dev_err(&port->dev, "Set RTS error\n");
1da177e4	319	}
9a8baec7	320	}
1da177e4	321
95da310e	322	baud = tty_get_baud_rate(tty);
3ec466b4 AC	323	if (baud) {
	324	urb_value = BELKIN_SA_BAUD(baud);
	325	/* Clip to maximum speed */
	326	if (urb_value == 0)
	327	urb_value = 1;
	328	/* Turn it back into a resulting real baud rate */
	329	baud = BELKIN_SA_BAUD(urb_value);
	330
	331	/* Report the actual baud rate back to the caller */
95da310e	332	tty_encode_baud_rate(tty, baud, baud);
9a8baec7	333	if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
194343d9	334	dev_err(&port->dev, "Set baudrate error\n");
9a8baec7 AC	335	} else {
9a8baec7 AC	336	/* Disable flow control */
b69c1499 AC	337	if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
b69c1499 AC	338	BELKIN_SA_FLOW_NONE) < 0)
194343d9	339	dev_err(&port->dev, "Disable flowcontrol error\n");
9a8baec7 AC	340	/* Drop RTS and DTR */
	341	control_state &= ~(TIOCM_DTR \| TIOCM_RTS);
	342	if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
194343d9	343	dev_err(&port->dev, "DTR LOW error\n");
9a8baec7	344	if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
194343d9	345	dev_err(&port->dev, "RTS LOW error\n");
1da177e4 LT	346	}
	347
	348	/* set the parity */
b69c1499	349	if ((cflag ^ old_cflag) & (PARENB \| PARODD)) {
1da177e4	350	if (cflag & PARENB)
b69c1499 AC	351	urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD
b69c1499 AC	352	: BELKIN_SA_PARITY_EVEN;
1da177e4 LT	353	else
	354	urb_value = BELKIN_SA_PARITY_NONE;
	355	if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
194343d9	356	dev_err(&port->dev, "Set parity error\n");
1da177e4 LT	357	}
	358
	359	/* set the number of data bits */
b69c1499	360	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1da177e4	361	switch (cflag & CSIZE) {
b69c1499 AC	362	case CS5:
	363	urb_value = BELKIN_SA_DATA_BITS(5);
	364	break;
	365	case CS6:
	366	urb_value = BELKIN_SA_DATA_BITS(6);
	367	break;
	368	case CS7:
	369	urb_value = BELKIN_SA_DATA_BITS(7);
	370	break;
	371	case CS8:
	372	urb_value = BELKIN_SA_DATA_BITS(8);
	373	break;
70f3c758	374	default:
c89aa638 GKH	375	dev_dbg(&port->dev,
c89aa638 GKH	376	"CSIZE was not CS5-CS8, using default of 8\n");
b69c1499 AC	377	urb_value = BELKIN_SA_DATA_BITS(8);
b69c1499 AC	378	break;
1da177e4 LT	379	}
1da177e4 LT	380	if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
194343d9	381	dev_err(&port->dev, "Set data bits error\n");
1da177e4 LT	382	}
	383
	384	/* set the number of stop bits */
b69c1499 AC	385	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
	386	urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
	387	: BELKIN_SA_STOP_BITS(1);
	388	if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
	389	urb_value) < 0)
194343d9	390	dev_err(&port->dev, "Set stop bits error\n");
1da177e4 LT	391	}
	392
	393	/* Set flow control */
b69c1499 AC	394	if (((iflag ^ old_iflag) & (IXOFF \| IXON)) \|\|
b69c1499 AC	395	((cflag ^ old_cflag) & CRTSCTS)) {
1da177e4 LT	396	urb_value = 0;
	397	if ((iflag & IXOFF) \|\| (iflag & IXON))
	398	urb_value \|= (BELKIN_SA_FLOW_OXON \| BELKIN_SA_FLOW_IXON);
	399	else
	400	urb_value &= ~(BELKIN_SA_FLOW_OXON \| BELKIN_SA_FLOW_IXON);
	401
	402	if (cflag & CRTSCTS)
	403	urb_value \|= (BELKIN_SA_FLOW_OCTS \| BELKIN_SA_FLOW_IRTS);
	404	else
	405	urb_value &= ~(BELKIN_SA_FLOW_OCTS \| BELKIN_SA_FLOW_IRTS);
	406
	407	if (bad_flow_control)
	408	urb_value &= ~(BELKIN_SA_FLOW_IRTS);
	409
	410	if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
194343d9	411	dev_err(&port->dev, "Set flow control error\n");
1da177e4 LT	412	}
	413
	414	/* save off the modified port settings */
	415	spin_lock_irqsave(&priv->lock, flags);
	416	priv->control_state = control_state;
	417	spin_unlock_irqrestore(&priv->lock, flags);
726ef428	418	}
1da177e4	419
95da310e	420	static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
1da177e4	421	{
95da310e	422	struct usb_serial_port *port = tty->driver_data;
1da177e4 LT	423	struct usb_serial *serial = port->serial;
	424
	425	if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
194343d9	426	dev_err(&port->dev, "Set break_ctl %d\n", break_state);
1da177e4 LT	427	}
1da177e4 LT	428
60b33c13	429	static int belkin_sa_tiocmget(struct tty_struct *tty)
1da177e4	430	{
95da310e	431	struct usb_serial_port *port = tty->driver_data;
1da177e4 LT	432	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	433	unsigned long control_state;
	434	unsigned long flags;
b69c1499	435
1da177e4 LT	436	spin_lock_irqsave(&priv->lock, flags);
	437	control_state = priv->control_state;
	438	spin_unlock_irqrestore(&priv->lock, flags);
	439
	440	return control_state;
	441	}
	442
20b9d177	443	static int belkin_sa_tiocmset(struct tty_struct *tty,
1da177e4 LT	444	unsigned int set, unsigned int clear)
1da177e4 LT	445	{
95da310e	446	struct usb_serial_port *port = tty->driver_data;
1da177e4 LT	447	struct usb_serial *serial = port->serial;
	448	struct belkin_sa_private *priv = usb_get_serial_port_data(port);
	449	unsigned long control_state;
	450	unsigned long flags;
	451	int retval;
	452	int rts = 0;
	453	int dtr = 0;
b69c1499	454
1da177e4 LT	455	spin_lock_irqsave(&priv->lock, flags);
	456	control_state = priv->control_state;
	457
	458	if (set & TIOCM_RTS) {
	459	control_state \|= TIOCM_RTS;
	460	rts = 1;
	461	}
	462	if (set & TIOCM_DTR) {
	463	control_state \|= TIOCM_DTR;
	464	dtr = 1;
	465	}
	466	if (clear & TIOCM_RTS) {
	467	control_state &= ~TIOCM_RTS;
	468	rts = 0;
	469	}
	470	if (clear & TIOCM_DTR) {
	471	control_state &= ~TIOCM_DTR;
	472	dtr = 0;
	473	}
	474
	475	priv->control_state = control_state;
	476	spin_unlock_irqrestore(&priv->lock, flags);
	477
	478	retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
	479	if (retval < 0) {
194343d9	480	dev_err(&port->dev, "Set RTS error %d\n", retval);
1da177e4 LT	481	goto exit;
	482	}
	483
	484	retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
	485	if (retval < 0) {
194343d9	486	dev_err(&port->dev, "Set DTR error %d\n", retval);
1da177e4 LT	487	goto exit;
	488	}
	489	exit:
	490	return retval;
	491	}
	492
68e24113	493	module_usb_serial_driver(serial_drivers, id_table);
1da177e4	494
b69c1499 AC	495	MODULE_AUTHOR(DRIVER_AUTHOR);
b69c1499 AC	496	MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4	497	MODULE_LICENSE("GPL");