[<prev] [next>] [day] [month] [year] [list]
Message-Id: <20250208173554.209688-1-brendanjconnelly17@gmail.com>
Date: Sat, 8 Feb 2025 12:35:54 -0500
From: Brendan Connelly <brendanjconnelly17@...il.com>
To: corbet@....net
Cc: linux-kernel@...r.kernel.org,
linux-doc@...r.kernel.org,
dmitry.torokhov@...il.com
Subject: [PATCH] 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 <brendanjconnelly17@...il.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
Powered by blists - more mailing lists