GM6000 Digital Heater Controller Branch: main
SDX-1330
WatchDog.h
Go to the documentation of this file.
1#ifndef Bsp_WatchDog_h_
2#define Bsp_WatchDog_h_
3/*-----------------------------------------------------------------------------
4* This file is part of the Colony.Core Project. The Colony.Core Project is an
5* open source project with a BSD type of licensing agreement. See the license
6* agreement (license.txt) in the top/ directory or on the Internet at
7* http://integerfox.com/colony.core/license.txt
8*
9* Copyright (c) 2014-2019 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file
14
15 This file defines a common/generic interface for managing the application's
16 and/or platform's watchdog. The watchdog is responsible for restarted the
17 application/platform if watchdog is not 'kicked' within the pre-configured
18 time intervals.
19
20 ALL Colony.* BSPs are ENCOURAGED to support this interface. The default
21 implementation DOES NOTHING. Use the config preprocessor symbols
22 HAVE_BSP_WATCH_DOG_xxx to disable and/or turn off the default implementation.
23 */
24
25
26#include "Bsp/Api.h"
27
28
29// Start C++
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34
35/////////////////////////////////////////////////////////////////////////////
36//
37
38/** This method starts the watchdog mechanism. Once started, the watchdog
39 mechanism can not be disabled/turned off. This method is also responsible
40 for configuring/setting the time interval/frequency that watchdog
41 must be kicked to keep the application/platform from resetting.
42
43 \b Prototype:
44 void Bsp_WatchDog_start(void);
45 */
46#define Bsp_WatchDog_start Bsp_WatchDog_start_MAP
47
48
49/** This method 'kicks' the watchdog, i.e. restart's the watchdog count
50 down timer.
51
52 \b Prototype:
53 void Bsp_WatchDog_kick(void);
54 */
55#define Bsp_WatchDog_kick Bsp_WatchDog_kick_MAP
56
57
58
59
60
61
62/////////////////////////////////////////////////////////////////////////////
63// DEFAULT IMPLEMENATION
64/////////////////////////////////////////////////////////////////////////////
65
66#ifndef DOXYGEN_WILL_SKIP_THIS
67
68#ifndef HAVE_BSP_WATCH_DOG_START
69#define Bsp_WatchDog_start_MAP()
70#endif
71
72#ifndef HAVE_BSP_WATCH_DOG_KICK
73#define Bsp_WatchDog_kick_MAP()
74#endif
75
76#endif // end DOXYGEN_WILL_SKIP_THIS
77
78#ifdef __cplusplus
79};
80#endif
81
82
83#endif // end header latch
Api.h
This file defines the common/generic interfaces that all Colony.
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8