Quelle  c3-pll.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Amlogic C3 PLL Controller Driver
 *
 * Copyright (c) 2023 Amlogic, inc.
 * Author: Chuan Liu <chuan.liu@amlogic.com>
 */

#include <linux/clk-provider.h>
#include <linux/platform_device.h>
#include "clk-regmap.h"
#include "clk-pll.h"
#include "meson-clkc-utils.h"
#include <dt-bindings/clock/amlogic,c3-pll-clkc.h>

#define ANACTRL_FIXPLL_CTRL4   0x50
#define ANACTRL_GP0PLL_CTRL0   0x80
#define ANACTRL_GP0PLL_CTRL1   0x84
#define ANACTRL_GP0PLL_CTRL2   0x88
#define ANACTRL_GP0PLL_CTRL3   0x8c
#define ANACTRL_GP0PLL_CTRL4   0x90
#define ANACTRL_GP0PLL_CTRL5   0x94
#define ANACTRL_GP0PLL_CTRL6   0x98
#define ANACTRL_HIFIPLL_CTRL0   0x100
#define ANACTRL_HIFIPLL_CTRL1   0x104
#define ANACTRL_HIFIPLL_CTRL2   0x108
#define ANACTRL_HIFIPLL_CTRL3   0x10c
#define ANACTRL_HIFIPLL_CTRL4   0x110
#define ANACTRL_HIFIPLL_CTRL5   0x114
#define ANACTRL_HIFIPLL_CTRL6   0x118
#define ANACTRL_MPLL_CTRL0   0x180
#define ANACTRL_MPLL_CTRL1   0x184
#define ANACTRL_MPLL_CTRL2   0x188
#define ANACTRL_MPLL_CTRL3   0x18c
#define ANACTRL_MPLL_CTRL4   0x190

static struct clk_regmap fclk_50m_en = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 0,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_50m_en",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_50m = {
 .mult = 1,
 .div = 40,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_50m",
  .ops = &clk_fixed_factor_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_50m_en.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div2_div = {
 .mult = 1,
 .div = 2,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div2_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div2 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 24,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div2",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div2_div.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div2p5_div = {
 .mult = 2,
 .div = 5,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div2p5_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div2p5 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 4,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div2p5",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div2p5_div.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div3_div = {
 .mult = 1,
 .div = 3,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div3_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div3 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 20,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div3",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div3_div.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div4_div = {
 .mult = 1,
 .div = 4,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div4_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div4 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 21,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div4",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div4_div.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div5_div = {
 .mult = 1,
 .div = 5,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div5_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div5 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 22,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div5",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div5_div.hw
  },
  .num_parents = 1,
 },
};

static struct clk_fixed_factor fclk_div7_div = {
 .mult = 1,
 .div = 7,
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div7_div",
  .ops = &clk_fixed_factor_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "fix"
  },
  .num_parents = 1,
 },
};

static struct clk_regmap fclk_div7 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_FIXPLL_CTRL4,
  .bit_idx = 23,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "fclk_div7",
  .ops = &clk_regmap_gate_ro_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &fclk_div7_div.hw
  },
  .num_parents = 1,
 },
};

static const struct reg_sequence c3_gp0_init_regs[] = {
 { .reg = ANACTRL_GP0PLL_CTRL2, .def = 0x0 },
 { .reg = ANACTRL_GP0PLL_CTRL3, .def = 0x48681c00 },
 { .reg = ANACTRL_GP0PLL_CTRL4,  .def = 0x88770290 },
 { .reg = ANACTRL_GP0PLL_CTRL5,  .def = 0x3927200a },
 { .reg = ANACTRL_GP0PLL_CTRL6, .def = 0x56540000 },
};

static const struct pll_mult_range c3_gp0_pll_mult_range = {
 .min = 125,
 .max = 250,
};

