# SOFTWARE.
import glob
+import os
import string
import sys
-import os
try:
- from pyparsing import (Word, White, Literal, ParserElement, Regex, LineEnd,
- OneOrMore, Combine, Or, Optional, Suppress, Group,
- nums, alphanums, printables,
- stringEnd, pythonStyleComment,
- ParseBaseException)
+ from pyparsing import (
+ Combine,
+ Group,
+ LineEnd,
+ Literal,
+ OneOrMore,
+ Optional,
+ Or,
+ ParseBaseException,
+ ParserElement,
+ Regex,
+ Suppress,
+ White,
+ Word,
+ alphanums,
+ nums,
+ printables,
+ pythonStyleComment,
+ stringEnd,
+ )
except ImportError:
print('pyparsing is not available')
sys.exit(77)
ecodes = None
print('WARNING: evdev is not available')
-try:
- from functools import lru_cache
-except ImportError:
- # don't do caching on old python
- lru_cache = lambda: (lambda f: f)
+from functools import lru_cache
EOL = LineEnd().suppress()
EMPTYLINE = LineEnd()
UDEV_TAG = Word(string.ascii_uppercase, alphanums + '_')
# Those patterns are used in type-specific matches
-TYPES = {'mouse': ('usb', 'bluetooth', 'ps2', '*'),
- 'evdev': ('name', 'atkbd', 'input'),
- 'fb': ('pci', 'vmbus'),
- 'id-input': ('modalias', 'bluetooth', 'i2c', 'usb'),
- 'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'),
- 'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'),
- 'keyboard': ('name', ),
- 'sensor': ('modalias',
- 'accel-base',
- 'accel-display',
- 'accel-camera',
- 'proximity-palmrest',
- 'proximity-palmrest-left',
- 'proximity-palmrest-right',
- 'proximity-lap',
- 'proximity-wifi',
- 'proximity-lte',
- 'proximity-wifi-lte',
- 'proximity-wifi-left',
- 'proximity-wifi-right',
- ),
- 'ieee1394-unit-function' : ('node', ),
- 'camera': ('usb'),
- }
+TYPES = {
+ 'mouse': ('usb', 'bluetooth', 'ps2', '*'),
+ 'evdev': ('name', 'atkbd', 'input'),
+ 'fb': ('pci', 'vmbus'),
+ 'id-input': ('modalias', 'bluetooth', 'i2c', 'usb'),
+ 'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'),
+ 'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'),
+ 'keyboard': ('name',),
+ 'sensor': (
+ 'modalias',
+ 'accel-base',
+ 'accel-display',
+ 'accel-camera',
+ 'proximity-palmrest',
+ 'proximity-palmrest-left',
+ 'proximity-palmrest-right',
+ 'proximity-lap',
+ 'proximity-wifi',
+ 'proximity-lte',
+ 'proximity-wifi-lte',
+ 'proximity-wifi-left',
+ 'proximity-wifi-right',
+ ),
+ 'ieee1394-unit-function': ('node',),
+ 'camera': ('usb'),
+}
# Patterns that are used to set general properties on a device
-GENERAL_MATCHES = {'acpi',
- 'bluetooth',
- 'dmi',
- 'ieee1394',
- 'OUI',
- 'pci',
- 'sdio',
- 'tpm2',
- 'usb',
- 'vmbus',
- }
+GENERAL_MATCHES = {
+ 'acpi',
+ 'bluetooth',
+ 'dmi',
+ 'ieee1394',
+ 'OUI',
+ 'pci',
+ 'sdio',
+ 'tpm2',
+ 'usb',
+ 'vmbus',
+}
+
def upperhex_word(length):
return Word(nums + 'ABCDEF', exact=length)
-@lru_cache()
+
+@lru_cache
def hwdb_grammar():
ParserElement.setDefaultWhitespaceChars('')
- prefix = Or(category + ':' + Or(conn) + ':'
- for category, conn in TYPES.items())
+ prefix = Or(category + ':' + Or(conn) + ':' for category, conn in TYPES.items())
matchline_typed = Combine(prefix + Word(printables + ' ' + '®'))
matchline_general = Combine(Or(GENERAL_MATCHES) + ':' + Word(printables + ' ' + '®'))
matchline = (matchline_typed | matchline_general) + EOL
- propertyline = (White(' ', exact=1).suppress() +
- Combine(UDEV_TAG - '=' - Optional(Word(alphanums + '_=:@*.!-;, "/?&'))
- - Optional(pythonStyleComment)) +
- EOL)
+ propertyline = (
+ White(' ', exact=1).suppress()
+ + Combine(
+ UDEV_TAG - '=' - Optional(Word(alphanums + '_=:@*.!-;, "/?&')) - Optional(pythonStyleComment)
+ )
+ + EOL
+ )
propertycomment = White(' ', exact=1) + pythonStyleComment + EOL
- group = (OneOrMore(matchline('MATCHES*') ^ COMMENTLINE.suppress()) -
- OneOrMore(propertyline('PROPERTIES*') ^ propertycomment.suppress()) -
- (EMPTYLINE ^ stringEnd()).suppress())
+ group = (
+ OneOrMore(matchline('MATCHES*') ^ COMMENTLINE.suppress())
+ - OneOrMore(propertyline('PROPERTIES*') ^ propertycomment.suppress())
+ - (EMPTYLINE ^ stringEnd()).suppress()
+ )
commentgroup = OneOrMore(COMMENTLINE).suppress() - EMPTYLINE.suppress()
grammar = OneOrMore(Group(group)('GROUPS*') ^ commentgroup) + stringEnd()
return grammar
-@lru_cache()
+
+@lru_cache
def property_grammar():
ParserElement.setDefaultWhitespaceChars(' ')
- dpi_setting = Group(Optional('*')('DEFAULT') + INTEGER('DPI') + Optional(Suppress('@') + INTEGER('HZ')))('SETTINGS*')
+ dpi_setting = Group(Optional('*')('DEFAULT') + INTEGER('DPI') + Optional(Suppress('@') + INTEGER('HZ')))(
+ 'SETTINGS*'
+ )
mount_matrix_row = SIGNED_REAL + ',' + SIGNED_REAL + ',' + SIGNED_REAL
mount_matrix = Group(mount_matrix_row + ';' + mount_matrix_row + ';' + mount_matrix_row)('MOUNT_MATRIX')
xkb_setting = Optional(Word(alphanums + '+-/@._'))
# Although this set doesn't cover all of characters in database entries, it's enough for test targets.
name_literal = Word(printables + ' ')
- props = (('MOUSE_DPI', Group(OneOrMore(dpi_setting))),
- ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER),
- ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER),
- ('MOUSE_WHEEL_CLICK_COUNT', INTEGER),
- ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER),
- ('ID_INPUT_3D_MOUSE', zero_one),
- ('ID_AUTOSUSPEND', zero_one),
- ('ID_AUTOSUSPEND_DELAY_MS', INTEGER),
- ('ID_AV_PRODUCTION_CONTROLLER', zero_one),
- ('ID_AV_LIGHTS', zero_one),
- ('ID_PERSIST', zero_one),
- ('ID_PDA', zero_one),
- ('ID_INPUT', id_input_setting),
- ('ID_INPUT_ACCELEROMETER', id_input_setting),
- ('ID_INPUT_JOYSTICK', id_input_setting),
- ('ID_INPUT_KEY', id_input_setting),
- ('ID_INPUT_KEYBOARD', id_input_setting),
- ('ID_INPUT_MOUSE', id_input_setting),
- ('ID_INPUT_POINTINGSTICK', id_input_setting),
- ('ID_INPUT_SWITCH', id_input_setting),
- ('ID_INPUT_TABLET', id_input_setting),
- ('ID_INPUT_TABLET_PAD', id_input_setting),
- ('ID_INPUT_TOUCHPAD', id_input_setting),
- ('ID_INPUT_TOUCHSCREEN', id_input_setting),
- ('ID_INPUT_TRACKBALL', id_input_setting),
- ('ID_SIGNAL_ANALYZER', zero_one),
- ('ID_MAKER_TOOL', zero_one),
- ('ID_HARDWARE_WALLET', zero_one),
- ('ID_SOFTWARE_RADIO', zero_one),
- ('ID_MM_DEVICE_IGNORE', zero_one),
- ('ID_NET_AUTO_LINK_LOCAL_ONLY', zero_one),
- ('POINTINGSTICK_SENSITIVITY', INTEGER),
- ('ID_INTEGRATION', Or(('internal', 'external'))),
- ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))),
- ('XKB_FIXED_LAYOUT', xkb_setting),
- ('XKB_FIXED_VARIANT', xkb_setting),
- ('XKB_FIXED_MODEL', xkb_setting),
- ('KEYBOARD_LED_NUMLOCK', Literal('0')),
- ('KEYBOARD_LED_CAPSLOCK', Literal('0')),
- ('ACCEL_MOUNT_MATRIX', mount_matrix),
- ('ACCEL_LOCATION', Or(('display', 'base'))),
- ('PROXIMITY_NEAR_LEVEL', INTEGER),
- ('IEEE1394_UNIT_FUNCTION_MIDI', zero_one),
- ('IEEE1394_UNIT_FUNCTION_AUDIO', zero_one),
- ('IEEE1394_UNIT_FUNCTION_VIDEO', zero_one),
- ('ID_VENDOR_FROM_DATABASE', name_literal),
- ('ID_MODEL_FROM_DATABASE', name_literal),
- ('ID_TAG_MASTER_OF_SEAT', Literal('1')),
- ('ID_INFRARED_CAMERA', zero_one),
- ('ID_CAMERA_DIRECTION', Or(('front', 'rear'))),
- ('SOUND_FORM_FACTOR', Or(('internal', 'webcam', 'speaker', 'headphone', 'headset', 'handset', 'microphone'))),
- ('ID_SYS_VENDOR_IS_RUBBISH', zero_one),
- ('ID_PRODUCT_NAME_IS_RUBBISH', zero_one),
- ('ID_PRODUCT_VERSION_IS_RUBBISH', zero_one),
- ('ID_BOARD_VERSION_IS_RUBBISH', zero_one),
- ('ID_PRODUCT_SKU_IS_RUBBISH', zero_one),
- ('ID_CHASSIS_ASSET_TAG_IS_RUBBISH', zero_one),
- ('ID_CHASSIS', name_literal),
- ('ID_SYSFS_ATTRIBUTE_MODEL', name_literal),
- ('ID_NET_NAME_FROM_DATABASE', name_literal),
- ('ID_NET_NAME_INCLUDE_DOMAIN', zero_one),
- ('TPM2_BROKEN_NVPCR', zero_one),
- ('IMDS_VENDOR', name_literal),
- ('IMDS_TOKEN_URL', name_literal),
- ('IMDS_REFRESH_HEADER_NAME', name_literal),
- ('IMDS_DATA_URL', name_literal),
- ('IMDS_DATA_URL_SUFFIX', name_literal),
- ('IMDS_TOKEN_HEADER_NAME', name_literal),
- ('IMDS_EXTRA_HEADER', name_literal),
- ('IMDS_ADDRESS_IPV4', name_literal),
- ('IMDS_ADDRESS_IPV6', name_literal),
- ('IMDS_KEY_HOSTNAME', name_literal),
- ('IMDS_KEY_REGION', name_literal),
- ('IMDS_KEY_ZONE', name_literal),
- ('IMDS_KEY_IPV4_PUBLIC', name_literal),
- ('IMDS_KEY_IPV6_PUBLIC', name_literal),
- ('IMDS_KEY_SSH_KEY', name_literal),
- ('IMDS_KEY_USERDATA', name_literal),
- ('IMDS_KEY_USERDATA_BASE', name_literal),
- ('IMDS_KEY_USERDATA_BASE64', name_literal),
- )
- fixed_props = [Literal(name)('NAME') - Suppress('=') - val('VALUE')
- for name, val in props]
- kbd_props = [Regex(r'KEYBOARD_KEY_[0-9a-f]+')('NAME')
- - Suppress('=') -
- Group('!' ^ (Optional('!') - Word(alphanums + '_')))('VALUE')
- ]
- abs_props = [Regex(r'EVDEV_ABS_[0-9a-f]{2}')('NAME')
- - Suppress('=') -
- Word('-' + nums + ':')('VALUE')
- ]
+ props = (
+ ('MOUSE_DPI', Group(OneOrMore(dpi_setting))),
+ ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER),
+ ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER),
+ ('MOUSE_WHEEL_CLICK_COUNT', INTEGER),
+ ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER),
+ ('ID_INPUT_3D_MOUSE', zero_one),
+ ('ID_AUTOSUSPEND', zero_one),
+ ('ID_AUTOSUSPEND_DELAY_MS', INTEGER),
+ ('ID_AV_PRODUCTION_CONTROLLER', zero_one),
+ ('ID_AV_LIGHTS', zero_one),
+ ('ID_PERSIST', zero_one),
+ ('ID_PDA', zero_one),
+ ('ID_INPUT', id_input_setting),
+ ('ID_INPUT_ACCELEROMETER', id_input_setting),
+ ('ID_INPUT_JOYSTICK', id_input_setting),
+ ('ID_INPUT_KEY', id_input_setting),
+ ('ID_INPUT_KEYBOARD', id_input_setting),
+ ('ID_INPUT_MOUSE', id_input_setting),
+ ('ID_INPUT_POINTINGSTICK', id_input_setting),
+ ('ID_INPUT_SWITCH', id_input_setting),
+ ('ID_INPUT_TABLET', id_input_setting),
+ ('ID_INPUT_TABLET_PAD', id_input_setting),
+ ('ID_INPUT_TOUCHPAD', id_input_setting),
+ ('ID_INPUT_TOUCHSCREEN', id_input_setting),
+ ('ID_INPUT_TRACKBALL', id_input_setting),
+ ('ID_SIGNAL_ANALYZER', zero_one),
+ ('ID_MAKER_TOOL', zero_one),
+ ('ID_HARDWARE_WALLET', zero_one),
+ ('ID_SOFTWARE_RADIO', zero_one),
+ ('ID_MM_DEVICE_IGNORE', zero_one),
+ ('ID_NET_AUTO_LINK_LOCAL_ONLY', zero_one),
+ ('POINTINGSTICK_SENSITIVITY', INTEGER),
+ ('ID_INTEGRATION', Or(('internal', 'external'))),
+ ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))),
+ ('XKB_FIXED_LAYOUT', xkb_setting),
+ ('XKB_FIXED_VARIANT', xkb_setting),
+ ('XKB_FIXED_MODEL', xkb_setting),
+ ('KEYBOARD_LED_NUMLOCK', Literal('0')),
+ ('KEYBOARD_LED_CAPSLOCK', Literal('0')),
+ ('ACCEL_MOUNT_MATRIX', mount_matrix),
+ ('ACCEL_LOCATION', Or(('display', 'base'))),
+ ('PROXIMITY_NEAR_LEVEL', INTEGER),
+ ('IEEE1394_UNIT_FUNCTION_MIDI', zero_one),
+ ('IEEE1394_UNIT_FUNCTION_AUDIO', zero_one),
+ ('IEEE1394_UNIT_FUNCTION_VIDEO', zero_one),
+ ('ID_VENDOR_FROM_DATABASE', name_literal),
+ ('ID_MODEL_FROM_DATABASE', name_literal),
+ ('ID_TAG_MASTER_OF_SEAT', Literal('1')),
+ ('ID_INFRARED_CAMERA', zero_one),
+ ('ID_CAMERA_DIRECTION', Or(('front', 'rear'))),
+ (
+ 'SOUND_FORM_FACTOR',
+ Or(('internal', 'webcam', 'speaker', 'headphone', 'headset', 'handset', 'microphone')),
+ ),
+ ('ID_SYS_VENDOR_IS_RUBBISH', zero_one),
+ ('ID_PRODUCT_NAME_IS_RUBBISH', zero_one),
+ ('ID_PRODUCT_VERSION_IS_RUBBISH', zero_one),
+ ('ID_BOARD_VERSION_IS_RUBBISH', zero_one),
+ ('ID_PRODUCT_SKU_IS_RUBBISH', zero_one),
+ ('ID_CHASSIS_ASSET_TAG_IS_RUBBISH', zero_one),
+ ('ID_CHASSIS', name_literal),
+ ('ID_SYSFS_ATTRIBUTE_MODEL', name_literal),
+ ('ID_NET_NAME_FROM_DATABASE', name_literal),
+ ('ID_NET_NAME_INCLUDE_DOMAIN', zero_one),
+ ('TPM2_BROKEN_NVPCR', zero_one),
+ ('IMDS_VENDOR', name_literal),
+ ('IMDS_TOKEN_URL', name_literal),
+ ('IMDS_REFRESH_HEADER_NAME', name_literal),
+ ('IMDS_DATA_URL', name_literal),
+ ('IMDS_DATA_URL_SUFFIX', name_literal),
+ ('IMDS_TOKEN_HEADER_NAME', name_literal),
+ ('IMDS_EXTRA_HEADER', name_literal),
+ ('IMDS_ADDRESS_IPV4', name_literal),
+ ('IMDS_ADDRESS_IPV6', name_literal),
+ ('IMDS_KEY_HOSTNAME', name_literal),
+ ('IMDS_KEY_REGION', name_literal),
+ ('IMDS_KEY_ZONE', name_literal),
+ ('IMDS_KEY_IPV4_PUBLIC', name_literal),
+ ('IMDS_KEY_IPV6_PUBLIC', name_literal),
+ ('IMDS_KEY_SSH_KEY', name_literal),
+ ('IMDS_KEY_USERDATA', name_literal),
+ ('IMDS_KEY_USERDATA_BASE', name_literal),
+ ('IMDS_KEY_USERDATA_BASE64', name_literal),
+ )
+ fixed_props = [Literal(name)('NAME') - Suppress('=') - val('VALUE') for name, val in props]
+ kbd_props = [
+ Regex(r'KEYBOARD_KEY_[0-9a-f]+')('NAME')
+ - Suppress('=')
+ - Group('!' ^ (Optional('!') - Word(alphanums + '_')))('VALUE')
+ ]
+ abs_props = [Regex(r'EVDEV_ABS_[0-9a-f]{2}')('NAME') - Suppress('=') - Word('-' + nums + ':')('VALUE')]
grammar = Or(fixed_props + kbd_props + abs_props) + EOL
return grammar
+
ERROR = False
+
+
def error(fmt, *args, **kwargs):
global ERROR
ERROR = True
print(fmt.format(*args, **kwargs))
+
def convert_properties(group):
matches = [m[0] for m in group.MATCHES]
props = [p[0] for p in group.PROPERTIES]
return matches, props
+
def parse(fname):
grammar = hwdb_grammar()
try:
- with open(fname, 'r', encoding='UTF-8') as f:
+ with open(fname, encoding='UTF-8') as f:
parsed = grammar.parseFile(f)
except ParseBaseException as e:
error('Cannot parse {}: {}', fname, e)
return []
return [convert_properties(g) for g in parsed.GROUPS]
+
def check_matches(groups):
matches = sum((group[0] for group in groups), [])
# This is a partial check. The other cases could be also done, but those
# three are the most commonly wrong.
grammars = {
- 'bluetooth' : 'v' + upperhex_word(4) + Optional('p' + upperhex_word(4) + Optional(':')) + '*',
- 'usb' : 'v' + upperhex_word(4) + Optional('p' + upperhex_word(4) + Optional(':')) + '*',
- 'pci' : 'v' + upperhex_word(8) + Optional('d' + upperhex_word(8) + Optional(':')) + '*',
+ 'bluetooth': 'v' + upperhex_word(4) + Optional('p' + upperhex_word(4) + Optional(':')) + '*',
+ 'usb': 'v' + upperhex_word(4) + Optional('p' + upperhex_word(4) + Optional(':')) + '*',
+ 'pci': 'v' + upperhex_word(8) + Optional('d' + upperhex_word(8) + Optional(':')) + '*',
}
for match in matches:
error('Match {!r} is duplicated', match)
prev = match
+
def check_one_default(prop, settings):
defaults = [s for s in settings if s.DEFAULT]
if len(defaults) > 1:
error('More than one star entry: {!r}', prop)
+
def check_one_mount_matrix(prop, value):
numbers = [s for s in value if s not in {';', ','}]
if len(numbers) != 9:
error('Wrong accel matrix: {!r}', prop)
bad_x, bad_y, bad_z = max(numbers[0:3]) == 0, max(numbers[3:6]) == 0, max(numbers[6:9]) == 0
if bad_x or bad_y or bad_z:
- error('Mount matrix is all zero in {} row: {!r}',
- 'x' if bad_x else ('y' if bad_y else 'z'),
- prop)
+ error('Mount matrix is all zero in {} row: {!r}', 'x' if bad_x else ('y' if bad_y else 'z'), prop)
+
def check_one_keycode(value):
if value != '!' and ecodes is not None:
key = 'KEY_' + value.upper()
- if not (key in ecodes or
- value.upper() in ecodes or
- # new keys added in kernel 5.5
- 'KBD_LCD_MENU' in key):
+ if not (
+ key in ecodes
+ or value.upper() in ecodes
+ # new keys added in kernel 5.5
+ or 'KBD_LCD_MENU' in key
+ ): # fmt: skip
error('Keycode {} unknown', key)
+
def check_wheel_clicks(properties):
- pairs = (('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_COUNT'),
- ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE'),
- ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL'),
- ('MOUSE_WHEEL_CLICK_COUNT', 'MOUSE_WHEEL_CLICK_ANGLE'))
+ pairs = (
+ ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_COUNT'),
+ ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE'),
+ ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL'),
+ ('MOUSE_WHEEL_CLICK_COUNT', 'MOUSE_WHEEL_CLICK_ANGLE'),
+ )
for pair in pairs:
if pair[0] in properties and pair[1] not in properties:
error('{} requires {} to be specified', *pair)
+
def check_properties(groups):
grammar = property_grammar()
for _, props in groups:
check_wheel_clicks(seen_props)
+
def print_summary(fname, groups):
n_matches = sum(len(matches) for matches, props in groups)
n_props = sum(len(props) for matches, props in groups)
if n_matches == 0 or n_props == 0:
print(f'{fname}: no matches or props')
+
if __name__ == '__main__':
- args = sys.argv[1:] or sorted([
- os.path.dirname(sys.argv[0]) + '/20-dmi-id.hwdb',
- os.path.dirname(sys.argv[0]) + '/20-net-ifname.hwdb',
- *glob.glob(os.path.dirname(sys.argv[0]) + '/[678][0-9]-*.hwdb'),
- ])
+ args = sys.argv[1:] or sorted(
+ [
+ os.path.dirname(sys.argv[0]) + '/20-dmi-id.hwdb',
+ os.path.dirname(sys.argv[0]) + '/20-net-ifname.hwdb',
+ *glob.glob(os.path.dirname(sys.argv[0]) + '/[678][0-9]-*.hwdb'),
+ ]
+ )
for fname in args:
groups = parse(fname)
projects / thirdparty / systemd.git / commitdiff
