HID: logitech-hidpp: fix Signature M650 side button timing

Some Logitech HID++ 2.0 mice can report diverted reprogrammable controls through HID++ feature 0x1b04, SpecialKeysMseButtons / REPROG_CONTROLS_V4, instead of the normal HID mouse report.

Add a quirk-gated event path for those controls. The handler temporarily diverts verified per-product controls, parses divertedButtonsEvent as the current pressed-control list, and reports the corresponding evdev key state for every mapped control.

Keep the control mappings in per-product profiles so adding support for another mouse does not change the evdev capabilities advertised by already-supported devices.

Documentation for feature 0x1b04 describes divertedButtonsEvent as a list of currently pressed diverted buttons, which is the event format handled here.

Link https://lekensteyn.nl/files/logitech/x1b04_specialkeysmsebuttons.html

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 215 +++++++++++++++++++++++++++++++

 1 file changed, 215 insertions(+)

drivers/hid/hid-logitech-hidpp.c +1 -0

index 70ba1a5e40d8..24c9cfaa4f37 100644
@@ -76,6 +76,7 @@ MODULE_PARM_DESC(disable_tap_to_click,
  #define HIDPP_QUIRK_HI_RES_SCROLL_1P0		BIT(28)
  #define HIDPP_QUIRK_WIRELESS_STATUS		BIT(29)
  #define HIDPP_QUIRK_RESET_HI_RES_SCROLL		BIT(30)
+#define HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS	BIT(31)

 /* These are just aliases for now */
 #define HIDPP_QUIRK_KBD_SCROLL_WHEEL HIDPP_QUIRK_HIDPP_WHEELS

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -205,6 +206,7 @@ struct hidpp_device {
  	struct hidpp_scroll_counter vertical_wheel_counter;

  u8 wireless_feature_index;

drivers/hid/hid-logitech-hidpp.c +1 -0

+	u8 reprog_controls_feature_index;

  int hires_wheel_multiplier;
  u8 hires_wheel_feature_index;

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3601,6 +3603,209 @@ static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
  	return 1;
  }

drivers/hid/hid-logitech-hidpp.c +15 -0

+/* -------------------------------------------------------------------------- */
+/* HID++2.0 reprogrammable controls                                           */
+/* -------------------------------------------------------------------------- */
+
+#define HIDPP_PAGE_REPROG_CONTROLS_V4			0x1b04
+
+#define HIDPP_REPROG_CONTROLS_GET_COUNT			0x00
+#define HIDPP_REPROG_CONTROLS_GET_CID_INFO		0x10
+#define HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING	0x30
+
+#define HIDPP_REPROG_CONTROLS_FLAG_MOUSE		BIT(0)
+#define HIDPP_REPROG_CONTROLS_FLAG_DIVERT		BIT(5)
+
+#define HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED	BIT(0)
+#define HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT	BIT(1)

drivers/hid/hid-logitech-hidpp.c +91 -0

+	unsigned int mapping_count;
+};
+
+static const struct hidpp_reprog_controls_profile *
+hidpp20_reprog_controls_get_profile(struct hidpp_device *hidpp)
+{
+	return NULL;
+}
+
+static int hidpp20_reprog_controls_get_count(struct hidpp_device *hidpp)
+{
+	struct hidpp_report response;
+	u8 feature_index = hidpp->reprog_controls_feature_index;
+	u8 cmd = HIDPP_REPROG_CONTROLS_GET_COUNT;
+	int ret;
+
+	ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, NULL, 0,
+					  &response);
+	if (ret > 0)
+		return -EPROTO;
+	if (ret)
+		return ret;
+
+	return response.fap.params[0];
+}
+
+static int hidpp20_reprog_controls_get_cid_info(struct hidpp_device *hidpp,
+						u8 index, u16 *control,
+						u8 *flags)
+{
+	struct hidpp_report response;
+	u8 feature_index = hidpp->reprog_controls_feature_index;
+	u8 cmd = HIDPP_REPROG_CONTROLS_GET_CID_INFO;
+	int ret;
+
+	ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, &index,
+					  sizeof(index), &response);
+	if (ret > 0)
+		return -EPROTO;
+	if (ret)
+		return ret;
+
+	*control = get_unaligned_be16(&response.fap.params[0]);
+	*flags = response.fap.params[4];
+
+	return 0;
+}
+
+static bool hidpp20_reprog_controls_find_control(struct hidpp_device *hidpp,
+						 u16 control)
+{
+	int count, ret;
+	u16 cid;
+	u8 flags;
+	int i;
+
+	count = hidpp20_reprog_controls_get_count(hidpp);
+	if (count < 0)
+		return false;
+
+	for (i = 0; i < count; i++) {
+		ret = hidpp20_reprog_controls_get_cid_info(hidpp, i, &cid,
+							   &flags);
+		if (ret)
+			return false;
+
+		if (cid == control)
+			return (flags & HIDPP_REPROG_CONTROLS_FLAG_MOUSE) &&
+			       (flags & HIDPP_REPROG_CONTROLS_FLAG_DIVERT);
+	}
+
+	return false;
+}
+
+static int hidpp20_reprog_controls_set_control_reporting(struct hidpp_device *hidpp,
+							 u16 control, u8 flags)
+{
+	struct hidpp_report response;
+	u8 params[5];
+
+	put_unaligned_be16(control, &params[0]);
+	params[2] = flags;
+	put_unaligned_be16(control, &params[3]);
+
+	return hidpp_send_fap_command_sync(hidpp,
+					   hidpp->reprog_controls_feature_index,
+					   HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING,
+					   params, sizeof(params), &response);
+}
+
+static void hidpp20_reprog_controls_connect(struct hidpp_device *hidpp)

drivers/hid/hid-logitech-hidpp.c +77 -0

+	if (!profile)
+		return;
+
+	if (hidpp_root_get_feature(hidpp, HIDPP_PAGE_REPROG_CONTROLS_V4,
+				   &hidpp->reprog_controls_feature_index))
+		return;
+
+	for (i = 0; i < profile->mapping_count; i++) {
+		u16 control = profile->mappings[i].control;
+
+		if (!hidpp20_reprog_controls_find_control(hidpp, control))
+			continue;
+
+		hidpp20_reprog_controls_set_control_reporting(hidpp, control, flags);
+	}
+}
+
+static int hidpp20_reprog_controls_raw_event(struct hidpp_device *hidpp,
+					     u8 *data, int size)
+{
+	const struct hidpp_reprog_controls_profile *profile;
+	const struct hidpp_reprog_control_mapping *mapping;
+	struct hidpp_report *report = (struct hidpp_report *)data;
+	u16 controls[4];
+	bool pressed;
+	unsigned int i, j;
+
+	if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS) ||
+	    !hidpp->input ||
+	    hidpp->reprog_controls_feature_index == 0xff)
+		return 0;
+
+	profile = hidpp20_reprog_controls_get_profile(hidpp);
+	if (!profile)
+		return 0;
+
+	if (size < HIDPP_REPORT_LONG_LENGTH ||
+	    report->fap.feature_index != hidpp->reprog_controls_feature_index ||
+	    report->fap.funcindex_clientid != HIDPP_REPROG_CONTROLS_EVENT_DIVERTED)
+		return 0;
+
+	for (i = 0; i < ARRAY_SIZE(controls); i++)
+		controls[i] = get_unaligned_be16(&report->fap.params[i * 2]);
+
+	for (i = 0; i < profile->mapping_count; i++) {
+		mapping = &profile->mappings[i];
+		pressed = false;
+
+		for (j = 0; j < ARRAY_SIZE(controls); j++) {
+			if (controls[j] == mapping->control) {
+				pressed = true;
+				break;
+			}
+		}
+
+		input_report_key(hidpp->input, mapping->code, pressed);
+	}
+
+	input_sync(hidpp->input);
+
+	return 1;
+}
+
+static void hidpp20_reprog_controls_populate_input(struct hidpp_device *hidpp,
+						   struct input_dev *input_dev)
+{
+	const struct hidpp_reprog_controls_profile *profile;
+	unsigned int i;
+
+	profile = hidpp20_reprog_controls_get_profile(hidpp);
+	if (!profile)
+		return;
+
+	for (i = 0; i < profile->mapping_count; i++)
+		input_set_capability(input_dev, EV_KEY, profile->mappings[i].code);
+}
+

 static void hidpp10_extra_mouse_buttons_populate_input(
  struct hidpp_device *hidpp, struct input_dev *input_dev) {

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3859,6 +4064,9 @@ static void hidpp_populate_input(struct hidpp_device *hidpp,

  if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS) hidpp10_extra_mouse_buttons_populate_input(hidpp, input);

drivers/hid/hid-logitech-hidpp.c +3 -0

+
+	if (hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS)
+		hidpp20_reprog_controls_populate_input(hidpp, input);

 }

 static int hidpp_input_configured(struct hid_device *hdev,

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3971,6 +4179,10 @@ static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
  			return ret;
  	}

drivers/hid/hid-logitech-hidpp.c +4 -0

+	ret = hidpp20_reprog_controls_raw_event(hidpp, data, size);
+	if (ret != 0)
+		return ret;
+

  if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) { ret = hidpp10_consumer_keys_raw_event(hidpp, data, size); if (ret != 0)

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -4264,6 +4476,8 @@ static void hidpp_connect_event(struct work_struct *work)
  			return;
  	}

drivers/hid/hid-logitech-hidpp.c +2 -0

+	hidpp20_reprog_controls_connect(hidpp);
+

  if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) { ret = hidpp10_consumer_keys_connect(hidpp); if (ret)

drivers/hid/hid-logitech-hidpp.c +1 -0

@@ -4436,6 +4650,7 @@ static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
  	hidpp->hid_dev = hdev;
  	hidpp->name = hdev->name;
  	hidpp->quirks = id->driver_data;
+	hidpp->reprog_controls_feature_index = 0xff;
  	hid_set_drvdata(hdev, hidpp);

  ret = hid_parse(hdev);

Quoted 4 lines · Elliot Douglas

Some Logitech HID++ 2.0 mice can report diverted reprogrammable controls through HID++ feature 0x1b04, SpecialKeysMseButtons / REPROG_CONTROLS_V4, instead of the normal HID mouse report.

Quoted 8 lines

Add a quirk-gated event path for those controls. The handler temporarily diverts verified per-product controls, parses divertedButtonsEvent as the current pressed-control list, and reports the corresponding evdev key state for every mapped control.

Keep the control mappings in per-product profiles so adding support for another mouse does not change the evdev capabilities advertised by already-supported devices.

How does this forced setting work/clash with the programmable buttons in Solaar?

I've added some inline comments below.

Quoted 51 lines

Documentation for feature 0x1b04 describes divertedButtonsEvent as a list of currently pressed diverted buttons, which is the event format handled here.

Link https://lekensteyn.nl/files/logitech/x1b04_specialkeysmsebuttons.html

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 215 +++++++++++++++++++++++++++++++
 1 file changed, 215 insertions(+)

drivers/hid/hid-logitech-hidpp.c +17 -0

index 70ba1a5e40d8..24c9cfaa4f37 100644
@@ -76,6 +76,7 @@ MODULE_PARM_DESC(disable_tap_to_click,
 #define HIDPP_QUIRK_HI_RES_SCROLL_1P0                BIT(28)
 #define HIDPP_QUIRK_WIRELESS_STATUS          BIT(29)
 #define HIDPP_QUIRK_RESET_HI_RES_SCROLL              BIT(30)
+#define HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS       BIT(31)
 
 /* These are just aliases for now */
 #define HIDPP_QUIRK_KBD_SCROLL_WHEEL HIDPP_QUIRK_HIDPP_WHEELS

@@ -205,6 +206,7 @@ struct hidpp_device {
      struct hidpp_scroll_counter vertical_wheel_counter;
 
      u8 wireless_feature_index;
+     u8 reprog_controls_feature_index;
 
      int hires_wheel_multiplier;
      u8 hires_wheel_feature_index;

@@ -3601,6 +3603,209 @@ static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
      return 1;
 }
 
+/* -------------------------------------------------------------------------- */
+/* HID++2.0 reprogrammable controls                                           */
+/* -------------------------------------------------------------------------- */
+
+#define HIDPP_PAGE_REPROG_CONTROLS_V4                        0x1b04
+
+#define HIDPP_REPROG_CONTROLS_GET_COUNT                      0x00
+#define HIDPP_REPROG_CONTROLS_GET_CID_INFO           0x10
+#define HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING  0x30
+
+#define HIDPP_REPROG_CONTROLS_FLAG_MOUSE             BIT(0)
+#define HIDPP_REPROG_CONTROLS_FLAG_DIVERT            BIT(5)
+
+#define HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED     BIT(0)
+#define HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT        BIT(1)

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3630

Quoted 10 lines

drivers/hid/hid-logitech-hidpp.c +10 -0

+
+#define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED         0x00
+
+struct hidpp_reprog_control_mapping {
+     u16 control;
+     u16 code;
+};
+
+struct hidpp_reprog_controls_profile {
+     const struct hidpp_reprog_control_mapping *mappings;

probably needs a __counted_by(), or maybe as it's static, it might be better to not require an intermediate struct, and return a NULL- terminated array instead.

Quoted 91 lines

drivers/hid/hid-logitech-hidpp.c +91 -0

+     unsigned int mapping_count;
+};
+
+static const struct hidpp_reprog_controls_profile *
+hidpp20_reprog_controls_get_profile(struct hidpp_device *hidpp)
+{
+     return NULL;
+}
+
+static int hidpp20_reprog_controls_get_count(struct hidpp_device *hidpp)
+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_COUNT;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, NULL, 0,
+                                       &response);
+     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;
+
+     return response.fap.params[0];
+}
+
+static int hidpp20_reprog_controls_get_cid_info(struct hidpp_device *hidpp,
+                                             u8 index, u16 *control,
+                                             u8 *flags)
+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_CID_INFO;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, &index,
+                                       sizeof(index), &response);
+     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;
+
+     *control = get_unaligned_be16(&response.fap.params[0]);
+     *flags = response.fap.params[4];
+
+     return 0;
+}
+
+static bool hidpp20_reprog_controls_find_control(struct hidpp_device *hidpp,
+                                              u16 control)
+{
+     int count, ret;
+     u16 cid;
+     u8 flags;
+     int i;
+
+     count = hidpp20_reprog_controls_get_count(hidpp);
+     if (count < 0)
+             return false;
+
+     for (i = 0; i < count; i++) {
+             ret = hidpp20_reprog_controls_get_cid_info(hidpp, i, &cid,
+                                                        &flags);
+             if (ret)
+                     return false;
+
+             if (cid == control)
+                     return (flags & HIDPP_REPROG_CONTROLS_FLAG_MOUSE) &&
+                            (flags & HIDPP_REPROG_CONTROLS_FLAG_DIVERT);
+     }
+
+     return false;
+}
+
+static int hidpp20_reprog_controls_set_control_reporting(struct hidpp_device *hidpp,
+                                                      u16 control, u8 flags)
+{
+     struct hidpp_report response;
+     u8 params[5];
+
+     put_unaligned_be16(control, &params[0]);
+     params[2] = flags;
+     put_unaligned_be16(control, &params[3]);
+
+     return hidpp_send_fap_command_sync(hidpp,
+                                        hidpp->reprog_controls_feature_index,
+                                        HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING,
+                                        params, sizeof(params), &response);
+}
+
+static void hidpp20_reprog_controls_connect(struct hidpp_device *hidpp)

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3731

