pseq: Start using device objects from JSON parser
Start using the C++ PowerSequencerDevice objects created by the updated
JSON parser in the phosphor-power-sequencer application.
The C++ PowerSequencerDevice objects are created based on
power_sequencer objects in the new JSON configuration file format.
The PowerSequencerDevice objects are currently only used to find the
rail that caused a pgood error. So this commit enables the current
single-chassis support to work with the new JSON configuration files.
Some of the code changes are temporary.
Subsequent commits will implement more multi-chassis support based on
the new and modified C++ objects returned by the parser.
Tested:
* Verified config file was successfully found based on compatible system
information.
* Tested cases where config file parsing succeeded and failed.
* Verified normal system power on and power off were successful with no
errors logged.
* Verified error logged when pgood fault injected before and after
powering on the system.
* Tested when no config file was found. Verified system could still be
powered on/off. Verified general error logged when pgood fault
occurred.
Change-Id: Id4351693346aa5c372be181dcbf0b7bd567d9c40
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
diff --git a/phosphor-power-sequencer/src/power_control.cpp b/phosphor-power-sequencer/src/power_control.cpp
index 4b8315c..f5b4735 100644
--- a/phosphor-power-sequencer/src/power_control.cpp
+++ b/phosphor-power-sequencer/src/power_control.cpp
@@ -16,17 +16,15 @@
#include "power_control.hpp"
+#include "chassis.hpp"
#include "config_file_parser.hpp"
#include "format_utils.hpp"
#include "types.hpp"
-#include "ucd90160_device.hpp"
-#include "ucd90320_device.hpp"
#include "utility.hpp"
#include <exception>
#include <format>
#include <functional>
-#include <map>
#include <span>
#include <stdexcept>
#include <thread>
@@ -57,9 +55,6 @@
compatSysTypesFinder = std::make_unique<util::CompatibleSystemTypesFinder>(
bus, std::bind_front(&PowerControl::compatibleSystemTypesFound, this));
- deviceFinder = std::make_unique<DeviceFinder>(
- bus, std::bind_front(&PowerControl::deviceFound, this));
-
setUpGpio();
}
@@ -97,20 +92,8 @@
std::string error;
std::map<std::string, std::string> additionalData{};
- // Check if pgood fault occurred on rail monitored by power sequencer device
- if (device)
- {
- try
- {
- error = device->findPgoodFault(services, powerSupplyError,
- additionalData);
- }
- catch (const std::exception& e)
- {
- services.logErrorMsg(e.what());
- additionalData.emplace("ERROR", e.what());
- }
- }
+ // Check if pgood fault occurred on one of the rails being monitored
+ error = findPgoodFault(additionalData);
// If fault was not isolated to a voltage rail, select a more generic error
if (error.empty())
@@ -137,6 +120,38 @@
}
}
+std::string PowerControl::findPgoodFault(
+ std::map<std::string, std::string>& additionalData)
+{
+ // Note: This code is temporary. It will be replaced when additional
+ // multi-chassis support is implementated in this application.
+ std::string error{};
+ if (system)
+ {
+ try
+ {
+ for (auto& chassis : system->getChassis())
+ {
+ for (auto& powerSequencer : chassis->getPowerSequencers())
+ {
+ error = powerSequencer->findPgoodFault(
+ services, powerSupplyError, additionalData);
+ if (!error.empty())
+ {
+ return error;
+ }
+ }
+ }
+ }
+ catch (const std::exception& e)
+ {
+ services.logErrorMsg(e.what());
+ additionalData.emplace("ERROR", e.what());
+ }
+ }
+ return error;
+}
+
void PowerControl::pollPgood()
{
if (inStateTransition)
@@ -274,26 +289,8 @@
// Store compatible system types
compatibleSystemTypes = types;
- // Load config file and create device object if possible
- loadConfigFileAndCreateDevice();
- }
-}
-
-void PowerControl::deviceFound(const DeviceProperties& properties)
-{
- // If we don't already have device properties
- if (!deviceProperties)
- {
- services.logInfoMsg(std::format(
- "Power sequencer device found: type={}, name={}, bus={:d}, address={:#02x}",
- properties.type, properties.name, properties.bus,
- properties.address));
-
- // Store device properties
- deviceProperties = properties;
-
- // Load config file and create device object if possible
- loadConfigFileAndCreateDevice();
+ // Load config file that matches one of the compatible system types
+ loadConfigFile();
}
}
@@ -326,24 +323,23 @@
services.logInfoMsg(std::format("Pgood state: {}", pgoodState));
}
-void PowerControl::loadConfigFileAndCreateDevice()
+void PowerControl::loadConfigFile()
{
- // If compatible system types and device properties have been found
- if (!compatibleSystemTypes.empty() && deviceProperties)
+ try
{
- // Find the JSON configuration file
std::filesystem::path configFile = findConfigFile();
if (!configFile.empty())
{
- // Parse the JSON configuration file
- std::vector<std::unique_ptr<Rail>> rails;
- if (parseConfigFile(configFile, rails))
- {
- // Create the power sequencer device object
- createDevice(std::move(rails));
- }
+ std::vector<std::unique_ptr<Chassis>> chassis =
+ config_file_parser::parse(configFile, services);
+ system = std::make_unique<System>(std::move(chassis));
}
}
+ catch (const std::exception& e)
+ {
+ services.logErrorMsg(std::format(
+ "Unable to parse JSON configuration file: {}", e.what()));
+ }
}
std::filesystem::path PowerControl::findConfigFile()
@@ -370,59 +366,4 @@
return configFile;
}
-bool PowerControl::parseConfigFile(const std::filesystem::path& configFile,
- std::vector<std::unique_ptr<Rail>>&)
-{
- // Parse JSON configuration file
- bool wasParsed{false};
- try
- {
- config_file_parser::parse(configFile, services);
- // wasParsed = true;
- }
- catch (const std::exception& e)
- {
- services.logErrorMsg(std::format(
- "Unable to parse JSON configuration file: {}", e.what()));
- }
- return wasParsed;
-}
-
-void PowerControl::createDevice(std::vector<std::unique_ptr<Rail>> rails)
-{
- // Create power sequencer device based on device properties
- if (deviceProperties)
- {
- try
- {
- if (deviceProperties->type == UCD90160Device::deviceName)
- {
- device = std::make_unique<UCD90160Device>(
- deviceProperties->bus, deviceProperties->address,
- "power-chassis-control", "power-chassis-good",
- std::move(rails), services);
- }
- else if (deviceProperties->type == UCD90320Device::deviceName)
- {
- device = std::make_unique<UCD90320Device>(
- deviceProperties->bus, deviceProperties->address,
- "power-chassis-control", "power-chassis-good",
- std::move(rails), services);
- }
- else
- {
- throw std::runtime_error{std::format(
- "Unsupported device type: {}", deviceProperties->type)};
- }
- services.logInfoMsg(std::format(
- "Power sequencer device created: {}", device->getName()));
- }
- catch (const std::exception& e)
- {
- services.logErrorMsg(
- std::format("Unable to create device object: {}", e.what()));
- }
- }
-}
-
} // namespace phosphor::power::sequencer
diff --git a/phosphor-power-sequencer/src/power_control.hpp b/phosphor-power-sequencer/src/power_control.hpp
index 7bc2cd5..2f0ed39 100644
--- a/phosphor-power-sequencer/src/power_control.hpp
+++ b/phosphor-power-sequencer/src/power_control.hpp
@@ -3,11 +3,9 @@
#include "config.h"
#include "compatible_system_types_finder.hpp"
-#include "device_finder.hpp"
#include "power_interface.hpp"
-#include "power_sequencer_device.hpp"
-#include "rail.hpp"
#include "services.hpp"
+#include "system.hpp"
#include <gpiod.hpp>
#include <sdbusplus/bus.hpp>
@@ -18,8 +16,8 @@
#include <chrono>
#include <filesystem>
+#include <map>
#include <memory>
-#include <optional>
#include <string>
#include <vector>
@@ -76,13 +74,6 @@
*/
void compatibleSystemTypesFound(const std::vector<std::string>& types);
- /**
- * Callback that is called when a power sequencer device is found.
- *
- * @param properties Properties of device that was found
- */
- void deviceFound(const DeviceProperties& properties);
-
private:
/**
* The D-Bus bus object
@@ -106,19 +97,12 @@
std::vector<std::string> compatibleSystemTypes;
/**
- * Object that finds the power sequencer device in the system.
+ * Computer system being controlled and monitored by the BMC.
+ *
+ * Contains the information loaded from the JSON configuration file.
+ * Contains nullptr if the configuration file has not been loaded.
*/
- std::unique_ptr<DeviceFinder> deviceFinder;
-
- /**
- * Power sequencer device properties.
- */
- std::optional<DeviceProperties> deviceProperties;
-
- /**
- * Power sequencer device that enables and monitors the voltage rails.
- */
- std::unique_ptr<PowerSequencerDevice> device;
+ std::unique_ptr<System> system;
/**
* Indicates if a failure has already been found. Cleared at power on.
@@ -215,6 +199,22 @@
void onFailure(bool wasTimeOut);
/**
+ * Checks whether a pgood fault has occurred on one of the rails being
+ * monitored.
+ *
+ * If a pgood fault was found, this method returns a string containing the
+ * error that should be logged. If no fault was found, an empty string is
+ * returned.
+ *
+ * @param additionalData Additional data to include in the error log if
+ * a pgood fault was found
+ * @return error that should be logged if a pgood fault was found, or an
+ * empty string if no pgood fault was found
+ */
+ std::string findPgoodFault(
+ std::map<std::string, std::string>& additionalData);
+
+ /**
* Polling method for monitoring the system power good
*/
void pollPgood();
@@ -225,14 +225,14 @@
void setUpGpio();
/**
- * Loads the JSON configuration file and creates the power sequencer device
- * object.
+ * Loads the JSON configuration file.
*
- * Does nothing if the compatible system types or device properties have not
- * been found yet. These are obtained from D-Bus. The order in which they
- * are found and the time to find them varies.
+ * Looks for the config file using findConfigFile().
+ *
+ * If the config file is found, it is parsed and the resulting information
+ * is stored in the system data member.
*/
- void loadConfigFileAndCreateDevice();
+ void loadConfigFile();
/**
* Finds the JSON configuration file for the current system based on the
@@ -243,27 +243,6 @@
* @return absolute path to the config file, or empty path if file not found
*/
std::filesystem::path findConfigFile();
-
- /**
- * Parses the specified JSON configuration file.
- *
- * Returns the resulting vector of Rail objects in the output parameter.
- *
- * @param configFile Absolute path to the config file
- * @param rails Rail objects within the config file
- * @return true if file was parsed successfully, false otherwise
- */
- bool parseConfigFile(const std::filesystem::path& configFile,
- std::vector<std::unique_ptr<Rail>>& rails);
-
- /**
- * Creates the power sequencer device object based on the device properties.
- *
- * Does nothing if the device properties have not been found yet.
- *
- * @param rails Voltage rails that are enabled and monitored by the device
- */
- void createDevice(std::vector<std::unique_ptr<Rail>> rails);
};
} // namespace phosphor::power::sequencer