blob: 1c771330f3fb284c0547b9bafa045bffd23e94b0 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/framework/config/xspprdAccessPllChip.h $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2000,2012 */
/* */
/* 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 xspprdAccessPllChip_h
#define xspprdAccessPllChip_h
// Class Description *************************************************
//
// Name: xspprdAccessPllChip
// Base class: PllChip
//
// Description: Provide PLL support for chips that have Access jtag interface
// Usage:
//
// End Class Description *********************************************
//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(IIPCHIP_H)
#include <iipchip.h>
#endif
//--------------------------------------------------------------------
// Forward References
//--------------------------------------------------------------------
/**
* Provide PLL support for chips that have Access jtag interface
*
* @author Doug Gilbert
*/
class AccessPllChip : public CHIP_CLASS
{
public:
/**
* @brief Constructor
* @param i_target A chip target.
*/
explicit AccessPllChip( TARGETING::TargetHandle_t i_target );
/**
Query hardware to see if there is a PLL error reported by this chip
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> [true | false]
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
virtual bool QueryPll();
/**
Clear the pll check bit(s) in the hardware
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> return code
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
</ul><br>
*/
virtual int32_t ClearPll();
/**
Disable the reporting of PLL errors in the hardware
<ul>
<br><b>Parameters: </b> serviceData
<br><b>Returns: </b> return code
<br><b>Requirements:</b> none.
<br><b>Promises: </b> serviceData may be modified
<br><b>Exceptions: </b> None.
</ul><br>
*/
virtual int32_t MaskPll(STEP_CODE_DATA_STRUCT & serviceData);
/**
Enable the reporting of PLL errors in the hardware
<ul>
<br><b>Parameters: </b> None.
<br><b>Returns: </b> return code
<br><b>Requirements:</b> none.
<br><b>Promises: </b> none.
<br><b>Exceptions: </b> None.
</ul><br>
*/
virtual int32_t UnMaskPll();
/**
* Add the PLL status register to the service Capturedata
* @param Service Data collector
* @pre none
* @post service data collectors' capture data has the content of the PLL
* status reg
*/
void CapturePll(STEP_CODE_DATA_STRUCT & serviceData);
private: // functions
/**
Copy constructor - Forbidden
<ul>
<br><b>Notes: </b> No definitions should exist
</ul><br>
*/
AccessPllChip(const AccessPllChip &);
/**
Assignment operator - Forbidden
<ul>
<br><b>Notes: </b> No definitions should exist
</ul><br>
*/
AccessPllChip & operator=(const AccessPllChip &);
private: // Data
};
inline AccessPllChip::AccessPllChip( TARGETING::TargetHandle_t i_target ) :
CHIP_CLASS(i_target)
{}
#endif /* xspprdAccessPllChip_h */
|
