drivers/usb/serial/visor.c

   1 /*
   2  * USB HandSpring Visor, Palm m50x, and Sony Clie driver
   3  * (supports all of the Palm OS USB devices)
   4  *
   5  *      Copyright (C) 1999 - 2004
   6  *          Greg Kroah-Hartman (greg@kroah.com)
   7  *
   8  *      This program is free software; you can redistribute it and/or
   9  *      modify it under the terms of the GNU General Public License version
  10  *      2 as published by the Free Software Foundation.
  11  *
  12  * See Documentation/usb/usb-serial.txt for more information on using this
  13  * driver
  14  *
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/errno.h>
  19 #include <linux/init.h>
  20 #include <linux/slab.h>
  21 #include <linux/tty.h>
  22 #include <linux/tty_driver.h>
  23 #include <linux/tty_flip.h>
  24 #include <linux/module.h>
  25 #include <linux/moduleparam.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/uaccess.h>
  28 #include <linux/usb.h>
  29 #include <linux/usb/serial.h>
  30 #include "visor.h"
  31
  32 /*
  33  * Version Information
  34  */
  35 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
  36 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
  37
  38 /* function prototypes for a handspring visor */
  39 static int  visor_open(struct tty_struct *tty, struct usb_serial_port *port);
  40 static void visor_close(struct usb_serial_port *port);
  41 static int  visor_probe(struct usb_serial *serial,
  42                                         const struct usb_device_id *id);
  43 static int  visor_calc_num_ports(struct usb_serial *serial);
  44 static void visor_read_int_callback(struct urb *urb);
  45 static int  clie_3_5_startup(struct usb_serial *serial);
  46 static int  treo_attach(struct usb_serial *serial);
  47 static int clie_5_attach(struct usb_serial *serial);
  48 static int palm_os_3_probe(struct usb_serial *serial,
  49                                         const struct usb_device_id *id);
  50 static int palm_os_4_probe(struct usb_serial *serial,
  51                                         const struct usb_device_id *id);
  52
  53 /* Parameters that may be passed into the module. */
  54 static int debug;
  55 static __u16 vendor;
  56 static __u16 product;
  57
  58 static struct usb_device_id id_table [] = {
  59         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
  60                 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
  61         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
  62                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  63         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
  64                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  65         { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
  66                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  67         { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
  68                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  69         { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
  70                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  71         { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
  72                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  73         { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
  74                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  75         { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
  76                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  77         { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
  78                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  79         { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
  80                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  81         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
  82                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  83         { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
  84                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  85         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
  86                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  87         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
  88                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  89         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
  90                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  91         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
  92                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  93         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
  94                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  95         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
  96                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  97         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
  98                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
  99         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
 100                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 101         { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
 102                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 103         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
 104                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 105         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
 106                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 107         { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
 108                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 109         { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
 110                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 111         { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
 112                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 113         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
 114                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 115         { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
 116                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 117         { },                                    /* optional parameter entry */
 118         { }                                     /* Terminating entry */
 119 };
 120
 121 static struct usb_device_id clie_id_5_table [] = {
 122         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
 123                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
 124         { },                                    /* optional parameter entry */
 125         { }                                     /* Terminating entry */
 126 };
 127
 128 static struct usb_device_id clie_id_3_5_table [] = {
 129         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
 130         { }                                     /* Terminating entry */
 131 };
 132
 133 static struct usb_device_id id_table_combined [] = {
 134         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
 135         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
 136         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
 137         { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
 138         { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
 139         { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
 140         { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
 141         { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
 142         { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
 143         { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
 144         { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
 145         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
 146         { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
 147         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
 148         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
 149         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
 150         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
 151         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
 152         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
 153         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
 154         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
 155         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
 156         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
 157         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
 158         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
 159         { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
 160         { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
 161         { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
 162         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
 163         { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
 164         { },                                    /* optional parameter entry */
 165         { }                                     /* Terminating entry */
 166 };
 167
 168 MODULE_DEVICE_TABLE(usb, id_table_combined);
 169
 170 static struct usb_driver visor_driver = {
 171         .name =         "visor",
 172         .probe =        usb_serial_probe,
 173         .disconnect =   usb_serial_disconnect,
 174         .id_table =     id_table_combined,
 175         .no_dynamic_id =        1,
 176 };
 177
 178 /* All of the device info needed for the Handspring Visor,
 179    and Palm 4.0 devices */
 180 static struct usb_serial_driver handspring_device = {
 181         .driver = {
 182                 .owner =        THIS_MODULE,
 183                 .name =         "visor",
 184         },
 185         .description =          "Handspring Visor / Palm OS",
 186         .usb_driver =           &visor_driver,
 187         .id_table =             id_table,
 188         .num_ports =            2,
 189         .open =                 visor_open,
 190         .close =                visor_close,
 191         .throttle =             usb_serial_generic_throttle,
 192         .unthrottle =           usb_serial_generic_unthrottle,
 193         .attach =               treo_attach,
 194         .probe =                visor_probe,
 195         .calc_num_ports =       visor_calc_num_ports,
 196         .read_int_callback =    visor_read_int_callback,
 197 };
 198
 199 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
 200 static struct usb_serial_driver clie_5_device = {
 201         .driver = {
 202                 .owner =        THIS_MODULE,
 203                 .name =         "clie_5",
 204         },
 205         .description =          "Sony Clie 5.0",
 206         .usb_driver =           &visor_driver,
 207         .id_table =             clie_id_5_table,
 208         .num_ports =            2,
 209         .open =                 visor_open,
 210         .close =                visor_close,
 211         .throttle =             usb_serial_generic_throttle,
 212         .unthrottle =           usb_serial_generic_unthrottle,
 213         .attach =               clie_5_attach,
 214         .probe =                visor_probe,
 215         .calc_num_ports =       visor_calc_num_ports,
 216         .read_int_callback =    visor_read_int_callback,
 217 };
 218
 219 /* device info for the Sony Clie OS version 3.5 */
 220 static struct usb_serial_driver clie_3_5_device = {
 221         .driver = {
 222                 .owner =        THIS_MODULE,
 223                 .name =         "clie_3.5",
 224         },
 225         .description =          "Sony Clie 3.5",
 226         .usb_driver =           &visor_driver,
 227         .id_table =             clie_id_3_5_table,
 228         .num_ports =            1,
 229         .open =                 visor_open,
 230         .close =                visor_close,
 231         .throttle =             usb_serial_generic_throttle,
 232         .unthrottle =           usb_serial_generic_unthrottle,
 233         .attach =               clie_3_5_startup,
 234 };
 235
 236 /******************************************************************************
 237  * Handspring Visor specific driver functions
 238  ******************************************************************************/
 239 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
 240 {
 241         int result = 0;
 242
 243         dbg("%s - port %d", __func__, port->number);
 244
 245         if (!port->read_urb) {
 246                 /* this is needed for some brain dead Sony devices */
 247                 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
 248                 return -ENODEV;
 249         }
 250
 251         /* Start reading from the device */
 252         result = usb_serial_generic_open(tty, port);
 253         if (result)
 254                 goto exit;
 255
 256         if (port->interrupt_in_urb) {
 257                 dbg("%s - adding interrupt input for treo", __func__);
 258                 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 259                 if (result)
 260                         dev_err(&port->dev,
 261                             "%s - failed submitting interrupt urb, error %d\n",
 262                                                         __func__, result);
 263         }
 264 exit:
 265         return result;
 266 }
 267
 268
 269 static void visor_close(struct usb_serial_port *port)
 270 {
 271         unsigned char *transfer_buffer;
 272
 273         dbg("%s - port %d", __func__, port->number);
 274
 275         /* shutdown our urbs */
 276         usb_serial_generic_close(port);
 277         usb_kill_urb(port->interrupt_in_urb);
 278
 279         mutex_lock(&port->serial->disc_mutex);
 280         if (!port->serial->disconnected) {
 281                 /* Try to send shutdown message, unless the device is gone */
 282                 transfer_buffer =  kmalloc(0x12, GFP_KERNEL);
 283                 if (transfer_buffer) {
 284                         usb_control_msg(port->serial->dev,
 285                                          usb_rcvctrlpipe(port->serial->dev, 0),
 286                                          VISOR_CLOSE_NOTIFICATION, 0xc2,
 287                                          0x0000, 0x0000,
 288                                          transfer_buffer, 0x12, 300);
 289                         kfree(transfer_buffer);
 290                 }
 291         }
 292         mutex_unlock(&port->serial->disc_mutex);
 293 }
 294
 295 static void visor_read_int_callback(struct urb *urb)
 296 {
 297         struct usb_serial_port *port = urb->context;
 298         int status = urb->status;
 299         int result;
 300
 301         switch (status) {
 302         case 0:
 303                 /* success */
 304                 break;
 305         case -ECONNRESET:
 306         case -ENOENT:
 307         case -ESHUTDOWN:
 308                 /* this urb is terminated, clean up */
 309                 dbg("%s - urb shutting down with status: %d",
 310                     __func__, status);
 311                 return;
 312         default:
 313                 dbg("%s - nonzero urb status received: %d",
 314                     __func__, status);
 315                 goto exit;
 316         }
 317
 318         /*
 319          * This information is still unknown what it can be used for.
 320          * If anyone has an idea, please let the author know...
 321          *
 322          * Rumor has it this endpoint is used to notify when data
 323          * is ready to be read from the bulk ones.
 324          */
 325         usb_serial_debug_data(debug, &port->dev, __func__,
 326                               urb->actual_length, urb->transfer_buffer);
 327
 328 exit:
 329         result = usb_submit_urb(urb, GFP_ATOMIC);
 330         if (result)
 331                 dev_err(&urb->dev->dev,
 332                                 "%s - Error %d submitting interrupt urb\n",
 333                                                         __func__, result);
 334 }
 335
 336 static int palm_os_3_probe(struct usb_serial *serial,
 337                                                 const struct usb_device_id *id)
 338 {
 339         struct device *dev = &serial->dev->dev;
 340         struct visor_connection_info *connection_info;
 341         unsigned char *transfer_buffer;
 342         char *string;
 343         int retval = 0;
 344         int i;
 345         int num_ports = 0;
 346
 347         dbg("%s", __func__);
 348
 349         transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
 350         if (!transfer_buffer) {
 351                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 352                         sizeof(*connection_info));
 353                 return -ENOMEM;
 354         }
 355
 356         /* send a get connection info request */
 357         retval = usb_control_msg(serial->dev,
 358                                   usb_rcvctrlpipe(serial->dev, 0),
 359                                   VISOR_GET_CONNECTION_INFORMATION,
 360                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 361                                   sizeof(*connection_info), 300);
 362         if (retval < 0) {
 363                 dev_err(dev, "%s - error %d getting connection information\n",
 364                         __func__, retval);
 365                 goto exit;
 366         }
 367
 368         if (retval == sizeof(*connection_info)) {
 369                         connection_info = (struct visor_connection_info *)
 370                                                         transfer_buffer;
 371
 372                 num_ports = le16_to_cpu(connection_info->num_ports);
 373                 for (i = 0; i < num_ports; ++i) {
 374                         switch (
 375                            connection_info->connections[i].port_function_id) {
 376                         case VISOR_FUNCTION_GENERIC:
 377                                 string = "Generic";
 378                                 break;
 379                         case VISOR_FUNCTION_DEBUGGER:
 380                                 string = "Debugger";
 381                                 break;
 382                         case VISOR_FUNCTION_HOTSYNC:
 383                                 string = "HotSync";
 384                                 break;
 385                         case VISOR_FUNCTION_CONSOLE:
 386                                 string = "Console";
 387                                 break;
 388                         case VISOR_FUNCTION_REMOTE_FILE_SYS:
 389                                 string = "Remote File System";
 390                                 break;
 391                         default:
 392                                 string = "unknown";
 393                                 break;
 394                         }
 395                         dev_info(dev, "%s: port %d, is for %s use\n",
 396                                 serial->type->description,
 397                                 connection_info->connections[i].port, string);
 398                 }
 399         }
 400         /*
 401         * Handle devices that report invalid stuff here.
 402         */
 403         if (num_ports == 0 || num_ports > 2) {
 404                 dev_warn(dev, "%s: No valid connect info available\n",
 405                         serial->type->description);
 406                 num_ports = 2;
 407         }
 408
 409         dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
 410                 num_ports);
 411
 412         /*
 413          * save off our num_ports info so that we can use it in the
 414          * calc_num_ports callback
 415          */
 416         usb_set_serial_data(serial, (void *)(long)num_ports);
 417
 418         /* ask for the number of bytes available, but ignore the
 419            response as it is broken */
 420         retval = usb_control_msg(serial->dev,
 421                                   usb_rcvctrlpipe(serial->dev, 0),
 422                                   VISOR_REQUEST_BYTES_AVAILABLE,
 423                                   0xc2, 0x0000, 0x0005, transfer_buffer,
 424                                   0x02, 300);
 425         if (retval < 0)
 426                 dev_err(dev, "%s - error %d getting bytes available request\n",
 427                         __func__, retval);
 428         retval = 0;
 429
 430 exit:
 431         kfree(transfer_buffer);
 432
 433         return retval;
 434 }
 435
 436 static int palm_os_4_probe(struct usb_serial *serial,
 437                                                 const struct usb_device_id *id)
 438 {
 439         struct device *dev = &serial->dev->dev;
 440         struct palm_ext_connection_info *connection_info;
 441         unsigned char *transfer_buffer;
 442         int retval;
 443
 444         dbg("%s", __func__);
 445
 446         transfer_buffer =  kmalloc(sizeof(*connection_info), GFP_KERNEL);
 447         if (!transfer_buffer) {
 448                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 449                         sizeof(*connection_info));
 450                 return -ENOMEM;
 451         }
 452
 453         retval = usb_control_msg(serial->dev,
 454                                   usb_rcvctrlpipe(serial->dev, 0),
 455                                   PALM_GET_EXT_CONNECTION_INFORMATION,
 456                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 457                                   sizeof(*connection_info), 300);
 458         if (retval < 0)
 459                 dev_err(dev, "%s - error %d getting connection info\n",
 460                         __func__, retval);
 461         else
 462                 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
 463                                       retval, transfer_buffer);
 464
 465         kfree(transfer_buffer);
 466         return 0;
 467 }
 468
 469
 470 static int visor_probe(struct usb_serial *serial,
 471                                         const struct usb_device_id *id)
 472 {
 473         int retval = 0;
 474         int (*startup)(struct usb_serial *serial,
 475                                         const struct usb_device_id *id);
 476
 477         dbg("%s", __func__);
 478
 479         if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
 480                 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
 481                         serial->dev->actconfig->desc.bConfigurationValue);
 482                 return -ENODEV;
 483         }
 484
 485         if (id->driver_info) {
 486                 startup = (void *)id->driver_info;
 487                 retval = startup(serial, id);
 488         }
 489
 490         return retval;
 491 }
 492
 493 static int visor_calc_num_ports(struct usb_serial *serial)
 494 {
 495         int num_ports = (int)(long)(usb_get_serial_data(serial));
 496
 497         if (num_ports)
 498                 usb_set_serial_data(serial, NULL);
 499
 500         return num_ports;
 501 }
 502
 503 static int clie_3_5_startup(struct usb_serial *serial)
 504 {
 505         struct device *dev = &serial->dev->dev;
 506         int result;
 507         u8 *data;
 508
 509         dbg("%s", __func__);
 510
 511         data = kmalloc(1, GFP_KERNEL);
 512         if (!data)
 513                 return -ENOMEM;
 514
 515         /*
 516          * Note that PEG-300 series devices expect the following two calls.
 517          */
 518
 519         /* get the config number */
 520         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 521                                   USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
 522                                   0, 0, data, 1, 3000);
 523         if (result < 0) {
 524                 dev_err(dev, "%s: get config number failed: %d\n",
 525                                                         __func__, result);
 526                 goto out;
 527         }
 528         if (result != 1) {
 529                 dev_err(dev, "%s: get config number bad return length: %d\n",
 530                                                         __func__, result);
 531                 result = -EIO;
 532                 goto out;
 533         }
 534
 535         /* get the interface number */
 536         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 537                                   USB_REQ_GET_INTERFACE,
 538                                   USB_DIR_IN | USB_RECIP_INTERFACE,
 539                                   0, 0, data, 1, 3000);
 540         if (result < 0) {
 541                 dev_err(dev, "%s: get interface number failed: %d\n",
 542                                                         __func__, result);
 543                 goto out;
 544         }
 545         if (result != 1) {
 546                 dev_err(dev,
 547                         "%s: get interface number bad return length: %d\n",
 548                                                         __func__, result);
 549                 result = -EIO;
 550                 goto out;
 551         }
 552
 553         result = 0;
 554 out:
 555         kfree(data);
 556
 557         return result;
 558 }
 559
 560 static int treo_attach(struct usb_serial *serial)
 561 {
 562         struct usb_serial_port *swap_port;
 563
 564         /* Only do this endpoint hack for the Handspring devices with
 565          * interrupt in endpoints, which for now are the Treo devices. */
 566         if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
 567                                                 == HANDSPRING_VENDOR_ID) ||
 568                 (le16_to_cpu(serial->dev->descriptor.idVendor)
 569                                                 == KYOCERA_VENDOR_ID)) ||
 570                 (serial->num_interrupt_in == 0))
 571                 return 0;
 572
 573         dbg("%s", __func__);
 574
 575         /*
 576         * It appears that Treos and Kyoceras want to use the
 577         * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
 578         * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
 579         * Note that swapping the bulk out endpoints would break lots of
 580         * apps that want to communicate on the second port.
 581         */
 582 #define COPY_PORT(dest, src)                                            \
 583         do { \
 584                 dest->read_urb = src->read_urb;                         \
 585                 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
 586                 dest->bulk_in_buffer = src->bulk_in_buffer;             \
 587                 dest->interrupt_in_urb = src->interrupt_in_urb;         \
 588                 dest->interrupt_in_endpointAddress = \
 589                                         src->interrupt_in_endpointAddress;\
 590                 dest->interrupt_in_buffer = src->interrupt_in_buffer;   \
 591         } while (0);
 592
 593         swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
 594         if (!swap_port)
 595                 return -ENOMEM;
 596         COPY_PORT(swap_port, serial->port[0]);
 597         COPY_PORT(serial->port[0], serial->port[1]);
 598         COPY_PORT(serial->port[1], swap_port);
 599         kfree(swap_port);
 600
 601         return 0;
 602 }
 603
 604 static int clie_5_attach(struct usb_serial *serial)
 605 {
 606         dbg("%s", __func__);
 607
 608         /* TH55 registers 2 ports.
 609            Communication in from the UX50/TH55 uses bulk_in_endpointAddress
 610            from port 0. Communication out to the UX50/TH55 uses
 611            bulk_out_endpointAddress from port 1
 612
 613            Lets do a quick and dirty mapping
 614          */
 615
 616         /* some sanity check */
 617         if (serial->num_ports < 2)
 618                 return -1;
 619
 620         /* port 0 now uses the modified endpoint Address */
 621         serial->port[0]->bulk_out_endpointAddress =
 622                                 serial->port[1]->bulk_out_endpointAddress;
 623
 624         return 0;
 625 }
 626
 627 static int __init visor_init(void)
 628 {
 629         int i, retval;
 630         /* Only if parameters were passed to us */
 631         if (vendor > 0 && product > 0) {
 632                 struct usb_device_id usb_dev_temp[] = {
 633                         {
 634                                 USB_DEVICE(vendor, product),
 635                                 .driver_info =
 636                                         (kernel_ulong_t) &palm_os_4_probe
 637                         }
 638                 };
 639
 640                 /* Find the last entry in id_table */
 641                 for (i = 0;; i++) {
 642                         if (id_table[i].idVendor == 0) {
 643                                 id_table[i] = usb_dev_temp[0];
 644                                 break;
 645                         }
 646                 }
 647                 /* Find the last entry in id_table_combined */
 648                 for (i = 0;; i++) {
 649                         if (id_table_combined[i].idVendor == 0) {
 650                                 id_table_combined[i] = usb_dev_temp[0];
 651                                 break;
 652                         }
 653                 }
 654                 printk(KERN_INFO KBUILD_MODNAME
 655                        ": Untested USB device specified at time of module insertion\n");
 656                 printk(KERN_INFO KBUILD_MODNAME
 657                        ": Warning: This is not guaranteed to work\n");
 658                 printk(KERN_INFO KBUILD_MODNAME
 659                        ": Using a newer kernel is preferred to this method\n");
 660                 printk(KERN_INFO KBUILD_MODNAME
 661                        ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
 662                         vendor, product);
 663         }
 664         retval = usb_serial_register(&handspring_device);
 665         if (retval)
 666                 goto failed_handspring_register;
 667         retval = usb_serial_register(&clie_3_5_device);
 668         if (retval)
 669                 goto failed_clie_3_5_register;
 670         retval = usb_serial_register(&clie_5_device);
 671         if (retval)
 672                 goto failed_clie_5_register;
 673         retval = usb_register(&visor_driver);
 674         if (retval)
 675                 goto failed_usb_register;
 676         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
 677
 678         return 0;
 679 failed_usb_register:
 680         usb_serial_deregister(&clie_5_device);
 681 failed_clie_5_register:
 682         usb_serial_deregister(&clie_3_5_device);
 683 failed_clie_3_5_register:
 684         usb_serial_deregister(&handspring_device);
 685 failed_handspring_register:
 686         return retval;
 687 }
 688
 689
 690 static void __exit visor_exit (void)
 691 {
 692         usb_deregister(&visor_driver);
 693         usb_serial_deregister(&handspring_device);
 694         usb_serial_deregister(&clie_3_5_device);
 695         usb_serial_deregister(&clie_5_device);
 696 }
 697
 698
 699 module_init(visor_init);
 700 module_exit(visor_exit);
 701
 702 MODULE_AUTHOR(DRIVER_AUTHOR);
 703 MODULE_DESCRIPTION(DRIVER_DESC);
 704 MODULE_LICENSE("GPL");
 705
 706 module_param(debug, bool, S_IRUGO | S_IWUSR);
 707 MODULE_PARM_DESC(debug, "Debug enabled or not");
 708
 709 module_param(vendor, ushort, 0);
 710 MODULE_PARM_DESC(vendor, "User specified vendor ID");
 711 module_param(product, ushort, 0);
 712 MODULE_PARM_DESC(product, "User specified product ID");
 713