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