sierra.c 29.1 KB
Newer Older
1
/*
K
Kevin Lloyd 已提交
2 3
  USB Driver for Sierra Wireless

4 5 6 7
  Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,

  Copyright (C) 2008, 2009  Elina Pasheva, Matthew Safar, Rory Filer
			<linux@sierrawireless.com>
K
Kevin Lloyd 已提交
8 9 10 11 12 13 14 15 16 17 18

  IMPORTANT DISCLAIMER: This driver is not commercially supported by
  Sierra Wireless. Use at your own risk.

  This driver is free software; you can redistribute it and/or modify
  it under the terms of Version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
  Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
*/
19 20
/* Uncomment to log function calls */
/* #define DEBUG */
21

22
#define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
K
Kevin Lloyd 已提交
23
#define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
24 25

#include <linux/kernel.h>
K
Kevin Lloyd 已提交
26 27
#include <linux/jiffies.h>
#include <linux/errno.h>
28
#include <linux/tty.h>
29
#include <linux/slab.h>
K
Kevin Lloyd 已提交
30
#include <linux/tty_flip.h>
31 32
#include <linux/module.h>
#include <linux/usb.h>
33
#include <linux/usb/serial.h>
34

35 36
#define SWIMS_USB_REQUEST_SetPower	0x00
#define SWIMS_USB_REQUEST_SetNmea	0x07
37

38 39 40 41
#define N_IN_URB_HM	8
#define N_OUT_URB_HM	64
#define N_IN_URB	4
#define N_OUT_URB	4
42 43
#define IN_BUFLEN	4096

44 45 46 47 48
#define MAX_TRANSFER		(PAGE_SIZE - 512)
/* MAX_TRANSFER is chosen so that the VM is not stressed by
   allocations > PAGE_SIZE and the number of packets in a page
   is an integer 512 is the largest possible packet on EHCI */

49
static bool nmea;
50

51 52 53 54 55 56
/* Used in interface blacklisting */
struct sierra_iface_info {
	const u32 infolen;	/* number of interface numbers on blacklist */
	const u8  *ifaceinfo;	/* pointer to the array holding the numbers */
};

57 58 59 60 61 62
struct sierra_intf_private {
	spinlock_t susp_lock;
	unsigned int suspended:1;
	int in_flight;
};

63
static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
64
{
65
	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
66
			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
K
Kevin Lloyd 已提交
67
			USB_TYPE_VENDOR,		/* __u8 request type */
68 69 70 71 72
			swiState,			/* __u16 value       */
			0,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
73 74
}

75
static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
76
{
77
	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
78
			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
K
Kevin Lloyd 已提交
79
			USB_TYPE_VENDOR,		/* __u8 request type */
80 81 82 83 84 85 86 87 88
			enable,				/* __u16 value       */
			0x0000,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
}

static int sierra_calc_num_ports(struct usb_serial *serial)
{
89 90
	int num_ports = 0;
	u8 ifnum, numendpoints;
91

92 93
	ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
	numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
94

95 96 97 98 99 100 101 102
	/* Dummy interface present on some SKUs should be ignored */
	if (ifnum == 0x99)
		num_ports = 0;
	else if (numendpoints <= 3)
		num_ports = 1;
	else
		num_ports = (numendpoints-1)/2;
	return num_ports;
103 104
}

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
static int is_blacklisted(const u8 ifnum,
				const struct sierra_iface_info *blacklist)
{
	const u8  *info;
	int i;

	if (blacklist) {
		info = blacklist->ifaceinfo;

		for (i = 0; i < blacklist->infolen; i++) {
			if (info[i] == ifnum)
				return 1;
		}
	}
	return 0;
}

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
static int is_himemory(const u8 ifnum,
				const struct sierra_iface_info *himemorylist)
{
	const u8  *info;
	int i;

	if (himemorylist) {
		info = himemorylist->ifaceinfo;

		for (i=0; i < himemorylist->infolen; i++) {
			if (info[i] == ifnum)
				return 1;
		}
	}
	return 0;
}

139 140
static int sierra_calc_interface(struct usb_serial *serial)
{
K
Kevin Lloyd 已提交
141 142 143
	int interface;
	struct usb_interface *p_interface;
	struct usb_host_interface *p_host_interface;
144

K
Kevin Lloyd 已提交
145 146
	/* Get the interface structure pointer from the serial struct */
	p_interface = serial->interface;
147

K
Kevin Lloyd 已提交
148 149
	/* Get a pointer to the host interface structure */
	p_host_interface = p_interface->cur_altsetting;
150

K
Kevin Lloyd 已提交
151 152 153 154
	/* read the interface descriptor for this active altsetting
	 * to find out the interface number we are on
	*/
	interface = p_host_interface->desc.bInterfaceNumber;
155

K
Kevin Lloyd 已提交
156
	return interface;
157 158
}

