Implement the FRU implementation class
FRU implementation class implements the logic to build the PLDM FRU table
from the inventory D-Bus objects. This class exposes APIs to read the
FRU table, number of FRU records and the checksum of the table. This will
be consumed by the GetFRURecordTableMetadata command and GetFRURecordTable
command specified in the DMTF specification DSP0257.
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>
Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
Change-Id: I3212f59e7e972dc66f57a507ba87b707281ba0b9
diff --git a/libpldmresponder/fru.hpp b/libpldmresponder/fru.hpp
new file mode 100644
index 0000000..3f817fd
--- /dev/null
+++ b/libpldmresponder/fru.hpp
@@ -0,0 +1,126 @@
+#pragma once
+
+#include "config.h"
+
+#include "fru_parser.hpp"
+#include "handler.hpp"
+
+#include <map>
+#include <sdbusplus/message.hpp>
+#include <string>
+#include <variant>
+#include <vector>
+
+#include "libpldm/fru.h"
+
+namespace pldm
+{
+
+namespace responder
+{
+
+namespace dbus
+{
+
+using Value =
+ std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t,
+ uint64_t, double, std::string, std::vector<uint8_t>>;
+using PropertyMap = std::map<Property, Value>;
+using InterfaceMap = std::map<Interface, PropertyMap>;
+using ObjectValueTree = std::map<sdbusplus::message::object_path, InterfaceMap>;
+
+} // namespace dbus
+
+/** @class FruImpl
+ *
+ * @brief Builds the PLDM FRU table containing the FRU records
+ */
+class FruImpl
+{
+ public:
+ /* @brief Header size for FRU record, it includes the FRU record set
+ * identifier, FRU record type, Number of FRU fields, Encoding type
+ * of FRU fields
+ */
+ static constexpr size_t recHeaderSize =
+ sizeof(struct pldm_fru_record_data_format) -
+ sizeof(struct pldm_fru_record_tlv);
+
+ /** @brief The FRU table is populated by processing the D-Bus inventory
+ * namespace, based on the config files for FRU. The configPath is
+ * consumed to build the FruParser object.
+ *
+ * @param[in] configPath - path to the directory containing config files
+ * for PLDM FRU
+ */
+ FruImpl(const std::string& configPath);
+
+ /** @brief Total length of the FRU table in bytes, this excludes the pad
+ * bytes and the checksum.
+ *
+ * @return size of the FRU table
+ */
+ uint32_t size() const
+ {
+ return table.size() - padBytes;
+ }
+
+ /** @brief The checksum of the contents of the FRU table
+ *
+ * @return checksum
+ */
+ uint32_t checkSum() const
+ {
+ return checksum;
+ }
+
+ /** @brief Number of record set identifiers in the FRU tables
+ *
+ * @return number of record set identifiers
+ */
+ uint16_t numRSI() const
+ {
+ return rsi;
+ }
+
+ /** @brief The number of FRU records in the table
+ *
+ * @return number of FRU records
+ */
+ uint16_t numRecords() const
+ {
+ return numRecs;
+ }
+
+ /** @brief Get the FRU table
+ *
+ * @param[out] - Populate response with the FRU table
+ */
+ void getFRUTable(Response& response);
+
+ private:
+ uint16_t nextRSI()
+ {
+ return ++rsi;
+ }
+
+ uint16_t rsi = 0;
+ uint16_t numRecs = 0;
+ uint8_t padBytes = 0;
+ std::vector<uint8_t> table;
+ uint32_t checksum = 0;
+
+ /** @brief populateRecord builds the FRU records for an instance of FRU and
+ * updates the FRU table with the FRU records.
+ *
+ * @param[in] interfaces - D-Bus interfaces and the associated property
+ * values for the FRU
+ * @param[in] recordInfos - FRU record info to build the FRU records
+ */
+ void populateRecords(const pldm::responder::dbus::InterfaceMap& interfaces,
+ const fru_parser::FruRecordInfos& recordInfos);
+};
+
+} // namespace responder
+
+} // namespace pldm