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