TLE986x Device Family SDK
Macros | Functions
pmu.h File Reference

Go to the source code of this file.

Detailed Description

Power Management Unit low level access library.

Version
V0.2.0
Date
28. Feb 2020

Include Graph

Include dependency graph for pmu.h:

Macros

#define PMU_RESET_STS_POR   (0x80u)
 PMU Reset Status Flag Mask, Power-On Reset Flag. More...
 
#define PMU_RESET_STS_PIN   (0x40u)
 PMU Reset Status Flag Mask, PIN-Reset Flag. More...
 
#define PMU_RESET_STS_WDT1   (0x20u)
 PMU Reset Status Flag Mask, External Watchdog (WDT1) Reset Flag. More...
 
#define PMU_RESET_STS_ClkWDT   (0x10u)
 PMU Reset Status Flag Mask, Clock Watchdog (CLKWDT) Reset Flag. More...
 
#define PMU_RESET_STS_LPR   (0x08u)
 PMU Reset Status Flag Mask, Low Priority Resets. More...
 
#define PMU_RESET_STS_SLEEP   (0x04u)
 PMU Reset Status Flag Mask, Flag which indicates a reset caused by Sleep-Exit. More...
 
#define PMU_RESET_STS_WAKE   (0x02u)
 PMU Reset Status Flag Mask, Flag which indicates a reset caused by Stop-Exit. More...
 
#define PMU_RESET_STS_SYS_FAIL   (0x01u)
 PMU Reset Status Flag Mask, Flag which indicates a reset caused by a System Fail reported in the corresponding Fail Register. More...
 
#define PMU_VDDEXT_STABLE   (0x80u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply works inside its specified range 1. More...
 
#define PMU_VDDEXT_OK   (0x40u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply works inside its specified range 2. More...
 
#define PMU_VDDEXT_OVERLOAD   (0x20u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply Overload. More...
 
#define PMU_VDDEXT_OVERVOLT   (0x10u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply Overvoltage. More...
 
#define PMU_VDDEXT_SHORT   (0x08u)
 PMU VDDEXT Status Flag Mask, VDDEXT Shorted Output. More...
 
#define PMU_VDDEXT_IE   (0x04u)
 PMU VDDEXT Status Flag Mask, Enabling of VDDEXT Supply status information as interrupt source. More...
 
#define PMU_VDDEXT_CYC_EN   (0x02u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply for Cyclic Sense Enable. More...
 
#define PMU_VDDEXT_ENABLE   (0x01u)
 PMU VDDEXT Status Flag Mask, VDDEXT Supply Enable. More...
 

Functions

INLINE void PMU_VDDEXT_Int_En (void)
 enables VDDEXT Supply status information as interrupt source (enable Fail Interrupt). More...
 
INLINE void PMU_VDDEXT_Int_Dis (void)
 disables VDDEXT Supply status information as interrupt source (disable Fail Interrupt). More...
 
INLINE void PMU_VDDC_Int_En (void)
 enables VDDC status information as interrupt source. More...
 
INLINE void PMU_VDDC_Int_Dis (void)
 disables VDDC status information as interrupt source. More...
 
INLINE void PMU_VDDP_Int_En (void)
 enables VDDP status information as interrupt source. More...
 
INLINE void PMU_VDDP_Int_Dis (void)
 disables VDDP status information as interrupt source. More...
 
void PMU_Init (void)
 Initializes the PMU module. More...
 
bool PMU_VDDEXT_On (void)
 Turns VDDEXT on. More...
 
INLINE uint8 PMU_Get_Reset_Status (void)
 Reads out the Reset Status Hard Register (PMU->PMU_RESET_STS1) More...
 
INLINE void PMU_Clear_Reset_Status (void)
 Clears the Reset Status Hard Register (PMU->PMU_RESET_STS1) More...
 
INLINE uint8 PMU_VDDEXT_Off (void)
 Switches off (disables) VDDEXT and returns the stable state of VDDEXT (VDDEXT Supply works inside its specified range) More...
 
INLINE void PMU_VDDEXT_Short_Clr (void)
 Clear VDDEXT Short Error Flag. More...
 
INLINE void PMU_VDDEXT_Set (uint8 FlagMask)
 Set the given bits in the PMU->VDDEXT_CTRL register. More...
 

Macro Definition Documentation

◆ PMU_RESET_STS_ClkWDT

#define PMU_RESET_STS_ClkWDT   (0x10u)

PMU Reset Status Flag Mask, Clock Watchdog (CLKWDT) Reset Flag.

◆ PMU_RESET_STS_LPR

#define PMU_RESET_STS_LPR   (0x08u)

PMU Reset Status Flag Mask, Low Priority Resets.

◆ PMU_RESET_STS_PIN

#define PMU_RESET_STS_PIN   (0x40u)

PMU Reset Status Flag Mask, PIN-Reset Flag.

◆ PMU_RESET_STS_POR

