root/drivers/gpu/drm/mediatek/mtk_disp_ovl_adaptor.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2021 MediaTek Inc.
 */

#include <drm/drm_fourcc.h>
#include <drm/drm_of.h>
#include <linux/clk.h>
#include <linux/component.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/reset.h>
#include <linux/soc/mediatek/mtk-cmdq.h>
#include <linux/soc/mediatek/mtk-mmsys.h>
#include <linux/soc/mediatek/mtk-mutex.h>

#include "mtk_ddp_comp.h"
#include "mtk_disp_drv.h"
#include "mtk_drm_drv.h"
#include "mtk_ethdr.h"

#define MTK_OVL_ADAPTOR_RDMA_MAX_WIDTH 1920
#define MTK_OVL_ADAPTOR_LAYER_NUM 4

enum mtk_ovl_adaptor_comp_type {
        OVL_ADAPTOR_TYPE_ETHDR,
        OVL_ADAPTOR_TYPE_MDP_RDMA,
        OVL_ADAPTOR_TYPE_MERGE,
        OVL_ADAPTOR_TYPE_PADDING,
        OVL_ADAPTOR_TYPE_NUM,
};

enum mtk_ovl_adaptor_comp_id {
        OVL_ADAPTOR_ETHDR0,
        OVL_ADAPTOR_MDP_RDMA0,
        OVL_ADAPTOR_MDP_RDMA1,
        OVL_ADAPTOR_MDP_RDMA2,
        OVL_ADAPTOR_MDP_RDMA3,
        OVL_ADAPTOR_MDP_RDMA4,
        OVL_ADAPTOR_MDP_RDMA5,
        OVL_ADAPTOR_MDP_RDMA6,
        OVL_ADAPTOR_MDP_RDMA7,
        OVL_ADAPTOR_MERGE0,
        OVL_ADAPTOR_MERGE1,
        OVL_ADAPTOR_MERGE2,
        OVL_ADAPTOR_MERGE3,
        OVL_ADAPTOR_PADDING0,
        OVL_ADAPTOR_PADDING1,
        OVL_ADAPTOR_PADDING2,
        OVL_ADAPTOR_PADDING3,
        OVL_ADAPTOR_PADDING4,
        OVL_ADAPTOR_PADDING5,
        OVL_ADAPTOR_PADDING6,
        OVL_ADAPTOR_PADDING7,
        OVL_ADAPTOR_ID_MAX
};

struct ovl_adaptor_comp_match {
        enum mtk_ovl_adaptor_comp_type type;
        enum mtk_ddp_comp_id comp_id;
        int alias_id;
        const struct mtk_ddp_comp_funcs *funcs;
};

struct mtk_disp_ovl_adaptor {
        struct device *ovl_adaptor_comp[OVL_ADAPTOR_ID_MAX];
        struct device *mmsys_dev;
        bool children_bound;
};

static const char * const private_comp_stem[OVL_ADAPTOR_TYPE_NUM] = {
        [OVL_ADAPTOR_TYPE_ETHDR]        = "ethdr",
        [OVL_ADAPTOR_TYPE_MDP_RDMA]     = "vdo1-rdma",
        [OVL_ADAPTOR_TYPE_MERGE]        = "merge",
        [OVL_ADAPTOR_TYPE_PADDING]      = "padding",
};

static const struct mtk_ddp_comp_funcs ethdr = {
        .clk_enable = mtk_ethdr_clk_enable,
        .clk_disable = mtk_ethdr_clk_disable,
        .start = mtk_ethdr_start,
        .stop = mtk_ethdr_stop,
};

static const struct mtk_ddp_comp_funcs merge = {
        .clk_enable = mtk_merge_clk_enable,
        .clk_disable = mtk_merge_clk_disable,
        .mode_valid = mtk_merge_mode_valid,
};

static const struct mtk_ddp_comp_funcs padding = {
        .clk_enable = mtk_padding_clk_enable,
        .clk_disable = mtk_padding_clk_disable,
        .start = mtk_padding_start,
        .stop = mtk_padding_stop,
};

