From nobody Mon Apr 13 21:01:12 2026 Received: from e3i489.smtp2go.com (e3i489.smtp2go.com [158.120.85.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id F22763AE18B for ; Wed, 4 Mar 2026 11:16:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=158.120.85.233 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772622978; cv=none; b=RHoDW4+j/YV/YGQkGjRCuW8RpMO+z91vKg5MpQIqiusnCu1AMAUZrmO67LB6+kXH8kuyitks/fXPzeOdhpyPnmPm3c/DRqmG2Tsdex+ImkHtpPDnnTMNXRM8+UilGMF3RRJThv5MfdQwjpWv2zoNO+nlaLdSXORpuMOu8Wjo1Gs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772622978; c=relaxed/simple; bh=4acsMjBoVlLlXic+7D5BtfAzzuEPenOfXbpuwuzmsPc=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=CkWBL/hFKTYuTjIo02N72hIafT3k//FuFZFcUMD5zg7fslXFDEQbdoS+ZuqnQ3pyEvDlDhMBbIB2HGRiQUe1wyKiyuIz9LUmrE/hZKtsyfG3VJ8M0bEe7ZyoOJVZwOvfHQrWQRVOek7nGCzs1rvL9wNZI/rtwXkzW1iz77iORwk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=medip.dev; spf=pass smtp.mailfrom=em1255854.medip.dev; dkim=pass (2048-bit key) header.d=medip.dev header.i=@medip.dev header.b=nxLPBX5l; arc=none smtp.client-ip=158.120.85.233 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=medip.dev Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=em1255854.medip.dev Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=medip.dev header.i=@medip.dev header.b="nxLPBX5l" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=medip.dev; i=@medip.dev; q=dns/txt; s=s1255854; t=1772622062; h=from : subject : to : message-id : date; bh=YL8CfOdH54DpstwkSwROFB1CqrSB1nAIhgrzHCvAXCg=; b=nxLPBX5l8jMTISDHO/F9QQM6cCon84Cq+2JChe6ZimS0Lgcwi+Pw2xB4yuuZbV/aWbf0z A0O/Lmr7C4Ptd3Pp6WgIbxL62gys1LAzE1Fj1jN+2EEEWTQ/6/G4dNq9cZFNSZTI0PHk/Ie EGDs4yfQc6rEI7pAnsuN2G8yfWVhrgUQ0TWDWzHCKDdJEhc7STO63w+YrFb2+Hp3lRvTRH6 TeuC1zvJ/gG1XxwAYBPgz7hhVfw6W4d0hVqZ0dGVLxdpLZEJBN85nZRQMvIyB5qDnj50rWo hDLzFN918IwpV0gdgAiUqtBYB0Mi/iXEZpu83/ANSedc6V3xwTqG/Ku169zw== Received: from [10.152.250.198] (helo=vilez) by smtpcorp.com with esmtpsa (TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256) (Exim 4.99.1-S2G) (envelope-from ) id 1vxjyL-FnQW0hPzsYP-jKxo; Wed, 04 Mar 2026 11:00:58 +0000 From: edip@medip.dev To: ilpo.jarvinen@linux.intel.com, hansg@kernel.org, kuba@kernel.org Cc: platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org, Edip Hazuri Subject: [PATCH v5] platform/x86: hp-wmi: Add multicolor LED support for HP keyboard backlight Date: Wed, 4 Mar 2026 13:58:33 +0300 Message-ID: <20260304105831.119349-3-edip@medip.dev> X-Mailer: git-send-email 2.53.0 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 X-Report-Abuse: Please forward a copy of this message, including all headers, to Feedback-ID: 1255854m:1255854ay30w_v:1255854sPvly0yD6A X-smtpcorp-track: juZ91RmChRpg.CytzmScdNlms.-RTyrwO2EU2 Content-Type: text/plain; charset="utf-8" From: Edip Hazuri 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: Edip Hazuri --- 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 drivers/platform/x86/hp/Kconfig | 2 + drivers/platform/x86/hp/hp-wmi.c | 274 +++++++++++++++++++++++++++++++ 2 files changed, 276 insertions(+) diff --git a/drivers/platform/x86/hp/Kconfig b/drivers/platform/x86/hp/Kcon= fig index dd51491b9bcd..2a1841cbec76 100644 --- 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 304d9ac63c8a..4a378ebe9be4 100644 --- a/drivers/platform/x86/hp/hp-wmi.c +++ b/drivers/platform/x86/hp/hp-wmi.c @@ -14,6 +14,7 @@ #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt =20 #include +#include #include #include #include @@ -23,6 +24,8 @@ #include #include #include +#include +#include #include #include #include @@ -58,6 +61,8 @@ enum hp_ec_offsets { #define HP_POWER_LIMIT_DEFAULT 0x00 #define HP_POWER_LIMIT_NO_CHANGE 0xFF =20 +#define HP_COLOR_TABLE_PADDING 25 + #define ACPI_AC_CLASS "ac_adapter" =20 #define zero_if_sup(tmp) (zero_insize_support?0:sizeof(tmp)) // use when z= ero insize is required @@ -98,6 +103,15 @@ 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; @@ -290,16 +304,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 { @@ -373,6 +398,16 @@ static const struct key_entry hp_wmi_keymap[] =3D { { KE_END, 0 } }; =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]; +}; + /* * Mutex for the active_platform_profile variable, * see omen_powersource_event. @@ -382,6 +417,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; @@ -1068,6 +1104,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; @@ -1168,6 +1206,7 @@ static void hp_wmi_notify(union acpi_object *obj, voi= d *context) case HPWMI_PROXIMITY_SENSOR: break; case HPWMI_BACKLIT_KB_BRIGHTNESS: + hp_kbd_brightness_set_by_hwd(event_data); break; case HPWMI_PEAKSHIFT_PERIOD: break; @@ -1430,6 +1469,237 @@ 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 * 3] =3D red; + color_table[HP_COLOR_TABLE_PADDING + zone * 3 + 1] =3D green; + color_table[HP_COLOR_TABLE_PADDING + zone * 3 + 2] =3D blue; + + 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); + + if (event_data =3D=3D 0x2) { + brightness =3D priv->last_brightness ? : LED_FULL; + } else if (event_data =3D=3D 0x0) { + priv->last_brightness =3D led_cdev->brightness; + brightness =3D LED_OFF; + } else { + 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 > 1) + led_cdev->name =3D devm_kasprintf(dev, GFP_KERNEL, + "hp::kbd_backlight_zone%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) * 3, + 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 < 3; i++) { + int off =3D HP_COLOR_TABLE_PADDING + zone * 3 + i; + + mc_subled_info[i].channel =3D zone * 3 + 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 3; + + 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; @@ -2230,6 +2500,10 @@ static int __init hp_wmi_bios_setup(struct platform_= device *device) =20 thermal_profile_setup(device); =20 + err =3D hp_kbd_rgb_setup(); + if (err) + dev_err(&device->dev, "Failed to initialize keyboard RGB\n"); + return 0; } =20 --=20 2.53.0