Skip to content

Commit 4fc510e

Browse files
rddunlaplumag
authored andcommitted
drm/msm: msm_fence.h: fix all kernel-doc warnings
Correct or add kernel-doc comments to eliminate all warnings: Warning: drivers/gpu/drm/msm/msm_fence.h:27 Incorrect use of kernel-doc format: * last_fence: Warning: drivers/gpu/drm/msm/msm_fence.h:36 Incorrect use of kernel-doc format: * completed_fence: Warning: drivers/gpu/drm/msm/msm_fence.h:44 Incorrect use of kernel-doc format: * fenceptr: Warning: drivers/gpu/drm/msm/msm_fence.h:65 Incorrect use of kernel-doc format: * next_deadline_fence: Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'dev' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'name' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'context' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'index' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'fence' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'there is no remaining pending work */ uint32_t last_fence' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'updated from the CPU after interrupt * from GPU */ uint32_t completed_fence' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'fenceptr' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'spinlock' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'next_deadline' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'next_deadline_fence' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'deadline_timer' not described in 'msm_fence_context' Warning: drivers/gpu/drm/msm/msm_fence.h:74 struct member 'deadline_work' not described in 'msm_fence_context' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com> Patchwork: https://patchwork.freedesktop.org/patch/695667/ Link: https://lore.kernel.org/r/20251219184638.1813181-17-rdunlap@infradead.org Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
1 parent a6ccad6 commit 4fc510e

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

drivers/gpu/drm/msm/msm_fence.h

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,39 @@
1616
* incrementing fence seqno at the end of each submit
1717
*/
1818
struct msm_fence_context {
19+
/** @dev: the drm device */
1920
struct drm_device *dev;
20-
/** name: human readable name for fence timeline */
21+
/** @name: human readable name for fence timeline */
2122
char name[32];
22-
/** context: see dma_fence_context_alloc() */
23+
/** @context: see dma_fence_context_alloc() */
2324
unsigned context;
24-
/** index: similar to context, but local to msm_fence_context's */
25+
/** @index: similar to context, but local to msm_fence_context's */
2526
unsigned index;
26-
2727
/**
28-
* last_fence:
29-
*
28+
* @last_fence:
3029
* Last assigned fence, incremented each time a fence is created
3130
* on this fence context. If last_fence == completed_fence,
3231
* there is no remaining pending work
3332
*/
3433
uint32_t last_fence;
35-
3634
/**
37-
* completed_fence:
38-
*
35+
* @completed_fence:
3936
* The last completed fence, updated from the CPU after interrupt
4037
* from GPU
4138
*/
4239
uint32_t completed_fence;
43-
4440
/**
45-
* fenceptr:
46-
*
41+
* @fenceptr:
4742
* The address that the GPU directly writes with completed fence
4843
* seqno. This can be ahead of completed_fence. We can peek at
4944
* this to see if a fence has already signaled but the CPU hasn't
5045
* gotten around to handling the irq and updating completed_fence
5146
*/
5247
volatile uint32_t *fenceptr;
5348

49+
/**
50+
* @spinlock: fence context spinlock
51+
*/
5452
spinlock_t spinlock;
5553

5654
/*
@@ -59,18 +57,22 @@ struct msm_fence_context {
5957
* don't queue, so maybe that is ok
6058
*/
6159

62-
/** next_deadline: Time of next deadline */
60+
/** @next_deadline: Time of next deadline */
6361
ktime_t next_deadline;
64-
6562
/**
66-
* next_deadline_fence:
67-
*
63+
* @next_deadline_fence:
6864
* Fence value for next pending deadline. The deadline timer is
6965
* canceled when this fence is signaled.
7066
*/
7167
uint32_t next_deadline_fence;
72-
68+
/**
69+
* @deadline_timer: tracks nearest deadline of a fence timeline and
70+
* expires just before it.
71+
*/
7372
struct hrtimer deadline_timer;
73+
/**
74+
* @deadline_work: work to do after deadline_timer expires
75+
*/
7476
struct kthread_work deadline_work;
7577
};
7678

0 commit comments

Comments
 (0)