1 #pragma once 2 3 #include "pmbus.hpp" 4 5 #include <nlohmann/json.hpp> 6 #include <phosphor-logging/elog.hpp> 7 #include <phosphor-logging/log.hpp> 8 #include <sdbusplus/bus.hpp> 9 10 #include <string> 11 12 namespace phosphor 13 { 14 namespace power 15 { 16 namespace util 17 { 18 19 constexpr auto SYSTEMD_SERVICE = "org.freedesktop.systemd1"; 20 constexpr auto SYSTEMD_ROOT = "/org/freedesktop/systemd1"; 21 constexpr auto SYSTEMD_INTERFACE = "org.freedesktop.systemd1.Manager"; 22 constexpr auto POWEROFF_TARGET = "obmc-chassis-hard-poweroff@0.target"; 23 constexpr auto PROPERTY_INTF = "org.freedesktop.DBus.Properties"; 24 25 using DbusPath = std::string; 26 using DbusProperty = std::string; 27 using DbusService = std::string; 28 using DbusInterface = std::string; 29 using DbusInterfaceList = std::vector<DbusInterface>; 30 using DbusSubtree = 31 std::map<DbusPath, std::map<DbusService, DbusInterfaceList>>; 32 using DbusVariant = 33 std::variant<uint64_t, std::string, std::vector<std::string>>; 34 using DbusPropertyMap = std::map<DbusProperty, DbusVariant>; 35 /** 36 * @brief Get the service name from the mapper for the 37 * interface and path passed in. 38 * 39 * @param[in] path - the D-Bus path name 40 * @param[in] interface - the D-Bus interface name 41 * @param[in] bus - the D-Bus object 42 * @param[in] logError - log error when no service found 43 * 44 * @return The service name 45 */ 46 std::string getService(const std::string& path, const std::string& interface, 47 sdbusplus::bus::bus& bus, bool logError = true); 48 49 /** 50 * @brief Read a D-Bus property 51 * 52 * @param[in] interface - the interface the property is on 53 * @param[in] propertName - the name of the property 54 * @param[in] path - the D-Bus path 55 * @param[in] service - the D-Bus service 56 * @param[in] bus - the D-Bus object 57 * @param[out] value - filled in with the property value 58 */ 59 template <typename T> 60 void getProperty(const std::string& interface, const std::string& propertyName, 61 const std::string& path, const std::string& service, 62 sdbusplus::bus::bus& bus, T& value) 63 { 64 std::variant<T> property; 65 66 auto method = bus.new_method_call(service.c_str(), path.c_str(), 67 PROPERTY_INTF, "Get"); 68 69 method.append(interface, propertyName); 70 71 auto reply = bus.call(method); 72 73 reply.read(property); 74 value = std::get<T>(property); 75 } 76 77 /** 78 * @brief Write a D-Bus property 79 * 80 * @param[in] interface - the interface the property is on 81 * @param[in] propertName - the name of the property 82 * @param[in] path - the D-Bus path 83 * @param[in] service - the D-Bus service 84 * @param[in] bus - the D-Bus object 85 * @param[in] value - the value to set the property to 86 */ 87 template <typename T> 88 void setProperty(const std::string& interface, const std::string& propertyName, 89 const std::string& path, const std::string& service, 90 sdbusplus::bus::bus& bus, T& value) 91 { 92 std::variant<T> propertyValue(value); 93 94 auto method = bus.new_method_call(service.c_str(), path.c_str(), 95 PROPERTY_INTF, "Set"); 96 97 method.append(interface, propertyName, propertyValue); 98 99 auto reply = bus.call(method); 100 } 101 102 /** 103 * @brief Get all D-Bus properties 104 * 105 * @param[in] bus - the D-Bus object 106 * @param[in] path - the D-Bus object path 107 * @param[in] interface - the D-Bus interface name 108 * @param[in] service - the D-Bus service name (optional) 109 * 110 * @return DbusPropertyMap - Map of property names and values 111 */ 112 DbusPropertyMap getAllProperties(sdbusplus::bus::bus& bus, 113 const std::string& path, 114 const std::string& interface, 115 const std::string& service = std::string()); 116 117 /** @brief Get subtree from the object mapper. 118 * 119 * Helper function to find objects, services, and interfaces. 120 * See: 121 * https://github.com/openbmc/docs/blob/master/architecture/object-mapper.md 122 * 123 * @param[in] bus - The D-Bus object. 124 * @param[in] path - The root of the tree to search. 125 * @param[in] interface - Interface in the subtree to search for 126 * @param[in] depth - The number of path elements to descend. 127 * 128 * @return DbusSubtree - Map of object paths to a map of service names to their 129 * interfaces. 130 */ 131 DbusSubtree getSubTree(sdbusplus::bus::bus& bus, const std::string& path, 132 const std::string& interface, int32_t depth); 133 134 /** 135 * Logs an error and powers off the system. 136 * 137 * @tparam T - error that will be logged before the power off 138 * @param[in] bus - D-Bus object 139 */ 140 template <typename T> 141 void powerOff(sdbusplus::bus::bus& bus) 142 { 143 phosphor::logging::report<T>(); 144 145 auto method = bus.new_method_call(SYSTEMD_SERVICE, SYSTEMD_ROOT, 146 SYSTEMD_INTERFACE, "StartUnit"); 147 148 method.append(POWEROFF_TARGET); 149 method.append("replace"); 150 151 bus.call_noreply(method); 152 } 153 154 /** 155 * Load json from a file 156 * 157 * @param[in] path - The path of the json file 158 * 159 * @return The nlohmann::json object 160 */ 161 nlohmann::json loadJSONFromFile(const char* path); 162 163 /** 164 * Get PmBus access type from the json config 165 * 166 * @param[in] json - The json object 167 * 168 * @return The pmbus access type 169 */ 170 phosphor::pmbus::Type getPMBusAccessType(const nlohmann::json& json); 171 172 /** 173 * Check if power is on 174 * 175 * @param[in] bus - D-Bus object 176 * @param[in] defaultState - The default state if the function fails to get 177 * the power state. 178 * 179 * @return true if power is on, otherwise false; 180 * defaultState if it fails to get the power state. 181 */ 182 bool isPoweredOn(sdbusplus::bus::bus& bus, bool defaultState = false); 183 184 /** 185 * Get all PSU inventory paths from D-Bus 186 * 187 * @param[in] bus - D-Bus object 188 * 189 * @return The list of PSU inventory paths 190 */ 191 std::vector<std::string> getPSUInventoryPaths(sdbusplus::bus::bus& bus); 192 193 } // namespace util 194 } // namespace power 195 } // namespace phosphor 196