3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 This file deals with Architecture Protocol (AP) registration in
19 the Dxe Core. The mArchProtocols[] array represents a list of
20 events that represent the Architectural Protocols.
28 // DXE Core Global Variables for all of the Architectural Protocols.
29 // If a protocol is installed mArchProtocols[].Present will be TRUE.
31 // CoreNotifyOnArchProtocolInstallation () fills in mArchProtocols[].Event
32 // and mArchProtocols[].Registration as it creates events for every array
36 ARCHITECTURAL_PROTOCOL_ENTRY mArchProtocols
[] = {
37 { &gEfiSecurityArchProtocolGuid
, (VOID
**)&gSecurity
, NULL
, NULL
, FALSE
},
38 { &gEfiCpuArchProtocolGuid
, (VOID
**)&gCpu
, NULL
, NULL
, FALSE
},
39 { &gEfiMetronomeArchProtocolGuid
, (VOID
**)&gMetronome
, NULL
, NULL
, FALSE
},
40 { &gEfiTimerArchProtocolGuid
, (VOID
**)&gTimer
, NULL
, NULL
, FALSE
},
41 { &gEfiBdsArchProtocolGuid
, (VOID
**)&gBds
, NULL
, NULL
, FALSE
},
42 { &gEfiWatchdogTimerArchProtocolGuid
, (VOID
**)&gWatchdogTimer
, NULL
, NULL
, FALSE
},
43 { &gEfiRuntimeArchProtocolGuid
, (VOID
**)&gRuntime
, NULL
, NULL
, FALSE
},
44 { &gEfiVariableArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
45 { &gEfiVariableWriteArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
46 { &gEfiCapsuleArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
47 { &gEfiMonotonicCounterArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
48 { &gEfiResetArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
49 { &gEfiRealTimeClockArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
50 { NULL
, (VOID
**)NULL
, NULL
, NULL
, FALSE
}
55 CoreAllEfiServicesAvailable (
61 Return TRUE if all AP services are availible.
67 EFI_SUCCESS - All AP services are available
68 EFI_NOT_FOUND - At least one AP service is not available
72 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
74 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
75 if (!Entry
->Present
) {
86 GenericArchProtocolNotify (
93 Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().
94 This notify function is registered for every architectural protocol. This handler
95 updates mArchProtocol[] array entry with protocol instance data and sets it's
96 present flag to TRUE. If any constructor is required it is executed. The EFI
97 System Table headers are updated.
101 Event - The Event that is being processed, not used.
103 Context - Event Context, not used.
112 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
116 LIST_ENTRY TempLinkNode
;
119 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
121 Status
= CoreLocateProtocol (Entry
->ProtocolGuid
, Entry
->Registration
, &Protocol
);
122 if (EFI_ERROR (Status
)) {
127 Entry
->Present
= TRUE
;
130 // Update protocol global variable if one exists. Entry->Protocol points to a global variable
131 // if one exists in the DXE core for this Architectural Protocol
133 if (Entry
->Protocol
!= NULL
) {
134 *(Entry
->Protocol
) = Protocol
;
137 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiTimerArchProtocolGuid
)) {
139 // Register the Core timer tick handler with the Timer AP
141 gTimer
->RegisterHandler (gTimer
, CoreTimerTick
);
144 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiRuntimeArchProtocolGuid
)) {
146 // When runtime architectural protocol is available, updates CRC32 in the Debug Table
148 CoreUpdateDebugTableCrc32 ();
151 // Update the Runtime Architectural protocol with the template that the core was
152 // using so there would not need to be a dependency on the Runtime AP
156 // Copy all the registered Image to new gRuntime protocol
158 for (Link
= gRuntimeTemplate
.ImageHead
.ForwardLink
; Link
!= &gRuntimeTemplate
.ImageHead
; Link
= TempLinkNode
.ForwardLink
) {
159 CopyMem (&TempLinkNode
, Link
, sizeof(LIST_ENTRY
));
160 InsertTailList (&gRuntime
->ImageHead
, Link
);
163 // Copy all the registered Event to new gRuntime protocol
165 for (Link
= gRuntimeTemplate
.EventHead
.ForwardLink
; Link
!= &gRuntimeTemplate
.EventHead
; Link
= TempLinkNode
.ForwardLink
) {
166 CopyMem (&TempLinkNode
, Link
, sizeof(LIST_ENTRY
));
167 InsertTailList (&gRuntime
->EventHead
, Link
);
171 // Clean up gRuntimeTemplate
173 gRuntimeTemplate
.ImageHead
.ForwardLink
= &gRuntimeTemplate
.ImageHead
;
174 gRuntimeTemplate
.ImageHead
.BackLink
= &gRuntimeTemplate
.ImageHead
;
175 gRuntimeTemplate
.EventHead
.ForwardLink
= &gRuntimeTemplate
.EventHead
;
176 gRuntimeTemplate
.EventHead
.BackLink
= &gRuntimeTemplate
.EventHead
;
181 // It's over kill to do them all every time, but it saves a lot of code.
184 CalculateEfiHdrCrc (&gDxeCoreRT
->Hdr
);
185 CalculateEfiHdrCrc (&gDxeCoreBS
->Hdr
);
186 CalculateEfiHdrCrc (&gDxeCoreST
->Hdr
);
187 CalculateEfiHdrCrc (&gDxeCoreDS
->Hdr
);
194 CoreNotifyOnArchProtocolInstallation (
200 Creates an event that is fired everytime a Protocol of a specific type is installed
211 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
213 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
218 Status
= CoreCreateEvent (
221 GenericArchProtocolNotify
,
225 ASSERT_EFI_ERROR(Status
);
228 // Register for protocol notifactions on this event
230 Status
= CoreRegisterProtocolNotify (
235 ASSERT_EFI_ERROR(Status
);
241 // Following is needed to display missing architectural protocols in debug builds
244 EFI_GUID
*ProtocolGuid
;
246 } GUID_TO_STRING_PROTOCOL_ENTRY
;
248 static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols
[] = {
249 { &gEfiSecurityArchProtocolGuid
, (CHAR16
*)L
"Security" },
250 { &gEfiCpuArchProtocolGuid
, (CHAR16
*)L
"CPU" },
251 { &gEfiMetronomeArchProtocolGuid
, (CHAR16
*)L
"Metronome" },
252 { &gEfiTimerArchProtocolGuid
, (CHAR16
*)L
"Timer" },
253 { &gEfiBdsArchProtocolGuid
, (CHAR16
*)L
"Bds" },
254 { &gEfiWatchdogTimerArchProtocolGuid
, (CHAR16
*)L
"Watchdog Timer" },
255 { &gEfiRuntimeArchProtocolGuid
, (CHAR16
*)L
"Runtime" },
256 { &gEfiVariableArchProtocolGuid
, (CHAR16
*)L
"Variable" },
257 { &gEfiVariableWriteArchProtocolGuid
, (CHAR16
*)L
"Variable Write" },
258 { &gEfiCapsuleArchProtocolGuid
, (CHAR16
*)L
"Capsule" },
259 { &gEfiMonotonicCounterArchProtocolGuid
, (CHAR16
*)L
"Monotonic Counter" },
260 { &gEfiResetArchProtocolGuid
, (CHAR16
*)L
"Reset" },
261 // { &gEfiStatusCodeRuntimeProtocolGuid, (CHAR16 *)L"Status Code" },
262 { &gEfiRealTimeClockArchProtocolGuid
, (CHAR16
*)L
"Real Time Clock" }
266 CoreDisplayMissingArchProtocols (
272 Displays Architectural protocols that were not loaded and are required for DXE core to function
273 Only used in Debug Builds
283 const GUID_TO_STRING_PROTOCOL_ENTRY
*MissingEntry
;
284 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
286 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
287 if (!Entry
->Present
) {
288 MissingEntry
= MissingProtocols
;
289 for (MissingEntry
= MissingProtocols
; TRUE
; MissingEntry
++) {
290 if (CompareGuid (Entry
->ProtocolGuid
, MissingEntry
->ProtocolGuid
)) {
291 DEBUG ((EFI_D_ERROR
, "\n%s Arch Protocol not present!!\n", MissingEntry
->GuidString
));