root/drivers/gpu/drm/sun4i/sun8i_vi_layer.c
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright (C) Jernej Skrabec <jernej.skrabec@siol.net>
 */

#include <drm/drm_atomic.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_blend.h>
#include <drm/drm_crtc.h>
#include <drm/drm_fb_dma_helper.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_gem_atomic_helper.h>
#include <drm/drm_gem_dma_helper.h>
#include <drm/drm_print.h>
#include <drm/drm_probe_helper.h>

#include "sun4i_crtc.h"
#include "sun8i_csc.h"
#include "sun8i_mixer.h"
#include "sun8i_vi_layer.h"
#include "sun8i_vi_scaler.h"

static void sun8i_vi_layer_disable(struct sun8i_layer *layer)
{
        u32 ch_base = sun8i_channel_base(layer);

        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_LAYER_ATTR(ch_base, layer->overlay), 0);
}

static void sun8i_vi_layer_update_attributes(struct sun8i_layer *layer,
                                             struct drm_plane *plane)
{
        struct drm_plane_state *state = plane->state;
        const struct drm_format_info *fmt;
        u32 val, ch_base, hw_fmt;

        ch_base = sun8i_channel_base(layer);
        fmt = state->fb->format;
        sun8i_mixer_drm_format_to_hw(fmt->format, &hw_fmt);

        val = hw_fmt << SUN8I_MIXER_CHAN_VI_LAYER_ATTR_FBFMT_OFFSET;
        if (!fmt->is_yuv)
                val |= SUN8I_MIXER_CHAN_VI_LAYER_ATTR_RGB_MODE;
        val |= SUN8I_MIXER_CHAN_VI_LAYER_ATTR_EN;
        if (layer->cfg->de_type >= SUN8I_MIXER_DE3) {
                val |= SUN50I_MIXER_CHAN_VI_LAYER_ATTR_ALPHA(state->alpha >> 8);
                val |= (state->alpha == DRM_BLEND_ALPHA_OPAQUE) ?
                        SUN50I_MIXER_CHAN_VI_LAYER_ATTR_ALPHA_MODE_PIXEL :
                        SUN50I_MIXER_CHAN_VI_LAYER_ATTR_ALPHA_MODE_COMBINED;
        }

        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_LAYER_ATTR(ch_base, layer->overlay), val);

        if (layer->cfg->de2_fcc_alpha) {
                regmap_write(layer->regs,
                             SUN8I_MIXER_FCC_GLOBAL_ALPHA_REG,
                             SUN8I_MIXER_FCC_GLOBAL_ALPHA(state->alpha >> 8));
        }
}

static void sun8i_vi_layer_update_coord(struct sun8i_layer *layer,
                                        struct drm_plane *plane)
{
        struct drm_plane_state *state = plane->state;
        struct sun4i_crtc *scrtc = drm_crtc_to_sun4i_crtc(state->crtc);
        struct sun8i_mixer *mixer = engine_to_sun8i_mixer(scrtc->engine);
        const struct drm_format_info *format = state->fb->format;
        u32 src_w, src_h, dst_w, dst_h;
        u32 outsize, insize;
        u32 hphase, vphase;
        u32 hn = 0, hm = 0;
        u32 vn = 0, vm = 0;
        bool subsampled;
        u32 ch_base;

        DRM_DEBUG_DRIVER("Updating VI channel %d overlay %d\n",
                         layer->channel, layer->overlay);

        ch_base = sun8i_channel_base(layer);

        src_w = drm_rect_width(&state->src) >> 16;
        src_h = drm_rect_height(&state->src) >> 16;
        dst_w = drm_rect_width(&state->dst);
        dst_h = drm_rect_height(&state->dst);

        hphase = state->src.x1 & 0xffff;
        vphase = state->src.y1 & 0xffff;

        /* make coordinates dividable by subsampling factor */
        if (format->hsub > 1) {
                int mask, remainder;

                mask = format->hsub - 1;
                remainder = (state->src.x1 >> 16) & mask;
                src_w = (src_w + remainder) & ~mask;
                hphase += remainder << 16;
        }

        if (format->vsub > 1) {
                int mask, remainder;

                mask = format->vsub - 1;
                remainder = (state->src.y1 >> 16) & mask;
                src_h = (src_h + remainder) & ~mask;
                vphase += remainder << 16;
        }

        insize = SUN8I_MIXER_SIZE(src_w, src_h);
        outsize = SUN8I_MIXER_SIZE(dst_w, dst_h);

