ic_haus_registers.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <nlohmann/json_fwd.hpp>
#include <span>
#include <string>
#include <string_view>
 
namespace mm::node::somanet {
 
 
enum class IcHausChip : uint8_t {
  kIcMu,   
  kIcPvl,  
};
 
constexpr std::string_view toString(IcHausChip chip) {
  switch (chip) {
    case IcHausChip::kIcMu:
      return "iC-MU";
    case IcHausChip::kIcPvl:
      return "iC-PVL";
  }
  return "unknown";
}
 
struct IcHausField {
  std::string_view name;  
 
  std::string_view bits;
 
  std::string_view description;  
};
 
void to_json(nlohmann::json& j, const IcHausField& field);
 
inline constexpr size_t kMaxFieldsPerRegister = 8;
 
struct IcHausRegister {
  uint8_t address = 0;  
 
  uint8_t lastAddress = 0;
 
  bool reserved = false;  
 
  bool spiOnly = false;
 
  std::array<IcHausField, kMaxFieldsPerRegister> fields{};  
  uint8_t fieldCount = 0;  
 
  std::span<const IcHausField> namedFields() const { return {fields.data(), fieldCount}; }
 
  std::string layout() const;
};
 
void to_json(nlohmann::json& j, const IcHausRegister& r);
 
struct IcHausRegisterSpace {
  IcHausChip chip{IcHausChip::kIcMu};
  std::string_view name;  
 
  std::string_view addressing;
 
  std::span<const IcHausRegister> registers;
};
 
void to_json(nlohmann::json& j, const IcHausRegisterSpace& space);
 
std::span<const IcHausRegisterSpace> icHausRegisterSpaces();
 
}  // namespace mm::node::somanet