blob: 8039d54a7441276f8fb529d42c0c0bfc35bfb192 [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
Daniel Vetterd9b13622014-11-26 16:57:41 +010033int drm_atomic_helper_check_modeset(struct drm_device *dev,
34 struct drm_atomic_state *state);
35int drm_atomic_helper_check_planes(struct drm_device *dev,
36 struct drm_atomic_state *state);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010037int drm_atomic_helper_check(struct drm_device *dev,
38 struct drm_atomic_state *state);
Daniel Vetter623369e2014-09-16 17:50:47 +020039int drm_atomic_helper_commit(struct drm_device *dev,
40 struct drm_atomic_state *state,
41 bool async);
42
Rob Clark5ee32292014-11-11 19:38:59 -050043void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
44 struct drm_atomic_state *old_state);
45
Daniel Vetter623369e2014-09-16 17:50:47 +020046void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
47 struct drm_atomic_state *state);
48void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
49 struct drm_atomic_state *old_state);
Daniel Vetterc2fcd272014-11-05 00:14:14 +010050
51int drm_atomic_helper_prepare_planes(struct drm_device *dev,
52 struct drm_atomic_state *state);
53void drm_atomic_helper_commit_planes(struct drm_device *dev,
54 struct drm_atomic_state *state);
55void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
56 struct drm_atomic_state *old_state);
57
58void drm_atomic_helper_swap_state(struct drm_device *dev,
59 struct drm_atomic_state *state);
60
Daniel Vetter042652e2014-07-27 13:46:52 +020061/* implementations for legacy interfaces */
62int drm_atomic_helper_update_plane(struct drm_plane *plane,
63 struct drm_crtc *crtc,
64 struct drm_framebuffer *fb,
65 int crtc_x, int crtc_y,
66 unsigned int crtc_w, unsigned int crtc_h,
67 uint32_t src_x, uint32_t src_y,
68 uint32_t src_w, uint32_t src_h);
69int drm_atomic_helper_disable_plane(struct drm_plane *plane);
70int drm_atomic_helper_set_config(struct drm_mode_set *set);
71
72int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
73 struct drm_property *property,
74 uint64_t val);
75int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
76 struct drm_property *property,
77 uint64_t val);
78int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
79 struct drm_property *property,
80 uint64_t val);
Daniel Vetter8bc0f312014-07-27 18:42:37 +020081int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
82 struct drm_framebuffer *fb,
83 struct drm_pending_vblank_event *event,
84 uint32_t flags);
Daniel Vetterb486e0e2015-01-22 18:53:05 +010085void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
86 int mode);
Daniel Vetter8bc0f312014-07-27 18:42:37 +020087
Daniel Vetterd4617012014-11-03 15:56:43 +010088/* default implementations for state handling */
89void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
90struct drm_crtc_state *
91drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
92void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
93 struct drm_crtc_state *state);
94
95void drm_atomic_helper_plane_reset(struct drm_plane *plane);
96struct drm_plane_state *
97drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
98void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
99 struct drm_plane_state *state);
100
101void drm_atomic_helper_connector_reset(struct drm_connector *connector);
102struct drm_connector_state *
103drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
104void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
105 struct drm_connector_state *state);
106
Rob Clarkdd275952014-11-25 20:29:46 -0500107/**
108 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
109 * @plane: the loop cursor
110 * @crtc: the crtc whose planes are iterated
111 *
112 * This iterates over the current state, useful (for example) when applying
113 * atomic state after it has been checked and swapped. To iterate over the
114 * planes which *will* be attached (for ->atomic_check()) see
115 * drm_crtc_for_each_pending_plane()
116 */
117#define drm_atomic_crtc_for_each_plane(plane, crtc) \
118 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
119
120/**
121 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
122 * @plane: the loop cursor
123 * @crtc_state: the incoming crtc-state
124 *
125 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
126 * attached if the specified state is applied. Useful during (for example)
127 * ->atomic_check() operations, to validate the incoming state
128 */
129#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
130 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
Daniel Vetter042652e2014-07-27 13:46:52 +0200131
Thierry Reding407b8bd2014-11-20 12:05:50 +0100132/*
133 * drm_atomic_plane_disabling - check whether a plane is being disabled
134 * @plane: plane object
135 * @old_state: previous atomic state
136 *
137 * Checks the atomic state of a plane to determine whether it's being disabled
138 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
139 * need to either both be NULL or both be non-NULL).
140 *
141 * RETURNS:
142 * True if the plane is being disabled, false otherwise.
143 */
144static inline bool
145drm_atomic_plane_disabling(struct drm_plane *plane,
146 struct drm_plane_state *old_state)
147{
148 /*
149 * When disabling a plane, CRTC and FB should always be NULL together.
150 * Anything else should be considered a bug in the atomic core, so we
151 * gently warn about it.
152 */
153 WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
154 (plane->state->crtc != NULL && plane->state->fb == NULL));
155
156 /*
157 * When using the transitional helpers, old_state may be NULL. If so,
158 * we know nothing about the current state and have to assume that it
159 * might be enabled.
160 *
161 * When using the atomic helpers, old_state won't be NULL. Therefore
162 * this check assumes that either the driver will have reconstructed
163 * the correct state in ->reset() or that the driver will have taken
164 * appropriate measures to disable all planes.
165 */
166 return (!old_state || old_state->crtc) && !plane->state->crtc;
167}
168
Daniel Vetterc2fcd272014-11-05 00:14:14 +0100169#endif /* DRM_ATOMIC_HELPER_H_ */