path: root/src/usr/diag/prdf/test/prdfTest_WriteHomerFir.H

/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/test/prdfTest_WriteHomerFir.H $             */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
/* [+] 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                                                     */

#ifndef __TEST_PRDFWRITEHOMERFIR_H
#define __TEST_PRDFWRITEHOMERFIR_H

/**
 *  @file prdfTest_WriteHomerFir.H
 *
 *  @brief prdf testing writeHomerFirData()
 */

#ifdef __HOSTBOOT_MODULE
  #include <cxxtest/TestSuite.H>
  #include <errl/errlentry.H>
  #include <errl/errlmanager.H>
#else
  #include <cxxtest/TestSuite.h>
  #include <fsp/FipsGlobalFixture.H>
  #include <errlentry.H>
#endif

#include <prdfTrace.H>
#include <prdfMain.H>
#include "prdfsimMacros.H"
#include <homerData_common.h>
#include <prdfWriteHomerFirData.H>
#include <prdfParserEnums.H>

namespace PRDF
{

/* Helper struct for chip information inserted into HOMER data section after the
 * header. There is basically an array of these after the initial HOMER section
 * (HOMER_Data_t).  The register info then follows.
 */
typedef struct __attribute__((packed))
{
    HOMER_Chip_t  hChipType;  /* Nimbus, Centaur, EC Level, etc...*/

    union
    {
        HOMER_ChipNimbus_t   hChipN;
        HOMER_ChipAxone_t    hChipA;
    };

} HOMER_ChipInfo_t;

// these functions from prdfWriteHomerFirData.C are needed for the
// fakeWriteHomerFirData() function
errlHndl_t getHwConfig( std::vector<HOMER_ChipInfo_t> &io_chipInfVector,
                        const HwInitialized_t i_curHw );

errlHndl_t writeData( uint8_t * i_hBuf, size_t i_hBufSize,
                      const HwInitialized_t i_curHw,
                      std::vector<HOMER_ChipInfo_t> &i_chipVector,
                      HOMER_Data_t  &io_homerData );
};

class WriteHomerFir: public CxxTest::TestSuite
{
private:

    //faked getPnorInfo() function to accommodate unsupported getSectioninfo()
    void fakeGetPnorInfo( HOMER_Data_t & o_data )
    {
        o_data.pnorInfo.pnorOffset     = 0;
        o_data.pnorInfo.pnorSize       = 0;
        o_data.pnorInfo.mmioOffset     = 0;
        o_data.pnorInfo.norWorkarounds = 0;
    }

//------------------------------------------------------------------------------

    // faked writeHomerFirData() function since getSectionInfo() in
    // getPnorInfo() is unsupported during CxxTest cases
    errlHndl_t fakeWriteHomerFirData( uint8_t * i_hBuf, size_t i_hBufSize,
                                      const PRDF::HwInitialized_t i_curHw )
    {
        using namespace PRDF;

        errlHndl_t errl = NULL;

        do
        {
            HOMER_Data_t data = HOMER_getData(); // Initializes data

            // Get the PNOR information, faked function
            fakeGetPnorInfo( data );

            // Get the hardware configuration
            std::vector<HOMER_ChipInfo_t> l_chipInfVector;
            errl = getHwConfig( l_chipInfVector, i_curHw );
            if ( NULL != errl )
            {
                TS_FAIL("getHwConfig() failed");
                break;
            }

            // Write the HOMER data
            errl = writeData( i_hBuf, i_hBufSize, i_curHw,
                              l_chipInfVector, data );

            if ( NULL != errl )
            {
                TS_FAIL("writeData() failed");
                break;
            }

        } while (0);

        if ( NULL != errl )
        {
            errl->collectTrace( PRDF_COMP_NAME, 512 );
        }

        return errl;
    }

//------------------------------------------------------------------------------

