/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2013 Samsung Electronics Co., Ltd.
 * Copyright (c) 2013 Linaro Ltd.
 * Author: Thomas Abraham <thomas.ab@samsung.com>
 *
 * Common Clock Framework support for all Samsung platforms
*/

#ifndef __SAMSUNG_CLK_H
#define __SAMSUNG_CLK_H

#include <linux/clk-provider.h>
#include <linux/mod_devicetable.h>
#include <linux/regmap.h>
#include "clk-pll.h"
#include "clk-cpu.h"

/**
 * struct samsung_clk_provider - information about clock provider
 * @reg_base: virtual address for the register base
 * @dev: clock provider device needed for runtime PM
 * @sysreg: syscon regmap for clock-provider sysreg controller
 * @lock: maintains exclusion between callbacks for a given clock-provider
 * @auto_clock_gate: enable auto clk mode for all clocks in clock-provider
 * @gate_dbg_offset: gate debug reg offset. Used for all gates in auto clk mode
 * @option_offset: option reg offset. Enables auto mode for clock-provider
 * @drcg_offset: dynamic root clk gate enable register offset in sysreg
 * @memclk_offset: memclk enable register offset in sysreg
 * @clk_data: holds clock related data like clk_hw* and number of clocks
 */
struct samsung_clk_provider {
        void __iomem *reg_base;
        struct device *dev;
        struct regmap *sysreg;
        spinlock_t lock;
        bool auto_clock_gate;
        u32 gate_dbg_offset;
        u32 option_offset;
        u32 drcg_offset;
        u32 memclk_offset;
        /* clk_data must be the last entry due to variable length 'hws' array */
        struct clk_hw_onecell_data clk_data;
};

/**
 * struct samsung_clock_alias - information about mux clock
 * @id: platform specific id of the clock
 * @dev_name: name of the device to which this clock belongs
 * @alias: optional clock alias name to be assigned to this clock
 */
struct samsung_clock_alias {
        unsigned int            id;
        const char              *dev_name;
        const char              *alias;
};

#define ALIAS(_id, dname, a)    \
        {                                                       \
                .id             = _id,                          \
                .dev_name       = dname,                        \
                .alias          = a,                            \
        }

#define MHZ (1000 * 1000)

/**
 * struct samsung_fixed_rate_clock - information about fixed-rate clock
 * @id: platform specific id of the clock
 * @name: name of this fixed-rate clock
 * @parent_name: optional parent clock name
 * @flags: optional fixed-rate clock flags
 * @fixed_rate: fixed clock rate of this clock
 */
struct samsung_fixed_rate_clock {
        unsigned int            id;
        char                    *name;
        const char              *parent_name;
        unsigned long           flags;
        unsigned long           fixed_rate;
};

#define FRATE(_id, cname, pname, f, frate)              \
        {                                               \
                .id             = _id,                  \
                .name           = cname,                \
                .parent_name    = pname,                \
                .flags          = f,                    \
                .fixed_rate     = frate,                \
        }

/**
 * struct samsung_fixed_factor_clock - information about fixed-factor clock
 * @id: platform specific id of the clock
 * @name: name of this fixed-factor clock
 * @parent_name: parent clock name
 * @mult: fixed multiplication factor
 * @div: fixed division factor
 * @flags: optional fixed-factor clock flags
 */
struct samsung_fixed_factor_clock {
        unsigned int            id;
        char                    *name;
        const char              *parent_name;
        unsigned long           mult;
        unsigned long           div;
        unsigned long           flags;
};

#define FFACTOR(_id, cname, pname, m, d, f)             \
        {                                               \
                .id             = _id,                  \
                .name           = cname,                \
                .parent_name    = pname,                \
                .mult           = m,                    \
                .div            = d,                    \
                .flags          = f,                    \
        }

/**
 * struct samsung_mux_clock - information about mux clock
 * @id: platform specific id of the clock
 * @name: name of this mux clock
 * @parent_names: array of pointer to parent clock names
 * @num_parents: number of parents listed in @parent_names
 * @flags: optional flags for basic clock
 * @offset: offset of the register for configuring the mux
 * @shift: starting bit location of the mux control bit-field in @reg
 * @width: width of the mux control bit-field in @reg
 * @mux_flags: flags for mux-type clock
 */
struct samsung_mux_clock {
        unsigned int            id;
        const char              *name;
        const char              *const *parent_names;
        u8                      num_parents;
        unsigned long           flags;
        unsigned long           offset;
        u8                      shift;
        u8                      width;
        u8                      mux_flags;
};

#define __MUX(_id, cname, pnames, o, s, w, f, mf)               \
        {                                                       \
                .id             = _id,                          \
                .name           = cname,                        \
                .parent_names   = pnames,                       \
                .num_parents    = ARRAY_SIZE(pnames),           \
                .flags          = f,                            \
                .offset         = o,                            \
                .shift          = s,                            \
                .width          = w,                            \
                .mux_flags      = mf,                           \
        }

#define MUX(_id, cname, pnames, o, s, w)                        \
        __MUX(_id, cname, pnames, o, s, w, CLK_SET_RATE_NO_REPARENT, 0)

#define MUX_F(_id, cname, pnames, o, s, w, f, mf)               \
        __MUX(_id, cname, pnames, o, s, w, (f) | CLK_SET_RATE_NO_REPARENT, mf)

/* Used by MUX clocks where reparenting on clock rate change is allowed. */
#define nMUX(_id, cname, pnames, o, s, w)                       \
        __MUX(_id, cname, pnames, o, s, w, 0, 0)

#define nMUX_F(_id, cname, pnames, o, s, w, f, mf)              \
        __MUX(_id, cname, pnames, o, s, w, f, mf)

/**
 * struct samsung_div_clock - information about div clock
 * @id: platform specific id of the clock
 * @name: name of this div clock
 * @parent_name: name of the parent clock
 * @flags: optional flags for basic clock
 * @offset: offset of the register for configuring the div
 * @shift: starting bit location of the div control bit-field in @reg
 * @width: width of the bitfield
 * @div_flags: flags for div-type clock
 * @table: array of divider/value pairs ending with a div set to 0
 */
struct samsung_div_clock {
        unsigned int            id;
        const char              *name;
        const char              *parent_name;
        unsigned long           flags;
        unsigned long           offset;
        u8                      shift;
        u8                      width;
        u8                      div_flags;
        struct clk_div_table    *table;
};

#define __DIV(_id, cname, pname, o, s, w, f, df, t)     \
        {                                                       \
                .id             = _id,                          \
                .name           = cname,                        \
                .parent_name    = pname,                        \
                .flags          = f,                            \
                .offset         = o,                            \
                .shift          = s,                            \
                .width          = w,                            \
                .div_flags      = df,                           \
                .table          = t,                            \
        }

#define DIV(_id, cname, pname, o, s, w)                         \
        __DIV(_id, cname, pname, o, s, w, 0, 0, NULL)

#define DIV_F(_id, cname, pname, o, s, w, f, df)                \
        __DIV(_id, cname, pname, o, s, w, f, df, NULL)

#define DIV_T(_id, cname, pname, o, s, w, t)                    \
        __DIV(_id, cname, pname, o, s, w, 0, 0, t)

/**
 * struct samsung_gate_clock - information about gate clock
 * @id: platform specific id of the clock
 * @name: name of this gate clock
 * @parent_name: name of the parent clock
 * @flags: optional flags for basic clock
 * @offset: offset of the register for configuring the gate
 * @bit_idx: bit index of the gate control bit-field in @reg
 * @gate_flags: flags for gate-type clock
 */
struct samsung_gate_clock {
        unsigned int            id;
        const char              *name;
        const char              *parent_name;
        unsigned long           flags;
        unsigned long           offset;
        u8                      bit_idx;
        u8                      gate_flags;
};

#define __GATE(_id, cname, pname, o, b, f, gf)                  \
        {                                                       \
                .id             = _id,                          \
                .name           = cname,                        \
                .parent_name    = pname,                        \
                .flags          = f,                            \
                .offset         = o,                            \
                .bit_idx        = b,                            \
                .gate_flags     = gf,                           \
        }

#define GATE(_id, cname, pname, o, b, f, gf)                    \
        __GATE(_id, cname, pname, o, b, f, gf)

#define PNAME(x) static const char * const x[] __initconst

/**
 * struct samsung_clk_reg_dump - register dump of clock controller registers
 * @offset: clock register offset from the controller base address
 * @value: the value to be register at offset
 */
struct samsung_clk_reg_dump {
        u32     offset;
        u32     value;
};

/**
 * struct samsung_pll_clock - information about pll clock
 * @id: platform specific id of the clock
 * @name: name of this pll clock
 * @parent_name: name of the parent clock
 * @flags: optional flags for basic clock
 * @con_offset: offset of the register for configuring the PLL
 * @lock_offset: offset of the register for locking the PLL
 * @type: type of PLL to be registered
 * @rate_table: array of PLL settings for possible PLL rates
 */
struct samsung_pll_clock {
        unsigned int            id;
        const char              *name;
        const char              *parent_name;
        unsigned long           flags;
        int                     con_offset;
        int                     lock_offset;
        enum samsung_pll_type   type;
        const struct samsung_pll_rate_table *rate_table;
};

