[deliverable/linux.git] / drivers / usb / serial / metro-usb.c

/*
  Some of this code is credited to Linux USB open source files that are
  distributed with Linux.

  Copyright:	2007 Metrologic Instruments. All rights reserved.
  Copyright:	2011 Azimut Ltd. <http://azimutrzn.ru/>
*/

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

#define DRIVER_DESC "Metrologic Instruments Inc. - USB-POS driver"

/* Product information. */
#define FOCUS_VENDOR_ID			0x0C2E
#define FOCUS_PRODUCT_ID_BI		0x0720
#define FOCUS_PRODUCT_ID_UNI		0x0700

#define METROUSB_SET_REQUEST_TYPE	0x40
#define METROUSB_SET_MODEM_CTRL_REQUEST	10
#define METROUSB_SET_BREAK_REQUEST	0x40
#define METROUSB_MCR_NONE		0x08	/* Deactivate DTR and RTS. */
#define METROUSB_MCR_RTS		0x0a	/* Activate RTS. */
#define METROUSB_MCR_DTR		0x09	/* Activate DTR. */
#define WDR_TIMEOUT			5000	/* default urb timeout. */

/* Private data structure. */
struct metrousb_private {
	spinlock_t lock;
	int throttled;
	unsigned long control_state;
};

/* Device table list. */
static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_BI) },
	{ USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_UNI) },
	{ }, /* Terminating entry. */
};
MODULE_DEVICE_TABLE(usb, id_table);

/* UNI-Directional mode commands for device configure */
#define UNI_CMD_OPEN	0x80
#define UNI_CMD_CLOSE	0xFF

static inline int metrousb_is_unidirectional_mode(struct usb_serial_port *port)
{
	__u16 product_id = le16_to_cpu(
		port->serial->dev->descriptor.idProduct);

	return product_id == FOCUS_PRODUCT_ID_UNI;
}

static int metrousb_send_unidirectional_cmd(u8 cmd, struct usb_serial_port *port)
{
	int ret;
	int actual_len;
	u8 *buffer_cmd = NULL;

	if (!metrousb_is_unidirectional_mode(port))
		return 0;

	buffer_cmd = kzalloc(sizeof(cmd), GFP_KERNEL);
	if (!buffer_cmd)
		return -ENOMEM;

	*buffer_cmd = cmd;

	ret = usb_interrupt_msg(port->serial->dev,
		usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
		buffer_cmd, sizeof(cmd),
		&actual_len, USB_CTRL_SET_TIMEOUT);

	kfree(buffer_cmd);

	if (ret < 0)
		return ret;
	else if (actual_len != sizeof(cmd))
		return -EIO;
	return 0;
}

static void metrousb_read_int_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned char *data = urb->transfer_buffer;
	int throttled = 0;
	int result = 0;
	unsigned long flags = 0;

	dev_dbg(&port->dev, "%s\n", __func__);

	switch (urb->status) {
	case 0:
		/* Success status, read from the port. */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* urb has been terminated. */
		dev_dbg(&port->dev,
			"%s - urb shutting down, error code=%d\n",
			__func__, urb->status);
		return;
	default:
		dev_dbg(&port->dev,
			"%s - non-zero urb received, error code=%d\n",
			__func__, urb->status);
		goto exit;
	}


	/* Set the data read from the usb port into the serial port buffer. */
	if (urb->actual_length) {
		/* Loop through the data copying each byte to the tty layer. */
		tty_insert_flip_string(&port->port, data, urb->actual_length);

		/* Force the data to the tty layer. */
		tty_flip_buffer_push(&port->port);
	}

	/* Set any port variables. */
	spin_lock_irqsave(&metro_priv->lock, flags);
	throttled = metro_priv->throttled;
	spin_unlock_irqrestore(&metro_priv->lock, flags);

	/* Continue trying to read if set. */
	if (!throttled) {
		usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
				 usb_rcvintpipe(port->serial->dev, port->interrupt_in_endpointAddress),
				 port->interrupt_in_urb->transfer_buffer,
				 port->interrupt_in_urb->transfer_buffer_length,
				 metrousb_read_int_callback, port, 1);

		result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);

		if (result)
			dev_err(&port->dev,
				"%s - failed submitting interrupt in urb, error code=%d\n",
				__func__, result);
	}
	return;

