xref: /linux/drivers/gpu/drm/msm/disp/dpu1/dpu_plane.c (revision 3f1c07fc21c68bd3bd2df9d2c9441f6485e934d9)

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (C) 2014-2018 The Linux Foundation. All rights reserved.
 * Copyright (C) 2013 Red Hat
 * Author: Rob Clark <robdclark@gmail.com>
 */

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

#include <linux/debugfs.h>
#include <linux/dma-buf.h>

#include <drm/drm_atomic.h>
#include <drm/drm_atomic_uapi.h>
#include <drm/drm_blend.h>
#include <drm/drm_damage_helper.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_gem_atomic_helper.h>

#include <linux/soc/qcom/ubwc.h>

#include "msm_drv.h"
#include "dpu_kms.h"
#include "dpu_hw_sspp.h"
#include "dpu_hw_util.h"
#include "dpu_trace.h"
#include "dpu_crtc.h"
#include "dpu_vbif.h"
#include "dpu_plane.h"

#define DPU_DEBUG_PLANE(pl, fmt, ...) DRM_DEBUG_ATOMIC("plane%d " fmt,\
		(pl) ? (pl)->base.base.id : -1, ##__VA_ARGS__)

#define DPU_ERROR_PLANE(pl, fmt, ...) DPU_ERROR("plane%d " fmt,\
		(pl) ? (pl)->base.base.id : -1, ##__VA_ARGS__)

#define DECIMATED_DIMENSION(dim, deci) (((dim) + ((1 << (deci)) - 1)) >> (deci))
#define PHASE_STEP_SHIFT	21
#define PHASE_STEP_UNIT_SCALE   ((int) (1 << PHASE_STEP_SHIFT))
#define PHASE_RESIDUAL		15

#define SHARP_STRENGTH_DEFAULT	32
#define SHARP_EDGE_THR_DEFAULT	112
#define SHARP_SMOOTH_THR_DEFAULT	8
#define SHARP_NOISE_THR_DEFAULT	2

#define DPU_PLANE_COLOR_FILL_FLAG	BIT(31)
#define DPU_ZPOS_MAX 255

/*
 * Default Preload Values
 */
#define DPU_QSEED3_DEFAULT_PRELOAD_H 0x4
#define DPU_QSEED3_DEFAULT_PRELOAD_V 0x3
#define DPU_QSEED4_DEFAULT_PRELOAD_V 0x2
#define DPU_QSEED4_DEFAULT_PRELOAD_H 0x4

#define DEFAULT_REFRESH_RATE	60

static const uint32_t qcom_compressed_supported_formats[] = {
	DRM_FORMAT_ABGR8888,
	DRM_FORMAT_ARGB8888,
	DRM_FORMAT_XBGR8888,
	DRM_FORMAT_XRGB8888,
	DRM_FORMAT_ARGB2101010,
	DRM_FORMAT_XRGB2101010,
	DRM_FORMAT_BGR565,

	DRM_FORMAT_NV12,
	DRM_FORMAT_P010,
};

/*
 * struct dpu_plane - local dpu plane structure
 * @vm: address space pointer
 * @csc_ptr: Points to dpu_csc_cfg structure to use for current
 * @catalog: Points to dpu catalog structure
 * @revalidate: force revalidation of all the plane properties
 */
struct dpu_plane {
	struct drm_plane base;

	enum dpu_sspp pipe;

	uint32_t color_fill;
	bool is_error;
	bool is_rt_pipe;
	const struct dpu_mdss_cfg *catalog;
};

static const uint64_t supported_format_modifiers[] = {
	DRM_FORMAT_MOD_QCOM_COMPRESSED,
	DRM_FORMAT_MOD_LINEAR,
	DRM_FORMAT_MOD_INVALID
};

#define to_dpu_plane(x) container_of(x, struct dpu_plane, base)

static struct dpu_kms *_dpu_plane_get_kms(struct drm_plane *plane)
{
	struct msm_drm_private *priv = plane->dev->dev_private;

	return to_dpu_kms(priv->kms);
}

/**
 * _dpu_plane_calc_bw - calculate bandwidth required for a plane
 * @catalog: Points to dpu catalog structure
 * @fmt: Pointer to source buffer format
 * @mode: Pointer to drm display mode
 * @pipe_cfg: Pointer to pipe configuration
 * Result: Updates calculated bandwidth in the plane state.
 * BW Equation: src_w * src_h * bpp * fps * (v_total / v_dest)
 * Prefill BW Equation: line src bytes * line_time
 */
static u64 _dpu_plane_calc_bw(const struct dpu_mdss_cfg *catalog,
	const struct msm_format *fmt,
	const struct drm_display_mode *mode,
	struct dpu_sw_pipe_cfg *pipe_cfg)
{
	int src_width, src_height, dst_height, fps;
	u64 plane_pixel_rate, plane_bit_rate;
	u64 plane_prefill_bw;
	u64 plane_bw;
	u32 hw_latency_lines;
	u64 scale_factor;
	int vbp, vpw, vfp;

	src_width = drm_rect_width(&pipe_cfg->src_rect);
	src_height = drm_rect_height(&pipe_cfg->src_rect);
	dst_height = drm_rect_height(&pipe_cfg->dst_rect);
	fps = drm_mode_vrefresh(mode);
	vbp = mode->vtotal - mode->vsync_end;
	vpw = mode->vsync_end - mode->vsync_start;
	vfp = mode->vsync_start - mode->vdisplay;
	hw_latency_lines =  catalog->perf->min_prefill_lines;
	scale_factor = src_height > dst_height ?
		mult_frac(src_height, 1, dst_height) : 1;

	plane_pixel_rate = src_width * mode->vtotal * fps;
	plane_bit_rate = plane_pixel_rate * fmt->bpp;

	plane_bw = plane_bit_rate * scale_factor;

	plane_prefill_bw = plane_bw * hw_latency_lines;

	if ((vbp+vpw) > hw_latency_lines)
		do_div(plane_prefill_bw, (vbp+vpw));
	else if ((vbp+vpw+vfp) < hw_latency_lines)
		do_div(plane_prefill_bw, (vbp+vpw+vfp));
	else
		do_div(plane_prefill_bw, hw_latency_lines);


	return max(plane_bw, plane_prefill_bw);
}

/**
 * _dpu_plane_calc_clk - calculate clock required for a plane
 * @mode: Pointer to drm display mode
 * @pipe_cfg: Pointer to pipe configuration
 * Result: Updates calculated clock in the plane state.
 * Clock equation: dst_w * v_total * fps * (src_h / dst_h)
 */
static u64 _dpu_plane_calc_clk(const struct drm_display_mode *mode,
		struct dpu_sw_pipe_cfg *pipe_cfg)
{
	int dst_width, src_height, dst_height, fps;
	u64 plane_clk;

	src_height = drm_rect_height(&pipe_cfg->src_rect);
	dst_width = drm_rect_width(&pipe_cfg->dst_rect);
	dst_height = drm_rect_height(&pipe_cfg->dst_rect);
	fps = drm_mode_vrefresh(mode);

	plane_clk =
		dst_width * mode->vtotal * fps;

	if (src_height > dst_height) {
		plane_clk *= src_height;
		do_div(plane_clk, dst_height);
	}

	return plane_clk;
}

/**
 * _dpu_plane_calc_fill_level - calculate fill level of the given source format
 * @plane:		Pointer to drm plane
 * @pipe:		Pointer to software pipe
 * @lut_usage:		LUT usecase
 * @fmt:		Pointer to source buffer format
 * @src_width:		width of source buffer
 * Return: fill level corresponding to the source buffer/format or 0 if error
 */
static int _dpu_plane_calc_fill_level(struct drm_plane *plane,
		struct dpu_sw_pipe *pipe,
		enum dpu_qos_lut_usage lut_usage,
		const struct msm_format *fmt, u32 src_width)
{
	struct dpu_plane *pdpu;
	u32 fixed_buff_size;
	u32 total_fl;

	if (!fmt || !pipe || !src_width || !fmt->bpp) {
		DPU_ERROR("invalid arguments\n");
		return 0;
	}

	if (lut_usage == DPU_QOS_LUT_USAGE_NRT)
		return 0;

	pdpu = to_dpu_plane(plane);
	fixed_buff_size = pdpu->catalog->caps->pixel_ram_size;

	/* FIXME: in multirect case account for the src_width of all the planes */

	if (fmt->fetch_type == MDP_PLANE_PSEUDO_PLANAR) {
		if (fmt->chroma_sample == CHROMA_420) {
			/* NV12 */
			total_fl = (fixed_buff_size / 2) /
				((src_width + 32) * fmt->bpp);
		} else {
			/* non NV12 */
			total_fl = (fixed_buff_size / 2) * 2 /
				((src_width + 32) * fmt->bpp);
		}
	} else {
		if (pipe->multirect_mode == DPU_SSPP_MULTIRECT_PARALLEL) {
			total_fl = (fixed_buff_size / 2) * 2 /
				((src_width + 32) * fmt->bpp);
		} else {
			total_fl = (fixed_buff_size) * 2 /
				((src_width + 32) * fmt->bpp);
		}
	}

	DPU_DEBUG_PLANE(pdpu, "pnum:%d fmt: %p4cc w:%u fl:%u\n",
			pipe->sspp->idx - SSPP_VIG0,
			&fmt->pixel_format,
			src_width, total_fl);

	return total_fl;
}

/**
 * _dpu_plane_set_qos_lut - set QoS LUT of the given plane
 * @plane:		Pointer to drm plane
 * @pipe:		Pointer to software pipe
 * @fmt:		Pointer to source buffer format
 * @pipe_cfg:		Pointer to pipe configuration
 */
