]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
5259c97d | 2 | This file defines the Human Interface Infrastructure protocol, which is\r |
3 | used by resources that want to publish IFR/Font/String data and have it\r | |
06a098c4 | 4 | collected by the Configuration engine. This protocol is defined in the.\r |
5 | Intel Platform Innovation Framework for EFI Human Interface Infrastructure\r | |
6 | Specification Version 0.92.\r | |
79964ac8 | 7 | \r |
06a098c4 | 8 | Copyright (c) 2007 - 2009, Intel Corporation\r |
79964ac8 | 9 | All rights reserved. This program and the accompanying materials\r |
10 | are licensed and made available under the terms and conditions of the BSD License\r | |
11 | which accompanies this distribution. The full text of the license may be found at\r | |
12 | http://opensource.org/licenses/bsd-license.php\r | |
13 | \r | |
14 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
15 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
16 | \r | |
79964ac8 | 17 | **/\r |
18 | \r | |
7c6d55db | 19 | #ifndef _FRAMEWORK_HII_H_\r |
20 | #define _FRAMEWORK_HII_H_\r | |
21 | \r | |
22 | //\r | |
5259c97d | 23 | // EFI_GRAPHICS_OUTPUT_BLT_PIXEL is defined in MdePkg/Protocol/GraphicsOutput.h\r |
7c6d55db | 24 | //\r |
25 | #include <Protocol/GraphicsOutput.h>\r | |
5259c97d | 26 | ////// In both EDK and EDK II, incompatbile change is done to Framework HII protocol. /// This change should cause a change of GUID in both of code and HII spec. But we /// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This/// is a known issue.///////// Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII/// 0.92 spec because the spec changed part of HII interfaces but did not update the protocol/// GUID.///#define EFI_HII_PROTOCOL_GUID \\r |
79964ac8 | 27 | { \\r |
28 | 0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \\r | |
29 | }\r | |
30 | \r | |
c39940b5 | 31 | #define EFI_HII_COMPATIBILITY_PROTOCOL_GUID \\r |
32 | { \\r | |
33 | 0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \\r | |
34 | }\r | |
35 | \r | |
73449862 | 36 | typedef UINT32 RELOFST;\r |
37 | \r | |
79964ac8 | 38 | typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL;\r |
39 | \r | |
06a098c4 | 40 | ///\r |
41 | /// Note: Name difference between code and the Framework HII 0.92 spec.\r | |
42 | /// Add FRAMEWORK_ prefix to avoid name confict with EFI_HII_HANDLE defined in the\r | |
43 | /// UEFI 2.1d spec.\r | |
44 | ///\r | |
dc7b4a5c | 45 | typedef UINT16 FRAMEWORK_EFI_HII_HANDLE;\r |
46 | \r | |
06a098c4 | 47 | ///\r |
48 | /// HII package type values\r | |
49 | ///\r | |
79964ac8 | 50 | #define EFI_HII_FONT 1\r |
51 | #define EFI_HII_STRING 2\r | |
52 | #define EFI_HII_IFR 3\r | |
53 | #define EFI_HII_KEYBOARD 4\r | |
54 | #define EFI_HII_HANDLES 5\r | |
55 | #define EFI_HII_VARIABLE 6\r | |
56 | #define EFI_HII_DEVICE_PATH 7\r | |
57 | \r | |
06a098c4 | 58 | //\r |
79964ac8 | 59 | // References to string tokens must use this macro to enable scanning for\r |
60 | // token usages.\r | |
61 | //\r | |
62 | #define STRING_TOKEN(t) t\r | |
63 | \r | |
64 | //\r | |
65 | // The following types are currently defined:\r | |
409f118c | 66 | // EFI_FORM_ID has been defined in UEFI spec.\r |
79964ac8 | 67 | //\r |
79964ac8 | 68 | typedef UINT16 EFI_FORM_LABEL;\r |
69 | \r | |
70 | #pragma pack(1)\r | |
71 | \r | |
06a098c4 | 72 | ///\r |
73 | /// The header found at the start of each package.\r | |
74 | ///\r | |
79964ac8 | 75 | typedef struct {\r |
06a098c4 | 76 | UINT32 Length; ///< The size of the package in bytes.\r |
77 | UINT16 Type; ///< The type of the package.\r | |
79964ac8 | 78 | } EFI_HII_PACK_HEADER;\r |
79 | \r | |
5259c97d | 80 | ////// IFR package structure./// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes. ///typedef struct {\r |
06a098c4 | 81 | EFI_HII_PACK_HEADER Header; ///< Header of the IFR package.\r |
79964ac8 | 82 | } EFI_HII_IFR_PACK;\r |
83 | \r | |
06a098c4 | 84 | ///\r |
85 | /// HII Handle package structure.\r | |
86 | /// \r | |
79964ac8 | 87 | typedef struct {\r |
5259c97d | 88 | /// /// Header of the package. /// EFI_HII_PACK_HEADER Header; // Must be filled in /// /// The image handle of the driver to which the package is referring. /// EFI_HANDLE ImageHandle; // Must be filled in ///\r |
06a098c4 | 89 | /// The handle of the device that is being described by this package.\r |
90 | ///\r | |
79964ac8 | 91 | EFI_HANDLE DeviceHandle; // Optional\r |
06a098c4 | 92 | ///\r |
93 | /// The handle of the parent of the device that is being described by this package.\r | |
94 | ///\r | |
79964ac8 | 95 | EFI_HANDLE ControllerHandle; // Optional\r |
06a098c4 | 96 | ///\r |
97 | /// The handle that was registered to receive EFI_FORM_CALLBACK_PROTOCOL calls from other drivers.\r | |
98 | ///\r | |
79964ac8 | 99 | EFI_HANDLE CallbackHandle; // Optional\r |
06a098c4 | 100 | ///\r |
101 | /// Note this field is not defined in the Framework HII 0.92 spec.\r | |
102 | /// Unused. Reserved for source code compatibility.\r | |
103 | ///\r | |
79964ac8 | 104 | EFI_HANDLE COBExportHandle; // Optional\r |
105 | } EFI_HII_HANDLE_PACK;\r | |
106 | \r | |
06a098c4 | 107 | ///\r |
108 | /// Variable package structure.\r | |
109 | /// \r | |
79964ac8 | 110 | typedef struct {\r |
06a098c4 | 111 | ///\r |
112 | /// Header of the package.\r | |
113 | ///\r | |
79964ac8 | 114 | EFI_HII_PACK_HEADER Header;\r |
06a098c4 | 115 | ///\r |
116 | /// GUID of the EFI variable\r | |
117 | ///\r | |
79964ac8 | 118 | EFI_GUID VariableGuid;\r |
06a098c4 | 119 | ///\r |
120 | /// Length in bytes of the EFI variable\r | |
121 | ///\r | |
79964ac8 | 122 | UINT32 VariableNameLength;\r |
06a098c4 | 123 | ///\r |
124 | /// The unique value for this variable\r | |
125 | ///\r | |
79964ac8 | 126 | UINT16 VariableId;\r |
127 | //\r | |
128 | // CHAR16 VariableName[]; //Null-terminated\r | |
129 | //\r | |
130 | } EFI_HII_VARIABLE_PACK;\r | |
131 | \r | |
06a098c4 | 132 | ///\r |
133 | /// Device path package structure.\r | |
134 | ///\r | |
79964ac8 | 135 | typedef struct {\r |
06a098c4 | 136 | ///\r |
137 | /// Header of the package.\r | |
138 | ///\r | |
79964ac8 | 139 | EFI_HII_PACK_HEADER Header;\r |
140 | //\r | |
141 | // EFI_DEVICE_PATH DevicePath[];\r | |
142 | //\r | |
143 | } EFI_HII_DEVICE_PATH_PACK;\r | |
144 | \r | |
79964ac8 | 145 | typedef struct {\r |
06a098c4 | 146 | ///\r |
147 | /// Unique value that correlates to the original HII handle. \r | |
148 | ///\r | |
dc7b4a5c | 149 | FRAMEWORK_EFI_HII_HANDLE HiiHandle;\r |
06a098c4 | 150 | ///\r |
151 | /// If an IFR pack exists in a data table that does not contain strings,\r | |
152 | /// then the strings for that IFR pack are located in another data table \r | |
153 | /// that contains a string pack and has a matching HiiDataTable.PackageGuid. \r | |
154 | ///\r | |
155 | EFI_GUID PackageGuid;\r | |
156 | ///\r | |
157 | /// Size of the EFI_HII_DATA_TABLE in bytes.\r | |
158 | ///\r | |
159 | UINT32 DataTableSize;\r | |
160 | ///\r | |
161 | /// Byte offset from the start of this structure to the IFR data.\r | |
162 | /// If the offset value is 0, then no IFR data is enclosed.\r | |
163 | ///\r | |
164 | UINT32 IfrDataOffset;\r | |
165 | ///\r | |
166 | /// Byte offset from the start of this structure to the string data. \r | |
167 | /// If the offset value is 0, then no string data is enclosed.\r | |
168 | ///\r | |
169 | UINT32 StringDataOffset;\r | |
170 | ///\r | |
171 | /// Byte offset from the start of this structure to the variable data.\r | |
172 | /// If the offset value is 0, then no variable data is enclosed.\r | |
173 | ///\r | |
174 | UINT32 VariableDataOffset;\r | |
175 | ///\r | |
176 | /// Byte offset from the start of this structure to the device path data.\r | |
177 | /// If the offset value is 0, then no DevicePath data is enclosed.\r | |
178 | ///\r | |
179 | UINT32 DevicePathOffset;\r | |
180 | ///\r | |
181 | /// Number of VariableData[] elements in the array.\r | |
182 | ///\r | |
183 | UINT32 NumberOfVariableData;\r | |
184 | ///\r | |
185 | /// The number of language string packages.\r | |
186 | ///\r | |
187 | UINT32 NumberOfLanguages;\r | |
79964ac8 | 188 | //\r |
189 | // EFI_HII_DEVICE_PATH_PACK DevicePath[];\r | |
190 | // EFI_HII_VARIABLE_PACK VariableData[];\r | |
191 | // EFI_HII_IFR_PACK IfrData;\r | |
192 | // EFI_HII_STRING_PACK StringData[];\r | |
193 | //\r | |
194 | } EFI_HII_DATA_TABLE;\r | |
195 | \r | |
06a098c4 | 196 | ///\r |
197 | /// Structure defining format for exporting data from the HII Database.\r | |
198 | ///\r | |
79964ac8 | 199 | typedef struct {\r |
06a098c4 | 200 | ///\r |
201 | /// Number of EFI_HII_DATA_TABLE entries.\r | |
202 | ///\r | |
79964ac8 | 203 | UINT32 NumberOfHiiDataTables;\r |
06a098c4 | 204 | ///\r |
205 | /// Defines the revision of the EFI_HII_DATA_TABLE structure.\r | |
206 | ///\r | |
79964ac8 | 207 | EFI_GUID Revision;\r |
208 | //\r | |
209 | // EFI_HII_DATA_TABLE HiiDataTable[];\r | |
210 | //\r | |
211 | } EFI_HII_EXPORT_TABLE;\r | |
212 | \r | |
06a098c4 | 213 | ///\r |
214 | /// Structure used to pass data to update a form or form package\r | |
215 | /// that has previously been registered with the EFI HII database.\r | |
216 | ///\r | |
79964ac8 | 217 | typedef struct {\r |
06a098c4 | 218 | ///\r |
219 | /// If TRUE, indicates that the FormCallbackHandle value will \r | |
220 | /// be used to update the contents of the CallBackHandle entry in the form set.\r | |
221 | ///\r | |
222 | BOOLEAN FormSetUpdate;\r | |
223 | ///\r | |
224 | /// This parameter is valid only when FormSetUpdate is TRUE.\r | |
225 | /// The value in this parameter will be used to update the contents \r | |
226 | /// of the CallbackHandle entry in the form set.\r | |
227 | ///\r | |
228 | EFI_PHYSICAL_ADDRESS FormCallbackHandle;\r | |
229 | ///\r | |
230 | /// If TRUE, indicates that the FormTitle contents will be \r | |
231 | /// used to update the FormValue's title.\r | |
232 | ///\r | |
233 | BOOLEAN FormUpdate;\r | |
234 | ///\r | |
235 | /// Specifies which form is to be updated if the FormUpdate value is TRUE.\r | |
236 | ///\r | |
237 | UINT16 FormValue;\r | |
238 | ///\r | |
239 | /// This parameter is valid only when the FormUpdate parameter is TRUE.\r | |
240 | /// The value in this parameter will be used to update the contents of the form title. \r | |
241 | ///\r | |
242 | STRING_REF FormTitle;\r | |
243 | ///\r | |
244 | /// The number of Data entries in this structure.\r | |
245 | UINT16 DataCount;\r | |
246 | ///\r | |
247 | /// An array of 1+ opcodes, specified by DataCount.\r | |
248 | ///\r | |
249 | UINT8 *Data;\r | |
250 | } EFI_HII_UPDATE_DATA;\r | |
79964ac8 | 251 | \r |
252 | //\r | |
253 | // String attributes\r | |
254 | //\r | |
255 | #define LANG_RIGHT_TO_LEFT 0x00000001\r | |
256 | \r | |
5259c97d | 257 | ////// A string package is used to localize strings to a particular/// language. The package is associated with a particular driver/// or set of drivers. Tools are used to associate tokens with/// string references in forms and in programs. These tokens are/// language agnostic. When paired with a language pack (directly/// or indirectly), the string token resolves into an actual/// UNICODE string. The NumStringPointers determines how many/// StringPointers (offset values) there are as well as the total/// number of Strings that are defined.///typedef struct {\r |
06a098c4 | 258 | ///\r |
259 | /// Header of the package.\r | |
260 | ///\r | |
79964ac8 | 261 | EFI_HII_PACK_HEADER Header;\r |
06a098c4 | 262 | ///\r |
263 | /// The string containing one or more ISO 639-2 three-character designator(s)\r | |
264 | /// of the language or languages whose translations are contained in this language pack.\r | |
265 | /// The first designator indicates the primary language while the others are secondary languages. \r | |
266 | ///\r | |
79964ac8 | 267 | RELOFST LanguageNameString;\r |
06a098c4 | 268 | ///\r |
269 | /// Contains the offset into this structure of a printable name of the language\r | |
270 | /// for use when prompting the user. The language printed is to be the primary language.\r | |
271 | ///\r | |
79964ac8 | 272 | RELOFST PrintableLanguageName;\r |
06a098c4 | 273 | ///\r |
274 | /// The number of Strings and StringPointers contained within the string package.\r | |
275 | ///\r | |
79964ac8 | 276 | UINT32 NumStringPointers;\r |
06a098c4 | 277 | ///\r |
278 | /// Indicates the direction the language is to be printed.\r | |
279 | ///\r | |
79964ac8 | 280 | UINT32 Attributes;\r |
281 | //\r | |
282 | // RELOFST StringPointers[];\r | |
283 | // EFI_STRING Strings[];\r | |
284 | //\r | |
285 | } EFI_HII_STRING_PACK;\r | |
286 | \r | |
79964ac8 | 287 | \r |
06a098c4 | 288 | ///\r |
289 | /// A font list consists of a font header followed by a series\r | |
290 | /// of glyph structures. Note that fonts are not language specific.\r | |
291 | ///\r | |
79964ac8 | 292 | typedef struct {\r |
06a098c4 | 293 | ///\r |
294 | /// Header of the package.\r | |
295 | ///\r | |
79964ac8 | 296 | EFI_HII_PACK_HEADER Header;\r |
06a098c4 | 297 | ///\r |
298 | /// The number of NarrowGlyphs that are included in the font package.\r | |
299 | ///\r | |
79964ac8 | 300 | UINT16 NumberOfNarrowGlyphs;\r |
06a098c4 | 301 | ///\r |
302 | /// The number of WideGlyphs that are included in the font package.\r | |
303 | ///\r | |
79964ac8 | 304 | UINT16 NumberOfWideGlyphs;\r |
06a098c4 | 305 | //EFI_NARROW_GLYPH NarrowGlyphs[];\r |
306 | //EFI_WIDE_GLYPH WideGlyphs[];\r | |
79964ac8 | 307 | } EFI_HII_FONT_PACK;\r |
308 | \r | |
5259c97d | 309 | ////// The definition of a specific physical key////// Note: Name difference between code and the Framework HII 0.92 spec./// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the/// UEFI 2.1d spec.///typedef struct {\r |
06a098c4 | 310 | ///\r |
311 | /// Used to describe a physical key on a keyboard.\r | |
312 | ///\r | |
79964ac8 | 313 | EFI_KEY Key;\r |
06a098c4 | 314 | ///\r |
315 | /// Unicode value for the Key.\r | |
79964ac8 | 316 | CHAR16 Unicode;\r |
06a098c4 | 317 | ///\r |
318 | /// Unicode value for the key with the shift key being held down.\r | |
319 | ///\r | |
79964ac8 | 320 | CHAR16 ShiftedUnicode;\r |
06a098c4 | 321 | ///\r |
322 | /// Unicode value for the key with the Alt-GR being held down.\r | |
323 | ///\r | |
79964ac8 | 324 | CHAR16 AltGrUnicode;\r |
06a098c4 | 325 | ///\r |
326 | /// Unicode value for the key with the Alt-GR and shift keys being held down.\r | |
327 | ///\r | |
79964ac8 | 328 | CHAR16 ShiftedAltGrUnicode;\r |
06a098c4 | 329 | ///\r |
330 | /// Modifier keys are defined to allow for special functionality that \r | |
331 | /// is not necessarily accomplished by a printable character. \r | |
332 | ///\r | |
79964ac8 | 333 | UINT16 Modifier;\r |
dc7b4a5c | 334 | } FRAMEWORK_EFI_KEY_DESCRIPTOR;\r |
79964ac8 | 335 | \r |
5259c97d | 336 | ////// This structure allows a sparse set of keys to be redefined/// or a complete redefinition of the keyboard layout. Most/// keyboards have a lot of commonality in their layouts, therefore/// only defining those keys that need to change from the default/// minimizes the passed in information.////// Additionally, when an update occurs, the active keyboard layout/// will be switched to the newly updated keyboard layout. This/// allows for situations that when a keyboard layout driver is/// loaded as part of system initialization, the system will default/// the keyboard behavior to the new layout.///typedef struct {\r |
06a098c4 | 337 | ///\r |
338 | /// Header of the package.\r | |
339 | EFI_HII_PACK_HEADER Header;\r | |
340 | ///\r | |
341 | /// A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR entries.\r | |
342 | /// Each entry will reflect the definition of a specific physical key.\r | |
343 | ///\r | |
dc7b4a5c | 344 | FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor;\r |
06a098c4 | 345 | ///\r |
346 | /// The number of Descriptor entries being described.\r | |
347 | ///\r | |
348 | UINT8 DescriptorCount;\r | |
79964ac8 | 349 | } EFI_HII_KEYBOARD_PACK;\r |
350 | \r | |
06a098c4 | 351 | ///\r |
352 | /// The packages structure that will be used to pass contents into the HII database.\r | |
353 | ///\r | |
354 | /// The EFI_HII_PACKAGES can contain various number of packages of different types just\r | |
355 | /// after the structure as inline data.\r | |
356 | ///\r | |
79964ac8 | 357 | typedef struct {\r |
06a098c4 | 358 | ///\r |
359 | /// The number of packages being defined in this structure.\r | |
360 | ///\r | |
79964ac8 | 361 | UINTN NumberOfPackages;\r |
06a098c4 | 362 | ///\r |
363 | /// The GUID to be used to identify this set of packages that are being exported\r | |
364 | /// to the HII database.\r | |
365 | ///\r | |
79964ac8 | 366 | EFI_GUID *GuidId;\r |
367 | //\r | |
368 | // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.\r | |
369 | // EFI_HII_IFR_PACK *IfrPack; // Only one pack.\r | |
370 | // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok\r | |
371 | // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok\r | |
372 | // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok\r | |
373 | //\r | |
374 | } EFI_HII_PACKAGES;\r | |
375 | \r | |
06a098c4 | 376 | ///\r |
377 | /// Packed link list that contains all the discernable defaults of variables\r | |
378 | /// for the opcodes that are defined in this Handle's domain of data.\r | |
379 | ///\r | |
79964ac8 | 380 | typedef struct _EFI_HII_VARIABLE_PACK_LIST {\r |
06a098c4 | 381 | ///\r |
382 | /// A pointer points to the next data structure of type \r | |
383 | /// EFI_HII_VARIABLE_PACK_LIST in the packed link list.\r | |
384 | ///\r | |
79964ac8 | 385 | struct _EFI_HII_VARIABLE_PACK_LIST *NextVariablePack;\r |
06a098c4 | 386 | ///\r |
387 | /// A pointer points to the content of the variable entry defined by GUID/name/data.\r | |
388 | ///\r | |
79964ac8 | 389 | EFI_HII_VARIABLE_PACK *VariablePack;\r |
06a098c4 | 390 | //EFI_HII_VARIABLE_PACK Content\r |
79964ac8 | 391 | } EFI_HII_VARIABLE_PACK_LIST;\r |
392 | \r | |
61a30832 | 393 | \r |
79964ac8 | 394 | #pragma pack()\r |
395 | \r | |
396 | /**\r | |
397 | Registers the various packs that are passed in via the Packages parameter.\r | |
398 | \r | |
399 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
400 | @param Packages A pointer to an EFI_HII_PACKAGES package instance.\r | |
534b8251 | 401 | @param Handle A pointer to the FRAMEWORK_EFI_HII_HANDLE instance.\r |
79964ac8 | 402 | \r |
403 | @retval EFI_SUCCESS Data was extracted from Packages, the database\r | |
404 | was updated with the data, and Handle returned successfully.\r | |
405 | @retval EFI_INVALID_PARAMETER The content of Packages was invalid.\r | |
406 | \r | |
407 | **/\r | |
408 | typedef\r | |
409 | EFI_STATUS\r | |
06a098c4 | 410 | (EFIAPI *EFI_HII_NEW_PACK)(\r |
411 | IN EFI_HII_PROTOCOL *This,\r | |
412 | IN EFI_HII_PACKAGES *Packages,\r | |
413 | OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r | |
79964ac8 | 414 | );\r |
415 | \r | |
416 | /**\r | |
417 | Removes a package from the HII database.\r | |
418 | \r | |
419 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
420 | @param Handle The handle that was registered to the data that is requested\r | |
421 | for removal.\r | |
422 | \r | |
423 | @retval EFI_SUCCESS The data associated with the Handle was removed\r | |
424 | from the HII database.\r | |
425 | @retval EFI_INVALID_PARAMETER The Handle was not valid.\r | |
426 | \r | |
427 | **/\r | |
428 | typedef\r | |
429 | EFI_STATUS\r | |
06a098c4 | 430 | (EFIAPI *EFI_HII_REMOVE_PACK)(\r |
431 | IN EFI_HII_PROTOCOL *This,\r | |
432 | IN FRAMEWORK_EFI_HII_HANDLE Handle\r | |
79964ac8 | 433 | );\r |
434 | \r | |
435 | /**\r | |
436 | Determines the handles that are currently active in the database.\r | |
437 | \r | |
438 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
439 | @param HandleBufferLength On input, a pointer to the length of the handle\r | |
440 | buffer. On output, the length of the handle buffer that is required\r | |
441 | for the handles found.\r | |
dc7b4a5c | 442 | @param Handle An array of FRAMEWORK_EFI_HII_HANDLE instances returned.\r |
79964ac8 | 443 | \r |
444 | @retval EFI_SUCCESS Handle was updated successfully.\r | |
445 | @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates\r | |
446 | that Handle is too small to support the number of handles.\r | |
447 | \r | |
448 | **/\r | |
449 | typedef\r | |
450 | EFI_STATUS\r | |
06a098c4 | 451 | (EFIAPI *EFI_HII_FIND_HANDLES)(\r |
452 | IN EFI_HII_PROTOCOL *This,\r | |
453 | IN OUT UINT16 *HandleBufferLength,\r | |
454 | OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r | |
79964ac8 | 455 | );\r |
456 | \r | |
457 | /**\r | |
458 | Exports the contents of the database into a buffer.\r | |
459 | \r | |
460 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
5259c97d | 461 | @param Handle A FRAMEWORK_EFI_HII_HANDLE that corresponds to the desired\r |
79964ac8 | 462 | handle to export. If the value is 0, the entire database will be exported.\r |
5259c97d | 463 | The data is exported in a format described by the\r |
79964ac8 | 464 | structure definition of EFI_HII_EXPORT_TABLE.\r |
465 | @param BufferSize\r | |
466 | On input, a pointer to the length of the buffer. On output, the length\r | |
467 | of the buffer that is required for the export data.\r | |
468 | @param Buffer A pointer to a buffer that will contain the results of the export function.\r | |
469 | \r | |
470 | @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.\r | |
471 | @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.\r | |
472 | \r | |
473 | **/\r | |
474 | typedef\r | |
475 | EFI_STATUS\r | |
06a098c4 | 476 | (EFIAPI *EFI_HII_EXPORT)(\r |
477 | IN EFI_HII_PROTOCOL *This,\r | |
478 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
479 | IN OUT UINTN *BufferSize,\r | |
480 | OUT VOID *Buffer\r | |
79964ac8 | 481 | );\r |
482 | \r | |
483 | /**\r | |
484 | Remove any new strings that were added after the initial string export\r | |
485 | for this handle.\r | |
486 | \r | |
487 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
488 | @param Handle The handle on which the string resides.\r | |
489 | \r | |
5259c97d | 490 | @retval EFI_SUCCESS Successfully removed strings from the handle.\r |
79964ac8 | 491 | @retval EFI_INVALID_PARAMETER The Handle was unknown.\r |
492 | \r | |
493 | **/\r | |
494 | typedef\r | |
495 | EFI_STATUS\r | |
06a098c4 | 496 | (EFIAPI *EFI_HII_RESET_STRINGS)(\r |
497 | IN EFI_HII_PROTOCOL *This,\r | |
498 | IN FRAMEWORK_EFI_HII_HANDLE Handle\r | |
79964ac8 | 499 | );\r |
500 | \r | |
501 | /**\r | |
502 | Tests if all of the characters in a string have corresponding font characters.\r | |
503 | \r | |
504 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
505 | @param StringToTest A pointer to a Unicode string.\r | |
506 | @param FirstMissing A pointer to an index into the string. On input,\r | |
507 | the index of the first character in the StringToTest to examine. On exit,\r | |
508 | the index of the first character encountered for which a glyph is unavailable.\r | |
509 | If all glyphs in the string are available, the index is the index of the\r | |
510 | terminator of the string.\r | |
511 | @param GlyphBufferSize A pointer to a value. On output, if the function\r | |
512 | returns EFI_SUCCESS, it contains the amount of memory that is required to\r | |
513 | store the string's glyph equivalent.\r | |
514 | \r | |
515 | @retval EFI_SUCCESS All glyphs are available. Note that an empty string\r | |
516 | always returns this value.\r | |
517 | @retval EFI_NOT_FOUND A glyph was not found for a character.\r | |
518 | \r | |
519 | **/\r | |
520 | typedef\r | |
521 | EFI_STATUS\r | |
e7be5d90 | 522 | (EFIAPI *EFI_HII_TEST_STRING)(\r |
79964ac8 | 523 | IN EFI_HII_PROTOCOL *This,\r |
524 | IN CHAR16 *StringToTest,\r | |
525 | IN OUT UINT32 *FirstMissing,\r | |
526 | OUT UINT32 *GlyphBufferSize\r | |
527 | );\r | |
528 | \r | |
529 | /**\r | |
530 | Translates a Unicode character into the corresponding font glyph.\r | |
531 | \r | |
06a098c4 | 532 | Note that this function prototype name is different from that in the Framework HII 0.92 spec\r |
533 | to avoid name confict with EFI_HII_GET_GLYPH defined in the UEFI 2.1d spec.\r | |
534 | \r | |
79964ac8 | 535 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r |
536 | @param Source A pointer to a Unicode string.\r | |
537 | @param Index On input, the offset into the string from which to fetch\r | |
5259c97d | 538 | the character. On successful completion, the index is updated to the first\r |
79964ac8 | 539 | character past the character(s) making up the just extracted glyph.\r |
540 | @param GlyphBuffer Pointer to an array where the glyphs corresponding\r | |
541 | to the characters in the source may be stored. GlyphBuffer is assumed\r | |
542 | to be wide enough to accept a wide glyph character.\r | |
543 | @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by\r | |
544 | this value is filled with the length of the glyph in pixels. It is unchanged\r | |
545 | if the call was unsuccessful.\r | |
546 | @param InternalStatus The cell pointed to by this parameter must be\r | |
547 | initialized to zero prior to invoking the call the first time for any string.\r | |
548 | \r | |
549 | @retval EFI_SUCCESS It worked.\r | |
550 | @retval EFI_NOT_FOUND A glyph for a character was not found.\r | |
551 | \r | |
552 | **/\r | |
553 | typedef\r | |
554 | EFI_STATUS\r | |
69686d56 | 555 | (EFIAPI *FRAMEWORK_EFI_HII_GET_GLYPH)(\r |
79964ac8 | 556 | IN EFI_HII_PROTOCOL *This,\r |
557 | IN CHAR16 *Source,\r | |
558 | IN OUT UINT16 *Index,\r | |
559 | OUT UINT8 **GlyphBuffer,\r | |
560 | OUT UINT16 *BitWidth,\r | |
561 | IN OUT UINT32 *InternalStatus\r | |
562 | );\r | |
563 | \r | |
564 | /**\r | |
565 | Translates a glyph into the format required for input to the Universal\r | |
566 | Graphics Adapter (UGA) Block Transfer (BLT) routines.\r | |
567 | \r | |
568 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
569 | @param GlyphBuffer A pointer to the buffer that contains glyph data.\r | |
570 | @param Foreground The foreground setting requested to be used for the\r | |
571 | generated BltBuffer data.\r | |
572 | @param Background The background setting requested to be used for the\r | |
573 | generated BltBuffer data.\r | |
574 | @param Count The entry in the BltBuffer upon which to act.\r | |
575 | @param Width The width in bits of the glyph being converted.\r | |
576 | @param Height The height in bits of the glyph being converted\r | |
577 | @param BltBuffer A pointer to the buffer that contains the data that is\r | |
578 | ready to be used by the UGA BLT routines.\r | |
579 | \r | |
580 | @retval EFI_SUCCESS It worked.\r | |
581 | @retval EFI_NOT_FOUND A glyph for a character was not found.\r | |
6d1824fc | 582 | @note: Inconsistent with specification here:\r |
5259c97d | 583 | In Framework Spec, HII spec 0.92. The type of 3rd, 4th and 8th parameter is EFI_UGA_PIXEL.\r |
584 | Here the definition uses the EFI_GRAPHICS_OUTPUT_BLT_PIXEL, which is defined in UEFI 2.1 spec\r | |
79964ac8 | 585 | **/\r |
586 | typedef\r | |
587 | EFI_STATUS\r | |
06a098c4 | 588 | (EFIAPI *EFI_HII_GLYPH_TO_BLT)(\r |
79964ac8 | 589 | IN EFI_HII_PROTOCOL *This,\r |
590 | IN UINT8 *GlyphBuffer,\r | |
591 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r | |
592 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,\r | |
593 | IN UINTN Count,\r | |
594 | IN UINTN Width,\r | |
595 | IN UINTN Height,\r | |
596 | IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer\r | |
597 | );\r | |
598 | \r | |
599 | /**\r | |
600 | Allows a new string to be added to an already existing string package.\r | |
601 | \r | |
06a098c4 | 602 | Note that this function prototype name is different from that in the Framework HII 0.92 spec\r |
603 | to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d spec.\r | |
604 | \r | |
79964ac8 | 605 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r |
606 | @param Pointer to a NULL-terminated string containing a single ISO 639-2\r | |
607 | language identifier, indicating the language in which the string is translated.\r | |
608 | @param Handle The handle of the language pack to which the string is to be added.\r | |
609 | @param Reference The identifier of the string to be added. If the reference\r | |
610 | value is zero, then the string will be assigned a new identifier on that\r | |
611 | handle for the language specified. Otherwise, the string will be updated\r | |
612 | with the NewString Value.\r | |
613 | @param NewString The string to be added.\r | |
614 | \r | |
615 | @retval EFI_SUCCESS The string was effectively registered.\r | |
616 | @retval EFI_INVALID_PARAMETER The Handle was unknown.\r | |
617 | \r | |
618 | **/\r | |
619 | typedef\r | |
620 | EFI_STATUS\r | |
69686d56 | 621 | (EFIAPI *FRAMEWORK_EFI_HII_NEW_STRING)(\r |
06a098c4 | 622 | IN EFI_HII_PROTOCOL *This,\r |
623 | IN CHAR16 *Language,\r | |
624 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
625 | IN OUT STRING_REF *Reference,\r | |
626 | IN CHAR16 *NewString\r | |
79964ac8 | 627 | );\r |
628 | \r | |
629 | /**\r | |
630 | Allows a program to determine the primary languages that are supported\r | |
631 | on a given handle.\r | |
632 | \r | |
633 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
634 | @param Handle The handle on which the strings reside.\r | |
635 | @param LanguageString A string allocated by GetPrimaryLanguages() that\r | |
636 | contains a list of all primary languages registered on the handle.\r | |
637 | \r | |
638 | @retval EFI_SUCCESS LanguageString was correctly returned.\r | |
639 | @retval EFI_INVALID_PARAMETER The Handle was unknown.\r | |
640 | \r | |
641 | **/\r | |
642 | typedef\r | |
643 | EFI_STATUS\r | |
06a098c4 | 644 | (EFIAPI *EFI_HII_GET_PRI_LANGUAGES)(\r |
645 | IN EFI_HII_PROTOCOL *This,\r | |
646 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
647 | OUT EFI_STRING *LanguageString\r | |
79964ac8 | 648 | );\r |
649 | \r | |
650 | /**\r | |
651 | Allows a program to determine which secondary languages are supported\r | |
652 | on a given handle for a given primary language.\r | |
653 | \r | |
654 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
655 | @param Handle The handle on which the strings reside.\r | |
656 | @param PrimaryLanguage Pointer to a NULL-terminated string containing a single\r | |
657 | ISO 639-2 language identifier, indicating the primary language.\r | |
658 | @param LanguageString A string allocated by GetSecondaryLanguages()\r | |
659 | containing a list of all secondary languages registered on the handle.\r | |
660 | \r | |
661 | @retval EFI_SUCCESS LanguageString was correctly returned.\r | |
662 | @retval EFI_INVALID_PARAMETER The Handle was unknown.\r | |
663 | \r | |
664 | **/\r | |
665 | typedef\r | |
666 | EFI_STATUS\r | |
06a098c4 | 667 | (EFIAPI *EFI_HII_GET_SEC_LANGUAGES)(\r |
668 | IN EFI_HII_PROTOCOL *This,\r | |
669 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
670 | IN CHAR16 *PrimaryLanguage,\r | |
671 | OUT EFI_STRING *LanguageString\r | |
79964ac8 | 672 | );\r |
673 | \r | |
674 | /**\r | |
675 | Extracts a string from a package already registered with the EFI HII database.\r | |
676 | \r | |
06a098c4 | 677 | Note that this function prototype name is different from that in the Framework HII 0.92 spec\r |
678 | to avoid name confict with EFI_HII_GET_STRING defined in the UEFI 2.1d spec.\r | |
679 | \r | |
79964ac8 | 680 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r |
681 | @param Handle The handle on which the string resides.\r | |
682 | @param Token The string token assigned to the string.\r | |
683 | @param Raw If TRUE, the string is returned unedited in the internal\r | |
06a098c4 | 684 | storage format. If false, the string returned is edited\r |
79964ac8 | 685 | by replacing <cr> with <space> and by removing special characters such\r |
686 | as the <wide> prefix.\r | |
687 | @param LanguageString Pointer to a NULL-terminated string containing a\r | |
688 | single ISO 639-2 language identifier, indicating the language to print.\r | |
689 | If the LanguageString is empty (starts with a NULL), the default system\r | |
690 | language will be used to determine the language.\r | |
691 | @param BufferLength Length of the StringBuffer.\r | |
692 | @param StringBuffer The buffer designed to receive the characters in the string.\r | |
693 | \r | |
694 | @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.\r | |
695 | @retval EFI_INVALID_PARAMETER The handle or string token is unknown.\r | |
696 | @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to\r | |
697 | allow the entire string to be stored.\r | |
698 | \r | |
699 | **/\r | |
700 | typedef\r | |
701 | EFI_STATUS\r | |
69686d56 | 702 | (EFIAPI *FRAMEWORK_EFI_HII_GET_STRING)(\r |
06a098c4 | 703 | IN EFI_HII_PROTOCOL *This,\r |
704 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
705 | IN STRING_REF Token,\r | |
706 | IN BOOLEAN Raw,\r | |
707 | IN CHAR16 *LanguageString,\r | |
708 | IN OUT UINTN *BufferLength,\r | |
709 | OUT EFI_STRING StringBuffer\r | |
79964ac8 | 710 | );\r |
711 | \r | |
712 | /**\r | |
713 | Allows a program to extract a part of a string of not more than a given width.\r | |
714 | \r | |
715 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
716 | @param Handle The handle on which the string resides.\r | |
717 | @param Token The string token assigned to the string.\r | |
718 | @param Index On input, the offset into the string where the line is to start.\r | |
719 | On output, the index is updated to point to beyond the last character returned\r | |
720 | in the call.\r | |
721 | @param LineWidth The maximum width of the line in units of narrow glyphs.\r | |
722 | @param LanguageString Pointer to a NULL-terminated string containing a\r | |
723 | single ISO 639-2 language identifier, indicating the language to print.\r | |
724 | @param BufferLength Pointer to the length of the StringBuffer.\r | |
725 | @param StringBuffer The buffer designed to receive the characters in the string.\r | |
726 | \r | |
727 | @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.\r | |
728 | @retval EFI_NOT_FOUND The font glyph for at least one of the characters in\r | |
729 | the string is not in the font database.\r | |
730 | @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough\r | |
731 | to allow the entire string to be stored.\r | |
732 | \r | |
733 | **/\r | |
734 | typedef\r | |
735 | EFI_STATUS\r | |
06a098c4 | 736 | (EFIAPI *EFI_HII_GET_LINE)(\r |
737 | IN EFI_HII_PROTOCOL *This,\r | |
738 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
739 | IN STRING_REF Token,\r | |
740 | IN OUT UINT16 *Index,\r | |
741 | IN UINT16 LineWidth,\r | |
742 | IN CHAR16 *LanguageString,\r | |
743 | IN OUT UINT16 *BufferLength,\r | |
744 | OUT EFI_STRING StringBuffer\r | |
79964ac8 | 745 | );\r |
746 | \r | |
747 | /**\r | |
748 | Allows a program to extract a form or form package that has previously\r | |
749 | been registered with the HII database.\r | |
750 | \r | |
751 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
752 | @param Handle Handle on which the form resides.\r | |
753 | @param FormId The ID of the form to return. If the ID is zero,\r | |
754 | the entire form package is returned.\r | |
755 | @param BufferLength On input, the length of the Buffer. On output,\r | |
756 | the length of the returned buffer,\r | |
757 | @param Buffer The buffer designed to receive the form(s).\r | |
758 | \r | |
759 | @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength\r | |
760 | was updated.\r | |
761 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
762 | @retval EFI_NOT_FOUND A form on the requested handle cannot be found with\r | |
763 | the requested FormId.\r | |
764 | @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough\r | |
765 | to allow the form to be stored.\r | |
766 | \r | |
767 | **/\r | |
768 | typedef\r | |
769 | EFI_STATUS\r | |
06a098c4 | 770 | (EFIAPI *EFI_HII_GET_FORMS)(\r |
771 | IN EFI_HII_PROTOCOL *This,\r | |
772 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
773 | IN EFI_FORM_ID FormId,\r | |
774 | IN OUT UINTN *BufferLength,\r | |
775 | OUT UINT8 *Buffer\r | |
79964ac8 | 776 | );\r |
777 | \r | |
778 | /**\r | |
779 | Extracts the defaults that are associated with a given handle in the HII database.\r | |
780 | \r | |
781 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
782 | @param Handle The HII handle from which will have default data retrieved.\r | |
783 | @param DefaultMask The mask used to specify some type of default override when extracting\r | |
784 | the default image data.\r | |
5259c97d | 785 | @param VariablePackList An indirect pointer to the first entry of a link list with\r |
79964ac8 | 786 | type EFI_HII_VARIABLE_PACK_LIST.\r |
787 | \r | |
788 | @retval EFI_SUCCESS The VariablePackList was populated with the appropriate\r | |
789 | default setting data.\r | |
790 | @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).\r | |
791 | @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle\r | |
792 | contain invalid data.\r | |
793 | \r | |
794 | **/\r | |
795 | typedef\r | |
796 | EFI_STATUS\r | |
06a098c4 | 797 | (EFIAPI *EFI_HII_GET_DEFAULT_IMAGE)(\r |
79964ac8 | 798 | IN EFI_HII_PROTOCOL *This,\r |
dc7b4a5c | 799 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r |
79964ac8 | 800 | IN UINTN DefaultMask,\r |
801 | OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r | |
802 | );\r | |
803 | \r | |
804 | /**\r | |
805 | Allows the caller to update a form or form package that has previously been\r | |
806 | registered with the EFI HII database.\r | |
807 | \r | |
808 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
809 | @param Handle Handle of the package where the form to be updated resides.\r | |
810 | @param Label The label inside the form package where the update is to take place.\r | |
811 | @param AddData If TRUE, adding data at a given Label; otherwise,\r | |
812 | if FALSE, removing data at a given Label.\r | |
813 | @param Data The buffer containing the new tags to insert after the Label\r | |
814 | \r | |
815 | @retval EFI_SUCCESS The form was updated with the new tags.\r | |
816 | @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not\r | |
817 | contain an integral number of tags.\r | |
818 | @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.\r | |
819 | \r | |
820 | **/\r | |
821 | typedef\r | |
822 | EFI_STATUS\r | |
06a098c4 | 823 | (EFIAPI *EFI_HII_UPDATE_FORM)(\r |
824 | IN EFI_HII_PROTOCOL *This,\r | |
825 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
826 | IN EFI_FORM_LABEL Label,\r | |
827 | IN BOOLEAN AddData,\r | |
828 | IN EFI_HII_UPDATE_DATA *Data\r | |
79964ac8 | 829 | );\r |
830 | \r | |
831 | /**\r | |
832 | Retrieves the current keyboard layout.\r | |
833 | \r | |
06a098c4 | 834 | Note that this function prototype name is different from that in the Framework HII 0.92 spec\r |
835 | to avoid name confict with EFI_HII_GET_KEYBOARD_LAYOUT defined in the UEFI 2.1d spec.\r | |
836 | \r | |
79964ac8 | 837 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r |
838 | @param DescriptorCount A pointer to the number of Descriptor entries being\r | |
839 | described in the keyboard layout being retrieved.\r | |
dc7b4a5c | 840 | @param Descriptor A pointer to a buffer containing an array of FRAMEWORK_EFI_KEY_DESCRIPTOR\r |
79964ac8 | 841 | entries. Each entry will reflect the definition of a specific physical key.\r |
842 | \r | |
843 | @retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r | |
844 | \r | |
845 | **/\r | |
846 | typedef\r | |
847 | EFI_STATUS\r | |
69686d56 | 848 | (EFIAPI *FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT)(\r |
06a098c4 | 849 | IN EFI_HII_PROTOCOL *This,\r |
850 | OUT UINT16 *DescriptorCount,\r | |
dc7b4a5c | 851 | OUT FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor\r |
79964ac8 | 852 | );\r |
853 | \r | |
06a098c4 | 854 | ///\r |
855 | /// The HII Protocol manages the HII database, which is a repository for data\r | |
856 | /// having to do with fonts, strings, forms, keyboards, and other future human\r | |
857 | /// interface items.\r | |
858 | ///\r | |
79964ac8 | 859 | struct _EFI_HII_PROTOCOL {\r |
2bbaeb0d | 860 | ///\r |
861 | /// Extracts the various packs from a package list.\r | |
862 | ///\r | |
06a098c4 | 863 | EFI_HII_NEW_PACK NewPack;\r |
2bbaeb0d | 864 | \r |
865 | ///\r | |
866 | /// Removes a package from the HII database.\r | |
867 | ///\r | |
06a098c4 | 868 | EFI_HII_REMOVE_PACK RemovePack;\r |
2bbaeb0d | 869 | \r |
870 | ///\r | |
871 | /// Determines the handles that are currently active in the database.\r | |
872 | /// \r | |
06a098c4 | 873 | EFI_HII_FIND_HANDLES FindHandles;\r |
2bbaeb0d | 874 | \r |
875 | ///\r | |
876 | /// Export the entire contents of the database to a buffer.\r | |
877 | ///\r | |
06a098c4 | 878 | EFI_HII_EXPORT ExportDatabase;\r |
c1adc63d | 879 | \r |
2bbaeb0d | 880 | ///\r |
881 | /// Tests if all of the characters in a string have corresponding font characters.\r | |
882 | ///\r | |
06a098c4 | 883 | EFI_HII_TEST_STRING TestString;\r |
2bbaeb0d | 884 | \r |
885 | ///\r | |
886 | /// Translates a Unicode character into the corresponding font glyph.\r | |
887 | ///\r | |
c1adc63d | 888 | FRAMEWORK_EFI_HII_GET_GLYPH GetGlyph;\r |
2bbaeb0d | 889 | \r |
890 | ///\r | |
891 | /// Converts a glyph value into a format that is ready for a UGA BLT command.\r | |
892 | ///\r | |
06a098c4 | 893 | EFI_HII_GLYPH_TO_BLT GlyphToBlt;\r |
c1adc63d | 894 | \r |
2bbaeb0d | 895 | ///\r |
896 | /// Allows a new string to be added to an already existing string package.\r | |
897 | ///\r | |
c1adc63d | 898 | FRAMEWORK_EFI_HII_NEW_STRING NewString;\r |
2bbaeb0d | 899 | \r |
900 | ///\r | |
901 | /// Allows a program to determine the primary languages that are supported\r | |
902 | /// on a given handle. \r | |
903 | ///\r | |
06a098c4 | 904 | EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages;\r |
2bbaeb0d | 905 | \r |
906 | ///\r | |
907 | /// Allows a program to determine which secondary languages are supported\r | |
908 | /// on a given handle for a given primary language. \r | |
909 | ///\r | |
06a098c4 | 910 | EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages;\r |
2bbaeb0d | 911 | \r |
912 | ///\r | |
913 | /// Extracts a string from a package that is already registered with the\r | |
914 | /// EFI HII database. \r | |
915 | ///\r | |
c1adc63d | 916 | FRAMEWORK_EFI_HII_GET_STRING GetString;\r |
2bbaeb0d | 917 | \r |
918 | ///\r | |
919 | /// Remove any new strings that were added after the initial string export\r | |
920 | /// for this handle. \r | |
06a098c4 | 921 | /// \r |
922 | /// Note this function is not defined in the Framework HII 0.92 spec.\r | |
2bbaeb0d | 923 | ///\r |
06a098c4 | 924 | EFI_HII_RESET_STRINGS ResetStrings;\r |
2bbaeb0d | 925 | \r |
926 | ///\r | |
927 | /// Allows a program to extract a part of a string of not more than a given width.\r | |
928 | ///\r | |
06a098c4 | 929 | EFI_HII_GET_LINE GetLine;\r |
2bbaeb0d | 930 | \r |
931 | ///\r | |
932 | /// Allows a program to extract a form or form package that has been previously registered.\r | |
933 | ///\r | |
06a098c4 | 934 | EFI_HII_GET_FORMS GetForms;\r |
2bbaeb0d | 935 | \r |
936 | ///\r | |
937 | /// Allows a program to extract the nonvolatile image that represents the default storage image.\r | |
938 | ///\r | |
06a098c4 | 939 | EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage;\r |
2bbaeb0d | 940 | \r |
941 | ///\r | |
942 | /// Allows a program to update a previously registered form.\r | |
943 | ///\r | |
06a098c4 | 944 | EFI_HII_UPDATE_FORM UpdateForm;\r |
c1adc63d | 945 | \r |
2bbaeb0d | 946 | ///\r |
947 | /// Allows a program to extract the current keyboard layout.\r | |
948 | ///\r | |
c1adc63d | 949 | FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r |
79964ac8 | 950 | };\r |
951 | \r | |
952 | extern EFI_GUID gEfiHiiProtocolGuid;\r | |
c39940b5 | 953 | extern EFI_GUID gEfiHiiCompatibilityProtocolGuid;\r |
954 | \r | |
79964ac8 | 955 | #endif\r |
06a098c4 | 956 | \r |