devices/MIMXRT1166/system_MIMXRT1166_cm4.h

0001 /*
0002 ** ###################################################################
0003 **     Processors:          MIMXRT1166CVM5A_cm4
0004 **                          MIMXRT1166DVM6A_cm4
0005 **                          MIMXRT1166XVM5A_cm4
0006 **
0007 **     Compilers:           Freescale C/C++ for Embedded ARM
0008 **                          GNU C Compiler
0009 **                          IAR ANSI C/C++ Compiler for ARM
0010 **                          Keil ARM C/C++ Compiler
0011 **                          MCUXpresso Compiler
0012 **
0013 **     Reference manual:    IMXRT1160RM, Rev 0, 03/2021
0014 **     Version:             rev. 0.1, 2020-12-29
0015 **     Build:               b210615
0016 **
0017 **     Abstract:
0018 **         Provides a system configuration function and a global variable that
0019 **         contains the system frequency. It configures the device and initializes
0020 **         the oscillator (PLL) that is part of the microcontroller device.
0021 **
0022 **     Copyright 2016 Freescale Semiconductor, Inc.
0023 **     Copyright 2016-2021 NXP
0024 **     All rights reserved.
0025 **
0026 **     SPDX-License-Identifier: BSD-3-Clause
0027 **
0028 **     http:                 www.nxp.com
0029 **     mail:                 support@nxp.com
0030 **
0031 **     Revisions:
0032 **     - rev. 0.1 (2020-12-29)
0033 **         Initial version.
0034 **
0035 ** ###################################################################
0036 */
0037
0038 /*!
0039  * @file MIMXRT1166_cm4
0040  * @version 1.0
0041  * @date 2021-06-15
0042  * @brief Device specific configuration file for MIMXRT1166_cm4 (header file)
0043  *
0044  * Provides a system configuration function and a global variable that contains
0045  * the system frequency. It configures the device and initializes the oscillator
0046  * (PLL) that is part of the microcontroller device.
0047  */
0048
0049 #ifndef _SYSTEM_MIMXRT1166_cm4_H_
0050 #define _SYSTEM_MIMXRT1166_cm4_H_                /**< Symbol preventing repeated inclusion */
0051
0052 #ifdef __cplusplus
0053 extern "C" {
0054 #endif
0055
0056 #include <stdint.h>
0057
0058
0059 #ifndef DISABLE_WDOG
0060   #define DISABLE_WDOG                 1
0061 #endif
0062
0063 /* Define clock source values */
0064
0065 #define CPU_XTAL_CLK_HZ                24000000UL          /* Value of the external crystal or oscillator clock frequency in Hz */
0066
0067 #define CPU_CLK1_HZ                    0UL                 /* Value of the CLK1 (select the CLK1_N/CLK1_P as source) frequency in Hz */
0068                                                            /* If CLOCK1_P,CLOCK1_N is choose as the pll bypass clock source, please implement the CLKPN_FREQ define, otherwise 0 will be returned. */
0069
0070 #define DEFAULT_SYSTEM_CLOCK           528000000UL         /* Default System clock value */
0071
0072
0073 /**
0074  * @brief System clock frequency (core clock)
0075  *
0076  * The system clock frequency supplied to the SysTick timer and the processor
0077  * core clock. This variable can be used by the user application to setup the
0078  * SysTick timer or configure other parameters. It may also be used by debugger to
0079  * query the frequency of the debug timer or configure the trace clock speed
0080  * SystemCoreClock is initialized with a correct predefined value.
0081  */
0082 extern uint32_t SystemCoreClock;
0083
0084 /**
0085  * @brief Setup the microcontroller system.
0086  *
0087  * Typically this function configures the oscillator (PLL) that is part of the
0088  * microcontroller device. For systems with variable clock speed it also updates
0089  * the variable SystemCoreClock. SystemInit is called from startup_device file.
0090  */
0091 void SystemInit (void);
0092
0093 /**
0094  * @brief Updates the SystemCoreClock variable.
0095  *
0096  * It must be called whenever the core clock is changed during program
0097  * execution. SystemCoreClockUpdate() evaluates the clock register settings and calculates
0098  * the current core clock.
0099  */
0100 void SystemCoreClockUpdate (void);
0101
0102 /**
0103  * @brief SystemInit function hook.
0104  *
0105  * This weak function allows to call specific initialization code during the
0106  * SystemInit() execution.This can be used when an application specific code needs
0107  * to be called as close to the reset entry as possible (for example the Multicore
0108  * Manager MCMGR_EarlyInit() function call).
0109  * NOTE: No global r/w variables can be used in this hook function because the
0110  * initialization of these variables happens after this function.
0111  */
0112 void SystemInitHook (void);
0113
0114 #ifdef __cplusplus
0115 }
0116 #endif
0117
0118 #endif  /* _SYSTEM_MIMXRT1166_cm4_H_ */