libratbag 0.14

Signed-off-by: Filipe Laíns <lains@archlinux.org>

.circleci/config.yml

@@ -1,10 +1,12 @@
 libratbag_references:
   build_dependencies: &build_dependencies
     FEDORA_DEP_BUILD: gcc gcc-c++ meson dbus-daemon glib2-devel json-glib-devel libevdev-devel libudev-devel libunistring-devel python3-devel python3-evdev swig
-    FEDORA_DEP_TEST: check-devel python3-gobject python3-lxml valgrind
+    FEDORA_DEP_TEST: check-devel python3-gobject python3-lxml valgrind diffutils
     FEDORA_DEP_DOC: python3-sphinx python3-sphinx_rtd_theme
     UBUNTU_DEP_BUILD: gcc g++ meson pkg-config systemd libevdev-dev libglib2.0-dev libjson-glib-dev libsystemd-dev libudev-dev libunistring-dev python3-dev python3-evdev swig
     UBUNTU_DEP_TEST: check python3-gi python3-lxml valgrind
+    ARCH_DEP_BUILD: meson swig glib2 libevdev libudev.so libunistring json-glib python python-evdev python-gobject
+    ARCH_DEP_TEST: check valgrind python-lxml
   default_settings: &default_settings
     working_directory: ~/libratbag
     environment:
@@ -75,22 +77,21 @@ libratbag_references:
         mkdir /run/dbus
         /usr/bin/dbus-daemon --system --fork
 
