[PATCH v2 00/10] platform/x86: alienware-wmi-wmax: HWMON support + DebugFS + Improvements

[PATCH v2 00/10] platform/x86: alienware-wmi-wmax: HWMON support + DebugFS + Improvements

[Kurt Borja]

Hi all,

It's been a busy week, but I finally finished v2.

The biggest change since v1 is Patch 08/10, which now uses custom HWMON
attributes.

As always thank you for your feedback and reviews :)

PD: I lost my changelog so I apologize if I missed something bellow.

---
Changes since v1:

[03/10]
  - Minor correction in commit message

[04/10]
  - Dropped overflow approach in favor of checking a hardcoded limit for
    device resources

[07/10]
  - Dropped status cache
  - As Armin pointed out, operation 0x01 of GetFanSensors gives us the
    count of temperature sensors related to a given fan. Use this to
    retrieve related sensors for each fan into a bitmap and expose this
    information through pwm*_auto_channels_temp attributes
  - Use related temperature sensors to assign labels to fans
  - Store available fan IDs in a bitmap for convenience

[08/10]
  - Use custom attributes to expose pwm_boost
  - Add pm_ops because if a user sets pwm_boost fans would remain *on*
    after suspending

[10/10]
  - Correct information about GetFanSensors method, based on Armin's
    feedback

v1: https://lore.kernel.org/platform-driver-x86/20250208051614.10644-1-kuurtb@gmail.com/


Kurt Borja (10):
  platform/x86: alienware-wmi-wmax: Rename thermal related symbols
  platform/x86: alienware-wmi-wmax: Refactor is_awcc_thermal_mode()
  platform/x86: alienware-wmi-wmax: Improve internal AWCC API
  platform/x86: alienware-wmi-wmax: Modify supported_thermal_profiles[]
  platform/x86: alienware-wmi-wmax: Improve platform profile probe
  platform/x86: alienware-wmi-wmax: Add support for the "custom" thermal
    profile
  platform/x86: alienware-wmi-wmax: Add HWMON support
  platform/x86: alienware-wmi-wmax: Add support for manual fan control
  platform/x86: alienware-wmi-wmax: Add a DebugFS interface
  platform/x86: alienware-wmi: Improve and update documentation

 Documentation/wmi/devices/alienware-wmi.rst   | 387 +++----
 drivers/platform/x86/dell/Kconfig             |   1 +
 .../platform/x86/dell/alienware-wmi-wmax.c    | 955 +++++++++++++++---
 3 files changed, 948 insertions(+), 395 deletions(-)


base-commit: c86e269c4da6dca2beaf99bdc6fd9f0a9f69035f
-- 
2.48.1

[PATCH v2 01/10] platform/x86: alienware-wmi-wmax: Rename thermal related symbols

[Kurt Borja]

The "thermal" features of the WMAX WMI device are only present on the
host device if the ACPI _UID is "AWCC". Replace WMAX prefixes with
"AWCC" to reflect this relationship.

Thermal profiles with WMAX_PROFILE_BASIC prefix are also renamed to
WMAX_PROFILE_LEGACY because they are only supported in older versions
of this WMI device.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 173 +++++++++---------
 1 file changed, 87 insertions(+), 86 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 3d3014b5adf0..ed70e12d73d7 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -24,16 +24,17 @@
 #define WMAX_METHOD_DEEP_SLEEP_STATUS		0x0C
 #define WMAX_METHOD_BRIGHTNESS			0x3
 #define WMAX_METHOD_ZONE_CONTROL		0x4
-#define WMAX_METHOD_THERMAL_INFORMATION		0x14
-#define WMAX_METHOD_THERMAL_CONTROL		0x15
-#define WMAX_METHOD_GAME_SHIFT_STATUS		0x25
 
-#define WMAX_THERMAL_MODE_GMODE			0xAB
+#define AWCC_METHOD_THERMAL_INFORMATION		0x14
+#define AWCC_METHOD_THERMAL_CONTROL		0x15
+#define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
 
-#define WMAX_FAILURE_CODE			0xFFFFFFFF
-#define WMAX_THERMAL_TABLE_MASK			GENMASK(7, 4)
-#define WMAX_THERMAL_MODE_MASK			GENMASK(3, 0)
-#define WMAX_SENSOR_ID_MASK			BIT(8)
+#define AWCC_THERMAL_MODE_GMODE			0xAB
+
+#define AWCC_FAILURE_CODE			0xFFFFFFFF
+#define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
+#define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
+#define AWCC_SENSOR_ID_MASK			BIT(8)
 
 static bool force_platform_profile;
 module_param_unsafe(force_platform_profile, bool, 0);
@@ -151,38 +152,38 @@ static const struct dmi_system_id awcc_dmi_table[] __initconst = {
 	},
 };
 
