MAX32675 Peripheral Driver API
Peripheral Driver API for the MAX32675
system_max32675.h
1 /*******************************************************************************
2  * Copyright (C) 2016 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  * $Date: 2016-03-21 12:44:55 -0700 (Mon, 21 Mar 2016) $
33  * $Revision: 22017 $
34  *
35  ******************************************************************************/
36 
37 #ifndef _SYSTEM_MAX32675_H_
38 #define _SYSTEM_MAX32675_H_
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 #include <stdint.h>
45 
46 /*----------------------------------------------------------------------------
47  Define clocks
48  *----------------------------------------------------------------------------*/
49 
50 /* NOTE: HIRC was previously named CRYPTO */
51 #ifdef CRYPTO_FREQ
52 #warning WARNING: CRYPTO_FREQ does not exist in MAX32675, replace with HIRC_FREQ!
53 #define HIRC_FREQ CRYPTO_FREQ
54 #endif
55 
56 /* NOTE: EXTCLK needs to be defined by user based on the clock they supply */
57 #ifndef EXTCLK_FREQ
58 #define EXTCLK_FREQ 75000000
59 #endif
60 
61 /* NOTE: INRO was previously named NANORING */
62 #ifndef INRO_FREQ
63 #define INRO_FREQ 80000
64 #endif
65 //NOTE: IPO clock bit is documented as 96MHz, but SR says this will be 100.
66 #ifndef IPO_FREQ
67 #define IPO_FREQ 100000000
68 #endif
69 
70 #ifndef IBRO_FREQ
71 #define IBRO_FREQ 7372800
72 #endif
73 
74 #ifndef ERFO_FREQ
75 #define ERFO_FREQ 27120000
76 #endif
77 
78 #ifndef ERTCO_FREQ
79 #define ERTCO_FREQ 32768
80 #endif
81 
82 #ifndef HIRC_FREQ
83 #define HIRC_FREQ IPO_FREQ
84 #endif
85 
86 extern uint32_t SystemCoreClock;
87 #ifdef PeripheralClock
88 #warning PeripheralClock define is being overidden.
89 #else
90 #define PeripheralClock (SystemCoreClock /2)
91 #endif
92 
93 /*
94  * Initialize the system
95  *
96  * @brief Setup the microcontroller system.
97  * Initialize the System and update the SystemCoreClock variable.
98  */
99 void SystemInit(void);
100 
101 /*
102  * Update SystemCoreClock variable
103  *
104  * @brief Updates the SystemCoreClock with current core Clock
105  * retrieved from cpu registers.
106  */
107 void SystemCoreClockUpdate(void);
108 
109 #ifdef __cplusplus
110 }
111 #endif
112 
113 #endif /* _SYSTEM_MAX32675_H_ */