diff options
| author | Brian Silver <bsilver@us.ibm.com> | 2015-02-13 13:39:53 -0600 |
|---|---|---|
| committer | Derk Rembold <rembold@de.ibm.com> | 2015-09-03 07:16:38 -0500 |
| commit | 7609511c99205fbdc357d99fdb13b336b1b9aab2 (patch) | |
| tree | 3ba4cab64b6ccbdc16656c4c490c8239a1106693 /import | |
| parent | e8287c0eb6e9be6408bff1858b73fd151a9c1c85 (diff) | |
| download | talos-sbe-7609511c99205fbdc357d99fdb13b336b1b9aab2.tar.gz talos-sbe-7609511c99205fbdc357d99fdb13b336b1b9aab2.zip | |
Add FFDC xml parsing documentation
Change-Id: I56844e96c80fb3eb345b2254a7b42dd95c434ce3
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/16041
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Reviewed-by: MATTHEW A. PLOETZ <maploetz@us.ibm.com>
Reviewed-by: Brian Silver <bsilver@us.ibm.com>
Tested-by: Brian Silver <bsilver@us.ibm.com>
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/20120
Tested-by: Jenkins Server
Reviewed-by: Derk Rembold <rembold@de.ibm.com>
Diffstat (limited to 'import')
| -rw-r--r-- | import/hwpf/fapi2/include/error_info.H | 38 | ||||
| -rw-r--r-- | import/hwpf/fapi2/include/plat_trace.H | 4 | ||||
| -rw-r--r-- | import/hwpf/fapi2/include/utils.H | 4 |
3 files changed, 37 insertions, 9 deletions
diff --git a/import/hwpf/fapi2/include/error_info.H b/import/hwpf/fapi2/include/error_info.H index 8da7f7ab..81e72d2f 100644 --- a/import/hwpf/fapi2/include/error_info.H +++ b/import/hwpf/fapi2/include/error_info.H @@ -22,10 +22,11 @@ /* permissions and limitations under the License. */ /* */ /* IBM_PROLOG_END_TAG */ -/** - * @file erro_infor.H - * @brief Defines the Error Information structures and classes - */ + +/// +/// @file error_info.H +/// @brief Defines the Error Information structures and classes +/// #ifndef FAPI2_ERRORINFO_H_ #define FAPI2_ERRORINFO_H_ @@ -174,7 +175,7 @@ namespace fapi2 } /// - /// @enum Enumeration of firmware traces + /// @enum Collect Trace /// /// This enumeration defines the possible firmware traces to collect /// @@ -738,6 +739,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Structure representing a hardware callout + /// struct ErrorInfoEntryHwCallout { uint8_t iv_hw; @@ -747,6 +751,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Structure representing a procedure callout + /// struct ErrorInfoEntryProcCallout { uint8_t iv_procedure; @@ -762,6 +769,9 @@ namespace fapi2 ErrorInfoEntryProcCallout(void) = default; }; + /// + /// @brief Structure representing a bus callout + /// struct ErrorInfoEntryBusCallout { uint8_t iv_endpoint1ObjIndex; @@ -771,6 +781,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Structure representing a target callout + /// struct ErrorInfoEntryTargetCDG { uint8_t iv_targetObjIndex; @@ -782,6 +795,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Structure representing a child callout + /// struct ErrorInfoEntryChildrenCDG { uint8_t iv_parentObjIndex; @@ -796,6 +812,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Structure representing collected trace information + /// struct ErrorInfoEntryCollectTrace { uint32_t iv_eieTraceId; @@ -803,6 +822,9 @@ namespace fapi2 const void* const* i_object) const; }; + /// + /// @brief Union of all the error info types + /// struct ErrorInfoEntry { uint8_t iv_type; // Value from ErrorInfoType @@ -816,6 +838,12 @@ namespace fapi2 ErrorInfoEntryChildrenCDG children_cdg; ErrorInfoEntryCollectTrace collect_trace; }; + + /// + /// @brief Add error information to the FFDC object + /// @param[in] i_info a shared pointer to the error info + /// @param[in] i_object the list of ffdc objects being collected + /// void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, const void* const* i_object) const { diff --git a/import/hwpf/fapi2/include/plat_trace.H b/import/hwpf/fapi2/include/plat_trace.H index 6c005620..7c7dd3be 100644 --- a/import/hwpf/fapi2/include/plat_trace.H +++ b/import/hwpf/fapi2/include/plat_trace.H @@ -23,8 +23,8 @@ /* */ /* IBM_PROLOG_END_TAG */ /** - * @file platTrace.H - * @brief Defines the FAPI trace macros. + * @file plat_trace.H + * @brief Defines the FAPI2 trace macros. * * Note that platform code must provide the implementation. * diff --git a/import/hwpf/fapi2/include/utils.H b/import/hwpf/fapi2/include/utils.H index c72a9ebd..65806272 100644 --- a/import/hwpf/fapi2/include/utils.H +++ b/import/hwpf/fapi2/include/utils.H @@ -23,8 +23,8 @@ /* */ /* IBM_PROLOG_END_TAG */ /** - * @file erro_infor.H - * @brief Defines the Error Information structures and classes + * @file utils.H + * @brief Defines common fapi2 utilities */ #ifndef FAPI2_UTILS_H_ |
