root/drivers/clk/qcom/dispcc-qcm2290.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2020, The Linux Foundation. All rights reserved.
 * Copyright (c) 2021, Linaro Ltd.
 */

#include <linux/clk-provider.h>
#include <linux/err.h>
#include <linux/kernel.h>
#include <linux/mod_devicetable.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/regmap.h>

#include <dt-bindings/clock/qcom,dispcc-qcm2290.h>

#include "clk-alpha-pll.h"
#include "clk-branch.h"
#include "clk-rcg.h"
#include "clk-regmap.h"
#include "clk-regmap-divider.h"
#include "common.h"
#include "gdsc.h"
#include "reset.h"

enum {
        P_BI_TCXO,
        P_BI_TCXO_AO,
        P_DISP_CC_PLL0_OUT_MAIN,
        P_DSI0_PHY_PLL_OUT_BYTECLK,
        P_DSI0_PHY_PLL_OUT_DSICLK,
        P_GPLL0_OUT_DIV,
        P_GPLL0_OUT_MAIN,
        P_SLEEP_CLK,
};

static const struct pll_vco spark_vco[] = {
        { 500000000, 1000000000, 2 },
};

/* 768MHz configuration */
static const struct alpha_pll_config disp_cc_pll0_config = {
        .l = 0x28,
        .vco_val = 0x2 << 20,
        .vco_mask = GENMASK(21, 20),
        .main_output_mask = BIT(0),
        .config_ctl_val = 0x4001055B,
};

static struct clk_alpha_pll disp_cc_pll0 = {
        .offset = 0x0,
        .vco_table = spark_vco,
        .num_vco = ARRAY_SIZE(spark_vco),
        .regs = clk_alpha_pll_regs[CLK_ALPHA_PLL_TYPE_DEFAULT],
        .clkr = {
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_pll0",
                        .parent_data = &(const struct clk_parent_data){
                                .fw_name = "bi_tcxo",
                        },
                        .num_parents = 1,
                        .ops = &clk_alpha_pll_ops,
                },
        },
};

static const struct parent_map disp_cc_parent_map_0[] = {
        { P_BI_TCXO, 0 },
        { P_DSI0_PHY_PLL_OUT_BYTECLK, 1 },
};

static const struct clk_parent_data disp_cc_parent_data_0[] = {
        { .fw_name = "bi_tcxo" },
        { .fw_name = "dsi0_phy_pll_out_byteclk" },
};

static const struct parent_map disp_cc_parent_map_1[] = {
        { P_BI_TCXO, 0 },
};

static const struct clk_parent_data disp_cc_parent_data_1[] = {
        { .fw_name = "bi_tcxo" },
};

static const struct parent_map disp_cc_parent_map_2[] = {
        { P_BI_TCXO_AO, 0 },
        { P_GPLL0_OUT_DIV, 4 },
};

static const struct clk_parent_data disp_cc_parent_data_2[] = {
        { .fw_name = "bi_tcxo_ao" },
        { .fw_name = "gcc_disp_gpll0_div_clk_src" },
};

static const struct parent_map disp_cc_parent_map_3[] = {
        { P_BI_TCXO, 0 },
        { P_DISP_CC_PLL0_OUT_MAIN, 1 },
        { P_GPLL0_OUT_MAIN, 4 },
};

static const struct clk_parent_data disp_cc_parent_data_3[] = {
        { .fw_name = "bi_tcxo" },
        { .hw = &disp_cc_pll0.clkr.hw },
        { .fw_name = "gcc_disp_gpll0_clk_src" },
};

static const struct parent_map disp_cc_parent_map_4[] = {
        { P_BI_TCXO, 0 },
        { P_DSI0_PHY_PLL_OUT_DSICLK, 1 },
};

static const struct clk_parent_data disp_cc_parent_data_4[] = {
        { .fw_name = "bi_tcxo" },
        { .fw_name = "dsi0_phy_pll_out_dsiclk" },
};