static const struct mtk_ddp_comp_funcs rdma = {
        .power_on = mtk_mdp_rdma_power_on,
        .power_off = mtk_mdp_rdma_power_off,
        .clk_enable = mtk_mdp_rdma_clk_enable,
        .clk_disable = mtk_mdp_rdma_clk_disable,
};

static const struct ovl_adaptor_comp_match comp_matches[OVL_ADAPTOR_ID_MAX] = {
        [OVL_ADAPTOR_ETHDR0] = { OVL_ADAPTOR_TYPE_ETHDR, DDP_COMPONENT_ETHDR_MIXER, 0, &ethdr },
        [OVL_ADAPTOR_MDP_RDMA0] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA0, 0, &rdma },
        [OVL_ADAPTOR_MDP_RDMA1] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA1, 1, &rdma },
        [OVL_ADAPTOR_MDP_RDMA2] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA2, 2, &rdma },
        [OVL_ADAPTOR_MDP_RDMA3] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA3, 3, &rdma },
        [OVL_ADAPTOR_MDP_RDMA4] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA4, 4, &rdma },
        [OVL_ADAPTOR_MDP_RDMA5] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA5, 5, &rdma },
        [OVL_ADAPTOR_MDP_RDMA6] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA6, 6, &rdma },
        [OVL_ADAPTOR_MDP_RDMA7] = { OVL_ADAPTOR_TYPE_MDP_RDMA, DDP_COMPONENT_MDP_RDMA7, 7, &rdma },
        [OVL_ADAPTOR_MERGE0] = { OVL_ADAPTOR_TYPE_MERGE, DDP_COMPONENT_MERGE1, 1, &merge },
        [OVL_ADAPTOR_MERGE1] = { OVL_ADAPTOR_TYPE_MERGE, DDP_COMPONENT_MERGE2, 2, &merge },
        [OVL_ADAPTOR_MERGE2] = { OVL_ADAPTOR_TYPE_MERGE, DDP_COMPONENT_MERGE3, 3, &merge },
        [OVL_ADAPTOR_MERGE3] = { OVL_ADAPTOR_TYPE_MERGE, DDP_COMPONENT_MERGE4, 4, &merge },
        [OVL_ADAPTOR_PADDING0] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING0, 0, &padding },
        [OVL_ADAPTOR_PADDING1] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING1, 1, &padding },
        [OVL_ADAPTOR_PADDING2] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING2, 2, &padding },
        [OVL_ADAPTOR_PADDING3] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING3, 3, &padding },
        [OVL_ADAPTOR_PADDING4] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING4, 4, &padding },
        [OVL_ADAPTOR_PADDING5] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING5, 5, &padding },
        [OVL_ADAPTOR_PADDING6] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING6, 6, &padding },
        [OVL_ADAPTOR_PADDING7] = { OVL_ADAPTOR_TYPE_PADDING, DDP_COMPONENT_PADDING7, 7, &padding },
};

