[PATCH 00/40] [Set 14] Rid W=1 warnings from GPU

[PATCH 00/40] [Set 14] Rid W=1 warnings from GPU

[Lee Jones]

This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.

Penultimate set, promise. :)

Lee Jones (40):
  drm/r128/r128_ioc32: Document headers do not make good kernel-doc
    candidates
  drm/mga/mga_ioc32: Document headers do not make good kernel-doc
    candidates
  drm/vmwgfx/vmwgfx_execbuf: Fix some kernel-doc related issues
  drm/vmwgfx/vmwgfx_kms: Remove unused variable 'ret' from
    'vmw_du_primary_plane_atomic_check()'
  drm/r128/r128_ioc32: Fix formatting issues in 'r128_compat_ioctl()'s
    header
  drm/mga/mga_ioc32: Fix some formatting issues in 'mga_compat_ioctl's
    header
  drm/vmwgfx/vmwgfx_kms: Mark vmw_{cursor,primary}_plane_formats as
    __maybe_unused
  drm/vmwgfx/vmwgfx_drv: Fix some kernel-doc misdemeanours
  drm/vmwgfx/vmwgfx_ioctl: Provide missing '@' sign required by
    kernel-doc
  drm/vmwgfx/vmwgfx_resource: Fix worthy function headers demote some
    others
  drm/vmwgfx/vmwgfx_ttm_buffer: Supply some missing parameter
    descriptions
  drm/vmwgfx/vmwgfx_fifo: Demote non-conformant kernel-doc header
  drm/vmwgfx/vmwgfx_ldu: Supply descriptions for 'state' function
    parameter
  drm/gma500/framebuffer: Fix some possible doc-rot issues
  drm/gma500/gem: Add and rename some function parameter descriptions
  drm/gma500/intel_bios: Demote non-conformant kernel-doc header
  drm/gma500/intel_i2c: Remove superflouous parameter description and
    rename another
  drm/gma500/mmu: Make local function 'psb_mmu_pt_alloc_map_lock()'
    static
  drm/gma500/power: Fix a bunch of *dev documentation issues
  drm/vmwgfx/vmwgfx_kms: Update worthy function headers and demote
    others
  drm/gma500/gma_display: Demote kernel-doc abuses to standard comment
    blocks
  drm/gma500/gma_device: Include our own header containing prototypes
  drm/vmwgfx/vmwgfx_overlay: Demote kernel-doc abuses to standard
    comment blocks
  drm/gma500/psb_intel_display: Demote kernel-doc formatting abuse
  drm/gma500/psb_intel_lvds: Supply description for 'mode_dev'
  drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation
    params/headers
  drm/vmwgfx/vmwgfx_bo: Remove superfluous param description and supply
    another
  drm/vmwgfx/vmwgfx_context: Demote kernel-doc abuses
  drm/vmwgfx/vmwgfx_scrn: Demote unworthy kernel-doc headers and update
    others
  drm/gma500/psb_intel_modes: Provide missing descriptions for function
    param 'adapter'
  drm/gma500/gem: Do not rely on consumers to include drm/drm_device.h
    before gem.h
  drm/gma500/gem: Include our own header containing prototypes
  drm/vmwgfx/vmwgfx_surface: Fix some kernel-doc related issues
  drm/gma500/mmu: Remove unused function 'psb_get_default_pd_addr'
  drm/vmwgfx/vmwgfx_cmdbuf_res: Rename param description and remove
    another
  drm/vmwgfx/vmwgfx_shader: Demote kernel-doc abuses and fix-up worthy
    headers
  drm/vmwgfx/vmwgfx_cmdbuf: Fix a bunch of missing or incorrectly
    formatted/named params
  drm/gma500/power: Remove excess param description 'state'
  drm/vmwgfx/vmwgfx_cmdbuf_res: Remove unused variable 'ret'
  drm/vmwgfx/vmwgfx_stdu: Add some missing param/member descriptions

 drivers/gpu/drm/gma500/framebuffer.c       |  6 +++---
 drivers/gpu/drm/gma500/gem.c               |  6 ++++--
 drivers/gpu/drm/gma500/gem.h               |  2 ++
 drivers/gpu/drm/gma500/gma_device.c        |  1 +
 drivers/gpu/drm/gma500/gma_display.c       |  8 ++++----
 drivers/gpu/drm/gma500/intel_bios.c        |  2 +-
 drivers/gpu/drm/gma500/intel_i2c.c         |  3 +--
 drivers/gpu/drm/gma500/mmu.c               | 13 ++-----------
 drivers/gpu/drm/gma500/power.c             |  8 ++++----
 drivers/gpu/drm/gma500/psb_intel_display.c |  2 +-
 drivers/gpu/drm/gma500/psb_intel_lvds.c    |  1 +
 drivers/gpu/drm/gma500/psb_intel_modes.c   |  3 ++-
 drivers/gpu/drm/mga/mga_ioc32.c            | 14 +++++++-------
 drivers/gpu/drm/r128/r128_ioc32.c          | 14 +++++++-------
 drivers/gpu/drm/vmwgfx/vmwgfx_bo.c         |  2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_cmd.c        |  2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_cmdbuf.c     | 12 ++++++++----
 drivers/gpu/drm/vmwgfx/vmwgfx_cmdbuf_res.c |  8 ++------
 drivers/gpu/drm/vmwgfx/vmwgfx_context.c    |  6 +++---
 drivers/gpu/drm/vmwgfx/vmwgfx_drv.c        |  8 ++++----
 drivers/gpu/drm/vmwgfx/vmwgfx_execbuf.c    | 20 ++++++++++++--------
 drivers/gpu/drm/vmwgfx/vmwgfx_fence.c      | 18 ++++++++++--------
 drivers/gpu/drm/vmwgfx/vmwgfx_ioctl.c      |  2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c        | 16 ++++++++--------
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.h        |  4 ++--
 drivers/gpu/drm/vmwgfx/vmwgfx_ldu.c        |  4 +++-
 drivers/gpu/drm/vmwgfx/vmwgfx_overlay.c    | 16 ++++++++--------
 drivers/gpu/drm/vmwgfx/vmwgfx_resource.c   | 10 ++++------
 drivers/gpu/drm/vmwgfx/vmwgfx_scrn.c       | 10 ++++++----
 drivers/gpu/drm/vmwgfx/vmwgfx_shader.c     | 10 +++++-----
 drivers/gpu/drm/vmwgfx/vmwgfx_stdu.c       |  9 +++++++--
 drivers/gpu/drm/vmwgfx/vmwgfx_surface.c    | 17 ++++++++++-------
 drivers/gpu/drm/vmwgfx/vmwgfx_ttm_buffer.c |  2 ++
 33 files changed, 137 insertions(+), 122 deletions(-)

