summaryrefslogtreecommitdiff
path: root/Include/Protocol/PciRootBridgeIo.h
blob: bc173a063f716d0f24598b1e785c92003e4423d4 (plain)
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2005, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**             6145-F Northbelt Pkwy, Norcross, GA 30071            **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************

//**********************************************************************
// $Header: /Alaska/BIN/Core/Include/Protocol/PciRootBridgeIo.h 4     2/05/11 2:33p Artems $
//
// $Revision: 4 $
//
// $Date: 2/05/11 2:33p $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/BIN/Core/Include/Protocol/PciRootBridgeIo.h $
// 
// 4     2/05/11 2:33p Artems
// Added EFI_PCI_CONFIGURATION_ADDRESS definition
// 
// 3     10/06/08 3:32p Yakovlevs
// UEFI 2.1 Update
// 
// 2     3/13/06 1:40a Felixp
// 
// 1     1/28/05 12:44p Felixp
// 
// 2     1/18/05 3:22p Felixp
// PrintDebugMessage renamed to Trace
// 
// 1     12/23/04 9:41a Felixp
// 
// 2     2/05/04 6:26p Markw
// Added EFI_PCI_CONFIGURATION_ADDRESS structure.
// 
// 1     2/03/04 10:23a Markw
// 
// 1     2/03/04 10:22a Markw
// 
// 1     1/26/04 3:25p Markw
// 
//**********************************************************************
//<AMI_FHDR_START>
//
// Name: PciRootBridgeIo_h
//
// Description:	Provides functions to access memory/io/pci behind a Pci bridge.
//
//<AMI_FHDR_END>
//**********************************************************************

#ifndef __PCI_ROOT_BRIDGE_IO_PROTOCOL_H__
#define __PCI_ROOT_BRIDGE_IO_PROTOCOL_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <EFI.h>

#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID \
	{0x2F707EBB,0x4A1A,0x11d4,0x9A,0x38,0x00,0x90,0x27,0x3F,0xC1,0x4D}

GUID_VARIABLE_DECLARATION(gEfiPciRootBridgeIoProtocolGuid,EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID);

//*******************************************************
// EFI PCI Root Bridge I/O Protocol Attribute bits
//*******************************************************
#define EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO	0x0001
#define EFI_PCI_ATTRIBUTE_ISA_IO				0x0002
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO		0x0004
#define EFI_PCI_ATTRIBUTE_VGA_MEMORY			0x0008
#define EFI_PCI_ATTRIBUTE_VGA_IO				0x0010
#define EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO		0x0020
#define EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO		0x0040
#define EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE	0x0080
#define EFI_PCI_ATTRIBUTE_MEMORY_CACHED			0x0800
#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE		0x1000
#define EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE	0x8000
//UIEFI 2.1 update
#define EFI_PCI_ATTRIBUTE_ISA_IO_16             0x10000
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16     0x20000
#define EFI_PCI_ATTRIBUTE_VGA_IO_16             0x40000