static const struct parent_map disp_cc_parent_map_5[] = {
        { P_SLEEP_CLK, 0 },
};

static const struct clk_parent_data disp_cc_parent_data_5[] = {
        { .fw_name = "sleep_clk" },
};

static struct clk_rcg2 disp_cc_mdss_byte0_clk_src = {
        .cmd_rcgr = 0x20a4,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_0,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_byte0_clk_src",
                .parent_data = disp_cc_parent_data_0,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_0),
                /* For set_rate and set_parent to succeed, parent(s) must be enabled */
                .flags = CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
                .ops = &clk_byte2_ops,
        },
};

static struct clk_regmap_div disp_cc_mdss_byte0_div_clk_src = {
        .reg = 0x20bc,
        .shift = 0,
        .width = 2,
        .clkr.hw.init = &(struct clk_init_data) {
                .name = "disp_cc_mdss_byte0_div_clk_src",
                .parent_hws = (const struct clk_hw*[]){
                        &disp_cc_mdss_byte0_clk_src.clkr.hw,
                },
                .num_parents = 1,
                .ops = &clk_regmap_div_ops,
        },
};

static const struct freq_tbl ftbl_disp_cc_mdss_ahb_clk_src[] = {
        F(19200000, P_BI_TCXO_AO, 1, 0, 0),
        F(37500000, P_GPLL0_OUT_DIV, 8, 0, 0),
        F(75000000, P_GPLL0_OUT_DIV, 4, 0, 0),
        { }
};

static struct clk_rcg2 disp_cc_mdss_ahb_clk_src = {
        .cmd_rcgr = 0x2154,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_2,
        .freq_tbl = ftbl_disp_cc_mdss_ahb_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_ahb_clk_src",
                .parent_data = disp_cc_parent_data_2,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_2),
                .ops = &clk_rcg2_shared_ops,
        },
};

static const struct freq_tbl ftbl_disp_cc_mdss_esc0_clk_src[] = {
        F(19200000, P_BI_TCXO, 1, 0, 0),
        { }
};

static struct clk_rcg2 disp_cc_mdss_esc0_clk_src = {
        .cmd_rcgr = 0x20c0,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_0,
        .freq_tbl = ftbl_disp_cc_mdss_esc0_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_esc0_clk_src",
                .parent_data = disp_cc_parent_data_0,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_0),
                .ops = &clk_rcg2_ops,
        },
};

static const struct freq_tbl ftbl_disp_cc_mdss_mdp_clk_src[] = {
        F(19200000, P_BI_TCXO, 1, 0, 0),
        F(192000000, P_DISP_CC_PLL0_OUT_MAIN, 4, 0, 0),
        F(256000000, P_DISP_CC_PLL0_OUT_MAIN, 3, 0, 0),
        F(307200000, P_DISP_CC_PLL0_OUT_MAIN, 2.5, 0, 0),
        F(384000000, P_DISP_CC_PLL0_OUT_MAIN, 2, 0, 0),
        { }
};

static struct clk_rcg2 disp_cc_mdss_mdp_clk_src = {
        .cmd_rcgr = 0x2074,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_3,
        .freq_tbl = ftbl_disp_cc_mdss_mdp_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_mdp_clk_src",
                .parent_data = disp_cc_parent_data_3,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_3),
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_shared_ops,
        },
};

static struct clk_rcg2 disp_cc_mdss_pclk0_clk_src = {
        .cmd_rcgr = 0x205c,
        .mnd_width = 8,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_4,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_pclk0_clk_src",
                .parent_data = disp_cc_parent_data_4,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_4),
                /* For set_rate and set_parent to succeed, parent(s) must be enabled */
                .flags = CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
                .ops = &clk_pixel_ops,
        },
};

