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 
60 	return state;
61 }
62 
63 /**
64  * intel_plane_duplicate_state - duplicate plane state
65  * @plane: drm plane
66  *
67  * Allocates and returns a copy of the plane state (both common and
68  * Intel-specific) for the specified plane.
69  *
70  * Returns: The newly allocated plane state, or NULL on failure.
71  */
72 struct drm_plane_state *
73 intel_plane_duplicate_state(struct drm_plane *plane)
74 {
75 	struct drm_plane_state *state;
76 	struct intel_plane_state *intel_state;
77 
78 	if (WARN_ON(!plane->state))
79 		intel_state = intel_create_plane_state(plane);
80 	else
81 		intel_state = kmemdup(plane->state, sizeof(*intel_state),
82 				      GFP_KERNEL);
83 
84 	if (!intel_state)
85 		return NULL;
86 
87 	state = &intel_state->base;
88 
89 	__drm_atomic_helper_plane_duplicate_state(plane, state);
90 
91 	return state;
92 }
93 
94 /**
95  * intel_plane_destroy_state - destroy plane state
96  * @plane: drm plane
97  * @state: state object to destroy
98  *
99  * Destroys the plane state (both common and Intel-specific) for the
100  * specified plane.
101  */
102 void
103 intel_plane_destroy_state(struct drm_plane *plane,
104 			  struct drm_plane_state *state)
105 {
106 	drm_atomic_helper_plane_destroy_state(plane, state);
107 }
108 
109 static int intel_plane_atomic_check(struct drm_plane *plane,
110 				    struct drm_plane_state *state)
111 {
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);
117 
118 	crtc = crtc ? crtc : plane->crtc;
119 	intel_crtc = to_intel_crtc(crtc);
120 
121 	/*
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.
126 	 */
127 	if (!crtc)
128 		return 0;
129 
130 	/* FIXME: temporary hack necessary while we still use the plane update
131 	 * helper. */
132 	if (state->state) {
133 		crtc_state =
134 			intel_atomic_get_crtc_state(state->state, intel_crtc);
135 		if (IS_ERR(crtc_state))
136 			return PTR_ERR(crtc_state);
137 	} else {
138 		crtc_state = intel_crtc->config;
139 	}
140 
141 	/*
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.
145 	 */
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;
154 
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;
162 
163 	/*
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.
167 	 */
168 	if (state->fb == NULL && plane->state->fb != NULL) {
169 		/*
170 		 * 'prepare' is never called when plane is being disabled, so
171 		 * we need to handle frontbuffer tracking as a special case
172 		 */
173 		intel_crtc->atomic.disabled_planes |=
174 			(1 << drm_plane_index(plane));
175 	}
176 
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");
181 			return -EINVAL;
182 		}
183 
184 		/*
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.
188 		 */
189 		switch (state->fb->pixel_format) {
190 		case DRM_FORMAT_C8:
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));
194 			return -EINVAL;
195 
196 		default:
197 			break;
198 		}
199 	}
200 
201 	return intel_plane->check_plane(plane, intel_state);
202 }
203 
204 static void intel_plane_atomic_update(struct drm_plane *plane,
205 				      struct drm_plane_state *old_state)
206 {
207 	struct intel_plane *intel_plane = to_intel_plane(plane);
208 	struct intel_plane_state *intel_state =
209 		to_intel_plane_state(plane->state);
210 
211 	intel_plane->commit_plane(plane, intel_state);
212 }
213 
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,
219 };
220 
221 /**
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
227  *
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.
231  */
232 int
233 intel_plane_atomic_get_property(struct drm_plane *plane,
234 				const struct drm_plane_state *state,
235 				struct drm_property *property,
236 				uint64_t *val)
237 {
238 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
239 	return -EINVAL;
240 }
241 
242 /**
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
248  *
249  * Writes the specified property value for a plane into the provided atomic
250  * state object.
251  *
252  * Returns 0 on success, -EINVAL on unrecognized properties
253  */
254 int
255 intel_plane_atomic_set_property(struct drm_plane *plane,
256 				struct drm_plane_state *state,
257 				struct drm_property *property,
258 				uint64_t val)
259 {
260 	DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
261 	return -EINVAL;
262 }
263