exit:
	/* Try to resubmit the urb. */
	result = usb_submit_urb(urb, GFP_ATOMIC);
	if (result)
		dev_err(&port->dev,
			"%s - failed submitting interrupt in urb, error code=%d\n",
			__func__, result);
}

static void metrousb_write_int_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;

	dev_warn(&port->dev, "%s not implemented yet.\n",
		__func__);
}

static void metrousb_cleanup(struct usb_serial_port *port)
{
	dev_dbg(&port->dev, "%s\n", __func__);

	usb_unlink_urb(port->interrupt_in_urb);
	usb_kill_urb(port->interrupt_in_urb);

	metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE, port);
}

static int metrousb_open(struct tty_struct *tty, struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned long flags = 0;
	int result = 0;

	dev_dbg(&port->dev, "%s\n", __func__);

	/* Make sure the urb is initialized. */
	if (!port->interrupt_in_urb) {
		dev_err(&port->dev, "%s - interrupt urb not initialized\n",
			__func__);
		return -ENODEV;
	}

	/* Set the private data information for the port. */
	spin_lock_irqsave(&metro_priv->lock, flags);
	metro_priv->control_state = 0;
	metro_priv->throttled = 0;
	spin_unlock_irqrestore(&metro_priv->lock, flags);

	/* Clear the urb pipe. */
	usb_clear_halt(serial->dev, port->interrupt_in_urb->pipe);

	/* Start reading from the device */
	usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
			  usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
			   port->interrupt_in_urb->transfer_buffer,
			   port->interrupt_in_urb->transfer_buffer_length,
			   metrousb_read_int_callback, port, 1);
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);

	if (result) {
		dev_err(&port->dev,
			"%s - failed submitting interrupt in urb, error code=%d\n",
			__func__, result);
		goto exit;
	}

	/* Send activate cmd to device */
	result = metrousb_send_unidirectional_cmd(UNI_CMD_OPEN, port);
	if (result) {
		dev_err(&port->dev,
			"%s - failed to configure device, error code=%d\n",
			__func__, result);
		goto exit;
	}

	dev_dbg(&port->dev, "%s - port open\n", __func__);
exit:
	return result;
}

static int metrousb_set_modem_ctrl(struct usb_serial *serial, unsigned int control_state)
{
	int retval = 0;
	unsigned char mcr = METROUSB_MCR_NONE;

	dev_dbg(&serial->dev->dev, "%s - control state = %d\n",
		__func__, control_state);

	/* Set the modem control value. */
	if (control_state & TIOCM_DTR)
		mcr |= METROUSB_MCR_DTR;
	if (control_state & TIOCM_RTS)
		mcr |= METROUSB_MCR_RTS;

	/* Send the command to the usb port. */
	retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
				METROUSB_SET_REQUEST_TYPE, METROUSB_SET_MODEM_CTRL_REQUEST,
				control_state, 0, NULL, 0, WDR_TIMEOUT);
	if (retval < 0)
		dev_err(&serial->dev->dev,
			"%s - set modem ctrl=0x%x failed, error code=%d\n",
			__func__, mcr, retval);

	return retval;
}

static int metrousb_port_probe(struct usb_serial_port *port)
{
	struct metrousb_private *metro_priv;

	metro_priv = kzalloc(sizeof(*metro_priv), GFP_KERNEL);
	if (!metro_priv)
		return -ENOMEM;

	spin_lock_init(&metro_priv->lock);

	usb_set_serial_port_data(port, metro_priv);

	return 0;
}

static int metrousb_port_remove(struct usb_serial_port *port)
{
	struct metrousb_private *metro_priv;

	metro_priv = usb_get_serial_port_data(port);
	kfree(metro_priv);

	return 0;
}

