2 * USB HandSpring Visor, Palm m50x, and Sony Clie driver
3 * (supports all of the Palm OS USB devices)
5 * Copyright (C) 1999 - 2004
6 * Greg Kroah-Hartman (greg@kroah.com)
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, or
11 * (at your option) any later version.
13 * See Documentation/usb/usb-serial.txt for more information on using this driver
15 * (06/03/2003) Judd Montgomery <judd at jpilot.org>
16 * Added support for module parameter options for untested/unknown
20 * Added support for the Sony Clie NZ90V device. Thanks to Martin Brachtl
21 * <brachtl@redgrep.cz> for the information.
24 * Think Treo support is now working.
27 * Added support for the Sony OS 4.1 devices. Thanks to Hiroyuki ARAKI
28 * <hiro@zob.ne.jp> for the information.
31 * Removed assumptions that port->tty was always valid (is not true
32 * for usb serial console devices.)
35 * Added support for the Palm i705 device, thanks to Thomas Riemer
36 * <tom@netmech.com> for the information.
39 * Added support for the Palm m130 device, thanks to Udo Eisenbarth
40 * <udo.eisenbarth@web.de> for the information.
43 * Reworked the urb handling logic. We have no more pool, but dynamically
44 * allocate the urb and the transfer buffer on the fly. In testing this
45 * does not incure any measurable overhead. This also relies on the fact
46 * that we have proper reference counting logic for urbs.
49 * Added initial support for the Palm m515 devices.
52 * Added support for the Clie S-360 device.
55 * Added better Clie support for 3.5 devices. Thanks to Geoffrey Levand
59 * Added support for the m125 devices, and added check to prevent oopses
60 * for CliƩ devices that lie about the number of ports they have.
63 * Added support for the Clie devices, both the 3.5 and 4.0 os versions.
64 * Many thanks to Daniel Burke, and Bryan Payne for helping with this.
67 * fixed a few potential bugs pointed out by Oliver Neukum.
70 * switched from using spinlock to a semaphore, which fixes lots of problems.
73 * Added initial support for the Palm m500 and Palm m505 devices.
76 * Identify version on module load.
79 * Added write_room and chars_in_buffer, as they were previously using the
80 * generic driver versions which is all wrong now that we are using an urb
81 * pool. Thanks to Wolfgang Grandegger for pointing this out to me.
82 * Removed count assignment in the write function, which was not needed anymore
83 * either. Thanks to Al Borchers for pointing this out.
86 * Moved MOD_DEC to end of visor_close to be nicer, as the final write
90 * Fixed bug with data being dropped on the floor by forcing tty->low_latency
91 * to be on. Hopefully this fixes the OHCI issue!
93 * (11/01/2000) Adam J. Richter
94 * usb_device_id table support
97 * Fixed bug with urb->dev not being set properly, now that the usb
101 * Got rid of always calling kmalloc for every urb we wrote out to the
103 * Added visor_read_callback so we can keep track of bytes in and out for
104 * those people who like to know the speed of their device.
105 * Removed DEBUG #ifdefs with call to usb_serial_debug_data
108 * Fixed oops in visor_exit. Need to uncomment usb_unlink_urb call _after_
109 * the host controller drivers set urb->dev = NULL when the urb is finished.
112 * Added locks for SMP safeness.
115 * Fixed endian problem in visor_startup.
116 * Fixed MOD_INC and MOD_DEC logic and the ability to open a port more
120 * Added pool of write urbs to speed up transfers to the visor.
123 * Added module_init and module_exit functions to handle the fact that this
124 * driver is a loadable module now.
127 * Added visor_set_ioctl and visor_set_termios functions (they don't do much
128 * of anything, but are good for debugging.)
131 * Fixed bug in visor_unthrottle that should help with the disconnect in PPP
132 * bug that people have been reporting.
135 * Cleaned up debugging statements in a quest to find UHCI timeout bug.
137 * (04/27/2000) Ryan VanderBijl
138 * Fixed memory leak in visor_close
141 * Split driver up into device specific pieces.
145 #include <linux/config.h>
146 #include <linux/kernel.h>
147 #include <linux/errno.h>
148 #include <linux/init.h>
149 #include <linux/slab.h>
150 #include <linux/tty.h>
151 #include <linux/tty_driver.h>
152 #include <linux/tty_flip.h>
153 #include <linux/module.h>
154 #include <linux/moduleparam.h>
155 #include <linux/spinlock.h>
156 #include <asm/uaccess.h>
157 #include <linux/usb.h>
159 #ifdef CONFIG_USB_SERIAL_DEBUG
160 static int debug = 1;
165 #include "usb-serial.h"
169 * Version Information
171 #define DRIVER_VERSION "v2.1"
172 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
173 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
175 /* function prototypes for a handspring visor */
176 static int visor_open (struct usb_serial_port *port, struct file *filp);
177 static void visor_close (struct usb_serial_port *port, struct file *filp);
178 static int visor_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
179 static int visor_write_room (struct usb_serial_port *port);
180 static int visor_chars_in_buffer (struct usb_serial_port *port);
181 static void visor_throttle (struct usb_serial_port *port);
182 static void visor_unthrottle (struct usb_serial_port *port);
183 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id);
184 static int visor_calc_num_ports(struct usb_serial *serial);
185 static void visor_shutdown (struct usb_serial *serial);
186 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
187 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios);
188 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
189 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
190 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs);
191 static int clie_3_5_startup (struct usb_serial *serial);
192 static int treo_attach (struct usb_serial *serial);
193 static int clie_5_attach (struct usb_serial *serial);
194 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id);
195 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id);
197 /* Parameters that may be passed into the module. */
199 static __u16 product;
201 static struct usb_device_id id_table [] = {
202 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
203 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
204 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
205 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
206 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
207 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
208 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
209 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
210 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
211 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
212 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
213 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
214 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
215 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
216 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
217 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
218 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
219 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
220 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
221 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
222 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
223 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
224 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
225 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
226 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID),
227 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
228 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
229 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
230 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
231 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
232 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
233 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
234 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
235 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
236 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
237 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
238 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
239 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
240 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
241 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
242 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
243 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
244 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
245 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
246 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
247 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
248 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
249 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
250 { }, /* optional parameter entry */
251 { } /* Terminating entry */
254 static struct usb_device_id clie_id_5_table [] = {
255 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
256 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
257 { }, /* optional parameter entry */
258 { } /* Terminating entry */
261 static struct usb_device_id clie_id_3_5_table [] = {
262 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
263 { } /* Terminating entry */
266 static struct usb_device_id id_table_combined [] = {
267 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
268 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
269 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
270 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
271 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
272 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
273 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
274 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
275 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
276 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
277 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
278 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
279 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID) },
280 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
281 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
282 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
283 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
284 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
285 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
286 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
287 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
288 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
289 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
290 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
291 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
292 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
293 { }, /* optional parameter entry */
294 { } /* Terminating entry */
297 MODULE_DEVICE_TABLE (usb, id_table_combined);
299 static struct usb_driver visor_driver = {
300 .owner = THIS_MODULE,
302 .probe = usb_serial_probe,
303 .disconnect = usb_serial_disconnect,
304 .id_table = id_table_combined,
307 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
308 static struct usb_serial_device_type handspring_device = {
309 .owner = THIS_MODULE,
310 .name = "Handspring Visor / Palm OS",
311 .short_name = "visor",
312 .id_table = id_table,
313 .num_interrupt_in = NUM_DONT_CARE,
318 .close = visor_close,
319 .throttle = visor_throttle,
320 .unthrottle = visor_unthrottle,
321 .attach = treo_attach,
322 .probe = visor_probe,
323 .calc_num_ports = visor_calc_num_ports,
324 .shutdown = visor_shutdown,
325 .ioctl = visor_ioctl,
326 .set_termios = visor_set_termios,
327 .write = visor_write,
328 .write_room = visor_write_room,
329 .chars_in_buffer = visor_chars_in_buffer,
330 .write_bulk_callback = visor_write_bulk_callback,
331 .read_bulk_callback = visor_read_bulk_callback,
332 .read_int_callback = visor_read_int_callback,
335 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
336 static struct usb_serial_device_type clie_5_device = {
337 .owner = THIS_MODULE,
338 .name = "Sony Clie 5.0",
339 .short_name = "clie_5",
340 .id_table = clie_id_5_table,
341 .num_interrupt_in = NUM_DONT_CARE,
346 .close = visor_close,
347 .throttle = visor_throttle,
348 .unthrottle = visor_unthrottle,
349 .attach = clie_5_attach,
350 .probe = visor_probe,
351 .calc_num_ports = visor_calc_num_ports,
352 .shutdown = visor_shutdown,
353 .ioctl = visor_ioctl,
354 .set_termios = visor_set_termios,
355 .write = visor_write,
356 .write_room = visor_write_room,
357 .chars_in_buffer = visor_chars_in_buffer,
358 .write_bulk_callback = visor_write_bulk_callback,
359 .read_bulk_callback = visor_read_bulk_callback,
360 .read_int_callback = visor_read_int_callback,
363 /* device info for the Sony Clie OS version 3.5 */
364 static struct usb_serial_device_type clie_3_5_device = {
365 .owner = THIS_MODULE,
366 .name = "Sony Clie 3.5",
367 .short_name = "clie_3.5",
368 .id_table = clie_id_3_5_table,
369 .num_interrupt_in = 0,
374 .close = visor_close,
375 .throttle = visor_throttle,
376 .unthrottle = visor_unthrottle,
377 .attach = clie_3_5_startup,
378 .ioctl = visor_ioctl,
379 .set_termios = visor_set_termios,
380 .write = visor_write,
381 .write_room = visor_write_room,
382 .chars_in_buffer = visor_chars_in_buffer,
383 .write_bulk_callback = visor_write_bulk_callback,
384 .read_bulk_callback = visor_read_bulk_callback,
389 static int bytes_out;
392 /******************************************************************************
393 * Handspring Visor specific driver functions
394 ******************************************************************************/
395 static int visor_open (struct usb_serial_port *port, struct file *filp)
397 struct usb_serial *serial = port->serial;
400 dbg("%s - port %d", __FUNCTION__, port->number);
402 if (!port->read_urb) {
403 /* this is needed for some brain dead Sony devices */
404 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
412 * Force low_latency on so that our tty_push actually forces the data
413 * through, otherwise it is scheduled, and with high data rates (like
414 * with OHCI) data can get lost.
417 port->tty->low_latency = 1;
419 /* Start reading from the device */
420 usb_fill_bulk_urb (port->read_urb, serial->dev,
421 usb_rcvbulkpipe (serial->dev,
422 port->bulk_in_endpointAddress),
423 port->read_urb->transfer_buffer,
424 port->read_urb->transfer_buffer_length,
425 visor_read_bulk_callback, port);
426 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
428 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
429 __FUNCTION__, result);
433 if (port->interrupt_in_urb) {
434 dbg("%s - adding interrupt input for treo", __FUNCTION__);
435 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
437 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
438 __FUNCTION__, result);
445 static void visor_close (struct usb_serial_port *port, struct file * filp)
447 unsigned char *transfer_buffer;
449 dbg("%s - port %d", __FUNCTION__, port->number);
451 /* shutdown our urbs */
452 usb_unlink_urb (port->read_urb);
453 if (port->interrupt_in_urb)
454 usb_unlink_urb (port->interrupt_in_urb);
456 /* Try to send shutdown message, if the device is gone, this will just fail. */
457 transfer_buffer = kmalloc (0x12, GFP_KERNEL);
458 if (transfer_buffer) {
459 usb_control_msg (port->serial->dev,
460 usb_rcvctrlpipe(port->serial->dev, 0),
461 VISOR_CLOSE_NOTIFICATION, 0xc2,
463 transfer_buffer, 0x12, 300);
464 kfree (transfer_buffer);
467 /* Uncomment the following line if you want to see some statistics in your syslog */
468 /* dev_info (&port->dev, "Bytes In = %d Bytes Out = %d\n", bytes_in, bytes_out); */
472 static int visor_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count)
474 struct usb_serial *serial = port->serial;
476 unsigned char *buffer;
479 dbg("%s - port %d", __FUNCTION__, port->number);
481 buffer = kmalloc (count, GFP_ATOMIC);
483 dev_err(&port->dev, "out of memory\n");
487 urb = usb_alloc_urb(0, GFP_ATOMIC);
489 dev_err(&port->dev, "no more free urbs\n");
495 if (copy_from_user (buffer, buf, count)) {
501 memcpy (buffer, buf, count);
504 usb_serial_debug_data (__FILE__, __FUNCTION__, count, buffer);
506 usb_fill_bulk_urb (urb, serial->dev,
507 usb_sndbulkpipe (serial->dev,
508 port->bulk_out_endpointAddress),
510 visor_write_bulk_callback, port);
512 /* send it down the pipe */
513 status = usb_submit_urb(urb, GFP_ATOMIC);
515 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
516 __FUNCTION__, status);
522 /* we are done with this urb, so let the host driver
523 * really free it when it is finished with it */
530 static int visor_write_room (struct usb_serial_port *port)
532 dbg("%s - port %d", __FUNCTION__, port->number);
535 * We really can take anything the user throws at us
536 * but let's pick a nice big number to tell the tty
537 * layer that we have lots of free space
543 static int visor_chars_in_buffer (struct usb_serial_port *port)
545 dbg("%s - port %d", __FUNCTION__, port->number);
548 * We can't really account for how much data we
549 * have sent out, but hasn't made it through to the
550 * device, so just tell the tty layer that everything
557 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
559 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
561 /* free up the transfer buffer, as usb_free_urb() does not do this */
562 kfree (urb->transfer_buffer);
564 dbg("%s - port %d", __FUNCTION__, port->number);
567 dbg("%s - nonzero write bulk status received: %d",
568 __FUNCTION__, urb->status);
570 schedule_work(&port->work);
574 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
576 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
577 struct tty_struct *tty;
578 unsigned char *data = urb->transfer_buffer;
582 dbg("%s - port %d", __FUNCTION__, port->number);
585 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
589 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
592 if (tty && urb->actual_length) {
593 for (i = 0; i < urb->actual_length ; ++i) {
594 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
595 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
596 tty_flip_buffer_push(tty);
598 /* this doesn't actually push the data through unless tty->low_latency is set */
599 tty_insert_flip_char(tty, data[i], 0);
601 tty_flip_buffer_push(tty);
603 bytes_in += urb->actual_length;
605 /* Continue trying to always read */
606 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
607 usb_rcvbulkpipe(port->serial->dev,
608 port->bulk_in_endpointAddress),
609 port->read_urb->transfer_buffer,
610 port->read_urb->transfer_buffer_length,
611 visor_read_bulk_callback, port);
612 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
614 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
618 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs)
622 switch (urb->status) {
629 /* this urb is terminated, clean up */
630 dbg("%s - urb shutting down with status: %d",
631 __FUNCTION__, urb->status);
634 dbg("%s - nonzero urb status received: %d",
635 __FUNCTION__, urb->status);
640 * This information is still unknown what it can be used for.
641 * If anyone has an idea, please let the author know...
643 * Rumor has it this endpoint is used to notify when data
644 * is ready to be read from the bulk ones.
646 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length,
647 urb->transfer_buffer);
650 result = usb_submit_urb (urb, GFP_ATOMIC);
652 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
653 __FUNCTION__, result);
656 static void visor_throttle (struct usb_serial_port *port)
658 dbg("%s - port %d", __FUNCTION__, port->number);
659 usb_unlink_urb (port->read_urb);
663 static void visor_unthrottle (struct usb_serial_port *port)
667 dbg("%s - port %d", __FUNCTION__, port->number);
669 port->read_urb->dev = port->serial->dev;
670 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
672 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
675 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
677 struct device *dev = &serial->dev->dev;
678 struct visor_connection_info *connection_info;
679 unsigned char *transfer_buffer;
685 dbg("%s", __FUNCTION__);
687 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
688 if (!transfer_buffer) {
689 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
690 sizeof(*connection_info));
694 /* send a get connection info request */
695 retval = usb_control_msg (serial->dev,
696 usb_rcvctrlpipe(serial->dev, 0),
697 VISOR_GET_CONNECTION_INFORMATION,
698 0xc2, 0x0000, 0x0000, transfer_buffer,
699 sizeof(*connection_info), 300);
701 dev_err(dev, "%s - error %d getting connection information\n",
702 __FUNCTION__, retval);
706 if (retval == sizeof(*connection_info)) {
707 connection_info = (struct visor_connection_info *)transfer_buffer;
709 le16_to_cpus(&connection_info->num_ports);
710 num_ports = connection_info->num_ports;
712 for (i = 0; i < num_ports; ++i) {
713 switch (connection_info->connections[i].port_function_id) {
714 case VISOR_FUNCTION_GENERIC:
717 case VISOR_FUNCTION_DEBUGGER:
720 case VISOR_FUNCTION_HOTSYNC:
723 case VISOR_FUNCTION_CONSOLE:
726 case VISOR_FUNCTION_REMOTE_FILE_SYS:
727 string = "Remote File System";
733 dev_info(dev, "%s: port %d, is for %s use\n",
735 connection_info->connections[i].port, string);
739 * Handle devices that report invalid stuff here.
741 if (num_ports == 0 || num_ports > 2) {
742 dev_warn (dev, "%s: No valid connect info available\n",
747 dev_info(dev, "%s: Number of ports: %d\n", serial->type->name,
751 * save off our num_ports info so that we can use it in the
752 * calc_num_ports callback
754 usb_set_serial_data(serial, (void *)(long)num_ports);
756 /* ask for the number of bytes available, but ignore the response as it is broken */
757 retval = usb_control_msg (serial->dev,
758 usb_rcvctrlpipe(serial->dev, 0),
759 VISOR_REQUEST_BYTES_AVAILABLE,
760 0xc2, 0x0000, 0x0005, transfer_buffer,
763 dev_err(dev, "%s - error %d getting bytes available request\n",
764 __FUNCTION__, retval);
768 kfree (transfer_buffer);
773 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
775 struct device *dev = &serial->dev->dev;
776 struct palm_ext_connection_info *connection_info;
777 unsigned char *transfer_buffer;
780 dbg("%s", __FUNCTION__);
782 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
783 if (!transfer_buffer) {
784 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
785 sizeof(*connection_info));
789 retval = usb_control_msg (serial->dev,
790 usb_rcvctrlpipe(serial->dev, 0),
791 PALM_GET_EXT_CONNECTION_INFORMATION,
792 0xc2, 0x0000, 0x0000, transfer_buffer,
793 sizeof (*connection_info), 300);
795 dev_err(dev, "%s - error %d getting connection info\n",
796 __FUNCTION__, retval);
798 usb_serial_debug_data (__FILE__, __FUNCTION__, 0x14, transfer_buffer);
800 kfree (transfer_buffer);
805 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
808 int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
810 dbg("%s", __FUNCTION__);
812 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
813 err("active config #%d != 1 ??",
814 serial->dev->actconfig->desc.bConfigurationValue);
818 if (id->driver_info) {
819 startup = (void *)id->driver_info;
820 retval = startup(serial, id);
826 static int visor_calc_num_ports (struct usb_serial *serial)
828 int num_ports = (int)(long)(usb_get_serial_data(serial));
831 usb_set_serial_data(serial, NULL);
836 static int clie_3_5_startup (struct usb_serial *serial)
838 struct device *dev = &serial->dev->dev;
842 dbg("%s", __FUNCTION__);
845 * Note that PEG-300 series devices expect the following two calls.
848 /* get the config number */
849 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
850 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
851 0, 0, &data, 1, HZ * 3);
853 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
857 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
861 /* get the interface number */
862 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
863 USB_REQ_GET_INTERFACE,
864 USB_DIR_IN | USB_RECIP_INTERFACE,
865 0, 0, &data, 1, HZ * 3);
867 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
871 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
878 static int treo_attach (struct usb_serial *serial)
880 struct usb_serial_port *swap_port;
882 /* Only do this endpoint hack for the Handspring devices with
883 * interrupt in endpoints, which for now are the Treo devices. */
884 if ((serial->dev->descriptor.idVendor != HANDSPRING_VENDOR_ID) ||
885 (serial->num_interrupt_in == 0))
888 dbg("%s", __FUNCTION__);
891 * It appears that Treos want to use the 1st interrupt endpoint to
892 * communicate with the 2nd bulk out endpoint, so let's swap the 1st
893 * and 2nd bulk in and interrupt endpoints. Note that swapping the
894 * bulk out endpoints would break lots of apps that want to communicate
895 * on the second port.
897 #define COPY_PORT(dest, src) \
898 dest->read_urb = src->read_urb; \
899 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
900 dest->bulk_in_buffer = src->bulk_in_buffer; \
901 dest->interrupt_in_urb = src->interrupt_in_urb; \
902 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
903 dest->interrupt_in_buffer = src->interrupt_in_buffer;
905 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
908 COPY_PORT(swap_port, serial->port[0]);
909 COPY_PORT(serial->port[0], serial->port[1]);
910 COPY_PORT(serial->port[1], swap_port);
916 static int clie_5_attach (struct usb_serial *serial)
918 dbg("%s", __FUNCTION__);
920 /* TH55 registers 2 ports.
921 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
922 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
924 Lets do a quick and dirty mapping
927 /* some sanity check */
928 if (serial->num_ports < 2)
931 /* port 0 now uses the modified endpoint Address */
932 serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
937 static void visor_shutdown (struct usb_serial *serial)
939 dbg("%s", __FUNCTION__);
942 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
944 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
950 /* This function is all nice and good, but we don't change anything based on it :) */
951 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios)
955 dbg("%s - port %d", __FUNCTION__, port->number);
957 if ((!port->tty) || (!port->tty->termios)) {
958 dbg("%s - no tty structures", __FUNCTION__);
962 cflag = port->tty->termios->c_cflag;
963 /* check that they really want us to change something */
965 if ((cflag == old_termios->c_cflag) &&
966 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
967 dbg("%s - nothing to change...", __FUNCTION__);
972 /* get the byte size */
973 switch (cflag & CSIZE) {
974 case CS5: dbg("%s - data bits = 5", __FUNCTION__); break;
975 case CS6: dbg("%s - data bits = 6", __FUNCTION__); break;
976 case CS7: dbg("%s - data bits = 7", __FUNCTION__); break;
978 case CS8: dbg("%s - data bits = 8", __FUNCTION__); break;
981 /* determine the parity */
984 dbg("%s - parity = odd", __FUNCTION__);
986 dbg("%s - parity = even", __FUNCTION__);
988 dbg("%s - parity = none", __FUNCTION__);
990 /* figure out the stop bits requested */
992 dbg("%s - stop bits = 2", __FUNCTION__);
994 dbg("%s - stop bits = 1", __FUNCTION__);
997 /* figure out the flow control settings */
999 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
1001 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
1003 /* determine software flow control */
1004 if (I_IXOFF(port->tty))
1005 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
1006 __FUNCTION__, START_CHAR(port->tty), STOP_CHAR(port->tty));
1008 dbg("%s - XON/XOFF is disabled", __FUNCTION__);
1010 /* get the baud rate wanted */
1011 dbg("%s - baud rate = %d", __FUNCTION__, tty_get_baud_rate(port->tty));
1017 static int __init visor_init (void)
1020 /* Only if parameters were passed to us */
1021 if ((vendor>0) && (product>0)) {
1022 struct usb_device_id usb_dev_temp[]=
1023 {{USB_DEVICE(vendor, product),
1024 .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
1026 /* Find the last entry in id_table */
1028 if (id_table[i].idVendor==0) {
1029 id_table[i] = usb_dev_temp[0];
1033 /* Find the last entry in id_table_combined */
1035 if (id_table_combined[i].idVendor==0) {
1036 id_table_combined[i] = usb_dev_temp[0];
1040 info("Untested USB device specified at time of module insertion");
1041 info("Warning: This is not guaranteed to work");
1042 info("Using a newer kernel is preferred to this method");
1043 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1046 retval = usb_serial_register(&handspring_device);
1048 goto failed_handspring_register;
1049 retval = usb_serial_register(&clie_3_5_device);
1051 goto failed_clie_3_5_register;
1052 retval = usb_serial_register(&clie_5_device);
1054 goto failed_clie_5_register;
1055 retval = usb_register(&visor_driver);
1057 goto failed_usb_register;
1058 info(DRIVER_DESC " " DRIVER_VERSION);
1061 failed_usb_register:
1062 usb_serial_deregister(&clie_5_device);
1063 failed_clie_5_register:
1064 usb_serial_deregister(&clie_3_5_device);
1065 failed_clie_3_5_register:
1066 usb_serial_deregister(&handspring_device);
1067 failed_handspring_register:
1072 static void __exit visor_exit (void)
1074 usb_deregister (&visor_driver);
1075 usb_serial_deregister (&handspring_device);
1076 usb_serial_deregister (&clie_3_5_device);
1077 usb_serial_deregister (&clie_5_device);
1081 module_init(visor_init);
1082 module_exit(visor_exit);
1084 MODULE_AUTHOR( DRIVER_AUTHOR );
1085 MODULE_DESCRIPTION( DRIVER_DESC );
1086 MODULE_LICENSE("GPL");
1088 module_param(debug, bool, S_IRUGO | S_IWUSR);
1089 MODULE_PARM_DESC(debug, "Debug enabled or not");
1091 module_param(vendor, ushort, 0);
1092 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1093 module_param(product, ushort, 0);
1094 MODULE_PARM_DESC(product, "User specified product ID");