HID: asus: fortify keyboard handshake

Handshaking with an Asus device involves sending it a feature report
with the string "ASUS Tech.Inc." and then reading it back to verify the
handshake was successful, under the feature ID the interaction will
take place.

Currently, the driver only does the first part. Add the readback to
verify the handshake was successful. As this could cause breakages,
allow the verification to fail with a dmesg error until we verify
all devices work with it (they seem to).

Since the response is more than 16 bytes, increase the buffer size
to 64 as well to avoid overflow errors. In addition, add the report
ID to prints, to help identify failed handshakes.

Reviewed-by: Benjamin Tissoires <bentiss@kernel.org>
Reviewed-by: Denis Benato <benato.denis96@gmail.com>
Acked-by: Benjamin Tissoires <bentiss@kernel.org>
Signed-off-by: Antheas Kapenekakis <lkml@antheas.dev>
Link: https://patch.msgid.link/20260122075044.5070-5-lkml@antheas.dev
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

diff --git a/drivers/hid/hid-asus.c b/drivers/hid/hid-asus.c
index 2ff2170dc30a25a5cf624c32cef5ab1b975943eb..cbf5bab9113b7027e61df77b9c7295db7f8229ab 100644 (file)
--- a/drivers/hid/hid-asus.c
+++ b/drivers/hid/hid-asus.c
@@ -49,7 +49,7 @@ MODULE_DESCRIPTION("Asus HID Keyboard and TouchPad");
 #define FEATURE_REPORT_ID 0x0d
 #define INPUT_REPORT_ID 0x5d
 #define FEATURE_KBD_REPORT_ID 0x5a
-#define FEATURE_KBD_REPORT_SIZE 16
+#define FEATURE_KBD_REPORT_SIZE 64
 #define FEATURE_KBD_LED_REPORT_ID1 0x5d
 #define FEATURE_KBD_LED_REPORT_ID2 0x5e
 
@@ -395,15 +395,41 @@ static int asus_kbd_set_report(struct hid_device *hdev, const u8 *buf, size_t bu
 
 static int asus_kbd_init(struct hid_device *hdev, u8 report_id)
 {
+       /*
+        * The handshake is first sent as a set_report, then retrieved
+        * from a get_report. They should be equal.
+        */
        const u8 buf[] = { report_id, 0x41, 0x53, 0x55, 0x53, 0x20, 0x54,
                     0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
        int ret;
 
        ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
-       if (ret < 0)
-               hid_err(hdev, "Asus failed to send init command: %d\n", ret);
+       if (ret < 0) {
+               hid_err(hdev, "Asus handshake %02x failed to send: %d\n",
+                       report_id, ret);
+               return ret;
+       }
 
-       return ret;
+       u8 *readbuf __free(kfree) = kzalloc(FEATURE_KBD_REPORT_SIZE, GFP_KERNEL);
+       if (!readbuf)
+               return -ENOMEM;
+
+       ret = hid_hw_raw_request(hdev, report_id, readbuf,
+                                FEATURE_KBD_REPORT_SIZE, HID_FEATURE_REPORT,
+                                HID_REQ_GET_REPORT);
+       if (ret < 0) {
+               hid_warn(hdev, "Asus handshake %02x failed to receive ack: %d\n",
+                        report_id, ret);
+       } else if (memcmp(readbuf, buf, sizeof(buf)) != 0) {
+               hid_warn(hdev, "Asus handshake %02x returned invalid response: %*ph\n",
+                        report_id, FEATURE_KBD_REPORT_SIZE, readbuf);
+       }
+
+       /*
+        * Do not return error if handshake is wrong until this is
+        * verified to work for all devices.
+        */
+       return 0;
 }
 
 static int asus_kbd_get_functions(struct hid_device *hdev,