2 * Copyright © 2014 Intel Corporation
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:
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
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
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
25 * DOC: atomic plane helpers
27 * The functions here are used by the atomic plane helper functions to
28 * implement legacy plane updates (i.e., drm_plane->update_plane() and
29 * drm_plane->disable_plane()). This allows plane updates to use the
30 * atomic state infrastructure and perform plane updates as separate
31 * prepare/check/commit/cleanup steps.
35 #include <drm/drm_atomic_helper.h>
36 #include <drm/drm_plane_helper.h>
37 #include "intel_drv.h"
40 * intel_create_plane_state - create plane state object
43 * Allocates a fresh plane state for the given plane and sets some of
44 * the state values to sensible initial values.
46 * Returns: A newly allocated plane state, or NULL on failure
48 struct intel_plane_state
*
49 intel_create_plane_state(struct drm_plane
*plane
)
51 struct intel_plane_state
*state
;
53 state
= kzalloc(sizeof(*state
), GFP_KERNEL
);
57 state
->base
.plane
= plane
;
58 state
->base
.rotation
= BIT(DRM_ROTATE_0
);
64 * intel_plane_duplicate_state - duplicate plane state
67 * Allocates and returns a copy of the plane state (both common and
68 * Intel-specific) for the specified plane.
70 * Returns: The newly allocated plane state, or NULL on failure.
72 struct drm_plane_state
*
73 intel_plane_duplicate_state(struct drm_plane
*plane
)
75 struct drm_plane_state
*state
;
76 struct intel_plane_state
*intel_state
;
78 if (WARN_ON(!plane
->state
))
79 intel_state
= intel_create_plane_state(plane
);
81 intel_state
= kmemdup(plane
->state
, sizeof(*intel_state
),
87 state
= &intel_state
->base
;
89 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
95 * intel_plane_destroy_state - destroy plane state
97 * @state: state object to destroy
99 * Destroys the plane state (both common and Intel-specific) for the
103 intel_plane_destroy_state(struct drm_plane
*plane
,
104 struct drm_plane_state
*state
)
106 drm_atomic_helper_plane_destroy_state(plane
, state
);
109 static int intel_plane_atomic_check(struct drm_plane
*plane
,
110 struct drm_plane_state
*state
)
112 struct drm_crtc
*crtc
= state
->crtc
;
113 struct intel_crtc
*intel_crtc
;
114 struct intel_crtc_state
*crtc_state
;
115 struct intel_plane
*intel_plane
= to_intel_plane(plane
);
116 struct intel_plane_state
*intel_state
= to_intel_plane_state(state
);
118 crtc
= crtc
? crtc
: plane
->crtc
;
119 intel_crtc
= to_intel_crtc(crtc
);
122 * Both crtc and plane->crtc could be NULL if we're updating a
123 * property while the plane is disabled. We don't actually have
124 * anything driver-specific we need to test in that case, so
125 * just return success.
130 /* FIXME: temporary hack necessary while we still use the plane update
134 intel_atomic_get_crtc_state(state
->state
, intel_crtc
);
135 if (IS_ERR(crtc_state
))
136 return PTR_ERR(crtc_state
);
138 crtc_state
= intel_crtc
->config
;
142 * The original src/dest coordinates are stored in state->base, but
143 * we want to keep another copy internal to our driver that we can
144 * clip/modify ourselves.
146 intel_state
->src
.x1
= state
->src_x
;
147 intel_state
->src
.y1
= state
->src_y
;
148 intel_state
->src
.x2
= state
->src_x
+ state
->src_w
;
149 intel_state
->src
.y2
= state
->src_y
+ state
->src_h
;
150 intel_state
->dst
.x1
= state
->crtc_x
;
151 intel_state
->dst
.y1
= state
->crtc_y
;
152 intel_state
->dst
.x2
= state
->crtc_x
+ state
->crtc_w
;
153 intel_state
->dst
.y2
= state
->crtc_y
+ state
->crtc_h
;
155 /* Clip all planes to CRTC size, or 0x0 if CRTC is disabled */
156 intel_state
->clip
.x1
= 0;
157 intel_state
->clip
.y1
= 0;
158 intel_state
->clip
.x2
=
159 crtc_state
->base
.active
? crtc_state
->pipe_src_w
: 0;
160 intel_state
->clip
.y2
=
161 crtc_state
->base
.active
? crtc_state
->pipe_src_h
: 0;
164 * Disabling a plane is always okay; we just need to update
165 * fb tracking in a special way since cleanup_fb() won't
166 * get called by the plane helpers.
168 if (state
->fb
== NULL
&& plane
->state
->fb
!= NULL
) {
170 * 'prepare' is never called when plane is being disabled, so
171 * we need to handle frontbuffer tracking as a special case
173 intel_crtc
->atomic
.disabled_planes
|=
174 (1 << drm_plane_index(plane
));
177 if (state
->fb
&& intel_rotation_90_or_270(state
->rotation
)) {
178 if (!(state
->fb
->modifier
[0] == I915_FORMAT_MOD_Y_TILED
||
179 state
->fb
->modifier
[0] == I915_FORMAT_MOD_Yf_TILED
)) {
180 DRM_DEBUG_KMS("Y/Yf tiling required for 90/270!\n");
185 * 90/270 is not allowed with RGB64 16:16:16:16,
186 * RGB 16-bit 5:6:5, and Indexed 8-bit.
187 * TBD: Add RGB64 case once its added in supported format list.
189 switch (state
->fb
->pixel_format
) {
191 case DRM_FORMAT_RGB565
:
192 DRM_DEBUG_KMS("Unsupported pixel format %s for 90/270!\n",
193 drm_get_format_name(state
->fb
->pixel_format
));
201 return intel_plane
->check_plane(plane
, intel_state
);
204 static void intel_plane_atomic_update(struct drm_plane
*plane
,
205 struct drm_plane_state
*old_state
)
207 struct intel_plane
*intel_plane
= to_intel_plane(plane
);
208 struct intel_plane_state
*intel_state
=
209 to_intel_plane_state(plane
->state
);
211 intel_plane
->commit_plane(plane
, intel_state
);
214 const struct drm_plane_helper_funcs intel_plane_helper_funcs
= {
215 .prepare_fb
= intel_prepare_plane_fb
,
216 .cleanup_fb
= intel_cleanup_plane_fb
,
217 .atomic_check
= intel_plane_atomic_check
,
218 .atomic_update
= intel_plane_atomic_update
,
222 * intel_plane_atomic_get_property - fetch plane property value
223 * @plane: plane to fetch property for
224 * @state: state containing the property value
225 * @property: property to look up
226 * @val: pointer to write property value into
228 * The DRM core does not store shadow copies of properties for
229 * atomic-capable drivers. This entrypoint is used to fetch
230 * the current value of a driver-specific plane property.
233 intel_plane_atomic_get_property(struct drm_plane
*plane
,
234 const struct drm_plane_state
*state
,
235 struct drm_property
*property
,
238 DRM_DEBUG_KMS("Unknown plane property '%s'\n", property
->name
);
243 * intel_plane_atomic_set_property - set plane property value
244 * @plane: plane to set property for
245 * @state: state to update property value in
246 * @property: property to set
247 * @val: value to set property to
249 * Writes the specified property value for a plane into the provided atomic
252 * Returns 0 on success, -EINVAL on unrecognized properties
255 intel_plane_atomic_set_property(struct drm_plane
*plane
,
256 struct drm_plane_state
*state
,
257 struct drm_property
*property
,
260 DRM_DEBUG_KMS("Unknown plane property '%s'\n", property
->name
);