xref: /openbmc/linux/drivers/usb/serial/sierra.c (revision 9ac8d3fb)
1 /*
2   USB Driver for Sierra Wireless
3 
4   Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>
5 
6   IMPORTANT DISCLAIMER: This driver is not commercially supported by
7   Sierra Wireless. Use at your own risk.
8 
9   This driver is free software; you can redistribute it and/or modify
10   it under the terms of Version 2 of the GNU General Public License as
11   published by the Free Software Foundation.
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 
17 #define DRIVER_VERSION "v.1.3.2"
18 #define DRIVER_AUTHOR "Kevin Lloyd <klloyd@sierrawireless.com>"
19 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
20 
21 #include <linux/kernel.h>
22 #include <linux/jiffies.h>
23 #include <linux/errno.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/module.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
29 #include <linux/usb/ch9.h>
30 
31 #define SWIMS_USB_REQUEST_SetPower	0x00
32 #define SWIMS_USB_REQUEST_SetNmea	0x07
33 
34 /* per port private data */
35 #define N_IN_URB	4
36 #define N_OUT_URB	4
37 #define IN_BUFLEN	4096
38 
39 static int debug;
40 static int nmea;
41 
42 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
43 {
44 	int result;
45 	dev_dbg(&udev->dev, "%s", __func__);
46 	result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
47 			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
48 			USB_TYPE_VENDOR,		/* __u8 request type */
49 			swiState,			/* __u16 value       */
50 			0,				/* __u16 index       */
51 			NULL,				/* void *data        */
52 			0,				/* __u16 size 	     */
53 			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
54 	return result;
55 }
56 
57 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
58 {
59 	int result;
60 	dev_dbg(&udev->dev, "%s", __func__);
61 	result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
62 			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
63 			USB_TYPE_VENDOR,		/* __u8 request type */
64 			enable,				/* __u16 value       */
65 			0x0000,				/* __u16 index       */
66 			NULL,				/* void *data        */
67 			0,				/* __u16 size 	     */
68 			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
69 	return result;
70 }
71 
72 static int sierra_calc_num_ports(struct usb_serial *serial)
73 {
74 	int result;
75 	int *num_ports = usb_get_serial_data(serial);
76 	dev_dbg(&serial->dev->dev, "%s", __func__);
77 
78 	result = *num_ports;
79 
80 	if (result) {
81 		kfree(num_ports);
82 		usb_set_serial_data(serial, NULL);
83 	}
84 
85 	return result;
86 }
87 
88 static int sierra_calc_interface(struct usb_serial *serial)
89 {
90 	int interface;
91 	struct usb_interface *p_interface;
92 	struct usb_host_interface *p_host_interface;
93 	dev_dbg(&serial->dev->dev, "%s", __func__);
94 
95 	/* Get the interface structure pointer from the serial struct */
96 	p_interface = serial->interface;
97 
98 	/* Get a pointer to the host interface structure */
99 	p_host_interface = p_interface->cur_altsetting;
100 
101 	/* read the interface descriptor for this active altsetting
102 	 * to find out the interface number we are on
103 	*/
104 	interface = p_host_interface->desc.bInterfaceNumber;
105 
106 	return interface;
107 }
108 
109 static int sierra_probe(struct usb_serial *serial,
110 			const struct usb_device_id *id)
111 {
112 	int result = 0;
113 	struct usb_device *udev;
114 	int *num_ports;
115 	u8 ifnum;
116 	u8 numendpoints;
117 
118 	dev_dbg(&serial->dev->dev, "%s", __func__);
119 
120 	num_ports = kmalloc(sizeof(*num_ports), GFP_KERNEL);
121 	if (!num_ports)
122 		return -ENOMEM;
123 
124 	ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
125 	numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
126 	udev = serial->dev;
127 
128 	/* Figure out the interface number from the serial structure */
129 	ifnum = sierra_calc_interface(serial);
130 
131 	/*
132 	 * If this interface supports more than 1 alternate
133 	 * select the 2nd one
134 	 */
135 	if (serial->interface->num_altsetting == 2) {
136 		dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
137 			ifnum);
138 		/* We know the alternate setting is 1 for the MC8785 */
139 		usb_set_interface(udev, ifnum, 1);
140 	}
141 
142 	/* Dummy interface present on some SKUs should be ignored */
143 	if (ifnum == 0x99)
144 		*num_ports = 0;
145 	else if (numendpoints <= 3)
146 		*num_ports = 1;
147 	else
148 		*num_ports = (numendpoints-1)/2;
149 
150 	/*
151 	 * save off our num_ports info so that we can use it in the
152 	 * calc_num_ports callback
153 	 */
154 	usb_set_serial_data(serial, (void *)num_ports);
155 
156 	return result;
157 }
158 
159 static struct usb_device_id id_table [] = {
160 	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
161 	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
162 	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
163 	{ USB_DEVICE(0x03f0, 0x1b1d) }, /* HP ev2200 a.k.a MC5720 */
164 	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
165 	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
166 	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
167 	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
168 	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
169 	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
170 	 /* Sierra Wireless C597 */
171 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
172 	 /* Sierra Wireless Device */
173 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
174 	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless Device */
175 	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless Device */
176 	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless Device */
177 
178 	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
179 	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
180 	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
181 	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
182 	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 (Lenovo) */
183 	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
184 	{ USB_DEVICE(0x03f0, 0x1e1d) },	/* HP hs2300 a.k.a MC8775 */
185 	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
186 	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
187 	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
188 	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
189 	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
190 	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
191 	{ USB_DEVICE(0x1199, 0x683C) },	/* Sierra Wireless MC8790 */
192 	{ USB_DEVICE(0x1199, 0x683D) },	/* Sierra Wireless MC8790 */
193 	{ USB_DEVICE(0x1199, 0x683E) },	/* Sierra Wireless MC8790 */
194 	{ USB_DEVICE(0x1199, 0x6850) },	/* Sierra Wireless AirCard 880 */
195 	{ USB_DEVICE(0x1199, 0x6851) },	/* Sierra Wireless AirCard 881 */
196 	{ USB_DEVICE(0x1199, 0x6852) },	/* Sierra Wireless AirCard 880 E */
197 	{ USB_DEVICE(0x1199, 0x6853) },	/* Sierra Wireless AirCard 881 E */
198 	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
199 	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
200 	{ USB_DEVICE(0x1199, 0x6859) },	/* Sierra Wireless AirCard 885 E */
201 	{ USB_DEVICE(0x1199, 0x685A) },	/* Sierra Wireless AirCard 885 E */
202 	/* Sierra Wireless C885 */
203 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
204 	/* Sierra Wireless Device */
205 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
206 	/* Sierra Wireless Device */
207 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
208 	/* Sierra Wireless Device */
209 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
210 
211 	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
212 	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
213 
214 	{ }
215 };
216 MODULE_DEVICE_TABLE(usb, id_table);
217 
218 static struct usb_driver sierra_driver = {
219 	.name       = "sierra",
220 	.probe      = usb_serial_probe,
221 	.disconnect = usb_serial_disconnect,
222 	.id_table   = id_table,
223 	.no_dynamic_id = 	1,
224 };
225 
226 struct sierra_port_private {
227 	spinlock_t lock;	/* lock the structure */
228 	int outstanding_urbs;	/* number of out urbs in flight */
229 
230 	/* Input endpoints and buffers for this port */
231 	struct urb *in_urbs[N_IN_URB];
232 	char *in_buffer[N_IN_URB];
233 
234 	/* Settings for the port */
235 	int rts_state;	/* Handshaking pins (outputs) */
236 	int dtr_state;
237 	int cts_state;	/* Handshaking pins (inputs) */
238 	int dsr_state;
239 	int dcd_state;
240 	int ri_state;
241 };
242 
243 static int sierra_send_setup(struct tty_struct *tty,
244 						struct usb_serial_port *port)
245 {
246 	struct usb_serial *serial = port->serial;
247 	struct sierra_port_private *portdata;
248 	__u16 interface = 0;
249 
250 	dev_dbg(&port->dev, "%s", __func__);
251 
252 	portdata = usb_get_serial_port_data(port);
253 
254 	if (tty) {
255 		int val = 0;
256 		if (portdata->dtr_state)
257 			val |= 0x01;
258 		if (portdata->rts_state)
259 			val |= 0x02;
260 
261 		/* If composite device then properly report interface */
262 		if (serial->num_ports == 1)
263 			interface = sierra_calc_interface(serial);
264 
265 		/* Otherwise the need to do non-composite mapping */
266 		else {
267 			if (port->bulk_out_endpointAddress == 2)
268 				interface = 0;
269 			else if (port->bulk_out_endpointAddress == 4)
270 				interface = 1;
271 			else if (port->bulk_out_endpointAddress == 5)
272 				interface = 2;
273 		}
274 
275 		return usb_control_msg(serial->dev,
276 				usb_rcvctrlpipe(serial->dev, 0),
277 				0x22, 0x21, val, interface,
278 				NULL, 0, USB_CTRL_SET_TIMEOUT);
279 	}
280 
281 	return 0;
282 }
283 
284 static void sierra_set_termios(struct tty_struct *tty,
285 		struct usb_serial_port *port, struct ktermios *old_termios)
286 {
287 	dev_dbg(&port->dev, "%s", __func__);
288 	tty_termios_copy_hw(tty->termios, old_termios);
289 	sierra_send_setup(tty, port);
290 }
291 
292 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
293 {
294 	struct usb_serial_port *port = tty->driver_data;
295 	unsigned int value;
296 	struct sierra_port_private *portdata;
297 
298 	dev_dbg(&port->dev, "%s", __func__);
299 	portdata = usb_get_serial_port_data(port);
300 
301 	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
302 		((portdata->dtr_state) ? TIOCM_DTR : 0) |
303 		((portdata->cts_state) ? TIOCM_CTS : 0) |
304 		((portdata->dsr_state) ? TIOCM_DSR : 0) |
305 		((portdata->dcd_state) ? TIOCM_CAR : 0) |
306 		((portdata->ri_state) ? TIOCM_RNG : 0);
307 
308 	return value;
309 }
310 
311 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
312 			unsigned int set, unsigned int clear)
313 {
314 	struct usb_serial_port *port = tty->driver_data;
315 	struct sierra_port_private *portdata;
316 
317 	portdata = usb_get_serial_port_data(port);
318 
319 	if (set & TIOCM_RTS)
320 		portdata->rts_state = 1;
321 	if (set & TIOCM_DTR)
322 		portdata->dtr_state = 1;
323 
324 	if (clear & TIOCM_RTS)
325 		portdata->rts_state = 0;
326 	if (clear & TIOCM_DTR)
327 		portdata->dtr_state = 0;
328 	return sierra_send_setup(tty, port);
329 }
330 
331 static void sierra_outdat_callback(struct urb *urb)
332 {
333 	struct usb_serial_port *port = urb->context;
334 	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
335 	int status = urb->status;
336 	unsigned long flags;
337 
338 	dev_dbg(&port->dev, "%s - port %d", __func__, port->number);
339 
340 	/* free up the transfer buffer, as usb_free_urb() does not do this */
341 	kfree(urb->transfer_buffer);
342 
343 	if (status)
344 		dev_dbg(&port->dev, "%s - nonzero write bulk status "
345 		    "received: %d", __func__, status);
346 
347 	spin_lock_irqsave(&portdata->lock, flags);
348 	--portdata->outstanding_urbs;
349 	spin_unlock_irqrestore(&portdata->lock, flags);
350 
351 	usb_serial_port_softint(port);
352 }
353 
354 /* Write */
355 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
356 					const unsigned char *buf, int count)
357 {
358 	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
359 	struct usb_serial *serial = port->serial;
360 	unsigned long flags;
361 	unsigned char *buffer;
362 	struct urb *urb;
363 	int status;
364 
365 	portdata = usb_get_serial_port_data(port);
366 
367 	dev_dbg(&port->dev, "%s: write (%d chars)", __func__, count);
368 
369 	spin_lock_irqsave(&portdata->lock, flags);
370 	if (portdata->outstanding_urbs > N_OUT_URB) {
371 		spin_unlock_irqrestore(&portdata->lock, flags);
372 		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
373 		return 0;
374 	}
375 	portdata->outstanding_urbs++;
376 	spin_unlock_irqrestore(&portdata->lock, flags);
377 
378 	buffer = kmalloc(count, GFP_ATOMIC);
379 	if (!buffer) {
380 		dev_err(&port->dev, "out of memory\n");
381 		count = -ENOMEM;
382 		goto error_no_buffer;
383 	}
384 
385 	urb = usb_alloc_urb(0, GFP_ATOMIC);
386 	if (!urb) {
387 		dev_err(&port->dev, "no more free urbs\n");
388 		count = -ENOMEM;
389 		goto error_no_urb;
390 	}
391 
392 	memcpy(buffer, buf, count);
393 
394 	usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
395 
396 	usb_fill_bulk_urb(urb, serial->dev,
397 			  usb_sndbulkpipe(serial->dev,
398 					  port->bulk_out_endpointAddress),
399 			  buffer, count, sierra_outdat_callback, port);
400 
401 	/* send it down the pipe */
402 	status = usb_submit_urb(urb, GFP_ATOMIC);
403 	if (status) {
404 		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
405 			"with status = %d\n", __func__, status);
406 		count = status;
407 		goto error;
408 	}
409 
410 	/* we are done with this urb, so let the host driver
411 	 * really free it when it is finished with it */
412 	usb_free_urb(urb);
413 
414 	return count;
415 error:
416 	usb_free_urb(urb);
417 error_no_urb:
418 	kfree(buffer);
419 error_no_buffer:
420 	spin_lock_irqsave(&portdata->lock, flags);
421 	--portdata->outstanding_urbs;
422 	spin_unlock_irqrestore(&portdata->lock, flags);
423 	return count;
424 }
425 
426 static void sierra_indat_callback(struct urb *urb)
427 {
428 	int err;
429 	int endpoint;
430 	struct usb_serial_port *port;
431 	struct tty_struct *tty;
432 	unsigned char *data = urb->transfer_buffer;
433 	int status = urb->status;
434 
435 	dbg("%s: %p", __func__, urb);
436 
437 	endpoint = usb_pipeendpoint(urb->pipe);
438 	port =  urb->context;
439 
440 	if (status) {
441 		dev_dbg(&port->dev, "%s: nonzero status: %d on"
442 		    " endpoint %02x.", __func__, status, endpoint);
443 	} else {
444 		if (urb->actual_length) {
445 		tty = tty_port_tty_get(&port->port);
446 			tty_buffer_request_room(tty, urb->actual_length);
447 			tty_insert_flip_string(tty, data, urb->actual_length);
448 			tty_flip_buffer_push(tty);
449 			tty_kref_put(tty);
450 		} else
451 			dev_dbg(&port->dev, "%s: empty read urb"
452 				" received", __func__);
453 
454 		/* Resubmit urb so we continue receiving */
455 		if (port->port.count && status != -ESHUTDOWN) {
456 			err = usb_submit_urb(urb, GFP_ATOMIC);
457 			if (err)
458 				dev_err(&port->dev, "resubmit read urb failed."
459 					"(%d)\n", err);
460 		}
461 	}
462 	return;
463 }
464 
465 static void sierra_instat_callback(struct urb *urb)
466 {
467 	int err;
468 	int status = urb->status;
469 	struct usb_serial_port *port =  urb->context;
470 	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
471 	struct usb_serial *serial = port->serial;
472 
473 	dev_dbg(&port->dev, "%s", __func__);
474 	dev_dbg(&port->dev, "%s: urb %p port %p has data %p", __func__,
475 		urb, port, portdata);
476 
477 	if (status == 0) {
478 		struct usb_ctrlrequest *req_pkt =
479 				(struct usb_ctrlrequest *)urb->transfer_buffer;
480 
481 		if (!req_pkt) {
482 			dev_dbg(&port->dev, "%s: NULL req_pkt\n",
483 				__func__);
484 			return;
485 		}
486 		if ((req_pkt->bRequestType == 0xA1) &&
487 				(req_pkt->bRequest == 0x20)) {
488 			int old_dcd_state;
489 			unsigned char signals = *((unsigned char *)
490 					urb->transfer_buffer +
491 					sizeof(struct usb_ctrlrequest));
492 			struct tty_struct *tty;
493 
494 			dev_dbg(&port->dev, "%s: signal x%x", __func__,
495 				signals);
496 
497 			old_dcd_state = portdata->dcd_state;
498 			portdata->cts_state = 1;
499 			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
500 			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
501 			portdata->ri_state = ((signals & 0x08) ? 1 : 0);
502 
503 			tty = tty_port_tty_get(&port->port);
504 			if (tty && !C_CLOCAL(tty) &&
505 					old_dcd_state && !portdata->dcd_state)
506 				tty_hangup(tty);
507 			tty_kref_put(tty);
508 		} else {
509 			dev_dbg(&port->dev, "%s: type %x req %x",
510 				__func__, req_pkt->bRequestType,
511 				req_pkt->bRequest);
512 		}
513 	} else
514 		dev_dbg(&port->dev, "%s: error %d", __func__, status);
515 
516 	/* Resubmit urb so we continue receiving IRQ data */
517 	if (status != -ESHUTDOWN) {
518 		urb->dev = serial->dev;
519 		err = usb_submit_urb(urb, GFP_ATOMIC);
520 		if (err)
521 			dev_dbg(&port->dev, "%s: resubmit intr urb "
522 				"failed. (%d)",	__func__, err);
523 	}
524 }
525 
526 static int sierra_write_room(struct tty_struct *tty)
527 {
528 	struct usb_serial_port *port = tty->driver_data;
529 	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
530 	unsigned long flags;
531 
532 	dev_dbg(&port->dev, "%s - port %d", __func__, port->number);
533 
534 	/* try to give a good number back based on if we have any free urbs at
535 	 * this point in time */
536 	spin_lock_irqsave(&portdata->lock, flags);
537 	if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
538 		spin_unlock_irqrestore(&portdata->lock, flags);
539 		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
540 		return 0;
541 	}
542 	spin_unlock_irqrestore(&portdata->lock, flags);
543 
544 	return 2048;
545 }
546 
547 static int sierra_open(struct tty_struct *tty,
548 			struct usb_serial_port *port, struct file *filp)
549 {
550 	struct sierra_port_private *portdata;
551 	struct usb_serial *serial = port->serial;
552 	int i;
553 	struct urb *urb;
554 	int result;
555 
556 	portdata = usb_get_serial_port_data(port);
557 
558 	dev_dbg(&port->dev, "%s", __func__);
559 
560 	/* Set some sane defaults */
561 	portdata->rts_state = 1;
562 	portdata->dtr_state = 1;
563 
564 	/* Reset low level data toggle and start reading from endpoints */
565 	for (i = 0; i < N_IN_URB; i++) {
566 		urb = portdata->in_urbs[i];
567 		if (!urb)
568 			continue;
569 		if (urb->dev != serial->dev) {
570 			dev_dbg(&port->dev, "%s: dev %p != %p",
571 				 __func__, urb->dev, serial->dev);
572 			continue;
573 		}
574 
575 		/*
576 		 * make sure endpoint data toggle is synchronized with the
577 		 * device
578 		 */
579 		usb_clear_halt(urb->dev, urb->pipe);
580 
581 		result = usb_submit_urb(urb, GFP_KERNEL);
582 		if (result) {
583 			dev_err(&port->dev, "submit urb %d failed (%d) %d\n",
584 				i, result, urb->transfer_buffer_length);
585 		}
586 	}
587 
588 	if (tty)
589 		tty->low_latency = 1;
590 
591 	sierra_send_setup(tty, port);
592 
593 	/* start up the interrupt endpoint if we have one */
594 	if (port->interrupt_in_urb) {
595 		result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
596 		if (result)
597 			dev_err(&port->dev, "submit irq_in urb failed %d\n",
598 				result);
599 	}
600 	return 0;
601 }
602 
603 static void sierra_close(struct tty_struct *tty,
604 			struct usb_serial_port *port, struct file *filp)
605 {
606 	int i;
607 	struct usb_serial *serial = port->serial;
608 	struct sierra_port_private *portdata;
609 
610 	dev_dbg(&port->dev, "%s", __func__);
611 	portdata = usb_get_serial_port_data(port);
612 
613 	portdata->rts_state = 0;
614 	portdata->dtr_state = 0;
615 
616 	if (serial->dev) {
617 		mutex_lock(&serial->disc_mutex);
618 		if (!serial->disconnected)
619 			sierra_send_setup(tty, port);
620 		mutex_unlock(&serial->disc_mutex);
621 
622 		/* Stop reading/writing urbs */
623 		for (i = 0; i < N_IN_URB; i++)
624 			usb_kill_urb(portdata->in_urbs[i]);
625 	}
626 
627 	usb_kill_urb(port->interrupt_in_urb);
628 	tty_port_tty_set(&port->port, NULL);
629 }
630 
631 static int sierra_startup(struct usb_serial *serial)
632 {
633 	struct usb_serial_port *port;
634 	struct sierra_port_private *portdata;
635 	struct urb *urb;
636 	int i;
637 	int j;
638 
639 	dev_dbg(&serial->dev->dev, "%s", __func__);
640 
641 	/* Set Device mode to D0 */
642 	sierra_set_power_state(serial->dev, 0x0000);
643 
644 	/* Check NMEA and set */
645 	if (nmea)
646 		sierra_vsc_set_nmea(serial->dev, 1);
647 
648 	/* Now setup per port private data */
649 	for (i = 0; i < serial->num_ports; i++) {
650 		port = serial->port[i];
651 		portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
652 		if (!portdata) {
653 			dev_dbg(&port->dev, "%s: kmalloc for "
654 				"sierra_port_private (%d) failed!.",
655 				__func__, i);
656 			return -ENOMEM;
657 		}
658 		spin_lock_init(&portdata->lock);
659 		for (j = 0; j < N_IN_URB; j++) {
660 			portdata->in_buffer[j] = kmalloc(IN_BUFLEN, GFP_KERNEL);
661 			if (!portdata->in_buffer[j]) {
662 				for (--j; j >= 0; j--)
663 					kfree(portdata->in_buffer[j]);
664 				kfree(portdata);
665 				return -ENOMEM;
666 			}
667 		}
668 
669 		usb_set_serial_port_data(port, portdata);
670 
671 		/* initialize the in urbs */
672 		for (j = 0; j < N_IN_URB; ++j) {
673 			urb = usb_alloc_urb(0, GFP_KERNEL);
674 			if (urb == NULL) {
675 				dev_dbg(&port->dev, "%s: alloc for in "
676 					"port failed.", __func__);
677 				continue;
678 			}
679 			/* Fill URB using supplied data. */
680 			usb_fill_bulk_urb(urb, serial->dev,
681 					  usb_rcvbulkpipe(serial->dev,
682 						port->bulk_in_endpointAddress),
683 					  portdata->in_buffer[j], IN_BUFLEN,
684 					  sierra_indat_callback, port);
685 			portdata->in_urbs[j] = urb;
686 		}
687 	}
688 
689 	return 0;
690 }
691 
692 static void sierra_shutdown(struct usb_serial *serial)
693 {
694 	int i, j;
695 	struct usb_serial_port *port;
696 	struct sierra_port_private *portdata;
697 
698 	dev_dbg(&serial->dev->dev, "%s", __func__);
699 
700 	for (i = 0; i < serial->num_ports; ++i) {
701 		port = serial->port[i];
702 		if (!port)
703 			continue;
704 		portdata = usb_get_serial_port_data(port);
705 		if (!portdata)
706 			continue;
707 
708 		for (j = 0; j < N_IN_URB; j++) {
709 			usb_kill_urb(portdata->in_urbs[j]);
710 			usb_free_urb(portdata->in_urbs[j]);
711 			kfree(portdata->in_buffer[j]);
712 		}
713 		kfree(portdata);
714 		usb_set_serial_port_data(port, NULL);
715 	}
716 }
717 
718 static struct usb_serial_driver sierra_device = {
719 	.driver = {
720 		.owner =	THIS_MODULE,
721 		.name =		"sierra",
722 	},
723 	.description       = "Sierra USB modem",
724 	.id_table          = id_table,
725 	.usb_driver        = &sierra_driver,
726 	.calc_num_ports	   = sierra_calc_num_ports,
727 	.probe		   = sierra_probe,
728 	.open              = sierra_open,
729 	.close             = sierra_close,
730 	.write             = sierra_write,
731 	.write_room        = sierra_write_room,
732 	.set_termios       = sierra_set_termios,
733 	.tiocmget          = sierra_tiocmget,
734 	.tiocmset          = sierra_tiocmset,
735 	.attach            = sierra_startup,
736 	.shutdown          = sierra_shutdown,
737 	.read_int_callback = sierra_instat_callback,
738 };
739 
740 /* Functions used by new usb-serial code. */
741 static int __init sierra_init(void)
742 {
743 	int retval;
744 	retval = usb_serial_register(&sierra_device);
745 	if (retval)
746 		goto failed_device_register;
747 
748 
749 	retval = usb_register(&sierra_driver);
750 	if (retval)
751 		goto failed_driver_register;
752 
753 	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
754 	       DRIVER_DESC "\n");
755 
756 	return 0;
757 
758 failed_driver_register:
759 	usb_serial_deregister(&sierra_device);
760 failed_device_register:
761 	return retval;
762 }
763 
764 static void __exit sierra_exit(void)
765 {
766 	usb_deregister(&sierra_driver);
767 	usb_serial_deregister(&sierra_device);
768 }
769 
770 module_init(sierra_init);
771 module_exit(sierra_exit);
772 
773 MODULE_AUTHOR(DRIVER_AUTHOR);
774 MODULE_DESCRIPTION(DRIVER_DESC);
775 MODULE_VERSION(DRIVER_VERSION);
776 MODULE_LICENSE("GPL");
777 
778 module_param(nmea, bool, S_IRUGO | S_IWUSR);
779 MODULE_PARM_DESC(nmea, "NMEA streaming");
780 
781 module_param(debug, bool, S_IRUGO | S_IWUSR);
782 MODULE_PARM_DESC(debug, "Debug messages");
783