/*
 * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __TEGRA_CLK_H
#define __TEGRA_CLK_H

#include <linux/clk-provider.h>
#include <linux/clkdev.h>

/**
 * struct tegra_clk_sync_source - external clock source from codec
 *
 * @hw: handle between common and hardware-specific interfaces
 * @rate: input frequency from source
 * @max_rate: max rate allowed
 */
struct tegra_clk_sync_source {
        struct          clk_hw hw;
        unsigned long   rate;
        unsigned long   max_rate;
};

#define to_clk_sync_source(_hw)                                 \
        container_of(_hw, struct tegra_clk_sync_source, hw)

extern const struct clk_ops tegra_clk_sync_source_ops;
struct clk *tegra_clk_register_sync_source(const char *name,
                unsigned long fixed_rate, unsigned long max_rate);

/**
 * struct tegra_clk_frac_div - fractional divider clock
 *
 * @hw:         handle between common and hardware-specific interfaces
 * @reg:        register containing divider
 * @flags:      hardware-specific flags
 * @shift:      shift to the divider bit field
 * @width:      width of the divider bit field
 * @frac_width: width of the fractional bit field
 * @lock:       register lock
 *
 * Flags:
 * TEGRA_DIVIDER_ROUND_UP - This flags indicates to round up the divider value.
 * TEGRA_DIVIDER_FIXED - Fixed rate PLL dividers has addition override bit, this
 *      flag indicates that this divider is for fixed rate PLL.
 * TEGRA_DIVIDER_INT - Some modules can not cope with the duty cycle when
 *      fraction bit is set. This flags indicates to calculate divider for which
 *      fracton bit will be zero.
 * TEGRA_DIVIDER_UART - UART module divider has additional enable bit which is
 *      set when divider value is not 0. This flags indicates that the divider
 *      is for UART module.
 */
struct tegra_clk_frac_div {
        struct clk_hw   hw;
        void __iomem    *reg;
        u8              flags;
        u8              shift;
        u8              width;
        u8              frac_width;
        spinlock_t      *lock;
};

#define to_clk_frac_div(_hw) container_of(_hw, struct tegra_clk_frac_div, hw)

#define TEGRA_DIVIDER_ROUND_UP BIT(0)
#define TEGRA_DIVIDER_FIXED BIT(1)
#define TEGRA_DIVIDER_INT BIT(2)
#define TEGRA_DIVIDER_UART BIT(3)

extern const struct clk_ops tegra_clk_frac_div_ops;
struct clk *tegra_clk_register_divider(const char *name,
                const char *parent_name, void __iomem *reg,
                unsigned long flags, u8 clk_divider_flags, u8 shift, u8 width,
                u8 frac_width, spinlock_t *lock);

/*
 * Tegra PLL:
 *
 * In general, there are 3 requirements for each PLL
 * that SW needs to be comply with.
 * (1) Input frequency range (REF).
 * (2) Comparison frequency range (CF). CF = REF/DIVM.
 * (3) VCO frequency range (VCO).  VCO = CF * DIVN.
 *
 * The final PLL output frequency (FO) = VCO >> DIVP.
 */

/**
 * struct tegra_clk_pll_freq_table - PLL frequecy table
 *
 * @input_rate:         input rate from source
 * @output_rate:        output rate from PLL for the input rate
 * @n:                  feedback divider
 * @m:                  input divider
 * @p:                  post divider
 * @cpcon:              charge pump current
 */
struct tegra_clk_pll_freq_table {
        unsigned long   input_rate;
        unsigned long   output_rate;
        u16             n;
        u16             m;
        u8              p;
        u8              cpcon;
};

/**
 * struct pdiv_map - map post divider to hw value
 *
 * @pdiv:               post divider
 * @hw_val:             value to be written to the PLL hw
 */
struct pdiv_map {
        u8 pdiv;
        u8 hw_val;
};

/**
 * struct clk_pll_params - PLL parameters
 *
 * @input_min:                  Minimum input frequency
 * @input_max:                  Maximum input frequency
 * @cf_min:                     Minimum comparison frequency
 * @cf_max:                     Maximum comparison frequency
 * @vco_min:                    Minimum VCO frequency
 * @vco_max:                    Maximum VCO frequency
 * @base_reg:                   PLL base reg offset
 * @misc_reg:                   PLL misc reg offset
 * @lock_reg:                   PLL lock reg offset
 * @lock_bit_idx:               Bit index for PLL lock status
 * @lock_enable_bit_idx:        Bit index to enable PLL lock
 * @lock_delay:                 Delay in us if PLL lock is not used
 */
struct tegra_clk_pll_params {
        unsigned long   input_min;
        unsigned long   input_max;
        unsigned long   cf_min;
        unsigned long   cf_max;
        unsigned long   vco_min;
        unsigned long   vco_max;

        u32             base_reg;
        u32             misc_reg;
        u32             lock_reg;
        u32             lock_mask;
        u32             lock_enable_bit_idx;
        u32             iddq_reg;
        u32             iddq_bit_idx;
        u32             aux_reg;
        u32             dyn_ramp_reg;
        u32             ext_misc_reg[3];
        int             stepa_shift;
        int             stepb_shift;
        int             lock_delay;
        int             max_p;
        struct pdiv_map *pdiv_tohw;
};

/**
 * struct tegra_clk_pll - Tegra PLL clock
 *
 * @hw:         handle between common and hardware-specifix interfaces
 * @clk_base:   address of CAR controller
 * @pmc:        address of PMC, required to read override bits
 * @freq_table: array of frequencies supported by PLL
 * @params:     PLL parameters
 * @flags:      PLL flags
 * @fixed_rate: PLL rate if it is fixed
 * @lock:       register lock
 * @divn_shift: shift to the feedback divider bit field
 * @divn_width: width of the feedback divider bit field
 * @divm_shift: shift to the input divider bit field
 * @divm_width: width of the input divider bit field
 * @divp_shift: shift to the post divider bit field
 * @divp_width: width of the post divider bit field
 *
 * Flags:
 * TEGRA_PLL_USE_LOCK - This flag indicated to use lock bits for
 *     PLL locking. If not set it will use lock_delay value to wait.
 * TEGRA_PLL_HAS_CPCON - This flag indicates that CPCON value needs
 *     to be programmed to change output frequency of the PLL.
 * TEGRA_PLL_SET_LFCON - This flag indicates that LFCON value needs
 *     to be programmed to change output frequency of the PLL.
 * TEGRA_PLL_SET_DCCON - This flag indicates that DCCON value needs
 *     to be programmed to change output frequency of the PLL.
 * TEGRA_PLLU - PLLU has inverted post divider. This flags indicated
 *     that it is PLLU and invert post divider value.
 * TEGRA_PLLM - PLLM has additional override settings in PMC. This
 *     flag indicates that it is PLLM and use override settings.
 * TEGRA_PLL_FIXED - We are not supposed to change output frequency
 *     of some plls.
 * TEGRA_PLLE_CONFIGURE - Configure PLLE when enabling.
 * TEGRA_PLL_LOCK_MISC - Lock bit is in the misc register instead of the
 *     base register.
 * TEGRA_PLL_BYPASS - PLL has bypass bit
 * TEGRA_PLL_HAS_LOCK_ENABLE - PLL has bit to enable lock monitoring
 */
struct tegra_clk_pll {
        struct clk_hw   hw;
        void __iomem    *clk_base;
        void __iomem    *pmc;
        u32             flags;
        unsigned long   fixed_rate;
        spinlock_t      *lock;
        u8              divn_shift;
        u8              divn_width;
        u8              divm_shift;
        u8              divm_width;
        u8              divp_shift;
        u8              divp_width;
        struct tegra_clk_pll_freq_table *freq_table;
        struct tegra_clk_pll_params     *params;
};

