blob: ad635b0f87583c4305ea02faf599e34aa75c5868 (
plain)
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
|
#ifndef _TOT_H
#define _TOT_H
/*!
* Time-out timer.
*
* This is a simple time-out timer for ensuring a maximum transmission
* time is observed. The time-out timer is configured with a total time
* in "ticks", which get counted down in an interrupt.
*
* When the "warning" level is reached, a flag is repeatedly set permit
* triggering of LEDs/sounds to warn the user that time is nearly up.
*
* Upon timeout, a separate flag is set to indicate timeout has taken
* place.
*
* Author Stuart Longland <[email protected]>
* Copyright (C) 2015 FreeDV project.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 2.1,
* as published by the Free Software Foundation. This program is
* distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, see
* <http://www.gnu.org/licenses/>.
*/
#include <stdint.h>
/*!
* Time-out timer state machine
*/
struct tot_t {
/*!
* Number of ticks remaining, if non-zero, transmission is
* in progress.
*/
uint32_t remaining;
/*!
* Number of ticks remaining, before next warning.
*/
uint32_t warn_remain;
/*!
* Timeout timer tick period. Used to reset the ticks counter.
*/
uint32_t tick_period;
/*!
* Number of ticks between the remaining warnings.
*/
uint16_t remain_warn_ticks;
/*!
* Event tick timer. Used to slow down the source timer.
*/
uint16_t ticks;
/*!
* Event flags.
*/
uint16_t event;
};
/*!
* Time-out timer has been started.
*/
#define TOT_EVT_START (1 << 0)
/*!
* Start of warning period reached.
*/
#define TOT_EVT_WARN (1 << 1)
/*!
* Next warning is due.
*/
#define TOT_EVT_WARN_NEXT (1 << 2)
/*!
* Time-out reached.
*/
#define TOT_EVT_TIMEOUT (1 << 3)
/*!
* Timer sequence complete
*/
#define TOT_EVT_DONE (1 << 4)
/*!
* Reset the time-out timer. This zeroes the counter and event flags.
*/
void tot_reset(struct tot_t * const tot);
/*!
* Start the time-out timer ticking.
*/
void tot_start(struct tot_t * const tot, uint32_t tot_ticks,
uint16_t warn_ticks);
/*!
* Count a time-out timer tick.
*/
static inline void tot_tick(struct tot_t * const tot)
{
if (tot->ticks)
tot->ticks--;
}
/*!
* Update the time-out timer state.
*/
void tot_update(struct tot_t * const tot);
#endif
|
