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