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

[Armin Wolf <W_Armin@gmx.de>]

Am 06.03.25 um 01:56 schrieb Kurt Borja:

> Inline all AWCC WMI helper methods and directly return the newly
> introduced __awcc_wmi_command() helper to simplify implementation.
>
> Drop awcc_thermal_control() in favor of awcc_op_activate_profile().
>
> Add awcc_op_get_resource_id() and awcc_profile_id_to_pprof() helpers to
> support upcoming changes, as well as a new failure code.

Reviewed-by: Armin Wolf <W_Armin@gmx.de>

> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
>   drivers/platform/x86/dell/alienware-wmi-wmax.c | 176 +++++++++++++++----------
>   1 file changed, 110 insertions(+), 66 deletions(-)
>
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index 80aefba5b22d6b4ac18aeb2ca356f8c911150abd..a43373717bd4580e8f62a7263e67664630165e28 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)
>   /* Some IDs have a BIT(8) flag that we ignore */
> @@ -443,8 +444,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)
>   {
> @@ -463,95 +463,140 @@ 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 = {
> +	int ret;
> +
> +	ret = alienware_wmi_command(wdev, method_id, args, sizeof(*args), out);
> +	if (ret)
> +		return ret;
> +
> +	if (*out == AWCC_FAILURE_CODE || *out == AWCC_FAILURE_CODE_2)
> +		return -EBADRQC;
> +
> +	return 0;
> +}
> +
> +static inline int awcc_thermal_information(struct wmi_device *wdev, u8 operation,
> +					   u8 arg, u32 *out)
> +{
> +	struct wmax_u32_args 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)
> -		return ret;
> -
> -	if (*out_data == AWCC_FAILURE_CODE)
> -		return -EBADRQC;
> -
> -	return 0;
> +	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
>   }
>
> -static int awcc_thermal_control(struct wmi_device *wdev, u8 profile)
> +static inline int awcc_game_shift_status(struct wmi_device *wdev, u8 operation,
> +					 u32 *out)
>   {
> -	struct wmax_u32_args in_args = {
> -		.operation = AWCC_OP_ACTIVATE_PROFILE,
> -		.arg1 = profile,
> -		.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;
> -
> -	if (out_data == AWCC_FAILURE_CODE)
> -		return -EBADRQC;
> -
> -	return 0;
> -}
> -
> -static int awcc_game_shift_status(struct wmi_device *wdev, u8 operation,
> -				  u32 *out_data)
> -{
> -	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 __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
> +}
> +
> +static inline int awcc_op_get_current_profile(struct wmi_device *wdev, u32 *out)
> +{
> +	struct wmax_u32_args args = {
> +		.operation = AWCC_OP_GET_CURRENT_PROFILE,
> +		.arg1 = 0,
> +		.arg2 = 0,
> +		.arg3 = 0,
> +	};
> +
> +	return __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_INFORMATION, &args, out);
> +}
> +
> +static inline int awcc_op_activate_profile(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 __awcc_wmi_command(wdev, AWCC_METHOD_THERMAL_CONTROL, &args, &out);
> +}
> +
> +static int awcc_profile_id_to_pprof(u32 id, enum platform_profile_option *profile)
> +{
> +	switch (id) {
> +	case AWCC_THERMAL_MODE_GMODE:
> +		*profile = PLATFORM_PROFILE_PERFORMANCE;
> +		return 0;
> +	default:
> +		break;
> +	}
> +
> +	if (!is_awcc_thermal_profile_id(id))
> +		return -ENODATA;
> +
> +	id = FIELD_GET(AWCC_THERMAL_MODE_MASK, id);
> +	*profile = awcc_mode_to_platform_profile[id];
>
>   	return 0;
>   }
>
> +/*
> + * 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)
>   {
>   	struct awcc_priv *priv = dev_get_drvdata(dev);
> -	u32 out_data;
> +	u32 profile_id;
>   	int ret;
>
> -	ret = awcc_thermal_information(priv->wdev, AWCC_OP_GET_CURRENT_PROFILE,
> -				       0, &out_data);
> -
> -	if (ret < 0)
> +	ret = awcc_op_get_current_profile(priv->wdev, &profile_id);
> +	if (ret)
>   		return ret;
>
> -	if (out_data == AWCC_THERMAL_MODE_GMODE) {
> -		*profile = PLATFORM_PROFILE_PERFORMANCE;
> -		return 0;
> -	}
> -
> -	if (!is_awcc_thermal_profile_id(out_data))
> -		return -ENODATA;
> -
> -	out_data &= AWCC_THERMAL_MODE_MASK;
> -	*profile = awcc_mode_to_platform_profile[out_data];
> +	ret = awcc_profile_id_to_pprof(profile_id, profile);
> +	if (ret)
> +		return ret;
>
>   	return 0;
>   }
> @@ -583,8 +628,8 @@ static int awcc_platform_profile_set(struct device *dev,
>   		}
>   	}
>
> -	return awcc_thermal_control(priv->wdev,
> -				    priv->supported_thermal_profiles[profile]);
> +	return awcc_op_activate_profile(priv->wdev,
> +					priv->supported_thermal_profiles[profile]);
>   }
>
>   static int awcc_platform_profile_probe(void *drvdata, unsigned long *choices)
> @@ -606,8 +651,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;
>