        /* Set height and width */
        DRM_DEBUG_DRIVER("Layer source offset X: %d Y: %d\n",
                         (state->src.x1 >> 16) & ~(format->hsub - 1),
                         (state->src.y1 >> 16) & ~(format->vsub - 1));
        DRM_DEBUG_DRIVER("Layer source size W: %d H: %d\n", src_w, src_h);
        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_LAYER_SIZE(ch_base, layer->overlay),
                     insize);
        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_OVL_SIZE(ch_base),
                     insize);

        /*
         * Scaler must be enabled for subsampled formats, so it scales
         * chroma to same size as luma.
         */
        subsampled = format->hsub > 1 || format->vsub > 1;

        if (insize != outsize || subsampled || hphase || vphase) {
                unsigned int scanline, required;
                struct drm_display_mode *mode;
                u32 hscale, vscale, fps;
                u64 ability;

                DRM_DEBUG_DRIVER("HW scaling is enabled\n");

                mode = &plane->state->crtc->state->mode;
                fps = (mode->clock * 1000) / (mode->vtotal * mode->htotal);
                ability = clk_get_rate(mixer->mod_clk);
                /* BSP algorithm assumes 80% efficiency of VI scaler unit */
                ability *= 80;
                do_div(ability, mode->vdisplay * fps * max(src_w, dst_w));

                required = src_h * 100 / dst_h;

                if (ability < required) {
                        DRM_DEBUG_DRIVER("Using vertical coarse scaling\n");
                        vm = src_h;
                        vn = (u32)ability * dst_h / 100;
                        src_h = vn;
                }

                /* it seems that every RGB scaler has buffer for 2048 pixels */
                scanline = subsampled ? layer->cfg->scanline_yuv : 2048;

                if (src_w > scanline) {
                        DRM_DEBUG_DRIVER("Using horizontal coarse scaling\n");
                        hm = src_w;
                        hn = scanline;
                        src_w = hn;
                }

                hscale = (src_w << 16) / dst_w;
                vscale = (src_h << 16) / dst_h;

                sun8i_vi_scaler_setup(layer, src_w, src_h, dst_w, dst_h,
                                      hscale, vscale, hphase, vphase, format);
                sun8i_vi_scaler_enable(layer, true);
        } else {
                DRM_DEBUG_DRIVER("HW scaling is not needed\n");
                sun8i_vi_scaler_enable(layer, false);
        }

        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_HDS_Y(ch_base),
                     SUN8I_MIXER_CHAN_VI_DS_N(hn) |
                     SUN8I_MIXER_CHAN_VI_DS_M(hm));
        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_HDS_UV(ch_base),
                     SUN8I_MIXER_CHAN_VI_DS_N(hn) |
                     SUN8I_MIXER_CHAN_VI_DS_M(hm));
        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_VDS_Y(ch_base),
                     SUN8I_MIXER_CHAN_VI_DS_N(vn) |
                     SUN8I_MIXER_CHAN_VI_DS_M(vm));
        regmap_write(layer->regs,
                     SUN8I_MIXER_CHAN_VI_VDS_UV(ch_base),
                     SUN8I_MIXER_CHAN_VI_DS_N(vn) |
                     SUN8I_MIXER_CHAN_VI_DS_M(vm));
}

static void sun8i_vi_layer_update_buffer(struct sun8i_layer *layer,
                                         struct drm_plane *plane)
{
        struct drm_plane_state *state = plane->state;
        struct drm_framebuffer *fb = state->fb;
        const struct drm_format_info *format = fb->format;
        struct drm_gem_dma_object *gem;
        u32 dx, dy, src_x, src_y;
        dma_addr_t dma_addr;
        u32 ch_base;
        int i;

        ch_base = sun8i_channel_base(layer);

        /* Adjust x and y to be dividable by subsampling factor */
        src_x = (state->src.x1 >> 16) & ~(format->hsub - 1);
        src_y = (state->src.y1 >> 16) & ~(format->vsub - 1);

        for (i = 0; i < format->num_planes; i++) {
                /* Get the physical address of the buffer in memory */
                gem = drm_fb_dma_get_gem_obj(fb, i);

                DRM_DEBUG_DRIVER("Using GEM @ %pad\n", &gem->dma_addr);

                /* Compute the start of the displayed memory */
                dma_addr = gem->dma_addr + fb->offsets[i];

                dx = src_x;
                dy = src_y;

                if (i > 0) {
                        dx /= format->hsub;
                        dy /= format->vsub;
                }

                /* Fixup framebuffer address for src coordinates */
                dma_addr += dx * format->cpp[i];
                dma_addr += dy * fb->pitches[i];

                /* Set the line width */
                DRM_DEBUG_DRIVER("Layer %d. line width: %d bytes\n",
                                 i + 1, fb->pitches[i]);
                regmap_write(layer->regs,
                             SUN8I_MIXER_CHAN_VI_LAYER_PITCH(ch_base,
                                                             layer->overlay, i),
                             fb->pitches[i]);

                DRM_DEBUG_DRIVER("Setting %d. buffer address to %pad\n",
                                 i + 1, &dma_addr);

                regmap_write(layer->regs,
                             SUN8I_MIXER_CHAN_VI_LAYER_TOP_LADDR(ch_base,
                                                                 layer->overlay, i),
                             lower_32_bits(dma_addr));
        }
}

