Message-ID: <20250102004854.14874-1-derekjohn.clark@gmail.com>
Date: Wed,  1 Jan 2025 16:47:18 -0800
From: "Derek J. Clark" <derekjohn.clark@...il.com>
To: Hans de Goede <hdegoede@...hat.com>,
	Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
Cc: Jonathan Corbet <corbet@....net>,
	Mario Limonciello <superm1@...nel.org>,
	Luke Jones <luke@...nes.dev>,
	Xino Ni <nijs1@...ovo.com>,
	Zhixin Zhang <zhangzx36@...ovo.com>,
	Mia Shao <shaohz1@...ovo.com>,
	Mark Pearson <mpearson-lenovo@...ebb.ca>,
	"Pierre-Loup A . Griffais" <pgriffais@...vesoftware.com>,
	"Cody T . -H . Chiu" <codyit@...il.com>,
	John Martens <johnfanv2@...il.com>,
	"Derek J . Clark" <derekjohn.clark@...il.com>,
	platform-driver-x86@...r.kernel.org,
	linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH v2 0/4] platform/x86: Add Lenovo Gaming Series WMI Drivers

Adds support for the Lenovo "Gaming Series" of laptop hardware that use
WMI interfaces that control various power settings. There are multiple WMI
interfaces that work in concert to provide getting and setting values as
well as validation of input. Currently only the "GameZone", "Other
Mode", and "LENOVO_CAPABILITY_DATA_01" interfaces are implemented, but
I attempted to structure the driver so that adding the "Custom Mode",
"Lighting", and other data block interfaces would be trivial in a later
patches.

This driver is distinct from, but should be considered a replacement for
this patch:
https://lore.kernel.org/all/20241118100503.14228-1-jonmail@163.com/

This driver attempts to standardize the exposed sysfs by mirroring the
asus-armoury driver currently under review. As such, a lot of
inspiration has been drawn from that driver.
https://lore.kernel.org/all/20240930000046.51388-1-luke@ljones.dev/

The drivers have been tested by me on the Lenovo Legion Go.

v2:
- Broke up initial patch into a 4 patch series.
- Removed all references to "Legion" in documentation, Kconfig,
  driver structs, functions, etc. Everything now refers either to the
  interface being used or the Lenovo "Gaming Series" of laptop hardware.
- Fixed all Acked changes requested by Mario and Armin.
- Capability Data is now cached before kset creation for each attribute.
  If the lenovo-wmi-capdata01 interface is not present, fails to grab
  valid data, doesn't include the requested attribute id page, or the
  data block indicates the attribute is not supported, the attribute will
  not be created in sysfs.
- The sysfs path for the firmware-attributes class was moved from
  lenovo-legion-wmi to lenovo-wmi-other.

- The Other Mode WMI interface no longer relies on gamezone as
  discussed. However; this creates a problem that should be discussed
  here. The current_value attribute is now only accurate when the
  "custom" profile is set on the device. Previously it would report the
  value from the Capability Data 01 instance related to the currently
  selected profile, which reported an accurate accounting of the current
  system state in all cases. I submitted this as-is since we discussed
  removing that dependency, but I am not a fan of the current_value
  attribute being incorrect for 3 of the 4 available profiles, especially
  when the data is available. There is also no way to -ENOTSUPP or
  similar when not in custom mode as that would also require us to know
  the state of the gamezone interface. What I would prefer to do would be
  to make the gamezone interface optional by treating custom as the
  default mode in the current_value functions, then only update the mode
  if a callback to get the current fan profile is a success. That way the
  logic will work with or without the GameZone interface, but it will be
  greatly improved if it is present.

- I did extensive testing of this firmware-attributes interface and its
  ability to retain the value set by the user. The SPL, SPPT, FPPT, and 
  platform profile all retain the users last setting when resuming from
  suspend, a full reboot, and a full shutdown. The only time the values
  are not preserved is when the user manually selects a new platform
  profile using either the pprof interface or the manual selection
  button on the device, in which case you would not expect them to be
  retained as they were intentionally changed. Based on the previous
  discussion it may be the case that older BIOS' will preserve the
  settings even after changing profiles, though I haven't confirmed
  this.

v1:
https://lore.kernel.org/platform-driver-x86/CAFqHKTna+kJpHLo5s4Fm1TmHcSSqSTr96JHDm0DJ0dxsZMkixA@mail.gmail.com/T/#t

Suggested-by: Mario Limonciello <superm1@...nel.org>
Signed-off-by: Derek J. Clark <derekjohn.clark@...il.com>

Derek J. Clark (4):
  platform/x86: Add lenovo-wmi drivers Documentation
  platform/x86: Add Lenovo GameZone WMI Driver
  platform/x86: Add Lenovo Capability Data 01 WMI Driver
  platform/x86: Add Lenovo Other Mode WMI Driver

 Documentation/wmi/devices/lenovo-wmi.rst    | 104 ++++++
 MAINTAINERS                                 |   9 +
 drivers/platform/x86/Kconfig                |  34 ++
 drivers/platform/x86/Makefile               |   3 +
 drivers/platform/x86/lenovo-wmi-capdata01.c | 131 +++++++
 drivers/platform/x86/lenovo-wmi-gamezone.c  | 203 +++++++++++
 drivers/platform/x86/lenovo-wmi-other.c     | 385 ++++++++++++++++++++
 drivers/platform/x86/lenovo-wmi.h           | 241 ++++++++++++
 8 files changed, 1110 insertions(+)
 create mode 100644 Documentation/wmi/devices/lenovo-wmi.rst
 create mode 100644 drivers/platform/x86/lenovo-wmi-capdata01.c
 create mode 100644 drivers/platform/x86/lenovo-wmi-gamezone.c
 create mode 100644 drivers/platform/x86/lenovo-wmi-other.c
 create mode 100644 drivers/platform/x86/lenovo-wmi.h

-- 
2.47.0

Powered by blists - more mailing lists