PowerCC32XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2020, 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_PowerCC32XX__include
#define ti_drivers_power_PowerCC32XX__include

#include <stdint.h>
#include <ti/drivers/utils/List.h>
#include <ti/drivers/Power.h>

/* driverlib header files */
#include <ti/devices/cc32xx/inc/hw_types.h>
#include <ti/devices/cc32xx/driverlib/rom.h>
#include <ti/devices/cc32xx/driverlib/rom_map.h>
#include <ti/devices/cc32xx/driverlib/pin.h>

#ifdef __cplusplus
extern "C" {
#endif

/* latency values were measured with a logic analyzer, and rounded up */

#define PowerCC32XX_RESUMETIMELPDS          2500

#define PowerCC32XX_TOTALTIMELPDS           20000

#define PowerCC32XX_TOTALTIMESHUTDOWN       500000

/* Power resources */
#define PowerCC32XX_PERIPH_CAMERA       0

#define PowerCC32XX_PERIPH_I2S          1

#define PowerCC32XX_PERIPH_SDHOST       2

#define PowerCC32XX_PERIPH_GSPI         3

#define PowerCC32XX_PERIPH_LSPI         4

#define PowerCC32XX_PERIPH_UDMA         5

#define PowerCC32XX_PERIPH_GPIOA0       6

#define PowerCC32XX_PERIPH_GPIOA1       7

#define PowerCC32XX_PERIPH_GPIOA2       8

#define PowerCC32XX_PERIPH_GPIOA3       9

#define PowerCC32XX_PERIPH_GPIOA4       10

#define PowerCC32XX_PERIPH_WDT          11

#define PowerCC32XX_PERIPH_UARTA0       12

#define PowerCC32XX_PERIPH_UARTA1       13

#define PowerCC32XX_PERIPH_TIMERA0      14

#define PowerCC32XX_PERIPH_TIMERA1      15

#define PowerCC32XX_PERIPH_TIMERA2      16

#define PowerCC32XX_PERIPH_TIMERA3      17

#define PowerCC32XX_PERIPH_DTHE         18

#define PowerCC32XX_PERIPH_SSPI         19

#define PowerCC32XX_PERIPH_I2CA0        20

/* \cond */
#define PowerCC32XX_NUMRESOURCES        21 /* Number of resources in database */
/* \endcond */

/*
 *  Power constraints on the CC32XX device
 */
#define PowerCC32XX_DISALLOW_LPDS       0

#define PowerCC32XX_DISALLOW_SHUTDOWN   1

/* \cond */
#define PowerCC32XX_NUMCONSTRAINTS      2   
/* \endcond */

/*
 *  Power events on the CC32XX device
 *
 *  Each event must be a power of two, and the event IDs must be sequential
 *  without any gaps.
 */
#define PowerCC32XX_ENTERING_LPDS       0x1

#define PowerCC32XX_ENTERING_SHUTDOWN   0x2

#define PowerCC32XX_AWAKE_LPDS          0x4

/* \cond */
#define PowerCC32XX_NUMEVENTS           3    
/* \endcond */

/* Power sleep states */
#define PowerCC32XX_LPDS                0x1 
/* \cond */
/* Use by NVIC Register structure */
#define PowerCC32XX_numNVICSetEnableRegs    6
#define PowerCC32XX_numNVICIntPriority      49
/* \endcond */

/* \cond */
/* Number of pins that can be parked in LPDS */
#define PowerCC32XX_NUMPINS             34
/* \endcond */

typedef struct {
    uint32_t pin;
    uint32_t parkState;
} PowerCC32XX_ParkInfo;

typedef struct {
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;
    void (*enterLPDSHookFxn)(void);
    void (*resumeLPDSHookFxn)(void);
    bool enablePolicy;
    bool enableGPIOWakeupLPDS;
    bool enableGPIOWakeupShutdown;
    bool enableNetworkWakeupLPDS;
    uint32_t wakeupGPIOSourceLPDS;
    uint32_t wakeupGPIOTypeLPDS;
    void (*wakeupGPIOFxnLPDS)(uint_least8_t argument);
    uint_least8_t wakeupGPIOFxnLPDSArg;
    uint32_t wakeupGPIOSourceShutdown;
    uint32_t wakeupGPIOTypeShutdown;
    uint32_t ramRetentionMaskLPDS;
    bool keepDebugActiveDuringLPDS;
    uint32_t ioRetentionShutdown;
    PowerCC32XX_ParkInfo * pinParkDefs;
    uint32_t numPins;
    uint32_t latencyForLPDS;
} PowerCC32XX_ConfigV1;

typedef struct {
    uint32_t vectorTable;
    uint32_t auxCtrl;
    uint32_t intCtrlState;
    uint32_t appInt;
    uint32_t sysCtrl;
    uint32_t configCtrl;
    uint32_t sysPri1;
    uint32_t sysPri2;
    uint32_t sysPri3;
    uint32_t sysHcrs;
    uint32_t systickCtrl;
    uint32_t systickReload;
    uint32_t systickCalib;
    uint32_t intSetEn[PowerCC32XX_numNVICSetEnableRegs];
    uint32_t intPriority[PowerCC32XX_numNVICIntPriority];
} PowerCC32XX_NVICRegisters;
typedef struct {
    uint32_t msp;
    uint32_t psp;
    uint32_t psr;
    uint32_t primask;
    uint32_t faultmask;
    uint32_t basepri;
    uint32_t control;
} PowerCC32XX_MCURegisters;
typedef struct {
    PowerCC32XX_MCURegisters m4Regs;
    PowerCC32XX_NVICRegisters nvicRegs;
} PowerCC32XX_SaveRegisters;
typedef enum {
    PowerCC32XX_NO_PULL_HIZ = PIN_TYPE_STD,
    PowerCC32XX_WEAK_PULL_UP_STD = PIN_TYPE_STD_PU,
    PowerCC32XX_WEAK_PULL_DOWN_STD = PIN_TYPE_STD_PD,
    PowerCC32XX_WEAK_PULL_UP_OPENDRAIN = PIN_TYPE_OD_PU,
    PowerCC32XX_WEAK_PULL_DOWN_OPENDRAIN = PIN_TYPE_OD_PD,
    PowerCC32XX_DRIVE_LOW,
    PowerCC32XX_DRIVE_HIGH,
    PowerCC32XX_DONT_PARK
} PowerCC32XX_ParkState;

typedef enum {
    PowerCC32XX_PIN01 = PIN_01,
    PowerCC32XX_PIN02 = PIN_02,
    PowerCC32XX_PIN03 = PIN_03,
    PowerCC32XX_PIN04 = PIN_04,
    PowerCC32XX_PIN05 = PIN_05,
    PowerCC32XX_PIN06 = PIN_06,
    PowerCC32XX_PIN07 = PIN_07,
    PowerCC32XX_PIN08 = PIN_08,
    PowerCC32XX_PIN11 = PIN_11,
    PowerCC32XX_PIN12 = PIN_12,
    PowerCC32XX_PIN13 = PIN_13,
    PowerCC32XX_PIN14 = PIN_14,
    PowerCC32XX_PIN15 = PIN_15,
    PowerCC32XX_PIN16 = PIN_16,
    PowerCC32XX_PIN17 = PIN_17,
    PowerCC32XX_PIN18 = PIN_18,
    PowerCC32XX_PIN19 = PIN_19,
    PowerCC32XX_PIN20 = PIN_20,
    PowerCC32XX_PIN21 = PIN_21,
    PowerCC32XX_PIN29 = 0x1C,
    PowerCC32XX_PIN30 = 0x1D,
    PowerCC32XX_PIN45 = PIN_45,
    PowerCC32XX_PIN50 = PIN_50,
    PowerCC32XX_PIN52 = PIN_52,
    PowerCC32XX_PIN53 = PIN_53,
    PowerCC32XX_PIN55 = PIN_55,
    PowerCC32XX_PIN57 = PIN_57,
    PowerCC32XX_PIN58 = PIN_58,
    PowerCC32XX_PIN59 = PIN_59,
    PowerCC32XX_PIN60 = PIN_60,
    PowerCC32XX_PIN61 = PIN_61,
    PowerCC32XX_PIN62 = PIN_62,
    PowerCC32XX_PIN63 = PIN_63,
    PowerCC32XX_PIN64 = PIN_64
} PowerCC32XX_Pin;

typedef struct {
    bool enableGPIOWakeupLPDS;
    bool enableGPIOWakeupShutdown;
    bool enableNetworkWakeupLPDS;
    uint32_t wakeupGPIOSourceLPDS;
    uint32_t wakeupGPIOTypeLPDS;
    void (*wakeupGPIOFxnLPDS)(uint_least8_t argument);
    uint_least8_t wakeupGPIOFxnLPDSArg;
    uint32_t wakeupGPIOSourceShutdown;
    uint32_t wakeupGPIOTypeShutdown;
} PowerCC32XX_Wakeup;

typedef struct {
    List_List notifyList;
    uint32_t constraintMask;
    uint32_t state;
    uint16_t dbRecords[PowerCC32XX_NUMRESOURCES];
    bool enablePolicy;
    bool initialized;
    uint8_t refCount[PowerCC32XX_NUMRESOURCES];
    uint8_t constraintCounts[PowerCC32XX_NUMCONSTRAINTS];
    Power_PolicyFxn policyFxn;
    uint32_t pinType[PowerCC32XX_NUMPINS];
    uint16_t pinDir[PowerCC32XX_NUMPINS];
    uint8_t pinMode[PowerCC32XX_NUMPINS];
    uint16_t stateAntPin29;
    uint16_t stateAntPin30;
    uint32_t pinLockMask;
    PowerCC32XX_Wakeup wakeupConfig;
} PowerCC32XX_ModuleState;
void PowerCC32XX_configureWakeup(PowerCC32XX_Wakeup *wakeup);

void PowerCC32XX_initPolicy(void);

void PowerCC32XX_getWakeup(PowerCC32XX_Wakeup *wakeup);

PowerCC32XX_ParkState PowerCC32XX_getParkState(PowerCC32XX_Pin pin);

void PowerCC32XX_restoreParkState(PowerCC32XX_Pin pin,
    PowerCC32XX_ParkState state);

void PowerCC32XX_setParkState(PowerCC32XX_Pin pin, uint32_t level);

void PowerCC32XX_disableIORetention(unsigned long groupFlags);

void PowerCC32XX_sleepPolicy(void);

 int_fast16_t PowerCC32XX_reset(uint_fast16_t resourceId);

/* \cond */
#define Power_getPerformanceLevel(void)   0
#define Power_setPerformanceLevel(level)  Power_EFAIL
/* \endcond */

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_power_PowerCC32XX__include */