[GitHub/mt8127/android_kernel_alcatel_ttab.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"

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