GLOBAL_ADC: GLOBAL_ADC.h Source File

Modbus RTU XMC47

previous page next page
GLOBAL_ADC.h
Go to the documentation of this file.
1 
78 #ifndef GLOBAL_ADC_H
79 #define GLOBAL_ADC_H
80 
81 /***********************************************************************************************************************
82  * HEADER FILES
83  **********************************************************************************************************************/
84 #include <xmc_vadc.h>
85 #include "global_adc_conf.h"
86 #include <DAVE_Common.h>
87 
88  /**********************************************************************************************************************
89  * MACROS
90  **********************************************************************************************************************/
91 #if (!((XMC_LIB_MAJOR_VERSION == 2U) && \
92  (XMC_LIB_MINOR_VERSION >= 1U) && \
93  (XMC_LIB_PATCH_VERSION >= 14U)))
94 #error "GLOBAL_ADC requires XMC Peripheral Library v2.0.0 or higher"
95 #endif
96  /**********************************************************************************************************************
97  * ENUMS
98  **********************************************************************************************************************/
107 typedef enum GLOBAL_ADC_STATUS
108 {
109  GLOBAL_ADC_SUCCESS = 0,
110  GLOBAL_ADC_FAILURE,
111  GLOBAL_ADC_UNINITIALIZED
112 } GLOBAL_ADC_STATUS_t;
113 
117 /**********************************************************************************************************************
118 * DATA STRUCTURES
119 **********************************************************************************************************************/
127 #if XMC_VADC_GROUP_AVAILABLE == 1U
128 typedef struct GLOBAL_ADC_GROUP
129 {
130  XMC_VADC_GROUP_t *const group_handle;
132  const XMC_VADC_GROUP_CONFIG_t* const group_config_handle;
134  const bool post_calibration;
136  GLOBAL_ADC_STATUS_t state;
137 } GLOBAL_ADC_GROUP_t;
138 #endif
139 
142 typedef struct GLOBAL_ADC
143 {
144 #if XMC_VADC_GROUP_AVAILABLE == 1U
145  GLOBAL_ADC_GROUP_t* const group_ptrs_array[XMC_VADC_MAXIMUM_NUM_GROUPS];
146 #endif
147  const XMC_VADC_GLOBAL_CONFIG_t* const global_config_handle;
149  XMC_VADC_GLOBAL_t* const module_ptr;
151 #if(XMC_VADC_SHS_AVAILABLE == 1U)
152  XMC_VADC_GLOBAL_SHS_t* const global_shs_ptr;
153  XMC_VADC_GLOBAL_SHS_CONFIG_t* const global_shscfg;
154 #endif
155  GLOBAL_ADC_STATUS_t init_state;
157  const bool enable_startup_calibration;
158 } GLOBAL_ADC_t;
159 
169 #ifdef __cplusplus
170 extern "C" {
171 #endif
172 /***********************************************************************************************************************
173  * API Prototypes
174  **********************************************************************************************************************/
175 
210 DAVE_APP_VERSION_t GLOBAL_ADC_GetAppVersion(void);
211 
234 GLOBAL_ADC_STATUS_t GLOBAL_ADC_Init(GLOBAL_ADC_t *const handle_ptr);
235 
236 #include "global_adc_extern.h"
237 
242 #ifdef __cplusplus
243 }
244 #endif
245 
246 #endif /* GLOBAL_ADC_H_ */
previous page start next page