Fabric: add support for PCIe Switch Port Metrics

harshit-aghera · edtanous · commit 2fd07a9f05c2 · 2026-03-12T15:18:42.000Z
This patch enable support for following properties for Port Metrics URI of a PCIe Switch. [1] - PCIeErrors.CorrectableErrorCount - PCIeErrors.NonFatalErrorCount - PCIeErrors.FatalErrorCount - PCIeErrors.L0ToRecoveryCount - PCIeErrors.ReplayCount - PCIeErrors.ReplayRolloverCount - PCIeErrors.NAKSentCount - PCIeErrors.NAKReceivedCount - PCIeErrors.UnsupportedRequestCount The patch uses "xyz.openbmc_project.Metric.Value" Interface for PCIe Port Metrics properties. Association between a Metric and a Port is `measuring` and `measured_by`. PDI patch - https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/84839 dbus-sensors patches - https://gerrit.openbmc.org/c/openbmc/dbus-sensors/+/84132 Tested: Build an image for nvl32-obmc machine with the following patch cherry picked. https://gerrit.openbmc.org/c/openbmc/dbus-sensors/+/84132 https://gerrit.openbmc.org/c/openbmc/openbmc/+/85490 The openbmc patch cherry-picks the following patches that are currently under review. ``` 1. device tree https://lore.kernel.org/all/aRbLqH8pLWCQryhu@molberding.nvidia.com/ 2. mctpd patches CodeConstruct/mctp#85 3. u-boot changes https://lore.kernel.org/openbmc/20251121-msx4-v1-0-fc0118b666c1@nvidia.com/T/#t 4. kernel changes as specified in the openbmc patch (for espi) 5. entity-manager changes https://gerrit.openbmc.org/c/openbmc/entity-manager/+/85455 6. platform-init changes https://gerrit.openbmc.org/c/openbmc/platform-init/+/85456 7. spi changes https://lore.kernel.org/all/20251121-w25q01jv_fixup-v1-1-3d175050db73@nvidia.com/ ``` redfish service validator is passing. ``` $ curl -k -u 'root:0penBmc' https://${bmc_ip}/redfish/v1/Fabrics/fabric/Switches/Nvidia_ConnectX_0/Ports/UP_0/Metrics/ { "@odata.id": "/redfish/v1/Fabrics/fabric/Switches/Nvidia_ConnectX_0/Ports/UP_0/Metrics", "@odata.type": "#PortMetrics.v1_3_0.PortMetrics", "Id": "Metrics", "Name": "Nvidia_ConnectX_0 UP_0 Port Metrics", "PCIeErrors": { "CorrectableErrorCount": 0, "FatalErrorCount": 0, "L0ToRecoveryCount": 1, "NAKReceivedCount": 0, "NAKSentCount": 0, "NonFatalErrorCount": 0, "ReplayCount": 0, "ReplayRolloverCount": 0, "UnsupportedRequestCount": 0 } }% ``` [1]: https://redfish.dmtf.org/schemas/v1/PortMetrics_v1.xml Change-Id: I7cca75fa5d4c77a4b02d35f7ce0b024f325ceff0 Signed-off-by: Harshit Aghera <haghera@nvidia.com>
diff --git a/docs/Redfish.md b/docs/Redfish.md
@@ -1283,6 +1283,16 @@ functions the same like the default implementation under the System resource.
 - @odata.type
 - Id
 - Name
+- PCIeErrors
+  - CorrectableErrorCount
+  - NonFatalErrorCount
+  - FatalErrorCount
+  - L0ToRecoveryCount
+  - ReplayCount
+  - ReplayRolloverCount
+  - NAKSentCount
+  - NAKReceivedCount
+  - UnsupportedRequestCount
 
 [1]: https://www.dmtf.org/standards/redfish
 [2]: https://github.com/DMTF/Redfish-Service-Validator
diff --git a/redfish-core/lib/switch_port.hpp b/redfish-core/lib/switch_port.hpp
@@ -24,16 +24,13 @@
 #include <cstddef>
 #include <format>
 #include <functional>
+#include <limits>
 #include <memory>
 #include <optional>
 #include <string>
 #include <string_view>
 #include <utility>
 
-static constexpr const char* inventoryPath = "/xyz/openbmc_project/inventory";
-static constexpr std::array<std::string_view, 1> portInterface = {
-    "xyz.openbmc_project.Inventory.Connector.Port"};
-
 namespace redfish
 {
 inline port::PortType dBusSensorPortTypeToRedfish(const std::string& portType)
@@ -132,10 +129,127 @@ inline void afterGetFabricSwitchPortInfo(
     }
 }
 
