File Index
Files and directories
Sign in
FILE

digi_acceleport.c

File preview with syntax highlighting.

linux-6.19.14/drivers/usb/serial/digi_acceleport.c C
   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3*  Digi AccelePort USB-4 and USB-2 Serial Converters
   4*
   5*  Copyright 2000 by Digi International
   6*
   7*  Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
   8*  usb-serial driver.
   9*
  10*  Peter Berger (pberger@brimson.com)
  11*  Al Borchers (borchers@steinerpoint.com)
  12*/
  13
  14#include <linux/kernel.h>
  15#include <linux/errno.h>
  16#include <linux/slab.h>
  17#include <linux/tty.h>
  18#include <linux/tty_driver.h>
  19#include <linux/tty_flip.h>
  20#include <linux/module.h>
  21#include <linux/spinlock.h>
  22#include <linux/uaccess.h>
  23#include <linux/usb.h>
  24#include <linux/wait.h>
  25#include <linux/sched/signal.h>
  26#include <linux/usb/serial.h>
  27
  28/* Defines */
  29
  30#define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
  31#define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
  32
  33/* port output buffer length -- must be <= transfer buffer length - 2 */
  34/* so we can be sure to send the full buffer in one urb */
  35#define DIGI_OUT_BUF_SIZE		8
  36
  37/* port input buffer length -- must be >= transfer buffer length - 3 */
  38/* so we can be sure to hold at least one full buffer from one urb */
  39#define DIGI_IN_BUF_SIZE		64
  40
  41/* retry timeout while sleeping */
  42#define DIGI_RETRY_TIMEOUT		(HZ/10)
  43
  44/* timeout while waiting for tty output to drain in close */
  45/* this delay is used twice in close, so the total delay could */
  46/* be twice this value */
  47#define DIGI_CLOSE_TIMEOUT		(5*HZ)
  48
  49
  50/* AccelePort USB Defines */
  51
  52/* ids */
  53#define DIGI_VENDOR_ID			0x05c5
  54#define DIGI_2_ID			0x0002	/* USB-2 */
  55#define DIGI_4_ID			0x0004	/* USB-4 */
  56
  57/* commands
  58 * "INB": can be used on the in-band endpoint
  59 * "OOB": can be used on the out-of-band endpoint
  60 */
  61#define DIGI_CMD_SET_BAUD_RATE			0	/* INB, OOB */
  62#define DIGI_CMD_SET_WORD_SIZE			1	/* INB, OOB */
  63#define DIGI_CMD_SET_PARITY			2	/* INB, OOB */
  64#define DIGI_CMD_SET_STOP_BITS			3	/* INB, OOB */
  65#define DIGI_CMD_SET_INPUT_FLOW_CONTROL		4	/* INB, OOB */
  66#define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL	5	/* INB, OOB */
  67#define DIGI_CMD_SET_DTR_SIGNAL			6	/* INB, OOB */
  68#define DIGI_CMD_SET_RTS_SIGNAL			7	/* INB, OOB */
  69#define DIGI_CMD_READ_INPUT_SIGNALS		8	/*      OOB */
  70#define DIGI_CMD_IFLUSH_FIFO			9	/*      OOB */
  71#define DIGI_CMD_RECEIVE_ENABLE			10	/* INB, OOB */
  72#define DIGI_CMD_BREAK_CONTROL			11	/* INB, OOB */
  73#define DIGI_CMD_LOCAL_LOOPBACK			12	/* INB, OOB */
  74#define DIGI_CMD_TRANSMIT_IDLE			13	/* INB, OOB */
  75#define DIGI_CMD_READ_UART_REGISTER		14	/*      OOB */
  76#define DIGI_CMD_WRITE_UART_REGISTER		15	/* INB, OOB */
  77#define DIGI_CMD_AND_UART_REGISTER		16	/* INB, OOB */
  78#define DIGI_CMD_OR_UART_REGISTER		17	/* INB, OOB */
  79#define DIGI_CMD_SEND_DATA			18	/* INB      */
  80#define DIGI_CMD_RECEIVE_DATA			19	/* INB      */
  81#define DIGI_CMD_RECEIVE_DISABLE		20	/* INB      */
  82#define DIGI_CMD_GET_PORT_TYPE			21	/*      OOB */
  83
  84/* baud rates */
  85#define DIGI_BAUD_50				0
  86#define DIGI_BAUD_75				1
  87#define DIGI_BAUD_110				2
  88#define DIGI_BAUD_150				3
  89#define DIGI_BAUD_200				4
  90#define DIGI_BAUD_300				5
  91#define DIGI_BAUD_600				6
  92#define DIGI_BAUD_1200				7
  93#define DIGI_BAUD_1800				8
  94#define DIGI_BAUD_2400				9
  95#define DIGI_BAUD_4800				10
  96#define DIGI_BAUD_7200				11
  97#define DIGI_BAUD_9600				12
  98#define DIGI_BAUD_14400				13
  99#define DIGI_BAUD_19200				14
 100#define DIGI_BAUD_28800				15
 101#define DIGI_BAUD_38400				16
 102#define DIGI_BAUD_57600				17
 103#define DIGI_BAUD_76800				18
 104#define DIGI_BAUD_115200			19
 105#define DIGI_BAUD_153600			20
 106#define DIGI_BAUD_230400			21
 107#define DIGI_BAUD_460800			22
 108
 109/* arguments */
 110#define DIGI_WORD_SIZE_5			0
 111#define DIGI_WORD_SIZE_6			1
 112#define DIGI_WORD_SIZE_7			2
 113#define DIGI_WORD_SIZE_8			3
 114
 115#define DIGI_PARITY_NONE			0
 116#define DIGI_PARITY_ODD				1
 117#define DIGI_PARITY_EVEN			2
 118#define DIGI_PARITY_MARK			3
 119#define DIGI_PARITY_SPACE			4
 120
 121#define DIGI_STOP_BITS_1			0
 122#define DIGI_STOP_BITS_2			1
 123
 124#define DIGI_INPUT_FLOW_CONTROL_XON_XOFF	1
 125#define DIGI_INPUT_FLOW_CONTROL_RTS		2
 126#define DIGI_INPUT_FLOW_CONTROL_DTR		4
 127
 128#define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF	1
 129#define DIGI_OUTPUT_FLOW_CONTROL_CTS		2
 130#define DIGI_OUTPUT_FLOW_CONTROL_DSR		4
 131
 132#define DIGI_DTR_INACTIVE			0
 133#define DIGI_DTR_ACTIVE				1
 134#define DIGI_DTR_INPUT_FLOW_CONTROL		2
 135
 136#define DIGI_RTS_INACTIVE			0
 137#define DIGI_RTS_ACTIVE				1
 138#define DIGI_RTS_INPUT_FLOW_CONTROL		2
 139#define DIGI_RTS_TOGGLE				3
 140
 141#define DIGI_FLUSH_TX				1
 142#define DIGI_FLUSH_RX				2
 143#define DIGI_RESUME_TX				4 /* clears xoff condition */
 144
 145#define DIGI_TRANSMIT_NOT_IDLE			0
 146#define DIGI_TRANSMIT_IDLE			1
 147
 148#define DIGI_DISABLE				0
 149#define DIGI_ENABLE				1
 150
 151#define DIGI_DEASSERT				0
 152#define DIGI_ASSERT				1
 153
 154/* in band status codes */
 155#define DIGI_OVERRUN_ERROR			4
 156#define DIGI_PARITY_ERROR			8
 157#define DIGI_FRAMING_ERROR			16
 158#define DIGI_BREAK_ERROR			32
 159
 160/* out of band status */
 161#define DIGI_NO_ERROR				0
 162#define DIGI_BAD_FIRST_PARAMETER		1
 163#define DIGI_BAD_SECOND_PARAMETER		2
 164#define DIGI_INVALID_LINE			3
 165#define DIGI_INVALID_OPCODE			4
 166
 167/* input signals */
 168#define DIGI_READ_INPUT_SIGNALS_SLOT		1
 169#define DIGI_READ_INPUT_SIGNALS_ERR		2
 170#define DIGI_READ_INPUT_SIGNALS_BUSY		4
 171#define DIGI_READ_INPUT_SIGNALS_PE		8
 172#define DIGI_READ_INPUT_SIGNALS_CTS		16
 173#define DIGI_READ_INPUT_SIGNALS_DSR		32
 174#define DIGI_READ_INPUT_SIGNALS_RI		64
 175#define DIGI_READ_INPUT_SIGNALS_DCD		128
 176
 177
 178/* Structures */
 179
 180struct digi_serial {
 181	spinlock_t ds_serial_lock;
 182	struct usb_serial_port *ds_oob_port;	/* out-of-band port */
 183	int ds_oob_port_num;			/* index of out-of-band port */
 184	int ds_device_started;
 185};
 186
 187struct digi_port {
 188	spinlock_t dp_port_lock;
 189	int dp_port_num;
 190	int dp_out_buf_len;
 191	unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
 192	int dp_write_urb_in_use;
 193	unsigned int dp_modem_signals;
 194	int dp_transmit_idle;
 195	wait_queue_head_t dp_transmit_idle_wait;
 196	int dp_throttled;
 197	int dp_throttle_restart;
 198	wait_queue_head_t dp_flush_wait;
 199	wait_queue_head_t dp_close_wait;	/* wait queue for close */
 200	wait_queue_head_t write_wait;
 201	struct usb_serial_port *dp_port;
 202};
 203
 204
 205/* Local Function Declarations */
 206
 207static int digi_write_oob_command(struct usb_serial_port *port,
 208	unsigned char *buf, int count, int interruptible);
 209static int digi_write_inb_command(struct usb_serial_port *port,
 210	unsigned char *buf, int count, unsigned long timeout);
 211static int digi_set_modem_signals(struct usb_serial_port *port,
 212	unsigned int modem_signals, int interruptible);
 213static int digi_transmit_idle(struct usb_serial_port *port,
 214	unsigned long timeout);
 215static void digi_rx_throttle(struct tty_struct *tty);
 216static void digi_rx_unthrottle(struct tty_struct *tty);
 217static void digi_set_termios(struct tty_struct *tty,
 218			     struct usb_serial_port *port,
 219			     const struct ktermios *old_termios);
 220static int digi_break_ctl(struct tty_struct *tty, int break_state);
 221static int digi_tiocmget(struct tty_struct *tty);
 222static int digi_tiocmset(struct tty_struct *tty, unsigned int set,
 223		unsigned int clear);
 224static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
 225		const unsigned char *buf, int count);
 226static void digi_write_bulk_callback(struct urb *urb);
 227static unsigned int digi_write_room(struct tty_struct *tty);
 228static unsigned int digi_chars_in_buffer(struct tty_struct *tty);
 229static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
 230static void digi_close(struct usb_serial_port *port);
 231static void digi_dtr_rts(struct usb_serial_port *port, int on);
 232static int digi_startup_device(struct usb_serial *serial);
 233static int digi_startup(struct usb_serial *serial);
 234static void digi_disconnect(struct usb_serial *serial);
 235static void digi_release(struct usb_serial *serial);
 236static int digi_port_probe(struct usb_serial_port *port);
 237static void digi_port_remove(struct usb_serial_port *port);
 238static void digi_read_bulk_callback(struct urb *urb);
 239static int digi_read_inb_callback(struct urb *urb);
 240static int digi_read_oob_callback(struct urb *urb);
 241
 242
 243static const struct usb_device_id id_table_combined[] = {
 244	{ USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 245	{ USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 246	{ }						/* Terminating entry */
 247};
 248
 249static const struct usb_device_id id_table_2[] = {
 250	{ USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 251	{ }						/* Terminating entry */
 252};
 253
 254static const struct usb_device_id id_table_4[] = {
 255	{ USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 256	{ }						/* Terminating entry */
 257};
 258
 259MODULE_DEVICE_TABLE(usb, id_table_combined);
 260
 261/* device info needed for the Digi serial converter */
 262
 263static struct usb_serial_driver digi_acceleport_2_device = {
 264	.driver = {
 265		.name =			"digi_2",
 266	},
 267	.description =			"Digi 2 port USB adapter",
 268	.id_table =			id_table_2,
 269	.num_ports =			3,
 270	.num_bulk_in =			4,
 271	.num_bulk_out =			4,
 272	.open =				digi_open,
 273	.close =			digi_close,
 274	.dtr_rts =			digi_dtr_rts,
 275	.write =			digi_write,
 276	.write_room =			digi_write_room,
 277	.write_bulk_callback = 		digi_write_bulk_callback,
 278	.read_bulk_callback =		digi_read_bulk_callback,
 279	.chars_in_buffer =		digi_chars_in_buffer,
 280	.throttle =			digi_rx_throttle,
 281	.unthrottle =			digi_rx_unthrottle,
 282	.set_termios =			digi_set_termios,
 283	.break_ctl =			digi_break_ctl,
 284	.tiocmget =			digi_tiocmget,
 285	.tiocmset =			digi_tiocmset,
 286	.attach =			digi_startup,
 287	.disconnect =			digi_disconnect,
 288	.release =			digi_release,
 289	.port_probe =			digi_port_probe,
 290	.port_remove =			digi_port_remove,
 291};
 292
 293static struct usb_serial_driver digi_acceleport_4_device = {
 294	.driver = {
 295		.name =			"digi_4",
 296	},
 297	.description =			"Digi 4 port USB adapter",
 298	.id_table =			id_table_4,
 299	.num_ports =			4,
 300	.num_bulk_in =			5,
 301	.num_bulk_out =			5,
 302	.open =				digi_open,
 303	.close =			digi_close,
 304	.write =			digi_write,
 305	.write_room =			digi_write_room,
 306	.write_bulk_callback = 		digi_write_bulk_callback,
 307	.read_bulk_callback =		digi_read_bulk_callback,
 308	.chars_in_buffer =		digi_chars_in_buffer,
 309	.throttle =			digi_rx_throttle,
 310	.unthrottle =			digi_rx_unthrottle,
 311	.set_termios =			digi_set_termios,
 312	.break_ctl =			digi_break_ctl,
 313	.tiocmget =			digi_tiocmget,
 314	.tiocmset =			digi_tiocmset,
 315	.attach =			digi_startup,
 316	.disconnect =			digi_disconnect,
 317	.release =			digi_release,
 318	.port_probe =			digi_port_probe,
 319	.port_remove =			digi_port_remove,
 320};
 321
 322static struct usb_serial_driver * const serial_drivers[] = {
 323	&digi_acceleport_2_device, &digi_acceleport_4_device, NULL
 324};
 325
 326/* Functions */
 327
 328/*
 329 *  Cond Wait Interruptible Timeout Irqrestore
 330 *
 331 *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
 332 *  so that wake ups are not lost if they occur between the unlock
 333 *  and the sleep.  In other words, spin_unlock_irqrestore and
 334 *  interruptible_sleep_on_timeout are "atomic" with respect to
 335 *  wake ups.  This is used to implement condition variables.
 336 *
 337 *  interruptible_sleep_on_timeout is deprecated and has been replaced
 338 *  with the equivalent code.
 339 */
 340
 341static long cond_wait_interruptible_timeout_irqrestore(
 342	wait_queue_head_t *q, long timeout,
 343	spinlock_t *lock, unsigned long flags)
 344__releases(lock)
 345{
 346	DEFINE_WAIT(wait);
 347
 348	prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
 349	spin_unlock_irqrestore(lock, flags);
 350	timeout = schedule_timeout(timeout);
 351	finish_wait(q, &wait);
 352
 353	return timeout;
 354}
 355
 356/*
 357 *  Digi Write OOB Command
 358 *
 359 *  Write commands on the out of band port.  Commands are 4
 360 *  bytes each, multiple commands can be sent at once, and
 361 *  no command will be split across USB packets.  Returns 0
 362 *  if successful, -EINTR if interrupted while sleeping and
 363 *  the interruptible flag is true, or a negative error
 364 *  returned by usb_submit_urb.
 365 */
 366
 367static int digi_write_oob_command(struct usb_serial_port *port,
 368	unsigned char *buf, int count, int interruptible)
 369{
 370	int ret = 0;
 371	int len;
 372	struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 373	struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 374	unsigned long flags;
 375
 376	dev_dbg(&port->dev,
 377		"digi_write_oob_command: TOP: port=%d, count=%d\n",
 378		oob_priv->dp_port_num, count);
 379
 380	spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 381	while (count > 0) {
 382		while (oob_priv->dp_write_urb_in_use) {
 383			cond_wait_interruptible_timeout_irqrestore(
 384				&oob_priv->write_wait, DIGI_RETRY_TIMEOUT,
 385				&oob_priv->dp_port_lock, flags);
 386			if (interruptible && signal_pending(current))
 387				return -EINTR;
 388			spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 389		}
 390
 391		/* len must be a multiple of 4, so commands are not split */
 392		len = min(count, oob_port->bulk_out_size);
 393		if (len > 4)
 394			len &= ~3;
 395		memcpy(oob_port->write_urb->transfer_buffer, buf, len);
 396		oob_port->write_urb->transfer_buffer_length = len;
 397		ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 398		if (ret == 0) {
 399			oob_priv->dp_write_urb_in_use = 1;
 400			count -= len;
 401			buf += len;
 402		}
 403	}
 404	spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 405	if (ret)
 406		dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 407			__func__, ret);
 408	return ret;
 409
 410}
 411
 412
 413/*
 414 *  Digi Write In Band Command
 415 *
 416 *  Write commands on the given port.  Commands are 4
 417 *  bytes each, multiple commands can be sent at once, and
 418 *  no command will be split across USB packets.  If timeout
 419 *  is non-zero, write in band command will return after
 420 *  waiting unsuccessfully for the URB status to clear for
 421 *  timeout ticks.  Returns 0 if successful, or a negative
 422 *  error returned by digi_write.
 423 */
 424
 425static int digi_write_inb_command(struct usb_serial_port *port,
 426	unsigned char *buf, int count, unsigned long timeout)
 427{
 428	int ret = 0;
 429	int len;
 430	struct digi_port *priv = usb_get_serial_port_data(port);
 431	unsigned char *data = port->write_urb->transfer_buffer;
 432	unsigned long flags;
 433
 434	dev_dbg(&port->dev, "digi_write_inb_command: TOP: port=%d, count=%d\n",
 435		priv->dp_port_num, count);
 436
 437	if (timeout)
 438		timeout += jiffies;
 439	else
 440		timeout = ULONG_MAX;
 441
 442	spin_lock_irqsave(&priv->dp_port_lock, flags);
 443	while (count > 0 && ret == 0) {
 444		while (priv->dp_write_urb_in_use &&
 445		       time_before(jiffies, timeout)) {
 446			cond_wait_interruptible_timeout_irqrestore(
 447				&priv->write_wait, DIGI_RETRY_TIMEOUT,
 448				&priv->dp_port_lock, flags);
 449			if (signal_pending(current))
 450				return -EINTR;
 451			spin_lock_irqsave(&priv->dp_port_lock, flags);
 452		}
 453
 454		/* len must be a multiple of 4 and small enough to */
 455		/* guarantee the write will send buffered data first, */
 456		/* so commands are in order with data and not split */
 457		len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 458		if (len > 4)
 459			len &= ~3;
 460
 461		/* write any buffered data first */
 462		if (priv->dp_out_buf_len > 0) {
 463			data[0] = DIGI_CMD_SEND_DATA;
 464			data[1] = priv->dp_out_buf_len;
 465			memcpy(data + 2, priv->dp_out_buf,
 466				priv->dp_out_buf_len);
 467			memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
 468			port->write_urb->transfer_buffer_length
 469				= priv->dp_out_buf_len + 2 + len;
 470		} else {
 471			memcpy(data, buf, len);
 472			port->write_urb->transfer_buffer_length = len;
 473		}
 474
 475		ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 476		if (ret == 0) {
 477			priv->dp_write_urb_in_use = 1;
 478			priv->dp_out_buf_len = 0;
 479			count -= len;
 480			buf += len;
 481		}
 482
 483	}
 484	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 485
 486	if (ret)
 487		dev_err(&port->dev,
 488			"%s: usb_submit_urb failed, ret=%d, port=%d\n",
 489			__func__, ret, priv->dp_port_num);
 490	return ret;
 491}
 492
 493
 494/*
 495 *  Digi Set Modem Signals
 496 *
 497 *  Sets or clears DTR and RTS on the port, according to the
 498 *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
 499 *  for the modem_signals argument.  Returns 0 if successful,
 500 *  -EINTR if interrupted while sleeping, or a non-zero error
 501 *  returned by usb_submit_urb.
 502 */
 503
 504static int digi_set_modem_signals(struct usb_serial_port *port,
 505	unsigned int modem_signals, int interruptible)
 506{
 507
 508	int ret;
 509	struct digi_port *port_priv = usb_get_serial_port_data(port);
 510	struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 511	struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 512	unsigned char *data = oob_port->write_urb->transfer_buffer;
 513	unsigned long flags;
 514
 515	dev_dbg(&port->dev,
 516		"digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x\n",
 517		port_priv->dp_port_num, modem_signals);
 518
 519	spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 520	spin_lock(&port_priv->dp_port_lock);
 521
 522	while (oob_priv->dp_write_urb_in_use) {
 523		spin_unlock(&port_priv->dp_port_lock);
 524		cond_wait_interruptible_timeout_irqrestore(
 525			&oob_priv->write_wait, DIGI_RETRY_TIMEOUT,
 526			&oob_priv->dp_port_lock, flags);
 527		if (interruptible && signal_pending(current))
 528			return -EINTR;
 529		spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 530		spin_lock(&port_priv->dp_port_lock);
 531	}
 532	data[0] = DIGI_CMD_SET_DTR_SIGNAL;
 533	data[1] = port_priv->dp_port_num;
 534	data[2] = (modem_signals & TIOCM_DTR) ?
 535					DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
 536	data[3] = 0;
 537	data[4] = DIGI_CMD_SET_RTS_SIGNAL;
 538	data[5] = port_priv->dp_port_num;
 539	data[6] = (modem_signals & TIOCM_RTS) ?
 540					DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
 541	data[7] = 0;
 542
 543	oob_port->write_urb->transfer_buffer_length = 8;
 544
 545	ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 546	if (ret == 0) {
 547		oob_priv->dp_write_urb_in_use = 1;
 548		port_priv->dp_modem_signals &= ~(TIOCM_DTR | TIOCM_RTS);
 549		port_priv->dp_modem_signals |=
 550				modem_signals & (TIOCM_DTR | TIOCM_RTS);
 551	}
 552	spin_unlock(&port_priv->dp_port_lock);
 553	spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 554	if (ret)
 555		dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 556			__func__, ret);
 557	return ret;
 558}
 559
 560/*
 561 *  Digi Transmit Idle
 562 *
 563 *  Digi transmit idle waits, up to timeout ticks, for the transmitter
 564 *  to go idle.  It returns 0 if successful or a negative error.
 565 *
 566 *  There are race conditions here if more than one process is calling
 567 *  digi_transmit_idle on the same port at the same time.  However, this
 568 *  is only called from close, and only one process can be in close on a
 569 *  port at a time, so its ok.
 570 */
 571
 572static int digi_transmit_idle(struct usb_serial_port *port,
 573	unsigned long timeout)
 574{
 575	int ret;
 576	unsigned char buf[2];
 577	struct digi_port *priv = usb_get_serial_port_data(port);
 578	unsigned long flags;
 579
 580	spin_lock_irqsave(&priv->dp_port_lock, flags);
 581	priv->dp_transmit_idle = 0;
 582	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 583
 584	buf[0] = DIGI_CMD_TRANSMIT_IDLE;
 585	buf[1] = 0;
 586
 587	timeout += jiffies;
 588
 589	ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
 590	if (ret != 0)
 591		return ret;
 592
 593	spin_lock_irqsave(&priv->dp_port_lock, flags);
 594
 595	while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
 596		cond_wait_interruptible_timeout_irqrestore(
 597			&priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
 598			&priv->dp_port_lock, flags);
 599		if (signal_pending(current))
 600			return -EINTR;
 601		spin_lock_irqsave(&priv->dp_port_lock, flags);
 602	}
 603	priv->dp_transmit_idle = 0;
 604	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 605	return 0;
 606
 607}
 608
 609
 610static void digi_rx_throttle(struct tty_struct *tty)
 611{
 612	unsigned long flags;
 613	struct usb_serial_port *port = tty->driver_data;
 614	struct digi_port *priv = usb_get_serial_port_data(port);
 615
 616	/* stop receiving characters by not resubmitting the read urb */
 617	spin_lock_irqsave(&priv->dp_port_lock, flags);
 618	priv->dp_throttled = 1;
 619	priv->dp_throttle_restart = 0;
 620	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 621}
 622
 623
 624static void digi_rx_unthrottle(struct tty_struct *tty)
 625{
 626	int ret = 0;
 627	unsigned long flags;
 628	struct usb_serial_port *port = tty->driver_data;
 629	struct digi_port *priv = usb_get_serial_port_data(port);
 630
 631	spin_lock_irqsave(&priv->dp_port_lock, flags);
 632
 633	/* restart read chain */
 634	if (priv->dp_throttle_restart)
 635		ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 636
 637	/* turn throttle off */
 638	priv->dp_throttled = 0;
 639	priv->dp_throttle_restart = 0;
 640
 641	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 642
 643	if (ret)
 644		dev_err(&port->dev,
 645			"%s: usb_submit_urb failed, ret=%d, port=%d\n",
 646			__func__, ret, priv->dp_port_num);
 647}
 648
 649
 650static void digi_set_termios(struct tty_struct *tty,
 651			     struct usb_serial_port *port,
 652			     const struct ktermios *old_termios)
 653{
 654	struct digi_port *priv = usb_get_serial_port_data(port);
 655	struct device *dev = &port->dev;
 656	unsigned int iflag = tty->termios.c_iflag;
 657	unsigned int cflag = tty->termios.c_cflag;
 658	unsigned int old_iflag = old_termios->c_iflag;
 659	unsigned int old_cflag = old_termios->c_cflag;
 660	unsigned char buf[32];
 661	unsigned int modem_signals;
 662	int arg, ret;
 663	int i = 0;
 664	speed_t baud;
 665
 666	dev_dbg(dev,
 667		"digi_set_termios: TOP: port=%d, iflag=0x%x, old_iflag=0x%x, cflag=0x%x, old_cflag=0x%x\n",
 668		priv->dp_port_num, iflag, old_iflag, cflag, old_cflag);
 669
 670	/* set baud rate */
 671	baud = tty_get_baud_rate(tty);
 672	if (baud != tty_termios_baud_rate(old_termios)) {
 673		arg = -1;
 674
 675		/* reassert DTR and (maybe) RTS on transition from B0 */
 676		if ((old_cflag & CBAUD) == B0) {
 677			/* don't set RTS if using hardware flow control */
 678			/* and throttling input */
 679			modem_signals = TIOCM_DTR;
 680			if (!C_CRTSCTS(tty) || !tty_throttled(tty))
 681				modem_signals |= TIOCM_RTS;
 682			digi_set_modem_signals(port, modem_signals, 1);
 683		}
 684		switch (baud) {
 685		/* drop DTR and RTS on transition to B0 */
 686		case 0: digi_set_modem_signals(port, 0, 1); break;
 687		case 50: arg = DIGI_BAUD_50; break;
 688		case 75: arg = DIGI_BAUD_75; break;
 689		case 110: arg = DIGI_BAUD_110; break;
 690		case 150: arg = DIGI_BAUD_150; break;
 691		case 200: arg = DIGI_BAUD_200; break;
 692		case 300: arg = DIGI_BAUD_300; break;
 693		case 600: arg = DIGI_BAUD_600; break;
 694		case 1200: arg = DIGI_BAUD_1200; break;
 695		case 1800: arg = DIGI_BAUD_1800; break;
 696		case 2400: arg = DIGI_BAUD_2400; break;
 697		case 4800: arg = DIGI_BAUD_4800; break;
 698		case 9600: arg = DIGI_BAUD_9600; break;
 699		case 19200: arg = DIGI_BAUD_19200; break;
 700		case 38400: arg = DIGI_BAUD_38400; break;
 701		case 57600: arg = DIGI_BAUD_57600; break;
 702		case 115200: arg = DIGI_BAUD_115200; break;
 703		case 230400: arg = DIGI_BAUD_230400; break;
 704		case 460800: arg = DIGI_BAUD_460800; break;
 705		default:
 706			arg = DIGI_BAUD_9600;
 707			baud = 9600;
 708			break;
 709		}
 710		if (arg != -1) {
 711			buf[i++] = DIGI_CMD_SET_BAUD_RATE;
 712			buf[i++] = priv->dp_port_num;
 713			buf[i++] = arg;
 714			buf[i++] = 0;
 715		}
 716	}
 717	/* set parity */
 718	tty->termios.c_cflag &= ~CMSPAR;
 719
 720	if ((cflag & (PARENB | PARODD)) != (old_cflag & (PARENB | PARODD))) {
 721		if (cflag & PARENB) {
 722			if (cflag & PARODD)
 723				arg = DIGI_PARITY_ODD;
 724			else
 725				arg = DIGI_PARITY_EVEN;
 726		} else {
 727			arg = DIGI_PARITY_NONE;
 728		}
 729		buf[i++] = DIGI_CMD_SET_PARITY;
 730		buf[i++] = priv->dp_port_num;
 731		buf[i++] = arg;
 732		buf[i++] = 0;
 733	}
 734	/* set word size */
 735	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 736		arg = -1;
 737		switch (cflag & CSIZE) {
 738		case CS5: arg = DIGI_WORD_SIZE_5; break;
 739		case CS6: arg = DIGI_WORD_SIZE_6; break;
 740		case CS7: arg = DIGI_WORD_SIZE_7; break;
 741		case CS8: arg = DIGI_WORD_SIZE_8; break;
 742		default:
 743			dev_dbg(dev,
 744				"digi_set_termios: can't handle word size %d\n",
 745				cflag & CSIZE);
 746			break;
 747		}
 748
 749		if (arg != -1) {
 750			buf[i++] = DIGI_CMD_SET_WORD_SIZE;
 751			buf[i++] = priv->dp_port_num;
 752			buf[i++] = arg;
 753			buf[i++] = 0;
 754		}
 755
 756	}
 757
 758	/* set stop bits */
 759	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 760
 761		if ((cflag & CSTOPB))
 762			arg = DIGI_STOP_BITS_2;
 763		else
 764			arg = DIGI_STOP_BITS_1;
 765
 766		buf[i++] = DIGI_CMD_SET_STOP_BITS;
 767		buf[i++] = priv->dp_port_num;
 768		buf[i++] = arg;
 769		buf[i++] = 0;
 770
 771	}
 772
 773	/* set input flow control */
 774	if ((iflag & IXOFF) != (old_iflag & IXOFF) ||
 775			(cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 776		arg = 0;
 777		if (iflag & IXOFF)
 778			arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
 779		else
 780			arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
 781
 782		if (cflag & CRTSCTS) {
 783			arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
 784
 785			/* On USB-4 it is necessary to assert RTS prior */
 786			/* to selecting RTS input flow control.  */
 787			buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
 788			buf[i++] = priv->dp_port_num;
 789			buf[i++] = DIGI_RTS_ACTIVE;
 790			buf[i++] = 0;
 791
 792		} else {
 793			arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
 794		}
 795		buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
 796		buf[i++] = priv->dp_port_num;
 797		buf[i++] = arg;
 798		buf[i++] = 0;
 799	}
 800
 801	/* set output flow control */
 802	if ((iflag & IXON) != (old_iflag & IXON) ||
 803			(cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 804		arg = 0;
 805		if (iflag & IXON)
 806			arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
 807		else
 808			arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
 809
 810		if (cflag & CRTSCTS)
 811			arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
 812		else
 813			arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
 814
 815		buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
 816		buf[i++] = priv->dp_port_num;
 817		buf[i++] = arg;
 818		buf[i++] = 0;
 819	}
 820
 821	/* set receive enable/disable */
 822	if ((cflag & CREAD) != (old_cflag & CREAD)) {
 823		if (cflag & CREAD)
 824			arg = DIGI_ENABLE;
 825		else
 826			arg = DIGI_DISABLE;
 827
 828		buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
 829		buf[i++] = priv->dp_port_num;
 830		buf[i++] = arg;
 831		buf[i++] = 0;
 832	}
 833	ret = digi_write_oob_command(port, buf, i, 1);
 834	if (ret != 0)
 835		dev_dbg(dev, "digi_set_termios: write oob failed, ret=%d\n", ret);
 836	tty_encode_baud_rate(tty, baud, baud);
 837}
 838
 839
 840static int digi_break_ctl(struct tty_struct *tty, int break_state)
 841{
 842	struct usb_serial_port *port = tty->driver_data;
 843	unsigned char buf[4];
 844
 845	buf[0] = DIGI_CMD_BREAK_CONTROL;
 846	buf[1] = 2;				/* length */
 847	buf[2] = break_state ? 1 : 0;
 848	buf[3] = 0;				/* pad */
 849
 850	return digi_write_inb_command(port, buf, 4, 0);
 851}
 852
 853
 854static int digi_tiocmget(struct tty_struct *tty)
 855{
 856	struct usb_serial_port *port = tty->driver_data;
 857	struct digi_port *priv = usb_get_serial_port_data(port);
 858	unsigned int val;
 859	unsigned long flags;
 860
 861	spin_lock_irqsave(&priv->dp_port_lock, flags);
 862	val = priv->dp_modem_signals;
 863	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 864	return val;
 865}
 866
 867
 868static int digi_tiocmset(struct tty_struct *tty,
 869					unsigned int set, unsigned int clear)
 870{
 871	struct usb_serial_port *port = tty->driver_data;
 872	struct digi_port *priv = usb_get_serial_port_data(port);
 873	unsigned int val;
 874	unsigned long flags;
 875
 876	spin_lock_irqsave(&priv->dp_port_lock, flags);
 877	val = (priv->dp_modem_signals & ~clear) | set;
 878	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 879	return digi_set_modem_signals(port, val, 1);
 880}
 881
 882
 883static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
 884					const unsigned char *buf, int count)
 885{
 886
 887	int ret, data_len, new_len;
 888	struct digi_port *priv = usb_get_serial_port_data(port);
 889	unsigned char *data = port->write_urb->transfer_buffer;
 890	unsigned long flags;
 891
 892	dev_dbg(&port->dev, "digi_write: TOP: port=%d, count=%d\n",
 893		priv->dp_port_num, count);
 894
 895	/* copy user data (which can sleep) before getting spin lock */
 896	count = min(count, port->bulk_out_size-2);
 897	count = min(64, count);
 898
 899	/* be sure only one write proceeds at a time */
 900	/* there are races on the port private buffer */
 901	spin_lock_irqsave(&priv->dp_port_lock, flags);
 902
 903	/* wait for urb status clear to submit another urb */
 904	if (priv->dp_write_urb_in_use) {
 905		/* buffer data if count is 1 (probably put_char) if possible */
 906		if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
 907			priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
 908			new_len = 1;
 909		} else {
 910			new_len = 0;
 911		}
 912		spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 913		return new_len;
 914	}
 915
 916	/* allow space for any buffered data and for new data, up to */
 917	/* transfer buffer size - 2 (for command and length bytes) */
 918	new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 919	data_len = new_len + priv->dp_out_buf_len;
 920
 921	if (data_len == 0) {
 922		spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 923		return 0;
 924	}
 925
 926	port->write_urb->transfer_buffer_length = data_len+2;
 927
 928	*data++ = DIGI_CMD_SEND_DATA;
 929	*data++ = data_len;
 930
 931	/* copy in buffered data first */
 932	memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
 933	data += priv->dp_out_buf_len;
 934
 935	/* copy in new data */
 936	memcpy(data, buf, new_len);
 937
 938	ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 939	if (ret == 0) {
 940		priv->dp_write_urb_in_use = 1;
 941		ret = new_len;
 942		priv->dp_out_buf_len = 0;
 943	}
 944
 945	/* return length of new data written, or error */
 946	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 947	if (ret < 0)
 948		dev_err_console(port,
 949			"%s: usb_submit_urb failed, ret=%d, port=%d\n",
 950			__func__, ret, priv->dp_port_num);
 951	dev_dbg(&port->dev, "digi_write: returning %d\n", ret);
 952	return ret;
 953
 954}
 955
 956static void digi_write_bulk_callback(struct urb *urb)
 957{
 958
 959	struct usb_serial_port *port = urb->context;
 960	struct usb_serial *serial;
 961	struct digi_port *priv;
 962	struct digi_serial *serial_priv;
 963	unsigned long flags;
 964	int ret = 0;
 965	int status = urb->status;
 966	bool wakeup;
 967
 968	/* port and serial sanity check */
 969	if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
 970		pr_err("%s: port or port->private is NULL, status=%d\n",
 971			__func__, status);
 972		return;
 973	}
 974	serial = port->serial;
 975	if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
 976		dev_err(&port->dev,
 977			"%s: serial or serial->private is NULL, status=%d\n",
 978			__func__, status);
 979		return;
 980	}
 981
 982	/* handle oob callback */
 983	if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
 984		dev_dbg(&port->dev, "digi_write_bulk_callback: oob callback\n");
 985		spin_lock_irqsave(&priv->dp_port_lock, flags);
 986		priv->dp_write_urb_in_use = 0;
 987		wake_up_interruptible(&priv->write_wait);
 988		spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 989		return;
 990	}
 991
 992	/* try to send any buffered data on this port */
 993	wakeup = true;
 994	spin_lock_irqsave(&priv->dp_port_lock, flags);
 995	priv->dp_write_urb_in_use = 0;
 996	if (priv->dp_out_buf_len > 0) {
 997		*((unsigned char *)(port->write_urb->transfer_buffer))
 998			= (unsigned char)DIGI_CMD_SEND_DATA;
 999		*((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1000			= (unsigned char)priv->dp_out_buf_len;
1001		port->write_urb->transfer_buffer_length =
1002						priv->dp_out_buf_len + 2;
1003		memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1004			priv->dp_out_buf_len);
1005		ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1006		if (ret == 0) {
1007			priv->dp_write_urb_in_use = 1;
1008			priv->dp_out_buf_len = 0;
1009			wakeup = false;
1010		}
1011	}
1012	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1013
1014	if (ret && ret != -EPERM)
1015		dev_err_console(port,
1016			"%s: usb_submit_urb failed, ret=%d, port=%d\n",
1017			__func__, ret, priv->dp_port_num);
1018
1019	if (wakeup)
1020		tty_port_tty_wakeup(&port->port);
1021}
1022
1023static unsigned int digi_write_room(struct tty_struct *tty)
1024{
1025	struct usb_serial_port *port = tty->driver_data;
1026	struct digi_port *priv = usb_get_serial_port_data(port);
1027	unsigned long flags;
1028	unsigned int room;
1029
1030	spin_lock_irqsave(&priv->dp_port_lock, flags);
1031
1032	if (priv->dp_write_urb_in_use)
1033		room = 0;
1034	else
1035		room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1036
1037	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1038	dev_dbg(&port->dev, "digi_write_room: port=%d, room=%u\n", priv->dp_port_num, room);
1039	return room;
1040
1041}
1042
1043static unsigned int digi_chars_in_buffer(struct tty_struct *tty)
1044{
1045	struct usb_serial_port *port = tty->driver_data;
1046	struct digi_port *priv = usb_get_serial_port_data(port);
1047	unsigned long flags;
1048	unsigned int chars;
1049
1050	spin_lock_irqsave(&priv->dp_port_lock, flags);
1051	if (priv->dp_write_urb_in_use)
1052		chars = port->bulk_out_size - 2;
1053	else
1054		chars = priv->dp_out_buf_len;
1055	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1056
1057	dev_dbg(&port->dev, "%s: port=%d, chars=%d\n", __func__,
1058			priv->dp_port_num, chars);
1059	return chars;
1060}
1061
1062static void digi_dtr_rts(struct usb_serial_port *port, int on)
1063{
1064	/* Adjust DTR and RTS */
1065	digi_set_modem_signals(port, on * (TIOCM_DTR | TIOCM_RTS), 1);
1066}
1067
1068static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1069{
1070	int ret;
1071	unsigned char buf[32];
1072	struct digi_port *priv = usb_get_serial_port_data(port);
1073	struct ktermios not_termios;
1074
1075	/* be sure the device is started up */
1076	if (digi_startup_device(port->serial) != 0)
1077		return -ENXIO;
1078
1079	/* read modem signals automatically whenever they change */
1080	buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1081	buf[1] = priv->dp_port_num;
1082	buf[2] = DIGI_ENABLE;
1083	buf[3] = 0;
1084
1085	/* flush fifos */
1086	buf[4] = DIGI_CMD_IFLUSH_FIFO;
1087	buf[5] = priv->dp_port_num;
1088	buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1089	buf[7] = 0;
1090
1091	ret = digi_write_oob_command(port, buf, 8, 1);
1092	if (ret != 0)
1093		dev_dbg(&port->dev, "digi_open: write oob failed, ret=%d\n", ret);
1094
1095	/* set termios settings */
1096	if (tty) {
1097		not_termios.c_cflag = ~tty->termios.c_cflag;
1098		not_termios.c_iflag = ~tty->termios.c_iflag;
1099		digi_set_termios(tty, port, &not_termios);
1100	}
1101	return 0;
1102}
1103
1104
1105static void digi_close(struct usb_serial_port *port)
1106{
1107	DEFINE_WAIT(wait);
1108	int ret;
1109	unsigned char buf[32];
1110	struct digi_port *priv = usb_get_serial_port_data(port);
1111
1112	mutex_lock(&port->serial->disc_mutex);
1113	/* if disconnected, just clear flags */
1114	if (port->serial->disconnected)
1115		goto exit;
1116
1117	/* FIXME: Transmit idle belongs in the wait_unti_sent path */
1118	digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1119
1120	/* disable input flow control */
1121	buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1122	buf[1] = priv->dp_port_num;
1123	buf[2] = DIGI_DISABLE;
1124	buf[3] = 0;
1125
1126	/* disable output flow control */
1127	buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1128	buf[5] = priv->dp_port_num;
1129	buf[6] = DIGI_DISABLE;
1130	buf[7] = 0;
1131
1132	/* disable reading modem signals automatically */
1133	buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1134	buf[9] = priv->dp_port_num;
1135	buf[10] = DIGI_DISABLE;
1136	buf[11] = 0;
1137
1138	/* disable receive */
1139	buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1140	buf[13] = priv->dp_port_num;
1141	buf[14] = DIGI_DISABLE;
1142	buf[15] = 0;
1143
1144	/* flush fifos */
1145	buf[16] = DIGI_CMD_IFLUSH_FIFO;
1146	buf[17] = priv->dp_port_num;
1147	buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1148	buf[19] = 0;
1149
1150	ret = digi_write_oob_command(port, buf, 20, 0);
1151	if (ret != 0)
1152		dev_dbg(&port->dev, "digi_close: write oob failed, ret=%d\n",
1153									ret);
1154	/* wait for final commands on oob port to complete */
1155	prepare_to_wait(&priv->dp_flush_wait, &wait,
1156			TASK_INTERRUPTIBLE);
1157	schedule_timeout(DIGI_CLOSE_TIMEOUT);
1158	finish_wait(&priv->dp_flush_wait, &wait);
1159
1160	/* shutdown any outstanding bulk writes */
1161	usb_kill_urb(port->write_urb);
1162exit:
1163	spin_lock_irq(&priv->dp_port_lock);
1164	priv->dp_write_urb_in_use = 0;
1165	wake_up_interruptible(&priv->dp_close_wait);
1166	spin_unlock_irq(&priv->dp_port_lock);
1167	mutex_unlock(&port->serial->disc_mutex);
1168}
1169
1170
1171/*
1172 *  Digi Startup Device
1173 *
1174 *  Starts reads on all ports.  Must be called AFTER startup, with
1175 *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1176 */
1177
1178static int digi_startup_device(struct usb_serial *serial)
1179{
1180	int i, ret = 0;
1181	struct digi_serial *serial_priv = usb_get_serial_data(serial);
1182	struct usb_serial_port *port;
1183
1184	/* be sure this happens exactly once */
1185	spin_lock(&serial_priv->ds_serial_lock);
1186	if (serial_priv->ds_device_started) {
1187		spin_unlock(&serial_priv->ds_serial_lock);
1188		return 0;
1189	}
1190	serial_priv->ds_device_started = 1;
1191	spin_unlock(&serial_priv->ds_serial_lock);
1192
1193	/* start reading from each bulk in endpoint for the device */
1194	/* set USB_DISABLE_SPD flag for write bulk urbs */
1195	for (i = 0; i < serial->type->num_ports + 1; i++) {
1196		port = serial->port[i];
1197		ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1198		if (ret != 0) {
1199			dev_err(&port->dev,
1200				"%s: usb_submit_urb failed, ret=%d, port=%d\n",
1201				__func__, ret, i);
1202			break;
1203		}
1204	}
1205	return ret;
1206}
1207
1208static int digi_port_init(struct usb_serial_port *port, unsigned port_num)
1209{
1210	struct digi_port *priv;
1211
1212	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1213	if (!priv)
1214		return -ENOMEM;
1215
1216	spin_lock_init(&priv->dp_port_lock);
1217	priv->dp_port_num = port_num;
1218	init_waitqueue_head(&priv->dp_transmit_idle_wait);
1219	init_waitqueue_head(&priv->dp_flush_wait);
1220	init_waitqueue_head(&priv->dp_close_wait);
1221	init_waitqueue_head(&priv->write_wait);
1222	priv->dp_port = port;
1223
1224	usb_set_serial_port_data(port, priv);
1225
1226	return 0;
1227}
1228
1229static int digi_startup(struct usb_serial *serial)
1230{
1231	struct digi_serial *serial_priv;
1232	int ret;
1233
1234	serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
1235	if (!serial_priv)
1236		return -ENOMEM;
1237
1238	spin_lock_init(&serial_priv->ds_serial_lock);
1239	serial_priv->ds_oob_port_num = serial->type->num_ports;
1240	serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1241
1242	ret = digi_port_init(serial_priv->ds_oob_port,
1243						serial_priv->ds_oob_port_num);
1244	if (ret) {
1245		kfree(serial_priv);
1246		return ret;
1247	}
1248
1249	usb_set_serial_data(serial, serial_priv);
1250
1251	return 0;
1252}
1253
1254
1255static void digi_disconnect(struct usb_serial *serial)
1256{
1257	int i;
1258
1259	/* stop reads and writes on all ports */
1260	for (i = 0; i < serial->type->num_ports + 1; i++) {
1261		usb_kill_urb(serial->port[i]->read_urb);
1262		usb_kill_urb(serial->port[i]->write_urb);
1263	}
1264}
1265
1266
1267static void digi_release(struct usb_serial *serial)
1268{
1269	struct digi_serial *serial_priv;
1270	struct digi_port *priv;
1271
1272	serial_priv = usb_get_serial_data(serial);
1273
1274	priv = usb_get_serial_port_data(serial_priv->ds_oob_port);
1275	kfree(priv);
1276
1277	kfree(serial_priv);
1278}
1279
1280static int digi_port_probe(struct usb_serial_port *port)
1281{
1282	return digi_port_init(port, port->port_number);
1283}
1284
1285static void digi_port_remove(struct usb_serial_port *port)
1286{
1287	struct digi_port *priv;
1288
1289	priv = usb_get_serial_port_data(port);
1290	kfree(priv);
1291}
1292
1293static void digi_read_bulk_callback(struct urb *urb)
1294{
1295	struct usb_serial_port *port = urb->context;
1296	struct digi_port *priv;
1297	struct digi_serial *serial_priv;
1298	int ret;
1299	int status = urb->status;
1300
1301	/* port sanity check, do not resubmit if port is not valid */
1302	if (port == NULL)
1303		return;
1304	priv = usb_get_serial_port_data(port);
1305	if (priv == NULL) {
1306		dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1307			__func__, status);
1308		return;
1309	}
1310	if (port->serial == NULL ||
1311		(serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1312		dev_err(&port->dev, "%s: serial is bad or serial->private "
1313			"is NULL, status=%d\n", __func__, status);
1314		return;
1315	}
1316
1317	/* do not resubmit urb if it has any status error */
1318	if (status) {
1319		dev_err(&port->dev,
1320			"%s: nonzero read bulk status: status=%d, port=%d\n",
1321			__func__, status, priv->dp_port_num);
1322		return;
1323	}
1324
1325	/* handle oob or inb callback, do not resubmit if error */
1326	if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1327		if (digi_read_oob_callback(urb) != 0)
1328			return;
1329	} else {
1330		if (digi_read_inb_callback(urb) != 0)
1331			return;
1332	}
1333
1334	/* continue read */
1335	ret = usb_submit_urb(urb, GFP_ATOMIC);
1336	if (ret != 0 && ret != -EPERM) {
1337		dev_err(&port->dev,
1338			"%s: failed resubmitting urb, ret=%d, port=%d\n",
1339			__func__, ret, priv->dp_port_num);
1340	}
1341
1342}
1343
1344/*
1345 *  Digi Read INB Callback
1346 *
1347 *  Digi Read INB Callback handles reads on the in band ports, sending
1348 *  the data on to the tty subsystem.  When called we know port and
1349 *  port->private are not NULL and port->serial has been validated.
1350 *  It returns 0 if successful, 1 if successful but the port is
1351 *  throttled, and -1 if the sanity checks failed.
1352 */
1353
1354static int digi_read_inb_callback(struct urb *urb)
1355{
1356	struct usb_serial_port *port = urb->context;
1357	struct digi_port *priv = usb_get_serial_port_data(port);
1358	unsigned char *buf = urb->transfer_buffer;
1359	unsigned long flags;
1360	int opcode;
1361	int len;
1362	int port_status;
1363	unsigned char *data;
1364	int tty_flag, throttled;
1365
1366	/* short/multiple packet check */
1367	if (urb->actual_length < 2) {
1368		dev_warn(&port->dev, "short packet received\n");
1369		return -1;
1370	}
1371
1372	opcode = buf[0];
1373	len = buf[1];
1374
1375	if (urb->actual_length != len + 2) {
1376		dev_err(&port->dev, "malformed packet received: port=%d, opcode=%d, len=%d, actual_length=%u\n",
1377			priv->dp_port_num, opcode, len, urb->actual_length);
1378		return -1;
1379	}
1380
1381	if (opcode == DIGI_CMD_RECEIVE_DATA && len < 1) {
1382		dev_err(&port->dev, "malformed data packet received\n");
1383		return -1;
1384	}
1385
1386	spin_lock_irqsave(&priv->dp_port_lock, flags);
1387
1388	/* check for throttle; if set, do not resubmit read urb */
1389	/* indicate the read chain needs to be restarted on unthrottle */
1390	throttled = priv->dp_throttled;
1391	if (throttled)
1392		priv->dp_throttle_restart = 1;
1393
1394	/* receive data */
1395	if (opcode == DIGI_CMD_RECEIVE_DATA) {
1396		port_status = buf[2];
1397		data = &buf[3];
1398
1399		/* get flag from port_status */
1400		tty_flag = 0;
1401
1402		/* overrun is special, not associated with a char */
1403		if (port_status & DIGI_OVERRUN_ERROR)
1404			tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
1405
1406		/* break takes precedence over parity, */
1407		/* which takes precedence over framing errors */
1408		if (port_status & DIGI_BREAK_ERROR)
1409			tty_flag = TTY_BREAK;
1410		else if (port_status & DIGI_PARITY_ERROR)
1411			tty_flag = TTY_PARITY;
1412		else if (port_status & DIGI_FRAMING_ERROR)
1413			tty_flag = TTY_FRAME;
1414
1415		/* data length is len-1 (one byte of len is port_status) */
1416		--len;
1417		if (len > 0) {
1418			tty_insert_flip_string_fixed_flag(&port->port, data,
1419					tty_flag, len);
1420			tty_flip_buffer_push(&port->port);
1421		}
1422	}
1423	spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1424
1425	if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1426		dev_dbg(&port->dev, "%s: got RECEIVE_DISABLE\n", __func__);
1427	else if (opcode != DIGI_CMD_RECEIVE_DATA)
1428		dev_dbg(&port->dev, "%s: unknown opcode: %d\n", __func__, opcode);
1429
1430	return throttled ? 1 : 0;
1431
1432}
1433
1434
1435/*
1436 *  Digi Read OOB Callback
1437 *
1438 *  Digi Read OOB Callback handles reads on the out of band port.
1439 *  When called we know port and port->private are not NULL and
1440 *  the port->serial is valid.  It returns 0 if successful, and
1441 *  -1 if the sanity checks failed.
1442 */
1443
1444static int digi_read_oob_callback(struct urb *urb)
1445{
1446
1447	struct usb_serial_port *port = urb->context;
1448	struct usb_serial *serial = port->serial;
1449	struct tty_struct *tty;
1450	struct digi_port *priv;
1451	unsigned char *buf = urb->transfer_buffer;
1452	int opcode, line, status, val;
1453	unsigned long flags;
1454	int i;
1455	unsigned int rts;
1456
1457	if (urb->actual_length < 4)
1458		return -1;
1459
1460	/* handle each oob command */
1461	for (i = 0; i < urb->actual_length - 3; i += 4) {
1462		opcode = buf[i];
1463		line = buf[i + 1];
1464		status = buf[i + 2];
1465		val = buf[i + 3];
1466
1467		dev_dbg(&port->dev, "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d\n",
1468			opcode, line, status, val);
1469
1470		if (status != 0 || line >= serial->type->num_ports)
1471			continue;
1472
1473		port = serial->port[line];
1474
1475		priv = usb_get_serial_port_data(port);
1476		if (priv == NULL)
1477			return -1;
1478
1479		tty = tty_port_tty_get(&port->port);
1480
1481		rts = 0;
1482		if (tty)
1483			rts = C_CRTSCTS(tty);
1484
1485		if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1486			bool wakeup = false;
1487
1488			spin_lock_irqsave(&priv->dp_port_lock, flags);
1489			/* convert from digi flags to termiox flags */
1490			if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1491				priv->dp_modem_signals |= TIOCM_CTS;
1492				if (rts)
1493					wakeup = true;
1494			} else {
1495				priv->dp_modem_signals &= ~TIOCM_CTS;
1496				/* port must be open to use tty struct */
1497			}
1498			if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1499				priv->dp_modem_signals |= TIOCM_DSR;
1500			else
1501				priv->dp_modem_signals &= ~TIOCM_DSR;
1502			if (val & DIGI_READ_INPUT_SIGNALS_RI)
1503				priv->dp_modem_signals |= TIOCM_RI;
1504			else
1505				priv->dp_modem_signals &= ~TIOCM_RI;
1506			if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1507				priv->dp_modem_signals |= TIOCM_CD;
1508			else
1509				priv->dp_modem_signals &= ~TIOCM_CD;
1510
1511			spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1512
1513			if (wakeup)
1514				tty_port_tty_wakeup(&port->port);
1515		} else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1516			spin_lock_irqsave(&priv->dp_port_lock, flags);
1517			priv->dp_transmit_idle = 1;
1518			wake_up_interruptible(&priv->dp_transmit_idle_wait);
1519			spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1520		} else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1521			wake_up_interruptible(&priv->dp_flush_wait);
1522		}
1523		tty_kref_put(tty);
1524	}
1525	return 0;
1526
1527}
1528
1529module_usb_serial_driver(serial_drivers, id_table_combined);
1530
1531MODULE_AUTHOR(DRIVER_AUTHOR);
1532MODULE_DESCRIPTION(DRIVER_DESC);
1533MODULE_LICENSE("GPL");
~/ Read-only file preview.