<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>avr-libc: <avr/wdt.h>: Watchdog timer handling</title>
<link href="dox.css" rel="stylesheet" type="text/css">
</head>
<body>
<center>
<table width="80%">
<tr>
<td align="left"><a href="http://www.nongnu.org/avr-libc/">AVR Libc Home Page</a></td>
<td align="center" colspan=4><img src="avrs.png" alt="AVRs" align="middle" border="0"></td>
<td align="right"><a href="https://savannah.nongnu.org/projects/avr-libc/">AVR Libc Development Pages</a></td>
</tr>
<tr>
<td align="center" width="13%"><a href="index.html">Main Page</a></td>
<td align="center" width="13%"><a href="pages.html">User Manual</a></td>
<td align="center" width="13%"><a href="modules.html">Library Reference</a></td>
<td align="center" width="13%"><a href="FAQ.html">FAQ</a></td>
<td align="center" width="13%"><a href="globals.html">Alphabetical Index</a></td>
<td align="center" width="13%"><a href="group__demos.html">Example Projects</a></td>
</tr>
</table>
</center>
<hr width="80%">
<!-- Generated by Doxygen 1.6.1 -->
<div class="contents">
<h1><avr/wdt.h>: Watchdog timer handling</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga9e52c54d10b6a6a7ce04aaaa4abea51f">wdt_reset</a>() __asm__ __volatile__ ("wdr")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#gaf6cfea2a1b61e2530ea0c4ef8fc572b3">wdt_enable</a>(value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#gab3784e1b871d61ed338da5658184b725">wdt_disable</a>()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#gad45893280f49113ffc2e67e1d741f29d">WDTO_15MS</a> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga057dd21dc54e71de0e20d8bd5734915d">WDTO_30MS</a> 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga7a5b072c51c05a34cc38111f0e6724e5">WDTO_60MS</a> 2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga7d028bcdb4a4103549fc6fb4ec07fbcd">WDTO_120MS</a> 3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga66d5f50cc76b92c76900d77ef577d53e">WDTO_250MS</a> 4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#gacf89fc5fb6c8aa9efaadb86872cfbcdf">WDTO_500MS</a> 5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga36302e15f38a4eeb8a328724bb8165e9">WDTO_1S</a> 6</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga05fc682d276a36d8cc4e9178340ff004">WDTO_2S</a> 7</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#ga752b0b1b5ba9009bc09976494313e30d">WDTO_4S</a> 8</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avr__watchdog.html#gaf074e538b2a1d5031931530f29a09fce">WDTO_8S</a> 9</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="wdt_8h.html">avr/wdt.h</a>></span>
</pre></div><p>This header file declares the interface to some inline macros handling the watchdog timer present in many AVR devices. In order to prevent the watchdog timer configuration from being accidentally altered by a crashing application, a special timed sequence is required in order to change it. The macros within this header file handle the required sequence automatically before changing any value. Interrupts will be disabled during the manipulation.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Depending on the fuse configuration of the particular device, further restrictions might apply, in particular it might be disallowed to turn off the watchdog timer.</dd></dl>
<p>Note that for newer devices (ATmega88 and newer, effectively any AVR that has the option to also generate interrupts), the watchdog timer remains active even after a system reset (except a power-on condition), using the fastest prescaler value (approximately 15 ms). It is therefore required to turn off the watchdog early during program startup, the datasheet recommends a sequence like the following:</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="stdint_8h.html">stdint.h</a>></span>
<span class="preprocessor"> #include <<a class="code" href="wdt_8h.html">avr/wdt.h</a>></span>
<a class="code" href="group__avr__stdint.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> mcusr_mirror __attribute__ ((section (<span class="stringliteral">".noinit"</span>)));
<span class="keywordtype">void</span> get_mcusr(<span class="keywordtype">void</span>) \
__attribute__((naked)) \
__attribute__((section(<span class="stringliteral">".init3"</span>)));
<span class="keywordtype">void</span> get_mcusr(<span class="keywordtype">void</span>)
{
mcusr_mirror = MCUSR;
MCUSR = 0;
<a class="code" href="group__avr__watchdog.html#gab3784e1b871d61ed338da5658184b725">wdt_disable</a>();
}
</pre></div><p>Saving the value of MCUSR in <code>mcusr_mirror</code> is only needed if the application later wants to examine the reset source, but in particular, clearing the watchdog reset flag before disabling the watchdog is required, according to the datasheet. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gab3784e1b871d61ed338da5658184b725"></a><!-- doxytag: member="wdt.h::wdt_disable" ref="gab3784e1b871d61ed338da5658184b725" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define wdt_disable</td>
<td>(</td>
</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">__asm__ __volatile__ ( \
<span class="stringliteral">"in __tmp_reg__, __SREG__"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"cli"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out %0, %1"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out %0, __zero_reg__"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out __SREG__,__tmp_reg__"</span> <span class="stringliteral">"\n\t"</span> \
: <span class="comment">/* no outputs */</span> \
: <span class="stringliteral">"I"</span> (_SFR_IO_ADDR(_WD_CONTROL_REG)), \
<span class="stringliteral">"r"</span> ((<a class="code" href="group__avr__stdint.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>)(<a class="code" href="group__avr__sfr.html#ga11643f271076024c395a93800b3d9546">_BV</a>(_WD_CHANGE_BIT) | <a class="code" href="group__avr__sfr.html#ga11643f271076024c395a93800b3d9546">_BV</a>(WDE))) \
: <span class="stringliteral">"r0"</span> \
)
</pre></div><p>Disable the watchdog timer, if possible. This attempts to turn off the Enable bit in the watchdog control register. See the datasheet for details. </p>
</div>
</div>
<a class="anchor" id="gaf6cfea2a1b61e2530ea0c4ef8fc572b3"></a><!-- doxytag: member="wdt.h::wdt_enable" ref="gaf6cfea2a1b61e2530ea0c4ef8fc572b3" args="(value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define wdt_enable</td>
<td>(</td>
<td class="paramtype">value </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">__asm__ __volatile__ ( \
<span class="stringliteral">"in __tmp_reg__,__SREG__"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"cli"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"wdr"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out %0,%1"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out __SREG__,__tmp_reg__"</span> <span class="stringliteral">"\n\t"</span> \
<span class="stringliteral">"out %0,%2"</span> \
: <span class="comment">/* no outputs */</span> \
: <span class="stringliteral">"I"</span> (_SFR_IO_ADDR(_WD_CONTROL_REG)), \
<span class="stringliteral">"r"</span> (<a class="code" href="group__avr__sfr.html#ga11643f271076024c395a93800b3d9546">_BV</a>(_WD_CHANGE_BIT) | <a class="code" href="group__avr__sfr.html#ga11643f271076024c395a93800b3d9546">_BV</a>(WDE)), \
<span class="stringliteral">"r"</span> ((<a class="code" href="group__avr__stdint.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>) ((value & 0x08 ? _WD_PS3_MASK : 0x00) | \
<a class="code" href="group__avr__sfr.html#ga11643f271076024c395a93800b3d9546">_BV</a>(WDE) | (value & 0x07)) ) \
: <span class="stringliteral">"r0"</span> \
)
</pre></div><p>Enable the watchdog timer, configuring it for expiry after <code>timeout</code> (which is a combination of the <code>WDP0</code> through <code>WDP2</code> bits to write into the <code>WDTCR</code> register; For those devices that have a <code>WDTCSR</code> register, it uses the combination of the <code>WDP0</code> through <code>WDP3</code> bits).</p>
<p>See also the symbolic constants <code>WDTO_15MS</code> et al. </p>
</div>
</div>
<a class="anchor" id="ga9e52c54d10b6a6a7ce04aaaa4abea51f"></a><!-- doxytag: member="wdt.h::wdt_reset" ref="ga9e52c54d10b6a6a7ce04aaaa4abea51f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define wdt_reset</td>
<td>(</td>
</td>
<td class="paramname"></td>
<td> ) </td>
<td> __asm__ __volatile__ ("wdr")</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the watchdog timer. When the watchdog timer is enabled, a call to this instruction is required before the timer expires, otherwise a watchdog-initiated device reset will occur. </p>
</div>
</div>
<a class="anchor" id="ga7d028bcdb4a4103549fc6fb4ec07fbcd"></a><!-- doxytag: member="wdt.h::WDTO_120MS" ref="ga7d028bcdb4a4103549fc6fb4ec07fbcd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_120MS 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="gad45893280f49113ffc2e67e1d741f29d"></a><!-- doxytag: member="wdt.h::WDTO_15MS" ref="gad45893280f49113ffc2e67e1d741f29d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_15MS 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Symbolic constants for the watchdog timeout. Since the watchdog timer is based on a free-running RC oscillator, the times are approximate only and apply to a supply voltage of 5 V. At lower supply voltages, the times will increase. For older devices, the times will be as large as three times when operating at Vcc = 3 V, while the newer devices (e. g. ATmega128, ATmega8) only experience a negligible change.</p>
<p>Possible timeout values are: 15 ms, 30 ms, 60 ms, 120 ms, 250 ms, 500 ms, 1 s, 2 s. (Some devices also allow for 4 s and 8 s.) Symbolic constants are formed by the prefix <code>WDTO_</code>, followed by the time.</p>
<p>Example that would select a watchdog timer expiry of approximately 500 ms: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__avr__watchdog.html#gaf6cfea2a1b61e2530ea0c4ef8fc572b3">wdt_enable</a>(<a class="code" href="group__avr__watchdog.html#gacf89fc5fb6c8aa9efaadb86872cfbcdf">WDTO_500MS</a>);
</pre></div>
</div>
</div>
<a class="anchor" id="ga36302e15f38a4eeb8a328724bb8165e9"></a><!-- doxytag: member="wdt.h::WDTO_1S" ref="ga36302e15f38a4eeb8a328724bb8165e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_1S 6</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="ga66d5f50cc76b92c76900d77ef577d53e"></a><!-- doxytag: member="wdt.h::WDTO_250MS" ref="ga66d5f50cc76b92c76900d77ef577d53e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_250MS 4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="ga05fc682d276a36d8cc4e9178340ff004"></a><!-- doxytag: member="wdt.h::WDTO_2S" ref="ga05fc682d276a36d8cc4e9178340ff004" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_2S 7</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="ga057dd21dc54e71de0e20d8bd5734915d"></a><!-- doxytag: member="wdt.h::WDTO_30MS" ref="ga057dd21dc54e71de0e20d8bd5734915d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_30MS 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="ga752b0b1b5ba9009bc09976494313e30d"></a><!-- doxytag: member="wdt.h::WDTO_4S" ref="ga752b0b1b5ba9009bc09976494313e30d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_4S 8</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> Note: This is only available on the ATtiny2313, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861, ATmega48, ATmega88, ATmega168, ATmega48P, ATmega88P, ATmega168P, ATmega328P, ATmega164P, ATmega324P, ATmega644P, ATmega644, ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561, ATmega8HVA, ATmega16HVA, ATmega32HVB, ATmega406, ATmega1284P, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, AT90PWM81, AT90USB82, AT90USB162, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATtiny48, ATtiny88. </p>
</div>
</div>
<a class="anchor" id="gacf89fc5fb6c8aa9efaadb86872cfbcdf"></a><!-- doxytag: member="wdt.h::WDTO_500MS" ref="gacf89fc5fb6c8aa9efaadb86872cfbcdf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_500MS 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="ga7a5b072c51c05a34cc38111f0e6724e5"></a><!-- doxytag: member="wdt.h::WDTO_60MS" ref="ga7a5b072c51c05a34cc38111f0e6724e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_60MS 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><code>WDT0_15MS</code> </p>
</div>
</div>
<a class="anchor" id="gaf074e538b2a1d5031931530f29a09fce"></a><!-- doxytag: member="wdt.h::WDTO_8S" ref="gaf074e538b2a1d5031931530f29a09fce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WDTO_8S 9</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <code>WDT0_15MS</code> Note: This is only available on the ATtiny2313, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861, ATmega48, ATmega88, ATmega168, ATmega48P, ATmega88P, ATmega168P, ATmega328P, ATmega164P, ATmega324P, ATmega644P, ATmega644, ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561, ATmega8HVA, ATmega16HVA, ATmega32HVB, ATmega406, ATmega1284P, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, AT90PWM81, AT90USB82, AT90USB162, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATtiny48, ATtiny88. </p>
</div>
</div>
</div>
<hr width="80%">
<p><center>Automatically generated by Doxygen 1.6.1 on 30 Nov 2009.</center></p>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
73443d16ffe49ffcb4131bf0d8d1b044
>
files
>
114
