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
205
206
|
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012,2013 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT 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 General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file timcap.h
* @brief TIMCAP Driver macros and structures.
*
* @addtogroup TIMCAP
* @{
*/
#ifndef _TIMCAP_H_
#define _TIMCAP_H_
#include "ch.h"
#include "hal.h"
#if (HAL_USE_TIMCAP == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Driver state machine possible states.
*/
typedef enum {
TIMCAP_UNINIT = 0, /**< Not initialized. */
TIMCAP_STOP = 1, /**< Stopped. */
TIMCAP_READY = 2, /**< Ready. */
TIMCAP_WAITING = 3, /**< Waiting first edge. */
TIMCAP_ACTIVE = 4, /**< Active cycle phase. */
TIMCAP_IDLE = 5, /**< Idle cycle phase. */
} timcapstate_t;
/**
* @brief Type of a structure representing an TIMCAP driver.
*/
typedef struct TIMCAPDriver TIMCAPDriver;
/**
* @brief TIMCAP notification callback type.
*
* @param[in] timcapp pointer to a @p TIMCAPDriver object
*/
typedef void (*timcapcallback_t)(TIMCAPDriver *timcapp);
#include "hal_timcap_lld.h"
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions
* @{
*/
/**
* @brief Enables the input capture.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @iclass
*/
#define timcapEnableI(timcapp) timcap_lld_enable(timcapp)
/**
* @brief Disables the input capture.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @iclass
*/
#define timcapDisableI(timcapp) timcap_lld_disable(timcapp)
/** @} */
/**
* @name Low Level driver helper macros
* @{
*/
/**
* @brief Common ISR code, TIMCAP channel 1 event.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @notapi
*/
#define _timcap_isr_invoke_channel1_cb(timcapp) { \
timcapstate_t previous_state = (timcapp)->state; \
(timcapp)->state = TIMCAP_ACTIVE; \
if (previous_state != TIMCAP_WAITING) \
(timcapp)->config->capture_cb_array[0](timcapp); \
}
/**
* @brief Common ISR code, TIMCAP channel 2 event.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @notapi
*/
#define _timcap_isr_invoke_channel2_cb(timcapp) { \
timcapstate_t previous_state = (timcapp)->state; \
(timcapp)->state = TIMCAP_ACTIVE; \
if (previous_state != TIMCAP_WAITING) \
(timcapp)->config->capture_cb_array[1](timcapp); \
}
/**
* @brief Common ISR code, TIMCAP channel 3 event.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @notapi
*/
#define _timcap_isr_invoke_channel3_cb(timcapp) { \
timcapstate_t previous_state = (timcapp)->state; \
(timcapp)->state = TIMCAP_ACTIVE; \
if (previous_state != TIMCAP_WAITING) \
(timcapp)->config->capture_cb_array[2](timcapp); \
}
/**
* @brief Common ISR code, TIMCAP channel 4 event.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @notapi
*/
#define _timcap_isr_invoke_channel4_cb(timcapp) { \
timcapstate_t previous_state = (timcapp)->state; \
(timcapp)->state = TIMCAP_ACTIVE; \
if (previous_state != TIMCAP_WAITING) \
(timcapp)->config->capture_cb_array[3](timcapp); \
}
/**
* @brief Common ISR code, TIMCAP timer overflow event.
*
* @param[in] timcapp pointer to the @p TIMCAPDriver object
*
* @notapi
*/
#define _timcap_isr_invoke_overflow_cb(timcapp) { \
(timcapp)->config->overflow_cb(timcapp); \
}
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void timcapInit(void);
void timcapObjectInit(TIMCAPDriver *timcapp);
void timcapStart(TIMCAPDriver *timcapp, const TIMCAPConfig *config);
void timcapStop(TIMCAPDriver *timcapp);
void timcapEnable(TIMCAPDriver *timcapp);
void timcapDisable(TIMCAPDriver *timcapp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_TIMCAP */
#endif /* _TIMCAP_H_ */
/** @} */
|
