root/drivers/gpu/drm/msm/disp/mdp4/mdp4_plane.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (C) 2013 Red Hat
 * Author: Rob Clark <robdclark@gmail.com>
 */

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

#include "mdp4_kms.h"

#define DOWN_SCALE_MAX  8
#define UP_SCALE_MAX    8

struct mdp4_plane {
        struct drm_plane base;
        const char *name;

        enum mdp4_pipe pipe;
};
#define to_mdp4_plane(x) container_of(x, struct mdp4_plane, base)

/* MDP format helper functions */
static inline
enum mdp4_frame_format mdp4_get_frame_format(struct drm_framebuffer *fb)
{
        bool is_tile = false;

        if (fb->modifier == DRM_FORMAT_MOD_SAMSUNG_64_32_TILE)
                is_tile = true;

        if (fb->format->format == DRM_FORMAT_NV12 && is_tile)
                return FRAME_TILE_YCBCR_420;

        return FRAME_LINEAR;
}

static void mdp4_plane_set_scanout(struct drm_plane *plane,
                struct drm_framebuffer *fb);
static int mdp4_plane_mode_set(struct drm_plane *plane,
                struct drm_crtc *crtc, struct drm_framebuffer *fb,
                int crtc_x, int crtc_y,
                unsigned int crtc_w, unsigned int crtc_h,
                uint32_t src_x, uint32_t src_y,
                uint32_t src_w, uint32_t src_h);

static struct mdp4_kms *get_kms(struct drm_plane *plane)
{
        struct msm_drm_private *priv = plane->dev->dev_private;
        return to_mdp4_kms(to_mdp_kms(priv->kms));
}

/* helper to install properties which are common to planes and crtcs */
static void mdp4_plane_install_properties(struct drm_plane *plane,
                struct drm_mode_object *obj)
{
        // XXX
}

static int mdp4_plane_set_property(struct drm_plane *plane,
                struct drm_property *property, uint64_t val)
{
        // XXX
        return -EINVAL;
}

static const struct drm_plane_funcs mdp4_plane_funcs = {
                .update_plane = drm_atomic_helper_update_plane,
                .disable_plane = drm_atomic_helper_disable_plane,
                .set_property = mdp4_plane_set_property,
                .reset = drm_atomic_helper_plane_reset,
                .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
                .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
};

static int mdp4_plane_prepare_fb(struct drm_plane *plane,
                                 struct drm_plane_state *new_state)
{
        if (!new_state->fb)
                return 0;

        drm_gem_plane_helper_prepare_fb(plane, new_state);

        return msm_framebuffer_prepare(new_state->fb, false);
}

static void mdp4_plane_cleanup_fb(struct drm_plane *plane,
                                  struct drm_plane_state *old_state)
{
        struct mdp4_plane *mdp4_plane = to_mdp4_plane(plane);
        struct drm_framebuffer *fb = old_state->fb;

        if (!fb)
                return;

        DBG("%s: cleanup: FB[%u]", mdp4_plane->name, fb->base.id);
        msm_framebuffer_cleanup(fb, false);
}


static int mdp4_plane_atomic_check(struct drm_plane *plane,
                struct drm_atomic_state *state)
{
        return 0;
}

static void mdp4_plane_atomic_update(struct drm_plane *plane,
                                     struct drm_atomic_state *state)
{
        struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
                                                                           plane);
        int ret;

        ret = mdp4_plane_mode_set(plane,
                        new_state->crtc, new_state->fb,
                        new_state->crtc_x, new_state->crtc_y,
                        new_state->crtc_w, new_state->crtc_h,
                        new_state->src_x,  new_state->src_y,
                        new_state->src_w, new_state->src_h);
        /* atomic_check should have ensured that this doesn't fail */
        WARN_ON(ret < 0);
}

static const struct drm_plane_helper_funcs mdp4_plane_helper_funcs = {
                .prepare_fb = mdp4_plane_prepare_fb,
                .cleanup_fb = mdp4_plane_cleanup_fb,
                .atomic_check = mdp4_plane_atomic_check,
                .atomic_update = mdp4_plane_atomic_update,
};

