From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 727DCC433E7 for ; Thu, 8 Oct 2020 09:33:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EA56821775 for ; Thu, 8 Oct 2020 09:33:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728945AbgJHJdd (ORCPT ); Thu, 8 Oct 2020 05:33:33 -0400 Received: from out5-smtp.messagingengine.com ([66.111.4.29]:36503 "EHLO out5-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725882AbgJHJdd (ORCPT ); Thu, 8 Oct 2020 05:33:33 -0400 Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.nyi.internal (Postfix) with ESMTP id F2D8D5C01C0; Thu, 8 Oct 2020 05:33:30 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute4.internal (MEProxy); Thu, 08 Oct 2020 05:33:30 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=VtnVLt yWkCexZgp2NvtPd24rtxB7/XD6z0WhcYLMj1c=; b=k6ALGWFxEZSlkUCEAUu1kX r8R+LtMdfyLkpaYVvaTB9Kl3RpsDusJDUJ3mKCcfa/T3mpavez9CWH903bUS8IYp kvys38RxU0TDwTQ7FBA+4lR85kL+pcBxZ4CAErQHpr5vHzN0PhAjmw/eDmgsWIgq sRKIuLzm/tcn9CfNYJGxlood5OATZIYtmzkDVwrLBY1vxggDf4Bcnh8DPCy/JLh1 d5WFgJk8+xrRo+bTMAO+nIPwKvYHi+qMxu2GR5ZtkPFcAyf038fVcM54FQ9Mtrvp rnrXvt7llJM0elGocOeRsyZO3NXDrvO9CKs2zUvfAalU//r+zmBKGQDhxNgjAJMQ == X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrgeekgddukecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhepfffhuffvkfgjfhfogggtsehttdertd ertddvnecuhfhrohhmpefnuhhkvgculfhonhgvshcuoehluhhkvgeslhhjohhnvghsrdgu vghvqeenucggtffrrghtthgvrhhnpefgfeefudffhffgueehgeffffeggeevieefueethf eijefftedugfeuveethedtteenucfkphepvddtfedruddugedrudeguddrudeinecuvehl uhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomheplhhukhgvsehljh honhgvshdruggvvh X-ME-Proxy: Received: from [192.168.20.20] (203-114-141-16.sta.inspire.net.nz [203.114.141.16]) by mail.messagingengine.com (Postfix) with ESMTPA id 3A1BC3280064; Thu, 8 Oct 2020 05:33:26 -0400 (EDT) Date: Thu, 08 Oct 2020 22:33:13 +1300 From: Luke Jones Subject: Re: [PATCH V6 RESEND] HID: ASUS: Add support for ASUS N-Key keyboard To: jikos@kernel.org Cc: benjamin.tissoires@redhat.com, linux-kernel@vger.kernel.org, linux-input@vger.kernel.org, jikos@kernel.org Message-Id: In-Reply-To: <20200923215633.209724-1-luke@ljones.dev> References: <20200923215633.209724-1-luke@ljones.dev> X-Mailer: geary/3.38.1 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii; format=flowed Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org Jikos, is it possible we could try to get this moving? I have something like 300+ users in a Discord channel using laptops this this particular device, and more keep arriving. It's a good problem to have but the support isn't something I have much time for now. Users rely on a daemon I wrote to manage ASUS AniME and RGB keyboards, which in turn relies on this patch, which, in turn, relies on users being able to either compile a kernel, install a custom one, or use dkms. The main change from previous version beyond cleanup is to use existing key event codes for the Aura-mode buttons so that there is no hold-up to okay the removed *new* codes. In future I will go through the process of adding custom codes. Many thanks. Luke. On Thu, Sep 24, 2020 at 09:56, Luke D Jones wrote: > The ASUS N-Key keyboard uses the productId of 0x1866 and is used in > almost all modern ASUS gaming laptops with slight changes to the > firmware. This patch enables: Fn+key hotkeys, keyboard backlight > brightness control, and notify asus-wmi to toggle "fan-mode". > > The keyboard has many of the same key outputs as the existing G752 > keyboard including a few extras, and varies a little between laptop > models. The key-sets have been split and sub-grouped so that there > will not be conflict between key event codes used. > > An existing key event used across some keyboards for "Mic Toggle" > has been changed to emit "F20" as this is what all the main > desktop environments are using. > > Additionally this keyboard requires the LED interface to be > intitialised before such things as keyboard backlight control work. > > Misc changes in scope: update some hardcoded comparisons to use an > available define. > > Signed-off-by: Luke D Jones > --- > drivers/hid/hid-asus.c | 188 > ++++++++++++++++++--- > drivers/hid/hid-ids.h | 1 + > include/linux/platform_data/x86/asus-wmi.h | 2 + > 3 files changed, 166 insertions(+), 25 deletions(-) > > diff --git a/drivers/hid/hid-asus.c b/drivers/hid/hid-asus.c > index c183caf89d49..541c92a7f108 100644 > --- a/drivers/hid/hid-asus.c > +++ b/drivers/hid/hid-asus.c > @@ -26,6 +26,8 @@ > #include > #include > #include > + > +#include > #include > #include > #include /* For to_usb_interface for T100 touchpad > intf check */ > @@ -48,6 +50,8 @@ MODULE_DESCRIPTION("Asus HID Keyboard and > TouchPad"); > #define INPUT_REPORT_ID 0x5d > #define FEATURE_KBD_REPORT_ID 0x5a > #define FEATURE_KBD_REPORT_SIZE 16 > +#define FEATURE_KBD_LED_REPORT_ID1 0x5d > +#define FEATURE_KBD_LED_REPORT_ID2 0x5e > > #define SUPPORT_KBD_BACKLIGHT BIT(0) > > @@ -80,6 +84,7 @@ MODULE_DESCRIPTION("Asus HID Keyboard and > TouchPad"); > #define QUIRK_T101HA_DOCK BIT(9) > #define QUIRK_T90CHI BIT(10) > #define QUIRK_MEDION_E1239T BIT(11) > +#define QUIRK_ROG_NKEY_KEYBOARD BIT(12) > > #define I2C_KEYBOARD_QUIRKS (QUIRK_FIX_NOTEBOOK_REPORT | \ > QUIRK_NO_INIT_REPORTS | \ > @@ -305,10 +310,33 @@ static int asus_e1239t_event(struct > asus_drvdata *drvdat, u8 *data, int size) > return 0; > } > > +/* > + * This enables triggering events in asus-wmi > + */ > +static int asus_wmi_send_event(struct asus_drvdata *drvdat, u8 code) > +{ > + int err; > + u32 retval; > + > + err = asus_wmi_evaluate_method(ASUS_WMI_METHODID_DEVS, > + ASUS_WMI_METHODID_NOTIF, code, &retval); > + if (err) { > + pr_warn("Failed to notify asus-wmi: %d\n", err); > + return err; > + } > + > + if (retval != 0) { > + pr_warn("Failed to notify asus-wmi (retval): 0x%x\n", retval); > + return -EIO; > + } > + > + return 0; > +} > + > static int asus_event(struct hid_device *hdev, struct hid_field > *field, > struct hid_usage *usage, __s32 value) > { > - if ((usage->hid & HID_USAGE_PAGE) == 0xff310000 && > + if ((usage->hid & HID_USAGE_PAGE) == HID_UP_ASUSVENDOR && > (usage->hid & HID_USAGE) != 0x00 && > (usage->hid & HID_USAGE) != 0xff && !usage->type) { > hid_warn(hdev, "Unmapped Asus vendor usagepage code 0x%02x\n", > @@ -321,6 +349,7 @@ static int asus_event(struct hid_device *hdev, > struct hid_field *field, > static int asus_raw_event(struct hid_device *hdev, > struct hid_report *report, u8 *data, int size) > { > + int ret; > struct asus_drvdata *drvdata = hid_get_drvdata(hdev); > > if (drvdata->battery && data[0] == BATTERY_REPORT_ID) > @@ -332,6 +361,35 @@ static int asus_raw_event(struct hid_device > *hdev, > if (drvdata->quirks & QUIRK_MEDION_E1239T) > return asus_e1239t_event(drvdata, data, size); > > + if (drvdata->quirks & QUIRK_ROG_NKEY_KEYBOARD) { > + /* > + * Skip these report ID, the device emits a continuous stream > associated > + * with the AURA mode it is in which looks like an 'echo' > + */ > + if (report->id == FEATURE_KBD_LED_REPORT_ID1 || > + report->id == FEATURE_KBD_LED_REPORT_ID2) { > + return -1; > + /* Additional report filtering */ > + } else if (report->id == FEATURE_KBD_REPORT_ID) { > + /* Fn+F5 "fan" symbol, trigger WMI event to toggle next mode */ > + if (data[1] == 0xae) { > + ret = asus_wmi_send_event(drvdata, 0xae); > + if (ret < 0) { > + hid_warn(hdev, "Asus failed to trigger fan control event"); > + } > + return -1; > + /* > + * G14 and G15 send these codes on some keypresses with no > + * discernable reason for doing so. We'll filter them out to avoid > + * unmapped warning messages later > + */ > + } else if (data[1] == 0xea || data[1] == 0xec || data[1] == 0x02 > || > + data[1] == 0x8a || data[1] == 0x9e) { > + return -1; > + } > + } > + } > + > return 0; > } > > @@ -344,7 +402,11 @@ static int asus_kbd_set_report(struct hid_device > *hdev, u8 *buf, size_t buf_size > if (!dmabuf) > return -ENOMEM; > > - ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, dmabuf, > + /* > + * The report ID should be set from the incoming buffer due to LED > and key > + * interfaces having different pages > + */ > + ret = hid_hw_raw_request(hdev, buf[0], dmabuf, > buf_size, HID_FEATURE_REPORT, > HID_REQ_SET_REPORT); > kfree(dmabuf); > @@ -397,6 +459,44 @@ static int asus_kbd_get_functions(struct > hid_device *hdev, > return ret; > } > > +static int asus_kbd_led_init(struct hid_device *hdev) > +{ > + u8 buf_init_start[] = { FEATURE_KBD_LED_REPORT_ID1, 0xB9 }; > + u8 buf_init2[] = { FEATURE_KBD_LED_REPORT_ID1, 0x41, 0x53, 0x55, > 0x53, 0x20, > + 0x54, 0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 }; > + u8 buf_init3[] = { FEATURE_KBD_LED_REPORT_ID1, > + 0x05, 0x20, 0x31, 0x00, 0x08 }; > + int ret; > + > + hid_warn(hdev, "Asus initialise N-KEY Device"); > + /* The first message is an init start */ > + ret = asus_kbd_set_report(hdev, buf_init_start, > sizeof(buf_init_start)); > + if (ret < 0) > + hid_err(hdev, "Asus failed to send init start command: %d\n", ret); > + /* Followed by a string */ > + ret = asus_kbd_set_report(hdev, buf_init2, sizeof(buf_init2)); > + if (ret < 0) > + hid_err(hdev, "Asus failed to send init command 1.0: %d\n", ret); > + /* Followed by a string */ > + ret = asus_kbd_set_report(hdev, buf_init3, sizeof(buf_init3)); > + if (ret < 0) > + hid_err(hdev, "Asus failed to send init command 1.1: %d\n", ret); > + > + /* begin second report ID with same data */ > + buf_init2[0] = FEATURE_KBD_LED_REPORT_ID2; > + buf_init3[0] = FEATURE_KBD_LED_REPORT_ID2; > + > + ret = asus_kbd_set_report(hdev, buf_init2, sizeof(buf_init2)); > + if (ret < 0) > + hid_err(hdev, "Asus failed to send init command 2.0: %d\n", ret); > + > + ret = asus_kbd_set_report(hdev, buf_init3, sizeof(buf_init3)); > + if (ret < 0) > + hid_err(hdev, "Asus failed to send init command 2.1: %d\n", ret); > + > + return ret; > +} > + > static void asus_kbd_backlight_set(struct led_classdev *led_cdev, > enum led_brightness brightness) > { > @@ -460,19 +560,28 @@ static int asus_kbd_register_leds(struct > hid_device *hdev) > unsigned char kbd_func; > int ret; > > - /* Initialize keyboard */ > - ret = asus_kbd_init(hdev); > - if (ret < 0) > - return ret; > + if (drvdata->quirks & QUIRK_G752_KEYBOARD) { > + /* Initialize keyboard */ > + ret = asus_kbd_init(hdev); > + if (ret < 0) > + return ret; > > - /* Get keyboard functions */ > - ret = asus_kbd_get_functions(hdev, &kbd_func); > - if (ret < 0) > - return ret; > + /* Get keyboard functions */ > + ret = asus_kbd_get_functions(hdev, &kbd_func); > + if (ret < 0) > + return ret; > > - /* Check for backlight support */ > - if (!(kbd_func & SUPPORT_KBD_BACKLIGHT)) > - return -ENODEV; > + /* Check for backlight support */ > + if (!(kbd_func & SUPPORT_KBD_BACKLIGHT)) > + return -ENODEV; > + } > + > + if (drvdata->quirks & QUIRK_ROG_NKEY_KEYBOARD) { > + /* Initialize keyboard LED interface and Vendor keys on 0x1866 */ > + ret = asus_kbd_led_init(hdev); > + if (ret < 0) > + return ret; > + } > > drvdata->kbd_backlight = devm_kzalloc(&hdev->dev, > sizeof(struct asus_kbd_leds), > @@ -751,14 +860,14 @@ static int asus_input_mapping(struct hid_device > *hdev, > usage->hid == (HID_UP_GENDEVCTRLS | 0x0026))) > return -1; > > - /* ASUS-specific keyboard hotkeys */ > - if ((usage->hid & HID_USAGE_PAGE) == 0xff310000) { > + /* ASUS-specific keyboard hotkeys and led backlight */ > + if ((usage->hid & HID_USAGE_PAGE) == HID_UP_ASUSVENDOR) { > switch (usage->hid & HID_USAGE) { > case 0x10: asus_map_key_clear(KEY_BRIGHTNESSDOWN); break; > case 0x20: asus_map_key_clear(KEY_BRIGHTNESSUP); break; > case 0x35: asus_map_key_clear(KEY_DISPLAY_OFF); break; > case 0x6c: asus_map_key_clear(KEY_SLEEP); break; > - case 0x7c: asus_map_key_clear(KEY_MICMUTE); break; > + case 0x7c: asus_map_key_clear(KEY_F20); break; > case 0x82: asus_map_key_clear(KEY_CAMERA); break; > case 0x88: asus_map_key_clear(KEY_RFKILL); break; > case 0xb5: asus_map_key_clear(KEY_CALC); break; > @@ -771,16 +880,42 @@ static int asus_input_mapping(struct hid_device > *hdev, > /* ROG key */ > case 0x38: asus_map_key_clear(KEY_PROG1); break; > > - /* Fn+C ASUS Splendid */ > - case 0xba: asus_map_key_clear(KEY_PROG2); break; > - > - /* Fn+Space Power4Gear Hybrid */ > - case 0x5c: asus_map_key_clear(KEY_PROG3); break; > - > - /* Fn+F5 "fan" symbol on FX503VD */ > - case 0x99: asus_map_key_clear(KEY_PROG4); break; > - > + /* The keyboard ID's in this section don't share key events */ > default: > + if (drvdata->quirks & QUIRK_G752_KEYBOARD) { > + switch (usage->hid & HID_USAGE) { > + /* Fn+C ASUS Splendid */ > + case 0xba: asus_map_key_clear(KEY_PROG2); break; > + > + /* Fn+Space Power4Gear Hybrid */ > + case 0x5c: asus_map_key_clear(KEY_PROG3); break; > + > + /* Fn+F5 "fan" symbol on FX503VD */ > + case 0x99: asus_map_key_clear(KEY_PROG4); break; > + > + default: > + return -1; > + } > + break; > + } > + /* device 0x1866, N-KEY Device specific */ > + else if (drvdata->quirks & QUIRK_ROG_NKEY_KEYBOARD) { > + switch (usage->hid & HID_USAGE) { > + /* Fn+Ret "Calc" symbol on device 0x1866, N-KEY Device */ > + case 0x92: asus_map_key_clear(KEY_CALC); break; > + > + /* Fn+Left Aura mode previous */ > + case 0xb2: asus_map_key_clear(KEY_PROG2); break; > + > + /* Fn+Right Aura mode next */ > + case 0xb3: asus_map_key_clear(KEY_PROG3); break; > + > + default: > + return -1; > + } > + break; > + } > + > /* ASUS lazily declares 256 usages, ignore the rest, > * as some make the keyboard appear as a pointer device. */ > return -1; > @@ -1126,6 +1261,9 @@ static const struct hid_device_id > asus_devices[] = { > { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK, > USB_DEVICE_ID_ASUSTEK_FX503VD_KEYBOARD), > QUIRK_USE_KBD_BACKLIGHT }, > + { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK, > + USB_DEVICE_ID_ASUSTEK_ROG_NKEY_KEYBOARD), > + QUIRK_USE_KBD_BACKLIGHT | QUIRK_ROG_NKEY_KEYBOARD }, > { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK, > USB_DEVICE_ID_ASUSTEK_T100TA_KEYBOARD), > QUIRK_T100_KEYBOARD | QUIRK_NO_CONSUMER_USAGES }, > diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h > index 74fc1df6e3c2..ce5ca078b232 100644 > --- a/drivers/hid/hid-ids.h > +++ b/drivers/hid/hid-ids.h > @@ -190,6 +190,7 @@ > #define USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD1 0x1854 > #define USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD2 0x1837 > #define USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD3 0x1822 > +#define USB_DEVICE_ID_ASUSTEK_ROG_NKEY_KEYBOARD 0x1866 > #define USB_DEVICE_ID_ASUSTEK_FX503VD_KEYBOARD 0x1869 > > #define USB_VENDOR_ID_ATEN 0x0557 > diff --git a/include/linux/platform_data/x86/asus-wmi.h > b/include/linux/platform_data/x86/asus-wmi.h > index 897b8332a39f..05253cfe786c 100644 > --- a/include/linux/platform_data/x86/asus-wmi.h > +++ b/include/linux/platform_data/x86/asus-wmi.h > @@ -27,6 +27,8 @@ > #define ASUS_WMI_METHODID_INIT 0x54494E49 /* INITialize */ > #define ASUS_WMI_METHODID_HKEY 0x59454B48 /* Hot KEY ?? */ > > +#define ASUS_WMI_METHODID_NOTIF 0x00100021 /* Notify method ?? */ > + > #define ASUS_WMI_UNSUPPORTED_METHOD 0xFFFFFFFE > > /* Wireless */ > -- > 2.26.2 >