dunedaq::timing::I2CSFPSlave Class Reference

I2C slave class to control SFP transceivers. More...

#include <I2CSFPNode.hpp>

Inheritance diagram for dunedaq::timing::I2CSFPSlave:

Collaboration diagram for dunedaq::timing::I2CSFPSlave:

Public Member Functions
	I2CSFPSlave (const I2CMasterNode *i2c_master, uint8_t i2c_device_address)
virtual	~I2CSFPSlave ()
void	sfp_reachable () const
	Check if SFP responds.
void	ddm_available () const
	Check if DDM is supported.
std::pair< double, double >	read_calibration_parameter_pair (uint32_t calib_parameter_id) const
	Read the raw SFP temperature.
double	read_temperature_raw () const
	Read the raw SFP temperature.
double	read_temperature () const
	Read the calibrated SFP temperature.
double	read_voltage_raw () const
	Read the raw SFP voltage.
double	read_voltage () const
	Read the calibrated SFP voltage.
double	read_rx_power_raw () const
	Read the raw SFP temperature.
double	read_rx_ower () const
	Read the raw SFP temperature.
double	read_tx_power_raw () const
	Read the raw SFP tx power.
double	read_tx_power () const
	Read the calibrated SFP tx power.
double	read_current_raw () const
	Read the raw SFP current.
double	read_current () const
	Read the calibrated SFP current.
std::string	read_vendor_name () const
	Read the vendor name.
std::string	read_vendor_part_number () const
	Read the vendor name.
std::string	read_serial_number () const
	Read the SFP serial number.
bool	read_ddm_support_bit () const
	Find out if SFP supports DDM.
bool	read_soft_tx_control_support_bit () const
	Find out if SFP supports soft tx laser disable.
bool	read_soft_tx_control_state () const
	Read the value of the soft tx disable control bit.
bool	read_tx_disable_pin_state () const
	Read the state of the tx disable control pin.
bool	read_i2c_reg_addressSwapBit () const
	Read whether the SFP has seperate I2C addresses, or if a special I2C address swap is required. True = address swap required.
void	switch_soft_tx_control_bit (bool turn_on) const
	Switch on or off the SFP tx laser via the soft control bit.
std::string	get_status (bool print_out=false) const
	Get SFP status.
Public Member Functions inherited from dunedaq::timing::I2CSlave
virtual	~I2CSlave ()
uint8_t	get_i2c_address () const
uint8_t	read_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address) const
	comodity functions
