AVR SD Safety Framework 1.0.0
Loading...
Searching...
No Matches
midware_power_manager.h File Reference

Contains API prototypes for the Power Manager. More...

#include <stdbool.h>
#include <define_error_flags.h>
#include <xc.h>

Enumerations

enum  vlmThreshold_t
 Type defines for available Voltage Level Monitor (VLM) threshold levels. More...
enum  vlmTrigger_t
 Type defines for available Voltage Level Monitor (VLM) trigger configurations. More...
enum  sleepMode_t
 Type defines for available sleep modes. More...

Functions

errFlag_t MW_GetClearVlmError (void)
 Reads and clears the flag indicating a supply voltage trigger error detected by the Voltage Level Monitor in the Brown-out Detector (BOD).
errFlag_t MW_GetClearVmonOverError (void)
 Reads and clears the flag indicating an overvoltage error detected by the Voltage Monitor.
errFlag_t MW_GetClearVmonUnderError (void)
 Reads and clears the flag indicating an undervoltage error detected by the Voltage Monitor.
errFlag_t MW_GetClearVmonDiagEntryError (void)
 Reads and clears the flag indicating a Diagnostic Mode entry error in the Voltage Monitor.
errFlag_t MW_GetClearVmonDiagExitError (void)
 Reads and clears the flag indicating a Diagnostic Mode exit error in the Voltage Monitor.
errFlag_t MW_GetClearVmonInternalError (void)
 Reads and clears the flag indicating internal error in the Voltage Monitor.
errFlag_t MW_GetClearVmonSleepEntryError (void)
 Reads and clears the flag indicating a sleep mode entry error in the Voltage Monitor.
errFlag_t MW_GetClearVmonDisabledError (void)
 Reads and clears the flag indicating a disabled Voltage Monitor error.
errFlag_t MW_GetClearSleepError (void)
 Reads and clears the flag indicating a Sleep Aborted error in the Sleep Controller.
void MW_EnablePowerInterrupts (void)
 Enables power related interrupts, including VMON, VLM and sleep error related interrupts.
errFlag_t MW_ConfigVlm (vlmThreshold_t threshold, vlmTrigger_t trigger)
 Configures the Voltage Level Monitor (VLM) with the provided voltage threshold and trigger condition.
void MW_SetVmonSleep (bool enableInSleep, bool useFullPowerMode)
 Configures Voltage Monitor (VMON) operation during Standby or Power-Down sleep.
errFlag_t MW_EnterSleepMode (sleepMode_t mode)
 Enters the selected device sleep mode.

Detailed Description

Contains API prototypes for the Power Manager.

Version
1.0.0

The Power Manager provides services to Tasks to ensure correct interaction with features of the SLPCTRL and BODCTRL peripherals.