lucidac.cpp

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 <lucidac/lucidac.h>
#include <utils/mac.h>
 
FLASHMEM platform::LUCIDAC::LUCIDAC(LUCIDAC_HAL *hardware)
    : Carrier({Cluster(0)}, hardware), hardware(hardware) {}
 
FLASHMEM bool platform::LUCIDAC::init() {
  if (!Carrier::init())
    return false;
 
  LOG(ANABRID_DEBUG_INIT, "Detecting front panel...");
  if (!front_panel) {
    front_panel = entities::detect<LUCIDACFrontPanel>(bus::address_from_tuple(2, 0));
    if (!front_panel) {
      LOG_ALWAYS("Warning: Front panel is missing or unknown.");
    }
  }
 
  LOG(ANABRID_DEBUG_INIT, "Initialising detected front panel...");
  if (front_panel && !front_panel->init()) {
    // return false; // No, this is NOT fatal. Continue working.
    LOG_ALWAYS("Error: Could not initialize front panel");
  }
  LOG(ANABRID_DEBUG_INIT, "Front panel initialized.");
 
  return utils::status::success();
}
 
FLASHMEM void platform::LUCIDAC::reset(entities::ResetAction action) {
  Carrier::reset(action);
  if (front_panel)
    front_panel->reset(action);
 
  if (action.has(entities::ResetAction::CIRCUIT_RESET)) {
    reset_acl_select();
    reset_adc_channels();
  }
}
 
FLASHMEM std::vector<entities::Entity *> platform::LUCIDAC::get_child_entities() {
  auto entities = this->Carrier::get_child_entities();
  if (front_panel)
    entities.push_back(front_panel);
  return entities;
}
 
FLASHMEM entities::Entity *platform::LUCIDAC::get_child_entity(const std::string &child_id) {
  if (child_id == "FP")
    return front_panel;
  return this->carrier::Carrier::get_child_entity(child_id);
}
 
FLASHMEM utils::status platform::LUCIDAC::write_to_hardware() {
  utils::status error = Carrier::write_to_hardware();
  if (front_panel)
    front_panel->write_to_hardware().attach_to(error, "Front Panel write failed.");
  if (!hardware->write_acl(acl_select))
    error.attach(1 << 5, "Write ACL failed");
  return error;
}
 
FLASHMEM const std::array<platform::LUCIDAC::ACL, 8> &platform::LUCIDAC::get_acl_select() const {
  return acl_select;
}
 
FLASHMEM void platform::LUCIDAC::set_acl_select(const std::array<ACL, 8> &acl_select_) {
  acl_select = acl_select_;
}
 
FLASHMEM bool platform::LUCIDAC::set_acl_select(uint8_t idx, LUCIDAC::ACL acl) {
  if (idx >= acl_select.size())
    return false;
  acl_select[idx] = acl;
  return true;
}
 
FLASHMEM void platform::LUCIDAC::reset_acl_select() {
  std::fill(acl_select.begin(), acl_select.end(), ACL::INTERNAL_);
}
 
FLASHMEM bool platform::LUCIDAC::calibrate_routes() {
  auto old_acl_selection = get_acl_select();
  reset_acl_select();
  if (!hardware->write_acl(acl_select))
    return false;
 
  if (!Carrier::calibrate_routes())
    return false;
 
  set_acl_select(old_acl_selection);
  return hardware->write_acl(acl_select);
}
 
FLASHMEM utils::status platform::LUCIDAC::config_self_from_json(JsonObjectConst cfg) {
  auto res = Carrier::config_self_from_json(cfg);
  if (!res)
    return res;
 
  for (auto cfgItr = cfg.begin(); cfgItr != cfg.end(); ++cfgItr) {
    if (cfgItr->key() == "adc_channels") {
      auto res = _config_adc_from_json(cfgItr->value());
      if (!res)
        return utils::status(530, "Could not configure ADCs from configuration.");
    } else if (cfgItr->key() == "acl_select") {
      auto res = _config_acl_from_json(cfgItr->value());
      if (!res)
        return utils::status(531, "Could not configure ACLs from configuration.");
    } else if (strlen(cfgItr->key().c_str()) >= 1 && cfgItr->key().c_str()[0] == '/') {
      // An sub-entity is refered to. This is already handled by
      // config_from_json() towards the children so it is ignored here.
    } else {
      return utils::status(532, "LUCIDAC: Unknown configuration key");
    }
  }
 
  return utils::status::success();
}
 
FLASHMEM bool platform::LUCIDAC::_config_adc_from_json(const JsonVariantConst &cfg) {
  if (!cfg.is<JsonArrayConst>())
    return false;
 
  auto cfg_adc_channels = cfg.as<JsonArrayConst>();
  for (size_t i = 0; i < cfg_adc_channels.size() && i < adc_channels.size(); i++) {
    adc_channels[i] = cfg_adc_channels[i].isNull() ? ADC_CHANNEL_DISABLED : cfg_adc_channels[i];
  }
  return hardware->write_adc_bus_mux(adc_channels);
}
 
FLASHMEM bool platform::LUCIDAC::_config_acl_from_json(const JsonVariantConst &cfg) {
  if (!cfg.is<JsonArrayConst>())
    return false;
 
  auto cfg_acl_select = cfg.as<JsonArrayConst>();
  for (size_t i = 0; i < cfg_acl_select.size() && i < acl_select.size(); i++) {
    if (cfg_acl_select[i] == "internal") {
      acl_select[i] = ACL::INTERNAL_;
    } else if (cfg_acl_select[i] == "external") {
      acl_select[i] = ACL::EXTERNAL_;
    } else {
      LOG_ALWAYS("platform::LUCIDAC::config_self_from_json: Expected acl_select[i] to be either 'internal' "
                 "or 'external' string")
      return false;
    }
  }
  return hardware->write_acl(acl_select);
}
 
FLASHMEM void platform::LUCIDAC::config_self_to_json(JsonObject &cfg) {
  // TODO: This code is very quick and dirty. Use JSON custom converters to make nicer.
 
  auto cfg_adc_channels = cfg.createNestedArray("adc_channels");
  auto cfg_acl_select = cfg.createNestedArray("acl_select");
 
  for (size_t i = 0; i < adc_channels.size(); i++) {
    if (adc_channels[i] == ADC_CHANNEL_DISABLED)
      cfg_adc_channels.add(nullptr); // json "none"
    else
      cfg_adc_channels.add(adc_channels[i]);
  }
 
  for (size_t i = 0; i < acl_select.size(); i++)
    cfg_acl_select.add(acl_select[i] == ACL::INTERNAL_ ? "internal" : "external");
}