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