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_MAX32570_INCLUDE_SYSTEM_MAX32570_H_
22 #define LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32570_INCLUDE_SYSTEM_MAX32570_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 MAX32570, replace with ISO_FREQ!
37 #define ISO_FREQ CRYPTO_FREQ
38 #endif
39 
40 /* NOTE: ISO was previously HIRC. */
41 #ifndef ISO_FREQ
42 #define ISO_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: INO was previosly LIRC8  */
48 #ifndef INRO_FREQ
49 #define INRO_FREQ 8000
50 #endif
51 
52 /* NOTE: IPO was previously HIRC96. */
53 #ifndef IPO_FREQ
54 #define IPO_FREQ 150000000
55 #endif
56 
57 /* NOTE: IBRO was previously HIRC8M. */
58 #ifndef IBRO_FREQ
59 #define IBRO_FREQ 7372800
60 #endif
61 
62 /* NOTE: ERFO was previously XTAL27M. */
63 #ifndef ERFO_FREQ
64 #define ERFO_FREQ 27120000
65 #endif
66 
67 /* NOTE: ERTCO was previously XTAL32K. */
68 #ifndef ERTCO_FREQ
69 #define ERTCO_FREQ 32768
70 #endif
71 
72 extern uint32_t SystemCoreClock; /*!< System Clock Frequency (Core Clock)  */
73 #ifdef PeripheralClock
74 #warning PeripheralClock define is being overidden.
75 #else
76 #define PeripheralClock (SystemCoreClock / 2) /*!< Peripheral Clock Frequency */
77 #endif
78 
79 /*
80  * Initialize the system
81  *
82  * @brief  Setup the microcontroller system.
83  *         Initialize the System and update the SystemCoreClock variable.
84  */
85 void SystemInit(void);
86 
87 /*
88  * Update SystemCoreClock variable
89  *
90  * @brief  Updates the SystemCoreClock with current core Clock
91  *         retrieved from cpu registers.
92  */
93 void SystemCoreClockUpdate(void);
94 
95 #ifdef __cplusplus
96 }
97 #endif
98 
99 #endif // LIBRARIES_CMSIS_DEVICE_MAXIM_MAX32570_INCLUDE_SYSTEM_MAX32570_H_
100