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