xref: /hal_ti-latest/simplelink_lpf3/source/ti/devices/cc23x0r5/driverlib/adc.h

/******************************************************************************
 *  Filename:       adc.h
 *
 *  Description:    Prototypes and defines for the ADC API.
 *
 *  Copyright (c) 2022 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *  3) Neither the name of the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/

#ifndef __ADC_H__
#define __ADC_H__

//*****************************************************************************
//
//! \addtogroup peripheral_group
//! @{
//! \addtogroup adc_api
//! @{
//
//*****************************************************************************

#include <stdint.h>
#include "../inc/hw_adc.h"
#include "../inc/hw_fcfg.h"
#include "../inc/hw_memmap.h"
#include "../inc/hw_sys0.h"
#include "../inc/hw_types.h"

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//
// Values
//
//*****************************************************************************

//! \brief Set ADC clock to system clock divided by 1
#define ADC_CLOCK_DIVIDER_1 ADC_CTL0_SCLKDIV_DIV_BY_1

//! \brief Set ADC clock to system clock divided by 2
#define ADC_CLOCK_DIVIDER_2 ADC_CTL0_SCLKDIV_DIV_BY_2

//! \brief Set ADC clock to system clock divided by 4
#define ADC_CLOCK_DIVIDER_4 ADC_CTL0_SCLKDIV_DIV_BY_4

//! \brief Set ADC clock to system clock divided by 8
#define ADC_CLOCK_DIVIDER_8 ADC_CTL0_SCLKDIV_DIV_BY_8

//! \brief Set ADC clock to system clock divided by 16
#define ADC_CLOCK_DIVIDER_16 ADC_CTL0_SCLKDIV_DIV_BY_16

//! \brief Set ADC clock to system clock divided by 24
#define ADC_CLOCK_DIVIDER_24 ADC_CTL0_SCLKDIV_DIV_BY_24

//! \brief Set ADC clock to system clock divided by 32
#define ADC_CLOCK_DIVIDER_32 ADC_CTL0_SCLKDIV_DIV_BY_32

//! \brief Set ADC clock to system clock divided by 48
#define ADC_CLOCK_DIVIDER_48 ADC_CTL0_SCLKDIV_DIV_BY_48

//! \brief Set resolution of ADC conversion to 12 bit (unsigned)
#define ADC_RESOLUTION_12_BIT ADC_CTL2_RES_BIT_12

//! \brief Set resolution of ADC conversion to 10 bit (unsigned)
#define ADC_RESOLUTION_10_BIT ADC_CTL2_RES_BIT_10

//! \brief Set resolution of ADC conversion to 8 bit (unsigned)
#define ADC_RESOLUTION_8_BIT ADC_CTL2_RES_BIT_8

//! \brief Set ADC reference to internal fixed 1.4V
#define ADC_FIXED_REFERENCE_1V4 0

//! \brief Set ADC reference to internal fixed 2.5V
#define ADC_FIXED_REFERENCE_2V5 1

//! \brief Set ADC reference to external analog pin A1
#define ADC_EXTERNAL_REFERENCE 2

//! \brief Set ADC reference to VDDS
#define ADC_VDDS_REFERENCE 3

//! \brief Set ADC conversion sequence to repeat control registers defined by start and stop address,
//! as set by \ref ADCSetMemctlRange
#define ADC_SEQUENCE_REPEATSEQUENCE ADC_CTL1_CONSEQ_REPEATSEQUENCE

//! \brief Set ADC conversion sequence to repeat control register defined by start as set by \ref ADCSetMemctlRange
#define ADC_SEQUENCE_REPEATSINGLE ADC_CTL1_CONSEQ_REPEATSINGLE

//! \brief Set ADC conversion sequence to a single pass of control registers defined by start and stop address,
//! as set by \ref ADCSetMemctlRange
#define ADC_SEQUENCE_SEQUENCE ADC_CTL1_CONSEQ_SEQUENCE

//! \brief Set ADC conversion sequence to do a single conversion of control register defined by start,
//! as set by \ref ADCSetMemctlRange
#define ADC_SEQUENCE_SINGLE ADC_CTL1_CONSEQ_SINGLE

//! \brief Result ready in memory result register 23
#define ADC_INT_MEMRES_23 ADC_IMASK0_MEMRESIFG23

//! \brief Result ready in memory result register 22
#define ADC_INT_MEMRES_22 ADC_IMASK0_MEMRESIFG22

//! \brief Result ready in memory result register 21
#define ADC_INT_MEMRES_21 ADC_IMASK0_MEMRESIFG21

//! \brief Result ready in memory result register 20
#define ADC_INT_MEMRES_20 ADC_IMASK0_MEMRESIFG20

//! \brief Result ready in memory result register 19
#define ADC_INT_MEMRES_19 ADC_IMASK0_MEMRESIFG19

//! \brief Result ready in memory result register 18
#define ADC_INT_MEMRES_18 ADC_IMASK0_MEMRESIFG18

//! \brief Result ready in memory result register 17
#define ADC_INT_MEMRES_17 ADC_IMASK0_MEMRESIFG17

//! \brief Result ready in memory result register 16
#define ADC_INT_MEMRES_16 ADC_IMASK0_MEMRESIFG16

//! \brief Result ready in memory result register 15
#define ADC_INT_MEMRES_15 ADC_IMASK0_MEMRESIFG15

//! \brief Result ready in memory result register 14
#define ADC_INT_MEMRES_14 ADC_IMASK0_MEMRESIFG14

//! \brief Result ready in memory result register 13
#define ADC_INT_MEMRES_13 ADC_IMASK0_MEMRESIFG13

//! \brief Result ready in memory result register 12
#define ADC_INT_MEMRES_12 ADC_IMASK0_MEMRESIFG12

//! \brief Result ready in memory result register 11
#define ADC_INT_MEMRES_11 ADC_IMASK0_MEMRESIFG11

//! \brief Result ready in memory result register 10
#define ADC_INT_MEMRES_10 ADC_IMASK0_MEMRESIFG10

//! \brief Result ready in memory result register 9
#define ADC_INT_MEMRES_09 ADC_IMASK0_MEMRESIFG9

//! \brief Result ready in memory result register 8
#define ADC_INT_MEMRES_08 ADC_IMASK0_MEMRESIFG8

//! \brief Result ready in memory result register 7
#define ADC_INT_MEMRES_07 ADC_IMASK0_MEMRESIFG7

//! \brief Result ready in memory result register 6
#define ADC_INT_MEMRES_06 ADC_IMASK0_MEMRESIFG6

//! \brief Result ready in memory result register 5
#define ADC_INT_MEMRES_05 ADC_IMASK0_MEMRESIFG5

//! \brief Result ready in memory result register 4
#define ADC_INT_MEMRES_04 ADC_IMASK0_MEMRESIFG4

//! \brief Result ready in memory result register 3
#define ADC_INT_MEMRES_03 ADC_IMASK0_MEMRESIFG3

//! \brief Result ready in memory result register 2
#define ADC_INT_MEMRES_02 ADC_IMASK0_MEMRESIFG2

//! \brief Result ready in memory result register 1
#define ADC_INT_MEMRES_01 ADC_IMASK0_MEMRESIFG1

//! \brief Result ready in memory result register 0
#define ADC_INT_MEMRES_00 ADC_IMASK0_MEMRESIFG0

//! \brief Ad-Hoc single conversion done
#define ADC_INT_ASCDONE ADC_IMASK0_ASCDONE

//! \brief Conversion underflow
#define ADC_INT_UVIFG ADC_IMASK0_UVIFG

//! \brief DMA transaction done
#define ADC_INT_DMADONE ADC_IMASK0_DMADONE

//! \brief ADC result is inside window comparator range
#define ADC_INT_INIFG ADC_IMASK0_INIFG

//! \brief ADC result is below window comparator range
#define ADC_INT_LOWIFG ADC_IMASK0_LOWIFG

//! \brief ADC result is above window comparator range
#define ADC_INT_HIGHIFG ADC_IMASK0_HIGHIFG

//! \brief Sequence conversion timeout overflow
#define ADC_INT_TOVIFG ADC_IMASK0_TOVIFG

//! \brief Conversion overflow
#define ADC_INT_OVIFG ADC_IMASK0_OVIFG

//*****************************************************************************
//
// API Functions and prototypes
//
//*****************************************************************************

//*****************************************************************************
//
//! \brief Sets the clock-divider value, and sample duration
//!
//! This function sets the clock divider, which determines the ADC clock,
//! derived from the system clock, and sets the duration of a sample in
//! ADC-clock cycles
//!
//! \param clkDiv is the clock divider value
//! - \ref ADC_CLOCK_DIVIDER_1
//! - \ref ADC_CLOCK_DIVIDER_2
//! - \ref ADC_CLOCK_DIVIDER_4
//! - \ref ADC_CLOCK_DIVIDER_8
//! - \ref ADC_CLOCK_DIVIDER_16
//! - \ref ADC_CLOCK_DIVIDER_24
//! - \ref ADC_CLOCK_DIVIDER_32
//! - \ref ADC_CLOCK_DIVIDER_48
//!
//! \param clkCycles is the duration of a sample, in ADC-clock cycles.
//! Valid range of input is [0, 1023]
//!
//! \note
//! The numerical value of clkDiv is not the actual divider value.
//! See the list of possible arguments and which divider value they represent.
//!
//! \note
//! The minimum sampling time for the ADC is 250 ns. The clock-divider and sample
//! duration must be set accordingly to maintain this requirement.
//!
//! \return None
//
//*****************************************************************************
extern void ADCSetSampleDuration(uint32_t clkDiv, uint16_t clkCycles);

//*****************************************************************************
//
//! \brief Sets the ADC bit resolution
//!
//! This function sets the resolution of the ADC conversion.
//!
//! \param resolution Bit resolution to be used in conversion
//! - \ref ADC_RESOLUTION_12_BIT
//! - \ref ADC_RESOLUTION_10_BIT
//! - \ref ADC_RESOLUTION_8_BIT
//!
//! \note
//! The resolution will affect how long a conversion will take.
//! - 12 bit: 14 clock cycles
//! - 10 bit: 12 clock cycles
//! - 8 bit: 9 clock cycles
//!
//! \return None
//
//*****************************************************************************
extern void ADCSetResolution(uint32_t resolution);

//*****************************************************************************
//
//! \brief Sets the ADC reference source and input channel
//!
//! This function sets the ADC reference and input channel. The control register
//! index that the settings are applied to must also be passed as a parameter
//!
//! \param reference Reference source used in conversion
//! - \ref ADC_FIXED_REFERENCE_1V4
//! - \ref ADC_FIXED_REFERENCE_2V5
//! - \ref ADC_VDDS_REFERENCE
//! - \ref ADC_EXTERNAL_REFERENCE
//!
//! \param channel Internal channels that can be muxed to ADC.
//! Channels 0-11 correspond to analog pins 0-11. See device data for more information.
//!
//! \param index Index of which control register to write to. See device data for valid indexes.
//!
//! \return None
//
//*****************************************************************************
extern void ADCSetInput(uint32_t reference, uint8_t channel, uint32_t index);

//*****************************************************************************
//
//! \brief Set start and stop control registers
//!
//! This function selects which control registers should be selected for
//! a conversion. Valid indexes are [0, 3]. For a single conversion, start and stop
//! should be set to the same.
//!
//! \param start the index of first control register used in sequence
//! \param stop the index of last control register used in sequence
//!
//! \return None
//
//*****************************************************************************
extern void ADCSetMemctlRange(uint32_t start, uint32_t stop);

//*****************************************************************************
//
//! \brief Set conversion sequence
//!
//! This function sets the sequence for ADC conversions. The actual sequence is
//! defined by \ref ADCSetMemctlRange. For a single conversion, start and stop
//! should be set to the same.
//!
//! \param sequence
//! - \ref ADC_SEQUENCE_REPEATSEQUENCE
//! - \ref ADC_SEQUENCE_REPEATSINGLE
//! - \ref ADC_SEQUENCE_SEQUENCE
//! - \ref ADC_SEQUENCE_SINGLE
//!
//! \return None
//
//*****************************************************************************
extern void ADCSetSequence(uint32_t sequence);

//*****************************************************************************
//
//! \brief Triggers an ADC conversion
//!
//! This function manually triggers an ADC conversion sequence, based on the
//! settings in the control registers in the start and stop range. See
//! \ref ADCSetMemctlRange and \ref ADCSetSequence
//!
//! \note It takes a minimum of 9 system-clock cycles for the BUSY-bit
//! in the STATUS register to go high after calling this function.
//!
//! \return None
//
//*****************************************************************************
extern void ADCManualTrigger(void);

//*****************************************************************************
//
//! \brief Read conversion result from ADC
//!
//! This function blocks until a conversion is done, and returns data
//! from the given memory register. The index corresponds to the selected
//! control register used for the conversion
//!
//! \param index Index of which memory result register to read from
//!
//! \return Raw ADC conversion result
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCReadResult(uint32_t index)
{

    while (HWREG(ADC_BASE + ADC_O_STA) & ADC_STA_BUSY_ACTIVE) {}

    /* Return data from result register */
    return HWREG(ADC_BASE + ADC_O_MEMRES0 + (4 * index));
}

