Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added PRD Wrapper file for hwp invoke commands
Change-Id: I173a6e3f07848791ca965040c967dcf0f637b257 Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/75543 Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com> Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com> Reviewed-by: Louis Stermole <stermole@us.ibm.com> Reviewed-by: STEPHEN GLANCY <sglancy@us.ibm.com> Reviewed-by: Jennifer A Stofer <stofer@us.ibm.com> Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/80643 Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com> Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com> Reviewed-by: Christian R Geddes <crgeddes@us.ibm.com>
- Loading branch information
1 parent
fd400b1
commit 4d3e1f1
Showing
1 changed file
with
297 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,297 @@ | ||
| /* IBM_PROLOG_BEGIN_TAG */ | ||
| /* This is an automatically generated prolog. */ | ||
| /* */ | ||
| /* $Source: src/import/generic/memory/lib/prd/hwp_wrappers.H $ */ | ||
| /* */ | ||
| /* OpenPOWER HostBoot Project */ | ||
| /* */ | ||
| /* Contributors Listed Below - COPYRIGHT 2019 */ | ||
| /* [+] 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 hwp_wrappers.H | ||
| /// @brief Main wrapper file for PRD calling memory procedure code | ||
| /// | ||
| // *HWP HWP Owner: Matthew Hickman <Matthew.Hickman@ibm.com> | ||
| // *HWP HWP Backup: Andre Marin <aamarin@us.ibm.com> | ||
| // *HWP Team: Memory | ||
| // *HWP Level: 3 | ||
| // *HWP Consumed by: HB:FSP | ||
|
|
||
| #ifndef _HWP_WRAPPERS_H_ | ||
| #define _HWP_WRAPPERS_H_ | ||
|
|
||
| #include <fapi2.H> | ||
| #include <generic/memory/lib/utils/mcbist/gen_mss_mcbist.H> | ||
| #include <generic/memory/lib/utils/mcbist/gen_mss_memdiags.H> | ||
|
|
||
| /// | ||
| /// @brief Memdiags stop command wrapper for Nimbus | ||
| /// @param[in] i_target the target | ||
| /// @return FAPI2_RC_SUCCESS iff ok | ||
| /// | ||
| fapi2::ReturnCode nim_stop( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target ) | ||
| { | ||
| return mss::memdiags::stop<mss::mc_type::NIMBUS>(i_target); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Memdiags stop command wrapper for Explorer | ||
| /// @param[in] i_target the target | ||
| /// @return FAPI2_RC_SUCCESS iff ok | ||
| /// | ||
| fapi2::ReturnCode exp_stop( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target ) | ||
| { | ||
| return mss::memdiags::stop<mss::mc_type::EXPLORER>(i_target); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Memdiags Super Fast Init command wrapper for Nimbus | ||
| /// @param[in] i_target the target behind which all memory should be initialized | ||
| /// @param[in] i_pattern an index representing a pattern to use to init memory (defaults to 0) | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode nim_sf_init( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, | ||
| const uint64_t i_pattern = PATTERN_0 ) | ||
| { | ||
| return mss::memdiags::sf_init<mss::mc_type::NIMBUS>(i_target, i_pattern); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Memdiags Super Fast Init command wrapper for Nimbus | ||
| /// @param[in] i_target the target behind which all memory should be initialized | ||
| /// @param[in] i_pattern an index representing a pattern to use to init memory (defaults to 0) | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode exp_sf_init( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, | ||
| const uint64_t i_pattern = PATTERN_0 ) | ||
| { | ||
| return mss::memdiags::sf_init<mss::mc_type::EXPLORER>(i_target, i_pattern); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Memdiags Super Fast Read command wrapper for Nimbus | ||
| /// @param[in] i_target the target behind which all memory should be read | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_address mcbist::address representing the address from which to start. | ||
| // Defaults to the first address behind the target | ||
| /// @param[in] i_end whether to end, and where | ||
| /// Defaults to stop after slave rank | ||
| /// @param[in] i_end_address mcbist::address representing the address to end. | ||
| // Defaults to TT::LARGEST_ADDRESS | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode nim_sf_read( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, | ||
| const stop_conditions<mss::mc_type::NIMBUS>& i_stop, | ||
| const mss::mcbist::address& i_address = mss::mcbist::address(), | ||
| const end_boundary i_end = end_boundary::STOP_AFTER_SLAVE_RANK, | ||
| const mss::mcbist::address& i_end_address = mss::mcbist::address( | ||
| mcbistTraits<mss::mc_type::NIMBUS, fapi2::TARGET_TYPE_MCBIST>::LARGEST_ADDRESS) ) | ||
| { | ||
| return mss::memdiags::sf_read<mss::mc_type::NIMBUS>(i_target, i_stop, i_address, i_end, i_end_address); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Memdiags Super Fast Read command wrapper for Explorer | ||
| /// @param[in] i_target the target behind which all memory should be read | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_address mcbist::address representing the address from which to start. | ||
| // Defaults to the first address behind the target | ||
| /// @param[in] i_end whether to end, and where | ||
| /// Defaults to stop after slave rank | ||
| /// @param[in] i_end_address mcbist::address representing the address to end. | ||
| // Defaults to TT::LARGEST_ADDRESS | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode exp_sf_read( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, | ||
| const stop_conditions<mss::mc_type::EXPLORER>& i_stop, | ||
| const mss::mcbist::address& i_address = mss::mcbist::address(), | ||
| const end_boundary i_end = end_boundary::STOP_AFTER_SLAVE_RANK, | ||
| const mss::mcbist::address& i_end_address = mss::mcbist::address( | ||
| mcbistTraits<mss::mc_type::EXPLORER, fapi2::TARGET_TYPE_OCMB_CHIP>::LARGEST_ADDRESS) ) | ||
| { | ||
| return mss::memdiags::sf_read<MC>(i_target, i_stop, i_address, i_end, i_end_address); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Continuous background scrub command wrapper for Nimbus | ||
| /// @param[in] i_target the target behind which all memory should be scrubbed | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_speed the speed to scrub | ||
| /// @param[in] i_address mcbist::address representing the address from which to start. | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode nim_background_scrub( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, | ||
| const stop_conditions<mss::mc_type::NIMBUS>& i_stop, | ||
| const speed i_speed, | ||
| const mss::mcbist::address& i_address ) | ||
| { | ||
| return mss::memdiags::background_scrub<mss::mc_type::NIMBUS>(i_target, i_stop, i_speed, i_address); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Continuous background scrub command wrapper for Explorer | ||
| /// @param[in] i_target the target behind which all memory should be scrubbed | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_speed the speed to scrub | ||
| /// @param[in] i_address mcbist::address representing the address from which to start. | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode exp_background_scrub( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, | ||
| const stop_conditions<mss::mc_type::EXPLORER>& i_stop, | ||
| const speed i_speed, | ||
| const mss::mcbist::address& i_address ) | ||
| { | ||
| return mss::memdiags::background_scrub<mss::mc_type::EXPLORER>(i_target, i_stop, i_speed, i_address); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Targeted scrub command wrapper for Nimbus | ||
| /// @param[in] i_target the target behind which all memory should be scrubbed | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_speed the speed to scrub | ||
| /// @param[in] i_start_address mcbist::address representing the address from which to start. | ||
| /// @param[in] i_end_address mcbist::address representing the address at which to end. | ||
| /// @param[in] i_end whether to end, and where | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode nim_targeted_scrub( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, | ||
| const stop_conditions<mss::mc_type::NIMBUS>& i_stop, | ||
| const mss::mcbist::address& i_start_address, | ||
| const mss::mcbist::address& i_end_address, | ||
| const end_boundary i_end ) | ||
| { | ||
| return mss::memdiags::targeted_scrub<mss::mc_type::NIMBUS>(i_target, i_stop, i_start_address, i_end_address, i_end); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Targeted scrub command wrapper for Explorer | ||
| /// @param[in] i_target the target behind which all memory should be scrubbed | ||
| /// @param[in] i_stop stop conditions | ||
| /// @param[in] i_speed the speed to scrub | ||
| /// @param[in] i_start_address mcbist::address representing the address from which to start. | ||
| /// @param[in] i_end_address mcbist::address representing the address at which to end. | ||
| /// @param[in] i_end whether to end, and where | ||
| /// @return FAPI2_RC_SUCCESS iff everything ok | ||
| /// | ||
| fapi2::ReturnCode exp_targeted_scrub( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, | ||
| const stop_conditions<mss::mc_type::EXPLORER>& i_stop, | ||
| const mss::mcbist::address& i_start_address, | ||
| const mss::mcbist::address& i_end_address, | ||
| const end_boundary i_end ) | ||
| { | ||
| return mss::memdiags::targeted_scrub<mss::mc_type::EXPLORER>(i_target, i_stop, i_start_address, i_end_address, i_end); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Continue current command wrapper for Nimbus | ||
| /// @param[in] i_target the target | ||
| /// @param[in] i_end whether to end, and where (default - don't stop at end of rank) | ||
| /// @param[in] i_stop stop conditions (default - 0 meaning 'don't change conditions') | ||
| /// @param[in] i_speed the speed to scrub (default - SAME_SPEED meaning leave speed untouched) | ||
| /// @return FAPI2_RC_SUCCESS iff ok | ||
| /// | ||
| fapi2::ReturnCode nim_continue_cmd( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, | ||
| const end_boundary i_end = end_boundary::DONT_CHANGE, | ||
| const stop_conditions<mss::mc_type::NIMBUS>& i_stop = stop_conditions<mss::mc_type::NIMBUS> | ||
| (stop_conditions<mss::mc_type::NIMBUS>::DONT_CHANGE), | ||
| const speed i_speed = speed::SAME_SPEED ) | ||
| { | ||
| return mss::memdiags::continue_cmd<mss::mc_type::NIMBUS>(i_target, i_end, i_stop, i_speed); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Continue current command wrapper for Explorer | ||
| /// @param[in] i_target the target | ||
| /// @param[in] i_end whether to end, and where (default - don't stop at end of rank) | ||
| /// @param[in] i_stop stop conditions (default - 0 meaning 'don't change conditions') | ||
| /// @param[in] i_speed the speed to scrub (default - SAME_SPEED meaning leave speed untouched) | ||
| /// @return FAPI2_RC_SUCCESS iff ok | ||
| /// | ||
| fapi2::ReturnCode exp_continue_cmd( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, | ||
| const end_boundary i_end = end_boundary::DONT_CHANGE, | ||
| const stop_conditions<mss::mc_type::EXPLORER>& i_stop = stop_conditions<mss::mc_type::EXPLORER> | ||
| (stop_conditions<mss::mc_type::EXPLORER>::DONT_CHANGE), | ||
| const speed i_speed = speed::SAME_SPEED ) | ||
| { | ||
| return mss::memdiags::continue_cmd<mss::mc_type::EXPLORER>(i_target, i_end, i_stop, i_speed); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Nimbus | ||
| /// @param[in] i_target the target to effect | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states nim_is_broadcast_capable(const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target) | ||
| { | ||
| return is_broadcast_capable<mss::mc_type::NIMBUS>(i_target); | ||
| } | ||
|
|
||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Nimbus | ||
| /// @param[in] i_targets the vector of targets to analyze | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states nim_is_broadcast_capable(const std::vector<fapi2::Target<fapi2::TARGET_TYPE_MCBIST>>& i_targets) | ||
| { | ||
| return is_broadcast_capable<mss::mc_type::NIMBUS>(i_targets); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Nimbus | ||
| /// @param[in] i_kinds the dimms to effect | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states nim_is_broadcast_capable(const std::vector<mss::dimm::kind>& i_kinds); | ||
| { | ||
| return is_broadcast_capable(i_kinds); | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Explorer | ||
| /// @param[in] i_target the target to effect | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states exp_is_broadcast_capable(const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target) | ||
| { | ||
| return mss::states::NO; | ||
| } | ||
|
|
||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Explorer | ||
| /// @param[in] i_targets the vector of targets to analyze | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states exp_is_broadcast_capable(const std::vector<fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>>& i_targets) | ||
| { | ||
| return mss::states::NO; | ||
| } | ||
|
|
||
| /// | ||
| /// @brief Broadcast mode check wrapper for Explorer | ||
| /// @param[in] i_kinds the dimms to effect | ||
| /// @return o_capable - yes iff these vector of targets are broadcast capable | ||
| /// | ||
| const mss::states exp_is_broadcast_capable(const std::vector<mss::dimm::kind>& i_kinds); | ||
| { | ||
| return mss::states::NO; | ||
| } | ||
|
|
||
| #endif |