redac.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 "block/teensy/icmd.h"
#include "redac/redac.h"
#include "tblock.h"
 
namespace platform {
 
using REDAC_HAL_Parent = entities::EntitySharedHardware<REDAC_HAL>;
 
 
class ADCFunction_V_1_0_X {
  static constexpr uint8_t ADC_PRG_FADDR = 0;
  static constexpr uint8_t ADC_RESET_FADDR = 1;
  static constexpr uint8_t ADC_STROBE_FADDR = 2;
 
  static const SPISettings F_ADC_SWITCHER_PRG_SPI_SETTINGS;
 
  const functions::ICommandRegisterFunction f_switcher_prg;
  const functions::TriggerFunction f_switcher_reset;
  const functions::TriggerFunction f_switcher_sync;
 
public:
  explicit ADCFunction_V_1_0_X(uint8_t cluster_idx):
      f_switcher_prg(bus::idx_to_addr(cluster_idx, bus::REDAC_ADC_PSEUDO_BLOCK_IDX, ADC_PRG_FADDR), 15, F_ADC_SWITCHER_PRG_SPI_SETTINGS),
     f_switcher_reset(bus::idx_to_addr(cluster_idx, bus::REDAC_ADC_PSEUDO_BLOCK_IDX, ADC_RESET_FADDR)),
     f_switcher_sync(bus::idx_to_addr(cluster_idx, bus::REDAC_ADC_PSEUDO_BLOCK_IDX, ADC_STROBE_FADDR)) {}
 
  [[nodiscard]] bool write(uint8_t channel, uint8_t output_idx) const {
    auto cmd = decltype(f_switcher_prg)::chip_cmd_word(channel, output_idx);
 
    if (!f_switcher_prg.transfer8(cmd))
      return false;
 
    f_switcher_sync.trigger();
    return true;
  }
 
  void trigger() {
    f_switcher_reset.trigger();
  }
};
 
class REDAC_HAL_V_1_0_X : public REDAC_HAL_Parent {
public:
  REDAC_HAL_V_1_0_X();
 
  uint16_t read_backplane_and_slot_id() const override;
 
  bool write_adc_bus_mux(const std::array<carrier::ADCChannel, 8> &channels) override;
  void reset_adc_bus_mux() override;
 
private:
  void set_standby(bool enabled) override;
 
public:
  // Function addresses
  static constexpr uint8_t METADATA_FADDR = bus::METADATA_FUNC_IDX;
  static constexpr uint8_t TEMPERATURE_FADDR = 1;
  static constexpr uint8_t STANDBY_SET_FADDR = 3;
  static constexpr uint8_t STANDBY_UNSET_FADDR = 2;
 
  static const SPISettings BP_REDAC_ID_SPI_SETTINGS;
  static constexpr uint8_t BP_REDAC_ID_FADDR = 2;
 
protected:
  const functions::DataFunction bp_redac_id;
 
  // Functions to configure ADC signal switching matrices
  const functions::TriggerFunction f_set_standby;
  const functions::TriggerFunction f_unset_standby;
 
  ADCFunction_V_1_0_X adc_functions[3];
};
 
class REDAC_HAL_V_1_1_X : public REDAC_HAL_V_1_0_X {
public:
  REDAC_HAL_V_1_1_X();
 
  static constexpr uint8_t FP_SR_CLR = 4;
  static constexpr uint8_t FP_SR_STO = 5;
  static constexpr uint8_t FP_SR = 6;
 
  bool write_fp_control_register(uint16_t state);
 
protected:
  const functions::SR74HCT595 fp_control; // Shift register for controlling mRedac front panel I/Os
  const functions::TriggerFunction fp_control_reset;
  const functions::TriggerFunction fp_control_sync;
};
 
class REDAC_V_1_1_X : public REDAC {
public:
  explicit REDAC_V_1_1_X(REDAC_HAL_V_1_1_X *hardware);
 
  enum FrontPanelIOMode : uint8_t { ANALOG_OUT = 0b00000, ANALOG_IN = 0b00001, DIGITAL_OUT = 0b10000, DIGITAL_IN = 0b10001 };
 
  // Sets to mode of the four I/O connections on the mREDAC front.
  // Be aware that only IO0 can be configured as digital in and only IO1-IO3 can be configured as digital out.
  //
  // Available mapping:
  // Analog signals:
  // IO0: Analog in/out cluster 0, lane 28
  // IO1: Analog in/out cluster 0, lane 29
  // IO2: Analog in/out cluster 0, lane 30
  // IO3: Analog in/out cluster 0, lane 31
  //
  // Digital signals:
  // IO0: Digital in, EXTHALT
  // IO1: Digital out PIN_DIO_6 (custom)
  // IO2: Digital out ModeIC
  // IO3: Digital out ModeOP
  bool set_io_mode(uint8_t io_number, FrontPanelIOMode mode);
  FrontPanelIOMode get_io_mode(uint8_t io_number) const;
 
  // Sets the direction of the bidirectional DIO lines available on this board.
  // Possible dio lines are 12, 13, 28 and 7.
  // This feature doesn't get used right now.
  bool set_DIO_direction(uint8_t dio_number, bool input_from_ctrl_block);
  // Returns true if the designated line is an input viewed from the ctrl block side.
  // Possible dio lines are 12, 13, 28 and 7.
  bool get_DIO_direction(uint8_t dio_number) const;
 
  UnitResult write_to_hardware() override;
 
protected:
  uint16_t fp_control_sr_state;
 
  REDAC_HAL_V_1_1_X *hardware;
};
 
} // namespace platform