Attention handler target service wrapper.

RTC: 43206
Change-Id: Ic7f80c518a1801dcd53d36df0dca4c0d88e77832
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/1352
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 355 insertions, 0 deletions

diff --git a/src/usr/diag/attn/attntarget.H b/src/usr/diag/attn/attntarget.H
new file mode 100644
index 000000000..344f02bb4
--- /dev/null
+++ b/src/usr/diag/attn/attntarget.H
@@ -0,0 +1,355 @@
+/*  IBM_PROLOG_BEGIN_TAG
+ *  This is an automatically generated prolog.
+ *
+ *  $Source: src/usr/diag/attn/attntarget.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_TAG
+ */
+#ifndef __ATTN_ATTNTARGET_H
+#define __ATTN_ATTNTARGET_H
+
+/**
+ * @file attntarget.H
+ *
+ * @brief HBATTN Target service wrapper class definitions.
+ */
+
+#include "attnfwd.H"
+#include <map>
+
+namespace ATTN
+{
+
+/**
+ * @brief TargetService Hold the installed target service implementation.
+ */
+class TargetService
+{
+    public:
+
+        /**
+         * @brief getMcsList Obtain the list of MCS unit targets
+         *           for the given proc chip target.
+         *
+         * @param[in] i_proc The proc chip target for which a
+         *              list of MCS unit targets should be obtained.
+         * @param[out] o_list The populated list of MCS unit targets.
+         */
+        void getMcsList(
+                TARGETING::TargetHandle_t i_proc,
+                TARGETING::TargetHandleList & o_list);
+
+        /**
+         * @brief getProc Find the requested membuf chip
+         *           target parent proc chip target.
+         *
+         * @param[in] i_membuf The membuf chip target
+         *             for which the parent proc chip target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated proc chip target.
+         * @retval[!0] Associated proc chip parent target.
+         */
+        TARGETING::TargetHandle_t getProc(
+                TARGETING::TargetHandle_t i_membuf);
+
+        /**
+         * @brief getMcs Find the requested membuf chip
+         *           target parent MCS unit target.
+         *
+         * @param[in] i_membuf The membuf chip target
+         *             for which the parent MCS unit target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated MCS unit target.
+         * @retval[!0] Associated MCS unit parent target.
+         */
+        TARGETING::TargetHandle_t getMcs(
+                TARGETING::TargetHandle_t i_membuf);
+
+        /**
+         * @brief getMcs Find the MCS unit target given
+         *           the proc chip parent target and MCS position.
+         *
+         * @param[in] i_proc The proc chip target for which the
+         *                MCS unit target should be found.
+         * @param[in] i_pos The MCS unit position for which the MCS
+         *                unit target should be found.
+         *
+         * @retval[0] Did not find any associated MCS unit target.
+         * @retval[!0] Associated MCS unit target.
+         */
+        TARGETING::TargetHandle_t getMcs(
+                TARGETING::TargetHandle_t i_proc,
+                uint64_t i_pos);
+
+        /**
+         * @brief getMcsPos Find the MCS unit position given
+         *           the MCS unit target.
+         *
+         * @param[in] i_mcs The MCS unit target for which the
+         *                MCS unit position should be found.
+         * @param[out] o_pos The MCS unit position.
+         */
+        void getMcsPos(
+                TARGETING::TargetHandle_t i_mcs,
+                uint64_t & o_pos);
+
+        /**
+         * @brief getMembuf Find the requested MCS unit target
+         *           child membuf chip target.
+         *
+         * @param[in] i_mcs The MCS unit target
+         *             for which the child membuf chip target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated membuf chip target.
+         * @retval[!0] Associated membuf chip target.
+         */
+        TARGETING::TargetHandle_t getMembuf(
+                TARGETING::TargetHandle_t i_mcs);
+
+        /**
+         * @brief getType Obtain the type of the provided target.
+         *
+         * @param[in] i_target The target for which the type
+         *                should be obtained.
+         *
+         * @return The type of the provided target.
+         */
+        TARGETING::TYPE getType(
+                TARGETING::TargetHandle_t i_target);
+
+        /**
+         * @brief setImpl Set the active target service implementation.
+         *
+         * @param[in] i_impl The target service implementation to make active.
+         */
+        void setImpl(TargetServiceImpl & i_impl);
+
+        /**
+         * @brief ctor
+         */
+        TargetService();
+
+    private:
+
+        /**
+         * @brief iv_impl The active targete service implementation.
+         */
+        TargetServiceImpl * iv_impl;
+
+        /**
+         * @brief copy Disabled.
+         */
+        TargetService(const TargetService &);
+
+        /**
+         * @brief assignment Disabled.
+         */
+        TargetService & operator=(const TargetService &);
+};
+
+/**
+ * @brief TargetServiceImpl Target Service
+ *           implementation interface requirement.
+ *
+ * Default implementation forwards calls to
+ * the real target service.
+ */
+class TargetServiceImpl
+{
+    public:
+
+        /**
+         * @brief getMcsList Obtain the list of MCS unit targets
+         *           for the given proc chip target.
+         *
+         * @param[in] i_proc The proc chip target for which a
+         *              list of MCS unit targets should be obtained.
+         * @param[out] o_list The populated list of MCS unit targets.
+         */
+        virtual void getMcsList(
+                TARGETING::TargetHandle_t i_proc,
+                TARGETING::TargetHandleList & o_list);
+
+       /**
+         * @brief getProc Find the requested membuf chip
+         *           target parent proc chip target.
+         *
+         * @param[in] i_membuf The membuf chip target
+         *             for which the parent proc chip target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated proc chip target.
+         * @retval[!0] Associated proc chip parent target.
+         */
+        virtual TARGETING::TargetHandle_t getProc(
+                TARGETING::TargetHandle_t i_membuf);
+
+        /**
+         * @brief getMcs Find the requested membuf chip
+         *           target parent MCS unit target.
+         *
+         * @param[in] i_membuf The membuf chip target
+         *             for which the parent MCS unit target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated MCS unit target.
+         * @retval[!0] Associated MCS unit parent target.
+         */
+        virtual TARGETING::TargetHandle_t getMcs(
+                TARGETING::TargetHandle_t i_membuf);
+
+        /**
+         * @brief getMcs Find the MCS unit target given
+         *           the proc chip parent target and MCS position.
+         *
+         * @param[in] i_proc The proc chip target for which the
+         *                MCS unit target should be found.
+         * @param[in] i_pos The MCS unit position for which the MCS
+         *                unit target should be found.
+         *
+         * @retval[0] Did not find any associated MCS unit target.
+         * @retval[!0] Associated MCS unit target.
+         */
+        virtual TARGETING::TargetHandle_t getMcs(
+                TARGETING::TargetHandle_t i_proc,
+                uint64_t i_pos);
+
+        /**
+         * @brief getMcsPos Find the MCS unit position given
+         *           the MCS unit target.
+         *
+         * @param[in] i_mcs The MCS unit target for which the
+         *                MCS unit position should be found.
+         * @param[out] o_pos The MCS unit position.
+         */
+        virtual void getMcsPos(
+                TARGETING::TargetHandle_t i_mcs,
+                uint64_t & o_pos);
+
+        /**
+         * @brief getMembuf Find the requested MCS unit target
+         *           child membuf chip target.
+         *
+         * @param[in] i_mcs The MCS unit target
+         *             for which the child membuf chip target
+         *             should be found.
+         *
+         * @retval[0] Did not find any associated membuf chip target.
+         * @retval[!0] Associated membuf chip target.
+         */
+        virtual TARGETING::TargetHandle_t getMembuf(
+                TARGETING::TargetHandle_t i_mcs);
+
+        /**
+         * @brief getType Obtain the type of the provided target.
+         *
+         * @param[in] i_target The target for which the type
+         *                should be obtained.
+         *
+         * @return The type of the provided target.
+         */
+        virtual TARGETING::TYPE getType(
+                TARGETING::TargetHandle_t i_target);
+
+        /**
+         * @brief installTargetService
+         *
+         * Make this the active target service implementation.
+         */
+        void installTargetService();
+
+        /**
+         * @brief dtor
+         */
+        virtual ~TargetServiceImpl() {}
+
+        /**
+         * @brief ctor
+         */
+        TargetServiceImpl();
+};
+
+inline void TargetService::getMcsList(
+        TARGETING::TargetHandle_t i_proc,
+        TARGETING::TargetHandleList & o_list)
+{
+    return iv_impl->getMcsList(i_proc, o_list);
+}
+
+inline TARGETING::TargetHandle_t TargetService::getProc(
+        TARGETING::TargetHandle_t i_membuf)
+{
+    return iv_impl->getProc(i_membuf);
+}
+
+inline TARGETING::TargetHandle_t TargetService::getMcs(
+        TARGETING::TargetHandle_t i_membuf)
+{
+    return iv_impl->getMcs(i_membuf);
+}
+
+inline TARGETING::TargetHandle_t TargetService::getMcs(
+        TARGETING::TargetHandle_t i_proc,
+        uint64_t i_pos)
+{
+    return iv_impl->getMcs(i_proc, i_pos);
+}
+
+inline void TargetService::getMcsPos(
+        TARGETING::TargetHandle_t i_mcs,
+        uint64_t & o_pos)
+{
+    iv_impl->getMcsPos(i_mcs, o_pos);
+}
+
+inline TARGETING::TargetHandle_t TargetService::getMembuf(
+        TARGETING::TargetHandle_t i_mcs)
+{
+    return iv_impl->getMembuf(i_mcs);
+}
+
+inline TARGETING::TYPE TargetService::getType(
+        TARGETING::TargetHandle_t i_target)
+{
+    return iv_impl->getType(i_target);
+}
+
+inline void TargetService::setImpl(TargetServiceImpl & i_impl)
+{
+    iv_impl = &i_impl;
+}
+
+inline TargetService::TargetService() :
+    iv_impl(&Singleton<TargetServiceImpl>::instance())
+{
+    // by default call the real target service
+}
+
+inline void TargetServiceImpl::installTargetService()
+{
+    getTargetService().setImpl(*this);
+}
+
+inline TargetServiceImpl::TargetServiceImpl() {}
+
+}
+#endif