1 // SPDX-License-Identifier: GPL-2.0
3 * USB HandSpring Visor, Palm m50x, and Sony Clie driver
4 * (supports all of the Palm OS USB devices)
6 * Copyright (C) 1999 - 2004
9 * See Documentation/usb/usb-serial.rst for more information on using this
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/slab.h>
17 #include <linux/tty.h>
18 #include <linux/tty_driver.h>
19 #include <linux/tty_flip.h>
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/spinlock.h>
23 #include <linux/uaccess.h>
24 #include <linux/usb.h>
25 #include <linux/usb/serial.h>
26 #include <linux/usb/cdc.h>
33 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
35 /* function prototypes for a handspring visor */
36 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port);
37 static void visor_close(struct usb_serial_port *port);
38 static int visor_probe(struct usb_serial *serial,
39 const struct usb_device_id *id);
40 static int visor_calc_num_ports(struct usb_serial *serial,
41 struct usb_serial_endpoints *epds);
42 static int clie_5_calc_num_ports(struct usb_serial *serial,
43 struct usb_serial_endpoints *epds);
44 static void visor_read_int_callback(struct urb *urb);
45 static int clie_3_5_startup(struct usb_serial *serial);
46 static int palm_os_3_probe(struct usb_serial *serial,
47 const struct usb_device_id *id);
48 static int palm_os_4_probe(struct usb_serial *serial,
49 const struct usb_device_id *id);
51 static const struct usb_device_id id_table[] = {
52 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
53 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
54 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
55 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
56 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
57 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
58 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
59 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
60 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
61 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
62 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
63 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
64 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
66 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
84 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
86 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE_INTERFACE_CLASS(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID, 0xff),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
108 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { } /* Terminating entry */
113 static const struct usb_device_id clie_id_5_table[] = {
114 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
116 { } /* Terminating entry */
119 static const struct usb_device_id clie_id_3_5_table[] = {
120 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
121 { } /* Terminating entry */
124 static const struct usb_device_id id_table_combined[] = {
125 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
126 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
127 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
128 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
129 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
130 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
131 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
132 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
133 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
134 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
135 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
136 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
137 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
138 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
139 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
140 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
141 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
142 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
143 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
144 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
145 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
146 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
147 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
148 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
149 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
150 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
151 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
152 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
153 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
154 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
155 { } /* Terminating entry */
158 MODULE_DEVICE_TABLE(usb, id_table_combined);
160 /* All of the device info needed for the Handspring Visor,
161 and Palm 4.0 devices */
162 static struct usb_serial_driver handspring_device = {
166 .description = "Handspring Visor / Palm OS",
167 .id_table = id_table,
169 .bulk_out_size = 256,
171 .close = visor_close,
172 .throttle = usb_serial_generic_throttle,
173 .unthrottle = usb_serial_generic_unthrottle,
174 .probe = visor_probe,
175 .calc_num_ports = visor_calc_num_ports,
176 .read_int_callback = visor_read_int_callback,
179 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
180 static struct usb_serial_driver clie_5_device = {
184 .description = "Sony Clie 5.0",
185 .id_table = clie_id_5_table,
188 .bulk_out_size = 256,
190 .close = visor_close,
191 .throttle = usb_serial_generic_throttle,
192 .unthrottle = usb_serial_generic_unthrottle,
193 .probe = visor_probe,
194 .calc_num_ports = clie_5_calc_num_ports,
195 .read_int_callback = visor_read_int_callback,
198 /* device info for the Sony Clie OS version 3.5 */
199 static struct usb_serial_driver clie_3_5_device = {
203 .description = "Sony Clie 3.5",
204 .id_table = clie_id_3_5_table,
206 .bulk_out_size = 256,
208 .close = visor_close,
209 .throttle = usb_serial_generic_throttle,
210 .unthrottle = usb_serial_generic_unthrottle,
211 .attach = clie_3_5_startup,
214 static struct usb_serial_driver * const serial_drivers[] = {
215 &handspring_device, &clie_5_device, &clie_3_5_device, NULL
218 /******************************************************************************
219 * Handspring Visor specific driver functions
220 ******************************************************************************/
221 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
225 if (!port->read_urb) {
226 /* this is needed for some brain dead Sony devices */
227 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
231 /* Start reading from the device */
232 result = usb_serial_generic_open(tty, port);
236 if (port->interrupt_in_urb) {
237 dev_dbg(&port->dev, "adding interrupt input for treo\n");
238 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
241 "%s - failed submitting interrupt urb, error %d\n",
249 static void visor_close(struct usb_serial_port *port)
251 unsigned char *transfer_buffer;
253 usb_serial_generic_close(port);
254 usb_kill_urb(port->interrupt_in_urb);
256 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
257 if (!transfer_buffer)
259 usb_control_msg(port->serial->dev,
260 usb_rcvctrlpipe(port->serial->dev, 0),
261 VISOR_CLOSE_NOTIFICATION, 0xc2,
263 transfer_buffer, 0x12, 300);
264 kfree(transfer_buffer);
267 static void visor_read_int_callback(struct urb *urb)
269 struct usb_serial_port *port = urb->context;
270 int status = urb->status;
280 /* this urb is terminated, clean up */
281 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
285 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
291 * This information is still unknown what it can be used for.
292 * If anyone has an idea, please let the author know...
294 * Rumor has it this endpoint is used to notify when data
295 * is ready to be read from the bulk ones.
297 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
298 urb->transfer_buffer);
301 result = usb_submit_urb(urb, GFP_ATOMIC);
303 dev_err(&urb->dev->dev,
304 "%s - Error %d submitting interrupt urb\n",
308 static int palm_os_3_probe(struct usb_serial *serial,
309 const struct usb_device_id *id)
311 struct device *dev = &serial->dev->dev;
312 struct visor_connection_info *connection_info;
313 unsigned char *transfer_buffer;
319 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
320 if (!transfer_buffer)
323 /* send a get connection info request */
324 retval = usb_control_msg(serial->dev,
325 usb_rcvctrlpipe(serial->dev, 0),
326 VISOR_GET_CONNECTION_INFORMATION,
327 0xc2, 0x0000, 0x0000, transfer_buffer,
328 sizeof(*connection_info), 300);
330 dev_err(dev, "%s - error %d getting connection information\n",
335 if (retval != sizeof(*connection_info)) {
336 dev_err(dev, "Invalid connection information received from device\n");
341 connection_info = (struct visor_connection_info *)transfer_buffer;
343 num_ports = le16_to_cpu(connection_info->num_ports);
345 /* Handle devices that report invalid stuff here. */
346 if (num_ports == 0 || num_ports > 2) {
347 dev_warn(dev, "%s: No valid connect info available\n",
348 serial->type->description);
352 for (i = 0; i < num_ports; ++i) {
353 switch (connection_info->connections[i].port_function_id) {
354 case VISOR_FUNCTION_GENERIC:
357 case VISOR_FUNCTION_DEBUGGER:
360 case VISOR_FUNCTION_HOTSYNC:
363 case VISOR_FUNCTION_CONSOLE:
366 case VISOR_FUNCTION_REMOTE_FILE_SYS:
367 string = "Remote File System";
373 dev_info(dev, "%s: port %d, is for %s use\n",
374 serial->type->description,
375 connection_info->connections[i].port, string);
377 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
381 * save off our num_ports info so that we can use it in the
382 * calc_num_ports callback
384 usb_set_serial_data(serial, (void *)(long)num_ports);
386 /* ask for the number of bytes available, but ignore the
387 response as it is broken */
388 retval = usb_control_msg(serial->dev,
389 usb_rcvctrlpipe(serial->dev, 0),
390 VISOR_REQUEST_BYTES_AVAILABLE,
391 0xc2, 0x0000, 0x0005, transfer_buffer,
394 dev_err(dev, "%s - error %d getting bytes available request\n",
399 kfree(transfer_buffer);
404 static int palm_os_4_probe(struct usb_serial *serial,
405 const struct usb_device_id *id)
407 struct device *dev = &serial->dev->dev;
408 struct palm_ext_connection_info *connection_info;
409 unsigned char *transfer_buffer;
412 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
413 if (!transfer_buffer)
416 retval = usb_control_msg(serial->dev,
417 usb_rcvctrlpipe(serial->dev, 0),
418 PALM_GET_EXT_CONNECTION_INFORMATION,
419 0xc2, 0x0000, 0x0000, transfer_buffer,
420 sizeof(*connection_info), 300);
422 dev_err(dev, "%s - error %d getting connection info\n",
425 usb_serial_debug_data(dev, __func__, retval, transfer_buffer);
427 kfree(transfer_buffer);
432 static int visor_probe(struct usb_serial *serial,
433 const struct usb_device_id *id)
436 int (*startup)(struct usb_serial *serial,
437 const struct usb_device_id *id);
440 * some Samsung Android phones in modem mode have the same ID
441 * as SPH-I500, but they are ACM devices, so dont bind to them
443 if (id->idVendor == SAMSUNG_VENDOR_ID &&
444 id->idProduct == SAMSUNG_SPH_I500_ID &&
445 serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
446 serial->dev->descriptor.bDeviceSubClass ==
447 USB_CDC_SUBCLASS_ACM)
450 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
451 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
452 serial->dev->actconfig->desc.bConfigurationValue);
456 if (id->driver_info) {
457 startup = (void *)id->driver_info;
458 retval = startup(serial, id);
464 static int visor_calc_num_ports(struct usb_serial *serial,
465 struct usb_serial_endpoints *epds)
467 unsigned int vid = le16_to_cpu(serial->dev->descriptor.idVendor);
468 int num_ports = (int)(long)(usb_get_serial_data(serial));
471 usb_set_serial_data(serial, NULL);
474 * Only swap the bulk endpoints for the Handspring devices with
475 * interrupt in endpoints, which for now are the Treo devices.
477 if (!(vid == HANDSPRING_VENDOR_ID || vid == KYOCERA_VENDOR_ID) ||
478 epds->num_interrupt_in == 0)
481 if (epds->num_bulk_in < 2 || epds->num_interrupt_in < 2) {
482 dev_err(&serial->interface->dev, "missing endpoints\n");
487 * It appears that Treos and Kyoceras want to use the
488 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
489 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
490 * Note that swapping the bulk out endpoints would break lots of
491 * apps that want to communicate on the second port.
493 swap(epds->bulk_in[0], epds->bulk_in[1]);
494 swap(epds->interrupt_in[0], epds->interrupt_in[1]);
499 static int clie_5_calc_num_ports(struct usb_serial *serial,
500 struct usb_serial_endpoints *epds)
503 * TH55 registers 2 ports.
504 * Communication in from the UX50/TH55 uses the first bulk-in
505 * endpoint, while communication out to the UX50/TH55 uses the second
510 * FIXME: Should we swap the descriptors instead of using the same
511 * bulk-out endpoint for both ports?
513 epds->bulk_out[0] = epds->bulk_out[1];
515 return serial->type->num_ports;
518 static int clie_3_5_startup(struct usb_serial *serial)
520 struct device *dev = &serial->dev->dev;
524 data = kmalloc(1, GFP_KERNEL);
529 * Note that PEG-300 series devices expect the following two calls.
532 /* get the config number */
533 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
534 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
535 0, 0, data, 1, 3000);
537 dev_err(dev, "%s: get config number failed: %d\n",
542 dev_err(dev, "%s: get config number bad return length: %d\n",
548 /* get the interface number */
549 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
550 USB_REQ_GET_INTERFACE,
551 USB_DIR_IN | USB_RECIP_INTERFACE,
552 0, 0, data, 1, 3000);
554 dev_err(dev, "%s: get interface number failed: %d\n",
560 "%s: get interface number bad return length: %d\n",
573 module_usb_serial_driver(serial_drivers, id_table_combined);
575 MODULE_AUTHOR(DRIVER_AUTHOR);
576 MODULE_DESCRIPTION(DRIVER_DESC);
577 MODULE_LICENSE("GPL v2");