root/drivers/clk/qcom/gpucc-sm6350.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2021, The Linux Foundation. All rights reserved.
 * Copyright (c) 2021, Konrad Dybcio <konrad.dybcio@somainline.org>
 */

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

#include <dt-bindings/clock/qcom,gpucc-sm6350.h>

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

#define CX_GMU_CBCR_SLEEP_MASK          0xF
#define CX_GMU_CBCR_SLEEP_SHIFT         4
#define CX_GMU_CBCR_WAKE_MASK           0xF
#define CX_GMU_CBCR_WAKE_SHIFT          8

enum {
        DT_BI_TCXO,
        DT_GPLL0_OUT_MAIN,
        DT_GPLL0_OUT_MAIN_DIV,
};

enum {
        P_BI_TCXO,
        P_GPLL0_OUT_MAIN,
        P_GPLL0_OUT_MAIN_DIV,
        P_GPU_CC_PLL0_OUT_MAIN,
        P_GPU_CC_PLL0_OUT_ODD,
        P_GPU_CC_PLL1_OUT_EVEN,
        P_GPU_CC_PLL1_OUT_MAIN,
        P_GPU_CC_PLL1_OUT_ODD,
        P_CRC_DIV,
};

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

/* 506MHz Configuration*/
static const struct alpha_pll_config gpu_cc_pll0_config = {
        .l = 0x1A,
        .alpha = 0x5AAA,
        .config_ctl_val = 0x20485699,
        .config_ctl_hi_val = 0x00002067,
        .test_ctl_val = 0x40000000,
        .test_ctl_hi_val = 0x00000002,
        .user_ctl_val = 0x00000001,
        .user_ctl_hi_val = 0x00004805,
};

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

static struct clk_fixed_factor crc_div = {
        .mult = 1,
        .div = 2,
        .hw.init = &(struct clk_init_data){
                .name = "crc_div",
                .parent_hws = (const struct clk_hw*[]){
                        &gpu_cc_pll0.clkr.hw,
                },
                .num_parents = 1,
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_fixed_factor_ops,
        },
};

/* 514MHz Configuration*/
static const struct alpha_pll_config gpu_cc_pll1_config = {
        .l = 0x1A,
        .alpha = 0xC555,
        .config_ctl_val = 0x20485699,
        .config_ctl_hi_val = 0x00002067,
        .test_ctl_val = 0x40000000,
        .test_ctl_hi_val = 0x00000002,
        .user_ctl_val = 0x00000001,
        .user_ctl_hi_val = 0x00004805,
};

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

static const struct parent_map gpu_cc_parent_map_0[] = {
        { P_BI_TCXO, 0 },
        { P_GPU_CC_PLL0_OUT_MAIN, 1 },
        { P_GPU_CC_PLL1_OUT_MAIN, 3 },
        { P_GPLL0_OUT_MAIN, 5 },
        { P_GPLL0_OUT_MAIN_DIV, 6 },
};

static const struct clk_parent_data gpu_cc_parent_data_0[] = {
        { .index = DT_BI_TCXO, .fw_name = "bi_tcxo" },
        { .hw = &gpu_cc_pll0.clkr.hw },
        { .hw = &gpu_cc_pll1.clkr.hw },
        { .index = DT_GPLL0_OUT_MAIN, .fw_name = "gcc_gpu_gpll0_clk_src" },
        { .index = DT_GPLL0_OUT_MAIN_DIV, .fw_name = "gcc_gpu_gpll0_div_clk_src" },
};

static const struct parent_map gpu_cc_parent_map_1[] = {
        { P_BI_TCXO, 0 },
        { P_CRC_DIV, 1 },
        { P_GPU_CC_PLL0_OUT_ODD, 2 },
        { P_GPU_CC_PLL1_OUT_EVEN, 3 },
        { P_GPU_CC_PLL1_OUT_ODD, 4 },
        { P_GPLL0_OUT_MAIN, 5 },
};

static const struct clk_parent_data gpu_cc_parent_data_1[] = {
        { .index = DT_BI_TCXO, .fw_name = "bi_tcxo" },
        { .hw = &crc_div.hw },
        { .hw = &gpu_cc_pll0.clkr.hw },
        { .hw = &gpu_cc_pll1.clkr.hw },
        { .hw = &gpu_cc_pll1.clkr.hw },
        { .index = DT_GPLL0_OUT_MAIN, .fw_name = "gcc_gpu_gpll0_clk_src" },
};

static const struct freq_tbl ftbl_gpu_cc_gmu_clk_src[] = {
        F(200000000, P_GPLL0_OUT_MAIN_DIV, 1.5, 0, 0),
        { }
};

