ckmd.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       ckmd.h
 *
 *  Description:    Defines and prototypes for the CKMD module.
 *
 *  Copyright (c) 2023 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 __CKMD_H__
#define __CKMD_H__

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

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

#include <stdbool.h>
#include <stdint.h>

#include "../inc/hw_types.h"
#include "../inc/hw_memmap.h"
#include "../inc/hw_ckmd.h"

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

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialCapTrim(uint32_t q1CapTrim, uint32_t q2CapTrim)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~(CKMD_HFXTINIT_Q1CAP_M | CKMD_HFXTINIT_Q2CAP_M);
    tmp |= (q1CapTrim << CKMD_HFXTINIT_Q1CAP_S) & CKMD_HFXTINIT_Q1CAP_M;
    tmp |= (q2CapTrim << CKMD_HFXTINIT_Q2CAP_S) & CKMD_HFXTINIT_Q2CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialQ1CapTrim(uint32_t q1Cap)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~CKMD_HFXTINIT_Q1CAP_M;
    tmp |= (q1Cap << CKMD_HFXTINIT_Q1CAP_S) & CKMD_HFXTINIT_Q1CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialQ2CapTrim(uint32_t q2Cap)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~CKMD_HFXTINIT_Q2CAP_M;
    tmp |= (q2Cap << CKMD_HFXTINIT_Q2CAP_S) & CKMD_HFXTINIT_Q2CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialIrefTrim(uint32_t iref)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~CKMD_HFXTINIT_IREF_M;
    tmp |= (iref << CKMD_HFXTINIT_IREF_S) & CKMD_HFXTINIT_IREF_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialIdacTrim(uint32_t idac)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~CKMD_HFXTINIT_IDAC_M;
    tmp |= (idac << CKMD_HFXTINIT_IDAC_S) & CKMD_HFXTINIT_IDAC_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetInitialAmplitudeThresholdTrim(uint32_t amplitudeThreshold)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & ~CKMD_HFXTINIT_AMPTHR_M;
    tmp |= (amplitudeThreshold << CKMD_HFXTINIT_AMPTHR_S) & CKMD_HFXTINIT_AMPTHR_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTINIT) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetInitialQ1CapTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & CKMD_HFXTINIT_Q1CAP_M) >> CKMD_HFXTINIT_Q1CAP_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetInitialQ2CapTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & CKMD_HFXTINIT_Q2CAP_M) >> CKMD_HFXTINIT_Q2CAP_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetInitialIrefTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & CKMD_HFXTINIT_IREF_M) >> CKMD_HFXTINIT_IREF_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetInitialIdacTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & CKMD_HFXTINIT_IDAC_M) >> CKMD_HFXTINIT_IDAC_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetInitialAmplitudeThresholdTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTINIT) & CKMD_HFXTINIT_AMPTHR_M) >> CKMD_HFXTINIT_AMPTHR_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetCapTrim(uint32_t q1CapTrim, uint32_t q2CapTrim)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~(CKMD_HFXTTARG_Q1CAP_M | CKMD_HFXTTARG_Q2CAP_M);
    tmp |= (q1CapTrim << CKMD_HFXTTARG_Q1CAP_S) & CKMD_HFXTTARG_Q1CAP_M;
    tmp |= (q2CapTrim << CKMD_HFXTTARG_Q2CAP_S) & CKMD_HFXTTARG_Q2CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}
//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetQ1CapTrim(uint32_t q1Cap)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~CKMD_HFXTTARG_Q1CAP_M;
    tmp |= (q1Cap << CKMD_HFXTTARG_Q1CAP_S) & CKMD_HFXTTARG_Q1CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetQ2CapTrim(uint32_t q2Cap)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~CKMD_HFXTTARG_Q2CAP_M;
    tmp |= (q2Cap << CKMD_HFXTTARG_Q2CAP_S) & CKMD_HFXTTARG_Q2CAP_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetIrefTrim(uint32_t iref)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~CKMD_HFXTTARG_IREF_M;
    tmp |= (iref << CKMD_HFXTTARG_IREF_S) & CKMD_HFXTTARG_IREF_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetIdacTrim(uint32_t idac)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~CKMD_HFXTTARG_IDAC_M;
    tmp |= (idac << CKMD_HFXTTARG_IDAC_S) & CKMD_HFXTTARG_IDAC_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetTargetAmplitudeThresholdTrim(uint32_t amplitudeThreshold)
{
    uint32_t tmp = HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & ~CKMD_HFXTTARG_AMPTHR_M;
    tmp |= (amplitudeThreshold << CKMD_HFXTTARG_AMPTHR_S) & CKMD_HFXTTARG_AMPTHR_M;
    HWREG(CKMD_BASE + CKMD_O_HFXTTARG) = tmp;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetTargetQ1CapTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & CKMD_HFXTTARG_Q1CAP_M) >> CKMD_HFXTTARG_Q1CAP_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetTargetQ2CapTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & CKMD_HFXTTARG_Q2CAP_M) >> CKMD_HFXTTARG_Q2CAP_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetTargetIrefTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & CKMD_HFXTTARG_IREF_M) >> CKMD_HFXTTARG_IREF_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetTargetIdacTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & CKMD_HFXTTARG_IDAC_M) >> CKMD_HFXTTARG_IDAC_S;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t CKMDGetTargetAmplitudeThresholdTrim(void)
{
    return (HWREG(CKMD_BASE + CKMD_O_HFXTTARG) & CKMD_HFXTTARG_AMPTHR_M) >> CKMD_HFXTTARG_AMPTHR_S;
}

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

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

#endif // __CKMD_H__