//*****************************************************************************
//
//! \brief Check if ADC is busy
//!
//! This function returns whether the ADC is busy or not.
//!
//! \return ADC Busy status
//! true: ADC sampling or conversion is in progress.
//! false: No ADC sampling or conversion in progress.
//!
//! \note It takes a minimum of 9 system-clock cycles between writing to the
//! START-bit, and the BUSY-bit in the STATUS register going high
//
//*****************************************************************************
__STATIC_INLINE bool ADCIsBusy(void)
{

    if (HWREG(ADC_BASE + ADC_O_STA) & ADC_STA_BUSY_ACTIVE)
    {
        return true;
    }
    else
    {
        return false;
    }
}

//*****************************************************************************
//
//! \brief Read conversion result from ADC
//!
//! This function returns data from the given memory register without blocking.
//! The index corresponds to the selected control register used for the conversion
//!
//! \param index Index of which memory result register to read from
//!
//! \return Raw ADC conversion result
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCReadResultNonBlocking(uint32_t index)
{
    /* Return data from result register */
    return HWREG(ADC_BASE + ADC_O_MEMRES0 + (4 * index));
}

//*****************************************************************************
//
//! \brief Convert ADC code to microvolts
//!
//! This function converts an adjusted ADC code to microvolts. Function arguments
//! also include bit resolution and reference voltage
//!
//! \param adcCode Raw adjusted adc code
//! \param bitResolution Bit resolution used in conversion
//! \param referenceVoltageMicroVolt Reference voltage (microvolts)
//!
//! \return ADC result in microvolts
//
//*****************************************************************************
extern uint32_t ADCValueToMicrovolts(uint32_t adcCode, uint32_t bitResolution, uint32_t referenceVoltageMicroVolt);