159 160 161 162
static int sierra_probe(struct usb_serial *serial,
			const struct usb_device_id *id)
{
	int result = 0;
163
	struct usb_device *udev;
164
	u8 ifnum;
165

166
	udev = serial->dev;
167
	ifnum = sierra_calc_interface(serial);
168

169 170 171 172 173 174 175 176 177 178
	/*
	 * If this interface supports more than 1 alternate
	 * select the 2nd one
	 */
	if (serial->interface->num_altsetting == 2) {
		dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
			ifnum);
		/* We know the alternate setting is 1 for the MC8785 */
		usb_set_interface(udev, ifnum, 1);
	}
179

180 181 182 183 184 185 186 187 188 189
	/* ifnum could have changed - by calling usb_set_interface */
	ifnum = sierra_calc_interface(serial);

	if (is_blacklisted(ifnum,
				(struct sierra_iface_info *)id->driver_info)) {
		dev_dbg(&serial->dev->dev,
			"Ignoring blacklisted interface #%d\n", ifnum);
		return -ENODEV;
	}

190
	return result;
191
}
K
Kevin Lloyd 已提交
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206
/* interfaces with higher memory requirements */
static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
static const struct sierra_iface_info typeA_interface_list = {
	.infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
	.ifaceinfo = hi_memory_typeA_ifaces,
};

static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
static const struct sierra_iface_info typeB_interface_list = {
	.infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
	.ifaceinfo = hi_memory_typeB_ifaces,
};

/* 'blacklist' of interfaces not served by this driver */
207
static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
208 209 210 211 212
static const struct sierra_iface_info direct_ip_interface_blacklist = {
	.infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
	.ifaceinfo = direct_ip_non_serial_ifaces,
};

213
static const struct usb_device_id id_table[] = {
214 215
	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
	{ USB_DEVICE(0x03F0, 0x1B1D) },	/* HP ev2200 a.k.a MC5720 */
216
	{ USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
217 218
	{ USB_DEVICE(0x03F0, 0x1E1D) },	/* HP hs2300 a.k.a MC8775 */

K
Kevin Lloyd 已提交
219
	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
220
	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
K
Kevin Lloyd 已提交
221
	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
222
	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
223
	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
224 225 226
	{ USB_DEVICE(0x1199, 0x0022) },	/* Sierra Wireless EM5725 */
	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
	{ USB_DEVICE(0x1199, 0x0224) },	/* Sierra Wireless MC5727 */
227
	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
K
Kevin Lloyd 已提交
228
	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
229
	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
K
Kevin Lloyd 已提交
230
	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
231
	{ USB_DEVICE(0x1199, 0x0301) },	/* Sierra Wireless USB Dongle 250U */
232
	/* Sierra Wireless C597 */
K
Kevin Lloyd 已提交
233
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
234
	/* Sierra Wireless T598 */
235
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
236 237 238 239
	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
	{ USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
K
Kevin Lloyd 已提交
240

241 242
	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
243 244 245 246
	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6805) },	/* Sierra Wireless MC8765 */
	{ USB_DEVICE(0x1199, 0x6808) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6809) },	/* Sierra Wireless MC8765 */
K
Kevin Lloyd 已提交
247
	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
248
	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 */
K
Kevin Lloyd 已提交
249
	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
250
	{ USB_DEVICE(0x1199, 0x6816) },	/* Sierra Wireless MC8775 */
251
	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
252
	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
253
	{ USB_DEVICE(0x1199, 0x6822) },	/* Sierra Wireless AirCard 875E */
K
Kevin Lloyd 已提交
254 255
	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
256 257 258 259
	{ USB_DEVICE(0x1199, 0x6834) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6835) },	/* Sierra Wireless MC8781 */
	{ USB_DEVICE(0x1199, 0x6838) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6839) },	/* Sierra Wireless MC8781 */
260
	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
261
	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
262 263 264 265 266
	/* Sierra Wireless MC8790, MC8791, MC8792 Composite */
	{ USB_DEVICE(0x1199, 0x683C) },
	{ USB_DEVICE(0x1199, 0x683D) },	/* Sierra Wireless MC8791 Composite */
	/* Sierra Wireless MC8790, MC8791, MC8792 */
	{ USB_DEVICE(0x1199, 0x683E) },
