Commit | Line | Data |
---|---|---|
cc4ceb48 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_H_ | |
29 | #define DRM_ATOMIC_H_ | |
30 | ||
37cc0148 TR |
31 | #include <drm/drm_crtc.h> |
32 | ||
3b24f7d6 DV |
33 | void drm_crtc_commit_put(struct drm_crtc_commit *commit); |
34 | static inline void drm_crtc_commit_get(struct drm_crtc_commit *commit) | |
35 | { | |
36 | kref_get(&commit->ref); | |
37 | } | |
38 | ||
cc4ceb48 DV |
39 | struct drm_atomic_state * __must_check |
40 | drm_atomic_state_alloc(struct drm_device *dev); | |
41 | void drm_atomic_state_clear(struct drm_atomic_state *state); | |
42 | void drm_atomic_state_free(struct drm_atomic_state *state); | |
036ef573 ML |
43 | |
44 | int __must_check | |
45 | drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state); | |
46 | void drm_atomic_state_default_clear(struct drm_atomic_state *state); | |
47 | void drm_atomic_state_default_release(struct drm_atomic_state *state); | |
cc4ceb48 DV |
48 | |
49 | struct drm_crtc_state * __must_check | |
50 | drm_atomic_get_crtc_state(struct drm_atomic_state *state, | |
51 | struct drm_crtc *crtc); | |
40ecc694 RC |
52 | int drm_atomic_crtc_set_property(struct drm_crtc *crtc, |
53 | struct drm_crtc_state *state, struct drm_property *property, | |
54 | uint64_t val); | |
cc4ceb48 DV |
55 | struct drm_plane_state * __must_check |
56 | drm_atomic_get_plane_state(struct drm_atomic_state *state, | |
57 | struct drm_plane *plane); | |
40ecc694 RC |
58 | int drm_atomic_plane_set_property(struct drm_plane *plane, |
59 | struct drm_plane_state *state, struct drm_property *property, | |
60 | uint64_t val); | |
cc4ceb48 DV |
61 | struct drm_connector_state * __must_check |
62 | drm_atomic_get_connector_state(struct drm_atomic_state *state, | |
63 | struct drm_connector *connector); | |
40ecc694 RC |
64 | int drm_atomic_connector_set_property(struct drm_connector *connector, |
65 | struct drm_connector_state *state, struct drm_property *property, | |
66 | uint64_t val); | |
88a48e29 | 67 | |
1b26a5e1 ML |
68 | /** |
69 | * drm_atomic_get_existing_crtc_state - get crtc state, if it exists | |
70 | * @state: global atomic state object | |
71 | * @crtc: crtc to grab | |
72 | * | |
73 | * This function returns the crtc state for the given crtc, or NULL | |
74 | * if the crtc is not part of the global atomic state. | |
75 | */ | |
76 | static inline struct drm_crtc_state * | |
77 | drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state, | |
78 | struct drm_crtc *crtc) | |
79 | { | |
5d943aa6 | 80 | return state->crtcs[drm_crtc_index(crtc)].state; |
1b26a5e1 ML |
81 | } |
82 | ||
83 | /** | |
84 | * drm_atomic_get_existing_plane_state - get plane state, if it exists | |
85 | * @state: global atomic state object | |
86 | * @plane: plane to grab | |
87 | * | |
88 | * This function returns the plane state for the given plane, or NULL | |
89 | * if the plane is not part of the global atomic state. | |
90 | */ | |
91 | static inline struct drm_plane_state * | |
92 | drm_atomic_get_existing_plane_state(struct drm_atomic_state *state, | |
93 | struct drm_plane *plane) | |
94 | { | |
b8b5342b | 95 | return state->planes[drm_plane_index(plane)].state; |
1b26a5e1 ML |
96 | } |
97 | ||
98 | /** | |
99 | * drm_atomic_get_existing_connector_state - get connector state, if it exists | |
100 | * @state: global atomic state object | |
101 | * @connector: connector to grab | |
102 | * | |
103 | * This function returns the connector state for the given connector, | |
104 | * or NULL if the connector is not part of the global atomic state. | |
105 | */ | |
106 | static inline struct drm_connector_state * | |
107 | drm_atomic_get_existing_connector_state(struct drm_atomic_state *state, | |
108 | struct drm_connector *connector) | |
109 | { | |
110 | int index = drm_connector_index(connector); | |
111 | ||
112 | if (index >= state->num_connector) | |
113 | return NULL; | |
114 | ||
63e83c1d | 115 | return state->connectors[index].state; |
1b26a5e1 ML |
116 | } |
117 | ||
2f196b7c DV |
118 | /** |
119 | * __drm_atomic_get_current_plane_state - get current plane state | |
120 | * @state: global atomic state object | |
121 | * @plane: plane to grab | |
122 | * | |
123 | * This function returns the plane state for the given plane, either from | |
124 | * @state, or if the plane isn't part of the atomic state update, from @plane. | |
125 | * This is useful in atomic check callbacks, when drivers need to peek at, but | |
126 | * not change, state of other planes, since it avoids threading an error code | |
127 | * back up the call chain. | |
128 | * | |
129 | * WARNING: | |
130 | * | |
131 | * Note that this function is in general unsafe since it doesn't check for the | |
132 | * required locking for access state structures. Drivers must ensure that it is | |
60c9e190 | 133 | * safe to access the returned state structure through other means. One common |
2f196b7c | 134 | * example is when planes are fixed to a single CRTC, and the driver knows that |
60c9e190 | 135 | * the CRTC lock is held already. In that case holding the CRTC lock gives a |
2f196b7c DV |
136 | * read-lock on all planes connected to that CRTC. But if planes can be |
137 | * reassigned things get more tricky. In that case it's better to use | |
138 | * drm_atomic_get_plane_state and wire up full error handling. | |
139 | * | |
140 | * Returns: | |
141 | * | |
142 | * Read-only pointer to the current plane state. | |
143 | */ | |
144 | static inline const struct drm_plane_state * | |
145 | __drm_atomic_get_current_plane_state(struct drm_atomic_state *state, | |
146 | struct drm_plane *plane) | |
147 | { | |
b8b5342b DV |
148 | if (state->planes[drm_plane_index(plane)].state) |
149 | return state->planes[drm_plane_index(plane)].state; | |
2f196b7c DV |
150 | |
151 | return plane->state; | |
152 | } | |
153 | ||
819364da DS |
154 | int __must_check |
155 | drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state, | |
156 | struct drm_display_mode *mode); | |
cc4ceb48 | 157 | int __must_check |
955f3c33 DS |
158 | drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state, |
159 | struct drm_property_blob *blob); | |
160 | int __must_check | |
07cc0ef6 DV |
161 | drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state, |
162 | struct drm_crtc *crtc); | |
321ebf04 DV |
163 | void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state, |
164 | struct drm_framebuffer *fb); | |
cc4ceb48 DV |
165 | int __must_check |
166 | drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state, | |
167 | struct drm_crtc *crtc); | |
168 | int __must_check | |
169 | drm_atomic_add_affected_connectors(struct drm_atomic_state *state, | |
170 | struct drm_crtc *crtc); | |
e01e9f75 ML |
171 | int __must_check |
172 | drm_atomic_add_affected_planes(struct drm_atomic_state *state, | |
173 | struct drm_crtc *crtc); | |
174 | ||
cc4ceb48 DV |
175 | void drm_atomic_legacy_backoff(struct drm_atomic_state *state); |
176 | ||
0f45c26f ML |
177 | void |
178 | drm_atomic_clean_old_fb(struct drm_device *dev, unsigned plane_mask, int ret); | |
179 | ||
cc4ceb48 DV |
180 | int __must_check drm_atomic_check_only(struct drm_atomic_state *state); |
181 | int __must_check drm_atomic_commit(struct drm_atomic_state *state); | |
b837ba0a | 182 | int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state); |
cc4ceb48 | 183 | |
63e83c1d | 184 | #define for_each_connector_in_state(__state, connector, connector_state, __i) \ |
df63b999 | 185 | for ((__i) = 0; \ |
63e83c1d DV |
186 | (__i) < (__state)->num_connector && \ |
187 | ((connector) = (__state)->connectors[__i].ptr, \ | |
188 | (connector_state) = (__state)->connectors[__i].state, 1); \ | |
df63b999 | 189 | (__i)++) \ |
373701b1 | 190 | for_each_if (connector) |
df63b999 | 191 | |
5d943aa6 | 192 | #define for_each_crtc_in_state(__state, crtc, crtc_state, __i) \ |
df63b999 | 193 | for ((__i) = 0; \ |
5d943aa6 DV |
194 | (__i) < (__state)->dev->mode_config.num_crtc && \ |
195 | ((crtc) = (__state)->crtcs[__i].ptr, \ | |
196 | (crtc_state) = (__state)->crtcs[__i].state, 1); \ | |
df63b999 | 197 | (__i)++) \ |
373701b1 | 198 | for_each_if (crtc_state) |
df63b999 | 199 | |
b8b5342b | 200 | #define for_each_plane_in_state(__state, plane, plane_state, __i) \ |
60f207a5 | 201 | for ((__i) = 0; \ |
b8b5342b DV |
202 | (__i) < (__state)->dev->mode_config.num_total_plane && \ |
203 | ((plane) = (__state)->planes[__i].ptr, \ | |
204 | (plane_state) = (__state)->planes[__i].state, 1); \ | |
60f207a5 | 205 | (__i)++) \ |
373701b1 | 206 | for_each_if (plane_state) |
081e9c0f DV |
207 | |
208 | /** | |
209 | * drm_atomic_crtc_needs_modeset - compute combined modeset need | |
210 | * @state: &drm_crtc_state for the CRTC | |
211 | * | |
212 | * To give drivers flexibility struct &drm_crtc_state has 3 booleans to track | |
213 | * whether the state CRTC changed enough to need a full modeset cycle: | |
214 | * connectors_changed, mode_changed and active_change. This helper simply | |
215 | * combines these three to compute the overall need for a modeset for @state. | |
216 | */ | |
2465ff62 DV |
217 | static inline bool |
218 | drm_atomic_crtc_needs_modeset(struct drm_crtc_state *state) | |
219 | { | |
fc596660 ML |
220 | return state->mode_changed || state->active_changed || |
221 | state->connectors_changed; | |
2465ff62 DV |
222 | } |
223 | ||
df63b999 | 224 | |
cc4ceb48 | 225 | #endif /* DRM_ATOMIC_H_ */ |