root/drivers/gpu/drm/sti/sti_cursor.c
// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (C) STMicroelectronics SA 2014
 * Authors: Vincent Abriou <vincent.abriou@st.com>
 *          Fabien Dessenne <fabien.dessenne@st.com>
 *          for STMicroelectronics.
 */

#include <linux/dma-mapping.h>
#include <linux/seq_file.h>

#include <drm/drm_atomic.h>
#include <drm/drm_device.h>
#include <drm/drm_fb_dma_helper.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_gem_dma_helper.h>
#include <drm/drm_print.h>

#include "sti_compositor.h"
#include "sti_cursor.h"
#include "sti_plane.h"
#include "sti_vtg.h"

/* Registers */
#define CUR_CTL             0x00
#define CUR_VPO             0x0C
#define CUR_PML             0x14
#define CUR_PMP             0x18
#define CUR_SIZE            0x1C
#define CUR_CML             0x20
#define CUR_AWS             0x28
#define CUR_AWE             0x2C

#define CUR_CTL_CLUT_UPDATE BIT(1)

#define STI_CURS_MIN_SIZE   1
#define STI_CURS_MAX_SIZE   128

/*
 * pixmap dma buffer structure
 *
 * @paddr:  physical address
 * @size:   buffer size
 * @base:   virtual address
 */
struct dma_pixmap {
        dma_addr_t paddr;
        size_t size;
        void *base;
};

/*
 * STI Cursor structure
 *
 * @sti_plane:    sti_plane structure
 * @dev:          driver device
 * @regs:         cursor registers
 * @width:        cursor width
 * @height:       cursor height
 * @clut:         color look up table
 * @clut_paddr:   color look up table physical address
 * @pixmap:       pixmap dma buffer (clut8-format cursor)
 */
struct sti_cursor {
        struct sti_plane plane;
        struct device *dev;
        void __iomem *regs;
        unsigned int width;
        unsigned int height;
        unsigned short *clut;
        dma_addr_t clut_paddr;
        struct dma_pixmap pixmap;
};

static const uint32_t cursor_supported_formats[] = {
        DRM_FORMAT_ARGB8888,
};

#define to_sti_cursor(x) container_of(x, struct sti_cursor, plane)

#define DBGFS_DUMP(reg) seq_printf(s, "\n  %-25s 0x%08X", #reg, \
                                   readl(cursor->regs + reg))

static void cursor_dbg_vpo(struct seq_file *s, u32 val)
{
        seq_printf(s, "\txdo:%4d\tydo:%4d", val & 0x0FFF, (val >> 16) & 0x0FFF);
}

static void cursor_dbg_size(struct seq_file *s, u32 val)
{
        seq_printf(s, "\t%d x %d", val & 0x07FF, (val >> 16) & 0x07FF);
}

static void cursor_dbg_pml(struct seq_file *s,
                           struct sti_cursor *cursor, u32 val)
{
        if (cursor->pixmap.paddr == val)
                seq_printf(s, "\tVirt @: %p", cursor->pixmap.base);
}

static void cursor_dbg_cml(struct seq_file *s,
                           struct sti_cursor *cursor, u32 val)
{
        if (cursor->clut_paddr == val)
                seq_printf(s, "\tVirt @: %p", cursor->clut);
}

static int cursor_dbg_show(struct seq_file *s, void *data)
{
        struct drm_info_node *node = s->private;
        struct sti_cursor *cursor = (struct sti_cursor *)node->info_ent->data;

        seq_printf(s, "%s: (vaddr = 0x%p)",
                   sti_plane_to_str(&cursor->plane), cursor->regs);

        DBGFS_DUMP(CUR_CTL);
        DBGFS_DUMP(CUR_VPO);
        cursor_dbg_vpo(s, readl(cursor->regs + CUR_VPO));
        DBGFS_DUMP(CUR_PML);
        cursor_dbg_pml(s, cursor, readl(cursor->regs + CUR_PML));
        DBGFS_DUMP(CUR_PMP);
        DBGFS_DUMP(CUR_SIZE);
        cursor_dbg_size(s, readl(cursor->regs + CUR_SIZE));
        DBGFS_DUMP(CUR_CML);
        cursor_dbg_cml(s, cursor, readl(cursor->regs + CUR_CML));
        DBGFS_DUMP(CUR_AWS);
        DBGFS_DUMP(CUR_AWE);
        seq_putc(s, '\n');
        return 0;
}

static struct drm_info_list cursor_debugfs_files[] = {
        { "cursor", cursor_dbg_show, 0, NULL },
};

static void cursor_debugfs_init(struct sti_cursor *cursor,
                                struct drm_minor *minor)
{
        unsigned int i;

        for (i = 0; i < ARRAY_SIZE(cursor_debugfs_files); i++)
                cursor_debugfs_files[i].data = cursor;

        drm_debugfs_create_files(cursor_debugfs_files,
                                 ARRAY_SIZE(cursor_debugfs_files),
                                 minor->debugfs_root, minor);
}

