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
|
/*++
Copyright (c) 2004, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which 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.
Module Name:
CpuIo.h
Abstract:
*.h file for the driver
Note: the EFIAPI on the CpuIo functions is used to glue MASM (assembler) code
into C code. By making the MASM functions EFIAPI it ensures that a standard
C calling convention is assumed by the compiler, reguardless of the compiler
flags.
--*/
#ifndef _CPU_IO_H
#define _CPU_IO_H
#include <PiDxe.h>
#include <Protocol/CpuIo.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#define VOLATILE volatile
typedef union {
UINT8 VOLATILE *buf;
UINT8 VOLATILE *ui8;
UINT16 VOLATILE *ui16;
UINT32 VOLATILE *ui32;
UINT64 VOLATILE *ui64;
UINTN VOLATILE ui;
} PTR;
EFI_STATUS
EFIAPI
CpuIoInitialize (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
CpuIo driver entry point.
Arguments:
ImageHandle - The firmware allocated handle for the EFI image.
SystemTable - A pointer to the EFI System Table.
Returns:
EFI_SUCCESS - The driver was initialized.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.
--*/
;
EFI_STATUS
EFIAPI
CpuMemoryServiceRead (
IN EFI_CPU_IO_PROTOCOL *This,
IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
OUT VOID *Buffer
)
/*++
Routine Description:
Perform the memory mapped I/O read service
Arguments:
This - Pointer to an instance of the CPU I/O Protocol
Width - Width of the memory mapped I/O operation
Address - Base address of the memory mapped I/O operation
Count - Count of the number of accesses to perform
Buffer - Pointer to the destination buffer to store the results
Returns:
EFI_SUCCESS - The data was read.
EFI_INVALID_PARAMETER - Width is invalid.
EFI_INVALID_PARAMETER - Buffer is NULL.
EFI_UNSUPPORTED - The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED - The address range specified by Address, Width,
and Count is not valid.
--*/
;
EFI_STATUS
EFIAPI
CpuMemoryServiceWrite (
IN EFI_CPU_IO_PROTOCOL *This,
IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
IN VOID *Buffer
)
/*++
Routine Description:
Perform the memory mapped I/O write service
Arguments:
This - Pointer to an instance of the CPU I/O Protocol
Width - Width of the memory mapped I/O operation
Address - Base address of the memory mapped I/O operation
Count - Count of the number of accesses to perform
Buffer - Pointer to the source buffer from which to write data
Returns:
EFI_SUCCESS - The data was written.
EFI_INVALID_PARAMETER - Width is invalid.
EFI_INVALID_PARAMETER - Buffer is NULL.
EFI_UNSUPPORTED - The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED - The address range specified by Address, Width,
and Count is not valid.
--*/
;
EFI_STATUS
EFIAPI
CpuIoServiceRead (
IN EFI_CPU_IO_PROTOCOL *This,
IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
IN UINT64 UserAddress,
IN UINTN Count,
OUT VOID *UserBuffer
)
/*++
Routine Description:
Perform the port I/O read service
Arguments:
This - Pointer to an instance of the CPU I/O Protocol
Width - Width of the port I/O operation
Address - Base address of the port I/O operation
Count - Count of the number of accesses to perform
Buffer - Pointer to the destination buffer to store the results
Returns:
EFI_SUCCESS - The data was read.
EFI_INVALID_PARAMETER - Width is invalid.
EFI_INVALID_PARAMETER - Buffer is NULL.
EFI_UNSUPPORTED - The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED - The address range specified by Address, Width,
and Count is not valid.
--*/
;
EFI_STATUS
EFIAPI
CpuIoServiceWrite (
IN EFI_CPU_IO_PROTOCOL *This,
IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
IN UINT64 UserAddress,
IN UINTN Count,
IN VOID *UserBuffer
)
/*++
Routine Description:
Perform the port I/O write service
Arguments:
This - Pointer to an instance of the CPU I/O Protocol
Width - Width of the port I/O operation
Address - Base address of the port I/O operation
Count - Count of the number of accesses to perform
Buffer - Pointer to the source buffer from which to write data
Returns:
EFI_SUCCESS - The data was written.
EFI_INVALID_PARAMETER - Width is invalid.
EFI_INVALID_PARAMETER - Buffer is NULL.
EFI_UNSUPPORTED - The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED - The address range specified by Address, Width,
and Count is not valid.
--*/
;
EFI_STATUS
CpuIoCheckParameter (
IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
IN VOID *Buffer,
IN UINT64 Limit
)
/*++
Routine Description:
Check the validation of parameters for CPU I/O interface functions.
Arguments:
Width - Width of the Memory Access
Address - Address of the Memory access
Count - Count of the number of accesses to perform
Buffer - Pointer to the buffer to read from memory
Buffer - Memory buffer for the I/O operation
Limit - Maximum address supported
Returns:
EFI_INVALID_PARAMETER - Buffer is NULL
EFI_UNSUPPORTED - The address range specified by Width, Address and Count is invalid
EFI_UNSUPPORTED - The memory buffer is not aligned
EFI_SUCCESS - Parameters are OK
--*/
;
#endif
|
