esos_wdog.c

Go to the documentation of this file.

/*
 * "Copyright (c) 2019 J. W. Bruce ("AUTHOR(S)")"
 * All rights reserved.
 * (J. W. Bruce, jwbruce_AT_tntech.edu, Tennessee Tech University)
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the authors appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 * Please maintain this header in its entirety when copying/modifying
 * these files.
 *
 *
 */
 
/************************************************************************
 * esos_wdog.c
 ************************************************************************
 * ES_OS file for (hardware independent) watchdog timer routines
 */
 
#include    "esos_wdog.h"
 
// ******** G L O B A L S ***************
volatile uint32_t   __esos_wdog_ticksWatchdogPeriod;
volatile uint32_t   __esos_wdog_ticksWatchdogLastFed;
 
void    _esos_wdog_initWatchdog(uint32_t  u32_msBetweenWatchdogResets ) {
  // record the watchdog period
  __esos_wdog_ticksWatchdogPeriod = u32_msBetweenWatchdogResets * MILLISECONDS;
  // call the HW-specific code to setup the watchdog timer
  _esos_hw_wdog_initWatchdog( u32_msBetweenWatchdogResets );        
  // record the time we last "fed" the watchdog
  __esos_wdog_ticksWatchdogLastFed = esos_GetSystemTick();
} // end esos_initWatchdog()
 
void  esos_wdog_feedWatchdog( void ) {
  // record the time we last "fed" the watchdog
  __esos_wdog_ticksWatchdogLastFed = esos_GetSystemTick();  
  // call the HW-specific code to setup the watchdog timer
  _esos_hw_wdog_feedWatchdog();       
} // end esos_feedWatchdog()
 
inline uint32_t esos_wdog_getWatchdogFedTicks(void) {
  return __esos_wdog_ticksWatchdogLastFed;
} // end esos_getWatchdogFedTicks(void)
 
inline uint32_t esos_wdog_getTicksSinceWatchdogFed(void) {
  return esos_GetSystemTick() - __esos_wdog_ticksWatchdogLastFed;
} // end esos_getTicksSinceWatchdogFed(void)
 
inline uint32_t esos_wdog_getTicksUntilWatchdogReset(void) {
  return __esos_wdog_ticksWatchdogLastFed + __esos_wdog_ticksWatchdogPeriod - esos_GetSystemTick();
}
 
inline uint32_t esos_wdog_getTicksWatchdogPeriod(void) {
  return __esos_wdog_ticksWatchdogPeriod;
}