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