Line data Source code
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 : #include <dev/pci/drm/drm_crtc.h>
32 :
33 : struct drm_atomic_state;
34 :
35 : int drm_atomic_helper_check_modeset(struct drm_device *dev,
36 : struct drm_atomic_state *state);
37 : int drm_atomic_helper_check_planes(struct drm_device *dev,
38 : struct drm_atomic_state *state);
39 : int drm_atomic_helper_check(struct drm_device *dev,
40 : struct drm_atomic_state *state);
41 : int drm_atomic_helper_commit(struct drm_device *dev,
42 : struct drm_atomic_state *state,
43 : bool async);
44 :
45 : void drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
46 : struct drm_atomic_state *old_state);
47 :
48 : void
49 : drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
50 : struct drm_atomic_state *old_state);
51 :
52 : void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
53 : struct drm_atomic_state *state);
54 : void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
55 : struct drm_atomic_state *old_state);
56 :
57 : int drm_atomic_helper_prepare_planes(struct drm_device *dev,
58 : struct drm_atomic_state *state);
59 : void drm_atomic_helper_commit_planes(struct drm_device *dev,
60 : struct drm_atomic_state *state,
61 : bool active_only);
62 : void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
63 : struct drm_atomic_state *old_state);
64 : void drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state);
65 :
66 : void drm_atomic_helper_swap_state(struct drm_device *dev,
67 : struct drm_atomic_state *state);
68 :
69 : /* implementations for legacy interfaces */
70 : int drm_atomic_helper_update_plane(struct drm_plane *plane,
71 : struct drm_crtc *crtc,
72 : struct drm_framebuffer *fb,
73 : int crtc_x, int crtc_y,
74 : unsigned int crtc_w, unsigned int crtc_h,
75 : uint32_t src_x, uint32_t src_y,
76 : uint32_t src_w, uint32_t src_h);
77 : int drm_atomic_helper_disable_plane(struct drm_plane *plane);
78 : int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
79 : struct drm_plane_state *plane_state);
80 : int drm_atomic_helper_set_config(struct drm_mode_set *set);
81 : int __drm_atomic_helper_set_config(struct drm_mode_set *set,
82 : struct drm_atomic_state *state);
83 :
84 : int drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
85 : struct drm_property *property,
86 : uint64_t val);
87 : int drm_atomic_helper_plane_set_property(struct drm_plane *plane,
88 : struct drm_property *property,
89 : uint64_t val);
90 : int drm_atomic_helper_connector_set_property(struct drm_connector *connector,
91 : struct drm_property *property,
92 : uint64_t val);
93 : int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
94 : struct drm_framebuffer *fb,
95 : struct drm_pending_vblank_event *event,
96 : uint32_t flags);
97 : int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
98 : int mode);
99 :
100 : /* default implementations for state handling */
101 : void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc);
102 : void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
103 : struct drm_crtc_state *state);
104 : struct drm_crtc_state *
105 : drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc);
106 : void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
107 : struct drm_crtc_state *state);
108 : void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
109 : struct drm_crtc_state *state);
110 :
111 : void drm_atomic_helper_plane_reset(struct drm_plane *plane);
112 : void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
113 : struct drm_plane_state *state);
114 : struct drm_plane_state *
115 : drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane);
116 : void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
117 : struct drm_plane_state *state);
118 : void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
119 : struct drm_plane_state *state);
120 :
121 : void drm_atomic_helper_connector_reset(struct drm_connector *connector);
122 : void
123 : __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
124 : struct drm_connector_state *state);
125 : struct drm_connector_state *
126 : drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector);
127 : struct drm_atomic_state *
128 : drm_atomic_helper_duplicate_state(struct drm_device *dev,
129 : struct drm_modeset_acquire_ctx *ctx);
130 : void
131 : __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
132 : struct drm_connector_state *state);
133 : void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
134 : struct drm_connector_state *state);
135 :
136 : /**
137 : * drm_atomic_crtc_for_each_plane - iterate over planes currently attached to CRTC
138 : * @plane: the loop cursor
139 : * @crtc: the crtc whose planes are iterated
140 : *
141 : * This iterates over the current state, useful (for example) when applying
142 : * atomic state after it has been checked and swapped. To iterate over the
143 : * planes which *will* be attached (for ->atomic_check()) see
144 : * drm_crtc_for_each_pending_plane()
145 : */
146 : #define drm_atomic_crtc_for_each_plane(plane, crtc) \
147 : drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
148 :
149 : /**
150 : * drm_crtc_atomic_state_for_each_plane - iterate over attached planes in new state
151 : * @plane: the loop cursor
152 : * @crtc_state: the incoming crtc-state
153 : *
154 : * Similar to drm_crtc_for_each_plane(), but iterates the planes that will be
155 : * attached if the specified state is applied. Useful during (for example)
156 : * ->atomic_check() operations, to validate the incoming state
157 : */
158 : #define drm_atomic_crtc_state_for_each_plane(plane, crtc_state) \
159 : drm_for_each_plane_mask(plane, (crtc_state)->state->dev, (crtc_state)->plane_mask)
160 :
161 : /*
162 : * drm_atomic_plane_disabling - check whether a plane is being disabled
163 : * @plane: plane object
164 : * @old_state: previous atomic state
165 : *
166 : * Checks the atomic state of a plane to determine whether it's being disabled
167 : * or not. This also WARNs if it detects an invalid state (both CRTC and FB
168 : * need to either both be NULL or both be non-NULL).
169 : *
170 : * RETURNS:
171 : * True if the plane is being disabled, false otherwise.
172 : */
173 : static inline bool
174 0 : drm_atomic_plane_disabling(struct drm_plane *plane,
175 : struct drm_plane_state *old_state)
176 : {
177 : /*
178 : * When disabling a plane, CRTC and FB should always be NULL together.
179 : * Anything else should be considered a bug in the atomic core, so we
180 : * gently warn about it.
181 : */
182 0 : WARN_ON((plane->state->crtc == NULL && plane->state->fb != NULL) ||
183 : (plane->state->crtc != NULL && plane->state->fb == NULL));
184 :
185 : /*
186 : * When using the transitional helpers, old_state may be NULL. If so,
187 : * we know nothing about the current state and have to assume that it
188 : * might be enabled.
189 : *
190 : * When using the atomic helpers, old_state won't be NULL. Therefore
191 : * this check assumes that either the driver will have reconstructed
192 : * the correct state in ->reset() or that the driver will have taken
193 : * appropriate measures to disable all planes.
194 : */
195 0 : return (!old_state || old_state->crtc) && !plane->state->crtc;
196 : }
197 :
198 : #endif /* DRM_ATOMIC_HELPER_H_ */
|
