root/drivers/clk/renesas/r8a779f0-cpg-mssr.c
// SPDX-License-Identifier: GPL-2.0
/*
 * r8a779f0 Clock Pulse Generator / Module Standby and Software Reset
 *
 * Copyright (C) 2021 Renesas Electronics Corp.
 *
 * Based on r8a779a0-cpg-mssr.c
 */

#include <linux/bitfield.h>
#include <linux/clk.h>
#include <linux/clk-provider.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/kernel.h>
#include <linux/soc/renesas/rcar-rst.h>

#include <dt-bindings/clock/r8a779f0-cpg-mssr.h>

#include "renesas-cpg-mssr.h"
#include "rcar-gen4-cpg.h"

enum clk_ids {
        /* Core Clock Outputs exported to DT */
        LAST_DT_CORE_CLK = R8A779F0_CLK_R,

        /* External Input Clocks */
        CLK_EXTAL,
        CLK_EXTALR,

        /* Internal Core Clocks */
        CLK_MAIN,
        CLK_PLL1,
        CLK_PLL2,
        CLK_PLL3,
        CLK_PLL5,
        CLK_PLL6,
        CLK_PLL1_DIV2,
        CLK_PLL2_DIV2,
        CLK_PLL3_DIV2,
        CLK_PLL5_DIV2,
        CLK_PLL5_DIV4,
        CLK_PLL6_DIV2,
        CLK_S0,
        CLK_SASYNCPER,
        CLK_SDSRC,
        CLK_RPCSRC,
        CLK_OCO,

        /* Module Clocks */
        MOD_CLK_BASE
};