static void _dpu_plane_set_qos_lut(struct drm_plane *plane,
		struct dpu_sw_pipe *pipe,
		const struct msm_format *fmt, struct dpu_sw_pipe_cfg *pipe_cfg)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_hw_qos_cfg cfg;
	u32 total_fl, lut_usage;

	if (!pdpu->is_rt_pipe) {
		lut_usage = DPU_QOS_LUT_USAGE_NRT;
	} else {
		if (fmt && MSM_FORMAT_IS_LINEAR(fmt))
			lut_usage = DPU_QOS_LUT_USAGE_LINEAR;
		else
			lut_usage = DPU_QOS_LUT_USAGE_MACROTILE;
	}

	total_fl = _dpu_plane_calc_fill_level(plane, pipe, lut_usage, fmt,
				drm_rect_width(&pipe_cfg->src_rect));

	cfg.creq_lut = _dpu_hw_get_qos_lut(&pdpu->catalog->perf->qos_lut_tbl[lut_usage], total_fl);
	cfg.danger_lut = pdpu->catalog->perf->danger_lut_tbl[lut_usage];
	cfg.safe_lut = pdpu->catalog->perf->safe_lut_tbl[lut_usage];

	if (pipe->sspp->idx != SSPP_CURSOR0 &&
	    pipe->sspp->idx != SSPP_CURSOR1 &&
	    pdpu->is_rt_pipe)
		cfg.danger_safe_en = true;

	DPU_DEBUG_PLANE(pdpu, "pnum:%d ds:%d is_rt:%d\n",
		pdpu->pipe - SSPP_VIG0,
		cfg.danger_safe_en,
		pdpu->is_rt_pipe);

	trace_dpu_perf_set_qos_luts(pipe->sspp->idx - SSPP_VIG0,
			(fmt) ? fmt->pixel_format : 0,
			pdpu->is_rt_pipe, total_fl, cfg.creq_lut, lut_usage);

	DPU_DEBUG_PLANE(pdpu, "pnum:%d fmt: %p4cc rt:%d fl:%u lut:0x%llx\n",
			pdpu->pipe - SSPP_VIG0,
			fmt ? &fmt->pixel_format : NULL,
			pdpu->is_rt_pipe, total_fl, cfg.creq_lut);

	trace_dpu_perf_set_danger_luts(pdpu->pipe - SSPP_VIG0,
			(fmt) ? fmt->pixel_format : 0,
			(fmt) ? fmt->fetch_mode : 0,
			cfg.danger_lut,
			cfg.safe_lut);

	DPU_DEBUG_PLANE(pdpu, "pnum:%d fmt: %p4cc mode:%d luts[0x%x, 0x%x]\n",
			pdpu->pipe - SSPP_VIG0,
			fmt ? &fmt->pixel_format : NULL,
			fmt ? fmt->fetch_mode : -1,
			cfg.danger_lut,
			cfg.safe_lut);

	pipe->sspp->ops.setup_qos_lut(pipe->sspp, &cfg);
}

/**
 * _dpu_plane_set_qos_ctrl - set QoS control of the given plane
 * @plane:		Pointer to drm plane
 * @pipe:		Pointer to software pipe
 * @enable:		true to enable QoS control
 */
static void _dpu_plane_set_qos_ctrl(struct drm_plane *plane,
	struct dpu_sw_pipe *pipe,
	bool enable)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);

	if (!pdpu->is_rt_pipe)
		enable = false;

	DPU_DEBUG_PLANE(pdpu, "pnum:%d ds:%d is_rt:%d\n",
		pdpu->pipe - SSPP_VIG0,
		enable,
		pdpu->is_rt_pipe);

	pipe->sspp->ops.setup_qos_ctrl(pipe->sspp,
				       enable);
}

static bool _dpu_plane_sspp_clk_force_ctrl(struct dpu_hw_sspp *sspp,
					   struct dpu_hw_mdp *mdp,
					   bool enable, bool *forced_on)
{
	if (sspp->ops.setup_clk_force_ctrl) {
		*forced_on = sspp->ops.setup_clk_force_ctrl(sspp, enable);
		return true;
	}

	if (mdp->ops.setup_clk_force_ctrl) {
		*forced_on = mdp->ops.setup_clk_force_ctrl(mdp, sspp->cap->clk_ctrl, enable);
		return true;
	}

	return false;
}

/**
 * _dpu_plane_set_ot_limit - set OT limit for the given plane
 * @plane:		Pointer to drm plane
 * @pipe:		Pointer to software pipe
 * @pipe_cfg:		Pointer to pipe configuration
 * @frame_rate:		CRTC's frame rate
 */
static void _dpu_plane_set_ot_limit(struct drm_plane *plane,
		struct dpu_sw_pipe *pipe,
		struct dpu_sw_pipe_cfg *pipe_cfg,
		int frame_rate)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_vbif_set_ot_params ot_params;
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	bool forced_on = false;

	memset(&ot_params, 0, sizeof(ot_params));
	ot_params.xin_id = pipe->sspp->cap->xin_id;
	ot_params.num = pipe->sspp->idx - SSPP_NONE;
	ot_params.width = drm_rect_width(&pipe_cfg->src_rect);
	ot_params.height = drm_rect_height(&pipe_cfg->src_rect);
	ot_params.is_wfd = !pdpu->is_rt_pipe;
	ot_params.frame_rate = frame_rate;
	ot_params.vbif_idx = VBIF_RT;
	ot_params.rd = true;

	if (!_dpu_plane_sspp_clk_force_ctrl(pipe->sspp, dpu_kms->hw_mdp,
					    true, &forced_on))
		return;

	dpu_vbif_set_ot_limit(dpu_kms, &ot_params);

	if (forced_on)
		_dpu_plane_sspp_clk_force_ctrl(pipe->sspp, dpu_kms->hw_mdp,
					       false, &forced_on);
}

/**
 * _dpu_plane_set_qos_remap - set vbif QoS for the given plane
 * @plane:		Pointer to drm plane
 * @pipe:		Pointer to software pipe
 */
static void _dpu_plane_set_qos_remap(struct drm_plane *plane,
		struct dpu_sw_pipe *pipe)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_vbif_set_qos_params qos_params;
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	bool forced_on = false;

	memset(&qos_params, 0, sizeof(qos_params));
	qos_params.vbif_idx = VBIF_RT;
	qos_params.xin_id = pipe->sspp->cap->xin_id;
	qos_params.num = pipe->sspp->idx - SSPP_VIG0;
	qos_params.is_rt = pdpu->is_rt_pipe;

	DPU_DEBUG_PLANE(pdpu, "pipe:%d vbif:%d xin:%d rt:%d\n",
			qos_params.num,
			qos_params.vbif_idx,
			qos_params.xin_id, qos_params.is_rt);

	if (!_dpu_plane_sspp_clk_force_ctrl(pipe->sspp, dpu_kms->hw_mdp,
					    true, &forced_on))
		return;

	dpu_vbif_set_qos_remap(dpu_kms, &qos_params);

	if (forced_on)
		_dpu_plane_sspp_clk_force_ctrl(pipe->sspp, dpu_kms->hw_mdp,
					       false, &forced_on);
}

static void _dpu_plane_setup_scaler3(struct dpu_hw_sspp *pipe_hw,
		uint32_t src_w, uint32_t src_h, uint32_t dst_w, uint32_t dst_h,
		struct dpu_hw_scaler3_cfg *scale_cfg,
		const struct msm_format *fmt,
		uint32_t chroma_subsmpl_h, uint32_t chroma_subsmpl_v,
		unsigned int rotation)
{
	uint32_t i;
	bool inline_rotation = rotation & DRM_MODE_ROTATE_90;

	/*
	 * For inline rotation cases, scaler config is post-rotation,
	 * so swap the dimensions here. However, pixel extension will
	 * need pre-rotation settings.
	 */
	if (inline_rotation)
		swap(src_w, src_h);

	scale_cfg->phase_step_x[DPU_SSPP_COMP_0] =
		mult_frac((1 << PHASE_STEP_SHIFT), src_w, dst_w);
	scale_cfg->phase_step_y[DPU_SSPP_COMP_0] =
		mult_frac((1 << PHASE_STEP_SHIFT), src_h, dst_h);


	scale_cfg->phase_step_y[DPU_SSPP_COMP_1_2] =
		scale_cfg->phase_step_y[DPU_SSPP_COMP_0] / chroma_subsmpl_v;
	scale_cfg->phase_step_x[DPU_SSPP_COMP_1_2] =
		scale_cfg->phase_step_x[DPU_SSPP_COMP_0] / chroma_subsmpl_h;

	scale_cfg->phase_step_x[DPU_SSPP_COMP_2] =
		scale_cfg->phase_step_x[DPU_SSPP_COMP_1_2];
	scale_cfg->phase_step_y[DPU_SSPP_COMP_2] =
		scale_cfg->phase_step_y[DPU_SSPP_COMP_1_2];

	scale_cfg->phase_step_x[DPU_SSPP_COMP_3] =
		scale_cfg->phase_step_x[DPU_SSPP_COMP_0];
	scale_cfg->phase_step_y[DPU_SSPP_COMP_3] =
		scale_cfg->phase_step_y[DPU_SSPP_COMP_0];

	for (i = 0; i < DPU_MAX_PLANES; i++) {
		scale_cfg->src_width[i] = src_w;
		scale_cfg->src_height[i] = src_h;
		if (i == DPU_SSPP_COMP_1_2 || i == DPU_SSPP_COMP_2) {
			scale_cfg->src_width[i] /= chroma_subsmpl_h;
			scale_cfg->src_height[i] /= chroma_subsmpl_v;
		}

		if (pipe_hw->cap->sblk->scaler_blk.version >= 0x3000) {
			scale_cfg->preload_x[i] = DPU_QSEED4_DEFAULT_PRELOAD_H;
			scale_cfg->preload_y[i] = DPU_QSEED4_DEFAULT_PRELOAD_V;
		} else {
			scale_cfg->preload_x[i] = DPU_QSEED3_DEFAULT_PRELOAD_H;
			scale_cfg->preload_y[i] = DPU_QSEED3_DEFAULT_PRELOAD_V;
		}
	}
	if (!(MSM_FORMAT_IS_YUV(fmt)) && (src_h == dst_h)
		&& (src_w == dst_w))
		return;

	scale_cfg->dst_width = dst_w;
	scale_cfg->dst_height = dst_h;
	scale_cfg->y_rgb_filter_cfg = DPU_SCALE_BIL;
	scale_cfg->uv_filter_cfg = DPU_SCALE_BIL;
	scale_cfg->alpha_filter_cfg = DPU_SCALE_ALPHA_BIL;
	scale_cfg->lut_flag = 0;
	scale_cfg->blend_cfg = 1;
	scale_cfg->enable = 1;
}

