diff options
author | Matt Derksen <mderkse1@us.ibm.com> | 2019-08-16 08:56:50 -0500 |
---|---|---|
committer | Daniel M Crowell <dcrowell@us.ibm.com> | 2019-09-25 14:30:00 -0500 |
commit | 56574b602999b7f4e31c8b19bb3b72fbde152700 (patch) | |
tree | f21bbe8e9e8b0ade638c2b2b4fd92a821f11a6d1 /src/import/chips | |
parent | b23632654208299109c98b42a30e3935424330ed (diff) | |
download | talos-hostboot-56574b602999b7f4e31c8b19bb3b72fbde152700.tar.gz talos-hostboot-56574b602999b7f4e31c8b19bb3b72fbde152700.zip |
Support EXP_FW_LOG command to get Explorer FW logs
Framework to send inband command and a proof of concept
adding explorer error log data via collectFfdc RC.
Change-Id: I41be5598eb6fb3239fd933e0a0563d1a99ed2fa0
RTC:205128
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/82372
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M Crowell <dcrowell@us.ibm.com>
Diffstat (limited to 'src/import/chips')
9 files changed, 794 insertions, 5 deletions
diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.C b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.C new file mode 100644 index 000000000..ad2c20a97 --- /dev/null +++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.C @@ -0,0 +1,109 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.C $ */ +/* */ +/* 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 exp_fw_log_data.C +/// +/// @brief Collects Explorer firmware log data +// ---------------------------------------- +// *HWP HWP Owner: Matt Derksen <mderkse1@us.ibm.com> +// *HWP HWP Backup: Louis Stermole <stermole@us.ibm.com> +// *HWP Team: Memory +// *HWP Level: 2 +// *HWP Consumed by: HB +// ---------------------------------------- +#include <exp_fw_log_data.H> +#include <fapi2.H> +#include <lib/inband/exp_inband.H> +#include <lib/inband/exp_fw_log.H> +#include <lib/shared/exp_consts.H> +#include <exp_data_structs.H> +#include <generic/memory/lib/utils/c_str.H> + + +extern "C" +{ + /// See header + fapi2::ReturnCode exp_active_log( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_ocmbTarget, + std::vector<uint8_t>& o_data) + { + host_fw_command_struct l_active_errl_cmd; + host_fw_response_struct l_response; + + // Set up the command packet + mss::exp::ib::build_log_cmd(i_ocmbTarget, + mss::exp::ib::SUB_CMD_READ_ACTIVE_LOG, + l_active_errl_cmd); + + // Send the command packet + FAPI_TRY(mss::exp::ib::putCMD(i_ocmbTarget, l_active_errl_cmd), + "exp_active_error_log: Failed putCMD() for %s!", + mss::c_str(i_ocmbTarget)); + + // Get the response + FAPI_TRY(mss::exp::ib::getRSP(i_ocmbTarget, l_response, o_data), + "exp_active_error_log: Failed getRSP() cmd " + "for %s!", mss::c_str(i_ocmbTarget)); + + // Check if cmd was successful + FAPI_TRY(mss::exp::ib::check_log_cmd_response(i_ocmbTarget, l_response), + "exp_active_error_log: Failed check_log_cmd_response()" + " for %s!", mss::c_str(i_ocmbTarget)); + + fapi_try_exit: + return fapi2::current_err; + } + + + /// See header + fapi2::ReturnCode exp_saved_log( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_ocmbTarget, + std::vector<uint8_t>& o_data) + { + host_fw_command_struct l_saved_log_cmd; + host_fw_response_struct l_response; + + // Set up the command packet + mss::exp::ib::build_log_cmd(i_ocmbTarget, + mss::exp::ib::SUB_CMD_READ_SAVED_LOG, + l_saved_log_cmd); + + // Send the command packet + FAPI_TRY(mss::exp::ib::putCMD(i_ocmbTarget, l_saved_log_cmd), + "exp_saved_log: Failed putCMD() for %s!", + mss::c_str(i_ocmbTarget)); + + // Get the response + FAPI_TRY(mss::exp::ib::getRSP(i_ocmbTarget, l_response, o_data), + "exp_saved_log: Failed getRSP() for %s!", + mss::c_str(i_ocmbTarget)); + + // Check if cmd was successful + FAPI_TRY(mss::exp::ib::check_log_cmd_response(i_ocmbTarget, l_response), + "exp_saved_log: Failed check_log_cmd_response()" + " for %s!", mss::c_str(i_ocmbTarget)); + fapi_try_exit: + return fapi2::current_err; + } +} diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.H b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.H new file mode 100644 index 000000000..4cfe074a1 --- /dev/null +++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.H @@ -0,0 +1,77 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_fw_log_data.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 exp_fw_log_data.H +/// @brief Procedure declaration to get Explorer log data +/// +// ---------------------------------------- +// *HWP HWP Owner: Matt Derksen <mderkse1@us.ibm.com> +// *HWP HWP Backup: Louis Stermole <stermole@us.ibm.com> +// *HWP Team: Memory +// *HWP Level: 2 +// *HWP Consumed by: HB +// ---------------------------------------- +#ifndef __EXP_FW_LOG_DATA__ +#define __EXP_FW_LOG_DATA__ + +#include <fapi2.H> +#include <vector> + +// Required for Cronus +typedef fapi2::ReturnCode (*exp_active_log_FP_t) ( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>&, + std::vector<uint8_t>& ); + +typedef fapi2::ReturnCode (*exp_saved_log_FP_t) ( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>&, + std::vector<uint8_t>& ); + +extern "C" +{ + + /// + /// @brief Grab active log entries from Explorer RAM + /// @param[in] i_target the controller + /// @param[out] o_data - where to put error log data + /// + /// @return FAPI2_RC_SUCCESS iff ok + /// + fapi2::ReturnCode exp_active_log( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_ocmbTarget, + std::vector<uint8_t>& o_data ); + + /// + /// @brief Grab saved log entries from Explorer SPI flash + /// @param[in] i_target the controller + /// @param[out] o_data - where to put error log data + /// + /// @return FAPI2_RC_SUCCESS iff ok + /// + fapi2::ReturnCode exp_saved_log( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_ocmbTarget, + std::vector<uint8_t>& o_data ); + +}// extern C +#endif diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.C b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.C new file mode 100644 index 000000000..f9c17f564 --- /dev/null +++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.C @@ -0,0 +1,139 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.C $ */ +/* */ +/* 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 exp_fw_log.C +/// +/// @brief Helpers to access explorer firmware logs + +// +// *HWP HWP Owner: Louis Stermole <stermole@us.ibm.com> +// *HWP FW Owner: Matt Derksen <mderkse1@us.ibm.com> +// *HWP Team: +// *HWP Level: 2 +// *HWP Consumed by: HB + +#include <exp_fw_log.H> +#include <fapi2.H> +#include <exp_inband.H> +#include <lib/shared/exp_consts.H> +#include <exp_data_structs.H> +#include <generic/memory/lib/utils/c_str.H> + + +namespace mss +{ +namespace exp +{ +namespace ib +{ + +/// +/// @brief Response parameters of Explorer Log commands +/// This is found in the response_argument field +typedef struct +{ + uint8_t op; /**< Firmware error log sub-cmd operation */ + uint8_t status; /**< Operation status */ + uint32_t err_code; /**< Specific error code if operation failed */ + uint32_t num_bytes_returned; /**< Number of bytes returned */ +} exp_fw_log_rsp_parms_struct_t; + +/// +/// @brief Operation status values +/// +enum +{ + STATUS_OP_FAILED = 0x00, + STATUS_OP_SUCCESSFUL = 0x01, +}; + +/// See header +void build_log_cmd( const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, + const exp_log_sub_cmd_op i_sub_op, + host_fw_command_struct& o_cmd ) +{ + // Issue EXP_FW_LOG cmd though EXP-FW REQ buffer + o_cmd.cmd_id = mss::exp::omi::EXP_FW_LOG; + o_cmd.cmd_flags = 0; + + // Host generated id number (returned in response packet) + // @todo RTC 210371 + //uint32_t l_counter = 0; + //FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_OCMB_COUNTER, i_target, l_counter)); + o_cmd.request_identifier = 0xabcd; + + if (i_sub_op == SUB_CMD_READ_SAVED_LOG) + { + o_cmd.request_identifier = 0xabce; + } + + o_cmd.cmd_length = 0; + + o_cmd.cmd_crc = 0xffffffff; + o_cmd.host_work_area = 0; + o_cmd.cmd_work_area = 0; + memset(o_cmd.padding, 0, sizeof(o_cmd.padding)); + + // Set the sub-command ID in the command argument field + o_cmd.command_argument[0] = i_sub_op; +} + +/// See header +fapi2::ReturnCode check_log_cmd_response( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, + const host_fw_response_struct& i_rsp ) +{ + std::vector<uint8_t> resp_arg; + uint32_t index = 0; + exp_fw_log_rsp_parms_struct_t l_rsp_args; + + //copy response_argument field into a vector that can be + //used by readCrctEndian() + resp_arg.assign(i_rsp.response_argument, + i_rsp.response_argument + ARGUMENT_SIZE); + + //convert fields to native endianness + FAPI_TRY(mss::exp::ib::readCrctEndian(resp_arg, index, l_rsp_args.op)); + FAPI_TRY(mss::exp::ib::readCrctEndian(resp_arg, index, l_rsp_args.status)); + FAPI_TRY(mss::exp::ib::readCrctEndian(resp_arg, index, l_rsp_args.err_code)); + FAPI_TRY(mss::exp::ib::readCrctEndian(resp_arg, index, l_rsp_args.num_bytes_returned)); + + // check if command was successful + FAPI_ASSERT(l_rsp_args.status == STATUS_OP_SUCCESSFUL, + fapi2::MSS_EXP_RSP_ARG_FAILED(). + set_TARGET(i_target). + set_RSP_ID(i_rsp.response_id). + set_ERROR_CODE(l_rsp_args.err_code), + "EXP_FW_LOG command 0x%02X failed for %s. " + "Status: 0x%02X, err_code 0x%04X, num_bytes_returned 0x%04X", + l_rsp_args.op, mss::c_str(i_target), l_rsp_args.status, + l_rsp_args.err_code, l_rsp_args.num_bytes_returned); + +fapi_try_exit: + return fapi2::current_err; +} + +}//ib namespace +}//exp namespace +}//mss namespace diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.H b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.H new file mode 100644 index 000000000..3817640be --- /dev/null +++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.H @@ -0,0 +1,104 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/inband/exp_fw_log.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 exp_fw_log.H +/// @brief Helpers to access explorer firmware logs +/// The Explorer firmware modules log pertinent data regarding +/// operations and errors, and the Host manages and accesses this +/// information by using the EXP_FW_LOG API command. The firmware +/// maintains the log in a circular buffer in RAM and in the event +/// of a processor exception, firmware assert, or other critical +/// condition the firmware saves the data in RAM to SPI flash. +/// Having the log stored in non-volatile memory allows post-analysis +/// of the log even if it requires a power-cycle to recover the system. +/// +// *HWP HWP Owner: Matt Derksen <mderkse1@us.ibm.com> +// *HWP HWP Backup: Louis Stermole <stermole@us.ibm.com> +// *HWP Team: Memory +// *HWP Level: 2 +// *HWP Consumed by: FSP:HB + +#ifndef __MSS_EXP_FW_LOG__ +#define __MSS_EXP_FW_LOG__ + +#include <fapi2.H> +#include <vector> +#include <exp_data_structs.H> + +namespace mss +{ +namespace exp +{ +namespace ib +{ +/// +/// @brief Defines the sub-commands available for the +/// EXP_FW_LOG command +/// +enum exp_log_sub_cmd_op +{ + // This is used to read log entries from the active + // firmware logfile stored in Explorer RAM + SUB_CMD_READ_ACTIVE_LOG = 0x01, + + // This is used to read log entries from the saved + // firmware logfile stored in Explorer SPI flash + SUB_CMD_READ_SAVED_LOG = 0x02, + + // This is used to clear the active logfile in Explorer RAM + SUB_CMD_CLEAR_ACTIVE_LOG = 0x03, + + // This is used to erase the saved logfile in Explorer SPI flash + SUB_CMD_ERASE_SAVED_LOG = 0x04, +}; + +/// +/// @brief Sets the command_argument fields for EXP_FW_LOG command +/// +/// @param[in] i_target - OCMB target +/// @param[in] i_sub_op - what sub-command of EXP_FW_LOG to use +/// @param[out] o_cmd - command packet to update +/// +void build_log_cmd(const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, + const exp_log_sub_cmd_op i_sub_op, + host_fw_command_struct& o_cmd ); + + +/// +/// @brief Checks the response of the EXP_FW_LOG command +/// +/// @param[in] i_target - OCMB target +/// @param[in] i_rsp - response portion of EXP_FW_ERROR_LOG (from getRsp()) +/// @return FAPI2_RC_SUCCESS iff ok +/// +fapi2::ReturnCode check_log_cmd_response( + const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target, + const host_fw_response_struct& i_rsp ); + +}//exp +}//mss +}//ib + +#endif diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H index e788d8bcd..6590df55f 100644 --- a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H +++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H @@ -374,8 +374,8 @@ enum cmd_and_response_id // find the flash loader version information EXP_FW_FLASH_LOADER_VERSION_INFO = 0x09, - // read the error logs from various modules of Explorer block - EXP_FW_ERROR_LOG_GET = 0x0A, + // read the FW logs from various modules of Explorer block + EXP_FW_LOG = 0x0A, }; /// diff --git a/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_collect_explorer_errors.xml b/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_collect_explorer_errors.xml new file mode 100644 index 000000000..d605771eb --- /dev/null +++ b/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_collect_explorer_errors.xml @@ -0,0 +1,49 @@ +<!-- IBM_PROLOG_BEGIN_TAG --> +<!-- This is an automatically generated prolog. --> +<!-- --> +<!-- $Source: src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_collect_explorer_errors.xml $ --> +<!-- --> +<!-- 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 --> +<hwpErrors> + <!-- ******************************************************************** --> + <hwpError> + <rc>RC_COLLECT_EXPLORER_ERROR</rc> + <description>Collects error log data from Explorer chip</description> + <collectFfdc>exp_collect_explorer_active_log, OCMB_CHIP_TARGET, EXP_ACTIVE_LOG_SIZE</collectFfdc> + <collectFfdc>exp_collect_explorer_saved_log, OCMB_CHIP_TARGET, EXP_SAVED_LOG_SIZE</collectFfdc> + <ffdc>OCMB_CHIP_TARGET</ffdc> + <ffdc>EXP_ACTIVE_LOG_SIZE</ffdc> + <ffdc>EXP_SAVED_LOG_SIZE</ffdc> + </hwpError> + <!-- ******************************************************************** --> + <hwpError> + <rc>RC_EXPLORER_ACTIVE_ERROR_LOG</rc> + <description>Collect active explorer errors during exp_collect_explorer_active_log</description> + <ffdc>UNIT_FFDC_EXP_ERROR</ffdc> + </hwpError> + <!-- ******************************************************************** --> + <hwpError> + <rc>RC_EXPLORER_SAVED_ERROR_LOG</rc> + <description>Collect saved explorer errors during exp_collect_explorer_saved_log</description> + <ffdc>UNIT_FFDC_EXP_ERROR</ffdc> + </hwpError> + <!-- ******************************************************************** --> +</hwpErrors> diff --git a/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.C b/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.C new file mode 100644 index 000000000..843da913f --- /dev/null +++ b/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.C @@ -0,0 +1,253 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.C $ */ +/* */ +/* OpenPOWER HostBoot Project */ +/* */ +/* Contributors Listed Below - COPYRIGHT 2016,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 exp_collect_explorer_log.C +/// +/// @brief Collects and adds Explorer logs to rc +//------------------------------------------------------------------------------ +// *HWP HW Owner : Matt Derksen +// *HWP HW Backup Owner : <> +// *HWP FW Owner : <> +// *HWP Level : 2 +// *HWP Consumed by : SE:HB +//------------------------------------------------------------------------------ + +#include <fapi2.H> +#include "exp_collect_explorer_log.H" +#include <exp_fw_log_data.H> + +struct explog_section_header_t +{ + uint16_t packet_num; // ordering byte (0 = first packet) + uint32_t offset_exp_log; // offset where data portion started in full explorer log + uint16_t error_data_size; // size of data portion following header + + explog_section_header_t() + : packet_num(0), + offset_exp_log(0), + error_data_size(0) + {} +} __attribute__((__packed__)); + +// 1st entry is most relevant traces so make it a small size so +// it won't be truncated from HWP error log +const size_t FIRST_PACKET_SIZE = 0x100; + +// Use a larger packet size for the rest of the remaining error data +// These aren't as important since they are older trace logs +const size_t FOLLOWING_PACKET_SIZE = 0x200; + +/** + * @brief Explorer Log type? + * + * The firmware maintains the log in a circular buffer in RAM (ACTIVE_LOG) and + * in the event of a processor exception, firmware assert, or other critical + * condition the firmware saves the data in RAM to SPI flash (SAVED_LOG). + * Having the log stored in non-volatile memory allows post-analysis + * of the log even if it requires a power-cycle to recover the system. + */ +enum exp_log_type : uint8_t +{ + ACTIVE_LOG = 1, // RAM error section + SAVED_LOG = 2 // SPI flash error section +}; + +/** + * @brief Main procedure to grab log traces from Explorer chip + * and append the trace data to HWP error (o_rc) + * + * @param[in] i_ocmb_chip - OCMB chip target + * @param[in] i_size - allowable total size (add entries upto this size) + * @param[in] i_log_type - what kind of explorer log to grab + * @param[out] o_rc - return code to add FFDC data to. + * + * @return FAPI2_RC_SUCCESS iff ok + */ +fapi2::ReturnCode exp_collect_explorer_logs(const fapi2::ffdc_t& i_ocmb_chip, + const fapi2::ffdc_t& i_size, + const exp_log_type i_log_type, + fapi2::ReturnCode& o_rc) +{ + fapi2::ReturnCode l_rc = fapi2::FAPI2_RC_SUCCESS; + + // This variable is reused multiple times to build up a unique section + // identifier to split the log data read from the OCMB before we add + // each section to the HWP error + explog_section_header_t l_header_meta; + + // target from which to grab the error log data + fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP> l_target_ocmb = + *(reinterpret_cast<const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP> *> + (i_ocmb_chip.ptr())); + + // How much explorer log data are we allowed to add to the HWP error? + uint32_t l_allowable_size = *(reinterpret_cast<const uint32_t*>(i_size.ptr())); + + std::vector<uint8_t>l_explorer_log_data; // full Explorer log data + fapi2::ffdc_t UNIT_FFDC_EXP_ERROR; // filled in for RC_EXPLORER_ERROR_LOG + + FAPI_INF( "exp_collect_explorer_logs: Entering ... " + "(log type: %s, max data size: 0x%04X)", + i_log_type == ACTIVE_LOG ? "Active" : "Saved", l_allowable_size ); + + if ( ACTIVE_LOG == i_log_type ) + { + FAPI_EXEC_HWP(l_rc, exp_active_log, l_target_ocmb, l_explorer_log_data); + } + else + { + FAPI_EXEC_HWP(l_rc, exp_saved_log, l_target_ocmb, l_explorer_log_data); + } + + if (l_rc != fapi2::FAPI2_RC_SUCCESS) + { + FAPI_ERR("exp_collect_explorer_logs: error 0x%04X from exp_%s_log", + (uint32_t)l_rc, i_log_type == ACTIVE_LOG ? "active" : "saved"); + } + else + { + // Variable to store how much Explorer data we have remaining + uint32_t l_explorer_bytes_left = l_explorer_log_data.size(); + + // Add this much explorer log data (as maximum amount, could be less) + l_header_meta.error_data_size = FIRST_PACKET_SIZE; + + // We read from the end since the most recent logs are the last + // entries returned in the full Explorer log data + auto l_end_ptr = l_explorer_log_data.end(); + + // This is where we start iterating through the Explorer log data + // and break it into sections that are added to the HWP error + while ( l_explorer_bytes_left ) + { + // ---------------------------------------------------------------- + // Calculate how much explorer data to add for this section entry + // ---------------------------------------------------------------- + // Verify there is enough space left in the allowable HWP error + // so we can add another full data section + if ( l_allowable_size > l_header_meta.error_data_size) + { + // We can add at least a packet of data, if we have that + // much to add + if (l_explorer_bytes_left < l_header_meta.error_data_size) + { + FAPI_INF("exp_collect_explorer_logs: %d) reduce packet size to include the last explorer log bytes" + "(l_explorer_bytes_left %d, Initial packet size %d)", l_header_meta.packet_num, + l_explorer_bytes_left, l_header_meta.error_data_size); + + // reduce the packet size to include the last explorer log bytes + l_header_meta.error_data_size = l_explorer_bytes_left; + } + + // else, have enough data and space, so add full data size + } + else if ( l_allowable_size ) // Any space left? + { + // Note: if here, we cannot add a full section size of data + + // Is allowable size remaining less than the explorer bytes available? + if ( l_allowable_size < l_explorer_bytes_left ) + { + // use up the rest of the allowable space available + FAPI_INF("exp_collect_explorer_logs: %d) use up rest of space available" + "(l_explorer_bytes_left %d, l_allowable_size %d)", l_header_meta.packet_num, + l_explorer_bytes_left, l_allowable_size); + l_header_meta.error_data_size = l_allowable_size; + } + else + { + // reduce the packet size to include the last explorer log bytes + l_header_meta.error_data_size = l_explorer_bytes_left; + } + } + else + { + // reached allowable size + break; + } + + // ---------------------------------------------------------------- + + // offset where the data is starting from out of the whole Explorer log data + l_header_meta.offset_exp_log = l_explorer_bytes_left - l_header_meta.error_data_size; + + FAPI_INF("exp_collect_explorer_logs: %d) starting offset 0x%08X " + "(data size: %d)", l_header_meta.packet_num, + l_header_meta.offset_exp_log, l_header_meta.error_data_size); + + // Adding header with meta data + auto const ptr = reinterpret_cast<uint8_t*>(&l_header_meta); + std::vector<uint8_t>l_error_log_entry ( ptr, ptr + sizeof(l_header_meta)); + + // Now append the explorer error section to the section entry + // Note: working backwards from the end of the Explorer log data + l_error_log_entry.insert( l_error_log_entry.end(), + l_end_ptr - l_header_meta.error_data_size, + l_end_ptr ); + + // Add the section entry to the HWP error log + UNIT_FFDC_EXP_ERROR.ptr() = l_error_log_entry.data(); + UNIT_FFDC_EXP_ERROR.size() = l_error_log_entry.size(); + + if (ACTIVE_LOG == i_log_type) + { + FAPI_ADD_INFO_TO_HWP_ERROR(o_rc, RC_EXPLORER_ACTIVE_ERROR_LOG); + } + else + { + FAPI_ADD_INFO_TO_HWP_ERROR(o_rc, RC_EXPLORER_SAVED_ERROR_LOG); + } + + // Update to next packet of Explorer error log data + l_header_meta.packet_num++; + l_explorer_bytes_left -= l_header_meta.error_data_size; + l_end_ptr -= l_header_meta.error_data_size; // point to beginning of last data inserted + l_allowable_size -= l_header_meta.error_data_size; + l_header_meta.error_data_size = FOLLOWING_PACKET_SIZE; + } + } + + FAPI_INF("exp_collect_explorer_logs: Exiting ..."); + + return l_rc; +} + +/// See header +fapi2::ReturnCode exp_collect_explorer_active_log( + const fapi2::ffdc_t& i_ocmb_chip, + const fapi2::ffdc_t& i_size, + fapi2::ReturnCode& o_rc ) +{ + return exp_collect_explorer_logs(i_ocmb_chip, i_size, ACTIVE_LOG, o_rc); +} + +/// See header +fapi2::ReturnCode exp_collect_explorer_saved_log( + const fapi2::ffdc_t& i_ocmb_chip, + const fapi2::ffdc_t& i_size, + fapi2::ReturnCode& o_rc ) +{ + return exp_collect_explorer_logs(i_ocmb_chip, i_size, SAVED_LOG, o_rc); +} diff --git a/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.H b/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.H index 654cd3ccb..adba2eee2 100644 --- a/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.H +++ b/src/import/chips/p9/procedures/hwp/ffdc/exp_collect_explorer_log.H @@ -29,7 +29,7 @@ // *HWP HWP Owner: Matt Derksen <mderkse1@us.ibm.com> // *HWP HWP Backup: Louis Stermole <stermole@us.ibm.com> // *HWP Team: Memory -// *HWP Level: 1 +// *HWP Level: 2 // *HWP Consumed by: HB // ---------------------------------------- #ifndef _COLLECT_EXPLORER_LOG_H_ @@ -38,11 +38,24 @@ //------------------------------------------------------------------------------ // Includes //------------------------------------------------------------------------------ +#include <return_code.H> +#include <error_info_defs.H> //------------------------------------------------------------------------------ // Structure definitions //------------------------------------------------------------------------------ +// function pointer typedef definition for HWP call support +typedef fapi2::ReturnCode (*exp_collect_explorer_active_log_FP_t)( + const fapi2::ffdc_t&, + const fapi2::ffdc_t&, + fapi2::ReturnCode& ); + +typedef fapi2::ReturnCode (*exp_collect_explorer_saved_log_FP_t)( + const fapi2::ffdc_t&, + const fapi2::ffdc_t&, + fapi2::ReturnCode& ); + //------------------------------------------------------------------------------ // Constant definitions //------------------------------------------------------------------------------ @@ -52,4 +65,45 @@ // Function prototypes //------------------------------------------------------------------------------ -#endif // _COLLECT_EXPLORER_ERROR_H_ +extern "C" +{ +/// +/// @brief Procedure to grab active (RAM) log traces from Explorer chip +/// and add those traces to the HWP error +/// @param[in] i_ocmb_chip - OCMB chip target +/// @param[in] i_size - allowable total size (add entries upto this size) +/// @param[out] o_rc - return code to add FFDC data to. +/// +/// @return FAPI2_RC_SUCCESS iff ok +/// +/// NOTE: All input parameters must be of type fapi2::ffdc_t and converted +/// to the correct type inside the function. +/// + fapi2::ReturnCode exp_collect_explorer_active_log( + const fapi2::ffdc_t& i_ocmb_chip, + const fapi2::ffdc_t& i_size, + fapi2::ReturnCode& o_rc ); + + +/// +/// @brief Procedure to grab saved (SPI flash) log traces from Explorer chip +/// and add those traces to the HWP error +/// @param[in] i_ocmb_chip - OCMB chip target +/// @param[in] i_size - allowable total size (add entries upto this size) +/// @param[out] o_rc - return code to add FFDC data to. +/// +/// @return FAPI2_RC_SUCCESS iff ok +/// +/// NOTE: All input parameters must be of type fapi2::ffdc_t and converted +/// to the correct type inside the function. +/// + fapi2::ReturnCode exp_collect_explorer_saved_log( + const fapi2::ffdc_t& i_ocmb_chip, + const fapi2::ffdc_t& i_size, + fapi2::ReturnCode& o_rc ); + + +} // extern "C" + + +#endif // _COLLECT_EXPLORER_LOG_H_ diff --git a/src/import/chips/p9/procedures/hwp/ffdc/ffdc_includes.H b/src/import/chips/p9/procedures/hwp/ffdc/ffdc_includes.H index c84739fb4..2336e59bf 100644 --- a/src/import/chips/p9/procedures/hwp/ffdc/ffdc_includes.H +++ b/src/import/chips/p9/procedures/hwp/ffdc/ffdc_includes.H @@ -5,7 +5,7 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* Contributors Listed Below - COPYRIGHT 2016,2018 */ +/* Contributors Listed Below - COPYRIGHT 2016,2019 */ /* [+] International Business Machines Corp. */ /* */ /* */ @@ -35,4 +35,8 @@ #include <p9_collect_ppe_state.H> #include <p9_eq_clear_atomic_lock.H> #include <p9_collect_lpc_regs.H> + +// needed for collectFfdc to work for adding Explorer log data +#include <exp_collect_explorer_log.H> + #endif |