linux/drivers/gpu/drm/msm/disp/dpu1/dpu_formats.c

// SPDX-License-Identifier: GPL-2.0-only
/* Copyright (c) 2015-2018, The Linux Foundation. All rights reserved.
 */

#define pr_fmt(fmt)	"[drm:%s:%d] " fmt, __func__, __LINE__

#include <uapi/drm/drm_fourcc.h>
#include <drm/drm_framebuffer.h>

#include "msm_media_info.h"
#include "dpu_kms.h"
#include "dpu_formats.h"

#define DPU_UBWC_PLANE_SIZE_ALIGNMENT	4096

/*
 * struct dpu_media_color_map - maps drm format to media format
 * @format: DRM base pixel format
 * @color: Media API color related to DRM format
 */
struct dpu_media_color_map {
	uint32_t format;
	uint32_t color;
};

/* _dpu_get_v_h_subsample_rate - Get subsample rates for all formats we support
 *   Note: Not using the drm_format_*_subsampling since we have formats
 */
static void _dpu_get_v_h_subsample_rate(
	enum mdp_chroma_samp_type chroma_sample,
	uint32_t *v_sample,
	uint32_t *h_sample)
{
	if (!v_sample || !h_sample)
		return;

	switch (chroma_sample) {
	case CHROMA_H2V1:
		*v_sample = 1;
		*h_sample = 2;
		break;
	case CHROMA_H1V2:
		*v_sample = 2;
		*h_sample = 1;
		break;
	case CHROMA_420:
		*v_sample = 2;
		*h_sample = 2;
		break;
	default:
		*v_sample = 1;
		*h_sample = 1;
		break;
	}
}

static int _dpu_format_get_media_color_ubwc(const struct msm_format *fmt)
{
	static const struct dpu_media_color_map dpu_media_ubwc_map[] = {
		{DRM_FORMAT_ABGR8888, COLOR_FMT_RGBA8888_UBWC},
		{DRM_FORMAT_ARGB8888, COLOR_FMT_RGBA8888_UBWC},
		{DRM_FORMAT_XBGR8888, COLOR_FMT_RGBA8888_UBWC},
		{DRM_FORMAT_XRGB8888, COLOR_FMT_RGBA8888_UBWC},
		{DRM_FORMAT_ABGR2101010, COLOR_FMT_RGBA1010102_UBWC},
		{DRM_FORMAT_ARGB2101010, COLOR_FMT_RGBA1010102_UBWC},
		{DRM_FORMAT_XRGB2101010, COLOR_FMT_RGBA1010102_UBWC},
		{DRM_FORMAT_XBGR2101010, COLOR_FMT_RGBA1010102_UBWC},
		{DRM_FORMAT_BGR565, COLOR_FMT_RGB565_UBWC},
	};
	int color_fmt = -1;
	int i;

	if (fmt->pixel_format == DRM_FORMAT_NV12 ||
	    fmt->pixel_format == DRM_FORMAT_P010) {
		if (MSM_FORMAT_IS_DX(fmt)) {
			if (fmt->flags & MSM_FORMAT_FLAG_UNPACK_TIGHT)
				color_fmt = COLOR_FMT_NV12_BPP10_UBWC;
			else
				color_fmt = COLOR_FMT_P010_UBWC;
		} else
			color_fmt = COLOR_FMT_NV12_UBWC;
		return color_fmt;
	}

	for (i = 0; i < ARRAY_SIZE(dpu_media_ubwc_map); ++i)
		if (fmt->pixel_format == dpu_media_ubwc_map[i].format) {
			color_fmt = dpu_media_ubwc_map[i].color;
			break;
		}
	return color_fmt;
}

static int _dpu_format_populate_plane_sizes_ubwc(
		const struct msm_format *fmt,
		struct drm_framebuffer *fb,
		struct dpu_hw_fmt_layout *layout)
{
	int i;
	int color;
	bool meta = MSM_FORMAT_IS_UBWC(fmt);

	memset(layout, 0, sizeof(struct dpu_hw_fmt_layout));
	layout->width = fb->width;
	layout->height = fb->height;
	layout->num_planes = fmt->num_planes;

	color = _dpu_format_get_media_color_ubwc(fmt);
	if (color < 0) {
		DRM_ERROR("UBWC format not supported for fmt: %p4cc\n",
			  &fmt->pixel_format);
		return -EINVAL;
	}

	if (MSM_FORMAT_IS_YUV(fmt)) {
		uint32_t y_sclines, uv_sclines;
		uint32_t y_meta_scanlines = 0;
		uint32_t uv_meta_scanlines = 0;

		layout->num_planes = 2;
		layout->plane_pitch[0] = VENUS_Y_STRIDE(color, fb->width);
		y_sclines = VENUS_Y_SCANLINES(color, fb->height);
		layout->plane_size[0] = MSM_MEDIA_ALIGN(layout->plane_pitch[0] *
			y_sclines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);

		layout->plane_pitch[1] = VENUS_UV_STRIDE(color, fb->width);
		uv_sclines = VENUS_UV_SCANLINES(color, fb->height);
		layout->plane_size[1] = MSM_MEDIA_ALIGN(layout->plane_pitch[1] *
			uv_sclines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);

		if (!meta)
			goto done;

		layout->num_planes += 2;
		layout->plane_pitch[2] = VENUS_Y_META_STRIDE(color, fb->width);
		y_meta_scanlines = VENUS_Y_META_SCANLINES(color, fb->height);
		layout->plane_size[2] = MSM_MEDIA_ALIGN(layout->plane_pitch[2] *
			y_meta_scanlines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);

		layout->plane_pitch[3] = VENUS_UV_META_STRIDE(color, fb->width);
		uv_meta_scanlines = VENUS_UV_META_SCANLINES(color, fb->height);
		layout->plane_size[3] = MSM_MEDIA_ALIGN(layout->plane_pitch[3] *
			uv_meta_scanlines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);

	} else {
		uint32_t rgb_scanlines, rgb_meta_scanlines;

		layout->num_planes = 1;

		layout->plane_pitch[0] = VENUS_RGB_STRIDE(color, fb->width);
		rgb_scanlines = VENUS_RGB_SCANLINES(color, fb->height);
		layout->plane_size[0] = MSM_MEDIA_ALIGN(layout->plane_pitch[0] *
			rgb_scanlines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);

		if (!meta)
			goto done;
		layout->num_planes += 2;
		layout->plane_pitch[2] = VENUS_RGB_META_STRIDE(color, fb->width);
		rgb_meta_scanlines = VENUS_RGB_META_SCANLINES(color, fb->height);
		layout->plane_size[2] = MSM_MEDIA_ALIGN(layout->plane_pitch[2] *
			rgb_meta_scanlines, DPU_UBWC_PLANE_SIZE_ALIGNMENT);
	}

done:
	for (i = 0; i < DPU_MAX_PLANES; i++)
		layout->total_size += layout->plane_size[i];

	return 0;
}

static int _dpu_format_populate_plane_sizes_linear(
		const struct msm_format *fmt,
		struct drm_framebuffer *fb,
		struct dpu_hw_fmt_layout *layout)
{
	int i;

	memset(layout, 0, sizeof(struct dpu_hw_fmt_layout));
	layout->width = fb->width;
	layout->height = fb->height;
	layout->num_planes = fmt->num_planes;

	/* Due to memset above, only need to set planes of interest */
	if (fmt->fetch_type == MDP_PLANE_INTERLEAVED) {
		layout->num_planes = 1;
		layout->plane_size[0] = fb->width * fb->height * fmt->bpp;
		layout->plane_pitch[0] = fb->width * fmt->bpp;
	} else {
		uint32_t v_subsample, h_subsample;
		uint32_t chroma_samp;
		uint32_t bpp = 1;

		chroma_samp = fmt->chroma_sample;
		_dpu_get_v_h_subsample_rate(chroma_samp, &v_subsample,
				&h_subsample);

		if (fb->width % h_subsample || fb->height % v_subsample) {
			DRM_ERROR("mismatch in subsample vs dimensions\n");
			return -EINVAL;
		}

		if ((fmt->pixel_format == DRM_FORMAT_NV12) &&
			(MSM_FORMAT_IS_DX(fmt)))
			bpp = 2;
		layout->plane_pitch[0] = fb->width * bpp;
		layout->plane_pitch[1] = layout->plane_pitch[0] / h_subsample;
		layout->plane_size[0] = layout->plane_pitch[0] * fb->height;
		layout->plane_size[1] = layout->plane_pitch[1] *
				(fb->height / v_subsample);

		if (fmt->fetch_type == MDP_PLANE_PSEUDO_PLANAR) {
			layout->num_planes = 2;
			layout->plane_size[1] *= 2;
			layout->plane_pitch[1] *= 2;
		} else {
			/* planar */
			layout->num_planes = 3;
			layout->plane_size[2] = layout->plane_size[1];
			layout->plane_pitch[2] = layout->plane_pitch[1];
		}
	}

	/*
	 * linear format: allow user allocated pitches if they are greater than
	 * the requirement.
	 * ubwc format: pitch values are computed uniformly across
	 * all the components based on ubwc specifications.
	 */
	for (i = 0; i < layout->num_planes && i < DPU_MAX_PLANES; ++i) {
		if (layout->plane_pitch[i] <= fb->pitches[i]) {
			layout->plane_pitch[i] = fb->pitches[i];
		} else {
			DRM_DEBUG("plane %u expected pitch %u, fb %u\n",
				  i, layout->plane_pitch[i], fb->pitches[i]);
			return -EINVAL;
		}
	}

	for (i = 0; i < DPU_MAX_PLANES; i++)
		layout->total_size += layout->plane_size[i];

	return 0;
}

/**
 * dpu_format_populate_plane_sizes - populate non-address part of the layout based on
 *                     fb, and format found in the fb
 * @fb:                framebuffer pointer
 * @layout:              format layout structure to populate
 *
 * Return: error code on failure or 0 if new addresses were populated
 */
