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