+inline void populateMetricsProperty(
+    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+    const nlohmann::json::json_pointer& jsonPtr,
+    const boost::system::error_code& ec, double value)
+{
+    if (ec)
+    {
+        BMCWEB_LOG_DEBUG(
+            "DBus response error on GetProperty {} for property {}", ec,
+            jsonPtr.to_string());
+        return;
+    }
+
+    if (!std::isfinite(value))
+    {
+        BMCWEB_LOG_DEBUG("Received non-finite value for property {}",
+                         jsonPtr.to_string());
+
+        asyncResp->res.jsonValue[jsonPtr] = nullptr;
+    }
+    else
+    {
+        asyncResp->res.jsonValue[jsonPtr] = static_cast<int64_t>(value);
+    }
+}
+
+inline void getMetricProperty(
+    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+    const std::string& serviceName,
+    const sdbusplus::message::object_path& objectPath,
+    const nlohmann::json::json_pointer& jsonPtr)
+{
+    dbus::utility::getProperty<double>(
+        serviceName, objectPath, "xyz.openbmc_project.Metric.Value", "Value",
+        std::bind_front(populateMetricsProperty, asyncResp, jsonPtr));
+}
+
+inline void handleFabricSwitchPortMetricsPathPortMetricsGet(
+    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+    const boost::system::error_code& ec,
+    const dbus::utility::MapperGetSubTreeResponse& object)
+{
+    if (ec)
+    {
+        BMCWEB_LOG_ERROR("DBus response error on GetAssociatedSubTree{}", ec);
+        messages::internalError(asyncResp->res);
+        return;
+    }
+
+    for (const auto& [path, service] : object)
+    {
+        if (service.size() != 1)
+        {
+            continue;
+        }
+
+        sdbusplus::message::object_path objectPah(path);
+
+        const std::string metricType = objectPah.parent_path().filename();
+        const std::string metricName = objectPah.filename();
+
+        if (metricType != "pcie")
+        {
+            continue;
+        }
+
+        const auto& serviceName = service.begin()->first;
+
+        if (metricName == "correctable_error_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/CorrectableErrorCount"_json_pointer);
+        }
+        else if (metricName == "non_fatal_error_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/NonFatalErrorCount"_json_pointer);
+        }
+        else if (metricName == "fatal_error_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/FatalErrorCount"_json_pointer);
+        }
+        else if (metricName == "l0_to_recovery_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/L0ToRecoveryCount"_json_pointer);
+        }
+        else if (metricName == "replay_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/ReplayCount"_json_pointer);
+        }
+        else if (metricName == "replay_rollover_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/ReplayRolloverCount"_json_pointer);
+        }
+        else if (metricName == "nak_sent_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/NAKSentCount"_json_pointer);
+        }
+        else if (metricName == "nak_received_count")
+        {
+            getMetricProperty(asyncResp, serviceName, path,
+                              "/PCIeErrors/NAKReceivedCount"_json_pointer);
+        }
+        else if (metricName == "unsupported_request_count")
+        {
+            getMetricProperty(
+                asyncResp, serviceName, path,
+                "/PCIeErrors/UnsupportedRequestCount"_json_pointer);
+        }
+    }
+}
+
 inline void handleFabricSwitchPortPathPortMetricsGet(
     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
     const std::string& fabricId, const std::string& switchId,
-    const std::string& portId, [[maybe_unused]] const std::string& portPath,
+    const std::string& portId, const std::string& portPath,
     [[maybe_unused]] const std::string& serviceName)
 {
     asyncResp->res.jsonValue["@odata.type"] = "#PortMetrics.v1_3_0.PortMetrics";
@@ -145,6 +259,15 @@ inline void handleFabricSwitchPortPathPortMetricsGet(
     asyncResp->res.jsonValue["Id"] = "Metrics";
     asyncResp->res.jsonValue["Name"] =
         std::format("{} {} Port Metrics", switchId, portId);
+
+    const sdbusplus::message::object_path associationPath =
+        sdbusplus::message::object_path(portPath) / "measured_by";
+    dbus::utility::getAssociatedSubTree(
+        associationPath,
+        sdbusplus::message::object_path("/xyz/openbmc_project/metric"), 0,
+        std::array<std::string_view, 1>{"xyz.openbmc_project.Metric.Value"},
+        std::bind_front(handleFabricSwitchPortMetricsPathPortMetricsGet,
+                        asyncResp));
 }
 
 inline void handleFabricSwitchPortPathPortGet(
@@ -170,7 +293,7 @@ inline void handleFabricSwitchPortPathPortGet(
         switchId, portId);
 
     dbus::utility::getAllProperties(
-        serviceName, portPath, std::string{portInterface[0]},
+        serviceName, portPath, "xyz.openbmc_project.Inventory.Connector.Port",
         std::bind_front(afterGetFabricSwitchPortInfo, asyncResp));
 }
 
@@ -226,8 +349,10 @@ inline void getAssociatedPortPath(
 {
     std::string associationPath = switchPath + "/connecting";
     dbus::utility::getAssociatedSubTree(
-        associationPath, sdbusplus::message::object_path{inventoryPath}, 0,
-        portInterface,
+        associationPath,
+        sdbusplus::message::object_path{"/xyz/openbmc_project/inventory"}, 0,
+        std::array<std::string_view, 1>{
+            "xyz.openbmc_project.Inventory.Connector.Port"},
         std::bind_front(afterHandleFabricSwitchPortPaths, asyncResp, portId,
                         std::move(callback)));
 }
@@ -273,8 +398,10 @@ inline void getFabricSwitchPortPaths(
 {
     std::string associationPath = switchPath + "/connecting";
     dbus::utility::getAssociatedSubTreePaths(
-        associationPath, sdbusplus::message::object_path{inventoryPath}, 0,
-        portInterface,
+        associationPath,
+        sdbusplus::message::object_path{"/xyz/openbmc_project/inventory"}, 0,
+        std::array<std::string_view, 1>{
+            "xyz.openbmc_project.Inventory.Connector.Port"},
         std::bind_front(handleFabricSwitchPathPortCollection, asyncResp,
                         fabricId, switchId));
 }
diff --git a/test/redfish-core/lib/service_root_test.cpp b/test/redfish-core/lib/service_root_test.cpp
@@ -58,6 +58,9 @@ void assertServiceRootGet(crow::Response& res)
     EXPECT_EQ(json["Managers"]["@odata.id"], "/redfish/v1/Managers");
     EXPECT_EQ(json["Managers"].size(), 1);
 
+    EXPECT_EQ(json["Fabrics"]["@odata.id"], "/redfish/v1/Fabrics");
+    EXPECT_EQ(json["Fabrics"].size(), 1);
+
     EXPECT_EQ(json["Name"], "Root Service");
     EXPECT_EQ(json["RedfishVersion"], "1.17.0");
 