static void metrousb_throttle(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned long flags = 0;

	dev_dbg(tty->dev, "%s\n", __func__);

	/* Set the private information for the port to stop reading data. */
	spin_lock_irqsave(&metro_priv->lock, flags);
	metro_priv->throttled = 1;
	spin_unlock_irqrestore(&metro_priv->lock, flags);
}

static int metrousb_tiocmget(struct tty_struct *tty)
{
	unsigned long control_state = 0;
	struct usb_serial_port *port = tty->driver_data;
	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned long flags = 0;

	dev_dbg(tty->dev, "%s\n", __func__);

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

	return control_state;
}

static int metrousb_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 metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned long flags = 0;
	unsigned long control_state = 0;

	dev_dbg(tty->dev, "%s - set=%d, clear=%d\n", __func__, set, clear);

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

	/* Set the RTS and DTR values. */
	if (set & TIOCM_RTS)
		control_state |= TIOCM_RTS;
	if (set & TIOCM_DTR)
		control_state |= TIOCM_DTR;
	if (clear & TIOCM_RTS)
		control_state &= ~TIOCM_RTS;
	if (clear & TIOCM_DTR)
		control_state &= ~TIOCM_DTR;

	metro_priv->control_state = control_state;
	spin_unlock_irqrestore(&metro_priv->lock, flags);
	return metrousb_set_modem_ctrl(serial, control_state);
}

static void metrousb_unthrottle(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	unsigned long flags = 0;
	int result = 0;

	dev_dbg(tty->dev, "%s\n", __func__);

	/* Set the private information for the port to resume reading data. */
	spin_lock_irqsave(&metro_priv->lock, flags);
	metro_priv->throttled = 0;
	spin_unlock_irqrestore(&metro_priv->lock, flags);

	/* Submit the urb to read from the port. */
	port->interrupt_in_urb->dev = port->serial->dev;
	result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
	if (result)
		dev_err(tty->dev,
			"failed submitting interrupt in urb error code=%d\n",
			result);
}

static struct usb_serial_driver metrousb_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"metro-usb",
	},
	.description		= "Metrologic USB to Serial",
	.id_table		= id_table,
	.num_ports		= 1,
	.open			= metrousb_open,
	.close			= metrousb_cleanup,
	.read_int_callback	= metrousb_read_int_callback,
	.write_int_callback	= metrousb_write_int_callback,
	.port_probe		= metrousb_port_probe,
	.port_remove		= metrousb_port_remove,
	.throttle		= metrousb_throttle,
	.unthrottle		= metrousb_unthrottle,
	.tiocmget		= metrousb_tiocmget,
	.tiocmset		= metrousb_tiocmset,
};

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

module_usb_serial_driver(serial_drivers, id_table);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Philip Nicastro");
MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>");
MODULE_DESCRIPTION(DRIVER_DESC);
Commit	Line	Data
43d186fe	1	/*
d4cbd6e9 GKH	2	Some of this code is credited to Linux USB open source files that are
d4cbd6e9 GKH	3	distributed with Linux.
43d186fe AB	4
	5	Copyright: 2007 Metrologic Instruments. All rights reserved.
	6	Copyright: 2011 Azimut Ltd. <http://azimutrzn.ru/>
43d186fe AB	7	*/
	8
	9	#include <linux/kernel.h>
43d186fe AB	10	#include <linux/tty.h>
	11	#include <linux/module.h>
	12	#include <linux/usb.h>
	13	#include <linux/errno.h>
	14	#include <linux/slab.h>
	15	#include <linux/tty_driver.h>
	16	#include <linux/tty_flip.h>
	17	#include <linux/moduleparam.h>
	18	#include <linux/spinlock.h>
