Commit 76a67822 authored by Brendan Connelly's avatar Brendan Connelly Committed by Jonathan Corbet
Browse files

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: default avatarBrendan Connelly <brendanjconnelly17@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250208173554.209688-1-brendanjconnelly17@gmail.com
parent 4dd4eef6

Documentation/input/input-programming.rst

+19 −0
Original line number Diff line number Diff line
@@ -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.