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