diff --git a/doc/user/meson.build b/doc/user/meson.build index fb2461dd..fce6ec15 100644 --- a/doc/user/meson.build +++ b/doc/user/meson.build @@ -153,6 +153,7 @@ src_rst = files( 'tapping.rst', 'test-suite.rst', 'timestamps.rst', + 'tablet-debugging.rst', 'tools.rst', 'touchpad-jumping-cursors.rst', 'touchpad-pressure.rst', diff --git a/doc/user/tablet-debugging.rst b/doc/user/tablet-debugging.rst new file mode 100644 index 00000000..2676650d --- /dev/null +++ b/doc/user/tablet-debugging.rst @@ -0,0 +1,44 @@ +.. _tablet-debugging: + +============================================================================== +Debugging tablet issues +============================================================================== + +.. _tablet-capabilities: + +------------------------------------------------------------------------------ +Required tablet capabilities +------------------------------------------------------------------------------ + +To handle a tablet correctly, libinput requires a set of capabilities +on the device. When these capabilities are missing, libinput ignores the +device and prints an error to the log. This error messages reads + +:: + + missing tablet capabilities: xy pen btn-stylus resolution. Ignoring this device. + +or in older versions of libinput simply: + +:: + + libinput bug: device does not meet tablet criteria. Ignoring this device. + + +When a tablet is rejected, it is usually possible to verify the issue with +the ``libinput record`` tool. + +- **xy** indicates that the tablet is missing the ``ABS_X`` and/or ``ABS_Y`` + axis. This indicates that the device is mislabelled and the udev tag + ``ID_INPUT_TABLET`` is applied to a device that is not a tablet. + A bug should be filed against `systemd `__. +- **pen** or **btn-stylus** indicates that the tablet does not have the + ``BTN_TOOL_PEN`` or ``BTN_STYLUS`` bit set. libinput requires either or both + of them to be present. This indicates a bug in the kernel driver + or the HID descriptors of the device. +- **resolution** indicates that the device does not have a resolution set + for the x and y axes. This can be fixed with a hwdb entry, locate and read + the `60-evdev.hwdb + `__ file + on your machine and file a pull request with the fixes against + `systemd `__. diff --git a/doc/user/tablet-support.rst b/doc/user/tablet-support.rst index 104ea448..c9adb814 100644 --- a/doc/user/tablet-support.rst +++ b/doc/user/tablet-support.rst @@ -422,37 +422,3 @@ libinput uses the **libinput_device_group** to decide on touch arbitration and automatically discards touch events whenever a tool is in proximity. The exact behavior is device-dependent. -.. _tablet-capabilities: - ------------------------------------------------------------------------------- -Required tablet capabilities ------------------------------------------------------------------------------- - -To handle a tablet correctly, libinput requires a set of capabilities -on the device. When these capabilities are missing, libinput ignores the -device and prints an error to the log. This error messages reads - -:: - - missing tablet capabilities: xy pen btn-stylus resolution. Ignoring this device. - -or in older versions of libinput simply: - -:: - - libinput bug: device does not meet tablet criteria. Ignoring this device. - - -When a tablet is rejected, it is usually possible to check the issue with -the ``evemu-descibe`` tool. - -- **xy** indicates that the tablet is missing the ``ABS_X`` and/or ``ABS_Y`` - axis. This indicates that the device is mislabelled and the udev tag - ``ID_INPUT_TABLET`` is applied to a device that is not a tablet. -- **pen** or **btn-stylus** indicates that the tablet does not have the - ``BTN_TOOL_PEN`` or ``BTN_STYLUS`` bit set. libinput requires either or both - of them to be present. This usually indicates a bug in the kernel driver - or the HID descriptors of the device. -- **resolution** indicates that the device does not have a resolution set - for the x and y axes. This can be fixed with a hwdb entry, locate and read - the 60-evdev.hwdb file on your machine to address this. diff --git a/doc/user/troubleshooting.rst b/doc/user/troubleshooting.rst index da7c9f42..a66f96c2 100644 --- a/doc/user/troubleshooting.rst +++ b/doc/user/troubleshooting.rst @@ -13,3 +13,4 @@ Troubleshooting touchpad-jitter.rst touchpad-pressure-debugging.rst trackpoint-configuration.rst + tablet-debugging.rst