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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/targeting/common/predicates/predicatehwas.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,2013 */
/* */
/* 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 */
#ifndef __TARGETING_COMMON_PREDICATEHWAS_H
#define __TARGETING_COMMON_PREDICATEHWAS_H
/**
* @file targeting/common/predicates/predicatehwas.H
*
* @brief Interface for a predicate which fiters a target based on its HWAS
* state
*/
//******************************************************************************
// Includes
//******************************************************************************
// STD
// Other Host Boot Components
// Targeting Component
#include <targeting/common/target.H>
#include <targeting/common/attributes.H>
#include <targeting/common/predicates/predicatebase.H>
//******************************************************************************
// Macros
//******************************************************************************
#undef TARG_NAMESPACE
#undef TARG_CLASS
#undef TARG_FN
//******************************************************************************
// Interface
//******************************************************************************
namespace TARGETING
{
#define TARG_NAMESPACE "TARGETING::"
#define TARG_CLASS "PredicateHWAS::"
class Target;
/**
* @brief Predicate class which filters a target based on its HWAS state
*/
class PredicateHwas : public PredicateBase
{
public:
/**
* @brief Create an HWAS state predicate
*/
PredicateHwas();
/**
* @brief Destroy an HWAS state predicate
*/
virtual ~PredicateHwas();
/**
* @brief Reset the predicate to match everything
*
* @return Reference to the predicate, for chaining
*/
PredicateHwas& reset();
/**
* @brief Configure predicate to look for the given powered on state
*
* @param[in] i_poweredOn Desired powered on state
*
* @return Reference to the predicate, for chaining
*/
PredicateHwas& poweredOn(const bool i_poweredOn);
/**
* @brief Configure predicate to look for the given present state
*
* @param[in] i_present Desired present state
*
* @return Reference to the predicate, for chaining
*/
PredicateHwas& present(const bool i_present);
/**
* @brief Configure predicate to look for the given functional state
*
* @param[in] i_functional Desired functional state
*
* @return Reference to the predicate, for chaining
*/
PredicateHwas& functional(const bool i_functional);
/**
* @brief Configure predicate to look for the given dump functional
* state
*
* @param[in] i_dumpFunctional Desired dump functional state
*
* @return Reference to the predicate, for chaining
*/
PredicateHwas& dumpFunctional(const bool i_dumpFunctional);
/**
* @brief Returns whether target matches the desired HWAS state
*
* @par Detailed Description:
* Returns whether target matches the desired HWAS state. Current
* HWAS sub-fields compared include poweredOn, present, functional
* and dumpFunctional. On construction, the
* predicate matches any state of those fields. To make the
* filter more restrictive, call any combination of the state
* configuration functions with the desired values. The filter
* will make sure all the desired fields have requested values
* before returning a match. To reset the filter to match all
* targets, call reset(). See PredicateBase class for
* parameter/return description.
*
* @param[in] i_pTarget
* Target handle pointing to the target to compare to
*
* @return bool indicating whether the target matches or not
*/
virtual bool operator()(
const Target* i_pTarget) const;
private:
/**
* @brief Union that exposes raw value of an HWAS state attribute
* for purposes of bitwise comparison
*
* @warning ATTR_HWAS_STATE size must be <= uint64_t in size, otherwise
* code cannot guarantee that the required bitfields fit. This
* requirement is enforced by a compile-time assert
*/
union hwasState
{
ATTR_HWAS_STATE_type attribute; // Attribute
uint64_t rawValue; // Flattened representation
};
hwasState iv_desired; ///< Desired states
hwasState iv_valid; ///< Validity of each field
TARG_DISABLE_COPY_AND_ASSIGNMENT_OPERATORS(PredicateHwas);
};
//******************************************************************************
// PredicateHwas::PredicateHwas
//******************************************************************************
inline PredicateHwas::PredicateHwas()
{
// Ignore reference
reset();
}
//******************************************************************************
// PredicateHwas::poweredOn
//******************************************************************************
inline PredicateHwas& PredicateHwas::poweredOn(
const bool i_poweredOn)
{
iv_desired.attribute.poweredOn = i_poweredOn;
iv_valid.attribute.poweredOn = true;
return *this;
}
//******************************************************************************
// PredicateHwas::present
//******************************************************************************
inline PredicateHwas& PredicateHwas::present(
const bool i_present)
{
iv_desired.attribute.present = i_present;
iv_valid.attribute.present = true;
return *this;
}
//******************************************************************************
// PredicateHwas::functional
//******************************************************************************
inline PredicateHwas& PredicateHwas::functional(
const bool i_functional)
{
iv_desired.attribute.functional = i_functional;
iv_valid.attribute.functional = true;
return *this;
}
//******************************************************************************
// PredicateHwas::dumpFunctional
//******************************************************************************
inline PredicateHwas& PredicateHwas::dumpFunctional(
const bool i_dumpFunctional)
{
iv_desired.attribute.dumpfunctional = i_dumpFunctional;
iv_valid.attribute.dumpfunctional = true;
return *this;
}
#undef TARG_CLASS
#undef TARG_NAMESPACE
} // End namespace TARGETING
#endif // __TARGETING_COMMON_PREDICATEHWAS_H
|
