fsl_adc.h

/*
 * Copyright (c) 2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2020 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _FSL_ADC_H_
#define _FSL_ADC_H_
 
#include "fsl_common.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
#define FSL_ADC_DRIVER_VERSION (MAKE_VERSION(2, 0, 4)) 
typedef enum _adc_status_flags
{
    kADC_ConversionActiveFlag  = ADC_GS_ADACT_MASK, 
    kADC_CalibrationFailedFlag = ADC_GS_CALF_MASK,  
    kADC_AsynchronousWakeupInterruptFlag =
        ADC_GS_AWKST_MASK, 
} adc_status_flags_t;
 
typedef enum _adc_reference_voltage_source
{
    kADC_ReferenceVoltageSourceAlt0 = 0U, 
} adc_reference_voltage_source_t;
 
typedef enum _adc_sample_period_mode
{
    /* This group of enumeration is for internal use which is related to register setting. */
    kADC_SamplePeriod2or12Clocks = 0U, 
    kADC_SamplePeriod4or16Clocks = 1U, 
    kADC_SamplePeriod6or20Clocks = 2U, 
    kADC_SamplePeriod8or24Clocks = 3U, 
    /* This group of enumeration is for a public user. */
    /* For long sample mode. */
    kADC_SamplePeriodLong12Clcoks = kADC_SamplePeriod2or12Clocks, 
    kADC_SamplePeriodLong16Clcoks = kADC_SamplePeriod4or16Clocks, 
    kADC_SamplePeriodLong20Clcoks = kADC_SamplePeriod6or20Clocks, 
    kADC_SamplePeriodLong24Clcoks = kADC_SamplePeriod8or24Clocks, 
    /* For short sample mode. */
    kADC_SamplePeriodShort2Clocks = kADC_SamplePeriod2or12Clocks, 
    kADC_SamplePeriodShort4Clocks = kADC_SamplePeriod4or16Clocks, 
    kADC_SamplePeriodShort6Clocks = kADC_SamplePeriod6or20Clocks, 
    kADC_SamplePeriodShort8Clocks = kADC_SamplePeriod8or24Clocks, 
} adc_sample_period_mode_t;
 
typedef enum _adc_clock_source
{
    kADC_ClockSourceIPG     = 0U, 
    kADC_ClockSourceIPGDiv2 = 1U, 
#if !(defined(FSL_FEATURE_ADC_SUPPORT_ALTCLK_REMOVE) && FSL_FEATURE_ADC_SUPPORT_ALTCLK_REMOVE)
    kADC_ClockSourceALT = 2U, 
#endif
    kADC_ClockSourceAD = 3U, 
} adc_clock_source_t;
 
typedef enum _adc_clock_drvier
{
    kADC_ClockDriver1 = 0U, 
    kADC_ClockDriver2 = 1U, 
    kADC_ClockDriver4 = 2U, 
    kADC_ClockDriver8 = 3U, 
} adc_clock_driver_t;
 
typedef enum _adc_resolution
{
    kADC_Resolution8Bit  = 0U, 
    kADC_Resolution10Bit = 1U, 
    kADC_Resolution12Bit = 2U, 
} adc_resolution_t;
 
typedef enum _adc_hardware_compare_mode
{
    kADC_HardwareCompareMode0 = 0U, 
    kADC_HardwareCompareMode1 = 1U, 
    kADC_HardwareCompareMode2 = 2U, 
    kADC_HardwareCompareMode3 = 3U, 
} adc_hardware_compare_mode_t;
 
typedef enum _adc_hardware_average_mode
{
    kADC_HardwareAverageCount4   = 0U, 
    kADC_HardwareAverageCount8   = 1U, 
    kADC_HardwareAverageCount16  = 2U, 
    kADC_HardwareAverageCount32  = 3U, 
    kADC_HardwareAverageDiasable = 4U, 
} adc_hardware_average_mode_t;
 
typedef struct _adc_config
{
    bool enableOverWrite;                                  
    bool enableContinuousConversion;                       
    bool enableHighSpeed;                                  
    bool enableLowPower;                                   
    bool enableLongSample;                                 
    bool enableAsynchronousClockOutput;                    
    adc_reference_voltage_source_t referenceVoltageSource; 
    adc_sample_period_mode_t samplePeriodMode; 
    adc_clock_source_t clockSource; 
    adc_clock_driver_t clockDriver; 
    adc_resolution_t resolution;    
} adc_config_t;
 
typedef struct _adc_offest_config
{
    bool enableSigned;    
    uint32_t offsetValue; 
} adc_offest_config_t;
 
typedef struct _adc_hardware_compare_config
{
    adc_hardware_compare_mode_t hardwareCompareMode; 
    uint16_t value1;                                 
    uint16_t value2;                                 
} adc_hardware_compare_config_t;
 
typedef struct _adc_channel_config
{
    uint32_t channelNumber;                    
    bool enableInterruptOnConversionCompleted; 
} adc_channel_config_t;
/*******************************************************************************
 * API
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
 
void ADC_Init(ADC_Type *base, const adc_config_t *config);
 
void ADC_Deinit(ADC_Type *base);
 
void ADC_GetDefaultConfig(adc_config_t *config);
 
void ADC_SetChannelConfig(ADC_Type *base, uint32_t channelGroup, const adc_channel_config_t *config);
 
static inline uint32_t ADC_GetChannelConversionValue(ADC_Type *base, uint32_t channelGroup)
{
    assert(channelGroup < (uint32_t)FSL_FEATURE_ADC_CONVERSION_CONTROL_COUNT);
 
    return base->R[channelGroup];
}
 
static inline uint32_t ADC_GetChannelStatusFlags(ADC_Type *base, uint32_t channelGroup)
{
    assert(channelGroup < (uint32_t)FSL_FEATURE_ADC_CONVERSION_CONTROL_COUNT);
 
    /* If flag is set,return 1,otherwise, return 0. */
    return (((base->HS) & (1UL << channelGroup)) >> channelGroup);
}
 
status_t ADC_DoAutoCalibration(ADC_Type *base);
 
void ADC_SetOffsetConfig(ADC_Type *base, const adc_offest_config_t *config);
 
static inline void ADC_EnableDMA(ADC_Type *base, bool enable)
{
    if (enable)
    {
        base->GC |= ADC_GC_DMAEN_MASK;
    }
    else
    {
        base->GC &= ~ADC_GC_DMAEN_MASK;
    }
}
 
#if !(defined(FSL_FEATURE_ADC_SUPPORT_HARDWARE_TRIGGER_REMOVE) && FSL_FEATURE_ADC_SUPPORT_HARDWARE_TRIGGER_REMOVE)
static inline void ADC_EnableHardwareTrigger(ADC_Type *base, bool enable)
{
    if (enable)
    {
        base->CFG |= ADC_CFG_ADTRG_MASK;
    }
    else
    {
        base->CFG &= ~ADC_CFG_ADTRG_MASK;
    }
}
#endif
 
void ADC_SetHardwareCompareConfig(ADC_Type *base, const adc_hardware_compare_config_t *config);
 
void ADC_SetHardwareAverageConfig(ADC_Type *base, adc_hardware_average_mode_t mode);
 
static inline uint32_t ADC_GetStatusFlags(ADC_Type *base)
{
    return base->GS;
}
 
void ADC_ClearStatusFlags(ADC_Type *base, uint32_t mask);
 
#if defined(__cplusplus)
}
#endif
 
#endif /* _FSL_ADC_H_ */