Fix some comments and typos.
[bertos.git] / bertos / cpu / avr / drv / wdt_avr.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  * \brief Watchdog interface for AVR architecture.
34  *
35  * \note The avr-libc already provide an api to manage the watchdog on AVR architecture.
36  * In avr-libc are also available several constants used to set the timeout value
37  * (see documentation for more detail).
38  *
39  * \version $Id$
40  *
41  * \author Daniele Basile <asterix@develer.com>
42  *
43  */
44
45 #ifndef DRV_WDT_AVR_H
46 #define DRV_WDT_AVR_H
47
48 #include "cfg/cfg_wdt.h"
49
50 #include <cfg/compiler.h> // INLINE
51
52 #include <avr/io.h>
53 #include <avr/wdt.h>
54
55 /**
56  * Reset the watchdog timer.
57  *
58  * This functions is already defind in avr-libc.
59  */
60 // void wdt_reset(void)
61
62 /**
63  * Start the watchdog timer that fire at the select
64  * timeout.
65  *
66  * \param timeout, you can use the macro that are defineded in
67  * avr/wdt.h.
68  *
69  * (from avr libc documentation)
70  * WDTO_15MS
71  * WDTO_30MS
72  * WDTO_60MS
73  * WDTO_120MS
74  * WDTO_250MS
75  * WDTO_500MS
76  * WDTO_1S
77  * WDTO_2S
78  * WDTO_4S
79  * WDTO_8S
80  */
81 INLINE void wdt_start(uint32_t _timeout)
82 {
83         uint8_t timeout = _timeout;
84
85         wdt_enable(timeout);
86 }
87
88 /**
89  * Stop watchdog timer.
90  */
91 INLINE void wdt_stop(void)
92 {
93         wdt_disable();
94 }
95
96
97 #endif /* DRV_WDT_AVR_H */