static int sun8i_vi_layer_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);
        struct sun8i_layer *layer = plane_to_sun8i_layer(plane);
        struct drm_crtc *crtc = new_plane_state->crtc;
        struct drm_crtc_state *crtc_state;
        const struct drm_format_info *fmt;
        int min_scale, max_scale, ret;
        u32 hw_fmt;

        if (!crtc)
                return 0;

        crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
        if (WARN_ON(!crtc_state))
                return -EINVAL;

        fmt = new_plane_state->fb->format;
        ret = sun8i_mixer_drm_format_to_hw(fmt->format, &hw_fmt);
        if (ret) {
                DRM_DEBUG_DRIVER("Invalid plane format\n");
                return ret;
        }

        min_scale = DRM_PLANE_NO_SCALING;
        max_scale = DRM_PLANE_NO_SCALING;

        if (layer->cfg->scaler_mask & BIT(layer->channel)) {
                min_scale = SUN8I_VI_SCALER_SCALE_MIN;
                max_scale = SUN8I_VI_SCALER_SCALE_MAX;
        }

        return drm_atomic_helper_check_plane_state(new_plane_state,
                                                   crtc_state,
                                                   min_scale, max_scale,
                                                   true, true);
}

static void sun8i_vi_layer_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);
        struct sun8i_layer *layer = plane_to_sun8i_layer(plane);

        if (!new_state->crtc || !new_state->visible) {
                sun8i_vi_layer_disable(layer);
                return;
        }

        sun8i_vi_layer_update_attributes(layer, plane);
        sun8i_vi_layer_update_coord(layer, plane);
        sun8i_csc_config(layer, new_state);
        sun8i_vi_layer_update_buffer(layer, plane);
}

static const struct drm_plane_helper_funcs sun8i_vi_layer_helper_funcs = {
        .atomic_check   = sun8i_vi_layer_atomic_check,
        .atomic_update  = sun8i_vi_layer_atomic_update,
};

static const struct drm_plane_funcs sun8i_vi_layer_funcs = {
        .atomic_destroy_state   = drm_atomic_helper_plane_destroy_state,
        .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
        .destroy                = drm_plane_cleanup,
        .disable_plane          = drm_atomic_helper_disable_plane,
        .reset                  = drm_atomic_helper_plane_reset,
        .update_plane           = drm_atomic_helper_update_plane,
};

/*
 * While DE2 VI layer supports same RGB formats as UI layer, alpha
 * channel is ignored. This structure lists all unique variants
 * where alpha channel is replaced with "don't care" (X) channel.
 */
static const u32 sun8i_vi_layer_formats[] = {
        DRM_FORMAT_BGR565,
        DRM_FORMAT_BGR888,
        DRM_FORMAT_BGRX4444,
        DRM_FORMAT_BGRX5551,
        DRM_FORMAT_BGRX8888,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_RGBX4444,
        DRM_FORMAT_RGBX5551,
        DRM_FORMAT_RGBX8888,
        DRM_FORMAT_XBGR1555,
        DRM_FORMAT_XBGR4444,
        DRM_FORMAT_XBGR8888,
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_XRGB4444,
        DRM_FORMAT_XRGB8888,

        DRM_FORMAT_NV16,
        DRM_FORMAT_NV12,
        DRM_FORMAT_NV21,
        DRM_FORMAT_NV61,
        DRM_FORMAT_UYVY,
        DRM_FORMAT_VYUY,
        DRM_FORMAT_YUYV,
        DRM_FORMAT_YVYU,
        DRM_FORMAT_YUV411,
        DRM_FORMAT_YUV420,
        DRM_FORMAT_YUV422,
        DRM_FORMAT_YVU411,
        DRM_FORMAT_YVU420,
        DRM_FORMAT_YVU422,
};

