Merge tag 'amlogic-drivers-2' of git://git.kernel.org/pub/scm/linux/kernel/git/khilma...
[linux-2.6-block.git] / include / drm / drm_atomic_helper.h
CommitLineData
c2fcd274
DV
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
0254951d
TR
31#include <drm/drm_crtc.h>
32
bbb1e524
RC
33struct drm_atomic_state;
34
d9b13620
DV
35int drm_atomic_helper_check_modeset(struct drm_device *dev,
36 struct drm_atomic_state *state);
37int drm_atomic_helper_check_planes(struct drm_device *dev,
38 struct drm_atomic_state *state);
c2fcd274
DV
39int drm_atomic_helper_check(struct drm_device *dev,
40 struct drm_atomic_state *state);
9f2a7950 41void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
623369e5
DV
42int drm_atomic_helper_commit(struct drm_device *dev,
43 struct drm_atomic_state *state,
286dbb8d 44 bool nonblock);
623369e5 45
4c5b7f3a
RC
46void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
47 struct drm_atomic_state *state);
c240906d
JK
48bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
49 struct drm_atomic_state *old_state,
50 struct drm_crtc *crtc);
51
5ee3229c
RC
52void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
53 struct drm_atomic_state *old_state);
54
4c18d301
DV
55void
56drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
57 struct drm_atomic_state *old_state);
58
1af434a9
DV
59void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
60 struct drm_atomic_state *state);
61void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
623369e5 62 struct drm_atomic_state *old_state);
c2fcd274
DV
63
64int drm_atomic_helper_prepare_planes(struct drm_device *dev,
65 struct drm_atomic_state *state);
66void drm_atomic_helper_commit_planes(struct drm_device *dev,
aef9dbb8
DV
67 struct drm_atomic_state *state,
68 bool active_only);
c2fcd274
DV
69void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
70 struct drm_atomic_state *old_state);
de28d021 71void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
6753ba97
JS
72void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
73 bool atomic);
c2fcd274 74
5e84c269
DV
75void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
76 bool stall);
c2fcd274 77
a095caa7
DV
78/* nonblocking commit helpers */
79int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
80 bool nonblock);
81void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
82void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
83void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
84
042652ed
DV
85/* implementations for legacy interfaces */
86int drm_atomic_helper_update_plane(struct drm_plane *plane,
87 struct drm_crtc *crtc,
88 struct drm_framebuffer *fb,
89 int crtc_x, int crtc_y,
90 unsigned int crtc_w, unsigned int crtc_h,
91 uint32_t src_x, uint32_t src_y,
92 uint32_t src_w, uint32_t src_h);
93int drm_atomic_helper_disable_plane(struct drm_plane *plane);
bbb1e524
RC
94int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
95 struct drm_plane_state *plane_state);
042652ed 96int drm_atomic_helper_set_config(struct drm_mode_set *set);
bbb1e524
RC
97int __drm_atomic_helper_set_config(struct drm_mode_set *set,
98 struct drm_atomic_state *state);
042652ed 99
14942760
TR
100int drm_atomic_helper_disable_all(struct drm_device *dev,
101 struct drm_modeset_acquire_ctx *ctx);
102struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
103int drm_atomic_helper_resume(struct drm_device *dev,
104 struct drm_atomic_state *state);
105
042652ed
DV
106int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
107 struct drm_property *property,
108 uint64_t val);
109int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
110 struct drm_property *property,
111 uint64_t val);
112int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
113 struct drm_property *property,
114 uint64_t val);
8bc0f312
DV
115int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
116 struct drm_framebuffer *fb,
117 struct drm_pending_vblank_event *event,
118 uint32_t flags);
9a69a9ac
ML
119int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
120 int mode);
9ecb5498
NT
121struct drm_encoder *
122drm_atomic_helper_best_encoder(struct drm_connector *connector);
8bc0f312 123
d461701c
DV
124/* default implementations for state handling */
125void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
f5e7840b
TR
126void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
127 struct drm_crtc_state *state);
d461701c
DV
128struct drm_crtc_state *
129drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
ec2dc6a0 130void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
d461701c
DV
131void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
132 struct drm_crtc_state *state);
133
134void drm_atomic_helper_plane_reset(struct drm_plane *plane);
f5e7840b
TR
135void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
136 struct drm_plane_state *state);
d461701c
DV
137struct drm_plane_state *
138drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
2f701695 139void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
d461701c
DV
140void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
141 struct drm_plane_state *state);
142
4cd39917
ML
143void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
144 struct drm_connector_state *conn_state);
d461701c 145void drm_atomic_helper_connector_reset(struct drm_connector *connector);
f5e7840b
TR
146void
147__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
148 struct drm_connector_state *state);
d461701c
DV
149struct drm_connector_state *
150drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
397fd77c
TR
151struct drm_atomic_state *
152drm_atomic_helper_duplicate_state(struct drm_device *dev,
153 struct drm_modeset_acquire_ctx *ctx);
f5e7840b 154void
fabd9106 155__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
d461701c
DV
156void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
157 struct drm_connector_state *state);
7ea77283
ML
158int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
159 u16 *red, u16 *green, u16 *blue,
160 uint32_t size);
d461701c 161
dd275956
RC
162/**
163 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
164 * @plane: the loop cursor
165 * @crtc: the crtc whose planes are iterated
166 *
167 * This iterates over the current state, useful (for example) when applying
168 * atomic state after it has been checked and swapped. To iterate over the
169 * planes which *will* be attached (for ->atomic_check()) see
5c0be3f1 170 * drm_atomic_crtc_state_for_each_plane().
dd275956
RC
171 */
172#define drm_atomic_crtc_for_each_plane(plane, crtc) \
173 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
174
175/**
176 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
177 * @plane: the loop cursor
178 * @crtc_state: the incoming crtc-state
179 *
180 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
181 * attached if the specified state is applied. Useful during (for example)
2f196b7c 182 * ->atomic_check() operations, to validate the incoming state.
dd275956
RC
183 */
184#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
185 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
042652ed 186
2f196b7c
DV
187/**
188 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
189 * @plane: the loop cursor
190 * @plane_state: loop cursor for the plane's state, must be const
191 * @crtc_state: the incoming crtc-state
192 *
193 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
194 * attached if the specified state is applied. Useful during (for example)
195 * ->atomic_check() operations, to validate the incoming state.
196 *
197 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
198 * const plane_state. This is useful when a driver just wants to peek at other
199 * active planes on this crtc, but does not need to change it.
200 */
201#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
202 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
203 for_each_if ((plane_state = \
204 __drm_atomic_get_current_plane_state((crtc_state)->state, \
205 plane)))
206
407b8bd9
TR
207/*
208 * drm_atomic_plane_disabling - check whether a plane is being disabled
209 * @plane: plane object
210 * @old_state: previous atomic state
211 *
212 * Checks the atomic state of a plane to determine whether it's being disabled
213 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
214 * need to either both be NULL or both be non-NULL).
215 *
216 * RETURNS:
217 * True if the plane is being disabled, false otherwise.
218 */
219static inline bool
220drm_atomic_plane_disabling(struct drm_plane *plane,
221 struct drm_plane_state *old_state)
222{
223 /*
224 * When disabling a plane, CRTC and FB should always be NULL together.
225 * Anything else should be considered a bug in the atomic core, so we
226 * gently warn about it.
227 */
228 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
229 (plane->state->crtc != NULL && plane->state->fb == NULL));
230
231 /*
232 * When using the transitional helpers, old_state may be NULL. If so,
233 * we know nothing about the current state and have to assume that it
234 * might be enabled.
235 *
236 * When using the atomic helpers, old_state won't be NULL. Therefore
237 * this check assumes that either the driver will have reconstructed
238 * the correct state in ->reset() or that the driver will have taken
239 * appropriate measures to disable all planes.
240 */
241 return (!old_state || old_state->crtc) && !plane->state->crtc;
242}
243
c2fcd274 244#endif /* DRM_ATOMIC_HELPER_H_ */