static void _dpu_plane_setup_pixel_ext(struct dpu_hw_scaler3_cfg *scale_cfg,
				struct dpu_hw_pixel_ext *pixel_ext,
				uint32_t src_w, uint32_t src_h,
				uint32_t chroma_subsmpl_h, uint32_t chroma_subsmpl_v)
{
	int i;

	for (i = 0; i < DPU_MAX_PLANES; i++) {
		uint32_t w = src_w, h = src_h;

		if (i == DPU_SSPP_COMP_1_2 || i == DPU_SSPP_COMP_2) {
			w /= chroma_subsmpl_h;
			h /= chroma_subsmpl_v;
		}

		pixel_ext->num_ext_pxls_top[i] = h;
		pixel_ext->num_ext_pxls_left[i] = w;
	}
}

static const struct dpu_csc_cfg *_dpu_plane_get_csc(struct dpu_sw_pipe *pipe,
						    const struct msm_format *fmt)
{
	const struct dpu_csc_cfg *csc_ptr;

	if (!MSM_FORMAT_IS_YUV(fmt))
		return NULL;

	if (BIT(DPU_SSPP_CSC_10BIT) & pipe->sspp->cap->features)
		csc_ptr = &dpu_csc10_YUV2RGB_601L;
	else
		csc_ptr = &dpu_csc_YUV2RGB_601L;

	return csc_ptr;
}

static void _dpu_plane_setup_scaler(struct dpu_sw_pipe *pipe,
		const struct msm_format *fmt, bool color_fill,
		struct dpu_sw_pipe_cfg *pipe_cfg)
{
	struct dpu_hw_sspp *pipe_hw = pipe->sspp;
	const struct drm_format_info *info = drm_format_info(fmt->pixel_format);
	struct dpu_hw_scaler3_cfg scaler3_cfg;
	struct dpu_hw_pixel_ext pixel_ext;
	u32 src_width = drm_rect_width(&pipe_cfg->src_rect);
	u32 src_height = drm_rect_height(&pipe_cfg->src_rect);
	u32 dst_width = drm_rect_width(&pipe_cfg->dst_rect);
	u32 dst_height = drm_rect_height(&pipe_cfg->dst_rect);

	memset(&scaler3_cfg, 0, sizeof(scaler3_cfg));
	memset(&pixel_ext, 0, sizeof(pixel_ext));

	/* don't chroma subsample if decimating */
	/* update scaler. calculate default config for QSEED3 */
	_dpu_plane_setup_scaler3(pipe_hw,
			src_width,
			src_height,
			dst_width,
			dst_height,
			&scaler3_cfg, fmt,
			info->hsub, info->vsub,
			pipe_cfg->rotation);

	/* configure pixel extension based on scalar config */
	_dpu_plane_setup_pixel_ext(&scaler3_cfg, &pixel_ext,
			src_width, src_height, info->hsub, info->vsub);

	if (pipe_hw->ops.setup_pe)
		pipe_hw->ops.setup_pe(pipe_hw,
				&pixel_ext);

	/**
	 * when programmed in multirect mode, scalar block will be
	 * bypassed. Still we need to update alpha and bitwidth
	 * ONLY for RECT0
	 */
	if (pipe_hw->ops.setup_scaler &&
			pipe->multirect_index != DPU_SSPP_RECT_1)
		pipe_hw->ops.setup_scaler(pipe_hw,
				&scaler3_cfg,
				fmt);
}

static void _dpu_plane_color_fill_pipe(struct dpu_plane_state *pstate,
				       struct dpu_sw_pipe *pipe,
				       struct drm_rect *dst_rect,
				       u32 fill_color,
				       const struct msm_format *fmt)
{
	struct dpu_sw_pipe_cfg pipe_cfg;

	/* update sspp */
	if (!pipe->sspp->ops.setup_solidfill)
		return;

	pipe->sspp->ops.setup_solidfill(pipe, fill_color);

	/* override scaler/decimation if solid fill */
	pipe_cfg.dst_rect = *dst_rect;

	pipe_cfg.src_rect.x1 = 0;
	pipe_cfg.src_rect.y1 = 0;
	pipe_cfg.src_rect.x2 =
		drm_rect_width(&pipe_cfg.dst_rect);
	pipe_cfg.src_rect.y2 =
		drm_rect_height(&pipe_cfg.dst_rect);

	if (pipe->sspp->ops.setup_format)
		pipe->sspp->ops.setup_format(pipe, fmt, DPU_SSPP_SOLID_FILL);

	if (pipe->sspp->ops.setup_rects)
		pipe->sspp->ops.setup_rects(pipe, &pipe_cfg);

	_dpu_plane_setup_scaler(pipe, fmt, true, &pipe_cfg);
}

/**
 * _dpu_plane_color_fill - enables color fill on plane
 * @pdpu:   Pointer to DPU plane object
 * @color:  RGB fill color value, [23..16] Blue, [15..8] Green, [7..0] Red
 * @alpha:  8-bit fill alpha value, 255 selects 100% alpha
 */
static void _dpu_plane_color_fill(struct dpu_plane *pdpu,
		uint32_t color, uint32_t alpha)
{
	const struct msm_format *fmt;
	const struct drm_plane *plane = &pdpu->base;
	struct msm_drm_private *priv = plane->dev->dev_private;
	struct dpu_plane_state *pstate = to_dpu_plane_state(plane->state);
	u32 fill_color = (color & 0xFFFFFF) | ((alpha & 0xFF) << 24);
	int i;

	DPU_DEBUG_PLANE(pdpu, "\n");

	/*
	 * select fill format to match user property expectation,
	 * h/w only supports RGB variants
	 */
	fmt = mdp_get_format(priv->kms, DRM_FORMAT_ABGR8888, 0);
	/* should not happen ever */
	if (!fmt)
		return;

	/* update sspp */
	for (i = 0; i < PIPES_PER_PLANE; i++) {
		if (!pstate->pipe[i].sspp)
			continue;
		_dpu_plane_color_fill_pipe(pstate, &pstate->pipe[i],
					   &pstate->pipe_cfg[i].dst_rect,
					   fill_color, fmt);
	}
}

static int dpu_plane_prepare_fb(struct drm_plane *plane,
		struct drm_plane_state *new_state)
{
	struct drm_framebuffer *fb = new_state->fb;
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_plane_state *pstate = to_dpu_plane_state(new_state);
	int ret;

	if (!new_state->fb)
		return 0;

	DPU_DEBUG_PLANE(pdpu, "FB[%u]\n", fb->base.id);

	/*
	 * TODO: Need to sort out the msm_framebuffer_prepare() call below so
	 *       we can use msm_atomic_prepare_fb() instead of doing the
	 *       implicit fence and fb prepare by hand here.
	 */
	drm_gem_plane_helper_prepare_fb(plane, new_state);

	ret = msm_framebuffer_prepare(new_state->fb, pstate->needs_dirtyfb);
	if (ret) {
		DPU_ERROR("failed to prepare framebuffer\n");
		return ret;
	}

	return 0;
}

static void dpu_plane_cleanup_fb(struct drm_plane *plane,
		struct drm_plane_state *old_state)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_plane_state *old_pstate;

	if (!old_state || !old_state->fb)
		return;

	old_pstate = to_dpu_plane_state(old_state);

	DPU_DEBUG_PLANE(pdpu, "FB[%u]\n", old_state->fb->base.id);

	msm_framebuffer_cleanup(old_state->fb, old_pstate->needs_dirtyfb);
}

static int dpu_plane_check_inline_rotation(struct dpu_plane *pdpu,
					   struct dpu_sw_pipe *pipe,
					   struct drm_rect src,
					   const struct msm_format *fmt)
{
	const struct dpu_sspp_sub_blks *sblk = pipe->sspp->cap->sblk;
	size_t num_formats;
	const u32 *supported_formats;

	if (!test_bit(DPU_SSPP_INLINE_ROTATION, &pipe->sspp->cap->features))
		return -EINVAL;

	if (!sblk->rotation_cfg) {
		DPU_ERROR("invalid rotation cfg\n");
		return -EINVAL;
	}

	if (drm_rect_width(&src) > sblk->rotation_cfg->rot_maxheight) {
		DPU_DEBUG_PLANE(pdpu, "invalid height for inline rot:%d max:%d\n",
				src.y2, sblk->rotation_cfg->rot_maxheight);
		return -EINVAL;
	}

	supported_formats = sblk->rotation_cfg->rot_format_list;
	num_formats = sblk->rotation_cfg->rot_num_formats;

	if (!MSM_FORMAT_IS_UBWC(fmt) ||
		!dpu_find_format(fmt->pixel_format, supported_formats, num_formats))
		return -EINVAL;

	return 0;
}

static int dpu_plane_atomic_check_pipe(struct dpu_plane *pdpu,
		struct dpu_sw_pipe *pipe,
		struct dpu_sw_pipe_cfg *pipe_cfg,
		const struct drm_display_mode *mode,
		struct drm_plane_state *new_plane_state)
{
	uint32_t min_src_size;
	struct dpu_kms *kms = _dpu_plane_get_kms(&pdpu->base);
	int ret;
	const struct msm_format *fmt;
	uint32_t supported_rotations;
	const struct dpu_sspp_cfg *pipe_hw_caps;
	const struct dpu_sspp_sub_blks *sblk;

