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