include/ipmid/utils.hpp

4 #include <ipmid/api-types.hpp>
32  * than the default 25s D-Bus timeout. */
49      *  @param[in] intf - The interface used for each lookup
50      *  @param[in] path - The path used for each lookup
58      *  @param[in] bus - The bus associated with and used for looking
61     const std::string& getService(sdbusplus::bus_t& bus);
66     /** @brief A wrapper around sdbusplus bus.new_method_call
68      *  @param[in] bus - The bus used for calling the method
69      *  @param[in] intf - The interface containing the method
70      *  @param[in] method - The method name
73     sdbusplus::message_t newMethodCall(sdbusplus::bus_t& bus, const char* intf,
78      * @param[in] bus - The bus used for the service lookup
81     bool isValid(sdbusplus::bus_t& bus) const;
90     /** @brief The name of the bus used in the service lookup */
97  * @param[in] bus - DBUS Bus Object
98  * @param[in] intf - DBUS Interface
99  * @param[in] path - DBUS Object Path
102 std::string getService(sdbusplus::bus_t& bus, const std::string& intf,
106  *  @param[in] bus - DBUS Bus Object.
107  *  @param[in] interfaces - Dbus interface.
108  *  @param[in] subtreePath - subtree from where the search should start.
109  *  @param[in] depth - Search depth
112 ObjectTree getSubTree(sdbusplus::bus_t& bus, const InterfaceList& interface,
117  *  @param[in] bus - DBUS Bus Object.
118  *  @param[in] interface - Dbus interface.
119  *  @param[in] subtreePath - subtree from where the search should start.
120  *  @param[in] match - identifier for object.
124     sdbusplus::bus_t& bus, const std::string& interface,
129  *  @param[in] bus - DBUS Bus Object.
130  *  @param[in] service - Dbus service name.
131  *  @param[in] objPath - Dbus object path.
132  *  @param[in] interface - Dbus interface.
133  *  @param[in] property - name of the property.
136 Value getDbusProperty(sdbusplus::bus_t& bus, const std::string& service,
143  *  @param[in] bus - DBUS Bus Object.
144  *  @param[in] service - Dbus service name.
145  *  @param[in] objPath - Dbus object path.
146  *  @param[in] interface - Dbus interface.
150     sdbusplus::bus_t& bus, const std::string& service,
156  *  @param[in] bus - D-Bus Bus Object.
157  *  @param[in] service - D-Bus service name.
158  *  @param[in] objPath - D-Bus object path.
161 ObjectValueTree getManagedObjects(sdbusplus::bus_t& bus,
166  *  @param[in] bus - DBUS Bus Object.
167  *  @param[in] service - Dbus service name.
168  *  @param[in] objPath - Dbus object path.
169  *  @param[in] interface - Dbus interface.
170  *  @param[in] property - name of the property.
171  *  @param[in] value - value which needs to be set.
173 void setDbusProperty(sdbusplus::bus_t& bus, const std::string& service,
180  *  @param[in] bus - DBUS Bus Object.
181  *  @param[in] serviceRoot - Service root path.
182  *  @param[in] interface - Dbus interface.
183  *  @param[in] match - Identifier for a path.
187     sdbusplus::bus_t& bus, const std::string& serviceRoot,
192  *  @param[in] bus - DBUS Bus Object.
193  *  @param[in] serviceRoot - Service root path.
194  *  @param[in] interface - Dbus interface.
195  *  @param[in] match - Identifier for object.
197 void deleteAllDbusObjects(sdbusplus::bus_t& bus, const std::string& serviceRoot,
204  *  @param[in] bus - Dbus bus object.
205  *  @param[in] path - Child Dbus object path.
206  *  @param[in] interfaces - Dbus interface list.
209 ObjectTree getAllAncestors(sdbusplus::bus_t& bus, const std::string& path,
213 /********* Begin co-routine yielding alternatives ***************/
215 /** @brief Get the D-Bus Service name for the input D-Bus path
217  *  @param[in] ctx - ipmi::Context::ptr
218  *  @param[in] intf - D-Bus Interface
219  *  @param[in] path - D-Bus Object Path
220  *  @param[out] service - requested service name
229  *  @param[in] ctx - ipmi::Context::ptr
230  *  @param[in] bus - DBUS Bus Object.
231  *  @param[in] interfaces - Dbus interface.
232  *  @param[in] subtreePath - subtree from where the search should start.
233  *  @param[in] depth - Search depth
234  *  @param[out] objectTree - map of object path and service info.
241 /** @brief Gets the D-Bus object info implementing the given interface
243  *  @param[in] ctx - ipmi::Context::ptr
244  *  @param[in] interface - D-Bus interface.
245  *  @param[in][optional] subtreePath - subtree from where the search starts.
246  *  @param[in][optional] match - identifier for object.
247  *  @param[out] D-Bus object with path and service name
248  *  @return - boost error code object
272  *  @param[in] ctx - ipmi::Context::ptr
273  *  @param[in] service - D-Bus service name.
274  *  @param[in] objPath - D-Bus object path.
275  *  @param[in] interface - D-Bus interface.
276  *  @param[in] property - name of the property.
277  *  @param[out] propertyValue - value of the D-Bus property.
278  *  @return - boost error code object
287     auto variant = ctx->bus->yield_method_call<std::variant<Type>>(  in getDbusProperty()
288         ctx->yield, ec, service.c_str(), objPath.c_str(), PROP_INTF, METHOD_GET,  in getDbusProperty()
307  *  @param[in] ctx - ipmi::Context::ptr
308  *  @param[in] service - D-Bus service name.
309  *  @param[in] objPath - D-Bus object path.
310  *  @param[in] interface - D-Bus interface.
311  *  @param[out] properties - map of name value pair.
312  *  @return - boost error code object
319  *  @param[in] ctx - ipmi::Context::ptr
320  *  @param[in] service - D-Bus service name.
321  *  @param[in] objPath - D-Bus object path.
322  *  @param[in] interface - D-Bus interface.
323  *  @param[in] property - name of the property.
324  *  @param[in] value - value which needs to be set.
325  *  @return - boost error code object
332 /** @brief  Gets all the D-Bus objects from the given service root
334  *  @param[in] ctx - ipmi::Context::ptr
335  *  @param[in] serviceRoot - Service root path.
336  *  @param[in] interface - D-Bus interface.
337  *  @param[in][optional] match - Identifier for a path.
338  *  @param[out] objectree - map of object path and service info.
339  *  @return - boost error code object
354 /** @brief Deletes all the D-Bus objects from the given service root
356  *  @param[in] ctx - ipmi::Context::ptr
357  *  @param[out] ec - boost error code object
358  *  @param[in] serviceRoot - Service root path.
359  *  @param[in] interface - D-Bus interface.
360  *  @param[in] match - Identifier for object.
369  *  @param[in] ctx - ipmi::Context::ptr
370  *  @param[in] service - D-Bus service name.
371  *  @param[in] objPath - D-Bus object path.
372  *  @param[out] objects - map of name value pair.
373  *  @return - boost error code object
381  *  @param[in] ctx - ipmi::Context::ptr
382  *  @param[in] path - Child D-Bus object path.
383  *  @param[in] interfaces - D-Bus interface list.
384  *  @param[out] ObjectTree - map of object path and service info.
385  *  @return - boost error code object
393  *  @param[in] ctx - ipmi::Context::ptr
394  *  @param[in] service - D-Bus service name.
395  *  @param[in] objPath - D-Bus object path.
396  *  @param[in] interface - D-Bus interface.
397  *  @param[in] method - name of the method.
398  *  @return - boost error code object
405 /********* End co-routine yielding alternatives ***************/
411  *  @tparam T - type of expected value to return
412  *  @param[in] props - D-Bus propery map (Map of variants)
413  *  @param[in] name - key name of property to fetch
414  *  @param[in] defaultValue - default value to return on error
415  *  @return - value from propery map at name, or defaultValue
426     const T* prop = std::get_if<T>(&item->second);  in mappedVariant()
459  *  @param[in] bus - DBUS Bus Object.
460  *  @param[in] service - Dbus service name.
461  *  @param[in] objPath - Dbus object path.
462  *  @param[in] interface - Dbus interface.
463  *  @param[in] method - Dbus method.
465 void callDbusMethod(sdbusplus::bus_t& bus, const std::string& service,
471 /** @brief Perform the low-level i2c bus write-read.
472  *  @param[in] i2cBus - i2c bus device node name, such as /dev/i2c-2.
473  *  @param[in] targetAddr - i2c device target address.
474  *  @param[in] writeData - The data written to i2c device.
475  *  @param[out] readBuf - Data read from the i2c device.