/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (c) 2019 BayLibre, SAS.
 * Author: Jerome Brunet <jbrunet@baylibre.com>
 */

#ifndef __MESON_CLK_PLL_H
#define __MESON_CLK_PLL_H

#include <linux/clk-provider.h>
#include <linux/regmap.h>
#include "parm.h"

struct pll_params_table {
	unsigned int	m;
	unsigned int	n;
	unsigned int	od;
	/* FIXME: Only C1 can be used for these two members, is it necessary? */
	const struct	reg_sequence *regs;
	unsigned int	regs_count;
};

struct pll_mult_range {
	unsigned int	min;
	unsigned int	max;
};

#define PLL_PARAMS(_m, _n)						\
	{								\
		.m		= (_m),					\
		.n		= (_n),					\
	}

#define PLL_PARAMS_OD(_m, _n, _od)						\
	{								\
		.m		= (_m),					\
		.n		= (_n),					\
		.od		= (_od),				\
	}

#define CLK_MESON_PLL_ROUND_CLOSEST			BIT(0)
#define CLK_MESON_PLL_NOINIT_ENABLED			BIT(1)
#define CLK_MESON_PLL_FIXED_FRAC_WEIGHT_PRECISION	BIT(2)
#define CLK_MESON_PLL_POWER_OF_TWO			BIT(3)
#define CLK_MESON_PLL_FIXED_N				BIT(4)
#define CLK_MESON_PLL_FIXED_EN0P5			BIT(5)
#define CLK_MESON_PLL_READ_ONLY				BIT(6)
#define CLK_MESON_PLL_RSTN				BIT(7)
#define CLK_MESON_PLL_L_RSTN				BIT(8)

struct meson_clk_pll_data {
	struct parm en;
	struct parm m;
	struct parm n;
	struct parm frac;
	struct parm l;
	struct parm rst;
	struct parm current_en;
	struct parm l_detect;
	struct parm l_rst;
	struct parm th; /* threshold */
	struct parm fl; /* force lock */
	struct parm od;
	/*for pcie*/
	struct parm pcie_hcsl;
	struct parm pcie_exen;
	const struct reg_sequence *init_regs;
	unsigned int init_count;
	const struct pll_params_table *table;
	const struct pll_mult_range *range;
	unsigned int od_max;
	unsigned int smc_id;
	u8 secid_disable;
	u8 secid;
	u16 flags;
	unsigned long saved_rate;
	int saved_is_enabled;
	struct reg_sequence *save_regs;
	unsigned int save_reg_count;
};

extern const struct clk_ops meson_clk_pll_ro_ops;
extern const struct clk_ops meson_clk_pll_ops;
extern const struct clk_ops meson_clk_pcie_pll_ops;
extern const struct clk_ops meson_secure_pll_v2_ops;
extern const struct clk_ops meson_clk_pll_v3_ops;

#endif /* __MESON_CLK_PLL_H */