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/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 <linux/uaccess.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
29 #include <linux/usb/cdc.h>
35 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
36 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
38 /* function prototypes for a handspring visor */
39 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
40 static void visor_close(struct usb_serial_port *port);
41 static int visor_probe(struct usb_serial *serial,
42 const struct usb_device_id *id);
43 static int visor_calc_num_ports(struct usb_serial *serial);
44 static void visor_read_int_callback(struct urb *urb);
45 static int clie_3_5_startup(struct usb_serial *serial);
46 static int treo_attach(struct usb_serial *serial);
47 static int clie_5_attach(struct usb_serial *serial);
48 static int palm_os_3_probe(struct usb_serial *serial,
49 const struct usb_device_id *id);
50 static int palm_os_4_probe(struct usb_serial *serial,
51 const struct usb_device_id *id);
53 static const struct usb_device_id id_table[] = {
54 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
55 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
56 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
57 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
58 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
59 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
60 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
62 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
64 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
66 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
84 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
86 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE_INTERFACE_CLASS(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID, 0xff),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
108 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { } /* Terminating entry */
115 static const struct usb_device_id clie_id_5_table[] = {
116 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
117 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
118 { } /* Terminating entry */
121 static const struct usb_device_id clie_id_3_5_table[] = {
122 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
123 { } /* Terminating entry */
126 static const struct usb_device_id id_table_combined[] = {
127 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
128 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
129 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
130 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
131 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
132 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
133 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
134 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
135 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
140 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
141 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
142 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
143 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
144 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
145 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
148 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
149 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
150 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
151 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
152 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
153 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
154 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
155 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
156 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
157 { } /* Terminating entry */
160 MODULE_DEVICE_TABLE(usb, id_table_combined);
162 /* All of the device info needed for the Handspring Visor,
163 and Palm 4.0 devices */
164 static struct usb_serial_driver handspring_device = {
166 .owner = THIS_MODULE,
169 .description = "Handspring Visor / Palm OS",
170 .id_table = id_table,
172 .bulk_out_size = 256,
174 .close = visor_close,
175 .throttle = usb_serial_generic_throttle,
176 .unthrottle = usb_serial_generic_unthrottle,
177 .attach = treo_attach,
178 .probe = visor_probe,
179 .calc_num_ports = visor_calc_num_ports,
180 .read_int_callback = visor_read_int_callback,
183 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
184 static struct usb_serial_driver clie_5_device = {
186 .owner = THIS_MODULE,
189 .description = "Sony Clie 5.0",
190 .id_table = clie_id_5_table,
192 .bulk_out_size = 256,
194 .close = visor_close,
195 .throttle = usb_serial_generic_throttle,
196 .unthrottle = usb_serial_generic_unthrottle,
197 .attach = clie_5_attach,
198 .probe = visor_probe,
199 .calc_num_ports = visor_calc_num_ports,
200 .read_int_callback = visor_read_int_callback,
203 /* device info for the Sony Clie OS version 3.5 */
204 static struct usb_serial_driver clie_3_5_device = {
206 .owner = THIS_MODULE,
209 .description = "Sony Clie 3.5",
210 .id_table = clie_id_3_5_table,
212 .bulk_out_size = 256,
214 .close = visor_close,
215 .throttle = usb_serial_generic_throttle,
216 .unthrottle = usb_serial_generic_unthrottle,
217 .attach = clie_3_5_startup,
220 static struct usb_serial_driver * const serial_drivers[] = {
221 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
224 /******************************************************************************
225 * Handspring Visor specific driver functions
226 ******************************************************************************/
227 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
231 if (!port->read_urb) {
232 /* this is needed for some brain dead Sony devices */
233 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
237 /* Start reading from the device */
238 result = usb_serial_generic_open(tty, port);
242 if (port->interrupt_in_urb) {
243 dev_dbg(&port->dev, "adding interrupt input for treo\n");
244 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
247 "%s - failed submitting interrupt urb, error %d\n",
255 static void visor_close(struct usb_serial_port *port)
257 unsigned char *transfer_buffer;
259 usb_serial_generic_close(port);
260 usb_kill_urb(port->interrupt_in_urb);
262 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
263 if (!transfer_buffer)
265 usb_control_msg(port->serial->dev,
266 usb_rcvctrlpipe(port->serial->dev, 0),
267 VISOR_CLOSE_NOTIFICATION, 0xc2,
269 transfer_buffer, 0x12, 300);
270 kfree(transfer_buffer);
273 static void visor_read_int_callback(struct urb *urb)
275 struct usb_serial_port *port = urb->context;
276 int status = urb->status;
286 /* this urb is terminated, clean up */
287 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
291 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
297 * This information is still unknown what it can be used for.
298 * If anyone has an idea, please let the author know...
300 * Rumor has it this endpoint is used to notify when data
301 * is ready to be read from the bulk ones.
303 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
304 urb->transfer_buffer);
307 result = usb_submit_urb(urb, GFP_ATOMIC);
309 dev_err(&urb->dev->dev,
310 "%s - Error %d submitting interrupt urb\n",
314 static int palm_os_3_probe(struct usb_serial *serial,
315 const struct usb_device_id *id)
317 struct device *dev = &serial->dev->dev;
318 struct visor_connection_info *connection_info;
319 unsigned char *transfer_buffer;
325 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
326 if (!transfer_buffer)
329 /* send a get connection info request */
330 retval = usb_control_msg(serial->dev,
331 usb_rcvctrlpipe(serial->dev, 0),
332 VISOR_GET_CONNECTION_INFORMATION,
333 0xc2, 0x0000, 0x0000, transfer_buffer,
334 sizeof(*connection_info), 300);
336 dev_err(dev, "%s - error %d getting connection information\n",
341 if (retval == sizeof(*connection_info)) {
342 connection_info = (struct visor_connection_info *)
345 num_ports = le16_to_cpu(connection_info->num_ports);
346 for (i = 0; i < num_ports; ++i) {
348 connection_info->connections[i].port_function_id) {
349 case VISOR_FUNCTION_GENERIC:
352 case VISOR_FUNCTION_DEBUGGER:
355 case VISOR_FUNCTION_HOTSYNC:
358 case VISOR_FUNCTION_CONSOLE:
361 case VISOR_FUNCTION_REMOTE_FILE_SYS:
362 string = "Remote File System";
368 dev_info(dev, "%s: port %d, is for %s use\n",
369 serial->type->description,
370 connection_info->connections[i].port, string);
374 * Handle devices that report invalid stuff here.
376 if (num_ports == 0 || num_ports > 2) {
377 dev_warn(dev, "%s: No valid connect info available\n",
378 serial->type->description);
382 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
386 * save off our num_ports info so that we can use it in the
387 * calc_num_ports callback
389 usb_set_serial_data(serial, (void *)(long)num_ports);
391 /* ask for the number of bytes available, but ignore the
392 response as it is broken */
393 retval = usb_control_msg(serial->dev,
394 usb_rcvctrlpipe(serial->dev, 0),
395 VISOR_REQUEST_BYTES_AVAILABLE,
396 0xc2, 0x0000, 0x0005, transfer_buffer,
399 dev_err(dev, "%s - error %d getting bytes available request\n",
404 kfree(transfer_buffer);
409 static int palm_os_4_probe(struct usb_serial *serial,
410 const struct usb_device_id *id)
412 struct device *dev = &serial->dev->dev;
413 struct palm_ext_connection_info *connection_info;
414 unsigned char *transfer_buffer;
417 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
418 if (!transfer_buffer)
421 retval = usb_control_msg(serial->dev,
422 usb_rcvctrlpipe(serial->dev, 0),
423 PALM_GET_EXT_CONNECTION_INFORMATION,
424 0xc2, 0x0000, 0x0000, transfer_buffer,
425 sizeof(*connection_info), 300);
427 dev_err(dev, "%s - error %d getting connection info\n",
430 usb_serial_debug_data(dev, __func__, retval, transfer_buffer);
432 kfree(transfer_buffer);
437 static int visor_probe(struct usb_serial *serial,
438 const struct usb_device_id *id)
441 int (*startup)(struct usb_serial *serial,
442 const struct usb_device_id *id);
445 * some Samsung Android phones in modem mode have the same ID
446 * as SPH-I500, but they are ACM devices, so dont bind to them
448 if (id->idVendor == SAMSUNG_VENDOR_ID &&
449 id->idProduct == SAMSUNG_SPH_I500_ID &&
450 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
451 serial->dev->descriptor.bDeviceSubClass ==
452 USB_CDC_SUBCLASS_ACM)
455 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
456 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
457 serial->dev->actconfig->desc.bConfigurationValue);
461 if (id->driver_info) {
462 startup = (void *)id->driver_info;
463 retval = startup(serial, id);
469 static int visor_calc_num_ports(struct usb_serial *serial)
471 int num_ports = (int)(long)(usb_get_serial_data(serial));
474 usb_set_serial_data(serial, NULL);
479 static int clie_3_5_startup(struct usb_serial *serial)
481 struct device *dev = &serial->dev->dev;
485 data = kmalloc(1, GFP_KERNEL);
490 * Note that PEG-300 series devices expect the following two calls.
493 /* get the config number */
494 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
495 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
496 0, 0, data, 1, 3000);
498 dev_err(dev, "%s: get config number failed: %d\n",
503 dev_err(dev, "%s: get config number bad return length: %d\n",
509 /* get the interface number */
510 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
511 USB_REQ_GET_INTERFACE,
512 USB_DIR_IN | USB_RECIP_INTERFACE,
513 0, 0, data, 1, 3000);
515 dev_err(dev, "%s: get interface number failed: %d\n",
521 "%s: get interface number bad return length: %d\n",
534 static int treo_attach(struct usb_serial *serial)
536 struct usb_serial_port *swap_port;
538 /* Only do this endpoint hack for the Handspring devices with
539 * interrupt in endpoints, which for now are the Treo devices. */
540 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
541 == HANDSPRING_VENDOR_ID) ||
542 (le16_to_cpu(serial->dev->descriptor.idVendor)
543 == KYOCERA_VENDOR_ID)) ||
544 (serial->num_interrupt_in == 0))
548 * It appears that Treos and Kyoceras want to use the
549 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
550 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
551 * Note that swapping the bulk out endpoints would break lots of
552 * apps that want to communicate on the second port.
554 #define COPY_PORT(dest, src) \
558 for (i = 0; i < ARRAY_SIZE(src->read_urbs); ++i) { \
559 dest->read_urbs[i] = src->read_urbs[i]; \
560 dest->read_urbs[i]->context = dest; \
561 dest->bulk_in_buffers[i] = src->bulk_in_buffers[i]; \
563 dest->read_urb = src->read_urb; \
564 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
565 dest->bulk_in_buffer = src->bulk_in_buffer; \
566 dest->bulk_in_size = src->bulk_in_size; \
567 dest->interrupt_in_urb = src->interrupt_in_urb; \
568 dest->interrupt_in_urb->context = dest; \
569 dest->interrupt_in_endpointAddress = \
570 src->interrupt_in_endpointAddress;\
571 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
574 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
577 COPY_PORT(swap_port, serial->port[0]);
578 COPY_PORT(serial->port[0], serial->port[1]);
579 COPY_PORT(serial->port[1], swap_port);
585 static int clie_5_attach(struct usb_serial *serial)
587 struct usb_serial_port *port;
591 /* TH55 registers 2 ports.
592 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
593 from port 0. Communication out to the UX50/TH55 uses
594 bulk_out_endpointAddress from port 1
596 Lets do a quick and dirty mapping
599 /* some sanity check */
600 if (serial->num_ports < 2)
603 /* port 0 now uses the modified endpoint Address */
604 port = serial->port[0];
605 port->bulk_out_endpointAddress =
606 serial->port[1]->bulk_out_endpointAddress;
608 pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
609 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
610 port->write_urbs[j]->pipe = pipe;
615 module_usb_serial_driver(serial_drivers, id_table_combined);
617 MODULE_AUTHOR(DRIVER_AUTHOR);
618 MODULE_DESCRIPTION(DRIVER_DESC);
619 MODULE_LICENSE("GPL");