K
Kevin Lloyd 已提交
267 268 269 270
	{ USB_DEVICE(0x1199, 0x6850) },	/* Sierra Wireless AirCard 880 */
	{ USB_DEVICE(0x1199, 0x6851) },	/* Sierra Wireless AirCard 881 */
	{ USB_DEVICE(0x1199, 0x6852) },	/* Sierra Wireless AirCard 880 E */
	{ USB_DEVICE(0x1199, 0x6853) },	/* Sierra Wireless AirCard 881 E */
K
Kevin Lloyd 已提交
271
	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
272
	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
273 274 275 276
	{ USB_DEVICE(0x1199, 0x6859) },	/* Sierra Wireless AirCard 885 E */
	{ USB_DEVICE(0x1199, 0x685A) },	/* Sierra Wireless AirCard 885 E */
	/* Sierra Wireless C885 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
277
	/* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
278
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
279
	/* Sierra Wireless C22/C33 */
280
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
281
	/* Sierra Wireless HSPA Non-Composite Device */
282
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
283
	{ USB_DEVICE(0x1199, 0x6893) },	/* Sierra Wireless Device */
284 285
	{ USB_DEVICE(0x1199, 0x68A3), 	/* Sierra Wireless Direct IP modems */
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
286 287 288 289
	},
	/* AT&T Direct IP LTE modems */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
290
	},
291 292 293
	{ USB_DEVICE(0x0f3d, 0x68A3), 	/* Airprime/Sierra Wireless Direct IP modems */
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
	},
294

K
Kevin Lloyd 已提交
295 296
	{ }
};
297
MODULE_DEVICE_TABLE(usb, id_table);
K
Kevin Lloyd 已提交
298 299 300


struct sierra_port_private {
301 302
	spinlock_t lock;	/* lock the structure */
	int outstanding_urbs;	/* number of out urbs in flight */
303 304
	struct usb_anchor active;
	struct usb_anchor delayed;
305

306 307
	int num_out_urbs;
	int num_in_urbs;
O
Oliver Neukum 已提交
308
	/* Input endpoints and buffers for this port */
309
	struct urb *in_urbs[N_IN_URB_HM];
K
Kevin Lloyd 已提交
310 311 312 313 314 315 316 317

	/* Settings for the port */
	int rts_state;	/* Handshaking pins (outputs) */
	int dtr_state;
	int cts_state;	/* Handshaking pins (inputs) */
	int dsr_state;
	int dcd_state;
	int ri_state;
318
	unsigned int opened:1;
K
Kevin Lloyd 已提交
319 320
};

321
static int sierra_send_setup(struct usb_serial_port *port)
322
{
323 324
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
325
	__u16 interface = 0;
326
	int val = 0;
327 328
	int do_send = 0;
	int retval;
K
Kevin Lloyd 已提交
329

330
	portdata = usb_get_serial_port_data(port);
K
Kevin Lloyd 已提交
331

332 333 334 335 336 337
	if (portdata->dtr_state)
		val |= 0x01;
	if (portdata->rts_state)
		val |= 0x02;

	/* If composite device then properly report interface */
A
Alan Cox 已提交
338
	if (serial->num_ports == 1) {
339
		interface = sierra_calc_interface(serial);
A
Alan Cox 已提交
340 341 342 343 344
		/* Control message is sent only to interfaces with
		 * interrupt_in endpoints
		 */
		if (port->interrupt_in_urb) {
			/* send control message */
345
			do_send = 1;
A
Alan Cox 已提交
346 347
		}
	}
348 349 350 351 352 353 354 355 356

	/* Otherwise the need to do non-composite mapping */
	else {
		if (port->bulk_out_endpointAddress == 2)
			interface = 0;
		else if (port->bulk_out_endpointAddress == 4)
			interface = 1;
		else if (port->bulk_out_endpointAddress == 5)
			interface = 2;
357 358

		do_send = 1;
A
Alan Cox 已提交
359
	}
360 361 362
	if (!do_send)
		return 0;

363 364 365 366
	retval = usb_autopm_get_interface(serial->interface);
	if (retval < 0)
		return retval;

367 368 369 370 371
	retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
		0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
	usb_autopm_put_interface(serial->interface);

	return retval;
372 373
}

A
Alan Cox 已提交
374 375
static void sierra_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
K
Kevin Lloyd 已提交
376
{
377
	tty_termios_copy_hw(&tty->termios, old_termios);
378
	sierra_send_setup(port);
K
Kevin Lloyd 已提交
379 380
}

381
static int sierra_tiocmget(struct tty_struct *tty)
K
Kevin Lloyd 已提交
382
{
A
Alan Cox 已提交
383
	struct usb_serial_port *port = tty->driver_data;
K
Kevin Lloyd 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	unsigned int value;
	struct sierra_port_private *portdata;

	portdata = usb_get_serial_port_data(port);

	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
		((portdata->dtr_state) ? TIOCM_DTR : 0) |
		((portdata->cts_state) ? TIOCM_CTS : 0) |
		((portdata->dsr_state) ? TIOCM_DSR : 0) |
		((portdata->dcd_state) ? TIOCM_CAR : 0) |
		((portdata->ri_state) ? TIOCM_RNG : 0);

	return value;
}

