drm/xe: Add kernel-doc to some xe_lrc interfaces
Add kernel-doc to xe_lrc_create/destroy and xe_lrc_get/put interfaces. v2: Fix kernel-doc for xe_lrc_create(), drop Fixes tag. (Matt Brost, Michal Wajdeczko) Signed-off-by: Niranjana Vishwanathapura <niranjana.vishwanathapura@intel.com> Reviewed-by: Matthew Brost <matthew.brost@intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20240531161230.32317-1-niranjana.vishwanathapura@intel.com Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
This commit is contained in:
parent
f2bf9e9598
commit
877517f2dc
@ -945,6 +945,17 @@ err_lrc_finish:
|
||||
return err;
|
||||
}
|
||||
|
||||
/**
|
||||
* xe_lrc_create - Create a LRC
|
||||
* @hwe: Hardware Engine
|
||||
* @vm: The VM (address space)
|
||||
* @ring_size: LRC ring size
|
||||
*
|
||||
* Allocate and initialize the Logical Ring Context (LRC).
|
||||
*
|
||||
* Return pointer to created LRC upon success and an error pointer
|
||||
* upon failure.
|
||||
*/
|
||||
struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
|
||||
u32 ring_size)
|
||||
{
|
||||
@ -964,6 +975,13 @@ struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
|
||||
return lrc;
|
||||
}
|
||||
|
||||
/**
|
||||
* xe_lrc_destroy - Destroy the LRC
|
||||
* @ref: reference to LRC
|
||||
*
|
||||
* Called when ref == 0, release resources held by the Logical Ring Context
|
||||
* (LRC) and free the LRC memory.
|
||||
*/
|
||||
void xe_lrc_destroy(struct kref *ref)
|
||||
{
|
||||
struct xe_lrc *lrc = container_of(ref, struct xe_lrc, refcount);
|
||||
|
@ -26,12 +26,25 @@ struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
|
||||
u32 ring_size);
|
||||
void xe_lrc_destroy(struct kref *ref);
|
||||
|
||||
/**
|
||||
* xe_lrc_get - Get reference to the LRC
|
||||
* @lrc: Logical Ring Context
|
||||
*
|
||||
* Increment reference count of @lrc
|
||||
*/
|
||||
static inline struct xe_lrc *xe_lrc_get(struct xe_lrc *lrc)
|
||||
{
|
||||
kref_get(&lrc->refcount);
|
||||
return lrc;
|
||||
}
|
||||
|
||||
/**
|
||||
* xe_lrc_put - Put reference of the LRC
|
||||
* @lrc: Logical Ring Context
|
||||
*
|
||||
* Decrement reference count of @lrc, call xe_lrc_destroy when
|
||||
* reference count reaches 0.
|
||||
*/
|
||||
static inline void xe_lrc_put(struct xe_lrc *lrc)
|
||||
{
|
||||
kref_put(&lrc->refcount, xe_lrc_destroy);
|
||||
|
Loading…
x
Reference in New Issue
Block a user