[roc] Consistent S/N parsing between CRU and CRORC

Author: kostorr

src/CommandLineUtilities/ProgramListCards.cxx

@@ -87,7 +87,12 @@ class ProgramListCards : public Program
         }
       }
 
-      std::string serial = std::to_string(card.serialId.getSerial());
+      // Pad the serial with 0s if necessary
+      // It should always be used as 3 chars to avoid conflicts with the sequence id
+      boost::format serialFormat("%03d");
+      serialFormat % std::to_string(card.serialId.getSerial());
+
+      std::string serial = serialFormat.str();
       std::string endpoint = std::to_string(card.serialId.getEndpoint());
 
       if (!mOptions.jsonOut) {

src/Crorc/Constants.h

@@ -412,6 +412,12 @@ static constexpr uint32_t DTSW(0x00000082);
 
 // Register to configure the Data Generator
 static constexpr Register DATA_GENERATOR_CFG(0x00000020);
+
+// Registers used to read the Serial Number
+static constexpr Register SERIAL_NUMBER_CTRL(0x000000F0);
+static constexpr uint32_t SERIAL_NUMBER_TRG(0xC0000000);
+static constexpr Register SERIAL_NUMBER(0x000000FC);
+
 } // namespace Registers
 } //namespace Crorc
 

src/Crorc/CrorcBar.cxx

@@ -26,6 +26,8 @@
 
 #include "boost/format.hpp"
 