static void mdp4_plane_set_scanout(struct drm_plane *plane,
                struct drm_framebuffer *fb)
{
        struct mdp4_plane *mdp4_plane = to_mdp4_plane(plane);
        struct mdp4_kms *mdp4_kms = get_kms(plane);
        enum mdp4_pipe pipe = mdp4_plane->pipe;

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_STRIDE_A(pipe),
                        MDP4_PIPE_SRC_STRIDE_A_P0(fb->pitches[0]) |
                        MDP4_PIPE_SRC_STRIDE_A_P1(fb->pitches[1]));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_STRIDE_B(pipe),
                        MDP4_PIPE_SRC_STRIDE_B_P2(fb->pitches[2]) |
                        MDP4_PIPE_SRC_STRIDE_B_P3(fb->pitches[3]));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRCP0_BASE(pipe),
                        msm_framebuffer_iova(fb, 0));
        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRCP1_BASE(pipe),
                        msm_framebuffer_iova(fb, 1));
        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRCP2_BASE(pipe),
                        msm_framebuffer_iova(fb, 2));
        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRCP3_BASE(pipe),
                        msm_framebuffer_iova(fb, 3));
}

static void mdp4_write_csc_config(struct mdp4_kms *mdp4_kms,
                enum mdp4_pipe pipe, struct csc_cfg *csc)
{
        int i;

        for (i = 0; i < ARRAY_SIZE(csc->matrix); i++) {
                mdp4_write(mdp4_kms, REG_MDP4_PIPE_CSC_MV(pipe, i),
                                csc->matrix[i]);
        }

        for (i = 0; i < ARRAY_SIZE(csc->post_bias) ; i++) {
                mdp4_write(mdp4_kms, REG_MDP4_PIPE_CSC_PRE_BV(pipe, i),
                                csc->pre_bias[i]);

                mdp4_write(mdp4_kms, REG_MDP4_PIPE_CSC_POST_BV(pipe, i),
                                csc->post_bias[i]);
        }

        for (i = 0; i < ARRAY_SIZE(csc->post_clamp) ; i++) {
                mdp4_write(mdp4_kms, REG_MDP4_PIPE_CSC_PRE_LV(pipe, i),
                                csc->pre_clamp[i]);

                mdp4_write(mdp4_kms, REG_MDP4_PIPE_CSC_POST_LV(pipe, i),
                                csc->post_clamp[i]);
        }
}

#define MDP4_VG_PHASE_STEP_DEFAULT      0x20000000

