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