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>,
	"Sumit Semwal" <sumit.semwal@linaro.org>,
	"Christian König" <christian.koenig@amd.com>,
	dri-devel@lists.freedesktop.org, linux-media@vger.kernel.org,
	linaro-mm-sig@lists.linaro.org
Subject: [PATCH 26/40] drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation params/headers
Date: Fri, 15 Jan 2021 18:12:59 +0000	[thread overview]
Message-ID: <20210115181313.3431493-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20210115181313.3431493-1-lee.jones@linaro.org>

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

 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:82: warning: Function parameter or member 'event' not described in 'vmw_event_fence_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:113: warning: Function parameter or member 'f' not described in 'vmw_fence_obj_destroy'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:261: warning: Function parameter or member 'work' not described in 'vmw_fence_work_func'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:720: warning: Function parameter or member 'fman' not described in 'vmw_fence_fifo_down'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:963: warning: Function parameter or member 'fence' not described in 'vmw_fence_obj_add_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:963: warning: Function parameter or member 'action' not described in 'vmw_fence_obj_add_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:1021: warning: Function parameter or member 'tv_sec' not described in 'vmw_event_fence_action_queue'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:1021: warning: Function parameter or member 'tv_usec' not described in 'vmw_event_fence_action_queue'

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: Sumit Semwal <sumit.semwal@linaro.org>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: dri-devel@lists.freedesktop.org
Cc: linux-media@vger.kernel.org
Cc: linaro-mm-sig@lists.linaro.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c b/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
index 378ec7600154b..23523eb3cac2a 100644
--- a/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
+++ b/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
@@ -58,13 +58,11 @@ struct vmw_user_fence {
 /**
  * struct vmw_event_fence_action - fence action that delivers a drm event.
  *
- * @e: A struct drm_pending_event that controls the event delivery.
  * @action: A struct vmw_fence_action to hook up to a fence.
+ * @event: A pointer to the pending event.
  * @fence: A referenced pointer to the fence to keep it alive while @action
  * hangs on it.
  * @dev: Pointer to a struct drm_device so we can access the event stuff.
- * @kref: Both @e and @action has destructors, so we need to refcount.
- * @size: Size accounted for this object.
  * @tv_sec: If non-null, the variable pointed to will be assigned
  * current time tv_sec val when the fence signals.
  * @tv_usec: Must be set if @tv_sec is set, and the variable pointed to will
@@ -87,7 +85,7 @@ fman_from_fence(struct vmw_fence_obj *fence)
 	return container_of(fence->base.lock, struct vmw_fence_manager, lock);
 }
 
-/**
+/*
  * Note on fencing subsystem usage of irqs:
  * Typically the vmw_fences_update function is called
  *
@@ -250,7 +248,7 @@ static const struct dma_fence_ops vmw_fence_ops = {
 };
 
 
-/**
+/*
  * Execute signal actions on fences recently signaled.
  * This is done from a workqueue so we don't have to execute
  * signal actions from atomic context.
@@ -708,7 +706,7 @@ int vmw_wait_dma_fence(struct vmw_fence_manager *fman,
 }
 
 
-/**
+/*
  * vmw_fence_fifo_down - signal all unsignaled fence objects.
  */
 
@@ -948,8 +946,8 @@ static void vmw_event_fence_action_cleanup(struct vmw_fence_action *action)
 /**
  * vmw_fence_obj_add_action - Add an action to a fence object.
  *
- * @fence - The fence object.
- * @action - The action to add.
+ * @fence: The fence object.
+ * @action: The action to add.
  *
  * Note that the action callbacks may be executed before this function
  * returns.
@@ -1001,6 +999,10 @@ static void vmw_fence_obj_add_action(struct vmw_fence_obj *fence,
  * @fence: The fence object on which to post the event.
  * @event: Event to be posted. This event should've been alloced
  * using k[mz]alloc, and should've been completely initialized.
+ * @tv_sec: If non-null, the variable pointed to will be assigned
+ * current time tv_sec val when the fence signals.
+ * @tv_usec: Must be set if @tv_sec is set, and the variable pointed to will
+ * be assigned the current time tv_usec val when the fence signals.
  * @interruptible: Interruptible waits if possible.
  *
  * As a side effect, the object pointed to by @event may have been
-- 
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,
	"Christian König" <christian.koenig@amd.com>,
	linaro-mm-sig@lists.linaro.org,
	"VMware Graphics" <linux-graphics-maintainer@vmware.com>,
	linux-media@vger.kernel.org
Subject: [PATCH 26/40] drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation params/headers
Date: Fri, 15 Jan 2021 18:12:59 +0000	[thread overview]
Message-ID: <20210115181313.3431493-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20210115181313.3431493-1-lee.jones@linaro.org>

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

 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:82: warning: Function parameter or member 'event' not described in 'vmw_event_fence_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:113: warning: Function parameter or member 'f' not described in 'vmw_fence_obj_destroy'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:261: warning: Function parameter or member 'work' not described in 'vmw_fence_work_func'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:720: warning: Function parameter or member 'fman' not described in 'vmw_fence_fifo_down'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:963: warning: Function parameter or member 'fence' not described in 'vmw_fence_obj_add_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:963: warning: Function parameter or member 'action' not described in 'vmw_fence_obj_add_action'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:1021: warning: Function parameter or member 'tv_sec' not described in 'vmw_event_fence_action_queue'
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c:1021: warning: Function parameter or member 'tv_usec' not described in 'vmw_event_fence_action_queue'

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: Sumit Semwal <sumit.semwal@linaro.org>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: dri-devel@lists.freedesktop.org
Cc: linux-media@vger.kernel.org
Cc: linaro-mm-sig@lists.linaro.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c b/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
index 378ec7600154b..23523eb3cac2a 100644
--- a/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
+++ b/drivers/gpu/drm/vmwgfx/vmwgfx_fence.c
@@ -58,13 +58,11 @@ struct vmw_user_fence {
 /**
  * struct vmw_event_fence_action - fence action that delivers a drm event.
  *
- * @e: A struct drm_pending_event that controls the event delivery.
  * @action: A struct vmw_fence_action to hook up to a fence.
+ * @event: A pointer to the pending event.
  * @fence: A referenced pointer to the fence to keep it alive while @action
  * hangs on it.
  * @dev: Pointer to a struct drm_device so we can access the event stuff.
- * @kref: Both @e and @action has destructors, so we need to refcount.
- * @size: Size accounted for this object.
  * @tv_sec: If non-null, the variable pointed to will be assigned
  * current time tv_sec val when the fence signals.
  * @tv_usec: Must be set if @tv_sec is set, and the variable pointed to will
@@ -87,7 +85,7 @@ fman_from_fence(struct vmw_fence_obj *fence)
 	return container_of(fence->base.lock, struct vmw_fence_manager, lock);
 }
 
-/**
+/*
  * Note on fencing subsystem usage of irqs:
  * Typically the vmw_fences_update function is called
  *
@@ -250,7 +248,7 @@ static const struct dma_fence_ops vmw_fence_ops = {
 };
 
 
-/**
+/*
  * Execute signal actions on fences recently signaled.
  * This is done from a workqueue so we don't have to execute
  * signal actions from atomic context.
@@ -708,7 +706,7 @@ int vmw_wait_dma_fence(struct vmw_fence_manager *fman,
 }
 
 
-/**
+/*
  * vmw_fence_fifo_down - signal all unsignaled fence objects.
  */
 
@@ -948,8 +946,8 @@ static void vmw_event_fence_action_cleanup(struct vmw_fence_action *action)
 /**
  * vmw_fence_obj_add_action - Add an action to a fence object.
  *
- * @fence - The fence object.
- * @action - The action to add.
+ * @fence: The fence object.
+ * @action: The action to add.
  *
  * Note that the action callbacks may be executed before this function
  * returns.
@@ -1001,6 +999,10 @@ static void vmw_fence_obj_add_action(struct vmw_fence_obj *fence,
  * @fence: The fence object on which to post the event.
  * @event: Event to be posted. This event should've been alloced
  * using k[mz]alloc, and should've been completely initialized.
+ * @tv_sec: If non-null, the variable pointed to will be assigned
+ * current time tv_sec val when the fence signals.
+ * @tv_usec: Must be set if @tv_sec is set, and the variable pointed to will
+ * be assigned the current time tv_usec val when the fence signals.
  * @interruptible: Interruptible waits if possible.
  *
  * As a side effect, the object pointed to by @event may have been
-- 
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 ` [PATCH 20/40] drm/vmwgfx/vmwgfx_kms: Update worthy function headers and demote others Lee Jones
2021-01-15 18:12   ` 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 ` Lee Jones [this message]
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: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-27-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=airlied@linux.ie \
    --cc=christian.koenig@amd.com \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=linaro-mm-sig@lists.linaro.org \
    --cc=linux-graphics-maintainer@vmware.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=sroland@vmware.com \
    --cc=sumit.semwal@linaro.org \
    /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.