static int mdp4_plane_mode_set(struct drm_plane *plane,
                struct drm_crtc *crtc, struct drm_framebuffer *fb,
                int crtc_x, int crtc_y,
                unsigned int crtc_w, unsigned int crtc_h,
                uint32_t src_x, uint32_t src_y,
                uint32_t src_w, uint32_t src_h)
{
        struct drm_device *dev = plane->dev;
        struct mdp4_plane *mdp4_plane = to_mdp4_plane(plane);
        struct mdp4_kms *mdp4_kms = get_kms(plane);
        enum mdp4_pipe pipe = mdp4_plane->pipe;
        const struct msm_format *format;
        uint32_t op_mode = 0;
        uint32_t phasex_step = MDP4_VG_PHASE_STEP_DEFAULT;
        uint32_t phasey_step = MDP4_VG_PHASE_STEP_DEFAULT;
        enum mdp4_frame_format frame_type;

        if (!(crtc && fb)) {
                DBG("%s: disabled!", mdp4_plane->name);
                return 0;
        }

        frame_type = mdp4_get_frame_format(fb);

        /* src values are in Q16 fixed point, convert to integer: */
        src_x = src_x >> 16;
        src_y = src_y >> 16;
        src_w = src_w >> 16;
        src_h = src_h >> 16;

        DBG("%s: FB[%u] %u,%u,%u,%u -> CRTC[%u] %d,%d,%u,%u", mdp4_plane->name,
                        fb->base.id, src_x, src_y, src_w, src_h,
                        crtc->base.id, crtc_x, crtc_y, crtc_w, crtc_h);

        format = msm_framebuffer_format(fb);

        if (src_w > (crtc_w * DOWN_SCALE_MAX)) {
                DRM_DEV_ERROR(dev->dev, "Width down scaling exceeds limits!\n");
                return -ERANGE;
        }

        if (src_h > (crtc_h * DOWN_SCALE_MAX)) {
                DRM_DEV_ERROR(dev->dev, "Height down scaling exceeds limits!\n");
                return -ERANGE;
        }

        if (crtc_w > (src_w * UP_SCALE_MAX)) {
                DRM_DEV_ERROR(dev->dev, "Width up scaling exceeds limits!\n");
                return -ERANGE;
        }

        if (crtc_h > (src_h * UP_SCALE_MAX)) {
                DRM_DEV_ERROR(dev->dev, "Height up scaling exceeds limits!\n");
                return -ERANGE;
        }

        if (src_w != crtc_w) {
                uint32_t sel_unit = SCALE_FIR;
                op_mode |= MDP4_PIPE_OP_MODE_SCALEX_EN;

                if (MSM_FORMAT_IS_YUV(format)) {
                        if (crtc_w > src_w)
                                sel_unit = SCALE_PIXEL_RPT;
                        else if (crtc_w <= (src_w / 4))
                                sel_unit = SCALE_MN_PHASE;

                        op_mode |= MDP4_PIPE_OP_MODE_SCALEX_UNIT_SEL(sel_unit);
                        phasex_step = mult_frac(MDP4_VG_PHASE_STEP_DEFAULT,
                                        src_w, crtc_w);
                }
        }

        if (src_h != crtc_h) {
                uint32_t sel_unit = SCALE_FIR;
                op_mode |= MDP4_PIPE_OP_MODE_SCALEY_EN;

                if (MSM_FORMAT_IS_YUV(format)) {

                        if (crtc_h > src_h)
                                sel_unit = SCALE_PIXEL_RPT;
                        else if (crtc_h <= (src_h / 4))
                                sel_unit = SCALE_MN_PHASE;

                        op_mode |= MDP4_PIPE_OP_MODE_SCALEY_UNIT_SEL(sel_unit);
                        phasey_step = mult_frac(MDP4_VG_PHASE_STEP_DEFAULT,
                                        src_h, crtc_h);
                }
        }

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_SIZE(pipe),
                        MDP4_PIPE_SRC_SIZE_WIDTH(src_w) |
                        MDP4_PIPE_SRC_SIZE_HEIGHT(src_h));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_XY(pipe),
                        MDP4_PIPE_SRC_XY_X(src_x) |
                        MDP4_PIPE_SRC_XY_Y(src_y));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_DST_SIZE(pipe),
                        MDP4_PIPE_DST_SIZE_WIDTH(crtc_w) |
                        MDP4_PIPE_DST_SIZE_HEIGHT(crtc_h));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_DST_XY(pipe),
                        MDP4_PIPE_DST_XY_X(crtc_x) |
                        MDP4_PIPE_DST_XY_Y(crtc_y));

        mdp4_plane_set_scanout(plane, fb);

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_FORMAT(pipe),
                        MDP4_PIPE_SRC_FORMAT_A_BPC(format->bpc_a) |
                        MDP4_PIPE_SRC_FORMAT_R_BPC(format->bpc_r_cr) |
                        MDP4_PIPE_SRC_FORMAT_G_BPC(format->bpc_g_y) |
                        MDP4_PIPE_SRC_FORMAT_B_BPC(format->bpc_b_cb) |
                        COND(format->alpha_enable, MDP4_PIPE_SRC_FORMAT_ALPHA_ENABLE) |
                        MDP4_PIPE_SRC_FORMAT_CPP(format->bpp - 1) |
                        MDP4_PIPE_SRC_FORMAT_UNPACK_COUNT(format->unpack_count - 1) |
                        MDP4_PIPE_SRC_FORMAT_FETCH_PLANES(format->fetch_type) |
                        MDP4_PIPE_SRC_FORMAT_CHROMA_SAMP(format->chroma_sample) |
                        MDP4_PIPE_SRC_FORMAT_FRAME_FORMAT(frame_type) |
                        COND(format->flags & MSM_FORMAT_FLAG_UNPACK_TIGHT,
                             MDP4_PIPE_SRC_FORMAT_UNPACK_TIGHT));

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_SRC_UNPACK(pipe),
                        MDP4_PIPE_SRC_UNPACK_ELEM0(format->element[0]) |
                        MDP4_PIPE_SRC_UNPACK_ELEM1(format->element[1]) |
                        MDP4_PIPE_SRC_UNPACK_ELEM2(format->element[2]) |
                        MDP4_PIPE_SRC_UNPACK_ELEM3(format->element[3]));

        if (MSM_FORMAT_IS_YUV(format)) {
                struct csc_cfg *csc = mdp_get_default_csc_cfg(CSC_YUV2RGB);

                op_mode |= MDP4_PIPE_OP_MODE_SRC_YCBCR;
                op_mode |= MDP4_PIPE_OP_MODE_CSC_EN;
                mdp4_write_csc_config(mdp4_kms, pipe, csc);
        }

        mdp4_write(mdp4_kms, REG_MDP4_PIPE_OP_MODE(pipe), op_mode);
        mdp4_write(mdp4_kms, REG_MDP4_PIPE_PHASEX_STEP(pipe), phasex_step);
        mdp4_write(mdp4_kms, REG_MDP4_PIPE_PHASEY_STEP(pipe), phasey_step);

        if (frame_type != FRAME_LINEAR)
                mdp4_write(mdp4_kms, REG_MDP4_PIPE_SSTILE_FRAME_SIZE(pipe),
                                MDP4_PIPE_SSTILE_FRAME_SIZE_WIDTH(src_w) |
                                MDP4_PIPE_SSTILE_FRAME_SIZE_HEIGHT(src_h));

        return 0;
}

