Commit c6771b63 authored by Lee Jones's avatar Lee Jones Committed by Zack Rusin

drm/vmwgfx/vmwgfx_fence: Add, remove and demote various documentation params/headers

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: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarZack Rusin <zackr@vmware.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20210115181313.3431493-27-lee.jones@linaro.org
parent 3a839da0
...@@ -58,13 +58,11 @@ struct vmw_user_fence { ...@@ -58,13 +58,11 @@ struct vmw_user_fence {
/** /**
* struct vmw_event_fence_action - fence action that delivers a drm event. * 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. * @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 * @fence: A referenced pointer to the fence to keep it alive while @action
* hangs on it. * hangs on it.
* @dev: Pointer to a struct drm_device so we can access the event stuff. * @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 * @tv_sec: If non-null, the variable pointed to will be assigned
* current time tv_sec val when the fence signals. * 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 * @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) ...@@ -87,7 +85,7 @@ fman_from_fence(struct vmw_fence_obj *fence)
return container_of(fence->base.lock, struct vmw_fence_manager, lock); return container_of(fence->base.lock, struct vmw_fence_manager, lock);
} }
/** /*
* Note on fencing subsystem usage of irqs: * Note on fencing subsystem usage of irqs:
* Typically the vmw_fences_update function is called * Typically the vmw_fences_update function is called
* *
...@@ -250,7 +248,7 @@ static const struct dma_fence_ops vmw_fence_ops = { ...@@ -250,7 +248,7 @@ static const struct dma_fence_ops vmw_fence_ops = {
}; };
/** /*
* Execute signal actions on fences recently signaled. * Execute signal actions on fences recently signaled.
* This is done from a workqueue so we don't have to execute * This is done from a workqueue so we don't have to execute
* signal actions from atomic context. * signal actions from atomic context.
...@@ -708,7 +706,7 @@ int vmw_wait_dma_fence(struct vmw_fence_manager *fman, ...@@ -708,7 +706,7 @@ int vmw_wait_dma_fence(struct vmw_fence_manager *fman,
} }
/** /*
* vmw_fence_fifo_down - signal all unsignaled fence objects. * 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) ...@@ -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. * vmw_fence_obj_add_action - Add an action to a fence object.
* *
* @fence - The fence object. * @fence: The fence object.
* @action - The action to add. * @action: The action to add.
* *
* Note that the action callbacks may be executed before this function * Note that the action callbacks may be executed before this function
* returns. * returns.
...@@ -1001,6 +999,10 @@ static void vmw_fence_obj_add_action(struct vmw_fence_obj *fence, ...@@ -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. * @fence: The fence object on which to post the event.
* @event: Event to be posted. This event should've been alloced * @event: Event to be posted. This event should've been alloced
* using k[mz]alloc, and should've been completely initialized. * 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. * @interruptible: Interruptible waits if possible.
* *
* As a side effect, the object pointed to by @event may have been * As a side effect, the object pointed to by @event may have been
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment