[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 contol 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/init.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"

/*
 * Version Information
 */
#define DRIVER_VERSION "v1.3"
#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_startup(struct usb_serial *serial);
static void belkin_sa_release(struct usb_serial *serial);
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,
	.attach =		belkin_sa_startup,
	.release =		belkin_sa_release,
};

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)

/* do some startup allocations not currently performed by usb_serial_probe() */
static int belkin_sa_startup(struct usb_serial *serial)
{
	struct usb_device *dev = serial->dev;
	struct belkin_sa_private *priv;

	/* allocate the private data structure */
	priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
	if (!priv)
		return -1; /* error */
	/* set initial values for control structures */
	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);

	init_waitqueue_head(&serial->port[0]->write_wait);
	usb_set_serial_port_data(serial->port[0], priv);

	return 0;
}

static void belkin_sa_release(struct usb_serial *serial)
{
	int i;

	for (i = 0; i < serial->num_ports; ++i)
		kfree(usb_get_serial_port_data(serial->port[i]));
}

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);
	struct tty_struct *tty;
	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;

	tty = tty_port_tty_get(&port->port);
	if (!tty)
		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(tty, 0, TTY_OVERRUN);
	}

	tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
							urb->actual_length);
	tty_flip_buffer_push(tty);
	tty_kref_put(tty);
}

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