3 Copyright (c) 2006, 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 contains global defines and prototype definitions
23 #ifndef _HIIDATABASE_H
24 #define _HIIDATABASE_H
27 // HII Database Global data
29 #define EFI_HII_DATA_SIGNATURE EFI_SIGNATURE_32 ('H', 'i', 'i', 'P')
31 #define MAX_GLYPH_COUNT 65535
32 #define NARROW_GLYPH_ARRAY_SIZE 19
33 #define WIDE_GLYPH_ARRAY_SIZE 38
35 #define SETUP_MAP_NAME L"Setup"
36 #define HII_VARIABLE_SUFFIX_USER_DATA L"UserSavedData"
37 #define HII_VARIABLE_SUFFIX_DEFAULT_OVERRIDE L"DefaultOverride"
38 #define HII_VARIABLE_SUFFIX_MANUFACTURING_OVERRIDE L"ManufacturingOverride"
40 typedef struct _EFI_HII_HANDLE_DATABASE
{
41 VOID
*Buffer
; // Actual buffer pointer
42 EFI_HII_HANDLE Handle
; // Monotonically increasing value to signify the value returned to caller
43 UINT32 NumberOfTokens
; // The initial number of tokens when first registered
44 struct _EFI_HII_HANDLE_DATABASE
*NextHandleDatabase
;
45 } EFI_HII_HANDLE_DATABASE
;
48 EFI_NARROW_GLYPH NarrowGlyphs
[MAX_GLYPH_COUNT
];
49 EFI_WIDE_GLYPH WideGlyphs
[MAX_GLYPH_COUNT
];
50 EFI_KEY_DESCRIPTOR SystemKeyboardLayout
[106];
51 EFI_KEY_DESCRIPTOR OverrideKeyboardLayout
[106];
52 BOOLEAN SystemKeyboardUpdate
; // Has the SystemKeyboard been updated?
53 } EFI_HII_GLOBAL_DATA
;
58 EFI_HII_GLOBAL_DATA
*GlobalData
;
59 EFI_HII_HANDLE_DATABASE
*DatabaseHead
; // Head of the Null-terminated singly-linked list of handles.
64 EFI_HII_HANDLE Handle
;
66 EFI_HII_HANDLE_PACK HandlePack
;
69 EFI_HII_IFR_PACK
*IfrData
; // All the IFR data stored here
70 EFI_HII_STRING_PACK
*StringData
; // All the String data stored at &IfrData + IfrSize (StringData is just a label - never referenced)
71 } EFI_HII_PACKAGE_INSTANCE
;
74 EFI_HII_PACK_HEADER Header
;
75 EFI_IFR_FORM_SET FormSet
;
76 EFI_IFR_END_FORM_SET EndFormSet
;
79 #define EFI_HII_DATA_FROM_THIS(a) CR (a, EFI_HII_DATA, Hii, EFI_HII_DATA_SIGNATURE)
81 #define NARROW_WIDTH 8
84 extern UINT8 mUnknownGlyph
[38];
93 OUT UINT32
*NumberOfTokens
99 IN EFI_HII_PROTOCOL
*This
,
100 IN EFI_HII_PACKAGE_INSTANCE
*PackageInstance
,
101 OUT EFI_HII_PACKAGE_INSTANCE
**StringPackageInstance
,
102 OUT UINT32
*TotalStringCount
107 // Public Interface Prototypes
111 InitializeHiiDatabase (
112 IN EFI_HANDLE ImageHandle
,
113 IN EFI_SYSTEM_TABLE
*SystemTable
120 IN EFI_HII_PROTOCOL
*This
,
121 IN EFI_HII_PACKAGES
*PackageList
,
122 OUT EFI_HII_HANDLE
*Handle
129 IN EFI_HII_PROTOCOL
*This
,
130 IN EFI_HII_HANDLE Handle
137 IN EFI_HII_PROTOCOL
*This
,
138 IN OUT UINT16
*HandleBufferLength
,
139 OUT EFI_HII_HANDLE
*Handle
146 IN EFI_HII_PROTOCOL
*This
,
147 IN EFI_HII_HANDLE Handle
,
148 IN OUT UINTN
*BufferSize
,
156 IN EFI_HII_PROTOCOL
*This
,
158 IN OUT UINT16
*Index
,
159 OUT UINT8
**GlyphBuffer
,
160 OUT UINT16
*BitWidth
,
161 IN OUT UINT32
*InternalStatus
168 IN EFI_HII_PROTOCOL
*This
,
169 IN UINT8
*GlyphBuffer
,
170 IN EFI_UGA_PIXEL Foreground
,
171 IN EFI_UGA_PIXEL Background
,
175 IN OUT EFI_UGA_PIXEL
*BltBuffer
182 IN EFI_HII_PROTOCOL
*This
,
184 IN EFI_HII_HANDLE Handle
,
185 IN OUT STRING_REF
*Reference
,
193 IN EFI_HII_PROTOCOL
*This
,
194 IN EFI_HII_HANDLE Handle
,
197 IN CHAR16
*LanguageString
,
198 IN OUT UINTN
*BufferLength
,
199 OUT EFI_STRING StringBuffer
206 IN EFI_HII_PROTOCOL
*This
,
207 IN EFI_HII_HANDLE Handle
214 IN EFI_HII_PROTOCOL
*This
,
215 IN CHAR16
*StringToTest
,
216 IN OUT UINT32
*FirstMissing
,
217 OUT UINT32
*GlyphBufferSize
223 HiiGetPrimaryLanguages (
224 IN EFI_HII_PROTOCOL
*This
,
225 IN EFI_HII_HANDLE Handle
,
226 OUT EFI_STRING
*LanguageString
232 HiiGetSecondaryLanguages (
233 IN EFI_HII_PROTOCOL
*This
,
234 IN EFI_HII_HANDLE Handle
,
235 IN CHAR16
*PrimaryLanguage
,
236 OUT EFI_STRING
*LanguageString
243 IN EFI_HII_PROTOCOL
*This
,
244 IN EFI_HII_HANDLE Handle
,
246 IN OUT UINT16
*Index
,
248 IN CHAR16
*LanguageString
,
249 IN OUT UINT16
*BufferLength
,
250 OUT EFI_STRING StringBuffer
257 IN EFI_HII_PROTOCOL
*This
,
258 IN EFI_HII_HANDLE Handle
,
259 IN EFI_FORM_ID FormId
,
260 IN OUT UINTN
*BufferLength
,
268 IN EFI_HII_PROTOCOL
*This
,
269 IN EFI_HII_HANDLE Handle
,
270 IN UINTN DefaultMask
,
271 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
278 IN EFI_HII_PROTOCOL
*This
,
279 IN EFI_HII_HANDLE Handle
,
280 IN EFI_FORM_LABEL Label
,
282 IN EFI_HII_UPDATE_DATA
*Data
288 HiiGetKeyboardLayout (
289 IN EFI_HII_PROTOCOL
*This
,
290 OUT UINT16
*DescriptorCount
,
291 OUT EFI_KEY_DESCRIPTOR
*Descriptor
297 IN CHAR16
*LanguageStringLocation
,