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(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
),
243 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
244 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
),
245 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
246 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
),
247 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
248 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_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_TREO_650
) },
279 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_Z_ID
) },
280 { USB_DEVICE(PALM_VENDOR_ID
, PALM_ZIRE31_ID
) },
281 { USB_DEVICE(PALM_VENDOR_ID
, PALM_ZIRE_ID
) },
282 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_3_5_ID
) },
283 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_0_ID
) },
284 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_S360_ID
) },
285 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_1_ID
) },
286 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NX60_ID
) },
287 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NZ90V_ID
) },
288 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_UX50_ID
) },
289 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_TJ25_ID
) },
290 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SCH_I330_ID
) },
291 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SPH_I500_ID
) },
292 { USB_DEVICE(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
) },
293 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
) },
294 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
) },
295 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_ID
) },
296 { }, /* optional parameter entry */
297 { } /* Terminating entry */
300 MODULE_DEVICE_TABLE (usb
, id_table_combined
);
302 static struct usb_driver visor_driver
= {
303 .owner
= THIS_MODULE
,
305 .probe
= usb_serial_probe
,
306 .disconnect
= usb_serial_disconnect
,
307 .id_table
= id_table_combined
,
310 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
311 static struct usb_serial_device_type handspring_device
= {
312 .owner
= THIS_MODULE
,
313 .name
= "Handspring Visor / Palm OS",
314 .short_name
= "visor",
315 .id_table
= id_table
,
316 .num_interrupt_in
= NUM_DONT_CARE
,
321 .close
= visor_close
,
322 .throttle
= visor_throttle
,
323 .unthrottle
= visor_unthrottle
,
324 .attach
= treo_attach
,
325 .probe
= visor_probe
,
326 .calc_num_ports
= visor_calc_num_ports
,
327 .shutdown
= visor_shutdown
,
328 .ioctl
= visor_ioctl
,
329 .set_termios
= visor_set_termios
,
330 .write
= visor_write
,
331 .write_room
= visor_write_room
,
332 .chars_in_buffer
= visor_chars_in_buffer
,
333 .write_bulk_callback
= visor_write_bulk_callback
,
334 .read_bulk_callback
= visor_read_bulk_callback
,
335 .read_int_callback
= visor_read_int_callback
,
338 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
339 static struct usb_serial_device_type clie_5_device
= {
340 .owner
= THIS_MODULE
,
341 .name
= "Sony Clie 5.0",
342 .short_name
= "clie_5",
343 .id_table
= clie_id_5_table
,
344 .num_interrupt_in
= NUM_DONT_CARE
,
349 .close
= visor_close
,
350 .throttle
= visor_throttle
,
351 .unthrottle
= visor_unthrottle
,
352 .attach
= clie_5_attach
,
353 .probe
= visor_probe
,
354 .calc_num_ports
= visor_calc_num_ports
,
355 .shutdown
= visor_shutdown
,
356 .ioctl
= visor_ioctl
,
357 .set_termios
= visor_set_termios
,
358 .write
= visor_write
,
359 .write_room
= visor_write_room
,
360 .chars_in_buffer
= visor_chars_in_buffer
,
361 .write_bulk_callback
= visor_write_bulk_callback
,
362 .read_bulk_callback
= visor_read_bulk_callback
,
363 .read_int_callback
= visor_read_int_callback
,
366 /* device info for the Sony Clie OS version 3.5 */
367 static struct usb_serial_device_type clie_3_5_device
= {
368 .owner
= THIS_MODULE
,
369 .name
= "Sony Clie 3.5",
370 .short_name
= "clie_3.5",
371 .id_table
= clie_id_3_5_table
,
372 .num_interrupt_in
= 0,
377 .close
= visor_close
,
378 .throttle
= visor_throttle
,
379 .unthrottle
= visor_unthrottle
,
380 .attach
= clie_3_5_startup
,
381 .ioctl
= visor_ioctl
,
382 .set_termios
= visor_set_termios
,
383 .write
= visor_write
,
384 .write_room
= visor_write_room
,
385 .chars_in_buffer
= visor_chars_in_buffer
,
386 .write_bulk_callback
= visor_write_bulk_callback
,
387 .read_bulk_callback
= visor_read_bulk_callback
,
390 struct visor_private
{
394 int outstanding_urbs
;
398 /* number of outstanding urbs to prevent userspace DoS from happening */
399 #define URB_UPPER_LIMIT 42
403 /******************************************************************************
404 * Handspring Visor specific driver functions
405 ******************************************************************************/
406 static int visor_open (struct usb_serial_port
*port
, struct file
*filp
)
408 struct usb_serial
*serial
= port
->serial
;
409 struct visor_private
*priv
= usb_get_serial_port_data(port
);
413 dbg("%s - port %d", __FUNCTION__
, port
->number
);
415 if (!port
->read_urb
) {
416 /* this is needed for some brain dead Sony devices */
417 dev_err(&port
->dev
, "Device lied about number of ports, please use a lower one.\n");
421 spin_lock_irqsave(&priv
->lock
, flags
);
424 priv
->outstanding_urbs
= 0;
426 spin_unlock_irqrestore(&priv
->lock
, flags
);
429 * Force low_latency on so that our tty_push actually forces the data
430 * through, otherwise it is scheduled, and with high data rates (like
431 * with OHCI) data can get lost.
434 port
->tty
->low_latency
= 1;
436 /* Start reading from the device */
437 usb_fill_bulk_urb (port
->read_urb
, serial
->dev
,
438 usb_rcvbulkpipe (serial
->dev
,
439 port
->bulk_in_endpointAddress
),
440 port
->read_urb
->transfer_buffer
,
441 port
->read_urb
->transfer_buffer_length
,
442 visor_read_bulk_callback
, port
);
443 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
445 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n",
446 __FUNCTION__
, result
);
450 if (port
->interrupt_in_urb
) {
451 dbg("%s - adding interrupt input for treo", __FUNCTION__
);
452 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
454 dev_err(&port
->dev
, "%s - failed submitting interrupt urb, error %d\n",
455 __FUNCTION__
, result
);
462 static void visor_close (struct usb_serial_port
*port
, struct file
* filp
)
464 struct visor_private
*priv
= usb_get_serial_port_data(port
);
465 unsigned char *transfer_buffer
;
467 dbg("%s - port %d", __FUNCTION__
, port
->number
);
469 /* shutdown our urbs */
470 usb_kill_urb(port
->read_urb
);
471 if (port
->interrupt_in_urb
)
472 usb_kill_urb(port
->interrupt_in_urb
);
474 /* Try to send shutdown message, if the device is gone, this will just fail. */
475 transfer_buffer
= kmalloc (0x12, GFP_KERNEL
);
476 if (transfer_buffer
) {
477 usb_control_msg (port
->serial
->dev
,
478 usb_rcvctrlpipe(port
->serial
->dev
, 0),
479 VISOR_CLOSE_NOTIFICATION
, 0xc2,
481 transfer_buffer
, 0x12, 300);
482 kfree (transfer_buffer
);
486 dev_info(&port
->dev
, "Bytes In = %d Bytes Out = %d\n",
487 priv
->bytes_in
, priv
->bytes_out
);
491 static int visor_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
493 struct visor_private
*priv
= usb_get_serial_port_data(port
);
494 struct usb_serial
*serial
= port
->serial
;
496 unsigned char *buffer
;
500 dbg("%s - port %d", __FUNCTION__
, port
->number
);
502 spin_lock_irqsave(&priv
->lock
, flags
);
503 if (priv
->outstanding_urbs
> URB_UPPER_LIMIT
) {
504 spin_unlock_irqrestore(&priv
->lock
, flags
);
505 dbg("%s - write limit hit\n", __FUNCTION__
);
508 spin_unlock_irqrestore(&priv
->lock
, flags
);
510 buffer
= kmalloc (count
, GFP_ATOMIC
);
512 dev_err(&port
->dev
, "out of memory\n");
516 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
518 dev_err(&port
->dev
, "no more free urbs\n");
523 memcpy (buffer
, buf
, count
);
525 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, buffer
);
527 usb_fill_bulk_urb (urb
, serial
->dev
,
528 usb_sndbulkpipe (serial
->dev
,
529 port
->bulk_out_endpointAddress
),
531 visor_write_bulk_callback
, port
);
533 /* send it down the pipe */
534 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
536 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
537 __FUNCTION__
, status
);
541 spin_lock_irqsave(&priv
->lock
, flags
);
542 ++priv
->outstanding_urbs
;
543 priv
->bytes_out
+= count
;
544 spin_unlock_irqrestore(&priv
->lock
, flags
);
547 /* we are done with this urb, so let the host driver
548 * really free it when it is finished with it */
555 static int visor_write_room (struct usb_serial_port
*port
)
557 dbg("%s - port %d", __FUNCTION__
, port
->number
);
560 * We really can take anything the user throws at us
561 * but let's pick a nice big number to tell the tty
562 * layer that we have lots of free space
568 static int visor_chars_in_buffer (struct usb_serial_port
*port
)
570 dbg("%s - port %d", __FUNCTION__
, port
->number
);
573 * We can't really account for how much data we
574 * have sent out, but hasn't made it through to the
575 * device, so just tell the tty layer that everything
582 static void visor_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
584 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
585 struct visor_private
*priv
= usb_get_serial_port_data(port
);
588 /* free up the transfer buffer, as usb_free_urb() does not do this */
589 kfree (urb
->transfer_buffer
);
591 dbg("%s - port %d", __FUNCTION__
, port
->number
);
594 dbg("%s - nonzero write bulk status received: %d",
595 __FUNCTION__
, urb
->status
);
597 spin_lock_irqsave(&priv
->lock
, flags
);
598 --priv
->outstanding_urbs
;
599 spin_unlock_irqrestore(&priv
->lock
, flags
);
601 schedule_work(&port
->work
);
605 static void visor_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
607 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
608 struct visor_private
*priv
= usb_get_serial_port_data(port
);
609 unsigned char *data
= urb
->transfer_buffer
;
610 struct tty_struct
*tty
;
616 dbg("%s - port %d", __FUNCTION__
, port
->number
);
619 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__
, urb
->status
);
623 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
626 if (tty
&& urb
->actual_length
) {
627 for (i
= 0; i
< urb
->actual_length
; ++i
) {
628 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
629 if(tty
->flip
.count
>= TTY_FLIPBUF_SIZE
) {
630 tty_flip_buffer_push(tty
);
632 /* this doesn't actually push the data through unless tty->low_latency is set */
633 tty_insert_flip_char(tty
, data
[i
], 0);
635 tty_flip_buffer_push(tty
);
637 spin_lock_irqsave(&priv
->lock
, flags
);
638 priv
->bytes_in
+= urb
->actual_length
;
639 throttled
= priv
->throttled
;
640 spin_unlock_irqrestore(&priv
->lock
, flags
);
642 /* Continue trying to always read if we should */
644 usb_fill_bulk_urb (port
->read_urb
, port
->serial
->dev
,
645 usb_rcvbulkpipe(port
->serial
->dev
,
646 port
->bulk_in_endpointAddress
),
647 port
->read_urb
->transfer_buffer
,
648 port
->read_urb
->transfer_buffer_length
,
649 visor_read_bulk_callback
, port
);
650 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
652 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
657 static void visor_read_int_callback (struct urb
*urb
, struct pt_regs
*regs
)
659 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
662 switch (urb
->status
) {
669 /* this urb is terminated, clean up */
670 dbg("%s - urb shutting down with status: %d",
671 __FUNCTION__
, urb
->status
);
674 dbg("%s - nonzero urb status received: %d",
675 __FUNCTION__
, urb
->status
);
680 * This information is still unknown what it can be used for.
681 * If anyone has an idea, please let the author know...
683 * Rumor has it this endpoint is used to notify when data
684 * is ready to be read from the bulk ones.
686 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
687 urb
->actual_length
, urb
->transfer_buffer
);
690 result
= usb_submit_urb (urb
, GFP_ATOMIC
);
692 dev_err(&urb
->dev
->dev
, "%s - Error %d submitting interrupt urb\n",
693 __FUNCTION__
, result
);
696 static void visor_throttle (struct usb_serial_port
*port
)
698 struct visor_private
*priv
= usb_get_serial_port_data(port
);
701 dbg("%s - port %d", __FUNCTION__
, port
->number
);
702 spin_lock_irqsave(&priv
->lock
, flags
);
704 spin_unlock_irqrestore(&priv
->lock
, flags
);
708 static void visor_unthrottle (struct usb_serial_port
*port
)
710 struct visor_private
*priv
= usb_get_serial_port_data(port
);
714 dbg("%s - port %d", __FUNCTION__
, port
->number
);
715 spin_lock_irqsave(&priv
->lock
, flags
);
717 spin_unlock_irqrestore(&priv
->lock
, flags
);
719 port
->read_urb
->dev
= port
->serial
->dev
;
720 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
722 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
725 static int palm_os_3_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
727 struct device
*dev
= &serial
->dev
->dev
;
728 struct visor_connection_info
*connection_info
;
729 unsigned char *transfer_buffer
;
735 dbg("%s", __FUNCTION__
);
737 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
738 if (!transfer_buffer
) {
739 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
740 sizeof(*connection_info
));
744 /* send a get connection info request */
745 retval
= usb_control_msg (serial
->dev
,
746 usb_rcvctrlpipe(serial
->dev
, 0),
747 VISOR_GET_CONNECTION_INFORMATION
,
748 0xc2, 0x0000, 0x0000, transfer_buffer
,
749 sizeof(*connection_info
), 300);
751 dev_err(dev
, "%s - error %d getting connection information\n",
752 __FUNCTION__
, retval
);
756 if (retval
== sizeof(*connection_info
)) {
757 connection_info
= (struct visor_connection_info
*)transfer_buffer
;
759 num_ports
= le16_to_cpu(connection_info
->num_ports
);
760 for (i
= 0; i
< num_ports
; ++i
) {
761 switch (connection_info
->connections
[i
].port_function_id
) {
762 case VISOR_FUNCTION_GENERIC
:
765 case VISOR_FUNCTION_DEBUGGER
:
768 case VISOR_FUNCTION_HOTSYNC
:
771 case VISOR_FUNCTION_CONSOLE
:
774 case VISOR_FUNCTION_REMOTE_FILE_SYS
:
775 string
= "Remote File System";
781 dev_info(dev
, "%s: port %d, is for %s use\n",
783 connection_info
->connections
[i
].port
, string
);
787 * Handle devices that report invalid stuff here.
789 if (num_ports
== 0 || num_ports
> 2) {
790 dev_warn (dev
, "%s: No valid connect info available\n",
795 dev_info(dev
, "%s: Number of ports: %d\n", serial
->type
->name
,
799 * save off our num_ports info so that we can use it in the
800 * calc_num_ports callback
802 usb_set_serial_data(serial
, (void *)(long)num_ports
);
804 /* ask for the number of bytes available, but ignore the response as it is broken */
805 retval
= usb_control_msg (serial
->dev
,
806 usb_rcvctrlpipe(serial
->dev
, 0),
807 VISOR_REQUEST_BYTES_AVAILABLE
,
808 0xc2, 0x0000, 0x0005, transfer_buffer
,
811 dev_err(dev
, "%s - error %d getting bytes available request\n",
812 __FUNCTION__
, retval
);
816 kfree (transfer_buffer
);
821 static int palm_os_4_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
823 struct device
*dev
= &serial
->dev
->dev
;
824 struct palm_ext_connection_info
*connection_info
;
825 unsigned char *transfer_buffer
;
828 dbg("%s", __FUNCTION__
);
830 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
831 if (!transfer_buffer
) {
832 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
833 sizeof(*connection_info
));
837 retval
= usb_control_msg (serial
->dev
,
838 usb_rcvctrlpipe(serial
->dev
, 0),
839 PALM_GET_EXT_CONNECTION_INFORMATION
,
840 0xc2, 0x0000, 0x0000, transfer_buffer
,
841 sizeof (*connection_info
), 300);
843 dev_err(dev
, "%s - error %d getting connection info\n",
844 __FUNCTION__
, retval
);
846 usb_serial_debug_data(debug
, &serial
->dev
->dev
, __FUNCTION__
,
847 retval
, transfer_buffer
);
849 kfree (transfer_buffer
);
854 static int visor_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
857 int (*startup
) (struct usb_serial
*serial
, const struct usb_device_id
*id
);
859 dbg("%s", __FUNCTION__
);
861 if (serial
->dev
->actconfig
->desc
.bConfigurationValue
!= 1) {
862 err("active config #%d != 1 ??",
863 serial
->dev
->actconfig
->desc
.bConfigurationValue
);
867 if (id
->driver_info
) {
868 startup
= (void *)id
->driver_info
;
869 retval
= startup(serial
, id
);
875 static int visor_calc_num_ports (struct usb_serial
*serial
)
877 int num_ports
= (int)(long)(usb_get_serial_data(serial
));
880 usb_set_serial_data(serial
, NULL
);
885 static int generic_startup(struct usb_serial
*serial
)
887 struct visor_private
*priv
;
890 for (i
= 0; i
< serial
->num_ports
; ++i
) {
891 priv
= kmalloc (sizeof(*priv
), GFP_KERNEL
);
894 memset (priv
, 0x00, sizeof(*priv
));
895 spin_lock_init(&priv
->lock
);
896 usb_set_serial_port_data(serial
->port
[i
], priv
);
901 static int clie_3_5_startup (struct usb_serial
*serial
)
903 struct device
*dev
= &serial
->dev
->dev
;
907 dbg("%s", __FUNCTION__
);
910 * Note that PEG-300 series devices expect the following two calls.
913 /* get the config number */
914 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
915 USB_REQ_GET_CONFIGURATION
, USB_DIR_IN
,
916 0, 0, &data
, 1, 3000);
918 dev_err(dev
, "%s: get config number failed: %d\n", __FUNCTION__
, result
);
922 dev_err(dev
, "%s: get config number bad return length: %d\n", __FUNCTION__
, result
);
926 /* get the interface number */
927 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
928 USB_REQ_GET_INTERFACE
,
929 USB_DIR_IN
| USB_RECIP_INTERFACE
,
930 0, 0, &data
, 1, 3000);
932 dev_err(dev
, "%s: get interface number failed: %d\n", __FUNCTION__
, result
);
936 dev_err(dev
, "%s: get interface number bad return length: %d\n", __FUNCTION__
, result
);
940 return generic_startup(serial
);
943 static int treo_attach (struct usb_serial
*serial
)
945 struct usb_serial_port
*swap_port
;
947 /* Only do this endpoint hack for the Handspring devices with
948 * interrupt in endpoints, which for now are the Treo devices. */
949 if (!((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == HANDSPRING_VENDOR_ID
) ||
950 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KYOCERA_VENDOR_ID
)) ||
951 (serial
->num_interrupt_in
== 0))
952 goto generic_startup
;
954 dbg("%s", __FUNCTION__
);
957 * It appears that Treos and Kyoceras want to use the
958 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
959 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
960 * Note that swapping the bulk out endpoints would break lots of
961 * apps that want to communicate on the second port.
963 #define COPY_PORT(dest, src) \
964 dest->read_urb = src->read_urb; \
965 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
966 dest->bulk_in_buffer = src->bulk_in_buffer; \
967 dest->interrupt_in_urb = src->interrupt_in_urb; \
968 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
969 dest->interrupt_in_buffer = src->interrupt_in_buffer;
971 swap_port
= kmalloc(sizeof(*swap_port
), GFP_KERNEL
);
974 COPY_PORT(swap_port
, serial
->port
[0]);
975 COPY_PORT(serial
->port
[0], serial
->port
[1]);
976 COPY_PORT(serial
->port
[1], swap_port
);
980 return generic_startup(serial
);
983 static int clie_5_attach (struct usb_serial
*serial
)
985 dbg("%s", __FUNCTION__
);
987 /* TH55 registers 2 ports.
988 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
989 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
991 Lets do a quick and dirty mapping
994 /* some sanity check */
995 if (serial
->num_ports
< 2)
998 /* port 0 now uses the modified endpoint Address */
999 serial
->port
[0]->bulk_out_endpointAddress
= serial
->port
[1]->bulk_out_endpointAddress
;
1001 return generic_startup(serial
);
1004 static void visor_shutdown (struct usb_serial
*serial
)
1006 dbg("%s", __FUNCTION__
);
1009 static int visor_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
)
1011 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__
, port
->number
, cmd
);
1013 return -ENOIOCTLCMD
;
1017 /* This function is all nice and good, but we don't change anything based on it :) */
1018 static void visor_set_termios (struct usb_serial_port
*port
, struct termios
*old_termios
)
1022 dbg("%s - port %d", __FUNCTION__
, port
->number
);
1024 if ((!port
->tty
) || (!port
->tty
->termios
)) {
1025 dbg("%s - no tty structures", __FUNCTION__
);
1029 cflag
= port
->tty
->termios
->c_cflag
;
1030 /* check that they really want us to change something */
1032 if ((cflag
== old_termios
->c_cflag
) &&
1033 (RELEVANT_IFLAG(port
->tty
->termios
->c_iflag
) == RELEVANT_IFLAG(old_termios
->c_iflag
))) {
1034 dbg("%s - nothing to change...", __FUNCTION__
);
1039 /* get the byte size */
1040 switch (cflag
& CSIZE
) {
1041 case CS5
: dbg("%s - data bits = 5", __FUNCTION__
); break;
1042 case CS6
: dbg("%s - data bits = 6", __FUNCTION__
); break;
1043 case CS7
: dbg("%s - data bits = 7", __FUNCTION__
); break;
1045 case CS8
: dbg("%s - data bits = 8", __FUNCTION__
); break;
1048 /* determine the parity */
1051 dbg("%s - parity = odd", __FUNCTION__
);
1053 dbg("%s - parity = even", __FUNCTION__
);
1055 dbg("%s - parity = none", __FUNCTION__
);
1057 /* figure out the stop bits requested */
1059 dbg("%s - stop bits = 2", __FUNCTION__
);
1061 dbg("%s - stop bits = 1", __FUNCTION__
);
1064 /* figure out the flow control settings */
1065 if (cflag
& CRTSCTS
)
1066 dbg("%s - RTS/CTS is enabled", __FUNCTION__
);
1068 dbg("%s - RTS/CTS is disabled", __FUNCTION__
);
1070 /* determine software flow control */
1071 if (I_IXOFF(port
->tty
))
1072 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
1073 __FUNCTION__
, START_CHAR(port
->tty
), STOP_CHAR(port
->tty
));
1075 dbg("%s - XON/XOFF is disabled", __FUNCTION__
);
1077 /* get the baud rate wanted */
1078 dbg("%s - baud rate = %d", __FUNCTION__
, tty_get_baud_rate(port
->tty
));
1084 static int __init
visor_init (void)
1087 /* Only if parameters were passed to us */
1088 if ((vendor
>0) && (product
>0)) {
1089 struct usb_device_id usb_dev_temp
[]=
1090 {{USB_DEVICE(vendor
, product
),
1091 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
}};
1093 /* Find the last entry in id_table */
1095 if (id_table
[i
].idVendor
==0) {
1096 id_table
[i
] = usb_dev_temp
[0];
1100 /* Find the last entry in id_table_combined */
1102 if (id_table_combined
[i
].idVendor
==0) {
1103 id_table_combined
[i
] = usb_dev_temp
[0];
1107 info("Untested USB device specified at time of module insertion");
1108 info("Warning: This is not guaranteed to work");
1109 info("Using a newer kernel is preferred to this method");
1110 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1113 retval
= usb_serial_register(&handspring_device
);
1115 goto failed_handspring_register
;
1116 retval
= usb_serial_register(&clie_3_5_device
);
1118 goto failed_clie_3_5_register
;
1119 retval
= usb_serial_register(&clie_5_device
);
1121 goto failed_clie_5_register
;
1122 retval
= usb_register(&visor_driver
);
1124 goto failed_usb_register
;
1125 info(DRIVER_DESC
" " DRIVER_VERSION
);
1128 failed_usb_register
:
1129 usb_serial_deregister(&clie_5_device
);
1130 failed_clie_5_register
:
1131 usb_serial_deregister(&clie_3_5_device
);
1132 failed_clie_3_5_register
:
1133 usb_serial_deregister(&handspring_device
);
1134 failed_handspring_register
:
1139 static void __exit
visor_exit (void)
1141 usb_deregister (&visor_driver
);
1142 usb_serial_deregister (&handspring_device
);
1143 usb_serial_deregister (&clie_3_5_device
);
1144 usb_serial_deregister (&clie_5_device
);
1148 module_init(visor_init
);
1149 module_exit(visor_exit
);
1151 MODULE_AUTHOR( DRIVER_AUTHOR
);
1152 MODULE_DESCRIPTION( DRIVER_DESC
);
1153 MODULE_LICENSE("GPL");
1155 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1156 MODULE_PARM_DESC(debug
, "Debug enabled or not");
1157 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1158 MODULE_PARM_DESC(stats
, "Enables statistics or not");
1160 module_param(vendor
, ushort
, 0);
1161 MODULE_PARM_DESC(vendor
, "User specified vendor ID");
1162 module_param(product
, ushort
, 0);
1163 MODULE_PARM_DESC(product
, "User specified product ID");