Commit 88026282 authored by Jani Nikula's avatar Jani Nikula
Browse files

drm/i915/active: fix kernel-doc for function parameters 



drivers/gpu/drm/i915/i915_active.h:66: warning: Function parameter or member 'active' not described in '__i915_active_fence_init'
drivers/gpu/drm/i915/i915_active.h:66: warning: Function parameter or member 'fence' not described in '__i915_active_fence_init'
drivers/gpu/drm/i915/i915_active.h:66: warning: Function parameter or member 'fn' not described in '__i915_active_fence_init'
drivers/gpu/drm/i915/i915_active.h:89: warning: Function parameter or member 'active' not described in 'i915_active_fence_set'
drivers/gpu/drm/i915/i915_active.h:89: warning: Function parameter or member 'rq' not described in 'i915_active_fence_set'
drivers/gpu/drm/i915/i915_active.h:102: warning: Function parameter or member 'active' not described in 'i915_active_fence_get'
drivers/gpu/drm/i915/i915_active.h:122: warning: Function parameter or member 'active' not described in 'i915_active_fence_isset'

Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
Reviewed-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/7f201c6cb715e4b3cece78ffa893a75610ecd27d.1683041799.git.jani.nikula@intel.com
parent 1c519e06

drivers/gpu/drm/i915/i915_active.h

+7 −7
Original line number Diff line number Diff line
@@ -49,9 +49,9 @@ void i915_active_noop(struct dma_fence *fence, struct dma_fence_cb *cb); 


/**

 * __i915_active_fence_init - prepares the activity tracker for use

 * @active - the active tracker

 * @fence - initial fence to track, can be NULL

 * @func - a callback when then the tracker is retired (becomes idle),

 * @active: the active tracker

 * @fence: initial fence to track, can be NULL

 * @fn: a callback when then the tracker is retired (becomes idle),

 *         can be NULL

 *

 * i915_active_fence_init() prepares the embedded @active struct for use as
@@ -77,8 +77,8 @@ __i915_active_fence_set(struct i915_active_fence *active, 


/**

 * i915_active_fence_set - updates the tracker to watch the current fence

 * @active - the active tracker

 * @rq - the request to watch

 * @active: the active tracker

 * @rq: the request to watch

 *

 * i915_active_fence_set() watches the given @rq for completion. While

 * that @rq is busy, the @active reports busy. When that @rq is signaled
@@ -89,7 +89,7 @@ i915_active_fence_set(struct i915_active_fence *active, 
		      struct i915_request *rq);

/**

 * i915_active_fence_get - return a reference to the active fence

 * @active - the active tracker

 * @active: the active tracker

 *

 * i915_active_fence_get() returns a reference to the active fence,

 * or NULL if the active tracker is idle. The reference is obtained under RCU,
@@ -111,7 +111,7 @@ i915_active_fence_get(struct i915_active_fence *active) 


/**

 * i915_active_fence_isset - report whether the active tracker is assigned

 * @active - the active tracker

 * @active: the active tracker

 *

 * i915_active_fence_isset() returns true if the active tracker is currently

 * assigned to a fence. Due to the lazy retiring, that fence may be idle