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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/register/iipErrorRegisterFilter.h $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2001,2014 */
/* */
/* 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 */
#ifndef iipErrorRegisterFilter_h
#define iipErrorRegisterFilter_h
/**
@file iipErrorRegisterFileter.h
@brief ErrorRegisterFilter class declaration
*/
// Class Description *************************************************
//
// Name: ErrorRegisterFilter
// Base class: ErrorRegister
//
// Description: Error register with a filter
// Usage: (see iipErrorRegisterMask.h)
//
//
// End Class Description *********************************************
//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipErrorRegister_h)
#include <iipErrorRegister.h>
#endif
#include <prdfFilters.H>
namespace PRDF
{
//--------------------------------------------------------------------
// Forward References
//--------------------------------------------------------------------
/**
Error register class with filtering capabilities
@author Doug Gilbert
*/
class ErrorRegisterFilter : public ErrorRegister
{
public:
/**
Constructor
<ul>
<br><b>Parameter: </b> Scan comm register to get bitString from hardware
<br><b>Parameter: </b> Resolution map to map bit pattern to a resolution
<br><b>Parameter: </b> scan comm register id for error signature
<br><b>Returns: </b> Nothing
<br><b>Requirements:</b> None
<br><b>Promises: </b> Object created
<br><b>Exceptions: </b> None
<br><b>Notes: </b>
</ul><br>
*/
ErrorRegisterFilter(SCAN_COMM_REGISTER_CLASS & r, ResolutionMap & rm, uint16_t scrId = 0x0fff);
/**
Constructor
<ul>
<br><b>Parameter: </b> Scan comm register to get bitString from hardware
<br><b>Parameter: </b> Resolution map to map bit pattern to a resolution
<br><b>Parameter: </b> Filter to apply to bit string before mapping it
<br><b>Parameter: </b> scan comm register id
<br><b>Returns: </b> Nothing
<br><b>Requirements:</b> None
<br><b>Promises: </b> Object created
<br><b>Exceptions: </b> None
<br><b>Notes: </b>
</ul><br>
*/
ErrorRegisterFilter( SCAN_COMM_REGISTER_CLASS & r, ResolutionMap & rm,
FilterClass * f, uint16_t scrId = 0x0fff );
/*
Destructor
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> No value returned
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Compiler default is OK
</ul><br>
*/
//~ErrorRegisterFilter();
/**
* @brief Get the stored filter associated with this resolution map.
* @returns Currently assigned filter.
*/
FilterClass * getFilter() const { return filter; };
/**
* @brief Store a new filter with this resolution map.
* @param i - FilterClass to store.
*/
void setFilter(FilterClass * i_filter) { filter = i_filter; };
protected: // functions
/**
Filter the bit string (if a filter is provided) & convert it to a BitList
<ul>
<br><b>Parameters: </b> Bit String
<br><b>Returns: </b> Bit List
<br><b>Requirements:</b> Read()
<br><b>Promises: </b> Bit list representation of the (filtered) bit string
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> filter is called only if provided
- DEFINTION in iipErrorRegisterMask.C
</ul><br>
*/
virtual BitKey Filter(const BIT_STRING_CLASS & bs);
/**
* Certain filters need to be reversed in order for Reset() to work right
* @return bit_list modified ? [true|false]
* @see Filters.H
*/
virtual bool FilterUndo(BitKey & i_bit_list)
{
bool modified = false;
if(filter) modified = filter->Undo(i_bit_list);
return modified;
}
private: // functions
/** Copy forbidden - no definition exists */
ErrorRegisterFilter(const ErrorRegisterFilter & er);
/** Assignment forbidden - no definition exists */
ErrorRegisterFilter & operator=(const ErrorRegisterFilter & er);
protected: // data
FilterClass * filter;
private: // Data
};
inline
ErrorRegisterFilter::ErrorRegisterFilter(SCAN_COMM_REGISTER_CLASS & r,
ResolutionMap & rm,
uint16_t scrId)
: ErrorRegister(r,rm,scrId), filter(NULL)
{}
inline
ErrorRegisterFilter::ErrorRegisterFilter(SCAN_COMM_REGISTER_CLASS & r,
ResolutionMap & rm,
FilterClass * f,
uint16_t scrId)
: ErrorRegister(r,rm,scrId), filter(f)
{}
} // end namespace PRDF
#endif /* iipErrorRegisterFilter_h */
|
