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
 53drm_atomic_helper_check_wb_encoder_state(struct drm_encoder *encoder,
 54					 struct drm_connector_state *conn_state);
 55int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
 56					const struct drm_crtc_state *crtc_state,
 57					int min_scale,
 58					int max_scale,
 59					bool can_position,
 60					bool can_update_disabled);
 61int drm_atomic_helper_check_planes(struct drm_device *dev,
 62			       struct drm_atomic_state *state);
 63int drm_atomic_helper_check_crtc_primary_plane(struct drm_crtc_state *crtc_state);
 64int drm_atomic_helper_check(struct drm_device *dev,
 65			    struct drm_atomic_state *state);
 66void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);
 67void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);
 68int drm_atomic_helper_commit(struct drm_device *dev,
 69			     struct drm_atomic_state *state,
 70			     bool nonblock);
 71int drm_atomic_helper_async_check(struct drm_device *dev,
 72				  struct drm_atomic_state *state);
 73void drm_atomic_helper_async_commit(struct drm_device *dev,
 74				    struct drm_atomic_state *state);
 75
 76int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
 77					struct drm_atomic_state *state,
 78					bool pre_swap);
 79
 80void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 81					struct drm_atomic_state *old_state);
 82
 83void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
 84					  struct drm_atomic_state *old_state);
 85
 86void
 87drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
 88					      struct drm_atomic_state *old_state);
 89
 90void
 91drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state);
 92
 93void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
 94					       struct drm_atomic_state *state);
 95void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
 96					  struct drm_atomic_state *old_state);
 97
 98int drm_atomic_helper_prepare_planes(struct drm_device *dev,
 99				     struct drm_atomic_state *state);
100
101#define DRM_PLANE_COMMIT_ACTIVE_ONLY			BIT(0)
102#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET	BIT(1)
103
104void drm_atomic_helper_commit_planes(struct drm_device *dev,
105				     struct drm_atomic_state *state,
106				     uint32_t flags);
107void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
108				      struct drm_atomic_state *old_state);
109void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
110void
111drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
112					 bool atomic);
113
114int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,
115					      bool stall);
116
117/* nonblocking commit helpers */
118int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
119				   bool nonblock);
120void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);
121void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);
122void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);
123void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);
124
125/* implementations for legacy interfaces */
126int drm_atomic_helper_update_plane(struct drm_plane *plane,
127				   struct drm_crtc *crtc,
128				   struct drm_framebuffer *fb,
129				   int crtc_x, int crtc_y,
130				   unsigned int crtc_w, unsigned int crtc_h,
131				   uint32_t src_x, uint32_t src_y,
132				   uint32_t src_w, uint32_t src_h,
133				   struct drm_modeset_acquire_ctx *ctx);
134int drm_atomic_helper_disable_plane(struct drm_plane *plane,
135				    struct drm_modeset_acquire_ctx *ctx);
136int drm_atomic_helper_set_config(struct drm_mode_set *set,
137				 struct drm_modeset_acquire_ctx *ctx);
 
138
139int drm_atomic_helper_disable_all(struct drm_device *dev,
140				  struct drm_modeset_acquire_ctx *ctx);
141void drm_atomic_helper_shutdown(struct drm_device *dev);
142struct drm_atomic_state *
143drm_atomic_helper_duplicate_state(struct drm_device *dev,
144				  struct drm_modeset_acquire_ctx *ctx);
145struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
146int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
147					      struct drm_modeset_acquire_ctx *ctx);
148int drm_atomic_helper_resume(struct drm_device *dev,
149			     struct drm_atomic_state *state);
150
 
 
 
 
 
 
 
 
 