-fedora_prep_cache: &fedora_prep_cache
-  <<: *default_settings
-  steps:
-    - run:
-        name: Initializing Fedora dnf cache
-        command: dnf install -y --downloadonly git ${FEDORA_DEP_BUILD} ${FEDORA_DEP_TEST} ${FEDORA_DEP_DOC}
-    - persist_to_workspace:
-        root: /var/cache/
-        paths:
-          - dnf/*
-  environment:
-    *build_dependencies
+save_date: &save_date
+  run:
+    name: Save date
+    command: date +%F > /tmp/date
+
+fedora_save_cache: &fedora_save_cache
+  save_cache:
+    key: fedora-cache-v1-{{ checksum "/tmp/date" }}
+    paths:
+      - /var/cache/dnf
 
 fedora_fetch_cache: &fedora_fetch_cache
-  attach_workspace:
-    at: /var/cache/
+  restore_cache:
+    keys:
+      - fedora-cache-v1
 
 fedora_install: &fedora_install
   run:
@@ -103,6 +104,7 @@ fedora_install: &fedora_install
 fedora_settings: &fedora_settings
   <<: *default_settings
   steps:
+    - *save_date
     - *fedora_fetch_cache
     - *fedora_install
     - checkout
@@ -114,6 +116,37 @@ fedora_settings: &fedora_settings
     - *build_buildtype_plain
     - *build_buildtype_release
     - *export_logs
+    - *fedora_save_cache
+  environment:
+    *build_dependencies
+
+arch_save_cache: &arch_save_cache
+  save_cache:
+    key: arch-cache-v1-{{ checksum "/tmp/date" }}
+    paths:
+      - /var/cache/pacman/pkg
+
+arch_fetch_cache: &arch_fetch_cache
+  restore_cache:
+    keys:
+      - arch-cache-v1
+
+arch_settings: &arch_settings
+  <<: *default_settings
+  steps:
+    - *save_date
+    - *arch_fetch_cache
+    - run:
+        name: Install prerequisites
+        command: pacman -Syu --noconfirm --noprogressbar --needed base-devel git tree ${ARCH_DEP_BUILD} ${ARCH_DEP_TEST}
+    - *start_dbus
+    - checkout
+    - *build_and_test
+    - *install
+    - *check_install
+    - *check_uninstall
+    - *export_logs
+    - *arch_save_cache
   environment:
     *build_dependencies
 
@@ -201,18 +234,18 @@ docs_deploy: &docs_deploy
 
 version: 2
 jobs:
-  fedora_cache:
-    <<: *fedora_prep_cache
-    docker:
-      - image: fedora:31
   fedora_31:
     <<: *fedora_settings
     docker:
       - image: fedora:31
-  ubuntu_19_04:
+  arch:
+    <<: *arch_settings
+    docker:
+      - image: archlinux
+  ubuntu_19_10:
     <<: *ubuntu_settings
     docker:
-      - image: ubuntu:19.04
+      - image: ubuntu:19.10
   doc_build:
     <<: *doc_build
     docker:
@@ -227,17 +260,12 @@ workflows:
   version: 2
   compile_and_test:
     jobs:
-      - fedora_cache
-      - ubuntu_19_04
-      - fedora_31:
-          requires:
-            - fedora_cache
-      - doc_build:
-          requires:
-            - fedora_cache
+      - ubuntu_19_10
+      - arch
+      - fedora_31
+      - doc_build
       - doc_deploy:
           requires:
-            - fedora_cache
             - doc_build
           filters:
               branches:

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,6 +13,12 @@ assignees: ''
 - Distribution: 
 - Kernel version (ex. `uname -srmo`): `KERNEL VERSION HERE`
 
+Device info (if applicable):
+```
+$ ratbagctl <device> info
+OUTPUT HERE
+```
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 

data/devices/data-parse-test.py

@@ -168,7 +168,7 @@ def check_section_hidpp10(section):
 
 
 def check_section_hidpp20(section):
-    permitted = ['DeviceIndex', 'Quirk']
+    permitted = ['DeviceIndex', 'Leds', 'Quirk']
     for key in section.keys():
         assertIn(key, permitted)
 

data/devices/logitech-M720.device

@@ -0,0 +1,4 @@
+[Device]
+Name=Logitech M720
+DeviceMatch=usb:046d:405e
+Driver=hidpp20

data/devices/logitech-MX-Anywhere2.device

@@ -1,4 +1,4 @@
 [Device]
 Name=Logitech MX Anywhere 2
-DeviceMatch=usb:046d:404a;bluetooth:046d:b013;bluetooth:046d:b018
+DeviceMatch=usb:046d:404a;bluetooth:046d:b013;bluetooth:046d:b018;bluetooth:046d:b01f
 Driver=hidpp20

data/devices/logitech-g305.device

@@ -4,4 +4,5 @@ DeviceMatch=usb:046d:4074
 Driver=hidpp20
 
 [Driver/hidpp20]
+Leds=0
 Quirk=G305

data/devices/logitech-g402.device

@@ -2,4 +2,5 @@
 [Device]
 Name=Logitech G402 Gaming Mouse
 DeviceMatch=usb:046d:c07e
+LedTypes=logo
 Driver=hidpp20

data/devices/logitech-g935.device

@@ -0,0 +1,5 @@
+[Device]
+Name=Logitech G935
+DeviceMatch=usb:046d:0a87
+LedTypes=logo;side
+Driver=hidpp20

doc/dbus.rst

@@ -85,13 +85,13 @@ interact with ratbagd.
         :type: i
         :flags: read-only,constant
 
-	The DBus API version. This is a stopgap feature while the DBus API
-	is still in flux. The version has no backwards or
-	forward-compatibilty guarantees - your client must understand
-	**exactly** the same version, it is not enough to support an older
-	or a newer version.
+        The DBus API version. This is a stopgap feature while the DBus API
+        is still in flux. The version has no backwards or
+        forward-compatibilty guarantees - your client must understand
+        **exactly** the same version, it is not enough to support an older
+        or a newer version.
 
-	This API will be removed once the DBus API is declared stable.
+        This API will be removed once the DBus API is declared stable.
 
 .. attribute:: Devices
 

meson.build

@@ -1,5 +1,5 @@
 project('libratbag', 'c',
-	version : '0.13',
+	version : '0.14',
 	license : 'MIT/Expat',
 	default_options : [ 'c_std=gnu99', 'warning_level=2' ],
 	meson_version : '>= 0.40.0')
@@ -284,6 +284,7 @@ data_files = files(
 	'data/devices/logitech-M570.device',
 	'data/devices/logitech-M585-M590.device',
 	'data/devices/logitech-M705.device',
+	'data/devices/logitech-M720.device',
 	'data/devices/logitech-MX-Ergo.device',
 	'data/devices/logitech-MX-Master.device',
 	'data/devices/logitech-MX-Master-2S.device',
@@ -329,6 +330,7 @@ data_files = files(
 	'data/devices/logitech-g815.device',
 	'data/devices/logitech-g910.device',
 	'data/devices/logitech-g915.device',
+	'data/devices/logitech-g935.device',
 	'data/devices/logitech-g9x-Call-of-Duty-MW3-Edition.device',
 	'data/devices/logitech-g9x-Original.device',
 	'data/devices/logitech-Marathon-M705.device',
@@ -537,12 +539,28 @@ configure_file(input : 'dbus/org.freedesktop.ratbag1.conf.in',
 
 #### tools ####
 
+# This is a special idiomatic construct in meson to get a fast dependency that
+# doesn't exist and isn't logged as "not found".
+dep_python3 = dependency('', required : false)
 if meson.version().version_compare('<0.48.0')
   python = import('python3')
   py3 = python.find_python()
 else
   pymod = import('python')
   py3 = pymod.find_installation()
+  if meson.version().version_compare('>= 0.53.0')
+    dep_python3 = py3.dependency(embed : true)
+  endif
+endif
+
+# From python 3.8 we neeed python3-embed
+py_version = py3.language_version()
+embed = py_version.version_compare('>= 3.8') ? '-embed' : ''
+if not dep_python3.found()
+  dep_python3 = dependency('python-@0@@1@'.format(py_version, embed), required : false)
+  if not dep_python3.found()
+    dep_python3 = dependency('python3@0@'.format(embed))
+  endif
 endif
 
 config_ratbagctl = configuration_data()
@@ -606,12 +624,6 @@ swig_gen = generator(
                 '@INPUT@'],
 )
 
-# From python 3.8 we neeed python3-embed
-dep_python3 = dependency('python3-embed', required: false)
-if not dep_python3.found()
-	dep_python3 = dependency('python3')
-endif
-
 wrapper_deps = [
     dep_python3,
     dep_libratbag,
@@ -624,7 +636,9 @@ shared_library(
    'libratbag',
    c_source,
    name_prefix: '_',
-   c_args : ['-Wno-missing-prototypes', '-Wno-format-nonliteral'],
+   c_args : ['-Wno-missing-prototypes',
+             '-Wno-format-nonliteral',
+             '-Wno-missing-field-initializers'],
    extra_files: [ i_source ] + src_libratbag ,
    dependencies: deps_libratbag + wrapper_deps,
    include_directories : include_directories('src', 'tools'),
@@ -637,7 +651,10 @@ shared_library(
    'hidpp',
    c_source,
    name_prefix: '_',
-   c_args : ['-Wno-missing-prototypes', '-Wno-format-nonliteral'],
+   c_args : ['-Wno-missing-prototypes',
+             '-Wno-format-nonliteral',
+             '-Wno-missing-field-initializers',
+             '-Wno-strict-prototypes'],
    extra_files: [ i_source ] + src_libratbag ,
    dependencies: deps_libratbag + wrapper_deps,
    include_directories : include_directories('src', 'tools'),

ratbagd/ratbagd.c

@@ -29,6 +29,7 @@
 
 #include <assert.h>
 #include <errno.h>
+#include <libgen.h>
 #include <libratbag.h>
 #include <libudev.h>
 #include <stdio.h>
@@ -547,6 +548,13 @@ static bool install_ratbagd_devel_dbus_policy(void)
 		log_error("Failed to source policy file: %m\n");
 		goto out;
 	}
+
+	if (mkdir_p(dirname(strdupa(DBUS_POLICY_DST)), 0755)) {
+		log_error("Failed to create destination path: %m\n");
+		goto out;
+	}
+
+
 	out = open(DBUS_POLICY_DST, O_CREAT|O_WRONLY, 0644);
 	if (out == -1) {
 		log_error("Failed to open destination: %m\n");

src/driver-hidpp10.c

@@ -164,6 +164,7 @@ hidpp10drv_map_button(struct ratbag_device *device,
 {
 	struct hidpp10_profile profile;
 	int ret;
+	unsigned int modifiers = 0;
 
 	ret = hidpp10_get_profile(hidpp10, button->profile->index, &profile);
 	if (ret)
@@ -178,6 +179,7 @@ hidpp10drv_map_button(struct ratbag_device *device,
 		button->action.type = RATBAG_BUTTON_ACTION_TYPE_KEY;
 		button->action.action.key.key = ratbag_hidraw_get_keycode_from_keyboard_usage(device,
 							profile.buttons[button->index].keys.key);
+		modifiers = profile.buttons[button->index].keys.modifier_flags;
 		break;
 	case PROFILE_BUTTON_TYPE_CONSUMER_CONTROL:
 		button->action.type = RATBAG_BUTTON_ACTION_TYPE_KEY;
@@ -199,6 +201,14 @@ hidpp10drv_map_button(struct ratbag_device *device,
 		}
 	}
 
+	if (button->action.type == RATBAG_BUTTON_ACTION_TYPE_KEY) {
+		ret = ratbag_button_macro_new_from_keycode(button, button->action.action.key.key, modifiers);
+		if (ret < 0) {
+			log_error(device->ratbag, "hidpp10: error while reading button %d\n", button->index);
+			button->action.type = RATBAG_BUTTON_ACTION_TYPE_NONE;
+		}
+	}
+
 	ratbag_button_enable_action_type(button, RATBAG_BUTTON_ACTION_TYPE_MACRO);
 }
 
@@ -299,6 +309,8 @@ hidpp10drv_write_button(struct hidpp10_profile *profile,
 	struct hidpp10drv_data *drv_data = ratbag_get_drv_data(device);
 	struct hidpp10_device *hidpp10 = drv_data->dev;
 	uint8_t code;
+	unsigned int modifiers, key;
+	int rc;
 
 	if (hidpp10->profile_type == HIDPP10_PROFILE_UNKNOWN)
 		return -ENOTSUP;
@@ -330,6 +342,26 @@ hidpp10drv_write_button(struct hidpp10_profile *profile,
 		profile->buttons[button->index].special.special = code;
 		break;
 	case RATBAG_BUTTON_ACTION_TYPE_MACRO:
+		rc = ratbag_action_keycode_from_macro(action, &key, &modifiers);
+		if (rc < 0) {
+			log_error(device->ratbag, "hidpp10: can't convert macro action to keycode in button %d\n", button->index);
+			return -EINVAL;
+		}
+
+		code = ratbag_hidraw_get_keyboard_usage_from_keycode(device, key);
+		if (code == 0) {
+			code = ratbag_hidraw_get_consumer_usage_from_keycode(device, key);
+			if (code == 0)
+				return -EINVAL;
+
+			profile->buttons[button->index].consumer_control.type = PROFILE_BUTTON_TYPE_CONSUMER_CONTROL;
+			profile->buttons[button->index].consumer_control.consumer_control = code;
+		} else {
+			profile->buttons[button->index].keys.type = PROFILE_BUTTON_TYPE_KEYS;
+			profile->buttons[button->index].keys.key = code;
+			profile->buttons[button->index].keys.modifier_flags = modifiers;
+		}
+		break;
 	default:
 		return -ENOTSUP;
 	}
@@ -558,8 +590,10 @@ hidpp10drv_commit(struct ratbag_device *device)
 				continue;
 
 			rc = hidpp10drv_write_button(&p, button, &action);
-			if (rc)
+			if (rc) {
+				log_error(device->ratbag, "hidpp10: failed to update buttons (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
+			}
 		}
 
 		ratbag_profile_for_each_led(profile, led)
@@ -567,8 +601,10 @@ hidpp10drv_commit(struct ratbag_device *device)
 
 		if (dev->profile_type != HIDPP10_PROFILE_UNKNOWN) {
 			rc = hidpp10_set_profile(dev, profile->index, &p);
-			if (rc)
+			if (rc) {
+				log_error(device->ratbag, "hidpp10: failed to set profile (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
+			}
 		}
 
 		/* Update the current resolution in case it changed */
