// SPDX-License-Identifier: GPL-2.0-only
/*
 * linux/drivers/video/omap2/dss/dss.c
 *
 * Copyright (C) 2009 Nokia Corporation
 * Author: Tomi Valkeinen <tomi.valkeinen@nokia.com>
 *
 * Some code and ideas taken from drivers/video/omap/ driver
 * by Imre Deak.
 */

#define DSS_SUBSYS_NAME "DSS"

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/io.h>
#include <linux/export.h>
#include <linux/err.h>
#include <linux/delay.h>
#include <linux/seq_file.h>
#include <linux/clk.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/gfp.h>
#include <linux/sizes.h>
#include <linux/mfd/syscon.h>
#include <linux/regmap.h>
#include <linux/of.h>
#include <linux/regulator/consumer.h>
#include <linux/suspend.h>
#include <linux/component.h>
#include <linux/pinctrl/consumer.h>

#include <video/omapfb_dss.h>

#include "dss.h"
#include "dss_features.h"

#define DSS_SZ_REGS                     SZ_512

struct dss_reg {
        u16 idx;
};

#define DSS_REG(idx)                    ((const struct dss_reg) { idx })

#define DSS_REVISION                    DSS_REG(0x0000)
#define DSS_SYSCONFIG                   DSS_REG(0x0010)
#define DSS_SYSSTATUS                   DSS_REG(0x0014)
#define DSS_CONTROL                     DSS_REG(0x0040)
#define DSS_SDI_CONTROL                 DSS_REG(0x0044)
#define DSS_PLL_CONTROL                 DSS_REG(0x0048)
#define DSS_SDI_STATUS                  DSS_REG(0x005C)

#define REG_GET(idx, start, end) \
        FLD_GET(dss_read_reg(idx), start, end)

#define REG_FLD_MOD(idx, val, start, end) \
        dss_write_reg(idx, FLD_MOD(dss_read_reg(idx), val, start, end))

struct dss_features {
        u8 fck_div_max;
        u8 dss_fck_multiplier;
        const char *parent_clk_name;
        const enum omap_display_type *ports;
        int num_ports;
        int (*dpi_select_source)(int port, enum omap_channel channel);
};

static struct {
        struct platform_device *pdev;
        void __iomem    *base;
        struct regmap   *syscon_pll_ctrl;
        u32             syscon_pll_ctrl_offset;

        struct clk      *parent_clk;
        struct clk      *dss_clk;
        unsigned long   dss_clk_rate;

        unsigned long   cache_req_pck;
        unsigned long   cache_prate;
        struct dispc_clock_info cache_dispc_cinfo;

        enum omap_dss_clk_source dsi_clk_source[MAX_NUM_DSI];
        enum omap_dss_clk_source dispc_clk_source;
        enum omap_dss_clk_source lcd_clk_source[MAX_DSS_LCD_MANAGERS];

        bool            ctx_valid;
        u32             ctx[DSS_SZ_REGS / sizeof(u32)];

        const struct dss_features *feat;

        struct dss_pll  *video1_pll;
        struct dss_pll  *video2_pll;
} dss;

static const char * const dss_generic_clk_source_names[] = {
        [OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DISPC]  = "DSI_PLL_HSDIV_DISPC",
        [OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DSI]    = "DSI_PLL_HSDIV_DSI",
        [OMAP_DSS_CLK_SRC_FCK]                  = "DSS_FCK",
        [OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DISPC] = "DSI_PLL2_HSDIV_DISPC",
        [OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DSI]   = "DSI_PLL2_HSDIV_DSI",
};

static bool dss_initialized;

bool omapdss_is_initialized(void)
{
        return dss_initialized;
}
EXPORT_SYMBOL(omapdss_is_initialized);

static inline void dss_write_reg(const struct dss_reg idx, u32 val)
{
        __raw_writel(val, dss.base + idx.idx);
}

static inline u32 dss_read_reg(const struct dss_reg idx)
{
        return __raw_readl(dss.base + idx.idx);
}

