diff options
Diffstat (limited to 'src/include')
| -rw-r--r-- | src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H b/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H index a3c1c46ef..30329cc75 100644 --- a/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H +++ b/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H @@ -5,7 +5,7 @@ /* */ /* IBM CONFIDENTIAL */ /* */ -/* COPYRIGHT International Business Machines Corp. 2012 */ +/* COPYRIGHT International Business Machines Corp. 2012,2013 */ /* */ /* p1 */ /* */ @@ -23,12 +23,13 @@ /** * @file fapiCollectRegFfdc.H * - * @brief Defines the fapiCollectRegFfdc function that collects chip register - * FFDC data. This is called automatically by FAPI_SET_HWP_ERROR (when - * a HWP creates an error) and FAPI_ADD_INFO_TO_HWP_ERROR (when an FFDC - * HWP adds error information to an existing error) if the error XML - * contains a <collectRegisterFfdc> element. This function should not - * be called directly by any user code. The function implementation is + * @brief Defines the fapiCollectRegFfdc function that collects chip or + * chiplet register FFDC data. This is called automatically by + * FAPI_SET_HWP_ERROR (when a HWP creates an error) and + * FAPI_ADD_INFO_TO_HWP_ERROR (when an FFDC HWP adds error information + * to an existing error) if the error XML contains a + * <collectRegisterFfdc> element. This function should not be called + * directly by any user code. The function implementation is * automatically generated from FAPI Error XML files. */ @@ -37,13 +38,15 @@ * Flag Defect/Feature User Date Description * ------ -------------- ---------- ----------- ---------------------------- * mjjones 09/19/2012 Created. + * dedahle 09/30/2013 Add i_child parameter for + * chiplet register FFDC */ #ifndef FAPICOLLECTREGFFDC_H_ #define FAPICOLLECTREGFFDC_H_ #include <fapiHwpErrorInfo.H> - +#include <fapiTarget.H> namespace fapi { @@ -51,7 +54,7 @@ class Target; class ReturnCode; /** - * @brief Collects Register FFDC from a chip + * @brief Collects Register FFDC from a chip or chiplet * * This should only be called by FAPI during FAPI_SET_HWP_ERROR or * FAPI_ADD_INFO_TO_HWP_ERROR @@ -59,10 +62,18 @@ class ReturnCode; * @param[in] i_target Reference to Target to collect FFDC from * @param[in] i_ffdcId FFDC Identifier * @param[out] o_rc Reference to ReturnCode that FFDC is added to + * @param[in] i_child Specifies type of i_target's chiplet to collect + * FFDC from. If this parameter is TARGET_TYPE_NONE + * (default value), then register FFDC is collected + * from i_target, else, register FFDC is collected + * from all functional child chiplets i_target of + * the specified type */ void fapiCollectRegFfdc(const fapi::Target & i_target, const fapi::HwpFfdcId i_ffdcId, - fapi::ReturnCode & o_rc); + fapi::ReturnCode & o_rc, + const fapi::TargetType i_child = + fapi::TARGET_TYPE_NONE); } #endif |
