]>
Commit | Line | Data |
---|---|---|
1 | #!/usr/bin/env python3 | |
2 | # SPDX-License-Identifier: MIT | |
3 | # | |
4 | # This file is distributed under the MIT license, see below. | |
5 | # | |
6 | # The MIT License (MIT) | |
7 | # | |
8 | # Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | # of this software and associated documentation files (the "Software"), to deal | |
10 | # in the Software without restriction, including without limitation the rights | |
11 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | # copies of the Software, and to permit persons to whom the Software is | |
13 | # furnished to do so, subject to the following conditions: | |
14 | # | |
15 | # The above copyright notice and this permission notice shall be included in | |
16 | # all copies or substantial portions of the Software. | |
17 | # | |
18 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | # SOFTWARE. | |
25 | ||
26 | import glob | |
27 | import string | |
28 | import sys | |
29 | import os | |
30 | ||
31 | try: | |
32 | from pyparsing import (Word, White, Literal, ParserElement, Regex, LineEnd, | |
33 | OneOrMore, Combine, Or, Optional, Suppress, Group, | |
34 | nums, alphanums, printables, | |
35 | stringEnd, pythonStyleComment, QuotedString, | |
36 | ParseBaseException) | |
37 | except ImportError: | |
38 | print('pyparsing is not available') | |
39 | sys.exit(77) | |
40 | ||
41 | try: | |
42 | from evdev.ecodes import ecodes | |
43 | except ImportError: | |
44 | ecodes = None | |
45 | print('WARNING: evdev is not available') | |
46 | ||
47 | try: | |
48 | from functools import lru_cache | |
49 | except ImportError: | |
50 | # don't do caching on old python | |
51 | lru_cache = lambda: (lambda f: f) | |
52 | ||
53 | EOL = LineEnd().suppress() | |
54 | EMPTYLINE = LineEnd() | |
55 | COMMENTLINE = pythonStyleComment + EOL | |
56 | INTEGER = Word(nums) | |
57 | STRING = QuotedString('"') | |
58 | REAL = Combine((INTEGER + Optional('.' + Optional(INTEGER))) ^ ('.' + INTEGER)) | |
59 | SIGNED_REAL = Combine(Optional(Word('-+')) + REAL) | |
60 | UDEV_TAG = Word(string.ascii_uppercase, alphanums + '_') | |
61 | ||
62 | # Those patterns are used in type-specific matches | |
63 | TYPES = {'mouse': ('usb', 'bluetooth', 'ps2', '*'), | |
64 | 'evdev': ('name', 'atkbd', 'input'), | |
65 | 'id-input': ('modalias'), | |
66 | 'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'), | |
67 | 'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'), | |
68 | 'keyboard': ('name', ), | |
69 | 'sensor': ('modalias', ), | |
70 | } | |
71 | ||
72 | # Patterns that are used to set general properties on a device | |
73 | GENERAL_MATCHES = {'acpi', | |
74 | 'bluetooth', | |
75 | 'usb', | |
76 | 'pci', | |
77 | 'sdio', | |
78 | 'vmbus', | |
79 | 'OUI', | |
80 | } | |
81 | ||
82 | @lru_cache() | |
83 | def hwdb_grammar(): | |
84 | ParserElement.setDefaultWhitespaceChars('') | |
85 | ||
86 | prefix = Or(category + ':' + Or(conn) + ':' | |
87 | for category, conn in TYPES.items()) | |
88 | ||
89 | matchline_typed = Combine(prefix + Word(printables + ' ' + '®')) | |
90 | matchline_general = Combine(Or(GENERAL_MATCHES) + ':' + Word(printables + ' ' + '®')) | |
91 | matchline = (matchline_typed | matchline_general) + EOL | |
92 | ||
93 | propertyline = (White(' ', exact=1).suppress() + | |
94 | Combine(UDEV_TAG - '=' - Word(alphanums + '_=:@*.!-;, "') - Optional(pythonStyleComment)) + | |
95 | EOL) | |
96 | propertycomment = White(' ', exact=1) + pythonStyleComment + EOL | |
97 | ||
98 | group = (OneOrMore(matchline('MATCHES*') ^ COMMENTLINE.suppress()) - | |
99 | OneOrMore(propertyline('PROPERTIES*') ^ propertycomment.suppress()) - | |
100 | (EMPTYLINE ^ stringEnd()).suppress()) | |
101 | commentgroup = OneOrMore(COMMENTLINE).suppress() - EMPTYLINE.suppress() | |
102 | ||
103 | grammar = OneOrMore(Group(group)('GROUPS*') ^ commentgroup) + stringEnd() | |
104 | ||
105 | return grammar | |
106 | ||
107 | @lru_cache() | |
108 | def property_grammar(): | |
109 | ParserElement.setDefaultWhitespaceChars(' ') | |
110 | ||
111 | dpi_setting = (Optional('*')('DEFAULT') + INTEGER('DPI') + Suppress('@') + INTEGER('HZ'))('SETTINGS*') | |
112 | mount_matrix_row = SIGNED_REAL + ',' + SIGNED_REAL + ',' + SIGNED_REAL | |
113 | mount_matrix = (mount_matrix_row + ';' + mount_matrix_row + ';' + mount_matrix_row)('MOUNT_MATRIX') | |
114 | ||
115 | props = (('MOUSE_DPI', Group(OneOrMore(dpi_setting))), | |
116 | ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER), | |
117 | ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER), | |
118 | ('MOUSE_WHEEL_CLICK_COUNT', INTEGER), | |
119 | ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER), | |
120 | ('ID_AUTOSUSPEND', Literal('1')), | |
121 | ('ID_INPUT', Literal('1')), | |
122 | ('ID_INPUT_ACCELEROMETER', Literal('1')), | |
123 | ('ID_INPUT_JOYSTICK', Literal('1')), | |
124 | ('ID_INPUT_KEY', Literal('1')), | |
125 | ('ID_INPUT_KEYBOARD', Literal('1')), | |
126 | ('ID_INPUT_MOUSE', Literal('1')), | |
127 | ('ID_INPUT_POINTINGSTICK', Literal('1')), | |
128 | ('ID_INPUT_SWITCH', Literal('1')), | |
129 | ('ID_INPUT_TABLET', Literal('1')), | |
130 | ('ID_INPUT_TABLET_PAD', Literal('1')), | |
131 | ('ID_INPUT_TOUCHPAD', Literal('1')), | |
132 | ('ID_INPUT_TOUCHSCREEN', Literal('1')), | |
133 | ('ID_INPUT_TRACKBALL', Literal('1')), | |
134 | ('POINTINGSTICK_SENSITIVITY', INTEGER), | |
135 | ('POINTINGSTICK_CONST_ACCEL', REAL), | |
136 | ('ID_INPUT_JOYSTICK_INTEGRATION', Or(('internal', 'external'))), | |
137 | ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))), | |
138 | ('XKB_FIXED_LAYOUT', STRING), | |
139 | ('XKB_FIXED_VARIANT', STRING), | |
140 | ('XKB_FIXED_MODEL', STRING), | |
141 | ('KEYBOARD_LED_NUMLOCK', Literal('0')), | |
142 | ('KEYBOARD_LED_CAPSLOCK', Literal('0')), | |
143 | ('ACCEL_MOUNT_MATRIX', mount_matrix), | |
144 | ('ACCEL_LOCATION', Or(('display', 'base'))), | |
145 | ('PROXIMITY_NEAR_LEVEL', INTEGER), | |
146 | ) | |
147 | fixed_props = [Literal(name)('NAME') - Suppress('=') - val('VALUE') | |
148 | for name, val in props] | |
149 | kbd_props = [Regex(r'KEYBOARD_KEY_[0-9a-f]+')('NAME') | |
150 | - Suppress('=') - | |
151 | ('!' ^ (Optional('!') - Word(alphanums + '_')))('VALUE') | |
152 | ] | |
153 | abs_props = [Regex(r'EVDEV_ABS_[0-9a-f]{2}')('NAME') | |
154 | - Suppress('=') - | |
155 | Word(nums + ':')('VALUE') | |
156 | ] | |
157 | ||
158 | grammar = Or(fixed_props + kbd_props + abs_props) + EOL | |
159 | ||
160 | return grammar | |
161 | ||
162 | ERROR = False | |
163 | def error(fmt, *args, **kwargs): | |
164 | global ERROR | |
165 | ERROR = True | |
166 | print(fmt.format(*args, **kwargs)) | |
167 | ||
168 | def convert_properties(group): | |
169 | matches = [m[0] for m in group.MATCHES] | |
170 | props = [p[0] for p in group.PROPERTIES] | |
171 | return matches, props | |
172 | ||
173 | def parse(fname): | |
174 | grammar = hwdb_grammar() | |
175 | try: | |
176 | with open(fname, 'r', encoding='UTF-8') as f: | |
177 | parsed = grammar.parseFile(f) | |
178 | except ParseBaseException as e: | |
179 | error('Cannot parse {}: {}', fname, e) | |
180 | return [] | |
181 | return [convert_properties(g) for g in parsed.GROUPS] | |
182 | ||
183 | def check_match_uniqueness(groups): | |
184 | matches = sum((group[0] for group in groups), []) | |
185 | matches.sort() | |
186 | prev = None | |
187 | for match in matches: | |
188 | if match == prev: | |
189 | error('Match {!r} is duplicated', match) | |
190 | prev = match | |
191 | ||
192 | def check_one_default(prop, settings): | |
193 | defaults = [s for s in settings if s.DEFAULT] | |
194 | if len(defaults) > 1: | |
195 | error('More than one star entry: {!r}', prop) | |
196 | ||
197 | def check_one_mount_matrix(prop, value): | |
198 | numbers = [s for s in value if s not in {';', ','}] | |
199 | if len(numbers) != 9: | |
200 | error('Wrong accel matrix: {!r}', prop) | |
201 | try: | |
202 | numbers = [abs(float(number)) for number in numbers] | |
203 | except ValueError: | |
204 | error('Wrong accel matrix: {!r}', prop) | |
205 | bad_x, bad_y, bad_z = max(numbers[0:3]) == 0, max(numbers[3:6]) == 0, max(numbers[6:9]) == 0 | |
206 | if bad_x or bad_y or bad_z: | |
207 | error('Mount matrix is all zero in {} row: {!r}', | |
208 | 'x' if bad_x else ('y' if bad_y else 'z'), | |
209 | prop) | |
210 | ||
211 | def check_one_keycode(prop, value): | |
212 | if value != '!' and ecodes is not None: | |
213 | key = 'KEY_' + value.upper() | |
214 | if not (key in ecodes or | |
215 | value.upper() in ecodes or | |
216 | # new keys added in kernel 5.5 | |
217 | 'KBD_LCD_MENU' in key): | |
218 | error('Keycode {} unknown', key) | |
219 | ||
220 | def check_properties(groups): | |
221 | grammar = property_grammar() | |
222 | for matches, props in groups: | |
223 | prop_names = set() | |
224 | for prop in props: | |
225 | # print('--', prop) | |
226 | prop = prop.partition('#')[0].rstrip() | |
227 | try: | |
228 | parsed = grammar.parseString(prop) | |
229 | except ParseBaseException as e: | |
230 | error('Failed to parse: {!r}', prop) | |
231 | continue | |
232 | # print('{!r}'.format(parsed)) | |
233 | if parsed.NAME in prop_names: | |
234 | error('Property {} is duplicated', parsed.NAME) | |
235 | prop_names.add(parsed.NAME) | |
236 | if parsed.NAME == 'MOUSE_DPI': | |
237 | check_one_default(prop, parsed.VALUE.SETTINGS) | |
238 | elif parsed.NAME == 'ACCEL_MOUNT_MATRIX': | |
239 | check_one_mount_matrix(prop, parsed.VALUE) | |
240 | elif parsed.NAME.startswith('KEYBOARD_KEY_'): | |
241 | val = parsed.VALUE if isinstance(parsed.VALUE, str) else parsed.VALUE[0] | |
242 | check_one_keycode(prop, val) | |
243 | ||
244 | def print_summary(fname, groups): | |
245 | n_matches = sum(len(matches) for matches, props in groups) | |
246 | n_props = sum(len(props) for matches, props in groups) | |
247 | print('{}: {} match groups, {} matches, {} properties' | |
248 | .format(fname, len(groups), n_matches, n_props)) | |
249 | ||
250 | if n_matches == 0 or n_props == 0: | |
251 | error('{}: no matches or props'.format(fname)) | |
252 | ||
253 | if __name__ == '__main__': | |
254 | args = sys.argv[1:] or sorted(glob.glob(os.path.dirname(sys.argv[0]) + '/[67][0-9]-*.hwdb')) | |
255 | ||
256 | for fname in args: | |
257 | groups = parse(fname) | |
258 | print_summary(fname, groups) | |
259 | check_match_uniqueness(groups) | |
260 | check_properties(groups) | |
261 | ||
262 | sys.exit(ERROR) |