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