diff options
| author | clyne <clyne@bitgloo.com> | 2021-03-21 16:34:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-21 16:34:21 -0400 |
| commit | 9b926b81ef1e8a4c7266494ae2a1369380e01b35 (patch) | |
| tree | 746095fa69eccccdc1c2830fdd0c06bac01848f5 /ChibiOS_20.3.2/os/ex/include/ex_sensors.h | |
| parent | e080a26651f90c88176140d63a74c93c2f4041a2 (diff) | |
| parent | a4f1482a8b23d5f761f60d6f3821c84190d89e2f (diff) | |
Merge pull request #3 from tcsullivan/stm32h7
Stm32h7
Diffstat (limited to 'ChibiOS_20.3.2/os/ex/include/ex_sensors.h')
| -rw-r--r-- | ChibiOS_20.3.2/os/ex/include/ex_sensors.h | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/ChibiOS_20.3.2/os/ex/include/ex_sensors.h b/ChibiOS_20.3.2/os/ex/include/ex_sensors.h new file mode 100644 index 0000000..3a0ef92 --- /dev/null +++ b/ChibiOS_20.3.2/os/ex/include/ex_sensors.h @@ -0,0 +1,151 @@ +/*
+ ChibiOS - Copyright (C) 2006..2018 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 ex_sensors.h
+ * @brief Generic sensors interface header.
+ *
+ * @addtogroup EX_SENSORS
+ * @{
+ */
+
+#ifndef EX_SENSORS_H
+#define EX_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_object_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
+ _base_object_data \
+
+/**
+ * @extends BaseObject
+ *
+ * @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;
+ _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->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->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->read_cooked(ip, dp)
+/** @} */
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* EX_SENSORS_H */
+
+/** @} */
|