root/drivers/gpu/drm/ingenic/ingenic-drm-drv.c
// SPDX-License-Identifier: GPL-2.0
//
// Ingenic JZ47xx KMS driver
//
// Copyright (C) 2019, Paul Cercueil <paul@crapouillou.net>

#include "ingenic-drm.h"

#include <linux/bitfield.h>
#include <linux/component.h>
#include <linux/clk.h>
#include <linux/dma-mapping.h>
#include <linux/io.h>
#include <linux/media-bus-format.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/of.h>
#include <linux/of_reserved_mem.h>
#include <linux/platform_device.h>
#include <linux/pm.h>
#include <linux/regmap.h>

#include <drm/clients/drm_client_setup.h>
#include <drm/drm_atomic.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_bridge.h>
#include <drm/drm_bridge_connector.h>
#include <drm/drm_color_mgmt.h>
#include <drm/drm_crtc.h>
#include <drm/drm_damage_helper.h>
#include <drm/drm_drv.h>
#include <drm/drm_encoder.h>
#include <drm/drm_gem_dma_helper.h>
#include <drm/drm_fb_dma_helper.h>
#include <drm/drm_fbdev_dma.h>
#include <drm/drm_fourcc.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_gem_atomic_helper.h>
#include <drm/drm_gem_framebuffer_helper.h>
#include <drm/drm_managed.h>
#include <drm/drm_of.h>
#include <drm/drm_panel.h>
#include <drm/drm_plane.h>
#include <drm/drm_probe_helper.h>
#include <drm/drm_vblank.h>

#define HWDESC_PALETTE 2

struct ingenic_dma_hwdesc {
        u32 next;
        u32 addr;
        u32 id;
        u32 cmd;
        /* extended hw descriptor for jz4780 */
        u32 offsize;
        u32 pagewidth;
        u32 cpos;
        u32 dessize;
} __aligned(16);

struct ingenic_dma_hwdescs {
        struct ingenic_dma_hwdesc hwdesc[3];
        u16 palette[256] __aligned(16);
};

struct jz_soc_info {
        bool needs_dev_clk;
        bool has_osd;
        bool has_alpha;
        bool map_noncoherent;
        bool use_extended_hwdesc;
        bool plane_f0_not_working;
        u32 max_burst;
        unsigned int max_width, max_height;
        const u32 *formats_f0, *formats_f1;
        unsigned int num_formats_f0, num_formats_f1;
};

struct ingenic_drm_private_state {
        struct drm_private_state base;
        bool use_palette;
};

struct ingenic_drm {
        struct drm_device drm;
        /*
         * f1 (aka. foreground1) is our primary plane, on top of which
         * f0 (aka. foreground0) can be overlayed. Z-order is fixed in
         * hardware and cannot be changed.
         */
        struct drm_plane f0, f1, *ipu_plane;
        struct drm_crtc crtc;

        struct device *dev;
        struct regmap *map;
        struct clk *lcd_clk, *pix_clk;
        const struct jz_soc_info *soc_info;

        struct ingenic_dma_hwdescs *dma_hwdescs;
        dma_addr_t dma_hwdescs_phys;

        bool panel_is_sharp;
        bool no_vblank;

        /*
         * clk_mutex is used to synchronize the pixel clock rate update with
         * the VBLANK. When the pixel clock's parent clock needs to be updated,
         * clock_nb's notifier function will lock the mutex, then wait until the
         * next VBLANK. At that point, the parent clock's rate can be updated,
         * and the mutex is then unlocked. If an atomic commit happens in the
         * meantime, it will lock on the mutex, effectively waiting until the
         * clock update process finishes. Finally, the pixel clock's rate will
         * be recomputed when the mutex has been released, in the pending atomic
         * commit, or a future one.
         */
        struct mutex clk_mutex;
        bool update_clk_rate;
        struct notifier_block clock_nb;

        struct drm_private_obj private_obj;
};

struct ingenic_drm_bridge {
        struct drm_encoder encoder;
        struct drm_bridge bridge, *next_bridge;

        struct drm_bus_cfg bus_cfg;
};

static inline struct ingenic_drm_bridge *
to_ingenic_drm_bridge(struct drm_encoder *encoder)
{
        return container_of(encoder, struct ingenic_drm_bridge, encoder);
}

static inline struct ingenic_drm_private_state *
to_ingenic_drm_priv_state(struct drm_private_state *state)
{
        return container_of(state, struct ingenic_drm_private_state, base);
}

static struct ingenic_drm_private_state *
ingenic_drm_get_priv_state(struct ingenic_drm *priv, struct drm_atomic_state *state)
{
        struct drm_private_state *priv_state;

        priv_state = drm_atomic_get_private_obj_state(state, &priv->private_obj);
        if (IS_ERR(priv_state))
                return ERR_CAST(priv_state);

        return to_ingenic_drm_priv_state(priv_state);
}

static struct ingenic_drm_private_state *
ingenic_drm_get_new_priv_state(struct ingenic_drm *priv, struct drm_atomic_state *state)
{
        struct drm_private_state *priv_state;

        priv_state = drm_atomic_get_new_private_obj_state(state, &priv->private_obj);
        if (!priv_state)
                return NULL;

        return to_ingenic_drm_priv_state(priv_state);
}

static bool ingenic_drm_writeable_reg(struct device *dev, unsigned int reg)
{
        switch (reg) {
        case JZ_REG_LCD_IID:
        case JZ_REG_LCD_SA0:
        case JZ_REG_LCD_FID0:
        case JZ_REG_LCD_CMD0:
        case JZ_REG_LCD_SA1:
        case JZ_REG_LCD_FID1:
        case JZ_REG_LCD_CMD1:
                return false;
        default:
                return true;
        }
}

static const struct regmap_config ingenic_drm_regmap_config = {
        .reg_bits = 32,
        .val_bits = 32,
        .reg_stride = 4,

        .writeable_reg = ingenic_drm_writeable_reg,
};

static inline struct ingenic_drm *drm_device_get_priv(struct drm_device *drm)
{
        return container_of(drm, struct ingenic_drm, drm);
}

static inline struct ingenic_drm *drm_crtc_get_priv(struct drm_crtc *crtc)
{
        return container_of(crtc, struct ingenic_drm, crtc);
}

static inline struct ingenic_drm *drm_nb_get_priv(struct notifier_block *nb)
{
        return container_of(nb, struct ingenic_drm, clock_nb);
}

static inline dma_addr_t dma_hwdesc_addr(const struct ingenic_drm *priv,
                                         unsigned int idx)
{
        u32 offset = offsetof(struct ingenic_dma_hwdescs, hwdesc[idx]);

        return priv->dma_hwdescs_phys + offset;
}

static int ingenic_drm_update_pixclk(struct notifier_block *nb,
                                     unsigned long action,
                                     void *data)
{
        struct ingenic_drm *priv = drm_nb_get_priv(nb);

        switch (action) {
        case PRE_RATE_CHANGE:
                mutex_lock(&priv->clk_mutex);
                priv->update_clk_rate = true;
                drm_crtc_wait_one_vblank(&priv->crtc);
                return NOTIFY_OK;
        default:
                mutex_unlock(&priv->clk_mutex);
                return NOTIFY_OK;
        }
}

static void ingenic_drm_bridge_atomic_enable(struct drm_bridge *bridge,
                                             struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_device_get_priv(bridge->dev);

        regmap_write(priv->map, JZ_REG_LCD_STATE, 0);

        regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
                           JZ_LCD_CTRL_ENABLE | JZ_LCD_CTRL_DISABLE,
                           JZ_LCD_CTRL_ENABLE);
}

