[PATCH v2] drm/amd/display: Address kdoc warnings in dcn30_fpu.c

[Rodrigo Siqueira Jordao]

On 6/2/23 09:19, Srinivasan Shanmugam wrote:
> Fixes the following gcc with W=1:
> 
> display/dc/dml/dcn30/dcn30_fpu.c:677: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Finds dummy_latency_index when MCLK switching using firmware based
> display/dc/dml/dcn30/dcn30_fpu.c:688: warning: Function parameter or member 'dc' not described in 'dcn30_find_dummy_latency_index_for_fw_based_mclk_switch'
> display/dc/dml/dcn30/dcn30_fpu.c:688: warning: Function parameter or member 'context' not described in 'dcn30_find_dummy_latency_index_for_fw_based_mclk_switch'
> display/dc/dml/dcn30/dcn30_fpu.c:688: warning: Function parameter or member 'pipes' not described in 'dcn30_find_dummy_latency_index_for_fw_based_mclk_switch'
> display/dc/dml/dcn30/dcn30_fpu.c:688: warning: Function parameter or member 'pipe_cnt' not described in 'dcn30_find_dummy_latency_index_for_fw_based_mclk_switch'
> display/dc/dml/dcn30/dcn30_fpu.c:688: warning: Function parameter or member 'vlevel' not described in 'dcn30_find_dummy_latency_index_for_fw_based_mclk_switch'
> 
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>
> Cc: Aurabindo Pillai <aurabindo.pillai at amd.com>
> Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam at amd.com>
> ---
> v2:
> 
>   - Change the commit title keyword 'Fix' to 'Address' (Rodrigo)
> 
>   .../gpu/drm/amd/display/dc/dml/dcn30/dcn30_fpu.c  | 15 ++++++++++++---
>   1 file changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/dml/dcn30/dcn30_fpu.c b/drivers/gpu/drm/amd/display/dc/dml/dcn30/dcn30_fpu.c
> index a352c703e258..ccb4ad78f667 100644
> --- a/drivers/gpu/drm/amd/display/dc/dml/dcn30/dcn30_fpu.c
> +++ b/drivers/gpu/drm/amd/display/dc/dml/dcn30/dcn30_fpu.c
> @@ -674,10 +674,19 @@ void dcn30_fpu_update_bw_bounding_box(struct dc *dc,
>   }
>   
>   /**
> - * Finds dummy_latency_index when MCLK switching using firmware based
> - * vblank stretch is enabled. This function will iterate through the
> - * table of dummy pstate latencies until the lowest value that allows
> + * dcn30_find_dummy_latency_index_for_fw_based_mclk_switch() - Finds
> + * dummy_latency_index when MCLK switching using firmware based vblank stretch
> + * is enabled. This function will iterate through the table of dummy pstate
> + * latencies until the lowest value that allows
>    * dm_allow_self_refresh_and_mclk_switch to happen is found
> + *
> + * @dc: Current DC state
> + * @context: new dc state
> + * @pipes: DML pipe params
> + * @pipe_cnt: number of DML pipes
> + * @vlevel: Voltage level calculated by DML
> + *
> + * Return: lowest dummy_latency_index value
>    */
>   int dcn30_find_dummy_latency_index_for_fw_based_mclk_switch(struct dc *dc,
>   							    struct dc_state *context,

Reviewed-by: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>