void mtk_ovl_adaptor_layer_config(struct device *dev, unsigned int idx,
                                  struct mtk_plane_state *state,
                                  struct cmdq_pkt *cmdq_pkt)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);
        struct mtk_plane_pending_state *pending = &state->pending;
        struct mtk_mdp_rdma_cfg rdma_config = {0};
        struct device *rdma_l;
        struct device *rdma_r;
        struct device *merge;
        struct device *ethdr;
        const struct drm_format_info *fmt_info = drm_format_info(pending->format);
        bool use_dual_pipe = false;
        unsigned int align_width;
        unsigned int l_w = 0;
        unsigned int r_w = 0;

        dev_dbg(dev, "%s+ idx:%d, enable:%d, fmt:0x%x\n", __func__, idx,
                pending->enable, pending->format);
        dev_dbg(dev, "addr 0x%pad, fb w:%d, {%d,%d,%d,%d}\n",
                &pending->addr, (pending->pitch / fmt_info->cpp[0]),
                pending->x, pending->y, pending->width, pending->height);

        rdma_l = ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MDP_RDMA0 + 2 * idx];
        rdma_r = ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MDP_RDMA0 + 2 * idx + 1];
        merge = ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MERGE0 + idx];
        ethdr = ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0];

        if (!pending->enable || !pending->width || !pending->height) {
                mtk_merge_stop_cmdq(merge, cmdq_pkt);
                mtk_mdp_rdma_stop(rdma_l, cmdq_pkt);
                mtk_mdp_rdma_stop(rdma_r, cmdq_pkt);
                mtk_ethdr_layer_config(ethdr, idx, state, cmdq_pkt);
                return;
        }

        /* ETHDR is in 1T2P domain, width needs to be 2 pixels align */
        align_width = ALIGN_DOWN(pending->width, 2);

        if (align_width > MTK_OVL_ADAPTOR_RDMA_MAX_WIDTH)
                use_dual_pipe = true;

        if (use_dual_pipe) {
                l_w = (align_width / 2) + ((pending->width / 2) % 2);
                r_w = align_width - l_w;
        } else {
                l_w = align_width;
        }
        mtk_merge_advance_config(merge, l_w, r_w, pending->height, 0, 0, cmdq_pkt);
        mtk_mmsys_merge_async_config(ovl_adaptor->mmsys_dev, idx, align_width / 2,
                                     pending->height, cmdq_pkt);

        rdma_config.width = l_w;
        rdma_config.height = pending->height;
        rdma_config.addr0 = pending->addr;
        rdma_config.pitch = pending->pitch;
        rdma_config.fmt = pending->format;
        rdma_config.color_encoding = pending->color_encoding;
        mtk_mdp_rdma_config(rdma_l, &rdma_config, cmdq_pkt);

        if (use_dual_pipe) {
                rdma_config.x_left = l_w;
                rdma_config.width = r_w;
                mtk_mdp_rdma_config(rdma_r, &rdma_config, cmdq_pkt);
        }

        mtk_merge_start_cmdq(merge, cmdq_pkt);

        mtk_mdp_rdma_start(rdma_l, cmdq_pkt);
        if (use_dual_pipe)
                mtk_mdp_rdma_start(rdma_r, cmdq_pkt);
        else
                mtk_mdp_rdma_stop(rdma_r, cmdq_pkt);

        mtk_ethdr_layer_config(ethdr, idx, state, cmdq_pkt);
}

void mtk_ovl_adaptor_config(struct device *dev, unsigned int w,
                            unsigned int h, unsigned int vrefresh,
                            unsigned int bpc, struct cmdq_pkt *cmdq_pkt)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        mtk_ethdr_config(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0], w, h,
                         vrefresh, bpc, cmdq_pkt);
}

void mtk_ovl_adaptor_start(struct device *dev)
{
        int i;
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                if (!ovl_adaptor->ovl_adaptor_comp[i] ||
                    !comp_matches[i].funcs->start)
                        continue;

                comp_matches[i].funcs->start(ovl_adaptor->ovl_adaptor_comp[i]);
        }
}

void mtk_ovl_adaptor_stop(struct device *dev)
{
        int i;
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                if (!ovl_adaptor->ovl_adaptor_comp[i] ||
                    !comp_matches[i].funcs->stop)
                        continue;

                comp_matches[i].funcs->stop(ovl_adaptor->ovl_adaptor_comp[i]);
        }
}

/**
 * power_off - Power off the devices in OVL adaptor
 * @dev: Device to be powered off
 * @num: Number of the devices to be powered off
 *
 * Calls the .power_off() ovl_adaptor component callback if it is present.
 */
static inline void power_off(struct device *dev, int num)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);
        int i;

        if (num > OVL_ADAPTOR_ID_MAX)
                num = OVL_ADAPTOR_ID_MAX;

        for (i = num - 1; i >= 0; i--) {
                if (!ovl_adaptor->ovl_adaptor_comp[i] ||
                    !comp_matches[i].funcs->power_off)
                        continue;

                comp_matches[i].funcs->power_off(ovl_adaptor->ovl_adaptor_comp[i]);
        }
}

/**
 * mtk_ovl_adaptor_power_on - Power on the devices in OVL adaptor
 * @dev: Device to be powered on
 *
 * Different from OVL, OVL adaptor is a pseudo device so
 * we didn't define it in the device tree, pm_runtime_resume_and_get()
 * called by .atomic_enable() power on no device in OVL adaptor,
 * we have to implement a function to do the job instead.
 *
 * Return: Zero for success or negative number for failure.
 */
