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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/register/iipErrorRegisterMask.h $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 1996,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 iipErrorRegisterMask_h
#define iipErrorRegisterMask_h
/**
@file iipErrorRegisterMask.h
@brief ErrorRegisterMask class declaration
*/
// Class Description *************************************************
//
// Name: ErrorRegisterMask
// Base class: ErrorRegister
// Concrete class that can be used as a base class
//
// Description: Maskable & Filterable Error register declairation
//--------------
// Usage:
// foo(SCAN_COMM_REGISTER &scr, ResolutionMap &resMap,
// STEP_CODE_DATA_STRUCT &error_data)
// {
// ErrorRegisterMask erm(scr,resMap);
// uint32_t mask_data[] = {0x00000000, 0xFFFFFFFF};
// erm.SetMaskBits(BIT_STRING_ADDRESS_CLASS(0,64,mask_data));
// ...
// int32_t rc = er.Analyze(error_data);
// ...
// erm.SetMaskBit(15);
// }
//--------------------
// Filter example
//
// FILTER_PRIORITY_CLASS filter(BIT_LIST_STRING_1); // bit 1 takes priority
// ErrorRegisterMask erm(scr,resMap,&filter); // if it's on
// ...
// int32_t rc = erm.Analyze(error_data);
//
// Notes:
//
//
// End Class Description *********************************************
//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipErrorRegisterFilter_h)
#include <iipErrorRegisterFilter.h>
#endif
#ifndef IIPBITS_H
#include <iipbits.h>
#endif
namespace PRDF
{
//--------------------------------------------------------------------
// Forward References
//--------------------------------------------------------------------
/**
Error register with bit masking capabilities
@version V4R5
*/
class ErrorRegisterMask : public ErrorRegisterFilter
{
public:
/**
Constructor
<ul>
<br><b>Parameter: </b> ScanCommRegister
<br><b>Parameter: </b> Resolution map
<br><b>Parameter: </b> Optional Filter
<br><b>Parameter: </b> Optional scrId
<br><b>Parameter: </b> Optional maskScan comm register
<br><b>Notes: </b> If no ScrId is provided then the scan
Comm register address is used
</ul><br>
*/
ErrorRegisterMask(SCAN_COMM_REGISTER_CLASS & r, ResolutionMap & rm, FILTER_CLASS * f = NULL, uint16_t scrId = 0x0fff, SCAN_COMM_REGISTER_CLASS & maskScr = *((SCAN_COMM_REGISTER_CLASS *) NULL)); // dg00
/**
Constructor
<ul>
<br><b>Parameter: </b> ScanCommRegister
<br><b>Parameter: </b> Resolution map
<br><b>Parameter: </b> scrId - for the signature
<br><b>Parameter: </b> Optional maskScan comm register
</ul><br>
*/
ErrorRegisterMask(SCAN_COMM_REGISTER_CLASS & r, ResolutionMap & rm, uint16_t scrId, SCAN_COMM_REGISTER_CLASS & maskScr = *((SCAN_COMM_REGISTER_CLASS *) NULL)); // dg00
// Function Specification ********************************************
//
// Purpose: Destruction
// Parameters: None.
// Returns: No value returned
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
// Notes: Compiler default is ok
//
// End Function Specification ****************************************
// ~ErrorRegisterMask();
/**
Set a mask bit
<ul>
<br><b>Parameters: </b> bit position
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> bitStringMask.IsSet(bitPosition) == true.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> The bitstring read from hardware during Read()
will have this bitpos reset (zeroed) prior to using
it for any Analysis.
</ul><br>
*/
void SetMaskBit(uint32_t bitPosition);
/**
Set mask bits
<ul>
<br><b>Parameters: </b> BitString
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> bitStringMask != bitString;
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> The bitstring read from hardware during Read()
will have the bit positions reset (zeroed) as
specified in the bitStringMask (by 1's) prior
to using it for any Analysis.
</ul><br>
*/
void SetMaskBits(const BIT_STRING_CLASS & bitString);
protected:
/**
Read the scan comm register, apply the mask, and return the resulting bit string
<ul>
<br><b>Parameters: </b> None
<br><b>Returns: </b> a Bit String
<br><b>Requirements:</b> None.
<br><b>Promises: </b> Bit string contains data from hardware with masked bits zeroed
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Any class that overides Read() but does not
override Analyze() should set src_rc
return code from mops scr access
</ul><br>
*/
virtual const BIT_STRING_CLASS & Read();
/**
Reset the error register and set mask bit if sdc is at theshold
<ul>
<br><b>Parameters: </b> BitList
<br><b>Returns: </b> return code
<br><b>Requirements:</b> Filter()
<br><b>Promises: </b> if xMaskScr == NULL then
bitStringMask bit(s) set if error.service_data->IsAtThreshold()
ELSE bitStringMask remains unchanged
Hardware may be modified
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
virtual int32_t Reset( const BIT_LIST_CLASS & bit_list,
STEP_CODE_DATA_STRUCT & error );
private: // functions
/** Copy forbidden - no definition (code) exists*/
ErrorRegisterMask(const ErrorRegisterMask & er);
/** Assignment forbidden - no definition (code) exists */
ErrorRegisterMask & operator=(const ErrorRegisterMask & er);
protected: // Data
BIT_STRING_BUFFER_CLASS bitString;
BIT_STRING_BUFFER_CLASS bitStringMask;
private: // Data
SCAN_COMM_REGISTER_CLASS & xMaskScr; // dg00
// bool maskIt;
};
inline void ErrorRegisterMask::SetMaskBit(uint32_t bitPosition)
{ bitStringMask.Set(bitPosition); }
inline void ErrorRegisterMask::SetMaskBits(const BIT_STRING_CLASS & bitString)
{ bitStringMask.SetBits(bitString); }
} // end namespace PRDF
#endif /* iipErrorRegisterMask_h */
|