-enum WMAX_THERMAL_INFORMATION_OPERATIONS {
-	WMAX_OPERATION_SYS_DESCRIPTION		= 0x02,
-	WMAX_OPERATION_LIST_IDS			= 0x03,
-	WMAX_OPERATION_CURRENT_PROFILE		= 0x0B,
+enum AWCC_THERMAL_INFORMATION_OPERATIONS {
+	AWCC_OP_GET_SYSTEM_DESCRIPTION		= 0x02,
+	AWCC_OP_GET_RESOURCE_ID			= 0x03,
+	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
 };
 
-enum WMAX_THERMAL_CONTROL_OPERATIONS {
-	WMAX_OPERATION_ACTIVATE_PROFILE		= 0x01,
+enum AWCC_THERMAL_CONTROL_OPERATIONS {
+	AWCC_OP_ACTIVATE_PROFILE		= 0x01,
 };
 
-enum WMAX_GAME_SHIFT_STATUS_OPERATIONS {
-	WMAX_OPERATION_TOGGLE_GAME_SHIFT	= 0x01,
-	WMAX_OPERATION_GET_GAME_SHIFT_STATUS	= 0x02,
+enum AWCC_GAME_SHIFT_STATUS_OPERATIONS {
+	AWCC_OP_TOGGLE_GAME_SHIFT		= 0x01,
+	AWCC_OP_GET_GAME_SHIFT_STATUS		= 0x02,
 };
 
-enum WMAX_THERMAL_TABLES {
-	WMAX_THERMAL_TABLE_BASIC		= 0x90,
-	WMAX_THERMAL_TABLE_USTT			= 0xA0,
+enum AWCC_THERMAL_TABLES {
+	AWCC_THERMAL_TABLE_LEGACY		= 0x90,
+	AWCC_THERMAL_TABLE_USTT			= 0xA0,
 };
 
-enum wmax_thermal_mode {
-	THERMAL_MODE_USTT_BALANCED,
-	THERMAL_MODE_USTT_BALANCED_PERFORMANCE,
-	THERMAL_MODE_USTT_COOL,
-	THERMAL_MODE_USTT_QUIET,
-	THERMAL_MODE_USTT_PERFORMANCE,
-	THERMAL_MODE_USTT_LOW_POWER,
-	THERMAL_MODE_BASIC_QUIET,
-	THERMAL_MODE_BASIC_BALANCED,
-	THERMAL_MODE_BASIC_BALANCED_PERFORMANCE,
-	THERMAL_MODE_BASIC_PERFORMANCE,
-	THERMAL_MODE_LAST,
+enum awcc_thermal_profile {
+	AWCC_PROFILE_USTT_BALANCED,
+	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
+	AWCC_PROFILE_USTT_COOL,
+	AWCC_PROFILE_USTT_QUIET,
+	AWCC_PROFILE_USTT_PERFORMANCE,
+	AWCC_PROFILE_USTT_LOW_POWER,
+	AWCC_PROFILE_LEGACY_QUIET,
+	AWCC_PROFILE_LEGACY_BALANCED,
+	AWCC_PROFILE_LEGACY_BALANCED_PERFORMANCE,
+	AWCC_PROFILE_LEGACY_PERFORMANCE,
+	AWCC_PROFILE_LAST,
 };
 
 struct wmax_led_args {
@@ -210,20 +211,20 @@ struct wmax_u32_args {
 struct awcc_priv {
 	struct wmi_device *wdev;
 	struct device *ppdev;
-	enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
+	enum awcc_thermal_profile supported_thermal_profiles[PLATFORM_PROFILE_LAST];
 };
 
-static const enum platform_profile_option wmax_mode_to_platform_profile[THERMAL_MODE_LAST] = {
-	[THERMAL_MODE_USTT_BALANCED]			= PLATFORM_PROFILE_BALANCED,
-	[THERMAL_MODE_USTT_BALANCED_PERFORMANCE]	= PLATFORM_PROFILE_BALANCED_PERFORMANCE,
-	[THERMAL_MODE_USTT_COOL]			= PLATFORM_PROFILE_COOL,
-	[THERMAL_MODE_USTT_QUIET]			= PLATFORM_PROFILE_QUIET,
-	[THERMAL_MODE_USTT_PERFORMANCE]			= PLATFORM_PROFILE_PERFORMANCE,
-	[THERMAL_MODE_USTT_LOW_POWER]			= PLATFORM_PROFILE_LOW_POWER,
-	[THERMAL_MODE_BASIC_QUIET]			= PLATFORM_PROFILE_QUIET,
-	[THERMAL_MODE_BASIC_BALANCED]			= PLATFORM_PROFILE_BALANCED,
-	[THERMAL_MODE_BASIC_BALANCED_PERFORMANCE]	= PLATFORM_PROFILE_BALANCED_PERFORMANCE,
-	[THERMAL_MODE_BASIC_PERFORMANCE]		= PLATFORM_PROFILE_PERFORMANCE,
+static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
+	[AWCC_PROFILE_USTT_BALANCED]			= PLATFORM_PROFILE_BALANCED,
+	[AWCC_PROFILE_USTT_BALANCED_PERFORMANCE]	= PLATFORM_PROFILE_BALANCED_PERFORMANCE,
+	[AWCC_PROFILE_USTT_COOL]			= PLATFORM_PROFILE_COOL,
+	[AWCC_PROFILE_USTT_QUIET]			= PLATFORM_PROFILE_QUIET,
+	[AWCC_PROFILE_USTT_PERFORMANCE]			= PLATFORM_PROFILE_PERFORMANCE,
+	[AWCC_PROFILE_USTT_LOW_POWER]			= PLATFORM_PROFILE_LOW_POWER,
+	[AWCC_PROFILE_LEGACY_QUIET]			= PLATFORM_PROFILE_QUIET,
+	[AWCC_PROFILE_LEGACY_BALANCED]			= PLATFORM_PROFILE_BALANCED,
+	[AWCC_PROFILE_LEGACY_BALANCED_PERFORMANCE]	= PLATFORM_PROFILE_BALANCED_PERFORMANCE,
+	[AWCC_PROFILE_LEGACY_PERFORMANCE]		= PLATFORM_PROFILE_PERFORMANCE,
 };
 
 static struct awcc_quirks *awcc;
@@ -444,26 +445,26 @@ const struct attribute_group wmax_deepsleep_attribute_group = {
  * Thermal Profile control
  *  - Provides thermal profile control through the Platform Profile API
  */
-static bool is_wmax_thermal_code(u32 code)
+static bool is_awcc_thermal_mode(u32 code)
 {
-	if (code & WMAX_SENSOR_ID_MASK)
+	if (code & AWCC_SENSOR_ID_MASK)
 		return false;
 
-	if ((code & WMAX_THERMAL_MODE_MASK) >= THERMAL_MODE_LAST)
+	if ((code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LAST)
 		return false;
 
-	if ((code & WMAX_THERMAL_TABLE_MASK) == WMAX_THERMAL_TABLE_BASIC &&
-	    (code & WMAX_THERMAL_MODE_MASK) >= THERMAL_MODE_BASIC_QUIET)
+	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_LEGACY &&
+	    (code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LEGACY_QUIET)
 		return true;
 
-	if ((code & WMAX_THERMAL_TABLE_MASK) == WMAX_THERMAL_TABLE_USTT &&
-	    (code & WMAX_THERMAL_MODE_MASK) <= THERMAL_MODE_USTT_LOW_POWER)
+	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_USTT &&
+	    (code & AWCC_THERMAL_MODE_MASK) <= AWCC_PROFILE_USTT_LOW_POWER)
 		return true;
 
 	return false;
 }
 
-static int wmax_thermal_information(struct wmi_device *wdev, u8 operation,
+static int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
 				    u8 arg, u32 *out_data)
 {
 	struct wmax_u32_args in_args = {
@@ -474,21 +475,21 @@ static int wmax_thermal_information(struct wmi_device *wdev, u8 operation,
 	};
 	int ret;
 
-	ret = alienware_wmi_command(wdev, WMAX_METHOD_THERMAL_INFORMATION,
+	ret = alienware_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION,
 				    &in_args, sizeof(in_args), out_data);
 	if (ret < 0)
 		return ret;
 
-	if (*out_data == WMAX_FAILURE_CODE)
+	if (*out_data == AWCC_FAILURE_CODE)
 		return -EBADRQC;
 
 	return 0;
 }
 
-static int wmax_thermal_control(struct wmi_device *wdev, u8 profile)
+static int awcc_thermal_control(struct wmi_device *wdev, u8 profile)
 {
 	struct wmax_u32_args in_args = {
-		.operation = WMAX_OPERATION_ACTIVATE_PROFILE,
+		.operation = AWCC_OP_ACTIVATE_PROFILE,
 		.arg1 = profile,
 		.arg2 = 0,
 		.arg3 = 0,
@@ -496,18 +497,18 @@ static int wmax_thermal_control(struct wmi_device *wdev, u8 profile)
 	u32 out_data;
 	int ret;
 
-	ret = alienware_wmi_command(wdev, WMAX_METHOD_THERMAL_CONTROL,
+	ret = alienware_wmi_command(wdev, AWCC_METHOD_THERMAL_CONTROL,
 				    &in_args, sizeof(in_args), &out_data);
 	if (ret)
 		return ret;
 
-	if (out_data == WMAX_FAILURE_CODE)
+	if (out_data == AWCC_FAILURE_CODE)
 		return -EBADRQC;
 
 	return 0;
 }
 
-static int wmax_game_shift_status(struct wmi_device *wdev, u8 operation,
+static int awcc_game_shift_status(struct wmi_device *wdev, u8 operation,
 				  u32 *out_data)
 {
 	struct wmax_u32_args in_args = {
@@ -518,46 +519,46 @@ static int wmax_game_shift_status(struct wmi_device *wdev, u8 operation,
 	};
 	int ret;
 
-	ret = alienware_wmi_command(wdev, WMAX_METHOD_GAME_SHIFT_STATUS,
+	ret = alienware_wmi_command(wdev, AWCC_METHOD_GAME_SHIFT_STATUS,
 				    &in_args, sizeof(in_args), out_data);
 	if (ret < 0)
 		return ret;
 
-	if (*out_data == WMAX_FAILURE_CODE)
+	if (*out_data == AWCC_FAILURE_CODE)
 		return -EOPNOTSUPP;
 
 	return 0;
 }
 
-static int thermal_profile_get(struct device *dev,
-			       enum platform_profile_option *profile)
+static int awcc_platform_profile_get(struct device *dev,
+				     enum platform_profile_option *profile)
 {
 	struct awcc_priv *priv = dev_get_drvdata(dev);
 	u32 out_data;
 	int ret;
 
-	ret = wmax_thermal_information(priv->wdev, WMAX_OPERATION_CURRENT_PROFILE,
+	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_CURRENT_PROFILE,
 				       0, &out_data);
 
 	if (ret < 0)
 		return ret;
 
-	if (out_data == WMAX_THERMAL_MODE_GMODE) {
+	if (out_data == AWCC_THERMAL_MODE_GMODE) {
 		*profile = PLATFORM_PROFILE_PERFORMANCE;
 		return 0;
 	}
 
-	if (!is_wmax_thermal_code(out_data))
+	if (!is_awcc_thermal_mode(out_data))
 		return -ENODATA;
 
-	out_data &= WMAX_THERMAL_MODE_MASK;
-	*profile = wmax_mode_to_platform_profile[out_data];
+	out_data &= AWCC_THERMAL_MODE_MASK;
+	*profile = awcc_mode_to_platform_profile[out_data];
 
 	return 0;
 }
 
-static int thermal_profile_set(struct device *dev,
-			       enum platform_profile_option profile)
+static int awcc_platform_profile_set(struct device *dev,
+				     enum platform_profile_option profile)
 {
 	struct awcc_priv *priv = dev_get_drvdata(dev);
 
@@ -565,8 +566,8 @@ static int thermal_profile_set(struct device *dev,
 		u32 gmode_status;
 		int ret;
 
-		ret = wmax_game_shift_status(priv->wdev,
-					     WMAX_OPERATION_GET_GAME_SHIFT_STATUS,
+		ret = awcc_game_shift_status(priv->wdev,
+					     AWCC_OP_GET_GAME_SHIFT_STATUS,
 					     &gmode_status);
 
 		if (ret < 0)
@@ -574,8 +575,8 @@ static int thermal_profile_set(struct device *dev,
 
 		if ((profile == PLATFORM_PROFILE_PERFORMANCE && !gmode_status) ||
 		    (profile != PLATFORM_PROFILE_PERFORMANCE && gmode_status)) {
-			ret = wmax_game_shift_status(priv->wdev,
-						     WMAX_OPERATION_TOGGLE_GAME_SHIFT,
+			ret = awcc_game_shift_status(priv->wdev,
+						     AWCC_OP_TOGGLE_GAME_SHIFT,
 						     &gmode_status);
 
 			if (ret < 0)
@@ -583,21 +584,21 @@ static int thermal_profile_set(struct device *dev,
 		}
 	}
 
-	return wmax_thermal_control(priv->wdev,
+	return awcc_thermal_control(priv->wdev,
 				    priv->supported_thermal_profiles[profile]);
 }
 
-static int thermal_profile_probe(void *drvdata, unsigned long *choices)
+static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 {
 	enum platform_profile_option profile;
 	struct awcc_priv *priv = drvdata;
-	enum wmax_thermal_mode mode;
+	enum awcc_thermal_profile mode;
 	u8 sys_desc[4];
 	u32 first_mode;
 	u32 out_data;
 	int ret;
 
-	ret = wmax_thermal_information(priv->wdev, WMAX_OPERATION_SYS_DESCRIPTION,
+	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
 				       0, (u32 *) &sys_desc);
 	if (ret < 0)
 		return ret;
@@ -605,7 +606,7 @@ static int thermal_profile_probe(void *drvdata, unsigned long *choices)
 	first_mode = sys_desc[0] + sys_desc[1];
 
 	for (u32 i = 0; i < sys_desc[3]; i++) {
-		ret = wmax_thermal_information(priv->wdev, WMAX_OPERATION_LIST_IDS,
+		ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_RESOURCE_ID,
 					       i + first_mode, &out_data);
 
 		if (ret == -EIO)
@@ -614,11 +615,11 @@ static int thermal_profile_probe(void *drvdata, unsigned long *choices)
 		if (ret == -EBADRQC)
 			break;
 
-		if (!is_wmax_thermal_code(out_data))
+		if (!is_awcc_thermal_mode(out_data))
 			continue;
 
-		mode = out_data & WMAX_THERMAL_MODE_MASK;
-		profile = wmax_mode_to_platform_profile[mode];
+		mode = out_data & AWCC_THERMAL_MODE_MASK;
+		profile = awcc_mode_to_platform_profile[mode];
 		priv->supported_thermal_profiles[profile] = out_data;
 
 		set_bit(profile, choices);
@@ -629,7 +630,7 @@ static int thermal_profile_probe(void *drvdata, unsigned long *choices)
 
 	if (awcc->gmode) {
 		priv->supported_thermal_profiles[PLATFORM_PROFILE_PERFORMANCE] =
-			WMAX_THERMAL_MODE_GMODE;
+			AWCC_THERMAL_MODE_GMODE;
 
 		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
 	}
@@ -638,9 +639,9 @@ static int thermal_profile_probe(void *drvdata, unsigned long *choices)
 }
 
 static const struct platform_profile_ops awcc_platform_profile_ops = {
-	.probe = thermal_profile_probe,
-	.profile_get = thermal_profile_get,
-	.profile_set = thermal_profile_set,
+	.probe = awcc_platform_profile_probe,
+	.profile_get = awcc_platform_profile_get,
+	.profile_set = awcc_platform_profile_set,
 };
 
 static int awcc_platform_profile_init(struct wmi_device *wdev)
-- 
2.48.1

[PATCH v2 02/10] platform/x86: alienware-wmi-wmax: Refactor is_awcc_thermal_mode()

[Kurt Borja]

Refactor is_awcc_thermal_mode() to use FIELD_GET() instead of bitwise
operations. Drop the check for BIT(8) sensor flag and rename it to
is_awcc_thermal_profile_id().

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 31 ++++++++++---------
 1 file changed, 16 insertions(+), 15 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index ed70e12d73d7..7f0aa88221d6 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -34,7 +34,7 @@
 #define AWCC_FAILURE_CODE			0xFFFFFFFF
 #define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
 #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
-#define AWCC_SENSOR_ID_MASK			BIT(8)
+#define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
 
 static bool force_platform_profile;
 module_param_unsafe(force_platform_profile, bool, 0);
@@ -168,8 +168,8 @@ enum AWCC_GAME_SHIFT_STATUS_OPERATIONS {
 };
 
 enum AWCC_THERMAL_TABLES {
-	AWCC_THERMAL_TABLE_LEGACY		= 0x90,
-	AWCC_THERMAL_TABLE_USTT			= 0xA0,
+	AWCC_THERMAL_TABLE_LEGACY		= 0x9,
+	AWCC_THERMAL_TABLE_USTT			= 0xA,
 };
 
 enum awcc_thermal_profile {
@@ -445,20 +445,18 @@ const struct attribute_group wmax_deepsleep_attribute_group = {
  * Thermal Profile control
  *  - Provides thermal profile control through the Platform Profile API
  */
-static bool is_awcc_thermal_mode(u32 code)
+static bool is_awcc_thermal_profile_id(u8 code)
 {
-	if (code & AWCC_SENSOR_ID_MASK)
-		return false;
+	u8 table = FIELD_GET(AWCC_THERMAL_TABLE_MASK, code);
+	u8 mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, code);
 
-	if ((code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LAST)
+	if (mode >= AWCC_PROFILE_LAST)
 		return false;
 
-	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_LEGACY &&
-	    (code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LEGACY_QUIET)
+	if (table == AWCC_THERMAL_TABLE_LEGACY && mode >= AWCC_PROFILE_LEGACY_QUIET)
 		return true;
 
-	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_USTT &&
-	    (code & AWCC_THERMAL_MODE_MASK) <= AWCC_PROFILE_USTT_LOW_POWER)
+	if (table == AWCC_THERMAL_TABLE_USTT && mode <= AWCC_PROFILE_USTT_LOW_POWER)
 		return true;
 
 	return false;
@@ -548,7 +546,7 @@ static int awcc_platform_profile_get(struct device *dev,
 		return 0;
 	}
 
-	if (!is_awcc_thermal_mode(out_data))
+	if (!is_awcc_thermal_profile_id(out_data))
 		return -ENODATA;
 
 	out_data &= AWCC_THERMAL_MODE_MASK;
@@ -597,6 +595,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 	u32 first_mode;
 	u32 out_data;
 	int ret;
+	u8 id;
 
 	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
 				       0, (u32 *) &sys_desc);
@@ -615,12 +614,14 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 		if (ret == -EBADRQC)
 			break;
 
-		if (!is_awcc_thermal_mode(out_data))
+		/* Some IDs have a BIT(8) flag that should be ignored */
+		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
+		if (!is_awcc_thermal_profile_id(id))
 			continue;
 
-		mode = out_data & AWCC_THERMAL_MODE_MASK;
+		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
 		profile = awcc_mode_to_platform_profile[mode];
-		priv->supported_thermal_profiles[profile] = out_data;
+		priv->supported_thermal_profiles[profile] = id;
 
 		set_bit(profile, choices);
 	}
-- 
2.48.1

Re: [PATCH v2 02/10] platform/x86: alienware-wmi-wmax: Refactor is_awcc_thermal_mode()

[Ilpo Järvinen]

On Tue, 25 Feb 2025, Kurt Borja wrote:

> Refactor is_awcc_thermal_mode() to use FIELD_GET() instead of bitwise
> operations. Drop the check for BIT(8) sensor flag and rename it to
> is_awcc_thermal_profile_id().
> 
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
> ---
>  .../platform/x86/dell/alienware-wmi-wmax.c    | 31 ++++++++++---------
>  1 file changed, 16 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index ed70e12d73d7..7f0aa88221d6 100644
> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> @@ -34,7 +34,7 @@
>  #define AWCC_FAILURE_CODE			0xFFFFFFFF
>  #define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
>  #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
> -#define AWCC_SENSOR_ID_MASK			BIT(8)
> +#define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
>  
>  static bool force_platform_profile;
>  module_param_unsafe(force_platform_profile, bool, 0);
> @@ -168,8 +168,8 @@ enum AWCC_GAME_SHIFT_STATUS_OPERATIONS {
>  };
>  
>  enum AWCC_THERMAL_TABLES {
> -	AWCC_THERMAL_TABLE_LEGACY		= 0x90,
> -	AWCC_THERMAL_TABLE_USTT			= 0xA0,
> +	AWCC_THERMAL_TABLE_LEGACY		= 0x9,
> +	AWCC_THERMAL_TABLE_USTT			= 0xA,
>  };
>  
>  enum awcc_thermal_profile {
> @@ -445,20 +445,18 @@ const struct attribute_group wmax_deepsleep_attribute_group = {
>   * Thermal Profile control
>   *  - Provides thermal profile control through the Platform Profile API
>   */
> -static bool is_awcc_thermal_mode(u32 code)
> +static bool is_awcc_thermal_profile_id(u8 code)
>  {
> -	if (code & AWCC_SENSOR_ID_MASK)
> -		return false;
> +	u8 table = FIELD_GET(AWCC_THERMAL_TABLE_MASK, code);
> +	u8 mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, code);
>  
> -	if ((code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LAST)
> +	if (mode >= AWCC_PROFILE_LAST)
>  		return false;
>  
> -	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_LEGACY &&
> -	    (code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LEGACY_QUIET)
> +	if (table == AWCC_THERMAL_TABLE_LEGACY && mode >= AWCC_PROFILE_LEGACY_QUIET)
>  		return true;
>  
> -	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_USTT &&
> -	    (code & AWCC_THERMAL_MODE_MASK) <= AWCC_PROFILE_USTT_LOW_POWER)
> +	if (table == AWCC_THERMAL_TABLE_USTT && mode <= AWCC_PROFILE_USTT_LOW_POWER)
>  		return true;
>  
>  	return false;
> @@ -548,7 +546,7 @@ static int awcc_platform_profile_get(struct device *dev,
>  		return 0;
>  	}
>  
> -	if (!is_awcc_thermal_mode(out_data))
> +	if (!is_awcc_thermal_profile_id(out_data))
>  		return -ENODATA;
>  
>  	out_data &= AWCC_THERMAL_MODE_MASK;
> @@ -597,6 +595,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  	u32 first_mode;
>  	u32 out_data;
>  	int ret;
> +	u8 id;
>  
>  	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
>  				       0, (u32 *) &sys_desc);
> @@ -615,12 +614,14 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  		if (ret == -EBADRQC)
>  			break;
>  
> -		if (!is_awcc_thermal_mode(out_data))
> +		/* Some IDs have a BIT(8) flag that should be ignored */

I find the place of this comment odd. If you want to keep it, it should be 
next to the GENMASK() as in this place I'm trying to find the code that 
implements what you commented but its nowhere near here.

> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
> +		if (!is_awcc_thermal_profile_id(id))
>  			continue;
>  
> -		mode = out_data & AWCC_THERMAL_MODE_MASK;
> +		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
>  		profile = awcc_mode_to_platform_profile[mode];
> -		priv->supported_thermal_profiles[profile] = out_data;
> +		priv->supported_thermal_profiles[profile] = id;
>  
>  		set_bit(profile, choices);
>  	}
> 

-- 
 i.

Re: [PATCH v2 02/10] platform/x86: alienware-wmi-wmax: Refactor is_awcc_thermal_mode()

[Kurt Borja]

Hi Ilpo,

On Tue Mar 4, 2025 at 10:02 AM -05, Ilpo Järvinen wrote:
> On Tue, 25 Feb 2025, Kurt Borja wrote:
>
>> Refactor is_awcc_thermal_mode() to use FIELD_GET() instead of bitwise
>> operations. Drop the check for BIT(8) sensor flag and rename it to
>> is_awcc_thermal_profile_id().
>> 
>> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
>> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
>> ---
>>  .../platform/x86/dell/alienware-wmi-wmax.c    | 31 ++++++++++---------
>>  1 file changed, 16 insertions(+), 15 deletions(-)
>> 
>> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> index ed70e12d73d7..7f0aa88221d6 100644
>> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> @@ -34,7 +34,7 @@
>>  #define AWCC_FAILURE_CODE			0xFFFFFFFF
>>  #define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
>>  #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
>> -#define AWCC_SENSOR_ID_MASK			BIT(8)
>> +#define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
>>  
>>  static bool force_platform_profile;
>>  module_param_unsafe(force_platform_profile, bool, 0);
>> @@ -168,8 +168,8 @@ enum AWCC_GAME_SHIFT_STATUS_OPERATIONS {
>>  };
>>  
>>  enum AWCC_THERMAL_TABLES {
>> -	AWCC_THERMAL_TABLE_LEGACY		= 0x90,
>> -	AWCC_THERMAL_TABLE_USTT			= 0xA0,
>> +	AWCC_THERMAL_TABLE_LEGACY		= 0x9,
>> +	AWCC_THERMAL_TABLE_USTT			= 0xA,
>>  };
>>  
>>  enum awcc_thermal_profile {
>> @@ -445,20 +445,18 @@ const struct attribute_group wmax_deepsleep_attribute_group = {
>>   * Thermal Profile control
>>   *  - Provides thermal profile control through the Platform Profile API
>>   */
>> -static bool is_awcc_thermal_mode(u32 code)
>> +static bool is_awcc_thermal_profile_id(u8 code)
>>  {
>> -	if (code & AWCC_SENSOR_ID_MASK)
>> -		return false;
>> +	u8 table = FIELD_GET(AWCC_THERMAL_TABLE_MASK, code);
>> +	u8 mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, code);
>>  
>> -	if ((code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LAST)
>> +	if (mode >= AWCC_PROFILE_LAST)
>>  		return false;
>>  
>> -	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_LEGACY &&
>> -	    (code & AWCC_THERMAL_MODE_MASK) >= AWCC_PROFILE_LEGACY_QUIET)
>> +	if (table == AWCC_THERMAL_TABLE_LEGACY && mode >= AWCC_PROFILE_LEGACY_QUIET)
>>  		return true;
>>  
>> -	if ((code & AWCC_THERMAL_TABLE_MASK) == AWCC_THERMAL_TABLE_USTT &&
>> -	    (code & AWCC_THERMAL_MODE_MASK) <= AWCC_PROFILE_USTT_LOW_POWER)
>> +	if (table == AWCC_THERMAL_TABLE_USTT && mode <= AWCC_PROFILE_USTT_LOW_POWER)
>>  		return true;
>>  
>>  	return false;
>> @@ -548,7 +546,7 @@ static int awcc_platform_profile_get(struct device *dev,
>>  		return 0;
>>  	}
>>  
>> -	if (!is_awcc_thermal_mode(out_data))
>> +	if (!is_awcc_thermal_profile_id(out_data))
>>  		return -ENODATA;
>>  
>>  	out_data &= AWCC_THERMAL_MODE_MASK;
>> @@ -597,6 +595,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>>  	u32 first_mode;
>>  	u32 out_data;
>>  	int ret;
>> +	u8 id;
>>  
>>  	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
>>  				       0, (u32 *) &sys_desc);
>> @@ -615,12 +614,14 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>>  		if (ret == -EBADRQC)
>>  			break;
>>  
>> -		if (!is_awcc_thermal_mode(out_data))
>> +		/* Some IDs have a BIT(8) flag that should be ignored */
>
> I find the place of this comment odd. If you want to keep it, it should be 
> next to the GENMASK() as in this place I'm trying to find the code that 
> implements what you commented but its nowhere near here.

I placed it here because the FIELD_GET bellow implicitly ignores the
flag. But I agree, I'll move it next to the GENMASK definition.

-- 
 ~ Kurt

>
>> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
>> +		if (!is_awcc_thermal_profile_id(id))
>>  			continue;
>>  
>> -		mode = out_data & AWCC_THERMAL_MODE_MASK;
>> +		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
>>  		profile = awcc_mode_to_platform_profile[mode];
>> -		priv->supported_thermal_profiles[profile] = out_data;
>> +		priv->supported_thermal_profiles[profile] = id;
>>  
>>  		set_bit(profile, choices);
>>  	}
>> 

[PATCH v2 03/10] platform/x86: alienware-wmi-wmax: Improve internal AWCC API

[Kurt Borja]

Inline all AWCC WMI helper methods and directly return the newly
introduced __awcc_wmi_command() to simplify implementation. Additionally
make wmax_u32_args __packed, add an additional failure code and add a
helper with documentation for AWCC_OP_GET_RESOURCE_ID.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 104 +++++++++++-------
 1 file changed, 63 insertions(+), 41 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 7f0aa88221d6..57897a0f4296 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -32,6 +32,7 @@
 #define AWCC_THERMAL_MODE_GMODE			0xAB
 
 #define AWCC_FAILURE_CODE			0xFFFFFFFF
+#define AWCC_FAILURE_CODE_2			0xFFFFFFFE
 #define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
 #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
 #define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
@@ -206,7 +207,7 @@ struct wmax_u32_args {
 	u8 arg1;
 	u8 arg2;
 	u8 arg3;
-};
+} __packed;
 
 struct awcc_priv {
 	struct wmi_device *wdev;
@@ -442,8 +443,7 @@ const struct attribute_group wmax_deepsleep_attribute_group = {
 };
 
 /*
- * Thermal Profile control
- *  - Provides thermal profile control through the Platform Profile API
+ * AWCC Helpers
  */
 static bool is_awcc_thermal_profile_id(u8 code)
 {
@@ -462,72 +462,95 @@ static bool is_awcc_thermal_profile_id(u8 code)
 	return false;
 }
 
-static int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
-				    u8 arg, u32 *out_data)
+static int __awcc_wmi_command(struct wmi_device *wdev, u32 method_id,
+			      struct wmax_u32_args *args, u32 *out)
 {
-	struct wmax_u32_args in_args = {
-		.operation = operation,
-		.arg1 = arg,
-		.arg2 = 0,
-		.arg3 = 0,
-	};
 	int ret;
 
-	ret = alienware_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION,
-				    &in_args, sizeof(in_args), out_data);
-	if (ret < 0)
+	ret = alienware_wmi_command(wdev, method_id, args, sizeof(*args), out);
+	if (ret)
 		return ret;
 
-	if (*out_data == AWCC_FAILURE_CODE)
+	if (*out == AWCC_FAILURE_CODE || *out == AWCC_FAILURE_CODE_2)
 		return -EBADRQC;
 
 	return 0;
 }
 
-static int awcc_thermal_control(struct wmi_device *wdev, u8 profile)
+static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
+					   u8 arg, u32 *out)
 {
-	struct wmax_u32_args in_args = {
-		.operation = AWCC_OP_ACTIVATE_PROFILE,
-		.arg1 = profile,
+	struct wmax_u32_args args = {
+		.operation = operation,
+		.arg1 = arg,
 		.arg2 = 0,
 		.arg3 = 0,
 	};
-	u32 out_data;
-	int ret;
 
-	ret = alienware_wmi_command(wdev, AWCC_METHOD_THERMAL_CONTROL,
-				    &in_args, sizeof(in_args), &out_data);
-	if (ret)
-		return ret;
+	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
+}
 
-	if (out_data == AWCC_FAILURE_CODE)
-		return -EBADRQC;
+static inline int awcc_thermal_control(struct wmi_device *wdev, u8 profile)
+{
+	struct wmax_u32_args args = {
+		.operation = AWCC_OP_ACTIVATE_PROFILE,
+		.arg1 = profile,
+		.arg2 = 0,
+		.arg3 = 0,
+	};
+	u32 out;
 
-	return 0;
+	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_CONTROL, &args, &out);
 }
 
-static int awcc_game_shift_status(struct wmi_device *wdev, u8 operation,
-				  u32 *out_data)
+static inline int awcc_game_shift_status(struct wmi_device *wdev, u8 operation,
+					 u32 *out)
 {
-	struct wmax_u32_args in_args = {
+	struct wmax_u32_args args = {
 		.operation = operation,
 		.arg1 = 0,
 		.arg2 = 0,
 		.arg3 = 0,
 	};
-	int ret;
 
-	ret = alienware_wmi_command(wdev, AWCC_METHOD_GAME_SHIFT_STATUS,
-				    &in_args, sizeof(in_args), out_data);
-	if (ret < 0)
-		return ret;
+	return __awcc_wmi_command(wdev, AWCC_METHOD_GAME_SHIFT_STATUS, &args, out);
+}
 
-	if (*out_data == AWCC_FAILURE_CODE)
-		return -EOPNOTSUPP;
+/**
+ * awcc_op_get_resource_id - Get the resource ID at a given index
+ * @wdev: AWCC WMI device
+ * @index: Index
+ * @out: Value returned by the WMI call
+ *
+ * Get the resource ID at a given index. Resource IDs are listed in the
+ * following order:
+ *
+ *	- Fan IDs
+ *	- Sensor IDs
+ *	- Unknown IDs
+ *	- Thermal Profile IDs
+ *
+ * The total number of IDs of a given type can be obtained with
+ * AWCC_OP_GET_SYSTEM_DESCRIPTION.
+ *
+ * Return: 0 on success, -errno on failure
+ */
+static inline int awcc_op_get_resource_id(struct wmi_device *wdev, u8 index, u32 *out)
+{
+	struct wmax_u32_args args = {
+		.operation = AWCC_OP_GET_RESOURCE_ID,
+		.arg1 = index,
+		.arg2 = 0,
+		.arg3 = 0,
+	};
 
-	return 0;
+	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
 }
 
+/*
+ * Thermal Profile control
+ *  - Provides thermal profile control through the Platform Profile API
+ */
 static int awcc_platform_profile_get(struct device *dev,
 				     enum platform_profile_option *profile)
 {
@@ -605,8 +628,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 	first_mode = sys_desc[0] + sys_desc[1];
 
 	for (u32 i = 0; i < sys_desc[3]; i++) {
-		ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_RESOURCE_ID,
-					       i + first_mode, &out_data);
+		ret = awcc_op_get_resource_id(priv->wdev, i + first_mode, &out_data);
 
 		if (ret == -EIO)
 			return ret;
-- 
2.48.1

[PATCH v2 04/10] platform/x86: alienware-wmi-wmax: Modify supported_thermal_profiles[]

[Kurt Borja]

Rename supported_thermal_profiles[] -> supported_profiles[] and change
it's type to u8 because it stores AWCC thermal IDs.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 drivers/platform/x86/dell/alienware-wmi-wmax.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 57897a0f4296..4a8335d90b5d 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -212,7 +212,7 @@ struct wmax_u32_args {
 struct awcc_priv {
 	struct wmi_device *wdev;
 	struct device *ppdev;
-	enum awcc_thermal_profile supported_thermal_profiles[PLATFORM_PROFILE_LAST];
+	u8 supported_profiles[PLATFORM_PROFILE_LAST];
 };
 
 static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
@@ -606,7 +606,7 @@ static int awcc_platform_profile_set(struct device *dev,
 	}
 
 	return awcc_thermal_control(priv->wdev,
-				    priv->supported_thermal_profiles[profile]);
+				    priv->supported_profiles[profile]);
 }
 
 static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
@@ -643,7 +643,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 
 		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
 		profile = awcc_mode_to_platform_profile[mode];
-		priv->supported_thermal_profiles[profile] = id;
+		priv->supported_profiles[profile] = id;
 
 		set_bit(profile, choices);
 	}
@@ -652,7 +652,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 		return -ENODEV;
 
 	if (awcc->gmode) {
-		priv->supported_thermal_profiles[PLATFORM_PROFILE_PERFORMANCE] =
+		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
 			AWCC_THERMAL_MODE_GMODE;
 
 		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
-- 
2.48.1

Re: [PATCH v2 04/10] platform/x86: alienware-wmi-wmax: Modify supported_thermal_profiles[]

[Ilpo Järvinen]

[-- Attachment #1: Type: text/plain, Size: 2176 bytes --]

On Tue, 25 Feb 2025, Kurt Borja wrote:

> Rename supported_thermal_profiles[] -> supported_profiles[] and change
> it's type to u8 because it stores AWCC thermal IDs.
> 
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
> ---
>  drivers/platform/x86/dell/alienware-wmi-wmax.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index 57897a0f4296..4a8335d90b5d 100644
> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> @@ -212,7 +212,7 @@ struct wmax_u32_args {
>  struct awcc_priv {
>  	struct wmi_device *wdev;
>  	struct device *ppdev;
> -	enum awcc_thermal_profile supported_thermal_profiles[PLATFORM_PROFILE_LAST];
> +	u8 supported_profiles[PLATFORM_PROFILE_LAST];
>  };
>  
>  static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
> @@ -606,7 +606,7 @@ static int awcc_platform_profile_set(struct device *dev,
>  	}
>  
>  	return awcc_thermal_control(priv->wdev,
> -				    priv->supported_thermal_profiles[profile]);
> +				    priv->supported_profiles[profile]);
>  }
>  
>  static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
> @@ -643,7 +643,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  
>  		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
>  		profile = awcc_mode_to_platform_profile[mode];
> -		priv->supported_thermal_profiles[profile] = id;
> +		priv->supported_profiles[profile] = id;
>  
>  		set_bit(profile, choices);
>  	}
> @@ -652,7 +652,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  		return -ENODEV;
>  
>  	if (awcc->gmode) {
> -		priv->supported_thermal_profiles[PLATFORM_PROFILE_PERFORMANCE] =
> +		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
>  			AWCC_THERMAL_MODE_GMODE;
>  
>  		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
> 

Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

-- 
 i.

[PATCH v2 05/10] platform/x86: alienware-wmi-wmax: Improve platform profile probe

[Kurt Borja]

Get and store the AWCC system description in alienware_awcc_setup()
instead of awcc_platform_profile_probe() and add a check for integer
overflows to avoid misbehaviors.

While at it, replace set_bit() with it's non-atomic version __set_bit()
because `choices` belong to this thread only.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 61 ++++++++++++++-----
 1 file changed, 46 insertions(+), 15 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 4a8335d90b5d..965b427f8f0a 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -37,6 +37,9 @@
 #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
 #define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
 
+/* Arbitrary limit based on supported models */
+#define AWCC_MAX_RES_COUNT			16
+
 static bool force_platform_profile;
 module_param_unsafe(force_platform_profile, bool, 0);
 MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
@@ -211,6 +214,17 @@ struct wmax_u32_args {
 
 struct awcc_priv {
 	struct wmi_device *wdev;
+	union {
+		u32 system_description;
+		struct {
+			u8 fan_count;
+			u8 temp_count;
+			u8 unknown_count;
+			u8 profile_count;
+		} __packed;
+		u8 res_count[4];
+	} __packed;
+
 	struct device *ppdev;
 	u8 supported_profiles[PLATFORM_PROFILE_LAST];
 };
@@ -614,38 +628,41 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 	enum platform_profile_option profile;
 	struct awcc_priv *priv = drvdata;
 	enum awcc_thermal_profile mode;
-	u8 sys_desc[4];
-	u32 first_mode;
+	u8 id, offset = 0;
 	u32 out_data;
 	int ret;
-	u8 id;
 
-	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
-				       0, (u32 *) &sys_desc);
-	if (ret < 0)
-		return ret;
-
-	first_mode = sys_desc[0] + sys_desc[1];
-
-	for (u32 i = 0; i < sys_desc[3]; i++) {
-		ret = awcc_op_get_resource_id(priv->wdev, i + first_mode, &out_data);
+	/*
+	 * Thermal profile IDs are listed last at offset
+	 *	fan_count + temp_count + unknown_count
+	 */
+	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count) - 1; i++)
+		offset += priv->res_count[i];
 
+	for (unsigned int i = 0; i < priv->profile_count; i++) {
+		ret = awcc_op_get_resource_id(priv->wdev, i + offset, &out_data);
 		if (ret == -EIO)
 			return ret;
 
+		/*
+		 * Some devices report an incorrect number of thermal profiles
+		 * so the resource ID list may end prematurely
+		 */
 		if (ret == -EBADRQC)
 			break;
 
 		/* Some IDs have a BIT(8) flag that should be ignored */
 		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
-		if (!is_awcc_thermal_profile_id(id))
+		if (!is_awcc_thermal_profile_id(id)) {
+			dev_dbg(&priv->wdev->dev, "Unmapped thermal profile ID 0x%02x\n", id);
 			continue;
+		}
 
 		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
 		profile = awcc_mode_to_platform_profile[mode];
 		priv->supported_profiles[profile] = id;
 
-		set_bit(profile, choices);
+		__set_bit(profile, choices);
 	}
 
 	if (bitmap_empty(choices, PLATFORM_PROFILE_LAST))
@@ -655,7 +672,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
 			AWCC_THERMAL_MODE_GMODE;
 
-		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
+		__set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
 	}
 
 	return 0;
@@ -686,6 +703,20 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
 	if (!priv)
 		return -ENOMEM;
 
+	ret = awcc_thermal_information(wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
+				       0, &priv->system_description);
+	if (ret < 0)
+		return ret;
+
+	/* Sanity check */
+	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count); i++) {
+		if (priv->res_count[i] > AWCC_MAX_RES_COUNT) {
+			dev_err(&wdev->dev, "Malformed system description: 0x%08x\n",
+				priv->system_description);
+			return -ENXIO;
+		}
+	}
+
 	priv->wdev = wdev;
 	dev_set_drvdata(&wdev->dev, priv);
 
-- 
2.48.1

Re: [PATCH v2 05/10] platform/x86: alienware-wmi-wmax: Improve platform profile probe

[Ilpo Järvinen]

On Tue, 25 Feb 2025, Kurt Borja wrote:

> Get and store the AWCC system description in alienware_awcc_setup()
> instead of awcc_platform_profile_probe() and add a check for integer
> overflows to avoid misbehaviors.
> 
> While at it, replace set_bit() with it's non-atomic version __set_bit()
> because `choices` belong to this thread only.
> 
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
> ---
>  .../platform/x86/dell/alienware-wmi-wmax.c    | 61 ++++++++++++++-----
>  1 file changed, 46 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index 4a8335d90b5d..965b427f8f0a 100644
> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> @@ -37,6 +37,9 @@
>  #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
>  #define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
>  
> +/* Arbitrary limit based on supported models */
> +#define AWCC_MAX_RES_COUNT			16
> +
>  static bool force_platform_profile;
>  module_param_unsafe(force_platform_profile, bool, 0);
>  MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
> @@ -211,6 +214,17 @@ struct wmax_u32_args {
>  
>  struct awcc_priv {
>  	struct wmi_device *wdev;
> +	union {
> +		u32 system_description;
> +		struct {
> +			u8 fan_count;
> +			u8 temp_count;
> +			u8 unknown_count;
> +			u8 profile_count;
> +		} __packed;
> +		u8 res_count[4];
> +	} __packed;

I don't like it how __packed is now creeping its way into priv structure 
too. It doesn't even seem useful in this case as all those are naturally 
aligned and take 4 bytes, AFAICT. Why did you add it?

> +
>  	struct device *ppdev;
>  	u8 supported_profiles[PLATFORM_PROFILE_LAST];
>  };
> @@ -614,38 +628,41 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  	enum platform_profile_option profile;
>  	struct awcc_priv *priv = drvdata;
>  	enum awcc_thermal_profile mode;
> -	u8 sys_desc[4];
> -	u32 first_mode;
> +	u8 id, offset = 0;
>  	u32 out_data;
>  	int ret;
> -	u8 id;
>  
> -	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
> -				       0, (u32 *) &sys_desc);
> -	if (ret < 0)
> -		return ret;
> -
> -	first_mode = sys_desc[0] + sys_desc[1];
> -
> -	for (u32 i = 0; i < sys_desc[3]; i++) {
> -		ret = awcc_op_get_resource_id(priv->wdev, i + first_mode, &out_data);
> +	/*
> +	 * Thermal profile IDs are listed last at offset
> +	 *	fan_count + temp_count + unknown_count
> +	 */
> +	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count) - 1; i++)
> +		offset += priv->res_count[i];
>  
> +	for (unsigned int i = 0; i < priv->profile_count; i++) {
> +		ret = awcc_op_get_resource_id(priv->wdev, i + offset, &out_data);
>  		if (ret == -EIO)
>  			return ret;
>  
> +		/*
> +		 * Some devices report an incorrect number of thermal profiles
> +		 * so the resource ID list may end prematurely
> +		 */
>  		if (ret == -EBADRQC)
>  			break;
>  
>  		/* Some IDs have a BIT(8) flag that should be ignored */
>  		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
> -		if (!is_awcc_thermal_profile_id(id))
> +		if (!is_awcc_thermal_profile_id(id)) {
> +			dev_dbg(&priv->wdev->dev, "Unmapped thermal profile ID 0x%02x\n", id);
>  			continue;
> +		}
>  
>  		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
>  		profile = awcc_mode_to_platform_profile[mode];
>  		priv->supported_profiles[profile] = id;
>  
> -		set_bit(profile, choices);
> +		__set_bit(profile, choices);
>  	}
>  
>  	if (bitmap_empty(choices, PLATFORM_PROFILE_LAST))
> @@ -655,7 +672,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>  		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
>  			AWCC_THERMAL_MODE_GMODE;
>  
> -		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
> +		__set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
>  	}
>  
>  	return 0;
> @@ -686,6 +703,20 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>  	if (!priv)
>  		return -ENOMEM;
>  
> +	ret = awcc_thermal_information(wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
> +				       0, &priv->system_description);
> +	if (ret < 0)
> +		return ret;
> +
> +	/* Sanity check */
> +	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count); i++) {
> +		if (priv->res_count[i] > AWCC_MAX_RES_COUNT) {
> +			dev_err(&wdev->dev, "Malformed system description: 0x%08x\n",
> +				priv->system_description);
> +			return -ENXIO;
> +		}
> +	}
> +
>  	priv->wdev = wdev;
>  	dev_set_drvdata(&wdev->dev, priv);
>  
> 

-- 
 i.

Re: [PATCH v2 05/10] platform/x86: alienware-wmi-wmax: Improve platform profile probe

[Kurt Borja]

On Tue Mar 4, 2025 at 10:40 AM -05, Ilpo Järvinen wrote:
> On Tue, 25 Feb 2025, Kurt Borja wrote:
>
>> Get and store the AWCC system description in alienware_awcc_setup()
>> instead of awcc_platform_profile_probe() and add a check for integer
>> overflows to avoid misbehaviors.
>> 
>> While at it, replace set_bit() with it's non-atomic version __set_bit()
>> because `choices` belong to this thread only.
>> 
>> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
>> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
>> ---
>>  .../platform/x86/dell/alienware-wmi-wmax.c    | 61 ++++++++++++++-----
>>  1 file changed, 46 insertions(+), 15 deletions(-)
>> 
>> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> index 4a8335d90b5d..965b427f8f0a 100644
>> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> @@ -37,6 +37,9 @@
>>  #define AWCC_THERMAL_MODE_MASK			GENMASK(3, 0)
>>  #define AWCC_RESOURCE_ID_MASK			GENMASK(7, 0)
>>  
>> +/* Arbitrary limit based on supported models */
>> +#define AWCC_MAX_RES_COUNT			16
>> +
>>  static bool force_platform_profile;
>>  module_param_unsafe(force_platform_profile, bool, 0);
>>  MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
>> @@ -211,6 +214,17 @@ struct wmax_u32_args {
>>  
>>  struct awcc_priv {
>>  	struct wmi_device *wdev;
>> +	union {
>> +		u32 system_description;
>> +		struct {
>> +			u8 fan_count;
>> +			u8 temp_count;
>> +			u8 unknown_count;
>> +			u8 profile_count;
>> +		} __packed;
>> +		u8 res_count[4];
>> +	} __packed;
>
> I don't like it how __packed is now creeping its way into priv structure 
> too. It doesn't even seem useful in this case as all those are naturally 
> aligned and take 4 bytes, AFAICT. Why did you add it?

You are right, I think alignment here is already guaranteed. Alignment
is still a bit confusing for me.

I'll drop it for v3.

-- 
 ~ Kurt

>
>> +
>>  	struct device *ppdev;
>>  	u8 supported_profiles[PLATFORM_PROFILE_LAST];
>>  };
>> @@ -614,38 +628,41 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>>  	enum platform_profile_option profile;
>>  	struct awcc_priv *priv = drvdata;
>>  	enum awcc_thermal_profile mode;
>> -	u8 sys_desc[4];
>> -	u32 first_mode;
>> +	u8 id, offset = 0;
>>  	u32 out_data;
>>  	int ret;
>> -	u8 id;
>>  
>> -	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
>> -				       0, (u32 *) &sys_desc);
>> -	if (ret < 0)
>> -		return ret;
>> -
>> -	first_mode = sys_desc[0] + sys_desc[1];
>> -
>> -	for (u32 i = 0; i < sys_desc[3]; i++) {
>> -		ret = awcc_op_get_resource_id(priv->wdev, i + first_mode, &out_data);
>> +	/*
>> +	 * Thermal profile IDs are listed last at offset
>> +	 *	fan_count + temp_count + unknown_count
>> +	 */
>> +	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count) - 1; i++)
>> +		offset += priv->res_count[i];
>>  
>> +	for (unsigned int i = 0; i < priv->profile_count; i++) {
>> +		ret = awcc_op_get_resource_id(priv->wdev, i + offset, &out_data);
>>  		if (ret == -EIO)
>>  			return ret;
>>  
>> +		/*
>> +		 * Some devices report an incorrect number of thermal profiles
>> +		 * so the resource ID list may end prematurely
>> +		 */
>>  		if (ret == -EBADRQC)
>>  			break;
>>  
>>  		/* Some IDs have a BIT(8) flag that should be ignored */
>>  		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
>> -		if (!is_awcc_thermal_profile_id(id))
>> +		if (!is_awcc_thermal_profile_id(id)) {
>> +			dev_dbg(&priv->wdev->dev, "Unmapped thermal profile ID 0x%02x\n", id);
>>  			continue;
>> +		}
>>  
>>  		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
>>  		profile = awcc_mode_to_platform_profile[mode];
>>  		priv->supported_profiles[profile] = id;
>>  
>> -		set_bit(profile, choices);
>> +		__set_bit(profile, choices);
>>  	}
>>  
>>  	if (bitmap_empty(choices, PLATFORM_PROFILE_LAST))
>> @@ -655,7 +672,7 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
>>  		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
>>  			AWCC_THERMAL_MODE_GMODE;
>>  
>> -		set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
>> +		__set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
>>  	}
>>  
>>  	return 0;
>> @@ -686,6 +703,20 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>>  	if (!priv)
>>  		return -ENOMEM;
>>  
>> +	ret = awcc_thermal_information(wdev, AWCC_OP_GET_SYSTEM_DESCRIPTION,
>> +				       0, &priv->system_description);
>> +	if (ret < 0)
>> +		return ret;
>> +
>> +	/* Sanity check */
>> +	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count); i++) {
>> +		if (priv->res_count[i] > AWCC_MAX_RES_COUNT) {
>> +			dev_err(&wdev->dev, "Malformed system description: 0x%08x\n",
>> +				priv->system_description);
>> +			return -ENXIO;
>> +		}
>> +	}
>> +
>>  	priv->wdev = wdev;
>>  	dev_set_drvdata(&wdev->dev, priv);
>>  
>> 

[PATCH v2 06/10] platform/x86: alienware-wmi-wmax: Add support for the "custom" thermal profile

[Kurt Borja]

All models with the "AWCC" WMAX device support a "custom" thermal
profile. In some models this profile signals user-space that the user
wants to manually control the fans, which are always unlocked. In other
models it actually unlocks manual fan control.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 23 +++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 965b427f8f0a..bbe87f91fcb6 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -29,8 +29,6 @@
 #define AWCC_METHOD_THERMAL_CONTROL		0x15
 #define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
 
-#define AWCC_THERMAL_MODE_GMODE			0xAB
-
 #define AWCC_FAILURE_CODE			0xFFFFFFFF
 #define AWCC_FAILURE_CODE_2			0xFFFFFFFE
 #define AWCC_THERMAL_TABLE_MASK			GENMASK(7, 4)
@@ -176,6 +174,11 @@ enum AWCC_THERMAL_TABLES {
 	AWCC_THERMAL_TABLE_USTT			= 0xA,
 };
 
+enum AWCC_SPECIAL_THERMAL_CODES {
+	AWCC_SPECIAL_PROFILE_CUSTOM		= 0x00,
+	AWCC_SPECIAL_PROFILE_GMODE		= 0xAB,
+};
+
 enum awcc_thermal_profile {
 	AWCC_PROFILE_USTT_BALANCED,
 	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
@@ -578,9 +581,15 @@ static int awcc_platform_profile_get(struct device *dev,
 	if (ret < 0)
 		return ret;
 
-	if (out_data == AWCC_THERMAL_MODE_GMODE) {
+	switch (out_data) {
+	case AWCC_SPECIAL_PROFILE_CUSTOM:
+		*profile = PLATFORM_PROFILE_CUSTOM;
+		return 0;
+	case AWCC_SPECIAL_PROFILE_GMODE:
 		*profile = PLATFORM_PROFILE_PERFORMANCE;
 		return 0;
+	default:
+		break;
 	}
 
 	if (!is_awcc_thermal_profile_id(out_data))
@@ -670,11 +679,17 @@ static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
 
 	if (awcc->gmode) {
 		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
-			AWCC_THERMAL_MODE_GMODE;
+			AWCC_SPECIAL_PROFILE_GMODE;
 
 		__set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
 	}
 
+	/* Every model supports the "custom" profile */
+	priv->supported_profiles[PLATFORM_PROFILE_CUSTOM] =
+		AWCC_SPECIAL_PROFILE_CUSTOM;
+
+	__set_bit(PLATFORM_PROFILE_CUSTOM, choices);
+
 	return 0;
 }
 
-- 
2.48.1

[PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support

[Kurt Borja]

All models with the "AWCC" WMAX device support monitoring fan speed and
temperature sensors. Expose this feature through the HWMON interface.

Sensor readings are cached for 1 second before refreshing them to
mitigate the performance cost of calling WMI methods.

Cc: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 drivers/platform/x86/dell/Kconfig             |   1 +
 .../platform/x86/dell/alienware-wmi-wmax.c    | 403 ++++++++++++++++++
 2 files changed, 404 insertions(+)

diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
index f8a0dffcaab7..85a57c01aaad 100644
--- a/drivers/platform/x86/dell/Kconfig
+++ b/drivers/platform/x86/dell/Kconfig
@@ -43,6 +43,7 @@ config ALIENWARE_WMI_WMAX
 	bool "Alienware WMAX WMI device driver"
 	default y
 	depends on ALIENWARE_WMI
+	depends on HWMON
 	select ACPI_PLATFORM_PROFILE
 	help
 	 Alienware WMI driver with AlienFX LED, HDMI, amplifier, deep sleep and
diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index bbe87f91fcb6..818023a5b205 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -9,10 +9,13 @@
 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 
 #include <linux/bitfield.h>
+#include <linux/bitmap.h>
 #include <linux/bits.h>
 #include <linux/dmi.h>
+#include <linux/hwmon.h>
 #include <linux/moduleparam.h>
 #include <linux/platform_profile.h>
+#include <linux/units.h>
 #include <linux/wmi.h>
 #include "alienware-wmi.h"
 
@@ -25,6 +28,7 @@
 #define WMAX_METHOD_BRIGHTNESS			0x3
 #define WMAX_METHOD_ZONE_CONTROL		0x4
 
+#define AWCC_METHOD_GET_FAN_SENSORS		0x13
 #define AWCC_METHOD_THERMAL_INFORMATION		0x14
 #define AWCC_METHOD_THERMAL_CONTROL		0x15
 #define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
@@ -38,6 +42,10 @@
 /* Arbitrary limit based on supported models */
 #define AWCC_MAX_RES_COUNT			16
 
+static bool force_hwmon;
+module_param_unsafe(force_hwmon, bool, 0);
+MODULE_PARM_DESC(force_hwmon, "Force probing for HWMON support without checking if the WMI backend is available");
+
 static bool force_platform_profile;
 module_param_unsafe(force_platform_profile, bool, 0);
 MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
@@ -47,16 +55,19 @@ module_param_unsafe(force_gmode, bool, 0);
 MODULE_PARM_DESC(force_gmode, "Forces G-Mode when performance profile is selected");
 
 struct awcc_quirks {
+	bool hwmon;
 	bool pprof;
 	bool gmode;
 };
 
 static struct awcc_quirks g_series_quirks = {
+	.hwmon = true,
 	.pprof = true,
 	.gmode = true,
 };
 
 static struct awcc_quirks generic_quirks = {
+	.hwmon = true,
 	.pprof = true,
 	.gmode = false,
 };
@@ -154,9 +165,18 @@ static const struct dmi_system_id awcc_dmi_table[] __initconst = {
 	},
 };
 
+enum AWCC_GET_FAN_SENSORS_OPERATIONS {
+	AWCC_OP_GET_TOTAL_FAN_TEMPS		= 0x01,
+	AWCC_OP_GET_FAN_TEMP_ID			= 0x02,
+};
+
 enum AWCC_THERMAL_INFORMATION_OPERATIONS {
 	AWCC_OP_GET_SYSTEM_DESCRIPTION		= 0x02,
 	AWCC_OP_GET_RESOURCE_ID			= 0x03,
+	AWCC_OP_GET_TEMPERATURE			= 0x04,
+	AWCC_OP_GET_FAN_RPM			= 0x05,
+	AWCC_OP_GET_FAN_MIN_RPM			= 0x08,
+	AWCC_OP_GET_FAN_MAX_RPM			= 0x09,
 	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
 };
 
@@ -179,6 +199,12 @@ enum AWCC_SPECIAL_THERMAL_CODES {
 	AWCC_SPECIAL_PROFILE_GMODE		= 0xAB,
 };
 
+enum AWCC_TEMP_SENSOR_TYPES {
+	AWCC_TEMP_SENSOR_CPU			= 0x01,
+	AWCC_TEMP_SENSOR_GPU			= 0x06,
+	AWCC_TEMP_SENSOR_LAST
+};
+
 enum awcc_thermal_profile {
 	AWCC_PROFILE_USTT_BALANCED,
 	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
@@ -215,6 +241,15 @@ struct wmax_u32_args {
 	u8 arg3;
 } __packed;
 
+struct awcc_fan_data {
+	unsigned long *related_temps;
+	unsigned long *auto_channels_temp;
+	u32 total_temps;
+	u32 min_rpm;
+	u32 max_rpm;
+	u8 id;
+};
+
 struct awcc_priv {
 	struct wmi_device *wdev;
 	union {
@@ -230,6 +265,11 @@ struct awcc_priv {
 
 	struct device *ppdev;
 	u8 supported_profiles[PLATFORM_PROFILE_LAST];
+
+	struct device *hwdev;
+	struct awcc_fan_data **fan_data;
+	unsigned int temp_sensors_size;
+	unsigned long *temp_sensors;
 };
 
 static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
@@ -494,6 +534,19 @@ static int __awcc_wmi_command(struct wmi_device *wdev, u32 method_id,
 	return 0;
 }
 
+static inline int awcc_get_fan_sensors(struct wmi_device *wdev, u8 operation,
+				       u8 fan_id, u8 index, u32 *out)
+{
+	struct wmax_u32_args args = {
+		.operation = operation,
+		.arg1 = fan_id,
+		.arg2 = index,
+		.arg3 = 0,
+	};
+
+	return __awcc_wmi_command(wdev, AWCC_METHOD_GET_FAN_SENSORS, &args, out);
+}
+
 static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
 					   u8 arg, u32 *out)
 {
@@ -564,6 +617,343 @@ static inline int awcc_op_get_resource_id(struct wmi_device *wdev, u8 index, u32
 	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
 }
 
+/*
+ * HWMON
+ *  - Provides temperature and fan speed monitoring as well as manual fan
+ *    control
+ */
+static umode_t awcc_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_types type,
+				     u32 attr, int channel)
+{
+	const struct awcc_priv *priv = drvdata;
+
+	switch (type) {
+	case hwmon_temp:
+		if (channel < priv->temp_count)
+			return 0444;
+
+		break;
+	case hwmon_fan:
+		if (channel < priv->fan_count)
+			return 0444;
+
+		break;
+	case hwmon_pwm:
+		if (channel < priv->fan_count)
+			return 0444;
+
+		break;
+	default:
+		break;
+	}
+
+	return 0;
+}
+
+static int awcc_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
+			   u32 attr, int channel, long *val)
+{
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *fan;
+	u32 state;
+	int ret;
+	u8 temp;
+
+	switch (type) {
+	case hwmon_temp:
+		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
+		if (temp >= U8_MAX)
+			return -ENXIO;
+
+		switch (attr) {
+		case hwmon_temp_input:
+			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_TEMPERATURE,
+						       temp, &state);
+			if (ret)
+				return ret;
+
+			*val = state * MILLIDEGREE_PER_DEGREE;
+			break;
+		default:
+			return -EOPNOTSUPP;
+		}
+
+		break;
+	case hwmon_fan:
+		fan = priv->fan_data[channel];
+
+		switch (attr) {
+		case hwmon_fan_input:
+			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_FAN_RPM,
+						       fan->id, &state);
+			if (ret)
+				return ret;
+
+			*val = state;
+			break;
+		case hwmon_fan_min:
+			*val = fan->min_rpm;
+			break;
+		case hwmon_fan_max:
+			*val = fan->max_rpm;
+			break;
+		default:
+			return -EOPNOTSUPP;
+		}
+
+		break;
+	case hwmon_pwm:
+		fan = priv->fan_data[channel];
+
+		bitmap_copy(val, fan->auto_channels_temp, BITS_PER_LONG);
+		break;
+	default:
+		return -EOPNOTSUPP;
+	}
+
+	return 0;
+}
+
+static int awcc_hwmon_read_string(struct device *dev, enum hwmon_sensor_types type,
+				  u32 attr, int channel, const char **str)
+{
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *fan;
+	u8 temp;
+
+	switch (type) {
+	case hwmon_temp:
+		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
+		if (temp >= U8_MAX)
+			return -ENXIO;
+
+		switch (temp) {
+		case AWCC_TEMP_SENSOR_CPU:
+			*str = "CPU";
+			break;
+		case AWCC_TEMP_SENSOR_GPU:
+			*str = "GPU";
+			break;
+		default:
+			*str = "Unknown";
+			break;
+		}
+
+		break;
+	case hwmon_fan:
+		fan = priv->fan_data[channel];
+
+		switch (fan->total_temps) {
+		case 0:
+			*str = "Independent Fan";
+			break;
+		case 1:
+			temp = find_first_bit(fan->related_temps, U8_MAX);
+
+			switch (temp) {
+			case AWCC_TEMP_SENSOR_CPU:
+				*str = "Processor Fan";
+				break;
+			case AWCC_TEMP_SENSOR_GPU:
+				*str = "Video Fan";
+				break;
+			default:
+				*str = "Unknown Fan";
+				break;
+			}
+
+			break;
+		default:
+			*str = "Shared Fan";
+			break;
+		}
+
+		break;
+	default:
+		return -EOPNOTSUPP;
+	}
+
+	return 0;
+}
+
+static const struct hwmon_ops awcc_hwmon_ops = {
+	.is_visible = awcc_hwmon_is_visible,
+	.read = awcc_hwmon_read,
+	.read_string = awcc_hwmon_read_string,
+};
+
+static const struct hwmon_channel_info * const awcc_hwmon_info[] = {
+	HWMON_CHANNEL_INFO(temp,
+			   HWMON_T_LABEL | HWMON_T_INPUT,
+			   HWMON_T_LABEL | HWMON_T_INPUT,
+			   HWMON_T_LABEL | HWMON_T_INPUT,
+			   HWMON_T_LABEL | HWMON_T_INPUT,
+			   HWMON_T_LABEL | HWMON_T_INPUT,
+			   HWMON_T_LABEL | HWMON_T_INPUT
+			   ),
+	HWMON_CHANNEL_INFO(fan,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
+			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX
+			   ),
+	HWMON_CHANNEL_INFO(pwm,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP,
+			   HWMON_PWM_AUTO_CHANNELS_TEMP
+			   ),
+	NULL
+};
+
+static const struct hwmon_chip_info awcc_hwmon_chip_info = {
+	.ops = &awcc_hwmon_ops,
+	.info = awcc_hwmon_info,
+};
+
+static int awcc_hwmon_temps_init(struct wmi_device *wdev)
+{
+	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
+	unsigned long temp_sensors[BITS_TO_LONGS(U8_MAX)];
+	unsigned int i, max_sensor_id = 0;
+	int ret;
+	u32 id;
+
+	for (i = 0; i < priv->temp_count; i++) {
+		/*
+		 * Temperature sensors IDs are listed after the fan IDs at
+		 * offset `fan_count`
+		 */
+		ret = awcc_op_get_resource_id(wdev, i + priv->fan_count, &id);
+		if (ret)
+			return ret;
+
+		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
+		if (id > max_sensor_id)
+			max_sensor_id = id;
+
+		ret = __test_and_set_bit(id, temp_sensors);
+		if (ret)
+			dev_warn(&wdev->dev, "Sensor ID at index %u is duplicated\n", i);
+	}
+
+	/*
+	 * We prefer to allocate the bitmap dynamically because usually temp IDs
+	 * are small (< 0x30) and only one UL is needed to store it, but there
+	 * may be unknown devices that break this rule
+	 */
+	priv->temp_sensors_size = max_sensor_id + 1;
+	priv->temp_sensors = devm_bitmap_zalloc(&wdev->dev, priv->temp_sensors_size,
+						GFP_KERNEL);
+	if (!priv->temp_sensors)
+		return -ENOMEM;
+
+	bitmap_copy(priv->temp_sensors, temp_sensors, priv->temp_sensors_size);
+
+	return 0;
+}
+
+static int awcc_hwmon_fans_init(struct wmi_device *wdev)
+{
+	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
+	u32 id, min_rpm, max_rpm, total_fan_temps, temp_id;
+	unsigned long gather[BITS_TO_LONGS(U8_MAX)];
+	struct awcc_fan_data *fan_data;
+	unsigned int i, j;
+	int ret;
+
+	for (i = 0; i < priv->fan_count; i++) {
+		fan_data = devm_kzalloc(&wdev->dev, sizeof(*fan_data), GFP_KERNEL);
+		if (!fan_data)
+			return -ENOMEM;
+
+		fan_data->related_temps = devm_bitmap_zalloc(&wdev->dev,
+							     priv->temp_sensors_size,
+							     GFP_KERNEL);
+		if (!priv->temp_sensors)
+			return -ENOMEM;
+
+		fan_data->auto_channels_temp = devm_bitmap_zalloc(&wdev->dev,
+								  priv->temp_count,
+								  GFP_KERNEL);
+		if (!priv->temp_sensors)
+			return -ENOMEM;
+
+		/*
+		 * Fan IDs are listed first at offset 0
+		 */
+		ret = awcc_op_get_resource_id(wdev, i, &id);
+		if (ret)
+			return ret;
+		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
+
+		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MIN_RPM, id,
+					       &min_rpm);
+		if (ret)
+			return ret;
+
+		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MAX_RPM, id,
+					       &max_rpm);
+		if (ret)
+			return ret;
+
+		ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_TOTAL_FAN_TEMPS, id,
+					   0, &total_fan_temps);
+		if (ret)
+			return ret;
+
+		for (j = 0; j < total_fan_temps; j++) {
+			ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_FAN_TEMP_ID,
+						   id, j, &temp_id);
+			if (ret)
+				break;
+
+			temp_id = FIELD_GET(AWCC_RESOURCE_ID_MASK, temp_id);
+			if (temp_id < priv->temp_sensors_size)
+				__set_bit(temp_id, fan_data->related_temps);
+		}
+
+		fan_data->id = id;
+		fan_data->min_rpm = min_rpm;
+		fan_data->max_rpm = max_rpm;
+		fan_data->total_temps = total_fan_temps;
+		bitmap_gather(gather, fan_data->related_temps, priv->temp_sensors,
+			      priv->temp_sensors_size);
+		bitmap_copy(fan_data->auto_channels_temp, gather, priv->temp_count);
+		priv->fan_data[i] = fan_data;
+	}
+
+	return 0;
+}
+
+static int awcc_hwmon_init(struct wmi_device *wdev)
+{
+	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
+	int ret;
+
+	priv->fan_data = devm_kcalloc(&wdev->dev, priv->fan_count,
+				      sizeof(*priv->fan_data), GFP_KERNEL);
+	if (!priv->fan_data)
+		return -ENOMEM;
+
+	ret = awcc_hwmon_temps_init(wdev);
+	if (ret)
+		return ret;
+
+	ret = awcc_hwmon_fans_init(wdev);
+	if (ret)
+		return ret;
+
+	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi", priv,
+							   &awcc_hwmon_chip_info, NULL);
+
+	return PTR_ERR_OR_ZERO(priv->hwdev);
+}
+
 /*
  * Thermal Profile control
  *  - Provides thermal profile control through the Platform Profile API
@@ -735,6 +1125,12 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
 	priv->wdev = wdev;
 	dev_set_drvdata(&wdev->dev, priv);
 
+	if (awcc->hwmon) {
+		ret = awcc_hwmon_init(wdev);
+		if (ret)
+			return ret;
+	}
+
 	if (awcc->pprof) {
 		ret = awcc_platform_profile_init(wdev);
 		if (ret)
@@ -815,6 +1211,13 @@ int __init alienware_wmax_wmi_init(void)
 	if (id)
 		awcc = id->driver_data;
 
+	if (force_hwmon) {
+		if (!awcc)
+			awcc = &empty_quirks;
+
+		awcc->hwmon = true;
+	}
+
 	if (force_platform_profile) {
 		if (!awcc)
 			awcc = &empty_quirks;
-- 
2.48.1

Re: [PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support

[Ilpo Järvinen]

On Tue, 25 Feb 2025, Kurt Borja wrote:

> All models with the "AWCC" WMAX device support monitoring fan speed and
> temperature sensors. Expose this feature through the HWMON interface.
> 
> Sensor readings are cached for 1 second before refreshing them to
> mitigate the performance cost of calling WMI methods.
> 
> Cc: Guenter Roeck <linux@roeck-us.net>
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
>  drivers/platform/x86/dell/Kconfig             |   1 +
>  .../platform/x86/dell/alienware-wmi-wmax.c    | 403 ++++++++++++++++++
>  2 files changed, 404 insertions(+)
> 
> diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
> index f8a0dffcaab7..85a57c01aaad 100644
> --- a/drivers/platform/x86/dell/Kconfig
> +++ b/drivers/platform/x86/dell/Kconfig
> @@ -43,6 +43,7 @@ config ALIENWARE_WMI_WMAX
>  	bool "Alienware WMAX WMI device driver"
>  	default y
>  	depends on ALIENWARE_WMI
> +	depends on HWMON
>  	select ACPI_PLATFORM_PROFILE
>  	help
>  	 Alienware WMI driver with AlienFX LED, HDMI, amplifier, deep sleep and
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index bbe87f91fcb6..818023a5b205 100644
> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> @@ -9,10 +9,13 @@
>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>  
>  #include <linux/bitfield.h>
> +#include <linux/bitmap.h>
>  #include <linux/bits.h>
>  #include <linux/dmi.h>
> +#include <linux/hwmon.h>
>  #include <linux/moduleparam.h>
>  #include <linux/platform_profile.h>
> +#include <linux/units.h>
>  #include <linux/wmi.h>
>  #include "alienware-wmi.h"
>  
> @@ -25,6 +28,7 @@
>  #define WMAX_METHOD_BRIGHTNESS			0x3
>  #define WMAX_METHOD_ZONE_CONTROL		0x4
>  
> +#define AWCC_METHOD_GET_FAN_SENSORS		0x13
>  #define AWCC_METHOD_THERMAL_INFORMATION		0x14
>  #define AWCC_METHOD_THERMAL_CONTROL		0x15
>  #define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
> @@ -38,6 +42,10 @@
>  /* Arbitrary limit based on supported models */
>  #define AWCC_MAX_RES_COUNT			16
>  
> +static bool force_hwmon;
> +module_param_unsafe(force_hwmon, bool, 0);
> +MODULE_PARM_DESC(force_hwmon, "Force probing for HWMON support without checking if the WMI backend is available");
> +
>  static bool force_platform_profile;
>  module_param_unsafe(force_platform_profile, bool, 0);
>  MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
> @@ -47,16 +55,19 @@ module_param_unsafe(force_gmode, bool, 0);
>  MODULE_PARM_DESC(force_gmode, "Forces G-Mode when performance profile is selected");
>  
>  struct awcc_quirks {
> +	bool hwmon;
>  	bool pprof;
>  	bool gmode;
>  };
>  
>  static struct awcc_quirks g_series_quirks = {
> +	.hwmon = true,
>  	.pprof = true,
>  	.gmode = true,
>  };
>  
>  static struct awcc_quirks generic_quirks = {
> +	.hwmon = true,
>  	.pprof = true,
>  	.gmode = false,
>  };
> @@ -154,9 +165,18 @@ static const struct dmi_system_id awcc_dmi_table[] __initconst = {
>  	},
>  };
>  
> +enum AWCC_GET_FAN_SENSORS_OPERATIONS {
> +	AWCC_OP_GET_TOTAL_FAN_TEMPS		= 0x01,
> +	AWCC_OP_GET_FAN_TEMP_ID			= 0x02,
> +};
> +
>  enum AWCC_THERMAL_INFORMATION_OPERATIONS {
>  	AWCC_OP_GET_SYSTEM_DESCRIPTION		= 0x02,
>  	AWCC_OP_GET_RESOURCE_ID			= 0x03,
> +	AWCC_OP_GET_TEMPERATURE			= 0x04,
> +	AWCC_OP_GET_FAN_RPM			= 0x05,
> +	AWCC_OP_GET_FAN_MIN_RPM			= 0x08,
> +	AWCC_OP_GET_FAN_MAX_RPM			= 0x09,
>  	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
>  };
>  
> @@ -179,6 +199,12 @@ enum AWCC_SPECIAL_THERMAL_CODES {
>  	AWCC_SPECIAL_PROFILE_GMODE		= 0xAB,
>  };
>  
> +enum AWCC_TEMP_SENSOR_TYPES {
> +	AWCC_TEMP_SENSOR_CPU			= 0x01,
> +	AWCC_TEMP_SENSOR_GPU			= 0x06,
> +	AWCC_TEMP_SENSOR_LAST
> +};
> +
>  enum awcc_thermal_profile {
>  	AWCC_PROFILE_USTT_BALANCED,
>  	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
> @@ -215,6 +241,15 @@ struct wmax_u32_args {
>  	u8 arg3;
>  } __packed;
>  
> +struct awcc_fan_data {
> +	unsigned long *related_temps;
> +	unsigned long *auto_channels_temp;
> +	u32 total_temps;
> +	u32 min_rpm;
> +	u32 max_rpm;
> +	u8 id;
> +};
> +
>  struct awcc_priv {
>  	struct wmi_device *wdev;
>  	union {
> @@ -230,6 +265,11 @@ struct awcc_priv {
>  
>  	struct device *ppdev;
>  	u8 supported_profiles[PLATFORM_PROFILE_LAST];
> +
> +	struct device *hwdev;
> +	struct awcc_fan_data **fan_data;
> +	unsigned int temp_sensors_size;
> +	unsigned long *temp_sensors;
>  };
>  
>  static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
> @@ -494,6 +534,19 @@ static int __awcc_wmi_command(struct wmi_device *wdev, u32 method_id,
>  	return 0;
>  }
>  
> +static inline int awcc_get_fan_sensors(struct wmi_device *wdev, u8 operation,
> +				       u8 fan_id, u8 index, u32 *out)
> +{
> +	struct wmax_u32_args args = {
> +		.operation = operation,
> +		.arg1 = fan_id,
> +		.arg2 = index,
> +		.arg3 = 0,
> +	};
> +
> +	return __awcc_wmi_command(wdev, AWCC_METHOD_GET_FAN_SENSORS, &args, out);
> +}
> +
>  static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
>  					   u8 arg, u32 *out)
>  {
> @@ -564,6 +617,343 @@ static inline int awcc_op_get_resource_id(struct wmi_device *wdev, u8 index, u32
>  	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
>  }
>  
> +/*
> + * HWMON
> + *  - Provides temperature and fan speed monitoring as well as manual fan
> + *    control
> + */
> +static umode_t awcc_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_types type,
> +				     u32 attr, int channel)
> +{
> +	const struct awcc_priv *priv = drvdata;
> +
> +	switch (type) {
> +	case hwmon_temp:
> +		if (channel < priv->temp_count)
> +			return 0444;
> +
> +		break;

IMO, these could be written as:
		return channel < priv->temp_count ? 0444 : 0;

> +	case hwmon_fan:
> +		if (channel < priv->fan_count)
> +			return 0444;
> +
> +		break;
> +	case hwmon_pwm:
> +		if (channel < priv->fan_count)
> +			return 0444;
> +
> +		break;
> +	default:
> +		break;
> +	}
> +
> +	return 0;
> +}
> +
> +static int awcc_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
> +			   u32 attr, int channel, long *val)
> +{
> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> +	struct awcc_fan_data *fan;
> +	u32 state;
> +	int ret;
> +	u8 temp;
> +
> +	switch (type) {
> +	case hwmon_temp:
> +		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
> +		if (temp >= U8_MAX)

It cannot be larger than as its type is u8??

> +			return -ENXIO;
> +
> +		switch (attr) {
> +		case hwmon_temp_input:
> +			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_TEMPERATURE,
> +						       temp, &state);
> +			if (ret)
> +				return ret;
> +
> +			*val = state * MILLIDEGREE_PER_DEGREE;
> +			break;
> +		default:
> +			return -EOPNOTSUPP;
> +		}
> +
> +		break;
> +	case hwmon_fan:
> +		fan = priv->fan_data[channel];
> +
> +		switch (attr) {
> +		case hwmon_fan_input:
> +			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_FAN_RPM,
> +						       fan->id, &state);
> +			if (ret)
> +				return ret;
> +
> +			*val = state;
> +			break;
> +		case hwmon_fan_min:
> +			*val = fan->min_rpm;
> +			break;
> +		case hwmon_fan_max:
> +			*val = fan->max_rpm;
> +			break;
> +		default:
> +			return -EOPNOTSUPP;
> +		}
> +
> +		break;
> +	case hwmon_pwm:
> +		fan = priv->fan_data[channel];
> +
> +		bitmap_copy(val, fan->auto_channels_temp, BITS_PER_LONG);
> +		break;
> +	default:
> +		return -EOPNOTSUPP;
> +	}
> +
> +	return 0;
> +}
> +
> +static int awcc_hwmon_read_string(struct device *dev, enum hwmon_sensor_types type,
> +				  u32 attr, int channel, const char **str)
> +{
> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> +	struct awcc_fan_data *fan;
> +	u8 temp;
> +
> +	switch (type) {
> +	case hwmon_temp:
> +		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
> +		if (temp >= U8_MAX)
> +			return -ENXIO;
> +
> +		switch (temp) {
> +		case AWCC_TEMP_SENSOR_CPU:
> +			*str = "CPU";
> +			break;
> +		case AWCC_TEMP_SENSOR_GPU:
> +			*str = "GPU";
> +			break;
> +		default:
> +			*str = "Unknown";
> +			break;
> +		}
> +
> +		break;
> +	case hwmon_fan:
> +		fan = priv->fan_data[channel];
> +
> +		switch (fan->total_temps) {
> +		case 0:
> +			*str = "Independent Fan";
> +			break;
> +		case 1:
> +			temp = find_first_bit(fan->related_temps, U8_MAX);
> +
> +			switch (temp) {
> +			case AWCC_TEMP_SENSOR_CPU:
> +				*str = "Processor Fan";
> +				break;
> +			case AWCC_TEMP_SENSOR_GPU:
> +				*str = "Video Fan";
> +				break;
> +			default:
> +				*str = "Unknown Fan";
> +				break;
> +			}
> +
> +			break;
> +		default:
> +			*str = "Shared Fan";
> +			break;
> +		}
> +
> +		break;
> +	default:
> +		return -EOPNOTSUPP;
> +	}
> +
> +	return 0;
> +}
> +
> +static const struct hwmon_ops awcc_hwmon_ops = {
> +	.is_visible = awcc_hwmon_is_visible,
> +	.read = awcc_hwmon_read,
> +	.read_string = awcc_hwmon_read_string,
> +};
> +
> +static const struct hwmon_channel_info * const awcc_hwmon_info[] = {
> +	HWMON_CHANNEL_INFO(temp,
> +			   HWMON_T_LABEL | HWMON_T_INPUT,
> +			   HWMON_T_LABEL | HWMON_T_INPUT,
> +			   HWMON_T_LABEL | HWMON_T_INPUT,
> +			   HWMON_T_LABEL | HWMON_T_INPUT,
> +			   HWMON_T_LABEL | HWMON_T_INPUT,
> +			   HWMON_T_LABEL | HWMON_T_INPUT
> +			   ),
> +	HWMON_CHANNEL_INFO(fan,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX
> +			   ),
> +	HWMON_CHANNEL_INFO(pwm,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
> +			   HWMON_PWM_AUTO_CHANNELS_TEMP
> +			   ),
> +	NULL
> +};
> +
> +static const struct hwmon_chip_info awcc_hwmon_chip_info = {
> +	.ops = &awcc_hwmon_ops,
> +	.info = awcc_hwmon_info,
> +};
> +
> +static int awcc_hwmon_temps_init(struct wmi_device *wdev)
> +{
> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
> +	unsigned long temp_sensors[BITS_TO_LONGS(U8_MAX)];
> +	unsigned int i, max_sensor_id = 0;
> +	int ret;
> +	u32 id;
> +
> +	for (i = 0; i < priv->temp_count; i++) {
> +		/*
> +		 * Temperature sensors IDs are listed after the fan IDs at
> +		 * offset `fan_count`
> +		 */
> +		ret = awcc_op_get_resource_id(wdev, i + priv->fan_count, &id);
> +		if (ret)
> +			return ret;
> +
> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
> +		if (id > max_sensor_id)
> +			max_sensor_id = id;
> +
> +		ret = __test_and_set_bit(id, temp_sensors);
> +		if (ret)
> +			dev_warn(&wdev->dev, "Sensor ID at index %u is duplicated\n", i);
> +	}
> +
> +	/*
> +	 * We prefer to allocate the bitmap dynamically because usually temp IDs
> +	 * are small (< 0x30) and only one UL is needed to store it, but there
> +	 * may be unknown devices that break this rule
> +	 */
> +	priv->temp_sensors_size = max_sensor_id + 1;
> +	priv->temp_sensors = devm_bitmap_zalloc(&wdev->dev, priv->temp_sensors_size,
> +						GFP_KERNEL);
> +	if (!priv->temp_sensors)
> +		return -ENOMEM;
> +
> +	bitmap_copy(priv->temp_sensors, temp_sensors, priv->temp_sensors_size);
> +
> +	return 0;
> +}
> +
> +static int awcc_hwmon_fans_init(struct wmi_device *wdev)
> +{
> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
> +	u32 id, min_rpm, max_rpm, total_fan_temps, temp_id;
> +	unsigned long gather[BITS_TO_LONGS(U8_MAX)];
> +	struct awcc_fan_data *fan_data;
> +	unsigned int i, j;
> +	int ret;
> +
> +	for (i = 0; i < priv->fan_count; i++) {
> +		fan_data = devm_kzalloc(&wdev->dev, sizeof(*fan_data), GFP_KERNEL);
> +		if (!fan_data)
> +			return -ENOMEM;
> +
> +		fan_data->related_temps = devm_bitmap_zalloc(&wdev->dev,
> +							     priv->temp_sensors_size,
> +							     GFP_KERNEL);
> +		if (!priv->temp_sensors)
> +			return -ENOMEM;
> +
> +		fan_data->auto_channels_temp = devm_bitmap_zalloc(&wdev->dev,
> +								  priv->temp_count,
> +								  GFP_KERNEL);
> +		if (!priv->temp_sensors)
> +			return -ENOMEM;
> +
> +		/*
> +		 * Fan IDs are listed first at offset 0
> +		 */
> +		ret = awcc_op_get_resource_id(wdev, i, &id);
> +		if (ret)
> +			return ret;
> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
> +
> +		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MIN_RPM, id,
> +					       &min_rpm);
> +		if (ret)
> +			return ret;
> +
> +		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MAX_RPM, id,
> +					       &max_rpm);
> +		if (ret)
> +			return ret;
> +
> +		ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_TOTAL_FAN_TEMPS, id,
> +					   0, &total_fan_temps);
> +		if (ret)
> +			return ret;
> +
> +		for (j = 0; j < total_fan_temps; j++) {
> +			ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_FAN_TEMP_ID,
> +						   id, j, &temp_id);
> +			if (ret)
> +				break;
> +
> +			temp_id = FIELD_GET(AWCC_RESOURCE_ID_MASK, temp_id);
> +			if (temp_id < priv->temp_sensors_size)
> +				__set_bit(temp_id, fan_data->related_temps);
> +		}
> +
> +		fan_data->id = id;
> +		fan_data->min_rpm = min_rpm;
> +		fan_data->max_rpm = max_rpm;
> +		fan_data->total_temps = total_fan_temps;
> +		bitmap_gather(gather, fan_data->related_temps, priv->temp_sensors,
> +			      priv->temp_sensors_size);
> +		bitmap_copy(fan_data->auto_channels_temp, gather, priv->temp_count);
> +		priv->fan_data[i] = fan_data;
> +	}
> +
> +	return 0;
> +}
> +
> +static int awcc_hwmon_init(struct wmi_device *wdev)
> +{
> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
> +	int ret;
> +
> +	priv->fan_data = devm_kcalloc(&wdev->dev, priv->fan_count,
> +				      sizeof(*priv->fan_data), GFP_KERNEL);
> +	if (!priv->fan_data)
> +		return -ENOMEM;
> +
> +	ret = awcc_hwmon_temps_init(wdev);
> +	if (ret)
> +		return ret;
> +
> +	ret = awcc_hwmon_fans_init(wdev);
> +	if (ret)
> +		return ret;
> +
> +	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi", priv,
> +							   &awcc_hwmon_chip_info, NULL);
> +
> +	return PTR_ERR_OR_ZERO(priv->hwdev);
> +}
> +
>  /*
>   * Thermal Profile control
>   *  - Provides thermal profile control through the Platform Profile API
> @@ -735,6 +1125,12 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>  	priv->wdev = wdev;
>  	dev_set_drvdata(&wdev->dev, priv);
>  
> +	if (awcc->hwmon) {
> +		ret = awcc_hwmon_init(wdev);
> +		if (ret)
> +			return ret;
> +	}
> +
>  	if (awcc->pprof) {
>  		ret = awcc_platform_profile_init(wdev);
>  		if (ret)
> @@ -815,6 +1211,13 @@ int __init alienware_wmax_wmi_init(void)
>  	if (id)
>  		awcc = id->driver_data;
>  
> +	if (force_hwmon) {
> +		if (!awcc)
> +			awcc = &empty_quirks;
> +
> +		awcc->hwmon = true;
> +	}
> +
>  	if (force_platform_profile) {
>  		if (!awcc)
>  			awcc = &empty_quirks;
> 

-- 
 i.

Re: [PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support

[Kurt Borja]

On Tue Mar 4, 2025 at 10:53 AM -05, Ilpo Järvinen wrote:
> On Tue, 25 Feb 2025, Kurt Borja wrote:
>
>> All models with the "AWCC" WMAX device support monitoring fan speed and
>> temperature sensors. Expose this feature through the HWMON interface.
>> 
>> Sensor readings are cached for 1 second before refreshing them to
>> mitigate the performance cost of calling WMI methods.
>> 
>> Cc: Guenter Roeck <linux@roeck-us.net>
>> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
>> ---
>>  drivers/platform/x86/dell/Kconfig             |   1 +
>>  .../platform/x86/dell/alienware-wmi-wmax.c    | 403 ++++++++++++++++++
>>  2 files changed, 404 insertions(+)
>> 
>> diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
>> index f8a0dffcaab7..85a57c01aaad 100644
>> --- a/drivers/platform/x86/dell/Kconfig
>> +++ b/drivers/platform/x86/dell/Kconfig
>> @@ -43,6 +43,7 @@ config ALIENWARE_WMI_WMAX
>>  	bool "Alienware WMAX WMI device driver"
>>  	default y
>>  	depends on ALIENWARE_WMI
>> +	depends on HWMON
>>  	select ACPI_PLATFORM_PROFILE
>>  	help
>>  	 Alienware WMI driver with AlienFX LED, HDMI, amplifier, deep sleep and
>> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> index bbe87f91fcb6..818023a5b205 100644
>> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> @@ -9,10 +9,13 @@
>>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>>  
>>  #include <linux/bitfield.h>
>> +#include <linux/bitmap.h>
>>  #include <linux/bits.h>
>>  #include <linux/dmi.h>
>> +#include <linux/hwmon.h>
>>  #include <linux/moduleparam.h>
>>  #include <linux/platform_profile.h>
>> +#include <linux/units.h>
>>  #include <linux/wmi.h>
>>  #include "alienware-wmi.h"
>>  
>> @@ -25,6 +28,7 @@
>>  #define WMAX_METHOD_BRIGHTNESS			0x3
>>  #define WMAX_METHOD_ZONE_CONTROL		0x4
>>  
>> +#define AWCC_METHOD_GET_FAN_SENSORS		0x13
>>  #define AWCC_METHOD_THERMAL_INFORMATION		0x14
>>  #define AWCC_METHOD_THERMAL_CONTROL		0x15
>>  #define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
>> @@ -38,6 +42,10 @@
>>  /* Arbitrary limit based on supported models */
>>  #define AWCC_MAX_RES_COUNT			16
>>  
>> +static bool force_hwmon;
>> +module_param_unsafe(force_hwmon, bool, 0);
>> +MODULE_PARM_DESC(force_hwmon, "Force probing for HWMON support without checking if the WMI backend is available");
>> +
>>  static bool force_platform_profile;
>>  module_param_unsafe(force_platform_profile, bool, 0);
>>  MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
>> @@ -47,16 +55,19 @@ module_param_unsafe(force_gmode, bool, 0);
>>  MODULE_PARM_DESC(force_gmode, "Forces G-Mode when performance profile is selected");
>>  
>>  struct awcc_quirks {
>> +	bool hwmon;
>>  	bool pprof;
>>  	bool gmode;
>>  };
>>  
>>  static struct awcc_quirks g_series_quirks = {
>> +	.hwmon = true,
>>  	.pprof = true,
>>  	.gmode = true,
>>  };
>>  
>>  static struct awcc_quirks generic_quirks = {
>> +	.hwmon = true,
>>  	.pprof = true,
>>  	.gmode = false,
>>  };
>> @@ -154,9 +165,18 @@ static const struct dmi_system_id awcc_dmi_table[] __initconst = {
>>  	},
>>  };
>>  
>> +enum AWCC_GET_FAN_SENSORS_OPERATIONS {
>> +	AWCC_OP_GET_TOTAL_FAN_TEMPS		= 0x01,
>> +	AWCC_OP_GET_FAN_TEMP_ID			= 0x02,
>> +};
>> +
>>  enum AWCC_THERMAL_INFORMATION_OPERATIONS {
>>  	AWCC_OP_GET_SYSTEM_DESCRIPTION		= 0x02,
>>  	AWCC_OP_GET_RESOURCE_ID			= 0x03,
>> +	AWCC_OP_GET_TEMPERATURE			= 0x04,
>> +	AWCC_OP_GET_FAN_RPM			= 0x05,
>> +	AWCC_OP_GET_FAN_MIN_RPM			= 0x08,
>> +	AWCC_OP_GET_FAN_MAX_RPM			= 0x09,
>>  	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
>>  };
>>  
>> @@ -179,6 +199,12 @@ enum AWCC_SPECIAL_THERMAL_CODES {
>>  	AWCC_SPECIAL_PROFILE_GMODE		= 0xAB,
>>  };
>>  
>> +enum AWCC_TEMP_SENSOR_TYPES {
>> +	AWCC_TEMP_SENSOR_CPU			= 0x01,
>> +	AWCC_TEMP_SENSOR_GPU			= 0x06,
>> +	AWCC_TEMP_SENSOR_LAST
>> +};
>> +
>>  enum awcc_thermal_profile {
>>  	AWCC_PROFILE_USTT_BALANCED,
>>  	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
>> @@ -215,6 +241,15 @@ struct wmax_u32_args {
>>  	u8 arg3;
>>  } __packed;
>>  
>> +struct awcc_fan_data {
>> +	unsigned long *related_temps;
>> +	unsigned long *auto_channels_temp;
>> +	u32 total_temps;
>> +	u32 min_rpm;
>> +	u32 max_rpm;
>> +	u8 id;
>> +};
>> +
>>  struct awcc_priv {
>>  	struct wmi_device *wdev;
>>  	union {
>> @@ -230,6 +265,11 @@ struct awcc_priv {
>>  
>>  	struct device *ppdev;
>>  	u8 supported_profiles[PLATFORM_PROFILE_LAST];
>> +
>> +	struct device *hwdev;
>> +	struct awcc_fan_data **fan_data;
>> +	unsigned int temp_sensors_size;
>> +	unsigned long *temp_sensors;
>>  };
>>  
>>  static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
>> @@ -494,6 +534,19 @@ static int __awcc_wmi_command(struct wmi_device *wdev, u32 method_id,
>>  	return 0;
>>  }
>>  
>> +static inline int awcc_get_fan_sensors(struct wmi_device *wdev, u8 operation,
>> +				       u8 fan_id, u8 index, u32 *out)
>> +{
>> +	struct wmax_u32_args args = {
>> +		.operation = operation,
>> +		.arg1 = fan_id,
>> +		.arg2 = index,
>> +		.arg3 = 0,
>> +	};
>> +
>> +	return __awcc_wmi_command(wdev, AWCC_METHOD_GET_FAN_SENSORS, &args, out);
>> +}
>> +
>>  static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
>>  					   u8 arg, u32 *out)
>>  {
>> @@ -564,6 +617,343 @@ static inline int awcc_op_get_resource_id(struct wmi_device *wdev, u8 index, u32
>>  	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
>>  }
>>  
>> +/*
>> + * HWMON
>> + *  - Provides temperature and fan speed monitoring as well as manual fan
>> + *    control
>> + */
>> +static umode_t awcc_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_types type,
>> +				     u32 attr, int channel)
>> +{
>> +	const struct awcc_priv *priv = drvdata;
>> +
>> +	switch (type) {
>> +	case hwmon_temp:
>> +		if (channel < priv->temp_count)
>> +			return 0444;
>> +
>> +		break;
>
> IMO, these could be written as:
> 		return channel < priv->temp_count ? 0444 : 0;

Ack.

>
>> +	case hwmon_fan:
>> +		if (channel < priv->fan_count)
>> +			return 0444;
>> +
>> +		break;
>> +	case hwmon_pwm:
>> +		if (channel < priv->fan_count)
>> +			return 0444;
>> +
>> +		break;
>> +	default:
>> +		break;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
>> +			   u32 attr, int channel, long *val)
>> +{
>> +	struct awcc_priv *priv = dev_get_drvdata(dev);
>> +	struct awcc_fan_data *fan;
>> +	u32 state;
>> +	int ret;
>> +	u8 temp;
>> +
>> +	switch (type) {
>> +	case hwmon_temp:
>> +		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
>> +		if (temp >= U8_MAX)
>
> It cannot be larger than as its type is u8??

Thanks, I forgot to change this! U8_MAX should be replaced with
priv->temp_sensors_size.

Thank you for reviewing this set! :)

-- 
 ~ Kurt

>
>> +			return -ENXIO;
>> +
>> +		switch (attr) {
>> +		case hwmon_temp_input:
>> +			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_TEMPERATURE,
>> +						       temp, &state);
>> +			if (ret)
>> +				return ret;
>> +
>> +			*val = state * MILLIDEGREE_PER_DEGREE;
>> +			break;
>> +		default:
>> +			return -EOPNOTSUPP;
>> +		}
>> +
>> +		break;
>> +	case hwmon_fan:
>> +		fan = priv->fan_data[channel];
>> +
>> +		switch (attr) {
>> +		case hwmon_fan_input:
>> +			ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_FAN_RPM,
>> +						       fan->id, &state);
>> +			if (ret)
>> +				return ret;
>> +
>> +			*val = state;
>> +			break;
>> +		case hwmon_fan_min:
>> +			*val = fan->min_rpm;
>> +			break;
>> +		case hwmon_fan_max:
>> +			*val = fan->max_rpm;
>> +			break;
>> +		default:
>> +			return -EOPNOTSUPP;
>> +		}
>> +
>> +		break;
>> +	case hwmon_pwm:
>> +		fan = priv->fan_data[channel];
>> +
>> +		bitmap_copy(val, fan->auto_channels_temp, BITS_PER_LONG);
>> +		break;
>> +	default:
>> +		return -EOPNOTSUPP;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_hwmon_read_string(struct device *dev, enum hwmon_sensor_types type,
>> +				  u32 attr, int channel, const char **str)
>> +{
>> +	struct awcc_priv *priv = dev_get_drvdata(dev);
>> +	struct awcc_fan_data *fan;
>> +	u8 temp;
>> +
>> +	switch (type) {
>> +	case hwmon_temp:
>> +		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
>> +		if (temp >= U8_MAX)
>> +			return -ENXIO;
>> +
>> +		switch (temp) {
>> +		case AWCC_TEMP_SENSOR_CPU:
>> +			*str = "CPU";
>> +			break;
>> +		case AWCC_TEMP_SENSOR_GPU:
>> +			*str = "GPU";
>> +			break;
>> +		default:
>> +			*str = "Unknown";
>> +			break;
>> +		}
>> +
>> +		break;
>> +	case hwmon_fan:
>> +		fan = priv->fan_data[channel];
>> +
>> +		switch (fan->total_temps) {
>> +		case 0:
>> +			*str = "Independent Fan";
>> +			break;
>> +		case 1:
>> +			temp = find_first_bit(fan->related_temps, U8_MAX);
>> +
>> +			switch (temp) {
>> +			case AWCC_TEMP_SENSOR_CPU:
>> +				*str = "Processor Fan";
>> +				break;
>> +			case AWCC_TEMP_SENSOR_GPU:
>> +				*str = "Video Fan";
>> +				break;
>> +			default:
>> +				*str = "Unknown Fan";
>> +				break;
>> +			}
>> +
>> +			break;
>> +		default:
>> +			*str = "Shared Fan";
>> +			break;
>> +		}
>> +
>> +		break;
>> +	default:
>> +		return -EOPNOTSUPP;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static const struct hwmon_ops awcc_hwmon_ops = {
>> +	.is_visible = awcc_hwmon_is_visible,
>> +	.read = awcc_hwmon_read,
>> +	.read_string = awcc_hwmon_read_string,
>> +};
>> +
>> +static const struct hwmon_channel_info * const awcc_hwmon_info[] = {
>> +	HWMON_CHANNEL_INFO(temp,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT,
>> +			   HWMON_T_LABEL | HWMON_T_INPUT
>> +			   ),
>> +	HWMON_CHANNEL_INFO(fan,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX,
>> +			   HWMON_F_LABEL | HWMON_F_INPUT | HWMON_F_MIN | HWMON_F_MAX
>> +			   ),
>> +	HWMON_CHANNEL_INFO(pwm,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP,
>> +			   HWMON_PWM_AUTO_CHANNELS_TEMP
>> +			   ),
>> +	NULL
>> +};
>> +
>> +static const struct hwmon_chip_info awcc_hwmon_chip_info = {
>> +	.ops = &awcc_hwmon_ops,
>> +	.info = awcc_hwmon_info,
>> +};
>> +
>> +static int awcc_hwmon_temps_init(struct wmi_device *wdev)
>> +{
>> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
>> +	unsigned long temp_sensors[BITS_TO_LONGS(U8_MAX)];
>> +	unsigned int i, max_sensor_id = 0;
>> +	int ret;
>> +	u32 id;
>> +
>> +	for (i = 0; i < priv->temp_count; i++) {
>> +		/*
>> +		 * Temperature sensors IDs are listed after the fan IDs at
>> +		 * offset `fan_count`
>> +		 */
>> +		ret = awcc_op_get_resource_id(wdev, i + priv->fan_count, &id);
>> +		if (ret)
>> +			return ret;
>> +
>> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
>> +		if (id > max_sensor_id)
>> +			max_sensor_id = id;
>> +
>> +		ret = __test_and_set_bit(id, temp_sensors);
>> +		if (ret)
>> +			dev_warn(&wdev->dev, "Sensor ID at index %u is duplicated\n", i);
>> +	}
>> +
>> +	/*
>> +	 * We prefer to allocate the bitmap dynamically because usually temp IDs
>> +	 * are small (< 0x30) and only one UL is needed to store it, but there
>> +	 * may be unknown devices that break this rule
>> +	 */
>> +	priv->temp_sensors_size = max_sensor_id + 1;
>> +	priv->temp_sensors = devm_bitmap_zalloc(&wdev->dev, priv->temp_sensors_size,
>> +						GFP_KERNEL);
>> +	if (!priv->temp_sensors)
>> +		return -ENOMEM;
>> +
>> +	bitmap_copy(priv->temp_sensors, temp_sensors, priv->temp_sensors_size);
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_hwmon_fans_init(struct wmi_device *wdev)
>> +{
>> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
>> +	u32 id, min_rpm, max_rpm, total_fan_temps, temp_id;
>> +	unsigned long gather[BITS_TO_LONGS(U8_MAX)];
>> +	struct awcc_fan_data *fan_data;
>> +	unsigned int i, j;
>> +	int ret;
>> +
>> +	for (i = 0; i < priv->fan_count; i++) {
>> +		fan_data = devm_kzalloc(&wdev->dev, sizeof(*fan_data), GFP_KERNEL);
>> +		if (!fan_data)
>> +			return -ENOMEM;
>> +
>> +		fan_data->related_temps = devm_bitmap_zalloc(&wdev->dev,
>> +							     priv->temp_sensors_size,
>> +							     GFP_KERNEL);
>> +		if (!priv->temp_sensors)
>> +			return -ENOMEM;
>> +
>> +		fan_data->auto_channels_temp = devm_bitmap_zalloc(&wdev->dev,
>> +								  priv->temp_count,
>> +								  GFP_KERNEL);
>> +		if (!priv->temp_sensors)
>> +			return -ENOMEM;
>> +
>> +		/*
>> +		 * Fan IDs are listed first at offset 0
>> +		 */
>> +		ret = awcc_op_get_resource_id(wdev, i, &id);
>> +		if (ret)
>> +			return ret;
>> +		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, id);
>> +
>> +		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MIN_RPM, id,
>> +					       &min_rpm);
>> +		if (ret)
>> +			return ret;
>> +
>> +		ret = awcc_thermal_information(wdev, AWCC_OP_GET_FAN_MAX_RPM, id,
>> +					       &max_rpm);
>> +		if (ret)
>> +			return ret;
>> +
>> +		ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_TOTAL_FAN_TEMPS, id,
>> +					   0, &total_fan_temps);
>> +		if (ret)
>> +			return ret;
>> +
>> +		for (j = 0; j < total_fan_temps; j++) {
>> +			ret = awcc_get_fan_sensors(wdev, AWCC_OP_GET_FAN_TEMP_ID,
>> +						   id, j, &temp_id);
>> +			if (ret)
>> +				break;
>> +
>> +			temp_id = FIELD_GET(AWCC_RESOURCE_ID_MASK, temp_id);
>> +			if (temp_id < priv->temp_sensors_size)
>> +				__set_bit(temp_id, fan_data->related_temps);
>> +		}
>> +
>> +		fan_data->id = id;
>> +		fan_data->min_rpm = min_rpm;
>> +		fan_data->max_rpm = max_rpm;
>> +		fan_data->total_temps = total_fan_temps;
>> +		bitmap_gather(gather, fan_data->related_temps, priv->temp_sensors,
>> +			      priv->temp_sensors_size);
>> +		bitmap_copy(fan_data->auto_channels_temp, gather, priv->temp_count);
>> +		priv->fan_data[i] = fan_data;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_hwmon_init(struct wmi_device *wdev)
>> +{
>> +	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
>> +	int ret;
>> +
>> +	priv->fan_data = devm_kcalloc(&wdev->dev, priv->fan_count,
>> +				      sizeof(*priv->fan_data), GFP_KERNEL);
>> +	if (!priv->fan_data)
>> +		return -ENOMEM;
>> +
>> +	ret = awcc_hwmon_temps_init(wdev);
>> +	if (ret)
>> +		return ret;
>> +
>> +	ret = awcc_hwmon_fans_init(wdev);
>> +	if (ret)
>> +		return ret;
>> +
>> +	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi", priv,
>> +							   &awcc_hwmon_chip_info, NULL);
>> +
>> +	return PTR_ERR_OR_ZERO(priv->hwdev);
>> +}
>> +
>>  /*
>>   * Thermal Profile control
>>   *  - Provides thermal profile control through the Platform Profile API
>> @@ -735,6 +1125,12 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>>  	priv->wdev = wdev;
>>  	dev_set_drvdata(&wdev->dev, priv);
>>  
>> +	if (awcc->hwmon) {
>> +		ret = awcc_hwmon_init(wdev);
>> +		if (ret)
>> +			return ret;
>> +	}
>> +
>>  	if (awcc->pprof) {
>>  		ret = awcc_platform_profile_init(wdev);
>>  		if (ret)
>> @@ -815,6 +1211,13 @@ int __init alienware_wmax_wmi_init(void)
>>  	if (id)
>>  		awcc = id->driver_data;
>>  
>> +	if (force_hwmon) {
>> +		if (!awcc)
>> +			awcc = &empty_quirks;
>> +
>> +		awcc->hwmon = true;
>> +	}
>> +
>>  	if (force_platform_profile) {
>>  		if (!awcc)
>>  			awcc = &empty_quirks;
>> 

Re: [PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support

[Ilpo Järvinen]

[-- Attachment #1: Type: text/plain, Size: 7816 bytes --]

On Tue, 4 Mar 2025, Kurt Borja wrote:

> On Tue Mar 4, 2025 at 10:53 AM -05, Ilpo Järvinen wrote:
> > On Tue, 25 Feb 2025, Kurt Borja wrote:
> >
> >> All models with the "AWCC" WMAX device support monitoring fan speed and
> >> temperature sensors. Expose this feature through the HWMON interface.
> >> 
> >> Sensor readings are cached for 1 second before refreshing them to
> >> mitigate the performance cost of calling WMI methods.
> >> 
> >> Cc: Guenter Roeck <linux@roeck-us.net>
> >> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> >> ---
> >>  drivers/platform/x86/dell/Kconfig             |   1 +
> >>  .../platform/x86/dell/alienware-wmi-wmax.c    | 403 ++++++++++++++++++
> >>  2 files changed, 404 insertions(+)
> >> 
> >> diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
> >> index f8a0dffcaab7..85a57c01aaad 100644
> >> --- a/drivers/platform/x86/dell/Kconfig
> >> +++ b/drivers/platform/x86/dell/Kconfig
> >> @@ -43,6 +43,7 @@ config ALIENWARE_WMI_WMAX
> >>  	bool "Alienware WMAX WMI device driver"
> >>  	default y
> >>  	depends on ALIENWARE_WMI
> >> +	depends on HWMON
> >>  	select ACPI_PLATFORM_PROFILE
> >>  	help
> >>  	 Alienware WMI driver with AlienFX LED, HDMI, amplifier, deep sleep and
> >> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> >> index bbe87f91fcb6..818023a5b205 100644
> >> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> >> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> >> @@ -9,10 +9,13 @@
> >>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
> >>  
> >>  #include <linux/bitfield.h>
> >> +#include <linux/bitmap.h>
> >>  #include <linux/bits.h>
> >>  #include <linux/dmi.h>
> >> +#include <linux/hwmon.h>
> >>  #include <linux/moduleparam.h>
> >>  #include <linux/platform_profile.h>
> >> +#include <linux/units.h>
> >>  #include <linux/wmi.h>
> >>  #include "alienware-wmi.h"
> >>  
> >> @@ -25,6 +28,7 @@
> >>  #define WMAX_METHOD_BRIGHTNESS			0x3
> >>  #define WMAX_METHOD_ZONE_CONTROL		0x4
> >>  
> >> +#define AWCC_METHOD_GET_FAN_SENSORS		0x13
> >>  #define AWCC_METHOD_THERMAL_INFORMATION		0x14
> >>  #define AWCC_METHOD_THERMAL_CONTROL		0x15
> >>  #define AWCC_METHOD_GAME_SHIFT_STATUS		0x25
> >> @@ -38,6 +42,10 @@
> >>  /* Arbitrary limit based on supported models */
> >>  #define AWCC_MAX_RES_COUNT			16
> >>  
> >> +static bool force_hwmon;
> >> +module_param_unsafe(force_hwmon, bool, 0);
> >> +MODULE_PARM_DESC(force_hwmon, "Force probing for HWMON support without checking if the WMI backend is available");
> >> +
> >>  static bool force_platform_profile;
> >>  module_param_unsafe(force_platform_profile, bool, 0);
> >>  MODULE_PARM_DESC(force_platform_profile, "Forces auto-detecting thermal profiles without checking if WMI thermal backend is available");
> >> @@ -47,16 +55,19 @@ module_param_unsafe(force_gmode, bool, 0);
> >>  MODULE_PARM_DESC(force_gmode, "Forces G-Mode when performance profile is selected");
> >>  
> >>  struct awcc_quirks {
> >> +	bool hwmon;
> >>  	bool pprof;
> >>  	bool gmode;
> >>  };
> >>  
> >>  static struct awcc_quirks g_series_quirks = {
> >> +	.hwmon = true,
> >>  	.pprof = true,
> >>  	.gmode = true,
> >>  };
> >>  
> >>  static struct awcc_quirks generic_quirks = {
> >> +	.hwmon = true,
> >>  	.pprof = true,
> >>  	.gmode = false,
> >>  };
> >> @@ -154,9 +165,18 @@ static const struct dmi_system_id awcc_dmi_table[] __initconst = {
> >>  	},
> >>  };
> >>  
> >> +enum AWCC_GET_FAN_SENSORS_OPERATIONS {
> >> +	AWCC_OP_GET_TOTAL_FAN_TEMPS		= 0x01,
> >> +	AWCC_OP_GET_FAN_TEMP_ID			= 0x02,
> >> +};
> >> +
> >>  enum AWCC_THERMAL_INFORMATION_OPERATIONS {
> >>  	AWCC_OP_GET_SYSTEM_DESCRIPTION		= 0x02,
> >>  	AWCC_OP_GET_RESOURCE_ID			= 0x03,
> >> +	AWCC_OP_GET_TEMPERATURE			= 0x04,
> >> +	AWCC_OP_GET_FAN_RPM			= 0x05,
> >> +	AWCC_OP_GET_FAN_MIN_RPM			= 0x08,
> >> +	AWCC_OP_GET_FAN_MAX_RPM			= 0x09,
> >>  	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
> >>  };
> >>  
> >> @@ -179,6 +199,12 @@ enum AWCC_SPECIAL_THERMAL_CODES {
> >>  	AWCC_SPECIAL_PROFILE_GMODE		= 0xAB,
> >>  };
> >>  
> >> +enum AWCC_TEMP_SENSOR_TYPES {
> >> +	AWCC_TEMP_SENSOR_CPU			= 0x01,
> >> +	AWCC_TEMP_SENSOR_GPU			= 0x06,
> >> +	AWCC_TEMP_SENSOR_LAST
> >> +};
> >> +
> >>  enum awcc_thermal_profile {
> >>  	AWCC_PROFILE_USTT_BALANCED,
> >>  	AWCC_PROFILE_USTT_BALANCED_PERFORMANCE,
> >> @@ -215,6 +241,15 @@ struct wmax_u32_args {
> >>  	u8 arg3;
> >>  } __packed;
> >>  
> >> +struct awcc_fan_data {
> >> +	unsigned long *related_temps;
> >> +	unsigned long *auto_channels_temp;
> >> +	u32 total_temps;
> >> +	u32 min_rpm;
> >> +	u32 max_rpm;
> >> +	u8 id;
> >> +};
> >> +
> >>  struct awcc_priv {
> >>  	struct wmi_device *wdev;
> >>  	union {
> >> @@ -230,6 +265,11 @@ struct awcc_priv {
> >>  
> >>  	struct device *ppdev;
> >>  	u8 supported_profiles[PLATFORM_PROFILE_LAST];
> >> +
> >> +	struct device *hwdev;
> >> +	struct awcc_fan_data **fan_data;
> >> +	unsigned int temp_sensors_size;
> >> +	unsigned long *temp_sensors;
> >>  };
> >>  
> >>  static const enum platform_profile_option awcc_mode_to_platform_profile[AWCC_PROFILE_LAST] = {
> >> @@ -494,6 +534,19 @@ static int __awcc_wmi_command(struct wmi_device *wdev, u32 method_id,
> >>  	return 0;
> >>  }
> >>  
> >> +static inline int awcc_get_fan_sensors(struct wmi_device *wdev, u8 operation,
> >> +				       u8 fan_id, u8 index, u32 *out)
> >> +{
> >> +	struct wmax_u32_args args = {
> >> +		.operation = operation,
> >> +		.arg1 = fan_id,
> >> +		.arg2 = index,
> >> +		.arg3 = 0,
> >> +	};
> >> +
> >> +	return __awcc_wmi_command(wdev, AWCC_METHOD_GET_FAN_SENSORS, &args, out);
> >> +}
> >> +
> >>  static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
> >>  					   u8 arg, u32 *out)
> >>  {
> >> @@ -564,6 +617,343 @@ static inline int awcc_op_get_resource_id(struct wmi_device *wdev, u8 index, u32
> >>  	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
> >>  }
> >>  
> >> +/*
> >> + * HWMON
> >> + *  - Provides temperature and fan speed monitoring as well as manual fan
> >> + *    control
> >> + */
> >> +static umode_t awcc_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_types type,
> >> +				     u32 attr, int channel)
> >> +{
> >> +	const struct awcc_priv *priv = drvdata;
> >> +
> >> +	switch (type) {
> >> +	case hwmon_temp:
> >> +		if (channel < priv->temp_count)
> >> +			return 0444;
> >> +
> >> +		break;
> >
> > IMO, these could be written as:
> > 		return channel < priv->temp_count ? 0444 : 0;
> 
> Ack.
> 
> >
> >> +	case hwmon_fan:
> >> +		if (channel < priv->fan_count)
> >> +			return 0444;
> >> +
> >> +		break;
> >> +	case hwmon_pwm:
> >> +		if (channel < priv->fan_count)
> >> +			return 0444;
> >> +
> >> +		break;
> >> +	default:
> >> +		break;
> >> +	}
> >> +
> >> +	return 0;
> >> +}
> >> +
> >> +static int awcc_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
> >> +			   u32 attr, int channel, long *val)
> >> +{
> >> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> >> +	struct awcc_fan_data *fan;
> >> +	u32 state;
> >> +	int ret;
> >> +	u8 temp;
> >> +
> >> +	switch (type) {
> >> +	case hwmon_temp:
> >> +		temp = find_nth_bit(priv->temp_sensors, U8_MAX, channel);
> >> +		if (temp >= U8_MAX)
> >
> > It cannot be larger than as its type is u8??
> 
> Thanks, I forgot to change this! U8_MAX should be replaced with
> priv->temp_sensors_size.

I recall seeing another similar line somewhere else in the file so please 
take a look at that as well.

> Thank you for reviewing this set! :)
> 
> 

-- 
 i.

Re: [PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support

[kernel test robot]

Hi Kurt,

kernel test robot noticed the following build errors:

[auto build test ERROR on c86e269c4da6dca2beaf99bdc6fd9f0a9f69035f]

url:    https://github.com/intel-lab-lkp/linux/commits/Kurt-Borja/platform-x86-alienware-wmi-wmax-Rename-thermal-related-symbols/20250226-063232
base:   c86e269c4da6dca2beaf99bdc6fd9f0a9f69035f
patch link:    https://lore.kernel.org/r/20250225222500.23535-8-kuurtb%40gmail.com
patch subject: [PATCH v2 07/10] platform/x86: alienware-wmi-wmax: Add HWMON support
config: x86_64-randconfig-074-20250305 (https://download.01.org/0day-ci/archive/20250305/202503051819.bQ9P70Og-lkp@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250305/202503051819.bQ9P70Og-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202503051819.bQ9P70Og-lkp@intel.com/

All errors (new ones prefixed by >>):

   ld: vmlinux.o: in function `awcc_platform_profile_init':
>> drivers/platform/x86/dell/alienware-wmi-wmax.c:1096: undefined reference to `devm_platform_profile_register'
   ld: vmlinux.o: in function `awcc_hwmon_init':
>> drivers/platform/x86/dell/alienware-wmi-wmax.c:951: undefined reference to `devm_hwmon_device_register_with_info'


vim +1096 drivers/platform/x86/dell/alienware-wmi-wmax.c

d29a9de20be84d Kurt Borja 2025-02-25   932  
d29a9de20be84d Kurt Borja 2025-02-25   933  static int awcc_hwmon_init(struct wmi_device *wdev)
d29a9de20be84d Kurt Borja 2025-02-25   934  {
d29a9de20be84d Kurt Borja 2025-02-25   935  	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
d29a9de20be84d Kurt Borja 2025-02-25   936  	int ret;
d29a9de20be84d Kurt Borja 2025-02-25   937  
d29a9de20be84d Kurt Borja 2025-02-25   938  	priv->fan_data = devm_kcalloc(&wdev->dev, priv->fan_count,
d29a9de20be84d Kurt Borja 2025-02-25   939  				      sizeof(*priv->fan_data), GFP_KERNEL);
d29a9de20be84d Kurt Borja 2025-02-25   940  	if (!priv->fan_data)
d29a9de20be84d Kurt Borja 2025-02-25   941  		return -ENOMEM;
d29a9de20be84d Kurt Borja 2025-02-25   942  
d29a9de20be84d Kurt Borja 2025-02-25   943  	ret = awcc_hwmon_temps_init(wdev);
d29a9de20be84d Kurt Borja 2025-02-25   944  	if (ret)
d29a9de20be84d Kurt Borja 2025-02-25   945  		return ret;
d29a9de20be84d Kurt Borja 2025-02-25   946  
d29a9de20be84d Kurt Borja 2025-02-25   947  	ret = awcc_hwmon_fans_init(wdev);
d29a9de20be84d Kurt Borja 2025-02-25   948  	if (ret)
d29a9de20be84d Kurt Borja 2025-02-25   949  		return ret;
d29a9de20be84d Kurt Borja 2025-02-25   950  
d29a9de20be84d Kurt Borja 2025-02-25  @951  	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi", priv,
d29a9de20be84d Kurt Borja 2025-02-25   952  							   &awcc_hwmon_chip_info, NULL);
d29a9de20be84d Kurt Borja 2025-02-25   953  
d29a9de20be84d Kurt Borja 2025-02-25   954  	return PTR_ERR_OR_ZERO(priv->hwdev);
d29a9de20be84d Kurt Borja 2025-02-25   955  }
d29a9de20be84d Kurt Borja 2025-02-25   956  
404d3e186207d4 Kurt Borja 2025-02-25   957  /*
404d3e186207d4 Kurt Borja 2025-02-25   958   * Thermal Profile control
404d3e186207d4 Kurt Borja 2025-02-25   959   *  - Provides thermal profile control through the Platform Profile API
404d3e186207d4 Kurt Borja 2025-02-25   960   */
94b96f340b5e25 Kurt Borja 2025-02-25   961  static int awcc_platform_profile_get(struct device *dev,
8cc2c415d092e1 Kurt Borja 2025-02-07   962  				     enum platform_profile_option *profile)
8cc2c415d092e1 Kurt Borja 2025-02-07   963  {
8cc2c415d092e1 Kurt Borja 2025-02-07   964  	struct awcc_priv *priv = dev_get_drvdata(dev);
8cc2c415d092e1 Kurt Borja 2025-02-07   965  	u32 out_data;
8cc2c415d092e1 Kurt Borja 2025-02-07   966  	int ret;
8cc2c415d092e1 Kurt Borja 2025-02-07   967  
94b96f340b5e25 Kurt Borja 2025-02-25   968  	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_CURRENT_PROFILE,
8cc2c415d092e1 Kurt Borja 2025-02-07   969  				       0, &out_data);
8cc2c415d092e1 Kurt Borja 2025-02-07   970  
8cc2c415d092e1 Kurt Borja 2025-02-07   971  	if (ret < 0)
8cc2c415d092e1 Kurt Borja 2025-02-07   972  		return ret;
8cc2c415d092e1 Kurt Borja 2025-02-07   973  
1dc40c13e81906 Kurt Borja 2025-02-25   974  	switch (out_data) {
1dc40c13e81906 Kurt Borja 2025-02-25   975  	case AWCC_SPECIAL_PROFILE_CUSTOM:
1dc40c13e81906 Kurt Borja 2025-02-25   976  		*profile = PLATFORM_PROFILE_CUSTOM;
1dc40c13e81906 Kurt Borja 2025-02-25   977  		return 0;
1dc40c13e81906 Kurt Borja 2025-02-25   978  	case AWCC_SPECIAL_PROFILE_GMODE:
8cc2c415d092e1 Kurt Borja 2025-02-07   979  		*profile = PLATFORM_PROFILE_PERFORMANCE;
8cc2c415d092e1 Kurt Borja 2025-02-07   980  		return 0;
1dc40c13e81906 Kurt Borja 2025-02-25   981  	default:
1dc40c13e81906 Kurt Borja 2025-02-25   982  		break;
8cc2c415d092e1 Kurt Borja 2025-02-07   983  	}
8cc2c415d092e1 Kurt Borja 2025-02-07   984  
0cc2eb52fa337a Kurt Borja 2025-02-25   985  	if (!is_awcc_thermal_profile_id(out_data))
8cc2c415d092e1 Kurt Borja 2025-02-07   986  		return -ENODATA;
8cc2c415d092e1 Kurt Borja 2025-02-07   987  
94b96f340b5e25 Kurt Borja 2025-02-25   988  	out_data &= AWCC_THERMAL_MODE_MASK;
94b96f340b5e25 Kurt Borja 2025-02-25   989  	*profile = awcc_mode_to_platform_profile[out_data];
8cc2c415d092e1 Kurt Borja 2025-02-07   990  
8cc2c415d092e1 Kurt Borja 2025-02-07   991  	return 0;
8cc2c415d092e1 Kurt Borja 2025-02-07   992  }
8cc2c415d092e1 Kurt Borja 2025-02-07   993  
94b96f340b5e25 Kurt Borja 2025-02-25   994  static int awcc_platform_profile_set(struct device *dev,
8cc2c415d092e1 Kurt Borja 2025-02-07   995  				     enum platform_profile_option profile)
8cc2c415d092e1 Kurt Borja 2025-02-07   996  {
8cc2c415d092e1 Kurt Borja 2025-02-07   997  	struct awcc_priv *priv = dev_get_drvdata(dev);
8cc2c415d092e1 Kurt Borja 2025-02-07   998  
8cc2c415d092e1 Kurt Borja 2025-02-07   999  	if (awcc->gmode) {
8cc2c415d092e1 Kurt Borja 2025-02-07  1000  		u32 gmode_status;
8cc2c415d092e1 Kurt Borja 2025-02-07  1001  		int ret;
8cc2c415d092e1 Kurt Borja 2025-02-07  1002  
94b96f340b5e25 Kurt Borja 2025-02-25  1003  		ret = awcc_game_shift_status(priv->wdev,
94b96f340b5e25 Kurt Borja 2025-02-25  1004  					     AWCC_OP_GET_GAME_SHIFT_STATUS,
8cc2c415d092e1 Kurt Borja 2025-02-07  1005  					     &gmode_status);
8cc2c415d092e1 Kurt Borja 2025-02-07  1006  
8cc2c415d092e1 Kurt Borja 2025-02-07  1007  		if (ret < 0)
8cc2c415d092e1 Kurt Borja 2025-02-07  1008  			return ret;
8cc2c415d092e1 Kurt Borja 2025-02-07  1009  
8cc2c415d092e1 Kurt Borja 2025-02-07  1010  		if ((profile == PLATFORM_PROFILE_PERFORMANCE && !gmode_status) ||
8cc2c415d092e1 Kurt Borja 2025-02-07  1011  		    (profile != PLATFORM_PROFILE_PERFORMANCE && gmode_status)) {
94b96f340b5e25 Kurt Borja 2025-02-25  1012  			ret = awcc_game_shift_status(priv->wdev,
94b96f340b5e25 Kurt Borja 2025-02-25  1013  						     AWCC_OP_TOGGLE_GAME_SHIFT,
8cc2c415d092e1 Kurt Borja 2025-02-07  1014  						     &gmode_status);
8cc2c415d092e1 Kurt Borja 2025-02-07  1015  
8cc2c415d092e1 Kurt Borja 2025-02-07  1016  			if (ret < 0)
8cc2c415d092e1 Kurt Borja 2025-02-07  1017  				return ret;
8cc2c415d092e1 Kurt Borja 2025-02-07  1018  		}
8cc2c415d092e1 Kurt Borja 2025-02-07  1019  	}
8cc2c415d092e1 Kurt Borja 2025-02-07  1020  
94b96f340b5e25 Kurt Borja 2025-02-25  1021  	return awcc_thermal_control(priv->wdev,
6b90057f955757 Kurt Borja 2025-02-25  1022  				    priv->supported_profiles[profile]);
8cc2c415d092e1 Kurt Borja 2025-02-07  1023  }
8cc2c415d092e1 Kurt Borja 2025-02-07  1024  
94b96f340b5e25 Kurt Borja 2025-02-25  1025  static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
8cc2c415d092e1 Kurt Borja 2025-02-07  1026  {
8cc2c415d092e1 Kurt Borja 2025-02-07  1027  	enum platform_profile_option profile;
8cc2c415d092e1 Kurt Borja 2025-02-07  1028  	struct awcc_priv *priv = drvdata;
94b96f340b5e25 Kurt Borja 2025-02-25  1029  	enum awcc_thermal_profile mode;
443362838f8842 Kurt Borja 2025-02-25  1030  	u8 id, offset = 0;
8cc2c415d092e1 Kurt Borja 2025-02-07  1031  	u32 out_data;
8cc2c415d092e1 Kurt Borja 2025-02-07  1032  	int ret;
8cc2c415d092e1 Kurt Borja 2025-02-07  1033  
443362838f8842 Kurt Borja 2025-02-25  1034  	/*
443362838f8842 Kurt Borja 2025-02-25  1035  	 * Thermal profile IDs are listed last at offset
443362838f8842 Kurt Borja 2025-02-25  1036  	 *	fan_count + temp_count + unknown_count
443362838f8842 Kurt Borja 2025-02-25  1037  	 */
443362838f8842 Kurt Borja 2025-02-25  1038  	for (unsigned int i = 0; i < ARRAY_SIZE(priv->res_count) - 1; i++)
443362838f8842 Kurt Borja 2025-02-25  1039  		offset += priv->res_count[i];
8cc2c415d092e1 Kurt Borja 2025-02-07  1040  
443362838f8842 Kurt Borja 2025-02-25  1041  	for (unsigned int i = 0; i < priv->profile_count; i++) {
443362838f8842 Kurt Borja 2025-02-25  1042  		ret = awcc_op_get_resource_id(priv->wdev, i + offset, &out_data);
8cc2c415d092e1 Kurt Borja 2025-02-07  1043  		if (ret == -EIO)
8cc2c415d092e1 Kurt Borja 2025-02-07  1044  			return ret;
8cc2c415d092e1 Kurt Borja 2025-02-07  1045  
443362838f8842 Kurt Borja 2025-02-25  1046  		/*
443362838f8842 Kurt Borja 2025-02-25  1047  		 * Some devices report an incorrect number of thermal profiles
443362838f8842 Kurt Borja 2025-02-25  1048  		 * so the resource ID list may end prematurely
443362838f8842 Kurt Borja 2025-02-25  1049  		 */
8cc2c415d092e1 Kurt Borja 2025-02-07  1050  		if (ret == -EBADRQC)
8cc2c415d092e1 Kurt Borja 2025-02-07  1051  			break;
8cc2c415d092e1 Kurt Borja 2025-02-07  1052  
0cc2eb52fa337a Kurt Borja 2025-02-25  1053  		/* Some IDs have a BIT(8) flag that should be ignored */
0cc2eb52fa337a Kurt Borja 2025-02-25  1054  		id = FIELD_GET(AWCC_RESOURCE_ID_MASK, out_data);
443362838f8842 Kurt Borja 2025-02-25  1055  		if (!is_awcc_thermal_profile_id(id)) {
443362838f8842 Kurt Borja 2025-02-25  1056  			dev_dbg(&priv->wdev->dev, "Unmapped thermal profile ID 0x%02x\n", id);
8cc2c415d092e1 Kurt Borja 2025-02-07  1057  			continue;
443362838f8842 Kurt Borja 2025-02-25  1058  		}
8cc2c415d092e1 Kurt Borja 2025-02-07  1059  
0cc2eb52fa337a Kurt Borja 2025-02-25  1060  		mode = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
94b96f340b5e25 Kurt Borja 2025-02-25  1061  		profile = awcc_mode_to_platform_profile[mode];
6b90057f955757 Kurt Borja 2025-02-25  1062  		priv->supported_profiles[profile] = id;
8cc2c415d092e1 Kurt Borja 2025-02-07  1063  
443362838f8842 Kurt Borja 2025-02-25  1064  		__set_bit(profile, choices);
8cc2c415d092e1 Kurt Borja 2025-02-07  1065  	}
8cc2c415d092e1 Kurt Borja 2025-02-07  1066  
8cc2c415d092e1 Kurt Borja 2025-02-07  1067  	if (bitmap_empty(choices, PLATFORM_PROFILE_LAST))
8cc2c415d092e1 Kurt Borja 2025-02-07  1068  		return -ENODEV;
8cc2c415d092e1 Kurt Borja 2025-02-07  1069  
8cc2c415d092e1 Kurt Borja 2025-02-07  1070  	if (awcc->gmode) {
6b90057f955757 Kurt Borja 2025-02-25  1071  		priv->supported_profiles[PLATFORM_PROFILE_PERFORMANCE] =
1dc40c13e81906 Kurt Borja 2025-02-25  1072  			AWCC_SPECIAL_PROFILE_GMODE;
8cc2c415d092e1 Kurt Borja 2025-02-07  1073  
443362838f8842 Kurt Borja 2025-02-25  1074  		__set_bit(PLATFORM_PROFILE_PERFORMANCE, choices);
8cc2c415d092e1 Kurt Borja 2025-02-07  1075  	}
8cc2c415d092e1 Kurt Borja 2025-02-07  1076  
1dc40c13e81906 Kurt Borja 2025-02-25  1077  	/* Every model supports the "custom" profile */
1dc40c13e81906 Kurt Borja 2025-02-25  1078  	priv->supported_profiles[PLATFORM_PROFILE_CUSTOM] =
1dc40c13e81906 Kurt Borja 2025-02-25  1079  		AWCC_SPECIAL_PROFILE_CUSTOM;
1dc40c13e81906 Kurt Borja 2025-02-25  1080  
1dc40c13e81906 Kurt Borja 2025-02-25  1081  	__set_bit(PLATFORM_PROFILE_CUSTOM, choices);
1dc40c13e81906 Kurt Borja 2025-02-25  1082  
8cc2c415d092e1 Kurt Borja 2025-02-07  1083  	return 0;
8cc2c415d092e1 Kurt Borja 2025-02-07  1084  }
8cc2c415d092e1 Kurt Borja 2025-02-07  1085  
8cc2c415d092e1 Kurt Borja 2025-02-07  1086  static const struct platform_profile_ops awcc_platform_profile_ops = {
94b96f340b5e25 Kurt Borja 2025-02-25  1087  	.probe = awcc_platform_profile_probe,
94b96f340b5e25 Kurt Borja 2025-02-25  1088  	.profile_get = awcc_platform_profile_get,
94b96f340b5e25 Kurt Borja 2025-02-25  1089  	.profile_set = awcc_platform_profile_set,
8cc2c415d092e1 Kurt Borja 2025-02-07  1090  };
8cc2c415d092e1 Kurt Borja 2025-02-07  1091  
8cc2c415d092e1 Kurt Borja 2025-02-07  1092  static int awcc_platform_profile_init(struct wmi_device *wdev)
8cc2c415d092e1 Kurt Borja 2025-02-07  1093  {
8cc2c415d092e1 Kurt Borja 2025-02-07  1094  	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
8cc2c415d092e1 Kurt Borja 2025-02-07  1095  
8cc2c415d092e1 Kurt Borja 2025-02-07 @1096  	priv->ppdev = devm_platform_profile_register(&wdev->dev, "alienware-wmi",
8cc2c415d092e1 Kurt Borja 2025-02-07  1097  						     priv, &awcc_platform_profile_ops);
8cc2c415d092e1 Kurt Borja 2025-02-07  1098  
8cc2c415d092e1 Kurt Borja 2025-02-07  1099  	return PTR_ERR_OR_ZERO(priv->ppdev);
8cc2c415d092e1 Kurt Borja 2025-02-07  1100  }
8cc2c415d092e1 Kurt Borja 2025-02-07  1101  

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

[PATCH v2 08/10] platform/x86: alienware-wmi-wmax: Add support for manual fan control

[Kurt Borja]

All models with the "AWCC" WMAX device support a way of manually
controlling fans.

The PWM duty cycle of a fan can't be controlled directly. Instead the
AWCC interface let's us tune a PWM `boost` value, which has the
following empirically discovered, aproximate behavior over the PWM
value:

	pwm = pwm_base + (pwm_boost / 255) * (pwm_max - pwm_base)

Where the pwm_base is the locked PWM value controlled by the FW and
pwm_boost is a value between 0 and 255.

Expose this pwm_boost knob as a custom HWMON attribute.

Cc: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 152 +++++++++++++++++-
 1 file changed, 144 insertions(+), 8 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 818023a5b205..64818efc3a1a 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -13,8 +13,11 @@
 #include <linux/bits.h>
 #include <linux/dmi.h>
 #include <linux/hwmon.h>
+#include <linux/hwmon-sysfs.h>
+#include <linux/minmax.h>
 #include <linux/moduleparam.h>
 #include <linux/platform_profile.h>
+#include <linux/pm.h>
 #include <linux/units.h>
 #include <linux/wmi.h>
 #include "alienware-wmi.h"
@@ -178,10 +181,12 @@ enum AWCC_THERMAL_INFORMATION_OPERATIONS {
 	AWCC_OP_GET_FAN_MIN_RPM			= 0x08,
 	AWCC_OP_GET_FAN_MAX_RPM			= 0x09,
 	AWCC_OP_GET_CURRENT_PROFILE		= 0x0B,
+	AWCC_OP_GET_FAN_BOOST			= 0x0C,
 };
 
 enum AWCC_THERMAL_CONTROL_OPERATIONS {
 	AWCC_OP_ACTIVATE_PROFILE		= 0x01,
+	AWCC_OP_SET_FAN_BOOST			= 0x02,
 };
 
 enum AWCC_GAME_SHIFT_STATUS_OPERATIONS {
@@ -247,6 +252,7 @@ struct awcc_fan_data {
 	u32 total_temps;
 	u32 min_rpm;
 	u32 max_rpm;
+	u8 suspend_cache;
 	u8 id;
 };
 
@@ -560,12 +566,13 @@ static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation
 	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
 }
 
-static inline int awcc_thermal_control(struct wmi_device *wdev, u8 profile)
+static inline int awcc_thermal_control(struct wmi_device *wdev, u8 operation,
+				       u8 arg1, u8 arg2)
 {
 	struct wmax_u32_args args = {
-		.operation = AWCC_OP_ACTIVATE_PROFILE,
-		.arg1 = profile,
-		.arg2 = 0,
+		.operation = operation,
+		.arg1 = arg1,
+		.arg2 = arg2,
 		.arg3 = 0,
 	};
 	u32 out;
@@ -815,6 +822,77 @@ static const struct hwmon_chip_info awcc_hwmon_chip_info = {
 	.info = awcc_hwmon_info,
 };
 
+static ssize_t pwm_boost_show(struct device *dev, struct device_attribute *attr,
+			      char *buf)
+{
+	int ret, index = to_sensor_dev_attr(attr)->index;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *data = priv->fan_data[index];
+	u32 boost;
+
+	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_FAN_BOOST, data->id,
+				       &boost);
+	if (ret)
+		return ret;
+
+	return sysfs_emit(buf, "%u\n", boost);
+}
+
+static ssize_t pwm_boost_store(struct device *dev, struct device_attribute *attr,
+			       const char *buf, size_t count)
+{
+	int ret, index = to_sensor_dev_attr(attr)->index;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *data = priv->fan_data[index];
+	unsigned long val;
+
+	ret = kstrtoul(buf, 0, &val);
+	if (ret)
+		return ret;
+
+	ret = awcc_thermal_control(priv->wdev, AWCC_OP_SET_FAN_BOOST, data->id,
+				   clamp_val(val, 0, 255));
+
+	return ret ? ret : count;
+}
+
+static SENSOR_DEVICE_ATTR_RW(pwm1_boost, pwm_boost, 0);
+static SENSOR_DEVICE_ATTR_RW(pwm2_boost, pwm_boost, 1);
+static SENSOR_DEVICE_ATTR_RW(pwm3_boost, pwm_boost, 2);
+static SENSOR_DEVICE_ATTR_RW(pwm4_boost, pwm_boost, 3);
+
+static umode_t pwm_boost_attr_visible(struct kobject *kobj, struct attribute *attr, int n)
+{
+	struct awcc_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
+
+	return n < priv->fan_count ? attr->mode : 0;
+}
+
+static bool pwm_boost_group_visible(struct kobject *kobj)
+{
+	return true;
+}
+
+DEFINE_SYSFS_GROUP_VISIBLE(pwm_boost);
+
+static struct attribute *fan_boost_attrs[] = {
+	&sensor_dev_attr_pwm1_boost.dev_attr.attr,
+	&sensor_dev_attr_pwm2_boost.dev_attr.attr,
+	&sensor_dev_attr_pwm3_boost.dev_attr.attr,
+	&sensor_dev_attr_pwm4_boost.dev_attr.attr,
+	NULL
+};
+
+static const struct attribute_group pwm_boost_group = {
+	.attrs = fan_boost_attrs,
+	.is_visible = SYSFS_GROUP_VISIBLE(pwm_boost),
+};
+
+static const struct attribute_group *awcc_hwmon_groups[] = {
+	&pwm_boost_group,
+	NULL
+};
+
 static int awcc_hwmon_temps_init(struct wmi_device *wdev)
 {
 	struct awcc_priv *priv = dev_get_drvdata(&wdev->dev);
@@ -948,12 +1026,51 @@ static int awcc_hwmon_init(struct wmi_device *wdev)
 	if (ret)
 		return ret;
 
-	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi", priv,
-							   &awcc_hwmon_chip_info, NULL);
+	priv->hwdev = devm_hwmon_device_register_with_info(&wdev->dev, "alienware_wmi",
+							   priv, &awcc_hwmon_chip_info,
+							   awcc_hwmon_groups);
 
 	return PTR_ERR_OR_ZERO(priv->hwdev);
 }
 
+static void awcc_hwmon_suspend(struct device *dev)
+{
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *fan;
+	unsigned int i;
+	u32 boost;
+	int ret;
+
+	for (i = 0; i < priv->fan_count; i++) {
+		fan = priv->fan_data[i];
+
+		ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_FAN_BOOST,
+					       fan->id, &boost);
+		if (ret)
+			fan->suspend_cache = 0;
+		else
+			fan->suspend_cache = clamp_val(boost, 0, 255);
+
+		awcc_thermal_control(priv->wdev, AWCC_OP_SET_FAN_BOOST, fan->id, 0);
+	}
+}
+
+static void awcc_hwmon_resume(struct device *dev)
+{
+
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *fan;
+	unsigned int i;
+
+	for (i = 0; i < priv->fan_count; i++) {
+		fan = priv->fan_data[i];
+
+		if (fan->suspend_cache)
+			awcc_thermal_control(priv->wdev, AWCC_OP_SET_FAN_BOOST,
+					     fan->id, fan->suspend_cache);
+	}
+}
+
 /*
  * Thermal Profile control
  *  - Provides thermal profile control through the Platform Profile API
@@ -1018,8 +1135,8 @@ static int awcc_platform_profile_set(struct device *dev,
 		}
 	}
 
-	return awcc_thermal_control(priv->wdev,
-				    priv->supported_profiles[profile]);
+	return awcc_thermal_control(priv->wdev, AWCC_OP_ACTIVATE_PROFILE,
+				    priv->supported_profiles[profile], 0);
 }
 
 static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
@@ -1187,6 +1304,24 @@ static int wmax_wmi_probe(struct wmi_device *wdev, const void *context)
 	return ret;
 }
 
+static int wmax_wmi_suspend(struct device *dev)
+{
+	if (awcc->hwmon)
+		awcc_hwmon_suspend(dev);
+
+	return 0;
+}
+
+static int wmax_wmi_resume(struct device *dev)
+{
+	if (awcc->hwmon)
+		awcc_hwmon_resume(dev);
+
+	return 0;
+}
+
+DEFINE_SIMPLE_DEV_PM_OPS(wmax_wmi_pm_ops, wmax_wmi_suspend, wmax_wmi_resume);
+
 static const struct wmi_device_id alienware_wmax_device_id_table[] = {
 	{ WMAX_CONTROL_GUID, NULL },
 	{ },
@@ -1197,6 +1332,7 @@ static struct wmi_driver alienware_wmax_wmi_driver = {
 	.driver = {
 		.name = "alienware-wmi-wmax",
 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
+		.pm = pm_sleep_ptr(&wmax_wmi_pm_ops),
 	},
 	.id_table = alienware_wmax_device_id_table,
 	.probe = wmax_wmi_probe,
-- 
2.48.1

[PATCH v2 09/10] platform/x86: alienware-wmi-wmax: Add a DebugFS interface

[Kurt Borja]

Add a debugfs interface which exposes thermal private data.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 .../platform/x86/dell/alienware-wmi-wmax.c    | 92 +++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 64818efc3a1a..14faa6ee3e73 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -11,6 +11,7 @@
 #include <linux/bitfield.h>
 #include <linux/bitmap.h>
 #include <linux/bits.h>
+#include <linux/debugfs.h>
 #include <linux/dmi.h>
 #include <linux/hwmon.h>
 #include <linux/hwmon-sysfs.h>
@@ -18,6 +19,7 @@
 #include <linux/moduleparam.h>
 #include <linux/platform_profile.h>
 #include <linux/pm.h>
+#include <linux/seq_file.h>
 #include <linux/units.h>
 #include <linux/wmi.h>
 #include "alienware-wmi.h"
@@ -1216,6 +1218,94 @@ static int awcc_platform_profile_init(struct wmi_device *wdev)
 	return PTR_ERR_OR_ZERO(priv->ppdev);
 }
 
+/*
+ * DebugFS
+ */
+static int awcc_debugfs_system_description_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+
+	seq_printf(seq, "0x%08x\n", priv->system_description);
+
+	return 0;
+}
+
+static int awcc_debugfs_hwmon_data_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	struct awcc_fan_data *fan_data;
+	u8 bit;
+
+	seq_printf(seq, "Number of fans: %u\n", priv->fan_count);
+	seq_printf(seq, "Number of temperature sensors: %u\n\n", priv->temp_count);
+
+	for (u32 i = 0; i < priv->fan_count; i++) {
+		fan_data = priv->fan_data[i];
+
+		seq_printf(seq, "Fan %u:\n", i);
+		seq_printf(seq, "  ID: 0x%02x\n", fan_data->id);
+		seq_printf(seq, "  Related temperature sensors: ");
+		for_each_set_bit(bit, fan_data->related_temps, priv->temp_sensors_size)
+			seq_printf(seq, "0x%02x ", bit);
+		seq_puts(seq, "\n");
+	}
+
+	seq_puts(seq, "\n");
+
+	seq_printf(seq, "Temperature sensor IDs:\n");
+	for_each_set_bit(bit, priv->temp_sensors, priv->temp_sensors_size)
+		seq_printf(seq, "  0x%02x\n", bit);
+
+	return 0;
+}
+
+static int awcc_debugfs_pprof_data_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+
+	seq_printf(seq, "Number of thermal profiles: %u\n\n", priv->profile_count);
+
+	for (u32 i = 0; i < PLATFORM_PROFILE_LAST; i++) {
+		if (!priv->supported_profiles[i])
+			continue;
+
+		seq_printf(seq, "Platform profile %u:\n", i);
+		seq_printf(seq, "  ID: 0x%02x\n", priv->supported_profiles[i]);
+	}
+
+	return 0;
+}
+
+static void awcc_debugfs_remove(void *data)
+{
+	struct dentry *root = data;
+
+	debugfs_remove(root);
+}
+
+static void awcc_debugfs_init(struct wmi_device *wdev)
+{
+	struct dentry *root;
+
+	root = debugfs_create_dir("alienware-wmi", NULL);
+
+	debugfs_create_devm_seqfile(&wdev->dev, "system_description", root,
+				    awcc_debugfs_system_description_read);
+
+	if (awcc->hwmon)
+		debugfs_create_devm_seqfile(&wdev->dev, "hwmon_data", root,
+					    awcc_debugfs_hwmon_data_read);
+
+	if (awcc->pprof)
+		debugfs_create_devm_seqfile(&wdev->dev, "pprof_data", root,
+					    awcc_debugfs_pprof_data_read);
+
+	devm_add_action_or_reset(&wdev->dev, awcc_debugfs_remove, root);
+}
+
 static int alienware_awcc_setup(struct wmi_device *wdev)
 {
 	struct awcc_priv *priv;
@@ -1254,6 +1344,8 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
 			return ret;
 	}
 