int mtk_ovl_adaptor_power_on(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);
        int i, ret;

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                if (!ovl_adaptor->ovl_adaptor_comp[i] ||
                    !comp_matches[i].funcs->power_on)
                        continue;

                ret = comp_matches[i].funcs->power_on(ovl_adaptor->ovl_adaptor_comp[i]);
                if (ret < 0) {
                        dev_err(dev, "Failed to enable power domain %d, err %d\n", i, ret);
                        power_off(dev, i);
                        return ret;
                }
        }
        return 0;
}

void mtk_ovl_adaptor_power_off(struct device *dev)
{
        power_off(dev, OVL_ADAPTOR_ID_MAX);
}

int mtk_ovl_adaptor_clk_enable(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);
        struct device *comp;
        int ret;
        int i;

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                comp = ovl_adaptor->ovl_adaptor_comp[i];
                if (!comp || !comp_matches[i].funcs->clk_enable)
                        continue;
                ret = comp_matches[i].funcs->clk_enable(comp);
                if (ret) {
                        dev_err(dev, "Failed to enable clock %d, err %d\n", i, ret);
                        while (--i >= 0)
                                comp_matches[i].funcs->clk_disable(comp);
                        return ret;
                }
        }
        return 0;
}

void mtk_ovl_adaptor_clk_disable(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);
        struct device *comp;
        int i;

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                comp = ovl_adaptor->ovl_adaptor_comp[i];
                if (!comp || !comp_matches[i].funcs->clk_disable)
                        continue;
                comp_matches[i].funcs->clk_disable(comp);
                if (i < OVL_ADAPTOR_MERGE0)
                        pm_runtime_put(comp);
        }
}

enum drm_mode_status mtk_ovl_adaptor_mode_valid(struct device *dev,
                                                const struct drm_display_mode *mode)

{
        int i;
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                dev = ovl_adaptor->ovl_adaptor_comp[i];
                if (!dev || !comp_matches[i].funcs->mode_valid)
                        continue;
                return comp_matches[i].funcs->mode_valid(dev, mode);
        }
        return MODE_OK;
}

unsigned int mtk_ovl_adaptor_layer_nr(struct device *dev)
{
        return MTK_OVL_ADAPTOR_LAYER_NUM;
}

struct device *mtk_ovl_adaptor_dma_dev_get(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        return ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MDP_RDMA0];
}

void mtk_ovl_adaptor_register_vblank_cb(struct device *dev, void (*vblank_cb)(void *),
                                        void *vblank_cb_data)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        mtk_ethdr_register_vblank_cb(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0],
                                     vblank_cb, vblank_cb_data);
}

void mtk_ovl_adaptor_unregister_vblank_cb(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        mtk_ethdr_unregister_vblank_cb(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0]);
}

void mtk_ovl_adaptor_enable_vblank(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        mtk_ethdr_enable_vblank(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0]);
}

void mtk_ovl_adaptor_disable_vblank(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        mtk_ethdr_disable_vblank(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0]);
}

u32 mtk_ovl_adaptor_get_blend_modes(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        return mtk_ethdr_get_blend_modes(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_ETHDR0]);
}

const u32 *mtk_ovl_adaptor_get_formats(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        return mtk_mdp_rdma_get_formats(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MDP_RDMA0]);
}

size_t mtk_ovl_adaptor_get_num_formats(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        return mtk_mdp_rdma_get_num_formats(ovl_adaptor->ovl_adaptor_comp[OVL_ADAPTOR_MDP_RDMA0]);
}

void mtk_ovl_adaptor_add_comp(struct device *dev, struct mtk_mutex *mutex)
{
        int i;
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                if (!ovl_adaptor->ovl_adaptor_comp[i])
                        continue;
                mtk_mutex_add_comp(mutex, comp_matches[i].comp_id);
        }
}

void mtk_ovl_adaptor_remove_comp(struct device *dev, struct mtk_mutex *mutex)
{
        int i;
        struct mtk_disp_ovl_adaptor *ovl_adaptor = dev_get_drvdata(dev);

        for (i = 0; i < OVL_ADAPTOR_ID_MAX; i++) {
                if (!ovl_adaptor->ovl_adaptor_comp[i])
                        continue;
                mtk_mutex_remove_comp(mutex, comp_matches[i].comp_id);
        }
}

