Fix some comments and typos.
[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  */
39
40 #ifndef DRV_WDT_H
41 #define DRV_WDT_H
42
43 #include "cfg/cfg_wdt.h"
44 #include "cfg/cfg_arch.h"
45
46 #include <cfg/compiler.h> // INLINE
47
48 /* Configury sanity check */
49 #if !defined(CONFIG_WATCHDOG) || (CONFIG_WATCHDOG != 0 && CONFIG_WATCHDOG != 1)
50         #error CONFIG_WATCHDOG must be defined to either 0 or 1
51 #endif
52
53 #if OS_HOSTED
54         #include <cpu/detect.h>
55         #include <cfg/os.h>
56
57         #if OS_QT
58                         #include <QtGui/QApplication>
59         #elif OS_POSIX
60                 #include <sys/select.h>
61         #else
62                 #error unknown CPU
63         #endif
64 #elif CONFIG_WATCHDOG
65         #include CPU_HEADER(wdt)
66 #endif /* CONFIG_WATCHDOG */
67
68
69 #if OS_HOSTED || !CONFIG_WATCHDOG
70
71         /**
72          * Reset the watchdog timer.
73          */
74         INLINE void wdt_reset(void)
75         {
76         #if CONFIG_WATCHDOG
77                 #if OS_QT
78                         // Let Qt handle events
79                         ASSERT(qApp);
80                         qApp->processEvents();
81                 #elif OS_POSIX
82                         static struct timeval tv = { 0, 0 };
83                         select(0, NULL, NULL, NULL, &tv);
84                 #endif
85         #endif /* CONFIG_WATCHDOG */
86         }
87
88         /**
89          * Start the watchdog timer that fire at the select
90          * timeout.
91          *
92          * \param timeout, this value is target dependant.
93          * See the target documentation for more details.
94          */
95         INLINE void wdt_start(uint32_t timeout)
96         {
97         #if CONFIG_WATCHDOG
98                 #if OS_QT
99                         // Create a dummy QApplication object
100                         if (!qApp)
101                         {
102                                 int argc;
103                                 new QApplication(argc, (char **)NULL);
104                         }
105                         (void)timeout;
106                 #elif OS_POSIX
107                         (void)timeout; // NOP
108                 #endif
109         #endif /* CONFIG_WATCHDOG */
110                 (void)timeout; // NOP
111         }
112
113         INLINE void wdt_stop(void)
114         {
115         #if CONFIG_WATCHDOG
116                 #if OS_QT
117                         // NOP
118                 #elif OS_POSIX
119                         // NOP
120                 #else
121                         #error unknown CPU
122                 #endif
123         #endif /* CONFIG_WATCHDOG */
124         }
125 #endif /* OS_HOSTED || !CONFIG_WATCHDOG */
126
127 #endif /* DRV_WDT_H */