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 int gameport_bind_driver(struct gameport
*gameport
, struct gameport_driver
*drv
)
197 gameport
->dev
.driver
= &drv
->driver
;
198 if (drv
->connect(gameport
, drv
)) {
199 gameport
->dev
.driver
= NULL
;
203 error
= device_bind_driver(&gameport
->dev
);
206 "gameport: device_bind_driver() failed "
207 "for %s (%s) and %s, error: %d\n",
208 gameport
->phys
, gameport
->name
,
209 drv
->description
, error
);
210 drv
->disconnect(gameport
);
211 gameport
->dev
.driver
= NULL
;
218 static void gameport_find_driver(struct gameport
*gameport
)
222 error
= device_attach(&gameport
->dev
);
225 "gameport: device_attach() failed for %s (%s), error: %d\n",
226 gameport
->phys
, gameport
->name
, error
);
231 * Gameport event processing.
234 enum gameport_event_type
{
237 GAMEPORT_REGISTER_PORT
,
238 GAMEPORT_REGISTER_DRIVER
,
241 struct gameport_event
{
242 enum gameport_event_type type
;
244 struct module
*owner
;
245 struct list_head node
;
248 static DEFINE_SPINLOCK(gameport_event_lock
); /* protects gameport_event_list */
249 static LIST_HEAD(gameport_event_list
);
250 static DECLARE_WAIT_QUEUE_HEAD(gameport_wait
);
251 static struct task_struct
*gameport_task
;
253 static void gameport_queue_event(void *object
, struct module
*owner
,
254 enum gameport_event_type event_type
)
257 struct gameport_event
*event
;
259 spin_lock_irqsave(&gameport_event_lock
, flags
);
262 * Scan event list for the other events for the same gameport port,
263 * starting with the most recent one. If event is the same we
264 * do not need add new one. If event is of different type we
265 * need to add this event and should not look further because
266 * we need to preseve sequence of distinct events.
268 list_for_each_entry_reverse(event
, &gameport_event_list
, node
) {
269 if (event
->object
== object
) {
270 if (event
->type
== event_type
)
276 if ((event
= kmalloc(sizeof(struct gameport_event
), GFP_ATOMIC
))) {
277 if (!try_module_get(owner
)) {
278 printk(KERN_WARNING
"gameport: Can't get module reference, dropping event %d\n", event_type
);
283 event
->type
= event_type
;
284 event
->object
= object
;
285 event
->owner
= owner
;
287 list_add_tail(&event
->node
, &gameport_event_list
);
288 wake_up(&gameport_wait
);
290 printk(KERN_ERR
"gameport: Not enough memory to queue event %d\n", event_type
);
293 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
296 static void gameport_free_event(struct gameport_event
*event
)
298 module_put(event
->owner
);
302 static void gameport_remove_duplicate_events(struct gameport_event
*event
)
304 struct list_head
*node
, *next
;
305 struct gameport_event
*e
;
308 spin_lock_irqsave(&gameport_event_lock
, flags
);
310 list_for_each_safe(node
, next
, &gameport_event_list
) {
311 e
= list_entry(node
, struct gameport_event
, node
);
312 if (event
->object
== e
->object
) {
314 * If this event is of different type we should not
315 * look further - we only suppress duplicate events
316 * that were sent back-to-back.
318 if (event
->type
!= e
->type
)
322 gameport_free_event(e
);
326 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
329 static struct gameport_event
*gameport_get_event(void)
331 struct gameport_event
*event
;
332 struct list_head
*node
;
335 spin_lock_irqsave(&gameport_event_lock
, flags
);
337 if (list_empty(&gameport_event_list
)) {
338 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
342 node
= gameport_event_list
.next
;
343 event
= list_entry(node
, struct gameport_event
, node
);
346 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
351 static void gameport_handle_event(void)
353 struct gameport_event
*event
;
355 mutex_lock(&gameport_mutex
);
358 * Note that we handle only one event here to give swsusp
359 * a chance to freeze kgameportd thread. Gameport events
360 * should be pretty rare so we are not concerned about
361 * taking performance hit.
363 if ((event
= gameport_get_event())) {
365 switch (event
->type
) {
366 case GAMEPORT_REGISTER_PORT
:
367 gameport_add_port(event
->object
);
370 case GAMEPORT_RECONNECT
:
371 gameport_reconnect_port(event
->object
);
374 case GAMEPORT_RESCAN
:
375 gameport_disconnect_port(event
->object
);
376 gameport_find_driver(event
->object
);
379 case GAMEPORT_REGISTER_DRIVER
:
380 gameport_add_driver(event
->object
);
387 gameport_remove_duplicate_events(event
);
388 gameport_free_event(event
);
391 mutex_unlock(&gameport_mutex
);
395 * Remove all events that have been submitted for a given gameport port.
397 static void gameport_remove_pending_events(struct gameport
*gameport
)
399 struct list_head
*node
, *next
;
400 struct gameport_event
*event
;
403 spin_lock_irqsave(&gameport_event_lock
, flags
);
405 list_for_each_safe(node
, next
, &gameport_event_list
) {
406 event
= list_entry(node
, struct gameport_event
, node
);
407 if (event
->object
== gameport
) {
409 gameport_free_event(event
);
413 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
417 * Destroy child gameport port (if any) that has not been fully registered yet.
419 * Note that we rely on the fact that port can have only one child and therefore
420 * only one child registration request can be pending. Additionally, children
421 * are registered by driver's connect() handler so there can't be a grandchild
422 * pending registration together with a child.
424 static struct gameport
*gameport_get_pending_child(struct gameport
*parent
)
426 struct gameport_event
*event
;
427 struct gameport
*gameport
, *child
= NULL
;
430 spin_lock_irqsave(&gameport_event_lock
, flags
);
432 list_for_each_entry(event
, &gameport_event_list
, node
) {
433 if (event
->type
== GAMEPORT_REGISTER_PORT
) {
434 gameport
= event
->object
;
435 if (gameport
->parent
== parent
) {
442 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
446 static int gameport_thread(void *nothing
)
449 gameport_handle_event();
450 wait_event_interruptible(gameport_wait
,
451 kthread_should_stop() || !list_empty(&gameport_event_list
));
453 } while (!kthread_should_stop());
455 printk(KERN_DEBUG
"gameport: kgameportd exiting\n");
461 * Gameport port operations
464 static ssize_t
gameport_show_description(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
466 struct gameport
*gameport
= to_gameport_port(dev
);
467 return sprintf(buf
, "%s\n", gameport
->name
);
470 static ssize_t
gameport_rebind_driver(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
472 struct gameport
*gameport
= to_gameport_port(dev
);
473 struct device_driver
*drv
;
476 error
= mutex_lock_interruptible(&gameport_mutex
);
480 if (!strncmp(buf
, "none", count
)) {
481 gameport_disconnect_port(gameport
);
482 } else if (!strncmp(buf
, "reconnect", count
)) {
483 gameport_reconnect_port(gameport
);
484 } else if (!strncmp(buf
, "rescan", count
)) {
485 gameport_disconnect_port(gameport
);
486 gameport_find_driver(gameport
);
487 } else if ((drv
= driver_find(buf
, &gameport_bus
)) != NULL
) {
488 gameport_disconnect_port(gameport
);
489 error
= gameport_bind_driver(gameport
, to_gameport_driver(drv
));
495 mutex_unlock(&gameport_mutex
);
497 return error
? error
: count
;
500 static struct device_attribute gameport_device_attrs
[] = {
501 __ATTR(description
, S_IRUGO
, gameport_show_description
, NULL
),
502 __ATTR(drvctl
, S_IWUSR
, NULL
, gameport_rebind_driver
),
506 static void gameport_release_port(struct device
*dev
)
508 struct gameport
*gameport
= to_gameport_port(dev
);
511 module_put(THIS_MODULE
);
514 void gameport_set_phys(struct gameport
*gameport
, const char *fmt
, ...)
519 vsnprintf(gameport
->phys
, sizeof(gameport
->phys
), fmt
, args
);
524 * Prepare gameport port for registration.
526 static void gameport_init_port(struct gameport
*gameport
)
528 static atomic_t gameport_no
= ATOMIC_INIT(0);
530 __module_get(THIS_MODULE
);
532 mutex_init(&gameport
->drv_mutex
);
533 device_initialize(&gameport
->dev
);
534 snprintf(gameport
->dev
.bus_id
, sizeof(gameport
->dev
.bus_id
),
535 "gameport%lu", (unsigned long)atomic_inc_return(&gameport_no
) - 1);
536 gameport
->dev
.bus
= &gameport_bus
;
537 gameport
->dev
.release
= gameport_release_port
;
538 if (gameport
->parent
)
539 gameport
->dev
.parent
= &gameport
->parent
->dev
;
541 INIT_LIST_HEAD(&gameport
->node
);
542 spin_lock_init(&gameport
->timer_lock
);
543 init_timer(&gameport
->poll_timer
);
544 gameport
->poll_timer
.function
= gameport_run_poll_handler
;
545 gameport
->poll_timer
.data
= (unsigned long)gameport
;
549 * Complete gameport port registration.
550 * Driver core will attempt to find appropriate driver for the port.
552 static void gameport_add_port(struct gameport
*gameport
)
556 if (gameport
->parent
)
557 gameport
->parent
->child
= gameport
;
559 gameport
->speed
= gameport_measure_speed(gameport
);
561 list_add_tail(&gameport
->node
, &gameport_list
);
564 printk(KERN_INFO
"gameport: %s is %s, io %#x, speed %dkHz\n",
565 gameport
->name
, gameport
->phys
, gameport
->io
, gameport
->speed
);
567 printk(KERN_INFO
"gameport: %s is %s, speed %dkHz\n",
568 gameport
->name
, gameport
->phys
, gameport
->speed
);
570 error
= device_add(&gameport
->dev
);
573 "gameport: device_add() failed for %s (%s), error: %d\n",
574 gameport
->phys
, gameport
->name
, error
);
576 gameport
->registered
= 1;
580 * gameport_destroy_port() completes deregistration process and removes
581 * port from the system
583 static void gameport_destroy_port(struct gameport
*gameport
)
585 struct gameport
*child
;
587 child
= gameport_get_pending_child(gameport
);
589 gameport_remove_pending_events(child
);
590 put_device(&child
->dev
);
593 if (gameport
->parent
) {
594 gameport
->parent
->child
= NULL
;
595 gameport
->parent
= NULL
;
598 if (gameport
->registered
) {
599 device_del(&gameport
->dev
);
600 gameport
->registered
= 0;
603 list_del_init(&gameport
->node
);
605 gameport_remove_pending_events(gameport
);
606 put_device(&gameport
->dev
);
610 * Reconnect gameport port and all its children (re-initialize attached devices)
612 static void gameport_reconnect_port(struct gameport
*gameport
)
615 if (!gameport
->drv
|| !gameport
->drv
->reconnect
|| gameport
->drv
->reconnect(gameport
)) {
616 gameport_disconnect_port(gameport
);
617 gameport_find_driver(gameport
);
618 /* Ok, old children are now gone, we are done */
621 gameport
= gameport
->child
;
626 * gameport_disconnect_port() unbinds a port from its driver. As a side effect
627 * all child ports are unbound and destroyed.
629 static void gameport_disconnect_port(struct gameport
*gameport
)
631 struct gameport
*s
, *parent
;
633 if (gameport
->child
) {
635 * Children ports should be disconnected and destroyed
636 * first, staring with the leaf one, since we don't want
639 for (s
= gameport
; s
->child
; s
= s
->child
)
645 device_release_driver(&s
->dev
);
646 gameport_destroy_port(s
);
647 } while ((s
= parent
) != gameport
);
651 * Ok, no children left, now disconnect this port
653 device_release_driver(&gameport
->dev
);
656 void gameport_rescan(struct gameport
*gameport
)
658 gameport_queue_event(gameport
, NULL
, GAMEPORT_RESCAN
);
661 void gameport_reconnect(struct gameport
*gameport
)
663 gameport_queue_event(gameport
, NULL
, GAMEPORT_RECONNECT
);
667 * Submits register request to kgameportd for subsequent execution.
668 * Note that port registration is always asynchronous.
670 void __gameport_register_port(struct gameport
*gameport
, struct module
*owner
)
672 gameport_init_port(gameport
);
673 gameport_queue_event(gameport
, owner
, GAMEPORT_REGISTER_PORT
);
677 * Synchronously unregisters gameport port.
679 void gameport_unregister_port(struct gameport
*gameport
)
681 mutex_lock(&gameport_mutex
);
682 gameport_disconnect_port(gameport
);
683 gameport_destroy_port(gameport
);
684 mutex_unlock(&gameport_mutex
);
689 * Gameport driver operations
692 static ssize_t
gameport_driver_show_description(struct device_driver
*drv
, char *buf
)
694 struct gameport_driver
*driver
= to_gameport_driver(drv
);
695 return sprintf(buf
, "%s\n", driver
->description
? driver
->description
: "(none)");
698 static struct driver_attribute gameport_driver_attrs
[] = {
699 __ATTR(description
, S_IRUGO
, gameport_driver_show_description
, NULL
),
703 static int gameport_driver_probe(struct device
*dev
)
705 struct gameport
*gameport
= to_gameport_port(dev
);
706 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
708 drv
->connect(gameport
, drv
);
709 return gameport
->drv
? 0 : -ENODEV
;
712 static int gameport_driver_remove(struct device
*dev
)
714 struct gameport
*gameport
= to_gameport_port(dev
);
715 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
717 drv
->disconnect(gameport
);
721 static void gameport_add_driver(struct gameport_driver
*drv
)
725 error
= driver_register(&drv
->driver
);
728 "gameport: driver_register() failed for %s, error: %d\n",
729 drv
->driver
.name
, error
);
732 void __gameport_register_driver(struct gameport_driver
*drv
, struct module
*owner
)
734 drv
->driver
.bus
= &gameport_bus
;
735 gameport_queue_event(drv
, owner
, GAMEPORT_REGISTER_DRIVER
);
738 void gameport_unregister_driver(struct gameport_driver
*drv
)
740 struct gameport
*gameport
;
742 mutex_lock(&gameport_mutex
);
743 drv
->ignore
= 1; /* so gameport_find_driver ignores it */
746 list_for_each_entry(gameport
, &gameport_list
, node
) {
747 if (gameport
->drv
== drv
) {
748 gameport_disconnect_port(gameport
);
749 gameport_find_driver(gameport
);
750 /* we could've deleted some ports, restart */
755 driver_unregister(&drv
->driver
);
756 mutex_unlock(&gameport_mutex
);
759 static int gameport_bus_match(struct device
*dev
, struct device_driver
*drv
)
761 struct gameport_driver
*gameport_drv
= to_gameport_driver(drv
);
763 return !gameport_drv
->ignore
;
766 static struct bus_type gameport_bus
= {
768 .dev_attrs
= gameport_device_attrs
,
769 .drv_attrs
= gameport_driver_attrs
,
770 .match
= gameport_bus_match
,
771 .probe
= gameport_driver_probe
,
772 .remove
= gameport_driver_remove
,
775 static void gameport_set_drv(struct gameport
*gameport
, struct gameport_driver
*drv
)
777 mutex_lock(&gameport
->drv_mutex
);
779 mutex_unlock(&gameport
->drv_mutex
);
782 int gameport_open(struct gameport
*gameport
, struct gameport_driver
*drv
, int mode
)
784 if (gameport
->open
) {
785 if (gameport
->open(gameport
, mode
)) {
789 if (mode
!= GAMEPORT_MODE_RAW
)
793 gameport_set_drv(gameport
, drv
);
797 void gameport_close(struct gameport
*gameport
)
799 del_timer_sync(&gameport
->poll_timer
);
800 gameport
->poll_handler
= NULL
;
801 gameport
->poll_interval
= 0;
802 gameport_set_drv(gameport
, NULL
);
804 gameport
->close(gameport
);
807 static int __init
gameport_init(void)
811 error
= bus_register(&gameport_bus
);
813 printk(KERN_ERR
"gameport: failed to register gameport bus, error: %d\n", error
);
817 gameport_task
= kthread_run(gameport_thread
, NULL
, "kgameportd");
818 if (IS_ERR(gameport_task
)) {
819 bus_unregister(&gameport_bus
);
820 error
= PTR_ERR(gameport_task
);
821 printk(KERN_ERR
"gameport: Failed to start kgameportd, error: %d\n", error
);
828 static void __exit
gameport_exit(void)
830 bus_unregister(&gameport_bus
);
831 kthread_stop(gameport_task
);
834 subsys_initcall(gameport_init
);
835 module_exit(gameport_exit
);