static struct clk_regmap gp0_pll_dco = {
 .data = &(struct meson_clk_pll_data) {
  .en = {
   .reg_off = ANACTRL_GP0PLL_CTRL0,
   .shift   = 28,
   .width   = 1,
  },
  .m = {
   .reg_off = ANACTRL_GP0PLL_CTRL0,
   .shift   = 0,
   .width   = 9,
  },
  .frac = {
   .reg_off = ANACTRL_GP0PLL_CTRL1,
   .shift   = 0,
   .width   = 19,
  },
  .n = {
   .reg_off = ANACTRL_GP0PLL_CTRL0,
   .shift   = 10,
   .width   = 5,
  },
  .l = {
   .reg_off = ANACTRL_GP0PLL_CTRL0,
   .shift   = 31,
   .width   = 1,
  },
  .rst = {
   .reg_off = ANACTRL_GP0PLL_CTRL0,
   .shift   = 29,
   .width   = 1,
  },
  .range = &c3_gp0_pll_mult_range,
  .init_regs = c3_gp0_init_regs,
  .init_count = ARRAY_SIZE(c3_gp0_init_regs),
 },
 .hw.init = &(struct clk_init_data) {
  .name = "gp0_pll_dco",
  .ops = &meson_clk_pll_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "top",
  },
  .num_parents = 1,
 },
};

/* The maximum frequency divider supports is 32, not 128(2^7) */
static const struct clk_div_table c3_gp0_pll_od_table[] = {
 { 0,  1 },
 { 1,  2 },
 { 2,  4 },
 { 3,  8 },
 { 4, 16 },
 { 5, 32 },
 { /* sentinel */ }
};

static struct clk_regmap gp0_pll = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_GP0PLL_CTRL0,
  .shift = 16,
  .width = 3,
  .table = c3_gp0_pll_od_table,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "gp0_pll",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &gp0_pll_dco.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static const struct reg_sequence c3_hifi_init_regs[] = {
 { .reg = ANACTRL_HIFIPLL_CTRL2, .def = 0x0 },
 { .reg = ANACTRL_HIFIPLL_CTRL3, .def = 0x6a285c00 },
 { .reg = ANACTRL_HIFIPLL_CTRL4, .def = 0x65771290 },
 { .reg = ANACTRL_HIFIPLL_CTRL5, .def = 0x3927200a },
 { .reg = ANACTRL_HIFIPLL_CTRL6, .def = 0x56540000 },
};

static struct clk_regmap hifi_pll_dco = {
 .data = &(struct meson_clk_pll_data) {
  .en = {
   .reg_off = ANACTRL_HIFIPLL_CTRL0,
   .shift   = 28,
   .width   = 1,
  },
  .m = {
   .reg_off = ANACTRL_HIFIPLL_CTRL0,
   .shift   = 0,
   .width   = 8,
  },
  .frac = {
   .reg_off = ANACTRL_HIFIPLL_CTRL1,
   .shift   = 0,
   .width   = 19,
  },
  .n = {
   .reg_off = ANACTRL_HIFIPLL_CTRL0,
   .shift   = 10,
   .width   = 5,
  },
  .l = {
   .reg_off = ANACTRL_HIFIPLL_CTRL0,
   .shift   = 31,
   .width   = 1,
  },
  .rst = {
   .reg_off = ANACTRL_HIFIPLL_CTRL0,
   .shift   = 29,
   .width   = 1,
  },
  .range = &c3_gp0_pll_mult_range,
  .init_regs = c3_hifi_init_regs,
  .init_count = ARRAY_SIZE(c3_hifi_init_regs),
  .frac_max = 100000,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "hifi_pll_dco",
  .ops = &meson_clk_pll_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "top",
  },
  .num_parents = 1,
 },
};

static struct clk_regmap hifi_pll = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_HIFIPLL_CTRL0,
  .shift = 16,
  .width = 2,
  .flags = CLK_DIVIDER_POWER_OF_TWO,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "hifi_pll",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &hifi_pll_dco.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static const struct reg_sequence c3_mclk_init_regs[] = {
 { .reg = ANACTRL_MPLL_CTRL1, .def = 0x1420500f },
 { .reg = ANACTRL_MPLL_CTRL2, .def = 0x00023041 },
 { .reg = ANACTRL_MPLL_CTRL3, .def = 0x18180000 },
 { .reg = ANACTRL_MPLL_CTRL2, .def = 0x00023001 }
};

static const struct pll_mult_range c3_mclk_pll_mult_range = {
 .min = 67,
 .max = 133,
};