//*****************************************************************************
//
//! \brief Enables individual ADC interrupt sources.
//!
//! This function enables the indicated ADC interrupt sources.
//!
//! \param intFlags is the bit mask of the interrupt sources to be enabled.
//! The parameter is the bitwise OR of any of the following:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//! - \ref ADC_INT_ASCDONE
//! - \ref ADC_INT_UVIFG
//! - \ref ADC_INT_DMADONE
//! - \ref ADC_INT_INIFG
//! - \ref ADC_INT_LOWIFG
//! - \ref ADC_INT_HIGHIFG
//! - \ref ADC_INT_TOVIFG
//! - \ref ADC_INT_OVIFG
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCEnableInterrupt(uint32_t intFlags)
{
    // Enable the specified interrupts.
    HWREG(ADC_BASE + ADC_O_IMASK0) |= intFlags;
}

//*****************************************************************************
//
//! \brief Disables individual ADC interrupt sources.
//!
//! This function disables the indicated ADC interrupt sources.
//!
//! \param intFlags is the bit mask of the interrupt sources to be disabled.
//! The parameter is the bitwise OR of any of the following:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//! - \ref ADC_INT_ASCDONE
//! - \ref ADC_INT_UVIFG
//! - \ref ADC_INT_DMADONE
//! - \ref ADC_INT_INIFG
//! - \ref ADC_INT_LOWIFG
//! - \ref ADC_INT_HIGHIFG
//! - \ref ADC_INT_TOVIFG
//! - \ref ADC_INT_OVIFG
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCDisableInterrupt(uint32_t intFlags)
{
    // Disable the specified interrupts.
    HWREG(ADC_BASE + ADC_O_IMASK0) &= ~(intFlags);
}

