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