xref: /openbmc/linux/include/drm/drm_atomic.h (revision 4f3db074)
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 struct drm_crtc_state * __must_check
39 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
40 			  struct drm_crtc *crtc);
41 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
42 		struct drm_crtc_state *state, struct drm_property *property,
43 		uint64_t val);
44 struct drm_plane_state * __must_check
45 drm_atomic_get_plane_state(struct drm_atomic_state *state,
46 			   struct drm_plane *plane);
47 int drm_atomic_plane_set_property(struct drm_plane *plane,
48 		struct drm_plane_state *state, struct drm_property *property,
49 		uint64_t val);
50 struct drm_connector_state * __must_check
51 drm_atomic_get_connector_state(struct drm_atomic_state *state,
52 			       struct drm_connector *connector);
53 int drm_atomic_connector_set_property(struct drm_connector *connector,
54 		struct drm_connector_state *state, struct drm_property *property,
55 		uint64_t val);
56 
57 int __must_check
58 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
59 			      struct drm_crtc *crtc);
60 void drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
61 				 struct drm_framebuffer *fb);
62 int __must_check
63 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
64 				  struct drm_crtc *crtc);
65 int __must_check
66 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
67 				   struct drm_crtc *crtc);
68 int
69 drm_atomic_connectors_for_crtc(struct drm_atomic_state *state,
70 			       struct drm_crtc *crtc);
71 
72 void drm_atomic_legacy_backoff(struct drm_atomic_state *state);
73 
74 int __must_check drm_atomic_check_only(struct drm_atomic_state *state);
75 int __must_check drm_atomic_commit(struct drm_atomic_state *state);
76 int __must_check drm_atomic_async_commit(struct drm_atomic_state *state);
77 
78 #define for_each_connector_in_state(state, connector, connector_state, __i) \
79 	for ((__i) = 0;							\
80 	     (connector) = (state)->connectors[__i],			\
81 	     (connector_state) = (state)->connector_states[__i],	\
82 	     (__i) < (state)->num_connector;				\
83 	     (__i)++)							\
84 		if (connector)
85 
86 #define for_each_crtc_in_state(state, crtc, crtc_state, __i)	\
87 	for ((__i) = 0;						\
88 	     (crtc) = (state)->crtcs[__i],			\
89 	     (crtc_state) = (state)->crtc_states[__i],		\
90 	     (__i) < (state)->dev->mode_config.num_crtc;	\
91 	     (__i)++)						\
92 		if (crtc_state)
93 
94 #define for_each_plane_in_state(state, plane, plane_state, __i)	\
95 	for ((__i) = 0;						\
96 	     (plane) = (state)->planes[__i],			\
97 	     (plane_state) = (state)->plane_states[__i],	\
98 	     (__i) < (state)->dev->mode_config.num_total_plane;	\
99 	     (__i)++)						\
100 		if (plane_state)
101 
102 #endif /* DRM_ATOMIC_H_ */
103