PowerCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2022, 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 CONSEQueueNTIAL 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_PowerCC26XX_
#define ti_drivers_power_PowerCC26XX_

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

#include <ti/devices/DeviceFamily.h>

#ifdef __cplusplus
extern "C" {
#endif

/* \cond */
typedef uint8_t PowerCC26XX_Resource; /* Resource identifier */
/* \endcond */

#define PowerCC26XX_RESUMETIMESTANDBY  750

#define PowerCC26XX_TOTALTIMESTANDBY   1000

#define PowerCC26XX_WAKEDELAYSTANDBY   240

#define PowerCC26XX_INITIALWAITRCOSC_LF 1000

#define PowerCC26XX_RETRYWAITRCOSC_LF   1000

#define PowerCC26XX_INITIALWAITXOSC_HF  50

#define PowerCC26XX_RETRYWAITXOSC_HF    50

#define PowerCC26XX_INITIALWAITXOSC_LF  10000

#define PowerCC26XX_RETRYWAITXOSC_LF    5000

/* resource IDs */
#define PowerCC26XX_PERIPH_GPT0    0

#define PowerCC26XX_PERIPH_GPT1    1

#define PowerCC26XX_PERIPH_GPT2    2

#define PowerCC26XX_PERIPH_GPT3    3

#define PowerCC26XX_PERIPH_SSI0    4

#define PowerCC26XX_PERIPH_UART0   5  
#define PowerCC26XX_PERIPH_I2C0    6  
#define PowerCC26XX_PERIPH_TRNG    7

#define PowerCC26XX_PERIPH_GPIO    8  
#define PowerCC26XX_PERIPH_UDMA    9  
#define PowerCC26XX_PERIPH_CRYPTO  10 
#define PowerCC26XX_PERIPH_I2S     11 
#define PowerCC26XX_PERIPH_RFCORE  12 
#define PowerCC26XX_XOSC_HF        13

#define PowerCC26XX_DOMAIN_PERIPH  14

#define PowerCC26XX_DOMAIN_SERIAL  15

#define PowerCC26XX_DOMAIN_RFCORE  16

#define PowerCC26XX_DOMAIN_SYSBUS  17

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

#define PowerCC26XX_PERIPH_PKA      18

#define PowerCC26XX_PERIPH_UART1    19

#define PowerCC26XX_PERIPH_SSI1     20

#endif

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

#define PowerCC26XX_PERIPH_UART2    21

#define PowerCC26XX_PERIPH_UART3    22

#define PowerCC26XX_PERIPH_SSI2     23

#define PowerCC26XX_PERIPH_SSI3     24

#define PowerCC26XX_PERIPH_I2C1     25

#endif

/* \cond */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X0_CC26X0)
#define PowerCC26XX_NUMRESOURCES 19 /* Number of resources in database */
#elif (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X1_CC26X1)
#define PowerCC26XX_NUMRESOURCES 19 /* Number of resources in database */
#elif (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X2_CC26X2)
#define PowerCC26XX_NUMRESOURCES 21 /* Number of resources in database */
#elif (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)
#define PowerCC26XX_NUMRESOURCES 26 /* Number of resources in database */
#endif
/* \endcond */

/* \cond */
/* resource record bitmasks */
#define PowerCC26XX_PERIPH          0x80 /* resource is a peripheral */
#define PowerCC26XX_SPECIAL         0x40 /* resource requires special handler */
#define PowerCC26XX_DOMAIN          0x00 /* resource is a domain */
#define PowerCC26XX_PARENTMASK      0x3F /* parent resource mask */
#define PowerCC26XX_NOPARENT        0x3F /* if resource has no parent */
/* \endcond */

#define PowerCC26XX_STANDBY         0x1 
/* \cond */
/* internal flags for enabling/disabling resources */
#define PowerCC26XX_ENABLE          1
#define PowerCC26XX_DISABLE         0
/* \endcond */

/* constraints */
#define PowerCC26XX_RETAIN_VIMS_CACHE_IN_STANDBY  0

#define PowerCC26XX_DISALLOW_SHUTDOWN  1

#define PowerCC26XX_DISALLOW_STANDBY  2

#define PowerCC26XX_DISALLOW_IDLE  3

#define PowerCC26XX_NEED_FLASH_IN_IDLE  4

