PowerCC27XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2025, 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:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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 ti_drivers_power_PowerCC27XX_
#define ti_drivers_power_PowerCC27XX_

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/ClockP.h>
#include <ti/drivers/Power.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(inc/hw_pmctl.h)
#include DeviceFamily_constructPath(inc/hw_clkctl.h)
#include DeviceFamily_constructPath(inc/hw_lrfddbell.h)
#include DeviceFamily_constructPath(inc/hw_memmap.h)
#include DeviceFamily_constructPath(inc/hw_types.h)
#include DeviceFamily_constructPath(driverlib/pmctl.h)

#ifdef __cplusplus
extern "C" {
#endif

#define PowerCC27XX_RESUMETIMESTANDBY (400U)

#define PowerCC27XX_TOTALTIMESTANDBY (500U)

#define PowerCC27XX_WAKEDELAYSTANDBY (150U)

/* Default lower threshold for when HFXT compensation is enabled */
#define PowerCC27XX_HFXT_THRESHOLD_TEMP_DEFAULT (-40)

/* \cond */
/* The control of the peripherals are split between multiple groups.
 * These defines are used to differentiate between the groups.
 * The bits in the PowerCC27XX_PERIPH_GROUP_M mask is used to store the group id,
 * and the bits in the PowerCC27XX_PERIPH_BIT_INDEX_M mask is used to store the
 * bit index shift value in the register for the given group.
 */
#define PowerCC27XX_PERIPH_GROUP_M       (0xFF00U)
#define PowerCC27XX_PERIPH_GROUP_CLKCTL0 (0x0000U)
#define PowerCC27XX_PERIPH_GROUP_CLKCTL1 (0x0100U)
#define PowerCC27XX_PERIPH_GROUP_LRFD    (0x0200U)
#define PowerCC27XX_PERIPH_BIT_INDEX_M   (0x00FFU)

/* \endcond */

/* \cond */
typedef uint16_t PowerLPF3_Resource; /* Power resource identifier */
/* \endcond */

/* Resource IDs */

#define PowerLPF3_PERIPH_GPIO (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_GPIO_S)

#define PowerLPF3_PERIPH_UART0 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_UART0_S)

#define PowerLPF3_PERIPH_UART1 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_UART1_S)

#define PowerLPF3_PERIPH_I2C0 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_I2C0_S)

#define PowerLPF3_PERIPH_SPI0 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_SPI0_S)

#define PowerLPF3_PERIPH_SPI1 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_SPI1_S)

#define PowerLPF3_PERIPH_ADC0 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_ADC0_S)

#define PowerLPF3_PERIPH_AES (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_LAES_S)

#define PowerLPF3_PERIPH_DMA (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_DMA_S)

#define PowerLPF3_PERIPH_I2S (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_I2S_S)

#define PowerLPF3_PERIPH_LGPT0 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_LGPT0_S)

#define PowerLPF3_PERIPH_LGPT1 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_LGPT1_S)

#define PowerLPF3_PERIPH_LGPT2 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_LGPT2_S)

#define PowerLPF3_PERIPH_LGPT3 (PowerCC27XX_PERIPH_GROUP_CLKCTL0 | CLKCTL_DESCEX0_LGPT3_S)

#define PowerLPF3_PERIPH_HSM (PowerCC27XX_PERIPH_GROUP_CLKCTL1 | CLKCTL_DESCEX1_HSM_S)

#define PowerLPF3_PERIPH_APU (PowerCC27XX_PERIPH_GROUP_CLKCTL1 | CLKCTL_DESCEX1_APU_S)

#define PowerLPF3_PERIPH_MCAN (PowerCC27XX_PERIPH_GROUP_CLKCTL1 | CLKCTL_DESCEX1_MCAN_S)

#define PowerLPF3_PERIPH_LFRD_TRC (PowerCC27XX_PERIPH_GROUP_LRFD | LRFDDBELL_CLKCTL_TRC_S)

#define PowerLPF3_PERIPH_LFRD_S2RRAM (PowerCC27XX_PERIPH_GROUP_LRFD | LRFDDBELL_CLKCTL_S2RRAM_S)

/* \cond */
/* Number of resources in the different resource groups. This is possibly larger
 * than the peripheral instance count on various device variants. This is
 * because some indexes might not be used for a given variant, resulting in a
 * sparse table.
 */
#define PowerCC27XX_NUMRESOURCES_CLKCTL0 (31U)
#define PowerCC27XX_NUMRESOURCES_CLKCTL1 (7U)
#define PowerCC27XX_NUMRESOURCES_LRFD    (12U)

/* \endcond */

#define PowerLPF3_STANDBY (0x1U) 
/* \cond */

/* Constraints
 *
 * Constraints restrict a specific system behavior from occurring or guarantee
 * a specified effect until released.
 */

#define PowerLPF3_DISALLOW_SHUTDOWN (0U)

#define PowerLPF3_DISALLOW_STANDBY (1U)

#define PowerLPF3_DISALLOW_IDLE (2U)

#define PowerLPF3_NEED_FLASH_IN_IDLE (3U)

#define PowerLPF3_DISALLOW_SWTCXO (4U)

/* \cond */
#define PowerCC27XX_NUMCONSTRAINTS (5U) /* Number of constraints supported */
/* \endcond */

/*
 *  Events
 *
 *  Each event must be a power of two and must be sequential
 *  without any gaps.
 */

#define PowerLPF3_ENTERING_STANDBY ((uint_fast16_t)((uint_fast16_t)1U << 0))

#define PowerLPF3_ENTERING_SHUTDOWN ((uint_fast16_t)((uint_fast16_t)1U << 1))

#define PowerLPF3_AWAKE_STANDBY ((uint_fast16_t)((uint_fast16_t)1U << 2))

#define PowerLPF3_HFXT_AVAILABLE ((uint_fast16_t)((uint_fast16_t)1U << 3))

#define PowerLPF3_LFCLK_SWITCHED ((uint_fast16_t)((uint_fast16_t)1U << 4))

/* \cond */
#define PowerCC27XX_NUMEVENTS (5U) /* Number of events supported */
/* \endcond */

typedef void (*PowerLPF3_StartInitialHfxtAmpCompFxn)(void);

typedef struct
{
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;

    PowerLPF3_StartInitialHfxtAmpCompFxn startInitialHfxtAmpCompFxn;
} PowerCC27XX_Config;

typedef enum
{
    PowerLPF3_RESET_SHUTDOWN_IO  = PMCTL_RESET_SHUTDOWN_IO,
    PowerLPF3_RESET_SHUTDOWN_SWD = PMCTL_RESET_SHUTDOWN_SWD,
    PowerLPF3_RESET_WATCHDOG     = PMCTL_RESET_WATCHDOG,
    PowerLPF3_RESET_SYSTEM       = PMCTL_RESET_SYSTEM,
    PowerLPF3_RESET_CPU          = PMCTL_RESET_CPU,
    PowerLPF3_RESET_LOCKUP       = PMCTL_RESET_LOCKUP,
    PowerLPF3_RESET_TSD          = PMCTL_RESET_TSD,
    PowerLPF3_RESET_SWD          = PMCTL_RESET_SWD,
    PowerLPF3_RESET_LFXT         = PMCTL_RESET_LFXT,
    PowerLPF3_RESET_VDDR         = PMCTL_RESET_VDDR,
    PowerLPF3_RESET_VDDS         = PMCTL_RESET_VDDS,
    PowerLPF3_RESET_PIN          = PMCTL_RESET_PIN,
    PowerLPF3_RESET_POR          = PMCTL_RESET_POR,
    PowerLPF3_RESET_UNKNOWN      = UINT32_MAX,
} PowerLPF3_ResetReason;

typedef enum
{
    PowerLPF3_AFOSC_FREQ_80MHZ      = 80000000U, 
    PowerLPF3_AFOSC_FREQ_90P3168MHZ = 90316800U, 
    PowerLPF3_AFOSC_FREQ_98P304MHZ  = 98304000U, 
} PowerLPF3_AfoscFreq;

typedef enum
{
    PowerLPF3_LFOSC_PPM_500 = 500U,
} PowerLPF3_LfoscCompensationPpmRequirement;

typedef struct
{
    uint32_t systemWakeupIntervalUsec;

    PowerLPF3_LfoscCompensationPpmRequirement ppmRequirement;

    uint16_t maxAllowedJitterUsec;

    uint16_t temperatureGradientMilliCelsiusPerSec;

} PowerLPF3_LfoscCompensationProfile;

void PowerCC27XX_doWFI(void);

PowerLPF3_ResetReason PowerLPF3_getResetReason(void);

void PowerLPF3_releaseLatches(void);

void PowerCC27XX_standbyPolicy(void);

void PowerLPF3_selectLFOSC(void);

void PowerLPF3_selectLFXT(void);

void PowerLPF3_selectEXTLF(void);

void PowerLPF3_initHFXTCompensation(int32_t P0, int32_t P1, int32_t P2, int32_t P3, uint8_t shift, bool fcfgInsertion);

void PowerLPF3_enableHFXTCompensation(int16_t tempThreshold, int16_t tempDelta);

void PowerLPF3_disableHFXTCompensation(void);

void PowerLPF3_forceHFXTCompensationUpdate(void);

uint32_t PowerLPF3_getHFXTCompensationRatio(void);

int_fast16_t PowerLPF3_startAFOSC(PowerLPF3_AfoscFreq frequency);

void PowerLPF3_stopAFOSC(void);

void PowerLPF3_startInitialHfxtAmpComp(void);

int_fast8_t PowerLPF3_getHfxtAmpAdjustment(void);

void PowerLPF3_adjustHfxtAmp(int_fast8_t adjustment);

void PowerLPF3_initLfoscCompensation(void);

void PowerLPF3_setLfoscCompensationProfile(const PowerLPF3_LfoscCompensationProfile *profile);

void PowerLPF3_enableLfoscCompensation(void);

void PowerLPF3_disableLfoscCompensation(void);

int_fast16_t PowerLPF3_sleep(uint32_t nextEventTimeUs);

bool PowerLPF3_isLfincFilterAllowingStandby(void);

void PowerCC27XX_schedulerDisable(void);
void PowerCC27XX_schedulerRestore(void);

#ifdef __cplusplus
}
#endif

#endif /* POWER_CC27XX_ */