[roc-status] Add PON RX power

Author: kostorr

README.md

@@ -600,6 +600,7 @@ metric format for the CRORC and the CRU is different, as different parameters ar
 | `"mgtTxPllLocked"`   | 0/1 (False/True)            | int    |
 | `"mgtRxPllLocked"`   | 0/1 (False/True)            | int    |
 | `"ponQualityStatus"` | 0/1 (Bad/Good)              | int    |
+| `"ponRxPower"`       | dBm                         | int    |
 
 | Tag key               | Value                 |
 | --------------------- | --------------------- |

src/CommandLineUtilities/ProgramStatus.cxx

@@ -272,6 +272,7 @@ class ProgramStatus : public Program
                              .addValue(onuStatus.mgtTxPllLocked, "mgtTxPllLocked")
                              .addValue(onuStatus.mgtRxPllLocked, "mgtRxPllLocked")
                              .addValue(onuStatus.ponQualityStatus, "ponQualityStatus")
+                             .addValue(onuStatus.ponRxPower, "ponRxPower")
                              .addTag(tags::Key::SerialId, card.serialId.getSerial())
                              .addTag(tags::Key::Endpoint, card.serialId.getEndpoint())
                              .addTag(tags::Key::ID, card.sequenceId)
@@ -289,6 +290,7 @@ class ProgramStatus : public Program
           root.put("ONU MGT RX PLL locked", onuStatus.mgtRxPllLocked);
           root.put("PON quality", Utilities::toHexString(onuStatus.ponQuality));
           root.put("PON quality Status", ponQualityStatusStr);
+          root.put("PON RX power (dBm)", onuStatus.ponRxPower);
         } else {
           std::cout << "=============================" << std::endl;
           std::cout << "ONU status: \t\t" << onuStickyStatus << std::endl;
@@ -304,6 +306,7 @@ class ProgramStatus : public Program
           std::cout << "ONU MGT RX PLL locked: \t" << std::boolalpha << onuStatus.mgtRxPllLocked << std::endl;
           std::cout << "PON quality: \t\t0x" << std::hex << onuStatus.ponQuality << std::endl;
           std::cout << "PON quality status: \t" << ponQualityStatusStr << std::endl;
+          std::cout << "PON RX power (dBm): \t" << onuStatus.ponRxPower << std::endl;
         }
       }
 

src/Cru/Common.h

@@ -114,6 +114,7 @@ struct OnuStatus {
   LinkStatus stickyBit;
   uint32_t ponQuality;
   int ponQualityStatus;
+  double ponRxPower;
 };
 
 struct FecStatus {

src/Cru/Constants.h

@@ -164,6 +164,9 @@ static constexpr Register DDG_CTRL2(0x00d00004);
 /// Register to control BSP
 static constexpr Register BSP_USER_CONTROL(0x00000018);
 
+/// Register to access I2C SFP information
+static constexpr Register BSP_I2C_SFP_1(0x00030200);
+
 /// Register to access I2C minipod information
 static constexpr Register BSP_I2C_MINIPODS(0x00030300);
 

src/Cru/CruBar.cxx

@@ -498,7 +498,7 @@ Cru::ReportInfo CruBar::report(bool forConfig)
   // Update the link map with optical power information through I2C
   I2c i2c = I2c(Cru::Registers::BSP_I2C_MINIPODS.address, 0x0, mPdaBar, mEndpoint);
 
-  // lock I2C operation
+  // lock I2C operations
   std::unique_ptr<Interprocess::Lock> i2cLock = std::make_unique<Interprocess::Lock>("_Alice_O2_RoC_I2C_" + std::to_string(mSerial) + "_lock", true);
   i2c.getOpticalPower(linkMap);
   i2cLock.reset();
@@ -1061,7 +1061,7 @@ void CruBar::patternPlayer(PatternPlayer::Info info)
 
 Cru::OnuStatus CruBar::reportOnuStatus()
 {
-  Ttc ttc = Ttc(mPdaBar, mSerial);
+  Ttc ttc = Ttc(mPdaBar, mSerial, mEndpoint);
   return ttc.onuStatus();
 }
 

src/Cru/I2c.cxx

@@ -241,5 +241,19 @@ void I2c::getOpticalPower(std::map<int, Link>& linkMap)
   return;
 }
 