+	awcc_debugfs_init(wdev);
+
 	return 0;
 }
 
-- 
2.48.1

[PATCH v2 10/10] platform/x86: alienware-wmi: Improve and update documentation

[Kurt Borja]

Use tables to describe method operations instead of using pseudo-code.
Drop unknown method descriptions to avoid redundancy. Drop GPIO section
as it is currently irrelevant to this driver. Update Thermal_Information
method documentation. Add one more helpful developer to the kudos section.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 Documentation/wmi/devices/alienware-wmi.rst | 387 ++++++--------------
 1 file changed, 119 insertions(+), 268 deletions(-)

diff --git a/Documentation/wmi/devices/alienware-wmi.rst b/Documentation/wmi/devices/alienware-wmi.rst
index ddc5e561960e..79238051b18b 100644
--- a/Documentation/wmi/devices/alienware-wmi.rst
+++ b/Documentation/wmi/devices/alienware-wmi.rst
@@ -11,7 +11,7 @@ The WMI device WMAX has been implemented for many Alienware and Dell's G-Series
 models. Throughout these models, two implementations have been identified. The
 first one, used by older systems, deals with HDMI, brightness, RGB, amplifier
 and deep sleep control. The second one used by newer systems deals primarily
-with thermal, overclocking, and GPIO control.
+with thermal control and overclocking.
 
 It is suspected that the latter is used by Alienware Command Center (AWCC) to
 manage manufacturer predefined thermal profiles. The alienware-wmi driver
