xref: /openbmc/linux/drivers/gpu/drm/sti/sti_cursor.c (revision dc6a81c3)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) STMicroelectronics SA 2014
4  * Authors: Vincent Abriou <vincent.abriou@st.com>
5  *          Fabien Dessenne <fabien.dessenne@st.com>
6  *          for STMicroelectronics.
7  */
8 
9 #include <linux/dma-mapping.h>
10 #include <linux/seq_file.h>
11 
12 #include <drm/drm_atomic.h>
13 #include <drm/drm_device.h>
14 #include <drm/drm_fb_cma_helper.h>
15 #include <drm/drm_gem_cma_helper.h>
16 
17 #include "sti_compositor.h"
18 #include "sti_cursor.h"
19 #include "sti_plane.h"
20 #include "sti_vtg.h"
21 
22 /* Registers */
23 #define CUR_CTL             0x00
24 #define CUR_VPO             0x0C
25 #define CUR_PML             0x14
26 #define CUR_PMP             0x18
27 #define CUR_SIZE            0x1C
28 #define CUR_CML             0x20
29 #define CUR_AWS             0x28
30 #define CUR_AWE             0x2C
31 
32 #define CUR_CTL_CLUT_UPDATE BIT(1)
33 
34 #define STI_CURS_MIN_SIZE   1
35 #define STI_CURS_MAX_SIZE   128
36 
37 /*
38  * pixmap dma buffer structure
39  *
40  * @paddr:  physical address
41  * @size:   buffer size
42  * @base:   virtual address
43  */
44 struct dma_pixmap {
45 	dma_addr_t paddr;
46 	size_t size;
47 	void *base;
48 };
49 
50 /*
51  * STI Cursor structure
52  *
53  * @sti_plane:    sti_plane structure
54  * @dev:          driver device
55  * @regs:         cursor registers
56  * @width:        cursor width
57  * @height:       cursor height
58  * @clut:         color look up table
59  * @clut_paddr:   color look up table physical address
60  * @pixmap:       pixmap dma buffer (clut8-format cursor)
61  */
62 struct sti_cursor {
63 	struct sti_plane plane;
64 	struct device *dev;
65 	void __iomem *regs;
66 	unsigned int width;
67 	unsigned int height;
68 	unsigned short *clut;
69 	dma_addr_t clut_paddr;
70 	struct dma_pixmap pixmap;
71 };
72 
73 static const uint32_t cursor_supported_formats[] = {
74 	DRM_FORMAT_ARGB8888,
75 };
76 
77 #define to_sti_cursor(x) container_of(x, struct sti_cursor, plane)
78 
79 #define DBGFS_DUMP(reg) seq_printf(s, "\n  %-25s 0x%08X", #reg, \
80 				   readl(cursor->regs + reg))
81 
82 static void cursor_dbg_vpo(struct seq_file *s, u32 val)
83 {
84 	seq_printf(s, "\txdo:%4d\tydo:%4d", val & 0x0FFF, (val >> 16) & 0x0FFF);
85 }
86 
87 static void cursor_dbg_size(struct seq_file *s, u32 val)
88 {
89 	seq_printf(s, "\t%d x %d", val & 0x07FF, (val >> 16) & 0x07FF);
90 }
91 
92 static void cursor_dbg_pml(struct seq_file *s,
93 			   struct sti_cursor *cursor, u32 val)
94 {
95 	if (cursor->pixmap.paddr == val)
96 		seq_printf(s, "\tVirt @: %p", cursor->pixmap.base);
97 }
98 
99 static void cursor_dbg_cml(struct seq_file *s,
100 			   struct sti_cursor *cursor, u32 val)
101 {
102 	if (cursor->clut_paddr == val)
103 		seq_printf(s, "\tVirt @: %p", cursor->clut);
104 }
105 
106 static int cursor_dbg_show(struct seq_file *s, void *data)
107 {
108 	struct drm_info_node *node = s->private;
109 	struct sti_cursor *cursor = (struct sti_cursor *)node->info_ent->data;
110 
111 	seq_printf(s, "%s: (vaddr = 0x%p)",
112 		   sti_plane_to_str(&cursor->plane), cursor->regs);
113 
114 	DBGFS_DUMP(CUR_CTL);
115 	DBGFS_DUMP(CUR_VPO);
116 	cursor_dbg_vpo(s, readl(cursor->regs + CUR_VPO));
117 	DBGFS_DUMP(CUR_PML);
118 	cursor_dbg_pml(s, cursor, readl(cursor->regs + CUR_PML));
119 	DBGFS_DUMP(CUR_PMP);
120 	DBGFS_DUMP(CUR_SIZE);
121 	cursor_dbg_size(s, readl(cursor->regs + CUR_SIZE));
122 	DBGFS_DUMP(CUR_CML);
123 	cursor_dbg_cml(s, cursor, readl(cursor->regs + CUR_CML));
124 	DBGFS_DUMP(CUR_AWS);
125 	DBGFS_DUMP(CUR_AWE);
126 	seq_putc(s, '\n');
127 	return 0;
128 }
129 
130 static struct drm_info_list cursor_debugfs_files[] = {
131 	{ "cursor", cursor_dbg_show, 0, NULL },
132 };
133 
134 static int cursor_debugfs_init(struct sti_cursor *cursor,
135 			       struct drm_minor *minor)
136 {
137 	unsigned int i;
138 
139 	for (i = 0; i < ARRAY_SIZE(cursor_debugfs_files); i++)
140 		cursor_debugfs_files[i].data = cursor;
141 
142 	return drm_debugfs_create_files(cursor_debugfs_files,
143 					ARRAY_SIZE(cursor_debugfs_files),
144 					minor->debugfs_root, minor);
145 }
146 
147 static void sti_cursor_argb8888_to_clut8(struct sti_cursor *cursor, u32 *src)
148 {
149 	u8  *dst = cursor->pixmap.base;
150 	unsigned int i, j;
151 	u32 a, r, g, b;
152 
153 	for (i = 0; i < cursor->height; i++) {
154 		for (j = 0; j < cursor->width; j++) {
155 			/* Pick the 2 higher bits of each component */
156 			a = (*src >> 30) & 3;
157 			r = (*src >> 22) & 3;
158 			g = (*src >> 14) & 3;
159 			b = (*src >> 6) & 3;
160 			*dst = a << 6 | r << 4 | g << 2 | b;
161 			src++;
162 			dst++;
163 		}
164 	}
165 }
166 
167 static void sti_cursor_init(struct sti_cursor *cursor)
168 {
169 	unsigned short *base = cursor->clut;
170 	unsigned int a, r, g, b;
171 
172 	/* Assign CLUT values, ARGB444 format */
173 	for (a = 0; a < 4; a++)
174 		for (r = 0; r < 4; r++)
175 			for (g = 0; g < 4; g++)
176 				for (b = 0; b < 4; b++)
177 					*base++ = (a * 5) << 12 |
178 						  (r * 5) << 8 |
179 						  (g * 5) << 4 |
180 						  (b * 5);
181 }
182 
183 static int sti_cursor_atomic_check(struct drm_plane *drm_plane,
184 				   struct drm_plane_state *state)
185 {
186 	struct sti_plane *plane = to_sti_plane(drm_plane);
187 	struct sti_cursor *cursor = to_sti_cursor(plane);
188 	struct drm_crtc *crtc = state->crtc;
189 	struct drm_framebuffer *fb = state->fb;
190 	struct drm_crtc_state *crtc_state;
191 	struct drm_display_mode *mode;
192 	int dst_x, dst_y, dst_w, dst_h;
193 	int src_w, src_h;
194 
195 	/* no need for further checks if the plane is being disabled */
196 	if (!crtc || !fb)
197 		return 0;
198 
199 	crtc_state = drm_atomic_get_crtc_state(state->state, crtc);
200 	mode = &crtc_state->mode;
201 	dst_x = state->crtc_x;
202 	dst_y = state->crtc_y;
203 	dst_w = clamp_val(state->crtc_w, 0, mode->crtc_hdisplay - dst_x);
204 	dst_h = clamp_val(state->crtc_h, 0, mode->crtc_vdisplay - dst_y);
205 	/* src_x are in 16.16 format */
206 	src_w = state->src_w >> 16;
207 	src_h = state->src_h >> 16;
208 
209 	if (src_w < STI_CURS_MIN_SIZE ||
210 	    src_h < STI_CURS_MIN_SIZE ||
211 	    src_w > STI_CURS_MAX_SIZE ||
212 	    src_h > STI_CURS_MAX_SIZE) {
213 		DRM_ERROR("Invalid cursor size (%dx%d)\n",
214 				src_w, src_h);
215 		return -EINVAL;
216 	}
217 
218 	/* If the cursor size has changed, re-allocated the pixmap */
219 	if (!cursor->pixmap.base ||
220 	    (cursor->width != src_w) ||
221 	    (cursor->height != src_h)) {
222 		cursor->width = src_w;
223 		cursor->height = src_h;
224 
225 		if (cursor->pixmap.base)
226 			dma_free_wc(cursor->dev, cursor->pixmap.size,
227 				    cursor->pixmap.base, cursor->pixmap.paddr);
228 
229 		cursor->pixmap.size = cursor->width * cursor->height;
230 
231 		cursor->pixmap.base = dma_alloc_wc(cursor->dev,
232 						   cursor->pixmap.size,
233 						   &cursor->pixmap.paddr,
234 						   GFP_KERNEL | GFP_DMA);
235 		if (!cursor->pixmap.base) {
236 			DRM_ERROR("Failed to allocate memory for pixmap\n");
237 			return -EINVAL;
238 		}
239 	}
240 
241 	if (!drm_fb_cma_get_gem_obj(fb, 0)) {
242 		DRM_ERROR("Can't get CMA GEM object for fb\n");
243 		return -EINVAL;
244 	}
245 
246 	DRM_DEBUG_KMS("CRTC:%d (%s) drm plane:%d (%s)\n",
247 		      crtc->base.id, sti_mixer_to_str(to_sti_mixer(crtc)),
248 		      drm_plane->base.id, sti_plane_to_str(plane));
249 	DRM_DEBUG_KMS("(%dx%d)@(%d,%d)\n", dst_w, dst_h, dst_x, dst_y);
250 
251 	return 0;
252 }
253 
254 static void sti_cursor_atomic_update(struct drm_plane *drm_plane,
255 				     struct drm_plane_state *oldstate)
256 {
257 	struct drm_plane_state *state = drm_plane->state;
258 	struct sti_plane *plane = to_sti_plane(drm_plane);
259 	struct sti_cursor *cursor = to_sti_cursor(plane);
260 	struct drm_crtc *crtc = state->crtc;
261 	struct drm_framebuffer *fb = state->fb;
262 	struct drm_display_mode *mode;
263 	int dst_x, dst_y;
264 	struct drm_gem_cma_object *cma_obj;
265 	u32 y, x;
266 	u32 val;
267 
268 	if (!crtc || !fb)
269 		return;
270 
271 	mode = &crtc->mode;
272 	dst_x = state->crtc_x;
273 	dst_y = state->crtc_y;
274 
275 	cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
276 
277 	/* Convert ARGB8888 to CLUT8 */
278 	sti_cursor_argb8888_to_clut8(cursor, (u32 *)cma_obj->vaddr);
279 
280 	/* AWS and AWE depend on the mode */
281 	y = sti_vtg_get_line_number(*mode, 0);
282 	x = sti_vtg_get_pixel_number(*mode, 0);
283 	val = y << 16 | x;
284 	writel(val, cursor->regs + CUR_AWS);
285 	y = sti_vtg_get_line_number(*mode, mode->vdisplay - 1);
286 	x = sti_vtg_get_pixel_number(*mode, mode->hdisplay - 1);
287 	val = y << 16 | x;
288 	writel(val, cursor->regs + CUR_AWE);
289 
290 	/* Set memory location, size, and position */
291 	writel(cursor->pixmap.paddr, cursor->regs + CUR_PML);
292 	writel(cursor->width, cursor->regs + CUR_PMP);
293 	writel(cursor->height << 16 | cursor->width, cursor->regs + CUR_SIZE);
294 
295 	y = sti_vtg_get_line_number(*mode, dst_y);
296 	x = sti_vtg_get_pixel_number(*mode, dst_x);
297 	writel((y << 16) | x, cursor->regs + CUR_VPO);
298 
299 	/* Set and fetch CLUT */
300 	writel(cursor->clut_paddr, cursor->regs + CUR_CML);
301 	writel(CUR_CTL_CLUT_UPDATE, cursor->regs + CUR_CTL);
302 
303 	sti_plane_update_fps(plane, true, false);
304 
305 	plane->status = STI_PLANE_UPDATED;
306 }
307 
308 static void sti_cursor_atomic_disable(struct drm_plane *drm_plane,
309 				      struct drm_plane_state *oldstate)
310 {
311 	struct sti_plane *plane = to_sti_plane(drm_plane);
312 
313 	if (!oldstate->crtc) {
314 		DRM_DEBUG_DRIVER("drm plane:%d not enabled\n",
315 				 drm_plane->base.id);
316 		return;
317 	}
318 
319 	DRM_DEBUG_DRIVER("CRTC:%d (%s) drm plane:%d (%s)\n",
320 			 oldstate->crtc->base.id,
321 			 sti_mixer_to_str(to_sti_mixer(oldstate->crtc)),
322 			 drm_plane->base.id, sti_plane_to_str(plane));
323 
324 	plane->status = STI_PLANE_DISABLING;
325 }
326 
327 static const struct drm_plane_helper_funcs sti_cursor_helpers_funcs = {
328 	.atomic_check = sti_cursor_atomic_check,
329 	.atomic_update = sti_cursor_atomic_update,
330 	.atomic_disable = sti_cursor_atomic_disable,
331 };
332 
333 static void sti_cursor_destroy(struct drm_plane *drm_plane)
334 {
335 	DRM_DEBUG_DRIVER("\n");
336 
337 	drm_plane_cleanup(drm_plane);
338 }
339 
340 static int sti_cursor_late_register(struct drm_plane *drm_plane)
341 {
342 	struct sti_plane *plane = to_sti_plane(drm_plane);
343 	struct sti_cursor *cursor = to_sti_cursor(plane);
344 
345 	return cursor_debugfs_init(cursor, drm_plane->dev->primary);
346 }
347 
348 static const struct drm_plane_funcs sti_cursor_plane_helpers_funcs = {
349 	.update_plane = drm_atomic_helper_update_plane,
350 	.disable_plane = drm_atomic_helper_disable_plane,
351 	.destroy = sti_cursor_destroy,
352 	.reset = sti_plane_reset,
353 	.atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
354 	.atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
355 	.late_register = sti_cursor_late_register,
356 };
357 
358 struct drm_plane *sti_cursor_create(struct drm_device *drm_dev,
359 				    struct device *dev, int desc,
360 				    void __iomem *baseaddr,
361 				    unsigned int possible_crtcs)
362 {
363 	struct sti_cursor *cursor;
364 	size_t size;
365 	int res;
366 
367 	cursor = devm_kzalloc(dev, sizeof(*cursor), GFP_KERNEL);
368 	if (!cursor) {
369 		DRM_ERROR("Failed to allocate memory for cursor\n");
370 		return NULL;
371 	}
372 
373 	/* Allocate clut buffer */
374 	size = 0x100 * sizeof(unsigned short);
375 	cursor->clut = dma_alloc_wc(dev, size, &cursor->clut_paddr,
376 				    GFP_KERNEL | GFP_DMA);
377 
378 	if (!cursor->clut) {
379 		DRM_ERROR("Failed to allocate memory for cursor clut\n");
380 		goto err_clut;
381 	}
382 
383 	cursor->dev = dev;
384 	cursor->regs = baseaddr;
385 	cursor->plane.desc = desc;
386 	cursor->plane.status = STI_PLANE_DISABLED;
387 
388 	sti_cursor_init(cursor);
389 
390 	res = drm_universal_plane_init(drm_dev, &cursor->plane.drm_plane,
391 				       possible_crtcs,
392 				       &sti_cursor_plane_helpers_funcs,
393 				       cursor_supported_formats,
394 				       ARRAY_SIZE(cursor_supported_formats),
395 				       NULL, DRM_PLANE_TYPE_CURSOR, NULL);
396 	if (res) {
397 		DRM_ERROR("Failed to initialize universal plane\n");
398 		goto err_plane;
399 	}
400 
401 	drm_plane_helper_add(&cursor->plane.drm_plane,
402 			     &sti_cursor_helpers_funcs);
403 
404 	sti_plane_init_property(&cursor->plane, DRM_PLANE_TYPE_CURSOR);
405 
406 	return &cursor->plane.drm_plane;
407 
408 err_plane:
409 	dma_free_wc(dev, size, cursor->clut, cursor->clut_paddr);
410 err_clut:
411 	devm_kfree(dev, cursor);
412 	return NULL;
413 }
414