151int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
152				struct drm_framebuffer *fb,
153				struct drm_pending_vblank_event *event,
154				uint32_t flags,
155				struct drm_modeset_acquire_ctx *ctx);
156int drm_atomic_helper_page_flip_target(
157				struct drm_crtc *crtc,
158				struct drm_framebuffer *fb,
159				struct drm_pending_vblank_event *event,
160				uint32_t flags,
161				uint32_t target,
162				struct drm_modeset_acquire_ctx *ctx);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
163
164/**
165 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
166 * @plane: the loop cursor
167 * @crtc:  the CRTC whose planes are iterated
168 *
169 * This iterates over the current state, useful (for example) when applying
170 * atomic state after it has been checked and swapped.  To iterate over the
171 * planes which *will* be attached (more useful in code called from
172 * &drm_mode_config_funcs.atomic_check) see
173 * drm_atomic_crtc_state_for_each_plane().
174 */
175#define drm_atomic_crtc_for_each_plane(plane, crtc) \
176	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
177
178/**
179 * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state
180 * @plane: the loop cursor
181 * @crtc_state: the incoming CRTC state
182 *
183 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
184 * attached if the specified state is applied.  Useful during for example
185 * in code called from &drm_mode_config_funcs.atomic_check operations, to
186 * validate the incoming state.
187 */
188#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
189	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
190
191/**
192 * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state
193 * @plane: the loop cursor
194 * @plane_state: loop cursor for the plane's state, must be const
195 * @crtc_state: the incoming CRTC state
196 *
197 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
198 * attached if the specified state is applied.  Useful during for example
199 * in code called from &drm_mode_config_funcs.atomic_check operations, to
200 * validate the incoming state.
201 *
202 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a
203 * const plane_state. This is useful when a driver just wants to peek at other
204 * active planes on this CRTC, but does not need to change it.
205 */
206#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \
207	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \
208		for_each_if ((plane_state = \
209			      __drm_atomic_get_current_plane_state((crtc_state)->state, \
210								   plane)))
211
212/**
213 * drm_atomic_plane_disabling - check whether a plane is being disabled
214 * @old_plane_state: old atomic plane state
215 * @new_plane_state: new atomic plane state
216 *
217 * Checks the atomic state of a plane to determine whether it's being disabled
218 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
219 * need to either both be NULL or both be non-NULL).
220 *
221 * RETURNS:
222 * True if the plane is being disabled, false otherwise.
223 */
224static inline bool
225drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,
226			   struct drm_plane_state *new_plane_state)
227{
228	/*
229	 * When disabling a plane, CRTC and FB should always be NULL together.
230	 * Anything else should be considered a bug in the atomic core, so we
231	 * gently warn about it.
232	 */
233	WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||
234		(new_plane_state->crtc != NULL && new_plane_state->fb == NULL));
235
236	return old_plane_state->crtc && !new_plane_state->crtc;
 
 
 
 
 
 
 
 
 
 
237}
238
239u32 *
240drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
241					struct drm_bridge_state *bridge_state,
242					struct drm_crtc_state *crtc_state,
243					struct drm_connector_state *conn_state,
244					u32 output_fmt,
245					unsigned int *num_input_fmts);
246
247#endif /* 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
 33struct drm_atomic_state;
 
 
 34
 35int 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);
 
 39int drm_atomic_helper_check(struct drm_device *dev,
 40			    struct drm_atomic_state *state);
 
 
 41int drm_atomic_helper_commit(struct drm_device *dev,
 42			     struct drm_atomic_state *state,
 43			     bool async);
 
 
 
 
 44
 45bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
 46					   struct drm_atomic_state *old_state,
 47					   struct drm_crtc *crtc);
 48
 49void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
 50					struct drm_atomic_state *old_state);
 51
 
 
 
 52void
 53drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
 54					      struct drm_atomic_state *old_state);
 55
 
 
 
 56void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
 57					       struct drm_atomic_state *state);
 58void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
 59					  struct drm_atomic_state *old_state);
 60
 61int drm_atomic_helper_prepare_planes(struct drm_device *dev,
 62				     struct drm_atomic_state *state);
 
 
 
 
 63void drm_atomic_helper_commit_planes(struct drm_device *dev,
 64				     struct drm_atomic_state *state,
 65				     bool active_only);
 66void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
 67				      struct drm_atomic_state *old_state);
 68void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
 69void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
 70					      bool atomic);
 
 71
 72void drm_atomic_helper_swap_state(struct drm_device *dev,
 73				  struct drm_atomic_state *state);
 
 
 
 
 
 
 
 
 74
 75/* implementations for legacy interfaces */
 76int drm_atomic_helper_update_plane(struct drm_plane *plane,
 77				   struct drm_crtc *crtc,
 78				   struct drm_framebuffer *fb,
 79				   int crtc_x, int crtc_y,
 80				   unsigned int crtc_w, unsigned int crtc_h,
 81				   uint32_t src_x, uint32_t src_y,
 82				   uint32_t src_w, uint32_t src_h);
 83int drm_atomic_helper_disable_plane(struct drm_plane *plane);
 84int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
 85		struct drm_plane_state *plane_state);
 86int drm_atomic_helper_set_config(struct drm_mode_set *set);
 87int __drm_atomic_helper_set_config(struct drm_mode_set *set,
 88		struct drm_atomic_state *state);
 89
 90int drm_atomic_helper_disable_all(struct drm_device *dev,
 91				  struct drm_modeset_acquire_ctx *ctx);
 
 
 
 
 92struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);
 
 
 93int drm_atomic_helper_resume(struct drm_device *dev,
 94			     struct drm_atomic_state *state);
 95
 96int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
 97					struct drm_property *property,
 98					uint64_t val);
 99int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
