1 files changed, 195 insertions, 0 deletions
diff --git a/src/include/usr/hwpf/fapi/fapiTarget.H b/src/include/usr/hwpf/fapi/fapiTarget.H
new file mode 100644
index 000000000..af22137b9
--- /dev/null
+++ b/src/include/usr/hwpf/fapi/fapiTarget.H
@@ -0,0 +1,195 @@
+/**
+ *  @file fapiTarget.H
+ *
+ *  @brief Defines the Target class that is a generic target of a Hardware
+ *         Procedure operation.
+ */
+
+#ifndef FAPITARGET_H_
+#define FAPITARGET_H_
+
+#include <stdint.h>
+#include <stddef.h>
+
+namespace fapi
+{
+
+/**
+ * @brief Enumeration of target types values (bitmask values)
+ */
+enum TargetType
+{
+    TARGET_TYPE_NONE        = 0x00000000,
+    TARGET_TYPE_SYSTEM      = 0x00000001,
+    TARGET_TYPE_DIMM        = 0x00000002,
+    TARGET_TYPE_PROC_CHIP   = 0x00000004,
+    TARGET_TYPE_MEMBUF_CHIP = 0x00000008,
+    TARGET_TYPE_EX_CHIPLET  = 0x00000010,
+    TARGET_TYPE_MBA_CHIPLET = 0x00000020,
+    TARGET_TYPE_MBS_CHIPLET = 0x80000040,
+    TARGET_TYPE_MCS_CHIPLET = 0x80000080,
+};
+
+/**
+ * @brief Typedef used when passing multiple TargetType values
+ */
+typedef uint32_t TargetTypes_t;
+
+/**
+ * @class Target
+ *
+ * This class provides a generic Target of a Hardware Procedure Operation.
+ *
+ * A Target contains a void * pointer to a handle which is only meaningful to
+ * platform code.
+ *
+ * A Target object is copyable and assignable. Therefore, it cannot be
+ * subclassed.
+ *
+ * A Target object is not thread safe, multiple threads must not use the same
+ * Target object concurrently.
+ */
+class Target
+{
+public:
+
+    /**
+     * @brief Default constructor
+     */
+    Target();
+
+    /**
+     * @brief Constructor
+     *
+     * @param[in] i_type    Target type
+     * @param[in] i_pHandle Pointer to platform specific Target handle
+     */
+    Target(const TargetType i_type,
+           const void * i_pHandle);
+
+    /**
+     * @brief Copy Constructor
+     *
+     * @param[in] i_right Reference to Target to copy
+     */
+    Target(const Target & i_right);
+
+    /**
+     * @brief Destructor
+     */
+    ~Target();
+
+    /**
+     * @brief Assignment Operator.
+     *
+     * @param[in] i_right Reference to Target to assign from.
+     *
+     * @return Reference to 'this' Target
+     */
+    Target & operator=(const Target & i_right);
+
+    /**
+     * @brief Equality Comparison Operator
+     *
+     * @param[in] i_right Reference to Target to compare.
+     *
+     * @return bool. True if equal.
+     */
+    bool operator==(const Target & i_right) const;
+
+    /**
+     * @brief Inequality Comparison Operator
+     *
+     * @param[in] i_right Reference to Target to compare.
+     *
+     * @return bool. True if not equal.
+     */
+    bool operator!=(const Target & i_right) const;
+
+    /**
+     * @brief Get the handle pointer.
+     *
+     * The handle is only meaningful to platform code.
+     *
+     * @return Handle_t. The handle.
+     */
+    void * get() const;
+
+    /**
+     * @brief Set the handle. Platform using Handle_t as handle
+     *
+     * The handle is only meaningful to platform code.
+     *
+     * @param[in] i_pHandle Pointer to platform specific handle
+     */
+    void set(const void * i_pHandle);
+
+    /**
+     * @brief Get the target type
+     *
+     * @return The type of target represented by this target
+     */
+    TargetType getType() const;
+
+    /**
+     * @brief Set the target type
+     *
+     * @param[in] i_type The type of target represented by this target
+     */
+    void setType(const TargetType i_type);
+
+    /**
+     * @brief Convert a target to an ecmd-format target string
+     *
+     * @note Implemented by platform code
+     *
+     * @return A pointer to a c-string. If the object cannot be converted to a
+     *         valid ecmd string, a NULL pointer is returned.
+     *
+     * IMPORTANT: It is the caller's responsibility to free the returned string
+     * when done with it by calling "free(char*)".
+     */
+    const char * toString() const;
+
+private:
+
+    /**
+     * @brief Compare the handle
+     *
+     * @note Implemented by platform code because only platform code knows the
+     *       type pointed to by iv_pHandle to compare
+     *
+     * @param[in] i_right Reference to Target to compare handle to
+     *
+     * @return bool. True if the same
+     */
+    bool compareHandle(const Target & i_right) const;
+
+    /**
+     * @brief Copy the handle
+     *
+     * @note Implemented by platform code because only platform code knows the
+     *       type pointed to by iv_pHandle to copy
+     *
+     * @param[in] i_right Reference to Target to copy handle from
+     */
+    void copyHandle(const Target & i_right);
+
+    /**
+     * @brief Delete the handle
+     *
+     * @note Implemented by platform code because only platform code knows the
+     *       type to delete and if it should actually be deleted
+     */
+    void deleteHandle();
+
+    // Type of target
+    TargetType iv_type;
+
+    // Pointer to platform specific Target Handle
+    const void * iv_pHandle;
+};
+
+}
+
+#endif // FAPITARGET_H_