Texas Instruments Tiva TM4C123GH6PM, User Manual

Page: 109 / 352

Hibernation Module
Prototype:
uint32_t
ROM_HibernateBatCheckDone(void)
ROM Location:
ROM_APITABLE
is an array of pointers located at
0x0100.0010
.
ROM_HIBERNATETABLE
is an array of pointers located at
ROM_APITABLE[19]
.
ROM_HibernateBatCheckDone
is a function pointer located at
ROM_HIBERNATETABLE[30]
.
Description:
This function returns if the forced battery check initiated by a call to the HibernateBatCheck-
Start() function has completed. This function will return a non-zero value until the battery level
check has completed. Once this function returns a value of zero, the hibernation module has
completed the battery check and the HibernateIntStatus() function can be used to check if the
battery was low by checking if the value returned has the
HIBERNATE_INT_LOW_BAT set.
Returns:
The value is zero when the battery level check has completed or non-zero if the check is still in
process.
11.2.1.2 ROM_HibernateBatCheckStart
Forces the Hibernation module to initiate a check of the battery voltage.
Prototype:
void
ROM_HibernateBatCheckStart(void)
ROM Location:
ROM_APITABLE
is an array of pointers located at
0x0100.0010
.
ROM_HIBERNATETABLE
is an array of pointers located at
ROM_APITABLE[19]
.
ROM_HibernateBatCheckStart
is a function pointer located at
ROM_HIBERNATETABLE[29]
.
Description:
This function forces the Hibernation module to initiate a check of the battery voltage imme-
diately rather than waiting for the next check interval to pass. After calling this function, the
application should call the () function and wait for the function to return a zero value before call-
ing the HibernateIntStatus() to check if the return code has the
HIBERNATE_INT_LOW_BAT
set. If HIBERNATE_INT_LOW_BAT is set this indicates that battery level is low. The appli-
cation can also enable the HIBERNATE_INT_LOW_BAT interrupt and wait for an interrupt to
indicate that the battery level is low.
Note:
A hibernation request is held off if a battery check is in progress.
Returns:
None.
April 8, 2013 109