sierra.c 24.6 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 19

  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>
*/

20
#define DRIVER_VERSION "v.1.3.7"
21
#define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
K
Kevin Lloyd 已提交
22
#define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
23 24

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

33 34
#define SWIMS_USB_REQUEST_SetPower	0x00
#define SWIMS_USB_REQUEST_SetNmea	0x07
35

36 37
#define N_IN_URB	8
#define N_OUT_URB	64
38 39
#define IN_BUFLEN	4096

40 41 42 43 44
#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 */

45
static int debug;
46
static int nmea;
47

48 49 50 51 52 53
/* 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 */
};

54
static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
55 56
{
	int result;
57
	dev_dbg(&udev->dev, "%s\n", __func__);
58
	result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
59
			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
K
Kevin Lloyd 已提交
60
			USB_TYPE_VENDOR,		/* __u8 request type */
61 62 63 64 65
			swiState,			/* __u16 value       */
			0,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
66 67 68
	return result;
}

69
static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
70 71
{
	int result;
72
	dev_dbg(&udev->dev, "%s\n", __func__);
73 74
	result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
K
Kevin Lloyd 已提交
75
			USB_TYPE_VENDOR,		/* __u8 request type */
76 77 78 79 80 81 82 83 84 85
			enable,				/* __u16 value       */
			0x0000,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
	return result;
}

static int sierra_calc_num_ports(struct usb_serial *serial)
{
86 87
	int num_ports = 0;
	u8 ifnum, numendpoints;
88

89
	dev_dbg(&serial->dev->dev, "%s\n", __func__);
90

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

94 95 96 97 98 99 100 101
	/* 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;
102 103
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
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;
}

121 122
static int sierra_calc_interface(struct usb_serial *serial)
{
K
Kevin Lloyd 已提交
123 124 125
	int interface;
	struct usb_interface *p_interface;
	struct usb_host_interface *p_host_interface;
126
	dev_dbg(&serial->dev->dev, "%s\n", __func__);
127

K
Kevin Lloyd 已提交
128 129
	/* Get the interface structure pointer from the serial struct */
	p_interface = serial->interface;
130

K
Kevin Lloyd 已提交
131 132
	/* Get a pointer to the host interface structure */
	p_host_interface = p_interface->cur_altsetting;
133

K
Kevin Lloyd 已提交
134 135 136 137
	/* read the interface descriptor for this active altsetting
	 * to find out the interface number we are on
	*/
	interface = p_host_interface->desc.bInterfaceNumber;
138

K
Kevin Lloyd 已提交
139
	return interface;
140 141
}

142 143 144 145
static int sierra_probe(struct usb_serial *serial,
			const struct usb_device_id *id)
{
	int result = 0;
146
	struct usb_device *udev;
147
	u8 ifnum;
148

149
	udev = serial->dev;
150
	dev_dbg(&udev->dev, "%s\n", __func__);
151

152 153 154 155 156 157 158 159 160 161 162
	ifnum = sierra_calc_interface(serial);
	/*
	 * 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);
	}
163

164 165 166 167 168 169 170 171 172 173
	/* 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;
	}

174
	return result;
175
}
K
Kevin Lloyd 已提交
176

177 178 179 180 181 182
static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
static const struct sierra_iface_info direct_ip_interface_blacklist = {
	.infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
	.ifaceinfo = direct_ip_non_serial_ifaces,
};

183
static struct usb_device_id id_table [] = {
K
Kevin Lloyd 已提交
184
	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
185
	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
K
Kevin Lloyd 已提交
186
	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
187
	{ USB_DEVICE(0x03f0, 0x1b1d) }, /* HP ev2200 a.k.a MC5720 */
188
	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
K
Kevin Lloyd 已提交
189
	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
190
	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
191
	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
K
Kevin Lloyd 已提交
192
	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
K
Kevin Lloyd 已提交
193
	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
K
Kevin Lloyd 已提交
194 195
	 /* Sierra Wireless C597 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
196 197 198
	 /* Sierra Wireless Device */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless Device */
199 200
	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless Device */
	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless Device */
K
Kevin Lloyd 已提交
201

202
	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
K
Kevin Lloyd 已提交
203
	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
204
	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
K
Kevin Lloyd 已提交
205
	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
K
Kevin Lloyd 已提交
206
	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 (Lenovo) */
K
Kevin Lloyd 已提交
207
	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
208
	{ USB_DEVICE(0x03f0, 0x1e1d) },	/* HP hs2300 a.k.a MC8775 */
209
	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
210
	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
K
Kevin Lloyd 已提交
211 212
	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
213
	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
214
	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
215 216 217 218 219
	/* 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 已提交
220 221 222 223
	{ 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 已提交
224
	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
225
	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
226 227 228 229 230 231 232
	{ 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)},
	/* Sierra Wireless Device */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
	/* Sierra Wireless Device */
233 234
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
	/* Sierra Wireless Device */
235 236 237 238
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},

	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