#define to_clk_pll(_hw) container_of(_hw, struct tegra_clk_pll, hw)

#define TEGRA_PLL_USE_LOCK BIT(0)
#define TEGRA_PLL_HAS_CPCON BIT(1)
#define TEGRA_PLL_SET_LFCON BIT(2)
#define TEGRA_PLL_SET_DCCON BIT(3)
#define TEGRA_PLLU BIT(4)
#define TEGRA_PLLM BIT(5)
#define TEGRA_PLL_FIXED BIT(6)
#define TEGRA_PLLE_CONFIGURE BIT(7)
#define TEGRA_PLL_LOCK_MISC BIT(8)
#define TEGRA_PLL_BYPASS BIT(9)
#define TEGRA_PLL_HAS_LOCK_ENABLE BIT(10)

extern const struct clk_ops tegra_clk_pll_ops;
extern const struct clk_ops tegra_clk_plle_ops;
struct clk *tegra_clk_register_pll(const char *name, const char *parent_name,
                void __iomem *clk_base, void __iomem *pmc,
                unsigned long flags, unsigned long fixed_rate,
                struct tegra_clk_pll_params *pll_params, u32 pll_flags,
                struct tegra_clk_pll_freq_table *freq_table, spinlock_t *lock);

struct clk *tegra_clk_register_plle(const char *name, const char *parent_name,
                void __iomem *clk_base, void __iomem *pmc,
                unsigned long flags, unsigned long fixed_rate,
                struct tegra_clk_pll_params *pll_params, u32 pll_flags,
                struct tegra_clk_pll_freq_table *freq_table, spinlock_t *lock);

struct clk *tegra_clk_register_pllxc(const char *name, const char *parent_name,
                            void __iomem *clk_base, void __iomem *pmc,
                            unsigned long flags, unsigned long fixed_rate,
                            struct tegra_clk_pll_params *pll_params,
                            u32 pll_flags,
                            struct tegra_clk_pll_freq_table *freq_table,
                            spinlock_t *lock);

struct clk *tegra_clk_register_pllm(const char *name, const char *parent_name,
                           void __iomem *clk_base, void __iomem *pmc,
                           unsigned long flags, unsigned long fixed_rate,
                           struct tegra_clk_pll_params *pll_params,
                           u32 pll_flags,
                           struct tegra_clk_pll_freq_table *freq_table,
                           spinlock_t *lock);

struct clk *tegra_clk_register_pllc(const char *name, const char *parent_name,
                           void __iomem *clk_base, void __iomem *pmc,
                           unsigned long flags, unsigned long fixed_rate,
                           struct tegra_clk_pll_params *pll_params,
                           u32 pll_flags,
                           struct tegra_clk_pll_freq_table *freq_table,
                           spinlock_t *lock);

struct clk *tegra_clk_register_pllre(const char *name, const char *parent_name,
                           void __iomem *clk_base, void __iomem *pmc,
                           unsigned long flags, unsigned long fixed_rate,
                           struct tegra_clk_pll_params *pll_params,
                           u32 pll_flags,
                           struct tegra_clk_pll_freq_table *freq_table,
                           spinlock_t *lock, unsigned long parent_rate);

struct clk *tegra_clk_register_plle_tegra114(const char *name,
                                const char *parent_name,
                                void __iomem *clk_base, unsigned long flags,
                                unsigned long fixed_rate,
                                struct tegra_clk_pll_params *pll_params,
                                struct tegra_clk_pll_freq_table *freq_table,
                                spinlock_t *lock);

/**
 * struct tegra_clk_pll_out - PLL divider down clock
 *
 * @hw:                 handle between common and hardware-specific interfaces
 * @reg:                register containing the PLL divider
 * @enb_bit_idx:        bit to enable/disable PLL divider
 * @rst_bit_idx:        bit to reset PLL divider
 * @lock:               register lock
 * @flags:              hardware-specific flags
 */