static const struct cpg_core_clk r8a779f0_core_clks[] __initconst = {
        /* External Clock Inputs */
        DEF_INPUT("extal",      CLK_EXTAL),
        DEF_INPUT("extalr",     CLK_EXTALR),

        /* Internal Core Clocks */
        DEF_BASE(".main", CLK_MAIN,     CLK_TYPE_GEN4_MAIN,     CLK_EXTAL),
        DEF_GEN4_PLL_F9_24(".pll1", 1,  CLK_PLL1,               CLK_MAIN),
        DEF_GEN4_PLL_V9_24(".pll2", 2,  CLK_PLL2,               CLK_MAIN),
        DEF_GEN4_PLL_V9_24(".pll3", 3,  CLK_PLL3,               CLK_MAIN),
        DEF_BASE(".pll5", CLK_PLL5,     CLK_TYPE_GEN4_PLL5,     CLK_MAIN),
        DEF_GEN4_PLL_V9_24(".pll6", 6,  CLK_PLL6,               CLK_MAIN),

        DEF_FIXED(".pll1_div2", CLK_PLL1_DIV2,  CLK_PLL1,       2, 1),
        DEF_FIXED(".pll2_div2", CLK_PLL2_DIV2,  CLK_PLL2,       2, 1),
        DEF_FIXED(".pll3_div2", CLK_PLL3_DIV2,  CLK_PLL3,       2, 1),
        DEF_FIXED(".pll5_div2", CLK_PLL5_DIV2,  CLK_PLL5,       2, 1),
        DEF_FIXED(".pll5_div4", CLK_PLL5_DIV4,  CLK_PLL5_DIV2,  2, 1),
        DEF_FIXED(".pll6_div2", CLK_PLL6_DIV2,  CLK_PLL6,       2, 1),
        DEF_FIXED(".s0",        CLK_S0,         CLK_PLL1_DIV2,  2, 1),

        DEF_FIXED(".sasyncper", CLK_SASYNCPER,  CLK_PLL5_DIV4,  3, 1),
        DEF_BASE(".sdsrc",      CLK_SDSRC,      CLK_TYPE_GEN4_SDSRC, CLK_PLL5),
        DEF_RATE(".oco",        CLK_OCO,        32768),

        DEF_BASE(".rpcsrc",     CLK_RPCSRC,     CLK_TYPE_GEN4_RPCSRC, CLK_PLL5),

        /* Core Clock Outputs */
        DEF_GEN4_Z("z0",        R8A779F0_CLK_Z0,        CLK_TYPE_GEN4_Z,        CLK_PLL2,       2, 0),
        DEF_GEN4_Z("z1",        R8A779F0_CLK_Z1,        CLK_TYPE_GEN4_Z,        CLK_PLL2,       2, 8),
        DEF_FIXED("s0d2",       R8A779F0_CLK_S0D2,      CLK_S0,         2, 1),
        DEF_FIXED("s0d3",       R8A779F0_CLK_S0D3,      CLK_S0,         3, 1),
        DEF_FIXED("s0d4",       R8A779F0_CLK_S0D4,      CLK_S0,         4, 1),
        DEF_FIXED("cl16m",      R8A779F0_CLK_CL16M,     CLK_S0,         48, 1),
        DEF_FIXED("s0d2_mm",    R8A779F0_CLK_S0D2_MM,   CLK_S0,         2, 1),
        DEF_FIXED("s0d3_mm",    R8A779F0_CLK_S0D3_MM,   CLK_S0,         3, 1),
        DEF_FIXED("s0d4_mm",    R8A779F0_CLK_S0D4_MM,   CLK_S0,         4, 1),
        DEF_FIXED("cl16m_mm",   R8A779F0_CLK_CL16M_MM,  CLK_S0,         48, 1),
        DEF_FIXED("s0d2_rt",    R8A779F0_CLK_S0D2_RT,   CLK_S0,         2, 1),
        DEF_FIXED("s0d3_rt",    R8A779F0_CLK_S0D3_RT,   CLK_S0,         3, 1),
        DEF_FIXED("s0d4_rt",    R8A779F0_CLK_S0D4_RT,   CLK_S0,         4, 1),
        DEF_FIXED("s0d6_rt",    R8A779F0_CLK_S0D6_RT,   CLK_S0,         6, 1),
        DEF_FIXED("cl16m_rt",   R8A779F0_CLK_CL16M_RT,  CLK_S0,         48, 1),
        DEF_FIXED("s0d3_per",   R8A779F0_CLK_S0D3_PER,  CLK_S0,         3, 1),
        DEF_FIXED("s0d6_per",   R8A779F0_CLK_S0D6_PER,  CLK_S0,         6, 1),
        DEF_FIXED("s0d12_per",  R8A779F0_CLK_S0D12_PER, CLK_S0,         12, 1),
        DEF_FIXED("s0d24_per",  R8A779F0_CLK_S0D24_PER, CLK_S0,         24, 1),
        DEF_FIXED("cl16m_per",  R8A779F0_CLK_CL16M_PER, CLK_S0,         48, 1),
        DEF_FIXED("s0d2_hsc",   R8A779F0_CLK_S0D2_HSC,  CLK_S0,         2, 1),
        DEF_FIXED("s0d3_hsc",   R8A779F0_CLK_S0D3_HSC,  CLK_S0,         3, 1),
        DEF_FIXED("s0d4_hsc",   R8A779F0_CLK_S0D4_HSC,  CLK_S0,         4, 1),
        DEF_FIXED("s0d6_hsc",   R8A779F0_CLK_S0D6_HSC,  CLK_S0,         6, 1),
        DEF_FIXED("s0d12_hsc",  R8A779F0_CLK_S0D12_HSC, CLK_S0,         12, 1),
        DEF_FIXED("cl16m_hsc",  R8A779F0_CLK_CL16M_HSC, CLK_S0,         48, 1),
        DEF_FIXED("s0d2_cc",    R8A779F0_CLK_S0D2_CC,   CLK_S0,         2, 1),
        DEF_FIXED("rsw2",       R8A779F0_CLK_RSW2,      CLK_PLL5_DIV2,  5, 1),
        DEF_FIXED("cbfusa",     R8A779F0_CLK_CBFUSA,    CLK_EXTAL,      2, 1),
        DEF_FIXED("cpex",       R8A779F0_CLK_CPEX,      CLK_EXTAL,      2, 1),

        DEF_FIXED("sasyncrt",   R8A779F0_CLK_SASYNCRT,  CLK_PLL5_DIV4,  48, 1),
        DEF_FIXED("sasyncperd1",R8A779F0_CLK_SASYNCPERD1, CLK_SASYNCPER,1, 1),
        DEF_FIXED("sasyncperd2",R8A779F0_CLK_SASYNCPERD2, CLK_SASYNCPER,2, 1),
        DEF_FIXED("sasyncperd4",R8A779F0_CLK_SASYNCPERD4, CLK_SASYNCPER,4, 1),

        DEF_GEN4_SDH("sd0h",    R8A779F0_CLK_SD0H,      CLK_SDSRC,         CPG_SD0CKCR),
        DEF_GEN4_SD("sd0",      R8A779F0_CLK_SD0,       R8A779F0_CLK_SD0H, CPG_SD0CKCR),

        DEF_BASE("rpc",         R8A779F0_CLK_RPC,       CLK_TYPE_GEN4_RPC, CLK_RPCSRC),
        DEF_BASE("rpcd2",       R8A779F0_CLK_RPCD2,     CLK_TYPE_GEN4_RPCD2, R8A779F0_CLK_RPC),

        DEF_DIV6P1("mso",       R8A779F0_CLK_MSO,       CLK_PLL5_DIV4,  CPG_MSOCKCR),

        DEF_GEN4_OSC("osc",     R8A779F0_CLK_OSC,       CLK_EXTAL,      8),
        DEF_GEN4_MDSEL("r",     R8A779F0_CLK_R, 29, CLK_EXTALR, 1, CLK_OCO, 1),
};

