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