drm/plane: Add missing kerneldoc
[deliverable/linux.git] / include / drm / drm_atomic_helper.h
CommitLineData
c2fcd274
DV
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
31int drm_atomic_helper_check(struct drm_device *dev,
32 struct drm_atomic_state *state);
623369e5
DV
33int drm_atomic_helper_commit(struct drm_device *dev,
34 struct drm_atomic_state *state,
35 bool async);
36
5ee3229c
RC
37void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
38 struct drm_atomic_state *old_state);
39
623369e5
DV
40void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
41 struct drm_atomic_state *state);
42void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
43 struct drm_atomic_state *old_state);
c2fcd274
DV
44
45int drm_atomic_helper_prepare_planes(struct drm_device *dev,
46 struct drm_atomic_state *state);
47void drm_atomic_helper_commit_planes(struct drm_device *dev,
48 struct drm_atomic_state *state);
49void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
50 struct drm_atomic_state *old_state);
51
52void drm_atomic_helper_swap_state(struct drm_device *dev,
53 struct drm_atomic_state *state);
54
042652ed
DV
55/* implementations for legacy interfaces */
56int drm_atomic_helper_update_plane(struct drm_plane *plane,
57 struct drm_crtc *crtc,
58 struct drm_framebuffer *fb,
59 int crtc_x, int crtc_y,
60 unsigned int crtc_w, unsigned int crtc_h,
61 uint32_t src_x, uint32_t src_y,
62 uint32_t src_w, uint32_t src_h);
63int drm_atomic_helper_disable_plane(struct drm_plane *plane);
64int drm_atomic_helper_set_config(struct drm_mode_set *set);
65
66int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
67 struct drm_property *property,
68 uint64_t val);
69int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
70 struct drm_property *property,
71 uint64_t val);
72int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
73 struct drm_property *property,
74 uint64_t val);
8bc0f312
DV
75int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
76 struct drm_framebuffer *fb,
77 struct drm_pending_vblank_event *event,
78 uint32_t flags);
79
d461701c
DV
80/* default implementations for state handling */
81void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
82struct drm_crtc_state *
83drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
84void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
85 struct drm_crtc_state *state);
86
87void drm_atomic_helper_plane_reset(struct drm_plane *plane);
88struct drm_plane_state *
89drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
90void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
91 struct drm_plane_state *state);
92
93void drm_atomic_helper_connector_reset(struct drm_connector *connector);
94struct drm_connector_state *
95drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
96void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
97 struct drm_connector_state *state);
98
042652ed 99
c2fcd274 100#endif /* DRM_ATOMIC_HELPER_H_ */
This page took 0.051846 seconds and 5 git commands to generate.