239

240 241 242 243
	{ USB_DEVICE(0x1199, 0x68A3), 	/* Sierra Wireless Direct IP modems */
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
	},

K
Kevin Lloyd 已提交
244 245
	{ }
};
246
MODULE_DEVICE_TABLE(usb, id_table);
K
Kevin Lloyd 已提交
247

248
static struct usb_driver sierra_driver = {
K
Kevin Lloyd 已提交
249
	.name       = "sierra",
250
	.probe      = usb_serial_probe,
K
Kevin Lloyd 已提交
251 252
	.disconnect = usb_serial_disconnect,
	.id_table   = id_table,
253
	.no_dynamic_id = 	1,
K
Kevin Lloyd 已提交
254 255 256
};

struct sierra_port_private {
257 258 259
	spinlock_t lock;	/* lock the structure */
	int outstanding_urbs;	/* number of out urbs in flight */

O
Oliver Neukum 已提交
260
	/* Input endpoints and buffers for this port */
K
Kevin Lloyd 已提交
261 262 263 264 265 266 267 268 269 270 271
	struct urb *in_urbs[N_IN_URB];

	/* 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;
};

272
static int sierra_send_setup(struct usb_serial_port *port)
273
{
274 275
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
276
	__u16 interface = 0;
277
	int val = 0;
K
Kevin Lloyd 已提交
278

279
	dev_dbg(&port->dev, "%s\n", __func__);
K
Kevin Lloyd 已提交
280

281
	portdata = usb_get_serial_port_data(port);
K
Kevin Lloyd 已提交
282

283 284 285 286 287 288
	if (portdata->dtr_state)
		val |= 0x01;
	if (portdata->rts_state)
		val |= 0x02;

	/* If composite device then properly report interface */
A
Alan Cox 已提交
289
	if (serial->num_ports == 1) {
290
		interface = sierra_calc_interface(serial);
A
Alan Cox 已提交
291 292 293 294 295 296 297 298 299 300 301
		/* Control message is sent only to interfaces with
		 * interrupt_in endpoints
		 */
		if (port->interrupt_in_urb) {
			/* send control message */
			return usb_control_msg(serial->dev,
				usb_rcvctrlpipe(serial->dev, 0),
				0x22, 0x21, val, interface,
				NULL, 0, USB_CTRL_SET_TIMEOUT);
		}
	}
302 303 304 305 306 307 308 309 310