int dpu_format_populate_plane_sizes(
		struct drm_framebuffer *fb,
		struct dpu_hw_fmt_layout *layout)
{
	const struct msm_format *fmt;

	if (!layout || !fb) {
		DRM_ERROR("invalid pointer\n");
		return -EINVAL;
	}

	if (fb->width > DPU_MAX_IMG_WIDTH ||
	    fb->height > DPU_MAX_IMG_HEIGHT) {
		DRM_ERROR("image dimensions outside max range\n");
		return -ERANGE;
	}

	fmt = msm_framebuffer_format(fb);

	if (MSM_FORMAT_IS_UBWC(fmt) || MSM_FORMAT_IS_TILE(fmt))
		return _dpu_format_populate_plane_sizes_ubwc(fmt, fb, layout);

	return _dpu_format_populate_plane_sizes_linear(fmt, fb, layout);
}

static void _dpu_format_populate_addrs_ubwc(struct msm_gem_address_space *aspace,
					    struct drm_framebuffer *fb,
					    struct dpu_hw_fmt_layout *layout)
{
	const struct msm_format *fmt;
	uint32_t base_addr = 0;
	bool meta;

	base_addr = msm_framebuffer_iova(fb, aspace, 0);

	fmt = msm_framebuffer_format(fb);
	meta = MSM_FORMAT_IS_UBWC(fmt);

	/* Per-format logic for verifying active planes */
	if (MSM_FORMAT_IS_YUV(fmt)) {
		/************************************************/
		/*      UBWC            **                      */
		/*      buffer          **      DPU PLANE       */
		/*      format          **                      */
		/************************************************/
		/* -------------------  ** -------------------- */
		/* |      Y meta     |  ** |    Y bitstream   | */
		/* |       data      |  ** |       plane      | */
		/* -------------------  ** -------------------- */
		/* |    Y bitstream  |  ** |  CbCr bitstream  | */
		/* |       data      |  ** |       plane      | */
		/* -------------------  ** -------------------- */
		/* |   Cbcr metadata |  ** |       Y meta     | */
		/* |       data      |  ** |       plane      | */
		/* -------------------  ** -------------------- */
		/* |  CbCr bitstream |  ** |     CbCr meta    | */
		/* |       data      |  ** |       plane      | */
		/* -------------------  ** -------------------- */
		/************************************************/

		/* configure Y bitstream plane */
		layout->plane_addr[0] = base_addr + layout->plane_size[2];

		/* configure CbCr bitstream plane */
		layout->plane_addr[1] = base_addr + layout->plane_size[0]
			+ layout->plane_size[2] + layout->plane_size[3];

		if (!meta)
			return;

		/* configure Y metadata plane */
		layout->plane_addr[2] = base_addr;

		/* configure CbCr metadata plane */
		layout->plane_addr[3] = base_addr + layout->plane_size[0]
			+ layout->plane_size[2];

	} else {
		/************************************************/
		/*      UBWC            **                      */
		/*      buffer          **      DPU PLANE       */
		/*      format          **                      */
		/************************************************/
		/* -------------------  ** -------------------- */
		/* |      RGB meta   |  ** |   RGB bitstream  | */
		/* |       data      |  ** |       plane      | */
		/* -------------------  ** -------------------- */
		/* |  RGB bitstream  |  ** |       NONE       | */
		/* |       data      |  ** |                  | */
		/* -------------------  ** -------------------- */
		/*                      ** |     RGB meta     | */
		/*                      ** |       plane      | */
		/*                      ** -------------------- */
		/************************************************/

		layout->plane_addr[0] = base_addr + layout->plane_size[2];
		layout->plane_addr[1] = 0;

		if (!meta)
			return;

		layout->plane_addr[2] = base_addr;
		layout->plane_addr[3] = 0;
	}
}

static void _dpu_format_populate_addrs_linear(struct msm_gem_address_space *aspace,
					      struct drm_framebuffer *fb,
					      struct dpu_hw_fmt_layout *layout)
{
	unsigned int i;

	/* Populate addresses for simple formats here */
	for (i = 0; i < layout->num_planes; ++i)
		layout->plane_addr[i] = msm_framebuffer_iova(fb, aspace, i);
}

/**
 * dpu_format_populate_addrs - populate buffer addresses based on
 *                     mmu, fb, and format found in the fb
 * @aspace:            address space pointer
 * @fb:                framebuffer pointer
 * @layout:            format layout structure to populate
 */
void dpu_format_populate_addrs(struct msm_gem_address_space *aspace,
			       struct drm_framebuffer *fb,
			       struct dpu_hw_fmt_layout *layout)
{
	const struct msm_format *fmt;

	fmt = msm_framebuffer_format(fb);

	/* Populate the addresses given the fb */
	if (MSM_FORMAT_IS_UBWC(fmt) ||
			MSM_FORMAT_IS_TILE(fmt))
		_dpu_format_populate_addrs_ubwc(aspace, fb, layout);
	else
		_dpu_format_populate_addrs_linear(aspace, fb, layout);
}