d4cbd6e9	19	#include <linux/uaccess.h>
43d186fe AB	20	#include <linux/usb/serial.h>
43d186fe AB	21
43d186fe AB	22	#define DRIVER_DESC "Metrologic Instruments Inc. - USB-POS driver"
43d186fe AB	23
159d4d8d GKH	24	/* Product information. */
159d4d8d GKH	25	#define FOCUS_VENDOR_ID 0x0C2E
810ec78e AB	26	#define FOCUS_PRODUCT_ID_BI 0x0720
810ec78e AB	27	#define FOCUS_PRODUCT_ID_UNI 0x0700
159d4d8d GKH	28
	29	#define METROUSB_SET_REQUEST_TYPE 0x40
	30	#define METROUSB_SET_MODEM_CTRL_REQUEST 10
	31	#define METROUSB_SET_BREAK_REQUEST 0x40
	32	#define METROUSB_MCR_NONE 0x08 /* Deactivate DTR and RTS. */
	33	#define METROUSB_MCR_RTS 0x0a /* Activate RTS. */
	34	#define METROUSB_MCR_DTR 0x09 /* Activate DTR. */
d4cbd6e9	35	#define WDR_TIMEOUT 5000 /* default urb timeout. */
159d4d8d GKH	36
	37	/* Private data structure. */
	38	struct metrousb_private {
	39	spinlock_t lock;
	40	int throttled;
	41	unsigned long control_state;
	42	};
	43
43d186fe	44	/* Device table list. */
5c6b98dd	45	static const struct usb_device_id id_table[] = {
810ec78e	46	{ USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_BI) },
43d186fe	47	{ USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_UNI) },
43d186fe AB	48	{ }, /* Terminating entry. */
	49	};
	50	MODULE_DEVICE_TABLE(usb, id_table);
	51
70457786 AB	52	/* UNI-Directional mode commands for device configure */
	53	#define UNI_CMD_OPEN 0x80
	54	#define UNI_CMD_CLOSE 0xFF
	55
8f24c490	56	static inline int metrousb_is_unidirectional_mode(struct usb_serial_port *port)
70457786 AB	57	{
	58	__u16 product_id = le16_to_cpu(
	59	port->serial->dev->descriptor.idProduct);
	60
	61	return product_id == FOCUS_PRODUCT_ID_UNI;
	62	}
	63
	64	static int metrousb_send_unidirectional_cmd(u8 cmd, struct usb_serial_port *port)
	65	{
	66	int ret;
	67	int actual_len;
	68	u8 *buffer_cmd = NULL;
	69
	70	if (!metrousb_is_unidirectional_mode(port))
	71	return 0;
	72
	73	buffer_cmd = kzalloc(sizeof(cmd), GFP_KERNEL);
	74	if (!buffer_cmd)
	75	return -ENOMEM;
	76
	77	*buffer_cmd = cmd;
	78
	79	ret = usb_interrupt_msg(port->serial->dev,
	80	usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
	81	buffer_cmd, sizeof(cmd),
	82	&actual_len, USB_CTRL_SET_TIMEOUT);
	83
	84	kfree(buffer_cmd);
	85
	86	if (ret < 0)
	87	return ret;
	88	else if (actual_len != sizeof(cmd))
	89	return -EIO;
	90	return 0;
	91	}
	92
