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