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