1/*
2 * Copyright (C) STMicroelectronics SA 2014
3 * Authors: Vincent Abriou <vincent.abriou@st.com>
4 *          Fabien Dessenne <fabien.dessenne@st.com>
5 *          for STMicroelectronics.
6 * License terms:  GNU General Public License (GPL), version 2
7 */
8#include <drm/drmP.h>
9
10#include <drm/drm_atomic_helper.h>
11#include <drm/drm_fb_cma_helper.h>
12#include <drm/drm_gem_cma_helper.h>
13#include <drm/drm_plane_helper.h>
14
15#include "sti_compositor.h"
16#include "sti_cursor.h"
17#include "sti_plane.h"
18#include "sti_vtg.h"
19
20/* Registers */
21#define CUR_CTL             0x00
22#define CUR_VPO             0x0C
23#define CUR_PML             0x14
24#define CUR_PMP             0x18
25#define CUR_SIZE            0x1C
26#define CUR_CML             0x20
27#define CUR_AWS             0x28
28#define CUR_AWE             0x2C
29
30#define CUR_CTL_CLUT_UPDATE BIT(1)
31
32#define STI_CURS_MIN_SIZE   1
33#define STI_CURS_MAX_SIZE   128
34
35/*
36 * pixmap dma buffer stucture
37 *
38 * @paddr:  physical address
39 * @size:   buffer size
40 * @base:   virtual address
41 */
42struct dma_pixmap {
43	dma_addr_t paddr;
44	size_t size;
45	void *base;
46};
47
48/**
49 * STI Cursor structure
50 *
51 * @sti_plane:    sti_plane structure
52 * @dev:          driver device
53 * @regs:         cursor registers
54 * @width:        cursor width
55 * @height:       cursor height
56 * @clut:         color look up table
57 * @clut_paddr:   color look up table physical address
58 * @pixmap:       pixmap dma buffer (clut8-format cursor)
59 */
60struct sti_cursor {
61	struct sti_plane plane;
62	struct device *dev;
63	void __iomem *regs;
64	unsigned int width;
65	unsigned int height;
66	unsigned short *clut;
67	dma_addr_t clut_paddr;
68	struct dma_pixmap pixmap;
69};
70
71static const uint32_t cursor_supported_formats[] = {
72	DRM_FORMAT_ARGB8888,
73};
74
75#define to_sti_cursor(x) container_of(x, struct sti_cursor, plane)
76
77static void sti_cursor_argb8888_to_clut8(struct sti_cursor *cursor, u32 *src)
78{
79	u8  *dst = cursor->pixmap.base;
80	unsigned int i, j;
81	u32 a, r, g, b;
82
83	for (i = 0; i < cursor->height; i++) {
84		for (j = 0; j < cursor->width; j++) {
85			/* Pick the 2 higher bits of each component */
86			a = (*src >> 30) & 3;
87			r = (*src >> 22) & 3;
88			g = (*src >> 14) & 3;
89			b = (*src >> 6) & 3;
90			*dst = a << 6 | r << 4 | g << 2 | b;
91			src++;
92			dst++;
93		}
94	}
95}
96
97static void sti_cursor_init(struct sti_cursor *cursor)
98{
99	unsigned short *base = cursor->clut;
100	unsigned int a, r, g, b;
101
102	/* Assign CLUT values, ARGB444 format */
103	for (a = 0; a < 4; a++)
104		for (r = 0; r < 4; r++)
105			for (g = 0; g < 4; g++)
106				for (b = 0; b < 4; b++)
107					*base++ = (a * 5) << 12 |
108						  (r * 5) << 8 |
109						  (g * 5) << 4 |
110						  (b * 5);
111}
112
113static void sti_cursor_atomic_update(struct drm_plane *drm_plane,
114				     struct drm_plane_state *oldstate)
115{
116	struct drm_plane_state *state = drm_plane->state;
117	struct sti_plane *plane = to_sti_plane(drm_plane);
118	struct sti_cursor *cursor = to_sti_cursor(plane);
119	struct drm_crtc *crtc = state->crtc;
120	struct sti_mixer *mixer = to_sti_mixer(crtc);
121	struct drm_framebuffer *fb = state->fb;
122	struct drm_display_mode *mode = &crtc->mode;
123	int dst_x = state->crtc_x;
124	int dst_y = state->crtc_y;
125	int dst_w = clamp_val(state->crtc_w, 0, mode->crtc_hdisplay - dst_x);
126	int dst_h = clamp_val(state->crtc_h, 0, mode->crtc_vdisplay - dst_y);
127	/* src_x are in 16.16 format */
128	int src_w = state->src_w >> 16;
129	int src_h = state->src_h >> 16;
130	bool first_prepare = plane->status == STI_PLANE_DISABLED ? true : false;
131	struct drm_gem_cma_object *cma_obj;
132	u32 y, x;
133	u32 val;
134
135	DRM_DEBUG_KMS("CRTC:%d (%s) drm plane:%d (%s)\n",
136		      crtc->base.id, sti_mixer_to_str(mixer),
137		      drm_plane->base.id, sti_plane_to_str(plane));
138	DRM_DEBUG_KMS("(%dx%d)@(%d,%d)\n", dst_w, dst_h, dst_x, dst_y);
139
140	dev_dbg(cursor->dev, "%s %s\n", __func__,
141		sti_plane_to_str(plane));
142
143	if (src_w < STI_CURS_MIN_SIZE ||
144	    src_h < STI_CURS_MIN_SIZE ||
145	    src_w > STI_CURS_MAX_SIZE ||
146	    src_h > STI_CURS_MAX_SIZE) {
147		DRM_ERROR("Invalid cursor size (%dx%d)\n",
148				src_w, src_h);
149		return;
150	}
151
152	/* If the cursor size has changed, re-allocated the pixmap */
153	if (!cursor->pixmap.base ||
154	    (cursor->width != src_w) ||
155	    (cursor->height != src_h)) {
156		cursor->width = src_w;
157		cursor->height = src_h;
158
159		if (cursor->pixmap.base)
160			dma_free_writecombine(cursor->dev,
161					      cursor->pixmap.size,
162					      cursor->pixmap.base,
163					      cursor->pixmap.paddr);
164
165		cursor->pixmap.size = cursor->width * cursor->height;
166
167		cursor->pixmap.base = dma_alloc_writecombine(cursor->dev,
168							cursor->pixmap.size,
169							&cursor->pixmap.paddr,
170							GFP_KERNEL | GFP_DMA);
171		if (!cursor->pixmap.base) {
172			DRM_ERROR("Failed to allocate memory for pixmap\n");
173			return;
174		}
175	}
176
177	cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
178	if (!cma_obj) {
179		DRM_ERROR("Can't get CMA GEM object for fb\n");
180		return;
181	}
182
183	/* Convert ARGB8888 to CLUT8 */
184	sti_cursor_argb8888_to_clut8(cursor, (u32 *)cma_obj->vaddr);
185
186	/* AWS and AWE depend on the mode */
187	y = sti_vtg_get_line_number(*mode, 0);
188	x = sti_vtg_get_pixel_number(*mode, 0);
189	val = y << 16 | x;
190	writel(val, cursor->regs + CUR_AWS);
191	y = sti_vtg_get_line_number(*mode, mode->vdisplay - 1);
192	x = sti_vtg_get_pixel_number(*mode, mode->hdisplay - 1);
193	val = y << 16 | x;
194	writel(val, cursor->regs + CUR_AWE);
195
196	if (first_prepare) {
197		/* Set and fetch CLUT */
198		writel(cursor->clut_paddr, cursor->regs + CUR_CML);
199		writel(CUR_CTL_CLUT_UPDATE, cursor->regs + CUR_CTL);
200	}
201
202	/* Set memory location, size, and position */
203	writel(cursor->pixmap.paddr, cursor->regs + CUR_PML);
204	writel(cursor->width, cursor->regs + CUR_PMP);
205	writel(cursor->height << 16 | cursor->width, cursor->regs + CUR_SIZE);
206
207	y = sti_vtg_get_line_number(*mode, dst_y);
208	x = sti_vtg_get_pixel_number(*mode, dst_y);
209	writel((y << 16) | x, cursor->regs + CUR_VPO);
210
211	plane->status = STI_PLANE_UPDATED;
212}
213
214static void sti_cursor_atomic_disable(struct drm_plane *drm_plane,
215				      struct drm_plane_state *oldstate)
216{
217	struct sti_plane *plane = to_sti_plane(drm_plane);
218	struct sti_mixer *mixer = to_sti_mixer(drm_plane->crtc);
219
220	if (!drm_plane->crtc) {
221		DRM_DEBUG_DRIVER("drm plane:%d not enabled\n",
222				 drm_plane->base.id);
223		return;
224	}
225
226	DRM_DEBUG_DRIVER("CRTC:%d (%s) drm plane:%d (%s)\n",
227			 drm_plane->crtc->base.id, sti_mixer_to_str(mixer),
228			 drm_plane->base.id, sti_plane_to_str(plane));
229
230	plane->status = STI_PLANE_DISABLING;
231}
232
233static const struct drm_plane_helper_funcs sti_cursor_helpers_funcs = {
234	.atomic_update = sti_cursor_atomic_update,
235	.atomic_disable = sti_cursor_atomic_disable,
236};
237
238struct drm_plane *sti_cursor_create(struct drm_device *drm_dev,
239				    struct device *dev, int desc,
240				    void __iomem *baseaddr,
241				    unsigned int possible_crtcs)
242{
243	struct sti_cursor *cursor;
244	size_t size;
245	int res;
246
247	cursor = devm_kzalloc(dev, sizeof(*cursor), GFP_KERNEL);
248	if (!cursor) {
249		DRM_ERROR("Failed to allocate memory for cursor\n");
250		return NULL;
251	}
252
253	/* Allocate clut buffer */
254	size = 0x100 * sizeof(unsigned short);
255	cursor->clut = dma_alloc_writecombine(dev, size, &cursor->clut_paddr,
256					      GFP_KERNEL | GFP_DMA);
257
258	if (!cursor->clut) {
259		DRM_ERROR("Failed to allocate memory for cursor clut\n");
260		goto err_clut;
261	}
262
263	cursor->dev = dev;
264	cursor->regs = baseaddr;
265	cursor->plane.desc = desc;
266	cursor->plane.status = STI_PLANE_DISABLED;
267
268	sti_cursor_init(cursor);
269
270	res = drm_universal_plane_init(drm_dev, &cursor->plane.drm_plane,
271				       possible_crtcs,
272				       &sti_plane_helpers_funcs,
273				       cursor_supported_formats,
274				       ARRAY_SIZE(cursor_supported_formats),
275				       DRM_PLANE_TYPE_CURSOR);
276	if (res) {
277		DRM_ERROR("Failed to initialize universal plane\n");
278		goto err_plane;
279	}
280
281	drm_plane_helper_add(&cursor->plane.drm_plane,
282			     &sti_cursor_helpers_funcs);
283
284	sti_plane_init_property(&cursor->plane, DRM_PLANE_TYPE_CURSOR);
285
286	return &cursor->plane.drm_plane;
287
288err_plane:
289	dma_free_writecombine(dev, size, cursor->clut, cursor->clut_paddr);
290err_clut:
291	devm_kfree(dev, cursor);
292	return NULL;
293}
294