Initial support to parse a Chip Data File
Change-Id: Ib5a7d8344922f8288c23f5bedd304e282dcfaada
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
diff --git a/src/chip_data/hei_chip_data.hpp b/src/chip_data/hei_chip_data.hpp
index 26cfb75..f35cdc1 100644
--- a/src/chip_data/hei_chip_data.hpp
+++ b/src/chip_data/hei_chip_data.hpp
@@ -1,6 +1,25 @@
#pragma once
-#include <hei_includes.hpp>
+#include <isolator/hei_isolation_chip.hpp>
namespace libhei
-{} // end namespace libhei
+{
+
+/**
+ * @brief Parses a buffer containing a Chip Data File and builds the necessary
+ * objects.
+ *
+ * This function will assert:
+ * - The buffer is a properly formated Chip Data File and contains valid data.
+ * - An IsolationChip object has not already been created for the chip type
+ * associated with the given buffer.
+ *
+ * @param i_buffer First address of the Chip Data File buffer.
+ * @param i_bufferSize Size of the Chip Data File buffer.
+ * @param io_isoChips This map will contain all current IsolationChip objects
+ * for each of the user applications chip types.
+ */
+void parseChipDataFile(void* i_buffer, size_t i_bufferSize,
+ IsolationChipMap& io_isoChips);
+
+} // end namespace libhei