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