Linux Audio

Check our new training course

Loading...
v6.8
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3  USB Driver for Sierra Wireless
   4
   5  Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,
   6
   7  Copyright (C) 2008, 2009  Elina Pasheva, Matthew Safar, Rory Filer
   8			<linux@sierrawireless.com>
   9
  10  IMPORTANT DISCLAIMER: This driver is not commercially supported by
  11  Sierra Wireless. Use at your own risk.
  12
  13  Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
  14  Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
  15*/
  16/* Uncomment to log function calls */
  17/* #define DEBUG */
  18
  19#define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
  20#define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
  21
  22#include <linux/kernel.h>
  23#include <linux/jiffies.h>
  24#include <linux/errno.h>
  25#include <linux/tty.h>
  26#include <linux/slab.h>
  27#include <linux/tty_flip.h>
  28#include <linux/module.h>
  29#include <linux/usb.h>
  30#include <linux/usb/serial.h>
  31
  32#define SWIMS_USB_REQUEST_SetPower	0x00
  33#define SWIMS_USB_REQUEST_SetNmea	0x07
  34
  35#define N_IN_URB_HM	8
  36#define N_OUT_URB_HM	64
  37#define N_IN_URB	4
  38#define N_OUT_URB	4
  39#define IN_BUFLEN	4096
  40
  41#define MAX_TRANSFER		(PAGE_SIZE - 512)
  42/* MAX_TRANSFER is chosen so that the VM is not stressed by
  43   allocations > PAGE_SIZE and the number of packets in a page
  44   is an integer 512 is the largest possible packet on EHCI */
  45
  46static bool nmea;
  47
  48struct sierra_iface_list {
  49	const u8 *nums;		/* array of interface numbers */
  50	size_t count;		/* number of elements in array */
 
  51};
  52
  53struct sierra_intf_private {
  54	spinlock_t susp_lock;
  55	unsigned int suspended:1;
  56	int in_flight;
  57	unsigned int open_ports;
  58};
  59
  60static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
  61{
  62	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  63			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
  64			USB_TYPE_VENDOR,		/* __u8 request type */
  65			swiState,			/* __u16 value       */
  66			0,				/* __u16 index       */
  67			NULL,				/* void *data        */
  68			0,				/* __u16 size 	     */
  69			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
  70}
  71
  72static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
  73{
  74	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  75			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
  76			USB_TYPE_VENDOR,		/* __u8 request type */
  77			enable,				/* __u16 value       */
  78			0x0000,				/* __u16 index       */
  79			NULL,				/* void *data        */
  80			0,				/* __u16 size 	     */
  81			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
  82}
  83
  84static int sierra_calc_num_ports(struct usb_serial *serial,
  85					struct usb_serial_endpoints *epds)
  86{
  87	int num_ports = 0;
  88	u8 ifnum, numendpoints;
  89
  90	ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
  91	numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
  92
  93	/* Dummy interface present on some SKUs should be ignored */
  94	if (ifnum == 0x99)
  95		num_ports = 0;
  96	else if (numendpoints <= 3)
  97		num_ports = 1;
  98	else
  99		num_ports = (numendpoints-1)/2;
 100	return num_ports;
 101}
 102
 103static bool is_listed(const u8 ifnum, const struct sierra_iface_list *list)
 
 104{
 
 105	int i;
 106
 107	if (!list)
 108		return false;
 109
 110	for (i = 0; i < list->count; i++) {
 111		if (list->nums[i] == ifnum)
 112			return true;
 
 113	}
 
 
 114
 115	return false;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 116}
 117
 118static u8 sierra_interface_num(struct usb_serial *serial)
 119{
 120	return serial->interface->cur_altsetting->desc.bInterfaceNumber;
 121}
 122
 123static int sierra_probe(struct usb_serial *serial,
 124			const struct usb_device_id *id)
 125{
 126	const struct sierra_iface_list *ignore_list;
 127	int result = 0;
 128	struct usb_device *udev;
 129	u8 ifnum;
 130
 131	udev = serial->dev;
 132	ifnum = sierra_interface_num(serial);
 133
 134	/*
 135	 * If this interface supports more than 1 alternate
 136	 * select the 2nd one
 137	 */
 138	if (serial->interface->num_altsetting == 2) {
 139		dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
 140			ifnum);
 141		/* We know the alternate setting is 1 for the MC8785 */
 142		usb_set_interface(udev, ifnum, 1);
 143	}
 144
 145	ignore_list = (const struct sierra_iface_list *)id->driver_info;
 146
 147	if (is_listed(ifnum, ignore_list)) {
 148		dev_dbg(&serial->dev->dev, "Ignoring interface #%d\n", ifnum);
 149		return -ENODEV;
 150	}
 151
 152	return result;
 153}
 154
 155/* interfaces with higher memory requirements */
 156static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
 157static const struct sierra_iface_list typeA_interface_list = {
 158	.nums	= hi_memory_typeA_ifaces,
 159	.count	= ARRAY_SIZE(hi_memory_typeA_ifaces),
 160};
 161
 162static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
 163static const struct sierra_iface_list typeB_interface_list = {
 164	.nums	= hi_memory_typeB_ifaces,
 165	.count	= ARRAY_SIZE(hi_memory_typeB_ifaces),
 166};
 167
 168/* 'ignorelist' of interfaces not served by this driver */
 169static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
 170static const struct sierra_iface_list direct_ip_interface_ignore = {
 171	.nums	= direct_ip_non_serial_ifaces,
 172	.count	= ARRAY_SIZE(direct_ip_non_serial_ifaces),
 173};
 174
 175static const struct usb_device_id id_table[] = {
 176	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
 177	{ USB_DEVICE(0x03F0, 0x1B1D) },	/* HP ev2200 a.k.a MC5720 */
 178	{ USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
 179	{ USB_DEVICE(0x03F0, 0x1E1D) },	/* HP hs2300 a.k.a MC8775 */
 180
 181	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
 182	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
 183	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
 184	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
 185	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
 186	{ USB_DEVICE(0x1199, 0x0022) },	/* Sierra Wireless EM5725 */
 187	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
 188	{ USB_DEVICE(0x1199, 0x0224) },	/* Sierra Wireless MC5727 */
 189	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
 190	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
 191	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
 192	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
 193	{ USB_DEVICE(0x1199, 0x0301) },	/* Sierra Wireless USB Dongle 250U */
 194	/* Sierra Wireless C597 */
 195	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
 196	/* Sierra Wireless T598 */
 197	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
 198	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
 199	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
 200	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
 201	{ USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
 202
 203	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
 204	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
 205	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
 206	{ USB_DEVICE(0x1199, 0x6805) },	/* Sierra Wireless MC8765 */
 207	{ USB_DEVICE(0x1199, 0x6808) },	/* Sierra Wireless MC8755 */
 208	{ USB_DEVICE(0x1199, 0x6809) },	/* Sierra Wireless MC8765 */
 209	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
 210	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 */
 211	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
 212	{ USB_DEVICE(0x1199, 0x6816) },	/* Sierra Wireless MC8775 */
 213	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
 214	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
 215	{ USB_DEVICE(0x1199, 0x6822) },	/* Sierra Wireless AirCard 875E */
 216	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
 217	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
 218	{ USB_DEVICE(0x1199, 0x6834) },	/* Sierra Wireless MC8780 */
 219	{ USB_DEVICE(0x1199, 0x6835) },	/* Sierra Wireless MC8781 */
 220	{ USB_DEVICE(0x1199, 0x6838) },	/* Sierra Wireless MC8780 */
 221	{ USB_DEVICE(0x1199, 0x6839) },	/* Sierra Wireless MC8781 */
 222	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
 223	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
 224	/* Sierra Wireless MC8790, MC8791, MC8792 Composite */
 225	{ USB_DEVICE(0x1199, 0x683C) },
 226	{ USB_DEVICE(0x1199, 0x683D) },	/* Sierra Wireless MC8791 Composite */
 227	/* Sierra Wireless MC8790, MC8791, MC8792 */
 228	{ USB_DEVICE(0x1199, 0x683E) },
 229	{ USB_DEVICE(0x1199, 0x6850) },	/* Sierra Wireless AirCard 880 */
 230	{ USB_DEVICE(0x1199, 0x6851) },	/* Sierra Wireless AirCard 881 */
 231	{ USB_DEVICE(0x1199, 0x6852) },	/* Sierra Wireless AirCard 880 E */
 232	{ USB_DEVICE(0x1199, 0x6853) },	/* Sierra Wireless AirCard 881 E */
 233	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
 234	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
 235	{ USB_DEVICE(0x1199, 0x6859) },	/* Sierra Wireless AirCard 885 E */
 236	{ USB_DEVICE(0x1199, 0x685A) },	/* Sierra Wireless AirCard 885 E */
 237	/* Sierra Wireless C885 */
 238	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
 239	/* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
 240	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
 241	/* Sierra Wireless C22/C33 */
 242	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
 243	/* Sierra Wireless HSPA Non-Composite Device */
 244	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
 245	{ USB_DEVICE(0x1199, 0x6893) },	/* Sierra Wireless Device */
 246	/* Sierra Wireless Direct IP modems */
 247	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
 248	  .driver_info = (kernel_ulong_t)&direct_ip_interface_ignore
 249	},
 250	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68AA, 0xFF, 0xFF, 0xFF),
 251	  .driver_info = (kernel_ulong_t)&direct_ip_interface_ignore
 252	},
 253	{ USB_DEVICE(0x1199, 0x68AB) }, /* Sierra Wireless AR8550 */
 254	/* AT&T Direct IP LTE modems */
 255	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
 256	  .driver_info = (kernel_ulong_t)&direct_ip_interface_ignore
 257	},
 258	/* Airprime/Sierra Wireless Direct IP modems */
 259	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
 260	  .driver_info = (kernel_ulong_t)&direct_ip_interface_ignore
 261	},
 262
 263	{ }
 264};
 265MODULE_DEVICE_TABLE(usb, id_table);
 266
 267
 268struct sierra_port_private {
 269	spinlock_t lock;	/* lock the structure */
 270	int outstanding_urbs;	/* number of out urbs in flight */
 271	struct usb_anchor active;
 272	struct usb_anchor delayed;
 273
 274	int num_out_urbs;
 275	int num_in_urbs;
 276	/* Input endpoints and buffers for this port */
 277	struct urb *in_urbs[N_IN_URB_HM];
 278
 279	/* Settings for the port */
 280	int rts_state;	/* Handshaking pins (outputs) */
 281	int dtr_state;
 282	int cts_state;	/* Handshaking pins (inputs) */
 283	int dsr_state;
 284	int dcd_state;
 285	int ri_state;
 286};
 287
 288static int sierra_send_setup(struct usb_serial_port *port)
 289{
 290	struct usb_serial *serial = port->serial;
 291	struct sierra_port_private *portdata;
 292	__u16 interface = 0;
 293	int val = 0;
 294	int do_send = 0;
 295	int retval;
 296
 297	portdata = usb_get_serial_port_data(port);
 298
 299	if (portdata->dtr_state)
 300		val |= 0x01;
 301	if (portdata->rts_state)
 302		val |= 0x02;
 303
 304	/* If composite device then properly report interface */
 305	if (serial->num_ports == 1) {
 306		interface = sierra_interface_num(serial);
 307		/* Control message is sent only to interfaces with
 308		 * interrupt_in endpoints
 309		 */
 310		if (port->interrupt_in_urb) {
 311			/* send control message */
 312			do_send = 1;
 313		}
 314	}
 315
 316	/* Otherwise the need to do non-composite mapping */
 317	else {
 318		if (port->bulk_out_endpointAddress == 2)
 319			interface = 0;
 320		else if (port->bulk_out_endpointAddress == 4)
 321			interface = 1;
 322		else if (port->bulk_out_endpointAddress == 5)
 323			interface = 2;
 324
 325		do_send = 1;
 326	}
 327	if (!do_send)
 328		return 0;
 329
 330	retval = usb_autopm_get_interface(serial->interface);
 331	if (retval < 0)
 332		return retval;
 333
 334	retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 335		0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
 336	usb_autopm_put_interface(serial->interface);
 337
 338	return retval;
 339}
 340
 341static int sierra_tiocmget(struct tty_struct *tty)
 342{
 343	struct usb_serial_port *port = tty->driver_data;
 344	unsigned int value;
 345	struct sierra_port_private *portdata;
 346
 347	portdata = usb_get_serial_port_data(port);
 348
 349	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
 350		((portdata->dtr_state) ? TIOCM_DTR : 0) |
 351		((portdata->cts_state) ? TIOCM_CTS : 0) |
 352		((portdata->dsr_state) ? TIOCM_DSR : 0) |
 353		((portdata->dcd_state) ? TIOCM_CAR : 0) |
 354		((portdata->ri_state) ? TIOCM_RNG : 0);
 355
 356	return value;
 357}
 358
 359static int sierra_tiocmset(struct tty_struct *tty,
 360			unsigned int set, unsigned int clear)
 361{
 362	struct usb_serial_port *port = tty->driver_data;
 363	struct sierra_port_private *portdata;
 364
 365	portdata = usb_get_serial_port_data(port);
 366
 367	if (set & TIOCM_RTS)
 368		portdata->rts_state = 1;
 369	if (set & TIOCM_DTR)
 370		portdata->dtr_state = 1;
 371
 372	if (clear & TIOCM_RTS)
 373		portdata->rts_state = 0;
 374	if (clear & TIOCM_DTR)
 375		portdata->dtr_state = 0;
 376	return sierra_send_setup(port);
 377}
 378
 379static void sierra_release_urb(struct urb *urb)
 380{
 381	if (urb) {
 382		kfree(urb->transfer_buffer);
 383		usb_free_urb(urb);
 384	}
 385}
 386
 387static void sierra_outdat_callback(struct urb *urb)
 388{
 389	struct usb_serial_port *port = urb->context;
 390	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 391	struct sierra_intf_private *intfdata;
 392	int status = urb->status;
 393	unsigned long flags;
 394
 395	intfdata = usb_get_serial_data(port->serial);
 396
 397	/* free up the transfer buffer, as usb_free_urb() does not do this */
 398	kfree(urb->transfer_buffer);
 399	usb_autopm_put_interface_async(port->serial->interface);
 400	if (status)
 401		dev_dbg(&port->dev, "%s - nonzero write bulk status "
 402		    "received: %d\n", __func__, status);
 403
 404	spin_lock_irqsave(&portdata->lock, flags);
 405	--portdata->outstanding_urbs;
 406	spin_unlock_irqrestore(&portdata->lock, flags);
 407	spin_lock_irqsave(&intfdata->susp_lock, flags);
 408	--intfdata->in_flight;
 409	spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 410
 411	usb_serial_port_softint(port);
 412}
 413
 414/* Write */
 415static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
 416					const unsigned char *buf, int count)
 417{
 418	struct sierra_port_private *portdata;
 419	struct sierra_intf_private *intfdata;
 420	struct usb_serial *serial = port->serial;
 421	unsigned long flags;
 422	unsigned char *buffer;
 423	struct urb *urb;
 424	size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
 425	int retval = 0;
 426
 427	/* verify that we actually have some data to write */
 428	if (count == 0)
 429		return 0;
 430
 431	portdata = usb_get_serial_port_data(port);
 432	intfdata = usb_get_serial_data(serial);
 433
 434	dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
 435	spin_lock_irqsave(&portdata->lock, flags);
 436	dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
 437		portdata->outstanding_urbs);
 438	if (portdata->outstanding_urbs > portdata->num_out_urbs) {
 439		spin_unlock_irqrestore(&portdata->lock, flags);
 440		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 441		return 0;
 442	}
 443	portdata->outstanding_urbs++;
 444	dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
 445		portdata->outstanding_urbs);
 446	spin_unlock_irqrestore(&portdata->lock, flags);
 447
 448	retval = usb_autopm_get_interface_async(serial->interface);
 449	if (retval < 0) {
 450		spin_lock_irqsave(&portdata->lock, flags);
 451		portdata->outstanding_urbs--;
 452		spin_unlock_irqrestore(&portdata->lock, flags);
 453		goto error_simple;
 454	}
 455
 456	buffer = kmemdup(buf, writesize, GFP_ATOMIC);
 457	if (!buffer) {
 458		retval = -ENOMEM;
 459		goto error_no_buffer;
 460	}
 461
 462	urb = usb_alloc_urb(0, GFP_ATOMIC);
 463	if (!urb) {
 464		retval = -ENOMEM;
 465		goto error_no_urb;
 466	}
 467
 
 
 468	usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
 469
 470	usb_fill_bulk_urb(urb, serial->dev,
 471			  usb_sndbulkpipe(serial->dev,
 472					  port->bulk_out_endpointAddress),
 473			  buffer, writesize, sierra_outdat_callback, port);
 474
 475	/* Handle the need to send a zero length packet */
 476	urb->transfer_flags |= URB_ZERO_PACKET;
 477
 478	spin_lock_irqsave(&intfdata->susp_lock, flags);
 479
 480	if (intfdata->suspended) {
 481		usb_anchor_urb(urb, &portdata->delayed);
 482		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 483		goto skip_power;
 484	} else {
 485		usb_anchor_urb(urb, &portdata->active);
 486	}
 487	/* send it down the pipe */
 488	retval = usb_submit_urb(urb, GFP_ATOMIC);
 489	if (retval) {
 490		usb_unanchor_urb(urb);
 491		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 492		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
 493			"with status = %d\n", __func__, retval);
 494		goto error;
 495	} else {
 496		intfdata->in_flight++;
 497		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 498	}
 499
 500skip_power:
 501	/* we are done with this urb, so let the host driver
 502	 * really free it when it is finished with it */
 503	usb_free_urb(urb);
 504
 505	return writesize;
 506error:
 507	usb_free_urb(urb);
 508error_no_urb:
 509	kfree(buffer);
 510error_no_buffer:
 511	spin_lock_irqsave(&portdata->lock, flags);
 512	--portdata->outstanding_urbs;
 513	dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
 514		portdata->outstanding_urbs);
 515	spin_unlock_irqrestore(&portdata->lock, flags);
 516	usb_autopm_put_interface_async(serial->interface);
 517error_simple:
 518	return retval;
 519}
 520
 521static void sierra_indat_callback(struct urb *urb)
 522{
 523	int err;
 524	int endpoint;
 525	struct usb_serial_port *port;
 526	unsigned char *data = urb->transfer_buffer;
 527	int status = urb->status;
 528
 529	endpoint = usb_pipeendpoint(urb->pipe);
 530	port = urb->context;
 531
 532	if (status) {
 533		dev_dbg(&port->dev, "%s: nonzero status: %d on"
 534			" endpoint %02x\n", __func__, status, endpoint);
 535	} else {
 536		if (urb->actual_length) {
 537			tty_insert_flip_string(&port->port, data,
 538				urb->actual_length);
 539			tty_flip_buffer_push(&port->port);
 540
 541			usb_serial_debug_data(&port->dev, __func__,
 542					      urb->actual_length, data);
 543		} else {
 544			dev_dbg(&port->dev, "%s: empty read urb"
 545				" received\n", __func__);
 546		}
 547	}
 548
 549	/* Resubmit urb so we continue receiving */
 550	if (status != -ESHUTDOWN && status != -EPERM) {
 551		usb_mark_last_busy(port->serial->dev);
 552		err = usb_submit_urb(urb, GFP_ATOMIC);
 553		if (err && err != -EPERM)
 554			dev_err(&port->dev, "resubmit read urb failed."
 555				"(%d)\n", err);
 556	}
 557}
 558
 559static void sierra_instat_callback(struct urb *urb)
 560{
 561	int err;
 562	int status = urb->status;
 563	struct usb_serial_port *port =  urb->context;
 564	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 565	struct usb_serial *serial = port->serial;
 566
 567	dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
 568		urb, port, portdata);
 569
 570	if (status == 0) {
 571		struct usb_ctrlrequest *req_pkt = urb->transfer_buffer;
 
 572
 573		if (!req_pkt) {
 574			dev_dbg(&port->dev, "%s: NULL req_pkt\n",
 575				__func__);
 576			return;
 577		}
 578		if ((req_pkt->bRequestType == 0xA1) &&
 579				(req_pkt->bRequest == 0x20)) {
 580			int old_dcd_state;
 581			unsigned char signals = *((unsigned char *)
 582					urb->transfer_buffer +
 583					sizeof(struct usb_ctrlrequest));
 584
 585			dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
 586				signals);
 587
 588			old_dcd_state = portdata->dcd_state;
 589			portdata->cts_state = 1;
 590			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
 591			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
 592			portdata->ri_state = ((signals & 0x08) ? 1 : 0);
 593
 594			if (old_dcd_state && !portdata->dcd_state)
 595				tty_port_tty_hangup(&port->port, true);
 596		} else {
 597			dev_dbg(&port->dev, "%s: type %x req %x\n",
 598				__func__, req_pkt->bRequestType,
 599				req_pkt->bRequest);
 600		}
 601	} else
 602		dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
 603
 604	/* Resubmit urb so we continue receiving IRQ data */
 605	if (status != -ESHUTDOWN && status != -ENOENT) {
 606		usb_mark_last_busy(serial->dev);
 607		err = usb_submit_urb(urb, GFP_ATOMIC);
 608		if (err && err != -EPERM)
 609			dev_err(&port->dev, "%s: resubmit intr urb "
 610				"failed. (%d)\n", __func__, err);
 611	}
 612}
 613
 614static unsigned int sierra_write_room(struct tty_struct *tty)
 615{
 616	struct usb_serial_port *port = tty->driver_data;
 617	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 618	unsigned long flags;
 619
 620	/* try to give a good number back based on if we have any free urbs at
 621	 * this point in time */
 622	spin_lock_irqsave(&portdata->lock, flags);
 623	if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
 624		spin_unlock_irqrestore(&portdata->lock, flags);
 625		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 626		return 0;
 627	}
 628	spin_unlock_irqrestore(&portdata->lock, flags);
 629
 630	return 2048;
 631}
 632
 633static unsigned int sierra_chars_in_buffer(struct tty_struct *tty)
 634{
 635	struct usb_serial_port *port = tty->driver_data;
 636	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 637	unsigned long flags;
 638	unsigned int chars;
 639
 640	/* NOTE: This overcounts somewhat. */
 641	spin_lock_irqsave(&portdata->lock, flags);
 642	chars = portdata->outstanding_urbs * MAX_TRANSFER;
 643	spin_unlock_irqrestore(&portdata->lock, flags);
 644
 645	dev_dbg(&port->dev, "%s - %u\n", __func__, chars);
 646
 647	return chars;
 648}
 649
 650static void sierra_stop_rx_urbs(struct usb_serial_port *port)
 651{
 652	int i;
 653	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 654
 655	for (i = 0; i < portdata->num_in_urbs; i++)
 656		usb_kill_urb(portdata->in_urbs[i]);
 657
 658	usb_kill_urb(port->interrupt_in_urb);
 659}
 660
 661static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
 662{
 663	int ok_cnt;
 664	int err = -EINVAL;
 665	int i;
 666	struct urb *urb;
 667	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 668
 669	ok_cnt = 0;
 670	for (i = 0; i < portdata->num_in_urbs; i++) {
 671		urb = portdata->in_urbs[i];
 672		if (!urb)
 673			continue;
 674		err = usb_submit_urb(urb, mem_flags);
 675		if (err) {
 676			dev_err(&port->dev, "%s: submit urb failed: %d\n",
 677				__func__, err);
 678		} else {
 679			ok_cnt++;
 680		}
 681	}
 682
 683	if (ok_cnt && port->interrupt_in_urb) {
 684		err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
 685		if (err) {
 686			dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
 687				__func__, err);
 688		}
 689	}
 690
 691	if (ok_cnt > 0) /* at least one rx urb submitted */
 692		return 0;
 693	else
 694		return err;
 695}
 696
 697static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
 698					int dir, void *ctx, int len,
 699					gfp_t mem_flags,
 700					usb_complete_t callback)
 701{
 702	struct urb	*urb;
 703	u8		*buf;
 704
 705	urb = usb_alloc_urb(0, mem_flags);
 706	if (!urb)
 707		return NULL;
 708
 709	buf = kmalloc(len, mem_flags);
 710	if (buf) {
 711		/* Fill URB using supplied data */
 712		usb_fill_bulk_urb(urb, serial->dev,
 713			usb_sndbulkpipe(serial->dev, endpoint) | dir,
 714			buf, len, callback, ctx);
 715
 716		dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
 717				dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
 718	} else {
 719		sierra_release_urb(urb);
 720		urb = NULL;
 721	}
 722
 723	return urb;
 724}
 725
 726static void sierra_close(struct usb_serial_port *port)
 727{
 728	int i;
 729	struct usb_serial *serial = port->serial;
 730	struct sierra_port_private *portdata;
 731	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 732	struct urb *urb;
 733
 734	portdata = usb_get_serial_port_data(port);
 735
 736	/*
 737	 * Need to take susp_lock to make sure port is not already being
 738	 * resumed, but no need to hold it due to the tty-port initialized
 739	 * flag.
 740	 */
 741	spin_lock_irq(&intfdata->susp_lock);
 742	if (--intfdata->open_ports == 0)
 743		serial->interface->needs_remote_wakeup = 0;
 744	spin_unlock_irq(&intfdata->susp_lock);
 745
 746	for (;;) {
 747		urb = usb_get_from_anchor(&portdata->delayed);
 748		if (!urb)
 749			break;
 750		kfree(urb->transfer_buffer);
 751		usb_free_urb(urb);
 752		usb_autopm_put_interface_async(serial->interface);
 753		spin_lock_irq(&portdata->lock);
 754		portdata->outstanding_urbs--;
 755		spin_unlock_irq(&portdata->lock);
 756	}
 757
 758	sierra_stop_rx_urbs(port);
 759	usb_kill_anchored_urbs(&portdata->active);
 760
 761	for (i = 0; i < portdata->num_in_urbs; i++) {
 762		sierra_release_urb(portdata->in_urbs[i]);
 763		portdata->in_urbs[i] = NULL;
 764	}
 765
 766	usb_autopm_get_interface_no_resume(serial->interface);
 767}
 768
 769static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
 770{
 771	struct sierra_port_private *portdata;
 772	struct usb_serial *serial = port->serial;
 773	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 774	int i;
 775	int err;
 776	int endpoint;
 777	struct urb *urb;
 778
 779	portdata = usb_get_serial_port_data(port);
 780
 781	endpoint = port->bulk_in_endpointAddress;
 782	for (i = 0; i < portdata->num_in_urbs; i++) {
 783		urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
 784					IN_BUFLEN, GFP_KERNEL,
 785					sierra_indat_callback);
 786		portdata->in_urbs[i] = urb;
 787	}
 788	/* clear halt condition */
 789	usb_clear_halt(serial->dev,
 790			usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
 791
 792	err = sierra_submit_rx_urbs(port, GFP_KERNEL);
 793	if (err)
 794		goto err_submit;
 795
 796	spin_lock_irq(&intfdata->susp_lock);
 797	if (++intfdata->open_ports == 1)
 798		serial->interface->needs_remote_wakeup = 1;
 799	spin_unlock_irq(&intfdata->susp_lock);
 800	usb_autopm_put_interface(serial->interface);
 801
 802	return 0;
 803
 804err_submit:
 805	sierra_stop_rx_urbs(port);
 806
 807	for (i = 0; i < portdata->num_in_urbs; i++) {
 808		sierra_release_urb(portdata->in_urbs[i]);
 809		portdata->in_urbs[i] = NULL;
 810	}
 811
 812	return err;
 813}
 814
 815
 816static void sierra_dtr_rts(struct usb_serial_port *port, int on)
 817{
 818	struct sierra_port_private *portdata;
 819
 820	portdata = usb_get_serial_port_data(port);
 821	portdata->rts_state = on;
 822	portdata->dtr_state = on;
 823
 824	sierra_send_setup(port);
 825}
 826
 827static int sierra_startup(struct usb_serial *serial)
 828{
 829	struct sierra_intf_private *intfdata;
 830
 831	intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
 832	if (!intfdata)
 833		return -ENOMEM;
 834
 835	spin_lock_init(&intfdata->susp_lock);
 836
 837	usb_set_serial_data(serial, intfdata);
 838
 839	/* Set Device mode to D0 */
 840	sierra_set_power_state(serial->dev, 0x0000);
 841
 842	/* Check NMEA and set */
 843	if (nmea)
 844		sierra_vsc_set_nmea(serial->dev, 1);
 845
 846	return 0;
 847}
 848
 849static void sierra_release(struct usb_serial *serial)
 850{
 851	struct sierra_intf_private *intfdata;
 852
 853	intfdata = usb_get_serial_data(serial);
 854	kfree(intfdata);
 855}
 856
 857static int sierra_port_probe(struct usb_serial_port *port)
 858{
 859	struct usb_serial *serial = port->serial;
 860	struct sierra_port_private *portdata;
 861	const struct sierra_iface_list *himemory_list;
 862	u8 ifnum;
 863
 864	portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
 865	if (!portdata)
 866		return -ENOMEM;
 867
 868	spin_lock_init(&portdata->lock);
 869	init_usb_anchor(&portdata->active);
 870	init_usb_anchor(&portdata->delayed);
 871
 872	/* Assume low memory requirements */
 873	portdata->num_out_urbs = N_OUT_URB;
 874	portdata->num_in_urbs  = N_IN_URB;
 875
 876	/* Determine actual memory requirements */
 877	if (serial->num_ports == 1) {
 878		/* Get interface number for composite device */
 879		ifnum = sierra_interface_num(serial);
 880		himemory_list = &typeB_interface_list;
 881	} else {
 882		/* This is really the usb-serial port number of the interface
 883		 * rather than the interface number.
 884		 */
 885		ifnum = port->port_number;
 886		himemory_list = &typeA_interface_list;
 887	}
 888
 889	if (is_listed(ifnum, himemory_list)) {
 890		portdata->num_out_urbs = N_OUT_URB_HM;
 891		portdata->num_in_urbs  = N_IN_URB_HM;
 892	}
 893
 894	dev_dbg(&port->dev,
 895			"Memory usage (urbs) interface #%d, in=%d, out=%d\n",
 896			ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
 897
 898	usb_set_serial_port_data(port, portdata);
 899
 900	return 0;
 901}
 902
 903static void sierra_port_remove(struct usb_serial_port *port)
 904{
 905	struct sierra_port_private *portdata;
 906
 907	portdata = usb_get_serial_port_data(port);
 908	usb_set_serial_port_data(port, NULL);
 909	kfree(portdata);
 
 
 910}
 911
 912#ifdef CONFIG_PM
 913static void stop_read_write_urbs(struct usb_serial *serial)
 914{
 915	int i;
 916	struct usb_serial_port *port;
 917	struct sierra_port_private *portdata;
 918
 919	/* Stop reading/writing urbs */
 920	for (i = 0; i < serial->num_ports; ++i) {
 921		port = serial->port[i];
 922		portdata = usb_get_serial_port_data(port);
 923		if (!portdata)
 924			continue;
 925		sierra_stop_rx_urbs(port);
 926		usb_kill_anchored_urbs(&portdata->active);
 927	}
 928}
 929
 930static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
 931{
 932	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 933
 934	spin_lock_irq(&intfdata->susp_lock);
 935	if (PMSG_IS_AUTO(message)) {
 936		if (intfdata->in_flight) {
 937			spin_unlock_irq(&intfdata->susp_lock);
 938			return -EBUSY;
 939		}
 940	}
 941	intfdata->suspended = 1;
 942	spin_unlock_irq(&intfdata->susp_lock);
 943
 944	stop_read_write_urbs(serial);
 945
 946	return 0;
 947}
 948
 949/* Caller must hold susp_lock. */
 950static int sierra_submit_delayed_urbs(struct usb_serial_port *port)
 951{
 952	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 953	struct sierra_intf_private *intfdata;
 954	struct urb *urb;
 955	int ec = 0;
 956	int err;
 957
 958	intfdata = usb_get_serial_data(port->serial);
 959
 960	for (;;) {
 961		urb = usb_get_from_anchor(&portdata->delayed);
 962		if (!urb)
 963			break;
 964
 965		usb_anchor_urb(urb, &portdata->active);
 966		intfdata->in_flight++;
 967		err = usb_submit_urb(urb, GFP_ATOMIC);
 968		if (err) {
 969			dev_err(&port->dev, "%s - submit urb failed: %d",
 970					__func__, err);
 971			ec++;
 972			intfdata->in_flight--;
 973			usb_unanchor_urb(urb);
 974			kfree(urb->transfer_buffer);
 975			usb_free_urb(urb);
 976
 977			spin_lock(&portdata->lock);
 978			portdata->outstanding_urbs--;
 979			spin_unlock(&portdata->lock);
 980		}
 981	}
 982
 983	if (ec)
 984		return -EIO;
 985
 986	return 0;
 987}
 988
 989static int sierra_resume(struct usb_serial *serial)
 990{
 991	struct usb_serial_port *port;
 992	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 993	int ec = 0;
 994	int i, err;
 995
 996	spin_lock_irq(&intfdata->susp_lock);
 997	for (i = 0; i < serial->num_ports; i++) {
 998		port = serial->port[i];
 999
1000		if (!tty_port_initialized(&port->port))
1001			continue;
1002
1003		err = sierra_submit_delayed_urbs(port);
1004		if (err)
1005			ec++;
1006
1007		err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1008		if (err)
1009			ec++;
1010	}
1011	intfdata->suspended = 0;
1012	spin_unlock_irq(&intfdata->susp_lock);
1013
1014	return ec ? -EIO : 0;
1015}
1016
1017#else
1018#define sierra_suspend NULL
1019#define sierra_resume NULL
1020#endif
1021
1022static struct usb_serial_driver sierra_device = {
1023	.driver = {
1024		.owner =	THIS_MODULE,
1025		.name =		"sierra",
1026	},
1027	.description       = "Sierra USB modem",
1028	.id_table          = id_table,
1029	.calc_num_ports	   = sierra_calc_num_ports,
1030	.probe		   = sierra_probe,
1031	.open              = sierra_open,
1032	.close             = sierra_close,
1033	.dtr_rts	   = sierra_dtr_rts,
1034	.write             = sierra_write,
1035	.write_room        = sierra_write_room,
1036	.chars_in_buffer   = sierra_chars_in_buffer,
1037	.tiocmget          = sierra_tiocmget,
1038	.tiocmset          = sierra_tiocmset,
1039	.attach            = sierra_startup,
1040	.release           = sierra_release,
1041	.port_probe        = sierra_port_probe,
1042	.port_remove       = sierra_port_remove,
1043	.suspend	   = sierra_suspend,
1044	.resume		   = sierra_resume,
1045	.read_int_callback = sierra_instat_callback,
1046};
1047
1048static struct usb_serial_driver * const serial_drivers[] = {
1049	&sierra_device, NULL
1050};
1051
1052module_usb_serial_driver(serial_drivers, id_table);
1053
1054MODULE_AUTHOR(DRIVER_AUTHOR);
1055MODULE_DESCRIPTION(DRIVER_DESC);
1056MODULE_LICENSE("GPL v2");
1057
1058module_param(nmea, bool, 0644);
1059MODULE_PARM_DESC(nmea, "NMEA streaming");
v4.17
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3  USB Driver for Sierra Wireless
   4
   5  Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,
   6
   7  Copyright (C) 2008, 2009  Elina Pasheva, Matthew Safar, Rory Filer
   8			<linux@sierrawireless.com>
   9
  10  IMPORTANT DISCLAIMER: This driver is not commercially supported by
  11  Sierra Wireless. Use at your own risk.
  12
  13  Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
  14  Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
  15*/
  16/* Uncomment to log function calls */
  17/* #define DEBUG */
  18
  19#define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
  20#define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
  21
  22#include <linux/kernel.h>
  23#include <linux/jiffies.h>
  24#include <linux/errno.h>
  25#include <linux/tty.h>
  26#include <linux/slab.h>
  27#include <linux/tty_flip.h>
  28#include <linux/module.h>
  29#include <linux/usb.h>
  30#include <linux/usb/serial.h>
  31
  32#define SWIMS_USB_REQUEST_SetPower	0x00
  33#define SWIMS_USB_REQUEST_SetNmea	0x07
  34
  35#define N_IN_URB_HM	8
  36#define N_OUT_URB_HM	64
  37#define N_IN_URB	4
  38#define N_OUT_URB	4
  39#define IN_BUFLEN	4096
  40
  41#define MAX_TRANSFER		(PAGE_SIZE - 512)
  42/* MAX_TRANSFER is chosen so that the VM is not stressed by
  43   allocations > PAGE_SIZE and the number of packets in a page
  44   is an integer 512 is the largest possible packet on EHCI */
  45
  46static bool nmea;
  47
  48/* Used in interface blacklisting */
  49struct sierra_iface_info {
  50	const u32 infolen;	/* number of interface numbers on blacklist */
  51	const u8  *ifaceinfo;	/* pointer to the array holding the numbers */
  52};
  53
  54struct sierra_intf_private {
  55	spinlock_t susp_lock;
  56	unsigned int suspended:1;
  57	int in_flight;
  58	unsigned int open_ports;
  59};
  60
  61static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
  62{
  63	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  64			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
  65			USB_TYPE_VENDOR,		/* __u8 request type */
  66			swiState,			/* __u16 value       */
  67			0,				/* __u16 index       */
  68			NULL,				/* void *data        */
  69			0,				/* __u16 size 	     */
  70			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
  71}
  72
  73static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
  74{
  75	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  76			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
  77			USB_TYPE_VENDOR,		/* __u8 request type */
  78			enable,				/* __u16 value       */
  79			0x0000,				/* __u16 index       */
  80			NULL,				/* void *data        */
  81			0,				/* __u16 size 	     */
  82			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
  83}
  84
  85static int sierra_calc_num_ports(struct usb_serial *serial,
  86					struct usb_serial_endpoints *epds)
  87{
  88	int num_ports = 0;
  89	u8 ifnum, numendpoints;
  90
  91	ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
  92	numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
  93
  94	/* Dummy interface present on some SKUs should be ignored */
  95	if (ifnum == 0x99)
  96		num_ports = 0;
  97	else if (numendpoints <= 3)
  98		num_ports = 1;
  99	else
 100		num_ports = (numendpoints-1)/2;
 101	return num_ports;
 102}
 103
 104static int is_blacklisted(const u8 ifnum,
 105				const struct sierra_iface_info *blacklist)
 106{
 107	const u8  *info;
 108	int i;
 109
 110	if (blacklist) {
 111		info = blacklist->ifaceinfo;
 112
 113		for (i = 0; i < blacklist->infolen; i++) {
 114			if (info[i] == ifnum)
 115				return 1;
 116		}
 117	}
 118	return 0;
 119}
 120
 121static int is_himemory(const u8 ifnum,
 122				const struct sierra_iface_info *himemorylist)
 123{
 124	const u8  *info;
 125	int i;
 126
 127	if (himemorylist) {
 128		info = himemorylist->ifaceinfo;
 129
 130		for (i=0; i < himemorylist->infolen; i++) {
 131			if (info[i] == ifnum)
 132				return 1;
 133		}
 134	}
 135	return 0;
 136}
 137
 138static u8 sierra_interface_num(struct usb_serial *serial)
 139{
 140	return serial->interface->cur_altsetting->desc.bInterfaceNumber;
 141}
 142
 143static int sierra_probe(struct usb_serial *serial,
 144			const struct usb_device_id *id)
 145{
 
 146	int result = 0;
 147	struct usb_device *udev;
 148	u8 ifnum;
 149
 150	udev = serial->dev;
 151	ifnum = sierra_interface_num(serial);
 152
 153	/*
 154	 * If this interface supports more than 1 alternate
 155	 * select the 2nd one
 156	 */
 157	if (serial->interface->num_altsetting == 2) {
 158		dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
 159			ifnum);
 160		/* We know the alternate setting is 1 for the MC8785 */
 161		usb_set_interface(udev, ifnum, 1);
 162	}
 163
 164	if (is_blacklisted(ifnum,
 165				(struct sierra_iface_info *)id->driver_info)) {
 166		dev_dbg(&serial->dev->dev,
 167			"Ignoring blacklisted interface #%d\n", ifnum);
 168		return -ENODEV;
 169	}
 170
 171	return result;
 172}
 173
 174/* interfaces with higher memory requirements */
 175static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
 176static const struct sierra_iface_info typeA_interface_list = {
 177	.infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
 178	.ifaceinfo = hi_memory_typeA_ifaces,
 179};
 180
 181static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
 182static const struct sierra_iface_info typeB_interface_list = {
 183	.infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
 184	.ifaceinfo = hi_memory_typeB_ifaces,
 185};
 186
 187/* 'blacklist' of interfaces not served by this driver */
 188static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
 189static const struct sierra_iface_info direct_ip_interface_blacklist = {
 190	.infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
 191	.ifaceinfo = direct_ip_non_serial_ifaces,
 192};
 193
 194static const struct usb_device_id id_table[] = {
 195	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
 196	{ USB_DEVICE(0x03F0, 0x1B1D) },	/* HP ev2200 a.k.a MC5720 */
 197	{ USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
 198	{ USB_DEVICE(0x03F0, 0x1E1D) },	/* HP hs2300 a.k.a MC8775 */
 199
 200	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
 201	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
 202	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
 203	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
 204	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
 205	{ USB_DEVICE(0x1199, 0x0022) },	/* Sierra Wireless EM5725 */
 206	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
 207	{ USB_DEVICE(0x1199, 0x0224) },	/* Sierra Wireless MC5727 */
 208	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
 209	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
 210	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
 211	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
 212	{ USB_DEVICE(0x1199, 0x0301) },	/* Sierra Wireless USB Dongle 250U */
 213	/* Sierra Wireless C597 */
 214	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
 215	/* Sierra Wireless T598 */
 216	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
 217	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
 218	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
 219	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
 220	{ USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
 221
 222	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
 223	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
 224	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
 225	{ USB_DEVICE(0x1199, 0x6805) },	/* Sierra Wireless MC8765 */
 226	{ USB_DEVICE(0x1199, 0x6808) },	/* Sierra Wireless MC8755 */
 227	{ USB_DEVICE(0x1199, 0x6809) },	/* Sierra Wireless MC8765 */
 228	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
 229	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 */
 230	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
 231	{ USB_DEVICE(0x1199, 0x6816) },	/* Sierra Wireless MC8775 */
 232	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
 233	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
 234	{ USB_DEVICE(0x1199, 0x6822) },	/* Sierra Wireless AirCard 875E */
 235	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
 236	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
 237	{ USB_DEVICE(0x1199, 0x6834) },	/* Sierra Wireless MC8780 */
 238	{ USB_DEVICE(0x1199, 0x6835) },	/* Sierra Wireless MC8781 */
 239	{ USB_DEVICE(0x1199, 0x6838) },	/* Sierra Wireless MC8780 */
 240	{ USB_DEVICE(0x1199, 0x6839) },	/* Sierra Wireless MC8781 */
 241	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
 242	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
 243	/* Sierra Wireless MC8790, MC8791, MC8792 Composite */
 244	{ USB_DEVICE(0x1199, 0x683C) },
 245	{ USB_DEVICE(0x1199, 0x683D) },	/* Sierra Wireless MC8791 Composite */
 246	/* Sierra Wireless MC8790, MC8791, MC8792 */
 247	{ USB_DEVICE(0x1199, 0x683E) },
 248	{ USB_DEVICE(0x1199, 0x6850) },	/* Sierra Wireless AirCard 880 */
 249	{ USB_DEVICE(0x1199, 0x6851) },	/* Sierra Wireless AirCard 881 */
 250	{ USB_DEVICE(0x1199, 0x6852) },	/* Sierra Wireless AirCard 880 E */
 251	{ USB_DEVICE(0x1199, 0x6853) },	/* Sierra Wireless AirCard 881 E */
 252	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
 253	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
 254	{ USB_DEVICE(0x1199, 0x6859) },	/* Sierra Wireless AirCard 885 E */
 255	{ USB_DEVICE(0x1199, 0x685A) },	/* Sierra Wireless AirCard 885 E */
 256	/* Sierra Wireless C885 */
 257	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
 258	/* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
 259	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
 260	/* Sierra Wireless C22/C33 */
 261	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
 262	/* Sierra Wireless HSPA Non-Composite Device */
 263	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
 264	{ USB_DEVICE(0x1199, 0x6893) },	/* Sierra Wireless Device */
 265	/* Sierra Wireless Direct IP modems */
 266	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
 267	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
 268	},
 269	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68AA, 0xFF, 0xFF, 0xFF),
 270	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
 271	},
 272	{ USB_DEVICE(0x1199, 0x68AB) }, /* Sierra Wireless AR8550 */
 273	/* AT&T Direct IP LTE modems */
 274	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
 275	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
 276	},
 277	/* Airprime/Sierra Wireless Direct IP modems */
 278	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
 279	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
 280	},
 281
 282	{ }
 283};
 284MODULE_DEVICE_TABLE(usb, id_table);
 285
 286
 287struct sierra_port_private {
 288	spinlock_t lock;	/* lock the structure */
 289	int outstanding_urbs;	/* number of out urbs in flight */
 290	struct usb_anchor active;
 291	struct usb_anchor delayed;
 292
 293	int num_out_urbs;
 294	int num_in_urbs;
 295	/* Input endpoints and buffers for this port */
 296	struct urb *in_urbs[N_IN_URB_HM];
 297
 298	/* Settings for the port */
 299	int rts_state;	/* Handshaking pins (outputs) */
 300	int dtr_state;
 301	int cts_state;	/* Handshaking pins (inputs) */
 302	int dsr_state;
 303	int dcd_state;
 304	int ri_state;
 305};
 306
 307static int sierra_send_setup(struct usb_serial_port *port)
 308{
 309	struct usb_serial *serial = port->serial;
 310	struct sierra_port_private *portdata;
 311	__u16 interface = 0;
 312	int val = 0;
 313	int do_send = 0;
 314	int retval;
 315
 316	portdata = usb_get_serial_port_data(port);
 317
 318	if (portdata->dtr_state)
 319		val |= 0x01;
 320	if (portdata->rts_state)
 321		val |= 0x02;
 322
 323	/* If composite device then properly report interface */
 324	if (serial->num_ports == 1) {
 325		interface = sierra_interface_num(serial);
 326		/* Control message is sent only to interfaces with
 327		 * interrupt_in endpoints
 328		 */
 329		if (port->interrupt_in_urb) {
 330			/* send control message */
 331			do_send = 1;
 332		}
 333	}
 334
 335	/* Otherwise the need to do non-composite mapping */
 336	else {
 337		if (port->bulk_out_endpointAddress == 2)
 338			interface = 0;
 339		else if (port->bulk_out_endpointAddress == 4)
 340			interface = 1;
 341		else if (port->bulk_out_endpointAddress == 5)
 342			interface = 2;
 343
 344		do_send = 1;
 345	}
 346	if (!do_send)
 347		return 0;
 348
 349	retval = usb_autopm_get_interface(serial->interface);
 350	if (retval < 0)
 351		return retval;
 352
 353	retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 354		0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
 355	usb_autopm_put_interface(serial->interface);
 356
 357	return retval;
 358}
 359
 360static int sierra_tiocmget(struct tty_struct *tty)
 361{
 362	struct usb_serial_port *port = tty->driver_data;
 363	unsigned int value;
 364	struct sierra_port_private *portdata;
 365
 366	portdata = usb_get_serial_port_data(port);
 367
 368	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
 369		((portdata->dtr_state) ? TIOCM_DTR : 0) |
 370		((portdata->cts_state) ? TIOCM_CTS : 0) |
 371		((portdata->dsr_state) ? TIOCM_DSR : 0) |
 372		((portdata->dcd_state) ? TIOCM_CAR : 0) |
 373		((portdata->ri_state) ? TIOCM_RNG : 0);
 374
 375	return value;
 376}
 377
 378static int sierra_tiocmset(struct tty_struct *tty,
 379			unsigned int set, unsigned int clear)
 380{
 381	struct usb_serial_port *port = tty->driver_data;
 382	struct sierra_port_private *portdata;
 383
 384	portdata = usb_get_serial_port_data(port);
 385
 386	if (set & TIOCM_RTS)
 387		portdata->rts_state = 1;
 388	if (set & TIOCM_DTR)
 389		portdata->dtr_state = 1;
 390
 391	if (clear & TIOCM_RTS)
 392		portdata->rts_state = 0;
 393	if (clear & TIOCM_DTR)
 394		portdata->dtr_state = 0;
 395	return sierra_send_setup(port);
 396}
 397
 398static void sierra_release_urb(struct urb *urb)
 399{
 400	if (urb) {
 401		kfree(urb->transfer_buffer);
 402		usb_free_urb(urb);
 403	}
 404}
 405
 406static void sierra_outdat_callback(struct urb *urb)
 407{
 408	struct usb_serial_port *port = urb->context;
 409	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 410	struct sierra_intf_private *intfdata;
 411	int status = urb->status;
 
 412
 413	intfdata = usb_get_serial_data(port->serial);
 414
 415	/* free up the transfer buffer, as usb_free_urb() does not do this */
 416	kfree(urb->transfer_buffer);
 417	usb_autopm_put_interface_async(port->serial->interface);
 418	if (status)
 419		dev_dbg(&port->dev, "%s - nonzero write bulk status "
 420		    "received: %d\n", __func__, status);
 421
 422	spin_lock(&portdata->lock);
 423	--portdata->outstanding_urbs;
 424	spin_unlock(&portdata->lock);
 425	spin_lock(&intfdata->susp_lock);
 426	--intfdata->in_flight;
 427	spin_unlock(&intfdata->susp_lock);
 428
 429	usb_serial_port_softint(port);
 430}
 431
 432/* Write */
 433static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
 434					const unsigned char *buf, int count)
 435{
 436	struct sierra_port_private *portdata;
 437	struct sierra_intf_private *intfdata;
 438	struct usb_serial *serial = port->serial;
 439	unsigned long flags;
 440	unsigned char *buffer;
 441	struct urb *urb;
 442	size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
 443	int retval = 0;
 444
 445	/* verify that we actually have some data to write */
 446	if (count == 0)
 447		return 0;
 448
 449	portdata = usb_get_serial_port_data(port);
 450	intfdata = usb_get_serial_data(serial);
 451
 452	dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
 453	spin_lock_irqsave(&portdata->lock, flags);
 454	dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
 455		portdata->outstanding_urbs);
 456	if (portdata->outstanding_urbs > portdata->num_out_urbs) {
 457		spin_unlock_irqrestore(&portdata->lock, flags);
 458		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 459		return 0;
 460	}
 461	portdata->outstanding_urbs++;
 462	dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
 463		portdata->outstanding_urbs);
 464	spin_unlock_irqrestore(&portdata->lock, flags);
 465
 466	retval = usb_autopm_get_interface_async(serial->interface);
 467	if (retval < 0) {
 468		spin_lock_irqsave(&portdata->lock, flags);
 469		portdata->outstanding_urbs--;
 470		spin_unlock_irqrestore(&portdata->lock, flags);
 471		goto error_simple;
 472	}
 473
 474	buffer = kmalloc(writesize, GFP_ATOMIC);
 475	if (!buffer) {
 476		retval = -ENOMEM;
 477		goto error_no_buffer;
 478	}
 479
 480	urb = usb_alloc_urb(0, GFP_ATOMIC);
 481	if (!urb) {
 482		retval = -ENOMEM;
 483		goto error_no_urb;
 484	}
 485
 486	memcpy(buffer, buf, writesize);
 487
 488	usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
 489
 490	usb_fill_bulk_urb(urb, serial->dev,
 491			  usb_sndbulkpipe(serial->dev,
 492					  port->bulk_out_endpointAddress),
 493			  buffer, writesize, sierra_outdat_callback, port);
 494
 495	/* Handle the need to send a zero length packet */
 496	urb->transfer_flags |= URB_ZERO_PACKET;
 497
 498	spin_lock_irqsave(&intfdata->susp_lock, flags);
 499
 500	if (intfdata->suspended) {
 501		usb_anchor_urb(urb, &portdata->delayed);
 502		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 503		goto skip_power;
 504	} else {
 505		usb_anchor_urb(urb, &portdata->active);
 506	}
 507	/* send it down the pipe */
 508	retval = usb_submit_urb(urb, GFP_ATOMIC);
 509	if (retval) {
 510		usb_unanchor_urb(urb);
 511		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 512		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
 513			"with status = %d\n", __func__, retval);
 514		goto error;
 515	} else {
 516		intfdata->in_flight++;
 517		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
 518	}
 519
 520skip_power:
 521	/* we are done with this urb, so let the host driver
 522	 * really free it when it is finished with it */
 523	usb_free_urb(urb);
 524
 525	return writesize;
 526error:
 527	usb_free_urb(urb);
 528error_no_urb:
 529	kfree(buffer);
 530error_no_buffer:
 531	spin_lock_irqsave(&portdata->lock, flags);
 532	--portdata->outstanding_urbs;
 533	dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
 534		portdata->outstanding_urbs);
 535	spin_unlock_irqrestore(&portdata->lock, flags);
 536	usb_autopm_put_interface_async(serial->interface);
 537error_simple:
 538	return retval;
 539}
 540
 541static void sierra_indat_callback(struct urb *urb)
 542{
 543	int err;
 544	int endpoint;
 545	struct usb_serial_port *port;
 546	unsigned char *data = urb->transfer_buffer;
 547	int status = urb->status;
 548
 549	endpoint = usb_pipeendpoint(urb->pipe);
 550	port = urb->context;
 551
 552	if (status) {
 553		dev_dbg(&port->dev, "%s: nonzero status: %d on"
 554			" endpoint %02x\n", __func__, status, endpoint);
 555	} else {
 556		if (urb->actual_length) {
 557			tty_insert_flip_string(&port->port, data,
 558				urb->actual_length);
 559			tty_flip_buffer_push(&port->port);
 560
 561			usb_serial_debug_data(&port->dev, __func__,
 562					      urb->actual_length, data);
 563		} else {
 564			dev_dbg(&port->dev, "%s: empty read urb"
 565				" received\n", __func__);
 566		}
 567	}
 568
 569	/* Resubmit urb so we continue receiving */
 570	if (status != -ESHUTDOWN && status != -EPERM) {
 571		usb_mark_last_busy(port->serial->dev);
 572		err = usb_submit_urb(urb, GFP_ATOMIC);
 573		if (err && err != -EPERM)
 574			dev_err(&port->dev, "resubmit read urb failed."
 575				"(%d)\n", err);
 576	}
 577}
 578
 579static void sierra_instat_callback(struct urb *urb)
 580{
 581	int err;
 582	int status = urb->status;
 583	struct usb_serial_port *port =  urb->context;
 584	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 585	struct usb_serial *serial = port->serial;
 586
 587	dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
 588		urb, port, portdata);
 589
 590	if (status == 0) {
 591		struct usb_ctrlrequest *req_pkt =
 592				(struct usb_ctrlrequest *)urb->transfer_buffer;
 593
 594		if (!req_pkt) {
 595			dev_dbg(&port->dev, "%s: NULL req_pkt\n",
 596				__func__);
 597			return;
 598		}
 599		if ((req_pkt->bRequestType == 0xA1) &&
 600				(req_pkt->bRequest == 0x20)) {
 601			int old_dcd_state;
 602			unsigned char signals = *((unsigned char *)
 603					urb->transfer_buffer +
 604					sizeof(struct usb_ctrlrequest));
 605
 606			dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
 607				signals);
 608
 609			old_dcd_state = portdata->dcd_state;
 610			portdata->cts_state = 1;
 611			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
 612			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
 613			portdata->ri_state = ((signals & 0x08) ? 1 : 0);
 614
 615			if (old_dcd_state && !portdata->dcd_state)
 616				tty_port_tty_hangup(&port->port, true);
 617		} else {
 618			dev_dbg(&port->dev, "%s: type %x req %x\n",
 619				__func__, req_pkt->bRequestType,
 620				req_pkt->bRequest);
 621		}
 622	} else
 623		dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
 624
 625	/* Resubmit urb so we continue receiving IRQ data */
 626	if (status != -ESHUTDOWN && status != -ENOENT) {
 627		usb_mark_last_busy(serial->dev);
 628		err = usb_submit_urb(urb, GFP_ATOMIC);
 629		if (err && err != -EPERM)
 630			dev_err(&port->dev, "%s: resubmit intr urb "
 631				"failed. (%d)\n", __func__, err);
 632	}
 633}
 634
 635static int sierra_write_room(struct tty_struct *tty)
 636{
 637	struct usb_serial_port *port = tty->driver_data;
 638	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 639	unsigned long flags;
 640
 641	/* try to give a good number back based on if we have any free urbs at
 642	 * this point in time */
 643	spin_lock_irqsave(&portdata->lock, flags);
 644	if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
 645		spin_unlock_irqrestore(&portdata->lock, flags);
 646		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 647		return 0;
 648	}
 649	spin_unlock_irqrestore(&portdata->lock, flags);
 650
 651	return 2048;
 652}
 653
 654static int sierra_chars_in_buffer(struct tty_struct *tty)
 655{
 656	struct usb_serial_port *port = tty->driver_data;
 657	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 658	unsigned long flags;
 659	int chars;
 660
 661	/* NOTE: This overcounts somewhat. */
 662	spin_lock_irqsave(&portdata->lock, flags);
 663	chars = portdata->outstanding_urbs * MAX_TRANSFER;
 664	spin_unlock_irqrestore(&portdata->lock, flags);
 665
 666	dev_dbg(&port->dev, "%s - %d\n", __func__, chars);
 667
 668	return chars;
 669}
 670
 671static void sierra_stop_rx_urbs(struct usb_serial_port *port)
 672{
 673	int i;
 674	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 675
 676	for (i = 0; i < portdata->num_in_urbs; i++)
 677		usb_kill_urb(portdata->in_urbs[i]);
 678
 679	usb_kill_urb(port->interrupt_in_urb);
 680}
 681
 682static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
 683{
 684	int ok_cnt;
 685	int err = -EINVAL;
 686	int i;
 687	struct urb *urb;
 688	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 689
 690	ok_cnt = 0;
 691	for (i = 0; i < portdata->num_in_urbs; i++) {
 692		urb = portdata->in_urbs[i];
 693		if (!urb)
 694			continue;
 695		err = usb_submit_urb(urb, mem_flags);
 696		if (err) {
 697			dev_err(&port->dev, "%s: submit urb failed: %d\n",
 698				__func__, err);
 699		} else {
 700			ok_cnt++;
 701		}
 702	}
 703
 704	if (ok_cnt && port->interrupt_in_urb) {
 705		err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
 706		if (err) {
 707			dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
 708				__func__, err);
 709		}
 710	}
 711
 712	if (ok_cnt > 0) /* at least one rx urb submitted */
 713		return 0;
 714	else
 715		return err;
 716}
 717
 718static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
 719					int dir, void *ctx, int len,
 720					gfp_t mem_flags,
 721					usb_complete_t callback)
 722{
 723	struct urb	*urb;
 724	u8		*buf;
 725
 726	urb = usb_alloc_urb(0, mem_flags);
 727	if (!urb)
 728		return NULL;
 729
 730	buf = kmalloc(len, mem_flags);
 731	if (buf) {
 732		/* Fill URB using supplied data */
 733		usb_fill_bulk_urb(urb, serial->dev,
 734			usb_sndbulkpipe(serial->dev, endpoint) | dir,
 735			buf, len, callback, ctx);
 736
 737		dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
 738				dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
 739	} else {
 740		sierra_release_urb(urb);
 741		urb = NULL;
 742	}
 743
 744	return urb;
 745}
 746
 747static void sierra_close(struct usb_serial_port *port)
 748{
 749	int i;
 750	struct usb_serial *serial = port->serial;
 751	struct sierra_port_private *portdata;
 752	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 753	struct urb *urb;
 754
 755	portdata = usb_get_serial_port_data(port);
 756
 757	/*
 758	 * Need to take susp_lock to make sure port is not already being
 759	 * resumed, but no need to hold it due to initialized
 
 760	 */
 761	spin_lock_irq(&intfdata->susp_lock);
 762	if (--intfdata->open_ports == 0)
 763		serial->interface->needs_remote_wakeup = 0;
 764	spin_unlock_irq(&intfdata->susp_lock);
 765
 766	for (;;) {
 767		urb = usb_get_from_anchor(&portdata->delayed);
 768		if (!urb)
 769			break;
 770		kfree(urb->transfer_buffer);
 771		usb_free_urb(urb);
 772		usb_autopm_put_interface_async(serial->interface);
 773		spin_lock(&portdata->lock);
 774		portdata->outstanding_urbs--;
 775		spin_unlock(&portdata->lock);
 776	}
 777
 778	sierra_stop_rx_urbs(port);
 779	usb_kill_anchored_urbs(&portdata->active);
 780
 781	for (i = 0; i < portdata->num_in_urbs; i++) {
 782		sierra_release_urb(portdata->in_urbs[i]);
 783		portdata->in_urbs[i] = NULL;
 784	}
 785
 786	usb_autopm_get_interface_no_resume(serial->interface);
 787}
 788
 789static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
 790{
 791	struct sierra_port_private *portdata;
 792	struct usb_serial *serial = port->serial;
 793	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 794	int i;
 795	int err;
 796	int endpoint;
 797	struct urb *urb;
 798
 799	portdata = usb_get_serial_port_data(port);
 800
 801	endpoint = port->bulk_in_endpointAddress;
 802	for (i = 0; i < portdata->num_in_urbs; i++) {
 803		urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
 804					IN_BUFLEN, GFP_KERNEL,
 805					sierra_indat_callback);
 806		portdata->in_urbs[i] = urb;
 807	}
 808	/* clear halt condition */
 809	usb_clear_halt(serial->dev,
 810			usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
 811
 812	err = sierra_submit_rx_urbs(port, GFP_KERNEL);
 813	if (err)
 814		goto err_submit;
 815
 816	spin_lock_irq(&intfdata->susp_lock);
 817	if (++intfdata->open_ports == 1)
 818		serial->interface->needs_remote_wakeup = 1;
 819	spin_unlock_irq(&intfdata->susp_lock);
 820	usb_autopm_put_interface(serial->interface);
 821
 822	return 0;
 823
 824err_submit:
 825	sierra_stop_rx_urbs(port);
 826
 827	for (i = 0; i < portdata->num_in_urbs; i++) {
 828		sierra_release_urb(portdata->in_urbs[i]);
 829		portdata->in_urbs[i] = NULL;
 830	}
 831
 832	return err;
 833}
 834
 835
 836static void sierra_dtr_rts(struct usb_serial_port *port, int on)
 837{
 838	struct sierra_port_private *portdata;
 839
 840	portdata = usb_get_serial_port_data(port);
 841	portdata->rts_state = on;
 842	portdata->dtr_state = on;
 843
 844	sierra_send_setup(port);
 845}
 846
 847static int sierra_startup(struct usb_serial *serial)
 848{
 849	struct sierra_intf_private *intfdata;
 850
 851	intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
 852	if (!intfdata)
 853		return -ENOMEM;
 854
 855	spin_lock_init(&intfdata->susp_lock);
 856
 857	usb_set_serial_data(serial, intfdata);
 858
 859	/* Set Device mode to D0 */
 860	sierra_set_power_state(serial->dev, 0x0000);
 861
 862	/* Check NMEA and set */
 863	if (nmea)
 864		sierra_vsc_set_nmea(serial->dev, 1);
 865
 866	return 0;
 867}
 868
 869static void sierra_release(struct usb_serial *serial)
 870{
 871	struct sierra_intf_private *intfdata;
 872
 873	intfdata = usb_get_serial_data(serial);
 874	kfree(intfdata);
 875}
 876
 877static int sierra_port_probe(struct usb_serial_port *port)
 878{
 879	struct usb_serial *serial = port->serial;
 880	struct sierra_port_private *portdata;
 881	const struct sierra_iface_info *himemoryp;
 882	u8 ifnum;
 883
 884	portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
 885	if (!portdata)
 886		return -ENOMEM;
 887
 888	spin_lock_init(&portdata->lock);
 889	init_usb_anchor(&portdata->active);
 890	init_usb_anchor(&portdata->delayed);
 891
 892	/* Assume low memory requirements */
 893	portdata->num_out_urbs = N_OUT_URB;
 894	portdata->num_in_urbs  = N_IN_URB;
 895
 896	/* Determine actual memory requirements */
 897	if (serial->num_ports == 1) {
 898		/* Get interface number for composite device */
 899		ifnum = sierra_interface_num(serial);
 900		himemoryp = &typeB_interface_list;
 901	} else {
 902		/* This is really the usb-serial port number of the interface
 903		 * rather than the interface number.
 904		 */
 905		ifnum = port->port_number;
 906		himemoryp = &typeA_interface_list;
 907	}
 908
 909	if (is_himemory(ifnum, himemoryp)) {
 910		portdata->num_out_urbs = N_OUT_URB_HM;
 911		portdata->num_in_urbs  = N_IN_URB_HM;
 912	}
 913
 914	dev_dbg(&port->dev,
 915			"Memory usage (urbs) interface #%d, in=%d, out=%d\n",
 916			ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
 917
 918	usb_set_serial_port_data(port, portdata);
 919
 920	return 0;
 921}
 922
 923static int sierra_port_remove(struct usb_serial_port *port)
 924{
 925	struct sierra_port_private *portdata;
 926
 927	portdata = usb_get_serial_port_data(port);
 928	usb_set_serial_port_data(port, NULL);
 929	kfree(portdata);
 930
 931	return 0;
 932}
 933
 934#ifdef CONFIG_PM
 935static void stop_read_write_urbs(struct usb_serial *serial)
 936{
 937	int i;
 938	struct usb_serial_port *port;
 939	struct sierra_port_private *portdata;
 940
 941	/* Stop reading/writing urbs */
 942	for (i = 0; i < serial->num_ports; ++i) {
 943		port = serial->port[i];
 944		portdata = usb_get_serial_port_data(port);
 945		if (!portdata)
 946			continue;
 947		sierra_stop_rx_urbs(port);
 948		usb_kill_anchored_urbs(&portdata->active);
 949	}
 950}
 951
 952static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
 953{
 954	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
 955
 956	spin_lock_irq(&intfdata->susp_lock);
 957	if (PMSG_IS_AUTO(message)) {
 958		if (intfdata->in_flight) {
 959			spin_unlock_irq(&intfdata->susp_lock);
 960			return -EBUSY;
 961		}
 962	}
 963	intfdata->suspended = 1;
 964	spin_unlock_irq(&intfdata->susp_lock);
 965
 966	stop_read_write_urbs(serial);
 967
 968	return 0;
 969}
 970
 971/* Caller must hold susp_lock. */
 972static int sierra_submit_delayed_urbs(struct usb_serial_port *port)
 973{
 974	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 975	struct sierra_intf_private *intfdata;
 976	struct urb *urb;
 977	int ec = 0;
 978	int err;
 979
 980	intfdata = usb_get_serial_data(port->serial);
 981
 982	for (;;) {
 983		urb = usb_get_from_anchor(&portdata->delayed);
 984		if (!urb)
 985			break;
 986
 987		usb_anchor_urb(urb, &portdata->active);
 988		intfdata->in_flight++;
 989		err = usb_submit_urb(urb, GFP_ATOMIC);
 990		if (err) {
 991			dev_err(&port->dev, "%s - submit urb failed: %d",
 992					__func__, err);
 993			ec++;
 994			intfdata->in_flight--;
 995			usb_unanchor_urb(urb);
 996			kfree(urb->transfer_buffer);
 997			usb_free_urb(urb);
 998
 999			spin_lock(&portdata->lock);
1000			portdata->outstanding_urbs--;
1001			spin_unlock(&portdata->lock);
1002		}
1003	}
1004
1005	if (ec)
1006		return -EIO;
1007
1008	return 0;
1009}
1010
1011static int sierra_resume(struct usb_serial *serial)
1012{
1013	struct usb_serial_port *port;
1014	struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
1015	int ec = 0;
1016	int i, err;
1017
1018	spin_lock_irq(&intfdata->susp_lock);
1019	for (i = 0; i < serial->num_ports; i++) {
1020		port = serial->port[i];
1021
1022		if (!tty_port_initialized(&port->port))
1023			continue;
1024
1025		err = sierra_submit_delayed_urbs(port);
1026		if (err)
1027			ec++;
1028
1029		err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1030		if (err)
1031			ec++;
1032	}
1033	intfdata->suspended = 0;
1034	spin_unlock_irq(&intfdata->susp_lock);
1035
1036	return ec ? -EIO : 0;
1037}
1038
1039#else
1040#define sierra_suspend NULL
1041#define sierra_resume NULL
1042#endif
1043
1044static struct usb_serial_driver sierra_device = {
1045	.driver = {
1046		.owner =	THIS_MODULE,
1047		.name =		"sierra",
1048	},
1049	.description       = "Sierra USB modem",
1050	.id_table          = id_table,
1051	.calc_num_ports	   = sierra_calc_num_ports,
1052	.probe		   = sierra_probe,
1053	.open              = sierra_open,
1054	.close             = sierra_close,
1055	.dtr_rts	   = sierra_dtr_rts,
1056	.write             = sierra_write,
1057	.write_room        = sierra_write_room,
1058	.chars_in_buffer   = sierra_chars_in_buffer,
1059	.tiocmget          = sierra_tiocmget,
1060	.tiocmset          = sierra_tiocmset,
1061	.attach            = sierra_startup,
1062	.release           = sierra_release,
1063	.port_probe        = sierra_port_probe,
1064	.port_remove       = sierra_port_remove,
1065	.suspend	   = sierra_suspend,
1066	.resume		   = sierra_resume,
1067	.read_int_callback = sierra_instat_callback,
1068};
1069
1070static struct usb_serial_driver * const serial_drivers[] = {
1071	&sierra_device, NULL
1072};
1073
1074module_usb_serial_driver(serial_drivers, id_table);
1075
1076MODULE_AUTHOR(DRIVER_AUTHOR);
1077MODULE_DESCRIPTION(DRIVER_DESC);
1078MODULE_LICENSE("GPL v2");
1079
1080module_param(nmea, bool, S_IRUGO | S_IWUSR);
1081MODULE_PARM_DESC(nmea, "NMEA streaming");