1a90a31a9SAndrew Geissler #pragma once 2a90a31a9SAndrew Geissler 3e426b589SAndrew Geissler #include "config.h" 4e426b589SAndrew Geissler 5e426b589SAndrew Geissler #include "xyz/openbmc_project/State/Chassis/server.hpp" 6e426b589SAndrew Geissler #include "xyz/openbmc_project/State/PowerOnHours/server.hpp" 7e426b589SAndrew Geissler 8cb781fe1SNagaraju Goruganti #include <cereal/cereal.hpp> 9a90a31a9SAndrew Geissler #include <sdbusplus/bus.hpp> 10d998f82bSWilliam A. Kennington III #include <sdeventplus/clock.hpp> 11d998f82bSWilliam A. Kennington III #include <sdeventplus/event.hpp> 12d998f82bSWilliam A. Kennington III #include <sdeventplus/utility/timer.hpp> 13e426b589SAndrew Geissler 14e426b589SAndrew Geissler #include <chrono> 156ed41eabSPatrick Williams #include <filesystem> 16e426b589SAndrew Geissler #include <functional> 17a90a31a9SAndrew Geissler 18a90a31a9SAndrew Geissler namespace phosphor 19a90a31a9SAndrew Geissler { 20a90a31a9SAndrew Geissler namespace state 21a90a31a9SAndrew Geissler { 22a90a31a9SAndrew Geissler namespace manager 23a90a31a9SAndrew Geissler { 24a90a31a9SAndrew Geissler 258f8ba39fSPatrick Williams using ChassisInherit = sdbusplus::server::object::object< 26cb781fe1SNagaraju Goruganti sdbusplus::xyz::openbmc_project::State::server::Chassis, 27cb781fe1SNagaraju Goruganti sdbusplus::xyz::openbmc_project::State::server::PowerOnHours>; 288f8ba39fSPatrick Williams namespace sdbusRule = sdbusplus::bus::match::rules; 296ed41eabSPatrick Williams namespace fs = std::filesystem; 308f8ba39fSPatrick Williams 31a90a31a9SAndrew Geissler /** @class Chassis 32a90a31a9SAndrew Geissler * @brief OpenBMC chassis state management implementation. 33a90a31a9SAndrew Geissler * @details A concrete implementation for xyz.openbmc_project.State.Chassis 34a90a31a9SAndrew Geissler * DBus API. 35a90a31a9SAndrew Geissler */ 368f8ba39fSPatrick Williams class Chassis : public ChassisInherit 37a90a31a9SAndrew Geissler { 38a90a31a9SAndrew Geissler public: 39a90a31a9SAndrew Geissler /** @brief Constructs Chassis State Manager 40a90a31a9SAndrew Geissler * 41dff50ed6SAndrew Geissler * @note This constructor passes 'true' to the base class in order to 42dff50ed6SAndrew Geissler * defer dbus object registration until we can run 43dff50ed6SAndrew Geissler * determineInitialState() and set our properties 44dff50ed6SAndrew Geissler * 45a90a31a9SAndrew Geissler * @param[in] bus - The Dbus bus object 46a90a31a9SAndrew Geissler * @param[in] objPath - The Dbus object path 4770f36d8eSPotin Lai * @param[in] id - Chassis id 48a90a31a9SAndrew Geissler */ 4970f36d8eSPotin Lai Chassis(sdbusplus::bus::bus& bus, const char* objPath, size_t id) : 50*76070747SPatrick Williams ChassisInherit(bus, objPath, ChassisInherit::action::defer_emit), 51*76070747SPatrick Williams bus(bus), 5258a18013SAndrew Geissler systemdSignals( 5358a18013SAndrew Geissler bus, 5458a18013SAndrew Geissler sdbusRule::type::signal() + sdbusRule::member("JobRemoved") + 558f8ba39fSPatrick Williams sdbusRule::path("/org/freedesktop/systemd1") + 5658a18013SAndrew Geissler sdbusRule::interface("org.freedesktop.systemd1.Manager"), 5758a18013SAndrew Geissler std::bind(std::mem_fn(&Chassis::sysStateChange), this, 58d998f82bSWilliam A. Kennington III std::placeholders::_1)), 5970f36d8eSPotin Lai id(id), pohTimer(sdeventplus::Event::get_default(), 6070f36d8eSPotin Lai std::bind(&Chassis::pohCallback, this), 6170f36d8eSPotin Lai std::chrono::hours{1}, std::chrono::minutes{1}) 62dff50ed6SAndrew Geissler { 630029a5d2SAndrew Geissler subscribeToSystemdSignals(); 640029a5d2SAndrew Geissler 6570f36d8eSPotin Lai createSystemdTargetTable(); 6670f36d8eSPotin Lai 679eab9861SMatt Spinler restoreChassisStateChangeTime(); 689eab9861SMatt Spinler 69dff50ed6SAndrew Geissler determineInitialState(); 70dff50ed6SAndrew Geissler 71cb781fe1SNagaraju Goruganti restorePOHCounter(); // restore POHCounter from persisted file 72cb781fe1SNagaraju Goruganti 73dff50ed6SAndrew Geissler // We deferred this until we could get our property correct 74dff50ed6SAndrew Geissler this->emit_object_added(); 75dff50ed6SAndrew Geissler } 76dff50ed6SAndrew Geissler 77a90a31a9SAndrew Geissler /** @brief Set value of RequestedPowerTransition */ 78a90a31a9SAndrew Geissler Transition requestedPowerTransition(Transition value) override; 79a90a31a9SAndrew Geissler 80a90a31a9SAndrew Geissler /** @brief Set value of CurrentPowerState */ 81a90a31a9SAndrew Geissler PowerState currentPowerState(PowerState value) override; 82a90a31a9SAndrew Geissler 83cb781fe1SNagaraju Goruganti /** @brief Get value of POHCounter */ 8445a1ed71SPatrick Williams using ChassisInherit::pohCounter; 85cb781fe1SNagaraju Goruganti 86cb781fe1SNagaraju Goruganti /** @brief Increment POHCounter if Chassis Power state is ON */ 87cb781fe1SNagaraju Goruganti void startPOHCounter(); 88cb781fe1SNagaraju Goruganti 89a90a31a9SAndrew Geissler private: 9070f36d8eSPotin Lai /** @brief Create systemd target instance names and mapping table */ 9170f36d8eSPotin Lai void createSystemdTargetTable(); 9270f36d8eSPotin Lai 930029a5d2SAndrew Geissler /** @brief Determine initial chassis state and set internally */ 940029a5d2SAndrew Geissler void determineInitialState(); 950029a5d2SAndrew Geissler 96396ed8a5SAdriana Kobylak /** @brief Determine status of power into system by examining all the 97396ed8a5SAdriana Kobylak * power-related interfaces of interest 98396ed8a5SAdriana Kobylak */ 998b1f8620SAndrew Geissler void determineStatusOfPower(); 1008b1f8620SAndrew Geissler 101396ed8a5SAdriana Kobylak /** @brief Determine status of power provided by an Uninterruptible Power 102396ed8a5SAdriana Kobylak * Supply into the system 103396ed8a5SAdriana Kobylak */ 104396ed8a5SAdriana Kobylak void determineStatusOfUPSPower(); 105396ed8a5SAdriana Kobylak 106396ed8a5SAdriana Kobylak /** @brief Determine status of power provided by the power supply units into 107396ed8a5SAdriana Kobylak * the system 108396ed8a5SAdriana Kobylak */ 109396ed8a5SAdriana Kobylak void determineStatusOfPSUPower(); 110396ed8a5SAdriana Kobylak 1110029a5d2SAndrew Geissler /** 1120029a5d2SAndrew Geissler * @brief subscribe to the systemd signals 1130029a5d2SAndrew Geissler * 1140029a5d2SAndrew Geissler * This object needs to capture when it's systemd targets complete 1150029a5d2SAndrew Geissler * so it can keep it's state updated 1160029a5d2SAndrew Geissler * 1170029a5d2SAndrew Geissler **/ 1180029a5d2SAndrew Geissler void subscribeToSystemdSignals(); 1190029a5d2SAndrew Geissler 120be6efabcSMatthew Barth /** @brief Start the systemd unit requested 121ce80f24cSAndrew Geissler * 122be6efabcSMatthew Barth * This function calls `StartUnit` on the systemd unit given. 123ce80f24cSAndrew Geissler * 124be6efabcSMatthew Barth * @param[in] sysdUnit - Systemd unit 125ce80f24cSAndrew Geissler */ 126be6efabcSMatthew Barth void startUnit(const std::string& sysdUnit); 127ce80f24cSAndrew Geissler 128697474c5SJosh D. King /** 129697474c5SJosh D. King * @brief Determine if target is active 130697474c5SJosh D. King * 131697474c5SJosh D. King * This function determines if the target is active and 132697474c5SJosh D. King * helps prevent misleading log recorded states. 133697474c5SJosh D. King * 134697474c5SJosh D. King * @param[in] target - Target string to check on 135697474c5SJosh D. King * 136697474c5SJosh D. King * @return boolean corresponding to state active 137697474c5SJosh D. King **/ 138697474c5SJosh D. King bool stateActive(const std::string& target); 139697474c5SJosh D. King 1400029a5d2SAndrew Geissler /** @brief Check if systemd state change is relevant to this object 1412ec3a7e9SAndrew Geissler * 1420029a5d2SAndrew Geissler * Instance specific interface to handle the detected systemd state 1430029a5d2SAndrew Geissler * change 1442ec3a7e9SAndrew Geissler * 1452ec3a7e9SAndrew Geissler * @param[in] msg - Data associated with subscribed signal 1462ec3a7e9SAndrew Geissler * 1472ec3a7e9SAndrew Geissler */ 1488f8ba39fSPatrick Williams int sysStateChange(sdbusplus::message::message& msg); 1492ec3a7e9SAndrew Geissler 150a90a31a9SAndrew Geissler /** @brief Persistent sdbusplus DBus connection. */ 151a90a31a9SAndrew Geissler sdbusplus::bus::bus& bus; 1522ec3a7e9SAndrew Geissler 1530029a5d2SAndrew Geissler /** @brief Used to subscribe to dbus systemd signals **/ 1548f8ba39fSPatrick Williams sdbusplus::bus::match_t systemdSignals; 155cb781fe1SNagaraju Goruganti 1562cf2a268SAndrew Geissler /** @brief Watch for any changes to UPS properties **/ 1572cf2a268SAndrew Geissler std::unique_ptr<sdbusplus::bus::match_t> uPowerPropChangeSignal; 1582cf2a268SAndrew Geissler 159396ed8a5SAdriana Kobylak /** @brief Watch for any changes to PowerSystemInputs properties **/ 160396ed8a5SAdriana Kobylak std::unique_ptr<sdbusplus::bus::match_t> powerSysInputsPropChangeSignal; 161396ed8a5SAdriana Kobylak 16270f36d8eSPotin Lai /** @brief Chassis id. **/ 16370f36d8eSPotin Lai const size_t id = 0; 16470f36d8eSPotin Lai 16570f36d8eSPotin Lai /** @brief Transition state to systemd target mapping table. **/ 16670f36d8eSPotin Lai std::map<Transition, std::string> systemdTargetTable; 16770f36d8eSPotin Lai 168cb781fe1SNagaraju Goruganti /** @brief Used to Set value of POHCounter */ 16945a1ed71SPatrick Williams uint32_t pohCounter(uint32_t value) override; 170cb781fe1SNagaraju Goruganti 171d998f82bSWilliam A. Kennington III /** @brief Used by the timer to update the POHCounter */ 17245a1ed71SPatrick Williams void pohCallback(); 173d998f82bSWilliam A. Kennington III 174cb781fe1SNagaraju Goruganti /** @brief Used to restore POHCounter value from persisted file */ 175cb781fe1SNagaraju Goruganti void restorePOHCounter(); 176cb781fe1SNagaraju Goruganti 177cb781fe1SNagaraju Goruganti /** @brief Serialize and persist requested POH counter. 178cb781fe1SNagaraju Goruganti * 179cb781fe1SNagaraju Goruganti * @param[in] dir - pathname of file where the serialized POH counter will 180cb781fe1SNagaraju Goruganti * be placed. 181cb781fe1SNagaraju Goruganti * 182cb781fe1SNagaraju Goruganti * @return fs::path - pathname of persisted requested POH counter. 183cb781fe1SNagaraju Goruganti */ 184cb781fe1SNagaraju Goruganti fs::path 18581957841SMatt Spinler serializePOH(const fs::path& dir = fs::path(POH_COUNTER_PERSIST_PATH)); 186cb781fe1SNagaraju Goruganti 18781957841SMatt Spinler /** @brief Deserialize a persisted requested POH counter. 188cb781fe1SNagaraju Goruganti * 189cb781fe1SNagaraju Goruganti * @param[in] path - pathname of persisted POH counter file 190cb781fe1SNagaraju Goruganti * @param[in] retCounter - deserialized POH counter value 191cb781fe1SNagaraju Goruganti * 192cb781fe1SNagaraju Goruganti * @return bool - true if the deserialization was successful, false 193cb781fe1SNagaraju Goruganti * otherwise. 194cb781fe1SNagaraju Goruganti */ 19581957841SMatt Spinler bool deserializePOH(const fs::path& path, uint32_t& retCounter); 196cb781fe1SNagaraju Goruganti 1979eab9861SMatt Spinler /** @brief Sets the LastStateChangeTime property and persists it. */ 1989eab9861SMatt Spinler void setStateChangeTime(); 1999eab9861SMatt Spinler 2009eab9861SMatt Spinler /** @brief Serialize the last power state change time. 2019eab9861SMatt Spinler * 2029eab9861SMatt Spinler * Save the time the state changed and the state itself. 2039eab9861SMatt Spinler * The state needs to be saved as well so that during rediscovery 2049eab9861SMatt Spinler * on reboots there's a way to know not to update the time again. 2059eab9861SMatt Spinler */ 2069eab9861SMatt Spinler void serializeStateChangeTime(); 2079eab9861SMatt Spinler 2089eab9861SMatt Spinler /** @brief Deserialize the last power state change time. 2099eab9861SMatt Spinler * 2109eab9861SMatt Spinler * @param[out] time - Deserialized time 2119eab9861SMatt Spinler * @param[out] state - Deserialized power state 2129eab9861SMatt Spinler * 2139eab9861SMatt Spinler * @return bool - true if successful, false otherwise. 2149eab9861SMatt Spinler */ 2159eab9861SMatt Spinler bool deserializeStateChangeTime(uint64_t& time, PowerState& state); 2169eab9861SMatt Spinler 2179eab9861SMatt Spinler /** @brief Restores the power state change time. 2189eab9861SMatt Spinler * 2199eab9861SMatt Spinler * The time is loaded into the LastStateChangeTime D-Bus property. 2209eab9861SMatt Spinler * On the very first start after this code has been applied but 2219eab9861SMatt Spinler * before the state has changed, the LastStateChangeTime value 2229eab9861SMatt Spinler * will be zero. 2239eab9861SMatt Spinler */ 2249eab9861SMatt Spinler void restoreChassisStateChangeTime(); 2259eab9861SMatt Spinler 226d998f82bSWilliam A. Kennington III /** @brief Timer used for tracking power on hours */ 22745a1ed71SPatrick Williams sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> pohTimer; 2282c36e5adSBen Tyner 2292c36e5adSBen Tyner /** @brief Function to check for a standby voltage regulator fault 2302c36e5adSBen Tyner * 2312c36e5adSBen Tyner * Determine if a standby voltage regulator fault was detected and 2322c36e5adSBen Tyner * return true or false accordingly. 2332c36e5adSBen Tyner * 2342c36e5adSBen Tyner * @return true if fault detected, else false 2352c36e5adSBen Tyner */ 2362c36e5adSBen Tyner bool standbyVoltageRegulatorFault(); 2372cf2a268SAndrew Geissler 2382cf2a268SAndrew Geissler /** @brief Process UPS property changes 2392cf2a268SAndrew Geissler * 2402cf2a268SAndrew Geissler * Instance specific interface to monitor for changes to the UPS 2412cf2a268SAndrew Geissler * properties which may impact CurrentPowerStatus 2422cf2a268SAndrew Geissler * 2432cf2a268SAndrew Geissler * @param[in] msg - Data associated with subscribed signal 2442cf2a268SAndrew Geissler * 2452cf2a268SAndrew Geissler */ 2462cf2a268SAndrew Geissler void uPowerChangeEvent(sdbusplus::message::message& msg); 247396ed8a5SAdriana Kobylak 248396ed8a5SAdriana Kobylak /** @brief Process PowerSystemInputs property changes 249396ed8a5SAdriana Kobylak * 250396ed8a5SAdriana Kobylak * Instance specific interface to monitor for changes to the 251396ed8a5SAdriana Kobylak * PowerSystemInputs properties which may impact CurrentPowerStatus 252396ed8a5SAdriana Kobylak * 253396ed8a5SAdriana Kobylak * @param[in] msg - Data associated with subscribed signal 254396ed8a5SAdriana Kobylak * 255396ed8a5SAdriana Kobylak */ 256396ed8a5SAdriana Kobylak void powerSysInputsChangeEvent(sdbusplus::message::message& msg); 257a90a31a9SAndrew Geissler }; 258a90a31a9SAndrew Geissler 259a90a31a9SAndrew Geissler } // namespace manager 260a90a31a9SAndrew Geissler } // namespace state 261a90a31a9SAndrew Geissler } // namespace phosphor 262