3.14.1.4 Module Documentation
3.14.1.4.1 HLVD
This file contains the API protoypes and related data structures for the HLVD driver.
Module description
This file contains the API protoypes and related data structures for the HLVD driver.
Enumerations
enum HLVD_TRIP_POINTS { HLVD_TRIP_POINT_EXTERNAL = 15, HLVD_TRIP_POINT_4p64V = 14, HLVD_TRIP_POINT_4p33V = 13, HLVD_TRIP_POINT_4p06V = 12, HLVD_TRIP_POINT_3p82V = 11, HLVD_TRIP_POINT_3p61V = 10, HLVD_TRIP_POINT_3p42V = 9, HLVD_TRIP_POINT_3p24V = 8, HLVD_TRIP_POINT_2p95V = 7, HLVD_TRIP_POINT_2p82V = 6, HLVD_TRIP_POINT_2p70V = 5, HLVD_TRIP_POINT_2p50V = 4, HLVD_TRIP_POINT_2p40V = 3, HLVD_TRIP_POINT_2p24V = 2, HLVD_TRIP_POINT_2p03V = 1, HLVD_TRIP_POINT_1p80V = 0 }
Trip point values for the HLVD driver.
enum HLVD_TRIP_DIRECTION { BELOW_TRIP_POINT = 0, EXCEED_TRIP_POINT = 1 }
Voltage trip direction for the HLVD driver.
Functions
void HLVD_Initialize (void)
Initializes the HLVD module. This is called only once before calling other HLVD APIs.
void HLVD_Enable (void)
Enables the HLVD.
void HLVD_Disable (void)
Disables the HLVD.
bool HLVD_IsReferenceVoltageStable (void)
Returns the status of the internal reference voltage.
bool HLVD_IsBandGapVoltageStable (void)
Returns the status of the band gap reference voltage.
void HLVD_TripPointSetup (HLVD_TRIP_DIRECTION trip_direction, HLVD_TRIP_POINTS trip_points)
Sets the voltage trip direction and trip point value.
void HLVD_CallbackRegister (void(*CallbackHandler)(void))
Sets the callback handler for the HLVD interrupt events.
void HLVD_Tasks (void)
Checks the status of the HLVD Interrupt Flag bit.
Function Documentation
HLVD_CallbackRegister()
void HLVD_CallbackRegister (void(*)(void) CallbackHandler)
Sets the callback handler for the HLVD interrupt events.
(*CallbackHandler)(void) |
- Function pointer to the HLVD interrupt handler. |
None. |
HLVD_Disable()
void HLVD_Disable (void )
Disables the HLVD.
HLVD_Initialize() and HLVD_IsReferenceVoltageStable() are already called. |
None. |
None. |
HLVD_Enable()
void HLVD_Enable (void )
Enables the HLVD.
None. |
None. |
HLVD_Initialize()
void HLVD_Initialize (void )
Initializes the HLVD module. This is called only once before calling other HLVD APIs.
None. |
None. |
HLVD_IsBandGapVoltageStable()
bool HLVD_IsBandGapVoltageStable (void )
Returns the status of the band gap reference voltage.
HLVD_Initialize() is already called. |
None. |
True |
- Band gap voltage is stable. |
False |
- Band gap voltage is unstable. |
HLVD_IsReferenceVoltageStable()
bool HLVD_IsReferenceVoltageStable (void )
Returns the status of the internal reference voltage.
HLVD_Initialize() is already called. |
None. |
True |
- Internal reference voltage is stable. |
False |
- Internal reference voltage is unstable. |
HLVD_Tasks()
void HLVD_Tasks (void )
Checks the status of the HLVD Interrupt Flag bit.
None. |
None. |
HLVD_TripPointSetup()
void HLVD_TripPointSetup (HLVD_TRIP_DIRECTION trip_direction, HLVD_TRIP_POINTS trip_points)
Sets the voltage trip direction and trip point value.
trip_direction |
- Trip direction value. |
trip_points |
- Trip point value. |
None. |
Enumeration Type Documentation
HLVD_TRIP_DIRECTION
enum HLVD_TRIP_DIRECTION
Voltage trip direction for the HLVD driver.
BELOW_TRIP_POINT | |
EXCEED_TRIP_POINT |
HLVD_TRIP_POINTS
enum HLVD_TRIP_POINTS
Trip point values for the HLVD driver.
Section: Included Files Section: Enum Declarations
HLVD_TRIP_POINT_EXTERNAL | |
HLVD_TRIP_POINT_4p64V | |
HLVD_TRIP_POINT_4p33V | |
HLVD_TRIP_POINT_4p06V | |
HLVD_TRIP_POINT_3p82V | |
HLVD_TRIP_POINT_3p61V | |
HLVD_TRIP_POINT_3p42V | |
HLVD_TRIP_POINT_3p24V | |
HLVD_TRIP_POINT_2p95V | |
HLVD_TRIP_POINT_2p82V | |
HLVD_TRIP_POINT_2p70V | |
HLVD_TRIP_POINT_2p50V | |
HLVD_TRIP_POINT_2p40V | |
HLVD_TRIP_POINT_2p24V | |
HLVD_TRIP_POINT_2p03V | |
HLVD_TRIP_POINT_1p80V |