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 int drm_atomic_helper_check(struct drm_device *dev,
  32                             struct drm_atomic_state *state);
  33 int drm_atomic_helper_commit(struct drm_device *dev,
  34                              struct drm_atomic_state *state,
  35                              bool async);
  36
  37 void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
  38                                          struct drm_atomic_state *state);
  39 void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
  40                                           struct drm_atomic_state *old_state);
  41
  42 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
  43                                      struct drm_atomic_state *state);
  44 void drm_atomic_helper_commit_planes(struct drm_device *dev,
  45                                      struct drm_atomic_state *state);
  46 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
  47                                       struct drm_atomic_state *old_state);
  48
  49 void drm_atomic_helper_swap_state(struct drm_device *dev,
  50                                   struct drm_atomic_state *state);
  51
  52 /* implementations for legacy interfaces */
  53 int drm_atomic_helper_update_plane(struct drm_plane *plane,
  54                                    struct drm_crtc *crtc,
  55                                    struct drm_framebuffer *fb,
  56                                    int crtc_x, int crtc_y,
  57                                    unsigned int crtc_w, unsigned int crtc_h,
  58                                    uint32_t src_x, uint32_t src_y,
  59                                    uint32_t src_w, uint32_t src_h);
  60 int drm_atomic_helper_disable_plane(struct drm_plane *plane);
  61 int drm_atomic_helper_set_config(struct drm_mode_set *set);
  62
  63 int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
  64                                         struct drm_property *property,
  65                                         uint64_t val);
  66 int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
  67                                         struct drm_property *property,
  68                                         uint64_t val);
  69 int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
  70                                         struct drm_property *property,
  71                                         uint64_t val);
  72 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
  73                                 struct drm_framebuffer *fb,
  74                                 struct drm_pending_vblank_event *event,
  75                                 uint32_t flags);
  76
  77 /* default implementations for state handling */
  78 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
  79 struct drm_crtc_state *
  80 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
  81 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
  82                                           struct drm_crtc_state *state);
  83
  84 void drm_atomic_helper_plane_reset(struct drm_plane *plane);
  85 struct drm_plane_state *
  86 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
  87 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
  88                                           struct drm_plane_state *state);
  89
  90 void drm_atomic_helper_connector_reset(struct drm_connector *connector);
  91 struct drm_connector_state *
  92 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
  93 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
  94                                           struct drm_connector_state *state);
  95
  96
  97 #endif /* DRM_ATOMIC_HELPER_H_ */