uint8_t	read_i2c (uint32_t i2c_reg_address) const
void	write_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
void	write_i2c (uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint32_t number_of_words) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_reg_address, uint32_t number_of_words) const
void	write_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
void	write_i2cArray (uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cPrimitive (uint32_t number_of_bytes) const
void	write_i2cPrimitive (const std::vector< uint8_t > &data, bool send_stop=true) const
bool	ping () const
std::string	get_master_id () const

Protected Attributes
const std::vector< uint32_t >	m_calibration_parameter_start_addresses
	Get and fill SFP hardware data.

Additional Inherited Members
Protected Member Functions inherited from dunedaq::timing::I2CSlave
	I2CSlave (const I2CMasterNode *i2c_master, uint8_t i2c_device_address)

Detailed Description

I2C slave class to control SFP transceivers.

Author

Alessandro Thea

Date

April 2018

Definition at line 37 of file I2CSFPNode.hpp.

Constructor & Destructor Documentation

I2CSFPSlave()

dunedaq::timing::I2CSFPSlave::I2CSFPSlave	(	const I2CMasterNode *	i2c_master,
		uint8_t	i2c_device_address )

Definition at line 21 of file I2CSFPNode.cpp.

  : I2CSlave(i2c_master, address)
  , m_calibration_parameter_start_addresses({ 0x4C, 0x50, 0x54, 0x58 }) // laser current, tx_pwr, temp, voltage
{}

~I2CSFPSlave()

dunedaq::timing::I2CSFPSlave::~I2CSFPSlave ( )

virtual

Definition at line 28 of file I2CSFPNode.cpp.

{}

Member Function Documentation

ddm_available()

void dunedaq::timing::I2CSFPSlave::ddm_available

(

)

const

Check if DDM is supported.

Definition at line 43 of file I2CSFPNode.cpp.

{
  if (!read_ddm_support_bit()) {
    throw SFPDDMUnsupported(ERS_HERE, get_master_id());
  } else {
    if (read_i2c_reg_addressSwapBit()) {
      throw SFPDDMI2CAddressSwapUnsupported(ERS_HERE, get_master_id());
    }
  }
}

get_status()

std::string dunedaq::timing::I2CSFPSlave::get_status

(

bool

print_out = false

)

const

Get SFP status.

Definition at line 327 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  std::stringstream status;
  std::vector<std::pair<std::string, std::string>> sfp_info;
 
  // Vendor name
  sfp_info.push_back(std::make_pair("Vendor", read_vendor_name()));
 
  // Vendor part number
  sfp_info.push_back(std::make_pair("Part number", read_vendor_part_number()));
 
  // Serial number
  sfp_info.push_back(std::make_pair("Serial number", read_serial_number()));
 
  // Does the SFP support DDM
  if (!read_ddm_support_bit()) {
    TLOG() << "DDM not available for SFP on I2C bus: " << get_master_id();
    status << format_reg_table(sfp_info, "SFP status", { "", "" });
    if (print_out)
      TLOG() << status.str();
    return status.str();
  } else {
    if (read_i2c_reg_addressSwapBit()) {
      TLOG() << "SFP DDM I2C address swap not supported. SFP on I2C bus: " << get_master_id();
      status << format_reg_table(sfp_info, "SFP status", { "", "" });
      if (print_out)
        TLOG() << status.str();
      return status.str();
    }
  }
 
  std::stringstream temperature_stream;
  temperature_stream << std::dec << std::fixed << std::setprecision(2) << read_temperature() << " C";
  sfp_info.push_back(std::make_pair("Temperature", temperature_stream.str()));
 
  std::stringstream voltage_stream;
  voltage_stream << std::dec << std::fixed << std::setprecision(2) << read_voltage() << " V";
  sfp_info.push_back(std::make_pair("Supply voltage", voltage_stream.str()));
 
  std::stringstream rx_power_stream;
  rx_power_stream << std::dec << std::fixed << std::setprecision(2) << read_rx_ower() << " uW";
  sfp_info.push_back(std::make_pair("Rx power", rx_power_stream.str()));
 
  std::stringstream tx_power_stream;
  tx_power_stream << std::dec << std::fixed << std::setprecision(2) << read_tx_power() << " uW";
  sfp_info.push_back(std::make_pair("Tx power", tx_power_stream.str()));
 
  std::stringstream current_stream;
  current_stream << std::dec << std::fixed << std::setprecision(2) << read_current() << " uA";
  sfp_info.push_back(std::make_pair("Tx current", current_stream.str()));
 
  if (read_soft_tx_control_support_bit()) {
    // sfp_info.push_back(std::make_pair("Soft Tx disbale supported",  "True"));
    sfp_info.push_back(std::make_pair("Tx disable bit", std::to_string(read_soft_tx_control_state())));
  } else {
    sfp_info.push_back(std::make_pair("Soft Tx disbale supported", "False"));
  }
 
  sfp_info.push_back(std::make_pair("Tx disable pin", std::to_string(read_tx_disable_pin_state())));
 
  status << format_reg_table(sfp_info, "SFP status", { "", "" });
  if (print_out)
    TLOG() << status.str();
  return status.str();
}

read_calibration_parameter_pair()

std::pair< double, double > dunedaq::timing::I2CSFPSlave::read_calibration_parameter_pair

(

uint32_t

calib_parameter_id

)

const

Read the raw SFP temperature.

Definition at line 57 of file I2CSFPNode.cpp.

{
 
  ddm_available();
 
  auto parameter_array = this->read_i2cArray(0x51, m_calibration_parameter_start_addresses.at(calib_parameter_id), 0x4);
 
  // slope
  double slope = parameter_array.at(0) + (parameter_array.at(1) / 256.0);
 
  uint32_t offset_raw = (parameter_array.at(2) & 0x7f) << 8 | parameter_array.at(3); // NOLINT(build/unsigned)
 
  // eighth bit corresponds to sign
  double offset = parameter_array.at(2) & (1UL << 7) ? offset_raw - 0x8000 : offset_raw;
 
  return std::make_pair(slope, offset);
}

read_current()

double dunedaq::timing::I2CSFPSlave::read_current

(

)

const

Read the calibrated SFP current.

Definition at line 190 of file I2CSFPNode.cpp.

{
  auto current_raw = this->read_current_raw();
  auto temp_calib_pair = read_calibration_parameter_pair(0x0);
  return ((current_raw * temp_calib_pair.first) + temp_calib_pair.second) * 0.002;
}

read_current_raw()

double dunedaq::timing::I2CSFPSlave::read_current_raw

(

)

const

Read the raw SFP current.

Definition at line 180 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto current_array = this->read_i2cArray(0x51, 0x64, 0x2);
  return (current_array.at(0) << 8) | current_array.at(1);
}

read_ddm_support_bit()

bool dunedaq::timing::I2CSFPSlave::read_ddm_support_bit

(

)

const

Find out if SFP supports DDM.