	pipe_hw_caps = pipe->sspp->cap;
	sblk = pipe->sspp->cap->sblk;

	/*
	 * We already have verified scaling against platform limitations.
	 * Now check if the SSPP supports scaling at all.
	 */
	if (!(sblk->scaler_blk.len && pipe->sspp->ops.setup_scaler) &&
	    ((drm_rect_width(&new_plane_state->src) >> 16 !=
	      drm_rect_width(&new_plane_state->dst)) ||
	     (drm_rect_height(&new_plane_state->src) >> 16 !=
	      drm_rect_height(&new_plane_state->dst))))
		return -ERANGE;

	fmt = msm_framebuffer_format(new_plane_state->fb);

	supported_rotations = DRM_MODE_REFLECT_MASK | DRM_MODE_ROTATE_0;

	if (pipe_hw_caps->features & BIT(DPU_SSPP_INLINE_ROTATION))
		supported_rotations |= DRM_MODE_ROTATE_90;

	pipe_cfg->rotation = drm_rotation_simplify(new_plane_state->rotation,
						   supported_rotations);

	min_src_size = MSM_FORMAT_IS_YUV(fmt) ? 2 : 1;

	if (MSM_FORMAT_IS_YUV(fmt) &&
	    !pipe->sspp->cap->sblk->csc_blk.len) {
		DPU_DEBUG_PLANE(pdpu,
				"plane doesn't have csc for yuv\n");
		return -EINVAL;
	}

	/* check src bounds */
	if (drm_rect_width(&pipe_cfg->src_rect) < min_src_size ||
	    drm_rect_height(&pipe_cfg->src_rect) < min_src_size) {
		DPU_DEBUG_PLANE(pdpu, "invalid source " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&pipe_cfg->src_rect));
		return -E2BIG;
	}

	/* valid yuv image */
	if (MSM_FORMAT_IS_YUV(fmt) &&
	    (pipe_cfg->src_rect.x1 & 0x1 ||
	     pipe_cfg->src_rect.y1 & 0x1 ||
	     drm_rect_width(&pipe_cfg->src_rect) & 0x1 ||
	     drm_rect_height(&pipe_cfg->src_rect) & 0x1)) {
		DPU_DEBUG_PLANE(pdpu, "invalid yuv source " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&pipe_cfg->src_rect));
		return -EINVAL;
	}

	/* min dst support */
	if (drm_rect_width(&pipe_cfg->dst_rect) < 0x1 ||
	    drm_rect_height(&pipe_cfg->dst_rect) < 0x1) {
		DPU_DEBUG_PLANE(pdpu, "invalid dest rect " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&pipe_cfg->dst_rect));
		return -EINVAL;
	}

	if (pipe_cfg->rotation & DRM_MODE_ROTATE_90) {
		ret = dpu_plane_check_inline_rotation(pdpu, pipe, pipe_cfg->src_rect, fmt);
		if (ret)
			return ret;
	}

	/* max clk check */
	if (_dpu_plane_calc_clk(mode, pipe_cfg) > kms->perf.max_core_clk_rate) {
		DPU_DEBUG_PLANE(pdpu, "plane exceeds max mdp core clk limits\n");
		return -E2BIG;
	}

	return 0;
}

#define MAX_UPSCALE_RATIO	20
#define MAX_DOWNSCALE_RATIO	4

static int dpu_plane_atomic_check_nosspp(struct drm_plane *plane,
					 struct drm_plane_state *new_plane_state,
					 const struct drm_crtc_state *crtc_state)
{
	int i, ret = 0, min_scale, max_scale;
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_kms *kms = _dpu_plane_get_kms(&pdpu->base);
	u64 max_mdp_clk_rate = kms->perf.max_core_clk_rate;
	struct dpu_plane_state *pstate = to_dpu_plane_state(new_plane_state);
	struct dpu_sw_pipe_cfg *pipe_cfg;
	struct dpu_sw_pipe_cfg *r_pipe_cfg;
	struct dpu_sw_pipe_cfg init_pipe_cfg;
	struct drm_rect fb_rect = { 0 };
	const struct drm_display_mode *mode = &crtc_state->adjusted_mode;
	uint32_t max_linewidth;
	u32 num_lm;
	int stage_id, num_stages;

	min_scale = FRAC_16_16(1, MAX_UPSCALE_RATIO);
	max_scale = MAX_DOWNSCALE_RATIO << 16;

	ret = drm_atomic_helper_check_plane_state(new_plane_state, crtc_state,
						  min_scale,
						  max_scale,
						  true, true);
	if (ret) {
		DPU_DEBUG_PLANE(pdpu, "Check plane state failed (%d)\n", ret);
		return ret;
	}
	if (!new_plane_state->visible)
		return 0;

	pstate->stage = DPU_STAGE_0 + pstate->base.normalized_zpos;
	if (pstate->stage >= pdpu->catalog->caps->max_mixer_blendstages) {
		DPU_ERROR("> %d plane stages assigned\n",
			  pdpu->catalog->caps->max_mixer_blendstages - DPU_STAGE_0);
		return -EINVAL;
	}

	num_lm = dpu_crtc_get_num_lm(crtc_state);

	/* state->src is 16.16, src_rect is not */
	drm_rect_fp_to_int(&init_pipe_cfg.src_rect, &new_plane_state->src);

	fb_rect.x2 = new_plane_state->fb->width;
	fb_rect.y2 = new_plane_state->fb->height;

	/* Ensure fb size is supported */
	if (drm_rect_width(&fb_rect) > DPU_MAX_IMG_WIDTH ||
	    drm_rect_height(&fb_rect) > DPU_MAX_IMG_HEIGHT) {
		DPU_DEBUG_PLANE(pdpu, "invalid framebuffer " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&fb_rect));
		return -E2BIG;
	}

	ret = dpu_format_populate_plane_sizes(new_plane_state->fb, &pstate->layout);
	if (ret) {
		DPU_ERROR_PLANE(pdpu, "failed to get format plane sizes, %d\n", ret);
		return ret;
	}

	for (i = 0; i < pstate->layout.num_planes; i++)
		if (pstate->layout.plane_pitch[i] > DPU_SSPP_MAX_PITCH_SIZE)
			return -E2BIG;

	max_linewidth = pdpu->catalog->caps->max_linewidth;

	drm_rect_rotate(&init_pipe_cfg.src_rect,
			new_plane_state->fb->width, new_plane_state->fb->height,
			new_plane_state->rotation);

	/*
	 * We have 1 mixer pair cfg for 1:1:1 and 2:2:1 topology, 2 mixer pair
	 * configs for left and right half screen in case of 4:4:2 topology.
	 * But we may have 2 rect to split wide plane that exceeds limit with 1
	 * config for 2:2:1. So need to handle both wide plane splitting, and
	 * two halves of screen splitting for quad-pipe case. Check dest
	 * rectangle left/right clipping first, then check wide rectangle
	 * splitting in every half next.
	 */
	num_stages = (num_lm + 1) / 2;
	/* iterate mixer configs for this plane, to separate left/right with the id */
	for (stage_id = 0; stage_id < num_stages; stage_id++) {
		struct drm_rect mixer_rect = {
			.x1 = stage_id * mode->hdisplay / num_stages,
			.y1 = 0,
			.x2 = (stage_id + 1) * mode->hdisplay / num_stages,
			.y2 = mode->vdisplay
			};
		int cfg_idx = stage_id * PIPES_PER_STAGE;

		pipe_cfg = &pstate->pipe_cfg[cfg_idx];
		r_pipe_cfg = &pstate->pipe_cfg[cfg_idx + 1];

		drm_rect_fp_to_int(&pipe_cfg->src_rect, &new_plane_state->src);
		pipe_cfg->dst_rect = new_plane_state->dst;

		DPU_DEBUG_PLANE(pdpu, "checking src " DRM_RECT_FMT
				" vs clip window " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&pipe_cfg->src_rect),
				DRM_RECT_ARG(&mixer_rect));

		/*
		 * If this plane does not fall into mixer rect, check next
		 * mixer rect.
		 */
		if (!drm_rect_clip_scaled(&pipe_cfg->src_rect,
					  &pipe_cfg->dst_rect,
					  &mixer_rect)) {
			memset(pipe_cfg, 0, 2 * sizeof(struct dpu_sw_pipe_cfg));

			continue;
		}

		pipe_cfg->dst_rect.x1 -= mixer_rect.x1;
		pipe_cfg->dst_rect.x2 -= mixer_rect.x1;

		DPU_DEBUG_PLANE(pdpu, "Got clip src:" DRM_RECT_FMT " dst: " DRM_RECT_FMT "\n",
				DRM_RECT_ARG(&pipe_cfg->src_rect), DRM_RECT_ARG(&pipe_cfg->dst_rect));

		/* Split wide rect into 2 rect */
		if ((drm_rect_width(&pipe_cfg->src_rect) > max_linewidth) ||
		     _dpu_plane_calc_clk(mode, pipe_cfg) > max_mdp_clk_rate) {

			if (drm_rect_width(&pipe_cfg->src_rect) > 2 * max_linewidth) {
				DPU_DEBUG_PLANE(pdpu, "invalid src " DRM_RECT_FMT " line:%u\n",
						DRM_RECT_ARG(&pipe_cfg->src_rect), max_linewidth);
				return -E2BIG;
			}

			memcpy(r_pipe_cfg, pipe_cfg, sizeof(struct dpu_sw_pipe_cfg));
			pipe_cfg->src_rect.x2 = (pipe_cfg->src_rect.x1 + pipe_cfg->src_rect.x2) >> 1;
			pipe_cfg->dst_rect.x2 = (pipe_cfg->dst_rect.x1 + pipe_cfg->dst_rect.x2) >> 1;
			r_pipe_cfg->src_rect.x1 = pipe_cfg->src_rect.x2;
			r_pipe_cfg->dst_rect.x1 = pipe_cfg->dst_rect.x2;
			DPU_DEBUG_PLANE(pdpu, "Split wide plane into:"
					DRM_RECT_FMT " and " DRM_RECT_FMT "\n",
					DRM_RECT_ARG(&pipe_cfg->src_rect),
					DRM_RECT_ARG(&r_pipe_cfg->src_rect));
		} else {
			memset(r_pipe_cfg, 0, sizeof(struct dpu_sw_pipe_cfg));
		}

		drm_rect_rotate_inv(&pipe_cfg->src_rect,
				    new_plane_state->fb->width,
				    new_plane_state->fb->height,
				    new_plane_state->rotation);

		if (drm_rect_width(&r_pipe_cfg->src_rect) != 0)
			drm_rect_rotate_inv(&r_pipe_cfg->src_rect,
					    new_plane_state->fb->width,
					    new_plane_state->fb->height,
					    new_plane_state->rotation);
	}

	pstate->needs_qos_remap = drm_atomic_crtc_needs_modeset(crtc_state);

	return 0;
}

