summaryrefslogtreecommitdiffstats
path: root/src/include/usr/targeting/common/pointer.H
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/usr/targeting/common/pointer.H')
-rw-r--r--src/include/usr/targeting/common/pointer.H85
1 files changed, 85 insertions, 0 deletions
diff --git a/src/include/usr/targeting/common/pointer.H b/src/include/usr/targeting/common/pointer.H
new file mode 100644
index 000000000..f5d919ab6
--- /dev/null
+++ b/src/include/usr/targeting/common/pointer.H
@@ -0,0 +1,85 @@
+// IBM_PROLOG_BEGIN_TAG
+// This is an automatically generated prolog.
+//
+// $Source: src/include/usr/targeting/common/pointer.H $
+//
+// IBM CONFIDENTIAL
+//
+// COPYRIGHT International Business Machines Corp. 2012
+//
+// p1
+//
+// Object Code Only (OCO) source materials
+// Licensed Internal Code Source Materials
+// IBM HostBoot Licensed Internal Code
+//
+// The source code for this program is not published or other-
+// wise divested of its trade secrets, irrespective of what has
+// been deposited with the U.S. Copyright Office.
+//
+// Origin: 30
+//
+// IBM_PROLOG_END
+
+#ifndef __TARGETING_COMMON_POINTER_H
+#define __TARGETING_COMMON_POINTER_H
+
+/**
+ * @file targeting/common/pointer.H
+ *
+ * @brief Pointer abstraction that allows Hostboot and FSP to use pointers in
+ * a common way, while maintaining binary compatibility
+ */
+
+#include <builtins.h>
+
+namespace TARGETING
+{
+
+/**
+ * @brief Type (union) which implements a common pointer type between Hostboot
+ * and FSP
+ */
+template<typename T>
+union AbstractPointer
+{
+ uint64_t raw; ///< Raw value of the container
+ struct
+ {
+ uint8_t doNotUse[sizeof(uint64_t)-sizeof(void*)]; ///< Do no use
+ T* ptr; ///< Pointer to instance of type T
+ };
+};
+
+/**
+ * @brief Macro which accepts an AbstractPointer<T> and returns a pointer
+ * customized to the platform
+ *
+ * @param[in] __PTR__
+ * AbstractPointer<T> containing the platform neutral pointer
+ *
+ * @return T* pointer customized to the platform
+ */
+#define TARG_TO_PLAT_PTR(__PTR__) \
+ ((__PTR__).ptr)
+
+/**
+ * @biref Macro which accepts an AbstractPointer<T>, customizes the pointer to
+ * the platform, then increments the pointer the specified number of times
+ * and returns it
+ *
+ * @param[in] __PTR__
+ * AbstractPointer<T> containing the platform neutral pointer
+ *
+ * @param[in] __NUM_INCS__
+ * Number of times to increment the platform specific pointer
+ *
+ * @return T* pointer customized to the platform, incremented the specified
+ * number of times
+ */
+#define TARG_TO_PLAT_PTR_AND_INC(__PTR__,__NUM_INCS__) \
+ ((__PTR__).ptr + __NUM_INCS__)
+
+} // End namespace Targeting
+
+#endif // __TARGETING_COMMON_POINTER_H
OpenPOWER on IntegriCloud