ublock.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 <block/ublock.h>
#include <chips/SR74HCT595.h>
#include <entity/hardware.h>
#include <utils/logging.h>
 
namespace functions {
 
class UMatrixFunction : public functions::DataFunction {
public:
  static const SPISettings DEFAULT_SPI_SETTINGS;
 
  using DataFunction::DataFunction;
  explicit UMatrixFunction(bus::addr_t address);
 
  template <size_t num_of_outputs>
  [[nodiscard]] bool transfer(const std::array<int8_t, num_of_outputs> &outputs) const;
};
 
} // namespace functions
 
namespace blocks {
 
using UBlockHAL_Parent = entities::EntitySharedHardware<UBlockHAL>;
 
class UBlockHAL_Common : public UBlockHAL_Parent {
protected:
  const functions::UMatrixFunction f_umatrix;
  const functions::TriggerFunction f_umatrix_sync;
  // Reset disables all output, but rest of logic is unchanged according to datasheet.
  // But I don't really know what that means. Data is still shifted out after a reset
  // and the enable-bits in the data are still set.
  // The datasheet calls the RESET pin OUTPUT ENABLE, so it probably is simply that.
  // Meaning it is completely useless.
  // const functions::TriggerFunction f_umatrix_reset;
 
  // TODO
  const functions::SR74HCT595 f_transmission_mode_register;
  const functions::TriggerFunction f_transmission_mode_sync;
  const functions::TriggerFunction f_transmission_mode_reset;
 
public:
  explicit UBlockHAL_Common(bus::addr_t block_address, uint8_t f_umatrix_cs, uint8_t f_umatrix_sync_cs,
                            uint8_t f_transmission_mode_register_cs, uint8_t f_transmission_mode_sync_cs,
                            uint8_t f_transmission_mode_reset_cs);
 
  bool write_outputs(std::array<int8_t, 32> outputs) override;
  bool write_transmission_modes_and_ref(std::pair<Transmission_Mode, Transmission_Mode> modes,
                                        Reference_Magnitude ref) override;
  void reset_transmission_modes_and_ref() override;
 
};
 
class UBlockHAL_V_1_2_X : public UBlockHAL_Common {
public:
  explicit UBlockHAL_V_1_2_X(const bus::addr_t block_address)
      : UBlockHAL_Common(block_address, 5, 6, 2, 3, 4){};
};
 
} // namespace blocks
 
// Include template definitions
#include "ublock.tpl.h"