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

The configuration of the driver. More...

#include <netx_drv_adc.h>

Collaboration diagram for DRV_ADC_SEQ_CONFIGURATION_T:
Collaboration graph

Data Fields

DRV_ADC_SEQ_DEVICE_ID_E eDeviceID
 
DRV_OPERATION_MODE_E eOperationMode
 
DRV_ADC_SEQ_DMA_MODE_E eDmaModeDisable
 
DRV_ADC_SEQ_32Bit_MODE_E e32BitMode
 
DRV_ADC_SEQ_VREF_VDD3_E eVrefVdd3
 
DRV_ADC_SEQ_CLK_SYNC_E eClkSync
 
DRV_ADC_SEQ_CLK_PHASE_E eClkPhase
 
DRV_ADC_SEQ_CLK_PERIOD_E eClkPeriod
 
DRV_ADC_SEQ_CHANNEL_TRACKING_TIME_E eChannelTrackingTime [DRV_ADC_INPUTS_MAX]
 
DRV_ADC_SEQ_CONTINUOUS_MODE_E eContinuousMode
 
DRV_ADC_SEQ_BASE_ADDRESS_E eBaseAdr
 
DRV_ADC_SEQ_MEAS_T tMeasurement [DRV_ADC_MEASUREMENTS_MAX]
 
DRV_CALLBACK_F fnSequenceCompleteCallback
 
void * pSequenceCompleteCallbackHandle
 
DRV_CALLBACK_F fnMeasurementCompleteCallback [DRV_ADC_MEASUREMENTS_MAX]
 
void * pMeasurementCompleteCallbackHandle [DRV_ADC_MEASUREMENTS_MAX]
 

Detailed Description

The configuration of the driver.

This structure shall be modified to change configuration parameters. It is evaluated during the init routine and used during the handles lifetime. The structure shall not be modified after initialization of the device.

Definition at line 472 of file netx_drv_adc.h.

Field Documentation

DRV_ADC_SEQ_32Bit_MODE_E DRV_ADC_SEQ_CONFIGURATION_T::e32BitMode

Use 32Bit increment (fast, more space) or 16Bit increments (slower because of read modify write but less space).

Definition at line 477 of file netx_drv_adc.h.

DRV_ADC_SEQ_BASE_ADDRESS_E DRV_ADC_SEQ_CONFIGURATION_T::eBaseAdr

Base address for writing the measurement results.

Definition at line 485 of file netx_drv_adc.h.

DRV_ADC_SEQ_CHANNEL_TRACKING_TIME_E DRV_ADC_SEQ_CONFIGURATION_T::eChannelTrackingTime[DRV_ADC_INPUTS_MAX]

ADC sample extension for input channel. Length of 2nd adcclk in steps of 10ns system clock(~ delay of 3rd adcclk edge). The capacitor inside ADC needs time to be charged depending on the driving strength of the external signal. For 12 bit precision, this time should be 9*(Rint+Rext)*C, with Rint=1kOhm and C=7.5pF. The total formula for this value is: tt_add = ceil((6,75 x Rext/kOhm) + 6,75) - adcclk_period/10ns - 2 Set tt_add=4 if calculated value is smaller 4. The total ADC cycle time results in: tcycle = 14 * adcclk_period + clock_sync_delay (max 1 adcclk_period) + tt_add * 10ns.

Definition at line 482 of file netx_drv_adc.h.

DRV_ADC_SEQ_CLK_PERIOD_E DRV_ADC_SEQ_CONFIGURATION_T::eClkPeriod

Shall be set to default value. Duration of an adcclk period in system clock cycles-1 For odd values the high phase of adcclk is one system clock cycle longer than the low phase.

Definition at line 481 of file netx_drv_adc.h.

DRV_ADC_SEQ_CLK_PHASE_E DRV_ADC_SEQ_CONFIGURATION_T::eClkPhase

Shall be set to default value. Generation of the rising edge of the adcclk is delayed until the global clk_phase counter matches this value. NOTE: The rising edge of the adcclk ending the first sample period of a triggered measurement is NEVER delayed.

Definition at line 480 of file netx_drv_adc.h.

DRV_ADC_SEQ_CLK_SYNC_E DRV_ADC_SEQ_CONFIGURATION_T::eClkSync

Independent or synchronous clock.

Definition at line 479 of file netx_drv_adc.h.

DRV_ADC_SEQ_CONTINUOUS_MODE_E DRV_ADC_SEQ_CONFIGURATION_T::eContinuousMode

Defines if the sequencer captures continuously or once.

Definition at line 484 of file netx_drv_adc.h.

DRV_ADC_SEQ_DEVICE_ID_E DRV_ADC_SEQ_CONFIGURATION_T::eDeviceID

The device to be used

Definition at line 474 of file netx_drv_adc.h.

DRV_ADC_SEQ_DMA_MODE_E DRV_ADC_SEQ_CONFIGURATION_T::eDmaModeDisable

Enable/Disable DMA mode for coping of results.

Definition at line 476 of file netx_drv_adc.h.

DRV_OPERATION_MODE_E DRV_ADC_SEQ_CONFIGURATION_T::eOperationMode

Which programming method (DMA/IRQ/POLL) is used.

Definition at line 475 of file netx_drv_adc.h.

DRV_ADC_SEQ_VREF_VDD3_E DRV_ADC_SEQ_CONFIGURATION_T::eVrefVdd3

Reference Select of ADC

Definition at line 478 of file netx_drv_adc.h.

DRV_CALLBACK_F DRV_ADC_SEQ_CONFIGURATION_T::fnMeasurementCompleteCallback[DRV_ADC_MEASUREMENTS_MAX]

The callback used if a single measurement conversion complete

Definition at line 489 of file netx_drv_adc.h.

DRV_CALLBACK_F DRV_ADC_SEQ_CONFIGURATION_T::fnSequenceCompleteCallback

The callback used if a ADC sequence conversion complete

Definition at line 487 of file netx_drv_adc.h.

void* DRV_ADC_SEQ_CONFIGURATION_T::pMeasurementCompleteCallbackHandle[DRV_ADC_MEASUREMENTS_MAX]

The handle associated with the single measurement conversion complete callback.

Definition at line 490 of file netx_drv_adc.h.

void* DRV_ADC_SEQ_CONFIGURATION_T::pSequenceCompleteCallbackHandle

The handle associated with the ADC sequence conversion complete callback.

Definition at line 488 of file netx_drv_adc.h.

DRV_ADC_SEQ_MEAS_T DRV_ADC_SEQ_CONFIGURATION_T::tMeasurement[DRV_ADC_MEASUREMENTS_MAX]

Every Sequencer can includes up to DRV_ADC_MEASUREMENTS_MAX measurements.

Definition at line 486 of file netx_drv_adc.h.


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