xref: /freebsd/sys/arm64/qoriq/clk/qoriq_clkgen.h (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2020 Alstom Group.
5  * Copyright (c) 2020 Semihalf.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  */
29 
30 #ifndef	_QORIQ_CLKGEN_H_
31 #define	_QORIQ_CLKGEN_H_
32 
33 #include <dev/extres/clk/clk.h>
34 #include <dev/extres/clk/clk_mux.h>
35 
36 #include <arm64/qoriq/clk/qoriq_clk_pll.h>
37 
38 #define	QORIQ_CLK_NAME_MAX_LEN	32
39 
40 #define	QORIQ_LITTLE_ENDIAN	0x01
41 
42 #define	QORIQ_TYPE_SYSCLK	0
43 #define	QORIQ_TYPE_CMUX		1
44 #define	QORIQ_TYPE_HWACCEL	2
45 #define	QORIQ_TYPE_FMAN		3
46 #define	QORIQ_TYPE_PLATFORM_PLL	4
47 #define	QORIQ_TYPE_CORECLK	5
48 #define	QORIQ_TYPE_INTERNAL	6
49 
50 #define	PLL_DIV1	0
51 #define	PLL_DIV2	1
52 #define	PLL_DIV3	2
53 #define	PLL_DIV4	3
54 #define	PLL_DIV5	4
55 #define	PLL_DIV6	5
56 #define	PLL_DIV7	6
57 #define	PLL_DIV8	7
58 #define	PLL_DIV9	8
59 #define	PLL_DIV10	9
60 #define	PLL_DIV11	10
61 #define	PLL_DIV12	11
62 #define	PLL_DIV13	12
63 #define	PLL_DIV14	13
64 #define	PLL_DIV15	14
65 #define	PLL_DIV16	15
66 
67 #define	QORIQ_CLK_ID(_type, _index)	((_type << 8) + _index)
68 
69 #define	QORIQ_SYSCLK_NAME	"clockgen_sysclk"
70 #define	QORIQ_CORECLK_NAME	"clockgen_coreclk"
71 
72 typedef int (*qoriq_init_func_t)(device_t);
73 
74 struct qoriq_clkgen_softc {
75 	device_t			dev;
76 	struct resource			*res;
77 	struct clkdom			*clkdom;
78 	struct mtx			mtx;
79 	struct qoriq_clk_pll_def	*pltfrm_pll_def;
80 	struct qoriq_clk_pll_def	**cga_pll;
81 	int				cga_pll_num;
82 	struct clk_mux_def		**mux;
83 	int				mux_num;
84 	qoriq_init_func_t		init_func;
85 	uint32_t			flags;
86 	bool				has_coreclk;
87 };
88 
89 MALLOC_DECLARE(M_QORIQ_CLKGEN);
90 DECLARE_CLASS(qoriq_clkgen_driver);
91 
92 int qoriq_clkgen_attach(device_t);
93 
94 #endif	/* _QORIQ_CLKGEN_H_ */
95