static void ingenic_drm_crtc_atomic_enable(struct drm_crtc *crtc,
                                           struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
        struct ingenic_drm_private_state *priv_state;
        unsigned int next_id;

        priv_state = ingenic_drm_get_new_priv_state(priv, state);
        if (WARN_ON(!priv_state))
                return;

        /* Set addresses of our DMA descriptor chains */
        next_id = priv_state->use_palette ? HWDESC_PALETTE : 0;
        regmap_write(priv->map, JZ_REG_LCD_DA0, dma_hwdesc_addr(priv, next_id));
        regmap_write(priv->map, JZ_REG_LCD_DA1, dma_hwdesc_addr(priv, 1));

        drm_crtc_vblank_on(crtc);
}

static void ingenic_drm_bridge_atomic_disable(struct drm_bridge *bridge,
                                              struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_device_get_priv(bridge->dev);
        unsigned int var;

        regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
                           JZ_LCD_CTRL_DISABLE, JZ_LCD_CTRL_DISABLE);

        regmap_read_poll_timeout(priv->map, JZ_REG_LCD_STATE, var,
                                 var & JZ_LCD_STATE_DISABLED,
                                 1000, 0);
}

static void ingenic_drm_crtc_atomic_disable(struct drm_crtc *crtc,
                                            struct drm_atomic_state *state)
{
        drm_crtc_vblank_off(crtc);
}

static void ingenic_drm_crtc_update_timings(struct ingenic_drm *priv,
                                            struct drm_display_mode *mode)
{
        unsigned int vpe, vds, vde, vt, hpe, hds, hde, ht;

        vpe = mode->crtc_vsync_end - mode->crtc_vsync_start;
        vds = mode->crtc_vtotal - mode->crtc_vsync_start;
        vde = vds + mode->crtc_vdisplay;
        vt = vde + mode->crtc_vsync_start - mode->crtc_vdisplay;

        hpe = mode->crtc_hsync_end - mode->crtc_hsync_start;
        hds = mode->crtc_htotal - mode->crtc_hsync_start;
        hde = hds + mode->crtc_hdisplay;
        ht = hde + mode->crtc_hsync_start - mode->crtc_hdisplay;

        regmap_write(priv->map, JZ_REG_LCD_VSYNC,
                     0 << JZ_LCD_VSYNC_VPS_OFFSET |
                     vpe << JZ_LCD_VSYNC_VPE_OFFSET);

        regmap_write(priv->map, JZ_REG_LCD_HSYNC,
                     0 << JZ_LCD_HSYNC_HPS_OFFSET |
                     hpe << JZ_LCD_HSYNC_HPE_OFFSET);

        regmap_write(priv->map, JZ_REG_LCD_VAT,
                     ht << JZ_LCD_VAT_HT_OFFSET |
                     vt << JZ_LCD_VAT_VT_OFFSET);

        regmap_write(priv->map, JZ_REG_LCD_DAH,
                     hds << JZ_LCD_DAH_HDS_OFFSET |
                     hde << JZ_LCD_DAH_HDE_OFFSET);
        regmap_write(priv->map, JZ_REG_LCD_DAV,
                     vds << JZ_LCD_DAV_VDS_OFFSET |
                     vde << JZ_LCD_DAV_VDE_OFFSET);

        if (priv->panel_is_sharp) {
                regmap_write(priv->map, JZ_REG_LCD_PS, hde << 16 | (hde + 1));
                regmap_write(priv->map, JZ_REG_LCD_CLS, hde << 16 | (hde + 1));
                regmap_write(priv->map, JZ_REG_LCD_SPL, hpe << 16 | (hpe + 1));
                regmap_write(priv->map, JZ_REG_LCD_REV, mode->htotal << 16);
        }

        regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
                           JZ_LCD_CTRL_OFUP | JZ_LCD_CTRL_BURST_MASK,
                           JZ_LCD_CTRL_OFUP | priv->soc_info->max_burst);

        /*
         * IPU restart - specify how much time the LCDC will wait before
         * transferring a new frame from the IPU. The value is the one
         * suggested in the programming manual.
         */
        regmap_write(priv->map, JZ_REG_LCD_IPUR, JZ_LCD_IPUR_IPUREN |
                     (ht * vpe / 3) << JZ_LCD_IPUR_IPUR_LSB);
}

static int ingenic_drm_crtc_atomic_check(struct drm_crtc *crtc,
                                         struct drm_atomic_state *state)
{
        struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
                                                                          crtc);
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
        struct drm_plane_state *f1_state, *f0_state, *ipu_state = NULL;
        struct ingenic_drm_private_state *priv_state;

        if (crtc_state->gamma_lut &&
            drm_color_lut_size(crtc_state->gamma_lut) != ARRAY_SIZE(priv->dma_hwdescs->palette)) {
                dev_dbg(priv->dev, "Invalid palette size\n");
                return -EINVAL;
        }

        /* We will need the state in atomic_enable, so let's make sure it's part of the state */
        priv_state = ingenic_drm_get_priv_state(priv, state);
        if (IS_ERR(priv_state))
                return PTR_ERR(priv_state);

        if (drm_atomic_crtc_needs_modeset(crtc_state) && priv->soc_info->has_osd) {
                f1_state = drm_atomic_get_plane_state(crtc_state->state,
                                                      &priv->f1);
                if (IS_ERR(f1_state))
                        return PTR_ERR(f1_state);

                f0_state = drm_atomic_get_plane_state(crtc_state->state,
                                                      &priv->f0);
                if (IS_ERR(f0_state))
                        return PTR_ERR(f0_state);

                if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && priv->ipu_plane) {
                        ipu_state = drm_atomic_get_plane_state(crtc_state->state,
                                                               priv->ipu_plane);
                        if (IS_ERR(ipu_state))
                                return PTR_ERR(ipu_state);

                        /* IPU and F1 planes cannot be enabled at the same time. */
                        if (f1_state->fb && ipu_state->fb) {
                                dev_dbg(priv->dev, "Cannot enable both F1 and IPU\n");
                                return -EINVAL;
                        }
                }

                /* If all the planes are disabled, we won't get a VBLANK IRQ */
                priv->no_vblank = !f1_state->fb && !f0_state->fb &&
                                  !(ipu_state && ipu_state->fb);
        }

        return 0;
}

static enum drm_mode_status
ingenic_drm_crtc_mode_valid(struct drm_crtc *crtc, const struct drm_display_mode *mode)
{
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
        long rate;

        if (mode->hdisplay > priv->soc_info->max_width)
                return MODE_BAD_HVALUE;
        if (mode->vdisplay > priv->soc_info->max_height)
                return MODE_BAD_VVALUE;

        rate = clk_round_rate(priv->pix_clk, mode->clock * 1000);
        if (rate < 0)
                return MODE_CLOCK_RANGE;

        return MODE_OK;
}

static void ingenic_drm_crtc_atomic_begin(struct drm_crtc *crtc,
                                          struct drm_atomic_state *state)
{
        struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
                                                                          crtc);
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
        u32 ctrl = 0;

        if (priv->soc_info->has_osd &&
            drm_atomic_crtc_needs_modeset(crtc_state)) {
                /*
                 * If IPU plane is enabled, enable IPU as source for the F1
                 * plane; otherwise use regular DMA.
                 */
                if (priv->ipu_plane && priv->ipu_plane->state->fb)
                        ctrl |= JZ_LCD_OSDCTRL_IPU;

                regmap_update_bits(priv->map, JZ_REG_LCD_OSDCTRL,
                                   JZ_LCD_OSDCTRL_IPU, ctrl);
        }
}

