From: Alex Deucher <alexdeucher@gmail.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: "David Airlie" <airlied@linux.ie>,
LKML <linux-kernel@vger.kernel.org>,
"amd-gfx list" <amd-gfx@lists.freedesktop.org>,
"Maling list - DRI developers" <dri-devel@lists.freedesktop.org>,
"Alex Deucher" <alexander.deucher@amd.com>,
"Evan Quan" <evan.quan@amd.com>,
"Christian König" <christian.koenig@amd.com>
Subject: Re: [PATCH 30/40] drm/amd/pm/powerplay/hwmgr/vega12_thermal: Fix some outdated function documentation
Date: Mon, 30 Nov 2020 18:54:10 -0500 [thread overview]
Message-ID: <CADnq5_Nx-6-CpBEYS=vNtvABakARnQO4+0QP1EtcJCykLK+2nA@mail.gmail.com> (raw)
In-Reply-To: <20201126134240.3214176-31-lee.jones@linaro.org>
On Thu, Nov 26, 2020 at 8:43 AM Lee Jones <lee.jones@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@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>
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@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-11-30 23:55 UTC|newest]
Thread overview: 82+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-26 13:42 [PATCH 00/40] [Set 10] Rid W=1 warnings from GPU Lee Jones
2020-11-26 13:42 ` [PATCH 01/40] drm/amd/pm/powerplay/smumgr/tonga_smumgr: Remove set but unused variable 'res' Lee Jones
2020-11-30 23:09 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 02/40] drm/amd/pm/powerplay/smumgr/polaris10_smumgr: Make function called by reference static Lee Jones
2020-11-30 23:10 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 03/40] drm/amd/pm/powerplay/smumgr/ci_smumgr: Remove set but unused variable 'res' Lee Jones
2020-11-30 23:14 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 04/40] drm/amd/pm/powerplay/smumgr/iceland_smumgr: Make function called by reference static Lee Jones
2020-11-30 23:16 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 05/40] drm/amd/pm/powerplay/smumgr/vegam_smumgr: " Lee Jones
2020-11-30 23:16 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 06/40] drm/amd/pm/powerplay/smumgr/smu9_smumgr: Include our own header containing our prototypes Lee Jones
2020-11-30 23:17 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 07/40] drm/amd/pm/powerplay/smumgr/fiji_smumgr: Demote kernel-doc format abuse Lee Jones
2020-11-30 23:18 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 08/40] drm/amd/pm/powerplay/hwmgr/hardwaremanager: Remove unused 'phm_set_*()' functions Lee Jones
2020-11-30 23:20 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 09/40] drm/amd/pm/powerplay/hwmgr/hwmgr: Move 'smu8_init_function_pointers()' prototype to shared header Lee Jones
2020-11-30 23:28 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 10/40] drm/amd/pm/inc/pp_thermal: Mark 'SMU7Thermal{WithDelay}Policy' as __maybe_unused Lee Jones
2020-11-30 23:29 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 11/40] drm/amd/pm/powerplay/hwmgr/ppevvmath: Place variable declaration under same clause as its use Lee Jones
2020-11-30 23:31 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 12/40] drm/amd/pm/powerplay/hwmgr/ppatomctrl: Remove unused variable 'fPowerDPMx' Lee Jones
2020-11-30 23:33 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 13/40] drm/amd/pm/powerplay/hwmgr/hwmgr: Move 'smu7_init_function_pointers()'s prototype to header Lee Jones
2020-11-30 23:33 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 14/40] drm/amd/pm/powerplay/hwmgr/ppatomfwctrl: Demote kernel-doc formatting abuses Lee Jones
2020-11-30 23:34 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 15/40] drm/msm/disp/dpu1/dpu_hw_interrupts: Demote kernel-doc formatting misuse Lee Jones
2020-11-30 21:23 ` abhinavk
2020-11-26 13:42 ` [PATCH 16/40] drm/amd/pm/powerplay/smumgr/iceland_smumgr: Remove unused variable 'res' Lee Jones
2020-11-30 23:39 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 17/40] drm/amd/pm/powerplay/hwmgr/hardwaremanager: Fix function header related formatting issues Lee Jones
2020-11-30 23:40 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 18/40] drm/amd/pm/powerplay/hwmgr/process_pptables_v1_0: Convert to proper kernel-doc format Lee Jones
2020-11-30 23:41 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 19/40] drm/amd/pm/powerplay/hwmgr/ppatomctrl: Fix a myriad of kernel-doc issues Lee Jones
2020-11-30 23:43 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 20/40] drm/amd/pm/powerplay/hwmgr/vega10_processpptables: Make function invoked by reference static Lee Jones
2020-11-30 23:43 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 21/40] drm/amd/pm/powerplay/hwmgr/smu7_hwmgr: Fix a whole bunch of historical function doc issues Lee Jones
2020-11-30 23:44 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 22/40] drm/amd/pm/powerplay/hwmgr/vega10_hwmgr: Remove set but unused variable 'result' Lee Jones
2020-11-26 13:42 ` [PATCH 23/40] drm/amd/pm/powerplay/hwmgr/smu7_thermal: Repair formatting in a bunch of function docs Lee Jones
2020-11-30 23:48 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 24/40] drm/amd/pm/powerplay/hwmgr/vega10_thermal: Fix a bunch of dated function doc formatting Lee Jones
2020-11-30 23:49 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 25/40] drm/amd/pm/powerplay/hwmgr/pp_psm: Remove unused variable 'result' Lee Jones
2020-11-26 13:42 ` [PATCH 26/40] drm/amd/pm/powerplay/hwmgr/hwmgr: Move 'vega12_hwmgr_init()'s prototype to shared header Lee Jones
2020-11-30 23:50 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 27/40] drm/amd/pm/powerplay/hwmgr/hwmgr: Move 'vega20_hwmgr_init()'s " Lee Jones
2020-11-30 23:51 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 28/40] drm/amd/pm/powerplay/hwmgr/smu_helper: Demote or fix kernel-doc headers Lee Jones
2020-11-30 23:52 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 29/40] drm/amd/pm/powerplay/hwmgr/vega20_thermal: Fix some outdated function documentation Lee Jones
2020-11-30 23:53 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 30/40] drm/amd/pm/powerplay/hwmgr/vega12_thermal: " Lee Jones
2020-11-30 23:54 ` Alex Deucher [this message]
2020-11-26 13:42 ` [PATCH 31/40] drm/amd/pm/powerplay/kv_dpm: Remove unused variable 'ret' Lee Jones
2020-12-01 14:00 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 32/40] drm/amd/display/amdgpu_dm/amdgpu_dm: Mark 'link_bandwidth_kbps' as __maybe_unused Lee Jones
2020-11-30 23:57 ` Alex Deucher
2020-12-01 7:19 ` Lee Jones
2020-11-26 13:42 ` [PATCH 33/40] drm/amd/display/dc/inc/hw/dpp: Mark 'dpp_input_csc_matrix' " Lee Jones
2020-12-01 0:00 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 34/40] drm/amd/display/amdgpu_dm/amdgpu_dm_helpers: Use 'gnu_printf' format notation Lee Jones
2020-12-01 18:42 ` Alex Deucher
2020-12-01 18:59 ` Christian König
2020-12-01 19:41 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 35/40] drm/amd/display/amdgpu_dm/amdgpu_dm_color: Demote a misuse and fix another kernel-doc header Lee Jones
2020-12-01 0:02 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 36/40] drm/amd/display/amdgpu_dm/amdgpu_dm_pp_smu: Mark local functions invoked by reference as static Lee Jones
2020-12-01 0:04 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 37/40] drm/amd/display/amdgpu_dm/amdgpu_dm_pp_smu: Remove unused function 'pp_nv_set_pme_wa_enable()' Lee Jones
2020-12-01 0:05 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 38/40] drm/amd/display/dc/basics/conversion: Include header containing our prototypes Lee Jones
2020-12-01 0:05 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 39/40] drm/amd/display/dc/basics/fixpt31_32: Remove unused variable 'dc_fixpt_pi' Lee Jones
2020-12-01 0:06 ` Alex Deucher
2020-11-26 13:42 ` [PATCH 40/40] drm/amd/display/dc/basics/vector: Make local function 'dal_vector_presized_costruct' static Lee Jones
2020-12-01 0:07 ` Alex Deucher
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADnq5_Nx-6-CpBEYS=vNtvABakARnQO4+0QP1EtcJCykLK+2nA@mail.gmail.com' \
--to=alexdeucher@gmail.com \
--cc=airlied@linux.ie \
--cc=alexander.deucher@amd.com \
--cc=amd-gfx@lists.freedesktop.org \
--cc=christian.koenig@amd.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=evan.quan@amd.com \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).