xref: /freebsd/sys/dev/qcom_clk/qcom_clk_rcg2.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1e34a491bSAdrian Chadd /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3e34a491bSAdrian Chadd  *
4e34a491bSAdrian Chadd  * Copyright (c) 2021 Adrian Chadd <adrian@FreeBSD.org>
5e34a491bSAdrian Chadd  *
6e34a491bSAdrian Chadd  * Redistribution and use in source and binary forms, with or without
7e34a491bSAdrian Chadd  * modification, are permitted provided that the following conditions
8e34a491bSAdrian Chadd  * are met:
9e34a491bSAdrian Chadd  * 1. Redistributions of source code must retain the above copyright
10e34a491bSAdrian Chadd  *    notice, this list of conditions and the following disclaimer.
11e34a491bSAdrian Chadd  * 2. Redistributions in binary form must reproduce the above copyright
12e34a491bSAdrian Chadd  *    notice, this list of conditions and the following disclaimer in the
13e34a491bSAdrian Chadd  *    documentation and/or other materials provided with the distribution.
14e34a491bSAdrian Chadd  *
15e34a491bSAdrian Chadd  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16e34a491bSAdrian Chadd  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17e34a491bSAdrian Chadd  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18e34a491bSAdrian Chadd  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19e34a491bSAdrian Chadd  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20e34a491bSAdrian Chadd  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21e34a491bSAdrian Chadd  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22e34a491bSAdrian Chadd  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23e34a491bSAdrian Chadd  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24e34a491bSAdrian Chadd  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25e34a491bSAdrian Chadd  * SUCH DAMAGE.
26e34a491bSAdrian Chadd  */
27e34a491bSAdrian Chadd 
28e34a491bSAdrian Chadd #ifndef	__QCOM_CLK_RCG2_H__
29e34a491bSAdrian Chadd #define	__QCOM_CLK_RCG2_H__
30e34a491bSAdrian Chadd 
31e34a491bSAdrian Chadd #include "qcom_clk_freqtbl.h"
32e34a491bSAdrian Chadd 
33e34a491bSAdrian Chadd /* Flags */
34e34a491bSAdrian Chadd /* Set the rate on the parent clock, not just ours */
35e34a491bSAdrian Chadd #define	QCOM_CLK_RCG2_FLAGS_SET_RATE_PARENT		0x1
36e34a491bSAdrian Chadd /* Must not stop this clock/gate! */
37e34a491bSAdrian Chadd #define	QCOM_CLK_RCG2_FLAGS_CRITICAL			0x2
38e34a491bSAdrian Chadd 
39e34a491bSAdrian Chadd /* prediv to hw mapping */
40e34a491bSAdrian Chadd #define	QCOM_CLK_FREQTBL_PREDIV_RCG2(prediv)		(2*(prediv)-1)
41e34a491bSAdrian Chadd 
42e34a491bSAdrian Chadd struct qcom_clk_rcg2_def {
43e34a491bSAdrian Chadd 	struct clknode_init_def clkdef;
44e34a491bSAdrian Chadd 	uint32_t cmd_rcgr;		/* rcg2 register start */
45e34a491bSAdrian Chadd 	uint32_t hid_width;		/* pre-divisor width */
46e34a491bSAdrian Chadd 	uint32_t mnd_width;		/* mn:d divisor width */
47e34a491bSAdrian Chadd 	int32_t safe_src_idx;		/* safe parent when disabling a shared
48e34a491bSAdrian Chadd 					 * rcg2 */
49e34a491bSAdrian Chadd 	uint32_t cfg_offset;		/* cfg offset after cmd_rcgr */
50e34a491bSAdrian Chadd 	int32_t safe_pre_parent_idx;	/* safe parent before switching
51e34a491bSAdrian Chadd 					 * parent mux */
52e34a491bSAdrian Chadd 	uint32_t flags;
53e34a491bSAdrian Chadd 	const struct qcom_clk_freq_tbl *freq_tbl;
54e34a491bSAdrian Chadd };
55e34a491bSAdrian Chadd 
56e34a491bSAdrian Chadd extern	int qcom_clk_rcg2_register(struct clkdom *clkdom,
57e34a491bSAdrian Chadd 	    struct qcom_clk_rcg2_def *clkdef);
58e34a491bSAdrian Chadd 
59e34a491bSAdrian Chadd #endif	/* __QCOM_CLK_RCG2_H__ */
60