Merge branch 'for-5.14/logitech' into for-linus
authorJiri Kosina <jkosina@suse.cz>
Wed, 30 Jun 2021 07:12:44 +0000 (09:12 +0200)
committerJiri Kosina <jkosina@suse.cz>
Wed, 30 Jun 2021 07:12:44 +0000 (09:12 +0200)
- support for LCD menu keys + LCD brightness control on the Logitech Z-10
  speakers (with LCD) which use the same protocol as the G15 keyboards
  from Hans de Goede

drivers/hid/hid-ids.h
drivers/hid/hid-ite.c
drivers/hid/hid-lg-g15.c
drivers/hid/hid-logitech-dj.c
drivers/hid/hid-logitech-hidpp.c

index 63ca5959dc679c34ed841dc721b9dce2f0655f52..8f1893e68112b4e72491df4172cff73dda9a1675 100644 (file)
 #define I2C_DEVICE_ID_LG_7010          0x7010
 
 #define USB_VENDOR_ID_LOGITECH         0x046d
+#define USB_DEVICE_ID_LOGITECH_Z_10_SPK        0x0a07
 #define USB_DEVICE_ID_LOGITECH_AUDIOHUB 0x0a0e
 #define USB_DEVICE_ID_LOGITECH_T651    0xb00c
 #define USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD 0xb309
index 14fc068affada8aadaa6584c85a52c831eeac4b7..430fa4f52ed3b88c80ada30b8abdaec6aa6f0ecb 100644 (file)
@@ -135,4 +135,5 @@ static struct hid_driver ite_driver = {
 };
 module_hid_driver(ite_driver);
 
+MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
 MODULE_LICENSE("GPL");
index bfbba0d4193315cc0073beb2782688fd016ec041..b2a08233f8d51318fd271a1969e1281381a52d37 100644 (file)
@@ -28,6 +28,7 @@ enum lg_g15_model {
        LG_G15_V2,
        LG_G510,
        LG_G510_USB_AUDIO,
+       LG_Z10,
 };
 
 enum lg_g15_led_type {
@@ -457,6 +458,13 @@ static int lg_g15_get_initial_led_brightness(struct lg_g15_data *g15)
                        return ret;
 
                return lg_g510_update_mkey_led_brightness(g15);
+       case LG_Z10:
+               /*
+                * Getting the LCD backlight brightness is not supported.
+                * Reading Feature(2) fails with -EPIPE and this crashes
+                * the LCD and touch keys part of the speakers.
+                */
+               return 0;
        }
        return -EINVAL; /* Never reached */
 }
@@ -464,7 +472,20 @@ static int lg_g15_get_initial_led_brightness(struct lg_g15_data *g15)
 /******** Input functions ********/
 
 /* On the G15 Mark I Logitech has been quite creative with which bit is what */
-static int lg_g15_event(struct lg_g15_data *g15, u8 *data, int size)
+static void lg_g15_handle_lcd_menu_keys(struct lg_g15_data *g15, u8 *data)
+{
+       int i, val;
+
+       /* Most left (round/display) button below the LCD */
+       input_report_key(g15->input, KEY_KBD_LCD_MENU1, data[8] & 0x80);
+       /* 4 other buttons below the LCD */
+       for (i = 0; i < 4; i++) {
+               val = data[i + 2] & 0x80;
+               input_report_key(g15->input, KEY_KBD_LCD_MENU2 + i, val);
+       }
+}
+
+static int lg_g15_event(struct lg_g15_data *g15, u8 *data)
 {
        int i, val;
 
@@ -494,13 +515,7 @@ static int lg_g15_event(struct lg_g15_data *g15, u8 *data, int size)
        /* MR */
        input_report_key(g15->input, KEY_MACRO_RECORD_START, data[7] & 0x40);
 
-       /* Most left (round) button below the LCD */
-       input_report_key(g15->input, KEY_KBD_LCD_MENU1, data[8] & 0x80);
-       /* 4 other buttons below the LCD */
-       for (i = 0; i < 4; i++) {
-               val = data[i + 2] & 0x80;
-               input_report_key(g15->input, KEY_KBD_LCD_MENU2 + i, val);
-       }
+       lg_g15_handle_lcd_menu_keys(g15, data);
 
        /* Backlight cycle button pressed? */
        if (data[1] & 0x80)
@@ -510,7 +525,7 @@ static int lg_g15_event(struct lg_g15_data *g15, u8 *data, int size)
        return 0;
 }
 
-static int lg_g15_v2_event(struct lg_g15_data *g15, u8 *data, int size)
+static int lg_g15_v2_event(struct lg_g15_data *g15, u8 *data)
 {
        int i, val;
 
@@ -542,7 +557,7 @@ static int lg_g15_v2_event(struct lg_g15_data *g15, u8 *data, int size)
        return 0;
 }
 
-static int lg_g510_event(struct lg_g15_data *g15, u8 *data, int size)
+static int lg_g510_event(struct lg_g15_data *g15, u8 *data)
 {
        bool game_mode_enabled;
        int i, val;
@@ -586,7 +601,7 @@ static int lg_g510_event(struct lg_g15_data *g15, u8 *data, int size)
        return 0;
 }
 
-static int lg_g510_leds_event(struct lg_g15_data *g15, u8 *data, int size)
+static int lg_g510_leds_event(struct lg_g15_data *g15, u8 *data)
 {
        bool backlight_disabled;
 
@@ -613,18 +628,24 @@ static int lg_g15_raw_event(struct hid_device *hdev, struct hid_report *report,
        switch (g15->model) {
        case LG_G15:
                if (data[0] == 0x02 && size == 9)
-                       return lg_g15_event(g15, data, size);
+                       return lg_g15_event(g15, data);
                break;
        case LG_G15_V2:
                if (data[0] == 0x02 && size == 5)
-                       return lg_g15_v2_event(g15, data, size);
+                       return lg_g15_v2_event(g15, data);
+               break;
+       case LG_Z10:
+               if (data[0] == 0x02 && size == 9) {
+                       lg_g15_handle_lcd_menu_keys(g15, data);
+                       input_sync(g15->input);
+               }
                break;
        case LG_G510:
        case LG_G510_USB_AUDIO:
                if (data[0] == 0x03 && size == 5)
-                       return lg_g510_event(g15, data, size);
+                       return lg_g510_event(g15, data);
                if (data[0] == 0x04 && size == 2)
-                       return lg_g510_leds_event(g15, data, size);
+                       return lg_g510_leds_event(g15, data);
                break;
        }
 
@@ -645,25 +666,18 @@ static void lg_g15_input_close(struct input_dev *dev)
        hid_hw_close(hdev);
 }
 
-static int lg_g15_register_led(struct lg_g15_data *g15, int i)
+static int lg_g15_register_led(struct lg_g15_data *g15, int i, const char *name)
 {
-       static const char * const led_names[] = {
-               "g15::kbd_backlight",
-               "g15::lcd_backlight",
-               "g15::macro_preset1",
-               "g15::macro_preset2",
-               "g15::macro_preset3",
-               "g15::macro_record",
-       };
-
        g15->leds[i].led = i;
-       g15->leds[i].cdev.name = led_names[i];
+       g15->leds[i].cdev.name = name;
 
        switch (g15->model) {
        case LG_G15:
        case LG_G15_V2:
-               g15->leds[i].cdev.brightness_set_blocking = lg_g15_led_set;
                g15->leds[i].cdev.brightness_get = lg_g15_led_get;
+               fallthrough;
+       case LG_Z10:
+               g15->leds[i].cdev.brightness_set_blocking = lg_g15_led_set;
                if (i < LG_G15_BRIGHTNESS_MAX) {
                        g15->leds[i].cdev.flags = LED_BRIGHT_HW_CHANGED;
                        g15->leds[i].cdev.max_brightness = 2;
@@ -702,8 +716,38 @@ static int lg_g15_register_led(struct lg_g15_data *g15, int i)
        return devm_led_classdev_register(&g15->hdev->dev, &g15->leds[i].cdev);
 }
 
+/* Common input device init code shared between keyboards and Z-10 speaker handling */
+static void lg_g15_init_input_dev(struct hid_device *hdev, struct input_dev *input,
+                                 const char *name)
+{
+       int i;
+
+       input->name = name;
+       input->phys = hdev->phys;
+       input->uniq = hdev->uniq;
+       input->id.bustype = hdev->bus;
+       input->id.vendor  = hdev->vendor;
+       input->id.product = hdev->product;
+       input->id.version = hdev->version;
+       input->dev.parent = &hdev->dev;
+       input->open = lg_g15_input_open;
+       input->close = lg_g15_input_close;
+
+       /* Keys below the LCD, intended for controlling a menu on the LCD */
+       for (i = 0; i < 5; i++)
+               input_set_capability(input, EV_KEY, KEY_KBD_LCD_MENU1 + i);
+}
+
 static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
 {
+       static const char * const led_names[] = {
+               "g15::kbd_backlight",
+               "g15::lcd_backlight",
+               "g15::macro_preset1",
+               "g15::macro_preset2",
+               "g15::macro_preset3",
+               "g15::macro_record",
+       };
        u8 gkeys_settings_output_report = 0;
        u8 gkeys_settings_feature_report = 0;
        struct hid_report_enum *rep_enum;
@@ -744,6 +788,8 @@ static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
 
        g15->hdev = hdev;
        g15->model = id->driver_data;
+       g15->input = input;
+       input_set_drvdata(input, hdev);
        hid_set_drvdata(hdev, (void *)g15);
 
        switch (g15->model) {
@@ -772,6 +818,9 @@ static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
                gkeys_settings_feature_report = 0x01;
                gkeys = 18;
                break;
+       case LG_Z10:
+               connect_mask = HID_CONNECT_HIDRAW;
+               break;
        }
 
        ret = hid_hw_start(hdev, connect_mask);
@@ -814,17 +863,21 @@ static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
        if (ret)
                goto error_hw_stop;
 
+       if (g15->model == LG_Z10) {
+               lg_g15_init_input_dev(hdev, g15->input, "Logitech Z-10 LCD Menu Keys");
+               ret = input_register_device(g15->input);
+               if (ret)
+                       goto error_hw_stop;
+
+               ret = lg_g15_register_led(g15, 1, "z-10::lcd_backlight");
+               if (ret)
+                       goto error_hw_stop;
+
+               return 0; /* All done */
+       }
+
        /* Setup and register input device */
-       input->name = "Logitech Gaming Keyboard Gaming Keys";
-       input->phys = hdev->phys;
-       input->uniq = hdev->uniq;
-       input->id.bustype = hdev->bus;
-       input->id.vendor  = hdev->vendor;
-       input->id.product = hdev->product;
-       input->id.version = hdev->version;
-       input->dev.parent = &hdev->dev;
-       input->open = lg_g15_input_open;
-       input->close = lg_g15_input_close;
+       lg_g15_init_input_dev(hdev, input, "Logitech Gaming Keyboard Gaming Keys");
 
        /* G-keys */
        for (i = 0; i < gkeys; i++)
@@ -835,10 +888,6 @@ static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
                input_set_capability(input, EV_KEY, KEY_MACRO_PRESET1 + i);
        input_set_capability(input, EV_KEY, KEY_MACRO_RECORD_START);
 
-       /* Keys below the LCD, intended for controlling a menu on the LCD */
-       for (i = 0; i < 5; i++)
-               input_set_capability(input, EV_KEY, KEY_KBD_LCD_MENU1 + i);
-
        /*
         * On the G510 only report headphone and mic mute keys when *not* using
         * the builtin USB audio device. When the builtin audio is used these
@@ -850,16 +899,13 @@ static int lg_g15_probe(struct hid_device *hdev, const struct hid_device_id *id)
                input_set_capability(input, EV_KEY, KEY_F20);
        }
 
-       g15->input = input;
-       input_set_drvdata(input, hdev);
-
        ret = input_register_device(input);
        if (ret)
                goto error_hw_stop;
 
        /* Register LED devices */
        for (i = 0; i < LG_G15_LED_MAX; i++) {
-               ret = lg_g15_register_led(g15, i);
+               ret = lg_g15_register_led(g15, i, led_names[i]);
                if (ret)
                        goto error_hw_stop;
        }
@@ -890,6 +936,10 @@ static const struct hid_device_id lg_g15_devices[] = {
        { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
                         USB_DEVICE_ID_LOGITECH_G510_USB_AUDIO),
                .driver_data = LG_G510_USB_AUDIO },
+       /* Z-10 speakers */
+       { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
+                        USB_DEVICE_ID_LOGITECH_Z_10_SPK),
+               .driver_data = LG_Z10 },
        { }
 };
 MODULE_DEVICE_TABLE(hid, lg_g15_devices);
@@ -902,4 +952,5 @@ static struct hid_driver lg_g15_driver = {
 };
 module_hid_driver(lg_g15_driver);
 
+MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
 MODULE_LICENSE("GPL");
index fa835d5659825b9f8c3c40b5b3e917ffa475b6e8..18d37b3765f3be85d1b6b8e4fc0acdb96af66f5f 100644 (file)
 #define HIDPP_DEVICE_TYPE_MASK                 GENMASK(3, 0)
 #define HIDPP_LINK_STATUS_MASK                 BIT(6)
 #define HIDPP_MANUFACTURER_MASK                        BIT(7)
+#define HIDPP_27MHZ_SECURE_MASK                        BIT(7)
 
 #define HIDPP_DEVICE_TYPE_KEYBOARD             1
 #define HIDPP_DEVICE_TYPE_MOUSE                        2
@@ -984,6 +985,13 @@ static void logi_hidpp_dev_conn_notif_27mhz(struct hid_device *hdev,
                workitem->reports_supported |= STD_MOUSE | HIDPP;
                break;
        case 3: /* Index 3 is always the keyboard */
+               if (hidpp_report->params[HIDPP_PARAM_DEVICE_INFO] & HIDPP_27MHZ_SECURE_MASK) {
+                       hid_info(hdev, "Keyboard connection is encrypted\n");
+               } else {
+                       hid_warn(hdev, "Keyboard events are send over the air in plain-text / unencrypted\n");
+                       hid_warn(hdev, "See: https://gitlab.freedesktop.org/jwrdegoede/logitech-27mhz-keyboard-encryption-setup/\n");
+               }
+               fallthrough;
        case 4: /* Index 4 is used for an optional separate numpad */
                workitem->device_type = HIDPP_DEVICE_TYPE_KEYBOARD;
                workitem->reports_supported |= STD_KEYBOARD | MULTIMEDIA |
index fee4e54a3ce083535656e6558c2f7dcb1e24f9e7..61635e629469a303437cf933b799351a7bc4f3f8 100644 (file)
@@ -56,6 +56,8 @@ MODULE_PARM_DESC(disable_tap_to_click,
 #define HIDPP_SUB_ID_CONSUMER_VENDOR_KEYS      0x03
 #define HIDPP_SUB_ID_ROLLER                    0x05
 #define HIDPP_SUB_ID_MOUSE_EXTRA_BTNS          0x06
+#define HIDPP_SUB_ID_USER_IFACE_EVENT          0x08
+#define HIDPP_USER_IFACE_EVENT_ENCRYPTION_KEY_LOST     BIT(5)
 
 #define HIDPP_QUIRK_CLASS_WTP                  BIT(0)
 #define HIDPP_QUIRK_CLASS_M560                 BIT(1)
@@ -3529,6 +3531,16 @@ static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
                return 1;
        }
 
+       if (hidpp->hid_dev->group == HID_GROUP_LOGITECH_27MHZ_DEVICE &&
+           data[0] == REPORT_ID_HIDPP_SHORT &&
+           data[2] == HIDPP_SUB_ID_USER_IFACE_EVENT &&
+           (data[3] & HIDPP_USER_IFACE_EVENT_ENCRYPTION_KEY_LOST)) {
+               dev_err_ratelimited(&hidpp->hid_dev->dev,
+                       "Error the keyboard's wireless encryption key has been lost, your keyboard will not work unless you re-configure encryption.\n");
+               dev_err_ratelimited(&hidpp->hid_dev->dev,
+                       "See: https://gitlab.freedesktop.org/jwrdegoede/logitech-27mhz-keyboard-encryption-setup/\n");
+       }
+
        if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
                ret = hidpp20_battery_event_1000(hidpp, data, size);
                if (ret != 0)