root/drivers/clk/qcom/gpucc-sm6125.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2019, The Linux Foundation. All rights reserved.
 * Copyright (c) 2023, Linaro Limited
 */

#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,sm6125-gpucc.h>

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

enum {
        DT_BI_TCXO,
        DT_GCC_GPU_GPLL0_CLK_SRC,
};

enum {
        P_BI_TCXO,
        P_GPLL0_OUT_MAIN,
        P_GPU_CC_PLL0_2X_CLK,
        P_GPU_CC_PLL0_OUT_AUX2,
        P_GPU_CC_PLL1_OUT_AUX,
        P_GPU_CC_PLL1_OUT_AUX2,
};

static const struct pll_vco gpu_cc_pll_vco[] = {
        { 1000000000, 2000000000, 0 },
        { 500000000,  1000000000, 2 },
};

/* 1020MHz configuration */
static const struct alpha_pll_config gpu_pll0_config = {
        .l = 0x35,
        .config_ctl_val = 0x4001055b,
        .alpha_hi = 0x20,
        .alpha = 0x00,
        .alpha_en_mask = BIT(24),
        .vco_val = 0x0 << 20,
        .vco_mask = 0x3 << 20,
        .aux2_output_mask = BIT(2),
};

/* 930MHz configuration */
static const struct alpha_pll_config gpu_pll1_config = {
        .l = 0x30,
        .config_ctl_val = 0x4001055b,
        .alpha_hi = 0x70,
        .alpha = 0x00,
        .alpha_en_mask = BIT(24),
        .vco_val = 0x2 << 20,
        .vco_mask = 0x3 << 20,
        .aux2_output_mask = BIT(2),
};

static struct clk_alpha_pll gpu_cc_pll0_out_aux2 = {
        .offset = 0x0,
        .vco_table = gpu_cc_pll_vco,
        .num_vco = ARRAY_SIZE(gpu_cc_pll_vco),
        .regs = clk_alpha_pll_regs[CLK_ALPHA_PLL_TYPE_DEFAULT],
        .flags = SUPPORTS_DYNAMIC_UPDATE,
        .clkr = {
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_pll0_out_aux2",
                        .parent_data = &(const struct clk_parent_data) {
                                .index = DT_BI_TCXO,
                        },
                        .num_parents = 1,
                        .ops = &clk_alpha_pll_ops,
                },
        },
};

static struct clk_alpha_pll gpu_cc_pll1_out_aux2 = {
        .offset = 0x100,
        .vco_table = gpu_cc_pll_vco,
        .num_vco = ARRAY_SIZE(gpu_cc_pll_vco),
        .regs = clk_alpha_pll_regs[CLK_ALPHA_PLL_TYPE_DEFAULT],
        .flags = SUPPORTS_DYNAMIC_UPDATE,
        .clkr = {
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_pll1_out_aux2",
                        .parent_data = &(const struct clk_parent_data) {
                                .index = DT_BI_TCXO,
                        },
                        .num_parents = 1,
                        .ops = &clk_alpha_pll_ops,
                },
        },
};

static const struct parent_map gpu_cc_parent_map_0[] = {
        { P_BI_TCXO, 0 },
        { P_GPLL0_OUT_MAIN, 5 },
};

static const struct clk_parent_data gpu_cc_parent_data_0[] = {
        { .index = DT_BI_TCXO },
        { .index = DT_GCC_GPU_GPLL0_CLK_SRC },
};

static const struct parent_map gpu_cc_parent_map_1[] = {
        { P_BI_TCXO, 0 },
        { P_GPU_CC_PLL0_OUT_AUX2, 2 },
        { P_GPU_CC_PLL1_OUT_AUX2, 4 },
};

static const struct clk_parent_data gpu_cc_parent_data_1[] = {
        { .index = DT_BI_TCXO },
        { .hw = &gpu_cc_pll0_out_aux2.clkr.hw },
        { .hw = &gpu_cc_pll1_out_aux2.clkr.hw },
};

static const struct freq_tbl ftbl_gpu_cc_gmu_clk_src[] = {
        F(200000000, P_GPLL0_OUT_MAIN, 3, 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),
                .ops = &clk_rcg2_shared_ops,
        },
};