#define PMU_RESET_STS_POR   (0x80u)

PMU Reset Status Flag Mask, Power-On Reset Flag.

◆ PMU_RESET_STS_SLEEP

#define PMU_RESET_STS_SLEEP   (0x04u)

PMU Reset Status Flag Mask, Flag which indicates a reset caused by Sleep-Exit.

◆ PMU_RESET_STS_SYS_FAIL

#define PMU_RESET_STS_SYS_FAIL   (0x01u)

PMU Reset Status Flag Mask, Flag which indicates a reset caused by a System Fail reported in the corresponding Fail Register.

◆ PMU_RESET_STS_WAKE

#define PMU_RESET_STS_WAKE   (0x02u)

PMU Reset Status Flag Mask, Flag which indicates a reset caused by Stop-Exit.

◆ PMU_RESET_STS_WDT1

#define PMU_RESET_STS_WDT1   (0x20u)

PMU Reset Status Flag Mask, External Watchdog (WDT1) Reset Flag.

◆ PMU_VDDEXT_CYC_EN

#define PMU_VDDEXT_CYC_EN   (0x02u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply for Cyclic Sense Enable.

◆ PMU_VDDEXT_ENABLE

#define PMU_VDDEXT_ENABLE   (0x01u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply Enable.

◆ PMU_VDDEXT_IE

#define PMU_VDDEXT_IE   (0x04u)

PMU VDDEXT Status Flag Mask, Enabling of VDDEXT Supply status information as interrupt source.

◆ PMU_VDDEXT_OK

#define PMU_VDDEXT_OK   (0x40u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply works inside its specified range 2.

◆ PMU_VDDEXT_OVERLOAD

#define PMU_VDDEXT_OVERLOAD   (0x20u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply Overload.

◆ PMU_VDDEXT_OVERVOLT

#define PMU_VDDEXT_OVERVOLT   (0x10u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply Overvoltage.

◆ PMU_VDDEXT_SHORT

#define PMU_VDDEXT_SHORT   (0x08u)

PMU VDDEXT Status Flag Mask, VDDEXT Shorted Output.

◆ PMU_VDDEXT_STABLE

#define PMU_VDDEXT_STABLE   (0x80u)

PMU VDDEXT Status Flag Mask, VDDEXT Supply works inside its specified range 1.

Function Documentation

◆ PMU_Clear_Reset_Status()

INLINE void PMU_Clear_Reset_Status ( void  )

Clears the Reset Status Hard Register (PMU->PMU_RESET_STS1)

Example

This example checks and clears Reset Status.

void Example_Function(void)
{
{
}
}

◆ PMU_Get_Reset_Status()

INLINE uint8 PMU_Get_Reset_Status ( void  )

Reads out the Reset Status Hard Register (PMU->PMU_RESET_STS1)

Returns
combination of reset status bits

Example

This example checks and clears Reset Status.

void Example_Function(void)
{
{
}
}

◆ PMU_Init()

void PMU_Init ( void  )

Initializes the PMU module.

◆ PMU_VDDC_Int_Dis()

INLINE void PMU_VDDC_Int_Dis ( void  )

disables VDDC status information as interrupt source.

Example

This example treats the Overvoltage at VDDC regulator interrupt.

void Example_Function(void)
{
if ((uint8)PMU->PMU_SUPPLY_STS.bit.PMU_1V5_OVERVOLT == (uint8)1)
{
PMU_VDDC_OV_CALLBACK();
}
}

◆ PMU_VDDC_Int_En()

INLINE void PMU_VDDC_Int_En ( void  )

enables VDDC status information as interrupt source.

Example

This example treats the Overvoltage at VDDC regulator interrupt.

void Example_Function(void)
{
if ((uint8)PMU->PMU_SUPPLY_STS.bit.PMU_1V5_OVERVOLT == (uint8)1)
{
PMU_VDDC_OV_CALLBACK();
}
}

◆ PMU_VDDEXT_Int_Dis()

INLINE void PMU_VDDEXT_Int_Dis ( void  )

disables VDDEXT Supply status information as interrupt source (disable Fail Interrupt).

Example

This example treats the VDDEXT Supply OverLoad interrupt.

void Example_Function(void)
{
if ((uint8)PMU->VDDEXT_CTRL.bit.OVERLOAD == (uint8)1)
{
PMU_VDDEXT_OL_CALLBACK();
}
}

◆ PMU_VDDEXT_Int_En()

INLINE void PMU_VDDEXT_Int_En ( void  )

enables VDDEXT Supply status information as interrupt source (enable Fail Interrupt).

Example

This example treats the VDDEXT Supply OverLoad interrupt.

void Example_Function(void)
{
if ((uint8)PMU->VDDEXT_CTRL.bit.OVERLOAD == (uint8)1)
{
PMU_VDDEXT_OL_CALLBACK();
}
}

◆ PMU_VDDEXT_Off()

