drm_atomic_helper.h

  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
 31#include <drm/drm_crtc.h>
 32#include <drm/drm_modeset_helper_vtables.h>
 33#include <drm/drm_modeset_helper.h>
 34#include <drm/drm_atomic_state_helper.h>
 35#include <drm/drm_util.h>
 36
 37/*
 38 * Drivers that don't allow primary plane scaling may pass this macro in place
 39 * of the min/max scale parameters of the plane-state checker function.
 40 *
 41 * Due to src being in 16.16 fixed point and dest being in integer pixels,
 42 * 1<<16 represents no scaling.
 43 */
 44#define DRM_PLANE_NO_SCALING (1<<16)
 45
 46struct drm_atomic_state;
 47struct drm_private_obj;
 48struct drm_private_state;
 49
 50int drm_atomic_helper_check_modeset(struct drm_device *dev,
 51				struct drm_atomic_state *state);
 52int drm_atomic_helper_check_wb_connector_state(struct drm_connector *connector,
 53					       struct drm_atomic_state *state);
 54int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
 55					const struct drm_crtc_state *crtc_state,
 56					int min_scale,
 57					int max_scale,
 58					bool can_position,
 59					bool can_update_disabled);
 60int drm_atomic_helper_check_planes(struct drm_device *dev,
 61			       struct drm_atomic_state *state);
 62int drm_atomic_helper_check_crtc_primary_plane(struct drm_crtc_state *crtc_state);
 63void drm_atomic_helper_commit_encoder_bridge_disable(struct drm_device *dev,
 64						     struct drm_atomic_state *state);
 65void drm_atomic_helper_commit_crtc_disable(struct drm_device *dev,
 66					   struct drm_atomic_state *state);
 67void drm_atomic_helper_commit_encoder_bridge_post_disable(struct drm_device *dev,
 68							  struct drm_atomic_state *state);
 69int drm_atomic_helper_check(struct drm_device *dev,
 70			    struct drm_atomic_state *state);
 71void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
 72void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
 73int drm_atomic_helper_commit(struct drm_device *dev,
 74			     struct drm_atomic_state *state,
 75			     bool nonblock);
 76int drm_atomic_helper_async_check(struct drm_device *dev,
 77				  struct drm_atomic_state *state);
 78void drm_atomic_helper_async_commit(struct drm_device *dev,
 79				    struct drm_atomic_state *state);
 80
 81int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
 82					struct drm_atomic_state *state,
 83					bool pre_swap);
 84
 85void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 86					struct drm_atomic_state *old_state);
 87
 88void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
 89					  struct drm_atomic_state *old_state);
 90
 91void
 92drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
 93					      struct drm_atomic_state *old_state);
 94
 95void
 96drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state);
 97
 98void drm_atomic_helper_commit_crtc_set_mode(struct drm_device *dev,
 99					    struct drm_atomic_state *state);
