GIBIONode.cpp

Go to the documentation of this file.

 
#include "timing/GIBIONode.hpp"
#include "timing/LM75Node.hpp"
 
#include <string>
#include <math.h>
 
namespace dunedaq {
namespace timing {
 
UHAL_REGISTER_DERIVED_NODE(GIBIONode)
 
//-----------------------------------------------------------------------------
GIBIONode::GIBIONode(const uhal::Node& node)
  : IONode(node, "i2c", "i2c", { "PLL" }, { "PLL", "SFP CDR 0", "SFP CDR 1", "SFP CDR 2", "SFP CDR 3", "SFP CDR 4", "SFP CDR 5", "10 MHz" }, { "i2c", "i2c", "i2c", "i2c", "i2c", "i2c" })
{
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
GIBIONode::GIBIONode(const uhal::Node& node,
               std::string uid_i2c_bus,
               std::string pll_i2c_bus,
               std::string pll_i2c_device,
               std::vector<std::string> clock_names,
               std::vector<std::string> sfp_i2c_buses)
  : IONode(node, uid_i2c_bus, pll_i2c_bus, pll_i2c_device, clock_names, sfp_i2c_buses)
{
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
GIBIONode::~GIBIONode() {}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
std::string
GIBIONode::get_uid_address_parameter_name() const
{
  return "UID_PROM";
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
std::string
GIBIONode::get_status(bool print_out) const
{
  std::stringstream status;
 
  auto subnodes = read_sub_nodes(getNode("csr.stat"));
  status << format_reg_table(subnodes, "GIB IO state");
 
  auto subnodes_2 = read_sub_nodes(getNode("csr.ctrl"));
  status << format_reg_table(subnodes_2, "GIB IO control");
 
  uint8_t sfp_los = read_sfps_los();
  uint8_t sfp_fault = read_sfps_fault();
 
  std::vector<std::string> sfp_vec;
  std::vector<uint8_t> los_vec;
  std::vector<uint8_t> fault_vec;
 
  for (int i=0; i<get_num_sfps(); i++) {
    sfp_vec.push_back(to_string(i));
    // L is 0x4C, H is L - 4
    los_vec.push_back(0x4C - 4*((sfp_los >> i) & 1));
    fault_vec.push_back(0x4C - 4*((sfp_fault >> i) & 1));
  }
  
  status << "------IO expander----" << std::endl;
  status << "SFP:   " << vec_fmt(sfp_vec) << std::endl;
  status << "LOS:   " << vec_fmt(los_vec) << std::endl;
  status << "Fault: " << vec_fmt(fault_vec) << std::endl;
 
  status << "Board temperature: " << read_board_temperature() << " [C]" << std::endl;
 
  if (print_out)
    TLOG() << std::endl << status.str();
  return status.str();
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
std::unique_ptr<const SI534xSlave>
GIBIONode::get_pll() const
{
  // enable pll channel 0 only
  set_i2c_mux_channels(0x1);
  return get_i2c_device<SI534xSlave>(m_pll_i2c_bus, m_pll_i2c_device);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
std::string
GIBIONode::get_hardware_info(bool print_out) const
{
  // enable pll/uid channel 0 only
  set_i2c_mux_channels(0x1);
  return IONode::get_hardware_info(print_out);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::set_up_io_infrastructure() const
{
  // enclustra i2c switch stuff
  CarrierType carrier_type = convert_value_to_carrier_type(read_carrier_type());
  if (carrier_type == kCarrierEnclustraA35) {
    try {
      getNode<I2CMasterNode>(m_uid_i2c_bus).get_slave("AX3_Switch").write_i2c(0x01, 0x7f);
    } catch (const std::exception& e) {
      ers::warning(EnclustraSwitchFailure(ERS_HERE, e));
    }
  }
 
  // Disable ICs
  //getNode("csr.ctrl.i2c_sw_rst").write(0x1);
  //getNode("csr.ctrl.i2c_exten_rst").write(0x1);
  //getNode("csr.ctrl.clk_gen_rst").write(0x1);
  //getClient().dispatch();
 
  // Enable ICs
  getNode("csr.ctrl.i2c_sw_rst").write(0x0);
  getNode("csr.ctrl.i2c_exten_rst").write(0x0);
  getNode("csr.ctrl.clk_gen_rst").write(0x0);
  getClient().dispatch();
 
  set_i2c_mux_channels(0x1);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::reset(const std::string& clock_config_file) const
{
  // Clear IPBus regs
  soft_reset();
 
  // In case this method is called directly, TODO refactor
  set_up_io_infrastructure();
 
  getNode("csr.ctrl.gps_clk_en").write(0x0);
 
  // Set filter to full bandwidth mode A = B = 0x0
  getNode("csr.ctrl.gps_clk_fltr_a").write(0x0);
  getNode("csr.ctrl.gps_clk_fltr_b").write(0x0);
  getClient().dispatch();
 
  // Upload config file to PLL
  configure_pll(clock_config_file);
 
  configure_expander();
 
  // reset dts logic
  getNode("csr.ctrl.rst").write(0x1);
  getClient().dispatch();
  getNode("csr.ctrl.rst").write(0x0);
  getClient().dispatch();
 
  TLOG() << "Reset done";
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::configure_expander() const
{
  auto sfp_expander_0 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander0");
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
  
  // Set invert registers to default for both (0,1) banks
  sfp_expander_0->set_inversion(0, 0x00);
  sfp_expander_0->set_inversion(1, 0x00);
  sfp_expander_1->set_inversion(0, 0x00);
  sfp_expander_1->set_inversion(1, 0x00);
  
  // 0: pin set as output, 1: pin set as input
  sfp_expander_0->set_io(0, 0xff); // set all pins of bank 0 as inputs
  sfp_expander_0->set_io(1, 0xff); // set all pins of bank 1 as inputs
 
  sfp_expander_1->set_io(0, 0xff); // set all pins of bank 0 as inputs
  sfp_expander_1->set_io(1, 0x00); // set all pins of bank 1 as outputs
 
  // Set SFP disable 
  // Set tx disable pins low, i.e. enable the pins given in the bitmap
  //   (different between v1 and v2/3)
  sfp_expander_1->set_outputs(1, get_sfp_tx_disable_bitmap());
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::reset_pll() const
{
  getNode("csr.ctrl.clk_gen_rst").write(0x1);
  getNode("csr.ctrl.clk_gen_rst").write(0x0);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
std::string
GIBIONode::get_sfp_status(uint32_t sfp_id, bool print_out) const { // NOLINT(build/unsigned)
  std::stringstream status;
  
  validate_sfp_id(sfp_id);
 
  uint8_t i2c_mux_bitmask = 1UL << (sfp_id+1);
 
  set_i2c_mux_channels(i2c_mux_bitmask);
 
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_id), "SFP_EEProm");
 
  status << "SFP " << sfp_id << ":" << std::endl;
  status << sfp->get_status();
 
  if (print_out)
    TLOG() << status.str();
 
  return status.str();
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
uint32_t
GIBIONode::read_io_expanders() const { // NOLINT(build/unsigned)
  auto sfp_expander_0 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander0");
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
 
  uint32_t expander_bits = sfp_expander_1->read_inputs(0);
  expander_bits = (expander_bits << 8) + sfp_expander_0->read_inputs(1);
  expander_bits = (expander_bits << 8) + sfp_expander_0->read_inputs(0);
 
  return expander_bits;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
uint8_t
GIBIONode::read_sfps_los() const { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  uint8_t los_bits = 0x00;
 
  for (uint8_t sfp = 0; sfp<6; sfp++) {
    // Each SFP has 4 bits, the 3rd bit is the LOS
    // Adds the SFPs in inverse order
    los_bits = (los_bits << 1) + ((expander_bits >> (2 + 20 - 4*sfp)) & 1);
  }
 
  return los_bits;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
uint8_t
GIBIONode::read_sfps_fault() const { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  uint8_t fault_bits = 0x00;
 
  for (uint8_t sfp = 0; sfp<6; sfp++) {
    // Each SFP has 4 bits, the 4th bit is the fault
    // Adds the SFPs in inverse order
    fault_bits = (fault_bits << 1) + ((expander_bits >> (3 + 20 - 4*sfp)) & 1);
  }
 
  return fault_bits;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
bool
GIBIONode::clocks_ok() const
{
  std::stringstream status;
 
  auto states = read_sub_nodes(getNode("csr.stat"));
  bool pll_lol = states.find("clk_gen_lol")->second.value();
  bool pll_interrupt = states.find("clk_gen_intr")->second.value();
  bool mmcm_ok = states.find("mmcm_ok")->second.value();
  bool mmcm_10_ok = states.find("mmcm_ok")->second.value();
 
  TLOG_DEBUG(5) << "pll lol: " << pll_lol << ", pll intr: " << pll_interrupt
                << ", mmcm ok: " << mmcm_ok << ", mmcm 10MHz ok: " << mmcm_10_ok;
 
  return !pll_lol && mmcm_ok && mmcm_10_ok;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::switch_sfp_soft_tx_control_bit(uint32_t sfp_id, bool turn_on) const { // NOLINT(build/unsigned)
  validate_sfp_id(sfp_id);
 
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_id), "SFP_EEProm");
  sfp->switch_soft_tx_control_bit(turn_on);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::switch_sfp_tx(uint32_t sfp_id, bool turn_on) const { // NOLINT(build/unsigned)
    validate_sfp_id(sfp_id);
 
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
    uint8_t current_sfp_tx_control_flags = sfp_expander_1->read_outputs_config(1); // NOLINT(build/unsigned)
 
    uint8_t new_sfp_tx_control_flags; // NOLINT(build/unsigned)
    if (turn_on)
    {
        new_sfp_tx_control_flags = current_sfp_tx_control_flags & ~(1UL << sfp_id);
    }
  else
  {
    new_sfp_tx_control_flags = current_sfp_tx_control_flags | (1UL << sfp_id);
  }
 
  sfp_expander_1->set_outputs(1, new_sfp_tx_control_flags);
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
//void
//GIBIONode::get_info(timinghardwareinfo::TimingGIBMonitorData& mon_data) const
//{
  // TODO
//}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
// void
// GIBIONode::get_info(opmonlib::InfoCollector& /*ci*/, int /*level*/) const
// {
//   // TO DO
// }
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
uint8_t
GIBIONode::get_sfp_tx_disable_bitmap() const { // NOLINT(build/unsigned)
  // First 6 bits are tx disable on GIBv1
  return 0xC0;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
uint8_t
GIBIONode::get_num_sfps() const { // NOLINT(build/unsigned)
  // 6 SFPs on GIBv1
  return 6;
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::validate_sfp_id(uint32_t sfp_id) const { // NOLINT(build/unsigned)
  // number of sfps on board defined by get_num_sfps
  if (sfp_id >= get_num_sfps()) {
        throw InvalidSFPId(ERS_HERE, format_reg_value(sfp_id));
  }
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
void
GIBIONode::set_i2c_mux_channels(uint8_t mux_channel_bitmask) const { // NOLINT(build/unsigned)
 
  uint8_t mux_channel_config = mux_channel_bitmask & 0x7f;
  
  auto i2c_bus = getNode<I2CMasterNode>("i2c");
  i2c_bus.write_i2cPrimitive(0x70, {mux_channel_config});
}
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
float
GIBIONode::read_board_temperature() const
{
    auto temp_mon = get_i2c_device<LM75Node>(m_pll_i2c_bus, "TEMP_MON");
    return temp_mon->read_temperature();
}
//-----------------------------------------------------------------------------
} // namespace timing
} // namespace dunedaq