occ_status.cpp - openbmc/openpower-occ-control - Gitiles

 #include "occ_status.hpp"

 #include "occ_manager.hpp"
 #include "occ_sensor.hpp"
 #include "powermode.hpp"
 #include "utils.hpp"

 #include <fmt/core.h>

 #ifdef POWER10
 #include <com/ibm/Host/Target/server.hpp>
 #endif
 #include <phosphor-logging/log.hpp>

 namespace open_power
 {
 namespace occ
 {

 using namespace phosphor::logging;

 // Handles updates to occActive property
 bool Status::occActive(bool value)
 {
     if (value != this->occActive())
     {
         log<level::INFO>(fmt::format("Status::occActive OCC{} changed to {}",
                                      instance, value)
                              .c_str());
         if (value)
         {
             // Bind the device
             device.bind();

             // Start watching for errors
             addErrorWatch();

             // Reset last OCC state
             lastState = 0;

             if (device.master())
             {
                 if (!pcap)
                 {
                     // Create the power cap monitor object for master OCC
                     pcap = std::make_unique<powercap::PowerCap>(*this);
                 }
                 // Update powercap bounds from OCC
                 pcap->updatePcapBounds();
             }

             // Call into Manager to let know that we have bound
             if (this->managerCallBack)
             {
                 this->managerCallBack(value);
             }
         }
         else
         {
 #ifdef POWER10
             if (pmode && device.master())
             {
                 // Prevent mode changes
                 pmode->setMasterActive(false);
             }
             if (safeStateDelayTimer.isEnabled())
             {
                 // stop safe delay timer
                 safeStateDelayTimer.setEnabled(false);
             }
 #endif

             // Call into Manager to let know that we will unbind.
             if (this->managerCallBack)
             {
                 this->managerCallBack(value);
             }

             // Stop watching for errors
             removeErrorWatch();

             // Do the unbind.
             device.unBind();
         }
     }
     else if (value && !device.bound())
     {
         // Existing error watch is on a dead file descriptor.
         removeErrorWatch();

         /*
          * In it's constructor, Status checks Device::bound() to see if OCC is
          * active or not.
          * Device::bound() checks for occX-dev0 directory.
          * We will lose occX-dev0 directories during FSI rescan.
          * So, if we start this application (and construct Status), and then
          * later do FSI rescan, we will end up with occActive = true and device
          * NOT bound. Lets correct that situation here.
          */
         device.bind();

         // Add error watch again
         addErrorWatch();
     }
     else if (!value && device.bound())
     {
         removeErrorWatch();

         // In the event that the application never receives the active signal
         // even though the OCC is active (this can occur if the BMC is rebooted
         // with the host on, since the initial OCC driver probe will discover
         // the OCCs), this application needs to be able to unbind the device
         // when we get the OCC inactive signal.
         device.unBind();
     }
     return Base::Status::occActive(value);
 }

 // Callback handler when a device error is reported.
 void Status::deviceError()
 {
 #ifdef POWER10
     if (pmode && device.master())
     {
         // Prevent mode changes
         pmode->setMasterActive(false);
     }
 #endif

     // This would deem OCC inactive
     this->occActive(false);

     // Reset the OCC
     this->resetOCC();
 }

 // Sends message to host control command handler to reset OCC
 void Status::resetOCC()
 {
     log<level::INFO>(
         fmt::format(">>Status::resetOCC() - requesting reset for OCC{}",
                     instance)
             .c_str());
 #ifdef PLDM
     if (resetCallBack)
     {
         this->resetCallBack(instance);
     }
 #else
     constexpr auto CONTROL_HOST_PATH = "/org/open_power/control/host0";
     constexpr auto CONTROL_HOST_INTF = "org.open_power.Control.Host";

     // This will throw exception on failure
     auto service = utils::getService(CONTROL_HOST_PATH, CONTROL_HOST_INTF);

     auto& bus = utils::getBus();
     auto method = bus.new_method_call(service.c_str(), CONTROL_HOST_PATH,
                                       CONTROL_HOST_INTF, "Execute");
     // OCC Reset control command
     method.append(convertForMessage(Control::Host::Command::OCCReset).c_str());

     // OCC Sensor ID for callout reasons
     method.append(std::variant<uint8_t>(std::get<0>(sensorMap.at(instance))));
     bus.call_noreply(method);
     return;
 #endif
 }

 // Handler called by Host control command handler to convey the
 // status of the executed command
 void Status::hostControlEvent(sdbusplus::message::message& msg)
 {
     std::string cmdCompleted{};
     std::string cmdStatus{};

     msg.read(cmdCompleted, cmdStatus);

     log<level::DEBUG>("Host control signal values",
                       entry("COMMAND=%s", cmdCompleted.c_str()),
                       entry("STATUS=%s", cmdStatus.c_str()));

     if (Control::Host::convertResultFromString(cmdStatus) !=
         Control::Host::Result::Success)
     {
         if (Control::Host::convertCommandFromString(cmdCompleted) ==
             Control::Host::Command::OCCReset)
         {
             // Must be a Timeout. Log an Error trace
             log<level::ERR>(
                 "Error resetting the OCC.", entry("PATH=%s", path.c_str()),
                 entry("SENSORID=0x%X", std::get<0>(sensorMap.at(instance))));
         }
     }
     return;
 }

 void Status::readOccState()
 {
     unsigned int state;
     const fs::path filename =
         fs::path(DEV_PATH) /
         fs::path(sysfsName + "." + std::to_string(instance + 1)) / "occ_state";

     std::ifstream file(filename, std::ios::in);
     const int open_errno = errno;
     if (file)
     {
         file >> state;
         if (state != lastState)
         {
             // Trace OCC state changes
             log<level::INFO>(
                 fmt::format("Status::readOccState: OCC{} state 0x{:02X}",
                             instance, state)
                     .c_str());
             if (state & 0xFFFFFFF8)
             {
                 log<level::ERR>(
                     fmt::format("Status::readOccState: INVALID STATE from {}!!",
                                 filename.c_str())
                         .c_str());
             }
             lastState = state;

 #ifdef POWER10
             if (OccState(state) == OccState::ACTIVE)
             {
                 if (pmode && device.master())
                 {
                     // Set the master OCC on the PowerMode object
                     pmode->setMasterOcc(path);
                     // Enable mode changes
                     pmode->setMasterActive();

                     // Special processing by master OCC when it goes active
                     occsWentActive();
                 }

                 CmdStatus status = sendAmbient();
                 if (status != CmdStatus::SUCCESS)
                 {
                     log<level::ERR>(
                         fmt::format(
                             "readOccState: Sending Ambient failed with status {}",
                             status)
                             .c_str());
                 }
             }

             if (OccState(state) == OccState::SAFE)
             {
                 // start safe delay timer (before requesting reset)
                 using namespace std::literals::chrono_literals;
                 safeStateDelayTimer.restartOnce(60s);
             }
             else if (safeStateDelayTimer.isEnabled())
             {
                 // stop safe delay timer (no longer in SAFE state)
                 safeStateDelayTimer.setEnabled(false);
             }
 #endif
         }
         file.close();
     }
     else
     {
         // If not able to read, OCC may be offline
         log<level::DEBUG>(
             fmt::format("Status::readOccState: open failed (errno={})",
                         open_errno)
                 .c_str());
         lastState = 0;
     }
 }

 #ifdef POWER10
 // Special processing that needs to happen once the OCCs change to ACTIVE state
 void Status::occsWentActive()
 {
     CmdStatus status = CmdStatus::SUCCESS;

     status = pmode->sendModeChange();
     if (status != CmdStatus::SUCCESS)
     {
         log<level::ERR>(
             fmt::format(
                 "Status::occsWentActive: OCC mode change failed with status {}",
                 status)
                 .c_str());
     }

     status = pmode->sendIpsData();
     if (status != CmdStatus::SUCCESS)
     {
         log<level::ERR>(
             fmt::format(
                 "Status::occsWentActive: Sending Idle Power Save Config data failed with status {}",
                 status)
                 .c_str());
     }
 }

 // Send Ambient and Altitude to the OCC
 CmdStatus Status::sendAmbient(const uint8_t inTemp, const uint16_t inAltitude)
 {
     CmdStatus status = CmdStatus::FAILURE;
     bool ambientValid = true;
     uint8_t ambientTemp = inTemp;
     uint16_t altitude = inAltitude;

     if (ambientTemp == 0xFF)
     {
         // Get latest readings from manager
         manager.getAmbientData(ambientValid, ambientTemp, altitude);
         log<level::DEBUG>(
             fmt::format("sendAmbient: valid: {}, Ambient: {}C, altitude: {}m",
                         ambientValid, ambientTemp, altitude)
                 .c_str());
     }

     std::vector<std::uint8_t> cmd, rsp;
     cmd.reserve(11);
     cmd.push_back(uint8_t(CmdType::SEND_AMBIENT));
     cmd.push_back(0x00);                    // Data Length (2 bytes)
     cmd.push_back(0x08);                    //
     cmd.push_back(0x00);                    // Version
     cmd.push_back(ambientValid ? 0 : 0xFF); // Ambient Status
     cmd.push_back(ambientTemp);             // Ambient Temperature
     cmd.push_back(altitude >> 8);           // Altitude in meters (2 bytes)
     cmd.push_back(altitude & 0xFF);         //
     cmd.push_back(0x00);                    // Reserved (3 bytes)
     cmd.push_back(0x00);
     cmd.push_back(0x00);
     log<level::DEBUG>(fmt::format("sendAmbient: SEND_AMBIENT "
                                   "command to OCC{} ({} bytes)",
                                   instance, cmd.size())
                           .c_str());
     status = occCmd.send(cmd, rsp);
     if (status == CmdStatus::SUCCESS)
     {
         if (rsp.size() == 5)
         {
             if (RspStatus::SUCCESS != RspStatus(rsp[2]))
             {
                 log<level::ERR>(
                     fmt::format(
                         "sendAmbient: SEND_AMBIENT failed with status 0x{:02X}",
                         rsp[2])
                         .c_str());
                 dump_hex(rsp);
                 status = CmdStatus::FAILURE;
             }
         }
         else
         {
             log<level::ERR>("sendAmbient: INVALID SEND_AMBIENT response");
             dump_hex(rsp);
             status = CmdStatus::FAILURE;
         }
     }
     else
     {
         if (status == CmdStatus::OPEN_FAILURE)
         {
             // OCC not active yet
             status = CmdStatus::SUCCESS;
         }
         else
         {
             log<level::ERR>("sendAmbient: SEND_AMBIENT FAILED!");
         }
     }

     return status;
 }

 // Called when safe timer expires to determine if OCCs need to be reset
 void Status::safeStateDelayExpired()
 {
     if (this->occActive())
     {
         log<level::INFO>(
             fmt::format(
                 "safeStateDelayExpired: OCC{} is in SAFE state, requesting reset",
                 instance)
                 .c_str());
         // Disable and reset to try recovering
         deviceError();
     }
 }
 #endif // POWER10

 fs::path Status::getHwmonPath() const
 {
     using namespace std::literals::string_literals;

     // Build the base HWMON path
     fs::path prefixPath = fs::path{OCC_HWMON_PATH + "occ-hwmon."s +
                                    std::to_string(instance + 1) + "/hwmon/"s};
     // Get the hwmonXX directory name, there better only be 1 dir
     assert(std::distance(fs::directory_iterator(prefixPath),
                          fs::directory_iterator{}) == 1);

     return *fs::directory_iterator(prefixPath);
 }

 } // namespace occ
 } // namespace open_power
	#include "occ_status.hpp"

	#include "occ_manager.hpp"
	#include "occ_sensor.hpp"
	#include "powermode.hpp"
	#include "utils.hpp"

	#include <fmt/core.h>

	#ifdef POWER10
	#include <com/ibm/Host/Target/server.hpp>
	#endif
	#include <phosphor-logging/log.hpp>

	namespace open_power
	{
	namespace occ
	{

	using namespace phosphor::logging;

	// Handles updates to occActive property
	bool Status::occActive(bool value)
	{
	if (value != this->occActive())
	{
	log<level::INFO>(fmt::format("Status::occActive OCC{} changed to {}",
	instance, value)
	.c_str());
	if (value)
	{
	// Bind the device
	device.bind();

	// Start watching for errors
	addErrorWatch();

	// Reset last OCC state
	lastState = 0;

	if (device.master())
	{
	if (!pcap)
	{
	// Create the power cap monitor object for master OCC
	pcap = std::make_unique<powercap::PowerCap>(*this);
	}
	// Update powercap bounds from OCC
	pcap->updatePcapBounds();
	}

	// Call into Manager to let know that we have bound
	if (this->managerCallBack)
	{
	this->managerCallBack(value);
	}
	}
	else
	{
	#ifdef POWER10
	if (pmode && device.master())
	{
	// Prevent mode changes
	pmode->setMasterActive(false);
	}
	if (safeStateDelayTimer.isEnabled())
	{
	// stop safe delay timer
	safeStateDelayTimer.setEnabled(false);
	}
	#endif

	// Call into Manager to let know that we will unbind.
	if (this->managerCallBack)
	{
	this->managerCallBack(value);
	}

	// Stop watching for errors
	removeErrorWatch();

	// Do the unbind.
	device.unBind();
	}
	}
	else if (value && !device.bound())
	{
	// Existing error watch is on a dead file descriptor.
	removeErrorWatch();

	/*
	* In it's constructor, Status checks Device::bound() to see if OCC is
	* active or not.
	* Device::bound() checks for occX-dev0 directory.
	* We will lose occX-dev0 directories during FSI rescan.
	* So, if we start this application (and construct Status), and then
	* later do FSI rescan, we will end up with occActive = true and device
	* NOT bound. Lets correct that situation here.
	*/
	device.bind();

	// Add error watch again
	addErrorWatch();
	}
	else if (!value && device.bound())
	{
	removeErrorWatch();

	// In the event that the application never receives the active signal
	// even though the OCC is active (this can occur if the BMC is rebooted
	// with the host on, since the initial OCC driver probe will discover
	// the OCCs), this application needs to be able to unbind the device
	// when we get the OCC inactive signal.
	device.unBind();
	}
	return Base::Status::occActive(value);
	}

	// Callback handler when a device error is reported.
	void Status::deviceError()
	{
	#ifdef POWER10
	if (pmode && device.master())
	{
	// Prevent mode changes
	pmode->setMasterActive(false);
	}
	#endif

	// This would deem OCC inactive
	this->occActive(false);

	// Reset the OCC
	this->resetOCC();
	}

	// Sends message to host control command handler to reset OCC
	void Status::resetOCC()
	{
	log<level::INFO>(
	fmt::format(">>Status::resetOCC() - requesting reset for OCC{}",
	instance)
	.c_str());
	#ifdef PLDM
	if (resetCallBack)
	{
	this->resetCallBack(instance);
	}
	#else
	constexpr auto CONTROL_HOST_PATH = "/org/open_power/control/host0";
	constexpr auto CONTROL_HOST_INTF = "org.open_power.Control.Host";

	// This will throw exception on failure
	auto service = utils::getService(CONTROL_HOST_PATH, CONTROL_HOST_INTF);

	auto& bus = utils::getBus();
	auto method = bus.new_method_call(service.c_str(), CONTROL_HOST_PATH,
	CONTROL_HOST_INTF, "Execute");
	// OCC Reset control command
	method.append(convertForMessage(Control::Host::Command::OCCReset).c_str());

	// OCC Sensor ID for callout reasons
	method.append(std::variant<uint8_t>(std::get<0>(sensorMap.at(instance))));
	bus.call_noreply(method);
	return;
	#endif
	}

	// Handler called by Host control command handler to convey the
	// status of the executed command
	void Status::hostControlEvent(sdbusplus::message::message& msg)
	{
	std::string cmdCompleted{};
	std::string cmdStatus{};

	msg.read(cmdCompleted, cmdStatus);

	log<level::DEBUG>("Host control signal values",
	entry("COMMAND=%s", cmdCompleted.c_str()),
	entry("STATUS=%s", cmdStatus.c_str()));

	if (Control::Host::convertResultFromString(cmdStatus) !=
	Control::Host::Result::Success)
	{
	if (Control::Host::convertCommandFromString(cmdCompleted) ==
	Control::Host::Command::OCCReset)
	{
	// Must be a Timeout. Log an Error trace
	log<level::ERR>(
	"Error resetting the OCC.", entry("PATH=%s", path.c_str()),
	entry("SENSORID=0x%X", std::get<0>(sensorMap.at(instance))));
	}
	}
	return;
	}

	void Status::readOccState()
	{
	unsigned int state;
	const fs::path filename =
	fs::path(DEV_PATH) /
	fs::path(sysfsName + "." + std::to_string(instance + 1)) / "occ_state";

	std::ifstream file(filename, std::ios::in);
	const int open_errno = errno;
	if (file)
	{
	file >> state;
	if (state != lastState)
	{
	// Trace OCC state changes
	log<level::INFO>(
	fmt::format("Status::readOccState: OCC{} state 0x{:02X}",
	instance, state)
	.c_str());
	if (state & 0xFFFFFFF8)
	{
	log<level::ERR>(
	fmt::format("Status::readOccState: INVALID STATE from {}!!",
	filename.c_str())
	.c_str());
	}
	lastState = state;

	#ifdef POWER10
	if (OccState(state) == OccState::ACTIVE)
	{
	if (pmode && device.master())
	{
	// Set the master OCC on the PowerMode object
	pmode->setMasterOcc(path);
	// Enable mode changes
	pmode->setMasterActive();

	// Special processing by master OCC when it goes active
	occsWentActive();
	}

	CmdStatus status = sendAmbient();
	if (status != CmdStatus::SUCCESS)
	{
	log<level::ERR>(
	fmt::format(
	"readOccState: Sending Ambient failed with status {}",
	status)
	.c_str());
	}
	}

	if (OccState(state) == OccState::SAFE)
	{
	// start safe delay timer (before requesting reset)
	using namespace std::literals::chrono_literals;
	safeStateDelayTimer.restartOnce(60s);
	}
	else if (safeStateDelayTimer.isEnabled())
	{
	// stop safe delay timer (no longer in SAFE state)
	safeStateDelayTimer.setEnabled(false);
	}
	#endif
	}
	file.close();
	}
	else
	{
	// If not able to read, OCC may be offline
	log<level::DEBUG>(
	fmt::format("Status::readOccState: open failed (errno={})",
	open_errno)
	.c_str());
	lastState = 0;
	}
	}

	#ifdef POWER10
	// Special processing that needs to happen once the OCCs change to ACTIVE state
	void Status::occsWentActive()
	{
	CmdStatus status = CmdStatus::SUCCESS;

	status = pmode->sendModeChange();
	if (status != CmdStatus::SUCCESS)
	{
	log<level::ERR>(
	fmt::format(
	"Status::occsWentActive: OCC mode change failed with status {}",
	status)
	.c_str());
	}

	status = pmode->sendIpsData();
	if (status != CmdStatus::SUCCESS)
	{
	log<level::ERR>(
	fmt::format(
	"Status::occsWentActive: Sending Idle Power Save Config data failed with status {}",
	status)
	.c_str());
	}
	}

	// Send Ambient and Altitude to the OCC
	CmdStatus Status::sendAmbient(const uint8_t inTemp, const uint16_t inAltitude)
	{
	CmdStatus status = CmdStatus::FAILURE;
	bool ambientValid = true;
	uint8_t ambientTemp = inTemp;
	uint16_t altitude = inAltitude;

	if (ambientTemp == 0xFF)
	{
	// Get latest readings from manager
	manager.getAmbientData(ambientValid, ambientTemp, altitude);
	log<level::DEBUG>(
	fmt::format("sendAmbient: valid: {}, Ambient: {}C, altitude: {}m",
	ambientValid, ambientTemp, altitude)
	.c_str());
	}

	std::vector<std::uint8_t> cmd, rsp;
	cmd.reserve(11);
	cmd.push_back(uint8_t(CmdType::SEND_AMBIENT));
	cmd.push_back(0x00); // Data Length (2 bytes)
	cmd.push_back(0x08); //
	cmd.push_back(0x00); // Version
	cmd.push_back(ambientValid ? 0 : 0xFF); // Ambient Status
	cmd.push_back(ambientTemp); // Ambient Temperature
	cmd.push_back(altitude >> 8); // Altitude in meters (2 bytes)
	cmd.push_back(altitude & 0xFF); //
	cmd.push_back(0x00); // Reserved (3 bytes)
	cmd.push_back(0x00);
	cmd.push_back(0x00);
	log<level::DEBUG>(fmt::format("sendAmbient: SEND_AMBIENT "
	"command to OCC{} ({} bytes)",
	instance, cmd.size())
	.c_str());
	status = occCmd.send(cmd, rsp);
	if (status == CmdStatus::SUCCESS)
	{
	if (rsp.size() == 5)
	{
	if (RspStatus::SUCCESS != RspStatus(rsp[2]))
	{
	log<level::ERR>(
	fmt::format(
	"sendAmbient: SEND_AMBIENT failed with status 0x{:02X}",
	rsp[2])
	.c_str());
	dump_hex(rsp);
	status = CmdStatus::FAILURE;
	}
	}
	else
	{
	log<level::ERR>("sendAmbient: INVALID SEND_AMBIENT response");
	dump_hex(rsp);
	status = CmdStatus::FAILURE;
	}
	}
	else
	{
	if (status == CmdStatus::OPEN_FAILURE)
	{
	// OCC not active yet
	status = CmdStatus::SUCCESS;
	}
	else
	{
	log<level::ERR>("sendAmbient: SEND_AMBIENT FAILED!");
	}
	}

	return status;
	}

	// Called when safe timer expires to determine if OCCs need to be reset
	void Status::safeStateDelayExpired()
	{
	if (this->occActive())
	{
	log<level::INFO>(
	fmt::format(
	"safeStateDelayExpired: OCC{} is in SAFE state, requesting reset",
	instance)
	.c_str());
	// Disable and reset to try recovering
	deviceError();
	}
	}
	#endif // POWER10

	fs::path Status::getHwmonPath() const
	{
	using namespace std::literals::string_literals;

	// Build the base HWMON path
	fs::path prefixPath = fs::path{OCC_HWMON_PATH + "occ-hwmon."s +
	std::to_string(instance + 1) + "/hwmon/"s};
	// Get the hwmonXX directory name, there better only be 1 dir
	assert(std::distance(fs::directory_iterator(prefixPath),
	fs::directory_iterator{}) == 1);

	return *fs::directory_iterator(prefixPath);
	}

	} // namespace occ
	} // namespace open_power