power-supply/power_supply.cpp - openbmc/witherspoon-pfault-analysis - Gitiles

 /**
  * Copyright © 2017 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.
  */
 #include <phosphor-logging/log.hpp>
 #include <phosphor-logging/elog.hpp>
 #include <org/open_power/Witherspoon/Fault/error.hpp>
 #include <xyz/openbmc_project/Common/Device/error.hpp>
 #include "elog-errors.hpp"
 #include "names_values.hpp"
 #include "power_supply.hpp"
 #include "pmbus.hpp"
 #include "utility.hpp"

 using namespace phosphor::logging;
 using namespace sdbusplus::org::open_power::Witherspoon::Fault::Error;
 using namespace sdbusplus::xyz::openbmc_project::Common::Device::Error;

 namespace witherspoon
 {
 namespace power
 {
 namespace psu
 {

 constexpr auto INVENTORY_OBJ_PATH = "/xyz/openbmc_project/inventory";
 constexpr auto INVENTORY_INTERFACE = "xyz.openbmc_project.Inventory.Item";
 constexpr auto PRESENT_PROP = "Present";
 constexpr auto POWER_OBJ_PATH = "/org/openbmc/control/power0";
 constexpr auto POWER_INTERFACE = "org.openbmc.control.Power";

 PowerSupply::PowerSupply(const std::string& name, size_t inst,
                          const std::string& objpath,
                          const std::string& invpath,
                          sdbusplus::bus::bus& bus,
                          event::Event& e,
                          std::chrono::seconds& t,
                          std::chrono::seconds& p)
     : Device(name, inst), monitorPath(objpath), pmbusIntf(objpath),
       inventoryPath(INVENTORY_OBJ_PATH + invpath), bus(bus), event(e),
       presentInterval(p),
       presentTimer(e, [this]()
                    {
                        // The hwmon path may have changed.
                        pmbusIntf.findHwmonDir();
                        this->present = true;
                    }),
       powerOnInterval(t),
       powerOnTimer(e, [this]()
                    {
                        this->powerOn = true;
                    })
 {
     using namespace sdbusplus::bus;
     presentMatch = std::make_unique<match_t>(bus,
                                              match::rules::propertiesChanged(
                                                      inventoryPath,
                                                      INVENTORY_INTERFACE),
                                              [this](auto& msg)
                                              {
                                                  this->inventoryChanged(msg);
                                              });
     // Get initial presence state.
     updatePresence();

     // Subscribe to power state changes
     powerOnMatch = std::make_unique<match_t>(bus,
                                              match::rules::propertiesChanged(
                                                      POWER_OBJ_PATH,
                                                      POWER_INTERFACE),
                                              [this](auto& msg)
                                              {
                                                  this->powerStateChanged(msg);
                                              });
     // Get initial power state.
     updatePowerState();
 }

 void PowerSupply::captureCmd(util::NamesValues& nv, const std::string& cmd,
                              witherspoon::pmbus::Type type)
 {
     if (pmbusIntf.exists(cmd, type))
     {
         try
         {
             auto val = pmbusIntf.read(cmd, type);
             nv.add(cmd, val);
         }
         catch (std::exception& e)
         {
             log<level::INFO>("Unable to capture metadata", entry("CMD=%s",
                                                                  cmd));
         }
     }
 }

 void PowerSupply::analyze()
 {
     using namespace witherspoon::pmbus;

     try
     {
         if (present)
         {
             std::uint16_t statusWord = 0;

             // Read the 2 byte STATUS_WORD value to check for faults.
             statusWord = pmbusIntf.read(STATUS_WORD, Type::Debug);
             readFail = 0;

             checkInputFault(statusWord);

             if (powerOn && !faultFound)
             {
                 checkFanFault(statusWord);
                 checkTemperatureFault(statusWord);
                 checkOutputOvervoltageFault(statusWord);
                 checkCurrentOutOverCurrentFault(statusWord);
                 checkPGOrUnitOffFault(statusWord);
             }
         }
     }
     catch (ReadFailure& e)
     {
         if (readFail < FAULT_COUNT)
         {
             readFail++;
         }

         if (!readFailLogged && readFail >= FAULT_COUNT)
         {
             commit<ReadFailure>();
             readFailLogged = true;
         }
     }

     return;
 }

 void PowerSupply::inventoryChanged(sdbusplus::message::message& msg)
 {
     std::string msgSensor;
     std::map<std::string, sdbusplus::message::variant<uint32_t, bool>> msgData;
     msg.read(msgSensor, msgData);

     // Check if it was the Present property that changed.
     auto valPropMap = msgData.find(PRESENT_PROP);
     if (valPropMap != msgData.end())
     {
         if (sdbusplus::message::variant_ns::get<bool>(valPropMap->second))
         {
             clearFaults();
             presentTimer.start(presentInterval, Timer::TimerType::oneshot);
         }
         else
         {
             present = false;
             presentTimer.stop();
         }
     }

     return;
 }

 void PowerSupply::updatePresence()
 {
     // Use getProperty utility function to get presence status.
     std::string service = "xyz.openbmc_project.Inventory.Manager";
     util::getProperty(INVENTORY_INTERFACE, PRESENT_PROP, inventoryPath,
                       service, bus, this->present);
 }

 void PowerSupply::powerStateChanged(sdbusplus::message::message& msg)
 {
     int32_t state = 0;
     std::string msgSensor;
     std::map<std::string, sdbusplus::message::variant<int32_t, int32_t>>
             msgData;
     msg.read(msgSensor, msgData);

     // Check if it was the Present property that changed.
     auto valPropMap = msgData.find("state");
     if (valPropMap != msgData.end())
     {
         state = sdbusplus::message::variant_ns::get<int32_t>(valPropMap->second);

         // Power is on when state=1. Set the fault logged variables to false
         // and start the power on timer when the state changes to 1.
         if (state)
         {
             clearFaults();
             powerOnTimer.start(powerOnInterval, Timer::TimerType::oneshot);
         }
         else
         {
             powerOnTimer.stop();
             powerOn = false;
         }
     }

 }

 void PowerSupply::updatePowerState()
 {
     // When state = 1, system is powered on
     int32_t state = 0;

     try
     {
         auto service = util::getService(POWER_OBJ_PATH,
                                         POWER_INTERFACE,
                                         bus);

         // Use getProperty utility function to get power state.
         util::getProperty<int32_t>(POWER_INTERFACE,
                                    "state",
                                    POWER_OBJ_PATH,
                                    service,
                                    bus,
                                    state);

         if (state)
         {
             powerOn = true;
         }
         else
         {
             powerOn = false;
         }
     }
     catch (std::exception& e)
     {
         log<level::INFO>("Failed to get power state. Assuming it is off.");
         powerOn = false;
     }

 }

 void PowerSupply::checkInputFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     if ((inputFault < FAULT_COUNT) &&
         ((statusWord & status_word::INPUT_FAULT_WARN) ||
          (statusWord & status_word::VIN_UV_FAULT)))
     {
         inputFault++;
     }
     else
     {
         if ((inputFault > 0) &&
             !(statusWord & status_word::INPUT_FAULT_WARN) &&
             !(statusWord & status_word::VIN_UV_FAULT))
         {
             inputFault = 0;
             faultFound = false;

             log<level::INFO>("INPUT_FAULT_WARN cleared",
                              entry("POWERSUPPLY=%s", inventoryPath.c_str()));

             if (powerOn)
             {
                 // The power supply will not be immediately powered on after
                 // the input power is restored.
                 powerOn = false;
                 // Start up the timer that will set the state to indicate we
                 // are ready for the powered on fault checks.
                 powerOnTimer.start(powerOnInterval, Timer::TimerType::oneshot);
             }
         }
     }

     if (!faultFound && (inputFault >= FAULT_COUNT))
     {
         util::NamesValues nv;
         nv.add("STATUS_WORD", statusWord);
         captureCmd(nv, STATUS_INPUT, Type::Debug);

         using metadata = org::open_power::Witherspoon::Fault::
                 PowerSupplyInputFault;

         report<PowerSupplyInputFault>(
                 metadata::RAW_STATUS(nv.get().c_str()),
                 metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));
         faultFound = true;
     }

 }

 void PowerSupply::checkPGOrUnitOffFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     if (powerOnFault < FAULT_COUNT)
     {
         // Check PG# and UNIT_IS_OFF
         if ((statusWord & status_word::POWER_GOOD_NEGATED) ||
             (statusWord & status_word::UNIT_IS_OFF))
         {
             log<level::INFO>("PGOOD or UNIT_IS_OFF bit bad",
                              entry("STATUS_WORD=0x%04X", statusWord));
             powerOnFault++;
         }
         else
         {
             if (powerOnFault > 0)
             {
                 log<level::INFO>("PGOOD and UNIT_IS_OFF bits good");
                 powerOnFault = 0;
             }
         }

         if (!faultFound && (powerOnFault >= FAULT_COUNT))
         {
             faultFound = true;

             util::NamesValues nv;
             nv.add("STATUS_WORD", statusWord);
             captureCmd(nv, STATUS_INPUT, Type::Debug);
             auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
             captureCmd(nv, status0Vout, Type::Debug);
             captureCmd(nv, STATUS_IOUT, Type::Debug);
             captureCmd(nv, STATUS_MFR, Type::Debug);

             using metadata = org::open_power::Witherspoon::Fault::
                     PowerSupplyShouldBeOn;

             // A power supply is OFF (or pgood low) but should be on.
             report<PowerSupplyShouldBeOn>(
                     metadata::RAW_STATUS(nv.get().c_str()),
                     metadata::CALLOUT_INVENTORY_PATH(
                             inventoryPath.c_str()));
         }
     }

 }

 void PowerSupply::checkCurrentOutOverCurrentFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     if (outputOCFault < FAULT_COUNT)
     {
         // Check for an output overcurrent fault.
         if ((statusWord & status_word::IOUT_OC_FAULT))
         {
             outputOCFault++;
         }
         else
         {
             if (outputOCFault > 0)
             {
                 outputOCFault = 0;
             }
         }

         if (!faultFound && (outputOCFault >= FAULT_COUNT))
         {
             util::NamesValues nv;
             nv.add("STATUS_WORD", statusWord);
             captureCmd(nv, STATUS_INPUT, Type::Debug);
             auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
             captureCmd(nv, status0Vout, Type::Debug);
             captureCmd(nv, STATUS_IOUT, Type::Debug);
             captureCmd(nv, STATUS_MFR, Type::Debug);

             using metadata = org::open_power::Witherspoon::Fault::
                     PowerSupplyOutputOvercurrent;

             report<PowerSupplyOutputOvercurrent>(
                     metadata::RAW_STATUS(nv.get().c_str()),
                     metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

             faultFound = true;
         }
     }
 }

 void PowerSupply::checkOutputOvervoltageFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     if (outputOVFault < FAULT_COUNT)
     {
         // Check for an output overvoltage fault.
         if (statusWord & status_word::VOUT_OV_FAULT)
         {
             outputOVFault++;
         }
         else
         {
             if (outputOVFault > 0)
             {
                 outputOVFault = 0;
             }
         }

         if (!faultFound && (outputOVFault >= FAULT_COUNT))
         {
             util::NamesValues nv;
             nv.add("STATUS_WORD", statusWord);
             captureCmd(nv, STATUS_INPUT, Type::Debug);
             auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
             captureCmd(nv, status0Vout, Type::Debug);
             captureCmd(nv, STATUS_IOUT, Type::Debug);
             captureCmd(nv, STATUS_MFR, Type::Debug);

             using metadata = org::open_power::Witherspoon::Fault::
                     PowerSupplyOutputOvervoltage;

             report<PowerSupplyOutputOvervoltage>(
                     metadata::RAW_STATUS(nv.get().c_str()),
                     metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

             faultFound = true;
         }
     }
 }

 void PowerSupply::checkFanFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     if (fanFault < FAULT_COUNT)
     {
         // Check for a fan fault or warning condition
         if (statusWord & status_word::FAN_FAULT)
         {
             fanFault++;
         }
         else
         {
             if (fanFault > 0)
             {
                 fanFault = 0;
             }
         }

         if (!faultFound && (fanFault >= FAULT_COUNT))
         {
             util::NamesValues nv;
             nv.add("STATUS_WORD", statusWord);
             captureCmd(nv, STATUS_MFR, Type::Debug);
             captureCmd(nv, STATUS_TEMPERATURE, Type::Debug);
             captureCmd(nv, STATUS_FANS_1_2, Type::Debug);

             using metadata = org::open_power::Witherspoon::Fault::
                     PowerSupplyFanFault;

             report<PowerSupplyFanFault>(
                     metadata::RAW_STATUS(nv.get().c_str()),
                     metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

             faultFound = true;
         }
     }
 }

 void PowerSupply::checkTemperatureFault(const uint16_t statusWord)
 {
     using namespace witherspoon::pmbus;

     // Due to how the PMBus core device driver sends a clear faults command
     // the bit in STATUS_WORD will likely be cleared when we attempt to examine
     // it for a Thermal Fault or Warning. So, check the STATUS_WORD and the
     // STATUS_TEMPERATURE bits. If either indicates a fault, proceed with
     // logging the over-temperature condition.
     std::uint8_t statusTemperature = 0;
     statusTemperature = pmbusIntf.read(STATUS_TEMPERATURE, Type::Debug);
     if (temperatureFault < FAULT_COUNT)
     {
         if ((statusWord & status_word::TEMPERATURE_FAULT_WARN) ||
             (statusTemperature & status_temperature::OT_FAULT))
         {
             temperatureFault++;
         }
         else
         {
             if (temperatureFault > 0)
             {
                 temperatureFault = 0;
             }
         }

         if (!faultFound && (temperatureFault >= FAULT_COUNT))
         {
             // The power supply has had an over-temperature condition.
             // This may not result in a shutdown if experienced for a short
             // duration.
             // This should not occur under normal conditions.
             // The power supply may be faulty, or the paired supply may be
             // putting out less current.
             // Capture command responses with potentially relevant information,
             // and call out the power supply reporting the condition.
             util::NamesValues nv;
             nv.add("STATUS_WORD", statusWord);
             captureCmd(nv, STATUS_MFR, Type::Debug);
             captureCmd(nv, STATUS_IOUT, Type::Debug);
             nv.add("STATUS_TEMPERATURE", statusTemperature);
             captureCmd(nv, STATUS_FANS_1_2, Type::Debug);

             using metadata = org::open_power::Witherspoon::Fault::
                     PowerSupplyTemperatureFault;

             report<PowerSupplyTemperatureFault>(
                     metadata::RAW_STATUS(nv.get().c_str()),
                     metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

             faultFound = true;
         }
     }
 }

 void PowerSupply::clearFaults()
 {
     readFail = 0;
     readFailLogged = false;
     inputFault = 0;
     powerOnFault = 0;
     outputOCFault = 0;
     outputOVFault = 0;
     fanFault = 0;
     temperatureFault = 0;
     faultFound = false;

     return;
 }

 void PowerSupply::resolveError(const std::string& callout,
                                const std::string& message)
 {
     // to be filled in.
     return;
 }

 }
 }
 }
	/**
	* Copyright © 2017 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.
	*/
	#include <phosphor-logging/log.hpp>
	#include <phosphor-logging/elog.hpp>
	#include <org/open_power/Witherspoon/Fault/error.hpp>
	#include <xyz/openbmc_project/Common/Device/error.hpp>
	#include "elog-errors.hpp"
	#include "names_values.hpp"
	#include "power_supply.hpp"
	#include "pmbus.hpp"
	#include "utility.hpp"

	using namespace phosphor::logging;
	using namespace sdbusplus::org::open_power::Witherspoon::Fault::Error;
	using namespace sdbusplus::xyz::openbmc_project::Common::Device::Error;

	namespace witherspoon
	{
	namespace power
	{
	namespace psu
	{

	constexpr auto INVENTORY_OBJ_PATH = "/xyz/openbmc_project/inventory";
	constexpr auto INVENTORY_INTERFACE = "xyz.openbmc_project.Inventory.Item";
	constexpr auto PRESENT_PROP = "Present";
	constexpr auto POWER_OBJ_PATH = "/org/openbmc/control/power0";
	constexpr auto POWER_INTERFACE = "org.openbmc.control.Power";

	PowerSupply::PowerSupply(const std::string& name, size_t inst,
	const std::string& objpath,
	const std::string& invpath,
	sdbusplus::bus::bus& bus,
	event::Event& e,
	std::chrono::seconds& t,
	std::chrono::seconds& p)
	: Device(name, inst), monitorPath(objpath), pmbusIntf(objpath),
	inventoryPath(INVENTORY_OBJ_PATH + invpath), bus(bus), event(e),
	presentInterval(p),
	presentTimer(e, [this]()
	{
	// The hwmon path may have changed.
	pmbusIntf.findHwmonDir();
	this->present = true;
	}),
	powerOnInterval(t),
	powerOnTimer(e, [this]()
	{
	this->powerOn = true;
	})
	{
	using namespace sdbusplus::bus;
	presentMatch = std::make_unique<match_t>(bus,
	match::rules::propertiesChanged(
	inventoryPath,
	INVENTORY_INTERFACE),
	[this](auto& msg)
	{
	this->inventoryChanged(msg);
	});
	// Get initial presence state.
	updatePresence();

	// Subscribe to power state changes
	powerOnMatch = std::make_unique<match_t>(bus,
	match::rules::propertiesChanged(
	POWER_OBJ_PATH,
	POWER_INTERFACE),
	[this](auto& msg)
	{
	this->powerStateChanged(msg);
	});
	// Get initial power state.
	updatePowerState();
	}

	void PowerSupply::captureCmd(util::NamesValues& nv, const std::string& cmd,
	witherspoon::pmbus::Type type)
	{
	if (pmbusIntf.exists(cmd, type))
	{
	try
	{
	auto val = pmbusIntf.read(cmd, type);
	nv.add(cmd, val);
	}
	catch (std::exception& e)
	{
	log<level::INFO>("Unable to capture metadata", entry("CMD=%s",
	cmd));
	}
	}
	}

	void PowerSupply::analyze()
	{
	using namespace witherspoon::pmbus;

	try
	{
	if (present)
	{
	std::uint16_t statusWord = 0;

	// Read the 2 byte STATUS_WORD value to check for faults.
	statusWord = pmbusIntf.read(STATUS_WORD, Type::Debug);
	readFail = 0;

	checkInputFault(statusWord);

	if (powerOn && !faultFound)
	{
	checkFanFault(statusWord);
	checkTemperatureFault(statusWord);
	checkOutputOvervoltageFault(statusWord);
	checkCurrentOutOverCurrentFault(statusWord);
	checkPGOrUnitOffFault(statusWord);
	}
	}
	}
	catch (ReadFailure& e)
	{
	if (readFail < FAULT_COUNT)
	{
	readFail++;
	}

	if (!readFailLogged && readFail >= FAULT_COUNT)
	{
	commit<ReadFailure>();
	readFailLogged = true;
	}
	}

	return;
	}

	void PowerSupply::inventoryChanged(sdbusplus::message::message& msg)
	{
	std::string msgSensor;
	std::map<std::string, sdbusplus::message::variant<uint32_t, bool>> msgData;
	msg.read(msgSensor, msgData);

	// Check if it was the Present property that changed.
	auto valPropMap = msgData.find(PRESENT_PROP);
	if (valPropMap != msgData.end())
	{
	if (sdbusplus::message::variant_ns::get<bool>(valPropMap->second))
	{
	clearFaults();
	presentTimer.start(presentInterval, Timer::TimerType::oneshot);
	}
	else
	{
	present = false;
	presentTimer.stop();
	}
	}

	return;
	}

	void PowerSupply::updatePresence()
	{
	// Use getProperty utility function to get presence status.
	std::string service = "xyz.openbmc_project.Inventory.Manager";
	util::getProperty(INVENTORY_INTERFACE, PRESENT_PROP, inventoryPath,
	service, bus, this->present);
	}

	void PowerSupply::powerStateChanged(sdbusplus::message::message& msg)
	{
	int32_t state = 0;
	std::string msgSensor;
	std::map<std::string, sdbusplus::message::variant<int32_t, int32_t>>
	msgData;
	msg.read(msgSensor, msgData);

	// Check if it was the Present property that changed.
	auto valPropMap = msgData.find("state");
	if (valPropMap != msgData.end())
	{
	state = sdbusplus::message::variant_ns::get<int32_t>(valPropMap->second);

	// Power is on when state=1. Set the fault logged variables to false
	// and start the power on timer when the state changes to 1.
	if (state)
	{
	clearFaults();
	powerOnTimer.start(powerOnInterval, Timer::TimerType::oneshot);
	}
	else
	{
	powerOnTimer.stop();
	powerOn = false;
	}
	}

	}

	void PowerSupply::updatePowerState()
	{
	// When state = 1, system is powered on
	int32_t state = 0;

	try
	{
	auto service = util::getService(POWER_OBJ_PATH,
	POWER_INTERFACE,
	bus);

	// Use getProperty utility function to get power state.
	util::getProperty<int32_t>(POWER_INTERFACE,
	"state",
	POWER_OBJ_PATH,
	service,
	bus,
	state);

	if (state)
	{
	powerOn = true;
	}
	else
	{
	powerOn = false;
	}
	}
	catch (std::exception& e)
	{
	log<level::INFO>("Failed to get power state. Assuming it is off.");
	powerOn = false;
	}

	}

	void PowerSupply::checkInputFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	if ((inputFault < FAULT_COUNT) &&
	((statusWord & status_word::INPUT_FAULT_WARN) \|\|
	(statusWord & status_word::VIN_UV_FAULT)))
	{
	inputFault++;
	}
	else
	{
	if ((inputFault > 0) &&
	!(statusWord & status_word::INPUT_FAULT_WARN) &&
	!(statusWord & status_word::VIN_UV_FAULT))
	{
	inputFault = 0;
	faultFound = false;

	log<level::INFO>("INPUT_FAULT_WARN cleared",
	entry("POWERSUPPLY=%s", inventoryPath.c_str()));

	if (powerOn)
	{
	// The power supply will not be immediately powered on after
	// the input power is restored.
	powerOn = false;
	// Start up the timer that will set the state to indicate we
	// are ready for the powered on fault checks.
	powerOnTimer.start(powerOnInterval, Timer::TimerType::oneshot);
	}
	}
	}

	if (!faultFound && (inputFault >= FAULT_COUNT))
	{
	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_INPUT, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyInputFault;

	report<PowerSupplyInputFault>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));
	faultFound = true;
	}

	}

	void PowerSupply::checkPGOrUnitOffFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	if (powerOnFault < FAULT_COUNT)
	{
	// Check PG# and UNIT_IS_OFF
	if ((statusWord & status_word::POWER_GOOD_NEGATED) \|\|
	(statusWord & status_word::UNIT_IS_OFF))
	{
	log<level::INFO>("PGOOD or UNIT_IS_OFF bit bad",
	entry("STATUS_WORD=0x%04X", statusWord));
	powerOnFault++;
	}
	else
	{
	if (powerOnFault > 0)
	{
	log<level::INFO>("PGOOD and UNIT_IS_OFF bits good");
	powerOnFault = 0;
	}
	}

	if (!faultFound && (powerOnFault >= FAULT_COUNT))
	{
	faultFound = true;

	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_INPUT, Type::Debug);
	auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
	captureCmd(nv, status0Vout, Type::Debug);
	captureCmd(nv, STATUS_IOUT, Type::Debug);
	captureCmd(nv, STATUS_MFR, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyShouldBeOn;

	// A power supply is OFF (or pgood low) but should be on.
	report<PowerSupplyShouldBeOn>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(
	inventoryPath.c_str()));
	}
	}

	}

	void PowerSupply::checkCurrentOutOverCurrentFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	if (outputOCFault < FAULT_COUNT)
	{
	// Check for an output overcurrent fault.
	if ((statusWord & status_word::IOUT_OC_FAULT))
	{
	outputOCFault++;
	}
	else
	{
	if (outputOCFault > 0)
	{
	outputOCFault = 0;
	}
	}

	if (!faultFound && (outputOCFault >= FAULT_COUNT))
	{
	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_INPUT, Type::Debug);
	auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
	captureCmd(nv, status0Vout, Type::Debug);
	captureCmd(nv, STATUS_IOUT, Type::Debug);
	captureCmd(nv, STATUS_MFR, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyOutputOvercurrent;

	report<PowerSupplyOutputOvercurrent>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

	faultFound = true;
	}
	}
	}

	void PowerSupply::checkOutputOvervoltageFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	if (outputOVFault < FAULT_COUNT)
	{
	// Check for an output overvoltage fault.
	if (statusWord & status_word::VOUT_OV_FAULT)
	{
	outputOVFault++;
	}
	else
	{
	if (outputOVFault > 0)
	{
	outputOVFault = 0;
	}
	}

	if (!faultFound && (outputOVFault >= FAULT_COUNT))
	{
	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_INPUT, Type::Debug);
	auto status0Vout = pmbusIntf.insertPageNum(STATUS_VOUT, 0);
	captureCmd(nv, status0Vout, Type::Debug);
	captureCmd(nv, STATUS_IOUT, Type::Debug);
	captureCmd(nv, STATUS_MFR, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyOutputOvervoltage;

	report<PowerSupplyOutputOvervoltage>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

	faultFound = true;
	}
	}
	}

	void PowerSupply::checkFanFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	if (fanFault < FAULT_COUNT)
	{
	// Check for a fan fault or warning condition
	if (statusWord & status_word::FAN_FAULT)
	{
	fanFault++;
	}
	else
	{
	if (fanFault > 0)
	{
	fanFault = 0;
	}
	}

	if (!faultFound && (fanFault >= FAULT_COUNT))
	{
	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_MFR, Type::Debug);
	captureCmd(nv, STATUS_TEMPERATURE, Type::Debug);
	captureCmd(nv, STATUS_FANS_1_2, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyFanFault;

	report<PowerSupplyFanFault>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

	faultFound = true;
	}
	}
	}

	void PowerSupply::checkTemperatureFault(const uint16_t statusWord)
	{
	using namespace witherspoon::pmbus;

	// Due to how the PMBus core device driver sends a clear faults command
	// the bit in STATUS_WORD will likely be cleared when we attempt to examine
	// it for a Thermal Fault or Warning. So, check the STATUS_WORD and the
	// STATUS_TEMPERATURE bits. If either indicates a fault, proceed with
	// logging the over-temperature condition.
	std::uint8_t statusTemperature = 0;
	statusTemperature = pmbusIntf.read(STATUS_TEMPERATURE, Type::Debug);
	if (temperatureFault < FAULT_COUNT)
	{
	if ((statusWord & status_word::TEMPERATURE_FAULT_WARN) \|\|
	(statusTemperature & status_temperature::OT_FAULT))
	{
	temperatureFault++;
	}
	else
	{
	if (temperatureFault > 0)
	{
	temperatureFault = 0;
	}
	}

	if (!faultFound && (temperatureFault >= FAULT_COUNT))
	{
	// The power supply has had an over-temperature condition.
	// This may not result in a shutdown if experienced for a short
	// duration.
	// This should not occur under normal conditions.
	// The power supply may be faulty, or the paired supply may be
	// putting out less current.
	// Capture command responses with potentially relevant information,
	// and call out the power supply reporting the condition.
	util::NamesValues nv;
	nv.add("STATUS_WORD", statusWord);
	captureCmd(nv, STATUS_MFR, Type::Debug);
	captureCmd(nv, STATUS_IOUT, Type::Debug);
	nv.add("STATUS_TEMPERATURE", statusTemperature);
	captureCmd(nv, STATUS_FANS_1_2, Type::Debug);

	using metadata = org::open_power::Witherspoon::Fault::
	PowerSupplyTemperatureFault;

	report<PowerSupplyTemperatureFault>(
	metadata::RAW_STATUS(nv.get().c_str()),
	metadata::CALLOUT_INVENTORY_PATH(inventoryPath.c_str()));

	faultFound = true;
	}
	}
	}

	void PowerSupply::clearFaults()
	{
	readFail = 0;
	readFailLogged = false;
	inputFault = 0;
	powerOnFault = 0;
	outputOCFault = 0;
	outputOVFault = 0;
	fanFault = 0;
	temperatureFault = 0;
	faultFound = false;

	return;
	}

	void PowerSupply::resolveError(const std::string& callout,
	const std::string& message)
	{
	// to be filled in.
	return;
	}

	}
	}
	}