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