root/drivers/clk/qcom/lpasscorecc-sc7180.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2020, The Linux Foundation. All rights reserved.
 */

#include <linux/clk-provider.h>
#include <linux/err.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/pm_clock.h>
#include <linux/pm_runtime.h>
#include <linux/regmap.h>

#include <dt-bindings/clock/qcom,lpasscorecc-sc7180.h>

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

enum {
        P_BI_TCXO,
        P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD,
        P_SLEEP_CLK,
};

static const struct pll_vco fabia_vco[] = {
        { 249600000, 2000000000, 0 },
};

static const struct alpha_pll_config lpass_lpaaudio_dig_pll_config = {
        .l = 0x20,
        .alpha = 0x0,
        .config_ctl_val = 0x20485699,
        .config_ctl_hi_val = 0x00002067,
        .test_ctl_val = 0x40000000,
        .test_ctl_hi_val = 0x00000000,
        .user_ctl_val = 0x00005105,
        .user_ctl_hi_val = 0x00004805,
};

static const u8 clk_alpha_pll_regs_offset[][PLL_OFF_MAX_REGS] = {
        [CLK_ALPHA_PLL_TYPE_FABIA] = {
                [PLL_OFF_L_VAL] = 0x04,
                [PLL_OFF_CAL_L_VAL] = 0x8,
                [PLL_OFF_USER_CTL] = 0x0c,
                [PLL_OFF_USER_CTL_U] = 0x10,
                [PLL_OFF_USER_CTL_U1] = 0x14,
                [PLL_OFF_CONFIG_CTL] = 0x18,
                [PLL_OFF_CONFIG_CTL_U] = 0x1C,
                [PLL_OFF_CONFIG_CTL_U1] = 0x20,
                [PLL_OFF_TEST_CTL] = 0x24,
                [PLL_OFF_TEST_CTL_U] = 0x28,
                [PLL_OFF_STATUS] = 0x30,
                [PLL_OFF_OPMODE] = 0x38,
                [PLL_OFF_FRAC] = 0x40,
        },
};

static struct clk_alpha_pll lpass_lpaaudio_dig_pll = {
        .offset = 0x1000,
        .vco_table = fabia_vco,
        .num_vco = ARRAY_SIZE(fabia_vco),
        .regs = clk_alpha_pll_regs_offset[CLK_ALPHA_PLL_TYPE_FABIA],
        .clkr = {
                .hw.init = &(struct clk_init_data){
                        .name = "lpass_lpaaudio_dig_pll",
                        .parent_data = &(const struct clk_parent_data){
                                .fw_name = "bi_tcxo",
                        },
                        .num_parents = 1,
                        .ops = &clk_alpha_pll_fabia_ops,
                },
        },
};

static const struct clk_div_table
                        post_div_table_lpass_lpaaudio_dig_pll_out_odd[] = {
        { 0x5, 5 },
        { }
};

static struct clk_alpha_pll_postdiv lpass_lpaaudio_dig_pll_out_odd = {
        .offset = 0x1000,
        .post_div_shift = 12,
        .post_div_table = post_div_table_lpass_lpaaudio_dig_pll_out_odd,
        .num_post_div =
                ARRAY_SIZE(post_div_table_lpass_lpaaudio_dig_pll_out_odd),
        .width = 4,
        .regs = clk_alpha_pll_regs[CLK_ALPHA_PLL_TYPE_FABIA],
        .clkr.hw.init = &(struct clk_init_data){
                .name = "lpass_lpaaudio_dig_pll_out_odd",
                .parent_hws = (const struct clk_hw*[]) {
                        &lpass_lpaaudio_dig_pll.clkr.hw,
                },
                .num_parents = 1,
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_alpha_pll_postdiv_fabia_ops,
        },
};

static const struct parent_map lpass_core_cc_parent_map_0[] = {
        { P_BI_TCXO, 0 },
        { P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 5 },
};

static const struct clk_parent_data lpass_core_cc_parent_data_0[] = {
        { .fw_name = "bi_tcxo" },
        { .hw = &lpass_lpaaudio_dig_pll_out_odd.clkr.hw },
};

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

static struct clk_rcg2 core_clk_src = {
        .cmd_rcgr = 0x1d000,
        .mnd_width = 8,
        .hid_width = 5,
        .parent_map = lpass_core_cc_parent_map_2,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "core_clk_src",
                .parent_data = &(const struct clk_parent_data){
                        .fw_name = "bi_tcxo",
                },
                .num_parents = 1,
                .ops = &clk_rcg2_ops,
        },
};

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

static const struct freq_tbl ftbl_ext_lpaif_clk_src[] = {
        F(256000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 1, 32),
        F(512000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 1, 16),
        F(768000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 10, 1, 16),
        F(1024000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 1, 8),
        F(1536000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 10, 1, 8),
        F(2048000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 1, 4),
        F(3072000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 10, 1, 4),
        F(4096000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 1, 2),
        F(6144000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 10, 1, 2),
        F(8192000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 15, 0, 0),
        F(9600000, P_BI_TCXO, 2, 0, 0),
        F(12288000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 10, 0, 0),
        F(19200000, P_BI_TCXO, 1, 0, 0),
        F(24576000, P_LPASS_LPAAUDIO_DIG_PLL_OUT_ODD, 5, 0, 0),
        { }
};