Quoted 10 lines

drivers/hid/hid-logitech-hidpp.c +10 -0

+{
+     const struct hidpp_reprog_controls_profile *profile;
+     u8 flags = HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED |
+                HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT;
+     unsigned int i;
+
+     if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS))
+             return;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);

Could the profile be cached in the hidpp_device struct?

Quoted 118 lines

drivers/hid/hid-logitech-hidpp.c +87 -0

+     if (!profile)
+             return;
+
+     if (hidpp_root_get_feature(hidpp, HIDPP_PAGE_REPROG_CONTROLS_V4,
+                                &hidpp->reprog_controls_feature_index))
+             return;
+
+     for (i = 0; i < profile->mapping_count; i++) {
+             u16 control = profile->mappings[i].control;
+
+             if (!hidpp20_reprog_controls_find_control(hidpp, control))
+                     continue;
+
+             hidpp20_reprog_controls_set_control_reporting(hidpp, control, flags);
+     }
+}
+
+static int hidpp20_reprog_controls_raw_event(struct hidpp_device *hidpp,
+                                          u8 *data, int size)
+{
+     const struct hidpp_reprog_controls_profile *profile;
+     const struct hidpp_reprog_control_mapping *mapping;
+     struct hidpp_report *report = (struct hidpp_report *)data;
+     u16 controls[4];
+     bool pressed;
+     unsigned int i, j;
+
+     if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS) ||
+         !hidpp->input ||
+         hidpp->reprog_controls_feature_index == 0xff)
+             return 0;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return 0;
+
+     if (size < HIDPP_REPORT_LONG_LENGTH ||
+         report->fap.feature_index != hidpp->reprog_controls_feature_index ||
+         report->fap.funcindex_clientid != HIDPP_REPROG_CONTROLS_EVENT_DIVERTED)
+             return 0;
+
+     for (i = 0; i < ARRAY_SIZE(controls); i++)
+             controls[i] = get_unaligned_be16(&report->fap.params[i * 2]);
+
+     for (i = 0; i < profile->mapping_count; i++) {
+             mapping = &profile->mappings[i];
+             pressed = false;
+
+             for (j = 0; j < ARRAY_SIZE(controls); j++) {
+                     if (controls[j] == mapping->control) {
+                             pressed = true;
+                             break;
+                     }
+             }
+
+             input_report_key(hidpp->input, mapping->code, pressed);
+     }
+
+     input_sync(hidpp->input);
+
+     return 1;
+}
+
+static void hidpp20_reprog_controls_populate_input(struct hidpp_device *hidpp,
+                                                struct input_dev *input_dev)
+{
+     const struct hidpp_reprog_controls_profile *profile;
+     unsigned int i;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return;
+
+     for (i = 0; i < profile->mapping_count; i++)
+             input_set_capability(input_dev, EV_KEY, profile->mappings[i].code);
+}
+
 static void hidpp10_extra_mouse_buttons_populate_input(
                      struct hidpp_device *hidpp, struct input_dev *input_dev)
 {

@@ -3859,6 +4064,9 @@ static void hidpp_populate_input(struct hidpp_device *hidpp,
 
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS)
              hidpp10_extra_mouse_buttons_populate_input(hidpp, input);
+
+     if (hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS)
+             hidpp20_reprog_controls_populate_input(hidpp, input);
 }
 
 static int hidpp_input_configured(struct hid_device *hdev,

@@ -3971,6 +4179,10 @@ static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
                      return ret;
      }
 
+     ret = hidpp20_reprog_controls_raw_event(hidpp, data, size);
+     if (ret != 0)
+             return ret;
+
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_raw_event(hidpp, data, size);
              if (ret != 0)

@@ -4264,6 +4476,8 @@ static void hidpp_connect_event(struct work_struct *work)
                      return;
      }
 
+     hidpp20_reprog_controls_connect(hidpp);
+
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_connect(hidpp);
              if (ret)

@@ -4436,6 +4650,7 @@ static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
      hidpp->hid_dev = hdev;
      hidpp->name = hdev->name;
      hidpp->quirks = id->driver_data;
+     hidpp->reprog_controls_feature_index = 0xff;
      hid_set_drvdata(hdev, hidpp);
 
      ret = hid_parse(hdev);

Thanks, that makes sense.

For Solaar, this is not continuously forced. The kernel only programs temporary diversion when the device connects. Solaar can still issue HID++ commands through hidraw, so if Solaar changes reporting for the same controls afterwards, the last writer wins.

If Solaar takes over those controls for custom actions, the kernel would stop receiving the diverted button notifications for normal evdev reporting until the kernel diverts the controls again, for example after reconnect. While the controls remain diverted, hidraw clients should still receive the raw HID++ reports.

I have addressed the inline comments locally for v2:
- replaced the profile/count wrapper with NULL-terminated mapping arrays
- cached the selected mapping pointer in struct hidpp_device

I'll wait for Benjamin's input to send Patch v2.

Quoted 308 lines · Bastien Nocera

Quoted 4 lines · Elliot Douglas

Some Logitech HID++ 2.0 mice can report diverted reprogrammable controls through HID++ feature 0x1b04, SpecialKeysMseButtons / REPROG_CONTROLS_V4, instead of the normal HID mouse report.

Quoted 8 lines

Add a quirk-gated event path for those controls. The handler temporarily diverts verified per-product controls, parses divertedButtonsEvent as the current pressed-control list, and reports the corresponding evdev key state for every mapped control.

Keep the control mappings in per-product profiles so adding support for another mouse does not change the evdev capabilities advertised by already-supported devices.

