PowerCC3200.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, 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_PowerCC3200__include
#define ti_drivers_power_PowerCC3200__include

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

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

#ifdef __cplusplus
extern "C" {
#endif

/* values were gathered from a logic analyzer and rounded up */
#define PowerCC3200_RESUMETIMELPDS          2500

#define PowerCC3200_TOTALTIMELPDS           20000

#define PowerCC3200_TOTALTIMESHUTDOWN       500000

/* Power resources */
#define PowerCC3200_PERIPH_CAMERA       0
#define PowerCC3200_PERIPH_I2S          1
#define PowerCC3200_PERIPH_SDHOST       2
#define PowerCC3200_PERIPH_GSPI         3
#define PowerCC3200_PERIPH_LSPI         4
#define PowerCC3200_PERIPH_UDMA         5
#define PowerCC3200_PERIPH_GPIOA0       6
#define PowerCC3200_PERIPH_GPIOA1       7
#define PowerCC3200_PERIPH_GPIOA2       8
#define PowerCC3200_PERIPH_GPIOA3       9
#define PowerCC3200_PERIPH_GPIOA4       10
#define PowerCC3200_PERIPH_WDT          11
#define PowerCC3200_PERIPH_UARTA0       12
#define PowerCC3200_PERIPH_UARTA1       13
#define PowerCC3200_PERIPH_TIMERA0      14
#define PowerCC3200_PERIPH_TIMERA1      15
#define PowerCC3200_PERIPH_TIMERA2      16
#define PowerCC3200_PERIPH_TIMERA3      17
#define PowerCC3200_PERIPH_DTHE         18
#define PowerCC3200_PERIPH_SSPI         19
#define PowerCC3200_PERIPH_I2CA0        20
#define PowerCC3200_NUMRESOURCES        21

/*
 *  Power constraints on the CC3200 device
 */
#define PowerCC3200_DISALLOW_LPDS       0   
#define PowerCC3200_DISALLOW_SHUTDOWN   1   
#define PowerCC3200_NUMCONSTRAINTS      2   
/*
 *  Power events on the CC3200 device
 *
 *  Each event must be a power of two and must be sequential
 *  without any gaps.
 */
#define PowerCC3200_ENTERING_LPDS       0x1  
#define PowerCC3200_ENTERING_SHUTDOWN   0x2  
#define PowerCC3200_AWAKE_LPDS          0x4  
#define PowerCC3200_NUMEVENTS           3    
/* Power sleep states */
#define PowerCC3200_LPDS                0x1 
/* Use by NVIC Register structure */
#define PowerCC3200_numNVICSetEnableRegs    6
#define PowerCC3200_numNVICIntPriority      49

/* Number of pins that can be parked in LPDS */
#define PowerCC3200_NUMPINS             34

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

typedef struct PowerCC3200_ConfigV1 {
    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)(unsigned int argument);
    unsigned int wakeupGPIOFxnLPDSArg;
    uint32_t wakeupGPIOSourceShutdown;
    uint32_t wakeupGPIOTypeShutdown;
    uint32_t ramRetentionMaskLPDS;
    bool keepDebugActiveDuringLPDS;
    uint32_t ioRetentionShutdown;
    PowerCC3200_ParkInfo * pinParkDefs;
    uint32_t numPins;
} PowerCC3200_ConfigV1;

typedef struct PowerCC3200_ModuleState {
    List_List notifyList;
    uint32_t constraintMask;
    uint32_t state;
    uint16_t dbRecords[PowerCC3200_NUMRESOURCES];
    bool enablePolicy;
    bool initialized;
    uint8_t refCount[PowerCC3200_NUMRESOURCES];
    uint8_t constraintCounts[PowerCC3200_NUMCONSTRAINTS];
    Power_PolicyFxn policyFxn;
    uint32_t pinType[PowerCC3200_NUMPINS];
    uint16_t pinDir[PowerCC3200_NUMPINS];
    uint8_t pinMode[PowerCC3200_NUMPINS];
    uint16_t stateAntPin29;
    uint16_t stateAntPin30;
    uint32_t pinLockMask;
    void (*wakeupGPIOFxnLPDS)(unsigned int);
    unsigned int wakeupGPIOFxnLPDSArg;
} PowerCC3200_ModuleState;

