blob: 2804451a6179db05e86fc41f7a5d75ad266d230c (
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
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/hwpf/fapi2/include/return_code.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2016 */
/* [+] 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 return_code.H
* @brief definitions for fapi2 return codes
*/
#ifndef __FAPI2_RETURN_CODE__
#define __FAPI2_RETURN_CODE__
#include <stdint.h>
#include <return_code_defs.H>
#ifndef FAPI2_NO_FFDC
#include <ffdc.H>
#endif
namespace fapi2
{
///
/// @brief Class representing a FAPI2 ReturnCode
///
// Remove the inheritance relationship with FirstFailureData if
// the platform doesn't support FFDC.
#if defined (FAPI2_NO_FFDC) || defined (MINIMUM_FFDC)
class ReturnCode
#else
class ReturnCode : public FirstFailureData<ReturnCode>
#endif
{
public:
///
/// @brief Constructor.
/// @param[in] i_rc the rc to set
///
ReturnCode(const uint32_t i_rc = FAPI2_RC_SUCCESS):
iv_rc(i_rc)
{};
///
/// @brief integral type conversion function. Returns the error code
/// @return The error code
///
inline operator uint32_t() const
{
return iv_rc;
}
///
/// @brief integral type conversion function. Returns the error code
/// @return The error code
///
inline operator uint64_t() const
{
return iv_rc;
}
///
/// @brief Returns true iff iv_rc != SUCCESS
/// @return true or false
///
inline operator bool() const
{
return iv_rc != FAPI2_RC_SUCCESS;
}
///
/// @brief Assignement operator
///
#ifdef DOXYGEN
inline ReturnCode& operator=(const uint32_t& rhs);
inline ReturnCode& operator=(const ReturnCodes& rhs);
#endif
inline bool operator==(const uint32_t& rhs) const
{
return rhs == iv_rc;
}
inline bool operator==(const ReturnCodes& rhs) const
{
return rhs == iv_rc;
}
inline bool operator!=(const uint32_t& rhs) const
{
return rhs != iv_rc;
}
inline bool operator!=(const ReturnCodes& rhs) const
{
return rhs != iv_rc;
}
///
/// @brief Enumeration of return code creators
///
enum returnCodeCreator
{
CREATOR_FAPI = 1,
CREATOR_PLAT = 2,
CREATOR_HWP = 3,
};
///
/// @brief Gets the creator of the return code
/// @return ReturnCodeCreator
///
inline returnCodeCreator getCreator(void) const
{
returnCodeCreator l_creator = CREATOR_HWP;
if (iv_rc & FAPI2_RC_FAPI2_MASK)
{
l_creator = CREATOR_FAPI;
}
else if (iv_rc & FAPI2_RC_PLAT_MASK)
{
l_creator = CREATOR_PLAT;
}
return l_creator;
}
///
/// @brief explicit check for RC value
/// @return true if this instance has a matching RC
///
inline bool isRC(const ReturnCodes i_rc) const
{
return static_cast<uint32_t>(i_rc) == iv_rc;
}
///
/// @brief explicit check for RC value
/// @return true if this instance has a matching RC
///
inline bool isRC(const uint32_t i_rc) const
{
return i_rc == iv_rc;
}
private:
uint32_t iv_rc;
};
/// This implementation assumes no exception handling and leverages thread-local
/// storage. For platforms without thread support, a global variable will
/// suffice for the error state.
extern thread_local uint64_t pib_error_mask; /// the pib mask
extern thread_local uint64_t operational_state; /// the operational mode
#ifndef PLAT_NO_THREAD_LOCAL_STORAGE
extern thread_local ReturnCode current_err; /// the current error state
#else
extern ReturnCode current_err;
#endif
}
#endif
|
