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 
22 /* MMC timing mode switch bit */
23 #define CCU_MMC_NEW_TIMING_MODE		BIT(30)
24 
25 struct device_node;
26 
27 struct ccu_common {
28 	void __iomem	*base;
29 	u16		reg;
30 	u16		lock_reg;
31 	u32		prediv;
32 
33 	unsigned long	features;
34 	spinlock_t	*lock;
35 	struct clk_hw	hw;
36 };
37 
38 static inline struct ccu_common *hw_to_ccu_common(struct clk_hw *hw)
39 {
40 	return container_of(hw, struct ccu_common, hw);
41 }
42 
43 struct sunxi_ccu_desc {
44 	struct ccu_common		**ccu_clks;
45 	unsigned long			num_ccu_clks;
46 
47 	struct clk_hw_onecell_data	*hw_clks;
48 
49 	struct ccu_reset_map		*resets;
50 	unsigned long			num_resets;
51 };
52 
53 void ccu_helper_wait_for_lock(struct ccu_common *common, u32 lock);
54 
55 struct ccu_pll_nb {
56 	struct notifier_block	clk_nb;
57 	struct ccu_common	*common;
58 
59 	u32	enable;
60 	u32	lock;
61 };
62 
63 #define to_ccu_pll_nb(_nb) container_of(_nb, struct ccu_pll_nb, clk_nb)
64 
65 int ccu_pll_notifier_register(struct ccu_pll_nb *pll_nb);
66 
67 int devm_sunxi_ccu_probe(struct device *dev, void __iomem *reg,
68 			 const struct sunxi_ccu_desc *desc);
69 void of_sunxi_ccu_probe(struct device_node *node, void __iomem *reg,
70 			const struct sunxi_ccu_desc *desc);
71 
72 #endif /* _COMMON_H_ */
73