Cc: Alan Cox <alan@linux.intel.com>
Cc: Benjamin Defnet <benjamin.r.defnet@intel.com>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: David Airlie <airlied@linux.ie>
Cc: dri-devel@lists.freedesktop.org
Cc: Eric Anholt <eric@anholt.net>
Cc: Jesse Barnes <jesse.barnes@intel.com>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: linaro-mm-sig@lists.linaro.org
Cc: linux-media@vger.kernel.org
Cc: Patrik Jakobsson <patrik.r.jakobsson@gmail.com>
Cc: Rajesh Poornachandran <rajesh.poornachandran@intel.com>
Cc: Roland Scheidegger <sroland@vmware.com>
Cc: Sumit Semwal <sumit.semwal@linaro.org>
Cc: VMware Graphics <linux-graphics-maintainer@vmware.com>
Cc: Zack Rusin <zackr@vmware.com>
-- 
2.25.1

[PATCH 03/40] drm/vmwgfx/vmwgfx_execbuf: Fix some kernel-doc related issues

[Lee Jones]

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

[PATCH 26/40] drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation params/headers

[Lee Jones]

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

Re: [PATCH 00/40] [Set 14] Rid W=1 warnings from GPU

[Zack Rusin]

> On Jan 15, 2021, at 13:12, Lee Jones <lee.jones@linaro.org> wrote:
> 
> This set is part of a larger effort attempting to clean-up W=1
> kernel builds, which are currently overwhelmingly riddled with
> niggly little warnings.
> 
> Penultimate set, promise. :)


Thank you for all that work. For all the vmwgfx bits:
Reviewed-by: Zack Rusin <zackr@vmware.com>

z

Re: [PATCH 00/40] [Set 14] Rid W=1 warnings from GPU

[Daniel Vetter]

On Fri, Jan 15, 2021 at 06:22:23PM +0000, Zack Rusin wrote:
> 
> > On Jan 15, 2021, at 13:12, Lee Jones <lee.jones@linaro.org> wrote:
> > 
> > This set is part of a larger effort attempting to clean-up W=1
> > kernel builds, which are currently overwhelmingly riddled with
> > niggly little warnings.
> > 
> > Penultimate set, promise. :)
> 
> 
> Thank you for all that work. For all the vmwgfx bits:
> Reviewed-by: Zack Rusin <zackr@vmware.com>

I pulled all the non-vmxgfx patches to drm-misc-next, I'll leave the vmw
stuff to Zack.

Thanks for your work here!
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch