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

drm/amd/pm/powerplay/hwmgr/smu7_thermal: Repair formatting in a bunch of function docs 



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

 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:112: warning: Function parameter or member 'hwmgr' not described in 'smu7_fan_ctrl_set_static_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:112: warning: Function parameter or member 'mode' not described in 'smu7_fan_ctrl_set_static_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:137: warning: Function parameter or member 'hwmgr' not described in 'smu7_fan_ctrl_set_default_mode'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:209: warning: Function parameter or member 'hwmgr' not described in 'smu7_fan_ctrl_set_fan_speed_percent'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:209: warning: Function parameter or member 'speed' not described in 'smu7_fan_ctrl_set_fan_speed_percent'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:245: warning: Function parameter or member 'hwmgr' not described in 'smu7_fan_ctrl_reset_fan_speed_to_default'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:268: warning: Function parameter or member 'hwmgr' not described in 'smu7_fan_ctrl_set_fan_speed_rpm'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:268: warning: Function parameter or member 'speed' not described in 'smu7_fan_ctrl_set_fan_speed_rpm'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:299: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_get_temperature'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:325: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_set_temperature_range'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:325: warning: Function parameter or member 'low_temp' not described in 'smu7_thermal_set_temperature_range'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:325: warning: Function parameter or member 'high_temp' not described in 'smu7_thermal_set_temperature_range'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:358: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_initialize'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:377: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_enable_alert'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:395: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_disable_alert'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:414: warning: Function parameter or member 'hwmgr' not described in 'smu7_thermal_stop_thermal_controller'
 drivers/gpu/drm/amd/amdgpu/../pm/powerplay/hwmgr/smu7_thermal.c:433: warning: Function parameter or member 'hwmgr' not described in 'smu7_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 1c206370

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

+50 −53
Original line number Diff line number Diff line
@@ -103,10 +103,10 @@ int smu7_fan_ctrl_get_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t *speed) 
}



/**

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

 * smu7_fan_ctrl_set_static_mode - Set Fan Speed Control to static mode, so that the user can decide what speed to use.

 * @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 smu7_fan_ctrl_set_static_mode(struct pp_hwmgr *hwmgr, uint32_t mode)

{
@@ -130,8 +130,8 @@ int smu7_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.

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

* Exception: Should always succeed.

*/

int smu7_fan_ctrl_set_default_mode(struct pp_hwmgr *hwmgr)

{
@@ -199,10 +199,10 @@ int smu7_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.

 * smu7_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 smu7_fan_ctrl_set_fan_speed_percent(struct pp_hwmgr *hwmgr,

		uint32_t speed)
@@ -237,9 +237,9 @@ int smu7_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.

* smu7_fan_ctrl_reset_fan_speed_to_default - Reset Fan Speed to default.

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

* Exception: Always succeeds.

*/

int smu7_fan_ctrl_reset_fan_speed_to_default(struct pp_hwmgr *hwmgr)

{
@@ -259,10 +259,10 @@ int smu7_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.

 * smu7_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 smu7_fan_ctrl_set_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t speed)

{
@@ -291,9 +291,9 @@ int smu7_fan_ctrl_set_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t speed) 
}



/**

* Reads the remote temperature from the SIslands thermal controller.

 * smu7_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 smu7_thermal_get_temperature(struct pp_hwmgr *hwmgr)

{
@@ -314,11 +314,12 @@ int smu7_thermal_get_temperature(struct pp_hwmgr *hwmgr) 
}



/**

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

 * smu7_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 high and low alert signals

* @exception PP_Result_BadInput if the input data is not valid.

 * @hwmgr: The address of the hardware manager.

 * @low_temp: Temperature to be programmed for high alert signals

 * @high_temp: Temperature to be programmed for low alert signals

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

 */

static int smu7_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,

		int low_temp, int high_temp)
@@ -350,9 +351,9 @@ static int smu7_thermal_set_temperature_range(struct pp_hwmgr *hwmgr, 
}



/**

* Programs thermal controller one-time setting registers

 * smu7_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 smu7_thermal_initialize(struct pp_hwmgr *hwmgr)

{
@@ -369,9 +370,9 @@ static int smu7_thermal_initialize(struct pp_hwmgr *hwmgr) 
}



/**

* Enable thermal alerts on the RV770 thermal controller.

 * smu7_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 void smu7_thermal_enable_alert(struct pp_hwmgr *hwmgr)

{
@@ -388,8 +389,8 @@ static void smu7_thermal_enable_alert(struct pp_hwmgr *hwmgr) 
}



/**

* Disable thermal alerts on the RV770 thermal controller.

* @param    hwmgr The address of the hardware manager.

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

 * @hwmgr: The address of the hardware manager.

 */

int smu7_thermal_disable_alert(struct pp_hwmgr *hwmgr)

{
@@ -406,9 +407,9 @@ int smu7_thermal_disable_alert(struct pp_hwmgr *hwmgr) 
}



/**

* Uninitialize the thermal controller.

 * smu7_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 smu7_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)

{
@@ -421,13 +422,9 @@ int smu7_thermal_stop_thermal_controller(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

 * smu7_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 smu7_thermal_start_smc_fan_control(struct pp_hwmgr *hwmgr)

{