+double I2c::getRxPower()
+{
+  resetI2c();
+  uint32_t address = 0x68;
+  uint32_t rxPower = readI2c(address) << 8;
+  rxPower |= readI2c(address + 1); // unit: 0.1*uW
+  if (rxPower) {
+    double watts = rxPower * 0.1 * 1e-6;
+    return 10 * log10(watts / 1e-3); // convert to dBm
+  } else {
+    return -1 * std::numeric_limits<double>::infinity();
+  }
+}
+
 } // namespace roc
 } // namespace AliceO2

src/Cru/I2c.h

@@ -41,6 +41,7 @@ class I2c
   void configurePll();
   uint32_t getSelectedClock();
   void getOpticalPower(std::map<int, Link>& linkMap);
+  double getRxPower(); //unit: dBm
   uint32_t readI2c(uint32_t address);
 
  private:

src/Cru/Ttc.cxx

@@ -33,7 +33,7 @@ using LinkStatus = Cru::LinkStatus;
 using OnuStatus = Cru::OnuStatus;
 using FecStatus = Cru::FecStatus;
 
-Ttc::Ttc(std::shared_ptr<BarInterface> bar, int serial) : mBar(bar), mSerial(serial)
+Ttc::Ttc(std::shared_ptr<BarInterface> bar, int serial, int endpoint) : mBar(bar), mSerial(serial), mEndpoint(endpoint)
 {
 }
 
@@ -177,7 +177,8 @@ OnuStatus Ttc::onuStatus()
     (calStatus >> 7 & 0x1) == 1,
     getOnuStickyBit(),
     getPonQuality(),
-    getPonQualityStatus()
+    getPonQualityStatus(),
+    getPonRxPower()
   };
 }
 
@@ -429,6 +430,18 @@ int Ttc::getPonQualityStatus()
   return 0; // BAD
 }
 
+double Ttc::getPonRxPower()
+{
+  I2c i2c = I2c(Cru::Registers::BSP_I2C_SFP_1.address, 0x51, mBar, mEndpoint);
+
+  // lock I2C operations
+  std::unique_ptr<Interprocess::Lock> i2cLock = std::make_unique<Interprocess::Lock>("_Alice_O2_RoC_I2C_" + std::to_string(mSerial) + "_lock", true);
+  auto rxPower = i2c.getRxPower();
+  i2cLock.reset();
+
+  return rxPower;
+}
+
 // Currently unused by RoC
 /*void Ttc::atxref(uint32_t refClock)
 {

src/Cru/Ttc.h

@@ -22,7 +22,7 @@ class Ttc
   using LinkStatus = Cru::LinkStatus;
 
  public:
-  Ttc(std::shared_ptr<BarInterface> bar, int serial = -1);
+  Ttc(std::shared_ptr<BarInterface> bar, int serial = -1, int endpoint = -1);
 
   void calibrateTtc();
   void setClock(uint32_t clock);
@@ -60,11 +60,13 @@ class Ttc
   LinkStatus getOnuStickyBit();
   uint32_t getPonQuality();
   int getPonQualityStatus();
+  double getPonRxPower();
 
   std::shared_ptr<BarInterface> mBar;
   std::unique_ptr<Interprocess::Lock> mI2cLock;
 
   int mSerial;
+  int mEndpoint;
   static constexpr uint32_t MAX_BCID = 3564 - 1;
 };
 } // namespace roc

src/Cru/cru_constants_populate.py

@@ -106,6 +106,7 @@
 'add_gbt_bank_fpll':'GBT_BANK_FPLL',
 'add_bsp_i2c_eeprom':"BSP_I2C_EEPROM",
 'add_bsp_i2c_minipods':"BSP_I2C_MINIPODS",
+'add_bsp_i2c_sfp1':"BSP_I2C_SFP_1",
 'add_bsp_i2c_si5345_1':'SI5345_1',
 'add_bsp_i2c_si5345_2':'SI5345_2',
 'add_bsp_i2c_si5344':'SI5344',