MAX32655 Peripheral Driver API
Peripheral Driver API for the MAX32655
system_max32655.h
1 /*******************************************************************************
2  * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
18  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Except as contained in this notice, the name of Maxim Integrated
23  * Products, Inc. shall not be used except as stated in the Maxim Integrated
24  * Products, Inc. Branding Policy.
25  *
26  * The mere transfer of this software does not imply any licenses
27  * of trade secrets, proprietary technology, copyrights, patents,
28  * trademarks, maskwork rights, or any other form of intellectual
29  * property whatsoever. Maxim Integrated Products, Inc. retains all
30  * ownership rights.
31  *
32  ******************************************************************************/
33 
34 #ifndef _SYSTEM_MAX78000_H_
35 #define _SYSTEM_MAX78000_H_
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 #include <stdint.h>
42 
43 /*----------------------------------------------------------------------------
44  Define clocks
45  *----------------------------------------------------------------------------*/
46 
47 /* NOTE: HIRC was previously named CRYPTO */
48 #ifdef CRYPTO_FREQ
49 #warning WARNING: CRYPTO_FREQ does not exist in MAX78000, replace with HIRC_FREQ!
50 #define HIRC_FREQ CRYPTO_FREQ
51 #endif
52 
53 /* NOTE: EXTCLK needs to be defined by user based on the clock they supply */
54 #ifndef EXTCLK_FREQ
55 #define EXTCLK_FREQ 75000000
56 #endif
57 
58 /* NOTE: INRO was previously named NANORING */
59 #ifndef INRO_FREQ
60 #define INRO_FREQ 8000
61 #endif
62 
63 #ifndef IPO_FREQ
64 #define IPO_FREQ 100000000
65 #endif
66 
67 #ifndef ERFO_FREQ
68 #define ERFO_FREQ 27120000
69 #endif
70 
71 #ifndef IBRO_FREQ
72 #define IBRO_FREQ 7372800
73 #endif
74 
75 #ifndef ERTCO_FREQ
76 #define ERTCO_FREQ 32768
77 #endif
78 
79 #ifndef HIRC_FREQ
80 #define HIRC_FREQ IPO_FREQ
81 #endif
82 
83 extern uint32_t SystemCoreClock;
84 #ifdef PeripheralClock
85 #warning PeripheralClock define is being overidden.
86 #else
87 #define PeripheralClock (SystemCoreClock /2)
88 #endif
89 
90 /*
91  * Initialize the system
92  *
93  * @brief Setup the microcontroller system.
94  * Initialize the System and update the SystemCoreClock variable.
95  */
96 void SystemInit(void);
97 
98 /*
99  * Update SystemCoreClock variable
100  *
101  * @brief Updates the SystemCoreClock with current core Clock
102  * retrieved from cpu registers.
103  */
104 void SystemCoreClockUpdate(void);
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif /* _SYSTEM_MAX32655_H_ */