Merge tag 'dm-4.0-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/device...
[sfrench/cifs-2.6.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         int if_num;
1481
1482         /* Sanity checks */
1483         if (!serial)
1484                 return;
1485         if (status) {
1486                 handle_usb_error(status, __func__, serial->parent);
1487                 return;
1488         }
1489
1490         /* tiocmget is only supported on HSO_PORT_MODEM */
1491         tiocmget = serial->tiocmget;
1492         if (!tiocmget)
1493                 return;
1494         BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1495
1496         usb = serial->parent->usb;
1497         if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1498
1499         /* wIndex should be the USB interface number of the port to which the
1500          * notification applies, which should always be the Modem port.
1501          */
1502         serial_state_notification = &tiocmget->serial_state_notification;
1503         if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1504             serial_state_notification->bNotification != B_NOTIFICATION ||
1505             le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1506             le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1507             le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1508                 dev_warn(&usb->dev,
1509                          "hso received invalid serial state notification\n");
1510                 DUMP(serial_state_notification,
1511                      sizeof(struct hso_serial_state_notification));
1512         } else {
1513
1514                 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1515                                                 UART_state_bitmap);
1516                 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1517                 icount = &tiocmget->icount;
1518                 spin_lock(&serial->serial_lock);
1519                 if ((UART_state_bitmap & B_OVERRUN) !=
1520                    (prev_UART_state_bitmap & B_OVERRUN))
1521                         icount->parity++;
1522                 if ((UART_state_bitmap & B_PARITY) !=
1523                    (prev_UART_state_bitmap & B_PARITY))
1524                         icount->parity++;
1525                 if ((UART_state_bitmap & B_FRAMING) !=
1526                    (prev_UART_state_bitmap & B_FRAMING))
1527                         icount->frame++;
1528                 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1529                    !(prev_UART_state_bitmap & B_RING_SIGNAL))
1530                         icount->rng++;
1531                 if ((UART_state_bitmap & B_BREAK) !=
1532                    (prev_UART_state_bitmap & B_BREAK))
1533                         icount->brk++;
1534                 if ((UART_state_bitmap & B_TX_CARRIER) !=
1535                    (prev_UART_state_bitmap & B_TX_CARRIER))
1536                         icount->dsr++;
1537                 if ((UART_state_bitmap & B_RX_CARRIER) !=
1538                    (prev_UART_state_bitmap & B_RX_CARRIER))
1539                         icount->dcd++;
1540                 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1541                 spin_unlock(&serial->serial_lock);
1542                 tiocmget->intr_completed = 1;
1543                 wake_up_interruptible(&tiocmget->waitq);
1544         }
1545         memset(serial_state_notification, 0,
1546                sizeof(struct hso_serial_state_notification));
1547         tiocmget_submit_urb(serial,
1548                             tiocmget,
1549                             serial->parent->usb);
1550 }
1551
1552 /*
1553  * next few functions largely stolen from drivers/serial/serial_core.c
1554  */
1555 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1556  * - mask passed in arg for lines of interest
1557  *   (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1558  * Caller should use TIOCGICOUNT to see which one it was
1559  */
1560 static int
1561 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1562 {
1563         DECLARE_WAITQUEUE(wait, current);
1564         struct uart_icount cprev, cnow;
1565         struct hso_tiocmget  *tiocmget;
1566         int ret;
1567
1568         tiocmget = serial->tiocmget;
1569         if (!tiocmget)
1570                 return -ENOENT;
1571         /*
1572          * note the counters on entry
1573          */
1574         spin_lock_irq(&serial->serial_lock);
1575         memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1576         spin_unlock_irq(&serial->serial_lock);
1577         add_wait_queue(&tiocmget->waitq, &wait);
1578         for (;;) {
1579                 spin_lock_irq(&serial->serial_lock);
1580                 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1581                 spin_unlock_irq(&serial->serial_lock);
1582                 set_current_state(TASK_INTERRUPTIBLE);
1583                 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1584                     ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1585                     ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd))) {
1586                         ret = 0;
1587                         break;
1588                 }
1589                 schedule();
1590                 /* see if a signal did it */
1591                 if (signal_pending(current)) {
1592                         ret = -ERESTARTSYS;
1593                         break;
1594                 }
1595                 cprev = cnow;
1596         }
1597         __set_current_state(TASK_RUNNING);
1598         remove_wait_queue(&tiocmget->waitq, &wait);
1599
1600         return ret;
1601 }
1602
1603 /*
1604  * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1605  * Return: write counters to the user passed counter struct
1606  * NB: both 1->0 and 0->1 transitions are counted except for
1607  *     RI where only 0->1 is counted.
1608  */
1609 static int hso_get_count(struct tty_struct *tty,
1610                   struct serial_icounter_struct *icount)
1611 {
1612         struct uart_icount cnow;
1613         struct hso_serial *serial = tty->driver_data;
1614         struct hso_tiocmget  *tiocmget = serial->tiocmget;
1615
1616         memset(icount, 0, sizeof(struct serial_icounter_struct));
1617
1618         if (!tiocmget)
1619                  return -ENOENT;
1620         spin_lock_irq(&serial->serial_lock);
1621         memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1622         spin_unlock_irq(&serial->serial_lock);
1623
1624         icount->cts         = cnow.cts;
1625         icount->dsr         = cnow.dsr;
1626         icount->rng         = cnow.rng;
1627         icount->dcd         = cnow.dcd;
1628         icount->rx          = cnow.rx;
1629         icount->tx          = cnow.tx;
1630         icount->frame       = cnow.frame;
1631         icount->overrun     = cnow.overrun;
1632         icount->parity      = cnow.parity;
1633         icount->brk         = cnow.brk;
1634         icount->buf_overrun = cnow.buf_overrun;
1635
1636         return 0;
1637 }
1638
1639
1640 static int hso_serial_tiocmget(struct tty_struct *tty)
1641 {
1642         int retval;
1643         struct hso_serial *serial = tty->driver_data;
1644         struct hso_tiocmget  *tiocmget;
1645         u16 UART_state_bitmap;
1646
1647         /* sanity check */
1648         if (!serial) {
1649                 D1("no tty structures");
1650                 return -EINVAL;
1651         }
1652         spin_lock_irq(&serial->serial_lock);
1653         retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1654             ((serial->dtr_state) ? TIOCM_DTR : 0);
1655         tiocmget = serial->tiocmget;
1656         if (tiocmget) {
1657
1658                 UART_state_bitmap = le16_to_cpu(
1659                         tiocmget->prev_UART_state_bitmap);
1660                 if (UART_state_bitmap & B_RING_SIGNAL)
1661                         retval |=  TIOCM_RNG;
1662                 if (UART_state_bitmap & B_RX_CARRIER)
1663                         retval |=  TIOCM_CD;
1664                 if (UART_state_bitmap & B_TX_CARRIER)
1665                         retval |=  TIOCM_DSR;
1666         }
1667         spin_unlock_irq(&serial->serial_lock);
1668         return retval;
1669 }
1670
1671 static int hso_serial_tiocmset(struct tty_struct *tty,
1672                                unsigned int set, unsigned int clear)
1673 {
1674         int val = 0;
1675         unsigned long flags;
1676         int if_num;
1677         struct hso_serial *serial = tty->driver_data;
1678
1679         /* sanity check */
1680         if (!serial) {
1681                 D1("no tty structures");
1682                 return -EINVAL;
1683         }
1684
1685         if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1686                 return -EINVAL;
1687
1688         if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1689
1690         spin_lock_irqsave(&serial->serial_lock, flags);
1691         if (set & TIOCM_RTS)
1692                 serial->rts_state = 1;
1693         if (set & TIOCM_DTR)
1694                 serial->dtr_state = 1;
1695
1696         if (clear & TIOCM_RTS)
1697                 serial->rts_state = 0;
1698         if (clear & TIOCM_DTR)
1699                 serial->dtr_state = 0;
1700
1701         if (serial->dtr_state)
1702                 val |= 0x01;
1703         if (serial->rts_state)
1704                 val |= 0x02;
1705
1706         spin_unlock_irqrestore(&serial->serial_lock, flags);
1707
1708         return usb_control_msg(serial->parent->usb,
1709                                usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1710                                0x21, val, if_num, NULL, 0,
1711                                USB_CTRL_SET_TIMEOUT);
1712 }
1713
1714 static int hso_serial_ioctl(struct tty_struct *tty,
1715                             unsigned int cmd, unsigned long arg)
1716 {
1717         struct hso_serial *serial = tty->driver_data;
1718         int ret = 0;
1719         D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1720
1721         if (!serial)
1722                 return -ENODEV;
1723         switch (cmd) {
1724         case TIOCMIWAIT:
1725                 ret = hso_wait_modem_status(serial, arg);
1726                 break;
1727         default:
1728                 ret = -ENOIOCTLCMD;
1729                 break;
1730         }
1731         return ret;
1732 }
1733
1734
1735 /* starts a transmit */
1736 static void hso_kick_transmit(struct hso_serial *serial)
1737 {
1738         u8 *temp;
1739         unsigned long flags;
1740         int res;
1741
1742         spin_lock_irqsave(&serial->serial_lock, flags);
1743         if (!serial->tx_buffer_count)
1744                 goto out;
1745
1746         if (serial->tx_urb_used)
1747                 goto out;
1748
1749         /* Wakeup USB interface if necessary */
1750         if (hso_get_activity(serial->parent) == -EAGAIN)
1751                 goto out;
1752
1753         /* Switch pointers around to avoid memcpy */
1754         temp = serial->tx_buffer;
1755         serial->tx_buffer = serial->tx_data;
1756         serial->tx_data = temp;
1757         serial->tx_data_count = serial->tx_buffer_count;
1758         serial->tx_buffer_count = 0;
1759
1760         /* If temp is set, it means we switched buffers */
1761         if (temp && serial->write_data) {
1762                 res = serial->write_data(serial);
1763                 if (res >= 0)
1764                         serial->tx_urb_used = 1;
1765         }
1766 out:
1767         spin_unlock_irqrestore(&serial->serial_lock, flags);
1768 }
1769
1770 /* make a request (for reading and writing data to muxed serial port) */
1771 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1772                               struct urb *ctrl_urb,
1773                               struct usb_ctrlrequest *ctrl_req,
1774                               u8 *ctrl_urb_data, u32 size)
1775 {
1776         int result;
1777         int pipe;
1778
1779         /* Sanity check */
1780         if (!serial || !ctrl_urb || !ctrl_req) {
1781                 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1782                 return -EINVAL;
1783         }
1784
1785         /* initialize */
1786         ctrl_req->wValue = 0;
1787         ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1788         ctrl_req->wLength = cpu_to_le16(size);
1789
1790         if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1791                 /* Reading command */
1792                 ctrl_req->bRequestType = USB_DIR_IN |
1793                                          USB_TYPE_OPTION_VENDOR |
1794                                          USB_RECIP_INTERFACE;
1795                 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1796                 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1797         } else {
1798                 /* Writing command */
1799                 ctrl_req->bRequestType = USB_DIR_OUT |
1800                                          USB_TYPE_OPTION_VENDOR |
1801                                          USB_RECIP_INTERFACE;
1802                 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1803                 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1804         }
1805         /* syslog */
1806         D2("%s command (%02x) len: %d, port: %d",
1807            type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1808            ctrl_req->bRequestType, ctrl_req->wLength, port);
1809
1810         /* Load ctrl urb */
1811         ctrl_urb->transfer_flags = 0;
1812         usb_fill_control_urb(ctrl_urb,
1813                              serial->parent->usb,
1814                              pipe,
1815                              (u8 *) ctrl_req,
1816                              ctrl_urb_data, size, ctrl_callback, serial);
1817         /* Send it on merry way */
1818         result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1819         if (result) {
1820                 dev_err(&ctrl_urb->dev->dev,
1821                         "%s failed submit ctrl_urb %d type %d\n", __func__,
1822                         result, type);
1823                 return result;
1824         }
1825
1826         /* done */
1827         return size;
1828 }
1829
1830 /* called by intr_callback when read occurs */
1831 static int hso_mux_serial_read(struct hso_serial *serial)
1832 {
1833         if (!serial)
1834                 return -EINVAL;
1835
1836         /* clean data */
1837         memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1838         /* make the request */
1839
1840         if (serial->num_rx_urbs != 1) {
1841                 dev_err(&serial->parent->interface->dev,
1842                         "ERROR: mux'd reads with multiple buffers "
1843                         "not possible\n");
1844                 return 0;
1845         }
1846         return mux_device_request(serial,
1847                                   USB_CDC_GET_ENCAPSULATED_RESPONSE,
1848                                   serial->parent->port_spec & HSO_PORT_MASK,
1849                                   serial->rx_urb[0],
1850                                   &serial->ctrl_req_rx,
1851                                   serial->rx_data[0], serial->rx_data_length);
1852 }
1853
1854 /* used for muxed serial port callback (muxed serial read) */
1855 static void intr_callback(struct urb *urb)
1856 {
1857         struct hso_shared_int *shared_int = urb->context;
1858         struct hso_serial *serial;
1859         unsigned char *port_req;
1860         int status = urb->status;
1861         int i;
1862
1863         usb_mark_last_busy(urb->dev);
1864
1865         /* sanity check */
1866         if (!shared_int)
1867                 return;
1868
1869         /* status check */
1870         if (status) {
1871                 handle_usb_error(status, __func__, NULL);
1872                 return;
1873         }
1874         D4("\n--- Got intr callback 0x%02X ---", status);
1875
1876         /* what request? */
1877         port_req = urb->transfer_buffer;
1878         D4(" port_req = 0x%.2X\n", *port_req);
1879         /* loop over all muxed ports to find the one sending this */
1880         for (i = 0; i < 8; i++) {
1881                 /* max 8 channels on MUX */
1882                 if (*port_req & (1 << i)) {
1883                         serial = get_serial_by_shared_int_and_type(shared_int,
1884                                                                    (1 << i));
1885                         if (serial != NULL) {
1886                                 D1("Pending read interrupt on port %d\n", i);
1887                                 spin_lock(&serial->serial_lock);
1888                                 if (serial->rx_state == RX_IDLE &&
1889                                         serial->port.count > 0) {
1890                                         /* Setup and send a ctrl req read on
1891                                          * port i */
1892                                         if (!serial->rx_urb_filled[0]) {
1893                                                 serial->rx_state = RX_SENT;
1894                                                 hso_mux_serial_read(serial);
1895                                         } else
1896                                                 serial->rx_state = RX_PENDING;
1897                                 } else {
1898                                         D1("Already a read pending on "
1899                                            "port %d or port not open\n", i);
1900                                 }
1901                                 spin_unlock(&serial->serial_lock);
1902                         }
1903                 }
1904         }
1905         /* Resubmit interrupt urb */
1906         hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1907 }
1908
1909 /* called for writing to muxed serial port */
1910 static int hso_mux_serial_write_data(struct hso_serial *serial)
1911 {
1912         if (NULL == serial)
1913                 return -EINVAL;
1914
1915         return mux_device_request(serial,
1916                                   USB_CDC_SEND_ENCAPSULATED_COMMAND,
1917                                   serial->parent->port_spec & HSO_PORT_MASK,
1918                                   serial->tx_urb,
1919                                   &serial->ctrl_req_tx,
1920                                   serial->tx_data, serial->tx_data_count);
1921 }
1922
1923 /* write callback for Diag and CS port */
1924 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1925 {
1926         struct hso_serial *serial = urb->context;
1927         int status = urb->status;
1928
1929         /* sanity check */
1930         if (!serial) {
1931                 D1("serial == NULL");
1932                 return;
1933         }
1934
1935         spin_lock(&serial->serial_lock);
1936         serial->tx_urb_used = 0;
1937         spin_unlock(&serial->serial_lock);
1938         if (status) {
1939                 handle_usb_error(status, __func__, serial->parent);
1940                 return;
1941         }
1942         hso_put_activity(serial->parent);
1943         tty_port_tty_wakeup(&serial->port);
1944         hso_kick_transmit(serial);
1945
1946         D1(" ");
1947 }
1948
1949 /* called for writing diag or CS serial port */
1950 static int hso_std_serial_write_data(struct hso_serial *serial)
1951 {
1952         int count = serial->tx_data_count;
1953         int result;
1954
1955         usb_fill_bulk_urb(serial->tx_urb,
1956                           serial->parent->usb,
1957                           usb_sndbulkpipe(serial->parent->usb,
1958                                           serial->out_endp->
1959                                           bEndpointAddress & 0x7F),
1960                           serial->tx_data, serial->tx_data_count,
1961                           hso_std_serial_write_bulk_callback, serial);
1962
1963         result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1964         if (result) {
1965                 dev_warn(&serial->parent->usb->dev,
1966                          "Failed to submit urb - res %d\n", result);
1967                 return result;
1968         }
1969
1970         return count;
1971 }
1972
1973 /* callback after read or write on muxed serial port */
1974 static void ctrl_callback(struct urb *urb)
1975 {
1976         struct hso_serial *serial = urb->context;
1977         struct usb_ctrlrequest *req;
1978         int status = urb->status;
1979
1980         /* sanity check */
1981         if (!serial)
1982                 return;
1983
1984         spin_lock(&serial->serial_lock);
1985         serial->tx_urb_used = 0;
1986         spin_unlock(&serial->serial_lock);
1987         if (status) {
1988                 handle_usb_error(status, __func__, serial->parent);
1989                 return;
1990         }
1991
1992         /* what request? */
1993         req = (struct usb_ctrlrequest *)(urb->setup_packet);
1994         D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
1995         D4("Actual length of urb = %d\n", urb->actual_length);
1996         DUMP1(urb->transfer_buffer, urb->actual_length);
1997
1998         if (req->bRequestType ==
1999             (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2000                 /* response to a read command */
2001                 serial->rx_urb_filled[0] = 1;
2002                 spin_lock(&serial->serial_lock);
2003                 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2004                 spin_unlock(&serial->serial_lock);
2005         } else {
2006                 hso_put_activity(serial->parent);
2007                 tty_port_tty_wakeup(&serial->port);
2008                 /* response to a write command */
2009                 hso_kick_transmit(serial);
2010         }
2011 }
2012
2013 /* handle RX data for serial port */
2014 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2015 {
2016         struct tty_struct *tty;
2017         int count;
2018
2019         /* Sanity check */
2020         if (urb == NULL || serial == NULL) {
2021                 D1("serial = NULL");
2022                 return -2;
2023         }
2024
2025         tty = tty_port_tty_get(&serial->port);
2026
2027         if (tty && test_bit(TTY_THROTTLED, &tty->flags)) {
2028                 tty_kref_put(tty);
2029                 return -1;
2030         }
2031
2032         /* Push data to tty */
2033         D1("data to push to tty");
2034         count = tty_buffer_request_room(&serial->port, urb->actual_length);
2035         if (count >= urb->actual_length) {
2036                 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2037                                        urb->actual_length);
2038                 tty_flip_buffer_push(&serial->port);
2039         } else {
2040                 dev_warn(&serial->parent->usb->dev,
2041                          "dropping data, %d bytes lost\n", urb->actual_length);
2042         }
2043
2044         tty_kref_put(tty);
2045
2046         serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2047
2048         return 0;
2049 }
2050
2051
2052 /* Base driver functions */
2053
2054 static void hso_log_port(struct hso_device *hso_dev)
2055 {
2056         char *port_type;
2057         char port_dev[20];
2058
2059         switch (hso_dev->port_spec & HSO_PORT_MASK) {
2060         case HSO_PORT_CONTROL:
2061                 port_type = "Control";
2062                 break;
2063         case HSO_PORT_APP:
2064                 port_type = "Application";
2065                 break;
2066         case HSO_PORT_GPS:
2067                 port_type = "GPS";
2068                 break;
2069         case HSO_PORT_GPS_CONTROL:
2070                 port_type = "GPS control";
2071                 break;
2072         case HSO_PORT_APP2:
2073                 port_type = "Application2";
2074                 break;
2075         case HSO_PORT_PCSC:
2076                 port_type = "PCSC";
2077                 break;
2078         case HSO_PORT_DIAG:
2079                 port_type = "Diagnostic";
2080                 break;
2081         case HSO_PORT_DIAG2:
2082                 port_type = "Diagnostic2";
2083                 break;
2084         case HSO_PORT_MODEM:
2085                 port_type = "Modem";
2086                 break;
2087         case HSO_PORT_NETWORK:
2088                 port_type = "Network";
2089                 break;
2090         default:
2091                 port_type = "Unknown";
2092                 break;
2093         }
2094         if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2095                 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2096         } else
2097                 sprintf(port_dev, "/dev/%s%d", tty_filename,
2098                         dev2ser(hso_dev)->minor);
2099
2100         dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2101                 port_type, port_dev);
2102 }
2103
2104 static int hso_start_net_device(struct hso_device *hso_dev)
2105 {
2106         int i, result = 0;
2107         struct hso_net *hso_net = dev2net(hso_dev);
2108
2109         if (!hso_net)
2110                 return -ENODEV;
2111
2112         /* send URBs for all read buffers */
2113         for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2114
2115                 /* Prep a receive URB */
2116                 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2117                                   hso_dev->usb,
2118                                   usb_rcvbulkpipe(hso_dev->usb,
2119                                                   hso_net->in_endp->
2120                                                   bEndpointAddress & 0x7F),
2121                                   hso_net->mux_bulk_rx_buf_pool[i],
2122                                   MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2123                                   hso_net);
2124
2125                 /* Put it out there so the device can send us stuff */
2126                 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2127                                         GFP_NOIO);
2128                 if (result)
2129                         dev_warn(&hso_dev->usb->dev,
2130                                 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2131                                 i, result);
2132         }
2133
2134         return result;
2135 }
2136
2137 static int hso_stop_net_device(struct hso_device *hso_dev)
2138 {
2139         int i;
2140         struct hso_net *hso_net = dev2net(hso_dev);
2141
2142         if (!hso_net)
2143                 return -ENODEV;
2144
2145         for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2146                 if (hso_net->mux_bulk_rx_urb_pool[i])
2147                         usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2148
2149         }
2150         if (hso_net->mux_bulk_tx_urb)
2151                 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2152
2153         return 0;
2154 }
2155
2156 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2157 {
2158         int i, result = 0;
2159         struct hso_serial *serial = dev2ser(hso_dev);
2160
2161         if (!serial)
2162                 return -ENODEV;
2163
2164         /* If it is not the MUX port fill in and submit a bulk urb (already
2165          * allocated in hso_serial_start) */
2166         if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2167                 for (i = 0; i < serial->num_rx_urbs; i++) {
2168                         usb_fill_bulk_urb(serial->rx_urb[i],
2169                                           serial->parent->usb,
2170                                           usb_rcvbulkpipe(serial->parent->usb,
2171                                                           serial->in_endp->
2172                                                           bEndpointAddress &
2173                                                           0x7F),
2174                                           serial->rx_data[i],
2175                                           serial->rx_data_length,
2176                                           hso_std_serial_read_bulk_callback,
2177                                           serial);
2178                         result = usb_submit_urb(serial->rx_urb[i], flags);
2179                         if (result) {
2180                                 dev_warn(&serial->parent->usb->dev,
2181                                          "Failed to submit urb - res %d\n",
2182                                          result);
2183                                 break;
2184                         }
2185                 }
2186         } else {
2187                 mutex_lock(&serial->shared_int->shared_int_lock);
2188                 if (!serial->shared_int->use_count) {
2189                         result =
2190                             hso_mux_submit_intr_urb(serial->shared_int,
2191                                                     hso_dev->usb, flags);
2192                 }
2193                 serial->shared_int->use_count++;
2194                 mutex_unlock(&serial->shared_int->shared_int_lock);
2195         }
2196         if (serial->tiocmget)
2197                 tiocmget_submit_urb(serial,
2198                                     serial->tiocmget,
2199                                     serial->parent->usb);
2200         return result;
2201 }
2202
2203 static int hso_stop_serial_device(struct hso_device *hso_dev)
2204 {
2205         int i;
2206         struct hso_serial *serial = dev2ser(hso_dev);
2207         struct hso_tiocmget  *tiocmget;
2208
2209         if (!serial)
2210                 return -ENODEV;
2211
2212         for (i = 0; i < serial->num_rx_urbs; i++) {
2213                 if (serial->rx_urb[i]) {
2214                         usb_kill_urb(serial->rx_urb[i]);
2215                         serial->rx_urb_filled[i] = 0;
2216                 }
2217         }
2218         serial->curr_rx_urb_idx = 0;
2219
2220         if (serial->tx_urb)
2221                 usb_kill_urb(serial->tx_urb);
2222
2223         if (serial->shared_int) {
2224                 mutex_lock(&serial->shared_int->shared_int_lock);
2225                 if (serial->shared_int->use_count &&
2226                     (--serial->shared_int->use_count == 0)) {
2227                         struct urb *urb;
2228
2229                         urb = serial->shared_int->shared_intr_urb;
2230                         if (urb)
2231                                 usb_kill_urb(urb);
2232                 }
2233                 mutex_unlock(&serial->shared_int->shared_int_lock);
2234         }
2235         tiocmget = serial->tiocmget;
2236         if (tiocmget) {
2237                 wake_up_interruptible(&tiocmget->waitq);
2238                 usb_kill_urb(tiocmget->urb);
2239         }
2240
2241         return 0;
2242 }
2243
2244 static void hso_serial_tty_unregister(struct hso_serial *serial)
2245 {
2246         tty_unregister_device(tty_drv, serial->minor);
2247 }
2248
2249 static void hso_serial_common_free(struct hso_serial *serial)
2250 {
2251         int i;
2252
2253         for (i = 0; i < serial->num_rx_urbs; i++) {
2254                 /* unlink and free RX URB */
2255                 usb_free_urb(serial->rx_urb[i]);
2256                 /* free the RX buffer */
2257                 kfree(serial->rx_data[i]);
2258         }
2259
2260         /* unlink and free TX URB */
2261         usb_free_urb(serial->tx_urb);
2262         kfree(serial->tx_buffer);
2263         kfree(serial->tx_data);
2264         tty_port_destroy(&serial->port);
2265 }
2266
2267 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2268                                     int rx_size, int tx_size)
2269 {
2270         struct device *dev;
2271         int minor;
2272         int i;
2273
2274         tty_port_init(&serial->port);
2275
2276         minor = get_free_serial_index();
2277         if (minor < 0)
2278                 goto exit;
2279
2280         /* register our minor number */
2281         serial->parent->dev = tty_port_register_device_attr(&serial->port,
2282                         tty_drv, minor, &serial->parent->interface->dev,
2283                         serial->parent, hso_serial_dev_groups);
2284         dev = serial->parent->dev;
2285
2286         /* fill in specific data for later use */
2287         serial->minor = minor;
2288         serial->magic = HSO_SERIAL_MAGIC;
2289         spin_lock_init(&serial->serial_lock);
2290         serial->num_rx_urbs = num_urbs;
2291
2292         /* RX, allocate urb and initialize */
2293
2294         /* prepare our RX buffer */
2295         serial->rx_data_length = rx_size;
2296         for (i = 0; i < serial->num_rx_urbs; i++) {
2297                 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2298                 if (!serial->rx_urb[i]) {
2299                         dev_err(dev, "Could not allocate urb?\n");
2300                         goto exit;
2301                 }
2302                 serial->rx_urb[i]->transfer_buffer = NULL;
2303                 serial->rx_urb[i]->transfer_buffer_length = 0;
2304                 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2305                                              GFP_KERNEL);
2306                 if (!serial->rx_data[i])
2307                         goto exit;
2308         }
2309
2310         /* TX, allocate urb and initialize */
2311         serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2312         if (!serial->tx_urb) {
2313                 dev_err(dev, "Could not allocate urb?\n");
2314                 goto exit;
2315         }
2316         serial->tx_urb->transfer_buffer = NULL;
2317         serial->tx_urb->transfer_buffer_length = 0;
2318         /* prepare our TX buffer */
2319         serial->tx_data_count = 0;
2320         serial->tx_buffer_count = 0;
2321         serial->tx_data_length = tx_size;
2322         serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2323         if (!serial->tx_data)
2324                 goto exit;
2325
2326         serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2327         if (!serial->tx_buffer)
2328                 goto exit;
2329
2330         return 0;
2331 exit:
2332         hso_serial_tty_unregister(serial);
2333         hso_serial_common_free(serial);
2334         return -1;
2335 }
2336
2337 /* Creates a general hso device */
2338 static struct hso_device *hso_create_device(struct usb_interface *intf,
2339                                             int port_spec)
2340 {
2341         struct hso_device *hso_dev;
2342
2343         hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2344         if (!hso_dev)
2345                 return NULL;
2346
2347         hso_dev->port_spec = port_spec;
2348         hso_dev->usb = interface_to_usbdev(intf);
2349         hso_dev->interface = intf;
2350         kref_init(&hso_dev->ref);
2351         mutex_init(&hso_dev->mutex);
2352
2353         INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2354         INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2355
2356         return hso_dev;
2357 }
2358
2359 /* Removes a network device in the network device table */
2360 static int remove_net_device(struct hso_device *hso_dev)
2361 {
2362         int i;
2363
2364         for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2365                 if (network_table[i] == hso_dev) {
2366                         network_table[i] = NULL;
2367                         break;
2368                 }
2369         }
2370         if (i == HSO_MAX_NET_DEVICES)
2371                 return -1;
2372         return 0;
2373 }
2374
2375 /* Frees our network device */
2376 static void hso_free_net_device(struct hso_device *hso_dev)
2377 {
2378         int i;
2379         struct hso_net *hso_net = dev2net(hso_dev);
2380
2381         if (!hso_net)
2382                 return;
2383
2384         remove_net_device(hso_net->parent);
2385
2386         if (hso_net->net)
2387                 unregister_netdev(hso_net->net);
2388
2389         /* start freeing */
2390         for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2391                 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2392                 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2393                 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2394         }
2395         usb_free_urb(hso_net->mux_bulk_tx_urb);
2396         kfree(hso_net->mux_bulk_tx_buf);
2397         hso_net->mux_bulk_tx_buf = NULL;
2398
2399         if (hso_net->net)
2400                 free_netdev(hso_net->net);
2401
2402         kfree(hso_dev);
2403 }
2404
2405 static const struct net_device_ops hso_netdev_ops = {
2406         .ndo_open       = hso_net_open,
2407         .ndo_stop       = hso_net_close,
2408         .ndo_start_xmit = hso_net_start_xmit,
2409         .ndo_tx_timeout = hso_net_tx_timeout,
2410 };
2411
2412 /* initialize the network interface */
2413 static void hso_net_init(struct net_device *net)
2414 {
2415         struct hso_net *hso_net = netdev_priv(net);
2416
2417         D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2418
2419         /* fill in the other fields */
2420         net->netdev_ops = &hso_netdev_ops;
2421         net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2422         net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2423         net->type = ARPHRD_NONE;
2424         net->mtu = DEFAULT_MTU - 14;
2425         net->tx_queue_len = 10;
2426         net->ethtool_ops = &ops;
2427
2428         /* and initialize the semaphore */
2429         spin_lock_init(&hso_net->net_lock);
2430 }
2431
2432 /* Adds a network device in the network device table */
2433 static int add_net_device(struct hso_device *hso_dev)
2434 {
2435         int i;
2436
2437         for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2438                 if (network_table[i] == NULL) {
2439                         network_table[i] = hso_dev;
2440                         break;
2441                 }
2442         }
2443         if (i == HSO_MAX_NET_DEVICES)
2444                 return -1;
2445         return 0;
2446 }
2447
2448 static int hso_rfkill_set_block(void *data, bool blocked)
2449 {
2450         struct hso_device *hso_dev = data;
2451         int enabled = !blocked;
2452         int rv;
2453
2454         mutex_lock(&hso_dev->mutex);
2455         if (hso_dev->usb_gone)
2456                 rv = 0;
2457         else
2458                 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2459                                        enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2460                                        USB_CTRL_SET_TIMEOUT);
2461         mutex_unlock(&hso_dev->mutex);
2462         return rv;
2463 }
2464
2465 static const struct rfkill_ops hso_rfkill_ops = {
2466         .set_block = hso_rfkill_set_block,
2467 };
2468
2469 /* Creates and sets up everything for rfkill */
2470 static void hso_create_rfkill(struct hso_device *hso_dev,
2471                              struct usb_interface *interface)
2472 {
2473         struct hso_net *hso_net = dev2net(hso_dev);
2474         struct device *dev = &hso_net->net->dev;
2475         static u32 rfkill_counter;
2476
2477         snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2478                  rfkill_counter++);
2479
2480         hso_net->rfkill = rfkill_alloc(hso_net->name,
2481                                        &interface_to_usbdev(interface)->dev,
2482                                        RFKILL_TYPE_WWAN,
2483                                        &hso_rfkill_ops, hso_dev);
2484         if (!hso_net->rfkill) {
2485                 dev_err(dev, "%s - Out of memory\n", __func__);
2486                 return;
2487         }
2488         if (rfkill_register(hso_net->rfkill) < 0) {
2489                 rfkill_destroy(hso_net->rfkill);
2490                 hso_net->rfkill = NULL;
2491                 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2492                 return;
2493         }
2494 }
2495
2496 static struct device_type hso_type = {
2497         .name   = "wwan",
2498 };
2499
2500 /* Creates our network device */
2501 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2502                                                 int port_spec)
2503 {
2504         int result, i;
2505         struct net_device *net;
2506         struct hso_net *hso_net;
2507         struct hso_device *hso_dev;
2508
2509         hso_dev = hso_create_device(interface, port_spec);
2510         if (!hso_dev)
2511                 return NULL;
2512
2513         /* allocate our network device, then we can put in our private data */
2514         /* call hso_net_init to do the basic initialization */
2515         net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2516                            hso_net_init);
2517         if (!net) {
2518                 dev_err(&interface->dev, "Unable to create ethernet device\n");
2519                 goto exit;
2520         }
2521
2522         hso_net = netdev_priv(net);
2523
2524         hso_dev->port_data.dev_net = hso_net;
2525         hso_net->net = net;
2526         hso_net->parent = hso_dev;
2527
2528         hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2529                                       USB_DIR_IN);
2530         if (!hso_net->in_endp) {
2531                 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2532                 goto exit;
2533         }
2534         hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2535                                        USB_DIR_OUT);
2536         if (!hso_net->out_endp) {
2537                 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2538                 goto exit;
2539         }
2540         SET_NETDEV_DEV(net, &interface->dev);
2541         SET_NETDEV_DEVTYPE(net, &hso_type);
2542
2543         /* registering our net device */
2544         result = register_netdev(net);
2545         if (result) {
2546                 dev_err(&interface->dev, "Failed to register device\n");
2547                 goto exit;
2548         }
2549
2550         /* start allocating */
2551         for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2552                 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2553                 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2554                         dev_err(&interface->dev, "Could not allocate rx urb\n");
2555                         goto exit;
2556                 }
2557                 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2558                                                            GFP_KERNEL);
2559                 if (!hso_net->mux_bulk_rx_buf_pool[i])
2560                         goto exit;
2561         }
2562         hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2563         if (!hso_net->mux_bulk_tx_urb) {
2564                 dev_err(&interface->dev, "Could not allocate tx urb\n");
2565                 goto exit;
2566         }
2567         hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2568         if (!hso_net->mux_bulk_tx_buf)
2569                 goto exit;
2570
2571         add_net_device(hso_dev);
2572
2573         hso_log_port(hso_dev);
2574
2575         hso_create_rfkill(hso_dev, interface);
2576
2577         return hso_dev;
2578 exit:
2579         hso_free_net_device(hso_dev);
2580         return NULL;
2581 }
2582
2583 static void hso_free_tiomget(struct hso_serial *serial)
2584 {
2585         struct hso_tiocmget *tiocmget;
2586         if (!serial)
2587                 return;
2588         tiocmget = serial->tiocmget;
2589         if (tiocmget) {
2590                 usb_free_urb(tiocmget->urb);
2591                 tiocmget->urb = NULL;
2592                 serial->tiocmget = NULL;
2593                 kfree(tiocmget);
2594         }
2595 }
2596
2597 /* Frees an AT channel ( goes for both mux and non-mux ) */
2598 static void hso_free_serial_device(struct hso_device *hso_dev)
2599 {
2600         struct hso_serial *serial = dev2ser(hso_dev);
2601
2602         if (!serial)
2603                 return;
2604
2605         hso_serial_common_free(serial);
2606
2607         if (serial->shared_int) {
2608                 mutex_lock(&serial->shared_int->shared_int_lock);
2609                 if (--serial->shared_int->ref_count == 0)
2610                         hso_free_shared_int(serial->shared_int);
2611                 else
2612                         mutex_unlock(&serial->shared_int->shared_int_lock);
2613         }
2614         hso_free_tiomget(serial);
2615         kfree(serial);
2616         kfree(hso_dev);
2617 }
2618
2619 /* Creates a bulk AT channel */
2620 static struct hso_device *hso_create_bulk_serial_device(
2621                         struct usb_interface *interface, int port)
2622 {
2623         struct hso_device *hso_dev;
2624         struct hso_serial *serial;
2625         int num_urbs;
2626         struct hso_tiocmget *tiocmget;
2627
2628         hso_dev = hso_create_device(interface, port);
2629         if (!hso_dev)
2630                 return NULL;
2631
2632         serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2633         if (!serial)
2634                 goto exit;
2635
2636         serial->parent = hso_dev;
2637         hso_dev->port_data.dev_serial = serial;
2638
2639         if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2640                 num_urbs = 2;
2641                 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2642                                            GFP_KERNEL);
2643                 /* it isn't going to break our heart if serial->tiocmget
2644                  *  allocation fails don't bother checking this.
2645                  */
2646                 if (serial->tiocmget) {
2647                         tiocmget = serial->tiocmget;
2648                         tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2649                         if (tiocmget->urb) {
2650                                 mutex_init(&tiocmget->mutex);
2651                                 init_waitqueue_head(&tiocmget->waitq);
2652                                 tiocmget->endp = hso_get_ep(
2653                                         interface,
2654                                         USB_ENDPOINT_XFER_INT,
2655                                         USB_DIR_IN);
2656                         } else
2657                                 hso_free_tiomget(serial);
2658                 }
2659         }
2660         else
2661                 num_urbs = 1;
2662
2663         if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2664                                      BULK_URB_TX_SIZE))
2665                 goto exit;
2666
2667         serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2668                                      USB_DIR_IN);
2669         if (!serial->in_endp) {
2670                 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2671                 goto exit2;
2672         }
2673
2674         if (!
2675             (serial->out_endp =
2676              hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2677                 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2678                 goto exit2;
2679         }
2680
2681         serial->write_data = hso_std_serial_write_data;
2682
2683         /* and record this serial */
2684         set_serial_by_index(serial->minor, serial);
2685
2686         /* setup the proc dirs and files if needed */
2687         hso_log_port(hso_dev);
2688
2689         /* done, return it */
2690         return hso_dev;
2691
2692 exit2:
2693         hso_serial_tty_unregister(serial);
2694         hso_serial_common_free(serial);
2695 exit:
2696         hso_free_tiomget(serial);
2697         kfree(serial);
2698         kfree(hso_dev);
2699         return NULL;
2700 }
2701
2702 /* Creates a multiplexed AT channel */
2703 static
2704 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2705                                                 int port,
2706                                                 struct hso_shared_int *mux)
2707 {
2708         struct hso_device *hso_dev;
2709         struct hso_serial *serial;
2710         int port_spec;
2711
2712         port_spec = HSO_INTF_MUX;
2713         port_spec &= ~HSO_PORT_MASK;
2714
2715         port_spec |= hso_mux_to_port(port);
2716         if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2717                 return NULL;
2718
2719         hso_dev = hso_create_device(interface, port_spec);
2720         if (!hso_dev)
2721                 return NULL;
2722
2723         serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2724         if (!serial)
2725                 goto exit;
2726
2727         hso_dev->port_data.dev_serial = serial;
2728         serial->parent = hso_dev;
2729
2730         if (hso_serial_common_create
2731             (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2732                 goto exit;
2733
2734         serial->tx_data_length--;
2735         serial->write_data = hso_mux_serial_write_data;
2736
2737         serial->shared_int = mux;
2738         mutex_lock(&serial->shared_int->shared_int_lock);
2739         serial->shared_int->ref_count++;
2740         mutex_unlock(&serial->shared_int->shared_int_lock);
2741
2742         /* and record this serial */
2743         set_serial_by_index(serial->minor, serial);
2744
2745         /* setup the proc dirs and files if needed */
2746         hso_log_port(hso_dev);
2747
2748         /* done, return it */
2749         return hso_dev;
2750
2751 exit:
2752         if (serial) {
2753                 tty_unregister_device(tty_drv, serial->minor);
2754                 kfree(serial);
2755         }
2756         kfree(hso_dev);
2757         return NULL;
2758
2759 }
2760
2761 static void hso_free_shared_int(struct hso_shared_int *mux)
2762 {
2763         usb_free_urb(mux->shared_intr_urb);
2764         kfree(mux->shared_intr_buf);
2765         mutex_unlock(&mux->shared_int_lock);
2766         kfree(mux);
2767 }
2768
2769 static
2770 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2771 {
2772         struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2773
2774         if (!mux)
2775                 return NULL;
2776
2777         mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2778                                     USB_DIR_IN);
2779         if (!mux->intr_endp) {
2780                 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2781                 goto exit;
2782         }
2783
2784         mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2785         if (!mux->shared_intr_urb) {
2786                 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2787                 goto exit;
2788         }
2789         mux->shared_intr_buf =
2790                 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2791                         GFP_KERNEL);
2792         if (!mux->shared_intr_buf)
2793                 goto exit;
2794
2795         mutex_init(&mux->shared_int_lock);
2796
2797         return mux;
2798
2799 exit:
2800         kfree(mux->shared_intr_buf);
2801         usb_free_urb(mux->shared_intr_urb);
2802         kfree(mux);
2803         return NULL;
2804 }
2805
2806 /* Gets the port spec for a certain interface */
2807 static int hso_get_config_data(struct usb_interface *interface)
2808 {
2809         struct usb_device *usbdev = interface_to_usbdev(interface);
2810         u8 *config_data = kmalloc(17, GFP_KERNEL);
2811         u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2812         s32 result;
2813
2814         if (!config_data)
2815                 return -ENOMEM;
2816         if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2817                             0x86, 0xC0, 0, 0, config_data, 17,
2818                             USB_CTRL_SET_TIMEOUT) != 0x11) {
2819                 kfree(config_data);
2820                 return -EIO;
2821         }
2822
2823         switch (config_data[if_num]) {
2824         case 0x0:
2825                 result = 0;
2826                 break;
2827         case 0x1:
2828                 result = HSO_PORT_DIAG;
2829                 break;
2830         case 0x2:
2831                 result = HSO_PORT_GPS;
2832                 break;
2833         case 0x3:
2834                 result = HSO_PORT_GPS_CONTROL;
2835                 break;
2836         case 0x4:
2837                 result = HSO_PORT_APP;
2838                 break;
2839         case 0x5:
2840                 result = HSO_PORT_APP2;
2841                 break;
2842         case 0x6:
2843                 result = HSO_PORT_CONTROL;
2844                 break;
2845         case 0x7:
2846                 result = HSO_PORT_NETWORK;
2847                 break;
2848         case 0x8:
2849                 result = HSO_PORT_MODEM;
2850                 break;
2851         case 0x9:
2852                 result = HSO_PORT_MSD;
2853                 break;
2854         case 0xa:
2855                 result = HSO_PORT_PCSC;
2856                 break;
2857         case 0xb:
2858                 result = HSO_PORT_VOICE;
2859                 break;
2860         default:
2861                 result = 0;
2862         }
2863
2864         if (result)
2865                 result |= HSO_INTF_BULK;
2866
2867         if (config_data[16] & 0x1)
2868                 result |= HSO_INFO_CRC_BUG;
2869
2870         kfree(config_data);
2871         return result;
2872 }
2873
2874 /* called once for each interface upon device insertion */
2875 static int hso_probe(struct usb_interface *interface,
2876                      const struct usb_device_id *id)
2877 {
2878         int mux, i, if_num, port_spec;
2879         unsigned char port_mask;
2880         struct hso_device *hso_dev = NULL;
2881         struct hso_shared_int *shared_int;
2882         struct hso_device *tmp_dev = NULL;
2883
2884         if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2885                 dev_err(&interface->dev, "Not our interface\n");
2886                 return -ENODEV;
2887         }
2888
2889         if_num = interface->altsetting->desc.bInterfaceNumber;
2890
2891         /* Get the interface/port specification from either driver_info or from
2892          * the device itself */
2893         if (id->driver_info)
2894                 port_spec = ((u32 *)(id->driver_info))[if_num];
2895         else
2896                 port_spec = hso_get_config_data(interface);
2897
2898         /* Check if we need to switch to alt interfaces prior to port
2899          * configuration */
2900         if (interface->num_altsetting > 1)
2901                 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2902         interface->needs_remote_wakeup = 1;
2903
2904         /* Allocate new hso device(s) */
2905         switch (port_spec & HSO_INTF_MASK) {
2906         case HSO_INTF_MUX:
2907                 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2908                         /* Create the network device */
2909                         if (!disable_net) {
2910                                 hso_dev = hso_create_net_device(interface,
2911                                                                 port_spec);
2912                                 if (!hso_dev)
2913                                         goto exit;
2914                                 tmp_dev = hso_dev;
2915                         }
2916                 }
2917
2918                 if (hso_get_mux_ports(interface, &port_mask))
2919                         /* TODO: de-allocate everything */
2920                         goto exit;
2921
2922                 shared_int = hso_create_shared_int(interface);
2923                 if (!shared_int)
2924                         goto exit;
2925
2926                 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2927                         if (port_mask & i) {
2928                                 hso_dev = hso_create_mux_serial_device(
2929                                                 interface, i, shared_int);
2930                                 if (!hso_dev)
2931                                         goto exit;
2932                         }
2933                 }
2934
2935                 if (tmp_dev)
2936                         hso_dev = tmp_dev;
2937                 break;
2938
2939         case HSO_INTF_BULK:
2940                 /* It's a regular bulk interface */
2941                 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2942                         if (!disable_net)
2943                                 hso_dev =
2944                                     hso_create_net_device(interface, port_spec);
2945                 } else {
2946                         hso_dev =
2947                             hso_create_bulk_serial_device(interface, port_spec);
2948                 }
2949                 if (!hso_dev)
2950                         goto exit;
2951                 break;
2952         default:
2953                 goto exit;
2954         }
2955
2956         /* save our data pointer in this device */
2957         usb_set_intfdata(interface, hso_dev);
2958
2959         /* done */
2960         return 0;
2961 exit:
2962         hso_free_interface(interface);
2963         return -ENODEV;
2964 }
2965
2966 /* device removed, cleaning up */
2967 static void hso_disconnect(struct usb_interface *interface)
2968 {
2969         hso_free_interface(interface);
2970
2971         /* remove reference of our private data */
2972         usb_set_intfdata(interface, NULL);
2973 }
2974
2975 static void async_get_intf(struct work_struct *data)
2976 {
2977         struct hso_device *hso_dev =
2978             container_of(data, struct hso_device, async_get_intf);
2979         usb_autopm_get_interface(hso_dev->interface);
2980 }
2981
2982 static void async_put_intf(struct work_struct *data)
2983 {
2984         struct hso_device *hso_dev =
2985             container_of(data, struct hso_device, async_put_intf);
2986         usb_autopm_put_interface(hso_dev->interface);
2987 }
2988
2989 static int hso_get_activity(struct hso_device *hso_dev)
2990 {
2991         if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2992                 if (!hso_dev->is_active) {
2993                         hso_dev->is_active = 1;
2994                         schedule_work(&hso_dev->async_get_intf);
2995                 }
2996         }
2997
2998         if (hso_dev->usb->state != USB_STATE_CONFIGURED)
2999                 return -EAGAIN;
3000
3001         usb_mark_last_busy(hso_dev->usb);
3002
3003         return 0;
3004 }
3005
3006 static int hso_put_activity(struct hso_device *hso_dev)
3007 {
3008         if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3009                 if (hso_dev->is_active) {
3010                         hso_dev->is_active = 0;
3011                         schedule_work(&hso_dev->async_put_intf);
3012                         return -EAGAIN;
3013                 }
3014         }
3015         hso_dev->is_active = 0;
3016         return 0;
3017 }
3018
3019 /* called by kernel when we need to suspend device */
3020 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3021 {
3022         int i, result;
3023
3024         /* Stop all serial ports */
3025         for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3026                 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3027                         result = hso_stop_serial_device(serial_table[i]);
3028                         if (result)
3029                                 goto out;
3030                 }
3031         }
3032
3033         /* Stop all network ports */
3034         for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3035                 if (network_table[i] &&
3036                     (network_table[i]->interface == iface)) {
3037                         result = hso_stop_net_device(network_table[i]);
3038                         if (result)
3039                                 goto out;
3040                 }
3041         }
3042
3043 out:
3044         return 0;
3045 }
3046
3047 /* called by kernel when we need to resume device */
3048 static int hso_resume(struct usb_interface *iface)
3049 {
3050         int i, result = 0;
3051         struct hso_net *hso_net;
3052
3053         /* Start all serial ports */
3054         for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3055                 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3056                         if (dev2ser(serial_table[i])->port.count) {
3057                                 result =
3058                                     hso_start_serial_device(serial_table[i], GFP_NOIO);
3059                                 hso_kick_transmit(dev2ser(serial_table[i]));
3060                                 if (result)
3061                                         goto out;
3062                         }
3063                 }
3064         }
3065
3066         /* Start all network ports */
3067         for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3068                 if (network_table[i] &&
3069                     (network_table[i]->interface == iface)) {
3070                         hso_net = dev2net(network_table[i]);
3071                         if (hso_net->flags & IFF_UP) {
3072                                 /* First transmit any lingering data,
3073                                    then restart the device. */
3074                                 if (hso_net->skb_tx_buf) {
3075                                         dev_dbg(&iface->dev,
3076                                                 "Transmitting"
3077                                                 " lingering data\n");
3078                                         hso_net_start_xmit(hso_net->skb_tx_buf,
3079                                                            hso_net->net);
3080                                         hso_net->skb_tx_buf = NULL;
3081                                 }
3082                                 result = hso_start_net_device(network_table[i]);
3083                                 if (result)
3084                                         goto out;
3085                         }
3086                 }
3087         }
3088
3089 out:
3090         return result;
3091 }
3092
3093 static void hso_serial_ref_free(struct kref *ref)
3094 {
3095         struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3096
3097         hso_free_serial_device(hso_dev);
3098 }
3099
3100 static void hso_free_interface(struct usb_interface *interface)
3101 {
3102         struct hso_serial *serial;
3103         int i;
3104
3105         for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3106                 if (serial_table[i] &&
3107                     (serial_table[i]->interface == interface)) {
3108                         serial = dev2ser(serial_table[i]);
3109                         tty_port_tty_hangup(&serial->port, false);
3110                         mutex_lock(&serial->parent->mutex);
3111                         serial->parent->usb_gone = 1;
3112                         mutex_unlock(&serial->parent->mutex);
3113                         cancel_work_sync(&serial_table[i]->async_put_intf);
3114                         cancel_work_sync(&serial_table[i]->async_get_intf);
3115                         hso_serial_tty_unregister(serial);
3116                         kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3117                         set_serial_by_index(i, NULL);
3118                 }
3119         }
3120
3121         for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3122                 if (network_table[i] &&
3123                     (network_table[i]->interface == interface)) {
3124                         struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3125                         /* hso_stop_net_device doesn't stop the net queue since
3126                          * traffic needs to start it again when suspended */
3127                         netif_stop_queue(dev2net(network_table[i])->net);
3128                         hso_stop_net_device(network_table[i]);
3129                         cancel_work_sync(&network_table[i]->async_put_intf);
3130                         cancel_work_sync(&network_table[i]->async_get_intf);
3131                         if (rfk) {
3132                                 rfkill_unregister(rfk);
3133                                 rfkill_destroy(rfk);
3134                         }
3135                         hso_free_net_device(network_table[i]);
3136                 }
3137         }
3138 }
3139
3140 /* Helper functions */
3141
3142 /* Get the endpoint ! */
3143 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3144                                                   int type, int dir)
3145 {
3146         int i;
3147         struct usb_host_interface *iface = intf->cur_altsetting;
3148         struct usb_endpoint_descriptor *endp;
3149
3150         for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3151                 endp = &iface->endpoint[i].desc;
3152                 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3153                     (usb_endpoint_type(endp) == type))
3154                         return endp;
3155         }
3156
3157         return NULL;
3158 }
3159
3160 /* Get the byte that describes which ports are enabled */
3161 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3162 {
3163         int i;
3164         struct usb_host_interface *iface = intf->cur_altsetting;
3165
3166         if (iface->extralen == 3) {
3167                 *ports = iface->extra[2];
3168                 return 0;
3169         }
3170
3171         for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3172                 if (iface->endpoint[i].extralen == 3) {
3173                         *ports = iface->endpoint[i].extra[2];
3174                         return 0;
3175                 }
3176         }
3177
3178         return -1;
3179 }
3180
3181 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3182 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3183                                    struct usb_device *usb, gfp_t gfp)
3184 {
3185         int result;
3186
3187         usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3188                          usb_rcvintpipe(usb,
3189                                 shared_int->intr_endp->bEndpointAddress & 0x7F),
3190                          shared_int->shared_intr_buf,
3191                          1,
3192                          intr_callback, shared_int,
3193                          shared_int->intr_endp->bInterval);
3194
3195         result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3196         if (result)
3197                 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3198                         result);
3199
3200         return result;
3201 }
3202
3203 /* operations setup of the serial interface */
3204 static const struct tty_operations hso_serial_ops = {
3205         .open = hso_serial_open,
3206         .close = hso_serial_close,
3207         .write = hso_serial_write,
3208         .write_room = hso_serial_write_room,
3209         .cleanup = hso_serial_cleanup,
3210         .ioctl = hso_serial_ioctl,
3211         .set_termios = hso_serial_set_termios,
3212         .chars_in_buffer = hso_serial_chars_in_buffer,
3213         .tiocmget = hso_serial_tiocmget,
3214         .tiocmset = hso_serial_tiocmset,
3215         .get_icount = hso_get_count,
3216         .unthrottle = hso_unthrottle
3217 };
3218
3219 static struct usb_driver hso_driver = {
3220         .name = driver_name,
3221         .probe = hso_probe,
3222         .disconnect = hso_disconnect,
3223         .id_table = hso_ids,
3224         .suspend = hso_suspend,
3225         .resume = hso_resume,
3226         .reset_resume = hso_resume,
3227         .supports_autosuspend = 1,
3228         .disable_hub_initiated_lpm = 1,
3229 };
3230
3231 static int __init hso_init(void)
3232 {
3233         int i;
3234         int result;
3235
3236         /* put it in the log */
3237         printk(KERN_INFO "hso: %s\n", version);
3238
3239         /* Initialise the serial table semaphore and table */
3240         spin_lock_init(&serial_table_lock);
3241         for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3242                 serial_table[i] = NULL;
3243
3244         /* allocate our driver using the proper amount of supported minors */
3245         tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3246         if (!tty_drv)
3247                 return -ENOMEM;
3248
3249         /* fill in all needed values */
3250         tty_drv->driver_name = driver_name;
3251         tty_drv->name = tty_filename;
3252
3253         /* if major number is provided as parameter, use that one */
3254         if (tty_major)
3255                 tty_drv->major = tty_major;
3256
3257         tty_drv->minor_start = 0;
3258         tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3259         tty_drv->subtype = SERIAL_TYPE_NORMAL;
3260         tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3261         tty_drv->init_termios = tty_std_termios;
3262         hso_init_termios(&tty_drv->init_termios);
3263         tty_set_operations(tty_drv, &hso_serial_ops);
3264
3265         /* register the tty driver */
3266         result = tty_register_driver(tty_drv);
3267         if (result) {
3268                 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3269                         __func__, result);
3270                 goto err_free_tty;
3271         }
3272
3273         /* register this module as an usb driver */
3274         result = usb_register(&hso_driver);
3275         if (result) {
3276                 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3277                         result);
3278                 goto err_unreg_tty;
3279         }
3280
3281         /* done */
3282         return 0;
3283 err_unreg_tty:
3284         tty_unregister_driver(tty_drv);
3285 err_free_tty:
3286         put_tty_driver(tty_drv);
3287         return result;
3288 }
3289
3290 static void __exit hso_exit(void)
3291 {
3292         printk(KERN_INFO "hso: unloaded\n");
3293
3294         tty_unregister_driver(tty_drv);
3295         put_tty_driver(tty_drv);
3296         /* deregister the usb driver */
3297         usb_deregister(&hso_driver);
3298 }
3299
3300 /* Module definitions */
3301 module_init(hso_init);
3302 module_exit(hso_exit);
3303
3304 MODULE_AUTHOR(MOD_AUTHOR);
3305 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3306 MODULE_LICENSE(MOD_LICENSE);
3307
3308 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3309 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3310 module_param(debug, int, S_IRUGO | S_IWUSR);
3311
3312 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3313 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3314 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3315
3316 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3317 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3318 module_param(disable_net, int, S_IRUGO | S_IWUSR);