Linux Audio

Check our new training course

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