platform/x86: add Xiaomi WMI key driver
cover platform/x86: add Xiaomi WMI key driver
This adds a driver for extra function keys on certain Xiaomi laptops.
Unlike the existing xiaomi-wmi driver where each key has its own WMI GUID, this machine delivers all keys through a single event GUID (B74AF83F-...), encoding the event type and keycode in the event buffer.
I was unsure whether this should be merged into the existing xiaomi-wmi.c or kept separate due to the different mechanism. I chose a separate file for clarity; happy to merge if preferred.
Tested on Xiaomi Mi Gaming Laptop (8th gen Intel).
Lucy Wong (1):
platform/x86: add Xiaomi WMI key driver
MAINTAINERS | 6 ++ drivers/platform/x86/Kconfig | 11 ++ drivers/platform/x86/Makefile | 1 + drivers/platform/x86/xiaomi-wmi-keys.c | 139 +++++++++++++++++++++++++ 4 files changed, 157 insertions(+) create mode 100644 drivers/platform/x86/xiaomi-wmi-keys.c
Signature · 1 line
2.54.0
PATCH 1/1 platform/x86: add Xiaomi WMI key driver
Certain Xiaomi laptops expose extra function keys through a single WMI event GUID (B74AF83F-8B2F-4069-ACAC-36D176F62FC0). Unlike the existing xiaomi-wmi driver where each key has its own GUID, here all keys share one GUID and the event buffer encodes both an event type and a keycode:
buffer[1] = event type
0x02: press/release keys (5 keys with abstract icons)
0x03: firmware-handled toggles (touchpad, Fn lock)buffer[2] = keycode within that type
The keys with abstract icons are mapped to programmable macro keys for userspace to bind. The touchpad and Fn lock keys are handled by the EC and are reported for notification purposes only.
--- MAINTAINERS | 6 ++ drivers/platform/x86/Kconfig | 11 ++ drivers/platform/x86/Makefile | 1 + drivers/platform/x86/xiaomi-wmi-keys.c | 139 +++++++++++++++++++++++++ 4 files changed, 157 insertions(+) create mode 100644 drivers/platform/x86/xiaomi-wmi-keys.c
MAINTAINERS +6 -0
@@ -29124,6 +29124,12 @@ F: fs/xfs/ F: include/uapi/linux/dqblk_xfs.h F: include/uapi/linux/fsmap.h +XIAOMI WMI KEYS DRIVER +M: Lucy Wong <[email protected]> +L: [email protected] +S: Maintained +F: drivers/platform/x86/xiaomi-wmi-keys.c + XILINX AMS DRIVER M: Salih Erim <[email protected]> M: Conall O'Griofa <[email protected]>
drivers/platform/x86/Kconfig +11 -0
@@ -90,6 +90,17 @@ config XIAOMI_WMI To compile this driver as a module, choose M here: the module will be called xiaomi-wmi. +config XIAOMI_WMI_KEYS + tristate "Xiaomi WMI key events driver" + depends on ACPI_WMI + depends on INPUT + help + Say Y here if you want to support WMI-based hotkey events on certain + Xiaomi laptops. + + To compile this driver as a module, choose M here: the module will + be called xiaomi-wmi-keys. + config REDMI_WMI tristate "Redmibook WMI key driver" depends on ACPI_WMI
drivers/platform/x86/Makefile +1 -0
@@ -12,6 +12,7 @@ obj-$(CONFIG_HUAWEI_WMI) += huawei-wmi.o obj-$(CONFIG_MXM_WMI) += mxm-wmi.o obj-$(CONFIG_NVIDIA_WMI_EC_BACKLIGHT) += nvidia-wmi-ec-backlight.o obj-$(CONFIG_XIAOMI_WMI) += xiaomi-wmi.o +obj-$(CONFIG_XIAOMI_WMI_KEYS) += xiaomi-wmi-keys.o obj-$(CONFIG_REDMI_WMI) += redmi-wmi.o obj-$(CONFIG_GIGABYTE_WMI) += gigabyte-wmi.o obj-$(CONFIG_BITLAND_MIFS_WMI) += bitland-mifs-wmi.o
drivers/platform/x86/xiaomi-wmi-keys.c new file +139 -0
139 lines not on this page · raw message
Signature · 1 line
2.54.0
PATCH v2 1/1 platform/x86: add Xiaomi WMI key driver
In reply to Lucy WongCertain Xiaomi laptops expose extra function keys through a single WMI event GUID (B74AF83F-8B2F-4069-ACAC-36D176F62FC0). Unlike the existing xiaomi-wmi driver where each key has its own GUID, here all keys share one GUID and the event buffer encodes both an event type and a keycode:
buffer[1] = event type
0x02: press/release keys (5 keys with abstract icons)
0x03: firmware-handled toggles (touchpad, Fn lock)buffer[2] = keycode within that type
The keys with abstract icons are mapped to programmable macro keys for userspace to bind. The touchpad and Fn lock toggles, as well as the keyboard backlight level events, are handled by the firmware and are ignored.
---
Changes in v2:
- Convert to .notify_new and set .min_event_size
- Ignore firmware-handled backlight and toggle events, which removes the toggle deduplication state
- Add the missing select INPUT_SPARSEKMAP
- Name the event codes and align the defines
- Add the dev_printk.h include
--- MAINTAINERS | 6 ++ drivers/platform/x86/Kconfig | 12 +++ drivers/platform/x86/Makefile | 1 + drivers/platform/x86/xiaomi-wmi-keys.c | 123 +++++++++++++++++++++++++ 4 files changed, 142 insertions(+) create mode 100644 drivers/platform/x86/xiaomi-wmi-keys.c
MAINTAINERS +6 -0
@@ -29124,6 +29124,12 @@ F: fs/xfs/ F: include/uapi/linux/dqblk_xfs.h F: include/uapi/linux/fsmap.h +XIAOMI WMI KEYS DRIVER +M: Lucy Wong <[email protected]> +L: [email protected] +S: Maintained +F: drivers/platform/x86/xiaomi-wmi-keys.c + XILINX AMS DRIVER M: Salih Erim <[email protected]> M: Conall O'Griofa <[email protected]>
drivers/platform/x86/Kconfig +12 -0
@@ -90,6 +90,18 @@ config XIAOMI_WMI To compile this driver as a module, choose M here: the module will be called xiaomi-wmi. +config XIAOMI_WMI_KEYS + tristate "Xiaomi WMI key events driver" + depends on ACPI_WMI + depends on INPUT + select INPUT_SPARSEKMAP + help + Say Y here if you want to support WMI-based hotkey events on certain + Xiaomi laptops. + + To compile this driver as a module, choose M here: the module will + be called xiaomi-wmi-keys. + config REDMI_WMI tristate "Redmibook WMI key driver" depends on ACPI_WMI
drivers/platform/x86/Makefile +1 -0
@@ -12,6 +12,7 @@ obj-$(CONFIG_HUAWEI_WMI) += huawei-wmi.o obj-$(CONFIG_MXM_WMI) += mxm-wmi.o obj-$(CONFIG_NVIDIA_WMI_EC_BACKLIGHT) += nvidia-wmi-ec-backlight.o obj-$(CONFIG_XIAOMI_WMI) += xiaomi-wmi.o +obj-$(CONFIG_XIAOMI_WMI_KEYS) += xiaomi-wmi-keys.o obj-$(CONFIG_REDMI_WMI) += redmi-wmi.o obj-$(CONFIG_GIGABYTE_WMI) += gigabyte-wmi.o obj-$(CONFIG_BITLAND_MIFS_WMI) += bitland-mifs-wmi.o
drivers/platform/x86/xiaomi-wmi-keys.c new file +123 -0
123 lines not on this page · raw message
Signature · 1 line
2.56.0
Am 22.10.26 um 20:56 schrieb Lucy Wong:
Quoted 98 lines
Certain Xiaomi laptops expose extra function keys through a single WMI event GUID (B74AF83F-8B2F-4069-ACAC-36D176F62FC0). Unlike the existing xiaomi-wmi driver where each key has its own GUID, here all keys share one GUID and the event buffer encodes both an event type and a keycode:
buffer[1] = event type
0x02: press/release keys (5 keys with abstract icons) 0x03: firmware-handled toggles (touchpad, Fn lock)buffer[2] = keycode within that type
The keys with abstract icons are mapped to programmable macro keys for userspace to bind. The touchpad and Fn lock toggles, as well as the keyboard backlight level events, are handled by the firmware and are ignored.
Signed-off-by Lucy Wong <[email protected]>---
Changes in v2:
- Convert to .notify_new and set .min_event_size
- Ignore firmware-handled backlight and toggle events, which removes the toggle deduplication state
- Add the missing selectINPUT_SPARSEKMAP
- Name the event codes and align the defines
- Add thedev_printk.hinclude--- MAINTAINERS | 6 ++ drivers/platform/x86/Kconfig | 12 +++ drivers/platform/x86/Makefile | 1 + drivers/platform/x86/xiaomi-wmi-keys.c | 123 +++++++++++++++++++++++++ 4 files changed, 142 insertions(+)create mode 100644
drivers/platform/x86/xiaomi-wmi-keys.cMAINTAINERS +6
-0@@ -29124,6 +29124,12 @@ F: fs/xfs/ F: include/uapi/linux/dqblk_xfs.h F: include/uapi/linux/fsmap.h +XIAOMI WMI KEYS DRIVER +M: Lucy Wong <[email protected]> +L: [email protected] +S: Maintained +F: drivers/platform/x86/xiaomi-wmi-keys.c + XILINX AMS DRIVER M: Salih Erim <[email protected]> M: Conall O'Griofa <[email protected]>drivers/platform/x86/Kconfig +12
-0@@ -90,6 +90,18 @@ config XIAOMI_WMI To compile this driver as a module, choose M here: the module will be called xiaomi-wmi. +config XIAOMI_WMI_KEYS + tristate "Xiaomi WMI key events driver" + depends on ACPI_WMI + depends on INPUT + select INPUT_SPARSEKMAP + help + Say Y here if you want to support WMI-based hotkey events on certain + Xiaomi laptops. + + To compile this driver as a module, choose M here: the module will + be called xiaomi-wmi-keys. + config REDMI_WMI tristate "Redmibook WMI key driver" depends on ACPI_WMIdrivers/platform/x86/Makefile +1
-0@@ -12,6 +12,7 @@ obj-$(CONFIG_HUAWEI_WMI) += huawei-wmi.o obj-$(CONFIG_MXM_WMI) += mxm-wmi.o obj-$(CONFIG_NVIDIA_WMI_EC_BACKLIGHT) += nvidia-wmi-ec-backlight.o obj-$(CONFIG_XIAOMI_WMI) += xiaomi-wmi.o +obj-$(CONFIG_XIAOMI_WMI_KEYS) += xiaomi-wmi-keys.o obj-$(CONFIG_REDMI_WMI) += redmi-wmi.o obj-$(CONFIG_GIGABYTE_WMI) += gigabyte-wmi.o obj-$(CONFIG_BITLAND_MIFS_WMI) += bitland-mifs-wmi.odrivers/platform/x86/xiaomi-wmi-keys.c new file +7
-0@@ -0,0 +1,123 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Xiaomi laptop WMI hotkey driver +* +* Copyright (C) 2026 Lucy Wong <[email protected]> +*/ +
drivers/platform/x86/xiaomi-wmi-keys.c line 17
Quoted 10 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +10
-0+#include <linux/device.h> +#include <linux/dev_printk.h> +#include <linux/input.h> +#include <linux/input/sparse-keymap.h> +#include <linux/module.h> +#include <linux/wmi.h> + +#define XIAOMI_WMI_EVENT_GUID "B74AF83F-8B2F-4069-ACAC-36D176F62FC0" + +#define XIAOMI_EVENT_TYPE_KEY 0x02
Please also document event type 0x03 and 0x01. Does your device contain embedded BMOF data? I would be interested in taking a look at it.
Quoted 25 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +25
-0+ +#define XIAOMI_KEY_PRESS_FIRST 0x01 +#define XIAOMI_KEY_COUNT 5 +#define XIAOMI_KEY_RELEASE_FIRST \ + (XIAOMI_KEY_PRESS_FIRST + XIAOMI_KEY_COUNT) + +struct xiaomi_wmi_keys_event { +u8 reserved; +u8 type; +u8 code; +}; + +struct xiaomi_wmi_keys { +struct input_dev *input_dev; +}; + +static const struct key_entry xiaomi_wmi_keys_keymap[] = { +/* programmable keys with abstract icons */ + {KE_KEY ,0x01 , {KEY_MACRO1 } }, + {KE_KEY ,0x02 , {KEY_MACRO2 } }, + {KE_KEY ,0x03 , {KEY_MACRO3 } }, + {KE_KEY ,0x04 , {KEY_MACRO4 } }, + {KE_KEY ,0x05 , {KEY_MACRO5 } }, + {KE_END ,0 }, +};
drivers/platform/x86/xiaomi-wmi-keys.c line 52
Quoted 10 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +10
-0+ +static int xiaomi_wmi_keys_probe (struct wmi_device *wdev,const void *context) +{ +struct xiaomi_wmi_keys *data; +int ret; + + data =devm_kzalloc (&wdev->dev,sizeof (*data),GFP_KERNEL ); +if (!data) +return -ENOMEM ; +dev_set_drvdata (&wdev->dev, data);
You need a mutex to sync each invocation of sparse_keymap_report_event().
Quoted 11 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +11
-0+ + data->input_dev =devm_input_allocate_device (&wdev->dev); +if (!data->input_dev) +return -ENOMEM ; + + data->input_dev->name ="Xiaomi WMI keys" ; + data->input_dev->phys ="wmi/input0" ; + data->input_dev->id.bustype =BUS_HOST ; + + ret =sparse_keymap_setup (data->input_dev, xiaomi_wmi_keys_keymap,NULL ); +if (ret)
drivers/platform/x86/xiaomi-wmi-keys.c line 73
Quoted 10 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +10
-0+return ret; + +return input_register_device (data->input_dev); +} + +static void xiaomi_wmi_keys_notify (struct wmi_device *wdev, +const struct wmi_buffer *buffer) +{ +const struct xiaomi_wmi_keys_event *event = buffer->data; +struct xiaomi_wmi_keys *data =dev_get_drvdata (&wdev->dev);
Reverse XMAS tree ordering please, move the above assignment to the top.
Quoted 13 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +13
-0+unsigned int code; +bool pressed; + +/* +* Only the press/release keys are reported. Event types 0x01 +* (backlight) and 0x03 (touchpad and Fn-lock toggles) are handled by +* the firmware and need no action from the driver. +*/ +if (event->type !=XIAOMI_EVENT_TYPE_KEY ) { +dev_dbg (&wdev->dev,"ignoring event type 0x%02x\n" , event->type); +return ; + } +
drivers/platform/x86/xiaomi-wmi-keys.c line 96
Quoted 10 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +10
-0+if (event->code >=XIAOMI_KEY_PRESS_FIRST && + event->code <XIAOMI_KEY_PRESS_FIRST +XIAOMI_KEY_COUNT ) { + code = event->code; + pressed = true; + }else if (event->code >=XIAOMI_KEY_RELEASE_FIRST && + event->code <XIAOMI_KEY_RELEASE_FIRST +XIAOMI_KEY_COUNT ) { + code = event->code -XIAOMI_KEY_COUNT ; + pressed = false; + }else { +dev_dbg (&wdev->dev,"ignoring key code 0x%02x\n" , event->code);
Maybe use dev_notice() here to notify users that a unknown key index was received.
Quoted 5 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +5
-0+return ; + } + +sparse_keymap_report_event (data->input_dev, code, pressed, false); +}
drivers/platform/x86/xiaomi-wmi-keys.c line 111
Quoted 10 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +10
-0+ +static const struct wmi_device_id xiaomi_wmi_keys_id_table[] = { + { .guid_string =XIAOMI_WMI_EVENT_GUID }, + { } +}; +MODULE_DEVICE_TABLE (wmi, xiaomi_wmi_keys_id_table); + +static struct wmi_driver xiaomi_wmi_keys_driver = { + .driver = { + .name ="xiaomi-wmi-keys" ,
Please add .probe_type = PROBE_PREFER_ASYNCHRONOUS here.
Other than that the driver looks promising.
Thanks,
Armin Wolf
Quoted 12 lines
drivers/platform/x86/xiaomi-wmi-keys.c new file +12
-0+ }, + .id_table = xiaomi_wmi_keys_id_table, + .min_event_size = sizeof(struct xiaomi_wmi_keys_event), + .probe = xiaomi_wmi_keys_probe, + .notify_new = xiaomi_wmi_keys_notify, + .no_singleton = true, +}; +module_wmi_driver (xiaomi_wmi_keys_driver); + +MODULE_AUTHOR ("Lucy Wong <[email protected]>" ); +MODULE_DESCRIPTION ("Xiaomi laptop WMI hotkey driver" ); +MODULE_LICENSE ("GPL" );
PATCH v3 1/1 platform/x86: add Xiaomi WMI key driver
Certain Xiaomi laptops expose extra function keys through a single WMI event GUID (B74AF83F-8B2F-4069-ACAC-36D176F62FC0). Unlike the existing xiaomi-wmi driver where each key has its own GUID, here all keys share one GUID and the event buffer encodes both an event type and a keycode:
buffer[1] = event type
0x01: keyboard backlight level (EC handled)
0x02: press/release keys (5 keys with abstract icons)
0x03: firmware-handled toggles (touchpad, Fn lock)buffer[2] = keycode within that type
The keys with abstract icons are mapped to programmable macro keys for userspace to bind. The backlight and toggle events are handled by the firmware and are ignored.
---
Changes in v3:
- Add a mutex to serialize sparse_keymap_report_event() calls
- Document event types 0x01 and 0x03 with named defines
- Use dev_notice() for unknown key indices
- Fix reverse XMAS tree ordering of the notify() locals
- Set .probe_type = PROBE_PREFER_ASYNCHRONOUS
Changes in v2:
- Convert to .notify_new and set .min_event_size
- Ignore firmware-handled backlight and toggle events, which removes the toggle deduplication state
- Add the missing select INPUT_SPARSEKMAP
- Name the event codes and align the defines
- Add the dev_printk.h include
Re: BMOF data -- the WMI device does not expose embedded BMOF data; there is no bmof sysfs attribute for B74AF83F-8B2F-4069-ACAC-36D176F62FC0.
--- MAINTAINERS | 6 ++ drivers/platform/x86/Kconfig | 12 +++ drivers/platform/x86/Makefile | 1 + drivers/platform/x86/xiaomi-wmi-keys.c | 134 +++++++++++++++++++++++++ 4 files changed, 153 insertions(+) create mode 100644 drivers/platform/x86/xiaomi-wmi-keys.c
MAINTAINERS +6 -0
@@ -30546,6 +30546,12 @@ F: fs/xfs/ F: include/uapi/linux/dqblk_xfs.h F: include/uapi/linux/fsmap.h +XIAOMI WMI KEYS DRIVER +M: Lucy Wong <[email protected]> +L: [email protected] +S: Maintained +F: drivers/platform/x86/xiaomi-wmi-keys.c + XILINX AMS DRIVER M: Sai Krishna Potthuri <[email protected]> M: Conall O'Griofa <[email protected]>
drivers/platform/x86/Kconfig +12 -0
@@ -78,6 +78,18 @@ config XIAOMI_WMI To compile this driver as a module, choose M here: the module will be called xiaomi-wmi. +config XIAOMI_WMI_KEYS + tristate "Xiaomi WMI key events driver" + depends on ACPI_WMI + depends on INPUT + select INPUT_SPARSEKMAP + help + Say Y here if you want to support WMI-based hotkey events on certain + Xiaomi laptops. + + To compile this driver as a module, choose M here: the module will + be called xiaomi-wmi-keys. + config REDMI_WMI tristate "Redmibook WMI key driver" depends on ACPI_WMI
drivers/platform/x86/Makefile +1 -0
@@ -9,6 +9,7 @@ obj-$(CONFIG_HUAWEI_WMI) += huawei-wmi.o obj-$(CONFIG_MXM_WMI) += mxm-wmi.o obj-$(CONFIG_NVIDIA_WMI_EC_BACKLIGHT) += nvidia-wmi-ec-backlight.o obj-$(CONFIG_XIAOMI_WMI) += xiaomi-wmi.o +obj-$(CONFIG_XIAOMI_WMI_KEYS) += xiaomi-wmi-keys.o obj-$(CONFIG_REDMI_WMI) += redmi-wmi.o obj-$(CONFIG_GIGABYTE_WMI) += gigabyte-wmi.o obj-$(CONFIG_BITLAND_MIFS_WMI) += bitland-mifs-wmi.o
drivers/platform/x86/xiaomi-wmi-keys.c new file +134 -0
134 lines not on this page · raw message
Signature · 1 line
2.56.0
Ilpo Järvinen
maintainerQuoted 5 lines · Lucy Wong
Certain Xiaomi laptops expose extra function keys through a single WMI event GUID (B74AF83F-8B2F-4069-ACAC-36D176F62FC0). Unlike the existing xiaomi-wmi driver where each key has its own GUID, here all keys share one GUID and the event buffer encodes both an event type and a keycode:
Quoted 7 lines
buffer[1] = event type
0x01: keyboard backlight level (EC handled) 0x02: press/release keys (5 keys with abstract icons) 0x03: firmware-handled toggles (touchpad, Fn lock)buffer[2] = keycode within that type
[...]
Thank you for your contribution, it has been applied to my local review-ilpo-next branch. Note it will show up in the public platform-drivers-x86/review-ilpo-next branch only once I've pushed my local branch there, which might take a while.
FYI [if applicable to your patch], as per Linus' policy change, also fixes are mostly routed through for-next unless the fix is for a commit introduced in the most recent cycle or is clearly a regression fix.
The list of commits applied:
[1/1] platform/x86: add Xiaomi WMI key driver
commit: 9a48682bdf4eac3286bad27d6e0cd6a5ab80255d
--
i.