//*****************************************************************************
//
//! \brief Gets the current raw interrupt status.
//!
//! This function returns the raw interrupt status for the ADC
//!
//! \return Returns the current interrupt status, enumerated as a bit field of:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//! - \ref ADC_INT_ASCDONE
//! - \ref ADC_INT_UVIFG
//! - \ref ADC_INT_DMADONE
//! - \ref ADC_INT_INIFG
//! - \ref ADC_INT_LOWIFG
//! - \ref ADC_INT_HIGHIFG
//! - \ref ADC_INT_TOVIFG
//! - \ref ADC_INT_OVIFG
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCRawInterruptStatus(void)
{
    return (HWREG(ADC_BASE + ADC_O_RIS0));
}

//*****************************************************************************
//
//! \brief Gets the current masked interrupt status.
//!
//! This function returns the masked interrupt status for the ADC
//!
//! \return Returns the current interrupt status, enumerated as a bit field of:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//! - \ref ADC_INT_ASCDONE
//! - \ref ADC_INT_UVIFG
//! - \ref ADC_INT_DMADONE
//! - \ref ADC_INT_INIFG
//! - \ref ADC_INT_LOWIFG
//! - \ref ADC_INT_HIGHIFG
//! - \ref ADC_INT_TOVIFG
//! - \ref ADC_INT_OVIFG
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCMaskedInterruptStatus(void)
{
    return (HWREG(ADC_BASE + ADC_O_MIS0));
}