@@ -69,9 +69,6 @@ data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
    [WmiMethodId(164), Implemented, read, write, Description("Tobii Camera Power Off.")] void TobiiCameraPowerOff([out] uint32 argr);
  };
 
-Some of these methods get quite intricate so we will describe them using
-pseudo-code that vaguely resembles the original ASL code.
-
 Methods not described in the following document have unknown behavior.
 
 Argument Structure
@@ -87,175 +84,133 @@ ID 0xA0, the argument you would pass to the method is 0xA001.
 Thermal Methods
 ===============
 
-WMI method Thermal_Information([in] uint32 arg2, [out] uint32 argr)
--------------------------------------------------------------------
-
-::
-
- if BYTE_0(arg2) == 0x01:
-         argr = 1
-
- if BYTE_0(arg2) == 0x02:
-         argr = SYSTEM_DESCRIPTION
-
- if BYTE_0(arg2) == 0x03:
-         if BYTE_1(arg2) == 0x00:
-                 argr = FAN_ID_0
-
-         if BYTE_1(arg2) == 0x01:
-                 argr = FAN_ID_1
-
-         if BYTE_1(arg2) == 0x02:
-                 argr = FAN_ID_2
-
-         if BYTE_1(arg2) == 0x03:
-                 argr = FAN_ID_3
-
-         if BYTE_1(arg2) == 0x04:
-                 argr = SENSOR_ID_CPU | 0x0100
-
-         if BYTE_1(arg2) == 0x05:
-                 argr = SENSOR_ID_GPU | 0x0100
-
-         if BYTE_1(arg2) == 0x06:
-                 argr = THERMAL_MODE_QUIET_ID
-
-         if BYTE_1(arg2) == 0x07:
-                 argr = THERMAL_MODE_BALANCED_ID
-
-         if BYTE_1(arg2) == 0x08:
-                 argr = THERMAL_MODE_BALANCED_PERFORMANCE_ID
-
-         if BYTE_1(arg2) == 0x09:
-                 argr = THERMAL_MODE_PERFORMANCE_ID
-
-         if BYTE_1(arg2) == 0x0A:
-                 argr = THERMAL_MODE_LOW_POWER_ID
-
-         if BYTE_1(arg2) == 0x0B:
-                 argr = THERMAL_MODE_GMODE_ID
-
-         else:
-                 argr = 0xFFFFFFFF
-
- if BYTE_0(arg2) == 0x04:
-         if is_valid_sensor(BYTE_1(arg2)):
-                 argr = SENSOR_TEMP_C
-         else:
-                 argr = 0xFFFFFFFF
-
- if BYTE_0(arg2) == 0x05:
-         if is_valid_fan(BYTE_1(arg2)):
-                 argr = FAN_RPM()
-
- if BYTE_0(arg2) == 0x06:
-         skip
-
- if BYTE_0(arg2) == 0x07:
-         argr = 0
-
- If BYTE_0(arg2) == 0x08:
-         if is_valid_fan(BYTE_1(arg2)):
-                 argr = 0
-         else:
-                 argr = 0xFFFFFFFF
-
- if BYTE_0(arg2) == 0x09:
-         if is_valid_fan(BYTE_1(arg2)):
-                 argr = FAN_UNKNOWN_STAT_0()
-
-         else:
-                 argr = 0xFFFFFFFF
-
- if BYTE_0(arg2) == 0x0A:
-         argr = THERMAL_MODE_BALANCED_ID
-
- if BYTE_0(arg2) == 0x0B:
-         argr = CURRENT_THERMAL_MODE()
-
- if BYTE_0(arg2) == 0x0C:
-         if is_valid_fan(BYTE_1(arg2)):
-                 argr = FAN_UNKNOWN_STAT_1()
-         else:
-                 argr = 0xFFFFFFFF
-
-Operation 0x02 returns a *system description* buffer with the following
-structure:
-
-::
-
- out[0] -> Number of fans
- out[1] -> Number of sensors
- out[2] -> 0x00
- out[3] -> Number of thermal modes
+WMI method GetFanSensors([in] uint32 arg2, [out] uint32 argr)
+-------------------------------------------------------------
 
