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>
158 #include "usb-serial.h"
162 * Version Information
164 #define DRIVER_VERSION "v2.1"
165 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
166 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
168 /* function prototypes for a handspring visor */
169 static int visor_open (struct usb_serial_port *port, struct file *filp);
170 static void visor_close (struct usb_serial_port *port, struct file *filp);
171 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count);
172 static int visor_write_room (struct usb_serial_port *port);
173 static int visor_chars_in_buffer (struct usb_serial_port *port);
174 static void visor_throttle (struct usb_serial_port *port);
175 static void visor_unthrottle (struct usb_serial_port *port);
176 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id);
177 static int visor_calc_num_ports(struct usb_serial *serial);
178 static void visor_shutdown (struct usb_serial *serial);
179 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
180 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios);
181 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
182 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
183 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs);
184 static int clie_3_5_startup (struct usb_serial *serial);
185 static int treo_attach (struct usb_serial *serial);
186 static int clie_5_attach (struct usb_serial *serial);
187 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id);
188 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id);
190 /* Parameters that may be passed into the module. */
193 static __u16 product;
195 static struct usb_device_id id_table [] = {
196 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
197 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
198 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
199 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
200 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
201 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
202 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
203 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
204 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
205 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
206 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
207 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
208 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
209 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
210 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
211 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
212 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
213 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
214 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
215 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
216 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
217 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
218 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
219 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
220 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID),
221 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
222 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
223 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
224 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
225 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
226 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
227 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
228 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
229 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
230 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
231 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
232 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
233 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
234 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
235 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
236 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
237 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
238 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
239 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
240 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
241 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
242 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
243 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
244 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
245 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
246 { }, /* optional parameter entry */
247 { } /* Terminating entry */
250 static struct usb_device_id clie_id_5_table [] = {
251 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
252 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
253 { }, /* optional parameter entry */
254 { } /* Terminating entry */
257 static struct usb_device_id clie_id_3_5_table [] = {
258 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
259 { } /* Terminating entry */
262 static struct usb_device_id id_table_combined [] = {
263 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
264 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
265 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
266 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
267 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
268 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
269 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
270 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
271 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
272 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
273 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
274 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
275 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID) },
276 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
277 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
278 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
279 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
280 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
281 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
282 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
283 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
284 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
285 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
286 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
287 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
288 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
289 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
290 { }, /* optional parameter entry */
291 { } /* Terminating entry */
294 MODULE_DEVICE_TABLE (usb, id_table_combined);
296 static struct usb_driver visor_driver = {
297 .owner = THIS_MODULE,
299 .probe = usb_serial_probe,
300 .disconnect = usb_serial_disconnect,
301 .id_table = id_table_combined,
304 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
305 static struct usb_serial_device_type handspring_device = {
306 .owner = THIS_MODULE,
307 .name = "Handspring Visor / Palm OS",
308 .short_name = "visor",
309 .id_table = id_table,
310 .num_interrupt_in = NUM_DONT_CARE,
315 .close = visor_close,
316 .throttle = visor_throttle,
317 .unthrottle = visor_unthrottle,
318 .attach = treo_attach,
319 .probe = visor_probe,
320 .calc_num_ports = visor_calc_num_ports,
321 .shutdown = visor_shutdown,
322 .ioctl = visor_ioctl,
323 .set_termios = visor_set_termios,
324 .write = visor_write,
325 .write_room = visor_write_room,
326 .chars_in_buffer = visor_chars_in_buffer,
327 .write_bulk_callback = visor_write_bulk_callback,
328 .read_bulk_callback = visor_read_bulk_callback,
329 .read_int_callback = visor_read_int_callback,
332 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
333 static struct usb_serial_device_type clie_5_device = {
334 .owner = THIS_MODULE,
335 .name = "Sony Clie 5.0",
336 .short_name = "clie_5",
337 .id_table = clie_id_5_table,
338 .num_interrupt_in = NUM_DONT_CARE,
343 .close = visor_close,
344 .throttle = visor_throttle,
345 .unthrottle = visor_unthrottle,
346 .attach = clie_5_attach,
347 .probe = visor_probe,
348 .calc_num_ports = visor_calc_num_ports,
349 .shutdown = visor_shutdown,
350 .ioctl = visor_ioctl,
351 .set_termios = visor_set_termios,
352 .write = visor_write,
353 .write_room = visor_write_room,
354 .chars_in_buffer = visor_chars_in_buffer,
355 .write_bulk_callback = visor_write_bulk_callback,
356 .read_bulk_callback = visor_read_bulk_callback,
357 .read_int_callback = visor_read_int_callback,
360 /* device info for the Sony Clie OS version 3.5 */
361 static struct usb_serial_device_type clie_3_5_device = {
362 .owner = THIS_MODULE,
363 .name = "Sony Clie 3.5",
364 .short_name = "clie_3.5",
365 .id_table = clie_id_3_5_table,
366 .num_interrupt_in = 0,
371 .close = visor_close,
372 .throttle = visor_throttle,
373 .unthrottle = visor_unthrottle,
374 .attach = clie_3_5_startup,
375 .ioctl = visor_ioctl,
376 .set_termios = visor_set_termios,
377 .write = visor_write,
378 .write_room = visor_write_room,
379 .chars_in_buffer = visor_chars_in_buffer,
380 .write_bulk_callback = visor_write_bulk_callback,
381 .read_bulk_callback = visor_read_bulk_callback,
384 struct visor_private {
388 int outstanding_urbs;
391 /* number of outstanding urbs to prevent userspace DoS from happening */
392 #define URB_UPPER_LIMIT 42
396 /******************************************************************************
397 * Handspring Visor specific driver functions
398 ******************************************************************************/
399 static int visor_open (struct usb_serial_port *port, struct file *filp)
401 struct usb_serial *serial = port->serial;
402 struct visor_private *priv = usb_get_serial_port_data(port);
406 dbg("%s - port %d", __FUNCTION__, port->number);
408 if (!port->read_urb) {
409 /* this is needed for some brain dead Sony devices */
410 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
414 spin_lock_irqsave(&priv->lock, flags);
417 priv->outstanding_urbs = 0;
418 spin_unlock_irqrestore(&priv->lock, flags);
421 * Force low_latency on so that our tty_push actually forces the data
422 * through, otherwise it is scheduled, and with high data rates (like
423 * with OHCI) data can get lost.
426 port->tty->low_latency = 1;
428 /* Start reading from the device */
429 usb_fill_bulk_urb (port->read_urb, serial->dev,
430 usb_rcvbulkpipe (serial->dev,
431 port->bulk_in_endpointAddress),
432 port->read_urb->transfer_buffer,
433 port->read_urb->transfer_buffer_length,
434 visor_read_bulk_callback, port);
435 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
437 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
438 __FUNCTION__, result);
442 if (port->interrupt_in_urb) {
443 dbg("%s - adding interrupt input for treo", __FUNCTION__);
444 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
446 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
447 __FUNCTION__, result);
454 static void visor_close (struct usb_serial_port *port, struct file * filp)
456 struct visor_private *priv = usb_get_serial_port_data(port);
457 unsigned char *transfer_buffer;
459 dbg("%s - port %d", __FUNCTION__, port->number);
461 /* shutdown our urbs */
462 usb_kill_urb(port->read_urb);
463 if (port->interrupt_in_urb)
464 usb_kill_urb(port->interrupt_in_urb);
466 /* Try to send shutdown message, if the device is gone, this will just fail. */
467 transfer_buffer = kmalloc (0x12, GFP_KERNEL);
468 if (transfer_buffer) {
469 usb_control_msg (port->serial->dev,
470 usb_rcvctrlpipe(port->serial->dev, 0),
471 VISOR_CLOSE_NOTIFICATION, 0xc2,
473 transfer_buffer, 0x12, 300);
474 kfree (transfer_buffer);
478 dev_info(&port->dev, "Bytes In = %d Bytes Out = %d\n",
479 priv->bytes_in, priv->bytes_out);
483 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count)
485 struct visor_private *priv = usb_get_serial_port_data(port);
486 struct usb_serial *serial = port->serial;
488 unsigned char *buffer;
492 dbg("%s - port %d", __FUNCTION__, port->number);
494 spin_lock_irqsave(&priv->lock, flags);
495 if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
496 spin_unlock_irqrestore(&priv->lock, flags);
497 dbg("%s - write limit hit\n", __FUNCTION__);
500 spin_unlock_irqrestore(&priv->lock, flags);
502 buffer = kmalloc (count, GFP_ATOMIC);
504 dev_err(&port->dev, "out of memory\n");
508 urb = usb_alloc_urb(0, GFP_ATOMIC);
510 dev_err(&port->dev, "no more free urbs\n");
515 memcpy (buffer, buf, count);
517 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
519 usb_fill_bulk_urb (urb, serial->dev,
520 usb_sndbulkpipe (serial->dev,
521 port->bulk_out_endpointAddress),
523 visor_write_bulk_callback, port);
525 /* send it down the pipe */
526 status = usb_submit_urb(urb, GFP_ATOMIC);
528 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
529 __FUNCTION__, status);
533 spin_lock_irqsave(&priv->lock, flags);
534 ++priv->outstanding_urbs;
535 priv->bytes_out += count;
536 spin_unlock_irqrestore(&priv->lock, flags);
539 /* we are done with this urb, so let the host driver
540 * really free it when it is finished with it */
547 static int visor_write_room (struct usb_serial_port *port)
549 dbg("%s - port %d", __FUNCTION__, port->number);
552 * We really can take anything the user throws at us
553 * but let's pick a nice big number to tell the tty
554 * layer that we have lots of free space
560 static int visor_chars_in_buffer (struct usb_serial_port *port)
562 dbg("%s - port %d", __FUNCTION__, port->number);
565 * We can't really account for how much data we
566 * have sent out, but hasn't made it through to the
567 * device, so just tell the tty layer that everything
574 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
576 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
577 struct visor_private *priv = usb_get_serial_port_data(port);
580 /* free up the transfer buffer, as usb_free_urb() does not do this */
581 kfree (urb->transfer_buffer);
583 dbg("%s - port %d", __FUNCTION__, port->number);
586 dbg("%s - nonzero write bulk status received: %d",
587 __FUNCTION__, urb->status);
589 spin_lock_irqsave(&priv->lock, flags);
590 --priv->outstanding_urbs;
591 spin_unlock_irqrestore(&priv->lock, flags);
593 schedule_work(&port->work);
597 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
599 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
600 struct visor_private *priv = usb_get_serial_port_data(port);
601 unsigned char *data = urb->transfer_buffer;
602 struct tty_struct *tty;
607 dbg("%s - port %d", __FUNCTION__, port->number);
610 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
614 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
617 if (tty && urb->actual_length) {
618 for (i = 0; i < urb->actual_length ; ++i) {
619 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
620 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
621 tty_flip_buffer_push(tty);
623 /* this doesn't actually push the data through unless tty->low_latency is set */
624 tty_insert_flip_char(tty, data[i], 0);
626 tty_flip_buffer_push(tty);
628 spin_lock_irqsave(&priv->lock, flags);
629 priv->bytes_in += urb->actual_length;
630 spin_unlock_irqrestore(&priv->lock, flags);
632 /* Continue trying to always read */
633 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
634 usb_rcvbulkpipe(port->serial->dev,
635 port->bulk_in_endpointAddress),
636 port->read_urb->transfer_buffer,
637 port->read_urb->transfer_buffer_length,
638 visor_read_bulk_callback, port);
639 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
641 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
645 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs)
647 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
650 switch (urb->status) {
657 /* this urb is terminated, clean up */
658 dbg("%s - urb shutting down with status: %d",
659 __FUNCTION__, urb->status);
662 dbg("%s - nonzero urb status received: %d",
663 __FUNCTION__, urb->status);
668 * This information is still unknown what it can be used for.
669 * If anyone has an idea, please let the author know...
671 * Rumor has it this endpoint is used to notify when data
672 * is ready to be read from the bulk ones.
674 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
675 urb->actual_length, urb->transfer_buffer);
678 result = usb_submit_urb (urb, GFP_ATOMIC);
680 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
681 __FUNCTION__, result);
684 static void visor_throttle (struct usb_serial_port *port)
686 dbg("%s - port %d", __FUNCTION__, port->number);
687 usb_kill_urb(port->read_urb);
691 static void visor_unthrottle (struct usb_serial_port *port)
695 dbg("%s - port %d", __FUNCTION__, port->number);
697 port->read_urb->dev = port->serial->dev;
698 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
700 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
703 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
705 struct device *dev = &serial->dev->dev;
706 struct visor_connection_info *connection_info;
707 unsigned char *transfer_buffer;
713 dbg("%s", __FUNCTION__);
715 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
716 if (!transfer_buffer) {
717 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
718 sizeof(*connection_info));
722 /* send a get connection info request */
723 retval = usb_control_msg (serial->dev,
724 usb_rcvctrlpipe(serial->dev, 0),
725 VISOR_GET_CONNECTION_INFORMATION,
726 0xc2, 0x0000, 0x0000, transfer_buffer,
727 sizeof(*connection_info), 300);
729 dev_err(dev, "%s - error %d getting connection information\n",
730 __FUNCTION__, retval);
734 if (retval == sizeof(*connection_info)) {
735 connection_info = (struct visor_connection_info *)transfer_buffer;
737 num_ports = le16_to_cpu(connection_info->num_ports);
738 for (i = 0; i < num_ports; ++i) {
739 switch (connection_info->connections[i].port_function_id) {
740 case VISOR_FUNCTION_GENERIC:
743 case VISOR_FUNCTION_DEBUGGER:
746 case VISOR_FUNCTION_HOTSYNC:
749 case VISOR_FUNCTION_CONSOLE:
752 case VISOR_FUNCTION_REMOTE_FILE_SYS:
753 string = "Remote File System";
759 dev_info(dev, "%s: port %d, is for %s use\n",
761 connection_info->connections[i].port, string);
765 * Handle devices that report invalid stuff here.
767 if (num_ports == 0 || num_ports > 2) {
768 dev_warn (dev, "%s: No valid connect info available\n",
773 dev_info(dev, "%s: Number of ports: %d\n", serial->type->name,
777 * save off our num_ports info so that we can use it in the
778 * calc_num_ports callback
780 usb_set_serial_data(serial, (void *)(long)num_ports);
782 /* ask for the number of bytes available, but ignore the response as it is broken */
783 retval = usb_control_msg (serial->dev,
784 usb_rcvctrlpipe(serial->dev, 0),
785 VISOR_REQUEST_BYTES_AVAILABLE,
786 0xc2, 0x0000, 0x0005, transfer_buffer,
789 dev_err(dev, "%s - error %d getting bytes available request\n",
790 __FUNCTION__, retval);
794 kfree (transfer_buffer);
799 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
801 struct device *dev = &serial->dev->dev;
802 struct palm_ext_connection_info *connection_info;
803 unsigned char *transfer_buffer;
806 dbg("%s", __FUNCTION__);
808 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
809 if (!transfer_buffer) {
810 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
811 sizeof(*connection_info));
815 retval = usb_control_msg (serial->dev,
816 usb_rcvctrlpipe(serial->dev, 0),
817 PALM_GET_EXT_CONNECTION_INFORMATION,
818 0xc2, 0x0000, 0x0000, transfer_buffer,
819 sizeof (*connection_info), 300);
821 dev_err(dev, "%s - error %d getting connection info\n",
822 __FUNCTION__, retval);
824 usb_serial_debug_data(debug, &serial->dev->dev, __FUNCTION__,
825 retval, transfer_buffer);
827 kfree (transfer_buffer);
832 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
835 int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
837 dbg("%s", __FUNCTION__);
839 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
840 err("active config #%d != 1 ??",
841 serial->dev->actconfig->desc.bConfigurationValue);
845 if (id->driver_info) {
846 startup = (void *)id->driver_info;
847 retval = startup(serial, id);
853 static int visor_calc_num_ports (struct usb_serial *serial)
855 int num_ports = (int)(long)(usb_get_serial_data(serial));
858 usb_set_serial_data(serial, NULL);
863 static int generic_startup(struct usb_serial *serial)
865 struct visor_private *priv;
868 for (i = 0; i < serial->num_ports; ++i) {
869 priv = kmalloc (sizeof(*priv), GFP_KERNEL);
872 memset (priv, 0x00, sizeof(*priv));
873 spin_lock_init(&priv->lock);
874 usb_set_serial_port_data(serial->port[i], priv);
879 static int clie_3_5_startup (struct usb_serial *serial)
881 struct device *dev = &serial->dev->dev;
885 dbg("%s", __FUNCTION__);
888 * Note that PEG-300 series devices expect the following two calls.
891 /* get the config number */
892 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
893 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
894 0, 0, &data, 1, HZ * 3);
896 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
900 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
904 /* get the interface number */
905 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
906 USB_REQ_GET_INTERFACE,
907 USB_DIR_IN | USB_RECIP_INTERFACE,
908 0, 0, &data, 1, HZ * 3);
910 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
914 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
918 return generic_startup(serial);
921 static int treo_attach (struct usb_serial *serial)
923 struct usb_serial_port *swap_port;
925 /* Only do this endpoint hack for the Handspring devices with
926 * interrupt in endpoints, which for now are the Treo devices. */
927 if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
928 (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
929 (serial->num_interrupt_in == 0))
930 goto generic_startup;
932 dbg("%s", __FUNCTION__);
935 * It appears that Treos and Kyoceras want to use the
936 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
937 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
938 * Note that swapping the bulk out endpoints would break lots of
939 * apps that want to communicate on the second port.
941 #define COPY_PORT(dest, src) \
942 dest->read_urb = src->read_urb; \
943 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
944 dest->bulk_in_buffer = src->bulk_in_buffer; \
945 dest->interrupt_in_urb = src->interrupt_in_urb; \
946 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
947 dest->interrupt_in_buffer = src->interrupt_in_buffer;
949 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
952 COPY_PORT(swap_port, serial->port[0]);
953 COPY_PORT(serial->port[0], serial->port[1]);
954 COPY_PORT(serial->port[1], swap_port);
958 return generic_startup(serial);
961 static int clie_5_attach (struct usb_serial *serial)
963 dbg("%s", __FUNCTION__);
965 /* TH55 registers 2 ports.
966 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
967 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
969 Lets do a quick and dirty mapping
972 /* some sanity check */
973 if (serial->num_ports < 2)
976 /* port 0 now uses the modified endpoint Address */
977 serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
979 return generic_startup(serial);
982 static void visor_shutdown (struct usb_serial *serial)
984 dbg("%s", __FUNCTION__);
987 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
989 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
995 /* This function is all nice and good, but we don't change anything based on it :) */
996 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1000 dbg("%s - port %d", __FUNCTION__, port->number);
1002 if ((!port->tty) || (!port->tty->termios)) {
1003 dbg("%s - no tty structures", __FUNCTION__);
1007 cflag = port->tty->termios->c_cflag;
1008 /* check that they really want us to change something */
1010 if ((cflag == old_termios->c_cflag) &&
1011 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
1012 dbg("%s - nothing to change...", __FUNCTION__);
1017 /* get the byte size */
1018 switch (cflag & CSIZE) {
1019 case CS5: dbg("%s - data bits = 5", __FUNCTION__); break;
1020 case CS6: dbg("%s - data bits = 6", __FUNCTION__); break;
1021 case CS7: dbg("%s - data bits = 7", __FUNCTION__); break;
1023 case CS8: dbg("%s - data bits = 8", __FUNCTION__); break;
1026 /* determine the parity */
1029 dbg("%s - parity = odd", __FUNCTION__);
1031 dbg("%s - parity = even", __FUNCTION__);
1033 dbg("%s - parity = none", __FUNCTION__);
1035 /* figure out the stop bits requested */
1037 dbg("%s - stop bits = 2", __FUNCTION__);
1039 dbg("%s - stop bits = 1", __FUNCTION__);
1042 /* figure out the flow control settings */
1043 if (cflag & CRTSCTS)
1044 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
1046 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
1048 /* determine software flow control */
1049 if (I_IXOFF(port->tty))
1050 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
1051 __FUNCTION__, START_CHAR(port->tty), STOP_CHAR(port->tty));
1053 dbg("%s - XON/XOFF is disabled", __FUNCTION__);
1055 /* get the baud rate wanted */
1056 dbg("%s - baud rate = %d", __FUNCTION__, tty_get_baud_rate(port->tty));
1062 static int __init visor_init (void)
1065 /* Only if parameters were passed to us */
1066 if ((vendor>0) && (product>0)) {
1067 struct usb_device_id usb_dev_temp[]=
1068 {{USB_DEVICE(vendor, product),
1069 .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
1071 /* Find the last entry in id_table */
1073 if (id_table[i].idVendor==0) {
1074 id_table[i] = usb_dev_temp[0];
1078 /* Find the last entry in id_table_combined */
1080 if (id_table_combined[i].idVendor==0) {
1081 id_table_combined[i] = usb_dev_temp[0];
1085 info("Untested USB device specified at time of module insertion");
1086 info("Warning: This is not guaranteed to work");
1087 info("Using a newer kernel is preferred to this method");
1088 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1091 retval = usb_serial_register(&handspring_device);
1093 goto failed_handspring_register;
1094 retval = usb_serial_register(&clie_3_5_device);
1096 goto failed_clie_3_5_register;
1097 retval = usb_serial_register(&clie_5_device);
1099 goto failed_clie_5_register;
1100 retval = usb_register(&visor_driver);
1102 goto failed_usb_register;
1103 info(DRIVER_DESC " " DRIVER_VERSION);
1106 failed_usb_register:
1107 usb_serial_deregister(&clie_5_device);
1108 failed_clie_5_register:
1109 usb_serial_deregister(&clie_3_5_device);
1110 failed_clie_3_5_register:
1111 usb_serial_deregister(&handspring_device);
1112 failed_handspring_register:
1117 static void __exit visor_exit (void)
1119 usb_deregister (&visor_driver);
1120 usb_serial_deregister (&handspring_device);
1121 usb_serial_deregister (&clie_3_5_device);
1122 usb_serial_deregister (&clie_5_device);
1126 module_init(visor_init);
1127 module_exit(visor_exit);
1129 MODULE_AUTHOR( DRIVER_AUTHOR );
1130 MODULE_DESCRIPTION( DRIVER_DESC );
1131 MODULE_LICENSE("GPL");
1133 module_param(debug, bool, S_IRUGO | S_IWUSR);
1134 MODULE_PARM_DESC(debug, "Debug enabled or not");
1135 module_param(stats, bool, S_IRUGO | S_IWUSR);
1136 MODULE_PARM_DESC(stats, "Enables statistics or not");
1138 module_param(vendor, ushort, 0);
1139 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1140 module_param(product, ushort, 0);
1141 MODULE_PARM_DESC(product, "User specified product ID");