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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/fapi/fapiReturnCodes.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* 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 */
// $Id: fapiReturnCodes.H,v 1.17 2014/04/15 17:50:40 whs Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiReturnCodes.H,v $
/**
* @file fapiReturnCodes.H
*
* @brief Defines the returns codes generated by HWPF code.
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 04/13/2011 Created.
* mjjones 06/07/2011 Add FAPI_RC_NOT_IMPLEMENTED
* mjjones 06/30/2011 Add FAPI_RC_ATTR_UNIT_TEST_FAIL
* mjjones 08/10/2011 Add FAPI_RC_FFDC_HWP_NOT_FOUND
* mjjones 09/23/2011 Remove FAPI_RC_FFDC_HWP_NOT_FOUND
* mjjones 10/07/2011 Add FAPI_RC_INVALID_ATTR_GET
* mjjones 10/28/2011 Trim FAPI/PLAT errors
* mjjones 11/10/2011 Use ecmdDataBufferBase
* mjjones 01/13/2012 Name enumeration
* mjjones 04/16/2012 Add FAPI_RC_INVALID_CHIP_EC_FEATURE_GET
* mjjones 05/02/2012 Add FAPI_RC_PLAT_ERR_ADU_LOCKED
* mjjones 11/14/2012 Add FAPI_RC_UNRECOGNIZED_SBE_ERROR
* mjjones 03/26/2014 Remove FAPI_RC_UNRECOGNIZED_SBE_ERROR
* whs 04/14/2014 Remove FAPI_RC_INVALID_PARAM
*/
#ifndef FAPIRETURNCODES_H_
#define FAPIRETURNCODES_H_
#include <ecmdDataBufferBase.H>
namespace fapi
{
/**
* @brief Enumeration of return codes
*
* @note HWP return codes are in the HwpReturnCode enumeration in the
* generated fapiHwpReturnCodes.H file
*/
enum ReturnCodes
{
FAPI_RC_SUCCESS = 0,
//--------------------------------------------------------------------------
// Flag bits indicating which code generated the error If no flag set then
// it is generated by HWP
//--------------------------------------------------------------------------
FAPI_RC_FAPI_MASK = 0x04000000, // FAPI generated error
FAPI_RC_PLAT_MASK = 0x02000000, // PLAT generated error
FAPI_RC_ECMD_MASK = ECMD_ERR_ECMD, // ECMD generated error (0x01000000)
//--------------------------------------------------------------------------
// FAPI generated return codes
//--------------------------------------------------------------------------
// Initfile requested an attribute with an invalid attribute ID
FAPI_RC_INVALID_ATTR_GET = FAPI_RC_FAPI_MASK | 0x01,
// HWP requested a chip EC feature with an invalid attribute ID
FAPI_RC_INVALID_CHIP_EC_FEATURE_GET = FAPI_RC_FAPI_MASK | 0x02,
// Invalid multiscom parameters
FAPI_RC_INVALID_MULTISCOM_LENGTH = FAPI_RC_FAPI_MASK | 0x03,
//--------------------------------------------------------------------------
// PLAT generated return codes. Additional details may be contained in
// ReturnCode platData (this can only be looked at by PLAT code)
//--------------------------------------------------------------------------
// Generic platform error
FAPI_RC_PLAT_ERR_SEE_DATA = FAPI_RC_PLAT_MASK | 0x01,
// Operation to AlterDisplay unit failed because it is locked
FAPI_RC_PLAT_ERR_ADU_LOCKED = FAPI_RC_PLAT_MASK | 0x02,
// Operation not supported by HB runtime
FAPI_RC_PLAT_NOT_SUPPORTED_AT_RUNTIME = FAPI_RC_PLAT_MASK | 0x03,
};
}
#endif // FAPIRETURNCODES_H_
|
