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