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