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