9fbd1649	93	static void metrousb_read_int_callback(struct urb *urb)
43d186fe	94	{
8111e4ec	95	struct usb_serial_port *port = urb->context;
9fbd1649	96	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
9fbd1649 GKH	97	unsigned char *data = urb->transfer_buffer;
	98	int throttled = 0;
	99	int result = 0;
	100	unsigned long flags = 0;
	101
5db51b50	102	dev_dbg(&port->dev, "%s\n", __func__);
43d186fe	103
9fbd1649 GKH	104	switch (urb->status) {
	105	case 0:
	106	/* Success status, read from the port. */
	107	break;
	108	case -ECONNRESET:
	109	case -ENOENT:
	110	case -ESHUTDOWN:
	111	/* urb has been terminated. */
5db51b50 GKH	112	dev_dbg(&port->dev,
5db51b50 GKH	113	"%s - urb shutting down, error code=%d\n",
bd2c09bc	114	__func__, urb->status);
9fbd1649 GKH	115	return;
9fbd1649 GKH	116	default:
5db51b50 GKH	117	dev_dbg(&port->dev,
5db51b50 GKH	118	"%s - non-zero urb received, error code=%d\n",
bd2c09bc	119	__func__, urb->status);
9fbd1649 GKH	120	goto exit;
	121	}
	122
	123
	124	/* Set the data read from the usb port into the serial port buffer. */
2e124b4a	125	if (urb->actual_length) {
9fbd1649	126	/* Loop through the data copying each byte to the tty layer. */
05c7cd39	127	tty_insert_flip_string(&port->port, data, urb->actual_length);
9fbd1649 GKH	128
9fbd1649 GKH	129	/* Force the data to the tty layer. */
2e124b4a	130	tty_flip_buffer_push(&port->port);
9fbd1649	131	}
9fbd1649 GKH	132
	133	/* Set any port variables. */
	134	spin_lock_irqsave(&metro_priv->lock, flags);
	135	throttled = metro_priv->throttled;
	136	spin_unlock_irqrestore(&metro_priv->lock, flags);
	137
	138	/* Continue trying to read if set. */
	139	if (!throttled) {
	140	usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
	141	usb_rcvintpipe(port->serial->dev, port->interrupt_in_endpointAddress),
	142	port->interrupt_in_urb->transfer_buffer,
	143	port->interrupt_in_urb->transfer_buffer_length,
	144	metrousb_read_int_callback, port, 1);
	145
	146	result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
	147
5db51b50	148	if (result)
91fbecfe	149	dev_err(&port->dev,
5db51b50 GKH	150	"%s - failed submitting interrupt in urb, error code=%d\n",
5db51b50 GKH	151	__func__, result);
43d186fe	152	}
9fbd1649 GKH	153	return;
	154
	155	exit:
	156	/* Try to resubmit the urb. */
	157	result = usb_submit_urb(urb, GFP_ATOMIC);
5db51b50	158	if (result)
91fbecfe	159	dev_err(&port->dev,
5db51b50 GKH	160	"%s - failed submitting interrupt in urb, error code=%d\n",
5db51b50 GKH	161	__func__, result);
43d186fe AB	162	}
43d186fe AB	163
28a4b6a6 AB	164	static void metrousb_write_int_callback(struct urb *urb)
	165	{
	166	struct usb_serial_port *port = urb->context;
	167
	168	dev_warn(&port->dev, "%s not implemented yet.\n",
	169	__func__);
	170	}
	171
9fbd1649	172	static void metrousb_cleanup(struct usb_serial_port *port)
43d186fe	173	{
5db51b50	174	dev_dbg(&port->dev, "%s\n", __func__);
9fbd1649	175
2ee44fbe JH	176	usb_unlink_urb(port->interrupt_in_urb);
	177	usb_kill_urb(port->interrupt_in_urb);
	178
5813f281	179	metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE, port);
43d186fe AB	180	}
43d186fe AB	181
d4cbd6e9	182	static int metrousb_open(struct tty_struct tty, struct usb_serial_port port)
43d186fe AB	183	{
	184	struct usb_serial *serial = port->serial;
	185	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	186	unsigned long flags = 0;
	187	int result = 0;
	188
5db51b50	189	dev_dbg(&port->dev, "%s\n", __func__);
43d186fe AB	190
	191	/* Make sure the urb is initialized. */
	192	if (!port->interrupt_in_urb) {
91fbecfe	193	dev_err(&port->dev, "%s - interrupt urb not initialized\n",
5db51b50	194	__func__);
43d186fe AB	195	return -ENODEV;
	196	}
	197
	198	/* Set the private data information for the port. */
	199	spin_lock_irqsave(&metro_priv->lock, flags);
	200	metro_priv->control_state = 0;
	201	metro_priv->throttled = 0;
	202	spin_unlock_irqrestore(&metro_priv->lock, flags);
	203
43d186fe AB	204	/* Clear the urb pipe. */
	205	usb_clear_halt(serial->dev, port->interrupt_in_urb->pipe);
	206
	207	/* Start reading from the device */
d4cbd6e9 GKH	208	usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
d4cbd6e9 GKH	209	usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
43d186fe AB	210	port->interrupt_in_urb->transfer_buffer,
	211	port->interrupt_in_urb->transfer_buffer_length,
	212	metrousb_read_int_callback, port, 1);
	213	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
	214
	215	if (result) {
91fbecfe	216	dev_err(&port->dev,
5db51b50 GKH	217	"%s - failed submitting interrupt in urb, error code=%d\n",
5db51b50 GKH	218	__func__, result);
43d186fe AB	219	goto exit;
	220	}
	221
