blob: 1db17f3450a7a99f0a72df0a86f395499234a2a9 [file] [log] [blame]
Matt Spinler974c9162017-08-04 08:36:37 -05001#pragma once
2
Lei YU40705462019-10-09 17:07:11 +08003#include "pmbus.hpp"
4
Lei YU7dc31bb2019-08-30 10:07:08 +08005#include <nlohmann/json.hpp>
Matt Spinler882ce952017-10-05 16:12:41 -05006#include <phosphor-logging/elog.hpp>
Matt Spinlerf0f02b92018-10-25 16:12:43 -05007#include <phosphor-logging/log.hpp>
Matt Spinler974c9162017-08-04 08:36:37 -05008#include <sdbusplus/bus.hpp>
Brandon Wymand1bc4ce2019-12-13 14:20:34 -06009
Matt Spinler974c9162017-08-04 08:36:37 -050010#include <string>
11
Lei YUab093322019-10-09 16:43:22 +080012namespace phosphor
Matt Spinler974c9162017-08-04 08:36:37 -050013{
14namespace power
15{
16namespace util
17{
18
Matt Spinlerf0f02b92018-10-25 16:12:43 -050019constexpr auto SYSTEMD_SERVICE = "org.freedesktop.systemd1";
20constexpr auto SYSTEMD_ROOT = "/org/freedesktop/systemd1";
Matt Spinler882ce952017-10-05 16:12:41 -050021constexpr auto SYSTEMD_INTERFACE = "org.freedesktop.systemd1.Manager";
Matt Spinlerf0f02b92018-10-25 16:12:43 -050022constexpr auto POWEROFF_TARGET = "obmc-chassis-hard-poweroff@0.target";
Matt Spinler974c9162017-08-04 08:36:37 -050023constexpr auto PROPERTY_INTF = "org.freedesktop.DBus.Properties";
24
Brandon Wymanc761b5f2020-11-05 18:30:41 -060025using DbusPath = std::string;
Adriana Kobylak4e8b3352021-03-16 20:38:50 +000026using DbusProperty = std::string;
Brandon Wymanc761b5f2020-11-05 18:30:41 -060027using DbusService = std::string;
28using DbusInterface = std::string;
29using DbusInterfaceList = std::vector<DbusInterface>;
30using DbusSubtree =
31 std::map<DbusPath, std::map<DbusService, DbusInterfaceList>>;
Adriana Kobylak886574c2021-11-01 18:22:28 +000032using DbusVariant =
33 std::variant<bool, uint64_t, std::string, std::vector<uint64_t>>;
Adriana Kobylak4e8b3352021-03-16 20:38:50 +000034using DbusPropertyMap = std::map<DbusProperty, DbusVariant>;
Matt Spinler974c9162017-08-04 08:36:37 -050035/**
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
Matthew Barthd2624402020-02-03 15:35:12 -060042 * @param[in] logError - log error when no service found
Matt Spinler974c9162017-08-04 08:36:37 -050043 *
44 * @return The service name
45 */
Matt Spinlerf0f02b92018-10-25 16:12:43 -050046std::string getService(const std::string& path, const std::string& interface,
Patrick Williams7354ce62022-07-22 19:26:56 -050047 sdbusplus::bus_t& bus, bool logError = true);
Matt Spinler974c9162017-08-04 08:36:37 -050048
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 */
Matt Spinlerf0f02b92018-10-25 16:12:43 -050059template <typename T>
60void getProperty(const std::string& interface, const std::string& propertyName,
61 const std::string& path, const std::string& service,
Patrick Williams7354ce62022-07-22 19:26:56 -050062 sdbusplus::bus_t& bus, T& value)
Matt Spinler974c9162017-08-04 08:36:37 -050063{
Patrick Williamsabe49412020-05-13 17:59:47 -050064 std::variant<T> property;
Matt Spinler974c9162017-08-04 08:36:37 -050065
Matt Spinlerf0f02b92018-10-25 16:12:43 -050066 auto method = bus.new_method_call(service.c_str(), path.c_str(),
67 PROPERTY_INTF, "Get");
Matt Spinler974c9162017-08-04 08:36:37 -050068
69 method.append(interface, propertyName);
70
71 auto reply = bus.call(method);
Matt Spinler974c9162017-08-04 08:36:37 -050072
73 reply.read(property);
Patrick Williams365d61c2020-05-13 12:23:08 -050074 value = std::get<T>(property);
Matt Spinler974c9162017-08-04 08:36:37 -050075}
76
Matt Spinler48b4a432017-08-04 11:57:37 -050077/**
Brandon Wyman0a4f5192017-12-06 20:19:08 -060078 * @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 */
Matt Spinlerf0f02b92018-10-25 16:12:43 -050087template <typename T>
88void setProperty(const std::string& interface, const std::string& propertyName,
89 const std::string& path, const std::string& service,
Patrick Williams7354ce62022-07-22 19:26:56 -050090 sdbusplus::bus_t& bus, T& value)
Brandon Wyman0a4f5192017-12-06 20:19:08 -060091{
Patrick Williamsabe49412020-05-13 17:59:47 -050092 std::variant<T> propertyValue(value);
Brandon Wyman0a4f5192017-12-06 20:19:08 -060093
Matt Spinlerf0f02b92018-10-25 16:12:43 -050094 auto method = bus.new_method_call(service.c_str(), path.c_str(),
95 PROPERTY_INTF, "Set");
Brandon Wyman0a4f5192017-12-06 20:19:08 -060096
97 method.append(interface, propertyName, propertyValue);
98
99 auto reply = bus.call(method);
Brandon Wyman0a4f5192017-12-06 20:19:08 -0600100}
101
Adriana Kobylak4e8b3352021-03-16 20:38:50 +0000102/**
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 */
Patrick Williams7354ce62022-07-22 19:26:56 -0500112DbusPropertyMap getAllProperties(sdbusplus::bus_t& bus, const std::string& path,
Adriana Kobylak4e8b3352021-03-16 20:38:50 +0000113 const std::string& interface,
114 const std::string& service = std::string());
115
Brandon Wymanc761b5f2020-11-05 18:30:41 -0600116/** @brief Get subtree from the object mapper.
117 *
118 * Helper function to find objects, services, and interfaces.
119 * See:
120 * https://github.com/openbmc/docs/blob/master/architecture/object-mapper.md
121 *
122 * @param[in] bus - The D-Bus object.
123 * @param[in] path - The root of the tree to search.
124 * @param[in] interface - Interface in the subtree to search for
125 * @param[in] depth - The number of path elements to descend.
126 *
127 * @return DbusSubtree - Map of object paths to a map of service names to their
128 * interfaces.
129 */
Patrick Williams7354ce62022-07-22 19:26:56 -0500130DbusSubtree getSubTree(sdbusplus::bus_t& bus, const std::string& path,
Brandon Wymanc761b5f2020-11-05 18:30:41 -0600131 const std::string& interface, int32_t depth);
132
Brandon Wyman0a4f5192017-12-06 20:19:08 -0600133/**
Matt Spinler882ce952017-10-05 16:12:41 -0500134 * Logs an error and powers off the system.
Matt Spinler48b4a432017-08-04 11:57:37 -0500135 *
Matt Spinler882ce952017-10-05 16:12:41 -0500136 * @tparam T - error that will be logged before the power off
Matt Spinler48b4a432017-08-04 11:57:37 -0500137 * @param[in] bus - D-Bus object
138 */
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500139template <typename T>
Patrick Williams7354ce62022-07-22 19:26:56 -0500140void powerOff(sdbusplus::bus_t& bus)
Matt Spinler882ce952017-10-05 16:12:41 -0500141{
142 phosphor::logging::report<T>();
143
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500144 auto method = bus.new_method_call(SYSTEMD_SERVICE, SYSTEMD_ROOT,
145 SYSTEMD_INTERFACE, "StartUnit");
Matt Spinler882ce952017-10-05 16:12:41 -0500146
147 method.append(POWEROFF_TARGET);
148 method.append("replace");
149
150 bus.call_noreply(method);
151}
Matt Spinler48b4a432017-08-04 11:57:37 -0500152
Lei YU7dc31bb2019-08-30 10:07:08 +0800153/**
154 * Load json from a file
155 *
156 * @param[in] path - The path of the json file
157 *
158 * @return The nlohmann::json object
159 */
160nlohmann::json loadJSONFromFile(const char* path);
161
Lei YU40705462019-10-09 17:07:11 +0800162/**
163 * Get PmBus access type from the json config
164 *
165 * @param[in] json - The json object
166 *
167 * @return The pmbus access type
168 */
169phosphor::pmbus::Type getPMBusAccessType(const nlohmann::json& json);
170
Lei YUcfc040c2019-10-29 17:10:26 +0800171/**
172 * Check if power is on
173 *
Lei YUe8c9cd62019-11-04 14:24:41 +0800174 * @param[in] bus - D-Bus object
175 * @param[in] defaultState - The default state if the function fails to get
176 * the power state.
177 *
178 * @return true if power is on, otherwise false;
179 * defaultState if it fails to get the power state.
Lei YUcfc040c2019-10-29 17:10:26 +0800180 */
Patrick Williams7354ce62022-07-22 19:26:56 -0500181bool isPoweredOn(sdbusplus::bus_t& bus, bool defaultState = false);
Lei YUe8c9cd62019-11-04 14:24:41 +0800182
183/**
184 * Get all PSU inventory paths from D-Bus
185 *
186 * @param[in] bus - D-Bus object
187 *
188 * @return The list of PSU inventory paths
189 */
Patrick Williams7354ce62022-07-22 19:26:56 -0500190std::vector<std::string> getPSUInventoryPaths(sdbusplus::bus_t& bus);
Lei YUcfc040c2019-10-29 17:10:26 +0800191
Matt Spinlerf0f02b92018-10-25 16:12:43 -0500192} // namespace util
193} // namespace power
Lei YUab093322019-10-09 16:43:22 +0800194} // namespace phosphor