static struct clk_rcg2 disp_cc_mdss_vsync_clk_src = {
        .cmd_rcgr = 0x208c,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_1,
        .freq_tbl = ftbl_disp_cc_mdss_esc0_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_mdss_vsync_clk_src",
                .parent_data = disp_cc_parent_data_1,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_1),
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_shared_ops,
        },
};

static const struct freq_tbl ftbl_disp_cc_sleep_clk_src[] = {
        F(32764, P_SLEEP_CLK, 1, 0, 0),
        { }
};

static struct clk_rcg2 disp_cc_sleep_clk_src = {
        .cmd_rcgr = 0x6050,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = disp_cc_parent_map_5,
        .freq_tbl = ftbl_disp_cc_sleep_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "disp_cc_sleep_clk_src",
                .parent_data = disp_cc_parent_data_5,
                .num_parents = ARRAY_SIZE(disp_cc_parent_data_5),
                .ops = &clk_rcg2_ops,
        },
};

static struct clk_branch disp_cc_mdss_ahb_clk = {
        .halt_reg = 0x2044,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2044,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_ahb_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_ahb_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_byte0_clk = {
        .halt_reg = 0x201c,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x201c,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_byte0_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_byte0_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_byte0_intf_clk = {
        .halt_reg = 0x2020,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2020,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_byte0_intf_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_byte0_div_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_esc0_clk = {
        .halt_reg = 0x2024,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2024,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_esc0_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_esc0_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_mdp_clk = {
        .halt_reg = 0x2008,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2008,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_mdp_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_mdp_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_mdp_lut_clk = {
        .halt_reg = 0x2010,
        .halt_check = BRANCH_HALT_VOTED,
        .clkr = {
                .enable_reg = 0x2010,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_mdp_lut_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_mdp_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_non_gdsc_ahb_clk = {
        .halt_reg = 0x4004,
        .halt_check = BRANCH_HALT_VOTED,
        .clkr = {
                .enable_reg = 0x4004,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_non_gdsc_ahb_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_ahb_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_pclk0_clk = {
        .halt_reg = 0x2004,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2004,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_pclk0_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_pclk0_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_mdss_vsync_clk = {
        .halt_reg = 0x2018,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x2018,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_mdss_vsync_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_mdss_vsync_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch disp_cc_sleep_clk = {
        .halt_reg = 0x6068,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x6068,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "disp_cc_sleep_clk",
                        .parent_hws = (const struct clk_hw*[]){
                                &disp_cc_sleep_clk_src.clkr.hw,
                        },
                        .num_parents = 1,
                        .flags = CLK_SET_RATE_PARENT,
                        .ops = &clk_branch2_ops,
                },
        },
};

static const struct qcom_reset_map disp_cc_qcm2290_resets[] = {
        [DISP_CC_MDSS_CORE_BCR] = { 0x2000 },
};

static struct gdsc mdss_gdsc = {
        .gdscr = 0x3000,
        .pd = {
                .name = "mdss_gdsc",
        },
        .pwrsts = PWRSTS_OFF_ON,
        .flags = HW_CTRL,
};

static struct gdsc *disp_cc_qcm2290_gdscs[] = {
        [MDSS_GDSC] = &mdss_gdsc,
};

static struct clk_regmap *disp_cc_qcm2290_clocks[] = {
        [DISP_CC_MDSS_AHB_CLK] = &disp_cc_mdss_ahb_clk.clkr,
        [DISP_CC_MDSS_AHB_CLK_SRC] = &disp_cc_mdss_ahb_clk_src.clkr,
        [DISP_CC_MDSS_BYTE0_CLK] = &disp_cc_mdss_byte0_clk.clkr,
        [DISP_CC_MDSS_BYTE0_CLK_SRC] = &disp_cc_mdss_byte0_clk_src.clkr,
        [DISP_CC_MDSS_BYTE0_DIV_CLK_SRC] = &disp_cc_mdss_byte0_div_clk_src.clkr,
        [DISP_CC_MDSS_BYTE0_INTF_CLK] = &disp_cc_mdss_byte0_intf_clk.clkr,
        [DISP_CC_MDSS_ESC0_CLK] = &disp_cc_mdss_esc0_clk.clkr,
        [DISP_CC_MDSS_ESC0_CLK_SRC] = &disp_cc_mdss_esc0_clk_src.clkr,
        [DISP_CC_MDSS_MDP_CLK] = &disp_cc_mdss_mdp_clk.clkr,
        [DISP_CC_MDSS_MDP_CLK_SRC] = &disp_cc_mdss_mdp_clk_src.clkr,
        [DISP_CC_MDSS_MDP_LUT_CLK] = &disp_cc_mdss_mdp_lut_clk.clkr,
        [DISP_CC_MDSS_NON_GDSC_AHB_CLK] = &disp_cc_mdss_non_gdsc_ahb_clk.clkr,
        [DISP_CC_MDSS_PCLK0_CLK] = &disp_cc_mdss_pclk0_clk.clkr,
        [DISP_CC_MDSS_PCLK0_CLK_SRC] = &disp_cc_mdss_pclk0_clk_src.clkr,
        [DISP_CC_MDSS_VSYNC_CLK] = &disp_cc_mdss_vsync_clk.clkr,
        [DISP_CC_MDSS_VSYNC_CLK_SRC] = &disp_cc_mdss_vsync_clk_src.clkr,
        [DISP_CC_PLL0] = &disp_cc_pll0.clkr,
        [DISP_CC_SLEEP_CLK] = &disp_cc_sleep_clk.clkr,
        [DISP_CC_SLEEP_CLK_SRC] = &disp_cc_sleep_clk_src.clkr,
};

static const struct regmap_config disp_cc_qcm2290_regmap_config = {
        .reg_bits = 32,
        .reg_stride = 4,
        .val_bits = 32,
        .max_register = 0x10000,
        .fast_io = true,
};

static const struct qcom_cc_desc disp_cc_qcm2290_desc = {
        .config = &disp_cc_qcm2290_regmap_config,
        .clks = disp_cc_qcm2290_clocks,
        .num_clks = ARRAY_SIZE(disp_cc_qcm2290_clocks),
        .gdscs = disp_cc_qcm2290_gdscs,
        .num_gdscs = ARRAY_SIZE(disp_cc_qcm2290_gdscs),
        .resets = disp_cc_qcm2290_resets,
        .num_resets = ARRAY_SIZE(disp_cc_qcm2290_resets),
};

static const struct of_device_id disp_cc_qcm2290_match_table[] = {
        { .compatible = "qcom,qcm2290-dispcc" },
        { }
};
MODULE_DEVICE_TABLE(of, disp_cc_qcm2290_match_table);

static int disp_cc_qcm2290_probe(struct platform_device *pdev)
{
        struct regmap *regmap;
        int ret;

        regmap = qcom_cc_map(pdev, &disp_cc_qcm2290_desc);
        if (IS_ERR(regmap))
                return PTR_ERR(regmap);

        clk_alpha_pll_configure(&disp_cc_pll0, regmap, &disp_cc_pll0_config);

        /* Keep some clocks always-on */
        qcom_branch_set_clk_en(regmap, 0x604c); /* DISP_CC_XO_CLK */

        ret = qcom_cc_really_probe(&pdev->dev, &disp_cc_qcm2290_desc, regmap);
        if (ret) {
                dev_err(&pdev->dev, "Failed to register DISP CC clocks\n");
                return ret;
        }

        return ret;
}

static struct platform_driver disp_cc_qcm2290_driver = {
        .probe = disp_cc_qcm2290_probe,
        .driver = {
                .name = "dispcc-qcm2290",
                .of_match_table = disp_cc_qcm2290_match_table,
        },
};

module_platform_driver(disp_cc_qcm2290_driver);

MODULE_DESCRIPTION("QTI DISP_CC qcm2290 Driver");
MODULE_LICENSE("GPL v2");