1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (c) 2016 Maxime Ripard. All rights reserved.
4 */
5
6 #ifndef _COMMON_H_
7 #define _COMMON_H_
8
9 #include <linux/compiler.h>
10 #include <linux/clk-provider.h>
11
12 #define CCU_FEATURE_FRACTIONAL BIT(0)
13 #define CCU_FEATURE_VARIABLE_PREDIV BIT(1)
14 #define CCU_FEATURE_FIXED_PREDIV BIT(2)
15 #define CCU_FEATURE_FIXED_POSTDIV BIT(3)
16 #define CCU_FEATURE_ALL_PREDIV BIT(4)
17 #define CCU_FEATURE_LOCK_REG BIT(5)
18 #define CCU_FEATURE_MMC_TIMING_SWITCH BIT(6)
19 #define CCU_FEATURE_SIGMA_DELTA_MOD BIT(7)
20 #define CCU_FEATURE_KEY_FIELD BIT(8)
21 #define CCU_FEATURE_CLOSEST_RATE BIT(9)
22 #define CCU_FEATURE_DUAL_DIV BIT(10)
23 #define CCU_FEATURE_UPDATE_BIT BIT(11)
24 #define CCU_FEATURE_IOSC_CALIBRATION BIT(12)
25
26 /* MMC timing mode switch bit */
27 #define CCU_MMC_NEW_TIMING_MODE BIT(30)
28
29 /* Some clocks need this bit to actually apply register changes */
30 #define CCU_SUNXI_UPDATE_BIT BIT(27)
31
32 struct device_node;
33
34 struct ccu_common {
35 void __iomem *base;
36 u16 reg;
37 u16 lock_reg;
38 u32 prediv;
39
40 unsigned long min_rate;
41 unsigned long max_rate;
42
43 unsigned long features;
44 spinlock_t *lock;
45 struct clk_hw hw;
46 };
47
hw_to_ccu_common(struct clk_hw * hw)48 static inline struct ccu_common *hw_to_ccu_common(struct clk_hw *hw)
49 {
50 return container_of(hw, struct ccu_common, hw);
51 }
52
53 struct sunxi_ccu_desc {
54 struct ccu_common **ccu_clks;
55 unsigned long num_ccu_clks;
56
57 struct clk_hw_onecell_data *hw_clks;
58
59 const struct ccu_reset_map *resets;
60 unsigned long num_resets;
61 };
62
63 void ccu_helper_wait_for_lock(struct ccu_common *common, u32 lock);
64
65 bool ccu_is_better_rate(struct ccu_common *common,
66 unsigned long target_rate,
67 unsigned long current_rate,
68 unsigned long best_rate);
69
70 struct ccu_pll_nb {
71 struct notifier_block clk_nb;
72 struct ccu_common *common;
73
74 u32 enable;
75 u32 lock;
76 };
77
78 #define to_ccu_pll_nb(_nb) container_of(_nb, struct ccu_pll_nb, clk_nb)
79
80 int ccu_pll_notifier_register(struct ccu_pll_nb *pll_nb);
81
82 int devm_sunxi_ccu_probe(struct device *dev, void __iomem *reg,
83 const struct sunxi_ccu_desc *desc);
84 void of_sunxi_ccu_probe(struct device_node *node, void __iomem *reg,
85 const struct sunxi_ccu_desc *desc);
86
87 #endif /* _COMMON_H_ */
88