move HAL and tests folder

2022-07-18 08:59:40 +02:00
parent 3686bbc486
commit 6f7be281ef
229 changed files with 494 additions and 559 deletions
--- a/src/fsfw_hal/devicehandlers/devicedefinitions/GyroL3GD20Definitions.h
+++ b/src/fsfw_hal/devicehandlers/devicedefinitions/GyroL3GD20Definitions.h
@ -0,0 +1,133 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_
+
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+
+#include <cstdint>
+
+namespace L3GD20H {
+
+/* Actual size is 15 but we round up a bit */
+static constexpr size_t MAX_BUFFER_SIZE = 16;
+
+static constexpr uint8_t READ_MASK = 0b10000000;
+
+static constexpr uint8_t AUTO_INCREMENT_MASK = 0b01000000;
+
+static constexpr uint8_t WHO_AM_I_REG = 0b00001111;
+static constexpr uint8_t WHO_AM_I_VAL = 0b11010111;
+
+/*------------------------------------------------------------------------*/
+/* Control registers */
+/*------------------------------------------------------------------------*/
+static constexpr uint8_t CTRL_REG_1 = 0b00100000;
+static constexpr uint8_t CTRL_REG_2 = 0b00100001;
+static constexpr uint8_t CTRL_REG_3 = 0b00100010;
+static constexpr uint8_t CTRL_REG_4 = 0b00100011;
+static constexpr uint8_t CTRL_REG_5 = 0b00100100;
+
+/* Register 1 */
+static constexpr uint8_t SET_DR_1 = 1 << 7;
+static constexpr uint8_t SET_DR_0 = 1 << 6;
+static constexpr uint8_t SET_BW_1 = 1 << 5;
+static constexpr uint8_t SET_BW_0 = 1 << 4;
+static constexpr uint8_t SET_POWER_NORMAL_MODE = 1 << 3;
+static constexpr uint8_t SET_Z_ENABLE = 1 << 2;
+static constexpr uint8_t SET_X_ENABLE = 1 << 1;
+static constexpr uint8_t SET_Y_ENABLE = 1;
+
+static constexpr uint8_t CTRL_REG_1_VAL =
+    SET_POWER_NORMAL_MODE | SET_Z_ENABLE | SET_Y_ENABLE | SET_X_ENABLE;
+
+/* Register 2 */
+static constexpr uint8_t EXTERNAL_EDGE_ENB = 1 << 7;
+static constexpr uint8_t LEVEL_SENSITIVE_TRIGGER = 1 << 6;
+static constexpr uint8_t SET_HPM_1 = 1 << 5;
+static constexpr uint8_t SET_HPM_0 = 1 << 4;
+static constexpr uint8_t SET_HPCF_3 = 1 << 3;
+static constexpr uint8_t SET_HPCF_2 = 1 << 2;
+static constexpr uint8_t SET_HPCF_1 = 1 << 1;
+static constexpr uint8_t SET_HPCF_0 = 1;
+
+static constexpr uint8_t CTRL_REG_2_VAL = 0b00000000;
+
+/* Register 3 */
+static constexpr uint8_t CTRL_REG_3_VAL = 0b00000000;
+
+/* Register 4 */
+static constexpr uint8_t SET_BNU = 1 << 7;
+static constexpr uint8_t SET_BLE = 1 << 6;
+static constexpr uint8_t SET_FS_1 = 1 << 5;
+static constexpr uint8_t SET_FS_0 = 1 << 4;
+static constexpr uint8_t SET_IMP_ENB = 1 << 3;
+static constexpr uint8_t SET_SELF_TEST_ENB_1 = 1 << 2;
+static constexpr uint8_t SET_SELF_TEST_ENB_0 = 1 << 1;
+static constexpr uint8_t SET_SPI_IF_SELECT = 1;
+
+/* Enable big endian data format */
+static constexpr uint8_t CTRL_REG_4_VAL = SET_BLE;
+
+/* Register 5 */
+static constexpr uint8_t SET_REBOOT_MEM = 1 << 7;
+static constexpr uint8_t SET_FIFO_ENB = 1 << 6;
+
+static constexpr uint8_t CTRL_REG_5_VAL = 0b00000000;
+
+/* Possible range values in degrees per second (DPS). */
+static constexpr uint16_t RANGE_DPS_00 = 245;
+static constexpr float SENSITIVITY_00 = 8.75 * 0.001;
+static constexpr uint16_t RANGE_DPS_01 = 500;
+static constexpr float SENSITIVITY_01 = 17.5 * 0.001;
+static constexpr uint16_t RANGE_DPS_11 = 2000;
+static constexpr float SENSITIVITY_11 = 70.0 * 0.001;
+
+static constexpr uint8_t READ_START = CTRL_REG_1;
+static constexpr size_t READ_LEN = 14;
+
+/* Indexing */
+static constexpr uint8_t REFERENCE_IDX = 6;
+static constexpr uint8_t TEMPERATURE_IDX = 7;
+static constexpr uint8_t STATUS_IDX = 8;
+static constexpr uint8_t OUT_X_H = 9;
+static constexpr uint8_t OUT_X_L = 10;
+static constexpr uint8_t OUT_Y_H = 11;
+static constexpr uint8_t OUT_Y_L = 12;
+static constexpr uint8_t OUT_Z_H = 13;
+static constexpr uint8_t OUT_Z_L = 14;
+
+/*------------------------------------------------------------------------*/
+/* Device Handler specific */
+/*------------------------------------------------------------------------*/
+static constexpr DeviceCommandId_t READ_REGS = 0;
+static constexpr DeviceCommandId_t CONFIGURE_CTRL_REGS = 1;
+static constexpr DeviceCommandId_t READ_CTRL_REGS = 2;
+
+static constexpr uint32_t GYRO_DATASET_ID = READ_REGS;
+
+enum GyroPoolIds : lp_id_t { ANG_VELOC_X, ANG_VELOC_Y, ANG_VELOC_Z, TEMPERATURE };
+
+}  // namespace L3GD20H
+
+class GyroPrimaryDataset : public StaticLocalDataSet<5> {
+ public:
+  /** Constructor  for data users like controllers */
+  GyroPrimaryDataset(object_id_t mgmId)
+      : StaticLocalDataSet(sid_t(mgmId, L3GD20H::GYRO_DATASET_ID)) {
+    setAllVariablesReadOnly();
+  }
+
+  /* Angular velocities in degrees per second (DPS) */
+  lp_var_t<float> angVelocX = lp_var_t<float>(sid.objectId, L3GD20H::ANG_VELOC_X, this);
+  lp_var_t<float> angVelocY = lp_var_t<float>(sid.objectId, L3GD20H::ANG_VELOC_Y, this);
+  lp_var_t<float> angVelocZ = lp_var_t<float>(sid.objectId, L3GD20H::ANG_VELOC_Z, this);
+  lp_var_t<float> temperature = lp_var_t<float>(sid.objectId, L3GD20H::TEMPERATURE, this);
+
+ private:
+  friend class GyroHandlerL3GD20H;
+  /** Constructor  for the data creator */
+  GyroPrimaryDataset(HasLocalDataPoolIF* hkOwner)
+      : StaticLocalDataSet(hkOwner, L3GD20H::GYRO_DATASET_ID) {}
+};
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_ */
--- a/src/fsfw_hal/devicehandlers/devicedefinitions/MgmLIS3HandlerDefs.h
+++ b/src/fsfw_hal/devicehandlers/devicedefinitions/MgmLIS3HandlerDefs.h
@ -0,0 +1,163 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_
+
+#include <fsfw/datapoollocal/LocalPoolVariable.h>
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+
+#include <cstdint>
+
+namespace MGMLIS3MDL {
+
+enum Set { ON, OFF };
+enum OpMode { LOW, MEDIUM, HIGH, ULTRA };
+
+enum Sensitivies : uint8_t { GAUSS_4 = 4, GAUSS_8 = 8, GAUSS_12 = 12, GAUSS_16 = 16 };
+
+/* Actually 15, we just round up a bit */
+static constexpr size_t MAX_BUFFER_SIZE = 16;
+
+/* Field data register scaling */
+static constexpr uint8_t GAUSS_TO_MICROTESLA_FACTOR = 100;
+static constexpr float FIELD_LSB_PER_GAUSS_4_SENS = 1.0 / 6842.0;
+static constexpr float FIELD_LSB_PER_GAUSS_8_SENS = 1.0 / 3421.0;
+static constexpr float FIELD_LSB_PER_GAUSS_12_SENS = 1.0 / 2281.0;
+static constexpr float FIELD_LSB_PER_GAUSS_16_SENS = 1.0 / 1711.0;
+
+static const DeviceCommandId_t READ_CONFIG_AND_DATA = 0x00;
+static const DeviceCommandId_t SETUP_MGM = 0x01;
+static const DeviceCommandId_t READ_TEMPERATURE = 0x02;
+static const DeviceCommandId_t IDENTIFY_DEVICE = 0x03;
+static const DeviceCommandId_t TEMP_SENSOR_ENABLE = 0x04;
+static const DeviceCommandId_t ACCURACY_OP_MODE_SET = 0x05;
+
+/* Number of all control registers */
+static const uint8_t NR_OF_CTRL_REGISTERS = 5;
+/* Number of registers in the MGM */
+static const uint8_t NR_OF_REGISTERS = 19;
+/* Total number of adresses for all registers */
+static const uint8_t TOTAL_NR_OF_ADRESSES = 52;
+static const uint8_t NR_OF_DATA_AND_CFG_REGISTERS = 14;
+static const uint8_t TEMPERATURE_REPLY_LEN = 3;
+static const uint8_t SETUP_REPLY_LEN = 6;
+
+/*------------------------------------------------------------------------*/
+/* Register adresses */
+/*------------------------------------------------------------------------*/
+/* Register adress returns identifier of device with default 0b00111101 */
+static const uint8_t IDENTIFY_DEVICE_REG_ADDR = 0b00001111;
+static const uint8_t DEVICE_ID = 0b00111101;  // Identifier for Device
+
+/* Register adress to access register 1 */
+static const uint8_t CTRL_REG1 = 0b00100000;
+/* Register adress to access register 2 */
+static const uint8_t CTRL_REG2 = 0b00100001;
+/* Register adress to access register 3 */
+static const uint8_t CTRL_REG3 = 0b00100010;
+/* Register adress to access register 4 */
+static const uint8_t CTRL_REG4 = 0b00100011;
+/* Register adress to access register 5 */
+static const uint8_t CTRL_REG5 = 0b00100100;
+
+/* Register adress to access status register */
+static const uint8_t STATUS_REG_IDX = 8;
+static const uint8_t STATUS_REG = 0b00100111;
+
+/* Register adress to access low byte of x-axis */
+static const uint8_t X_LOWBYTE_IDX = 9;
+static const uint8_t X_LOWBYTE = 0b00101000;
+/* Register adress to access high byte of x-axis */
+static const uint8_t X_HIGHBYTE_IDX = 10;
+static const uint8_t X_HIGHBYTE = 0b00101001;
+/* Register adress to access low byte of y-axis */
+static const uint8_t Y_LOWBYTE_IDX = 11;
+static const uint8_t Y_LOWBYTE = 0b00101010;
+/* Register adress to access high byte of y-axis */
+static const uint8_t Y_HIGHBYTE_IDX = 12;
+static const uint8_t Y_HIGHBYTE = 0b00101011;
+/* Register adress to access low byte of z-axis */
+static const uint8_t Z_LOWBYTE_IDX = 13;
+static const uint8_t Z_LOWBYTE = 0b00101100;
+/* Register adress to access high byte of z-axis */
+static const uint8_t Z_HIGHBYTE_IDX = 14;
+static const uint8_t Z_HIGHBYTE = 0b00101101;
+
+/* Register adress to access low byte of temperature sensor */
+static const uint8_t TEMP_LOWBYTE = 0b00101110;
+/* Register adress to access high byte of temperature sensor */
+static const uint8_t TEMP_HIGHBYTE = 0b00101111;
+
+/*------------------------------------------------------------------------*/
+/* Initialize Setup Register set bits                                     */
+/*------------------------------------------------------------------------*/
+/* General transfer bits */
+// Read=1 / Write=0 Bit
+static const uint8_t RW_BIT = 7;
+// Continous Read/Write Bit, increment adress
+static const uint8_t MS_BIT = 6;
+
+/* CTRL_REG1 bits */
+static const uint8_t ST = 0;  // Self test enable bit, enabled = 1
+// Enable rates higher than 80 Hz enabled = 1
+static const uint8_t FAST_ODR = 1;
+static const uint8_t DO0 = 2;      // Output data rate bit 2
+static const uint8_t DO1 = 3;      // Output data rate bit 3
+static const uint8_t DO2 = 4;      // Output data rate bit 4
+static const uint8_t OM0 = 5;      // XY operating mode bit 5
+static const uint8_t OM1 = 6;      // XY operating mode bit 6
+static const uint8_t TEMP_EN = 7;  // Temperature sensor enable enabled = 1
+static const uint8_t CTRL_REG1_DEFAULT =
+    (1 << TEMP_EN) | (1 << OM1) | (1 << DO0) | (1 << DO1) | (1 << DO2);
+
+/* CTRL_REG2 bits */
+// reset configuration registers and user registers
+static const uint8_t SOFT_RST = 2;
+static const uint8_t REBOOT = 3;  // reboot memory content
+static const uint8_t FSO = 5;     // full-scale selection bit 5
+static const uint8_t FS1 = 6;     // full-scale selection bit 6
+static const uint8_t CTRL_REG2_DEFAULT = 0;
+
+/* CTRL_REG3 bits */
+static const uint8_t MD0 = 0;  // Operating mode bit 0
+static const uint8_t MD1 = 1;  // Operating mode bit 1
+// SPI serial interface mode selection enabled = 3-wire-mode
+static const uint8_t SIM = 2;
+static const uint8_t LP = 5;  // low-power mode
+static const uint8_t CTRL_REG3_DEFAULT = 0;
+
+/* CTRL_REG4 bits */
+// big/little endian data selection enabled = MSb at lower adress
+static const uint8_t BLE = 1;
+static const uint8_t OMZ0 = 2;  // Z operating mode bit 2
+static const uint8_t OMZ1 = 3;  // Z operating mode bit 3
+static const uint8_t CTRL_REG4_DEFAULT = (1 << OMZ1);
+
+/* CTRL_REG5 bits */
+static const uint8_t BDU = 6;        // Block data update
+static const uint8_t FAST_READ = 7;  // Fast read enabled = 1
+static const uint8_t CTRL_REG5_DEFAULT = 0;
+
+static const uint32_t MGM_DATA_SET_ID = READ_CONFIG_AND_DATA;
+
+enum MgmPoolIds : lp_id_t {
+  FIELD_STRENGTH_X,
+  FIELD_STRENGTH_Y,
+  FIELD_STRENGTH_Z,
+  TEMPERATURE_CELCIUS
+};
+
+class MgmPrimaryDataset : public StaticLocalDataSet<4> {
+ public:
+  MgmPrimaryDataset(HasLocalDataPoolIF* hkOwner) : StaticLocalDataSet(hkOwner, MGM_DATA_SET_ID) {}
+
+  MgmPrimaryDataset(object_id_t mgmId) : StaticLocalDataSet(sid_t(mgmId, MGM_DATA_SET_ID)) {}
+
+  lp_var_t<float> fieldStrengthX = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_X, this);
+  lp_var_t<float> fieldStrengthY = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_Y, this);
+  lp_var_t<float> fieldStrengthZ = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_Z, this);
+  lp_var_t<float> temperature = lp_var_t<float>(sid.objectId, TEMPERATURE_CELCIUS, this);
+};
+
+}  // namespace MGMLIS3MDL
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_ */
--- a/src/fsfw_hal/devicehandlers/devicedefinitions/MgmRM3100HandlerDefs.h
+++ b/src/fsfw_hal/devicehandlers/devicedefinitions/MgmRM3100HandlerDefs.h
@ -0,0 +1,124 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_
+
+#include <fsfw/datapoollocal/LocalPoolVariable.h>
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+#include <fsfw/serialize/SerialLinkedListAdapter.h>
+
+#include <cstdint>
+
+namespace RM3100 {
+
+/* Actually 10, we round up a little bit */
+static constexpr size_t MAX_BUFFER_SIZE = 12;
+
+static constexpr uint8_t READ_MASK = 0x80;
+
+/*----------------------------------------------------------------------------*/
+/* CMM Register */
+/*----------------------------------------------------------------------------*/
+static constexpr uint8_t SET_CMM_CMZ = 1 << 6;
+static constexpr uint8_t SET_CMM_CMY = 1 << 5;
+static constexpr uint8_t SET_CMM_CMX = 1 << 4;
+static constexpr uint8_t SET_CMM_DRDM = 1 << 2;
+static constexpr uint8_t SET_CMM_START = 1;
+static constexpr uint8_t CMM_REGISTER = 0x01;
+
+static constexpr uint8_t CMM_VALUE =
+    SET_CMM_CMZ | SET_CMM_CMY | SET_CMM_CMX | SET_CMM_DRDM | SET_CMM_START;
+
+/*----------------------------------------------------------------------------*/
+/* Cycle count register */
+/*----------------------------------------------------------------------------*/
+// Default value (200)
+static constexpr uint8_t CYCLE_COUNT_VALUE = 0xC8;
+
+static constexpr float DEFAULT_GAIN = static_cast<float>(CYCLE_COUNT_VALUE) / 100 * 38;
+static constexpr uint8_t CYCLE_COUNT_START_REGISTER = 0x04;
+
+/*----------------------------------------------------------------------------*/
+/* TMRC register */
+/*----------------------------------------------------------------------------*/
+static constexpr uint8_t TMRC_150HZ_VALUE = 0x94;
+static constexpr uint8_t TMRC_75HZ_VALUE = 0x95;
+static constexpr uint8_t TMRC_DEFAULT_37HZ_VALUE = 0x96;
+
+static constexpr uint8_t TMRC_REGISTER = 0x0B;
+static constexpr uint8_t TMRC_DEFAULT_VALUE = TMRC_DEFAULT_37HZ_VALUE;
+
+static constexpr uint8_t MEASUREMENT_REG_START = 0x24;
+static constexpr uint8_t BIST_REGISTER = 0x33;
+static constexpr uint8_t DATA_READY_VAL = 0b10000000;
+static constexpr uint8_t STATUS_REGISTER = 0x34;
+static constexpr uint8_t REVID_REGISTER = 0x36;
+
+// Range in Microtesla. 1 T equals 10000 Gauss (for comparison with LIS3 MGM)
+static constexpr uint16_t RANGE = 800;
+
+static constexpr DeviceCommandId_t READ_DATA = 0;
+
+static constexpr DeviceCommandId_t CONFIGURE_CMM = 1;
+static constexpr DeviceCommandId_t READ_CMM = 2;
+
+static constexpr DeviceCommandId_t CONFIGURE_TMRC = 3;
+static constexpr DeviceCommandId_t READ_TMRC = 4;
+
+static constexpr DeviceCommandId_t CONFIGURE_CYCLE_COUNT = 5;
+static constexpr DeviceCommandId_t READ_CYCLE_COUNT = 6;
+
+class CycleCountCommand : public SerialLinkedListAdapter<SerializeIF> {
+ public:
+  CycleCountCommand(bool oneCycleCount = true) : oneCycleCount(oneCycleCount) {
+    setLinks(oneCycleCount);
+  }
+
+  ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
+                            Endianness streamEndianness) override {
+    ReturnValue_t result = SerialLinkedListAdapter::deSerialize(buffer, size, streamEndianness);
+    if (oneCycleCount) {
+      cycleCountY = cycleCountX;
+      cycleCountZ = cycleCountX;
+    }
+    return result;
+  }
+
+  SerializeElement<uint16_t> cycleCountX;
+  SerializeElement<uint16_t> cycleCountY;
+  SerializeElement<uint16_t> cycleCountZ;
+
+ private:
+  void setLinks(bool oneCycleCount) {
+    setStart(&cycleCountX);
+    if (not oneCycleCount) {
+      cycleCountX.setNext(&cycleCountY);
+      cycleCountY.setNext(&cycleCountZ);
+    }
+  }
+
+  bool oneCycleCount;
+};
+
+static constexpr uint32_t MGM_DATASET_ID = READ_DATA;
+
+enum MgmPoolIds : lp_id_t {
+  FIELD_STRENGTH_X,
+  FIELD_STRENGTH_Y,
+  FIELD_STRENGTH_Z,
+};
+
+class Rm3100PrimaryDataset : public StaticLocalDataSet<3> {
+ public:
+  Rm3100PrimaryDataset(HasLocalDataPoolIF* hkOwner) : StaticLocalDataSet(hkOwner, MGM_DATASET_ID) {}
+
+  Rm3100PrimaryDataset(object_id_t mgmId) : StaticLocalDataSet(sid_t(mgmId, MGM_DATASET_ID)) {}
+
+  // Field strengths in micro Tesla.
+  lp_var_t<float> fieldStrengthX = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_X, this);
+  lp_var_t<float> fieldStrengthY = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_Y, this);
+  lp_var_t<float> fieldStrengthZ = lp_var_t<float>(sid.objectId, FIELD_STRENGTH_Z, this);
+};
+
+}  // namespace RM3100
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_ */