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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/framework/register/prdfScomRegister.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 iipScomRegister_h
#define iipScomRegister_h
/**
* @brief Models register.It does not contain target.
*
* This class stores the hash id and bit length of scom registers It models
* registers without maintaining target information. Instances of this class
* are shared across rule chip objects of same type.Once prd object model is
* built, instances of this register are saved in flyweight.These instances
* persist as long as prd object model survives.
*/
#include <iipscr.h>
#include <iipbits.h>
#include <iipMopRegisterAccess.h>
#include <prdfTrace.H>
namespace PRDF
{
// Forward References
class CHIP_CLASS;
class MopsRegisterAccess;
class ExtensibleChip;
class ScomRegister : public SCAN_COMM_REGISTER_CLASS
{
public:
/**
* @brief constructor
* @param i_address address of the register
* @param i_bitLength bit length of register
* @param i_targetType target type associated with register
*/
ScomRegister( uint64_t i_address, uint32_t i_bitLength,
TARGETING::TYPE i_targetType, AccessLevel i_access ) :
SCAN_COMM_REGISTER_CLASS(),
iv_bitLength( i_bitLength ),
iv_chipType( i_targetType ),
iv_scomAddress( i_address ),
iv_operationType( i_access )
{}
/**
* @brief constructor .Added this because we save object of this type in
* @ FlyweightS
*/
ScomRegister():
SCAN_COMM_REGISTER_CLASS(),
iv_bitLength( 0 ),
iv_chipType( TARGETING::TYPE_NA ),
iv_scomAddress( 0 ),
iv_operationType( ACCESS_NONE )
{}
/**
* @brief Returns the pointer to bit string
* @param i_type attention type
* @return BIT_STRING_CLASS * pointer to bit string
*/
virtual const BIT_STRING_CLASS * GetBitString(ATTENTION_TYPE i_type =
INVALID_ATTENTION_TYPE) const;
/**
* @brief Updates bit string contents associated with register
* @param i_bs poiner to bit string
* @return Nil
*/
virtual void SetBitString(const BIT_STRING_CLASS * i_bs) ;
/**
* @brief Returns length of the bits string associated with register
* @return length of bit string
*/
uint32_t GetBitLength(void) const { return iv_bitLength ;}
/**
* @brief Directly reads from hardware register
* @return SUCCESS|FAIL
*/
virtual uint32_t ForceRead() const;
/**
* @brief Returns contents of register.If entry does not exist in cache
* a fresh entry is created and hardware is read.
* @return SUCCESS|FAIL
*/
virtual uint32_t Read() const;
/**
* @brief Writes cache contents to register.
* @return SUCCESS|FAIL
*/
virtual uint32_t Write();
/**
* @brief Returns the hash id of register
* @return returns hash id of register
* @pre None
* @post None
* @note
*/
virtual uint16_t GetId(void) const { return iv_shortId; };
/**
* @brief Sets the hash id of register
* @param i_id hash id of register
* @return Nil
*/
virtual void SetId(uint16_t i_id) { iv_shortId = i_id; };
/**
* @brief Returns type of Target associated with register.
* @return Refer to function description
*/
TARGETING::TYPE getChipType()const{ return iv_chipType ;} ;
/**
* @brief Returns scom address of register
* @return Refer to function description
*/
uint64_t GetAddress( ) const {return iv_scomAddress ;};
/**
* @brief compares two ScomRegisterAccess register for equality
* @param i_rightRegister register to be compared against
* @return Returns true if registers are equal false otherwise
*/
bool operator == ( const ScomRegister & i_rightRegister ) const ;
/**
* @brief defines < operation for ScomRegisterAccess
* @param i_rightRegister register to be compared against
* @return Returns false if i_rightRegisters is less and true otherwise
*/
bool operator < ( const ScomRegister & i_rightRegister ) const ;
/**
* @brief defines >= operation for ScomRegisterAccess
* @param i_rightRegister register to be compared against
* @return Returns true if registers is >= i_rightRegister false
* otherwise
*/
bool operator >= ( const ScomRegister & i_rightRegister ) const;
/** @return The register access level (see enum AccessLevel). */
virtual AccessLevel getAccessLevel() const { return iv_operationType; }
/** @brief Sets the register access level (see enum AccessLevel). */
virtual void setAccessLevel( AccessLevel i_op ) { iv_operationType = i_op; }
protected: // Functions
/**
* @brief copy constructor
* @param i_scomRegister scomRegister instance to be copied
*/
ScomRegister( const SCAN_COMM_REGISTER_CLASS & i_scomRegister ):
SCAN_COMM_REGISTER_CLASS(),
iv_bitLength( i_scomRegister.GetBitLength() ),
iv_shortId( i_scomRegister.GetId() ),
iv_chipType( i_scomRegister.getChipType() ),
iv_scomAddress( i_scomRegister.GetAddress() ),
iv_operationType( i_scomRegister.getAccessLevel() )
{}
/**
* @brief Returns reference to bit string associated with register
* @return Refer to function description
*/
virtual BIT_STRING_CLASS & AccessBitString( );
/**
* @brief Gets the register read and write done by calling access
* function of scom accessor service.
* @param reference to bit string maintained in caller class
* @param Read or write operation
* @return [SUCCESS|FAIL]
*/
uint32_t Access( BIT_STRING_CLASS & bs,
MopRegisterAccess::Operation op )const;
/**
* @brief Returns rulechip pointer associated with the register
* @return Refer to function description
*/
virtual ExtensibleChip * getChip() const;
private: // functions
friend class CaptureData;
/** @return TRUE if entry for this register exist in this cache. */
bool queryCache() const;
/**
* @brief Reads register contents from cache.
* @return Reference to bit string buffer maintained in cache.
*/
BIT_STRING_CLASS & readCache() const;
/**
* @brief Deletes one or all entry in the cache
* @param RuleChip pointer associated with register
* @return Nil
*/
void flushCache( ExtensibleChip *i_pChip = NULL ) const;
private: // Data
uint32_t iv_bitLength; // bit length of scom
uint16_t iv_shortId; // unique hash id of register
TARGETING::TYPE iv_chipType; // type of target associated with register
uint64_t iv_scomAddress; // scom address associated with regiser
AccessLevel iv_operationType; // Operation supported (RO, WO, or RW)
};
}//namespace PRDF ends
#endif
|
