1 //*****************************************************************************
2 //
3 // watchdog.h - Prototypes for the Watchdog Timer API
4 //
5 // Copyright (c) 2005-2012 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 // This is part of revision 9453 of the Stellaris Peripheral Driver Library.
37 //
38 //*****************************************************************************
39 
40 #ifndef __WATCHDOG_H__
41 #define __WATCHDOG_H__
42 
43 //*****************************************************************************
44 //
45 // If building with a C++ compiler, make all of the definitions in this header
46 // have a C binding.
47 //
48 //*****************************************************************************
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 //*****************************************************************************
55 //
56 // The type of interrupt that can be generated by the watchdog.
57 //
58 //*****************************************************************************
59 #define WATCHDOG_INT_TYPE_INT   0x00000000
60 #define WATCHDOG_INT_TYPE_NMI   0x00000004
61 
62 //*****************************************************************************
63 //
64 // Prototypes for the APIs.
65 //
66 //*****************************************************************************
67 extern tBoolean WatchdogRunning(unsigned long ulBase);
68 extern void WatchdogEnable(unsigned long ulBase);
69 extern void WatchdogResetEnable(unsigned long ulBase);
70 extern void WatchdogResetDisable(unsigned long ulBase);
71 extern void WatchdogLock(unsigned long ulBase);
72 extern void WatchdogUnlock(unsigned long ulBase);
73 extern tBoolean WatchdogLockState(unsigned long ulBase);
74 extern void WatchdogReloadSet(unsigned long ulBase, unsigned long ulLoadVal);
75 extern unsigned long WatchdogReloadGet(unsigned long ulBase);
76 extern unsigned long WatchdogValueGet(unsigned long ulBase);
77 extern void WatchdogIntRegister(unsigned long ulBase, void(*pfnHandler)(void));
78 extern void WatchdogIntUnregister(unsigned long ulBase);
79 extern void WatchdogIntEnable(unsigned long ulBase);
80 extern unsigned long WatchdogIntStatus(unsigned long ulBase, tBoolean bMasked);
81 extern void WatchdogIntClear(unsigned long ulBase);
82 extern void WatchdogIntTypeSet(unsigned long ulBase, unsigned long ulType);
83 extern void WatchdogStallEnable(unsigned long ulBase);
84 extern void WatchdogStallDisable(unsigned long ulBase);
85 
86 //*****************************************************************************
87 //
88 // Mark the end of the C bindings section for C++ compilers.
89 //
90 //*****************************************************************************
91 #ifdef __cplusplus
92 }
93 #endif
94 
95 #endif // __WATCHDOG_H__
96