VADC_GLOBAL_CONFIG: VADC_GLOBAL_CONFIG.h Source File

VADC GLOBAL CONFIG

previous page next page
VADC_GLOBAL_CONFIG
VADC_GLOBAL_CONFIG.h
Go to the documentation of this file.
1 
52 /***********************************************************************************************************************
53  * HEADER FILES
54  **********************************************************************************************************************/
55 #ifndef VADC_GLOBAL_CONFIG_H
56 #define VADC_GLOBAL_CONFIG_H
57 
58 #include <xmc_vadc.h>
59 #include <DAVE_Common.h>
60 #include "vadc_global_config_conf.h"
61 
62 /***********************************************************************************************************************
63  * MACROS
64  **********************************************************************************************************************/
65 #if (!((XMC_LIB_MAJOR_VERSION == 2U) && \
66  (XMC_LIB_MINOR_VERSION >= 1U) && \
67  (XMC_LIB_PATCH_VERSION >= 2U)))
68 #error "VADC_GLOBAL_CONFIG requires XMC Peripheral Library v2.1.2 or higher"
69 #endif
70 
71 /***********************************************************************************************************************
72  * ENUMS
73  **********************************************************************************************************************/
74 
81 typedef enum VADC_GLOBAL_CONFIG_STATUS
82 {
83  VADC_GLOBAL_CONFIG_STATUS_SUCCESS = 0U,
84  VADC_GLOBAL_CONFIG_STATUS_FAILURE,
85  VADC_GLOBAL_CONFIG_STATUS_UNINITIALIZED
86 } VADC_GLOBAL_CONFIG_STATUS_t;
87 
92 /***********************************************************************************************************************
93  * DATA STRUCTURES
94  **********************************************************************************************************************/
95 
96 typedef VADC_GLOBAL_CONFIG_STATUS_t (*VADC_GLOBAL_CONFIG_func_ptr) (void);
97 
106 #if XMC_VADC_GROUP_AVAILABLE == 1U
107 typedef struct VADC_GLOBAL_CONFIG_GROUP
108 {
109  XMC_VADC_GROUP_t *const group_handle;
111  const XMC_VADC_GROUP_CONFIG_t* const group_config_handle;
113  const bool post_calibration;
115 } VADC_GLOBAL_CONFIG_GROUP_t;
116 #endif
117 
121 typedef struct VADC_GLOBAL_CONFIG
122 {
123  VADC_GLOBAL_CONFIG_func_ptr init_function;
125 #if XMC_VADC_GROUP_AVAILABLE == 1U
126  const VADC_GLOBAL_CONFIG_GROUP_t* const group_ptrs_array[XMC_VADC_MAXIMUM_NUM_GROUPS];
128 #endif
129 
130  VADC_GLOBAL_CONFIG_STATUS_t init_state;
132 } VADC_GLOBAL_CONFIG_t;
133 
138 /***********************************************************************************************************************
139  * API Prototypes
140  **********************************************************************************************************************/
141 #ifdef __cplusplus
142 extern "C" {
143 #endif
144 
190 DAVE_APP_VERSION_t VADC_GLOBAL_CONFIG_GetAppVersion(void);
191 
225 VADC_GLOBAL_CONFIG_STATUS_t VADC_GLOBAL_CONFIG_Init(const VADC_GLOBAL_CONFIG_t *const handle);
226 
231 /* Include APP extern declaration file */
232 #include "vadc_global_config_extern.h"
233 
234 #ifdef __cplusplus
235 }
236 #endif
237 
238 #endif /* VADC_GLOBAL_CONFIG_H */
previous page start next page