Skip to content

Commit 2d1e962

Browse files
committed
drm/xe: Fix broken kernel-doc for the struct xe_bo
Use correct multi-line kernel-doc style if required. Some members were described only in the commit message. Some other members were described using wrong names. Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Cc: Matthew Brost <matthew.brost@intel.com> Cc: Himal Prasad Ghimiray <himal.prasad.ghimiray@intel.com> Cc: Satyanarayana K V P <satyanarayana.k.v.p@intel.com> Reviewed-by: Satyanarayana K V P <satyanarayana.k.v.p@intel.com> Link: https://lore.kernel.org/r/20250904144026.7222-1-michal.wajdeczko@intel.com
1 parent dcc38bc commit 2d1e962

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

drivers/gpu/drm/xe/xe_bo_types.h

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ struct xe_vm;
2525
/* TODO: To be selected with VM_MADVISE */
2626
#define XE_BO_PRIORITY_NORMAL 1
2727

28-
/** @xe_bo: XE buffer object */
28+
/**
29+
* struct xe_bo - Xe buffer object
30+
*/
2931
struct xe_bo {
3032
/** @ttm: TTM base buffer object */
3133
struct ttm_buffer_object ttm;
@@ -47,7 +49,7 @@ struct xe_bo {
4749
struct xe_ggtt_node *ggtt_node[XE_MAX_TILES_PER_DEVICE];
4850
/** @vmap: iosys map of this buffer */
4951
struct iosys_map vmap;
50-
/** @ttm_kmap: TTM bo kmap object for internal use only. Keep off. */
52+
/** @kmap: TTM bo kmap object for internal use only. Keep off. */
5153
struct ttm_bo_kmap_obj kmap;
5254
/** @pinned_link: link to present / evicted list of pinned BO */
5355
struct list_head pinned_link;
@@ -82,10 +84,10 @@ struct xe_bo {
8284
/** @created: Whether the bo has passed initial creation */
8385
bool created;
8486

85-
/** @ccs_cleared */
87+
/** @ccs_cleared: true means that CCS region of BO is already cleared */
8688
bool ccs_cleared;
8789

88-
/** @bb_ccs_rw: BB instructions of CCS read/write. Valid only for VF */
90+
/** @bb_ccs: BB instructions of CCS read/write. Valid only for VF */
8991
struct xe_bb *bb_ccs[XE_SRIOV_VF_CCS_CTX_COUNT];
9092

9193
/**
@@ -99,9 +101,10 @@ struct xe_bo {
99101
struct drm_pagemap_devmem devmem_allocation;
100102

101103
/** @vram_userfault_link: Link into @mem_access.vram_userfault.list */
102-
struct list_head vram_userfault_link;
104+
struct list_head vram_userfault_link;
103105

104-
/** @min_align: minimum alignment needed for this BO if different
106+
/**
107+
* @min_align: minimum alignment needed for this BO if different
105108
* from default
106109
*/
107110
u64 min_align;

0 commit comments

Comments
 (0)