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