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