1 /** 2 * Copyright © 2020 IBM Corporation 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 #pragma once 17 18 #include "services.hpp" 19 #include "system.hpp" 20 21 #include <interfaces/manager_interface.hpp> 22 #include <sdbusplus/bus.hpp> 23 #include <sdbusplus/bus/match.hpp> 24 #include <sdbusplus/server/object.hpp> 25 #include <sdeventplus/event.hpp> 26 #include <sdeventplus/source/signal.hpp> 27 #include <sdeventplus/utility/timer.hpp> 28 29 #include <filesystem> 30 #include <memory> 31 #include <string> 32 #include <vector> 33 34 namespace phosphor::power::regulators 35 { 36 37 using Timer = sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>; 38 39 using ManagerObject = sdbusplus::server::object::object< 40 phosphor::power::regulators::interface::ManagerInterface>; 41 42 class Manager : public ManagerObject 43 { 44 public: 45 Manager() = delete; 46 Manager(const Manager&) = delete; 47 Manager(Manager&&) = delete; 48 Manager& operator=(const Manager&) = delete; 49 Manager& operator=(Manager&&) = delete; 50 ~Manager() = default; 51 52 /** 53 * Constructor 54 * Creates a manager over the regulators. 55 * 56 * @param bus the D-Bus bus 57 * @param event the sdevent event 58 */ 59 Manager(sdbusplus::bus::bus& bus, const sdeventplus::Event& event); 60 61 /** 62 * Implements the D-Bus "configure" method. 63 * 64 * Configures all the voltage regulators in the system. 65 * 66 * This method should be called when the system is being powered on. It 67 * needs to occur before the regulators have been enabled/turned on. 68 */ 69 void configure() override; 70 71 /** 72 * Callback function to handle interfacesAdded D-Bus signals 73 * 74 * @param msg Expanded sdbusplus message data 75 */ 76 void interfacesAddedHandler(sdbusplus::message::message& msg); 77 78 /** 79 * Implements the D-Bus "monitor" method. 80 * 81 * Sets whether regulator monitoring is enabled. 82 * 83 * When monitoring is enabled: 84 * - regulator sensors will be read and published on D-Bus 85 * - phase fault detection will be performed 86 * 87 * Regulator monitoring should be enabled when the system is being powered 88 * on. It needs to occur after the regulators have been configured and 89 * enabled/turned on. 90 * 91 * Regulator monitoring should be disabled when the system is being powered 92 * off. It needs to occur before the regulators have been disabled/turned 93 * off. 94 * 95 * Regulator monitoring can also be temporarily disabled and then re-enabled 96 * while the system is powered on. This allows other applications or tools 97 * to temporarily communicate with the regulators for testing or debug. 98 * Monitoring should be disabled for only short periods of time; other 99 * applications, such as fan control, may be dependent on regulator sensors. 100 * 101 * @param enable true if monitoring should be enabled, false if it should be 102 * disabled 103 */ 104 void monitor(bool enable) override; 105 106 /** 107 * Callback function to handle receiving a HUP signal 108 * to reload the configuration data. 109 * 110 * @param sigSrc sd_event_source signal wrapper 111 * @param sigInfo signal info on signal fd 112 */ 113 void sighupHandler(sdeventplus::source::Signal& sigSrc, 114 const struct signalfd_siginfo* sigInfo); 115 116 /** 117 * Timer expired callback function 118 */ 119 void timerExpired(); 120 121 private: 122 /** 123 * Clear any cached data or error history related to hardware devices. 124 * 125 * This method should be called when the system is powering on (booting). 126 * While the system was powered off, hardware could have been added, 127 * removed, or replaced. 128 */ 129 void clearHardwareData(); 130 131 /** 132 * Finds the list of compatible system types using D-Bus methods. 133 * 134 * This list is used to find the correct JSON configuration file for the 135 * current system. 136 * 137 * Note that some systems do not support the D-Bus compatible interface. 138 * 139 * If a list of compatible system types is found, it is stored in the 140 * compatibleSystemTypes data member. 141 */ 142 void findCompatibleSystemTypes(); 143 144 /** 145 * Finds the JSON configuration file. 146 * 147 * Looks for a configuration file based on the list of compatible system 148 * types. If no file is found, looks for a file with the default name. 149 * 150 * Looks for the file in the test directory and standard directory. 151 * 152 * Throws an exception if an operating system error occurs while checking 153 * for the existence of a file. 154 * 155 * @return absolute path to config file, or an empty path if none found 156 */ 157 std::filesystem::path findConfigFile(); 158 159 /** 160 * Returns whether the JSON configuration file has been loaded. 161 * 162 * @return true if config file loaded, false otherwise 163 */ 164 bool isConfigFileLoaded() const 165 { 166 // If System object exists, the config file has been loaded 167 return (system != nullptr); 168 } 169 170 /** 171 * Returns whether the system is currently powered on. 172 * 173 * @return true if system is powered on, false otherwise 174 */ 175 bool isSystemPoweredOn(); 176 177 /** 178 * Loads the JSON configuration file. 179 * 180 * Looks for the config file using findConfigFile(). 181 * 182 * If the config file is found, it is parsed and the resulting information 183 * is stored in the system data member. If parsing fails, an error is 184 * logged. 185 */ 186 void loadConfigFile(); 187 188 /** 189 * Waits until the JSON configuration file has been loaded. 190 * 191 * If the config file has not yet been loaded, waits until one of the 192 * following occurs: 193 * - config file is loaded 194 * - maximum amount of time to wait has elapsed 195 */ 196 void waitUntilConfigFileLoaded(); 197 198 /** 199 * The D-Bus bus 200 */ 201 sdbusplus::bus::bus& bus; 202 203 /** 204 * Event to loop on 205 */ 206 const sdeventplus::Event& eventLoop; 207 208 /** 209 * System services like error logging and the journal. 210 */ 211 BMCServices services; 212 213 /** 214 * Event timer used to initiate regulator monitoring. 215 */ 216 Timer timer; 217 218 /** 219 * List of D-Bus signal matches 220 */ 221 std::vector<std::unique_ptr<sdbusplus::bus::match::match>> signals{}; 222 223 /** 224 * Indicates whether regulator monitoring is enabled. 225 */ 226 bool isMonitoringEnabled{false}; 227 228 /** 229 * List of compatible system types for the current system. 230 * 231 * Used to find the JSON configuration file. 232 */ 233 std::vector<std::string> compatibleSystemTypes{}; 234 235 /** 236 * Computer system being controlled and monitored by the BMC. 237 * 238 * Contains the information loaded from the JSON configuration file. 239 * Contains nullptr if the configuration file has not been loaded. 240 */ 241 std::unique_ptr<System> system{}; 242 }; 243 244 } // namespace phosphor::power::regulators 245