1/*
 2 * Copyright (C) 2011-2013 Intel Corporation
 3 *
 4 * Permission is hereby granted, free of charge, to any person obtaining a
 5 * copy of this software and associated documentation files (the "Software"),
 6 * to deal in the Software without restriction, including without limitation
 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 8 * and/or sell copies of the Software, and to permit persons to whom the
 9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * 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 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24#ifndef DRM_PLANE_HELPER_H
25#define DRM_PLANE_HELPER_H
26
27#include <linux/types.h>
28
29struct drm_atomic_state;
30struct drm_crtc;
31struct drm_framebuffer;
32struct drm_modeset_acquire_ctx;
33struct drm_plane;
34
35int drm_plane_helper_update_primary(struct drm_plane *plane, struct drm_crtc *crtc,
36				    struct drm_framebuffer *fb,
37				    int crtc_x, int crtc_y,
38				    unsigned int crtc_w, unsigned int crtc_h,
39				    uint32_t src_x, uint32_t src_y,
40				    uint32_t src_w, uint32_t src_h,
41				    struct drm_modeset_acquire_ctx *ctx);
42int drm_plane_helper_disable_primary(struct drm_plane *plane,
43				     struct drm_modeset_acquire_ctx *ctx);
44void drm_plane_helper_destroy(struct drm_plane *plane);
45int drm_plane_helper_atomic_check(struct drm_plane *plane, struct drm_atomic_state *state);
46
47/**
48 * DRM_PLANE_NON_ATOMIC_FUNCS - Default plane functions for non-atomic drivers
49 *
50 * This macro initializes plane functions for non-atomic drivers to default
51 * values. Non-atomic interfaces are deprecated and should not be used in new
52 * drivers.
53 */
54#define DRM_PLANE_NON_ATOMIC_FUNCS \
55	.update_plane = drm_plane_helper_update_primary, \
56	.disable_plane = drm_plane_helper_disable_primary, \
57	.destroy = drm_plane_helper_destroy
58
59#endif