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
195
196
197
198
199
200
201
202
203
204
|
/************************************************************************
* sched/wdog/wdog.h
*
* Copyright (C) 2007, 2009, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************/
#ifndef __SCHED_WDOG_WDOG_H
#define __SCHED_WDOG_WDOG_H
/************************************************************************
* Included Files
************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
#include <stdbool.h>
#include <nuttx/compiler.h>
#include <nuttx/wdog.h>
/************************************************************************
* Pre-processor Definitions
************************************************************************/
/* Configuration ********************************************************/
#ifndef CONFIG_PREALLOC_WDOGS
# define CONFIG_PREALLOC_WDOGS 32
#endif
#ifndef CONFIG_WDOG_INTRESERVE
# if CONFIG_PREALLOC_WDOGS > 16
# define CONFIG_WDOG_INTRESERVE 4
# elif CONFIG_PREALLOC_WDOGS > 8
# define CONFIG_WDOG_INTRESERVE 2
# else
# define CONFIG_WDOG_INTRESERVE 1
# endif
#endif
#if CONFIG_WDOG_INTRESERVE >= CONFIG_PREALLOC_WDOGS
# error CONFIG_WDOG_INTRESERVE >= CONFIG_PREALLOC_WDOGS
#endif
/* Watchdog Definitions *************************************************/
/* Flag bits for the flags field of struct wdog_s */
#define WDOGF_ACTIVE (1 << 0) /* Watchdog is actively timing */
#define WDOGF_ALLOCED (1 << 1) /* 0:Pre-allocated, 1:Allocated */
#define WDOG_SETACTIVE(w) do { (w)->flags |= WDOGF_ACTIVE; } while (0)
#define WDOG_SETALLOCED(w) do { (w)->flags |= WDOGF_ALLOCED; } while (0)
#define WDOG_CLRACTIVE(w) do { (w)->flags &= ~WDOGF_ACTIVE; } while (0)
#define WDOG_CLRALLOCED(w) do { (w)->flags &= ~WDOGF_ALLOCED; } while (0)
#define WDOG_ISACTIVE(w) (((w)->flags & WDOGF_ACTIVE) != 0)
#define WDOG_ISALLOCED(w) (((w)->flags & WDOGF_ALLOCED) != 0)
/************************************************************************
* Public Type Declarations
************************************************************************/
/* This is the watchdog structure. The WDOG_ID is a pointer to a
* watchdog structure.
*/
struct wdog_s
{
FAR struct wdog_s *next; /* Support for singly linked lists. */
wdentry_t func; /* Function to execute when delay expires */
#ifdef CONFIG_PIC
FAR void *picbase; /* PIC base address */
#endif
int lag; /* Timer associated with the delay */
uint8_t flags; /* See WDOGF_* definitions above */
uint8_t argc; /* The number of parameters to pass */
uint32_t parm[CONFIG_MAX_WDOGPARMS];
};
typedef struct wdog_s wdog_t;
/************************************************************************
* Public Variables
************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/* The g_wdfreelist data structure is a singly linked list of watchdogs
* available to the system for delayed function use.
*/
extern sq_queue_t g_wdfreelist;
/* The g_wdactivelist data structure is a singly linked list ordered by
* watchdog expiration time. When watchdog timers expire,the functions on
* this linked list are removed and the function is called.
*/
extern sq_queue_t g_wdactivelist;
/* This is the number of free, pre-allocated watchdog structures in the
* g_wdfreelist. This value is used to enforce a reserve for interrupt
* handlers.
*/
extern uint16_t g_wdnfree;
/************************************************************************
* Public Function Prototypes
************************************************************************/
/************************************************************************
* Name: wd_initialize
*
* Description:
* This function initializes the watchdog data structures
*
* Parameters:
* None
*
* Return Value:
* None
*
* Assumptions:
* This function must be called early in the initialization sequence
* before the timer interrupt is attached and before any watchdog
* services are used.
*
************************************************************************/
void weak_function wd_initialize(void);
/****************************************************************************
* Name: wd_timer
*
* Description:
* This function is called from the timer interrupt handler to determine
* if it is time to execute a watchdog function. If so, the watchdog
* function will be executed in the context of the timer interrupt
* handler.
*
* Parameters:
* ticks - If CONFIG_SCHED_TICKLESS is defined then the number of ticks
* in the the interval that just expired is provided. Otherwise,
* this function is called on each timer interrupt and a value of one
* is implicit.
*
* Return Value:
* If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the
* next delay is provided (zero if no delay). Otherwise, this function
* has no returned value.
*
* Assumptions:
* Called from interrupt handler logic with interrupts disabled.
*
****************************************************************************/
#ifdef CONFIG_SCHED_TICKLESS
unsigned int wd_timer(int ticks);
#else
void wd_timer(void);
#endif
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __SCHED_WDOG_WDOG_H */
|
