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 static struct usb_device_id id_table [] = {
55 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
56 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
57 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
58 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
59 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
60 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
61 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
62 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
63 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
64 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
65 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
66 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
67 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
68 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
69 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
70 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
71 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
72 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
73 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
74 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
75 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
76 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
77 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
78 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
79 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
80 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
81 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
82 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
83 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
84 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
85 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
86 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
87 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
88 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
89 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
90 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
91 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
92 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
93 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
94 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
95 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
96 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
97 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
98 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
99 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
100 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
101 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
102 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
103 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
104 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
105 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
106 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
107 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
108 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
109 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
110 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
111 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
112 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
113 { } /* Terminating entry */
116 static struct usb_device_id clie_id_5_table [] = {
117 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
118 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
119 { } /* Terminating entry */
122 static struct usb_device_id clie_id_3_5_table [] = {
123 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
124 { } /* Terminating entry */
127 static struct usb_device_id id_table_combined [] = {
128 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
129 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
130 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
131 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
132 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
133 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
134 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
135 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
142 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
143 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
144 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
145 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
148 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
150 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
151 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
152 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
153 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
154 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
155 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
156 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
157 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
158 { } /* Terminating entry */
161 MODULE_DEVICE_TABLE(usb, id_table_combined);
163 /* All of the device info needed for the Handspring Visor,
164 and Palm 4.0 devices */
165 static struct usb_serial_driver handspring_device = {
167 .owner = THIS_MODULE,
170 .description = "Handspring Visor / Palm OS",
171 .id_table = id_table,
173 .bulk_out_size = 256,
175 .close = visor_close,
176 .throttle = usb_serial_generic_throttle,
177 .unthrottle = usb_serial_generic_unthrottle,
178 .attach = treo_attach,
179 .probe = visor_probe,
180 .calc_num_ports = visor_calc_num_ports,
181 .read_int_callback = visor_read_int_callback,
184 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
185 static struct usb_serial_driver clie_5_device = {
187 .owner = THIS_MODULE,
190 .description = "Sony Clie 5.0",
191 .id_table = clie_id_5_table,
193 .bulk_out_size = 256,
195 .close = visor_close,
196 .throttle = usb_serial_generic_throttle,
197 .unthrottle = usb_serial_generic_unthrottle,
198 .attach = clie_5_attach,
199 .probe = visor_probe,
200 .calc_num_ports = visor_calc_num_ports,
201 .read_int_callback = visor_read_int_callback,
204 /* device info for the Sony Clie OS version 3.5 */
205 static struct usb_serial_driver clie_3_5_device = {
207 .owner = THIS_MODULE,
210 .description = "Sony Clie 3.5",
211 .id_table = clie_id_3_5_table,
213 .bulk_out_size = 256,
215 .close = visor_close,
216 .throttle = usb_serial_generic_throttle,
217 .unthrottle = usb_serial_generic_unthrottle,
218 .attach = clie_3_5_startup,
221 static struct usb_serial_driver * const serial_drivers[] = {
222 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
225 /******************************************************************************
226 * Handspring Visor specific driver functions
227 ******************************************************************************/
228 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
232 if (!port->read_urb) {
233 /* this is needed for some brain dead Sony devices */
234 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
238 /* Start reading from the device */
239 result = usb_serial_generic_open(tty, port);
243 if (port->interrupt_in_urb) {
244 dev_dbg(&port->dev, "adding interrupt input for treo\n");
245 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
248 "%s - failed submitting interrupt urb, error %d\n",
256 static void visor_close(struct usb_serial_port *port)
258 unsigned char *transfer_buffer;
260 /* shutdown our urbs */
261 usb_serial_generic_close(port);
262 usb_kill_urb(port->interrupt_in_urb);
264 mutex_lock(&port->serial->disc_mutex);
265 if (!port->serial->disconnected) {
266 /* Try to send shutdown message, unless the device is gone */
267 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
268 if (transfer_buffer) {
269 usb_control_msg(port->serial->dev,
270 usb_rcvctrlpipe(port->serial->dev, 0),
271 VISOR_CLOSE_NOTIFICATION, 0xc2,
273 transfer_buffer, 0x12, 300);
274 kfree(transfer_buffer);
277 mutex_unlock(&port->serial->disc_mutex);
280 static void visor_read_int_callback(struct urb *urb)
282 struct usb_serial_port *port = urb->context;
283 int status = urb->status;
293 /* this urb is terminated, clean up */
294 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
298 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
304 * This information is still unknown what it can be used for.
305 * If anyone has an idea, please let the author know...
307 * Rumor has it this endpoint is used to notify when data
308 * is ready to be read from the bulk ones.
310 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
311 urb->transfer_buffer);
314 result = usb_submit_urb(urb, GFP_ATOMIC);
316 dev_err(&urb->dev->dev,
317 "%s - Error %d submitting interrupt urb\n",
321 static int palm_os_3_probe(struct usb_serial *serial,
322 const struct usb_device_id *id)
324 struct device *dev = &serial->dev->dev;
325 struct visor_connection_info *connection_info;
326 unsigned char *transfer_buffer;
332 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
333 if (!transfer_buffer) {
334 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
335 sizeof(*connection_info));
339 /* send a get connection info request */
340 retval = usb_control_msg(serial->dev,
341 usb_rcvctrlpipe(serial->dev, 0),
342 VISOR_GET_CONNECTION_INFORMATION,
343 0xc2, 0x0000, 0x0000, transfer_buffer,
344 sizeof(*connection_info), 300);
346 dev_err(dev, "%s - error %d getting connection information\n",
351 if (retval == sizeof(*connection_info)) {
352 connection_info = (struct visor_connection_info *)
355 num_ports = le16_to_cpu(connection_info->num_ports);
356 for (i = 0; i < num_ports; ++i) {
358 connection_info->connections[i].port_function_id) {
359 case VISOR_FUNCTION_GENERIC:
362 case VISOR_FUNCTION_DEBUGGER:
365 case VISOR_FUNCTION_HOTSYNC:
368 case VISOR_FUNCTION_CONSOLE:
371 case VISOR_FUNCTION_REMOTE_FILE_SYS:
372 string = "Remote File System";
378 dev_info(dev, "%s: port %d, is for %s use\n",
379 serial->type->description,
380 connection_info->connections[i].port, string);
384 * Handle devices that report invalid stuff here.
386 if (num_ports == 0 || num_ports > 2) {
387 dev_warn(dev, "%s: No valid connect info available\n",
388 serial->type->description);
392 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
396 * save off our num_ports info so that we can use it in the
397 * calc_num_ports callback
399 usb_set_serial_data(serial, (void *)(long)num_ports);
401 /* ask for the number of bytes available, but ignore the
402 response as it is broken */
403 retval = usb_control_msg(serial->dev,
404 usb_rcvctrlpipe(serial->dev, 0),
405 VISOR_REQUEST_BYTES_AVAILABLE,
406 0xc2, 0x0000, 0x0005, transfer_buffer,
409 dev_err(dev, "%s - error %d getting bytes available request\n",
414 kfree(transfer_buffer);
419 static int palm_os_4_probe(struct usb_serial *serial,
420 const struct usb_device_id *id)
422 struct device *dev = &serial->dev->dev;
423 struct palm_ext_connection_info *connection_info;
424 unsigned char *transfer_buffer;
427 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
428 if (!transfer_buffer) {
429 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
430 sizeof(*connection_info));
434 retval = usb_control_msg(serial->dev,
435 usb_rcvctrlpipe(serial->dev, 0),
436 PALM_GET_EXT_CONNECTION_INFORMATION,
437 0xc2, 0x0000, 0x0000, transfer_buffer,
438 sizeof(*connection_info), 300);
440 dev_err(dev, "%s - error %d getting connection info\n",
443 usb_serial_debug_data(dev, __func__, retval, transfer_buffer);
445 kfree(transfer_buffer);
450 static int visor_probe(struct usb_serial *serial,
451 const struct usb_device_id *id)
454 int (*startup)(struct usb_serial *serial,
455 const struct usb_device_id *id);
458 * some Samsung Android phones in modem mode have the same ID
459 * as SPH-I500, but they are ACM devices, so dont bind to them
461 if (id->idVendor == SAMSUNG_VENDOR_ID &&
462 id->idProduct == SAMSUNG_SPH_I500_ID &&
463 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
464 serial->dev->descriptor.bDeviceSubClass ==
465 USB_CDC_SUBCLASS_ACM)
468 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
469 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
470 serial->dev->actconfig->desc.bConfigurationValue);
474 if (id->driver_info) {
475 startup = (void *)id->driver_info;
476 retval = startup(serial, id);
482 static int visor_calc_num_ports(struct usb_serial *serial)
484 int num_ports = (int)(long)(usb_get_serial_data(serial));
487 usb_set_serial_data(serial, NULL);
492 static int clie_3_5_startup(struct usb_serial *serial)
494 struct device *dev = &serial->dev->dev;
498 data = kmalloc(1, GFP_KERNEL);
503 * Note that PEG-300 series devices expect the following two calls.
506 /* get the config number */
507 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
508 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
509 0, 0, data, 1, 3000);
511 dev_err(dev, "%s: get config number failed: %d\n",
516 dev_err(dev, "%s: get config number bad return length: %d\n",
522 /* get the interface number */
523 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
524 USB_REQ_GET_INTERFACE,
525 USB_DIR_IN | USB_RECIP_INTERFACE,
526 0, 0, data, 1, 3000);
528 dev_err(dev, "%s: get interface number failed: %d\n",
534 "%s: get interface number bad return length: %d\n",
547 static int treo_attach(struct usb_serial *serial)
549 struct usb_serial_port *swap_port;
551 /* Only do this endpoint hack for the Handspring devices with
552 * interrupt in endpoints, which for now are the Treo devices. */
553 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
554 == HANDSPRING_VENDOR_ID) ||
555 (le16_to_cpu(serial->dev->descriptor.idVendor)
556 == KYOCERA_VENDOR_ID)) ||
557 (serial->num_interrupt_in == 0))
561 * It appears that Treos and Kyoceras want to use the
562 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
563 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
564 * Note that swapping the bulk out endpoints would break lots of
565 * apps that want to communicate on the second port.
567 #define COPY_PORT(dest, src) \
569 dest->read_urb = src->read_urb; \
570 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
571 dest->bulk_in_buffer = src->bulk_in_buffer; \
572 dest->interrupt_in_urb = src->interrupt_in_urb; \
573 dest->interrupt_in_endpointAddress = \
574 src->interrupt_in_endpointAddress;\
575 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
578 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
581 COPY_PORT(swap_port, serial->port[0]);
582 COPY_PORT(serial->port[0], serial->port[1]);
583 COPY_PORT(serial->port[1], swap_port);
589 static int clie_5_attach(struct usb_serial *serial)
591 struct usb_serial_port *port;
595 /* TH55 registers 2 ports.
596 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
597 from port 0. Communication out to the UX50/TH55 uses
598 bulk_out_endpointAddress from port 1
600 Lets do a quick and dirty mapping
603 /* some sanity check */
604 if (serial->num_ports < 2)
607 /* port 0 now uses the modified endpoint Address */
608 port = serial->port[0];
609 port->bulk_out_endpointAddress =
610 serial->port[1]->bulk_out_endpointAddress;
612 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
613 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
614 port->write_urbs[j]->pipe = pipe;
619 module_usb_serial_driver(serial_drivers, id_table_combined);
621 MODULE_AUTHOR(DRIVER_AUTHOR);
622 MODULE_DESCRIPTION(DRIVER_DESC);
623 MODULE_LICENSE("GPL");