]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/drm/drm_atomic_helper.h
drm/atomic-helper: Add NO_DISABLE_AFTER_MODESET flag support for plane commit
[mirror_ubuntu-bionic-kernel.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 31#include <drm/drm_crtc.h>
1de72faf
DV
32#include <drm/drm_modeset_helper_vtables.h>
33#include <drm/drm_modeset_helper.h>
0254951d 34
bbb1e524
RC
35struct drm_atomic_state;
36
d9b13620
DV
37int drm_atomic_helper_check_modeset(struct drm_device *dev,
38 struct drm_atomic_state *state);
39int drm_atomic_helper_check_planes(struct drm_device *dev,
40 struct drm_atomic_state *state);
c2fcd274
DV
41int drm_atomic_helper_check(struct drm_device *dev,
42 struct drm_atomic_state *state);
9f2a7950 43void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
623369e5
DV
44int drm_atomic_helper_commit(struct drm_device *dev,
45 struct drm_atomic_state *state,
286dbb8d 46 bool nonblock);
623369e5 47
4c5b7f3a
RC
48void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
49 struct drm_atomic_state *state);
c240906d
JK
50bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
51 struct drm_atomic_state *old_state,
52 struct drm_crtc *crtc);
53
5ee3229c
RC
54void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
55 struct drm_atomic_state *old_state);
56
4c18d301
DV
57void
58drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
59 struct drm_atomic_state *old_state);
60
1af434a9
DV
61void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
62 struct drm_atomic_state *state);
63void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
623369e5 64 struct drm_atomic_state *old_state);
c2fcd274
DV
65
66int drm_atomic_helper_prepare_planes(struct drm_device *dev,
67 struct drm_atomic_state *state);
2b58e98d
LY
68
69#define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
70#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
71
c2fcd274 72void drm_atomic_helper_commit_planes(struct drm_device *dev,
aef9dbb8 73 struct drm_atomic_state *state,
2b58e98d 74 uint32_t flags);
c2fcd274
DV
75void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
76 struct drm_atomic_state *old_state);
de28d021 77void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
28500291
LY
78void
79drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
80 bool atomic);
c2fcd274 81
5e84c269
DV
82void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
83 bool stall);
c2fcd274 84
a095caa7
DV
85/* nonblocking commit helpers */
86int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
87 bool nonblock);
88void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
89void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
90void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
91
042652ed
DV
92/* implementations for legacy interfaces */
93int 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);
100int drm_atomic_helper_disable_plane(struct drm_plane *plane);
bbb1e524
RC
101int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
102 struct drm_plane_state *plane_state);
042652ed 103int drm_atomic_helper_set_config(struct drm_mode_set *set);
bbb1e524
RC
104int __drm_atomic_helper_set_config(struct drm_mode_set *set,
105 struct drm_atomic_state *state);
042652ed 106
14942760
TR
107int drm_atomic_helper_disable_all(struct drm_device *dev,
108 struct drm_modeset_acquire_ctx *ctx);
109struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
110int drm_atomic_helper_resume(struct drm_device *dev,
111 struct drm_atomic_state *state);
112
042652ed
DV
113int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
114 struct drm_property *property,
115 uint64_t val);
116int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
117 struct drm_property *property,
118 uint64_t val);
119int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
120 struct drm_property *property,
121 uint64_t val);
8bc0f312
DV
122int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
123 struct drm_framebuffer *fb,
124 struct drm_pending_vblank_event *event,
125 uint32_t flags);
9a69a9ac
ML
126int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
127 int mode);
9ecb5498
NT
128struct drm_encoder *
129drm_atomic_helper_best_encoder(struct drm_connector *connector);
8bc0f312 130
d461701c
DV
131/* default implementations for state handling */
132void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
f5e7840b
TR
133void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
134 struct drm_crtc_state *state);
d461701c
DV
135struct drm_crtc_state *
136drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
ec2dc6a0 137void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
d461701c
DV
138void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
139 struct drm_crtc_state *state);
140
141void drm_atomic_helper_plane_reset(struct drm_plane *plane);
f5e7840b
TR
142void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
143 struct drm_plane_state *state);
d461701c
DV
144struct drm_plane_state *
145drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
2f701695 146void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
d461701c
DV
147void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
148 struct drm_plane_state *state);
149
4cd39917
ML
150void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
151 struct drm_connector_state *conn_state);
d461701c 152void drm_atomic_helper_connector_reset(struct drm_connector *connector);
f5e7840b
TR
153void
154__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
155 struct drm_connector_state *state);
d461701c
DV
156struct drm_connector_state *
157drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
397fd77c
TR
158struct drm_atomic_state *
159drm_atomic_helper_duplicate_state(struct drm_device *dev,
160 struct drm_modeset_acquire_ctx *ctx);
f5e7840b 161void
fabd9106 162__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
d461701c
DV
163void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
164 struct drm_connector_state *state);
7ea77283
ML
165int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
166 u16 *red, u16 *green, u16 *blue,
167 uint32_t size);
d461701c 168
dd275956
RC
169/**
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
173 *
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
5c0be3f1 177 * drm_atomic_crtc_state_for_each_plane().
dd275956
RC
178 */
179#define drm_atomic_crtc_for_each_plane(plane, crtc) \
180 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
181
182/**
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
186 *
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)
2f196b7c 189 * ->atomic_check() operations, to validate the incoming state.
dd275956
RC
190 */
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)
042652ed 193
2f196b7c
DV
194/**
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
199 *
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.
203 *
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.
207 */
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, \
212 plane)))
213
407b8bd9
TR
214/*
215 * drm_atomic_plane_disabling - check whether a plane is being disabled
216 * @plane: plane object
217 * @old_state: previous atomic state
218 *
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).
222 *
223 * RETURNS:
224 * True if the plane is being disabled, false otherwise.
225 */
226static inline bool
227drm_atomic_plane_disabling(struct drm_plane *plane,
228 struct drm_plane_state *old_state)
229{
230 /*
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.
234 */
235 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
236 (plane->state->crtc != NULL && plane->state->fb == NULL));
237
238 /*
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
241 * might be enabled.
242 *
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.
247 */
248 return (!old_state || old_state->crtc) && !plane->state->crtc;
249}
250
c2fcd274 251#endif /* DRM_ATOMIC_HELPER_H_ */