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