struct tegra_clk_pll_out {
        struct clk_hw   hw;
        void __iomem    *reg;
        u8              enb_bit_idx;
        u8              rst_bit_idx;
        spinlock_t      *lock;
        u8              flags;
};

#define to_clk_pll_out(_hw) container_of(_hw, struct tegra_clk_pll_out, hw)

extern const struct clk_ops tegra_clk_pll_out_ops;
struct clk *tegra_clk_register_pll_out(const char *name,
                const char *parent_name, void __iomem *reg, u8 enb_bit_idx,
                u8 rst_bit_idx, unsigned long flags, u8 pll_div_flags,
                spinlock_t *lock);

/**
 * struct tegra_clk_periph_regs -  Registers controlling peripheral clock
 *
 * @enb_reg:            read the enable status
 * @enb_set_reg:        write 1 to enable clock
 * @enb_clr_reg:        write 1 to disable clock
 * @rst_reg:            read the reset status
 * @rst_set_reg:        write 1 to assert the reset of peripheral
 * @rst_clr_reg:        write 1 to deassert the reset of peripheral
 */
struct tegra_clk_periph_regs {
        u32 enb_reg;
        u32 enb_set_reg;
        u32 enb_clr_reg;
        u32 rst_reg;
        u32 rst_set_reg;
        u32 rst_clr_reg;
};

/**
 * struct tegra_clk_periph_gate - peripheral gate clock
 *
 * @magic:              magic number to validate type
 * @hw:                 handle between common and hardware-specific interfaces
 * @clk_base:           address of CAR controller
 * @regs:               Registers to control the peripheral
 * @flags:              hardware-specific flags
 * @clk_num:            Clock number
 * @enable_refcnt:      array to maintain reference count of the clock
 *
 * Flags:
 * TEGRA_PERIPH_NO_RESET - This flag indicates that reset is not allowed
 *     for this module.
 * TEGRA_PERIPH_MANUAL_RESET - This flag indicates not to reset module
 *     after clock enable and driver for the module is responsible for
 *     doing reset.
 * TEGRA_PERIPH_ON_APB - If peripheral is in the APB bus then read the
 *     bus to flush the write operation in apb bus. This flag indicates
 *     that this peripheral is in apb bus.
 * TEGRA_PERIPH_WAR_1005168 - Apply workaround for Tegra114 MSENC bug
 */
struct tegra_clk_periph_gate {
        u32                     magic;
        struct clk_hw           hw;
        void __iomem            *clk_base;
        u8                      flags;
        int                     clk_num;
        int                     *enable_refcnt;
        struct tegra_clk_periph_regs    *regs;
};

#define to_clk_periph_gate(_hw)                                 \
        container_of(_hw, struct tegra_clk_periph_gate, hw)

#define TEGRA_CLK_PERIPH_GATE_MAGIC 0x17760309

#define TEGRA_PERIPH_NO_RESET BIT(0)
#define TEGRA_PERIPH_MANUAL_RESET BIT(1)
#define TEGRA_PERIPH_ON_APB BIT(2)
#define TEGRA_PERIPH_WAR_1005168 BIT(3)

void tegra_periph_reset(struct tegra_clk_periph_gate *gate, bool assert);
extern const struct clk_ops tegra_clk_periph_gate_ops;
struct clk *tegra_clk_register_periph_gate(const char *name,
                const char *parent_name, u8 gate_flags, void __iomem *clk_base,
                unsigned long flags, int clk_num,
                struct tegra_clk_periph_regs *pregs, int *enable_refcnt);

/**
 * struct clk-periph - peripheral clock
 *
 * @magic:      magic number to validate type
 * @hw:         handle between common and hardware-specific interfaces
 * @mux:        mux clock
 * @divider:    divider clock
 * @gate:       gate clock
 * @mux_ops:    mux clock ops
 * @div_ops:    divider clock ops
 * @gate_ops:   gate clock ops
 */
