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