| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <374b993c-b364-44cd-89c2-c2dc6883f1cd@139.com>
Date: Wed, 12 Feb 2025 15:04:17 +0800
From: Jackie Dong <xy-jackie@....com>
To: Kurt Borja <kuurtb@...il.com>, hdegoede@...hat.com,
ilpo.jarvinen@...ux.intel.com
Cc: linux-kernel@...r.kernel.org, platform-driver-x86@...r.kernel.org,
dongeg1@...ovo.com, Mark Pearson <mpearson-lenovo@...ebb.ca>
Subject: Re: [PATCH v4] platform/x86: lenovo-super-hotkey-wmi.c: Support
formic and audio mute LEDs
On 2/12/25 02:17, Kurt Borja wrote:
> Hi Jackie,
>
> On Tue Feb 11, 2025 at 10:20 AM -05, Jackie Dong wrote:
>> Implement Lenovo utility data WMI calls needed to make LEDs
>> work on Ideapads that support this GUID.
>> This enables the mic and audio LEDs to be updated correctly.
>>
>> Tested on below samples.
>> ThinkBook 13X Gen4 IMH
>> ThinkBook 14 G6 ABP
>> ThinkBook 16p Gen4-21J8
>> ThinkBook 16p Gen8-IRL
>> ThinkBook 16p G7+ ASP
>>
>> Signed-off-by: Jackie Dong <xy-jackie@....com>
>> Suggested-by: Mark Pearson <mpearson-lenovo@...ebb.ca>
>> ---
>> Changes in v4:
>> - Add related head files include cleanup.h, dev_printk.h, device.h,
>> module.h
>> - Replaced kfree() by __free()
>> - Remove double free for obj
>> - Remove wpriv->cdev[led_type].dev = dev
>> - Remove *wpriv = *(const struct lenovo_super_hotkey_wmi_private *)context
>> - Remove wpriv->event == LSH_WMI_EVENT_LUD_KEYS
>> - Remove lenovo_super_hotkey_wmi_remove() for unnecessary
>>
>> Changes in v3:
>> - Changed the name of the Kconfig entry to LENOVO_SUPER_HOTKEY_WMI
>> - Renamed everything in this driver which contains the name "ideapad"
>> to instead contain the name of this driver.
>> - Moved struct wmi_device *led_wdev in lenovo_super_hotkey_wmi_private,
>> and use container_of() to the led_wdev pointer.
>> - Replaced sizeof(struct wmi_led_args) by sizeof(led_arg)
>> - Added condtions checking for obj && obj->type == ACPI_TYPE_INTEGER
>> and free the ACPI object after get the required value.
>> - Removed led_classdev_unregister() after led_reg_failed label, but
>> add lenovo_super_hotkey_wmi_remove(struct wmi_device *wdev) to free
>> resource.
>> - Removed IDEAPAD_WMI_EVENT_FN_KEYS/IDEAPAD_WMI_EVENT_LUD_KEYS related
>> source codes and only keep LUD_WMI_METHOD_GUID.
>>
>> Changes in v2:
>> - Update code layout and formatting as recommended in review
>> - Improved error handling in ideapad_wmi_led_init
>> - Separated a WMI driver named lenovo-super-hotkey-wmi.c from
>> ideapad-lap.c, it's only for Lenovo Super Hotkey WMI devices.
>>
>> drivers/platform/x86/Kconfig | 9 +
>> drivers/platform/x86/Makefile | 1 +
>> .../platform/x86/lenovo-super-hotkey-wmi.c | 234 ++++++++++++++++++
>> 3 files changed, 244 insertions(+)
>> create mode 100644 drivers/platform/x86/lenovo-super-hotkey-wmi.c
>>
>> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
>> index 0258dd879d64..c1792e8f04e1 100644
>> --- a/drivers/platform/x86/Kconfig
>> +++ b/drivers/platform/x86/Kconfig
>> @@ -475,6 +475,15 @@ config IDEAPAD_LAPTOP
>> This is a driver for Lenovo IdeaPad netbooks contains drivers for
>> rfkill switch, hotkey, fan control and backlight control.
>>
>> +config LENOVO_SUPER_HOTKEY_WMI
>> + tristate "Lenovo Super Hotkey Utility WMI extras driver"
>> + depends on ACPI_WMI
>> + depends on IDEAPAD_LAPTOP
>> + help
>> + This driver provides WMI support for Lenovo customized hotkeys function
>> + of Lenovo NoteBooks which are for Consumer and SMB customers, such as
>> + Ideapad/YOGA/XiaoXin/Gaming/ThinkBook and so on.
>> +
>> config LENOVO_YMC
>> tristate "Lenovo Yoga Tablet Mode Control"
>> depends on ACPI_WMI
>> diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
>> index e1b142947067..598335da9f55 100644
>> --- a/drivers/platform/x86/Makefile
>> +++ b/drivers/platform/x86/Makefile
>> @@ -61,6 +61,7 @@ obj-$(CONFIG_UV_SYSFS) += uv_sysfs.o
>> # IBM Thinkpad and Lenovo
>> obj-$(CONFIG_IBM_RTL) += ibm_rtl.o
>> obj-$(CONFIG_IDEAPAD_LAPTOP) += ideapad-laptop.o
>> +obj-$(CONFIG_LENOVO_SUPER_HOTKEY_WMI) += lenovo-super-hotkey-wmi.o
>> obj-$(CONFIG_LENOVO_YMC) += lenovo-ymc.o
>> obj-$(CONFIG_SENSORS_HDAPS) += hdaps.o
>> obj-$(CONFIG_THINKPAD_ACPI) += thinkpad_acpi.o
>> diff --git a/drivers/platform/x86/lenovo-super-hotkey-wmi.c b/drivers/platform/x86/lenovo-super-hotkey-wmi.c
>> new file mode 100644
>> index 000000000000..f5704dad5cb2
>> --- /dev/null
>> +++ b/drivers/platform/x86/lenovo-super-hotkey-wmi.c
>> @@ -0,0 +1,234 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +/*
>> + * Lenovo Super Hotkey Utility WMI extras driver for Ideapad laptop
>> + *
>> + * Copyright (C) 2025 Lenovo
>> + */
>> +
>> +#include <linux/cleanup.h>
>> +#include <linux/dev_printk.h>
>> +#include <linux/device.h>
>> +#include <linux/leds.h>
>> +#include <linux/module.h>
>> +#include <linux/wmi.h>
>> +
>> +/* Lenovo Super Hotkey WMI GUIDs */
>> +#define LUD_WMI_METHOD_GUID "CE6C0974-0407-4F50-88BA-4FC3B6559AD8"
>> +
>> +/* Lenovo Utility Data WMI method_id */
>> +#define WMI_LUD_GET_SUPPORT 1
>> +#define WMI_LUD_SET_FEATURE 2
>> +
>> +#define WMI_LUD_GET_MICMUTE_LED_VER 20
>> +#define WMI_LUD_GET_AUDIOMUTE_LED_VER 26
>> +
>> +#define WMI_LUD_SUPPORT_MICMUTE_LED_VER 25
>> +#define WMI_LUD_SUPPORT_AUDIOMUTE_LED_VER 27
>> +
>> +/* Input parameters to mute/unmute audio LED and Mic LED */
>> +struct wmi_led_args {
>> + u8 id;
>> + u8 subid;
>> + u16 value;
>> +};
>> +
>> +/* Values of input parameters to SetFeature of audio LED and Mic LED */
>> +enum hotkey_set_feature {
>> + MIC_MUTE_LED_ON = 1,
>> + MIC_MUTE_LED_OFF,
>> + AUDIO_MUTE_LED_ON = 4,
>> + AUDIO_MUTE_LED_OFF,
>> +};
>> +
>> +#define LSH_ACPI_LED_MAX 2
>> +
>> +enum lenovo_super_hotkey_wmi_event_type {
>> + LSH_WMI_EVENT_LUD_KEYS = 2,
>> +};
>> +
>> +struct lenovo_super_hotkey_wmi_private {
>> + enum lenovo_super_hotkey_wmi_event_type event;
>> + struct led_classdev cdev[LSH_ACPI_LED_MAX];
>> + struct wmi_device *led_wdev;
>> +};
>> +
>> +enum mute_led_type {
>> + MIC_MUTE,
>> + AUDIO_MUTE,
>> +};
>> +
>> +static int lsh_wmi_mute_led_set(enum mute_led_type led_type, struct led_classdev *led_cdev,
>> + enum led_brightness brightness)
>> +
>> +{
>> + struct lenovo_super_hotkey_wmi_private *wpriv = container_of(led_cdev,
>> + struct lenovo_super_hotkey_wmi_private, cdev[led_type]);
>> + struct wmi_led_args led_arg = {0, 0, 0};
>> + struct acpi_buffer input;
>> + acpi_status status;
>> +
>> + switch (led_type) {
>> + case MIC_MUTE:
>> + led_arg.id = brightness == LED_ON ? MIC_MUTE_LED_ON : MIC_MUTE_LED_OFF;
>> + break;
>> + case AUDIO_MUTE:
>> + led_arg.id = brightness == LED_ON ? AUDIO_MUTE_LED_ON : AUDIO_MUTE_LED_OFF;
>> + break;
>> + default:
>> + return -EINVAL;
>> + }
>> +
>> + input.length = sizeof(led_arg);
>> + input.pointer = &led_arg;
>> + status = wmidev_evaluate_method(wpriv->led_wdev, 0, WMI_LUD_SET_FEATURE, &input, NULL);
>> + if (ACPI_FAILURE(status))
>> + return -EIO;
>> +
>> + return 0;
>> +}
>> +
>> +static int lsh_wmi_audiomute_led_set(struct led_classdev *led_cdev,
>> + enum led_brightness brightness)
>> +
>> +{
>> + return lsh_wmi_mute_led_set(AUDIO_MUTE, led_cdev, brightness);
>> +}
>> +
>> +static int lsh_wmi_micmute_led_set(struct led_classdev *led_cdev,
>> + enum led_brightness brightness)
>> +{
>> + return lsh_wmi_mute_led_set(MIC_MUTE, led_cdev, brightness);
>> +}
>> +
>> +static int lenovo_super_hotkey_wmi_led_init(enum mute_led_type led_type, struct device *dev)
>> +{
>> + struct lenovo_super_hotkey_wmi_private *wpriv = dev_get_drvdata(dev);
>> + struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
>> + struct acpi_buffer input;
>> + union acpi_object *obj;
>> + int led_version, err = 0;
>> + unsigned int wmiarg;
>> + acpi_status status;
>> +
>> + switch (led_type) {
>> + case MIC_MUTE:
>> + wmiarg = WMI_LUD_GET_MICMUTE_LED_VER;
>> + break;
>> + case AUDIO_MUTE:
>> + wmiarg = WMI_LUD_GET_AUDIOMUTE_LED_VER;
>> + break;
>> + default:
>> + return -EINVAL;
>> + }
>> +
>> + input.length = sizeof(wmiarg);
>> + input.pointer = &wmiarg;
>> + status = wmidev_evaluate_method(wpriv->led_wdev, 0, WMI_LUD_GET_SUPPORT, &input, &output);
>> + if (ACPI_FAILURE(status))
>> + return -EIO;
>> +
>> + obj = output.pointer;
>
> This is where
>
> union acpi_object *obj __free(kfree) = output.pointer;
>
> should go, not inside the if-else block.
>
> If you prefer to free `obj` immidiately you should do it manually. But
> be careful not to introduce memory bugs.
>
>> + if (obj && obj->type == ACPI_TYPE_INTEGER) {
>> + led_version = obj->integer.value;
>> + union acpi_object *obj __free(kfree) = output.pointer;
>> + } else {
>> + err = -EIO;
>> + union acpi_object *obj __free(kfree) = output.pointer;
>> + return err;
>> + }
>> +
>> + wpriv->cdev[led_type].max_brightness = LED_ON;
>> + wpriv->cdev[led_type].flags = LED_CORE_SUSPENDRESUME;
>> +
>> + switch (led_type) {
>> + case MIC_MUTE:
>> + if (led_version != WMI_LUD_SUPPORT_MICMUTE_LED_VER) {
>> + err = -EIO;
>> + goto led_error;
>> + }
>> + wpriv->cdev[led_type].name = "platform::micmute";
>> + wpriv->cdev[led_type].brightness_set_blocking = &lsh_wmi_micmute_led_set;
>> + wpriv->cdev[led_type].default_trigger = "audio-micmute";
>> +
>> + err = devm_led_classdev_register(dev, &wpriv->cdev[led_type]);
>> + if (err < 0)
>> + goto led_reg_failed;
>> +
>> + break;
>> + case AUDIO_MUTE:
>> + if (led_version != WMI_LUD_SUPPORT_AUDIOMUTE_LED_VER) {
>> + err = -EIO;
>> + goto led_error;
>> + }
>> + wpriv->cdev[led_type].name = "platform::mute";
>> + wpriv->cdev[led_type].brightness_set_blocking = &lsh_wmi_audiomute_led_set;
>> + wpriv->cdev[led_type].default_trigger = "audio-mute";
>> +
>> + err = devm_led_classdev_register(dev, &wpriv->cdev[led_type]);
>> + if (err < 0)
>> + goto led_reg_failed;
>> +
>> + break;
>> + default:
>> + err = -EINVAL;
>> + dev_err(dev, "Unknown LED type %d\n", led_type);
>> + goto led_error;
>> + }
>> +
>> + return 0;
>> +
>> +led_reg_failed:
>> + dev_err(dev, "Could not register mute LED %d : %d\n", led_type, err);
>> +
>> +led_error:
>> + return err;
>> +}
>> +
>> +static void lenovo_super_hotkey_wmi_leds_setup(struct device *dev)
>> +{
>> + lenovo_super_hotkey_wmi_led_init(MIC_MUTE, dev);
>> + lenovo_super_hotkey_wmi_led_init(AUDIO_MUTE, dev);
>> +}
>> +
>> +static int lenovo_super_hotkey_wmi_probe(struct wmi_device *wdev, const void *context)
>> +{
>> + struct lenovo_super_hotkey_wmi_private *wpriv;
>> +
>> + wpriv = devm_kzalloc(&wdev->dev, sizeof(*wpriv), GFP_KERNEL);
>> + if (!wpriv)
>> + return -ENOMEM;
>> +
>> + dev_set_drvdata(&wdev->dev, wpriv);
>> + wpriv->led_wdev = wdev;
>> + lenovo_super_hotkey_wmi_leds_setup(&wdev->dev);
>> +
>> + return 0;
>> +}
>> +
>> +static const struct lenovo_super_hotkey_wmi_private lsk_wmi_context_lud_keys = {
>> + .event = LSH_WMI_EVENT_LUD_KEYS
>> +};
>> +
>> +static const struct wmi_device_id lenovo_super_hotkey_wmi_id_table[] = {
>> + { LUD_WMI_METHOD_GUID, &lsk_wmi_context_lud_keys }, /* Utility data */
>
> Is this `context` needed anymore? It is not used anymore so you can maybe
> drop it?
>
Hi Kurt,
Thanks for your new comments, I have updated in v5 patch and sent it
by mail.
Pls review it, again.
Powered by blists - more mailing lists