1 /*
2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
26 */
27
28 #ifndef DRM_ATOMIC_HELPER_H_
29 #define DRM_ATOMIC_HELPER_H_
30
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_modeset_helper_vtables.h>
33 #include <drm/drm_modeset_helper.h>
34 #include <drm/drm_atomic_state_helper.h>
35 #include <drm/drm_util.h>
36
37 struct drm_atomic_state;
38 struct drm_private_obj;
39 struct drm_private_state;
40
41 int drm_atomic_helper_check_modeset(struct drm_device *dev,
42 struct drm_atomic_state *state);
43 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
44 const struct drm_crtc_state *crtc_state,
45 int min_scale,
46 int max_scale,
47 bool can_position,
48 bool can_update_disabled);
49 int drm_atomic_helper_check_planes(struct drm_device *dev,
50 struct drm_atomic_state *state);
51 int drm_atomic_helper_check(struct drm_device *dev,
52 struct drm_atomic_state *state);
53 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
54 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
55 int drm_atomic_helper_commit(struct drm_device *dev,
56 struct drm_atomic_state *state,
57 bool nonblock);
58 int drm_atomic_helper_async_check(struct drm_device *dev,
59 struct drm_atomic_state *state);
60 void drm_atomic_helper_async_commit(struct drm_device *dev,
61 struct drm_atomic_state *state);
62
63 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
64 struct drm_atomic_state *state,
65 bool pre_swap);
66
67 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
68 struct drm_atomic_state *old_state);
69
70 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
71 struct drm_atomic_state *old_state);
72
73 void
74 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
75 struct drm_atomic_state *old_state);
76
77 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
78 struct drm_atomic_state *state);
79 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
80 struct drm_atomic_state *old_state);
81
82 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
83 struct drm_atomic_state *state);
84
85 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
86 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
87
88 void drm_atomic_helper_commit_planes(struct drm_device *dev,
89 struct drm_atomic_state *state,
90 uint32_t flags);
91 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
92 struct drm_atomic_state *old_state);
93 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
94 void
95 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
96 bool atomic);
97
98 int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
99 bool stall);
100
101 /* nonblocking commit helpers */
102 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
103 bool nonblock);
104 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
105 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
106 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
107 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
108
109 /* implementations for legacy interfaces */
110 int drm_atomic_helper_update_plane(struct drm_plane *plane,
111 struct drm_crtc *crtc,
112 struct drm_framebuffer *fb,
113 int crtc_x, int crtc_y,
114 unsigned int crtc_w, unsigned int crtc_h,
115 uint32_t src_x, uint32_t src_y,
116 uint32_t src_w, uint32_t src_h,
117 struct drm_modeset_acquire_ctx *ctx);
118 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
119 struct drm_modeset_acquire_ctx *ctx);
120 int drm_atomic_helper_set_config(struct drm_mode_set *set,
121 struct drm_modeset_acquire_ctx *ctx);
122
123 int drm_atomic_helper_disable_all(struct drm_device *dev,
124 struct drm_modeset_acquire_ctx *ctx);
125 void drm_atomic_helper_shutdown(struct drm_device *dev);
126 struct drm_atomic_state *
127 drm_atomic_helper_duplicate_state(struct drm_device *dev,
128 struct drm_modeset_acquire_ctx *ctx);
129 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
130 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
131 struct drm_modeset_acquire_ctx *ctx);
132 int drm_atomic_helper_resume(struct drm_device *dev,
133 struct drm_atomic_state *state);
134
135 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
136 struct drm_framebuffer *fb,
137 struct drm_pending_vblank_event *event,
138 uint32_t flags,
139 struct drm_modeset_acquire_ctx *ctx);
140 int drm_atomic_helper_page_flip_target(
141 struct drm_crtc *crtc,
142 struct drm_framebuffer *fb,
143 struct drm_pending_vblank_event *event,
144 uint32_t flags,
145 uint32_t target,
146 struct drm_modeset_acquire_ctx *ctx);
147 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
148 u16 *red, u16 *green, u16 *blue,
149 uint32_t size,
150 struct drm_modeset_acquire_ctx *ctx);
151
152 /**
153 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
154 * @plane: the loop cursor
155 * @crtc: the crtc whose planes are iterated
156 *
157 * This iterates over the current state, useful (for example) when applying
158 * atomic state after it has been checked and swapped. To iterate over the
159 * planes which *will* be attached (more useful in code called from
160 * &drm_mode_config_funcs.atomic_check) see
161 * drm_atomic_crtc_state_for_each_plane().
162 */
163 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
164 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
165
166 /**
167 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
168 * @plane: the loop cursor
169 * @crtc_state: the incoming crtc-state
170 *
171 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
172 * attached if the specified state is applied. Useful during for example
173 * in code called from &drm_mode_config_funcs.atomic_check operations, to
174 * validate the incoming state.
175 */
176 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
177 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
178
179 /**
180 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
181 * @plane: the loop cursor
182 * @plane_state: loop cursor for the plane's state, must be const
183 * @crtc_state: the incoming crtc-state
184 *
185 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
186 * attached if the specified state is applied. Useful during for example
187 * in code called from &drm_mode_config_funcs.atomic_check operations, to
188 * validate the incoming state.
189 *
190 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
191 * const plane_state. This is useful when a driver just wants to peek at other
192 * active planes on this crtc, but does not need to change it.
193 */
194 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
195 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
196 for_each_if ((plane_state = \
197 __drm_atomic_get_current_plane_state((crtc_state)->state, \
198 plane)))
199
200 /**
201 * drm_atomic_plane_disabling - check whether a plane is being disabled
202 * @old_plane_state: old atomic plane state
203 * @new_plane_state: new atomic plane state
204 *
205 * Checks the atomic state of a plane to determine whether it's being disabled
206 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
207 * need to either both be NULL or both be non-NULL).
208 *
209 * RETURNS:
210 * True if the plane is being disabled, false otherwise.
211 */
212 static inline bool
drm_atomic_plane_disabling(struct drm_plane_state * old_plane_state,struct drm_plane_state * new_plane_state)213 drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
214 struct drm_plane_state *new_plane_state)
215 {
216 /*
217 * When disabling a plane, CRTC and FB should always be NULL together.
218 * Anything else should be considered a bug in the atomic core, so we
219 * gently warn about it.
220 */
221 WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
222 (new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
223
224 return old_plane_state->crtc && !new_plane_state->crtc;
225 }
226
227 #endif /* DRM_ATOMIC_HELPER_H_ */
228