HWPF Error Info Support

Change-Id: Ib060599a4b64e768cbc75184a050e851c0a39c4e
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/250
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>
Reviewed-by: Nicholas E. Bofferding <bofferdn@us.ibm.com>

1 files changed, 36 insertions, 0 deletions

diff --git a/src/include/usr/hwpf/hwp/fapiTestHwpError.H b/src/include/usr/hwpf/hwp/fapiTestHwpError.H
new file mode 100644
index 000000000..5d7954e35
--- /dev/null
+++ b/src/include/usr/hwpf/hwp/fapiTestHwpError.H
@@ -0,0 +1,36 @@
+/**
+ *  @file fapiTestHwpError.H
+ *
+ *  @brief Defines a simple test Hardware Procedure that returns an error
+ */
+
+/*
+ * Change Log ******************************************************************
+ * Flag     Defect/Feature  User        Date        Description
+ * ------   --------------  ----------  ----------- ----------------------------
+ *                          mjjones     08/08/2011  Created.
+ *
+ */
+
+#ifndef FAPITESTHWPERROR_H_
+#define FAPITESTHWPERROR_H_
+
+#include <fapi.H>
+
+// HWPs are defined as C functions because platforms may wish to package them
+// in linux shared libraries which are DL-Opened
+extern "C"
+{
+
+/**
+ * @brief Simple HWP that returns an error (RC_TEST_ERROR_A)
+ *
+ * @param[in] i_target Reference to target (unused by HWP)
+ *
+ * @return ReturnCode
+ */
+fapi::ReturnCode hwpTestError(const fapi::Target & i_target);
+
+} // extern "C"
+
+#endif // FAPITESTHWPERROR_H_