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