static const struct freq_tbl ftbl_gpu_cc_gx_gfx3d_clk_src[] = {
        F(320000000, P_GPU_CC_PLL1_OUT_AUX2, 2, 0, 0),
        F(465000000, P_GPU_CC_PLL1_OUT_AUX2, 2, 0, 0),
        F(600000000, P_GPU_CC_PLL0_OUT_AUX2, 2, 0, 0),
        F(745000000, P_GPU_CC_PLL0_OUT_AUX2, 2, 0, 0),
        F(820000000, P_GPU_CC_PLL0_OUT_AUX2, 2, 0, 0),
        F(900000000, P_GPU_CC_PLL0_OUT_AUX2, 2, 0, 0),
        F(950000000, P_GPU_CC_PLL0_OUT_AUX2, 2, 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 | CLK_OPS_PARENT_ENABLE,
                .ops = &clk_rcg2_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_apb_clk = {
        .halt_reg = 0x1088,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x1088,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_cx_apb_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_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.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_sleep_clk = {
        .halt_reg = 0x1090,
        .halt_check = BRANCH_HALT_DELAY,
        .clkr = {
                .enable_reg = 0x1090,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_sleep_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_hlos1_vote_gpu_smmu_clk = {
        .halt_reg = 0x5000,
        .halt_check = BRANCH_VOTED,
        .clkr = {
                .enable_reg = 0x5000,
                .enable_mask = BIT(0),
                .hw.init = &(struct clk_init_data){
                        .name = "gpu_cc_hlos1_vote_gpu_smmu_clk",
                        .ops = &clk_branch2_ops,
                },
        },
};

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

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

static struct clk_regmap *gpu_cc_sm6125_clocks[] = {
        [GPU_CC_CRC_AHB_CLK] = &gpu_cc_crc_ahb_clk.clkr,
        [GPU_CC_CX_APB_CLK] = &gpu_cc_cx_apb_clk.clkr,
        [GPU_CC_CX_GFX3D_CLK] = &gpu_cc_cx_gfx3d_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_PLL0_OUT_AUX2] = &gpu_cc_pll0_out_aux2.clkr,
        [GPU_CC_PLL1_OUT_AUX2] = &gpu_cc_pll1_out_aux2.clkr,
        [GPU_CC_SLEEP_CLK] = &gpu_cc_sleep_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_AHB_CLK] = &gpu_cc_ahb_clk.clkr,
        [GPU_CC_HLOS1_VOTE_GPU_SMMU_CLK] = &gpu_cc_hlos1_vote_gpu_smmu_clk.clkr,
};

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

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

static const struct qcom_cc_desc gpu_cc_sm6125_desc = {
        .config = &gpu_cc_sm6125_regmap_config,
        .clks = gpu_cc_sm6125_clocks,
        .num_clks = ARRAY_SIZE(gpu_cc_sm6125_clocks),
        .gdscs = gpucc_sm6125_gdscs,
        .num_gdscs = ARRAY_SIZE(gpucc_sm6125_gdscs),
};

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

static int gpu_cc_sm6125_probe(struct platform_device *pdev)
{
        struct regmap *regmap;

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

        clk_alpha_pll_configure(&gpu_cc_pll0_out_aux2, regmap, &gpu_pll0_config);
        clk_alpha_pll_configure(&gpu_cc_pll1_out_aux2, regmap, &gpu_pll1_config);

        /* Set recommended WAKEUP/SLEEP settings for the gpu_cc_cx_gmu_clk */
        qcom_branch_set_wakeup(regmap, gpu_cc_cx_gmu_clk, 0xf);
        qcom_branch_set_sleep(regmap, gpu_cc_cx_gmu_clk, 0xf);

        qcom_branch_set_force_mem_core(regmap, gpu_cc_gx_gfx3d_clk, true);
        qcom_branch_set_force_periph_on(regmap, gpu_cc_gx_gfx3d_clk, true);

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

static struct platform_driver gpu_cc_sm6125_driver = {
        .probe = gpu_cc_sm6125_probe,
        .driver = {
                .name = "gpucc-sm6125",
                .of_match_table = gpu_cc_sm6125_match_table,
        },
};
module_platform_driver(gpu_cc_sm6125_driver);

MODULE_DESCRIPTION("QTI GPUCC SM6125 Driver");
MODULE_LICENSE("GPL");