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> 15*6ed41eabSPatrick 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; 29*6ed41eabSPatrick 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) : 50769a62f1SAndrew Geissler ChassisInherit(bus, objPath, true), bus(bus), 5158a18013SAndrew Geissler systemdSignals( 5258a18013SAndrew Geissler bus, 5358a18013SAndrew Geissler sdbusRule::type::signal() + sdbusRule::member("JobRemoved") + 548f8ba39fSPatrick Williams sdbusRule::path("/org/freedesktop/systemd1") + 5558a18013SAndrew Geissler sdbusRule::interface("org.freedesktop.systemd1.Manager"), 5658a18013SAndrew Geissler std::bind(std::mem_fn(&Chassis::sysStateChange), this, 57d998f82bSWilliam A. Kennington III std::placeholders::_1)), 5870f36d8eSPotin Lai id(id), pohTimer(sdeventplus::Event::get_default(), 5970f36d8eSPotin Lai std::bind(&Chassis::pohCallback, this), 6070f36d8eSPotin Lai std::chrono::hours{1}, std::chrono::minutes{1}) 61dff50ed6SAndrew Geissler { 620029a5d2SAndrew Geissler subscribeToSystemdSignals(); 630029a5d2SAndrew Geissler 6470f36d8eSPotin Lai createSystemdTargetTable(); 6570f36d8eSPotin Lai 669eab9861SMatt Spinler restoreChassisStateChangeTime(); 679eab9861SMatt Spinler 68dff50ed6SAndrew Geissler determineInitialState(); 69dff50ed6SAndrew Geissler 70cb781fe1SNagaraju Goruganti restorePOHCounter(); // restore POHCounter from persisted file 71cb781fe1SNagaraju Goruganti 72dff50ed6SAndrew Geissler // We deferred this until we could get our property correct 73dff50ed6SAndrew Geissler this->emit_object_added(); 74dff50ed6SAndrew Geissler } 75dff50ed6SAndrew Geissler 76a90a31a9SAndrew Geissler /** @brief Set value of RequestedPowerTransition */ 77a90a31a9SAndrew Geissler Transition requestedPowerTransition(Transition value) override; 78a90a31a9SAndrew Geissler 79a90a31a9SAndrew Geissler /** @brief Set value of CurrentPowerState */ 80a90a31a9SAndrew Geissler PowerState currentPowerState(PowerState value) override; 81a90a31a9SAndrew Geissler 82cb781fe1SNagaraju Goruganti /** @brief Get value of POHCounter */ 8345a1ed71SPatrick Williams using ChassisInherit::pohCounter; 84cb781fe1SNagaraju Goruganti 85cb781fe1SNagaraju Goruganti /** @brief Increment POHCounter if Chassis Power state is ON */ 86cb781fe1SNagaraju Goruganti void startPOHCounter(); 87cb781fe1SNagaraju Goruganti 88a90a31a9SAndrew Geissler private: 8970f36d8eSPotin Lai /** @brief Create systemd target instance names and mapping table */ 9070f36d8eSPotin Lai void createSystemdTargetTable(); 9170f36d8eSPotin Lai 920029a5d2SAndrew Geissler /** @brief Determine initial chassis state and set internally */ 930029a5d2SAndrew Geissler void determineInitialState(); 940029a5d2SAndrew Geissler 95396ed8a5SAdriana Kobylak /** @brief Determine status of power into system by examining all the 96396ed8a5SAdriana Kobylak * power-related interfaces of interest 97396ed8a5SAdriana Kobylak */ 988b1f8620SAndrew Geissler void determineStatusOfPower(); 998b1f8620SAndrew Geissler 100396ed8a5SAdriana Kobylak /** @brief Determine status of power provided by an Uninterruptible Power 101396ed8a5SAdriana Kobylak * Supply into the system 102396ed8a5SAdriana Kobylak */ 103396ed8a5SAdriana Kobylak void determineStatusOfUPSPower(); 104396ed8a5SAdriana Kobylak 105396ed8a5SAdriana Kobylak /** @brief Determine status of power provided by the power supply units into 106396ed8a5SAdriana Kobylak * the system 107396ed8a5SAdriana Kobylak */ 108396ed8a5SAdriana Kobylak void determineStatusOfPSUPower(); 109396ed8a5SAdriana Kobylak 1100029a5d2SAndrew Geissler /** 1110029a5d2SAndrew Geissler * @brief subscribe to the systemd signals 1120029a5d2SAndrew Geissler * 1130029a5d2SAndrew Geissler * This object needs to capture when it's systemd targets complete 1140029a5d2SAndrew Geissler * so it can keep it's state updated 1150029a5d2SAndrew Geissler * 1160029a5d2SAndrew Geissler **/ 1170029a5d2SAndrew Geissler void subscribeToSystemdSignals(); 1180029a5d2SAndrew Geissler 119be6efabcSMatthew Barth /** @brief Start the systemd unit requested 120ce80f24cSAndrew Geissler * 121be6efabcSMatthew Barth * This function calls `StartUnit` on the systemd unit given. 122ce80f24cSAndrew Geissler * 123be6efabcSMatthew Barth * @param[in] sysdUnit - Systemd unit 124ce80f24cSAndrew Geissler */ 125be6efabcSMatthew Barth void startUnit(const std::string& sysdUnit); 126ce80f24cSAndrew Geissler 127697474c5SJosh D. King /** 128697474c5SJosh D. King * @brief Determine if target is active 129697474c5SJosh D. King * 130697474c5SJosh D. King * This function determines if the target is active and 131697474c5SJosh D. King * helps prevent misleading log recorded states. 132697474c5SJosh D. King * 133697474c5SJosh D. King * @param[in] target - Target string to check on 134697474c5SJosh D. King * 135697474c5SJosh D. King * @return boolean corresponding to state active 136697474c5SJosh D. King **/ 137697474c5SJosh D. King bool stateActive(const std::string& target); 138697474c5SJosh D. King 1390029a5d2SAndrew Geissler /** @brief Check if systemd state change is relevant to this object 1402ec3a7e9SAndrew Geissler * 1410029a5d2SAndrew Geissler * Instance specific interface to handle the detected systemd state 1420029a5d2SAndrew Geissler * change 1432ec3a7e9SAndrew Geissler * 1442ec3a7e9SAndrew Geissler * @param[in] msg - Data associated with subscribed signal 1452ec3a7e9SAndrew Geissler * 1462ec3a7e9SAndrew Geissler */ 1478f8ba39fSPatrick Williams int sysStateChange(sdbusplus::message::message& msg); 1482ec3a7e9SAndrew Geissler 149a90a31a9SAndrew Geissler /** @brief Persistent sdbusplus DBus connection. */ 150a90a31a9SAndrew Geissler sdbusplus::bus::bus& bus; 1512ec3a7e9SAndrew Geissler 1520029a5d2SAndrew Geissler /** @brief Used to subscribe to dbus systemd signals **/ 1538f8ba39fSPatrick Williams sdbusplus::bus::match_t systemdSignals; 154cb781fe1SNagaraju Goruganti 1552cf2a268SAndrew Geissler /** @brief Watch for any changes to UPS properties **/ 1562cf2a268SAndrew Geissler std::unique_ptr<sdbusplus::bus::match_t> uPowerPropChangeSignal; 1572cf2a268SAndrew Geissler 158396ed8a5SAdriana Kobylak /** @brief Watch for any changes to PowerSystemInputs properties **/ 159396ed8a5SAdriana Kobylak std::unique_ptr<sdbusplus::bus::match_t> powerSysInputsPropChangeSignal; 160396ed8a5SAdriana Kobylak 16170f36d8eSPotin Lai /** @brief Chassis id. **/ 16270f36d8eSPotin Lai const size_t id = 0; 16370f36d8eSPotin Lai 16470f36d8eSPotin Lai /** @brief Transition state to systemd target mapping table. **/ 16570f36d8eSPotin Lai std::map<Transition, std::string> systemdTargetTable; 16670f36d8eSPotin Lai 167cb781fe1SNagaraju Goruganti /** @brief Used to Set value of POHCounter */ 16845a1ed71SPatrick Williams uint32_t pohCounter(uint32_t value) override; 169cb781fe1SNagaraju Goruganti 170d998f82bSWilliam A. Kennington III /** @brief Used by the timer to update the POHCounter */ 17145a1ed71SPatrick Williams void pohCallback(); 172d998f82bSWilliam A. Kennington III 173cb781fe1SNagaraju Goruganti /** @brief Used to restore POHCounter value from persisted file */ 174cb781fe1SNagaraju Goruganti void restorePOHCounter(); 175cb781fe1SNagaraju Goruganti 176cb781fe1SNagaraju Goruganti /** @brief Serialize and persist requested POH counter. 177cb781fe1SNagaraju Goruganti * 178cb781fe1SNagaraju Goruganti * @param[in] dir - pathname of file where the serialized POH counter will 179cb781fe1SNagaraju Goruganti * be placed. 180cb781fe1SNagaraju Goruganti * 181cb781fe1SNagaraju Goruganti * @return fs::path - pathname of persisted requested POH counter. 182cb781fe1SNagaraju Goruganti */ 183cb781fe1SNagaraju Goruganti fs::path 18481957841SMatt Spinler serializePOH(const fs::path& dir = fs::path(POH_COUNTER_PERSIST_PATH)); 185cb781fe1SNagaraju Goruganti 18681957841SMatt Spinler /** @brief Deserialize a persisted requested POH counter. 187cb781fe1SNagaraju Goruganti * 188cb781fe1SNagaraju Goruganti * @param[in] path - pathname of persisted POH counter file 189cb781fe1SNagaraju Goruganti * @param[in] retCounter - deserialized POH counter value 190cb781fe1SNagaraju Goruganti * 191cb781fe1SNagaraju Goruganti * @return bool - true if the deserialization was successful, false 192cb781fe1SNagaraju Goruganti * otherwise. 193cb781fe1SNagaraju Goruganti */ 19481957841SMatt Spinler bool deserializePOH(const fs::path& path, uint32_t& retCounter); 195cb781fe1SNagaraju Goruganti 1969eab9861SMatt Spinler /** @brief Sets the LastStateChangeTime property and persists it. */ 1979eab9861SMatt Spinler void setStateChangeTime(); 1989eab9861SMatt Spinler 1999eab9861SMatt Spinler /** @brief Serialize the last power state change time. 2009eab9861SMatt Spinler * 2019eab9861SMatt Spinler * Save the time the state changed and the state itself. 2029eab9861SMatt Spinler * The state needs to be saved as well so that during rediscovery 2039eab9861SMatt Spinler * on reboots there's a way to know not to update the time again. 2049eab9861SMatt Spinler */ 2059eab9861SMatt Spinler void serializeStateChangeTime(); 2069eab9861SMatt Spinler 2079eab9861SMatt Spinler /** @brief Deserialize the last power state change time. 2089eab9861SMatt Spinler * 2099eab9861SMatt Spinler * @param[out] time - Deserialized time 2109eab9861SMatt Spinler * @param[out] state - Deserialized power state 2119eab9861SMatt Spinler * 2129eab9861SMatt Spinler * @return bool - true if successful, false otherwise. 2139eab9861SMatt Spinler */ 2149eab9861SMatt Spinler bool deserializeStateChangeTime(uint64_t& time, PowerState& state); 2159eab9861SMatt Spinler 2169eab9861SMatt Spinler /** @brief Restores the power state change time. 2179eab9861SMatt Spinler * 2189eab9861SMatt Spinler * The time is loaded into the LastStateChangeTime D-Bus property. 2199eab9861SMatt Spinler * On the very first start after this code has been applied but 2209eab9861SMatt Spinler * before the state has changed, the LastStateChangeTime value 2219eab9861SMatt Spinler * will be zero. 2229eab9861SMatt Spinler */ 2239eab9861SMatt Spinler void restoreChassisStateChangeTime(); 2249eab9861SMatt Spinler 225d998f82bSWilliam A. Kennington III /** @brief Timer used for tracking power on hours */ 22645a1ed71SPatrick Williams sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> pohTimer; 2272c36e5adSBen Tyner 2282c36e5adSBen Tyner /** @brief Function to check for a standby voltage regulator fault 2292c36e5adSBen Tyner * 2302c36e5adSBen Tyner * Determine if a standby voltage regulator fault was detected and 2312c36e5adSBen Tyner * return true or false accordingly. 2322c36e5adSBen Tyner * 2332c36e5adSBen Tyner * @return true if fault detected, else false 2342c36e5adSBen Tyner */ 2352c36e5adSBen Tyner bool standbyVoltageRegulatorFault(); 2362cf2a268SAndrew Geissler 2372cf2a268SAndrew Geissler /** @brief Process UPS property changes 2382cf2a268SAndrew Geissler * 2392cf2a268SAndrew Geissler * Instance specific interface to monitor for changes to the UPS 2402cf2a268SAndrew Geissler * properties which may impact CurrentPowerStatus 2412cf2a268SAndrew Geissler * 2422cf2a268SAndrew Geissler * @param[in] msg - Data associated with subscribed signal 2432cf2a268SAndrew Geissler * 2442cf2a268SAndrew Geissler */ 2452cf2a268SAndrew Geissler void uPowerChangeEvent(sdbusplus::message::message& msg); 246396ed8a5SAdriana Kobylak 247396ed8a5SAdriana Kobylak /** @brief Process PowerSystemInputs property changes 248396ed8a5SAdriana Kobylak * 249396ed8a5SAdriana Kobylak * Instance specific interface to monitor for changes to the 250396ed8a5SAdriana Kobylak * PowerSystemInputs properties which may impact CurrentPowerStatus 251396ed8a5SAdriana Kobylak * 252396ed8a5SAdriana Kobylak * @param[in] msg - Data associated with subscribed signal 253396ed8a5SAdriana Kobylak * 254396ed8a5SAdriana Kobylak */ 255396ed8a5SAdriana Kobylak void powerSysInputsChangeEvent(sdbusplus::message::message& msg); 256a90a31a9SAndrew Geissler }; 257a90a31a9SAndrew Geissler 258a90a31a9SAndrew Geissler } // namespace manager 259a90a31a9SAndrew Geissler } // namespace state 260a90a31a9SAndrew Geissler } // namespace phosphor 261