static struct clk_rcg2 ext_mclk0_clk_src = {
        .cmd_rcgr = 0x20000,
        .mnd_width = 8,
        .hid_width = 5,
        .parent_map = lpass_core_cc_parent_map_0,
        .freq_tbl = ftbl_ext_mclk0_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "ext_mclk0_clk_src",
                .parent_data = lpass_core_cc_parent_data_0,
                .num_parents = 2,
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_ops,
        },
};

static struct clk_rcg2 lpaif_pri_clk_src = {
        .cmd_rcgr = 0x10000,
        .mnd_width = 16,
        .hid_width = 5,
        .parent_map = lpass_core_cc_parent_map_0,
        .freq_tbl = ftbl_ext_lpaif_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "lpaif_pri_clk_src",
                .parent_data = lpass_core_cc_parent_data_0,
                .num_parents = 2,
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_ops,
        },
};

static struct clk_rcg2 lpaif_sec_clk_src = {
        .cmd_rcgr = 0x11000,
        .mnd_width = 16,
        .hid_width = 5,
        .parent_map = lpass_core_cc_parent_map_0,
        .freq_tbl = ftbl_ext_lpaif_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "lpaif_sec_clk_src",
                .parent_data = lpass_core_cc_parent_data_0,
                .num_parents = 2,
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_ops,
        },
};

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

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

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

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

static struct clk_regmap *lpass_core_cc_sc7180_clocks[] = {
        [EXT_MCLK0_CLK_SRC] = &ext_mclk0_clk_src.clkr,
        [LPAIF_PRI_CLK_SRC] = &lpaif_pri_clk_src.clkr,
        [LPAIF_SEC_CLK_SRC] = &lpaif_sec_clk_src.clkr,
        [CORE_CLK_SRC] = &core_clk_src.clkr,
        [LPASS_AUDIO_CORE_EXT_MCLK0_CLK] = &lpass_audio_core_ext_mclk0_clk.clkr,
        [LPASS_AUDIO_CORE_LPAIF_PRI_IBIT_CLK] =
                &lpass_audio_core_lpaif_pri_ibit_clk.clkr,
        [LPASS_AUDIO_CORE_LPAIF_SEC_IBIT_CLK] =
                &lpass_audio_core_lpaif_sec_ibit_clk.clkr,
        [LPASS_AUDIO_CORE_SYSNOC_MPORT_CORE_CLK] =
                &lpass_audio_core_sysnoc_mport_core_clk.clkr,
        [LPASS_LPAAUDIO_DIG_PLL] = &lpass_lpaaudio_dig_pll.clkr,
        [LPASS_LPAAUDIO_DIG_PLL_OUT_ODD] = &lpass_lpaaudio_dig_pll_out_odd.clkr,
};

static struct gdsc lpass_pdc_hm_gdsc = {
        .gdscr = 0x3090,
        .pd = {
                .name = "lpass_pdc_hm_gdsc",
        },
        .pwrsts = PWRSTS_OFF_ON,
        .flags = VOTABLE,
};

static struct gdsc lpass_audio_hm_gdsc = {
        .gdscr = 0x9090,
        .pd = {
                .name = "lpass_audio_hm_gdsc",
        },
        .pwrsts = PWRSTS_OFF_ON,
};

static struct gdsc lpass_core_hm_gdsc = {
        .gdscr = 0x0,
        .pd = {
                .name = "lpass_core_hm_gdsc",
        },
        .pwrsts = PWRSTS_OFF_ON,
        .flags = RETAIN_FF_ENABLE,
};

static struct gdsc *lpass_core_hm_sc7180_gdscs[] = {
        [LPASS_CORE_HM_GDSCR] = &lpass_core_hm_gdsc,
};

static struct gdsc *lpass_audio_hm_sc7180_gdscs[] = {
        [LPASS_PDC_HM_GDSCR] = &lpass_pdc_hm_gdsc,
        [LPASS_AUDIO_HM_GDSCR] = &lpass_audio_hm_gdsc,
};

static struct regmap_config lpass_core_cc_sc7180_regmap_config = {
        .reg_bits = 32,
        .reg_stride = 4,
        .val_bits = 32,
        .fast_io = true,
};

static const struct qcom_cc_desc lpass_core_hm_sc7180_desc = {
        .config = &lpass_core_cc_sc7180_regmap_config,
        .gdscs = lpass_core_hm_sc7180_gdscs,
        .num_gdscs = ARRAY_SIZE(lpass_core_hm_sc7180_gdscs),
};

static const struct qcom_cc_desc lpass_core_cc_sc7180_desc = {
        .config = &lpass_core_cc_sc7180_regmap_config,
        .clks = lpass_core_cc_sc7180_clocks,
        .num_clks = ARRAY_SIZE(lpass_core_cc_sc7180_clocks),
};

