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/slab.h>
21 #include <linux/delay.h>
22 #include <linux/kthread.h>
23 #include <linux/sched.h> /* HZ */
24 #include <linux/mutex.h>
25 #include <linux/freezer.h>
27 /*#include <asm/io.h>*/
29 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
30 MODULE_DESCRIPTION("Generic gameport layer");
31 MODULE_LICENSE("GPL");
33 EXPORT_SYMBOL(__gameport_register_port
);
34 EXPORT_SYMBOL(gameport_unregister_port
);
35 EXPORT_SYMBOL(__gameport_register_driver
);
36 EXPORT_SYMBOL(gameport_unregister_driver
);
37 EXPORT_SYMBOL(gameport_open
);
38 EXPORT_SYMBOL(gameport_close
);
39 EXPORT_SYMBOL(gameport_set_phys
);
40 EXPORT_SYMBOL(gameport_start_polling
);
41 EXPORT_SYMBOL(gameport_stop_polling
);
44 * gameport_mutex protects entire gameport subsystem and is taken
45 * every time gameport port or driver registrered or unregistered.
47 static DEFINE_MUTEX(gameport_mutex
);
49 static LIST_HEAD(gameport_list
);
51 static struct bus_type gameport_bus
;
53 static void gameport_add_port(struct gameport
*gameport
);
54 static void gameport_attach_driver(struct gameport_driver
*drv
);
55 static void gameport_reconnect_port(struct gameport
*gameport
);
56 static void gameport_disconnect_port(struct gameport
*gameport
);
60 #include <asm/i8253.h>
62 #define DELTA(x,y) ((y)-(x)+((y)<(x)?1193182/HZ:0))
63 #define GET_TIME(x) do { x = get_time_pit(); } while (0)
65 static unsigned int get_time_pit(void)
70 spin_lock_irqsave(&i8253_lock
, flags
);
73 count
|= inb_p(0x40) << 8;
74 spin_unlock_irqrestore(&i8253_lock
, flags
);
84 * gameport_measure_speed() measures the gameport i/o speed.
87 static int gameport_measure_speed(struct gameport
*gameport
)
91 unsigned int i
, t
, t1
, t2
, t3
, tx
;
94 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
99 for(i
= 0; i
< 50; i
++) {
100 local_irq_save(flags
);
102 for (t
= 0; t
< 50; t
++) gameport_read(gameport
);
105 local_irq_restore(flags
);
107 if ((t
= DELTA(t2
,t1
) - DELTA(t3
,t2
)) < tx
) tx
= t
;
110 gameport_close(gameport
);
111 return 59659 / (tx
< 1 ? 1 : tx
);
113 #elif defined (__x86_64__)
116 unsigned long tx
, t1
, t2
, flags
;
118 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
123 for(i
= 0; i
< 50; i
++) {
124 local_irq_save(flags
);
126 for (t
= 0; t
< 50; t
++) gameport_read(gameport
);
128 local_irq_restore(flags
);
130 if (t2
- t1
< tx
) tx
= t2
- t1
;
133 gameport_close(gameport
);
134 return (cpu_data(raw_smp_processor_id()).loops_per_jiffy
*
135 (unsigned long)HZ
/ (1000 / 50)) / (tx
< 1 ? 1 : tx
);
139 unsigned int j
, t
= 0;
141 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
144 j
= jiffies
; while (j
== jiffies
);
145 j
= jiffies
; while (j
== jiffies
) { t
++; gameport_read(gameport
); }
147 gameport_close(gameport
);
148 return t
* HZ
/ 1000;
153 void gameport_start_polling(struct gameport
*gameport
)
155 spin_lock(&gameport
->timer_lock
);
157 if (!gameport
->poll_cnt
++) {
158 BUG_ON(!gameport
->poll_handler
);
159 BUG_ON(!gameport
->poll_interval
);
160 mod_timer(&gameport
->poll_timer
, jiffies
+ msecs_to_jiffies(gameport
->poll_interval
));
163 spin_unlock(&gameport
->timer_lock
);
166 void gameport_stop_polling(struct gameport
*gameport
)
168 spin_lock(&gameport
->timer_lock
);
170 if (!--gameport
->poll_cnt
)
171 del_timer(&gameport
->poll_timer
);
173 spin_unlock(&gameport
->timer_lock
);
176 static void gameport_run_poll_handler(unsigned long d
)
178 struct gameport
*gameport
= (struct gameport
*)d
;
180 gameport
->poll_handler(gameport
);
181 if (gameport
->poll_cnt
)
182 mod_timer(&gameport
->poll_timer
, jiffies
+ msecs_to_jiffies(gameport
->poll_interval
));
186 * Basic gameport -> driver core mappings
189 static int gameport_bind_driver(struct gameport
*gameport
, struct gameport_driver
*drv
)
193 gameport
->dev
.driver
= &drv
->driver
;
194 if (drv
->connect(gameport
, drv
)) {
195 gameport
->dev
.driver
= NULL
;
199 error
= device_bind_driver(&gameport
->dev
);
202 "gameport: device_bind_driver() failed "
203 "for %s (%s) and %s, error: %d\n",
204 gameport
->phys
, gameport
->name
,
205 drv
->description
, error
);
206 drv
->disconnect(gameport
);
207 gameport
->dev
.driver
= NULL
;
214 static void gameport_find_driver(struct gameport
*gameport
)
218 error
= device_attach(&gameport
->dev
);
221 "gameport: device_attach() failed for %s (%s), error: %d\n",
222 gameport
->phys
, gameport
->name
, error
);
227 * Gameport event processing.
230 enum gameport_event_type
{
231 GAMEPORT_REGISTER_PORT
,
232 GAMEPORT_ATTACH_DRIVER
,
235 struct gameport_event
{
236 enum gameport_event_type type
;
238 struct module
*owner
;
239 struct list_head node
;
242 static DEFINE_SPINLOCK(gameport_event_lock
); /* protects gameport_event_list */
243 static LIST_HEAD(gameport_event_list
);
244 static DECLARE_WAIT_QUEUE_HEAD(gameport_wait
);
245 static struct task_struct
*gameport_task
;
247 static int gameport_queue_event(void *object
, struct module
*owner
,
248 enum gameport_event_type event_type
)
251 struct gameport_event
*event
;
254 spin_lock_irqsave(&gameport_event_lock
, flags
);
257 * Scan event list for the other events for the same gameport port,
258 * starting with the most recent one. If event is the same we
259 * do not need add new one. If event is of different type we
260 * need to add this event and should not look further because
261 * we need to preseve sequence of distinct events.
263 list_for_each_entry_reverse(event
, &gameport_event_list
, node
) {
264 if (event
->object
== object
) {
265 if (event
->type
== event_type
)
271 event
= kmalloc(sizeof(struct gameport_event
), GFP_ATOMIC
);
274 "gameport: Not enough memory to queue event %d\n",
280 if (!try_module_get(owner
)) {
282 "gameport: Can't get module reference, dropping event %d\n",
289 event
->type
= event_type
;
290 event
->object
= object
;
291 event
->owner
= owner
;
293 list_add_tail(&event
->node
, &gameport_event_list
);
294 wake_up(&gameport_wait
);
297 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
301 static void gameport_free_event(struct gameport_event
*event
)
303 module_put(event
->owner
);
307 static void gameport_remove_duplicate_events(struct gameport_event
*event
)
309 struct list_head
*node
, *next
;
310 struct gameport_event
*e
;
313 spin_lock_irqsave(&gameport_event_lock
, flags
);
315 list_for_each_safe(node
, next
, &gameport_event_list
) {
316 e
= list_entry(node
, struct gameport_event
, node
);
317 if (event
->object
== e
->object
) {
319 * If this event is of different type we should not
320 * look further - we only suppress duplicate events
321 * that were sent back-to-back.
323 if (event
->type
!= e
->type
)
327 gameport_free_event(e
);
331 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
334 static struct gameport_event
*gameport_get_event(void)
336 struct gameport_event
*event
;
337 struct list_head
*node
;
340 spin_lock_irqsave(&gameport_event_lock
, flags
);
342 if (list_empty(&gameport_event_list
)) {
343 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
347 node
= gameport_event_list
.next
;
348 event
= list_entry(node
, struct gameport_event
, node
);
351 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
356 static void gameport_handle_event(void)
358 struct gameport_event
*event
;
360 mutex_lock(&gameport_mutex
);
363 * Note that we handle only one event here to give swsusp
364 * a chance to freeze kgameportd thread. Gameport events
365 * should be pretty rare so we are not concerned about
366 * taking performance hit.
368 if ((event
= gameport_get_event())) {
370 switch (event
->type
) {
371 case GAMEPORT_REGISTER_PORT
:
372 gameport_add_port(event
->object
);
375 case GAMEPORT_ATTACH_DRIVER
:
376 gameport_attach_driver(event
->object
);
383 gameport_remove_duplicate_events(event
);
384 gameport_free_event(event
);
387 mutex_unlock(&gameport_mutex
);
391 * Remove all events that have been submitted for a given object,
392 * be it a gameport port or a driver.
394 static void gameport_remove_pending_events(void *object
)
396 struct list_head
*node
, *next
;
397 struct gameport_event
*event
;
400 spin_lock_irqsave(&gameport_event_lock
, flags
);
402 list_for_each_safe(node
, next
, &gameport_event_list
) {
403 event
= list_entry(node
, struct gameport_event
, node
);
404 if (event
->object
== object
) {
406 gameport_free_event(event
);
410 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
414 * Destroy child gameport port (if any) that has not been fully registered yet.
416 * Note that we rely on the fact that port can have only one child and therefore
417 * only one child registration request can be pending. Additionally, children
418 * are registered by driver's connect() handler so there can't be a grandchild
419 * pending registration together with a child.
421 static struct gameport
*gameport_get_pending_child(struct gameport
*parent
)
423 struct gameport_event
*event
;
424 struct gameport
*gameport
, *child
= NULL
;
427 spin_lock_irqsave(&gameport_event_lock
, flags
);
429 list_for_each_entry(event
, &gameport_event_list
, node
) {
430 if (event
->type
== GAMEPORT_REGISTER_PORT
) {
431 gameport
= event
->object
;
432 if (gameport
->parent
== parent
) {
439 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
443 static int gameport_thread(void *nothing
)
447 gameport_handle_event();
448 wait_event_freezable(gameport_wait
,
449 kthread_should_stop() || !list_empty(&gameport_event_list
));
450 } while (!kthread_should_stop());
452 printk(KERN_DEBUG
"gameport: kgameportd exiting\n");
458 * Gameport port operations
461 static ssize_t
gameport_show_description(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
463 struct gameport
*gameport
= to_gameport_port(dev
);
464 return sprintf(buf
, "%s\n", gameport
->name
);
467 static ssize_t
gameport_rebind_driver(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
469 struct gameport
*gameport
= to_gameport_port(dev
);
470 struct device_driver
*drv
;
473 error
= mutex_lock_interruptible(&gameport_mutex
);
477 if (!strncmp(buf
, "none", count
)) {
478 gameport_disconnect_port(gameport
);
479 } else if (!strncmp(buf
, "reconnect", count
)) {
480 gameport_reconnect_port(gameport
);
481 } else if (!strncmp(buf
, "rescan", count
)) {
482 gameport_disconnect_port(gameport
);
483 gameport_find_driver(gameport
);
484 } else if ((drv
= driver_find(buf
, &gameport_bus
)) != NULL
) {
485 gameport_disconnect_port(gameport
);
486 error
= gameport_bind_driver(gameport
, to_gameport_driver(drv
));
492 mutex_unlock(&gameport_mutex
);
494 return error
? error
: count
;
497 static struct device_attribute gameport_device_attrs
[] = {
498 __ATTR(description
, S_IRUGO
, gameport_show_description
, NULL
),
499 __ATTR(drvctl
, S_IWUSR
, NULL
, gameport_rebind_driver
),
503 static void gameport_release_port(struct device
*dev
)
505 struct gameport
*gameport
= to_gameport_port(dev
);
508 module_put(THIS_MODULE
);
511 void gameport_set_phys(struct gameport
*gameport
, const char *fmt
, ...)
516 vsnprintf(gameport
->phys
, sizeof(gameport
->phys
), fmt
, args
);
521 * Prepare gameport port for registration.
523 static void gameport_init_port(struct gameport
*gameport
)
525 static atomic_t gameport_no
= ATOMIC_INIT(0);
527 __module_get(THIS_MODULE
);
529 mutex_init(&gameport
->drv_mutex
);
530 device_initialize(&gameport
->dev
);
531 dev_set_name(&gameport
->dev
, "gameport%lu", (unsigned long)atomic_inc_return(&gameport_no
) - 1);
532 gameport
->dev
.bus
= &gameport_bus
;
533 gameport
->dev
.release
= gameport_release_port
;
534 if (gameport
->parent
)
535 gameport
->dev
.parent
= &gameport
->parent
->dev
;
537 INIT_LIST_HEAD(&gameport
->node
);
538 spin_lock_init(&gameport
->timer_lock
);
539 init_timer(&gameport
->poll_timer
);
540 gameport
->poll_timer
.function
= gameport_run_poll_handler
;
541 gameport
->poll_timer
.data
= (unsigned long)gameport
;
545 * Complete gameport port registration.
546 * Driver core will attempt to find appropriate driver for the port.
548 static void gameport_add_port(struct gameport
*gameport
)
552 if (gameport
->parent
)
553 gameport
->parent
->child
= gameport
;
555 gameport
->speed
= gameport_measure_speed(gameport
);
557 list_add_tail(&gameport
->node
, &gameport_list
);
560 printk(KERN_INFO
"gameport: %s is %s, io %#x, speed %dkHz\n",
561 gameport
->name
, gameport
->phys
, gameport
->io
, gameport
->speed
);
563 printk(KERN_INFO
"gameport: %s is %s, speed %dkHz\n",
564 gameport
->name
, gameport
->phys
, gameport
->speed
);
566 error
= device_add(&gameport
->dev
);
569 "gameport: device_add() failed for %s (%s), error: %d\n",
570 gameport
->phys
, gameport
->name
, error
);
572 gameport
->registered
= 1;
576 * gameport_destroy_port() completes deregistration process and removes
577 * port from the system
579 static void gameport_destroy_port(struct gameport
*gameport
)
581 struct gameport
*child
;
583 child
= gameport_get_pending_child(gameport
);
585 gameport_remove_pending_events(child
);
586 put_device(&child
->dev
);
589 if (gameport
->parent
) {
590 gameport
->parent
->child
= NULL
;
591 gameport
->parent
= NULL
;
594 if (gameport
->registered
) {
595 device_del(&gameport
->dev
);
596 gameport
->registered
= 0;
599 list_del_init(&gameport
->node
);
601 gameport_remove_pending_events(gameport
);
602 put_device(&gameport
->dev
);
606 * Reconnect gameport port and all its children (re-initialize attached devices)
608 static void gameport_reconnect_port(struct gameport
*gameport
)
611 if (!gameport
->drv
|| !gameport
->drv
->reconnect
|| gameport
->drv
->reconnect(gameport
)) {
612 gameport_disconnect_port(gameport
);
613 gameport_find_driver(gameport
);
614 /* Ok, old children are now gone, we are done */
617 gameport
= gameport
->child
;
622 * gameport_disconnect_port() unbinds a port from its driver. As a side effect
623 * all child ports are unbound and destroyed.
625 static void gameport_disconnect_port(struct gameport
*gameport
)
627 struct gameport
*s
, *parent
;
629 if (gameport
->child
) {
631 * Children ports should be disconnected and destroyed
632 * first, staring with the leaf one, since we don't want
635 for (s
= gameport
; s
->child
; s
= s
->child
)
641 device_release_driver(&s
->dev
);
642 gameport_destroy_port(s
);
643 } while ((s
= parent
) != gameport
);
647 * Ok, no children left, now disconnect this port
649 device_release_driver(&gameport
->dev
);
653 * Submits register request to kgameportd for subsequent execution.
654 * Note that port registration is always asynchronous.
656 void __gameport_register_port(struct gameport
*gameport
, struct module
*owner
)
658 gameport_init_port(gameport
);
659 gameport_queue_event(gameport
, owner
, GAMEPORT_REGISTER_PORT
);
663 * Synchronously unregisters gameport port.
665 void gameport_unregister_port(struct gameport
*gameport
)
667 mutex_lock(&gameport_mutex
);
668 gameport_disconnect_port(gameport
);
669 gameport_destroy_port(gameport
);
670 mutex_unlock(&gameport_mutex
);
675 * Gameport driver operations
678 static ssize_t
gameport_driver_show_description(struct device_driver
*drv
, char *buf
)
680 struct gameport_driver
*driver
= to_gameport_driver(drv
);
681 return sprintf(buf
, "%s\n", driver
->description
? driver
->description
: "(none)");
684 static struct driver_attribute gameport_driver_attrs
[] = {
685 __ATTR(description
, S_IRUGO
, gameport_driver_show_description
, NULL
),
689 static int gameport_driver_probe(struct device
*dev
)
691 struct gameport
*gameport
= to_gameport_port(dev
);
692 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
694 drv
->connect(gameport
, drv
);
695 return gameport
->drv
? 0 : -ENODEV
;
698 static int gameport_driver_remove(struct device
*dev
)
700 struct gameport
*gameport
= to_gameport_port(dev
);
701 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
703 drv
->disconnect(gameport
);
707 static void gameport_attach_driver(struct gameport_driver
*drv
)
711 error
= driver_attach(&drv
->driver
);
714 "gameport: driver_attach() failed for %s, error: %d\n",
715 drv
->driver
.name
, error
);
718 int __gameport_register_driver(struct gameport_driver
*drv
, struct module
*owner
,
719 const char *mod_name
)
723 drv
->driver
.bus
= &gameport_bus
;
724 drv
->driver
.owner
= owner
;
725 drv
->driver
.mod_name
= mod_name
;
728 * Temporarily disable automatic binding because probing
729 * takes long time and we are better off doing it in kgameportd
733 error
= driver_register(&drv
->driver
);
736 "gameport: driver_register() failed for %s, error: %d\n",
737 drv
->driver
.name
, error
);
742 * Reset ignore flag and let kgameportd bind the driver to free ports
745 error
= gameport_queue_event(drv
, NULL
, GAMEPORT_ATTACH_DRIVER
);
747 driver_unregister(&drv
->driver
);
754 void gameport_unregister_driver(struct gameport_driver
*drv
)
756 struct gameport
*gameport
;
758 mutex_lock(&gameport_mutex
);
760 drv
->ignore
= 1; /* so gameport_find_driver ignores it */
761 gameport_remove_pending_events(drv
);
764 list_for_each_entry(gameport
, &gameport_list
, node
) {
765 if (gameport
->drv
== drv
) {
766 gameport_disconnect_port(gameport
);
767 gameport_find_driver(gameport
);
768 /* we could've deleted some ports, restart */
773 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 struct bus_type gameport_bus
= {
787 .dev_attrs
= gameport_device_attrs
,
788 .drv_attrs
= gameport_driver_attrs
,
789 .match
= gameport_bus_match
,
790 .probe
= gameport_driver_probe
,
791 .remove
= gameport_driver_remove
,
794 static void gameport_set_drv(struct gameport
*gameport
, struct gameport_driver
*drv
)
796 mutex_lock(&gameport
->drv_mutex
);
798 mutex_unlock(&gameport
->drv_mutex
);
801 int gameport_open(struct gameport
*gameport
, struct gameport_driver
*drv
, int mode
)
803 if (gameport
->open
) {
804 if (gameport
->open(gameport
, mode
)) {
808 if (mode
!= GAMEPORT_MODE_RAW
)
812 gameport_set_drv(gameport
, drv
);
816 void gameport_close(struct gameport
*gameport
)
818 del_timer_sync(&gameport
->poll_timer
);
819 gameport
->poll_handler
= NULL
;
820 gameport
->poll_interval
= 0;
821 gameport_set_drv(gameport
, NULL
);
823 gameport
->close(gameport
);
826 static int __init
gameport_init(void)
830 error
= bus_register(&gameport_bus
);
832 printk(KERN_ERR
"gameport: failed to register gameport bus, error: %d\n", error
);
836 gameport_task
= kthread_run(gameport_thread
, NULL
, "kgameportd");
837 if (IS_ERR(gameport_task
)) {
838 bus_unregister(&gameport_bus
);
839 error
= PTR_ERR(gameport_task
);
840 printk(KERN_ERR
"gameport: Failed to start kgameportd, error: %d\n", error
);
847 static void __exit
gameport_exit(void)
849 bus_unregister(&gameport_bus
);
850 kthread_stop(gameport_task
);
853 subsys_initcall(gameport_init
);
854 module_exit(gameport_exit
);