275 lines · c
1/*2 * Copyright (C) 2014 Red Hat3 * Copyright (C) 2014 Intel Corp.4 *5 * Permission is hereby granted, free of charge, to any person obtaining a6 * copy of this software and associated documentation files (the "Software"),7 * to deal in the Software without restriction, including without limitation8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,9 * and/or sell copies of the Software, and to permit persons to whom the10 * Software is furnished to do so, subject to the following conditions:11 *12 * The above copyright notice and this permission notice shall be included in13 * all copies or substantial portions of the Software.14 *15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR19 * 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 OR21 * 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#include <drm/drm_atomic_state_helper.h>35#include <drm/drm_util.h>36 37/*38 * Drivers that don't allow primary plane scaling may pass this macro in place39 * of the min/max scale parameters of the plane-state checker function.40 *41 * Due to src being in 16.16 fixed point and dest being in integer pixels,42 * 1<<16 represents no scaling.43 */44#define DRM_PLANE_NO_SCALING (1<<16)45 46struct drm_atomic_state;47struct drm_private_obj;48struct drm_private_state;49 50int drm_atomic_helper_check_modeset(struct drm_device *dev,51 struct drm_atomic_state *state);52int drm_atomic_helper_check_wb_connector_state(struct drm_connector *connector,53 struct drm_atomic_state *state);54int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,55 const struct drm_crtc_state *crtc_state,56 int min_scale,57 int max_scale,58 bool can_position,59 bool can_update_disabled);60int drm_atomic_helper_check_planes(struct drm_device *dev,61 struct drm_atomic_state *state);62int drm_atomic_helper_check_crtc_primary_plane(struct drm_crtc_state *crtc_state);63int drm_atomic_helper_check(struct drm_device *dev,64 struct drm_atomic_state *state);65void drm_atomic_helper_commit_tail(struct drm_atomic_state *state);66void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *state);67int drm_atomic_helper_commit(struct drm_device *dev,68 struct drm_atomic_state *state,69 bool nonblock);70int drm_atomic_helper_async_check(struct drm_device *dev,71 struct drm_atomic_state *state);72void drm_atomic_helper_async_commit(struct drm_device *dev,73 struct drm_atomic_state *state);74 75int drm_atomic_helper_wait_for_fences(struct drm_device *dev,76 struct drm_atomic_state *state,77 bool pre_swap);78 79void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,80 struct drm_atomic_state *old_state);81 82void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,83 struct drm_atomic_state *old_state);84 85void86drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,87 struct drm_atomic_state *old_state);88 89void90drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state);91 92void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,93 struct drm_atomic_state *state);94void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,95 struct drm_atomic_state *old_state);96 97int drm_atomic_helper_prepare_planes(struct drm_device *dev,98 struct drm_atomic_state *state);99void drm_atomic_helper_unprepare_planes(struct drm_device *dev,100 struct drm_atomic_state *state);101 102#define DRM_PLANE_COMMIT_ACTIVE_ONLY BIT(0)103#define DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET BIT(1)104 105void drm_atomic_helper_commit_planes(struct drm_device *dev,106 struct drm_atomic_state *state,107 uint32_t flags);108void drm_atomic_helper_cleanup_planes(struct drm_device *dev,109 struct drm_atomic_state *old_state);110void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);111void112drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,113 bool atomic);114 115int __must_check drm_atomic_helper_swap_state(struct drm_atomic_state *state,116 bool stall);117 118/* nonblocking commit helpers */119int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,120 bool nonblock);121void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state);122void drm_atomic_helper_fake_vblank(struct drm_atomic_state *state);123void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state);124void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state);125 126/* implementations for legacy interfaces */127int drm_atomic_helper_update_plane(struct drm_plane *plane,128 struct drm_crtc *crtc,129 struct drm_framebuffer *fb,130 int crtc_x, int crtc_y,131 unsigned int crtc_w, unsigned int crtc_h,132 uint32_t src_x, uint32_t src_y,133 uint32_t src_w, uint32_t src_h,134 struct drm_modeset_acquire_ctx *ctx);135int drm_atomic_helper_disable_plane(struct drm_plane *plane,136 struct drm_modeset_acquire_ctx *ctx);137int drm_atomic_helper_set_config(struct drm_mode_set *set,138 struct drm_modeset_acquire_ctx *ctx);139 140int drm_atomic_helper_disable_all(struct drm_device *dev,141 struct drm_modeset_acquire_ctx *ctx);142void drm_atomic_helper_shutdown(struct drm_device *dev);143struct drm_atomic_state *144drm_atomic_helper_duplicate_state(struct drm_device *dev,145 struct drm_modeset_acquire_ctx *ctx);146struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev);147int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,148 struct drm_modeset_acquire_ctx *ctx);149int drm_atomic_helper_resume(struct drm_device *dev,150 struct drm_atomic_state *state);151 152int drm_atomic_helper_page_flip(struct drm_crtc *crtc,153 struct drm_framebuffer *fb,154 struct drm_pending_vblank_event *event,155 uint32_t flags,156 struct drm_modeset_acquire_ctx *ctx);157int drm_atomic_helper_page_flip_target(158 struct drm_crtc *crtc,159 struct drm_framebuffer *fb,160 struct drm_pending_vblank_event *event,161 uint32_t flags,162 uint32_t target,163 struct drm_modeset_acquire_ctx *ctx);164 165/**166 * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC167 * @plane: the loop cursor168 * @crtc: the CRTC whose planes are iterated169 *170 * This iterates over the current state, useful (for example) when applying171 * atomic state after it has been checked and swapped. To iterate over the172 * planes which *will* be attached (more useful in code called from173 * &drm_mode_config_funcs.atomic_check) see174 * drm_atomic_crtc_state_for_each_plane().175 */176#define drm_atomic_crtc_for_each_plane(plane, crtc) \177 drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)178 179/**180 * drm_atomic_crtc_state_for_each_plane - iterate over attached planes in new state181 * @plane: the loop cursor182 * @crtc_state: the incoming CRTC state183 *184 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be185 * attached if the specified state is applied. Useful during for example186 * in code called from &drm_mode_config_funcs.atomic_check operations, to187 * validate the incoming state.188 */189#define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \190 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)191 192/**193 * drm_atomic_crtc_state_for_each_plane_state - iterate over attached planes in new state194 * @plane: the loop cursor195 * @plane_state: loop cursor for the plane's state, must be const196 * @crtc_state: the incoming CRTC state197 *198 * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be199 * attached if the specified state is applied. Useful during for example200 * in code called from &drm_mode_config_funcs.atomic_check operations, to201 * validate the incoming state.202 *203 * Compared to just drm_atomic_crtc_state_for_each_plane() this also fills in a204 * const plane_state. This is useful when a driver just wants to peek at other205 * active planes on this CRTC, but does not need to change it.206 */207#define drm_atomic_crtc_state_for_each_plane_state(plane, plane_state, crtc_state) \208 drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask) \209 for_each_if ((plane_state = \210 __drm_atomic_get_current_plane_state((crtc_state)->state, \211 plane)))212 213/**214 * drm_atomic_plane_enabling - check whether a plane is being enabled215 * @old_plane_state: old atomic plane state216 * @new_plane_state: new atomic plane state217 *218 * Checks the atomic state of a plane to determine whether it's being enabled219 * or not. This also WARNs if it detects an invalid state (both CRTC and FB220 * need to either both be NULL or both be non-NULL).221 *222 * RETURNS:223 * True if the plane is being enabled, false otherwise.224 */225static inline bool drm_atomic_plane_enabling(struct drm_plane_state *old_plane_state,226 struct drm_plane_state *new_plane_state)227{228 /*229 * When enabling a plane, CRTC and FB should always be set together.230 * Anything else should be considered a bug in the atomic core, so we231 * gently warn about it.232 */233 WARN_ON((!new_plane_state->crtc && new_plane_state->fb) ||234 (new_plane_state->crtc && !new_plane_state->fb));235 236 return !old_plane_state->crtc && new_plane_state->crtc;237}238 239/**240 * drm_atomic_plane_disabling - check whether a plane is being disabled241 * @old_plane_state: old atomic plane state242 * @new_plane_state: new atomic plane state243 *244 * Checks the atomic state of a plane to determine whether it's being disabled245 * or not. This also WARNs if it detects an invalid state (both CRTC and FB246 * need to either both be NULL or both be non-NULL).247 *248 * RETURNS:249 * True if the plane is being disabled, false otherwise.250 */251static inline bool252drm_atomic_plane_disabling(struct drm_plane_state *old_plane_state,253 struct drm_plane_state *new_plane_state)254{255 /*256 * When disabling a plane, CRTC and FB should always be NULL together.257 * Anything else should be considered a bug in the atomic core, so we258 * gently warn about it.259 */260 WARN_ON((new_plane_state->crtc == NULL && new_plane_state->fb != NULL) ||261 (new_plane_state->crtc != NULL && new_plane_state->fb == NULL));262 263 return old_plane_state->crtc && !new_plane_state->crtc;264}265 266u32 *267drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,268 struct drm_bridge_state *bridge_state,269 struct drm_crtc_state *crtc_state,270 struct drm_connector_state *conn_state,271 u32 output_fmt,272 unsigned int *num_input_fmts);273 274#endif /* DRM_ATOMIC_HELPER_H_ */275