-Operation 0x03 list all available fan IDs, sensor IDs and thermal profile
-codes in order, but different models may have different number of fans and
-thermal profiles. These are the known ranges:
++--------------------+------------------------------------+--------------------+
+| Operation (Byte 0) | Description                        | Arguments          |
++====================+====================================+====================+
+| 0x01               | Get the number of temperature      | - Byte 1: Fan ID   |
+|                    | sensors related with a fan ID      |                    |
++--------------------+------------------------------------+--------------------+
+| 0x02               | Get the temperature sensor IDs     | - Byte 1: Fan ID   |
+|                    | related to a fan sensor ID         | - Byte 2: Index    |
++--------------------+------------------------------------+--------------------+
 
-* Fan IDs: from 2 up to 4
-* Sensor IDs: 2
-* Thermal profile codes: from 1 up to 7
+WMI method Thermal_Information([in] uint32 arg2, [out] uint32 argr)
+-------------------------------------------------------------------
 
-In total BYTE_1(ARG2) may range from 0x5 up to 0xD depending on the model.
++--------------------+------------------------------------+--------------------+
+| Operation (Byte 0) | Description                        | Arguments          |
++====================+====================================+====================+
+| 0x01               | Unknown.                           | - None             |
++--------------------+------------------------------------+--------------------+
+| 0x02               | Get system description number with | - None             |
+|                    | the following structure:           |                    |
+|                    |                                    |                    |
+|                    | - Byte 0: Number of fans           |                    |
+|                    | - Byte 1: Number of temperature    |                    |
+|                    |   sensors                          |                    |
+|                    | - Byte 2: Unknown                  |                    |
+|                    | - Byte 3: Number of thermal        |                    |
+|                    |   profiles                         |                    |
++--------------------+------------------------------------+--------------------+
+| 0x03               | List an ID or resource at a given  | - Byte 1: Index    |
+|                    | index. Fan IDs, temperature IDs,   |                    |
+|                    | unknown IDs and thermal profile    |                    |
+|                    | IDs are listed in that exact       |                    |
+|                    | order.                             |                    |
+|                    |                                    |                    |
+|                    | Operation 0x02 is used to know     |                    |
+|                    | which indexes map to which         |                    |
+|                    | resources.                         |                    |
+|                    |                                    |                    |
+|                    | **Returns:** ID at a given index   |                    |
++--------------------+------------------------------------+--------------------+
+| 0x04               | Get the current temperature for a  | - Byte 1: Sensor   |
+|                    | given temperature sensor.          |   ID               |
++--------------------+------------------------------------+--------------------+
+| 0x05               | Get the current RPM for a given    | - Byte 1: Fan ID   |
+|                    | fan.                               |                    |
++--------------------+------------------------------------+--------------------+
+| 0x06               | Get fan speed percentage. (not     | - Byte 1: Fan ID   |
+|                    | implemented in every model)        |                    |
++--------------------+------------------------------------+--------------------+
+| 0x07               | Unknown.                           | - Unknown          |
++--------------------+------------------------------------+--------------------+
+| 0x08               | Get minimum RPM for a given FAN    | - Byte 1: Fan ID   |
+|                    | ID.                                |                    |
++--------------------+------------------------------------+--------------------+
+| 0x09               | Get maximum RPM for a given FAN    | - Byte 1: Fan ID   |
+|                    | ID.                                |                    |
++--------------------+------------------------------------+--------------------+
+| 0x0A               | Get balanced thermal profile ID.   | - None             |
++--------------------+------------------------------------+--------------------+
+| 0x0B               | Get current thermal profile ID.    | - None             |
++--------------------+------------------------------------+--------------------+
+| 0x0C               | Get current `boost` value for a    | - Byte 1: Fan ID   |
+|                    | given fan ID.                      |                    |
++--------------------+------------------------------------+--------------------+
 
 WMI method Thermal_Control([in] uint32 arg2, [out] uint32 argr)
 ---------------------------------------------------------------
 
