3 This file contains global defines and prototype definitions
4 for the Framework HII to Uefi HII Thunk Module.
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _HIIDATABASE_H
18 #define _HIIDATABASE_H
21 #include <FrameworkDxe.h>
23 #include <Guid/GlobalVariable.h>
24 #include <Protocol/FrameworkFormCallback.h>
25 #include <Protocol/FrameworkHii.h>
26 #include <Protocol/FrameworkFormBrowser.h>
31 #include <Protocol/HiiFont.h>
32 #include <Protocol/HiiImage.h>
33 #include <Protocol/HiiString.h>
34 #include <Protocol/HiiDatabase.h>
35 #include <Protocol/HiiConfigRouting.h>
36 #include <Protocol/HiiConfigAccess.h>
37 #include <Protocol/UgaDraw.h>
40 #include <Library/BaseLib.h>
41 #include <Library/DebugLib.h>
42 #include <Library/UefiDriverEntryPoint.h>
43 #include <Library/MemoryAllocationLib.h>
44 #include <Library/BaseMemoryLib.h>
45 #include <Library/UefiBootServicesTableLib.h>
46 #include <Library/UefiRuntimeServicesTableLib.h>
47 #include <Library/HiiLib.h>
48 #include <Library/UefiLib.h>
50 #include <Library/IfrSupportLib.h>
51 #include <Library/ExtendedIfrSupportLib.h>
52 #include <Library/PcdLib.h>
54 #include <Guid/MdeModuleHii.h>
56 #include "UefiIfrParser.h"
60 // VARSTORE ID of 0 for Buffer Storage Type Storage is defined as invalid in UEFI 2.1 HII. VARSTORE ID
61 // 0 is the default VarStore ID for storage without explicit declaration in Framework HII 0.92. EDK II UEFI VFR compiler
62 // in compatible mode will assign 0x0001 as UEFI VARSTORE ID to this default storage id in Framework VFR without
63 // VARSTORE declaration.
65 // In addition, the Name of Default VarStore is assumed to be L"Setup" for those storage without explicit VARSTORE declaration in the formset
66 // by Framework HII. EDK II UEFI VFR compiler in compatible mode hard-coded L"Setup" as VARSTORE name.
68 #define FRAMEWORK_RESERVED_VARSTORE_ID 0x0001
69 #define FRAMEWORK_RESERVED_VARSTORE_NAME L"Setup"
72 /// The size of a 3 character ISO639 language code.
74 #define ISO_639_2_ENTRY_SIZE 3
80 EFI_HII_PACK_HEADER FrameworkPackageHeader
;
81 EFI_HII_PACKAGE_HEADER PackageHeader
;
82 } TIANO_AUTOGEN_PACKAGES_HEADER
;
85 #define HII_THUNK_PRIVATE_DATA_FROM_THIS(Record) CR(Record, HII_THUNK_PRIVATE_DATA, Hii, HII_THUNK_PRIVATE_DATA_SIGNATURE)
86 #define HII_THUNK_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('H', 'i', 'I', 'T')
93 // The head of link list for all HII_THUNK_CONTEXT.
95 LIST_ENTRY ThunkContextListHead
;
97 EFI_HANDLE RemovePackNotifyHandle
;
98 EFI_HANDLE AddPackNotifyHandle
;
99 } HII_THUNK_PRIVATE_DATA
;
105 #define QUESTION_ID_MAP_ENTRY_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP_ENTRY, Link, QUESTION_ID_MAP_ENTRY_SIGNATURE)
106 #define QUESTION_ID_MAP_ENTRY_SIGNATURE SIGNATURE_32 ('Q', 'I', 'M', 'E')
111 EFI_QUESTION_ID UefiQid
;
112 } QUESTION_ID_MAP_ENTRY
;
116 #define QUESTION_ID_MAP_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP, Link, QUESTION_ID_MAP_SIGNATURE)
117 #define QUESTION_ID_MAP_SIGNATURE SIGNATURE_32 ('Q', 'I', 'M', 'P')
123 LIST_ENTRY MapEntryListHead
;
128 #define HII_THUNK_CONTEXT_FROM_LINK(Record) CR(Record, HII_THUNK_CONTEXT, Link, HII_THUNK_CONTEXT_SIGNATURE)
129 #define HII_THUNK_CONTEXT_SIGNATURE SIGNATURE_32 ('H', 'T', 'H', 'M')
133 FRAMEWORK_EFI_HII_HANDLE FwHiiHandle
;
134 EFI_HII_HANDLE UefiHiiHandle
;
135 EFI_HANDLE UefiHiiDriverHandle
;
137 UINTN IfrPackageCount
;
138 UINTN StringPackageCount
;
140 BOOLEAN ByFrameworkHiiNewPack
;
143 // HII Thunk will use TagGuid to associate the String Package and Form Package togehter.
144 // See description for TagGuid. This field is to record if either one of the following condition
146 // 1) if ((SharingStringPack == TRUE) && (StringPackageCount != 0 && IfrPackageCount == 0)), then this Package List only
147 /// has String Packages and provides Strings to other IFR package.
148 // 2) if ((SharingStringPack == TRUE) && (StringPackageCount == 0 && IfrPackageCount != 1)), then this Form Package
149 // copied String Packages from other Package List.
150 // 3) if ((SharingStringPack == FALSE)), this Package does not provide String Package or copy String Packages from other
154 // When a Hii->NewString() is called for this FwHiiHandle and SharingStringPack is TRUE, then all Package List that sharing
155 // the same TagGuid will update or create String in there respective String Packages. If SharingStringPack is FALSE, then
156 // only the String from String Packages in this Package List will be updated or created.
158 BOOLEAN SharingStringPack
;
161 // The HII 0.92 version of HII data implementation in EDK 1.03 and 1.04 make an the following assumption
162 // in both HII Database implementation and all modules that registering packages:
163 // If a Package List has only IFR package and no String Package, the IFR package will reference
164 // String in another Package List registered with the HII database with the same EFI_HII_PACKAGES.GuidId.
165 // TagGuid is the used to record this GuidId.
168 UINT8
*NvMapOverride
;
170 FORM_BROWSER_FORMSET
*FormSet
;
176 #define BUFFER_STORAGE_ENTRY_SIGNATURE SIGNATURE_32 ('H', 'T', 's', 'k')
177 #define BUFFER_STORAGE_ENTRY_FROM_LINK(Record) CR(Record, BUFFER_STORAGE_ENTRY, Link, BUFFER_STORAGE_ENTRY_SIGNATURE)
185 } BUFFER_STORAGE_ENTRY
;
189 /// HII specific Vendor Device Path Node definition.
192 VENDOR_DEVICE_PATH VendorDevicePath
;
195 } HII_VENDOR_DEVICE_PATH_NODE
;
198 /// HII specific Vendor Device Path definition.
201 HII_VENDOR_DEVICE_PATH_NODE Node
;
202 EFI_DEVICE_PATH_PROTOCOL End
;
203 } HII_VENDOR_DEVICE_PATH
;
206 #define CONFIG_ACCESS_PRIVATE_SIGNATURE SIGNATURE_32 ('H', 'T', 'c', 'a')
207 #define CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL(Record) CR(Record, CONFIG_ACCESS_PRIVATE, ConfigAccessProtocol, CONFIG_ACCESS_PRIVATE_SIGNATURE)
210 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccessProtocol
;
212 // Framework's callback
214 EFI_FORM_CALLBACK_PROTOCOL
*FormCallbackProtocol
;
216 HII_THUNK_CONTEXT
*ThunkContext
;
217 } CONFIG_ACCESS_PRIVATE
;
221 #define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('F', 'B', 'T', 'd')
222 #define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_FROM_THIS(Record) CR(Record, EFI_FORMBROWSER_THUNK_PRIVATE_DATA, FormBrowser, EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE)
226 HII_THUNK_PRIVATE_DATA
*ThunkPrivate
;
227 EFI_FORM_BROWSER_PROTOCOL FormBrowser
;
228 } EFI_FORMBROWSER_THUNK_PRIVATE_DATA
;
234 extern CONST EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
235 extern CONST EFI_HII_IMAGE_PROTOCOL
*mHiiImageProtocol
;
236 extern CONST EFI_HII_STRING_PROTOCOL
*mHiiStringProtocol
;
237 extern CONST EFI_HII_FONT_PROTOCOL
*mHiiFontProtocol
;
238 extern CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRoutingProtocol
;
239 extern CONST EFI_FORM_BROWSER2_PROTOCOL
*mFormBrowser2Protocol
;
241 extern HII_THUNK_PRIVATE_DATA
*mHiiThunkPrivateData
;
243 extern BOOLEAN mInFrameworkUpdatePakcage
;
249 IN EFI_HII_PROTOCOL
*This
,
250 IN EFI_HII_PACKAGES
*PackageList
,
251 OUT FRAMEWORK_EFI_HII_HANDLE
*Handle
257 IN EFI_HII_PROTOCOL
*This
,
258 IN FRAMEWORK_EFI_HII_HANDLE Handle
264 IN EFI_HII_PROTOCOL
*This
,
265 IN OUT UINT16
*HandleBufferLength
,
266 OUT FRAMEWORK_EFI_HII_HANDLE
*Handle
272 IN EFI_HII_PROTOCOL
*This
,
273 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
274 IN OUT UINTN
*BufferSize
,
281 IN EFI_HII_PROTOCOL
*This
,
283 IN OUT UINT16
*Index
,
284 OUT UINT8
**GlyphBuffer
,
285 OUT UINT16
*BitWidth
,
286 IN OUT UINT32
*InternalStatus
292 IN EFI_HII_PROTOCOL
*This
,
293 IN UINT8
*GlyphBuffer
,
294 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
295 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
299 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
305 IN EFI_HII_PROTOCOL
*This
,
307 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
308 IN OUT STRING_REF
*Reference
,
315 IN EFI_HII_PROTOCOL
*This
,
316 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
319 IN CHAR16
*LanguageString
,
320 IN OUT UINTN
*BufferLength
,
321 OUT EFI_STRING StringBuffer
327 IN EFI_HII_PROTOCOL
*This
,
328 IN FRAMEWORK_EFI_HII_HANDLE Handle
334 IN EFI_HII_PROTOCOL
*This
,
335 IN CHAR16
*StringToTest
,
336 IN OUT UINT32
*FirstMissing
,
337 OUT UINT32
*GlyphBufferSize
342 HiiGetPrimaryLanguages (
343 IN EFI_HII_PROTOCOL
*This
,
344 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
345 OUT EFI_STRING
*LanguageString
350 HiiGetSecondaryLanguages (
351 IN EFI_HII_PROTOCOL
*This
,
352 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
353 IN CHAR16
*PrimaryLanguage
,
354 OUT EFI_STRING
*LanguageString
360 IN EFI_HII_PROTOCOL
*This
,
361 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
363 IN OUT UINT16
*Index
,
365 IN CHAR16
*LanguageString
,
366 IN OUT UINT16
*BufferLength
,
367 OUT EFI_STRING StringBuffer
373 IN EFI_HII_PROTOCOL
*This
,
374 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
375 IN EFI_FORM_ID FormId
,
376 IN OUT UINTN
*BufferLength
,
383 IN EFI_HII_PROTOCOL
*This
,
384 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
385 IN UINTN DefaultMask
,
386 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
392 IN EFI_HII_PROTOCOL
*This
,
393 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
394 IN EFI_FORM_LABEL Label
,
396 IN FRAMEWORK_EFI_HII_UPDATE_DATA
*Data
401 HiiGetKeyboardLayout (
402 IN EFI_HII_PROTOCOL
*This
,
403 OUT UINT16
*DescriptorCount
,
404 OUT FRAMEWORK_EFI_KEY_DESCRIPTOR
*Descriptor
410 IN EFI_FORM_BROWSER_PROTOCOL
*This
,
411 IN BOOLEAN UseDatabase
,
412 IN FRAMEWORK_EFI_HII_HANDLE
*Handle
,
413 IN UINTN HandleCount
,
414 IN FRAMEWORK_EFI_IFR_PACKET
*Packet
, OPTIONAL
415 IN EFI_HANDLE CallbackHandle
, OPTIONAL
416 IN UINT8
*NvMapOverride
, OPTIONAL
417 IN FRAMEWORK_EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
418 OUT BOOLEAN
*ResetRequired OPTIONAL
424 IN UINTN NumberOfLines
,
426 IN UINTN MaximumStringSize
,
427 OUT CHAR16
*StringBuffer
,
428 OUT EFI_INPUT_KEY
*KeyValue
,
436 IN UINT8 PackageType
,
437 IN CONST EFI_GUID
*PackageGuid
,
438 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
439 IN EFI_HII_HANDLE Handle
,
440 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
446 IN UINT8 PackageType
,
447 IN CONST EFI_GUID
*PackageGuid
,
448 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
449 IN EFI_HII_HANDLE Handle
,
450 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
454 Create a EFI_HII_UPDATE_DATA structure used to call IfrLibUpdateForm.
456 @param ThunkContext The HII Thunk Context.
457 @param FwUpdateData The Framework Update Data.
458 @param UefiUpdateData The UEFI Update Data.
460 @retval EFI_SUCCESS The UEFI Update Data is created successfully.
461 @retval EFI_UNSUPPORTED There is unsupported opcode in FwUpdateData.
462 @retval EFI_OUT_OF_RESOURCES There is not enough resource.
465 FwUpdateDataToUefiUpdateData (
466 IN HII_THUNK_CONTEXT
*ThunkContext
,
467 IN CONST FRAMEWORK_EFI_HII_UPDATE_DATA
*FwUpdateData
,
468 OUT EFI_HII_UPDATE_DATA
**UefiUpdateData
474 Initialize string packages in HII database.
478 InitSetBrowserStrings (
484 #include "ConfigAccess.h"