Commit d9261648 authored by Lee Jones's avatar Lee Jones Committed by Alex Deucher
Browse files

drm/amd/pm/powerplay/hwmgr/vega10_thermal: Fix a bunch of dated function doc formatting 



Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:128: warning: Function parameter or member 'hwmgr' not described in 'vega10_fan_ctrl_set_static_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:128: warning: Function parameter or member 'mode' not described in 'vega10_fan_ctrl_set_static_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:157: warning: Function parameter or member 'hwmgr' not described in 'vega10_fan_ctrl_set_default_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:176: warning: Cannot understand  * @fn vega10_enable_fan_control_feature
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:252: warning: Function parameter or member 'hwmgr' not described in 'vega10_fan_ctrl_set_fan_speed_percent'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:252: warning: Function parameter or member 'speed' not described in 'vega10_fan_ctrl_set_fan_speed_percent'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:290: warning: Function parameter or member 'hwmgr' not described in 'vega10_fan_ctrl_reset_fan_speed_to_default'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:307: warning: Function parameter or member 'hwmgr' not described in 'vega10_fan_ctrl_set_fan_speed_rpm'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:307: warning: Function parameter or member 'speed' not described in 'vega10_fan_ctrl_set_fan_speed_rpm'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:339: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_get_temperature'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:365: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_set_temperature_range'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:365: warning: Function parameter or member 'range' not described in 'vega10_thermal_set_temperature_range'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:414: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_initialize'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:437: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_enable_alert'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:468: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_disable_alert'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:496: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_stop_thermal_controller'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:515: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_setup_fan_table'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/vega10_thermal.c:618: warning: Function parameter or member 'hwmgr' not described in 'vega10_thermal_start_smc_fan_control'

Cc: Evan Quan <evan.quan@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent aa68e9a3

drivers/gpu/drm/amd/pm/powerplay/hwmgr/vega10_thermal.c

+61 −70
Original line number Diff line number Diff line
@@ -118,11 +118,11 @@ int vega10_fan_ctrl_get_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t *speed) 
}



/**

* Set Fan Speed Control to static mode,

 * vega10_fan_ctrl_set_static_mode - Set Fan Speed Control to static mode,

 * so that the user can decide what speed to use.

* @param    hwmgr  the address of the powerplay hardware manager.

*           mode the fan control mode, 0 default, 1 by percent, 5, by RPM

* @exception Should always succeed.

 * @hwmgr:  the address of the powerplay hardware manager.

 * @mode: the fan control mode, 0 default, 1 by percent, 5, by RPM

 * Exception: Should always succeed.

 */

int vega10_fan_ctrl_set_static_mode(struct pp_hwmgr *hwmgr, uint32_t mode)

{
@@ -149,9 +149,9 @@ int vega10_fan_ctrl_set_static_mode(struct pp_hwmgr *hwmgr, uint32_t mode) 
}



/**

* Reset Fan Speed Control to default mode.

* @param    hwmgr  the address of the powerplay hardware manager.

* @exception Should always succeed.

 * vega10_fan_ctrl_set_default_mode - Reset Fan Speed Control to default mode.

 * @hwmgr:  the address of the powerplay hardware manager.

 * Exception: Should always succeed.

 */

int vega10_fan_ctrl_set_default_mode(struct pp_hwmgr *hwmgr)

{
@@ -173,11 +173,10 @@ int vega10_fan_ctrl_set_default_mode(struct pp_hwmgr *hwmgr) 
}



/**

 * @fn vega10_enable_fan_control_feature

 * @brief Enables the SMC Fan Control Feature.

 * vega10_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 vega10_enable_fan_control_feature(struct pp_hwmgr *hwmgr)

{
@@ -242,10 +241,10 @@ int vega10_fan_ctrl_stop_smc_fan_control(struct pp_hwmgr *hwmgr) 
}



/**

* Set Fan Speed in percent.

* @param    hwmgr  the address of the powerplay hardware manager.

* @param    speed is the percentage value (0% - 100%) to be set.

* @exception Fails is the 100% setting appears to be 0.

 * vega10_fan_ctrl_set_fan_speed_percent - Set Fan Speed in percent.

 * @hwmgr:  the address of the powerplay hardware manager.

 * @speed: is the percentage value (0% - 100%) to be set.

 * Exception: Fails is the 100% setting appears to be 0.

 */

int vega10_fan_ctrl_set_fan_speed_percent(struct pp_hwmgr *hwmgr,

		uint32_t speed)