399
static int sierra_tiocmset(struct tty_struct *tty,
K
Kevin Lloyd 已提交
400 401
			unsigned int set, unsigned int clear)
{
A
Alan Cox 已提交
402
	struct usb_serial_port *port = tty->driver_data;
K
Kevin Lloyd 已提交
403 404 405 406 407 408 409 410 411 412 413 414 415
	struct sierra_port_private *portdata;

	portdata = usb_get_serial_port_data(port);

	if (set & TIOCM_RTS)
		portdata->rts_state = 1;
	if (set & TIOCM_DTR)
		portdata->dtr_state = 1;

	if (clear & TIOCM_RTS)
		portdata->rts_state = 0;
	if (clear & TIOCM_DTR)
		portdata->dtr_state = 0;
416
	return sierra_send_setup(port);
K
Kevin Lloyd 已提交
417 418
}

419 420 421 422
static void sierra_release_urb(struct urb *urb)
{
	struct usb_serial_port *port;
	if (urb) {
423
		port = urb->context;
424 425 426 427 428
		kfree(urb->transfer_buffer);
		usb_free_urb(urb);
	}
}

429 430 431 432
static void sierra_outdat_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
433
	struct sierra_intf_private *intfdata;
434 435
	int status = urb->status;

436
	intfdata = port->serial->private;
437 438 439

	/* free up the transfer buffer, as usb_free_urb() does not do this */
	kfree(urb->transfer_buffer);
440
	usb_autopm_put_interface_async(port->serial->interface);
441
	if (status)
442
		dev_dbg(&port->dev, "%s - nonzero write bulk status "
443
		    "received: %d\n", __func__, status);
444

445
	spin_lock(&portdata->lock);
446
	--portdata->outstanding_urbs;
447 448 449 450
	spin_unlock(&portdata->lock);
	spin_lock(&intfdata->susp_lock);
	--intfdata->in_flight;
	spin_unlock(&intfdata->susp_lock);
451 452 453 454

	usb_serial_port_softint(port);
}

K
Kevin Lloyd 已提交
455
/* Write */
A
Alan Cox 已提交
456 457
static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
					const unsigned char *buf, int count)
K
Kevin Lloyd 已提交
458
{
459
	struct sierra_port_private *portdata;
460
	struct sierra_intf_private *intfdata;
461 462 463 464
	struct usb_serial *serial = port->serial;
	unsigned long flags;
	unsigned char *buffer;
	struct urb *urb;
465 466 467 468 469 470
	size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
	int retval = 0;

	/* verify that we actually have some data to write */
	if (count == 0)
		return 0;
K
Kevin Lloyd 已提交
471 472

	portdata = usb_get_serial_port_data(port);
473
	intfdata = serial->private;
K
Kevin Lloyd 已提交
474

475
	dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
476
	spin_lock_irqsave(&portdata->lock, flags);
477 478
	dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
479
	if (portdata->outstanding_urbs > portdata->num_out_urbs) {
480
		spin_unlock_irqrestore(&portdata->lock, flags);
481
		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
482 483 484
		return 0;
	}
	portdata->outstanding_urbs++;
485 486
	dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
487 488
	spin_unlock_irqrestore(&portdata->lock, flags);

489 490 491 492 493 494 495 496
	retval = usb_autopm_get_interface_async(serial->interface);
	if (retval < 0) {
		spin_lock_irqsave(&portdata->lock, flags);
		portdata->outstanding_urbs--;
		spin_unlock_irqrestore(&portdata->lock, flags);
		goto error_simple;
	}

497
	buffer = kmalloc(writesize, GFP_ATOMIC);
498
	if (!buffer) {
499
		retval = -ENOMEM;
500 501
		goto error_no_buffer;
	}
K
Kevin Lloyd 已提交
502

503 504
	urb = usb_alloc_urb(0, GFP_ATOMIC);
	if (!urb) {
505
		retval = -ENOMEM;
506 507
		goto error_no_urb;
	}
K
Kevin Lloyd 已提交
508

509
	memcpy(buffer, buf, writesize);
K
Kevin Lloyd 已提交
510

511
	usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
512 513 514 515

	usb_fill_bulk_urb(urb, serial->dev,
			  usb_sndbulkpipe(serial->dev,
					  port->bulk_out_endpointAddress),
516
			  buffer, writesize, sierra_outdat_callback, port);
517

518 519 520
	/* Handle the need to send a zero length packet */
	urb->transfer_flags |= URB_ZERO_PACKET;

521 522 523 524 525 526 527 528 529
	spin_lock_irqsave(&intfdata->susp_lock, flags);

	if (intfdata->suspended) {
		usb_anchor_urb(urb, &portdata->delayed);
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
		goto skip_power;
	} else {
		usb_anchor_urb(urb, &portdata->active);
	}
530
	/* send it down the pipe */
531 532
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval) {
533 534
		usb_unanchor_urb(urb);
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
535
		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
536
			"with status = %d\n", __func__, retval);
