hwdb.d/parse_hwdb.py

   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,
  36                            ParseBaseException, __diag__)
  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 __diag__.warn_multiple_tokens_in_named_alternation = True
  54 __diag__.warn_ungrouped_named_tokens_in_collection = True
  55 __diag__.warn_name_set_on_empty_Forward = True
  56 __diag__.warn_on_multiple_string_args_to_oneof = True
  57 __diag__.enable_debug_on_named_expressions = True
  58
  59 EOL = LineEnd().suppress()
  60 EMPTYLINE = LineEnd()
  61 COMMENTLINE = pythonStyleComment + EOL
  62 INTEGER = Word(nums)
  63 REAL = Combine((INTEGER + Optional('.' + Optional(INTEGER))) ^ ('.' + INTEGER))
  64 SIGNED_REAL = Combine(Optional(Word('-+')) + REAL)
  65 UDEV_TAG = Word(string.ascii_uppercase, alphanums + '_')
  66
  67 # Those patterns are used in type-specific matches
  68 TYPES = {'mouse':    ('usb', 'bluetooth', 'ps2', '*'),
  69          'evdev':    ('name', 'atkbd', 'input'),
  70          'id-input': ('modalias'),
  71          'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'),
  72          'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'),
  73          'keyboard': ('name', ),
  74          'sensor':   ('modalias', ),
  75         }
  76
  77 # Patterns that are used to set general properties on a device
  78 GENERAL_MATCHES = {'acpi',
  79                    'bluetooth',
  80                    'usb',
  81                    'pci',
  82                    'sdio',
  83                    'vmbus',
  84                    'OUI',
  85                    }
  86
  87 def upperhex_word(length):
  88     return Word(nums + 'ABCDEF', exact=length)
  89
  90 @lru_cache()
  91 def hwdb_grammar():
  92     ParserElement.setDefaultWhitespaceChars('')
  93
  94     prefix = Or(category + ':' + Or(conn) + ':'
  95                 for category, conn in TYPES.items())
  96
  97     matchline_typed = Combine(prefix + Word(printables + ' ' + '®'))
  98     matchline_general = Combine(Or(GENERAL_MATCHES) + ':' + Word(printables + ' ' + '®'))
  99     matchline = (matchline_typed | matchline_general) + EOL
 100
 101     propertyline = (White(' ', exact=1).suppress() +
 102                     Combine(UDEV_TAG - '=' - Optional(Word(alphanums + '_=:@*.!-;, "'))
 103                             - Optional(pythonStyleComment)) +
 104                     EOL)
 105     propertycomment = White(' ', exact=1) + pythonStyleComment + EOL
 106
 107     group = (OneOrMore(matchline('MATCHES*') ^ COMMENTLINE.suppress()) -
 108              OneOrMore(propertyline('PROPERTIES*') ^ propertycomment.suppress()) -
 109              (EMPTYLINE ^ stringEnd()).suppress())
 110     commentgroup = OneOrMore(COMMENTLINE).suppress() - EMPTYLINE.suppress()
 111
 112     grammar = OneOrMore(Group(group)('GROUPS*') ^ commentgroup) + stringEnd()
 113
 114     return grammar
 115
 116 @lru_cache()
 117 def property_grammar():
 118     ParserElement.setDefaultWhitespaceChars(' ')
 119
 120     dpi_setting = Group(Optional('*')('DEFAULT') + INTEGER('DPI') + Suppress('@') + INTEGER('HZ'))('SETTINGS*')
 121     mount_matrix_row = SIGNED_REAL + ',' + SIGNED_REAL + ',' + SIGNED_REAL
 122     mount_matrix = Group(mount_matrix_row + ';' + mount_matrix_row + ';' + mount_matrix_row)('MOUNT_MATRIX')
 123     xkb_setting = Optional(Word(alphanums + '+-/@._'))
 124
 125     props = (('MOUSE_DPI', Group(OneOrMore(dpi_setting))),
 126              ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER),
 127              ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER),
 128              ('MOUSE_WHEEL_CLICK_COUNT', INTEGER),
 129              ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER),
 130              ('ID_AUTOSUSPEND', Or((Literal('0'), Literal('1')))),
 131              ('ID_INPUT', Or((Literal('0'), Literal('1')))),
 132              ('ID_INPUT_ACCELEROMETER', Or((Literal('0'), Literal('1')))),
 133              ('ID_INPUT_JOYSTICK', Or((Literal('0'), Literal('1')))),
 134              ('ID_INPUT_KEY', Or((Literal('0'), Literal('1')))),
 135              ('ID_INPUT_KEYBOARD', Or((Literal('0'), Literal('1')))),
 136              ('ID_INPUT_MOUSE', Or((Literal('0'), Literal('1')))),
 137              ('ID_INPUT_POINTINGSTICK', Or((Literal('0'), Literal('1')))),
 138              ('ID_INPUT_SWITCH', Or((Literal('0'), Literal('1')))),
 139              ('ID_INPUT_TABLET', Or((Literal('0'), Literal('1')))),
 140              ('ID_INPUT_TABLET_PAD', Or((Literal('0'), Literal('1')))),
 141              ('ID_INPUT_TOUCHPAD', Or((Literal('0'), Literal('1')))),
 142              ('ID_INPUT_TOUCHSCREEN', Or((Literal('0'), Literal('1')))),
 143              ('ID_INPUT_TRACKBALL', Or((Literal('0'), Literal('1')))),
 144              ('POINTINGSTICK_SENSITIVITY', INTEGER),
 145              ('POINTINGSTICK_CONST_ACCEL', REAL),
 146              ('ID_INPUT_JOYSTICK_INTEGRATION', Or(('internal', 'external'))),
 147              ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))),
 148              ('XKB_FIXED_LAYOUT', xkb_setting),
 149              ('XKB_FIXED_VARIANT', xkb_setting),
 150              ('XKB_FIXED_MODEL', xkb_setting),
 151              ('KEYBOARD_LED_NUMLOCK', Literal('0')),
 152              ('KEYBOARD_LED_CAPSLOCK', Literal('0')),
 153              ('ACCEL_MOUNT_MATRIX', mount_matrix),
 154              ('ACCEL_LOCATION', Or(('display', 'base'))),
 155              ('PROXIMITY_NEAR_LEVEL', INTEGER),
 156             )
 157     fixed_props = [Literal(name)('NAME') - Suppress('=') - val('VALUE')
 158                    for name, val in props]
 159     kbd_props = [Regex(r'KEYBOARD_KEY_[0-9a-f]+')('NAME')
 160                  - Suppress('=') -
 161                  ('!' ^ (Optional('!') - Word(alphanums + '_')))('VALUE')
 162                 ]
 163     abs_props = [Regex(r'EVDEV_ABS_[0-9a-f]{2}')('NAME')
 164                  - Suppress('=') -
 165                  Word(nums + ':')('VALUE')
 166                 ]
 167
 168     grammar = Or(fixed_props + kbd_props + abs_props) + EOL
 169
 170     return grammar
 171
 172 ERROR = False
 173 def error(fmt, *args, **kwargs):
 174     global ERROR
 175     ERROR = True
 176     print(fmt.format(*args, **kwargs))
 177
 178 def convert_properties(group):
 179     matches = [m[0] for m in group.MATCHES]
 180     props = [p[0] for p in group.PROPERTIES]
 181     return matches, props
 182
 183 def parse(fname):
 184     grammar = hwdb_grammar()
 185     try:
 186         with open(fname, 'r', encoding='UTF-8') as f:
 187             parsed = grammar.parseFile(f)
 188     except ParseBaseException as e:
 189         error('Cannot parse {}: {}', fname, e)
 190         return []
 191     return [convert_properties(g) for g in parsed.GROUPS]
 192
 193 def check_matches(groups):
 194     matches = sum((group[0] for group in groups), [])
 195
 196     # This is a partial check. The other cases could be also done, but those
 197     # two are most commonly wrong.
 198     grammars = { 'usb' : 'v' + upperhex_word(4) + Optional('p' + upperhex_word(4)),
 199                  'pci' : 'v' + upperhex_word(8) + Optional('d' + upperhex_word(8)),
 200     }
 201
 202     for match in matches:
 203         prefix, rest = match.split(':', maxsplit=1)
 204         gr = grammars.get(prefix)
 205         if gr:
 206             try:
 207                 gr.parseString(rest)
 208             except ParseBaseException as e:
 209                 error('Pattern {!r} is invalid: {}', rest, e)
 210                 continue
 211             if rest[-1] not in '*:':
 212                 error('pattern {} does not end with "*" or ":"', match)
 213
 214     matches.sort()
 215     prev = None
 216     for match in matches:
 217         if match == prev:
 218             error('Match {!r} is duplicated', match)
 219         prev = match
 220
 221 def check_one_default(prop, settings):
 222     defaults = [s for s in settings if s.DEFAULT]
 223     if len(defaults) > 1:
 224         error('More than one star entry: {!r}', prop)
 225
 226 def check_one_mount_matrix(prop, value):
 227     numbers = [s for s in value if s not in {';', ','}]
 228     if len(numbers) != 9:
 229         error('Wrong accel matrix: {!r}', prop)
 230     try:
 231         numbers = [abs(float(number)) for number in numbers]
 232     except ValueError:
 233         error('Wrong accel matrix: {!r}', prop)
 234     bad_x, bad_y, bad_z = max(numbers[0:3]) == 0, max(numbers[3:6]) == 0, max(numbers[6:9]) == 0
 235     if bad_x or bad_y or bad_z:
 236         error('Mount matrix is all zero in {} row: {!r}',
 237               'x' if bad_x else ('y' if bad_y else 'z'),
 238               prop)
 239
 240 def check_one_keycode(prop, value):
 241     if value != '!' and ecodes is not None:
 242         key = 'KEY_' + value.upper()
 243         if not (key in ecodes or
 244                 value.upper() in ecodes or
 245                  # new keys added in kernel 5.5
 246                 'KBD_LCD_MENU' in key):
 247             error('Keycode {} unknown', key)
 248
 249 def check_wheel_clicks(properties):
 250     pairs = (('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_COUNT'),
 251              ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE'),
 252              ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', 'MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL'),
 253              ('MOUSE_WHEEL_CLICK_COUNT', 'MOUSE_WHEEL_CLICK_ANGLE'))
 254     for pair in pairs:
 255         if pair[0] in properties and pair[1] not in properties:
 256             error('{} requires {} to be specified', *pair)
 257
 258 def check_properties(groups):
 259     grammar = property_grammar()
 260     for matches, props in groups:
 261         seen_props = {}
 262         for prop in props:
 263             # print('--', prop)
 264             prop = prop.partition('#')[0].rstrip()
 265             try:
 266                 parsed = grammar.parseString(prop)
 267             except ParseBaseException as e:
 268                 error('Failed to parse: {!r}', prop)
 269                 continue
 270             # print('{!r}'.format(parsed))
 271             if parsed.NAME in seen_props:
 272                 error('Property {} is duplicated', parsed.NAME)
 273             seen_props[parsed.NAME] = parsed.VALUE
 274             if parsed.NAME == 'MOUSE_DPI':
 275                 check_one_default(prop, parsed.VALUE.SETTINGS)
 276             elif parsed.NAME == 'ACCEL_MOUNT_MATRIX':
 277                 check_one_mount_matrix(prop, parsed.VALUE)
 278             elif parsed.NAME.startswith('KEYBOARD_KEY_'):
 279                 val = parsed.VALUE if isinstance(parsed.VALUE, str) else parsed.VALUE[0]
 280                 check_one_keycode(prop, val)
 281
 282         check_wheel_clicks(seen_props)
 283
 284 def print_summary(fname, groups):
 285     n_matches = sum(len(matches) for matches, props in groups)
 286     n_props = sum(len(props) for matches, props in groups)
 287     print('{}: {} match groups, {} matches, {} properties'
 288           .format(fname, len(groups), n_matches, n_props))
 289
 290     if n_matches == 0 or n_props == 0:
 291         error('{}: no matches or props'.format(fname))
 292
 293 if __name__ == '__main__':
 294     args = sys.argv[1:] or sorted(glob.glob(os.path.dirname(sys.argv[0]) + '/[67][0-9]-*.hwdb'))
 295
 296     for fname in args:
 297         groups = parse(fname)
 298         print_summary(fname, groups)
 299         check_matches(groups)
 300         check_properties(groups)
 301
 302     sys.exit(ERROR)