2 This file contains the entry code to the HII database, which is defined by
3 UEFI 2.1 specification.
5 Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "HiiDatabase.h"
22 EFI_EVENT gHiiKeyboardLayoutChanged
;
23 BOOLEAN gExportAfterReadyToBoot
= FALSE
;
25 HII_DATABASE_PRIVATE_DATA mPrivate
= {
26 HII_DATABASE_PRIVATE_DATA_SIGNATURE
,
61 HiiGetSecondaryLanguages
68 HiiExportPackageLists
,
69 HiiRegisterPackageNotify
,
70 HiiUnregisterPackageNotify
,
71 HiiFindKeyboardLayouts
,
74 HiiGetPackageListHandle
77 HiiConfigRoutingExtractConfig
,
78 HiiConfigRoutingExportConfig
,
79 HiiConfigRoutingRouteConfig
,
85 EfiConfigKeywordHandlerSetData
,
86 EfiConfigKeywordHandlerGetData
97 EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
),
102 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}
108 The default event handler for gHiiKeyboardLayoutChanged
111 This is internal function.
113 @param Event The event that triggered this notification function.
114 @param Context Pointer to the notification functions context.
119 KeyboardLayoutChangeNullEvent (
128 On Ready To Boot Services Event notification handler.
130 To trigger the function that to export the Hii Configuration setting.
132 @param[in] Event Event whose notification function is being invoked
133 @param[in] Context Pointer to the notification function's context
144 // When ready to boot, we begin to export the HiiDatabase date.
145 // And hook all the possible HiiDatabase change actions to export data.
147 HiiGetConfigurationSetting(&mPrivate
.HiiDatabase
);
148 gExportAfterReadyToBoot
= TRUE
;
150 gBS
->CloseEvent (Event
);
154 Initialize HII Database.
157 @param ImageHandle The image handle.
158 @param SystemTable The system table.
160 @retval EFI_SUCCESS The Hii database is setup correctly.
161 @return Other value if failed to create the default event for
162 gHiiKeyboardLayoutChanged. Check gBS->CreateEventEx for
163 details. Or failed to install the protocols.
164 Check gBS->InstallMultipleProtocolInterfaces for details.
165 Or failed to create Ready To Boot Event.
166 Check EfiCreateEventReadyToBootEx for details.
171 InitializeHiiDatabase (
172 IN EFI_HANDLE ImageHandle
,
173 IN EFI_SYSTEM_TABLE
*SystemTable
178 EFI_EVENT ReadyToBootEvent
;
181 // There will be only one HII Database in the system
182 // If there is another out there, someone is trying to install us
183 // again. Fail that scenario.
185 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiDatabaseProtocolGuid
);
186 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiFontProtocolGuid
);
187 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiImageProtocolGuid
);
188 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiStringProtocolGuid
);
189 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiConfigRoutingProtocolGuid
);
190 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiConfigKeywordHandlerProtocolGuid
);
192 InitializeListHead (&mPrivate
.DatabaseList
);
193 InitializeListHead (&mPrivate
.DatabaseNotifyList
);
194 InitializeListHead (&mPrivate
.HiiHandleList
);
195 InitializeListHead (&mPrivate
.FontInfoList
);
198 // Create a event with EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group type.
200 Status
= gBS
->CreateEventEx (
203 KeyboardLayoutChangeNullEvent
,
205 &gEfiHiiKeyBoardLayoutGuid
,
206 &gHiiKeyboardLayoutChanged
208 if (EFI_ERROR (Status
)) {
213 Status
= gBS
->InstallMultipleProtocolInterfaces (
215 &gEfiHiiFontProtocolGuid
,
217 &gEfiHiiStringProtocolGuid
,
219 &gEfiHiiDatabaseProtocolGuid
,
220 &mPrivate
.HiiDatabase
,
221 &gEfiHiiConfigRoutingProtocolGuid
,
222 &mPrivate
.ConfigRouting
,
223 &gEfiConfigKeywordHandlerProtocolGuid
,
224 &mPrivate
.ConfigKeywordHandler
,
228 if (EFI_ERROR (Status
)) {
232 if (FeaturePcdGet (PcdSupportHiiImageProtocol
)) {
233 Status
= gBS
->InstallMultipleProtocolInterfaces (
235 &gEfiHiiImageProtocolGuid
, &mPrivate
.HiiImage
,
236 &gEfiHiiImageExProtocolGuid
, &mPrivate
.HiiImageEx
,
242 if (FeaturePcdGet(PcdHiiOsRuntimeSupport
)) {
243 Status
= EfiCreateEventReadyToBootEx (
249 if (EFI_ERROR (Status
)) {