//*****************************************************************************
//
//! \brief Clears ADC interrupt sources.
//!
//! The specified ADC interrupt sources are cleared, so that they no longer
//! assert. This function must be called in the interrupt handler to keep the
//! interrupt from being recognized again immediately upon exit.
//!
//! \note Due to write buffers and synchronizers in the system it may take several
//! clock cycles from a register write clearing an event in a module and until the
//! event is actually cleared in the NVIC of the system CPU. It is recommended to
//! clear the event source early in the interrupt service routine (ISR) to allow
//! the event clear to propagate to the NVIC before returning from the ISR.
//! At the same time, an early event clear allows new events of the same type to be
//! pended instead of ignored if the event is cleared later in the ISR.
//! It is the responsibility of the programmer to make sure that enough time has passed
//! before returning from the ISR to avoid false re-triggering of the cleared event.
//! A simple, although not necessarily optimal, way of clearing an event before
//! returning from the ISR is:
//! -# Write to clear event (interrupt source). (buffered write)
//! -# Dummy read from the event source module. (making sure the write has propagated)
//! -# Wait two system CPU clock cycles (user code or two NOPs). (allowing cleared event to propagate through any
//! synchronizers)
//!
//! \param intFlags is a bit mask of the interrupt sources to be cleared.
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//! - \ref ADC_INT_ASCDONE
//! - \ref ADC_INT_UVIFG
//! - \ref ADC_INT_DMADONE
//! - \ref ADC_INT_INIFG
//! - \ref ADC_INT_LOWIFG
//! - \ref ADC_INT_HIGHIFG
//! - \ref ADC_INT_TOVIFG
//! - \ref ADC_INT_OVIFG
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCClearInterrupt(uint32_t intFlags)
{
    // Clear the requested interrupt sources
    HWREG(ADC_BASE + ADC_O_ICLR0) = intFlags;
}

//*****************************************************************************
//
//! \brief Enable DMA trigger for data transfer.
//!
//! This function enables DMA trigger for data transfer. DMAEN bit is cleared by hardware
//! based on DMA done signal at the end of data transfer. Software has to re-enable DMAEN
//! bit for ADC to generate DMA triggers.
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCEnableDMATrigger(void)
{
    HWREG(ADC_BASE + ADC_O_CTL2) |= ADC_CTL2_DMAEN;
}

//*****************************************************************************
//
//! \brief Enables individual ADC interrupt sources for DMA Trigger Event Publisher (INT_EVENT2).
//!
//! This function enables the indicated ADC interrupt sources (INT_EVENT2).
//!
//! \param intFlags is the bit mask of the interrupt sources to be enabled.
//! The parameter is the bitwise OR of any of the following:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCEnableDMAInterrupt(uint32_t intFlags)
{
    // Enable the specified interrupts.
    HWREG(ADC_BASE + ADC_O_IMASK2) |= intFlags;
}

//*****************************************************************************
//
//! \brief Disables individual ADC interrupt sources for DMA Trigger Event Publisher (INT_EVENT2).
//!
//! This function disables the indicated ADC interrupt sources (INT_EVENT2).
//!
//! \param intFlags is the bit mask of the interrupt sources to be disabled.
//! The parameter is the bitwise OR of any of the following:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCDisableDMAInterrupt(uint32_t intFlags)
{
    // Disable the specified interrupts.
    HWREG(ADC_BASE + ADC_O_IMASK2) &= ~(intFlags);
}

//*****************************************************************************
//
//! \brief Gets the current raw interrupt status for DMA Trigger Event Publisher (INT_EVENT2).
//!
//! This function returns the raw interrupt status for the ADC (INT_EVENT2).
//!
//! \return Returns the current interrupt status, enumerated as a bit field of:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCRawDMAInterruptStatus(void)
{
    return (HWREG(ADC_BASE + ADC_O_RIS2));
}