How does this forced setting work/clash with the programmable buttons in Solaar?

I've added some inline comments below.

Quoted 51 lines

Documentation for feature 0x1b04 describes divertedButtonsEvent as a list of currently pressed diverted buttons, which is the event format handled here.

Link https://lekensteyn.nl/files/logitech/x1b04_specialkeysmsebuttons.html

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 215 +++++++++++++++++++++++++++++++
 1 file changed, 215 insertions(+)

drivers/hid/hid-logitech-hidpp.c +17 -0

index 70ba1a5e40d8..24c9cfaa4f37 100644
@@ -76,6 +76,7 @@ MODULE_PARM_DESC(disable_tap_to_click,
 #define HIDPP_QUIRK_HI_RES_SCROLL_1P0                BIT(28)
 #define HIDPP_QUIRK_WIRELESS_STATUS          BIT(29)
 #define HIDPP_QUIRK_RESET_HI_RES_SCROLL              BIT(30)
+#define HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS       BIT(31)
 
 /* These are just aliases for now */
 #define HIDPP_QUIRK_KBD_SCROLL_WHEEL HIDPP_QUIRK_HIDPP_WHEELS

@@ -205,6 +206,7 @@ struct hidpp_device {
      struct hidpp_scroll_counter vertical_wheel_counter;
 
      u8 wireless_feature_index;
+     u8 reprog_controls_feature_index;
 
      int hires_wheel_multiplier;
      u8 hires_wheel_feature_index;

@@ -3601,6 +3603,209 @@ static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
      return 1;
 }
 
+/* -------------------------------------------------------------------------- */
+/* HID++2.0 reprogrammable controls                                           */
+/* -------------------------------------------------------------------------- */
+
+#define HIDPP_PAGE_REPROG_CONTROLS_V4                        0x1b04
+
+#define HIDPP_REPROG_CONTROLS_GET_COUNT                      0x00
+#define HIDPP_REPROG_CONTROLS_GET_CID_INFO           0x10
+#define HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING  0x30
+
+#define HIDPP_REPROG_CONTROLS_FLAG_MOUSE             BIT(0)
+#define HIDPP_REPROG_CONTROLS_FLAG_DIVERT            BIT(5)
+
+#define HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED     BIT(0)
+#define HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT        BIT(1)

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3630

Quoted 10 lines

drivers/hid/hid-logitech-hidpp.c +10 -0

+
+#define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED         0x00
+
+struct hidpp_reprog_control_mapping {
+     u16 control;
+     u16 code;
+};
+
+struct hidpp_reprog_controls_profile {
+     const struct hidpp_reprog_control_mapping *mappings;

probably needs a __counted_by(), or maybe as it's static, it might be better to not require an intermediate struct, and return a NULL- terminated array instead.

Quoted 91 lines

drivers/hid/hid-logitech-hidpp.c +91 -0

+     unsigned int mapping_count;
+};
+
+static const struct hidpp_reprog_controls_profile *
+hidpp20_reprog_controls_get_profile(struct hidpp_device *hidpp)
+{
+     return NULL;
+}
+
+static int hidpp20_reprog_controls_get_count(struct hidpp_device *hidpp)
+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_COUNT;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, NULL, 0,
+                                       &response);
+     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;
+
+     return response.fap.params[0];
+}
+
+static int hidpp20_reprog_controls_get_cid_info(struct hidpp_device *hidpp,
+                                             u8 index, u16 *control,
+                                             u8 *flags)
+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_CID_INFO;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index, cmd, &index,
+                                       sizeof(index), &response);
+     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;
+
+     *control = get_unaligned_be16(&response.fap.params[0]);
+     *flags = response.fap.params[4];
+
+     return 0;
+}
+
+static bool hidpp20_reprog_controls_find_control(struct hidpp_device *hidpp,
+                                              u16 control)
+{
+     int count, ret;
+     u16 cid;
+     u8 flags;
+     int i;
+
+     count = hidpp20_reprog_controls_get_count(hidpp);
+     if (count < 0)
+             return false;
+
+     for (i = 0; i < count; i++) {
+             ret = hidpp20_reprog_controls_get_cid_info(hidpp, i, &cid,
+                                                        &flags);
+             if (ret)
+                     return false;
+
+             if (cid == control)
+                     return (flags & HIDPP_REPROG_CONTROLS_FLAG_MOUSE) &&
+                            (flags & HIDPP_REPROG_CONTROLS_FLAG_DIVERT);
+     }
+
+     return false;
+}
+
+static int hidpp20_reprog_controls_set_control_reporting(struct hidpp_device *hidpp,
+                                                      u16 control, u8 flags)
+{
+     struct hidpp_report response;
+     u8 params[5];
+
+     put_unaligned_be16(control, &params[0]);
+     params[2] = flags;
+     put_unaligned_be16(control, &params[3]);
+
+     return hidpp_send_fap_command_sync(hidpp,
+                                        hidpp->reprog_controls_feature_index,
+                                        HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING,
+                                        params, sizeof(params), &response);
+}
+
+static void hidpp20_reprog_controls_connect(struct hidpp_device *hidpp)

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3731

Quoted 10 lines

drivers/hid/hid-logitech-hidpp.c +10 -0

+{
+     const struct hidpp_reprog_controls_profile *profile;
+     u8 flags = HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED |
+                HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT;
+     unsigned int i;
+
+     if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS))
+             return;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);

Could the profile be cached in the hidpp_device struct?

Quoted 118 lines

drivers/hid/hid-logitech-hidpp.c +87 -0

+     if (!profile)
+             return;
+
+     if (hidpp_root_get_feature(hidpp, HIDPP_PAGE_REPROG_CONTROLS_V4,
+                                &hidpp->reprog_controls_feature_index))
+             return;
+
+     for (i = 0; i < profile->mapping_count; i++) {
+             u16 control = profile->mappings[i].control;
+
+             if (!hidpp20_reprog_controls_find_control(hidpp, control))
+                     continue;
+
+             hidpp20_reprog_controls_set_control_reporting(hidpp, control, flags);
+     }
+}
+
+static int hidpp20_reprog_controls_raw_event(struct hidpp_device *hidpp,
+                                          u8 *data, int size)
+{
+     const struct hidpp_reprog_controls_profile *profile;
+     const struct hidpp_reprog_control_mapping *mapping;
+     struct hidpp_report *report = (struct hidpp_report *)data;
+     u16 controls[4];
+     bool pressed;
+     unsigned int i, j;
+
+     if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS) ||
+         !hidpp->input ||
+         hidpp->reprog_controls_feature_index == 0xff)
+             return 0;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return 0;
+
+     if (size < HIDPP_REPORT_LONG_LENGTH ||
+         report->fap.feature_index != hidpp->reprog_controls_feature_index ||
+         report->fap.funcindex_clientid != HIDPP_REPROG_CONTROLS_EVENT_DIVERTED)
+             return 0;
+
+     for (i = 0; i < ARRAY_SIZE(controls); i++)
+             controls[i] = get_unaligned_be16(&report->fap.params[i * 2]);
+
+     for (i = 0; i < profile->mapping_count; i++) {
+             mapping = &profile->mappings[i];
+             pressed = false;
+
+             for (j = 0; j < ARRAY_SIZE(controls); j++) {
+                     if (controls[j] == mapping->control) {
+                             pressed = true;
+                             break;
+                     }
+             }
+
+             input_report_key(hidpp->input, mapping->code, pressed);
+     }
+
+     input_sync(hidpp->input);
+
+     return 1;
+}
+
+static void hidpp20_reprog_controls_populate_input(struct hidpp_device *hidpp,
+                                                struct input_dev *input_dev)
+{
+     const struct hidpp_reprog_controls_profile *profile;
+     unsigned int i;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return;
+
+     for (i = 0; i < profile->mapping_count; i++)
+             input_set_capability(input_dev, EV_KEY, profile->mappings[i].code);
+}
+
 static void hidpp10_extra_mouse_buttons_populate_input(
                      struct hidpp_device *hidpp, struct input_dev *input_dev)
 {

@@ -3859,6 +4064,9 @@ static void hidpp_populate_input(struct hidpp_device *hidpp,
 
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS)
              hidpp10_extra_mouse_buttons_populate_input(hidpp, input);
+
+     if (hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS)
+             hidpp20_reprog_controls_populate_input(hidpp, input);
 }
 
 static int hidpp_input_configured(struct hid_device *hdev,

@@ -3971,6 +4179,10 @@ static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
                      return ret;
      }
 
+     ret = hidpp20_reprog_controls_raw_event(hidpp, data, size);
+     if (ret != 0)
+             return ret;
+
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_raw_event(hidpp, data, size);
              if (ret != 0)

@@ -4264,6 +4476,8 @@ static void hidpp_connect_event(struct work_struct *work)
                      return;
      }
 
+     hidpp20_reprog_controls_connect(hidpp);
+
      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_connect(hidpp);
              if (ret)

@@ -4436,6 +4650,7 @@ static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
      hidpp->hid_dev = hdev;
      hidpp->name = hdev->name;
      hidpp->quirks = id->driver_data;
+     hidpp->reprog_controls_feature_index = 0xff;
      hid_set_drvdata(hdev, hidpp);
 
      ret = hid_parse(hdev);

Just wanted to poke on this thread again, Benjamin or Bastien, what is needed to
push this forward or should I send the v2 at this point?

Thanks,
Elliot

Quoted 406 lines · Elliot Douglas

Thanks, that makes sense.

For Solaar, this is not continuously forced. The kernel only programs
temporary diversion when the device connects. Solaar can still issue HID++
commands through hidraw, so if Solaar changes reporting for the same controls
afterwards, the last writer wins.

If Solaar takes over those controls for custom actions, the kernel would stop
receiving the diverted button notifications for normal evdev reporting until
the kernel diverts the controls again, for example after reconnect. While the
controls remain diverted, hidraw clients should still receive the raw HID++
reports.

I have addressed the inline comments locally for v2:
- replaced the profile/count wrapper with NULL-terminated mapping arrays
- cached the selected mapping pointer in struct hidpp_device

I'll wait for Benjamin's input to send Patch v2.

Quoted 375 lines · Bastien Nocera

Quoted 12 lines · Elliot Douglas

Some Logitech HID++ 2.0 mice can report diverted reprogrammable controls through HID++ feature 0x1b04, SpecialKeysMseButtons / REPROG_CONTROLS_V4, instead of the normal HID mouse report.

Add a quirk-gated event path for those controls. The handler temporarily
diverts verified per-product controls, parses divertedButtonsEvent as the
current pressed-control list, and reports the corresponding evdev key state
for every mapped control.

Quoted 5 lines

Keep the control mappings in per-product profiles so adding support for
another mouse does not change the evdev capabilities advertised by
already-supported devices.

How does this forced setting work/clash with the programmable buttons
in Solaar?

I've added some inline comments below.

Quoted 64 lines

Documentation for feature 0x1b04 describes divertedButtonsEvent as a list
of currently pressed diverted buttons, which is the event format handled
here.

Link:
https://lekensteyn.nl/files/logitech/x1b04_specialkeysmsebuttons.html

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 215
+++++++++++++++++++++++++++++++

 1 file changed, 215 insertions(+)

drivers/hid/hid-logitech-hidpp.c +2 -0

index 70ba1a5e40d8..24c9cfaa4f37 100644
@@ -76,6 +76,7 @@ MODULE_PARM_DESC(disable_tap_to_click,
  #define HIDPP_QUIRK_HI_RES_SCROLL_1P0                BIT(28)
  #define HIDPP_QUIRK_WIRELESS_STATUS          BIT(29)
  #define HIDPP_QUIRK_RESET_HI_RES_SCROLL              BIT(30)
+#define HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS       BIT(31)
 
  /* These are just aliases for now */
  #define HIDPP_QUIRK_KBD_SCROLL_WHEEL HIDPP_QUIRK_HIDPP_WHEELS

@@ -205,6 +206,7 @@ struct hidpp_device {
       struct hidpp_scroll_counter vertical_wheel_counter;
 
       u8 wireless_feature_index;
+     u8 reprog_controls_feature_index;
 
       int hires_wheel_multiplier;
       u8 hires_wheel_feature_index;

@@ -3601,6 +3603,209 @@ static int

hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
      return 1;
 }

drivers/hid/hid-logitech-hidpp.c +2 -1

+/* -----------------------------------------------------------
--------------- */
+/* HID++2.0 reprogrammable

controls                                           */

drivers/hid/hid-logitech-hidpp.c +3 -1

+/* -----------------------------------------------------------
--------------- */
+
+#define HIDPP_PAGE_REPROG_CONTROLS_V4                       

0x1b04

drivers/hid/hid-logitech-hidpp.c +2 -0

+
+#define HIDPP_REPROG_CONTROLS_GET_COUNT                     

0x00

drivers/hid/hid-logitech-hidpp.c +8 -0

+#define HIDPP_REPROG_CONTROLS_GET_CID_INFO           0x10
+#define HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING  0x30
+
+#define HIDPP_REPROG_CONTROLS_FLAG_MOUSE             BIT(0)
+#define HIDPP_REPROG_CONTROLS_FLAG_DIVERT            BIT(5)
+
+#define HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED     BIT(0)
+#define HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT       

BIT(1)

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3630

Quoted 10 lines

drivers/hid/hid-logitech-hidpp.c +10 -0

+
+#define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED         0x00
+
+struct hidpp_reprog_control_mapping {
+     u16 control;
+     u16 code;
+};
+
+struct hidpp_reprog_controls_profile {
+     const struct hidpp_reprog_control_mapping *mappings;

probably needs a __counted_by(), or maybe as it's static, it might be
better to not require an intermediate struct, and return a NULL- terminated array instead.

Quoted 117 lines

+     unsigned int mapping_count;

drivers/hid/hid-logitech-hidpp.c +4 -0

+};
+
+static const struct hidpp_reprog_controls_profile *
+hidpp20_reprog_controls_get_profile(struct hidpp_device

*hidpp)

drivers/hid/hid-logitech-hidpp.c +5 -0

+{
+     return NULL;
+}
+
+static int hidpp20_reprog_controls_get_count(struct

hidpp_device *hidpp)

drivers/hid/hid-logitech-hidpp.c +7 -0

+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_COUNT;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index,

cmd, NULL, 0,
+                                       &response); +     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;

