From: Brendan Connelly Date: Sat, 8 Feb 2025 17:35:54 +0000 (-0500) Subject: Documentation: input: Add section pertaining to polled input devices X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=76a6782284dff53a08b688fdead3e46f22236e71;p=users%2Fdwmw2%2Flinux.git Documentation: input: Add section pertaining to polled input devices Added section in Documentation/input/input-programming.rst about input_setup_polling() and input_set_poll_interval() Signed-off-by: Brendan Connelly Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20250208173554.209688-1-brendanjconnelly17@gmail.com --- diff --git a/Documentation/input/input-programming.rst b/Documentation/input/input-programming.rst index c9264814c7aa6..2b3e6a34e34bd 100644 --- a/Documentation/input/input-programming.rst +++ b/Documentation/input/input-programming.rst @@ -346,3 +346,22 @@ driver can handle these events, it has to set the respective bits in evbit, This callback routine can be called from an interrupt or a BH (although that isn't a rule), and thus must not sleep, and must not take too long to finish. + +Polled input devices +~~~~~~~~~~~~~~~~~~~~ + +Input polling is set up by passing an input device struct and a callback to +the function:: + + int input_setup_polling(struct input_dev *dev, + void (*poll_fn)(struct input_dev *dev)) + +Within the callback, devices should use the regular input_report_* functions +and input_sync as is used by other devices. + +There is also the function:: + + void input_set_poll_interval(struct input_dev *dev, unsigned int interval) + +which is used to configure the interval, in milliseconds, that the device will +be polled at.