@@ -282,9 +281,9 @@ int vega10_fan_ctrl_set_fan_speed_percent(struct pp_hwmgr *hwmgr, 
}



/**

* Reset Fan Speed to default.

* @param    hwmgr  the address of the powerplay hardware manager.

* @exception Always succeeds.

 * vega10_fan_ctrl_reset_fan_speed_to_default - Reset Fan Speed to default.

 * @hwmgr:  the address of the powerplay hardware manager.

 * Exception: Always succeeds.

 */

int vega10_fan_ctrl_reset_fan_speed_to_default(struct pp_hwmgr *hwmgr)

{
@@ -298,10 +297,10 @@ int vega10_fan_ctrl_reset_fan_speed_to_default(struct pp_hwmgr *hwmgr) 
}



/**

* Set Fan Speed in RPM.

* @param    hwmgr  the address of the powerplay hardware manager.

* @param    speed is the percentage value (min - max) to be set.

* @exception Fails is the speed not lie between min and max.

 * vega10_fan_ctrl_set_fan_speed_rpm - Set Fan Speed in RPM.

 * @hwmgr:  the address of the powerplay hardware manager.

 * @speed: is the percentage value (min - max) to be set.

 * Exception: Fails is the speed not lie between min and max.

 */

int vega10_fan_ctrl_set_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t speed)

{
@@ -331,9 +330,9 @@ int vega10_fan_ctrl_set_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t speed) 
}



/**

* Reads the remote temperature from the SIslands thermal controller.

 * vega10_thermal_get_temperature - Reads the remote temperature from the SIslands thermal controller.

 *

* @param    hwmgr The address of the hardware manager.

 * @hwmgr: The address of the hardware manager.

 */

int vega10_thermal_get_temperature(struct pp_hwmgr *hwmgr)

{
@@ -353,12 +352,12 @@ int vega10_thermal_get_temperature(struct pp_hwmgr *hwmgr) 
}



/**

* Set the requested temperature range for high and low alert signals

 * vega10_thermal_set_temperature_range - 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

 * @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.

 * Exception: PP_Result_BadInput if the input data is not valid.

 */

static int vega10_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,

		struct PP_TemperatureRange *range)
@@ -406,9 +405,9 @@ static int vega10_thermal_set_temperature_range(struct pp_hwmgr *hwmgr, 
}



/**

* Programs thermal controller one-time setting registers

 * vega10_thermal_initialize - Programs thermal controller one-time setting registers

 *

* @param    hwmgr The address of the hardware manager.

 * @hwmgr: The address of the hardware manager.

 */

static int vega10_thermal_initialize(struct pp_hwmgr *hwmgr)

{
@@ -429,9 +428,9 @@ static int vega10_thermal_initialize(struct pp_hwmgr *hwmgr) 
}



/**

* Enable thermal alerts on the RV770 thermal controller.

 * vega10_thermal_enable_alert - Enable thermal alerts on the RV770 thermal controller.

 *

* @param    hwmgr The address of the hardware manager.

 * @hwmgr: The address of the hardware manager.

 */

static int vega10_thermal_enable_alert(struct pp_hwmgr *hwmgr)

{
@@ -461,8 +460,8 @@ static int vega10_thermal_enable_alert(struct pp_hwmgr *hwmgr) 
}



/**

* Disable thermal alerts on the RV770 thermal controller.

* @param    hwmgr The address of the hardware manager.

 * vega10_thermal_disable_alert - Disable thermal alerts on the RV770 thermal controller.

 * @hwmgr: The address of the hardware manager.

 */

int vega10_thermal_disable_alert(struct pp_hwmgr *hwmgr)

{
@@ -488,9 +487,9 @@ int vega10_thermal_disable_alert(struct pp_hwmgr *hwmgr) 
}



/**

* Uninitialize the thermal controller.

 * vega10_thermal_stop_thermal_controller - Uninitialize the thermal controller.

 * Currently just disables alerts.

* @param    hwmgr The address of the hardware manager.

 * @hwmgr: The address of the hardware manager.

 */

int vega10_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)

{
@@ -503,13 +502,9 @@ int vega10_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

 * vega10_thermal_setup_fan_table - Set up the fan table to control the fan using the SMC.

 * @hwmgr:  the address of the powerplay hardware manager.

 * Return:   result from set temperature range routine

 */

static int vega10_thermal_setup_fan_table(struct pp_hwmgr *hwmgr)

{
@@ -606,13 +601,9 @@ int vega10_enable_mgpu_fan_boost(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

 * vega10_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 vega10_thermal_start_smc_fan_control(struct pp_hwmgr *hwmgr)

{