1 /*
2  * (C) COPYRIGHT 2016 ARM Limited. All rights reserved.
3  * Author: Liviu Dudau <Liviu.Dudau@arm.com>
4  *
5  * This program is free software and is provided to you under the terms of the
6  * GNU General Public License version 2 as published by the Free Software
7  * Foundation, and any use by you of this program is subject to the terms
8  * of such GNU licence.
9  *
10  * ARM Mali DP plane manipulation routines.
11  */
12 
13 #include <drm/drmP.h>
14 #include <drm/drm_atomic.h>
15 #include <drm/drm_atomic_helper.h>
16 #include <drm/drm_fb_cma_helper.h>
17 #include <drm/drm_gem_cma_helper.h>
18 #include <drm/drm_plane_helper.h>
19 #include <drm/drm_print.h>
20 
21 #include "malidp_hw.h"
22 #include "malidp_drv.h"
23 
24 /* Layer specific register offsets */
25 #define MALIDP_LAYER_FORMAT		0x000
26 #define MALIDP_LAYER_CONTROL		0x004
27 #define   LAYER_ENABLE			(1 << 0)
28 #define   LAYER_FLOWCFG_MASK		7
29 #define   LAYER_FLOWCFG(x)		(((x) & LAYER_FLOWCFG_MASK) << 1)
30 #define     LAYER_FLOWCFG_SCALE_SE	3
31 #define   LAYER_ROT_OFFSET		8
32 #define   LAYER_H_FLIP			(1 << 10)
33 #define   LAYER_V_FLIP			(1 << 11)
34 #define   LAYER_ROT_MASK		(0xf << 8)
35 #define   LAYER_COMP_MASK		(0x3 << 12)
36 #define   LAYER_COMP_PIXEL		(0x3 << 12)
37 #define   LAYER_COMP_PLANE		(0x2 << 12)
38 #define MALIDP_LAYER_COMPOSE		0x008
39 #define MALIDP_LAYER_SIZE		0x00c
40 #define   LAYER_H_VAL(x)		(((x) & 0x1fff) << 0)
41 #define   LAYER_V_VAL(x)		(((x) & 0x1fff) << 16)
42 #define MALIDP_LAYER_COMP_SIZE		0x010
43 #define MALIDP_LAYER_OFFSET		0x014
44 #define MALIDP550_LS_ENABLE		0x01c
45 #define MALIDP550_LS_R1_IN_SIZE		0x020
46 
47 /*
48  * This 4-entry look-up-table is used to determine the full 8-bit alpha value
49  * for formats with 1- or 2-bit alpha channels.
50  * We set it to give 100%/0% opacity for 1-bit formats and 100%/66%/33%/0%
51  * opacity for 2-bit formats.
52  */
53 #define MALIDP_ALPHA_LUT 0xffaa5500
54 
55 static void malidp_de_plane_destroy(struct drm_plane *plane)
56 {
57 	struct malidp_plane *mp = to_malidp_plane(plane);
58 
59 	if (mp->base.fb)
60 		drm_framebuffer_put(mp->base.fb);
61 
62 	drm_plane_helper_disable(plane);
63 	drm_plane_cleanup(plane);
64 	devm_kfree(plane->dev->dev, mp);
65 }
66 
67 /*
68  * Replicate what the default ->reset hook does: free the state pointer and
69  * allocate a new empty object. We just need enough space to store
70  * a malidp_plane_state instead of a drm_plane_state.
71  */
72 static void malidp_plane_reset(struct drm_plane *plane)
73 {
74 	struct malidp_plane_state *state = to_malidp_plane_state(plane->state);
75 
76 	if (state)
77 		__drm_atomic_helper_plane_destroy_state(&state->base);
78 	kfree(state);
79 	plane->state = NULL;
80 	state = kzalloc(sizeof(*state), GFP_KERNEL);
81 	if (state) {
82 		state->base.plane = plane;
83 		state->base.rotation = DRM_MODE_ROTATE_0;
84 		plane->state = &state->base;
85 	}
86 }
87 
88 static struct
89 drm_plane_state *malidp_duplicate_plane_state(struct drm_plane *plane)
90 {
91 	struct malidp_plane_state *state, *m_state;
92 
93 	if (!plane->state)
94 		return NULL;
95 
96 	state = kmalloc(sizeof(*state), GFP_KERNEL);
97 	if (!state)
98 		return NULL;
99 
100 	m_state = to_malidp_plane_state(plane->state);
101 	__drm_atomic_helper_plane_duplicate_state(plane, &state->base);
102 	state->rotmem_size = m_state->rotmem_size;
103 	state->format = m_state->format;
104 	state->n_planes = m_state->n_planes;
105 
106 	return &state->base;
107 }
108 
109 static void malidp_destroy_plane_state(struct drm_plane *plane,
110 				       struct drm_plane_state *state)
111 {
112 	struct malidp_plane_state *m_state = to_malidp_plane_state(state);
113 
114 	__drm_atomic_helper_plane_destroy_state(state);
115 	kfree(m_state);
116 }
117 
118 static void malidp_plane_atomic_print_state(struct drm_printer *p,
119 					    const struct drm_plane_state *state)
120 {
121 	struct malidp_plane_state *ms = to_malidp_plane_state(state);
122 
123 	drm_printf(p, "\trotmem_size=%u\n", ms->rotmem_size);
124 	drm_printf(p, "\tformat_id=%u\n", ms->format);
125 	drm_printf(p, "\tn_planes=%u\n", ms->n_planes);
126 }
127 
128 static const struct drm_plane_funcs malidp_de_plane_funcs = {
129 	.update_plane = drm_atomic_helper_update_plane,
130 	.disable_plane = drm_atomic_helper_disable_plane,
131 	.destroy = malidp_de_plane_destroy,
132 	.reset = malidp_plane_reset,
133 	.atomic_duplicate_state = malidp_duplicate_plane_state,
134 	.atomic_destroy_state = malidp_destroy_plane_state,
135 	.atomic_print_state = malidp_plane_atomic_print_state,
136 };
137 
138 static int malidp_se_check_scaling(struct malidp_plane *mp,
139 				   struct drm_plane_state *state)
140 {
141 	struct drm_crtc_state *crtc_state =
142 		drm_atomic_get_existing_crtc_state(state->state, state->crtc);
143 	struct malidp_crtc_state *mc;
144 	struct drm_rect clip = { 0 };
145 	u32 src_w, src_h;
146 	int ret;
147 
148 	if (!crtc_state)
149 		return -EINVAL;
150 
151 	if (crtc_state->enable)
152 		drm_mode_get_hv_timing(&crtc_state->mode,
153 				       &clip.x2, &clip.y2);
154 
155 	ret = drm_atomic_helper_check_plane_state(state, crtc_state, &clip,
156 						  0, INT_MAX, true, true);
157 	if (ret)
158 		return ret;
159 
160 	src_w = state->src_w >> 16;
161 	src_h = state->src_h >> 16;
162 	if ((state->crtc_w == src_w) && (state->crtc_h == src_h)) {
163 		/* Scaling not necessary for this plane. */
164 		mc->scaled_planes_mask &= ~(mp->layer->id);
165 		return 0;
166 	}
167 
168 	if (mp->layer->id & (DE_SMART | DE_GRAPHICS2))
169 		return -EINVAL;
170 
171 	mc = to_malidp_crtc_state(crtc_state);
172 
173 	mc->scaled_planes_mask |= mp->layer->id;
174 	/* Defer scaling requirements calculation to the crtc check. */
175 	return 0;
176 }
177 
178 static int malidp_de_plane_check(struct drm_plane *plane,
179 				 struct drm_plane_state *state)
180 {
181 	struct malidp_plane *mp = to_malidp_plane(plane);
182 	struct malidp_plane_state *ms = to_malidp_plane_state(state);
183 	struct drm_framebuffer *fb;
184 	int i, ret;
185 
186 	if (!state->crtc || !state->fb)
187 		return 0;
188 
189 	fb = state->fb;
190 
191 	ms->format = malidp_hw_get_format_id(&mp->hwdev->hw->map,
192 					     mp->layer->id,
193 					     fb->format->format);
194 	if (ms->format == MALIDP_INVALID_FORMAT_ID)
195 		return -EINVAL;
196 
197 	ms->n_planes = fb->format->num_planes;
198 	for (i = 0; i < ms->n_planes; i++) {
199 		if (!malidp_hw_pitch_valid(mp->hwdev, fb->pitches[i])) {
200 			DRM_DEBUG_KMS("Invalid pitch %u for plane %d\n",
201 				      fb->pitches[i], i);
202 			return -EINVAL;
203 		}
204 	}
205 
206 	if ((state->crtc_w > mp->hwdev->max_line_size) ||
207 	    (state->crtc_h > mp->hwdev->max_line_size) ||
208 	    (state->crtc_w < mp->hwdev->min_line_size) ||
209 	    (state->crtc_h < mp->hwdev->min_line_size))
210 		return -EINVAL;
211 
212 	/*
213 	 * DP550/650 video layers can accept 3 plane formats only if
214 	 * fb->pitches[1] == fb->pitches[2] since they don't have a
215 	 * third plane stride register.
216 	 */
217 	if (ms->n_planes == 3 &&
218 	    !(mp->hwdev->hw->features & MALIDP_DEVICE_LV_HAS_3_STRIDES) &&
219 	    (state->fb->pitches[1] != state->fb->pitches[2]))
220 		return -EINVAL;
221 
222 	ret = malidp_se_check_scaling(mp, state);
223 	if (ret)
224 		return ret;
225 
226 	/* packed RGB888 / BGR888 can't be rotated or flipped */
227 	if (state->rotation != DRM_MODE_ROTATE_0 &&
228 	    (fb->format->format == DRM_FORMAT_RGB888 ||
229 	     fb->format->format == DRM_FORMAT_BGR888))
230 		return -EINVAL;
231 
232 	ms->rotmem_size = 0;
233 	if (state->rotation & MALIDP_ROTATED_MASK) {
234 		int val;
235 
236 		val = mp->hwdev->hw->rotmem_required(mp->hwdev, state->crtc_h,
237 						     state->crtc_w,
238 						     fb->format->format);
239 		if (val < 0)
240 			return val;
241 
242 		ms->rotmem_size = val;
243 	}
244 
245 	return 0;
246 }
247 
248 static void malidp_de_set_plane_pitches(struct malidp_plane *mp,
249 					int num_planes, unsigned int pitches[3])
250 {
251 	int i;
252 	int num_strides = num_planes;
253 
254 	if (!mp->layer->stride_offset)
255 		return;
256 
257 	if (num_planes == 3)
258 		num_strides = (mp->hwdev->hw->features &
259 			       MALIDP_DEVICE_LV_HAS_3_STRIDES) ? 3 : 2;
260 
261 	for (i = 0; i < num_strides; ++i)
262 		malidp_hw_write(mp->hwdev, pitches[i],
263 				mp->layer->base +
264 				mp->layer->stride_offset + i * 4);
265 }
266 
267 static void malidp_de_plane_update(struct drm_plane *plane,
268 				   struct drm_plane_state *old_state)
269 {
270 	struct malidp_plane *mp;
271 	struct malidp_plane_state *ms = to_malidp_plane_state(plane->state);
272 	u32 src_w, src_h, dest_w, dest_h, val;
273 	int i;
274 
275 	mp = to_malidp_plane(plane);
276 
277 	/* convert src values from Q16 fixed point to integer */
278 	src_w = plane->state->src_w >> 16;
279 	src_h = plane->state->src_h >> 16;
280 	dest_w = plane->state->crtc_w;
281 	dest_h = plane->state->crtc_h;
282 
283 	malidp_hw_write(mp->hwdev, ms->format, mp->layer->base);
284 
285 	for (i = 0; i < ms->n_planes; i++) {
286 		/* calculate the offset for the layer's plane registers */
287 		u16 ptr = mp->layer->ptr + (i << 4);
288 		dma_addr_t fb_addr = drm_fb_cma_get_gem_addr(plane->state->fb,
289 							     plane->state, i);
290 
291 		malidp_hw_write(mp->hwdev, lower_32_bits(fb_addr), ptr);
292 		malidp_hw_write(mp->hwdev, upper_32_bits(fb_addr), ptr + 4);
293 	}
294 	malidp_de_set_plane_pitches(mp, ms->n_planes,
295 				    plane->state->fb->pitches);
296 
297 	malidp_hw_write(mp->hwdev, LAYER_H_VAL(src_w) | LAYER_V_VAL(src_h),
298 			mp->layer->base + MALIDP_LAYER_SIZE);
299 
300 	malidp_hw_write(mp->hwdev, LAYER_H_VAL(dest_w) | LAYER_V_VAL(dest_h),
301 			mp->layer->base + MALIDP_LAYER_COMP_SIZE);
302 
303 	malidp_hw_write(mp->hwdev, LAYER_H_VAL(plane->state->crtc_x) |
304 			LAYER_V_VAL(plane->state->crtc_y),
305 			mp->layer->base + MALIDP_LAYER_OFFSET);
306 
307 	if (mp->layer->id == DE_SMART)
308 		malidp_hw_write(mp->hwdev,
309 				LAYER_H_VAL(src_w) | LAYER_V_VAL(src_h),
310 				mp->layer->base + MALIDP550_LS_R1_IN_SIZE);
311 
312 	/* first clear the rotation bits */
313 	val = malidp_hw_read(mp->hwdev, mp->layer->base + MALIDP_LAYER_CONTROL);
314 	val &= ~LAYER_ROT_MASK;
315 
316 	/* setup the rotation and axis flip bits */
317 	if (plane->state->rotation & DRM_MODE_ROTATE_MASK)
318 		val |= ilog2(plane->state->rotation & DRM_MODE_ROTATE_MASK) <<
319 		       LAYER_ROT_OFFSET;
320 	if (plane->state->rotation & DRM_MODE_REFLECT_X)
321 		val |= LAYER_H_FLIP;
322 	if (plane->state->rotation & DRM_MODE_REFLECT_Y)
323 		val |= LAYER_V_FLIP;
324 
325 	/*
326 	 * always enable pixel alpha blending until we have a way to change
327 	 * blend modes
328 	 */
329 	val &= ~LAYER_COMP_MASK;
330 	val |= LAYER_COMP_PIXEL;
331 
332 	val &= ~LAYER_FLOWCFG(LAYER_FLOWCFG_MASK);
333 	if (plane->state->crtc) {
334 		struct malidp_crtc_state *m =
335 			to_malidp_crtc_state(plane->state->crtc->state);
336 
337 		if (m->scaler_config.scale_enable &&
338 		    m->scaler_config.plane_src_id == mp->layer->id)
339 			val |= LAYER_FLOWCFG(LAYER_FLOWCFG_SCALE_SE);
340 	}
341 
342 	/* set the 'enable layer' bit */
343 	val |= LAYER_ENABLE;
344 
345 	malidp_hw_write(mp->hwdev, val,
346 			mp->layer->base + MALIDP_LAYER_CONTROL);
347 }
348 
349 static void malidp_de_plane_disable(struct drm_plane *plane,
350 				    struct drm_plane_state *state)
351 {
352 	struct malidp_plane *mp = to_malidp_plane(plane);
353 
354 	malidp_hw_clearbits(mp->hwdev,
355 			    LAYER_ENABLE | LAYER_FLOWCFG(LAYER_FLOWCFG_MASK),
356 			    mp->layer->base + MALIDP_LAYER_CONTROL);
357 }
358 
359 static const struct drm_plane_helper_funcs malidp_de_plane_helper_funcs = {
360 	.atomic_check = malidp_de_plane_check,
361 	.atomic_update = malidp_de_plane_update,
362 	.atomic_disable = malidp_de_plane_disable,
363 };
364 
365 int malidp_de_planes_init(struct drm_device *drm)
366 {
367 	struct malidp_drm *malidp = drm->dev_private;
368 	const struct malidp_hw_regmap *map = &malidp->dev->hw->map;
369 	struct malidp_plane *plane = NULL;
370 	enum drm_plane_type plane_type;
371 	unsigned long crtcs = 1 << drm->mode_config.num_crtc;
372 	unsigned long flags = DRM_MODE_ROTATE_0 | DRM_MODE_ROTATE_90 | DRM_MODE_ROTATE_180 |
373 			      DRM_MODE_ROTATE_270 | DRM_MODE_REFLECT_X | DRM_MODE_REFLECT_Y;
374 	u32 *formats;
375 	int ret, i, j, n;
376 
377 	formats = kcalloc(map->n_pixel_formats, sizeof(*formats), GFP_KERNEL);
378 	if (!formats) {
379 		ret = -ENOMEM;
380 		goto cleanup;
381 	}
382 
383 	for (i = 0; i < map->n_layers; i++) {
384 		u8 id = map->layers[i].id;
385 
386 		plane = kzalloc(sizeof(*plane), GFP_KERNEL);
387 		if (!plane) {
388 			ret = -ENOMEM;
389 			goto cleanup;
390 		}
391 
392 		/* build the list of DRM supported formats based on the map */
393 		for (n = 0, j = 0;  j < map->n_pixel_formats; j++) {
394 			if ((map->pixel_formats[j].layer & id) == id)
395 				formats[n++] = map->pixel_formats[j].format;
396 		}
397 
398 		plane_type = (i == 0) ? DRM_PLANE_TYPE_PRIMARY :
399 					DRM_PLANE_TYPE_OVERLAY;
400 		ret = drm_universal_plane_init(drm, &plane->base, crtcs,
401 					       &malidp_de_plane_funcs, formats,
402 					       n, NULL, plane_type, NULL);
403 		if (ret < 0)
404 			goto cleanup;
405 
406 		drm_plane_helper_add(&plane->base,
407 				     &malidp_de_plane_helper_funcs);
408 		plane->hwdev = malidp->dev;
409 		plane->layer = &map->layers[i];
410 
411 		if (id == DE_SMART) {
412 			/*
413 			 * Enable the first rectangle in the SMART layer to be
414 			 * able to use it as a drm plane.
415 			 */
416 			malidp_hw_write(malidp->dev, 1,
417 					plane->layer->base + MALIDP550_LS_ENABLE);
418 			/* Skip the features which the SMART layer doesn't have. */
419 			continue;
420 		}
421 
422 		drm_plane_create_rotation_property(&plane->base, DRM_MODE_ROTATE_0, flags);
423 		malidp_hw_write(malidp->dev, MALIDP_ALPHA_LUT,
424 				plane->layer->base + MALIDP_LAYER_COMPOSE);
425 	}
426 
427 	kfree(formats);
428 
429 	return 0;
430 
431 cleanup:
432 	malidp_de_planes_destroy(drm);
433 	kfree(formats);
434 
435 	return ret;
436 }
437 
438 void malidp_de_planes_destroy(struct drm_device *drm)
439 {
440 	struct drm_plane *p, *pt;
441 
442 	list_for_each_entry_safe(p, pt, &drm->mode_config.plane_list, head) {
443 		drm_plane_cleanup(p);
444 		kfree(p);
445 	}
446 }
447