100
101void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
102					       struct drm_atomic_state *state);
103
104void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
105					 struct drm_atomic_state *state);
106
107void drm_atomic_helper_commit_encoder_bridge_pre_enable(struct drm_device *dev,
108							struct drm_atomic_state *state);
109
110void drm_atomic_helper_commit_crtc_enable(struct drm_device *dev,
111					  struct drm_atomic_state *state);
112
113void drm_atomic_helper_commit_encoder_bridge_enable(struct drm_device *dev,
114						    struct drm_atomic_state *state);
115
116void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
117					  struct drm_atomic_state *old_state);
118
119int drm_atomic_helper_prepare_planes(struct drm_device *dev,
120				     struct drm_atomic_state *state);
121void drm_atomic_helper_unprepare_planes(struct drm_device *dev,
122					struct drm_atomic_state *state);
123
124#define DRM_PLANE_COMMIT_ACTIVE_ONLY			BIT(0)
125#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET	BIT(1)
126
127void drm_atomic_helper_commit_planes(struct drm_device *dev,
128				     struct drm_atomic_state *state,
129				     uint32_t flags);
130void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
131				      struct drm_atomic_state *old_state);
132void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
133void
134drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
135					 bool atomic);
136
137int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
138					      bool stall);
139
140/* nonblocking commit helpers */
141int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
142				   bool nonblock);
143void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
144void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
145void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
146void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
147
148/* implementations for legacy interfaces */
149int drm_atomic_helper_update_plane(struct drm_plane *plane,
150				   struct drm_crtc *crtc,
151				   struct drm_framebuffer *fb,
152				   int crtc_x, int crtc_y,
153				   unsigned int crtc_w, unsigned int crtc_h,
154				   uint32_t src_x, uint32_t src_y,
155				   uint32_t src_w, uint32_t src_h,
156				   struct drm_modeset_acquire_ctx *ctx);
157int drm_atomic_helper_disable_plane(struct drm_plane *plane,
158				    struct drm_modeset_acquire_ctx *ctx);
159int drm_atomic_helper_set_config(struct drm_mode_set *set,
160				 struct drm_modeset_acquire_ctx *ctx);
161
162int drm_atomic_helper_disable_all(struct drm_device *dev,
163				  struct drm_modeset_acquire_ctx *ctx);
164int drm_atomic_helper_reset_crtc(struct drm_crtc *crtc,
165				 struct drm_modeset_acquire_ctx *ctx);
166void drm_atomic_helper_shutdown(struct drm_device *dev);
167struct drm_atomic_state *
168drm_atomic_helper_duplicate_state(struct drm_device *dev,
169				  struct drm_modeset_acquire_ctx *ctx);
170struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
171int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
172					      struct drm_modeset_acquire_ctx *ctx);
173int drm_atomic_helper_resume(struct drm_device *dev,
174			     struct drm_atomic_state *state);
175
176int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
177				struct drm_framebuffer *fb,
178				struct drm_pending_vblank_event *event,
179				uint32_t flags,
180				struct drm_modeset_acquire_ctx *ctx);
181int drm_atomic_helper_page_flip_target(
182				struct drm_crtc *crtc,
183				struct drm_framebuffer *fb,
184				struct drm_pending_vblank_event *event,
185				uint32_t flags,
186				uint32_t target,
187				struct drm_modeset_acquire_ctx *ctx);
188
189/**
190 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
191 * @plane: the loop cursor
192 * @crtc:  the CRTC whose planes are iterated
193 *
194 * This iterates over the current state, useful (for example) when applying
195 * atomic state after it has been checked and swapped.  To iterate over the
196 * planes which *will* be attached (more useful in code called from
197 * &drm_mode_config_funcs.atomic_check) see
198 * drm_atomic_crtc_state_for_each_plane().
199 */
200#define drm_atomic_crtc_for_each_plane(plane, crtc) \
201	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
202
203/**
204 * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state
205 * @plane: the loop cursor
206 * @crtc_state: the incoming CRTC state
207 *
208 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
209 * attached if the specified state is applied.  Useful during for example
210 * in code called from &drm_mode_config_funcs.atomic_check operations, to
211 * validate the incoming state.
212 */
213#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
214	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
215
216/**
217 * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state
218 * @plane: the loop cursor
219 * @plane_state: loop cursor for the plane's state, must be const
220 * @crtc_state: the incoming CRTC state
221 *
222 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
223 * attached if the specified state is applied.  Useful during for example
224 * in code called from &drm_mode_config_funcs.atomic_check operations, to
225 * validate the incoming state.
226 *
227 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
228 * const plane_state. This is useful when a driver just wants to peek at other
229 * active planes on this CRTC, but does not need to change it.
230 */
231#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
232	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
233		for_each_if ((plane_state = \
234			      __drm_atomic_get_current_plane_state((crtc_state)->state, \
235								   plane)))
236
237/**
238 * drm_atomic_plane_enabling - check whether a plane is being enabled
239 * @old_plane_state: old atomic plane state
240 * @new_plane_state: new atomic plane state
241 *
242 * Checks the atomic state of a plane to determine whether it's being enabled
243 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
244 * need to either both be NULL or both be non-NULL).
245 *
246 * RETURNS:
247 * True if the plane is being enabled, false otherwise.
248 */
249static inline bool drm_atomic_plane_enabling(struct drm_plane_state *old_plane_state,
250					     struct drm_plane_state *new_plane_state)
251{
252	/*
253	 * When enabling a plane, CRTC and FB should always be set together.
254	 * Anything else should be considered a bug in the atomic core, so we
255	 * gently warn about it.
256	 */
257	WARN_ON((!new_plane_state->crtc && new_plane_state->fb) ||
258		(new_plane_state->crtc && !new_plane_state->fb));
259
260	return !old_plane_state->crtc && new_plane_state->crtc;
261}
262
263/**
264 * drm_atomic_plane_disabling - check whether a plane is being disabled
265 * @old_plane_state: old atomic plane state
266 * @new_plane_state: new atomic plane state
267 *
268 * Checks the atomic state of a plane to determine whether it's being disabled
269 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
270 * need to either both be NULL or both be non-NULL).
271 *
272 * RETURNS:
273 * True if the plane is being disabled, false otherwise.
274 */
275static inline bool
276drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
277			   struct drm_plane_state *new_plane_state)
278{
279	/*
280	 * When disabling a plane, CRTC and FB should always be NULL together.
281	 * Anything else should be considered a bug in the atomic core, so we
282	 * gently warn about it.
283	 */
284	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
285		(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
286
287	return old_plane_state->crtc && !new_plane_state->crtc;
288}
289
290u32 *
291drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
292					struct drm_bridge_state *bridge_state,
293					struct drm_crtc_state *crtc_state,
294					struct drm_connector_state *conn_state,
295					u32 output_fmt,
296					unsigned int *num_input_fmts);
297
298#endif /* DRM_ATOMIC_HELPER_H_ */