1 | /* SPDX-License-Identifier: BSD-2-Clause */ |
---|
2 | |
---|
3 | /** |
---|
4 | * @file |
---|
5 | * |
---|
6 | * This file describes the Watchdog Driver for all boards. |
---|
7 | * A watchdog is a hardware device that will reset the board |
---|
8 | * if not touched in a specific way at a regular interval. |
---|
9 | * It is a simple, yet important, part of many embedded systems. |
---|
10 | */ |
---|
11 | |
---|
12 | /* |
---|
13 | * |
---|
14 | * COPYRIGHT (c) 1989-2008. |
---|
15 | * On-Line Applications Research Corporation (OAR). |
---|
16 | * |
---|
17 | * Redistribution and use in source and binary forms, with or without |
---|
18 | * modification, are permitted provided that the following conditions |
---|
19 | * are met: |
---|
20 | * 1. Redistributions of source code must retain the above copyright |
---|
21 | * notice, this list of conditions and the following disclaimer. |
---|
22 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
23 | * notice, this list of conditions and the following disclaimer in the |
---|
24 | * documentation and/or other materials provided with the distribution. |
---|
25 | * |
---|
26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
27 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
28 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
29 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
30 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
31 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
32 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
33 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
34 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
35 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
36 | * POSSIBILITY OF SUCH DAMAGE. |
---|
37 | */ |
---|
38 | |
---|
39 | #ifndef _RTEMS_WATCHDOGDRV_H |
---|
40 | #define _RTEMS_WATCHDOGDRV_H |
---|
41 | |
---|
42 | #ifdef __cplusplus |
---|
43 | extern "C" { |
---|
44 | #endif |
---|
45 | |
---|
46 | /** |
---|
47 | * This macro defines the watchdog device driver entry points. |
---|
48 | */ |
---|
49 | #define WATCHDOG_DRIVER_TABLE_ENTRY \ |
---|
50 | { Watchdog_initialize, NULL, NULL, NULL, NULL, Watchdog_control } |
---|
51 | |
---|
52 | /** |
---|
53 | * @brief Watchdog Driver Initialization |
---|
54 | * |
---|
55 | * This method initializes the watchdog hardware device. The device |
---|
56 | * should be initialized as DISABLED since BSP initialization may |
---|
57 | * take longer than the timeout period for the watchdog. |
---|
58 | * |
---|
59 | * @param[in] major is the watchdog device major number |
---|
60 | * @param[in] minor is the watchdog device minor number |
---|
61 | * @param[in] arguments points to device driver arguments |
---|
62 | */ |
---|
63 | rtems_device_driver Watchdog_initialize( |
---|
64 | rtems_device_major_number major, |
---|
65 | rtems_device_minor_number minor, |
---|
66 | void *arguments |
---|
67 | ); |
---|
68 | |
---|
69 | /** |
---|
70 | * @brief Watchdog Driver IO Control |
---|
71 | * |
---|
72 | * This method implements the IO Control device driver entry |
---|
73 | * point for the watchdog hardware device. |
---|
74 | * |
---|
75 | * @param[in] major is the watchdog device major number |
---|
76 | * @param[in] minor is the watchdog device minor number |
---|
77 | * @param[in] arguments points to device driver arguments |
---|
78 | */ |
---|
79 | rtems_device_driver Watchdog_control( |
---|
80 | rtems_device_major_number major, |
---|
81 | rtems_device_minor_number minor, |
---|
82 | void *arguments |
---|
83 | ); |
---|
84 | |
---|
85 | #ifdef __cplusplus |
---|
86 | } |
---|
87 | #endif |
---|
88 | |
---|
89 | #endif |
---|
90 | /* end of include file */ |
---|