Re: [PATCH v4 3/6 RESEND] platform/x86: Add Lenovo WMI Events Driver

[Derek John Clark]

On Wed, Mar 26, 2025 at 6:04 PM Armin Wolf <W_Armin@xxxxxx> wrote:
>
> Am 17.03.25 um 15:43 schrieb Derek J. Clark:
>
> > Adds lenovo-wmi-events driver. The events driver is designed as a
> > general entrypoint for all Lenovo WMI Events. It acts as a notification
> > chain head that will process event data and pass it on to registered
> > drivers so they can react to the events.
> >
> > Currently only the Gamezone interface Thermal Mode Event GUID is
> > implemented in this driver. It is documented in the Gamezone
> > documentation.
> >
> > Suggested-by: Armin Wolf <W_Armin@xxxxxx>
> > Signed-off-by: Derek J. Clark <derekjohn.clark@xxxxxxxxx>
> > ---
> > v4:
> >   - Remove the Thermal Mode Event GUID from Gamezone and add this driver.
> > ---
> >   MAINTAINERS                              |   2 +
> >   drivers/platform/x86/Kconfig             |   4 +
> >   drivers/platform/x86/Makefile            |   1 +
> >   drivers/platform/x86/lenovo-wmi-events.c | 132 +++++++++++++++++++++++
> >   drivers/platform/x86/lenovo-wmi-events.h |  21 ++++
> >   5 files changed, 160 insertions(+)
> >   create mode 100644 drivers/platform/x86/lenovo-wmi-events.c
> >   create mode 100644 drivers/platform/x86/lenovo-wmi-events.h
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 3a370a18b806..6dde75922aaf 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -13164,6 +13164,8 @@ L:    platform-driver-x86@xxxxxxxxxxxxxxx
> >   S:  Maintained
> >   F:  Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> >   F:  Documentation/wmi/devices/lenovo-wmi-other.rst
> > +F:   drivers/platform/x86/lenovo-wmi-events.c
> > +F:   drivers/platform/x86/lenovo-wmi-events.h
> >   F:  drivers/platform/x86/lenovo-wmi-helpers.c
> >   F:  drivers/platform/x86/lenovo-wmi-helpers.h
> >
> > diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> > index bece1ba61417..13b8f4ac5dc5 100644
> > --- a/drivers/platform/x86/Kconfig
> > +++ b/drivers/platform/x86/Kconfig
> > @@ -459,6 +459,10 @@ config IBM_RTL
> >        state = 0 (BIOS SMIs on)
> >        state = 1 (BIOS SMIs off)
> >
> > +config LENOVO_WMI_EVENTS
> > +     tristate
> > +     depends on ACPI_WMI
> > +
> >   config LENOVO_WMI_HELPERS
> >       tristate
> >       depends on ACPI_WMI
> > diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
> > index 5a9f4e94f78b..fc039839286a 100644
> > --- a/drivers/platform/x86/Makefile
> > +++ b/drivers/platform/x86/Makefile
> > @@ -69,6 +69,7 @@ obj-$(CONFIG_THINKPAD_LMI)  += think-lmi.o
> >   obj-$(CONFIG_YOGABOOK)              += lenovo-yogabook.o
> >   obj-$(CONFIG_YT2_1380)              += lenovo-yoga-tab2-pro-1380-fastcharger.o
> >   obj-$(CONFIG_LENOVO_WMI_CAMERA)     += lenovo-wmi-camera.o
> > +obj-$(CONFIG_LENOVO_WMI_EVENTS)      += lenovo-wmi-events.o
> >   obj-$(CONFIG_LENOVO_WMI_HELPERS)    += lenovo-wmi-helpers.o
> >
> >   # Intel
> > diff --git a/drivers/platform/x86/lenovo-wmi-events.c b/drivers/platform/x86/lenovo-wmi-events.c
> > new file mode 100644
> > index 000000000000..3ea0face3c0d
> > --- /dev/null
> > +++ b/drivers/platform/x86/lenovo-wmi-events.c
> > @@ -0,0 +1,132 @@
> > +// SPDX-License-Identifier: GPL-2.0-or-later
> > +/*
> > + * Lenovo WMI Events driver. Lenovo WMI interfaces provide various
> > + * hardware triggered events that many drivers need to have propagated.
> > + * This driver provides a uniform entrypoint for these events so that
> > + * any driver that needs to respond to these events can subscribe to a
> > + * notifier chain.
> > + *
> > + * Copyright(C) 2025 Derek J. Clark <derekjohn.clark@xxxxxxxxx>
> > + */
> > +
> > +#include <linux/list.h>
> > +#include <linux/notifier.h>
> > +#include <linux/types.h>
> > +#include <linux/wmi.h>
> > +#include "lenovo-wmi-events.h"
>
> Hi,
>
> please also include linux/acpi.h, linux/export.h and linux/module.h. Also why do you import
> linux/list.h?
>
> > +
> > +/* Interface GUIDs */
> > +#define THERMAL_MODE_EVENT_GUID "D320289E-8FEA-41E0-86F9-911D83151B5F"
> > +
> > +#define LENOVO_WMI_EVENT_DEVICE(guid, type)                        \
> > +     .guid_string = (guid), .context = &(enum lwmi_events_type) \
> > +     {                                                          \
> > +             type                                               \
> > +     }
> > +
> > +static BLOCKING_NOTIFIER_HEAD(events_chain_head);
> > +
> > +struct lwmi_events_priv {
> > +     struct wmi_device *wdev;
> > +     enum lwmi_events_type type;
> > +};
> > +
> > +/* Notifier Methods */
> > +int lwmi_events_register_notifier(struct notifier_block *nb)
> > +{
> > +     return blocking_notifier_chain_register(&events_chain_head, nb);
> > +}
> > +EXPORT_SYMBOL_NS_GPL(lwmi_events_register_notifier, "LENOVO_WMI_EVENTS");
> > +
> > +int lwmi_events_unregister_notifier(struct notifier_block *nb)
> > +{
> > +     return blocking_notifier_chain_unregister(&events_chain_head, nb);
> > +}
> > +EXPORT_SYMBOL_NS_GPL(lwmi_events_unregister_notifier, "LENOVO_WMI_EVENTS");
> > +
> > +static void devm_lwmi_events_unregister_notifier(void *data)
> > +{
> > +     struct notifier_block *nb = data;
> > +
> > +     lwmi_events_unregister_notifier(nb);
> > +}
> > +
> > +int devm_lwmi_events_register_notifier(struct device *dev,
> > +                                    struct notifier_block *nb)
> > +{
> > +     int ret;
> > +
> > +     ret = lwmi_events_register_notifier(nb);
> > +     if (ret < 0)
> > +             return ret;
> > +
> > +     return devm_add_action_or_reset(dev,
> > +                             devm_lwmi_events_unregister_notifier, nb);
>
> Please remove this line break here.
>
> > +}
> > +EXPORT_SYMBOL_NS_GPL(devm_lwmi_events_register_notifier, "LENOVO_WMI_EVENTS");
> > +
> > +/* Driver Methods */
> > +static void lwmi_events_notify(struct wmi_device *wdev, union acpi_object *obj)
> > +{
> > +     struct lwmi_events_priv *priv = dev_get_drvdata(&wdev->dev);
> > +     int sel_prof;
> > +     int ret;
> > +
> > +     switch (priv->type) {
> > +     case THERMAL_MODE_EVENT:
> > +             if (obj->type != ACPI_TYPE_INTEGER)
> > +                     return;
> > +
> > +             sel_prof = obj->integer.value;
> > +             ret = blocking_notifier_call_chain(&events_chain_head,
> > +                                                THERMAL_MODE_EVENT, &sel_prof);
> > +             if (ret == NOTIFY_BAD)
> > +                     dev_err(&wdev->dev,
> > +                             "Failed to send notification to call chain for WMI Events\n");
> > +             break;
> > +     default:
> > +             return;
> > +     }
> > +}
> > +
> > +static int lwmi_events_probe(struct wmi_device *wdev, const void *context)
> > +{
> > +     struct lwmi_events_priv *priv;
> > +
> > +     priv = devm_kzalloc(&wdev->dev, sizeof(*priv), GFP_KERNEL);
> > +     if (!priv)
> > +             return -ENOMEM;
> > +
> > +     if (!context)
> > +             return -EINVAL;
> > +
> > +     priv->wdev = wdev;
> > +     priv->type = *(enum lwmi_events_type *)context;
> > +
> > +     dev_set_drvdata(&wdev->dev, priv);
> > +     return 0;
> > +}
> > +
> > +static const struct wmi_device_id lwmi_events_id_table[] = {
> > +     { LENOVO_WMI_EVENT_DEVICE(THERMAL_MODE_EVENT_GUID,
> > +                               THERMAL_MODE_EVENT) },
> > +     {}
> > +};
> > +
> > +static struct wmi_driver lwmi_events_driver = {
> > +     .driver = {
> > +             .name = "lenovo_wmi_events",
> > +             .probe_type = PROBE_PREFER_ASYNCHRONOUS,
> > +     },
> > +     .id_table = lwmi_events_id_table,
> > +     .probe = lwmi_events_probe,
> > +     .notify = lwmi_events_notify,
> > +     .no_singleton = true,
> > +};
> > +
> > +module_wmi_driver(lwmi_events_driver);
> > +
> > +MODULE_DEVICE_TABLE(wmi, lwmi_events_id_table);
> > +MODULE_AUTHOR("Derek J. Clark <derekjohn.clark@xxxxxxxxx>");
> > +MODULE_DESCRIPTION("Lenovo WMI Events Driver");
> > +MODULE_LICENSE("GPL");
> > diff --git a/drivers/platform/x86/lenovo-wmi-events.h b/drivers/platform/x86/lenovo-wmi-events.h
> > new file mode 100644
> > index 000000000000..a3fa934eaa10
> > --- /dev/null
> > +++ b/drivers/platform/x86/lenovo-wmi-events.h
> > @@ -0,0 +1,21 @@
> > +/* SPDX-License-Identifier: GPL-2.0-or-later
>
> The SPDX license identifier needs to be a separate comment.
>
> With those minor issues being fixed:
> Reviewed-by: Armin Wolf <W_Armin@xxxxxx>
>

Will fix, thanks,
Derek

> > + *
> > + * Copyright(C) 2025 Derek J. Clark <derekjohn.clark@xxxxxxxxx>
> > + */
> > +
> > +#include <linux/notifier.h>
> > +#include <linux/types.h>
> > +
> > +#ifndef _LENOVO_WMI_EVENTS_H_
> > +#define _LENOVO_WMI_EVENTS_H_
> > +
> > +enum lwmi_events_type {
> > +     THERMAL_MODE_EVENT = 1,
> > +};
> > +
> > +int lwmi_events_register_notifier(struct notifier_block *nb);
> > +int lwmi_events_unregister_notifier(struct notifier_block *nb);
> > +int devm_lwmi_events_register_notifier(struct device *dev,
> > +                                    struct notifier_block *nb);
> > +
> > +#endif /* !_LENOVO_WMI_EVENTS_H_ */