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
 35struct drm_atomic_state;
 36struct drm_private_obj;
 37struct drm_private_state;
 38
 39int drm_atomic_helper_check_modeset(struct drm_device *dev,
 40				struct drm_atomic_state *state);
 41int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
 42					const struct drm_crtc_state *crtc_state,
 43					int min_scale,
 44					int max_scale,
 45					bool can_position,
 46					bool can_update_disabled);
 47int drm_atomic_helper_check_planes(struct drm_device *dev,
 48			       struct drm_atomic_state *state);
 49int drm_atomic_helper_check(struct drm_device *dev,
 50			    struct drm_atomic_state *state);
 51void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
 52void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
 53int drm_atomic_helper_commit(struct drm_device *dev,
 54			     struct drm_atomic_state *state,
 55			     bool nonblock);
 56int drm_atomic_helper_async_check(struct drm_device *dev,
 57				  struct drm_atomic_state *state);
 58void drm_atomic_helper_async_commit(struct drm_device *dev,
 59				    struct drm_atomic_state *state);
 60
 61int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
 62					struct drm_atomic_state *state,
 63					bool pre_swap);
 64
 65void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 66					struct drm_atomic_state *old_state);
 67
 68void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
 69					  struct drm_atomic_state *old_state);
 70
 71void
 72drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
 73					      struct drm_atomic_state *old_state);
 74
 75void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
 76					       struct drm_atomic_state *state);
 77void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
 78					  struct drm_atomic_state *old_state);
 79
 80int drm_atomic_helper_prepare_planes(struct drm_device *dev,
 81				     struct drm_atomic_state *state);
 82
 83#define DRM_PLANE_COMMIT_ACTIVE_ONLY			BIT(0)
 84#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET	BIT(1)
 85
 86void drm_atomic_helper_commit_planes(struct drm_device *dev,
 87				     struct drm_atomic_state *state,
 88				     uint32_t flags);
 89void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
 90				      struct drm_atomic_state *old_state);
 91void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
 92void
 93drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
 94					 bool atomic);
 95
 96int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
 97					      bool stall);
 98
 99/* nonblocking commit helpers */
100int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
101				   bool nonblock);
102void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
103void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
104void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
105
106/* implementations for legacy interfaces */
107int drm_atomic_helper_update_plane(struct drm_plane *plane,
108				   struct drm_crtc *crtc,
109				   struct drm_framebuffer *fb,
110				   int crtc_x, int crtc_y,
111				   unsigned int crtc_w, unsigned int crtc_h,
112				   uint32_t src_x, uint32_t src_y,
113				   uint32_t src_w, uint32_t src_h,
114				   struct drm_modeset_acquire_ctx *ctx);
115int drm_atomic_helper_disable_plane(struct drm_plane *plane,
116				    struct drm_modeset_acquire_ctx *ctx);
117int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
118		struct drm_plane_state *plane_state);
119int drm_atomic_helper_set_config(struct drm_mode_set *set,
120				 struct drm_modeset_acquire_ctx *ctx);
121int __drm_atomic_helper_set_config(struct drm_mode_set *set,
122		struct drm_atomic_state *state);
123
124int drm_atomic_helper_disable_all(struct drm_device *dev,
125				  struct drm_modeset_acquire_ctx *ctx);
126void drm_atomic_helper_shutdown(struct drm_device *dev);
127struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
128int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
129					      struct drm_modeset_acquire_ctx *ctx);
130int drm_atomic_helper_resume(struct drm_device *dev,
131			     struct drm_atomic_state *state);
132
133int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
134				struct drm_framebuffer *fb,
135				struct drm_pending_vblank_event *event,
136				uint32_t flags,
137				struct drm_modeset_acquire_ctx *ctx);
138int drm_atomic_helper_page_flip_target(
139				struct drm_crtc *crtc,
140				struct drm_framebuffer *fb,
141				struct drm_pending_vblank_event *event,
142				uint32_t flags,
143				uint32_t target,
144				struct drm_modeset_acquire_ctx *ctx);
145struct drm_encoder *
146drm_atomic_helper_best_encoder(struct drm_connector *connector);
147
148/* default implementations for state handling */
149void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
150void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
151					      struct drm_crtc_state *state);
152struct drm_crtc_state *
153drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
154void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state);
155void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
156					  struct drm_crtc_state *state);
157
158void drm_atomic_helper_plane_reset(struct drm_plane *plane);
159void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
160					       struct drm_plane_state *state);
161struct drm_plane_state *
162drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
163void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state);
164void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
165					  struct drm_plane_state *state);
166
167void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
168					 struct drm_connector_state *conn_state);
169void drm_atomic_helper_connector_reset(struct drm_connector *connector);
170void
171__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
172					   struct drm_connector_state *state);
173struct drm_connector_state *
174drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
175struct drm_atomic_state *
176drm_atomic_helper_duplicate_state(struct drm_device *dev,
177				  struct drm_modeset_acquire_ctx *ctx);
178void
179__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state);
180void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
181					  struct drm_connector_state *state);
182int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
183				       u16 *red, u16 *green, u16 *blue,
184				       uint32_t size,
185				       struct drm_modeset_acquire_ctx *ctx);
186void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
187						     struct drm_private_state *state);
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_crtc_atomic_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_crtc_atomic_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_disabling - check whether a plane is being disabled
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 disabled
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 disabled, false otherwise.
248 */
249static inline bool
250drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
251			   struct drm_plane_state *new_plane_state)
252{
253	/*
254	 * When disabling a plane, CRTC and FB should always be NULL together.
255	 * Anything else should be considered a bug in the atomic core, so we
256	 * gently warn about it.
257	 */
258	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
259		(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
260
261	return old_plane_state->crtc && !new_plane_state->crtc;
262}
263
264#endif /* DRM_ATOMIC_HELPER_H_ */