/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: import/chips/p9/procedures/hwp/lib/p9_intr_regs.H $           */
/*                                                                        */
/* OpenPOWER HCODE Project                                                */
/*                                                                        */
/* COPYRIGHT 2016,2017                                                    */
/* [+] 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  p9_intr_regs.H
/// @brief Dump a PPE engine's state.
///
/// *HWP HW Owner        : Ashish More <ashish.more.@in.ibm.com>
/// *HWP HW Backup Owner : Brian Vanderpool <vanderp@us.ibm.com>
/// *HWP FW Owner        : Sangeetha T S <sangeet2@in.ibm.com>
/// *HWP Team            : PM
/// *HWP Level           : 2
/// *HWP Consumed by     : SBE, Cronus

#include <p9_ppe_utils.H>
#include <map>

#ifndef __P9_INTR_REGS_H__
#define __P9_INTR_REGS_H__
/**
 * @brief Offsets from base address for CME regs.
 */
enum INTR_REGS
{
    //Interrupts
    EISR    = 0x25,
    EIMR    = 0x26,
    EIPR    = 0x27,
    EITR    = 0x28,
    EISTR   = 0x29,
    EINR    = 0x2A,

};

const std::map<uint16_t, std::string> v_intr_num_name =
{
    { EISR,    "EISR" },
    { EIMR,    "EIMR" },
    { EIPR,    "EIPR" },
    { EITR,    "EITR" },
    { EISTR,   "EISTR"},
    { EINR,    "EINR" },
};

/// @typedef p9_intr_regs_FP_t
/// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode (*p9_intr_regs_FP_t) (
    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
    const uint64_t, const uint8_t i_name, std::vector<SCOMRegValue_t>& v_intr_regs_value );

extern "C"
{

/// @brief Dump the PPE state based on the based base address
/// @param [in] i_target TARGET_TYPE_PROC_CHIP
/// @param [in] i_base_address Base offset to be used for all accesses
/// @return FAPI2_RC_SUCCESS
    fapi2::ReturnCode
    p9_intr_regs(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
                 const uint64_t i_base_address, const uint8_t  i_name , std::vector<SCOMRegValue_t>& v_intr_regs_value);

} // extern C

#endif  // __P9_INTR_REGS_H__