1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __MACH_IMX_CLK_H
3 #define __MACH_IMX_CLK_H
5 #include <linux/spinlock.h>
6 #include <linux/clk-provider.h>
8 #define IMX_CLK_GATE2_SINGLE_BIT 1
10 extern spinlock_t imx_ccm_lock;
12 void imx_check_clocks(struct clk *clks[], unsigned int count);
13 void imx_check_clk_hws(struct clk_hw *clks[], unsigned int count);
14 void imx_register_uart_clocks(struct clk ** const clks[]);
15 void imx_mmdc_mask_handshake(void __iomem *ccm_base, unsigned int chn);
16 void imx_unregister_clocks(struct clk *clks[], unsigned int count);
17 void imx_unregister_hw_clocks(struct clk_hw *hws[], unsigned int count);
19 extern void imx_cscmr1_fixup(u32 *val);
30 enum imx_sscg_pll_type {
35 enum imx_pll14xx_type {
40 /* NOTE: Rate table should be kept sorted in descending order. */
41 struct imx_pll14xx_rate_table {
49 struct imx_pll14xx_clk {
50 enum imx_pll14xx_type type;
51 const struct imx_pll14xx_rate_table *rate_table;
56 extern struct imx_pll14xx_clk imx_1416x_pll;
57 extern struct imx_pll14xx_clk imx_1443x_pll;
58 extern struct imx_pll14xx_clk imx_1443x_dram_pll;
60 #define imx_clk_cpu(name, parent_name, div, mux, pll, step) \
61 to_clk(imx_clk_hw_cpu(name, parent_name, div, mux, pll, step))
63 #define clk_register_gate2(dev, name, parent_name, flags, reg, bit_idx, \
64 cgr_val, clk_gate_flags, lock, share_count) \
65 to_clk(clk_hw_register_gate2(dev, name, parent_name, flags, reg, bit_idx, \
66 cgr_val, clk_gate_flags, lock, share_count))
68 #define imx_clk_pllv3(type, name, parent_name, base, div_mask) \
69 to_clk(imx_clk_hw_pllv3(type, name, parent_name, base, div_mask))
71 #define imx_clk_pfd(name, parent_name, reg, idx) \
72 to_clk(imx_clk_hw_pfd(name, parent_name, reg, idx))
74 #define imx_clk_gate_exclusive(name, parent, reg, shift, exclusive_mask) \
75 to_clk(imx_clk_hw_gate_exclusive(name, parent, reg, shift, exclusive_mask))
77 #define imx_clk_fixed(name, rate) \
78 to_clk(imx_clk_hw_fixed(name, rate))
80 #define imx_clk_fixed_factor(name, parent, mult, div) \
81 to_clk(imx_clk_hw_fixed_factor(name, parent, mult, div))
83 #define imx_clk_divider(name, parent, reg, shift, width) \
84 to_clk(imx_clk_hw_divider(name, parent, reg, shift, width))
86 #define imx_clk_divider2(name, parent, reg, shift, width) \
87 to_clk(imx_clk_hw_divider2(name, parent, reg, shift, width))
89 #define imx_clk_divider_flags(name, parent, reg, shift, width, flags) \
90 to_clk(imx_clk_hw_divider_flags(name, parent, reg, shift, width, flags))
92 #define imx_clk_gate(name, parent, reg, shift) \
93 to_clk(imx_clk_hw_gate(name, parent, reg, shift))
95 #define imx_clk_gate_dis(name, parent, reg, shift) \
96 to_clk(imx_clk_hw_gate_dis(name, parent, reg, shift))
98 #define imx_clk_gate2(name, parent, reg, shift) \
99 to_clk(imx_clk_hw_gate2(name, parent, reg, shift))
101 #define imx_clk_gate2_flags(name, parent, reg, shift, flags) \
102 to_clk(imx_clk_hw_gate2_flags(name, parent, reg, shift, flags))
104 #define imx_clk_gate2_shared2(name, parent, reg, shift, share_count) \
105 to_clk(imx_clk_hw_gate2_shared2(name, parent, reg, shift, share_count))
107 #define imx_clk_gate3(name, parent, reg, shift) \
108 to_clk(imx_clk_hw_gate3(name, parent, reg, shift))
110 #define imx_clk_gate4(name, parent, reg, shift) \
111 to_clk(imx_clk_hw_gate4(name, parent, reg, shift))
113 #define imx_clk_mux(name, reg, shift, width, parents, num_parents) \
114 to_clk(imx_clk_hw_mux(name, reg, shift, width, parents, num_parents))
116 #define imx_clk_pllv1(type, name, parent, base) \
117 to_clk(imx_clk_hw_pllv1(type, name, parent, base))
119 #define imx_clk_pllv2(name, parent, base) \
120 to_clk(imx_clk_hw_pllv2(name, parent, base))
122 #define imx_clk_frac_pll(name, parent_name, base) \
123 to_clk(imx_clk_hw_frac_pll(name, parent_name, base))
125 #define imx_clk_sscg_pll(name, parent_names, num_parents, parent,\
126 bypass1, bypass2, base, flags) \
127 to_clk(imx_clk_hw_sscg_pll(name, parent_names, num_parents, parent,\
128 bypass1, bypass2, base, flags))
130 struct clk *imx_clk_pll14xx(const char *name, const char *parent_name,
131 void __iomem *base, const struct imx_pll14xx_clk *pll_clk);
133 #define imx_clk_pll14xx(name, parent_name, base, pll_clk) \
134 to_clk(imx_clk_hw_pll14xx(name, parent_name, base, pll_clk))
136 struct clk_hw *imx_dev_clk_hw_pll14xx(struct device *dev, const char *name,
137 const char *parent_name, void __iomem *base,
138 const struct imx_pll14xx_clk *pll_clk);
140 struct clk_hw *imx_clk_hw_pllv1(enum imx_pllv1_type type, const char *name,
141 const char *parent, void __iomem *base);
143 struct clk_hw *imx_clk_hw_pllv2(const char *name, const char *parent,
146 struct clk_hw *imx_clk_hw_frac_pll(const char *name, const char *parent_name,
149 struct clk_hw *imx_clk_hw_sscg_pll(const char *name,
150 const char * const *parent_names,
152 u8 parent, u8 bypass1, u8 bypass2,
154 unsigned long flags);
156 enum imx_pllv3_type {
169 struct clk_hw *imx_clk_hw_pllv3(enum imx_pllv3_type type, const char *name,
170 const char *parent_name, void __iomem *base, u32 div_mask);
172 #define PLL_1416X_RATE(_rate, _m, _p, _s) \
180 #define PLL_1443X_RATE(_rate, _m, _p, _s, _k) \
189 struct clk_hw *imx_clk_hw_pllv4(const char *name, const char *parent_name,
192 struct clk_hw *clk_hw_register_gate2(struct device *dev, const char *name,
193 const char *parent_name, unsigned long flags,
194 void __iomem *reg, u8 bit_idx, u8 cgr_val,
195 u8 clk_gate_flags, spinlock_t *lock,
196 unsigned int *share_count);
198 struct clk * imx_obtain_fixed_clock(
199 const char *name, unsigned long rate);
201 struct clk_hw *imx_obtain_fixed_clock_hw(
202 const char *name, unsigned long rate);
204 struct clk_hw *imx_obtain_fixed_clk_hw(struct device_node *np,
207 struct clk_hw *imx_clk_hw_gate_exclusive(const char *name, const char *parent,
208 void __iomem *reg, u8 shift, u32 exclusive_mask);
210 struct clk_hw *imx_clk_hw_pfd(const char *name, const char *parent_name,
211 void __iomem *reg, u8 idx);
213 struct clk_hw *imx_clk_hw_pfdv2(const char *name, const char *parent_name,
214 void __iomem *reg, u8 idx);
216 struct clk_hw *imx_clk_hw_busy_divider(const char *name, const char *parent_name,
217 void __iomem *reg, u8 shift, u8 width,
218 void __iomem *busy_reg, u8 busy_shift);
220 struct clk_hw *imx_clk_hw_busy_mux(const char *name, void __iomem *reg, u8 shift,
221 u8 width, void __iomem *busy_reg, u8 busy_shift,
222 const char * const *parent_names, int num_parents);
224 struct clk_hw *imx7ulp_clk_hw_composite(const char *name,
225 const char * const *parent_names,
226 int num_parents, bool mux_present,
227 bool rate_present, bool gate_present,
230 struct clk_hw *imx_clk_hw_fixup_divider(const char *name, const char *parent,
231 void __iomem *reg, u8 shift, u8 width,
232 void (*fixup)(u32 *val));
234 struct clk_hw *imx_clk_hw_fixup_mux(const char *name, void __iomem *reg,
235 u8 shift, u8 width, const char * const *parents,
236 int num_parents, void (*fixup)(u32 *val));
238 static inline struct clk *to_clk(struct clk_hw *hw)
240 if (IS_ERR_OR_NULL(hw))
245 static inline struct clk_hw *imx_clk_hw_pll14xx(const char *name, const char *parent_name,
247 const struct imx_pll14xx_clk *pll_clk)
249 return imx_dev_clk_hw_pll14xx(NULL, name, parent_name, base, pll_clk);
252 static inline struct clk_hw *imx_clk_hw_fixed(const char *name, int rate)
254 return clk_hw_register_fixed_rate(NULL, name, NULL, 0, rate);
257 static inline struct clk_hw *imx_clk_hw_mux_ldb(const char *name, void __iomem *reg,
258 u8 shift, u8 width, const char * const *parents,
261 return clk_hw_register_mux(NULL, name, parents, num_parents,
262 CLK_SET_RATE_NO_REPARENT | CLK_SET_RATE_PARENT, reg,
263 shift, width, CLK_MUX_READ_ONLY, &imx_ccm_lock);
266 static inline struct clk_hw *imx_clk_hw_fixed_factor(const char *name,
267 const char *parent, unsigned int mult, unsigned int div)
269 return clk_hw_register_fixed_factor(NULL, name, parent,
270 CLK_SET_RATE_PARENT, mult, div);
273 static inline struct clk_hw *imx_clk_hw_divider(const char *name,
275 void __iomem *reg, u8 shift,
278 return clk_hw_register_divider(NULL, name, parent, CLK_SET_RATE_PARENT,
279 reg, shift, width, 0, &imx_ccm_lock);
282 static inline struct clk_hw *imx_clk_hw_divider_flags(const char *name,
284 void __iomem *reg, u8 shift,
285 u8 width, unsigned long flags)
287 return clk_hw_register_divider(NULL, name, parent, flags,
288 reg, shift, width, 0, &imx_ccm_lock);
291 static inline struct clk_hw *imx_clk_hw_divider2(const char *name, const char *parent,
292 void __iomem *reg, u8 shift, u8 width)
294 return clk_hw_register_divider(NULL, name, parent,
295 CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
296 reg, shift, width, 0, &imx_ccm_lock);
299 static inline struct clk *imx_clk_divider2_flags(const char *name,
300 const char *parent, void __iomem *reg, u8 shift, u8 width,
303 return clk_register_divider(NULL, name, parent,
304 flags | CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
305 reg, shift, width, 0, &imx_ccm_lock);
308 static inline struct clk_hw *imx_clk_hw_gate_flags(const char *name, const char *parent,
309 void __iomem *reg, u8 shift, unsigned long flags)
311 return clk_hw_register_gate(NULL, name, parent, flags | CLK_SET_RATE_PARENT, reg,
312 shift, 0, &imx_ccm_lock);
315 static inline struct clk_hw *imx_clk_hw_gate(const char *name, const char *parent,
316 void __iomem *reg, u8 shift)
318 return clk_hw_register_gate(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
319 shift, 0, &imx_ccm_lock);
322 static inline struct clk_hw *imx_dev_clk_hw_gate(struct device *dev, const char *name,
323 const char *parent, void __iomem *reg, u8 shift)
325 return clk_hw_register_gate(dev, name, parent, CLK_SET_RATE_PARENT, reg,
326 shift, 0, &imx_ccm_lock);
329 static inline struct clk_hw *imx_clk_hw_gate_dis(const char *name, const char *parent,
330 void __iomem *reg, u8 shift)
332 return clk_hw_register_gate(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
333 shift, CLK_GATE_SET_TO_DISABLE, &imx_ccm_lock);
336 static inline struct clk_hw *imx_clk_hw_gate_dis_flags(const char *name, const char *parent,
337 void __iomem *reg, u8 shift, unsigned long flags)
339 return clk_hw_register_gate(NULL, name, parent, flags | CLK_SET_RATE_PARENT, reg,
340 shift, CLK_GATE_SET_TO_DISABLE, &imx_ccm_lock);
343 static inline struct clk_hw *imx_clk_hw_gate2(const char *name, const char *parent,
344 void __iomem *reg, u8 shift)
346 return clk_hw_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
347 shift, 0x3, 0, &imx_ccm_lock, NULL);
350 static inline struct clk_hw *imx_clk_hw_gate2_flags(const char *name, const char *parent,
351 void __iomem *reg, u8 shift, unsigned long flags)
353 return clk_hw_register_gate2(NULL, name, parent, flags | CLK_SET_RATE_PARENT, reg,
354 shift, 0x3, 0, &imx_ccm_lock, NULL);
357 static inline struct clk_hw *imx_clk_hw_gate2_shared(const char *name,
358 const char *parent, void __iomem *reg, u8 shift,
359 unsigned int *share_count)
361 return clk_hw_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
362 shift, 0x3, 0, &imx_ccm_lock, share_count);
365 static inline struct clk_hw *imx_clk_hw_gate2_shared2(const char *name,
366 const char *parent, void __iomem *reg, u8 shift,
367 unsigned int *share_count)
369 return clk_hw_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT |
370 CLK_OPS_PARENT_ENABLE, reg, shift, 0x3, 0,
371 &imx_ccm_lock, share_count);
374 static inline struct clk_hw *imx_dev_clk_hw_gate_shared(struct device *dev,
375 const char *name, const char *parent,
376 void __iomem *reg, u8 shift,
377 unsigned int *share_count)
379 return clk_hw_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT |
380 CLK_OPS_PARENT_ENABLE, reg, shift, 0x3,
381 IMX_CLK_GATE2_SINGLE_BIT,
382 &imx_ccm_lock, share_count);
385 static inline struct clk *imx_clk_gate2_cgr(const char *name,
386 const char *parent, void __iomem *reg, u8 shift, u8 cgr_val)
388 return clk_register_gate2(NULL, name, parent, CLK_SET_RATE_PARENT, reg,
389 shift, cgr_val, 0, &imx_ccm_lock, NULL);
392 static inline struct clk_hw *imx_clk_hw_gate3(const char *name, const char *parent,
393 void __iomem *reg, u8 shift)
395 return clk_hw_register_gate(NULL, name, parent,
396 CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
397 reg, shift, 0, &imx_ccm_lock);
400 static inline struct clk_hw *imx_clk_hw_gate3_flags(const char *name,
401 const char *parent, void __iomem *reg, u8 shift,
404 return clk_hw_register_gate(NULL, name, parent,
405 flags | CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
406 reg, shift, 0, &imx_ccm_lock);
409 #define imx_clk_gate3_flags(name, parent, reg, shift, flags) \
410 to_clk(imx_clk_hw_gate3_flags(name, parent, reg, shift, flags))
412 static inline struct clk_hw *imx_clk_hw_gate4(const char *name, const char *parent,
413 void __iomem *reg, u8 shift)
415 return clk_hw_register_gate2(NULL, name, parent,
416 CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
417 reg, shift, 0x3, 0, &imx_ccm_lock, NULL);
420 static inline struct clk_hw *imx_clk_hw_gate4_flags(const char *name,
421 const char *parent, void __iomem *reg, u8 shift,
424 return clk_hw_register_gate2(NULL, name, parent,
425 flags | CLK_SET_RATE_PARENT | CLK_OPS_PARENT_ENABLE,
426 reg, shift, 0x3, 0, &imx_ccm_lock, NULL);
429 #define imx_clk_gate4_flags(name, parent, reg, shift, flags) \
430 to_clk(imx_clk_hw_gate4_flags(name, parent, reg, shift, flags))
432 static inline struct clk_hw *imx_clk_hw_mux(const char *name, void __iomem *reg,
433 u8 shift, u8 width, const char * const *parents,
436 return clk_hw_register_mux(NULL, name, parents, num_parents,
437 CLK_SET_RATE_NO_REPARENT, reg, shift,
438 width, 0, &imx_ccm_lock);
441 static inline struct clk_hw *imx_dev_clk_hw_mux(struct device *dev,
442 const char *name, void __iomem *reg, u8 shift,
443 u8 width, const char * const *parents, int num_parents)
445 return clk_hw_register_mux(dev, name, parents, num_parents,
446 CLK_SET_RATE_NO_REPARENT | CLK_SET_PARENT_GATE,
447 reg, shift, width, 0, &imx_ccm_lock);
450 static inline struct clk *imx_clk_mux2(const char *name, void __iomem *reg,
451 u8 shift, u8 width, const char * const *parents,
454 return clk_register_mux(NULL, name, parents, num_parents,
455 CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE,
456 reg, shift, width, 0, &imx_ccm_lock);
459 static inline struct clk_hw *imx_clk_hw_mux2(const char *name, void __iomem *reg,
461 const char * const *parents,
464 return clk_hw_register_mux(NULL, name, parents, num_parents,
465 CLK_SET_RATE_NO_REPARENT |
466 CLK_OPS_PARENT_ENABLE,
467 reg, shift, width, 0, &imx_ccm_lock);
470 static inline struct clk *imx_clk_mux_flags(const char *name,
471 void __iomem *reg, u8 shift, u8 width,
472 const char * const *parents, int num_parents,
475 return clk_register_mux(NULL, name, parents, num_parents,
476 flags | CLK_SET_RATE_NO_REPARENT, reg, shift, width, 0,
480 static inline struct clk_hw *imx_clk_hw_mux2_flags(const char *name,
481 void __iomem *reg, u8 shift, u8 width,
482 const char * const *parents,
483 int num_parents, unsigned long flags)
485 return clk_hw_register_mux(NULL, name, parents, num_parents,
486 flags | CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE,
487 reg, shift, width, 0, &imx_ccm_lock);
490 static inline struct clk *imx_clk_mux2_flags(const char *name,
491 void __iomem *reg, u8 shift, u8 width,
492 const char * const *parents,
493 int num_parents, unsigned long flags)
495 return clk_register_mux(NULL, name, parents, num_parents,
496 flags | CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE,
497 reg, shift, width, 0, &imx_ccm_lock);
500 static inline struct clk_hw *imx_clk_hw_mux_flags(const char *name,
501 void __iomem *reg, u8 shift,
503 const char * const *parents,
507 return clk_hw_register_mux(NULL, name, parents, num_parents,
508 flags | CLK_SET_RATE_NO_REPARENT,
509 reg, shift, width, 0, &imx_ccm_lock);
512 static inline struct clk_hw *imx_dev_clk_hw_mux_flags(struct device *dev,
514 void __iomem *reg, u8 shift,
516 const char * const *parents,
520 return clk_hw_register_mux(dev, name, parents, num_parents,
521 flags | CLK_SET_RATE_NO_REPARENT,
522 reg, shift, width, 0, &imx_ccm_lock);
525 struct clk_hw *imx_clk_hw_cpu(const char *name, const char *parent_name,
526 struct clk *div, struct clk *mux, struct clk *pll,
529 #define IMX_COMPOSITE_CORE BIT(0)
530 #define IMX_COMPOSITE_BUS BIT(1)
532 struct clk_hw *imx8m_clk_hw_composite_flags(const char *name,
533 const char * const *parent_names,
537 unsigned long flags);
539 #define imx8m_clk_hw_composite_bus(name, parent_names, reg) \
540 imx8m_clk_hw_composite_flags(name, parent_names, \
541 ARRAY_SIZE(parent_names), reg, \
543 CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE)
545 #define imx8m_clk_hw_composite_core(name, parent_names, reg) \
546 imx8m_clk_hw_composite_flags(name, parent_names, \
547 ARRAY_SIZE(parent_names), reg, \
548 IMX_COMPOSITE_CORE, \
549 CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE)
551 #define imx8m_clk_composite_flags(name, parent_names, num_parents, reg, \
553 to_clk(imx8m_clk_hw_composite_flags(name, parent_names, \
554 num_parents, reg, 0, flags))
556 #define __imx8m_clk_hw_composite(name, parent_names, reg, flags) \
557 imx8m_clk_hw_composite_flags(name, parent_names, \
558 ARRAY_SIZE(parent_names), reg, 0, \
559 flags | CLK_SET_RATE_NO_REPARENT | CLK_OPS_PARENT_ENABLE)
561 #define __imx8m_clk_composite(name, parent_names, reg, flags) \
562 to_clk(__imx8m_clk_hw_composite(name, parent_names, reg, flags))
564 #define imx8m_clk_hw_composite(name, parent_names, reg) \
565 __imx8m_clk_hw_composite(name, parent_names, reg, 0)
567 #define imx8m_clk_composite(name, parent_names, reg) \
568 __imx8m_clk_composite(name, parent_names, reg, 0)
570 #define imx8m_clk_hw_composite_critical(name, parent_names, reg) \
571 __imx8m_clk_hw_composite(name, parent_names, reg, CLK_IS_CRITICAL)
573 #define imx8m_clk_composite_critical(name, parent_names, reg) \
574 __imx8m_clk_composite(name, parent_names, reg, CLK_IS_CRITICAL)
576 struct clk_hw *imx_clk_hw_divider_gate(const char *name, const char *parent_name,
577 unsigned long flags, void __iomem *reg, u8 shift, u8 width,
578 u8 clk_divider_flags, const struct clk_div_table *table,