#define PowerCC26XX_SWITCH_XOSC_HF_MANUALLY 5

#define PowerCC26XX_DISALLOW_XOSC_HF_SWITCHING 6

/* \cond */
#define PowerCC26XX_NUMCONSTRAINTS  7 /* Number of constraints supported */
/* \endcond */

/* \cond */
/* Deprecated constraint names */
#define PowerCC26XX_SD_DISALLOW  PowerCC26XX_DISALLOW_SHUTDOWN
#define PowerCC26XX_SB_DISALLOW  PowerCC26XX_DISALLOW_STANDBY
#define PowerCC26XX_IDLE_PD_DISALLOW  PowerCC26XX_DISALLOW_IDLE
#define PowerCC26XX_XOSC_HF_SWITCHING_DISALLOW PowerCC26XX_DISALLOW_XOSC_HF_SWITCHING
#define PowerCC26XX_SB_VIMS_CACHE_RETAIN PowerCC26XX_RETAIN_VIMS_CACHE_IN_STANDBY
/* \endcond */

/*
 *  Events
 *
 *  Each event must be a power of two and must be sequential
 *  without any gaps.
 */
#define PowerCC26XX_ENTERING_STANDBY    0x1

#define PowerCC26XX_ENTERING_SHUTDOWN   0x2

#define PowerCC26XX_AWAKE_STANDBY       0x4

#define PowerCC26XX_AWAKE_STANDBY_LATE  0x8

#define PowerCC26XX_XOSC_HF_SWITCHED    0x10

#define PowerCC26XX_JTAG_PD_TURNED_ON   0x20

/* \cond */
#define PowerCC26XX_NUMEVENTS           6  /* Number of events supported */
/* \endcond */

/* \cond */
/*
 *  Calibration stages
 */
#define PowerCC26XX_SETUP_CALIBRATE     1
#define PowerCC26XX_INITIATE_CALIBRATE  2
#define PowerCC26XX_DO_CALIBRATE        3
/* \endcond */

/* \cond */
typedef struct {
    uint8_t flags;          /* resource type | first parent */
    uint16_t driverlibID;   /* corresponding driverlib ID for this resource */
} PowerCC26XX_ResourceRecord;
/* \endcond */

typedef struct {
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;
    bool (*calibrateFxn)(unsigned int arg);
    uint32_t maxStandbyDuration;
    uint16_t vddrRechargeMargin;
    bool enableMaxStandbyDuration;
    bool enablePolicy;
    bool calibrateRCOSC_LF;
    bool calibrateRCOSC_HF;
} PowerCC26XX_Config;

typedef struct {
    List_List notifyList;        
    uint32_t constraintMask;     
    ClockP_Struct clockObj;       
    ClockP_Struct xoscClockObj;   
    ClockP_Struct lfClockObj;     
    ClockP_Struct calClockStruct; 
    HwiP_Struct hwiStruct;        
    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 hwiState;            
    bool busyCal;                
    uint8_t calStep;             
    bool firstLF;                
    bool enablePolicy;           
    bool initialized;            
#if defined(DeviceFamily_CC26X0R2)
    bool emulatorAttached;      
#endif
    uint8_t constraintCounts[PowerCC26XX_NUMCONSTRAINTS];
    uint8_t resourceCounts[PowerCC26XX_NUMRESOURCES];
    unsigned int (*resourceHandlers[3])(unsigned int arg);
    Power_PolicyFxn policyFxn;   
} PowerCC26XX_ModuleState;

bool PowerCC26XX_calibrate(unsigned int arg);

void PowerCC26XX_doWFI(void);

ClockP_Handle PowerCC26XX_getClockHandle(void);

uint32_t PowerCC26XX_getXoscStartupTime(uint32_t timeUntilWakeupInMs);

bool PowerCC26XX_injectCalibration(void);

bool PowerCC26XX_noCalibrate(unsigned int arg);

bool PowerCC26XX_isStableXOSC_HF(void);

void PowerCC26XX_switchXOSC_HF(void);

void PowerCC26XX_standbyPolicy(void);

void PowerCC26XX_schedulerDisable(void);
void PowerCC26XX_schedulerRestore(void);

#define Power_getPerformanceLevel(void)   0
#define Power_setPerformanceLevel(level)  Power_EFAIL

#ifdef __cplusplus
}
#endif

#endif /* POWER_CC26XX_ */