From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from hope.aquinas.su (hope.aquinas.su [82.148.24.172]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8207E265606; Mon, 14 Sep 2026 06:41:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=82.148.24.172 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789368087; cv=none; b=X1s/pU+FhfoM7zAiU57Qv9skRNHZS3kZ3emtmarRE74XnTItRoIqlbUCh50WCVPBaxtmvsN64Wrk3wo1j0fTlA/Z7DGz9ML67jjtt8s4ZRV7UOctmJVHydl6jZgT8Dyos0w9vSAyKkjR5reHGy1+tfgKERgmxFZ56ntFCtMoHTY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789368087; c=relaxed/simple; bh=mAXfjL4ja6yci7UvzWKgU6ZzxLaSY4K54vfN8PXV5uI=; h=From:To:Subject:Date:Message-ID:MIME-Version:Content-Type; b=Y37mXXEofbyhr2ExBtpGdP9EfWYQMMHpb1hxxim1E/bcoQfnykRmORiwOlRZ/5lhSa6myygueKzIp2TvuLsvK4WTl5cs6GQkd06MKwx2WuWvNyL3Z7TQxisXOfbkFalO3CMJyNJf5pggvgqksgXC50IHcHkl8lvgkr7K+BAIuhc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=aquinas.su; spf=pass smtp.mailfrom=aquinas.su; dkim=pass (2048-bit key) header.d=aquinas.su header.i=@aquinas.su header.b=bM4g0CI0; arc=none smtp.client-ip=82.148.24.172 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=aquinas.su Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=aquinas.su Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=aquinas.su header.i=@aquinas.su header.b="bM4g0CI0" Received: from woolf.localnet (unknown [158.46.243.40]) (Authenticated sender: admin@aquinas.su) by hope.aquinas.su (Postfix) with ESMTPSA id 4CC6E706AC; Mon, 14 Sep 2026 09:33:49 +0300 (MSK) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aquinas.su; s=default; t=1789367631; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=awEib7GlI6b5ljTYq2rUg7YmGdHGJV2aVR7ARjpplA8=; b=bM4g0CI05Fn7l9ni8YYT81px6p0gO80bw3gE+H/akTrlalsPP8yx5VbDHvkbd1XBSba7yt /wWQuI2JYfmaY/GF7rJPrXIxzcoT0pOi+sgo54mV0AJIYHqeFcElm9oZwKdMBUwcefCjAX k0tee9xUS6nnTR502SAXfl2UOmHjUuqGon4HNket6J7BzEjCvmcN4UkmVEAF+CpZKsa2Yy ErXvFJK2Kr0AwC81Rq2XSCViKWWh+BER7gZauglsJe2kCrNCpQGR7S6k7z8xK/zXLClCZh RMupJP/U1d7P47KhfhG4Wb5QHzevnG8JkYTQAnA0guCTZ3tqQxJtBAxePBAeVw== Authentication-Results: hope.aquinas.su; auth=pass smtp.auth=admin@aquinas.su smtp.mailfrom=admin@aquinas.su From: =?UTF-8?B?0JrQvtC90LXQvdC60L4g0JDQvdC00YDQtdC5INCS0LjQutGC0L7RgNC+0LLQuNGH?= To: Ilpo =?UTF-8?B?SsOkcnZpbmVu?= , LKML , platform-driver-x86@vger.kernel.org, Hans de Goede Subject: [PATCH v11] platform/x86: hp-wmi: Add multicolor LED support for HP keyboard backlight Date: Mon, 14 Sep 2026 13:33:48 +0700 Message-ID: <0Ja9VPr1QTSihXZrbKAgzg@aquinas.su> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add support for the HP keyboard RGB backlight found on HP OMEN and HP Victus laptops. These keyboards expose per-zone RGB control through WMI commands. Register multicolor LED class devices for each keyboard zone (up to 4 zones, depending on the keyboard type). Each zone exposes individual red, green, and blue channels via the multicolor LED subsystem. Also hardware-initiated brightness changes (e.g. via the keyboard backlight hotkey, mostly fn+f4) are reported. The color data is stored in a 128-byte color table managed by the firmware, with RGB values starting at offset 25, packed sequentially per zone. Signed-off-by: Konenko Andrey Viktorovich =2D-- Changes since v10: - adapted for current linux-next (20260914) - Added Named Constants: HP_BACKLIGHT_EVENT_ON =E2=80=94 replaces magic number for backlight enable= event HP_BACKLIGHT_EVENT_OFF =E2=80=94 replaces magic number for backlight disab= le event HP_KBD_RGB_COLORS =E2=80=94 replaces universally used literal 3 as RGB col= or/channel count - Refactored hp_kbd_brightness_set_by_hwd Function - Eliminated reliance o= n magic numbers in event handling logic (bugfix) - Event Filtering (critical bugfix): Added event type filtering in hp_wmi_notify() before calling hp_kbd_bright= ness_set_by_hwd() This prevents EC flooding and keyboard malfunction on some devices Changes since v9: - Fixed corrupted long lines - Fixed changelog Changes since v8: - No changes (It was mistake to resend email without any fix) Changes since v7: - The LED class device names changed to be consistent with the documentati= on. Changes since v6: - The LED class device names have been made more consistent with the=20 documentation, in accordance with patch https://lore.kernel.org/linux-leds/ 20260504145434.12746-1-johannes.goede@oss.qualcomm.com/ underscores have been replaced with dashes where indicated. Changes since v5: - LED class device names changed from a number to using a descriptive name= =20 for each zone. v4: https://lore.kernel.org/all/20260303084022.7223-3-edip@medip.dev/ Changes since v4: - Fix circular dependencies Changes since v3: - Merge the changes into a single commit Changes since v1: - Fix mentioned style errors - Add Kconfig dependencies =2D-- drivers/platform/x86/hp/Kconfig | 2 + drivers/platform/x86/hp/hp-wmi.c | 298 ++++++++++++++++++++++++++++++- 2 files changed, 299 insertions(+), 1 deletion(-) diff --git a/drivers/platform/x86/hp/Kconfig b/drivers/platform/x86/hp/Kcon= fig index dd51491b9bcd..2a1841cbec76 100644 =2D-- a/drivers/platform/x86/hp/Kconfig +++ b/drivers/platform/x86/hp/Kconfig @@ -45,6 +45,8 @@ config HP_WMI select INPUT_SPARSEKMAP select ACPI_PLATFORM_PROFILE select HWMON + select LEDS_CLASS + select LEDS_CLASS_MULTICOLOR help Say Y here if you want to support WMI-based hotkeys on HP laptops and to read data from WMI such as docking or ambient light sensor state. diff --git a/drivers/platform/x86/hp/hp-wmi.c b/drivers/platform/x86/hp/hp-= wmi.c index 615b4cf6fc45..cf57b6b00b01 100644 =2D-- a/drivers/platform/x86/hp/hp-wmi.c +++ b/drivers/platform/x86/hp/hp-wmi.c @@ -28,6 +28,8 @@ #include #include #include +#include +#include #include #include #include @@ -61,6 +63,10 @@ enum hp_ec_offsets { #define HP_FAN_SPEED_AUTOMATIC 0x00 #define HP_POWER_LIMIT_DEFAULT 0x00 #define HP_POWER_LIMIT_NO_CHANGE 0xFF +#define HP_COLOR_TABLE_PADDING 25 +#define HP_BACKLIGHT_EVENT_ON 0x2 +#define HP_BACKLIGHT_EVENT_OFF 0x0 +#define HP_KBD_RGB_COLORS 3 #define HPWMI_MUX_MODE_UMA BIT(0) #define HPWMI_MUX_MODE_HYBRID BIT(1) #define HPWMI_MUX_MODE_DISCRETE BIT(2) @@ -106,6 +112,14 @@ enum hp_thermal_profile { HP_THERMAL_PROFILE_QUIET =3D 0x03, }; =20 +enum hp_keyboard_type { + HP_KEYBOARD_TYPE_NOBACKLIGHT =3D 0x0, + HP_KEYBOARD_TYPE_FOURZONE_WITH_NUMPAD =3D 0x1, + HP_KEYBOARD_TYPE_FOURZONE_WITHOUT_NUMPAD =3D 0x2, + HP_KEYBOARD_TYPE_RGB_PER_KEY =3D 0x3, + HP_KEYBOARD_TYPE_SINGLEZONE_WITH_NUMPAD =3D 0x4, + HP_KEYBOARD_TYPE_SINGLEZONE_WITHOUT_NUMPAD =3D 0x5, +}; =20 struct thermal_profile_params { u8 performance; @@ -433,16 +447,27 @@ enum hp_wmi_gm_commandtype { HPWMI_GET_GPU_THERMAL_MODES_QUERY =3D 0x21, HPWMI_SET_GPU_THERMAL_MODES_QUERY =3D 0x22, HPWMI_SET_POWER_LIMITS_QUERY =3D 0x29, + HPWMI_GET_KEYBOARD_TYPE_QUERY =3D 0x2b, HPWMI_VICTUS_S_FAN_SPEED_GET_QUERY =3D 0x2D, HPWMI_VICTUS_S_FAN_SPEED_SET_QUERY =3D 0x2E, HPWMI_VICTUS_S_GET_FAN_TABLE_QUERY =3D 0x2F, }; =20 +enum hp_wmi_backlight_commandtype { + HPWMI_BACKLIGHT_COLOR_GET_QUERY =3D 0x02, + HPWMI_BACKLIGHT_COLOR_SET_QUERY =3D 0x03, + HPWMI_BACKLIGHT_BRIGHTNESS_GET_QUERY =3D 0x04, + HPWMI_BACKLIGHT_BRIGHTNESS_SET_QUERY =3D 0x05, + HPWMI_BACKLIGHT_SET_OFF_QUERY =3D 0x64, + HPWMI_BACKLIGHT_SET_ON_QUERY =3D 0xE4, +}; + enum hp_wmi_command { HPWMI_READ =3D 0x01, HPWMI_WRITE =3D 0x02, HPWMI_ODM =3D 0x03, HPWMI_GM =3D 0x20008, + HPWMI_BACKLIGHT =3D 0x20009, }; =20 enum hp_wmi_hardware_mask { @@ -450,6 +475,24 @@ enum hp_wmi_hardware_mask { HPWMI_TABLET_MASK =3D 0x04, }; =20 +struct hp_kbd_led_priv { + int zone; /* Zone index (0-3) */ + enum led_brightness last_brightness; /* Brightness before turning off */ +}; + +struct hp_mc_leds { + struct led_classdev_mc devices[4]; + struct hp_kbd_led_priv priv[4]; +}; + +/* zone naming for 4-zone keyboards (HP Omen) */ +static const char *const hp_zone_names_4[] =3D { + [0] =3D "zoned_backlight-right", + [1] =3D "zoned_backlight-center", + [2] =3D "zoned_backlight-left", + [3] =3D "zoned_backlight-wasd", +}; + struct bios_return { u32 sigpass; u32 return_code; @@ -530,6 +573,7 @@ static DEFINE_MUTEX(active_platform_profile_lock); static struct input_dev *hp_wmi_input_dev; static struct input_dev *camera_shutter_input_dev; static struct platform_device *hp_wmi_platform_dev; +static struct hp_mc_leds hp_multicolor_leds; static struct device *platform_profile_device; static struct notifier_block platform_power_source_nb; static enum platform_profile_option active_platform_profile; @@ -1338,6 +1382,8 @@ static struct attribute *hp_wmi_attrs[] =3D { }; ATTRIBUTE_GROUPS(hp_wmi); =20 +static void hp_kbd_brightness_set_by_hwd(u32 event_data); + static void hp_wmi_notify(union acpi_object *obj, void *context) { u32 event_id, event_data; @@ -1438,6 +1484,16 @@ static void hp_wmi_notify(union acpi_object *obj, vo= id *context) case HPWMI_PROXIMITY_SENSOR: break; case HPWMI_BACKLIT_KB_BRIGHTNESS: + /* + * Only handle actual backlight events (0x0 and 0x2). + * Other event_data values (like keyboard scan codes, e.g. 0x20 for 'd') + * are keyboard events and should be handled via sparse_keymap, + * not treated as brightness control commands. + */ + if (event_data !=3D HP_BACKLIGHT_EVENT_ON && + event_data !=3D HP_BACKLIGHT_EVENT_OFF) + break; + hp_kbd_brightness_set_by_hwd(event_data); break; case HPWMI_PEAKSHIFT_PERIOD: break; @@ -1700,6 +1756,244 @@ static int __init hp_wmi_rfkill2_setup(struct platf= orm_device *device) return err; } =20 +static struct hp_kbd_led_priv *hp_led_get_priv(struct led_classdev *led_cd= ev) +{ + struct led_classdev_mc *mc_cdev =3D lcdev_to_mccdev(led_cdev); + int zone =3D mc_cdev - hp_multicolor_leds.devices; + + return &hp_multicolor_leds.priv[zone]; +} + +static int hp_kbd_backlight_set_rgb_color(int zone, int red, int green, in= t blue) +{ + u8 color_table[128]; + int ret; + + /* + * Get the current color table and then change only the relevant parts. + */ + ret =3D hp_wmi_perform_query(HPWMI_BACKLIGHT_COLOR_GET_QUERY, + HPWMI_BACKLIGHT, color_table, + zero_if_sup(color_table), + sizeof(color_table)); + if (ret) + return ret; + + /* + * RGB color data starts at offset 25 +3 per zone (r g b) + * e.g. if zone 1 starts in 25 zone 2 starts in 28 + */ + color_table[HP_COLOR_TABLE_PADDING + zone * HP_KBD_RGB_COLORS] =3D re= d; + color_table[HP_COLOR_TABLE_PADDING + zone * HP_KBD_RGB_COLORS + 1] =3D gr= een; + color_table[HP_COLOR_TABLE_PADDING + zone * HP_KBD_RGB_COLORS + 2] =3D bl= ue; + + ret =3D hp_wmi_perform_query(HPWMI_BACKLIGHT_COLOR_SET_QUERY, HPWMI_BACKL= IGHT, + color_table, sizeof(color_table), sizeof(color_table)); + if (ret < 0) + return ret; + if (ret) + return -EINVAL; + + return 0; +} + +static bool hp_kbd_backlight_is_on(void) +{ + u8 data; + int ret; + + ret =3D hp_wmi_perform_query(HPWMI_BACKLIGHT_BRIGHTNESS_GET_QUERY, HPWMI_= BACKLIGHT, &data, + sizeof(data), sizeof(data)); + if (ret) + return false; + + return data =3D=3D HPWMI_BACKLIGHT_SET_ON_QUERY; +} + +static int hp_kbd_set_brightness(struct led_classdev *led_cdev, + enum led_brightness brightness) +{ + struct hp_kbd_led_priv *priv =3D hp_led_get_priv(led_cdev); + struct led_classdev_mc *mc_cdev; + struct led_classdev_mc *device; + int red, green, blue; + int ret; + + if (!hp_kbd_backlight_is_on()) { + u8 data =3D HPWMI_BACKLIGHT_SET_ON_QUERY; + + ret =3D hp_wmi_perform_query(HPWMI_BACKLIGHT_BRIGHTNESS_SET_QUERY, + HPWMI_BACKLIGHT, &data, + sizeof(data), sizeof(data)); + if (ret) + return ret; + + /* + * Turning the backlight on via WMI turns all zones, + * so we need to restore the other zones' off state. + */ + for (int i =3D 0; i < ARRAY_SIZE(hp_multicolor_leds.devices); i++) { + if (i =3D=3D priv->zone) + continue; + + device =3D &hp_multicolor_leds.devices[i]; + if (!device->led_cdev.name) + continue; + hp_kbd_backlight_set_rgb_color(i, + device->subled_info[0].brightness, + device->subled_info[1].brightness, + device->subled_info[2].brightness); + } + } + + led_cdev->brightness =3D brightness; + + mc_cdev =3D lcdev_to_mccdev(led_cdev); + led_mc_calc_color_components(mc_cdev, brightness); + + red =3D mc_cdev->subled_info[0].brightness; + green =3D mc_cdev->subled_info[1].brightness; + blue =3D mc_cdev->subled_info[2].brightness; + + return hp_kbd_backlight_set_rgb_color(priv->zone, red, green, blue); +} + +static void hp_kbd_brightness_set_by_hwd(u32 event_data) +{ + struct device *dev =3D &hp_wmi_platform_dev->dev; + struct led_classdev *led_cdev; + struct hp_kbd_led_priv *priv; + u8 brightness; + + for (int zone =3D 0; zone < ARRAY_SIZE(hp_multicolor_leds.devices); zone+= +) { + if (!hp_multicolor_leds.devices[zone].led_cdev.name) + continue; + + led_cdev =3D &hp_multicolor_leds.devices[zone].led_cdev; + if (!led_cdev->dev) + continue; + + priv =3D hp_led_get_priv(led_cdev); + + switch (event_data) { + case HP_BACKLIGHT_EVENT_ON: + brightness =3D priv->last_brightness ? : LED_FULL; + break; + case HP_BACKLIGHT_EVENT_OFF: + priv->last_brightness =3D led_cdev->brightness; + brightness =3D LED_OFF; + break; + default: + dev_warn(dev, "Unknown keyboard backlight event - 0x%x\n", + event_data); + return; + } + + led_cdev->brightness =3D brightness; + led_classdev_notify_brightness_hw_changed(led_cdev, brightness); + } +} + +static int __init hp_mc_leds_register(int num_zones) +{ + u8 color_table[128]; + int ret; + + ret =3D hp_wmi_perform_query(HPWMI_BACKLIGHT_COLOR_GET_QUERY, HPWMI_BACKL= IGHT, + color_table, zero_if_sup(color_table), + sizeof(color_table)); + if (ret) + return ret; + + for (int zone =3D 0; zone < num_zones; zone++) { + struct led_classdev_mc *multicolor_led_dev; + struct led_classdev *led_cdev; + struct mc_subled *mc_subled_info; + struct hp_kbd_led_priv *priv; + struct device *dev; + + dev =3D &hp_wmi_platform_dev->dev; + multicolor_led_dev =3D &hp_multicolor_leds.devices[zone]; + led_cdev =3D &multicolor_led_dev->led_cdev; + priv =3D &hp_multicolor_leds.priv[zone]; + + if (num_zones =3D=3D 1) + led_cdev->name =3D devm_kasprintf(dev, GFP_KERNEL, + "hp::kbd_backlight"); + else if (num_zones =3D=3D 4 && zone < ARRAY_SIZE(hp_zone_names_4)) + led_cdev->name =3D devm_kasprintf(dev, GFP_KERNEL, + "hp::kbd_%s", + hp_zone_names_4[zone]); + else if (num_zones > 1) + led_cdev->name =3D devm_kasprintf(dev, GFP_KERNEL, + "hp::kbd_zoned_backlight-%d", + zone); + + if (!led_cdev->name) + return -ENOMEM; + led_cdev->brightness =3D hp_kbd_backlight_is_on() ? + LED_FULL : LED_OFF; + led_cdev->max_brightness =3D LED_FULL; + led_cdev->brightness_set_blocking =3D hp_kbd_set_brightness; + led_cdev->flags =3D LED_CORE_SUSPENDRESUME | + LED_RETAIN_AT_SHUTDOWN | + LED_BRIGHT_HW_CHANGED; + + mc_subled_info =3D devm_kzalloc(dev, sizeof(*mc_subled_info) * HP_KBD_RG= B_COLORS, + GFP_KERNEL); + if (!mc_subled_info) + return -ENOMEM; + + mc_subled_info[0].color_index =3D LED_COLOR_ID_RED; + mc_subled_info[1].color_index =3D LED_COLOR_ID_GREEN; + mc_subled_info[2].color_index =3D LED_COLOR_ID_BLUE; + + for (int i =3D 0; i < HP_KBD_RGB_COLORS; i++) { + int off =3D HP_COLOR_TABLE_PADDING + zone * HP_KBD_RGB_COLORS + i; + + mc_subled_info[i].channel =3D zone * HP_KBD_RGB_COLORS + i; + mc_subled_info[i].intensity =3D color_table[off]; + mc_subled_info[i].brightness =3D LED_FULL; + } + + multicolor_led_dev->subled_info =3D mc_subled_info; + multicolor_led_dev->num_colors =3D HP_KBD_RGB_COLORS; + + ret =3D devm_led_classdev_multicolor_register(dev, multicolor_led_dev); + if (ret) { + dev_err(dev, "Failed to register multicolor RGB backlight\n"); + return ret; + } + + /* Initialize private data */ + priv->zone =3D zone; + priv->last_brightness =3D LED_FULL; + } + return 0; +} + +static int __init hp_kbd_rgb_setup(void) +{ + u8 keyboard_type; + int ret; + + ret =3D hp_wmi_perform_query(HPWMI_GET_KEYBOARD_TYPE_QUERY, HPWMI_GM, &ke= yboard_type, + sizeof(keyboard_type), sizeof(keyboard_type)); + if (ret) + return ret; + + switch (keyboard_type) { + case HP_KEYBOARD_TYPE_FOURZONE_WITH_NUMPAD: + case HP_KEYBOARD_TYPE_FOURZONE_WITHOUT_NUMPAD: + return hp_mc_leds_register(4); + case HP_KEYBOARD_TYPE_SINGLEZONE_WITH_NUMPAD: + case HP_KEYBOARD_TYPE_SINGLEZONE_WITHOUT_NUMPAD: + return hp_mc_leds_register(1); + default: + return 0; + } +} + static int platform_profile_omen_get_ec(enum platform_profile_option *prof= ile) { int tp; @@ -2541,7 +2835,9 @@ static int __init hp_wmi_bios_setup(struct platform_d= evice *device) return err; =20 thermal_profile_setup(device); =2D + err =3D hp_kbd_rgb_setup(); + if (err) + dev_err(&device->dev, "Failed to initialize keyboard RGB\n"); return 0; } =20 =2D-=20 2.55.0