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 03/40] drm/vmwgfx/vmwgfx_execbuf: Fix some kernel-doc related issues
Date: Fri, 15 Jan 2021 18:12:36 +0000 [thread overview]
Message-ID: <20210115181313.3431493-4-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_execbuf.c:89: warning: Enum value 'vmw_res_rel_max' not described in enum 'vmw_resource_relocation_type'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:136: warning: Function parameter or member 'func' not described in 'vmw_cmd_entry'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:136: warning: Function parameter or member 'cmd_name' not described in 'vmw_cmd_entry'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:212: warning: Function parameter or member 'res' not described in 'vmw_cmd_ctx_first_setup'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:523: warning: Function parameter or member 'sw_context' not described in 'vmw_resource_relocation_add'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:523: warning: Excess function parameter 'list' description in 'vmw_resource_relocation_add'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:653: warning: Function parameter or member 'p_res' not described in 'vmw_cmd_res_check'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:653: warning: Excess function parameter 'p_val' description in 'vmw_cmd_res_check'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:1716: warning: Function parameter or member 'res' not described in 'vmw_cmd_res_switch_backup'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:1716: warning: Excess function parameter 'val_node' description in 'vmw_cmd_res_switch_backup'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'file_priv' not described in 'vmw_execbuf_fence_commands'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'dev_priv' not described in 'vmw_execbuf_fence_commands'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'p_fence' not described in 'vmw_execbuf_fence_commands'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3757: warning: Function parameter or member 'p_handle' not described in 'vmw_execbuf_fence_commands'
drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c:3954: warning: Function parameter or member 'kernel_commands' not described in 'vmw_execbuf_cmdbuf'
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_execbuf.c | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c b/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c
index 462f173207085..7a24196f92c38 100644
--- a/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c
+++ b/drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c
@@ -80,7 +80,8 @@ struct vmw_relocation {
* with a NOP.
* @vmw_res_rel_cond_nop: Conditional NOP relocation. If the resource id after
* validation is -1, the command is replaced with a NOP. Otherwise no action.
- */
+ * @vmw_res_rel_max: Last value in the enum - used for error checking
+*/
enum vmw_resource_relocation_type {
vmw_res_rel_normal,
vmw_res_rel_nop,
@@ -122,9 +123,11 @@ struct vmw_ctx_validation_info {
/**
* struct vmw_cmd_entry - Describe a command for the verifier
*
+ * @func: Call-back to handle the command.
* @user_allow: Whether allowed from the execbuf ioctl.
* @gb_disable: Whether disabled if guest-backed objects are available.
* @gb_enable: Whether enabled iff guest-backed objects are available.
+ * @cmd_name: Name of the command.
*/
struct vmw_cmd_entry {
int (*func) (struct vmw_private *, struct vmw_sw_context *,
@@ -203,6 +206,7 @@ static void vmw_bind_dx_query_mob(struct vmw_sw_context *sw_context)
*
* @dev_priv: Pointer to the device private:
* @sw_context: The command submission context
+ * @res: Pointer to the resource
* @node: The validation node holding the context resource metadata
*/
static int vmw_cmd_ctx_first_setup(struct vmw_private *dev_priv,
@@ -509,7 +513,7 @@ static int vmw_resource_context_res_add(struct vmw_private *dev_priv,
/**
* vmw_resource_relocation_add - Add a relocation to the relocation list
*
- * @list: Pointer to head of relocation list.
+ * @sw_context: Pointer to the software context.
* @res: The resource.
* @offset: Offset into the command buffer currently being parsed where the id
* that needs fixup is located. Granularity is one byte.
@@ -639,7 +643,7 @@ static int vmw_resources_reserve(struct vmw_sw_context *sw_context)
* @converter: User-space visisble type specific information.
* @id_loc: Pointer to the location in the command buffer currently being parsed
* from where the user-space resource id handle is located.
- * @p_val: Pointer to pointer to resource validalidation node. Populated on
+ * @p_res: Pointer to pointer to resource validalidation node. Populated on
* exit.
*/
static int
@@ -1700,7 +1704,7 @@ static int vmw_cmd_check_define_gmrfb(struct vmw_private *dev_priv,
*
* @dev_priv: Pointer to a device private struct.
* @sw_context: The software context being used for this batch.
- * @val_node: The validation node representing the resource.
+ * @res: Pointer to the resource.
* @buf_id: Pointer to the user-space backup buffer handle in the command
* stream.
* @backup_offset: Offset of backup into MOB.
@@ -3739,7 +3743,7 @@ static int vmw_resize_cmd_bounce(struct vmw_sw_context *sw_context,
return 0;
}
-/**
+/*
* vmw_execbuf_fence_commands - create and submit a command stream fence
*
* Creates a fence object and submits a command stream marker.
@@ -3939,9 +3943,9 @@ static int vmw_execbuf_submit_cmdbuf(struct vmw_private *dev_priv,
* On successful return, the function returns a pointer to the data in the
* command buffer and *@header is set to non-NULL.
*
- * If command buffers could not be used, the function will return the value of
- * @kernel_commands on function call. That value may be NULL. In that case, the
- * value of *@header will be set to NULL.
+ * @kernel_commands: If command buffers could not be used, the function will
+ * return the value of @kernel_commands on function call. That value may be
+ * NULL. In that case, the value of *@header will be set to NULL.
*
* If an error is encountered, the function will return a pointer error value.
* If the function is interrupted by a signal while sleeping, it will return
--
2.25.1
next prev parent reply other threads:[~2021-01-15 18:14 UTC|newest]
Thread overview: 43+ 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 ` [PATCH 01/40] drm/r128/r128_ioc32: Document headers do not make good kernel-doc candidates Lee Jones
2021-01-15 18:12 ` [PATCH 02/40] drm/mga/mga_ioc32: " Lee Jones
2021-01-15 18:12 ` Lee Jones [this message]
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 ` [PATCH 05/40] drm/r128/r128_ioc32: Fix formatting issues in 'r128_compat_ioctl()'s header 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 ` [PATCH 07/40] drm/vmwgfx/vmwgfx_kms: Mark vmw_{cursor,primary}_plane_formats as __maybe_unused 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 ` [PATCH 09/40] drm/vmwgfx/vmwgfx_ioctl: Provide missing '@' sign required by kernel-doc 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 ` [PATCH 11/40] drm/vmwgfx/vmwgfx_ttm_buffer: Supply some missing parameter descriptions 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 ` [PATCH 13/40] drm/vmwgfx/vmwgfx_ldu: Supply descriptions for 'state' function parameter 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 ` [PATCH 15/40] drm/gma500/gem: Add and rename some function parameter descriptions 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 ` [PATCH 17/40] drm/gma500/intel_i2c: Remove superflouous parameter description and rename another 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 ` [PATCH 19/40] drm/gma500/power: Fix a bunch of *dev documentation issues 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 ` [PATCH 21/40] drm/gma500/gma_display: Demote kernel-doc abuses to standard comment blocks 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 ` [PATCH 23/40] drm/vmwgfx/vmwgfx_overlay: Demote kernel-doc abuses to standard comment blocks 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 ` [PATCH 25/40] drm/gma500/psb_intel_lvds: Supply description for 'mode_dev' 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:13 ` [PATCH 27/40] drm/vmwgfx/vmwgfx_bo: Remove superfluous param description and supply another 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 ` [PATCH 29/40] drm/vmwgfx/vmwgfx_scrn: Demote unworthy kernel-doc headers and update others 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 ` [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 ` [PATCH 32/40] drm/gma500/gem: Include our own header containing prototypes 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 ` [PATCH 34/40] drm/gma500/mmu: Remove unused function 'psb_get_default_pd_addr' 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 ` [PATCH 36/40] drm/vmwgfx/vmwgfx_shader: Demote kernel-doc abuses and fix-up worthy headers 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 ` [PATCH 38/40] drm/gma500/power: Remove excess param description 'state' 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 ` [PATCH 40/40] drm/vmwgfx/vmwgfx_stdu: Add some missing param/member descriptions Lee Jones
2021-01-15 18:22 ` [PATCH 00/40] [Set 14] Rid W=1 warnings from GPU Zack Rusin
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-4-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 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).