Linux Audio

Check our new training course

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