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
|
/** @file
Internal interfaces specific to the QemuFwCfgLibMmio instances in OvmfPkg.
Copyright (C) 2016, Red Hat, Inc.
Copyright (C) 2017, Advanced Micro Devices. All rights reserved
Copyright (c) 2024 Loongson Technology Corporation Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef QEMU_FW_CFG_LIB_MMIO_INTERNAL_H_
#define QEMU_FW_CFG_LIB_MMIO_INTERNAL_H_
typedef struct {
UINTN FwCfgSelectorAddress;
UINTN FwCfgDataAddress;
UINTN FwCfgDmaAddress;
} QEMU_FW_CFG_RESOURCE;
/**
Reads firmware configuration bytes into a buffer
@param[in] Size Size in bytes to read
@param[in] Buffer Buffer to store data into (OPTIONAL if Size is 0)
**/
typedef
VOID(EFIAPI READ_BYTES_FUNCTION)(
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Writes bytes from a buffer to firmware configuration
@param[in] Size Size in bytes to write
@param[in] Buffer Buffer to transfer data from (OPTIONAL if Size is 0)
**/
typedef
VOID(EFIAPI WRITE_BYTES_FUNCTION)(
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Skips bytes in firmware configuration
@param[in] Size Size in bytes to skip
**/
typedef
VOID(EFIAPI SKIP_BYTES_FUNCTION)(
IN UINTN Size
);
/**
Reads firmware configuration bytes into a buffer
@param[in] Size Size in bytes to read
@param[in] Buffer Buffer to store data into (OPTIONAL if Size is 0)
**/
extern
VOID (EFIAPI *InternalQemuFwCfgReadBytes)(
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Writes bytes from a buffer to firmware configuration
@param[in] Size Size in bytes to write
@param[in] Buffer Buffer to transfer data from (OPTIONAL if Size is 0)
**/
extern
VOID (EFIAPI *InternalQemuFwCfgWriteBytes)(
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Skips bytes in firmware configuration
@param[in] Size Size in bytes to skip
**/
extern
VOID (EFIAPI *InternalQemuFwCfgSkipBytes)(
IN UINTN Size
);
/**
Build firmware configure resource HOB.
@param[in] FwCfgResource A pointer to firmware configure resource.
@retval NULL
**/
VOID
QemuBuildFwCfgResourceHob (
IN QEMU_FW_CFG_RESOURCE *FwCfgResource
);
/**
Get firmware configure resource HOB.
@param VOID
@retval FwCfgResource The firmware configure resouce in HOB.
**/
QEMU_FW_CFG_RESOURCE *
QemuGetFwCfgResourceHob (
VOID
);
/**
To get firmware configure selector address.
@param VOID
@retval firmware configure selector address
**/
UINTN
EFIAPI
QemuGetFwCfgSelectorAddress (
VOID
);
/**
To get firmware configure Data address.
@param VOID
@retval firmware configure data address
**/
UINTN
EFIAPI
QemuGetFwCfgDataAddress (
VOID
);
/**
To get firmware DMA address.
@param VOID
@retval firmware DMA address
**/
UINTN
EFIAPI
QemuGetFwCfgDmaAddress (
VOID
);
/**
Slow READ_BYTES_FUNCTION.
**/
VOID
EFIAPI
MmioReadBytes (
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Slow WRITE_BYTES_FUNCTION.
**/
VOID
EFIAPI
MmioWriteBytes (
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Slow SKIP_BYTES_FUNCTION.
**/
VOID
EFIAPI
MmioSkipBytes (
IN UINTN Size
);
/**
Fast READ_BYTES_FUNCTION.
**/
VOID
EFIAPI
DmaReadBytes (
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Fast WRITE_BYTES_FUNCTION.
**/
VOID
EFIAPI
DmaWriteBytes (
IN UINTN Size,
IN VOID *Buffer OPTIONAL
);
/**
Fast SKIP_BYTES_FUNCTION.
**/
VOID
EFIAPI
DmaSkipBytes (
IN UINTN Size
);
/**
Transfer an array of bytes, or skip a number of bytes, using the DMA
interface.
@param[in] Size Size in bytes to transfer or skip.
@param[in,out] Buffer Buffer to read data into or write data from. Ignored,
and may be NULL, if Size is zero, or Control is
FW_CFG_DMA_CTL_SKIP.
@param[in] Control One of the following:
FW_CFG_DMA_CTL_WRITE - write to fw_cfg from Buffer.
FW_CFG_DMA_CTL_READ - read from fw_cfg into Buffer.
FW_CFG_DMA_CTL_SKIP - skip bytes in fw_cfg.
**/
VOID
DmaTransferBytes (
IN UINTN Size,
IN OUT VOID *Buffer OPTIONAL,
IN UINT32 Control
);
#endif
|