537
		goto error;
538 539 540
	} else {
		intfdata->in_flight++;
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
K
Kevin Lloyd 已提交
541 542
	}

543
skip_power:
544 545 546 547
	/* we are done with this urb, so let the host driver
	 * really free it when it is finished with it */
	usb_free_urb(urb);

548
	return writesize;
549 550 551 552 553 554 555
error:
	usb_free_urb(urb);
error_no_urb:
	kfree(buffer);
error_no_buffer:
	spin_lock_irqsave(&portdata->lock, flags);
	--portdata->outstanding_urbs;
556 557
	dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
558
	spin_unlock_irqrestore(&portdata->lock, flags);
559 560
	usb_autopm_put_interface_async(serial->interface);
error_simple:
561
	return retval;
K
Kevin Lloyd 已提交
562 563 564 565 566 567 568 569
}

static void sierra_indat_callback(struct urb *urb)
{
	int err;
	int endpoint;
	struct usb_serial_port *port;
	unsigned char *data = urb->transfer_buffer;
570
	int status = urb->status;
K
Kevin Lloyd 已提交
571 572

	endpoint = usb_pipeendpoint(urb->pipe);
573 574
	port = urb->context;

575
	if (status) {
576
		dev_dbg(&port->dev, "%s: nonzero status: %d on"
577
			" endpoint %02x\n", __func__, status, endpoint);
K
Kevin Lloyd 已提交
578 579
	} else {
		if (urb->actual_length) {
J
Jiri Slaby 已提交
580 581 582 583 584 585
			tty_insert_flip_string(&port->port, data,
				urb->actual_length);
			tty_flip_buffer_push(&port->port);

			usb_serial_debug_data(&port->dev, __func__,
					      urb->actual_length, data);
586
		} else {
587
			dev_dbg(&port->dev, "%s: empty read urb"
588
				" received\n", __func__);
K
Kevin Lloyd 已提交
589 590
		}
	}
591 592

	/* Resubmit urb so we continue receiving */
593
	if (status != -ESHUTDOWN && status != -EPERM) {
594
		usb_mark_last_busy(port->serial->dev);
595
		err = usb_submit_urb(urb, GFP_ATOMIC);
596
		if (err && err != -EPERM)
597 598 599
			dev_err(&port->dev, "resubmit read urb failed."
				"(%d)\n", err);
	}
K
Kevin Lloyd 已提交
600 601 602 603 604
}

static void sierra_instat_callback(struct urb *urb)
{
	int err;
605
	int status = urb->status;
606
	struct usb_serial_port *port =  urb->context;
K
Kevin Lloyd 已提交
607 608 609
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;

610
	dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
611
		urb, port, portdata);
K
Kevin Lloyd 已提交
612

613
	if (status == 0) {
K
Kevin Lloyd 已提交
614 615 616 617
		struct usb_ctrlrequest *req_pkt =
				(struct usb_ctrlrequest *)urb->transfer_buffer;

		if (!req_pkt) {
618 619
			dev_dbg(&port->dev, "%s: NULL req_pkt\n",
				__func__);
K
Kevin Lloyd 已提交
620 621 622 623 624 625 626 627 628
			return;
		}
		if ((req_pkt->bRequestType == 0xA1) &&
				(req_pkt->bRequest == 0x20)) {
			int old_dcd_state;
			unsigned char signals = *((unsigned char *)
					urb->transfer_buffer +
					sizeof(struct usb_ctrlrequest));

629
			dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
630
				signals);
K
Kevin Lloyd 已提交
631 632 633 634 635 636 637

			old_dcd_state = portdata->dcd_state;
			portdata->cts_state = 1;
			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
			portdata->ri_state = ((signals & 0x08) ? 1 : 0);

J
Jiri Slaby 已提交
638 639
			if (old_dcd_state && !portdata->dcd_state)
				tty_port_tty_hangup(&port->port, true);
K
Kevin Lloyd 已提交
640
		} else {
641
			dev_dbg(&port->dev, "%s: type %x req %x\n",
642 643
				__func__, req_pkt->bRequestType,
				req_pkt->bRequest);
K
Kevin Lloyd 已提交
644 645
		}
	} else