100					struct drm_property *property,
101					uint64_t val);
102int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
103					struct drm_property *property,
104					uint64_t val);
105int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
106				struct drm_framebuffer *fb,
107				struct drm_pending_vblank_event *event,
108				uint32_t flags);
109int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
110				     int mode);
111
112/* default implementations for state handling */
113void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
114void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
115					      struct drm_crtc_state *state);
116struct drm_crtc_state *
117drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
118void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
119					    struct drm_crtc_state *state);
120void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
121					  struct drm_crtc_state *state);
122
123void drm_atomic_helper_plane_reset(struct drm_plane *plane);
124void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
125					       struct drm_plane_state *state);
126struct drm_plane_state *
127drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
128void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
129					     struct drm_plane_state *state);
130void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
131					  struct drm_plane_state *state);
132
133void __drm_atomic_helper_connector_reset(struct drm_connector *connector,
134					 struct drm_connector_state *conn_state);
135void drm_atomic_helper_connector_reset(struct drm_connector *connector);
136void
137__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
138					   struct drm_connector_state *state);
139struct drm_connector_state *
140drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
141struct drm_atomic_state *
142drm_atomic_helper_duplicate_state(struct drm_device *dev,
143				  struct drm_modeset_acquire_ctx *ctx);
144void
145__drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
146					    struct drm_connector_state *state);
147void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
148					  struct drm_connector_state *state);
149void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
150					u16 *red, u16 *green, u16 *blue,
151					uint32_t start, uint32_t size);
152
153/**
154 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
155 * @plane: the loop cursor
156 * @crtc:  the crtc whose planes are iterated
157 *
158 * This iterates over the current state, useful (for example) when applying
159 * atomic state after it has been checked and swapped.  To iterate over the
160 * planes which *will* be attached (for ->atomic_check()) see
161 * drm_crtc_for_each_pending_plane()
 
162 */
163#define drm_atomic_crtc_for_each_plane(plane, crtc) \
164	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
165
166/**
167 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
168 * @plane: the loop cursor
169 * @crtc_state: the incoming crtc-state
170 *
171 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
172 * attached if the specified state is applied.  Useful during (for example)
173 * ->atomic_check() operations, to validate the incoming state
 
174 */
175#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
176	drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
177
178/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
179 * drm_atomic_plane_disabling - check whether a plane is being disabled
180 * @plane: plane object
181 * @old_state: previous atomic state
182 *
183 * Checks the atomic state of a plane to determine whether it's being disabled
184 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
185 * need to either both be NULL or both be non-NULL).
186 *
187 * RETURNS:
188 * True if the plane is being disabled, false otherwise.
189 */
190static inline bool
191drm_atomic_plane_disabling(struct drm_plane *plane,
192			   struct drm_plane_state *old_state)
193{
194	/*
195	 * When disabling a plane, CRTC and FB should always be NULL together.
196	 * Anything else should be considered a bug in the atomic core, so we
197	 * gently warn about it.
198	 */
199	WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
200		(plane->state->crtc != NULL && plane->state->fb == NULL));
201
202	/*
203	 * When using the transitional helpers, old_state may be NULL. If so,
204	 * we know nothing about the current state and have to assume that it
205	 * might be enabled.
206	 *
207	 * When using the atomic helpers, old_state won't be NULL. Therefore
208	 * this check assumes that either the driver will have reconstructed
209	 * the correct state in ->reset() or that the driver will have taken
210	 * appropriate measures to disable all planes.
211	 */
212	return (!old_state || old_state->crtc) && !plane->state->crtc;
213}
 
 
 
 
 
 
 
 
214
215#endif /* DRM_ATOMIC_HELPER_H_ */