70457786 AB	222	/* Send activate cmd to device */
	223	result = metrousb_send_unidirectional_cmd(UNI_CMD_OPEN, port);
	224	if (result) {
	225	dev_err(&port->dev,
1143832e GKH	226	"%s - failed to configure device, error code=%d\n",
1143832e GKH	227	__func__, result);
70457786 AB	228	goto exit;
	229	}
	230
5db51b50	231	dev_dbg(&port->dev, "%s - port open\n", __func__);
43d186fe AB	232	exit:
	233	return result;
	234	}
	235
43d186fe AB	236	static int metrousb_set_modem_ctrl(struct usb_serial *serial, unsigned int control_state)
	237	{
	238	int retval = 0;
	239	unsigned char mcr = METROUSB_MCR_NONE;
	240
5db51b50 GKH	241	dev_dbg(&serial->dev->dev, "%s - control state = %d\n",
5db51b50 GKH	242	__func__, control_state);
43d186fe AB	243
	244	/* Set the modem control value. */
	245	if (control_state & TIOCM_DTR)
	246	mcr \|= METROUSB_MCR_DTR;
	247	if (control_state & TIOCM_RTS)
	248	mcr \|= METROUSB_MCR_RTS;
	249
	250	/* Send the command to the usb port. */
	251	retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
	252	METROUSB_SET_REQUEST_TYPE, METROUSB_SET_MODEM_CTRL_REQUEST,
	253	control_state, 0, NULL, 0, WDR_TIMEOUT);
	254	if (retval < 0)
91fbecfe	255	dev_err(&serial->dev->dev,
5db51b50 GKH	256	"%s - set modem ctrl=0x%x failed, error code=%d\n",
5db51b50 GKH	257	__func__, mcr, retval);
43d186fe AB	258
	259	return retval;
	260	}
	261
50dde868	262	static int metrousb_port_probe(struct usb_serial_port *port)
43d186fe	263	{
50dde868	264	struct metrousb_private *metro_priv;
43d186fe	265
50dde868 JH	266	metro_priv = kzalloc(sizeof(*metro_priv), GFP_KERNEL);
	267	if (!metro_priv)
	268	return -ENOMEM;
43d186fe	269
50dde868	270	spin_lock_init(&metro_priv->lock);
43d186fe	271
50dde868	272	usb_set_serial_port_data(port, metro_priv);
43d186fe	273
50dde868	274	return 0;
43d186fe AB	275	}
43d186fe AB	276
50dde868	277	static int metrousb_port_remove(struct usb_serial_port *port)
43d186fe AB	278	{
43d186fe AB	279	struct metrousb_private *metro_priv;
43d186fe	280
50dde868 JH	281	metro_priv = usb_get_serial_port_data(port);
50dde868 JH	282	kfree(metro_priv);
43d186fe AB	283
	284	return 0;
	285	}
	286
d4cbd6e9	287	static void metrousb_throttle(struct tty_struct *tty)
43d186fe AB	288	{
	289	struct usb_serial_port *port = tty->driver_data;
	290	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	291	unsigned long flags = 0;
	292
5db51b50	293	dev_dbg(tty->dev, "%s\n", __func__);
43d186fe AB	294
	295	/* Set the private information for the port to stop reading data. */
	296	spin_lock_irqsave(&metro_priv->lock, flags);
	297	metro_priv->throttled = 1;
	298	spin_unlock_irqrestore(&metro_priv->lock, flags);
	299	}
	300
d4cbd6e9	301	static int metrousb_tiocmget(struct tty_struct *tty)
43d186fe AB	302	{
	303	unsigned long control_state = 0;
	304	struct usb_serial_port *port = tty->driver_data;
	305	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	306	unsigned long flags = 0;
	307
5db51b50	308	dev_dbg(tty->dev, "%s\n", __func__);
43d186fe AB	309
	310	spin_lock_irqsave(&metro_priv->lock, flags);
	311	control_state = metro_priv->control_state;
	312	spin_unlock_irqrestore(&metro_priv->lock, flags);
	313
	314	return control_state;
	315	}
	316