646
		dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
K
Kevin Lloyd 已提交
647 648

	/* Resubmit urb so we continue receiving IRQ data */
649
	if (status != -ESHUTDOWN && status != -ENOENT) {
650
		usb_mark_last_busy(serial->dev);
K
Kevin Lloyd 已提交
651
		err = usb_submit_urb(urb, GFP_ATOMIC);
652
		if (err && err != -EPERM)
653 654
			dev_err(&port->dev, "%s: resubmit intr urb "
				"failed. (%d)\n", __func__, err);
K
Kevin Lloyd 已提交
655 656 657
	}
}

A
Alan Cox 已提交
658
static int sierra_write_room(struct tty_struct *tty)
K
Kevin Lloyd 已提交
659
{
A
Alan Cox 已提交
660
	struct usb_serial_port *port = tty->driver_data;
661 662
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	unsigned long flags;
K
Kevin Lloyd 已提交
663

664 665 666
	/* try to give a good number back based on if we have any free urbs at
	 * this point in time */
	spin_lock_irqsave(&portdata->lock, flags);
667
	if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
668
		spin_unlock_irqrestore(&portdata->lock, flags);
669
		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
670
		return 0;
K
Kevin Lloyd 已提交
671
	}
672
	spin_unlock_irqrestore(&portdata->lock, flags);
K
Kevin Lloyd 已提交
673

674
	return 2048;
K
Kevin Lloyd 已提交
675 676
}

677
static void sierra_stop_rx_urbs(struct usb_serial_port *port)
K
Kevin Lloyd 已提交
678
{
679
	int i;
680
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
K
Kevin Lloyd 已提交
681

682
	for (i = 0; i < portdata->num_in_urbs; i++)
683
		usb_kill_urb(portdata->in_urbs[i]);
K
Kevin Lloyd 已提交
684

685 686
	usb_kill_urb(port->interrupt_in_urb);
}
K
Kevin Lloyd 已提交
687

688 689 690 691 692 693 694
static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
{
	int ok_cnt;
	int err = -EINVAL;
	int i;
	struct urb *urb;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
K
Kevin Lloyd 已提交
695

696
	ok_cnt = 0;
697
	for (i = 0; i < portdata->num_in_urbs; i++) {
K
Kevin Lloyd 已提交
698
		urb = portdata->in_urbs[i];
699
		if (!urb)
K
Kevin Lloyd 已提交
700
			continue;
701 702 703 704 705 706
		err = usb_submit_urb(urb, mem_flags);
		if (err) {
			dev_err(&port->dev, "%s: submit urb failed: %d\n",
				__func__, err);
		} else {
			ok_cnt++;
K
Kevin Lloyd 已提交
707
		}
708
	}
K
Kevin Lloyd 已提交
709

710 711 712 713 714
	if (ok_cnt && port->interrupt_in_urb) {
		err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
		if (err) {
			dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
				__func__, err);
K
Kevin Lloyd 已提交
715 716 717
		}
	}

718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
	if (ok_cnt > 0) /* at least one rx urb submitted */
		return 0;
	else
		return err;
}

static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
					int dir, void *ctx, int len,
					gfp_t mem_flags,
					usb_complete_t callback)
{
	struct urb	*urb;
	u8		*buf;

	if (endpoint == -1)
		return NULL;
K
Kevin Lloyd 已提交
734

735
	urb = usb_alloc_urb(0, mem_flags);
736
	if (!urb)
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
		return NULL;

	buf = kmalloc(len, mem_flags);
	if (buf) {
		/* Fill URB using supplied data */
		usb_fill_bulk_urb(urb, serial->dev,
			usb_sndbulkpipe(serial->dev, endpoint) | dir,
			buf, len, callback, ctx);

		dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
				dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
	} else {
		sierra_release_urb(urb);
		urb = NULL;
	}

	return urb;
K
Kevin Lloyd 已提交
754 755
}

