4.14.1.4 Module Documentation

4.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.

Version: HLVD Driver Version 1.0.0

Enumerations

Functions

Function Documentation

HLVD_CallbackRegister()

void HLVD_CallbackRegister (void(*)(void) CallbackHandler)

Sets the callback handler for the HLVD interrupt events.

Parameters:
(*CallbackHandler)(void)

- Function pointer to the HLVD interrupt handler.

Returns:

None.

HLVD_Enable()

void HLVD_Enable (void )

Enables the HLVD.

Parameters:
None.
Returns:

None.

HLVD_Initialize()

void HLVD_Initialize (void )

Initializes the HLVD module. This is called only once before calling other HLVD APIs.

Parameters:
None.
Returns:

None.

HLVD_IsBandGapVoltageStable()

bool HLVD_IsBandGapVoltageStable (void )

Returns the status of the band gap reference voltage.

Precondition:

HLVD_Initialize() is already called.

Parameters:
None.
Return values:
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.

Precondition:

HLVD_Initialize() is already called.

Parameters:
None.
Return values:
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.

Parameters:
None.
Returns:

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.

Parameters:
trip_direction

- Trip direction value.

trip_points

- Trip point value.

Returns:

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