summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2017-06-13 12:20:34 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2017-06-13 12:21:33 +1000
commitb3779caef7ea8ade701ae0e0b189200ac2002e34 (patch)
treedff11ab27dbdbec16cda69a6d068a8ffff078c0a
parent42ee99ee4df13ce934bd969d23421c2aa606cb8f (diff)
doc: add a short blurb regarding lid switch handling
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r--doc/switches.dox18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/switches.dox b/doc/switches.dox
index 4bb2675..5153dc2 100644
--- a/doc/switches.dox
+++ b/doc/switches.dox
@@ -13,4 +13,22 @@ specific features based on a switch state.
The order of switch events is guaranteed to be correct, i.e., a switch will
never send consecutive switch on, or switch off, events.
+@section switches_lid Lid switch handling
+
+Where available, libinput listens to devices providing a lid switch.
+The evdev event code `EV_SW` `SW_LID` is provided as @ref
+LIBINPUT_SWITCH_LID. If devices with a lid switch have a touchpad device,
+the device is disabled while the lid is logically closed. This is to avoid
+ghost touches that can be caused by interference with touchpads and the
+closed lid. The touchpad is automatically re-enabled whenever the lid is
+openend.
+
+This handling of lid switches is transparent to the user, no notifications
+are sent and the device appears as enabled at all times.
+
+On some devices, the device's lid state does not always reflect the physical
+state and the lid state may report as closed even when the lid is physicall
+open. libinput employs some heuristics to detect user input (specificially
+typing) to re-enable the touchpad on those devices.
+
*/