static struct clk_rcg2 gpu_cc_gmu_clk_src = {
        .cmd_rcgr = 0x1120,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = gpu_cc_parent_map_0,
        .freq_tbl = ftbl_gpu_cc_gmu_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "gpu_cc_gmu_clk_src",
                .parent_data = gpu_cc_parent_data_0,
                .num_parents = ARRAY_SIZE(gpu_cc_parent_data_0),
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_ops,
        },
};

static const struct freq_tbl ftbl_gpu_cc_gx_gfx3d_clk_src[] = {
        F(253000000, P_CRC_DIV, 1, 0, 0),
        F(355000000, P_CRC_DIV, 1, 0, 0),
        F(430000000, P_CRC_DIV, 1, 0, 0),
        F(565000000, P_CRC_DIV, 1, 0, 0),
        F(650000000, P_CRC_DIV, 1, 0, 0),
        F(800000000, P_CRC_DIV, 1, 0, 0),
        F(825000000, P_CRC_DIV, 1, 0, 0),
        F(850000000, P_CRC_DIV, 1, 0, 0),
        { }
};

static struct clk_rcg2 gpu_cc_gx_gfx3d_clk_src = {
        .cmd_rcgr = 0x101c,
        .mnd_width = 0,
        .hid_width = 5,
        .parent_map = gpu_cc_parent_map_1,
        .freq_tbl = ftbl_gpu_cc_gx_gfx3d_clk_src,
        .clkr.hw.init = &(struct clk_init_data){
                .name = "gpu_cc_gx_gfx3d_clk_src",
                .parent_data = gpu_cc_parent_data_1,
                .num_parents = ARRAY_SIZE(gpu_cc_parent_data_1),
                .flags = CLK_SET_RATE_PARENT,
                .ops = &clk_rcg2_ops,
        },
};

