functions.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 <bus/functions.h>
 
functions::Function::Function(const bus::addr_t address) : address(address) {}
 
void functions::TriggerFunction::trigger() const {
  bus::address_function(address);
  bus::activate_address();
  delayNanoseconds(2 * 42);
  bus::deactivate_address();
}
 
functions::DataFunction::DataFunction(bus::addr_t address, const SPISettings &spiSettings)
    : Function(address), spi_settings(spiSettings) {}
 
void functions::DataFunction::begin_communication() const {
  /*
   * HACK: Do two-step addressing to circumvent hardware limitations,
   *       see lucidac/hardware/dimm-template-rev1/-/issues/2
   *
   * For each block, we have to define an unused (or practically no-op) address that
   * gets addressed first to assert the correct MSELECT signal, before we address
   * the actual address. Otherwise, the SPI mode can not be correctly set.
   * Each block requires different addresses. See the issue for background info.
   */
  auto block_address = bus::remove_addr_parts(address, false, true);
  auto hack_msel_only_address = address;
 
  switch (block_address) {
  case 0:
    break;
  case /*  1 */ bus::CTRL_BLOCK_BADDR:
    hack_msel_only_address = 5;
    break;
  case /*  2 */ bus::BACKPLANE_BADDR:
    // This is actually the "front plane" for LUCIDAC (with analog in/outs, function generator, ...)
    // On LUCIDAC front plane, CS={1,7} are free
    // This is the "back plane" for REDAC (with T-Blocks, backplane identification, ...)
    // On REDAC back plane, CS=3 is free
    // TODO: Introduce some mechanism to differentiate between LUCIDAC and REDAC here.
    //       For now, just have it separate on the two branches.
    hack_msel_only_address = 1;
    break;
  case /*  3 */ bus::AUX_BADDR:
    // This is actually non-existent for the LUCIDAC
    // This is not yet existent for the REDAC
    break;
  case /*  4 */ bus::T_BLOCK_BADDR:
    hack_msel_only_address = bus::replace_function_idx(address, 7);
    break;
  case /*  5 */ bus::CARRIER_BADDR:
    hack_msel_only_address = bus::replace_function_idx(address, 15);
    break;
  case /*  6 */ bus::REDAC_BACKPLANE_SIGNAL_PROCESSING_BADDR:
  case /*  7 */ bus::RESERVED_BADDR:
    // Both currently not used
    break;
  case /*  8 */ bus::U_BLOCK_BADDR(0):
  case /* 16 */ bus::U_BLOCK_BADDR(1):
  case /* 24 */ bus::U_BLOCK_BADDR(2):
    if (bus::get_function_idx(address) == 2)
      hack_msel_only_address = bus::replace_function_idx(address, 3);
    else
      hack_msel_only_address = bus::replace_function_idx(address, 2);
    break;
  case /*  9 */ bus::C_BLOCK_BADDR(0):
  case /* 17 */ bus::C_BLOCK_BADDR(1):
  case /* 25 */ bus::C_BLOCK_BADDR(2):
    hack_msel_only_address = bus::replace_function_idx(address, 48);
    break;
  case /* 10 */ bus::I_BLOCK_BADDR(0):
  case /* 18 */ bus::I_BLOCK_BADDR(1):
  case /* 26 */ bus::I_BLOCK_BADDR(2):
    if (bus::get_function_idx(address) == 5)
      hack_msel_only_address = bus::replace_function_idx(address, 6);
    else
      hack_msel_only_address = bus::replace_function_idx(address, 5);
    break;
  case /* 11 */ bus::SH_BLOCK_BADDR(0):
  case /* 19 */ bus::SH_BLOCK_BADDR(1):
  case /* 27 */ bus::SH_BLOCK_BADDR(2):
    hack_msel_only_address = bus::replace_function_idx(address, 8);
    break;
  case /* 12 */ bus::M0_BLOCK_BADDR(0):
  case /* 20 */ bus::M0_BLOCK_BADDR(1):
  case /* 28 */ bus::M0_BLOCK_BADDR(2):
  case /* 13 */ bus::M1_BLOCK_BADDR(0):
  case /* 21 */ bus::M1_BLOCK_BADDR(1):
  case /* 29 */ bus::M1_BLOCK_BADDR(2):
    // CS = 15 should be free for both, but does not work
    hack_msel_only_address = bus::replace_function_idx(address, 2);
    break;
  case /* 14 */ bus::REDAC_ADC_PSEUDO_BLOCK_BADDR(0):
  case /* 22 */ bus::REDAC_ADC_PSEUDO_BLOCK_BADDR(1):
  case /* 30 */ bus::REDAC_ADC_PSEUDO_BLOCK_BADDR(2):
    hack_msel_only_address = bus::replace_function_idx(address, 4);
    break;
  case /* 15 */ bus::REDAC_BACKPLANE_T0_BLOCK_BADDR:
  case /* 23 */ bus::REDAC_BACKPLANE_T1_BLOCK_BADDR:
  case /* 31 */ bus::REDAC_BACKPLANE_TAUX_BLOCK_BADDR:
    // Must possibly be adapted when T-blocks on backplane are changed
    hack_msel_only_address = bus::replace_function_idx(address, 7);
    break;
  }
 
  bus::address_function(hack_msel_only_address);
  bus::activate_address();
  bus::address_function(address);
  bus::spi.beginTransaction(spi_settings);
  delayNanoseconds(200);
  bus::activate_address();
}
 
void functions::DataFunction::end_communication() const {
  bus::deactivate_address();
  bus::spi.endTransaction();
}
 
void functions::DataFunction::transfer(const void *mosi_buf, void *miso_buf, size_t count) const {
  begin_communication();
  bus::spi.transfer(mosi_buf, miso_buf, count);
  end_communication();
}
 
uint8_t functions::DataFunction::transfer8(uint8_t data_in) const {
  begin_communication();
  auto ret = bus::spi.transfer(data_in);
  end_communication();
  return ret;
}
 
uint16_t functions::DataFunction::transfer16(uint16_t data_in) const {
  begin_communication();
  auto ret = bus::spi.transfer16(data_in);
  end_communication();
  return ret;
}
 
uint32_t functions::DataFunction::transfer32(uint32_t data_in) const {
  begin_communication();
  auto ret = bus::spi.transfer32(data_in);
  end_communication();
  return ret;
}
 
SPIClass &functions::DataFunction::get_raw_spi() { return bus::spi; }