path: root/src/usr/hwpf/hwp/fapiHwpExecInitFile.C

/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/hwp/fapiHwpExecInitFile.C,v $                      */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2011,2014                        */
/* [+] 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                                                     */
/**
 *  @file fapiHwpExecInitFile.C
 *
 *  @brief Implements a Hardware Procedure to execute an initfile.
 */
// $Id: fapiHwpExecInitFile.C,v 1.22 2014/08/05 15:04:40 kahnevan Exp $
/*
 * Change Log ******************************************************************
 * Flag     Defect/Feature  User        Date        Description
 * ------   --------------  ----------  ----------- ----------------------------
 *                          camvanng    09/29/2011  Created.
 *                          andrewg     11/09/2011  Multi-dimension array support
 *                          camvanng    11/16/2011  Support endianness &
 *                                                  32-bit platforms.  Support
 *                                                  system & target attributes.
 *                          camvanng    12/06/2011  Optimize code to check for
 *                                                  endianness at compile time
 *                          camvanng    01/06/2012  Support for writing an
 *                                                  attribute to a SCOM register
 *                          mjjones     01/13/2012  Use new ReturnCode interfaces
 *                          camvanng    01/20/2012  Support for using a range
 *                                                  indexes for array attributes
 *                          mjjones     02/21/2012  Use new Target toEcmdString
 *                          camvanng    04/12/2012  Right justify SCOM data
 *                          camvanng    04/30/2012  Optimization - Minimize scom
 *                                                  operations by combining
 *                                                  PutScomUnderMask ops to same
 *                                                  Scom register
 *                                                  Turn off most debug traces
 *                          camvanng    05/07/2012  Support for associated target
 *                                                  attributes
 *                          camvanng    05/22/2012  Ability to do simple operations
 *                                                  on attributes in the scom
 *                                                  data column
 *          SW146714        camvanng    06/08/2012  Use two bytes to store row
 *                                                  rpn sequence byte count
 *                          camvanng    06/15/2012  Ability to do bitwise OR and AND operations
 *                          camvanng    06/27/2012  Fix bug in targetId
 *                          camvanng    09/07/2012  Optimization - do PutScom vs PutScomUnderMask
 *                                                  if the combined bit mask enables all 64 bits
 *                          camvanng    12/15/2012  For PutScomUnderMask ops, grab only valid bits
 *                                                  of the data when the data length is greater
 *                                                  then number of bits specified.
 *          SW187788        mww         02/27/2013  Add minimal succinct trace
 *          SW195717        mww         04/22/2013  Add function to dump ffdc
 *                                                  and trace.
 *          SW251791        muqahmed    03/14/2014  Fixed compile warning
 */

#include <fapiHwpExecInitFile.H>
#include <fapiUtil.H>
#include <fapiAttributeService.H>
#include <string.h>
#include <vector>
#include <endian.h>
#include <stdlib.h>

#include <string.h>

