linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Rob Clark <robdclark@gmail.com>,
	Sean Paul <sean@poorly.run>, David Airlie <airlied@linux.ie>,
	Daniel Vetter <daniel@ffwll.ch>,
	Kalyan Thota <kalyan_t@codeaurora.org>,
	linux-arm-msm@vger.kernel.org, dri-devel@lists.freedesktop.org,
	freedreno@lists.freedesktop.org
Subject: [PATCH 35/40] drm/msm/disp/dpu1/dpu_plane: Fix some spelling and missing function param descriptions
Date: Mon, 23 Nov 2020 11:19:14 +0000	[thread overview]
Message-ID: <20201123111919.233376-36-lee.jones@linaro.org> (raw)
In-Reply-To: <20201123111919.233376-1-lee.jones@linaro.org>

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@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>
---
 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)
 {
-- 
2.25.1


  parent reply	other threads:[~2020-11-23 11:20 UTC|newest]

Thread overview: 82+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-23 11:18 [PATCH 00/40] [Set 8] Rid W=1 warnings from GPU Lee Jones
2020-11-23 11:18 ` [PATCH 01/40] drm/radeon/radeon_device: Consume our own header where the prototypes are located Lee Jones
2020-11-24 15:52   ` Alex Deucher
2020-11-24 19:02     ` Lee Jones
2020-11-23 11:18 ` [PATCH 02/40] drm/amd/amdgpu/amdgpu_ttm: Add description for 'page_flags' Lee Jones
2020-11-24 15:48   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 03/40] drm/amd/amdgpu/amdgpu_ib: Provide docs for 'amdgpu_ib_schedule()'s 'job' param Lee Jones
2020-11-24 15:49   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 04/40] drm/amd/amdgpu/amdgpu_virt: Correct possible copy/paste or doc-rot misnaming issue Lee Jones
2020-11-24 15:53   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 05/40] drm/amd/amdgpu/cik_ih: Supply description for 'ih' in 'cik_ih_{get,set}_wptr()' Lee Jones
2020-11-24 15:51   ` [PATCH 05/40] drm/amd/amdgpu/cik_ih: Supply description for 'ih' in 'cik_ih_{get, set}_wptr()' Alex Deucher
2020-11-23 11:18 ` [PATCH 06/40] drm/amd/amdgpu/uvd_v4_2: Fix some kernel-doc misdemeanours Lee Jones
2020-11-24 15:58   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 07/40] drm/amd/amdgpu/dce_v8_0: Supply description for 'async' Lee Jones
2020-11-24 15:59   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 08/40] drm/amd/amdgpu/cik_sdma: Supply some missing function param descriptions Lee Jones
2020-11-24 16:03   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 09/40] drm/amd/amdgpu/gfx_v7_0: Clean-up a bunch of kernel-doc related issues Lee Jones
2020-11-24 16:04   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 10/40] drm/msm/disp/dpu1/dpu_core_perf: Fix kernel-doc formatting issues Lee Jones
2020-11-23 21:10   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 11/40] drm/msm/disp/dpu1/dpu_hw_blk: Add one missing and remove an extra param description Lee Jones
2020-11-23 21:06   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 12/40] drm/msm/disp/dpu1/dpu_formats: Demote non-conformant kernel-doc header Lee Jones
2020-11-23 21:08   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 13/40] drm/msm/disp/dpu1/dpu_hw_catalog: Remove duplicated initialisation of 'max_linewidth' Lee Jones
2020-11-23 21:07   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 14/40] drm/msm/disp/dpu1/dpu_hw_catalog: Move definitions to the only place they are used Lee Jones
2020-11-23 21:23   ` abhinavk
2020-11-23 11:18 ` [PATCH 15/40] drm/nouveau/nvkm/subdev/bios/init: Demote obvious abuse of kernel-doc Lee Jones
2020-11-23 11:18 ` [PATCH 16/40] drm/amd/amdgpu/si_dma: Fix a bunch of function documentation issues Lee Jones
2020-11-24 16:06   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 17/40] drm/amd/amdgpu/gfx_v6_0: Supply description for 'gfx_v6_0_ring_test_ib()'s 'timeout' param Lee Jones
2020-11-24 16:07   ` Alex Deucher
2020-11-23 11:18 ` [PATCH 18/40] drm/msm/disp/dpu1/dpu_encoder: Fix a few parameter/member formatting issues Lee Jones
2020-11-23 21:10   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 19/40] drm/msm/disp/dpu1/dpu_hw_lm: Fix misnaming of parameter 'ctx' Lee Jones
2020-11-23 21:12   ` [Freedreno] " abhinavk
2020-11-23 11:18 ` [PATCH 20/40] drm/msm/disp/dpu1/dpu_hw_sspp: Fix kernel-doc formatting abuse Lee Jones
2020-11-23 21:12   ` [Freedreno] " abhinavk
2020-11-23 11:19 ` [PATCH 21/40] drm/amd/amdgpu/uvd_v3_1: Fix-up some documentation issues Lee Jones
2020-11-24 16:09   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 22/40] drm/amd/amdgpu/dce_v6_0: Fix formatting and missing parameter description issues Lee Jones
2020-11-24 16:10   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 23/40] drm/amd/include/vega20_ip_offset: Mark top-level IP_BASE definition as __maybe_unused Lee Jones
2020-11-24 16:11   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 24/40] drm/amd/include/navi10_ip_offset: Mark top-level IP_BASE " Lee Jones
2020-11-24 16:12   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 25/40] drm/amd/include/arct_ip_offset: Mark top-level IP_BASE definition " Lee Jones
2020-11-24 16:12   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 26/40] drm/amd/include/navi14_ip_offset: Mark top-level IP_BASE " Lee Jones
2020-11-24 16:13   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 27/40] drm/amd/include/navi12_ip_offset: " Lee Jones
2020-11-24 16:14   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 28/40] drm/amd/include/sienna_cichlid_ip_offset: " Lee Jones
2020-11-24 16:15   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 29/40] drm/amd/include/vangogh_ip_offset: " Lee Jones
2020-11-24 16:15   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 30/40] drm/amd/include/dimgrey_cavefish_ip_offset: " Lee Jones
2020-11-24 16:17   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 31/40] drm/msm/disp/dpu1/dpu_rm: Fix formatting issues and supply 'global_state' description Lee Jones
2020-11-23 21:13   ` [Freedreno] " abhinavk
2020-11-23 11:19 ` [PATCH 32/40] drm/msm/disp/dpu1/dpu_vbif: Fix a couple of function param descriptions Lee Jones
2020-11-23 11:19 ` [PATCH 33/40] drm/amd/amdgpu/cik_sdma: Add one and remove another function param description Lee Jones
2020-11-24 16:19   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 34/40] drm/amd/amdgpu/uvd_v4_2: " Lee Jones
2020-11-24 16:20   ` Alex Deucher
2020-11-23 11:19 ` Lee Jones [this message]
2020-11-23 21:13   ` [Freedreno] [PATCH 35/40] drm/msm/disp/dpu1/dpu_plane: Fix some spelling and missing function param descriptions abhinavk
2020-11-23 11:19 ` [PATCH 36/40] drm/amd/amdgpu/gmc_v7_0: Add some missing kernel-doc descriptions Lee Jones
2020-11-24 16:24   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 37/40] drm/amd/amdgpu/gmc_v8_0: Fix more issues attributed to copy/paste Lee Jones
2020-11-24 16:26   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 38/40] drm/msm/msm_drv: Make '_msm_ioremap()' static Lee Jones
2020-11-23 21:14   ` [Freedreno] " abhinavk
2020-11-23 11:19 ` [PATCH 39/40] drm/amd/amdgpu/gmc_v9_0: Remove unused table 'ecc_umc_mcumc_status_addrs' Lee Jones
2020-11-24 16:27   ` Alex Deucher
2020-11-23 11:19 ` [PATCH 40/40] drm/amd/amdgpu/gmc_v9_0: Suppy some missing function doc descriptions Lee Jones
2020-11-24 16:30   ` Alex Deucher
2020-11-23 11:52 ` [PATCH 00/40] [Set 8] Rid W=1 warnings from GPU Christian König
2020-11-23 12:30   ` Lee Jones

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=20201123111919.233376-36-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=airlied@linux.ie \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=freedreno@lists.freedesktop.org \
    --cc=kalyan_t@codeaurora.org \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robdclark@gmail.com \
    --cc=sean@poorly.run \
    /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).