drm/vkms/vkms_composer.c

a4e7e98eSRodrigo Siqueira// SPDX-License-Identifier: GPL-2.0+
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira#include <linux/crc32.h>
ce672a1bSSam Ravnborg
a4e7e98eSRodrigo Siqueira#include <drm/drm_atomic.h>
a4e7e98eSRodrigo Siqueira#include <drm/drm_atomic_helper.h>
a4e7e98eSRodrigo Siqueira#include <drm/drm_gem_framebuffer_helper.h>
ce672a1bSSam Ravnborg#include <drm/drm_vblank.h>
ce672a1bSSam Ravnborg
ce672a1bSSam Ravnborg#include "vkms_drv.h"
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira/**
a4e7e98eSRodrigo Siqueira * compute_crc - Compute CRC value on output frame
a4e7e98eSRodrigo Siqueira *
a4e7e98eSRodrigo Siqueira * @vaddr_out: address to final framebuffer
a4e7e98eSRodrigo Siqueira * @composer: framebuffer's metadata
a4e7e98eSRodrigo Siqueira *
a4e7e98eSRodrigo Siqueira * returns CRC value computed using crc32 on the visible portion of
a4e7e98eSRodrigo Siqueira * the final framebuffer at vaddr_out
a4e7e98eSRodrigo Siqueira */
a4e7e98eSRodrigo Siqueirastatic uint32_t compute_crc(void *vaddr_out, struct vkms_composer *composer)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	int i, j, src_offset;
a4e7e98eSRodrigo Siqueira	int x_src = composer->src.x1 >> 16;
a4e7e98eSRodrigo Siqueira	int y_src = composer->src.y1 >> 16;
a4e7e98eSRodrigo Siqueira	int h_src = drm_rect_height(&composer->src) >> 16;
a4e7e98eSRodrigo Siqueira	int w_src = drm_rect_width(&composer->src) >> 16;
a4e7e98eSRodrigo Siqueira	u32 crc = 0;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	for (i = y_src; i < y_src + h_src; ++i) {
a4e7e98eSRodrigo Siqueira		for (j = x_src; j < x_src + w_src; ++j) {
a4e7e98eSRodrigo Siqueira			src_offset = composer->offset
a4e7e98eSRodrigo Siqueira				     + (i * composer->pitch)
a4e7e98eSRodrigo Siqueira				     + (j * composer->cpp);
a4e7e98eSRodrigo Siqueira			/* XRGB format ignores Alpha channel */
09861911SMelissa Wen			bitmap_clear(vaddr_out + src_offset, 24, 8);
a4e7e98eSRodrigo Siqueira			crc = crc32_le(crc, vaddr_out + src_offset,
a4e7e98eSRodrigo Siqueira				       sizeof(u32));
a4e7e98eSRodrigo Siqueira		}
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	return crc;
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira/**
0530bbd0SGabriela Bittencourt * blend - blend value at vaddr_src with value at vaddr_dst
a4e7e98eSRodrigo Siqueira * @vaddr_dst: destination address
a4e7e98eSRodrigo Siqueira * @vaddr_src: source address
a4e7e98eSRodrigo Siqueira * @dest_composer: destination framebuffer's metadata
a4e7e98eSRodrigo Siqueira * @src_composer: source framebuffer's metadata
a4e7e98eSRodrigo Siqueira *
a4e7e98eSRodrigo Siqueira * Blend value at vaddr_src with value at vaddr_dst.
0530bbd0SGabriela Bittencourt * Currently, this function write value of vaddr_src on value
a4e7e98eSRodrigo Siqueira * at vaddr_dst using buffer's metadata to locate the new values
0530bbd0SGabriela Bittencourt * from vaddr_src and their destination at vaddr_dst.
a4e7e98eSRodrigo Siqueira *
0530bbd0SGabriela Bittencourt * TODO: Use the alpha value to blend vaddr_src with vaddr_dst
a4e7e98eSRodrigo Siqueira *	 instead of overwriting it.
a4e7e98eSRodrigo Siqueira */
a4e7e98eSRodrigo Siqueirastatic void blend(void *vaddr_dst, void *vaddr_src,
a4e7e98eSRodrigo Siqueira		  struct vkms_composer *dest_composer,
a4e7e98eSRodrigo Siqueira		  struct vkms_composer *src_composer)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	int i, j, j_dst, i_dst;
a4e7e98eSRodrigo Siqueira	int offset_src, offset_dst;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	int x_src = src_composer->src.x1 >> 16;
a4e7e98eSRodrigo Siqueira	int y_src = src_composer->src.y1 >> 16;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	int x_dst = src_composer->dst.x1;
a4e7e98eSRodrigo Siqueira	int y_dst = src_composer->dst.y1;
a4e7e98eSRodrigo Siqueira	int h_dst = drm_rect_height(&src_composer->dst);
a4e7e98eSRodrigo Siqueira	int w_dst = drm_rect_width(&src_composer->dst);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	int y_limit = y_src + h_dst;
a4e7e98eSRodrigo Siqueira	int x_limit = x_src + w_dst;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	for (i = y_src, i_dst = y_dst; i < y_limit; ++i) {
a4e7e98eSRodrigo Siqueira		for (j = x_src, j_dst = x_dst; j < x_limit; ++j) {
a4e7e98eSRodrigo Siqueira			offset_dst = dest_composer->offset
a4e7e98eSRodrigo Siqueira				     + (i_dst * dest_composer->pitch)
a4e7e98eSRodrigo Siqueira				     + (j_dst++ * dest_composer->cpp);
a4e7e98eSRodrigo Siqueira			offset_src = src_composer->offset
a4e7e98eSRodrigo Siqueira				     + (i * src_composer->pitch)
a4e7e98eSRodrigo Siqueira				     + (j * src_composer->cpp);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira			memcpy(vaddr_dst + offset_dst,
a4e7e98eSRodrigo Siqueira			       vaddr_src + offset_src, sizeof(u32));
a4e7e98eSRodrigo Siqueira		}
a4e7e98eSRodrigo Siqueira		i_dst++;
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueirastatic void compose_cursor(struct vkms_composer *cursor_composer,
a4e7e98eSRodrigo Siqueira			   struct vkms_composer *primary_composer,
a4e7e98eSRodrigo Siqueira			   void *vaddr_out)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	struct drm_gem_object *cursor_obj;
a4e7e98eSRodrigo Siqueira	struct vkms_gem_object *cursor_vkms_obj;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	cursor_obj = drm_gem_fb_get_obj(&cursor_composer->fb, 0);
a4e7e98eSRodrigo Siqueira	cursor_vkms_obj = drm_gem_to_vkms_gem(cursor_obj);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (WARN_ON(!cursor_vkms_obj->vaddr))
a4e7e98eSRodrigo Siqueira		return;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	blend(vaddr_out, cursor_vkms_obj->vaddr,
a4e7e98eSRodrigo Siqueira	      primary_composer, cursor_composer);
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueirastatic uint32_t _vkms_get_crc(struct vkms_composer *primary_composer,
a4e7e98eSRodrigo Siqueira			      struct vkms_composer *cursor_composer)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	struct drm_framebuffer *fb = &primary_composer->fb;
a4e7e98eSRodrigo Siqueira	struct drm_gem_object *gem_obj = drm_gem_fb_get_obj(fb, 0);
a4e7e98eSRodrigo Siqueira	struct vkms_gem_object *vkms_obj = drm_gem_to_vkms_gem(gem_obj);
a4e7e98eSRodrigo Siqueira	void *vaddr_out = kzalloc(vkms_obj->gem.size, GFP_KERNEL);
a4e7e98eSRodrigo Siqueira	u32 crc = 0;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (!vaddr_out) {
a4e7e98eSRodrigo Siqueira		DRM_ERROR("Failed to allocate memory for output frame.");
a4e7e98eSRodrigo Siqueira		return 0;
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (WARN_ON(!vkms_obj->vaddr)) {
a4e7e98eSRodrigo Siqueira		kfree(vaddr_out);
a4e7e98eSRodrigo Siqueira		return crc;
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	memcpy(vaddr_out, vkms_obj->vaddr, vkms_obj->gem.size);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (cursor_composer)
a4e7e98eSRodrigo Siqueira		compose_cursor(cursor_composer, primary_composer, vaddr_out);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	crc = compute_crc(vaddr_out, primary_composer);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	kfree(vaddr_out);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	return crc;
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira/**
a4e7e98eSRodrigo Siqueira * vkms_composer_worker - ordered work_struct to compute CRC
a4e7e98eSRodrigo Siqueira *
a4e7e98eSRodrigo Siqueira * @work: work_struct
a4e7e98eSRodrigo Siqueira *
a4e7e98eSRodrigo Siqueira * Work handler for composing and computing CRCs. work_struct scheduled in
a4e7e98eSRodrigo Siqueira * an ordered workqueue that's periodically scheduled to run by
a4e7e98eSRodrigo Siqueira * _vblank_handle() and flushed at vkms_atomic_crtc_destroy_state().
a4e7e98eSRodrigo Siqueira */
a4e7e98eSRodrigo Siqueiravoid vkms_composer_worker(struct work_struct *work)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	struct vkms_crtc_state *crtc_state = container_of(work,
a4e7e98eSRodrigo Siqueira						struct vkms_crtc_state,
a4e7e98eSRodrigo Siqueira						composer_work);
a4e7e98eSRodrigo Siqueira	struct drm_crtc *crtc = crtc_state->base.crtc;
a4e7e98eSRodrigo Siqueira	struct vkms_output *out = drm_crtc_to_vkms_output(crtc);
a4e7e98eSRodrigo Siqueira	struct vkms_composer *primary_composer = NULL;
a4e7e98eSRodrigo Siqueira	struct vkms_composer *cursor_composer = NULL;
a4e7e98eSRodrigo Siqueira	u32 crc32 = 0;
a4e7e98eSRodrigo Siqueira	u64 frame_start, frame_end;
a4e7e98eSRodrigo Siqueira	bool crc_pending;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	spin_lock_irq(&out->composer_lock);
a4e7e98eSRodrigo Siqueira	frame_start = crtc_state->frame_start;
a4e7e98eSRodrigo Siqueira	frame_end = crtc_state->frame_end;
a4e7e98eSRodrigo Siqueira	crc_pending = crtc_state->crc_pending;
a4e7e98eSRodrigo Siqueira	crtc_state->frame_start = 0;
a4e7e98eSRodrigo Siqueira	crtc_state->frame_end = 0;
a4e7e98eSRodrigo Siqueira	crtc_state->crc_pending = false;
a4e7e98eSRodrigo Siqueira	spin_unlock_irq(&out->composer_lock);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	/*
a4e7e98eSRodrigo Siqueira	 * We raced with the vblank hrtimer and previous work already computed
a4e7e98eSRodrigo Siqueira	 * the crc, nothing to do.
a4e7e98eSRodrigo Siqueira	 */
a4e7e98eSRodrigo Siqueira	if (!crc_pending)
a4e7e98eSRodrigo Siqueira		return;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (crtc_state->num_active_planes >= 1)
a4e7e98eSRodrigo Siqueira		primary_composer = crtc_state->active_planes[0]->composer;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (crtc_state->num_active_planes == 2)
a4e7e98eSRodrigo Siqueira		cursor_composer = crtc_state->active_planes[1]->composer;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (primary_composer)
a4e7e98eSRodrigo Siqueira		crc32 = _vkms_get_crc(primary_composer, cursor_composer);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	/*
a4e7e98eSRodrigo Siqueira	 * The worker can fall behind the vblank hrtimer, make sure we catch up.
a4e7e98eSRodrigo Siqueira	 */
a4e7e98eSRodrigo Siqueira	while (frame_start <= frame_end)
a4e7e98eSRodrigo Siqueira		drm_crtc_add_crc_entry(crtc, true, frame_start++, &crc32);
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueirastatic const char * const pipe_crc_sources[] = {"auto"};
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueiraconst char *const *vkms_get_crc_sources(struct drm_crtc *crtc,
a4e7e98eSRodrigo Siqueira					size_t *count)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	*count = ARRAY_SIZE(pipe_crc_sources);
a4e7e98eSRodrigo Siqueira	return pipe_crc_sources;
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueirastatic int vkms_crc_parse_source(const char *src_name, bool *enabled)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	int ret = 0;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (!src_name) {
a4e7e98eSRodrigo Siqueira		*enabled = false;
a4e7e98eSRodrigo Siqueira	} else if (strcmp(src_name, "auto") == 0) {
a4e7e98eSRodrigo Siqueira		*enabled = true;
a4e7e98eSRodrigo Siqueira	} else {
a4e7e98eSRodrigo Siqueira		*enabled = false;
a4e7e98eSRodrigo Siqueira		ret = -EINVAL;
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	return ret;
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueiraint vkms_verify_crc_source(struct drm_crtc *crtc, const char *src_name,
a4e7e98eSRodrigo Siqueira			   size_t *values_cnt)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	bool enabled;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	if (vkms_crc_parse_source(src_name, &enabled) < 0) {
a4e7e98eSRodrigo Siqueira		DRM_DEBUG_DRIVER("unknown source %s\n", src_name);
a4e7e98eSRodrigo Siqueira		return -EINVAL;
a4e7e98eSRodrigo Siqueira	}
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	*values_cnt = 1;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	return 0;
a4e7e98eSRodrigo Siqueira}
a4e7e98eSRodrigo Siqueira
*5bd858d7SMelissa Wenstatic void vkms_set_composer(struct vkms_output *out, bool enabled)
*5bd858d7SMelissa Wen{
*5bd858d7SMelissa Wen	bool old_enabled;
*5bd858d7SMelissa Wen
*5bd858d7SMelissa Wen	if (enabled)
*5bd858d7SMelissa Wen		drm_crtc_vblank_get(&out->crtc);
*5bd858d7SMelissa Wen
*5bd858d7SMelissa Wen	spin_lock_irq(&out->lock);
*5bd858d7SMelissa Wen	old_enabled = out->composer_enabled;
*5bd858d7SMelissa Wen	out->composer_enabled = enabled;
*5bd858d7SMelissa Wen	spin_unlock_irq(&out->lock);
*5bd858d7SMelissa Wen
*5bd858d7SMelissa Wen	if (old_enabled)
*5bd858d7SMelissa Wen		drm_crtc_vblank_put(&out->crtc);
*5bd858d7SMelissa Wen}
*5bd858d7SMelissa Wen
a4e7e98eSRodrigo Siqueiraint vkms_set_crc_source(struct drm_crtc *crtc, const char *src_name)
a4e7e98eSRodrigo Siqueira{
a4e7e98eSRodrigo Siqueira	struct vkms_output *out = drm_crtc_to_vkms_output(crtc);
a4e7e98eSRodrigo Siqueira	bool enabled = false;
a4e7e98eSRodrigo Siqueira	int ret = 0;
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	ret = vkms_crc_parse_source(src_name, &enabled);
a4e7e98eSRodrigo Siqueira
*5bd858d7SMelissa Wen	vkms_set_composer(out, enabled);
a4e7e98eSRodrigo Siqueira
a4e7e98eSRodrigo Siqueira	return ret;
a4e7e98eSRodrigo Siqueira}