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