include/drm/drm_atomic.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_H_
  29 #define DRM_ATOMIC_H_
  30
  31 #include <drm/drm_crtc.h>
  32
  33 struct drm_atomic_state * __must_check
  34 drm_atomic_state_alloc(struct drm_device *dev);
  35 void drm_atomic_state_clear(struct drm_atomic_state *state);
  36 void drm_atomic_state_free(struct drm_atomic_state *state);
  37
  38 int  __must_check
  39 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state);
  40 void drm_atomic_state_default_clear(struct drm_atomic_state *state);
  41 void drm_atomic_state_default_release(struct drm_atomic_state *state);
  42
  43 struct drm_crtc_state * __must_check
  44 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
  45                           struct drm_crtc *crtc);
  46 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
  47                 struct drm_crtc_state *state, struct drm_property *property,
  48                 uint64_t val);
  49 struct drm_plane_state * __must_check
  50 drm_atomic_get_plane_state(struct drm_atomic_state *state,
  51                            struct drm_plane *plane);
  52 int drm_atomic_plane_set_property(struct drm_plane *plane,
  53                 struct drm_plane_state *state, struct drm_property *property,
  54                 uint64_t val);
  55 struct drm_connector_state * __must_check
  56 drm_atomic_get_connector_state(struct drm_atomic_state *state,
  57                                struct drm_connector *connector);
  58 int drm_atomic_connector_set_property(struct drm_connector *connector,
  59                 struct drm_connector_state *state, struct drm_property *property,
  60                 uint64_t val);
  61
  62 /**
  63  * drm_atomic_get_existing_crtc_state - get crtc state, if it exists
  64  * @state: global atomic state object
  65  * @crtc: crtc to grab
  66  *
  67  * This function returns the crtc state for the given crtc, or NULL
  68  * if the crtc is not part of the global atomic state.
  69  */
  70 static inline struct drm_crtc_state *
  71 drm_atomic_get_existing_crtc_state(struct drm_atomic_state *state,
  72                                    struct drm_crtc *crtc)
  73 {
  74         return state->crtc_states[drm_crtc_index(crtc)];
  75 }
  76
  77 /**
  78  * drm_atomic_get_existing_plane_state - get plane state, if it exists
  79  * @state: global atomic state object
  80  * @plane: plane to grab
  81  *
  82  * This function returns the plane state for the given plane, or NULL
  83  * if the plane is not part of the global atomic state.
  84  */
  85 static inline struct drm_plane_state *
  86 drm_atomic_get_existing_plane_state(struct drm_atomic_state *state,
  87                                     struct drm_plane *plane)
  88 {
  89         return state->plane_states[drm_plane_index(plane)];
  90 }
  91
  92 /**
  93  * drm_atomic_get_existing_connector_state - get connector state, if it exists
  94  * @state: global atomic state object
  95  * @connector: connector to grab
  96  *
  97  * This function returns the connector state for the given connector,
  98  * or NULL if the connector is not part of the global atomic state.
  99  */
 100 static inline struct drm_connector_state *
 101 drm_atomic_get_existing_connector_state(struct drm_atomic_state *state,
 102                                         struct drm_connector *connector)
 103 {
 104         int index = drm_connector_index(connector);
 105
 106         if (index >= state->num_connector)
 107                 return NULL;
 108
 109         return state->connector_states[index];
 110 }
 111
 112 /**
 113  * __drm_atomic_get_current_plane_state - get current plane state
 114  * @state: global atomic state object
 115  * @plane: plane to grab
 116  *
 117  * This function returns the plane state for the given plane, either from
 118  * @state, or if the plane isn't part of the atomic state update, from @plane.
 119  * This is useful in atomic check callbacks, when drivers need to peek at, but
 120  * not change, state of other planes, since it avoids threading an error code
 121  * back up the call chain.
 122  *
 123  * WARNING:
 124  *
 125  * Note that this function is in general unsafe since it doesn't check for the
 126  * required locking for access state structures. Drivers must ensure that it is
 127  * save to access the returned state structure through other means. One commone
 128  * example is when planes are fixed to a single CRTC, and the driver knows that
 129  * the CRTC locks is held already. In that case holding the CRTC locks gives a
 130  * read-lock on all planes connected to that CRTC. But if planes can be
 131  * reassigned things get more tricky. In that case it's better to use
 132  * drm_atomic_get_plane_state and wire up full error handling.
 133  *
 134  * Returns:
 135  *
 136  * Read-only pointer to the current plane state.
 137  */
 138 static inline const struct drm_plane_state *
 139 __drm_atomic_get_current_plane_state(struct drm_atomic_state *state,
 140                                      struct drm_plane *plane)
 141 {
 142         if (state->plane_states[drm_plane_index(plane)])
 143                 return state->plane_states[drm_plane_index(plane)];
 144
 145         return plane->state;
 146 }
 147
 148 int __must_check
 149 drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
 150                              struct drm_display_mode *mode);
 151 int __must_check
 152 drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
 153                                   struct drm_property_blob *blob);
 154 int __must_check
 155 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
 156                               struct drm_crtc *crtc);
 157 void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
 158                                  struct drm_framebuffer *fb);
 159 int __must_check
 160 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
 161                                   struct drm_crtc *crtc);
 162 int __must_check
 163 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
 164                                    struct drm_crtc *crtc);
 165 int __must_check
 166 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
 167                                struct drm_crtc *crtc);
 168
 169 void drm_atomic_legacy_backoff(struct drm_atomic_state *state);
 170
 171 void
 172 drm_atomic_clean_old_fb(struct drm_device *dev, unsigned plane_mask, int ret);
 173
 174 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
 175 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
 176 int __must_check drm_atomic_nonblocking_commit(struct drm_atomic_state *state);
 177
 178 #define for_each_connector_in_state(state, connector, connector_state, __i) \
 179         for ((__i) = 0;                                                 \
 180              (__i) < (state)->num_connector &&                          \
 181              ((connector) = (state)->connectors[__i],                   \
 182              (connector_state) = (state)->connector_states[__i], 1);    \
 183              (__i)++)                                                   \
 184                 for_each_if (connector)
 185
 186 #define for_each_crtc_in_state(state, crtc, crtc_state, __i)    \
 187         for ((__i) = 0;                                         \
 188              (__i) < (state)->dev->mode_config.num_crtc &&      \
 189              ((crtc) = (state)->crtcs[__i],                     \
 190              (crtc_state) = (state)->crtc_states[__i], 1);      \
 191              (__i)++)                                           \
 192                 for_each_if (crtc_state)
 193
 194 #define for_each_plane_in_state(state, plane, plane_state, __i)         \
 195         for ((__i) = 0;                                                 \
 196              (__i) < (state)->dev->mode_config.num_total_plane &&       \
 197              ((plane) = (state)->planes[__i],                           \
 198              (plane_state) = (state)->plane_states[__i], 1);            \
 199              (__i)++)                                                   \
 200                 for_each_if (plane_state)
 201 static inline bool
 202 drm_atomic_crtc_needs_modeset(struct drm_crtc_state *state)
 203 {
 204         return state->mode_changed || state->active_changed ||
 205                state->connectors_changed;
 206 }
 207
 208
 209 #endif /* DRM_ATOMIC_H_ */