INLINE uint8 PMU_VDDEXT_Off ( void  )

Switches off (disables) VDDEXT and returns the stable state of VDDEXT (VDDEXT Supply works inside its specified range)

Returns
status of VDDEXT

Example

This example switches VDDEXT off and waits until VDDEXT is in stable condition.

void Example_Function(void)
{
while (PMU_VDDEXT_Off() == (uint8)0)
{
}
}

◆ PMU_VDDEXT_On()

bool PMU_VDDEXT_On ( void  )

Turns VDDEXT on.

Different implementations for BE/BF-Step

Return values
TRUEVDDEXT was turned on
FALSEVDDEXT is off, was not turned on

Example

This example switches VDDEXT on and waits until VDDEXT is in stable condition.

void Example_Function(void)
{
while (PMU_VDDEXT_On() == false)
{
}
}

◆ PMU_VDDEXT_Set()

INLINE void PMU_VDDEXT_Set ( uint8  FlagMask)

Set the given bits in the PMU->VDDEXT_CTRL register.

Parameters
FlagMaskVDDEXT Flags Mask

Example

This example enables VVDDEXT Supply status information as interrupt source.

void Example_Function(void)
{
}

◆ PMU_VDDEXT_Short_Clr()

INLINE void PMU_VDDEXT_Short_Clr ( void  )

Clear VDDEXT Short Error Flag.

Example

This example clears VDDEXT Supply Shorted Output flag.

void Example_Function(void)
{
}

◆ PMU_VDDP_Int_Dis()

INLINE void PMU_VDDP_Int_Dis ( void  )

disables VDDP status information as interrupt source.

Example

This example treats the Overvoltage at VDDP regulator interrupt.

void Example_Function(void)
{
if ((uint8)PMU->PMU_SUPPLY_STS.bit.PMU_5V_OVERVOLT == (uint8)1)
{
PMU_VDDP_OV_CALLBACK();
}
}

◆ PMU_VDDP_Int_En()

INLINE void PMU_VDDP_Int_En ( void  )

enables VDDP status information as interrupt source.

Example

This example treats the Overvoltage at VDDP regulator interrupt.

void Example_Function(void)
{
if ((uint8)PMU->PMU_SUPPLY_STS.bit.PMU_5V_OVERVOLT == (uint8)1)
{
PMU_VDDP_OV_CALLBACK();
}
}
PMU_Clear_Reset_Status
INLINE void PMU_Clear_Reset_Status(void)
Clears the Reset Status Hard Register (PMU->PMU_RESET_STS1)
Definition: pmu.h:336
PMU_VDDC_Int_En
INLINE void PMU_VDDC_Int_En(void)
enables VDDC status information as interrupt source.
Definition: pmu.h:191
PMU_VDDEXT_Short_Clr
INLINE void PMU_VDDEXT_Short_Clr(void)
Clear VDDEXT Short Error Flag.
Definition: pmu.h:376
PMU_VDDP_Int_Dis
INLINE void PMU_VDDP_Int_Dis(void)
disables VDDP status information as interrupt source.
Definition: pmu.h:256
PMU_VDDEXT_On
bool PMU_VDDEXT_On(void)
Turns VDDEXT on.
uint8
unsigned char uint8
8 bit unsigned value
Definition: types.h:139
PMU_VDDEXT_Int_En
INLINE void PMU_VDDEXT_Int_En(void)
enables VDDEXT Supply status information as interrupt source (enable Fail Interrupt).
Definition: pmu.h:148
PMU
#define PMU
Definition: tle986x.h:6002
PMU_VDDEXT_Set
INLINE void PMU_VDDEXT_Set(uint8 FlagMask)
Set the given bits in the PMU->VDDEXT_CTRL register.
Definition: pmu.h:395
PMU_VDDEXT_Off
INLINE uint8 PMU_VDDEXT_Off(void)
Switches off (disables) VDDEXT and returns the stable state of VDDEXT (VDDEXT Supply works inside its...
Definition: pmu.h:358
PMU_VDDP_Int_En
INLINE void PMU_VDDP_Int_En(void)
enables VDDP status information as interrupt source.
Definition: pmu.h:234
PMU_VDDC_Int_Dis
INLINE void PMU_VDDC_Int_Dis(void)
disables VDDC status information as interrupt source.
Definition: pmu.h:213
PMU_Get_Reset_Status
INLINE uint8 PMU_Get_Reset_Status(void)
Reads out the Reset Status Hard Register (PMU->PMU_RESET_STS1)
Definition: pmu.h:316
PMU_VDDEXT_ENABLE
#define PMU_VDDEXT_ENABLE
PMU VDDEXT Status Flag Mask, VDDEXT Supply Enable.
Definition: pmu.h:128
PMU_VDDEXT_Int_Dis
INLINE void PMU_VDDEXT_Int_Dis(void)
disables VDDEXT Supply status information as interrupt source (disable Fail Interrupt).
Definition: pmu.h:170