756
static void sierra_close(struct usb_serial_port *port)
K
Kevin Lloyd 已提交
757
{
758
	int i;
K
Kevin Lloyd 已提交
759 760
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
761 762
	struct sierra_intf_private *intfdata = port->serial->private;

K
Kevin Lloyd 已提交
763
	portdata = usb_get_serial_port_data(port);
764 765 766

	portdata->rts_state = 0;
	portdata->dtr_state = 0;
K
Kevin Lloyd 已提交
767

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
	mutex_lock(&serial->disc_mutex);
	if (!serial->disconnected) {
		serial->interface->needs_remote_wakeup = 0;
		/* odd error handling due to pm counters */
		if (!usb_autopm_get_interface(serial->interface))
			sierra_send_setup(port);
		else
			usb_autopm_get_interface_no_resume(serial->interface);

	}
	mutex_unlock(&serial->disc_mutex);
	spin_lock_irq(&intfdata->susp_lock);
	portdata->opened = 0;
	spin_unlock_irq(&intfdata->susp_lock);

	sierra_stop_rx_urbs(port);
	for (i = 0; i < portdata->num_in_urbs; i++) {
		sierra_release_urb(portdata->in_urbs[i]);
		portdata->in_urbs[i] = NULL;
787 788 789
	}
}

790
static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
791
{
792 793
	struct sierra_port_private *portdata;
	struct usb_serial *serial = port->serial;
794
	struct sierra_intf_private *intfdata = serial->private;
795
	int i;
796 797 798 799 800 801 802 803 804 805 806 807
	int err;
	int endpoint;
	struct urb *urb;

	portdata = usb_get_serial_port_data(port);

	/* Set some sane defaults */
	portdata->rts_state = 1;
	portdata->dtr_state = 1;


	endpoint = port->bulk_in_endpointAddress;
808
	for (i = 0; i < portdata->num_in_urbs; i++) {
809 810 811 812 813 814 815 816 817 818 819 820 821
		urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
					IN_BUFLEN, GFP_KERNEL,
					sierra_indat_callback);
		portdata->in_urbs[i] = urb;
	}
	/* clear halt condition */
	usb_clear_halt(serial->dev,
			usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);

	err = sierra_submit_rx_urbs(port, GFP_KERNEL);
	if (err) {
		/* get rid of everything as in close */
		sierra_close(port);
822
		/* restore balance for autopm */
823 824
		if (!serial->disconnected)
			usb_autopm_put_interface(serial->interface);
825 826 827 828
		return err;
	}
	sierra_send_setup(port);

829 830 831 832 833 834
	serial->interface->needs_remote_wakeup = 1;
	spin_lock_irq(&intfdata->susp_lock);
	portdata->opened = 1;
	spin_unlock_irq(&intfdata->susp_lock);
	usb_autopm_put_interface(serial->interface);

835 836 837 838 839 840
	return 0;
}


static void sierra_dtr_rts(struct usb_serial_port *port, int on)
{
841
	struct sierra_port_private *portdata;
K
Kevin Lloyd 已提交
842

843
	portdata = usb_get_serial_port_data(port);
844 845
	portdata->rts_state = on;
	portdata->dtr_state = on;
846

847
	sierra_send_setup(port);
K
Kevin Lloyd 已提交
848 849 850 851
}

static int sierra_startup(struct usb_serial *serial)
{
852
	struct sierra_intf_private *intfdata;
K
Kevin Lloyd 已提交
853

854 855 856 857 858 859 860 861
	intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
	if (!intfdata)
		return -ENOMEM;

	spin_lock_init(&intfdata->susp_lock);

	usb_set_serial_data(serial, intfdata);

862
	/* Set Device mode to D0 */
863 864
	sierra_set_power_state(serial->dev, 0x0000);

865 866 867 868
	/* Check NMEA and set */
	if (nmea)
		sierra_vsc_set_nmea(serial->dev, 1);

869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
	return 0;
}

static void sierra_release(struct usb_serial *serial)
{
	struct sierra_intf_private *intfdata;

	intfdata = usb_get_serial_data(serial);
	kfree(intfdata);
}

static int sierra_port_probe(struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
	const struct sierra_iface_info *himemoryp;
	u8 ifnum;

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

	spin_lock_init(&portdata->lock);
	init_usb_anchor(&portdata->active);
	init_usb_anchor(&portdata->delayed);

	/* Assume low memory requirements */
	portdata->num_out_urbs = N_OUT_URB;
	portdata->num_in_urbs  = N_IN_URB;

	/* Determine actual memory requirements */
	if (serial->num_ports == 1) {
		/* Get interface number for composite device */
		ifnum = sierra_calc_interface(serial);
		himemoryp = &typeB_interface_list;
	} else {
		/* This is really the usb-serial port number of the interface
		 * rather than the interface number.
		 */
908
		ifnum = port->port_number;
909
		himemoryp = &typeA_interface_list;
K
Kevin Lloyd 已提交
910 911
	}

912 913 914
	if (is_himemory(ifnum, himemoryp)) {
		portdata->num_out_urbs = N_OUT_URB_HM;
		portdata->num_in_urbs  = N_IN_URB_HM;
915 916
	}

917 918 919 920 921 922 923
	dev_dbg(&port->dev,
			"Memory usage (urbs) interface #%d, in=%d, out=%d\n",
			ifnum, portdata->num_in_urbs, portdata->num_out_urbs);

	usb_set_serial_port_data(port, portdata);

	return 0;
K
Kevin Lloyd 已提交
924 925
}

