psu-ng: Add peak input power sensor for some PSs
Some models of the ibm-cffps power supplies support an 'input history'
command that reports 30 second maximum and average input power values.
The code was currently putting those on an 'org.open_power' D-Bus
interface so that the history of those values could be captured in a
single D-Bus call.
Now that there is a real telemetry feature in Redfish that can capture
the history of a single sensor value, we can drop the custom D-Bus
interface and just use the normal Sensor.Value interface that contains
the most recent maximum value from the input history command, The sensor
name will be 'psX_input_power_peak' where X is the PS instance number.
The average input power telemetry will now just be obtained from the
psX_input_power sensor provided by phosphor-hwmon so an equivalent
sensor to the peak isn't needed here.
This commit will add support for putting the new sensor on D-Bus, and a
future one will remove the previous input history support.
Like sensors in other daemons, it will be set to not available when a PS
is removed, and not functional when it has an access problem. There
will be associations to the parent chassis and to the power supply so it
will show up in Redfish output with the other sensors.
This commit did remove one of the input history testcases, as trying to
get the right sequence of EXPECT_CALLs would get tricky when both the
old and new are running together.
Tested:
- New sensor shows up when PS is present and supports it.
- All interfaces on the object path are correct.
- Sensor value matches what org.open_power Max property had.
- Works correctly when:
- PS is missing on startup
- PS is removed
- Previously present PS is replaced.
Change-Id: Id9c33aa753c9af32880a0cc874b39c113222568f
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
diff --git a/phosphor-power-supply/power_supply.hpp b/phosphor-power-supply/power_supply.hpp
index 3690bd8..ec1290e 100644
--- a/phosphor-power-supply/power_supply.hpp
+++ b/phosphor-power-supply/power_supply.hpp
@@ -10,7 +10,10 @@
#include <gpiod.hpp>
#include <sdbusplus/bus/match.hpp>
+#include <xyz/openbmc_project/Association/Definitions/server.hpp>
#include <xyz/openbmc_project/Sensor/Value/server.hpp>
+#include <xyz/openbmc_project/State/Decorator/Availability/server.hpp>
+#include <xyz/openbmc_project/State/Decorator/OperationalStatus/server.hpp>
#include <filesystem>
#include <stdexcept>
@@ -53,8 +56,19 @@
constexpr auto IBMCFFPS_DD_NAME = "ibm-cffps";
constexpr auto ACBEL_FSG032_DD_NAME = "acbel-fsg032";
+using AvailabilityInterface =
+ sdbusplus::xyz::openbmc_project::State::Decorator::server::Availability;
+using OperationalStatusInterface = sdbusplus::xyz::openbmc_project::State::
+ Decorator::server::OperationalStatus;
+using AssocDefInterface =
+ sdbusplus::xyz::openbmc_project::Association::server::Definitions;
using SensorInterface = sdbusplus::xyz::openbmc_project::Sensor::server::Value;
using SensorObject = sdbusplus::server::object_t<SensorInterface>;
+using PowerSensorObject =
+ sdbusplus::server::object_t<SensorInterface, OperationalStatusInterface,
+ AvailabilityInterface, AssocDefInterface>;
+
+using AssociationTuple = std::tuple<std::string, std::string, std::string>;
/**
* @class PowerSupply
@@ -545,6 +559,33 @@
*/
void setInputVoltageRating();
+ /**
+ * @brief Returns the peak input power value if there is one,
+ * otherwise std::nullopt.
+ */
+ std::optional<double> getPeakInputPower() const
+ {
+ std::optional<double> value;
+ if (peakInputPowerSensor)
+ {
+ value = peakInputPowerSensor->value();
+ }
+ return value;
+ }
+
+ /**
+ * @brief Converts a Linear Format power number to an integer
+ *
+ * The PMBus spec describes a 2 byte Linear Format
+ * number that is composed of an exponent and mantissa
+ * in two's complement notation.
+ *
+ * Value = Mantissa * 2**Exponent
+ *
+ * @return double - The converted value
+ */
+ static double linearToInteger(uint16_t data);
+
private:
/**
* @brief Examine STATUS_WORD for CML (communication, memory, logic fault).
@@ -751,6 +792,39 @@
void getPsuVpdFromDbus(const std::string& keyword, std::string& vpdStr);
/**
+ * @brief Creates the appropriate sensor D-Bus objects.
+ */
+ void setupSensors();
+
+ /**
+ * @brief Monitors sensor values and updates D-Bus.
+ * Called from analyze().
+ */
+ void monitorSensors();
+
+ /**
+ * @brief Creates the peak input power sensor D-Bus object
+ * if the PS supports it.
+ */
+ void setupInputPowerPeakSensor();
+
+ /**
+ * @brief Monitors the peak input power sensor
+ */
+ void monitorPeakInputPowerSensor();
+
+ /**
+ * @brief Sets any sensor objects to Available = false on D-Bus.
+ */
+ void setSensorsNotAvailable();
+
+ /**
+ * @brief Returns the associations to create for a sensor on this
+ * power supply.
+ */
+ std::vector<AssociationTuple> getSensorAssociations();
+
+ /**
* @brief systemd bus member
*/
sdbusplus::bus_t& bus;
@@ -1053,6 +1127,11 @@
std::unique_ptr<SensorObject> inputVoltageRatingIface;
/**
+ * @brief The D-Bus object for the peak input power sensor.
+ */
+ std::unique_ptr<PowerSensorObject> peakInputPowerSensor;
+
+ /**
* @brief The device driver name
*/
std::string driverName;