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
},
48 // UEFI 2.0 added support for Capsule services. DXE CIS ??? Added support for this AP
50 { &gEfiCapsuleArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
52 { &gEfiMonotonicCounterArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
53 { &gEfiResetArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
54 { &gEfiRealTimeClockArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
55 { NULL
, (VOID
**)NULL
, NULL
, NULL
, FALSE
}
60 CoreAllEfiServicesAvailable (
66 Return TRUE if all AP services are availible.
72 EFI_SUCCESS - All AP services are available
73 EFI_NOT_FOUND - At least one AP service is not available
77 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
79 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
80 if (!Entry
->Present
) {
91 GenericArchProtocolNotify (
98 Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().
99 This notify function is registered for every architectural protocol. This handler
100 updates mArchProtocol[] array entry with protocol instance data and sets it's
101 present flag to TRUE. If any constructor is required it is executed. The EFI
102 System Table headers are updated.
106 Event - The Event that is being processed, not used.
108 Context - Event Context, not used.
117 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
121 LIST_ENTRY TempLinkNode
;
124 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
126 Status
= CoreLocateProtocol (Entry
->ProtocolGuid
, Entry
->Registration
, &Protocol
);
127 if (EFI_ERROR (Status
)) {
132 Entry
->Present
= TRUE
;
135 // Update protocol global variable if one exists. Entry->Protocol points to a global variable
136 // if one exists in the DXE core for this Architectural Protocol
138 if (Entry
->Protocol
!= NULL
) {
139 *(Entry
->Protocol
) = Protocol
;
142 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiTimerArchProtocolGuid
)) {
144 // Register the Core timer tick handler with the Timer AP
146 gTimer
->RegisterHandler (gTimer
, CoreTimerTick
);
149 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiRuntimeArchProtocolGuid
)) {
151 // When runtime architectural protocol is available, updates CRC32 in the Debug Table
153 CoreUpdateDebugTableCrc32 ();
156 // Update the Runtime Architectural protocol with the template that the core was
157 // using so there would not need to be a dependency on the Runtime AP
161 // Copy all the registered Image to new gRuntime protocol
163 for (Link
= gRuntimeTemplate
.ImageHead
.ForwardLink
; Link
!= &gRuntimeTemplate
.ImageHead
; Link
= TempLinkNode
.ForwardLink
) {
164 CopyMem (&TempLinkNode
, Link
, sizeof(LIST_ENTRY
));
165 InsertTailList (&gRuntime
->ImageHead
, Link
);
168 // Copy all the registered Event to new gRuntime protocol
170 for (Link
= gRuntimeTemplate
.EventHead
.ForwardLink
; Link
!= &gRuntimeTemplate
.EventHead
; Link
= TempLinkNode
.ForwardLink
) {
171 CopyMem (&TempLinkNode
, Link
, sizeof(LIST_ENTRY
));
172 InsertTailList (&gRuntime
->EventHead
, Link
);
176 // Clean up gRuntimeTemplate
178 gRuntimeTemplate
.ImageHead
.ForwardLink
= &gRuntimeTemplate
.ImageHead
;
179 gRuntimeTemplate
.ImageHead
.BackLink
= &gRuntimeTemplate
.ImageHead
;
180 gRuntimeTemplate
.EventHead
.ForwardLink
= &gRuntimeTemplate
.EventHead
;
181 gRuntimeTemplate
.EventHead
.BackLink
= &gRuntimeTemplate
.EventHead
;
186 // It's over kill to do them all every time, but it saves a lot of code.
189 CalculateEfiHdrCrc (&gRT
->Hdr
);
190 CalculateEfiHdrCrc (&gBS
->Hdr
);
191 CalculateEfiHdrCrc (&gST
->Hdr
);
192 CalculateEfiHdrCrc (&gDS
->Hdr
);
199 CoreNotifyOnArchProtocolInstallation (
205 Creates an event that is fired everytime a Protocol of a specific type is installed
216 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
218 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
223 Status
= CoreCreateEvent (
224 EFI_EVENT_NOTIFY_SIGNAL
,
226 GenericArchProtocolNotify
,
230 ASSERT_EFI_ERROR(Status
);
233 // Register for protocol notifactions on this event
235 Status
= CoreRegisterProtocolNotify (
240 ASSERT_EFI_ERROR(Status
);
246 // Following is needed to display missing architectural protocols in debug builds
249 EFI_GUID
*ProtocolGuid
;
251 } GUID_TO_STRING_PROTOCOL_ENTRY
;
253 static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols
[] = {
254 { &gEfiSecurityArchProtocolGuid
, (CHAR16
*)L
"Security" },
255 { &gEfiCpuArchProtocolGuid
, (CHAR16
*)L
"CPU" },
256 { &gEfiMetronomeArchProtocolGuid
, (CHAR16
*)L
"Metronome" },
257 { &gEfiTimerArchProtocolGuid
, (CHAR16
*)L
"Timer" },
258 { &gEfiBdsArchProtocolGuid
, (CHAR16
*)L
"Bds" },
259 { &gEfiWatchdogTimerArchProtocolGuid
, (CHAR16
*)L
"Watchdog Timer" },
260 { &gEfiRuntimeArchProtocolGuid
, (CHAR16
*)L
"Runtime" },
261 { &gEfiVariableArchProtocolGuid
, (CHAR16
*)L
"Variable" },
262 { &gEfiVariableWriteArchProtocolGuid
, (CHAR16
*)L
"Variable Write" },
263 { &gEfiCapsuleArchProtocolGuid
, (CHAR16
*)L
"Capsule" },
264 { &gEfiMonotonicCounterArchProtocolGuid
, (CHAR16
*)L
"Monotonic Counter" },
265 { &gEfiResetArchProtocolGuid
, (CHAR16
*)L
"Reset" },
266 // { &gEfiStatusCodeRuntimeProtocolGuid, (CHAR16 *)L"Status Code" },
267 { &gEfiRealTimeClockArchProtocolGuid
, (CHAR16
*)L
"Real Time Clock" }
271 CoreDisplayMissingArchProtocols (
277 Displays Architectural protocols that were not loaded and are required for DXE core to function
278 Only used in Debug Builds
288 const GUID_TO_STRING_PROTOCOL_ENTRY
*MissingEntry
;
289 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
291 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
292 if (!Entry
->Present
) {
293 MissingEntry
= MissingProtocols
;
294 for (MissingEntry
= MissingProtocols
; TRUE
; MissingEntry
++) {
295 if (CompareGuid (Entry
->ProtocolGuid
, MissingEntry
->ProtocolGuid
)) {
296 DEBUG ((EFI_D_ERROR
, "\n%s Arch Protocol not present!!\n", MissingEntry
->GuidString
));