]>
git.ipfire.org Git - thirdparty/systemd.git/blob - hwdb/parse_hwdb.py
2 # SPDX-License-Identifier: MIT
4 # This file is distributed under the MIT license, see below.
6 # The MIT License (MIT)
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:
15 # The above copyright notice and this permission notice shall be included in
16 # all copies or substantial portions of the Software.
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
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
,
38 print('pyparsing is not available')
42 from evdev
.ecodes
import ecodes
45 print('WARNING: evdev is not available')
48 from functools
import lru_cache
50 # don't do caching on old python
51 lru_cache
= lambda: (lambda f
: f
)
53 EOL
= LineEnd().suppress()
55 COMMENTLINE
= pythonStyleComment
+ EOL
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
+ '_')
62 TYPES
= {'mouse': ('usb', 'bluetooth', 'ps2', '*'),
63 'evdev': ('name', 'atkbd', 'input'),
64 'id-input': ('modalias'),
65 'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'),
66 'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'),
67 'keyboard': ('name', ),
68 'sensor': ('modalias', ),
73 ParserElement
.setDefaultWhitespaceChars('')
75 prefix
= Or(category
+ ':' + Or(conn
) + ':'
76 for category
, conn
in TYPES
.items())
77 matchline
= Combine(prefix
+ Word(printables
+ ' ' + '®')) + EOL
78 propertyline
= (White(' ', exact
=1).suppress() +
79 Combine(UDEV_TAG
- '=' - Word(alphanums
+ '_=:@*.!-;, "') - Optional(pythonStyleComment
)) +
81 propertycomment
= White(' ', exact
=1) + pythonStyleComment
+ EOL
83 group
= (OneOrMore(matchline('MATCHES*') ^ COMMENTLINE
.suppress()) -
84 OneOrMore(propertyline('PROPERTIES*') ^ propertycomment
.suppress()) -
85 (EMPTYLINE ^
stringEnd()).suppress())
86 commentgroup
= OneOrMore(COMMENTLINE
).suppress() - EMPTYLINE
.suppress()
88 grammar
= OneOrMore(group('GROUPS*') ^ commentgroup
) + stringEnd()
93 def property_grammar():
94 ParserElement
.setDefaultWhitespaceChars(' ')
96 dpi_setting
= (Optional('*')('DEFAULT') + INTEGER('DPI') + Suppress('@') + INTEGER('HZ'))('SETTINGS*')
97 mount_matrix_row
= SIGNED_REAL
+ ',' + SIGNED_REAL
+ ',' + SIGNED_REAL
98 mount_matrix
= (mount_matrix_row
+ ';' + mount_matrix_row
+ ';' + mount_matrix_row
)('MOUNT_MATRIX')
100 props
= (('MOUSE_DPI', Group(OneOrMore(dpi_setting
))),
101 ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER
),
102 ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER
),
103 ('MOUSE_WHEEL_CLICK_COUNT', INTEGER
),
104 ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER
),
105 ('ID_INPUT', Literal('1')),
106 ('ID_INPUT_ACCELEROMETER', Literal('1')),
107 ('ID_INPUT_JOYSTICK', Literal('1')),
108 ('ID_INPUT_KEY', Literal('1')),
109 ('ID_INPUT_KEYBOARD', Literal('1')),
110 ('ID_INPUT_MOUSE', Literal('1')),
111 ('ID_INPUT_POINTINGSTICK', Literal('1')),
112 ('ID_INPUT_SWITCH', Literal('1')),
113 ('ID_INPUT_TABLET', Literal('1')),
114 ('ID_INPUT_TABLET_PAD', Literal('1')),
115 ('ID_INPUT_TOUCHPAD', Literal('1')),
116 ('ID_INPUT_TOUCHSCREEN', Literal('1')),
117 ('ID_INPUT_TRACKBALL', Literal('1')),
118 ('MOUSE_WHEEL_TILT_HORIZONTAL', Literal('1')),
119 ('MOUSE_WHEEL_TILT_VERTICAL', Literal('1')),
120 ('POINTINGSTICK_SENSITIVITY', INTEGER
),
121 ('POINTINGSTICK_CONST_ACCEL', REAL
),
122 ('ID_INPUT_JOYSTICK_INTEGRATION', Or(('internal', 'external'))),
123 ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))),
124 ('XKB_FIXED_LAYOUT', STRING
),
125 ('XKB_FIXED_VARIANT', STRING
),
126 ('KEYBOARD_LED_NUMLOCK', Literal('0')),
127 ('KEYBOARD_LED_CAPSLOCK', Literal('0')),
128 ('ACCEL_MOUNT_MATRIX', mount_matrix
),
129 ('ACCEL_LOCATION', Or(('display', 'base'))),
131 fixed_props
= [Literal(name
)('NAME') - Suppress('=') - val('VALUE')
132 for name
, val
in props
]
133 kbd_props
= [Regex(r
'KEYBOARD_KEY_[0-9a-f]+')('NAME')
135 ('!' ^
(Optional('!') - Word(alphanums
+ '_')))('VALUE')
137 abs_props
= [Regex(r
'EVDEV_ABS_[0-9a-f]{2}')('NAME')
139 Word(nums
+ ':')('VALUE')
142 grammar
= Or(fixed_props
+ kbd_props
+ abs_props
) + EOL
147 def error(fmt
, *args
, **kwargs
):
150 print(fmt
.format(*args
, **kwargs
))
152 def convert_properties(group
):
153 matches
= [m
[0] for m
in group
.MATCHES
]
154 props
= [p
[0] for p
in group
.PROPERTIES
]
155 return matches
, props
158 grammar
= hwdb_grammar()
160 with
open(fname
, 'r', encoding
='UTF-8') as f
:
161 parsed
= grammar
.parseFile(f
)
162 except ParseBaseException
as e
:
163 error('Cannot parse {}: {}', fname
, e
)
165 return [convert_properties(g
) for g
in parsed
.GROUPS
]
167 def check_match_uniqueness(groups
):
168 matches
= sum((group
[0] for group
in groups
), [])
171 for match
in matches
:
173 error('Match {!r} is duplicated', match
)
176 def check_one_default(prop
, settings
):
177 defaults
= [s
for s
in settings
if s
.DEFAULT
]
178 if len(defaults
) > 1:
179 error('More than one star entry: {!r}', prop
)
181 def check_one_mount_matrix(prop
, value
):
182 numbers
= [s
for s
in value
if s
not in {';', ','}]
183 if len(numbers
) != 9:
184 error('Wrong accel matrix: {!r}', prop
)
186 numbers
= [abs(float(number
)) for number
in numbers
]
188 error('Wrong accel matrix: {!r}', prop
)
189 bad_x
, bad_y
, bad_z
= max(numbers
[0:3]) == 0, max(numbers
[3:6]) == 0, max(numbers
[6:9]) == 0
190 if bad_x
or bad_y
or bad_z
:
191 error('Mount matrix is all zero in {} row: {!r}',
192 'x' if bad_x
else ('y' if bad_y
else 'z'),
195 def check_one_keycode(prop
, value
):
196 if value
!= '!' and ecodes
is not None:
197 key
= 'KEY_' + value
.upper()
198 if key
not in ecodes
:
200 if key
not in ecodes
:
201 error('Keycode {} unknown', key
)
203 def check_properties(groups
):
204 grammar
= property_grammar()
205 for matches
, props
in groups
:
209 prop
= prop
.partition('#')[0].rstrip()
211 parsed
= grammar
.parseString(prop
)
212 except ParseBaseException
as e
:
213 error('Failed to parse: {!r}', prop
)
215 # print('{!r}'.format(parsed))
216 if parsed
.NAME
in prop_names
:
217 error('Property {} is duplicated', parsed
.NAME
)
218 prop_names
.add(parsed
.NAME
)
219 if parsed
.NAME
== 'MOUSE_DPI':
220 check_one_default(prop
, parsed
.VALUE
.SETTINGS
)
221 elif parsed
.NAME
== 'ACCEL_MOUNT_MATRIX':
222 check_one_mount_matrix(prop
, parsed
.VALUE
)
223 elif parsed
.NAME
.startswith('KEYBOARD_KEY_'):
224 check_one_keycode(prop
, parsed
.VALUE
)
226 def print_summary(fname
, groups
):
227 print('{}: {} match groups, {} matches, {} properties'
230 sum(len(matches
) for matches
, props
in groups
),
231 sum(len(props
) for matches
, props
in groups
)))
233 if __name__
== '__main__':
234 args
= sys
.argv
[1:] or glob
.glob(os
.path
.dirname(sys
.argv
[0]) + '/[67]0-*.hwdb')
237 groups
= parse(fname
)
238 print_summary(fname
, groups
)
239 check_match_uniqueness(groups
)
240 check_properties(groups
)