static void ingenic_drm_crtc_atomic_flush(struct drm_crtc *crtc,
                                          struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
        struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
                                                                          crtc);
        struct drm_pending_vblank_event *event = crtc_state->event;

        if (drm_atomic_crtc_needs_modeset(crtc_state)) {
                ingenic_drm_crtc_update_timings(priv, &crtc_state->adjusted_mode);
                priv->update_clk_rate = true;
        }

        if (priv->update_clk_rate) {
                mutex_lock(&priv->clk_mutex);
                clk_set_rate(priv->pix_clk,
                             crtc_state->adjusted_mode.crtc_clock * 1000);
                priv->update_clk_rate = false;
                mutex_unlock(&priv->clk_mutex);
        }

        if (event) {
                crtc_state->event = NULL;

                spin_lock_irq(&crtc->dev->event_lock);
                if (drm_crtc_vblank_get(crtc) == 0)
                        drm_crtc_arm_vblank_event(crtc, event);
                else
                        drm_crtc_send_vblank_event(crtc, event);
                spin_unlock_irq(&crtc->dev->event_lock);
        }
}

static int ingenic_drm_plane_atomic_check(struct drm_plane *plane,
                                          struct drm_atomic_state *state)
{
        struct drm_plane_state *old_plane_state = drm_atomic_get_old_plane_state(state,
                                                                                 plane);
        struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
                                                                                 plane);
        struct ingenic_drm *priv = drm_device_get_priv(plane->dev);
        struct ingenic_drm_private_state *priv_state;
        struct drm_crtc_state *crtc_state;
        struct drm_crtc *crtc = new_plane_state->crtc ?: old_plane_state->crtc;
        int ret;

        if (!crtc)
                return 0;

        if (priv->soc_info->plane_f0_not_working && plane == &priv->f0)
                return -EINVAL;

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

        priv_state = ingenic_drm_get_priv_state(priv, state);
        if (IS_ERR(priv_state))
                return PTR_ERR(priv_state);

        ret = drm_atomic_helper_check_plane_state(new_plane_state, crtc_state,
                                                  DRM_PLANE_NO_SCALING,
                                                  DRM_PLANE_NO_SCALING,
                                                  priv->soc_info->has_osd,
                                                  true);
        if (ret)
                return ret;

        /*
         * If OSD is not available, check that the width/height match.
         * Note that state->src_* are in 16.16 fixed-point format.
         */
        if (!priv->soc_info->has_osd &&
            (new_plane_state->src_x != 0 ||
             (new_plane_state->src_w >> 16) != new_plane_state->crtc_w ||
             (new_plane_state->src_h >> 16) != new_plane_state->crtc_h))
                return -EINVAL;

        priv_state->use_palette = new_plane_state->fb &&
                new_plane_state->fb->format->format == DRM_FORMAT_C8;

        /*
         * Require full modeset if enabling or disabling a plane, or changing
         * its position, size or depth.
         */
        if (priv->soc_info->has_osd &&
            (!old_plane_state->fb || !new_plane_state->fb ||
             old_plane_state->crtc_x != new_plane_state->crtc_x ||
             old_plane_state->crtc_y != new_plane_state->crtc_y ||
             old_plane_state->crtc_w != new_plane_state->crtc_w ||
             old_plane_state->crtc_h != new_plane_state->crtc_h ||
             old_plane_state->fb->format->format != new_plane_state->fb->format->format))
                crtc_state->mode_changed = true;

        if (priv->soc_info->map_noncoherent)
                drm_atomic_helper_check_plane_damage(state, new_plane_state);

        return 0;
}

static void ingenic_drm_plane_enable(struct ingenic_drm *priv,
                                     struct drm_plane *plane)
{
        unsigned int en_bit;

        if (priv->soc_info->has_osd) {
                if (plane != &priv->f0)
                        en_bit = JZ_LCD_OSDC_F1EN;
                else
                        en_bit = JZ_LCD_OSDC_F0EN;

                regmap_set_bits(priv->map, JZ_REG_LCD_OSDC, en_bit);
        }
}

void ingenic_drm_plane_disable(struct device *dev, struct drm_plane *plane)
{
        struct ingenic_drm *priv = dev_get_drvdata(dev);
        unsigned int en_bit;

        if (priv->soc_info->has_osd) {
                if (plane != &priv->f0)
                        en_bit = JZ_LCD_OSDC_F1EN;
                else
                        en_bit = JZ_LCD_OSDC_F0EN;

                regmap_clear_bits(priv->map, JZ_REG_LCD_OSDC, en_bit);
        }
}

static void ingenic_drm_plane_atomic_disable(struct drm_plane *plane,
                                             struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_device_get_priv(plane->dev);

        ingenic_drm_plane_disable(priv->dev, plane);
}

void ingenic_drm_plane_config(struct device *dev,
                              struct drm_plane *plane, u32 fourcc)
{
        struct ingenic_drm *priv = dev_get_drvdata(dev);
        struct drm_plane_state *state = plane->state;
        unsigned int xy_reg, size_reg;
        unsigned int ctrl = 0;

        ingenic_drm_plane_enable(priv, plane);

        if (priv->soc_info->has_osd && plane != &priv->f0) {
                switch (fourcc) {
                case DRM_FORMAT_XRGB1555:
                        ctrl |= JZ_LCD_OSDCTRL_RGB555;
                        fallthrough;
                case DRM_FORMAT_RGB565:
                        ctrl |= JZ_LCD_OSDCTRL_BPP_15_16;
                        break;
                case DRM_FORMAT_RGB888:
                        ctrl |= JZ_LCD_OSDCTRL_BPP_24_COMP;
                        break;
                case DRM_FORMAT_XRGB8888:
                        ctrl |= JZ_LCD_OSDCTRL_BPP_18_24;
                        break;
                case DRM_FORMAT_XRGB2101010:
                        ctrl |= JZ_LCD_OSDCTRL_BPP_30;
                        break;
                }

                regmap_update_bits(priv->map, JZ_REG_LCD_OSDCTRL,
                                   JZ_LCD_OSDCTRL_BPP_MASK, ctrl);
        } else {
                switch (fourcc) {
                case DRM_FORMAT_C8:
                        ctrl |= JZ_LCD_CTRL_BPP_8;
                        break;
                case DRM_FORMAT_XRGB1555:
                        ctrl |= JZ_LCD_CTRL_RGB555;
                        fallthrough;
                case DRM_FORMAT_RGB565:
                        ctrl |= JZ_LCD_CTRL_BPP_15_16;
                        break;
                case DRM_FORMAT_RGB888:
                        ctrl |= JZ_LCD_CTRL_BPP_24_COMP;
                        break;
                case DRM_FORMAT_XRGB8888:
                        ctrl |= JZ_LCD_CTRL_BPP_18_24;
                        break;
                case DRM_FORMAT_XRGB2101010:
                        ctrl |= JZ_LCD_CTRL_BPP_30;
                        break;
                }

                regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
                                   JZ_LCD_CTRL_BPP_MASK, ctrl);
        }

        if (priv->soc_info->has_osd) {
                if (plane != &priv->f0) {
                        xy_reg = JZ_REG_LCD_XYP1;
                        size_reg = JZ_REG_LCD_SIZE1;
                } else {
                        xy_reg = JZ_REG_LCD_XYP0;
                        size_reg = JZ_REG_LCD_SIZE0;
                }

                regmap_write(priv->map, xy_reg,
                             state->crtc_x << JZ_LCD_XYP01_XPOS_LSB |
                             state->crtc_y << JZ_LCD_XYP01_YPOS_LSB);
                regmap_write(priv->map, size_reg,
                             state->crtc_w << JZ_LCD_SIZE01_WIDTH_LSB |
                             state->crtc_h << JZ_LCD_SIZE01_HEIGHT_LSB);
        }
}

bool ingenic_drm_map_noncoherent(const struct device *dev)
{
        const struct ingenic_drm *priv = dev_get_drvdata(dev);

        return priv->soc_info->map_noncoherent;
}

