watchdog.h
Go to the documentation of this file.
1 //*****************************************************************************
2 //
3 // watchdog.h - Prototypes for the Watchdog Timer API
4 //
5 // Copyright (c) 2005-2017 Texas Instruments Incorporated. All rights reserved.
6 // Software License Agreement
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 //
15 // Redistributions in binary form must reproduce the above copyright
16 // notice, this list of conditions and the following disclaimer in the
17 // documentation and/or other materials provided with the
18 // distribution.
19 //
20 // Neither the name of Texas Instruments Incorporated nor the names of
21 // its contributors may be used to endorse or promote products derived
22 // from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 //*****************************************************************************
37 
38 #ifndef __DRIVERLIB_WATCHDOG_H__
39 #define __DRIVERLIB_WATCHDOG_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 //
57 // The type of interrupt that can be generated by the watchdog.
58 //
59 //*****************************************************************************
60 #define WATCHDOG_INT_TYPE_INT 0x00000000
61 #define WATCHDOG_INT_TYPE_NMI 0x00000004
62 
63 //*****************************************************************************
64 //
65 // Prototypes for the APIs.
66 //
67 //*****************************************************************************
68 extern bool WatchdogRunning(uint32_t ui32Base);
69 extern void WatchdogEnable(uint32_t ui32Base);
70 extern void WatchdogResetEnable(uint32_t ui32Base);
71 extern void WatchdogResetDisable(uint32_t ui32Base);
72 extern void WatchdogLock(uint32_t ui32Base);
73 extern void WatchdogUnlock(uint32_t ui32Base);
74 extern bool WatchdogLockState(uint32_t ui32Base);
75 extern void WatchdogReloadSet(uint32_t ui32Base, uint32_t ui32LoadVal);
76 extern uint32_t WatchdogReloadGet(uint32_t ui32Base);
77 extern uint32_t WatchdogValueGet(uint32_t ui32Base);
78 extern void WatchdogIntRegister(uint32_t ui32Base, void (*pfnHandler)(void));
79 extern void WatchdogIntUnregister(uint32_t ui32Base);
80 extern void WatchdogIntEnable(uint32_t ui32Base);
81 extern uint32_t WatchdogIntStatus(uint32_t ui32Base, bool bMasked);
82 extern void WatchdogIntClear(uint32_t ui32Base);
83 extern void WatchdogIntTypeSet(uint32_t ui32Base, uint32_t ui32Type);
84 extern void WatchdogStallEnable(uint32_t ui32Base);
85 extern void WatchdogStallDisable(uint32_t ui32Base);
86 
87 //*****************************************************************************
88 //
89 // Mark the end of the C bindings section for C++ compilers.
90 //
91 //*****************************************************************************
92 #ifdef __cplusplus
93 }
94 #endif
95 
96 #endif // __DRIVERLIB_WATCHDOG_H__
void WatchdogIntTypeSet(uint32_t ui32Base, uint32_t ui32Type)
Definition: watchdog.c:531
void WatchdogResetEnable(uint32_t ui32Base)
Definition: watchdog.c:122
void WatchdogStallEnable(uint32_t ui32Base)
Definition: watchdog.c:567
void WatchdogReloadSet(uint32_t ui32Base, uint32_t ui32LoadVal)
Definition: watchdog.c:259
void WatchdogIntRegister(uint32_t ui32Base, void(*pfnHandler)(void))
Definition: watchdog.c:349
void WatchdogIntUnregister(uint32_t ui32Base)
Definition: watchdog.c:390
void WatchdogIntEnable(uint32_t ui32Base)
Definition: watchdog.c:422
void WatchdogEnable(uint32_t ui32Base)
Definition: watchdog.c:94
uint32_t WatchdogValueGet(uint32_t ui32Base)
Definition: watchdog.c:310
void WatchdogUnlock(uint32_t ui32Base)
Definition: watchdog.c:201
uint32_t WatchdogReloadGet(uint32_t ui32Base)
Definition: watchdog.c:285
void WatchdogResetDisable(uint32_t ui32Base)
Definition: watchdog.c:150
bool WatchdogRunning(uint32_t ui32Base)
Definition: watchdog.c:67
void WatchdogIntClear(uint32_t ui32Base)
Definition: watchdog.c:496
uint32_t WatchdogIntStatus(uint32_t ui32Base, bool bMasked)
Definition: watchdog.c:452
void WatchdogLock(uint32_t ui32Base)
Definition: watchdog.c:175
bool WatchdogLockState(uint32_t ui32Base)
Definition: watchdog.c:227
void WatchdogStallDisable(uint32_t ui32Base)
Definition: watchdog.c:596
Copyright 2017, Texas Instruments Incorporated