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.
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(SAMSUNG_VENDOR_ID
, SAMSUNG_SCH_I330_ID
),
108 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
109 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SPH_I500_ID
),
110 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
111 { USB_DEVICE(TAPWAVE_VENDOR_ID
, TAPWAVE_ZODIAC_ID
),
112 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
113 { USB_DEVICE(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
),
114 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
115 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
),
116 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
117 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
),
118 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
119 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_ID
),
120 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
121 { }, /* optional parameter entry */
122 { } /* Terminating entry */
125 static struct usb_device_id clie_id_5_table
[] = {
126 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_UX50_ID
),
127 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
},
128 { }, /* optional parameter entry */
129 { } /* Terminating entry */
132 static struct usb_device_id clie_id_3_5_table
[] = {
133 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_3_5_ID
) },
134 { } /* Terminating entry */
137 static struct usb_device_id id_table_combined
[] = {
138 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_VISOR_ID
) },
139 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO_ID
) },
140 { USB_DEVICE(HANDSPRING_VENDOR_ID
, HANDSPRING_TREO600_ID
) },
141 { USB_DEVICE(GSPDA_VENDOR_ID
, GSPDA_XPLORE_M68_ID
) },
142 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M500_ID
) },
143 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M505_ID
) },
144 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M515_ID
) },
145 { USB_DEVICE(PALM_VENDOR_ID
, PALM_I705_ID
) },
146 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M100_ID
) },
147 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M125_ID
) },
148 { USB_DEVICE(PALM_VENDOR_ID
, PALM_M130_ID
) },
149 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_T_ID
) },
150 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TREO_650
) },
151 { USB_DEVICE(PALM_VENDOR_ID
, PALM_TUNGSTEN_Z_ID
) },
152 { USB_DEVICE(PALM_VENDOR_ID
, PALM_ZIRE_ID
) },
153 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_3_5_ID
) },
154 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_0_ID
) },
155 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_S360_ID
) },
156 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_4_1_ID
) },
157 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NX60_ID
) },
158 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_NZ90V_ID
) },
159 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_UX50_ID
) },
160 { USB_DEVICE(SONY_VENDOR_ID
, SONY_CLIE_TJ25_ID
) },
161 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SCH_I330_ID
) },
162 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_SPH_I500_ID
) },
163 { USB_DEVICE(TAPWAVE_VENDOR_ID
, TAPWAVE_ZODIAC_ID
) },
164 { USB_DEVICE(GARMIN_VENDOR_ID
, GARMIN_IQUE_3600_ID
) },
165 { USB_DEVICE(ACEECA_VENDOR_ID
, ACEECA_MEZ1000_ID
) },
166 { USB_DEVICE(KYOCERA_VENDOR_ID
, KYOCERA_7135_ID
) },
167 { USB_DEVICE(FOSSIL_VENDOR_ID
, FOSSIL_ABACUS_ID
) },
168 { }, /* optional parameter entry */
169 { } /* Terminating entry */
172 MODULE_DEVICE_TABLE (usb
, id_table_combined
);
174 static struct usb_driver visor_driver
= {
176 .probe
= usb_serial_probe
,
177 .disconnect
= usb_serial_disconnect
,
178 .id_table
= id_table_combined
,
182 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
183 static struct usb_serial_driver handspring_device
= {
185 .owner
= THIS_MODULE
,
188 .description
= "Handspring Visor / Palm OS",
189 .usb_driver
= &visor_driver
,
190 .id_table
= id_table
,
191 .num_interrupt_in
= NUM_DONT_CARE
,
196 .close
= visor_close
,
197 .throttle
= visor_throttle
,
198 .unthrottle
= visor_unthrottle
,
199 .attach
= treo_attach
,
200 .probe
= visor_probe
,
201 .calc_num_ports
= visor_calc_num_ports
,
202 .shutdown
= visor_shutdown
,
203 .ioctl
= visor_ioctl
,
204 .set_termios
= visor_set_termios
,
205 .write
= visor_write
,
206 .write_room
= visor_write_room
,
207 .chars_in_buffer
= visor_chars_in_buffer
,
208 .write_bulk_callback
= visor_write_bulk_callback
,
209 .read_bulk_callback
= visor_read_bulk_callback
,
210 .read_int_callback
= visor_read_int_callback
,
213 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
214 static struct usb_serial_driver clie_5_device
= {
216 .owner
= THIS_MODULE
,
219 .description
= "Sony Clie 5.0",
220 .usb_driver
= &visor_driver
,
221 .id_table
= clie_id_5_table
,
222 .num_interrupt_in
= NUM_DONT_CARE
,
227 .close
= visor_close
,
228 .throttle
= visor_throttle
,
229 .unthrottle
= visor_unthrottle
,
230 .attach
= clie_5_attach
,
231 .probe
= visor_probe
,
232 .calc_num_ports
= visor_calc_num_ports
,
233 .shutdown
= visor_shutdown
,
234 .ioctl
= visor_ioctl
,
235 .set_termios
= visor_set_termios
,
236 .write
= visor_write
,
237 .write_room
= visor_write_room
,
238 .chars_in_buffer
= visor_chars_in_buffer
,
239 .write_bulk_callback
= visor_write_bulk_callback
,
240 .read_bulk_callback
= visor_read_bulk_callback
,
241 .read_int_callback
= visor_read_int_callback
,
244 /* device info for the Sony Clie OS version 3.5 */
245 static struct usb_serial_driver clie_3_5_device
= {
247 .owner
= THIS_MODULE
,
250 .description
= "Sony Clie 3.5",
251 .usb_driver
= &visor_driver
,
252 .id_table
= clie_id_3_5_table
,
253 .num_interrupt_in
= 0,
258 .close
= visor_close
,
259 .throttle
= visor_throttle
,
260 .unthrottle
= visor_unthrottle
,
261 .attach
= clie_3_5_startup
,
262 .ioctl
= visor_ioctl
,
263 .set_termios
= visor_set_termios
,
264 .write
= visor_write
,
265 .write_room
= visor_write_room
,
266 .chars_in_buffer
= visor_chars_in_buffer
,
267 .write_bulk_callback
= visor_write_bulk_callback
,
268 .read_bulk_callback
= visor_read_bulk_callback
,
271 struct visor_private
{
275 int outstanding_urbs
;
279 /* number of outstanding urbs to prevent userspace DoS from happening */
280 #define URB_UPPER_LIMIT 42
284 /******************************************************************************
285 * Handspring Visor specific driver functions
286 ******************************************************************************/
287 static int visor_open (struct usb_serial_port
*port
, struct file
*filp
)
289 struct usb_serial
*serial
= port
->serial
;
290 struct visor_private
*priv
= usb_get_serial_port_data(port
);
294 dbg("%s - port %d", __FUNCTION__
, port
->number
);
296 if (!port
->read_urb
) {
297 /* this is needed for some brain dead Sony devices */
298 dev_err(&port
->dev
, "Device lied about number of ports, please use a lower one.\n");
302 spin_lock_irqsave(&priv
->lock
, flags
);
306 spin_unlock_irqrestore(&priv
->lock
, flags
);
309 * Force low_latency on so that our tty_push actually forces the data
310 * through, otherwise it is scheduled, and with high data rates (like
311 * with OHCI) data can get lost.
314 port
->tty
->low_latency
= 1;
316 /* Start reading from the device */
317 usb_fill_bulk_urb (port
->read_urb
, serial
->dev
,
318 usb_rcvbulkpipe (serial
->dev
,
319 port
->bulk_in_endpointAddress
),
320 port
->read_urb
->transfer_buffer
,
321 port
->read_urb
->transfer_buffer_length
,
322 visor_read_bulk_callback
, port
);
323 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
325 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n",
326 __FUNCTION__
, result
);
330 if (port
->interrupt_in_urb
) {
331 dbg("%s - adding interrupt input for treo", __FUNCTION__
);
332 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
334 dev_err(&port
->dev
, "%s - failed submitting interrupt urb, error %d\n",
335 __FUNCTION__
, result
);
342 static void visor_close (struct usb_serial_port
*port
, struct file
* filp
)
344 struct visor_private
*priv
= usb_get_serial_port_data(port
);
345 unsigned char *transfer_buffer
;
347 dbg("%s - port %d", __FUNCTION__
, port
->number
);
349 /* shutdown our urbs */
350 usb_kill_urb(port
->read_urb
);
351 usb_kill_urb(port
->interrupt_in_urb
);
353 /* Try to send shutdown message, if the device is gone, this will just fail. */
354 transfer_buffer
= kmalloc (0x12, GFP_KERNEL
);
355 if (transfer_buffer
) {
356 usb_control_msg (port
->serial
->dev
,
357 usb_rcvctrlpipe(port
->serial
->dev
, 0),
358 VISOR_CLOSE_NOTIFICATION
, 0xc2,
360 transfer_buffer
, 0x12, 300);
361 kfree (transfer_buffer
);
365 dev_info(&port
->dev
, "Bytes In = %d Bytes Out = %d\n",
366 priv
->bytes_in
, priv
->bytes_out
);
370 static int visor_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
372 struct visor_private
*priv
= usb_get_serial_port_data(port
);
373 struct usb_serial
*serial
= port
->serial
;
375 unsigned char *buffer
;
379 dbg("%s - port %d", __FUNCTION__
, port
->number
);
381 spin_lock_irqsave(&priv
->lock
, flags
);
382 if (priv
->outstanding_urbs
> URB_UPPER_LIMIT
) {
383 spin_unlock_irqrestore(&priv
->lock
, flags
);
384 dbg("%s - write limit hit\n", __FUNCTION__
);
387 spin_unlock_irqrestore(&priv
->lock
, flags
);
389 buffer
= kmalloc (count
, GFP_ATOMIC
);
391 dev_err(&port
->dev
, "out of memory\n");
395 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
397 dev_err(&port
->dev
, "no more free urbs\n");
402 memcpy (buffer
, buf
, count
);
404 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, buffer
);
406 usb_fill_bulk_urb (urb
, serial
->dev
,
407 usb_sndbulkpipe (serial
->dev
,
408 port
->bulk_out_endpointAddress
),
410 visor_write_bulk_callback
, port
);
412 /* send it down the pipe */
413 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
415 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
416 __FUNCTION__
, status
);
420 spin_lock_irqsave(&priv
->lock
, flags
);
421 ++priv
->outstanding_urbs
;
422 priv
->bytes_out
+= count
;
423 spin_unlock_irqrestore(&priv
->lock
, flags
);
426 /* we are done with this urb, so let the host driver
427 * really free it when it is finished with it */
434 static int visor_write_room (struct usb_serial_port
*port
)
436 struct visor_private
*priv
= usb_get_serial_port_data(port
);
439 dbg("%s - port %d", __FUNCTION__
, port
->number
);
442 * We really can take anything the user throws at us
443 * but let's pick a nice big number to tell the tty
444 * layer that we have lots of free space, unless we don't.
447 spin_lock_irqsave(&priv
->lock
, flags
);
448 if (priv
->outstanding_urbs
> URB_UPPER_LIMIT
* 2 / 3) {
449 spin_unlock_irqrestore(&priv
->lock
, flags
);
450 dbg("%s - write limit hit\n", __FUNCTION__
);
453 spin_unlock_irqrestore(&priv
->lock
, flags
);
459 static int visor_chars_in_buffer (struct usb_serial_port
*port
)
461 dbg("%s - port %d", __FUNCTION__
, port
->number
);
464 * We can't really account for how much data we
465 * have sent out, but hasn't made it through to the
466 * device, so just tell the tty layer that everything
473 static void visor_write_bulk_callback (struct urb
*urb
)
475 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
476 struct visor_private
*priv
= usb_get_serial_port_data(port
);
479 /* free up the transfer buffer, as usb_free_urb() does not do this */
480 kfree (urb
->transfer_buffer
);
482 dbg("%s - port %d", __FUNCTION__
, port
->number
);
485 dbg("%s - nonzero write bulk status received: %d",
486 __FUNCTION__
, urb
->status
);
488 spin_lock_irqsave(&priv
->lock
, flags
);
489 --priv
->outstanding_urbs
;
490 spin_unlock_irqrestore(&priv
->lock
, flags
);
492 usb_serial_port_softint(port
);
496 static void visor_read_bulk_callback (struct urb
*urb
)
498 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
499 struct visor_private
*priv
= usb_get_serial_port_data(port
);
500 unsigned char *data
= urb
->transfer_buffer
;
501 struct tty_struct
*tty
;
506 dbg("%s - port %d", __FUNCTION__
, port
->number
);
509 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__
, urb
->status
);
513 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
516 if (tty
&& urb
->actual_length
) {
517 tty_buffer_request_room(tty
, urb
->actual_length
);
518 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
519 tty_flip_buffer_push(tty
);
521 spin_lock_irqsave(&priv
->lock
, flags
);
522 priv
->bytes_in
+= urb
->actual_length
;
523 throttled
= priv
->throttled
;
524 spin_unlock_irqrestore(&priv
->lock
, flags
);
526 /* Continue trying to always read if we should */
528 usb_fill_bulk_urb (port
->read_urb
, port
->serial
->dev
,
529 usb_rcvbulkpipe(port
->serial
->dev
,
530 port
->bulk_in_endpointAddress
),
531 port
->read_urb
->transfer_buffer
,
532 port
->read_urb
->transfer_buffer_length
,
533 visor_read_bulk_callback
, port
);
534 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
536 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
541 static void visor_read_int_callback (struct urb
*urb
)
543 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
546 switch (urb
->status
) {
553 /* this urb is terminated, clean up */
554 dbg("%s - urb shutting down with status: %d",
555 __FUNCTION__
, urb
->status
);
558 dbg("%s - nonzero urb status received: %d",
559 __FUNCTION__
, urb
->status
);
564 * This information is still unknown what it can be used for.
565 * If anyone has an idea, please let the author know...
567 * Rumor has it this endpoint is used to notify when data
568 * is ready to be read from the bulk ones.
570 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
571 urb
->actual_length
, urb
->transfer_buffer
);
574 result
= usb_submit_urb (urb
, GFP_ATOMIC
);
576 dev_err(&urb
->dev
->dev
, "%s - Error %d submitting interrupt urb\n",
577 __FUNCTION__
, result
);
580 static void visor_throttle (struct usb_serial_port
*port
)
582 struct visor_private
*priv
= usb_get_serial_port_data(port
);
585 dbg("%s - port %d", __FUNCTION__
, port
->number
);
586 spin_lock_irqsave(&priv
->lock
, flags
);
588 spin_unlock_irqrestore(&priv
->lock
, flags
);
592 static void visor_unthrottle (struct usb_serial_port
*port
)
594 struct visor_private
*priv
= usb_get_serial_port_data(port
);
598 dbg("%s - port %d", __FUNCTION__
, port
->number
);
599 spin_lock_irqsave(&priv
->lock
, flags
);
601 spin_unlock_irqrestore(&priv
->lock
, flags
);
603 port
->read_urb
->dev
= port
->serial
->dev
;
604 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
606 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
609 static int palm_os_3_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
611 struct device
*dev
= &serial
->dev
->dev
;
612 struct visor_connection_info
*connection_info
;
613 unsigned char *transfer_buffer
;
619 dbg("%s", __FUNCTION__
);
621 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
622 if (!transfer_buffer
) {
623 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
624 sizeof(*connection_info
));
628 /* send a get connection info request */
629 retval
= usb_control_msg (serial
->dev
,
630 usb_rcvctrlpipe(serial
->dev
, 0),
631 VISOR_GET_CONNECTION_INFORMATION
,
632 0xc2, 0x0000, 0x0000, transfer_buffer
,
633 sizeof(*connection_info
), 300);
635 dev_err(dev
, "%s - error %d getting connection information\n",
636 __FUNCTION__
, retval
);
640 if (retval
== sizeof(*connection_info
)) {
641 connection_info
= (struct visor_connection_info
*)transfer_buffer
;
643 num_ports
= le16_to_cpu(connection_info
->num_ports
);
644 for (i
= 0; i
< num_ports
; ++i
) {
645 switch (connection_info
->connections
[i
].port_function_id
) {
646 case VISOR_FUNCTION_GENERIC
:
649 case VISOR_FUNCTION_DEBUGGER
:
652 case VISOR_FUNCTION_HOTSYNC
:
655 case VISOR_FUNCTION_CONSOLE
:
658 case VISOR_FUNCTION_REMOTE_FILE_SYS
:
659 string
= "Remote File System";
665 dev_info(dev
, "%s: port %d, is for %s use\n",
666 serial
->type
->description
,
667 connection_info
->connections
[i
].port
, string
);
671 * Handle devices that report invalid stuff here.
673 if (num_ports
== 0 || num_ports
> 2) {
674 dev_warn (dev
, "%s: No valid connect info available\n",
675 serial
->type
->description
);
679 dev_info(dev
, "%s: Number of ports: %d\n", serial
->type
->description
,
683 * save off our num_ports info so that we can use it in the
684 * calc_num_ports callback
686 usb_set_serial_data(serial
, (void *)(long)num_ports
);
688 /* ask for the number of bytes available, but ignore the response as it is broken */
689 retval
= usb_control_msg (serial
->dev
,
690 usb_rcvctrlpipe(serial
->dev
, 0),
691 VISOR_REQUEST_BYTES_AVAILABLE
,
692 0xc2, 0x0000, 0x0005, transfer_buffer
,
695 dev_err(dev
, "%s - error %d getting bytes available request\n",
696 __FUNCTION__
, retval
);
700 kfree (transfer_buffer
);
705 static int palm_os_4_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
707 struct device
*dev
= &serial
->dev
->dev
;
708 struct palm_ext_connection_info
*connection_info
;
709 unsigned char *transfer_buffer
;
712 dbg("%s", __FUNCTION__
);
714 transfer_buffer
= kmalloc (sizeof (*connection_info
), GFP_KERNEL
);
715 if (!transfer_buffer
) {
716 dev_err(dev
, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__
,
717 sizeof(*connection_info
));
721 retval
= usb_control_msg (serial
->dev
,
722 usb_rcvctrlpipe(serial
->dev
, 0),
723 PALM_GET_EXT_CONNECTION_INFORMATION
,
724 0xc2, 0x0000, 0x0000, transfer_buffer
,
725 sizeof (*connection_info
), 300);
727 dev_err(dev
, "%s - error %d getting connection info\n",
728 __FUNCTION__
, retval
);
730 usb_serial_debug_data(debug
, &serial
->dev
->dev
, __FUNCTION__
,
731 retval
, transfer_buffer
);
733 kfree (transfer_buffer
);
738 static int visor_probe (struct usb_serial
*serial
, const struct usb_device_id
*id
)
741 int (*startup
) (struct usb_serial
*serial
, const struct usb_device_id
*id
);
743 dbg("%s", __FUNCTION__
);
745 if (serial
->dev
->actconfig
->desc
.bConfigurationValue
!= 1) {
746 err("active config #%d != 1 ??",
747 serial
->dev
->actconfig
->desc
.bConfigurationValue
);
751 if (id
->driver_info
) {
752 startup
= (void *)id
->driver_info
;
753 retval
= startup(serial
, id
);
759 static int visor_calc_num_ports (struct usb_serial
*serial
)
761 int num_ports
= (int)(long)(usb_get_serial_data(serial
));
764 usb_set_serial_data(serial
, NULL
);
769 static int generic_startup(struct usb_serial
*serial
)
771 struct usb_serial_port
**ports
= serial
->port
;
772 struct visor_private
*priv
;
775 for (i
= 0; i
< serial
->num_ports
; ++i
) {
776 priv
= kzalloc (sizeof(*priv
), GFP_KERNEL
);
779 priv
= usb_get_serial_port_data(ports
[i
]);
780 usb_set_serial_port_data(ports
[i
], NULL
);
785 spin_lock_init(&priv
->lock
);
786 usb_set_serial_port_data(ports
[i
], priv
);
791 static int clie_3_5_startup (struct usb_serial
*serial
)
793 struct device
*dev
= &serial
->dev
->dev
;
797 dbg("%s", __FUNCTION__
);
800 * Note that PEG-300 series devices expect the following two calls.
803 /* get the config number */
804 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
805 USB_REQ_GET_CONFIGURATION
, USB_DIR_IN
,
806 0, 0, &data
, 1, 3000);
808 dev_err(dev
, "%s: get config number failed: %d\n", __FUNCTION__
, result
);
812 dev_err(dev
, "%s: get config number bad return length: %d\n", __FUNCTION__
, result
);
816 /* get the interface number */
817 result
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
818 USB_REQ_GET_INTERFACE
,
819 USB_DIR_IN
| USB_RECIP_INTERFACE
,
820 0, 0, &data
, 1, 3000);
822 dev_err(dev
, "%s: get interface number failed: %d\n", __FUNCTION__
, result
);
826 dev_err(dev
, "%s: get interface number bad return length: %d\n", __FUNCTION__
, result
);
830 return generic_startup(serial
);
833 static int treo_attach (struct usb_serial
*serial
)
835 struct usb_serial_port
*swap_port
;
837 /* Only do this endpoint hack for the Handspring devices with
838 * interrupt in endpoints, which for now are the Treo devices. */
839 if (!((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == HANDSPRING_VENDOR_ID
) ||
840 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KYOCERA_VENDOR_ID
)) ||
841 (serial
->num_interrupt_in
== 0))
842 goto generic_startup
;
844 dbg("%s", __FUNCTION__
);
847 * It appears that Treos and Kyoceras want to use the
848 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
849 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
850 * Note that swapping the bulk out endpoints would break lots of
851 * apps that want to communicate on the second port.
853 #define COPY_PORT(dest, src) \
854 dest->read_urb = src->read_urb; \
855 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
856 dest->bulk_in_buffer = src->bulk_in_buffer; \
857 dest->interrupt_in_urb = src->interrupt_in_urb; \
858 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
859 dest->interrupt_in_buffer = src->interrupt_in_buffer;
861 swap_port
= kmalloc(sizeof(*swap_port
), GFP_KERNEL
);
864 COPY_PORT(swap_port
, serial
->port
[0]);
865 COPY_PORT(serial
->port
[0], serial
->port
[1]);
866 COPY_PORT(serial
->port
[1], swap_port
);
870 return generic_startup(serial
);
873 static int clie_5_attach (struct usb_serial
*serial
)
875 dbg("%s", __FUNCTION__
);
877 /* TH55 registers 2 ports.
878 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
879 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
881 Lets do a quick and dirty mapping
884 /* some sanity check */
885 if (serial
->num_ports
< 2)
888 /* port 0 now uses the modified endpoint Address */
889 serial
->port
[0]->bulk_out_endpointAddress
= serial
->port
[1]->bulk_out_endpointAddress
;
891 return generic_startup(serial
);
894 static void visor_shutdown (struct usb_serial
*serial
)
896 struct visor_private
*priv
;
899 dbg("%s", __FUNCTION__
);
901 for (i
= 0; i
< serial
->num_ports
; i
++) {
902 priv
= usb_get_serial_port_data(serial
->port
[i
]);
904 usb_set_serial_port_data(serial
->port
[i
], NULL
);
910 static int visor_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
)
912 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__
, port
->number
, cmd
);
918 /* This function is all nice and good, but we don't change anything based on it :) */
919 static void visor_set_termios (struct usb_serial_port
*port
, struct ktermios
*old_termios
)
923 dbg("%s - port %d", __FUNCTION__
, port
->number
);
925 if ((!port
->tty
) || (!port
->tty
->termios
)) {
926 dbg("%s - no tty structures", __FUNCTION__
);
930 cflag
= port
->tty
->termios
->c_cflag
;
931 /* check that they really want us to change something */
933 if ((cflag
== old_termios
->c_cflag
) &&
934 (RELEVANT_IFLAG(port
->tty
->termios
->c_iflag
) == RELEVANT_IFLAG(old_termios
->c_iflag
))) {
935 dbg("%s - nothing to change...", __FUNCTION__
);
940 /* get the byte size */
941 switch (cflag
& CSIZE
) {
942 case CS5
: dbg("%s - data bits = 5", __FUNCTION__
); break;
943 case CS6
: dbg("%s - data bits = 6", __FUNCTION__
); break;
944 case CS7
: dbg("%s - data bits = 7", __FUNCTION__
); break;
946 case CS8
: dbg("%s - data bits = 8", __FUNCTION__
); break;
949 /* determine the parity */
952 dbg("%s - parity = odd", __FUNCTION__
);
954 dbg("%s - parity = even", __FUNCTION__
);
956 dbg("%s - parity = none", __FUNCTION__
);
958 /* figure out the stop bits requested */
960 dbg("%s - stop bits = 2", __FUNCTION__
);
962 dbg("%s - stop bits = 1", __FUNCTION__
);
965 /* figure out the flow control settings */
967 dbg("%s - RTS/CTS is enabled", __FUNCTION__
);
969 dbg("%s - RTS/CTS is disabled", __FUNCTION__
);
971 /* determine software flow control */
972 if (I_IXOFF(port
->tty
))
973 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
974 __FUNCTION__
, START_CHAR(port
->tty
), STOP_CHAR(port
->tty
));
976 dbg("%s - XON/XOFF is disabled", __FUNCTION__
);
978 /* get the baud rate wanted */
979 dbg("%s - baud rate = %d", __FUNCTION__
, tty_get_baud_rate(port
->tty
));
985 static int __init
visor_init (void)
988 /* Only if parameters were passed to us */
989 if ((vendor
>0) && (product
>0)) {
990 struct usb_device_id usb_dev_temp
[]=
991 {{USB_DEVICE(vendor
, product
),
992 .driver_info
= (kernel_ulong_t
)&palm_os_4_probe
}};
994 /* Find the last entry in id_table */
996 if (id_table
[i
].idVendor
==0) {
997 id_table
[i
] = usb_dev_temp
[0];
1001 /* Find the last entry in id_table_combined */
1003 if (id_table_combined
[i
].idVendor
==0) {
1004 id_table_combined
[i
] = usb_dev_temp
[0];
1008 info("Untested USB device specified at time of module insertion");
1009 info("Warning: This is not guaranteed to work");
1010 info("Using a newer kernel is preferred to this method");
1011 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1014 retval
= usb_serial_register(&handspring_device
);
1016 goto failed_handspring_register
;
1017 retval
= usb_serial_register(&clie_3_5_device
);
1019 goto failed_clie_3_5_register
;
1020 retval
= usb_serial_register(&clie_5_device
);
1022 goto failed_clie_5_register
;
1023 retval
= usb_register(&visor_driver
);
1025 goto failed_usb_register
;
1029 failed_usb_register
:
1030 usb_serial_deregister(&clie_5_device
);
1031 failed_clie_5_register
:
1032 usb_serial_deregister(&clie_3_5_device
);
1033 failed_clie_3_5_register
:
1034 usb_serial_deregister(&handspring_device
);
1035 failed_handspring_register
:
1040 static void __exit
visor_exit (void)
1042 usb_deregister (&visor_driver
);
1043 usb_serial_deregister (&handspring_device
);
1044 usb_serial_deregister (&clie_3_5_device
);
1045 usb_serial_deregister (&clie_5_device
);
1049 module_init(visor_init
);
1050 module_exit(visor_exit
);
1052 MODULE_AUTHOR( DRIVER_AUTHOR
);
1053 MODULE_DESCRIPTION( DRIVER_DESC
);
1054 MODULE_LICENSE("GPL");
1056 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1057 MODULE_PARM_DESC(debug
, "Debug enabled or not");
1058 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1059 MODULE_PARM_DESC(stats
, "Enables statistics or not");
1061 module_param(vendor
, ushort
, 0);
1062 MODULE_PARM_DESC(vendor
, "User specified vendor ID");
1063 module_param(product
, ushort
, 0);
1064 MODULE_PARM_DESC(product
, "User specified product ID");