?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
USB: fix race in visor_write
[linux-2.6/verdex.git] / drivers / usb / serial / visor.c
blobffbe601cde2a563d34f3921eaee2934b92c56f53
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/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 int throttled;
277 };
278
279 /* number of outstanding urbs to prevent userspace DoS from happening */
280 #define URB_UPPER_LIMIT 42
281
282 static int stats;
283
284 /******************************************************************************
285 * Handspring Visor specific driver functions
286 ******************************************************************************/
287 static int visor_open (struct usb_serial_port *port, struct file *filp)
288 {
289 struct usb_serial *serial = port->serial;
290 struct visor_private *priv = usb_get_serial_port_data(port);
291 unsigned long flags;
292 int result = 0;
293
294 dbg("%s - port %d", __FUNCTION__, port->number);
295
296 if (!port->read_urb) {
297 /* this is needed for some brain dead Sony devices */
298 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
299 return -ENODEV;
300 }
301
302 spin_lock_irqsave(&priv->lock, flags);
303 priv->bytes_in = 0;
304 priv->bytes_out = 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 usb_kill_urb(port->interrupt_in_urb);
352
353 /* Try to send shutdown message, if the device is gone, this will just fail. */
354 transfer_buffer = kmalloc (0x12, GFP_KERNEL);
355 if (transfer_buffer) {
356 usb_control_msg (port->serial->dev,
357 usb_rcvctrlpipe(port->serial->dev, 0),
358 VISOR_CLOSE_NOTIFICATION, 0xc2,
359 0x0000, 0x0000,
360 transfer_buffer, 0x12, 300);
361 kfree (transfer_buffer);
362 }
363
364 if (stats)
365 dev_info(&port->dev, "Bytes In = %d Bytes Out = %d\n",
366 priv->bytes_in, priv->bytes_out);
367 }
368
369
370 static int visor_write (struct usb_serial_port *port, const unsigned char *buf, int count)
371 {
372 struct visor_private *priv = usb_get_serial_port_data(port);
373 struct usb_serial *serial = port->serial;
374 struct urb *urb;
375 unsigned char *buffer;
376 unsigned long flags;
377 int status;
378
379 dbg("%s - port %d", __FUNCTION__, port->number);
380
381 spin_lock_irqsave(&priv->lock, flags);
382 if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
383 spin_unlock_irqrestore(&priv->lock, flags);
384 dbg("%s - write limit hit\n", __FUNCTION__);
385 return 0;
386 }
387 priv->outstanding_urbs++;
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 count = -ENOMEM;
394 goto error_no_buffer;
395 }
396
397 urb = usb_alloc_urb(0, GFP_ATOMIC);
398 if (!urb) {
399 dev_err(&port->dev, "no more free urbs\n");
400 count = -ENOMEM;
401 goto error_no_urb;
402 }
403
404 memcpy (buffer, buf, count);
405
406 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
407
408 usb_fill_bulk_urb (urb, serial->dev,
409 usb_sndbulkpipe (serial->dev,
410 port->bulk_out_endpointAddress),
411 buffer, count,
412 visor_write_bulk_callback, port);
413
414 /* send it down the pipe */
415 status = usb_submit_urb(urb, GFP_ATOMIC);
416 if (status) {
417 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed with status = %d\n",
418 __FUNCTION__, status);
419 count = status;
420 goto error;
421 } else {
422 spin_lock_irqsave(&priv->lock, flags);
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 error:
433 usb_free_urb(urb);
434 error_no_urb:
435 kfree(buffer);
436 error_no_buffer:
437 spin_lock_irqsave(&priv->lock, flags);
438 --priv->outstanding_urbs;
439 spin_unlock_irqrestore(&priv->lock, flags);
440 return count;
441 }
442
443
444 static int visor_write_room (struct usb_serial_port *port)
445 {
446 struct visor_private *priv = usb_get_serial_port_data(port);
447 unsigned long flags;
448
449 dbg("%s - port %d", __FUNCTION__, port->number);
450
451 /*
452 * We really can take anything the user throws at us
453 * but let's pick a nice big number to tell the tty
454 * layer that we have lots of free space, unless we don't.
455 */
456
457 spin_lock_irqsave(&priv->lock, flags);
458 if (priv->outstanding_urbs > URB_UPPER_LIMIT * 2 / 3) {
459 spin_unlock_irqrestore(&priv->lock, flags);
460 dbg("%s - write limit hit\n", __FUNCTION__);
461 return 0;
462 }
463 spin_unlock_irqrestore(&priv->lock, flags);
464
465 return 2048;
466 }
467
468
469 static int visor_chars_in_buffer (struct usb_serial_port *port)
470 {
471 dbg("%s - port %d", __FUNCTION__, port->number);
472
473 /*
474 * We can't really account for how much data we
475 * have sent out, but hasn't made it through to the
476 * device, so just tell the tty layer that everything
477 * is flushed.
478 */
479 return 0;
480 }
481
482
483 static void visor_write_bulk_callback (struct urb *urb)
484 {
485 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
486 struct visor_private *priv = usb_get_serial_port_data(port);
487 unsigned long flags;
488
489 /* free up the transfer buffer, as usb_free_urb() does not do this */
490 kfree (urb->transfer_buffer);
491
492 dbg("%s - port %d", __FUNCTION__, port->number);
493
494 if (urb->status)
495 dbg("%s - nonzero write bulk status received: %d",
496 __FUNCTION__, urb->status);
497
498 spin_lock_irqsave(&priv->lock, flags);
499 --priv->outstanding_urbs;
500 spin_unlock_irqrestore(&priv->lock, flags);
501
502 usb_serial_port_softint(port);
503 }
504
505
506 static void visor_read_bulk_callback (struct urb *urb)
507 {
508 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
509 struct visor_private *priv = usb_get_serial_port_data(port);
510 unsigned char *data = urb->transfer_buffer;
511 struct tty_struct *tty;
512 unsigned long flags;
513 int throttled;
514 int result;
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 tty_buffer_request_room(tty, urb->actual_length);
528 tty_insert_flip_string(tty, data, urb->actual_length);
529 tty_flip_buffer_push(tty);
530 }
531 spin_lock_irqsave(&priv->lock, flags);
532 priv->bytes_in += urb->actual_length;
533 throttled = priv->throttled;
534 spin_unlock_irqrestore(&priv->lock, flags);
535
536 /* Continue trying to always read if we should */
537 if (!throttled) {
538 usb_fill_bulk_urb (port->read_urb, port->serial->dev,
539 usb_rcvbulkpipe(port->serial->dev,
540 port->bulk_in_endpointAddress),
541 port->read_urb->transfer_buffer,
542 port->read_urb->transfer_buffer_length,
543 visor_read_bulk_callback, port);
544 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
545 if (result)
546 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
547 }
548 return;
549 }
550
551 static void visor_read_int_callback (struct urb *urb)
552 {
553 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
554 int result;
555
556 switch (urb->status) {
557 case 0:
558 /* success */
559 break;
560 case -ECONNRESET:
561 case -ENOENT:
562 case -ESHUTDOWN:
563 /* this urb is terminated, clean up */
564 dbg("%s - urb shutting down with status: %d",
565 __FUNCTION__, urb->status);
566 return;
567 default:
568 dbg("%s - nonzero urb status received: %d",
569 __FUNCTION__, urb->status);
570 goto exit;
571 }
572
573 /*
574 * This information is still unknown what it can be used for.
575 * If anyone has an idea, please let the author know...
576 *
577 * Rumor has it this endpoint is used to notify when data
578 * is ready to be read from the bulk ones.
579 */
580 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
581 urb->actual_length, urb->transfer_buffer);
582
583 exit:
584 result = usb_submit_urb (urb, GFP_ATOMIC);
585 if (result)
586 dev_err(&urb->dev->dev, "%s - Error %d submitting interrupt urb\n",
587 __FUNCTION__, result);
588 }
589
590 static void visor_throttle (struct usb_serial_port *port)
591 {
592 struct visor_private *priv = usb_get_serial_port_data(port);
593 unsigned long flags;
594
595 dbg("%s - port %d", __FUNCTION__, port->number);
596 spin_lock_irqsave(&priv->lock, flags);
597 priv->throttled = 1;
598 spin_unlock_irqrestore(&priv->lock, flags);
599 }
600
601
602 static void visor_unthrottle (struct usb_serial_port *port)
603 {
604 struct visor_private *priv = usb_get_serial_port_data(port);
605 unsigned long flags;
606 int result;
607
608 dbg("%s - port %d", __FUNCTION__, port->number);
609 spin_lock_irqsave(&priv->lock, flags);
610 priv->throttled = 0;
611 spin_unlock_irqrestore(&priv->lock, flags);
612
613 port->read_urb->dev = port->serial->dev;
614 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
615 if (result)
616 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
617 }
618
619 static int palm_os_3_probe (struct usb_serial *serial, const struct usb_device_id *id)
620 {
621 struct device *dev = &serial->dev->dev;
622 struct visor_connection_info *connection_info;
623 unsigned char *transfer_buffer;
624 char *string;
625 int retval = 0;
626 int i;
627 int num_ports = 0;
628
629 dbg("%s", __FUNCTION__);
630
631 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
632 if (!transfer_buffer) {
633 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
634 sizeof(*connection_info));
635 return -ENOMEM;
636 }
637
638 /* send a get connection info request */
639 retval = usb_control_msg (serial->dev,
640 usb_rcvctrlpipe(serial->dev, 0),
641 VISOR_GET_CONNECTION_INFORMATION,
642 0xc2, 0x0000, 0x0000, transfer_buffer,
643 sizeof(*connection_info), 300);
644 if (retval < 0) {
645 dev_err(dev, "%s - error %d getting connection information\n",
646 __FUNCTION__, retval);
647 goto exit;
648 }
649
650 if (retval == sizeof(*connection_info)) {
651 connection_info = (struct visor_connection_info *)transfer_buffer;
652
653 num_ports = le16_to_cpu(connection_info->num_ports);
654 for (i = 0; i < num_ports; ++i) {
655 switch (connection_info->connections[i].port_function_id) {
656 case VISOR_FUNCTION_GENERIC:
657 string = "Generic";
658 break;
659 case VISOR_FUNCTION_DEBUGGER:
660 string = "Debugger";
661 break;
662 case VISOR_FUNCTION_HOTSYNC:
663 string = "HotSync";
664 break;
665 case VISOR_FUNCTION_CONSOLE:
666 string = "Console";
667 break;
668 case VISOR_FUNCTION_REMOTE_FILE_SYS:
669 string = "Remote File System";
670 break;
671 default:
672 string = "unknown";
673 break;
674 }
675 dev_info(dev, "%s: port %d, is for %s use\n",
676 serial->type->description,
677 connection_info->connections[i].port, string);
678 }
679 }
680 /*
681 * Handle devices that report invalid stuff here.
682 */
683 if (num_ports == 0 || num_ports > 2) {
684 dev_warn (dev, "%s: No valid connect info available\n",
685 serial->type->description);
686 num_ports = 2;
687 }
688
689 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
690 num_ports);
691
692 /*
693 * save off our num_ports info so that we can use it in the
694 * calc_num_ports callback
695 */
696 usb_set_serial_data(serial, (void *)(long)num_ports);
697
698 /* ask for the number of bytes available, but ignore the response as it is broken */
699 retval = usb_control_msg (serial->dev,
700 usb_rcvctrlpipe(serial->dev, 0),
701 VISOR_REQUEST_BYTES_AVAILABLE,
702 0xc2, 0x0000, 0x0005, transfer_buffer,
703 0x02, 300);
704 if (retval < 0)
705 dev_err(dev, "%s - error %d getting bytes available request\n",
706 __FUNCTION__, retval);
707 retval = 0;
708
709 exit:
710 kfree (transfer_buffer);
711
712 return retval;
713 }
714
715 static int palm_os_4_probe (struct usb_serial *serial, const struct usb_device_id *id)
716 {
717 struct device *dev = &serial->dev->dev;
718 struct palm_ext_connection_info *connection_info;
719 unsigned char *transfer_buffer;
720 int retval;
721
722 dbg("%s", __FUNCTION__);
723
724 transfer_buffer = kmalloc (sizeof (*connection_info), GFP_KERNEL);
725 if (!transfer_buffer) {
726 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __FUNCTION__,
727 sizeof(*connection_info));
728 return -ENOMEM;
729 }
730
731 retval = usb_control_msg (serial->dev,
732 usb_rcvctrlpipe(serial->dev, 0),
733 PALM_GET_EXT_CONNECTION_INFORMATION,
734 0xc2, 0x0000, 0x0000, transfer_buffer,
735 sizeof (*connection_info), 300);
736 if (retval < 0)
737 dev_err(dev, "%s - error %d getting connection info\n",
738 __FUNCTION__, retval);
739 else
740 usb_serial_debug_data(debug, &serial->dev->dev, __FUNCTION__,
741 retval, transfer_buffer);
742
743 kfree (transfer_buffer);
744 return 0;
745 }
746
747
748 static int visor_probe (struct usb_serial *serial, const struct usb_device_id *id)
749 {
750 int retval = 0;
751 int (*startup) (struct usb_serial *serial, const struct usb_device_id *id);
752
753 dbg("%s", __FUNCTION__);
754
755 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
756 err("active config #%d != 1 ??",
757 serial->dev->actconfig->desc.bConfigurationValue);
758 return -ENODEV;
759 }
760
761 if (id->driver_info) {
762 startup = (void *)id->driver_info;
763 retval = startup(serial, id);
764 }
765
766 return retval;
767 }
768
769 static int visor_calc_num_ports (struct usb_serial *serial)
770 {
771 int num_ports = (int)(long)(usb_get_serial_data(serial));
772
773 if (num_ports)
774 usb_set_serial_data(serial, NULL);
775
776 return num_ports;
777 }
778
779 static int generic_startup(struct usb_serial *serial)
780 {
781 struct usb_serial_port **ports = serial->port;
782 struct visor_private *priv;
783 int i;
784
785 for (i = 0; i < serial->num_ports; ++i) {
786 priv = kzalloc (sizeof(*priv), GFP_KERNEL);
787 if (!priv) {
788 while (i-- != 0) {
789 priv = usb_get_serial_port_data(ports[i]);
790 usb_set_serial_port_data(ports[i], NULL);
791 kfree(priv);
792 }
793 return -ENOMEM;
794 }
795 spin_lock_init(&priv->lock);
796 usb_set_serial_port_data(ports[i], priv);
797 }
798 return 0;
799 }
800
801 static int clie_3_5_startup (struct usb_serial *serial)
802 {
803 struct device *dev = &serial->dev->dev;
804 int result;
805 u8 data;
806
807 dbg("%s", __FUNCTION__);
808
809 /*
810 * Note that PEG-300 series devices expect the following two calls.
811 */
812
813 /* get the config number */
814 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
815 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
816 0, 0, &data, 1, 3000);
817 if (result < 0) {
818 dev_err(dev, "%s: get config number failed: %d\n", __FUNCTION__, result);
819 return result;
820 }
821 if (result != 1) {
822 dev_err(dev, "%s: get config number bad return length: %d\n", __FUNCTION__, result);
823 return -EIO;
824 }
825
826 /* get the interface number */
827 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0),
828 USB_REQ_GET_INTERFACE,
829 USB_DIR_IN | USB_RECIP_INTERFACE,
830 0, 0, &data, 1, 3000);
831 if (result < 0) {
832 dev_err(dev, "%s: get interface number failed: %d\n", __FUNCTION__, result);
833 return result;
834 }
835 if (result != 1) {
836 dev_err(dev, "%s: get interface number bad return length: %d\n", __FUNCTION__, result);
837 return -EIO;
838 }
839
840 return generic_startup(serial);
841 }
842
843 static int treo_attach (struct usb_serial *serial)
844 {
845 struct usb_serial_port *swap_port;
846
847 /* Only do this endpoint hack for the Handspring devices with
848 * interrupt in endpoints, which for now are the Treo devices. */
849 if (!((le16_to_cpu(serial->dev->descriptor.idVendor) == HANDSPRING_VENDOR_ID) ||
850 (le16_to_cpu(serial->dev->descriptor.idVendor) == KYOCERA_VENDOR_ID)) ||
851 (serial->num_interrupt_in == 0))
852 goto generic_startup;
853
854 dbg("%s", __FUNCTION__);
855
856 /*
857 * It appears that Treos and Kyoceras want to use the
858 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
859 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
860 * Note that swapping the bulk out endpoints would break lots of
861 * apps that want to communicate on the second port.
862 */
863 #define COPY_PORT(dest, src) \
864 dest->read_urb = src->read_urb; \
865 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress; \
866 dest->bulk_in_buffer = src->bulk_in_buffer; \
867 dest->interrupt_in_urb = src->interrupt_in_urb; \
868 dest->interrupt_in_endpointAddress = src->interrupt_in_endpointAddress; \
869 dest->interrupt_in_buffer = src->interrupt_in_buffer;
870
871 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
872 if (!swap_port)
873 return -ENOMEM;
874 COPY_PORT(swap_port, serial->port[0]);
875 COPY_PORT(serial->port[0], serial->port[1]);
876 COPY_PORT(serial->port[1], swap_port);
877 kfree(swap_port);
878
879 generic_startup:
880 return generic_startup(serial);
881 }
882
883 static int clie_5_attach (struct usb_serial *serial)
884 {
885 dbg("%s", __FUNCTION__);
886
887 /* TH55 registers 2 ports.
888 Communication in from the UX50/TH55 uses bulk_in_endpointAddress from port 0
889 Communication out to the UX50/TH55 uses bulk_out_endpointAddress from port 1
890
891 Lets do a quick and dirty mapping
892 */
893
894 /* some sanity check */
895 if (serial->num_ports < 2)
896 return -1;
897
898 /* port 0 now uses the modified endpoint Address */
899 serial->port[0]->bulk_out_endpointAddress = serial->port[1]->bulk_out_endpointAddress;
900
901 return generic_startup(serial);
902 }
903
904 static void visor_shutdown (struct usb_serial *serial)
905 {
906 struct visor_private *priv;
907 int i;
908
909 dbg("%s", __FUNCTION__);
910
911 for (i = 0; i < serial->num_ports; i++) {
912 priv = usb_get_serial_port_data(serial->port[i]);
913 if (priv) {
914 usb_set_serial_port_data(serial->port[i], NULL);
915 kfree(priv);
916 }
917 }
918 }
919
920 static int visor_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
921 {
922 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
923
924 return -ENOIOCTLCMD;
925 }
926
927
928 /* This function is all nice and good, but we don't change anything based on it :) */
929 static void visor_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
930 {
931 unsigned int cflag;
932
933 dbg("%s - port %d", __FUNCTION__, port->number);
934
935 if ((!port->tty) || (!port->tty->termios)) {
936 dbg("%s - no tty structures", __FUNCTION__);
937 return;
938 }
939
940 cflag = port->tty->termios->c_cflag;
941 /* check that they really want us to change something */
942 if (old_termios) {
943 if ((cflag == old_termios->c_cflag) &&
944 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
945 dbg("%s - nothing to change...", __FUNCTION__);
946 return;
947 }
948 }
949
950 /* get the byte size */
951 switch (cflag & CSIZE) {
952 case CS5: dbg("%s - data bits = 5", __FUNCTION__); break;
953 case CS6: dbg("%s - data bits = 6", __FUNCTION__); break;
954 case CS7: dbg("%s - data bits = 7", __FUNCTION__); break;
955 default:
956 case CS8: dbg("%s - data bits = 8", __FUNCTION__); break;
957 }
958
959 /* determine the parity */
960 if (cflag & PARENB)
961 if (cflag & PARODD)
962 dbg("%s - parity = odd", __FUNCTION__);
963 else
964 dbg("%s - parity = even", __FUNCTION__);
965 else
966 dbg("%s - parity = none", __FUNCTION__);
967
968 /* figure out the stop bits requested */
969 if (cflag & CSTOPB)
970 dbg("%s - stop bits = 2", __FUNCTION__);
971 else
972 dbg("%s - stop bits = 1", __FUNCTION__);
973
974
975 /* figure out the flow control settings */
976 if (cflag & CRTSCTS)
977 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
978 else
979 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
980
981 /* determine software flow control */
982 if (I_IXOFF(port->tty))
983 dbg("%s - XON/XOFF is enabled, XON = %2x, XOFF = %2x",
984 __FUNCTION__, START_CHAR(port->tty), STOP_CHAR(port->tty));
985 else
986 dbg("%s - XON/XOFF is disabled", __FUNCTION__);
987
988 /* get the baud rate wanted */
989 dbg("%s - baud rate = %d", __FUNCTION__, tty_get_baud_rate(port->tty));
990
991 return;
992 }
993
994
995 static int __init visor_init (void)
996 {
997 int i, retval;
998 /* Only if parameters were passed to us */
999 if ((vendor>0) && (product>0)) {
1000 struct usb_device_id usb_dev_temp[]=
1001 {{USB_DEVICE(vendor, product),
1002 .driver_info = (kernel_ulong_t)&palm_os_4_probe }};
1003
1004 /* Find the last entry in id_table */
1005 for (i=0; ; i++) {
1006 if (id_table[i].idVendor==0) {
1007 id_table[i] = usb_dev_temp[0];
1008 break;
1009 }
1010 }
1011 /* Find the last entry in id_table_combined */
1012 for (i=0; ; i++) {
1013 if (id_table_combined[i].idVendor==0) {
1014 id_table_combined[i] = usb_dev_temp[0];
1015 break;
1016 }
1017 }
1018 info("Untested USB device specified at time of module insertion");
1019 info("Warning: This is not guaranteed to work");
1020 info("Using a newer kernel is preferred to this method");
1021 info("Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x",
1022 vendor, product);
1023 }
1024 retval = usb_serial_register(&handspring_device);
1025 if (retval)
1026 goto failed_handspring_register;
1027 retval = usb_serial_register(&clie_3_5_device);
1028 if (retval)
1029 goto failed_clie_3_5_register;
1030 retval = usb_serial_register(&clie_5_device);
1031 if (retval)
1032 goto failed_clie_5_register;
1033 retval = usb_register(&visor_driver);
1034 if (retval)
1035 goto failed_usb_register;
1036 info(DRIVER_DESC);
1037
1038 return 0;
1039 failed_usb_register:
1040 usb_serial_deregister(&clie_5_device);
1041 failed_clie_5_register:
1042 usb_serial_deregister(&clie_3_5_device);
1043 failed_clie_3_5_register:
1044 usb_serial_deregister(&handspring_device);
1045 failed_handspring_register:
1046 return retval;
1047 }
1048
1049
1050 static void __exit visor_exit (void)
1051 {
1052 usb_deregister (&visor_driver);
1053 usb_serial_deregister (&handspring_device);
1054 usb_serial_deregister (&clie_3_5_device);
1055 usb_serial_deregister (&clie_5_device);
1056 }
1057
1058
1059 module_init(visor_init);
1060 module_exit(visor_exit);
1061
1062 MODULE_AUTHOR( DRIVER_AUTHOR );
1063 MODULE_DESCRIPTION( DRIVER_DESC );
1064 MODULE_LICENSE("GPL");
1065
1066 module_param(debug, bool, S_IRUGO | S_IWUSR);
1067 MODULE_PARM_DESC(debug, "Debug enabled or not");
1068 module_param(stats, bool, S_IRUGO | S_IWUSR);
1069 MODULE_PARM_DESC(stats, "Enables statistics or not");
1070
1071 module_param(vendor, ushort, 0);
1072 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1073 module_param(product, ushort, 0);
1074 MODULE_PARM_DESC(product, "User specified product ID");
1075
Verdex Pro support