xref: /openbmc/phosphor-power/tools/power-utils/validator.hpp (revision 2ae582185602511620aca1dd1c0256171b7547bb)

/**
 * Copyright © 2025 IBM Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include "types.hpp"
#include "utility.hpp"

#include <sdbusplus/bus.hpp>

#include <string>

namespace validator
{
using namespace phosphor::power::util;
/**
 * @class PSUUpdateValidator
 * @brief This class validates PSU configurations in OpenBMC.
 */
class PSUUpdateValidator
{
  public:
    /**
     * @brief Constructor - Initializes D-Bus connection.
     *
     * @param bus The sdbusplus DBus bus connection
     * @param psuPath PSU inventory path
     */
    PSUUpdateValidator(sdbusplus::bus_t& bus, const std::string& psuPath) :
        bus(bus), psuPath(psuPath)
    {}

    /**
     * @brief Checks if all PSUs are of the same model.
     *
     * @return true if all PSUs have the same model.
     * @return false if any PSU has a different model.
     */
    bool areAllPsuSameModel();

    /**
     * @brief Counts the number of PSUs that are physically present and
     * operational
     *
     * @return true if successfully counted present PSUs.
     * @return false on failure.
     */
    bool countPresentPsus();

    /**
     * @brief Retrieves the required number of PSUs for redundancy.
     *
     * @return true if successfully retrieved redundancy count.
     * @return false on failure.
     */
    bool getRequiredPsus();

    /**
     * @brief Ensure all PSUs have same model, validate all PSUs present
     * and functional meet or exceed the number of PSUs required for this
     * system
     *
     * @return true if all configuration requirement are met.
     * @return otherwise false
     */
    bool validToUpdate();

    /**
     * @brief Retrieves the operational PSU status.
     *
     * @return true if operational
     * @return false on operational failure.
     */
    bool isItFunctional(const std::string& path);

  private:
    sdbusplus::bus_t& bus;             // D-Bus connection instance
    std::vector<std::string> psuPaths; // List of PSU object paths
    std::string targetPsuModel;        // Model name of the reference PSU
    std::string psuPath;               // Path  of the referenced PSU
    DbusSubtree supportedObjects;      // D-Bus PSU supported objects
    DbusPropertyMap properties;        // D-Bus PSU properties
    int presentPsuCount = 0;           // Count of physically present PSUs
    int redundantCount = 0;            // Total number of PSUs required to be
                                       // in this system configuration.
};

} // namespace validator