static const u32 sun8i_vi_layer_de3_formats[] = {
        DRM_FORMAT_ABGR1555,
        DRM_FORMAT_ABGR2101010,
        DRM_FORMAT_ABGR4444,
        DRM_FORMAT_ABGR8888,
        DRM_FORMAT_ARGB1555,
        DRM_FORMAT_ARGB2101010,
        DRM_FORMAT_ARGB4444,
        DRM_FORMAT_ARGB8888,
        DRM_FORMAT_BGR565,
        DRM_FORMAT_BGR888,
        DRM_FORMAT_BGRA1010102,
        DRM_FORMAT_BGRA5551,
        DRM_FORMAT_BGRA4444,
        DRM_FORMAT_BGRA8888,
        DRM_FORMAT_BGRX8888,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_RGBA1010102,
        DRM_FORMAT_RGBA4444,
        DRM_FORMAT_RGBA5551,
        DRM_FORMAT_RGBA8888,
        DRM_FORMAT_RGBX8888,
        DRM_FORMAT_XBGR8888,
        DRM_FORMAT_XRGB8888,

        DRM_FORMAT_NV16,
        DRM_FORMAT_NV12,
        DRM_FORMAT_NV21,
        DRM_FORMAT_NV61,
        DRM_FORMAT_P010,
        DRM_FORMAT_P210,
        DRM_FORMAT_UYVY,
        DRM_FORMAT_VYUY,
        DRM_FORMAT_YUYV,
        DRM_FORMAT_YVYU,
        DRM_FORMAT_YUV411,
        DRM_FORMAT_YUV420,
        DRM_FORMAT_YUV422,
        DRM_FORMAT_YVU411,
        DRM_FORMAT_YVU420,
        DRM_FORMAT_YVU422,
};

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

struct sun8i_layer *sun8i_vi_layer_init_one(struct drm_device *drm,
                                            enum drm_plane_type type,
                                            struct regmap *regs,
                                            int index, int phy_index,
                                            int plane_cnt,
                                            const struct sun8i_layer_cfg *cfg)
{
        u32 supported_encodings, supported_ranges;
        unsigned int format_count;
        struct sun8i_layer *layer;
        const u32 *formats;
        int ret;

        layer = devm_kzalloc(drm->dev, sizeof(*layer), GFP_KERNEL);
        if (!layer)
                return ERR_PTR(-ENOMEM);

        layer->type = SUN8I_LAYER_TYPE_VI;
        layer->index = index;
        layer->channel = phy_index;
        layer->overlay = 0;
        layer->regs = regs;
        layer->cfg = cfg;

        if (layer->cfg->de_type >= SUN8I_MIXER_DE3) {
                formats = sun8i_vi_layer_de3_formats;
                format_count = ARRAY_SIZE(sun8i_vi_layer_de3_formats);
        } else {
                formats = sun8i_vi_layer_formats;
                format_count = ARRAY_SIZE(sun8i_vi_layer_formats);
        }

        /* possible crtcs are set later */
        ret = drm_universal_plane_init(drm, &layer->plane, 0,
                                       &sun8i_vi_layer_funcs,
                                       formats, format_count,
                                       sun8i_layer_modifiers,
                                       type, NULL);
        if (ret) {
                dev_err(drm->dev, "Couldn't initialize layer\n");
                return ERR_PTR(ret);
        }

        if (layer->cfg->de2_fcc_alpha || layer->cfg->de_type >= SUN8I_MIXER_DE3) {
                ret = drm_plane_create_alpha_property(&layer->plane);
                if (ret) {
                        dev_err(drm->dev, "Couldn't add alpha property\n");
                        return ERR_PTR(ret);
                }
        }

        ret = drm_plane_create_zpos_property(&layer->plane, index,
                                             0, plane_cnt - 1);
        if (ret) {
                dev_err(drm->dev, "Couldn't add zpos property\n");
                return ERR_PTR(ret);
        }

        supported_encodings = BIT(DRM_COLOR_YCBCR_BT601) |
                              BIT(DRM_COLOR_YCBCR_BT709);
        if (layer->cfg->de_type >= SUN8I_MIXER_DE3)
                supported_encodings |= BIT(DRM_COLOR_YCBCR_BT2020);

        supported_ranges = BIT(DRM_COLOR_YCBCR_LIMITED_RANGE) |
                           BIT(DRM_COLOR_YCBCR_FULL_RANGE);

        ret = drm_plane_create_color_properties(&layer->plane,
                                                supported_encodings,
                                                supported_ranges,
                                                DRM_COLOR_YCBCR_BT709,
                                                DRM_COLOR_YCBCR_LIMITED_RANGE);
        if (ret) {
                dev_err(drm->dev, "Couldn't add encoding and range properties!\n");
                return ERR_PTR(ret);
        }

        drm_plane_helper_add(&layer->plane, &sun8i_vi_layer_helper_funcs);

        return layer;
}