[PATCH 30/40] drm/amd/pm/powerplay/hwmgr/vega12_thermal: Fix some outdated function documentation
Alex Deucher
alexdeucher at gmail.com
Mon Nov 30 23:54:10 UTC 2020
On Thu, Nov 26, 2020 at 8:43 AM Lee Jones <lee.jones at linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:63: warning: Cannot understand * @fn vega12_enable_fan_control_feature
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:137: warning: Function parameter or member 'hwmgr' not described in 'vega12_fan_ctrl_reset_fan_speed_to_default'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:147: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_get_temperature'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:172: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_set_temperature_range'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:172: warning: Function parameter or member 'range' not described in 'vega12_thermal_set_temperature_range'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:208: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_enable_alert'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:226: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_disable_alert'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:240: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_stop_thermal_controller'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:256: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_setup_fan_table'
> drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega12_thermal.c:279: warning: Function parameter or member 'hwmgr' not described in 'vega12_thermal_start_smc_fan_control'
>
> Cc: Evan Quan <evan.quan at amd.com>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Cc: "Christian König" <christian.koenig at amd.com>
> Cc: David Airlie <airlied at linux.ie>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: amd-gfx at lists.freedesktop.org
> Cc: dri-devel at lists.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones at linaro.org>
Applied. Thanks!
Alex
> ---
> .../amd/pm/powerplay/hwmgr/vega12_thermal.c | 82 ++++++++-----------
> 1 file changed, 36 insertions(+), 46 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega12_thermal.c b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega12_thermal.c
> index 7ace439dcde7a..0dc16f25a463b 100644
> --- a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega12_thermal.c
> +++ b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega12_thermal.c
> @@ -60,11 +60,10 @@ int vega12_fan_ctrl_get_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t *speed)
> }
>
> /**
> - * @fn vega12_enable_fan_control_feature
> - * @brief Enables the SMC Fan Control Feature.
> + * vega12_enable_fan_control_feature -Enables the SMC Fan Control Feature.
> *
> - * @param hwmgr - the address of the powerplay hardware manager.
> - * @return 0 on success. -1 otherwise.
> + * @hwmgr: the address of the powerplay hardware manager.
> + * Return: 0 on success. -1 otherwise.
> */
> static int vega12_enable_fan_control_feature(struct pp_hwmgr *hwmgr)
> {
> @@ -129,20 +128,20 @@ int vega12_fan_ctrl_stop_smc_fan_control(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Reset Fan Speed to default.
> -* @param hwmgr the address of the powerplay hardware manager.
> -* @exception Always succeeds.
> -*/
> + * vega12_fan_ctrl_reset_fan_speed_to_default - Reset Fan Speed to default.
> + * @hwmgr: the address of the powerplay hardware manager.
> + * Exception Always succeeds.
> + */
> int vega12_fan_ctrl_reset_fan_speed_to_default(struct pp_hwmgr *hwmgr)
> {
> return vega12_fan_ctrl_start_smc_fan_control(hwmgr);
> }
>
> /**
> -* Reads the remote temperature from the SIslands thermal controller.
> -*
> -* @param hwmgr The address of the hardware manager.
> -*/
> + * vega12_thermal_get_temperature - Reads the remote temperature from the SIslands thermal controller.
> + *
> + * @hwmgr: The address of the hardware manager.
> + */
> int vega12_thermal_get_temperature(struct pp_hwmgr *hwmgr)
> {
> struct amdgpu_device *adev = hwmgr->adev;
> @@ -160,13 +159,13 @@ int vega12_thermal_get_temperature(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Set the requested temperature range for high and low alert signals
> -*
> -* @param hwmgr The address of the hardware manager.
> -* @param range Temperature range to be programmed for
> -* high and low alert signals
> -* @exception PP_Result_BadInput if the input data is not valid.
> -*/
> + * Set the requested temperature range for high and low alert signals
> + *
> + * @hwmgr: The address of the hardware manager.
> + * @range: Temperature range to be programmed for
> + * high and low alert signals
> + * Exception: PP_Result_BadInput if the input data is not valid.
> + */
> static int vega12_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,
> struct PP_TemperatureRange *range)
> {
> @@ -200,10 +199,10 @@ static int vega12_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,
> }
>
> /**
> -* Enable thermal alerts on the RV770 thermal controller.
> -*
> -* @param hwmgr The address of the hardware manager.
> -*/
> + * vega12_thermal_enable_alert - Enable thermal alerts on the RV770 thermal controller.
> + *
> + * @hwmgr: The address of the hardware manager.
> + */
> static int vega12_thermal_enable_alert(struct pp_hwmgr *hwmgr)
> {
> struct amdgpu_device *adev = hwmgr->adev;
> @@ -219,9 +218,9 @@ static int vega12_thermal_enable_alert(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Disable thermal alerts on the RV770 thermal controller.
> -* @param hwmgr The address of the hardware manager.
> -*/
> + * vega12_thermal_disable_alert - Disable thermal alerts on the RV770 thermal controller.
> + * @hwmgr: The address of the hardware manager.
> + */
> int vega12_thermal_disable_alert(struct pp_hwmgr *hwmgr)
> {
> struct amdgpu_device *adev = hwmgr->adev;
> @@ -232,10 +231,10 @@ int vega12_thermal_disable_alert(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Uninitialize the thermal controller.
> -* Currently just disables alerts.
> -* @param hwmgr The address of the hardware manager.
> -*/
> + * vega12_thermal_stop_thermal_controller - Uninitialize the thermal controller.
> + * Currently just disables alerts.
> + * @hwmgr: The address of the hardware manager.
> + */
> int vega12_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)
> {
> int result = vega12_thermal_disable_alert(hwmgr);
> @@ -244,14 +243,9 @@ int vega12_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Set up the fan table to control the fan using the SMC.
> -* @param hwmgr the address of the powerplay hardware manager.
> -* @param pInput the pointer to input data
> -* @param pOutput the pointer to output data
> -* @param pStorage the pointer to temporary storage
> -* @param Result the last failure code
> -* @return result from set temperature range routine
> -*/
> + * vega12_thermal_setup_fan_table - Set up the fan table to control the fan using the SMC.
> + * @hwmgr: the address of the powerplay hardware manager.
> + */
> static int vega12_thermal_setup_fan_table(struct pp_hwmgr *hwmgr)
> {
> int ret;
> @@ -267,14 +261,10 @@ static int vega12_thermal_setup_fan_table(struct pp_hwmgr *hwmgr)
> }
>
> /**
> -* Start the fan control on the SMC.
> -* @param hwmgr the address of the powerplay hardware manager.
> -* @param pInput the pointer to input data
> -* @param pOutput the pointer to output data
> -* @param pStorage the pointer to temporary storage
> -* @param Result the last failure code
> -* @return result from set temperature range routine
> -*/
> + * vega12_thermal_start_smc_fan_control - Start the fan control on the SMC.
> + * @hwmgr: the address of the powerplay hardware manager.
> + * Return: result from set temperature range routine
> + */
> static int vega12_thermal_start_smc_fan_control(struct pp_hwmgr *hwmgr)
> {
> /* If the fantable setup has failed we could have disabled
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
More information about the amd-gfx
mailing list