1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic gameport layer
5 * Copyright (c) 1999-2002 Vojtech Pavlik
6 * Copyright (c) 2005 Dmitry Torokhov
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/stddef.h>
13 #include <linux/module.h>
15 #include <linux/ioport.h>
16 #include <linux/init.h>
17 #include <linux/gameport.h>
18 #include <linux/slab.h>
19 #include <linux/delay.h>
20 #include <linux/workqueue.h>
21 #include <linux/sched.h> /* HZ */
22 #include <linux/mutex.h>
23 #include <linux/timekeeping.h>
25 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
26 MODULE_DESCRIPTION("Generic gameport layer");
27 MODULE_LICENSE("GPL");
29 static bool use_ktime
= true;
30 module_param(use_ktime
, bool, 0400);
31 MODULE_PARM_DESC(use_ktime
, "Use ktime for measuring I/O speed");
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 const 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
);
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)
60 raw_spin_lock_irqsave(&i8253_lock
, flags
);
63 count
|= inb_p(0x40) << 8;
64 raw_spin_unlock_irqrestore(&i8253_lock
, flags
);
74 * gameport_measure_speed() measures the gameport i/o speed.
77 static int gameport_measure_speed(struct gameport
*gameport
)
79 unsigned int i
, t
, tx
;
83 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
88 for (i
= 0; i
< 50; i
++) {
89 local_irq_save(flags
);
91 for (t
= 0; t
< 50; t
++)
92 gameport_read(gameport
);
95 local_irq_restore(flags
);
97 t
= (t2
- t1
) - (t3
- t2
);
102 gameport_close(gameport
);
109 static int old_gameport_measure_speed(struct gameport
*gameport
)
111 #if defined(__i386__)
113 unsigned int i
, t
, t1
, t2
, t3
, tx
;
116 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
121 for(i
= 0; i
< 50; i
++) {
122 local_irq_save(flags
);
124 for (t
= 0; t
< 50; t
++) gameport_read(gameport
);
127 local_irq_restore(flags
);
129 if ((t
= DELTA(t2
,t1
) - DELTA(t3
,t2
)) < tx
) tx
= t
;
132 gameport_close(gameport
);
133 return 59659 / (tx
< 1 ? 1 : tx
);
135 #elif defined (__x86_64__)
138 unsigned long tx
, t1
, t2
, flags
;
140 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
145 for(i
= 0; i
< 50; i
++) {
146 local_irq_save(flags
);
148 for (t
= 0; t
< 50; t
++) gameport_read(gameport
);
150 local_irq_restore(flags
);
152 if (t2
- t1
< tx
) tx
= t2
- t1
;
155 gameport_close(gameport
);
156 return (this_cpu_read(cpu_info
.loops_per_jiffy
) *
157 (unsigned long)HZ
/ (1000 / 50)) / (tx
< 1 ? 1 : tx
);
161 unsigned int j
, t
= 0;
163 if (gameport_open(gameport
, NULL
, GAMEPORT_MODE_RAW
))
166 j
= jiffies
; while (j
== jiffies
);
167 j
= jiffies
; while (j
== jiffies
) { t
++; gameport_read(gameport
); }
169 gameport_close(gameport
);
170 return t
* HZ
/ 1000;
175 void gameport_start_polling(struct gameport
*gameport
)
177 spin_lock(&gameport
->timer_lock
);
179 if (!gameport
->poll_cnt
++) {
180 BUG_ON(!gameport
->poll_handler
);
181 BUG_ON(!gameport
->poll_interval
);
182 mod_timer(&gameport
->poll_timer
, jiffies
+ msecs_to_jiffies(gameport
->poll_interval
));
185 spin_unlock(&gameport
->timer_lock
);
187 EXPORT_SYMBOL(gameport_start_polling
);
189 void gameport_stop_polling(struct gameport
*gameport
)
191 spin_lock(&gameport
->timer_lock
);
193 if (!--gameport
->poll_cnt
)
194 del_timer(&gameport
->poll_timer
);
196 spin_unlock(&gameport
->timer_lock
);
198 EXPORT_SYMBOL(gameport_stop_polling
);
200 static void gameport_run_poll_handler(struct timer_list
*t
)
202 struct gameport
*gameport
= from_timer(gameport
, t
, poll_timer
);
204 gameport
->poll_handler(gameport
);
205 if (gameport
->poll_cnt
)
206 mod_timer(&gameport
->poll_timer
, jiffies
+ msecs_to_jiffies(gameport
->poll_interval
));
210 * Basic gameport -> driver core mappings
213 static int gameport_bind_driver(struct gameport
*gameport
, struct gameport_driver
*drv
)
217 gameport
->dev
.driver
= &drv
->driver
;
218 if (drv
->connect(gameport
, drv
)) {
219 gameport
->dev
.driver
= NULL
;
223 error
= device_bind_driver(&gameport
->dev
);
225 dev_warn(&gameport
->dev
,
226 "device_bind_driver() failed for %s (%s) and %s, error: %d\n",
227 gameport
->phys
, gameport
->name
,
228 drv
->description
, error
);
229 drv
->disconnect(gameport
);
230 gameport
->dev
.driver
= NULL
;
237 static void gameport_find_driver(struct gameport
*gameport
)
241 error
= device_attach(&gameport
->dev
);
243 dev_warn(&gameport
->dev
,
244 "device_attach() failed for %s (%s), error: %d\n",
245 gameport
->phys
, gameport
->name
, error
);
250 * Gameport event processing.
253 enum gameport_event_type
{
254 GAMEPORT_REGISTER_PORT
,
255 GAMEPORT_ATTACH_DRIVER
,
258 struct gameport_event
{
259 enum gameport_event_type type
;
261 struct module
*owner
;
262 struct list_head node
;
265 static DEFINE_SPINLOCK(gameport_event_lock
); /* protects gameport_event_list */
266 static LIST_HEAD(gameport_event_list
);
268 static struct gameport_event
*gameport_get_event(void)
270 struct gameport_event
*event
= NULL
;
273 spin_lock_irqsave(&gameport_event_lock
, flags
);
275 if (!list_empty(&gameport_event_list
)) {
276 event
= list_first_entry(&gameport_event_list
,
277 struct gameport_event
, node
);
278 list_del_init(&event
->node
);
281 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
285 static void gameport_free_event(struct gameport_event
*event
)
287 module_put(event
->owner
);
291 static void gameport_remove_duplicate_events(struct gameport_event
*event
)
293 struct gameport_event
*e
, *next
;
296 spin_lock_irqsave(&gameport_event_lock
, flags
);
298 list_for_each_entry_safe(e
, next
, &gameport_event_list
, node
) {
299 if (event
->object
== e
->object
) {
301 * If this event is of different type we should not
302 * look further - we only suppress duplicate events
303 * that were sent back-to-back.
305 if (event
->type
!= e
->type
)
308 list_del_init(&e
->node
);
309 gameport_free_event(e
);
313 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
317 static void gameport_handle_events(struct work_struct
*work
)
319 struct gameport_event
*event
;
321 mutex_lock(&gameport_mutex
);
324 * Note that we handle only one event here to give swsusp
325 * a chance to freeze kgameportd thread. Gameport events
326 * should be pretty rare so we are not concerned about
327 * taking performance hit.
329 if ((event
= gameport_get_event())) {
331 switch (event
->type
) {
333 case GAMEPORT_REGISTER_PORT
:
334 gameport_add_port(event
->object
);
337 case GAMEPORT_ATTACH_DRIVER
:
338 gameport_attach_driver(event
->object
);
342 gameport_remove_duplicate_events(event
);
343 gameport_free_event(event
);
346 mutex_unlock(&gameport_mutex
);
349 static DECLARE_WORK(gameport_event_work
, gameport_handle_events
);
351 static int gameport_queue_event(void *object
, struct module
*owner
,
352 enum gameport_event_type event_type
)
355 struct gameport_event
*event
;
358 spin_lock_irqsave(&gameport_event_lock
, flags
);
361 * Scan event list for the other events for the same gameport port,
362 * starting with the most recent one. If event is the same we
363 * do not need add new one. If event is of different type we
364 * need to add this event and should not look further because
365 * we need to preserve sequence of distinct events.
367 list_for_each_entry_reverse(event
, &gameport_event_list
, node
) {
368 if (event
->object
== object
) {
369 if (event
->type
== event_type
)
375 event
= kmalloc(sizeof(*event
), GFP_ATOMIC
);
377 pr_err("Not enough memory to queue event %d\n", event_type
);
382 if (!try_module_get(owner
)) {
383 pr_warn("Can't get module reference, dropping event %d\n",
390 event
->type
= event_type
;
391 event
->object
= object
;
392 event
->owner
= owner
;
394 list_add_tail(&event
->node
, &gameport_event_list
);
395 queue_work(system_long_wq
, &gameport_event_work
);
398 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
403 * Remove all events that have been submitted for a given object,
404 * be it a gameport port or a driver.
406 static void gameport_remove_pending_events(void *object
)
408 struct gameport_event
*event
, *next
;
411 spin_lock_irqsave(&gameport_event_lock
, flags
);
413 list_for_each_entry_safe(event
, next
, &gameport_event_list
, node
) {
414 if (event
->object
== object
) {
415 list_del_init(&event
->node
);
416 gameport_free_event(event
);
420 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
424 * Destroy child gameport port (if any) that has not been fully registered yet.
426 * Note that we rely on the fact that port can have only one child and therefore
427 * only one child registration request can be pending. Additionally, children
428 * are registered by driver's connect() handler so there can't be a grandchild
429 * pending registration together with a child.
431 static struct gameport
*gameport_get_pending_child(struct gameport
*parent
)
433 struct gameport_event
*event
;
434 struct gameport
*gameport
, *child
= NULL
;
437 spin_lock_irqsave(&gameport_event_lock
, flags
);
439 list_for_each_entry(event
, &gameport_event_list
, node
) {
440 if (event
->type
== GAMEPORT_REGISTER_PORT
) {
441 gameport
= event
->object
;
442 if (gameport
->parent
== parent
) {
449 spin_unlock_irqrestore(&gameport_event_lock
, flags
);
454 * Gameport port operations
457 static ssize_t
gameport_description_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
459 struct gameport
*gameport
= to_gameport_port(dev
);
461 return sprintf(buf
, "%s\n", gameport
->name
);
463 static DEVICE_ATTR(description
, S_IRUGO
, gameport_description_show
, NULL
);
465 static ssize_t
drvctl_store(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
467 struct gameport
*gameport
= to_gameport_port(dev
);
468 struct device_driver
*drv
;
471 error
= mutex_lock_interruptible(&gameport_mutex
);
475 if (!strncmp(buf
, "none", count
)) {
476 gameport_disconnect_port(gameport
);
477 } else if (!strncmp(buf
, "reconnect", count
)) {
478 gameport_reconnect_port(gameport
);
479 } else if (!strncmp(buf
, "rescan", count
)) {
480 gameport_disconnect_port(gameport
);
481 gameport_find_driver(gameport
);
482 } else if ((drv
= driver_find(buf
, &gameport_bus
)) != NULL
) {
483 gameport_disconnect_port(gameport
);
484 error
= gameport_bind_driver(gameport
, to_gameport_driver(drv
));
489 mutex_unlock(&gameport_mutex
);
491 return error
? error
: count
;
493 static DEVICE_ATTR_WO(drvctl
);
495 static struct attribute
*gameport_device_attrs
[] = {
496 &dev_attr_description
.attr
,
497 &dev_attr_drvctl
.attr
,
500 ATTRIBUTE_GROUPS(gameport_device
);
502 static void gameport_release_port(struct device
*dev
)
504 struct gameport
*gameport
= to_gameport_port(dev
);
507 module_put(THIS_MODULE
);
510 void gameport_set_phys(struct gameport
*gameport
, const char *fmt
, ...)
515 vsnprintf(gameport
->phys
, sizeof(gameport
->phys
), fmt
, args
);
518 EXPORT_SYMBOL(gameport_set_phys
);
520 static void gameport_default_trigger(struct gameport
*gameport
)
522 #ifdef CONFIG_HAS_IOPORT
523 outb(0xff, gameport
->io
);
527 static unsigned char gameport_default_read(struct gameport
*gameport
)
529 #ifdef CONFIG_HAS_IOPORT
530 return inb(gameport
->io
);
536 static void gameport_setup_default_handlers(struct gameport
*gameport
)
538 if ((!gameport
->trigger
|| !gameport
->read
) &&
539 !IS_ENABLED(CONFIG_HAS_IOPORT
))
540 dev_err(&gameport
->dev
,
541 "I/O port access is required for %s (%s) but is not available\n",
542 gameport
->phys
, gameport
->name
);
544 if (!gameport
->trigger
)
545 gameport
->trigger
= gameport_default_trigger
;
547 gameport
->read
= gameport_default_read
;
551 * Prepare gameport port for registration.
553 static void gameport_init_port(struct gameport
*gameport
)
555 static atomic_t gameport_no
= ATOMIC_INIT(-1);
557 __module_get(THIS_MODULE
);
559 mutex_init(&gameport
->drv_mutex
);
560 device_initialize(&gameport
->dev
);
561 dev_set_name(&gameport
->dev
, "gameport%lu",
562 (unsigned long)atomic_inc_return(&gameport_no
));
563 gameport
->dev
.bus
= &gameport_bus
;
564 gameport
->dev
.release
= gameport_release_port
;
565 if (gameport
->parent
)
566 gameport
->dev
.parent
= &gameport
->parent
->dev
;
568 gameport_setup_default_handlers(gameport
);
569 INIT_LIST_HEAD(&gameport
->node
);
570 spin_lock_init(&gameport
->timer_lock
);
571 timer_setup(&gameport
->poll_timer
, gameport_run_poll_handler
, 0);
575 * Complete gameport port registration.
576 * Driver core will attempt to find appropriate driver for the port.
578 static void gameport_add_port(struct gameport
*gameport
)
582 if (gameport
->parent
)
583 gameport
->parent
->child
= gameport
;
585 gameport
->speed
= use_ktime
?
586 gameport_measure_speed(gameport
) :
587 old_gameport_measure_speed(gameport
);
589 list_add_tail(&gameport
->node
, &gameport_list
);
592 dev_info(&gameport
->dev
, "%s is %s, io %#x, speed %dkHz\n",
593 gameport
->name
, gameport
->phys
, gameport
->io
, gameport
->speed
);
595 dev_info(&gameport
->dev
, "%s is %s, speed %dkHz\n",
596 gameport
->name
, gameport
->phys
, gameport
->speed
);
598 error
= device_add(&gameport
->dev
);
600 dev_err(&gameport
->dev
,
601 "device_add() failed for %s (%s), error: %d\n",
602 gameport
->phys
, gameport
->name
, error
);
606 * gameport_destroy_port() completes deregistration process and removes
607 * port from the system
609 static void gameport_destroy_port(struct gameport
*gameport
)
611 struct gameport
*child
;
613 child
= gameport_get_pending_child(gameport
);
615 gameport_remove_pending_events(child
);
616 put_device(&child
->dev
);
619 if (gameport
->parent
) {
620 gameport
->parent
->child
= NULL
;
621 gameport
->parent
= NULL
;
624 if (device_is_registered(&gameport
->dev
))
625 device_del(&gameport
->dev
);
627 list_del_init(&gameport
->node
);
629 gameport_remove_pending_events(gameport
);
630 put_device(&gameport
->dev
);
634 * Reconnect gameport port and all its children (re-initialize attached devices)
636 static void gameport_reconnect_port(struct gameport
*gameport
)
639 if (!gameport
->drv
|| !gameport
->drv
->reconnect
|| gameport
->drv
->reconnect(gameport
)) {
640 gameport_disconnect_port(gameport
);
641 gameport_find_driver(gameport
);
642 /* Ok, old children are now gone, we are done */
645 gameport
= gameport
->child
;
650 * gameport_disconnect_port() unbinds a port from its driver. As a side effect
651 * all child ports are unbound and destroyed.
653 static void gameport_disconnect_port(struct gameport
*gameport
)
655 struct gameport
*s
, *parent
;
657 if (gameport
->child
) {
659 * Children ports should be disconnected and destroyed
660 * first, staring with the leaf one, since we don't want
663 for (s
= gameport
; s
->child
; s
= s
->child
)
669 device_release_driver(&s
->dev
);
670 gameport_destroy_port(s
);
671 } while ((s
= parent
) != gameport
);
675 * Ok, no children left, now disconnect this port
677 device_release_driver(&gameport
->dev
);
681 * Submits register request to kgameportd for subsequent execution.
682 * Note that port registration is always asynchronous.
684 void __gameport_register_port(struct gameport
*gameport
, struct module
*owner
)
686 gameport_init_port(gameport
);
687 gameport_queue_event(gameport
, owner
, GAMEPORT_REGISTER_PORT
);
689 EXPORT_SYMBOL(__gameport_register_port
);
692 * Synchronously unregisters gameport port.
694 void gameport_unregister_port(struct gameport
*gameport
)
696 mutex_lock(&gameport_mutex
);
697 gameport_disconnect_port(gameport
);
698 gameport_destroy_port(gameport
);
699 mutex_unlock(&gameport_mutex
);
701 EXPORT_SYMBOL(gameport_unregister_port
);
705 * Gameport driver operations
708 static ssize_t
description_show(struct device_driver
*drv
, char *buf
)
710 struct gameport_driver
*driver
= to_gameport_driver(drv
);
711 return sprintf(buf
, "%s\n", driver
->description
? driver
->description
: "(none)");
713 static DRIVER_ATTR_RO(description
);
715 static struct attribute
*gameport_driver_attrs
[] = {
716 &driver_attr_description
.attr
,
719 ATTRIBUTE_GROUPS(gameport_driver
);
721 static int gameport_driver_probe(struct device
*dev
)
723 struct gameport
*gameport
= to_gameport_port(dev
);
724 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
726 drv
->connect(gameport
, drv
);
727 return gameport
->drv
? 0 : -ENODEV
;
730 static void gameport_driver_remove(struct device
*dev
)
732 struct gameport
*gameport
= to_gameport_port(dev
);
733 struct gameport_driver
*drv
= to_gameport_driver(dev
->driver
);
735 drv
->disconnect(gameport
);
738 static void gameport_attach_driver(struct gameport_driver
*drv
)
742 error
= driver_attach(&drv
->driver
);
744 pr_err("driver_attach() failed for %s, error: %d\n",
745 drv
->driver
.name
, error
);
748 int __gameport_register_driver(struct gameport_driver
*drv
, struct module
*owner
,
749 const char *mod_name
)
753 drv
->driver
.bus
= &gameport_bus
;
754 drv
->driver
.owner
= owner
;
755 drv
->driver
.mod_name
= mod_name
;
758 * Temporarily disable automatic binding because probing
759 * takes long time and we are better off doing it in kgameportd
763 error
= driver_register(&drv
->driver
);
765 pr_err("driver_register() failed for %s, error: %d\n",
766 drv
->driver
.name
, error
);
771 * Reset ignore flag and let kgameportd bind the driver to free ports
774 error
= gameport_queue_event(drv
, NULL
, GAMEPORT_ATTACH_DRIVER
);
776 driver_unregister(&drv
->driver
);
782 EXPORT_SYMBOL(__gameport_register_driver
);
784 void gameport_unregister_driver(struct gameport_driver
*drv
)
786 struct gameport
*gameport
;
788 mutex_lock(&gameport_mutex
);
790 drv
->ignore
= true; /* so gameport_find_driver ignores it */
791 gameport_remove_pending_events(drv
);
794 list_for_each_entry(gameport
, &gameport_list
, node
) {
795 if (gameport
->drv
== drv
) {
796 gameport_disconnect_port(gameport
);
797 gameport_find_driver(gameport
);
798 /* we could've deleted some ports, restart */
803 driver_unregister(&drv
->driver
);
805 mutex_unlock(&gameport_mutex
);
807 EXPORT_SYMBOL(gameport_unregister_driver
);
809 static int gameport_bus_match(struct device
*dev
, const struct device_driver
*drv
)
811 const struct gameport_driver
*gameport_drv
= to_gameport_driver(drv
);
813 return !gameport_drv
->ignore
;
816 static const struct bus_type gameport_bus
= {
818 .dev_groups
= gameport_device_groups
,
819 .drv_groups
= gameport_driver_groups
,
820 .match
= gameport_bus_match
,
821 .probe
= gameport_driver_probe
,
822 .remove
= gameport_driver_remove
,
825 static void gameport_set_drv(struct gameport
*gameport
, struct gameport_driver
*drv
)
827 mutex_lock(&gameport
->drv_mutex
);
829 mutex_unlock(&gameport
->drv_mutex
);
832 int gameport_open(struct gameport
*gameport
, struct gameport_driver
*drv
, int mode
)
834 if (gameport
->open
) {
835 if (gameport
->open(gameport
, mode
)) {
839 if (mode
!= GAMEPORT_MODE_RAW
)
843 gameport_set_drv(gameport
, drv
);
846 EXPORT_SYMBOL(gameport_open
);
848 void gameport_close(struct gameport
*gameport
)
850 del_timer_sync(&gameport
->poll_timer
);
851 gameport
->poll_handler
= NULL
;
852 gameport
->poll_interval
= 0;
853 gameport_set_drv(gameport
, NULL
);
855 gameport
->close(gameport
);
857 EXPORT_SYMBOL(gameport_close
);
859 static int __init
gameport_init(void)
863 error
= bus_register(&gameport_bus
);
865 pr_err("failed to register gameport bus, error: %d\n", error
);
873 static void __exit
gameport_exit(void)
875 bus_unregister(&gameport_bus
);
878 * There should not be any outstanding events but work may
879 * still be scheduled so simply cancel it.
881 cancel_work_sync(&gameport_event_work
);
884 subsys_initcall(gameport_init
);
885 module_exit(gameport_exit
);