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