	/* 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;
A
Alan Cox 已提交
311
		return usb_control_msg(serial->dev,
312 313 314
			usb_rcvctrlpipe(serial->dev, 0),
			0x22, 0x21, val, interface,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
A
Alan Cox 已提交
315
	}
316
	return 0;
317 318
}

A
Alan Cox 已提交
319 320
static void sierra_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
K
Kevin Lloyd 已提交
321
{
322
	dev_dbg(&port->dev, "%s\n", __func__);
A
Alan Cox 已提交
323
	tty_termios_copy_hw(tty->termios, old_termios);
324
	sierra_send_setup(port);
K
Kevin Lloyd 已提交
325 326
}

A
Alan Cox 已提交
327
static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
K
Kevin Lloyd 已提交
328
{
A
Alan Cox 已提交
329
	struct usb_serial_port *port = tty->driver_data;
K
Kevin Lloyd 已提交
330 331 332
	unsigned int value;
	struct sierra_port_private *portdata;

333
	dev_dbg(&port->dev, "%s\n", __func__);
K
Kevin Lloyd 已提交
334 335 336 337 338 339 340 341 342 343 344 345
	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;
}

A
Alan Cox 已提交
346
static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
K
Kevin Lloyd 已提交
347 348
			unsigned int set, unsigned int clear)
{
A
Alan Cox 已提交
349
	struct usb_serial_port *port = tty->driver_data;
K
Kevin Lloyd 已提交
350 351 352 353 354 355 356 357 358 359 360 361 362
	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;
363
	return sierra_send_setup(port);
K
Kevin Lloyd 已提交
364 365
}

366 367 368 369 370 371 372 373 374 375 376
static void sierra_release_urb(struct urb *urb)
{
	struct usb_serial_port *port;
	if (urb) {
		port =  urb->context;
		dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
		kfree(urb->transfer_buffer);
		usb_free_urb(urb);
	}
}

377 378 379 380 381 382 383
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);
	int status = urb->status;
	unsigned long flags;

384
	dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
385 386 387 388 389

	/* free up the transfer buffer, as usb_free_urb() does not do this */
	kfree(urb->transfer_buffer);

	if (status)
390
		dev_dbg(&port->dev, "%s - nonzero write bulk status "
391
		    "received: %d\n", __func__, status);
392 393 394 395 396 397 398 399

	spin_lock_irqsave(&portdata->lock, flags);
	--portdata->outstanding_urbs;
	spin_unlock_irqrestore(&portdata->lock, flags);

	usb_serial_port_softint(port);
}

K
Kevin Lloyd 已提交
400
/* Write */
A
Alan Cox 已提交
401 402
static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
					const unsigned char *buf, int count)
K
Kevin Lloyd 已提交
403
{
404 405 406 407 408
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;
	unsigned long flags;
	unsigned char *buffer;
	struct urb *urb;
409 410 411 412 413 414
	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 已提交
415 416 417

	portdata = usb_get_serial_port_data(port);

418
	dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
K
Kevin Lloyd 已提交
419

420
	spin_lock_irqsave(&portdata->lock, flags);
421 422
	dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
423 424
	if (portdata->outstanding_urbs > N_OUT_URB) {
		spin_unlock_irqrestore(&portdata->lock, flags);
425
		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
426 427 428
		return 0;
	}
	portdata->outstanding_urbs++;
429 430
	dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
431 432
	spin_unlock_irqrestore(&portdata->lock, flags);

433
	buffer = kmalloc(writesize, GFP_ATOMIC);
434 435
	if (!buffer) {
		dev_err(&port->dev, "out of memory\n");
436
		retval = -ENOMEM;
437 438
		goto error_no_buffer;
	}
K
Kevin Lloyd 已提交
439

440 441 442
	urb = usb_alloc_urb(0, GFP_ATOMIC);
	if (!urb) {
		dev_err(&port->dev, "no more free urbs\n");
443
		retval = -ENOMEM;
444 445
		goto error_no_urb;
	}
K
Kevin Lloyd 已提交
446

447
	memcpy(buffer, buf, writesize);
K
Kevin Lloyd 已提交
448

449
	usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
450 451 452 453

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

456 457 458
	/* Handle the need to send a zero length packet */
	urb->transfer_flags |= URB_ZERO_PACKET;

459
	/* send it down the pipe */
460 461
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval) {
462
		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
463
			"with status = %d\n", __func__, retval);
464
		goto error;
K
Kevin Lloyd 已提交
465 466
	}

467 468 469 470
	/* we are done with this urb, so let the host driver
	 * really free it when it is finished with it */
	usb_free_urb(urb);

471
	return writesize;
472 473 474 475 476 477 478
error:
	usb_free_urb(urb);
error_no_urb:
	kfree(buffer);
error_no_buffer:
	spin_lock_irqsave(&portdata->lock, flags);
	--portdata->outstanding_urbs;
479 480
	dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
		portdata->outstanding_urbs);
481
	spin_unlock_irqrestore(&portdata->lock, flags);