drivers/hid/hid-logitech-hidpp.c +5 -0

+
+     return response.fap.params[0];
+}
+
+static int hidpp20_reprog_controls_get_cid_info(struct

hidpp_device *hidpp,
+                                             u8 index, u16 *control,
+                                             u8 *flags)

drivers/hid/hid-logitech-hidpp.c +7 -0

+{
+     struct hidpp_report response;
+     u8 feature_index = hidpp->reprog_controls_feature_index;
+     u8 cmd = HIDPP_REPROG_CONTROLS_GET_CID_INFO;
+     int ret;
+
+     ret = hidpp_send_fap_command_sync(hidpp, feature_index,

cmd, &index,
+                                       sizeof(index), &response);
+     if (ret > 0)
+             return -EPROTO;
+     if (ret)
+             return ret;

drivers/hid/hid-logitech-hidpp.c +8 -0

+
+     *control = get_unaligned_be16(&response.fap.params[0]);
+     *flags = response.fap.params[4];
+
+     return 0;
+}
+
+static bool hidpp20_reprog_controls_find_control(struct

hidpp_device *hidpp,
+                                              u16 control)

drivers/hid/hid-logitech-hidpp.c +12 -0

+{
+     int count, ret;
+     u16 cid;
+     u8 flags;
+     int i;
+
+     count = hidpp20_reprog_controls_get_count(hidpp);
+     if (count < 0)
+             return false;
+
+     for (i = 0; i < count; i++) {
+             ret = hidpp20_reprog_controls_get_cid_info(hidpp,

i, &cid,
+
&flags);
+             if (ret)
+                     return false;
+
+             if (cid == control)
+                     return (flags &
HIDPP_REPROG_CONTROLS_FLAG_MOUSE) &&
+                            (flags &
HIDPP_REPROG_CONTROLS_FLAG_DIVERT);
+     }

drivers/hid/hid-logitech-hidpp.c +5 -0

+
+     return false;
+}
+
+static int

hidpp20_reprog_controls_set_control_reporting(struct hidpp_device *hidpp,
+                                                      u16 control, u8 flags)

drivers/hid/hid-logitech-hidpp.c +10 -0

+{
+     struct hidpp_report response;
+     u8 params[5];
+
+     put_unaligned_be16(control, &params[0]);
+     params[2] = flags;
+     put_unaligned_be16(control, &params[3]);
+
+     return hidpp_send_fap_command_sync(hidpp,
+                                        hidpp-

Quoted 1 line

reprog_controls_feature_index,

+
HIDPP_REPROG_CONTROLS_SET_CONTROL_REPORTING,
+                                        params,
sizeof(params), &response);

drivers/hid/hid-logitech-hidpp.c +3 -0

+}
+
+static void hidpp20_reprog_controls_connect(struct

hidpp_device *hidpp)

drivers/hid/hid-logitech-hidpp.c +7 -0

+{
+     const struct hidpp_reprog_controls_profile *profile;
+     u8 flags = HIDPP_REPROG_CONTROLS_TEMPORARY_DIVERTED |
+                HIDPP_REPROG_CONTROLS_CHANGE_TEMPORARY_DIVERT;
+     unsigned int i;
+
+     if (!(hidpp->quirks &

Quoted 4 lines

HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS))
+             return;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);

Could the profile be cached in the hidpp_device struct?

Quoted 145 lines

+     if (!profile)
+             return;
+
+     if (hidpp_root_get_feature(hidpp,
HIDPP_PAGE_REPROG_CONTROLS_V4,
+                                &hidpp-

Quoted 1 line

reprog_controls_feature_index))

+             return;

drivers/hid/hid-logitech-hidpp.c +5 -0

+
+     for (i = 0; i < profile->mapping_count; i++) {
+             u16 control = profile->mappings[i].control;
+
+             if (!hidpp20_reprog_controls_find_control(hidpp,

control))
+                     continue;
+
+ hidpp20_reprog_controls_set_control_reporting(hidpp, control, flags);
+     }

drivers/hid/hid-logitech-hidpp.c +3 -0

+}
+
+static int hidpp20_reprog_controls_raw_event(struct

hidpp_device *hidpp,
+                                          u8 *data, int size) +{
+     const struct hidpp_reprog_controls_profile *profile; +     const struct hidpp_reprog_control_mapping *mapping; +     struct hidpp_report *report = (struct hidpp_report *)data;
+     u16 controls[4];
+     bool pressed;
+     unsigned int i, j;
+
+     if (!(hidpp->quirks & HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS) ||
+         !hidpp->input ||
+         hidpp->reprog_controls_feature_index == 0xff) +             return 0;

drivers/hid/hid-logitech-hidpp.c +7 -0

+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return 0;
+
+     if (size < HIDPP_REPORT_LONG_LENGTH ||
+         report->fap.feature_index != hidpp-

Quoted 1 line

reprog_controls_feature_index ||

+         report->fap.funcindex_clientid != HIDPP_REPROG_CONTROLS_EVENT_DIVERTED)
+             return 0;
+
+     for (i = 0; i < ARRAY_SIZE(controls); i++) +             controls[i] = get_unaligned_be16(&report-

Quoted 1 line

fap.params[i * 2]);

drivers/hid/hid-logitech-hidpp.c +13 -0

+
+     for (i = 0; i < profile->mapping_count; i++) {
+             mapping = &profile->mappings[i];
+             pressed = false;
+
+             for (j = 0; j < ARRAY_SIZE(controls); j++) {
+                     if (controls[j] == mapping->control) {
+                             pressed = true;
+                             break;
+                     }
+             }
+
+             input_report_key(hidpp->input, mapping->code,

pressed);
+     }

drivers/hid/hid-logitech-hidpp.c +7 -0

+
+     input_sync(hidpp->input);
+
+     return 1;
+}
+
+static void hidpp20_reprog_controls_populate_input(struct

hidpp_device *hidpp,
+                                                struct input_dev *input_dev)

drivers/hid/hid-logitech-hidpp.c +10 -0

