Re: [Freedreno] [PATCH 10/40] drm/msm/disp/dpu1/dpu_core_perf: Fix kernel-doc formatting issues

[abhinavk@codeaurora.org]

On 2020-11-23 03:18, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:31: warning: Enum value
> 'DPU_PERF_MODE_MAX' not described in enum 'dpu_perf_mode'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:34: warning: Cannot
> understand  * @_dpu_core_perf_calc_bw() - to calculate BW per crtc
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:73: warning: Function
> parameter or member 'kms' not described in '_dpu_core_perf_calc_clk'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:73: warning: Function
> parameter or member 'crtc' not described in '_dpu_core_perf_calc_clk'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:73: warning: Function
> parameter or member 'state' not described in '_dpu_core_perf_calc_clk'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c:249: warning: Cannot
> understand  * @dpu_core_perf_crtc_release_bw() - request zero
> bandwidth
> 
> Cc: Rob Clark <robdclark@gmail.com>
> Cc: Sean Paul <sean@poorly.run>
> Cc: David Airlie <airlied@linux.ie>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Kalyan Thota <kalyan_t@codeaurora.org>
> Cc: linux-arm-msm@vger.kernel.org
> Cc: dri-devel@lists.freedesktop.org
> Cc: freedreno@lists.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Reviewed-by: Abhinav Kumar <abhinavk@codeaurora.org>
> ---
>  drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c
> b/drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c
> index 36927fc04a388..b6b3bbab03336 100644
> --- a/drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c
> +++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_core_perf.c
> @@ -22,6 +22,7 @@
>   * @DPU_PERF_MODE_NORMAL: performance controlled by user mode client
>   * @DPU_PERF_MODE_MINIMUM: performance bounded by minimum setting
>   * @DPU_PERF_MODE_FIXED: performance bounded by fixed setting
> + * @DPU_PERF_MODE_MAX: maximum value, used for error checking
>   */
>  enum dpu_perf_mode {
>  	DPU_PERF_MODE_NORMAL,
> @@ -31,9 +32,9 @@ enum dpu_perf_mode {
>  };
> 
>  /**
> - * @_dpu_core_perf_calc_bw() - to calculate BW per crtc
> - * @kms -  pointer to the dpu_kms
> - * @crtc - pointer to a crtc
> + * _dpu_core_perf_calc_bw() - to calculate BW per crtc
> + * @kms:  pointer to the dpu_kms
> + * @crtc: pointer to a crtc
>   * Return: returns aggregated BW for all planes in crtc.
>   */
>  static u64 _dpu_core_perf_calc_bw(struct dpu_kms *kms,
> @@ -63,9 +64,9 @@ static u64 _dpu_core_perf_calc_bw(struct dpu_kms 
> *kms,
> 
>  /**
>   * _dpu_core_perf_calc_clk() - to calculate clock per crtc
> - * @kms -  pointer to the dpu_kms
> - * @crtc - pointer to a crtc
> - * @state - pointer to a crtc state
> + * @kms:  pointer to the dpu_kms
> + * @crtc: pointer to a crtc
> + * @state: pointer to a crtc state
>   * Return: returns max clk for all planes in crtc.
>   */
>  static u64 _dpu_core_perf_calc_clk(struct dpu_kms *kms,
> @@ -246,8 +247,8 @@ static int _dpu_core_perf_crtc_update_bus(struct
> dpu_kms *kms,
>  }
> 
>  /**
> - * @dpu_core_perf_crtc_release_bw() - request zero bandwidth
> - * @crtc - pointer to a crtc
> + * dpu_core_perf_crtc_release_bw() - request zero bandwidth
> + * @crtc: pointer to a crtc
>   *
>   * Function checks a state variable for the crtc, if all pending 
> commit
>   * requests are done, meaning no more bandwidth is needed, release