fsl_cmp.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016-2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _FSL_CMP_H_
#define _FSL_CMP_H_
 
#include "fsl_common.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define FSL_CMP_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
enum _cmp_interrupt_enable
{
    kCMP_OutputRisingInterruptEnable  = CMP_SCR_IER_MASK, 
    kCMP_OutputFallingInterruptEnable = CMP_SCR_IEF_MASK, 
};
 
enum _cmp_status_flags
{
    kCMP_OutputRisingEventFlag  = CMP_SCR_CFR_MASK,  
    kCMP_OutputFallingEventFlag = CMP_SCR_CFF_MASK,  
    kCMP_OutputAssertEventFlag  = CMP_SCR_COUT_MASK, 
};
 
typedef enum _cmp_hysteresis_mode
{
    kCMP_HysteresisLevel0 = 0U, 
    kCMP_HysteresisLevel1 = 1U, 
    kCMP_HysteresisLevel2 = 2U, 
    kCMP_HysteresisLevel3 = 3U, 
} cmp_hysteresis_mode_t;
 
typedef enum _cmp_reference_voltage_source
{
    kCMP_VrefSourceVin1 = 0U, 
    kCMP_VrefSourceVin2 = 1U, 
} cmp_reference_voltage_source_t;
 
typedef struct _cmp_config
{
    bool enableCmp;                       
    cmp_hysteresis_mode_t hysteresisMode; 
    bool enableHighSpeed;                 
    bool enableInvertOutput;              
    bool useUnfilteredOutput;             
    bool enablePinOut;                    
#if defined(FSL_FEATURE_CMP_HAS_TRIGGER_MODE) && FSL_FEATURE_CMP_HAS_TRIGGER_MODE
    bool enableTriggerMode; 
#endif                      /* FSL_FEATURE_CMP_HAS_TRIGGER_MODE */
} cmp_config_t;
 
typedef struct _cmp_filter_config
{
#if defined(FSL_FEATURE_CMP_HAS_EXTERNAL_SAMPLE_SUPPORT) && FSL_FEATURE_CMP_HAS_EXTERNAL_SAMPLE_SUPPORT
    bool enableSample;    
#endif                    /* FSL_FEATURE_CMP_HAS_EXTERNAL_SAMPLE_SUPPORT */
    uint8_t filterCount;  
    uint8_t filterPeriod; 
} cmp_filter_config_t;
 
typedef struct _cmp_dac_config
{
    cmp_reference_voltage_source_t referenceVoltageSource; 
    uint8_t DACValue; 
} cmp_dac_config_t;
 
#if defined(__cplusplus)
extern "C" {
#endif
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
void CMP_Init(CMP_Type *base, const cmp_config_t *config);
 
void CMP_Deinit(CMP_Type *base);
 
static inline void CMP_Enable(CMP_Type *base, bool enable)
{
    if (enable)
    {
        base->CR1 |= CMP_CR1_EN_MASK;
    }
    else
    {
        base->CR1 &= ~(uint8_t)CMP_CR1_EN_MASK;
    }
}
 
void CMP_GetDefaultConfig(cmp_config_t *config);
 
void CMP_SetInputChannels(CMP_Type *base, uint8_t positiveChannel, uint8_t negativeChannel);
 
/* @} */
 
#if defined(FSL_FEATURE_CMP_HAS_DMA) && FSL_FEATURE_CMP_HAS_DMA
void CMP_EnableDMA(CMP_Type *base, bool enable);
#endif /* FSL_FEATURE_CMP_HAS_DMA */
 
#if defined(FSL_FEATURE_CMP_HAS_WINDOW_MODE) && FSL_FEATURE_CMP_HAS_WINDOW_MODE
static inline void CMP_EnableWindowMode(CMP_Type *base, bool enable)
{
    if (enable)
    {
        base->CR1 |= CMP_CR1_WE_MASK;
    }
    else
    {
        base->CR1 &= (uint8_t)(~CMP_CR1_WE_MASK);
    }
}
#endif /* FSL_FEATURE_CMP_HAS_WINDOW_MODE */
 
#if defined(FSL_FEATURE_CMP_HAS_PASS_THROUGH_MODE) && FSL_FEATURE_CMP_HAS_PASS_THROUGH_MODE
static inline void CMP_EnablePassThroughMode(CMP_Type *base, bool enable)
{
    if (enable)
    {
        base->MUXCR |= CMP_MUXCR_PSTM_MASK;
    }
    else
    {
        base->MUXCR &= (uint8_t)(~CMP_MUXCR_PSTM_MASK);
    }
}
#endif /* FSL_FEATURE_CMP_HAS_PASS_THROUGH_MODE */
 
void CMP_SetFilterConfig(CMP_Type *base, const cmp_filter_config_t *config);
 
void CMP_SetDACConfig(CMP_Type *base, const cmp_dac_config_t *config);
 
void CMP_EnableInterrupts(CMP_Type *base, uint32_t mask);
 
void CMP_DisableInterrupts(CMP_Type *base, uint32_t mask);
 
/* @} */
 
uint32_t CMP_GetStatusFlags(CMP_Type *base);
 
void CMP_ClearStatusFlags(CMP_Type *base, uint32_t mask);
 
/* @} */
#if defined(__cplusplus)
}
#endif
#endif /* _FSL_CMP_H_ */