struct tegra_clk_periph {
        u32                     magic;
        struct clk_hw           hw;
        struct clk_mux          mux;
        struct tegra_clk_frac_div       divider;
        struct tegra_clk_periph_gate    gate;

        const struct clk_ops    *mux_ops;
        const struct clk_ops    *div_ops;
        const struct clk_ops    *gate_ops;
};

#define to_clk_periph(_hw) container_of(_hw, struct tegra_clk_periph, hw)

#define TEGRA_CLK_PERIPH_MAGIC 0x18221223

extern const struct clk_ops tegra_clk_periph_ops;
struct clk *tegra_clk_register_periph(const char *name,
                const char **parent_names, int num_parents,
                struct tegra_clk_periph *periph, void __iomem *clk_base,
                u32 offset, unsigned long flags);
struct clk *tegra_clk_register_periph_nodiv(const char *name,
                const char **parent_names, int num_parents,
                struct tegra_clk_periph *periph, void __iomem *clk_base,
                u32 offset);

#define TEGRA_CLK_PERIPH(_mux_shift, _mux_mask, _mux_flags,             \
                         _div_shift, _div_width, _div_frac_width,       \
                         _div_flags, _clk_num, _enb_refcnt, _regs,      \
                         _gate_flags, _table)                           \
        {                                                               \
                .mux = {                                                \
                        .flags = _mux_flags,                            \
                        .shift = _mux_shift,                            \
                        .mask = _mux_mask,                              \
                        .table = _table,                                \
                },                                                      \
                .divider = {                                            \
                        .flags = _div_flags,                            \
                        .shift = _div_shift,                            \
                        .width = _div_width,                            \
                        .frac_width = _div_frac_width,                  \
                },                                                      \
                .gate = {                                               \
                        .flags = _gate_flags,                           \
                        .clk_num = _clk_num,                            \
                        .enable_refcnt = _enb_refcnt,                   \
                        .regs = _regs,                                  \
                },                                                      \
                .mux_ops = &clk_mux_ops,                                \
                .div_ops = &tegra_clk_frac_div_ops,                     \
                .gate_ops = &tegra_clk_periph_gate_ops,                 \
        }

struct tegra_periph_init_data {
        const char *name;
        int clk_id;
        const char **parent_names;
        int num_parents;
        struct tegra_clk_periph periph;
        u32 offset;
        const char *con_id;
        const char *dev_id;
        unsigned long flags;
};

#define TEGRA_INIT_DATA_TABLE(_name, _con_id, _dev_id, _parent_names, _offset,\
                        _mux_shift, _mux_mask, _mux_flags, _div_shift,  \
                        _div_width, _div_frac_width, _div_flags, _regs, \
                        _clk_num, _enb_refcnt, _gate_flags, _clk_id, _table,\
                        _flags) \
        {                                                               \
                .name = _name,                                          \
                .clk_id = _clk_id,                                      \
                .parent_names = _parent_names,                          \
                .num_parents = ARRAY_SIZE(_parent_names),               \
                .periph = TEGRA_CLK_PERIPH(_mux_shift, _mux_mask,       \
                                           _mux_flags, _div_shift,      \
                                           _div_width, _div_frac_width, \
                                           _div_flags, _clk_num,        \
                                           _enb_refcnt, _regs,          \
                                           _gate_flags, _table),        \
                .offset = _offset,                                      \
                .con_id = _con_id,                                      \
                .dev_id = _dev_id,                                      \
                .flags = _flags                                         \
        }

