xref: /OK3568_Linux_fs/kernel/include/drm/drm_vblank_work.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: MIT */
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun #ifndef _DRM_VBLANK_WORK_H_
4*4882a593Smuzhiyun #define _DRM_VBLANK_WORK_H_
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include <linux/kthread.h>
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun struct drm_crtc;
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun /**
11*4882a593Smuzhiyun  * struct drm_vblank_work - A delayed work item which delays until a target
12*4882a593Smuzhiyun  * vblank passes, and then executes at realtime priority outside of IRQ
13*4882a593Smuzhiyun  * context.
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  * See also:
16*4882a593Smuzhiyun  * drm_vblank_work_schedule()
17*4882a593Smuzhiyun  * drm_vblank_work_init()
18*4882a593Smuzhiyun  * drm_vblank_work_cancel_sync()
19*4882a593Smuzhiyun  * drm_vblank_work_flush()
20*4882a593Smuzhiyun  */
21*4882a593Smuzhiyun struct drm_vblank_work {
22*4882a593Smuzhiyun 	/**
23*4882a593Smuzhiyun 	 * @base: The base &kthread_work item which will be executed by
24*4882a593Smuzhiyun 	 * &drm_vblank_crtc.worker. Drivers should not interact with this
25*4882a593Smuzhiyun 	 * directly, and instead rely on drm_vblank_work_init() to initialize
26*4882a593Smuzhiyun 	 * this.
27*4882a593Smuzhiyun 	 */
28*4882a593Smuzhiyun 	struct kthread_work base;
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun 	/**
31*4882a593Smuzhiyun 	 * @vblank: A pointer to &drm_vblank_crtc this work item belongs to.
32*4882a593Smuzhiyun 	 */
33*4882a593Smuzhiyun 	struct drm_vblank_crtc *vblank;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 	/**
36*4882a593Smuzhiyun 	 * @count: The target vblank this work will execute on. Drivers should
37*4882a593Smuzhiyun 	 * not modify this value directly, and instead use
38*4882a593Smuzhiyun 	 * drm_vblank_work_schedule()
39*4882a593Smuzhiyun 	 */
40*4882a593Smuzhiyun 	u64 count;
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun 	/**
43*4882a593Smuzhiyun 	 * @cancelling: The number of drm_vblank_work_cancel_sync() calls that
44*4882a593Smuzhiyun 	 * are currently running. A work item cannot be rescheduled until all
45*4882a593Smuzhiyun 	 * calls have finished.
46*4882a593Smuzhiyun 	 */
47*4882a593Smuzhiyun 	int cancelling;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	/**
50*4882a593Smuzhiyun 	 * @node: The position of this work item in
51*4882a593Smuzhiyun 	 * &drm_vblank_crtc.pending_work.
52*4882a593Smuzhiyun 	 */
53*4882a593Smuzhiyun 	struct list_head node;
54*4882a593Smuzhiyun };
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun /**
57*4882a593Smuzhiyun  * to_drm_vblank_work - Retrieve the respective &drm_vblank_work item from a
58*4882a593Smuzhiyun  * &kthread_work
59*4882a593Smuzhiyun  * @_work: The &kthread_work embedded inside a &drm_vblank_work
60*4882a593Smuzhiyun  */
61*4882a593Smuzhiyun #define to_drm_vblank_work(_work) \
62*4882a593Smuzhiyun 	container_of((_work), struct drm_vblank_work, base)
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun int drm_vblank_work_schedule(struct drm_vblank_work *work,
65*4882a593Smuzhiyun 			     u64 count, bool nextonmiss);
66*4882a593Smuzhiyun void drm_vblank_work_init(struct drm_vblank_work *work, struct drm_crtc *crtc,
67*4882a593Smuzhiyun 			  void (*func)(struct kthread_work *work));
68*4882a593Smuzhiyun bool drm_vblank_work_cancel_sync(struct drm_vblank_work *work);
69*4882a593Smuzhiyun void drm_vblank_work_flush(struct drm_vblank_work *work);
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun #endif /* !_DRM_VBLANK_WORK_H_ */
72