From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from n169-114.mail.139.com (n169-114.mail.139.com [120.232.169.114]) (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 205902753E5; Fri, 14 Feb 2025 15:39:32 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=120.232.169.114 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739547579; cv=none; b=rsWGppW9eHJmufuPKgHfi6VutEXZ+jwllr9fMo/izUq2AuLcHQW08ofCtyhoGhvI/qO8I0Fhix8FjBF1vn256mUuom945XfwTy04/VYieA6RglWT4nN8j9vvBo2U9U/H4lOA6QQUmPP7BhFIqHX6L4GNRguoF44YxX+UVjx/Gw4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739547579; c=relaxed/simple; bh=cmKSs81Yfpp1SXDEIObhzD1XJI6Ce1SUaTS/MQNGIao=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=Ak1ByU+6adP0qd4uSkw1eC53DprGgPbMdhs21LKzi7G/3QuljFgfmao3h020T7EIpbSEcbA4J0lg1YJmuHRK0tLWTen66wJGYL7zAUWvqrQ4B6RMIxnpNnuc4cqhr6huR5wTXDh20FzfGLfN5j0Ox0vpUZiqTHK05bewBYr/6r0= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=139.com; spf=pass smtp.mailfrom=139.com; arc=none smtp.client-ip=120.232.169.114 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=139.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=139.com X-RM-TagInfo: emlType=0 X-RM-SPAM: X-RM-SPAM-FLAG:00000000 Received:from [IPV6:2409:8a00:7877:4fa0:b447:118:24f7:471a] (unknown[2409:8A00:7877:4FA0:B447:118:24F7:471A]) by rmsmtp-lg-appmail-45-12076 (RichMail) with SMTP id 2f2c67af63a5903-7af4a; Fri, 14 Feb 2025 23:39:22 +0800 (CST) X-RM-TRANSID:2f2c67af63a5903-7af4a Message-ID: <71d8eef3-ae69-4e3f-8793-0f4f43f6f896@139.com> Date: Fri, 14 Feb 2025 23:39:21 +0800 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v6] platform/x86:lenovo-wmi-hotkey-utilities To: Kurt Borja , hdegoede@redhat.com, ilpo.jarvinen@linux.intel.com Cc: linux-kernel@vger.kernel.org, platform-driver-x86@vger.kernel.org, W_Armin@gmx.de, dongeg1@lenovo.com, Mark Pearson References: <20250214072347.4297-1-xy-jackie@139.com> Content-Language: en-US From: Jackie Dong In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit On 2/14/25 22:54, Kurt Borja wrote: > Hi Jackie, > > On Fri Feb 14, 2025 at 2:23 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 16 G8 IRL >> ThinkBook 16 G7+ ASP >> >> Signed-off-by: Jackie Dong >> Suggested-by: Mark Pearson > > I noticed this driver lacks a MAINTAINERS entry, could you add one > please? > > After addressing that and some last nitpicks bellow: > > Reviewed-by: Kurt Borja > Hi Kurt, OK, I'll add it. >> --- >> Changes in v6: >> - Rename lenovo-super-hotkey-wmi.c to lenovo-wmi-hotkey-utilities >> - Update LENOVO_WMI_HOTKEY_UTILITIES item description and add select >> NEW_LEDS, LEDS_CLASS based on reviewer's suggestion. >> - Align items in enum hotkey_set_feature >> - Drop some brances and return error message directly >> - Check return value of lenovo_super_hotkey_wmi_led_init() in >> lenovo_super_hotkey_wmi_leds_setup >> >> Changes in v5: >> - Take out union acpi_object *obj __free(kfree) = output.pointer from >> if-else block >> - Remove lsk_wmi_context_lud_keys related source code >> >> 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 | 11 + >> drivers/platform/x86/Makefile | 1 + >> .../x86/lenovo-wmi-hotkey-utilities.c | 227 ++++++++++++++++++ >> 3 files changed, 239 insertions(+) >> create mode 100644 drivers/platform/x86/lenovo-wmi-hotkey-utilities.c >> >> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig >> index 0258dd879d64..715bcfbe992f 100644 >> --- a/drivers/platform/x86/Kconfig >> +++ b/drivers/platform/x86/Kconfig >> @@ -475,6 +475,17 @@ config IDEAPAD_LAPTOP >> This is a driver for Lenovo IdeaPad netbooks contains drivers for >> rfkill switch, hotkey, fan control and backlight control. >> >> +config LENOVO_WMI_HOTKEY_UTILITIES >> + tristate "Lenovo Hotkey Utility WMI extras driver" >> + depends on ACPI_WMI >> + depends on IDEAPAD_LAPTOP >> + select NEW_LEDS >> + select LEDS_CLASS >> + help >> + This driver provides WMI support for Lenovo customized hotkeys function, >> + such as LED control for audio/mic mute event for 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..131fcf974477 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_WMI_HOTKEY_UTILITIES) += lenovo-wmi-hotkey-utilities.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-wmi-hotkey-utilities.c b/drivers/platform/x86/lenovo-wmi-hotkey-utilities.c >> new file mode 100644 >> index 000000000000..e50914a76970 >> --- /dev/null >> +++ b/drivers/platform/x86/lenovo-wmi-hotkey-utilities.c >> @@ -0,0 +1,227 @@ >> +// SPDX-License-Identifier: GPL-2.0 >> +/* >> + * Lenovo Super Hotkey Utility WMI extras driver for Ideapad laptop >> + * >> + * Copyright (C) 2025 Lenovo >> + */ >> + >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> + >> +/* 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 = 2, >> + AUDIO_MUTE_LED_ON = 4, >> + AUDIO_MUTE_LED_OFF = 5, > > We usually align these with tabs like this: > > MIC_MUTE_LED_ON= 1, > ... > > For each line, without adding spaces before tabs. > OK, I'll update it. >> +}; >> + >> +#define LSH_ACPI_LED_MAX 2 >> + >> +struct lenovo_super_hotkey_wmi_private { >> + 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; >> + 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; >> + >> + union acpi_object *obj __free(kfree) = output.pointer; >> + if (obj && obj->type == ACPI_TYPE_INTEGER) >> + led_version = obj->integer.value; >> + else >> + return -EIO; >> + >> + 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) >> + return -EIO; >> + >> + 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) >> + return -EIO; >> + >> + 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: >> + dev_err(dev, "Unknown LED type %d\n", led_type); >> + return -EINVAL; >> + } >> + >> + return 0; >> + >> +led_reg_failed: >> + dev_err(dev, "Could not register mute LED %d : %d\n", led_type, err); >> + return err; >> +} >> + >> +static int lenovo_super_hotkey_wmi_leds_setup(struct device *dev) >> +{ >> + int err; >> + >> + err = lenovo_super_hotkey_wmi_led_init(MIC_MUTE, dev); >> + if (err) >> + return err; >> + >> + err = lenovo_super_hotkey_wmi_led_init(AUDIO_MUTE, dev); >> + if (err) >> + return err; >> + >> + return 0; >> +} >> + >> +static int lenovo_super_hotkey_wmi_probe(struct wmi_device *wdev, const void *context) >> +{ >> + struct lenovo_super_hotkey_wmi_private *wpriv; >> + int err; >> + >> + wpriv = devm_kzalloc(&wdev->dev, sizeof(*wpriv), GFP_KERNEL); >> + if (!wpriv) >> + return -ENOMEM; >> + >> + dev_set_drvdata(&wdev->dev, wpriv); >> + wpriv->led_wdev = wdev; >> + err = lenovo_super_hotkey_wmi_leds_setup(&wdev->dev); > > return lenovo_super_hotkey_wmi_leds_setup(&wdev->dev); > > Other than that this looks good to me :) > Yes, it's better than my code. Thanks Kurt for your review the patch again and again and give helpful comments. I'll send v7 patch later. Jackie Dong