    // check if data exists in HOMER when it should not
    void checkHomerData(HOMER_Data_t *d, const PRDF::HwInitialized_t i_curHw)
    {
        using namespace PRDF;

        const size_t sz_u32 = sizeof(uint32_t);
        const size_t sz_hd  = sizeof(HOMER_Data_t);

        if (MASTER_PROC_CORE == i_curHw || ALL_PROC_MASTER_CORE == i_curHw)
        {
            // Should have at least one processor chip
            if (0 == d->chipCount)
            {
                TS_FAIL("ERROR: ChipCount is zero in HOMER data");
            } // end if no chips
            else
            {
                uint8_t  *l_bytePtr = (reinterpret_cast<uint8_t *>(d)) + sz_hd;
                HOMER_Chip_t  *l_chipPtr = NULL;

              // The HOMER_Data_t struct may have an uneven size. Add some
              // padding to ensure the subsequent HOMER_Chip_t structs are
              // word aligned.
              const size_t padding = (sz_u32 - (sz_hd % sz_u32)) % sz_u32;
              l_bytePtr += padding;

                // Have a chip or more to look thru
                for ( uint32_t  l_chipNum=0;
                      (l_chipNum < d->chipCount); l_chipNum++ )
                {
                    l_chipPtr = reinterpret_cast<HOMER_Chip_t *>(l_bytePtr);
                    l_bytePtr += sizeof(HOMER_Chip_t);

                    /* 'Existing chiplet area' can vary in size  */
                    if (HOMER_CHIP_NIMBUS == l_chipPtr->chipType)
                    {
                        HOMER_ChipNimbus_t *l_nimPtr =
                              reinterpret_cast<HOMER_ChipNimbus_t *>(l_bytePtr);

                        // MCBIST
                        if (l_nimPtr->mcbistMask != 0)
                        {
                            TS_FAIL("ERROR: MCBIST should not be available. "
                                    "(MCBIST: 0x%x)", l_nimPtr->mcbistMask);
                            break;
                        }

                        // MCS
                        if (l_nimPtr->mcsMask != 0)
                        {
                            TS_FAIL("ERROR: MCS should not be available. "
                                    "(MCS: 0x%x)", l_nimPtr->mcsMask);
                            break;
                        }

                        // MCA
                        if (l_nimPtr->mcaMask != 0)
                        {
                            TS_FAIL("ERROR: MCA should not be available. "
                                    "(MCA: 0x%x)", l_nimPtr->mcaMask);
                            break;
                        }

                        // prepare for next chip (if any)
                        l_bytePtr += sizeof(HOMER_ChipNimbus_t);
                    }
                    else if (HOMER_CHIP_AXONE == l_chipPtr->chipType)
                    {
                        HOMER_ChipAxone_t *l_axPtr =
                             reinterpret_cast<HOMER_ChipAxone_t *>(l_bytePtr);

                        // MC
                        if (l_axPtr->mcMask != 0)
                        {
                            TS_FAIL("ERROR: MC should not be available. "
                                    "(MC: 0x%x)", l_axPtr->mcMask);
                            break;
                        }

                        // MI
                        if (l_axPtr->miMask != 0)
                        {
                            TS_FAIL("ERROR: MI should not be available. "
                                    "(MI: 0x%x)", l_axPtr->miMask);
                            break;
                        }

                        // MCC
                        if (l_axPtr->mccMask != 0)
                        {
                            TS_FAIL("ERROR: MCC should not be available. "
                                    "(MCC: 0x%x)", l_axPtr->mccMask);
                            break;
                        }

                        // OMIC
                        if (l_axPtr->omicMask != 0)
                        {
                            TS_FAIL("ERROR: OMIC should not be available. "
                                    "(OMIC: 0x%x)", l_axPtr->omicMask);
                            break;
                        }

                        // prepare for next chip (if any)
                        l_bytePtr += sizeof(HOMER_ChipAxone_t);
                    }
                    else if (HOMER_CHIP_EXPLORER == l_chipPtr->chipType)
                    {
                        TS_FAIL("ERROR: OCMB should not be available ");
                        break;
                    }

                } // end for loop thru chips

            } // end else we have a chip or 2

        } // end if proc related

    } // end function checkHomerData

//------------------------------------------------------------------------------

public:

    uint8_t hBuf[3072];

    // called at the beginning of each test
    void setUp()
    {
        memset(hBuf, 0x00, sizeof(hBuf));
    }

//------------------------------------------------------------------------------