#define __PLL(_typ, _id, _name, _pname, _flags, _lock, _con, _rtable)   \
        {                                                               \
                .id             = _id,                                  \
                .type           = _typ,                                 \
                .name           = _name,                                \
                .parent_name    = _pname,                               \
                .flags          = _flags,                               \
                .con_offset     = _con,                                 \
                .lock_offset    = _lock,                                \
                .rate_table     = _rtable,                              \
        }

#define PLL(_typ, _id, _name, _pname, _lock, _con, _rtable)     \
        __PLL(_typ, _id, _name, _pname, CLK_GET_RATE_NOCACHE, _lock,    \
              _con, _rtable)

struct samsung_cpu_clock {
        unsigned int    id;
        const char      *name;
        unsigned int    parent_id;
        unsigned int    alt_parent_id;
        unsigned long   flags;
        int             offset;
        enum exynos_cpuclk_layout reg_layout;
        const struct exynos_cpuclk_cfg_data *cfg;
};

#define CPU_CLK(_id, _name, _pid, _apid, _flags, _offset, _layout, _cfg) \
        {                                                       \
                .id               = _id,                        \
                .name             = _name,                      \
                .parent_id        = _pid,                       \
                .alt_parent_id    = _apid,                      \
                .flags            = _flags,                     \
                .offset           = _offset,                    \
                .reg_layout       = _layout,                    \
                .cfg              = _cfg,                       \
        }

struct samsung_clock_reg_cache {
        struct list_head node;
        void __iomem *reg_base;
        struct regmap *sysreg;
        struct samsung_clk_reg_dump *rdump;
        unsigned int rd_num;
        const struct samsung_clk_reg_dump *rsuspend;
        unsigned int rsuspend_num;
};

/**
 * struct samsung_cmu_info - all clocks information needed for CMU registration
 * @pll_clks: list of PLL clocks
 * @nr_pll_clks: count of clocks in @pll_clks
 * @mux_clks: list of mux clocks
 * @nr_mux_clks: count of clocks in @mux_clks
 * @div_clks: list of div clocks
 * @nr_div_clks: count of clocks in @div_clks
 * @gate_clks: list of gate clocks
 * @nr_gate_clks: count of clocks in @gate_clks
 * @fixed_clks: list of fixed clocks
 * @nr_fixed_clks: count clocks in @fixed_clks
 * @fixed_factor_clks: list of fixed factor clocks
 * @nr_fixed_factor_clks: count of clocks in @fixed_factor_clks
 * @nr_clk_ids: total number of clocks with IDs assigned
 * @cpu_clks: list of CPU clocks
 * @nr_cpu_clks: count of clocks in @cpu_clks
 * @clk_regs: list of clock registers
 * @nr_clk_regs: count of clock registers in @clk_regs
 * @suspend_regs: list of clock registers to set before suspend
 * @nr_suspend_regs: count of clock registers in @suspend_regs
 * @clk_name: name of the parent clock needed for CMU register access
 * @sysreg_clk_regs: list of sysreg clock registers
 * @nr_sysreg_clk_regs: count of clock registers in @sysreg_clk_regs
 * @manual_plls: Enable manual control for PLL clocks
 * @auto_clock_gate: enable auto clock mode for all components in CMU
 * @gate_dbg_offset: gate debug reg offset. Used by all gates in auto clk mode
 * @option_offset: option reg offset. Enables auto clk mode for entire CMU
 * @drcg_offset: dynamic root clk gate enable register offset in sysreg
 * @memclk_offset: memclk enable register offset in sysreg
 */
struct samsung_cmu_info {
        const struct samsung_pll_clock *pll_clks;
        unsigned int nr_pll_clks;
        const struct samsung_mux_clock *mux_clks;
        unsigned int nr_mux_clks;
        const struct samsung_div_clock *div_clks;
        unsigned int nr_div_clks;
        const struct samsung_gate_clock *gate_clks;
        unsigned int nr_gate_clks;
        const struct samsung_fixed_rate_clock *fixed_clks;
        unsigned int nr_fixed_clks;
        const struct samsung_fixed_factor_clock *fixed_factor_clks;
        unsigned int nr_fixed_factor_clks;
        unsigned int nr_clk_ids;
        const struct samsung_cpu_clock *cpu_clks;
        unsigned int nr_cpu_clks;

        const unsigned long *clk_regs;
        unsigned int nr_clk_regs;

        const struct samsung_clk_reg_dump *suspend_regs;
        unsigned int nr_suspend_regs;
        const char *clk_name;

