/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/fapi2/test/fapi2GetTargetTest.H $                     */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016                             */
/* [+] 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                                                     */
#include <fapi2/target.H>
#include <error_scope.H>

using namespace fapi2;

class Fapi2GetTargetTest : public CxxTest::TestSuite
{
    public:
        //******************************************************************************
        // test_fapi2GetTarget
        //******************************************************************************
        void test_fapi2GetTarget()
        {

            uint8_t    l_chipletNum = 0;
            uint32_t   l_huid = 0;

            do
            {
                // Get EX target of FAPI_POS (2)
                Target<fapi2::TARGET_TYPE_EX>  l_tTar;
                l_tTar = fapi2::getTarget<fapi2::TARGET_TYPE_EX>(2);

                // Verify the chiplet number
                l_chipletNum = l_tTar.getChipletNumber();
                FAPI_INF("test_fapi2GetTarget EX Fapi-pos: 2, Chiplet Num: %.8x",
                        l_chipletNum);
                if (l_chipletNum != 0x11)
                {
                    TS_FAIL("test_fapi2GetTarget: EX Wrong Chiplet Number!");
                    break;
                }

                // Verify HUID of EX
                const TARGETING::Target * l_platTarget =
                    static_cast<const TARGETING::Target*>(l_tTar.get());
                l_huid = TARGETING::get_huid(l_platTarget);
                FAPI_INF("test_fapi2GetTarget EX HUID: %.8x", l_huid);
                if (l_huid != 0x00060002)
                {
                    TS_FAIL("getTarget: EX HUID is Wrong");
                    break;
                }

                // get EX's parent and verify HUID of parent
                TARGETING::Target * l_tempTargetingParent =
                    static_cast<TARGETING::Target*>(
                            l_tTar.getParent<TARGET_TYPE_EQ>());

                l_huid = TARGETING::get_huid(l_tempTargetingParent);
                FAPI_INF("test_fapi2GetTarget EX Parent HUID: %.8x", l_huid);

                if (l_huid != 0x00230001)
                {
                    TS_FAIL("test_fapi2GetTarget: EX Wrong Parent HUID!");
                    break;
                }

                // get EX's children (cores) and verify their HUIDs
                uint32_t l_exp_huids[] = {0x00070004, 0x00070005};
                uint32_t i = 0;

                std::vector<Target<fapi2::TARGET_TYPE_CORE> > l_childCores;
                l_childCores =
                    l_tTar.getChildren<fapi2::TARGET_TYPE_CORE>(TARGET_STATE_PRESENT);
                FAPI_INF("test_fapi2GetTarget EX Number of cores: %.8x",
                        l_childCores.size());
                if ((l_childCores.size() < 1 ) ||
                        (l_childCores.size() > 2 ))
                {
                    TS_FAIL("test_fapi2GetTarget: EX Wrong number of children!");
                    break;
                }
                for (std::vector<Target<fapi2::TARGET_TYPE_CORE> >::iterator
                        l_it = l_childCores.begin();
                        l_it != l_childCores.end();
                        ++l_it, ++i)
                {
                    l_huid = TARGETING::get_huid(*l_it);
                    FAPI_INF("test_fapi2GetTarget EX Child HUID: %.8x", l_huid);

                    if (l_huid != l_exp_huids[i])
                    {
                        TS_FAIL("test_fapi2GetTarget: EX Wrong Child HUID!");
                        break;
                    }
                }
                FAPI_INF("test_fapi2GetTarget Test Complete.");

            }while(0);
        }


        //******************************************************************************
        // test_fapi2GetTarget_1
        //******************************************************************************
        void test_fapi2GetTarget_1()
        {
            // get the 0'th instance of the proc target
            uint8_t instance = 0;

            fapi2::TargetType type = fapi2::TARGET_TYPE_PROC_CHIP;

            fapi2::Target<TARGET_TYPE_ALL>* l_target =
                fapi2::getTarget<fapi2::TARGET_TYPE_ALL>(type,instance);

            TARGETING::Target * l_targTarg = l_target->get();

            // verify the instance number
            // verify the type

            TARGETING::ATTR_FAPI_POS_type pos =
                l_targTarg->getAttr<TARGETING::ATTR_FAPI_POS>();

            if( pos != instance )
            {
                TS_FAIL("position of proc did not match [%d!=%d]",
                        instance, pos);
            }

            TARGETING::ATTR_TYPE_type Ttype =
                l_targTarg->getAttr<TARGETING::ATTR_TYPE>();

            if( Ttype != TARGETING::TYPE_PROC )
            {
                TS_FAIL("Target type was not TYPE_PROC - we got 0x%x", Ttype);
            }

            //get the 3rd EX chiplet
            instance = 3;

            type = fapi2::TARGET_TYPE_EX;

            l_target = fapi2::getTarget<fapi2::TARGET_TYPE_ALL>(type,instance);

            l_targTarg = l_target->get();

            // verify the instance number
            // verify the type

            pos = l_targTarg->getAttr<TARGETING::ATTR_FAPI_POS>();

            if( pos != instance )
            {
                TS_FAIL("position of EX chiplet did not match [%d!=%d]",
                        instance, pos);
            }

            Ttype = l_targTarg->getAttr<TARGETING::ATTR_TYPE>();

            if( Ttype != TARGETING::TYPE_EX )
            {
                TS_FAIL("Target type was not TYPE_EX - we got 0x%x", Ttype);
            }

        }
};