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

[Armin Wolf <W_Armin@gmx.de>]

Am 08.02.25 um 06:16 schrieb 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, additional failure code and add a helper
> with documentation for AWCC_OP_GET_RESOURCE_ID.

"add a additional failure code"

With this being fixed:

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

> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
>   .../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;