lkml.org 
[lkml]   [2020]   [Nov]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 23/40] drm/amd/pm/powerplay/hwmgr/smu7_thermal: Repair formatting in a bunch of function docs
    Date
    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: Lee Jones <lee.jones@linaro.org>
    ---
    .../drm/amd/pm/powerplay/hwmgr/smu7_thermal.c | 103 +++++++++---------
    1 file changed, 50 insertions(+), 53 deletions(-)

    diff --git a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/smu7_thermal.c b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/smu7_thermal.c
    index e3d9d969d86ac..0d38d4206848a 100644
    --- a/drivers/gpu/drm/amd/pm/powerplay/hwmgr/smu7_thermal.c
    +++ b/drivers/gpu/drm/amd/pm/powerplay/hwmgr/smu7_thermal.c
    @@ -103,11 +103,11 @@ 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)
    {
    if (hwmgr->fan_ctrl_is_in_default_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,11 +199,11 @@ 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,11 +259,11 @@ 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)
    {
    uint32_t tach_period;
    @@ -291,10 +291,10 @@ int smu7_fan_ctrl_set_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t speed)
    }

    /**
    -* Reads the remote temperature from the SIslands thermal controller.
    -*
    -* @param hwmgr The address of the hardware manager.
    -*/
    + * smu7_thermal_get_temperature - Reads the remote temperature from the SIslands thermal controller.
    + *
    + * @hwmgr: The address of the hardware manager.
    + */
    int smu7_thermal_get_temperature(struct pp_hwmgr *hwmgr)
    {
    int temp;
    @@ -314,12 +314,13 @@ int smu7_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.
    -*/
    + * smu7_thermal_set_temperature_range - Set the requested temperature range for high and low alert signals
    + *
    + * @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,10 +351,10 @@ static int smu7_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,
    }

    /**
    -* Programs thermal controller one-time setting registers
    -*
    -* @param hwmgr The address of the hardware manager.
    -*/
    + * smu7_thermal_initialize - Programs thermal controller one-time setting registers
    + *
    + * @hwmgr: The address of the hardware manager.
    + */
    static int smu7_thermal_initialize(struct pp_hwmgr *hwmgr)
    {
    if (hwmgr->thermal_controller.fanInfo.ucTachometerPulsesPerRevolution)
    @@ -369,10 +370,10 @@ static int smu7_thermal_initialize(struct pp_hwmgr *hwmgr)
    }

    /**
    -* Enable thermal alerts on the RV770 thermal controller.
    -*
    -* @param hwmgr The address of the hardware manager.
    -*/
    + * smu7_thermal_enable_alert - Enable thermal alerts on the RV770 thermal controller.
    + *
    + * @hwmgr: The address of the hardware manager.
    + */
    static void smu7_thermal_enable_alert(struct pp_hwmgr *hwmgr)
    {
    uint32_t alert;
    @@ -388,9 +389,9 @@ 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)
    {
    uint32_t alert;
    @@ -406,10 +407,10 @@ int smu7_thermal_disable_alert(struct pp_hwmgr *hwmgr)
    }

    /**
    -* Uninitialize the thermal controller.
    -* Currently just disables alerts.
    -* @param hwmgr The address of the hardware manager.
    -*/
    + * smu7_thermal_stop_thermal_controller - Uninitialize the thermal controller.
    + * Currently just disables alerts.
    + * @hwmgr: The address of the hardware manager.
    + */
    int smu7_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)
    {
    int result = smu7_thermal_disable_alert(hwmgr);
    @@ -421,14 +422,10 @@ 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)
    {
    /* If the fantable setup has failed we could have disabled
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-11-26 15:10    [W:6.047 / U:0.480 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site