extern "C"
{

#ifndef SUPPRESS_UNUSED_VARIABLE
#define SUPPRESS_UNUSED_VARIABLE(...)
#endif

//  --------------------------------------------------------------------
//  enable minimal debug.  This will trace:
//      Attr table, literal table, scoms, rows, and expressions being processed.
//  Unfortunately this still adds a lot of trace, turn off before checking in.
//  --------------------------------------------------------------------
// #define HWPEXECINITFILE_DEBUG
#ifdef  HWPEXECINITFILE_DEBUG
#define IF_DBG(_fmt_, _args_...) FAPI_IMP(_fmt_, ##_args_)
#else
#define IF_DBG(_fmt_, _args_...) SUPPRESS_UNUSED_VARIABLE(NULL, ##_args_)
#endif

//  --------------------------------------------------------------------
//  enable malloc debug.  This will trace:
//      malloc/new/free/delete 's
//  Turn off before checking in.
//  --------------------------------------------------------------------
// #define HWPEXECINITFILE_MALLOC_DEBUG
#ifdef  HWPEXECINITFILE_MALLOC_DEBUG
#define IF_MDBG(_fmt_, _args_...) FAPI_IMP(_fmt_, ##_args_)
#else
#define IF_MDBG(_fmt_, _args_...) SUPPRESS_UNUSED_VARIABLE(NULL, ##_args_)
#endif

//  --------------------------------------------------------------------
//  enable attribute debug.  This will trace getAttr's
//  Make sure this is off before checking in.
//  --------------------------------------------------------------------
// #define HWPEXECINITFILE_ATTR_DEBUG
#ifdef  HWPEXECINITFILE_ATTR_DEBUG
#define IF_ADBG(_fmt_, _args_...) FAPI_IMP(_fmt_, ##_args_)
#else
#define IF_ADBG(_fmt_, _args_...) SUPPRESS_UNUSED_VARIABLE(NULL, ##_args_)
#endif

//  --------------------------------------------------------------------
//  enable ridiculous amounts of debug.  This will slow execution down by ~50%
//  Make sure this is off before checking in
//  --------------------------------------------------------------------
// #define HWPEXECINITFILE_DEBUG2
#ifdef HWPEXECINITFILE_DEBUG2
#define IF_DBG2(_fmt_, _args_...) FAPI_INF(_fmt_, ##_args_)
#else
#define IF_DBG2(_fmt_, _args_...) SUPPRESS_UNUSED_VARIABLE(NULL, ##_args_)
#endif

//******************************************************************************
// Enumerations
//******************************************************************************

//Flag indicating ANY operand
enum IfAnyFlags
{
    IF_NOT_ANY = 0,
    IF_ANY = 1,
    IF_ONE_SIDED_ANY = 2
};

//Special variables & literals
enum IfSpecialIds
{
    IF_VAL_ANY = 0x4000,
    IF_EXPR    = 0x8000
};

/**
* Offsets of certain elements in the initfile.
*/
enum IfHeader
{
    // Initfile Header
    //-----------------
    IF_VERSION_LOC            = 0,
    IF_CVS_VERSION_LOC        = 4,
    IF_ATTR_TABLE_OFFSET_LOC   = 12,
    IF_LIT_TABLE_OFFSET_LOC   = 16,
    IF_SCOM_SECTION_OFFSET_LOC= 20,
    IF_SCOM_NUM_LOC           = 24,

    IF_VERSION_SIZE            = 4,
    IF_CVS_VERSION_SIZE        = 8,

    IF_ATTR_TABLE_OFFSET_SIZE   = 4,
    IF_LIT_TABLE_OFFSET_SIZE   = 4,
    IF_SCOM_SECTION_OFFSET_SIZE= 4,
    IF_SCOM_NUM_SIZE           = 4,

    // Supported Syntax Version
    IF_SYNTAX_VERSION          = 1,
};

//******************************************************************************
// typedefs and structs
//******************************************************************************

//RPN stack
typedef std::vector<uint64_t> rpnStack_t;

//InitFile address, size and current offset
typedef struct ifInfo
{
    const char * addr;
    size_t size;
    size_t offset;
}ifInfo_t;

//Attribute Symbol Table entry
typedef struct attrTableEntry
{
    uint8_t  type;
    uint32_t attrId;
}attrTableEntry_t;

//Scom Section Data entry
typedef struct scomData
{
    uint16_t   len;
    uint16_t   offset;
    uint16_t   addrId;  //numeric literal
    uint16_t   numCols;
    uint16_t   numRows;
    char **    data;    //scom data to write
    bool       hasExpr; //has "expr" column
    char *     colId;   //an attribute plus its target#
    char **    rowData;
}scomData_t;

//Init File Data
typedef struct ifData
{
    const std::vector<fapi::Target> * pTarget;
    uint16_t                 numAttrs;
    uint16_t                 numLits;
    uint32_t                 numScoms;
    attrTableEntry_t *       attrs;
    uint64_t *               numericLits;
    scomData_t **            scoms;
    rpnStack_t *             rpnStack;
}ifData_t;

// The scom to write
typedef struct scomToWrite
{
    uint16_t scomNum;  //the scom entry number
    uint16_t row;      //the row within the scom entry
}scomToWrite_t;

//A list of the scoms to write
typedef std::vector<scomToWrite_t> scomList_t;


//  ------------------------------------------------------------------------
//  @class  InitFileStats
//  collect statistics to dump if we hit an error.
//  ------------------------------------------------------------------------
class   InitFileStats
{

public:
    /**
     * @brief Constructor
     *
     *  @param  pointer to init file name
     *  @param  init file version
     *  @param  pointer to initfile image
     *  @param  initfile image size
     *
     */
    InitFileStats(  const char  *i_initfile,
                    uint32_t    i_version,
                    const char  *i_addr,
                    size_t      i_size )
        :   iv_ok(true),
            iv_pAttrSymbolTableAddr( NULL ),
            iv_attrSymbolTableSize( 0 ),

            iv_pLitSymbolTableAddr( NULL ),
            iv_litSymbolTableSize( 0 ),

            iv_pScomSectionAddr( NULL ),
            iv_scomSectionSize( 0 ),

            iv_column( 0 ),
            iv_row( 0 ),
            iv_pStack( NULL )
    {
        iv_pInitFileName    =   i_initfile;
        iv_initFileVersion  =   i_version;

        iv_pInitFileAddr    =   i_addr;
        iv_initFileSize     =   i_size;
    }

    /**
     * @brief Destructor
     */
    ~InitFileStats()
    {
    }

    /**
     *  @brief  save address and size of attr table for dumping if necessary
     *
     *  @param  i_addr  address of attr table
     *  @param  i_size  number of attributes in table
     *
     *  @return none.
    */
    void attrSymbolTable(   attrTableEntry  *i_addr,
                            const uint16_t  i_size )
    {
        iv_pAttrSymbolTableAddr =   i_addr;
        iv_attrSymbolTableSize  =   i_size;
    }

    /**
     *  @brief  save address and size of lit table for dumping if necessary
     *
     *  @param  i_addr  address of lit table
     *  @param  i_size  number of literals in table
     *
     *  @return none.
    */
    void litSymbolTable(    uint64_t         *i_addr,
                            const int16_t    i_size )
    {
        iv_pLitSymbolTableAddr  =   i_addr;
        iv_litSymbolTableSize   =   i_size;
    }

    /**
     *  @brief  save address and size of scom section for dumping if necessary
     *
     *  @param  i_addr  address of scom section
     *  @param  i_size  number of scoms in table
     *
     *  @return none.
    */
    void scomSection(   scomData_t  **i_addr,
                        uint32_t    i_size )
    {
        iv_pScomSectionAddr =   i_addr;
        iv_scomSectionSize  =   i_size;
    }

    /**
     *  @brief save current Targets for dumping if necessary
     *
     *  @param  i_pTargets    pointer to target list.
     *
     *  @return none.
     */
    void    saveTargets(const std::vector<fapi::Target> * i_pTargets   )
    {

        iv_pTargets   =   i_pTargets;
    }


    /**
     *  @brief save current Stack for dumping if necessary
     *
    *  @param  i_pStack    pointer to rpnStack.
     *
     *  @return none.
    */
    void    saveStack(  rpnStack_t      *i_pStack   )
    {

        iv_pStack   =   i_pStack;
    }

    /**
     *  @brief save current column for dumping if necessary
     *
    *  @param  i_col    column we're working on
     *
     *  @return none.
    */
    void    saveCol(    uint32_t        i_col   )
    {

        iv_column   =   i_col;
    }

    /**
     *  @brief save current row for dumping if necessary
     *
    *  @param  i_row       row we're working on
     *
     *  @return none.
    */
    void    saveRow(    uint32_t        i_row  )
    {
        iv_row  =   i_row;
    }

    /**
     *  @brief  save current scom data for dumping if necessary
     *
     *  @param  i_scomData  scomData we are working on
     *
     *  @return none.
    */
    void    saveScom(   const scomData_t  *i_scomData )
    {

        iv_scomData         =   *i_scomData;
    }

    /**
     *  @brief  dump saved values, and records that an error has ocurred.
     *
     *  @return none
     *          sets iv_ok to false.
     */
    void    dump( );

    /**
     *  @brief  return ffdc information
     *          Fills in FFDC values for a fapi Returncode.
     *
     *  @param  ref to fapi rc to fill in
     *
     *  @return none
     *          filled in fapi RC
     */
    void    generateError( fapi::ReturnCode &o_fapiRc );


    /**
     *  Return whether dump() was called somewhere so we can log the error.
     *
     *  @return true or false, depending on whether dump() was called.
    */
    bool    ok()
    {
        return  iv_ok;
    }

private:
    /**
     *  Disable copy constructor and assignment operator
     */
    InitFileStats(const InitFileStats& i_right);
    InitFileStats& operator=(const InitFileStats& i_right);

    bool            iv_ok;
    const char      *iv_pInitFileName;
    uint32_t        iv_initFileVersion;
    const char      *iv_pInitFileAddr;
    size_t          iv_initFileSize;

    attrTableEntry  *iv_pAttrSymbolTableAddr;
    uint16_t        iv_attrSymbolTableSize;

    uint64_t        *iv_pLitSymbolTableAddr;
    uint16_t        iv_litSymbolTableSize;

    scomData_t      **iv_pScomSectionAddr;
    uint32_t        iv_scomSectionSize;

    const std::vector<fapi::Target> * iv_pTargets;

    uint32_t        iv_column;
    uint32_t        iv_row;
    scomData_t      iv_scomData;
    rpnStack_t      *iv_pStack;

};  // end class    InitFileStats



//******************************************************************************
// Forward Declarations
//******************************************************************************
void ifSeek(ifInfo_t & io_ifInfo, size_t i_offset);

void ifRead(ifInfo_t & io_ifInfo, void * o_data, uint32_t i_size,
            bool i_swap = true);

void loadAttrSymbolTable(ifInfo_t & io_ifInfo,ifData_t & io_ifData );

void  unloadAttrSymbolTable(ifData_t & io_ifData);

fapi::ReturnCode getAttr(const ifData_t & i_ifData,
                 const uint16_t i_id,
                 uint64_t & o_val,
                 const uint32_t i_targetNum,
                 const uint16_t i_arrayIndex[MAX_ATTRIBUTE_ARRAY_DIMENSION],
                 InitFileStats  &i_stats );

void loadLitSymbolTable(ifInfo_t & io_ifInfo, ifData_t & io_ifData );

void unloadLitSymbolTable(ifData_t & io_ifData);

fapi::ReturnCode getLit(const ifData_t & i_ifData,
                        const uint16_t i_id,
                        uint64_t & o_val,
                        InitFileStats   &i_stats );

void loadScomSection(ifInfo_t & io_ifInfo, ifData_t & io_ifData );

void unloadScomSection(ifData_t & io_ifData);

fapi::ReturnCode executeScoms(ifData_t & io_ifData,
                              InitFileStats &i_stats );

fapi::ReturnCode writeScom(ifData_t & i_ifData,
                           const scomList_t & i_scomList,
                           InitFileStats    &i_stats );

fapi::ReturnCode getAttrArrayDimension(const ifData_t & i_ifData,
                                       const uint16_t i_id,
                                       uint8_t & o_attrDimension);

void rpnPush(rpnStack_t * io_rpnStack,
             uint64_t i_val );

uint64_t rpnPop(rpnStack_t * io_rpnStack,
                InitFileStats   &i_stats   );

void rpnDumpStack(rpnStack_t * i_rpnStack);

uint64_t rpnUnaryOp(IfRpnOp i_op,
                    uint64_t i_val,
                    uint32_t i_any,
                    InitFileStats   &i_stats   );

uint64_t rpnBinaryOp(IfRpnOp i_op,
                     uint64_t i_val1,
                     uint64_t i_val2,
                     uint32_t i_any,
                     InitFileStats  &i_stats   );

fapi::ReturnCode rpnDoPush(ifData_t & io_ifData,
                const uint16_t i_id,
                uint32_t & io_any,
                const uint32_t i_targetNum,
                const uint16_t i_arrayIndex[MAX_ATTRIBUTE_ARRAY_DIMENSION],
                           InitFileStats    &i_stats   );

fapi::ReturnCode rpnDoOp(rpnStack_t * io_rpnStack,
                         IfRpnOp i_op,
                         uint32_t i_any,
                         InitFileStats  &i_stats   );

fapi::ReturnCode evalRpn(ifData_t & i_ifData,
                         char * i_expr,
                         uint32_t i_len,
                         bool i_isColExpr,
                         bool i_hasExpr,
                         InitFileStats  &i_stats   );

//
void    InitFileStats::dump()
{
        iv_ok   =   false;

        FAPI_IMP( "dump stats: initfile %s version %u, addr=%p, size = %zu",
                  iv_pInitFileName,
                  iv_initFileVersion,
                  iv_pInitFileAddr,
                  iv_initFileSize );
        FAPI_IMP( "dump stats: attribute symbol table addr=%p, num attrs= %u",
                  iv_pAttrSymbolTableAddr,
                  iv_attrSymbolTableSize );
        for ( int i=0; i<iv_attrSymbolTableSize; i++ )
        {
            FAPI_IMP( "    %.4d    0x%x    0x%08x",
                i,
                iv_pAttrSymbolTableAddr[i].type,
                iv_pAttrSymbolTableAddr[i].attrId );
        }
        FAPI_IMP( "dump stats: literal symbol table addr=%p, num lits = %u",
                  iv_pLitSymbolTableAddr,
                  iv_litSymbolTableSize );
        for ( int i=0; i<iv_litSymbolTableSize; i++ )
        {
            FAPI_IMP( "    0xX%03x    0x%08llx",
                i+1,
                iv_pLitSymbolTableAddr[i] );
        }
        FAPI_IMP( "dump stats: scomSection addr=%p, num scoms = %u",
                  iv_pScomSectionAddr,
                  iv_scomSectionSize );
        FAPI_IMP( "dump stats: current column is 0x%x", iv_column );
        FAPI_IMP( "dump stats: current row is 0x%x", iv_row );

        FAPI_IMP( "dump stats: iv_scomData.len      is 0x%x",
                  iv_scomData.len    );
        FAPI_IMP( "dump stats: iv_scomData.offset   is 0x%x",
                  iv_scomData.offset );
        FAPI_IMP( "dump stats: iv_scomData.addrId   is 0x%x",
                  iv_scomData.addrId );
        FAPI_IMP( "dump stats: iv_scomData.numCols  is 0x%x",
                  iv_scomData.numCols);
        FAPI_IMP( "dump stats: iv_scomData.numRows  is 0x%x",
                  iv_scomData.numRows);
        FAPI_IMP( "dump stats: iv_scomData.data     addr is %p",
                  iv_scomData.data   );
        FAPI_IMP( "dump stats: iv_scomData.hasExpr  is 0x%x",
                  iv_scomData.hasExpr);
        FAPI_IMP( "dump stats: iv_scomData.colId    addr is %p",
                  iv_scomData.colId  );
        FAPI_IMP( "dump stats: iv_scomData.rowData  addr is %p",
                  iv_scomData.rowData);

        rpnDumpStack( iv_pStack );
}


//
void    InitFileStats::generateError( fapi::ReturnCode &o_fapiRc )
{
    //  fill in ffdc info
    uint16_t    &FFDC_SCOM_ADDRID   =   iv_scomData.addrId;
    uint16_t    &FFDC_SCOM_OFFSET   =   iv_scomData.offset;
    uint16_t    &FFDC_SCOM_LEN      =   iv_scomData.len;
    uint32_t    &FFDC_COLUMN        =   iv_column;
    uint32_t    &FFDC_ROW           =   iv_row;

    FAPI_SET_HWP_ERROR( o_fapiRc, RC_INITFILE_EXECUTION_ERROR );

}


//******************************************************************************
// fapiHwpExecInitFile function
//******************************************************************************

/**  @brief Execute the initfile
 *
 * This HWP can be called to execute a binary initfile.
 *
 * @param[in] i_target  Reference to std::vector<fapi::Target>
 * @param[in] i_file    The binary if filename: <initfile>.if
 *
 * @return ReturnCode. Zero on success.
 */
fapi::ReturnCode fapiHwpExecInitFile(const std::vector<fapi::Target> & i_target,
                                     const char * i_file)
{
    FAPI_INF(">> fapiHwpExecInitFile: Performing HWP for %s", i_file);

    // Print the ecmd string of the targets
    FAPI_IMP( "fapiHwpExecInitFile: SCOM target: %s",
              i_target.front().toEcmdString());
    for (size_t i = 1; i < i_target.size(); i++)
    {
        FAPI_IMP( "fapiHwpExecInitFile: Associated target: %s",
                  i_target.at(i).toEcmdString());
    }

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;
    fapi::ReturnCode l_tmpRc = fapi::FAPI_RC_SUCCESS;
    size_t l_ifSize = 0;
    const char * l_ifAddr = NULL;


    // Load the binary initfile
    l_rc = fapiLoadInitFile(i_target.front(), i_file, l_ifAddr, l_ifSize);

    if (l_rc.ok())
    {
        FAPI_IMP( "fapiHwpExecInitFile: initfile addr = %p, size = %zu",
                  l_ifAddr,
                  l_ifSize );

        //Save the data
        ifInfo_t l_ifInfo;
        memset(&l_ifInfo, 0, sizeof(ifInfo_t));
        l_ifInfo.addr = l_ifAddr;
        l_ifInfo.size = l_ifSize;
        l_ifInfo.offset = IF_VERSION_LOC;

        //Check endianness
        #ifdef __BYTE_ORDER
            #if (__BYTE_ORDER == __BIG_ENDIAN)
                FAPI_INF("fapiHwpExecInitFile: big endian mode");
            #elif (__BYTE_ORDER == __LITTLE_ENDIAN)
                FAPI_INF("fapiHwpExecInitFile: little endian mode");
            #else
            #error "Unknown byte order"
            #endif
        #else
        #error "Byte order not defined"
        #endif

        //Check the version
        uint32_t l_version;
        ifRead(l_ifInfo, reinterpret_cast<void*>(&l_version), IF_VERSION_SIZE);

        if (IF_SYNTAX_VERSION != l_version)
        {
            FAPI_ERR( "fapiHwpExecInitFile: %s Syntax version %u"
                      "Expected version %u",
                      i_file,
                      l_version,
                      IF_SYNTAX_VERSION );

            uint32_t & FFDC_IF_VER = l_version; // GENERIC IDENTIFIER
            FAPI_SET_HWP_ERROR(l_rc, RC_INITFILE_INCORRECT_VER);

            // Unload the initfile, disregard this rc
            l_tmpRc = fapiUnloadInitFile(i_file, l_ifAddr, l_ifSize);
            if (!l_tmpRc.ok())
            {
                //Log error
                fapiLogError(l_tmpRc);
            }
        }
        else
        {
            char l_cvsVersion[IF_CVS_VERSION_SIZE];
            ifRead( l_ifInfo, reinterpret_cast<void*>(&l_cvsVersion),
                    IF_CVS_VERSION_SIZE,
                    false );

            FAPI_IMP("fapiHwpExecInitFile: %s Syntax version %u CVS version %s",
                     i_file,
                     l_version,
                     l_cvsVersion );

            //  create a stats object to collect initfile statistics -
            //  this will be used if things break.
            InitFileStats   l_stats( i_file, l_version, l_ifAddr, l_ifSize );

            ifData_t l_ifData;
            memset(&l_ifData, 0, sizeof(ifData_t));

            //--------------------------------
            // Load the Attribute Symbol Table
            //--------------------------------
            loadAttrSymbolTable(l_ifInfo, l_ifData  );
            FAPI_IMP( "fapiHwpExecInitFile: Addr of attribute symbol table %p, "
                    "num attrs %u",
                    l_ifData.attrs,
                    l_ifData.numAttrs );
            l_stats.attrSymbolTable(
                l_ifData.attrs,
                l_ifData.numAttrs );

            //--------------------------------
            // Load the Literal Symbol Table
            //--------------------------------
            loadLitSymbolTable(l_ifInfo, l_ifData );
            FAPI_IMP( "fapiHwpExecInitFile: Addr of literal symbol table %p, "
                    "num lits %u",
                    l_ifData.numericLits,
                    l_ifData.numLits );
            l_stats.litSymbolTable(
                l_ifData.numericLits,
                l_ifData.numLits );

            //--------------------------------
            // Load the SCOM Section
            //--------------------------------
            loadScomSection(l_ifInfo, l_ifData );
            FAPI_IMP( "fapiHwpExecInitFile: Addr of scom section %p, "
                    "num scoms %u",
                    l_ifData.scoms,
                    l_ifData.numScoms );
            l_stats.scomSection(
                l_ifData.scoms,
                l_ifData.numScoms );

            //--------------------------------
            // Execute SCOMs
            //--------------------------------
            l_ifData.pTarget = &i_target;

            l_rc = executeScoms(l_ifData, l_stats );


            //--------------------------------
            // Unload
            //--------------------------------

            // Unload the Attribute Symbol Table
            unloadAttrSymbolTable(l_ifData);

            // Unload the Literal Symbol Table
            unloadLitSymbolTable(l_ifData);

            // Unload the Scom Section
            unloadScomSection(l_ifData);
        }

        // Unload the initfile
        l_tmpRc = fapiUnloadInitFile(i_file, l_ifAddr, l_ifSize);

        // return code from executeScoms takes precedence
        if (l_rc.ok())
        {
            l_rc = l_tmpRc;
        }
        else if (!l_tmpRc.ok())
        {
            //Log error
            fapiLogError(l_tmpRc);
        }
    }

    FAPI_INF("<< fapiHwpExecInitFile: Performing HWP for %s", i_file);
    return l_rc;
}


//******************************************************************************
// Helper functions to read initfiles
//******************************************************************************

/**  @brief Seek to the specified offset in the binary initfile
 *
 * Seeks from the start of the file to the position passed in.
 *
 * @param[in,out] io_ifInfo   Reference to ifInfo_t which contains addr, size,
 *                            and current offset of the initfile
 * @param[in]     i_offset    Position to seek to.
 */
void ifSeek(ifInfo_t & io_ifInfo, size_t i_offset)
{
    if (i_offset > io_ifInfo.size)
    {
        FAPI_ERR("fapiHwpExecInitFile: ifSeek: offset out of range 0x%zX",
                 i_offset );
        fapiAssert(false);
    }

    //Advance the offset
    io_ifInfo.offset = i_offset;
}

/**  @brief Reads the initfile
 *
 * Reads the binary initfile at the current offset.
 *
 * @param[in,out] io_ifInfo   Reference to ifInfo_t which contains addr, size,
 *                            and current offset of the initfile
 * @param[out] o_data         Ptr to buffer where data read will be stored
 * @param[in] i_size          number of bytes to read
 * @param[in] i_swap          If true, will swap bytes to account for endianness if needed.
 */
void ifRead(ifInfo_t & io_ifInfo, void * o_data, uint32_t i_size, bool i_swap)
{
    if ((true == i_swap) &&
        !((1 == i_size) || (2 == i_size) || (4 == i_size) || (8 == i_size)))
    {
        FAPI_ERR("fapiHwpExecInitFile: ifRead: invalid number of bytes %d",
                 i_size );
        fapiAssert(false);
    }

    if ((io_ifInfo.offset + i_size) > io_ifInfo.size)
    {
        FAPI_ERR( "fapiHwpExecInitFile: ifRead: offset 0x%zX + size 0x%X "
                  "out of range",
                  io_ifInfo.offset,
                  i_size );
        fapiAssert(false);
    }

    //Copy the data
    #if (__BYTE_ORDER == __LITTLE_ENDIAN)
    if ((1 < i_size) && (true == i_swap))
    {
        //Account for endianness
        const char * l_pSrc = io_ifInfo.addr + io_ifInfo.offset + i_size - 1;
        char * l_pDst = static_cast<char *>(o_data);
        do
        {
            *l_pDst = *l_pSrc;
            l_pSrc--;
            l_pDst++;
        } while (l_pSrc >= io_ifInfo.addr + io_ifInfo.offset);
    }
    else
    {
        memcpy(o_data, io_ifInfo.addr + io_ifInfo.offset, i_size);
    }
    #else
    memcpy(o_data, io_ifInfo.addr + io_ifInfo.offset, i_size);
    #endif

    //Advance the offset
    io_ifInfo.offset += i_size;
}

//******************************************************************************
// Helper functions for Attributes
//******************************************************************************

/**  @brief Loads the Attribute Symbol Table
 *
 * Loads the Attribute Symbol Table from the binary initfile.
 *
 * @param[in,out] io_ifInfo   Reference to ifInfo_t which contains addr, size,
 *                            and current offset of the initfile
 * @param[in,out] io_ifData   Reference to ifData_t which contains initfile data
 */
void loadAttrSymbolTable(ifInfo_t & io_ifInfo,
                         ifData_t & io_ifData  )
{
    IF_DBG( ">> fapiHwpExecInitFile: loadAttrSymbolTable" );

    attrTableEntry_t * l_attrs = NULL;
    uint16_t l_numAttrs = 0;
    uint32_t l_attrTableOffset = 0;

    //Seek to the Attribute Symbol Table offset
    ifSeek(io_ifInfo, IF_ATTR_TABLE_OFFSET_LOC);

    //Read the offset to the Attribute Symbol Table
    ifRead(io_ifInfo, &l_attrTableOffset, IF_ATTR_TABLE_OFFSET_SIZE);

    //Seek to the Attribute Symbol Table
    ifSeek(io_ifInfo, l_attrTableOffset);

    //Read the number of attributes
    ifRead(io_ifInfo, &l_numAttrs, sizeof(l_numAttrs));
    IF_DBG( "loadAttrSymbolTable: Offset of Attr Symbol Table 0x%X "
             "num attrs %u",
             l_attrTableOffset,
             l_numAttrs );

    //Now read the individual attribute entry
    if (0 < l_numAttrs)
    {
        //Allocate memory to hold the attribute data
        l_attrs = reinterpret_cast<attrTableEntry_t *>
            (malloc(l_numAttrs * sizeof(attrTableEntry_t)));
        memset(l_attrs, 0, l_numAttrs * sizeof(attrTableEntry_t));

        for (uint16_t i = 0; i < l_numAttrs; i++)
        {
            //Read the attribute type
            ifRead(io_ifInfo, &(l_attrs[i].type), sizeof(l_attrs[i].type));

            //Read the attribute id
            ifRead(io_ifInfo, &(l_attrs[i].attrId), sizeof(l_attrs[i].attrId));

            IF_DBG( "loadAttrSymbolTable: attr[%u]: type 0x%x, id 0x%x",
                     i, l_attrs[i].type, l_attrs[i].attrId);
        }
    }

    io_ifData.attrs = l_attrs;
    io_ifData.numAttrs = l_numAttrs;

    IF_DBG( "<< fapiHwpExecInitFile: loadAttrSymbolTable at %p",
            io_ifData.attrs );
}

/**  @brief Unloads the Attribue Symbol Table from memory
 *
 * Unloads the Attribute Symbol Table from memory
 *
 * @param[in, out] i_ifData   Reference to ifData_t which contains initfile data
 */
void unloadAttrSymbolTable(ifData_t & io_ifData)
{
    IF_DBG( "fapiHwpExecInitFile: unloadAttrSymbolTable at %p",
            io_ifData.attrs );
    // Deallocate memory
    free(io_ifData.attrs);
    io_ifData.attrs = NULL;
}

/**  @brief Get an InitFile attribute value
 *
 * This function gets a copy of an attribute. In the case of an array attribute,
 * The value in the specified index is retrieved.
 *
 * If there are ever attributes with more than 4 dimensions then this function
 * will need to be updated.
 *
 * @param[in]  i_ifData        Reference to ifData_t which contains initfile data
 * @param[in]  i_id            AttributeID
 * @param[out] o_val           Reference to uint64_t where attribute value is set
 * @param[in]  i_arrayIndex    Array of attribute array index's (when needed)
 *
 * @return ReturnCode. Zero if success.
 */
//******************************************************************************
fapi::ReturnCode getAttr(const ifData_t & i_ifData,
                 const uint16_t i_id,
                 uint64_t & o_val,
                 const uint32_t i_targetNum,
                 const uint16_t i_arrayIndex[MAX_ATTRIBUTE_ARRAY_DIMENSION],
                 InitFileStats  &i_stats )
{
    IF_DBG2( ">> fapiHwpExecInitFile: getAttr: id 0x%x target# %u",
             i_id, i_targetNum);

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;

    do {

        //Mask out the type bits and zero-base
        uint16_t l_id = (i_id & IF_ID_MASK) - 1;
        IF_DBG2( "fapiHwpExecInitFile: getAttr: id 0x%x", l_id);

        if (l_id < i_ifData.numAttrs)
        {
            const fapi::Target * l_pTarget = &(i_ifData.pTarget->front());

            if ((i_id & IF_TYPE_MASK) == IF_SYS_ATTR_TYPE)
            {
                l_pTarget = NULL;
            }
            else if ((i_id & IF_TYPE_MASK) == IF_ASSOC_TGT_ATTR_TYPE)
            {
                if (0 == i_targetNum)
                {
                    //Expect nonzero targetNum
                    FAPI_ERR( "fapiHwpExecInitFile: "
                              "getAttr: Expect nonzero targetNum" );
                    // dump trace and return error
                    i_stats.dump( );
                    i_stats.generateError( l_rc );
                    break;
                }
                else if (i_ifData.pTarget->size() <= i_targetNum)
                {
                    FAPI_ERR( "fapiHwpExecInitFile: "
                              "getAttr: target# %u is greater "
                              "than number of targets %zu passed in",
                              i_targetNum,
                              i_ifData.pTarget->size() );

                    const uint32_t & FFDC_IF_TGT_NUM = i_targetNum;
                    size_t l_ffdc = i_ifData.pTarget->size();
                    size_t & FFDC_IF_NUM_TGTS_PASSED_IN = l_ffdc;
                    FAPI_SET_HWP_ERROR(l_rc, RC_INITFILE_TGT_NUM_OUT_OF_RANGE);
                    i_stats.dump();
                    break;

                }

                l_pTarget = &(i_ifData.pTarget->at(i_targetNum));
            }

            fapi::AttributeId l_attrId =
                static_cast<fapi::AttributeId>(i_ifData.attrs[l_id].attrId);
            IF_DBG2( "fapiHwpExecInitFile: getAttr: attrId 0x%x",
            l_attrId );

            l_rc = fapi::fapiGetInitFileAttr(l_attrId, l_pTarget, o_val,
                                             i_arrayIndex[0], i_arrayIndex[1],
                                             i_arrayIndex[2], i_arrayIndex[3]);

            if (l_rc)
            {
                FAPI_ERR("fapiHwpExecInitFile: "
                         "getAttr: GetInitFileAttr failed rc 0x%x",
                         static_cast<uint32_t>(l_rc) );
                i_stats.dump();
                break;
            }
            if ( l_pTarget )
            {
                IF_ADBG( "fapiHwpExecInitFile: "
                         "getAttr: target %s attrId 0x%x val 0x%.16llx",
                         l_pTarget->toEcmdString(),
                         l_attrId,
                         o_val );
            }
            else
            {
                IF_ADBG( "fapiHwpExecInitFile: "
                         "getAttr: target NULL attrId 0x%x val 0x%.16llx",
                         l_attrId,
                         o_val );
            }
        }
        else
        {
            FAPI_ERR("fapiHwpExecInitFile: getAttr: id 0x%x out of range",
                     i_id );

            //  GENERIC IDENTIFIER
            const uint16_t & FFDC_IF_ATTR_ID_OUT_OF_RANGE = i_id;
            FAPI_SET_HWP_ERROR(l_rc, RC_INITFILE_ATTR_ID_OUT_OF_RANGE);
            i_stats.dump();
            break;
        }
    }
    while (0);

    IF_DBG2( "<< fapiHwpExecInitFile: getAttr" );
    return l_rc;
}


//******************************************************************************
// Helper functions for Literals
//******************************************************************************

/**  @brief Loads the Literal Symbol Table
 *
 * Loads the Literal Symbol Table from the binary initfile.
 *
 * @param[in,out] io_ifInfo   Reference to ifInfo_t which contains addr, size,
 *                            and current offset of the initfile
 * @param[in,out] io_ifData   Reference to ifData_t which contains initfile data
 */
void loadLitSymbolTable(ifInfo_t & io_ifInfo,
                        ifData_t & io_ifData )
{
    IF_DBG2( ">> fapiHwpExecInitFile: loadLitSymbolTable" );

    uint64_t * l_numericLits = NULL;
    uint16_t l_numLits = 0;
    uint32_t l_litTableOffset = 0;

    //Seek to the Literal Symbol Table offset
    ifSeek(io_ifInfo, IF_LIT_TABLE_OFFSET_LOC);

    //Read the offset to the Literal Symbol Table
    ifRead(io_ifInfo, &l_litTableOffset, IF_LIT_TABLE_OFFSET_SIZE);

    //Seek to the Literal Symbol Table
    ifSeek(io_ifInfo, l_litTableOffset);

    //Read the number of literals
    ifRead(io_ifInfo, &l_numLits, sizeof(l_numLits));
    IF_DBG2( "loadLitSymbolTable: Offset of Literal Symbol Table 0x%X "
             "num literals %u",
             l_litTableOffset,
             l_numLits );

    if (0 < l_numLits)
    {
        //Now read the individual literal entry

        uint8_t l_litSize = 0;

        l_numericLits =
            reinterpret_cast<uint64_t *>(malloc(l_numLits * sizeof(uint64_t)));
        memset(l_numericLits, 0, l_numLits * sizeof(uint64_t));

        for (uint16_t i = 0; i < l_numLits; i++)
        {
            //Read the literal size in bytes
            ifRead(io_ifInfo, &l_litSize, sizeof(l_litSize));

            if ((l_litSize > 0) && (l_litSize <= sizeof(uint64_t)))
            {
                //Read the literal value
                ifRead(io_ifInfo, &(l_numericLits[i]), l_litSize);

                #if (__BYTE_ORDER == __BIG_ENDIAN)
                //In big endian mode, if the literal is less then 8 bytes,
                //need to right justify so it is a regular 64-byte number.
                //In little endian mode, the bytes are swapped by ifRead()
                //so the literal is already justified.
                l_numericLits[i] >>= (64 - (l_litSize * 8));
                #endif

                IF_DBG( "loadLitSymbolTable:lit[%u]:size 0x%x,value 0x%016llx",
                         i,
                         l_litSize,
                         l_numericLits[i] );
            }
            else
            {
                //Expect nonzero literal size of 1 to 8 bytes
                FAPI_ERR( "loadLitSymbolTable: lit[%u]:  invalid size %u",
                          i,
                          l_litSize );
                fapiAssert(false);
            }
        }
    }

    io_ifData.numericLits = l_numericLits;
    io_ifData.numLits = l_numLits;

    IF_DBG2( "<< fapiHwpExecInitFile: loadLitSymbolTable at %p",
             io_ifData.numericLits );
}

/**  @brief Unloads the Literal Symbol Table from memory
 *
 * Unloads the Literal Symbol Table from memory
 *
 * @param[in, out] i_ifData   Reference to ifData_t which contains initfile data
 */
void unloadLitSymbolTable(ifData_t & io_ifData)
{
    IF_DBG( "fapiHwpExecInitFile: unloadLitSymbolTable at %p",
            io_ifData.numericLits );

    // Deallocate memory
    free(io_ifData.numericLits);
    io_ifData.numericLits = NULL;
}

/**  @brief Get an InitFile numeric literal value
 *
 * This function gets a copy of a numeric literal.
 *
 * @param[in]  i_ifData      Reference to ifData_t which contains initfile data
 * @param[in]  i_id          Numeric Literal id
 * @param[out] o_val         Reference to uint64_t where literal value is set
 *
 * @return ReturnCode. Zero if success.
 */
//******************************************************************************
fapi::ReturnCode getLit(const ifData_t & i_ifData,
                        const uint16_t i_id,
                        uint64_t & o_val,
                        InitFileStats   &i_stats    )
{
    IF_DBG2( ">> fapiHwpExecInitFile: getLit: id 0x%X",
             i_id );

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;

    //Mask out the type bits and zero-base
    uint16_t l_id = (i_id & IF_ID_MASK) - 1;

    if (l_id < i_ifData.numLits)
    {
        o_val = i_ifData.numericLits[l_id];
        IF_DBG2( "fapiHwpExecInitFile: getLit: id 0x%x val 0x%.16llX",
                 i_id,
                 o_val );
    }
    else
    {
        FAPI_ERR("fapiHwpExecInitFile: getLit: id 0x%x out of range", i_id);

        //  GENERIC IDENTIFIER
        const uint16_t & FFDC_IF_LIT_ID_OUT_OF_RANGE = i_id;
        FAPI_SET_HWP_ERROR(l_rc, RC_INITFILE_LIT_ID_OUT_OF_RANGE);
        //  dump trace
        i_stats.dump();

    }

    return l_rc;
}


//******************************************************************************
// Helper functions for Scoms
//******************************************************************************

/**  @brief Loads the Scom Section
 *
 * Loads the Scom Section from the binary initfile.
 *
 * @param[in,out] io_ifInfo   Reference to ifInfo_t which contains addr, size,
 *                            and current offset of the initfile
 * @param[in,out] io_ifData   Reference to ifData_t which contains initfile data
 */
void loadScomSection(ifInfo_t & io_ifInfo,
                     ifData_t & io_ifData )
{
    IF_DBG2( ">> fapiHwpExecInitFile: loadScomSection" );

    scomData_t ** l_scoms = NULL;
    uint32_t l_numScoms = 0;
    uint32_t l_scomSectionOffset = 0;

    //Seek to the Scom Section offset
    ifSeek(io_ifInfo, IF_SCOM_SECTION_OFFSET_LOC);

    //Read the offset to the Scom Section
    ifRead(io_ifInfo, &l_scomSectionOffset, IF_SCOM_SECTION_OFFSET_SIZE);

    //Read the number of Scoms
    ifRead(io_ifInfo, &l_numScoms, sizeof(l_numScoms));
    IF_DBG( "loadScomSection: Offset of Scom Section 0x%X "
             "num scoms %u",
             l_scomSectionOffset,
             l_numScoms );

    //Seek to the Scom Section
    ifSeek(io_ifInfo, l_scomSectionOffset);

    if (0 < l_numScoms)
    {
        //------------------------------------
        //Now read the individual SCOM entry
        //------------------------------------

        //Allocate memory to hold the data
        l_scoms = new scomData_t*[l_numScoms];
        IF_MDBG( ">>>> new l_scoms @ %p",
                 l_scoms );

        for (uint32_t i = 0; i < l_numScoms; i++)
        {
            // Allocate SCOM.
            l_scoms[i] = new scomData_t;
            memset(l_scoms[i], '\0', sizeof(scomData_t));
            IF_MDBG( ">>>> new l_scoms[%d] @ %p",
                     i,
                     l_scoms[i] );

            //Read the SCOM len
            ifRead(io_ifInfo, &(l_scoms[i]->len), sizeof(l_scoms[i]->len));

            //Read the SCOM offset
            ifRead( io_ifInfo, &(l_scoms[i]->offset),
                    sizeof(l_scoms[i]->offset) );

            //Read the SCOM address id
            ifRead( io_ifInfo, &(l_scoms[i]->addrId),
                    sizeof(l_scoms[i]->addrId) );

            //Expect numeric literal id, 1-based
            if ( ! ((IF_NUM_TYPE == (l_scoms[i]->addrId & IF_TYPE_MASK)) &&
                (IF_NUM_TYPE < l_scoms[i]->addrId)) )
            {
                FAPI_ERR( "loadScomSection: scom[%u]: "
                          "addrId not a numeric literal",
                          i );
                fapiAssert(false);
            }

            //Read the number of columns
            ifRead( io_ifInfo, &(l_scoms[i]->numCols),
                    sizeof(l_scoms[i]->numCols));

            //Read the number of rows
            ifRead( io_ifInfo, &(l_scoms[i]->numRows),
                    sizeof(l_scoms[i]->numRows));

            IF_DBG( "loadScomSection: scom[%u]: len %u, offset %u",
                    i,
                    l_scoms[i]->len,
                    l_scoms[i]->offset );
            IF_DBG( "loadScomSection: addr id 0x%x, #cols %u, #rows %u",
                    l_scoms[i]->addrId,
                    l_scoms[i]->numCols,
                    l_scoms[i]->numRows );

            //Expect at least one row
            if (0 >= l_scoms[i]->numRows)
            {
                FAPI_ERR( "loadScomSection: scom[%u]: num rows %u <= 0",
                         i,
                         l_scoms[i]->numRows );
                fapiAssert(false);
            }

            //-----------------------------------
            //Read the scom data
            //-----------------------------------

            uint8_t l_rowSize = 0;
            char * l_rowPtr = NULL;

            //Allocate memory to hold the scom data
            l_scoms[i]->data =
                reinterpret_cast<char**>
                    (malloc(l_scoms[i]->numRows * sizeof(char**)));
            memset(l_scoms[i]->data, 0, l_scoms[i]->numRows * sizeof(char**));
            IF_MDBG( "malloc l_scoms[%d]->data @ %p",
                     i,
                     l_scoms[i]->data );

            //Read the scom data for each row
            for (uint16_t j = 0; j < l_scoms[i]->numRows; j++)
            {
                //Read the row size; i.e. # of bytes
                ifRead(io_ifInfo, &l_rowSize, sizeof(l_rowSize));

                //Expect non-zero row size
                if (0 >= l_rowSize)
                {
                    FAPI_ERR("loadScomSection: scom[%u]: scom data row size %u",
                             i,
                             l_rowSize );
                    fapiAssert(false);
                }

                //Allocate the space for the scom data and its size
                l_scoms[i]->data[j] = reinterpret_cast<char *>
                    (malloc(l_rowSize + 1));
                memset(l_scoms[i]->data[j], 0, l_rowSize + 1);
                l_rowPtr = l_scoms[i]->data[j];
                IF_MDBG( "malloc l_scoms[%d]->data[%d] @ %p",
                         i,
                         j,
                         l_scoms[i]->data[j] );

                //Save the size of the scom data
                *l_rowPtr++ = l_rowSize;

                //Read in the scom data
                //Don't swap the bytes, scom data will parsed by byte later in code
                ifRead(io_ifInfo, l_rowPtr, l_rowSize, false);
                #ifdef HWPEXECINITFILE_DEBUG
                for (uint8_t k = 0; k < l_rowSize; k++)
                {
                    IF_DBG2( "loadScomSection: scom[%u]: data[%u] "
                           "0x%02x",
                           i,
                           j,
                           *l_rowPtr++ );
                }
                #endif
            }

            // Set to default
            l_scoms[i]->hasExpr = false;

            //-----------------------------------
            //Load the column data
            //-----------------------------------
            if (0 < l_scoms[i]->numCols)
            {
                //Allocate memory to hold the column data plus its target id
                l_scoms[i]->colId =
                    reinterpret_cast<char *>
                        (malloc(l_scoms[i]->numCols * 2 * sizeof(uint16_t)));
                memset(l_scoms[i]->colId, 0,
                    l_scoms[i]->numCols * 2 * sizeof(uint16_t));
                IF_MDBG( "malloc l_scoms[%d]->colId @ %p",
                         i,
                         l_scoms[i]->colId );

                //Read Column Id
                uint16_t l_colId = 0;
                char *l_pCol = l_scoms[i]->colId;
                for (uint16_t j = 0; j < l_scoms[i]->numCols; j++)
                {
                    //Don't swap the bytes - colId is parsed by bytes later in code.
                    ifRead(io_ifInfo, l_pCol, sizeof(uint16_t), false);
                    l_colId = *l_pCol++ << 8;
                    l_colId |= *l_pCol++;

                    IF_DBG2( "loadScomSection: scom[%u]: colId[%u] "
                             "0x%02x",
                             i,
                             j,
                             l_colId );

                    //Is this an associated target attribute
                    if ((l_colId & IF_TYPE_MASK) == IF_ASSOC_TGT_ATTR_TYPE)
                    {
                        //Read the target Id
                        //Don't swap the bytes - it is parsed by bytes later in code.
                        ifRead(io_ifInfo, l_pCol, sizeof(uint16_t), false);
                        #ifdef HWPEXECINITFILE_DEBUG2
                            uint16_t l_colTgtId = 0;
                            l_colTgtId = (*l_pCol << 8) | (*(l_pCol+1));
                            IF_DBG2( "loadScomSection: colTgtId[%u] 0x%02x",
                                     j,
                                     l_colTgtId );
                        #endif
                    }
                    l_pCol += 2; //advance past the target Id
                }

                //Is the last column an EXPR column
                if (IF_EXPR == l_colId)
                {
                    IF_DBG2( "loadScomSection: scom[%u]: has expression",
                             i );
                    l_scoms[i]->hasExpr = true;
                }
            }

            //-----------------------------------
            //Load the row data for each columns
            //-----------------------------------
            if (0 == l_scoms[i]->numCols)
            {
                // Set the row data ptr to NULL & discard 1-byte row size
                l_scoms[i]->rowData = NULL;
                ifSeek(io_ifInfo, io_ifInfo.offset + 1);
            }
            else
            {
                //Allocate memory to hold the row data
                l_scoms[i]->rowData =
                    reinterpret_cast<char**>
                        (malloc(l_scoms[i]->numRows * sizeof(char**)));
                memset(l_scoms[i]->rowData, 0,
                    l_scoms[i]->numRows * sizeof(char**));
                IF_MDBG( "malloc l_scoms[%d]->rowData @ %p",
                         i,
                         l_scoms[i]->rowData );

                // Determine the number of simple columns (not an expr columns)
                uint16_t l_numSimpleCols = l_scoms[i]->numCols;
                if (l_scoms[i]->hasExpr)
                {
                    l_numSimpleCols--;
                }

                //Read the row data for each row
                uint16_t l_rowSize = 0;
                l_rowPtr = NULL;
                uint32_t c;

                for (uint16_t j = 0; j < l_scoms[i]->numRows; j++)
                {
                    //Read the row size; i.e. # of bytes
                    ifRead(io_ifInfo, &l_rowSize, sizeof(l_rowSize));

                    //Expect non-zero row size
                    if (0 >= l_rowSize)
                    {
                        FAPI_ERR( "loadScomSection: scom[%u]: row size %u",
                                 i,
                                 l_rowSize );
                        fapiAssert(false);
                    }

                    //If have expr column, need another two bytes to store its length
                    if (l_scoms[i]->hasExpr)
                    {
                        l_rowSize += 2;
                    }

                    //Allocate the space
                    l_scoms[i]->rowData[j] = reinterpret_cast<char *>
                        (malloc(l_rowSize));
                    l_rowPtr = l_scoms[i]->rowData[j];
                    IF_MDBG( "malloc l_scoms[%d]->rowData[%d] @ %p",
                             i,
                             j,
                             l_scoms[i]->rowData );

                    //Read in the simple column entries in the rows
                    for (uint16_t k = 0; k < l_numSimpleCols; k++)
                    {
                        //Keep reading in data until we hit a non push, which
                        //would be an operator
                        while (1)
                        {
                            //Read the first byte of the Push, or an operator
                            ifRead(io_ifInfo, l_rowPtr, sizeof(char));
                            IF_DBG2( "loadScomSection: scom[%u]: rowData[%u] "
                                     "0x%02x",
                                     i,
                                     j,
                                     *l_rowPtr );

                            c = *l_rowPtr++;
                            l_rowSize--;

                            //If it's not a push, then it must be an operator,
                            //so we're done
                            if (!(c & PUSH_MASK))
                            {
                                break;
                            }

                            //It was a push, so read in the 2nd byte of it
                            ifRead(io_ifInfo, l_rowPtr, sizeof(char));
                            IF_DBG2( "loadScomSection: scom[%u]: rowData[%u] "
                                     "0x%02x",
                                     i,
                                     j,
                                     *l_rowPtr );
                            l_rowPtr++;
                            l_rowSize--;
                        }
                    }

                    //After the simple columns comes the expression column,
                    //if present
                    if (l_scoms[i]->hasExpr)
                    {
                        //Save the length of the expr
                        l_rowSize -= 2;
                        *l_rowPtr++ = (uint8_t)(l_rowSize >> 8);
                        *l_rowPtr++ = (uint8_t)l_rowSize;
                        IF_DBG2( "loadScomSection: scom[%u]: rowData[%u] "
                                 "expr len 0x%02x%02x",
                                 i,
                                 j,
                                 *(l_rowPtr-2),
                                 *(l_rowPtr-1) );

                        //Read in the rest of the expression, which goes to the
                        //end of the row
                        while (l_rowSize--)
                        {
                            ifRead(io_ifInfo, l_rowPtr, sizeof(char));
                            IF_DBG2( "loadScomSection: scom[%u]: rowData[%u] "
                                     "0x%02x",
                                     i,
                                     j,
                                     *l_rowPtr );
                            l_rowPtr++;
                        }
                    }
                }
            }
        }
    }

    io_ifData.scoms = l_scoms;
    io_ifData.numScoms = l_numScoms;

    IF_DBG( "<< fapiHwpExecInitFile: loadScomSection" );
}

/**  @brief Unloads the Scom Section from memory
 *
 * @param[in, out] i_ifData   Reference to ifData_t which contains initfile data
 */
void unloadScomSection(ifData_t & io_ifData)
{
    IF_DBG2( ">> fapiHwpExecInitFile: unloadScomSection" );

    //Deallocate memory
    for (uint32_t i = 0; i < io_ifData.numScoms; i++)
    {
        if (NULL != io_ifData.scoms[i]->data)
        {
            for (uint16_t j = 0; j < io_ifData.scoms[i]->numRows; j++)
            {
                IF_MDBG( "free(io_ifData.scoms[%d]->data[%d] @ %p)",
                         i,
                         j,
                         io_ifData.scoms[i]->data[j] );
                free(io_ifData.scoms[i]->data[j]);
                io_ifData.scoms[i]->data[j] = NULL;
            }

            IF_MDBG( "free(io_ifData.scoms[%d]->data @ %p)",
                     i,
                     io_ifData.scoms[i]->data );
            free(io_ifData.scoms[i]->data);
            io_ifData.scoms[i]->data = NULL;
        }

        IF_MDBG( "free(io_ifData.scoms[%d]->colId @ %p)",
                 i,
                 io_ifData.scoms[i]->colId );
        free(io_ifData.scoms[i]->colId);
        io_ifData.scoms[i]->colId = NULL;

        if (NULL != io_ifData.scoms[i]->rowData)
        {
            for (uint16_t j = 0; j < io_ifData.scoms[i]->numRows; j++)
            {
                IF_MDBG( "free(io_ifData.scoms[%d]->rowData[%d] @ %p)",
                         i,
                         j,
                         io_ifData.scoms[i]->rowData[j] );
                free(io_ifData.scoms[i]->rowData[j]);
                io_ifData.scoms[i]->rowData[j] = NULL;
            }

            IF_MDBG( "free(io_ifData.scoms[%d]->rowData @ %p)",
                     i,
                     io_ifData.scoms[i]->rowData );
            free(io_ifData.scoms[i]->rowData);
            io_ifData.scoms[i]->rowData = NULL;
        }

        IF_MDBG( "delete (io_ifData.scoms[%d] @ %p)",
                 i,
                 io_ifData.scoms[i] );
        delete io_ifData.scoms[i];
        io_ifData.scoms[i] = NULL;
    }   // endfor i

    IF_MDBG( "delete[] (io_ifData.scoms @ %p)",
             io_ifData.scoms );
    delete[] io_ifData.scoms;
    io_ifData.scoms = NULL;

    IF_DBG( "<< fapiHwpExecInitFile: unloadScomSection" );
}

/**  @brief Execute the Scom Section
 *
 * @param[in] i_ifData   Reference to ifData_t which contains initfile data
 *
 * @return ReturnCode. Zero if success.
 */
fapi::ReturnCode executeScoms(ifData_t & i_ifData, InitFileStats &i_stats )
{
    FAPI_INF(">> fapiHwpExecInitFile: executeScoms");

    fapi::ReturnCode l_rc;
    uint16_t l_numSimpleCols = 0;
    uint16_t l_len = 0;
    char * l_rowExpr = NULL;
    char * l_colExpr = NULL;
    uint16_t l_row;
    bool l_goToNextRow = false;
    rpnStack_t l_rpnStack;
    uint64_t result = 0;
    scomToWrite_t l_scom;
    scomList_t l_scomList;

    //Create RPN stack
    l_rpnStack.reserve(128);

    i_ifData.rpnStack = &l_rpnStack;

    i_stats.saveTargets( i_ifData.pTarget );
    i_stats.saveStack(  &l_rpnStack );

    for (uint32_t i = 0; i < i_ifData.numScoms; i++)
    {
        //  save values for debug
        i_stats.saveScom( i_ifData.scoms[i] );

        //Get the number of simple columns
        l_numSimpleCols = i_ifData.scoms[i]->numCols;
        if (i_ifData.scoms[i]->hasExpr)
        {
            l_numSimpleCols--;
        }

        IF_DBG2( "fapiHwpExecInitFile:executeScoms:scoms[%d]:#simple cols %u",
                 i,
                 l_numSimpleCols );

        for (l_row = 0; l_row < i_ifData.scoms[i]->numRows; l_row++)
        {
            IF_DBG( ">> fapiHwpExecInitFile: executeScoms: scom %u row %u",
                    i,
                    l_row );
            //  save values for debug
            i_stats.saveRow(l_row);

            //Nothing to check if there are no columns
            //We found a row match
            if ((0 == i_ifData.scoms[i]->numCols) ||
                (NULL == i_ifData.scoms[i]->rowData))
            {
                IF_DBG2( "fapiHwpExecInitFile: executeScoms: no cols" );
                break;
            }

            //Get a pointer to the row expressions
            l_rowExpr = i_ifData.scoms[i]->rowData[l_row];

            //Get a pointer to the column expressions
            if (l_numSimpleCols > 0)
            {
                l_colExpr = i_ifData.scoms[i]->colId;
            }

            //Evaluate the simple columns (not the 'expr' column)
            for (uint16_t col= 0; col < l_numSimpleCols; col++)
            {
                //  save values for debug
                i_stats.saveCol( col );

                //Evaluate the col id & target number
                l_rc = evalRpn(i_ifData, l_colExpr, 4, true, false, i_stats );

                if (l_rc)
                {
                    FAPI_ERR( "fapiHwpExecInitFile: "
                              "Simple Column evalRpn failed" );
                    break;
                }

                l_colExpr += 4; //advance past calculation

                //This might be several pushes or just a push and an operator,
                //so loop to read in the pushes
                //An OP marks the end of a simple column RPN
                while (static_cast<uint32_t>(*l_rowExpr) & PUSH_MASK)
                {
                    uint32_t l_byteCount = 2;
                    if((static_cast<uint16_t>(*l_rowExpr << 8) & IF_TYPE_MASK)
                       == IF_ASSOC_TGT_ATTR_TYPE)
                    {
                        //Read the target# also
                        l_byteCount += 2;
                    }

                    // PUSH  (SYMBOL)
                    l_rc = evalRpn(i_ifData,
                                   l_rowExpr,
                                   l_byteCount,
                                   false,
                                   false,
                                   i_stats );
                    l_rowExpr += l_byteCount; //advance past the calculation

                    if (l_rc)
                    {
                        FAPI_ERR( "fapiHwpExecInitFile: "
                                  "Simple Column evalRpn failed"
                                 " on scom 0x%X",
                                 i_ifData.scoms[i]->addrId);
                        break;
                    }
                }

                if (l_rc)
                {
                    break;
                }

                //If the op is TRUE_OP or FALSE_OP then pop the extra column
                //symbol off the Rpn stack since it won't be consumed by the OP
                if((*l_rowExpr == FALSE_OP) || (*l_rowExpr == TRUE_OP))
                {
                    //Unconditional OP; throw pushed COL symbol away
                    rpnPop(i_ifData.rpnStack, i_stats );
                    if ( !i_stats.ok() )
                    {
                        FAPI_ERR( "rpnPop failure" );
                        i_stats.generateError( l_rc );
                        break;
                    }
                    IF_DBG2( "fapiHwpExecInitFile: executeScoms: "
                             "True or False op" );
                }

                l_rc = evalRpn(i_ifData, l_rowExpr, 1, false, false, i_stats );
                l_rowExpr++;

                if (l_rc)
                {
                    FAPI_ERR("fapiHwpExecInitFile: Simple Column evalRpn "
                             "failed on scom 0x%X",
                             i_ifData.scoms[i]->addrId );
                    break;
                }

                result = rpnPop(i_ifData.rpnStack,i_stats );
                if ( !i_stats.ok() )
                {
                    FAPI_ERR( "rpnPop failure" );
                    i_stats.generateError( l_rc );
                    break;
                }
                IF_DBG2( "fapiHwpExecInitFile: executeScoms: Simple Col: "
                         "result 0x%llX",
                         result );


                //If zero, continue on to the next row.
                if (0 == result)
                {
                  l_goToNextRow = true;
                  break; //break out of simple column for loop
                }

            } //End looping on simple columns

            if (l_rc)
            {
                break;
            }

            //Skip over to the next row
            if (l_goToNextRow)
            {
                IF_DBG2( "fapiHwpExecInitFile: executeScoms: check next row" );

                l_goToNextRow = false;
                continue;
            }

            //Now evaluate the expression, if there is one
            if (i_ifData.scoms[i]->hasExpr)
            {
                IF_DBG( "fapiHwpExecInitFile: Evaluate expr @ %p",
                        l_rowExpr );

                // fetch 2 bytes and combine to get a uint16_t len
                l_len = *((uint8_t*)l_rowExpr);
                l_rowExpr++;
                l_len = (l_len << 8) + *((uint8_t*)l_rowExpr);
                l_rowExpr++;

                l_rc = evalRpn(i_ifData,
                               l_rowExpr,
                               l_len,
                               false,
                               true,
                               i_stats );

                if (l_rc)
                {
                    FAPI_ERR( "fapiHwpExecInitFile: "
                              "Row expression evalRpn failed on scom 0x%X",
                              i_ifData.scoms[i]->addrId );
                    break;
                }

                result = rpnPop(i_ifData.rpnStack, i_stats );
                if ( !i_stats.ok() )
                {
                    FAPI_ERR( "rpnPop failure" );
                    i_stats.generateError( l_rc );
                    break;
                }
                IF_DBG2( "fapiHwpExecInitFile: executeScoms: Expr: "
                         "result 0x%llX",
                         result );

                //If nonzero, we're done so break out of row loop, otherwise
                //let it go down to the next row
                if (0 != result)
                {
                  IF_DBG2( "fapiHwpExecInitFile: executeScoms: Expr: "
                           "found valid row" );
                  break;
                }
            }
            else
            {
                //No expression, and we're at the end, so we must
                //have found a match in the columns
                IF_DBG2( "fapiHwpExecInitFile: executeScoms: found valid row" );
                break;
            }

        } // end looping for all rows

        if (l_rc)
        {
            break;
        }

        IF_DBG2( "fapiHwpExecInitFile: executeScoms: scom %u row %u",
                i,
                l_row );

        //Can tell we found a match by checking if we broke out of the
        //for loop early
        if (l_row < i_ifData.scoms[i]->numRows)
        {
            //Set the scom entry number and it's row
            l_scom.scomNum = i;
            l_scom.row = l_row;

            //push the scom entry and its row into the list to write
            l_scomList.push_back(l_scom);

            IF_DBG2( "fapiHwpExecInitFile: executeScoms: "
                     "found valid scom# %u row %u",
                      l_scom.scomNum,
                      l_scom.row );
        }

        IF_DBG2( "fapiHwpExecInitFile: executeScoms: l_scomList size %u",
                 l_scomList.size() );

        if (l_scomList.size())
        {
            //Look ahead to see if we can combine Scoms for optimization.
            //Scoms can be combined if they're PutScomUnderMask ops to the
            //same Scom registers.  Write the scoms in the list if we're at
            //the last scom entry (no more entries to process or compare),
            //if this or the next scom entry is a PutScom op (scom len = 0),
            //or if the next entry is an op to a different Scom register
            //(addrIds don't match), else go to the next scom.
            if (((i+1) == i_ifData.numScoms)    ||                          //last scom entry
                (0 == i_ifData.scoms[i]->len)   ||
                (0 == i_ifData.scoms[i+1]->len) ||                          //not PutScomUnderMask
                (i_ifData.scoms[i]->addrId != i_ifData.scoms[i+1]->addrId)) //different Scom regs
            {
                // Perform a scom operation on the chip
                #ifdef HWPEXECINITFILE_DEBUG2
                for (size_t j = 0; j < l_scomList.size(); j++)
                {
                    IF_DBG2( "fapiHwpExecInitFile: executeScoms: "
                             "will write scom# %u row %u",
                             l_scomList[j].scomNum,
                             l_scomList[j].row );
                }
                #endif

                l_rc = writeScom(i_ifData, l_scomList, i_stats );

                // Clear the scom list
                l_scomList.clear();

                if (l_rc)
                {
                    break;
                }
            }
        }
    } // end looping for all scoms

    // Clear the scom list; the only time the scom list is not empty
    // is if we have pending scoms to write but we broke out of the above for
    // loop early due to an error (l_rc != 0).
    if (l_scomList.size())
    {
        FAPI_ERR( "fapiHwpExecInitFile: executeScoms: scom list size = %zu, "
                  "expecting zero",
                  l_scomList.size() );
        l_scomList.clear();
    }

    //  Clear the stack, clear the external pointer to it
    l_rpnStack.clear();
    i_ifData.rpnStack = NULL;

    // clear it in stats as well.
    i_stats.saveStack( NULL );

    FAPI_INF("<< fapiHwpExecInitFile: executeScoms");
    return l_rc;
}

/**  @brief Write Scom
 *
 * @param[in] i_ifData   Reference to ifData_t which contains initfile data
 * @param[in] i_scomList The list of scoms to write
 *
 * @return ReturnCode. Zero if success.
 */
fapi::ReturnCode writeScom(ifData_t & i_ifData,
                           const scomList_t & i_scomList,
                           InitFileStats  &i_stats )
{
    FAPI_DBG(">> fapiHwpExecInitFile: writeScom");

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;
    uint32_t l_ecmdRc = ECMD_DBUF_SUCCESS;

    const fapi::Target l_target = i_ifData.pTarget->front();

    uint64_t l_data = 0; // aggregate scom data to write
    uint64_t l_mask = 0; // aggregate mask for PutScomUnderMask op

    uint16_t l_scomNum = 0;
    uint16_t l_row = 0;
    uint64_t l_tmpData = 0;
    uint16_t l_addrId = 0;
    uint64_t l_addr = 0;
    char *   l_rowExpr = NULL;  // pointer to scom data expression
    uint8_t  l_rowSize = 0;     // size of scom data

    do
    {
        for (size_t l_entry = 0; l_entry < i_scomList.size(); l_entry++)
        {
            l_scomNum = i_scomList.at(l_entry).scomNum;
            l_row = i_scomList.at(l_entry).row;
            l_tmpData = 0;

            if (0 == l_entry)
            {
                //Get the the scom address
                l_addrId = i_ifData.scoms[l_scomNum]->addrId;
                l_rc = getLit(i_ifData, l_addrId, l_addr, i_stats );
                if (l_rc)
                {
                    break;
                }
            }
            else if (l_addrId != i_ifData.scoms[l_scomNum]->addrId)
            {
                //Address should be the same for all scoms in the list
                FAPI_ERR( "fapiHwpExecInitFile: writeScom: have scomList "
                          "of different Scom addresses!" );
                // dump trace & ffdc
                i_stats.dump( );
                i_stats.generateError( l_rc );
                break;
            }

            //Get the scom data
            IF_DBG2( "fapiHwpExecInitFile: writeScom: Evaluate scom data" );

            l_rowExpr = i_ifData.scoms[l_scomNum]->data[l_row];
            l_rowSize = *((uint8_t*)l_rowExpr); //size of the scom data
            l_rowExpr++;

            l_rc = evalRpn(i_ifData,
                           l_rowExpr,
                           l_rowSize,
                           false,
                           false,
                           i_stats);

            if (l_rc)
            {
                FAPI_ERR("fapiHwpExecInitFile: writeScom: scom data expression "
                         "evalRpn failed on scom 0x%X",
                         i_ifData.scoms[l_scomNum]->addrId );
                break;
            }

            l_tmpData = rpnPop(i_ifData.rpnStack, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }
            IF_DBG2( "fapiHwpExecInitFile: writeScom: Scom data 0x%llX",
                     l_tmpData );

            IF_DBG2( "fapiHwpExecInitFile: writeScom: addr 0x%.16llX, "
                     "data 0x%.16llX",
                     l_addr,
                     l_tmpData );

            //Check if this is a bit operation
            if (i_ifData.scoms[l_scomNum]->len)
            {
                //Get offset and len
                uint16_t l_offset = i_ifData.scoms[l_scomNum]->offset;
                uint16_t l_len = i_ifData.scoms[l_scomNum]->len;
                uint64_t l_tmpMask = 0; // mask for PutScomUnderMask ops

                //Create mask
                for (uint64_t i = l_offset; i < (l_offset + l_len); i++)
                {
                    l_tmpMask |= (0x8000000000000000ll >> i);
                }
                l_mask |= l_tmpMask;

                //Shift data to the right offset and grab only the valid
                //bits; data is right aligned
                l_tmpData <<= (64 - (l_offset + l_len));
                l_tmpData &= l_tmpMask;
                l_data |= l_tmpData;

                FAPI_DBG("fapiHwpExecInitFile: writeScom: data 0x%.16llX "
                         "mask 0x%.16llX len %u offset %u",
                         l_tmpData, l_tmpMask, l_len, l_offset);
            }
            else
            {
                if (1 < i_scomList.size())
                {
                    //There should only be one entry in the scom list if this not
                    //a bit op
                    FAPI_ERR("fapiHwpExecInitFile: writeScom: "
                             "scomList size > 1 for PutScom op!" );
                    // dump trace & ffdc
                    i_stats.dump( );
                    i_stats.generateError( l_rc );
                    break;
                }

                l_data = l_tmpData;
            }
        }

        if (l_rc)
        {
            break;
        }

        IF_DBG2( "fapiHwpExecInitFile: writeScom: "
                 "data 0x%.16llX mask 0x%.16llX",
                 l_data,
                 l_mask );

        //Create a 64 bit data buffer
        ecmdDataBufferBase l_scomData(64);

        #ifdef HWPEXECINITFILE_DEBUG2
        l_rc = fapiGetScom(l_target, l_addr, l_scomData);
        IF_DBG2( "fapiHwpExecInitFile: writeScom: Data read 0x%.16llX",
                 l_scomData.getDoubleWord(0) );
        #endif

        l_ecmdRc = l_scomData.setDoubleWord(0, l_data);
        if (l_ecmdRc != ECMD_DBUF_SUCCESS)
        {
             FAPI_ERR("fapiHwpExecInitFile: writeScom: error from "
                      "ecmdDataBuffer setDoubleWord() - rc 0x%.8X",
                      l_ecmdRc );

             l_rc.setEcmdError(l_ecmdRc);
             break;
        }

        if (l_mask && (l_mask != 0xFFFFFFFFFFFFFFFFull))
        {
            //Perform a PutScomUnderMask operation on the target

            //Create a 64 bit data buffer
            ecmdDataBufferBase l_scomMask(64);
            l_ecmdRc = l_scomMask.setDoubleWord(0, l_mask);
            if (l_ecmdRc != ECMD_DBUF_SUCCESS)
            {
                 FAPI_ERR("fapiHwpExecInitFile: writeScom: error from "
                          "ecmdDataBuffer setDoubleWord() - rc 0x%.8X",
                          l_ecmdRc);

                 l_rc.setEcmdError(l_ecmdRc);
                 break;
            }

            FAPI_DBG("fapiHwpExecInitFile: writeScom: PutScomUnderMask: "
                     "0x%.16llX = 0x%.16llX mask 0x%.16llX",
                     l_addr, l_scomData.getDoubleWord(0),
                     l_scomMask.getDoubleWord(0));

            l_rc = fapiPutScomUnderMask(l_target, l_addr, l_scomData,
                                        l_scomMask);
            if (l_rc)
            {
                FAPI_ERR("fapiHwpExecInitFile: "
                         "Error from fapiPutScomUnderMask");
                break;
            }
        }
        else
        {
           //Perform a PutScom operation on the target

            IF_DBG2( "fapiHwpExecInitFile: writeScom: PutScom: "
                     "0x%.16llX = 0x%.16llX",
                     l_addr,
                     l_scomData.getDoubleWord(0) );

            l_rc = fapiPutScom(l_target, l_addr, l_scomData);

            if (l_rc)
            {
                FAPI_ERR( "fapiHwpExecInitFile: Error from fapiPutScom" );
                break;
            }
        }

        #ifdef HWPEXECINITFILE_DEBUG2
            l_rc = fapiGetScom(l_target, l_addr, l_scomData);
            IF_DBG2( "fapiHwpExecInitFile: writeScom: Data read 0x%.16llX",
                     l_scomData.getDoubleWord(0) );
        #endif

    } while(0);

    FAPI_DBG("<< fapiHwpExecInitFile: writeScom");
    return l_rc;
}


/**  @brief Get the attribute array dimension.
 *
 * @param[in] i_ifData   Reference to ifData_t which contains initfile data
 * @param[in] i_id       attribute Id
 *
 * @return the attribute dimension
 */
fapi::ReturnCode getAttrArrayDimension(const ifData_t & i_ifData,
                                       const uint16_t i_id,
                                       uint8_t & o_attrDimension)
{
    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;

    o_attrDimension = 0;

    //Mask out the type bits and zero-based
    uint16_t l_id = (i_id & IF_ID_MASK) - 1;
    if (l_id < i_ifData.numAttrs)
    {
        // Get the attribute dimension & shift it to the LS nibble
        o_attrDimension =
            (i_ifData.attrs[l_id].type & ATTR_DIMENSION_MASK) >> 4;

        IF_DBG2( "fapiHwpExecInitFile: getAttrArrayDimension: Attr ID:0x%.4X "
                 "has dimension %u of type 0x%.4X",
                 i_id,
                 o_attrDimension,
                 i_ifData.attrs[l_id].type );
    }
    else
    {
        FAPI_ERR( "fapiHwpExecInitFile: getAttrArrayDimension: "
                  "id 0x%x out of range",
                  i_id );

        //  GENERIC IDENTIFIER
        const uint16_t & FFDC_IF_ATTR_ID_OUT_OF_RANGE = i_id;
        FAPI_SET_HWP_ERROR(l_rc, RC_INITFILE_ATTR_ID_OUT_OF_RANGE);
    }

    return l_rc;
}


//******************************************************************************
// RPN Calculator functions
//******************************************************************************

/** @brief Pushes a value onto the RPN stack.
 *
 * @param[in,out] io_rpnStack  Ptr to RPN stack
 * @param[in]     i_val        Value to push
 */
void rpnPush(rpnStack_t * io_rpnStack,
             uint64_t i_val )
{
    IF_DBG2( "fapiHwpExecInitFile: rpnPush 0x%llX",
             i_val );

    io_rpnStack->push_back(i_val);
}

/** @brief Pops the top value off of the RPN stack.
 *
 * @param[in,out] io_rpnStack  Ptr to RPN stack
 * @return uint64_t            Value from top of stack
 */
uint64_t rpnPop(rpnStack_t * io_rpnStack, InitFileStats &i_stats )
{
    IF_DBG2( "fapiHwpExecInitFile: rpnPop" );
    uint64_t l_val = 0;

    if (0 == io_rpnStack->size())
    {
        FAPI_ERR( "fapiHwpExecInitFile: rpnPop: rpn stack is empty. " );

        // dump trace here, register an error to be handled by caller.
        i_stats.dump( );
    }
    else
    {
        l_val = io_rpnStack->back();
        io_rpnStack->pop_back();

        IF_DBG2( "fapiHwpExecInitFile: rpnPop 0x%llX",
                 l_val );
    }
    return l_val;
}

/** @brief Dumps out the RPN stack
 *
 * @param[in] i_rpnStack  Ptr to RPN stack
 */
void rpnDumpStack(rpnStack_t * i_rpnStack)
{

    if ( i_rpnStack != NULL )
    {
        FAPI_IMP( ">> fapiHwpExecInitFile: rpnDumpStack: %p, stack size = %zd",
                  i_rpnStack,
                  i_rpnStack->size() );

        uint64_t l_val = 0;

        for (ssize_t i = i_rpnStack->size() - 1; i >= 0; i--)
        {
            l_val = i_rpnStack->at(i);
            FAPI_IMP( "Stack: Value = 0x%llX",
                      l_val );
        }

        FAPI_IMP( "<< fapiHwpExecInitFile: rpnDumpStack" );
    }

}

/** @brief Executes the unary operations - the ones with 1 operand.
 *
 * @param[in] i_op   Operation to perform
 * @param[in] i_val  Value to perform it on
 * @param[in] i_any  Flag indicating if this is an ANY op
 * @return uint64_t  The result
 */
uint64_t rpnUnaryOp(    IfRpnOp i_op,
                        uint64_t i_val,
                        uint32_t i_any,
                        InitFileStats   &i_stats
                        )
{
    IF_DBG2( "fapiHwpExecInitFile: rpnUnaryOp" );
    uint64_t result = 0;

    if (i_op == NOT)
    {
        if (i_any & IF_ANY) //everything returns true
        {
            result = 1;
        }
        else
        {
            result = (i_val == 0) ? 1 : 0;
        }
    }
    else
    {
        FAPI_ERR( "fapiHwpExecInitFile: rpnUnaryOp: Invalid Op %u",
                  i_op );
        // dump trace and register an error to be handled by caller.
        i_stats.dump( );
    }

    return result;
}

/** @brief Executes the binary operations - the ones with 2 operands.
 *
 * @param[in] IfRpnOp i_op     Operation to perform
 * @param[in] uint64_t i_val1  The first operand
 * @param[in] uint64_t i_val2  The second operand
 * @return uint64_t            The result
 */
uint64_t rpnBinaryOp(   IfRpnOp i_op,
                        uint64_t i_val1,
                        uint64_t i_val2,
                        uint32_t i_any,
                        InitFileStats   &i_stats
                        )
{
    IF_DBG2( ">> fapiHwpExecInitFile: rpnBinaryOp 0x%X",
             i_op );

    uint64_t result = 0;

    //If either of these are ANY, then just return nonzero/true
    if (i_any & IF_ANY)
    {
        result = 1;
        IF_DBG2( "fapiHwpExecInitFile: rpnBinaryOp: ANY" );
    }
    else
    {
        switch (i_op)
        {
            case (AND):
                result = i_val1 && i_val2;
                break;

            case (OR):
                result = i_val1 || i_val2;
                break;

            case (EQ):
                result = i_val1 == i_val2;
                break;

            case (NE):
                result = i_val1 != i_val2;
                break;

            case (GT):
                result = i_val1 > i_val2;
                break;

            case (GE):
                result = i_val1 >= i_val2;
                break;

            case (LT):
                result = i_val1 < i_val2;
                break;

            case (LE):
                result = i_val1 <= i_val2;
                break;

            case (PLUS):
                result = i_val1 + i_val2;
                break;

            case (MINUS):
                result = i_val1 - i_val2;
                break;

            case (MULT):
                result = i_val1 * i_val2;
                break;

            case (DIVIDE):
                if (0 == i_val2)
                {
                    FAPI_ERR( "fapiHwpExecInitFile: rpnBinaryOp: "
                              "Division by zero, i_val1 = 0x%llx",
                              i_val1 );
                    //  dump stats and flag an error to be handled by caller
                    i_stats.dump();
                    result  =   0;
                }
                else
                {
                    result = i_val1 / i_val2;
                }
                break;

            case (MOD):
                if (0 == i_val2)
                {
                    FAPI_ERR( "fapiHwpExecInitFile: rpnBinaryOp: "
                              "Mod by zero, i_val1 = 0x%llx",
                              i_val1 );
                    //  dump stats and register an error to be handled by caller
                    i_stats.dump();
                    result  =   0;
                }
                else
                {
                    result = i_val1 % i_val2;
                }
                break;

            case (SHIFTLEFT):
                result = i_val1 << i_val2;
                break;

            case (SHIFTRIGHT):
                result = i_val1 >> i_val2;
                break;

            case (BITWISEAND):
                result = i_val1 & i_val2;
                break;

            case (BITWISEOR):
                result = i_val1 | i_val2;
                break;

            default:
              FAPI_ERR("fapiHwpExecInitFile: rpnBinaryOp, invalid operator %d",
                       i_op);
              // dump trace and register an error to be handled by caller
              i_stats.dump();
              result    =   0;
              break;
        }
    }

    IF_DBG2( "<< fapiHwpExecInitFile: rpnBinaryOp: result 0x%llX",
             result );
    return result;
}

/** @brief Pushes an attribute or literal value onto the RPN stack.
 *
 * Pushes the attribute or literal value specified by i_id onto the RPN stack.
 * It uses the appropriate symbol table to resolve the value first.
 *
 * @param[in,out] io_ifData    Reference to ifData_t which contains initfile data
 * @param[in]     i_id         Id of element to push
 * @param[in,out] io_any       Set if ANY op
 * @param[in] i_arrayIndex  Array of attribute array index's
                                (when attribute is array type)
 * @return fapi::ReturnCode    Zero on success
 */
fapi::ReturnCode rpnDoPush(ifData_t & io_ifData, const uint16_t i_id,
                   uint32_t & io_any, const uint32_t i_targetNum,
                   const uint16_t i_arrayIndex[MAX_ATTRIBUTE_ARRAY_DIMENSION],
                           InitFileStats    &i_stats
                   )
{
    IF_DBG2( ">> fapiHwpExecInitFile: rpnDoPush: id 0x%X",
             i_id );

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;
    uint64_t l_val = 0;

    do
    {

        if (i_id & IF_ATTR_TYPE) //It's an attribute
        {
            l_rc = getAttr(io_ifData,
                           i_id,
                           l_val,
                           i_targetNum,
                           i_arrayIndex,
                           i_stats
                           );
            if (l_rc)
            {
              break;
            }

            IF_DBG2( "fapiHwpExecInitFile: rpnDoPush: getAttr: id = 0x%X, "
                     "target# = %u, value = 0x%llX",
                     i_id,
                     i_targetNum,
                     l_val );

            rpnPush(io_ifData.rpnStack, l_val);
        }
        else //It's a literal
        {
            //If it's not 'ANY'
            if (i_id != IF_VAL_ANY)
            {
                l_rc = getLit(io_ifData, i_id, l_val, i_stats );
                if (l_rc)
                {
                  FAPI_ERR( "fapiHwpExecInitFile: rpnDoPush: "
                            "getLit: id 0x%X failed",
                            i_id);
                  break;
                }

                IF_DBG2( "fapiHwpExecInitFile: rpnDoPush: Literal lookup: "
                         "id = 0x%X, value = 0x%llX",
                         i_id,
                         l_val );

                rpnPush(io_ifData.rpnStack, l_val);
            }
            else //It's 'ANY', which will always return true
            {
                io_any |= IF_ANY;

                l_val = 1;
                rpnPush(io_ifData.rpnStack, l_val);

                //If this is set, then we will see a PUSH ANY on the stack
                //without the 2nd operand for the binary operator EQ.  This
                //happens when parsing the expression column
                if (io_any & IF_ONE_SIDED_ANY)
                {
                   //To get the second operand, push a fake one on the stack
                   uint64_t l_temp = 0;
                   rpnPush(io_ifData.rpnStack, l_temp);
                }

                IF_DBG2( "fapiHwpExecInitFile: rpnDoPush: "
                         "Literal ANY pushed on stack" );
            }
        }

    } while(0);

    IF_DBG2( "<< fapiHwpExecInitFile: rpnDoPush" );
    return l_rc;
}

/** @brief Execute the operation
 *
 * Executes the operation passed in, and places the result onto
 *
 * @param[in,out] io_rpnStack  Ptr to RPN stack
 * @param[in,out] i_op         Operation to perform
 * @param[in]     i_any        Set if ANY op
 * @return fapi::ReturnCode    Zero on success
 */
fapi::ReturnCode rpnDoOp(rpnStack_t * io_rpnStack,
                         IfRpnOp i_op,
                         uint32_t i_any,
                         InitFileStats  &i_stats   )
{
    IF_DBG2( ">> fapiHwpExecInitFile: rpnDoOp 0x%X",
             i_op );

#ifdef HWPEXECINITFILE_DEBUG2
    rpnDumpStack(io_rpnStack);
#endif

    fapi::ReturnCode l_rc = fapi::FAPI_RC_SUCCESS;
    uint64_t val1   = 0;
    uint64_t val2   = 0;
    uint64_t result = 0;

    switch (i_op)
    {
        //Do all of the binary ops
        case (AND):
        case (OR):
        case (GT):
        case (GE):
        case (LT):
        case (LE):
        case (EQ):
        case (NE):
        case (PLUS):
        case (MINUS):
        case (MULT):
        case (DIVIDE):
        case (MOD):
        case (SHIFTLEFT):
        case (SHIFTRIGHT):
        case (BITWISEAND):
        case (BITWISEOR):

            //pop the first value
            val2 = rpnPop(io_rpnStack, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }

            //pop the second value
            val1 = rpnPop(io_rpnStack, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }

            //Calculate the result
            result = rpnBinaryOp(i_op, val1, val2, i_any, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }

            //Push the result onto the stack
            rpnPush(io_rpnStack, result );

            break;

        case (NOT):

            //Pop the value
            val1 = rpnPop(io_rpnStack, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }

            //Calculate the result
            result = rpnUnaryOp(i_op, val1, i_any, i_stats );
            if ( !i_stats.ok() )
            {
                FAPI_ERR( "rpnPop failure" );
                i_stats.generateError( l_rc );
                break;
            }

            //Push the result onto the stack
            rpnPush(io_rpnStack, result );

            break;

        case (FALSE_OP):

            result = 0;
            rpnPush(io_rpnStack, result );
            break;

        case (TRUE_OP):

           result = 1;
           rpnPush(io_rpnStack, result );
           break;

        default:
           FAPI_ERR( "fapiHwpExecInitFile: rpnDoOp: invalid op 0x%X",
                     i_op );
           // dump trace & ffdc
           i_stats.dump();
           i_stats.generateError( l_rc );
           break;
    }

    IF_DBG2( "<< fapiHwpExecInitFile: rpnDoOp: result %llu",
             result );
    return l_rc;
}

/** @brief Evaluates the RPN expression
 *
 * Evaluates the expression passed in and places the result on the RPN stack.
 *
 * @param[in,out] io_ifData   Reference to ifData_t which contains initfile data
 * @param[in]     i_expr      Expression to evaluate
 * @param[in]     i_len       Length of expression
 * @param[in]     i_hasExpr   True if EXPR column
 * @param[in]     i_stats    ref to InitFileStatus object
 *
 * @return fapi::ReturnCode   Zero on success
 */
fapi::ReturnCode evalRpn( ifData_t & io_ifData,
                          char *i_expr,
                          uint32_t i_len,
                          const bool i_isColExpr,
                          const bool i_hasExpr,
                          InitFileStats    &i_stats )
{
    IF_DBG2( ">> fapiHwpExecInitFile: evalRpn" );

    fapi::ReturnCode l_rc;
    IfRpnOp l_op;
    uint16_t l_id;
    uint64_t l_targetNum = 0;
    uint32_t l_any = IF_NOT_ANY;

    IF_DBG2( "fapiHwpExecInitFile: evalRpn: len %u",
             i_len );

    //If we're in an expression column, then an 'ANY' will just be one sided,
    //and won't have the 2nd operand needed for the upcoming EQ operator
    if (i_hasExpr)
    {
        IF_DBG2( "fapiHwpExecInitFile: evalRpn: this is an expr" );
        l_any = IF_ONE_SIDED_ANY;
    }

    while (i_len--)
    {
        l_op = static_cast<IfRpnOp>((*i_expr++) & OP_MASK);
        IF_DBG2( "fapiHwpExecInitFile: evalRpn: op? 0x%.2X",
                 l_op );

        if (l_op & PUSH_MASK) //Push
        {
            l_id = static_cast<uint16_t>((l_op << 8) | ((*i_expr++) & OP_MASK));
            --i_len;

            IF_DBG2( "fapiHwpExecInitFile: evalRpn: id 0x%.2X",
                     l_id );

            //Check for attribute of array type
            uint16_t l_arrayIndexs[MAX_ATTRIBUTE_ARRAY_DIMENSION] = {0};

            if (l_id & IF_ATTR_TYPE)
            {
                // If it's a column Id or an associated target attribute
                if (i_isColExpr ||
                    (l_id & IF_TYPE_MASK) == IF_ASSOC_TGT_ATTR_TYPE)
                {
                    // Read the target# id
                    uint16_t l_targetId = *i_expr++ << 8;
                    l_targetId |= *i_expr++;
                    IF_DBG2( "target Id 0x%x",
                             l_targetId );

                    if (l_targetId)
                    {
                        // Retrieve the actual value for the target
                        //  number (using it's id)
                        l_rc = getLit(io_ifData,
                                      l_targetId,
                                      l_targetNum,
                                      i_stats);
                        if (l_rc)
                        {
                            break;
                        }
                    }
                    i_len -= 2;
                }

                // Get the attribute dimension
                uint8_t l_attrDimension = 0;
                l_rc = getAttrArrayDimension(io_ifData, l_id, l_attrDimension);
                if (l_rc)
                {
                    break;
                }

                // Read out all dimensions for the attribute
                for(uint8_t j=0; j<l_attrDimension; j++)
                {
                    // Read out array index id
                    uint16_t l_arrayIdxId = 0;
                    l_arrayIdxId = *i_expr++ << 8;
                    l_arrayIdxId |= *i_expr++;

                    uint64_t l_tmpIdx = 0;

                    // Retrieve the actual value for the array index (using it's id)
                    l_rc = getLit(io_ifData,l_arrayIdxId,l_tmpIdx, i_stats );
                    if (l_rc)
                    {
                        break;
                    }
                    l_arrayIndexs[j] = l_tmpIdx;
                    i_len -= 2;
                }
            }

            // Handle error from above for loop
            if(l_rc)
            {
                break;
            }

            l_rc = rpnDoPush( io_ifData,
                              l_id,
                              l_any,
                              l_targetNum,
                              l_arrayIndexs,
                              i_stats );
        }
        else
        {
            l_rc = rpnDoOp(io_ifData.rpnStack,
                           l_op,
                           l_any,
                           i_stats );
        }

        if (l_rc)
        {
            break;
        }
    }

    IF_DBG2( "<< fapiHwpExecInitFile: evalRpn" );
    return l_rc;
}

} // extern "C"