static int dpu_plane_is_multirect_capable(struct dpu_hw_sspp *sspp,
					  struct dpu_sw_pipe_cfg *pipe_cfg,
					  const struct msm_format *fmt)
{
	if (drm_rect_width(&pipe_cfg->src_rect) != drm_rect_width(&pipe_cfg->dst_rect) ||
	    drm_rect_height(&pipe_cfg->src_rect) != drm_rect_height(&pipe_cfg->dst_rect))
		return false;

	if (pipe_cfg->rotation & DRM_MODE_ROTATE_90)
		return false;

	if (MSM_FORMAT_IS_YUV(fmt))
		return false;

	if (!sspp)
		return true;

	if (!test_bit(DPU_SSPP_SMART_DMA_V1, &sspp->cap->features) &&
	    !test_bit(DPU_SSPP_SMART_DMA_V2, &sspp->cap->features))
		return false;

	return true;
}

static int dpu_plane_is_parallel_capable(struct dpu_sw_pipe_cfg *pipe_cfg,
					 const struct msm_format *fmt,
					 uint32_t max_linewidth)
{
	if (MSM_FORMAT_IS_UBWC(fmt) &&
	    drm_rect_width(&pipe_cfg->src_rect) > max_linewidth / 2)
		return false;

	return true;
}

static int dpu_plane_is_multirect_parallel_capable(struct dpu_hw_sspp *sspp,
						   struct dpu_sw_pipe_cfg *pipe_cfg,
						   const struct msm_format *fmt,
						   uint32_t max_linewidth)
{
	return dpu_plane_is_multirect_capable(sspp, pipe_cfg, fmt) &&
		dpu_plane_is_parallel_capable(pipe_cfg, fmt, max_linewidth);
}

static bool dpu_plane_get_single_pipe_in_stage(struct dpu_plane_state *pstate,
					       struct dpu_sw_pipe **single_pipe,
					       struct dpu_sw_pipe_cfg **single_pipe_cfg,
					       int stage_index)
{
	int pipe_idx;

	pipe_idx = stage_index * PIPES_PER_STAGE;
	if (drm_rect_width(&pstate->pipe_cfg[pipe_idx].src_rect) != 0 &&
	    drm_rect_width(&pstate->pipe_cfg[pipe_idx + 1].src_rect) == 0) {
		*single_pipe = &pstate->pipe[pipe_idx];
		*single_pipe_cfg = &pstate->pipe_cfg[pipe_idx];
		return true;
	}

	return false;
}

static int dpu_plane_atomic_check_sspp(struct drm_plane *plane,
				       struct drm_atomic_state *state,
				       const struct drm_crtc_state *crtc_state)
{
	struct drm_plane_state *new_plane_state =
		drm_atomic_get_new_plane_state(state, plane);
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_plane_state *pstate = to_dpu_plane_state(new_plane_state);
	struct dpu_sw_pipe *pipe;
	struct dpu_sw_pipe_cfg *pipe_cfg;
	int ret = 0, i;

	for (i = 0; i < PIPES_PER_PLANE; i++) {
		pipe = &pstate->pipe[i];
		pipe_cfg = &pstate->pipe_cfg[i];
		if (!drm_rect_width(&pipe_cfg->src_rect))
			continue;
		DPU_DEBUG_PLANE(pdpu, "pipe %d is in use, validate it\n", i);
		ret = dpu_plane_atomic_check_pipe(pdpu, pipe, pipe_cfg,
						  &crtc_state->adjusted_mode,
						  new_plane_state);
		if (ret)
			return ret;
	}

	return 0;
}

static bool dpu_plane_try_multirect_parallel(struct dpu_sw_pipe *pipe, struct dpu_sw_pipe_cfg *pipe_cfg,
					     struct dpu_sw_pipe *r_pipe, struct dpu_sw_pipe_cfg *r_pipe_cfg,
					     struct dpu_hw_sspp *sspp, const struct msm_format *fmt,
					     uint32_t max_linewidth)
{
	r_pipe->sspp = NULL;

	pipe->multirect_index = DPU_SSPP_RECT_SOLO;
	pipe->multirect_mode = DPU_SSPP_MULTIRECT_NONE;

	r_pipe->multirect_index = DPU_SSPP_RECT_SOLO;
	r_pipe->multirect_mode = DPU_SSPP_MULTIRECT_NONE;

	if (drm_rect_width(&r_pipe_cfg->src_rect) != 0) {
		if (!dpu_plane_is_multirect_parallel_capable(pipe->sspp, pipe_cfg, fmt, max_linewidth) ||
		    !dpu_plane_is_multirect_parallel_capable(pipe->sspp, r_pipe_cfg, fmt, max_linewidth))
			return false;

		r_pipe->sspp = pipe->sspp;

		pipe->multirect_index = DPU_SSPP_RECT_0;
		pipe->multirect_mode = DPU_SSPP_MULTIRECT_PARALLEL;

		r_pipe->multirect_index = DPU_SSPP_RECT_1;
		r_pipe->multirect_mode = DPU_SSPP_MULTIRECT_PARALLEL;
	}

	return true;
}

static int dpu_plane_try_multirect_shared(struct dpu_plane_state *pstate,
					  struct dpu_plane_state *prev_adjacent_pstate,
					  const struct msm_format *fmt,
					  uint32_t max_linewidth, int stage_index)
{
	struct dpu_sw_pipe *pipe, *prev_pipe;
	struct dpu_sw_pipe_cfg *pipe_cfg, *prev_pipe_cfg;
	const struct msm_format *prev_fmt = msm_framebuffer_format(prev_adjacent_pstate->base.fb);
	u16 max_tile_height = 1;

	if (!dpu_plane_get_single_pipe_in_stage(pstate, &pipe,
						&pipe_cfg, stage_index))
		return false;

	if (!dpu_plane_get_single_pipe_in_stage(prev_adjacent_pstate,
						&prev_pipe, &prev_pipe_cfg,
						stage_index) ||
	    prev_pipe->multirect_mode != DPU_SSPP_MULTIRECT_NONE)
		return false;

	/* Do not validate SSPP of current plane when it is not ready */
	if (!dpu_plane_is_multirect_capable(pipe->sspp, pipe_cfg, fmt) ||
	    !dpu_plane_is_multirect_capable(prev_pipe->sspp, prev_pipe_cfg, prev_fmt))
		return false;

	if (MSM_FORMAT_IS_UBWC(fmt))
		max_tile_height = max(max_tile_height, fmt->tile_height);

	if (MSM_FORMAT_IS_UBWC(prev_fmt))
		max_tile_height = max(max_tile_height, prev_fmt->tile_height);

	if (dpu_plane_is_parallel_capable(pipe_cfg, fmt, max_linewidth) &&
	    dpu_plane_is_parallel_capable(prev_pipe_cfg, prev_fmt, max_linewidth) &&
	    (pipe_cfg->dst_rect.x1 >= prev_pipe_cfg->dst_rect.x2 ||
	     prev_pipe_cfg->dst_rect.x1 >= pipe_cfg->dst_rect.x2)) {
		pipe->sspp = prev_pipe->sspp;

		pipe->multirect_index = DPU_SSPP_RECT_1;
		pipe->multirect_mode = DPU_SSPP_MULTIRECT_PARALLEL;

		prev_pipe->multirect_index = DPU_SSPP_RECT_0;
		prev_pipe->multirect_mode = DPU_SSPP_MULTIRECT_PARALLEL;

		return true;
	}

	if (pipe_cfg->dst_rect.y1 >= prev_pipe_cfg->dst_rect.y2 + 2 * max_tile_height ||
	    prev_pipe_cfg->dst_rect.y1 >= pipe_cfg->dst_rect.y2 + 2 * max_tile_height) {
		pipe->sspp = prev_pipe->sspp;

		pipe->multirect_index = DPU_SSPP_RECT_1;
		pipe->multirect_mode = DPU_SSPP_MULTIRECT_TIME_MX;

		prev_pipe->multirect_index = DPU_SSPP_RECT_0;
		prev_pipe->multirect_mode = DPU_SSPP_MULTIRECT_TIME_MX;

		return true;
	}

	return false;
}

