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