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
264
265
|
/** @file
This library provides SMM functions for IO and PCI IO access.
These can be used to save size and simplify code.
All contents must be runtime and SMM safe.
@copyright
Copyright (c) 1999 - 2013 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains a 'Sample Driver' and is licensed as such
under the terms of your license agreement with Intel or your
vendor. This file may be modified by the user, subject to
the additional terms of the license agreement
**/
#ifndef _SMM_IO_LIB_H_
#define _SMM_IO_LIB_H_
#include "EdkIIGlueDxe.h"
#include "Pci22.h"
///
/// Utility consumed protocols
///
#include EFI_PROTOCOL_DEFINITION (SmmBase)
///
/// Global variables that must be defined and initialized to use this library
///
extern EFI_SMM_SYSTEM_TABLE *mSmst;
///
/// Definitions
///
#define ICH_ACPI_TIMER_MAX_VALUE 0x1000000 ///< The timer is 24 bit overflow
///
/// Pci I/O related data structure deifinition
///
typedef enum {
SmmPciWidthUint8 = 0,
SmmPciWidthUint16 = 1,
SmmPciWidthUint32 = 2,
SmmPciWidthUint64 = 3,
SmmPciWidthMaximum
} SMM_PCI_IO_WIDTH;
#define SMM_PCI_ADDRESS(bus, dev, func, reg) \
((UINT64) ((((UINT32) bus) << 24) + (((UINT32) dev) << 16) + (((UINT32) func) << 8) + ((UINT32) reg)))
typedef struct {
UINT8 Register;
UINT8 Function;
UINT8 Device;
UINT8 Bus;
UINT32 ExtendedRegister;
} SMM_PCI_IO_ADDRESS;
///
/// CPU I/O Access Functions
///
/**
Do a one byte IO read
@param[in] Address - IO address to read
@retval Data read
**/
UINT8
SmmIoRead8 (
IN UINT16 Address
);
/**
Do a one byte IO write
@param[in] Address - IO address to write
@param[in] Data - Data to write
**/
VOID
SmmIoWrite8 (
IN UINT16 Address,
IN UINT8 Data
);
/**
Do a two byte IO read
@param[in] Address - IO address to read
@retval Data read
**/
UINT16
SmmIoRead16 (
IN UINT16 Address
);
/**
Do a two byte IO write
@param[in] Address - IO address to write
@param[in] Data - Data to write
**/
VOID
SmmIoWrite16 (
IN UINT16 Address,
IN UINT16 Data
);
/**
Do a four byte IO read
@param[in] Address - IO address to read
@retval Data read
**/
UINT32
SmmIoRead32 (
IN UINT16 Address
);
/**
Do a four byte IO write
@param[in] Address - IO address to write
@param[in] Data - Data to write
**/
VOID
SmmIoWrite32 (
IN UINT16 Address,
IN UINT32 Data
);
/**
Do a one byte Memory write
@param[in] Dest - Memory address to write
@param[in] Data - Data to write
@retval None
**/
VOID
SmmMemWrite8 (
IN UINT64 Dest,
IN UINT8 Data
);
/**
Do a one byte Memory read
@param[in] Dest - Memory address to read
@retval Data read
**/
UINT8
SmmMemRead8 (
IN UINT64 Dest
);
/**
Do a two bytes Memory write
@param[in] Dest - Memory address to write
@param[in] Data - Data to write
@retval None
**/
VOID
SmmMemWrite16 (
IN UINT64 Dest,
IN UINT16 Data
);
/**
Do a two bytes Memory read
@param[in] Dest - Memory address to read
@retval Data read
**/
UINT16
SmmMemRead16 (
IN UINT64 Dest
);
/**
Do a four bytes Memory write
@param[in] Dest - Memory address to write
@param[in] Data - Data to write
@retval None
**/
VOID
SmmMemWrite32 (
IN UINT64 Dest,
IN UINT32 Data
);
/**
Do a four bytes Memory read
@param[in] Dest - Memory address to read
@retval Data read
**/
UINT32
SmmMemRead32 (
IN UINT64 Dest
);
/**
Do a four bytes Memory read, then AND with Data, then write back to the same address
@param[in] Dest - Memory address to write
@param[in] Data - Data to do AND
@retval None
**/
VOID
SmmMemAnd32 (
IN UINT64 Dest,
IN UINT32 Data
);
///
/// Pci Configuration Space access functions definition
///
/**
Read value from the specified PCI config space register
@param[in] Width - The width (8, 16 or 32 bits) of accessed pci config space register
@param[in] Address - The address of the accessed pci register (bus, dev, func, offset)
@param[in] Buffer - The returned value
@retval EFI_SUCCESS - All operations successfully
@retval EFI_INVALID_PARAMETER - Width is not valid or dosn't match register address
@retval Other error code - If any error occured when calling libiary functions
**/
EFI_STATUS
SmmPciCfgRead (
IN SMM_PCI_IO_WIDTH Width,
IN SMM_PCI_IO_ADDRESS *Address,
IN OUT VOID *Buffer
);
/**
Write value into the specified PCI config space register
@param[in] Width - The width (8, 16 or 32 bits) of accessed pci config space register
@param[in] Address - The address of the accessed pci register (bus, dev, func, offset)
@param[in] Buffer - The returned value
@retval EFI_SUCCESS - All operations successfully
@retval EFI_INVALID_PARAMETER - Width is not valid or dosn't match register address
@retval Other error code - If any error occured when calling libiary functions
**/
EFI_STATUS
SmmPciCfgWrite (
IN SMM_PCI_IO_WIDTH Width,
IN SMM_PCI_IO_ADDRESS *Address,
IN OUT VOID *Buffer
);
#endif
|
