cblock.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 <block/cblock.h>
#include <chips/AD5452.h>
#include <utils/logging.h>
 
#include "teensy/cblock.h"
 
blocks::CBlock *blocks::CBlock::from_entity_classifier(entities::EntityClassifier classifier,
                                                                const bus::addr_t block_address) {
  if (!classifier or classifier.class_enum != CLASS_ or classifier.type != TYPE)
    return nullptr;
 
  if (classifier.version < entities::Version(1, 0))
    return nullptr;
  if (classifier.version < entities::Version(1, 1)) {
    auto *new_block = new CBlock(new CBlockHAL_V_1_0_X(block_address));
    new_block->classifier = classifier;
    return new_block;
  }
  if (classifier.version < entities::Version(1, 2)) {
    auto *new_block = new CBlock(new CBlockHAL_V_1_1_X(block_address));
    new_block->classifier = classifier;
    return new_block;
  }
  if (classifier.version < entities::Version(1, 3)) {
    auto *new_block = new CBlock(new CBlockHAL_V_1_2_X(block_address));
    new_block->classifier = classifier;
    return new_block;
  }
 
  // Any unknown versuin results in a nullptr here.
  return nullptr;
}
 
std::array<functions::AD5452, 32> blocks::CBlockHAL_Common::make_f_coeffs(
    bus::addr_t block_address, std::array<const uint8_t, 32> f_coeffs_cs, uint8_t alt_function_idx) {
  return {functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[0]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[1]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[2]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[3]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[4]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[5]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[6]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[7]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[8]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[9]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[10]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[11]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[12]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[13]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[14]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[15]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[16]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[17]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[18]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[19]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[20]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[21]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[22]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[23]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[24]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[25]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[26]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[27]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[28]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[29]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[30]), alt_function_idx),
          functions::AD5452(bus::replace_function_idx(block_address, f_coeffs_cs[31]), alt_function_idx)};
}
 
 
blocks::CBlockHAL_Common::CBlockHAL_Common(bus::addr_t block_address, bus::addr_t temperature_sensor_address,
                                           std::array<const uint8_t, 32> f_coeffs_cs, uint8_t alt_function_idx)
    : blocks::CBlockHAL_Parent(/*f_meta*/ block_address,
                               /*temperature_sensor*/ temperature_sensor_address, alt_function_idx),
      f_coeffs(make_f_coeffs(block_address, f_coeffs_cs, alt_function_idx)) {}
 
bool blocks::CBlockHAL_Common::write_factor(uint8_t idx, float value) {
  if (idx >= 32)
    return false;
  // NOTE: The current hardware does not allow any error detection here.
  f_coeffs[idx].set_scale(value);
  return true;
}
 
blocks::CBlockHAL_V_1_0_X::CBlockHAL_V_1_0_X(bus::addr_t block_address)
    /*
     * Due to wrong order of connections on IC2, the addresses are mixed up
     * - FADDR[0...15] = CS[0...15] = [EEPROM, Coeffs[0...14]]
     * - FADDR[32+0...32+15] = CS[16...31] = Coeffs[15...30]
     * - FADDR[16+0...16+3] = CS[32+0...32+3] = [Coeff31, TMP127, UNUSED, UNUSED]
     * - but also FADDR[16+4+0...16+4+3] = FADDR[16+8+0...16+8+3] = FADDR[16+8+4+0...16+8+4+3],
     *   because 2nd & 3rd bit of FADDR is not decoded
     * - FADDR >= 48 are decoded correctly but not used
     */
    : CBlockHAL_Common(block_address, bus::replace_function_idx(block_address, 17),
                       {1,      2,       3,       4,       5,       6,       7,       8,
                        9,      10,      11,      12,      13,      14,      15,      32 + 0,
                        32 + 1, 32 + 2,  32 + 3,  32 + 4,  32 + 5,  32 + 6,  32 + 7,  32 + 8,
                        32 + 9, 32 + 10, 32 + 11, 32 + 12, 32 + 13, 32 + 14, 32 + 15, 16},
                       48) {}
 
blocks::CBlockHAL_V_1_1_X::CBlockHAL_V_1_1_X(bus::addr_t block_address)
    /*
     * Wrong oder of connection on IC2 was fixed, the addresses are
     * - FADDR[0...35] = CS[0...35]
     * - but also FADDR[32+4+0...32+4+3] = FADDR[32+8+0...32+8+3] = FADDR[32+8+4+0...32+8+4+3] = CS[32..35],
     *   because 2nd & 3rd bit of FADDR is not decoded
     * - FADDR >= 48 are decoded correctly but not used
     */
    : CBlockHAL_Common(block_address, bus::replace_function_idx(block_address, 33),
                       {1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11, 12, 13, 14, 15, 16,
                        17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32},
                       48) {}
 
blocks::CBlockHAL_V_1_2_X::CBlockHAL_V_1_2_X(bus::addr_t block_address)
    : CBlockHAL_Common(block_address, bus::replace_function_idx(block_address, 33),
                       {1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11, 12, 13, 14, 15, 16,
                        17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32},
                       0xff) {}