        const unsigned long *sysreg_clk_regs;
        unsigned int nr_sysreg_clk_regs;

        /* ARM64 Exynos CMUs */
        bool manual_plls;
        bool auto_clock_gate;
        u32 gate_dbg_offset;
        u32 option_offset;
        u32 drcg_offset;
        u32 memclk_offset;
};

struct samsung_clk_provider *samsung_clk_init(struct device *dev,
                        void __iomem *base, unsigned long nr_clks);
void samsung_clk_of_add_provider(struct device_node *np,
                        struct samsung_clk_provider *ctx);
void samsung_clk_of_register_fixed_ext(
                        struct samsung_clk_provider *ctx,
                        struct samsung_fixed_rate_clock *fixed_rate_clk,
                        unsigned int nr_fixed_rate_clk,
                        const struct of_device_id *clk_matches);

void samsung_clk_add_lookup(struct samsung_clk_provider *ctx,
                        struct clk_hw *clk_hw, unsigned int id);

void samsung_clk_register_alias(struct samsung_clk_provider *ctx,
                        const struct samsung_clock_alias *list,
                        unsigned int nr_clk);
void samsung_clk_register_fixed_rate(
                        struct samsung_clk_provider *ctx,
                        const struct samsung_fixed_rate_clock *clk_list,
                        unsigned int nr_clk);
void samsung_clk_register_fixed_factor(
                        struct samsung_clk_provider *ctx,
                        const struct samsung_fixed_factor_clock *list,
                        unsigned int nr_clk);
void samsung_clk_register_mux(struct samsung_clk_provider *ctx,
                        const struct samsung_mux_clock *clk_list,
                        unsigned int nr_clk);
void samsung_clk_register_div(struct samsung_clk_provider *ctx,
                        const struct samsung_div_clock *clk_list,
                        unsigned int nr_clk);
void samsung_clk_register_gate(struct samsung_clk_provider *ctx,
                        const struct samsung_gate_clock *clk_list,
                        unsigned int nr_clk);
void samsung_clk_register_pll(struct samsung_clk_provider *ctx,
                        const struct samsung_pll_clock *pll_list,
                        unsigned int nr_clk);
void samsung_clk_register_cpu(struct samsung_clk_provider *ctx,
                const struct samsung_cpu_clock *list, unsigned int nr_clk);

void samsung_cmu_register_clocks(struct samsung_clk_provider *ctx,
                                 const struct samsung_cmu_info *cmu,
                                 struct device_node *np);
struct samsung_clk_provider *samsung_cmu_register_one(
                        struct device_node *,
                        const struct samsung_cmu_info *);

#ifdef CONFIG_PM_SLEEP
void samsung_clk_extended_sleep_init(void __iomem *reg_base,
                        struct regmap *sysreg,
                        const unsigned long *rdump,
                        unsigned long nr_rdump,
                        const struct samsung_clk_reg_dump *rsuspend,
                        unsigned long nr_rsuspend);
#else
static inline void samsung_clk_extended_sleep_init(void __iomem *reg_base,
                        struct regmap *sysreg,
                        const unsigned long *rdump,
                        unsigned long nr_rdump,
                        const struct samsung_clk_reg_dump *rsuspend,
                        unsigned long nr_rsuspend) {}
#endif
#define samsung_clk_sleep_init(reg_base, sysreg, rdump, nr_rdump)          \
        samsung_clk_extended_sleep_init(reg_base, sysreg, rdump, nr_rdump, \
                                        NULL, 0)

void samsung_clk_save(void __iomem *base,
                        struct regmap *regmap,
                        struct samsung_clk_reg_dump *rd,
                        unsigned int num_regs);
void samsung_clk_restore(void __iomem *base,
                        struct regmap *regmap,
                        const struct samsung_clk_reg_dump *rd,
                        unsigned int num_regs);
struct samsung_clk_reg_dump *samsung_clk_alloc_reg_dump(
                        const unsigned long *rdump,
                        unsigned long nr_rdump);

void samsung_en_dyn_root_clk_gating(struct device_node *np,
                                struct samsung_clk_provider *ctx,
                                const struct samsung_cmu_info *cmu,
                                bool cmu_has_pm);

struct clk_hw *samsung_register_auto_gate(struct device *dev,
                struct device_node *np, const char *name,
                const char *parent_name, const struct clk_hw *parent_hw,
                const struct clk_parent_data *parent_data,
                unsigned long flags,
                void __iomem *reg, u8 bit_idx,
                u8 clk_gate_flags, spinlock_t *lock);

bool samsung_is_auto_capable(struct device_node *np);

#endif /* __SAMSUNG_CLK_H */