Commit | Line | Data |
---|---|---|
c2fcd274 DV |
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 | ||
0254951d TR |
31 | #include <drm/drm_crtc.h> |
32 | ||
d9b13620 DV |
33 | int drm_atomic_helper_check_modeset(struct drm_device *dev, |
34 | struct drm_atomic_state *state); | |
35 | int drm_atomic_helper_check_planes(struct drm_device *dev, | |
36 | struct drm_atomic_state *state); | |
c2fcd274 DV |
37 | int drm_atomic_helper_check(struct drm_device *dev, |
38 | struct drm_atomic_state *state); | |
623369e5 DV |
39 | int drm_atomic_helper_commit(struct drm_device *dev, |
40 | struct drm_atomic_state *state, | |
41 | bool async); | |
42 | ||
5ee3229c RC |
43 | void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev, |
44 | struct drm_atomic_state *old_state); | |
45 | ||
4c18d301 DV |
46 | void |
47 | drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev, | |
48 | struct drm_atomic_state *old_state); | |
49 | ||
1af434a9 DV |
50 | void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev, |
51 | struct drm_atomic_state *state); | |
52 | void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev, | |
623369e5 | 53 | struct drm_atomic_state *old_state); |
c2fcd274 DV |
54 | |
55 | int drm_atomic_helper_prepare_planes(struct drm_device *dev, | |
56 | struct drm_atomic_state *state); | |
57 | void drm_atomic_helper_commit_planes(struct drm_device *dev, | |
aef9dbb8 DV |
58 | struct drm_atomic_state *state, |
59 | bool active_only); | |
c2fcd274 DV |
60 | void drm_atomic_helper_cleanup_planes(struct drm_device *dev, |
61 | struct drm_atomic_state *old_state); | |
de28d021 | 62 | void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state); |
c2fcd274 DV |
63 | |
64 | void drm_atomic_helper_swap_state(struct drm_device *dev, | |
65 | struct drm_atomic_state *state); | |
66 | ||
042652ed DV |
67 | /* implementations for legacy interfaces */ |
68 | int drm_atomic_helper_update_plane(struct drm_plane *plane, | |
69 | struct drm_crtc *crtc, | |
70 | struct drm_framebuffer *fb, | |
71 | int crtc_x, int crtc_y, | |
72 | unsigned int crtc_w, unsigned int crtc_h, | |
73 | uint32_t src_x, uint32_t src_y, | |
74 | uint32_t src_w, uint32_t src_h); | |
75 | int drm_atomic_helper_disable_plane(struct drm_plane *plane); | |
76 | int drm_atomic_helper_set_config(struct drm_mode_set *set); | |
77 | ||
78 | int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc, | |
79 | struct drm_property *property, | |
80 | uint64_t val); | |
81 | int drm_atomic_helper_plane_set_property(struct drm_plane *plane, | |
82 | struct drm_property *property, | |
83 | uint64_t val); | |
84 | int drm_atomic_helper_connector_set_property(struct drm_connector *connector, | |
85 | struct drm_property *property, | |
86 | uint64_t val); | |
8bc0f312 DV |
87 | int drm_atomic_helper_page_flip(struct drm_crtc *crtc, |
88 | struct drm_framebuffer *fb, | |
89 | struct drm_pending_vblank_event *event, | |
90 | uint32_t flags); | |
9a69a9ac ML |
91 | int drm_atomic_helper_connector_dpms(struct drm_connector *connector, |
92 | int mode); | |
8bc0f312 | 93 | |
d461701c DV |
94 | /* default implementations for state handling */ |
95 | void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc); | |
f5e7840b TR |
96 | void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc, |
97 | struct drm_crtc_state *state); | |
d461701c DV |
98 | struct drm_crtc_state * |
99 | drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc); | |
f5e7840b TR |
100 | void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
101 | struct drm_crtc_state *state); | |
d461701c DV |
102 | void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc, |
103 | struct drm_crtc_state *state); | |
104 | ||
105 | void drm_atomic_helper_plane_reset(struct drm_plane *plane); | |
f5e7840b TR |
106 | void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane, |
107 | struct drm_plane_state *state); | |
d461701c DV |
108 | struct drm_plane_state * |
109 | drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane); | |
f5e7840b TR |
110 | void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
111 | struct drm_plane_state *state); | |
d461701c DV |
112 | void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane, |
113 | struct drm_plane_state *state); | |
114 | ||
115 | void drm_atomic_helper_connector_reset(struct drm_connector *connector); | |
f5e7840b TR |
116 | void |
117 | __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector, | |
118 | struct drm_connector_state *state); | |
d461701c DV |
119 | struct drm_connector_state * |
120 | drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector); | |
f5e7840b TR |
121 | void |
122 | __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, | |
123 | struct drm_connector_state *state); | |
d461701c DV |
124 | void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector, |
125 | struct drm_connector_state *state); | |
126 | ||
dd275956 RC |
127 | /** |
128 | * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC | |
129 | * @plane: the loop cursor | |
130 | * @crtc: the crtc whose planes are iterated | |
131 | * | |
132 | * This iterates over the current state, useful (for example) when applying | |
133 | * atomic state after it has been checked and swapped. To iterate over the | |
134 | * planes which *will* be attached (for ->atomic_check()) see | |
135 | * drm_crtc_for_each_pending_plane() | |
136 | */ | |
137 | #define drm_atomic_crtc_for_each_plane(plane, crtc) \ | |
138 | drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask) | |
139 | ||
140 | /** | |
141 | * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state | |
142 | * @plane: the loop cursor | |
143 | * @crtc_state: the incoming crtc-state | |
144 | * | |
145 | * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be | |
146 | * attached if the specified state is applied. Useful during (for example) | |
147 | * ->atomic_check() operations, to validate the incoming state | |
148 | */ | |
149 | #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \ | |
150 | drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) | |
042652ed | 151 | |
407b8bd9 TR |
152 | /* |
153 | * drm_atomic_plane_disabling - check whether a plane is being disabled | |
154 | * @plane: plane object | |
155 | * @old_state: previous atomic state | |
156 | * | |
157 | * Checks the atomic state of a plane to determine whether it's being disabled | |
158 | * or not. This also WARNs if it detects an invalid state (both CRTC and FB | |
159 | * need to either both be NULL or both be non-NULL). | |
160 | * | |
161 | * RETURNS: | |
162 | * True if the plane is being disabled, false otherwise. | |
163 | */ | |
164 | static inline bool | |
165 | drm_atomic_plane_disabling(struct drm_plane *plane, | |
166 | struct drm_plane_state *old_state) | |
167 | { | |
168 | /* | |
169 | * When disabling a plane, CRTC and FB should always be NULL together. | |
170 | * Anything else should be considered a bug in the atomic core, so we | |
171 | * gently warn about it. | |
172 | */ | |
173 | WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) || | |
174 | (plane->state->crtc != NULL && plane->state->fb == NULL)); | |
175 | ||
176 | /* | |
177 | * When using the transitional helpers, old_state may be NULL. If so, | |
178 | * we know nothing about the current state and have to assume that it | |
179 | * might be enabled. | |
180 | * | |
181 | * When using the atomic helpers, old_state won't be NULL. Therefore | |
182 | * this check assumes that either the driver will have reconstructed | |
183 | * the correct state in ->reset() or that the driver will have taken | |
184 | * appropriate measures to disable all planes. | |
185 | */ | |
186 | return (!old_state || old_state->crtc) && !plane->state->crtc; | |
187 | } | |
188 | ||
c2fcd274 | 189 | #endif /* DRM_ATOMIC_HELPER_H_ */ |