mblock_mul.h

Go to the documentation of this file.

// Copyright (c) 2024 anabrid GmbH
// Contact: https://www.anabrid.com/licensing/
// SPDX-License-Identifier: MIT OR GPL-2.0-or-later
#pragma once
 
#include <bitset>
 
#include <block/mblock_mul.h>
 
#include <chips/AD840X.h>
#include <chips/DAC60508.h>
#include <chips/SR74HC16X.h>
#include <entity/hardware.h>
 
namespace blocks {
 
using MMulBlockHAL_Parent = entities::EntitySharedHardware<MMulBlockHAL>;
 
class MMulBlockHAL_FullAutoCalibration : public MMulBlockHAL {
public:
  virtual bool write_calibration_gain(uint8_t idx, uint8_t gain) = 0;
};
 
class MMulBlockHAL_V_1_0_X : public MMulBlockHAL_Parent {
protected:
  const functions::TriggerFunction f_overload_flags_reset;
  const functions::SR74HC16X f_overload_flags;
  const functions::DAC60508 f_calibration_dac_0;
  const functions::DAC60508 f_calibration_dac_1;
 
public:
  explicit MMulBlockHAL_V_1_0_X(bus::addr_t block_address);
 
  bool init() override;
 
public:
  bool write_calibration_input_offsets(uint8_t idx, uint16_t offset_x, uint16_t offset_y) override;
  bool write_calibration_output_offset(uint8_t idx, uint16_t offset_z) override;
 
  static constexpr float MIN_OFFSET = -0.1f;
  static constexpr float MAX_OFFSET = +0.1f;

  static float raw_to_float_calibration(uint16_t raw) {
    return map(static_cast<float>(raw), functions::DAC60508::RAW_ZERO, functions::DAC60508::RAW_MAX,
               MAX_OFFSET, MIN_OFFSET);
  }

  static uint16_t float_to_raw_calibration(float value) {
    return static_cast<uint16_t>(roundf(
        map(value, MIN_OFFSET, MAX_OFFSET, functions::DAC60508::RAW_MAX, functions::DAC60508::RAW_ZERO)));
  }
 
  static constexpr inline uint16_t RAW_ZERO = functions::DAC60508::RAW_ZERO;
  static constexpr inline uint16_t RAW_MAX = functions::DAC60508::RAW_MAX;
 
  std::bitset<8> read_overload_flags() override;
  void reset_overload_flags() override;
};
 
class MMulBlockHAL_V_1_M1_X : public MMulBlockHAL_V_1_0_X, public MMulBlockHAL_FullAutoCalibration {
protected:
  functions::AD8402 f_gain_ch0_1;
  functions::AD8402 f_gain_ch2_3;
 
public:
  explicit MMulBlockHAL_V_1_M1_X(bus::addr_t block_address);
 
  bool write_calibration_gain(uint8_t idx, uint8_t gain) override;
 
  std::bitset<8> read_overload_flags() override { return MMulBlockHAL_V_1_0_X::read_overload_flags(); }
 
  void reset_overload_flags() override { MMulBlockHAL_V_1_0_X::reset_overload_flags(); }
 
  bool write_calibration_input_offsets(uint8_t idx, uint16_t offset_x, uint16_t offset_y) override {
    return MMulBlockHAL_V_1_0_X::write_calibration_input_offsets(idx, offset_x, offset_y);
  }
 
  bool write_calibration_output_offset(uint8_t idx, uint16_t offset_z) override {
    return MMulBlockHAL_V_1_0_X::write_calibration_output_offset(idx, offset_z);
  }
 
  float read_temperature() const override { return MMulBlockHAL_V_1_0_X::read_temperature(); };
};
 
class MMulBlockHAL_V_1_1_X : public MMulBlockHAL_V_1_0_X, public MMulBlockHAL_FullAutoCalibration {
protected:
  functions::AD8403 f_gain;
 
public:
  explicit MMulBlockHAL_V_1_1_X(bus::addr_t block_address);
 
  bool write_calibration_gain(uint8_t idx, uint8_t gain) override;
 
  std::bitset<8> read_overload_flags() override { return MMulBlockHAL_V_1_0_X::read_overload_flags(); }
 
  void reset_overload_flags() override { MMulBlockHAL_V_1_0_X::reset_overload_flags(); }
 
  bool write_calibration_input_offsets(uint8_t idx, uint16_t offset_x, uint16_t offset_y) override {
    return MMulBlockHAL_V_1_0_X::write_calibration_input_offsets(idx, offset_x, offset_y);
  }
 
  bool write_calibration_output_offset(uint8_t idx, uint16_t offset_z) override {
    return MMulBlockHAL_V_1_0_X::write_calibration_output_offset(idx, offset_z);
  }
 
  float read_temperature() const override { return MMulBlockHAL_V_1_0_X::read_temperature(); };
};
 
class MMulBlock_FullAutoCalibration : public MMulBlock {
public:
  MMulBlock_FullAutoCalibration(SLOT slot, blocks::MMulBlockHAL_FullAutoCalibration *hardware);
 
public:
  status calibrate(platform::Cluster *cluster, carrier::Carrier *carrier) override;
  status write_calibration_to_hardware() override;
 
protected:
  MMulBlockHAL_FullAutoCalibration *hardware;
};
 
} // namespace blocks