blob: 1649c44d99de409f981e5f2ffdac0e71b5bdb900 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/plat/pegasus/prdfCenMarkstore.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2013,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* 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 prdfCenMarkstore_H
#define prdfCenMarkstore_H
/** @file prdfCenMarkstore.H */
#include <prdfCenAddress.H>
#include <prdfMemConst.H>
#include <prdfCenSymbol.H>
#include <prdfTargetFwdRef.H>
//##############################################################################
// class CenMark
//##############################################################################
namespace PRDF
{
/**
* @brief Container for a memory symbol and chip mark.
* @note When reading and writing markstore the symbol and chip marks are set
* or returned as a pair. This is a simple container to keep the two
* marks bundled.
*/
class CenMark
{
public: // constructors
/** @brief Default constructor */
CenMark() :
iv_symbolMark(), iv_chipMark()
{}
/** @brief Constructor from components */
CenMark( const CenSymbol & i_symbolMark, const CenSymbol & i_chipMark ) :
iv_symbolMark(i_symbolMark), iv_chipMark(i_chipMark)
{}
public: // functions
/** @return A symbol representing the symbol mark. */
CenSymbol getSM() const { return iv_symbolMark; }
/** @return A symbol representing the chip mark. */
CenSymbol getCM() const { return iv_chipMark; }
/** @brief Sets the symbol mark to the given symbol. */
void setSM( const CenSymbol & i_symbolMark )
{ iv_symbolMark = i_symbolMark; }
/** @brief Sets the chip mark to the given symbol. */
void setCM( const CenSymbol & i_chipMark ) { iv_chipMark = i_chipMark; }
/** @brief Sets the symbol mark to an invalid symbol. */
void clearSM() { iv_symbolMark = CenSymbol(); }
/** @brief Sets the chip mark to an invalid symbol. */
void clearCM() { iv_chipMark = CenSymbol(); }
private: // instance variables
CenSymbol iv_symbolMark; ///< A symbol representing the symbol mark.
CenSymbol iv_chipMark; ///< A symbol representing the chip mark.
};
} // end namespace PRDF
#endif // prdfCenMarkstore_H
|