5792af9a5f
Previously, we had all extra device information ("This is an Apple Touchpad",
"This touchpad causes pointer jumps", etc.) in the udev hwdb. The problem with
the hwdb is that updating it is nontrivial for the average user and debugging
when things go wrong is even harder. Plus, the hwdb has a matching scheme that
is unpredictable unless one is familiar with the implementation.
This patch set moves the hwdb entries into .ini style text files, with a
simple line-based parser. A new libinput list-quirks tool can list the quirks
applied to any given device, in --verbose mode it prints all matches as they
apply or not apply.
The data files are currently unused by libinput, that comes in a later patch.
They're installed though, the defaults point to the /usr/share/libinput
directory and for *temporary* local overrides the single file
/etc/libinput/local-overrides.quirks.
Failure to parse any file is a hard failure for the quirks system, but if the
local override file doesn't exist that's fine.
THIS IS NOT A CONFIGURATION INTERFACE! None of these settings are exposed via
the libinput_device_config_* calls. There is no API guarantee for these files,
think of them as source code.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
|
||
|---|---|---|
| .. | ||
| 10-generic-keyboard.quirks | ||
| 10-generic-lid.quirks | ||
| 10-generic-trackball.quirks | ||
| 30-vendor-aiptek.quirks | ||
| 30-vendor-alps.quirks | ||
| 30-vendor-cyapa.quirks | ||
| 30-vendor-elantech.quirks | ||
| 30-vendor-huion.quirks | ||
| 30-vendor-ibm.quirks | ||
| 30-vendor-logitech.quirks | ||
| 30-vendor-microsoft.quirks | ||
| 30-vendor-razer.quirks | ||
| 30-vendor-synaptics.quirks | ||
| 30-vendor-wacom.quirks | ||
| 50-system-apple.quirks | ||
| 50-system-asus.quirks | ||
| 50-system-chicony.quirks | ||
| 50-system-cyborg.quirks | ||
| 50-system-dell.quirks | ||
| 50-system-google.quirks | ||
| 50-system-hp.quirks | ||
| 50-system-lenovo.quirks | ||
| 50-system-system76.quirks | ||
| README.md | ||
= libinput data file format =
This directory contains hardware quirks used by libinput to work around bugs in the hardware, device behavior and to supply information not obtained through the kernel device.
THIS IS NOT STABLE API
The data format may change at any time. If your data file is not part of the libinput git tree, do not expect it to work after an update. Absolutely no guarantees are made for backwards-compatibility.
THIS IS NOT A CONFIGURATION API
Use the libinput_device_config_foo() functions for device configuration.
The quirks are hardware quirks only.
== Data file naming ==
Data files are read in versionsort order, read order determines how values override each other. A values read later override previously values. The current structure is 10-generic-foo.quirks for generic settings, 30-vendor-foo.quirks for vendor-specific settings and 50-system-foo.quirks for system vendors. This is not a fixed naming scheme and may change at any time. It's an approximation only because some vendors are also system vendors, e.g. Microsoft makes devices and laptops.
Laptop-specific quirks should always go into the laptop vendor's file.
== Sections, matches and values ==
A data file must contain at least one section, each section must have at
least one Match tag and at least one of either Attr or Model. Section
names are free-form and may contain spaces.
# This is a comment
[Some touchpad]
MatchBus=usb
# No quotes around strings
MatchName=*Synaptics Touchpad*
AttrSizeHint=50x50
ModelSynapticsTouchpad=1
[Apple touchpad]
MatchVendor=0x5AC
MatchProduct=0x123
ModelAppleTouchpad=1
Comments are lines starting with #.
All Model tags take a value of either 1 or 0.
All Attr tag values are specific to that attribute.
== Parser errors ==
The following will cause parser errors and are considered invalid data files:
- Whitespace at the beginning of the line
- Inline comments, e.g.
MatchBus=usb # oops, fail - Sections without at least one
Match*entry - Sections with the same
Match*entry repeated - Sections without at least one of
Model*orAttrentries - A
Modeltag with a value other than1or0 - A string property with enclosing quotes
== Debugging ==
When modifying a data file, use the libinput list-quirks tool to
verify the changes. The tool can be pointed at the data directory to
analyse, use --verbose to get more info. For example:
libinput list-quirks --data-dir /path/to/git/repo/data/ --verbose /dev/input/event0