Definition at line 245 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  // Bit 6 of reg 5C tells us whether the SFP supports digital diagnostic monitoring (DDM)
  auto ddm_info_byte = this->read_i2c(0x5C);
  return ddm_info_byte & 0x40;
}

read_i2c_reg_addressSwapBit()

bool dunedaq::timing::I2CSFPSlave::read_i2c_reg_addressSwapBit

(

)

const

Read whether the SFP has seperate I2C addresses, or if a special I2C address swap is required. True = address swap required.

Definition at line 291 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  auto ddm_info_byte = this->read_i2c(0x5C);
  // Bit 2 of byte 5C tells us whether special I2C address change operations are needed to access the DDM area
  return ddm_info_byte & 0x4;
}

read_rx_ower()

double dunedaq::timing::I2CSFPSlave::read_rx_ower

(

)

const

Read the raw SFP temperature.

Definition at line 131 of file I2CSFPNode.cpp.

{
  auto rx_power_raw = this->read_rx_power_raw();
  // rx power calib constants, 5 4-byte parameters, IEEE 754 float encoding
  std::vector<uint32_t> rx_param_start_adr = { 0x48, 0x44, 0x40, 0x3C, 0x38 }; // NOLINT(build/unsigned)
  std::vector<double> rx_parameters;
  for (auto it = rx_param_start_adr.begin(); it != rx_param_start_adr.end(); ++it) {
    uint32_t parameter_bits = 0; // NOLINT(build/unsigned)
    auto parameter_array = this->read_i2cArray(0x51, *it, 0x4);
 
    for (auto jt = parameter_array.begin(); jt != parameter_array.end(); ++jt)
      parameter_bits = (parameter_bits << 8) | *jt;
 
    // convert the 32 bits to a float according IEEE 754
    double parameter = convert_bits_to_float(parameter_bits);
    rx_parameters.push_back(parameter);
  }
 
  double rx_power_calib = 0;
  for (uint32_t i = 0; i < rx_parameters.size(); ++i) { // NOLINT(build/unsigned)
    double parameter = rx_parameters.at(i);
    rx_power_calib = rx_power_calib + (parameter * pow(rx_power_raw, i));
  }
  return rx_power_calib * 0.1;
}

read_rx_power_raw()

double dunedaq::timing::I2CSFPSlave::read_rx_power_raw

(

)

const

Read the raw SFP temperature.

Definition at line 121 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto rx_power_array = this->read_i2cArray(0x51, 0x68, 0x2);
  return (rx_power_array.at(0) << 8) | rx_power_array.at(1);
}

read_serial_number()

std::string dunedaq::timing::I2CSFPSlave::read_serial_number

(

)

const

Read the SFP serial number.

Definition at line 230 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  std::stringstream serial_number;
  auto serial_number_characters = this->read_i2cArray(0x44, 0x10);
  for (auto it = serial_number_characters.begin(); it != serial_number_characters.end(); ++it) {
    serial_number << *it;
  }
  return serial_number.str();
}

read_soft_tx_control_state()

bool dunedaq::timing::I2CSFPSlave::read_soft_tx_control_state

(

)

const

Read the value of the soft tx disable control bit.

Definition at line 269 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto opt_status_ctrl_byte = this->read_i2c(0x51, 0x6e);
  // Bit 6 tells us the state of the soft tx_disble register
  return opt_status_ctrl_byte & 0x40;
}

read_soft_tx_control_support_bit()

bool dunedaq::timing::I2CSFPSlave::read_soft_tx_control_support_bit

(

)

const

Find out if SFP supports soft tx laser disable.

Definition at line 257 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  // Bit 6 of reg 5d tells us whether the soft tx control is implemented in this sfp
  auto enhanced_options_byte = this->read_i2c(0x5d);
  return enhanced_options_byte & 0x40;
}

read_temperature()

double dunedaq::timing::I2CSFPSlave::read_temperature

(

)

const

Read the calibrated SFP temperature.

Definition at line 91 of file I2CSFPNode.cpp.

{
  auto temperature_raw = read_temperature_raw();
  auto temp_calib_pair = read_calibration_parameter_pair(0x2);
  return temperature_raw * temp_calib_pair.first + temp_calib_pair.second;
}

read_temperature_raw()

double dunedaq::timing::I2CSFPSlave::read_temperature_raw

(

)

const

Read the raw SFP temperature.

Definition at line 78 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto temperature_array = this->read_i2cArray(0x51, 0x60, 0x2);
 
  // bit 7 corresponds to temperature sign, 0 for pos, 1 for neg
  double temperature = temperature_array.at(0) & (1UL << 7) ? (temperature_array.at(0) & 0x7f) - 0xff : temperature_array.at(0);
  return temperature + (temperature_array.at(1) / 256.0);
}