+{
+     const struct hidpp_reprog_controls_profile *profile;
+     unsigned int i;
+
+     profile = hidpp20_reprog_controls_get_profile(hidpp);
+     if (!profile)
+             return;
+
+     for (i = 0; i < profile->mapping_count; i++)
+             input_set_capability(input_dev, EV_KEY, profile-

Quoted 1 line

mappings[i].code);

drivers/hid/hid-logitech-hidpp.c +2 -0

+}
+

 static void hidpp10_extra_mouse_buttons_populate_input( struct hidpp_device *hidpp, struct input_dev *input_dev)
 {

drivers/hid/hid-logitech-hidpp.c +3 -0

@@ -3859,6 +4064,9 @@ static void hidpp_populate_input(struct
 hidpp_device *hidpp,
 
       if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS)
               hidpp10_extra_mouse_buttons_populate_input(hidpp,
 input);
+
+     if (hidpp->quirks &
 HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS)
+             hidpp20_reprog_controls_populate_input(hidpp,

input);
 }

 static int hidpp_input_configured(struct hid_device *hdev,

drivers/hid/hid-logitech-hidpp.c +4 -0

@@ -3971,6 +4179,10 @@ static int hidpp_raw_hidpp_event(struct
 hidpp_device *hidpp, u8 *data,
                       return ret;
       }
 
+     ret = hidpp20_reprog_controls_raw_event(hidpp, data,
 size);
+     if (ret != 0)
+             return ret;
+

      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_raw_event(hidpp, data, size);
              if (ret != 0)

drivers/hid/hid-logitech-hidpp.c +2 -0

@@ -4264,6 +4476,8 @@ static void hidpp_connect_event(struct
 work_struct *work)
                       return;
       }
 
+     hidpp20_reprog_controls_connect(hidpp);
+

      if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
              ret = hidpp10_consumer_keys_connect(hidpp); if (ret)

drivers/hid/hid-logitech-hidpp.c +1 -0

@@ -4436,6 +4650,7 @@ static int hidpp_probe(struct hid_device
 *hdev, const struct hid_device_id *id)
       hidpp->hid_dev = hdev;
       hidpp->name = hdev->name;
       hidpp->quirks = id->driver_data;
+     hidpp->reprog_controls_feature_index = 0xff;
       hid_set_drvdata(hdev, hidpp);
 

      ret = hid_parse(hdev);

The Bluetooth Signature M650 exposes its side buttons through the normal
mouse report, but the observed events are short click-like events emitted
around release rather than physical press/release state.

The device appears to use the held side-button state for its built-in gesture and side-button + wheel horizontal-scroll mode. As a result, holding a side button long enough can prevent the normal mouse report from
emitting a usable button event at all.

HID++ REPROG_CONTROLS_V4 diversion for control IDs 0x0053 and 0x0056 provides real press and release timing for those same controls. Logitech
documents the Signature M650 side buttons as Back/Forward buttons, so report the diverted controls as BTN_BACK and BTN_FORWARD.

Link:
https://support.logi.com/hc/en-nz/articles/4414473810583-Getting-Started-Signature-M650

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 21 ++++++++++++++++++++-

 1 file changed, 20 insertions(+), 1 deletion(-)

drivers/hid/hid- renamed from drivers/hid/hid-logitech-hidpp.c +0 -0

logitech-hidpp.c
index 24c9cfaa4f37..80108778ee80 100644

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3621,6 +3621,9 @@ static int
 hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,

 #define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED 0x00

+
 struct hidpp_reprog_control_mapping {
  u16 control;
  u16 code;

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3631,9 +3634,24 @@ struct hidpp_reprog_controls_profile {
  	unsigned int mapping_count;
  };

+static const struct hidpp_reprog_control_mapping
m650_reprog_control_mappings[] = {

drivers/hid/hid-logitech-hidpp.c +5 -0

+	{ HIDPP_REPROG_CONTROL_M650_BACK, BTN_BACK },
+	{ HIDPP_REPROG_CONTROL_M650_FORWARD, BTN_FORWARD },
+};
+
+static const struct hidpp_reprog_controls_profile

m650_reprog_controls_profile = {

drivers/hid/hid-logitech-hidpp.c +4 -0

+	.mappings = m650_reprog_control_mappings,
+	.mapping_count = ARRAY_SIZE(m650_reprog_control_mappings),
+};
+

 static const struct hidpp_reprog_controls_profile * hidpp20_reprog_controls_get_profile(struct hidpp_device *hidpp) {

drivers/hid/hid-logitech-hidpp.c +3 -0

+		return &m650_reprog_controls_profile;
+	}
+

  return NULL;
 }

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -4921,7 +4939,8 @@ static const struct hid_device_id
 hidpp_devices[] = {

  { /* MX Vertical mouse over Bluetooth */ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb020) }, { /* Signature M650 over Bluetooth */

drivers/hid/hid-logitech-hidpp.c +2 -1

-	  HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb02a) },
+	  HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb02a),
+	  .driver_data = HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS },

  { /* MX Master 3 mouse over Bluetooth */ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb023) }, { /* MX Anywhere 3 mouse over Bluetooth */

The Bluetooth Signature M650 exposes its side buttons through the normal
mouse report, but the observed events are short click-like events emitted
around release rather than physical press/release state.

The device appears to use the held side-button state for its built-in gesture and side-button + wheel horizontal-scroll mode. As a result, holding a side button long enough

can prevent the normal mouse report from
emitting a usable button event at all.

HID++ REPROG_CONTROLS_V4 diversion for control IDs 0x0053 and 0x0056 provides real press and release timing for those same controls. Logitech
documents the Signature M650 side buttons as Back/Forward buttons, so report the diverted controls as BTN_BACK and BTN_FORWARD.

The HID++ 0x1b04 documentation lists those control IDs as Back and Forward. The driver still verifies that the controls are present in the
device control table and advertised as divertable before changing their
reporting mode.

Link:
https://support.logi.com/hc/en-nz/articles/4414473810583-Getting-Started-Signature-M650

Signed-off-by Elliot Douglas <[email protected]>

---
 drivers/hid/hid-logitech-hidpp.c | 20 +++++++++++++++++++-

 1 file changed, 19 insertions(+), 1 deletion(-)

drivers/hid/hid- renamed from drivers/hid/hid-logitech-hidpp.c +0 -0

logitech-hidpp.c
index f9189e14fb78..e71dd2457e80 100644

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3624,14 +3624,30 @@ static int
 hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,

 #define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED 0x00

+
 struct hidpp_reprog_control_mapping {
  u16 control;
  u16 code;
 };

+static const struct hidpp_reprog_control_mapping
m650_reprog_control_mappings[] = {
+ { HIDPP_REPROG_CONTROL_BACK, BTN_BACK },
+ { HIDPP_REPROG_CONTROL_FORWARD, BTN_FORWARD },
+ { }

drivers/hid/hid-logitech-hidpp.c +2 -0

+};
+

 static const struct hidpp_reprog_control_mapping * hidpp20_reprog_controls_get_mappings(struct hidpp_device *hidpp) {
+ switch (hidpp->hid_dev->product) {
+ case HIDPP_PRODUCT_SIGNATURE_M650:
+ return m650_reprog_control_mappings;
+ }
+
  return NULL;
 }

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -4911,7 +4927,9 @@ static const struct hid_device_id
 hidpp_devices[] = {

  { /* MX Vertical mouse over Bluetooth */ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb020) }, { /* Signature M650 over Bluetooth */
-   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb02a) },
+   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
+        HIDPP_PRODUCT_SIGNATURE_M650),
+   .driver_data = HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS }, { /* MX Master 3 mouse over Bluetooth */ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb023) }, { /* MX Anywhere 3 mouse over Bluetooth */

Quoted 9 lines · Elliot Douglas

The Bluetooth Signature M650 exposes its side buttons through the normal
mouse report, but the observed events are short click-like events emitted
around release rather than physical press/release state.

The device appears to use the held side-button state for its built-in gesture and side-button + wheel horizontal-scroll mode. As a result, holding a side button long enough

s/long enough/more than approximately 2 seconds/ ?

Quoted 16 lines

can prevent the normal mouse report from
emitting a usable button event at all.

HID++ REPROG_CONTROLS_V4 diversion for control IDs 0x0053 and 0x0056 provides real press and release timing for those same controls. Logitech
documents the Signature M650 side buttons as Back/Forward buttons, so report the diverted controls as BTN_BACK and BTN_FORWARD.

The HID++ 0x1b04 documentation lists those control IDs as Back and Forward. The driver still verifies that the controls are present in the
device control table and advertised as divertable before changing their
reporting mode.

Quoted 3 lines

Link:
https://support.logi.com/hc/en-nz/articles/4414473810583-Getting-Started-Signature-M650

Signed-off-by Elliot Douglas <[email protected]>

Tested with my M650 mouse connected through Bluetooth.

Reviewed-by Bastien Nocera <[email protected]>

Quoted 10 lines

---
 drivers/hid/hid-logitech-hidpp.c | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

drivers/hid/hid- renamed from drivers/hid/hid-logitech-hidpp.c +0 -0

logitech-hidpp.c
index f9189e14fb78..e71dd2457e80 100644

drivers/hid/hid-logitech-hidpp.c static int · line 3631

Quoted 8 lines

drivers/hid/hid-logitech-hidpp.c +4 -0

@@ -3624,14 +3624,30 @@ static int
 hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
 
 #define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED 0x00
 
+#define HIDPP_REPROG_CONTROL_BACK 0x0053
+#define HIDPP_REPROG_CONTROL_FORWARD 0x0056
+
+#define HIDPP_PRODUCT_SIGNATURE_M650 0xb02a

If you want to add a product ID constant, please do it in hid-ids.h instead.

Quoted 36 lines

drivers/hid/hid-logitech-hidpp.c +12 -0

+
 struct hidpp_reprog_control_mapping {
  u16 control;
  u16 code;
 };
 
+static const struct hidpp_reprog_control_mapping
 m650_reprog_control_mappings[] = {
+ { HIDPP_REPROG_CONTROL_BACK, BTN_BACK },
+ { HIDPP_REPROG_CONTROL_FORWARD, BTN_FORWARD },
+ { }
+};
+
 static const struct hidpp_reprog_control_mapping *
 hidpp20_reprog_controls_get_mappings(struct hidpp_device *hidpp)
 {
+ switch (hidpp->hid_dev->product) {
+ case HIDPP_PRODUCT_SIGNATURE_M650:
+ return m650_reprog_control_mappings;
+ }
+
  return NULL;

}

drivers/hid/hid-logitech-hidpp.c +3 -1

@@ -4911,7 +4927,9 @@ static const struct hid_device_id
 hidpp_devices[] = {
  { /* MX Vertical mouse over Bluetooth */
    HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb020) },
  { /* Signature M650 over Bluetooth */
-   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb02a) },
+   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
+        HIDPP_PRODUCT_SIGNATURE_M650),
+   .driver_data = HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS },
  { /* MX Master 3 mouse over Bluetooth */
    HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb023) },

