blob: 4842ee9485ceccad21d980ae8eb006e1507179f9 [file] [log] [blame]
Daniel Vetterc2fcd272014-11-05 00:14:14 +01001/*
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
Thierry Reding02549512014-11-25 12:09:47 +010031#include <drm/drm_crtc.h>
Daniel Vetter1de72fa2016-08-12 22:48:39 +020032#include <drm/drm_modeset_helper_vtables.h>
33#include <drm/drm_modeset_helper.h>
Thierry Reding02549512014-11-25 12:09:47 +010034
Rob Clarkbbb1e522015-08-25 15:35:58 -040035struct drm_atomic_state;
Ville Syrjäläa4370c72017-07-12 18:51:02 +030036struct drm_private_obj;
37struct drm_private_state;
Rob Clarkbbb1e522015-08-25 15:35:58 -040038
Daniel Vetterd9b13622014-11-26 16:57:41 +010039int drm_atomic_helper_check_modeset(struct drm_device *dev,
40 struct drm_atomic_state *state);
Ville Syrjäläa01cb8b2017-11-01 22:16:19 +020041int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
42 const struct drm_crtc_state *crtc_state,
43 const struct drm_rect *clip,
44 int min_scale,
45 int max_scale,
46 bool can_position,
47 bool can_update_disabled);
Daniel Vetterd9b13622014-11-26 16:57:41 +010048int drm_atomic_helper_check_planes(struct drm_device *dev,
49 struct drm_atomic_state *state);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010050int drm_atomic_helper_check(struct drm_device *dev,
51 struct drm_atomic_state *state);
Daniel Vetter9f2a7952016-06-08 14:19:02 +020052void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
Maxime Ripard81a099a2017-07-20 15:01:16 +020053void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
Daniel Vetter623369e2014-09-16 17:50:47 +020054int drm_atomic_helper_commit(struct drm_device *dev,
55 struct drm_atomic_state *state,
Maarten Lankhorst286dbb82016-04-26 16:11:34 +020056 bool nonblock);
Gustavo Padovanfef9df82017-06-30 15:03:17 -030057int drm_atomic_helper_async_check(struct drm_device *dev,
58 struct drm_atomic_state *state);
59void drm_atomic_helper_async_commit(struct drm_device *dev,
60 struct drm_atomic_state *state);
Daniel Vetter623369e2014-09-16 17:50:47 +020061
Gustavo Padovanf6ce4102016-09-12 16:08:11 -030062int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
63 struct drm_atomic_state *state,
64 bool pre_swap);
John Keepingc2409062016-01-19 10:46:58 +000065
Rob Clark5ee32292014-11-11 19:38:59 -050066void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
67 struct drm_atomic_state *old_state);
68
Boris Brezillon01086482017-06-02 10:32:06 +020069void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
70 struct drm_atomic_state *old_state);
71
Daniel Vetter4c18d302015-05-12 15:27:37 +020072void
73drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
74 struct drm_atomic_state *old_state);
75
Daniel Vetter1af434a2015-02-22 12:24:19 +010076void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
77 struct drm_atomic_state *state);
78void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
Daniel Vetter623369e2014-09-16 17:50:47 +020079 struct drm_atomic_state *old_state);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010080
81int drm_atomic_helper_prepare_planes(struct drm_device *dev,
82 struct drm_atomic_state *state);
Liu Ying2b58e982016-08-29 17:12:03 +080083
84#define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)
85#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)
86
Daniel Vetterc2fcd272014-11-05 00:14:14 +010087void drm_atomic_helper_commit_planes(struct drm_device *dev,
Daniel Vetteraef9dbb2015-09-08 12:02:07 +020088 struct drm_atomic_state *state,
Liu Ying2b58e982016-08-29 17:12:03 +080089 uint32_t flags);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010090void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
91 struct drm_atomic_state *old_state);
Maarten Lankhorstde28d022015-05-19 16:41:01 +020092void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
Liu Ying28500292016-08-26 15:30:39 +080093void
94drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
95 bool atomic);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010096
Maarten Lankhorst8a393742017-07-11 16:33:13 +020097int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
98 bool stall);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010099
Daniel Vettera095caa2016-06-08 17:15:36 +0200100/* nonblocking commit helpers */
101int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
102 bool nonblock);
103void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
104void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
105void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
106
Daniel Vetter042652e2014-07-27 13:46:52 +0200107/* implementations for legacy interfaces */
108int drm_atomic_helper_update_plane(struct drm_plane *plane,
109 struct drm_crtc *crtc,
110 struct drm_framebuffer *fb,
111 int crtc_x, int crtc_y,
112 unsigned int crtc_w, unsigned int crtc_h,
113 uint32_t src_x, uint32_t src_y,
Daniel Vetter34a2ab52017-03-22 22:50:41 +0100114 uint32_t src_w, uint32_t src_h,
115 struct drm_modeset_acquire_ctx *ctx);
Daniel Vetter19315292017-03-22 22:50:43 +0100116int drm_atomic_helper_disable_plane(struct drm_plane *plane,
117 struct drm_modeset_acquire_ctx *ctx);
Rob Clarkbbb1e522015-08-25 15:35:58 -0400118int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
119 struct drm_plane_state *plane_state);
Daniel Vettera4eff9a2017-03-22 22:50:57 +0100120int drm_atomic_helper_set_config(struct drm_mode_set *set,
121 struct drm_modeset_acquire_ctx *ctx);
Rob Clarkbbb1e522015-08-25 15:35:58 -0400122int __drm_atomic_helper_set_config(struct drm_mode_set *set,
123 struct drm_atomic_state *state);
Daniel Vetter042652e2014-07-27 13:46:52 +0200124
Thierry Reding14942762015-12-02 17:50:04 +0100125int drm_atomic_helper_disable_all(struct drm_device *dev,
126 struct drm_modeset_acquire_ctx *ctx);
Daniel Vetter18dddad2017-03-21 17:41:49 +0100127void drm_atomic_helper_shutdown(struct drm_device *dev);
Thierry Reding14942762015-12-02 17:50:04 +0100128struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
Maarten Lankhorst581e49f2017-01-16 10:37:38 +0100129int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
130 struct drm_modeset_acquire_ctx *ctx);
Thierry Reding14942762015-12-02 17:50:04 +0100131int drm_atomic_helper_resume(struct drm_device *dev,
132 struct drm_atomic_state *state);
133
Daniel Vetter8bc0f312014-07-27 18:42:37 +0200134int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
135 struct drm_framebuffer *fb,
136 struct drm_pending_vblank_event *event,
Daniel Vetter41292b1f2017-03-22 22:50:50 +0100137 uint32_t flags,
138 struct drm_modeset_acquire_ctx *ctx);
Andrey Grodzovskyf869a6e2017-01-06 15:39:40 -0500139int drm_atomic_helper_page_flip_target(
140 struct drm_crtc *crtc,
141 struct drm_framebuffer *fb,
142 struct drm_pending_vblank_event *event,
143 uint32_t flags,
Daniel Vetter41292b1f2017-03-22 22:50:50 +0100144 uint32_t target,
145 struct drm_modeset_acquire_ctx *ctx);
Noralf Trønnes9ecb5492016-05-11 18:09:21 +0200146struct drm_encoder *
147drm_atomic_helper_best_encoder(struct drm_connector *connector);
Daniel Vetter8bc0f312014-07-27 18:42:37 +0200148
Daniel Vetterd4617012014-11-03 15:56:43 +0100149/* default implementations for state handling */
150void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
Thierry Redingf5e78402015-01-28 14:54:32 +0100151void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
152 struct drm_crtc_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100153struct drm_crtc_state *
154drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
Daniel Vetterec2dc6a2016-05-09 16:34:09 +0200155void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100156void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
157 struct drm_crtc_state *state);
158
159void drm_atomic_helper_plane_reset(struct drm_plane *plane);
Thierry Redingf5e78402015-01-28 14:54:32 +0100160void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
161 struct drm_plane_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100162struct drm_plane_state *
163drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
Daniel Vetter2f701692016-05-09 16:34:10 +0200164void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100165void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
166 struct drm_plane_state *state);
167
Maarten Lankhorst4cd39912016-01-04 12:53:16 +0100168void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
169 struct drm_connector_state *conn_state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100170void drm_atomic_helper_connector_reset(struct drm_connector *connector);
Thierry Redingf5e78402015-01-28 14:54:32 +0100171void
172__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
173 struct drm_connector_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100174struct drm_connector_state *
175drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
Thierry Reding397fd772015-09-08 15:00:45 +0200176struct drm_atomic_state *
177drm_atomic_helper_duplicate_state(struct drm_device *dev,
178 struct drm_modeset_acquire_ctx *ctx);
Thierry Redingf5e78402015-01-28 14:54:32 +0100179void
Daniel Vetterfabd9102016-05-09 16:34:11 +0200180__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100181void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
182 struct drm_connector_state *state);
Maarten Lankhorst7ea77282016-06-07 12:49:30 +0200183int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
184 u16 *red, u16 *green, u16 *blue,
Daniel Vetter6d124ff2017-04-03 10:33:01 +0200185 uint32_t size,
186 struct drm_modeset_acquire_ctx *ctx);
Ville Syrjäläa4370c72017-07-12 18:51:02 +0300187void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
188 struct drm_private_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100189
Rob Clarkdd275952014-11-25 20:29:46 -0500190/**
191 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
192 * @plane: the loop cursor
193 * @crtc: the crtc whose planes are iterated
194 *
195 * This iterates over the current state, useful (for example) when applying
196 * atomic state after it has been checked and swapped. To iterate over the
Daniel Vetter6806cdf2017-01-25 07:26:43 +0100197 * planes which *will* be attached (more useful in code called from
198 * &drm_mode_config_funcs.atomic_check) see
Liviu Dudau5c0be3f2016-06-10 16:03:25 +0100199 * drm_atomic_crtc_state_for_each_plane().
Rob Clarkdd275952014-11-25 20:29:46 -0500200 */
201#define drm_atomic_crtc_for_each_plane(plane, crtc) \
202 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
203
204/**
205 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
206 * @plane: the loop cursor
207 * @crtc_state: the incoming crtc-state
208 *
209 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
Daniel Vetter6806cdf2017-01-25 07:26:43 +0100210 * attached if the specified state is applied. Useful during for example
211 * in code called from &drm_mode_config_funcs.atomic_check operations, to
212 * validate the incoming state.
Rob Clarkdd275952014-11-25 20:29:46 -0500213 */
214#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
215 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
Daniel Vetter042652e2014-07-27 13:46:52 +0200216
Daniel Vetter2f196b72016-06-02 16:21:44 +0200217/**
218 * drm_crtc_atomic_state_for_each_plane_state - iterate over attached planes in new state
219 * @plane: the loop cursor
220 * @plane_state: loop cursor for the plane's state, must be const
221 * @crtc_state: the incoming crtc-state
222 *
223 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
Daniel Vetter6806cdf2017-01-25 07:26:43 +0100224 * attached if the specified state is applied. Useful during for example
225 * in code called from &drm_mode_config_funcs.atomic_check operations, to
226 * validate the incoming state.
Daniel Vetter2f196b72016-06-02 16:21:44 +0200227 *
228 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
229 * const plane_state. This is useful when a driver just wants to peek at other
230 * active planes on this crtc, but does not need to change it.
231 */
232#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
233 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
234 for_each_if ((plane_state = \
235 __drm_atomic_get_current_plane_state((crtc_state)->state, \
236 plane)))
237
Maarten Lankhorst51ffa122017-02-16 15:47:07 +0100238/**
Thierry Reding407b8bd2014-11-20 12:05:50 +0100239 * drm_atomic_plane_disabling - check whether a plane is being disabled
Maarten Lankhorst51ffa122017-02-16 15:47:07 +0100240 * @old_plane_state: old atomic plane state
241 * @new_plane_state: new atomic plane state
Thierry Reding407b8bd2014-11-20 12:05:50 +0100242 *
243 * Checks the atomic state of a plane to determine whether it's being disabled
244 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
245 * need to either both be NULL or both be non-NULL).
246 *
247 * RETURNS:
248 * True if the plane is being disabled, false otherwise.
249 */
250static inline bool
Maarten Lankhorst51ffa122017-02-16 15:47:07 +0100251drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
252 struct drm_plane_state *new_plane_state)
Thierry Reding407b8bd2014-11-20 12:05:50 +0100253{
254 /*
255 * When disabling a plane, CRTC and FB should always be NULL together.
256 * Anything else should be considered a bug in the atomic core, so we
257 * gently warn about it.
258 */
Maarten Lankhorst51ffa122017-02-16 15:47:07 +0100259 WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
260 (new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
Thierry Reding407b8bd2014-11-20 12:05:50 +0100261
Maarten Lankhorst51ffa122017-02-16 15:47:07 +0100262 return old_plane_state->crtc && !new_plane_state->crtc;
Thierry Reding407b8bd2014-11-20 12:05:50 +0100263}
264
Daniel Vetterc2fcd272014-11-05 00:14:14 +0100265#endif /* DRM_ATOMIC_HELPER_H_ */