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