-::
-
- if BYTE_0(arg2) == 0x01:
-         if is_valid_thermal_profile(BYTE_1(arg2)):
-                 SET_THERMAL_PROFILE(BYTE_1(arg2))
-                 argr = 0
-
- if BYTE_0(arg2) == 0x02:
-         if is_valid_fan(BYTE_1(arg2)):
-                 SET_FAN_SPEED_MULTIPLIER(BYTE_2(arg2))
-                 argr = 0
-         else:
-                 argr = 0xFFFFFFFF
-
-.. note::
-   While you can manually change the fan speed multiplier with this method,
-   Dell's BIOS tends to overwrite this changes anyway.
++--------------------+------------------------------------+--------------------+
+| Operation (Byte 0) | Description                        | Arguments          |
++====================+====================================+====================+
+| 0x01               | Activate a given thermal profile.  | - Byte 1: Thermal  |
+|                    |                                    |   profile ID       |
++--------------------+------------------------------------+--------------------+
+| 0x02               | Set a `boost` value for a given    | - Byte 1: Fan ID   |
+|                    | fan ID.                            | - Byte 2: Boost    |
++--------------------+------------------------------------+--------------------+
 
 These are the known thermal profile codes:
 
-::
-
- CUSTOM                         0x00
-
- BALANCED_USTT                  0xA0
- BALANCED_PERFORMANCE_USTT      0xA1
- COOL_USTT                      0xA2
- QUIET_USTT                     0xA3
- PERFORMANCE_USTT               0xA4
- LOW_POWER_USTT                 0xA5
-
- QUIET                          0x96
- BALANCED                       0x97
- BALANCED_PERFORMANCE           0x98
- PERFORMANCE                    0x99
-
- GMODE                          0xAB
-
-Usually if a model doesn't support the first four profiles they will support
-the User Selectable Thermal Tables (USTT) profiles and vice-versa.
-
-GMODE replaces PERFORMANCE in G-Series laptops.
++------------------------------+----------+------+
+| Thermal Profile              | Type     | ID   |
++==============================+==========+======+
+| Custom                       | Special  | 0x00 |
++------------------------------+----------+------+
+| G-Mode                       | Special  | 0xAB |
++------------------------------+----------+------+
+| Quiet                        | Legacy   | 0x96 |
++------------------------------+----------+------+
+| Balanced                     | Legacy   | 0x97 |
++------------------------------+----------+------+
+| Balanced Performance         | Legacy   | 0x98 |
++------------------------------+----------+------+
+| Performance                  | Legacy   | 0x99 |
++------------------------------+----------+------+
+| Balanced                     | USTT     | 0xA0 |
++------------------------------+----------+------+
+| Balanced Performance         | USTT     | 0xA1 |
++------------------------------+----------+------+
+| Cool                         | USTT     | 0xA2 |
++------------------------------+----------+------+
+| Quiet                        | USTT     | 0xA3 |
++------------------------------+----------+------+
+| Performance                  | USTT     | 0xA4 |
++------------------------------+----------+------+
+| Low Power                    | USTT     | 0xA5 |
++------------------------------+----------+------+
+
+If a model supports the User Selectable Thermal Tables (USTT) profiles, it will
+not support the Legacy profiles and vice-versa.
+
+Every model supports the CUSTOM (0x00) thermal profile. GMODE replaces
+PERFORMANCE in G-Series laptops.
 
 WMI method GameShiftStatus([in] uint32 arg2, [out] uint32 argr)
 ---------------------------------------------------------------
 
