ARC: [plat-eznps] spinlock aware for MTM
[linux/fpc-iii.git] / drivers / usb / serial / visor.c
blob9f3317a940ef6a8d88767eaa919bb4b61f6f13b6
1 /*
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
13 * driver
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>
30 #include "visor.h"
33 * Version Information
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 struct usb_serial_endpoints *epds);
45 static int clie_5_calc_num_ports(struct usb_serial *serial,
46 struct usb_serial_endpoints *epds);
47 static void visor_read_int_callback(struct urb *urb);
48 static int clie_3_5_startup(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 const 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_INTERFACE_CLASS(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID, 0xff),
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 const 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 const 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 const 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 = {
166 .driver = {
167 .owner = THIS_MODULE,
168 .name = "visor",
170 .description = "Handspring Visor / Palm OS",
171 .id_table = id_table,
172 .num_ports = 2,
173 .bulk_out_size = 256,
174 .open = visor_open,
175 .close = visor_close,
176 .throttle = usb_serial_generic_throttle,
177 .unthrottle = usb_serial_generic_unthrottle,
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 = {
185 .driver = {
186 .owner = THIS_MODULE,
187 .name = "clie_5",
189 .description = "Sony Clie 5.0",
190 .id_table = clie_id_5_table,
191 .num_ports = 2,
192 .num_bulk_out = 2,
193 .bulk_out_size = 256,
194 .open = visor_open,
195 .close = visor_close,
196 .throttle = usb_serial_generic_throttle,
197 .unthrottle = usb_serial_generic_unthrottle,
198 .probe = visor_probe,
199 .calc_num_ports = clie_5_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 = {
205 .driver = {
206 .owner = THIS_MODULE,
207 .name = "clie_3.5",
209 .description = "Sony Clie 3.5",
210 .id_table = clie_id_3_5_table,
211 .num_ports = 1,
212 .bulk_out_size = 256,
213 .open = visor_open,
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)
229 int result = 0;
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");
234 return -ENODEV;
237 /* Start reading from the device */
238 result = usb_serial_generic_open(tty, port);
239 if (result)
240 goto exit;
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);
245 if (result)
246 dev_err(&port->dev,
247 "%s - failed submitting interrupt urb, error %d\n",
248 __func__, result);
250 exit:
251 return result;
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)
264 return;
265 usb_control_msg(port->serial->dev,
266 usb_rcvctrlpipe(port->serial->dev, 0),
267 VISOR_CLOSE_NOTIFICATION, 0xc2,
268 0x0000, 0x0000,
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;
277 int result;
279 switch (status) {
280 case 0:
281 /* success */
282 break;
283 case -ECONNRESET:
284 case -ENOENT:
285 case -ESHUTDOWN:
286 /* this urb is terminated, clean up */
287 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
288 __func__, status);
289 return;
290 default:
291 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
292 __func__, status);
293 goto exit;
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);
306 exit:
307 result = usb_submit_urb(urb, GFP_ATOMIC);
308 if (result)
309 dev_err(&urb->dev->dev,
310 "%s - Error %d submitting interrupt urb\n",
311 __func__, result);
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;
320 char *string;
321 int retval = 0;
322 int i;
323 int num_ports = 0;
325 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
326 if (!transfer_buffer)
327 return -ENOMEM;
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);
335 if (retval < 0) {
336 dev_err(dev, "%s - error %d getting connection information\n",
337 __func__, retval);
338 goto exit;
341 if (retval == sizeof(*connection_info)) {
342 connection_info = (struct visor_connection_info *)
343 transfer_buffer;
345 num_ports = le16_to_cpu(connection_info->num_ports);
346 for (i = 0; i < num_ports; ++i) {
347 switch (
348 connection_info->connections[i].port_function_id) {
349 case VISOR_FUNCTION_GENERIC:
350 string = "Generic";
351 break;
352 case VISOR_FUNCTION_DEBUGGER:
353 string = "Debugger";
354 break;
355 case VISOR_FUNCTION_HOTSYNC:
356 string = "HotSync";
357 break;
358 case VISOR_FUNCTION_CONSOLE:
359 string = "Console";
360 break;
361 case VISOR_FUNCTION_REMOTE_FILE_SYS:
362 string = "Remote File System";
363 break;
364 default:
365 string = "unknown";
366 break;
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);
379 num_ports = 2;
382 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
383 num_ports);
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,
397 0x02, 300);
398 if (retval < 0)
399 dev_err(dev, "%s - error %d getting bytes available request\n",
400 __func__, retval);
401 retval = 0;
403 exit:
404 kfree(transfer_buffer);
406 return retval;
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;
415 int retval;
417 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
418 if (!transfer_buffer)
419 return -ENOMEM;
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);
426 if (retval < 0)
427 dev_err(dev, "%s - error %d getting connection info\n",
428 __func__, retval);
429 else
430 usb_serial_debug_data(dev, __func__, retval, transfer_buffer);
432 kfree(transfer_buffer);
433 return 0;
437 static int visor_probe(struct usb_serial *serial,
438 const struct usb_device_id *id)
440 int retval = 0;
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)
453 return -ENODEV;
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);
458 return -ENODEV;
461 if (id->driver_info) {
462 startup = (void *)id->driver_info;
463 retval = startup(serial, id);
466 return retval;
469 static int visor_calc_num_ports(struct usb_serial *serial,
470 struct usb_serial_endpoints *epds)
472 unsigned int vid = le16_to_cpu(serial->dev->descriptor.idVendor);
473 int num_ports = (int)(long)(usb_get_serial_data(serial));
475 if (num_ports)
476 usb_set_serial_data(serial, NULL);
479 * Only swap the bulk endpoints for the Handspring devices with
480 * interrupt in endpoints, which for now are the Treo devices.
482 if (!(vid == HANDSPRING_VENDOR_ID || vid == KYOCERA_VENDOR_ID) ||
483 epds->num_interrupt_in == 0)
484 goto out;
486 if (epds->num_bulk_in < 2 || epds->num_interrupt_in < 2) {
487 dev_err(&serial->interface->dev, "missing endpoints\n");
488 return -ENODEV;
492 * It appears that Treos and Kyoceras want to use the
493 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
494 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
495 * Note that swapping the bulk out endpoints would break lots of
496 * apps that want to communicate on the second port.
498 swap(epds->bulk_in[0], epds->bulk_in[1]);
499 swap(epds->interrupt_in[0], epds->interrupt_in[1]);
500 out:
501 return num_ports;
504 static int clie_5_calc_num_ports(struct usb_serial *serial,
505 struct usb_serial_endpoints *epds)
508 * TH55 registers 2 ports.
509 * Communication in from the UX50/TH55 uses the first bulk-in
510 * endpoint, while communication out to the UX50/TH55 uses the second
511 * bulk-out endpoint.
515 * FIXME: Should we swap the descriptors instead of using the same
516 * bulk-out endpoint for both ports?
518 epds->bulk_out[0] = epds->bulk_out[1];
520 return serial->type->num_ports;
523 static int clie_3_5_startup(struct usb_serial *serial)
525 struct device *dev = &serial->dev->dev;
526 int result;
527 u8 *data;
529 data = kmalloc(1, GFP_KERNEL);
530 if (!data)
531 return -ENOMEM;
534 * Note that PEG-300 series devices expect the following two calls.
537 /* get the config number */
538 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
539 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
540 0, 0, data, 1, 3000);
541 if (result < 0) {
542 dev_err(dev, "%s: get config number failed: %d\n",
543 __func__, result);
544 goto out;
546 if (result != 1) {
547 dev_err(dev, "%s: get config number bad return length: %d\n",
548 __func__, result);
549 result = -EIO;
550 goto out;
553 /* get the interface number */
554 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
555 USB_REQ_GET_INTERFACE,
556 USB_DIR_IN | USB_RECIP_INTERFACE,
557 0, 0, data, 1, 3000);
558 if (result < 0) {
559 dev_err(dev, "%s: get interface number failed: %d\n",
560 __func__, result);
561 goto out;
563 if (result != 1) {
564 dev_err(dev,
565 "%s: get interface number bad return length: %d\n",
566 __func__, result);
567 result = -EIO;
568 goto out;
571 result = 0;
572 out:
573 kfree(data);
575 return result;
578 module_usb_serial_driver(serial_drivers, id_table_combined);
580 MODULE_AUTHOR(DRIVER_AUTHOR);
581 MODULE_DESCRIPTION(DRIVER_DESC);
582 MODULE_LICENSE("GPL");