All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	VMware Graphics <linux-graphics-maintainer@vmware.com>,
	Roland Scheidegger <sroland@vmware.com>,
	David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
	dri-devel@lists.freedesktop.org
Subject: [PATCH 20/40] drm/vmwgfx/vmwgfx_kms: Update worthy function headers and demote others
Date: Fri, 15 Jan 2021 18:12:53 +0000	[thread overview]
Message-ID: <20210115181313.3431493-21-lee.jones@linaro.org> (raw)
In-Reply-To: <20210115181313.3431493-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 In file included from drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:37:
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:483: warning: Function parameter or member 'new_state' not described in 'vmw_du_cursor_plane_atomic_check'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:483: warning: Excess function parameter 'state' description in 'vmw_du_cursor_plane_atomic_check'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1069: warning: Function parameter or member 'vfb' not described in 'vmw_framebuffer_pin'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1281: warning: Function parameter or member 'dev_priv' not described in 'vmw_kms_srf_ok'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1907: warning: Function parameter or member 'crtc' not described in 'vmw_get_vblank_counter'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1915: warning: Function parameter or member 'crtc' not described in 'vmw_enable_vblank'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1923: warning: Function parameter or member 'crtc' not described in 'vmw_disable_vblank'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:2131: warning: Function parameter or member 'mode' not described in 'vmw_guess_mode_timing'

Cc: VMware Graphics <linux-graphics-maintainer@vmware.com>
Cc: Roland Scheidegger <sroland@vmware.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c b/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
index 9293dc19a7683..84143b707cd32 100644
--- a/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
+++ b/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
@@ -467,7 +467,7 @@ int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
  * vmw_du_cursor_plane_atomic_check - check if the new state is okay
  *
  * @plane: cursor plane
- * @state: info on the new plane state
+ * @new_state: info on the new plane state
  *
  * This is a chance to fail if the new cursor state does not fit
  * our requirements.
@@ -1057,7 +1057,7 @@ static const struct drm_framebuffer_funcs vmw_framebuffer_bo_funcs = {
 	.dirty = vmw_framebuffer_bo_dirty_ext,
 };
 
-/**
+/*
  * Pin the bofer in a location suitable for access by the
  * display system.
  */