static void ingenic_drm_update_palette(struct ingenic_drm *priv,
                                       const struct drm_color_lut *lut)
{
        unsigned int i;

        for (i = 0; i < ARRAY_SIZE(priv->dma_hwdescs->palette); i++) {
                u16 color = drm_color_lut_extract(lut[i].red, 5) << 11
                        | drm_color_lut_extract(lut[i].green, 6) << 5
                        | drm_color_lut_extract(lut[i].blue, 5);

                priv->dma_hwdescs->palette[i] = color;
        }
}

static void ingenic_drm_plane_atomic_update(struct drm_plane *plane,
                                            struct drm_atomic_state *state)
{
        struct ingenic_drm *priv = drm_device_get_priv(plane->dev);
        struct drm_plane_state *newstate = drm_atomic_get_new_plane_state(state, plane);
        struct drm_plane_state *oldstate = drm_atomic_get_old_plane_state(state, plane);
        unsigned int width, height, cpp, next_id, plane_id;
        struct ingenic_drm_private_state *priv_state;
        struct drm_crtc_state *crtc_state;
        struct ingenic_dma_hwdesc *hwdesc;
        dma_addr_t addr;
        u32 fourcc;

        if (newstate && newstate->fb) {
                if (priv->soc_info->map_noncoherent)
                        drm_fb_dma_sync_non_coherent(&priv->drm, oldstate, newstate);

                crtc_state = newstate->crtc->state;
                plane_id = !!(priv->soc_info->has_osd && plane != &priv->f0);

                addr = drm_fb_dma_get_gem_addr(newstate->fb, newstate, 0);
                width = newstate->src_w >> 16;
                height = newstate->src_h >> 16;
                cpp = newstate->fb->format->cpp[0];

                priv_state = ingenic_drm_get_new_priv_state(priv, state);
                next_id = (priv_state && priv_state->use_palette) ? HWDESC_PALETTE : plane_id;

                hwdesc = &priv->dma_hwdescs->hwdesc[plane_id];
                hwdesc->addr = addr;
                hwdesc->cmd = JZ_LCD_CMD_EOF_IRQ | (width * height * cpp / 4);
                hwdesc->next = dma_hwdesc_addr(priv, next_id);

                if (priv->soc_info->use_extended_hwdesc) {
                        hwdesc->cmd |= JZ_LCD_CMD_FRM_ENABLE;

                        /* Extended 8-byte descriptor */
                        hwdesc->cpos = 0;
                        hwdesc->offsize = 0;
                        hwdesc->pagewidth = 0;

                        switch (newstate->fb->format->format) {
                        case DRM_FORMAT_XRGB1555:
                                hwdesc->cpos |= JZ_LCD_CPOS_RGB555;
                                fallthrough;
                        case DRM_FORMAT_RGB565:
                                hwdesc->cpos |= JZ_LCD_CPOS_BPP_15_16;
                                break;
                        case DRM_FORMAT_XRGB8888:
                                hwdesc->cpos |= JZ_LCD_CPOS_BPP_18_24;
                                break;
                        }
                        hwdesc->cpos |= (JZ_LCD_CPOS_COEFFICIENT_1 <<
                                         JZ_LCD_CPOS_COEFFICIENT_OFFSET);
                        hwdesc->dessize =
                                (0xff << JZ_LCD_DESSIZE_ALPHA_OFFSET) |
                                FIELD_PREP(JZ_LCD_DESSIZE_HEIGHT_MASK, height - 1) |
                                FIELD_PREP(JZ_LCD_DESSIZE_WIDTH_MASK, width - 1);
                }

                if (drm_atomic_crtc_needs_modeset(crtc_state)) {
                        fourcc = newstate->fb->format->format;

                        ingenic_drm_plane_config(priv->dev, plane, fourcc);

                        crtc_state->color_mgmt_changed = fourcc == DRM_FORMAT_C8;
                }

                if (crtc_state->color_mgmt_changed)
                        ingenic_drm_update_palette(priv, crtc_state->gamma_lut->data);
        }
}

static void ingenic_drm_encoder_atomic_mode_set(struct drm_encoder *encoder,
                                                struct drm_crtc_state *crtc_state,
                                                struct drm_connector_state *conn_state)
{
        struct ingenic_drm *priv = drm_device_get_priv(encoder->dev);
        struct drm_display_mode *mode = &crtc_state->adjusted_mode;
        struct ingenic_drm_bridge *bridge = to_ingenic_drm_bridge(encoder);
        unsigned int cfg, rgbcfg = 0;

        priv->panel_is_sharp = bridge->bus_cfg.flags & DRM_BUS_FLAG_SHARP_SIGNALS;

        if (priv->panel_is_sharp) {
                cfg = JZ_LCD_CFG_MODE_SPECIAL_TFT_1 | JZ_LCD_CFG_REV_POLARITY;
        } else {
                cfg = JZ_LCD_CFG_PS_DISABLE | JZ_LCD_CFG_CLS_DISABLE
                    | JZ_LCD_CFG_SPL_DISABLE | JZ_LCD_CFG_REV_DISABLE;
        }

        if (priv->soc_info->use_extended_hwdesc)
                cfg |= JZ_LCD_CFG_DESCRIPTOR_8;

        if (mode->flags & DRM_MODE_FLAG_NHSYNC)
                cfg |= JZ_LCD_CFG_HSYNC_ACTIVE_LOW;
        if (mode->flags & DRM_MODE_FLAG_NVSYNC)
                cfg |= JZ_LCD_CFG_VSYNC_ACTIVE_LOW;
        if (bridge->bus_cfg.flags & DRM_BUS_FLAG_DE_LOW)
                cfg |= JZ_LCD_CFG_DE_ACTIVE_LOW;
        if (bridge->bus_cfg.flags & DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE)
                cfg |= JZ_LCD_CFG_PCLK_FALLING_EDGE;

        if (!priv->panel_is_sharp) {
                if (conn_state->connector->connector_type == DRM_MODE_CONNECTOR_TV) {
                        if (mode->flags & DRM_MODE_FLAG_INTERLACE)
                                cfg |= JZ_LCD_CFG_MODE_TV_OUT_I;
                        else
                                cfg |= JZ_LCD_CFG_MODE_TV_OUT_P;
                } else {
                        switch (bridge->bus_cfg.format) {
                        case MEDIA_BUS_FMT_RGB565_1X16:
                                cfg |= JZ_LCD_CFG_MODE_GENERIC_16BIT;
                                break;
                        case MEDIA_BUS_FMT_RGB666_1X18:
                                cfg |= JZ_LCD_CFG_MODE_GENERIC_18BIT;
                                break;
                        case MEDIA_BUS_FMT_RGB888_1X24:
                                cfg |= JZ_LCD_CFG_MODE_GENERIC_24BIT;
                                break;
                        case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
                                rgbcfg = JZ_LCD_RGBC_EVEN_GBR | JZ_LCD_RGBC_ODD_RGB;
                                fallthrough;
                        case MEDIA_BUS_FMT_RGB888_3X8:
                                cfg |= JZ_LCD_CFG_MODE_8BIT_SERIAL;
                                break;
                        default:
                                break;
                        }
                }
        }

        regmap_write(priv->map, JZ_REG_LCD_CFG, cfg);
        regmap_write(priv->map, JZ_REG_LCD_RGBC, rgbcfg);
}

static int ingenic_drm_bridge_attach(struct drm_bridge *bridge,
                                     struct drm_encoder *encoder,
                                     enum drm_bridge_attach_flags flags)
{
        struct ingenic_drm_bridge *ib = to_ingenic_drm_bridge(encoder);

        return drm_bridge_attach(encoder, ib->next_bridge,
                                 &ib->bridge, flags);
}

static int ingenic_drm_bridge_atomic_check(struct drm_bridge *bridge,
                                           struct drm_bridge_state *bridge_state,
                                           struct drm_crtc_state *crtc_state,
                                           struct drm_connector_state *conn_state)
{
        struct drm_display_mode *mode = &crtc_state->adjusted_mode;
        struct ingenic_drm_bridge *ib = to_ingenic_drm_bridge(bridge->encoder);

        ib->bus_cfg = bridge_state->output_bus_cfg;

        if (conn_state->connector->connector_type == DRM_MODE_CONNECTOR_TV)
                return 0;

        switch (bridge_state->output_bus_cfg.format) {
        case MEDIA_BUS_FMT_RGB888_3X8:
        case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
                /*
                 * The LCD controller expects timing values in dot-clock ticks,
                 * which is 3x the timing values in pixels when using a 3x8-bit
                 * display; but it will count the display area size in pixels
                 * either way. Go figure.
                 */
                mode->crtc_clock = mode->clock * 3;
                mode->crtc_hsync_start = mode->hsync_start * 3 - mode->hdisplay * 2;
                mode->crtc_hsync_end = mode->hsync_end * 3 - mode->hdisplay * 2;
                mode->crtc_hdisplay = mode->hdisplay;
                mode->crtc_htotal = mode->htotal * 3 - mode->hdisplay * 2;
                return 0;
        case MEDIA_BUS_FMT_RGB565_1X16:
        case MEDIA_BUS_FMT_RGB666_1X18:
        case MEDIA_BUS_FMT_RGB888_1X24:
                return 0;
        default:
                return -EINVAL;
        }
}

static u32 *
ingenic_drm_bridge_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
                                             struct drm_bridge_state *bridge_state,
                                             struct drm_crtc_state *crtc_state,
                                             struct drm_connector_state *conn_state,
                                             u32 output_fmt,
                                             unsigned int *num_input_fmts)
{
        switch (output_fmt) {
        case MEDIA_BUS_FMT_RGB888_1X24:
        case MEDIA_BUS_FMT_RGB666_1X18:
        case MEDIA_BUS_FMT_RGB565_1X16:
        case MEDIA_BUS_FMT_RGB888_3X8:
        case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
                break;
        default:
                *num_input_fmts = 0;
                return NULL;
        }

        return drm_atomic_helper_bridge_propagate_bus_fmt(bridge, bridge_state,
                                                          crtc_state, conn_state,
                                                          output_fmt,
                                                          num_input_fmts);
}

static irqreturn_t ingenic_drm_irq_handler(int irq, void *arg)
{
        struct ingenic_drm *priv = drm_device_get_priv(arg);
        unsigned int state;

        regmap_read(priv->map, JZ_REG_LCD_STATE, &state);

        regmap_update_bits(priv->map, JZ_REG_LCD_STATE,
                           JZ_LCD_STATE_EOF_IRQ, 0);

        if (state & JZ_LCD_STATE_EOF_IRQ)
                drm_crtc_handle_vblank(&priv->crtc);

        return IRQ_HANDLED;
}

static int ingenic_drm_enable_vblank(struct drm_crtc *crtc)
{
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);

        if (priv->no_vblank)
                return -EINVAL;

        regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
                           JZ_LCD_CTRL_EOF_IRQ, JZ_LCD_CTRL_EOF_IRQ);

        return 0;
}

static void ingenic_drm_disable_vblank(struct drm_crtc *crtc)
{
        struct ingenic_drm *priv = drm_crtc_get_priv(crtc);

        regmap_update_bits(priv->map, JZ_REG_LCD_CTRL, JZ_LCD_CTRL_EOF_IRQ, 0);
}

static struct drm_framebuffer *
ingenic_drm_gem_fb_create(struct drm_device *drm, struct drm_file *file,
                          const struct drm_format_info *info,
                          const struct drm_mode_fb_cmd2 *mode_cmd)
{
        struct ingenic_drm *priv = drm_device_get_priv(drm);

        if (priv->soc_info->map_noncoherent)
                return drm_gem_fb_create_with_dirty(drm, file, info, mode_cmd);

        return drm_gem_fb_create(drm, file, info, mode_cmd);
}

static struct drm_gem_object *
ingenic_drm_gem_create_object(struct drm_device *drm, size_t size)
{
        struct ingenic_drm *priv = drm_device_get_priv(drm);
        struct drm_gem_dma_object *obj;

        obj = kzalloc_obj(*obj);
        if (!obj)
                return ERR_PTR(-ENOMEM);

        obj->map_noncoherent = priv->soc_info->map_noncoherent;

        return &obj->base;
}

static struct drm_private_state *
ingenic_drm_duplicate_state(struct drm_private_obj *obj)
{
        struct ingenic_drm_private_state *state = to_ingenic_drm_priv_state(obj->state);

        state = kmemdup(state, sizeof(*state), GFP_KERNEL);
        if (!state)
                return NULL;

        __drm_atomic_helper_private_obj_duplicate_state(obj, &state->base);

        return &state->base;
}

static void ingenic_drm_destroy_state(struct drm_private_obj *obj,
                                      struct drm_private_state *state)
{
        struct ingenic_drm_private_state *priv_state = to_ingenic_drm_priv_state(state);

        kfree(priv_state);
}

DEFINE_DRM_GEM_DMA_FOPS(ingenic_drm_fops);

static const struct drm_driver ingenic_drm_driver_data = {
        .driver_features        = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
        .name                   = "ingenic-drm",
        .desc                   = "DRM module for Ingenic SoCs",
        .major                  = 1,
        .minor                  = 1,
        .patchlevel             = 0,

        .fops                   = &ingenic_drm_fops,
        .gem_create_object      = ingenic_drm_gem_create_object,
        DRM_GEM_DMA_DRIVER_OPS,
        DRM_FBDEV_DMA_DRIVER_OPS,
};

static const struct drm_plane_funcs ingenic_drm_primary_plane_funcs = {
        .update_plane           = drm_atomic_helper_update_plane,
        .disable_plane          = drm_atomic_helper_disable_plane,
        .reset                  = drm_atomic_helper_plane_reset,
        .destroy                = drm_plane_cleanup,

        .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
        .atomic_destroy_state   = drm_atomic_helper_plane_destroy_state,
};

static const struct drm_crtc_funcs ingenic_drm_crtc_funcs = {
        .set_config             = drm_atomic_helper_set_config,
        .page_flip              = drm_atomic_helper_page_flip,
        .reset                  = drm_atomic_helper_crtc_reset,
        .destroy                = drm_crtc_cleanup,

        .atomic_duplicate_state = drm_atomic_helper_crtc_duplicate_state,
        .atomic_destroy_state   = drm_atomic_helper_crtc_destroy_state,

        .enable_vblank          = ingenic_drm_enable_vblank,
        .disable_vblank         = ingenic_drm_disable_vblank,
};

static const struct drm_plane_helper_funcs ingenic_drm_plane_helper_funcs = {
        .atomic_update          = ingenic_drm_plane_atomic_update,
        .atomic_check           = ingenic_drm_plane_atomic_check,
        .atomic_disable         = ingenic_drm_plane_atomic_disable,
};

static const struct drm_crtc_helper_funcs ingenic_drm_crtc_helper_funcs = {
        .atomic_enable          = ingenic_drm_crtc_atomic_enable,
        .atomic_disable         = ingenic_drm_crtc_atomic_disable,
        .atomic_begin           = ingenic_drm_crtc_atomic_begin,
        .atomic_flush           = ingenic_drm_crtc_atomic_flush,
        .atomic_check           = ingenic_drm_crtc_atomic_check,
        .mode_valid             = ingenic_drm_crtc_mode_valid,
};