static const struct qcom_cc_desc lpass_audio_hm_sc7180_desc = {
        .config = &lpass_core_cc_sc7180_regmap_config,
        .gdscs = lpass_audio_hm_sc7180_gdscs,
        .num_gdscs = ARRAY_SIZE(lpass_audio_hm_sc7180_gdscs),
};

static int lpass_setup_runtime_pm(struct platform_device *pdev)
{
        int ret;

        pm_runtime_use_autosuspend(&pdev->dev);
        pm_runtime_set_autosuspend_delay(&pdev->dev, 500);

        ret = devm_pm_runtime_enable(&pdev->dev);
        if (ret)
                return ret;

        ret = devm_pm_clk_create(&pdev->dev);
        if (ret)
                return ret;

        ret = pm_clk_add(&pdev->dev, "iface");
        if (ret < 0)
                dev_err(&pdev->dev, "failed to acquire iface clock\n");

        return pm_runtime_resume_and_get(&pdev->dev);
}

static int lpass_core_cc_sc7180_probe(struct platform_device *pdev)
{
        const struct qcom_cc_desc *desc;
        struct regmap *regmap;
        int ret;

        ret = lpass_setup_runtime_pm(pdev);
        if (ret)
                return ret;

        lpass_core_cc_sc7180_regmap_config.name = "lpass_audio_cc";
        desc = &lpass_audio_hm_sc7180_desc;
        ret = qcom_cc_probe_by_index(pdev, 1, desc);
        if (ret)
                goto exit;

        lpass_core_cc_sc7180_regmap_config.name = "lpass_core_cc";
        regmap = qcom_cc_map(pdev, &lpass_core_cc_sc7180_desc);
        if (IS_ERR(regmap)) {
                ret = PTR_ERR(regmap);
                goto exit;
        }

        /* Keep some clocks always-on */
        qcom_branch_set_clk_en(regmap, 0x24000); /* LPASS_AUDIO_CORE_SYSNOC_SWAY_CORE_CLK */

        /* PLL settings */
        regmap_write(regmap, 0x1008, 0x20);
        regmap_update_bits(regmap, 0x1014, BIT(0), BIT(0));

        clk_fabia_pll_configure(&lpass_lpaaudio_dig_pll, regmap,
                                &lpass_lpaaudio_dig_pll_config);

        ret = qcom_cc_really_probe(&pdev->dev, &lpass_core_cc_sc7180_desc, regmap);

exit:
        pm_runtime_put_autosuspend(&pdev->dev);

        return ret;
}

static int lpass_hm_core_probe(struct platform_device *pdev)
{
        const struct qcom_cc_desc *desc;
        int ret;

        ret = lpass_setup_runtime_pm(pdev);
        if (ret)
                return ret;

        lpass_core_cc_sc7180_regmap_config.name = "lpass_hm_core";
        desc = &lpass_core_hm_sc7180_desc;

        ret = qcom_cc_probe_by_index(pdev, 0, desc);

        pm_runtime_put_autosuspend(&pdev->dev);

        return ret;
}

static const struct of_device_id lpass_hm_sc7180_match_table[] = {
        {
                .compatible = "qcom,sc7180-lpasshm",
        },
        { }
};
MODULE_DEVICE_TABLE(of, lpass_hm_sc7180_match_table);

static const struct of_device_id lpass_core_cc_sc7180_match_table[] = {
        {
                .compatible = "qcom,sc7180-lpasscorecc",
        },
        { }
};
MODULE_DEVICE_TABLE(of, lpass_core_cc_sc7180_match_table);

static const struct dev_pm_ops lpass_pm_ops = {
        SET_RUNTIME_PM_OPS(pm_clk_suspend, pm_clk_resume, NULL)
};

static struct platform_driver lpass_core_cc_sc7180_driver = {
        .probe = lpass_core_cc_sc7180_probe,
        .driver = {
                .name = "lpass_core_cc-sc7180",
                .of_match_table = lpass_core_cc_sc7180_match_table,
                .pm = &lpass_pm_ops,
        },
};

static struct platform_driver lpass_hm_sc7180_driver = {
        .probe = lpass_hm_core_probe,
        .driver = {
                .name = "lpass_hm-sc7180",
                .of_match_table = lpass_hm_sc7180_match_table,
                .pm = &lpass_pm_ops,
        },
};

static int __init lpass_sc7180_init(void)
{
        int ret;

        ret = platform_driver_register(&lpass_core_cc_sc7180_driver);
        if (ret)
                return ret;

        ret = platform_driver_register(&lpass_hm_sc7180_driver);
        if (ret) {
                platform_driver_unregister(&lpass_core_cc_sc7180_driver);
                return ret;
        }

        return 0;
}
subsys_initcall(lpass_sc7180_init);

static void __exit lpass_sc7180_exit(void)
{
        platform_driver_unregister(&lpass_hm_sc7180_driver);
        platform_driver_unregister(&lpass_core_cc_sc7180_driver);
}
module_exit(lpass_sc7180_exit);

MODULE_DESCRIPTION("QTI LPASS_CORE_CC SC7180 Driver");
MODULE_LICENSE("GPL v2");