482
	return retval;
K
Kevin Lloyd 已提交
483 484 485 486 487 488 489 490 491
}

static void sierra_indat_callback(struct urb *urb)
{
	int err;
	int endpoint;
	struct usb_serial_port *port;
	struct tty_struct *tty;
	unsigned char *data = urb->transfer_buffer;
492
	int status = urb->status;
K
Kevin Lloyd 已提交
493 494

	endpoint = usb_pipeendpoint(urb->pipe);
495 496 497
	port = urb->context;

	dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
K
Kevin Lloyd 已提交
498

499
	if (status) {
500
		dev_dbg(&port->dev, "%s: nonzero status: %d on"
501
			" endpoint %02x\n", __func__, status, endpoint);
K
Kevin Lloyd 已提交
502 503
	} else {
		if (urb->actual_length) {
A
Alan Cox 已提交
504
			tty = tty_port_tty_get(&port->port);
505

K
Kevin Lloyd 已提交
506 507 508
			tty_buffer_request_room(tty, urb->actual_length);
			tty_insert_flip_string(tty, data, urb->actual_length);
			tty_flip_buffer_push(tty);
509

A
Alan Cox 已提交
510
			tty_kref_put(tty);
511 512 513
			usb_serial_debug_data(debug, &port->dev, __func__,
				urb->actual_length, data);
		} else {
514
			dev_dbg(&port->dev, "%s: empty read urb"
515
				" received\n", __func__);
K
Kevin Lloyd 已提交
516 517
		}
	}
518 519 520 521 522 523 524 525 526

	/* Resubmit urb so we continue receiving */
	if (port->port.count && status != -ESHUTDOWN && status != -EPERM) {
		err = usb_submit_urb(urb, GFP_ATOMIC);
		if (err)
			dev_err(&port->dev, "resubmit read urb failed."
				"(%d)\n", err);
	}

K
Kevin Lloyd 已提交
527 528 529 530 531 532
	return;
}

static void sierra_instat_callback(struct urb *urb)
{
	int err;
533
	int status = urb->status;
534
	struct usb_serial_port *port =  urb->context;
K
Kevin Lloyd 已提交
535 536 537
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;

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

541
	if (status == 0) {
K
Kevin Lloyd 已提交
542 543 544 545
		struct usb_ctrlrequest *req_pkt =
				(struct usb_ctrlrequest *)urb->transfer_buffer;

		if (!req_pkt) {
546 547
			dev_dbg(&port->dev, "%s: NULL req_pkt\n",
				__func__);
K
Kevin Lloyd 已提交
548 549 550 551 552 553 554 555
			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));
A
Alan Cox 已提交
556
			struct tty_struct *tty;
K
Kevin Lloyd 已提交
557

558
			dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
559
				signals);
K
Kevin Lloyd 已提交
560 561 562 563 564 565 566

			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);

A
Alan Cox 已提交
567 568
			tty = tty_port_tty_get(&port->port);
			if (tty && !C_CLOCAL(tty) &&
K
Kevin Lloyd 已提交
569
					old_dcd_state && !portdata->dcd_state)
A
Alan Cox 已提交
570 571
				tty_hangup(tty);
			tty_kref_put(tty);
K
Kevin Lloyd 已提交
572
		} else {
573
			dev_dbg(&port->dev, "%s: type %x req %x\n",
574 575
				__func__, req_pkt->bRequestType,
				req_pkt->bRequest);
K
Kevin Lloyd 已提交
576 577
		}
	} else
578
		dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
K
Kevin Lloyd 已提交
579 580

	/* Resubmit urb so we continue receiving IRQ data */
581
	if (port->port.count && status != -ESHUTDOWN && status != -ENOENT) {
K
Kevin Lloyd 已提交
582 583 584
		urb->dev = serial->dev;
		err = usb_submit_urb(urb, GFP_ATOMIC);
		if (err)
585 586
			dev_err(&port->dev, "%s: resubmit intr urb "
				"failed. (%d)\n", __func__, err);
K
Kevin Lloyd 已提交
587 588 589
	}
}

