GNU Linux-libre 4.14.332-gnu1
[releases.git] / drivers / clk / imx / clk.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __MACH_IMX_CLK_H
3 #define __MACH_IMX_CLK_H
4
5 #include <linux/spinlock.h>
6 #include <linux/clk-provider.h>
7
8 extern spinlock_t imx_ccm_lock;
9
10 void imx_check_clocks(struct clk *clks[], unsigned int count);
11 void imx_register_uart_clocks(struct clk ** const clks[]);
12
13 extern void imx_cscmr1_fixup(u32 *val);
14
15 enum imx_pllv1_type {
16         IMX_PLLV1_IMX1,
17         IMX_PLLV1_IMX21,
18         IMX_PLLV1_IMX25,
19         IMX_PLLV1_IMX27,
20         IMX_PLLV1_IMX31,
21         IMX_PLLV1_IMX35,
22 };
23
24 struct clk *imx_clk_pllv1(enum imx_pllv1_type type, const char *name,
25                 const char *parent, void __iomem *base);
26
27 struct clk *imx_clk_pllv2(const char *name, const char *parent,
28                 void __iomem *base);
29
30 enum imx_pllv3_type {
31         IMX_PLLV3_GENERIC,
32         IMX_PLLV3_SYS,
33         IMX_PLLV3_USB,
34         IMX_PLLV3_USB_VF610,
35         IMX_PLLV3_AV,
36         IMX_PLLV3_ENET,
37         IMX_PLLV3_ENET_IMX7,
38         IMX_PLLV3_SYS_VF610,
39         IMX_PLLV3_DDR_IMX7,
40 };
41
42 struct clk *imx_clk_pllv3(enum imx_pllv3_type type, const char *name,
43                 const char *parent_name, void __iomem *base, u32 div_mask);
44
45 struct clk *clk_register_gate2(struct device *dev, const char *name,
46                 const char *parent_name, unsigned long flags,
47                 void __iomem *reg, u8 bit_idx, u8 cgr_val,
48                 u8 clk_gate_flags, spinlock_t *lock,
49                 unsigned int *share_count);
50
51 struct clk * imx_obtain_fixed_clock(
52                         const char *name, unsigned long rate);
53
54 struct clk *imx_clk_gate_exclusive(const char *name, const char *parent,
55          void __iomem *reg, u8 shift, u32 exclusive_mask);
56
57 struct clk *imx_clk_pfd(const char *name, const char *parent_name,
58                 void __iomem *reg, u8 idx);
59
60 struct clk *imx_clk_busy_divider(const char *name, const char *parent_name,
61                                  void __iomem *reg, u8 shift, u8 width,
62                                  void __iomem *busy_reg, u8 busy_shift);
63
64 struct clk *imx_clk_busy_mux(const char *name, void __iomem *reg, u8 shift,
65                              u8 width, void __iomem *busy_reg, u8 busy_shift,
66                              const char * const *parent_names, int num_parents);
67
68 struct clk *imx_clk_fixup_divider(const char *name, const char *parent,
69                                   void __iomem *reg, u8 shift, u8 width,
70                                   void (*fixup)(u32 *val));
71
72 struct clk *imx_clk_fixup_mux(const char *name, void __iomem *reg,
73                               u8 shift, u8 width, const char * const *parents,
74                               int num_parents, void (*fixup)(u32 *val));
75
76 static inline struct clk *imx_clk_fixed(const char *name, int rate)
77 {
78         return clk_register_fixed_rate(NULL, name, NULL, 0, rate);
79 }
80
81 static inline struct clk *imx_clk_mux_ldb(const char *name, void __iomem *reg,
82                         u8 shift, u8 width, const char * const *parents,
83                         int num_parents)
84 {
85         return clk_register_mux(NULL, name, parents, num_parents,
86                         CLK_SET_RATE_NO_REPARENT | CLK_SET_RATE_PARENT, reg,
87                         shift, width, CLK_MUX_READ_ONLY, &imx_ccm_lock);
88 }
89
90 static inline struct clk *imx_clk_fixed_factor(const char *name,
91                 const char *parent, unsigned int mult, unsigned int div)
92 {
93         return clk_register_fixed_factor(NULL, name, parent,
94                         CLK_SET_RATE_PARENT, mult, div);
95 }
96
97 static inline struct clk *imx_clk_divider(const char *name, const char *parent,
98                 void __iomem *reg, u8 shift, u8 width)
99 {
100         return clk_register_divider(NULL, name, parent, CLK_SET_RATE_PARENT,
101                         reg, shift, width, 0, &imx_ccm_lock);
102 }
103
104 static inline struct clk *imx_clk_divider_flags(const char *name,
105                 const char *parent, void __iomem *reg, u8 shift, u8 width,
106                 unsigned long flags)
107 {
108         return clk_register_divider(NULL, name, parent, flags,
109                         reg, shift, width, 0, &imx_ccm_lock);
110 }
111
112 static inline struct clk *imx_clk_divider2(const char *name, const char *parent,
113                 void __iomem *reg, u8 shift, u8 width)
114 {
115         return clk_register_divider(NULL, name, parent,
116                         CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
117                         reg, shift, width, 0, &imx_ccm_lock);
118 }
119
120 static inline struct clk *imx_clk_gate(const char *name, const char *parent,
121                 void __iomem *reg, u8 shift)
122 {
123         return clk_register_gate(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
124                         shift, 0, &imx_ccm_lock);
125 }
126
127 static inline struct clk *imx_clk_gate_dis(const char *name, const char *parent,
128                 void __iomem *reg, u8 shift)
129 {
130         return clk_register_gate(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
131                         shift, CLK_GATE_SET_TO_DISABLE, &imx_ccm_lock);
132 }
133
134 static inline struct clk *imx_clk_gate2(const char *name, const char *parent,
135                 void __iomem *reg, u8 shift)
136 {
137         return clk_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
138                         shift, 0x3, 0, &imx_ccm_lock, NULL);
139 }
140
141 static inline struct clk *imx_clk_gate2_shared(const char *name,
142                 const char *parent, void __iomem *reg, u8 shift,
143                 unsigned int *share_count)
144 {
145         return clk_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
146                         shift, 0x3, 0, &imx_ccm_lock, share_count);
147 }
148
149 static inline struct clk *imx_clk_gate2_shared2(const char *name,
150                 const char *parent, void __iomem *reg, u8 shift,
151                 unsigned int *share_count)
152 {
153         return clk_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT |
154                                   CLK_OPS_PARENT_ENABLE, reg, shift, 0x3, 0,
155                                   &imx_ccm_lock, share_count);
156 }
157
158 static inline struct clk *imx_clk_gate2_cgr(const char *name,
159                 const char *parent, void __iomem *reg, u8 shift, u8 cgr_val)
160 {
161         return clk_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
162                         shift, cgr_val, 0, &imx_ccm_lock, NULL);
163 }
164
165 static inline struct clk *imx_clk_gate3(const char *name, const char *parent,
166                 void __iomem *reg, u8 shift)
167 {
168         return clk_register_gate(NULL, name, parent,
169                         CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
170                         reg, shift, 0, &imx_ccm_lock);
171 }
172
173 static inline struct clk *imx_clk_gate4(const char *name, const char *parent,
174                 void __iomem *reg, u8 shift)
175 {
176         return clk_register_gate2(NULL, name, parent,
177                         CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
178                         reg, shift, 0x3, 0, &imx_ccm_lock, NULL);
179 }
180
181 static inline struct clk *imx_clk_mux(const char *name, void __iomem *reg,
182                         u8 shift, u8 width, const char * const *parents,
183                         int num_parents)
184 {
185         return clk_register_mux(NULL, name, parents, num_parents,
186                         CLK_SET_RATE_NO_REPARENT, reg, shift,
187                         width, 0, &imx_ccm_lock);
188 }
189
190 static inline struct clk *imx_clk_mux2(const char *name, void __iomem *reg,
191                         u8 shift, u8 width, const char * const *parents,
192                         int num_parents)
193 {
194         return clk_register_mux(NULL, name, parents, num_parents,
195                         CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE,
196                         reg, shift, width, 0, &imx_ccm_lock);
197 }
198
199 static inline struct clk *imx_clk_mux_flags(const char *name,
200                         void __iomem *reg, u8 shift, u8 width,
201                         const char * const *parents, int num_parents,
202                         unsigned long flags)
203 {
204         return clk_register_mux(NULL, name, parents, num_parents,
205                         flags | CLK_SET_RATE_NO_REPARENT, reg, shift, width, 0,
206                         &imx_ccm_lock);
207 }
208
209 struct clk *imx_clk_cpu(const char *name, const char *parent_name,
210                 struct clk *div, struct clk *mux, struct clk *pll,
211                 struct clk *step);
212
213 #endif