blob: c557dc96f8ff70d5c65f0841730b44b2ceb25624 (
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
|
/*
ChibiOS - Copyright (C) 2016 Rocco Marco Guglielmi
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_accelerometer.h
* @brief Generic accelerometer interface header.
*
* @addtogroup HAL_ACCELEROMETER
* @{
*/
#ifndef _HAL_ACCELEROMETER_H_
#define _HAL_ACCELEROMETER_H_
#include "hal_sensors.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief BaseAccelerometer specific methods.
*/
#define _base_accelerometer_methods_alone
/**
* @brief BaseAccelerometer specific methods with inherited ones.
*/
#define _base_accelerometer_methods \
_base_sensor_methods \
_base_accelerometer_methods_alone
/**
* @brief @p BaseAccelerometer virtual methods table.
*/
struct BaseAccelerometerVMT {
_base_accelerometer_methods
};
/**
* @brief @p BaseAccelerometer specific data.
*/
#define _base_accelerometer_data \
_base_sensor_data
/**
* @brief Base accelerometer class.
* @details This class represents a generic a generic accelerometer.
*/
typedef struct {
/** @brief Virtual Methods Table.*/
const struct BaseAccelerometerVMT *vmt;
_base_sensor_data
} BaseAccelerometer;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions (BaseAccelerometer)
* @{
*/
/**
* @brief Accelerometer get axes number.
*
* @param[in] ip pointer to a @p BaseAccelerometer class.
* @return The number of axes of the BaseSensor
*
* @api
*/
#define accelerometerGetAxesNumber(ip) sensorGetAxesNumber(ip)
/**
* @brief Accelerometer read raw data.
*
* @param[in] ip pointer to a @p BaseAccelerometer 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 accelerometerReadRaw(ip, dp) sensorReadRaw(ip, dp)
/**
* @brief Accelerometer read cooked data.
*
* @param[in] ip pointer to a @p BaseAccelerometer 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 accelerometerReadCooked(ip, dp) sensorReadCooked(ip, dp)
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
#endif /* _HAL_ACCELEROMETER_H_ */
/** @} */
|
