[status] Report TTC PON quality

Author: kostorr

README.md

@@ -551,18 +551,19 @@ metric format for the CRORC and the CRU is different, as different parameters ar
 
 ###### Metric: `"onu"`
 
-| Value name         | Value                       | Type   | 
-| -------------------| --------------------------- | ------ | 
-| `"onuStickyStatus"`| 0/1 (DOWN/UP)               | int    |
-| `"onuAddress"`     | ONU Address                 | string |
-| `"rx40Locked"`     | 0/1 (False/True)            | int    |
-| `"phaseGood"`      | 0/1 (False/True)            | int    |
-| `"rxLocked"`       | 0/1 (False/True)            | int    |
-| `"operational"`    | 0/1 (False/True)            | int    |
-| `"mgtTxReady"`     | 0/1 (False/True)            | int    |
-| `"mgtRxReady"`     | 0/1 (False/True)            | int    |
-| `"mgtTxPllLocked"` | 0/1 (False/True)            | int    |
-| `"mgtRxPllLocked"` | 0/1 (False/True)            | int    |
+| Value name         - | Value                       | Type   | 
+| ---------------------| --------------------------- | ------ | 
+| `"onuStickyStatus"`  | 0/1 (DOWN/UP)               | int    |
+| `"onuAddress"`       | ONU Address                 | string |
+| `"rx40Locked"`       | 0/1 (False/True)            | int    |
+| `"phaseGood"`        | 0/1 (False/True)            | int    |
+| `"rxLocked"`         | 0/1 (False/True)            | int    |
+| `"operational"`      | 0/1 (False/True)            | int    |
+| `"mgtTxReady"`       | 0/1 (False/True)            | int    |
+| `"mgtRxReady"`       | 0/1 (False/True)            | int    |
+| `"mgtTxPllLocked"`   | 0/1 (False/True)            | int    |
+| `"mgtRxPllLocked"`   | 0/1 (False/True)            | int    |
+| `"ponQualityStatus"` | 0/1 (Bad/Good)              | int    |
 
 | Tag key               | Value                 |
 | --------------------- | --------------------- |

src/CommandLineUtilities/ProgramStatus.cxx

@@ -248,6 +248,9 @@ class ProgramStatus : public Program
           onuStickyStatusInt = 0;
         }
 
+        std::string ponQualityStatusStr;
+        ponQualityStatusStr = onuStatus.ponQualityStatus ? "good" : "bad";
+
         if (mOptions.monitoring) {
           monitoring->send(Metric{ "onu" }
                              .addValue(onuStickyStatusInt, "onuStickyStatus")
@@ -260,6 +263,7 @@ class ProgramStatus : public Program
                              .addValue(onuStatus.mgtRxReady, "mgtRxReady")
                              .addValue(onuStatus.mgtTxPllLocked, "mgtTxPllLocked")
                              .addValue(onuStatus.mgtRxPllLocked, "mgtRxPllLocked")
+                             .addValue(onuStatus.ponQualityStatus, "ponQualityStatus")
                              .addTag(tags::Key::SerialId, card.serialId.getSerial())
                              .addTag(tags::Key::Endpoint, card.serialId.getEndpoint())
                              .addTag(tags::Key::ID, card.sequenceId)
@@ -275,6 +279,8 @@ class ProgramStatus : public Program
           root.put("ONU MGT RX ready", onuStatus.mgtRxReady);
           root.put("ONU MGT TX PLL locked", onuStatus.mgtTxPllLocked);
           root.put("ONU MGT RX PLL locked", onuStatus.mgtRxPllLocked);
+          root.put("PON quality", Utilities::toHexString(onuStatus.ponQuality));
+          root.put("PON quality Status", ponQualityStatusStr);
         } else {
           std::cout << "=============================" << std::endl;
           std::cout << "ONU status: \t\t" << onuStickyStatus << std::endl;
@@ -288,6 +294,8 @@ class ProgramStatus : public Program
           std::cout << "ONU MGT RX ready: \t" << std::boolalpha << onuStatus.mgtRxReady << std::endl;
           std::cout << "ONU MGT TX PLL locked: \t" << std::boolalpha << onuStatus.mgtTxPllLocked << std::endl;
           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;
         }
       }
 

src/Cru/Common.h

@@ -112,6 +112,8 @@ struct OnuStatus {
   bool mgtTxPllLocked;
   bool mgtRxPllLocked;
   LinkStatus stickyBit;
+  uint32_t ponQuality;
+  int ponQualityStatus;
 };
 
 struct LinkPacketInfo {

src/Cru/Constants.h

@@ -181,13 +181,16 @@ static constexpr Register LOCK_CLOCK_TO_REF(0x00220000);
 
 /// Register for modifying TTC parameters (CLOCK_/DATA_)
 static constexpr Register TTC_DATA(0x00200000);
-static constexpr Register TTC_ONU_STICKY(0x00200014);
 /*static constexpr uint32_t CLOCK_TTC(0x0);
 static constexpr uint32_t CLOCK_LOCAL(0x2);
 static constexpr uint32_t DATA_CTP(0x0);
 static constexpr uint32_t DATA_PATTERN(0x1);
 static constexpr uint32_t DATA_MIDTRG(0x2);*/
 
+/// Registers for getting TTC info
+static constexpr Register TTC_ONU_STICKY(0x00200014);
+static constexpr Register TTC_PON_QUALITY(0x0010000C);
+
 /// Registers used for TTC calibration
 static constexpr Register PON_WRAPPER_PLL(0x00224000);
 static constexpr Register PON_WRAPPER_TX(0x00226000);

src/Cru/Ttc.cxx

@@ -173,7 +173,9 @@ OnuStatus Ttc::onuStatus()
     calStatus >> 5 & 0x1,
     calStatus >> 6 & 0x1,
     calStatus >> 7 & 0x1,
-    getOnuStickyBit()
+    getOnuStickyBit(),
+    getPonQuality(),
+    getPonQualityStatus()
   };
 
   return onuStatus;
@@ -388,6 +390,22 @@ void Ttc::setFixedBCTrigger(std::vector<uint32_t> FBCTVector)
   }
 }
 
+uint32_t Ttc::getPonQuality()
+{
+  return mBar->readRegister(Cru::Registers::TTC_PON_QUALITY.index);
+}
+
+int Ttc::getPonQualityStatus()
+{
+  uint32_t ponQuality = getPonQuality();
+  std::this_thread::sleep_for(std::chrono::milliseconds(10));
+  if (ponQuality == getPonQuality()) {
+      return 1; // GOOD
+  }
+
+  return 0; // BAD
+}
+
 // Currently unused by RoC
 /*void Ttc::atxref(uint32_t refClock)
 {

src/Cru/Ttc.h

@@ -54,6 +54,8 @@ class Ttc
   void configurePlls(uint32_t clock);
   void setRefGen(int frequency = 240);
   LinkStatus getOnuStickyBit();
+  uint32_t getPonQuality();
+  int getPonQualityStatus();
 
   std::shared_ptr<BarInterface> mBar;
   std::unique_ptr<Interprocess::Lock> mI2cLock;