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_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 	intel_state->wait_req = NULL;
88 
89 	return state;
90 }
91 
92 /**
93  * intel_plane_destroy_state - destroy plane state
94  * @plane: drm plane
95  * @state: state object to destroy
96  *
97  * Destroys the plane state (both common and Intel-specific) for the
98  * specified plane.
99  */
100 void
101 intel_plane_destroy_state(struct drm_plane *plane,
102 			  struct drm_plane_state *state)
103 {
104 	WARN_ON(state && to_intel_plane_state(state)->wait_req);
105 	drm_atomic_helper_plane_destroy_state(plane, state);
106 }
107 
108 static int intel_plane_atomic_check(struct drm_plane *plane,
109 				    struct drm_plane_state *state)
110 {
111 	struct drm_crtc *crtc = state->crtc;
112 	struct intel_crtc *intel_crtc;
113 	struct intel_crtc_state *crtc_state;
114 	struct intel_plane *intel_plane = to_intel_plane(plane);
115 	struct intel_plane_state *intel_state = to_intel_plane_state(state);
116 	struct drm_crtc_state *drm_crtc_state;
117 	int ret;
118 
119 	crtc = crtc ? crtc : plane->state->crtc;
120 	intel_crtc = to_intel_crtc(crtc);
121 
122 	/*
123 	 * Both crtc and plane->crtc could be NULL if we're updating a
124 	 * property while the plane is disabled.  We don't actually have
125 	 * anything driver-specific we need to test in that case, so
126 	 * just return success.
127 	 */
128 	if (!crtc)
129 		return 0;
130 
131 	drm_crtc_state = drm_atomic_get_existing_crtc_state(state->state, crtc);
132 	if (WARN_ON(!drm_crtc_state))
133 		return -EINVAL;
134 
135 	crtc_state = to_intel_crtc_state(drm_crtc_state);
136 
137 	/*
138 	 * The original src/dest coordinates are stored in state->base, but
139 	 * we want to keep another copy internal to our driver that we can
140 	 * clip/modify ourselves.
141 	 */
142 	intel_state->src.x1 = state->src_x;
143 	intel_state->src.y1 = state->src_y;
144 	intel_state->src.x2 = state->src_x + state->src_w;
145 	intel_state->src.y2 = state->src_y + state->src_h;
146 	intel_state->dst.x1 = state->crtc_x;
147 	intel_state->dst.y1 = state->crtc_y;
148 	intel_state->dst.x2 = state->crtc_x + state->crtc_w;
149 	intel_state->dst.y2 = state->crtc_y + state->crtc_h;
150 
151 	/* Clip all planes to CRTC size, or 0x0 if CRTC is disabled */
152 	intel_state->clip.x1 = 0;
153 	intel_state->clip.y1 = 0;
154 	intel_state->clip.x2 =
155 		crtc_state->base.enable ? crtc_state->pipe_src_w : 0;
156 	intel_state->clip.y2 =
157 		crtc_state->base.enable ? crtc_state->pipe_src_h : 0;
158 
159 	if (state->fb && intel_rotation_90_or_270(state->rotation)) {
160 		if (!(state->fb->modifier[0] == I915_FORMAT_MOD_Y_TILED ||
161 			state->fb->modifier[0] == I915_FORMAT_MOD_Yf_TILED)) {
162 			DRM_DEBUG_KMS("Y/Yf tiling required for 90/270!\n");
163 			return -EINVAL;
164 		}
165 
166 		/*
167 		 * 90/270 is not allowed with RGB64 16:16:16:16,
168 		 * RGB 16-bit 5:6:5, and Indexed 8-bit.
169 		 * TBD: Add RGB64 case once its added in supported format list.
170 		 */
171 		switch (state->fb->pixel_format) {
172 		case DRM_FORMAT_C8:
173 		case DRM_FORMAT_RGB565:
174 			DRM_DEBUG_KMS("Unsupported pixel format %s for 90/270!\n",
175 					drm_get_format_name(state->fb->pixel_format));
176 			return -EINVAL;
177 
178 		default:
179 			break;
180 		}
181 	}
182 
183 	intel_state->visible = false;
184 	ret = intel_plane->check_plane(plane, crtc_state, intel_state);
185 	if (ret)
186 		return ret;
187 
188 	return intel_plane_atomic_calc_changes(&crtc_state->base, state);
189 }
190 
191 static void intel_plane_atomic_update(struct drm_plane *plane,
192 				      struct drm_plane_state *old_state)
193 {
194 	struct intel_plane *intel_plane = to_intel_plane(plane);
195 	struct intel_plane_state *intel_state =
196 		to_intel_plane_state(plane->state);
197 	struct drm_crtc *crtc = plane->state->crtc ?: old_state->crtc;
198 
199 	if (intel_state->visible)
200 		intel_plane->update_plane(plane,
201 					  to_intel_crtc_state(crtc->state),
202 					  intel_state);
203 	else
204 		intel_plane->disable_plane(plane, crtc);
205 }
206 
207 const struct drm_plane_helper_funcs intel_plane_helper_funcs = {
208 	.prepare_fb = intel_prepare_plane_fb,
209 	.cleanup_fb = intel_cleanup_plane_fb,
210 	.atomic_check = intel_plane_atomic_check,
211 	.atomic_update = intel_plane_atomic_update,
212 };
213 
214 /**
215  * intel_plane_atomic_get_property - fetch plane property value
216  * @plane: plane to fetch property for
217  * @state: state containing the property value
218  * @property: property to look up
219  * @val: pointer to write property value into
220  *
221  * The DRM core does not store shadow copies of properties for
222  * atomic-capable drivers.  This entrypoint is used to fetch
223  * the current value of a driver-specific plane property.
224  */
225 int
226 intel_plane_atomic_get_property(struct drm_plane *plane,
227 				const struct drm_plane_state *state,
228 				struct drm_property *property,
229 				uint64_t *val)
230 {
231 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
232 	return -EINVAL;
233 }
234 
235 /**
236  * intel_plane_atomic_set_property - set plane property value
237  * @plane: plane to set property for
238  * @state: state to update property value in
239  * @property: property to set
240  * @val: value to set property to
241  *
242  * Writes the specified property value for a plane into the provided atomic
243  * state object.
244  *
245  * Returns 0 on success, -EINVAL on unrecognized properties
246  */
247 int
248 intel_plane_atomic_set_property(struct drm_plane *plane,
249 				struct drm_plane_state *state,
250 				struct drm_property *property,
251 				uint64_t val)
252 {
253 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
254 	return -EINVAL;
255 }
256