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