static int dpu_plane_atomic_check(struct drm_plane *plane,
				  struct drm_atomic_state *state)
{
	struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
										 plane);
	int ret = 0;
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_plane_state *pstate = to_dpu_plane_state(new_plane_state);
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	struct dpu_sw_pipe *pipe = &pstate->pipe[0];
	struct dpu_sw_pipe *r_pipe = &pstate->pipe[1];
	struct dpu_sw_pipe_cfg *pipe_cfg = &pstate->pipe_cfg[0];
	struct dpu_sw_pipe_cfg *r_pipe_cfg = &pstate->pipe_cfg[1];
	const struct drm_crtc_state *crtc_state = NULL;
	uint32_t max_linewidth = dpu_kms->catalog->caps->max_linewidth;

	if (new_plane_state->crtc)
		crtc_state = drm_atomic_get_new_crtc_state(state,
							   new_plane_state->crtc);

	pipe->sspp = dpu_rm_get_sspp(&dpu_kms->rm, pdpu->pipe);

	if (!pipe->sspp)
		return -EINVAL;

	ret = dpu_plane_atomic_check_nosspp(plane, new_plane_state, crtc_state);
	if (ret)
		return ret;

	if (!new_plane_state->visible)
		return 0;

	if (!dpu_plane_try_multirect_parallel(pipe, pipe_cfg, r_pipe, r_pipe_cfg,
					      pipe->sspp,
					      msm_framebuffer_format(new_plane_state->fb),
					      max_linewidth)) {
		DPU_DEBUG_PLANE(pdpu, "invalid " DRM_RECT_FMT " /" DRM_RECT_FMT
				" max_line:%u, can't use split source\n",
				DRM_RECT_ARG(&pipe_cfg->src_rect),
				DRM_RECT_ARG(&r_pipe_cfg->src_rect),
				max_linewidth);
		return -E2BIG;
	}

	return dpu_plane_atomic_check_sspp(plane, state, crtc_state);
}

static int dpu_plane_virtual_atomic_check(struct drm_plane *plane,
					  struct drm_atomic_state *state)
{
	struct drm_plane_state *plane_state =
		drm_atomic_get_plane_state(state, plane);
	struct drm_plane_state *old_plane_state =
		drm_atomic_get_old_plane_state(state, plane);
	struct dpu_plane_state *pstate = to_dpu_plane_state(plane_state);
	struct drm_crtc_state *crtc_state = NULL;
	int ret, i;

	if (IS_ERR(plane_state))
		return PTR_ERR(plane_state);

	if (plane_state->crtc)
		crtc_state = drm_atomic_get_new_crtc_state(state,
							   plane_state->crtc);

	ret = dpu_plane_atomic_check_nosspp(plane, plane_state, crtc_state);
	if (ret)
		return ret;

	if (!plane_state->visible) {
		/*
		 * resources are freed by dpu_crtc_assign_plane_resources(),
		 * but clean them here.
		 */
		for (i = 0; i < PIPES_PER_PLANE; i++)
			pstate->pipe[i].sspp = NULL;

		return 0;
	}

	/*
	 * Force resource reallocation if the format of FB or src/dst have
	 * changed. We might need to allocate different SSPP or SSPPs for this
	 * plane than the one used previously.
	 */
	if (!old_plane_state || !old_plane_state->fb ||
	    old_plane_state->src_w != plane_state->src_w ||
	    old_plane_state->src_h != plane_state->src_h ||
	    old_plane_state->crtc_w != plane_state->crtc_w ||
	    old_plane_state->crtc_h != plane_state->crtc_h ||
	    msm_framebuffer_format(old_plane_state->fb) !=
	    msm_framebuffer_format(plane_state->fb))
		crtc_state->planes_changed = true;

	return 0;
}

static int dpu_plane_assign_resource_in_stage(struct dpu_sw_pipe *pipe,
					      struct dpu_sw_pipe_cfg *pipe_cfg,
					      struct drm_plane_state *plane_state,
					      struct dpu_global_state *global_state,
					      struct drm_crtc *crtc,
					      struct dpu_rm_sspp_requirements *reqs)
{
	struct drm_plane *plane = plane_state->plane;
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	struct dpu_sw_pipe *r_pipe = pipe + 1;
	struct dpu_sw_pipe_cfg *r_pipe_cfg = pipe_cfg + 1;

	if (drm_rect_width(&pipe_cfg->src_rect) == 0)
		return 0;

	pipe->sspp = dpu_rm_reserve_sspp(&dpu_kms->rm, global_state, crtc, reqs);
	if (!pipe->sspp)
		return -ENODEV;
	pipe->multirect_index = DPU_SSPP_RECT_SOLO;
	pipe->multirect_mode = DPU_SSPP_MULTIRECT_NONE;

	if (drm_rect_width(&r_pipe_cfg->src_rect) == 0)
		return 0;

	if (dpu_plane_try_multirect_parallel(pipe, pipe_cfg, r_pipe, r_pipe_cfg,
					      pipe->sspp,
					      msm_framebuffer_format(plane_state->fb),
					      dpu_kms->catalog->caps->max_linewidth))
		return 0;

	r_pipe->sspp = dpu_rm_reserve_sspp(&dpu_kms->rm, global_state, crtc, reqs);
	if (!r_pipe->sspp)
		return -ENODEV;
	r_pipe->multirect_index = DPU_SSPP_RECT_SOLO;
	r_pipe->multirect_mode = DPU_SSPP_MULTIRECT_NONE;

	return 0;
}

static int dpu_plane_virtual_assign_resources(struct drm_crtc *crtc,
					      struct dpu_global_state *global_state,
					      struct drm_atomic_state *state,
					      struct drm_plane_state *plane_state,
					      struct drm_plane_state **prev_adjacent_plane_state)
{
	const struct drm_crtc_state *crtc_state = NULL;
	struct drm_plane *plane = plane_state->plane;
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	struct dpu_rm_sspp_requirements reqs;
	struct dpu_plane_state *pstate, *prev_adjacent_pstate[STAGES_PER_PLANE];
	struct dpu_sw_pipe *pipe;
	struct dpu_sw_pipe_cfg *pipe_cfg;
	const struct msm_format *fmt;
	int i, ret;

	if (plane_state->crtc)
		crtc_state = drm_atomic_get_new_crtc_state(state,
							   plane_state->crtc);

	pstate = to_dpu_plane_state(plane_state);
	for (i = 0; i < STAGES_PER_PLANE; i++)
		prev_adjacent_pstate[i] = prev_adjacent_plane_state[i] ?
			to_dpu_plane_state(prev_adjacent_plane_state[i]) : NULL;

	for (i = 0; i < PIPES_PER_PLANE; i++)
		pstate->pipe[i].sspp = NULL;

	if (!plane_state->fb)
		return -EINVAL;

	fmt = msm_framebuffer_format(plane_state->fb);
	reqs.yuv = MSM_FORMAT_IS_YUV(fmt);
	reqs.scale = (plane_state->src_w >> 16 != plane_state->crtc_w) ||
		(plane_state->src_h >> 16 != plane_state->crtc_h);

	reqs.rot90 = drm_rotation_90_or_270(plane_state->rotation);

	for (i = 0; i < STAGES_PER_PLANE; i++) {
		if (prev_adjacent_pstate[i] &&
		    dpu_plane_try_multirect_shared(pstate, prev_adjacent_pstate[i], fmt,
						   dpu_kms->catalog->caps->max_linewidth,
						   i))
			continue;

		if (dpu_plane_get_single_pipe_in_stage(pstate, &pipe, &pipe_cfg, i))
			prev_adjacent_plane_state[i] = plane_state;

		pipe = &pstate->pipe[i * PIPES_PER_STAGE];
		pipe_cfg = &pstate->pipe_cfg[i * PIPES_PER_STAGE];
		ret = dpu_plane_assign_resource_in_stage(pipe, pipe_cfg,
							 plane_state,
							 global_state,
							 crtc, &reqs);
		if (ret)
			return ret;
	}

	return dpu_plane_atomic_check_sspp(plane, state, crtc_state);
}

int dpu_assign_plane_resources(struct dpu_global_state *global_state,
			       struct drm_atomic_state *state,
			       struct drm_crtc *crtc,
			       struct drm_plane_state **states,
			       unsigned int num_planes)
{
	unsigned int i;
	struct drm_plane_state *prev_adjacent_plane_state[STAGES_PER_PLANE] = { NULL };

	for (i = 0; i < num_planes; i++) {
		struct drm_plane_state *plane_state = states[i];

		if (!plane_state ||
		    !plane_state->visible)
			continue;

		int ret = dpu_plane_virtual_assign_resources(crtc, global_state,
							     state, plane_state,
							     prev_adjacent_plane_state);
		if (ret)
			return ret;
	}

	return 0;
}

static void dpu_plane_flush_csc(struct dpu_plane *pdpu, struct dpu_sw_pipe *pipe)
{
	const struct msm_format *format =
		msm_framebuffer_format(pdpu->base.state->fb);
	const struct dpu_csc_cfg *csc_ptr;

	if (!pipe->sspp || !pipe->sspp->ops.setup_csc)
		return;

	csc_ptr = _dpu_plane_get_csc(pipe, format);
	if (!csc_ptr)
		return;

	DPU_DEBUG_PLANE(pdpu, "using 0x%X 0x%X 0x%X...\n",
			csc_ptr->csc_mv[0],
			csc_ptr->csc_mv[1],
			csc_ptr->csc_mv[2]);

	pipe->sspp->ops.setup_csc(pipe->sspp, csc_ptr);

}

/**
 * dpu_plane_flush - final plane operations before commit flush
 * @plane: Pointer to drm plane structure
 */
