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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/service/iipsdbug.h $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2002,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 IIPSDBUG_H
#define IIPSDBUG_H
/*!
@file iipsdbug.h
@brief PRD wrapper to the system debug data
*/
/* Module Description *************************************************/
/* */
/* Name: iipsdbug.h */
/* */
/* Description: This module contains the Processor Runtime
Diagnostics System Debug area class declaration. */
/* */
/* End Module Description *********************************************/
/*--------------------------------------------------------------------*/
/* Reference the virtual function tables and inline function
defintions in another translation unit. */
/*--------------------------------------------------------------------*/
#ifdef __GNUC__
#pragma interface
#endif
/*--------------------------------------------------------------------*/
/* Includes */
/*--------------------------------------------------------------------*/
#include <stdint.h>
#include <prdfMain.H>
#include <prdfTargetFwdRef.H>
namespace PRDF
{
/*--------------------------------------------------------------------*/
/* Forward References */
/*--------------------------------------------------------------------*/
//class CHIP_CLASS;
struct PRD_SRC_TYPE;
struct STEP_CODE_DATA_STRUCT;
/*--------------------------------------------------------------------*/
/* User Types */
/*--------------------------------------------------------------------*/
typedef uint8_t ATTENTION_TYPE;
/*--------------------------------------------------------------------*/
/* Constants */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Macros */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Global Variables */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Function Prototypes */
/*--------------------------------------------------------------------*/
/* Class Specification ************************************************/
/* */
/* Title: System Debug */
/* */
/* Purpose: SYSTEM_DEBUG_CLASS is an interface to the Service
Processor Communcation Area (SPCA) System Debug common
memory area. */
/* */
/* Usage: Concrete class */
/* */
/* Notes: This System Debug specifies an interface for accessing
data in the SPCA sysdbug structure. */
/* */
/* Cardinality: N */
/* */
/* Space Complexity: Constant */
/* */
/* End Class Specification ********************************************/
/**
Provide services associated with the service processor system debug area
@author Douglas R. Gilbert
@version V4R5
*/
class SYSTEM_DEBUG_CLASS
{
public:
/**
Constructor
<ul>
<br><b>Parameters: </b> None.
<br><b>Requirements:</b> sp virtuals established
<br><b>Promises: </b> Object instantiated
<br><b>Exceptions: </b> None.
</ul><br>
*/
SYSTEM_DEBUG_CLASS(void);
/**
Re-read attention data
<ul>
<br><b>Parameters: </b> i_attnList list of chips at attention
<br><b>Returns: </b> None.
<br><b>Requirements:</b> sp virtuals established
<br><b>Promises: </b> object resurrected
<br><b>Exceptions: </b> None.
</ul><br>
*/
uint32_t Reinitialize(const AttnList & i_attnList);
/**
Indicates if an attention is active for a particular chip
<ul>
<br><b>Parameters: </b> i_pTargetHandle
<br><b>Returns: </b> [true | false]
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
bool IsAttentionActive(TARGETING::TargetHandle_t i_ptargetHandle ) const;
/**
Indicates if an attention is active for a particular chip
<ul>
<br><b>Parameters: </b> ChipClass
<br><b>Returns: </b> [true | false]
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
// bool IsAttentionActive(const CHIP_CLASS & chip) const;
/**
Get the attention type for the attention that is active on this chip
<ul>
<br><b>Parameters: </b> i_pTargetHandle
<br><b>Returns: </b> ATTENTION_TYPE
<br><b>Requirements:</b> IsAttentionActive() == true
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
uint8_t GetAttentionType(TARGETING::TargetHandle_t i_ptargetHandle ) const;
/**
Get the attention type for the attention that is active on this chip
<ul>
<br><b>Parameters: </b> ChipClass
<br><b>Returns: </b> ATTENTION_TYPE
<br><b>Requirements:</b> IsAttentionActive() == true
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
// uint8_t GetAttentionType(const CHIP_CLASS & chip) const;
/**
Get the global(overall) attention type
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> ATTENTION_TYPE
<br><b>Requirements:</b> None,
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
uint32_t GetGlobalAttentionType(void) const;
/**
Set the sysdebug SRC pointer to the PRD generated SRC
<ul>
<br><b>Parameters: </b> ptr to SRC
<br><b>Returns: </b> None
<br><b>Requirements:</b> src_ptr is valid
<br><b>Promises: </b> sysdebug modified
<br><b>Exceptions: </b> None.
</ul><br>
*/
void SetPrdSrcPointer(uint32_t*);
void SetPrdSrcPointer(); // called by main - can we remove it?
/**
Create an SRC in the SOT (obsolete)
<ul>
<br><b>Parameters: </b> reference code, step code, analysis return code
<br><b>Returns: </b> return code
<br><b>Requirements:</b> none.
<br><b>Promises: </b> SRC written to SOT
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> No implementation after V3R7
</ul><br>
*/
// int32_t SrcFill(uint16_t ref_code, uint16_t step_code, uint16_t mop_rc) const;
/**
Callout all chips at attention
<ul>
<br><b>Parameters: </b> ServiceData
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
void CalloutThoseAtAttention(STEP_CODE_DATA_STRUCT & serviceData) const;
enum { MAX_ERROR_ENTRY_INDEX = 80 };
/**
Clear the attentions
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> Nothing is at attention
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
void Clear(void);
// Functions used by the simulator only
/**
Get the pointer to the PRD SRC in sysdebug (Simulator only)
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> ptr to SRC
<br><b>Requirements:</b> SetPrdSrcPointer()
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Available in PRD simulator only
</ul><br>
*/
const uint32_t *GetPrdSrcPointer(void) const;
/**
Set the attention type for the specified chip (Simulator only)
<ul>
<br><b>Parameters: </b> i_pTargetHandle, ATTENTION_TYPE
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> GetAttentionType() == at
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Available in PRD simulator only
</ul><br>
*/
void SetAttentionType( TARGETING::TargetHandle_t i_pTargetHandle,
ATTENTION_VALUE_TYPE i_eAttentionType );
// SetGlobalAttentionType(uint8_t ga); // FIXME : remove this function when merge, no longer used
private:
enum
{
SRCFILL_FORMAT = 1,
SRCFILL_GROUP = 7
};
};
} // end namespace PRDF
#endif //IIPSDBUG_H
|
