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