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

   1 /*
   2  * USB HandSpring Visor, Palm m50x, and Sony Clie driver
   3  * (supports all of the Palm OS USB devices)
   4  *
   5  *      Copyright (C) 1999 - 2004
   6  *          Greg Kroah-Hartman (greg@kroah.com)
   7  *
   8  *      This program is free software; you can redistribute it and/or
   9  *      modify it under the terms of the GNU General Public License version
  10  *      2 as published by the Free Software Foundation.
  11  *
  12  * See Documentation/usb/usb-serial.txt for more information on using this driver
  13  *
  14  */
  15
  16 #include <linux/kernel.h>
  17 #include <linux/errno.h>
  18 #include <linux/init.h>
  19 #include <linux/slab.h>
  20 #include <linux/tty.h>
  21 #include <linux/tty_driver.h>
  22 #include <linux/tty_flip.h>
  23 #include <linux/module.h>
  24 #include <linux/moduleparam.h>
  25 #include <linux/spinlock.h>
  26 #include <asm/uaccess.h>
  27 #include <linux/usb.h>
  28 #include <linux/usb/serial.h>
  29 #include "visor.h"
  30
  31 /*
  32  * Version Information
  33  */
  34 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
  35 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
  36
  37 /* function prototypes for a handspring visor */
  38 static int  visor_open          (struct tty_struct *tty, struct usb_serial_port *port, struct file *filp);
  39 static void visor_close         (struct tty_struct *tty, struct usb_serial_port *port, struct file *filp);
  40 static int  visor_write         (struct tty_struct *tty, struct usb_serial_port *port, const unsigned char *buf, int count);
  41 static int  visor_write_room    (struct tty_struct *tty);
  42 static void visor_throttle      (struct tty_struct *tty);
  43 static void visor_unthrottle    (struct tty_struct *tty);
  44 static int  visor_probe         (struct usb_serial *serial, const struct usb_device_id *id);
  45 static int  visor_calc_num_ports(struct usb_serial *serial);
  46 static void visor_shutdown      (struct usb_serial *serial);
  47 static void visor_write_bulk_callback   (struct urb *urb);
  48 static void visor_read_bulk_callback    (struct urb *urb);
  49 static void visor_read_int_callback     (struct urb *urb);
  50 static int  clie_3_5_startup    (struct usb_serial *serial);
  51 static int  treo_attach         (struct usb_serial *serial);
  52 static int clie_5_attach (struct usb_serial *serial);
  53 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id);
  54 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id);
  55
  56 /* Parameters that may be passed into the module. */
  57 static int debug;
  58 static __u16 vendor;
  59 static __u16 product;
  60
  61 static struct usb_device_id id_table [] = {
  62         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
  63                 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
  64         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
  65                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  66         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
  67                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  68         { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
  69                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  70         { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
  71                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  72         { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
  73                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  74         { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
  75                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  76         { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
  77                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  78         { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
  79                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  80         { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
  81                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  82         { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
  83                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  84         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
  85                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  86         { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
  87                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  88         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
  89                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  90         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
  91                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  92         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
  93                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  94         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
  95                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  96         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
  97                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  98         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
  99                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 100         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
 101                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 102         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
 103                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 104         { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
 105                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 106         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
 107                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 108         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
 109                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 110         { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
 111                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 112         { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
 113                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 114         { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
 115                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 116         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
 117                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 118         { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
 119                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 120         { },                                    /* optional parameter entry */
 121         { }                                     /* Terminating entry */
 122 };
 123
 124 static struct usb_device_id clie_id_5_table [] = {
 125         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
 126                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 127         { },                                    /* optional parameter entry */
 128         { }                                     /* Terminating entry */
 129 };
 130
 131 static struct usb_device_id clie_id_3_5_table [] = {
 132         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
 133         { }                                     /* Terminating entry */
 134 };
 135
 136 static struct usb_device_id id_table_combined [] = {
 137         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
 138         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
 139         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
 140         { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
 141         { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
 142         { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
 143         { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
 144         { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
 145         { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
 146         { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
 147         { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
 148         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
 149         { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
 150         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
 151         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
 152         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
 153         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
 154         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
 155         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
 156         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
 157         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
 158         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
 159         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
 160         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
 161         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
 162         { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
 163         { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
 164         { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
 165         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
 166         { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
 167         { },                                    /* optional parameter entry */
 168         { }                                     /* Terminating entry */
 169 };
 170
 171 MODULE_DEVICE_TABLE (usb, id_table_combined);
 172
 173 static struct usb_driver visor_driver = {
 174         .name =         "visor",
 175         .probe =        usb_serial_probe,
 176         .disconnect =   usb_serial_disconnect,
 177         .id_table =     id_table_combined,
 178         .no_dynamic_id =        1,
 179 };
 180
 181 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
 182 static struct usb_serial_driver handspring_device = {
 183         .driver = {
 184                 .owner =        THIS_MODULE,
 185                 .name =         "visor",
 186         },
 187         .description =          "Handspring Visor / Palm OS",
 188         .usb_driver =           &visor_driver,
 189         .id_table =             id_table,
 190         .num_ports =            2,
 191         .open =                 visor_open,
 192         .close =                visor_close,
 193         .throttle =             visor_throttle,
 194         .unthrottle =           visor_unthrottle,
 195         .attach =               treo_attach,
 196         .probe =                visor_probe,
 197         .calc_num_ports =       visor_calc_num_ports,
 198         .shutdown =             visor_shutdown,
 199         .write =                visor_write,
 200         .write_room =           visor_write_room,
 201         .write_bulk_callback =  visor_write_bulk_callback,
 202         .read_bulk_callback =   visor_read_bulk_callback,
 203         .read_int_callback =    visor_read_int_callback,
 204 };
 205
 206 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
 207 static struct usb_serial_driver clie_5_device = {
 208         .driver = {
 209                 .owner =        THIS_MODULE,
 210                 .name =         "clie_5",
 211         },
 212         .description =          "Sony Clie 5.0",
 213         .usb_driver =           &visor_driver,
 214         .id_table =             clie_id_5_table,
 215         .num_ports =            2,
 216         .open =                 visor_open,
 217         .close =                visor_close,
 218         .throttle =             visor_throttle,
 219         .unthrottle =           visor_unthrottle,
 220         .attach =               clie_5_attach,
 221         .probe =                visor_probe,
 222         .calc_num_ports =       visor_calc_num_ports,
 223         .shutdown =             visor_shutdown,
 224         .write =                visor_write,
 225         .write_room =           visor_write_room,
 226         .write_bulk_callback =  visor_write_bulk_callback,
 227         .read_bulk_callback =   visor_read_bulk_callback,
 228         .read_int_callback =    visor_read_int_callback,
 229 };
 230
 231 /* device info for the Sony Clie OS version 3.5 */
 232 static struct usb_serial_driver clie_3_5_device = {
 233         .driver = {
 234                 .owner =        THIS_MODULE,
 235                 .name =         "clie_3.5",
 236         },
 237         .description =          "Sony Clie 3.5",
 238         .usb_driver =           &visor_driver,
 239         .id_table =             clie_id_3_5_table,
 240         .num_ports =            1,
 241         .open =                 visor_open,
 242         .close =                visor_close,
 243         .throttle =             visor_throttle,
 244         .unthrottle =           visor_unthrottle,
 245         .attach =               clie_3_5_startup,
 246         .write =                visor_write,
 247         .write_room =           visor_write_room,
 248         .write_bulk_callback =  visor_write_bulk_callback,
 249         .read_bulk_callback =   visor_read_bulk_callback,
 250 };
 251
 252 struct visor_private {
 253         spinlock_t lock;
 254         int bytes_in;
 255         int bytes_out;
 256         int outstanding_urbs;
 257         unsigned char throttled;
 258         unsigned char actually_throttled;
 259 };
 260
 261 /* number of outstanding urbs to prevent userspace DoS from happening */
 262 #define URB_UPPER_LIMIT 42
 263
 264 static int stats;
 265
 266 /******************************************************************************
 267  * Handspring Visor specific driver functions
 268  ******************************************************************************/
 269 static int visor_open (struct tty_struct *tty, struct usb_serial_port *port, struct file *filp)
 270 {
 271         struct usb_serial *serial = port->serial;
 272         struct visor_private *priv = usb_get_serial_port_data(port);
 273         unsigned long flags;
 274         int result = 0;
 275
 276         dbg("%s - port %d", __func__, port->number);
 277
 278         if (!port->read_urb) {
 279                 /* this is needed for some brain dead Sony devices */
 280                 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
 281                 return -ENODEV;
 282         }
 283
 284         spin_lock_irqsave(&priv->lock, flags);
 285         priv->bytes_in = 0;
 286         priv->bytes_out = 0;
 287         priv->throttled = 0;
 288         spin_unlock_irqrestore(&priv->lock, flags);
 289
 290         /*
 291          * Force low_latency on so that our tty_push actually forces the data
 292          * through, otherwise it is scheduled, and with high data rates (like
 293          * with OHCI) data can get lost.
 294          */
 295         if (tty)
 296                 tty->low_latency = 1;
 297
 298         /* Start reading from the device */
 299         usb_fill_bulk_urb (port->read_urb, serial->dev,
 300                            usb_rcvbulkpipe (serial->dev,
 301                                             port->bulk_in_endpointAddress),
 302                            port->read_urb->transfer_buffer,
 303                            port->read_urb->transfer_buffer_length,
 304                            visor_read_bulk_callback, port);
 305         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 306         if (result) {
 307                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
 308                         __func__, result);
 309                 goto exit;
 310         }
 311
 312         if (port->interrupt_in_urb) {
 313                 dbg("%s - adding interrupt input for treo", __func__);
 314                 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 315                 if (result)
 316                         dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
 317                                 __func__, result);
 318         }
 319 exit:
 320         return result;
 321 }
 322
 323
 324 static void visor_close(struct tty_struct *tty,
 325                         struct usb_serial_port *port, struct file * filp)
 326 {
 327         struct visor_private *priv = usb_get_serial_port_data(port);
 328         unsigned char *transfer_buffer;
 329
 330         dbg("%s - port %d", __func__, port->number);
 331
 332         /* shutdown our urbs */
 333         usb_kill_urb(port->read_urb);
 334         usb_kill_urb(port->interrupt_in_urb);
 335
 336         mutex_lock(&port->serial->disc_mutex);
 337         if (!port->serial->disconnected) {
 338                 /* Try to send shutdown message, unless the device is gone */
 339                 transfer_buffer =  kmalloc (0x12, GFP_KERNEL);
 340                 if (transfer_buffer) {
 341                         usb_control_msg (port->serial->dev,
 342                                          usb_rcvctrlpipe(port->serial->dev, 0),
 343                                          VISOR_CLOSE_NOTIFICATION, 0xc2,
 344                                          0x0000, 0x0000,
 345                                          transfer_buffer, 0x12, 300);
 346                         kfree (transfer_buffer);
 347                 }
 348         }
 349         mutex_unlock(&port->serial->disc_mutex);
 350
 351         if (stats)
 352                 dev_info(&port->dev, "Bytes In = %d  Bytes Out = %d\n",
 353                          priv->bytes_in, priv->bytes_out);
 354 }
 355
 356
 357 static int visor_write(struct tty_struct *tty, struct usb_serial_port *port,
 358                                         const unsigned char *buf, int count)
 359 {
 360         struct visor_private *priv = usb_get_serial_port_data(port);
 361         struct usb_serial *serial = port->serial;
 362         struct urb *urb;
 363         unsigned char *buffer;
 364         unsigned long flags;
 365         int status;
 366
 367         dbg("%s - port %d", __func__, port->number);
 368
 369         spin_lock_irqsave(&priv->lock, flags);
 370         if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
 371                 spin_unlock_irqrestore(&priv->lock, flags);
 372                 dbg("%s - write limit hit\n", __func__);
 373                 return 0;
 374         }
 375         priv->outstanding_urbs++;
 376         spin_unlock_irqrestore(&priv->lock, flags);
 377
 378         buffer = kmalloc (count, GFP_ATOMIC);
 379         if (!buffer) {
 380                 dev_err(&port->dev, "out of memory\n");
 381                 count = -ENOMEM;
 382                 goto error_no_buffer;
 383         }
 384
 385         urb = usb_alloc_urb(0, GFP_ATOMIC);
 386         if (!urb) {
 387                 dev_err(&port->dev, "no more free urbs\n");
 388                 count = -ENOMEM;
 389                 goto error_no_urb;
 390         }
 391
 392         memcpy (buffer, buf, count);
 393
 394         usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
 395
 396         usb_fill_bulk_urb (urb, serial->dev,
 397                            usb_sndbulkpipe (serial->dev,
 398                                             port->bulk_out_endpointAddress),
 399                            buffer, count,
 400                            visor_write_bulk_callback, port);
 401
 402         /* send it down the pipe */
 403         status = usb_submit_urb(urb, GFP_ATOMIC);
 404         if (status) {
 405                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
 406                         __func__, status);
 407                 count = status;
 408                 goto error;
 409         } else {
 410                 spin_lock_irqsave(&priv->lock, flags);
 411                 priv->bytes_out += count;
 412                 spin_unlock_irqrestore(&priv->lock, flags);
 413         }
 414
 415         /* we are done with this urb, so let the host driver
 416          * really free it when it is finished with it */
 417         usb_free_urb(urb);
 418
 419         return count;
 420 error:
 421         usb_free_urb(urb);
 422 error_no_urb:
 423         kfree(buffer);
 424 error_no_buffer:
 425         spin_lock_irqsave(&priv->lock, flags);
 426         --priv->outstanding_urbs;
 427         spin_unlock_irqrestore(&priv->lock, flags);
 428         return count;
 429 }
 430
 431
 432 static int visor_write_room (struct tty_struct *tty)
 433 {
 434         struct usb_serial_port *port = tty->driver_data;
 435         struct visor_private *priv = usb_get_serial_port_data(port);
 436         unsigned long flags;
 437
 438         dbg("%s - port %d", __func__, port->number);
 439
 440         /*
 441          * We really can take anything the user throws at us
 442          * but let's pick a nice big number to tell the tty
 443          * layer that we have lots of free space, unless we don't.
 444          */
 445
 446         spin_lock_irqsave(&priv->lock, flags);
 447         if (priv->outstanding_urbs > URB_UPPER_LIMIT * 2 / 3) {
 448                 spin_unlock_irqrestore(&priv->lock, flags);
 449                 dbg("%s - write limit hit\n", __func__);
 450                 return 0;
 451         }
 452         spin_unlock_irqrestore(&priv->lock, flags);
 453
 454         return 2048;
 455 }
 456
 457
 458 static void visor_write_bulk_callback (struct urb *urb)
 459 {
 460         struct usb_serial_port *port = urb->context;
 461         struct visor_private *priv = usb_get_serial_port_data(port);
 462         int status = urb->status;
 463         unsigned long flags;
 464
 465         /* free up the transfer buffer, as usb_free_urb() does not do this */
 466         kfree (urb->transfer_buffer);
 467
 468         dbg("%s - port %d", __func__, port->number);
 469
 470         if (status)
 471                 dbg("%s - nonzero write bulk status received: %d",
 472                     __func__, status);
 473
 474         spin_lock_irqsave(&priv->lock, flags);
 475         --priv->outstanding_urbs;
 476         spin_unlock_irqrestore(&priv->lock, flags);
 477
 478         usb_serial_port_softint(port);
 479 }
 480
 481
 482 static void visor_read_bulk_callback (struct urb *urb)
 483 {
 484         struct usb_serial_port *port = urb->context;
 485         struct visor_private *priv = usb_get_serial_port_data(port);
 486         unsigned char *data = urb->transfer_buffer;
 487         int status = urb->status;
 488         struct tty_struct *tty;
 489         int result;
 490         int available_room;
 491
 492         dbg("%s - port %d", __func__, port->number);
 493
 494         if (status) {
 495                 dbg("%s - nonzero read bulk status received: %d",
 496                     __func__, status);
 497                 return;
 498         }
 499
 500         usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length, data);
 501
 502         tty = port->port.tty;
 503         if (tty && urb->actual_length) {
 504                 available_room = tty_buffer_request_room(tty, urb->actual_length);
 505                 if (available_room) {
 506                         tty_insert_flip_string(tty, data, available_room);
 507                         tty_flip_buffer_push(tty);
 508                 }
 509                 spin_lock(&priv->lock);
 510                 priv->bytes_in += available_room;
 511
 512         } else {
 513                 spin_lock(&priv->lock);
 514         }
 515
 516         /* Continue trying to always read if we should */
 517         if (!priv->throttled) {
 518                 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
 519                                    usb_rcvbulkpipe(port->serial->dev,
 520                                                    port->bulk_in_endpointAddress),
 521                                    port->read_urb->transfer_buffer,
 522                                    port->read_urb->transfer_buffer_length,
 523                                    visor_read_bulk_callback, port);
 524                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 525                 if (result)
 526                         dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __func__, result);
 527         } else {
 528                 priv->actually_throttled = 1;
 529         }
 530         spin_unlock(&priv->lock);
 531 }
 532
 533 static void visor_read_int_callback (struct urb *urb)
 534 {
 535         struct usb_serial_port *port = urb->context;
 536         int status = urb->status;
 537         int result;
 538
 539         switch (status) {
 540         case 0:
 541                 /* success */
 542                 break;
 543         case -ECONNRESET:
 544         case -ENOENT:
 545         case -ESHUTDOWN:
 546                 /* this urb is terminated, clean up */
 547                 dbg("%s - urb shutting down with status: %d",
 548                     __func__, status);
 549                 return;
 550         default:
 551                 dbg("%s - nonzero urb status received: %d",
 552                     __func__, status);
 553                 goto exit;
 554         }
 555
 556         /*
 557          * This information is still unknown what it can be used for.
 558          * If anyone has an idea, please let the author know...
 559          *
 560          * Rumor has it this endpoint is used to notify when data
 561          * is ready to be read from the bulk ones.
 562          */
 563         usb_serial_debug_data(debug, &port->dev, __func__,
 564                               urb->actual_length, urb->transfer_buffer);
 565
 566 exit:
 567         result = usb_submit_urb (urb, GFP_ATOMIC);
 568         if (result)
 569                 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
 570                         __func__, result);
 571 }
 572
 573 static void visor_throttle (struct tty_struct *tty)
 574 {
 575         struct usb_serial_port *port = tty->driver_data;
 576         struct visor_private *priv = usb_get_serial_port_data(port);
 577         unsigned long flags;
 578
 579         dbg("%s - port %d", __func__, port->number);
 580         spin_lock_irqsave(&priv->lock, flags);
 581         priv->throttled = 1;
 582         spin_unlock_irqrestore(&priv->lock, flags);
 583 }
 584
 585
 586 static void visor_unthrottle (struct tty_struct *tty)
 587 {
 588         struct usb_serial_port *port = tty->driver_data;
 589         struct visor_private *priv = usb_get_serial_port_data(port);
 590         unsigned long flags;
 591         int result;
 592
 593         dbg("%s - port %d", __func__, port->number);
 594         spin_lock_irqsave(&priv->lock, flags);
 595         priv->throttled = 0;
 596         priv->actually_throttled = 0;
 597         spin_unlock_irqrestore(&priv->lock, flags);
 598
 599         port->read_urb->dev = port->serial->dev;
 600         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 601         if (result)
 602                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __func__, result);
 603 }
 604
 605 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
 606 {
 607         struct device *dev = &serial->dev->dev;
 608         struct visor_connection_info *connection_info;
 609         unsigned char *transfer_buffer;
 610         char *string;
 611         int retval = 0;
 612         int i;
 613         int num_ports = 0;
 614
 615         dbg("%s", __func__);
 616
 617         transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
 618         if (!transfer_buffer) {
 619                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 620                         sizeof(*connection_info));
 621                 return -ENOMEM;
 622         }
 623
 624         /* send a get connection info request */
 625         retval = usb_control_msg (serial->dev,
 626                                   usb_rcvctrlpipe(serial->dev, 0),
 627                                   VISOR_GET_CONNECTION_INFORMATION,
 628                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 629                                   sizeof(*connection_info), 300);
 630         if (retval < 0) {
 631                 dev_err(dev, "%s - error %d getting connection information\n",
 632                         __func__, retval);
 633                 goto exit;
 634         }
 635
 636         if (retval == sizeof(*connection_info)) {
 637                 connection_info = (struct visor_connection_info *)transfer_buffer;
 638
 639                 num_ports = le16_to_cpu(connection_info->num_ports);
 640                 for (i = 0; i < num_ports; ++i) {
 641                         switch (connection_info->connections[i].port_function_id) {
 642                                 case VISOR_FUNCTION_GENERIC:
 643                                         string = "Generic";
 644                                         break;
 645                                 case VISOR_FUNCTION_DEBUGGER:
 646                                         string = "Debugger";
 647                                         break;
 648                                 case VISOR_FUNCTION_HOTSYNC:
 649                                         string = "HotSync";
 650                                         break;
 651                                 case VISOR_FUNCTION_CONSOLE:
 652                                         string = "Console";
 653                                         break;
 654                                 case VISOR_FUNCTION_REMOTE_FILE_SYS:
 655                                         string = "Remote File System";
 656                                         break;
 657                                 default:
 658                                         string = "unknown";
 659                                         break;
 660                         }
 661                         dev_info(dev, "%s: port %d, is for %s use\n",
 662                                 serial->type->description,
 663                                 connection_info->connections[i].port, string);
 664                 }
 665         }
 666         /*
 667         * Handle devices that report invalid stuff here.
 668         */
 669         if (num_ports == 0 || num_ports > 2) {
 670                 dev_warn (dev, "%s: No valid connect info available\n",
 671                         serial->type->description);
 672                 num_ports = 2;
 673         }
 674
 675         dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
 676                 num_ports);
 677
 678         /*
 679          * save off our num_ports info so that we can use it in the
 680          * calc_num_ports callback
 681          */
 682         usb_set_serial_data(serial, (void *)(long)num_ports);
 683
 684         /* ask for the number of bytes available, but ignore the response as it is broken */
 685         retval = usb_control_msg (serial->dev,
 686                                   usb_rcvctrlpipe(serial->dev, 0),
 687                                   VISOR_REQUEST_BYTES_AVAILABLE,
 688                                   0xc2, 0x0000, 0x0005, transfer_buffer,
 689                                   0x02, 300);
 690         if (retval < 0)
 691                 dev_err(dev, "%s - error %d getting bytes available request\n",
 692                         __func__, retval);
 693         retval = 0;
 694
 695 exit:
 696         kfree (transfer_buffer);
 697
 698         return retval;
 699 }
 700
 701 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
 702 {
 703         struct device *dev = &serial->dev->dev;
 704         struct palm_ext_connection_info *connection_info;
 705         unsigned char *transfer_buffer;
 706         int retval;
 707
 708         dbg("%s", __func__);
 709
 710         transfer_buffer =  kmalloc (sizeof (*connection_info), GFP_KERNEL);
 711         if (!transfer_buffer) {
 712                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 713                         sizeof(*connection_info));
 714                 return -ENOMEM;
 715         }
 716
 717         retval = usb_control_msg (serial->dev,
 718                                   usb_rcvctrlpipe(serial->dev, 0),
 719                                   PALM_GET_EXT_CONNECTION_INFORMATION,
 720                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 721                                   sizeof (*connection_info), 300);
 722         if (retval < 0)
 723                 dev_err(dev, "%s - error %d getting connection info\n",
 724                         __func__, retval);
 725         else
 726                 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
 727                                       retval, transfer_buffer);
 728
 729         kfree (transfer_buffer);
 730         return 0;
 731 }
 732
 733
 734 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
 735 {
 736         int retval = 0;
 737         int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
 738
 739         dbg("%s", __func__);
 740
 741         if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
 742                 err("active config #%d != 1 ??",
 743                         serial->dev->actconfig->desc.bConfigurationValue);
 744                 return -ENODEV;
 745         }
 746
 747         if (id->driver_info) {
 748                 startup = (void *)id->driver_info;
 749                 retval = startup(serial, id);
 750         }
 751
 752         return retval;
 753 }
 754
 755 static int visor_calc_num_ports (struct usb_serial *serial)
 756 {
 757         int num_ports = (int)(long)(usb_get_serial_data(serial));
 758
 759         if (num_ports)
 760                 usb_set_serial_data(serial, NULL);
 761
 762         return num_ports;
 763 }
 764
 765 static int generic_startup(struct usb_serial *serial)
 766 {
 767         struct usb_serial_port **ports = serial->port;
 768         struct visor_private *priv;
 769         int i;
 770
 771         for (i = 0; i < serial->num_ports; ++i) {
 772                 priv = kzalloc (sizeof(*priv), GFP_KERNEL);
 773                 if (!priv) {
 774                         while (i-- != 0) {
 775                                 priv = usb_get_serial_port_data(ports[i]);
 776                                 usb_set_serial_port_data(ports[i], NULL);
 777                                 kfree(priv);
 778                         }
 779                         return -ENOMEM;
 780                 }
 781                 spin_lock_init(&priv->lock);
 782                 usb_set_serial_port_data(ports[i], priv);
 783         }
 784         return 0;
 785 }
 786
 787 static int clie_3_5_startup (struct usb_serial *serial)
 788 {
 789         struct device *dev = &serial->dev->dev;
 790         int result;
 791         u8 data;
 792
 793         dbg("%s", __func__);
 794
 795         /*
 796          * Note that PEG-300 series devices expect the following two calls.
 797          */
 798
 799         /* get the config number */
 800         result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 801                                   USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
 802                                   0, 0, &data, 1, 3000);
 803         if (result < 0) {
 804                 dev_err(dev, "%s: get config number failed: %d\n", __func__, result);
 805                 return result;
 806         }
 807         if (result != 1) {
 808                 dev_err(dev, "%s: get config number bad return length: %d\n", __func__, result);
 809                 return -EIO;
 810         }
 811
 812         /* get the interface number */
 813         result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 814                                   USB_REQ_GET_INTERFACE,
 815                                   USB_DIR_IN | USB_RECIP_INTERFACE,
 816                                   0, 0, &data, 1, 3000);
 817         if (result < 0) {
 818                 dev_err(dev, "%s: get interface number failed: %d\n", __func__, result);
 819                 return result;
 820         }
 821         if (result != 1) {
 822                 dev_err(dev, "%s: get interface number bad return length: %d\n", __func__, result);
 823                 return -EIO;
 824         }
 825
 826         return generic_startup(serial);
 827 }
 828
 829 static int treo_attach (struct usb_serial *serial)
 830 {
 831         struct usb_serial_port *swap_port;
 832
 833         /* Only do this endpoint hack for the Handspring devices with
 834          * interrupt in endpoints, which for now are the Treo devices. */
 835         if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
 836               (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
 837             (serial->num_interrupt_in == 0))
 838                 goto generic_startup;
 839
 840         dbg("%s", __func__);
 841
 842         /*
 843         * It appears that Treos and Kyoceras want to use the
 844         * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
 845         * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
 846         * Note that swapping the bulk out endpoints would break lots of
 847         * apps that want to communicate on the second port.
 848         */
 849 #define COPY_PORT(dest, src)                                            \
 850         dest->read_urb = src->read_urb;                                 \
 851         dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;   \
 852         dest->bulk_in_buffer = src->bulk_in_buffer;                     \
 853         dest->interrupt_in_urb = src->interrupt_in_urb;                 \
 854         dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
 855         dest->interrupt_in_buffer = src->interrupt_in_buffer;
 856
 857         swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
 858         if (!swap_port)
 859                 return -ENOMEM;
 860         COPY_PORT(swap_port, serial->port[0]);
 861         COPY_PORT(serial->port[0], serial->port[1]);
 862         COPY_PORT(serial->port[1], swap_port);
 863         kfree(swap_port);
 864
 865 generic_startup:
 866         return generic_startup(serial);
 867 }
 868
 869 static int clie_5_attach (struct usb_serial *serial)
 870 {
 871         dbg("%s", __func__);
 872
 873         /* TH55 registers 2 ports.
 874            Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
 875            Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
 876
 877            Lets do a quick and dirty mapping
 878          */
 879
 880         /* some sanity check */
 881         if (serial->num_ports < 2)
 882                 return -1;
 883
 884         /* port 0 now uses the modified endpoint Address */
 885         serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
 886
 887         return generic_startup(serial);
 888 }
 889
 890 static void visor_shutdown (struct usb_serial *serial)
 891 {
 892         struct visor_private *priv;
 893         int i;
 894
 895         dbg("%s", __func__);
 896
 897         for (i = 0; i < serial->num_ports; i++) {
 898                 priv = usb_get_serial_port_data(serial->port[i]);
 899                 if (priv) {
 900                         usb_set_serial_port_data(serial->port[i], NULL);
 901                         kfree(priv);
 902                 }
 903         }
 904 }
 905
 906 static int __init visor_init (void)
 907 {
 908         int i, retval;
 909         /* Only if parameters were passed to us */
 910         if ((vendor>0) && (product>0)) {
 911                 struct usb_device_id usb_dev_temp[]=
 912                         {{USB_DEVICE(vendor, product),
 913                         .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
 914
 915                 /* Find the last entry in id_table */
 916                 for (i=0; ; i++) {
 917                         if (id_table[i].idVendor==0) {
 918                                 id_table[i] = usb_dev_temp[0];
 919                                 break;
 920                         }
 921                 }
 922                 /* Find the last entry in id_table_combined */
 923                 for (i=0; ; i++) {
 924                         if (id_table_combined[i].idVendor==0) {
 925                                 id_table_combined[i] = usb_dev_temp[0];
 926                                 break;
 927                         }
 928                 }
 929                 info("Untested USB device specified at time of module insertion");
 930                 info("Warning: This is not guaranteed to work");
 931                 info("Using a newer kernel is preferred to this method");
 932                 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
 933                         vendor, product);
 934         }
 935         retval = usb_serial_register(&handspring_device);
 936         if (retval)
 937                 goto failed_handspring_register;
 938         retval = usb_serial_register(&clie_3_5_device);
 939         if (retval)
 940                 goto failed_clie_3_5_register;
 941         retval = usb_serial_register(&clie_5_device);
 942         if (retval)
 943                 goto failed_clie_5_register;
 944         retval = usb_register(&visor_driver);
 945         if (retval)
 946                 goto failed_usb_register;
 947         info(DRIVER_DESC);
 948
 949         return 0;
 950 failed_usb_register:
 951         usb_serial_deregister(&clie_5_device);
 952 failed_clie_5_register:
 953         usb_serial_deregister(&clie_3_5_device);
 954 failed_clie_3_5_register:
 955         usb_serial_deregister(&handspring_device);
 956 failed_handspring_register:
 957         return retval;
 958 }
 959
 960
 961 static void __exit visor_exit (void)
 962 {
 963         usb_deregister (&visor_driver);
 964         usb_serial_deregister (&handspring_device);
 965         usb_serial_deregister (&clie_3_5_device);
 966         usb_serial_deregister (&clie_5_device);
 967 }
 968
 969
 970 module_init(visor_init);
 971 module_exit(visor_exit);
 972
 973 MODULE_AUTHOR( DRIVER_AUTHOR );
 974 MODULE_DESCRIPTION( DRIVER_DESC );
 975 MODULE_LICENSE("GPL");
 976
 977 module_param(debug, bool, S_IRUGO | S_IWUSR);
 978 MODULE_PARM_DESC(debug, "Debug enabled or not");
 979 module_param(stats, bool, S_IRUGO | S_IWUSR);
 980 MODULE_PARM_DESC(stats, "Enables statistics or not");
 981
 982 module_param(vendor, ushort, 0);
 983 MODULE_PARM_DESC(vendor, "User specified vendor ID");
 984 module_param(product, ushort, 0);
 985 MODULE_PARM_DESC(product, "User specified product ID");
 986