Data Fields
PowerCC32XX_ConfigV1 Struct Reference

Power global configuration. More...

#include <PowerCC32XX.h>

Collaboration diagram for PowerCC32XX_ConfigV1:
Collaboration graph
[legend]

Data Fields

Power_PolicyInitFxn policyInitFxn
 
Power_PolicyFxn policyFxn
 
void(* enterLPDSHookFxn )(void)
 Hook function called before entering LPDS. More...
 
void(* resumeLPDSHookFxn )(void)
 Hook function called when resuming from LPDS. More...
 
bool enablePolicy
 
bool enableGPIOWakeupLPDS
 
bool enableGPIOWakeupShutdown
 
bool enableNetworkWakeupLPDS
 
uint32_t wakeupGPIOSourceLPDS
 The GPIO source for wakeup from LPDS. More...
 
uint32_t wakeupGPIOTypeLPDS
 The GPIO trigger type for wakeup from LPDS. More...
 
void(* wakeupGPIOFxnLPDS )(uint_least8_t argument)
 Function to be called when the configured GPIO triggers wakeup from LPDS. More...
 
uint_least8_t wakeupGPIOFxnLPDSArg
 The argument to be passed to wakeupGPIOFxnLPDS() More...
 
uint32_t wakeupGPIOSourceShutdown
 The GPIO sources for wakeup from shutdown. More...
 
uint32_t wakeupGPIOTypeShutdown
 The GPIO trigger type for wakeup from shutdown. More...
 
uint32_t ramRetentionMaskLPDS
 SRAM retention mask for LPDS. More...
 
bool keepDebugActiveDuringLPDS
 Keep debug interface active during LPDS. More...
 
uint32_t ioRetentionShutdown
 IO retention mask for Shutdown. More...
 
PowerCC32XX_ParkInfopinParkDefs
 Pointer to an array of pins to be parked during LPDS. More...
 
uint32_t numPins
 Number of pins to be parked during LPDS. More...
 

Detailed Description

Power global configuration.

Field Documentation

§ policyInitFxn

Power_PolicyInitFxn PowerCC32XX_ConfigV1::policyInitFxn

Initialization function for the power policy

§ policyFxn

Power_PolicyFxn PowerCC32XX_ConfigV1::policyFxn

The power policy function

§ enterLPDSHookFxn

void(* PowerCC32XX_ConfigV1::enterLPDSHookFxn) (void)

Hook function called before entering LPDS.

This function is called after any notifications are complete, and before any pins are parked, just before entry to LPDS.

§ resumeLPDSHookFxn

void(* PowerCC32XX_ConfigV1::resumeLPDSHookFxn) (void)

Hook function called when resuming from LPDS.

This function is called early in the wake sequence, before any notification functions are run.

§ enablePolicy

bool PowerCC32XX_ConfigV1::enablePolicy

Determines whether to run the power policy function

§ enableGPIOWakeupLPDS

bool PowerCC32XX_ConfigV1::enableGPIOWakeupLPDS

Enable GPIO as a wakeup source for LPDS

§ enableGPIOWakeupShutdown

bool PowerCC32XX_ConfigV1::enableGPIOWakeupShutdown

Enable GPIO as a wakeup source for shutdown

§ enableNetworkWakeupLPDS

bool PowerCC32XX_ConfigV1::enableNetworkWakeupLPDS

Enable Network activity as a wakeup source for LPDS

§ wakeupGPIOSourceLPDS

uint32_t PowerCC32XX_ConfigV1::wakeupGPIOSourceLPDS

The GPIO source for wakeup from LPDS.

Only one GPIO {2,4,11,13,17,24,26} can be specified as a wake source for LPDS. The GPIO must be specified as one of the following (as defined in driverlib/prcm.h): PRCM_LPDS_GPIO2, PRCM_LPDS_GPIO4, PRCM_LPDS_GPIO11, PRCM_LPDS_GPIO13, PRCM_LPDS_GPIO17, PRCM_LPDS_GPIO24, PRCM_LPDS_GPIO26

§ wakeupGPIOTypeLPDS

