drivers/usb/serial/visor.c

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