GLOBAL_ADC: Methods

GLOBAL ADC

GLOBAL_ADC
Methods
DAVE_APP_VERSION_t GLOBAL_ADC_GetAppVersion (void)
 Get GLOBAL_ADC APP version.
GLOBAL_ADC_STATUS_t GLOBAL_ADC_Init (GLOBAL_ADC_t *const handle_ptr)
 Initializes the ADC global as per user configured values.

Methods


Function Documentation

DAVE_APP_VERSION_t GLOBAL_ADC_GetAppVersion ( void  )

Get GLOBAL_ADC APP version.

Returns:
DAVE_APP_VERSION_t APP version information (major, minor and patch number)
Description:
The function can be used to check application software compatibility with a specific version of the APP.

Example Usage:

 #include <DAVE.h>

 int main(void) {
   DAVE_STATUS_t init_status;
   DAVE_APP_VERSION_t version;

   // Initialize GLOBAL_ADC APP:
   // GLOBAL_ADC_Init() is called from within DAVE_Init().
   init_status = DAVE_Init();

   version = GLOBAL_ADC_GetAppVersion();
   if (version.major != 1U) {
     // Probably, not the right version.
   }

   // More code here
   while(1) {

   }
   return (0);
 }

Inclusion of header file

Definition at line 96 of file GLOBAL_ADC.c.

Initializes the ADC global as per user configured values.

Returns:
void
Description:
Initializes the VADC peripheral. Invokes various VADC LLD drivers to initialize the VADC peripheral. This would invoke The XMC_VADC_GLOBAL_Init(), XMC_VADC_GROUP_Init(). It also invokes XMC_VADC_GROUP_SetPowerMode() to power on available groups.

Example Usage:

  #include <DAVE.h>
  int main (void)
  {
    DAVE_Init(); //GLOBAL_ADC_Init is called within DAVE_Init
    while(1);
    return 0;
  }

This function initializes all instances of the ADC Global APP and low level app.

Definition at line 110 of file GLOBAL_ADC.c.

References GLOBAL_ADC::enable_startup_calibration, GLOBAL_ADC_SUCCESS, GLOBAL_ADC_UNINITIALIZED, GLOBAL_ADC::global_config_handle, GLOBAL_ADC::global_shs_ptr, GLOBAL_ADC_GROUP::group_config_handle, GLOBAL_ADC_GROUP::group_handle, GLOBAL_ADC::group_ptrs_array, GLOBAL_ADC::init_state, GLOBAL_ADC::module_ptr, GLOBAL_ADC_GROUP::post_calibration, and GLOBAL_ADC_GROUP::state.