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
 
#include <algorithm>
#include <bitset>
 
#include "block/mblock.h"
 
#include <chips/AD840X.h>
#include <chips/DAC60508.h>
#include <chips/SR74HC16X.h>
#include <chips/SR74HCT595.h>
#include <entity/meta.h>
 
namespace blocks {
 
// TODO: Change this comment -- This is rather a MUL4 not MUL8
//
// ███    ███ ██    ██ ██       █████       ██████ ██       █████  ███████ ███████
// ████  ████ ██    ██ ██      ██   ██     ██      ██      ██   ██ ██      ██
// ██ ████ ██ ██    ██ ██       █████      ██      ██      ███████ ███████ ███████
// ██  ██  ██ ██    ██ ██      ██   ██     ██      ██      ██   ██      ██      ██
// ██      ██  ██████  ███████  █████       ██████ ███████ ██   ██ ███████ ███████
 
class MMulBlockHAL_V_1_0_X : public MMulBlockHAL {
protected:
  const metadata::MetadataEditor f_meta;
  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);
 
  metadata::eui_t get_entity_eui() const override { return f_meta.read_eui(); }
 
  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);
  }
 
  std::bitset<8> read_overload_flags() override;
  void reset_overload_flags() override;
};
 
class MMulBlockHAL_V_1_M1_X : public MMulBlockHAL_V_1_0_X {
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);
};
 
class MMulBlock_FullAutoCalibration : public MMulBlock {
public:
  MMulBlock_FullAutoCalibration(SLOT slot, blocks::MMulBlockHAL_V_1_M1_X *hardware);
 
public:
  bool calibrate(platform::Cluster *cluster, carrier::Carrier *carrier) override;
  utils::status write_calibration_to_hardware() override;
 
protected:
  MMulBlockHAL_V_1_M1_X *hardware;
};
 
} // namespace blocks