kbuild: Fix instrumentation removal breakage on avr32
[wrt350n-kernel.git] / drivers / usb / serial / visor.c
blob22b3f78a388ce0d40486ede8c98f9af41051dc49
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 driver
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/init.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 <asm/uaccess.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
29 #include "visor.h"
32 * Version Information
34 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
35 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
37 /* function prototypes for a handspring visor */
38 static int visor_open (struct usb_serial_port *port, struct file *filp);
39 static void visor_close (struct usb_serial_port *port, struct file *filp);
40 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count);
41 static int visor_write_room (struct usb_serial_port *port);
42 static int visor_chars_in_buffer (struct usb_serial_port *port);
43 static void visor_throttle (struct usb_serial_port *port);
44 static void visor_unthrottle (struct usb_serial_port *port);
45 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id);
46 static int visor_calc_num_ports(struct usb_serial *serial);
47 static void visor_shutdown (struct usb_serial *serial);
48 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
49 static void visor_write_bulk_callback (struct urb *urb);
50 static void visor_read_bulk_callback (struct urb *urb);
51 static void visor_read_int_callback (struct urb *urb);
52 static int clie_3_5_startup (struct usb_serial *serial);
53 static int treo_attach (struct usb_serial *serial);
54 static int clie_5_attach (struct usb_serial *serial);
55 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id);
56 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id);
58 /* Parameters that may be passed into the module. */
59 static int debug;
60 static __u16 vendor;
61 static __u16 product;
63 static struct usb_device_id id_table [] = {
64 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
65 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
66 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
67 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
68 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
84 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
86 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
108 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
116 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
117 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
118 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
119 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
120 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
121 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
122 { }, /* optional parameter entry */
123 { } /* Terminating entry */
126 static struct usb_device_id clie_id_5_table [] = {
127 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
128 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
129 { }, /* optional parameter entry */
130 { } /* Terminating entry */
133 static struct usb_device_id clie_id_3_5_table [] = {
134 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
135 { } /* Terminating entry */
138 static struct usb_device_id id_table_combined [] = {
139 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
140 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
141 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
142 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
143 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
144 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
145 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
146 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
147 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
148 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
149 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
150 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
151 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
152 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
153 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
154 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
155 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
156 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
157 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
158 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
159 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
160 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
161 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
162 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
163 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
164 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
165 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
166 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
167 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
168 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
169 { }, /* optional parameter entry */
170 { } /* Terminating entry */
173 MODULE_DEVICE_TABLE (usb, id_table_combined);
175 static struct usb_driver visor_driver = {
176 .name = "visor",
177 .probe = usb_serial_probe,
178 .disconnect = usb_serial_disconnect,
179 .id_table = id_table_combined,
180 .no_dynamic_id = 1,
183 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
184 static struct usb_serial_driver handspring_device = {
185 .driver = {
186 .owner = THIS_MODULE,
187 .name = "visor",
189 .description = "Handspring Visor / Palm OS",
190 .usb_driver = &visor_driver,
191 .id_table = id_table,
192 .num_interrupt_in = NUM_DONT_CARE,
193 .num_bulk_in = 2,
194 .num_bulk_out = 2,
195 .num_ports = 2,
196 .open = visor_open,
197 .close = visor_close,
198 .throttle = visor_throttle,
199 .unthrottle = visor_unthrottle,
200 .attach = treo_attach,
201 .probe = visor_probe,
202 .calc_num_ports = visor_calc_num_ports,
203 .shutdown = visor_shutdown,
204 .ioctl = visor_ioctl,
205 .write = visor_write,
206 .write_room = visor_write_room,
207 .chars_in_buffer = visor_chars_in_buffer,
208 .write_bulk_callback = visor_write_bulk_callback,
209 .read_bulk_callback = visor_read_bulk_callback,
210 .read_int_callback = visor_read_int_callback,
213 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
214 static struct usb_serial_driver clie_5_device = {
215 .driver = {
216 .owner = THIS_MODULE,
217 .name = "clie_5",
219 .description = "Sony Clie 5.0",
220 .usb_driver = &visor_driver,
221 .id_table = clie_id_5_table,
222 .num_interrupt_in = NUM_DONT_CARE,
223 .num_bulk_in = 2,
224 .num_bulk_out = 2,
225 .num_ports = 2,
226 .open = visor_open,
227 .close = visor_close,
228 .throttle = visor_throttle,
229 .unthrottle = visor_unthrottle,
230 .attach = clie_5_attach,
231 .probe = visor_probe,
232 .calc_num_ports = visor_calc_num_ports,
233 .shutdown = visor_shutdown,
234 .ioctl = visor_ioctl,
235 .write = visor_write,
236 .write_room = visor_write_room,
237 .chars_in_buffer = visor_chars_in_buffer,
238 .write_bulk_callback = visor_write_bulk_callback,
239 .read_bulk_callback = visor_read_bulk_callback,
240 .read_int_callback = visor_read_int_callback,
243 /* device info for the Sony Clie OS version 3.5 */
244 static struct usb_serial_driver clie_3_5_device = {
245 .driver = {
246 .owner = THIS_MODULE,
247 .name = "clie_3.5",
249 .description = "Sony Clie 3.5",
250 .usb_driver = &visor_driver,
251 .id_table = clie_id_3_5_table,
252 .num_interrupt_in = 0,
253 .num_bulk_in = 1,
254 .num_bulk_out = 1,
255 .num_ports = 1,
256 .open = visor_open,
257 .close = visor_close,
258 .throttle = visor_throttle,
259 .unthrottle = visor_unthrottle,
260 .attach = clie_3_5_startup,
261 .ioctl = visor_ioctl,
262 .write = visor_write,
263 .write_room = visor_write_room,
264 .chars_in_buffer = visor_chars_in_buffer,
265 .write_bulk_callback = visor_write_bulk_callback,
266 .read_bulk_callback = visor_read_bulk_callback,
269 struct visor_private {
270 spinlock_t lock;
271 int bytes_in;
272 int bytes_out;
273 int outstanding_urbs;
274 unsigned char throttled;
275 unsigned char actually_throttled;
278 /* number of outstanding urbs to prevent userspace DoS from happening */
279 #define URB_UPPER_LIMIT 42
281 static int stats;
283 /******************************************************************************
284 * Handspring Visor specific driver functions
285 ******************************************************************************/
286 static int visor_open (struct usb_serial_port *port, struct file *filp)
288 struct usb_serial *serial = port->serial;
289 struct visor_private *priv = usb_get_serial_port_data(port);
290 unsigned long flags;
291 int result = 0;
293 dbg("%s - port %d", __FUNCTION__, port->number);
295 if (!port->read_urb) {
296 /* this is needed for some brain dead Sony devices */
297 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
298 return -ENODEV;
301 spin_lock_irqsave(&priv->lock, flags);
302 priv->bytes_in = 0;
303 priv->bytes_out = 0;
304 priv->throttled = 0;
305 spin_unlock_irqrestore(&priv->lock, flags);
308 * Force low_latency on so that our tty_push actually forces the data
309 * through, otherwise it is scheduled, and with high data rates (like
310 * with OHCI) data can get lost.
312 if (port->tty)
313 port->tty->low_latency = 1;
315 /* Start reading from the device */
316 usb_fill_bulk_urb (port->read_urb, serial->dev,
317 usb_rcvbulkpipe (serial->dev,
318 port->bulk_in_endpointAddress),
319 port->read_urb->transfer_buffer,
320 port->read_urb->transfer_buffer_length,
321 visor_read_bulk_callback, port);
322 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
323 if (result) {
324 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
325 __FUNCTION__, result);
326 goto exit;
329 if (port->interrupt_in_urb) {
330 dbg("%s - adding interrupt input for treo", __FUNCTION__);
331 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
332 if (result)
333 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
334 __FUNCTION__, result);
336 exit:
337 return result;
341 static void visor_close (struct usb_serial_port *port, struct file * filp)
343 struct visor_private *priv = usb_get_serial_port_data(port);
344 unsigned char *transfer_buffer;
346 dbg("%s - port %d", __FUNCTION__, port->number);
348 /* shutdown our urbs */
349 usb_kill_urb(port->read_urb);
350 usb_kill_urb(port->interrupt_in_urb);
352 mutex_lock(&port->serial->disc_mutex);
353 if (!port->serial->disconnected) {
354 /* Try to send shutdown message, unless the device is gone */
355 transfer_buffer = kmalloc (0x12, GFP_KERNEL);
356 if (transfer_buffer) {
357 usb_control_msg (port->serial->dev,
358 usb_rcvctrlpipe(port->serial->dev, 0),
359 VISOR_CLOSE_NOTIFICATION, 0xc2,
360 0x0000, 0x0000,
361 transfer_buffer, 0x12, 300);
362 kfree (transfer_buffer);
365 mutex_unlock(&port->serial->disc_mutex);
367 if (stats)
368 dev_info(&port->dev, "Bytes In = %d Bytes Out = %d\n",
369 priv->bytes_in, priv->bytes_out);
373 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count)
375 struct visor_private *priv = usb_get_serial_port_data(port);
376 struct usb_serial *serial = port->serial;
377 struct urb *urb;
378 unsigned char *buffer;
379 unsigned long flags;
380 int status;
382 dbg("%s - port %d", __FUNCTION__, port->number);
384 spin_lock_irqsave(&priv->lock, flags);
385 if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
386 spin_unlock_irqrestore(&priv->lock, flags);
387 dbg("%s - write limit hit\n", __FUNCTION__);
388 return 0;
390 priv->outstanding_urbs++;
391 spin_unlock_irqrestore(&priv->lock, flags);
393 buffer = kmalloc (count, GFP_ATOMIC);
394 if (!buffer) {
395 dev_err(&port->dev, "out of memory\n");
396 count = -ENOMEM;
397 goto error_no_buffer;
400 urb = usb_alloc_urb(0, GFP_ATOMIC);
401 if (!urb) {
402 dev_err(&port->dev, "no more free urbs\n");
403 count = -ENOMEM;
404 goto error_no_urb;
407 memcpy (buffer, buf, count);
409 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
411 usb_fill_bulk_urb (urb, serial->dev,
412 usb_sndbulkpipe (serial->dev,
413 port->bulk_out_endpointAddress),
414 buffer, count,
415 visor_write_bulk_callback, port);
417 /* send it down the pipe */
418 status = usb_submit_urb(urb, GFP_ATOMIC);
419 if (status) {
420 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
421 __FUNCTION__, status);
422 count = status;
423 goto error;
424 } else {
425 spin_lock_irqsave(&priv->lock, flags);
426 priv->bytes_out += count;
427 spin_unlock_irqrestore(&priv->lock, flags);
430 /* we are done with this urb, so let the host driver
431 * really free it when it is finished with it */
432 usb_free_urb(urb);
434 return count;
435 error:
436 usb_free_urb(urb);
437 error_no_urb:
438 kfree(buffer);
439 error_no_buffer:
440 spin_lock_irqsave(&priv->lock, flags);
441 --priv->outstanding_urbs;
442 spin_unlock_irqrestore(&priv->lock, flags);
443 return count;
447 static int visor_write_room (struct usb_serial_port *port)
449 struct visor_private *priv = usb_get_serial_port_data(port);
450 unsigned long flags;
452 dbg("%s - port %d", __FUNCTION__, port->number);
455 * We really can take anything the user throws at us
456 * but let's pick a nice big number to tell the tty
457 * layer that we have lots of free space, unless we don't.
460 spin_lock_irqsave(&priv->lock, flags);
461 if (priv->outstanding_urbs > URB_UPPER_LIMIT * 2 / 3) {
462 spin_unlock_irqrestore(&priv->lock, flags);
463 dbg("%s - write limit hit\n", __FUNCTION__);
464 return 0;
466 spin_unlock_irqrestore(&priv->lock, flags);
468 return 2048;
472 static int visor_chars_in_buffer (struct usb_serial_port *port)
474 dbg("%s - port %d", __FUNCTION__, port->number);
477 * We can't really account for how much data we
478 * have sent out, but hasn't made it through to the
479 * device, so just tell the tty layer that everything
480 * is flushed.
482 return 0;
486 static void visor_write_bulk_callback (struct urb *urb)
488 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
489 struct visor_private *priv = usb_get_serial_port_data(port);
490 int status = urb->status;
491 unsigned long flags;
493 /* free up the transfer buffer, as usb_free_urb() does not do this */
494 kfree (urb->transfer_buffer);
496 dbg("%s - port %d", __FUNCTION__, port->number);
498 if (status)
499 dbg("%s - nonzero write bulk status received: %d",
500 __FUNCTION__, status);
502 spin_lock_irqsave(&priv->lock, flags);
503 --priv->outstanding_urbs;
504 spin_unlock_irqrestore(&priv->lock, flags);
506 usb_serial_port_softint(port);
510 static void visor_read_bulk_callback (struct urb *urb)
512 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
513 struct visor_private *priv = usb_get_serial_port_data(port);
514 unsigned char *data = urb->transfer_buffer;
515 int status = urb->status;
516 struct tty_struct *tty;
517 int result;
518 int available_room;
520 dbg("%s - port %d", __FUNCTION__, port->number);
522 if (status) {
523 dbg("%s - nonzero read bulk status received: %d",
524 __FUNCTION__, status);
525 return;
528 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
530 tty = port->tty;
531 if (tty && urb->actual_length) {
532 available_room = tty_buffer_request_room(tty, urb->actual_length);
533 if (available_room) {
534 tty_insert_flip_string(tty, data, available_room);
535 tty_flip_buffer_push(tty);
537 spin_lock(&priv->lock);
538 priv->bytes_in += available_room;
540 } else {
541 spin_lock(&priv->lock);
544 /* Continue trying to always read if we should */
545 if (!priv->throttled) {
546 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
547 usb_rcvbulkpipe(port->serial->dev,
548 port->bulk_in_endpointAddress),
549 port->read_urb->transfer_buffer,
550 port->read_urb->transfer_buffer_length,
551 visor_read_bulk_callback, port);
552 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
553 if (result)
554 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
555 } else {
556 priv->actually_throttled = 1;
558 spin_unlock(&priv->lock);
561 static void visor_read_int_callback (struct urb *urb)
563 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
564 int status = urb->status;
565 int result;
567 switch (status) {
568 case 0:
569 /* success */
570 break;
571 case -ECONNRESET:
572 case -ENOENT:
573 case -ESHUTDOWN:
574 /* this urb is terminated, clean up */
575 dbg("%s - urb shutting down with status: %d",
576 __FUNCTION__, status);
577 return;
578 default:
579 dbg("%s - nonzero urb status received: %d",
580 __FUNCTION__, status);
581 goto exit;
585 * This information is still unknown what it can be used for.
586 * If anyone has an idea, please let the author know...
588 * Rumor has it this endpoint is used to notify when data
589 * is ready to be read from the bulk ones.
591 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
592 urb->actual_length, urb->transfer_buffer);
594 exit:
595 result = usb_submit_urb (urb, GFP_ATOMIC);
596 if (result)
597 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
598 __FUNCTION__, result);
601 static void visor_throttle (struct usb_serial_port *port)
603 struct visor_private *priv = usb_get_serial_port_data(port);
604 unsigned long flags;
606 dbg("%s - port %d", __FUNCTION__, port->number);
607 spin_lock_irqsave(&priv->lock, flags);
608 priv->throttled = 1;
609 spin_unlock_irqrestore(&priv->lock, flags);
613 static void visor_unthrottle (struct usb_serial_port *port)
615 struct visor_private *priv = usb_get_serial_port_data(port);
616 unsigned long flags;
617 int result;
619 dbg("%s - port %d", __FUNCTION__, port->number);
620 spin_lock_irqsave(&priv->lock, flags);
621 priv->throttled = 0;
622 priv->actually_throttled = 0;
623 spin_unlock_irqrestore(&priv->lock, flags);
625 port->read_urb->dev = port->serial->dev;
626 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
627 if (result)
628 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
631 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
633 struct device *dev = &serial->dev->dev;
634 struct visor_connection_info *connection_info;
635 unsigned char *transfer_buffer;
636 char *string;
637 int retval = 0;
638 int i;
639 int num_ports = 0;
641 dbg("%s", __FUNCTION__);
643 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
644 if (!transfer_buffer) {
645 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
646 sizeof(*connection_info));
647 return -ENOMEM;
650 /* send a get connection info request */
651 retval = usb_control_msg (serial->dev,
652 usb_rcvctrlpipe(serial->dev, 0),
653 VISOR_GET_CONNECTION_INFORMATION,
654 0xc2, 0x0000, 0x0000, transfer_buffer,
655 sizeof(*connection_info), 300);
656 if (retval < 0) {
657 dev_err(dev, "%s - error %d getting connection information\n",
658 __FUNCTION__, retval);
659 goto exit;
662 if (retval == sizeof(*connection_info)) {
663 connection_info = (struct visor_connection_info *)transfer_buffer;
665 num_ports = le16_to_cpu(connection_info->num_ports);
666 for (i = 0; i < num_ports; ++i) {
667 switch (connection_info->connections[i].port_function_id) {
668 case VISOR_FUNCTION_GENERIC:
669 string = "Generic";
670 break;
671 case VISOR_FUNCTION_DEBUGGER:
672 string = "Debugger";
673 break;
674 case VISOR_FUNCTION_HOTSYNC:
675 string = "HotSync";
676 break;
677 case VISOR_FUNCTION_CONSOLE:
678 string = "Console";
679 break;
680 case VISOR_FUNCTION_REMOTE_FILE_SYS:
681 string = "Remote File System";
682 break;
683 default:
684 string = "unknown";
685 break;
687 dev_info(dev, "%s: port %d, is for %s use\n",
688 serial->type->description,
689 connection_info->connections[i].port, string);
693 * Handle devices that report invalid stuff here.
695 if (num_ports == 0 || num_ports > 2) {
696 dev_warn (dev, "%s: No valid connect info available\n",
697 serial->type->description);
698 num_ports = 2;
701 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
702 num_ports);
705 * save off our num_ports info so that we can use it in the
706 * calc_num_ports callback
708 usb_set_serial_data(serial, (void *)(long)num_ports);
710 /* ask for the number of bytes available, but ignore the response as it is broken */
711 retval = usb_control_msg (serial->dev,
712 usb_rcvctrlpipe(serial->dev, 0),
713 VISOR_REQUEST_BYTES_AVAILABLE,
714 0xc2, 0x0000, 0x0005, transfer_buffer,
715 0x02, 300);
716 if (retval < 0)
717 dev_err(dev, "%s - error %d getting bytes available request\n",
718 __FUNCTION__, retval);
719 retval = 0;
721 exit:
722 kfree (transfer_buffer);
724 return retval;
727 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
729 struct device *dev = &serial->dev->dev;
730 struct palm_ext_connection_info *connection_info;
731 unsigned char *transfer_buffer;
732 int retval;
734 dbg("%s", __FUNCTION__);
736 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
737 if (!transfer_buffer) {
738 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
739 sizeof(*connection_info));
740 return -ENOMEM;
743 retval = usb_control_msg (serial->dev,
744 usb_rcvctrlpipe(serial->dev, 0),
745 PALM_GET_EXT_CONNECTION_INFORMATION,
746 0xc2, 0x0000, 0x0000, transfer_buffer,
747 sizeof (*connection_info), 300);
748 if (retval < 0)
749 dev_err(dev, "%s - error %d getting connection info\n",
750 __FUNCTION__, retval);
751 else
752 usb_serial_debug_data(debug, &serial->dev->dev, __FUNCTION__,
753 retval, transfer_buffer);
755 kfree (transfer_buffer);
756 return 0;
760 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
762 int retval = 0;
763 int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
765 dbg("%s", __FUNCTION__);
767 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
768 err("active config #%d != 1 ??",
769 serial->dev->actconfig->desc.bConfigurationValue);
770 return -ENODEV;
773 if (id->driver_info) {
774 startup = (void *)id->driver_info;
775 retval = startup(serial, id);
778 return retval;
781 static int visor_calc_num_ports (struct usb_serial *serial)
783 int num_ports = (int)(long)(usb_get_serial_data(serial));
785 if (num_ports)
786 usb_set_serial_data(serial, NULL);
788 return num_ports;
791 static int generic_startup(struct usb_serial *serial)
793 struct usb_serial_port **ports = serial->port;
794 struct visor_private *priv;
795 int i;
797 for (i = 0; i < serial->num_ports; ++i) {
798 priv = kzalloc (sizeof(*priv), GFP_KERNEL);
799 if (!priv) {
800 while (i-- != 0) {
801 priv = usb_get_serial_port_data(ports[i]);
802 usb_set_serial_port_data(ports[i], NULL);
803 kfree(priv);
805 return -ENOMEM;
807 spin_lock_init(&priv->lock);
808 usb_set_serial_port_data(ports[i], priv);
810 return 0;
813 static int clie_3_5_startup (struct usb_serial *serial)
815 struct device *dev = &serial->dev->dev;
816 int result;
817 u8 data;
819 dbg("%s", __FUNCTION__);
822 * Note that PEG-300 series devices expect the following two calls.
825 /* get the config number */
826 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
827 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
828 0, 0, &data, 1, 3000);
829 if (result < 0) {
830 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
831 return result;
833 if (result != 1) {
834 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
835 return -EIO;
838 /* get the interface number */
839 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
840 USB_REQ_GET_INTERFACE,
841 USB_DIR_IN | USB_RECIP_INTERFACE,
842 0, 0, &data, 1, 3000);
843 if (result < 0) {
844 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
845 return result;
847 if (result != 1) {
848 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
849 return -EIO;
852 return generic_startup(serial);
855 static int treo_attach (struct usb_serial *serial)
857 struct usb_serial_port *swap_port;
859 /* Only do this endpoint hack for the Handspring devices with
860 * interrupt in endpoints, which for now are the Treo devices. */
861 if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
862 (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
863 (serial->num_interrupt_in == 0))
864 goto generic_startup;
866 dbg("%s", __FUNCTION__);
869 * It appears that Treos and Kyoceras want to use the
870 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
871 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
872 * Note that swapping the bulk out endpoints would break lots of
873 * apps that want to communicate on the second port.
875 #define COPY_PORT(dest, src) \
876 dest->read_urb = src->read_urb; \
877 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
878 dest->bulk_in_buffer = src->bulk_in_buffer; \
879 dest->interrupt_in_urb = src->interrupt_in_urb; \
880 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
881 dest->interrupt_in_buffer = src->interrupt_in_buffer;
883 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
884 if (!swap_port)
885 return -ENOMEM;
886 COPY_PORT(swap_port, serial->port[0]);
887 COPY_PORT(serial->port[0], serial->port[1]);
888 COPY_PORT(serial->port[1], swap_port);
889 kfree(swap_port);
891 generic_startup:
892 return generic_startup(serial);
895 static int clie_5_attach (struct usb_serial *serial)
897 dbg("%s", __FUNCTION__);
899 /* TH55 registers 2 ports.
900 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
901 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
903 Lets do a quick and dirty mapping
906 /* some sanity check */
907 if (serial->num_ports < 2)
908 return -1;
910 /* port 0 now uses the modified endpoint Address */
911 serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
913 return generic_startup(serial);
916 static void visor_shutdown (struct usb_serial *serial)
918 struct visor_private *priv;
919 int i;
921 dbg("%s", __FUNCTION__);
923 for (i = 0; i < serial->num_ports; i++) {
924 priv = usb_get_serial_port_data(serial->port[i]);
925 if (priv) {
926 usb_set_serial_port_data(serial->port[i], NULL);
927 kfree(priv);
932 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
934 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
936 return -ENOIOCTLCMD;
939 static int __init visor_init (void)
941 int i, retval;
942 /* Only if parameters were passed to us */
943 if ((vendor>0) && (product>0)) {
944 struct usb_device_id usb_dev_temp[]=
945 {{USB_DEVICE(vendor, product),
946 .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
948 /* Find the last entry in id_table */
949 for (i=0; ; i++) {
950 if (id_table[i].idVendor==0) {
951 id_table[i] = usb_dev_temp[0];
952 break;
955 /* Find the last entry in id_table_combined */
956 for (i=0; ; i++) {
957 if (id_table_combined[i].idVendor==0) {
958 id_table_combined[i] = usb_dev_temp[0];
959 break;
962 info("Untested USB device specified at time of module insertion");
963 info("Warning: This is not guaranteed to work");
964 info("Using a newer kernel is preferred to this method");
965 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
966 vendor, product);
968 retval = usb_serial_register(&handspring_device);
969 if (retval)
970 goto failed_handspring_register;
971 retval = usb_serial_register(&clie_3_5_device);
972 if (retval)
973 goto failed_clie_3_5_register;
974 retval = usb_serial_register(&clie_5_device);
975 if (retval)
976 goto failed_clie_5_register;
977 retval = usb_register(&visor_driver);
978 if (retval)
979 goto failed_usb_register;
980 info(DRIVER_DESC);
982 return 0;
983 failed_usb_register:
984 usb_serial_deregister(&clie_5_device);
985 failed_clie_5_register:
986 usb_serial_deregister(&clie_3_5_device);
987 failed_clie_3_5_register:
988 usb_serial_deregister(&handspring_device);
989 failed_handspring_register:
990 return retval;
994 static void __exit visor_exit (void)
996 usb_deregister (&visor_driver);
997 usb_serial_deregister (&handspring_device);
998 usb_serial_deregister (&clie_3_5_device);
999 usb_serial_deregister (&clie_5_device);
1003 module_init(visor_init);
1004 module_exit(visor_exit);
1006 MODULE_AUTHOR( DRIVER_AUTHOR );
1007 MODULE_DESCRIPTION( DRIVER_DESC );
1008 MODULE_LICENSE("GPL");
1010 module_param(debug, bool, S_IRUGO | S_IWUSR);
1011 MODULE_PARM_DESC(debug, "Debug enabled or not");
1012 module_param(stats, bool, S_IRUGO | S_IWUSR);
1013 MODULE_PARM_DESC(stats, "Enables statistics or not");
1015 module_param(vendor, ushort, 0);
1016 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1017 module_param(product, ushort, 0);
1018 MODULE_PARM_DESC(product, "User specified product ID");