A
Alan Cox 已提交
590
static int sierra_write_room(struct tty_struct *tty)
K
Kevin Lloyd 已提交
591
{
A
Alan Cox 已提交
592
	struct usb_serial_port *port = tty->driver_data;
593 594
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	unsigned long flags;
K
Kevin Lloyd 已提交
595

596
	dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
K
Kevin Lloyd 已提交
597

598 599 600 601 602
	/* 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);
	if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
		spin_unlock_irqrestore(&portdata->lock, flags);
603
		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
604
		return 0;
K
Kevin Lloyd 已提交
605
	}
606
	spin_unlock_irqrestore(&portdata->lock, flags);
K
Kevin Lloyd 已提交
607

608
	return 2048;
K
Kevin Lloyd 已提交
609 610
}

611
static void sierra_stop_rx_urbs(struct usb_serial_port *port)
K
Kevin Lloyd 已提交
612
{
613
	int i;
614
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
K
Kevin Lloyd 已提交
615

616 617
	for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++)
		usb_kill_urb(portdata->in_urbs[i]);
K
Kevin Lloyd 已提交
618

619 620
	usb_kill_urb(port->interrupt_in_urb);
}
K
Kevin Lloyd 已提交
621

622 623 624 625 626 627 628
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 已提交
629

630 631
	ok_cnt = 0;
	for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
K
Kevin Lloyd 已提交
632
		urb = portdata->in_urbs[i];
633
		if (!urb)
K
Kevin Lloyd 已提交
634
			continue;
635 636 637 638 639 640
		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 已提交
641
		}
642
	}
K
Kevin Lloyd 已提交
643

644 645 646 647 648
	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 已提交
649 650 651
		}
	}

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
	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 已提交
668

669 670 671 672 673
	urb = usb_alloc_urb(0, mem_flags);
	if (urb == NULL) {
		dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
			__func__, endpoint);
		return NULL;
674
	}
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694

	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);

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

		sierra_release_urb(urb);
		urb = NULL;
	}

	return urb;
K
Kevin Lloyd 已提交
695 696
}

697
static void sierra_close(struct usb_serial_port *port)
K
Kevin Lloyd 已提交
698
{
699
	int i;
K
Kevin Lloyd 已提交
700 701 702
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;

703
	dev_dbg(&port->dev, "%s\n", __func__);
K
Kevin Lloyd 已提交
704
	portdata = usb_get_serial_port_data(port);
705 706 707

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

	if (serial->dev) {
710 711
		mutex_lock(&serial->disc_mutex);
		if (!serial->disconnected)
712
			sierra_send_setup(port);
713
		mutex_unlock(&serial->disc_mutex);
714 715 716 717 718 719 720 721

		/* Stop reading urbs */
		sierra_stop_rx_urbs(port);
		/* .. and release them */
		for (i = 0; i < N_IN_URB; i++) {
			sierra_release_urb(portdata->in_urbs[i]);
			portdata->in_urbs[i] = NULL;
		}
722 723 724
	}
}

725 726
static int sierra_open(struct tty_struct *tty,
			struct usb_serial_port *port, struct file *filp)
727
{
728 729
	struct sierra_port_private *portdata;
	struct usb_serial *serial = port->serial;
730
	int i;
731 732 733 734 735 736
	int err;
	int endpoint;
	struct urb *urb;

	portdata = usb_get_serial_port_data(port);

737
	dev_dbg(&port->dev, "%s\n", __func__);
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768

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


	endpoint = port->bulk_in_endpointAddress;
	for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
		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);
		return err;
	}
	sierra_send_setup(port);

	return 0;
}


static void sierra_dtr_rts(struct usb_serial_port *port, int on)
{
769 770
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
K
Kevin Lloyd 已提交
771

772
	portdata = usb_get_serial_port_data(port);
773 774
	portdata->rts_state = on;
	portdata->dtr_state = on;
775 776

	if (serial->dev) {
777 778 779 780
		mutex_lock(&serial->disc_mutex);
		if (!serial->disconnected)
			sierra_send_setup(port);
		mutex_unlock(&serial->disc_mutex);
K
Kevin Lloyd 已提交
781 782 783 784 785 786 787
	}
}