926
static int sierra_port_remove(struct usb_serial_port *port)
K
Kevin Lloyd 已提交
927 928 929
{
	struct sierra_port_private *portdata;

930 931 932 933
	portdata = usb_get_serial_port_data(port);
	kfree(portdata);

	return 0;
K
Kevin Lloyd 已提交
934 935
}

936
#ifdef CONFIG_PM
937 938
static void stop_read_write_urbs(struct usb_serial *serial)
{
939
	int i;
940 941 942 943 944 945 946
	struct usb_serial_port *port;
	struct sierra_port_private *portdata;

	/* Stop reading/writing urbs */
	for (i = 0; i < serial->num_ports; ++i) {
		port = serial->port[i];
		portdata = usb_get_serial_port_data(port);
947
		sierra_stop_rx_urbs(port);
948 949 950 951 952 953 954 955 956
		usb_kill_anchored_urbs(&portdata->active);
	}
}

static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
{
	struct sierra_intf_private *intfdata;
	int b;

957
	if (PMSG_IS_AUTO(message)) {
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
		intfdata = serial->private;
		spin_lock_irq(&intfdata->susp_lock);
		b = intfdata->in_flight;

		if (b) {
			spin_unlock_irq(&intfdata->susp_lock);
			return -EBUSY;
		} else {
			intfdata->suspended = 1;
			spin_unlock_irq(&intfdata->susp_lock);
		}
	}
	stop_read_write_urbs(serial);

	return 0;
}

static int sierra_resume(struct usb_serial *serial)
{
	struct usb_serial_port *port;
	struct sierra_intf_private *intfdata = serial->private;
	struct sierra_port_private *portdata;
	struct urb *urb;
	int ec = 0;
	int i, err;

	spin_lock_irq(&intfdata->susp_lock);
	for (i = 0; i < serial->num_ports; i++) {
		port = serial->port[i];
		portdata = usb_get_serial_port_data(port);

		while ((urb = usb_get_from_anchor(&portdata->delayed))) {
			usb_anchor_urb(urb, &portdata->active);
			intfdata->in_flight++;
			err = usb_submit_urb(urb, GFP_ATOMIC);
			if (err < 0) {
				intfdata->in_flight--;
				usb_unanchor_urb(urb);
				usb_scuttle_anchored_urbs(&portdata->delayed);
				break;
			}
		}

		if (portdata->opened) {
			err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
			if (err)
				ec++;
		}
	}
	intfdata->suspended = 0;
	spin_unlock_irq(&intfdata->susp_lock);

	return ec ? -EIO : 0;
}
1012

1013 1014 1015 1016
#else
#define sierra_suspend NULL
#define sierra_resume NULL
#endif
1017

1018
static struct usb_serial_driver sierra_device = {
1019 1020
	.driver = {
		.owner =	THIS_MODULE,
K
Kevin Lloyd 已提交
1021
		.name =		"sierra",
1022
	},
1023 1024 1025 1026
	.description       = "Sierra USB modem",
	.id_table          = id_table,
	.calc_num_ports	   = sierra_calc_num_ports,
	.probe		   = sierra_probe,
1027 1028
	.open              = sierra_open,
	.close             = sierra_close,
1029
	.dtr_rts	   = sierra_dtr_rts,
1030 1031 1032 1033 1034 1035
	.write             = sierra_write,
	.write_room        = sierra_write_room,
	.set_termios       = sierra_set_termios,
	.tiocmget          = sierra_tiocmget,
	.tiocmset          = sierra_tiocmset,
	.attach            = sierra_startup,
1036
	.release           = sierra_release,
1037 1038
	.port_probe        = sierra_port_probe,
	.port_remove       = sierra_port_remove,
1039 1040
	.suspend	   = sierra_suspend,
	.resume		   = sierra_resume,
1041 1042 1043
	.read_int_callback = sierra_instat_callback,
};

1044 1045 1046 1047
static struct usb_serial_driver * const serial_drivers[] = {
	&sierra_device, NULL
};

1048
module_usb_serial_driver(serial_drivers, id_table);
1049

K
Kevin Lloyd 已提交
1050 1051
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
1052
MODULE_LICENSE("GPL");
K
Kevin Lloyd 已提交
1053

K
Kevin Lloyd 已提交
1054
module_param(nmea, bool, S_IRUGO | S_IWUSR);
1055
MODULE_PARM_DESC(nmea, "NMEA streaming");