typedef struct PowerCC3200_NVICRegisters {
    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[PowerCC3200_numNVICSetEnableRegs];
    uint32_t intPriority[PowerCC3200_numNVICIntPriority];
} PowerCC3200_NVICRegisters;

typedef struct PowerCC3200_MCURegisters {
    uint32_t msp;
    uint32_t psp;
    uint32_t psr;
    uint32_t primask;
    uint32_t faultmask;
    uint32_t basepri;
    uint32_t control;
} PowerCC3200_MCURegisters;

typedef struct PowerCC3200_SaveRegisters {
    PowerCC3200_MCURegisters m4Regs;
    PowerCC3200_NVICRegisters nvicRegs;
} PowerCC3200_SaveRegisters;

typedef enum {
    PowerCC3200_NO_PULL_HIZ = PIN_TYPE_STD,
    PowerCC3200_WEAK_PULL_UP_STD = PIN_TYPE_STD_PU,
    PowerCC3200_WEAK_PULL_DOWN_STD = PIN_TYPE_STD_PD,
    PowerCC3200_WEAK_PULL_UP_OPENDRAIN = PIN_TYPE_OD_PU,
    PowerCC3200_WEAK_PULL_DOWN_OPENDRAIN = PIN_TYPE_OD_PD,
    PowerCC3200_DRIVE_LOW,
    PowerCC3200_DRIVE_HIGH,
    PowerCC3200_DONT_PARK
} PowerCC3200_ParkState;

typedef enum {
    PowerCC3200_PIN01 = PIN_01,
    PowerCC3200_PIN02 = PIN_02,
    PowerCC3200_PIN03 = PIN_03,
    PowerCC3200_PIN04 = PIN_04,
    PowerCC3200_PIN05 = PIN_05,
    PowerCC3200_PIN06 = PIN_06,
    PowerCC3200_PIN07 = PIN_07,
    PowerCC3200_PIN08 = PIN_08,
    PowerCC3200_PIN11 = PIN_11,
    PowerCC3200_PIN12 = PIN_12,
    PowerCC3200_PIN13 = PIN_13,
    PowerCC3200_PIN14 = PIN_14,
    PowerCC3200_PIN15 = PIN_15,
    PowerCC3200_PIN16 = PIN_16,
    PowerCC3200_PIN17 = PIN_17,
    PowerCC3200_PIN18 = PIN_18,
    PowerCC3200_PIN19 = PIN_19,
    PowerCC3200_PIN20 = PIN_20,
    PowerCC3200_PIN21 = PIN_21,
    PowerCC3200_PIN29 = 0x1C,
    PowerCC3200_PIN30 = 0x1D,
    PowerCC3200_PIN45 = PIN_45,
    PowerCC3200_PIN50 = PIN_50,
    PowerCC3200_PIN52 = PIN_52,
    PowerCC3200_PIN53 = PIN_53,
    PowerCC3200_PIN55 = PIN_55,
    PowerCC3200_PIN57 = PIN_57,
    PowerCC3200_PIN58 = PIN_58,
    PowerCC3200_PIN59 = PIN_59,
    PowerCC3200_PIN60 = PIN_60,
    PowerCC3200_PIN61 = PIN_61,
    PowerCC3200_PIN62 = PIN_62,
    PowerCC3200_PIN63 = PIN_63,
    PowerCC3200_PIN64 = PIN_64
} PowerCC3200_Pin;

typedef struct PowerCC3200_Wakeup {
    bool enableGPIOWakeupLPDS;
    bool enableGPIOWakeupShutdown;
    bool enableNetworkWakeupLPDS;
    uint32_t wakeupGPIOSourceLPDS;
    uint32_t wakeupGPIOTypeLPDS;
    void (*wakeupGPIOFxnLPDS)();
    unsigned int wakeupGPIOFxnLPDSArg;
    uint32_t wakeupGPIOSourceShutdown;
    uint32_t wakeupGPIOTypeShutdown;
} PowerCC3200_Wakeup;

void PowerCC3200_configureWakeup(PowerCC3200_Wakeup *wakeup);

void PowerCC3200_initPolicy(void);

void PowerCC3200_setParkState(PowerCC3200_Pin pin, uint32_t level);

void PowerCC3200_disableIORetention(unsigned long groupFlags);

void PowerCC3200_sleepPolicy(void);

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

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_power_PowerCC3200__include */