lpcmp.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       lpcmp.h
 *
 *  Description:    Defines and prototypes for the LPCMP peripheral.
 *
 *  Copyright (c) 2022-2024, Texas Instruments Incorporated
 *  All rights reserved.
 *
 *  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 ORGANIZATION 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 __LPCMP_H__
#define __LPCMP_H__

//*****************************************************************************
//
//
//*****************************************************************************

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

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

//*****************************************************************************
//
// Defines that can be passed to LPCMPSetDividerPath() to select the voltage
// divider path.
//
//*****************************************************************************
#define LPCMP_DIVISION_PATH_N SYS0_LPCMPCFG_DIVPATH_NSIDE 
#define LPCMP_DIVISION_PATH_P SYS0_LPCMPCFG_DIVPATH_PSIDE 

//*****************************************************************************
//
// Defines that can be passed to LPCMPSetDividerRatio() to select which ratio
// should be used by the voltage divider.
//
//*****************************************************************************
#define LPCMP_DIVISION_FACTOR_1_1 SYS0_LPCMPCFG_DIV_VAL0 
#define LPCMP_DIVISION_FACTOR_3_4 SYS0_LPCMPCFG_DIV_VAL1 
#define LPCMP_DIVISION_FACTOR_1_2 SYS0_LPCMPCFG_DIV_VAL2 
#define LPCMP_DIVISION_FACTOR_1_3 SYS0_LPCMPCFG_DIV_VAL3 
#define LPCMP_DIVISION_FACTOR_1_4 SYS0_LPCMPCFG_DIV_VAL4 

//*****************************************************************************
//
// Defines that can be passed to LPCMPSetPolarity() to select which edge type
// should generate a LPCMP event.
//
//*****************************************************************************
#define LPCMP_POLARITY_FALL SYS0_LPCMPCFG_EDGCFG_FALL 
#define LPCMP_POLARITY_RISE SYS0_LPCMPCFG_EDGCFG_RISE 

//*****************************************************************************
//
// Defines that can be passed to LPCMPNegativeInputSelect() to select which
// signal should be muxed to LPCMP negative input.
//
//*****************************************************************************
#define LPCMP_NEG_INPUT_VDDD SYS0_LPCMPCFG_NSEL_VDDD      
#define LPCMP_NEG_INPUT_VDDS SYS0_LPCMPCFG_NSEL_VDDA      
#define LPCMP_NEG_INPUT_A2   SYS0_LPCMPCFG_NSEL_VA_PAD_A2 
#define LPCMP_NEG_INPUT_A3   SYS0_LPCMPCFG_NSEL_VA_PAD_A3 
#define LPCMP_NEG_INPUT_OPEN SYS0_LPCMPCFG_NSEL_OPEN      

//*****************************************************************************
//
// Defines that can be passed to LPCMPPositiveInputSelect() to select which
// signal should be muxed to LPCMP positive input.
//
//*****************************************************************************
#define LPCMP_POS_INPUT_A1   SYS0_LPCMPCFG_PSEL_VA_PAD_A1 
#define LPCMP_POS_INPUT_A2   SYS0_LPCMPCFG_PSEL_VA_PAD_A2 
#define LPCMP_POS_INPUT_A3   SYS0_LPCMPCFG_PSEL_VA_PAD_A3 
#define LPCMP_POS_INPUT_VDDS SYS0_LPCMPCFG_PSEL_VDDA      
#define LPCMP_POS_INPUT_OPEN SYS0_LPCMPCFG_PSEL_OPEN      

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

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPEnable(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) |= SYS0_LPCMPCFG_EN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPDisable(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_EN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPEnableEvent(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) |= SYS0_LPCMPCFG_EVTEN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPDisableEvent(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_EVTEN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPClearEvent(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_EVTIFG;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPEnableWakeup(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) |= SYS0_LPCMPCFG_WUENSB;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPDisableWakeup(void)
{
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_WUENSB;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPSelectNegativeInput(uint32_t input)
{
    uint32_t lpcmpcfg;

    lpcmpcfg                           = HWREG(SYS0_BASE + SYS0_O_LPCMPCFG);
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) = (lpcmpcfg & ~SYS0_LPCMPCFG_NSEL_M) | (input & SYS0_LPCMPCFG_NSEL_M);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE bool LPCMPIsOutputHigh(void)
{
    if (HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) & SYS0_LPCMPCFG_COUT_HIGH)
    {
        return true;
    }
    else
    {
        return false;
    }
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPSelectPositiveInput(uint32_t input)
{
    uint32_t lpcmpcfg;

    lpcmpcfg                           = HWREG(SYS0_BASE + SYS0_O_LPCMPCFG);
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) = (lpcmpcfg & ~SYS0_LPCMPCFG_PSEL_M) | (input & SYS0_LPCMPCFG_PSEL_M);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPSetPolarity(uint32_t polarity)
{
    if (polarity == LPCMP_POLARITY_FALL)
    {
        HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) |= SYS0_LPCMPCFG_EDGCFG;
    }
    else
    {
        HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_EDGCFG;
    }
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPSetDividerRatio(uint32_t divider)
{
    uint32_t lpcmpcfg;

    lpcmpcfg                           = HWREG(SYS0_BASE + SYS0_O_LPCMPCFG);
    HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) = (lpcmpcfg & ~SYS0_LPCMPCFG_DIV_M) | (divider & SYS0_LPCMPCFG_DIV_M);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void LPCMPSetDividerPath(uint32_t path)
{
    if (path == LPCMP_DIVISION_PATH_P)
    {
        HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) |= SYS0_LPCMPCFG_DIVPATH;
    }
    else
    {
        HWREG(SYS0_BASE + SYS0_O_LPCMPCFG) &= ~SYS0_LPCMPCFG_DIVPATH;
    }
}

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

//*****************************************************************************
//
//
//*****************************************************************************

#endif // __LPCMP_H__