1 /*
2  * drivers/gpu/drm/omapdrm/omap_plane.c
3  *
4  * Copyright (C) 2011 Texas Instruments
5  * Author: Rob Clark <rob.clark@linaro.org>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #include <drm/drm_atomic.h>
21 #include <drm/drm_atomic_helper.h>
22 #include <drm/drm_plane_helper.h>
23 
24 #include "omap_dmm_tiler.h"
25 #include "omap_drv.h"
26 
27 /* some hackery because omapdss has an 'enum omap_plane' (which would be
28  * better named omap_plane_id).. and compiler seems unhappy about having
29  * both a 'struct omap_plane' and 'enum omap_plane'
30  */
31 #define omap_plane _omap_plane
32 
33 /*
34  * plane funcs
35  */
36 
37 #define to_omap_plane(x) container_of(x, struct omap_plane, base)
38 
39 struct omap_plane {
40 	struct drm_plane base;
41 	int id;  /* TODO rename omap_plane -> omap_plane_id in omapdss so I can use the enum */
42 	const char *name;
43 
44 	uint32_t nformats;
45 	uint32_t formats[32];
46 
47 	struct omap_drm_irq error_irq;
48 };
49 
50 struct omap_plane_state {
51 	struct drm_plane_state base;
52 
53 	unsigned int zorder;
54 };
55 
56 static inline struct omap_plane_state *
57 to_omap_plane_state(struct drm_plane_state *state)
58 {
59 	return container_of(state, struct omap_plane_state, base);
60 }
61 
62 static int omap_plane_prepare_fb(struct drm_plane *plane,
63 				 struct drm_plane_state *new_state)
64 {
65 	if (!new_state->fb)
66 		return 0;
67 
68 	return omap_framebuffer_pin(new_state->fb);
69 }
70 
71 static void omap_plane_cleanup_fb(struct drm_plane *plane,
72 				  struct drm_plane_state *old_state)
73 {
74 	if (old_state->fb)
75 		omap_framebuffer_unpin(old_state->fb);
76 }
77 
78 static void omap_plane_atomic_update(struct drm_plane *plane,
79 				     struct drm_plane_state *old_state)
80 {
81 	struct omap_plane *omap_plane = to_omap_plane(plane);
82 	struct drm_plane_state *state = plane->state;
83 	struct omap_plane_state *omap_state = to_omap_plane_state(state);
84 	struct omap_overlay_info info;
85 	struct omap_drm_window win;
86 	int ret;
87 
88 	DBG("%s, crtc=%p fb=%p", omap_plane->name, state->crtc, state->fb);
89 
90 	memset(&info, 0, sizeof(info));
91 	info.rotation_type = OMAP_DSS_ROT_DMA;
92 	info.rotation = OMAP_DSS_ROT_0;
93 	info.global_alpha = 0xff;
94 	info.mirror = 0;
95 	info.zorder = omap_state->zorder;
96 
97 	memset(&win, 0, sizeof(win));
98 	win.rotation = state->rotation;
99 	win.crtc_x = state->crtc_x;
100 	win.crtc_y = state->crtc_y;
101 	win.crtc_w = state->crtc_w;
102 	win.crtc_h = state->crtc_h;
103 
104 	/*
105 	 * src values are in Q16 fixed point, convert to integer.
106 	 * omap_framebuffer_update_scanout() takes adjusted src.
107 	 */
108 	win.src_x = state->src_x >> 16;
109 	win.src_y = state->src_y >> 16;
110 
111 	if (drm_rotation_90_or_270(state->rotation)) {
112 		win.src_w = state->src_h >> 16;
113 		win.src_h = state->src_w >> 16;
114 	} else {
115 		win.src_w = state->src_w >> 16;
116 		win.src_h = state->src_h >> 16;
117 	}
118 
119 	/* update scanout: */
120 	omap_framebuffer_update_scanout(state->fb, &win, &info);
121 
122 	DBG("%dx%d -> %dx%d (%d)", info.width, info.height,
123 			info.out_width, info.out_height,
124 			info.screen_width);
125 	DBG("%d,%d %pad %pad", info.pos_x, info.pos_y,
126 			&info.paddr, &info.p_uv_addr);
127 
128 	dispc_ovl_set_channel_out(omap_plane->id,
129 				  omap_crtc_channel(state->crtc));
130 
131 	/* and finally, update omapdss: */
132 	ret = dispc_ovl_setup(omap_plane->id, &info, false,
133 			      omap_crtc_timings(state->crtc), false);
134 	if (ret) {
135 		dev_err(plane->dev->dev, "Failed to setup plane %s\n",
136 			omap_plane->name);
137 		dispc_ovl_enable(omap_plane->id, false);
138 		return;
139 	}
140 
141 	dispc_ovl_enable(omap_plane->id, true);
142 }
143 
144 static void omap_plane_atomic_disable(struct drm_plane *plane,
145 				      struct drm_plane_state *old_state)
146 {
147 	struct omap_plane_state *omap_state = to_omap_plane_state(plane->state);
148 	struct omap_plane *omap_plane = to_omap_plane(plane);
149 
150 	plane->state->rotation = DRM_ROTATE_0;
151 	omap_state->zorder = plane->type == DRM_PLANE_TYPE_PRIMARY
152 			   ? 0 : omap_plane->id;
153 
154 	dispc_ovl_enable(omap_plane->id, false);
155 }
156 
157 static int omap_plane_atomic_check(struct drm_plane *plane,
158 				   struct drm_plane_state *state)
159 {
160 	struct drm_crtc_state *crtc_state;
161 
162 	if (!state->fb)
163 		return 0;
164 
165 	/* crtc should only be NULL when disabling (i.e., !state->fb) */
166 	if (WARN_ON(!state->crtc))
167 		return 0;
168 
169 	crtc_state = drm_atomic_get_existing_crtc_state(state->state, state->crtc);
170 	/* we should have a crtc state if the plane is attached to a crtc */
171 	if (WARN_ON(!crtc_state))
172 		return 0;
173 
174 	if (!crtc_state->enable)
175 		return 0;
176 
177 	if (state->crtc_x < 0 || state->crtc_y < 0)
178 		return -EINVAL;
179 
180 	if (state->crtc_x + state->crtc_w > crtc_state->adjusted_mode.hdisplay)
181 		return -EINVAL;
182 
183 	if (state->crtc_y + state->crtc_h > crtc_state->adjusted_mode.vdisplay)
184 		return -EINVAL;
185 
186 	if (state->rotation != DRM_ROTATE_0 &&
187 	    !omap_framebuffer_supports_rotation(state->fb))
188 		return -EINVAL;
189 
190 	return 0;
191 }
192 
193 static const struct drm_plane_helper_funcs omap_plane_helper_funcs = {
194 	.prepare_fb = omap_plane_prepare_fb,
195 	.cleanup_fb = omap_plane_cleanup_fb,
196 	.atomic_check = omap_plane_atomic_check,
197 	.atomic_update = omap_plane_atomic_update,
198 	.atomic_disable = omap_plane_atomic_disable,
199 };
200 
201 static void omap_plane_destroy(struct drm_plane *plane)
202 {
203 	struct omap_plane *omap_plane = to_omap_plane(plane);
204 
205 	DBG("%s", omap_plane->name);
206 
207 	omap_irq_unregister(plane->dev, &omap_plane->error_irq);
208 
209 	drm_plane_cleanup(plane);
210 
211 	kfree(omap_plane);
212 }
213 
214 /* helper to install properties which are common to planes and crtcs */
215 void omap_plane_install_properties(struct drm_plane *plane,
216 		struct drm_mode_object *obj)
217 {
218 	struct drm_device *dev = plane->dev;
219 	struct omap_drm_private *priv = dev->dev_private;
220 
221 	if (priv->has_dmm) {
222 		if (!plane->rotation_property)
223 			drm_plane_create_rotation_property(plane,
224 							   DRM_ROTATE_0,
225 							   DRM_ROTATE_0 | DRM_ROTATE_90 |
226 							   DRM_ROTATE_180 | DRM_ROTATE_270 |
227 							   DRM_REFLECT_X | DRM_REFLECT_Y);
228 
229 		/* Attach the rotation property also to the crtc object */
230 		if (plane->rotation_property && obj != &plane->base)
231 			drm_object_attach_property(obj, plane->rotation_property,
232 						   DRM_ROTATE_0);
233 	}
234 
235 	drm_object_attach_property(obj, priv->zorder_prop, 0);
236 }
237 
238 static struct drm_plane_state *
239 omap_plane_atomic_duplicate_state(struct drm_plane *plane)
240 {
241 	struct omap_plane_state *state;
242 	struct omap_plane_state *copy;
243 
244 	if (WARN_ON(!plane->state))
245 		return NULL;
246 
247 	state = to_omap_plane_state(plane->state);
248 	copy = kmemdup(state, sizeof(*state), GFP_KERNEL);
249 	if (copy == NULL)
250 		return NULL;
251 
252 	__drm_atomic_helper_plane_duplicate_state(plane, &copy->base);
253 
254 	return &copy->base;
255 }
256 
257 static void omap_plane_atomic_destroy_state(struct drm_plane *plane,
258 					    struct drm_plane_state *state)
259 {
260 	__drm_atomic_helper_plane_destroy_state(state);
261 	kfree(to_omap_plane_state(state));
262 }
263 
264 static void omap_plane_reset(struct drm_plane *plane)
265 {
266 	struct omap_plane *omap_plane = to_omap_plane(plane);
267 	struct omap_plane_state *omap_state;
268 
269 	if (plane->state) {
270 		omap_plane_atomic_destroy_state(plane, plane->state);
271 		plane->state = NULL;
272 	}
273 
274 	omap_state = kzalloc(sizeof(*omap_state), GFP_KERNEL);
275 	if (omap_state == NULL)
276 		return;
277 
278 	/*
279 	 * Set defaults depending on whether we are a primary or overlay
280 	 * plane.
281 	 */
282 	omap_state->zorder = plane->type == DRM_PLANE_TYPE_PRIMARY
283 			   ? 0 : omap_plane->id;
284 	omap_state->base.rotation = DRM_ROTATE_0;
285 
286 	plane->state = &omap_state->base;
287 	plane->state->plane = plane;
288 }
289 
290 static int omap_plane_atomic_set_property(struct drm_plane *plane,
291 					  struct drm_plane_state *state,
292 					  struct drm_property *property,
293 					  uint64_t val)
294 {
295 	struct omap_drm_private *priv = plane->dev->dev_private;
296 	struct omap_plane_state *omap_state = to_omap_plane_state(state);
297 
298 	if (property == priv->zorder_prop)
299 		omap_state->zorder = val;
300 	else
301 		return -EINVAL;
302 
303 	return 0;
304 }
305 
306 static int omap_plane_atomic_get_property(struct drm_plane *plane,
307 					  const struct drm_plane_state *state,
308 					  struct drm_property *property,
309 					  uint64_t *val)
310 {
311 	struct omap_drm_private *priv = plane->dev->dev_private;
312 	const struct omap_plane_state *omap_state =
313 		container_of(state, const struct omap_plane_state, base);
314 
315 	if (property == priv->zorder_prop)
316 		*val = omap_state->zorder;
317 	else
318 		return -EINVAL;
319 
320 	return 0;
321 }
322 
323 static const struct drm_plane_funcs omap_plane_funcs = {
324 	.update_plane = drm_atomic_helper_update_plane,
325 	.disable_plane = drm_atomic_helper_disable_plane,
326 	.reset = omap_plane_reset,
327 	.destroy = omap_plane_destroy,
328 	.set_property = drm_atomic_helper_plane_set_property,
329 	.atomic_duplicate_state = omap_plane_atomic_duplicate_state,
330 	.atomic_destroy_state = omap_plane_atomic_destroy_state,
331 	.atomic_set_property = omap_plane_atomic_set_property,
332 	.atomic_get_property = omap_plane_atomic_get_property,
333 };
334 
335 static void omap_plane_error_irq(struct omap_drm_irq *irq, uint32_t irqstatus)
336 {
337 	struct omap_plane *omap_plane =
338 			container_of(irq, struct omap_plane, error_irq);
339 	DRM_ERROR_RATELIMITED("%s: errors: %08x\n", omap_plane->name,
340 		irqstatus);
341 }
342 
343 static const char *plane_names[] = {
344 	[OMAP_DSS_GFX] = "gfx",
345 	[OMAP_DSS_VIDEO1] = "vid1",
346 	[OMAP_DSS_VIDEO2] = "vid2",
347 	[OMAP_DSS_VIDEO3] = "vid3",
348 };
349 
350 static const uint32_t error_irqs[] = {
351 	[OMAP_DSS_GFX] = DISPC_IRQ_GFX_FIFO_UNDERFLOW,
352 	[OMAP_DSS_VIDEO1] = DISPC_IRQ_VID1_FIFO_UNDERFLOW,
353 	[OMAP_DSS_VIDEO2] = DISPC_IRQ_VID2_FIFO_UNDERFLOW,
354 	[OMAP_DSS_VIDEO3] = DISPC_IRQ_VID3_FIFO_UNDERFLOW,
355 };
356 
357 /* initialize plane */
358 struct drm_plane *omap_plane_init(struct drm_device *dev,
359 		int id, enum drm_plane_type type)
360 {
361 	struct omap_drm_private *priv = dev->dev_private;
362 	struct drm_plane *plane;
363 	struct omap_plane *omap_plane;
364 	int ret;
365 
366 	DBG("%s: type=%d", plane_names[id], type);
367 
368 	omap_plane = kzalloc(sizeof(*omap_plane), GFP_KERNEL);
369 	if (!omap_plane)
370 		return ERR_PTR(-ENOMEM);
371 
372 	omap_plane->nformats = omap_framebuffer_get_formats(
373 			omap_plane->formats, ARRAY_SIZE(omap_plane->formats),
374 			dss_feat_get_supported_color_modes(id));
375 	omap_plane->id = id;
376 	omap_plane->name = plane_names[id];
377 
378 	plane = &omap_plane->base;
379 
380 	omap_plane->error_irq.irqmask = error_irqs[id];
381 	omap_plane->error_irq.irq = omap_plane_error_irq;
382 	omap_irq_register(dev, &omap_plane->error_irq);
383 
384 	ret = drm_universal_plane_init(dev, plane, (1 << priv->num_crtcs) - 1,
385 				       &omap_plane_funcs, omap_plane->formats,
386 				       omap_plane->nformats, type, NULL);
387 	if (ret < 0)
388 		goto error;
389 
390 	drm_plane_helper_add(plane, &omap_plane_helper_funcs);
391 
392 	omap_plane_install_properties(plane, &plane->base);
393 
394 	return plane;
395 
396 error:
397 	omap_irq_unregister(plane->dev, &omap_plane->error_irq);
398 	kfree(omap_plane);
399 	return NULL;
400 }
401