[PATCH] Documentation: input: Add section pertaining to polled input devices

[PATCH] Documentation: input: Add section pertaining to polled input devices

[Brendan Connelly]

Added section in Documentation/input/input-programming.rst about
input_setup_polling() and input_set_poll_interval()

Signed-off-by: Brendan Connelly <brendanjconnelly17@gmail.com>
---
 Documentation/input/input-programming.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/Documentation/input/input-programming.rst b/Documentation/input/input-programming.rst
index c9264814c7aa..2b3e6a34e34b 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.
-- 
2.39.5

Re: [PATCH] Documentation: input: Add section pertaining to polled input devices

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 837 bytes --]

On Sat, Feb 08, 2025 at 12:35:54PM -0500, Brendan Connelly wrote:
> +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.

Looks good, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] Documentation: input: Add section pertaining to polled input devices

[Jonathan Corbet]

Brendan Connelly <brendanjconnelly17@gmail.com> writes:

> Added section in Documentation/input/input-programming.rst about
> input_setup_polling() and input_set_poll_interval()
>
> Signed-off-by: Brendan Connelly <brendanjconnelly17@gmail.com>
> ---
>  Documentation/input/input-programming.rst | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)

Applied, thanks.

jon