[deliverable/linux.git] / drivers / usb / serial / belkin_sa.c

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