* Re: [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface
2026-11-16 4:05 [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface Alan Pluto
@ 2026-11-16 12:43 ` Ilpo Järvinen
2026-11-16 12:44 ` Rong Zhang
2026-11-16 16:56 ` Mark Pearson
2 siblings, 0 replies; 4+ messages in thread
From: Ilpo Järvinen @ 2026-11-16 12:43 UTC (permalink / raw)
To: Alan Pluto
Cc: platform-driver-x86, Mark Pearson, derekjohn.clark, i, W_Armin,
Hans de Goede, corbet, skhan, rdunlap, LKML, linux-doc, linux-api
On Mon, 16 Nov 2026, Alan Pluto wrote:
> Expose Lenovo Other Mode WMI GetDataByPackage, method 99, through a
> root-only character device so userspace can access the raw firmware
> interface. And document the interface.
>
> The upstream driver was build-tested with W=1 and checked with Sparse.
> A backport using the five-argument wmidev_invoke_method() interface
> was tested on Ubuntu 7.0.0-42 with Lenovo hardware. The upstream 7.4
> driver has not been tested on hardware.
>
> Signed-off-by: Alan Pluto <alanpluto@163.com>
> ---
> Documentation/ABI/testing/dev-tac | 49 +++
> .../wmi/devices/lenovo-wmi-other.rst | 8 +
> MAINTAINERS | 1 +
> drivers/platform/x86/lenovo/wmi-other.c | 325 ++++++++++++++++++
> 4 files changed, 383 insertions(+)
> create mode 100644 Documentation/ABI/testing/dev-tac
>
> diff --git a/Documentation/ABI/testing/dev-tac b/Documentation/ABI/testing/dev-tac
> new file mode 100644
> index 00000000000..a8be8e95e2d
> --- /dev/null
> +++ b/Documentation/ABI/testing/dev-tac
> @@ -0,0 +1,49 @@
> +What: /dev/tac[0-9]*
> +Date: November 2026
> +Contact: platform-driver-x86@vger.kernel.org
> +Description:
> + Lenovo Other Mode WMI GetDataByPackage (method 99).
> + Each firmware WMI instance gets a misc character device with
> + mode 0600. Numbering follows allocation order, not necessarily
> + the firmware instance number. Registration does not probe
> + support for method 99. The parent is the bound WMI device.
> +
> + Open with O_RDWR. One write submits one complete request of
> + 1..100 raw bytes; shorter requests are padded with zeroes to
> + 100 bytes. Empty and oversized writes fail with EINVAL without
> + calling firmware. Successful writes return the full submitted
> + length and execute two identical WMI calls for the BIOS
> + duplicate-call workaround. Request pairs through this
> + interface are serialized; calls made by other driver
> + interfaces are not covered by this serialization.
> + Evaluation failures abort the pair; the driver does not
> + automatically retry.
> +
> + Each open file description owns its response. A write while
> + that response remains unread fails with EBUSY, including after
> + partial reads. A new open cannot read another open's response.
> + Descriptors shared by dup/fork share the same transaction;
> + applications must coordinate the complete write/read sequence.
> +
> + Read returns little-endian u32 DataSize followed by exactly
> + DataSize data bytes. Response storage is erased when fully
> + read or closed. Further reads return EOF until a new successful
> + write. Before a successful write, or after a failed firmware
> + evaluation, reads return ENODATA. A zero-length read returns
> + zero without consuming data.
> +
> + Requests are synchronous even with O_NONBLOCK. Seeking and
> + positional I/O are not supported. There is no ioctl interface.
> + A removed WMI device causes nonempty reads and valid writes
> + on existing descriptors to fail with ENODEV.
> +
> + Firmware evaluation failures map to EIO. WMI marshalling
> + failures return the error reported by the WMI subsystem.
> + A truncated response or invalid DataSize maps to EPROTO.
> + Bad userspace memory maps to EFAULT. Failure does not imply
> + firmware had no side effects; never blindly resubmit commands.
> + Interrupted waits can return EINTR before firmware evaluation.
> +
> + The WMI subsystem converts returned ACPI objects to a buffer.
> + This raw firmware interface may change device state. Use only
> + commands whose behavior and side effects are understood.
> diff --git a/Documentation/wmi/devices/lenovo-wmi-other.rst b/Documentation/wmi/devices/lenovo-wmi-other.rst
> index 011054d64ea..ec85fdeeb7a 100644
> --- a/Documentation/wmi/devices/lenovo-wmi-other.rst
> +++ b/Documentation/wmi/devices/lenovo-wmi-other.rst
> @@ -33,6 +33,10 @@ under the following path:
>
> Additionally, this driver also exports attributes to HWMON.
>
> +The driver also exposes GetDataByPackage (method 99) through a raw character
> +device for each WMI instance. See Documentation/ABI/testing/dev-tac for the
> +request and response format and its access restrictions.
> +
> LENOVO_CAPABILITY_DATA_00
> -------------------------
>
> @@ -109,6 +113,10 @@ WMI interface description
> The WMI interface description can be decoded from the embedded binary MOF (bmof)
> data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
>
> +The example below describes an older firmware revision and specifies a
> +40-byte maximum input for GetDataByPackage. Newer firmware uses a 100-byte
> +input, which is the size used by the raw interface described above.
> +
> ::
>
> [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("LENOVO_OTHER_METHOD class"), guid("{dc2a8805-3a8c-41ba-a6f7-092e0089cd3b}")]
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 981eb3fdbef..84b1545f525 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -15168,6 +15168,7 @@ M: Derek J. Clark <derekjohn.clark@gmail.com>
> M: Rong Zhang <i@rong.moe>
> L: platform-driver-x86@vger.kernel.org
> S: Maintained
> +F: Documentation/ABI/testing/dev-tac
> F: Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> F: Documentation/wmi/devices/lenovo-wmi-other.rst
> F: drivers/platform/x86/lenovo/*
> diff --git a/drivers/platform/x86/lenovo/wmi-other.c b/drivers/platform/x86/lenovo/wmi-other.c
> index bd64e7b4466..c15b3a2a758 100644
> --- a/drivers/platform/x86/lenovo/wmi-other.c
> +++ b/drivers/platform/x86/lenovo/wmi-other.c
> @@ -34,16 +34,23 @@
> #include <linux/device.h>
> #include <linux/export.h>
> #include <linux/firmware_attributes.h>
> +#include <linux/fs.h>
> #include <linux/gfp_types.h>
> #include <linux/hwmon.h>
> #include <linux/idr.h>
> #include <linux/kdev_t.h>
> #include <linux/kobject.h>
> +#include <linux/kref.h>
> #include <linux/limits.h>
> +#include <linux/miscdevice.h>
> #include <linux/module.h>
> +#include <linux/mutex.h>
> #include <linux/platform_profile.h>
> #include <linux/power_supply.h>
> +#include <linux/slab.h>
> #include <linux/types.h>
> +#include <linux/uaccess.h>
> +#include <linux/unaligned.h>
> #include <linux/wmi.h>
>
> #include <acpi/battery.h>
> @@ -91,6 +98,9 @@ enum lwmi_feature_id_psu {
> #define LWMI_FEATURE_VALUE_GET 17
> #define LWMI_FEATURE_VALUE_SET 18
>
> +#define LWMI_DATA_PACKAGE_GET 99
> +#define LWMI_DATA_PACKAGE_INPUT_MAX 100
> +
> #define LWMI_FAN_ID_BASE 1
> #define LWMI_FAN_NR 4
> #define LWMI_FAN_ID(x) ((x) + LWMI_FAN_ID_BASE)
> @@ -115,6 +125,27 @@ enum lwmi_feature_id_psu {
>
> static DEFINE_IDA(lwmi_om_ida);
>
> +static DEFINE_IDA(lwmi_tac_ida);
> +static DEFINE_MUTEX(lwmi_tac_lock);
Please document what it protects.
> +
> +struct lwmi_tac {
> + struct miscdevice misc;
> + struct kref ref;
> + struct wmi_device *wdev;
> + u8 instance;
> + int id;
> +};
> +
> +struct lwmi_tac_file {
> + struct lwmi_tac *tac;
> + /* Protects the per-open response and its position. */
> + struct mutex lock;
> + void *result;
> + size_t result_len;
> + loff_t position;
> + bool completed;
> +};
> +
> enum attribute_property {
> DEFAULT_VAL,
> MAX_VAL,
> @@ -1609,6 +1640,295 @@ static void lwmi_om_fw_attr_remove(struct lwmi_om_priv *priv)
> priv->ida_id = -EIDRM;
> }
>
> +/**
> + * lwmi_tac_free() - Free an unregistered endpoint after its last close
> + * @ref: Reference belonging to the endpoint.
> + */
> +static void lwmi_tac_free(struct kref *ref)
> +{
> + struct lwmi_tac *tac = container_of(ref, struct lwmi_tac, ref);
> +
> + ida_free(&lwmi_tac_ida, tac->id);
> + kfree(tac->misc.name);
> + kfree(tac);
> +}
> +
> +/**
> + * lwmi_tac_open() - Allocate independent response state for an open file
> + * @inode: Character device inode.
> + * @file: File initially pointing to the registered miscdevice.
> + *
> + * The misc core serializes open against deregistration, so the registration
> + * reference remains valid while the file acquires its own reference.
> + *
> + * Return: 0 on success, or -ENOMEM.
> + */
> +static int lwmi_tac_open(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac *tac = container_of(file->private_data, struct lwmi_tac, misc);
> + struct lwmi_tac_file *state;
> +
> + state = kzalloc_obj(*state);
> + if (!state)
> + return -ENOMEM;
> + mutex_init(&state->lock);
> + state->tac = tac;
> + kref_get(&tac->ref);
> + file->private_data = state;
> + return stream_open(inode, file);
> +}
> +
> +/**
> + * lwmi_tac_release() - Erase the response and drop the endpoint reference
> + * @inode: Character device inode.
> + * @file: File holding the endpoint state.
> + *
> + * Return: 0.
> + */
> +static int lwmi_tac_release(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> +
> + kfree_sensitive(state->result);
> + mutex_destroy(&state->lock);
> + kref_put(&state->tac->ref, lwmi_tac_free);
> + kfree(state);
> + return 0;
> +}
> +
> +/**
> + * lwmi_tac_invoke() - Execute GetDataByPackage and retain the response
> + * @state: Open file whose response buffer is empty.
> + * @data: Zero-padded 100-byte input buffer.
> + *
> + * The caller holds state->lock and lwmi_tac_lock. The latter serializes call
Please lockdep assert any locks that are expected to be held.
> + * pairs across instances and keeps the WMI device valid during evaluation.
> + *
> + * Return: 0 on success, or a negative error code.
> + */
> +static int lwmi_tac_invoke(struct lwmi_tac_file *state, u8 *data)
> +{
> + struct lwmi_tac *tac = state->tac;
> + struct wmi_buffer input = { .length = LWMI_DATA_PACKAGE_INPUT_MAX, .data = data };
> + struct wmi_buffer output;
> + u32 data_size;
> + int ret;
> +
> + if (!tac->wdev)
> + return -ENODEV;
> + /*
> + * Duplicated call required to match BIOS workaround for behavior
> + * seen when WMI accessed via scripting on other OS.
> + */
> + for (unsigned int call = 0; call < 2; call++) {
> + ret = wmidev_invoke_method(tac->wdev, tac->instance,
> + LWMI_DATA_PACKAGE_GET, &input, &output, 0);
> + if (ret)
> + return ret;
> + if (!call)
> + kfree_sensitive(output.data);
Why are you using _sensitive() variant extensively?
> + }
> + /* Validate DataSize before preserving the complete firmware response. */
> + if (output.length < sizeof(__le32)) {
> + ret = -EPROTO;
> + goto free_output;
> + }
> + data_size = get_unaligned_le32(output.data);
> + if (data_size > output.length - sizeof(__le32)) {
> + ret = -EPROTO;
> + goto free_output;
> + }
Can't the new WMI interface do size checks for you?
> + /* Transfer ownership without another allocation after firmware ran. */
> + state->result = output.data;
> + state->result_len = sizeof(__le32) + data_size;
> + state->position = 0;
> + state->completed = true;
> + return 0;
> +free_output:
> + kfree_sensitive(output.data);
Please use __free() & no_free_ptr() instead.
I suggest assign to a newly declared (mid-function) variable after the
loop as is recommended with __free() (see the long comment in cleanup.h
for details).
> + return ret;
> +}
> +
> +/**
> + * lwmi_tac_write() - Submit one complete TAC request
> + * @file: Open TAC endpoint with independent response state.
> + * @buffer: Userspace input bytes.
> + * @count: Input size, from 1 to 100 bytes.
> + * @ppos: Unused; TAC is a nonseekable request/response stream.
> + *
> + * Short inputs are zero-padded. An unread response must be consumed before
> + * submitting another request. A failed firmware call is never retried here.
> + *
> + * Return: @count on success, or a negative error code.
> + */
> +static ssize_t lwmi_tac_write(struct file *file, const char __user *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + u8 input[LWMI_DATA_PACKAGE_INPUT_MAX] = {};
> + int ret;
> +
> + if (!count || count > sizeof(input))
> + return -EINVAL;
> + if (copy_from_user(input, buffer, count)) {
> + ret = -EFAULT;
> + goto clear_input;
> + }
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + goto clear_input;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
Please use ACQUIRE/ACQUIRE_ERR() for these, then you can return directly
below as unlocks will be done automatically for you. It will simplify the
code flow a ton here.
> + goto unlock;
> + if (!state->tac->wdev) {
> + ret = -ENODEV;
> + } else if (state->result) {
> + ret = -EBUSY;
> + } else {
> + state->completed = false;
> + ret = lwmi_tac_invoke(state, input);
> + }
> + mutex_unlock(&lwmi_tac_lock);
> +unlock:
> + mutex_unlock(&state->lock);
> +clear_input:
> + memzero_explicit(input, sizeof(input));
?
You really need to have a justification for these in the changelog if you
want to go there.
> + if (ret)
> + return ret;
> + return count;
> +}
> +
> +/**
> + * lwmi_tac_read() - Read only this open file's firmware response
> + * @file: Open TAC endpoint.
> + * @buffer: Userspace destination.
> + * @count: Maximum number of bytes to return.
> + * @ppos: Unused; the response position is protected by state->lock.
> + *
> + * Responses contain little-endian u32 DataSize followed by Data. Partial
> + * reads advance the response position. Consuming the result erases its
> + * storage immediately; subsequent reads return EOF until another write.
> + *
> + * Return: Bytes read, 0 at EOF or for zero @count, or a negative error code.
> + */
> +static ssize_t lwmi_tac_read(struct file *file, char __user *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + ssize_t ret;
> +
> + if (!count)
> + return 0;
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + return ret;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
> + goto unlock;
> + if (!state->tac->wdev)
> + ret = -ENODEV;
> + mutex_unlock(&lwmi_tac_lock);
> + if (ret) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + goto unlock;
> + }
> + if (!state->completed) {
> + ret = -ENODATA;
> + goto unlock;
> + }
> + if (!state->result)
> + goto unlock;
> + ret = simple_read_from_buffer(buffer, count, &state->position,
> + state->result, state->result_len);
> + if (state->position == (loff_t)state->result_len) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + }
> +unlock:
> + mutex_unlock(&state->lock);
> + return ret;
> +}
Same comments as above.
> +
> +static const struct file_operations lwmi_tac_fops = {
> + .owner = THIS_MODULE,
> + .open = lwmi_tac_open,
> + .release = lwmi_tac_release,
> + .read = lwmi_tac_read,
> + .write = lwmi_tac_write,
> +};
> +
> +/**
> + * lwmi_tac_remove() - Unregister an endpoint and block further firmware calls
> + * @data: Endpoint registered as a device-managed cleanup action.
> + *
> + * Stop new opens before waiting for an in-flight call pair. Existing files
> + * retain the endpoint state, but their subsequent reads/writes return -ENODEV.
> + */
> +static void lwmi_tac_remove(void *data)
> +{
> + struct lwmi_tac *tac = data;
> +
> + misc_deregister(&tac->misc);
> + mutex_lock(&lwmi_tac_lock);
> + tac->wdev = NULL;
> + mutex_unlock(&lwmi_tac_lock);
> + kref_put(&tac->ref, lwmi_tac_free);
> +}
> +
> +/**
> + * lwmi_tac_add() - Register TAC endpoints independently of capability data
> + * @wdev: Bound Lenovo Other Mode WMI device.
> + *
> + * No capability describes method 99, so registration does not probe firmware
> + * support. Each firmware instance gets an endpoint; unsupported method calls
> + * are reported to userspace when requested.
> + *
> + * Return: 0 on success, or a negative error code. Device-managed cleanup
> + * unregisters earlier endpoints if a later registration or probe step fails.
> + */
> +static int lwmi_tac_add(struct wmi_device *wdev)
> +{
> + unsigned int instances = wmidev_instance_count(wdev);
> + int ret;
> +
> + for (unsigned int instance = 0; instance < instances; instance++) {
> + struct lwmi_tac *tac;
> +
> + tac = kzalloc_obj(*tac);
> + if (!tac)
> + return -ENOMEM;
> + ret = ida_alloc(&lwmi_tac_ida, GFP_KERNEL);
> + if (ret < 0) {
> + kfree(tac);
> + return ret;
> + }
> + tac->id = ret;
> + kref_init(&tac->ref);
> + tac->wdev = wdev;
> + tac->instance = instance;
> + tac->misc.minor = MISC_DYNAMIC_MINOR;
> + tac->misc.name = kasprintf(GFP_KERNEL, "tac%d", tac->id);
> + tac->misc.fops = &lwmi_tac_fops;
> + tac->misc.parent = &wdev->dev;
> + tac->misc.mode = 0600;
> + if (!tac->misc.name) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return -ENOMEM;
> + }
> + ret = misc_register(&tac->misc);
> + if (ret) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return ret;
Please add a rollback path to not duplicate.
> + }
> + /* Unregister before the WMI device and its managed state disappear. */
> + ret = devm_add_action_or_reset(&wdev->dev, lwmi_tac_remove, tac);
> + if (ret)
> + return ret;
> + }
> + return 0;
> +}
> +
> /* ======== Self (master: lenovo-wmi-other) ======== */
>
> /**
> @@ -1693,6 +2013,7 @@ static int lwmi_other_probe(struct wmi_device *wdev, const void *context)
> {
> struct component_match *master_match = NULL;
> struct lwmi_om_priv *priv;
> + int ret;
>
> priv = devm_kzalloc_obj(&wdev->dev, *priv);
> if (!priv)
> @@ -1708,6 +2029,10 @@ static int lwmi_other_probe(struct wmi_device *wdev, const void *context)
> if (IS_ERR(master_match))
> return PTR_ERR(master_match);
>
> + ret = lwmi_tac_add(wdev);
> + if (ret)
> + return ret;
> +
> return component_master_add_with_match(&wdev->dev, &lwmi_om_master_ops,
> master_match);
> }
>
> base-commit: 5680519168f65666d2c03cc6ed8fe2b7052aee12
>
--
i.
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface
2026-11-16 4:05 [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface Alan Pluto
2026-11-16 12:43 ` Ilpo Järvinen
@ 2026-11-16 12:44 ` Rong Zhang
2026-11-16 16:56 ` Mark Pearson
2 siblings, 0 replies; 4+ messages in thread
From: Rong Zhang @ 2026-11-16 12:44 UTC (permalink / raw)
To: Alan Pluto, platform-driver-x86
Cc: mpearson-lenovo, derekjohn.clark, W_Armin, hansg, ilpo.jarvinen,
corbet, skhan, rdunlap, linux-kernel, linux-doc, linux-api
Hi Alan,
Thanks for working on this.
On Mon, 2026-11-16 at 12:05 +0800, Alan Pluto wrote:
> Expose Lenovo Other Mode WMI GetDataByPackage, method 99, through a
> root-only character device so userspace can access the raw firmware
> interface. And document the interface.
What's the practical purpose of the interface? Did you use this to tune
anything on your device?
>
> The upstream driver was build-tested with W=1 and checked with Sparse.
> A backport using the five-argument wmidev_invoke_method() interface
> was tested on Ubuntu 7.0.0-42 with Lenovo hardware. The upstream 7.4
> driver has not been tested on hardware.
Don't include this in the commit message, but rather send a cover letter
or place it under `---'.
>
> Signed-off-by: Alan Pluto <alanpluto@163.com>
Is the work assisted by LLM?
> ---
> Documentation/ABI/testing/dev-tac | 49 +++
> .../wmi/devices/lenovo-wmi-other.rst | 8 +
> MAINTAINERS | 1 +
> drivers/platform/x86/lenovo/wmi-other.c | 325 ++++++++++++++++++
> 4 files changed, 383 insertions(+)
> create mode 100644 Documentation/ABI/testing/dev-tac
>
> diff --git a/Documentation/ABI/testing/dev-tac b/Documentation/ABI/testing/dev-tac
> new file mode 100644
> index 00000000000..a8be8e95e2d
> --- /dev/null
> +++ b/Documentation/ABI/testing/dev-tac
> @@ -0,0 +1,49 @@
> +What: /dev/tac[0-9]*
> +Date: November 2026
> +Contact: platform-driver-x86@vger.kernel.org
> +Description:
> + Lenovo Other Mode WMI GetDataByPackage (method 99).
> + Each firmware WMI instance gets a misc character device with
> + mode 0600.
>
Why would you need to add a character device instead of a debugfs file?
See also lwmi_debugfs_create_dir().
IMHO the interface is quite internal and undocumented. Exposing it as a
character device makes it too reachable for users, unnecessarily
increases the complexity of the driver, and requires some sorts of ABI
stability.
> Numbering follows allocation order, not necessarily
> + the firmware instance number.
>
You must be using a wordy LLM if you are using one. Isn't this just
obvious and natural for most character devices?
> Registration does not probe
> + support for method 99. The parent is the bound WMI device.
If it can't be probed, gate it unless a module parameter is set.
> +
> + Open with O_RDWR. One write submits one complete request of
> + 1..100 raw bytes; shorter requests are padded with zeroes to
> + 100 bytes. Empty and oversized writes fail with EINVAL without
sed -E 's/\bE[A-Z]+\b/-\0/g'
> + calling firmware. Successful writes return the full submitted
> + length and execute two identical WMI calls for the BIOS
> + duplicate-call workaround.
>
> Request pairs through this
> + interface are serialized; calls made by other driver
> + interfaces are not covered by this serialization.
Why would you need to mention cross-interface implementation details in a
user-facing documentation?
> + Evaluation failures abort the pair; the driver does not
> + automatically retry.
> +
> + Each open file description owns its response.
>
Why would you need to support multiple writers? Couldn't you simply
return -EBUSY when there is a pending writer/reader?
> A write while
> + that response remains unread fails with EBUSY, including after
> + partial reads.
>
If userspace must write all data at once, why would you need to support
partial reads?
> A new open cannot read another open's response.
> + Descriptors shared by dup/fork share the same transaction;
> + applications must coordinate the complete write/read sequence.
Aren't these just obvious and natural for most character devices, too?
> +
> + Read returns little-endian u32 DataSize followed by exactly
> + DataSize data bytes. Response storage is erased when fully
> + read or closed. Further reads return EOF until a new successful
> + write. Before a successful write, or after a failed firmware
> + evaluation, reads return ENODATA. A zero-length read returns
> + zero without consuming data.
> +
> + Requests are synchronous even with O_NONBLOCK. Seeking and
> + positional I/O are not supported.
>
Aren't these just the default characteristic for most non-block character
devices?
> There is no ioctl interface.
Too verbose. If you don't say it has some, it's obvious that it has none.
> + A removed WMI device causes nonempty reads and valid writes
> + on existing descriptors to fail with ENODEV.
> +
> + Firmware evaluation failures map to EIO. WMI marshalling
> + failures return the error reported by the WMI subsystem.
> + A truncated response or invalid DataSize maps to EPROTO.
> + Bad userspace memory maps to EFAULT. Failure does not imply
> + firmware had no side effects; never blindly resubmit commands.
> + Interrupted waits can return EINTR before firmware evaluation.
Obvious, no?
> +
> + The WMI subsystem converts returned ACPI objects to a buffer.
Yet another implementation detail.
> + This raw firmware interface may change device state. Use only
> + commands whose behavior and side effects are understood.
> diff --git a/Documentation/wmi/devices/lenovo-wmi-other.rst b/Documentation/wmi/devices/lenovo-wmi-other.rst
> index 011054d64ea..ec85fdeeb7a 100644
> --- a/Documentation/wmi/devices/lenovo-wmi-other.rst
> +++ b/Documentation/wmi/devices/lenovo-wmi-other.rst
> @@ -33,6 +33,10 @@ under the following path:
>
> Additionally, this driver also exports attributes to HWMON.
>
> +The driver also exposes GetDataByPackage (method 99) through a raw character
> +device for each WMI instance. See Documentation/ABI/testing/dev-tac for the
> +request and response format and its access restrictions.
> +
> LENOVO_CAPABILITY_DATA_00
> -------------------------
>
> @@ -109,6 +113,10 @@ WMI interface description
> The WMI interface description can be decoded from the embedded binary MOF (bmof)
> data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
>
> +The example below describes an older firmware revision and specifies a
> +40-byte maximum input for GetDataByPackage. Newer firmware uses a 100-byte
> +input, which is the size used by the raw interface described above.
> +
> ::
>
> [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("LENOVO_OTHER_METHOD class"), guid("{dc2a8805-3a8c-41ba-a6f7-092e0089cd3b}")]
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 981eb3fdbef..84b1545f525 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -15168,6 +15168,7 @@ M: Derek J. Clark <derekjohn.clark@gmail.com>
> M: Rong Zhang <i@rong.moe>
> L: platform-driver-x86@vger.kernel.org
> S: Maintained
> +F: Documentation/ABI/testing/dev-tac
> F: Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> F: Documentation/wmi/devices/lenovo-wmi-other.rst
> F: drivers/platform/x86/lenovo/*
> diff --git a/drivers/platform/x86/lenovo/wmi-other.c b/drivers/platform/x86/lenovo/wmi-other.c
> index bd64e7b4466..c15b3a2a758 100644
> --- a/drivers/platform/x86/lenovo/wmi-other.c
> +++ b/drivers/platform/x86/lenovo/wmi-other.c
> @@ -34,16 +34,23 @@
> #include <linux/device.h>
> #include <linux/export.h>
> #include <linux/firmware_attributes.h>
> +#include <linux/fs.h>
> #include <linux/gfp_types.h>
> #include <linux/hwmon.h>
> #include <linux/idr.h>
> #include <linux/kdev_t.h>
> #include <linux/kobject.h>
> +#include <linux/kref.h>
> #include <linux/limits.h>
> +#include <linux/miscdevice.h>
> #include <linux/module.h>
> +#include <linux/mutex.h>
> #include <linux/platform_profile.h>
> #include <linux/power_supply.h>
> +#include <linux/slab.h>
> #include <linux/types.h>
> +#include <linux/uaccess.h>
> +#include <linux/unaligned.h>
> #include <linux/wmi.h>
>
> #include <acpi/battery.h>
> @@ -91,6 +98,9 @@ enum lwmi_feature_id_psu {
> #define LWMI_FEATURE_VALUE_GET 17
> #define LWMI_FEATURE_VALUE_SET 18
>
> +#define LWMI_DATA_PACKAGE_GET 99
> +#define LWMI_DATA_PACKAGE_INPUT_MAX 100
> +
> #define LWMI_FAN_ID_BASE 1
> #define LWMI_FAN_NR 4
> #define LWMI_FAN_ID(x) ((x) + LWMI_FAN_ID_BASE)
> @@ -115,6 +125,27 @@ enum lwmi_feature_id_psu {
>
> static DEFINE_IDA(lwmi_om_ida);
>
> +static DEFINE_IDA(lwmi_tac_ida);
> +static DEFINE_MUTEX(lwmi_tac_lock);
> +
> +struct lwmi_tac {
> + struct miscdevice misc;
> + struct kref ref;
> + struct wmi_device *wdev;
> + u8 instance;
> + int id;
> +};
> +
> +struct lwmi_tac_file {
> + struct lwmi_tac *tac;
> + /* Protects the per-open response and its position. */
> + struct mutex lock;
> + void *result;
> + size_t result_len;
> + loff_t position;
> + bool completed;
> +};
> +
> enum attribute_property {
> DEFAULT_VAL,
> MAX_VAL,
> @@ -1609,6 +1640,295 @@ static void lwmi_om_fw_attr_remove(struct lwmi_om_priv *priv)
> priv->ida_id = -EIDRM;
> }
>
> +/**
> + * lwmi_tac_free() - Free an unregistered endpoint after its last close
> + * @ref: Reference belonging to the endpoint.
> + */
> +static void lwmi_tac_free(struct kref *ref)
> +{
> + struct lwmi_tac *tac = container_of(ref, struct lwmi_tac, ref);
> +
> + ida_free(&lwmi_tac_ida, tac->id);
> + kfree(tac->misc.name);
> + kfree(tac);
> +}
> +
> +/**
> + * lwmi_tac_open() - Allocate independent response state for an open file
> + * @inode: Character device inode.
> + * @file: File initially pointing to the registered miscdevice.
> + *
> + * The misc core serializes open against deregistration, so the registration
> + * reference remains valid while the file acquires its own reference.
> + *
> + * Return: 0 on success, or -ENOMEM.
> + */
> +static int lwmi_tac_open(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac *tac = container_of(file->private_data, struct lwmi_tac, misc);
> + struct lwmi_tac_file *state;
> +
> + state = kzalloc_obj(*state);
> + if (!state)
> + return -ENOMEM;
> + mutex_init(&state->lock);
> + state->tac = tac;
> + kref_get(&tac->ref);
> + file->private_data = state;
> + return stream_open(inode, file);
Add line breaks to improve readability. Same for the following methods.
> +}
> +
> +/**
> + * lwmi_tac_release() - Erase the response and drop the endpoint reference
> + * @inode: Character device inode.
> + * @file: File holding the endpoint state.
> + *
> + * Return: 0.
> + */
> +static int lwmi_tac_release(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> +
> + kfree_sensitive(state->result);
Why on earth is it sensitive?
> + mutex_destroy(&state->lock);
> + kref_put(&state->tac->ref, lwmi_tac_free);
> + kfree(state);
> + return 0;
> +}
> +
> +/**
> + * lwmi_tac_invoke() - Execute GetDataByPackage and retain the response
> + * @state: Open file whose response buffer is empty.
> + * @data: Zero-padded 100-byte input buffer.
> + *
> + * The caller holds state->lock and lwmi_tac_lock.
>
Add lockdep assertions instead of stating them in comments.
> The latter serializes call
> + * pairs across instances and keeps the WMI device valid during evaluation.
> + *
> + * Return: 0 on success, or a negative error code.
> + */
> +static int lwmi_tac_invoke(struct lwmi_tac_file *state, u8 *data)
> +{
> + struct lwmi_tac *tac = state->tac;
> + struct wmi_buffer input = { .length = LWMI_DATA_PACKAGE_INPUT_MAX, .data = data };
> + struct wmi_buffer output;
> + u32 data_size;
> + int ret;
> +
> + if (!tac->wdev)
> + return -ENODEV;
> + /*
> + * Duplicated call required to match BIOS workaround for behavior
> + * seen when WMI accessed via scripting on other OS.
Reference? Where is the script?
> + */
> + for (unsigned int call = 0; call < 2; call++) {
> + ret = wmidev_invoke_method(tac->wdev, tac->instance,
> + LWMI_DATA_PACKAGE_GET, &input, &output, 0);
> + if (ret)
> + return ret;
> + if (!call)
> + kfree_sensitive(output.data);
> + }
> + /* Validate DataSize before preserving the complete firmware response. */
Don't retell what the code does, but rather explain why.
> + if (output.length < sizeof(__le32)) {
Why not use wmidev_invoke_method()'s min_size argument?
> + ret = -EPROTO;
> + goto free_output;
> + }
> + data_size = get_unaligned_le32(output.data);
wmidev_invoke_method() returns aligned data.
> + if (data_size > output.length - sizeof(__le32)) {
> + ret = -EPROTO;
> + goto free_output;
> + }
> + /* Transfer ownership without another allocation after firmware ran. */
> + state->result = output.data;
Use __free() and no_free_ptr().
> + state->result_len = sizeof(__le32) + data_size;
Couldn't you declare a struct with a flex array member to represent this?
> + state->position = 0;
> + state->completed = true;
> + return 0;
> +free_output:
> + kfree_sensitive(output.data);
> + return ret;
> +}
> +
> +/**
> + * lwmi_tac_write() - Submit one complete TAC request
"complete"
Obvious.
> + * @file: Open TAC endpoint with independent response state.
> + * @buffer: Userspace input bytes.
> + * @count: Input size, from 1 to 100 bytes.
> + * @ppos: Unused;
>
> TAC is a nonseekable request/response stream.
Obvious.
> + *
> + * Short inputs are zero-padded. An unread response must be consumed before
> + * submitting another request. A failed firmware call is never retried here.
> + *
> + * Return: @count on success, or a negative error code.
> + */
> +static ssize_t lwmi_tac_write(struct file *file, const char __user *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + u8 input[LWMI_DATA_PACKAGE_INPUT_MAX] = {};
> + int ret;
> +
> + if (!count || count > sizeof(input))
> + return -EINVAL;
> + if (copy_from_user(input, buffer, count)) {
> + ret = -EFAULT;
> + goto clear_input;
> + }
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + goto clear_input;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
> + goto unlock;
Use scoped_cond_guard() or ACQUIRE().
> + if (!state->tac->wdev) {
> + ret = -ENODEV;
> + } else if (state->result) {
> + ret = -EBUSY;
> + } else {
> + state->completed = false;
> + ret = lwmi_tac_invoke(state, input);
> + }
> + mutex_unlock(&lwmi_tac_lock);
> +unlock:
> + mutex_unlock(&state->lock);
> +clear_input:
> + memzero_explicit(input, sizeof(input));
Why on earth is it sensitive, too?
> + if (ret)
> + return ret;
> + return count;
> +}
> +
> +/**
> + * lwmi_tac_read() - Read only this open file's firmware response
"only"
Obvious, no?
> + * @file: Open TAC endpoint.
> + * @buffer: Userspace destination.
> + * @count: Maximum number of bytes to return.
> + * @ppos: Unused; the response position is protected by state->lock.
> + *
> + * Responses contain little-endian u32 DataSize followed by Data. Partial
> + * reads advance the response position. Consuming the result erases its
> + * storage immediately; subsequent reads return EOF until another write.
> + *
> + * Return: Bytes read, 0 at EOF or for zero @count, or a negative error code.
> + */
> +static ssize_t lwmi_tac_read(struct file *file, char __user *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + ssize_t ret;
> +
> + if (!count)
> + return 0;
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + return ret;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
> + goto unlock;
> + if (!state->tac->wdev)
> + ret = -ENODEV;
> + mutex_unlock(&lwmi_tac_lock);
> + if (ret) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + goto unlock;
> + }
> + if (!state->completed) {
> + ret = -ENODATA;
> + goto unlock;
> + }
> + if (!state->result)
> + goto unlock;
> + ret = simple_read_from_buffer(buffer, count, &state->position,
> + state->result, state->result_len);
> + if (state->position == (loff_t)state->result_len) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + }
> +unlock:
> + mutex_unlock(&state->lock);
> + return ret;
The entire method is in a horrible mess. Drop the support for partial
reads, and use scoped_cond_guard()/ACQUIRE(), and __free() to tidy it up.
> +}
> +
> +static const struct file_operations lwmi_tac_fops = {
> + .owner = THIS_MODULE,
> + .open = lwmi_tac_open,
> + .release = lwmi_tac_release,
> + .read = lwmi_tac_read,
> + .write = lwmi_tac_write,
> +};
> +
> +/**
> + * lwmi_tac_remove() - Unregister an endpoint and block further firmware calls
> + * @data: Endpoint registered as a device-managed cleanup action.
> + *
> + * Stop new opens before waiting for an in-flight call pair. Existing files
> + * retain the endpoint state, but their subsequent reads/writes return -ENODEV.
> + */
> +static void lwmi_tac_remove(void *data)
> +{
> + struct lwmi_tac *tac = data;
> +
> + misc_deregister(&tac->misc);
> + mutex_lock(&lwmi_tac_lock);
> + tac->wdev = NULL;
> + mutex_unlock(&lwmi_tac_lock);
> + kref_put(&tac->ref, lwmi_tac_free);
> +}
> +
> +/**
> + * lwmi_tac_add() - Register TAC endpoints independently of capability data
> + * @wdev: Bound Lenovo Other Mode WMI device.
> + *
> + * No capability describes method 99, so registration does not probe firmware
> + * support. Each firmware instance gets an endpoint; unsupported method calls
> + * are reported to userspace when requested.
> + *
> + * Return: 0 on success, or a negative error code. Device-managed cleanup
> + * unregisters earlier endpoints if a later registration or probe step fails.
> + */
> +static int lwmi_tac_add(struct wmi_device *wdev)
devm_
> +{
> + unsigned int instances = wmidev_instance_count(wdev);
> + int ret;
> +
> + for (unsigned int instance = 0; instance < instances; instance++) {
> + struct lwmi_tac *tac;
> +
> + tac = kzalloc_obj(*tac);
> + if (!tac)
> + return -ENOMEM;
> + ret = ida_alloc(&lwmi_tac_ida, GFP_KERNEL);
> + if (ret < 0) {
> + kfree(tac);
> + return ret;
> + }
> + tac->id = ret;
> + kref_init(&tac->ref);
> + tac->wdev = wdev;
> + tac->instance = instance;
> + tac->misc.minor = MISC_DYNAMIC_MINOR;
> + tac->misc.name = kasprintf(GFP_KERNEL, "tac%d", tac->id);
> + tac->misc.fops = &lwmi_tac_fops;
> + tac->misc.parent = &wdev->dev;
> + tac->misc.mode = 0600;
> + if (!tac->misc.name) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return -ENOMEM;
> + }
> + ret = misc_register(&tac->misc);
> + if (ret) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return ret;
> + }
> + /* Unregister before the WMI device and its managed state disappear. */
> + ret = devm_add_action_or_reset(&wdev->dev, lwmi_tac_remove, tac);
> + if (ret)
> + return ret;
> + }
> + return 0;
> +}
> +
> /* ======== Self (master: lenovo-wmi-other) ======== */
>
> /**
> @@ -1693,6 +2013,7 @@ static int lwmi_other_probe(struct wmi_device *wdev, const void *context)
> {
> struct component_match *master_match = NULL;
> struct lwmi_om_priv *priv;
> + int ret;
>
> priv = devm_kzalloc_obj(&wdev->dev, *priv);
> if (!priv)
> @@ -1708,6 +2029,10 @@ static int lwmi_other_probe(struct wmi_device *wdev, const void *context)
> if (IS_ERR(master_match))
> return PTR_ERR(master_match);
>
> + ret = lwmi_tac_add(wdev);
> + if (ret)
> + return ret;
Why is this fatal?
Thanks,
Rong
> +
> return component_master_add_with_match(&wdev->dev, &lwmi_om_master_ops,
> master_match);
> }
>
> base-commit: 5680519168f65666d2c03cc6ed8fe2b7052aee12
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface
2026-11-16 4:05 [PATCH] platform/x86: lenovo-wmi-other: Add raw GetDataByPackage interface Alan Pluto
2026-11-16 12:43 ` Ilpo Järvinen
2026-11-16 12:44 ` Rong Zhang
@ 2026-11-16 16:56 ` Mark Pearson
2 siblings, 0 replies; 4+ messages in thread
From: Mark Pearson @ 2026-11-16 16:56 UTC (permalink / raw)
To: Alan Pluto, platform-driver-x86@vger.kernel.org
Cc: Derek J . Clark, Rong Zhang, Armin Wolf, Hans de Goede,
Ilpo Järvinen, Jonathan Corbet, skhan, Randy Dunlap,
linux-kernel, linux-doc, linux-api
Hi Alan,
On Sun, Nov 15, 2026, at 11:05 PM, Alan Pluto wrote:
> Expose Lenovo Other Mode WMI GetDataByPackage, method 99, through a
> root-only character device so userspace can access the raw firmware
> interface. And document the interface.
>
> The upstream driver was build-tested with W=1 and checked with Sparse.
> A backport using the five-argument wmidev_invoke_method() interface
> was tested on Ubuntu 7.0.0-42 with Lenovo hardware. The upstream 7.4
> driver has not been tested on hardware.
>
> Signed-off-by: Alan Pluto <alanpluto@163.com>
> ---
> Documentation/ABI/testing/dev-tac | 49 +++
> .../wmi/devices/lenovo-wmi-other.rst | 8 +
> MAINTAINERS | 1 +
> drivers/platform/x86/lenovo/wmi-other.c | 325 ++++++++++++++++++
> 4 files changed, 383 insertions(+)
> create mode 100644 Documentation/ABI/testing/dev-tac
>
> diff --git a/Documentation/ABI/testing/dev-tac
> b/Documentation/ABI/testing/dev-tac
> new file mode 100644
> index 00000000000..a8be8e95e2d
> --- /dev/null
> +++ b/Documentation/ABI/testing/dev-tac
> @@ -0,0 +1,49 @@
> +What: /dev/tac[0-9]*
> +Date: November 2026
> +Contact: platform-driver-x86@vger.kernel.org
> +Description:
> + Lenovo Other Mode WMI GetDataByPackage (method 99).
> + Each firmware WMI instance gets a misc character
> device with
> + mode 0600. Numbering follows allocation order, not
> necessarily
> + the firmware instance number. Registration does not
> probe
> + support for method 99. The parent is the bound WMI
> device.
> +
> + Open with O_RDWR. One write submits one complete
> request of
> + 1..100 raw bytes; shorter requests are padded with
> zeroes to
> + 100 bytes. Empty and oversized writes fail with EINVAL
> without
> + calling firmware. Successful writes return the full
> submitted
> + length and execute two identical WMI calls for the BIOS
> + duplicate-call workaround. Request pairs through this
> + interface are serialized; calls made by other driver
> + interfaces are not covered by this serialization.
> + Evaluation failures abort the pair; the driver does not
> + automatically retry.
> +
> + Each open file description owns its response. A write
> while
> + that response remains unread fails with EBUSY,
> including after
> + partial reads. A new open cannot read another open's
> response.
> + Descriptors shared by dup/fork share the same
> transaction;
> + applications must coordinate the complete write/read
> sequence.
> +
> + Read returns little-endian u32 DataSize followed by
> exactly
> + DataSize data bytes. Response storage is erased when
> fully
> + read or closed. Further reads return EOF until a new
> successful
> + write. Before a successful write, or after a failed
> firmware
> + evaluation, reads return ENODATA. A zero-length read
> returns
> + zero without consuming data.
> +
> + Requests are synchronous even with O_NONBLOCK. Seeking
> and
> + positional I/O are not supported. There is no ioctl
> interface.
> + A removed WMI device causes nonempty reads and valid
> writes
> + on existing descriptors to fail with ENODEV.
> +
> + Firmware evaluation failures map to EIO. WMI
> marshalling
> + failures return the error reported by the WMI
> subsystem.
> + A truncated response or invalid DataSize maps to
> EPROTO.
> + Bad userspace memory maps to EFAULT. Failure does not
> imply
> + firmware had no side effects; never blindly resubmit
> commands.
> + Interrupted waits can return EINTR before firmware
> evaluation.
> +
> + The WMI subsystem converts returned ACPI objects to a
> buffer.
> + This raw firmware interface may change device state.
> Use only
> + commands whose behavior and side effects are
> understood.
> diff --git a/Documentation/wmi/devices/lenovo-wmi-other.rst
> b/Documentation/wmi/devices/lenovo-wmi-other.rst
> index 011054d64ea..ec85fdeeb7a 100644
> --- a/Documentation/wmi/devices/lenovo-wmi-other.rst
> +++ b/Documentation/wmi/devices/lenovo-wmi-other.rst
> @@ -33,6 +33,10 @@ under the following path:
>
> Additionally, this driver also exports attributes to HWMON.
>
> +The driver also exposes GetDataByPackage (method 99) through a raw character
> +device for each WMI instance. See Documentation/ABI/testing/dev-tac for the
> +request and response format and its access restrictions.
> +
> LENOVO_CAPABILITY_DATA_00
> -------------------------
>
> @@ -109,6 +113,10 @@ WMI interface description
> The WMI interface description can be decoded from the embedded binary
> MOF (bmof)
> data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
>
> +The example below describes an older firmware revision and specifies a
> +40-byte maximum input for GetDataByPackage. Newer firmware uses a 100-byte
> +input, which is the size used by the raw interface described above.
> +
> ::
>
> [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"),
> Description("LENOVO_OTHER_METHOD class"),
> guid("{dc2a8805-3a8c-41ba-a6f7-092e0089cd3b}")]
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 981eb3fdbef..84b1545f525 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -15168,6 +15168,7 @@ M: Derek J. Clark <derekjohn.clark@gmail.com>
> M: Rong Zhang <i@rong.moe>
> L: platform-driver-x86@vger.kernel.org
> S: Maintained
> +F: Documentation/ABI/testing/dev-tac
> F: Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> F: Documentation/wmi/devices/lenovo-wmi-other.rst
> F: drivers/platform/x86/lenovo/*
> diff --git a/drivers/platform/x86/lenovo/wmi-other.c
> b/drivers/platform/x86/lenovo/wmi-other.c
> index bd64e7b4466..c15b3a2a758 100644
> --- a/drivers/platform/x86/lenovo/wmi-other.c
> +++ b/drivers/platform/x86/lenovo/wmi-other.c
> @@ -34,16 +34,23 @@
> #include <linux/device.h>
> #include <linux/export.h>
> #include <linux/firmware_attributes.h>
> +#include <linux/fs.h>
> #include <linux/gfp_types.h>
> #include <linux/hwmon.h>
> #include <linux/idr.h>
> #include <linux/kdev_t.h>
> #include <linux/kobject.h>
> +#include <linux/kref.h>
> #include <linux/limits.h>
> +#include <linux/miscdevice.h>
> #include <linux/module.h>
> +#include <linux/mutex.h>
> #include <linux/platform_profile.h>
> #include <linux/power_supply.h>
> +#include <linux/slab.h>
> #include <linux/types.h>
> +#include <linux/uaccess.h>
> +#include <linux/unaligned.h>
> #include <linux/wmi.h>
>
> #include <acpi/battery.h>
> @@ -91,6 +98,9 @@ enum lwmi_feature_id_psu {
> #define LWMI_FEATURE_VALUE_GET 17
> #define LWMI_FEATURE_VALUE_SET 18
>
> +#define LWMI_DATA_PACKAGE_GET 99
> +#define LWMI_DATA_PACKAGE_INPUT_MAX 100
> +
> #define LWMI_FAN_ID_BASE 1
> #define LWMI_FAN_NR 4
> #define LWMI_FAN_ID(x) ((x) + LWMI_FAN_ID_BASE)
> @@ -115,6 +125,27 @@ enum lwmi_feature_id_psu {
>
> static DEFINE_IDA(lwmi_om_ida);
>
> +static DEFINE_IDA(lwmi_tac_ida);
> +static DEFINE_MUTEX(lwmi_tac_lock);
> +
> +struct lwmi_tac {
> + struct miscdevice misc;
> + struct kref ref;
> + struct wmi_device *wdev;
> + u8 instance;
> + int id;
> +};
> +
> +struct lwmi_tac_file {
> + struct lwmi_tac *tac;
> + /* Protects the per-open response and its position. */
> + struct mutex lock;
> + void *result;
> + size_t result_len;
> + loff_t position;
> + bool completed;
> +};
> +
> enum attribute_property {
> DEFAULT_VAL,
> MAX_VAL,
> @@ -1609,6 +1640,295 @@ static void lwmi_om_fw_attr_remove(struct
> lwmi_om_priv *priv)
> priv->ida_id = -EIDRM;
> }
>
> +/**
> + * lwmi_tac_free() - Free an unregistered endpoint after its last close
> + * @ref: Reference belonging to the endpoint.
> + */
> +static void lwmi_tac_free(struct kref *ref)
> +{
> + struct lwmi_tac *tac = container_of(ref, struct lwmi_tac, ref);
> +
> + ida_free(&lwmi_tac_ida, tac->id);
> + kfree(tac->misc.name);
> + kfree(tac);
> +}
> +
> +/**
> + * lwmi_tac_open() - Allocate independent response state for an open
> file
> + * @inode: Character device inode.
> + * @file: File initially pointing to the registered miscdevice.
> + *
> + * The misc core serializes open against deregistration, so the
> registration
> + * reference remains valid while the file acquires its own reference.
> + *
> + * Return: 0 on success, or -ENOMEM.
> + */
> +static int lwmi_tac_open(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac *tac = container_of(file->private_data, struct
> lwmi_tac, misc);
> + struct lwmi_tac_file *state;
> +
> + state = kzalloc_obj(*state);
> + if (!state)
> + return -ENOMEM;
> + mutex_init(&state->lock);
> + state->tac = tac;
> + kref_get(&tac->ref);
> + file->private_data = state;
> + return stream_open(inode, file);
> +}
> +
> +/**
> + * lwmi_tac_release() - Erase the response and drop the endpoint
> reference
> + * @inode: Character device inode.
> + * @file: File holding the endpoint state.
> + *
> + * Return: 0.
> + */
> +static int lwmi_tac_release(struct inode *inode, struct file *file)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> +
> + kfree_sensitive(state->result);
> + mutex_destroy(&state->lock);
> + kref_put(&state->tac->ref, lwmi_tac_free);
> + kfree(state);
> + return 0;
> +}
> +
> +/**
> + * lwmi_tac_invoke() - Execute GetDataByPackage and retain the response
> + * @state: Open file whose response buffer is empty.
> + * @data: Zero-padded 100-byte input buffer.
> + *
> + * The caller holds state->lock and lwmi_tac_lock. The latter
> serializes call
> + * pairs across instances and keeps the WMI device valid during
> evaluation.
> + *
> + * Return: 0 on success, or a negative error code.
> + */
> +static int lwmi_tac_invoke(struct lwmi_tac_file *state, u8 *data)
> +{
> + struct lwmi_tac *tac = state->tac;
> + struct wmi_buffer input = { .length = LWMI_DATA_PACKAGE_INPUT_MAX,
> .data = data };
> + struct wmi_buffer output;
> + u32 data_size;
> + int ret;
> +
> + if (!tac->wdev)
> + return -ENODEV;
> + /*
> + * Duplicated call required to match BIOS workaround for behavior
> + * seen when WMI accessed via scripting on other OS.
> + */
> + for (unsigned int call = 0; call < 2; call++) {
> + ret = wmidev_invoke_method(tac->wdev, tac->instance,
> + LWMI_DATA_PACKAGE_GET, &input, &output, 0);
> + if (ret)
> + return ret;
> + if (!call)
> + kfree_sensitive(output.data);
> + }
> + /* Validate DataSize before preserving the complete firmware
> response. */
> + if (output.length < sizeof(__le32)) {
> + ret = -EPROTO;
> + goto free_output;
> + }
> + data_size = get_unaligned_le32(output.data);
> + if (data_size > output.length - sizeof(__le32)) {
> + ret = -EPROTO;
> + goto free_output;
> + }
> + /* Transfer ownership without another allocation after firmware ran.
> */
> + state->result = output.data;
> + state->result_len = sizeof(__le32) + data_size;
> + state->position = 0;
> + state->completed = true;
> + return 0;
> +free_output:
> + kfree_sensitive(output.data);
> + return ret;
> +}
> +
> +/**
> + * lwmi_tac_write() - Submit one complete TAC request
> + * @file: Open TAC endpoint with independent response state.
> + * @buffer: Userspace input bytes.
> + * @count: Input size, from 1 to 100 bytes.
> + * @ppos: Unused; TAC is a nonseekable request/response stream.
> + *
> + * Short inputs are zero-padded. An unread response must be consumed
> before
> + * submitting another request. A failed firmware call is never retried
> here.
> + *
> + * Return: @count on success, or a negative error code.
> + */
> +static ssize_t lwmi_tac_write(struct file *file, const char __user
> *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + u8 input[LWMI_DATA_PACKAGE_INPUT_MAX] = {};
> + int ret;
> +
> + if (!count || count > sizeof(input))
> + return -EINVAL;
> + if (copy_from_user(input, buffer, count)) {
> + ret = -EFAULT;
> + goto clear_input;
> + }
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + goto clear_input;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
> + goto unlock;
> + if (!state->tac->wdev) {
> + ret = -ENODEV;
> + } else if (state->result) {
> + ret = -EBUSY;
> + } else {
> + state->completed = false;
> + ret = lwmi_tac_invoke(state, input);
> + }
> + mutex_unlock(&lwmi_tac_lock);
> +unlock:
> + mutex_unlock(&state->lock);
> +clear_input:
> + memzero_explicit(input, sizeof(input));
> + if (ret)
> + return ret;
> + return count;
> +}
> +
> +/**
> + * lwmi_tac_read() - Read only this open file's firmware response
> + * @file: Open TAC endpoint.
> + * @buffer: Userspace destination.
> + * @count: Maximum number of bytes to return.
> + * @ppos: Unused; the response position is protected by state->lock.
> + *
> + * Responses contain little-endian u32 DataSize followed by Data.
> Partial
> + * reads advance the response position. Consuming the result erases its
> + * storage immediately; subsequent reads return EOF until another
> write.
> + *
> + * Return: Bytes read, 0 at EOF or for zero @count, or a negative
> error code.
> + */
> +static ssize_t lwmi_tac_read(struct file *file, char __user *buffer,
> + size_t count, loff_t *ppos)
> +{
> + struct lwmi_tac_file *state = file->private_data;
> + ssize_t ret;
> +
> + if (!count)
> + return 0;
> + ret = mutex_lock_interruptible(&state->lock);
> + if (ret)
> + return ret;
> + ret = mutex_lock_interruptible(&lwmi_tac_lock);
> + if (ret)
> + goto unlock;
> + if (!state->tac->wdev)
> + ret = -ENODEV;
> + mutex_unlock(&lwmi_tac_lock);
> + if (ret) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + goto unlock;
> + }
> + if (!state->completed) {
> + ret = -ENODATA;
> + goto unlock;
> + }
> + if (!state->result)
> + goto unlock;
> + ret = simple_read_from_buffer(buffer, count, &state->position,
> + state->result, state->result_len);
> + if (state->position == (loff_t)state->result_len) {
> + kfree_sensitive(state->result);
> + state->result = NULL;
> + }
> +unlock:
> + mutex_unlock(&state->lock);
> + return ret;
> +}
> +
> +static const struct file_operations lwmi_tac_fops = {
> + .owner = THIS_MODULE,
> + .open = lwmi_tac_open,
> + .release = lwmi_tac_release,
> + .read = lwmi_tac_read,
> + .write = lwmi_tac_write,
> +};
> +
> +/**
> + * lwmi_tac_remove() - Unregister an endpoint and block further
> firmware calls
> + * @data: Endpoint registered as a device-managed cleanup action.
> + *
> + * Stop new opens before waiting for an in-flight call pair. Existing
> files
> + * retain the endpoint state, but their subsequent reads/writes return
> -ENODEV.
> + */
> +static void lwmi_tac_remove(void *data)
> +{
> + struct lwmi_tac *tac = data;
> +
> + misc_deregister(&tac->misc);
> + mutex_lock(&lwmi_tac_lock);
> + tac->wdev = NULL;
> + mutex_unlock(&lwmi_tac_lock);
> + kref_put(&tac->ref, lwmi_tac_free);
> +}
> +
> +/**
> + * lwmi_tac_add() - Register TAC endpoints independently of capability
> data
> + * @wdev: Bound Lenovo Other Mode WMI device.
> + *
> + * No capability describes method 99, so registration does not probe
> firmware
> + * support. Each firmware instance gets an endpoint; unsupported
> method calls
> + * are reported to userspace when requested.
> + *
> + * Return: 0 on success, or a negative error code. Device-managed
> cleanup
> + * unregisters earlier endpoints if a later registration or probe step
> fails.
> + */
> +static int lwmi_tac_add(struct wmi_device *wdev)
> +{
> + unsigned int instances = wmidev_instance_count(wdev);
> + int ret;
> +
> + for (unsigned int instance = 0; instance < instances; instance++) {
> + struct lwmi_tac *tac;
> +
> + tac = kzalloc_obj(*tac);
> + if (!tac)
> + return -ENOMEM;
> + ret = ida_alloc(&lwmi_tac_ida, GFP_KERNEL);
> + if (ret < 0) {
> + kfree(tac);
> + return ret;
> + }
> + tac->id = ret;
> + kref_init(&tac->ref);
> + tac->wdev = wdev;
> + tac->instance = instance;
> + tac->misc.minor = MISC_DYNAMIC_MINOR;
> + tac->misc.name = kasprintf(GFP_KERNEL, "tac%d", tac->id);
> + tac->misc.fops = &lwmi_tac_fops;
> + tac->misc.parent = &wdev->dev;
> + tac->misc.mode = 0600;
> + if (!tac->misc.name) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return -ENOMEM;
> + }
> + ret = misc_register(&tac->misc);
> + if (ret) {
> + kref_put(&tac->ref, lwmi_tac_free);
> + return ret;
> + }
> + /* Unregister before the WMI device and its managed state disappear.
> */
> + ret = devm_add_action_or_reset(&wdev->dev, lwmi_tac_remove, tac);
> + if (ret)
> + return ret;
> + }
> + return 0;
> +}
> +
> /* ======== Self (master: lenovo-wmi-other) ======== */
>
> /**
> @@ -1693,6 +2013,7 @@ static int lwmi_other_probe(struct wmi_device
> *wdev, const void *context)
> {
> struct component_match *master_match = NULL;
> struct lwmi_om_priv *priv;
> + int ret;
>
> priv = devm_kzalloc_obj(&wdev->dev, *priv);
> if (!priv)
> @@ -1708,6 +2029,10 @@ static int lwmi_other_probe(struct wmi_device
> *wdev, const void *context)
> if (IS_ERR(master_match))
> return PTR_ERR(master_match);
>
> + ret = lwmi_tac_add(wdev);
> + if (ret)
> + return ret;
> +
> return component_master_add_with_match(&wdev->dev, &lwmi_om_master_ops,
> master_match);
> }
>
> base-commit: 5680519168f65666d2c03cc6ed8fe2b7052aee12
> --
> 2.53.0
Are you working within Lenovo? I looked up what this method does and details in the spec I have are very limited, but I was wondering if you're working on one of the new products?
If so, please ping me on my work address. You should be able to look me (Mark Pearson) up - or reach out to the Linux preload team. I think it would be good to discuss what is being done here.
If you're not from within Lenovo please let me know how/why you're using this interface. I would rather go and discuss with the FW team to confirm what is being exposed first, before we enable it blindly.
Thanks
Mark
^ permalink raw reply [flat|nested] 4+ messages in thread