All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Derek J. Clark" <derekjohn.clark@gmail.com>
To: "Hans de Goede" <hdegoede@redhat.com>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
Cc: Armin Wolf <W_Armin@gmx.de>, Jonathan Corbet <corbet@lwn.net>,
	Mario Limonciello <superm1@kernel.org>,
	Luke Jones <luke@ljones.dev>, Xino Ni <nijs1@lenovo.com>,
	Zhixin Zhang <zhangzx36@lenovo.com>,
	Mia Shao <shaohz1@lenovo.com>,
	Mark Pearson <mpearson-lenovo@squebb.ca>,
	"Pierre-Loup A . Griffais" <pgriffais@valvesoftware.com>,
	"Cody T . -H . Chiu" <codyit@gmail.com>,
	John Martens <johnfanv2@gmail.com>,
	"Derek J . Clark" <derekjohn.clark@gmail.com>,
	platform-driver-x86@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v4 2/6 RESEND] platform/x86: Add lenovo-wmi-helpers
Date: Mon, 17 Mar 2025 07:43:22 -0700	[thread overview]
Message-ID: <20250317144326.5850-3-derekjohn.clark@gmail.com> (raw)
In-Reply-To: <20250317144326.5850-1-derekjohn.clark@gmail.com>

Adds documentation for all new lenovo-wmi drivers.

Signed-off-by: Derek J. Clark <derekjohn.clark@gmail.com>
---
v4:
 - Changed namespace to LENOVO_WMI_HELPERS from LENOVO_WMI.
 - Changed filenames to lenovo-wmi-helpers from lenovo-wmi.
 - Removed structs and functions implemented by other drivers.
---
 MAINTAINERS                               |  2 +
 drivers/platform/x86/Kconfig              |  4 ++
 drivers/platform/x86/Makefile             |  1 +
 drivers/platform/x86/lenovo-wmi-helpers.c | 64 +++++++++++++++++++++++
 drivers/platform/x86/lenovo-wmi-helpers.h | 24 +++++++++
 5 files changed, 95 insertions(+)
 create mode 100644 drivers/platform/x86/lenovo-wmi-helpers.c
 create mode 100644 drivers/platform/x86/lenovo-wmi-helpers.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 675f4b26426d..3a370a18b806 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13164,6 +13164,8 @@ L:	platform-driver-x86@vger.kernel.org
 S:	Maintained
 F:	Documentation/wmi/devices/lenovo-wmi-gamezone.rst
 F:	Documentation/wmi/devices/lenovo-wmi-other.rst
+F:	drivers/platform/x86/lenovo-wmi-helpers.c
+F:	drivers/platform/x86/lenovo-wmi-helpers.h
 
 LENOVO WMI HOTKEY UTILITIES DRIVER
 M:	Jackie Dong <xy-jackie@139.com>
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index 43407e76476b..bece1ba61417 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_HELPERS
+	tristate
+	depends on ACPI_WMI
+
 config IDEAPAD_LAPTOP
 	tristate "Lenovo IdeaPad Laptop Extras"
 	depends on ACPI
diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
index 650dfbebb6c8..5a9f4e94f78b 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_HELPERS)	+= lenovo-wmi-helpers.o
 
 # Intel
 obj-y				+= intel/