static void sti_cursor_argb8888_to_clut8(struct sti_cursor *cursor, u32 *src)
{
        u8  *dst = cursor->pixmap.base;
        unsigned int i, j;
        u32 a, r, g, b;

        for (i = 0; i < cursor->height; i++) {
                for (j = 0; j < cursor->width; j++) {
                        /* Pick the 2 higher bits of each component */
                        a = (*src >> 30) & 3;
                        r = (*src >> 22) & 3;
                        g = (*src >> 14) & 3;
                        b = (*src >> 6) & 3;
                        *dst = a << 6 | r << 4 | g << 2 | b;
                        src++;
                        dst++;
                }
        }
}

static void sti_cursor_init(struct sti_cursor *cursor)
{
        unsigned short *base = cursor->clut;
        unsigned int a, r, g, b;

        /* Assign CLUT values, ARGB444 format */
        for (a = 0; a < 4; a++)
                for (r = 0; r < 4; r++)
                        for (g = 0; g < 4; g++)
                                for (b = 0; b < 4; b++)
                                        *base++ = (a * 5) << 12 |
                                                  (r * 5) << 8 |
                                                  (g * 5) << 4 |
                                                  (b * 5);
}

static int sti_cursor_atomic_check(struct drm_plane *drm_plane,
                                   struct drm_atomic_state *state)
{
        struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
                                                                                 drm_plane);
        struct sti_plane *plane = to_sti_plane(drm_plane);
        struct sti_cursor *cursor = to_sti_cursor(plane);
        struct drm_crtc *crtc = new_plane_state->crtc;
        struct drm_framebuffer *fb = new_plane_state->fb;
        struct drm_crtc_state *crtc_state;
        struct drm_display_mode *mode;
        int dst_x, dst_y, dst_w, dst_h;
        int src_w, src_h;

        /* no need for further checks if the plane is being disabled */
        if (!crtc || !fb)
                return 0;

        crtc_state = drm_atomic_get_crtc_state(state, crtc);
        if (IS_ERR(crtc_state))
                return PTR_ERR(crtc_state);

        mode = &crtc_state->mode;
        dst_x = new_plane_state->crtc_x;
        dst_y = new_plane_state->crtc_y;
        dst_w = clamp_val(new_plane_state->crtc_w, 0,
                          mode->crtc_hdisplay - dst_x);
        dst_h = clamp_val(new_plane_state->crtc_h, 0,
                          mode->crtc_vdisplay - dst_y);
        /* src_x are in 16.16 format */
        src_w = new_plane_state->src_w >> 16;
        src_h = new_plane_state->src_h >> 16;

        if (src_w < STI_CURS_MIN_SIZE ||
            src_h < STI_CURS_MIN_SIZE ||
            src_w > STI_CURS_MAX_SIZE ||
            src_h > STI_CURS_MAX_SIZE) {
                DRM_ERROR("Invalid cursor size (%dx%d)\n",
                                src_w, src_h);
                return -EINVAL;
        }

        /* If the cursor size has changed, re-allocated the pixmap */
        if (!cursor->pixmap.base ||
            (cursor->width != src_w) ||
            (cursor->height != src_h)) {
                cursor->width = src_w;
                cursor->height = src_h;

                if (cursor->pixmap.base)
                        dma_free_wc(cursor->dev, cursor->pixmap.size,
                                    cursor->pixmap.base, cursor->pixmap.paddr);

                cursor->pixmap.size = cursor->width * cursor->height;

                cursor->pixmap.base = dma_alloc_wc(cursor->dev,
                                                   cursor->pixmap.size,
                                                   &cursor->pixmap.paddr,
                                                   GFP_KERNEL | GFP_DMA);
                if (!cursor->pixmap.base) {
                        DRM_ERROR("Failed to allocate memory for pixmap\n");
                        return -EINVAL;
                }
        }

        if (!drm_fb_dma_get_gem_obj(fb, 0)) {
                DRM_ERROR("Can't get DMA GEM object for fb\n");
                return -EINVAL;
        }

        DRM_DEBUG_KMS("CRTC:%d (%s) drm plane:%d (%s)\n",
                      crtc->base.id, sti_mixer_to_str(to_sti_mixer(crtc)),
                      drm_plane->base.id, sti_plane_to_str(plane));
        DRM_DEBUG_KMS("(%dx%d)@(%d,%d)\n", dst_w, dst_h, dst_x, dst_y);

        return 0;
}

static void sti_cursor_atomic_update(struct drm_plane *drm_plane,
                                     struct drm_atomic_state *state)
{
        struct drm_plane_state *newstate = drm_atomic_get_new_plane_state(state,
                                                                          drm_plane);
        struct sti_plane *plane = to_sti_plane(drm_plane);
        struct sti_cursor *cursor = to_sti_cursor(plane);
        struct drm_crtc *crtc = newstate->crtc;
        struct drm_framebuffer *fb = newstate->fb;
        struct drm_display_mode *mode;
        int dst_x, dst_y;
        struct drm_gem_dma_object *dma_obj;
        u32 y, x;
        u32 val;

        if (!crtc || !fb)
                return;

