AGHAF  4.5.6
Annecy electronique Generic Hardware Access Framework
aghaf_adc.h
Go to the documentation of this file.
1 // Copyright (c) 2019 by ANNECY ELECTRONIQUE, Chavanod, France
2 
6 
7 #ifndef EXXOTEST_AGHAF_ADC_H
8 #define EXXOTEST_AGHAF_ADC_H
9 
10 #include <ghap/aghaf_adc_enums.h>
11 
12 #include "aghaf_global.h"
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
20 
22 typedef void *AGHAF_ADC;
23 
29 typedef void (*AGHAF_ADC_onConversion)(uint64_t timestamp, int32_t value,
31  void *userContext);
32 
33 AGHAF_PUBLIC_FUNCTION(void, AGHAF_ADC_setOnConversionCallback,
34  (AGHAF_ADC adc, AGHAF_ADC_onConversion callback,
35  void *userContext));
36 
37 AGHAF_PUBLIC_FUNCTION(AGHAF_ADC, AGHAF_ADC_get,
38  (AGHAF_Device device, uint8_t index));
39 AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_ADC_getIndex, (AGHAF_ADC adc));
40 AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_ADC_getCount, (AGHAF_Device device));
41 
42 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_activate, (AGHAF_ADC adc));
43 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_deactivate, (AGHAF_ADC adc));
44 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_isActivated,
45  (AGHAF_ADC adc, AGHAF_BOOL *isActivated));
46 
47 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_getParam,
48  (AGHAF_ADC adc, AGHAF_ADC_Param param, uint32_t *value));
49 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_setParam,
50  (AGHAF_ADC adc, AGHAF_ADC_Param param, uint32_t value));
51 
52 AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ADC_getLastConversion,
53  (AGHAF_ADC adc, int32_t *value,
54  AGHAF_ADC_TriggerState *triggerState));
55 
57 
58 #ifdef __cplusplus
59 }
60 #endif
61 
62 #endif
AGHAF_ADC_Param
List of parameters used to configure an ADC bus.
Definition: aghaf_adc_enums.h:45
AGHAF_Status AGHAF_ADC_getLastConversion(AGHAF_ADC adc, int32_t *value, AGHAF_ADC_TriggerState *triggerState)
Return the current state from the ADC trigger.
Definition: aghaf_adc.cpp:119
void AGHAF_ADC_setOnConversionCallback(AGHAF_ADC adc, AGHAF_ADC_onConversion callback, void *userContext)
Set the callback called on a ADC event.
Definition: aghaf_adc.cpp:14
AGHAF_Status AGHAF_ADC_deactivate(AGHAF_ADC adc)
stop the communication with the ADC
Definition: aghaf_adc.cpp:67
AGHAF_ADC_TriggerState
Trigger state.
Definition: aghaf_adc_enums.h:36
void * AGHAF_ADC
handle on a ADC
Definition: aghaf_adc.h:22
AGHAF_Status AGHAF_ADC_getParam(AGHAF_ADC adc, AGHAF_ADC_Param param, uint32_t *value)
get a parameter from a ADC
Definition: aghaf_adc.cpp:93
uint8_t AGHAF_ADC_getCount(AGHAF_Device device)
return the number of Adcs available on a device
Definition: aghaf_adc.cpp:47
uint8_t AGHAF_ADC_getIndex(AGHAF_ADC adc)
return the index from an ADC
Definition: aghaf_adc.cpp:37
void(* AGHAF_ADC_onConversion)(uint64_t timestamp, int32_t value, AGHAF_ADC_TriggerState state, void *userContext)
callback called on a ADC event
Definition: aghaf_adc.h:29
AGHAF_Status AGHAF_ADC_activate(AGHAF_ADC adc)
start the communication with the ADC
Definition: aghaf_adc.cpp:57
AGHAF_ADC AGHAF_ADC_get(AGHAF_Device device, uint8_t index)
return the KLine bus at the index specified
Definition: aghaf_adc.cpp:27
AGHAF_Status AGHAF_ADC_isActivated(AGHAF_ADC adc, AGHAF_BOOL *isActivated)
allow to know if the communication on the ADC is started or not
Definition: aghaf_adc.cpp:78
AGHAF_Status AGHAF_ADC_setParam(AGHAF_ADC adc, AGHAF_ADC_Param param, uint32_t value)
set a parameter from a ADC
Definition: aghaf_adc.cpp:106
AGHAF_Status
enumerator to define the error type in aghaf functions
Definition: aghaf_global.h:120
AGHAF_BOOL
enumerator to get a bool definition
Definition: aghaf_global.h:114
void * AGHAF_Device
handle on an exxotest device
Definition: aghaf_global.h:175