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