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>
33 struct drm_atomic_state;
35 int drm_atomic_helper_check_modeset(struct drm_device *dev,
36 struct drm_atomic_state *state);
37 int drm_atomic_helper_check_planes(struct drm_device *dev,
38 struct drm_atomic_state *state);
39 int drm_atomic_helper_check(struct drm_device *dev,
40 struct drm_atomic_state *state);
41 int drm_atomic_helper_commit(struct drm_device *dev,
42 struct drm_atomic_state *state,
45 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
46 struct drm_atomic_state *old_state,
47 struct drm_crtc *crtc);
49 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
50 struct drm_atomic_state *old_state);
53 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
54 struct drm_atomic_state *old_state);
56 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
57 struct drm_atomic_state *state);
58 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
59 struct drm_atomic_state *old_state);
61 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
62 struct drm_atomic_state *state);
63 void drm_atomic_helper_commit_planes(struct drm_device *dev,
64 struct drm_atomic_state *state,
66 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
67 struct drm_atomic_state *old_state);
68 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
70 void drm_atomic_helper_swap_state(struct drm_device *dev,
71 struct drm_atomic_state *state);
73 /* implementations for legacy interfaces */
74 int drm_atomic_helper_update_plane(struct drm_plane *plane,
75 struct drm_crtc *crtc,
76 struct drm_framebuffer *fb,
77 int crtc_x, int crtc_y,
78 unsigned int crtc_w, unsigned int crtc_h,
79 uint32_t src_x, uint32_t src_y,
80 uint32_t src_w, uint32_t src_h);
81 int drm_atomic_helper_disable_plane(struct drm_plane *plane);
82 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
83 struct drm_plane_state *plane_state);
84 int drm_atomic_helper_set_config(struct drm_mode_set *set);
85 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
86 struct drm_atomic_state *state);
88 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
89 struct drm_property *property,
91 int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
92 struct drm_property *property,
94 int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
95 struct drm_property *property,
97 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
98 struct drm_framebuffer *fb,
99 struct drm_pending_vblank_event *event,
101 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
104 /* default implementations for state handling */
105 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
106 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
107 struct drm_crtc_state *state);
108 struct drm_crtc_state *
109 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
110 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
111 struct drm_crtc_state *state);
112 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
113 struct drm_crtc_state *state);
115 void drm_atomic_helper_plane_reset(struct drm_plane *plane);
116 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
117 struct drm_plane_state *state);
118 struct drm_plane_state *
119 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
120 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
121 struct drm_plane_state *state);
122 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
123 struct drm_plane_state *state);
125 void drm_atomic_helper_connector_reset(struct drm_connector *connector);
127 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
128 struct drm_connector_state *state);
129 struct drm_connector_state *
130 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
131 struct drm_atomic_state *
132 drm_atomic_helper_duplicate_state(struct drm_device *dev,
133 struct drm_modeset_acquire_ctx *ctx);
135 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
136 struct drm_connector_state *state);
137 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
138 struct drm_connector_state *state);
141 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
142 * @plane: the loop cursor
143 * @crtc: the crtc whose planes are iterated
145 * This iterates over the current state, useful (for example) when applying
146 * atomic state after it has been checked and swapped. To iterate over the
147 * planes which *will* be attached (for ->atomic_check()) see
148 * drm_crtc_for_each_pending_plane()
150 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
151 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
154 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
155 * @plane: the loop cursor
156 * @crtc_state: the incoming crtc-state
158 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
159 * attached if the specified state is applied. Useful during (for example)
160 * ->atomic_check() operations, to validate the incoming state
162 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
163 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
166 * drm_atomic_plane_disabling - check whether a plane is being disabled
167 * @plane: plane object
168 * @old_state: previous atomic state
170 * Checks the atomic state of a plane to determine whether it's being disabled
171 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
172 * need to either both be NULL or both be non-NULL).
175 * True if the plane is being disabled, false otherwise.
178 drm_atomic_plane_disabling(struct drm_plane *plane,
179 struct drm_plane_state *old_state)
182 * When disabling a plane, CRTC and FB should always be NULL together.
183 * Anything else should be considered a bug in the atomic core, so we
184 * gently warn about it.
186 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
187 (plane->state->crtc != NULL && plane->state->fb == NULL));
190 * When using the transitional helpers, old_state may be NULL. If so,
191 * we know nothing about the current state and have to assume that it
194 * When using the atomic helpers, old_state won't be NULL. Therefore
195 * this check assumes that either the driver will have reconstructed
196 * the correct state in ->reset() or that the driver will have taken
197 * appropriate measures to disable all planes.
199 return (!old_state || old_state->crtc) && !plane->state->crtc;
202 #endif /* DRM_ATOMIC_HELPER_H_ */