blob: a3c1c46ef622602fc205b77722136ad0e35d400d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2012 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* 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. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @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
* automatically generated from FAPI Error XML files.
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 09/19/2012 Created.
*/
#ifndef FAPICOLLECTREGFFDC_H_
#define FAPICOLLECTREGFFDC_H_
#include <fapiHwpErrorInfo.H>
namespace fapi
{
class Target;
class ReturnCode;
/**
* @brief Collects Register FFDC from a chip
*
* This should only be called by FAPI during FAPI_SET_HWP_ERROR or
* FAPI_ADD_INFO_TO_HWP_ERROR
*
* @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
*/
void fapiCollectRegFfdc(const fapi::Target & i_target,
const fapi::HwpFfdcId i_ffdcId,
fapi::ReturnCode & o_rc);
}
#endif
|