static const struct drm_encoder_helper_funcs ingenic_drm_encoder_helper_funcs = {
        .atomic_mode_set        = ingenic_drm_encoder_atomic_mode_set,
};

static const struct drm_bridge_funcs ingenic_drm_bridge_funcs = {
        .attach                 = ingenic_drm_bridge_attach,
        .atomic_enable          = ingenic_drm_bridge_atomic_enable,
        .atomic_disable         = ingenic_drm_bridge_atomic_disable,
        .atomic_check           = ingenic_drm_bridge_atomic_check,
        .atomic_reset           = drm_atomic_helper_bridge_reset,
        .atomic_duplicate_state = drm_atomic_helper_bridge_duplicate_state,
        .atomic_destroy_state   = drm_atomic_helper_bridge_destroy_state,
        .atomic_get_input_bus_fmts = ingenic_drm_bridge_atomic_get_input_bus_fmts,
};

static const struct drm_mode_config_funcs ingenic_drm_mode_config_funcs = {
        .fb_create              = ingenic_drm_gem_fb_create,
        .atomic_check           = drm_atomic_helper_check,
        .atomic_commit          = drm_atomic_helper_commit,
};

static struct drm_mode_config_helper_funcs ingenic_drm_mode_config_helpers = {
        .atomic_commit_tail = drm_atomic_helper_commit_tail,
};

static const struct drm_private_state_funcs ingenic_drm_private_state_funcs = {
        .atomic_duplicate_state = ingenic_drm_duplicate_state,
        .atomic_destroy_state = ingenic_drm_destroy_state,
};

static void ingenic_drm_unbind_all(void *d)
{
        struct ingenic_drm *priv = d;

        component_unbind_all(priv->dev, &priv->drm);
}

static void __maybe_unused ingenic_drm_release_rmem(void *d)
{
        of_reserved_mem_device_release(d);
}

static void ingenic_drm_configure_hwdesc(struct ingenic_drm *priv,
                                         unsigned int hwdesc,
                                         unsigned int next_hwdesc, u32 id)
{
        struct ingenic_dma_hwdesc *desc = &priv->dma_hwdescs->hwdesc[hwdesc];

        desc->next = dma_hwdesc_addr(priv, next_hwdesc);
        desc->id = id;
}

static void ingenic_drm_configure_hwdesc_palette(struct ingenic_drm *priv)
{
        struct ingenic_dma_hwdesc *desc;

        ingenic_drm_configure_hwdesc(priv, HWDESC_PALETTE, 0, 0xc0);

        desc = &priv->dma_hwdescs->hwdesc[HWDESC_PALETTE];
        desc->addr = priv->dma_hwdescs_phys
                + offsetof(struct ingenic_dma_hwdescs, palette);
        desc->cmd = JZ_LCD_CMD_ENABLE_PAL
                | (sizeof(priv->dma_hwdescs->palette) / 4);
}

static void ingenic_drm_configure_hwdesc_plane(struct ingenic_drm *priv,
                                               unsigned int plane)
{
        ingenic_drm_configure_hwdesc(priv, plane, plane, 0xf0 | plane);
}

static void ingenic_drm_atomic_private_obj_fini(struct drm_device *drm, void *private_obj)
{
        drm_atomic_private_obj_fini(private_obj);
}

