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
|
/** @file
The Header file of the Pci Host Bridge Driver
@copyright
Copyright (c) 1999 - 2012 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 an 'Intel Peripheral Driver' and uniquely
identified as "Intel Reference Module" and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef _PCI_HOST_BRIDGE_H_
#define _PCI_HOST_BRIDGE_H_
#include "EdkIIGlueDxe.h"
#include "CpuRegs.h"
#include "CpuPlatformLib.h"
#include EFI_PROTOCOL_DEFINITION (PciHostBridgeResourceAllocation)
///
/// Hard code the host bridge number in the platform.
/// In this chipset, there is only one host bridge.
///
#define HOST_BRIDGE_NUMBER 1
#define PCI_HOST_BRIDGE_SIGNATURE EFI_SIGNATURE_32 ('e', 'h', 's', 't')
typedef struct {
UINTN Signature;
EFI_HANDLE HostBridgeHandle;
UINTN RootBridgeNumber;
LIST_ENTRY Head;
BOOLEAN ResourceSubmited;
BOOLEAN CanRestarted;
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL ResAlloc;
} PCI_HOST_BRIDGE_INSTANCE;
#define INSTANCE_FROM_RESOURCE_ALLOCATION_THIS(a) CR (a, PCI_HOST_BRIDGE_INSTANCE, ResAlloc, PCI_HOST_BRIDGE_SIGNATURE)
///
/// HostBridge Resource Allocation interface
///
/**
Enter a certain phase of the PCI enumeration process
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
@param[in] Phase - The phase during enumeration
@retval EFI_SUCCESS - Succeed.
@retval EFI_INVALID_PARAMETER - Wrong phase parameter passed in.
@retval EFI_NOT_READY - Resources have not been submitted yet.
**/
EFI_STATUS
EFIAPI
NotifyPhase (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase
)
;
/**
Return the device handle of the next PCI root bridge that is associated with
this Host Bridge
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
@param[in] RootBridgeHandle - Returns the device handle of the next PCI Root Bridge.
On input, it holds the RootBridgeHandle returned by the most
recent call to GetNextRootBridge().The handle for the first
PCI Root Bridge is returned if RootBridgeHandle is NULL on input
@retval EFI_SUCCESS - Succeed.
@retval EFI_NOT_FOUND - Next PCI root bridge not found.
@retval EFI_INVALID_PARAMETER - Wrong parameter passed in.
**/
EFI_STATUS
EFIAPI
GetNextRootBridge (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN OUT EFI_HANDLE *RootBridgeHandle
)
;
/**
Returns the attributes of a PCI Root Bridge.
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.
@param[in] RootBridgeHandle - The device handle of the PCI Root Bridge
that the caller is interested in
@param[in] Attributes - The pointer to attributes of the PCI Root Bridge
@retval EFI_SUCCESS - Succeed.
@retval EFI_INVALID_PARAMETER - Attributes parameter passed in is NULL or
RootBridgeHandle is not an EFI_HANDLE
that was returned on a previous call to
GetNextRootBridge().
**/
EFI_STATUS
EFIAPI
GetAttributes (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
OUT UINT64 *Attributes
)
;
/**
This is the request from the PCI enumerator to set up
the specified PCI Root Bridge for bus enumeration process.
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.
@param[in] RootBridgeHandle - The PCI Root Bridge to be set up.
@param[in] Configuration - Pointer to the pointer to the PCI bus resource descriptor.
@retval EFI_SUCCESS - Succeed.
@retval EFI_OUT_OF_RESOURCES - Not enough pool to be allocated.
@retval EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.
**/
EFI_STATUS
EFIAPI
StartBusEnumeration (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
OUT VOID **Configuration
)
;
/**
This function programs the PCI Root Bridge hardware so that
it decodes the specified PCI bus range
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
@param[in] RootBridgeHandle - The PCI Root Bridge whose bus range is to be programmed
@param[in] Configuration - The pointer to the PCI bus resource descriptor
@retval EFI_SUCCESS - Succeed.
@retval EFI_INVALID_PARAMETER - Wrong parameters passed in.
**/
EFI_STATUS
EFIAPI
SetBusNumbers (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
IN VOID *Configuration
)
;
/**
Submits the I/O and memory resource requirements for the specified PCI Root Bridge
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
@param[in] RootBridgeHandle - The PCI Root Bridge whose I/O and memory resource requirements
are being submitted
@param[in] Configuration - The pointer to the PCI I/O and PCI memory resource descriptor
@retval EFI_SUCCESS - Succeed.
@retval EFI_INVALID_PARAMETER - Wrong parameters passed in.
**/
EFI_STATUS
EFIAPI
SubmitResources (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
IN VOID *Configuration
)
;
/**
This function returns the proposed resource settings for the specified
PCI Root Bridge
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
@param[in] RootBridgeHandle - The PCI Root Bridge handle
@param[in] Configuration - The pointer to the pointer to the PCI I/O
and memory resource descriptor
@retval EFI_SUCCESS - Succeed.
@retval EFI_OUT_OF_RESOURCES - Not enough pool to be allocated.
@retval EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.
**/
EFI_STATUS
EFIAPI
GetProposedResources (
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
OUT VOID **Configuration
)
;
/**
This function is called for all the PCI controllers that the PCI
bus driver finds. Can be used to Preprogram the controller.
@param[in] This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
@param[in] RootBridgeHandle - The PCI Root Bridge handle
@param[in] PciAddress - Address of the controller on the PCI bus
@param[in] Phase - The Phase during resource allocation
@retval EFI_SUCCESS - Succeed.
@retval EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.
**/
EFI_STATUS
EFIAPI
PreprocessController (
IN struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_HANDLE RootBridgeHandle,
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,
IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase
)
;
/**
Calculate max memory of power 2
@param[in] MemoryLength - Input memory length.
@retval Returned Maximum length.
**/
UINT64
Power2MaxMemory (
IN UINT64 MemoryLength
)
;
#endif
|