static struct clk_branch gpu_cc_acd_ahb_clk = {
        .halt_reg = 0x1168,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x1168,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_acd_ahb_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_acd_cxo_clk = {
        .halt_reg = 0x1164,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x1164,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_acd_cxo_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_ahb_clk = {
        .halt_reg = 0x1078,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x1078,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_ahb_clk",
                        .flags = CLK_IS_CRITICAL,
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_crc_ahb_clk = {
        .halt_reg = 0x107c,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x107c,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_crc_ahb_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

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

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

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

static struct clk_branch gpu_cc_cx_snoc_dvm_clk = {
        .halt_reg = 0x108c,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x108c,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_cx_snoc_dvm_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_cxo_aon_clk = {
        .halt_reg = 0x1004,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x1004,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_cxo_aon_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_cxo_clk = {
        .halt_reg = 0x109c,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x109c,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_cxo_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct clk_branch gpu_cc_gx_cxo_clk = {
        .halt_reg = 0x1060,
        .halt_check = BRANCH_HALT,
        .clkr = {
                .enable_reg = 0x1060,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_gx_cxo_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

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

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

static struct clk_branch gpu_cc_gx_vsense_clk = {
        .halt_reg = 0x1058,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x1058,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_gx_vsense_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

static struct gdsc gpu_cx_gdsc = {
        .gdscr = 0x106c,
        .gds_hw_ctrl = 0x1540,
        .en_rest_wait_val = 0x2,
        .en_few_wait_val = 0x2,
        .clk_dis_wait_val = 0x8,
        .pd = {
                .name = "gpu_cx_gdsc",
        },
        .pwrsts = PWRSTS_OFF_ON,
        .flags = VOTABLE,
};

static struct gdsc gpu_gx_gdsc = {
        .gdscr = 0x100c,
        .clamp_io_ctrl = 0x1508,
        .en_rest_wait_val = 0x2,
        .en_few_wait_val = 0x2,
        .clk_dis_wait_val = 0x2,
        .pd = {
                .name = "gpu_gx_gdsc",
                .power_on = gdsc_gx_do_nothing_enable,
        },
        .pwrsts = PWRSTS_OFF_ON,
        .flags = CLAMP_IO | POLL_CFG_GDSCR,
};

static struct clk_hw *gpu_cc_sm6350_hws[] = {
        [GPU_CC_CRC_DIV] = &crc_div.hw,
};

static struct clk_regmap *gpu_cc_sm6350_clocks[] = {
        [GPU_CC_ACD_AHB_CLK] = &gpu_cc_acd_ahb_clk.clkr,
        [GPU_CC_ACD_CXO_CLK] = &gpu_cc_acd_cxo_clk.clkr,
        [GPU_CC_AHB_CLK] = &gpu_cc_ahb_clk.clkr,
        [GPU_CC_CRC_AHB_CLK] = &gpu_cc_crc_ahb_clk.clkr,
        [GPU_CC_CX_GFX3D_CLK] = &gpu_cc_cx_gfx3d_clk.clkr,
        [GPU_CC_CX_GFX3D_SLV_CLK] = &gpu_cc_cx_gfx3d_slv_clk.clkr,
        [GPU_CC_CX_GMU_CLK] = &gpu_cc_cx_gmu_clk.clkr,
        [GPU_CC_CX_SNOC_DVM_CLK] = &gpu_cc_cx_snoc_dvm_clk.clkr,
        [GPU_CC_CXO_AON_CLK] = &gpu_cc_cxo_aon_clk.clkr,
        [GPU_CC_CXO_CLK] = &gpu_cc_cxo_clk.clkr,
        [GPU_CC_GMU_CLK_SRC] = &gpu_cc_gmu_clk_src.clkr,
        [GPU_CC_GX_CXO_CLK] = &gpu_cc_gx_cxo_clk.clkr,
        [GPU_CC_GX_GFX3D_CLK] = &gpu_cc_gx_gfx3d_clk.clkr,
        [GPU_CC_GX_GFX3D_CLK_SRC] = &gpu_cc_gx_gfx3d_clk_src.clkr,
        [GPU_CC_GX_GMU_CLK] = &gpu_cc_gx_gmu_clk.clkr,
        [GPU_CC_GX_VSENSE_CLK] = &gpu_cc_gx_vsense_clk.clkr,
        [GPU_CC_PLL0] = &gpu_cc_pll0.clkr,
        [GPU_CC_PLL1] = &gpu_cc_pll1.clkr,
};

static struct gdsc *gpu_cc_sm6350_gdscs[] = {
        [GPU_CX_GDSC] = &gpu_cx_gdsc,
        [GPU_GX_GDSC] = &gpu_gx_gdsc,
};

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

static const struct qcom_cc_desc gpu_cc_sm6350_desc = {
        .config = &gpu_cc_sm6350_regmap_config,
        .clk_hws = gpu_cc_sm6350_hws,
        .num_clk_hws = ARRAY_SIZE(gpu_cc_sm6350_hws),
        .clks = gpu_cc_sm6350_clocks,
        .num_clks = ARRAY_SIZE(gpu_cc_sm6350_clocks),
        .gdscs = gpu_cc_sm6350_gdscs,
        .num_gdscs = ARRAY_SIZE(gpu_cc_sm6350_gdscs),
};

static const struct of_device_id gpu_cc_sm6350_match_table[] = {
        { .compatible = "qcom,sm6350-gpucc" },
        { }
};
MODULE_DEVICE_TABLE(of, gpu_cc_sm6350_match_table);

static int gpu_cc_sm6350_probe(struct platform_device *pdev)
{
        struct regmap *regmap;
        unsigned int value, mask;

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

        clk_fabia_pll_configure(&gpu_cc_pll0, regmap, &gpu_cc_pll0_config);
        clk_fabia_pll_configure(&gpu_cc_pll1, regmap, &gpu_cc_pll1_config);

        /* Configure gpu_cc_cx_gmu_clk with recommended wakeup/sleep settings */
        mask = CX_GMU_CBCR_WAKE_MASK << CX_GMU_CBCR_WAKE_SHIFT;
        mask |= CX_GMU_CBCR_SLEEP_MASK << CX_GMU_CBCR_SLEEP_SHIFT;
        value = 0xF << CX_GMU_CBCR_WAKE_SHIFT | 0xF << CX_GMU_CBCR_SLEEP_SHIFT;
        regmap_update_bits(regmap, 0x1098, mask, value);

        return qcom_cc_really_probe(&pdev->dev, &gpu_cc_sm6350_desc, regmap);
}

static struct platform_driver gpu_cc_sm6350_driver = {
        .probe = gpu_cc_sm6350_probe,
        .driver = {
                .name = "sm6350-gpucc",
                .of_match_table = gpu_cc_sm6350_match_table,
        },
};

static int __init gpu_cc_sm6350_init(void)
{
        return platform_driver_register(&gpu_cc_sm6350_driver);
}
core_initcall(gpu_cc_sm6350_init);

static void __exit gpu_cc_sm6350_exit(void)
{
        platform_driver_unregister(&gpu_cc_sm6350_driver);
}
module_exit(gpu_cc_sm6350_exit);

MODULE_DESCRIPTION("QTI GPU_CC LAGOON Driver");
MODULE_LICENSE("GPL v2");