data: add a test for unifying receiver IDs

We don't want any device files that use the receiver itself as a match so
let's test for that. In virtually all cases this means the user must update
the kernel and hope support for that receiver is already present in that
version.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

data/devices/receiver-check.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+# vim: set expandtab shiftwidth=4 tabstop=4:
+#
+# Copyright © 2018 Red Hat, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice (including the next
+# paragraph) shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+#
+
+import argparse
+import os
+import sys
+import configparser
+
+# see the IDs from
+# https://github.com/torvalds/linux/blob/master/drivers/hid/hid-ids.h#L772
+# https://github.com/torvalds/linux/blob/master/drivers/hid/hid-logitech-dj.c#L1826
+logitech_receivers = [
+    0xc50c,  # USB_DEVICE_ID_S510_RECEIVER
+    0xc517,  # USB_DEVICE_ID_S510_RECEIVER_2
+    0xc512,  # USB_DEVICE_ID_LOGITECH_CORDLESS_DESKTOP_LX500
+    0xc513,  # USB_DEVICE_ID_MX3000_RECEIVER
+    0xc51b,  # USB_DEVICE_ID_LOGITECH_27MHZ_MOUSE_RECEIVER
+    0xc52b,  # USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER
+    0xc52f,  # USB_DEVICE_ID_LOGITECH_NANO_RECEIVER
+    0xc532,  # USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2
+    0xc534,  # USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_2
+    0xc539,  # USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_LIGHTSPEED_1
+    0xc53f,  # USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_LIGHTSPEED_1_1
+    0xc53a,  # USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_POWERPLAY
+]
+RECEIVERS = ['usb:046d:{}'.format(r) for r in logitech_receivers]
+
+
+def parse_data_file(path):
+    data = configparser.ConfigParser(strict=True)
+    # Don't convert to lowercase
+    data.optionxform = lambda option: option
+    data.read(path)
+
+    matches = data['Device']['DeviceMatch']
+    return matches.split(';')
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Checks that no unifying receiver ID is in the device files')
+    parser.add_argument('file', nargs='+')
+    args = parser.parse_args()
+    receiver_found = False
+    for path in args.file:
+        matches = parse_data_file(path)
+        fname = os.path.basename(path)
+        for m in matches:
+            if m in RECEIVERS:
+                print('Receiver ID {} found in file {}'.format(m, fname))
+                receiver_found = True
+
+    if receiver_found:
+        sys.exit(1)

meson.build

@@ -350,6 +350,9 @@ test('data-parse-test', data_parse_test, args:  data_files)
 duplicate_test = find_program(join_paths(meson.source_root(), 'data/devices/duplicate-check.py'))
 test('duplicate-test', duplicate_test, args : data_files)
 
+reciever_id_test = find_program(join_paths(meson.source_root(), 'data/devices/receiver-check.py'))
+test('receiver-id-test', reciever_id_test, args : data_files)
+
 #### tests ####
 enable_tests = get_option('tests')
 if enable_tests