blob: d473dcc91f540878687d9c0c5fdf25bf56afe5a4 [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>
32
Rob Clarkbbb1e522015-08-25 15:35:58 -040033struct drm_atomic_state;
34
Daniel Vetterd9b13622014-11-26 16:57:41 +010035int 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);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010039int drm_atomic_helper_check(struct drm_device *dev,
40 struct drm_atomic_state *state);
Daniel Vetter623369e2014-09-16 17:50:47 +020041int drm_atomic_helper_commit(struct drm_device *dev,
42 struct drm_atomic_state *state,
Maarten Lankhorst286dbb82016-04-26 16:11:34 +020043 bool nonblock);
Daniel Vetter623369e2014-09-16 17:50:47 +020044
Rob Clark4c5b7f32016-03-18 19:14:55 -040045void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
46 struct drm_atomic_state *state);
John Keepingc2409062016-01-19 10:46:58 +000047bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
48 struct drm_atomic_state *old_state,
49 struct drm_crtc *crtc);
50
Rob Clark5ee32292014-11-11 19:38:59 -050051void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
52 struct drm_atomic_state *old_state);
53
Daniel Vetter4c18d302015-05-12 15:27:37 +020054void
55drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
56 struct drm_atomic_state *old_state);
57
Daniel Vetter1af434a2015-02-22 12:24:19 +010058void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
59 struct drm_atomic_state *state);
60void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
Daniel Vetter623369e2014-09-16 17:50:47 +020061 struct drm_atomic_state *old_state);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010062
63int drm_atomic_helper_prepare_planes(struct drm_device *dev,
64 struct drm_atomic_state *state);
65void drm_atomic_helper_commit_planes(struct drm_device *dev,
Daniel Vetteraef9dbb2015-09-08 12:02:07 +020066 struct drm_atomic_state *state,
67 bool active_only);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010068void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
69 struct drm_atomic_state *old_state);
Maarten Lankhorstde28d022015-05-19 16:41:01 +020070void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
Jyri Sarha6753ba92015-11-27 16:14:01 +020071void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
72 bool atomic);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010073
74void drm_atomic_helper_swap_state(struct drm_device *dev,
75 struct drm_atomic_state *state);
76
Daniel Vetter042652e2014-07-27 13:46:52 +020077/* implementations for legacy interfaces */
78int drm_atomic_helper_update_plane(struct drm_plane *plane,
79 struct drm_crtc *crtc,
80 struct drm_framebuffer *fb,
81 int crtc_x, int crtc_y,
82 unsigned int crtc_w, unsigned int crtc_h,
83 uint32_t src_x, uint32_t src_y,
84 uint32_t src_w, uint32_t src_h);
85int drm_atomic_helper_disable_plane(struct drm_plane *plane);
Rob Clarkbbb1e522015-08-25 15:35:58 -040086int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
87 struct drm_plane_state *plane_state);
Daniel Vetter042652e2014-07-27 13:46:52 +020088int drm_atomic_helper_set_config(struct drm_mode_set *set);
Rob Clarkbbb1e522015-08-25 15:35:58 -040089int __drm_atomic_helper_set_config(struct drm_mode_set *set,
90 struct drm_atomic_state *state);
Daniel Vetter042652e2014-07-27 13:46:52 +020091
Thierry Reding14942762015-12-02 17:50:04 +010092int drm_atomic_helper_disable_all(struct drm_device *dev,
93 struct drm_modeset_acquire_ctx *ctx);
94struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
95int drm_atomic_helper_resume(struct drm_device *dev,
96 struct drm_atomic_state *state);
97
Daniel Vetter042652e2014-07-27 13:46:52 +020098int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
99 struct drm_property *property,
100 uint64_t val);
101int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
102 struct drm_property *property,
103 uint64_t val);
104int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
105 struct drm_property *property,
106 uint64_t val);
Daniel Vetter8bc0f312014-07-27 18:42:37 +0200107int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
108 struct drm_framebuffer *fb,
109 struct drm_pending_vblank_event *event,
110 uint32_t flags);
Maarten Lankhorst9a69a9a2015-07-21 11:34:55 +0200111int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
112 int mode);
Noralf Trønnes9ecb5492016-05-11 18:09:21 +0200113struct drm_encoder *
114drm_atomic_helper_best_encoder(struct drm_connector *connector);
Daniel Vetter8bc0f312014-07-27 18:42:37 +0200115
Daniel Vetterd4617012014-11-03 15:56:43 +0100116/* default implementations for state handling */
117void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
Thierry Redingf5e78402015-01-28 14:54:32 +0100118void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
119 struct drm_crtc_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100120struct drm_crtc_state *
121drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
Daniel Vetterec2dc6a2016-05-09 16:34:09 +0200122void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100123void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
124 struct drm_crtc_state *state);
125
126void drm_atomic_helper_plane_reset(struct drm_plane *plane);
Thierry Redingf5e78402015-01-28 14:54:32 +0100127void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
128 struct drm_plane_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100129struct drm_plane_state *
130drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
Daniel Vetter2f701692016-05-09 16:34:10 +0200131void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100132void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
133 struct drm_plane_state *state);
134
Maarten Lankhorst4cd39912016-01-04 12:53:16 +0100135void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
136 struct drm_connector_state *conn_state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100137void drm_atomic_helper_connector_reset(struct drm_connector *connector);
Thierry Redingf5e78402015-01-28 14:54:32 +0100138void
139__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
140 struct drm_connector_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100141struct drm_connector_state *
142drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
Thierry Reding397fd772015-09-08 15:00:45 +0200143struct drm_atomic_state *
144drm_atomic_helper_duplicate_state(struct drm_device *dev,
145 struct drm_modeset_acquire_ctx *ctx);
Thierry Redingf5e78402015-01-28 14:54:32 +0100146void
Daniel Vetterfabd9102016-05-09 16:34:11 +0200147__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
Daniel Vetterd4617012014-11-03 15:56:43 +0100148void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
149 struct drm_connector_state *state);
Lionel Landwerlin5488dc12016-02-26 17:05:00 +0000150void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
151 u16 *red, u16 *green, u16 *blue,
152 uint32_t start, uint32_t size);
Daniel Vetterd4617012014-11-03 15:56:43 +0100153
Rob Clarkdd275952014-11-25 20:29:46 -0500154/**
155 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
156 * @plane: the loop cursor
157 * @crtc: the crtc whose planes are iterated
158 *
159 * This iterates over the current state, useful (for example) when applying
160 * atomic state after it has been checked and swapped. To iterate over the
161 * planes which *will* be attached (for ->atomic_check()) see
162 * drm_crtc_for_each_pending_plane()
163 */
164#define drm_atomic_crtc_for_each_plane(plane, crtc) \
165 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
166
167/**
168 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
169 * @plane: the loop cursor
170 * @crtc_state: the incoming crtc-state
171 *
172 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
173 * attached if the specified state is applied. Useful during (for example)
174 * ->atomic_check() operations, to validate the incoming state
175 */
176#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
177 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
Daniel Vetter042652e2014-07-27 13:46:52 +0200178
Thierry Reding407b8bd2014-11-20 12:05:50 +0100179/*
180 * drm_atomic_plane_disabling - check whether a plane is being disabled
181 * @plane: plane object
182 * @old_state: previous atomic state
183 *
184 * Checks the atomic state of a plane to determine whether it's being disabled
185 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
186 * need to either both be NULL or both be non-NULL).
187 *
188 * RETURNS:
189 * True if the plane is being disabled, false otherwise.
190 */
191static inline bool
192drm_atomic_plane_disabling(struct drm_plane *plane,
193 struct drm_plane_state *old_state)
194{
195 /*
196 * When disabling a plane, CRTC and FB should always be NULL together.
197 * Anything else should be considered a bug in the atomic core, so we
198 * gently warn about it.
199 */
200 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
201 (plane->state->crtc != NULL && plane->state->fb == NULL));
202
203 /*
204 * When using the transitional helpers, old_state may be NULL. If so,
205 * we know nothing about the current state and have to assume that it
206 * might be enabled.
207 *
208 * When using the atomic helpers, old_state won't be NULL. Therefore
209 * this check assumes that either the driver will have reconstructed
210 * the correct state in ->reset() or that the driver will have taken
211 * appropriate measures to disable all planes.
212 */
213 return (!old_state || old_state->crtc) && !plane->state->crtc;
214}
215
Daniel Vetterc2fcd272014-11-05 00:14:14 +0100216#endif /* DRM_ATOMIC_HELPER_H_ */