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
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
12 * See Documentation/usb/usb-serial.txt for more information on using this driver
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/init.h>
19 #include <linux/slab.h>
20 #include <linux/tty.h>
21 #include <linux/tty_driver.h>
22 #include <linux/tty_flip.h>
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/spinlock.h>
26 #include <asm/uaccess.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
34 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
35 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
37 /* function prototypes for a handspring visor */
38 static int visor_open (struct usb_serial_port
*port
, struct file
*filp
);
39 static void visor_close (struct usb_serial_port
*port
, struct file
*filp
);
40 static int visor_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
);
41 static int visor_write_room (struct usb_serial_port
*port
);
42 static int visor_chars_in_buffer (struct usb_serial_port
*port
);
43 static void visor_throttle (struct usb_serial_port
*port
);
44 static void visor_unthrottle (struct usb_serial_port
*port
);
45 static int visor_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
);
46 static int visor_calc_num_ports(struct usb_serial
*serial
);
47 static void visor_shutdown (struct usb_serial
*serial
);
48 static int visor_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
);
49 static void visor_set_termios (struct usb_serial_port
*port
, struct ktermios
*old_termios
);
50 static void visor_write_bulk_callback (struct urb
*urb
);
51 static void visor_read_bulk_callback (struct urb
*urb
);
52 static void visor_read_int_callback (struct urb
*urb
);
53 static int clie_3_5_startup (struct usb_serial
*serial
);
54 static int treo_attach (struct usb_serial
*serial
);
55 static int clie_5_attach (struct usb_serial
*serial
);
56 static int palm_os_3_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
);
57 static int palm_os_4_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
);
59 /* Parameters that may be passed into the module. */
64 static struct usb_device_id id_table
[] = {
65 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_VISOR_ID
),
66 .driver_info
= (kernel_ulong_t
)&palm_os_3_probe
},
67 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO_ID
),
68 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
69 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO600_ID
),
70 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
71 { USB_DEVICE(GSPDA_VENDOR_ID
, GSPDA_XPLORE_M68_ID
),
72 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
73 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M500_ID
),
74 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
75 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M505_ID
),
76 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
77 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M515_ID
),
78 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
79 { USB_DEVICE(PALM_VENDOR_ID
, PALM_I705_ID
),
80 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
81 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M100_ID
),
82 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
83 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M125_ID
),
84 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
85 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M130_ID
),
86 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
87 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_T_ID
),
88 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
89 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TREO_650
),
90 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
91 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_Z_ID
),
92 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
93 { USB_DEVICE(PALM_VENDOR_ID
, PALM_ZIRE_ID
),
94 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
95 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_0_ID
),
96 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
97 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_S360_ID
),
98 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
99 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_1_ID
),
100 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
101 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NX60_ID
),
102 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
103 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NZ90V_ID
),
104 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
105 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_TJ25_ID
),
106 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
107 { USB_DEVICE(ACER_VENDOR_ID
, ACER_S10_ID
),
108 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
109 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SCH_I330_ID
),
110 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
111 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SPH_I500_ID
),
112 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
113 { USB_DEVICE(TAPWAVE_VENDOR_ID
, TAPWAVE_ZODIAC_ID
),
114 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
115 { USB_DEVICE(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
),
116 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
117 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
),
118 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
119 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
),
120 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
121 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_ID
),
122 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
123 { }, /* optional parameter entry */
124 { } /* Terminating entry */
127 static struct usb_device_id clie_id_5_table
[] = {
128 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_UX50_ID
),
129 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
130 { }, /* optional parameter entry */
131 { } /* Terminating entry */
134 static struct usb_device_id clie_id_3_5_table
[] = {
135 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_3_5_ID
) },
136 { } /* Terminating entry */
139 static struct usb_device_id id_table_combined
[] = {
140 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_VISOR_ID
) },
141 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO_ID
) },
142 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO600_ID
) },
143 { USB_DEVICE(GSPDA_VENDOR_ID
, GSPDA_XPLORE_M68_ID
) },
144 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M500_ID
) },
145 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M505_ID
) },
146 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M515_ID
) },
147 { USB_DEVICE(PALM_VENDOR_ID
, PALM_I705_ID
) },
148 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M100_ID
) },
149 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M125_ID
) },
150 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M130_ID
) },
151 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_T_ID
) },
152 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TREO_650
) },
153 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_Z_ID
) },
154 { USB_DEVICE(PALM_VENDOR_ID
, PALM_ZIRE_ID
) },
155 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_3_5_ID
) },
156 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_0_ID
) },
157 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_S360_ID
) },
158 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_1_ID
) },
159 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NX60_ID
) },
160 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NZ90V_ID
) },
161 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_UX50_ID
) },
162 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_TJ25_ID
) },
163 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SCH_I330_ID
) },
164 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SPH_I500_ID
) },
165 { USB_DEVICE(TAPWAVE_VENDOR_ID
, TAPWAVE_ZODIAC_ID
) },
166 { USB_DEVICE(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
) },
167 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
) },
168 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
) },
169 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_ID
) },
170 { }, /* optional parameter entry */
171 { } /* Terminating entry */
174 MODULE_DEVICE_TABLE (usb
, id_table_combined
);
176 static struct usb_driver visor_driver
= {
178 .probe
= usb_serial_probe
,
179 .disconnect
= usb_serial_disconnect
,
180 .id_table
= id_table_combined
,
184 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
185 static struct usb_serial_driver handspring_device
= {
187 .owner
= THIS_MODULE
,
190 .description
= "Handspring Visor / Palm OS",
191 .usb_driver
= &visor_driver
,
192 .id_table
= id_table
,
193 .num_interrupt_in
= NUM_DONT_CARE
,
198 .close
= visor_close
,
199 .throttle
= visor_throttle
,
200 .unthrottle
= visor_unthrottle
,
201 .attach
= treo_attach
,
202 .probe
= visor_probe
,
203 .calc_num_ports
= visor_calc_num_ports
,
204 .shutdown
= visor_shutdown
,
205 .ioctl
= visor_ioctl
,
206 .set_termios
= visor_set_termios
,
207 .write
= visor_write
,
208 .write_room
= visor_write_room
,
209 .chars_in_buffer
= visor_chars_in_buffer
,
210 .write_bulk_callback
= visor_write_bulk_callback
,
211 .read_bulk_callback
= visor_read_bulk_callback
,
212 .read_int_callback
= visor_read_int_callback
,
215 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
216 static struct usb_serial_driver clie_5_device
= {
218 .owner
= THIS_MODULE
,
221 .description
= "Sony Clie 5.0",
222 .usb_driver
= &visor_driver
,
223 .id_table
= clie_id_5_table
,
224 .num_interrupt_in
= NUM_DONT_CARE
,
229 .close
= visor_close
,
230 .throttle
= visor_throttle
,
231 .unthrottle
= visor_unthrottle
,
232 .attach
= clie_5_attach
,
233 .probe
= visor_probe
,
234 .calc_num_ports
= visor_calc_num_ports
,
235 .shutdown
= visor_shutdown
,
236 .ioctl
= visor_ioctl
,
237 .set_termios
= visor_set_termios
,
238 .write
= visor_write
,
239 .write_room
= visor_write_room
,
240 .chars_in_buffer
= visor_chars_in_buffer
,
241 .write_bulk_callback
= visor_write_bulk_callback
,
242 .read_bulk_callback
= visor_read_bulk_callback
,
243 .read_int_callback
= visor_read_int_callback
,
246 /* device info for the Sony Clie OS version 3.5 */
247 static struct usb_serial_driver clie_3_5_device
= {
249 .owner
= THIS_MODULE
,
252 .description
= "Sony Clie 3.5",
253 .usb_driver
= &visor_driver
,
254 .id_table
= clie_id_3_5_table
,
255 .num_interrupt_in
= 0,
260 .close
= visor_close
,
261 .throttle
= visor_throttle
,
262 .unthrottle
= visor_unthrottle
,
263 .attach
= clie_3_5_startup
,
264 .ioctl
= visor_ioctl
,
265 .set_termios
= visor_set_termios
,
266 .write
= visor_write
,
267 .write_room
= visor_write_room
,
268 .chars_in_buffer
= visor_chars_in_buffer
,
269 .write_bulk_callback
= visor_write_bulk_callback
,
270 .read_bulk_callback
= visor_read_bulk_callback
,
273 struct visor_private
{
277 int outstanding_urbs
;
278 unsigned char throttled
;
279 unsigned char actually_throttled
;
282 /* number of outstanding urbs to prevent userspace DoS from happening */
283 #define URB_UPPER_LIMIT 42
287 /******************************************************************************
288 * Handspring Visor specific driver functions
289 ******************************************************************************/
290 static int visor_open (struct usb_serial_port
*port
, struct file
*filp
)
292 struct usb_serial
*serial
= port
->serial
;
293 struct visor_private
*priv
= usb_get_serial_port_data(port
);
297 dbg("%s - port %d", __FUNCTION__
, port
->number
);
299 if (!port
->read_urb
) {
300 /* this is needed for some brain dead Sony devices */
301 dev_err(&port
->dev
, "Device lied about number of ports, please use a lower one.\n");
305 spin_lock_irqsave(&priv
->lock
, flags
);
309 spin_unlock_irqrestore(&priv
->lock
, flags
);
312 * Force low_latency on so that our tty_push actually forces the data
313 * through, otherwise it is scheduled, and with high data rates (like
314 * with OHCI) data can get lost.
317 port
->tty
->low_latency
= 1;
319 /* Start reading from the device */
320 usb_fill_bulk_urb (port
->read_urb
, serial
->dev
,
321 usb_rcvbulkpipe (serial
->dev
,
322 port
->bulk_in_endpointAddress
),
323 port
->read_urb
->transfer_buffer
,
324 port
->read_urb
->transfer_buffer_length
,
325 visor_read_bulk_callback
, port
);
326 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
328 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n",
329 __FUNCTION__
, result
);
333 if (port
->interrupt_in_urb
) {
334 dbg("%s - adding interrupt input for treo", __FUNCTION__
);
335 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
337 dev_err(&port
->dev
, "%s - failed submitting interrupt urb, error %d\n",
338 __FUNCTION__
, result
);
345 static void visor_close (struct usb_serial_port
*port
, struct file
* filp
)
347 struct visor_private
*priv
= usb_get_serial_port_data(port
);
348 unsigned char *transfer_buffer
;
350 dbg("%s - port %d", __FUNCTION__
, port
->number
);
352 /* shutdown our urbs */
353 usb_kill_urb(port
->read_urb
);
354 usb_kill_urb(port
->interrupt_in_urb
);
356 /* Try to send shutdown message, if the device is gone, this will just fail. */
357 transfer_buffer
= kmalloc (0x12, GFP_KERNEL
);
358 if (transfer_buffer
) {
359 usb_control_msg (port
->serial
->dev
,
360 usb_rcvctrlpipe(port
->serial
->dev
, 0),
361 VISOR_CLOSE_NOTIFICATION
, 0xc2,
363 transfer_buffer
, 0x12, 300);
364 kfree (transfer_buffer
);
368 dev_info(&port
->dev
, "Bytes In = %d Bytes Out = %d\n",
369 priv
->bytes_in
, priv
->bytes_out
);
373 static int visor_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
375 struct visor_private
*priv
= usb_get_serial_port_data(port
);
376 struct usb_serial
*serial
= port
->serial
;
378 unsigned char *buffer
;
382 dbg("%s - port %d", __FUNCTION__
, port
->number
);
384 spin_lock_irqsave(&priv
->lock
, flags
);
385 if (priv
->outstanding_urbs
> URB_UPPER_LIMIT
) {
386 spin_unlock_irqrestore(&priv
->lock
, flags
);
387 dbg("%s - write limit hit\n", __FUNCTION__
);
390 priv
->outstanding_urbs
++;
391 spin_unlock_irqrestore(&priv
->lock
, flags
);
393 buffer
= kmalloc (count
, GFP_ATOMIC
);
395 dev_err(&port
->dev
, "out of memory\n");
397 goto error_no_buffer
;
400 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
402 dev_err(&port
->dev
, "no more free urbs\n");
407 memcpy (buffer
, buf
, count
);
409 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, buffer
);
411 usb_fill_bulk_urb (urb
, serial
->dev
,
412 usb_sndbulkpipe (serial
->dev
,
413 port
->bulk_out_endpointAddress
),
415 visor_write_bulk_callback
, port
);
417 /* send it down the pipe */
418 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
420 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
421 __FUNCTION__
, status
);
425 spin_lock_irqsave(&priv
->lock
, flags
);
426 priv
->bytes_out
+= count
;
427 spin_unlock_irqrestore(&priv
->lock
, flags
);
430 /* we are done with this urb, so let the host driver
431 * really free it when it is finished with it */
440 spin_lock_irqsave(&priv
->lock
, flags
);
441 --priv
->outstanding_urbs
;
442 spin_unlock_irqrestore(&priv
->lock
, flags
);
447 static int visor_write_room (struct usb_serial_port
*port
)
449 struct visor_private
*priv
= usb_get_serial_port_data(port
);
452 dbg("%s - port %d", __FUNCTION__
, port
->number
);
455 * We really can take anything the user throws at us
456 * but let's pick a nice big number to tell the tty
457 * layer that we have lots of free space, unless we don't.
460 spin_lock_irqsave(&priv
->lock
, flags
);
461 if (priv
->outstanding_urbs
> URB_UPPER_LIMIT
* 2 / 3) {
462 spin_unlock_irqrestore(&priv
->lock
, flags
);
463 dbg("%s - write limit hit\n", __FUNCTION__
);
466 spin_unlock_irqrestore(&priv
->lock
, flags
);
472 static int visor_chars_in_buffer (struct usb_serial_port
*port
)
474 dbg("%s - port %d", __FUNCTION__
, port
->number
);
477 * We can't really account for how much data we
478 * have sent out, but hasn't made it through to the
479 * device, so just tell the tty layer that everything
486 static void visor_write_bulk_callback (struct urb
*urb
)
488 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
489 struct visor_private
*priv
= usb_get_serial_port_data(port
);
490 int status
= urb
->status
;
493 /* free up the transfer buffer, as usb_free_urb() does not do this */
494 kfree (urb
->transfer_buffer
);
496 dbg("%s - port %d", __FUNCTION__
, port
->number
);
499 dbg("%s - nonzero write bulk status received: %d",
500 __FUNCTION__
, status
);
502 spin_lock_irqsave(&priv
->lock
, flags
);
503 --priv
->outstanding_urbs
;
504 spin_unlock_irqrestore(&priv
->lock
, flags
);
506 usb_serial_port_softint(port
);
510 static void visor_read_bulk_callback (struct urb
*urb
)
512 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
513 struct visor_private
*priv
= usb_get_serial_port_data(port
);
514 unsigned char *data
= urb
->transfer_buffer
;
515 int status
= urb
->status
;
516 struct tty_struct
*tty
;
520 dbg("%s - port %d", __FUNCTION__
, port
->number
);
523 dbg("%s - nonzero read bulk status received: %d",
524 __FUNCTION__
, status
);
528 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
531 if (tty
&& urb
->actual_length
) {
532 available_room
= tty_buffer_request_room(tty
, urb
->actual_length
);
533 if (available_room
) {
534 tty_insert_flip_string(tty
, data
, available_room
);
535 tty_flip_buffer_push(tty
);
537 spin_lock(&priv
->lock
);
538 priv
->bytes_in
+= available_room
;
541 spin_lock(&priv
->lock
);
544 /* Continue trying to always read if we should */
545 if (!priv
->throttled
) {
546 usb_fill_bulk_urb (port
->read_urb
, port
->serial
->dev
,
547 usb_rcvbulkpipe(port
->serial
->dev
,
548 port
->bulk_in_endpointAddress
),
549 port
->read_urb
->transfer_buffer
,
550 port
->read_urb
->transfer_buffer_length
,
551 visor_read_bulk_callback
, port
);
552 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
554 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
556 priv
->actually_throttled
= 1;
558 spin_unlock(&priv
->lock
);
561 static void visor_read_int_callback (struct urb
*urb
)
563 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
564 int status
= urb
->status
;
574 /* this urb is terminated, clean up */
575 dbg("%s - urb shutting down with status: %d",
576 __FUNCTION__
, status
);
579 dbg("%s - nonzero urb status received: %d",
580 __FUNCTION__
, status
);
585 * This information is still unknown what it can be used for.
586 * If anyone has an idea, please let the author know...
588 * Rumor has it this endpoint is used to notify when data
589 * is ready to be read from the bulk ones.
591 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
592 urb
->actual_length
, urb
->transfer_buffer
);
595 result
= usb_submit_urb (urb
, GFP_ATOMIC
);
597 dev_err(&urb
->dev
->dev
, "%s - Error %d submitting interrupt urb\n",
598 __FUNCTION__
, result
);
601 static void visor_throttle (struct usb_serial_port
*port
)
603 struct visor_private
*priv
= usb_get_serial_port_data(port
);
606 dbg("%s - port %d", __FUNCTION__
, port
->number
);
607 spin_lock_irqsave(&priv
->lock
, flags
);
609 spin_unlock_irqrestore(&priv
->lock
, flags
);
613 static void visor_unthrottle (struct usb_serial_port
*port
)
615 struct visor_private
*priv
= usb_get_serial_port_data(port
);
619 dbg("%s - port %d", __FUNCTION__
, port
->number
);
620 spin_lock_irqsave(&priv
->lock
, flags
);
622 priv
->actually_throttled
= 0;
623 spin_unlock_irqrestore(&priv
->lock
, flags
);
625 port
->read_urb
->dev
= port
->serial
->dev
;
626 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
628 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
631 static int palm_os_3_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
633 struct device
*dev
= &serial
->dev
->dev
;
634 struct visor_connection_info
*connection_info
;
635 unsigned char *transfer_buffer
;
641 dbg("%s", __FUNCTION__
);
643 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
644 if (!transfer_buffer
) {
645 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
646 sizeof(*connection_info
));
650 /* send a get connection info request */
651 retval
= usb_control_msg (serial
->dev
,
652 usb_rcvctrlpipe(serial
->dev
, 0),
653 VISOR_GET_CONNECTION_INFORMATION
,
654 0xc2, 0x0000, 0x0000, transfer_buffer
,
655 sizeof(*connection_info
), 300);
657 dev_err(dev
, "%s - error %d getting connection information\n",
658 __FUNCTION__
, retval
);
662 if (retval
== sizeof(*connection_info
)) {
663 connection_info
= (struct visor_connection_info
*)transfer_buffer
;
665 num_ports
= le16_to_cpu(connection_info
->num_ports
);
666 for (i
= 0; i
< num_ports
; ++i
) {
667 switch (connection_info
->connections
[i
].port_function_id
) {
668 case VISOR_FUNCTION_GENERIC
:
671 case VISOR_FUNCTION_DEBUGGER
:
674 case VISOR_FUNCTION_HOTSYNC
:
677 case VISOR_FUNCTION_CONSOLE
:
680 case VISOR_FUNCTION_REMOTE_FILE_SYS
:
681 string
= "Remote File System";
687 dev_info(dev
, "%s: port %d, is for %s use\n",
688 serial
->type
->description
,
689 connection_info
->connections
[i
].port
, string
);
693 * Handle devices that report invalid stuff here.
695 if (num_ports
== 0 || num_ports
> 2) {
696 dev_warn (dev
, "%s: No valid connect info available\n",
697 serial
->type
->description
);
701 dev_info(dev
, "%s: Number of ports: %d\n", serial
->type
->description
,
705 * save off our num_ports info so that we can use it in the
706 * calc_num_ports callback
708 usb_set_serial_data(serial
, (void *)(long)num_ports
);
710 /* ask for the number of bytes available, but ignore the response as it is broken */
711 retval
= usb_control_msg (serial
->dev
,
712 usb_rcvctrlpipe(serial
->dev
, 0),
713 VISOR_REQUEST_BYTES_AVAILABLE
,
714 0xc2, 0x0000, 0x0005, transfer_buffer
,
717 dev_err(dev
, "%s - error %d getting bytes available request\n",
718 __FUNCTION__
, retval
);
722 kfree (transfer_buffer
);
727 static int palm_os_4_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
729 struct device
*dev
= &serial
->dev
->dev
;
730 struct palm_ext_connection_info
*connection_info
;
731 unsigned char *transfer_buffer
;
734 dbg("%s", __FUNCTION__
);
736 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
737 if (!transfer_buffer
) {
738 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
739 sizeof(*connection_info
));
743 retval
= usb_control_msg (serial
->dev
,
744 usb_rcvctrlpipe(serial
->dev
, 0),
745 PALM_GET_EXT_CONNECTION_INFORMATION
,
746 0xc2, 0x0000, 0x0000, transfer_buffer
,
747 sizeof (*connection_info
), 300);
749 dev_err(dev
, "%s - error %d getting connection info\n",
750 __FUNCTION__
, retval
);
752 usb_serial_debug_data(debug
, &serial
->dev
->dev
, __FUNCTION__
,
753 retval
, transfer_buffer
);
755 kfree (transfer_buffer
);
760 static int visor_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
763 int (*startup
) (struct usb_serial
*serial
, const struct usb_device_id
*id
);
765 dbg("%s", __FUNCTION__
);
767 if (serial
->dev
->actconfig
->desc
.bConfigurationValue
!= 1) {
768 err("active config #%d != 1 ??",
769 serial
->dev
->actconfig
->desc
.bConfigurationValue
);
773 if (id
->driver_info
) {
774 startup
= (void *)id
->driver_info
;
775 retval
= startup(serial
, id
);
781 static int visor_calc_num_ports (struct usb_serial
*serial
)
783 int num_ports
= (int)(long)(usb_get_serial_data(serial
));
786 usb_set_serial_data(serial
, NULL
);
791 static int generic_startup(struct usb_serial
*serial
)
793 struct usb_serial_port
**ports
= serial
->port
;
794 struct visor_private
*priv
;
797 for (i
= 0; i
< serial
->num_ports
; ++i
) {
798 priv
= kzalloc (sizeof(*priv
), GFP_KERNEL
);
801 priv
= usb_get_serial_port_data(ports
[i
]);
802 usb_set_serial_port_data(ports
[i
], NULL
);
807 spin_lock_init(&priv
->lock
);
808 usb_set_serial_port_data(ports
[i
], priv
);
813 static int clie_3_5_startup (struct usb_serial
*serial
)
815 struct device
*dev
= &serial
->dev
->dev
;
819 dbg("%s", __FUNCTION__
);
822 * Note that PEG-300 series devices expect the following two calls.
825 /* get the config number */
826 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
827 USB_REQ_GET_CONFIGURATION
, USB_DIR_IN
,
828 0, 0, &data
, 1, 3000);
830 dev_err(dev
, "%s: get config number failed: %d\n", __FUNCTION__
, result
);
834 dev_err(dev
, "%s: get config number bad return length: %d\n", __FUNCTION__
, result
);
838 /* get the interface number */
839 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
840 USB_REQ_GET_INTERFACE
,
841 USB_DIR_IN
| USB_RECIP_INTERFACE
,
842 0, 0, &data
, 1, 3000);
844 dev_err(dev
, "%s: get interface number failed: %d\n", __FUNCTION__
, result
);
848 dev_err(dev
, "%s: get interface number bad return length: %d\n", __FUNCTION__
, result
);
852 return generic_startup(serial
);
855 static int treo_attach (struct usb_serial
*serial
)
857 struct usb_serial_port
*swap_port
;
859 /* Only do this endpoint hack for the Handspring devices with
860 * interrupt in endpoints, which for now are the Treo devices. */
861 if (!((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == HANDSPRING_VENDOR_ID
) ||
862 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KYOCERA_VENDOR_ID
)) ||
863 (serial
->num_interrupt_in
== 0))
864 goto generic_startup
;
866 dbg("%s", __FUNCTION__
);
869 * It appears that Treos and Kyoceras want to use the
870 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
871 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
872 * Note that swapping the bulk out endpoints would break lots of
873 * apps that want to communicate on the second port.
875 #define COPY_PORT(dest, src) \
876 dest->read_urb = src->read_urb; \
877 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
878 dest->bulk_in_buffer = src->bulk_in_buffer; \
879 dest->interrupt_in_urb = src->interrupt_in_urb; \
880 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
881 dest->interrupt_in_buffer = src->interrupt_in_buffer;
883 swap_port
= kmalloc(sizeof(*swap_port
), GFP_KERNEL
);
886 COPY_PORT(swap_port
, serial
->port
[0]);
887 COPY_PORT(serial
->port
[0], serial
->port
[1]);
888 COPY_PORT(serial
->port
[1], swap_port
);
892 return generic_startup(serial
);
895 static int clie_5_attach (struct usb_serial
*serial
)
897 dbg("%s", __FUNCTION__
);
899 /* TH55 registers 2 ports.
900 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
901 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
903 Lets do a quick and dirty mapping
906 /* some sanity check */
907 if (serial
->num_ports
< 2)
910 /* port 0 now uses the modified endpoint Address */
911 serial
->port
[0]->bulk_out_endpointAddress
= serial
->port
[1]->bulk_out_endpointAddress
;
913 return generic_startup(serial
);
916 static void visor_shutdown (struct usb_serial
*serial
)
918 struct visor_private
*priv
;
921 dbg("%s", __FUNCTION__
);
923 for (i
= 0; i
< serial
->num_ports
; i
++) {
924 priv
= usb_get_serial_port_data(serial
->port
[i
]);
926 usb_set_serial_port_data(serial
->port
[i
], NULL
);
932 static int visor_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
)
934 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__
, port
->number
, cmd
);
940 /* This function is all nice and good, but we don't change anything based on it :) */
941 static void visor_set_termios (struct usb_serial_port
*port
, struct ktermios
*old_termios
)
945 dbg("%s - port %d", __FUNCTION__
, port
->number
);
947 if ((!port
->tty
) || (!port
->tty
->termios
)) {
948 dbg("%s - no tty structures", __FUNCTION__
);
952 cflag
= port
->tty
->termios
->c_cflag
;
954 /* get the byte size */
955 switch (cflag
& CSIZE
) {
956 case CS5
: dbg("%s - data bits = 5", __FUNCTION__
); break;
957 case CS6
: dbg("%s - data bits = 6", __FUNCTION__
); break;
958 case CS7
: dbg("%s - data bits = 7", __FUNCTION__
); break;
960 case CS8
: dbg("%s - data bits = 8", __FUNCTION__
); break;
963 /* determine the parity */
966 dbg("%s - parity = odd", __FUNCTION__
);
968 dbg("%s - parity = even", __FUNCTION__
);
970 dbg("%s - parity = none", __FUNCTION__
);
972 /* figure out the stop bits requested */
974 dbg("%s - stop bits = 2", __FUNCTION__
);
976 dbg("%s - stop bits = 1", __FUNCTION__
);
979 /* figure out the flow control settings */
981 dbg("%s - RTS/CTS is enabled", __FUNCTION__
);
983 dbg("%s - RTS/CTS is disabled", __FUNCTION__
);
985 /* determine software flow control */
986 if (I_IXOFF(port
->tty
))
987 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
988 __FUNCTION__
, START_CHAR(port
->tty
), STOP_CHAR(port
->tty
));
990 dbg("%s - XON/XOFF is disabled", __FUNCTION__
);
992 /* get the baud rate wanted */
993 dbg("%s - baud rate = %d", __FUNCTION__
, tty_get_baud_rate(port
->tty
));
999 static int __init
visor_init (void)
1002 /* Only if parameters were passed to us */
1003 if ((vendor
>0) && (product
>0)) {
1004 struct usb_device_id usb_dev_temp
[]=
1005 {{USB_DEVICE(vendor
, product
),
1006 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
}};
1008 /* Find the last entry in id_table */
1010 if (id_table
[i
].idVendor
==0) {
1011 id_table
[i
] = usb_dev_temp
[0];
1015 /* Find the last entry in id_table_combined */
1017 if (id_table_combined
[i
].idVendor
==0) {
1018 id_table_combined
[i
] = usb_dev_temp
[0];
1022 info("Untested USB device specified at time of module insertion");
1023 info("Warning: This is not guaranteed to work");
1024 info("Using a newer kernel is preferred to this method");
1025 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1028 retval
= usb_serial_register(&handspring_device
);
1030 goto failed_handspring_register
;
1031 retval
= usb_serial_register(&clie_3_5_device
);
1033 goto failed_clie_3_5_register
;
1034 retval
= usb_serial_register(&clie_5_device
);
1036 goto failed_clie_5_register
;
1037 retval
= usb_register(&visor_driver
);
1039 goto failed_usb_register
;
1043 failed_usb_register
:
1044 usb_serial_deregister(&clie_5_device
);
1045 failed_clie_5_register
:
1046 usb_serial_deregister(&clie_3_5_device
);
1047 failed_clie_3_5_register
:
1048 usb_serial_deregister(&handspring_device
);
1049 failed_handspring_register
:
1054 static void __exit
visor_exit (void)
1056 usb_deregister (&visor_driver
);
1057 usb_serial_deregister (&handspring_device
);
1058 usb_serial_deregister (&clie_3_5_device
);
1059 usb_serial_deregister (&clie_5_device
);
1063 module_init(visor_init
);
1064 module_exit(visor_exit
);
1066 MODULE_AUTHOR( DRIVER_AUTHOR
);
1067 MODULE_DESCRIPTION( DRIVER_DESC
);
1068 MODULE_LICENSE("GPL");
1070 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1071 MODULE_PARM_DESC(debug
, "Debug enabled or not");
1072 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1073 MODULE_PARM_DESC(stats
, "Enables statistics or not");
1075 module_param(vendor
, ushort
, 0);
1076 MODULE_PARM_DESC(vendor
, "User specified vendor ID");
1077 module_param(product
, ushort
, 0);
1078 MODULE_PARM_DESC(product
, "User specified product ID");