[PATCH] USB: allow usb drivers to disable dynamic ids
[linux-2.6.git] / drivers / usb / serial / visor.c
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 modify
9  *      it under the terms of the GNU General Public License as published by
10  *      the Free Software Foundation; either version 2 of the License.
11  *
12  * See Documentation/usb/usb-serial.txt for more information on using this driver
13  *
14  */
15
16 #include <linux/config.h>
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 <asm/uaccess.h>
28 #include <linux/usb.h>
29 #include "usb-serial.h"
30 #include "visor.h"
31
32 /*
33  * Version Information
34  */
35 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
36 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
37
38 /* function prototypes for a handspring visor */
39 static int  visor_open          (struct usb_serial_port *port, struct file *filp);
40 static void visor_close         (struct usb_serial_port *port, struct file *filp);
41 static int  visor_write         (struct usb_serial_port *port, const unsigned char *buf, int count);
42 static int  visor_write_room            (struct usb_serial_port *port);
43 static int  visor_chars_in_buffer       (struct usb_serial_port *port);
44 static void visor_throttle      (struct usb_serial_port *port);
45 static void visor_unthrottle    (struct usb_serial_port *port);
46 static int  visor_probe         (struct usb_serial *serial, const struct usb_device_id *id);
47 static int  visor_calc_num_ports(struct usb_serial *serial);
48 static void visor_shutdown      (struct usb_serial *serial);
49 static int  visor_ioctl         (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
50 static void visor_set_termios   (struct usb_serial_port *port, struct termios *old_termios);
51 static void visor_write_bulk_callback   (struct urb *urb, struct pt_regs *regs);
52 static void visor_read_bulk_callback    (struct urb *urb, struct pt_regs *regs);
53 static void visor_read_int_callback     (struct urb *urb, struct pt_regs *regs);
54 static int  clie_3_5_startup    (struct usb_serial *serial);
55 static int  treo_attach         (struct usb_serial *serial);
56 static int clie_5_attach (struct usb_serial *serial);
57 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id);
58 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id);
59
60 /* Parameters that may be passed into the module. */
61 static int debug;
62 static __u16 vendor;
63 static __u16 product;
64
65 static struct usb_device_id id_table [] = {
66         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
67                 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
68         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
69                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
70         { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_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_ZIRE31_ID),
93                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
95                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
97                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
99                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
101                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
103                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
105                 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106         { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_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 */
124 };
125
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 */
131 };
132
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 */
136 };
137
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(PALM_VENDOR_ID, PALM_M500_ID) },
143         { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
144         { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
145         { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
146         { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
147         { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
148         { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
149         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
150         { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
151         { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
152         { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE31_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 */
171 };
172
173 MODULE_DEVICE_TABLE (usb, id_table_combined);
174
175 static struct usb_driver visor_driver = {
176         .owner =        THIS_MODULE,
177         .name =         "visor",
178         .probe =        usb_serial_probe,
179         .disconnect =   usb_serial_disconnect,
180         .id_table =     id_table_combined,
181         .no_dynamic_id =        1,
182 };
183
184 /* All of the device info needed for the Handspring Visor, and Palm 4.0 devices */
185 static struct usb_serial_driver handspring_device = {
186         .driver = {
187                 .owner =        THIS_MODULE,
188                 .name =         "visor",
189         },
190         .description =          "Handspring Visor / Palm OS",
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         .set_termios =          visor_set_termios,
206         .write =                visor_write,
207         .write_room =           visor_write_room,
208         .chars_in_buffer =      visor_chars_in_buffer,
209         .write_bulk_callback =  visor_write_bulk_callback,
210         .read_bulk_callback =   visor_read_bulk_callback,
211         .read_int_callback =    visor_read_int_callback,
212 };
213
214 /* All of the device info needed for the Clie UX50, TH55 Palm 5.0 devices */
215 static struct usb_serial_driver clie_5_device = {
216         .driver = {
217                 .owner =        THIS_MODULE,
218                 .name =         "clie_5",
219         },
220         .description =          "Sony Clie 5.0",
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         .set_termios =          visor_set_termios,
236         .write =                visor_write,
237         .write_room =           visor_write_room,
238         .chars_in_buffer =      visor_chars_in_buffer,
239         .write_bulk_callback =  visor_write_bulk_callback,
240         .read_bulk_callback =   visor_read_bulk_callback,
241         .read_int_callback =    visor_read_int_callback,
242 };
243
244 /* device info for the Sony Clie OS version 3.5 */
245 static struct usb_serial_driver clie_3_5_device = {
246         .driver = {
247                 .owner =        THIS_MODULE,
248                 .name =         "clie_3.5",
249         },
250         .description =          "Sony Clie 3.5",
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         .set_termios =          visor_set_termios,
263         .write =                visor_write,
264         .write_room =           visor_write_room,
265         .chars_in_buffer =      visor_chars_in_buffer,
266         .write_bulk_callback =  visor_write_bulk_callback,
267         .read_bulk_callback =   visor_read_bulk_callback,
268 };
269
270 struct visor_private {
271         spinlock_t lock;
272         int bytes_in;
273         int bytes_out;
274         int outstanding_urbs;
275         int throttled;
276 };
277
278 /* number of outstanding urbs to prevent userspace DoS from happening */
279 #define URB_UPPER_LIMIT 42
280
281 static int stats;
282
283 /******************************************************************************
284  * Handspring Visor specific driver functions
285  ******************************************************************************/
286 static int visor_open (struct usb_serial_port *port, struct file *filp)
287 {
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;
292
293         dbg("%s - port %d", __FUNCTION__, port->number);
294
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;
299         }
300
301         spin_lock_irqsave(&priv->lock, flags);
302         priv->bytes_in = 0;
303         priv->bytes_out = 0;
304         priv->outstanding_urbs = 0;
305         priv->throttled = 0;
306         spin_unlock_irqrestore(&priv->lock, flags);
307
308         /*
309          * Force low_latency on so that our tty_push actually forces the data
310          * through, otherwise it is scheduled, and with high data rates (like
311          * with OHCI) data can get lost.
312          */
313         if (port->tty)
314                 port->tty->low_latency = 1;
315
316         /* Start reading from the device */
317         usb_fill_bulk_urb (port->read_urb, serial->dev,
318                            usb_rcvbulkpipe (serial->dev, 
319                                             port->bulk_in_endpointAddress),
320                            port->read_urb->transfer_buffer,
321                            port->read_urb->transfer_buffer_length,
322                            visor_read_bulk_callback, port);
323         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
324         if (result) {
325                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n",
326                         __FUNCTION__, result);
327                 goto exit;
328         }
329         
330         if (port->interrupt_in_urb) {
331                 dbg("%s - adding interrupt input for treo", __FUNCTION__);
332                 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
333                 if (result)
334                         dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n",
335                                 __FUNCTION__, result);
336         }
337 exit:   
338         return result;
339 }
340
341
342 static void visor_close (struct usb_serial_port *port, struct file * filp)
343 {
344         struct visor_private *priv = usb_get_serial_port_data(port);
345         unsigned char *transfer_buffer;
346
347         dbg("%s - port %d", __FUNCTION__, port->number);
348                          
349         /* shutdown our urbs */
350         usb_kill_urb(port->read_urb);
351         if (port->interrupt_in_urb)
352                 usb_kill_urb(port->interrupt_in_urb);
353
354         /* Try to send shutdown message, if the device is gone, this will just fail. */
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);
363         }
364
365         if (stats)
366                 dev_info(&port->dev, "Bytes In = %d  Bytes Out = %d\n",
367                          priv->bytes_in, priv->bytes_out);
368 }
369
370
371 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count)
372 {
373         struct visor_private *priv = usb_get_serial_port_data(port);
374         struct usb_serial *serial = port->serial;
375         struct urb *urb;
376         unsigned char *buffer;
377         unsigned long flags;
378         int status;
379
380         dbg("%s - port %d", __FUNCTION__, port->number);
381
382         spin_lock_irqsave(&priv->lock, flags);
383         if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
384                 spin_unlock_irqrestore(&priv->lock, flags);
385                 dbg("%s - write limit hit\n", __FUNCTION__);
386                 return 0;
387         }
388         spin_unlock_irqrestore(&priv->lock, flags);
389
390         buffer = kmalloc (count, GFP_ATOMIC);
391         if (!buffer) {
392                 dev_err(&port->dev, "out of memory\n");
393                 return -ENOMEM;
394         }
395
396         urb = usb_alloc_urb(0, GFP_ATOMIC);
397         if (!urb) {
398                 dev_err(&port->dev, "no more free urbs\n");
399                 kfree (buffer);
400                 return -ENOMEM;
401         }
402
403         memcpy (buffer, buf, count);
404
405         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
406
407         usb_fill_bulk_urb (urb, serial->dev,
408                            usb_sndbulkpipe (serial->dev,
409                                             port->bulk_out_endpointAddress),
410                            buffer, count, 
411                            visor_write_bulk_callback, port);
412
413         /* send it down the pipe */
414         status = usb_submit_urb(urb, GFP_ATOMIC);
415         if (status) {
416                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
417                         __FUNCTION__, status);
418                 count = status;
419                 kfree (buffer);
420         } else {
421                 spin_lock_irqsave(&priv->lock, flags);
422                 ++priv->outstanding_urbs;
423                 priv->bytes_out += count;
424                 spin_unlock_irqrestore(&priv->lock, flags);
425         }
426
427         /* we are done with this urb, so let the host driver
428          * really free it when it is finished with it */
429         usb_free_urb (urb);
430
431         return count;
432 }
433
434
435 static int visor_write_room (struct usb_serial_port *port)
436 {
437         dbg("%s - port %d", __FUNCTION__, port->number);
438
439         /*
440          * We really can take anything the user throws at us
441          * but let's pick a nice big number to tell the tty
442          * layer that we have lots of free space
443          */
444         return 2048;
445 }
446
447
448 static int visor_chars_in_buffer (struct usb_serial_port *port)
449 {
450         dbg("%s - port %d", __FUNCTION__, port->number);
451
452         /* 
453          * We can't really account for how much data we
454          * have sent out, but hasn't made it through to the
455          * device, so just tell the tty layer that everything
456          * is flushed.
457          */
458         return 0;
459 }
460
461
462 static void visor_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
463 {
464         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
465         struct visor_private *priv = usb_get_serial_port_data(port);
466         unsigned long flags;
467
468         /* free up the transfer buffer, as usb_free_urb() does not do this */
469         kfree (urb->transfer_buffer);
470
471         dbg("%s - port %d", __FUNCTION__, port->number);
472         
473         if (urb->status)
474                 dbg("%s - nonzero write bulk status received: %d",
475                     __FUNCTION__, urb->status);
476
477         spin_lock_irqsave(&priv->lock, flags);
478         --priv->outstanding_urbs;
479         spin_unlock_irqrestore(&priv->lock, flags);
480
481         schedule_work(&port->work);
482 }
483
484
485 static void visor_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
486 {
487         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
488         struct visor_private *priv = usb_get_serial_port_data(port);
489         unsigned char *data = urb->transfer_buffer;
490         struct tty_struct *tty;
491         unsigned long flags;
492         int i;
493         int throttled;
494         int result;
495
496         dbg("%s - port %d", __FUNCTION__, port->number);
497
498         if (urb->status) {
499                 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
500                 return;
501         }
502
503         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
504
505         tty = port->tty;
506         if (tty && urb->actual_length) {
507                 for (i = 0; i < urb->actual_length ; ++i) {
508                         /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
509                         if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
510                                 tty_flip_buffer_push(tty);
511                         }
512                         /* this doesn't actually push the data through unless tty->low_latency is set */
513                         tty_insert_flip_char(tty, data[i], 0);
514                 }
515                 tty_flip_buffer_push(tty);
516         }
517         spin_lock_irqsave(&priv->lock, flags);
518         priv->bytes_in += urb->actual_length;
519         throttled = priv->throttled;
520         spin_unlock_irqrestore(&priv->lock, flags);
521
522         /* Continue trying to always read if we should */
523         if (!throttled) {
524                 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
525                                    usb_rcvbulkpipe(port->serial->dev,
526                                                    port->bulk_in_endpointAddress),
527                                    port->read_urb->transfer_buffer,
528                                    port->read_urb->transfer_buffer_length,
529                                    visor_read_bulk_callback, port);
530                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
531                 if (result)
532                         dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
533         }
534         return;
535 }
536
537 static void visor_read_int_callback (struct urb *urb, struct pt_regs *regs)
538 {
539         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
540         int result;
541
542         switch (urb->status) {
543         case 0:
544                 /* success */
545                 break;
546         case -ECONNRESET:
547         case -ENOENT:
548         case -ESHUTDOWN:
549                 /* this urb is terminated, clean up */
550                 dbg("%s - urb shutting down with status: %d",
551                     __FUNCTION__, urb->status);
552                 return;
553         default:
554                 dbg("%s - nonzero urb status received: %d",
555                     __FUNCTION__, urb->status);
556                 goto exit;
557         }
558
559         /*
560          * This information is still unknown what it can be used for.
561          * If anyone has an idea, please let the author know...
562          *
563          * Rumor has it this endpoint is used to notify when data
564          * is ready to be read from the bulk ones.
565          */
566         usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
567                               urb->actual_length, urb->transfer_buffer);
568
569 exit:
570         result = usb_submit_urb (urb, GFP_ATOMIC);
571         if (result)
572                 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
573                         __FUNCTION__, result);
574 }
575
576 static void visor_throttle (struct usb_serial_port *port)
577 {
578         struct visor_private *priv = usb_get_serial_port_data(port);
579         unsigned long flags;
580
581         dbg("%s - port %d", __FUNCTION__, port->number);
582         spin_lock_irqsave(&priv->lock, flags);
583         priv->throttled = 1;
584         spin_unlock_irqrestore(&priv->lock, flags);
585 }
586
587
588 static void visor_unthrottle (struct usb_serial_port *port)
589 {
590         struct visor_private *priv = usb_get_serial_port_data(port);
591         unsigned long flags;
592         int result;
593
594         dbg("%s - port %d", __FUNCTION__, port->number);
595         spin_lock_irqsave(&priv->lock, flags);
596         priv->throttled = 0;
597         spin_unlock_irqrestore(&priv->lock, flags);
598
599         port->read_urb->dev = port->serial->dev;
600         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
601         if (result)
602                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
603 }
604
605 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
606 {
607         struct device *dev = &serial->dev->dev;
608         struct visor_connection_info *connection_info;
609         unsigned char *transfer_buffer;
610         char *string;
611         int retval = 0;
612         int i;
613         int num_ports = 0;
614
615         dbg("%s", __FUNCTION__);
616
617         transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
618         if (!transfer_buffer) {
619                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
620                         sizeof(*connection_info));
621                 return -ENOMEM;
622         }
623
624         /* send a get connection info request */
625         retval = usb_control_msg (serial->dev,
626                                   usb_rcvctrlpipe(serial->dev, 0),
627                                   VISOR_GET_CONNECTION_INFORMATION,
628                                   0xc2, 0x0000, 0x0000, transfer_buffer,
629                                   sizeof(*connection_info), 300);
630         if (retval < 0) {
631                 dev_err(dev, "%s - error %d getting connection information\n",
632                         __FUNCTION__, retval);
633                 goto exit;
634         }
635
636         if (retval == sizeof(*connection_info)) {
637                 connection_info = (struct visor_connection_info *)transfer_buffer;
638
639                 num_ports = le16_to_cpu(connection_info->num_ports);
640                 for (i = 0; i < num_ports; ++i) {
641                         switch (connection_info->connections[i].port_function_id) {
642                                 case VISOR_FUNCTION_GENERIC:
643                                         string = "Generic";
644                                         break;
645                                 case VISOR_FUNCTION_DEBUGGER:
646                                         string = "Debugger";
647                                         break;
648                                 case VISOR_FUNCTION_HOTSYNC:
649                                         string = "HotSync";
650                                         break;
651                                 case VISOR_FUNCTION_CONSOLE:
652                                         string = "Console";
653                                         break;
654                                 case VISOR_FUNCTION_REMOTE_FILE_SYS:
655                                         string = "Remote File System";
656                                         break;
657                                 default:
658                                         string = "unknown";
659                                         break;
660                         }
661                         dev_info(dev, "%s: port %d, is for %s use\n",
662                                 serial->type->description,
663                                 connection_info->connections[i].port, string);
664                 }
665         }
666         /*
667         * Handle devices that report invalid stuff here.
668         */
669         if (num_ports == 0 || num_ports > 2) {
670                 dev_warn (dev, "%s: No valid connect info available\n",
671                         serial->type->description);
672                 num_ports = 2;
673         }
674   
675         dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
676                 num_ports);
677
678         /*
679          * save off our num_ports info so that we can use it in the
680          * calc_num_ports callback
681          */
682         usb_set_serial_data(serial, (void *)(long)num_ports);
683
684         /* ask for the number of bytes available, but ignore the response as it is broken */
685         retval = usb_control_msg (serial->dev,
686                                   usb_rcvctrlpipe(serial->dev, 0),
687                                   VISOR_REQUEST_BYTES_AVAILABLE,
688                                   0xc2, 0x0000, 0x0005, transfer_buffer,
689                                   0x02, 300);
690         if (retval < 0)
691                 dev_err(dev, "%s - error %d getting bytes available request\n",
692                         __FUNCTION__, retval);
693         retval = 0;
694
695 exit:
696         kfree (transfer_buffer);
697
698         return retval;
699 }
700
701 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
702 {
703         struct device *dev = &serial->dev->dev;
704         struct palm_ext_connection_info *connection_info;
705         unsigned char *transfer_buffer;
706         int retval;
707
708         dbg("%s", __FUNCTION__);
709
710         transfer_buffer =  kmalloc (sizeof (*connection_info), GFP_KERNEL);
711         if (!transfer_buffer) {
712                 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
713                         sizeof(*connection_info));
714                 return -ENOMEM;
715         }
716
717         retval = usb_control_msg (serial->dev,
718                                   usb_rcvctrlpipe(serial->dev, 0), 
719                                   PALM_GET_EXT_CONNECTION_INFORMATION,
720                                   0xc2, 0x0000, 0x0000, transfer_buffer,
721                                   sizeof (*connection_info), 300);
722         if (retval < 0)
723                 dev_err(dev, "%s - error %d getting connection info\n",
724                         __FUNCTION__, retval);
725         else
726                 usb_serial_debug_data(debug, &serial->dev->dev, __FUNCTION__,
727                                       retval, transfer_buffer);
728
729         kfree (transfer_buffer);
730         return 0;
731 }
732
733
734 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
735 {
736         int retval = 0;
737         int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
738
739         dbg("%s", __FUNCTION__);
740
741         if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
742                 err("active config #%d != 1 ??",
743                         serial->dev->actconfig->desc.bConfigurationValue);
744                 return -ENODEV;
745         }
746
747         if (id->driver_info) {
748                 startup = (void *)id->driver_info;
749                 retval = startup(serial, id);
750         }
751
752         return retval;
753 }
754
755 static int visor_calc_num_ports (struct usb_serial *serial)
756 {
757         int num_ports = (int)(long)(usb_get_serial_data(serial));
758
759         if (num_ports)
760                 usb_set_serial_data(serial, NULL);
761
762         return num_ports;
763 }
764
765 static int generic_startup(struct usb_serial *serial)
766 {
767         struct visor_private *priv;
768         int i;
769
770         for (i = 0; i < serial->num_ports; ++i) {
771                 priv = kmalloc (sizeof(*priv), GFP_KERNEL);
772                 if (!priv)
773                         return -ENOMEM;
774                 memset (priv, 0x00, sizeof(*priv));
775                 spin_lock_init(&priv->lock);
776                 usb_set_serial_port_data(serial->port[i], priv);
777         }
778         return 0;
779 }
780
781 static int clie_3_5_startup (struct usb_serial *serial)
782 {
783         struct device *dev = &serial->dev->dev;
784         int result;
785         u8 data;
786
787         dbg("%s", __FUNCTION__);
788
789         /*
790          * Note that PEG-300 series devices expect the following two calls.
791          */
792
793         /* get the config number */
794         result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
795                                   USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
796                                   0, 0, &data, 1, 3000);
797         if (result < 0) {
798                 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
799                 return result;
800         }
801         if (result != 1) {
802                 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
803                 return -EIO;
804         }
805
806         /* get the interface number */
807         result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
808                                   USB_REQ_GET_INTERFACE, 
809                                   USB_DIR_IN | USB_RECIP_INTERFACE,
810                                   0, 0, &data, 1, 3000);
811         if (result < 0) {
812                 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
813                 return result;
814         }
815         if (result != 1) {
816                 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
817                 return -EIO;
818         }
819
820         return generic_startup(serial);
821 }
822  
823 static int treo_attach (struct usb_serial *serial)
824 {
825         struct usb_serial_port *swap_port;
826
827         /* Only do this endpoint hack for the Handspring devices with
828          * interrupt in endpoints, which for now are the Treo devices. */
829         if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
830               (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
831             (serial->num_interrupt_in == 0))
832                 goto generic_startup;
833
834         dbg("%s", __FUNCTION__);
835
836         /*
837         * It appears that Treos and Kyoceras want to use the 
838         * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint, 
839         * so let's swap the 1st and 2nd bulk in and interrupt endpoints.  
840         * Note that swapping the bulk out endpoints would break lots of 
841         * apps that want to communicate on the second port.
842         */
843 #define COPY_PORT(dest, src)                                            \
844         dest->read_urb = src->read_urb;                                 \
845         dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;   \
846         dest->bulk_in_buffer = src->bulk_in_buffer;                     \
847         dest->interrupt_in_urb = src->interrupt_in_urb;                 \
848         dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
849         dest->interrupt_in_buffer = src->interrupt_in_buffer;
850
851         swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
852         if (!swap_port)
853                 return -ENOMEM;
854         COPY_PORT(swap_port, serial->port[0]);
855         COPY_PORT(serial->port[0], serial->port[1]);
856         COPY_PORT(serial->port[1], swap_port);
857         kfree(swap_port);
858
859 generic_startup:
860         return generic_startup(serial);
861 }
862
863 static int clie_5_attach (struct usb_serial *serial)
864 {
865         dbg("%s", __FUNCTION__);
866
867         /* TH55 registers 2 ports. 
868            Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0 
869            Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1 
870            
871            Lets do a quick and dirty mapping
872          */
873         
874         /* some sanity check */
875         if (serial->num_ports < 2)
876                 return -1;
877                 
878         /* port 0 now uses the modified endpoint Address */
879         serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
880
881         return generic_startup(serial);
882 }
883
884 static void visor_shutdown (struct usb_serial *serial)
885 {
886         dbg("%s", __FUNCTION__);
887 }
888
889 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
890 {
891         dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
892
893         return -ENOIOCTLCMD;
894 }
895
896
897 /* This function is all nice and good, but we don't change anything based on it :) */
898 static void visor_set_termios (struct usb_serial_port *port, struct termios *old_termios)
899 {
900         unsigned int cflag;
901
902         dbg("%s - port %d", __FUNCTION__, port->number);
903
904         if ((!port->tty) || (!port->tty->termios)) {
905                 dbg("%s - no tty structures", __FUNCTION__);
906                 return;
907         }
908
909         cflag = port->tty->termios->c_cflag;
910         /* check that they really want us to change something */
911         if (old_termios) {
912                 if ((cflag == old_termios->c_cflag) &&
913                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
914                         dbg("%s - nothing to change...", __FUNCTION__);
915                         return;
916                 }
917         }
918
919         /* get the byte size */
920         switch (cflag & CSIZE) {
921                 case CS5:       dbg("%s - data bits = 5", __FUNCTION__);   break;
922                 case CS6:       dbg("%s - data bits = 6", __FUNCTION__);   break;
923                 case CS7:       dbg("%s - data bits = 7", __FUNCTION__);   break;
924                 default:
925                 case CS8:       dbg("%s - data bits = 8", __FUNCTION__);   break;
926         }
927         
928         /* determine the parity */
929         if (cflag & PARENB)
930                 if (cflag & PARODD)
931                         dbg("%s - parity = odd", __FUNCTION__);
932                 else
933                         dbg("%s - parity = even", __FUNCTION__);
934         else
935                 dbg("%s - parity = none", __FUNCTION__);
936
937         /* figure out the stop bits requested */
938         if (cflag & CSTOPB)
939                 dbg("%s - stop bits = 2", __FUNCTION__);
940         else
941                 dbg("%s - stop bits = 1", __FUNCTION__);
942
943         
944         /* figure out the flow control settings */
945         if (cflag & CRTSCTS)
946                 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
947         else
948                 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
949         
950         /* determine software flow control */
951         if (I_IXOFF(port->tty))
952                 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
953                     __FUNCTION__, START_CHAR(port->tty), STOP_CHAR(port->tty));
954         else
955                 dbg("%s - XON/XOFF is disabled", __FUNCTION__);
956
957         /* get the baud rate wanted */
958         dbg("%s - baud rate = %d", __FUNCTION__, tty_get_baud_rate(port->tty));
959
960         return;
961 }
962
963
964 static int __init visor_init (void)
965 {
966         int i, retval;
967         /* Only if parameters were passed to us */
968         if ((vendor>0) && (product>0)) {
969                 struct usb_device_id usb_dev_temp[]=
970                         {{USB_DEVICE(vendor, product),
971                         .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
972
973                 /* Find the last entry in id_table */
974                 for (i=0; ; i++) {
975                         if (id_table[i].idVendor==0) {
976                                 id_table[i] = usb_dev_temp[0];
977                                 break;
978                         }
979                 }
980                 /* Find the last entry in id_table_combined */
981                 for (i=0; ; i++) {
982                         if (id_table_combined[i].idVendor==0) {
983                                 id_table_combined[i] = usb_dev_temp[0];
984                                 break;
985                         }
986                 }
987                 info("Untested USB device specified at time of module insertion");
988                 info("Warning: This is not guaranteed to work");
989                 info("Using a newer kernel is preferred to this method");
990                 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
991                         vendor, product);
992         }
993         retval = usb_serial_register(&handspring_device);
994         if (retval)
995                 goto failed_handspring_register;
996         retval = usb_serial_register(&clie_3_5_device);
997         if (retval)
998                 goto failed_clie_3_5_register;
999         retval = usb_serial_register(&clie_5_device);
1000         if (retval)
1001                 goto failed_clie_5_register;
1002         retval = usb_register(&visor_driver);
1003         if (retval) 
1004                 goto failed_usb_register;
1005         info(DRIVER_DESC);
1006
1007         return 0;
1008 failed_usb_register:
1009         usb_serial_deregister(&clie_5_device);
1010 failed_clie_5_register:
1011         usb_serial_deregister(&clie_3_5_device);
1012 failed_clie_3_5_register:
1013         usb_serial_deregister(&handspring_device);
1014 failed_handspring_register:
1015         return retval;
1016 }
1017
1018
1019 static void __exit visor_exit (void)
1020 {
1021         usb_deregister (&visor_driver);
1022         usb_serial_deregister (&handspring_device);
1023         usb_serial_deregister (&clie_3_5_device);
1024         usb_serial_deregister (&clie_5_device);
1025 }
1026
1027
1028 module_init(visor_init);
1029 module_exit(visor_exit);
1030
1031 MODULE_AUTHOR( DRIVER_AUTHOR );
1032 MODULE_DESCRIPTION( DRIVER_DESC );
1033 MODULE_LICENSE("GPL");
1034
1035 module_param(debug, bool, S_IRUGO | S_IWUSR);
1036 MODULE_PARM_DESC(debug, "Debug enabled or not");
1037 module_param(stats, bool, S_IRUGO | S_IWUSR);
1038 MODULE_PARM_DESC(stats, "Enables statistics or not");
1039
1040 module_param(vendor, ushort, 0);
1041 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1042 module_param(product, ushort, 0);
1043 MODULE_PARM_DESC(product, "User specified product ID");
1044