/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/attn/test/attnfakegfir.H $                       */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2014              */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __TEST_ATTNFAKEGFIR_H
#define __TEST_ATTNFAKEGFIR_H

/**
 * @file attnfakegfir.H
 *
 * @brief HBATTN fake global FIR class definitions.
 */

#include "attnfakeelement.H"

namespace ATTN
{

/**
 * @brief FakeGfir Fake global FIR class definition.
 *
 * Attach logic to GFIR register modifications and
 * Proc local fir attentions.
 */
class FakeGfir : public FakeReg, public FakeSource
{
    public:

        /**
         * @brief ctor
         *
         * @param[in] i_type The type of the GFIR to be monitored.
         */
        explicit FakeGfir(PRDF::ATTENTION_VALUE_TYPE i_type);

        /**
         * @brief dtor
         */
        ~FakeGfir() {}

        /**
         * @brief install
         *
         * Register this object with the provided system for
         * the appropriate callbacks.
         *
         * @param[in] i_system The system in which to register callbacks.
         */
        void install(FakeSystem & i_system);

        /**
         * @brief processPutReg Process modified register content.
         *
         * Fake implemenation of GFIR.  Turns GFIR on when
         * local attentions are present.
         *
         * @param[in] i_sys System that modified register content.
         * @param[in] i_target Target whose registers were modified.
         * @param[in] i_address Address of register that was modified.
         * @param[in] i_new Register content after modification.
         * @param[in] i_old Register content before modification.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processPutReg(
                FakeSystem & i_sys,
                TARGETING::TargetHandle_t i_target,
                uint64_t i_address,
                uint64_t i_new,
                uint64_t i_old);

        /**
         * @brief processPutAttention Process injected attention.
         *
         * Fake implemenation of local Firs.  Turns GFIR on.
         *
         * @param[in] i_sys System on which attention was injected.
         * @param[in] i_attn Attention that was injected.
         * @param[in] i_count number of attentions currently present.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processPutAttention(
                FakeSystem & i_sys,
                const PRDF::AttnData & i_attn,
                uint64_t i_count);

        /**
         * @brief processClearAttention Process cleared attention.
         *
         * Fake implemenation of local Firs.  Clears GFIR
         * when appropriate.
         *
         * @param[in] i_sys System on which attention was cleared.
         * @param[in] i_attn Attention that was cleared.
         * @param[in] i_count number of attentions currently present.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processClearAttention(
                FakeSystem & i_sys,
                const PRDF::AttnData & i_attn,
                uint64_t i_count);

    private:

        /**
         * @brief iv_type The GFIR instance associated with this element.
         */
        PRDF::ATTENTION_VALUE_TYPE iv_type;

        /**
         * @brief iv_address GFIR address for type.
         */
        uint64_t iv_address;

        /**
         * @brief iv_writebits GFIR checkbits for type.
         */
        uint64_t iv_writebits;
};
}
#endif