static const struct mssr_mod_clk r8a779f0_mod_clks[] __initconst = {
        DEF_MOD("hscif0",       514,    R8A779F0_CLK_SASYNCPERD1),
        DEF_MOD("hscif1",       515,    R8A779F0_CLK_SASYNCPERD1),
        DEF_MOD("hscif2",       516,    R8A779F0_CLK_SASYNCPERD1),
        DEF_MOD("hscif3",       517,    R8A779F0_CLK_SASYNCPERD1),
        DEF_MOD("i2c0",         518,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("i2c1",         519,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("i2c2",         520,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("i2c3",         521,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("i2c4",         522,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("i2c5",         523,    R8A779F0_CLK_S0D6_PER),
        DEF_MOD("msiof0",       618,    R8A779F0_CLK_MSO),
        DEF_MOD("msiof1",       619,    R8A779F0_CLK_MSO),
        DEF_MOD("msiof2",       620,    R8A779F0_CLK_MSO),
        DEF_MOD("msiof3",       621,    R8A779F0_CLK_MSO),
        DEF_MOD("pcie0",        624,    R8A779F0_CLK_S0D2),
        DEF_MOD("pcie1",        625,    R8A779F0_CLK_S0D2),
        DEF_MOD("scif0",        702,    R8A779F0_CLK_SASYNCPERD4),
        DEF_MOD("scif1",        703,    R8A779F0_CLK_SASYNCPERD4),
        DEF_MOD("scif3",        704,    R8A779F0_CLK_SASYNCPERD4),
        DEF_MOD("scif4",        705,    R8A779F0_CLK_SASYNCPERD4),
        DEF_MOD("sdhi0",        706,    R8A779F0_CLK_SD0),
        DEF_MOD("sys-dmac0",    709,    R8A779F0_CLK_S0D3_PER),
        DEF_MOD("sys-dmac1",    710,    R8A779F0_CLK_S0D3_PER),
        DEF_MOD("tmu0",         713,    R8A779F0_CLK_SASYNCRT),
        DEF_MOD("tmu1",         714,    R8A779F0_CLK_SASYNCPERD2),
        DEF_MOD("tmu2",         715,    R8A779F0_CLK_SASYNCPERD2),
        DEF_MOD("tmu3",         716,    R8A779F0_CLK_SASYNCPERD2),
        DEF_MOD("tmu4",         717,    R8A779F0_CLK_SASYNCPERD2),
        DEF_MOD("wdt",          907,    R8A779F0_CLK_R),
        DEF_MOD("cmt0",         910,    R8A779F0_CLK_R),
        DEF_MOD("cmt1",         911,    R8A779F0_CLK_R),
        DEF_MOD("cmt2",         912,    R8A779F0_CLK_R),
        DEF_MOD("cmt3",         913,    R8A779F0_CLK_R),
        DEF_MOD("pfc0",         915,    R8A779F0_CLK_CPEX),
        DEF_MOD("tsc",          919,    R8A779F0_CLK_CL16M),
        DEF_MOD("rswitch2",     1505,   R8A779F0_CLK_RSW2),
        DEF_MOD("ether-serdes", 1506,   R8A779F0_CLK_S0D2_HSC),
        DEF_MOD("ufs",          1514,   R8A779F0_CLK_S0D4_HSC),
};

static const unsigned int r8a779f0_crit_mod_clks[] __initconst = {
        MOD_CLK_ID(907),        /* WDT */
};

/*
 * CPG Clock Data
 */
/*
 *   MD  EXTAL          PLL1    PLL2    PLL3    PLL4    PLL5    PLL6    OSC
 * 14 13 (MHz)
 * ------------------------------------------------------------------------
 * 0  0  16    / 1      x200    x150    x200    n/a     x200    x134    /15
 * 0  1  20    / 1      x160    x120    x160    n/a     x160    x106    /19
 * 1  0  Prohibited setting
 * 1  1  40    / 2      x160    x120    x160    n/a     x160    x106    /38
 */
#define CPG_PLL_CONFIG_INDEX(md)        ((((md) & BIT(14)) >> 13) | \
                                         (((md) & BIT(13)) >> 13))

static const struct rcar_gen4_cpg_pll_config cpg_pll_configs[4] __initconst = {
        /* EXTAL div    PLL1 mult/div   PLL5 mult/div   OSC prediv */
        { 1,            200,    1,      200,    1,      15,     },
        { 1,            160,    1,      160,    1,      19,     },
        { 0,            0,      0,      0,      0,      0,      },
        { 2,            160,    1,      160,    1,      38,     },
};

static int __init r8a779f0_cpg_mssr_init(struct device *dev)
{
        const struct rcar_gen4_cpg_pll_config *cpg_pll_config;
        u32 cpg_mode;
        int error;

        error = rcar_rst_read_mode_pins(&cpg_mode);
        if (error)
                return error;

        cpg_pll_config = &cpg_pll_configs[CPG_PLL_CONFIG_INDEX(cpg_mode)];
        if (!cpg_pll_config->extal_div) {
                dev_err(dev, "Prohibited setting (cpg_mode=0x%x)\n", cpg_mode);
                return -EINVAL;
        }

        return rcar_gen4_cpg_init(cpg_pll_config, CLK_EXTALR, cpg_mode);
}

const struct cpg_mssr_info r8a779f0_cpg_mssr_info __initconst = {
        /* Core Clocks */
        .core_clks = r8a779f0_core_clks,
        .num_core_clks = ARRAY_SIZE(r8a779f0_core_clks),
        .last_dt_core_clk = LAST_DT_CORE_CLK,
        .num_total_core_clks = MOD_CLK_BASE,

        /* Module Clocks */
        .mod_clks = r8a779f0_mod_clks,
        .num_mod_clks = ARRAY_SIZE(r8a779f0_mod_clks),
        .num_hw_mod_clks = 28 * 32,

        /* Critical Module Clocks */
        .crit_mod_clks = r8a779f0_crit_mod_clks,
        .num_crit_mod_clks = ARRAY_SIZE(r8a779f0_crit_mod_clks),

        /* Callbacks */
        .init = r8a779f0_cpg_mssr_init,
        .cpg_clk_register = rcar_gen4_cpg_clk_register,

        .reg_layout = CLK_REG_LAYOUT_RCAR_GEN4,
};