d4cbd6e9 GKH	317	static int metrousb_tiocmset(struct tty_struct *tty,
d4cbd6e9 GKH	318	unsigned int set, unsigned int clear)
43d186fe AB	319	{
	320	struct usb_serial_port *port = tty->driver_data;
	321	struct usb_serial *serial = port->serial;
	322	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	323	unsigned long flags = 0;
	324	unsigned long control_state = 0;
	325
5db51b50	326	dev_dbg(tty->dev, "%s - set=%d, clear=%d\n", __func__, set, clear);
43d186fe AB	327
	328	spin_lock_irqsave(&metro_priv->lock, flags);
	329	control_state = metro_priv->control_state;
	330
d4cbd6e9	331	/* Set the RTS and DTR values. */
43d186fe AB	332	if (set & TIOCM_RTS)
	333	control_state \|= TIOCM_RTS;
	334	if (set & TIOCM_DTR)
	335	control_state \|= TIOCM_DTR;
	336	if (clear & TIOCM_RTS)
	337	control_state &= ~TIOCM_RTS;
	338	if (clear & TIOCM_DTR)
	339	control_state &= ~TIOCM_DTR;
	340
	341	metro_priv->control_state = control_state;
	342	spin_unlock_irqrestore(&metro_priv->lock, flags);
	343	return metrousb_set_modem_ctrl(serial, control_state);
	344	}
	345
d4cbd6e9	346	static void metrousb_unthrottle(struct tty_struct *tty)
43d186fe AB	347	{
	348	struct usb_serial_port *port = tty->driver_data;
	349	struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
	350	unsigned long flags = 0;
	351	int result = 0;
	352
5db51b50	353	dev_dbg(tty->dev, "%s\n", __func__);
43d186fe AB	354
	355	/* Set the private information for the port to resume reading data. */
	356	spin_lock_irqsave(&metro_priv->lock, flags);
	357	metro_priv->throttled = 0;
	358	spin_unlock_irqrestore(&metro_priv->lock, flags);
	359
	360	/* Submit the urb to read from the port. */
	361	port->interrupt_in_urb->dev = port->serial->dev;
	362	result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
5db51b50	363	if (result)
91fbecfe	364	dev_err(tty->dev,
5db51b50 GKH	365	"failed submitting interrupt in urb error code=%d\n",
5db51b50 GKH	366	result);
43d186fe AB	367	}
43d186fe AB	368
9fbd1649 GKH	369	static struct usb_serial_driver metrousb_device = {
	370	.driver = {
	371	.owner = THIS_MODULE,
	372	.name = "metro-usb",
	373	},
e2dd3af4	374	.description = "Metrologic USB to Serial",
9fbd1649 GKH	375	.id_table = id_table,
	376	.num_ports = 1,
	377	.open = metrousb_open,
	378	.close = metrousb_cleanup,
	379	.read_int_callback = metrousb_read_int_callback,
28a4b6a6	380	.write_int_callback = metrousb_write_int_callback,
50dde868 JH	381	.port_probe = metrousb_port_probe,
50dde868 JH	382	.port_remove = metrousb_port_remove,
9fbd1649 GKH	383	.throttle = metrousb_throttle,
	384	.unthrottle = metrousb_unthrottle,
	385	.tiocmget = metrousb_tiocmget,
	386	.tiocmset = metrousb_tiocmset,
	387	};
	388
	389	static struct usb_serial_driver * const serial_drivers[] = {
	390	&metrousb_device,
	391	NULL,
	392	};
	393
68e24113	394	module_usb_serial_driver(serial_drivers, id_table);
1935e357	395
43d186fe	396	MODULE_LICENSE("GPL");
d4cbd6e9 GKH	397	MODULE_AUTHOR("Philip Nicastro");
	398	MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>");
	399	MODULE_DESCRIPTION(DRIVER_DESC);