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