PHAL: dump utility functions support
Added dump utility function to create and watch dump
progress for SBE type dumps.
Signed-off-by: Jayanth Othayoth <ojayanth@in.ibm.com>
Change-Id: Ieef2231340aab9ed09aa677dcabdcf4c3b066645
diff --git a/extensions/phal/dump_utils.hpp b/extensions/phal/dump_utils.hpp
new file mode 100644
index 0000000..91377f2
--- /dev/null
+++ b/extensions/phal/dump_utils.hpp
@@ -0,0 +1,35 @@
+#include <cstdint>
+
+#pragma once
+
+namespace openpower::phal::dump
+{
+
+constexpr auto SBE_DUMP_TIMEOUT = 4 * 60; // Timeout in seconds
+
+/** @brief Dump types supported by dump request */
+enum class DumpType
+{
+ SBE
+};
+
+/** @brief Structure for dump request parameters */
+struct DumpParameters
+{
+ uint32_t logId;
+ uint32_t unitId;
+ uint32_t timeout;
+ DumpType dumpType;
+};
+
+/**
+ * Request a dump from the dump manager
+ *
+ * Request a dump from the dump manager and register a monitor for observing
+ * the dump progress.
+ *
+ * @param dumpParameters Parameters for the dump request
+ */
+void requestDump(const DumpParameters& dumpParameters);
+
+} // namespace openpower::phal::dump