drivers/net/usb/hso.c

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