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_TREO_650),
219 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
220 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
221 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
222 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID),
223 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
224 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
225 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
226 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
227 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
228 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
229 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
230 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
231 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
232 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
233 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
234 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
235 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
236 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
237 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
238 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
239 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
240 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
241 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
242 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
243 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
244 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
245 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
246 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
247 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
248 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
249 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
250 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
251 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
252 { }, /* optional parameter entry */
253 { } /* Terminating entry */
256 static struct usb_device_id clie_id_5_table [] = {
257 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
258 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
259 { }, /* optional parameter entry */
260 { } /* Terminating entry */
263 static struct usb_device_id clie_id_3_5_table [] = {
264 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
265 { } /* Terminating entry */
268 static struct usb_device_id id_table_combined [] = {
269 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
270 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
271 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
272 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
273 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
274 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
275 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
276 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
277 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
278 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
279 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
280 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
281 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
282 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_ID) },
283 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
284 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
285 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
286 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
287 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
288 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
289 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
290 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
291 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
292 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
293 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
294 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
295 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
296 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
297 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
298 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
299 { }, /* optional parameter entry */
300 { } /* Terminating entry */
303 MODULE_DEVICE_TABLE (usb, id_table_combined);
305 static struct usb_driver visor_driver = {
306 .owner = THIS_MODULE,
308 .probe = usb_serial_probe,
309 .disconnect = usb_serial_disconnect,
310 .id_table = id_table_combined,
313 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
314 static struct usb_serial_driver handspring_device = {
316 .owner = THIS_MODULE,
318 .name = "Handspring Visor / Palm OS",
319 .short_name = "visor",
320 .id_table = id_table,
321 .num_interrupt_in = NUM_DONT_CARE,
326 .close = visor_close,
327 .throttle = visor_throttle,
328 .unthrottle = visor_unthrottle,
329 .attach = treo_attach,
330 .probe = visor_probe,
331 .calc_num_ports = visor_calc_num_ports,
332 .shutdown = visor_shutdown,
333 .ioctl = visor_ioctl,
334 .set_termios = visor_set_termios,
335 .write = visor_write,
336 .write_room = visor_write_room,
337 .chars_in_buffer = visor_chars_in_buffer,
338 .write_bulk_callback = visor_write_bulk_callback,
339 .read_bulk_callback = visor_read_bulk_callback,
340 .read_int_callback = visor_read_int_callback,
343 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
344 static struct usb_serial_driver clie_5_device = {
346 .owner = THIS_MODULE,
348 .name = "Sony Clie 5.0",
349 .short_name = "clie_5",
350 .id_table = clie_id_5_table,
351 .num_interrupt_in = NUM_DONT_CARE,
356 .close = visor_close,
357 .throttle = visor_throttle,
358 .unthrottle = visor_unthrottle,
359 .attach = clie_5_attach,
360 .probe = visor_probe,
361 .calc_num_ports = visor_calc_num_ports,
362 .shutdown = visor_shutdown,
363 .ioctl = visor_ioctl,
364 .set_termios = visor_set_termios,
365 .write = visor_write,
366 .write_room = visor_write_room,
367 .chars_in_buffer = visor_chars_in_buffer,
368 .write_bulk_callback = visor_write_bulk_callback,
369 .read_bulk_callback = visor_read_bulk_callback,
370 .read_int_callback = visor_read_int_callback,
373 /* device info for the Sony Clie OS version 3.5 */
374 static struct usb_serial_driver clie_3_5_device = {
376 .owner = THIS_MODULE,
378 .name = "Sony Clie 3.5",
379 .short_name = "clie_3.5",
380 .id_table = clie_id_3_5_table,
381 .num_interrupt_in = 0,
386 .close = visor_close,
387 .throttle = visor_throttle,
388 .unthrottle = visor_unthrottle,
389 .attach = clie_3_5_startup,
390 .ioctl = visor_ioctl,
391 .set_termios = visor_set_termios,
392 .write = visor_write,
393 .write_room = visor_write_room,
394 .chars_in_buffer = visor_chars_in_buffer,
395 .write_bulk_callback = visor_write_bulk_callback,
396 .read_bulk_callback = visor_read_bulk_callback,
399 struct visor_private {
403 int outstanding_urbs;
407 /* number of outstanding urbs to prevent userspace DoS from happening */
408 #define URB_UPPER_LIMIT 42
412 /******************************************************************************
413 * Handspring Visor specific driver functions
414 ******************************************************************************/
415 static int visor_open (struct usb_serial_port *port, struct file *filp)
417 struct usb_serial *serial = port->serial;
418 struct visor_private *priv = usb_get_serial_port_data(port);
422 dbg("%s - port %d", __FUNCTION__, port->number);
424 if (!port->read_urb) {
425 /* this is needed for some brain dead Sony devices */
426 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
430 spin_lock_irqsave(&priv->lock, flags);
433 priv->outstanding_urbs = 0;
435 spin_unlock_irqrestore(&priv->lock, flags);
438 * Force low_latency on so that our tty_push actually forces the data
439 * through, otherwise it is scheduled, and with high data rates (like
440 * with OHCI) data can get lost.
443 port->tty->low_latency = 1;
445 /* Start reading from the device */
446 usb_fill_bulk_urb (port->read_urb, serial->dev,
447 usb_rcvbulkpipe (serial->dev,
448 port->bulk_in_endpointAddress),
449 port->read_urb->transfer_buffer,
450 port->read_urb->transfer_buffer_length,
451 visor_read_bulk_callback, port);
452 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
454 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
455 __FUNCTION__, result);
459 if (port->interrupt_in_urb) {
460 dbg("%s - adding interrupt input for treo", __FUNCTION__);
461 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
463 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
464 __FUNCTION__, result);
471 static void visor_close (struct usb_serial_port *port, struct file * filp)
473 struct visor_private *priv = usb_get_serial_port_data(port);
474 unsigned char *transfer_buffer;
476 dbg("%s - port %d", __FUNCTION__, port->number);
478 /* shutdown our urbs */
479 usb_kill_urb(port->read_urb);
480 if (port->interrupt_in_urb)
481 usb_kill_urb(port->interrupt_in_urb);
483 /* Try to send shutdown message, if the device is gone, this will just fail. */
484 transfer_buffer = kmalloc (0x12, GFP_KERNEL);
485 if (transfer_buffer) {
486 usb_control_msg (port->serial->dev,
487 usb_rcvctrlpipe(port->serial->dev, 0),
488 VISOR_CLOSE_NOTIFICATION, 0xc2,
490 transfer_buffer, 0x12, 300);
491 kfree (transfer_buffer);
495 dev_info(&port->dev, "Bytes In = %d Bytes Out = %d\n",
496 priv->bytes_in, priv->bytes_out);
500 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count)
502 struct visor_private *priv = usb_get_serial_port_data(port);
503 struct usb_serial *serial = port->serial;
505 unsigned char *buffer;
509 dbg("%s - port %d", __FUNCTION__, port->number);
511 spin_lock_irqsave(&priv->lock, flags);
512 if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
513 spin_unlock_irqrestore(&priv->lock, flags);
514 dbg("%s - write limit hit\n", __FUNCTION__);
517 spin_unlock_irqrestore(&priv->lock, flags);
519 buffer = kmalloc (count, GFP_ATOMIC);
521 dev_err(&port->dev, "out of memory\n");
525 urb = usb_alloc_urb(0, GFP_ATOMIC);
527 dev_err(&port->dev, "no more free urbs\n");
532 memcpy (buffer, buf, count);
534 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
536 usb_fill_bulk_urb (urb, serial->dev,
537 usb_sndbulkpipe (serial->dev,
538 port->bulk_out_endpointAddress),
540 visor_write_bulk_callback, port);
542 /* send it down the pipe */
543 status = usb_submit_urb(urb, GFP_ATOMIC);
545 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
546 __FUNCTION__, status);
550 spin_lock_irqsave(&priv->lock, flags);
551 ++priv->outstanding_urbs;
552 priv->bytes_out += count;
553 spin_unlock_irqrestore(&priv->lock, flags);
556 /* we are done with this urb, so let the host driver
557 * really free it when it is finished with it */
564 static int visor_write_room (struct usb_serial_port *port)
566 dbg("%s - port %d", __FUNCTION__, port->number);
569 * We really can take anything the user throws at us
570 * but let's pick a nice big number to tell the tty
571 * layer that we have lots of free space
577 static int visor_chars_in_buffer (struct usb_serial_port *port)
579 dbg("%s - port %d", __FUNCTION__, port->number);
582 * We can't really account for how much data we
583 * have sent out, but hasn't made it through to the
584 * device, so just tell the tty layer that everything
591 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
593 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
594 struct visor_private *priv = usb_get_serial_port_data(port);
597 /* free up the transfer buffer, as usb_free_urb() does not do this */
598 kfree (urb->transfer_buffer);
600 dbg("%s - port %d", __FUNCTION__, port->number);
603 dbg("%s - nonzero write bulk status received: %d",
604 __FUNCTION__, urb->status);
606 spin_lock_irqsave(&priv->lock, flags);
607 --priv->outstanding_urbs;
608 spin_unlock_irqrestore(&priv->lock, flags);
610 schedule_work(&port->work);
614 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
616 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
617 struct visor_private *priv = usb_get_serial_port_data(port);
618 unsigned char *data = urb->transfer_buffer;
619 struct tty_struct *tty;
625 dbg("%s - port %d", __FUNCTION__, port->number);
628 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
632 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
635 if (tty && urb->actual_length) {
636 for (i = 0; i < urb->actual_length ; ++i) {
637 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
638 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
639 tty_flip_buffer_push(tty);
641 /* this doesn't actually push the data through unless tty->low_latency is set */
642 tty_insert_flip_char(tty, data[i], 0);
644 tty_flip_buffer_push(tty);
646 spin_lock_irqsave(&priv->lock, flags);
647 priv->bytes_in += urb->actual_length;
648 throttled = priv->throttled;
649 spin_unlock_irqrestore(&priv->lock, flags);
651 /* Continue trying to always read if we should */
653 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
654 usb_rcvbulkpipe(port->serial->dev,
655 port->bulk_in_endpointAddress),
656 port->read_urb->transfer_buffer,
657 port->read_urb->transfer_buffer_length,
658 visor_read_bulk_callback, port);
659 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
661 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
666 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs)
668 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
671 switch (urb->status) {
678 /* this urb is terminated, clean up */
679 dbg("%s - urb shutting down with status: %d",
680 __FUNCTION__, urb->status);
683 dbg("%s - nonzero urb status received: %d",
684 __FUNCTION__, urb->status);
689 * This information is still unknown what it can be used for.
690 * If anyone has an idea, please let the author know...
692 * Rumor has it this endpoint is used to notify when data
693 * is ready to be read from the bulk ones.
695 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
696 urb->actual_length, urb->transfer_buffer);
699 result = usb_submit_urb (urb, GFP_ATOMIC);
701 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
702 __FUNCTION__, result);
705 static void visor_throttle (struct usb_serial_port *port)
707 struct visor_private *priv = usb_get_serial_port_data(port);
710 dbg("%s - port %d", __FUNCTION__, port->number);
711 spin_lock_irqsave(&priv->lock, flags);
713 spin_unlock_irqrestore(&priv->lock, flags);
717 static void visor_unthrottle (struct usb_serial_port *port)
719 struct visor_private *priv = usb_get_serial_port_data(port);
723 dbg("%s - port %d", __FUNCTION__, port->number);
724 spin_lock_irqsave(&priv->lock, flags);
726 spin_unlock_irqrestore(&priv->lock, flags);
728 port->read_urb->dev = port->serial->dev;
729 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
731 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
734 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
736 struct device *dev = &serial->dev->dev;
737 struct visor_connection_info *connection_info;
738 unsigned char *transfer_buffer;
744 dbg("%s", __FUNCTION__);
746 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
747 if (!transfer_buffer) {
748 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
749 sizeof(*connection_info));
753 /* send a get connection info request */
754 retval = usb_control_msg (serial->dev,
755 usb_rcvctrlpipe(serial->dev, 0),
756 VISOR_GET_CONNECTION_INFORMATION,
757 0xc2, 0x0000, 0x0000, transfer_buffer,
758 sizeof(*connection_info), 300);
760 dev_err(dev, "%s - error %d getting connection information\n",
761 __FUNCTION__, retval);
765 if (retval == sizeof(*connection_info)) {
766 connection_info = (struct visor_connection_info *)transfer_buffer;
768 num_ports = le16_to_cpu(connection_info->num_ports);
769 for (i = 0; i < num_ports; ++i) {
770 switch (connection_info->connections[i].port_function_id) {
771 case VISOR_FUNCTION_GENERIC:
774 case VISOR_FUNCTION_DEBUGGER:
777 case VISOR_FUNCTION_HOTSYNC:
780 case VISOR_FUNCTION_CONSOLE:
783 case VISOR_FUNCTION_REMOTE_FILE_SYS:
784 string = "Remote File System";
790 dev_info(dev, "%s: port %d, is for %s use\n",
792 connection_info->connections[i].port, string);
796 * Handle devices that report invalid stuff here.
798 if (num_ports == 0 || num_ports > 2) {
799 dev_warn (dev, "%s: No valid connect info available\n",
804 dev_info(dev, "%s: Number of ports: %d\n", serial->type->name,
808 * save off our num_ports info so that we can use it in the
809 * calc_num_ports callback
811 usb_set_serial_data(serial, (void *)(long)num_ports);
813 /* ask for the number of bytes available, but ignore the response as it is broken */
814 retval = usb_control_msg (serial->dev,
815 usb_rcvctrlpipe(serial->dev, 0),
816 VISOR_REQUEST_BYTES_AVAILABLE,
817 0xc2, 0x0000, 0x0005, transfer_buffer,
820 dev_err(dev, "%s - error %d getting bytes available request\n",
821 __FUNCTION__, retval);
825 kfree (transfer_buffer);
830 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
832 struct device *dev = &serial->dev->dev;
833 struct palm_ext_connection_info *connection_info;
834 unsigned char *transfer_buffer;
837 dbg("%s", __FUNCTION__);
839 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
840 if (!transfer_buffer) {
841 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
842 sizeof(*connection_info));
846 retval = usb_control_msg (serial->dev,
847 usb_rcvctrlpipe(serial->dev, 0),
848 PALM_GET_EXT_CONNECTION_INFORMATION,
849 0xc2, 0x0000, 0x0000, transfer_buffer,
850 sizeof (*connection_info), 300);
852 dev_err(dev, "%s - error %d getting connection info\n",
853 __FUNCTION__, retval);
855 usb_serial_debug_data(debug, &serial->dev->dev, __FUNCTION__,
856 retval, transfer_buffer);
858 kfree (transfer_buffer);
863 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
866 int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
868 dbg("%s", __FUNCTION__);
870 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
871 err("active config #%d != 1 ??",
872 serial->dev->actconfig->desc.bConfigurationValue);
876 if (id->driver_info) {
877 startup = (void *)id->driver_info;
878 retval = startup(serial, id);
884 static int visor_calc_num_ports (struct usb_serial *serial)
886 int num_ports = (int)(long)(usb_get_serial_data(serial));
889 usb_set_serial_data(serial, NULL);
894 static int generic_startup(struct usb_serial *serial)
896 struct visor_private *priv;
899 for (i = 0; i < serial->num_ports; ++i) {
900 priv = kmalloc (sizeof(*priv), GFP_KERNEL);
903 memset (priv, 0x00, sizeof(*priv));
904 spin_lock_init(&priv->lock);
905 usb_set_serial_port_data(serial->port[i], priv);
910 static int clie_3_5_startup (struct usb_serial *serial)
912 struct device *dev = &serial->dev->dev;
916 dbg("%s", __FUNCTION__);
919 * Note that PEG-300 series devices expect the following two calls.
922 /* get the config number */
923 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
924 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
925 0, 0, &data, 1, 3000);
927 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
931 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
935 /* get the interface number */
936 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
937 USB_REQ_GET_INTERFACE,
938 USB_DIR_IN | USB_RECIP_INTERFACE,
939 0, 0, &data, 1, 3000);
941 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
945 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
949 return generic_startup(serial);
952 static int treo_attach (struct usb_serial *serial)
954 struct usb_serial_port *swap_port;
956 /* Only do this endpoint hack for the Handspring devices with
957 * interrupt in endpoints, which for now are the Treo devices. */
958 if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
959 (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
960 (serial->num_interrupt_in == 0))
961 goto generic_startup;
963 dbg("%s", __FUNCTION__);
966 * It appears that Treos and Kyoceras want to use the
967 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
968 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
969 * Note that swapping the bulk out endpoints would break lots of
970 * apps that want to communicate on the second port.
972 #define COPY_PORT(dest, src) \
973 dest->read_urb = src->read_urb; \
974 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
975 dest->bulk_in_buffer = src->bulk_in_buffer; \
976 dest->interrupt_in_urb = src->interrupt_in_urb; \
977 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
978 dest->interrupt_in_buffer = src->interrupt_in_buffer;
980 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
983 COPY_PORT(swap_port, serial->port[0]);
984 COPY_PORT(serial->port[0], serial->port[1]);
985 COPY_PORT(serial->port[1], swap_port);
989 return generic_startup(serial);
992 static int clie_5_attach (struct usb_serial *serial)
994 dbg("%s", __FUNCTION__);
996 /* TH55 registers 2 ports.
997 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
998 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
1000 Lets do a quick and dirty mapping
1003 /* some sanity check */
1004 if (serial->num_ports < 2)
1007 /* port 0 now uses the modified endpoint Address */
1008 serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
1010 return generic_startup(serial);
1013 static void visor_shutdown (struct usb_serial *serial)
1015 dbg("%s", __FUNCTION__);
1018 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1020 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
1022 return -ENOIOCTLCMD;
1026 /* This function is all nice and good, but we don't change anything based on it :) */
1027 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1031 dbg("%s - port %d", __FUNCTION__, port->number);
1033 if ((!port->tty) || (!port->tty->termios)) {
1034 dbg("%s - no tty structures", __FUNCTION__);
1038 cflag = port->tty->termios->c_cflag;
1039 /* check that they really want us to change something */
1041 if ((cflag == old_termios->c_cflag) &&
1042 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
1043 dbg("%s - nothing to change...", __FUNCTION__);
1048 /* get the byte size */
1049 switch (cflag & CSIZE) {
1050 case CS5: dbg("%s - data bits = 5", __FUNCTION__); break;
1051 case CS6: dbg("%s - data bits = 6", __FUNCTION__); break;
1052 case CS7: dbg("%s - data bits = 7", __FUNCTION__); break;
1054 case CS8: dbg("%s - data bits = 8", __FUNCTION__); break;
1057 /* determine the parity */
1060 dbg("%s - parity = odd", __FUNCTION__);
1062 dbg("%s - parity = even", __FUNCTION__);
1064 dbg("%s - parity = none", __FUNCTION__);
1066 /* figure out the stop bits requested */
1068 dbg("%s - stop bits = 2", __FUNCTION__);
1070 dbg("%s - stop bits = 1", __FUNCTION__);
1073 /* figure out the flow control settings */
1074 if (cflag & CRTSCTS)
1075 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
1077 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
1079 /* determine software flow control */
1080 if (I_IXOFF(port->tty))
1081 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
1082 __FUNCTION__, START_CHAR(port->tty), STOP_CHAR(port->tty));
1084 dbg("%s - XON/XOFF is disabled", __FUNCTION__);
1086 /* get the baud rate wanted */
1087 dbg("%s - baud rate = %d", __FUNCTION__, tty_get_baud_rate(port->tty));
1093 static int __init visor_init (void)
1096 /* Only if parameters were passed to us */
1097 if ((vendor>0) && (product>0)) {
1098 struct usb_device_id usb_dev_temp[]=
1099 {{USB_DEVICE(vendor, product),
1100 .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
1102 /* Find the last entry in id_table */
1104 if (id_table[i].idVendor==0) {
1105 id_table[i] = usb_dev_temp[0];
1109 /* Find the last entry in id_table_combined */
1111 if (id_table_combined[i].idVendor==0) {
1112 id_table_combined[i] = usb_dev_temp[0];
1116 info("Untested USB device specified at time of module insertion");
1117 info("Warning: This is not guaranteed to work");
1118 info("Using a newer kernel is preferred to this method");
1119 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1122 retval = usb_serial_register(&handspring_device);
1124 goto failed_handspring_register;
1125 retval = usb_serial_register(&clie_3_5_device);
1127 goto failed_clie_3_5_register;
1128 retval = usb_serial_register(&clie_5_device);
1130 goto failed_clie_5_register;
1131 retval = usb_register(&visor_driver);
1133 goto failed_usb_register;
1134 info(DRIVER_DESC " " DRIVER_VERSION);
1137 failed_usb_register:
1138 usb_serial_deregister(&clie_5_device);
1139 failed_clie_5_register:
1140 usb_serial_deregister(&clie_3_5_device);
1141 failed_clie_3_5_register:
1142 usb_serial_deregister(&handspring_device);
1143 failed_handspring_register:
1148 static void __exit visor_exit (void)
1150 usb_deregister (&visor_driver);
1151 usb_serial_deregister (&handspring_device);
1152 usb_serial_deregister (&clie_3_5_device);
1153 usb_serial_deregister (&clie_5_device);
1157 module_init(visor_init);
1158 module_exit(visor_exit);
1160 MODULE_AUTHOR( DRIVER_AUTHOR );
1161 MODULE_DESCRIPTION( DRIVER_DESC );
1162 MODULE_LICENSE("GPL");
1164 module_param(debug, bool, S_IRUGO | S_IWUSR);
1165 MODULE_PARM_DESC(debug, "Debug enabled or not");
1166 module_param(stats, bool, S_IRUGO | S_IWUSR);
1167 MODULE_PARM_DESC(stats, "Enables statistics or not");
1169 module_param(vendor, ushort, 0);
1170 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1171 module_param(product, ushort, 0);
1172 MODULE_PARM_DESC(product, "User specified product ID");