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