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