PowerCC26X2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2023, 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_PowerCC26X2_
#define ti_drivers_power_PowerCC26X2_

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

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/sys_ctrl.h)

#ifdef __cplusplus
extern "C" {
#endif

#define PowerCC26X2_RESUMETIMESTANDBY 750

#define PowerCC26X2_TOTALTIMESTANDBY 1000

#define PowerCC26X2_WAKEDELAYSTANDBY 240

#define PowerCC26X2_INITIALWAITRCOSC_LF 1000

#define PowerCC26X2_RETRYWAITRCOSC_LF 1000

#define PowerCC26X2_INITIALWAITXOSC_HF 50

#define PowerCC26X2_RETRYWAITXOSC_HF 50

#define PowerCC26X2_INITIALWAITXOSC_LF 10000

#define PowerCC26X2_RETRYWAITXOSC_LF 5000

/* Power peripheral IDs.
 * See PowerCC26XX.h for peripheral IDs. Some are redefined here for compatibility.
 */

/* The PKA, UART1 and SSI1 peripherals are not available on CC13X1 and CC26X1 devices */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X2_CC26X2 || \
     DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)

    #define PowerCC26X2_PERIPH_PKA PowerCC26XX_PERIPH_PKA

    #define PowerCC26X2_PERIPH_UART1 PowerCC26XX_PERIPH_UART1

    #define PowerCC26X2_PERIPH_SSI1 PowerCC26XX_PERIPH_SSI1
    #if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)

        #define PowerCC26X2_PERIPH_SPI1 PowerCC26X2_PERIPH_SSI1
    #endif

#endif

/* The peripherals below are only available on CC13X4, CC26X3 and CC26X4 devices */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)

    #define PowerCC26X2_PERIPH_UART2 PowerCC26XX_PERIPH_UART2

    #define PowerCC26X2_PERIPH_UART3 PowerCC26XX_PERIPH_UART3

    #define PowerCC26X2_PERIPH_SPI2 PowerCC26XX_PERIPH_SPI2

    #define PowerCC26X2_PERIPH_SSI2 PowerCC26X2_PERIPH_SPI2

    #define PowerCC26X2_PERIPH_SPI3 PowerCC26XX_PERIPH_SPI3

    #define PowerCC26X2_PERIPH_SSI3 PowerCC26X2_PERIPH_SPI3

    #define PowerCC26X2_PERIPH_I2C1 PowerCC26XX_PERIPH_I2C1

#endif

#define PowerCC26X2_HPOSC_RTC_COMPENSATION_DELTA 3

#define PowerCC26X2_XOSC_LF_RTC_COMPENSATION_DELTA 2

/* \cond */
#define PowerCC26X2_NUMRESOURCES PowerCC26XX_NUMRESOURCES
/* \endcond */

/* \cond */
#define PowerCC26X2_NUMCONSTRAINTS (PowerCC26XX_NUMCONSTRAINTS + 0) /* Number of constraints supported */
/* \endcond */

/* \cond */
/*
 *  Calibration stages
 */
#define PowerCC26X2_SETUP_CALIBRATE    1
#define PowerCC26X2_INITIATE_CALIBRATE 2
#define PowerCC26X2_DO_CALIBRATE       3
/* \endcond */

typedef enum
{
    PowerCC26X2_RESET_SHUTDOWN_IO = RSTSRC_WAKEUP_FROM_SHUTDOWN,
    PowerCC26X2_RESET_TCK_NOISE   = RSTSRC_WAKEUP_FROM_TCK_NOISE,
    PowerCC26X2_RESET_SYSTEM      = RSTSRC_SYSRESET,
    PowerCC26X2_RESET_WARM_RESET  = RSTSRC_WARMRESET,
    PowerCC26X2_RESET_CLK         = RSTSRC_CLK_LOSS,
    PowerCC26X2_RESET_VDDR        = RSTSRC_VDDR_LOSS,
    PowerCC26X2_RESET_VDDS        = RSTSRC_VDDS_LOSS,
    PowerCC26X2_RESET_PIN         = RSTSRC_PIN_RESET,
    PowerCC26X2_RESET_POR         = RSTSRC_PWR_ON,
} PowerCC26X2_ResetReason;

typedef struct
{
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;
    bool (*calibrateFxn)(unsigned int calibrationStage);
    bool enablePolicy;
    bool calibrateRCOSC_LF;
    bool calibrateRCOSC_HF;
    void (*enableTCXOFxn)(bool arg);
} PowerCC26X2_Config;

typedef struct
{
    List_List notifyList;           
    uint32_t constraintMask;        
    ClockP_Struct clockObj;         
    ClockP_Struct calibrationClock; 
    ClockP_Struct tcxoEnableClock;  
    HwiP_Struct oscHwi;             
    HwiP_Struct tdcHwi;             
    int32_t nDeltaFreqCurr;         
    int32_t nCtrimCurr;             
    int32_t nCtrimFractCurr;        
    int32_t nCtrimNew;              
    int32_t nCtrimFractNew;         
    int32_t nRtrimNew;              
    int32_t nRtrimCurr;             
    int32_t nDeltaFreqNew;          
    bool bRefine;                   
    uint32_t state;                 
    bool xoscPending;               
    bool calLF;                     
    uint8_t auxHwiState;            
    bool busyCal;                   
    uint32_t calStep;               
    bool firstLF;                   
    bool enablePolicy;              
    bool initialized;               
    uint8_t constraintCounts[PowerCC26X2_NUMCONSTRAINTS];
    uint8_t resourceCounts[PowerCC26X2_NUMRESOURCES];
    unsigned int (*resourceHandlers[3])(unsigned int arg);
    Power_PolicyFxn policyFxn;               
    PowerCC26X2_ResetReason lastResetReason; 
} PowerCC26X2_ModuleState;

void PowerCC26X2_enableHposcRtcCompensation(void);

void PowerCC26X2_enableXoscLfRtcCompensation(void);

PowerCC26X2_ResetReason PowerCC26X2_getResetReason(void);

static inline void PowerCC26X2_releaseLatches(void)
{
    PowerCtrlPadSleepDisable();
}

#ifdef __cplusplus
}
#endif

#endif /* POWER_CC26X2_ */