uint32_t PowerCC32XX_ConfigV1::wakeupGPIOTypeLPDS

The GPIO trigger type for wakeup from LPDS.

Value can be one of the following (defined in driverlib/prcm.h): PRCM_LPDS_LOW_LEVEL, PRCM_LPDS_HIGH_LEVEL, PRCM_LPDS_FALL_EDGE, PRCM_LPDS_RISE_EDGE

§ wakeupGPIOFxnLPDS

void(* PowerCC32XX_ConfigV1::wakeupGPIOFxnLPDS) (uint_least8_t argument)

Function to be called when the configured GPIO triggers wakeup from LPDS.

During LPDS the internal GPIO module is powered off, and special periphery logic is used instead to detect the trigger and wake the device. No GPIO interrupt service routine will be triggered in this case (even if an ISR is configured, and used normally to detect GPIO interrupts when not in LPDS). This function can be used in lieu of a GPIO ISR, to take specific action upon LPDS wakeup.

A value of NULL indicates no GPIO wakeup function will be called.

An argument for this wakeup function can be specified via wakeupGPIOFxnLPDSArg.

Note
This wakeup function will be called as one of the last steps in Power_sleep(), after all notifications have been sent out, and after pins have been restored to their previous (non-parked) states.

§ wakeupGPIOFxnLPDSArg

uint_least8_t PowerCC32XX_ConfigV1::wakeupGPIOFxnLPDSArg

The argument to be passed to wakeupGPIOFxnLPDS()

§ wakeupGPIOSourceShutdown

uint32_t PowerCC32XX_ConfigV1::wakeupGPIOSourceShutdown

The GPIO sources for wakeup from shutdown.

Only one GPIO {2,4,11,13,17,24,26} can be specified as a wake source for Shutdown. The GPIO must be specified as one of the following (as defined in driverlib/prcm.h): PRCM_HIB_GPIO2, PRCM_HIB_GPIO4, PRCM_HIB_GPIO11, PRCM_HIB_GPIO13, PRCM_HIB_GPIO17, PRCM_HIB_GPIO24, PRCM_HIB_GPIO26

§ wakeupGPIOTypeShutdown

uint32_t PowerCC32XX_ConfigV1::wakeupGPIOTypeShutdown

The GPIO trigger type for wakeup from shutdown.

Value can be one of the following (defined in driverlib/prcm.h): PRCM_HIB_LOW_LEVEL, PRCM_HIB_HIGH_LEVEL, PRCM_HIB_FALL_EDGE, PRCM_HIB_RISE_EDGE

§ ramRetentionMaskLPDS

uint32_t PowerCC32XX_ConfigV1::ramRetentionMaskLPDS

SRAM retention mask for LPDS.

Value can be a mask of the following (defined in driverlib/prcm.h): PRCM_SRAM_COL_1, PRCM_SRAM_COL_2, PRCM_SRAM_COL_3, PRCM_SRAM_COL_4

§ keepDebugActiveDuringLPDS

bool PowerCC32XX_ConfigV1::keepDebugActiveDuringLPDS

Keep debug interface active during LPDS.

This Boolean controls whether the debug interface will be left active when LPDS is entered. For best power savings this flag should be set to false. Setting the flag to true will enable better debug capability, but will prevent full LPDS, and will result in increased power consumption.

§ ioRetentionShutdown

uint32_t PowerCC32XX_ConfigV1::ioRetentionShutdown

IO retention mask for Shutdown.

Value can be a mask of the following (defined in driverlib/prcm.h): PRCM_IO_RET_GRP_0, PRCM_IO_RET_GRP_1, PRCM_IO_RET_GRP_2 PRCM_IO_RET_GRP_3

§ pinParkDefs

PowerCC32XX_ParkInfo* PowerCC32XX_ConfigV1::pinParkDefs

Pointer to an array of pins to be parked during LPDS.

A value of NULL will disable parking of any pins during LPDS

§ numPins

uint32_t PowerCC32XX_ConfigV1::numPins

Number of pins to be parked during LPDS.


The documentation for this struct was generated from the following file:
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale