2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
28 #ifndef DRM_ATOMIC_HELPER_H_
29 #define DRM_ATOMIC_HELPER_H_
31 #include <drm/drm_crtc.h>
33 struct drm_atomic_state
;
35 int drm_atomic_helper_check_modeset(struct drm_device
*dev
,
36 struct drm_atomic_state
*state
);
37 int drm_atomic_helper_check_planes(struct drm_device
*dev
,
38 struct drm_atomic_state
*state
);
39 int drm_atomic_helper_check(struct drm_device
*dev
,
40 struct drm_atomic_state
*state
);
41 int drm_atomic_helper_commit(struct drm_device
*dev
,
42 struct drm_atomic_state
*state
,
45 void drm_atomic_helper_wait_for_fences(struct drm_device
*dev
,
46 struct drm_atomic_state
*state
);
47 bool drm_atomic_helper_framebuffer_changed(struct drm_device
*dev
,
48 struct drm_atomic_state
*old_state
,
49 struct drm_crtc
*crtc
);
51 void drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
52 struct drm_atomic_state
*old_state
);
55 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
56 struct drm_atomic_state
*old_state
);
58 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
59 struct drm_atomic_state
*state
);
60 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
61 struct drm_atomic_state
*old_state
);
63 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
64 struct drm_atomic_state
*state
);
65 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
66 struct drm_atomic_state
*state
,
68 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
69 struct drm_atomic_state
*old_state
);
70 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
);
71 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc
*crtc
,
74 void drm_atomic_helper_swap_state(struct drm_device
*dev
,
75 struct drm_atomic_state
*state
);
77 /* implementations for legacy interfaces */
78 int 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
);
85 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
);
86 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
87 struct drm_plane_state
*plane_state
);
88 int drm_atomic_helper_set_config(struct drm_mode_set
*set
);
89 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
90 struct drm_atomic_state
*state
);
92 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
93 struct drm_modeset_acquire_ctx
*ctx
);
94 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
);
95 int drm_atomic_helper_resume(struct drm_device
*dev
,
96 struct drm_atomic_state
*state
);
98 int drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
99 struct drm_property
*property
,
101 int drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
102 struct drm_property
*property
,
104 int drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
105 struct drm_property
*property
,
107 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
108 struct drm_framebuffer
*fb
,
109 struct drm_pending_vblank_event
*event
,
111 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
114 drm_atomic_helper_best_encoder(struct drm_connector
*connector
);
116 /* default implementations for state handling */
117 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
);
118 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
119 struct drm_crtc_state
*state
);
120 struct drm_crtc_state
*
121 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
);
122 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
);
123 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
124 struct drm_crtc_state
*state
);
126 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
);
127 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
128 struct drm_plane_state
*state
);
129 struct drm_plane_state
*
130 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
);
131 void __drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
132 struct drm_plane_state
*state
);
133 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
134 struct drm_plane_state
*state
);
136 void __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
137 struct drm_connector_state
*conn_state
);
138 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
);
140 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
141 struct drm_connector_state
*state
);
142 struct drm_connector_state
*
143 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
);
144 struct drm_atomic_state
*
145 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
146 struct drm_modeset_acquire_ctx
*ctx
);
148 __drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
149 struct drm_connector_state
*state
);
150 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
151 struct drm_connector_state
*state
);
152 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc
*crtc
,
153 u16
*red
, u16
*green
, u16
*blue
,
154 uint32_t start
, uint32_t size
);
157 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
158 * @plane: the loop cursor
159 * @crtc: the crtc whose planes are iterated
161 * This iterates over the current state, useful (for example) when applying
162 * atomic state after it has been checked and swapped. To iterate over the
163 * planes which *will* be attached (for ->atomic_check()) see
164 * drm_crtc_for_each_pending_plane()
166 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
167 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
170 * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
171 * @plane: the loop cursor
172 * @crtc_state: the incoming crtc-state
174 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
175 * attached if the specified state is applied. Useful during (for example)
176 * ->atomic_check() operations, to validate the incoming state
178 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
179 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
182 * drm_atomic_plane_disabling - check whether a plane is being disabled
183 * @plane: plane object
184 * @old_state: previous atomic state
186 * Checks the atomic state of a plane to determine whether it's being disabled
187 * or not. This also WARNs if it detects an invalid state (both CRTC and FB
188 * need to either both be NULL or both be non-NULL).
191 * True if the plane is being disabled, false otherwise.
194 drm_atomic_plane_disabling(struct drm_plane
*plane
,
195 struct drm_plane_state
*old_state
)
198 * When disabling a plane, CRTC and FB should always be NULL together.
199 * Anything else should be considered a bug in the atomic core, so we
200 * gently warn about it.
202 WARN_ON((plane
->state
->crtc
== NULL
&& plane
->state
->fb
!= NULL
) ||
203 (plane
->state
->crtc
!= NULL
&& plane
->state
->fb
== NULL
));
206 * When using the transitional helpers, old_state may be NULL. If so,
207 * we know nothing about the current state and have to assume that it
210 * When using the atomic helpers, old_state won't be NULL. Therefore
211 * this check assumes that either the driver will have reconstructed
212 * the correct state in ->reset() or that the driver will have taken
213 * appropriate measures to disable all planes.
215 return (!old_state
|| old_state
->crtc
) && !plane
->state
->crtc
;
218 #endif /* DRM_ATOMIC_HELPER_H_ */
This page took 0.037493 seconds and 6 git commands to generate.