static const char *pipe_names[] = {
                "VG1", "VG2",
                "RGB1", "RGB2", "RGB3",
                "VG3", "VG4",
};

enum mdp4_pipe mdp4_plane_pipe(struct drm_plane *plane)
{
        struct mdp4_plane *mdp4_plane = to_mdp4_plane(plane);
        return mdp4_plane->pipe;
}

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

static const uint32_t mdp4_rgb_formats[] = {
        DRM_FORMAT_ARGB8888,
        DRM_FORMAT_ABGR8888,
        DRM_FORMAT_RGBA8888,
        DRM_FORMAT_BGRA8888,
        DRM_FORMAT_XRGB8888,
        DRM_FORMAT_XBGR8888,
        DRM_FORMAT_RGBX8888,
        DRM_FORMAT_BGRX8888,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_BGR888,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_BGR565,
};

static const uint32_t mdp4_rgb_yuv_formats[] = {
        DRM_FORMAT_ARGB8888,
        DRM_FORMAT_ABGR8888,
        DRM_FORMAT_RGBA8888,
        DRM_FORMAT_BGRA8888,
        DRM_FORMAT_XRGB8888,
        DRM_FORMAT_XBGR8888,
        DRM_FORMAT_RGBX8888,
        DRM_FORMAT_BGRX8888,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_BGR888,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_BGR565,

        DRM_FORMAT_NV12,
        DRM_FORMAT_NV21,
        DRM_FORMAT_NV16,
        DRM_FORMAT_NV61,
        DRM_FORMAT_VYUY,
        DRM_FORMAT_UYVY,
        DRM_FORMAT_YUYV,
        DRM_FORMAT_YVYU,
        DRM_FORMAT_YUV420,
        DRM_FORMAT_YVU420,
};

/* initialize plane */
struct drm_plane *mdp4_plane_init(struct drm_device *dev,
                enum mdp4_pipe pipe_id, bool private_plane)
{
        struct drm_plane *plane = NULL;
        struct mdp4_plane *mdp4_plane;
        enum drm_plane_type type;
        uint32_t pipe_caps;
        const uint32_t *formats;
        size_t nformats;

        type = private_plane ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;

        pipe_caps = mdp4_pipe_caps(pipe_id);
        if (pipe_supports_yuv(pipe_caps)) {
                formats = mdp4_rgb_yuv_formats;
                nformats = ARRAY_SIZE(mdp4_rgb_yuv_formats);
        } else {
                formats = mdp4_rgb_formats;
                nformats = ARRAY_SIZE(mdp4_rgb_formats);
        }

        mdp4_plane = drmm_universal_plane_alloc(dev, struct mdp4_plane, base,
                                                0xff, &mdp4_plane_funcs,
                                                formats, nformats,
                                                supported_format_modifiers,
                                                type, NULL);
        if (IS_ERR(mdp4_plane))
                return ERR_CAST(mdp4_plane);

        plane = &mdp4_plane->base;

        mdp4_plane->pipe = pipe_id;
        mdp4_plane->name = pipe_names[pipe_id];

        drm_plane_helper_add(plane, &mdp4_plane_helper_funcs);

        mdp4_plane_install_properties(plane, &plane->base);

        drm_plane_enable_fb_damage_clips(plane);

        return plane;
}