summaryrefslogtreecommitdiffstats
path: root/src/include/usr/fapi2/subroutine_executor.H
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/usr/fapi2/subroutine_executor.H')
-rw-r--r--src/include/usr/fapi2/subroutine_executor.H58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/include/usr/fapi2/subroutine_executor.H b/src/include/usr/fapi2/subroutine_executor.H
new file mode 100644
index 000000000..7d9acda1b
--- /dev/null
+++ b/src/include/usr/fapi2/subroutine_executor.H
@@ -0,0 +1,58 @@
+/* IBM_PROLOG_BEGIN_TAG */
+/* This is an automatically generated prolog. */
+/* */
+/* $Source: src/include/usr/fapi2/subroutine_executor.H $ */
+/* */
+/* OpenPOWER HostBoot Project */
+/* */
+/* Contributors Listed Below - COPYRIGHT 2016,2017 */
+/* [+] International Business Machines Corp. */
+/* */
+/* */
+/* Licensed under the Apache License, Version 2.0 (the "License"); */
+/* you may not use this file except in compliance with the License. */
+/* You may obtain a copy of the License at */
+/* */
+/* http://www.apache.org/licenses/LICENSE-2.0 */
+/* */
+/* Unless required by applicable law or agreed to in writing, software */
+/* distributed under the License is distributed on an "AS IS" BASIS, */
+/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
+/* implied. See the License for the specific language governing */
+/* permissions and limitations under the License. */
+/* */
+/* IBM_PROLOG_END_TAG */
+///
+/// @file subroutine_executor.H
+///
+/// @brief Defines the PLAT Subroutine Executor Macro.
+///
+/// The PLAT Subroutine Executor macro is called by
+/// FAPI_CALL_SUBROUTINE when a hardware procedure has
+/// a subroutine is needed, typicaly a chipop function.
+///
+/// Example implementation of plat code
+
+#ifndef SUBROUTINEEXECUTOR_H_
+#define SUBROUTINEEXECUTOR_H_
+
+#include <fapi2_subroutine_executor.H>
+
+#include <plat_trace.H>
+
+/**
+ * @brief Subroutine Executor macro example code - Platforms will need to
+ * implement as needed for their enviroment.
+ *
+ * This macro calls a PLAT macro which will do any platform specific work to
+ * execute the Subroutine (e.g. dlopening a shared library)
+ */
+#define FAPI_PLAT_CALL_SUBROUTINE(RC, FUNC, _args...) \
+ { \
+ FAPI_DBG("executing FAPI_PLAT_CALL_SUBROUTINE macro"); \
+ RC = FUNC(_args); \
+ }
+
+//@todo - RTC:179062 - Add real chipop support
+
+#endif
OpenPOWER on IntegriCloud