Example watchdog
This is a guide to the watchdog C example project included in the EMAC OE SDK.
A watchdog timer (WDT) is a hardware circuit that can reset the computer system in case of a software fault. This is an example test for the Linux watchdog API.
For more information about the protocol see the following page: http://en.wikipedia.org/wiki/Watchdog_timer
The watchdog project builds one executable: watchdog-test.
Opening, Building and Uploading the Project Files
For information on opening the project from within Eclipse, please see Importing the EMAC OE SDK Projects with Eclipse. Then, follow Using the EMAC OE SDK Projects with Eclipse for information on how to build, upload and execute the example.
Alternatively, the Makefile can be used with the make command from the commandline to build and upload the example. For more information on this method, please see Using EMAC OE SDK Example Projects.
Usage and Behavior
A watchdog timer is a hardware circuit that can reset the computer system in case of a software fault. The watchdog-test application can enable, disable, activate, configure and interrupt the watchdog timer.
| NOTE |
| Activating watchdog invokes system reset (after timeout) |
Hardware Requirements
watchdog will run on any system for which it can be compiled and implements the standard Linux watchdog API.
watchdog Usage
root@emac-oe:~# ./watchdog-test [-det] - -d
- Disable watchdog.
- -e
- Enable watchdog.
- -t
- Set the watchdog timeout (to a value specified in code. Default is five seconds).
Usage Example. Activating watchdog with a periodic interrupt
This will activate watchdog and initiate a periodic interrupt to keep it from timing out.
root@emac-oe:/tmp# ./watchdog-test Watchdog Ticking Away!
Every second watchdog-test is sending an IOCTL to the watchdog driver, which in turn ticks watchdog to reset its internal timer so it doesn't timeout and trigger a system reset.
Now we will stop interrupting watchdog and let it trigger a computer reset by pressing Ctrl+C.
Usage Example. Disabling watchdog
root@emac-oe:/tmp# ./watchdog-test -d Watchdog card disabled.
After running the ./watchdog-test -d command, the program exits normally.
Usage Example. Enabling watchdog
This will enable and activate watchdog but it won't perform a periodic timeout interrupt (see the first usage example, above). So when you run it the program activates watchdog and then watchdog resets the system.
root@emac-oe:/tmp# ./watchdog-test -e Watchdog card enabled.
After running the ./watchdog-test -e command, the system resets.
Usage Example. Setting watchdog timeout
This will activate watchdog and set it to timeout in 5 seconds.
root@emac-oe:/tmp# ./watchdog-test -t Watchdog timeout set to 5 seconds!
After running the ./watchdog-test -t command, the program exits normally. Once it exits, 5 seconds will elapse, and then the system resets.
Summary
The watchdog C example project demonstrates how to use the watchdog timer. The watchdog timer is there to help ensure that your system will return to a functional state should your program get stuck while executing.
EMAC provides examples of how to enable, disable, activate, configure and interrupt the watchdog hardware circuit. To use watchdog peripheral in Linux you will need a watchdog driver, and a watchdog device file. A device file is a special kind of virtual file which marks the device node in your root filesystem. Normally it's called /dev/watchdog .