        mode = &crtc->mode;
        dst_x = newstate->crtc_x;
        dst_y = newstate->crtc_y;

        dma_obj = drm_fb_dma_get_gem_obj(fb, 0);

        /* Convert ARGB8888 to CLUT8 */
        sti_cursor_argb8888_to_clut8(cursor, (u32 *)dma_obj->vaddr);

        /* AWS and AWE depend on the mode */
        y = sti_vtg_get_line_number(*mode, 0);
        x = sti_vtg_get_pixel_number(*mode, 0);
        val = y << 16 | x;
        writel(val, cursor->regs + CUR_AWS);
        y = sti_vtg_get_line_number(*mode, mode->vdisplay - 1);
        x = sti_vtg_get_pixel_number(*mode, mode->hdisplay - 1);
        val = y << 16 | x;
        writel(val, cursor->regs + CUR_AWE);

        /* Set memory location, size, and position */
        writel(cursor->pixmap.paddr, cursor->regs + CUR_PML);
        writel(cursor->width, cursor->regs + CUR_PMP);
        writel(cursor->height << 16 | cursor->width, cursor->regs + CUR_SIZE);

        y = sti_vtg_get_line_number(*mode, dst_y);
        x = sti_vtg_get_pixel_number(*mode, dst_x);
        writel((y << 16) | x, cursor->regs + CUR_VPO);

        /* Set and fetch CLUT */
        writel(cursor->clut_paddr, cursor->regs + CUR_CML);
        writel(CUR_CTL_CLUT_UPDATE, cursor->regs + CUR_CTL);

        sti_plane_update_fps(plane, true, false);

        plane->status = STI_PLANE_UPDATED;
}

static void sti_cursor_atomic_disable(struct drm_plane *drm_plane,
                                      struct drm_atomic_state *state)
{
        struct drm_plane_state *oldstate = drm_atomic_get_old_plane_state(state,
                                                                          drm_plane);
        struct sti_plane *plane = to_sti_plane(drm_plane);

        if (!oldstate->crtc) {
                DRM_DEBUG_DRIVER("drm plane:%d not enabled\n",
                                 drm_plane->base.id);
                return;
        }

        DRM_DEBUG_DRIVER("CRTC:%d (%s) drm plane:%d (%s)\n",
                         oldstate->crtc->base.id,
                         sti_mixer_to_str(to_sti_mixer(oldstate->crtc)),
                         drm_plane->base.id, sti_plane_to_str(plane));

        plane->status = STI_PLANE_DISABLING;
}

static const struct drm_plane_helper_funcs sti_cursor_helpers_funcs = {
        .atomic_check = sti_cursor_atomic_check,
        .atomic_update = sti_cursor_atomic_update,
        .atomic_disable = sti_cursor_atomic_disable,
};

static int sti_cursor_late_register(struct drm_plane *drm_plane)
{
        struct sti_plane *plane = to_sti_plane(drm_plane);
        struct sti_cursor *cursor = to_sti_cursor(plane);

        cursor_debugfs_init(cursor, drm_plane->dev->primary);

        return 0;
}

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

struct drm_plane *sti_cursor_create(struct drm_device *drm_dev,
                                    struct device *dev, int desc,
                                    void __iomem *baseaddr,
                                    unsigned int possible_crtcs)
{
        struct sti_cursor *cursor;
        size_t size;
        int res;

        cursor = devm_kzalloc(dev, sizeof(*cursor), GFP_KERNEL);
        if (!cursor) {
                DRM_ERROR("Failed to allocate memory for cursor\n");
                return NULL;
        }

        /* Allocate clut buffer */
        size = 0x100 * sizeof(unsigned short);
        cursor->clut = dma_alloc_wc(dev, size, &cursor->clut_paddr,
                                    GFP_KERNEL | GFP_DMA);

        if (!cursor->clut) {
                DRM_ERROR("Failed to allocate memory for cursor clut\n");
                goto err_clut;
        }

        cursor->dev = dev;
        cursor->regs = baseaddr;
        cursor->plane.desc = desc;
        cursor->plane.status = STI_PLANE_DISABLED;

        sti_cursor_init(cursor);

        res = drm_universal_plane_init(drm_dev, &cursor->plane.drm_plane,
                                       possible_crtcs,
                                       &sti_cursor_plane_helpers_funcs,
                                       cursor_supported_formats,
                                       ARRAY_SIZE(cursor_supported_formats),
                                       NULL, DRM_PLANE_TYPE_CURSOR, NULL);
        if (res) {
                DRM_ERROR("Failed to initialize universal plane\n");
                goto err_plane;
        }

        drm_plane_helper_add(&cursor->plane.drm_plane,
                             &sti_cursor_helpers_funcs);

        sti_plane_init_property(&cursor->plane, DRM_PLANE_TYPE_CURSOR);

        return &cursor->plane.drm_plane;

err_plane:
        dma_free_wc(dev, size, cursor->clut, cursor->clut_paddr);
err_clut:
        devm_kfree(dev, cursor);
        return NULL;
}