VADC_GROUP_CONFIG: VADC_GROUP_CONFIG.h Source File

VADC GROUP CONFIG

previous page next page
VADC_GROUP_CONFIG
VADC_GROUP_CONFIG.h
Go to the documentation of this file.
1 
52 /***********************************************************************************************************************
53  * HEADER FILES
54  **********************************************************************************************************************/
55 #ifndef VADC_GROUP_CONFIG_H
56 #define VADC_GROUP_CONFIG_H
57 
58 #include "VADC_GLOBAL_CONFIG/vadc_global_config.h"
59 #include "vadc_group_config_conf.h"
60 
61 /***********************************************************************************************************************
62  * MACROS
63  **********************************************************************************************************************/
64 #if (!((XMC_LIB_MAJOR_VERSION == 2U) && \
65  (XMC_LIB_MINOR_VERSION >= 1U) && \
66  (XMC_LIB_PATCH_VERSION >= 8U)))
67 #error "VADC_GROUP_CONFIG requires XMC Peripheral Library v2.1.8 or higher"
68 #endif
69 
70 /***********************************************************************************************************************
71  * ENUMS
72  **********************************************************************************************************************/
73 
80 typedef enum VADC_GROUP_CONFIG_STATUS
81 {
82  VADC_GROUP_CONFIG_STATUS_SUCCESS = 0U,
83  VADC_GROUP_CONFIG_STATUS_FAILURE
85 } VADC_GROUP_CONFIG_STATUS_t;
86 
91 /***********************************************************************************************************************
92  * DATA STRUCTURES
93  **********************************************************************************************************************/
94 
95 typedef VADC_GROUP_CONFIG_STATUS_t (*VADC_GROUP_CONFIG_func_ptr) (void);
96 
105 typedef struct VADC_GROUP_CONFIG_CHANNEL
106 {
107  const XMC_VADC_CHANNEL_CONFIG_t *ch_handle;
109  const uint8_t ch_num;
111 } VADC_GROUP_CONFIG_CHANNEL_t;
112 
116 typedef struct VADC_GROUP_CONFIG_RESULT_REGISTER
117 {
118  const XMC_VADC_RESULT_CONFIG_t *res_handle;
120  const uint8_t res_reg_num;
122 } VADC_GROUP_CONFIG_RESULT_REGISTER_t;
123 
127 typedef struct VADC_GROUP_CONFIG
128 {
129  VADC_GROUP_CONFIG_func_ptr init_func;
130 #if XMC_VADC_GROUP_AVAILABLE == 1U
131  XMC_VADC_GROUP_t *const group_ptr;
132 #endif
133 
134  XMC_VADC_GLOBAL_t *const module_ptr;
135 } VADC_GROUP_CONFIG_t;
136 
141 /***********************************************************************************************************************
142  * API Prototypes
143  **********************************************************************************************************************/
144 #ifdef __cplusplus
145 extern "C" {
146 #endif
147 
161 DAVE_APP_VERSION_t VADC_GROUP_CONFIG_GetAppVersion(void);
162 
201 VADC_GROUP_CONFIG_STATUS_t VADC_GROUP_CONFIG_Init(const VADC_GROUP_CONFIG_t *const handle);
202 
207 /* Include App extern declaration file */
208 #include "vadc_group_config_extern.h"
209 
210 #ifdef __cplusplus
211 }
212 #endif
213 
214 #endif /* VADC_GROUP_CONFIG_H */
previous page start next page