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
  33 int drm_atomic_helper_check_modeset(struct drm_device *dev,
  34                                 struct drm_atomic_state *state);
  35 int drm_atomic_helper_check_planes(struct drm_device *dev,
  36                                struct drm_atomic_state *state);
  37 int drm_atomic_helper_check(struct drm_device *dev,
  38                             struct drm_atomic_state *state);
  39 int drm_atomic_helper_commit(struct drm_device *dev,
  40                              struct drm_atomic_state *state,
  41                              bool async);
  42
  43 void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
  44                                         struct drm_atomic_state *old_state);
  45
  46 void
  47 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
  48                                               struct drm_atomic_state *old_state);
  49
  50 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
  51                                                struct drm_atomic_state *state);
  52 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
  53                                           struct drm_atomic_state *old_state);
  54
  55 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
  56                                      struct drm_atomic_state *state);
  57 void drm_atomic_helper_commit_planes(struct drm_device *dev,
  58                                      struct drm_atomic_state *state);
  59 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
  60                                       struct drm_atomic_state *old_state);
  61 void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
  62
  63 void drm_atomic_helper_swap_state(struct drm_device *dev,
  64                                   struct drm_atomic_state *state);
  65
  66 /* implementations for legacy interfaces */
  67 int drm_atomic_helper_update_plane(struct drm_plane *plane,
  68                                    struct drm_crtc *crtc,
  69                                    struct drm_framebuffer *fb,
  70                                    int crtc_x, int crtc_y,
  71                                    unsigned int crtc_w, unsigned int crtc_h,
  72                                    uint32_t src_x, uint32_t src_y,
  73                                    uint32_t src_w, uint32_t src_h);
  74 int drm_atomic_helper_disable_plane(struct drm_plane *plane);
  75 int drm_atomic_helper_set_config(struct drm_mode_set *set);
  76
  77 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
  78                                         struct drm_property *property,
  79                                         uint64_t val);
  80 int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
  81                                         struct drm_property *property,
  82                                         uint64_t val);
  83 int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
  84                                         struct drm_property *property,
  85                                         uint64_t val);
  86 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
  87                                 struct drm_framebuffer *fb,
  88                                 struct drm_pending_vblank_event *event,
  89                                 uint32_t flags);
  90 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
  91                                       int mode);
  92
  93 /* default implementations for state handling */
  94 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
  95 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
  96                                               struct drm_crtc_state *state);
  97 struct drm_crtc_state *
  98 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
  99 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
 100                                             struct drm_crtc_state *state);
 101 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
 102                                           struct drm_crtc_state *state);
 103
 104 void drm_atomic_helper_plane_reset(struct drm_plane *plane);
 105 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
 106                                                struct drm_plane_state *state);
 107 struct drm_plane_state *
 108 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
 109 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
 110                                              struct drm_plane_state *state);
 111 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
 112                                           struct drm_plane_state *state);
 113
 114 void drm_atomic_helper_connector_reset(struct drm_connector *connector);
 115 void
 116 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
 117                                            struct drm_connector_state *state);
 118 struct drm_connector_state *
 119 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
 120 void
 121 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
 122                                             struct drm_connector_state *state);
 123 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
 124                                           struct drm_connector_state *state);
 125
 126 /**
 127  * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
 128  * @plane: the loop cursor
 129  * @crtc:  the crtc whose planes are iterated
 130  *
 131  * This iterates over the current state, useful (for example) when applying
 132  * atomic state after it has been checked and swapped.  To iterate over the
 133  * planes which *will* be attached (for ->atomic_check()) see
 134  * drm_crtc_for_each_pending_plane()
 135  */
 136 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
 137         drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
 138
 139 /**
 140  * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
 141  * @plane: the loop cursor
 142  * @crtc_state: the incoming crtc-state
 143  *
 144  * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
 145  * attached if the specified state is applied.  Useful during (for example)
 146  * ->atomic_check() operations, to validate the incoming state
 147  */
 148 #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
 149         drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
 150
 151 /*
 152  * drm_atomic_plane_disabling - check whether a plane is being disabled
 153  * @plane: plane object
 154  * @old_state: previous atomic state
 155  *
 156  * Checks the atomic state of a plane to determine whether it's being disabled
 157  * or not. This also WARNs if it detects an invalid state (both CRTC and FB
 158  * need to either both be NULL or both be non-NULL).
 159  *
 160  * RETURNS:
 161  * True if the plane is being disabled, false otherwise.
 162  */
 163 static inline bool
 164 drm_atomic_plane_disabling(struct drm_plane *plane,
 165                            struct drm_plane_state *old_state)
 166 {
 167         /*
 168          * When disabling a plane, CRTC and FB should always be NULL together.
 169          * Anything else should be considered a bug in the atomic core, so we
 170          * gently warn about it.
 171          */
 172         WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
 173                 (plane->state->crtc != NULL && plane->state->fb == NULL));
 174
 175         /*
 176          * When using the transitional helpers, old_state may be NULL. If so,
 177          * we know nothing about the current state and have to assume that it
 178          * might be enabled.
 179          *
 180          * When using the atomic helpers, old_state won't be NULL. Therefore
 181          * this check assumes that either the driver will have reconstructed
 182          * the correct state in ->reset() or that the driver will have taken
 183          * appropriate measures to disable all planes.
 184          */
 185         return (!old_state || old_state->crtc) && !plane->state->crtc;
 186 }
 187
 188 #endif /* DRM_ATOMIC_HELPER_H_ */