//*******************************************************
// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
//*******************************************************
typedef enum {
	EfiPciWidthUint8,
	EfiPciWidthUint16,
	EfiPciWidthUint32,
	EfiPciWidthUint64,
	EfiPciWidthFifoUint8,
	EfiPciWidthFifoUint16,
	EfiPciWidthFifoUint32,
	EfiPciWidthFifoUint64,
	EfiPciWidthFillUint8,
	EfiPciWidthFillUint16,
	EfiPciWidthFillUint32,
	EfiPciWidthFillUint64,
	EfiPciWidthMaximum
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH;
	
//*******************************************************
// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION
//*******************************************************
typedef enum {
	EfiPciOperationBusMasterRead,
	EfiPciOperationBusMasterWrite,
	EfiPciOperationBusMasterCommonBuffer,
	EfiPciOperationBusMasterRead64,
	EfiPciOperationBusMasterWrite64,
	EfiPciOperationBusMasterCommonBuffer64,
	EfiPciOperationMaximum
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION;


typedef struct {
	UINT8	Register;
	UINT8	Function;
	UINT8	Device;
	UINT8	Bus;
	UINT32	ExtendedRegister;
} EFI_PCI_CONFIGURATION_ADDRESS;

#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS EFI_PCI_CONFIGURATION_ADDRESS

typedef struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL;

//*******************************************************
// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM
//*******************************************************
typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL			*This,
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
	IN UINT64									Address,
	IN UINT64									Mask,
	IN UINT64									Value,
	IN UINT64									Delay,
	OUT UINT64									*Result
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL			*This,
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
	IN UINT64									Address,
	IN UINT64									Mask,
	IN UINT64									Value,
	IN UINT64									Delay,
	OUT UINT64									*Result
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL			*This,
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
	IN UINT64									Address,
	IN UINTN									Count,
	IN OUT VOID									*Buffer
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL			*This,
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
	IN UINT64									DestAddress,
	IN UINT64									SrcAddress,
	IN UINTN									Count
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL				*This,
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION	Operation,
	IN VOID											*HostAddress,
	IN OUT UINTN									*NumberOfBytes,
	OUT EFI_PHYSICAL_ADDRESS						*DeviceAddress,
	OUT VOID										**Mapping
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This,
	IN VOID								*Mapping
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This,
	IN EFI_ALLOCATE_TYPE				Type,
	IN EFI_MEMORY_TYPE					MemoryType,
	IN UINTN 							Pages,
	OUT VOID 							**HostAddress,
	IN UINT64							Attributes
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This,
	IN UINTN							Pages,
	IN VOID								*HostAddress
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This,
	OUT UINT64							*Supports OPTIONAL,
	OUT UINT64							*Attributes OPTIONAL
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL	*This,
	IN UINT64							Attributes,
	IN OUT UINT64 						*ResourceBase OPTIONAL,
	IN OUT UINT64 						*ResourceLength OPTIONAL
);

typedef EFI_STATUS (EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION) (
	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This,
	OUT VOID **Resources
);

//**********************************************************************
//<AMI_THDR_START>
//
// Name:        EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS
//
// Description: This provides north bridge functions to open, close, lock,
//              and describe SMM space.
//
// Fields:     Name        Type					Description
//        ------------------------------------------------------------
//		  Read	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM	- definition to read Mem/Io/Pci.
//		  Write	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  - definition to read Mem/Io/Pci.
//<AMI_THDR_END>
//**********************************************************************
typedef struct {
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM	Read;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM	Write;
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS;

//**********************************************************************
//<AMI_THDR_START>
//
// Name:        EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
//
// Description: Functions to access Pci Root Bridge for reading/writting
//              Memory/IO/config space.
//
// Fields:     Name        Type					Description
//        ------------------------------------------------------------
//	ParentHandle	EFI_HANDLE 
//	PollMem			EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM
//	PollIo			EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM		
//	Mem				EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			
//	Io				EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			
//	Pci				EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			
//	CopyMem			EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM		
//	Map				EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP				
//	Unmap			EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP			
//	AllocateBuffer	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER	
//	FreeBuffer		EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER		
//	Flush			EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH			
//	GetAttributes	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES	
//	SetAttributes	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES	
//	Configuration	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION	
//	SegmentNumber	UINT32											
//
//<AMI_THDR_END>
//**********************************************************************
struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL {
	EFI_HANDLE ParentHandle;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM		PollMem;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM		PollIo;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			Mem;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			Io;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS			Pci;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM		CopyMem;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP				Map;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP			Unmap;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER	AllocateBuffer;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER		FreeBuffer;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH			Flush;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES	GetAttributes;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES	SetAttributes;
	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION	Configuration;
	UINT32											SegmentNumber;
};

/****** DO NOT WRITE BELOW THIS LINE *******/
#ifdef __cplusplus
}
#endif
#endif

//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2005, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**             6145-F Northbelt Pkwy, Norcross, GA 30071            **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************