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