|
|
Power global configuration (MSP432-specific) More...
#include <PowerMSP432.h>
Data Fields | |
| Power_PolicyInitFxn | policyInitFxn |
| The Power Policy's initialization function. More... | |
| Power_PolicyFxn | policyFxn |
| The Power Policy function. More... | |
| unsigned int | initialPerfLevel |
| The initial performance level to be established during Power Manager initialization. More... | |
| bool | enablePolicy |
| Boolean specifying if the Power Policy function is enabled. More... | |
| bool | enablePerf |
| Boolean specifying if performance scaling is enabled. More... | |
| bool | enableParking |
| Boolean specifying if pull resistors should be automatically applied to input pins during PowerMSP432_DEEPSLEEP_0 and PowerMSP432_DEEPSLEEP_1. More... | |
| void(* | resumeShutdownHookFxn )(void) |
| Hook function called when resuming from a SHUTDOWN state. More... | |
| PowerMSP432_PerfLevel * | customPerfLevels |
| Pointer to an optional array of custom performance levels. More... | |
| uint32_t | numCustom |
| Number of custom performance levels. More... | |
| bool | useExtendedPerf |
| Boolean specifying if extended performance scaling features are to be supported. More... | |
| unsigned int | HFXTFREQ |
| The high frequency crystal (HFXT) frequency. More... | |
| unsigned int | LFXTDRIVE |
| The low frequency crystal (LFXT) drive level. More... | |
| bool | configurePinHFXT |
| Boolean specifying if the HFXT pin should be configured for HFXT function. More... | |
| bool | bypassHFXT |
| Boolean specifying if the HFXT pin should be configured for HFXT bypass. More... | |
| bool | configurePinLFXT |
| Boolean specifying if the LFXT pin should be configured for LFXT function. More... | |
| bool | bypassLFXT |
| Boolean specifying if the LFXT pin should be configured for LFXT bypass. More... | |
| bool | enableInterruptsCS |
| Boolean specifying if interrupts from the Clock System (CS) should be enabled for catching clock and oscillator fault conditions. More... | |
| unsigned int | priorityInterruptsCS |
| The interrupt priority to be configured for CS interrupts. More... | |
| void(* | isrCS )(void) |
| The application-provided interrupt service routine that should be configured for handling CS interrupts. More... | |
Power global configuration (MSP432-specific)
| Power_PolicyInitFxn PowerMSP432_ConfigV1::policyInitFxn |
The Power Policy's initialization function.
If the policy does not have an initialization function, 'NULL' should be specified.
| Power_PolicyFxn PowerMSP432_ConfigV1::policyFxn |
The Power Policy function.
When enabled, this function is invoked in the idle loop, to opportunistically select and activate sleep states.
Two reference policies are provided:
PowerMSP432_sleepPolicy() - a simple policy that will put the device in either the PowerMSP432_SLEEP state (unless there is a constraint prohibiting this), or CPU wait for interrupt (WFI)
PowerMSP432_deepSleepPolicy() - a more agressive policy that checks constraints and optionally chooses PowerMSP432_DEEPSLEEP_1, PowerMSP432_DEEPSLEEP_0, PowerMSP432_SLEEP, or WFI, in that order of preference.
Custom policies can be written, and specified via this function pointer.
In addition to this static selection, the Power Policy can be dynamically changed at runtime, via the Power_setPolicy() API.
| unsigned int PowerMSP432_ConfigV1::initialPerfLevel |
The initial performance level to be established during Power Manager initialization.
The performance level is identified by a numeric index into the table of available performance levels.
This performance level will be activated during initialization only when performance scaling is enabled (below, via specification of enablePerf).
| bool PowerMSP432_ConfigV1::enablePolicy |
Boolean specifying if the Power Policy function is enabled.
If 'true', the policy function will be invoked once for each pass of the idle loop.
If 'false', the policy will not be invoked.
In addition to this static setting, the Power Policy can be dynamically enabled and disabled at runtime, via the Power_enablePolicy() and Power_disablePolicy() functions, respectively.
| bool PowerMSP432_ConfigV1::enablePerf |
Boolean specifying if performance scaling is enabled.
If 'true', the performance scaling feature will be enabled for the application. And, the initial performance level (specified above, via initialPerfLevel) will be established during Power Manager initialization.
If 'false', performance scaling is disabled for the application.
| bool PowerMSP432_ConfigV1::enableParking |
Boolean specifying if pull resistors should be automatically applied to input pins during PowerMSP432_DEEPSLEEP_0 and PowerMSP432_DEEPSLEEP_1.
Leaving an input pin floating during a device deepsleep state will result in an increase in power consumption. The Power Manager provides an option to automatically apply pull resistors to input pins during deepsleep, so that none are left floating. The type of pull (pull-up or pull-down) is determined by the current state sensed for each input pin, as the device is transitioning into deepsleep. This feature is referred to as 'automatic pin parking', and is enabled with this enableParking configuration parameter.
If 'true', before completing a transition into deepsleep, pull resistors will be applied to all pins configured as input, with General Purpose I/O (GPIO) function (as configured in the PxSEL1 and PxSEL0 registers). On wake from deepsleep, the pull resistor settings will be restored to those in effect prior to deepsleep.
If 'false', pull resistors will not be automatically applied during deepsleep states.
As an example, consider a pin that is connected via a debounced button switch to ground. An internal pull-up resistor is used versus an external pull-up resistor. The GPIO.h driver is used to manage this pin, with the following entry in the pin configuration array:
If GPIO_CFG_IN_INT_RISING were selected, in certain situations there may be a problem with this pin being able to trigger a wakeup from deepsleep. For example, consider the case where there is an additional mechanism to wake the device from deepsleep, for example, the watchdog timer is programmed in interval timer mode, to periodically wake the device every 250ms. If the button is not pressed, when the device goes to deepsleep the pin state is sensed as high, and a pull-up resistor is automatically applied by the Power driver. At some point the button is pressed, and the pin is pulled to ground. But since "RISING" edge was configured for the interrupt, the interrupt request has not yet been sent to the CPU. Now, while the button is still low, the interval timer wakes the device, the necessary work is done, the power policy runs in the idle loop again, and puts the device back to deepsleep. On this transition to deepsleep, the auto pin parking code runs again, but this time the button pin level is sensed as low (since the button is depressed); so this time, a pull-down resistor is applied to the pin. The device goes to deepsleep, and then eventually the button is released... but the pin is still held low by the internal pull-down resistor, so no rising edge occurs, no interrupt is signalled to the CPU, and the device stays in deesleep.
The above is a hypothetical example, but illustrates the importance of selecting the appropriate interrupt trigger configuration for GPIO pins when auto pin parking is enabled. If a pin is being driven by an external circuit (versus floating with weak pull resistors as in the above example), as long as the external circuit can sufficiently drive the pin to counteract the weak pull resistor, there won't be a similar issue.
| void(* PowerMSP432_ConfigV1::resumeShutdownHookFxn) (void) |
Hook function called when resuming from a SHUTDOWN state.
This function is called when the device wakes and resumes from a previous entry into either the SHUTDOWN_0 or SHUTDOWN_1 states. If this function is defined (i.e., this pointer is not NULL), it will be called during Power_init(), right before the Power driver clears the LOCKLPM5 and LOCKBKUP bits in the PMCTL1 register, to unlock I/Os and the backup domain.
| PowerMSP432_PerfLevel* PowerMSP432_ConfigV1::customPerfLevels |
Pointer to an optional array of custom performance levels.
A value of NULL indicates no custom performance levels are defined
| uint32_t PowerMSP432_ConfigV1::numCustom |
Number of custom performance levels.
| bool PowerMSP432_ConfigV1::useExtendedPerf |
Boolean specifying if extended performance scaling features are to be supported.
If 'true', the following configuration parameters for crystal oscillator support are enabled.
If 'false', the extended configuration parameters are not suppored.
This Boolean is used to maintain backwards compatibility with previous releases. Older board files won't include the extended configuration parameters, and by default, crystal oscillators won't be supported in those applications. New board files can include the extended configuration parameters, and by including and setting this Boolean to true, the extended support with crystals will be enabled.
| unsigned int PowerMSP432_ConfigV1::HFXTFREQ |
The high frequency crystal (HFXT) frequency.
The source is specified via an enumerated value from cs.h, for example: CS_48MHZ, CS_24MHZ, etc.
| unsigned int PowerMSP432_ConfigV1::LFXTDRIVE |
The low frequency crystal (LFXT) drive level.
The source is specified via an enumerated value from cs.h, for example: CS_LFXT_DRIVE3, CS_LFXT_DRIVE2, etc.
| bool PowerMSP432_ConfigV1::configurePinHFXT |
Boolean specifying if the HFXT pin should be configured for HFXT function.
If 'true', the HFXT pin will be configured for HFXT function.
If 'false', the pin will not be configured.
| bool PowerMSP432_ConfigV1::bypassHFXT |
Boolean specifying if the HFXT pin should be configured for HFXT bypass.
If 'true', the HFXT pin will be configured for HFXT bypass.
If 'false', the pin will not be configured for HFXT bypass.
| bool PowerMSP432_ConfigV1::configurePinLFXT |
Boolean specifying if the LFXT pin should be configured for LFXT function.
If 'true', the LFXT pin will be configured for LFXT function.
If 'false', the pin will not be configured.
| bool PowerMSP432_ConfigV1::bypassLFXT |
Boolean specifying if the LFXT pin should be configured for LFXT bypass.
If 'true', the LFXT pin will be configured for LFXT bypass.
If 'false', the pin will not be configured for LFXT bypass.
| bool PowerMSP432_ConfigV1::enableInterruptsCS |
Boolean specifying if interrupts from the Clock System (CS) should be enabled for catching clock and oscillator fault conditions.
If 'true', an application-provided interrupt service routine will be configured for catching CS interrupts.
If 'false', interrupts from the CS will not be enabled.
When a performance level is activated that uses HFXT and/or LFXT, and this Boolean is true, the corresponding interrupt sources (HFXTIE and/or LFXTIE) will be enabled at the CS. If HFXT and/or LFXT are later disabled, the corresponding interrupt sources will likewise be disabled.
| unsigned int PowerMSP432_ConfigV1::priorityInterruptsCS |
The interrupt priority to be configured for CS interrupts.
| void(* PowerMSP432_ConfigV1::isrCS) (void) |
The application-provided interrupt service routine that should be configured for handling CS interrupts.