ckmd.h

Go to the documentation of this file.

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

//*****************************************************************************
//
//
//*****************************************************************************
#define CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MIN (INT16_MIN)
#define CKMD_LFOSC_MID_TEMP_COEFFICIENT_RANGE_MAX (70)

#define CKMD_WATCHDOG_UNLOCK 0x1ACCE551

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

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDEnableHighPerformanceClockBuffer(void)
{
    HWREG(CKMD_BASE + CKMD_O_HFXTCTL) |= CKMD_HFXTCTL_HPBUFEN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDDisableHighPerformanceClockBuffer(void)
{
    HWREG(CKMD_BASE + CKMD_O_HFXTCTL) &= ~CKMD_HFXTCTL_HPBUFEN;
}

//*****************************************************************************
//
//
//*****************************************************************************
__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;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint_least16_t CKMDGetLfoscRtnPpm(void)
{
    // Only App trims revision 5 and newer has a ppmRtn field. For older
    // revisions use a default value of 20 (equivalent to 600ppm)
    uint8_t ppmRtn = 20;
    if (fcfg->appTrims.revision >= 0x5)
    {
        ppmRtn = fcfg->appTrims.cc23x0r5.misc0.lfoscPpmRtn;
    }

    // The ppmTempMid field uses units of 30ppm, convert to ppm
    return ppmRtn * 30;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint_least16_t CKMDGetLfoscMidTempCoefficientPpmPerC(void)
{
    // Only App trims revision 5 and newer has a ppmTempMid field. For older
    // revisions use a default value of 20 (equivalent to 260ppm/C)
    uint8_t ppmTempMid = 20;
    if (fcfg->appTrims.revision >= 0x5)
    {
        ppmTempMid = fcfg->appTrims.cc23x0r5.misc0.lfoscPpmTempMid;
    }

    // The ppmTempMid field uses units of 13ppm/C, convert to ppm/C
    return ppmTempMid * 13;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint_least16_t CKMDGetLfoscExtTempCoefficientPpmPerC(void)
{
    // Only App trims revision 5 and newer has a ppmTempExt field. For older
    // revisions use a default value of 20 (equivalent to 700ppm/C)
    uint8_t ppmTempExt = 20;
    if (fcfg->appTrims.revision >= 0x5)
    {
        ppmTempExt = fcfg->appTrims.cc23x0r5.misc0.lfoscPpmTempExt;
    }

    // The ppmTempExt field uses units of 35ppm/C, convert to ppm/C
    return ppmTempExt * 35;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDUnlockWatchdog(void)
{
    // Unlock the Watchdog
    HWREG(CKMD_BASE + CKMD_O_WDTLOCK) = CKMD_WATCHDOG_UNLOCK;

    // Make sure the Watchdog is unlocked before continuing
    while (HWREG(CKMD_BASE + CKMD_O_WDTLOCK) == 1) {}
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDLockWatchdog(void)
{
    HWREG(CKMD_BASE + CKMD_O_WDTLOCK) = 0x0;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetWatchdogCounter(uint32_t value)
{
    HWREG(CKMD_BASE + CKMD_O_WDTCNT) = value;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void CKMDSetWatchdogDebugConfig(bool stopWhenCpuIsHalted)
{
    HWREG(CKMD_BASE + CKMD_O_WDTTEST) = stopWhenCpuIsHalted ? CKMD_WDTTEST_STALLEN_EN : CKMD_WDTTEST_STALLEN_DIS;
}

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

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

#endif // __CKMD_H__