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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/*
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file hal_gyroscope.h
* @brief Generic gyroscope interface header.
*
* @addtogroup HAL_GYROSCOPE
* @{
*/
#ifndef _HAL_GYROSCOPE_H_
#define _HAL_GYROSCOPE_H_
#include "hal_sensors.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief BaseGyroscope specific methods.
*/
#define _base_gyroscope_methods_alone \
/* Invoke the sample bias procedure.*/ \
msg_t (*sample_bias)(void *instance); \
/* Invoke the set bias procedure.*/ \
msg_t (*set_bias)(void *instance, int32_t biases[]); \
/* Remove bias stored data.*/ \
msg_t (*reset_bias)(void *instance); \
/* Invoke the set sensitivity procedure.*/ \
msg_t (*set_sensitivity)(void *instance, float sensitivities[]); \
/* Restore sensitivity stored data to default.*/ \
msg_t (*reset_sensitivity)(void *instance); \
/* Enable temperature drift effect compensation.*/ \
msg_t (*enable_temperature_compensation)(void *instance); \
/* Disable temperature drift effect compensation.*/ \
msg_t (*disable_temperature_compensation)(void *instance);
/**
* @brief BaseGyroscope specific methods with inherited ones.
*/
#define _base_gyroscope_methods \
_base_sensor_methods \
_base_gyroscope_methods_alone
/**
* @brief @p BaseGyroscope virtual methods table.
*/
struct BaseGyroscopeVMT {
_base_gyroscope_methods
};
/**
* @brief @p BaseGyroscope specific data.
*/
#define _base_gyroscope_data \
_base_sensor_data
/**
* @brief Base gyroscope class.
* @details This class represents a generic gyroscope.
*/
typedef struct {
/** @brief Virtual Methods Table.*/
const struct BaseGyroscopeVMT *vmt_basegyroscope;
_base_gyroscope_data
} BaseGyroscope;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions (BaseGyroscope)
* @{
*/
/**
* @brief Gyroscope get axes number.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
* @return The number of axes of the BaseSensor
*
* @api
*/
#define gyroscopeGetAxesNumber(ip) \
(ip)->vmt_basegyroscope->get_axes_number(ip)
/**
* @brief Gyroscope read raw data.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
* @param[in] dp pointer to a data array.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeReadRaw(ip, dp) \
(ip)->vmt_basegyroscope->read_raw(ip, dp)
/**
* @brief Gyroscope read cooked data.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
* @param[in] dp pointer to a data array.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeReadCooked(ip, dp) \
(ip)->vmt_basegyroscope->read_cooked(ip, dp)
/**
* @brief Gyroscope bias sampling procedure.
* @note During this procedure gyroscope must be kept hold in the rest
* position. Sampled bias will be automatically removed after
* calling this procedure.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeSampleBias(ip) \
(ip)->vmt_basegyroscope->sample_bias(ip)
/**
* @brief Updates gyroscope bias data from received buffer.
* @note The bias buffer must have the same length of the
* the gyroscope axes number.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
* @param[in] bp pointer to a buffer of bias values.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeSetBias(ip, bp) \
(ip)->vmt_basegyroscope->set_bias(ip, bp)
/**
* @brief Reset gyroscope bias data restoring it to zero.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeResetBias(ip) \
(ip)->vmt_basegyroscope->reset_bias(ip)
/**
* @brief Updates gyroscope sensitivity data from received buffer.
* @note The sensitivity buffer must have the same length of the
* the gyroscope axes number.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
* @param[in] sp pointer to a buffer of sensitivity values.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeSetSensitivity(ip, sp) \
(ip)->vmt_basegyroscope->set_sensitivity(ip, sp)
/**
* @brief Reset gyroscope sensitivity data restoring it to its typical
* value.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeResetSensitivity(ip) \
(ip)->vmt_basegyroscope->reset_sensitivity(ip)
/**
* @brief Enables data compensation removing temperature drift.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeEnableTempCompensation(ip) \
(ip)->vmt_basegyroscope->enable_temperature_compensation(ip)
/**
* @brief Disable data compensation.
*
* @param[in] ip pointer to a @p BaseGyroscope class.
*
* @return The operation status.
* @retval MSG_OK if the function succeeded.
* @retval MSG_RESET if one or more errors occurred.
*
* @api
*/
#define gyroscopeDisableTempCompensation(ip) \
(ip)->vmt_basegyroscope->disable_temperature_compensation(ip)
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
#endif /* _HAL_GYROSCOPE_H_ */
/** @} */
|
