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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/scom/scom.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,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 __SCOM_H
#define __SCOM_H
#include <devicefw/driverif.H>
/** @file scom.H
* @brief Provides the interfaces to perform a SCom
*/
namespace SCOM
{
/**
* @brief Indirect SCOM Status
*/
union IndirectScom_t
{
uint64_t data64;
struct
{
uint64_t :12; //0:11
uint64_t addr:20; //12:31
uint64_t done:1; //32
uint64_t piberr:3; //33:35
uint64_t userstat:4; //36:39
uint64_t :8; //40:47
uint64_t data:16; //48:63
};
};
enum ScomErrorMask
{
// checkf for complete bit .. bit 32
SCOM_IND_COMPLETE_MASK = 0x0000000080000000,
//check for bits 33-35
SCOM_IND_ERROR_MASK = 0x0000000070000000
};
/**
* @brief Performs a SCom operation
* This function performs a SCOM operation by calling
* checkIndirectScomOP. It handles whether the address
* a regular or an indirect SCOM address
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/(userif.H)
* @param[in] i_args This is an argument list for DD framework.
* In this function, there's only one argument,
* which is the SCom address value.
*
* @return errlHndl_t
*/
errlHndl_t scomPerformOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
va_list i_args);
/**
* @brief Performs a SCom operation on a target TYPE_MEMBUF
* This function performs a SCOM operation by calling
* checkIndirectScomOP. It handles whether the address
* a regular or an indirect SCOM address
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/(userif.H)
* @param[in] i_args This is an argument list for DD framework.
* In this function, there's only one argument,
* which is the SCom address value.
*
* @return errlHndl_t
*/
errlHndl_t scomMemBufPerformOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
va_list i_args);
/**
* @brief Performs a SCom operation
* This function performs an SCom Read/Write operation. It follows a
* pre-defined prototype functions in order to be registered with the
* device-driver framework.
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/userif.H
* @param[in] i_addr scom Address Value
*
* @return errlHndl_t
*/
errlHndl_t doScomOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
/**
* @brief Performs a SCom operation
* This function determines whether the scom in inband or not, and the
* form of the scom operation. It then calls the apporpriate doForm operation
*
* @param[in] i_opType Operation type
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/userif.H
* @param[in] i_addr Scom Address Value.
*
* @return errlHndl_t
*/
errlHndl_t checkIndirectAndDoScom(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
/**
* @brief Performs a SCom operation
* This function sets up the needed scom registers based on form 0
* and calls doScomOp
*
* @param[in] i_opType Operation type
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/userif.H
* @param[in] i_addr Scom Address Value.
*
* @return errlHndl_t
*/
errlHndl_t doForm0IndirectScom(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
/**
* @brief Performs a SCom operation
* This function sets up the needed scom registers based on form 1
* and calls doScomOp
*
* @param[in] i_opType Operation type
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* @see usr/devicefw/userif.H
* @param[in] i_addr Scom Address Value.
*
* @return errlHndl_t
*/
errlHndl_t doForm1IndirectScom(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
}; // End namespace
#endif
|
