1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/* watchdog.h
*
* This include file contains all the constants and structures associated
* with watchdog timers. This Handler provides mechanisms which can be
* used to initialize and manipulate watchdog timers.
*
* COPYRIGHT (c) 1989-1997.
* On-Line Applications Research Corporation (OAR).
* Copyright assigned to U.S. Government, 1994.
*
* The license and distribution terms for this file may in
* the file LICENSE in this distribution or at
* http://www.OARcorp.com/rtems/license.html.
*
* $Id$
*/
#ifndef __WATCHDOG_h
#define __WATCHDOG_h
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/score/object.h>
/*
* The following type defines the control block used to manage
* intervals.
*/
typedef unsigned32 Watchdog_Interval;
/*
* The following types define a pointer to a watchdog service routine.
*/
typedef void Watchdog_Service_routine;
typedef Watchdog_Service_routine ( *Watchdog_Service_routine_entry )(
Objects_Id,
void *
);
/*
* Constant for indefinite wait. (actually an illegal interval)
*/
#define WATCHDOG_NO_TIMEOUT 0
/*
* The following enumerated type lists the states in which a
* watchdog timer may be at any given time.
*/
typedef enum {
WATCHDOG_INACTIVE, /* off all chains */
WATCHDOG_BEING_INSERTED, /* off all chains, searching for insertion point */
WATCHDOG_ACTIVE, /* on chain, allowed to fire */
WATCHDOG_REMOVE_IT /* on chain, remove without firing if expires */
} Watchdog_States;
/*
* The following enumerated type details the manner in which
* a watchdog chain may be adjusted by the Watchdog_Adjust
* routine. The direction indicates a movement FORWARD
* or BACKWARD in time.
*/
typedef enum {
WATCHDOG_FORWARD, /* adjust delta value forward */
WATCHDOG_BACKWARD /* adjust delta value backward */
} Watchdog_Adjust_directions;
/*
* The following record defines the control block used
* to manage each watchdog timer.
*/
typedef struct {
Chain_Node Node;
Watchdog_States state;
Watchdog_Interval initial;
Watchdog_Interval delta_interval;
Watchdog_Interval start_time;
Watchdog_Interval stop_time;
Watchdog_Service_routine_entry routine;
Objects_Id id;
void *user_data;
} Watchdog_Control;
/*
* The following are used for synchronization purposes
* during an insert on a watchdog delta chain.
*/
SCORE_EXTERN volatile unsigned32 _Watchdog_Sync_level;
SCORE_EXTERN volatile unsigned32 _Watchdog_Sync_count;
/*
* The following contains the number of ticks since the
* system was booted.
*/
SCORE_EXTERN Watchdog_Interval _Watchdog_Ticks_since_boot;
/*
* The following defines the watchdog chains which are managed
* on ticks and second boundaries.
*/
SCORE_EXTERN Chain_Control _Watchdog_Ticks_chain;
SCORE_EXTERN Chain_Control _Watchdog_Seconds_chain;
/*
* _Watchdog_Handler_initialization
*
* DESCRIPTION:
*
* This routine initializes the watchdog handler. The watchdog
* synchronization flag is initialized and the watchdog chains are
* initialized and emptied.
*/
void _Watchdog_Handler_initialization( void );
/*
* _Watchdog_Remove
*
* DESCRIPTION:
*
* This routine removes THE_WATCHDOG from the watchdog chain on which
* it resides and returns the state THE_WATCHDOG timer was in.
*/
Watchdog_States _Watchdog_Remove (
Watchdog_Control *the_watchdog
);
/*
* _Watchdog_Adjust
*
* DESCRIPTION:
*
* This routine adjusts the HEADER watchdog chain in the forward
* or backward DIRECTION for UNITS ticks.
*/
void _Watchdog_Adjust (
Chain_Control *header,
Watchdog_Adjust_directions direction,
Watchdog_Interval units
);
/*
* _Watchdog_Insert
*
* DESCRIPTION:
*
* This routine inserts THE_WATCHDOG into the HEADER watchdog chain
* for a time of UNITS. The INSERT_MODE indicates whether
* THE_WATCHDOG is to be activated automatically or later, explicitly
* by the caller.
*
*/
void _Watchdog_Insert (
Chain_Control *header,
Watchdog_Control *the_watchdog
);
/*
* _Watchdog_Tickle
*
* DESCRIPTION:
*
* This routine is invoked at appropriate intervals to update
* the HEADER watchdog chain.
*/
void _Watchdog_Tickle (
Chain_Control *header
);
#ifndef __RTEMS_APPLICATION__
#include <rtems/score/watchdog.inl>
#endif
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
