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
39struct 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
50struct omap_plane_state {
51	struct drm_plane_state base;
52
53	unsigned int zorder;
54};
55
56static inline struct omap_plane_state *
57to_omap_plane_state(struct drm_plane_state *state)
58{
59	return container_of(state, struct omap_plane_state, base);
60}
61
62static int omap_plane_prepare_fb(struct drm_plane *plane,
63				 const 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
71static void omap_plane_cleanup_fb(struct drm_plane *plane,
72				  const struct drm_plane_state *old_state)
73{
74	if (old_state->fb)
75		omap_framebuffer_unpin(old_state->fb);
76}
77
78static 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	switch (state->rotation & DRM_ROTATE_MASK) {
112	case BIT(DRM_ROTATE_90):
113	case BIT(DRM_ROTATE_270):
114		win.src_w = state->src_h >> 16;
115		win.src_h = state->src_w >> 16;
116		break;
117	default:
118		win.src_w = state->src_w >> 16;
119		win.src_h = state->src_h >> 16;
120		break;
121	}
122
123	/* update scanout: */
124	omap_framebuffer_update_scanout(state->fb, &win, &info);
125
126	DBG("%dx%d -> %dx%d (%d)", info.width, info.height,
127			info.out_width, info.out_height,
128			info.screen_width);
129	DBG("%d,%d %pad %pad", info.pos_x, info.pos_y,
130			&info.paddr, &info.p_uv_addr);
131
132	dispc_ovl_set_channel_out(omap_plane->id,
133				  omap_crtc_channel(state->crtc));
134
135	/* and finally, update omapdss: */
136	ret = dispc_ovl_setup(omap_plane->id, &info, false,
137			      omap_crtc_timings(state->crtc), false);
138	if (WARN_ON(ret)) {
139		dispc_ovl_enable(omap_plane->id, false);
140		return;
141	}
142
143	dispc_ovl_enable(omap_plane->id, true);
144}
145
146static void omap_plane_atomic_disable(struct drm_plane *plane,
147				      struct drm_plane_state *old_state)
148{
149	struct omap_plane_state *omap_state = to_omap_plane_state(plane->state);
150	struct omap_plane *omap_plane = to_omap_plane(plane);
151
152	plane->state->rotation = BIT(DRM_ROTATE_0);
153	omap_state->zorder = plane->type == DRM_PLANE_TYPE_PRIMARY
154			   ? 0 : omap_plane->id;
155
156	dispc_ovl_enable(omap_plane->id, false);
157}
158
159static int omap_plane_atomic_check(struct drm_plane *plane,
160				   struct drm_plane_state *state)
161{
162	struct drm_crtc_state *crtc_state;
163
164	if (!state->crtc)
165		return 0;
166
167	crtc_state = drm_atomic_get_crtc_state(state->state, state->crtc);
168	if (IS_ERR(crtc_state))
169		return PTR_ERR(crtc_state);
170
171	if (state->crtc_x < 0 || state->crtc_y < 0)
172		return -EINVAL;
173
174	if (state->crtc_x + state->crtc_w > crtc_state->adjusted_mode.hdisplay)
175		return -EINVAL;
176
177	if (state->crtc_y + state->crtc_h > crtc_state->adjusted_mode.vdisplay)
178		return -EINVAL;
179
180	return 0;
181}
182
183static const struct drm_plane_helper_funcs omap_plane_helper_funcs = {
184	.prepare_fb = omap_plane_prepare_fb,
185	.cleanup_fb = omap_plane_cleanup_fb,
186	.atomic_check = omap_plane_atomic_check,
187	.atomic_update = omap_plane_atomic_update,
188	.atomic_disable = omap_plane_atomic_disable,
189};
190
191static void omap_plane_reset(struct drm_plane *plane)
192{
193	struct omap_plane *omap_plane = to_omap_plane(plane);
194	struct omap_plane_state *omap_state;
195
196	if (plane->state && plane->state->fb)
197		drm_framebuffer_unreference(plane->state->fb);
198
199	kfree(plane->state);
200	plane->state = NULL;
201
202	omap_state = kzalloc(sizeof(*omap_state), GFP_KERNEL);
203	if (omap_state == NULL)
204		return;
205
206	/*
207	 * Set defaults depending on whether we are a primary or overlay
208	 * plane.
209	 */
210	omap_state->zorder = plane->type == DRM_PLANE_TYPE_PRIMARY
211			   ? 0 : omap_plane->id;
212	omap_state->base.rotation = BIT(DRM_ROTATE_0);
213
214	plane->state = &omap_state->base;
215	plane->state->plane = plane;
216}
217
218static void omap_plane_destroy(struct drm_plane *plane)
219{
220	struct omap_plane *omap_plane = to_omap_plane(plane);
221
222	DBG("%s", omap_plane->name);
223
224	omap_irq_unregister(plane->dev, &omap_plane->error_irq);
225
226	drm_plane_cleanup(plane);
227
228	kfree(omap_plane);
229}
230
231/* helper to install properties which are common to planes and crtcs */
232void omap_plane_install_properties(struct drm_plane *plane,
233		struct drm_mode_object *obj)
234{
235	struct drm_device *dev = plane->dev;
236	struct omap_drm_private *priv = dev->dev_private;
237
238	if (priv->has_dmm) {
239		struct drm_property *prop = dev->mode_config.rotation_property;
240
241		drm_object_attach_property(obj, prop, 0);
242	}
243
244	drm_object_attach_property(obj, priv->zorder_prop, 0);
245}
246
247static struct drm_plane_state *
248omap_plane_atomic_duplicate_state(struct drm_plane *plane)
249{
250	struct omap_plane_state *state;
251	struct omap_plane_state *copy;
252
253	if (WARN_ON(!plane->state))
254		return NULL;
255
256	state = to_omap_plane_state(plane->state);
257	copy = kmemdup(state, sizeof(*state), GFP_KERNEL);
258	if (copy == NULL)
259		return NULL;
260
261	__drm_atomic_helper_plane_duplicate_state(plane, &copy->base);
262
263	return &copy->base;
264}
265
266static void omap_plane_atomic_destroy_state(struct drm_plane *plane,
267					    struct drm_plane_state *state)
268{
269	__drm_atomic_helper_plane_destroy_state(plane, state);
270	kfree(to_omap_plane_state(state));
271}
272
273static int omap_plane_atomic_set_property(struct drm_plane *plane,
274					  struct drm_plane_state *state,
275					  struct drm_property *property,
276					  uint64_t val)
277{
278	struct omap_drm_private *priv = plane->dev->dev_private;
279	struct omap_plane_state *omap_state = to_omap_plane_state(state);
280
281	if (property == priv->zorder_prop)
282		omap_state->zorder = val;
283	else
284		return -EINVAL;
285
286	return 0;
287}
288
289static int omap_plane_atomic_get_property(struct drm_plane *plane,
290					  const struct drm_plane_state *state,
291					  struct drm_property *property,
292					  uint64_t *val)
293{
294	struct omap_drm_private *priv = plane->dev->dev_private;
295	const struct omap_plane_state *omap_state =
296		container_of(state, const struct omap_plane_state, base);
297
298	if (property == priv->zorder_prop)
299		*val = omap_state->zorder;
300	else
301		return -EINVAL;
302
303	return 0;
304}
305
306static const struct drm_plane_funcs omap_plane_funcs = {
307	.update_plane = drm_atomic_helper_update_plane,
308	.disable_plane = drm_atomic_helper_disable_plane,
309	.reset = omap_plane_reset,
310	.destroy = omap_plane_destroy,
311	.set_property = drm_atomic_helper_plane_set_property,
312	.atomic_duplicate_state = omap_plane_atomic_duplicate_state,
313	.atomic_destroy_state = omap_plane_atomic_destroy_state,
314	.atomic_set_property = omap_plane_atomic_set_property,
315	.atomic_get_property = omap_plane_atomic_get_property,
316};
317
318static void omap_plane_error_irq(struct omap_drm_irq *irq, uint32_t irqstatus)
319{
320	struct omap_plane *omap_plane =
321			container_of(irq, struct omap_plane, error_irq);
322	DRM_ERROR_RATELIMITED("%s: errors: %08x\n", omap_plane->name,
323		irqstatus);
324}
325
326static const char *plane_names[] = {
327	[OMAP_DSS_GFX] = "gfx",
328	[OMAP_DSS_VIDEO1] = "vid1",
329	[OMAP_DSS_VIDEO2] = "vid2",
330	[OMAP_DSS_VIDEO3] = "vid3",
331};
332
333static const uint32_t error_irqs[] = {
334	[OMAP_DSS_GFX] = DISPC_IRQ_GFX_FIFO_UNDERFLOW,
335	[OMAP_DSS_VIDEO1] = DISPC_IRQ_VID1_FIFO_UNDERFLOW,
336	[OMAP_DSS_VIDEO2] = DISPC_IRQ_VID2_FIFO_UNDERFLOW,
337	[OMAP_DSS_VIDEO3] = DISPC_IRQ_VID3_FIFO_UNDERFLOW,
338};
339
340/* initialize plane */
341struct drm_plane *omap_plane_init(struct drm_device *dev,
342		int id, enum drm_plane_type type)
343{
344	struct omap_drm_private *priv = dev->dev_private;
345	struct drm_plane *plane;
346	struct omap_plane *omap_plane;
347	int ret;
348
349	DBG("%s: type=%d", plane_names[id], type);
350
351	omap_plane = kzalloc(sizeof(*omap_plane), GFP_KERNEL);
352	if (!omap_plane)
353		return ERR_PTR(-ENOMEM);
354
355	omap_plane->nformats = omap_framebuffer_get_formats(
356			omap_plane->formats, ARRAY_SIZE(omap_plane->formats),
357			dss_feat_get_supported_color_modes(id));
358	omap_plane->id = id;
359	omap_plane->name = plane_names[id];
360
361	plane = &omap_plane->base;
362
363	omap_plane->error_irq.irqmask = error_irqs[id];
364	omap_plane->error_irq.irq = omap_plane_error_irq;
365	omap_irq_register(dev, &omap_plane->error_irq);
366
367	ret = drm_universal_plane_init(dev, plane, (1 << priv->num_crtcs) - 1,
368				       &omap_plane_funcs, omap_plane->formats,
369				       omap_plane->nformats, type);
370	if (ret < 0)
371		goto error;
372
373	drm_plane_helper_add(plane, &omap_plane_helper_funcs);
374
375	omap_plane_install_properties(plane, &plane->base);
376
377	return plane;
378
379error:
380	omap_irq_unregister(plane->dev, &omap_plane->error_irq);
381	kfree(omap_plane);
382	return NULL;
383}
384