static struct clk_regmap mclk_pll_dco = {
 .data = &(struct meson_clk_pll_data) {
  .en = {
   .reg_off = ANACTRL_MPLL_CTRL0,
   .shift   = 28,
   .width   = 1,
  },
  .m = {
   .reg_off = ANACTRL_MPLL_CTRL0,
   .shift   = 0,
   .width   = 8,
  },
  .n = {
   .reg_off = ANACTRL_MPLL_CTRL0,
   .shift   = 16,
   .width   = 5,
  },
  .l = {
   .reg_off = ANACTRL_MPLL_CTRL0,
   .shift   = 31,
   .width   = 1,
  },
  .rst = {
   .reg_off = ANACTRL_MPLL_CTRL0,
   .shift   = 29,
   .width   = 1,
  },
  .range = &c3_mclk_pll_mult_range,
  .init_regs = c3_mclk_init_regs,
  .init_count = ARRAY_SIZE(c3_mclk_init_regs),
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk_pll_dco",
  .ops = &meson_clk_pll_ops,
  .parent_data = &(const struct clk_parent_data) {
   .fw_name = "mclk",
  },
  .num_parents = 1,
 },
};

static const struct clk_div_table c3_mpll_od_table[] = {
 { 0,  1 },
 { 1,  2 },
 { 2,  4 },
 { 3,  8 },
 { 4, 16 },
 { /* sentinel */ }
};

static struct clk_regmap mclk_pll_od = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_MPLL_CTRL0,
  .shift = 12,
  .width = 3,
  .table = c3_mpll_od_table,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk_pll_od",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk_pll_dco.hw },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

/* both value 0 and 1 gives divide the input rate by one */
static struct clk_regmap mclk_pll = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .shift = 16,
  .width = 5,
  .flags = CLK_DIVIDER_ONE_BASED | CLK_DIVIDER_ALLOW_ZERO,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk_pll",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk_pll_od.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static const struct clk_parent_data mclk_parent[] = {
 { .hw = &mclk_pll.hw },
 { .fw_name = "mclk" },
 { .hw = &fclk_50m.hw }
};

static struct clk_regmap mclk0_sel = {
 .data = &(struct clk_regmap_mux_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .mask = 0x3,
  .shift = 4,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk0_sel",
  .ops = &clk_regmap_mux_ops,
  .parent_data = mclk_parent,
  .num_parents = ARRAY_SIZE(mclk_parent),
 },
};

static struct clk_regmap mclk0_div_en = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .bit_idx = 1,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk0_div_en",
  .ops = &clk_regmap_gate_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk0_sel.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_regmap mclk0_div = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .shift = 2,
  .width = 1,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk0_div",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk0_div_en.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_regmap mclk0 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .bit_idx = 0,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk0",
  .ops = &clk_regmap_gate_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk0_div.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_regmap mclk1_sel = {
 .data = &(struct clk_regmap_mux_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .mask = 0x3,
  .shift = 12,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk1_sel",
  .ops = &clk_regmap_mux_ops,
  .parent_data = mclk_parent,
  .num_parents = ARRAY_SIZE(mclk_parent),
 },
};