    // test when the master processor and core are the configured hw
    void TestWriteHomerMasterProcCore(void)
    {
        using namespace PRDF;

        // FIRDATA not supported on Cumulus based systems. So do nothing.
        if ( TARGETING::MODEL_CUMULUS ==
             PlatServices::getChipModel(PlatServices::getMasterProc()) )
        {
            return;
        }

        TS_TRACE("- Write Homer Test 1 - Master Proc Core - Start -");

        errlHndl_t errl = fakeWriteHomerFirData(hBuf, sizeof(hBuf),
                                                MASTER_PROC_CORE);
        if (NULL != errl)
        {
            TS_FAIL("ERROR: writeHomerFirData failed.");
        }

        HOMER_Data_t * d = reinterpret_cast<HOMER_Data_t *>(hBuf);
        checkHomerData(d, MASTER_PROC_CORE);

        TS_TRACE("- Write Homer Test 1 - Master Proc Core - End-");
    }

//------------------------------------------------------------------------------

    // test when all processors and the master core are the configured hw
    void TestWriteHomerAllProcMasterCore(void)
    {
        using namespace PRDF;

        // FIRDATA not supported on Cumulus based systems. So do nothing.
        if ( TARGETING::MODEL_CUMULUS ==
             PlatServices::getChipModel(PlatServices::getMasterProc()) )
        {
            return;
        }

        TS_TRACE("- Write Homer Test 2 - All Proc Master Core - Start -");

        errlHndl_t errl = fakeWriteHomerFirData(hBuf, sizeof(hBuf),
                                                ALL_PROC_MASTER_CORE);
        if (NULL != errl)
        {
            TS_FAIL("ERROR: writeHomerFirData failed.");
        }

        HOMER_Data_t * d = reinterpret_cast<HOMER_Data_t *>(hBuf);
        checkHomerData(d, ALL_PROC_MASTER_CORE);

        TS_TRACE("- Write Homer Test 2 - All Proc Master Core - End-");

    }

//------------------------------------------------------------------------------

    // test when all processors, all memory, master core are the configured hw
    void TestWriteHomerAllProcMemMasterCore(void)
    {
        using namespace PRDF;

        // FIRDATA not supported on Cumulus based systems. So do nothing.
        if ( TARGETING::MODEL_CUMULUS ==
             PlatServices::getChipModel(PlatServices::getMasterProc()) )
        {
            return;
        }

        TS_TRACE("- Write Homer Test 3 - All Proc Mem Master Core - Start -");

        errlHndl_t errl = fakeWriteHomerFirData(hBuf, sizeof(hBuf),
                                                ALL_PROC_MEM_MASTER_CORE);
        if (NULL != errl)
        {
            TS_FAIL("ERROR: writeHomerFirData failed.");
        }

        HOMER_Data_t * d = reinterpret_cast<HOMER_Data_t *>(hBuf);
        checkHomerData(d, ALL_PROC_MEM_MASTER_CORE);

        TS_TRACE("- Write Homer Test 3 - All Proc Mem Master Core - End-");

    }

//------------------------------------------------------------------------------

    // test when all hardware is configured
    void TestWriteHomerAllHardware(void)
    {
        using namespace PRDF;

        // FIRDATA not supported on Cumulus based systems. So do nothing.
        if ( TARGETING::MODEL_CUMULUS ==
             PlatServices::getChipModel(PlatServices::getMasterProc()) )
        {
            return;
        }

        TS_TRACE("- Write Homer Test 4 - All Hardware - Start -");

        errlHndl_t errl = fakeWriteHomerFirData(hBuf, sizeof(hBuf),
                                                ALL_HARDWARE);
        if (NULL != errl)
        {
            TS_FAIL("ERROR: writeHomerFirData failed.");
        }

        HOMER_Data_t * d = reinterpret_cast<HOMER_Data_t *>(hBuf);
        checkHomerData(d, ALL_HARDWARE);

        TS_TRACE("- Write Homer Test 4 - All Hardware - End-");

    }

//------------------------------------------------------------------------------

};
#endif