{ /* MX Anywhere 3 mouse over Bluetooth */

Quoted 6 lines · Elliot Douglas

The Bluetooth Signature M650 exposes its side buttons through the normal
mouse report, but the observed events are short click-like events emitted
around release rather than physical press/release state.

Quoted 3 lines

The device appears to use the held side-button state for its built-in gesture and side-button + wheel horizontal-scroll mode. As a result, holding a side button long enough

s/long enough/more than approximately 2 seconds/ ?

Quoted 16 lines

can prevent the normal mouse report from
emitting a usable button event at all.

HID++ REPROG_CONTROLS_V4 diversion for control IDs 0x0053 and 0x0056 provides real press and release timing for those same controls. Logitech
documents the Signature M650 side buttons as Back/Forward buttons, so report the diverted controls as BTN_BACK and BTN_FORWARD.

The HID++ 0x1b04 documentation lists those control IDs as Back and Forward. The driver still verifies that the controls are present in the
device control table and advertised as divertable before changing their
reporting mode.

Quoted 3 lines

Link:
https://support.logi.com/hc/en-nz/articles/4414473810583-Getting-Started-Signature-M650

Signed-off-by Elliot Douglas <[email protected]>

Tested with my M650 mouse connected through Bluetooth.

Reviewed-by Bastien Nocera <[email protected]>

Quoted 14 lines

---
 drivers/hid/hid-logitech-hidpp.c | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

drivers/hid/hid- renamed from drivers/hid/hid-logitech-hidpp.c +0 -0

logitech-hidpp.c
index f9189e14fb78..e71dd2457e80 100644

drivers/hid/hid-logitech-hidpp.c +0 -0

@@ -3624,14 +3624,30 @@ static int
 hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
 
 #define HIDPP_REPROG_CONTROLS_EVENT_DIVERTED 0x00
 

drivers/hid/hid-logitech-hidpp.c static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp, · line 3630

Quoted 4 lines

drivers/hid/hid-logitech-hidpp.c +4 -0

+#define HIDPP_REPROG_CONTROL_BACK 0x0053
+#define HIDPP_REPROG_CONTROL_FORWARD 0x0056
+
+#define HIDPP_PRODUCT_SIGNATURE_M650 0xb02a

If you want to add a product ID constant, please do it in hid-ids.h instead.

Quoted 36 lines

drivers/hid/hid-logitech-hidpp.c +12 -0

+
 struct hidpp_reprog_control_mapping {
  u16 control;
  u16 code;
 };
 
+static const struct hidpp_reprog_control_mapping
 m650_reprog_control_mappings[] = {
+ { HIDPP_REPROG_CONTROL_BACK, BTN_BACK },
+ { HIDPP_REPROG_CONTROL_FORWARD, BTN_FORWARD },
+ { }
+};
+
 static const struct hidpp_reprog_control_mapping *
 hidpp20_reprog_controls_get_mappings(struct hidpp_device *hidpp)
 {
+ switch (hidpp->hid_dev->product) {
+ case HIDPP_PRODUCT_SIGNATURE_M650:
+ return m650_reprog_control_mappings;
+ }
+
  return NULL;

}

drivers/hid/hid-logitech-hidpp.c +3 -1

@@ -4911,7 +4927,9 @@ static const struct hid_device_id
 hidpp_devices[] = {
  { /* MX Vertical mouse over Bluetooth */
    HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb020) },
  { /* Signature M650 over Bluetooth */
-   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb02a) },
+   HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
+        HIDPP_PRODUCT_SIGNATURE_M650),
+   .driver_data = HIDPP_QUIRK_HIDPP_REPROG_CONTROLS_BTNS },
  { /* MX Master 3 mouse over Bluetooth */
    HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb023) },

{ /* MX Anywhere 3 mouse over Bluetooth */