void mtk_ovl_adaptor_connect(struct device *dev, struct device *mmsys_dev, unsigned int next)
{
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_ETHDR_MIXER, next);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MDP_RDMA0, DDP_COMPONENT_MERGE1);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MDP_RDMA1, DDP_COMPONENT_MERGE1);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MDP_RDMA2, DDP_COMPONENT_MERGE2);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MERGE1, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MERGE2, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MERGE3, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_connect(mmsys_dev, DDP_COMPONENT_MERGE4, DDP_COMPONENT_ETHDR_MIXER);
}

void mtk_ovl_adaptor_disconnect(struct device *dev, struct device *mmsys_dev, unsigned int next)
{
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_ETHDR_MIXER, next);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MDP_RDMA0, DDP_COMPONENT_MERGE1);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MDP_RDMA1, DDP_COMPONENT_MERGE1);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MDP_RDMA2, DDP_COMPONENT_MERGE2);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MERGE1, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MERGE2, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MERGE3, DDP_COMPONENT_ETHDR_MIXER);
        mtk_mmsys_ddp_disconnect(mmsys_dev, DDP_COMPONENT_MERGE4, DDP_COMPONENT_ETHDR_MIXER);
}

static int ovl_adaptor_comp_get_id(struct device *dev, struct device_node *node,
                                   enum mtk_ovl_adaptor_comp_type type)
{
        int alias_id = of_alias_get_id(node, private_comp_stem[type]);
        int i;

        for (i = 0; i < ARRAY_SIZE(comp_matches); i++)
                if (comp_matches[i].type == type &&
                    comp_matches[i].alias_id == alias_id)
                        return i;

        dev_warn(dev, "Failed to get id. type: %d, alias: %d\n", type, alias_id);
        return -EINVAL;
}

static const struct of_device_id mtk_ovl_adaptor_comp_dt_ids[] = {
        { .compatible = "mediatek,mt8188-disp-padding", .data = (void *)OVL_ADAPTOR_TYPE_PADDING },
        { .compatible = "mediatek,mt8195-disp-ethdr", .data = (void *)OVL_ADAPTOR_TYPE_ETHDR },
        { .compatible = "mediatek,mt8195-disp-merge", .data = (void *)OVL_ADAPTOR_TYPE_MERGE },
        { .compatible = "mediatek,mt8195-vdo1-rdma", .data = (void *)OVL_ADAPTOR_TYPE_MDP_RDMA },
        { /* sentinel */ }
};

static int ovl_adaptor_of_get_ddp_comp_type(struct device_node *node,
                                            enum mtk_ovl_adaptor_comp_type *ctype)
{
        const struct of_device_id *of_id = of_match_node(mtk_ovl_adaptor_comp_dt_ids, node);

        if (!of_id)
                return -EINVAL;

        *ctype = (enum mtk_ovl_adaptor_comp_type)((uintptr_t)of_id->data);

        return 0;
}

bool mtk_ovl_adaptor_is_comp_present(struct device_node *node)
{
        enum mtk_ovl_adaptor_comp_type type;
        int ret;

        ret = ovl_adaptor_of_get_ddp_comp_type(node, &type);
        if (ret)
                return false;

        if (type >= OVL_ADAPTOR_TYPE_NUM)
                return false;

        /*
         * In the context of mediatek-drm, ETHDR, MDP_RDMA and Padding are
         * used exclusively by OVL Adaptor: if this component is not one of
         * those, it's likely not an OVL Adaptor path.
         */
        return type == OVL_ADAPTOR_TYPE_ETHDR ||
               type == OVL_ADAPTOR_TYPE_MDP_RDMA ||
               type == OVL_ADAPTOR_TYPE_PADDING;
}

static void ovl_adaptor_put_device(void *_dev)
{
        struct device *dev = _dev;

        put_device(dev);
}

