err.no Git - linux-2.6/blob - drivers/usb/serial/option.c

   1 /*
   2   USB Driver for GSM modems
   3
   4   Copyright (C) 2005  Matthias Urlichs <smurf@smurf.noris.de>
   5
   6   This driver is free software; you can redistribute it and/or modify
   7   it under the terms of Version 2 of the GNU General Public License as
   8   published by the Free Software Foundation.
   9
  10   Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
  11
  12   History: see the git log.
  13
  14   Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
  15
  16   This driver exists because the "normal" serial driver doesn't work too well
  17   with GSM modems. Issues:
  18   - data loss -- one single Receive URB is not nearly enough
  19   - nonstandard flow (Option devices) control
  20   - controlling the baud rate doesn't make sense
  21
  22   This driver is named "option" because the most common device it's
  23   used for is a PC-Card (with an internal OHCI-USB interface, behind
  24   which the GSM interface sits), made by Option Inc.
  25
  26   Some of the "one port" devices actually exhibit multiple USB instances
  27   on the USB bus. This is not a bug, these ports are used for different
  28   device features.
  29 */
  30
  31 #define DRIVER_VERSION "v0.7.1"
  32 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
  33 #define DRIVER_DESC "USB Driver for GSM modems"
  34
  35 #include <linux/kernel.h>
  36 #include <linux/jiffies.h>
  37 #include <linux/errno.h>
  38 #include <linux/tty.h>
  39 #include <linux/tty_flip.h>
  40 #include <linux/module.h>
  41 #include <linux/bitops.h>
  42 #include <linux/usb.h>
  43 #include <linux/usb/serial.h>
  44
  45 /* Function prototypes */
  46 static int  option_open(struct usb_serial_port *port, struct file *filp);
  47 static void option_close(struct usb_serial_port *port, struct file *filp);
  48 static int  option_startup(struct usb_serial *serial);
  49 static void option_shutdown(struct usb_serial *serial);
  50 static void option_rx_throttle(struct usb_serial_port *port);
  51 static void option_rx_unthrottle(struct usb_serial_port *port);
  52 static int  option_write_room(struct usb_serial_port *port);
  53
  54 static void option_instat_callback(struct urb *urb);
  55
  56 static int option_write(struct usb_serial_port *port,
  57                         const unsigned char *buf, int count);
  58
  59 static int  option_chars_in_buffer(struct usb_serial_port *port);
  60 static int  option_ioctl(struct usb_serial_port *port, struct file *file,
  61                         unsigned int cmd, unsigned long arg);
  62 static void option_set_termios(struct usb_serial_port *port,
  63                                 struct ktermios *old);
  64 static void option_break_ctl(struct usb_serial_port *port, int break_state);
  65 static int  option_tiocmget(struct usb_serial_port *port, struct file *file);
  66 static int  option_tiocmset(struct usb_serial_port *port, struct file *file,
  67                                 unsigned int set, unsigned int clear);
  68 static int  option_send_setup(struct usb_serial_port *port);
  69
  70 /* Vendor and product IDs */
  71 #define OPTION_VENDOR_ID                        0x0AF0
  72 #define OPTION_PRODUCT_COLT                     0x5000
  73 #define OPTION_PRODUCT_RICOLA                   0x6000
  74 #define OPTION_PRODUCT_RICOLA_LIGHT             0x6100
  75 #define OPTION_PRODUCT_RICOLA_QUAD              0x6200
  76 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT        0x6300
  77 #define OPTION_PRODUCT_RICOLA_NDIS              0x6050
  78 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT        0x6150
  79 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD         0x6250
  80 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT   0x6350
  81 #define OPTION_PRODUCT_COBRA                    0x6500
  82 #define OPTION_PRODUCT_COBRA_BUS                0x6501
  83 #define OPTION_PRODUCT_VIPER                    0x6600
  84 #define OPTION_PRODUCT_VIPER_BUS                0x6601
  85 #define OPTION_PRODUCT_GT_MAX_READY             0x6701
  86 #define OPTION_PRODUCT_GT_MAX                   0x6711
  87 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT         0x6721
  88 #define OPTION_PRODUCT_FUJI_MODEM_GT            0x6741
  89 #define OPTION_PRODUCT_FUJI_MODEM_EX            0x6761
  90 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT       0x6731
  91 #define OPTION_PRODUCT_FUJI_NETWORK_GT          0x6751
  92 #define OPTION_PRODUCT_FUJI_NETWORK_EX          0x6771
  93 #define OPTION_PRODUCT_KOI_MODEM                0x6800
  94 #define OPTION_PRODUCT_KOI_NETWORK              0x6811
  95 #define OPTION_PRODUCT_SCORPION_MODEM           0x6901
  96 #define OPTION_PRODUCT_SCORPION_NETWORK         0x6911
  97 #define OPTION_PRODUCT_ETNA_MODEM               0x7001
  98 #define OPTION_PRODUCT_ETNA_NETWORK             0x7011
  99 #define OPTION_PRODUCT_ETNA_MODEM_LITE          0x7021
 100 #define OPTION_PRODUCT_ETNA_MODEM_GT            0x7041
 101 #define OPTION_PRODUCT_ETNA_MODEM_EX            0x7061
 102 #define OPTION_PRODUCT_ETNA_NETWORK_LITE        0x7031
 103 #define OPTION_PRODUCT_ETNA_NETWORK_GT          0x7051
 104 #define OPTION_PRODUCT_ETNA_NETWORK_EX          0x7071
 105 #define OPTION_PRODUCT_ETNA_KOI_MODEM           0x7100
 106 #define OPTION_PRODUCT_ETNA_KOI_NETWORK         0x7111
 107
 108 #define HUAWEI_VENDOR_ID                        0x12D1
 109 #define HUAWEI_PRODUCT_E600                     0x1001
 110 #define HUAWEI_PRODUCT_E220                     0x1003
 111 #define HUAWEI_PRODUCT_E220BIS                  0x1004
 112
 113 #define NOVATELWIRELESS_VENDOR_ID               0x1410
 114 #define DELL_VENDOR_ID                          0x413C
 115
 116 #define ANYDATA_VENDOR_ID                       0x16d5
 117 #define ANYDATA_PRODUCT_ADU_E100A               0x6501
 118 #define ANYDATA_PRODUCT_ADU_500A                0x6502
 119
 120 #define BANDRICH_VENDOR_ID                      0x1A8D
 121 #define BANDRICH_PRODUCT_C100_1                 0x1002
 122 #define BANDRICH_PRODUCT_C100_2                 0x1003
 123
 124 static struct usb_device_id option_ids[] = {
 125         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
 126         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
 127         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
 128         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
 129         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
 130         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
 131         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
 132         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
 133         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
 134         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
 135         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
 136         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
 137         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
 138         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
 139         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
 140         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
 141         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
 142         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
 143         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
 144         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
 145         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
 146         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
 147         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
 148         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
 149         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
 150         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
 151         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
 152         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
 153         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
 154         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
 155         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
 156         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
 157         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
 158         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
 159         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
 160         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
 161         { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
 162         { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
 163         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1100) }, /* Novatel Merlin XS620/S640 */
 164         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1110) }, /* Novatel Merlin S620 */
 165         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1120) }, /* Novatel Merlin EX720 */
 166         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1130) }, /* Novatel Merlin S720 */
 167         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1400) }, /* Novatel U730 */
 168         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1410) }, /* Novatel U740 */
 169         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1420) }, /* Novatel EU870 */
 170         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1430) }, /* Novatel Merlin XU870 HSDPA/3G */
 171         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2100) }, /* Novatel EV620 CDMA/EV-DO */
 172         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2110) }, /* Novatel Merlin ES620 / Merlin ES720 / Ovation U720 */
 173         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2130) }, /* Novatel Merlin ES620 SM Bus */
 174         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2410) }, /* Novatel EU740 */
 175         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x4100) }, /* Novatel U727 */
 176         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x4400) }, /* Novatel MC950 */
 177         { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
 178         { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
 179         { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
 180         { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
 181         { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
 182         { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
 183         { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
 184         { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
 185         { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
 186         { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
 187         { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
 188         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
 189         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
 190         { } /* Terminating entry */
 191 };
 192 MODULE_DEVICE_TABLE(usb, option_ids);
 193
 194 static struct usb_driver option_driver = {
 195         .name       = "option",
 196         .probe      = usb_serial_probe,
 197         .disconnect = usb_serial_disconnect,
 198         .id_table   = option_ids,
 199         .no_dynamic_id =        1,
 200 };
 201
 202 /* The card has three separate interfaces, which the serial driver
 203  * recognizes separately, thus num_port=1.
 204  */
 205
 206 static struct usb_serial_driver option_1port_device = {
 207         .driver = {
 208                 .owner =        THIS_MODULE,
 209                 .name =         "option1",
 210         },
 211         .description       = "GSM modem (1-port)",
 212         .usb_driver        = &option_driver,
 213         .id_table          = option_ids,
 214         .num_interrupt_in  = NUM_DONT_CARE,
 215         .num_bulk_in       = NUM_DONT_CARE,
 216         .num_bulk_out      = NUM_DONT_CARE,
 217         .num_ports         = 1,
 218         .open              = option_open,
 219         .close             = option_close,
 220         .write             = option_write,
 221         .write_room        = option_write_room,
 222         .chars_in_buffer   = option_chars_in_buffer,
 223         .throttle          = option_rx_throttle,
 224         .unthrottle        = option_rx_unthrottle,
 225         .ioctl             = option_ioctl,
 226         .set_termios       = option_set_termios,
 227         .break_ctl         = option_break_ctl,
 228         .tiocmget          = option_tiocmget,
 229         .tiocmset          = option_tiocmset,
 230         .attach            = option_startup,
 231         .shutdown          = option_shutdown,
 232         .read_int_callback = option_instat_callback,
 233 };
 234
 235 #ifdef CONFIG_USB_DEBUG
 236 static int debug;
 237 #else
 238 #define debug 0
 239 #endif
 240
 241 /* per port private data */
 242
 243 #define N_IN_URB 4
 244 #define N_OUT_URB 1
 245 #define IN_BUFLEN 4096
 246 #define OUT_BUFLEN 128
 247
 248 struct option_port_private {
 249         /* Input endpoints and buffer for this port */
 250         struct urb *in_urbs[N_IN_URB];
 251         u8 *in_buffer[N_IN_URB];
 252         /* Output endpoints and buffer for this port */
 253         struct urb *out_urbs[N_OUT_URB];
 254         u8 *out_buffer[N_OUT_URB];
 255         unsigned long out_busy;         /* Bit vector of URBs in use */
 256
 257         /* Settings for the port */
 258         int rts_state;  /* Handshaking pins (outputs) */
 259         int dtr_state;
 260         int cts_state;  /* Handshaking pins (inputs) */
 261         int dsr_state;
 262         int dcd_state;
 263         int ri_state;
 264
 265         unsigned long tx_start_time[N_OUT_URB];
 266 };
 267
 268 /* Functions used by new usb-serial code. */
 269 static int __init option_init(void)
 270 {
 271         int retval;
 272         retval = usb_serial_register(&option_1port_device);
 273         if (retval)
 274                 goto failed_1port_device_register;
 275         retval = usb_register(&option_driver);
 276         if (retval)
 277                 goto failed_driver_register;
 278
 279         info(DRIVER_DESC ": " DRIVER_VERSION);
 280
 281         return 0;
 282
 283 failed_driver_register:
 284         usb_serial_deregister (&option_1port_device);
 285 failed_1port_device_register:
 286         return retval;
 287 }
 288
 289 static void __exit option_exit(void)
 290 {
 291         usb_deregister (&option_driver);
 292         usb_serial_deregister (&option_1port_device);
 293 }
 294
 295 module_init(option_init);
 296 module_exit(option_exit);
 297
 298 static void option_rx_throttle(struct usb_serial_port *port)
 299 {
 300         dbg("%s", __FUNCTION__);
 301 }
 302
 303 static void option_rx_unthrottle(struct usb_serial_port *port)
 304 {
 305         dbg("%s", __FUNCTION__);
 306 }
 307
 308 static void option_break_ctl(struct usb_serial_port *port, int break_state)
 309 {
 310         /* Unfortunately, I don't know how to send a break */
 311         dbg("%s", __FUNCTION__);
 312 }
 313
 314 static void option_set_termios(struct usb_serial_port *port,
 315                         struct ktermios *old_termios)
 316 {
 317         dbg("%s", __FUNCTION__);
 318         /* Doesn't support option setting */
 319         tty_termios_copy_hw(port->tty->termios, old_termios);
 320         option_send_setup(port);
 321 }
 322
 323 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
 324 {
 325         unsigned int value;
 326         struct option_port_private *portdata;
 327
 328         portdata = usb_get_serial_port_data(port);
 329
 330         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
 331                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
 332                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
 333                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
 334                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
 335                 ((portdata->ri_state) ? TIOCM_RNG : 0);
 336
 337         return value;
 338 }
 339
 340 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
 341                         unsigned int set, unsigned int clear)
 342 {
 343         struct option_port_private *portdata;
 344
 345         portdata = usb_get_serial_port_data(port);
 346
 347         if (set & TIOCM_RTS)
 348                 portdata->rts_state = 1;
 349         if (set & TIOCM_DTR)
 350                 portdata->dtr_state = 1;
 351
 352         if (clear & TIOCM_RTS)
 353                 portdata->rts_state = 0;
 354         if (clear & TIOCM_DTR)
 355                 portdata->dtr_state = 0;
 356         return option_send_setup(port);
 357 }
 358
 359 static int option_ioctl(struct usb_serial_port *port, struct file *file,
 360                         unsigned int cmd, unsigned long arg)
 361 {
 362         return -ENOIOCTLCMD;
 363 }
 364
 365 /* Write */
 366 static int option_write(struct usb_serial_port *port,
 367                         const unsigned char *buf, int count)
 368 {
 369         struct option_port_private *portdata;
 370         int i;
 371         int left, todo;
 372         struct urb *this_urb = NULL; /* spurious */
 373         int err;
 374
 375         portdata = usb_get_serial_port_data(port);
 376
 377         dbg("%s: write (%d chars)", __FUNCTION__, count);
 378
 379         i = 0;
 380         left = count;
 381         for (i=0; left > 0 && i < N_OUT_URB; i++) {
 382                 todo = left;
 383                 if (todo > OUT_BUFLEN)
 384                         todo = OUT_BUFLEN;
 385
 386                 this_urb = portdata->out_urbs[i];
 387                 if (test_and_set_bit(i, &portdata->out_busy)) {
 388                         if (time_before(jiffies,
 389                                         portdata->tx_start_time[i] + 10 * HZ))
 390                                 continue;
 391                         usb_unlink_urb(this_urb);
 392                         continue;
 393                 }
 394                 if (this_urb->status != 0)
 395                         dbg("usb_write %p failed (err=%d)",
 396                                 this_urb, this_urb->status);
 397
 398                 dbg("%s: endpoint %d buf %d", __FUNCTION__,
 399                         usb_pipeendpoint(this_urb->pipe), i);
 400
 401                 /* send the data */
 402                 memcpy (this_urb->transfer_buffer, buf, todo);
 403                 this_urb->transfer_buffer_length = todo;
 404
 405                 this_urb->dev = port->serial->dev;
 406                 err = usb_submit_urb(this_urb, GFP_ATOMIC);
 407                 if (err) {
 408                         dbg("usb_submit_urb %p (write bulk) failed "
 409                                 "(%d, has %d)", this_urb,
 410                                 err, this_urb->status);
 411                         clear_bit(i, &portdata->out_busy);
 412                         continue;
 413                 }
 414                 portdata->tx_start_time[i] = jiffies;
 415                 buf += todo;
 416                 left -= todo;
 417         }
 418
 419         count -= left;
 420         dbg("%s: wrote (did %d)", __FUNCTION__, count);
 421         return count;
 422 }
 423
 424 static void option_indat_callback(struct urb *urb)
 425 {
 426         int err;
 427         int endpoint;
 428         struct usb_serial_port *port;
 429         struct tty_struct *tty;
 430         unsigned char *data = urb->transfer_buffer;
 431         int status = urb->status;
 432
 433         dbg("%s: %p", __FUNCTION__, urb);
 434
 435         endpoint = usb_pipeendpoint(urb->pipe);
 436         port = (struct usb_serial_port *) urb->context;
 437
 438         if (status) {
 439                 dbg("%s: nonzero status: %d on endpoint %02x.",
 440                     __FUNCTION__, status, endpoint);
 441         } else {
 442                 tty = port->tty;
 443                 if (urb->actual_length) {
 444                         tty_buffer_request_room(tty, urb->actual_length);
 445                         tty_insert_flip_string(tty, data, urb->actual_length);
 446                         tty_flip_buffer_push(tty);
 447                 } else {
 448                         dbg("%s: empty read urb received", __FUNCTION__);
 449                 }
 450
 451                 /* Resubmit urb so we continue receiving */
 452                 if (port->open_count && status != -ESHUTDOWN) {
 453                         err = usb_submit_urb(urb, GFP_ATOMIC);
 454                         if (err)
 455                                 printk(KERN_ERR "%s: resubmit read urb failed. "
 456                                         "(%d)", __FUNCTION__, err);
 457                 }
 458         }
 459         return;
 460 }
 461
 462 static void option_outdat_callback(struct urb *urb)
 463 {
 464         struct usb_serial_port *port;
 465         struct option_port_private *portdata;
 466         int i;
 467
 468         dbg("%s", __FUNCTION__);
 469
 470         port = (struct usb_serial_port *) urb->context;
 471
 472         usb_serial_port_softint(port);
 473
 474         portdata = usb_get_serial_port_data(port);
 475         for (i = 0; i < N_OUT_URB; ++i) {
 476                 if (portdata->out_urbs[i] == urb) {
 477                         smp_mb__before_clear_bit();
 478                         clear_bit(i, &portdata->out_busy);
 479                         break;
 480                 }
 481         }
 482 }
 483
 484 static void option_instat_callback(struct urb *urb)
 485 {
 486         int err;
 487         int status = urb->status;
 488         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 489         struct option_port_private *portdata = usb_get_serial_port_data(port);
 490         struct usb_serial *serial = port->serial;
 491
 492         dbg("%s", __FUNCTION__);
 493         dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
 494
 495         if (status == 0) {
 496                 struct usb_ctrlrequest *req_pkt =
 497                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
 498
 499                 if (!req_pkt) {
 500                         dbg("%s: NULL req_pkt\n", __FUNCTION__);
 501                         return;
 502                 }
 503                 if ((req_pkt->bRequestType == 0xA1) &&
 504                                 (req_pkt->bRequest == 0x20)) {
 505                         int old_dcd_state;
 506                         unsigned char signals = *((unsigned char *)
 507                                         urb->transfer_buffer +
 508                                         sizeof(struct usb_ctrlrequest));
 509
 510                         dbg("%s: signal x%x", __FUNCTION__, signals);
 511
 512                         old_dcd_state = portdata->dcd_state;
 513                         portdata->cts_state = 1;
 514                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
 515                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
 516                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
 517
 518                         if (port->tty && !C_CLOCAL(port->tty) &&
 519                                         old_dcd_state && !portdata->dcd_state)
 520                                 tty_hangup(port->tty);
 521                 } else {
 522                         dbg("%s: type %x req %x", __FUNCTION__,
 523                                 req_pkt->bRequestType,req_pkt->bRequest);
 524                 }
 525         } else
 526                 dbg("%s: error %d", __FUNCTION__, status);
 527
 528         /* Resubmit urb so we continue receiving IRQ data */
 529         if (status != -ESHUTDOWN) {
 530                 urb->dev = serial->dev;
 531                 err = usb_submit_urb(urb, GFP_ATOMIC);
 532                 if (err)
 533                         dbg("%s: resubmit intr urb failed. (%d)",
 534                                 __FUNCTION__, err);
 535         }
 536 }
 537
 538 static int option_write_room(struct usb_serial_port *port)
 539 {
 540         struct option_port_private *portdata;
 541         int i;
 542         int data_len = 0;
 543         struct urb *this_urb;
 544
 545         portdata = usb_get_serial_port_data(port);
 546
 547         for (i=0; i < N_OUT_URB; i++) {
 548                 this_urb = portdata->out_urbs[i];
 549                 if (this_urb && !test_bit(i, &portdata->out_busy))
 550                         data_len += OUT_BUFLEN;
 551         }
 552
 553         dbg("%s: %d", __FUNCTION__, data_len);
 554         return data_len;
 555 }
 556
 557 static int option_chars_in_buffer(struct usb_serial_port *port)
 558 {
 559         struct option_port_private *portdata;
 560         int i;
 561         int data_len = 0;
 562         struct urb *this_urb;
 563
 564         portdata = usb_get_serial_port_data(port);
 565
 566         for (i=0; i < N_OUT_URB; i++) {
 567                 this_urb = portdata->out_urbs[i];
 568                 if (this_urb && test_bit(i, &portdata->out_busy))
 569                         data_len += this_urb->transfer_buffer_length;
 570         }
 571         dbg("%s: %d", __FUNCTION__, data_len);
 572         return data_len;
 573 }
 574
 575 static int option_open(struct usb_serial_port *port, struct file *filp)
 576 {
 577         struct option_port_private *portdata;
 578         struct usb_serial *serial = port->serial;
 579         int i, err;
 580         struct urb *urb;
 581
 582         portdata = usb_get_serial_port_data(port);
 583
 584         dbg("%s", __FUNCTION__);
 585
 586         /* Set some sane defaults */
 587         portdata->rts_state = 1;
 588         portdata->dtr_state = 1;
 589
 590         /* Reset low level data toggle and start reading from endpoints */
 591         for (i = 0; i < N_IN_URB; i++) {
 592                 urb = portdata->in_urbs[i];
 593                 if (! urb)
 594                         continue;
 595                 if (urb->dev != serial->dev) {
 596                         dbg("%s: dev %p != %p", __FUNCTION__,
 597                                 urb->dev, serial->dev);
 598                         continue;
 599                 }
 600
 601                 /*
 602                  * make sure endpoint data toggle is synchronized with the
 603                  * device
 604                  */
 605                 usb_clear_halt(urb->dev, urb->pipe);
 606
 607                 err = usb_submit_urb(urb, GFP_KERNEL);
 608                 if (err) {
 609                         dbg("%s: submit urb %d failed (%d) %d",
 610                                 __FUNCTION__, i, err,
 611                                 urb->transfer_buffer_length);
 612                 }
 613         }
 614
 615         /* Reset low level data toggle on out endpoints */
 616         for (i = 0; i < N_OUT_URB; i++) {
 617                 urb = portdata->out_urbs[i];
 618                 if (! urb)
 619                         continue;
 620                 urb->dev = serial->dev;
 621                 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
 622                                 usb_pipeout(urb->pipe), 0); */
 623         }
 624
 625         port->tty->low_latency = 1;
 626
 627         option_send_setup(port);
 628
 629         return (0);
 630 }
 631
 632 static void option_close(struct usb_serial_port *port, struct file *filp)
 633 {
 634         int i;
 635         struct usb_serial *serial = port->serial;
 636         struct option_port_private *portdata;
 637
 638         dbg("%s", __FUNCTION__);
 639         portdata = usb_get_serial_port_data(port);
 640
 641         portdata->rts_state = 0;
 642         portdata->dtr_state = 0;
 643
 644         if (serial->dev) {
 645                 mutex_lock(&serial->disc_mutex);
 646                 if (!serial->disconnected)
 647                         option_send_setup(port);
 648                 mutex_unlock(&serial->disc_mutex);
 649
 650                 /* Stop reading/writing urbs */
 651                 for (i = 0; i < N_IN_URB; i++)
 652                         usb_kill_urb(portdata->in_urbs[i]);
 653                 for (i = 0; i < N_OUT_URB; i++)
 654                         usb_kill_urb(portdata->out_urbs[i]);
 655         }
 656         port->tty = NULL;
 657 }
 658
 659 /* Helper functions used by option_setup_urbs */
 660 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
 661                 int dir, void *ctx, char *buf, int len,
 662                 void (*callback)(struct urb *))
 663 {
 664         struct urb *urb;
 665
 666         if (endpoint == -1)
 667                 return NULL;            /* endpoint not needed */
 668
 669         urb = usb_alloc_urb(0, GFP_KERNEL);             /* No ISO */
 670         if (urb == NULL) {
 671                 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
 672                 return NULL;
 673         }
 674
 675                 /* Fill URB using supplied data. */
 676         usb_fill_bulk_urb(urb, serial->dev,
 677                       usb_sndbulkpipe(serial->dev, endpoint) | dir,
 678                       buf, len, callback, ctx);
 679
 680         return urb;
 681 }
 682
 683 /* Setup urbs */
 684 static void option_setup_urbs(struct usb_serial *serial)
 685 {
 686         int i,j;
 687         struct usb_serial_port *port;
 688         struct option_port_private *portdata;
 689
 690         dbg("%s", __FUNCTION__);
 691
 692         for (i = 0; i < serial->num_ports; i++) {
 693                 port = serial->port[i];
 694                 portdata = usb_get_serial_port_data(port);
 695
 696         /* Do indat endpoints first */
 697                 for (j = 0; j < N_IN_URB; ++j) {
 698                         portdata->in_urbs[j] = option_setup_urb (serial,
 699                         port->bulk_in_endpointAddress, USB_DIR_IN, port,
 700                         portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
 701                 }
 702
 703                 /* outdat endpoints */
 704                 for (j = 0; j < N_OUT_URB; ++j) {
 705                         portdata->out_urbs[j] = option_setup_urb (serial,
 706                         port->bulk_out_endpointAddress, USB_DIR_OUT, port,
 707                         portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
 708                 }
 709         }
 710 }
 711
 712 static int option_send_setup(struct usb_serial_port *port)
 713 {
 714         struct usb_serial *serial = port->serial;
 715         struct option_port_private *portdata;
 716
 717         dbg("%s", __FUNCTION__);
 718
 719         if (port->number != 0)
 720                 return 0;
 721
 722         portdata = usb_get_serial_port_data(port);
 723
 724         if (port->tty) {
 725                 int val = 0;
 726                 if (portdata->dtr_state)
 727                         val |= 0x01;
 728                 if (portdata->rts_state)
 729                         val |= 0x02;
 730
 731                 return usb_control_msg(serial->dev,
 732                                 usb_rcvctrlpipe(serial->dev, 0),
 733                                 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
 734         }
 735
 736         return 0;
 737 }
 738
 739 static int option_startup(struct usb_serial *serial)
 740 {
 741         int i, j, err;
 742         struct usb_serial_port *port;
 743         struct option_port_private *portdata;
 744         u8 *buffer;
 745
 746         dbg("%s", __FUNCTION__);
 747
 748         /* Now setup per port private data */
 749         for (i = 0; i < serial->num_ports; i++) {
 750                 port = serial->port[i];
 751                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
 752                 if (!portdata) {
 753                         dbg("%s: kmalloc for option_port_private (%d) failed!.",
 754                                         __FUNCTION__, i);
 755                         return (1);
 756                 }
 757
 758                 for (j = 0; j < N_IN_URB; j++) {
 759                         buffer = (u8 *)__get_free_page(GFP_KERNEL);
 760                         if (!buffer)
 761                                 goto bail_out_error;
 762                         portdata->in_buffer[j] = buffer;
 763                 }
 764
 765                 for (j = 0; j < N_OUT_URB; j++) {
 766                         buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
 767                         if (!buffer)
 768                                 goto bail_out_error2;
 769                         portdata->out_buffer[j] = buffer;
 770                 }
 771
 772                 usb_set_serial_port_data(port, portdata);
 773
 774                 if (! port->interrupt_in_urb)
 775                         continue;
 776                 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 777                 if (err)
 778                         dbg("%s: submit irq_in urb failed %d",
 779                                 __FUNCTION__, err);
 780         }
 781
 782         option_setup_urbs(serial);
 783
 784         return (0);
 785
 786 bail_out_error2:
 787         for (j = 0; j < N_OUT_URB; j++)
 788                 kfree(portdata->out_buffer[j]);
 789 bail_out_error:
 790         for (j = 0; j < N_IN_URB; j++)
 791                 if (portdata->in_buffer[j])
 792                         free_page((unsigned long)portdata->in_buffer[j]);
 793         kfree(portdata);
 794         return 1;
 795 }
 796
 797 static void option_shutdown(struct usb_serial *serial)
 798 {
 799         int i, j;
 800         struct usb_serial_port *port;
 801         struct option_port_private *portdata;
 802
 803         dbg("%s", __FUNCTION__);
 804
 805         /* Stop reading/writing urbs */
 806         for (i = 0; i < serial->num_ports; ++i) {
 807                 port = serial->port[i];
 808                 portdata = usb_get_serial_port_data(port);
 809                 for (j = 0; j < N_IN_URB; j++)
 810                         usb_kill_urb(portdata->in_urbs[j]);
 811                 for (j = 0; j < N_OUT_URB; j++)
 812                         usb_kill_urb(portdata->out_urbs[j]);
 813         }
 814
 815         /* Now free them */
 816         for (i = 0; i < serial->num_ports; ++i) {
 817                 port = serial->port[i];
 818                 portdata = usb_get_serial_port_data(port);
 819
 820                 for (j = 0; j < N_IN_URB; j++) {
 821                         if (portdata->in_urbs[j]) {
 822                                 usb_free_urb(portdata->in_urbs[j]);
 823                                 free_page((unsigned long)portdata->in_buffer[j]);
 824                                 portdata->in_urbs[j] = NULL;
 825                         }
 826                 }
 827                 for (j = 0; j < N_OUT_URB; j++) {
 828                         if (portdata->out_urbs[j]) {
 829                                 usb_free_urb(portdata->out_urbs[j]);
 830                                 kfree(portdata->out_buffer[j]);
 831                                 portdata->out_urbs[j] = NULL;
 832                         }
 833                 }
 834         }
 835
 836         /* Now free per port private data */
 837         for (i = 0; i < serial->num_ports; i++) {
 838                 port = serial->port[i];
 839                 kfree(usb_get_serial_port_data(port));
 840         }
 841 }
 842
 843 MODULE_AUTHOR(DRIVER_AUTHOR);
 844 MODULE_DESCRIPTION(DRIVER_DESC);
 845 MODULE_VERSION(DRIVER_VERSION);
 846 MODULE_LICENSE("GPL");
 847
 848 #ifdef CONFIG_USB_DEBUG
 849 module_param(debug, bool, S_IRUGO | S_IWUSR);
 850 MODULE_PARM_DESC(debug, "Debug messages");
 851 #endif
 852