static int ingenic_drm_bind(struct device *dev, bool has_components)
{
        struct platform_device *pdev = to_platform_device(dev);
        struct ingenic_drm_private_state *private_state;
        const struct jz_soc_info *soc_info;
        struct ingenic_drm *priv;
        struct clk *parent_clk;
        struct drm_plane *primary;
        struct drm_bridge *bridge;
        struct drm_panel *panel;
        struct drm_connector *connector;
        struct drm_encoder *encoder;
        struct ingenic_drm_bridge *ib;
        struct drm_device *drm;
        void __iomem *base;
        struct resource *res;
        struct regmap_config regmap_config;
        long parent_rate;
        unsigned int i, clone_mask = 0;
        int ret, irq;
        u32 osdc = 0;

        soc_info = of_device_get_match_data(dev);
        if (!soc_info) {
                dev_err(dev, "Missing platform data\n");
                return -EINVAL;
        }

        if (IS_ENABLED(CONFIG_OF_RESERVED_MEM)) {
                ret = of_reserved_mem_device_init(dev);

                if (ret && ret != -ENODEV)
                        dev_warn(dev, "Failed to get reserved memory: %d\n", ret);

                if (!ret) {
                        ret = devm_add_action_or_reset(dev, ingenic_drm_release_rmem, dev);
                        if (ret)
                                return ret;
                }
        }

        priv = devm_drm_dev_alloc(dev, &ingenic_drm_driver_data,
                                  struct ingenic_drm, drm);
        if (IS_ERR(priv))
                return PTR_ERR(priv);

        priv->soc_info = soc_info;
        priv->dev = dev;
        drm = &priv->drm;

        platform_set_drvdata(pdev, priv);

        ret = drmm_mode_config_init(drm);
        if (ret)
                goto err_drvdata;

        drm->mode_config.min_width = 0;
        drm->mode_config.min_height = 0;
        drm->mode_config.max_width = soc_info->max_width;
        drm->mode_config.max_height = 4095;
        drm->mode_config.funcs = &ingenic_drm_mode_config_funcs;
        drm->mode_config.helper_private = &ingenic_drm_mode_config_helpers;

        base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
        if (IS_ERR(base)) {
                dev_err(dev, "Failed to get memory resource\n");
                ret = PTR_ERR(base);
                goto err_drvdata;
        }

        regmap_config = ingenic_drm_regmap_config;
        regmap_config.max_register = res->end - res->start;
        priv->map = devm_regmap_init_mmio(dev, base,
                                          &regmap_config);
        if (IS_ERR(priv->map)) {
                dev_err(dev, "Failed to create regmap\n");
                ret = PTR_ERR(priv->map);
                goto err_drvdata;
        }

        irq = platform_get_irq(pdev, 0);
        if (irq < 0) {
                ret = irq;
                goto err_drvdata;
        }

        if (soc_info->needs_dev_clk) {
                priv->lcd_clk = devm_clk_get(dev, "lcd");
                if (IS_ERR(priv->lcd_clk)) {
                        dev_err(dev, "Failed to get lcd clock\n");
                        ret = PTR_ERR(priv->lcd_clk);
                        goto err_drvdata;
                }
        }

        priv->pix_clk = devm_clk_get(dev, "lcd_pclk");
        if (IS_ERR(priv->pix_clk)) {
                dev_err(dev, "Failed to get pixel clock\n");
                ret = PTR_ERR(priv->pix_clk);
                goto err_drvdata;
        }

        priv->dma_hwdescs = dmam_alloc_coherent(dev,
                                                sizeof(*priv->dma_hwdescs),
                                                &priv->dma_hwdescs_phys,
                                                GFP_KERNEL);
        if (!priv->dma_hwdescs) {
                ret = -ENOMEM;
                goto err_drvdata;
        }

        /* Configure DMA hwdesc for foreground0 plane */
        ingenic_drm_configure_hwdesc_plane(priv, 0);

        /* Configure DMA hwdesc for foreground1 plane */
        ingenic_drm_configure_hwdesc_plane(priv, 1);

        /* Configure DMA hwdesc for palette */
        ingenic_drm_configure_hwdesc_palette(priv);

        primary = priv->soc_info->has_osd ? &priv->f1 : &priv->f0;

        drm_plane_helper_add(primary, &ingenic_drm_plane_helper_funcs);

        ret = drm_universal_plane_init(drm, primary, 1,
                                       &ingenic_drm_primary_plane_funcs,
                                       priv->soc_info->formats_f1,
                                       priv->soc_info->num_formats_f1,
                                       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
        if (ret) {
                dev_err(dev, "Failed to register plane: %i\n", ret);
                goto err_drvdata;
        }

        if (soc_info->map_noncoherent)
                drm_plane_enable_fb_damage_clips(&priv->f1);

        drm_crtc_helper_add(&priv->crtc, &ingenic_drm_crtc_helper_funcs);

        ret = drm_crtc_init_with_planes(drm, &priv->crtc, primary,
                                        NULL, &ingenic_drm_crtc_funcs, NULL);
        if (ret) {
                dev_err(dev, "Failed to init CRTC: %i\n", ret);
                goto err_drvdata;
        }

        drm_crtc_enable_color_mgmt(&priv->crtc, 0, false,
                                   ARRAY_SIZE(priv->dma_hwdescs->palette));

        if (soc_info->has_osd) {
                drm_plane_helper_add(&priv->f0,
                                     &ingenic_drm_plane_helper_funcs);

                ret = drm_universal_plane_init(drm, &priv->f0, 1,
                                               &ingenic_drm_primary_plane_funcs,
                                               priv->soc_info->formats_f0,
                                               priv->soc_info->num_formats_f0,
                                               NULL, DRM_PLANE_TYPE_OVERLAY,
                                               NULL);
                if (ret) {
                        dev_err(dev, "Failed to register overlay plane: %i\n",
                                ret);
                        goto err_drvdata;
                }

                if (soc_info->map_noncoherent)
                        drm_plane_enable_fb_damage_clips(&priv->f0);

                if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && has_components) {
                        ret = component_bind_all(dev, drm);
                        if (ret) {
                                if (ret != -EPROBE_DEFER)
                                        dev_err(dev, "Failed to bind components: %i\n", ret);
                                goto err_drvdata;
                        }

                        ret = devm_add_action_or_reset(dev, ingenic_drm_unbind_all, priv);
                        if (ret)
                                goto err_drvdata;

                        priv->ipu_plane = drm_plane_from_index(drm, 2);
                        if (!priv->ipu_plane) {
                                dev_err(dev, "Failed to retrieve IPU plane\n");
                                ret = -EINVAL;
                                goto err_drvdata;
                        }
                }
        }

        for (i = 0; ; i++) {
                ret = drm_of_find_panel_or_bridge(dev->of_node, 0, i, &panel, &bridge);
                if (ret) {
                        if (ret == -ENODEV)
                                break; /* we're done */
                        if (ret != -EPROBE_DEFER)
                                dev_err(dev, "Failed to get bridge handle\n");
                        goto err_drvdata;
                }

                if (panel)
                        bridge = devm_drm_panel_bridge_add_typed(dev, panel,
                                                                 DRM_MODE_CONNECTOR_DPI);

                ib = drmm_encoder_alloc(drm, struct ingenic_drm_bridge, encoder,
                                        NULL, DRM_MODE_ENCODER_DPI, NULL);
                if (IS_ERR(ib)) {
                        ret = PTR_ERR(ib);
                        dev_err(dev, "Failed to init encoder: %d\n", ret);
                        goto err_drvdata;
                }

                encoder = &ib->encoder;
                encoder->possible_crtcs = drm_crtc_mask(&priv->crtc);

                drm_encoder_helper_add(encoder, &ingenic_drm_encoder_helper_funcs);

                ib->bridge.funcs = &ingenic_drm_bridge_funcs;
                ib->next_bridge = bridge;

                ret = drm_bridge_attach(encoder, &ib->bridge, NULL,
                                        DRM_BRIDGE_ATTACH_NO_CONNECTOR);
                if (ret) {
                        dev_err(dev, "Unable to attach bridge\n");
                        goto err_drvdata;
                }

                connector = drm_bridge_connector_init(drm, encoder);
                if (IS_ERR(connector)) {
                        dev_err(dev, "Unable to init connector\n");
                        ret = PTR_ERR(connector);
                        goto err_drvdata;
                }

                drm_connector_attach_encoder(connector, encoder);
        }

        drm_for_each_encoder(encoder, drm) {
                clone_mask |= BIT(drm_encoder_index(encoder));
        }

        drm_for_each_encoder(encoder, drm) {
                encoder->possible_clones = clone_mask;
        }

        ret = devm_request_irq(dev, irq, ingenic_drm_irq_handler, 0, drm->driver->name, drm);
        if (ret) {
                dev_err(dev, "Unable to install IRQ handler\n");
                goto err_drvdata;
        }

        ret = drm_vblank_init(drm, 1);
        if (ret) {
                dev_err(dev, "Failed calling drm_vblank_init()\n");
                goto err_drvdata;
        }

        drm_mode_config_reset(drm);

        ret = clk_prepare_enable(priv->pix_clk);
        if (ret) {
                dev_err(dev, "Unable to start pixel clock\n");
                goto err_drvdata;
        }

        if (priv->lcd_clk) {
                parent_clk = clk_get_parent(priv->lcd_clk);
                parent_rate = clk_get_rate(parent_clk);

                /* LCD Device clock must be 3x the pixel clock for STN panels,
                 * or 1.5x the pixel clock for TFT panels. To avoid having to
                 * check for the LCD device clock everytime we do a mode change,
                 * we set the LCD device clock to the highest rate possible.
                 */
                ret = clk_set_rate(priv->lcd_clk, parent_rate);
                if (ret) {
                        dev_err(dev, "Unable to set LCD clock rate\n");
                        goto err_pixclk_disable;
                }

                ret = clk_prepare_enable(priv->lcd_clk);
                if (ret) {
                        dev_err(dev, "Unable to start lcd clock\n");
                        goto err_pixclk_disable;
                }
        }

        /* Enable OSD if available */
        if (soc_info->has_osd)
                osdc |= JZ_LCD_OSDC_OSDEN;
        if (soc_info->has_alpha)
                osdc |= JZ_LCD_OSDC_ALPHAEN;
        regmap_write(priv->map, JZ_REG_LCD_OSDC, osdc);

        mutex_init(&priv->clk_mutex);
        priv->clock_nb.notifier_call = ingenic_drm_update_pixclk;

        parent_clk = clk_get_parent(priv->pix_clk);
        ret = clk_notifier_register(parent_clk, &priv->clock_nb);
        if (ret) {
                dev_err(dev, "Unable to register clock notifier\n");
                goto err_devclk_disable;
        }

        private_state = kzalloc_obj(*private_state);
        if (!private_state) {
                ret = -ENOMEM;
                goto err_clk_notifier_unregister;
        }

        drm_atomic_private_obj_init(drm, &priv->private_obj, &private_state->base,
                                    &ingenic_drm_private_state_funcs);

        ret = drmm_add_action_or_reset(drm, ingenic_drm_atomic_private_obj_fini,
                                       &priv->private_obj);
        if (ret)
                goto err_private_state_free;

        ret = drm_dev_register(drm, 0);
        if (ret) {
                dev_err(dev, "Failed to register DRM driver\n");
                goto err_clk_notifier_unregister;
        }

        drm_client_setup(drm, NULL);

        return 0;

err_private_state_free:
        kfree(private_state);
err_clk_notifier_unregister:
        clk_notifier_unregister(parent_clk, &priv->clock_nb);
err_devclk_disable:
        if (priv->lcd_clk)
                clk_disable_unprepare(priv->lcd_clk);
err_pixclk_disable:
        clk_disable_unprepare(priv->pix_clk);
err_drvdata:
        platform_set_drvdata(pdev, NULL);
        return ret;
}

static int ingenic_drm_bind_with_components(struct device *dev)
{
        return ingenic_drm_bind(dev, true);
}