static int ovl_adaptor_comp_init(struct device *dev, struct component_match **match)
{
        struct mtk_disp_ovl_adaptor *priv = dev_get_drvdata(dev);
        struct device_node *parent;
        struct platform_device *comp_pdev;

        parent = dev->parent->parent->of_node->parent;

        for_each_child_of_node_scoped(parent, node) {
                enum mtk_ovl_adaptor_comp_type type;
                int id, ret;

                ret = ovl_adaptor_of_get_ddp_comp_type(node, &type);
                if (ret)
                        continue;

                if (!of_device_is_available(node)) {
                        dev_dbg(dev, "Skipping disabled component %pOF\n",
                                node);
                        continue;
                }

                id = ovl_adaptor_comp_get_id(dev, node, type);
                if (id < 0) {
                        dev_warn(dev, "Skipping unknown component %pOF\n",
                                 node);
                        continue;
                }

                comp_pdev = of_find_device_by_node(node);
                if (!comp_pdev)
                        return -EPROBE_DEFER;

                ret = devm_add_action_or_reset(dev, ovl_adaptor_put_device,
                                               &comp_pdev->dev);
                if (ret)
                        return ret;

                priv->ovl_adaptor_comp[id] = &comp_pdev->dev;

                drm_of_component_match_add(dev, match, component_compare_of, node);
                dev_dbg(dev, "Adding component match for %pOF\n", node);
        }

        if (!*match) {
                dev_err(dev, "No match device for ovl_adaptor\n");
                return -ENODEV;
        }

        return 0;
}

static int mtk_disp_ovl_adaptor_comp_bind(struct device *dev, struct device *master,
                                          void *data)
{
        struct mtk_disp_ovl_adaptor *priv = dev_get_drvdata(dev);

        if (!priv->children_bound)
                return -EPROBE_DEFER;

        return 0;
}

static void mtk_disp_ovl_adaptor_comp_unbind(struct device *dev, struct device *master,
                                             void *data)
{
}

static const struct component_ops mtk_disp_ovl_adaptor_comp_ops = {
        .bind   = mtk_disp_ovl_adaptor_comp_bind,
        .unbind = mtk_disp_ovl_adaptor_comp_unbind,
};

static int mtk_disp_ovl_adaptor_master_bind(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *priv = dev_get_drvdata(dev);
        int ret;

        ret = component_bind_all(dev, priv->mmsys_dev);
        if (ret)
                return dev_err_probe(dev, ret, "component_bind_all failed!\n");

        priv->children_bound = true;
        return 0;
}

static void mtk_disp_ovl_adaptor_master_unbind(struct device *dev)
{
        struct mtk_disp_ovl_adaptor *priv = dev_get_drvdata(dev);

        priv->children_bound = false;
}

static const struct component_master_ops mtk_disp_ovl_adaptor_master_ops = {
        .bind           = mtk_disp_ovl_adaptor_master_bind,
        .unbind         = mtk_disp_ovl_adaptor_master_unbind,
};

static int mtk_disp_ovl_adaptor_probe(struct platform_device *pdev)
{
        struct mtk_disp_ovl_adaptor *priv;
        struct device *dev = &pdev->dev;
        struct component_match *match = NULL;
        int ret;

        priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
        if (!priv)
                return -ENOMEM;

        platform_set_drvdata(pdev, priv);

        ret = ovl_adaptor_comp_init(dev, &match);
        if (ret < 0)
                return ret;

        priv->mmsys_dev = pdev->dev.platform_data;

        component_master_add_with_match(dev, &mtk_disp_ovl_adaptor_master_ops, match);

        pm_runtime_enable(dev);

        ret = component_add(dev, &mtk_disp_ovl_adaptor_comp_ops);
        if (ret != 0) {
                pm_runtime_disable(dev);
                return dev_err_probe(dev, ret, "Failed to add component\n");
        }

        return 0;
}

static void mtk_disp_ovl_adaptor_remove(struct platform_device *pdev)
{
        component_master_del(&pdev->dev, &mtk_disp_ovl_adaptor_master_ops);
        pm_runtime_disable(&pdev->dev);
}

struct platform_driver mtk_disp_ovl_adaptor_driver = {
        .probe          = mtk_disp_ovl_adaptor_probe,
        .remove         = mtk_disp_ovl_adaptor_remove,
        .driver         = {
                .name   = "mediatek-disp-ovl-adaptor",
        },
};