VILLASnode/fpga/include/villas/fpga/ips/dino.hpp

/* Driver for wrapper around Dino
 *
 * Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
 * Author: Steffen Vogel <svogel2@eonerc.rwth-aachen.de>
 * SPDX-FileCopyrightText: 2024 Niklas Eiling
 * SPDX-FileCopyrightText: 2020 Institute for Automation of Complex Power Systems, RWTH Aachen University
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <villas/fpga/ips/i2c.hpp>
#include <villas/fpga/ips/register.hpp>
#include <villas/fpga/node.hpp>

namespace villas {
namespace fpga {
namespace ip {

class Dino : public Node {
public:
  friend class DinoFactory;
  union IoextPorts {
    struct __attribute__((packed)) {
      bool clk_dir : 1;
      bool data_dir : 1;
      bool status_led : 1;
      bool n_we : 1; // write enable (active low)
      bool input_zero : 1;
      bool sat_detect : 1;
      bool gain_lsb : 1;
      bool gain_msb : 1;
    } fields;
    uint8_t raw;

    friend std::ostream &operator<<(std::ostream &stream,
                                    const IoextPorts &ports) {
      return stream << "IoextPorts [clk_dir=" << ports.fields.clk_dir
                    << ", data_dir=" << ports.fields.data_dir
                    << ", status_led=" << ports.fields.status_led
                    << ", n_we=" << ports.fields.n_we
                    << ", input_zero=" << ports.fields.input_zero
                    << ", sat_detect=" << ports.fields.sat_detect
                    << ", gain_lsb=" << ports.fields.gain_lsb
                    << ", gain_msb=" << ports.fields.gain_msb << "]";
    }
    std::string toString() {
      std::stringstream s;
      s << *this;
      return s.str();
    }
  };
  enum Gain { GAIN_1 = 0, GAIN_2 = 1, GAIN_5 = 2, GAIN_10 = 3 };

  Dino();
  virtual ~Dino();
  virtual bool init() override;
  void setI2c(std::shared_ptr<I2c> i2cdev, uint8_t i2c_channel) {
    this->i2cdev = i2cdev;
    this->i2c_channel = i2c_channel;
  }
  virtual void configureHardware() = 0;

  static constexpr const char *masterPort = "M00_AXIS";
  static constexpr const char *slavePort = "S00_AXIS";

  const StreamVertex &getDefaultSlavePort() const override {
    return getSlavePort(slavePort);
  }

  const StreamVertex &getDefaultMasterPort() const override {
    return getMasterPort(masterPort);
  }

  IoextPorts getIoextDirectionRegister();
  IoextPorts getIoextOutputRegister();

protected:
  std::shared_ptr<I2c> i2cdev;
  uint8_t i2c_channel;
  bool configDone;

  IoextPorts getIoextDir();
  IoextPorts getIoextOut();
  void setIoextDir(IoextPorts ports);
  void setIoextOut(IoextPorts ports);
};

class DinoAdc : public Dino {
public:
  DinoAdc();
  virtual ~DinoAdc();
  virtual void configureHardware() override;

  /** Set the configuration of the ADC registers
   *
   * @param reg Register to set
   * @param sampleRate Sample rate in Hz. The default is 100 Hz.
   */
  static void setRegisterConfig(std::shared_ptr<Register> reg,
                                double sampleRate = (1 / 10e-3));

  static void setRegisterConfigTimestep(std::shared_ptr<Register> reg,
                                        double timestep = 10e-3) {
    setRegisterConfig(reg, 1 / timestep);
  }
};

class DinoDac : public Dino {
public:
  DinoDac();
  virtual ~DinoDac();
  virtual void configureHardware() override;
  void setGain(Gain gain);
  Gain getGain();
};

class DinoFactory : NodeFactory {
public:
  virtual std::string getDescription() const override {
    return "Dino Analog I/O";
  }

protected:
  virtual void parse(Core &ip, json_t *json) override;
};

class DinoAdcFactory : DinoFactory {
public:
  virtual std::string getName() const { return "dinoAdc"; }

private:
  virtual Vlnv getCompatibleVlnv() const {
    return Vlnv("xilinx.com:module_ref:dinoif_fast:");
  }
  Core *make() const { return new DinoAdc; };
};

class DinoDacFactory : DinoFactory {
public:
  virtual std::string getName() const { return "dinoDac"; }

private:
  virtual Vlnv getCompatibleVlnv() const {
    return Vlnv("xilinx.com:module_ref:dinoif_dac:");
  }
  Core *make() const { return new DinoDac; };
};

} // namespace ip
} // namespace fpga
} // namespace villas

#ifndef FMT_LEGACY_OSTREAM_FORMATTER
template <>
class fmt::formatter<villas::fpga::ip::Dino> : public fmt::ostream_formatter {};
template <>
class fmt::formatter<villas::fpga::ip::Dino::IoextPorts>
    : public fmt::ostream_formatter {};
#endif