static void ingenic_drm_unbind(struct device *dev)
{
        struct ingenic_drm *priv = dev_get_drvdata(dev);
        struct clk *parent_clk = clk_get_parent(priv->pix_clk);

        clk_notifier_unregister(parent_clk, &priv->clock_nb);
        if (priv->lcd_clk)
                clk_disable_unprepare(priv->lcd_clk);
        clk_disable_unprepare(priv->pix_clk);

        drm_dev_unregister(&priv->drm);
        drm_atomic_helper_shutdown(&priv->drm);
        dev_set_drvdata(dev, NULL);
}

static const struct component_master_ops ingenic_master_ops = {
        .bind = ingenic_drm_bind_with_components,
        .unbind = ingenic_drm_unbind,
};

static int ingenic_drm_probe(struct platform_device *pdev)
{
        struct device *dev = &pdev->dev;
        struct component_match *match = NULL;
        struct device_node *np;

        if (!IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
                return ingenic_drm_bind(dev, false);

        /* IPU is at port address 8 */
        np = of_graph_get_remote_node(dev->of_node, 8, 0);
        if (!np)
                return ingenic_drm_bind(dev, false);

        drm_of_component_match_add(dev, &match, component_compare_of, np);
        of_node_put(np);

        return component_master_add_with_match(dev, &ingenic_master_ops, match);
}

static void ingenic_drm_remove(struct platform_device *pdev)
{
        struct device *dev = &pdev->dev;

        if (!IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
                ingenic_drm_unbind(dev);
        else
                component_master_del(dev, &ingenic_master_ops);
}

static void ingenic_drm_shutdown(struct platform_device *pdev)
{
        struct ingenic_drm *priv = platform_get_drvdata(pdev);

        if (priv)
                drm_atomic_helper_shutdown(&priv->drm);
}

static int ingenic_drm_suspend(struct device *dev)
{
        struct ingenic_drm *priv = dev_get_drvdata(dev);

        return drm_mode_config_helper_suspend(&priv->drm);
}

static int ingenic_drm_resume(struct device *dev)
{
        struct ingenic_drm *priv = dev_get_drvdata(dev);

        return drm_mode_config_helper_resume(&priv->drm);
}

static DEFINE_SIMPLE_DEV_PM_OPS(ingenic_drm_pm_ops,
                                ingenic_drm_suspend, ingenic_drm_resume);

static const u32 jz4740_formats[] = {
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_XRGB8888,
};

static const u32 jz4725b_formats_f1[] = {
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_XRGB8888,
};

static const u32 jz4725b_formats_f0[] = {
        DRM_FORMAT_C8,
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_XRGB8888,
};

static const u32 jz4770_formats_f1[] = {
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_XRGB8888,
        DRM_FORMAT_XRGB2101010,
};

static const u32 jz4770_formats_f0[] = {
        DRM_FORMAT_C8,
        DRM_FORMAT_XRGB1555,
        DRM_FORMAT_RGB565,
        DRM_FORMAT_RGB888,
        DRM_FORMAT_XRGB8888,
        DRM_FORMAT_XRGB2101010,
};

static const struct jz_soc_info jz4740_soc_info = {
        .needs_dev_clk = true,
        .has_osd = false,
        .map_noncoherent = false,
        .max_width = 800,
        .max_height = 600,
        .max_burst = JZ_LCD_CTRL_BURST_16,
        .formats_f1 = jz4740_formats,
        .num_formats_f1 = ARRAY_SIZE(jz4740_formats),
        /* JZ4740 has only one plane */
};

static const struct jz_soc_info jz4725b_soc_info = {
        .needs_dev_clk = false,
        .has_osd = true,
        .map_noncoherent = false,
        .max_width = 800,
        .max_height = 600,
        .max_burst = JZ_LCD_CTRL_BURST_16,
        .formats_f1 = jz4725b_formats_f1,
        .num_formats_f1 = ARRAY_SIZE(jz4725b_formats_f1),
        .formats_f0 = jz4725b_formats_f0,
        .num_formats_f0 = ARRAY_SIZE(jz4725b_formats_f0),
};

static const struct jz_soc_info jz4760_soc_info = {
        .needs_dev_clk = false,
        .has_osd = true,
        .map_noncoherent = false,
        .max_width = 1280,
        .max_height = 720,
        .max_burst = JZ_LCD_CTRL_BURST_32,
        .formats_f1 = jz4770_formats_f1,
        .num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
        .formats_f0 = jz4770_formats_f0,
        .num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
};

static const struct jz_soc_info jz4760b_soc_info = {
        .needs_dev_clk = false,
        .has_osd = true,
        .map_noncoherent = false,
        .max_width = 1280,
        .max_height = 720,
        .max_burst = JZ_LCD_CTRL_BURST_64,
        .formats_f1 = jz4770_formats_f1,
        .num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
        .formats_f0 = jz4770_formats_f0,
        .num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
};

static const struct jz_soc_info jz4770_soc_info = {
        .needs_dev_clk = false,
        .has_osd = true,
        .map_noncoherent = true,
        .max_width = 1280,
        .max_height = 720,
        .max_burst = JZ_LCD_CTRL_BURST_64,
        .formats_f1 = jz4770_formats_f1,
        .num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
        .formats_f0 = jz4770_formats_f0,
        .num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
};

static const struct jz_soc_info jz4780_soc_info = {
        .needs_dev_clk = true,
        .has_osd = true,
        .has_alpha = true,
        .use_extended_hwdesc = true,
        .plane_f0_not_working = true,   /* REVISIT */
        .max_width = 4096,
        .max_height = 2048,
        .max_burst = JZ_LCD_CTRL_BURST_64,
        .formats_f1 = jz4770_formats_f1,
        .num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
        .formats_f0 = jz4770_formats_f0,
        .num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
};

static const struct of_device_id ingenic_drm_of_match[] = {
        { .compatible = "ingenic,jz4740-lcd", .data = &jz4740_soc_info },
        { .compatible = "ingenic,jz4725b-lcd", .data = &jz4725b_soc_info },
        { .compatible = "ingenic,jz4760-lcd", .data = &jz4760_soc_info },
        { .compatible = "ingenic,jz4760b-lcd", .data = &jz4760b_soc_info },
        { .compatible = "ingenic,jz4770-lcd", .data = &jz4770_soc_info },
        { .compatible = "ingenic,jz4780-lcd", .data = &jz4780_soc_info },
        { /* sentinel */ },
};
MODULE_DEVICE_TABLE(of, ingenic_drm_of_match);

static struct platform_driver ingenic_drm_driver = {
        .driver = {
                .name = "ingenic-drm",
                .pm = pm_sleep_ptr(&ingenic_drm_pm_ops),
                .of_match_table = of_match_ptr(ingenic_drm_of_match),
        },
        .probe = ingenic_drm_probe,
        .remove = ingenic_drm_remove,
        .shutdown = ingenic_drm_shutdown,
};

static int ingenic_drm_init(void)
{
        int err;

        if (drm_firmware_drivers_only())
                return -ENODEV;

        if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU)) {
                err = platform_driver_register(ingenic_ipu_driver_ptr);
                if (err)
                        return err;
        }

        err = platform_driver_register(&ingenic_drm_driver);
        if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && err)
                platform_driver_unregister(ingenic_ipu_driver_ptr);

        return err;
}
module_init(ingenic_drm_init);

static void ingenic_drm_exit(void)
{
        platform_driver_unregister(&ingenic_drm_driver);

        if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
                platform_driver_unregister(ingenic_ipu_driver_ptr);
}
module_exit(ingenic_drm_exit);

MODULE_AUTHOR("Paul Cercueil <paul@crapouillou.net>");
MODULE_DESCRIPTION("DRM driver for the Ingenic SoCs\n");
MODULE_LICENSE("GPL");