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 = DRM_ROTATE_0;
59 state->ckey.flags = I915_SET_COLORKEY_NONE;
65 * intel_plane_duplicate_state - duplicate plane state
68 * Allocates and returns a copy of the plane state (both common and
69 * Intel-specific) for the specified plane.
71 * Returns: The newly allocated plane state, or NULL on failure.
73 struct drm_plane_state *
74 intel_plane_duplicate_state(struct drm_plane *plane)
76 struct drm_plane_state *state;
77 struct intel_plane_state *intel_state;
79 intel_state = kmemdup(plane->state, sizeof(*intel_state), GFP_KERNEL);
84 state = &intel_state->base;
86 __drm_atomic_helper_plane_duplicate_state(plane, state);
88 intel_state->vma = NULL;
94 * intel_plane_destroy_state - destroy plane state
96 * @state: state object to destroy
98 * Destroys the plane state (both common and Intel-specific) for the
102 intel_plane_destroy_state(struct drm_plane *plane,
103 struct drm_plane_state *state)
105 struct i915_vma *vma;
107 vma = fetch_and_zero(&to_intel_plane_state(state)->vma);
110 * FIXME: Normally intel_cleanup_plane_fb handles destruction of vma.
111 * We currently don't clear all planes during driver unload, so we have
112 * to be able to unpin vma here for now.
114 * Normally this can only happen during unload when kmscon is disabled
115 * and userspace doesn't attempt to set a framebuffer at all.
118 mutex_lock(&plane->dev->struct_mutex);
119 intel_unpin_fb_vma(vma);
120 mutex_unlock(&plane->dev->struct_mutex);
123 drm_atomic_helper_plane_destroy_state(plane, state);
126 int intel_plane_atomic_check_with_state(struct intel_crtc_state *crtc_state,
127 struct intel_plane_state *intel_state)
129 struct drm_plane *plane = intel_state->base.plane;
130 struct drm_i915_private *dev_priv = to_i915(plane->dev);
131 struct drm_plane_state *state = &intel_state->base;
132 struct intel_plane *intel_plane = to_intel_plane(plane);
136 * Both crtc and plane->crtc could be NULL if we're updating a
137 * property while the plane is disabled. We don't actually have
138 * anything driver-specific we need to test in that case, so
139 * just return success.
141 if (!intel_state->base.crtc && !plane->state->crtc)
144 /* Clip all planes to CRTC size, or 0x0 if CRTC is disabled */
145 intel_state->clip.x1 = 0;
146 intel_state->clip.y1 = 0;
147 intel_state->clip.x2 =
148 crtc_state->base.enable ? crtc_state->pipe_src_w : 0;
149 intel_state->clip.y2 =
150 crtc_state->base.enable ? crtc_state->pipe_src_h : 0;
152 if (state->fb && drm_rotation_90_or_270(state->rotation)) {
153 struct drm_format_name_buf format_name;
155 if (state->fb->modifier != I915_FORMAT_MOD_Y_TILED &&
156 state->fb->modifier != I915_FORMAT_MOD_Yf_TILED) {
157 DRM_DEBUG_KMS("Y/Yf tiling required for 90/270!\n");
162 * 90/270 is not allowed with RGB64 16:16:16:16,
163 * RGB 16-bit 5:6:5, and Indexed 8-bit.
164 * TBD: Add RGB64 case once its added in supported format list.
166 switch (state->fb->format->format) {
168 case DRM_FORMAT_RGB565:
169 DRM_DEBUG_KMS("Unsupported pixel format %s for 90/270!\n",
170 drm_get_format_name(state->fb->format->format,
179 /* CHV ignores the mirror bit when the rotate bit is set :( */
180 if (IS_CHERRYVIEW(dev_priv) &&
181 state->rotation & DRM_ROTATE_180 &&
182 state->rotation & DRM_REFLECT_X) {
183 DRM_DEBUG_KMS("Cannot rotate and reflect at the same time\n");
187 intel_state->base.visible = false;
188 ret = intel_plane->check_plane(plane, crtc_state, intel_state);
192 return intel_plane_atomic_calc_changes(&crtc_state->base, state);
195 static int intel_plane_atomic_check(struct drm_plane *plane,
196 struct drm_plane_state *state)
198 struct drm_crtc *crtc = state->crtc;
199 struct drm_crtc_state *drm_crtc_state;
201 crtc = crtc ? crtc : plane->state->crtc;
204 * Both crtc and plane->crtc could be NULL if we're updating a
205 * property while the plane is disabled. We don't actually have
206 * anything driver-specific we need to test in that case, so
207 * just return success.
212 drm_crtc_state = drm_atomic_get_existing_crtc_state(state->state, crtc);
213 if (WARN_ON(!drm_crtc_state))
216 return intel_plane_atomic_check_with_state(to_intel_crtc_state(drm_crtc_state),
217 to_intel_plane_state(state));
220 static void intel_plane_atomic_update(struct drm_plane *plane,
221 struct drm_plane_state *old_state)
223 struct intel_plane *intel_plane = to_intel_plane(plane);
224 struct intel_plane_state *intel_state =
225 to_intel_plane_state(plane->state);
226 struct drm_crtc *crtc = plane->state->crtc ?: old_state->crtc;
228 if (intel_state->base.visible)
229 intel_plane->update_plane(plane,
230 to_intel_crtc_state(crtc->state),
233 intel_plane->disable_plane(plane, crtc);
236 const struct drm_plane_helper_funcs intel_plane_helper_funcs = {
237 .prepare_fb = intel_prepare_plane_fb,
238 .cleanup_fb = intel_cleanup_plane_fb,
239 .atomic_check = intel_plane_atomic_check,
240 .atomic_update = intel_plane_atomic_update,
244 * intel_plane_atomic_get_property - fetch plane property value
245 * @plane: plane to fetch property for
246 * @state: state containing the property value
247 * @property: property to look up
248 * @val: pointer to write property value into
250 * The DRM core does not store shadow copies of properties for
251 * atomic-capable drivers. This entrypoint is used to fetch
252 * the current value of a driver-specific plane property.
255 intel_plane_atomic_get_property(struct drm_plane *plane,
256 const struct drm_plane_state *state,
257 struct drm_property *property,
260 DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
265 * intel_plane_atomic_set_property - set plane property value
266 * @plane: plane to set property for
267 * @state: state to update property value in
268 * @property: property to set
269 * @val: value to set property to
271 * Writes the specified property value for a plane into the provided atomic
274 * Returns 0 on success, -EINVAL on unrecognized properties
277 intel_plane_atomic_set_property(struct drm_plane *plane,
278 struct drm_plane_state *state,
279 struct drm_property *property,
282 DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);