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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/attn/attnscom.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,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 __ATTN_ATTNSCOM_H
#define __ATTN_ATTNSCOM_H
/**
* @file attnscom.H
*
* @brief HBATTN SCOM abstraction layer definitions.
*/
#include "attnfwd.H"
namespace ATTN
{
/**
* @brief ScomImpl SCOM interface requirement.
*
* This default implementation routes SCOM calls to real hardware.
*/
class ScomImpl
{
public:
/**
* @brief putScom Write a register using SCOM.
*
* @param[in] i_target Target to write register on.
* @param[in] i_address Register address to write to.
* @param[in] i_data Data to write to register.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
virtual errlHndl_t putScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t i_data);
/**
* @brief getScom Read a register using SCOM.
*
* @param[in] i_target Target to read register from.
* @param[in] i_address Register address to read from.
* @param[out] o_data Buffer to write register content to.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
virtual errlHndl_t getScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t & o_data);
/**
* @brief modifyScom RMW a register using SCOM.
*
* @param[in] i_target Target to update register on.
* @param[in] i_address Register address to update.
* @param[in] i_data Data to write to register.
* @param[out] o_data Data read from register.
* @param[in] i_op and/or behavior.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
virtual errlHndl_t modifyScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t i_data,
uint64_t & o_data,
ScomOp i_op);
/**
* @brief installScomImpl
*
* Set this as the active scom implementation.
*/
void installScomImpl();
/**
* @brief dtor
*/
virtual ~ScomImpl();
/**
* @brief ctor
*/
ScomImpl() {}
private:
/**
* @brief copy Disabled.
*/
ScomImpl(const ScomImpl &);
/**
* @brief assignment Disabled.
*/
ScomImpl & operator=(const ScomImpl &);
};
/**
* @brief ScomWrapper Holds the installed SCOM implementation.
*/
class ScomWrapper
{
public:
/**
* @brief setImpl Change the SCOM implementation to be used.
*
* @param[in] i_impl The new implemenation to use.
*/
void setImpl(ScomImpl & i_impl)
{
iv_impl = &i_impl;
}
/**
* @brief putScom Write a register using SCOM.
*
* Routes to the current SCOM implementation.
*
* @param[in] i_target Target to write register on.
* @param[in] i_address Register address to write to.
* @param[in] i_data Data to write to register.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
errlHndl_t putScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t i_data);
/**
* @brief getScom Read a register using SCOM.
*
* Routes to the current SCOM implementation.
*
* @param[in] i_target Target to read register from.
* @param[in] i_address Register address to read from.
* @param[out] o_data Buffer to write register content to.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
errlHndl_t getScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t & o_data);
/**
* @brief modifyScom RMW a register using SCOM.
*
* @param[in] i_target Target to update register on.
* @param[in] i_address Register address to update.
* @param[in] i_data Data to write to register.
* @param[out] o_data Data read from register.
* @param[in] i_op and/or behavior.
*
* @retval[0] No errors.
* @retval[!0] Unexpected error occurred.
*/
errlHndl_t modifyScom(
TARGETING::TargetHandle_t i_target,
uint64_t i_address,
uint64_t i_data,
uint64_t & o_data,
ScomOp i_op);
/**
* @brief ctor
*/
ScomWrapper();
private:
/**
* @brief iv_impl The SCOM implementation to
* which calls should be forwarded.
*/
ScomImpl * iv_impl;
/**
* @brief copy Disabled.
*/
ScomWrapper(const ScomWrapper &);
/**
* @brief assignment Disabled.
*/
ScomWrapper & operator=(const ScomWrapper &);
/**
* @brief Give access to the default implementation.
*/
friend class ScomImpl;
};
}
#endif
|
