2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
28 #ifndef DRM_ATOMIC_HELPER_H_
29 #define DRM_ATOMIC_HELPER_H_
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_modeset_helper_vtables.h>
33 #include <drm/drm_modeset_helper.h>
35 struct drm_atomic_state;
37 int drm_atomic_helper_check_modeset(struct drm_device *dev,
38 struct drm_atomic_state *state);
39 int drm_atomic_helper_check_planes(struct drm_device *dev,
40 struct drm_atomic_state *state);
41 int drm_atomic_helper_check(struct drm_device *dev,
42 struct drm_atomic_state *state);
43 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
44 int drm_atomic_helper_commit(struct drm_device *dev,
45 struct drm_atomic_state *state,
48 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
49 struct drm_atomic_state *state);
50 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
51 struct drm_atomic_state *old_state,
52 struct drm_crtc *crtc);
54 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
55 struct drm_atomic_state *old_state);
58 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
59 struct drm_atomic_state *old_state);
61 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
62 struct drm_atomic_state *state);
63 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
64 struct drm_atomic_state *old_state);
66 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
67 struct drm_atomic_state *state);
69 #define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
70 #define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
72 void drm_atomic_helper_commit_planes(struct drm_device *dev,
73 struct drm_atomic_state *state,
75 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
76 struct drm_atomic_state *old_state);
77 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
79 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
82 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
85 /* nonblocking commit helpers */
86 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
88 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
89 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
90 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
92 /* implementations for legacy interfaces */
93 int drm_atomic_helper_update_plane(struct drm_plane *plane,
94 struct drm_crtc *crtc,
95 struct drm_framebuffer *fb,
96 int crtc_x, int crtc_y,
97 unsigned int crtc_w, unsigned int crtc_h,
98 uint32_t src_x, uint32_t src_y,
99 uint32_t src_w, uint32_t src_h);
100 int drm_atomic_helper_disable_plane(struct drm_plane *plane);
101 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
102 struct drm_plane_state *plane_state);
103 int drm_atomic_helper_set_config(struct drm_mode_set *set);
104 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
105 struct drm_atomic_state *state);
107 int drm_atomic_helper_disable_all(struct drm_device *dev,
108 struct drm_modeset_acquire_ctx *ctx);
109 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
110 int drm_atomic_helper_resume(struct drm_device *dev,
111 struct drm_atomic_state *state);
113 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
114 struct drm_property *property,
116 int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
117 struct drm_property *property,
119 int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
120 struct drm_property *property,
122 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
123 struct drm_framebuffer *fb,
124 struct drm_pending_vblank_event *event,
126 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
129 drm_atomic_helper_best_encoder(struct drm_connector *connector);
131 /* default implementations for state handling */
132 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
133 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
134 struct drm_crtc_state *state);
135 struct drm_crtc_state *
136 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
137 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
138 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
139 struct drm_crtc_state *state);
141 void drm_atomic_helper_plane_reset(struct drm_plane *plane);
142 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
143 struct drm_plane_state *state);
144 struct drm_plane_state *
145 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
146 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
147 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
148 struct drm_plane_state *state);
150 void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
151 struct drm_connector_state *conn_state);
152 void drm_atomic_helper_connector_reset(struct drm_connector *connector);
154 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
155 struct drm_connector_state *state);
156 struct drm_connector_state *
157 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
158 struct drm_atomic_state *
159 drm_atomic_helper_duplicate_state(struct drm_device *dev,
160 struct drm_modeset_acquire_ctx *ctx);
162 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
163 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
164 struct drm_connector_state *state);
165 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
166 u16 *red, u16 *green, u16 *blue,
170 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
171 * @plane: the loop cursor
172 * @crtc: the crtc whose planes are iterated
174 * This iterates over the current state, useful (for example) when applying
175 * atomic state after it has been checked and swapped. To iterate over the
176 * planes which *will* be attached (for ->atomic_check()) see
177 * drm_atomic_crtc_state_for_each_plane().
179 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
180 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
183 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
184 * @plane: the loop cursor
185 * @crtc_state: the incoming crtc-state
187 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
188 * attached if the specified state is applied. Useful during (for example)
189 * ->atomic_check() operations, to validate the incoming state.
191 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
192 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
195 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
196 * @plane: the loop cursor
197 * @plane_state: loop cursor for the plane's state, must be const
198 * @crtc_state: the incoming crtc-state
200 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
201 * attached if the specified state is applied. Useful during (for example)
202 * ->atomic_check() operations, to validate the incoming state.
204 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
205 * const plane_state. This is useful when a driver just wants to peek at other
206 * active planes on this crtc, but does not need to change it.
208 #define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
209 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
210 for_each_if ((plane_state = \
211 __drm_atomic_get_current_plane_state((crtc_state)->state, \
215 * drm_atomic_plane_disabling - check whether a plane is being disabled
216 * @plane: plane object
217 * @old_state: previous atomic state
219 * Checks the atomic state of a plane to determine whether it's being disabled
220 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
221 * need to either both be NULL or both be non-NULL).
224 * True if the plane is being disabled, false otherwise.
227 drm_atomic_plane_disabling(struct drm_plane *plane,
228 struct drm_plane_state *old_state)
231 * When disabling a plane, CRTC and FB should always be NULL together.
232 * Anything else should be considered a bug in the atomic core, so we
233 * gently warn about it.
235 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
236 (plane->state->crtc != NULL && plane->state->fb == NULL));
239 * When using the transitional helpers, old_state may be NULL. If so,
240 * we know nothing about the current state and have to assume that it
243 * When using the atomic helpers, old_state won't be NULL. Therefore
244 * this check assumes that either the driver will have reconstructed
245 * the correct state in ->reset() or that the driver will have taken
246 * appropriate measures to disable all planes.
248 return (!old_state || old_state->crtc) && !plane->state->crtc;
251 #endif /* DRM_ATOMIC_HELPER_H_ */