Unverified Commit 877517f2 authored by Niranjana Vishwanathapura's avatar Niranjana Vishwanathapura Committed by Rodrigo Vivi
Browse files

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: default avatarNiranjana Vishwanathapura <niranjana.vishwanathapura@intel.com>
Reviewed-by: default avatarMatthew Brost <matthew.brost@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240531161230.32317-1-niranjana.vishwanathapura@intel.com


Signed-off-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
parent f2bf9e95

drivers/gpu/drm/xe/xe_lrc.c

+18 −0
Original line number Diff line number Diff line
@@ -945,6 +945,17 @@ static int xe_lrc_init(struct xe_lrc *lrc, struct xe_hw_engine *hwe, 
	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);

drivers/gpu/drm/xe/xe_lrc.h

+13 −0
Original line number Diff line number Diff line
@@ -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);