read_tx_disable_pin_state()

bool dunedaq::timing::I2CSFPSlave::read_tx_disable_pin_state

(

)

const

Read the state of the tx disable control pin.

Definition at line 280 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto opt_status_ctrl_byte = this->read_i2c(0x51, 0x6e);
  // Bit 7 tells us the state of tx_disble pin
  return opt_status_ctrl_byte & 0x80;
}

read_tx_power()

double dunedaq::timing::I2CSFPSlave::read_tx_power

(

)

const

Read the calibrated SFP tx power.

Definition at line 170 of file I2CSFPNode.cpp.

{
  auto tx_power_raw = this->read_tx_power_raw();
  auto temp_calib_pair = read_calibration_parameter_pair(0x1);
  return ((tx_power_raw * temp_calib_pair.first) + temp_calib_pair.second) * 0.1;
}

read_tx_power_raw()

double dunedaq::timing::I2CSFPSlave::read_tx_power_raw

(

)

const

Read the raw SFP tx power.

Definition at line 160 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto tx_power_array = this->read_i2cArray(0x51, 0x66, 0x2);
  return (tx_power_array.at(0) << 8) | tx_power_array.at(1);
}

read_vendor_name()

std::string dunedaq::timing::I2CSFPSlave::read_vendor_name

(

)

const

Read the vendor name.

Definition at line 200 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  std::stringstream vendor_name;
  auto vendor_name_characters = this->read_i2cArray(0x14, 0x10);
  for (auto it = vendor_name_characters.begin(); it != vendor_name_characters.end(); ++it) {
    vendor_name << *it;
  }
  return vendor_name.str();
}

read_vendor_part_number()

std::string dunedaq::timing::I2CSFPSlave::read_vendor_part_number

(

)

const

Read the vendor name.

Definition at line 215 of file I2CSFPNode.cpp.

{
  sfp_reachable();
 
  std::stringstream vendor_pn;
  auto vendor_pn_characters = this->read_i2cArray(0x28, 0x10);
  for (auto it = vendor_pn_characters.begin(); it != vendor_pn_characters.end(); ++it) {
    vendor_pn << *it;
  }
  return vendor_pn.str();
}

read_voltage()

double dunedaq::timing::I2CSFPSlave::read_voltage

(

)

const

Read the calibrated SFP voltage.

Definition at line 111 of file I2CSFPNode.cpp.

{
  auto voltage_raw = this->read_voltage_raw();
  auto temp_calib_pair = read_calibration_parameter_pair(0x3);
  return ((voltage_raw * temp_calib_pair.first) + temp_calib_pair.second) * 1e-4;
}

read_voltage_raw()

double dunedaq::timing::I2CSFPSlave::read_voltage_raw

(

)

const

Read the raw SFP voltage.

Definition at line 101 of file I2CSFPNode.cpp.

{
  ddm_available();
  auto voltage_array = this->read_i2cArray(0x51, 0x62, 0x2);
  return (voltage_array.at(0) << 8) | voltage_array.at(1);
}

sfp_reachable()

void dunedaq::timing::I2CSFPSlave::sfp_reachable

(

)

const

Check if SFP responds.

Definition at line 33 of file I2CSFPNode.cpp.

{
  if (!this->ping()) {
    throw SFPUnreachable(ERS_HERE, get_master_id());
  }
}

switch_soft_tx_control_bit()

void dunedaq::timing::I2CSFPSlave::switch_soft_tx_control_bit

(

bool

turn_on

)

const

Switch on or off the SFP tx laser via the soft control bit.

Definition at line 303 of file I2CSFPNode.cpp.

{
  ddm_available();
 
  if (!read_soft_tx_control_support_bit()) {
    throw SoftTxLaserControlUnsupported(ERS_HERE, get_master_id());
  }
 
  // Get optional status/control bits
  auto opt_status_ctrl_byte = this->read_i2c(0x51, 0x6e);
 
  uint8_t new_opt_status_ctrl_byte; // NOLINT(build/unsigned)
  // Bit 6 of byte 0x6e controls the soft tx_disable
  if (turn_on) {
    new_opt_status_ctrl_byte = opt_status_ctrl_byte & ~(1UL << 6);
  } else {
    new_opt_status_ctrl_byte = opt_status_ctrl_byte | (1UL << 6);
  }
  this->write_i2c(0x51, 0x6e, new_opt_status_ctrl_byte);
}

Member Data Documentation

m_calibration_parameter_start_addresses

const std::vector<uint32_t> dunedaq::timing::I2CSFPSlave::m_calibration_parameter_start_addresses

protected

Get and fill SFP hardware data.

Definition at line 190 of file I2CSFPNode.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/timing/include/timing/I2CSFPNode.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/I2CSFPNode.cpp