2 * Generic gameport layer
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 * Copyright (c) 2005 Dmitry Torokhov
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 #include <linux/stddef.h>
15 #include <linux/module.h>
16 #include <linux/ioport.h>
17 #include <linux/init.h>
18 #include <linux/gameport.h>
19 #include <linux/wait.h>
20 #include <linux/sched.h>
21 #include <linux/slab.h>
22 #include <linux/delay.h>
23 #include <linux/kthread.h>
24 #include <linux/sched.h> /* HZ */
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 /*#include <asm/io.h>*/
30 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
31 MODULE_DESCRIPTION("Generic gameport layer");
32 MODULE_LICENSE("GPL");
34 EXPORT_SYMBOL(__gameport_register_port);
35 EXPORT_SYMBOL(gameport_unregister_port);
36 EXPORT_SYMBOL(__gameport_register_driver);
37 EXPORT_SYMBOL(gameport_unregister_driver);
38 EXPORT_SYMBOL(gameport_open);
39 EXPORT_SYMBOL(gameport_close);
40 EXPORT_SYMBOL(gameport_rescan);
41 EXPORT_SYMBOL(gameport_cooked_read);
42 EXPORT_SYMBOL(gameport_set_name);
43 EXPORT_SYMBOL(gameport_set_phys);
44 EXPORT_SYMBOL(gameport_start_polling);
45 EXPORT_SYMBOL(gameport_stop_polling);
48 * gameport_mutex protects entire gameport subsystem and is taken
49 * every time gameport port or driver registrered or unregistered.
51 static DEFINE_MUTEX(gameport_mutex);
53 static LIST_HEAD(gameport_list);
55 static struct bus_type gameport_bus;
57 static void gameport_add_driver(struct gameport_driver *drv);
58 static void gameport_add_port(struct gameport *gameport);
59 static void gameport_destroy_port(struct gameport *gameport);
60 static void gameport_reconnect_port(struct gameport *gameport);
61 static void gameport_disconnect_port(struct gameport *gameport);
65 #include <asm/i8253.h>
67 #define DELTA(x,y) ((y)-(x)+((y)<(x)?1193182/HZ:0))
68 #define GET_TIME(x) do { x = get_time_pit(); } while (0)
70 static unsigned int get_time_pit(void)
75 spin_lock_irqsave(&i8253_lock, flags);
78 count |= inb_p(0x40) << 8;
79 spin_unlock_irqrestore(&i8253_lock, flags);
89 * gameport_measure_speed() measures the gameport i/o speed.
92 static int gameport_measure_speed(struct gameport *gameport)
96 unsigned int i, t, t1, t2, t3, tx;
99 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
104 for(i = 0; i < 50; i++) {
105 local_irq_save(flags);
107 for (t = 0; t < 50; t++) gameport_read(gameport);
110 local_irq_restore(flags);
112 if ((t = DELTA(t2,t1) - DELTA(t3,t2)) < tx) tx = t;
115 gameport_close(gameport);
116 return 59659 / (tx < 1 ? 1 : tx);
118 #elif defined (__x86_64__)
121 unsigned long tx, t1, t2, flags;
123 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
128 for(i = 0; i < 50; i++) {
129 local_irq_save(flags);
131 for (t = 0; t < 50; t++) gameport_read(gameport);
133 local_irq_restore(flags);
135 if (t2 - t1 < tx) tx = t2 - t1;
138 gameport_close(gameport);
139 return (cpu_data[raw_smp_processor_id()].loops_per_jiffy * (unsigned long)HZ / (1000 / 50)) / (tx < 1 ? 1 : tx);
143 unsigned int j, t = 0;
145 if (gameport_open(gameport, NULL, GAMEPORT_MODE_RAW))
148 j = jiffies; while (j == jiffies);
149 j = jiffies; while (j == jiffies) { t++; gameport_read(gameport); }
151 gameport_close(gameport);
152 return t * HZ / 1000;
157 void gameport_start_polling(struct gameport *gameport)
159 spin_lock(&gameport->timer_lock);
161 if (!gameport->poll_cnt++) {
162 BUG_ON(!gameport->poll_handler);
163 BUG_ON(!gameport->poll_interval);
164 mod_timer(&gameport->poll_timer, jiffies + msecs_to_jiffies(gameport->poll_interval));
167 spin_unlock(&gameport->timer_lock);
170 void gameport_stop_polling(struct gameport *gameport)
172 spin_lock(&gameport->timer_lock);
174 if (!--gameport->poll_cnt)
175 del_timer(&gameport->poll_timer);
177 spin_unlock(&gameport->timer_lock);
180 static void gameport_run_poll_handler(unsigned long d)
182 struct gameport *gameport = (struct gameport *)d;
184 gameport->poll_handler(gameport);
185 if (gameport->poll_cnt)
186 mod_timer(&gameport->poll_timer, jiffies + msecs_to_jiffies(gameport->poll_interval));
190 * Basic gameport -> driver core mappings
193 static void gameport_bind_driver(struct gameport *gameport, struct gameport_driver *drv)
197 down_write(&gameport_bus.subsys.rwsem);
199 gameport->dev.driver = &drv->driver;
200 if (drv->connect(gameport, drv)) {
201 gameport->dev.driver = NULL;
205 error = device_bind_driver(&gameport->dev);
208 "gameport: device_bind_driver() failed "
209 "for %s (%s) and %s, error: %d\n",
210 gameport->phys, gameport->name,
211 drv->description, error);
212 drv->disconnect(gameport);
213 gameport->dev.driver = NULL;
218 up_write(&gameport_bus.subsys.rwsem);
221 static void gameport_release_driver(struct gameport *gameport)
223 down_write(&gameport_bus.subsys.rwsem);
224 device_release_driver(&gameport->dev);
225 up_write(&gameport_bus.subsys.rwsem);
228 static void gameport_find_driver(struct gameport *gameport)
232 down_write(&gameport_bus.subsys.rwsem);
233 error = device_attach(&gameport->dev);
236 "gameport: device_attach() failed for %s (%s), error: %d\n",
237 gameport->phys, gameport->name, error);
238 up_write(&gameport_bus.subsys.rwsem);
243 * Gameport event processing.
246 enum gameport_event_type {
249 GAMEPORT_REGISTER_PORT,
250 GAMEPORT_REGISTER_DRIVER,
253 struct gameport_event {
254 enum gameport_event_type type;
256 struct module *owner;
257 struct list_head node;
260 static DEFINE_SPINLOCK(gameport_event_lock); /* protects gameport_event_list */
261 static LIST_HEAD(gameport_event_list);
262 static DECLARE_WAIT_QUEUE_HEAD(gameport_wait);
263 static struct task_struct *gameport_task;
265 static void gameport_queue_event(void *object, struct module *owner,
266 enum gameport_event_type event_type)
269 struct gameport_event *event;
271 spin_lock_irqsave(&gameport_event_lock, flags);
274 * Scan event list for the other events for the same gameport port,
275 * starting with the most recent one. If event is the same we
276 * do not need add new one. If event is of different type we
277 * need to add this event and should not look further because
278 * we need to preseve sequence of distinct events.
280 list_for_each_entry_reverse(event, &gameport_event_list, node) {
281 if (event->object == object) {
282 if (event->type == event_type)
288 if ((event = kmalloc(sizeof(struct gameport_event), GFP_ATOMIC))) {
289 if (!try_module_get(owner)) {
290 printk(KERN_WARNING "gameport: Can't get module reference, dropping event %d\n", event_type);
295 event->type = event_type;
296 event->object = object;
297 event->owner = owner;
299 list_add_tail(&event->node, &gameport_event_list);
300 wake_up(&gameport_wait);
302 printk(KERN_ERR "gameport: Not enough memory to queue event %d\n", event_type);
305 spin_unlock_irqrestore(&gameport_event_lock, flags);
308 static void gameport_free_event(struct gameport_event *event)
310 module_put(event->owner);
314 static void gameport_remove_duplicate_events(struct gameport_event *event)
316 struct list_head *node, *next;
317 struct gameport_event *e;
320 spin_lock_irqsave(&gameport_event_lock, flags);
322 list_for_each_safe(node, next, &gameport_event_list) {
323 e = list_entry(node, struct gameport_event, node);
324 if (event->object == e->object) {
326 * If this event is of different type we should not
327 * look further - we only suppress duplicate events
328 * that were sent back-to-back.
330 if (event->type != e->type)
334 gameport_free_event(e);
338 spin_unlock_irqrestore(&gameport_event_lock, flags);
341 static struct gameport_event *gameport_get_event(void)
343 struct gameport_event *event;
344 struct list_head *node;
347 spin_lock_irqsave(&gameport_event_lock, flags);
349 if (list_empty(&gameport_event_list)) {
350 spin_unlock_irqrestore(&gameport_event_lock, flags);
354 node = gameport_event_list.next;
355 event = list_entry(node, struct gameport_event, node);
358 spin_unlock_irqrestore(&gameport_event_lock, flags);
363 static void gameport_handle_event(void)
365 struct gameport_event *event;
367 mutex_lock(&gameport_mutex);
370 * Note that we handle only one event here to give swsusp
371 * a chance to freeze kgameportd thread. Gameport events
372 * should be pretty rare so we are not concerned about
373 * taking performance hit.
375 if ((event = gameport_get_event())) {
377 switch (event->type) {
378 case GAMEPORT_REGISTER_PORT:
379 gameport_add_port(event->object);
382 case GAMEPORT_RECONNECT:
383 gameport_reconnect_port(event->object);
386 case GAMEPORT_RESCAN:
387 gameport_disconnect_port(event->object);
388 gameport_find_driver(event->object);
391 case GAMEPORT_REGISTER_DRIVER:
392 gameport_add_driver(event->object);
399 gameport_remove_duplicate_events(event);
400 gameport_free_event(event);
403 mutex_unlock(&gameport_mutex);
407 * Remove all events that have been submitted for a given gameport port.
409 static void gameport_remove_pending_events(struct gameport *gameport)
411 struct list_head *node, *next;
412 struct gameport_event *event;
415 spin_lock_irqsave(&gameport_event_lock, flags);
417 list_for_each_safe(node, next, &gameport_event_list) {
418 event = list_entry(node, struct gameport_event, node);
419 if (event->object == gameport) {
421 gameport_free_event(event);
425 spin_unlock_irqrestore(&gameport_event_lock, flags);
429 * Destroy child gameport port (if any) that has not been fully registered yet.
431 * Note that we rely on the fact that port can have only one child and therefore
432 * only one child registration request can be pending. Additionally, children
433 * are registered by driver's connect() handler so there can't be a grandchild
434 * pending registration together with a child.
436 static struct gameport *gameport_get_pending_child(struct gameport *parent)
438 struct gameport_event *event;
439 struct gameport *gameport, *child = NULL;
442 spin_lock_irqsave(&gameport_event_lock, flags);
444 list_for_each_entry(event, &gameport_event_list, node) {
445 if (event->type == GAMEPORT_REGISTER_PORT) {
446 gameport = event->object;
447 if (gameport->parent == parent) {
454 spin_unlock_irqrestore(&gameport_event_lock, flags);
458 static int gameport_thread(void *nothing)
461 gameport_handle_event();
462 wait_event_interruptible(gameport_wait,
463 kthread_should_stop() || !list_empty(&gameport_event_list));
465 } while (!kthread_should_stop());
467 printk(KERN_DEBUG "gameport: kgameportd exiting\n");
473 * Gameport port operations
476 static ssize_t gameport_show_description(struct device *dev, struct device_attribute *attr, char *buf)
478 struct gameport *gameport = to_gameport_port(dev);
479 return sprintf(buf, "%s\n", gameport->name);
482 static ssize_t gameport_rebind_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
484 struct gameport *gameport = to_gameport_port(dev);
485 struct device_driver *drv;
488 retval = mutex_lock_interruptible(&gameport_mutex);
493 if (!strncmp(buf, "none", count)) {
494 gameport_disconnect_port(gameport);
495 } else if (!strncmp(buf, "reconnect", count)) {
496 gameport_reconnect_port(gameport);
497 } else if (!strncmp(buf, "rescan", count)) {
498 gameport_disconnect_port(gameport);
499 gameport_find_driver(gameport);
500 } else if ((drv = driver_find(buf, &gameport_bus)) != NULL) {
501 gameport_disconnect_port(gameport);
502 gameport_bind_driver(gameport, to_gameport_driver(drv));
508 mutex_unlock(&gameport_mutex);
513 static struct device_attribute gameport_device_attrs[] = {
514 __ATTR(description, S_IRUGO, gameport_show_description, NULL),
515 __ATTR(drvctl, S_IWUSR, NULL, gameport_rebind_driver),
519 static void gameport_release_port(struct device *dev)
521 struct gameport *gameport = to_gameport_port(dev);
524 module_put(THIS_MODULE);
527 void gameport_set_phys(struct gameport *gameport, const char *fmt, ...)
532 vsnprintf(gameport->phys, sizeof(gameport->phys), fmt, args);
537 * Prepare gameport port for registration.
539 static void gameport_init_port(struct gameport *gameport)
541 static atomic_t gameport_no = ATOMIC_INIT(0);
543 __module_get(THIS_MODULE);
545 mutex_init(&gameport->drv_mutex);
546 device_initialize(&gameport->dev);
547 snprintf(gameport->dev.bus_id, sizeof(gameport->dev.bus_id),
548 "gameport%lu", (unsigned long)atomic_inc_return(&gameport_no) - 1);
549 gameport->dev.bus = &gameport_bus;
550 gameport->dev.release = gameport_release_port;
551 if (gameport->parent)
552 gameport->dev.parent = &gameport->parent->dev;
554 INIT_LIST_HEAD(&gameport->node);
555 spin_lock_init(&gameport->timer_lock);
556 init_timer(&gameport->poll_timer);
557 gameport->poll_timer.function = gameport_run_poll_handler;
558 gameport->poll_timer.data = (unsigned long)gameport;
562 * Complete gameport port registration.
563 * Driver core will attempt to find appropriate driver for the port.
565 static void gameport_add_port(struct gameport *gameport)
569 if (gameport->parent)
570 gameport->parent->child = gameport;
572 gameport->speed = gameport_measure_speed(gameport);
574 list_add_tail(&gameport->node, &gameport_list);
577 printk(KERN_INFO "gameport: %s is %s, io %#x, speed %dkHz\n",
578 gameport->name, gameport->phys, gameport->io, gameport->speed);
580 printk(KERN_INFO "gameport: %s is %s, speed %dkHz\n",
581 gameport->name, gameport->phys, gameport->speed);
583 error = device_add(&gameport->dev);
586 "gameport: device_add() failed for %s (%s), error: %d\n",
587 gameport->phys, gameport->name, error);
589 gameport->registered = 1;
593 * gameport_destroy_port() completes deregistration process and removes
594 * port from the system
596 static void gameport_destroy_port(struct gameport *gameport)
598 struct gameport *child;
600 child = gameport_get_pending_child(gameport);
602 gameport_remove_pending_events(child);
603 put_device(&child->dev);
606 if (gameport->parent) {
607 gameport->parent->child = NULL;
608 gameport->parent = NULL;
611 if (gameport->registered) {
612 device_del(&gameport->dev);
613 gameport->registered = 0;
616 list_del_init(&gameport->node);
618 gameport_remove_pending_events(gameport);
619 put_device(&gameport->dev);
623 * Reconnect gameport port and all its children (re-initialize attached devices)
625 static void gameport_reconnect_port(struct gameport *gameport)
628 if (!gameport->drv || !gameport->drv->reconnect || gameport->drv->reconnect(gameport)) {
629 gameport_disconnect_port(gameport);
630 gameport_find_driver(gameport);
631 /* Ok, old children are now gone, we are done */
634 gameport = gameport->child;
639 * gameport_disconnect_port() unbinds a port from its driver. As a side effect
640 * all child ports are unbound and destroyed.
642 static void gameport_disconnect_port(struct gameport *gameport)
644 struct gameport *s, *parent;
646 if (gameport->child) {
648 * Children ports should be disconnected and destroyed
649 * first, staring with the leaf one, since we don't want
652 for (s = gameport; s->child; s = s->child)
658 gameport_release_driver(s);
659 gameport_destroy_port(s);
660 } while ((s = parent) != gameport);
664 * Ok, no children left, now disconnect this port
666 gameport_release_driver(gameport);
669 void gameport_rescan(struct gameport *gameport)
671 gameport_queue_event(gameport, NULL, GAMEPORT_RESCAN);
674 void gameport_reconnect(struct gameport *gameport)
676 gameport_queue_event(gameport, NULL, GAMEPORT_RECONNECT);
680 * Submits register request to kgameportd for subsequent execution.
681 * Note that port registration is always asynchronous.
683 void __gameport_register_port(struct gameport *gameport, struct module *owner)
685 gameport_init_port(gameport);
686 gameport_queue_event(gameport, owner, GAMEPORT_REGISTER_PORT);
690 * Synchronously unregisters gameport port.
692 void gameport_unregister_port(struct gameport *gameport)
694 mutex_lock(&gameport_mutex);
695 gameport_disconnect_port(gameport);
696 gameport_destroy_port(gameport);
697 mutex_unlock(&gameport_mutex);
702 * Gameport driver operations
705 static ssize_t gameport_driver_show_description(struct device_driver *drv, char *buf)
707 struct gameport_driver *driver = to_gameport_driver(drv);
708 return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
711 static struct driver_attribute gameport_driver_attrs[] = {
712 __ATTR(description, S_IRUGO, gameport_driver_show_description, NULL),
716 static int gameport_driver_probe(struct device *dev)
718 struct gameport *gameport = to_gameport_port(dev);
719 struct gameport_driver *drv = to_gameport_driver(dev->driver);
721 drv->connect(gameport, drv);
722 return gameport->drv ? 0 : -ENODEV;
725 static int gameport_driver_remove(struct device *dev)
727 struct gameport *gameport = to_gameport_port(dev);
728 struct gameport_driver *drv = to_gameport_driver(dev->driver);
730 drv->disconnect(gameport);
734 static struct bus_type gameport_bus = {
736 .probe = gameport_driver_probe,
737 .remove = gameport_driver_remove,
740 static void gameport_add_driver(struct gameport_driver *drv)
744 error = driver_register(&drv->driver);
747 "gameport: driver_register() failed for %s, error: %d\n",
748 drv->driver.name, error);
751 void __gameport_register_driver(struct gameport_driver *drv, struct module *owner)
753 drv->driver.bus = &gameport_bus;
754 gameport_queue_event(drv, owner, GAMEPORT_REGISTER_DRIVER);
757 void gameport_unregister_driver(struct gameport_driver *drv)
759 struct gameport *gameport;
761 mutex_lock(&gameport_mutex);
762 drv->ignore = 1; /* so gameport_find_driver ignores it */
765 list_for_each_entry(gameport, &gameport_list, node) {
766 if (gameport->drv == drv) {
767 gameport_disconnect_port(gameport);
768 gameport_find_driver(gameport);
769 /* we could've deleted some ports, restart */
774 driver_unregister(&drv->driver);
775 mutex_unlock(&gameport_mutex);
778 static int gameport_bus_match(struct device *dev, struct device_driver *drv)
780 struct gameport_driver *gameport_drv = to_gameport_driver(drv);
782 return !gameport_drv->ignore;
785 static void gameport_set_drv(struct gameport *gameport, struct gameport_driver *drv)
787 mutex_lock(&gameport->drv_mutex);
789 mutex_unlock(&gameport->drv_mutex);
792 int gameport_open(struct gameport *gameport, struct gameport_driver *drv, int mode)
795 if (gameport->open) {
796 if (gameport->open(gameport, mode)) {
800 if (mode != GAMEPORT_MODE_RAW)
804 gameport_set_drv(gameport, drv);
808 void gameport_close(struct gameport *gameport)
810 del_timer_sync(&gameport->poll_timer);
811 gameport->poll_handler = NULL;
812 gameport->poll_interval = 0;
813 gameport_set_drv(gameport, NULL);
815 gameport->close(gameport);
818 static int __init gameport_init(void)
822 gameport_bus.dev_attrs = gameport_device_attrs;
823 gameport_bus.drv_attrs = gameport_driver_attrs;
824 gameport_bus.match = gameport_bus_match;
825 error = bus_register(&gameport_bus);
827 printk(KERN_ERR "gameport: failed to register gameport bus, error: %d\n", error);
831 gameport_task = kthread_run(gameport_thread, NULL, "kgameportd");
832 if (IS_ERR(gameport_task)) {
833 bus_unregister(&gameport_bus);
834 error = PTR_ERR(gameport_task);
835 printk(KERN_ERR "gameport: Failed to start kgameportd, error: %d\n", error);
842 static void __exit gameport_exit(void)
844 bus_unregister(&gameport_bus);
845 kthread_stop(gameport_task);
848 subsys_initcall(gameport_init);
849 module_exit(gameport_exit);