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 	if (state->fb)
89 		drm_framebuffer_reference(state->fb);
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_plane *intel_plane = to_intel_plane(plane);
115 	struct intel_plane_state *intel_state = to_intel_plane_state(state);
116 
117 	crtc = crtc ? crtc : plane->crtc;
118 	intel_crtc = to_intel_crtc(crtc);
119 
120 	/*
121 	 * Both crtc and plane->crtc could be NULL if we're updating a
122 	 * property while the plane is disabled.  We don't actually have
123 	 * anything driver-specific we need to test in that case, so
124 	 * just return success.
125 	 */
126 	if (!crtc)
127 		return 0;
128 
129 	/*
130 	 * The original src/dest coordinates are stored in state->base, but
131 	 * we want to keep another copy internal to our driver that we can
132 	 * clip/modify ourselves.
133 	 */
134 	intel_state->src.x1 = state->src_x;
135 	intel_state->src.y1 = state->src_y;
136 	intel_state->src.x2 = state->src_x + state->src_w;
137 	intel_state->src.y2 = state->src_y + state->src_h;
138 	intel_state->dst.x1 = state->crtc_x;
139 	intel_state->dst.y1 = state->crtc_y;
140 	intel_state->dst.x2 = state->crtc_x + state->crtc_w;
141 	intel_state->dst.y2 = state->crtc_y + state->crtc_h;
142 
143 	/* Clip all planes to CRTC size, or 0x0 if CRTC is disabled */
144 	intel_state->clip.x1 = 0;
145 	intel_state->clip.y1 = 0;
146 	intel_state->clip.x2 =
147 		intel_crtc->active ? intel_crtc->config->pipe_src_w : 0;
148 	intel_state->clip.y2 =
149 		intel_crtc->active ? intel_crtc->config->pipe_src_h : 0;
150 
151 	/*
152 	 * Disabling a plane is always okay; we just need to update
153 	 * fb tracking in a special way since cleanup_fb() won't
154 	 * get called by the plane helpers.
155 	 */
156 	if (state->fb == NULL && plane->state->fb != NULL) {
157 		/*
158 		 * 'prepare' is never called when plane is being disabled, so
159 		 * we need to handle frontbuffer tracking as a special case
160 		 */
161 		intel_crtc->atomic.disabled_planes |=
162 			(1 << drm_plane_index(plane));
163 	}
164 
165 	return intel_plane->check_plane(plane, intel_state);
166 }
167 
168 static void intel_plane_atomic_update(struct drm_plane *plane,
169 				      struct drm_plane_state *old_state)
170 {
171 	struct intel_plane *intel_plane = to_intel_plane(plane);
172 	struct intel_plane_state *intel_state =
173 		to_intel_plane_state(plane->state);
174 
175 	/* Don't disable an already disabled plane */
176 	if (!plane->state->fb && !old_state->fb)
177 		return;
178 
179 	intel_plane->commit_plane(plane, intel_state);
180 }
181 
182 const struct drm_plane_helper_funcs intel_plane_helper_funcs = {
183 	.prepare_fb = intel_prepare_plane_fb,
184 	.cleanup_fb = intel_cleanup_plane_fb,
185 	.atomic_check = intel_plane_atomic_check,
186 	.atomic_update = intel_plane_atomic_update,
187 };
188 
189 /**
190  * intel_plane_atomic_get_property - fetch plane property value
191  * @plane: plane to fetch property for
192  * @state: state containing the property value
193  * @property: property to look up
194  * @val: pointer to write property value into
195  *
196  * The DRM core does not store shadow copies of properties for
197  * atomic-capable drivers.  This entrypoint is used to fetch
198  * the current value of a driver-specific plane property.
199  */
200 int
201 intel_plane_atomic_get_property(struct drm_plane *plane,
202 				const struct drm_plane_state *state,
203 				struct drm_property *property,
204 				uint64_t *val)
205 {
206 	struct drm_mode_config *config = &plane->dev->mode_config;
207 
208 	if (property == config->rotation_property) {
209 		*val = state->rotation;
210 	} else {
211 		DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
212 		return -EINVAL;
213 	}
214 
215 	return 0;
216 }
217 
218 /**
219  * intel_plane_atomic_set_property - set plane property value
220  * @plane: plane to set property for
221  * @state: state to update property value in
222  * @property: property to set
223  * @val: value to set property to
224  *
225  * Writes the specified property value for a plane into the provided atomic
226  * state object.
227  *
228  * Returns 0 on success, -EINVAL on unrecognized properties
229  */
230 int
231 intel_plane_atomic_set_property(struct drm_plane *plane,
232 				struct drm_plane_state *state,
233 				struct drm_property *property,
234 				uint64_t val)
235 {
236 	struct drm_mode_config *config = &plane->dev->mode_config;
237 
238 	if (property == config->rotation_property) {
239 		state->rotation = val;
240 	} else {
241 		DRM_DEBUG_KMS("Unknown plane property '%s'\n", property->name);
242 		return -EINVAL;
243 	}
244 
245 	return 0;
246 }
247