1 | /** |
---|
2 | * @file rtems/watchdogdrv.h |
---|
3 | * |
---|
4 | * This file describes the Watchdog Driver for all boards. |
---|
5 | * A watchdog is a hardware device that will reset the board |
---|
6 | * if not touched in a specific way at a regular interval. |
---|
7 | * It is a simple, yet important, part of many embedded systems. |
---|
8 | */ |
---|
9 | |
---|
10 | /* |
---|
11 | * |
---|
12 | * COPYRIGHT (c) 1989-2008. |
---|
13 | * On-Line Applications Research Corporation (OAR). |
---|
14 | * |
---|
15 | * The license and distribution terms for this file may be |
---|
16 | * found in the file LICENSE in this distribution or at |
---|
17 | * http://www.rtems.org/license/LICENSE. |
---|
18 | */ |
---|
19 | |
---|
20 | #ifndef _RTEMS_WATCHDOGDRV_H |
---|
21 | #define _RTEMS_WATCHDOGDRV_H |
---|
22 | |
---|
23 | #ifdef __cplusplus |
---|
24 | extern "C" { |
---|
25 | #endif |
---|
26 | |
---|
27 | /** |
---|
28 | * This macro defines the watchdog device driver entry points. |
---|
29 | */ |
---|
30 | #define WATCHDOG_DRIVER_TABLE_ENTRY \ |
---|
31 | { Watchdog_initialize, NULL, NULL, NULL, NULL, Watchdog_control } |
---|
32 | |
---|
33 | /** |
---|
34 | * @brief Watchdog Driver Initialization |
---|
35 | * |
---|
36 | * This method initializes the watchdog hardware device. The device |
---|
37 | * should be initialized as DISABLED since BSP initialization may |
---|
38 | * take longer than the timeout period for the watchdog. |
---|
39 | * |
---|
40 | * @param[in] major is the watchdog device major number |
---|
41 | * @param[in] minor is the watchdog device minor number |
---|
42 | * @param[in] arguments points to device driver arguments |
---|
43 | */ |
---|
44 | rtems_device_driver Watchdog_initialize( |
---|
45 | rtems_device_major_number major, |
---|
46 | rtems_device_minor_number minor, |
---|
47 | void *arguments |
---|
48 | ); |
---|
49 | |
---|
50 | /** |
---|
51 | * @brief Watchdog Driver IO Control |
---|
52 | * |
---|
53 | * This method implements the IO Control device driver entry |
---|
54 | * point for the watchdog hardware device. |
---|
55 | * |
---|
56 | * @param[in] major is the watchdog device major number |
---|
57 | * @param[in] minor is the watchdog device minor number |
---|
58 | * @param[in] arguments points to device driver arguments |
---|
59 | */ |
---|
60 | rtems_device_driver Watchdog_control( |
---|
61 | rtems_device_major_number major, |
---|
62 | rtems_device_minor_number minor, |
---|
63 | void *arguments |
---|
64 | ); |
---|
65 | |
---|
66 | #ifdef __cplusplus |
---|
67 | } |
---|
68 | #endif |
---|
69 | |
---|
70 | #endif |
---|
71 | /* end of include file */ |
---|