-::
-
- if BYTE_0(arg2) == 0x1:
-         TOGGLE_GAME_SHIFT()
-         argr = GET_GAME_SHIFT_STATUS()
-
- if BYTE_0(arg2) == 0x2:
-         argr = GET_GAME_SHIFT_STATUS()
++--------------------+------------------------------------+--------------------+
+| Operation (Byte 0) | Description                        | Arguments          |
++====================+====================================+====================+
+| 0x01               | Toggle *Game Shift*.               | - None             |
++--------------------+------------------------------------+--------------------+
+| 0x02               | Get *Game Shift* status.           | - None             |
++--------------------+------------------------------------+--------------------+
 
 Game Shift Status does not change the fan speed profile but it could be some
 sort of CPU/GPU power profile. Benchmarks have not been done.
@@ -267,131 +222,27 @@ Thermal_Information does not list it.
 G-key on Dell's G-Series laptops also changes Game Shift status, so both are
 directly related.
 
-WMI method GetFanSensors([in] uint32 arg2, [out] uint32 argr)
--------------------------------------------------------------
-
-::
-
- if BYTE_0(arg2) == 0x1:
-        if is_valid_fan(BYTE_1(arg2)):
-                argr = 1
-        else:
-                argr = 0
-
- if BYTE_0(arg2) == 0x2:
-        if is_valid_fan(BYTE_1(arg2)):
-                if BYTE_2(arg2) == 0:
-                        argr == SENSOR_ID
-                else
-                        argr == 0xFFFFFFFF
-        else:
-                argr = 0
-
 Overclocking Methods
 ====================
 