@@ -1267,6 +1267,7 @@ static int vmw_kms_new_framebuffer_bo(struct vmw_private *dev_priv,
 /**
  * vmw_kms_srf_ok - check if a surface can be created
  *
+ * @dev_priv: Pointer to device private struct.
  * @width: requested width
  * @height: requested height
  *
@@ -1896,7 +1897,7 @@ bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
 }
 
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 u32 vmw_get_vblank_counter(struct drm_crtc *crtc)
@@ -1904,7 +1905,7 @@ u32 vmw_get_vblank_counter(struct drm_crtc *crtc)
 	return 0;
 }
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 int vmw_enable_vblank(struct drm_crtc *crtc)
@@ -1912,7 +1913,7 @@ int vmw_enable_vblank(struct drm_crtc *crtc)
 	return -EINVAL;
 }
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 void vmw_disable_vblank(struct drm_crtc *crtc)
@@ -2120,7 +2121,7 @@ static struct drm_display_mode vmw_kms_connector_builtin[] = {
  * vmw_guess_mode_timing - Provide fake timings for a
  * 60Hz vrefresh mode.
  *
- * @mode - Pointer to a struct drm_display_mode with hdisplay and vdisplay
+ * @mode: Pointer to a struct drm_display_mode with hdisplay and vdisplay
  * members filled in.
  */
 void vmw_guess_mode_timing(struct drm_display_mode *mode)
-- 
2.25.1


WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: David Airlie <airlied@linux.ie>,
	Roland Scheidegger <sroland@vmware.com>,
	linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
	VMware Graphics <linux-graphics-maintainer@vmware.com>
Subject: [PATCH 20/40] drm/vmwgfx/vmwgfx_kms: Update worthy function headers and demote others
Date: Fri, 15 Jan 2021 18:12:53 +0000	[thread overview]
Message-ID: <20210115181313.3431493-21-lee.jones@linaro.org> (raw)
In-Reply-To: <20210115181313.3431493-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 In file included from drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:37:
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:483: warning: Function parameter or member 'new_state' not described in 'vmw_du_cursor_plane_atomic_check'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:483: warning: Excess function parameter 'state' description in 'vmw_du_cursor_plane_atomic_check'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1069: warning: Function parameter or member 'vfb' not described in 'vmw_framebuffer_pin'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1281: warning: Function parameter or member 'dev_priv' not described in 'vmw_kms_srf_ok'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1907: warning: Function parameter or member 'crtc' not described in 'vmw_get_vblank_counter'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1915: warning: Function parameter or member 'crtc' not described in 'vmw_enable_vblank'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:1923: warning: Function parameter or member 'crtc' not described in 'vmw_disable_vblank'
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c:2131: warning: Function parameter or member 'mode' not described in 'vmw_guess_mode_timing'

Cc: VMware Graphics <linux-graphics-maintainer@vmware.com>
Cc: Roland Scheidegger <sroland@vmware.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c b/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
index 9293dc19a7683..84143b707cd32 100644
--- a/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
+++ b/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c
@@ -467,7 +467,7 @@ int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
  * vmw_du_cursor_plane_atomic_check - check if the new state is okay
  *
  * @plane: cursor plane
- * @state: info on the new plane state
+ * @new_state: info on the new plane state
  *
  * This is a chance to fail if the new cursor state does not fit
  * our requirements.
@@ -1057,7 +1057,7 @@ static const struct drm_framebuffer_funcs vmw_framebuffer_bo_funcs = {
 	.dirty = vmw_framebuffer_bo_dirty_ext,
 };
 
-/**
+/*
  * Pin the bofer in a location suitable for access by the
  * display system.
  */
@@ -1267,6 +1267,7 @@ static int vmw_kms_new_framebuffer_bo(struct vmw_private *dev_priv,
 /**
  * vmw_kms_srf_ok - check if a surface can be created
  *
+ * @dev_priv: Pointer to device private struct.
  * @width: requested width
  * @height: requested height
  *
@@ -1896,7 +1897,7 @@ bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
 }
 
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 u32 vmw_get_vblank_counter(struct drm_crtc *crtc)
@@ -1904,7 +1905,7 @@ u32 vmw_get_vblank_counter(struct drm_crtc *crtc)
 	return 0;
 }
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 int vmw_enable_vblank(struct drm_crtc *crtc)
@@ -1912,7 +1913,7 @@ int vmw_enable_vblank(struct drm_crtc *crtc)
 	return -EINVAL;
 }
 
-/**
+/*
  * Function called by DRM code called with vbl_lock held.
  */
 void vmw_disable_vblank(struct drm_crtc *crtc)
@@ -2120,7 +2121,7 @@ static struct drm_display_mode vmw_kms_connector_builtin[] = {
  * vmw_guess_mode_timing - Provide fake timings for a
  * 60Hz vrefresh mode.
  *
- * @mode - Pointer to a struct drm_display_mode with hdisplay and vdisplay
+ * @mode: Pointer to a struct drm_display_mode with hdisplay and vdisplay
  * members filled in.
  */
 void vmw_guess_mode_timing(struct drm_display_mode *mode)
-- 
2.25.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  parent reply	other threads:[~2021-01-15 18:15 UTC|newest]

Thread overview: 86+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-15 18:12 [PATCH 00/40] [Set 14] Rid W=1 warnings from GPU Lee Jones
2021-01-15 18:12 ` Lee Jones
2021-01-15 18:12 ` [PATCH 01/40] drm/r128/r128_ioc32: Document headers do not make good kernel-doc candidates Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 02/40] drm/mga/mga_ioc32: " Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 03/40] drm/vmwgfx/vmwgfx_execbuf: Fix some kernel-doc related issues Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 04/40] drm/vmwgfx/vmwgfx_kms: Remove unused variable 'ret' from 'vmw_du_primary_plane_atomic_check()' Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 05/40] drm/r128/r128_ioc32: Fix formatting issues in 'r128_compat_ioctl()'s header Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 06/40] drm/mga/mga_ioc32: Fix some formatting issues in 'mga_compat_ioctl's header Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 07/40] drm/vmwgfx/vmwgfx_kms: Mark vmw_{cursor,primary}_plane_formats as __maybe_unused Lee Jones
2021-01-15 18:12   ` [PATCH 07/40] drm/vmwgfx/vmwgfx_kms: Mark vmw_{cursor, primary}_plane_formats " Lee Jones
2021-01-15 18:12 ` [PATCH 08/40] drm/vmwgfx/vmwgfx_drv: Fix some kernel-doc misdemeanours Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 09/40] drm/vmwgfx/vmwgfx_ioctl: Provide missing '@' sign required by kernel-doc Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 10/40] drm/vmwgfx/vmwgfx_resource: Fix worthy function headers demote some others Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 11/40] drm/vmwgfx/vmwgfx_ttm_buffer: Supply some missing parameter descriptions Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 12/40] drm/vmwgfx/vmwgfx_fifo: Demote non-conformant kernel-doc header Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 13/40] drm/vmwgfx/vmwgfx_ldu: Supply descriptions for 'state' function parameter Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 14/40] drm/gma500/framebuffer: Fix some possible doc-rot issues Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 15/40] drm/gma500/gem: Add and rename some function parameter descriptions Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 16/40] drm/gma500/intel_bios: Demote non-conformant kernel-doc header Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 17/40] drm/gma500/intel_i2c: Remove superflouous parameter description and rename another Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 18/40] drm/gma500/mmu: Make local function 'psb_mmu_pt_alloc_map_lock()' static Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 19/40] drm/gma500/power: Fix a bunch of *dev documentation issues Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` Lee Jones [this message]
2021-01-15 18:12   ` [PATCH 20/40] drm/vmwgfx/vmwgfx_kms: Update worthy function headers and demote others Lee Jones
2021-01-15 18:12 ` [PATCH 21/40] drm/gma500/gma_display: Demote kernel-doc abuses to standard comment blocks Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 22/40] drm/gma500/gma_device: Include our own header containing prototypes Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 23/40] drm/vmwgfx/vmwgfx_overlay: Demote kernel-doc abuses to standard comment blocks Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 24/40] drm/gma500/psb_intel_display: Demote kernel-doc formatting abuse Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 25/40] drm/gma500/psb_intel_lvds: Supply description for 'mode_dev' Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:12 ` [PATCH 26/40] drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation params/headers Lee Jones
2021-01-15 18:12   ` Lee Jones
2021-01-15 18:13 ` [PATCH 27/40] drm/vmwgfx/vmwgfx_bo: Remove superfluous param description and supply another Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 28/40] drm/vmwgfx/vmwgfx_context: Demote kernel-doc abuses Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 29/40] drm/vmwgfx/vmwgfx_scrn: Demote unworthy kernel-doc headers and update others Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 30/40] drm/gma500/psb_intel_modes: Provide missing descriptions for function param 'adapter' Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 31/40] drm/gma500/gem: Do not rely on consumers to include drm/drm_device.h before gem.h Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 32/40] drm/gma500/gem: Include our own header containing prototypes Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 33/40] drm/vmwgfx/vmwgfx_surface: Fix some kernel-doc related issues Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 34/40] drm/gma500/mmu: Remove unused function 'psb_get_default_pd_addr' Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 35/40] drm/vmwgfx/vmwgfx_cmdbuf_res: Rename param description and remove another Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 36/40] drm/vmwgfx/vmwgfx_shader: Demote kernel-doc abuses and fix-up worthy headers Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 37/40] drm/vmwgfx/vmwgfx_cmdbuf: Fix a bunch of missing or incorrectly formatted/named params Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 38/40] drm/gma500/power: Remove excess param description 'state' Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 39/40] drm/vmwgfx/vmwgfx_cmdbuf_res: Remove unused variable 'ret' Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:13 ` [PATCH 40/40] drm/vmwgfx/vmwgfx_stdu: Add some missing param/member descriptions Lee Jones
2021-01-15 18:13   ` Lee Jones
2021-01-15 18:22 ` [PATCH 00/40] [Set 14] Rid W=1 warnings from GPU Zack Rusin
2021-01-15 18:22   ` Zack Rusin
2021-01-18 14:46   ` Daniel Vetter
2021-01-18 14:46     ` Daniel Vetter

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=20210115181313.3431493-21-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=airlied@linux.ie \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=linux-graphics-maintainer@vmware.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sroland@vmware.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.