blob: c031af1e5224eb7643068e2e16f50e44dc2bc9cc [file] [log] [blame]
Sampa Misra032bd502019-03-06 05:03:22 -06001#pragma once
2
Sampa Misraaea5dde2020-08-31 08:33:47 -05003#include "types.hpp"
4
George Liuc453e162022-12-21 17:16:23 +08005#include <libpldm/base.h>
6#include <libpldm/bios.h>
George Liudf9a6d32020-12-22 16:27:16 +08007#include <libpldm/entity.h>
8#include <libpldm/pdr.h>
George Liuc453e162022-12-21 17:16:23 +08009#include <libpldm/platform.h>
10#include <libpldm/utils.h>
Sampa Misra032bd502019-03-06 05:03:22 -060011#include <systemd/sd-bus.h>
Jinu Joy Thomasf666db12019-05-29 05:22:31 -050012#include <unistd.h>
Sampa Misra032bd502019-03-06 05:03:22 -060013
George Liu6492f522020-06-16 10:34:05 +080014#include <nlohmann/json.hpp>
Archana Kakanie26d13f2025-03-09 23:17:46 -050015#include <phosphor-logging/lg2.hpp>
George Liu6492f522020-06-16 10:34:05 +080016#include <sdbusplus/server.hpp>
Archana Kakanie26d13f2025-03-09 23:17:46 -050017#include <xyz/openbmc_project/BIOSConfig/Manager/common.hpp>
Riya Dixit754041d2024-02-20 06:15:49 -060018#include <xyz/openbmc_project/Inventory/Manager/client.hpp>
George Liu6492f522020-06-16 10:34:05 +080019#include <xyz/openbmc_project/Logging/Entry/server.hpp>
Gilbert Chen44524a52022-02-14 12:12:25 +000020#include <xyz/openbmc_project/ObjectMapper/client.hpp>
George Liu6492f522020-06-16 10:34:05 +080021
Pavithra Barithayab3b84b42024-08-23 11:43:57 +053022#include <cstdint>
George Liudf9a6d32020-12-22 16:27:16 +080023#include <deque>
Sampa Misraa2fa0702019-05-31 01:28:55 -050024#include <exception>
Deepak Kodihalli3cd61812020-03-10 06:38:45 -050025#include <filesystem>
Sampa Misraaa8ae722019-12-12 03:20:40 -060026#include <iostream>
George Liudf9a6d32020-12-22 16:27:16 +080027#include <map>
Sampa Misra032bd502019-03-06 05:03:22 -060028#include <string>
Sampa Misraa2fa0702019-05-31 01:28:55 -050029#include <variant>
30#include <vector>
Sampa Misra032bd502019-03-06 05:03:22 -060031
vkaverap@in.ibm.com5b71b862023-08-21 05:19:04 +000032constexpr uint64_t dbusTimeout =
33 std::chrono::duration_cast<std::chrono::microseconds>(
34 std::chrono::seconds(DBUS_TIMEOUT))
35 .count();
36
Archana Kakanie26d13f2025-03-09 23:17:46 -050037PHOSPHOR_LOG2_USING;
38
Sampa Misra032bd502019-03-06 05:03:22 -060039namespace pldm
40{
Jinu Joy Thomasf666db12019-05-29 05:22:31 -050041namespace utils
42{
Thu Nguyena34a64b2022-03-31 08:56:39 +070043
Gilbert Chen77e6fe72024-08-06 09:23:30 +000044enum class Level
45{
46 WARNING,
47 CRITICAL,
48 PERFORMANCELOSS,
49 SOFTSHUTDOWN,
50 HARDSHUTDOWN,
51 ERROR
52};
53enum class Direction
54{
55 HIGH,
56 LOW,
57 ERROR
58};
59
Thu Nguyena34a64b2022-03-31 08:56:39 +070060const std::set<std::string_view> dbusValueTypeNames = {
61 "bool", "uint8_t", "int16_t", "uint16_t",
62 "int32_t", "uint32_t", "int64_t", "uint64_t",
63 "double", "string", "vector<uint8_t>", "vector<string>"};
64const std::set<std::string_view> dbusValueNumericTypeNames = {
65 "uint8_t", "int16_t", "uint16_t", "int32_t",
66 "uint32_t", "int64_t", "uint64_t", "double"};
67
Deepak Kodihalli3cd61812020-03-10 06:38:45 -050068namespace fs = std::filesystem;
Tom Joseph250c4752020-04-15 10:32:45 +053069using Json = nlohmann::json;
Tom Josephe5268cd2021-09-07 13:04:03 +053070constexpr bool Tx = true;
71constexpr bool Rx = false;
Gilbert Chen44524a52022-02-14 12:12:25 +000072using ObjectMapper = sdbusplus::client::xyz::openbmc_project::ObjectMapper<>;
Gilbert Chen44524a52022-02-14 12:12:25 +000073using inventoryManager =
74 sdbusplus::client::xyz::openbmc_project::inventory::Manager<>;
75
76constexpr auto dbusProperties = "org.freedesktop.DBus.Properties";
77constexpr auto mapperService = ObjectMapper::default_service;
78constexpr auto inventoryPath = "/xyz/openbmc_project/inventory";
Unive Tienc40d4a62025-03-12 11:36:07 +080079
Jinu Joy Thomasf666db12019-05-29 05:22:31 -050080/** @struct CustomFD
81 *
82 * RAII wrapper for file descriptor.
83 */
84struct CustomFD
85{
86 CustomFD(const CustomFD&) = delete;
87 CustomFD& operator=(const CustomFD&) = delete;
88 CustomFD(CustomFD&&) = delete;
89 CustomFD& operator=(CustomFD&&) = delete;
90
Patrick Williams6da4f912023-05-10 07:50:53 -050091 CustomFD(int fd) : fd(fd) {}
Jinu Joy Thomasf666db12019-05-29 05:22:31 -050092
93 ~CustomFD()
94 {
95 if (fd >= 0)
96 {
97 close(fd);
98 }
99 }
100
101 int operator()() const
102 {
103 return fd;
104 }
105
106 private:
107 int fd = -1;
108};
109
Sampa Misrab37be312019-07-03 02:26:41 -0500110/** @brief Calculate the pad for PLDM data
111 *
112 * @param[in] data - Length of the data
113 * @return - uint8_t - number of pad bytes
114 */
115uint8_t getNumPadBytes(uint32_t data);
116
George Liu83409572019-12-24 18:42:54 +0800117/** @brief Convert uint64 to date
118 *
119 * @param[in] data - time date of uint64
120 * @param[out] year - year number in dec
121 * @param[out] month - month number in dec
122 * @param[out] day - day of the month in dec
123 * @param[out] hour - number of hours in dec
124 * @param[out] min - number of minutes in dec
125 * @param[out] sec - number of seconds in dec
Manojkiran Eda2576aec2024-06-17 12:05:17 +0530126 * @return true if decode success, false if decode failed
George Liu83409572019-12-24 18:42:54 +0800127 */
128bool uintToDate(uint64_t data, uint16_t* year, uint8_t* month, uint8_t* day,
129 uint8_t* hour, uint8_t* min, uint8_t* sec);
130
131/** @brief Convert effecter data to structure of set_effecter_state_field
132 *
133 * @param[in] effecterData - the date of effecter
George Liuba4c1fb2020-02-05 14:13:30 +0800134 * @param[in] effecterCount - the number of individual sets of effecter
135 * information
136 * @return[out] parse success and get a valid set_effecter_state_field
137 * structure, return nullopt means parse failed
George Liu83409572019-12-24 18:42:54 +0800138 */
Patrick Williams16c2a0a2024-08-16 15:20:59 -0400139std::optional<std::vector<set_effecter_state_field>> parseEffecterData(
140 const std::vector<uint8_t>& effecterData, uint8_t effecterCount);
Sampa Misra032bd502019-03-06 05:03:22 -0600141
142/**
Sampa Misraaa8ae722019-12-12 03:20:40 -0600143 * @brief creates an error log
144 * @param[in] errorMsg - the error message
145 */
Manojkiran Eda92fb0b52024-04-17 10:48:17 +0530146void reportError(const char* errorMsg);
Sampa Misraaa8ae722019-12-12 03:20:40 -0600147
Sampa Misra032bd502019-03-06 05:03:22 -0600148/** @brief Convert any Decimal number to BCD
149 *
150 * @tparam[in] decimal - Decimal number
151 * @return Corresponding BCD number
152 */
153template <typename T>
154T decimalToBcd(T decimal)
155{
156 T bcd = 0;
157 T rem = 0;
158 auto cnt = 0;
159
160 while (decimal)
161 {
162 rem = decimal % 10;
163 bcd = bcd + (rem << cnt);
164 decimal = decimal / 10;
165 cnt += 4;
166 }
167
168 return bcd;
169}
170
George Liu1e44c732020-02-28 20:20:06 +0800171struct DBusMapping
172{
173 std::string objectPath; //!< D-Bus object path
174 std::string interface; //!< D-Bus interface
175 std::string propertyName; //!< D-Bus property name
176 std::string propertyType; //!< D-Bus property type
177};
178
179using PropertyValue =
180 std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t,
Riya Dixit754041d2024-02-20 06:15:49 -0600181 uint64_t, double, std::string, std::vector<uint8_t>,
Unive Tienc40d4a62025-03-12 11:36:07 +0800182 std::vector<uint64_t>, std::vector<std::string>>;
Deepak Kodihalli6b1d1ca2020-04-27 07:24:51 -0500183using DbusProp = std::string;
184using DbusChangedProps = std::map<DbusProp, PropertyValue>;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500185using DBusInterfaceAdded = std::vector<
186 std::pair<pldm::dbus::Interface,
187 std::vector<std::pair<pldm::dbus::Property,
188 std::variant<pldm::dbus::Property>>>>>;
Kamalkumar Patel7d427f12024-05-16 03:44:00 -0500189
Manojkiran Eda1ef62c32021-04-24 07:23:18 +0530190using ObjectPath = std::string;
Kamalkumar Patel7d427f12024-05-16 03:44:00 -0500191using EntityName = std::string;
192using Entities = std::vector<pldm_entity_node*>;
193using EntityAssociations = std::vector<Entities>;
194using ObjectPathMaps = std::map<fs::path, pldm_entity_node*>;
195using EntityMaps = std::map<pldm::pdr::EntityType, EntityName>;
196
Manojkiran Eda1ef62c32021-04-24 07:23:18 +0530197using ServiceName = std::string;
198using Interfaces = std::vector<std::string>;
199using MapperServiceMap = std::vector<std::pair<ServiceName, Interfaces>>;
200using GetSubTreeResponse = std::vector<std::pair<ObjectPath, MapperServiceMap>>;
Pavithra Barithaya2ec82692024-04-29 06:31:10 -0500201using GetSubTreePathsResponse = std::vector<std::string>;
Unive Tienc40d4a62025-03-12 11:36:07 +0800202using GetAssociatedSubTreeResponse =
203 std::map<std::string, std::map<std::string, std::vector<std::string>>>;
Delphine CC Chiu549e4bc2024-03-06 11:24:05 +0800204using GetAncestorsResponse =
205 std::vector<std::pair<ObjectPath, MapperServiceMap>>;
Sridevi Ramesheefe49b2022-06-27 11:51:02 -0500206using PropertyMap = std::map<std::string, PropertyValue>;
207using InterfaceMap = std::map<std::string, PropertyMap>;
Riya Dixit754041d2024-02-20 06:15:49 -0600208using ObjectValueTree = std::map<sdbusplus::message::object_path, InterfaceMap>;
Archana Kakanie26d13f2025-03-09 23:17:46 -0500209using AttributeName = std::string;
210using AttributeType = std::string;
211using AttributeValue = std::variant<std::string, int64_t>;
212using PendingAttributesList = std::vector<
213 std::pair<AttributeName, std::tuple<AttributeType, AttributeValue>>>;
George Liu1e44c732020-02-28 20:20:06 +0800214
Pavithra Barithaya36ac5592025-06-16 11:41:37 +0530215using SensorPDR = std::vector<uint8_t>;
216using SensorPDRs = std::vector<SensorPDR>;
Pavithra Barithayaa206b602025-08-21 14:37:13 +0530217using EffecterPDR = std::vector<uint8_t>;
218using EffecterPDRs = std::vector<EffecterPDR>;
Pavithra Barithaya36ac5592025-06-16 11:41:37 +0530219
Archana Kakanie26d13f2025-03-09 23:17:46 -0500220constexpr auto EnumAttribute =
221 "xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Enumeration";
222
George Liu1e44c732020-02-28 20:20:06 +0800223/**
224 * @brief The interface for DBusHandler
225 */
226class DBusHandlerInterface
227{
228 public:
229 virtual ~DBusHandlerInterface() = default;
230
George Liu36e81352020-07-01 14:40:30 +0800231 virtual std::string getService(const char* path,
232 const char* interface) const = 0;
Patrick Williams366507c2025-02-03 14:28:01 -0500233 virtual GetSubTreeResponse getSubtree(
234 const std::string& path, int depth,
235 const std::vector<std::string>& ifaceList) const = 0;
George Liu36e81352020-07-01 14:40:30 +0800236
Patrick Williams366507c2025-02-03 14:28:01 -0500237 virtual GetSubTreePathsResponse getSubTreePaths(
238 const std::string& objectPath, int depth,
239 const std::vector<std::string>& ifaceList) const = 0;
Pavithra Barithaya2ec82692024-04-29 06:31:10 -0500240
Delphine CC Chiu549e4bc2024-03-06 11:24:05 +0800241 virtual GetAncestorsResponse getAncestors(
242 const std::string& path,
243 const std::vector<std::string>& ifaceList) const = 0;
244
George Liu1e44c732020-02-28 20:20:06 +0800245 virtual void setDbusProperty(const DBusMapping& dBusMap,
246 const PropertyValue& value) const = 0;
John Wang9e242422020-03-05 08:37:50 +0800247
Patrick Williams366507c2025-02-03 14:28:01 -0500248 virtual PropertyValue getDbusPropertyVariant(
249 const char* objPath, const char* dbusProp,
250 const char* dbusInterface) const = 0;
Gilbert Chen44524a52022-02-14 12:12:25 +0000251
Patrick Williams366507c2025-02-03 14:28:01 -0500252 virtual PropertyMap getDbusPropertiesVariant(
253 const char* serviceName, const char* objPath,
254 const char* dbusInterface) const = 0;
Unive Tienc40d4a62025-03-12 11:36:07 +0800255
256 virtual GetAssociatedSubTreeResponse getAssociatedSubTree(
257 const sdbusplus::message::object_path& objectPath,
258 const sdbusplus::message::object_path& subtree, int depth,
259 const std::vector<std::string>& ifaceList) const = 0;
George Liu1e44c732020-02-28 20:20:06 +0800260};
261
Sampa Misraa2fa0702019-05-31 01:28:55 -0500262/**
263 * @class DBusHandler
264 *
265 * Wrapper class to handle the D-Bus calls
266 *
267 * This class contains the APIs to handle the D-Bus calls
268 * to cater the request from pldm requester.
269 * A class is created to mock the apis in the test cases
270 */
George Liu1e44c732020-02-28 20:20:06 +0800271class DBusHandler : public DBusHandlerInterface
Sampa Misraa2fa0702019-05-31 01:28:55 -0500272{
273 public:
George Liu0e02c322020-01-01 09:41:51 +0800274 /** @brief Get the bus connection. */
275 static auto& getBus()
276 {
277 static auto bus = sdbusplus::bus::new_default();
278 return bus;
279 }
280
281 /**
282 * @brief Get the DBUS Service name for the input dbus path
John Wang9e242422020-03-05 08:37:50 +0800283 *
George Liu0e02c322020-01-01 09:41:51 +0800284 * @param[in] path - DBUS object path
285 * @param[in] interface - DBUS Interface
John Wang9e242422020-03-05 08:37:50 +0800286 *
George Liu0e02c322020-01-01 09:41:51 +0800287 * @return std::string - the dbus service name
John Wang9e242422020-03-05 08:37:50 +0800288 *
Patrick Williams84b790c2022-07-22 19:26:56 -0500289 * @throw sdbusplus::exception_t when it fails
George Liu0e02c322020-01-01 09:41:51 +0800290 */
George Liu36e81352020-07-01 14:40:30 +0800291 std::string getService(const char* path,
292 const char* interface) const override;
George Liu0e02c322020-01-01 09:41:51 +0800293
Manojkiran Eda1ef62c32021-04-24 07:23:18 +0530294 /**
295 * @brief Get the Subtree response from the mapper
296 *
297 * @param[in] path - DBUS object path
298 * @param[in] depth - Search depth
299 * @param[in] ifaceList - list of the interface that are being
300 * queried from the mapper
301 *
302 * @return GetSubTreeResponse - the mapper subtree response
303 *
Patrick Williams84b790c2022-07-22 19:26:56 -0500304 * @throw sdbusplus::exception_t when it fails
Manojkiran Eda1ef62c32021-04-24 07:23:18 +0530305 */
Patrick Williams366507c2025-02-03 14:28:01 -0500306 GetSubTreeResponse getSubtree(
307 const std::string& path, int depth,
308 const std::vector<std::string>& ifaceList) const override;
Manojkiran Eda1ef62c32021-04-24 07:23:18 +0530309
Pavithra Barithaya2ec82692024-04-29 06:31:10 -0500310 /** @brief Get Subtree path response from the mapper
311 *
312 * @param[in] path - DBUS object path
313 * @param[in] depth - Search depth
314 * @param[in] ifaceList - list of the interface that are being
315 * queried from the mapper
316 *
317 * @return std::vector<std::string> vector of subtree paths
318 */
319 GetSubTreePathsResponse getSubTreePaths(
320 const std::string& objectPath, int depth,
321 const std::vector<std::string>& ifaceList) const override;
322
Delphine CC Chiu549e4bc2024-03-06 11:24:05 +0800323 /**
324 * @brief Get the Ancestors response from the mapper
325 *
326 * @param[in] path - D-Bus object path
327 * @param[in] ifaceList - an optional list of interfaces to constrain the
328 * search to queried from the mapper
329 *
330 * @return GetAncestorsResponse - the mapper GetAncestors response
331 *
332 * @throw sdbusplus::exception_t when it fails
333 */
334 GetAncestorsResponse getAncestors(
335 const std::string& path,
336 const std::vector<std::string>& ifaceList) const override;
337
John Wang9e242422020-03-05 08:37:50 +0800338 /** @brief Get property(type: variant) from the requested dbus
339 *
340 * @param[in] objPath - The Dbus object path
341 * @param[in] dbusProp - The property name to get
342 * @param[in] dbusInterface - The Dbus interface
343 *
344 * @return The value of the property(type: variant)
345 *
Patrick Williams84b790c2022-07-22 19:26:56 -0500346 * @throw sdbusplus::exception_t when it fails
John Wang9e242422020-03-05 08:37:50 +0800347 */
Patrick Williams366507c2025-02-03 14:28:01 -0500348 PropertyValue getDbusPropertyVariant(
349 const char* objPath, const char* dbusProp,
350 const char* dbusInterface) const override;
George Liu0e02c322020-01-01 09:41:51 +0800351
Gilbert Chen44524a52022-02-14 12:12:25 +0000352 /** @brief Get All properties(type: variant) from the requested dbus
353 *
354 * @param[in] serviceName - The Dbus service name
355 * @param[in] objPath - The Dbus object path
356 * @param[in] dbusInterface - The Dbus interface
357 *
358 * @return The values of the properties(type: variant)
359 *
360 * @throw sdbusplus::exception_t when it fails
361 */
Patrick Williams366507c2025-02-03 14:28:01 -0500362 PropertyMap getDbusPropertiesVariant(
363 const char* serviceName, const char* objPath,
364 const char* dbusInterface) const override;
Gilbert Chen44524a52022-02-14 12:12:25 +0000365
John Wang9e242422020-03-05 08:37:50 +0800366 /** @brief The template function to get property from the requested dbus
367 * path
368 *
369 * @tparam Property - Excepted type of the property on dbus
370 *
371 * @param[in] objPath - The Dbus object path
372 * @param[in] dbusProp - The property name to get
373 * @param[in] dbusInterface - The Dbus interface
374 *
375 * @return The value of the property
376 *
Patrick Williams84b790c2022-07-22 19:26:56 -0500377 * @throw sdbusplus::exception_t when dbus request fails
John Wang9e242422020-03-05 08:37:50 +0800378 * std::bad_variant_access when \p Property and property on dbus do
379 * not match
380 */
John Wang92b3c972019-10-17 11:06:41 +0800381 template <typename Property>
382 auto getDbusProperty(const char* objPath, const char* dbusProp,
383 const char* dbusInterface)
384 {
Patrick Williams16c2a0a2024-08-16 15:20:59 -0400385 auto VariantValue =
386 getDbusPropertyVariant(objPath, dbusProp, dbusInterface);
John Wang92b3c972019-10-17 11:06:41 +0800387 return std::get<Property>(VariantValue);
388 }
George Liu1e44c732020-02-28 20:20:06 +0800389
Unive Tienc40d4a62025-03-12 11:36:07 +0800390 /** @brief Get the associated subtree from the mapper
391 *
392 * @param[in] path - The D-Bus object path
393 *
394 * @param[in] interface - The D-Bus interface
395 *
396 * @return GetAssociatedSubtreeResponse - The associated subtree
397 */
398 GetAssociatedSubTreeResponse getAssociatedSubTree(
399 const sdbusplus::message::object_path& objectPath,
400 const sdbusplus::message::object_path& subtree, int depth,
401 const std::vector<std::string>& ifaceList) const override;
402
George Liu1e44c732020-02-28 20:20:06 +0800403 /** @brief Set Dbus property
404 *
405 * @param[in] dBusMap - Object path, property name, interface and property
406 * type for the D-Bus object
407 * @param[in] value - The value to be set
John Wang9e242422020-03-05 08:37:50 +0800408 *
Patrick Williams84b790c2022-07-22 19:26:56 -0500409 * @throw sdbusplus::exception_t when it fails
George Liu1e44c732020-02-28 20:20:06 +0800410 */
411 void setDbusProperty(const DBusMapping& dBusMap,
412 const PropertyValue& value) const override;
Riya Dixit754041d2024-02-20 06:15:49 -0600413
414 /** @brief This function retrieves the properties of an object managed
415 * by the specified D-Bus service located at the given object path.
416 *
417 * @param[in] service - The D-Bus service providing the managed object
418 * @param[in] value - The object path of the managed object
419 *
420 * @return A hierarchical structure representing the properties of the
421 * managed object.
Patrick Williams897b0f82024-04-14 02:31:48 -0500422 * @throw sdbusplus::exception_t when it fails
Riya Dixit754041d2024-02-20 06:15:49 -0600423 */
424 static ObjectValueTree getManagedObj(const char* service, const char* path);
425
426 /** @brief Retrieve the inventory objects managed by a specified class.
427 * The retrieved inventory objects are cached statically
428 * and returned upon subsequent calls to this function.
429 *
430 * @tparam ClassType - The class type that manages the inventory objects.
431 *
432 * @return A reference to the cached inventory objects.
433 */
434 template <typename ClassType>
435 static auto& getInventoryObjects()
436 {
437 static ObjectValueTree object = ClassType::getManagedObj(
438 inventoryManager::interface, inventoryPath);
439 return object;
440 }
Sampa Misraa2fa0702019-05-31 01:28:55 -0500441};
442
Deepak Kodihalli3cd61812020-03-10 06:38:45 -0500443/** @brief Fetch parent D-Bus object based on pathname
444 *
445 * @param[in] dbusObj - child D-Bus object
446 *
447 * @return std::string - the parent D-Bus object path
448 */
449inline std::string findParent(const std::string& dbusObj)
450{
451 fs::path p(dbusObj);
452 return p.parent_path().string();
453}
454
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500455/** @brief Read (static) MCTP EID of host firmware from a file
456 *
457 * @return uint8_t - MCTP EID
458 */
459uint8_t readHostEID();
Tom Joseph250c4752020-04-15 10:32:45 +0530460
Gilbert Chen6c7fed42022-02-22 15:40:17 +0000461/** @brief Validate the MCTP EID of MCTP endpoint
462 * In `Table 2 - Special endpoint IDs` of DSP0236. EID 0 is NULL_EID.
463 * EID from 1 to 7 is reserved EID. EID 0xFF is broadcast EID.
464 * Those are invalid EID of one MCTP Endpoint.
465 *
466 * @param[in] eid - MCTP EID
467 *
468 * @return true if the MCTP EID is valid otherwise return false.
469 */
470bool isValidEID(eid mctpEid);
471
TOM JOSEPHd4d97a52020-03-23 14:36:34 +0530472/** @brief Convert a value in the JSON to a D-Bus property value
473 *
474 * @param[in] type - type of the D-Bus property
475 * @param[in] value - value in the JSON file
476 *
477 * @return PropertyValue - the D-Bus property value
478 */
479PropertyValue jsonEntryToDbusVal(std::string_view type,
480 const nlohmann::json& value);
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500481
Pavithra Barithaya0f74c982020-04-27 02:17:10 -0500482/** @brief Find State Effecter PDR
483 * @param[in] tid - PLDM terminus ID.
484 * @param[in] entityID - entity that can be associated with PLDM State set.
485 * @param[in] stateSetId - value that identifies PLDM State set.
486 * @param[in] repo - pointer to BMC's primary PDR repo.
487 * @return array[array[uint8_t]] - StateEffecterPDRs
488 */
Patrick Williams16c2a0a2024-08-16 15:20:59 -0400489std::vector<std::vector<uint8_t>> findStateEffecterPDR(
490 uint8_t tid, uint16_t entityID, uint16_t stateSetId, const pldm_pdr* repo);
Chicago Duan738e4d82020-05-28 16:39:19 +0800491/** @brief Find State Sensor PDR
492 * @param[in] tid - PLDM terminus ID.
493 * @param[in] entityID - entity that can be associated with PLDM State set.
494 * @param[in] stateSetId - value that identifies PLDM State set.
495 * @param[in] repo - pointer to BMC's primary PDR repo.
496 * @return array[array[uint8_t]] - StateSensorPDRs
497 */
Patrick Williams16c2a0a2024-08-16 15:20:59 -0400498std::vector<std::vector<uint8_t>> findStateSensorPDR(
499 uint8_t tid, uint16_t entityID, uint16_t stateSetId, const pldm_pdr* repo);
Pavithra Barithaya0f74c982020-04-27 02:17:10 -0500500
Sampa Misra3a0e3b92020-10-21 05:58:00 -0500501/** @brief Find sensor id from a state sensor PDR
502 *
503 * @param[in] pdrRepo - PDR repository
504 * @param[in] tid - terminus id
505 * @param[in] entityType - entity type
506 * @param[in] entityInstance - entity instance number
507 * @param[in] containerId - container id
508 * @param[in] stateSetId - state set id
509 *
510 * @return uint16_t - the sensor id
511 */
512uint16_t findStateSensorId(const pldm_pdr* pdrRepo, uint8_t tid,
513 uint16_t entityType, uint16_t entityInstance,
514 uint16_t containerId, uint16_t stateSetId);
515
Tom Joseph250c4752020-04-15 10:32:45 +0530516/** @brief Find effecter id from a state effecter pdr
517 * @param[in] pdrRepo - PDR repository
518 * @param[in] entityType - entity type
519 * @param[in] entityInstance - entity instance number
520 * @param[in] containerId - container id
521 * @param[in] stateSetId - state set id
Sampa Misraa4a96162020-07-14 05:33:46 -0500522 * @param[in] localOrRemote - true for checking local repo and false for remote
523 * repo
Tom Joseph250c4752020-04-15 10:32:45 +0530524 *
525 * @return uint16_t - the effecter id
526 */
527uint16_t findStateEffecterId(const pldm_pdr* pdrRepo, uint16_t entityType,
528 uint16_t entityInstance, uint16_t containerId,
Sampa Misraa4a96162020-07-14 05:33:46 -0500529 uint16_t stateSetId, bool localOrRemote);
Tom Joseph250c4752020-04-15 10:32:45 +0530530
Pavithra Barithaya36ac5592025-06-16 11:41:37 +0530531/** @brief Method to find all state sensor PDRs by type
532 *
533 * @param[in] entityType - the entity type
534 * @param[in] repo - opaque pointer acting as a PDR repo handle
535 *
536 * @return vector of vector of all state sensor PDRs
537 */
538SensorPDRs getStateSensorPDRsByType(uint16_t entityType, const pldm_pdr* repo);
539
540/** @brief method to find sensor IDs based on the pldm_entity
541 *
542 * @param[in] pdrRepo - opaque pointer acting as a PDR repo handle
543 * @param[in] entityType - the entity type
544 * @param[in] entityInstance - the entity instance number
545 * @param[in] containerId - the container ID
546 *
547 * @return vector of all sensor IDs
548 */
549std::vector<pldm::pdr::SensorID> findSensorIds(
550 const pldm_pdr* pdrRepo, uint16_t entityType, uint16_t entityInstance,
551 uint16_t containerId);
552
Pavithra Barithayaa206b602025-08-21 14:37:13 +0530553/** @brief Method to find all state effecter PDRs by type
554 *
555 * @param[in] entityType - the entity type
556 * @param[in] repo - opaque pointer acting as a PDR repo handle
557 *
558 * @return vector of vector of all state effecter PDRs
559 */
560EffecterPDRs getStateEffecterPDRsByType(uint16_t entityType,
561 const pldm_pdr* repo);
562
563/** @brief method to find effecter IDs based on the pldm_entity
564 *
565 * @param[in] pdrRepo - opaque pointer acting as a PDR repo handle
566 * @param[in] entityType - the entity type
567 * @param[in] entityInstance - the entity instance number
568 * @param[in] containerId - the container ID
569 *
570 * @return vector of all effecter IDs
571 */
572std::vector<pldm::pdr::EffecterID> findEffecterIds(
573 const pldm_pdr* pdrRepo, uint16_t entityType, uint16_t entityInstance,
574 uint16_t containerId);
575
Chicago Duanfe4d88b2020-06-12 16:44:13 +0800576/** @brief Emit the sensor event signal
577 *
578 * @param[in] tid - the terminus id
579 * @param[in] sensorId - sensorID value of the sensor
580 * @param[in] sensorOffset - Identifies which state sensor within a
581 * composite state sensor the event is being returned for
582 * @param[in] eventState - The event state value from the state change that
583 * triggered the event message
584 * @param[in] previousEventState - The event state value for the state from
585 * which the present event state was entered.
586 * @return PLDM completion code
587 */
588int emitStateSensorEventSignal(uint8_t tid, uint16_t sensorId,
589 uint8_t sensorOffset, uint8_t eventState,
590 uint8_t previousEventState);
591
Chau Ly8fa40db2024-04-02 09:32:01 +0000592/**
593 * @brief call Recover() method to recover an MCTP Endpoint
594 * @param[in] MCTP Endpoint's object path
595 */
596void recoverMctpEndpoint(const std::string& endpointObjPath);
597
Sridevi Rameshae28bc72020-12-10 07:21:16 -0600598/** @brief Print the buffer
599 *
Tom Josephe5268cd2021-09-07 13:04:03 +0530600 * @param[in] isTx - True if the buffer is an outgoing PLDM message, false if
601 the buffer is an incoming PLDM message
602 * @param[in] buffer - Buffer to print
Sridevi Rameshae28bc72020-12-10 07:21:16 -0600603 *
604 * @return - None
605 */
Tom Josephe5268cd2021-09-07 13:04:03 +0530606void printBuffer(bool isTx, const std::vector<uint8_t>& buffer);
Sridevi Rameshae28bc72020-12-10 07:21:16 -0600607
Tom Joseph54922072021-06-19 02:45:46 -0700608/** @brief Convert the buffer to std::string
609 *
610 * If there are characters that are not printable characters, it is replaced
611 * with space(0x20).
612 *
613 * @param[in] var - pointer to data and length of the data
614 *
615 * @return std::string equivalent of variable field
616 */
617std::string toString(const struct variable_field& var);
618
George Liu872f0f62021-11-25 16:26:16 +0800619/** @brief Split strings according to special identifiers
620 *
621 * We can split the string according to the custom identifier(';', ',', '&' or
622 * others) and store it to vector.
623 *
624 * @param[in] srcStr - The string to be split
625 * @param[in] delim - The custom identifier
626 * @param[in] trimStr - The first and last string to be trimmed
627 *
628 * @return std::vector<std::string> Vectors are used to store strings
629 */
630std::vector<std::string> split(std::string_view srcStr, std::string_view delim,
631 std::string_view trimStr = "");
Manojkiran Edaef773052021-07-29 09:29:28 +0530632/** @brief Get the current system time in readable format
633 *
634 * @return - std::string equivalent of the system time
635 */
636std::string getCurrentSystemTime();
George Liu872f0f62021-11-25 16:26:16 +0800637
Sridevi Ramesheefe49b2022-06-27 11:51:02 -0500638/** @brief checks if the FRU is actually present.
639 * @param[in] objPath - FRU object path.
640 *
641 * @return bool to indicate presence or absence of FRU.
642 */
643bool checkForFruPresence(const std::string& objPath);
644
Sagar Srinivas5db6e872023-12-01 10:03:30 -0600645/** @brief Method to check if the logical bit is set
646 *
647 * @param[containerId] - container id of the entity
648 *
649 * @return true or false based on the logic bit set
650 */
651bool checkIfLogicalBitSet(const uint16_t& containerId);
Pavithra Barithaya5e542be2021-08-13 00:33:31 -0500652
653/** @brief setting the present property
654 *
655 * @param[in] objPath - the object path of the fru
656 * @param[in] present - status to set either true/false
657 */
658void setFruPresence(const std::string& fruObjPath, bool present);
Thu Nguyenb8cf46b2024-06-15 02:44:35 +0000659
660/** @brief Trim `\0` in string and replace ` ` by `_` to use name in D-Bus
661 * object path
662 *
663 * @param[in] name - the input string
664 *
665 * @return the result string
666 */
667std::string_view trimNameForDbus(std::string& name);
668
Thu Nguyena34a64b2022-03-31 08:56:39 +0700669/** @brief Convert the number type D-Bus Value to the double
670 *
671 * @param[in] type - string type should in dbusValueNumericTypeNames list
672 * @param[in] value - DBus PropertyValue variant
673 * @param[out] doubleValue - response value
674 *
675 * @return true if data type is corrected and converting is successful
676 * otherwise return false.
677 */
678bool dbusPropValuesToDouble(const std::string_view& type,
679 const pldm::utils::PropertyValue& value,
680 double* doubleValue);
681
Dung Caob6d39432024-06-05 03:46:47 +0000682/** @brief Convert the Fru String bytes from PLDM Fru to std::string
683 *
684 * @param[in] value - the Fru String bytes
685 * @param[in] length - Number of bytes
686 *
687 * @return Fru string or nullopt.
688 */
Patrick Williams366507c2025-02-03 14:28:01 -0500689std::optional<std::string> fruFieldValuestring(const uint8_t* value,
690 const uint8_t& length);
Dung Caob6d39432024-06-05 03:46:47 +0000691
692/** @brief Convert the Fru Uint32 raw data from PLDM Fru to uint32_t
693 *
694 * @param[in] value - the Fru uint32 raw data
695 * @param[in] length - Number of bytes
696 *
697 * @return Fru uint32_t or nullopt.
698 */
699std::optional<uint32_t> fruFieldParserU32(const uint8_t* value,
700 const uint8_t& length);
701
Archana Kakanie26d13f2025-03-09 23:17:46 -0500702/** @brief Method to get the value from a bios attribute
703 *
704 * @param[in] dbusAttrName - the bios attribute name from
705 * which the value must be retrieved
706 *
707 * @return the attribute value
708 */
709template <typename T>
710std::optional<T> getBiosAttrValue(const std::string& dbusAttrName)
711{
712 constexpr auto biosConfigPath = "/xyz/openbmc_project/bios_config/manager";
713 constexpr auto biosConfigIntf = sdbusplus::common::xyz::openbmc_project::
714 bios_config::Manager::interface;
715
716 std::string var1;
717 std::variant<std::string, int64_t> var2, var3;
718 auto& bus = DBusHandler::getBus();
719 try
720 {
721 auto service = pldm::utils::DBusHandler().getService(biosConfigPath,
722 biosConfigIntf);
723 auto method = bus.new_method_call(service.c_str(), biosConfigPath,
724 biosConfigIntf, "GetAttribute");
725 method.append(dbusAttrName);
726 auto reply = bus.call(method, dbusTimeout);
727 reply.read(var1, var2, var3);
728 if (auto ptr = std::get_if<T>(&var2))
729 {
730 return *ptr;
731 }
732 }
733 catch (const sdbusplus::exception::SdBusError& e)
734 {
735 info("Error getting the bios attribute {BIOS_ATTR}: {ERR_EXCEP}",
736 "BIOS_ATTR", dbusAttrName, "ERR_EXCEP", e);
737 }
738
739 return std::nullopt;
740}
741
742/** @brief Method to set the specified bios attribute with
743 * specified value
744 *
745 * @param[in] PendingAttributesList - the list of bios attribute and values
746 * to be set
747 */
748void setBiosAttr(const PendingAttributesList& biosAttrList);
749
George Liu83409572019-12-24 18:42:54 +0800750} // namespace utils
Sampa Misra032bd502019-03-06 05:03:22 -0600751} // namespace pldm