]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/net/usb/hso.c
projects / mirror_ubuntu-bionic-kernel.git / blob
? search:


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