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         .bulk_out_size =        256,
 190         .open =                 visor_open,
 191         .close =                visor_close,
 192         .throttle =             usb_serial_generic_throttle,
 193         .unthrottle =           usb_serial_generic_unthrottle,
 194         .attach =               treo_attach,
 195         .probe =                visor_probe,
 196         .calc_num_ports =       visor_calc_num_ports,
 197         .read_int_callback =    visor_read_int_callback,
 198 };
 199
 200 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
 201 static struct usb_serial_driver clie_5_device = {
 202         .driver = {
 203                 .owner =        THIS_MODULE,
 204                 .name =         "clie_5",
 205         },
 206         .description =          "Sony Clie 5.0",
 207         .usb_driver =           &visor_driver,
 208         .id_table =             clie_id_5_table,
 209         .num_ports =            2,
 210         .bulk_out_size =        256,
 211         .open =                 visor_open,
 212         .close =                visor_close,
 213         .throttle =             usb_serial_generic_throttle,
 214         .unthrottle =           usb_serial_generic_unthrottle,
 215         .attach =               clie_5_attach,
 216         .probe =                visor_probe,
 217         .calc_num_ports =       visor_calc_num_ports,
 218         .read_int_callback =    visor_read_int_callback,
 219 };
 220
 221 /* device info for the Sony Clie OS version 3.5 */
 222 static struct usb_serial_driver clie_3_5_device = {
 223         .driver = {
 224                 .owner =        THIS_MODULE,
 225                 .name =         "clie_3.5",
 226         },
 227         .description =          "Sony Clie 3.5",
 228         .usb_driver =           &visor_driver,
 229         .id_table =             clie_id_3_5_table,
 230         .num_ports =            1,
 231         .bulk_out_size =        256,
 232         .open =                 visor_open,
 233         .close =                visor_close,
 234         .throttle =             usb_serial_generic_throttle,
 235         .unthrottle =           usb_serial_generic_unthrottle,
 236         .attach =               clie_3_5_startup,
 237 };
 238
 239 /******************************************************************************
 240  * Handspring Visor specific driver functions
 241  ******************************************************************************/
 242 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
 243 {
 244         int result = 0;
 245
 246         dbg("%s - port %d", __func__, port->number);
 247
 248         if (!port->read_urb) {
 249                 /* this is needed for some brain dead Sony devices */
 250                 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
 251                 return -ENODEV;
 252         }
 253
 254         /* Start reading from the device */
 255         result = usb_serial_generic_open(tty, port);
 256         if (result)
 257                 goto exit;
 258
 259         if (port->interrupt_in_urb) {
 260                 dbg("%s - adding interrupt input for treo", __func__);
 261                 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 262                 if (result)
 263                         dev_err(&port->dev,
 264                             "%s - failed submitting interrupt urb, error %d\n",
 265                                                         __func__, result);
 266         }
 267 exit:
 268         return result;
 269 }
 270
 271
 272 static void visor_close(struct usb_serial_port *port)
 273 {
 274         unsigned char *transfer_buffer;
 275
 276         dbg("%s - port %d", __func__, port->number);
 277
 278         /* shutdown our urbs */
 279         usb_serial_generic_close(port);
 280         usb_kill_urb(port->interrupt_in_urb);
 281
 282         mutex_lock(&port->serial->disc_mutex);
 283         if (!port->serial->disconnected) {
 284                 /* Try to send shutdown message, unless the device is gone */
 285                 transfer_buffer =  kmalloc(0x12, GFP_KERNEL);
 286                 if (transfer_buffer) {
 287                         usb_control_msg(port->serial->dev,
 288                                          usb_rcvctrlpipe(port->serial->dev, 0),
 289                                          VISOR_CLOSE_NOTIFICATION, 0xc2,
 290                                          0x0000, 0x0000,
 291                                          transfer_buffer, 0x12, 300);
 292                         kfree(transfer_buffer);
 293                 }
 294         }
 295         mutex_unlock(&port->serial->disc_mutex);
 296 }
 297
 298 static void visor_read_int_callback(struct urb *urb)
 299 {
 300         struct usb_serial_port *port = urb->context;
 301         int status = urb->status;
 302         int result;
 303
 304         switch (status) {
 305         case 0:
 306                 /* success */
 307                 break;
 308         case -ECONNRESET:
 309         case -ENOENT:
 310         case -ESHUTDOWN:
 311                 /* this urb is terminated, clean up */
 312                 dbg("%s - urb shutting down with status: %d",
 313                     __func__, status);
 314                 return;
 315         default:
 316                 dbg("%s - nonzero urb status received: %d",
 317                     __func__, status);
 318                 goto exit;
 319         }
 320
 321         /*
 322          * This information is still unknown what it can be used for.
 323          * If anyone has an idea, please let the author know...
 324          *
 325          * Rumor has it this endpoint is used to notify when data
 326          * is ready to be read from the bulk ones.
 327          */
 328         usb_serial_debug_data(debug, &port->dev, __func__,
 329                               urb->actual_length, urb->transfer_buffer);
 330
 331 exit:
 332         result = usb_submit_urb(urb, GFP_ATOMIC);
 333         if (result)
 334                 dev_err(&urb->dev->dev,
 335                                 "%s - Error %d submitting interrupt urb\n",
 336                                                         __func__, result);
 337 }
 338
 339 static int palm_os_3_probe(struct usb_serial *serial,
 340                                                 const struct usb_device_id *id)
 341 {
 342         struct device *dev = &serial->dev->dev;
 343         struct visor_connection_info *connection_info;
 344         unsigned char *transfer_buffer;
 345         char *string;
 346         int retval = 0;
 347         int i;
 348         int num_ports = 0;
 349
 350         dbg("%s", __func__);
 351
 352         transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
 353         if (!transfer_buffer) {
 354                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 355                         sizeof(*connection_info));
 356                 return -ENOMEM;
 357         }
 358
 359         /* send a get connection info request */
 360         retval = usb_control_msg(serial->dev,
 361                                   usb_rcvctrlpipe(serial->dev, 0),
 362                                   VISOR_GET_CONNECTION_INFORMATION,
 363                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 364                                   sizeof(*connection_info), 300);
 365         if (retval < 0) {
 366                 dev_err(dev, "%s - error %d getting connection information\n",
 367                         __func__, retval);
 368                 goto exit;
 369         }
 370
 371         if (retval == sizeof(*connection_info)) {
 372                         connection_info = (struct visor_connection_info *)
 373                                                         transfer_buffer;
 374
 375                 num_ports = le16_to_cpu(connection_info->num_ports);
 376                 for (i = 0; i < num_ports; ++i) {
 377                         switch (
 378                            connection_info->connections[i].port_function_id) {
 379                         case VISOR_FUNCTION_GENERIC:
 380                                 string = "Generic";
 381                                 break;
 382                         case VISOR_FUNCTION_DEBUGGER:
 383                                 string = "Debugger";
 384                                 break;
 385                         case VISOR_FUNCTION_HOTSYNC:
 386                                 string = "HotSync";
 387                                 break;
 388                         case VISOR_FUNCTION_CONSOLE:
 389                                 string = "Console";
 390                                 break;
 391                         case VISOR_FUNCTION_REMOTE_FILE_SYS:
 392                                 string = "Remote File System";
 393                                 break;
 394                         default:
 395                                 string = "unknown";
 396                                 break;
 397                         }
 398                         dev_info(dev, "%s: port %d, is for %s use\n",
 399                                 serial->type->description,
 400                                 connection_info->connections[i].port, string);
 401                 }
 402         }
 403         /*
 404         * Handle devices that report invalid stuff here.
 405         */
 406         if (num_ports == 0 || num_ports > 2) {
 407                 dev_warn(dev, "%s: No valid connect info available\n",
 408                         serial->type->description);
 409                 num_ports = 2;
 410         }
 411
 412         dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
 413                 num_ports);
 414
 415         /*
 416          * save off our num_ports info so that we can use it in the
 417          * calc_num_ports callback
 418          */
 419         usb_set_serial_data(serial, (void *)(long)num_ports);
 420
 421         /* ask for the number of bytes available, but ignore the
 422            response as it is broken */
 423         retval = usb_control_msg(serial->dev,
 424                                   usb_rcvctrlpipe(serial->dev, 0),
 425                                   VISOR_REQUEST_BYTES_AVAILABLE,
 426                                   0xc2, 0x0000, 0x0005, transfer_buffer,
 427                                   0x02, 300);
 428         if (retval < 0)
 429                 dev_err(dev, "%s - error %d getting bytes available request\n",
 430                         __func__, retval);
 431         retval = 0;
 432
 433 exit:
 434         kfree(transfer_buffer);
 435
 436         return retval;
 437 }
 438
 439 static int palm_os_4_probe(struct usb_serial *serial,
 440                                                 const struct usb_device_id *id)
 441 {
 442         struct device *dev = &serial->dev->dev;
 443         struct palm_ext_connection_info *connection_info;
 444         unsigned char *transfer_buffer;
 445         int retval;
 446
 447         dbg("%s", __func__);
 448
 449         transfer_buffer =  kmalloc(sizeof(*connection_info), GFP_KERNEL);
 450         if (!transfer_buffer) {
 451                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
 452                         sizeof(*connection_info));
 453                 return -ENOMEM;
 454         }
 455
 456         retval = usb_control_msg(serial->dev,
 457                                   usb_rcvctrlpipe(serial->dev, 0),
 458                                   PALM_GET_EXT_CONNECTION_INFORMATION,
 459                                   0xc2, 0x0000, 0x0000, transfer_buffer,
 460                                   sizeof(*connection_info), 300);
 461         if (retval < 0)
 462                 dev_err(dev, "%s - error %d getting connection info\n",
 463                         __func__, retval);
 464         else
 465                 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
 466                                       retval, transfer_buffer);
 467
 468         kfree(transfer_buffer);
 469         return 0;
 470 }
 471
 472
 473 static int visor_probe(struct usb_serial *serial,
 474                                         const struct usb_device_id *id)
 475 {
 476         int retval = 0;
 477         int (*startup)(struct usb_serial *serial,
 478                                         const struct usb_device_id *id);
 479
 480         dbg("%s", __func__);
 481
 482         if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
 483                 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
 484                         serial->dev->actconfig->desc.bConfigurationValue);
 485                 return -ENODEV;
 486         }
 487
 488         if (id->driver_info) {
 489                 startup = (void *)id->driver_info;
 490                 retval = startup(serial, id);
 491         }
 492
 493         return retval;
 494 }
 495
 496 static int visor_calc_num_ports(struct usb_serial *serial)
 497 {
 498         int num_ports = (int)(long)(usb_get_serial_data(serial));
 499
 500         if (num_ports)
 501                 usb_set_serial_data(serial, NULL);
 502
 503         return num_ports;
 504 }
 505
 506 static int clie_3_5_startup(struct usb_serial *serial)
 507 {
 508         struct device *dev = &serial->dev->dev;
 509         int result;
 510         u8 *data;
 511
 512         dbg("%s", __func__);
 513
 514         data = kmalloc(1, GFP_KERNEL);
 515         if (!data)
 516                 return -ENOMEM;
 517
 518         /*
 519          * Note that PEG-300 series devices expect the following two calls.
 520          */
 521
 522         /* get the config number */
 523         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 524                                   USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
 525                                   0, 0, data, 1, 3000);
 526         if (result < 0) {
 527                 dev_err(dev, "%s: get config number failed: %d\n",
 528                                                         __func__, result);
 529                 goto out;
 530         }
 531         if (result != 1) {
 532                 dev_err(dev, "%s: get config number bad return length: %d\n",
 533                                                         __func__, result);
 534                 result = -EIO;
 535                 goto out;
 536         }
 537
 538         /* get the interface number */
 539         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 540                                   USB_REQ_GET_INTERFACE,
 541                                   USB_DIR_IN | USB_RECIP_INTERFACE,
 542                                   0, 0, data, 1, 3000);
 543         if (result < 0) {
 544                 dev_err(dev, "%s: get interface number failed: %d\n",
 545                                                         __func__, result);
 546                 goto out;
 547         }
 548         if (result != 1) {
 549                 dev_err(dev,
 550                         "%s: get interface number bad return length: %d\n",
 551                                                         __func__, result);
 552                 result = -EIO;
 553                 goto out;
 554         }
 555
 556         result = 0;
 557 out:
 558         kfree(data);
 559
 560         return result;
 561 }
 562
 563 static int treo_attach(struct usb_serial *serial)
 564 {
 565         struct usb_serial_port *swap_port;
 566
 567         /* Only do this endpoint hack for the Handspring devices with
 568          * interrupt in endpoints, which for now are the Treo devices. */
 569         if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
 570                                                 == HANDSPRING_VENDOR_ID) ||
 571                 (le16_to_cpu(serial->dev->descriptor.idVendor)
 572                                                 == KYOCERA_VENDOR_ID)) ||
 573                 (serial->num_interrupt_in == 0))
 574                 return 0;
 575
 576         dbg("%s", __func__);
 577
 578         /*
 579         * It appears that Treos and Kyoceras want to use the
 580         * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
 581         * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
 582         * Note that swapping the bulk out endpoints would break lots of
 583         * apps that want to communicate on the second port.
 584         */
 585 #define COPY_PORT(dest, src)                                            \
 586         do { \
 587                 dest->read_urb = src->read_urb;                         \
 588                 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
 589                 dest->bulk_in_buffer = src->bulk_in_buffer;             \
 590                 dest->interrupt_in_urb = src->interrupt_in_urb;         \
 591                 dest->interrupt_in_endpointAddress = \
 592                                         src->interrupt_in_endpointAddress;\
 593                 dest->interrupt_in_buffer = src->interrupt_in_buffer;   \
 594         } while (0);
 595
 596         swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
 597         if (!swap_port)
 598                 return -ENOMEM;
 599         COPY_PORT(swap_port, serial->port[0]);
 600         COPY_PORT(serial->port[0], serial->port[1]);
 601         COPY_PORT(serial->port[1], swap_port);
 602         kfree(swap_port);
 603
 604         return 0;
 605 }
 606
 607 static int clie_5_attach(struct usb_serial *serial)
 608 {
 609         dbg("%s", __func__);
 610
 611         /* TH55 registers 2 ports.
 612            Communication in from the UX50/TH55 uses bulk_in_endpointAddress
 613            from port 0. Communication out to the UX50/TH55 uses
 614            bulk_out_endpointAddress from port 1
 615
 616            Lets do a quick and dirty mapping
 617          */
 618
 619         /* some sanity check */
 620         if (serial->num_ports < 2)
 621                 return -1;
 622
 623         /* port 0 now uses the modified endpoint Address */
 624         serial->port[0]->bulk_out_endpointAddress =
 625                                 serial->port[1]->bulk_out_endpointAddress;
 626
 627         return 0;
 628 }
 629
 630 static int __init visor_init(void)
 631 {
 632         int i, retval;
 633         /* Only if parameters were passed to us */
 634         if (vendor > 0 && product > 0) {
 635                 struct usb_device_id usb_dev_temp[] = {
 636                         {
 637                                 USB_DEVICE(vendor, product),
 638                                 .driver_info =
 639                                         (kernel_ulong_t) &palm_os_4_probe
 640                         }
 641                 };
 642
 643                 /* Find the last entry in id_table */
 644                 for (i = 0;; i++) {
 645                         if (id_table[i].idVendor == 0) {
 646                                 id_table[i] = usb_dev_temp[0];
 647                                 break;
 648                         }
 649                 }
 650                 /* Find the last entry in id_table_combined */
 651                 for (i = 0;; i++) {
 652                         if (id_table_combined[i].idVendor == 0) {
 653                                 id_table_combined[i] = usb_dev_temp[0];
 654                                 break;
 655                         }
 656                 }
 657                 printk(KERN_INFO KBUILD_MODNAME
 658                        ": Untested USB device specified at time of module insertion\n");
 659                 printk(KERN_INFO KBUILD_MODNAME
 660                        ": Warning: This is not guaranteed to work\n");
 661                 printk(KERN_INFO KBUILD_MODNAME
 662                        ": Using a newer kernel is preferred to this method\n");
 663                 printk(KERN_INFO KBUILD_MODNAME
 664                        ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
 665                         vendor, product);
 666         }
 667         retval = usb_serial_register(&handspring_device);
 668         if (retval)
 669                 goto failed_handspring_register;
 670         retval = usb_serial_register(&clie_3_5_device);
 671         if (retval)
 672                 goto failed_clie_3_5_register;
 673         retval = usb_serial_register(&clie_5_device);
 674         if (retval)
 675                 goto failed_clie_5_register;
 676         retval = usb_register(&visor_driver);
 677         if (retval)
 678                 goto failed_usb_register;
 679         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
 680
 681         return 0;
 682 failed_usb_register:
 683         usb_serial_deregister(&clie_5_device);
 684 failed_clie_5_register:
 685         usb_serial_deregister(&clie_3_5_device);
 686 failed_clie_3_5_register:
 687         usb_serial_deregister(&handspring_device);
 688 failed_handspring_register:
 689         return retval;
 690 }
 691
 692
 693 static void __exit visor_exit (void)
 694 {
 695         usb_deregister(&visor_driver);
 696         usb_serial_deregister(&handspring_device);
 697         usb_serial_deregister(&clie_3_5_device);
 698         usb_serial_deregister(&clie_5_device);
 699 }
 700
 701
 702 module_init(visor_init);
 703 module_exit(visor_exit);
 704
 705 MODULE_AUTHOR(DRIVER_AUTHOR);
 706 MODULE_DESCRIPTION(DRIVER_DESC);
 707 MODULE_LICENSE("GPL");
 708
 709 module_param(debug, bool, S_IRUGO | S_IWUSR);
 710 MODULE_PARM_DESC(debug, "Debug enabled or not");
 711
 712 module_param(vendor, ushort, 0);
 713 MODULE_PARM_DESC(vendor, "User specified vendor ID");
 714 module_param(product, ushort, 0);
 715 MODULE_PARM_DESC(product, "User specified product ID");
 716