blob: 90f5f751d1301097bbba8a008ebd521a9898fed6 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/resolution/iipCalloutMap.h $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 1996,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 iipCalloutMap_h
#define iipCalloutMap_h
// Class Description *************************************************
//
// Name: iipCalloutMap
// Base class:
//
// Description: Map ChipiD's to Mru callouts
// Usage:
//
// CalloutMap calloutMap();
//
// foo(CalloutMap & calloutMap, CHIP_CLASS * chip)
// {
// uint32_t chip_id = chip->GetId();
// MruCallout m1 = calloutMap.GetCallout(chip_id,HIGH);
// }
//
// End Class Description *********************************************
//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(PRDF_TYPES_H)
#include <prdf_types.h>
#endif
#include <prdfCallouts.H>
//--------------------------------------------------------------------
// Forward References
//--------------------------------------------------------------------
namespace PRDF
{
/**
Convert a chipid to a mru callout
@author Douglas R. Gilbert
@version V4R5
*/
class CalloutMap
{
public:
enum probability { HIGH_PROBABILITY, LOW_PROBABILITY };
/**
CTOR
<ul>
<br><b>Parameters: </b> None
<br><b>Returns: </b> None
<br><b>Requirements:</b> None
<br><b>Promises: </b> Object created
<br><b>Exceptions: </b> None.
</ul><br>
*/
CalloutMap();
// Function Specification ********************************************
//
// Purpose: Destruction
// Parameters: None.
// Returns: No value returned
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
// Notes: Compiler default is sufficient
//
// End Function Specification ****************************************
// ~iipCalloutMap();
/**
Return a MruCallout for a chipId (Apache/Northstar)
<ul>
<br><b>Parameters: </b> chipId, probability
<br><b>Returns: </b> MruCallout
<br><b>Requirements:</b> Valid chipId
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Implemented for Apache and Northstar only
</ul><br>
*/
//MruCallout GetCallout(uint32_t chipId, probability prb = HIGH_PROBABILITY) const;
/**
Get a MruValues for a chipId (Condor/CSP)
<ul>
<br><b>Parameters: </b> ChipId
<br><b>Returns: </b> MruValues (see xspiiCallout.h)
<br><b>Requirements:</b> Valid chipId
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Implemented for Condor and CSP only
</ul><br>
*/
PRDF::MruValues GetMruCallout(uint32_t chipId) const;
/**
Get a MruValues for a chipId (Regatta/CSP)
<ul>
<br><b>Parameters: </b> ChipEnum
<br><b>Returns: </b> MruValues (see xspiiCallout.h)
<br><b>Requirements:</b> Valid chipEnum
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b> Implemented for Regatta and CSP only
</ul><br>
*/
PRDF::MruValues GetMruCallout(ChipEnum chipEnum) const;
private: // functions
private: // Data
};
} // end namespace PRDF
#endif /* iipCalloutMap_h */
// Change Log *********************************************************
//
// Flag Reason Vers Date Coder Description
// ---- -------- ---- -------- ----- -------------------------------
// d24758.1 v4r1 05/20/96 DRG Initial Creation
// D49127.7 V4R1 09/27/96 DRG Made data static
// D49274.1 V4R5 06/08/98 DRG MOdify to support v4r5
// D49420.x v5r2 07/17/00 mak modify to support v5r2
//
// End Change Log *****************************************************
|
