xref: /linux/drivers/clk/imx/clk-scu.h (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright 2018-2021 NXP
4  *   Dong Aisheng <aisheng.dong@nxp.com>
5  */
6 
7 #ifndef __IMX_CLK_SCU_H
8 #define __IMX_CLK_SCU_H
9 
10 #include <linux/firmware/imx/sci.h>
11 #include <linux/of.h>
12 
13 #define IMX_SCU_GPR_CLK_GATE	BIT(0)
14 #define IMX_SCU_GPR_CLK_DIV	BIT(1)
15 #define IMX_SCU_GPR_CLK_MUX	BIT(2)
16 
17 struct imx_clk_scu_rsrc_table {
18 	const u32 *rsrc;
19 	u8 num;
20 };
21 
22 extern struct list_head imx_scu_clks[];
23 extern const struct dev_pm_ops imx_clk_lpcg_scu_pm_ops;
24 extern const struct imx_clk_scu_rsrc_table imx_clk_scu_rsrc_imx8dxl;
25 extern const struct imx_clk_scu_rsrc_table imx_clk_scu_rsrc_imx8qxp;
26 extern const struct imx_clk_scu_rsrc_table imx_clk_scu_rsrc_imx8qm;
27 
28 int imx_clk_scu_init(struct device_node *np,
29 		     const struct imx_clk_scu_rsrc_table *data);
30 struct clk_hw *imx_scu_of_clk_src_get(struct of_phandle_args *clkspec,
31 				      void *data);
32 struct clk_hw *imx_clk_scu_alloc_dev(const char *name,
33 				     const char * const *parents,
34 				     int num_parents, u32 rsrc_id, u8 clk_type);
35 
36 struct clk_hw *__imx_clk_scu(struct device *dev, const char *name,
37 			     const char * const *parents, int num_parents,
38 			     u32 rsrc_id, u8 clk_type);
39 
40 void imx_clk_scu_unregister(void);
41 
42 struct clk_hw *__imx_clk_lpcg_scu(struct device *dev, const char *name,
43 				  const char *parent_name, unsigned long flags,
44 				  void __iomem *reg, u8 bit_idx, bool hw_gate);
45 void imx_clk_lpcg_scu_unregister(struct clk_hw *hw);
46 
47 struct clk_hw *__imx_clk_gpr_scu(const char *name, const char * const *parent_name,
48 				 int num_parents, u32 rsrc_id, u8 gpr_id, u8 flags,
49 				 bool invert);
50 
51 static inline struct clk_hw *imx_clk_scu(const char *name, u32 rsrc_id,
52 					 u8 clk_type)
53 {
54 	return imx_clk_scu_alloc_dev(name, NULL, 0, rsrc_id, clk_type);
55 }
56 
57 static inline struct clk_hw *imx_clk_scu2(const char *name, const char * const *parents,
58 					  int num_parents, u32 rsrc_id, u8 clk_type)
59 {
60 	return imx_clk_scu_alloc_dev(name, parents, num_parents, rsrc_id, clk_type);
61 }
62 
63 static inline struct clk_hw *imx_clk_lpcg_scu_dev(struct device *dev, const char *name,
64 						  const char *parent_name, unsigned long flags,
65 						  void __iomem *reg, u8 bit_idx, bool hw_gate)
66 {
67 	return __imx_clk_lpcg_scu(dev, name, parent_name, flags, reg,
68 				  bit_idx, hw_gate);
69 }
70 
71 static inline struct clk_hw *imx_clk_lpcg_scu(const char *name, const char *parent_name,
72 					      unsigned long flags, void __iomem *reg,
73 					      u8 bit_idx, bool hw_gate)
74 {
75 	return __imx_clk_lpcg_scu(NULL, name, parent_name, flags, reg,
76 				  bit_idx, hw_gate);
77 }
78 
79 static inline struct clk_hw *imx_clk_gate_gpr_scu(const char *name, const char *parent_name,
80 						  u32 rsrc_id, u8 gpr_id, bool invert)
81 {
82 	return __imx_clk_gpr_scu(name, &parent_name, 1, rsrc_id, gpr_id,
83 				 IMX_SCU_GPR_CLK_GATE, invert);
84 }
85 
86 static inline struct clk_hw *imx_clk_divider_gpr_scu(const char *name, const char *parent_name,
87 						     u32 rsrc_id, u8 gpr_id)
88 {
89 	return __imx_clk_gpr_scu(name, &parent_name, 1, rsrc_id, gpr_id,
90 				 IMX_SCU_GPR_CLK_DIV, 0);
91 }
92 
93 static inline struct clk_hw *imx_clk_mux_gpr_scu(const char *name, const char * const *parent_names,
94 						 int num_parents, u32 rsrc_id, u8 gpr_id)
95 {
96 	return __imx_clk_gpr_scu(name, parent_names, num_parents, rsrc_id,
97 				 gpr_id, IMX_SCU_GPR_CLK_MUX, 0);
98 }
99 #endif
100