pmctl.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       pmctl.h
 *
 *  Description:    Defines and prototypes for the PMCTL module.
 *
 *  Copyright (c) 2022-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 __PMCTL_H__
#define __PMCTL_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_pmctl.h"

#include "../cmsis/cc27xx.h"
#include "../cmsis/core/core_cm33.h"

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

//*****************************************************************************
#define PMCTL_RESET_SHUTDOWN_IO        (PMCTL_RSTSTA_SDDET | PMCTL_RSTSTA_IOWUSD)
#define PMCTL_RESET_SHUTDOWN_SWD       PMCTL_RSTSTA_SDDET
#define PMCTL_RESET_WATCHDOG           (PMCTL_RSTSTA_SYSSRC_WDTEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_SYSTEM             (PMCTL_RSTSTA_SYSSRC_SYSRSTEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_CPU                (PMCTL_RSTSTA_SYSSRC_CPURSTEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_LOCKUP             (PMCTL_RSTSTA_SYSSRC_LOCKUPEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_ANALOG_FSM_TIMEOUT (PMCTL_RSTSTA_SYSSRC_AFSMEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_EM_SENSOR          (PMCTL_RSTSTA_SYSSRC_EMSEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_TAMPER             (PMCTL_RSTSTA_SYSSRC_TAMPEREV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_SRAM_PARITY_ERROR  (PMCTL_RSTSTA_SYSSRC_SRAMEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_ANALOG_ERROR       (PMCTL_RSTSTA_SYSSRC_AERREV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_DIGITAL_ERROR      (PMCTL_RSTSTA_SYSSRC_DERREV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_SWD                (PMCTL_RSTSTA_SYSSRC_SWDRSTEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_LFXT               (PMCTL_RSTSTA_SYSSRC_LFLOSSEV | PMCTL_RSTSTA_RESETSRC_SYSRESET)
#define PMCTL_RESET_TSD                (PMCTL_RSTSTA_TSDEV | PMCTL_RSTSTA_RESETSRC_PINRESET)
#define PMCTL_RESET_VDDR               PMCTL_RSTSTA_RESETSRC_VDDRLOSS
#define PMCTL_RESET_VDDS               PMCTL_RSTSTA_RESETSRC_VDDSLOSS
#define PMCTL_RESET_PIN                PMCTL_RSTSTA_RESETSRC_PINRESET
#define PMCTL_RESET_POR                PMCTL_RSTSTA_RESETSRC_PWRON


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

//*****************************************************************************
#define PMCTL_VOLTAGE_REGULATOR_DCDC PMCTL_VDDRCTL_SELECT_DCDC
#define PMCTL_VOLTAGE_REGULATOR_GLDO PMCTL_VDDRCTL_SELECT_GLDO


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

#ifndef DRIVERLIB_NS
//*****************************************************************************
//
// Below functions will only be compiled into the driverlib.a library and not
// the driverlib_ns.a library.
// Non-secure applications might be able to access some/all of these functions
// through veneers declared further below in the #else case.
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t PMCTLGetResetReason(void)
{
    // Read the RSTSTA register but mask out the RTCSTA bit
    return HWREG(PMCTL_BASE + PMCTL_O_RSTSTA) & ~PMCTL_RSTSTA_RTCSTA_M;
}

//*****************************************************************************
//
//*****************************************************************************
__STATIC_INLINE bool PMCTLGetRtcResetStatus(void)
{
    return (HWREG(PMCTL_BASE + PMCTL_O_RSTSTA) & PMCTL_RSTSTA_RTCSTA_M) == PMCTL_RSTSTA_RTCSTA_CLR;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void PMCTLResetSystem(void)
{
    // Disable interrupts
    __disable_irq();

    // Write reset register
    HWREG(PMCTL_BASE + PMCTL_O_RSTCTL) |= PMCTL_RSTCTL_SYSRST_SET;

    // Should never return from this function
    while (1) {}
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void PMCTLSetVoltageRegulator(uint32_t regulator)
{
    // Write to VDDR regulator register while preserving other configuration
    // fields
    uint32_t tmp                        = HWREG(PMCTL_BASE + PMCTL_O_VDDRCTL) & ~PMCTL_VDDRCTL_SELECT_M;
    HWREG(PMCTL_BASE + PMCTL_O_VDDRCTL) = tmp | regulator;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t PMCTLGetVoltageRegulator(void)
{
    return (HWREG(PMCTL_BASE + PMCTL_O_VDDRCTL) & PMCTL_VDDRCTL_SELECT_M);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void PMCTLEnableVddioGpioPadPower(void)
{
    HWREG(PMCTL_BASE + PMCTL_O_AONRSET1) |= PMCTL_AONRSET1_VDDIOPGIO_SET;
}

#else
//*****************************************************************************
//
// Secure-only API functions available from non-secure context through
// veneers.
//
// These functions must be linked in from from the secure veneer library.
//
//*****************************************************************************

extern bool PMCTLGetRtcResetStatus_veneer(void);
    #define PMCTLGetRtcResetStatus       PMCTLGetRtcResetStatus_veneer

extern bool PMCTLEnableVddioGpioPadPower_veneer(void);
    #define PMCTLEnableVddioGpioPadPower PMCTLEnableVddioGpioPadPower_veneer

#endif

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

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

#endif // __PMCTL_H__