IfxVadc_Adc.h File Reference
VADC ADC details. More...
Go to the source code of this file.
Data Structures | |
| struct | IfxVadc_Adc |
| VADC handle data structure. More... | |
| struct | IfxVadc_Adc_GatingTriggerConfig |
| Gating/Trigger configuration structure. More... | |
| struct | IfxVadc_Adc_ArbiterConfig |
| Arbiter configuration structure. More... | |
| struct | IfxVadc_Adc_BackgroundScanConfig |
| Background scan mode configuration structure. More... | |
| struct | IfxVadc_Adc_ClassConfig |
| Input class configuration structure. More... | |
| struct | IfxVadc_Adc_Group |
| Group handle data structure. More... | |
| struct | IfxVadc_Adc_QueueConfig |
| Queue configuration structure. More... | |
| struct | IfxVadc_Adc_ScanConfig |
| Scan mode configuration structure. More... | |
| struct | IfxVadc_Adc_EmuxPinConfig |
| struct | IfxVadc_Adc_Channel |
| Channel handle data structure. More... | |
| struct | IfxVadc_Adc_ChannelConfig |
| Channel configuration structure. More... | |
| struct | IfxVadc_Adc_Config |
| VADC module configuration structure. More... | |
| struct | IfxVadc_Adc_EmuxControl |
| Emux Control Structure. More... | |
| struct | IfxVadc_Adc_GroupConfig |
| Group configuration structure. More... | |
Typedefs | |
| typedef uint8 | IfxVadc_Adc_SYNCTR_STSEL |
Functions | |
| IFX_INLINE void | IfxVadc_Adc_deInitModule (IfxVadc_Adc *vadc) |
| Reset the VADC module. More... | |
| IFX_INLINE void | IfxVadc_Adc_getModuleConfig (IfxVadc_Adc *vadc, IfxVadc_Adc_Config *config) |
| Get the current VADC configuration (e.g. VADC frequency) More... | |
| IFX_INLINE Ifx_VADC_RES | IfxVadc_Adc_getResultBasedOnRequestSource (IfxVadc_Adc_Group *group, IfxVadc_ChannelId channel, IfxVadc_RequestSource sourceType) |
| Get conversion result based on the Request Source. (Function does not care about the alignment) value = raw * gain + offset. More... | |
| IFX_EXTERN void | IfxVadc_Adc_disableModule (Ifx_VADC *vadc) |
| Disable VADC Module. More... | |
| IFX_EXTERN IfxVadc_Status | IfxVadc_Adc_initModule (IfxVadc_Adc *vadc, const IfxVadc_Adc_Config *config) |
| Initialise the VADC to run with the expected frequency and calibration. More... | |
| IFX_EXTERN void | IfxVadc_Adc_initModuleConfig (IfxVadc_Adc_Config *config, Ifx_VADC *vadc) |
| Initialise buffer with default VADC configuration. More... | |
| IFX_INLINE Ifx_VADC_G * | IfxVadc_Adc_getGroupRegsFromGroup (const IfxVadc_Adc_Group *group) |
| Gets the current group register set. More... | |
| IFX_INLINE void | IfxVadc_Adc_getGroupResult (IfxVadc_Adc_Group *group, Ifx_VADC_RES *results, uint32 resultOffset, uint32 numResults) |
| Get conversion result for the group. More... | |
| IFX_INLINE Ifx_VADC * | IfxVadc_Adc_getVadcFromGroup (const IfxVadc_Adc_Group *group) |
| Gets the current group module register address. More... | |
| IFX_EXTERN void | IfxVadc_Adc_deInitGroup (IfxVadc_Adc_Group *group) |
| Reset the VADC group. More... | |
| IFX_EXTERN void | IfxVadc_Adc_getGroupConfig (IfxVadc_Adc_Group *group, IfxVadc_Adc_GroupConfig *config) |
| Get the current group configuration (e.g. vadc frequency) More... | |
| IFX_EXTERN IfxVadc_Status | IfxVadc_Adc_initGroup (IfxVadc_Adc_Group *group, const IfxVadc_Adc_GroupConfig *config) |
| Initialise the VADC group (also autoscan and queue modes) Slave Groups must initialize first. More... | |
| IFX_EXTERN void | IfxVadc_Adc_initGroupConfig (IfxVadc_Adc_GroupConfig *config, IfxVadc_Adc *vadc) |
| Initialise buffer with default VADC configuration. More... | |
| IFX_INLINE void | IfxVadc_Adc_configureWaitForReadMode (IfxVadc_Adc_Channel *channel, boolean waitForRead) |
| pointer to the VADC channel More... | |
| IFX_INLINE Ifx_VADC_RES | IfxVadc_Adc_getResult (IfxVadc_Adc_Channel *channel) |
| Get conversion result (Function does not care about the alignment) More... | |
| IFX_EXTERN void | IfxVadc_Adc_getChannelConfig (IfxVadc_Adc_Channel *channel, IfxVadc_Adc_ChannelConfig *config) |
| Get the current channel configuration (e.g. sample settings) More... | |
| IFX_EXTERN float32 | IfxVadc_Adc_getChannelConversionTime (IfxVadc_Adc_Channel *channel, IfxVadc_ConversionType conversionMode) |
| get the channel Conversion Time More... | |
| IFX_EXTERN IfxVadc_Status | IfxVadc_Adc_initChannel (IfxVadc_Adc_Channel *channel, const IfxVadc_Adc_ChannelConfig *config) |
| Initialise one channel with given configuration. More... | |
| IFX_EXTERN void | IfxVadc_Adc_initChannelConfig (IfxVadc_Adc_ChannelConfig *config, const IfxVadc_Adc_Group *group) |
| Initialise buffer with default channel configuration. More... | |
| IFX_INLINE void | IfxVadc_Adc_configureWaitForReadModeForGlobalResultRegister (IfxVadc_Adc *vadc, boolean waitForRead) |
| access function to enable/disable wait for read mode for global result register More... | |
| IFX_INLINE IfxVadc_Status | IfxVadc_Adc_getBackgroundScanStatus (IfxVadc_Adc *vadc) |
| Gives the background scan status for a group. More... | |
| IFX_INLINE Ifx_VADC_GLOBRES | IfxVadc_Adc_getGlobalResult (IfxVadc_Adc *vadc) |
| returns result stored in global result register More... | |
| IFX_INLINE void | IfxVadc_Adc_setBackgroundScan (IfxVadc_Adc *vadc, IfxVadc_Adc_Group *group, uint32 channels, uint32 mask) |
| configures a background scan More... | |
| IFX_INLINE void | IfxVadc_Adc_startBackgroundScan (IfxVadc_Adc *vadc) |
| Starts a background scan. More... | |
| IFX_INLINE IfxVadc_Status | IfxVadc_Adc_getScanStatus (IfxVadc_Adc_Group *group) |
| Gives the scan status for a group. More... | |
| IFX_INLINE void | IfxVadc_Adc_setScan (IfxVadc_Adc_Group *group, uint32 channels, uint32 mask) |
| Configures an autoscan. More... | |
| IFX_INLINE void | IfxVadc_Adc_startScan (IfxVadc_Adc_Group *group) |
| Starts an autoscan on the specified group. More... | |
| IFX_INLINE void | IfxVadc_Adc_addToQueue (IfxVadc_Adc_Channel *channel, uint32 options) |
| Add an entry to the queue of a group for the specified channel with the following options set: refill source interrupt enable/disable external trigger control. More... | |
| IFX_INLINE void | IfxVadc_Adc_clearQueue (IfxVadc_Adc_Group *group) |
| Flush the contents of the queue of a group. More... | |
| IFX_INLINE IfxVadc_Status | IfxVadc_Adc_getQueueStatus (IfxVadc_Adc_Group *group) |
| Gives the status of the Queue of a group by returning non zero value if the Queue is full. More... | |
| IFX_INLINE void | IfxVadc_Adc_startQueue (IfxVadc_Adc_Group *group) |
| Starts a queue of a group by generating a trigger event through software. More... | |
| IFX_EXTERN void | IfxVadc_Adc_initExternalMultiplexerModeConfig (IfxVadc_Adc_EmuxControl *emuxConfig, Ifx_VADC *vadc) |
| initialise default configuration for external multiplexer More... | |
| IFX_EXTERN void | IfxVadc_Adc_initExternalMultiplexerMode (Ifx_VADC *vadc, const IfxVadc_Adc_EmuxControl *emuxControl) |
| initalise external multiplexer. More... | |
Detailed Description
VADC ADC details.
- Version
- iLLD_1_0_0_11_0
- Copyright
- Copyright (c) 2013 Infineon Technologies AG. All rights reserved.
IMPORTANT NOTICE
Infineon Technologies AG (Infineon) is supplying this file for use exclusively with Infineon's microcontroller products. This file can be freely distributed within development tools that are supporting such microcontroller products.
THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
Definition in file IfxVadc_Adc.h.
Data Structure Documentation
| struct IfxVadc_Adc_EmuxPinConfig |
Definition at line 438 of file IfxVadc_Adc.h.
Collaboration diagram for IfxVadc_Adc_EmuxPinConfig:
| Data Fields | ||
|---|---|---|
| IfxPort_OutputMode | outputMode | the pin output mode which should be configured |
| IfxPort_PadDriver | padDriver | Pad driver. |
| IfxVadc_Emux_Out * | pins[3] | Emux Pins configuration. |
Typedef Documentation
| typedef uint8 IfxVadc_Adc_SYNCTR_STSEL |
Definition at line 350 of file IfxVadc_Adc.h.
