blob: 6a97ddaedb37304a89270c2d997ac130e4a1fab1 (
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
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
|
/*
ChibiOS - Copyright (C) 2006..2018 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_sensors.h
* @brief Generic sensors interface header.
*
* @addtogroup HAL_SENSORS
* @{
*/
#ifndef HAL_SENSORS_H
#define HAL_SENSORS_H
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief BaseSensor specific methods.
*/
#define _base_sensor_methods_alone \
/* Get number of channels.*/ \
size_t (*get_channels_number)(void *instance); \
/* Reads the sensor raw data.*/ \
msg_t (*read_raw)(void *instance, int32_t axes[]); \
/* Reads the sensor returning normalized data.*/ \
msg_t (*read_cooked)(void *instance, float axes[]);
/**
* @brief BaseSensor specific methods with inherited ones.
*/
#define _base_sensor_methods \
_base_sensor_methods_alone
/**
* @brief @p BaseSensor virtual methods table.
*/
struct BaseSensorVMT {
_base_sensor_methods
};
/**
* @brief @p BaseSensor specific data.
* @note It is empty because @p BaseSensor is only an interface
* without implementation.
*/
#define _base_sensor_data
/**
* @brief Base stream class.
* @details This class represents a generic blocking unbuffered sequential
* data stream.
*/
typedef struct {
/** @brief Virtual Methods Table.*/
const struct BaseSensorVMT *vmt_sensor;
_base_sensor_data
} BaseSensor;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions (BaseSensor)
* @{
*/
/**
* @brief Sensors get channels number.
*
* @param[in] ip pointer to a @p BaseSensor or derived class.
* @return The number of channels of the BaseSensor
*
* @api
*/
#define sensorGetChannelNumber(ip) (ip)->vmt_sensor->get_channels_number(ip)
/**
* @brief Sensors read raw data.
*
* @param[in] ip pointer to a @p BaseSensor or derived 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 sensorReadRaw(ip, dp) (ip)->vmt_sensor->read_raw(ip, dp)
/**
* @brief Sensors read cooked data.
*
* @param[in] ip pointer to a @p BaseSensor or derived 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 sensorReadCooked(ip, dp) (ip)->vmt_sensor->read_cooked(ip, dp)
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
#endif /* HAL_SENSORS_H */
/** @} */
|