static int sierra_startup(struct usb_serial *serial)
{
	struct usb_serial_port *port;
	struct sierra_port_private *portdata;
788
	int i;
K
Kevin Lloyd 已提交
789

790
	dev_dbg(&serial->dev->dev, "%s\n", __func__);
K
Kevin Lloyd 已提交
791

792
	/* Set Device mode to D0 */
793 794
	sierra_set_power_state(serial->dev, 0x0000);

795 796 797 798
	/* Check NMEA and set */
	if (nmea)
		sierra_vsc_set_nmea(serial->dev, 1);

K
Kevin Lloyd 已提交
799 800 801 802 803
	/* Now setup per port private data */
	for (i = 0; i < serial->num_ports; i++) {
		port = serial->port[i];
		portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
		if (!portdata) {
804
			dev_dbg(&port->dev, "%s: kmalloc for "
805
				"sierra_port_private (%d) failed!.\n",
806
				__func__, i);
807
			return -ENOMEM;
K
Kevin Lloyd 已提交
808
		}
809
		spin_lock_init(&portdata->lock);
810
		/* Set the port private data pointer */
K
Kevin Lloyd 已提交
811 812 813
		usb_set_serial_port_data(port, portdata);
	}

814
	return 0;
K
Kevin Lloyd 已提交
815 816
}

817
static void sierra_release(struct usb_serial *serial)
K
Kevin Lloyd 已提交
818
{
819
	int i;
K
Kevin Lloyd 已提交
820 821 822
	struct usb_serial_port *port;
	struct sierra_port_private *portdata;

823
	dev_dbg(&serial->dev->dev, "%s\n", __func__);
K
Kevin Lloyd 已提交
824 825 826

	for (i = 0; i < serial->num_ports; ++i) {
		port = serial->port[i];
827 828
		if (!port)
			continue;
K
Kevin Lloyd 已提交
829
		portdata = usb_get_serial_port_data(port);
830 831
		if (!portdata)
			continue;
832
		kfree(portdata);
K
Kevin Lloyd 已提交
833 834 835
	}
}

836
static struct usb_serial_driver sierra_device = {
837 838
	.driver = {
		.owner =	THIS_MODULE,
K
Kevin Lloyd 已提交
839
		.name =		"sierra",
840
	},
841 842
	.description       = "Sierra USB modem",
	.id_table          = id_table,
843
	.usb_driver        = &sierra_driver,
844 845
	.calc_num_ports	   = sierra_calc_num_ports,
	.probe		   = sierra_probe,
846 847
	.open              = sierra_open,
	.close             = sierra_close,
848
	.dtr_rts	   = sierra_dtr_rts,
849 850 851 852 853 854
	.write             = sierra_write,
	.write_room        = sierra_write_room,
	.set_termios       = sierra_set_termios,
	.tiocmget          = sierra_tiocmget,
	.tiocmset          = sierra_tiocmset,
	.attach            = sierra_startup,
855
	.release           = sierra_release,
856 857 858 859 860 861 862
	.read_int_callback = sierra_instat_callback,
};

/* Functions used by new usb-serial code. */
static int __init sierra_init(void)
{
	int retval;
863
	retval = usb_serial_register(&sierra_device);
864
	if (retval)
865
		goto failed_device_register;
866 867 868 869 870 871


	retval = usb_register(&sierra_driver);
	if (retval)
		goto failed_driver_register;

872 873
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
874 875 876 877

	return 0;

failed_driver_register:
878 879
	usb_serial_deregister(&sierra_device);
failed_device_register:
880 881 882 883 884
	return retval;
}

static void __exit sierra_exit(void)
{
A
Alan Cox 已提交
885
	usb_deregister(&sierra_driver);
886
	usb_serial_deregister(&sierra_device);
887 888 889 890 891
}

module_init(sierra_init);
module_exit(sierra_exit);

K
Kevin Lloyd 已提交
892 893 894
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_VERSION(DRIVER_VERSION);
895
MODULE_LICENSE("GPL");
K
Kevin Lloyd 已提交
896

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

K
Kevin Lloyd 已提交
900 901
module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug messages");