+using namespace std::literals;
+
 namespace AliceO2
 {
 namespace roc
@@ -40,6 +42,11 @@ CrorcBar::CrorcBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> r
 {
 }
 
+CrorcBar::CrorcBar(std::shared_ptr<Pda::PdaBar> bar)
+  : BarInterfaceBase(bar)
+{
+}
+
 CrorcBar::~CrorcBar()
 {
 }
@@ -52,14 +59,43 @@ boost::optional<std::string> CrorcBar::getFirmwareInfo()
 
 boost::optional<int32_t> CrorcBar::getSerial()
 {
-  return Crorc::getSerial(*(mPdaBar.get()));
+  return getSerialNumber();
 }
 
 void CrorcBar::setSerial(int serial)
 {
   Crorc::setSerial(*(mPdaBar.get()), serial);
 }
 
+boost::optional<int32_t> CrorcBar::getSerialNumber()
+{
+  //  mPdaBar->assertBarIndex(0, "Can only get serial from Bar 0");
+  uint32_t serial = readRegister(Crorc::Registers::SERIAL_NUMBER.index);
+  if (serial == 0x0 || true) {
+    writeRegister(Crorc::Registers::SERIAL_NUMBER_CTRL.index, Crorc::Registers::SERIAL_NUMBER_TRG);
+    std::this_thread::sleep_for(500ms);
+    serial = readRegister(Crorc::Registers::SERIAL_NUMBER.index);
+  }
+
+  if (serial == 0x0) { // Previous S/N scheme
+    return Crorc::getSerial(*(mPdaBar.get()));
+  } else {
+    // Register format e.g. 0x32343932
+    // transltes to -> 2942 -> 942 (keep 3)
+    std::stringstream serialString;
+
+    serialString << char(serial & 0xff)
+                 << char((serial & 0xff00) >> 8)
+                 << char((serial & 0xff0000) >> 16);
+
+    try {
+      return std::stoi(serialString.str());
+    } catch (...) {
+      return {};
+    }
+  }
+}
+
 int CrorcBar::getEndpointNumber()
 {
   return 0;

src/Crorc/CrorcBar.h

@@ -31,6 +31,7 @@ class CrorcBar final : public BarInterfaceBase
 {
  public:
   CrorcBar(const Parameters& parameters, std::unique_ptr<RocPciDevice> rocPciDevice);
+  CrorcBar(std::shared_ptr<Pda::PdaBar> bar);
   virtual ~CrorcBar();
   //virtual void checkReadSafe(int index) override;
   //virtual void checkWriteSafe(int index, uint32_t value) override;
@@ -44,6 +45,7 @@ class CrorcBar final : public BarInterfaceBase
   virtual boost::optional<std::string> getFirmwareInfo() override;
   virtual int getEndpointNumber() override;
 
+  boost::optional<int32_t> getSerialNumber();
   void setSerial(int serial);
 
   void configure(bool force = false) override;

src/Cru/CruBar.cxx

@@ -267,7 +267,7 @@ int32_t CruBar::getLinksPerWrapper(int wrapper)
 /// calling this function, or the card may crash. See parseFirmwareFeatures().
 boost::optional<int32_t> CruBar::getSerialNumber()
 {
-  assertBarIndex(2, "Can only get serial number from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get serial number from BAR 2");
   uint32_t serial = readRegister(Cru::Registers::SERIAL_NUMBER.index);
   if (serial == 0x0) { // Try to populate the serial register in case it's empty
     writeRegister(Cru::Registers::SERIAL_NUMBER_CTRL.index, Cru::Registers::SERIAL_NUMBER_TRG);
@@ -280,16 +280,16 @@ boost::optional<int32_t> CruBar::getSerialNumber()
     boost::optional<int32_t> serial = eeprom.getSerial();
     return serial;
   } else { // v3.6.3+
+    // Register format e.g. 0x343230
+    // translates to -> 024
+    std::stringstream serialString;
 
-    std::string serialString;
-
-    for (int i = 0; i < 3; i++) { // The serial number consists of 3 digits
-      serialString += char(serial & 0xff);
-      serial = serial >> 8;
-    }
+    serialString << char(serial & 0xff)
+                 << char((serial & 0xff00) >> 8)
+                 << char((serial & 0xff0000) >> 16);
 
     try {
-      return std::stol(serialString, NULL, 0);
+      return std::stoi(serialString.str());
     } catch (...) {
       return {};
     }
@@ -299,7 +299,7 @@ boost::optional<int32_t> CruBar::getSerialNumber()
 /// Get raw data from the temperature register
 uint32_t CruBar::getTemperatureRaw()
 {
-  assertBarIndex(2, "Can only get temperature from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get temperature from BAR 2");
   // Only use lower 10 bits
   return readRegister(Cru::Registers::TEMPERATURE.index) & 0x3ff;
 }
@@ -332,55 +332,55 @@ boost::optional<float> CruBar::getTemperatureCelsius()
 
 uint32_t CruBar::getFirmwareCompileInfo()
 {
-  assertBarIndex(0, "Can only get firmware compile info from BAR 0");
+  mPdaBar->assertBarIndex(0, "Can only get firmware compile info from BAR 0");
   return readRegister(Cru::Registers::FIRMWARE_COMPILE_INFO.index);
 }
 
 uint32_t CruBar::getFirmwareGitHash()
 {
-  assertBarIndex(2, "Can only get git hash from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get git hash from BAR 2");
   return readRegister(Cru::Registers::FIRMWARE_GIT_HASH.index);
 }
 
 uint32_t CruBar::getFirmwareDateEpoch()
 {
-  assertBarIndex(2, "Can only get firmware epoch from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get firmware epoch from BAR 2");
   return readRegister(Cru::Registers::FIRMWARE_EPOCH.index);
 }
 
 uint32_t CruBar::getFirmwareDate()
 {
-  assertBarIndex(2, "Can only get firmware date from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get firmware date from BAR 2");
   return readRegister(Cru::Registers::FIRMWARE_DATE.index);
 }
 
 uint32_t CruBar::getFirmwareTime()
 {
-  assertBarIndex(2, "Can only get firmware time from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get firmware time from BAR 2");
   return readRegister(Cru::Registers::FIRMWARE_TIME.index);
 }
 
 uint32_t CruBar::getFpgaChipHigh()
 {
-  assertBarIndex(2, "Can only get FPGA chip ID from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get FPGA chip ID from BAR 2");
   return readRegister(Cru::Registers::FPGA_CHIP_HIGH.index);
 }
 
 uint32_t CruBar::getFpgaChipLow()
 {
-  assertBarIndex(2, "Can only get FPGA chip ID from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get FPGA chip ID from BAR 2");
   return readRegister(Cru::Registers::FPGA_CHIP_LOW.index);
 }
 
 uint32_t CruBar::getPonStatusRegister()
 {
-  assertBarIndex(2, "Can only get PON status register from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get PON status register from BAR 2");
   return readRegister((Cru::Registers::ONU_USER_LOGIC.address + 0x0c) / 4);
 }
 
 uint32_t CruBar::getOnuAddress()
 {
-  assertBarIndex(2, "Can only get PON status register from BAR 2");
+  mPdaBar->assertBarIndex(2, "Can only get PON status register from BAR 2");
   return readRegister(Cru::Registers::ONU_USER_LOGIC.index) >> 1;
 }
 
@@ -399,7 +399,7 @@ bool CruBar::checkPonUpstreamStatusExpected(uint32_t ponUpstreamRegister, uint32
 /// Get the enabled features for the card's firmware.
 FirmwareFeatures CruBar::parseFirmwareFeatures()
 {
-  assertBarIndex(0, "Can only get firmware features from BAR 0");
+  mPdaBar->assertBarIndex(0, "Can only get firmware features from BAR 0");
   return convertToFirmwareFeatures(readRegister(Cru::Registers::FIRMWARE_FEATURES.index));
 }
 

src/Cru/CruBar.h

@@ -151,14 +151,6 @@ class CruBar final : public BarInterfaceBase
 
   /// Per-link counter to verify superpage sizes received are valid
   uint32_t mSuperpageSizeIndexCounter[Cru::MAX_LINKS] = { 0 };
-
-  /// Checks if this is the correct BAR. Used to check for BAR 2 for special functions.
-  void assertBarIndex(int index, std::string message) const
-  {
-    if (mPdaBar->getIndex() != index) {
-      BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message(message) << ErrorInfo::BarIndex(mPdaBar->getIndex()));
-    }
-  }
 };
 
 } // namespace roc

src/Pda/PdaBar.h

@@ -113,6 +113,14 @@ class PdaBar : public BarInterface
     return mBarLength;
   }
 
+  /// Checks if this is the correct BAR. Used to check for BAR 2 for special functions.
+  void assertBarIndex(int index, std::string message) const
+  {
+    if (getIndex() != index) {
+      BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message(message) << ErrorInfo::BarIndex(getIndex()));
+    }
+  }
+
   virtual boost::optional<int32_t> getSerial() override
   {
     return {};
@@ -195,7 +203,6 @@ class PdaBar : public BarInterface
   {
     return reinterpret_cast<void*>(mUserspaceAddress + byteOffset);
   }
-
   /// PDA object for the PCI BAR
   Bar* mPdaBar;
 

src/RocPciDevice.cxx

@@ -22,7 +22,7 @@
 #include <boost/format.hpp>
 #include <functional>
 #include <iostream>
-#include "Crorc/Crorc.h"
+#include "Crorc/CrorcBar.h"
 #include "Cru/CruBar.h"
 #include "Pda/PdaDevice.h"
 #include "ReadoutCard/ChannelFactory.h"
@@ -256,7 +256,8 @@ int cruGetSerial(std::shared_ptr<Pda::PdaBar> pdaBar2)
 
 int crorcGetSerial(std::shared_ptr<Pda::PdaBar> pdaBar0)
 {
-  return Crorc::getSerial(*pdaBar0.get()).get();
+  int serial = CrorcBar(pdaBar0).getSerial().get();
+  return serial;
 }
 
 int cruGetEndpoint(std::shared_ptr<Pda::PdaBar> pdaBar0)