esos_wdog.h

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.
 *
 *
 */
 
#ifndef ESOS_WDOG_H
#define ESOS_WDOG_H
 
 
#include "esos.h"
 
 
/* ******************************************************************
 * 
 * Prototypes for all the hardware-independent routines herein
 * 
 * *****************************************************************/
void    _esos_wdog_initWatchdog(uint32_t  u32_ticksBetweenWatchdogResets );
void    esos_wdog_feedWatchdog( void );
 
uint32_t esos_wdog_getWatchdogFedTicks(void);
 
uint32_t esos_wdog_getTicksSinceWatchdogFed(void);
 
uint32_t esos_wdog_getTicksUntilWatchdogReset(void);
 
uint32_t esos_wdog_getTicksWatchdogPeriod(void);
 
/* ******************************************************************
 * 
 * Prototypes for all the hardware specific routines we expect
 * 
 * *****************************************************************/
void _esos_hw_wdog_initWatchdog(uint32_t  u32_msBetweenWatchdogResets );
void _esos_hw_wdog_feedWatchdog(void);
 
// ******** G L O B A L S ***************
extern volatile uint32_t    __esos_wdog_ticksWatchdogLastFed;
 
#endif              // ESOS_WDOG_H