/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright (c) 2013 Samsung Electronics Co., Ltd. * Copyright (c) 2013 Linaro Ltd. * Author: Thomas Abraham <[email protected]> * * Common Clock Framework support for all Samsung platforms */ #ifndef __SAMSUNG_CLK_H #define __SAMSUNG_CLK_H #include <linux/clk-provider.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 * @lock: maintains exclusion between callbacks for a given clock-provider * @clk_data: holds clock related data like clk_hw* and number of clocks */ struct samsung_clk_provider { … }; /** * 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 { … }; #define ALIAS(_id, dname, a) … #define MHZ … /** * 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 { … }; #define FRATE(_id, cname, pname, f, 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 { … }; #define FFACTOR(_id, cname, pname, m, d, 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 { … }; #define __MUX(_id, cname, pnames, o, s, w, f, mf) … #define MUX(_id, cname, pnames, o, s, w) … #define MUX_F(_id, cname, pnames, o, s, w, f, mf) … /* Used by MUX clocks where reparenting on clock rate change is allowed. */ #define nMUX(_id, cname, pnames, o, s, w) … #define nMUX_F(_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 { … }; #define __DIV(_id, cname, pname, o, s, w, f, df, t) … #define DIV(_id, cname, pname, o, s, w) … #define DIV_F(_id, cname, pname, o, s, w, f, df) … #define DIV_T(_id, cname, pname, o, s, w, 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 { … }; #define __GATE(_id, cname, pname, o, b, f, gf) … #define GATE(_id, cname, pname, o, b, f, gf) … #define PNAME(x) … /** * 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 { … }; /** * 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 { … }; #define __PLL(_typ, _id, _name, _pname, _flags, _lock, _con, _rtable) … #define PLL(_typ, _id, _name, _pname, _lock, _con, _rtable) … struct samsung_cpu_clock { … }; #define CPU_CLK(_id, _name, _pid, _apid, _flags, _offset, _layout, _cfg) … struct samsung_clock_reg_cache { … }; /** * 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 * @manual_plls: Enable manual control for PLL clocks */ struct samsung_cmu_info { … }; 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 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, 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, 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, rdump, nr_rdump) … void samsung_clk_save(void __iomem *base, struct samsung_clk_reg_dump *rd, unsigned int num_regs); void samsung_clk_restore(void __iomem *base, 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); #endif /* __SAMSUNG_CLK_H */
Codebase Browser
linux