xref: /linux/drivers/net/usb/hso.c (revision 8a79db5e83a5d52c74e6f3c40d6f312cf899213e)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /******************************************************************************
3  *
4  * Driver for Option High Speed Mobile Devices.
5  *
6  *  Copyright (C) 2008 Option International
7  *                     Filip Aben <f.aben@option.com>
8  *                     Denis Joseph Barrow <d.barow@option.com>
9  *                     Jan Dumon <j.dumon@option.com>
10  *  Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
11  *  			<ajb@spheresystems.co.uk>
12  *  Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
13  *  Copyright (C) 2008 Novell, Inc.
14  *
15  *****************************************************************************/
16 
17 /******************************************************************************
18  *
19  * Description of the device:
20  *
21  * Interface 0:	Contains the IP network interface on the bulk end points.
22  *		The multiplexed serial ports are using the interrupt and
23  *		control endpoints.
24  *		Interrupt contains a bitmap telling which multiplexed
25  *		serialport needs servicing.
26  *
27  * Interface 1:	Diagnostics port, uses bulk only, do not submit urbs until the
28  *		port is opened, as this have a huge impact on the network port
29  *		throughput.
30  *
31  * Interface 2:	Standard modem interface - circuit switched interface, this
32  *		can be used to make a standard ppp connection however it
33  *              should not be used in conjunction with the IP network interface
34  *              enabled for USB performance reasons i.e. if using this set
35  *              ideally disable_net=1.
36  *
37  *****************************************************************************/
38 
39 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
40 
41 #include <linux/sched/signal.h>
42 #include <linux/slab.h>
43 #include <linux/init.h>
44 #include <linux/delay.h>
45 #include <linux/netdevice.h>
46 #include <linux/module.h>
47 #include <linux/ethtool.h>
48 #include <linux/usb.h>
49 #include <linux/tty.h>
50 #include <linux/tty_driver.h>
51 #include <linux/tty_flip.h>
52 #include <linux/kmod.h>
53 #include <linux/rfkill.h>
54 #include <linux/ip.h>
55 #include <linux/uaccess.h>
56 #include <linux/usb/cdc.h>
57 #include <net/arp.h>
58 #include <asm/byteorder.h>
59 #include <linux/serial_core.h>
60 #include <linux/serial.h>
61 
62 
63 #define MOD_AUTHOR			"Option Wireless"
64 #define MOD_DESCRIPTION			"USB High Speed Option driver"
65 
66 #define HSO_MAX_NET_DEVICES		10
67 #define HSO__MAX_MTU			2048
68 #define DEFAULT_MTU			1500
69 #define DEFAULT_MRU			1500
70 
71 #define CTRL_URB_RX_SIZE		1024
72 #define CTRL_URB_TX_SIZE		64
73 
74 #define BULK_URB_RX_SIZE		4096
75 #define BULK_URB_TX_SIZE		8192
76 
77 #define MUX_BULK_RX_BUF_SIZE		HSO__MAX_MTU
78 #define MUX_BULK_TX_BUF_SIZE		HSO__MAX_MTU
79 #define MUX_BULK_RX_BUF_COUNT		4
80 #define USB_TYPE_OPTION_VENDOR		0x20
81 
82 /* These definitions are used with the struct hso_net flags element */
83 /* - use *_bit operations on it. (bit indices not values.) */
84 #define HSO_NET_RUNNING			0
85 
86 #define	HSO_NET_TX_TIMEOUT		(HZ*10)
87 
88 #define HSO_SERIAL_MAGIC		0x48534f31
89 
90 /* Number of ttys to handle */
91 #define HSO_SERIAL_TTY_MINORS		256
92 
93 #define MAX_RX_URBS			2
94 
95 /*****************************************************************************/
96 /* Debugging functions                                                       */
97 /*****************************************************************************/
98 #define hso_dbg(lvl, fmt, ...)						\
99 do {									\
100 	if ((lvl) & debug)						\
101 		pr_info("[%d:%s] " fmt,					\
102 			__LINE__, __func__, ##__VA_ARGS__);		\
103 } while (0)
104 
105 /*****************************************************************************/
106 /* Enumerators                                                               */
107 /*****************************************************************************/
108 enum pkt_parse_state {
109 	WAIT_IP,
110 	WAIT_DATA,
111 	WAIT_SYNC
112 };
113 
114 /*****************************************************************************/
115 /* Structs                                                                   */
116 /*****************************************************************************/
117 
118 struct hso_shared_int {
119 	struct usb_endpoint_descriptor *intr_endp;
120 	void *shared_intr_buf;
121 	struct urb *shared_intr_urb;
122 	struct usb_device *usb;
123 	int use_count;
124 	int ref_count;
125 	struct mutex shared_int_lock;
126 };
127 
128 struct hso_net {
129 	struct hso_device *parent;
130 	struct net_device *net;
131 	struct rfkill *rfkill;
132 	char name[24];
133 
134 	struct usb_endpoint_descriptor *in_endp;
135 	struct usb_endpoint_descriptor *out_endp;
136 
137 	struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
138 	struct urb *mux_bulk_tx_urb;
139 	void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
140 	void *mux_bulk_tx_buf;
141 
142 	struct sk_buff *skb_rx_buf;
143 	struct sk_buff *skb_tx_buf;
144 
145 	enum pkt_parse_state rx_parse_state;
146 	spinlock_t net_lock;
147 
148 	unsigned short rx_buf_size;
149 	unsigned short rx_buf_missing;
150 	struct iphdr rx_ip_hdr;
151 
152 	unsigned long flags;
153 };
154 
155 enum rx_ctrl_state{
156 	RX_IDLE,
157 	RX_SENT,
158 	RX_PENDING
159 };
160 
161 #define BM_REQUEST_TYPE (0xa1)
162 #define B_NOTIFICATION  (0x20)
163 #define W_VALUE         (0x0)
164 #define W_LENGTH        (0x2)
165 
166 #define B_OVERRUN       (0x1<<6)
167 #define B_PARITY        (0x1<<5)
168 #define B_FRAMING       (0x1<<4)
169 #define B_RING_SIGNAL   (0x1<<3)
170 #define B_BREAK         (0x1<<2)
171 #define B_TX_CARRIER    (0x1<<1)
172 #define B_RX_CARRIER    (0x1<<0)
173 
174 struct hso_serial_state_notification {
175 	u8 bmRequestType;
176 	u8 bNotification;
177 	u16 wValue;
178 	u16 wIndex;
179 	u16 wLength;
180 	u16 UART_state_bitmap;
181 } __packed;
182 
183 struct hso_tiocmget {
184 	struct mutex mutex;
185 	wait_queue_head_t waitq;
186 	int    intr_completed;
187 	struct usb_endpoint_descriptor *endp;
188 	struct urb *urb;
189 	struct hso_serial_state_notification *serial_state_notification;
190 	u16    prev_UART_state_bitmap;
191 	struct uart_icount icount;
192 };
193 
194 
195 struct hso_serial {
196 	struct hso_device *parent;
197 	int magic;
198 	u8 minor;
199 
200 	struct hso_shared_int *shared_int;
201 
202 	/* rx/tx urb could be either a bulk urb or a control urb depending
203 	   on which serial port it is used on. */
204 	struct urb *rx_urb[MAX_RX_URBS];
205 	u8 num_rx_urbs;
206 	u8 *rx_data[MAX_RX_URBS];
207 	u16 rx_data_length;	/* should contain allocated length */
208 
209 	struct urb *tx_urb;
210 	u8 *tx_data;
211 	u8 *tx_buffer;
212 	u16 tx_data_length;	/* should contain allocated length */
213 	u16 tx_data_count;
214 	u16 tx_buffer_count;
215 	struct usb_ctrlrequest ctrl_req_tx;
216 	struct usb_ctrlrequest ctrl_req_rx;
217 
218 	struct usb_endpoint_descriptor *in_endp;
219 	struct usb_endpoint_descriptor *out_endp;
220 
221 	enum rx_ctrl_state rx_state;
222 	u8 rts_state;
223 	u8 dtr_state;
224 	unsigned tx_urb_used:1;
225 
226 	struct tty_port port;
227 	/* from usb_serial_port */
228 	spinlock_t serial_lock;
229 
230 	int (*write_data) (struct hso_serial *serial);
231 	struct hso_tiocmget  *tiocmget;
232 	/* Hacks required to get flow control
233 	 * working on the serial receive buffers
234 	 * so as not to drop characters on the floor.
235 	 */
236 	int  curr_rx_urb_idx;
237 	u8   rx_urb_filled[MAX_RX_URBS];
238 	struct tasklet_struct unthrottle_tasklet;
239 };
240 
241 struct hso_device {
242 	union {
243 		struct hso_serial *dev_serial;
244 		struct hso_net *dev_net;
245 	} port_data;
246 
247 	u32 port_spec;
248 
249 	u8 is_active;
250 	u8 usb_gone;
251 	struct work_struct async_get_intf;
252 	struct work_struct async_put_intf;
253 
254 	struct usb_device *usb;
255 	struct usb_interface *interface;
256 
257 	struct device *dev;
258 	struct kref ref;
259 	struct mutex mutex;
260 };
261 
262 /* Type of interface */
263 #define HSO_INTF_MASK		0xFF00
264 #define	HSO_INTF_MUX		0x0100
265 #define	HSO_INTF_BULK   	0x0200
266 
267 /* Type of port */
268 #define HSO_PORT_MASK		0xFF
269 #define HSO_PORT_NO_PORT	0x0
270 #define	HSO_PORT_CONTROL	0x1
271 #define	HSO_PORT_APP		0x2
272 #define	HSO_PORT_GPS		0x3
273 #define	HSO_PORT_PCSC		0x4
274 #define	HSO_PORT_APP2		0x5
275 #define HSO_PORT_GPS_CONTROL	0x6
276 #define HSO_PORT_MSD		0x7
277 #define HSO_PORT_VOICE		0x8
278 #define HSO_PORT_DIAG2		0x9
279 #define	HSO_PORT_DIAG		0x10
280 #define	HSO_PORT_MODEM		0x11
281 #define	HSO_PORT_NETWORK	0x12
282 
283 /* Additional device info */
284 #define HSO_INFO_MASK		0xFF000000
285 #define HSO_INFO_CRC_BUG	0x01000000
286 
287 /*****************************************************************************/
288 /* Prototypes                                                                */
289 /*****************************************************************************/
290 /* Serial driver functions */
291 static int hso_serial_tiocmset(struct tty_struct *tty,
292 			       unsigned int set, unsigned int clear);
293 static void ctrl_callback(struct urb *urb);
294 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
295 static void hso_kick_transmit(struct hso_serial *serial);
296 /* Helper functions */
297 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
298 				   struct usb_device *usb, gfp_t gfp);
299 static void handle_usb_error(int status, const char *function,
300 			     struct hso_device *hso_dev);
301 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
302 						  int type, int dir);
303 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
304 static void hso_free_interface(struct usb_interface *intf);
305 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
306 static int hso_stop_serial_device(struct hso_device *hso_dev);
307 static int hso_start_net_device(struct hso_device *hso_dev);
308 static void hso_free_shared_int(struct hso_shared_int *shared_int);
309 static int hso_stop_net_device(struct hso_device *hso_dev);
310 static void hso_serial_ref_free(struct kref *ref);
311 static void hso_std_serial_read_bulk_callback(struct urb *urb);
312 static int hso_mux_serial_read(struct hso_serial *serial);
313 static void async_get_intf(struct work_struct *data);
314 static void async_put_intf(struct work_struct *data);
315 static int hso_put_activity(struct hso_device *hso_dev);
316 static int hso_get_activity(struct hso_device *hso_dev);
317 static void tiocmget_intr_callback(struct urb *urb);
318 /*****************************************************************************/
319 /* Helping functions                                                         */
320 /*****************************************************************************/
321 
322 /* #define DEBUG */
323 
324 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
325 {
326 	return hso_dev->port_data.dev_net;
327 }
328 
329 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
330 {
331 	return hso_dev->port_data.dev_serial;
332 }
333 
334 /* Debugging functions */
335 #ifdef DEBUG
336 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
337 		     unsigned int len)
338 {
339 	static char name[255];
340 
341 	sprintf(name, "hso[%d:%s]", line_count, func_name);
342 	print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
343 }
344 
345 #define DUMP(buf_, len_)	\
346 	dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
347 
348 #define DUMP1(buf_, len_)			\
349 	do {					\
350 		if (0x01 & debug)		\
351 			DUMP(buf_, len_);	\
352 	} while (0)
353 #else
354 #define DUMP(buf_, len_)
355 #define DUMP1(buf_, len_)
356 #endif
357 
358 /* module parameters */
359 static int debug;
360 static int tty_major;
361 static int disable_net;
362 
363 /* driver info */
364 static const char driver_name[] = "hso";
365 static const char tty_filename[] = "ttyHS";
366 static const char *version = __FILE__ ": " MOD_AUTHOR;
367 /* the usb driver itself (registered in hso_init) */
368 static struct usb_driver hso_driver;
369 /* serial structures */
370 static struct tty_driver *tty_drv;
371 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
372 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
373 static spinlock_t serial_table_lock;
374 
375 static const s32 default_port_spec[] = {
376 	HSO_INTF_MUX | HSO_PORT_NETWORK,
377 	HSO_INTF_BULK | HSO_PORT_DIAG,
378 	HSO_INTF_BULK | HSO_PORT_MODEM,
379 	0
380 };
381 
382 static const s32 icon321_port_spec[] = {
383 	HSO_INTF_MUX | HSO_PORT_NETWORK,
384 	HSO_INTF_BULK | HSO_PORT_DIAG2,
385 	HSO_INTF_BULK | HSO_PORT_MODEM,
386 	HSO_INTF_BULK | HSO_PORT_DIAG,
387 	0
388 };
389 
390 #define default_port_device(vendor, product)	\
391 	USB_DEVICE(vendor, product),	\
392 		.driver_info = (kernel_ulong_t)default_port_spec
393 
394 #define icon321_port_device(vendor, product)	\
395 	USB_DEVICE(vendor, product),	\
396 		.driver_info = (kernel_ulong_t)icon321_port_spec
397 
398 /* list of devices we support */
399 static const struct usb_device_id hso_ids[] = {
400 	{default_port_device(0x0af0, 0x6711)},
401 	{default_port_device(0x0af0, 0x6731)},
402 	{default_port_device(0x0af0, 0x6751)},
403 	{default_port_device(0x0af0, 0x6771)},
404 	{default_port_device(0x0af0, 0x6791)},
405 	{default_port_device(0x0af0, 0x6811)},
406 	{default_port_device(0x0af0, 0x6911)},
407 	{default_port_device(0x0af0, 0x6951)},
408 	{default_port_device(0x0af0, 0x6971)},
409 	{default_port_device(0x0af0, 0x7011)},
410 	{default_port_device(0x0af0, 0x7031)},
411 	{default_port_device(0x0af0, 0x7051)},
412 	{default_port_device(0x0af0, 0x7071)},
413 	{default_port_device(0x0af0, 0x7111)},
414 	{default_port_device(0x0af0, 0x7211)},
415 	{default_port_device(0x0af0, 0x7251)},
416 	{default_port_device(0x0af0, 0x7271)},
417 	{default_port_device(0x0af0, 0x7311)},
418 	{default_port_device(0x0af0, 0xc031)},	/* Icon-Edge */
419 	{icon321_port_device(0x0af0, 0xd013)},	/* Module HSxPA */
420 	{icon321_port_device(0x0af0, 0xd031)},	/* Icon-321 */
421 	{icon321_port_device(0x0af0, 0xd033)},	/* Icon-322 */
422 	{USB_DEVICE(0x0af0, 0x7301)},		/* GE40x */
423 	{USB_DEVICE(0x0af0, 0x7361)},		/* GE40x */
424 	{USB_DEVICE(0x0af0, 0x7381)},		/* GE40x */
425 	{USB_DEVICE(0x0af0, 0x7401)},		/* GI 0401 */
426 	{USB_DEVICE(0x0af0, 0x7501)},		/* GTM 382 */
427 	{USB_DEVICE(0x0af0, 0x7601)},		/* GE40x */
428 	{USB_DEVICE(0x0af0, 0x7701)},
429 	{USB_DEVICE(0x0af0, 0x7706)},
430 	{USB_DEVICE(0x0af0, 0x7801)},
431 	{USB_DEVICE(0x0af0, 0x7901)},
432 	{USB_DEVICE(0x0af0, 0x7A01)},
433 	{USB_DEVICE(0x0af0, 0x7A05)},
434 	{USB_DEVICE(0x0af0, 0x8200)},
435 	{USB_DEVICE(0x0af0, 0x8201)},
436 	{USB_DEVICE(0x0af0, 0x8300)},
437 	{USB_DEVICE(0x0af0, 0x8302)},
438 	{USB_DEVICE(0x0af0, 0x8304)},
439 	{USB_DEVICE(0x0af0, 0x8400)},
440 	{USB_DEVICE(0x0af0, 0x8600)},
441 	{USB_DEVICE(0x0af0, 0x8800)},
442 	{USB_DEVICE(0x0af0, 0x8900)},
443 	{USB_DEVICE(0x0af0, 0x9000)},
444 	{USB_DEVICE(0x0af0, 0x9200)},		/* Option GTM671WFS */
445 	{USB_DEVICE(0x0af0, 0xd035)},
446 	{USB_DEVICE(0x0af0, 0xd055)},
447 	{USB_DEVICE(0x0af0, 0xd155)},
448 	{USB_DEVICE(0x0af0, 0xd255)},
449 	{USB_DEVICE(0x0af0, 0xd057)},
450 	{USB_DEVICE(0x0af0, 0xd157)},
451 	{USB_DEVICE(0x0af0, 0xd257)},
452 	{USB_DEVICE(0x0af0, 0xd357)},
453 	{USB_DEVICE(0x0af0, 0xd058)},
454 	{USB_DEVICE(0x0af0, 0xc100)},
455 	{}
456 };
457 MODULE_DEVICE_TABLE(usb, hso_ids);
458 
459 /* Sysfs attribute */
460 static ssize_t hso_sysfs_show_porttype(struct device *dev,
461 				       struct device_attribute *attr,
462 				       char *buf)
463 {
464 	struct hso_device *hso_dev = dev_get_drvdata(dev);
465 	char *port_name;
466 
467 	if (!hso_dev)
468 		return 0;
469 
470 	switch (hso_dev->port_spec & HSO_PORT_MASK) {
471 	case HSO_PORT_CONTROL:
472 		port_name = "Control";
473 		break;
474 	case HSO_PORT_APP:
475 		port_name = "Application";
476 		break;
477 	case HSO_PORT_APP2:
478 		port_name = "Application2";
479 		break;
480 	case HSO_PORT_GPS:
481 		port_name = "GPS";
482 		break;
483 	case HSO_PORT_GPS_CONTROL:
484 		port_name = "GPS Control";
485 		break;
486 	case HSO_PORT_PCSC:
487 		port_name = "PCSC";
488 		break;
489 	case HSO_PORT_DIAG:
490 		port_name = "Diagnostic";
491 		break;
492 	case HSO_PORT_DIAG2:
493 		port_name = "Diagnostic2";
494 		break;
495 	case HSO_PORT_MODEM:
496 		port_name = "Modem";
497 		break;
498 	case HSO_PORT_NETWORK:
499 		port_name = "Network";
500 		break;
501 	default:
502 		port_name = "Unknown";
503 		break;
504 	}
505 
506 	return sprintf(buf, "%s\n", port_name);
507 }
508 static DEVICE_ATTR(hsotype, 0444, hso_sysfs_show_porttype, NULL);
509 
510 static struct attribute *hso_serial_dev_attrs[] = {
511 	&dev_attr_hsotype.attr,
512 	NULL
513 };
514 
515 ATTRIBUTE_GROUPS(hso_serial_dev);
516 
517 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
518 {
519 	int idx;
520 
521 	for (idx = 0; idx < serial->num_rx_urbs; idx++)
522 		if (serial->rx_urb[idx] == urb)
523 			return idx;
524 	dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
525 	return -1;
526 }
527 
528 /* converts mux value to a port spec value */
529 static u32 hso_mux_to_port(int mux)
530 {
531 	u32 result;
532 
533 	switch (mux) {
534 	case 0x1:
535 		result = HSO_PORT_CONTROL;
536 		break;
537 	case 0x2:
538 		result = HSO_PORT_APP;
539 		break;
540 	case 0x4:
541 		result = HSO_PORT_PCSC;
542 		break;
543 	case 0x8:
544 		result = HSO_PORT_GPS;
545 		break;
546 	case 0x10:
547 		result = HSO_PORT_APP2;
548 		break;
549 	default:
550 		result = HSO_PORT_NO_PORT;
551 	}
552 	return result;
553 }
554 
555 /* converts port spec value to a mux value */
556 static u32 hso_port_to_mux(int port)
557 {
558 	u32 result;
559 
560 	switch (port & HSO_PORT_MASK) {
561 	case HSO_PORT_CONTROL:
562 		result = 0x0;
563 		break;
564 	case HSO_PORT_APP:
565 		result = 0x1;
566 		break;
567 	case HSO_PORT_PCSC:
568 		result = 0x2;
569 		break;
570 	case HSO_PORT_GPS:
571 		result = 0x3;
572 		break;
573 	case HSO_PORT_APP2:
574 		result = 0x4;
575 		break;
576 	default:
577 		result = 0x0;
578 	}
579 	return result;
580 }
581 
582 static struct hso_serial *get_serial_by_shared_int_and_type(
583 					struct hso_shared_int *shared_int,
584 					int mux)
585 {
586 	int i, port;
587 
588 	port = hso_mux_to_port(mux);
589 
590 	for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
591 		if (serial_table[i] &&
592 		    (dev2ser(serial_table[i])->shared_int == shared_int) &&
593 		    ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
594 			return dev2ser(serial_table[i]);
595 		}
596 	}
597 
598 	return NULL;
599 }
600 
601 static struct hso_serial *get_serial_by_index(unsigned index)
602 {
603 	struct hso_serial *serial = NULL;
604 	unsigned long flags;
605 
606 	spin_lock_irqsave(&serial_table_lock, flags);
607 	if (serial_table[index])
608 		serial = dev2ser(serial_table[index]);
609 	spin_unlock_irqrestore(&serial_table_lock, flags);
610 
611 	return serial;
612 }
613 
614 static int get_free_serial_index(void)
615 {
616 	int index;
617 	unsigned long flags;
618 
619 	spin_lock_irqsave(&serial_table_lock, flags);
620 	for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
621 		if (serial_table[index] == NULL) {
622 			spin_unlock_irqrestore(&serial_table_lock, flags);
623 			return index;
624 		}
625 	}
626 	spin_unlock_irqrestore(&serial_table_lock, flags);
627 
628 	pr_err("%s: no free serial devices in table\n", __func__);
629 	return -1;
630 }
631 
632 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
633 {
634 	unsigned long flags;
635 
636 	spin_lock_irqsave(&serial_table_lock, flags);
637 	if (serial)
638 		serial_table[index] = serial->parent;
639 	else
640 		serial_table[index] = NULL;
641 	spin_unlock_irqrestore(&serial_table_lock, flags);
642 }
643 
644 static void handle_usb_error(int status, const char *function,
645 			     struct hso_device *hso_dev)
646 {
647 	char *explanation;
648 
649 	switch (status) {
650 	case -ENODEV:
651 		explanation = "no device";
652 		break;
653 	case -ENOENT:
654 		explanation = "endpoint not enabled";
655 		break;
656 	case -EPIPE:
657 		explanation = "endpoint stalled";
658 		break;
659 	case -ENOSPC:
660 		explanation = "not enough bandwidth";
661 		break;
662 	case -ESHUTDOWN:
663 		explanation = "device disabled";
664 		break;
665 	case -EHOSTUNREACH:
666 		explanation = "device suspended";
667 		break;
668 	case -EINVAL:
669 	case -EAGAIN:
670 	case -EFBIG:
671 	case -EMSGSIZE:
672 		explanation = "internal error";
673 		break;
674 	case -EILSEQ:
675 	case -EPROTO:
676 	case -ETIME:
677 	case -ETIMEDOUT:
678 		explanation = "protocol error";
679 		if (hso_dev)
680 			usb_queue_reset_device(hso_dev->interface);
681 		break;
682 	default:
683 		explanation = "unknown status";
684 		break;
685 	}
686 
687 	/* log a meaningful explanation of an USB status */
688 	hso_dbg(0x1, "%s: received USB status - %s (%d)\n",
689 		function, explanation, status);
690 }
691 
692 /* Network interface functions */
693 
694 /* called when net interface is brought up by ifconfig */
695 static int hso_net_open(struct net_device *net)
696 {
697 	struct hso_net *odev = netdev_priv(net);
698 	unsigned long flags = 0;
699 
700 	if (!odev) {
701 		dev_err(&net->dev, "No net device !\n");
702 		return -ENODEV;
703 	}
704 
705 	odev->skb_tx_buf = NULL;
706 
707 	/* setup environment */
708 	spin_lock_irqsave(&odev->net_lock, flags);
709 	odev->rx_parse_state = WAIT_IP;
710 	odev->rx_buf_size = 0;
711 	odev->rx_buf_missing = sizeof(struct iphdr);
712 	spin_unlock_irqrestore(&odev->net_lock, flags);
713 
714 	/* We are up and running. */
715 	set_bit(HSO_NET_RUNNING, &odev->flags);
716 	hso_start_net_device(odev->parent);
717 
718 	/* Tell the kernel we are ready to start receiving from it */
719 	netif_start_queue(net);
720 
721 	return 0;
722 }
723 
724 /* called when interface is brought down by ifconfig */
725 static int hso_net_close(struct net_device *net)
726 {
727 	struct hso_net *odev = netdev_priv(net);
728 
729 	/* we don't need the queue anymore */
730 	netif_stop_queue(net);
731 	/* no longer running */
732 	clear_bit(HSO_NET_RUNNING, &odev->flags);
733 
734 	hso_stop_net_device(odev->parent);
735 
736 	/* done */
737 	return 0;
738 }
739 
740 /* USB tells is xmit done, we should start the netqueue again */
741 static void write_bulk_callback(struct urb *urb)
742 {
743 	struct hso_net *odev = urb->context;
744 	int status = urb->status;
745 
746 	/* Sanity check */
747 	if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
748 		dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
749 		return;
750 	}
751 
752 	/* Do we still have a valid kernel network device? */
753 	if (!netif_device_present(odev->net)) {
754 		dev_err(&urb->dev->dev, "%s: net device not present\n",
755 			__func__);
756 		return;
757 	}
758 
759 	/* log status, but don't act on it, we don't need to resubmit anything
760 	 * anyhow */
761 	if (status)
762 		handle_usb_error(status, __func__, odev->parent);
763 
764 	hso_put_activity(odev->parent);
765 
766 	/* Tell the network interface we are ready for another frame */
767 	netif_wake_queue(odev->net);
768 }
769 
770 /* called by kernel when we need to transmit a packet */
771 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
772 					    struct net_device *net)
773 {
774 	struct hso_net *odev = netdev_priv(net);
775 	int result;
776 
777 	/* Tell the kernel, "No more frames 'til we are done with this one." */
778 	netif_stop_queue(net);
779 	if (hso_get_activity(odev->parent) == -EAGAIN) {
780 		odev->skb_tx_buf = skb;
781 		return NETDEV_TX_OK;
782 	}
783 
784 	/* log if asked */
785 	DUMP1(skb->data, skb->len);
786 	/* Copy it from kernel memory to OUR memory */
787 	memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
788 	hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE);
789 
790 	/* Fill in the URB for shipping it out. */
791 	usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
792 			  odev->parent->usb,
793 			  usb_sndbulkpipe(odev->parent->usb,
794 					  odev->out_endp->
795 					  bEndpointAddress & 0x7F),
796 			  odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
797 			  odev);
798 
799 	/* Deal with the Zero Length packet problem, I hope */
800 	odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
801 
802 	/* Send the URB on its merry way. */
803 	result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
804 	if (result) {
805 		dev_warn(&odev->parent->interface->dev,
806 			"failed mux_bulk_tx_urb %d\n", result);
807 		net->stats.tx_errors++;
808 		netif_start_queue(net);
809 	} else {
810 		net->stats.tx_packets++;
811 		net->stats.tx_bytes += skb->len;
812 	}
813 	dev_kfree_skb(skb);
814 	/* we're done */
815 	return NETDEV_TX_OK;
816 }
817 
818 static const struct ethtool_ops ops = {
819 	.get_link = ethtool_op_get_link
820 };
821 
822 /* called when a packet did not ack after watchdogtimeout */
823 static void hso_net_tx_timeout(struct net_device *net)
824 {
825 	struct hso_net *odev = netdev_priv(net);
826 
827 	if (!odev)
828 		return;
829 
830 	/* Tell syslog we are hosed. */
831 	dev_warn(&net->dev, "Tx timed out.\n");
832 
833 	/* Tear the waiting frame off the list */
834 	if (odev->mux_bulk_tx_urb &&
835 	    (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
836 		usb_unlink_urb(odev->mux_bulk_tx_urb);
837 
838 	/* Update statistics */
839 	net->stats.tx_errors++;
840 }
841 
842 /* make a real packet from the received USB buffer */
843 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
844 			unsigned int count, unsigned char is_eop)
845 {
846 	unsigned short temp_bytes;
847 	unsigned short buffer_offset = 0;
848 	unsigned short frame_len;
849 
850 	/* log if needed */
851 	hso_dbg(0x1, "Rx %d bytes\n", count);
852 	DUMP(ip_pkt, min(128, (int)count));
853 
854 	while (count) {
855 		switch (odev->rx_parse_state) {
856 		case WAIT_IP:
857 			/* waiting for IP header. */
858 			/* wanted bytes - size of ip header */
859 			temp_bytes =
860 			    (count <
861 			     odev->rx_buf_missing) ? count : odev->
862 			    rx_buf_missing;
863 
864 			memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
865 			       odev->rx_buf_size, ip_pkt + buffer_offset,
866 			       temp_bytes);
867 
868 			odev->rx_buf_size += temp_bytes;
869 			buffer_offset += temp_bytes;
870 			odev->rx_buf_missing -= temp_bytes;
871 			count -= temp_bytes;
872 
873 			if (!odev->rx_buf_missing) {
874 				/* header is complete allocate an sk_buffer and
875 				 * continue to WAIT_DATA */
876 				frame_len = ntohs(odev->rx_ip_hdr.tot_len);
877 
878 				if ((frame_len > DEFAULT_MRU) ||
879 				    (frame_len < sizeof(struct iphdr))) {
880 					dev_err(&odev->net->dev,
881 						"Invalid frame (%d) length\n",
882 						frame_len);
883 					odev->rx_parse_state = WAIT_SYNC;
884 					continue;
885 				}
886 				/* Allocate an sk_buff */
887 				odev->skb_rx_buf = netdev_alloc_skb(odev->net,
888 								    frame_len);
889 				if (!odev->skb_rx_buf) {
890 					/* We got no receive buffer. */
891 					hso_dbg(0x1, "could not allocate memory\n");
892 					odev->rx_parse_state = WAIT_SYNC;
893 					continue;
894 				}
895 
896 				/* Copy what we got so far. make room for iphdr
897 				 * after tail. */
898 				skb_put_data(odev->skb_rx_buf,
899 					     (char *)&(odev->rx_ip_hdr),
900 					     sizeof(struct iphdr));
901 
902 				/* ETH_HLEN */
903 				odev->rx_buf_size = sizeof(struct iphdr);
904 
905 				/* Filip actually use .tot_len */
906 				odev->rx_buf_missing =
907 				    frame_len - sizeof(struct iphdr);
908 				odev->rx_parse_state = WAIT_DATA;
909 			}
910 			break;
911 
912 		case WAIT_DATA:
913 			temp_bytes = (count < odev->rx_buf_missing)
914 					? count : odev->rx_buf_missing;
915 
916 			/* Copy the rest of the bytes that are left in the
917 			 * buffer into the waiting sk_buf. */
918 			/* Make room for temp_bytes after tail. */
919 			skb_put_data(odev->skb_rx_buf,
920 				     ip_pkt + buffer_offset,
921 				     temp_bytes);
922 
923 			odev->rx_buf_missing -= temp_bytes;
924 			count -= temp_bytes;
925 			buffer_offset += temp_bytes;
926 			odev->rx_buf_size += temp_bytes;
927 			if (!odev->rx_buf_missing) {
928 				/* Packet is complete. Inject into stack. */
929 				/* We have IP packet here */
930 				odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
931 				skb_reset_mac_header(odev->skb_rx_buf);
932 
933 				/* Ship it off to the kernel */
934 				netif_rx(odev->skb_rx_buf);
935 				/* No longer our buffer. */
936 				odev->skb_rx_buf = NULL;
937 
938 				/* update out statistics */
939 				odev->net->stats.rx_packets++;
940 
941 				odev->net->stats.rx_bytes += odev->rx_buf_size;
942 
943 				odev->rx_buf_size = 0;
944 				odev->rx_buf_missing = sizeof(struct iphdr);
945 				odev->rx_parse_state = WAIT_IP;
946 			}
947 			break;
948 
949 		case WAIT_SYNC:
950 			hso_dbg(0x1, " W_S\n");
951 			count = 0;
952 			break;
953 		default:
954 			hso_dbg(0x1, "\n");
955 			count--;
956 			break;
957 		}
958 	}
959 
960 	/* Recovery mechanism for WAIT_SYNC state. */
961 	if (is_eop) {
962 		if (odev->rx_parse_state == WAIT_SYNC) {
963 			odev->rx_parse_state = WAIT_IP;
964 			odev->rx_buf_size = 0;
965 			odev->rx_buf_missing = sizeof(struct iphdr);
966 		}
967 	}
968 }
969 
970 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
971 {
972 	static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
973 	u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
974 
975 	if (((rest == 5) || (rest == 6)) &&
976 	    !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
977 		    crc_check, 4)) {
978 		urb->actual_length -= 4;
979 	}
980 }
981 
982 /* Moving data from usb to kernel (in interrupt state) */
983 static void read_bulk_callback(struct urb *urb)
984 {
985 	struct hso_net *odev = urb->context;
986 	struct net_device *net;
987 	int result;
988 	unsigned long flags;
989 	int status = urb->status;
990 
991 	/* is al ok?  (Filip: Who's Al ?) */
992 	if (status) {
993 		handle_usb_error(status, __func__, odev->parent);
994 		return;
995 	}
996 
997 	/* Sanity check */
998 	if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
999 		hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
1000 		return;
1001 	}
1002 	usb_mark_last_busy(urb->dev);
1003 
1004 	net = odev->net;
1005 
1006 	if (!netif_device_present(net)) {
1007 		/* Somebody killed our network interface... */
1008 		return;
1009 	}
1010 
1011 	if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1012 		fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1013 
1014 	/* do we even have a packet? */
1015 	if (urb->actual_length) {
1016 		/* Handle the IP stream, add header and push it onto network
1017 		 * stack if the packet is complete. */
1018 		spin_lock_irqsave(&odev->net_lock, flags);
1019 		packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1020 			    (urb->transfer_buffer_length >
1021 			     urb->actual_length) ? 1 : 0);
1022 		spin_unlock_irqrestore(&odev->net_lock, flags);
1023 	}
1024 
1025 	/* We are done with this URB, resubmit it. Prep the USB to wait for
1026 	 * another frame. Reuse same as received. */
1027 	usb_fill_bulk_urb(urb,
1028 			  odev->parent->usb,
1029 			  usb_rcvbulkpipe(odev->parent->usb,
1030 					  odev->in_endp->
1031 					  bEndpointAddress & 0x7F),
1032 			  urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1033 			  read_bulk_callback, odev);
1034 
1035 	/* Give this to the USB subsystem so it can tell us when more data
1036 	 * arrives. */
1037 	result = usb_submit_urb(urb, GFP_ATOMIC);
1038 	if (result)
1039 		dev_warn(&odev->parent->interface->dev,
1040 			 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1041 			 result);
1042 }
1043 
1044 /* Serial driver functions */
1045 
1046 static void hso_init_termios(struct ktermios *termios)
1047 {
1048 	/*
1049 	 * The default requirements for this device are:
1050 	 */
1051 	termios->c_iflag &=
1052 		~(IGNBRK	/* disable ignore break */
1053 		| BRKINT	/* disable break causes interrupt */
1054 		| PARMRK	/* disable mark parity errors */
1055 		| ISTRIP	/* disable clear high bit of input characters */
1056 		| INLCR		/* disable translate NL to CR */
1057 		| IGNCR		/* disable ignore CR */
1058 		| ICRNL		/* disable translate CR to NL */
1059 		| IXON);	/* disable enable XON/XOFF flow control */
1060 
1061 	/* disable postprocess output characters */
1062 	termios->c_oflag &= ~OPOST;
1063 
1064 	termios->c_lflag &=
1065 		~(ECHO		/* disable echo input characters */
1066 		| ECHONL	/* disable echo new line */
1067 		| ICANON	/* disable erase, kill, werase, and rprnt
1068 				   special characters */
1069 		| ISIG		/* disable interrupt, quit, and suspend special
1070 				   characters */
1071 		| IEXTEN);	/* disable non-POSIX special characters */
1072 
1073 	termios->c_cflag &=
1074 		~(CSIZE		/* no size */
1075 		| PARENB	/* disable parity bit */
1076 		| CBAUD		/* clear current baud rate */
1077 		| CBAUDEX);	/* clear current buad rate */
1078 
1079 	termios->c_cflag |= CS8;	/* character size 8 bits */
1080 
1081 	/* baud rate 115200 */
1082 	tty_termios_encode_baud_rate(termios, 115200, 115200);
1083 }
1084 
1085 static void _hso_serial_set_termios(struct tty_struct *tty,
1086 				    struct ktermios *old)
1087 {
1088 	struct hso_serial *serial = tty->driver_data;
1089 
1090 	if (!serial) {
1091 		pr_err("%s: no tty structures", __func__);
1092 		return;
1093 	}
1094 
1095 	hso_dbg(0x8, "port %d\n", serial->minor);
1096 
1097 	/*
1098 	 *	Fix up unsupported bits
1099 	 */
1100 	tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1101 
1102 	tty->termios.c_cflag &=
1103 		~(CSIZE		/* no size */
1104 		| PARENB	/* disable parity bit */
1105 		| CBAUD		/* clear current baud rate */
1106 		| CBAUDEX);	/* clear current buad rate */
1107 
1108 	tty->termios.c_cflag |= CS8;	/* character size 8 bits */
1109 
1110 	/* baud rate 115200 */
1111 	tty_encode_baud_rate(tty, 115200, 115200);
1112 }
1113 
1114 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1115 {
1116 	int result;
1117 	/* We are done with this URB, resubmit it. Prep the USB to wait for
1118 	 * another frame */
1119 	usb_fill_bulk_urb(urb, serial->parent->usb,
1120 			  usb_rcvbulkpipe(serial->parent->usb,
1121 					  serial->in_endp->
1122 					  bEndpointAddress & 0x7F),
1123 			  urb->transfer_buffer, serial->rx_data_length,
1124 			  hso_std_serial_read_bulk_callback, serial);
1125 	/* Give this to the USB subsystem so it can tell us when more data
1126 	 * arrives. */
1127 	result = usb_submit_urb(urb, GFP_ATOMIC);
1128 	if (result) {
1129 		dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1130 			__func__, result);
1131 	}
1132 }
1133 
1134 
1135 
1136 
1137 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1138 {
1139 	int count;
1140 	struct urb *curr_urb;
1141 
1142 	while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1143 		curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1144 		count = put_rxbuf_data(curr_urb, serial);
1145 		if (count == -1)
1146 			return;
1147 		if (count == 0) {
1148 			serial->curr_rx_urb_idx++;
1149 			if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1150 				serial->curr_rx_urb_idx = 0;
1151 			hso_resubmit_rx_bulk_urb(serial, curr_urb);
1152 		}
1153 	}
1154 }
1155 
1156 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1157 {
1158 	int count = 0;
1159 	struct urb *urb;
1160 
1161 	urb = serial->rx_urb[0];
1162 	if (serial->port.count > 0) {
1163 		count = put_rxbuf_data(urb, serial);
1164 		if (count == -1)
1165 			return;
1166 	}
1167 	/* Re issue a read as long as we receive data. */
1168 
1169 	if (count == 0 && ((urb->actual_length != 0) ||
1170 			   (serial->rx_state == RX_PENDING))) {
1171 		serial->rx_state = RX_SENT;
1172 		hso_mux_serial_read(serial);
1173 	} else
1174 		serial->rx_state = RX_IDLE;
1175 }
1176 
1177 
1178 /* read callback for Diag and CS port */
1179 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1180 {
1181 	struct hso_serial *serial = urb->context;
1182 	int status = urb->status;
1183 	unsigned long flags;
1184 
1185 	hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1186 
1187 	/* sanity check */
1188 	if (!serial) {
1189 		hso_dbg(0x1, "serial == NULL\n");
1190 		return;
1191 	}
1192 	if (status) {
1193 		handle_usb_error(status, __func__, serial->parent);
1194 		return;
1195 	}
1196 
1197 	hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1198 	DUMP1(urb->transfer_buffer, urb->actual_length);
1199 
1200 	/* Anyone listening? */
1201 	if (serial->port.count == 0)
1202 		return;
1203 
1204 	if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1205 		fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1206 	/* Valid data, handle RX data */
1207 	spin_lock_irqsave(&serial->serial_lock, flags);
1208 	serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1209 	put_rxbuf_data_and_resubmit_bulk_urb(serial);
1210 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1211 }
1212 
1213 /*
1214  * This needs to be a tasklet otherwise we will
1215  * end up recursively calling this function.
1216  */
1217 static void hso_unthrottle_tasklet(unsigned long data)
1218 {
1219 	struct hso_serial *serial = (struct hso_serial *)data;
1220 	unsigned long flags;
1221 
1222 	spin_lock_irqsave(&serial->serial_lock, flags);
1223 	if ((serial->parent->port_spec & HSO_INTF_MUX))
1224 		put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1225 	else
1226 		put_rxbuf_data_and_resubmit_bulk_urb(serial);
1227 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1228 }
1229 
1230 static	void hso_unthrottle(struct tty_struct *tty)
1231 {
1232 	struct hso_serial *serial = tty->driver_data;
1233 
1234 	tasklet_hi_schedule(&serial->unthrottle_tasklet);
1235 }
1236 
1237 /* open the requested serial port */
1238 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1239 {
1240 	struct hso_serial *serial = get_serial_by_index(tty->index);
1241 	int result;
1242 
1243 	/* sanity check */
1244 	if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1245 		WARN_ON(1);
1246 		tty->driver_data = NULL;
1247 		hso_dbg(0x1, "Failed to open port\n");
1248 		return -ENODEV;
1249 	}
1250 
1251 	mutex_lock(&serial->parent->mutex);
1252 	result = usb_autopm_get_interface(serial->parent->interface);
1253 	if (result < 0)
1254 		goto err_out;
1255 
1256 	hso_dbg(0x1, "Opening %d\n", serial->minor);
1257 
1258 	/* setup */
1259 	tty->driver_data = serial;
1260 	tty_port_tty_set(&serial->port, tty);
1261 
1262 	/* check for port already opened, if not set the termios */
1263 	serial->port.count++;
1264 	if (serial->port.count == 1) {
1265 		serial->rx_state = RX_IDLE;
1266 		/* Force default termio settings */
1267 		_hso_serial_set_termios(tty, NULL);
1268 		tasklet_init(&serial->unthrottle_tasklet,
1269 			     hso_unthrottle_tasklet,
1270 			     (unsigned long)serial);
1271 		result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1272 		if (result) {
1273 			hso_stop_serial_device(serial->parent);
1274 			serial->port.count--;
1275 		} else {
1276 			kref_get(&serial->parent->ref);
1277 		}
1278 	} else {
1279 		hso_dbg(0x1, "Port was already open\n");
1280 	}
1281 
1282 	usb_autopm_put_interface(serial->parent->interface);
1283 
1284 	/* done */
1285 	if (result)
1286 		hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1287 err_out:
1288 	mutex_unlock(&serial->parent->mutex);
1289 	return result;
1290 }
1291 
1292 /* close the requested serial port */
1293 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1294 {
1295 	struct hso_serial *serial = tty->driver_data;
1296 	u8 usb_gone;
1297 
1298 	hso_dbg(0x1, "Closing serial port\n");
1299 
1300 	/* Open failed, no close cleanup required */
1301 	if (serial == NULL)
1302 		return;
1303 
1304 	mutex_lock(&serial->parent->mutex);
1305 	usb_gone = serial->parent->usb_gone;
1306 
1307 	if (!usb_gone)
1308 		usb_autopm_get_interface(serial->parent->interface);
1309 
1310 	/* reset the rts and dtr */
1311 	/* do the actual close */
1312 	serial->port.count--;
1313 
1314 	if (serial->port.count <= 0) {
1315 		serial->port.count = 0;
1316 		tty_port_tty_set(&serial->port, NULL);
1317 		if (!usb_gone)
1318 			hso_stop_serial_device(serial->parent);
1319 		tasklet_kill(&serial->unthrottle_tasklet);
1320 	}
1321 
1322 	if (!usb_gone)
1323 		usb_autopm_put_interface(serial->parent->interface);
1324 
1325 	mutex_unlock(&serial->parent->mutex);
1326 }
1327 
1328 /* close the requested serial port */
1329 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1330 			    int count)
1331 {
1332 	struct hso_serial *serial = tty->driver_data;
1333 	int space, tx_bytes;
1334 	unsigned long flags;
1335 
1336 	/* sanity check */
1337 	if (serial == NULL) {
1338 		pr_err("%s: serial is NULL\n", __func__);
1339 		return -ENODEV;
1340 	}
1341 
1342 	spin_lock_irqsave(&serial->serial_lock, flags);
1343 
1344 	space = serial->tx_data_length - serial->tx_buffer_count;
1345 	tx_bytes = (count < space) ? count : space;
1346 
1347 	if (!tx_bytes)
1348 		goto out;
1349 
1350 	memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1351 	serial->tx_buffer_count += tx_bytes;
1352 
1353 out:
1354 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1355 
1356 	hso_kick_transmit(serial);
1357 	/* done */
1358 	return tx_bytes;
1359 }
1360 
1361 /* how much room is there for writing */
1362 static int hso_serial_write_room(struct tty_struct *tty)
1363 {
1364 	struct hso_serial *serial = tty->driver_data;
1365 	int room;
1366 	unsigned long flags;
1367 
1368 	spin_lock_irqsave(&serial->serial_lock, flags);
1369 	room = serial->tx_data_length - serial->tx_buffer_count;
1370 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1371 
1372 	/* return free room */
1373 	return room;
1374 }
1375 
1376 static void hso_serial_cleanup(struct tty_struct *tty)
1377 {
1378 	struct hso_serial *serial = tty->driver_data;
1379 
1380 	if (!serial)
1381 		return;
1382 
1383 	kref_put(&serial->parent->ref, hso_serial_ref_free);
1384 }
1385 
1386 /* setup the term */
1387 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1388 {
1389 	struct hso_serial *serial = tty->driver_data;
1390 	unsigned long flags;
1391 
1392 	if (old)
1393 		hso_dbg(0x16, "Termios called with: cflags new[%d] - old[%d]\n",
1394 			tty->termios.c_cflag, old->c_cflag);
1395 
1396 	/* the actual setup */
1397 	spin_lock_irqsave(&serial->serial_lock, flags);
1398 	if (serial->port.count)
1399 		_hso_serial_set_termios(tty, old);
1400 	else
1401 		tty->termios = *old;
1402 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1403 
1404 	/* done */
1405 }
1406 
1407 /* how many characters in the buffer */
1408 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1409 {
1410 	struct hso_serial *serial = tty->driver_data;
1411 	int chars;
1412 	unsigned long flags;
1413 
1414 	/* sanity check */
1415 	if (serial == NULL)
1416 		return 0;
1417 
1418 	spin_lock_irqsave(&serial->serial_lock, flags);
1419 	chars = serial->tx_buffer_count;
1420 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1421 
1422 	return chars;
1423 }
1424 static int tiocmget_submit_urb(struct hso_serial *serial,
1425 			       struct hso_tiocmget *tiocmget,
1426 			       struct usb_device *usb)
1427 {
1428 	int result;
1429 
1430 	if (serial->parent->usb_gone)
1431 		return -ENODEV;
1432 	usb_fill_int_urb(tiocmget->urb, usb,
1433 			 usb_rcvintpipe(usb,
1434 					tiocmget->endp->
1435 					bEndpointAddress & 0x7F),
1436 			 tiocmget->serial_state_notification,
1437 			 sizeof(struct hso_serial_state_notification),
1438 			 tiocmget_intr_callback, serial,
1439 			 tiocmget->endp->bInterval);
1440 	result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1441 	if (result) {
1442 		dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1443 			 result);
1444 	}
1445 	return result;
1446 
1447 }
1448 
1449 static void tiocmget_intr_callback(struct urb *urb)
1450 {
1451 	struct hso_serial *serial = urb->context;
1452 	struct hso_tiocmget *tiocmget;
1453 	int status = urb->status;
1454 	u16 UART_state_bitmap, prev_UART_state_bitmap;
1455 	struct uart_icount *icount;
1456 	struct hso_serial_state_notification *serial_state_notification;
1457 	struct usb_device *usb;
1458 	struct usb_interface *interface;
1459 	int if_num;
1460 
1461 	/* Sanity checks */
1462 	if (!serial)
1463 		return;
1464 	if (status) {
1465 		handle_usb_error(status, __func__, serial->parent);
1466 		return;
1467 	}
1468 
1469 	/* tiocmget is only supported on HSO_PORT_MODEM */
1470 	tiocmget = serial->tiocmget;
1471 	if (!tiocmget)
1472 		return;
1473 	BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1474 
1475 	usb = serial->parent->usb;
1476 	interface = serial->parent->interface;
1477 
1478 	if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1479 
1480 	/* wIndex should be the USB interface number of the port to which the
1481 	 * notification applies, which should always be the Modem port.
1482 	 */
1483 	serial_state_notification = tiocmget->serial_state_notification;
1484 	if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1485 	    serial_state_notification->bNotification != B_NOTIFICATION ||
1486 	    le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1487 	    le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1488 	    le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1489 		dev_warn(&usb->dev,
1490 			 "hso received invalid serial state notification\n");
1491 		DUMP(serial_state_notification,
1492 		     sizeof(struct hso_serial_state_notification));
1493 	} else {
1494 		unsigned long flags;
1495 
1496 		UART_state_bitmap = le16_to_cpu(serial_state_notification->
1497 						UART_state_bitmap);
1498 		prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1499 		icount = &tiocmget->icount;
1500 		spin_lock_irqsave(&serial->serial_lock, flags);
1501 		if ((UART_state_bitmap & B_OVERRUN) !=
1502 		   (prev_UART_state_bitmap & B_OVERRUN))
1503 			icount->parity++;
1504 		if ((UART_state_bitmap & B_PARITY) !=
1505 		   (prev_UART_state_bitmap & B_PARITY))
1506 			icount->parity++;
1507 		if ((UART_state_bitmap & B_FRAMING) !=
1508 		   (prev_UART_state_bitmap & B_FRAMING))
1509 			icount->frame++;
1510 		if ((UART_state_bitmap & B_RING_SIGNAL) &&
1511 		   !(prev_UART_state_bitmap & B_RING_SIGNAL))
1512 			icount->rng++;
1513 		if ((UART_state_bitmap & B_BREAK) !=
1514 		   (prev_UART_state_bitmap & B_BREAK))
1515 			icount->brk++;
1516 		if ((UART_state_bitmap & B_TX_CARRIER) !=
1517 		   (prev_UART_state_bitmap & B_TX_CARRIER))
1518 			icount->dsr++;
1519 		if ((UART_state_bitmap & B_RX_CARRIER) !=
1520 		   (prev_UART_state_bitmap & B_RX_CARRIER))
1521 			icount->dcd++;
1522 		tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1523 		spin_unlock_irqrestore(&serial->serial_lock, flags);
1524 		tiocmget->intr_completed = 1;
1525 		wake_up_interruptible(&tiocmget->waitq);
1526 	}
1527 	memset(serial_state_notification, 0,
1528 	       sizeof(struct hso_serial_state_notification));
1529 	tiocmget_submit_urb(serial,
1530 			    tiocmget,
1531 			    serial->parent->usb);
1532 }
1533 
1534 /*
1535  * next few functions largely stolen from drivers/serial/serial_core.c
1536  */
1537 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1538  * - mask passed in arg for lines of interest
1539  *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1540  * Caller should use TIOCGICOUNT to see which one it was
1541  */
1542 static int
1543 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1544 {
1545 	DECLARE_WAITQUEUE(wait, current);
1546 	struct uart_icount cprev, cnow;
1547 	struct hso_tiocmget  *tiocmget;
1548 	int ret;
1549 
1550 	tiocmget = serial->tiocmget;
1551 	if (!tiocmget)
1552 		return -ENOENT;
1553 	/*
1554 	 * note the counters on entry
1555 	 */
1556 	spin_lock_irq(&serial->serial_lock);
1557 	memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1558 	spin_unlock_irq(&serial->serial_lock);
1559 	add_wait_queue(&tiocmget->waitq, &wait);
1560 	for (;;) {
1561 		spin_lock_irq(&serial->serial_lock);
1562 		memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1563 		spin_unlock_irq(&serial->serial_lock);
1564 		set_current_state(TASK_INTERRUPTIBLE);
1565 		if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1566 		    ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1567 		    ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd))) {
1568 			ret = 0;
1569 			break;
1570 		}
1571 		schedule();
1572 		/* see if a signal did it */
1573 		if (signal_pending(current)) {
1574 			ret = -ERESTARTSYS;
1575 			break;
1576 		}
1577 		cprev = cnow;
1578 	}
1579 	__set_current_state(TASK_RUNNING);
1580 	remove_wait_queue(&tiocmget->waitq, &wait);
1581 
1582 	return ret;
1583 }
1584 
1585 /*
1586  * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1587  * Return: write counters to the user passed counter struct
1588  * NB: both 1->0 and 0->1 transitions are counted except for
1589  *     RI where only 0->1 is counted.
1590  */
1591 static int hso_get_count(struct tty_struct *tty,
1592 		  struct serial_icounter_struct *icount)
1593 {
1594 	struct uart_icount cnow;
1595 	struct hso_serial *serial = tty->driver_data;
1596 	struct hso_tiocmget  *tiocmget = serial->tiocmget;
1597 
1598 	memset(icount, 0, sizeof(struct serial_icounter_struct));
1599 
1600 	if (!tiocmget)
1601 		 return -ENOENT;
1602 	spin_lock_irq(&serial->serial_lock);
1603 	memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1604 	spin_unlock_irq(&serial->serial_lock);
1605 
1606 	icount->cts         = cnow.cts;
1607 	icount->dsr         = cnow.dsr;
1608 	icount->rng         = cnow.rng;
1609 	icount->dcd         = cnow.dcd;
1610 	icount->rx          = cnow.rx;
1611 	icount->tx          = cnow.tx;
1612 	icount->frame       = cnow.frame;
1613 	icount->overrun     = cnow.overrun;
1614 	icount->parity      = cnow.parity;
1615 	icount->brk         = cnow.brk;
1616 	icount->buf_overrun = cnow.buf_overrun;
1617 
1618 	return 0;
1619 }
1620 
1621 
1622 static int hso_serial_tiocmget(struct tty_struct *tty)
1623 {
1624 	int retval;
1625 	struct hso_serial *serial = tty->driver_data;
1626 	struct hso_tiocmget  *tiocmget;
1627 	u16 UART_state_bitmap;
1628 
1629 	/* sanity check */
1630 	if (!serial) {
1631 		hso_dbg(0x1, "no tty structures\n");
1632 		return -EINVAL;
1633 	}
1634 	spin_lock_irq(&serial->serial_lock);
1635 	retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1636 	    ((serial->dtr_state) ? TIOCM_DTR : 0);
1637 	tiocmget = serial->tiocmget;
1638 	if (tiocmget) {
1639 
1640 		UART_state_bitmap = le16_to_cpu(
1641 			tiocmget->prev_UART_state_bitmap);
1642 		if (UART_state_bitmap & B_RING_SIGNAL)
1643 			retval |=  TIOCM_RNG;
1644 		if (UART_state_bitmap & B_RX_CARRIER)
1645 			retval |=  TIOCM_CD;
1646 		if (UART_state_bitmap & B_TX_CARRIER)
1647 			retval |=  TIOCM_DSR;
1648 	}
1649 	spin_unlock_irq(&serial->serial_lock);
1650 	return retval;
1651 }
1652 
1653 static int hso_serial_tiocmset(struct tty_struct *tty,
1654 			       unsigned int set, unsigned int clear)
1655 {
1656 	int val = 0;
1657 	unsigned long flags;
1658 	int if_num;
1659 	struct hso_serial *serial = tty->driver_data;
1660 	struct usb_interface *interface;
1661 
1662 	/* sanity check */
1663 	if (!serial) {
1664 		hso_dbg(0x1, "no tty structures\n");
1665 		return -EINVAL;
1666 	}
1667 
1668 	if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1669 		return -EINVAL;
1670 
1671 	interface = serial->parent->interface;
1672 	if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1673 
1674 	spin_lock_irqsave(&serial->serial_lock, flags);
1675 	if (set & TIOCM_RTS)
1676 		serial->rts_state = 1;
1677 	if (set & TIOCM_DTR)
1678 		serial->dtr_state = 1;
1679 
1680 	if (clear & TIOCM_RTS)
1681 		serial->rts_state = 0;
1682 	if (clear & TIOCM_DTR)
1683 		serial->dtr_state = 0;
1684 
1685 	if (serial->dtr_state)
1686 		val |= 0x01;
1687 	if (serial->rts_state)
1688 		val |= 0x02;
1689 
1690 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1691 
1692 	return usb_control_msg(serial->parent->usb,
1693 			       usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1694 			       0x21, val, if_num, NULL, 0,
1695 			       USB_CTRL_SET_TIMEOUT);
1696 }
1697 
1698 static int hso_serial_ioctl(struct tty_struct *tty,
1699 			    unsigned int cmd, unsigned long arg)
1700 {
1701 	struct hso_serial *serial = tty->driver_data;
1702 	int ret = 0;
1703 	hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1704 
1705 	if (!serial)
1706 		return -ENODEV;
1707 	switch (cmd) {
1708 	case TIOCMIWAIT:
1709 		ret = hso_wait_modem_status(serial, arg);
1710 		break;
1711 	default:
1712 		ret = -ENOIOCTLCMD;
1713 		break;
1714 	}
1715 	return ret;
1716 }
1717 
1718 
1719 /* starts a transmit */
1720 static void hso_kick_transmit(struct hso_serial *serial)
1721 {
1722 	unsigned long flags;
1723 	int res;
1724 
1725 	spin_lock_irqsave(&serial->serial_lock, flags);
1726 	if (!serial->tx_buffer_count)
1727 		goto out;
1728 
1729 	if (serial->tx_urb_used)
1730 		goto out;
1731 
1732 	/* Wakeup USB interface if necessary */
1733 	if (hso_get_activity(serial->parent) == -EAGAIN)
1734 		goto out;
1735 
1736 	/* Switch pointers around to avoid memcpy */
1737 	swap(serial->tx_buffer, serial->tx_data);
1738 	serial->tx_data_count = serial->tx_buffer_count;
1739 	serial->tx_buffer_count = 0;
1740 
1741 	/* If serial->tx_data is set, it means we switched buffers */
1742 	if (serial->tx_data && serial->write_data) {
1743 		res = serial->write_data(serial);
1744 		if (res >= 0)
1745 			serial->tx_urb_used = 1;
1746 	}
1747 out:
1748 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1749 }
1750 
1751 /* make a request (for reading and writing data to muxed serial port) */
1752 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1753 			      struct urb *ctrl_urb,
1754 			      struct usb_ctrlrequest *ctrl_req,
1755 			      u8 *ctrl_urb_data, u32 size)
1756 {
1757 	int result;
1758 	int pipe;
1759 
1760 	/* Sanity check */
1761 	if (!serial || !ctrl_urb || !ctrl_req) {
1762 		pr_err("%s: Wrong arguments\n", __func__);
1763 		return -EINVAL;
1764 	}
1765 
1766 	/* initialize */
1767 	ctrl_req->wValue = 0;
1768 	ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1769 	ctrl_req->wLength = cpu_to_le16(size);
1770 
1771 	if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1772 		/* Reading command */
1773 		ctrl_req->bRequestType = USB_DIR_IN |
1774 					 USB_TYPE_OPTION_VENDOR |
1775 					 USB_RECIP_INTERFACE;
1776 		ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1777 		pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1778 	} else {
1779 		/* Writing command */
1780 		ctrl_req->bRequestType = USB_DIR_OUT |
1781 					 USB_TYPE_OPTION_VENDOR |
1782 					 USB_RECIP_INTERFACE;
1783 		ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1784 		pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1785 	}
1786 	/* syslog */
1787 	hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1788 		type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1789 		ctrl_req->bRequestType, ctrl_req->wLength, port);
1790 
1791 	/* Load ctrl urb */
1792 	ctrl_urb->transfer_flags = 0;
1793 	usb_fill_control_urb(ctrl_urb,
1794 			     serial->parent->usb,
1795 			     pipe,
1796 			     (u8 *) ctrl_req,
1797 			     ctrl_urb_data, size, ctrl_callback, serial);
1798 	/* Send it on merry way */
1799 	result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1800 	if (result) {
1801 		dev_err(&ctrl_urb->dev->dev,
1802 			"%s failed submit ctrl_urb %d type %d\n", __func__,
1803 			result, type);
1804 		return result;
1805 	}
1806 
1807 	/* done */
1808 	return size;
1809 }
1810 
1811 /* called by intr_callback when read occurs */
1812 static int hso_mux_serial_read(struct hso_serial *serial)
1813 {
1814 	if (!serial)
1815 		return -EINVAL;
1816 
1817 	/* clean data */
1818 	memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1819 	/* make the request */
1820 
1821 	if (serial->num_rx_urbs != 1) {
1822 		dev_err(&serial->parent->interface->dev,
1823 			"ERROR: mux'd reads with multiple buffers "
1824 			"not possible\n");
1825 		return 0;
1826 	}
1827 	return mux_device_request(serial,
1828 				  USB_CDC_GET_ENCAPSULATED_RESPONSE,
1829 				  serial->parent->port_spec & HSO_PORT_MASK,
1830 				  serial->rx_urb[0],
1831 				  &serial->ctrl_req_rx,
1832 				  serial->rx_data[0], serial->rx_data_length);
1833 }
1834 
1835 /* used for muxed serial port callback (muxed serial read) */
1836 static void intr_callback(struct urb *urb)
1837 {
1838 	struct hso_shared_int *shared_int = urb->context;
1839 	struct hso_serial *serial;
1840 	unsigned char *port_req;
1841 	int status = urb->status;
1842 	unsigned long flags;
1843 	int i;
1844 
1845 	usb_mark_last_busy(urb->dev);
1846 
1847 	/* sanity check */
1848 	if (!shared_int)
1849 		return;
1850 
1851 	/* status check */
1852 	if (status) {
1853 		handle_usb_error(status, __func__, NULL);
1854 		return;
1855 	}
1856 	hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1857 
1858 	/* what request? */
1859 	port_req = urb->transfer_buffer;
1860 	hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1861 	/* loop over all muxed ports to find the one sending this */
1862 	for (i = 0; i < 8; i++) {
1863 		/* max 8 channels on MUX */
1864 		if (*port_req & (1 << i)) {
1865 			serial = get_serial_by_shared_int_and_type(shared_int,
1866 								   (1 << i));
1867 			if (serial != NULL) {
1868 				hso_dbg(0x1, "Pending read interrupt on port %d\n",
1869 					i);
1870 				spin_lock_irqsave(&serial->serial_lock, flags);
1871 				if (serial->rx_state == RX_IDLE &&
1872 					serial->port.count > 0) {
1873 					/* Setup and send a ctrl req read on
1874 					 * port i */
1875 					if (!serial->rx_urb_filled[0]) {
1876 						serial->rx_state = RX_SENT;
1877 						hso_mux_serial_read(serial);
1878 					} else
1879 						serial->rx_state = RX_PENDING;
1880 				} else {
1881 					hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1882 						i);
1883 				}
1884 				spin_unlock_irqrestore(&serial->serial_lock,
1885 						       flags);
1886 			}
1887 		}
1888 	}
1889 	/* Resubmit interrupt urb */
1890 	hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1891 }
1892 
1893 /* called for writing to muxed serial port */
1894 static int hso_mux_serial_write_data(struct hso_serial *serial)
1895 {
1896 	if (NULL == serial)
1897 		return -EINVAL;
1898 
1899 	return mux_device_request(serial,
1900 				  USB_CDC_SEND_ENCAPSULATED_COMMAND,
1901 				  serial->parent->port_spec & HSO_PORT_MASK,
1902 				  serial->tx_urb,
1903 				  &serial->ctrl_req_tx,
1904 				  serial->tx_data, serial->tx_data_count);
1905 }
1906 
1907 /* write callback for Diag and CS port */
1908 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1909 {
1910 	struct hso_serial *serial = urb->context;
1911 	int status = urb->status;
1912 	unsigned long flags;
1913 
1914 	/* sanity check */
1915 	if (!serial) {
1916 		hso_dbg(0x1, "serial == NULL\n");
1917 		return;
1918 	}
1919 
1920 	spin_lock_irqsave(&serial->serial_lock, flags);
1921 	serial->tx_urb_used = 0;
1922 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1923 	if (status) {
1924 		handle_usb_error(status, __func__, serial->parent);
1925 		return;
1926 	}
1927 	hso_put_activity(serial->parent);
1928 	tty_port_tty_wakeup(&serial->port);
1929 	hso_kick_transmit(serial);
1930 
1931 	hso_dbg(0x1, "\n");
1932 }
1933 
1934 /* called for writing diag or CS serial port */
1935 static int hso_std_serial_write_data(struct hso_serial *serial)
1936 {
1937 	int count = serial->tx_data_count;
1938 	int result;
1939 
1940 	usb_fill_bulk_urb(serial->tx_urb,
1941 			  serial->parent->usb,
1942 			  usb_sndbulkpipe(serial->parent->usb,
1943 					  serial->out_endp->
1944 					  bEndpointAddress & 0x7F),
1945 			  serial->tx_data, serial->tx_data_count,
1946 			  hso_std_serial_write_bulk_callback, serial);
1947 
1948 	result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1949 	if (result) {
1950 		dev_warn(&serial->parent->usb->dev,
1951 			 "Failed to submit urb - res %d\n", result);
1952 		return result;
1953 	}
1954 
1955 	return count;
1956 }
1957 
1958 /* callback after read or write on muxed serial port */
1959 static void ctrl_callback(struct urb *urb)
1960 {
1961 	struct hso_serial *serial = urb->context;
1962 	struct usb_ctrlrequest *req;
1963 	int status = urb->status;
1964 	unsigned long flags;
1965 
1966 	/* sanity check */
1967 	if (!serial)
1968 		return;
1969 
1970 	spin_lock_irqsave(&serial->serial_lock, flags);
1971 	serial->tx_urb_used = 0;
1972 	spin_unlock_irqrestore(&serial->serial_lock, flags);
1973 	if (status) {
1974 		handle_usb_error(status, __func__, serial->parent);
1975 		return;
1976 	}
1977 
1978 	/* what request? */
1979 	req = (struct usb_ctrlrequest *)(urb->setup_packet);
1980 	hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1981 	hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1982 	DUMP1(urb->transfer_buffer, urb->actual_length);
1983 
1984 	if (req->bRequestType ==
1985 	    (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1986 		/* response to a read command */
1987 		serial->rx_urb_filled[0] = 1;
1988 		spin_lock_irqsave(&serial->serial_lock, flags);
1989 		put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1990 		spin_unlock_irqrestore(&serial->serial_lock, flags);
1991 	} else {
1992 		hso_put_activity(serial->parent);
1993 		tty_port_tty_wakeup(&serial->port);
1994 		/* response to a write command */
1995 		hso_kick_transmit(serial);
1996 	}
1997 }
1998 
1999 /* handle RX data for serial port */
2000 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2001 {
2002 	struct tty_struct *tty;
2003 	int count;
2004 
2005 	/* Sanity check */
2006 	if (urb == NULL || serial == NULL) {
2007 		hso_dbg(0x1, "serial = NULL\n");
2008 		return -2;
2009 	}
2010 
2011 	tty = tty_port_tty_get(&serial->port);
2012 
2013 	if (tty && tty_throttled(tty)) {
2014 		tty_kref_put(tty);
2015 		return -1;
2016 	}
2017 
2018 	/* Push data to tty */
2019 	hso_dbg(0x1, "data to push to tty\n");
2020 	count = tty_buffer_request_room(&serial->port, urb->actual_length);
2021 	if (count >= urb->actual_length) {
2022 		tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2023 				       urb->actual_length);
2024 		tty_flip_buffer_push(&serial->port);
2025 	} else {
2026 		dev_warn(&serial->parent->usb->dev,
2027 			 "dropping data, %d bytes lost\n", urb->actual_length);
2028 	}
2029 
2030 	tty_kref_put(tty);
2031 
2032 	serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2033 
2034 	return 0;
2035 }
2036 
2037 
2038 /* Base driver functions */
2039 
2040 static void hso_log_port(struct hso_device *hso_dev)
2041 {
2042 	char *port_type;
2043 	char port_dev[20];
2044 
2045 	switch (hso_dev->port_spec & HSO_PORT_MASK) {
2046 	case HSO_PORT_CONTROL:
2047 		port_type = "Control";
2048 		break;
2049 	case HSO_PORT_APP:
2050 		port_type = "Application";
2051 		break;
2052 	case HSO_PORT_GPS:
2053 		port_type = "GPS";
2054 		break;
2055 	case HSO_PORT_GPS_CONTROL:
2056 		port_type = "GPS control";
2057 		break;
2058 	case HSO_PORT_APP2:
2059 		port_type = "Application2";
2060 		break;
2061 	case HSO_PORT_PCSC:
2062 		port_type = "PCSC";
2063 		break;
2064 	case HSO_PORT_DIAG:
2065 		port_type = "Diagnostic";
2066 		break;
2067 	case HSO_PORT_DIAG2:
2068 		port_type = "Diagnostic2";
2069 		break;
2070 	case HSO_PORT_MODEM:
2071 		port_type = "Modem";
2072 		break;
2073 	case HSO_PORT_NETWORK:
2074 		port_type = "Network";
2075 		break;
2076 	default:
2077 		port_type = "Unknown";
2078 		break;
2079 	}
2080 	if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2081 		sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2082 	} else
2083 		sprintf(port_dev, "/dev/%s%d", tty_filename,
2084 			dev2ser(hso_dev)->minor);
2085 
2086 	dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2087 		port_type, port_dev);
2088 }
2089 
2090 static int hso_start_net_device(struct hso_device *hso_dev)
2091 {
2092 	int i, result = 0;
2093 	struct hso_net *hso_net = dev2net(hso_dev);
2094 
2095 	if (!hso_net)
2096 		return -ENODEV;
2097 
2098 	/* send URBs for all read buffers */
2099 	for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2100 
2101 		/* Prep a receive URB */
2102 		usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2103 				  hso_dev->usb,
2104 				  usb_rcvbulkpipe(hso_dev->usb,
2105 						  hso_net->in_endp->
2106 						  bEndpointAddress & 0x7F),
2107 				  hso_net->mux_bulk_rx_buf_pool[i],
2108 				  MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2109 				  hso_net);
2110 
2111 		/* Put it out there so the device can send us stuff */
2112 		result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2113 					GFP_NOIO);
2114 		if (result)
2115 			dev_warn(&hso_dev->usb->dev,
2116 				"%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2117 				i, result);
2118 	}
2119 
2120 	return result;
2121 }
2122 
2123 static int hso_stop_net_device(struct hso_device *hso_dev)
2124 {
2125 	int i;
2126 	struct hso_net *hso_net = dev2net(hso_dev);
2127 
2128 	if (!hso_net)
2129 		return -ENODEV;
2130 
2131 	for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2132 		if (hso_net->mux_bulk_rx_urb_pool[i])
2133 			usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2134 
2135 	}
2136 	if (hso_net->mux_bulk_tx_urb)
2137 		usb_kill_urb(hso_net->mux_bulk_tx_urb);
2138 
2139 	return 0;
2140 }
2141 
2142 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2143 {
2144 	int i, result = 0;
2145 	struct hso_serial *serial = dev2ser(hso_dev);
2146 
2147 	if (!serial)
2148 		return -ENODEV;
2149 
2150 	/* If it is not the MUX port fill in and submit a bulk urb (already
2151 	 * allocated in hso_serial_start) */
2152 	if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2153 		for (i = 0; i < serial->num_rx_urbs; i++) {
2154 			usb_fill_bulk_urb(serial->rx_urb[i],
2155 					  serial->parent->usb,
2156 					  usb_rcvbulkpipe(serial->parent->usb,
2157 							  serial->in_endp->
2158 							  bEndpointAddress &
2159 							  0x7F),
2160 					  serial->rx_data[i],
2161 					  serial->rx_data_length,
2162 					  hso_std_serial_read_bulk_callback,
2163 					  serial);
2164 			result = usb_submit_urb(serial->rx_urb[i], flags);
2165 			if (result) {
2166 				dev_warn(&serial->parent->usb->dev,
2167 					 "Failed to submit urb - res %d\n",
2168 					 result);
2169 				break;
2170 			}
2171 		}
2172 	} else {
2173 		mutex_lock(&serial->shared_int->shared_int_lock);
2174 		if (!serial->shared_int->use_count) {
2175 			result =
2176 			    hso_mux_submit_intr_urb(serial->shared_int,
2177 						    hso_dev->usb, flags);
2178 		}
2179 		serial->shared_int->use_count++;
2180 		mutex_unlock(&serial->shared_int->shared_int_lock);
2181 	}
2182 	if (serial->tiocmget)
2183 		tiocmget_submit_urb(serial,
2184 				    serial->tiocmget,
2185 				    serial->parent->usb);
2186 	return result;
2187 }
2188 
2189 static int hso_stop_serial_device(struct hso_device *hso_dev)
2190 {
2191 	int i;
2192 	struct hso_serial *serial = dev2ser(hso_dev);
2193 	struct hso_tiocmget  *tiocmget;
2194 
2195 	if (!serial)
2196 		return -ENODEV;
2197 
2198 	for (i = 0; i < serial->num_rx_urbs; i++) {
2199 		if (serial->rx_urb[i]) {
2200 			usb_kill_urb(serial->rx_urb[i]);
2201 			serial->rx_urb_filled[i] = 0;
2202 		}
2203 	}
2204 	serial->curr_rx_urb_idx = 0;
2205 
2206 	if (serial->tx_urb)
2207 		usb_kill_urb(serial->tx_urb);
2208 
2209 	if (serial->shared_int) {
2210 		mutex_lock(&serial->shared_int->shared_int_lock);
2211 		if (serial->shared_int->use_count &&
2212 		    (--serial->shared_int->use_count == 0)) {
2213 			struct urb *urb;
2214 
2215 			urb = serial->shared_int->shared_intr_urb;
2216 			if (urb)
2217 				usb_kill_urb(urb);
2218 		}
2219 		mutex_unlock(&serial->shared_int->shared_int_lock);
2220 	}
2221 	tiocmget = serial->tiocmget;
2222 	if (tiocmget) {
2223 		wake_up_interruptible(&tiocmget->waitq);
2224 		usb_kill_urb(tiocmget->urb);
2225 	}
2226 
2227 	return 0;
2228 }
2229 
2230 static void hso_serial_tty_unregister(struct hso_serial *serial)
2231 {
2232 	tty_unregister_device(tty_drv, serial->minor);
2233 }
2234 
2235 static void hso_serial_common_free(struct hso_serial *serial)
2236 {
2237 	int i;
2238 
2239 	for (i = 0; i < serial->num_rx_urbs; i++) {
2240 		/* unlink and free RX URB */
2241 		usb_free_urb(serial->rx_urb[i]);
2242 		/* free the RX buffer */
2243 		kfree(serial->rx_data[i]);
2244 	}
2245 
2246 	/* unlink and free TX URB */
2247 	usb_free_urb(serial->tx_urb);
2248 	kfree(serial->tx_buffer);
2249 	kfree(serial->tx_data);
2250 	tty_port_destroy(&serial->port);
2251 }
2252 
2253 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2254 				    int rx_size, int tx_size)
2255 {
2256 	int minor;
2257 	int i;
2258 
2259 	tty_port_init(&serial->port);
2260 
2261 	minor = get_free_serial_index();
2262 	if (minor < 0)
2263 		goto exit;
2264 
2265 	/* register our minor number */
2266 	serial->parent->dev = tty_port_register_device_attr(&serial->port,
2267 			tty_drv, minor, &serial->parent->interface->dev,
2268 			serial->parent, hso_serial_dev_groups);
2269 
2270 	/* fill in specific data for later use */
2271 	serial->minor = minor;
2272 	serial->magic = HSO_SERIAL_MAGIC;
2273 	spin_lock_init(&serial->serial_lock);
2274 	serial->num_rx_urbs = num_urbs;
2275 
2276 	/* RX, allocate urb and initialize */
2277 
2278 	/* prepare our RX buffer */
2279 	serial->rx_data_length = rx_size;
2280 	for (i = 0; i < serial->num_rx_urbs; i++) {
2281 		serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2282 		if (!serial->rx_urb[i])
2283 			goto exit;
2284 		serial->rx_urb[i]->transfer_buffer = NULL;
2285 		serial->rx_urb[i]->transfer_buffer_length = 0;
2286 		serial->rx_data[i] = kzalloc(serial->rx_data_length,
2287 					     GFP_KERNEL);
2288 		if (!serial->rx_data[i])
2289 			goto exit;
2290 	}
2291 
2292 	/* TX, allocate urb and initialize */
2293 	serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2294 	if (!serial->tx_urb)
2295 		goto exit;
2296 	serial->tx_urb->transfer_buffer = NULL;
2297 	serial->tx_urb->transfer_buffer_length = 0;
2298 	/* prepare our TX buffer */
2299 	serial->tx_data_count = 0;
2300 	serial->tx_buffer_count = 0;
2301 	serial->tx_data_length = tx_size;
2302 	serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2303 	if (!serial->tx_data)
2304 		goto exit;
2305 
2306 	serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2307 	if (!serial->tx_buffer)
2308 		goto exit;
2309 
2310 	return 0;
2311 exit:
2312 	hso_serial_tty_unregister(serial);
2313 	hso_serial_common_free(serial);
2314 	return -1;
2315 }
2316 
2317 /* Creates a general hso device */
2318 static struct hso_device *hso_create_device(struct usb_interface *intf,
2319 					    int port_spec)
2320 {
2321 	struct hso_device *hso_dev;
2322 
2323 	hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2324 	if (!hso_dev)
2325 		return NULL;
2326 
2327 	hso_dev->port_spec = port_spec;
2328 	hso_dev->usb = interface_to_usbdev(intf);
2329 	hso_dev->interface = intf;
2330 	kref_init(&hso_dev->ref);
2331 	mutex_init(&hso_dev->mutex);
2332 
2333 	INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2334 	INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2335 
2336 	return hso_dev;
2337 }
2338 
2339 /* Removes a network device in the network device table */
2340 static int remove_net_device(struct hso_device *hso_dev)
2341 {
2342 	int i;
2343 
2344 	for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2345 		if (network_table[i] == hso_dev) {
2346 			network_table[i] = NULL;
2347 			break;
2348 		}
2349 	}
2350 	if (i == HSO_MAX_NET_DEVICES)
2351 		return -1;
2352 	return 0;
2353 }
2354 
2355 /* Frees our network device */
2356 static void hso_free_net_device(struct hso_device *hso_dev)
2357 {
2358 	int i;
2359 	struct hso_net *hso_net = dev2net(hso_dev);
2360 
2361 	if (!hso_net)
2362 		return;
2363 
2364 	remove_net_device(hso_net->parent);
2365 
2366 	if (hso_net->net)
2367 		unregister_netdev(hso_net->net);
2368 
2369 	/* start freeing */
2370 	for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2371 		usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2372 		kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2373 		hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2374 	}
2375 	usb_free_urb(hso_net->mux_bulk_tx_urb);
2376 	kfree(hso_net->mux_bulk_tx_buf);
2377 	hso_net->mux_bulk_tx_buf = NULL;
2378 
2379 	if (hso_net->net)
2380 		free_netdev(hso_net->net);
2381 
2382 	kfree(hso_dev);
2383 }
2384 
2385 static const struct net_device_ops hso_netdev_ops = {
2386 	.ndo_open	= hso_net_open,
2387 	.ndo_stop	= hso_net_close,
2388 	.ndo_start_xmit = hso_net_start_xmit,
2389 	.ndo_tx_timeout = hso_net_tx_timeout,
2390 };
2391 
2392 /* initialize the network interface */
2393 static void hso_net_init(struct net_device *net)
2394 {
2395 	struct hso_net *hso_net = netdev_priv(net);
2396 
2397 	hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2398 
2399 	/* fill in the other fields */
2400 	net->netdev_ops = &hso_netdev_ops;
2401 	net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2402 	net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2403 	net->type = ARPHRD_NONE;
2404 	net->mtu = DEFAULT_MTU - 14;
2405 	net->tx_queue_len = 10;
2406 	net->ethtool_ops = &ops;
2407 
2408 	/* and initialize the semaphore */
2409 	spin_lock_init(&hso_net->net_lock);
2410 }
2411 
2412 /* Adds a network device in the network device table */
2413 static int add_net_device(struct hso_device *hso_dev)
2414 {
2415 	int i;
2416 
2417 	for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2418 		if (network_table[i] == NULL) {
2419 			network_table[i] = hso_dev;
2420 			break;
2421 		}
2422 	}
2423 	if (i == HSO_MAX_NET_DEVICES)
2424 		return -1;
2425 	return 0;
2426 }
2427 
2428 static int hso_rfkill_set_block(void *data, bool blocked)
2429 {
2430 	struct hso_device *hso_dev = data;
2431 	int enabled = !blocked;
2432 	int rv;
2433 
2434 	mutex_lock(&hso_dev->mutex);
2435 	if (hso_dev->usb_gone)
2436 		rv = 0;
2437 	else
2438 		rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2439 				       enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2440 				       USB_CTRL_SET_TIMEOUT);
2441 	mutex_unlock(&hso_dev->mutex);
2442 	return rv;
2443 }
2444 
2445 static const struct rfkill_ops hso_rfkill_ops = {
2446 	.set_block = hso_rfkill_set_block,
2447 };
2448 
2449 /* Creates and sets up everything for rfkill */
2450 static void hso_create_rfkill(struct hso_device *hso_dev,
2451 			     struct usb_interface *interface)
2452 {
2453 	struct hso_net *hso_net = dev2net(hso_dev);
2454 	struct device *dev = &hso_net->net->dev;
2455 	static u32 rfkill_counter;
2456 
2457 	snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2458 		 rfkill_counter++);
2459 
2460 	hso_net->rfkill = rfkill_alloc(hso_net->name,
2461 				       &interface_to_usbdev(interface)->dev,
2462 				       RFKILL_TYPE_WWAN,
2463 				       &hso_rfkill_ops, hso_dev);
2464 	if (!hso_net->rfkill) {
2465 		dev_err(dev, "%s - Out of memory\n", __func__);
2466 		return;
2467 	}
2468 	if (rfkill_register(hso_net->rfkill) < 0) {
2469 		rfkill_destroy(hso_net->rfkill);
2470 		hso_net->rfkill = NULL;
2471 		dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2472 		return;
2473 	}
2474 }
2475 
2476 static struct device_type hso_type = {
2477 	.name	= "wwan",
2478 };
2479 
2480 /* Creates our network device */
2481 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2482 						int port_spec)
2483 {
2484 	int result, i;
2485 	struct net_device *net;
2486 	struct hso_net *hso_net;
2487 	struct hso_device *hso_dev;
2488 
2489 	hso_dev = hso_create_device(interface, port_spec);
2490 	if (!hso_dev)
2491 		return NULL;
2492 
2493 	/* allocate our network device, then we can put in our private data */
2494 	/* call hso_net_init to do the basic initialization */
2495 	net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2496 			   hso_net_init);
2497 	if (!net) {
2498 		dev_err(&interface->dev, "Unable to create ethernet device\n");
2499 		goto exit;
2500 	}
2501 
2502 	hso_net = netdev_priv(net);
2503 
2504 	hso_dev->port_data.dev_net = hso_net;
2505 	hso_net->net = net;
2506 	hso_net->parent = hso_dev;
2507 
2508 	hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2509 				      USB_DIR_IN);
2510 	if (!hso_net->in_endp) {
2511 		dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2512 		goto exit;
2513 	}
2514 	hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2515 				       USB_DIR_OUT);
2516 	if (!hso_net->out_endp) {
2517 		dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2518 		goto exit;
2519 	}
2520 	SET_NETDEV_DEV(net, &interface->dev);
2521 	SET_NETDEV_DEVTYPE(net, &hso_type);
2522 
2523 	/* start allocating */
2524 	for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2525 		hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2526 		if (!hso_net->mux_bulk_rx_urb_pool[i])
2527 			goto exit;
2528 		hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2529 							   GFP_KERNEL);
2530 		if (!hso_net->mux_bulk_rx_buf_pool[i])
2531 			goto exit;
2532 	}
2533 	hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2534 	if (!hso_net->mux_bulk_tx_urb)
2535 		goto exit;
2536 	hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2537 	if (!hso_net->mux_bulk_tx_buf)
2538 		goto exit;
2539 
2540 	add_net_device(hso_dev);
2541 
2542 	/* registering our net device */
2543 	result = register_netdev(net);
2544 	if (result) {
2545 		dev_err(&interface->dev, "Failed to register device\n");
2546 		goto exit;
2547 	}
2548 
2549 	hso_log_port(hso_dev);
2550 
2551 	hso_create_rfkill(hso_dev, interface);
2552 
2553 	return hso_dev;
2554 exit:
2555 	hso_free_net_device(hso_dev);
2556 	return NULL;
2557 }
2558 
2559 static void hso_free_tiomget(struct hso_serial *serial)
2560 {
2561 	struct hso_tiocmget *tiocmget;
2562 	if (!serial)
2563 		return;
2564 	tiocmget = serial->tiocmget;
2565 	if (tiocmget) {
2566 		usb_free_urb(tiocmget->urb);
2567 		tiocmget->urb = NULL;
2568 		serial->tiocmget = NULL;
2569 		kfree(tiocmget->serial_state_notification);
2570 		tiocmget->serial_state_notification = NULL;
2571 		kfree(tiocmget);
2572 	}
2573 }
2574 
2575 /* Frees an AT channel ( goes for both mux and non-mux ) */
2576 static void hso_free_serial_device(struct hso_device *hso_dev)
2577 {
2578 	struct hso_serial *serial = dev2ser(hso_dev);
2579 
2580 	if (!serial)
2581 		return;
2582 
2583 	hso_serial_common_free(serial);
2584 
2585 	if (serial->shared_int) {
2586 		mutex_lock(&serial->shared_int->shared_int_lock);
2587 		if (--serial->shared_int->ref_count == 0)
2588 			hso_free_shared_int(serial->shared_int);
2589 		else
2590 			mutex_unlock(&serial->shared_int->shared_int_lock);
2591 	}
2592 	hso_free_tiomget(serial);
2593 	kfree(serial);
2594 	kfree(hso_dev);
2595 }
2596 
2597 /* Creates a bulk AT channel */
2598 static struct hso_device *hso_create_bulk_serial_device(
2599 			struct usb_interface *interface, int port)
2600 {
2601 	struct hso_device *hso_dev;
2602 	struct hso_serial *serial;
2603 	int num_urbs;
2604 	struct hso_tiocmget *tiocmget;
2605 
2606 	hso_dev = hso_create_device(interface, port);
2607 	if (!hso_dev)
2608 		return NULL;
2609 
2610 	serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2611 	if (!serial)
2612 		goto exit;
2613 
2614 	serial->parent = hso_dev;
2615 	hso_dev->port_data.dev_serial = serial;
2616 
2617 	if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2618 		num_urbs = 2;
2619 		serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2620 					   GFP_KERNEL);
2621 		serial->tiocmget->serial_state_notification
2622 			= kzalloc(sizeof(struct hso_serial_state_notification),
2623 					   GFP_KERNEL);
2624 		/* it isn't going to break our heart if serial->tiocmget
2625 		 *  allocation fails don't bother checking this.
2626 		 */
2627 		if (serial->tiocmget && serial->tiocmget->serial_state_notification) {
2628 			tiocmget = serial->tiocmget;
2629 			tiocmget->endp = hso_get_ep(interface,
2630 						    USB_ENDPOINT_XFER_INT,
2631 						    USB_DIR_IN);
2632 			if (!tiocmget->endp) {
2633 				dev_err(&interface->dev, "Failed to find INT IN ep\n");
2634 				goto exit;
2635 			}
2636 
2637 			tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2638 			if (tiocmget->urb) {
2639 				mutex_init(&tiocmget->mutex);
2640 				init_waitqueue_head(&tiocmget->waitq);
2641 			} else
2642 				hso_free_tiomget(serial);
2643 		}
2644 	}
2645 	else
2646 		num_urbs = 1;
2647 
2648 	if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2649 				     BULK_URB_TX_SIZE))
2650 		goto exit;
2651 
2652 	serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2653 				     USB_DIR_IN);
2654 	if (!serial->in_endp) {
2655 		dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2656 		goto exit2;
2657 	}
2658 
2659 	if (!
2660 	    (serial->out_endp =
2661 	     hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2662 		dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2663 		goto exit2;
2664 	}
2665 
2666 	serial->write_data = hso_std_serial_write_data;
2667 
2668 	/* and record this serial */
2669 	set_serial_by_index(serial->minor, serial);
2670 
2671 	/* setup the proc dirs and files if needed */
2672 	hso_log_port(hso_dev);
2673 
2674 	/* done, return it */
2675 	return hso_dev;
2676 
2677 exit2:
2678 	hso_serial_tty_unregister(serial);
2679 	hso_serial_common_free(serial);
2680 exit:
2681 	hso_free_tiomget(serial);
2682 	kfree(serial);
2683 	kfree(hso_dev);
2684 	return NULL;
2685 }
2686 
2687 /* Creates a multiplexed AT channel */
2688 static
2689 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2690 						int port,
2691 						struct hso_shared_int *mux)
2692 {
2693 	struct hso_device *hso_dev;
2694 	struct hso_serial *serial;
2695 	int port_spec;
2696 
2697 	port_spec = HSO_INTF_MUX;
2698 	port_spec &= ~HSO_PORT_MASK;
2699 
2700 	port_spec |= hso_mux_to_port(port);
2701 	if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2702 		return NULL;
2703 
2704 	hso_dev = hso_create_device(interface, port_spec);
2705 	if (!hso_dev)
2706 		return NULL;
2707 
2708 	serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2709 	if (!serial)
2710 		goto exit;
2711 
2712 	hso_dev->port_data.dev_serial = serial;
2713 	serial->parent = hso_dev;
2714 
2715 	if (hso_serial_common_create
2716 	    (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2717 		goto exit;
2718 
2719 	serial->tx_data_length--;
2720 	serial->write_data = hso_mux_serial_write_data;
2721 
2722 	serial->shared_int = mux;
2723 	mutex_lock(&serial->shared_int->shared_int_lock);
2724 	serial->shared_int->ref_count++;
2725 	mutex_unlock(&serial->shared_int->shared_int_lock);
2726 
2727 	/* and record this serial */
2728 	set_serial_by_index(serial->minor, serial);
2729 
2730 	/* setup the proc dirs and files if needed */
2731 	hso_log_port(hso_dev);
2732 
2733 	/* done, return it */
2734 	return hso_dev;
2735 
2736 exit:
2737 	if (serial) {
2738 		tty_unregister_device(tty_drv, serial->minor);
2739 		kfree(serial);
2740 	}
2741 	kfree(hso_dev);
2742 	return NULL;
2743 
2744 }
2745 
2746 static void hso_free_shared_int(struct hso_shared_int *mux)
2747 {
2748 	usb_free_urb(mux->shared_intr_urb);
2749 	kfree(mux->shared_intr_buf);
2750 	mutex_unlock(&mux->shared_int_lock);
2751 	kfree(mux);
2752 }
2753 
2754 static
2755 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2756 {
2757 	struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2758 
2759 	if (!mux)
2760 		return NULL;
2761 
2762 	mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2763 				    USB_DIR_IN);
2764 	if (!mux->intr_endp) {
2765 		dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2766 		goto exit;
2767 	}
2768 
2769 	mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2770 	if (!mux->shared_intr_urb)
2771 		goto exit;
2772 	mux->shared_intr_buf =
2773 		kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2774 			GFP_KERNEL);
2775 	if (!mux->shared_intr_buf)
2776 		goto exit;
2777 
2778 	mutex_init(&mux->shared_int_lock);
2779 
2780 	return mux;
2781 
2782 exit:
2783 	kfree(mux->shared_intr_buf);
2784 	usb_free_urb(mux->shared_intr_urb);
2785 	kfree(mux);
2786 	return NULL;
2787 }
2788 
2789 /* Gets the port spec for a certain interface */
2790 static int hso_get_config_data(struct usb_interface *interface)
2791 {
2792 	struct usb_device *usbdev = interface_to_usbdev(interface);
2793 	u8 *config_data = kmalloc(17, GFP_KERNEL);
2794 	u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2795 	s32 result;
2796 
2797 	if (!config_data)
2798 		return -ENOMEM;
2799 	if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2800 			    0x86, 0xC0, 0, 0, config_data, 17,
2801 			    USB_CTRL_SET_TIMEOUT) != 0x11) {
2802 		kfree(config_data);
2803 		return -EIO;
2804 	}
2805 
2806 	/* check if we have a valid interface */
2807 	if (if_num > 16) {
2808 		kfree(config_data);
2809 		return -EINVAL;
2810 	}
2811 
2812 	switch (config_data[if_num]) {
2813 	case 0x0:
2814 		result = 0;
2815 		break;
2816 	case 0x1:
2817 		result = HSO_PORT_DIAG;
2818 		break;
2819 	case 0x2:
2820 		result = HSO_PORT_GPS;
2821 		break;
2822 	case 0x3:
2823 		result = HSO_PORT_GPS_CONTROL;
2824 		break;
2825 	case 0x4:
2826 		result = HSO_PORT_APP;
2827 		break;
2828 	case 0x5:
2829 		result = HSO_PORT_APP2;
2830 		break;
2831 	case 0x6:
2832 		result = HSO_PORT_CONTROL;
2833 		break;
2834 	case 0x7:
2835 		result = HSO_PORT_NETWORK;
2836 		break;
2837 	case 0x8:
2838 		result = HSO_PORT_MODEM;
2839 		break;
2840 	case 0x9:
2841 		result = HSO_PORT_MSD;
2842 		break;
2843 	case 0xa:
2844 		result = HSO_PORT_PCSC;
2845 		break;
2846 	case 0xb:
2847 		result = HSO_PORT_VOICE;
2848 		break;
2849 	default:
2850 		result = 0;
2851 	}
2852 
2853 	if (result)
2854 		result |= HSO_INTF_BULK;
2855 
2856 	if (config_data[16] & 0x1)
2857 		result |= HSO_INFO_CRC_BUG;
2858 
2859 	kfree(config_data);
2860 	return result;
2861 }
2862 
2863 /* called once for each interface upon device insertion */
2864 static int hso_probe(struct usb_interface *interface,
2865 		     const struct usb_device_id *id)
2866 {
2867 	int mux, i, if_num, port_spec;
2868 	unsigned char port_mask;
2869 	struct hso_device *hso_dev = NULL;
2870 	struct hso_shared_int *shared_int;
2871 	struct hso_device *tmp_dev = NULL;
2872 
2873 	if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2874 		dev_err(&interface->dev, "Not our interface\n");
2875 		return -ENODEV;
2876 	}
2877 
2878 	if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2879 
2880 	/* Get the interface/port specification from either driver_info or from
2881 	 * the device itself */
2882 	if (id->driver_info) {
2883 		/* if_num is controlled by the device, driver_info is a 0 terminated
2884 		 * array. Make sure, the access is in bounds! */
2885 		for (i = 0; i <= if_num; ++i)
2886 			if (((u32 *)(id->driver_info))[i] == 0)
2887 				goto exit;
2888 		port_spec = ((u32 *)(id->driver_info))[if_num];
2889 	} else {
2890 		port_spec = hso_get_config_data(interface);
2891 		if (port_spec < 0)
2892 			goto exit;
2893 	}
2894 
2895 	/* Check if we need to switch to alt interfaces prior to port
2896 	 * configuration */
2897 	if (interface->num_altsetting > 1)
2898 		usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2899 	interface->needs_remote_wakeup = 1;
2900 
2901 	/* Allocate new hso device(s) */
2902 	switch (port_spec & HSO_INTF_MASK) {
2903 	case HSO_INTF_MUX:
2904 		if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2905 			/* Create the network device */
2906 			if (!disable_net) {
2907 				hso_dev = hso_create_net_device(interface,
2908 								port_spec);
2909 				if (!hso_dev)
2910 					goto exit;
2911 				tmp_dev = hso_dev;
2912 			}
2913 		}
2914 
2915 		if (hso_get_mux_ports(interface, &port_mask))
2916 			/* TODO: de-allocate everything */
2917 			goto exit;
2918 
2919 		shared_int = hso_create_shared_int(interface);
2920 		if (!shared_int)
2921 			goto exit;
2922 
2923 		for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2924 			if (port_mask & i) {
2925 				hso_dev = hso_create_mux_serial_device(
2926 						interface, i, shared_int);
2927 				if (!hso_dev)
2928 					goto exit;
2929 			}
2930 		}
2931 
2932 		if (tmp_dev)
2933 			hso_dev = tmp_dev;
2934 		break;
2935 
2936 	case HSO_INTF_BULK:
2937 		/* It's a regular bulk interface */
2938 		if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2939 			if (!disable_net)
2940 				hso_dev =
2941 				    hso_create_net_device(interface, port_spec);
2942 		} else {
2943 			hso_dev =
2944 			    hso_create_bulk_serial_device(interface, port_spec);
2945 		}
2946 		if (!hso_dev)
2947 			goto exit;
2948 		break;
2949 	default:
2950 		goto exit;
2951 	}
2952 
2953 	/* save our data pointer in this device */
2954 	usb_set_intfdata(interface, hso_dev);
2955 
2956 	/* done */
2957 	return 0;
2958 exit:
2959 	hso_free_interface(interface);
2960 	return -ENODEV;
2961 }
2962 
2963 /* device removed, cleaning up */
2964 static void hso_disconnect(struct usb_interface *interface)
2965 {
2966 	hso_free_interface(interface);
2967 
2968 	/* remove reference of our private data */
2969 	usb_set_intfdata(interface, NULL);
2970 }
2971 
2972 static void async_get_intf(struct work_struct *data)
2973 {
2974 	struct hso_device *hso_dev =
2975 	    container_of(data, struct hso_device, async_get_intf);
2976 	usb_autopm_get_interface(hso_dev->interface);
2977 }
2978 
2979 static void async_put_intf(struct work_struct *data)
2980 {
2981 	struct hso_device *hso_dev =
2982 	    container_of(data, struct hso_device, async_put_intf);
2983 	usb_autopm_put_interface(hso_dev->interface);
2984 }
2985 
2986 static int hso_get_activity(struct hso_device *hso_dev)
2987 {
2988 	if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2989 		if (!hso_dev->is_active) {
2990 			hso_dev->is_active = 1;
2991 			schedule_work(&hso_dev->async_get_intf);
2992 		}
2993 	}
2994 
2995 	if (hso_dev->usb->state != USB_STATE_CONFIGURED)
2996 		return -EAGAIN;
2997 
2998 	usb_mark_last_busy(hso_dev->usb);
2999 
3000 	return 0;
3001 }
3002 
3003 static int hso_put_activity(struct hso_device *hso_dev)
3004 {
3005 	if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3006 		if (hso_dev->is_active) {
3007 			hso_dev->is_active = 0;
3008 			schedule_work(&hso_dev->async_put_intf);
3009 			return -EAGAIN;
3010 		}
3011 	}
3012 	hso_dev->is_active = 0;
3013 	return 0;
3014 }
3015 
3016 /* called by kernel when we need to suspend device */
3017 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3018 {
3019 	int i, result;
3020 
3021 	/* Stop all serial ports */
3022 	for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3023 		if (serial_table[i] && (serial_table[i]->interface == iface)) {
3024 			result = hso_stop_serial_device(serial_table[i]);
3025 			if (result)
3026 				goto out;
3027 		}
3028 	}
3029 
3030 	/* Stop all network ports */
3031 	for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3032 		if (network_table[i] &&
3033 		    (network_table[i]->interface == iface)) {
3034 			result = hso_stop_net_device(network_table[i]);
3035 			if (result)
3036 				goto out;
3037 		}
3038 	}
3039 
3040 out:
3041 	return 0;
3042 }
3043 
3044 /* called by kernel when we need to resume device */
3045 static int hso_resume(struct usb_interface *iface)
3046 {
3047 	int i, result = 0;
3048 	struct hso_net *hso_net;
3049 
3050 	/* Start all serial ports */
3051 	for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3052 		if (serial_table[i] && (serial_table[i]->interface == iface)) {
3053 			if (dev2ser(serial_table[i])->port.count) {
3054 				result =
3055 				    hso_start_serial_device(serial_table[i], GFP_NOIO);
3056 				hso_kick_transmit(dev2ser(serial_table[i]));
3057 				if (result)
3058 					goto out;
3059 			}
3060 		}
3061 	}
3062 
3063 	/* Start all network ports */
3064 	for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3065 		if (network_table[i] &&
3066 		    (network_table[i]->interface == iface)) {
3067 			hso_net = dev2net(network_table[i]);
3068 			if (hso_net->flags & IFF_UP) {
3069 				/* First transmit any lingering data,
3070 				   then restart the device. */
3071 				if (hso_net->skb_tx_buf) {
3072 					dev_dbg(&iface->dev,
3073 						"Transmitting"
3074 						" lingering data\n");
3075 					hso_net_start_xmit(hso_net->skb_tx_buf,
3076 							   hso_net->net);
3077 					hso_net->skb_tx_buf = NULL;
3078 				}
3079 				result = hso_start_net_device(network_table[i]);
3080 				if (result)
3081 					goto out;
3082 			}
3083 		}
3084 	}
3085 
3086 out:
3087 	return result;
3088 }
3089 
3090 static void hso_serial_ref_free(struct kref *ref)
3091 {
3092 	struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3093 
3094 	hso_free_serial_device(hso_dev);
3095 }
3096 
3097 static void hso_free_interface(struct usb_interface *interface)
3098 {
3099 	struct hso_serial *serial;
3100 	int i;
3101 
3102 	for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3103 		if (serial_table[i] &&
3104 		    (serial_table[i]->interface == interface)) {
3105 			serial = dev2ser(serial_table[i]);
3106 			tty_port_tty_hangup(&serial->port, false);
3107 			mutex_lock(&serial->parent->mutex);
3108 			serial->parent->usb_gone = 1;
3109 			mutex_unlock(&serial->parent->mutex);
3110 			cancel_work_sync(&serial_table[i]->async_put_intf);
3111 			cancel_work_sync(&serial_table[i]->async_get_intf);
3112 			hso_serial_tty_unregister(serial);
3113 			kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3114 			set_serial_by_index(i, NULL);
3115 		}
3116 	}
3117 
3118 	for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3119 		if (network_table[i] &&
3120 		    (network_table[i]->interface == interface)) {
3121 			struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3122 			/* hso_stop_net_device doesn't stop the net queue since
3123 			 * traffic needs to start it again when suspended */
3124 			netif_stop_queue(dev2net(network_table[i])->net);
3125 			hso_stop_net_device(network_table[i]);
3126 			cancel_work_sync(&network_table[i]->async_put_intf);
3127 			cancel_work_sync(&network_table[i]->async_get_intf);
3128 			if (rfk) {
3129 				rfkill_unregister(rfk);
3130 				rfkill_destroy(rfk);
3131 			}
3132 			hso_free_net_device(network_table[i]);
3133 		}
3134 	}
3135 }
3136 
3137 /* Helper functions */
3138 
3139 /* Get the endpoint ! */
3140 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3141 						  int type, int dir)
3142 {
3143 	int i;
3144 	struct usb_host_interface *iface = intf->cur_altsetting;
3145 	struct usb_endpoint_descriptor *endp;
3146 
3147 	for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3148 		endp = &iface->endpoint[i].desc;
3149 		if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3150 		    (usb_endpoint_type(endp) == type))
3151 			return endp;
3152 	}
3153 
3154 	return NULL;
3155 }
3156 
3157 /* Get the byte that describes which ports are enabled */
3158 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3159 {
3160 	int i;
3161 	struct usb_host_interface *iface = intf->cur_altsetting;
3162 
3163 	if (iface->extralen == 3) {
3164 		*ports = iface->extra[2];
3165 		return 0;
3166 	}
3167 
3168 	for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3169 		if (iface->endpoint[i].extralen == 3) {
3170 			*ports = iface->endpoint[i].extra[2];
3171 			return 0;
3172 		}
3173 	}
3174 
3175 	return -1;
3176 }
3177 
3178 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3179 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3180 				   struct usb_device *usb, gfp_t gfp)
3181 {
3182 	int result;
3183 
3184 	usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3185 			 usb_rcvintpipe(usb,
3186 				shared_int->intr_endp->bEndpointAddress & 0x7F),
3187 			 shared_int->shared_intr_buf,
3188 			 1,
3189 			 intr_callback, shared_int,
3190 			 shared_int->intr_endp->bInterval);
3191 
3192 	result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3193 	if (result)
3194 		dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3195 			result);
3196 
3197 	return result;
3198 }
3199 
3200 /* operations setup of the serial interface */
3201 static const struct tty_operations hso_serial_ops = {
3202 	.open = hso_serial_open,
3203 	.close = hso_serial_close,
3204 	.write = hso_serial_write,
3205 	.write_room = hso_serial_write_room,
3206 	.cleanup = hso_serial_cleanup,
3207 	.ioctl = hso_serial_ioctl,
3208 	.set_termios = hso_serial_set_termios,
3209 	.chars_in_buffer = hso_serial_chars_in_buffer,
3210 	.tiocmget = hso_serial_tiocmget,
3211 	.tiocmset = hso_serial_tiocmset,
3212 	.get_icount = hso_get_count,
3213 	.unthrottle = hso_unthrottle
3214 };
3215 
3216 static struct usb_driver hso_driver = {
3217 	.name = driver_name,
3218 	.probe = hso_probe,
3219 	.disconnect = hso_disconnect,
3220 	.id_table = hso_ids,
3221 	.suspend = hso_suspend,
3222 	.resume = hso_resume,
3223 	.reset_resume = hso_resume,
3224 	.supports_autosuspend = 1,
3225 	.disable_hub_initiated_lpm = 1,
3226 };
3227 
3228 static int __init hso_init(void)
3229 {
3230 	int i;
3231 	int result;
3232 
3233 	/* put it in the log */
3234 	pr_info("%s\n", version);
3235 
3236 	/* Initialise the serial table semaphore and table */
3237 	spin_lock_init(&serial_table_lock);
3238 	for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3239 		serial_table[i] = NULL;
3240 
3241 	/* allocate our driver using the proper amount of supported minors */
3242 	tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3243 	if (!tty_drv)
3244 		return -ENOMEM;
3245 
3246 	/* fill in all needed values */
3247 	tty_drv->driver_name = driver_name;
3248 	tty_drv->name = tty_filename;
3249 
3250 	/* if major number is provided as parameter, use that one */
3251 	if (tty_major)
3252 		tty_drv->major = tty_major;
3253 
3254 	tty_drv->minor_start = 0;
3255 	tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3256 	tty_drv->subtype = SERIAL_TYPE_NORMAL;
3257 	tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3258 	tty_drv->init_termios = tty_std_termios;
3259 	hso_init_termios(&tty_drv->init_termios);
3260 	tty_set_operations(tty_drv, &hso_serial_ops);
3261 
3262 	/* register the tty driver */
3263 	result = tty_register_driver(tty_drv);
3264 	if (result) {
3265 		pr_err("%s - tty_register_driver failed(%d)\n",
3266 		       __func__, result);
3267 		goto err_free_tty;
3268 	}
3269 
3270 	/* register this module as an usb driver */
3271 	result = usb_register(&hso_driver);
3272 	if (result) {
3273 		pr_err("Could not register hso driver - error: %d\n", result);
3274 		goto err_unreg_tty;
3275 	}
3276 
3277 	/* done */
3278 	return 0;
3279 err_unreg_tty:
3280 	tty_unregister_driver(tty_drv);
3281 err_free_tty:
3282 	put_tty_driver(tty_drv);
3283 	return result;
3284 }
3285 
3286 static void __exit hso_exit(void)
3287 {
3288 	pr_info("unloaded\n");
3289 
3290 	tty_unregister_driver(tty_drv);
3291 	/* deregister the usb driver */
3292 	usb_deregister(&hso_driver);
3293 	put_tty_driver(tty_drv);
3294 }
3295 
3296 /* Module definitions */
3297 module_init(hso_init);
3298 module_exit(hso_exit);
3299 
3300 MODULE_AUTHOR(MOD_AUTHOR);
3301 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3302 MODULE_LICENSE("GPL");
3303 
3304 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3305 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3306 module_param(debug, int, 0644);
3307 
3308 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3309 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3310 module_param(tty_major, int, 0644);
3311 
3312 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3313 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3314 module_param(disable_net, int, 0644);
3315