CLOCK_XMC4: CLOCK_XMC4.h Source File

CLOCK XMC4

CLOCK_XMC4.h
Go to the documentation of this file.
00001 
00059 #ifndef CLOCK_XMC4_H
00060 #define CLOCK_XMC4_H
00061 
00062 /***********************************************************************************************************************
00063  * HEADER FILES                                                                                                      
00064  **********************************************************************************************************************/
00065 #include <xmc_scu.h>
00066 #include <xmc_gpio.h>
00067 #include <DAVE_Common.h>
00068 #include "clock_xmc4_conf.h"
00069 
00070  /**********************************************************************************************************************
00071  * MACROS                                                                                                            
00072  **********************************************************************************************************************/
00073 #if (!((XMC_LIB_MAJOR_VERSION == 2U) && \
00074            (XMC_LIB_MINOR_VERSION >= 0U) && \
00075        (XMC_LIB_PATCH_VERSION >= 0U)))
00076 #error "CLOCK_XMC4 requires XMC Peripheral Library v2.0.0 or higher"
00077 #endif
00078 
00091  /**********************************************************************************************************************
00092  * ENUMS
00093  **********************************************************************************************************************/
00098 /*
00099  * @brief enumeration for CLOCK_XMC4 APP
00100  */
00101 typedef enum CLOCK_XMC4_STATUS
00102 {
00103   CLOCK_XMC4_STATUS_SUCCESS = 0U,        
00104   CLOCK_XMC4_STATUS_FAILURE = 1U         
00105 } CLOCK_XMC4_STATUS_t;
00106 
00111 /**********************************************************************************************************************
00112 * DATA STRUCTURES
00113 **********************************************************************************************************************/
00121 typedef struct CLOCK_XMC4
00122 {
00123   bool init_status;  
00124 } CLOCK_XMC4_t;
00129 #ifdef __cplusplus
00130 extern "C" {
00131 #endif
00132 /***********************************************************************************************************************
00133  * API Prototypes
00134  **********************************************************************************************************************/
00173 DAVE_APP_VERSION_t CLOCK_XMC4_GetAppVersion(void);
00174 
00209 CLOCK_XMC4_STATUS_t CLOCK_XMC4_Init(CLOCK_XMC4_t *handle);
00210 
00211 #ifdef CLOCK_XMC4_OSCHP_ENABLED
00212 
00224 uint32_t OSCHP_GetFrequency(void);
00225 #endif
00226 
00265 void CLOCK_XMC4_StepSystemPllFrequency(uint32_t kdiv);
00269 #ifdef __cplusplus
00270 }
00271 #endif   
00272 
00273 /* Include APP extern declaration file */
00274 #include"clock_xmc4_extern.h"
00275 
00276 #endif /* End of CLOCK_XMC4_H */