1 /*
2  * Copyright © 2014 Intel Corporation
3  *
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:
10  *
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
13  * 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 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.
22  */
23 
24 /**
25  * DOC: atomic plane helpers
26  *
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.
32  */
33 
34 #include <drm/drmP.h>
35 #include <drm/drm_atomic_helper.h>
36 #include <drm/drm_plane_helper.h>
37 #include "intel_drv.h"
38 
39 /**
40  * intel_create_plane_state - create plane state object
41  * @plane: drm plane
42  *
43  * Allocates a fresh plane state for the given plane and sets some of
44  * the state values to sensible initial values.
45  *
46  * Returns: A newly allocated plane state, or NULL on failure
47  */
48 struct intel_plane_state *
49 intel_create_plane_state(struct drm_plane *plane)
50 {
51 	struct intel_plane_state *state;
52 
53 	state = kzalloc(sizeof(*state), GFP_KERNEL);
54 	if (!state)
55 		return NULL;
56 
57 	state->base.plane = plane;
58 	state->base.rotation = DRM_MODE_ROTATE_0;
59 	state->ckey.flags = I915_SET_COLORKEY_NONE;
60 
61 	return state;
62 }
63 
64 /**
65  * intel_plane_duplicate_state - duplicate plane state
66  * @plane: drm plane
67  *
68  * Allocates and returns a copy of the plane state (both common and
69  * Intel-specific) for the specified plane.
70  *
71  * Returns: The newly allocated plane state, or NULL on failure.
72  */
73 struct drm_plane_state *
74 intel_plane_duplicate_state(struct drm_plane *plane)
75 {
76 	struct drm_plane_state *state;
77 	struct intel_plane_state *intel_state;
78 
79 	intel_state = kmemdup(plane->state, sizeof(*intel_state), GFP_KERNEL);
80 
81 	if (!intel_state)
82 		return NULL;
83 
84 	state = &intel_state->base;
85 
86 	__drm_atomic_helper_plane_duplicate_state(plane, state);
87 
88 	intel_state->vma = NULL;
89 
90 	return state;
91 }
92 
93 /**
94  * intel_plane_destroy_state - destroy plane state
95  * @plane: drm plane
96  * @state: state object to destroy
97  *
98  * Destroys the plane state (both common and Intel-specific) for the
99  * specified plane.
100  */
101 void
102 intel_plane_destroy_state(struct drm_plane *plane,
103 			  struct drm_plane_state *state)
104 {
105 	WARN_ON(to_intel_plane_state(state)->vma);
106 
107 	drm_atomic_helper_plane_destroy_state(plane, state);
108 }
109 
110 int intel_plane_atomic_check_with_state(const struct intel_crtc_state *old_crtc_state,
111 					struct intel_crtc_state *crtc_state,
112 					const struct intel_plane_state *old_plane_state,
113 					struct intel_plane_state *intel_state)
114 {
115 	struct drm_plane *plane = intel_state->base.plane;
116 	struct drm_i915_private *dev_priv = to_i915(plane->dev);
117 	struct drm_plane_state *state = &intel_state->base;
118 	struct intel_plane *intel_plane = to_intel_plane(plane);
119 	const struct drm_display_mode *adjusted_mode =
120 		&crtc_state->base.adjusted_mode;
121 	int ret;
122 
123 	/*
124 	 * Both crtc and plane->crtc could be NULL if we're updating a
125 	 * property while the plane is disabled.  We don't actually have
126 	 * anything driver-specific we need to test in that case, so
127 	 * just return success.
128 	 */
129 	if (!intel_state->base.crtc && !old_plane_state->base.crtc)
130 		return 0;
131 
132 	/* Clip all planes to CRTC size, or 0x0 if CRTC is disabled */
133 	intel_state->clip.x1 = 0;
134 	intel_state->clip.y1 = 0;
135 	intel_state->clip.x2 =
136 		crtc_state->base.enable ? crtc_state->pipe_src_w : 0;
137 	intel_state->clip.y2 =
138 		crtc_state->base.enable ? crtc_state->pipe_src_h : 0;
139 
140 	if (state->fb && drm_rotation_90_or_270(state->rotation)) {
141 		struct drm_format_name_buf format_name;
142 
143 		if (state->fb->modifier != I915_FORMAT_MOD_Y_TILED &&
144 		    state->fb->modifier != I915_FORMAT_MOD_Yf_TILED) {
145 			DRM_DEBUG_KMS("Y/Yf tiling required for 90/270!\n");
146 			return -EINVAL;
147 		}
148 
149 		/*
150 		 * 90/270 is not allowed with RGB64 16:16:16:16,
151 		 * RGB 16-bit 5:6:5, and Indexed 8-bit.
152 		 * TBD: Add RGB64 case once its added in supported format list.
153 		 */
154 		switch (state->fb->format->format) {
155 		case DRM_FORMAT_C8:
156 		case DRM_FORMAT_RGB565:
157 			DRM_DEBUG_KMS("Unsupported pixel format %s for 90/270!\n",
158 			              drm_get_format_name(state->fb->format->format,
159 			                                  &format_name));
160 			return -EINVAL;
161 
162 		default:
163 			break;
164 		}
165 	}
166 
167 	/* CHV ignores the mirror bit when the rotate bit is set :( */
168 	if (IS_CHERRYVIEW(dev_priv) &&
169 	    state->rotation & DRM_MODE_ROTATE_180 &&
170 	    state->rotation & DRM_MODE_REFLECT_X) {
171 		DRM_DEBUG_KMS("Cannot rotate and reflect at the same time\n");
172 		return -EINVAL;
173 	}
174 
175 	intel_state->base.visible = false;
176 	ret = intel_plane->check_plane(intel_plane, crtc_state, intel_state);
177 	if (ret)
178 		return ret;
179 
180 	/*
181 	 * Y-tiling is not supported in IF-ID Interlace mode in
182 	 * GEN9 and above.
183 	 */
184 	if (state->fb && INTEL_GEN(dev_priv) >= 9 && crtc_state->base.enable &&
185 	    adjusted_mode->flags & DRM_MODE_FLAG_INTERLACE) {
186 		if (state->fb->modifier == I915_FORMAT_MOD_Y_TILED ||
187 		    state->fb->modifier == I915_FORMAT_MOD_Yf_TILED) {
188 			DRM_DEBUG_KMS("Y/Yf tiling not supported in IF-ID mode\n");
189 			return -EINVAL;
190 		}
191 	}
192 
193 	/* FIXME pre-g4x don't work like this */
194 	if (intel_state->base.visible)
195 		crtc_state->active_planes |= BIT(intel_plane->id);
196 	else
197 		crtc_state->active_planes &= ~BIT(intel_plane->id);
198 
199 	return intel_plane_atomic_calc_changes(old_crtc_state,
200 					       &crtc_state->base,
201 					       old_plane_state,
202 					       state);
203 }
204 
205 static int intel_plane_atomic_check(struct drm_plane *plane,
206 				    struct drm_plane_state *new_plane_state)
207 {
208 	struct drm_atomic_state *state = new_plane_state->state;
209 	const struct drm_plane_state *old_plane_state =
210 		drm_atomic_get_old_plane_state(state, plane);
211 	struct drm_crtc *crtc = new_plane_state->crtc ?: old_plane_state->crtc;
212 	const struct drm_crtc_state *old_crtc_state;
213 	struct drm_crtc_state *new_crtc_state;
214 
215 	/*
216 	 * Both crtc and plane->crtc could be NULL if we're updating a
217 	 * property while the plane is disabled.  We don't actually have
218 	 * anything driver-specific we need to test in that case, so
219 	 * just return success.
220 	 */
221 	if (!crtc)
222 		return 0;
223 
224 	old_crtc_state = drm_atomic_get_old_crtc_state(state, crtc);
225 	new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
226 
227 	return intel_plane_atomic_check_with_state(to_intel_crtc_state(old_crtc_state),
228 						   to_intel_crtc_state(new_crtc_state),
229 						   to_intel_plane_state(old_plane_state),
230 						   to_intel_plane_state(new_plane_state));
231 }
232 
233 static void intel_plane_atomic_update(struct drm_plane *plane,
234 				      struct drm_plane_state *old_state)
235 {
236 	struct intel_atomic_state *state = to_intel_atomic_state(old_state->state);
237 	struct intel_plane *intel_plane = to_intel_plane(plane);
238 	const struct intel_plane_state *new_plane_state =
239 		intel_atomic_get_new_plane_state(state, intel_plane);
240 	struct drm_crtc *crtc = new_plane_state->base.crtc ?: old_state->crtc;
241 
242 	if (new_plane_state->base.visible) {
243 		const struct intel_crtc_state *new_crtc_state =
244 			intel_atomic_get_new_crtc_state(state, to_intel_crtc(crtc));
245 
246 		trace_intel_update_plane(plane,
247 					 to_intel_crtc(crtc));
248 
249 		intel_plane->update_plane(intel_plane,
250 					  new_crtc_state, new_plane_state);
251 	} else {
252 		trace_intel_disable_plane(plane,
253 					  to_intel_crtc(crtc));
254 
255 		intel_plane->disable_plane(intel_plane, to_intel_crtc(crtc));
256 	}
257 }
258 
259 const struct drm_plane_helper_funcs intel_plane_helper_funcs = {
260 	.prepare_fb = intel_prepare_plane_fb,
261 	.cleanup_fb = intel_cleanup_plane_fb,
262 	.atomic_check = intel_plane_atomic_check,
263 	.atomic_update = intel_plane_atomic_update,
264 };
265 
266 /**
267  * intel_plane_atomic_get_property - fetch plane property value
268  * @plane: plane to fetch property for
269  * @state: state containing the property value
270  * @property: property to look up
271  * @val: pointer to write property value into
272  *
273  * The DRM core does not store shadow copies of properties for
274  * atomic-capable drivers.  This entrypoint is used to fetch
275  * the current value of a driver-specific plane property.
276  */
277 int
278 intel_plane_atomic_get_property(struct drm_plane *plane,
279 				const struct drm_plane_state *state,
280 				struct drm_property *property,
281 				uint64_t *val)
282 {
283 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
284 	return -EINVAL;
285 }
286 
287 /**
288  * intel_plane_atomic_set_property - set plane property value
289  * @plane: plane to set property for
290  * @state: state to update property value in
291  * @property: property to set
292  * @val: value to set property to
293  *
294  * Writes the specified property value for a plane into the provided atomic
295  * state object.
296  *
297  * Returns 0 on success, -EINVAL on unrecognized properties
298  */
299 int
300 intel_plane_atomic_set_property(struct drm_plane *plane,
301 				struct drm_plane_state *state,
302 				struct drm_property *property,
303 				uint64_t val)
304 {
305 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
306 	return -EINVAL;
307 }
308