1 /******************************************************************************
2  *
3  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
4  * Analog Devices, Inc.),
5  * Copyright (C) 2023-2024 Analog Devices, Inc.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ******************************************************************************/
20 
21 #ifndef LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32680_INCLUDE_SYSTEM_MAX32680_H_
22 #define LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32680_INCLUDE_SYSTEM_MAX32680_H_
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #include <stdint.h>
29 
30 /*----------------------------------------------------------------------------
31   Define clocks
32  *----------------------------------------------------------------------------*/
33 
34 /* NOTE: HIRC was previously named CRYPTO */
35 #ifdef CRYPTO_FREQ
36 #warning WARNING: CRYPTO_FREQ does not exist in MAX32680, replace with HIRC_FREQ!
37 #define HIRC_FREQ CRYPTO_FREQ
38 #endif
39 
40 /* NOTE: EXTCLK needs to be defined by user based on the clock they supply */
41 #ifndef EXTCLK_FREQ
42 #define EXTCLK_FREQ 75000000
43 #endif
44 
45 /* NOTE: This is the nominal value for INRO. The actual value may vary from chip to chip.
46          Update if use of this oscillator requires precise timing.*/
47 /* NOTE: INRO was previously named NANORING */
48 #ifndef INRO_FREQ
49 #define INRO_FREQ 8000
50 #endif
51 
52 #ifndef IPO_FREQ
53 #define IPO_FREQ 100000000
54 #endif
55 
56 #ifndef ISO_FREQ
57 #define ISO_FREQ 60000000
58 #endif
59 
60 /* NOTE: ERFO_FREQ (16MHz-32MHz) needs to be defined by user based on the clock they supply */
61 #ifndef ERFO_FREQ
62 #define ERFO_FREQ 32000000
63 #endif
64 
65 #ifndef IBRO_FREQ
66 #define IBRO_FREQ 7372800
67 #endif
68 
69 #ifndef ERTCO_FREQ
70 #define ERTCO_FREQ 32768
71 #endif
72 
73 #ifndef HIRC_FREQ
74 #define HIRC_FREQ IPO_FREQ
75 #endif
76 
77 extern uint32_t SystemCoreClock; /*!< System Clock Frequency (Core Clock)  */
78 #ifdef PeripheralClock
79 #warning PeripheralClock define is being overidden.
80 #else
81 #define PeripheralClock (SystemCoreClock / 2) /*!< Peripheral Clock Frequency */
82 #endif
83 
84 /*
85  * Initialize the system
86  *
87  * @brief  Setup the microcontroller system.
88  *         Initialize the System and update the SystemCoreClock variable.
89  */
90 void SystemInit(void);
91 
92 /*
93  * Update SystemCoreClock variable
94  *
95  * @brief  Updates the SystemCoreClock with current core Clock
96  *         retrieved from cpu registers.
97  */
98 void SystemCoreClockUpdate(void);
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif // LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32680_INCLUDE_SYSTEM_MAX32680_H_
105