Add wizard info for wdt.
[bertos.git] / bertos / drv / wdt.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \version $Id$
34  *
35  * \author Bernie Innocenti <bernie@codewiz.org>
36  *
37  * \brief Watchdog interface
38  * $WIZARD_MODULE = {
39  * "name" : "wdt",
40  * "depends" : [],
41  * "configuration" : "bertos/cfg/cfg_wdt.h"
42  * }
43  */
44
45 #ifndef DRV_WDT_H
46 #define DRV_WDT_H
47
48 #include "cfg/cfg_wdt.h"
49
50 #include <cfg/compiler.h> // INLINE
51
52 /* Configury sanity check */
53 #if !defined(CONFIG_WATCHDOG) || (CONFIG_WATCHDOG != 0 && CONFIG_WATCHDOG != 1)
54         #error CONFIG_WATCHDOG must be defined to either 0 or 1
55 #endif
56
57 #if OS_HOSTED
58         #include <cpu/detect.h>
59         #include <cfg/os.h>
60
61         #if OS_QT
62                         #include <QtGui/QApplication>
63         #elif OS_POSIX
64                 #include <sys/select.h>
65         #else
66                 #error unknown CPU
67         #endif
68 #elif CONFIG_WATCHDOG
69         #include CPU_HEADER(wdt)
70 #endif /* CONFIG_WATCHDOG */
71
72
73 #if OS_HOSTED || !CONFIG_WATCHDOG
74
75         /**
76          * Reset the watchdog timer.
77          */
78         INLINE void wdt_reset(void)
79         {
80         #if CONFIG_WATCHDOG
81                 #if OS_QT
82                         // Let Qt handle events
83                         ASSERT(qApp);
84                         qApp->processEvents();
85                 #elif OS_POSIX
86                         static struct timeval tv = { 0, 0 };
87                         select(0, NULL, NULL, NULL, &tv);
88                 #endif
89         #endif /* CONFIG_WATCHDOG */
90         }
91
92         /**
93          * Start the watchdog timer that fire at the select
94          * timeout.
95          *
96          * \param timeout this value is target dependant.
97          * See the target documentation for more details.
98          */
99         INLINE void wdt_start(uint32_t timeout)
100         {
101         #if CONFIG_WATCHDOG
102                 #if OS_QT
103                         // Create a dummy QApplication object
104                         if (!qApp)
105                         {
106                                 int argc;
107                                 new QApplication(argc, (char **)NULL);
108                         }
109                         (void)timeout;
110                 #elif OS_POSIX
111                         (void)timeout; // NOP
112                 #endif
113         #endif /* CONFIG_WATCHDOG */
114                 (void)timeout; // NOP
115         }
116
117         INLINE void wdt_stop(void)
118         {
119         #if CONFIG_WATCHDOG
120                 #if OS_QT
121                         // NOP
122                 #elif OS_POSIX
123                         // NOP
124                 #else
125                         #error unknown CPU
126                 #endif
127         #endif /* CONFIG_WATCHDOG */
128         }
129 #endif /* OS_HOSTED || !CONFIG_WATCHDOG */
130
131 #endif /* DRV_WDT_H */