1 /******************************************************************************
2 * Filename: ccfgread.h
3 *
4 * Description: API for reading CCFG.
5 *
6 * Copyright (c) 2015 - 2022, Texas Instruments Incorporated
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1) Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2) Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3) Neither the name of the ORGANIZATION nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************/
36
37 //*****************************************************************************
38 //
39 //! \addtogroup system_control_group
40 //! @{
41 //! \addtogroup ccfgread_api
42 //! @{
43 //
44 //*****************************************************************************
45
46 #ifndef __CCFGREAD_H__
47 #define __CCFGREAD_H__
48
49 //*****************************************************************************
50 //
51 // If building with a C++ compiler, make all of the definitions in this header
52 // have a C binding.
53 //
54 //*****************************************************************************
55 #ifdef __cplusplus
56 extern "C"
57 {
58 #endif
59
60 #include <stdbool.h>
61 #include <stdint.h>
62 #include "../inc/hw_types.h"
63 #include "../inc/hw_memmap.h"
64 #include "../inc/hw_ccfg.h"
65
66 //*****************************************************************************
67 //
68 // General constants and defines
69 //
70 //*****************************************************************************
71
72
73 //*****************************************************************************
74 //
75 // API Functions and prototypes
76 //
77 //*****************************************************************************
78
79 //*****************************************************************************
80 //
81 //! \brief Read DIS_GPRAM from CCFG.
82 //!
83 //! \return Value of CCFG field CCFG_SIZE_AND_DIS_FLAGS_DIS_GPRAM
84 //
85 //*****************************************************************************
86 __STATIC_INLINE bool
CCFGRead_DIS_GPRAM(void)87 CCFGRead_DIS_GPRAM( void )
88 {
89 return (( HWREG( CCFG_BASE + CCFG_O_SIZE_AND_DIS_FLAGS ) &
90 CCFG_SIZE_AND_DIS_FLAGS_DIS_GPRAM_M ) >>
91 CCFG_SIZE_AND_DIS_FLAGS_DIS_GPRAM_S ) ;
92 }
93
94 //*****************************************************************************
95 //
96 //! \brief Read EXT_LF_CLK_DIO from CCFG.
97 //!
98 //! \return Value of CCFG field CCFG_EXT_LF_CLK_DIO
99 //
100 //*****************************************************************************
101 __STATIC_INLINE bool
CCFGRead_EXT_LF_CLK_DIO(void)102 CCFGRead_EXT_LF_CLK_DIO( void )
103 {
104 return (( HWREG( CCFG_BASE + CCFG_O_EXT_LF_CLK ) &
105 CCFG_EXT_LF_CLK_DIO_M ) >>
106 CCFG_EXT_LF_CLK_DIO_S ) ;
107 }
108
109 //*****************************************************************************
110 //
111 // Defines the possible values returned from CCFGRead_SCLK_LF_OPTION()
112 //
113 //*****************************************************************************
114 #define CCFGREAD_SCLK_LF_OPTION_XOSC_HF_DLF ( CCFG_MODE_CONF_SCLK_LF_OPTION_XOSC_HF_DLF >> CCFG_MODE_CONF_SCLK_LF_OPTION_S )
115 #define CCFGREAD_SCLK_LF_OPTION_EXTERNAL_LF ( CCFG_MODE_CONF_SCLK_LF_OPTION_EXTERNAL_LF >> CCFG_MODE_CONF_SCLK_LF_OPTION_S )
116 #define CCFGREAD_SCLK_LF_OPTION_XOSC_LF ( CCFG_MODE_CONF_SCLK_LF_OPTION_XOSC_LF >> CCFG_MODE_CONF_SCLK_LF_OPTION_S )
117 #define CCFGREAD_SCLK_LF_OPTION_RCOSC_LF ( CCFG_MODE_CONF_SCLK_LF_OPTION_RCOSC_LF >> CCFG_MODE_CONF_SCLK_LF_OPTION_S )
118
119 //*****************************************************************************
120 //
121 //! \brief Read SCLK_LF_OPTION from CCFG.
122 //!
123 //! \return Returns the value of the CCFG field CCFG_MODE_CONF_SCLK_LF_OPTION field.
124 //! Returns one of the following:
125 //! - \ref CCFGREAD_SCLK_LF_OPTION_XOSC_HF_DLF
126 //! - \ref CCFGREAD_SCLK_LF_OPTION_EXTERNAL_LF
127 //! - \ref CCFGREAD_SCLK_LF_OPTION_XOSC_LF
128 //! - \ref CCFGREAD_SCLK_LF_OPTION_RCOSC_LF
129 //
130 //*****************************************************************************
131 __STATIC_INLINE uint32_t
CCFGRead_SCLK_LF_OPTION(void)132 CCFGRead_SCLK_LF_OPTION( void )
133 {
134 return (( HWREG( CCFG_BASE + CCFG_O_MODE_CONF ) &
135 CCFG_MODE_CONF_SCLK_LF_OPTION_M ) >>
136 CCFG_MODE_CONF_SCLK_LF_OPTION_S ) ;
137 }
138
139 //*****************************************************************************
140 //
141 // Defines the possible values returned from CCFGRead_XOSC_FREQ()
142 //
143 //*****************************************************************************
144 #define CCFGREAD_XOSC_FREQ_24M ( CCFG_MODE_CONF_XOSC_FREQ_24M >> CCFG_MODE_CONF_XOSC_FREQ_S )
145 #define CCFGREAD_XOSC_FREQ_48M ( CCFG_MODE_CONF_XOSC_FREQ_48M >> CCFG_MODE_CONF_XOSC_FREQ_S )
146 #define CCFGREAD_XOSC_FREQ_HPOSC ( CCFG_MODE_CONF_XOSC_FREQ_HPOSC >> CCFG_MODE_CONF_XOSC_FREQ_S )
147 #define CCFGREAD_XOSC_FREQ_TCXO ( CCFG_MODE_CONF_XOSC_FREQ_TCXO >> CCFG_MODE_CONF_XOSC_FREQ_S )
148
149 //*****************************************************************************
150 //
151 //! \brief Read XOSC_FREQ setting CCFG.
152 //!
153 //! \return Returns the value of the CCFG_MODE_CONF_XOSC_FREQ field.
154 //! Returns one of the following:
155 //! - \ref CCFGREAD_XOSC_FREQ_24M
156 //! - \ref CCFGREAD_XOSC_FREQ_48M
157 //! - \ref CCFGREAD_XOSC_FREQ_HPOSC
158 //! - \ref CCFGREAD_XOSC_FREQ_TCXO
159 //!
160 //
161 //*****************************************************************************
162 __STATIC_INLINE uint32_t
CCFGRead_XOSC_FREQ(void)163 CCFGRead_XOSC_FREQ( void )
164 {
165 return (( HWREG( CCFG_BASE + CCFG_O_MODE_CONF ) &
166 CCFG_MODE_CONF_XOSC_FREQ_M ) >>
167 CCFG_MODE_CONF_XOSC_FREQ_S ) ;
168 }
169
170 //*****************************************************************************
171 //
172 //! \brief Read TCXO_MAX_START setting from CCFG.
173 //!
174 //! \return Returns the value of the CCFG_MODE_CONF_1_TCXO_MAX_START field.
175 //!
176 //
177 //*****************************************************************************
178 __STATIC_INLINE uint32_t
CCFGRead_TCXO_MAX_START(void)179 CCFGRead_TCXO_MAX_START( void )
180 {
181 return (( HWREG( CCFG_BASE + CCFG_O_MODE_CONF_1 ) &
182 CCFG_MODE_CONF_1_TCXO_MAX_START_M ) >>
183 CCFG_MODE_CONF_1_TCXO_MAX_START_S ) ;
184 }
185
186 //*****************************************************************************
187 //
188 //! \brief Read TCXO_TYPE setting from CCFG.
189 //!
190 //! \return Returns the value of the CCFG_MODE_CONF_1_TCXO_TYPE field.
191 //!
192 //
193 //*****************************************************************************
194 __STATIC_INLINE uint32_t
CCFGRead_TCXO_TYPE(void)195 CCFGRead_TCXO_TYPE( void )
196 {
197 return (( HWREG( CCFG_BASE + CCFG_O_MODE_CONF_1 ) &
198 CCFG_MODE_CONF_1_TCXO_TYPE_M ) >>
199 CCFG_MODE_CONF_1_TCXO_TYPE_S ) ;
200 }
201
202 //*****************************************************************************
203 //
204 // Mark the end of the C bindings section for C++ compilers.
205 //
206 //*****************************************************************************
207 #ifdef __cplusplus
208 }
209 #endif
210
211 #endif // __AUX_SMPH_H__
212
213 //*****************************************************************************
214 //
215 //! Close the Doxygen group.
216 //! @}
217 //! @}
218 //
219 //*****************************************************************************
220
