Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris...
[linux/fpc-iii.git] / drivers / input / gameport / gameport.c
blob24c41ba7d4e01dcf852050d3f1d8ef27b5f0a22f
1 /*
2 * Generic gameport layer
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 * Copyright (c) 2005 Dmitry Torokhov
6 */
8 /*
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License version 2 as published by
11 * the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/stddef.h>
17 #include <linux/module.h>
18 #include <linux/ioport.h>
19 #include <linux/init.h>
20 #include <linux/gameport.h>
21 #include <linux/slab.h>
22 #include <linux/delay.h>
23 #include <linux/workqueue.h>
24 #include <linux/sched.h> /* HZ */
25 #include <linux/mutex.h>
27 /*#include <asm/io.h>*/
29 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
30 MODULE_DESCRIPTION("Generic gameport layer");
31 MODULE_LICENSE("GPL");
34 * gameport_mutex protects entire gameport subsystem and is taken
35 * every time gameport port or driver registrered or unregistered.
37 static DEFINE_MUTEX(gameport_mutex);
39 static LIST_HEAD(gameport_list);
41 static struct bus_type gameport_bus;
43 static void gameport_add_port(struct gameport *gameport);
44 static void gameport_attach_driver(struct gameport_driver *drv);
45 static void gameport_reconnect_port(struct gameport *gameport);
46 static void gameport_disconnect_port(struct gameport *gameport);
48 #if defined(__i386__)
50 #include <linux/i8253.h>
52 #define DELTA(x,y) ((y)-(x)+((y)<(x)?1193182/HZ:0))
53 #define GET_TIME(x) do { x = get_time_pit(); } while (0)
55 static unsigned int get_time_pit(void)
57 unsigned long flags;
58 unsigned int count;
60 raw_spin_lock_irqsave(&i8253_lock, flags);
61 outb_p(0x00, 0x43);
62 count = inb_p(0x40);
63 count |= inb_p(0x40) << 8;
64 raw_spin_unlock_irqrestore(&i8253_lock, flags);
66 return count;
69 #endif
74 * gameport_measure_speed() measures the gameport i/o speed.
77 static int gameport_measure_speed(struct gameport *gameport)
79 #if defined(__i386__)
81 unsigned int i, t, t1, t2, t3, tx;
82 unsigned long flags;
84 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
85 return 0;
87 tx = 1 << 30;
89 for(i = 0; i < 50; i++) {
90 local_irq_save(flags);
91 GET_TIME(t1);
92 for (t = 0; t < 50; t++) gameport_read(gameport);
93 GET_TIME(t2);
94 GET_TIME(t3);
95 local_irq_restore(flags);
96 udelay(i * 10);
97 if ((t = DELTA(t2,t1) - DELTA(t3,t2)) < tx) tx = t;
100 gameport_close(gameport);
101 return 59659 / (tx < 1 ? 1 : tx);
103 #elif defined (__x86_64__)
105 unsigned int i, t;
106 unsigned long tx, t1, t2, flags;
108 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
109 return 0;
111 tx = 1 << 30;
113 for(i = 0; i < 50; i++) {
114 local_irq_save(flags);
115 rdtscl(t1);
116 for (t = 0; t < 50; t++) gameport_read(gameport);
117 rdtscl(t2);
118 local_irq_restore(flags);
119 udelay(i * 10);
120 if (t2 - t1 < tx) tx = t2 - t1;
123 gameport_close(gameport);
124 return (this_cpu_read(cpu_info.loops_per_jiffy) *
125 (unsigned long)HZ / (1000 / 50)) / (tx < 1 ? 1 : tx);
127 #else
129 unsigned int j, t = 0;
131 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
132 return 0;
134 j = jiffies; while (j == jiffies);
135 j = jiffies; while (j == jiffies) { t++; gameport_read(gameport); }
137 gameport_close(gameport);
138 return t * HZ / 1000;
140 #endif
143 void gameport_start_polling(struct gameport *gameport)
145 spin_lock(&gameport->timer_lock);
147 if (!gameport->poll_cnt++) {
148 BUG_ON(!gameport->poll_handler);
149 BUG_ON(!gameport->poll_interval);
150 mod_timer(&gameport->poll_timer, jiffies + msecs_to_jiffies(gameport->poll_interval));
153 spin_unlock(&gameport->timer_lock);
155 EXPORT_SYMBOL(gameport_start_polling);
157 void gameport_stop_polling(struct gameport *gameport)
159 spin_lock(&gameport->timer_lock);
161 if (!--gameport->poll_cnt)
162 del_timer(&gameport->poll_timer);
164 spin_unlock(&gameport->timer_lock);
166 EXPORT_SYMBOL(gameport_stop_polling);
168 static void gameport_run_poll_handler(unsigned long d)
170 struct gameport *gameport = (struct gameport *)d;
172 gameport->poll_handler(gameport);
173 if (gameport->poll_cnt)
174 mod_timer(&gameport->poll_timer, jiffies + msecs_to_jiffies(gameport->poll_interval));
178 * Basic gameport -> driver core mappings
181 static int gameport_bind_driver(struct gameport *gameport, struct gameport_driver *drv)
183 int error;
185 gameport->dev.driver = &drv->driver;
186 if (drv->connect(gameport, drv)) {
187 gameport->dev.driver = NULL;
188 return -ENODEV;
191 error = device_bind_driver(&gameport->dev);
192 if (error) {
193 dev_warn(&gameport->dev,
194 "device_bind_driver() failed for %s (%s) and %s, error: %d\n",
195 gameport->phys, gameport->name,
196 drv->description, error);
197 drv->disconnect(gameport);
198 gameport->dev.driver = NULL;
199 return error;
202 return 0;
205 static void gameport_find_driver(struct gameport *gameport)
207 int error;
209 error = device_attach(&gameport->dev);
210 if (error < 0)
211 dev_warn(&gameport->dev,
212 "device_attach() failed for %s (%s), error: %d\n",
213 gameport->phys, gameport->name, error);
218 * Gameport event processing.
221 enum gameport_event_type {
222 GAMEPORT_REGISTER_PORT,
223 GAMEPORT_ATTACH_DRIVER,
226 struct gameport_event {
227 enum gameport_event_type type;
228 void *object;
229 struct module *owner;
230 struct list_head node;
233 static DEFINE_SPINLOCK(gameport_event_lock); /* protects gameport_event_list */
234 static LIST_HEAD(gameport_event_list);
236 static struct gameport_event *gameport_get_event(void)
238 struct gameport_event *event = NULL;
239 unsigned long flags;
241 spin_lock_irqsave(&gameport_event_lock, flags);
243 if (!list_empty(&gameport_event_list)) {
244 event = list_first_entry(&gameport_event_list,
245 struct gameport_event, node);
246 list_del_init(&event->node);
249 spin_unlock_irqrestore(&gameport_event_lock, flags);
250 return event;
253 static void gameport_free_event(struct gameport_event *event)
255 module_put(event->owner);
256 kfree(event);
259 static void gameport_remove_duplicate_events(struct gameport_event *event)
261 struct gameport_event *e, *next;
262 unsigned long flags;
264 spin_lock_irqsave(&gameport_event_lock, flags);
266 list_for_each_entry_safe(e, next, &gameport_event_list, node) {
267 if (event->object == e->object) {
269 * If this event is of different type we should not
270 * look further - we only suppress duplicate events
271 * that were sent back-to-back.
273 if (event->type != e->type)
274 break;
276 list_del_init(&e->node);
277 gameport_free_event(e);
281 spin_unlock_irqrestore(&gameport_event_lock, flags);
285 static void gameport_handle_events(struct work_struct *work)
287 struct gameport_event *event;
289 mutex_lock(&gameport_mutex);
292 * Note that we handle only one event here to give swsusp
293 * a chance to freeze kgameportd thread. Gameport events
294 * should be pretty rare so we are not concerned about
295 * taking performance hit.
297 if ((event = gameport_get_event())) {
299 switch (event->type) {
301 case GAMEPORT_REGISTER_PORT:
302 gameport_add_port(event->object);
303 break;
305 case GAMEPORT_ATTACH_DRIVER:
306 gameport_attach_driver(event->object);
307 break;
310 gameport_remove_duplicate_events(event);
311 gameport_free_event(event);
314 mutex_unlock(&gameport_mutex);
317 static DECLARE_WORK(gameport_event_work, gameport_handle_events);
319 static int gameport_queue_event(void *object, struct module *owner,
320 enum gameport_event_type event_type)
322 unsigned long flags;
323 struct gameport_event *event;
324 int retval = 0;
326 spin_lock_irqsave(&gameport_event_lock, flags);
329 * Scan event list for the other events for the same gameport port,
330 * starting with the most recent one. If event is the same we
331 * do not need add new one. If event is of different type we
332 * need to add this event and should not look further because
333 * we need to preserve sequence of distinct events.
335 list_for_each_entry_reverse(event, &gameport_event_list, node) {
336 if (event->object == object) {
337 if (event->type == event_type)
338 goto out;
339 break;
343 event = kmalloc(sizeof(struct gameport_event), GFP_ATOMIC);
344 if (!event) {
345 pr_err("Not enough memory to queue event %d\n", event_type);
346 retval = -ENOMEM;
347 goto out;
350 if (!try_module_get(owner)) {
351 pr_warning("Can't get module reference, dropping event %d\n",
352 event_type);
353 kfree(event);
354 retval = -EINVAL;
355 goto out;
358 event->type = event_type;
359 event->object = object;
360 event->owner = owner;
362 list_add_tail(&event->node, &gameport_event_list);
363 queue_work(system_long_wq, &gameport_event_work);
365 out:
366 spin_unlock_irqrestore(&gameport_event_lock, flags);
367 return retval;
371 * Remove all events that have been submitted for a given object,
372 * be it a gameport port or a driver.
374 static void gameport_remove_pending_events(void *object)
376 struct gameport_event *event, *next;
377 unsigned long flags;
379 spin_lock_irqsave(&gameport_event_lock, flags);
381 list_for_each_entry_safe(event, next, &gameport_event_list, node) {
382 if (event->object == object) {
383 list_del_init(&event->node);
384 gameport_free_event(event);
388 spin_unlock_irqrestore(&gameport_event_lock, flags);
392 * Destroy child gameport port (if any) that has not been fully registered yet.
394 * Note that we rely on the fact that port can have only one child and therefore
395 * only one child registration request can be pending. Additionally, children
396 * are registered by driver's connect() handler so there can't be a grandchild
397 * pending registration together with a child.
399 static struct gameport *gameport_get_pending_child(struct gameport *parent)
401 struct gameport_event *event;
402 struct gameport *gameport, *child = NULL;
403 unsigned long flags;
405 spin_lock_irqsave(&gameport_event_lock, flags);
407 list_for_each_entry(event, &gameport_event_list, node) {
408 if (event->type == GAMEPORT_REGISTER_PORT) {
409 gameport = event->object;
410 if (gameport->parent == parent) {
411 child = gameport;
412 break;
417 spin_unlock_irqrestore(&gameport_event_lock, flags);
418 return child;
422 * Gameport port operations
425 static ssize_t gameport_description_show(struct device *dev, struct device_attribute *attr, char *buf)
427 struct gameport *gameport = to_gameport_port(dev);
429 return sprintf(buf, "%s\n", gameport->name);
431 static DEVICE_ATTR(description, S_IRUGO, gameport_description_show, NULL);
433 static ssize_t drvctl_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
435 struct gameport *gameport = to_gameport_port(dev);
436 struct device_driver *drv;
437 int error;
439 error = mutex_lock_interruptible(&gameport_mutex);
440 if (error)
441 return error;
443 if (!strncmp(buf, "none", count)) {
444 gameport_disconnect_port(gameport);
445 } else if (!strncmp(buf, "reconnect", count)) {
446 gameport_reconnect_port(gameport);
447 } else if (!strncmp(buf, "rescan", count)) {
448 gameport_disconnect_port(gameport);
449 gameport_find_driver(gameport);
450 } else if ((drv = driver_find(buf, &gameport_bus)) != NULL) {
451 gameport_disconnect_port(gameport);
452 error = gameport_bind_driver(gameport, to_gameport_driver(drv));
453 } else {
454 error = -EINVAL;
457 mutex_unlock(&gameport_mutex);
459 return error ? error : count;
461 static DEVICE_ATTR_WO(drvctl);
463 static struct attribute *gameport_device_attrs[] = {
464 &dev_attr_description.attr,
465 &dev_attr_drvctl.attr,
466 NULL,
468 ATTRIBUTE_GROUPS(gameport_device);
470 static void gameport_release_port(struct device *dev)
472 struct gameport *gameport = to_gameport_port(dev);
474 kfree(gameport);
475 module_put(THIS_MODULE);
478 void gameport_set_phys(struct gameport *gameport, const char *fmt, ...)
480 va_list args;
482 va_start(args, fmt);
483 vsnprintf(gameport->phys, sizeof(gameport->phys), fmt, args);
484 va_end(args);
486 EXPORT_SYMBOL(gameport_set_phys);
489 * Prepare gameport port for registration.
491 static void gameport_init_port(struct gameport *gameport)
493 static atomic_t gameport_no = ATOMIC_INIT(0);
495 __module_get(THIS_MODULE);
497 mutex_init(&gameport->drv_mutex);
498 device_initialize(&gameport->dev);
499 dev_set_name(&gameport->dev, "gameport%lu",
500 (unsigned long)atomic_inc_return(&gameport_no) - 1);
501 gameport->dev.bus = &gameport_bus;
502 gameport->dev.release = gameport_release_port;
503 if (gameport->parent)
504 gameport->dev.parent = &gameport->parent->dev;
506 INIT_LIST_HEAD(&gameport->node);
507 spin_lock_init(&gameport->timer_lock);
508 init_timer(&gameport->poll_timer);
509 gameport->poll_timer.function = gameport_run_poll_handler;
510 gameport->poll_timer.data = (unsigned long)gameport;
514 * Complete gameport port registration.
515 * Driver core will attempt to find appropriate driver for the port.
517 static void gameport_add_port(struct gameport *gameport)
519 int error;
521 if (gameport->parent)
522 gameport->parent->child = gameport;
524 gameport->speed = gameport_measure_speed(gameport);
526 list_add_tail(&gameport->node, &gameport_list);
528 if (gameport->io)
529 dev_info(&gameport->dev, "%s is %s, io %#x, speed %dkHz\n",
530 gameport->name, gameport->phys, gameport->io, gameport->speed);
531 else
532 dev_info(&gameport->dev, "%s is %s, speed %dkHz\n",
533 gameport->name, gameport->phys, gameport->speed);
535 error = device_add(&gameport->dev);
536 if (error)
537 dev_err(&gameport->dev,
538 "device_add() failed for %s (%s), error: %d\n",
539 gameport->phys, gameport->name, error);
543 * gameport_destroy_port() completes deregistration process and removes
544 * port from the system
546 static void gameport_destroy_port(struct gameport *gameport)
548 struct gameport *child;
550 child = gameport_get_pending_child(gameport);
551 if (child) {
552 gameport_remove_pending_events(child);
553 put_device(&child->dev);
556 if (gameport->parent) {
557 gameport->parent->child = NULL;
558 gameport->parent = NULL;
561 if (device_is_registered(&gameport->dev))
562 device_del(&gameport->dev);
564 list_del_init(&gameport->node);
566 gameport_remove_pending_events(gameport);
567 put_device(&gameport->dev);
571 * Reconnect gameport port and all its children (re-initialize attached devices)
573 static void gameport_reconnect_port(struct gameport *gameport)
575 do {
576 if (!gameport->drv || !gameport->drv->reconnect || gameport->drv->reconnect(gameport)) {
577 gameport_disconnect_port(gameport);
578 gameport_find_driver(gameport);
579 /* Ok, old children are now gone, we are done */
580 break;
582 gameport = gameport->child;
583 } while (gameport);
587 * gameport_disconnect_port() unbinds a port from its driver. As a side effect
588 * all child ports are unbound and destroyed.
590 static void gameport_disconnect_port(struct gameport *gameport)
592 struct gameport *s, *parent;
594 if (gameport->child) {
596 * Children ports should be disconnected and destroyed
597 * first, staring with the leaf one, since we don't want
598 * to do recursion
600 for (s = gameport; s->child; s = s->child)
601 /* empty */;
603 do {
604 parent = s->parent;
606 device_release_driver(&s->dev);
607 gameport_destroy_port(s);
608 } while ((s = parent) != gameport);
612 * Ok, no children left, now disconnect this port
614 device_release_driver(&gameport->dev);
618 * Submits register request to kgameportd for subsequent execution.
619 * Note that port registration is always asynchronous.
621 void __gameport_register_port(struct gameport *gameport, struct module *owner)
623 gameport_init_port(gameport);
624 gameport_queue_event(gameport, owner, GAMEPORT_REGISTER_PORT);
626 EXPORT_SYMBOL(__gameport_register_port);
629 * Synchronously unregisters gameport port.
631 void gameport_unregister_port(struct gameport *gameport)
633 mutex_lock(&gameport_mutex);
634 gameport_disconnect_port(gameport);
635 gameport_destroy_port(gameport);
636 mutex_unlock(&gameport_mutex);
638 EXPORT_SYMBOL(gameport_unregister_port);
642 * Gameport driver operations
645 static ssize_t description_show(struct device_driver *drv, char *buf)
647 struct gameport_driver *driver = to_gameport_driver(drv);
648 return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
650 static DRIVER_ATTR_RO(description);
652 static struct attribute *gameport_driver_attrs[] = {
653 &driver_attr_description.attr,
654 NULL
656 ATTRIBUTE_GROUPS(gameport_driver);
658 static int gameport_driver_probe(struct device *dev)
660 struct gameport *gameport = to_gameport_port(dev);
661 struct gameport_driver *drv = to_gameport_driver(dev->driver);
663 drv->connect(gameport, drv);
664 return gameport->drv ? 0 : -ENODEV;
667 static int gameport_driver_remove(struct device *dev)
669 struct gameport *gameport = to_gameport_port(dev);
670 struct gameport_driver *drv = to_gameport_driver(dev->driver);
672 drv->disconnect(gameport);
673 return 0;
676 static void gameport_attach_driver(struct gameport_driver *drv)
678 int error;
680 error = driver_attach(&drv->driver);
681 if (error)
682 pr_err("driver_attach() failed for %s, error: %d\n",
683 drv->driver.name, error);
686 int __gameport_register_driver(struct gameport_driver *drv, struct module *owner,
687 const char *mod_name)
689 int error;
691 drv->driver.bus = &gameport_bus;
692 drv->driver.owner = owner;
693 drv->driver.mod_name = mod_name;
696 * Temporarily disable automatic binding because probing
697 * takes long time and we are better off doing it in kgameportd
699 drv->ignore = true;
701 error = driver_register(&drv->driver);
702 if (error) {
703 pr_err("driver_register() failed for %s, error: %d\n",
704 drv->driver.name, error);
705 return error;
709 * Reset ignore flag and let kgameportd bind the driver to free ports
711 drv->ignore = false;
712 error = gameport_queue_event(drv, NULL, GAMEPORT_ATTACH_DRIVER);
713 if (error) {
714 driver_unregister(&drv->driver);
715 return error;
718 return 0;
720 EXPORT_SYMBOL(__gameport_register_driver);
722 void gameport_unregister_driver(struct gameport_driver *drv)
724 struct gameport *gameport;
726 mutex_lock(&gameport_mutex);
728 drv->ignore = true; /* so gameport_find_driver ignores it */
729 gameport_remove_pending_events(drv);
731 start_over:
732 list_for_each_entry(gameport, &gameport_list, node) {
733 if (gameport->drv == drv) {
734 gameport_disconnect_port(gameport);
735 gameport_find_driver(gameport);
736 /* we could've deleted some ports, restart */
737 goto start_over;
741 driver_unregister(&drv->driver);
743 mutex_unlock(&gameport_mutex);
745 EXPORT_SYMBOL(gameport_unregister_driver);
747 static int gameport_bus_match(struct device *dev, struct device_driver *drv)
749 struct gameport_driver *gameport_drv = to_gameport_driver(drv);
751 return !gameport_drv->ignore;
754 static struct bus_type gameport_bus = {
755 .name = "gameport",
756 .dev_groups = gameport_device_groups,
757 .drv_groups = gameport_driver_groups,
758 .match = gameport_bus_match,
759 .probe = gameport_driver_probe,
760 .remove = gameport_driver_remove,
763 static void gameport_set_drv(struct gameport *gameport, struct gameport_driver *drv)
765 mutex_lock(&gameport->drv_mutex);
766 gameport->drv = drv;
767 mutex_unlock(&gameport->drv_mutex);
770 int gameport_open(struct gameport *gameport, struct gameport_driver *drv, int mode)
772 if (gameport->open) {
773 if (gameport->open(gameport, mode)) {
774 return -1;
776 } else {
777 if (mode != GAMEPORT_MODE_RAW)
778 return -1;
781 gameport_set_drv(gameport, drv);
782 return 0;
784 EXPORT_SYMBOL(gameport_open);
786 void gameport_close(struct gameport *gameport)
788 del_timer_sync(&gameport->poll_timer);
789 gameport->poll_handler = NULL;
790 gameport->poll_interval = 0;
791 gameport_set_drv(gameport, NULL);
792 if (gameport->close)
793 gameport->close(gameport);
795 EXPORT_SYMBOL(gameport_close);
797 static int __init gameport_init(void)
799 int error;
801 error = bus_register(&gameport_bus);
802 if (error) {
803 pr_err("failed to register gameport bus, error: %d\n", error);
804 return error;
808 return 0;
811 static void __exit gameport_exit(void)
813 bus_unregister(&gameport_bus);
816 * There should not be any outstanding events but work may
817 * still be scheduled so simply cancel it.
819 cancel_work_sync(&gameport_event_work);
822 subsys_initcall(gameport_init);
823 module_exit(gameport_exit);