diff options
Diffstat (limited to 'importtemp/fapi2/include/fapi2_hw_access.H')
| -rw-r--r-- | importtemp/fapi2/include/fapi2_hw_access.H | 463 |
1 files changed, 0 insertions, 463 deletions
diff --git a/importtemp/fapi2/include/fapi2_hw_access.H b/importtemp/fapi2/include/fapi2_hw_access.H deleted file mode 100644 index fe310df7..00000000 --- a/importtemp/fapi2/include/fapi2_hw_access.H +++ /dev/null @@ -1,463 +0,0 @@ -/* IBM_PROLOG_BEGIN_TAG */ -/* This is an automatically generated prolog. */ -/* */ -/* $Source: hwpf/fapi2/include/fapi2_hw_access.H $ */ -/* */ -/* IBM CONFIDENTIAL */ -/* */ -/* EKB Project */ -/* */ -/* COPYRIGHT 2012,2015 */ -/* [+] International Business Machines Corp. */ -/* */ -/* */ -/* The source code for this program is not published or otherwise */ -/* divested of its trade secrets, irrespective of what has been */ -/* deposited with the U.S. Copyright Office. */ -/* */ -/* IBM_PROLOG_END_TAG */ -/// -/// @file fapi2_hw_access.H -/// @brief Common file that defines the hardware access functions that -/// platform code must implement. -/// - -#ifndef _FAPI2_COMMON_HWACCESS_H_ -#define _FAPI2_COMMON_HWACCESS_H_ - -#ifdef FAPI_SUPPORT_SPY_AS_ENUM - #include <spy_ids.H> - typedef uint64_t spyId_t; -#endif - -#include <stdint.h> -#include <thread> -#include <buffer.H> - -// variable_buffer isn't supported on PPE -#ifndef __PPE__ - #include <variable_buffer.H> -#endif - -#include <return_code.H> -#include <target.H> -#include <hw_access_def.H> -#include <plat_hw_access.H> - -#ifdef FAPI_SUPPORT_MULTI_SCOM - #include <multi_scom.H> -#endif - -namespace fapi2 -{ -//-------------------------------------------------------------------------- -// PIB Error Functions -//-------------------------------------------------------------------------- - -/// @brief Sets the PIB error mask - platform dependant -/// @param[in] i_mask The new error mask -inline void setPIBErrorMask(uint8_t i_mask); - -/// @brief Gets the PIB error mask - platform dependant -/// @return uint8_t The current PIB error mask -inline uint8_t getPIBErrorMask(void); - -//-------------------------------------------------------------------------- -// Operational Mode Error Functions -//-------------------------------------------------------------------------- - -/// @brief Sets the operational mode -/// @param[in] i_mode The new mode -inline void setOpMode(const OpModes i_mode); - -/// @brief Gets the operational mode -/// @return the operational mode -inline OpModes getOpMode(void); - -//-------------------------------------------------------------------------- -// HW Communication Functions -//-------------------------------------------------------------------------- - -/// @brief Reads a SCOM register from a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address SCOM register address to read from. -/// @param[out] o_data Buffer that holds data read from HW target. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode getScom(const Target<K>& i_target, const uint64_t i_address, - buffer<uint64_t>& o_data); - -/// @brief Writes a SCOM register on a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address SCOM register address to write to. -/// @param[in] i_data Buffer that holds data to write into address. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode putScom(const Target<K>& i_target, const uint64_t i_address, - const buffer<uint64_t> i_data); - -/// @brief Writes a SCOM register under mask on a chip -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address SCOM register address to write to. -/// @param[in] i_data Buffer that holds data to write into address. -/// @param[in] i_mask Buffer that holds the mask value. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode putScomUnderMask(const Target<K>& i_target, - const uint64_t i_address, - const buffer<uint64_t> i_data, - const buffer<uint64_t> i_mask); - -/// @brief Reads a CFAM register from a chip. -/// CFAM register is 32-bit wide. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address CFAM register address to read from. -/// @param[out] o_data Buffer that holds data read from HW target. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode getCfamRegister(const Target<K>& i_target, - const uint32_t i_address, - buffer<uint32_t>& o_data); - -/// @brief Writes a CFAM register on a chip. -/// CFAM register is 32-bit wide. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address CFAM register address to write to. -/// @param[in] i_data Buffer that holds data to write into address. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode putCfamRegister(const Target<K>& i_target, - const uint32_t i_address, - const buffer<uint32_t> i_data); - -/// @brief Read-modify-write a CFAM register on a chip. -/// CFAM register is 32-bit wide. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target HW target to operate on. -/// @param[in] i_address CFAM register address to modify. -/// @param[in] i_data Buffer that holds data to be modified. -/// @param[in] i_modifyMode The modify mode (or/and/xor). -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode modifyCfamRegister(const Target<K>& i_target, - const uint32_t i_address, - const buffer<uint32_t> i_data, - const ChipOpModifyMode i_modifyMode); - -// variable_buffer isn't supported on PPE -#ifndef __PPE__ -/// @brief Reads a ring from a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_address Ring address to read from. -/// @param[out] o_data Buffer that holds data read from HW target. -/// @param[in] i_ringMode Ring operation mode. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode getRing(const Target<K>& i_target, - const scanRingId_t i_address, - variable_buffer& o_data, - const RingMode i_ringMode = 0); - -/// @brief Writes a ring to a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_address Ring address to write to. -/// @param[in] i_data Buffer that contains RS4 compressed ring data -/// to write into address -/// @param[in] i_ringMode Ring operation mode. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode putRing(const Target<K>& i_target, - const scanRingId_t i_address, - const variable_buffer& i_data, - const RingMode i_ringMode = 0); - - -/// @brief Read-modify-write a ring on a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_address Ring address to modify. -/// @param[in] i_data Buffer that contains RS4 compressed ring data -/// to be modified. -/// @param[in] i_modifyMode The modify mode (or/and/xor) -/// @param[in] i_ringMode Ring operation mode. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -template< TargetType K > -inline ReturnCode modifyRing(const Target<K>& i_target, - const scanRingId_t i_address, - const variable_buffer& i_data, - const ChipOpModifyMode i_modifyMode, - const RingMode i_ringMode = 0); -#endif - -#ifdef FAPI_SUPPORT_MULTI_SCOM -/// @brief Performs a multiple SCOM operation -/// This interface performs multiple SCOM operations on a chip in the -/// order specified by the input MultiScom object. -/// See fapiMultiScom.H for details of how to populate the MultiScom -/// object with SCOM operations. -/// -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in,out] io_multiScomObj Reference to a MultiScom object, -/// pre-populated with SingleScomInfo entries -/// to perform multiple SCOMs on input target -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -/// -/// @note This is a synchronous interface and would return after all the -/// SCOM operations are completed or on the first failed operation -/// -/// @note SCOMs will be performed in the order they were added to the -/// input MultiScom object -/// -/// @note In case of errors, the platform code is responsible to collect -/// and add all the required error info and FFDC into the error data -/// for debugging -/// -/// @note If the SCOM operations added are specific to a processor chip, -/// then the FSI Shift Engine configured in scatter-gather DMA mode -/// extension would be used to execute the SCOM operations in a -/// performance optimize mode. In this mode, the special -/// SCOM_BULK_READ_MODE and SCOM_BULK_WRITE_MODE operations are -/// supported that allow a large bulk of SCOM access (in multiple of -/// 64 bits) for targets that support auto-increment. The -/// SCOM_WRITE_UNDER_MASK operation is not supported in this mode -/// -/// @note If the SCOM operations added are specific to a memory buffer -/// chip, then the regular SCOM engine is used to execute the SCOM -/// operations. SCOM_WRITE_UNDER_MASK operation is supported in -/// this mode, but the special SCOM_BULK_READ_MODE and -/// SCOM_BULK_WRITE_MODE operations are not supported due to -/// hardware limitations. -/// -template< TargetType K > -fapi2::ReturnCode multiScom (const Target<K>& i_target, - MultiScom& io_multiScomObj); -#endif - -// -------------------------------------------------------------------------- -// NOTE: -// Implement platform Spy access functions if platform supports them. -// -------------------------------------------------------------------------- - -// variable_buffer isn't supported on PPE -#ifndef __PPE__ -/// @brief Reads a spy from a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy whose data to be read. -/// @param[out] o_data Buffer that holds data read from HW target. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -/// -/// @note: The string version is only supported for cronus. -/// -/// The fapi design to support both FSP and cronus use of get and -/// put spy functions is dependant on the SPY names being expanded -/// to resemble a valid C identifier. This design places some -/// restrictions on the SPY names which can be used. -/// -/// 1. if the spy name contains a # procedure writers should replace -/// it with an __P__ for example - -/// -/// ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS -/// becomes -/// ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS -/// -/// 2. if the spy name has a number following a "." it must have an -/// underscore prepended to the number. -/// -/// EH.TPCHIP.2KX100_ARY_CLK_EDGES_DLY -/// becomes -/// EH.TPCHIP._2KX100_ARY_CLK_EDGES_DLY -/// -/// Example SPY name: -/// The hardware procedure should call the function like: -/// -/// ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS -/// -/// fapi2::ReturnCode rc = fapiGetSpy( targ, -/// ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS, data ); -/// -/// @note The ID is not in quotes the fapi code will handle adding -/// the quotes for the cronus environment -#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(DOXYGEN) - -#define FAPI_GET_SPY(TARGET, ID, DATA) fapi2::getSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA) - -template< TargetType K > -inline ReturnCode getSpy(const Target<K>& i_target, - const spyId_t i_spyId, - variable_buffer& o_data); -#endif - -#if defined(FAPI_SUPPORT_SPY_AS_STRING) || defined(DOXYGEN) - -#define FAPI_GET_SPY(TARGET, ID, DATA) fapi2::getSpy(TARGET, #ID, DATA) - -template< TargetType K > -inline ReturnCode getSpy(const Target<K>& i_target, - const char* const i_spyId, - variable_buffer& o_data); -#endif - -/// @brief Writes a spy on a chip. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy to write data to. -/// @param[out] i_data Buffer that holds data to write into spy. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -/// -/// @note: The string version is only supported for cronus. -/// -/// The fapi design to support both FSP and cronus use of get and -/// put spy functions is dependent on the SPY names being expanded -/// to resemble a valid C identifier. This design places some -/// restrictions on the SPY names which can be used. -/// -/// 1. if the spy name contains a # procedure writers should replace -/// is with an __P__ for example - -/// -/// ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS -/// becomes -/// ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS -/// -/// 2. if the spy name has a number following a "." it must have an -/// underscore prepended to the number. -/// -/// EH.TPCHIP.2KX100_ARY_CLK_EDGES_DLY -/// becomes -/// EH.TPCHIP._2KX100_ARY_CLK_EDGES_DLY -/// -/// Example SPY name: -/// The hardware procedure should call the function like: -/// -/// ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS -/// -/// fapi2::ReturnCode rc = fapiPutSpy( targ, -/// ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS, data ); -/// -/// @note The ID is not in quotes the fapi code will handle adding -/// the quotes for the cronus environment -/// -#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(DOXYGEN) - -#define FAPI_PUT_SPY(TARGET, ID, DATA) fapi2::putSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA) - -template< TargetType K > -inline ReturnCode putSpy(const Target<K>& i_target, - const spyId_t i_spyId, - const variable_buffer& i_data); -#endif - -#if defined(FAPI_SUPPORT_SPY_AS_STRING) || defined(DOXYGEN) - -#define FAPI_PUT_SPY(TARGET, ID, DATA) fapi2::putSpy(TARGET, #ID, DATA) - -template< TargetType K > -inline ReturnCode putSpy(const Target<K>& i_target, - const char* const i_spyId, - const variable_buffer& i_data); - -template< TargetType K > -inline ReturnCode putSpy(const Target<K>& i_target, - const char* const i_spyId, - const char* i_enum); -#endif - -/// @brief Writes spy data into a buffer holding ring data image -/// This API is used by L2/L3 repair to put column repair data -/// into a ring buffer image. -/// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy. -/// @param[in] i_data Buffer that holds spy data to write into ring -/// image. -/// @param[out] o_data Buffer that holds updated ring image. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -/// -/// @note: The string version is only supported for cronus. -/// -/// The fapi design to support both FSP and cronus use of get and -/// put spy functions is dependent on the SPY names being expanded -/// to resemble a valid C identifier. This design places some -/// restrictions on the SPY names which can be used. -/// -/// See fapiPutSpy for details on spy id specifics. -/// -#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(DOXYGEN) - -#define FAPI_PUT_SPY_IMAGE(TARGET, ID, DATA1, DATA2) \ - fapi2::putSpyImage(TARGET, FAPI_SPY_NAMES::ID.value, \ - DATA1, DATA2) - -template< TargetType K > -inline ReturnCode putSpyImage(const Target<K>& i_target, - const spyId_t i_spyId, - const variable_buffer& i_data, - variable_buffer& o_imageData); -#endif - -#if defined(FAPI_SUPPORT_SPY_AS_STRING) || defined(DOXYGEN) - -#define FAPI_PUT_SPY_IMAGE(TARGET, ID, DATA1, DATA2) \ - fapi2::putSpyImage(TARGET, #ID, DATA1,DATA2) - -template< TargetType K > -inline ReturnCode putSpyImage(const Target<K>& i_target, - const char* const i_spyId, - const variable_buffer& i_data, - variable_buffer& o_imageData); -#endif - -/// @brief Reads spy data from a ring image buffer -/// @param[in] i_target Target to operate on -/// @param[in] i_spyId The spy's id -/// @param[out] o_data Buffer that holds data read from ring image. -/// @param[in] i_imageData Buffer that holds ring image to read data -/// from. -/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. -/// -/// @note: The string version is only supported for cronus. -/// -/// The fapi design to support both FSP and cronus use of get and -/// put spy functions is dependent on the SPY names being expanded -/// to resemble a valid C identifier. This design places some -/// restrictions on the SPY names which can be used. -/// -/// See fapiPutSpy for details on spy id specifics. -/// -#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(DOXYGEN) - -#define FAPI_GET_SPY_IMAGE(TARGET, ID, DATA1, DATA2) \ - fapi2:getSpyImage(TARGET, FAPI_SPY_NAMES::ID.value, \ - DATA1, DATA2) - -template< TargetType K > -inline ReturnCode getSpyImage(const Target<K>& i_target, - const spyId_t i_spyId, - variable_buffer& o_data, - const variable_buffer& i_imageData); -#endif - -#if defined(FAPI_SUPPORT_SPY_AS_STRING) || defined(DOXYGEN) - -#define FAPI_GET_SPY_IMAGE(TARGET, ID, DATA1, DATA2) \ - fapi2::getSpyImage(TARGET, #ID, DATA1,DATA2) - -template< TargetType K > -inline ReturnCode getSpyImage(const Target<K>& i_target, - const char* const i_spyId, - variable_buffer& o_data, - const variable_buffer& i_imageData); -#endif - -#endif // PPE -}; - -#endif // _FAPI2_HWACCESS_H_ |