static struct clk_regmap mclk1_div_en = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .bit_idx = 9,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk1_div_en",
  .ops = &clk_regmap_gate_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk1_sel.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_regmap mclk1_div = {
 .data = &(struct clk_regmap_div_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .shift = 10,
  .width = 1,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk1_div",
  .ops = &clk_regmap_divider_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk1_div_en.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_regmap mclk1 = {
 .data = &(struct clk_regmap_gate_data) {
  .offset = ANACTRL_MPLL_CTRL4,
  .bit_idx = 8,
 },
 .hw.init = &(struct clk_init_data) {
  .name = "mclk1",
  .ops = &clk_regmap_gate_ops,
  .parent_hws = (const struct clk_hw *[]) {
   &mclk1_div.hw
  },
  .num_parents = 1,
  .flags = CLK_SET_RATE_PARENT,
 },
};

static struct clk_hw *c3_pll_hw_clks[] = {
 [CLKID_FCLK_50M_EN] = &fclk_50m_en.hw,
 [CLKID_FCLK_50M] = &fclk_50m.hw,
 [CLKID_FCLK_DIV2_DIV] = &fclk_div2_div.hw,
 [CLKID_FCLK_DIV2] = &fclk_div2.hw,
 [CLKID_FCLK_DIV2P5_DIV] = &fclk_div2p5_div.hw,
 [CLKID_FCLK_DIV2P5] = &fclk_div2p5.hw,
 [CLKID_FCLK_DIV3_DIV] = &fclk_div3_div.hw,
 [CLKID_FCLK_DIV3] = &fclk_div3.hw,
 [CLKID_FCLK_DIV4_DIV] = &fclk_div4_div.hw,
 [CLKID_FCLK_DIV4] = &fclk_div4.hw,
 [CLKID_FCLK_DIV5_DIV] = &fclk_div5_div.hw,
 [CLKID_FCLK_DIV5] = &fclk_div5.hw,
 [CLKID_FCLK_DIV7_DIV] = &fclk_div7_div.hw,
 [CLKID_FCLK_DIV7] = &fclk_div7.hw,
 [CLKID_GP0_PLL_DCO] = &gp0_pll_dco.hw,
 [CLKID_GP0_PLL]  = &gp0_pll.hw,
 [CLKID_HIFI_PLL_DCO] = &hifi_pll_dco.hw,
 [CLKID_HIFI_PLL] = &hifi_pll.hw,
 [CLKID_MCLK_PLL_DCO] = &mclk_pll_dco.hw,
 [CLKID_MCLK_PLL_OD] = &mclk_pll_od.hw,
 [CLKID_MCLK_PLL] = &mclk_pll.hw,
 [CLKID_MCLK0_SEL] = &mclk0_sel.hw,
 [CLKID_MCLK0_SEL_EN] = &mclk0_div_en.hw,
 [CLKID_MCLK0_DIV] = &mclk0_div.hw,
 [CLKID_MCLK0]  = &mclk0.hw,
 [CLKID_MCLK1_SEL] = &mclk1_sel.hw,
 [CLKID_MCLK1_SEL_EN] = &mclk1_div_en.hw,
 [CLKID_MCLK1_DIV] = &mclk1_div.hw,
 [CLKID_MCLK1]  = &mclk1.hw
};

static const struct regmap_config clkc_regmap_config = {
 .reg_bits       = 32,
 .val_bits       = 32,
 .reg_stride     = 4,
 .max_register   = ANACTRL_MPLL_CTRL4,
};

static struct meson_clk_hw_data c3_pll_clks = {
 .hws = c3_pll_hw_clks,
 .num = ARRAY_SIZE(c3_pll_hw_clks),
};

static int c3_pll_probe(struct platform_device *pdev)
{
 struct device *dev = &pdev->dev;
 struct regmap *regmap;
 void __iomem *base;
 int clkid, ret;

 base = devm_platform_ioremap_resource(pdev, 0);
 if (IS_ERR(base))
  return PTR_ERR(base);

 regmap = devm_regmap_init_mmio(dev, base, &clkc_regmap_config);
 if (IS_ERR(regmap))
  return PTR_ERR(regmap);

 for (clkid = 0; clkid < c3_pll_clks.num; clkid++) {
  /* array might be sparse */
  if (!c3_pll_clks.hws[clkid])
   continue;

  ret = devm_clk_hw_register(dev, c3_pll_clks.hws[clkid]);
  if (ret) {
   dev_err(dev, "Clock registration failed\n");
   return ret;
  }
 }

 return devm_of_clk_add_hw_provider(dev, meson_clk_hw_get,
        &c3_pll_clks);
}

static const struct of_device_id c3_pll_clkc_match_table[] = {
 {
  .compatible = "amlogic,c3-pll-clkc",
 },
 {}
};
MODULE_DEVICE_TABLE(of, c3_pll_clkc_match_table);

static struct platform_driver c3_pll_driver = {
 .probe  = c3_pll_probe,
 .driver  = {
  .name = "c3-pll-clkc",
  .of_match_table = c3_pll_clkc_match_table,
 },
};
module_platform_driver(c3_pll_driver);

MODULE_DESCRIPTION("Amlogic C3 PLL Clock Controller driver");
MODULE_AUTHOR("Chuan Liu ");
MODULE_LICENSE("GPL");
MODULE_IMPORT_NS("CLK_MESON");