-.. warning::
-   These methods have not been tested and are only partially reverse
-   engineered.
-
-WMI method Return_OverclockingReport([out] uint32 argr)
--------------------------------------------------------
-
-::
-
- CSMI (0xE3, 0x99)
- argr = 0
-
-CSMI is an unknown operation.
-
-WMI method Set_OCUIBIOSControl([in] uint32 arg2, [out] uint32 argr)
--------------------------------------------------------------------
-
-::
-
- CSMI (0xE3, 0x99)
- argr = 0
-
-CSMI is an unknown operation.
-
-WMI method Clear_OCFailSafeFlag([out] uint32 argr)
---------------------------------------------------
-
-::
-
- CSMI (0xE3, 0x99)
- argr = 0
-
-CSMI is an unknown operation.
-
-
 WMI method MemoryOCControl([in] uint32 arg2, [out] uint32 argr)
 ---------------------------------------------------------------
 
 AWCC supports memory overclocking, but this method is very intricate and has
 not been deciphered yet.
 
-GPIO methods
-============
-
-These methods are probably related to some kind of firmware update system,
-through a GPIO device.
-
-.. warning::
-   These methods have not been tested and are only partially reverse
-   engineered.
-
-WMI method FWUpdateGPIOtoggle([in] uint32 arg2, [out] uint32 argr)
-------------------------------------------------------------------
-
-::
-
- if BYTE_0(arg2) == 0:
-         if BYTE_1(arg2) == 1:
-                 SET_PIN_A_HIGH()
-         else:
-                 SET_PIN_A_LOW()
-
- if BYTE_0(arg2) == 1:
-         if BYTE_1(arg2) == 1:
-                 SET_PIN_B_HIGH()
-
-         else:
-                 SET_PIN_B_LOW()
-
- else:
-         argr = 1
-
-WMI method ReadTotalofGPIOs([out] uint32 argr)
-----------------------------------------------
-
-::
-
- argr = 0x02
-
-WMI method ReadGPIOpPinStatus([in] uint32 arg2, [out] uint32 argr)
-------------------------------------------------------------------
-
-::
-
- if BYTE_0(arg2) == 0:
-         argr = PIN_A_STATUS
-
- if BYTE_0(arg2) == 1:
-         argr = PIN_B_STATUS
-
 Other information Methods
 =========================
 
 WMI method ReadChassisColor([out] uint32 argr)
 ----------------------------------------------
 
-::
-
- argr = CHASSIS_COLOR_ID
+Returns the chassis color internal ID.
 
 Acknowledgements
 ================
 
-Kudos to `AlexIII <https://github.com/AlexIII/tcc-g15>`_ for documenting
-and testing available thermal profile codes.
+Kudos to `AlexIII <https://github.com/AlexIII/tcc-g15>`_ and
+`T-Troll <https://github.com/T-Troll/alienfx-tools/>`_ for documenting and
+testing some of this device's functionality, making it possible to generalize
+this driver.
-- 
2.48.1