Detailed Description

Power global configuration.

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	enableGPIOSyncIOWakeupLPDS

bool	enableSleepCounterWakeupLPDS

bool	enableUARTWakeupLPDS

bool	enableSPICSWakeupLPDS

bool	enableRTCWakeupLPDS

bool	enableFRCWakeupLPDS

Power_GPIO_SYNCIO_Wakeup_Enable	selectGpioSyncIOLpds

uint32_t	wakeupGPIOPadLPDS
	The GPIO source for wakeup from LPDS. More...

uint32_t	wakeupGPIOEdgeLPDS
	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	wakeupSyncIOPadLPDS
	The GPIO source for wakeup from LPDS. More...

uint32_t	wakeupSyncIOEdgeLPDS
	The GPIO trigger type for wakeup from LPDS. More...

uint32_t	ramRetentionMaskLPDS
	SRAM retention mask for LPDS. More...

bool	keepDebugActiveDuringLPDS
	Keep debug interface active during LPDS. More...

Power_ParkInfo *	pinParkDefs
	Pointer to an array of pins to be parked during LPDS. More...

uint32_t	numPins
	Number of pins to be parked during LPDS. More...

uint32_t	totalLatencyForLPDS
	Latency to reserve for entry to and exit from LPDS, in microseconds. More...

uint32_t	resumeLatencyForLPDS

uint32_t	totalLatencyForSleep

uint32_t	resumeLatencyForSleep

uint32_t	totalLatencyForIdle

uint32_t	resumeLatencyForIdle

Field Documentation

◆ policyInitFxn

Power_PolicyInitFxn Power_ConfigV1::policyInitFxn

Initialization function for the power policy

◆ policyFxn

Power_PolicyFxn Power_ConfigV1::policyFxn

The power policy function

◆ enterLPDSHookFxn

void(* Power_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(* Power_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 Power_ConfigV1::enablePolicy

Determines whether to run the power policy function

◆ enableGPIOSyncIOWakeupLPDS

bool Power_ConfigV1::enableGPIOSyncIOWakeupLPDS

◆ enableSleepCounterWakeupLPDS

bool Power_ConfigV1::enableSleepCounterWakeupLPDS

Enable sleep counter as a wakeup source for LPDS

◆ enableUARTWakeupLPDS

bool Power_ConfigV1::enableUARTWakeupLPDS

Enable UART activity as a wakeup source for LPDS

◆ enableSPICSWakeupLPDS

bool Power_ConfigV1::enableSPICSWakeupLPDS

Enable SPI chip select as a wakeup source for LPDS

◆ enableRTCWakeupLPDS

bool Power_ConfigV1::enableRTCWakeupLPDS

Enable RTC as a wakeup source for LPDS

◆ enableFRCWakeupLPDS

bool Power_ConfigV1::enableFRCWakeupLPDS

Enable FRC as a wakeup source for LPDS

◆ selectGpioSyncIOLpds

Power_GPIO_SYNCIO_Wakeup_Enable Power_ConfigV1::selectGpioSyncIOLpds

◆ wakeupGPIOPadLPDS

uint32_t Power_ConfigV1::wakeupGPIOPadLPDS

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

◆ wakeupGPIOEdgeLPDS

uint32_t Power_ConfigV1::wakeupGPIOEdgeLPDS

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(* Power_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 Power_ConfigV1::wakeupGPIOFxnLPDSArg

The argument to be passed to wakeupGPIOFxnLPDS()

◆ wakeupSyncIOPadLPDS

uint32_t Power_ConfigV1::wakeupSyncIOPadLPDS

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

◆ wakeupSyncIOEdgeLPDS

uint32_t Power_ConfigV1::wakeupSyncIOEdgeLPDS

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

◆ ramRetentionMaskLPDS

uint32_t Power_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 Power_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.

◆ pinParkDefs

Power_ParkInfo* Power_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 Power_ConfigV1::numPins

Number of pins to be parked during LPDS.

◆ totalLatencyForLPDS

uint32_t Power_ConfigV1::totalLatencyForLPDS

Latency to reserve for entry to and exit from LPDS, in microseconds.

This value is used by the power policy when determining whether to enter LPDS, versus a lighter sleep state with a lower latency.

◆ resumeLatencyForLPDS

uint32_t Power_ConfigV1::resumeLatencyForLPDS

◆ totalLatencyForSleep

uint32_t Power_ConfigV1::totalLatencyForSleep

◆ resumeLatencyForSleep

uint32_t Power_ConfigV1::resumeLatencyForSleep

◆ totalLatencyForIdle

uint32_t Power_ConfigV1::totalLatencyForIdle

◆ resumeLatencyForIdle

uint32_t Power_ConfigV1::resumeLatencyForIdle