void dpu_plane_flush(struct drm_plane *plane)
{
	struct dpu_plane *pdpu;
	struct dpu_plane_state *pstate;
	int i;

	if (!plane || !plane->state) {
		DPU_ERROR("invalid plane\n");
		return;
	}

	pdpu = to_dpu_plane(plane);
	pstate = to_dpu_plane_state(plane->state);

	/*
	 * These updates have to be done immediately before the plane flush
	 * timing, and may not be moved to the atomic_update/mode_set functions.
	 */
	if (pdpu->is_error)
		/* force white frame with 100% alpha pipe output on error */
		_dpu_plane_color_fill(pdpu, 0xFFFFFF, 0xFF);
	else if (pdpu->color_fill & DPU_PLANE_COLOR_FILL_FLAG)
		/* force 100% alpha */
		_dpu_plane_color_fill(pdpu, pdpu->color_fill, 0xFF);
	else {
		for (i = 0; i < PIPES_PER_PLANE; i++)
			dpu_plane_flush_csc(pdpu, &pstate->pipe[i]);
	}

	/* flag h/w flush complete */
	if (plane->state)
		pstate->pending = false;
}

/**
 * dpu_plane_set_error: enable/disable error condition
 * @plane: pointer to drm_plane structure
 * @error: error value to set
 */
void dpu_plane_set_error(struct drm_plane *plane, bool error)
{
	struct dpu_plane *pdpu;

	if (!plane)
		return;

	pdpu = to_dpu_plane(plane);
	pdpu->is_error = error;
}

static void dpu_plane_sspp_update_pipe(struct drm_plane *plane,
				       struct dpu_sw_pipe *pipe,
				       struct dpu_sw_pipe_cfg *pipe_cfg,
				       const struct msm_format *fmt,
				       int frame_rate,
				       struct dpu_hw_fmt_layout *layout)
{
	uint32_t src_flags;
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct drm_plane_state *state = plane->state;
	struct dpu_plane_state *pstate = to_dpu_plane_state(state);

	if (layout && pipe->sspp->ops.setup_sourceaddress) {
		trace_dpu_plane_set_scanout(pipe, layout);
		pipe->sspp->ops.setup_sourceaddress(pipe, layout);
	}

	/* override for color fill */
	if (pdpu->color_fill & DPU_PLANE_COLOR_FILL_FLAG) {
		_dpu_plane_set_qos_ctrl(plane, pipe, false);

		/* skip remaining processing on color fill */
		return;
	}

	if (pipe->sspp->ops.setup_rects) {
		pipe->sspp->ops.setup_rects(pipe,
				pipe_cfg);
	}

	_dpu_plane_setup_scaler(pipe, fmt, false, pipe_cfg);

	if (pipe->sspp->ops.setup_multirect)
		pipe->sspp->ops.setup_multirect(
				pipe);

	if (pipe->sspp->ops.setup_format) {
		unsigned int rotation = pipe_cfg->rotation;

		src_flags = 0x0;

		if (rotation & DRM_MODE_REFLECT_X)
			src_flags |= DPU_SSPP_FLIP_LR;

		if (rotation & DRM_MODE_REFLECT_Y)
			src_flags |= DPU_SSPP_FLIP_UD;

		if (rotation & DRM_MODE_ROTATE_90)
			src_flags |= DPU_SSPP_ROT_90;

		/* update format */
		pipe->sspp->ops.setup_format(pipe, fmt, src_flags);

		if (pipe->sspp->ops.setup_cdp) {
			const struct dpu_perf_cfg *perf = pdpu->catalog->perf;

			pipe->sspp->ops.setup_cdp(pipe, fmt,
						  perf->cdp_cfg[DPU_PERF_CDP_USAGE_RT].rd_enable);
		}
	}

	_dpu_plane_set_qos_lut(plane, pipe, fmt, pipe_cfg);

	if (pipe->sspp->idx != SSPP_CURSOR0 &&
	    pipe->sspp->idx != SSPP_CURSOR1)
		_dpu_plane_set_ot_limit(plane, pipe, pipe_cfg, frame_rate);

	if (pstate->needs_qos_remap)
		_dpu_plane_set_qos_remap(plane, pipe);
}

static void dpu_plane_sspp_atomic_update(struct drm_plane *plane,
					 struct drm_plane_state *new_state)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct drm_plane_state *state = plane->state;
	struct dpu_plane_state *pstate = to_dpu_plane_state(state);
	struct drm_crtc *crtc = state->crtc;
	struct drm_framebuffer *fb = state->fb;
	bool is_rt_pipe;
	const struct msm_format *fmt =
		msm_framebuffer_format(fb);
	int i;

	pstate->pending = true;

	is_rt_pipe = (dpu_crtc_get_client_type(crtc) != NRT_CLIENT);
	pstate->needs_qos_remap |= (is_rt_pipe != pdpu->is_rt_pipe);
	pdpu->is_rt_pipe = is_rt_pipe;

	dpu_format_populate_addrs(new_state->fb, &pstate->layout);

	DPU_DEBUG_PLANE(pdpu, "FB[%u] " DRM_RECT_FP_FMT "->crtc%u " DRM_RECT_FMT
			", %p4cc ubwc %d\n", fb->base.id, DRM_RECT_FP_ARG(&state->src),
			crtc->base.id, DRM_RECT_ARG(&state->dst),
			&fmt->pixel_format, MSM_FORMAT_IS_UBWC(fmt));

	for (i = 0; i < PIPES_PER_PLANE; i++) {
		if (!drm_rect_width(&pstate->pipe_cfg[i].src_rect))
			continue;
		dpu_plane_sspp_update_pipe(plane, &pstate->pipe[i],
					   &pstate->pipe_cfg[i], fmt,
					   drm_mode_vrefresh(&crtc->mode),
					   &pstate->layout);
	}

	if (pstate->needs_qos_remap)
		pstate->needs_qos_remap = false;

	pstate->plane_fetch_bw = 0;
	pstate->plane_clk = 0;
	for (i = 0; i < PIPES_PER_PLANE; i++) {
		if (!drm_rect_width(&pstate->pipe_cfg[i].src_rect))
			continue;
		pstate->plane_fetch_bw += _dpu_plane_calc_bw(pdpu->catalog, fmt,
							     &crtc->mode, &pstate->pipe_cfg[i]);

		pstate->plane_clk = max(pstate->plane_clk,
					_dpu_plane_calc_clk(&crtc->mode,
							    &pstate->pipe_cfg[i]));
	}
}

static void _dpu_plane_atomic_disable(struct drm_plane *plane)
{
	struct drm_plane_state *state = plane->state;
	struct dpu_plane_state *pstate = to_dpu_plane_state(state);
	struct dpu_sw_pipe *pipe;
	int i;

	for (i = 0; i < PIPES_PER_PLANE; i += 1) {
		pipe = &pstate->pipe[i];
		if (!pipe->sspp)
			continue;

		trace_dpu_plane_disable(DRMID(plane), false,
					pstate->pipe[i].multirect_mode);

		if (i % PIPES_PER_STAGE == 0)
			continue;

		/*
		 * clear multirect for the right pipe so that the SSPP
		 * can be further reused in the solo mode
		 */
		pipe->multirect_index = DPU_SSPP_RECT_SOLO;
		pipe->multirect_mode = DPU_SSPP_MULTIRECT_NONE;
		if (pipe->sspp->ops.setup_multirect)
			pipe->sspp->ops.setup_multirect(pipe);
	}

	pstate->pending = true;
}

static void dpu_plane_atomic_update(struct drm_plane *plane,
				struct drm_atomic_state *state)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
									   plane);

	pdpu->is_error = false;

	DPU_DEBUG_PLANE(pdpu, "\n");

	if (!new_state->visible) {
		_dpu_plane_atomic_disable(plane);
	} else {
		dpu_plane_sspp_atomic_update(plane, new_state);
	}
}

static void dpu_plane_destroy_state(struct drm_plane *plane,
		struct drm_plane_state *state)
{
	__drm_atomic_helper_plane_destroy_state(state);
	kfree(to_dpu_plane_state(state));
}

static struct drm_plane_state *
dpu_plane_duplicate_state(struct drm_plane *plane)
{
	struct dpu_plane *pdpu;
	struct dpu_plane_state *pstate;
	struct dpu_plane_state *old_state;

	if (!plane) {
		DPU_ERROR("invalid plane\n");
		return NULL;
	} else if (!plane->state) {
		DPU_ERROR("invalid plane state\n");
		return NULL;
	}

	old_state = to_dpu_plane_state(plane->state);
	pdpu = to_dpu_plane(plane);
	pstate = kmemdup(old_state, sizeof(*old_state), GFP_KERNEL);
	if (!pstate) {
		DPU_ERROR_PLANE(pdpu, "failed to allocate state\n");
		return NULL;
	}

	DPU_DEBUG_PLANE(pdpu, "\n");

	pstate->pending = false;

	__drm_atomic_helper_plane_duplicate_state(plane, &pstate->base);

	return &pstate->base;
}

static const char * const multirect_mode_name[] = {
	[DPU_SSPP_MULTIRECT_NONE] = "none",
	[DPU_SSPP_MULTIRECT_PARALLEL] = "parallel",
	[DPU_SSPP_MULTIRECT_TIME_MX] = "time_mx",
};

static const char * const multirect_index_name[] = {
	[DPU_SSPP_RECT_SOLO] = "solo",
	[DPU_SSPP_RECT_0] = "rect_0",
	[DPU_SSPP_RECT_1] = "rect_1",
};

static const char *dpu_get_multirect_mode(enum dpu_sspp_multirect_mode mode)
{
	if (WARN_ON(mode >= ARRAY_SIZE(multirect_mode_name)))
		return "unknown";

	return multirect_mode_name[mode];
}

static const char *dpu_get_multirect_index(enum dpu_sspp_multirect_index index)
{
	if (WARN_ON(index >= ARRAY_SIZE(multirect_index_name)))
		return "unknown";

	return multirect_index_name[index];
}

static void dpu_plane_atomic_print_state(struct drm_printer *p,
		const struct drm_plane_state *state)
{
	const struct dpu_plane_state *pstate = to_dpu_plane_state(state);
	const struct dpu_sw_pipe *pipe;
	const struct dpu_sw_pipe_cfg *pipe_cfg;
	int i;

	drm_printf(p, "\tstage=%d\n", pstate->stage);

	for (i = 0; i < PIPES_PER_PLANE; i++) {
		pipe = &pstate->pipe[i];
		if (!pipe->sspp)
			continue;
		pipe_cfg = &pstate->pipe_cfg[i];
		drm_printf(p, "\tsspp[%d]=%s\n", i, pipe->sspp->cap->name);
		drm_printf(p, "\tmultirect_mode[%d]=%s\n", i,
			   dpu_get_multirect_mode(pipe->multirect_mode));
		drm_printf(p, "\tmultirect_index[%d]=%s\n", i,
			   dpu_get_multirect_index(pipe->multirect_index));
		drm_printf(p, "\tsrc[%d]=" DRM_RECT_FMT "\n", i,
			   DRM_RECT_ARG(&pipe_cfg->src_rect));
		drm_printf(p, "\tdst[%d]=" DRM_RECT_FMT "\n", i,
			   DRM_RECT_ARG(&pipe_cfg->dst_rect));
	}
}

static void dpu_plane_reset(struct drm_plane *plane)
{
	struct dpu_plane *pdpu;
	struct dpu_plane_state *pstate;

	if (!plane) {
		DPU_ERROR("invalid plane\n");
		return;
	}

	pdpu = to_dpu_plane(plane);
	DPU_DEBUG_PLANE(pdpu, "\n");

	/* remove previous state, if present */
	if (plane->state) {
		dpu_plane_destroy_state(plane, plane->state);
		plane->state = NULL;
	}

	pstate = kzalloc(sizeof(*pstate), GFP_KERNEL);
	if (!pstate) {
		DPU_ERROR_PLANE(pdpu, "failed to allocate state\n");
		return;
	}

	__drm_atomic_helper_plane_reset(plane, &pstate->base);
}

#ifdef CONFIG_DEBUG_FS
void dpu_plane_danger_signal_ctrl(struct drm_plane *plane, bool enable)
{
	struct dpu_plane *pdpu = to_dpu_plane(plane);
	struct dpu_plane_state *pstate = to_dpu_plane_state(plane->state);
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	int i;

	if (!pdpu->is_rt_pipe)
		return;

	pm_runtime_get_sync(&dpu_kms->pdev->dev);
	for (i = 0; i < PIPES_PER_PLANE; i++) {
		if (!pstate->pipe[i].sspp)
			continue;
		_dpu_plane_set_qos_ctrl(plane, &pstate->pipe[i], enable);
	}
	pm_runtime_put_sync(&dpu_kms->pdev->dev);
}
#endif

static bool dpu_plane_format_mod_supported(struct drm_plane *plane,
		uint32_t format, uint64_t modifier)
{
	struct dpu_kms *dpu_kms = _dpu_plane_get_kms(plane);
	bool has_no_ubwc = (dpu_kms->mdss->ubwc_enc_version == 0) &&
			   (dpu_kms->mdss->ubwc_dec_version == 0);

	if (modifier == DRM_FORMAT_MOD_LINEAR)
		return true;

	if (modifier == DRM_FORMAT_MOD_QCOM_COMPRESSED && !has_no_ubwc)
		return dpu_find_format(format, qcom_compressed_supported_formats,
				ARRAY_SIZE(qcom_compressed_supported_formats));

	return false;
}

static const struct drm_plane_funcs dpu_plane_funcs = {
		.update_plane = drm_atomic_helper_update_plane,
		.disable_plane = drm_atomic_helper_disable_plane,
		.reset = dpu_plane_reset,
		.atomic_duplicate_state = dpu_plane_duplicate_state,
		.atomic_destroy_state = dpu_plane_destroy_state,
		.atomic_print_state = dpu_plane_atomic_print_state,
		.format_mod_supported = dpu_plane_format_mod_supported,
};

static const struct drm_plane_helper_funcs dpu_plane_helper_funcs = {
		.prepare_fb = dpu_plane_prepare_fb,
		.cleanup_fb = dpu_plane_cleanup_fb,
		.atomic_check = dpu_plane_atomic_check,
		.atomic_update = dpu_plane_atomic_update,
};

static const struct drm_plane_helper_funcs dpu_plane_virtual_helper_funcs = {
	.prepare_fb = dpu_plane_prepare_fb,
	.cleanup_fb = dpu_plane_cleanup_fb,
	.atomic_check = dpu_plane_virtual_atomic_check,
	.atomic_update = dpu_plane_atomic_update,
};

/* initialize plane */
static struct drm_plane *dpu_plane_init_common(struct drm_device *dev,
					       enum drm_plane_type type,
					       unsigned long possible_crtcs,
					       bool inline_rotation,
					       const uint32_t *format_list,
					       uint32_t num_formats,
					       enum dpu_sspp pipe)
{
	struct drm_plane *plane = NULL;
	struct dpu_plane *pdpu;
	struct msm_drm_private *priv = dev->dev_private;
	struct dpu_kms *kms = to_dpu_kms(priv->kms);
	uint32_t supported_rotations;
	int ret;

	pdpu = drmm_universal_plane_alloc(dev, struct dpu_plane, base,
				0xff, &dpu_plane_funcs,
				format_list, num_formats,
				supported_format_modifiers, type, NULL);
	if (IS_ERR(pdpu))
		return ERR_CAST(pdpu);

	/* cache local stuff for later */
	plane = &pdpu->base;
	pdpu->pipe = pipe;

	pdpu->catalog = kms->catalog;

	ret = drm_plane_create_zpos_property(plane, 0, 0, DPU_ZPOS_MAX);
	if (ret)
		DPU_ERROR("failed to install zpos property, rc = %d\n", ret);

	drm_plane_create_alpha_property(plane);
	drm_plane_create_blend_mode_property(plane,
			BIT(DRM_MODE_BLEND_PIXEL_NONE) |
			BIT(DRM_MODE_BLEND_PREMULTI) |
			BIT(DRM_MODE_BLEND_COVERAGE));

	supported_rotations = DRM_MODE_REFLECT_MASK | DRM_MODE_ROTATE_0 | DRM_MODE_ROTATE_180;

	if (inline_rotation)
		supported_rotations |= DRM_MODE_ROTATE_MASK;

	drm_plane_create_rotation_property(plane,
		    DRM_MODE_ROTATE_0, supported_rotations);

	drm_plane_enable_fb_damage_clips(plane);

	DPU_DEBUG("%s created for pipe:%u id:%u\n", plane->name,
					pipe, plane->base.id);
	return plane;
}

/**
 * dpu_plane_init - create new dpu plane for the given pipe
 * @dev:   Pointer to DRM device
 * @pipe:  dpu hardware pipe identifier
 * @type:  Plane type - PRIMARY/OVERLAY/CURSOR
 * @possible_crtcs: bitmask of crtc that can be attached to the given pipe
 *
 * Initialize the plane.
 */
struct drm_plane *dpu_plane_init(struct drm_device *dev,
				 uint32_t pipe, enum drm_plane_type type,
				 unsigned long possible_crtcs)
{
	struct drm_plane *plane = NULL;
	struct msm_drm_private *priv = dev->dev_private;
	struct dpu_kms *kms = to_dpu_kms(priv->kms);
	struct dpu_hw_sspp *pipe_hw;

	/* initialize underlying h/w driver */
	pipe_hw = dpu_rm_get_sspp(&kms->rm, pipe);
	if (!pipe_hw || !pipe_hw->cap || !pipe_hw->cap->sblk) {
		DPU_ERROR("[%u]SSPP is invalid\n", pipe);
		return ERR_PTR(-EINVAL);
	}


	plane = dpu_plane_init_common(dev, type, possible_crtcs,
				      pipe_hw->cap->features & BIT(DPU_SSPP_INLINE_ROTATION),
				      pipe_hw->cap->sblk->format_list,
				      pipe_hw->cap->sblk->num_formats,
				      pipe);
	if (IS_ERR(plane))
		return plane;

	drm_plane_helper_add(plane, &dpu_plane_helper_funcs);

	DPU_DEBUG("%s created for pipe:%u id:%u\n", plane->name,
					pipe, plane->base.id);

	return plane;
}

/**
 * dpu_plane_init_virtual - create new virtualized DPU plane
 * @dev:   Pointer to DRM device
 * @type:  Plane type - PRIMARY/OVERLAY/CURSOR
 * @possible_crtcs: bitmask of crtc that can be attached to the given pipe
 *
 * Initialize the virtual plane with no backing SSPP / pipe.
 */
struct drm_plane *dpu_plane_init_virtual(struct drm_device *dev,
					 enum drm_plane_type type,
					 unsigned long possible_crtcs)
{
	struct drm_plane *plane = NULL;
	struct msm_drm_private *priv = dev->dev_private;
	struct dpu_kms *kms = to_dpu_kms(priv->kms);
	bool has_inline_rotation = false;
	const u32 *format_list = NULL;
	u32 num_formats = 0;
	int i;

	/* Determine the largest configuration that we can implement */
	for (i = 0; i < kms->catalog->sspp_count; i++) {
		const struct dpu_sspp_cfg *cfg = &kms->catalog->sspp[i];

		if (test_bit(DPU_SSPP_INLINE_ROTATION, &cfg->features))
			has_inline_rotation = true;

		if (!format_list ||
		    cfg->sblk->csc_blk.len) {
			format_list = cfg->sblk->format_list;
			num_formats = cfg->sblk->num_formats;
		}
	}

	plane = dpu_plane_init_common(dev, type, possible_crtcs,
				      has_inline_rotation,
				      format_list,
				      num_formats,
				      SSPP_NONE);
	if (IS_ERR(plane))
		return plane;

	drm_plane_helper_add(plane, &dpu_plane_virtual_helper_funcs);

	DPU_DEBUG("%s created virtual id:%u\n", plane->name, plane->base.id);

	return plane;
}