diff --git a/drivers/platform/x86/lenovo-wmi-helpers.c b/drivers/platform/x86/lenovo-wmi-helpers.c
new file mode 100644
index 000000000000..36d553502223
--- /dev/null
+++ b/drivers/platform/x86/lenovo-wmi-helpers.c
@@ -0,0 +1,64 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Lenovo Legion WMI helpers driver. The Lenovo Legion WMI interface is
+ * broken up into multiple GUID interfaces that require cross-references
+ * between GUID's for some functionality. The "Custom Method" interface is a
+ * legacy interface for managing and displaying CPU & GPU power and hwmon
+ * settings and readings. The "Other Mode" interface is a modern interface
+ * that replaces or extends the "Custom Method" interface methods. The
+ * "Gamezone" interface adds advanced features such as fan profiles and
+ * overclocking. The "Lighting" interface adds control of various status
+ * lights related to different hardware components. Each of these drivers
+ * uses a common procedure to get data fro the WMI interface, enumerated here.
+ *
+ * Copyright(C) 2025 Derek J. Clark <derekjohn.clark@gmail.com>
+ *
+ */
+
+#include <linux/wmi.h>
+#include "lenovo-wmi-helpers.h"
+
+/*
+ * lwmi_dev_evaluate_method() - Helper function to call wmidev_evaluate_method
+ * for Lenovo WMI device method calls that return an ACPI integer.
+ * @wdev: Pointer to the WMI device to be called.
+ * @instance: Instance of the called method.
+ * @method_id: WMI Method ID for the method to be called.
+ * @buf: Buffer of all arguments for the given method_id.
+ * @size: Length of the buffer.
+ * @retval: Pointer for the return value to be assigned.
+ *
+ * Returns: 0, or an error.
+ */
+int lwmi_dev_evaluate_method(struct wmi_device *wdev, u8 instance,
+			     u32 method_id, unsigned char *buf, size_t size,
+			     u32 *retval)
+{
+	struct acpi_buffer input = { size, buf };
+	struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
+	union acpi_object *ret_obj __free(kfree) = NULL;
+	acpi_status status;
+
+	status = wmidev_evaluate_method(wdev, instance, method_id, &input,
+					&output);
+
+	if (ACPI_FAILURE(status))
+		return -EIO;
+
+	if (retval) {
+		ret_obj = output.pointer;
+		if (!ret_obj)
+			return -ENODATA;
+
+		if (ret_obj->type != ACPI_TYPE_INTEGER)
+			return -ENXIO;
+
+		*retval = (u32)ret_obj->integer.value;
+	}
+	return 0;
+};
+EXPORT_SYMBOL_NS_GPL(lwmi_dev_evaluate_method, "LENOVO_WMI_HELPERS");
+
+MODULE_AUTHOR("Derek J. Clark <derekjohn.clark@gmail.com>");
+MODULE_DESCRIPTION("Lenovo WMI Helpers Driver");
+MODULE_LICENSE("GPL");
diff --git a/drivers/platform/x86/lenovo-wmi-helpers.h b/drivers/platform/x86/lenovo-wmi-helpers.h
new file mode 100644
index 000000000000..7e0d7870790e
--- /dev/null
+++ b/drivers/platform/x86/lenovo-wmi-helpers.h
@@ -0,0 +1,24 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later
+ *
+ * Copyright(C) 2025 Derek J. Clark <derekjohn.clark@gmail.com>
+ *
+ */
+#include <linux/notifier.h>
+#include <linux/platform_profile.h>
+
+#ifndef _LENOVO_WMI_HELPERS_H_
+#define _LENOVO_WMI_HELPERS_H_
+
+#include <linux/types.h>
+#include <linux/wmi.h>
+
+struct wmi_method_args_32 {
+	u32 arg0;
+	u32 arg1;
+};
+
+int lwmi_dev_evaluate_method(struct wmi_device *wdev, u8 instance,
+			     u32 method_id, unsigned char *buf, size_t size,
+			     u32 *retval);
+
+#endif /* !_LENOVO_WMI_HELPERS_H_ */
-- 
2.49.0


  parent reply	other threads:[~2025-03-17 14:43 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-17 14:43 [PATCH v4 0/6 RESEND] platform/x86: Add Lenovo Gaming Series WMI Drivers Derek J. Clark
2025-03-17 14:43 ` [PATCH v4 1/6 RESEND] platform/x86: Add lenovo-wmi-* driver Documentation Derek J. Clark
2025-03-18  4:24   ` Mario Limonciello
2025-03-19  2:48   ` Derek J. Clark
2025-03-19  4:41   ` Bagas Sanjaya
2025-03-19  4:50     ` Derek J. Clark
2025-03-27  0:26   ` Armin Wolf
2025-03-30  4:49     ` Derek John Clark
2025-03-17 14:43 ` Derek J. Clark [this message]
2025-03-18  4:27   ` [PATCH v4 2/6 RESEND] platform/x86: Add lenovo-wmi-helpers Mario Limonciello
2025-03-19  2:50     ` Derek J. Clark
2025-03-26 19:45   ` Matthew Schwartz
2025-03-27  0:40   ` Armin Wolf
2025-03-30  4:55     ` Derek John Clark
2025-03-27 12:43   ` Ilpo Järvinen
2025-04-02 21:22     ` Derek John Clark
2025-03-17 14:43 ` [PATCH v4 3/6 RESEND] platform/x86: Add Lenovo WMI Events Driver Derek J. Clark
2025-03-18  4:30   ` Mario Limonciello
2025-03-26 19:47   ` Matthew Schwartz
2025-03-27  1:03   ` Armin Wolf
2025-03-30  4:55     ` Derek John Clark
2025-03-27 12:47   ` Ilpo Järvinen
2025-03-17 14:43 ` [PATCH v4 4/6 RESEND] platform/x86: Add Lenovo Capability Data 01 WMI Driver Derek J. Clark
2025-03-26 19:47   ` Matthew Schwartz
2025-03-27  1:29   ` Armin Wolf
2025-04-02 20:47     ` Derek John Clark
2025-04-03  1:40       ` Armin Wolf
2025-03-27 12:56   ` Ilpo Järvinen
2025-04-02 21:22     ` Derek John Clark
2025-04-03  1:21       ` Armin Wolf
2025-04-03 11:01       ` Ilpo Järvinen
2025-03-17 14:43 ` [PATCH v4 5/6 RESEND] platform/x86: Add Lenovo Other Mode " Derek J. Clark
2025-03-26 19:48   ` Matthew Schwartz
2025-03-27  3:28   ` Armin Wolf
2025-04-02 22:24     ` Derek John Clark
2025-04-03  1:28       ` Armin Wolf
2025-04-03 11:05         ` Ilpo Järvinen
2025-03-27 13:49   ` Ilpo Järvinen
2025-04-02 21:22     ` Derek John Clark
2025-04-03 10:49       ` Ilpo Järvinen
2025-03-17 14:43 ` [PATCH v4 6/6 RESEND] platform/x86: Add Lenovo Gamezone " Derek J. Clark
2025-03-26 19:48   ` Matthew Schwartz
2025-03-27  3:49   ` Armin Wolf
2025-04-02 20:58     ` Derek John Clark
2025-04-03  1:32       ` Armin Wolf
2025-03-27 13:56   ` Ilpo Järvinen
2025-04-02 21:22     ` Derek John Clark
2025-04-03 10:53       ` Ilpo Järvinen
2025-03-27  3:52 ` [PATCH v4 0/6 RESEND] platform/x86: Add Lenovo Gaming Series WMI Drivers Armin Wolf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250317144326.5850-3-derekjohn.clark@gmail.com \
    --to=derekjohn.clark@gmail.com \
    --cc=W_Armin@gmx.de \
    --cc=codyit@gmail.com \
    --cc=corbet@lwn.net \
    --cc=hdegoede@redhat.com \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=johnfanv2@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luke@ljones.dev \
    --cc=mpearson-lenovo@squebb.ca \
    --cc=nijs1@lenovo.com \
    --cc=pgriffais@valvesoftware.com \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=shaohz1@lenovo.com \
    --cc=superm1@kernel.org \
    --cc=zhangzx36@lenovo.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.