#define SR(reg) \
        dss.ctx[(DSS_##reg).idx / sizeof(u32)] = dss_read_reg(DSS_##reg)
#define RR(reg) \
        dss_write_reg(DSS_##reg, dss.ctx[(DSS_##reg).idx / sizeof(u32)])

static void dss_save_context(void)
{
        DSSDBG("dss_save_context\n");

        SR(CONTROL);

        if (dss_feat_get_supported_displays(OMAP_DSS_CHANNEL_LCD) &
                        OMAP_DISPLAY_TYPE_SDI) {
                SR(SDI_CONTROL);
                SR(PLL_CONTROL);
        }

        dss.ctx_valid = true;

        DSSDBG("context saved\n");
}

static void dss_restore_context(void)
{
        DSSDBG("dss_restore_context\n");

        if (!dss.ctx_valid)
                return;

        RR(CONTROL);

        if (dss_feat_get_supported_displays(OMAP_DSS_CHANNEL_LCD) &
                        OMAP_DISPLAY_TYPE_SDI) {
                RR(SDI_CONTROL);
                RR(PLL_CONTROL);
        }

        DSSDBG("context restored\n");
}

#undef SR
#undef RR

void dss_ctrl_pll_enable(enum dss_pll_id pll_id, bool enable)
{
        unsigned shift;
        unsigned val;

        if (!dss.syscon_pll_ctrl)
                return;

        val = !enable;

        switch (pll_id) {
        case DSS_PLL_VIDEO1:
                shift = 0;
                break;
        case DSS_PLL_VIDEO2:
                shift = 1;
                break;
        case DSS_PLL_HDMI:
                shift = 2;
                break;
        default:
                DSSERR("illegal DSS PLL ID %d\n", pll_id);
                return;
        }

        regmap_update_bits(dss.syscon_pll_ctrl, dss.syscon_pll_ctrl_offset,
                1 << shift, val << shift);
}

void dss_ctrl_pll_set_control_mux(enum dss_pll_id pll_id,
        enum omap_channel channel)
{
        unsigned shift, val;

        if (!dss.syscon_pll_ctrl)
                return;

        switch (channel) {
        case OMAP_DSS_CHANNEL_LCD:
                shift = 3;

                switch (pll_id) {
                case DSS_PLL_VIDEO1:
                        val = 0; break;
                case DSS_PLL_HDMI:
                        val = 1; break;
                default:
                        DSSERR("error in PLL mux config for LCD\n");
                        return;
                }

                break;
        case OMAP_DSS_CHANNEL_LCD2:
                shift = 5;

                switch (pll_id) {
                case DSS_PLL_VIDEO1:
                        val = 0; break;
                case DSS_PLL_VIDEO2:
                        val = 1; break;
                case DSS_PLL_HDMI:
                        val = 2; break;
                default:
                        DSSERR("error in PLL mux config for LCD2\n");
                        return;
                }

                break;
        case OMAP_DSS_CHANNEL_LCD3:
                shift = 7;

                switch (pll_id) {
                case DSS_PLL_VIDEO1:
                        val = 1; break;
                case DSS_PLL_VIDEO2:
                        val = 0; break;
                case DSS_PLL_HDMI:
                        val = 2; break;
                default:
                        DSSERR("error in PLL mux config for LCD3\n");
                        return;
                }

                break;
        default:
                DSSERR("error in PLL mux config\n");
                return;
        }

        regmap_update_bits(dss.syscon_pll_ctrl, dss.syscon_pll_ctrl_offset,
                0x3 << shift, val << shift);
}

void dss_sdi_init(int datapairs)
{
        u32 l;

        BUG_ON(datapairs > 3 || datapairs < 1);

        l = dss_read_reg(DSS_SDI_CONTROL);
        l = FLD_MOD(l, 0xf, 19, 15);            /* SDI_PDIV */
        l = FLD_MOD(l, datapairs-1, 3, 2);      /* SDI_PRSEL */
        l = FLD_MOD(l, 2, 1, 0);                /* SDI_BWSEL */
        dss_write_reg(DSS_SDI_CONTROL, l);

        l = dss_read_reg(DSS_PLL_CONTROL);
        l = FLD_MOD(l, 0x7, 25, 22);    /* SDI_PLL_FREQSEL */
        l = FLD_MOD(l, 0xb, 16, 11);    /* SDI_PLL_REGN */
        l = FLD_MOD(l, 0xb4, 10, 1);    /* SDI_PLL_REGM */
        dss_write_reg(DSS_PLL_CONTROL, l);
}

int dss_sdi_enable(void)
{
        unsigned long timeout;

        dispc_pck_free_enable(1);

        /* Reset SDI PLL */
        REG_FLD_MOD(DSS_PLL_CONTROL, 1, 18, 18); /* SDI_PLL_SYSRESET */
        udelay(1);      /* wait 2x PCLK */

        /* Lock SDI PLL */
        REG_FLD_MOD(DSS_PLL_CONTROL, 1, 28, 28); /* SDI_PLL_GOBIT */

        /* Waiting for PLL lock request to complete */
        timeout = jiffies + msecs_to_jiffies(500);
        while (dss_read_reg(DSS_SDI_STATUS) & (1 << 6)) {
                if (time_after_eq(jiffies, timeout)) {
                        DSSERR("PLL lock request timed out\n");
                        goto err1;
                }
        }

        /* Clearing PLL_GO bit */
        REG_FLD_MOD(DSS_PLL_CONTROL, 0, 28, 28);

        /* Waiting for PLL to lock */
        timeout = jiffies + msecs_to_jiffies(500);
        while (!(dss_read_reg(DSS_SDI_STATUS) & (1 << 5))) {
                if (time_after_eq(jiffies, timeout)) {
                        DSSERR("PLL lock timed out\n");
                        goto err1;
                }
        }

        dispc_lcd_enable_signal(1);

        /* Waiting for SDI reset to complete */
        timeout = jiffies + msecs_to_jiffies(500);
        while (!(dss_read_reg(DSS_SDI_STATUS) & (1 << 2))) {
                if (time_after_eq(jiffies, timeout)) {
                        DSSERR("SDI reset timed out\n");
                        goto err2;
                }
        }

        return 0;

 err2:
        dispc_lcd_enable_signal(0);
 err1:
        /* Reset SDI PLL */
        REG_FLD_MOD(DSS_PLL_CONTROL, 0, 18, 18); /* SDI_PLL_SYSRESET */

        dispc_pck_free_enable(0);

        return -ETIMEDOUT;
}

void dss_sdi_disable(void)
{
        dispc_lcd_enable_signal(0);

        dispc_pck_free_enable(0);

        /* Reset SDI PLL */
        REG_FLD_MOD(DSS_PLL_CONTROL, 0, 18, 18); /* SDI_PLL_SYSRESET */
}

const char *dss_get_generic_clk_source_name(enum omap_dss_clk_source clk_src)
{
        return dss_generic_clk_source_names[clk_src];
}

void dss_dump_clocks(struct seq_file *s)
{
        const char *fclk_name, *fclk_real_name;
        unsigned long fclk_rate;

        if (dss_runtime_get())
                return;

        seq_printf(s, "- DSS -\n");

        fclk_name = dss_get_generic_clk_source_name(OMAP_DSS_CLK_SRC_FCK);
        fclk_real_name = dss_feat_get_clk_source_name(OMAP_DSS_CLK_SRC_FCK);
        fclk_rate = clk_get_rate(dss.dss_clk);

        seq_printf(s, "%s (%s) = %lu\n",
                        fclk_name, fclk_real_name,
                        fclk_rate);

        dss_runtime_put();
}

static void dss_dump_regs(struct seq_file *s)
{
#define DUMPREG(r) seq_printf(s, "%-35s %08x\n", #r, dss_read_reg(r))

        if (dss_runtime_get())
                return;

        DUMPREG(DSS_REVISION);
        DUMPREG(DSS_SYSCONFIG);
        DUMPREG(DSS_SYSSTATUS);
        DUMPREG(DSS_CONTROL);

        if (dss_feat_get_supported_displays(OMAP_DSS_CHANNEL_LCD) &
                        OMAP_DISPLAY_TYPE_SDI) {
                DUMPREG(DSS_SDI_CONTROL);
                DUMPREG(DSS_PLL_CONTROL);
                DUMPREG(DSS_SDI_STATUS);
        }

        dss_runtime_put();
#undef DUMPREG
}

static void dss_select_dispc_clk_source(enum omap_dss_clk_source clk_src)
{
        int b;
        u8 start, end;

        switch (clk_src) {
        case OMAP_DSS_CLK_SRC_FCK:
                b = 0;
                break;
        case OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DISPC:
                b = 1;
                break;
        case OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DISPC:
                b = 2;
                break;
        default:
                BUG();
                return;
        }

        dss_feat_get_reg_field(FEAT_REG_DISPC_CLK_SWITCH, &start, &end);

        REG_FLD_MOD(DSS_CONTROL, b, start, end);        /* DISPC_CLK_SWITCH */

        dss.dispc_clk_source = clk_src;
}

void dss_select_dsi_clk_source(int dsi_module,
                enum omap_dss_clk_source clk_src)
{
        int b, pos;

        switch (clk_src) {
        case OMAP_DSS_CLK_SRC_FCK:
                b = 0;
                break;
        case OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DSI:
                BUG_ON(dsi_module != 0);
                b = 1;
                break;
        case OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DSI:
                BUG_ON(dsi_module != 1);
                b = 1;
                break;
        default:
                BUG();
                return;
        }

        pos = dsi_module == 0 ? 1 : 10;
        REG_FLD_MOD(DSS_CONTROL, b, pos, pos);  /* DSIx_CLK_SWITCH */

        dss.dsi_clk_source[dsi_module] = clk_src;
}

void dss_select_lcd_clk_source(enum omap_channel channel,
                enum omap_dss_clk_source clk_src)
{
        int b, ix, pos;

        if (!dss_has_feature(FEAT_LCD_CLK_SRC)) {
                dss_select_dispc_clk_source(clk_src);
                return;
        }

        switch (clk_src) {
        case OMAP_DSS_CLK_SRC_FCK:
                b = 0;
                break;
        case OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DISPC:
                BUG_ON(channel != OMAP_DSS_CHANNEL_LCD);
                b = 1;
                break;
        case OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DISPC:
                BUG_ON(channel != OMAP_DSS_CHANNEL_LCD2 &&
                       channel != OMAP_DSS_CHANNEL_LCD3);
                b = 1;
                break;
        default:
                BUG();
                return;
        }

        pos = channel == OMAP_DSS_CHANNEL_LCD ? 0 :
             (channel == OMAP_DSS_CHANNEL_LCD2 ? 12 : 19);
        REG_FLD_MOD(DSS_CONTROL, b, pos, pos);  /* LCDx_CLK_SWITCH */

        ix = channel == OMAP_DSS_CHANNEL_LCD ? 0 :
            (channel == OMAP_DSS_CHANNEL_LCD2 ? 1 : 2);
        dss.lcd_clk_source[ix] = clk_src;
}

enum omap_dss_clk_source dss_get_dispc_clk_source(void)
{
        return dss.dispc_clk_source;
}

enum omap_dss_clk_source dss_get_dsi_clk_source(int dsi_module)
{
        return dss.dsi_clk_source[dsi_module];
}

enum omap_dss_clk_source dss_get_lcd_clk_source(enum omap_channel channel)
{
        if (dss_has_feature(FEAT_LCD_CLK_SRC)) {
                int ix = channel == OMAP_DSS_CHANNEL_LCD ? 0 :
                        (channel == OMAP_DSS_CHANNEL_LCD2 ? 1 : 2);
                return dss.lcd_clk_source[ix];
        } else {
                /* LCD_CLK source is the same as DISPC_FCLK source for
                 * OMAP2 and OMAP3 */
                return dss.dispc_clk_source;
        }
}

bool dss_div_calc(unsigned long pck, unsigned long fck_min,
                dss_div_calc_func func, void *data)
{
        int fckd, fckd_start, fckd_stop;
        unsigned long fck;
        unsigned long fck_hw_max;
        unsigned long fckd_hw_max;
        unsigned long prate;
        unsigned m;

        fck_hw_max = dss_feat_get_param_max(FEAT_PARAM_DSS_FCK);

        if (dss.parent_clk == NULL) {
                unsigned pckd;

                pckd = fck_hw_max / pck;

                fck = pck * pckd;

                fck = clk_round_rate(dss.dss_clk, fck);

                return func(fck, data);
        }

        fckd_hw_max = dss.feat->fck_div_max;

        m = dss.feat->dss_fck_multiplier;
        prate = clk_get_rate(dss.parent_clk);

        fck_min = fck_min ? fck_min : 1;

        fckd_start = min(prate * m / fck_min, fckd_hw_max);
        fckd_stop = max(DIV_ROUND_UP(prate * m, fck_hw_max), 1ul);

        for (fckd = fckd_start; fckd >= fckd_stop; --fckd) {
                fck = DIV_ROUND_UP(prate, fckd) * m;

                if (func(fck, data))
                        return true;
        }

        return false;
}

int dss_set_fck_rate(unsigned long rate)
{
        int r;

        DSSDBG("set fck to %lu\n", rate);

        r = clk_set_rate(dss.dss_clk, rate);
        if (r)
                return r;

        dss.dss_clk_rate = clk_get_rate(dss.dss_clk);

        WARN_ONCE(dss.dss_clk_rate != rate,
                        "clk rate mismatch: %lu != %lu", dss.dss_clk_rate,
                        rate);

        return 0;
}

unsigned long dss_get_dispc_clk_rate(void)
{
        return dss.dss_clk_rate;
}

static int dss_setup_default_clock(void)
{
        unsigned long max_dss_fck, prate;
        unsigned long fck;
        unsigned fck_div;
        int r;

        max_dss_fck = dss_feat_get_param_max(FEAT_PARAM_DSS_FCK);

        if (dss.parent_clk == NULL) {
                fck = clk_round_rate(dss.dss_clk, max_dss_fck);
        } else {
                prate = clk_get_rate(dss.parent_clk);

                fck_div = DIV_ROUND_UP(prate * dss.feat->dss_fck_multiplier,
                                max_dss_fck);
                fck = DIV_ROUND_UP(prate, fck_div) * dss.feat->dss_fck_multiplier;
        }

        r = dss_set_fck_rate(fck);
        if (r)
                return r;

        return 0;
}

void dss_set_venc_output(enum omap_dss_venc_type type)
{
        int l = 0;

        if (type == OMAP_DSS_VENC_TYPE_COMPOSITE)
                l = 0;
        else if (type == OMAP_DSS_VENC_TYPE_SVIDEO)
                l = 1;
        else
                BUG();

        /* venc out selection. 0 = comp, 1 = svideo */
        REG_FLD_MOD(DSS_CONTROL, l, 6, 6);
}

void dss_set_dac_pwrdn_bgz(bool enable)
{
        REG_FLD_MOD(DSS_CONTROL, enable, 5, 5); /* DAC Power-Down Control */
}

void dss_select_hdmi_venc_clk_source(enum dss_hdmi_venc_clk_source_select src)
{
        enum omap_display_type dp;
        dp = dss_feat_get_supported_displays(OMAP_DSS_CHANNEL_DIGIT);

        /* Complain about invalid selections */
        WARN_ON((src == DSS_VENC_TV_CLK) && !(dp & OMAP_DISPLAY_TYPE_VENC));
        WARN_ON((src == DSS_HDMI_M_PCLK) && !(dp & OMAP_DISPLAY_TYPE_HDMI));

        /* Select only if we have options */
        if ((dp & OMAP_DISPLAY_TYPE_VENC) && (dp & OMAP_DISPLAY_TYPE_HDMI))
                REG_FLD_MOD(DSS_CONTROL, src, 15, 15);  /* VENC_HDMI_SWITCH */
}

enum dss_hdmi_venc_clk_source_select dss_get_hdmi_venc_clk_source(void)
{
        enum omap_display_type displays;

        displays = dss_feat_get_supported_displays(OMAP_DSS_CHANNEL_DIGIT);
        if ((displays & OMAP_DISPLAY_TYPE_HDMI) == 0)
                return DSS_VENC_TV_CLK;

        if ((displays & OMAP_DISPLAY_TYPE_VENC) == 0)
                return DSS_HDMI_M_PCLK;

        return REG_GET(DSS_CONTROL, 15, 15);
}

static int dss_dpi_select_source_omap2_omap3(int port, enum omap_channel channel)
{
        if (channel != OMAP_DSS_CHANNEL_LCD)
                return -EINVAL;

        return 0;
}

static int dss_dpi_select_source_omap4(int port, enum omap_channel channel)
{
        int val;

        switch (channel) {
        case OMAP_DSS_CHANNEL_LCD2:
                val = 0;
                break;
        case OMAP_DSS_CHANNEL_DIGIT:
                val = 1;
                break;
        default:
                return -EINVAL;
        }

        REG_FLD_MOD(DSS_CONTROL, val, 17, 17);

        return 0;
}

static int dss_dpi_select_source_omap5(int port, enum omap_channel channel)
{
        int val;

        switch (channel) {
        case OMAP_DSS_CHANNEL_LCD:
                val = 1;
                break;
        case OMAP_DSS_CHANNEL_LCD2:
                val = 2;
                break;
        case OMAP_DSS_CHANNEL_LCD3:
                val = 3;
                break;
        case OMAP_DSS_CHANNEL_DIGIT:
                val = 0;
                break;
        default:
                return -EINVAL;
        }

        REG_FLD_MOD(DSS_CONTROL, val, 17, 16);

        return 0;
}

static int dss_dpi_select_source_dra7xx(int port, enum omap_channel channel)
{
        switch (port) {
        case 0:
                return dss_dpi_select_source_omap5(port, channel);
        case 1:
                if (channel != OMAP_DSS_CHANNEL_LCD2)
                        return -EINVAL;
                break;
        case 2:
                if (channel != OMAP_DSS_CHANNEL_LCD3)
                        return -EINVAL;
                break;
        default:
                return -EINVAL;
        }

        return 0;
}

int dss_dpi_select_source(int port, enum omap_channel channel)
{
        return dss.feat->dpi_select_source(port, channel);
}

static int dss_get_clocks(void)
{
        struct clk *clk;

        clk = devm_clk_get(&dss.pdev->dev, "fck");
        if (IS_ERR(clk)) {
                DSSERR("can't get clock fck\n");
                return PTR_ERR(clk);
        }

        dss.dss_clk = clk;

        if (dss.feat->parent_clk_name) {
                clk = clk_get(NULL, dss.feat->parent_clk_name);
                if (IS_ERR(clk)) {
                        DSSERR("Failed to get %s\n", dss.feat->parent_clk_name);
                        return PTR_ERR(clk);
                }
        } else {
                clk = NULL;
        }

        dss.parent_clk = clk;

        return 0;
}

static void dss_put_clocks(void)
{
        if (dss.parent_clk)
                clk_put(dss.parent_clk);
}

int dss_runtime_get(void)
{
        int r;

        DSSDBG("dss_runtime_get\n");

        r = pm_runtime_get_sync(&dss.pdev->dev);
        if (WARN_ON(r < 0)) {
                pm_runtime_put_sync(&dss.pdev->dev);
                return r;
        }
        return 0;
}

void dss_runtime_put(void)
{
        int r;

        DSSDBG("dss_runtime_put\n");

        r = pm_runtime_put_sync(&dss.pdev->dev);
        WARN_ON(r < 0 && r != -ENOSYS && r != -EBUSY);
}

/* DEBUGFS */
#if defined(CONFIG_FB_OMAP2_DSS_DEBUGFS)
void dss_debug_dump_clocks(struct seq_file *s)
{
        dss_dump_clocks(s);
        dispc_dump_clocks(s);
#ifdef CONFIG_FB_OMAP2_DSS_DSI
        dsi_dump_clocks(s);
#endif
}
#endif


static const enum omap_display_type omap2plus_ports[] = {
        OMAP_DISPLAY_TYPE_DPI,
};

static const enum omap_display_type omap34xx_ports[] = {
        OMAP_DISPLAY_TYPE_DPI,
        OMAP_DISPLAY_TYPE_SDI,
};

static const enum omap_display_type dra7xx_ports[] = {
        OMAP_DISPLAY_TYPE_DPI,
        OMAP_DISPLAY_TYPE_DPI,
        OMAP_DISPLAY_TYPE_DPI,
};

static const struct dss_features omap24xx_dss_feats = {
        /*
         * fck div max is really 16, but the divider range has gaps. The range
         * from 1 to 6 has no gaps, so let's use that as a max.
         */
        .fck_div_max            =       6,
        .dss_fck_multiplier     =       2,
        .parent_clk_name        =       "core_ck",
        .dpi_select_source      =       &dss_dpi_select_source_omap2_omap3,
        .ports                  =       omap2plus_ports,
        .num_ports              =       ARRAY_SIZE(omap2plus_ports),
};

static const struct dss_features omap34xx_dss_feats = {
        .fck_div_max            =       16,
        .dss_fck_multiplier     =       2,
        .parent_clk_name        =       "dpll4_ck",
        .dpi_select_source      =       &dss_dpi_select_source_omap2_omap3,
        .ports                  =       omap34xx_ports,
        .num_ports              =       ARRAY_SIZE(omap34xx_ports),
};

static const struct dss_features omap3630_dss_feats = {
        .fck_div_max            =       31,
        .dss_fck_multiplier     =       1,
        .parent_clk_name        =       "dpll4_ck",
        .dpi_select_source      =       &dss_dpi_select_source_omap2_omap3,
        .ports                  =       omap2plus_ports,
        .num_ports              =       ARRAY_SIZE(omap2plus_ports),
};

static const struct dss_features omap44xx_dss_feats = {
        .fck_div_max            =       32,
        .dss_fck_multiplier     =       1,
        .parent_clk_name        =       "dpll_per_x2_ck",
        .dpi_select_source      =       &dss_dpi_select_source_omap4,
        .ports                  =       omap2plus_ports,
        .num_ports              =       ARRAY_SIZE(omap2plus_ports),
};

static const struct dss_features omap54xx_dss_feats = {
        .fck_div_max            =       64,
        .dss_fck_multiplier     =       1,
        .parent_clk_name        =       "dpll_per_x2_ck",
        .dpi_select_source      =       &dss_dpi_select_source_omap5,
        .ports                  =       omap2plus_ports,
        .num_ports              =       ARRAY_SIZE(omap2plus_ports),
};

static const struct dss_features am43xx_dss_feats = {
        .fck_div_max            =       0,
        .dss_fck_multiplier     =       0,
        .parent_clk_name        =       NULL,
        .dpi_select_source      =       &dss_dpi_select_source_omap2_omap3,
        .ports                  =       omap2plus_ports,
        .num_ports              =       ARRAY_SIZE(omap2plus_ports),
};

static const struct dss_features dra7xx_dss_feats = {
        .fck_div_max            =       64,
        .dss_fck_multiplier     =       1,
        .parent_clk_name        =       "dpll_per_x2_ck",
        .dpi_select_source      =       &dss_dpi_select_source_dra7xx,
        .ports                  =       dra7xx_ports,
        .num_ports              =       ARRAY_SIZE(dra7xx_ports),
};

static const struct dss_features *dss_get_features(void)
{
        switch (omapdss_get_version()) {
        case OMAPDSS_VER_OMAP24xx:
                return &omap24xx_dss_feats;

        case OMAPDSS_VER_OMAP34xx_ES1:
        case OMAPDSS_VER_OMAP34xx_ES3:
        case OMAPDSS_VER_AM35xx:
                return &omap34xx_dss_feats;

        case OMAPDSS_VER_OMAP3630:
                return &omap3630_dss_feats;

        case OMAPDSS_VER_OMAP4430_ES1:
        case OMAPDSS_VER_OMAP4430_ES2:
        case OMAPDSS_VER_OMAP4:
                return &omap44xx_dss_feats;

        case OMAPDSS_VER_OMAP5:
                return &omap54xx_dss_feats;

        case OMAPDSS_VER_AM43xx:
                return &am43xx_dss_feats;

        case OMAPDSS_VER_DRA7xx:
                return &dra7xx_dss_feats;

        default:
                return NULL;
        }
}

static void dss_uninit_ports(struct platform_device *pdev);

static int dss_init_ports(struct platform_device *pdev)
{
        struct device_node *parent = pdev->dev.of_node;
        struct device_node *port;
        int r, ret = 0;

        if (parent == NULL)
                return 0;

        port = omapdss_of_get_next_port(parent, NULL);
        if (!port)
                return 0;

        if (dss.feat->num_ports == 0)
                return 0;

        do {
                enum omap_display_type port_type;
                u32 reg;

                r = of_property_read_u32(port, "reg", &reg);
                if (r)
                        reg = 0;

                if (reg >= dss.feat->num_ports)
                        continue;

                port_type = dss.feat->ports[reg];

                switch (port_type) {
                case OMAP_DISPLAY_TYPE_DPI:
                        ret = dpi_init_port(pdev, port);
                        break;
                case OMAP_DISPLAY_TYPE_SDI:
                        ret = sdi_init_port(pdev, port);
                        break;
                default:
                        break;
                }
        } while (!ret &&
                 (port = omapdss_of_get_next_port(parent, port)) != NULL);

        if (ret)
                dss_uninit_ports(pdev);

        return ret;
}

static void dss_uninit_ports(struct platform_device *pdev)
{
        struct device_node *parent = pdev->dev.of_node;
        struct device_node *port;

        if (parent == NULL)
                return;

        port = omapdss_of_get_next_port(parent, NULL);
        if (!port)
                return;

        if (dss.feat->num_ports == 0)
                return;

        do {
                enum omap_display_type port_type;
                u32 reg;
                int r;

                r = of_property_read_u32(port, "reg", &reg);
                if (r)
                        reg = 0;

                if (reg >= dss.feat->num_ports)
                        continue;

                port_type = dss.feat->ports[reg];

                switch (port_type) {
                case OMAP_DISPLAY_TYPE_DPI:
                        dpi_uninit_port(port);
                        break;
                case OMAP_DISPLAY_TYPE_SDI:
                        sdi_uninit_port(port);

                        break;
                default:
                        break;
                }
        } while ((port = omapdss_of_get_next_port(parent, port)) != NULL);
}

static int dss_video_pll_probe(struct platform_device *pdev)
{
        struct device_node *np = pdev->dev.of_node;
        struct regulator *pll_regulator;
        int r;

        if (!np)
                return 0;

        if (of_property_read_bool(np, "syscon-pll-ctrl")) {
                dss.syscon_pll_ctrl = syscon_regmap_lookup_by_phandle(np,
                        "syscon-pll-ctrl");
                if (IS_ERR(dss.syscon_pll_ctrl)) {
                        dev_err(&pdev->dev,
                                "failed to get syscon-pll-ctrl regmap\n");
                        return PTR_ERR(dss.syscon_pll_ctrl);
                }

                if (of_property_read_u32_index(np, "syscon-pll-ctrl", 1,
                                &dss.syscon_pll_ctrl_offset)) {
                        dev_err(&pdev->dev,
                                "failed to get syscon-pll-ctrl offset\n");
                        return -EINVAL;
                }
        }

        pll_regulator = devm_regulator_get(&pdev->dev, "vdda_video");
        if (IS_ERR(pll_regulator)) {
                r = PTR_ERR(pll_regulator);

                switch (r) {
                case -ENOENT:
                        pll_regulator = NULL;
                        break;

                case -EPROBE_DEFER:
                        return -EPROBE_DEFER;

                default:
                        DSSERR("can't get DPLL VDDA regulator\n");
                        return r;
                }
        }

        if (of_property_match_string(np, "reg-names", "pll1") >= 0) {
                dss.video1_pll = dss_video_pll_init(pdev, 0, pll_regulator);
                if (IS_ERR(dss.video1_pll))
                        return PTR_ERR(dss.video1_pll);
        }

        if (of_property_match_string(np, "reg-names", "pll2") >= 0) {
                dss.video2_pll = dss_video_pll_init(pdev, 1, pll_regulator);
                if (IS_ERR(dss.video2_pll)) {
                        dss_video_pll_uninit(dss.video1_pll);
                        return PTR_ERR(dss.video2_pll);
                }
        }

        return 0;
}

/* DSS HW IP initialisation */
static int dss_bind(struct device *dev)
{
        struct platform_device *pdev = to_platform_device(dev);
        struct resource *dss_mem;
        u32 rev;
        int r;

        dss.pdev = pdev;

        dss.feat = dss_get_features();
        if (!dss.feat)
                return -ENODEV;

        dss_mem = platform_get_resource(dss.pdev, IORESOURCE_MEM, 0);
        if (!dss_mem) {
                DSSERR("can't get IORESOURCE_MEM DSS\n");
                return -EINVAL;
        }

        dss.base = devm_ioremap(&pdev->dev, dss_mem->start,
                                resource_size(dss_mem));
        if (!dss.base) {
                DSSERR("can't ioremap DSS\n");
                return -ENOMEM;
        }

        r = dss_get_clocks();
        if (r)
                return r;

        r = dss_setup_default_clock();
        if (r)
                goto err_setup_clocks;

        r = dss_video_pll_probe(pdev);
        if (r)
                goto err_pll_init;

        r = dss_init_ports(pdev);
        if (r)
                goto err_init_ports;

        pm_runtime_enable(&pdev->dev);

        r = dss_runtime_get();
        if (r)
                goto err_runtime_get;

        dss.dss_clk_rate = clk_get_rate(dss.dss_clk);

        /* Select DPLL */
        REG_FLD_MOD(DSS_CONTROL, 0, 0, 0);

        dss_select_dispc_clk_source(OMAP_DSS_CLK_SRC_FCK);

#ifdef CONFIG_FB_OMAP2_DSS_VENC
        REG_FLD_MOD(DSS_CONTROL, 1, 4, 4);      /* venc dac demen */
        REG_FLD_MOD(DSS_CONTROL, 1, 3, 3);      /* venc clock 4x enable */
        REG_FLD_MOD(DSS_CONTROL, 0, 2, 2);      /* venc clock mode = normal */
#endif
        dss.dsi_clk_source[0] = OMAP_DSS_CLK_SRC_FCK;
        dss.dsi_clk_source[1] = OMAP_DSS_CLK_SRC_FCK;
        dss.dispc_clk_source = OMAP_DSS_CLK_SRC_FCK;
        dss.lcd_clk_source[0] = OMAP_DSS_CLK_SRC_FCK;
        dss.lcd_clk_source[1] = OMAP_DSS_CLK_SRC_FCK;

        rev = dss_read_reg(DSS_REVISION);
        printk(KERN_INFO "OMAP DSS rev %d.%d\n",
                        FLD_GET(rev, 7, 4), FLD_GET(rev, 3, 0));

        dss_runtime_put();

        r = component_bind_all(&pdev->dev, NULL);
        if (r)
                goto err_component;

        dss_debugfs_create_file("dss", dss_dump_regs);

        pm_set_vt_switch(0);

        dss_initialized = true;

        return 0;

err_component:
err_runtime_get:
        pm_runtime_disable(&pdev->dev);
        dss_uninit_ports(pdev);
err_init_ports:
        if (dss.video1_pll)
                dss_video_pll_uninit(dss.video1_pll);

        if (dss.video2_pll)
                dss_video_pll_uninit(dss.video2_pll);
err_pll_init:
err_setup_clocks:
        dss_put_clocks();
        return r;
}

static void dss_unbind(struct device *dev)
{
        struct platform_device *pdev = to_platform_device(dev);

        dss_initialized = false;

        component_unbind_all(&pdev->dev, NULL);

        if (dss.video1_pll)
                dss_video_pll_uninit(dss.video1_pll);

        if (dss.video2_pll)
                dss_video_pll_uninit(dss.video2_pll);

        dss_uninit_ports(pdev);

        pm_runtime_disable(&pdev->dev);

        dss_put_clocks();
}

static const struct component_master_ops dss_component_ops = {
        .bind = dss_bind,
        .unbind = dss_unbind,
};

static int dss_component_compare(struct device *dev, void *data)
{
        struct device *child = data;
        return dev == child;
}

static int dss_add_child_component(struct device *dev, void *data)
{
        struct component_match **match = data;

        /*
         * HACK
         * We don't have a working driver for rfbi, so skip it here always.
         * Otherwise dss will never get probed successfully, as it will wait
         * for rfbi to get probed.
         */
        if (strstr(dev_name(dev), "rfbi"))
                return 0;

        component_match_add(dev->parent, match, dss_component_compare, dev);

        return 0;
}

static int dss_probe(struct platform_device *pdev)
{
        struct component_match *match = NULL;
        int r;

        /* add all the child devices as components */
        device_for_each_child(&pdev->dev, &match, dss_add_child_component);

        r = component_master_add_with_match(&pdev->dev, &dss_component_ops, match);
        if (r)
                return r;

        return 0;
}

static int dss_remove(struct platform_device *pdev)
{
        component_master_del(&pdev->dev, &dss_component_ops);
        return 0;
}

static int dss_runtime_suspend(struct device *dev)
{
        dss_save_context();
        dss_set_min_bus_tput(dev, 0);

        pinctrl_pm_select_sleep_state(dev);

        return 0;
}

static int dss_runtime_resume(struct device *dev)
{
        int r;

        pinctrl_pm_select_default_state(dev);

        /*
         * Set an arbitrarily high tput request to ensure OPP100.
         * What we should really do is to make a request to stay in OPP100,
         * without any tput requirements, but that is not currently possible
         * via the PM layer.
         */

        r = dss_set_min_bus_tput(dev, 1000000000);
        if (r)
                return r;

        dss_restore_context();
        return 0;
}

static const struct dev_pm_ops dss_pm_ops = {
        .runtime_suspend = dss_runtime_suspend,
        .runtime_resume = dss_runtime_resume,
};

static const struct of_device_id dss_of_match[] = {
        { .compatible = "ti,omap2-dss", },
        { .compatible = "ti,omap3-dss", },
        { .compatible = "ti,omap4-dss", },
        { .compatible = "ti,omap5-dss", },
        { .compatible = "ti,dra7-dss", },
        {},
};

MODULE_DEVICE_TABLE(of, dss_of_match);

static struct platform_driver omap_dsshw_driver = {
        .probe          = dss_probe,
        .remove         = dss_remove,
        .driver         = {
                .name   = "omapdss_dss",
                .pm     = &dss_pm_ops,
                .of_match_table = dss_of_match,
                .suppress_bind_attrs = true,
        },
};

int __init dss_init_platform_driver(void)
{
        return platform_driver_register(&omap_dsshw_driver);
}

void dss_uninit_platform_driver(void)
{
        platform_driver_unregister(&omap_dsshw_driver);
}