//*****************************************************************************
//
//! \brief Gets the current masked interrupt status for DMA Trigger Event Publisher (INT_EVENT2).
//!
//! This function returns the masked interrupt status for the ADC (INT_EVENT2).
//!
//! \return Returns the current interrupt status, enumerated as a bit field of:
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//
//*****************************************************************************
__STATIC_INLINE uint32_t ADCMaskedDMAInterruptStatus(void)
{
    return (HWREG(ADC_BASE + ADC_O_MIS2));
}

//*****************************************************************************
//
//! \brief Clears ADC interrupt sources for DMA Trigger Event Publisher (INT_EVENT2).
//!
//! The specified ADC interrupt sources are cleared, so that they no longer
//! assert. This function must be called in the interrupt handler to keep the
//! interrupt from being recognized again immediately upon exit.
//!
//! \note Due to write buffers and synchronizers in the system it may take several
//! clock cycles from a register write clearing an event in a module and until the
//! event is actually cleared in the NVIC of the system CPU. It is recommended to
//! clear the event source early in the interrupt service routine (ISR) to allow
//! the event clear to propagate to the NVIC before returning from the ISR.
//! At the same time, an early event clear allows new events of the same type to be
//! pended instead of ignored if the event is cleared later in the ISR.
//! It is the responsibility of the programmer to make sure that enough time has passed
//! before returning from the ISR to avoid false re-triggering of the cleared event.
//! A simple, although not necessarily optimal, way of clearing an event before
//! returning from the ISR is:
//! -# Write to clear event (interrupt source). (buffered write)
//! -# Dummy read from the event source module. (making sure the write has propagated)
//! -# Wait two system CPU clock cycles (user code or two NOPs). (allowing cleared event to propagate through any
//! synchronizers)
//!
//! \param intFlags is a bit mask of the interrupt sources to be cleared.
//! - ADC_INT_MEMRES_N (\ref ADC_INT_MEMRES_00, \ref ADC_INT_MEMRES_01, etc)
//!
//! \return None
//
//*****************************************************************************
__STATIC_INLINE void ADCClearDMAInterrupt(uint32_t intFlags)
{
    // Clear the requested interrupt sources
    HWREG(ADC_BASE + ADC_O_ICLR2) = intFlags;
}

//*****************************************************************************
//
//! \brief Returns ADC gain value for given reference
//!
//! This returns a gain value that should be passed to \ref ADCAdjustValueForGain.
//! The gain is dependant on the reference source
//!
//! \param reference reference source used in conversion
//! - \ref ADC_FIXED_REFERENCE_1V4
//! - \ref ADC_FIXED_REFERENCE_2V5
//! - \ref ADC_VDDS_REFERENCE
//! - \ref ADC_EXTERNAL_REFERENCE
//!
//! \return Gain value
//
//*****************************************************************************
extern uint16_t ADCGetAdjustmentGain(uint32_t reference);

//*****************************************************************************
//
//! \brief Write correct offset value to ADC-peripheral trim register
//!
//! The ADC peripheral relies on an offset trim value in \ref SYS0_O_TMUTE2. This value
//! needs to be set depending on which reference source is used in the conversion
//!
//! \param reference reference source used in conversion
//! - \ref ADC_FIXED_REFERENCE_1V4
//! - \ref ADC_FIXED_REFERENCE_2V5
//! - \ref ADC_VDDS_REFERENCE
//! - \ref ADC_EXTERNAL_REFERENCE
//
//*****************************************************************************
extern void ADCSetAdjustmentOffset(uint32_t reference);

//*****************************************************************************
//
//! \brief Performs ADC value gain adjustment.
//!
//! This function takes a measured ADC value and compensates for the internal gain
//! in the ADC.
//!
//! \param adcValue
//!     ADC unadjusted value
//! \param bitResolution
//!     ADC bit resolution
//! \param gain
//!     Gain adjustment value provided by \ref ADCGetAdjustmentGain()
//!
//! \return
//!     ADC adjusted value
//
//*****************************************************************************
extern uint32_t ADCAdjustValueForGain(uint32_t adcValue, uint32_t bitResolution, uint16_t gain);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
//! Close the Doxygen group.
//! @}
//! @}
//
//*****************************************************************************

#endif //  __ADC_H__