?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
tty: Bring the usb tty port structure into more use
[linux-2.6/x86.git] / drivers / usb / serial / visor.c
blobb15f1c0e1d4acba4adcbadf66ac98a9870e8c994
1 /*
2 * USB HandSpring Visor, Palm m50x, and Sony Clie driver
3 * (supports all of the Palm OS USB devices)
4 *
5 * Copyright (C) 1999 - 2004
6 * Greg Kroah-Hartman (greg@kroah.com)
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
11 *
12 * See Documentation/usb/usb-serial.txt for more information on using this
13 * driver
14 *
15 */
16
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/spinlock.h>
27 #include <linux/uaccess.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
30 #include "visor.h"
31
32 /*
33 * Version Information
34 */
35 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
36 #define DRIVER_DESC "USB HandSpring Visor / Palm OS driver"
37
38 /* function prototypes for a handspring visor */
39 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port,
40 struct file *filp);
41 static void visor_close(struct usb_serial_port *port);
42 static int visor_write(struct tty_struct *tty, struct usb_serial_port *port,
43 const unsigned char *buf, int count);
44 static int visor_write_room(struct tty_struct *tty);
45 static void visor_throttle(struct tty_struct *tty);
46 static void visor_unthrottle(struct tty_struct *tty);
47 static int visor_probe(struct usb_serial *serial,
48 const struct usb_device_id *id);
49 static int visor_calc_num_ports(struct usb_serial *serial);
50 static void visor_shutdown(struct usb_serial *serial);
51 static void visor_write_bulk_callback(struct urb *urb);
52 static void visor_read_bulk_callback(struct urb *urb);
53 static void visor_read_int_callback(struct urb *urb);
54 static int clie_3_5_startup(struct usb_serial *serial);
55 static int treo_attach(struct usb_serial *serial);
56 static int clie_5_attach(struct usb_serial *serial);
57 static int palm_os_3_probe(struct usb_serial *serial,
58 const struct usb_device_id *id);
59 static int palm_os_4_probe(struct usb_serial *serial,
60 const struct usb_device_id *id);
61
62 /* Parameters that may be passed into the module. */
63 static int debug;
64 static __u16 vendor;
65 static __u16 product;
66
67 static struct usb_device_id id_table [] = {
68 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID),
69 .driver_info = (kernel_ulong_t)&palm_os_3_probe },
70 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID),
71 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
72 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID),
73 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
74 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID),
75 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
76 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID),
77 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
78 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID),
79 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
80 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID),
81 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
82 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID),
83 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
84 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID),
85 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
86 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID),
87 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
88 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID),
89 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
90 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID),
91 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
92 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650),
93 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
94 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID),
95 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
96 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID),
97 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
98 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID),
99 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
100 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID),
101 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
102 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID),
103 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
104 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID),
105 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
106 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID),
107 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
108 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID),
109 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
110 { USB_DEVICE(ACER_VENDOR_ID, ACER_S10_ID),
111 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
112 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID),
113 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
114 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID),
115 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
116 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID),
117 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
118 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID),
119 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
120 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID),
121 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
122 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID),
123 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
124 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID),
125 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
126 { }, /* optional parameter entry */
127 { } /* Terminating entry */
128 };
129
130 static struct usb_device_id clie_id_5_table [] = {
131 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID),
132 .driver_info = (kernel_ulong_t)&palm_os_4_probe },
133 { }, /* optional parameter entry */
134 { } /* Terminating entry */
135 };
136
137 static struct usb_device_id clie_id_3_5_table [] = {
138 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
139 { } /* Terminating entry */
140 };
141
142 static struct usb_device_id id_table_combined [] = {
143 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID) },
144 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO_ID) },
145 { USB_DEVICE(HANDSPRING_VENDOR_ID, HANDSPRING_TREO600_ID) },
146 { USB_DEVICE(GSPDA_VENDOR_ID, GSPDA_XPLORE_M68_ID) },
147 { USB_DEVICE(PALM_VENDOR_ID, PALM_M500_ID) },
148 { USB_DEVICE(PALM_VENDOR_ID, PALM_M505_ID) },
149 { USB_DEVICE(PALM_VENDOR_ID, PALM_M515_ID) },
150 { USB_DEVICE(PALM_VENDOR_ID, PALM_I705_ID) },
151 { USB_DEVICE(PALM_VENDOR_ID, PALM_M100_ID) },
152 { USB_DEVICE(PALM_VENDOR_ID, PALM_M125_ID) },
153 { USB_DEVICE(PALM_VENDOR_ID, PALM_M130_ID) },
154 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_T_ID) },
155 { USB_DEVICE(PALM_VENDOR_ID, PALM_TREO_650) },
156 { USB_DEVICE(PALM_VENDOR_ID, PALM_TUNGSTEN_Z_ID) },
157 { USB_DEVICE(PALM_VENDOR_ID, PALM_ZIRE_ID) },
158 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_3_5_ID) },
159 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_0_ID) },
160 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_S360_ID) },
161 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_4_1_ID) },
162 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NX60_ID) },
163 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_NZ90V_ID) },
164 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_UX50_ID) },
165 { USB_DEVICE(SONY_VENDOR_ID, SONY_CLIE_TJ25_ID) },
166 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SCH_I330_ID) },
167 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_SPH_I500_ID) },
168 { USB_DEVICE(TAPWAVE_VENDOR_ID, TAPWAVE_ZODIAC_ID) },
169 { USB_DEVICE(GARMIN_VENDOR_ID, GARMIN_IQUE_3600_ID) },
170 { USB_DEVICE(ACEECA_VENDOR_ID, ACEECA_MEZ1000_ID) },
171 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_7135_ID) },
172 { USB_DEVICE(FOSSIL_VENDOR_ID, FOSSIL_ABACUS_ID) },
173 { }, /* optional parameter entry */
174 { } /* Terminating entry */
175 };
176
177 MODULE_DEVICE_TABLE(usb, id_table_combined);
178
179 static struct usb_driver visor_driver = {
180 .name = "visor",
181 .probe = usb_serial_probe,
182 .disconnect = usb_serial_disconnect,
183 .id_table = id_table_combined,
184 .no_dynamic_id = 1,
185 };
186
187 /* All of the device info needed for the Handspring Visor,
188 and Palm 4.0 devices */
189 static struct usb_serial_driver handspring_device = {
190 .driver = {
191 .owner = THIS_MODULE,
192 .name = "visor",
193 },
194 .description = "Handspring Visor / Palm OS",
195 .usb_driver = &visor_driver,
196 .id_table = id_table,
197 .num_ports = 2,
198 .open = visor_open,
199 .close = visor_close,
200 .throttle = visor_throttle,
201 .unthrottle = visor_unthrottle,
202 .attach = treo_attach,
203 .probe = visor_probe,
204 .calc_num_ports = visor_calc_num_ports,
205 .shutdown = visor_shutdown,
206 .write = visor_write,
207 .write_room = visor_write_room,
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_ports = 2,
223 .open = visor_open,
224 .close = visor_close,
225 .throttle = visor_throttle,
226 .unthrottle = visor_unthrottle,
227 .attach = clie_5_attach,
228 .probe = visor_probe,
229 .calc_num_ports = visor_calc_num_ports,
230 .shutdown = visor_shutdown,
231 .write = visor_write,
232 .write_room = visor_write_room,
233 .write_bulk_callback = visor_write_bulk_callback,
234 .read_bulk_callback = visor_read_bulk_callback,
235 .read_int_callback = visor_read_int_callback,
236 };
237
238 /* device info for the Sony Clie OS version 3.5 */
239 static struct usb_serial_driver clie_3_5_device = {
240 .driver = {
241 .owner = THIS_MODULE,
242 .name = "clie_3.5",
243 },
244 .description = "Sony Clie 3.5",
245 .usb_driver = &visor_driver,
246 .id_table = clie_id_3_5_table,
247 .num_ports = 1,
248 .open = visor_open,
249 .close = visor_close,
250 .throttle = visor_throttle,
251 .unthrottle = visor_unthrottle,
252 .attach = clie_3_5_startup,
253 .write = visor_write,
254 .write_room = visor_write_room,
255 .write_bulk_callback = visor_write_bulk_callback,
256 .read_bulk_callback = visor_read_bulk_callback,
257 };
258
259 struct visor_private {
260 spinlock_t lock;
261 int bytes_in;
262 int bytes_out;
263 int outstanding_urbs;
264 unsigned char throttled;
265 unsigned char actually_throttled;
266 };
267
268 /* number of outstanding urbs to prevent userspace DoS from happening */
269 #define URB_UPPER_LIMIT 42
270
271 static int stats;
272
273 /******************************************************************************
274 * Handspring Visor specific driver functions
275 ******************************************************************************/
276 static int visor_open(struct tty_struct *tty, struct usb_serial_port *port,
277 struct file *filp)
278 {
279 struct usb_serial *serial = port->serial;
280 struct visor_private *priv = usb_get_serial_port_data(port);
281 unsigned long flags;
282 int result = 0;
283
284 dbg("%s - port %d", __func__, port->number);
285
286 if (!port->read_urb) {
287 /* this is needed for some brain dead Sony devices */
288 dev_err(&port->dev, "Device lied about number of ports, please use a lower one.\n");
289 return -ENODEV;
290 }
291
292 spin_lock_irqsave(&priv->lock, flags);
293 priv->bytes_in = 0;
294 priv->bytes_out = 0;
295 priv->throttled = 0;
296 spin_unlock_irqrestore(&priv->lock, flags);
297
298 /* Start reading from the device */
299 usb_fill_bulk_urb(port->read_urb, serial->dev,
300 usb_rcvbulkpipe(serial->dev,
301 port->bulk_in_endpointAddress),
302 port->read_urb->transfer_buffer,
303 port->read_urb->transfer_buffer_length,
304 visor_read_bulk_callback, port);
305 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
306 if (result) {
307 dev_err(&port->dev,
308 "%s - failed submitting read urb, error %d\n",
309 __func__, result);
310 goto exit;
311 }
312
313 if (port->interrupt_in_urb) {
314 dbg("%s - adding interrupt input for treo", __func__);
315 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
316 if (result)
317 dev_err(&port->dev,
318 "%s - failed submitting interrupt urb, error %d\n",
319 __func__, result);
320 }
321 exit:
322 return result;
323 }
324
325
326 static void visor_close(struct usb_serial_port *port)
327 {
328 struct visor_private *priv = usb_get_serial_port_data(port);
329 unsigned char *transfer_buffer;
330
331 dbg("%s - port %d", __func__, port->number);
332
333 /* shutdown our urbs */
334 usb_kill_urb(port->read_urb);
335 usb_kill_urb(port->interrupt_in_urb);
336
337 mutex_lock(&port->serial->disc_mutex);
338 if (!port->serial->disconnected) {
339 /* Try to send shutdown message, unless the device is gone */
340 transfer_buffer = kmalloc(0x12, GFP_KERNEL);
341 if (transfer_buffer) {
342 usb_control_msg(port->serial->dev,
343 usb_rcvctrlpipe(port->serial->dev, 0),
344 VISOR_CLOSE_NOTIFICATION, 0xc2,
345 0x0000, 0x0000,
346 transfer_buffer, 0x12, 300);
347 kfree(transfer_buffer);
348 }
349 }
350 mutex_unlock(&port->serial->disc_mutex);
351
352 if (stats)
353 dev_info(&port->dev, "Bytes In = %d Bytes Out = %d\n",
354 priv->bytes_in, priv->bytes_out);
355 }
356
357
358 static int visor_write(struct tty_struct *tty, struct usb_serial_port *port,
359 const unsigned char *buf, int count)
360 {
361 struct visor_private *priv = usb_get_serial_port_data(port);
362 struct usb_serial *serial = port->serial;
363 struct urb *urb;
364 unsigned char *buffer;
365 unsigned long flags;
366 int status;
367
368 dbg("%s - port %d", __func__, port->number);
369
370 spin_lock_irqsave(&priv->lock, flags);
371 if (priv->outstanding_urbs > URB_UPPER_LIMIT) {
372 spin_unlock_irqrestore(&priv->lock, flags);
373 dbg("%s - write limit hit\n", __func__);
374 return 0;
375 }
376 priv->outstanding_urbs++;
377 spin_unlock_irqrestore(&priv->lock, flags);
378
379 buffer = kmalloc(count, GFP_ATOMIC);
380 if (!buffer) {
381 dev_err(&port->dev, "out of memory\n");
382 count = -ENOMEM;
383 goto error_no_buffer;
384 }
385
386 urb = usb_alloc_urb(0, GFP_ATOMIC);
387 if (!urb) {
388 dev_err(&port->dev, "no more free urbs\n");
389 count = -ENOMEM;
390 goto error_no_urb;
391 }
392
393 memcpy(buffer, buf, count);
394
395 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
396
397 usb_fill_bulk_urb(urb, serial->dev,
398 usb_sndbulkpipe(serial->dev,
399 port->bulk_out_endpointAddress),
400 buffer, count,
401 visor_write_bulk_callback, port);
402
403 /* send it down the pipe */
404 status = usb_submit_urb(urb, GFP_ATOMIC);
405 if (status) {
406 dev_err(&port->dev,
407 "%s - usb_submit_urb(write bulk) failed with status = %d\n",
408 __func__, status);
409 count = status;
410 goto error;
411 } else {
412 spin_lock_irqsave(&priv->lock, flags);
413 priv->bytes_out += count;
414 spin_unlock_irqrestore(&priv->lock, flags);
415 }
416
417 /* we are done with this urb, so let the host driver
418 * really free it when it is finished with it */
419 usb_free_urb(urb);
420
421 return count;
422 error:
423 usb_free_urb(urb);
424 error_no_urb:
425 kfree(buffer);
426 error_no_buffer:
427 spin_lock_irqsave(&priv->lock, flags);
428 --priv->outstanding_urbs;
429 spin_unlock_irqrestore(&priv->lock, flags);
430 return count;
431 }
432
433
434 static int visor_write_room(struct tty_struct *tty)
435 {
436 struct usb_serial_port *port = tty->driver_data;
437 struct visor_private *priv = usb_get_serial_port_data(port);
438 unsigned long flags;
439
440 dbg("%s - port %d", __func__, 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", __func__);
452 return 0;
453 }
454 spin_unlock_irqrestore(&priv->lock, flags);
455
456 return 2048;
457 }
458
459
460 static void visor_write_bulk_callback(struct urb *urb)
461 {
462 struct usb_serial_port *port = urb->context;
463 struct visor_private *priv = usb_get_serial_port_data(port);
464 int status = urb->status;
465 unsigned long flags;
466
467 /* free up the transfer buffer, as usb_free_urb() does not do this */
468 kfree(urb->transfer_buffer);
469
470 dbg("%s - port %d", __func__, port->number);
471
472 if (status)
473 dbg("%s - nonzero write bulk status received: %d",
474 __func__, status);
475
476 spin_lock_irqsave(&priv->lock, flags);
477 --priv->outstanding_urbs;
478 spin_unlock_irqrestore(&priv->lock, flags);
479
480 usb_serial_port_softint(port);
481 }
482
483
484 static void visor_read_bulk_callback(struct urb *urb)
485 {
486 struct usb_serial_port *port = urb->context;
487 struct visor_private *priv = usb_get_serial_port_data(port);
488 unsigned char *data = urb->transfer_buffer;
489 int status = urb->status;
490 struct tty_struct *tty;
491 int result;
492 int available_room = 0;
493
494 dbg("%s - port %d", __func__, port->number);
495
496 if (status) {
497 dbg("%s - nonzero read bulk status received: %d",
498 __func__, status);
499 return;
500 }
501
502 usb_serial_debug_data(debug, &port->dev, __func__,
503 urb->actual_length, data);
504
505 if (urb->actual_length) {
506 tty = tty_port_tty_get(&port->port);
507 if (tty) {
508 available_room = tty_buffer_request_room(tty,
509 urb->actual_length);
510 if (available_room) {
511 tty_insert_flip_string(tty, data,
512 available_room);
513 tty_flip_buffer_push(tty);
514 }
515 tty_kref_put(tty);
516 }
517 spin_lock(&priv->lock);
518 priv->bytes_in += available_room;
519
520 } else {
521 spin_lock(&priv->lock);
522 }
523
524 /* Continue trying to always read if we should */
525 if (!priv->throttled) {
526 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
527 usb_rcvbulkpipe(port->serial->dev,
528 port->bulk_in_endpointAddress),
529 port->read_urb->transfer_buffer,
530 port->read_urb->transfer_buffer_length,
531 visor_read_bulk_callback, port);
532 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
533 if (result)
534 dev_err(&port->dev,
535 "%s - failed resubmitting read urb, error %d\n",
536 __func__, result);
537 } else
538 priv->actually_throttled = 1;
539 spin_unlock(&priv->lock);
540 }
541
542 static void visor_read_int_callback(struct urb *urb)
543 {
544 struct usb_serial_port *port = urb->context;
545 int status = urb->status;
546 int result;
547
548 switch (status) {
549 case 0:
550 /* success */
551 break;
552 case -ECONNRESET:
553 case -ENOENT:
554 case -ESHUTDOWN:
555 /* this urb is terminated, clean up */
556 dbg("%s - urb shutting down with status: %d",
557 __func__, status);
558 return;
559 default:
560 dbg("%s - nonzero urb status received: %d",
561 __func__, status);
562 goto exit;
563 }
564
565 /*
566 * This information is still unknown what it can be used for.
567 * If anyone has an idea, please let the author know...
568 *
569 * Rumor has it this endpoint is used to notify when data
570 * is ready to be read from the bulk ones.
571 */
572 usb_serial_debug_data(debug, &port->dev, __func__,
573 urb->actual_length, urb->transfer_buffer);
574
575 exit:
576 result = usb_submit_urb(urb, GFP_ATOMIC);
577 if (result)
578 dev_err(&urb->dev->dev,
579 "%s - Error %d submitting interrupt urb\n",
580 __func__, result);
581 }
582
583 static void visor_throttle(struct tty_struct *tty)
584 {
585 struct usb_serial_port *port = tty->driver_data;
586 struct visor_private *priv = usb_get_serial_port_data(port);
587 unsigned long flags;
588
589 dbg("%s - port %d", __func__, port->number);
590 spin_lock_irqsave(&priv->lock, flags);
591 priv->throttled = 1;
592 spin_unlock_irqrestore(&priv->lock, flags);
593 }
594
595
596 static void visor_unthrottle(struct tty_struct *tty)
597 {
598 struct usb_serial_port *port = tty->driver_data;
599 struct visor_private *priv = usb_get_serial_port_data(port);
600 unsigned long flags;
601 int result;
602
603 dbg("%s - port %d", __func__, port->number);
604 spin_lock_irqsave(&priv->lock, flags);
605 priv->throttled = 0;
606 priv->actually_throttled = 0;
607 spin_unlock_irqrestore(&priv->lock, flags);
608
609 port->read_urb->dev = port->serial->dev;
610 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
611 if (result)
612 dev_err(&port->dev,
613 "%s - failed submitting read urb, error %d\n",
614 __func__, result);
615 }
616
617 static int palm_os_3_probe(struct usb_serial *serial,
618 const struct usb_device_id *id)
619 {
620 struct device *dev = &serial->dev->dev;
621 struct visor_connection_info *connection_info;
622 unsigned char *transfer_buffer;
623 char *string;
624 int retval = 0;
625 int i;
626 int num_ports = 0;
627
628 dbg("%s", __func__);
629
630 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
631 if (!transfer_buffer) {
632 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
633 sizeof(*connection_info));
634 return -ENOMEM;
635 }
636
637 /* send a get connection info request */
638 retval = usb_control_msg(serial->dev,
639 usb_rcvctrlpipe(serial->dev, 0),
640 VISOR_GET_CONNECTION_INFORMATION,
641 0xc2, 0x0000, 0x0000, transfer_buffer,
642 sizeof(*connection_info), 300);
643 if (retval < 0) {
644 dev_err(dev, "%s - error %d getting connection information\n",
645 __func__, retval);
646 goto exit;
647 }
648
649 if (retval == sizeof(*connection_info)) {
650 connection_info = (struct visor_connection_info *)
651 transfer_buffer;
652
653 num_ports = le16_to_cpu(connection_info->num_ports);
654 for (i = 0; i < num_ports; ++i) {
655 switch (
656 connection_info->connections[i].port_function_id) {
657 case VISOR_FUNCTION_GENERIC:
658 string = "Generic";
659 break;
660 case VISOR_FUNCTION_DEBUGGER:
661 string = "Debugger";
662 break;
663 case VISOR_FUNCTION_HOTSYNC:
664 string = "HotSync";
665 break;
666 case VISOR_FUNCTION_CONSOLE:
667 string = "Console";
668 break;
669 case VISOR_FUNCTION_REMOTE_FILE_SYS:
670 string = "Remote File System";
671 break;
672 default:
673 string = "unknown";
674 break;
675 }
676 dev_info(dev, "%s: port %d, is for %s use\n",
677 serial->type->description,
678 connection_info->connections[i].port, string);
679 }
680 }
681 /*
682 * Handle devices that report invalid stuff here.
683 */
684 if (num_ports == 0 || num_ports > 2) {
685 dev_warn(dev, "%s: No valid connect info available\n",
686 serial->type->description);
687 num_ports = 2;
688 }
689
690 dev_info(dev, "%s: Number of ports: %d\n", serial->type->description,
691 num_ports);
692
693 /*
694 * save off our num_ports info so that we can use it in the
695 * calc_num_ports callback
696 */
697 usb_set_serial_data(serial, (void *)(long)num_ports);
698
699 /* ask for the number of bytes available, but ignore the
700 response as it is broken */
701 retval = usb_control_msg(serial->dev,
702 usb_rcvctrlpipe(serial->dev, 0),
703 VISOR_REQUEST_BYTES_AVAILABLE,
704 0xc2, 0x0000, 0x0005, transfer_buffer,
705 0x02, 300);
706 if (retval < 0)
707 dev_err(dev, "%s - error %d getting bytes available request\n",
708 __func__, retval);
709 retval = 0;
710
711 exit:
712 kfree(transfer_buffer);
713
714 return retval;
715 }
716
717 static int palm_os_4_probe(struct usb_serial *serial,
718 const struct usb_device_id *id)
719 {
720 struct device *dev = &serial->dev->dev;
721 struct palm_ext_connection_info *connection_info;
722 unsigned char *transfer_buffer;
723 int retval;
724
725 dbg("%s", __func__);
726
727 transfer_buffer = kmalloc(sizeof(*connection_info), GFP_KERNEL);
728 if (!transfer_buffer) {
729 dev_err(dev, "%s - kmalloc(%Zd) failed.\n", __func__,
730 sizeof(*connection_info));
731 return -ENOMEM;
732 }
733
734 retval = usb_control_msg(serial->dev,
735 usb_rcvctrlpipe(serial->dev, 0),
736 PALM_GET_EXT_CONNECTION_INFORMATION,
737 0xc2, 0x0000, 0x0000, transfer_buffer,
738 sizeof(*connection_info), 300);
739 if (retval < 0)
740 dev_err(dev, "%s - error %d getting connection info\n",
741 __func__, retval);
742 else
743 usb_serial_debug_data(debug, &serial->dev->dev, __func__,
744 retval, transfer_buffer);
745
746 kfree(transfer_buffer);
747 return 0;
748 }
749
750
751 static int visor_probe(struct usb_serial *serial,
752 const struct usb_device_id *id)
753 {
754 int retval = 0;
755 int (*startup)(struct usb_serial *serial,
756 const struct usb_device_id *id);
757
758 dbg("%s", __func__);
759
760 if (serial->dev->actconfig->desc.bConfigurationValue != 1) {
761 dev_err(&serial->dev->dev, "active config #%d != 1 ??\n",
762 serial->dev->actconfig->desc.bConfigurationValue);
763 return -ENODEV;
764 }
765
766 if (id->driver_info) {
767 startup = (void *)id->driver_info;
768 retval = startup(serial, id);
769 }
770
771 return retval;
772 }
773
774 static int visor_calc_num_ports(struct usb_serial *serial)
775 {
776 int num_ports = (int)(long)(usb_get_serial_data(serial));
777
778 if (num_ports)
779 usb_set_serial_data(serial, NULL);
780
781 return num_ports;
782 }
783
784 static int generic_startup(struct usb_serial *serial)
785 {
786 struct usb_serial_port **ports = serial->port;
787 struct visor_private *priv;
788 int i;
789
790 for (i = 0; i < serial->num_ports; ++i) {
791 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
792 if (!priv) {
793 while (i-- != 0) {
794 priv = usb_get_serial_port_data(ports[i]);
795 usb_set_serial_port_data(ports[i], NULL);
796 kfree(priv);
797 }
798 return -ENOMEM;
799 }
800 spin_lock_init(&priv->lock);
801 usb_set_serial_port_data(ports[i], priv);
802 }
803 return 0;
804 }
805
806 static int clie_3_5_startup(struct usb_serial *serial)
807 {
808 struct device *dev = &serial->dev->dev;
809 int result;
810 u8 data;
811
812 dbg("%s", __func__);
813
814 /*
815 * Note that PEG-300 series devices expect the following two calls.
816 */
817
818 /* get the config number */
819 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
820 USB_REQ_GET_CONFIGURATION, USB_DIR_IN,
821 0, 0, &data, 1, 3000);
822 if (result < 0) {
823 dev_err(dev, "%s: get config number failed: %d\n",
824 __func__, result);
825 return result;
826 }
827 if (result != 1) {
828 dev_err(dev, "%s: get config number bad return length: %d\n",
829 __func__, result);
830 return -EIO;
831 }
832
833 /* get the interface number */
834 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
835 USB_REQ_GET_INTERFACE,
836 USB_DIR_IN | USB_RECIP_INTERFACE,
837 0, 0, &data, 1, 3000);
838 if (result < 0) {
839 dev_err(dev, "%s: get interface number failed: %d\n",
840 __func__, result);
841 return result;
842 }
843 if (result != 1) {
844 dev_err(dev,
845 "%s: get interface number bad return length: %d\n",
846 __func__, result);
847 return -EIO;
848 }
849
850 return generic_startup(serial);
851 }
852
853 static int treo_attach(struct usb_serial *serial)
854 {
855 struct usb_serial_port *swap_port;
856
857 /* Only do this endpoint hack for the Handspring devices with
858 * interrupt in endpoints, which for now are the Treo devices. */
859 if (!((le16_to_cpu(serial->dev->descriptor.idVendor)
860 == HANDSPRING_VENDOR_ID) ||
861 (le16_to_cpu(serial->dev->descriptor.idVendor)
862 == KYOCERA_VENDOR_ID)) ||
863 (serial->num_interrupt_in == 0))
864 goto generic_startup;
865
866 dbg("%s", __func__);
867
868 /*
869 * It appears that Treos and Kyoceras want to use the
870 * 1st bulk in endpoint to communicate with the 2nd bulk out endpoint,
871 * so let's swap the 1st and 2nd bulk in and interrupt endpoints.
872 * Note that swapping the bulk out endpoints would break lots of
873 * apps that want to communicate on the second port.
874 */
875 #define COPY_PORT(dest, src) \
876 do { \
877 dest->read_urb = src->read_urb; \
878 dest->bulk_in_endpointAddress = src->bulk_in_endpointAddress;\
879 dest->bulk_in_buffer = src->bulk_in_buffer; \
880 dest->interrupt_in_urb = src->interrupt_in_urb; \
881 dest->interrupt_in_endpointAddress = \
882 src->interrupt_in_endpointAddress;\
883 dest->interrupt_in_buffer = src->interrupt_in_buffer; \
884 } while (0);
885
886 swap_port = kmalloc(sizeof(*swap_port), GFP_KERNEL);
887 if (!swap_port)
888 return -ENOMEM;
889 COPY_PORT(swap_port, serial->port[0]);
890 COPY_PORT(serial->port[0], serial->port[1]);
891 COPY_PORT(serial->port[1], swap_port);
892 kfree(swap_port);
893
894 generic_startup:
895 return generic_startup(serial);
896 }
897
898 static int clie_5_attach(struct usb_serial *serial)
899 {
900 dbg("%s", __func__);
901
902 /* TH55 registers 2 ports.
903 Communication in from the UX50/TH55 uses bulk_in_endpointAddress
904 from port 0. Communication out to the UX50/TH55 uses
905 bulk_out_endpointAddress from port 1
906
907 Lets do a quick and dirty mapping
908 */
909
910 /* some sanity check */
911 if (serial->num_ports < 2)
912 return -1;
913
914 /* port 0 now uses the modified endpoint Address */
915 serial->port[0]->bulk_out_endpointAddress =
916 serial->port[1]->bulk_out_endpointAddress;
917
918 return generic_startup(serial);
919 }
920
921 static void visor_shutdown(struct usb_serial *serial)
922 {
923 struct visor_private *priv;
924 int i;
925
926 dbg("%s", __func__);
927
928 for (i = 0; i < serial->num_ports; i++) {
929 priv = usb_get_serial_port_data(serial->port[i]);
930 if (priv) {
931 usb_set_serial_port_data(serial->port[i], NULL);
932 kfree(priv);
933 }
934 }
935 }
936
937 static int __init visor_init(void)
938 {
939 int i, retval;
940 /* Only if parameters were passed to us */
941 if (vendor > 0 && product > 0) {
942 struct usb_device_id usb_dev_temp[] = {
943 {
944 USB_DEVICE(vendor, product),
945 .driver_info =
946 (kernel_ulong_t) &palm_os_4_probe
947 }
948 };
949
950 /* Find the last entry in id_table */
951 for (i = 0;; i++) {
952 if (id_table[i].idVendor == 0) {
953 id_table[i] = usb_dev_temp[0];
954 break;
955 }
956 }
957 /* Find the last entry in id_table_combined */
958 for (i = 0;; i++) {
959 if (id_table_combined[i].idVendor == 0) {
960 id_table_combined[i] = usb_dev_temp[0];
961 break;
962 }
963 }
964 printk(KERN_INFO KBUILD_MODNAME
965 ": Untested USB device specified at time of module insertion\n");
966 printk(KERN_INFO KBUILD_MODNAME
967 ": Warning: This is not guaranteed to work\n");
968 printk(KERN_INFO KBUILD_MODNAME
969 ": Using a newer kernel is preferred to this method\n");
970 printk(KERN_INFO KBUILD_MODNAME
971 ": Adding Palm OS protocol 4.x support for unknown device: 0x%x/0x%x\n",
972 vendor, product);
973 }
974 retval = usb_serial_register(&handspring_device);
975 if (retval)
976 goto failed_handspring_register;
977 retval = usb_serial_register(&clie_3_5_device);
978 if (retval)
979 goto failed_clie_3_5_register;
980 retval = usb_serial_register(&clie_5_device);
981 if (retval)
982 goto failed_clie_5_register;
983 retval = usb_register(&visor_driver);
984 if (retval)
985 goto failed_usb_register;
986 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
987
988 return 0;
989 failed_usb_register:
990 usb_serial_deregister(&clie_5_device);
991 failed_clie_5_register:
992 usb_serial_deregister(&clie_3_5_device);
993 failed_clie_3_5_register:
994 usb_serial_deregister(&handspring_device);
995 failed_handspring_register:
996 return retval;
997 }
998
999
1000 static void __exit visor_exit (void)
1001 {
1002 usb_deregister(&visor_driver);
1003 usb_serial_deregister(&handspring_device);
1004 usb_serial_deregister(&clie_3_5_device);
1005 usb_serial_deregister(&clie_5_device);
1006 }
1007
1008
1009 module_init(visor_init);
1010 module_exit(visor_exit);
1011
1012 MODULE_AUTHOR(DRIVER_AUTHOR);
1013 MODULE_DESCRIPTION(DRIVER_DESC);
1014 MODULE_LICENSE("GPL");
1015
1016 module_param(debug, bool, S_IRUGO | S_IWUSR);
1017 MODULE_PARM_DESC(debug, "Debug enabled or not");
1018 module_param(stats, bool, S_IRUGO | S_IWUSR);
1019 MODULE_PARM_DESC(stats, "Enables statistics or not");
1020
1021 module_param(vendor, ushort, 0);
1022 MODULE_PARM_DESC(vendor, "User specified vendor ID");
1023 module_param(product, ushort, 0);
1024 MODULE_PARM_DESC(product, "User specified product ID");
1025
x86 "subsystem" repository