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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/** @file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __USRA_ACCESS_LIB_H__
#define __USRA_ACCESS_LIB_H__
#include <Base.h>
#include <Library/UsraAccessApi.h>
#include <Library/CsrToPcieAddress.h>
#include <Library/PcieAddress.h>
#include <Library/BaseLib.h>
#include <Library/IoLib.h>
#include <Library/S3BootScriptLib.h>
//
// Get Aligned Access Address
//
typedef
VOID
(EFIAPI *GET_ALLIGNED_ACCESS_ADDRESS) (VOID*, BOOLEAN, USRA_ADDRESS*, UINTN*);
//
// Register Read
//
typedef
RETURN_STATUS
(EFIAPI *REGISTER_READ) (USRA_ADDRESS *, VOID *);
//
// Register Write
//
typedef
RETURN_STATUS
(EFIAPI *REGISTER_WRITE) (USRA_ADDRESS *, VOID *);
//
// Register Write
//
typedef
RETURN_STATUS
(EFIAPI *REGISTER_MODIFY) (USRA_ADDRESS *, VOID *, VOID *);
/**
This API get the Pcie address from the given USRA Address.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@retval NONE
**/
VOID
GetPcieAccessAddress (
IN VOID *Global,
IN BOOLEAN Virtual,
IN USRA_ADDRESS *Address,
OUT UINTN *AlignedAddress
);
/**
This API get the CSR address from the given USRA Address.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@param[in] Buffer A pointer of buffer for the value read from the register
@retval NONE
**/
VOID
GetCsrAccessAddress (
IN VOID *Global,
IN BOOLEAN Virtual,
IN USRA_ADDRESS *Address,
OUT UINTN *AlignedAddress
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit Pcie silicon register read operations.
It transfers data from a register into a naturally aligned data buffer.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@param[in] Buffer A pointer of buffer for the value read from the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
PcieRegisterRead (
IN USRA_ADDRESS *Address,
IN VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit Pcie block silicon register read operations.
It transfers data from a register into a naturally aligned data buffer.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@param[in] Buffer A pointer of buffer for the value read from the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
PcieBlkRegisterRead (
IN USRA_ADDRESS *Address,
IN VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit CSR silicon register read operations.
It transfers data from a register into a naturally aligned data buffer.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@param[in] Buffer A pointer of buffer for the value read from the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
CsrRegisterRead (
IN USRA_ADDRESS *Address,
IN VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit Pcie silicon register write operations.
It transfers data from a naturally aligned data buffer into a register.
@param[in] Address A pointer of the address of the USRA Address Structure to be written
@param[in] Buffer A pointer of buffer for the value write to the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
PcieRegisterWrite (
IN USRA_ADDRESS *Address,
OUT VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit Pcie block silicon register write operations.
It transfers data from a naturally aligned data buffer into a register.
@param[in] Address A pointer of the address of the USRA Address Structure to be written
@param[in] Buffer A pointer of buffer for the value write to the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
PcieBlkRegisterWrite (
IN USRA_ADDRESS *Address,
OUT VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit CSR silicon register write operations.
It transfers data from a naturally aligned data buffer into a register.
@param[in] Address A pointer of the address of the USRA Address Structure to be written
@param[in] Buffer A pointer of buffer for the value write to the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
CsrRegisterWrite (
IN USRA_ADDRESS *Address,
OUT VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit Pcie silicon register AND then OR operations. It read data from a
register, And it with the AndBuffer, then Or it with the OrBuffer, and write the result back to the register
@param[in] Address A pointer of the address of the silicon register to be modified
@param[in] AndBuffer A pointer of buffer for the value used for AND operation
A NULL pointer means no AND operation. RegisterModify() equivalents to RegisterOr()
@param[in] OrBuffer A pointer of buffer for the value used for OR operation
A NULL pointer means no OR operation. RegisterModify() equivalents to RegisterAnd()
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
PcieRegisterModify (
IN USRA_ADDRESS *Address,
IN VOID *AndBuffer,
IN VOID *OrBuffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit CSR silicon register AND then OR operations. It read data from a
register, And it with the AndBuffer, then Or it with the OrBuffer, and write the result back to the register
@param[in] Address A pointer of the address of the silicon register to be modified
@param[in] AndBuffer A pointer of buffer for the value used for AND operation
A NULL pointer means no AND operation. RegisterModify() equivalents to RegisterOr()
@param[in] OrBuffer A pointer of buffer for the value used for OR operation
A NULL pointer means no OR operation. RegisterModify() equivalents to RegisterAnd()
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
CsrRegisterModify (
IN USRA_ADDRESS *Address,
IN VOID *AndBuffer,
IN VOID *OrBuffer
);
/**
Perform MMIO read
@param[in] AccessWidth Access Width
@param[in] AlignedAddress An address to be read out
@param[in] Buffer A pointer of buffer contains the data to be read out
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
UsraRegAlignedRead (
IN UINT32 AccessWidth,
IN UINTN AlignedAddress,
OUT VOID *Buffer
);
/**
Perform AND then OR operations for a input data
@param[in out] Data A pointer of the address of the register to be modified
@param[in] AndBuffer A pointer of buffer for the value used for AND operation
A NULL pointer means no AND operation. RegisterModify() equivalents to RegisterOr()
@param[in] OrBuffer A pointer of buffer for the value used for OR operation
A NULL pointer means no OR operation. RegisterModify() equivalents to RegisterAnd()
@param[in] NumOfByte NumOfByte Count of byte data to be performed
@retval NONE
**/
VOID
DataAndOr (
IN UINT64 *Data,
IN VOID *AndBuffer,
IN VOID *OrBuffer,
IN UINT8 NumOfByte
);
/**
Perform MMIO write
@param[in] AccessWidth Access Width
@param[in] AlignedAddress An address to be written
@param[in] Buffer A pointer of buffer contains the data to be written
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
UsraRegAlignedWrite (
IN UINT32 AccessWidth,
IN UINTN AlignedAddress,
OUT VOID *Buffer
);
#endif
|