@@ -576,8 +612,10 @@ hidpp10drv_commit(struct ratbag_device *device)
 			rc = hidpp10_set_current_resolution(dev,
 						       active_resolution->dpi_x,
 						       active_resolution->dpi_y);
-			if (rc)
+			if (rc) {
+				log_error(device->ratbag, "hidpp10: failed to set active resolution (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
+			}
 
 			active_resolution = NULL;
 		}
@@ -631,9 +669,9 @@ hidpp10drv_probe(struct ratbag_device *device)
 	 * If there is a special need like for G700(s), then add a DeviceIndex
 	 * entry to the .device file.
 	 */
-	dev = hidpp10_device_new(&base, device_idx, type, profile_count);
+	rc = hidpp10_device_new(&base, device_idx, type, profile_count, &dev);
 
-	if (!dev) {
+	if (rc) {
 		log_error(device->ratbag,
 			  "Failed to get HID++1.0 device for %s\n",
 			  device->name);
@@ -714,14 +752,14 @@ static void
 hidpp10drv_remove(struct ratbag_device *device)
 {
 	struct hidpp10drv_data *drv_data;
-	struct hidpp10_device *dev;
 
 	ratbag_close_hidraw(device);
 
 	drv_data = ratbag_get_drv_data(device);
-	dev = drv_data->dev;
+	if (!drv_data)
+		return;
 
-	hidpp10_device_destroy(dev);
+	hidpp10_device_destroy(drv_data->dev);
 
 	free(drv_data);
 }

src/driver-hidpp20.c

@@ -575,7 +575,7 @@ hidpp20drv_update_button_8100(struct ratbag_button *button)
 		code = ratbag_hidraw_get_keyboard_usage_from_keycode(device, key);
 		if (code == 0) {
 			subtype = HIDPP20_BUTTON_HID_TYPE_CONSUMER_CONTROL;
-			code = ratbag_hidraw_get_consumer_usage_from_keycode(device, action->action.key.key);
+			code = ratbag_hidraw_get_consumer_usage_from_keycode(device, key);
 			if (code == 0)
 				return -EINVAL;
 		}
@@ -1490,7 +1490,7 @@ hidpp20drv_commit(struct ratbag_device *device)
 		if (profile->rate_dirty) {
 			rc = hidpp20drv_update_report_rate(profile, profile->hz);
 			if (rc) {
-				log_error(device->ratbag, "hidpp20: failed to update report rate\n");
+				log_error(device->ratbag, "hidpp20: failed to update report rate (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
 			}
 		}
@@ -1500,7 +1500,7 @@ hidpp20drv_commit(struct ratbag_device *device)
 							      resolution->dpi_x,
 							      resolution->dpi_y);
 			if (rc) {
-				log_error(device->ratbag, "hidpp20: failed to update resolution\n");
+				log_error(device->ratbag, "hidpp20: failed to update resolution (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
 			}
 		}
@@ -1511,7 +1511,7 @@ hidpp20drv_commit(struct ratbag_device *device)
 
 			rc = hidpp20drv_update_button(button);
 			if (rc) {
-				log_error(device->ratbag, "hidpp20: failed to update button\n");
+				log_error(device->ratbag, "hidpp20: failed to update button (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
 			}
 		}
@@ -1522,7 +1522,7 @@ hidpp20drv_commit(struct ratbag_device *device)
 
 			rc = hidpp20drv_update_led(led);
 			if (rc) {
-				log_error(device->ratbag, "hidpp20: failed to update led\n");
+				log_error(device->ratbag, "hidpp20: failed to update led (%d)\n", rc);
 				return RATBAG_ERROR_DEVICE;
 			}
 		}
@@ -1535,7 +1535,7 @@ hidpp20drv_commit(struct ratbag_device *device)
 		rc = hidpp20_onboard_profiles_commit(drv_data->dev,
 						     drv_data->profiles);
 		if (rc) {
-			log_error(device->ratbag, "hidpp20: failed to commit profile\n");
+			log_error(device->ratbag, "hidpp20: failed to commit profile (%d)\n", rc);
 			return RATBAG_ERROR_DEVICE;
 		}
 
@@ -1636,6 +1636,11 @@ hidpp20drv_init_device(struct ratbag_device *device,
 {
 	struct ratbag_profile *profile;
 	bool active_profile = false;
+	int num;
+
+	num = ratbag_device_data_hidpp20_get_led_count(device->data);
+	if (num >= 0)
+		drv_data->num_leds = num;
 
 	ratbag_device_init_profiles(device,
 				    drv_data->num_profiles,

src/hidpp10.c

@@ -1144,6 +1144,9 @@ hidpp10_onboard_profiles_read_macro(struct hidpp10_device *device,
 		}
 
 		if (rc == -ENOMEM) {
+			if ((unsigned) offset + mem_index > 0xff)
+				goto out_err;
+
 			offset += mem_index;
 			if (offset & 0x01)
 				offset--;
@@ -1198,8 +1201,10 @@ hidpp10_onboard_profiles_parse_macro(struct hidpp10_device *device,
 	hidpp_log_raw(&device->base, "*** macro starts at (0x%02x, 0x%04x) ***\n", page, offset);
 
 	rc = hidpp10_onboard_profiles_read_macro(device, page, offset, &macro);
-	if (rc)
+	if (rc) {
+		hidpp_log_raw(&device->base, "hidpp10: failed to read macro\n");
 		return rc;
+	}
 
 	count = rc;
 
@@ -2754,12 +2759,14 @@ hidpp10_get_device_info(struct hidpp10_device *dev)
 	return hidpp10_get_current_profile(dev, &current_profile);
 }
 
-struct hidpp10_device*
+int
 hidpp10_device_new(const struct hidpp_device *base,
 		   int idx,
 		   enum hidpp10_profile_type type,
-		   unsigned int profile_count)
+		   unsigned int profile_count,
+		   struct hidpp10_device **out)
 {
+	int rc;
 	struct hidpp10_device *dev;
 
 	dev = zalloc(sizeof(*dev));
@@ -2770,12 +2777,14 @@ hidpp10_device_new(const struct hidpp_device *base,
 	dev->profile_count = profile_count;
 	dev->profiles = zalloc(dev->profile_count * sizeof(struct hidpp10_profile));
 
-	if (hidpp10_get_device_info(dev) != 0) {
+	if ((rc = hidpp10_get_device_info(dev)) != 0) {
 		hidpp10_device_destroy(dev);
 		dev = NULL;
 	}
 
-	return dev;
+	*out = dev;
+
+	return rc;
 }
 
 int

src/hidpp10.h

@@ -69,11 +69,12 @@ struct hidpp10_device  {
 	unsigned int profile_count;
 };
 
-struct hidpp10_device*
+int
 hidpp10_device_new(const struct hidpp_device *base,
 		   int idx,
 		   enum hidpp10_profile_type type,
-		   unsigned int profile_count);
+		   unsigned int profile_count,
+		   struct hidpp10_device **out);
 
 int
 hidpp10_device_read_profiles(struct hidpp10_device *dev);

src/hidpp20.c

@@ -260,7 +260,7 @@ hidpp_root_get_feature(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = HIDPP_PAGE_ROOT_IDX,
 		.msg.address = CMD_ROOT_GET_FEATURE,
@@ -287,7 +287,7 @@ hidpp20_root_get_protocol_version(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = HIDPP_PAGE_ROOT_IDX,
 		.msg.address = CMD_ROOT_GET_PROTOCOL_VERSION,
@@ -321,7 +321,7 @@ hidpp20_feature_set_get_count(struct hidpp20_device *device, uint8_t reg)
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_FEATURE_SET_GET_COUNT,
@@ -343,7 +343,7 @@ hidpp20_feature_set_get_feature_id(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_FEATURE_SET_GET_FEATURE_ID,
@@ -429,7 +429,7 @@ hidpp20_batterylevel_get_battery_level(struct hidpp20_device *device,
 {
 	uint8_t feature_index;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS,
 	};
@@ -566,7 +566,7 @@ int hidpp20_led_sw_control_get_led_count(struct hidpp20_device* device)
 {
 	union hidpp20_message msg = {
 		.msg = {
-			.report_id = REPORT_ID_LONG,
+			.report_id = REPORT_ID_SHORT,
 			.address = CMD_LED_SW_CONTROL_GET_LED_COUNT,
 			.device_idx = device->index,
 		},
@@ -594,7 +594,7 @@ int hidpp20_led_sw_control_get_led_info(struct hidpp20_device* device,
 {
 	union hidpp20_message msg = {
 		.msg = {
-			.report_id = REPORT_ID_LONG,
+			.report_id = REPORT_ID_SHORT,
 			.address = CMD_LED_SW_CONTROL_GET_LED_INFO,
 			.device_idx = device->index,
 		},
@@ -682,7 +682,7 @@ int hidpp20_led_sw_control_get_led_state(struct hidpp20_device* device,
 	uint8_t feature_idx;
 	union hidpp20_message msg = {
 		.msg = {
-			.report_id = REPORT_ID_LONG,
+			.report_id = REPORT_ID_SHORT,
 			.address = CMD_LED_SW_CONTROL_GET_LED_STATE,
 			.device_idx = device->index,
 		}
@@ -767,7 +767,7 @@ static int
 hidpp20_kbd_reprogrammable_keys_get_count(struct hidpp20_device *device, uint8_t reg)
 {
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_KBD_REPROGRAMMABLE_KEYS_GET_COUNT,
@@ -788,7 +788,7 @@ hidpp20_kbd_reprogrammable_keys_get_info(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_KBD_REPROGRAMMABLE_KEYS_GET_CTRL_ID_INFO,
@@ -908,7 +908,7 @@ hidpp20_color_led_effects_get_zone_info(struct hidpp20_device *device,
 	int rc;
 	struct hidpp20_color_led_zone_info *msg_info;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_COLOR_LED_EFFECTS_GET_ZONE_INFO,
@@ -1022,7 +1022,7 @@ hidpp20_color_led_effects_set_zone_effect(struct hidpp20_device *device,
 {
 	uint8_t feature_index;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_SHORT,
+		.msg.report_id = REPORT_ID_LONG,
 		.msg.address = CMD_COLOR_LED_EFFECTS_SET_ZONE_EFFECT,
 		.msg.device_idx = device->index,
 		.msg.parameters[0] = zone_index,
@@ -1109,7 +1109,7 @@ hidpp20_rgb_effects_get_device_info(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_RGB_EFFECTS_GET_INFO,
 		.msg.parameters[0] = HIDPP20_RGB_EFFECTS_INDEX_ALL,
@@ -1146,7 +1146,7 @@ hidpp20_rgb_effects_get_cluster_info(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_RGB_EFFECTS_GET_INFO,
 		.msg.parameters[0] = cluster_index,
@@ -1229,7 +1229,7 @@ hidpp20_rgb_effects_get_effect_info(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_RGB_EFFECTS_GET_INFO,
 		.msg.parameters[0] = cluster_index,
@@ -1273,7 +1273,7 @@ hidpp20_special_keys_buttons_get_count(struct hidpp20_device *device, uint8_t re
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_SPECIAL_KEYS_BUTTONS_GET_COUNT,
@@ -1293,7 +1293,7 @@ hidpp20_special_keys_buttons_get_info(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_SPECIAL_KEYS_BUTTONS_GET_INFO,
@@ -1323,7 +1323,7 @@ hidpp20_special_keys_buttons_get_reporting(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_SPECIAL_KEYS_BUTTONS_GET_REPORTING,
@@ -1464,7 +1464,7 @@ hidpp20_mousepointer_get_mousepointer_info(struct hidpp20_device *device,
 {
 	uint8_t feature_index;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_MOUSE_POINTER_BASIC_GET_INFO,
 	};
@@ -1501,7 +1501,7 @@ hidpp20_adjustable_dpi_get_count(struct hidpp20_device *device, uint8_t reg)
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_ADJUSTABLE_DPI_GET_SENSOR_COUNT,
@@ -1522,7 +1522,7 @@ hidpp20_adjustable_dpi_get_dpi_list(struct hidpp20_device *device,
 	int rc;
 	unsigned i = 1, dpi_index = 0;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_ADJUSTABLE_DPI_GET_SENSOR_DPI_LIST,
@@ -1570,7 +1570,7 @@ hidpp20_adjustable_dpi_get_dpi(struct hidpp20_device *device,
 {
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.sub_id = reg,
 		.msg.address = CMD_ADJUSTABLE_DPI_GET_SENSOR_DPI,
@@ -1653,7 +1653,7 @@ int hidpp20_adjustable_dpi_set_sensor_dpi(struct hidpp20_device *device,
 	uint16_t returned_parameters;
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_ADJUSTABLE_DPI_SET_SENSOR_DPI,
 		.msg.parameters[0] = sensor->index,
@@ -1698,10 +1698,9 @@ int hidpp20_adjustable_report_rate_get_report_rate_list(struct hidpp20_device *d
 	uint8_t feature_index;
 	int rc;
 	union hidpp20_message msg = {
-		.msg.report_id = REPORT_ID_LONG,
+		.msg.report_id = REPORT_ID_SHORT,
 		.msg.device_idx = device->index,
 		.msg.address = CMD_ADJUSTABLE_REPORT_RATE_GET_REPORT_RATE_LIST,
-		.msg.parameters[0] = 0,
 	};
 
 	feature_index = hidpp_root_get_feature_idx(device,

src/hidpp20.h

@@ -577,14 +577,42 @@ enum hidpp20_color_led_zone_effect {
 
 #define HIDPP_PAGE_ONBOARD_PROFILES			0x8100
 
+/* type */
 #define HIDPP20_BUTTON_HID_TYPE				0x80
+#define HIDPP20_BUTTON_SPECIAL				0x90
+
+/* standard opcodes (0x80) */
+#define HIDPP20_BUTTON_HID_TYPE_NOOP			0x00
 #define HIDPP20_BUTTON_HID_TYPE_MOUSE			0x01
 #define HIDPP20_BUTTON_HID_TYPE_KEYBOARD		0x02
 #define HIDPP20_BUTTON_HID_TYPE_CONSUMER_CONTROL	0x03
-#define HIDPP20_BUTTON_SPECIAL				0x90
+
+/* special opcodes (0x90) */
+#define HIDPP20_BUTTON_SPECIAL_NOOP			0x00
+#define HIDPP20_BUTTON_SPECIAL_TILT_LEFT		0x01
+#define HIDPP20_BUTTON_SPECIAL_TILT_RIGHT		0x02
+#define HIDPP20_BUTTON_SPECIAL_NEXT_DPI			0x03
+#define HIDPP20_BUTTON_SPECIAL_PREV_DPI			0x04
+#define HIDPP20_BUTTON_SPECIAL_CYCLE_DPI		0x05
+#define HIDPP20_BUTTON_SPECIAL_DEFAULT_DPI		0x06
+#define HIDPP20_BUTTON_SPECIAL_SHIFT_DPI		0x07
+#define HIDPP20_BUTTON_SPECIAL_NEXT_PROFILE		0x08
+#define HIDPP20_BUTTON_SPECIAL_PREV_PROFILE		0x09
+#define HIDPP20_BUTTON_SPECIAL_CYCLE_PROFILE		0x0a
+#define HIDPP20_BUTTON_SPECIAL_GSHIFT			0x0b
+/* memory model >= 3 */
+#define HIDPP20_BUTTON_SPECIAL_BATTERY_INDICATOR	0x0c
+#define HIDPP20_BUTTON_SPECIAL_ENABLE_PROFILE		0x0d
+#define HIDPP20_BUTTON_SPECIAL_PERFORMANCE_SWITCH	0x0e
+#define HIDPP20_BUTTON_SPECIAL_HOST			0x0f
+#define HIDPP20_BUTTON_SPECIAL_SCROLL_DOWN		0x10
+#define HIDPP20_BUTTON_SPECIAL_SCROLL_UP		0x11
+
+/* buttons */
 #define HIDPP20_BUTTON_MACRO				0x00
 #define HIDPP20_BUTTON_DISABLED				0xFF
 
+/* modifiers */
 #define HIDPP20_MODIFIER_KEY_CTRL			0x01
 #define HIDPP20_MODIFIER_KEY_SHIFT			0x02
 
@@ -792,12 +820,32 @@ struct hidpp20_led {
 	uint8_t original[sizeof(struct hidpp20_internal_led)];
 };
 
-#define HIDPP20_MACRO_NOOP			0x01
+/* macro opcodes */
+
+/* control commands */
+#define HIDPP20_MACRO_WAIT_FOR_RELEASE		0x01
+#define HIDPP20_MACRO_REPEAT_WHILE_PRESSED	0x02
+#define HIDPP20_MACRO_REPEAT_UNTIL_CANCELED	0x03
+#define HIDPP20_MACRO_END			0xff
+
+/* delay & jump commands */
+#define HIDPP20_MACRO_NOOP			0x00 /* wait the duration of a macro step */
 #define HIDPP20_MACRO_DELAY			0x40
+#define HIDPP20_MACRO_JUMP			0x60
+
+/* button & key event generation */
+#define HIDPP20_MACRO_BUTTON_DOWN		0x41
+#define HIDPP20_MACRO_BUTTON_UP			0x42
 #define HIDPP20_MACRO_KEY_PRESS			0x43
 #define HIDPP20_MACRO_KEY_RELEASE		0x44
-#define HIDPP20_MACRO_JUMP			0x60
-#define HIDPP20_MACRO_END			0xff
+#define HIDPP20_MACRO_CONS_DOWN			0x45
+#define HIDPP20_MACRO_CONS_UP			0x46
+
+/* analog commands */
+#define HIDPP20_MACRO_ROLLER			0x20
+#define HIDPP20_MACRO_ACPAN			0x21
+#define HIDPP20_MACRO_XY			0x61
+
 
 union hidpp20_macro_data {
 	struct {

src/liblur.c

@@ -140,20 +140,21 @@ hidraw_is_receiver(int fd)
 	return true;
 }
 
-static struct hidpp10_device *
-hidpp10_init(int fd)
+static int
+hidpp10_init(int fd, struct hidpp10_device **out)
 {
 	struct hidpp_device base;
 
 	hidpp_device_init(&base, fd);
 
 	return hidpp10_device_new(&base, HIDPP_RECEIVER_IDX,
-				  HIDPP10_PROFILE_UNKNOWN, 1);
+				  HIDPP10_PROFILE_UNKNOWN, 1, out);
 }
 
 _EXPORT_ int
 lur_receiver_new_from_hidraw(int fd, void *userdata, struct lur_receiver **out)
 {
+	int rc;
 	struct lur_receiver *receiver;
 
 	if (!hidraw_is_receiver(fd))
@@ -165,8 +166,8 @@ lur_receiver_new_from_hidraw(int fd, void *userdata, struct lur_receiver **out)
 	receiver->userdata = userdata;
 	list_init(&receiver->devices);
 
-	receiver->hidppdev = hidpp10_init(fd);
-	if (!receiver->hidppdev)
+	rc = hidpp10_init(fd, &receiver->hidppdev);
+	if (rc)
 		goto error;
 
 	*out = receiver;
@@ -174,8 +175,7 @@ lur_receiver_new_from_hidraw(int fd, void *userdata, struct lur_receiver **out)
 
 error:
 	free(receiver);
-	return -errno;
-
+	return rc;
 }
 
 _EXPORT_ int
@@ -203,7 +203,7 @@ lur_receiver_enumerate(struct lur_receiver *lur,
 		uint32_t serial;
 		bool is_new_device = true;
 
-		d = hidpp10_device_new(&base, i, HIDPP10_PROFILE_UNKNOWN, 1);
+		rc = hidpp10_device_new(&base, i, HIDPP10_PROFILE_UNKNOWN, 1, &d);
 		if (!d)
 			continue;
 

src/libratbag-data.c

@@ -56,6 +56,7 @@ enum driver {
 struct data_hidpp20 {
 	int index;
 	enum hidpp20_quirk quirk;
+	int led_count;
 };
 
 struct data_hidpp10 {
@@ -157,6 +158,7 @@ init_data_hidpp20(struct ratbag *ratbag,
 	char *str;
 
 	data->hidpp20.index = -1;
+	data->hidpp20.led_count = -1;
 
 	num = g_key_file_get_integer(keyfile, group, "DeviceIndex", &error);
 	if (num != 0 || !error)
@@ -164,6 +166,13 @@ init_data_hidpp20(struct ratbag *ratbag,
 	if (error)
 		g_error_free(error);
 
+	error = NULL;
+	num = g_key_file_get_integer(keyfile, group, "Leds", &error);
+	if (!error)
+		data->hidpp20.led_count = num;
+	if (error)
+		g_error_free(error);
+
 	str = g_key_file_get_string(keyfile, group, "Quirk", NULL);
 	data->hidpp20.quirk = HIDPP20_QUIRK_NONE;
 	if (str) {
@@ -576,6 +585,14 @@ ratbag_device_data_hidpp20_get_index(const struct ratbag_device_data *data)
 	return data->hidpp20.index;
 }
 
+int
+ratbag_device_data_hidpp20_get_led_count(const struct ratbag_device_data *data)
+{
+	assert(data->drivertype == HIDPP20);
+
+	return data->hidpp20.led_count;
+}
+
 enum hidpp20_quirk
 ratbag_device_data_hidpp20_get_quirk(const struct ratbag_device_data *data)
 {

src/libratbag-data.h

@@ -80,6 +80,9 @@ ratbag_device_data_hidpp10_get_led_count(const struct ratbag_device_data *data);
 int
 ratbag_device_data_hidpp20_get_index(const struct ratbag_device_data *data);
 
+int
+ratbag_device_data_hidpp20_get_led_count(const struct ratbag_device_data *data);
+
 enum hidpp20_quirk
 ratbag_device_data_hidpp20_get_quirk(const struct ratbag_device_data *data);
 

src/libratbag-util.c

@@ -37,6 +37,8 @@
 #include <stdlib.h>
 #include <iconv.h>
 #include <errno.h>
+#include <libgen.h>
+#include <sys/stat.h>
 
 #include "libratbag-util.h"
 #include "libratbag-private.h"
@@ -188,3 +190,18 @@ err:
 	iconv_close(converter);
 	return ret;
 }
+
+int mkdir_p(char *dir, mode_t mode)
+{
+    struct stat sb;
+
+    if (!dir)
+        return EINVAL;
+
+    if (!stat(dir, &sb))
+        return 0;
+
+    mkdir_p(dirname(strdupa(dir)), mode);
+
+    return mkdir(dir, mode);
+}

src/libratbag-util.h

@@ -62,6 +62,8 @@ int list_empty(const struct list *list);
 	     pos = tmp,							\
 	     tmp = container_of(pos->member.next, tmp, member))
 
+int mkdir_p(char *dir, mode_t mode);
+
 static inline char*
 strncpy_safe(char *dest, const char *src, size_t n)
 {

tools/hidpp10-dump-page.c

@@ -98,7 +98,9 @@ main(int argc, char **argv)
 		error(1, errno, "Failed to open path %s", path);
 
 	hidpp_device_init(&base, fd);
-	dev = hidpp10_device_new(&base, HIDPP_WIRED_DEVICE_IDX, HIDPP10_PROFILE_UNKNOWN, 5);
+	rc = hidpp10_device_new(&base, HIDPP_WIRED_DEVICE_IDX, HIDPP10_PROFILE_UNKNOWN, 5, &dev);
+	if (rc)
+		return rc;
 
 	if (argc == 2)
 		rc = dump_all_pages(dev);

tools/ratbagctl.in.in

@@ -193,14 +193,18 @@ def print_profile(d, p, level):
                                                        " (active)" if p.is_active else ""))
     if p.enabled:
         print(" " * level + "Name: {}".format(p.name or 'n/a'))
-        print(" " * level + "Report Rate: {}Hz".format(p.report_rate))
-        print(" " * level + "Resolutions:")
-        for r in p.resolutions:
-            print_resolution(d, p, r, level + 2)
-        for b in p.buttons:
-            print_button(d, p, b, level)
-        for l in p.leds:
-            print_led(d, p, l, level)
+        if p.report_rate:
+            print(" " * level + "Report Rate: {}Hz".format(p.report_rate))
+        if p.resolutions:
+            print(" " * level + "Resolutions:")
+            for r in p.resolutions:
+                print_resolution(d, p, r, level + 2)
+        if p.buttons:
+            for b in p.buttons:
+                print_button(d, p, b, level)
+        if p.leds:
+            for l in p.leds:
+                print_led(d, p, l, level)
 
 
 def print_device(d, level):