Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
DRV_ADC_SEQ_HANDLE_T Struct Reference

The handle of the ADC driver. More...

#include <netx_drv_adc.h>

Collaboration diagram for DRV_ADC_SEQ_HANDLE_T:
Collaboration graph

Public Member Functions

DRV_STATUS_E DRV_ADC_Seq_Init (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, DRV_ADC_HANDLE_T *const ptDriver)
 Initializes the adc sequencer and its handle by the given configuration. More...
 
DRV_STATUS_E DRV_ADC_Seq_DeInit (DRV_ADC_SEQ_HANDLE_T *const ptSequencer)
 Deinitializes the adc sequencer and its handle. More...
 
DRV_STATUS_E DRV_ADC_Seq_SetMode (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, DRV_ADC_SEQ_CONTINUOUS_MODE_E eMode)
 Set mode of the sequencer. More...
 
DRV_STATUS_E DRV_ADC_Seq_Start (DRV_ADC_SEQ_HANDLE_T *const ptSequencer)
 Starts the given adc sequencer. More...
 
DRV_STATUS_E DRV_ADC_Seq_Stop (DRV_ADC_SEQ_HANDLE_T *const ptSequencer)
 Stops the given adc sequencer. More...
 
DRV_STATUS_E DRV_ADC_Seq_Reset (DRV_ADC_SEQ_HANDLE_T *const ptSequencer)
 Reset the given adc sequencer. More...
 
DRV_STATUS_E DRV_ADC_Seq_Meas_ChangeConfig (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, DRV_ADC_SEQ_MEASUREMENT_E eMeasurement, DRV_ADC_SEQ_MEAS_INPUT_CHANNEL_E eInputChannel, DRV_ADC_SEQ_MEAS_OVERSAMPLING_E eOversampling, DRV_ADC_SEQ_MEAS_TRIGGER_E eTrigger)
 Changes the parameters of the given adc sequencer measurement. More...
 
DRV_STATUS_E DRV_ADC_Seq_GetState (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, DRV_ADC_STATE_T *const ptState)
 Aquires the state of the given adc sequencer. More...
 
DRV_STATUS_E DRV_ADC_Seq_GetSample (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, uint32_t *const pulSample, uint8_t *const pbMeasNr)
 Stores the current acquired sample of the the given adc. More...
 
DRV_STATUS_E DRV_ADC_Seq_GetLastSample (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, uint32_t *const pulSample, uint8_t *const pbMeasNr)
 Stores the last sample of the the given adc. More...
 
DRV_STATUS_E DRV_ADC_Seq_SetSampleSeriesBuffer (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, uint16_t *pulSampleSeries, size_t tSize, DRV_CALLBACK_F fnCallback, void *pUser)
 Stores a series of aquired sample of the given adc. More...
 

Data Fields

DRV_ADC_SEQ_CONFIGURATION_T tConfiguration
 

Private Member Functions

__STATIC_INLINE void DRV_ACD_IRQ_SaveResult (DRV_ADC_SEQ_HANDLE_T *const ptSequencer, DRV_ADC_SEQ_MEASUREMENT_E const eMeasurement)
 
__STATIC_INLINE void DRV_ACD_IRQ_Inline_Handler (DRV_ADC_SEQ_DEVICE_ID_E const eDeviceID)
 

Private Attributes

DRV_ADC_SEQ_DEVICE_TptDevice
 
DRV_ADC_HANDLE_TptParent
 
DRV_LOCK_T tLock
 
DRV_ADC_SEQ_BUFFER_T tBuffer
 

Detailed Description

The handle of the ADC driver.

The configuration SHALL be changed before initializing the device and shall not be changed afterwards. The rest of it SHALL not be modified outside of the driver, even if it appears to be possible.

Definition at line 519 of file netx_drv_adc.h.

Field Documentation

DRV_ADC_SEQ_DEVICE_T* DRV_ADC_SEQ_HANDLE_T::ptDevice
private

The ADC device register as bitfield and value unions.

Definition at line 521 of file netx_drv_adc.h.

DRV_ADC_HANDLE_T* DRV_ADC_SEQ_HANDLE_T::ptParent
private

Pointer to the adc device handle.

Definition at line 522 of file netx_drv_adc.h.

DRV_ADC_SEQ_BUFFER_T DRV_ADC_SEQ_HANDLE_T::tBuffer
private

Contains the pointer and position to record the next sample.

Definition at line 525 of file netx_drv_adc.h.

DRV_ADC_SEQ_CONFIGURATION_T DRV_ADC_SEQ_HANDLE_T::tConfiguration

Contains the configuration associated with the sequencer.

Definition at line 523 of file netx_drv_adc.h.

DRV_LOCK_T DRV_ADC_SEQ_HANDLE_T::tLock
private

The drivers locking variable used as internal mutex

Definition at line 524 of file netx_drv_adc.h.


The documentation for this struct was generated from the following files: