xref: /linux/drivers/usb/serial/visor.c (revision 8f668fbbd571bbd5187a9a0eae150b768fc388ac)
1 /*
2  * USB HandSpring Visor, Palm m50x, and Sony Clie driver
3  * (supports all of the Palm OS USB devices)
4  *
5  *	Copyright (C) 1999 - 2004
6  *	    Greg Kroah-Hartman (greg@kroah.com)
7  *
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.
11  *
12  * See Documentation/usb/usb-serial.txt for more information on using this
13  * driver
14  *
15  */
16 
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>
31 #include "visor.h"
32 
33 /*
34  * Version Information
35  */
36 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
37 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
38 
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);
53 
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(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 */
114 };
115 
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 */
120 };
121 
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 */
125 };
126 
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 */
159 };
160 
161 MODULE_DEVICE_TABLE(usb, id_table_combined);
162 
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",
169 	},
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 	.attach =		treo_attach,
179 	.probe =		visor_probe,
180 	.calc_num_ports =	visor_calc_num_ports,
181 	.read_int_callback =	visor_read_int_callback,
182 };
183 
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 = {
186 	.driver = {
187 		.owner =	THIS_MODULE,
188 		.name =		"clie_5",
189 	},
190 	.description =		"Sony Clie 5.0",
191 	.id_table =		clie_id_5_table,
192 	.num_ports =		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 	.attach =		clie_5_attach,
199 	.probe =		visor_probe,
200 	.calc_num_ports =	visor_calc_num_ports,
201 	.read_int_callback =	visor_read_int_callback,
202 };
203 
204 /* device info for the Sony Clie OS version 3.5 */
205 static struct usb_serial_driver clie_3_5_device = {
206 	.driver = {
207 		.owner =	THIS_MODULE,
208 		.name =		"clie_3.5",
209 	},
210 	.description =		"Sony Clie 3.5",
211 	.id_table =		clie_id_3_5_table,
212 	.num_ports =		1,
213 	.bulk_out_size =	256,
214 	.open =			visor_open,
215 	.close =		visor_close,
216 	.throttle =		usb_serial_generic_throttle,
217 	.unthrottle =		usb_serial_generic_unthrottle,
218 	.attach =		clie_3_5_startup,
219 };
220 
221 static struct usb_serial_driver * const serial_drivers[] = {
222 	&handspring_device, &clie_5_device, &clie_3_5_device, NULL
223 };
224 
225 /******************************************************************************
226  * Handspring Visor specific driver functions
227  ******************************************************************************/
228 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port)
229 {
230 	int result = 0;
231 
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");
235 		return -ENODEV;
236 	}
237 
238 	/* Start reading from the device */
239 	result = usb_serial_generic_open(tty, port);
240 	if (result)
241 		goto exit;
242 
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);
246 		if (result)
247 			dev_err(&port->dev,
248 			    "%s - failed submitting interrupt urb, error %d\n",
249 							__func__, result);
250 	}
251 exit:
252 	return result;
253 }
254 
255 
256 static void visor_close(struct usb_serial_port *port)
257 {
258 	unsigned char *transfer_buffer;
259 
260 	usb_serial_generic_close(port);
261 	usb_kill_urb(port->interrupt_in_urb);
262 
263 	transfer_buffer = kmalloc(0x12, GFP_KERNEL);
264 	if (!transfer_buffer)
265 		return;
266 	usb_control_msg(port->serial->dev,
267 					 usb_rcvctrlpipe(port->serial->dev, 0),
268 					 VISOR_CLOSE_NOTIFICATION, 0xc2,
269 					 0x0000, 0x0000,
270 					 transfer_buffer, 0x12, 300);
271 	kfree(transfer_buffer);
272 }
273 
274 static void visor_read_int_callback(struct urb *urb)
275 {
276 	struct usb_serial_port *port = urb->context;
277 	int status = urb->status;
278 	int result;
279 
280 	switch (status) {
281 	case 0:
282 		/* success */
283 		break;
284 	case -ECONNRESET:
285 	case -ENOENT:
286 	case -ESHUTDOWN:
287 		/* this urb is terminated, clean up */
288 		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
289 			__func__, status);
290 		return;
291 	default:
292 		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
293 			__func__, status);
294 		goto exit;
295 	}
296 
297 	/*
298 	 * This information is still unknown what it can be used for.
299 	 * If anyone has an idea, please let the author know...
300 	 *
301 	 * Rumor has it this endpoint is used to notify when data
302 	 * is ready to be read from the bulk ones.
303 	 */
304 	usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
305 			      urb->transfer_buffer);
306 
307 exit:
308 	result = usb_submit_urb(urb, GFP_ATOMIC);
309 	if (result)
310 		dev_err(&urb->dev->dev,
311 				"%s - Error %d submitting interrupt urb\n",
312 							__func__, result);
313 }
314 
315 static int palm_os_3_probe(struct usb_serial *serial,
316 						const struct usb_device_id *id)
317 {
318 	struct device *dev = &serial->dev->dev;
319 	struct visor_connection_info *connection_info;
320 	unsigned char *transfer_buffer;
321 	char *string;
322 	int retval = 0;
323 	int i;
324 	int num_ports = 0;
325 
326 	transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
327 	if (!transfer_buffer)
328 		return -ENOMEM;
329 
330 	/* send a get connection info request */
331 	retval = usb_control_msg(serial->dev,
332 				  usb_rcvctrlpipe(serial->dev, 0),
333 				  VISOR_GET_CONNECTION_INFORMATION,
334 				  0xc2, 0x0000, 0x0000, transfer_buffer,
335 				  sizeof(*connection_info), 300);
336 	if (retval < 0) {
337 		dev_err(dev, "%s - error %d getting connection information\n",
338 			__func__, retval);
339 		goto exit;
340 	}
341 
342 	if (retval == sizeof(*connection_info)) {
343 			connection_info = (struct visor_connection_info *)
344 							transfer_buffer;
345 
346 		num_ports = le16_to_cpu(connection_info->num_ports);
347 		for (i = 0; i < num_ports; ++i) {
348 			switch (
349 			   connection_info->connections[i].port_function_id) {
350 			case VISOR_FUNCTION_GENERIC:
351 				string = "Generic";
352 				break;
353 			case VISOR_FUNCTION_DEBUGGER:
354 				string = "Debugger";
355 				break;
356 			case VISOR_FUNCTION_HOTSYNC:
357 				string = "HotSync";
358 				break;
359 			case VISOR_FUNCTION_CONSOLE:
360 				string = "Console";
361 				break;
362 			case VISOR_FUNCTION_REMOTE_FILE_SYS:
363 				string = "Remote File System";
364 				break;
365 			default:
366 				string = "unknown";
367 				break;
368 			}
369 			dev_info(dev, "%s: port %d, is for %s use\n",
370 				serial->type->description,
371 				connection_info->connections[i].port, string);
372 		}
373 	}
374 	/*
375 	* Handle devices that report invalid stuff here.
376 	*/
377 	if (num_ports == 0 || num_ports > 2) {
378 		dev_warn(dev, "%s: No valid connect info available\n",
379 			serial->type->description);
380 		num_ports = 2;
381 	}
382 
383 	dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
384 		num_ports);
385 
386 	/*
387 	 * save off our num_ports info so that we can use it in the
388 	 * calc_num_ports callback
389 	 */
390 	usb_set_serial_data(serial, (void *)(long)num_ports);
391 
392 	/* ask for the number of bytes available, but ignore the
393 	   response as it is broken */
394 	retval = usb_control_msg(serial->dev,
395 				  usb_rcvctrlpipe(serial->dev, 0),
396 				  VISOR_REQUEST_BYTES_AVAILABLE,
397 				  0xc2, 0x0000, 0x0005, transfer_buffer,
398 				  0x02, 300);
399 	if (retval < 0)
400 		dev_err(dev, "%s - error %d getting bytes available request\n",
401 			__func__, retval);
402 	retval = 0;
403 
404 exit:
405 	kfree(transfer_buffer);
406 
407 	return retval;
408 }
409 
410 static int palm_os_4_probe(struct usb_serial *serial,
411 						const struct usb_device_id *id)
412 {
413 	struct device *dev = &serial->dev->dev;
414 	struct palm_ext_connection_info *connection_info;
415 	unsigned char *transfer_buffer;
416 	int retval;
417 
418 	transfer_buffer =  kmalloc(sizeof(*connection_info), GFP_KERNEL);
419 	if (!transfer_buffer)
420 		return -ENOMEM;
421 
422 	retval = usb_control_msg(serial->dev,
423 				  usb_rcvctrlpipe(serial->dev, 0),
424 				  PALM_GET_EXT_CONNECTION_INFORMATION,
425 				  0xc2, 0x0000, 0x0000, transfer_buffer,
426 				  sizeof(*connection_info), 300);
427 	if (retval < 0)
428 		dev_err(dev, "%s - error %d getting connection info\n",
429 			__func__, retval);
430 	else
431 		usb_serial_debug_data(dev, __func__, retval, transfer_buffer);
432 
433 	kfree(transfer_buffer);
434 	return 0;
435 }
436 
437 
438 static int visor_probe(struct usb_serial *serial,
439 					const struct usb_device_id *id)
440 {
441 	int retval = 0;
442 	int (*startup)(struct usb_serial *serial,
443 					const struct usb_device_id *id);
444 
445 	/*
446 	 * some Samsung Android phones in modem mode have the same ID
447 	 * as SPH-I500, but they are ACM devices, so dont bind to them
448 	 */
449 	if (id->idVendor == SAMSUNG_VENDOR_ID &&
450 		id->idProduct == SAMSUNG_SPH_I500_ID &&
451 		serial->dev->descriptor.bDeviceClass == USB_CLASS_COMM &&
452 		serial->dev->descriptor.bDeviceSubClass ==
453 			USB_CDC_SUBCLASS_ACM)
454 		return -ENODEV;
455 
456 	if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
457 		dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
458 			serial->dev->actconfig->desc.bConfigurationValue);
459 		return -ENODEV;
460 	}
461 
462 	if (id->driver_info) {
463 		startup = (void *)id->driver_info;
464 		retval = startup(serial, id);
465 	}
466 
467 	return retval;
468 }
469 
470 static int visor_calc_num_ports(struct usb_serial *serial)
471 {
472 	int num_ports = (int)(long)(usb_get_serial_data(serial));
473 
474 	if (num_ports)
475 		usb_set_serial_data(serial, NULL);
476 
477 	return num_ports;
478 }
479 
480 static int clie_3_5_startup(struct usb_serial *serial)
481 {
482 	struct device *dev = &serial->dev->dev;
483 	int result;
484 	u8 *data;
485 
486 	data = kmalloc(1, GFP_KERNEL);
487 	if (!data)
488 		return -ENOMEM;
489 
490 	/*
491 	 * Note that PEG-300 series devices expect the following two calls.
492 	 */
493 
494 	/* get the config number */
495 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
496 				  USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
497 				  0, 0, data, 1, 3000);
498 	if (result < 0) {
499 		dev_err(dev, "%s: get config number failed: %d\n",
500 							__func__, result);
501 		goto out;
502 	}
503 	if (result != 1) {
504 		dev_err(dev, "%s: get config number bad return length: %d\n",
505 							__func__, result);
506 		result = -EIO;
507 		goto out;
508 	}
509 
510 	/* get the interface number */
511 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
512 				  USB_REQ_GET_INTERFACE,
513 				  USB_DIR_IN | USB_RECIP_INTERFACE,
514 				  0, 0, data, 1, 3000);
515 	if (result < 0) {
516 		dev_err(dev, "%s: get interface number failed: %d\n",
517 							__func__, result);
518 		goto out;
519 	}
520 	if (result != 1) {
521 		dev_err(dev,
522 			"%s: get interface number bad return length: %d\n",
523 							__func__, result);
524 		result = -EIO;
525 		goto out;
526 	}
527 
528 	result = 0;
529 out:
530 	kfree(data);
531 
532 	return result;
533 }
534 
535 static int treo_attach(struct usb_serial *serial)
536 {
537 	struct usb_serial_port *swap_port;
538 
539 	/* Only do this endpoint hack for the Handspring devices with
540 	 * interrupt in endpoints, which for now are the Treo devices. */
541 	if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
542 						== HANDSPRING_VENDOR_ID) ||
543 		(le16_to_cpu(serial->dev->descriptor.idVendor)
544 						== KYOCERA_VENDOR_ID)) ||
545 		(serial->num_interrupt_in == 0))
546 		return 0;
547 
548 	/*
549 	* It appears that Treos and Kyoceras want to use the
550 	* 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
551 	* so let's swap the 1st and 2nd bulk in and interrupt endpoints.
552 	* Note that swapping the bulk out endpoints would break lots of
553 	* apps that want to communicate on the second port.
554 	*/
555 #define COPY_PORT(dest, src)						\
556 	do { \
557 		int i;							\
558 									\
559 		for (i = 0; i < ARRAY_SIZE(src->read_urbs); ++i) {	\
560 			dest->read_urbs[i] = src->read_urbs[i];		\
561 			dest->read_urbs[i]->context = dest;		\
562 			dest->bulk_in_buffers[i] = src->bulk_in_buffers[i]; \
563 		}							\
564 		dest->read_urb = src->read_urb;				\
565 		dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
566 		dest->bulk_in_buffer = src->bulk_in_buffer;		\
567 		dest->bulk_in_size = src->bulk_in_size;			\
568 		dest->interrupt_in_urb = src->interrupt_in_urb;		\
569 		dest->interrupt_in_urb->context = dest;			\
570 		dest->interrupt_in_endpointAddress = \
571 					src->interrupt_in_endpointAddress;\
572 		dest->interrupt_in_buffer = src->interrupt_in_buffer;	\
573 	} while (0);
574 
575 	swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
576 	if (!swap_port)
577 		return -ENOMEM;
578 	COPY_PORT(swap_port, serial->port[0]);
579 	COPY_PORT(serial->port[0], serial->port[1]);
580 	COPY_PORT(serial->port[1], swap_port);
581 	kfree(swap_port);
582 
583 	return 0;
584 }
585 
586 static int clie_5_attach(struct usb_serial *serial)
587 {
588 	struct usb_serial_port *port;
589 	unsigned int pipe;
590 	int j;
591 
592 	/* TH55 registers 2 ports.
593 	   Communication in from the UX50/TH55 uses bulk_in_endpointAddress
594 	   from port 0. Communication out to the UX50/TH55 uses
595 	   bulk_out_endpointAddress from port 1
596 
597 	   Lets do a quick and dirty mapping
598 	 */
599 
600 	/* some sanity check */
601 	if (serial->num_ports < 2)
602 		return -1;
603 
604 	/* port 0 now uses the modified endpoint Address */
605 	port = serial->port[0];
606 	port->bulk_out_endpointAddress =
607 				serial->port[1]->bulk_out_endpointAddress;
608 
609 	pipe = usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress);
610 	for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j)
611 		port->write_urbs[j]->pipe = pipe;
612 
613 	return 0;
614 }
615 
616 module_usb_serial_driver(serial_drivers, id_table_combined);
617 
618 MODULE_AUTHOR(DRIVER_AUTHOR);
619 MODULE_DESCRIPTION(DRIVER_DESC);
620 MODULE_LICENSE("GPL");
621