/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: import/chips/p9/procedures/ppe_closed/lib/p9_hcd_block_copy.h $ */
/*                                                                        */
/* OpenPOWER HCODE Project                                                */
/*                                                                        */
/* COPYRIGHT 2015,2018                                                    */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __P9_HCD_BLOCK_COPY_H__
#define __P9_HCD_BLOCK_COPY_H__
#include <stdint.h>

//config values associated with CME Block Copy Engine.
typedef enum
{
    ENABLE_WR_SCOPE         = 0x0000000000000010,

// Due to HW423589, need to enable vector scope to all targets
#if NIMBUS_DD_LEVEL == 20 || NIMBUS_DD_LEVEL >= 22
    ENABLE_RD_SCOPE         = 0x0000000000000020,
    VG_TARGET_1S            = 0x0000000000000008,
#else
    ENABLE_RD_SCOPE         = 0x0000000000000040,
    VG_TARGET_1S            = 0x0000000000000000,
#endif

    BLOCK_COPY_SIZE_1MB     = 0x0000000000000001,
    START_BLOCK_COPY        = 0x2000000000000000,
    RD_FROM_HOMER_TO_SRAM   = 0x0800000000000000,
    SEL_BCEBAR0             = 0x0000000000000000,
    SEL_BCEBAR1             = 0x0400000000000000,
    SET_RD_PRIORITY_0       = 0x0000000000000000,
    SET_SBASE               = 0x0000000000000000,
    CHECK_BUSY              = 0x8000000000000000,
    CHECK_ERROR             = 0x4000000000000000,
    BAR_INDEX_0             = 0x00,
    BAR_INDEX_1             = 0x01,

} BceConfigVal_t;

//Return codes associated with Block Copy Engine.
typedef enum
{
    BLOCK_COPY_SUCCESS      = 0,
    BLOCK_COPY_SCOM_FAIL    = 1,
    BLOCK_COPY_FAILED       = 2,
    BLOCK_COPY_INVALID_ARG  = 3,
    BLOCK_COPY_IN_PROGRESS  = 4,
} BceReturnCode_t;

// Bit shifts needed for various fields of CME's BCESCR register
enum
{
    BASE_SHIFT_POS      =   20,
    NUM_BLK_SHIFT_POS   =   36,
    SBASE_SHIFT_POS     =   24,
    CME_BASE_ADDRESS    =   0x10012000,
};

/// @brief accomplishes block copy from mainstore to CME SRAM.
/// @param [in]  i_cmeStartBlk   Block no associated with CME SRAM( a block is 32B )
/// @param [in]  i_blockLength   number of block to be transferred.
/// @param [in]  i_cmePos        Position of CME in the P9 chip.
/// @param [in]  i_plat          platform requesting block copy transfer.
/// @param [in]  i_mbaseVal      main memory block index from where block copy begins.
/// @note  It is a non blocking function. It doesn't poll the status and error bits.
///        It is expected to be called by CME and SGPE only.
void startCmeBlockCopy( uint64_t i_cmeStartBlk, uint32_t i_blockLength,
                        uint32_t i_cmePos, uint8_t i_barIndex, uint32_t i_mbaseVal );

void startCmeBlockCopyWriteHomer( uint64_t i_cmeStartBlk, uint32_t i_blockLength,
                                  uint32_t i_cmePos, uint8_t i_barIndex, uint32_t i_mbaseVal);

/// @brief accomplishes block copy from mainstore to CME SRAM.
/// @param [in]  i_cmePos        Position of CME in the P9 chip.
/// @param [in]  i_plat          platform requesting block copy transfer.
/// @retVal BLOCK_COPY_SUCCESS is block succeeds, return code otherwise.
/// @note  It is a non blocking function. It doesn't poll the status and error bits.
///        It is expected to be called by CME and SGPE only.
BceReturnCode_t checkCmeBlockCopyStatus( uint32_t i_cmePos);

#endif