#define TEGRA_INIT_DATA(_name, _con_id, _dev_id, _parent_names, _offset,\
                        _mux_shift, _mux_width, _mux_flags, _div_shift, \
                        _div_width, _div_frac_width, _div_flags, _regs, \
                        _clk_num, _enb_refcnt, _gate_flags, _clk_id)    \
        TEGRA_INIT_DATA_TABLE(_name, _con_id, _dev_id, _parent_names, _offset,\
                        _mux_shift, BIT(_mux_width) - 1, _mux_flags,    \
                        _div_shift, _div_width, _div_frac_width, _div_flags, \
                        _regs, _clk_num, _enb_refcnt, _gate_flags, _clk_id,\
                        NULL, 0)

/**
 * struct clk_super_mux - super clock
 *
 * @hw:         handle between common and hardware-specific interfaces
 * @reg:        register controlling multiplexer
 * @width:      width of the multiplexer bit field
 * @flags:      hardware-specific flags
 * @div2_index: bit controlling divide-by-2
 * @pllx_index: PLLX index in the parent list
 * @lock:       register lock
 *
 * Flags:
 * TEGRA_DIVIDER_2 - LP cluster has additional divider. This flag indicates
 *     that this is LP cluster clock.
 */
struct tegra_clk_super_mux {
        struct clk_hw   hw;
        void __iomem    *reg;
        u8              width;
        u8              flags;
        u8              div2_index;
        u8              pllx_index;
        spinlock_t      *lock;
};

#define to_clk_super_mux(_hw) container_of(_hw, struct tegra_clk_super_mux, hw)

#define TEGRA_DIVIDER_2 BIT(0)

extern const struct clk_ops tegra_clk_super_ops;
struct clk *tegra_clk_register_super_mux(const char *name,
                const char **parent_names, u8 num_parents,
                unsigned long flags, void __iomem *reg, u8 clk_super_flags,
                u8 width, u8 pllx_index, u8 div2_index, spinlock_t *lock);

/**
 * struct clk_init_tabel - clock initialization table
 * @clk_id:     clock id as mentioned in device tree bindings
 * @parent_id:  parent clock id as mentioned in device tree bindings
 * @rate:       rate to set
 * @state:      enable/disable
 */
struct tegra_clk_init_table {
        unsigned int    clk_id;
        unsigned int    parent_id;
        unsigned long   rate;
        int             state;
};

/**
 * struct clk_duplicate - duplicate clocks
 * @clk_id:     clock id as mentioned in device tree bindings
 * @lookup:     duplicate lookup entry for the clock
 */
struct tegra_clk_duplicate {
        int                     clk_id;
        struct clk_lookup       lookup;
};

#define TEGRA_CLK_DUPLICATE(_clk_id, _dev, _con) \
        {                                       \
                .clk_id = _clk_id,              \
                .lookup = {                     \
                        .dev_id = _dev,         \
                        .con_id = _con,         \
                },                              \
        }

void tegra_init_from_table(struct tegra_clk_init_table *tbl,
                struct clk *clks[], int clk_max);

void tegra_init_dup_clks(struct tegra_clk_duplicate *dup_list,
                struct clk *clks[], int clk_max);

#ifdef CONFIG_ARCH_TEGRA_2x_SOC
void tegra20_clock_init(struct device_node *np);
#else
static inline void tegra20_clock_init(struct device_node *np) {}
#endif /* CONFIG_ARCH_TEGRA_2x_SOC */

#ifdef CONFIG_ARCH_TEGRA_3x_SOC
void tegra30_clock_init(struct device_node *np);
#else
static inline void tegra30_clock_init(struct device_node *np) {}
#endif /* CONFIG_ARCH_TEGRA_3x_SOC */

#ifdef CONFIG_ARCH_TEGRA_114_SOC
void tegra114_clock_init(struct device_node *np);
#else
static inline void tegra114_clock_init(struct device_node *np) {}
#endif /* CONFIG_ARCH_TEGRA114_SOC */

typedef void (*tegra_clk_apply_init_table_func)(void);
extern tegra_clk_apply_init_table_func tegra_clk_apply_init_table;

#endif /* TEGRA_CLK_H */