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 .disconnect = usb_serial_disconnect,
169 .id_table = id_table_combined,
172 /* All of the device info needed for the Handspring Visor,
173 and Palm 4.0 devices */
174 static struct usb_serial_driver handspring_device = {
176 .owner = THIS_MODULE,
179 .description = "Handspring Visor / Palm OS",
180 .id_table = id_table,
182 .bulk_out_size = 256,
184 .close = visor_close,
185 .throttle = usb_serial_generic_throttle,
186 .unthrottle = usb_serial_generic_unthrottle,
187 .attach = treo_attach,
188 .probe = visor_probe,
189 .calc_num_ports = visor_calc_num_ports,
190 .read_int_callback = visor_read_int_callback,
193 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
194 static struct usb_serial_driver clie_5_device = {
196 .owner = THIS_MODULE,
199 .description = "Sony Clie 5.0",
200 .id_table = clie_id_5_table,
202 .bulk_out_size = 256,
204 .close = visor_close,
205 .throttle = usb_serial_generic_throttle,
206 .unthrottle = usb_serial_generic_unthrottle,
207 .attach = clie_5_attach,
208 .probe = visor_probe,
209 .calc_num_ports = visor_calc_num_ports,
210 .read_int_callback = visor_read_int_callback,
213 /* device info for the Sony Clie OS version 3.5 */
214 static struct usb_serial_driver clie_3_5_device = {
216 .owner = THIS_MODULE,
219 .description = "Sony Clie 3.5",
220 .id_table = clie_id_3_5_table,
222 .bulk_out_size = 256,
224 .close = visor_close,
225 .throttle = usb_serial_generic_throttle,
226 .unthrottle = usb_serial_generic_unthrottle,
227 .attach = clie_3_5_startup,
230 static struct usb_serial_driver * const serial_drivers[] = {
231 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
234 /******************************************************************************
235 * Handspring Visor specific driver functions
236 ******************************************************************************/
237 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
241 if (!port->read_urb) {
242 /* this is needed for some brain dead Sony devices */
243 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
247 /* Start reading from the device */
248 result = usb_serial_generic_open(tty, port);
252 if (port->interrupt_in_urb) {
253 dev_dbg(&port->dev, "adding interrupt input for treo\n");
254 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
257 "%s - failed submitting interrupt urb, error %d\n",
265 static void visor_close(struct usb_serial_port *port)
267 unsigned char *transfer_buffer;
269 /* shutdown our urbs */
270 usb_serial_generic_close(port);
271 usb_kill_urb(port->interrupt_in_urb);
273 mutex_lock(&port->serial->disc_mutex);
274 if (!port->serial->disconnected) {
275 /* Try to send shutdown message, unless the device is gone */
276 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
277 if (transfer_buffer) {
278 usb_control_msg(port->serial->dev,
279 usb_rcvctrlpipe(port->serial->dev, 0),
280 VISOR_CLOSE_NOTIFICATION, 0xc2,
282 transfer_buffer, 0x12, 300);
283 kfree(transfer_buffer);
286 mutex_unlock(&port->serial->disc_mutex);
289 static void visor_read_int_callback(struct urb *urb)
291 struct usb_serial_port *port = urb->context;
292 int status = urb->status;
302 /* this urb is terminated, clean up */
303 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
307 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
313 * This information is still unknown what it can be used for.
314 * If anyone has an idea, please let the author know...
316 * Rumor has it this endpoint is used to notify when data
317 * is ready to be read from the bulk ones.
319 usb_serial_debug_data(debug, &port->dev, __func__,
320 urb->actual_length, urb->transfer_buffer);
323 result = usb_submit_urb(urb, GFP_ATOMIC);
325 dev_err(&urb->dev->dev,
326 "%s - Error %d submitting interrupt urb\n",
330 static int palm_os_3_probe(struct usb_serial *serial,
331 const struct usb_device_id *id)
333 struct device *dev = &serial->dev->dev;
334 struct visor_connection_info *connection_info;
335 unsigned char *transfer_buffer;
341 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
342 if (!transfer_buffer) {
343 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
344 sizeof(*connection_info));
348 /* send a get connection info request */
349 retval = usb_control_msg(serial->dev,
350 usb_rcvctrlpipe(serial->dev, 0),
351 VISOR_GET_CONNECTION_INFORMATION,
352 0xc2, 0x0000, 0x0000, transfer_buffer,
353 sizeof(*connection_info), 300);
355 dev_err(dev, "%s - error %d getting connection information\n",
360 if (retval == sizeof(*connection_info)) {
361 connection_info = (struct visor_connection_info *)
364 num_ports = le16_to_cpu(connection_info->num_ports);
365 for (i = 0; i < num_ports; ++i) {
367 connection_info->connections[i].port_function_id) {
368 case VISOR_FUNCTION_GENERIC:
371 case VISOR_FUNCTION_DEBUGGER:
374 case VISOR_FUNCTION_HOTSYNC:
377 case VISOR_FUNCTION_CONSOLE:
380 case VISOR_FUNCTION_REMOTE_FILE_SYS:
381 string = "Remote File System";
387 dev_info(dev, "%s: port %d, is for %s use\n",
388 serial->type->description,
389 connection_info->connections[i].port, string);
393 * Handle devices that report invalid stuff here.
395 if (num_ports == 0 || num_ports > 2) {
396 dev_warn(dev, "%s: No valid connect info available\n",
397 serial->type->description);
401 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
405 * save off our num_ports info so that we can use it in the
406 * calc_num_ports callback
408 usb_set_serial_data(serial, (void *)(long)num_ports);
410 /* ask for the number of bytes available, but ignore the
411 response as it is broken */
412 retval = usb_control_msg(serial->dev,
413 usb_rcvctrlpipe(serial->dev, 0),
414 VISOR_REQUEST_BYTES_AVAILABLE,
415 0xc2, 0x0000, 0x0005, transfer_buffer,
418 dev_err(dev, "%s - error %d getting bytes available request\n",
423 kfree(transfer_buffer);
428 static int palm_os_4_probe(struct usb_serial *serial,
429 const struct usb_device_id *id)
431 struct device *dev = &serial->dev->dev;
432 struct palm_ext_connection_info *connection_info;
433 unsigned char *transfer_buffer;
436 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
437 if (!transfer_buffer) {
438 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
439 sizeof(*connection_info));
443 retval = usb_control_msg(serial->dev,
444 usb_rcvctrlpipe(serial->dev, 0),
445 PALM_GET_EXT_CONNECTION_INFORMATION,
446 0xc2, 0x0000, 0x0000, transfer_buffer,
447 sizeof(*connection_info), 300);
449 dev_err(dev, "%s - error %d getting connection info\n",
452 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
453 retval, transfer_buffer);
455 kfree(transfer_buffer);
460 static int visor_probe(struct usb_serial *serial,
461 const struct usb_device_id *id)
464 int (*startup)(struct usb_serial *serial,
465 const struct usb_device_id *id);
468 * some Samsung Android phones in modem mode have the same ID
469 * as SPH-I500, but they are ACM devices, so dont bind to them
471 if (id->idVendor == SAMSUNG_VENDOR_ID &&
472 id->idProduct == SAMSUNG_SPH_I500_ID &&
473 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
474 serial->dev->descriptor.bDeviceSubClass ==
475 USB_CDC_SUBCLASS_ACM)
478 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
479 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
480 serial->dev->actconfig->desc.bConfigurationValue);
484 if (id->driver_info) {
485 startup = (void *)id->driver_info;
486 retval = startup(serial, id);
492 static int visor_calc_num_ports(struct usb_serial *serial)
494 int num_ports = (int)(long)(usb_get_serial_data(serial));
497 usb_set_serial_data(serial, NULL);
502 static int clie_3_5_startup(struct usb_serial *serial)
504 struct device *dev = &serial->dev->dev;
508 data = kmalloc(1, GFP_KERNEL);
513 * Note that PEG-300 series devices expect the following two calls.
516 /* get the config number */
517 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
518 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
519 0, 0, data, 1, 3000);
521 dev_err(dev, "%s: get config number failed: %d\n",
526 dev_err(dev, "%s: get config number bad return length: %d\n",
532 /* get the interface number */
533 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
534 USB_REQ_GET_INTERFACE,
535 USB_DIR_IN | USB_RECIP_INTERFACE,
536 0, 0, data, 1, 3000);
538 dev_err(dev, "%s: get interface number failed: %d\n",
544 "%s: get interface number bad return length: %d\n",
557 static int treo_attach(struct usb_serial *serial)
559 struct usb_serial_port *swap_port;
561 /* Only do this endpoint hack for the Handspring devices with
562 * interrupt in endpoints, which for now are the Treo devices. */
563 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
564 == HANDSPRING_VENDOR_ID) ||
565 (le16_to_cpu(serial->dev->descriptor.idVendor)
566 == KYOCERA_VENDOR_ID)) ||
567 (serial->num_interrupt_in == 0))
571 * It appears that Treos and Kyoceras want to use the
572 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
573 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
574 * Note that swapping the bulk out endpoints would break lots of
575 * apps that want to communicate on the second port.
577 #define COPY_PORT(dest, src) \
579 dest->read_urb = src->read_urb; \
580 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
581 dest->bulk_in_buffer = src->bulk_in_buffer; \
582 dest->interrupt_in_urb = src->interrupt_in_urb; \
583 dest->interrupt_in_endpointAddress = \
584 src->interrupt_in_endpointAddress;\
585 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
588 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
591 COPY_PORT(swap_port, serial->port[0]);
592 COPY_PORT(serial->port[0], serial->port[1]);
593 COPY_PORT(serial->port[1], swap_port);
599 static int clie_5_attach(struct usb_serial *serial)
601 struct usb_serial_port *port;
605 /* TH55 registers 2 ports.
606 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
607 from port 0. Communication out to the UX50/TH55 uses
608 bulk_out_endpointAddress from port 1
610 Lets do a quick and dirty mapping
613 /* some sanity check */
614 if (serial->num_ports < 2)
617 /* port 0 now uses the modified endpoint Address */
618 port = serial->port[0];
619 port->bulk_out_endpointAddress =
620 serial->port[1]->bulk_out_endpointAddress;
622 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
623 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
624 port->write_urbs[j]->pipe = pipe;
629 module_usb_serial_driver(visor_driver, serial_drivers);
631 MODULE_AUTHOR(DRIVER_AUTHOR);
632 MODULE_DESCRIPTION(DRIVER_DESC);
633 MODULE_LICENSE("GPL");
635 module_param(debug, bool, S_IRUGO | S_IWUSR);
636 MODULE_PARM_DESC(debug, "Debug enabled or not");