[Freedreno] [PATCH 35/40] drm/msm/disp/dpu1/dpu_plane: Fix some spelling and missing function param descriptions

[abhinavk at codeaurora.org]

On 2020-11-23 03:19, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:152: warning: Function
> parameter or member 'plane' not described in '_dpu_plane_calc_bw'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:152: warning: Function
> parameter or member 'fb' not described in '_dpu_plane_calc_bw'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:152: warning: Excess
> function parameter 'Plane' description in '_dpu_plane_calc_bw'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:200: warning: Function
> parameter or member 'plane' not described in '_dpu_plane_calc_clk'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:200: warning: Excess
> function parameter 'Plane' description in '_dpu_plane_calc_clk'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:232: warning: Function
> parameter or member 'src_width' not described in
> '_dpu_plane_calc_fill_level'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:232: warning: Excess
> function parameter 'src_wdith' description in
> '_dpu_plane_calc_fill_level'
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c:1060: warning: Function
> parameter or member 'error' not described in 'dpu_plane_set_error'
> 
> Cc: Rob Clark <robdclark at gmail.com>
> Cc: Sean Paul <sean at poorly.run>
> Cc: David Airlie <airlied at linux.ie>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Kalyan Thota <kalyan_t at codeaurora.org>
> Cc: linux-arm-msm at vger.kernel.org
> Cc: dri-devel at lists.freedesktop.org
> Cc: freedreno at lists.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones at linaro.org>
Reviewed-by: Abhinav Kumar <abhinavk at codeaurora.org>
> ---
>  drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> index c0b1d77369e53..cf0084d7cc7c9 100644
> --- a/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> +++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c
> @@ -142,7 +142,8 @@ static struct dpu_kms *_dpu_plane_get_kms(struct
> drm_plane *plane)
> 
>  /**
>   * _dpu_plane_calc_bw - calculate bandwidth required for a plane
> - * @Plane: Pointer to drm plane.
> + * @plane: Pointer to drm plane.
> + * @fb:   Pointer to framebuffer associated with the given plane
>   * Result: Updates calculated bandwidth in the plane state.
>   * BW Equation: src_w * src_h * bpp * fps * (v_total / v_dest)
>   * Prefill BW Equation: line src bytes * line_time
> @@ -192,7 +193,7 @@ static void _dpu_plane_calc_bw(struct drm_plane 
> *plane,
> 
>  /**
>   * _dpu_plane_calc_clk - calculate clock required for a plane
> - * @Plane: Pointer to drm plane.
> + * @plane: Pointer to drm plane.
>   * Result: Updates calculated clock in the plane state.
>   * Clock equation: dst_w * v_total * fps * (src_h / dst_h)
>   */
> @@ -224,7 +225,7 @@ static void _dpu_plane_calc_clk(struct drm_plane 
> *plane)
>   * _dpu_plane_calc_fill_level - calculate fill level of the given 
> source format
>   * @plane:		Pointer to drm plane
>   * @fmt:		Pointer to source buffer format
> - * @src_wdith:		width of source buffer
> + * @src_width:		width of source buffer
>   * Return: fill level corresponding to the source buffer/format or 0 
> if error
>   */
>  static int _dpu_plane_calc_fill_level(struct drm_plane *plane,
> @@ -1055,6 +1056,7 @@ void dpu_plane_flush(struct drm_plane *plane)
>  /**
>   * dpu_plane_set_error: enable/disable error condition
>   * @plane: pointer to drm_plane structure
> + * @error: error value to set
>   */
>  void dpu_plane_set_error(struct drm_plane *plane, bool error)
>  {