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
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/spinlock.h>
27 #include <linux/uaccess.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
30 #include <linux/usb/cdc.h>
36 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
37 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
39 /* function prototypes for a handspring visor */
40 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
41 static void visor_close(struct usb_serial_port *port);
42 static int visor_probe(struct usb_serial *serial,
43 const struct usb_device_id *id);
44 static int visor_calc_num_ports(struct usb_serial *serial);
45 static void visor_read_int_callback(struct urb *urb);
46 static int clie_3_5_startup(struct usb_serial *serial);
47 static int treo_attach(struct usb_serial *serial);
48 static int clie_5_attach(struct usb_serial *serial);
49 static int palm_os_3_probe(struct usb_serial *serial,
50 const struct usb_device_id *id);
51 static int palm_os_4_probe(struct usb_serial *serial,
52 const struct usb_device_id *id);
54 /* Parameters that may be passed into the module. */
57 static struct usb_device_id id_table [] = {
58 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
59 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
60 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
62 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
64 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
66 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
84 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
86 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
108 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
116 { } /* Terminating entry */
119 static struct usb_device_id clie_id_5_table [] = {
120 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
121 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
122 { } /* Terminating entry */
125 static struct usb_device_id clie_id_3_5_table [] = {
126 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
127 { } /* Terminating entry */
130 static struct usb_device_id id_table_combined [] = {
131 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
132 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
133 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
134 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
135 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
143 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
144 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
145 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
148 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
151 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
152 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
153 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
154 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
155 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
156 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
157 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
158 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
159 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
160 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
161 { } /* Terminating entry */
164 MODULE_DEVICE_TABLE(usb, id_table_combined);
166 static struct usb_driver visor_driver = {
168 .id_table = id_table_combined,
171 /* All of the device info needed for the Handspring Visor,
172 and Palm 4.0 devices */
173 static struct usb_serial_driver handspring_device = {
175 .owner = THIS_MODULE,
178 .description = "Handspring Visor / Palm OS",
179 .id_table = id_table,
181 .bulk_out_size = 256,
183 .close = visor_close,
184 .throttle = usb_serial_generic_throttle,
185 .unthrottle = usb_serial_generic_unthrottle,
186 .attach = treo_attach,
187 .probe = visor_probe,
188 .calc_num_ports = visor_calc_num_ports,
189 .read_int_callback = visor_read_int_callback,
192 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
193 static struct usb_serial_driver clie_5_device = {
195 .owner = THIS_MODULE,
198 .description = "Sony Clie 5.0",
199 .id_table = clie_id_5_table,
201 .bulk_out_size = 256,
203 .close = visor_close,
204 .throttle = usb_serial_generic_throttle,
205 .unthrottle = usb_serial_generic_unthrottle,
206 .attach = clie_5_attach,
207 .probe = visor_probe,
208 .calc_num_ports = visor_calc_num_ports,
209 .read_int_callback = visor_read_int_callback,
212 /* device info for the Sony Clie OS version 3.5 */
213 static struct usb_serial_driver clie_3_5_device = {
215 .owner = THIS_MODULE,
218 .description = "Sony Clie 3.5",
219 .id_table = clie_id_3_5_table,
221 .bulk_out_size = 256,
223 .close = visor_close,
224 .throttle = usb_serial_generic_throttle,
225 .unthrottle = usb_serial_generic_unthrottle,
226 .attach = clie_3_5_startup,
229 static struct usb_serial_driver * const serial_drivers[] = {
230 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
233 /******************************************************************************
234 * Handspring Visor specific driver functions
235 ******************************************************************************/
236 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
240 if (!port->read_urb) {
241 /* this is needed for some brain dead Sony devices */
242 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
246 /* Start reading from the device */
247 result = usb_serial_generic_open(tty, port);
251 if (port->interrupt_in_urb) {
252 dev_dbg(&port->dev, "adding interrupt input for treo\n");
253 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
256 "%s - failed submitting interrupt urb, error %d\n",
264 static void visor_close(struct usb_serial_port *port)
266 unsigned char *transfer_buffer;
268 /* shutdown our urbs */
269 usb_serial_generic_close(port);
270 usb_kill_urb(port->interrupt_in_urb);
272 mutex_lock(&port->serial->disc_mutex);
273 if (!port->serial->disconnected) {
274 /* Try to send shutdown message, unless the device is gone */
275 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
276 if (transfer_buffer) {
277 usb_control_msg(port->serial->dev,
278 usb_rcvctrlpipe(port->serial->dev, 0),
279 VISOR_CLOSE_NOTIFICATION, 0xc2,
281 transfer_buffer, 0x12, 300);
282 kfree(transfer_buffer);
285 mutex_unlock(&port->serial->disc_mutex);
288 static void visor_read_int_callback(struct urb *urb)
290 struct usb_serial_port *port = urb->context;
291 int status = urb->status;
301 /* this urb is terminated, clean up */
302 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
306 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
312 * This information is still unknown what it can be used for.
313 * If anyone has an idea, please let the author know...
315 * Rumor has it this endpoint is used to notify when data
316 * is ready to be read from the bulk ones.
318 usb_serial_debug_data(debug, &port->dev, __func__,
319 urb->actual_length, urb->transfer_buffer);
322 result = usb_submit_urb(urb, GFP_ATOMIC);
324 dev_err(&urb->dev->dev,
325 "%s - Error %d submitting interrupt urb\n",
329 static int palm_os_3_probe(struct usb_serial *serial,
330 const struct usb_device_id *id)
332 struct device *dev = &serial->dev->dev;
333 struct visor_connection_info *connection_info;
334 unsigned char *transfer_buffer;
340 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
341 if (!transfer_buffer) {
342 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
343 sizeof(*connection_info));
347 /* send a get connection info request */
348 retval = usb_control_msg(serial->dev,
349 usb_rcvctrlpipe(serial->dev, 0),
350 VISOR_GET_CONNECTION_INFORMATION,
351 0xc2, 0x0000, 0x0000, transfer_buffer,
352 sizeof(*connection_info), 300);
354 dev_err(dev, "%s - error %d getting connection information\n",
359 if (retval == sizeof(*connection_info)) {
360 connection_info = (struct visor_connection_info *)
363 num_ports = le16_to_cpu(connection_info->num_ports);
364 for (i = 0; i < num_ports; ++i) {
366 connection_info->connections[i].port_function_id) {
367 case VISOR_FUNCTION_GENERIC:
370 case VISOR_FUNCTION_DEBUGGER:
373 case VISOR_FUNCTION_HOTSYNC:
376 case VISOR_FUNCTION_CONSOLE:
379 case VISOR_FUNCTION_REMOTE_FILE_SYS:
380 string = "Remote File System";
386 dev_info(dev, "%s: port %d, is for %s use\n",
387 serial->type->description,
388 connection_info->connections[i].port, string);
392 * Handle devices that report invalid stuff here.
394 if (num_ports == 0 || num_ports > 2) {
395 dev_warn(dev, "%s: No valid connect info available\n",
396 serial->type->description);
400 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
404 * save off our num_ports info so that we can use it in the
405 * calc_num_ports callback
407 usb_set_serial_data(serial, (void *)(long)num_ports);
409 /* ask for the number of bytes available, but ignore the
410 response as it is broken */
411 retval = usb_control_msg(serial->dev,
412 usb_rcvctrlpipe(serial->dev, 0),
413 VISOR_REQUEST_BYTES_AVAILABLE,
414 0xc2, 0x0000, 0x0005, transfer_buffer,
417 dev_err(dev, "%s - error %d getting bytes available request\n",
422 kfree(transfer_buffer);
427 static int palm_os_4_probe(struct usb_serial *serial,
428 const struct usb_device_id *id)
430 struct device *dev = &serial->dev->dev;
431 struct palm_ext_connection_info *connection_info;
432 unsigned char *transfer_buffer;
435 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
436 if (!transfer_buffer) {
437 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
438 sizeof(*connection_info));
442 retval = usb_control_msg(serial->dev,
443 usb_rcvctrlpipe(serial->dev, 0),
444 PALM_GET_EXT_CONNECTION_INFORMATION,
445 0xc2, 0x0000, 0x0000, transfer_buffer,
446 sizeof(*connection_info), 300);
448 dev_err(dev, "%s - error %d getting connection info\n",
451 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
452 retval, transfer_buffer);
454 kfree(transfer_buffer);
459 static int visor_probe(struct usb_serial *serial,
460 const struct usb_device_id *id)
463 int (*startup)(struct usb_serial *serial,
464 const struct usb_device_id *id);
467 * some Samsung Android phones in modem mode have the same ID
468 * as SPH-I500, but they are ACM devices, so dont bind to them
470 if (id->idVendor == SAMSUNG_VENDOR_ID &&
471 id->idProduct == SAMSUNG_SPH_I500_ID &&
472 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
473 serial->dev->descriptor.bDeviceSubClass ==
474 USB_CDC_SUBCLASS_ACM)
477 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
478 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
479 serial->dev->actconfig->desc.bConfigurationValue);
483 if (id->driver_info) {
484 startup = (void *)id->driver_info;
485 retval = startup(serial, id);
491 static int visor_calc_num_ports(struct usb_serial *serial)
493 int num_ports = (int)(long)(usb_get_serial_data(serial));
496 usb_set_serial_data(serial, NULL);
501 static int clie_3_5_startup(struct usb_serial *serial)
503 struct device *dev = &serial->dev->dev;
507 data = kmalloc(1, GFP_KERNEL);
512 * Note that PEG-300 series devices expect the following two calls.
515 /* get the config number */
516 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
517 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
518 0, 0, data, 1, 3000);
520 dev_err(dev, "%s: get config number failed: %d\n",
525 dev_err(dev, "%s: get config number bad return length: %d\n",
531 /* get the interface number */
532 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
533 USB_REQ_GET_INTERFACE,
534 USB_DIR_IN | USB_RECIP_INTERFACE,
535 0, 0, data, 1, 3000);
537 dev_err(dev, "%s: get interface number failed: %d\n",
543 "%s: get interface number bad return length: %d\n",
556 static int treo_attach(struct usb_serial *serial)
558 struct usb_serial_port *swap_port;
560 /* Only do this endpoint hack for the Handspring devices with
561 * interrupt in endpoints, which for now are the Treo devices. */
562 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
563 == HANDSPRING_VENDOR_ID) ||
564 (le16_to_cpu(serial->dev->descriptor.idVendor)
565 == KYOCERA_VENDOR_ID)) ||
566 (serial->num_interrupt_in == 0))
570 * It appears that Treos and Kyoceras want to use the
571 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
572 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
573 * Note that swapping the bulk out endpoints would break lots of
574 * apps that want to communicate on the second port.
576 #define COPY_PORT(dest, src) \
578 dest->read_urb = src->read_urb; \
579 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
580 dest->bulk_in_buffer = src->bulk_in_buffer; \
581 dest->interrupt_in_urb = src->interrupt_in_urb; \
582 dest->interrupt_in_endpointAddress = \
583 src->interrupt_in_endpointAddress;\
584 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
587 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
590 COPY_PORT(swap_port, serial->port[0]);
591 COPY_PORT(serial->port[0], serial->port[1]);
592 COPY_PORT(serial->port[1], swap_port);
598 static int clie_5_attach(struct usb_serial *serial)
600 struct usb_serial_port *port;
604 /* TH55 registers 2 ports.
605 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
606 from port 0. Communication out to the UX50/TH55 uses
607 bulk_out_endpointAddress from port 1
609 Lets do a quick and dirty mapping
612 /* some sanity check */
613 if (serial->num_ports < 2)
616 /* port 0 now uses the modified endpoint Address */
617 port = serial->port[0];
618 port->bulk_out_endpointAddress =
619 serial->port[1]->bulk_out_endpointAddress;
621 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
622 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
623 port->write_urbs[j]->pipe = pipe;
628 module_usb_serial_driver(visor_driver, serial_drivers);
630 MODULE_AUTHOR(DRIVER_AUTHOR);
631 MODULE_DESCRIPTION(DRIVER_DESC);
632 MODULE_LICENSE("GPL");
634 module_param(debug, bool, S_IRUGO | S_IWUSR);
635 MODULE_PARM_DESC(debug, "Debug enabled or not");