1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (c) 2016 Maxime Ripard. All rights reserved.
4  */
5 
6 #ifndef _CCU_COMMON_H_
7 #define _CCU_COMMON_H_
8 
9 #include "ccu.h"
10 #include <hal_clk.h>
11 #include <hal_reset.h>
12 
13 #define CCU_FEATURE_FRACTIONAL      BIT(0)
14 #define CCU_FEATURE_VARIABLE_PREDIV BIT(1)
15 #define CCU_FEATURE_FIXED_PREDIV    BIT(2)
16 #define CCU_FEATURE_FIXED_POSTDIV   BIT(3)
17 #define CCU_FEATURE_ALL_PREDIV      BIT(4)
18 #define CCU_FEATURE_LOCK_REG        BIT(5)
19 #define CCU_FEATURE_MMC_TIMING_SWITCH   BIT(6)
20 #define CCU_FEATURE_SIGMA_DELTA_MOD BIT(7)
21 
22 /* Support key-field reg setting */
23 #define CCU_FEATURE_KEY_FIELD_MOD   BIT(8)
24 
25 /* New formula support in MP: clk = parent / M / P */
26 #define CCU_FEATURE_MP_NO_INDEX_MODE    BIT(9)
27 
28 /* Support fixed rate in gate-clk */
29 #define CCU_FEATURE_FIXED_RATE_GATE BIT(10)
30 /* MMC timing mode switch bit */
31 #define CCU_MMC_NEW_TIMING_MODE     BIT(30)
32 
33 /**
34  * struct ccu_reg_dump: register dump of clock controller registers.
35  * @offset: clock register offset from the controller base address.
36  * @value: the value to be register at offset.
37  */
38 struct ccu_reg_dump
39 {
40     u32 offset;
41     u32 value;
42 };
43 
44 struct ccu_common
45 {
46     unsigned long    base;
47     u32     reg;
48     u32     lock_reg;
49     u32     prediv;
50     u32     key_value;
51 
52     hal_spinlock_t lock;
53     unsigned long   features;
54     struct clk_hw   hw;
55 };
56 
hw_to_ccu_common(struct clk_hw * hw)57 static inline struct ccu_common *hw_to_ccu_common(struct clk_hw *hw)
58 {
59     return container_of(hw, struct ccu_common, hw);
60 }
61 
62 struct sunxi_ccu_desc
63 {
64     struct ccu_common       **ccu_clks;
65     u32             num_ccu_clks;
66 
67     struct clk_hw_onecell_data  *hw_clks;
68     hal_clk_type_t          clk_type;
69 
70     struct ccu_reset_map        *resets;
71     hal_reset_type_t        reset_type;
72     u32             num_resets;
73 };
74 
75 void ccu_helper_wait_for_lock(struct ccu_common *common, u32 lock);
76 int ccu_common_init(unsigned long reg, const struct sunxi_ccu_desc *desc);
77 void set_reg(unsigned long addr, u32 val, u8 bw, u8 bs);
78 void set_reg_key(unsigned long addr,
79                  u32 key, u8 kbw, u8 kbs,
80                  u32 val, u8 bw, u8 bs);
81 
82 #endif /* _COMMON_H_ */
83