]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Efi/Include/EfiHii.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Update the copyright notice format
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Efi / Include / EfiHii.h
CommitLineData
2c40a813 1/*++\r
2\r
f57387d5
HT		 3Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
4This program and the accompanying materials\r
2c40a813 5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12Module Name:\r
13\r
14 EfiHii.h\r
15\r
16Abstract:\r
17\r
18 Hii relative definitions, such as Hii package, IFR OpCode etc\r
19\r
20Revision History\r
21\r
22--*/\r
23\r
24#ifndef _EFI_HII_H_\r
25#define _EFI_HII_H_\r
26\r
27#include "EfiCommon.h"\r
28#include EFI_PROTOCOL_DEFINITION (DevicePath)\r
29\r
30typedef VOID *EFI_HII_HANDLE;\r
31typedef CHAR16 *EFI_STRING;\r
32typedef UINT16 EFI_QUESTION_ID;\r
33typedef UINT16 EFI_IMAGE_ID;\r
34typedef UINT16 EFI_STRING_ID;\r
35typedef UINT16 EFI_FORM_ID;\r
36typedef UINT16 EFI_VARSTORE_ID;\r
37typedef UINT16 EFI_DEFAULT_ID;\r
38typedef UINT32 EFI_HII_FONT_STYLE;\r
39\r
40//\r
41// Type defined for backward compatible with Framework HII\r
42//\r
43typedef EFI_STRING_ID STRING_REF;\r
44\r
45#pragma pack(1)\r
46\r
47//\r
48// HII package list\r
49//\r
50typedef struct {\r
51 EFI_GUID PackageListGuid;\r
52 UINT32 PackageLength;\r
53} EFI_HII_PACKAGE_LIST_HEADER;\r
54\r
55typedef struct {\r
56 UINT32 Length:24;\r
57 UINT32 Type:8;\r
58} EFI_HII_PACKAGE_HEADER;\r
59\r
60#define EFI_HII_PACKAGE_TYPE_ALL 0x00\r
61#define EFI_HII_PACKAGE_TYPE_GUID 0x01\r
62#define EFI_HII_PACKAGE_FORM 0x02\r
63#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x03\r
64#define EFI_HII_PACKAGE_STRINGS 0x04\r
65#define EFI_HII_PACKAGE_FONTS 0x05\r
66#define EFI_HII_PACKAGE_IMAGES 0x06\r
67#define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07\r
68#define EFI_HII_PACKAGE_DEVICE_PATH 0x08\r
69#define EFI_HII_PACKAGE_END 0xDF\r
70#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0\r
71#define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF\r
72\r
73//\r
74// Simplified Font Package\r
75//\r
76\r
77#define EFI_GLYPH_HEIGHT 19\r
78#define EFI_GLYPH_WIDTH 8\r
79//\r
80// Contents of EFI_NARROW_GLYPH.Attributes\r
81//\r
82#define EFI_GLYPH_NON_SPACING 0x01\r
83#define EFI_GLYPH_WIDE 0x02\r
84\r
85typedef struct {\r
86 CHAR16 UnicodeWeight;\r
87 UINT8 Attributes;\r
88 UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r
89} EFI_NARROW_GLYPH;\r
90\r
91typedef struct {\r
92 CHAR16 UnicodeWeight;\r
93 UINT8 Attributes;\r
94 UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r
95 UINT8 GlyphCol2[EFI_GLYPH_HEIGHT];\r
96 UINT8 Pad[3];\r
97} EFI_WIDE_GLYPH;\r
98\r
99typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {\r
100 EFI_HII_PACKAGE_HEADER Header;\r
101 UINT16 NumberOfNarrowGlyphs;\r
102 UINT16 NumberOfWideGlyphs;\r
103 // EFI_NARROW_GLYPH NarrowGlyphs[];\r
104 // EFI_WIDE_GLYPH WideGlyphs[];\r
105} EFI_HII_SIMPLE_FONT_PACKAGE_HDR;\r
106\r
107//\r
108// Font Package\r
109//\r
110\r
111#define EFI_HII_FONT_STYLE_BOLD 0x00000001\r
112#define EFI_HII_FONT_STYLE_ITALIC 0x00000002\r
113#define EFI_HII_FONT_STYLE_EMBOSS 0x00010000\r
114#define EFI_HII_FONT_STYLE_OUTLINE 0x00020000\r
115#define EFI_HII_FONT_STYLE_SHADOW 0x00040000\r
116#define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000\r
117#define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000\r
118\r
119typedef struct _EFI_HII_GLYPH_INFO {\r
120 UINT16 Width;\r
121 UINT16 Height;\r
122 INT16 OffsetX;\r
123 INT16 OffsetY;\r
124 INT16 AdvanceX;\r
125} EFI_HII_GLYPH_INFO;\r
126\r
127typedef struct _EFI_HII_FONT_PACKAGE_HDR {\r
128 EFI_HII_PACKAGE_HEADER Header;\r
129 UINT32 HdrSize;\r
130 UINT32 GlyphBlockOffset;\r
131 EFI_HII_GLYPH_INFO Cell;\r
132 EFI_HII_FONT_STYLE FontStyle;\r
133 CHAR16 FontFamily[1];\r
134} EFI_HII_FONT_PACKAGE_HDR;\r
135\r
136#define EFI_HII_GIBT_END 0x00\r
137#define EFI_HII_GIBT_GLYPH 0x10\r
138#define EFI_HII_GIBT_GLYPHS 0x11\r
139#define EFI_HII_GIBT_GLYPH_DEFAULT 0x12\r
140#define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13\r
141#define EFI_HII_GIBT_DUPLICATE 0x20\r
142#define EFI_HII_GIBT_SKIP2 0x21\r
143#define EFI_HII_GIBT_SKIP1 0x22\r
144#define EFI_HII_GIBT_DEFAULTS 0x23\r
145#define EFI_HII_GIBT_EXT1 0x30\r
146#define EFI_HII_GIBT_EXT2 0x31\r
147#define EFI_HII_GIBT_EXT4 0x32\r
148\r
149typedef struct _EFI_HII_GLYPH_BLOCK {\r
150 UINT8 BlockType;\r
151} EFI_HII_GLYPH_BLOCK;\r
152\r
153typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK {\r
154 EFI_HII_GLYPH_BLOCK Header;\r
155 EFI_HII_GLYPH_INFO Cell;\r
156} EFI_HII_GIBT_DEFAULTS_BLOCK;\r
157\r
158typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK {\r
159 EFI_HII_GLYPH_BLOCK Header;\r
160 CHAR16 CharValue;\r
161} EFI_HII_GIBT_DUPLICATE_BLOCK;\r
162\r
163typedef struct _EFI_GLYPH_GIBT_END_BLOCK {\r
164 EFI_HII_GLYPH_BLOCK Header;\r
165} EFI_GLYPH_GIBT_END_BLOCK;\r
166\r
167typedef struct _EFI_HII_GIBT_EXT1_BLOCK {\r
168 EFI_HII_GLYPH_BLOCK Header;\r
169 UINT8 BlockType2;\r
170 UINT8 Length;\r
171} EFI_HII_GIBT_EXT1_BLOCK;\r
172\r
173typedef struct _EFI_HII_GIBT_EXT2_BLOCK {\r
174 EFI_HII_GLYPH_BLOCK Header;\r
175 UINT8 BlockType2;\r
176 UINT16 Length;\r
177} EFI_HII_GIBT_EXT2_BLOCK;\r
178\r
179typedef struct _EFI_HII_GIBT_EXT4_BLOCK {\r
180 EFI_HII_GLYPH_BLOCK Header;\r
181 UINT8 BlockType2;\r
182 UINT32 Length;\r
183} EFI_HII_GIBT_EXT4_BLOCK;\r
184\r
185typedef struct _EFI_HII_GIBT_GLYPH_BLOCK {\r
186 EFI_HII_GLYPH_BLOCK Header;\r
187 EFI_HII_GLYPH_INFO Cell;\r
188 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
189} EFI_HII_GIBT_GLYPH_BLOCK;\r
190\r
191typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK {\r
192 EFI_HII_GLYPH_BLOCK Header;\r
193 EFI_HII_GLYPH_INFO Cell;\r
194 UINT16 Count; \r
195 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
196} EFI_HII_GIBT_GLYPHS_BLOCK;\r
197\r
198typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK {\r
199 EFI_HII_GLYPH_BLOCK Header;\r
200 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
201} EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK;\r
202\r
203typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK {\r
204 EFI_HII_GLYPH_BLOCK Header;\r
205 UINT16 Count;\r
206 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
207} EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK;\r
208\r
209typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {\r
210 EFI_HII_GLYPH_BLOCK Header;\r
211 UINT8 SkipCount;\r
212} EFI_HII_GIBT_SKIP1_BLOCK;\r
213\r
214typedef struct _EFI_HII_GIBT_SKIP2_BLOCK {\r
215 EFI_HII_GLYPH_BLOCK Header;\r
216 UINT16 SkipCount;\r
217} EFI_HII_GIBT_SKIP2_BLOCK;\r
218\r
219//\r
220// Device Path Package\r
221//\r
222typedef struct _EFI_HII_DEVICE_PATH_PACKAGE {\r
223 EFI_HII_PACKAGE_HEADER Header;\r
224 // EFI_DEVICE_PATH_PROTOCOL DevicePath[];\r
225} EFI_HII_DEVICE_PATH_PACKAGE;\r
226\r
227//\r
228// GUID Package\r
229//\r
230typedef struct _EFI_HII_GUID_PACKAGE_HDR {\r
231 EFI_HII_PACKAGE_HEADER Header;\r
232 EFI_GUID Guid;\r
233 // Data per GUID definition may follow\r
234} EFI_HII_GUID_PACKAGE_HDR;\r
235\r
236//\r
237// String Package\r
238//\r
239\r
240#define UEFI_CONFIG_LANG L"x-UEFI"\r
241#define UEFI_CONFIG_LANG2 L"x-i-UEFI" // BUGBUG, spec need to be updated.\r
242\r
243typedef struct _EFI_HII_STRING_PACKAGE_HDR {\r
244 EFI_HII_PACKAGE_HEADER Header;\r
245 UINT32 HdrSize;\r
246 UINT32 StringInfoOffset;\r
247 CHAR16 LanguageWindow[16];\r
248 EFI_STRING_ID LanguageName;\r
249 CHAR8 Language[1];\r
250} EFI_HII_STRING_PACKAGE_HDR;\r
251\r
252typedef struct {\r
253 UINT8 BlockType;\r
254} EFI_HII_STRING_BLOCK;\r
255\r
256#define EFI_HII_SIBT_END 0x00\r
257#define EFI_HII_SIBT_STRING_SCSU 0x10\r
258#define EFI_HII_SIBT_STRING_SCSU_FONT 0x11\r
259#define EFI_HII_SIBT_STRINGS_SCSU 0x12\r
260#define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13\r
261#define EFI_HII_SIBT_STRING_UCS2 0x14\r
262#define EFI_HII_SIBT_STRING_UCS2_FONT 0x15\r
263#define EFI_HII_SIBT_STRINGS_UCS2 0x16\r
264#define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17\r
265#define EFI_HII_SIBT_DUPLICATE 0x20\r
266#define EFI_HII_SIBT_SKIP2 0x21\r
267#define EFI_HII_SIBT_SKIP1 0x22\r
268#define EFI_HII_SIBT_EXT1 0x30\r
269#define EFI_HII_SIBT_EXT2 0x31\r
270#define EFI_HII_SIBT_EXT4 0x32\r
271#define EFI_HII_SIBT_FONT 0x40\r
272\r
273typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK {\r
274 EFI_HII_STRING_BLOCK Header;\r
275 EFI_STRING_ID StringId;\r
276} EFI_HII_SIBT_DUPLICATE_BLOCK;\r
277\r
278typedef struct _EFI_HII_SIBT_END_BLOCK {\r
279 EFI_HII_STRING_BLOCK Header;\r
280} EFI_HII_SIBT_END_BLOCK;\r
281\r
282typedef struct _EFI_HII_SIBT_EXT1_BLOCK {\r
283 EFI_HII_STRING_BLOCK Header;\r
284 UINT8 BlockType2;\r
285 UINT8 Length;\r
286} EFI_HII_SIBT_EXT1_BLOCK;\r
287\r
288typedef struct _EFI_HII_SIBT_EXT2_BLOCK {\r
289 EFI_HII_STRING_BLOCK Header;\r
290 UINT8 BlockType2;\r
291 UINT16 Length;\r
292} EFI_HII_SIBT_EXT2_BLOCK;\r
293\r
294typedef struct _EFI_HII_SIBT_EXT4_BLOCK {\r
295 EFI_HII_STRING_BLOCK Header;\r
296 UINT8 BlockType2;\r
297 UINT32 Length;\r
298} EFI_HII_SIBT_EXT4_BLOCK;\r
299\r
300typedef struct _EFI_HII_SIBT_FONT_BLOCK {\r
301 EFI_HII_SIBT_EXT2_BLOCK Header;\r
302 UINT8 FontId;\r
303 UINT16 FontSize;\r
304 EFI_HII_FONT_STYLE FontStyle;\r
305 CHAR16 FontName[1];\r
306} EFI_HII_SIBT_FONT_BLOCK;\r
307\r
308typedef struct _EFI_HII_SIBT_SKIP1_BLOCK {\r
309 EFI_HII_STRING_BLOCK Header;\r
310 UINT8 SkipCount;\r
311} EFI_HII_SIBT_SKIP1_BLOCK;\r
312\r
313typedef struct _EFI_HII_SIBT_SKIP2_BLOCK {\r
314 EFI_HII_STRING_BLOCK Header;\r
315 UINT16 SkipCount;\r
316} EFI_HII_SIBT_SKIP2_BLOCK;\r
317\r
318typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK {\r
319 EFI_HII_STRING_BLOCK Header;\r
320 UINT8 StringText[1];\r
321} EFI_HII_SIBT_STRING_SCSU_BLOCK;\r
322\r
323typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK {\r
324 EFI_HII_STRING_BLOCK Header;\r
325 UINT8 FontIdentifier;\r
326 UINT8 StringText[1];\r
327} EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK;\r
328\r
329typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK {\r
330 EFI_HII_STRING_BLOCK Header;\r
331 UINT16 StringCount;\r
332 UINT8 StringText[1];\r
333} EFI_HII_SIBT_STRINGS_SCSU_BLOCK;\r
334\r
335typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK {\r
336 EFI_HII_STRING_BLOCK Header;\r
337 UINT8 FontIdentifier;\r
338 UINT16 StringCount;\r
339 UINT8 StringText[1];\r
340} EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK;\r
341\r
342typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK {\r
343 EFI_HII_STRING_BLOCK Header;\r
344 CHAR16 StringText[1];\r
345} EFI_HII_SIBT_STRING_UCS2_BLOCK;\r
346\r
347typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK {\r
348 EFI_HII_STRING_BLOCK Header;\r
349 UINT8 FontIdentifier;\r
350 CHAR16 StringText[1];\r
351} EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK;\r
352\r
353typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK {\r
354 EFI_HII_STRING_BLOCK Header;\r
355 UINT16 StringCount;\r
356 CHAR16 StringText[1];\r
357} EFI_HII_SIBT_STRINGS_UCS2_BLOCK;\r
358\r
359typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK {\r
360 EFI_HII_STRING_BLOCK Header;\r
361 UINT8 FontIdentifier;\r
362 UINT16 StringCount;\r
363 CHAR16 StringText[1];\r
364} EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK;\r
365\r
366//\r
367// Image Packages\r
368//\r
369\r
370typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
371 EFI_HII_PACKAGE_HEADER Header;\r
372 UINT32 ImageInfoOffset;\r
373 UINT32 PaletteInfoOffset;\r
374} EFI_HII_IMAGE_PACKAGE_HDR;\r
375\r
376typedef struct _EFI_HII_IMAGE_BLOCK {\r
377 UINT8 BlockType;\r
378} EFI_HII_IMAGE_BLOCK;\r
379\r
380#define EFI_HII_IIBT_END 0x00\r
381#define EFI_HII_IIBT_IMAGE_1BIT 0x10\r
382#define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11\r
383#define EFI_HII_IIBT_IMAGE_4BIT 0x12\r
384#define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13\r
385#define EFI_HII_IIBT_IMAGE_8BIT 0x14\r
386#define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15\r
387#define EFI_HII_IIBT_IMAGE_24BIT 0x16\r
388#define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17\r
389#define EFI_HII_IIBT_IMAGE_JPEG 0x18\r
390#define EFI_HII_IIBT_DUPLICATE 0x20\r
391#define EFI_HII_IIBT_SKIP2 0x21\r
392#define EFI_HII_IIBT_SKIP1 0x22\r
393#define EFI_HII_IIBT_EXT1 0x30\r
394#define EFI_HII_IIBT_EXT2 0x31\r
395#define EFI_HII_IIBT_EXT4 0x32\r
396\r
397typedef struct _EFI_HII_IIBT_END_BLOCK {\r
398 EFI_HII_IMAGE_BLOCK Header;\r
399} EFI_HII_IIBT_END_BLOCK;\r
400\r
401typedef struct _EFI_HII_IIBT_EXT1_BLOCK {\r
402 EFI_HII_IMAGE_BLOCK Header;\r
403 UINT8 BlockType2;\r
404 UINT8 Length;\r
405} EFI_HII_IIBT_EXT1_BLOCK;\r
406\r
407typedef struct _EFI_HII_IIBT_EXT2_BLOCK {\r
408 EFI_HII_IMAGE_BLOCK Header;\r
409 UINT8 BlockType2;\r
410 UINT16 Length;\r
411} EFI_HII_IIBT_EXT2_BLOCK;\r
412\r
413typedef struct _EFI_HII_IIBT_EXT4_BLOCK {\r
414 EFI_HII_IMAGE_BLOCK Header;\r
415 UINT8 BlockType2;\r
416 UINT32 Length;\r
417} EFI_HII_IIBT_EXT4_BLOCK;\r
418\r
419typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE {\r
420 UINT16 Width;\r
421 UINT16 Height;\r
422 UINT8 Data[1];\r
423} EFI_HII_IIBT_IMAGE_1BIT_BASE;\r
424\r
425typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK {\r
426 EFI_HII_IMAGE_BLOCK Header;\r
427 UINT8 PaletteIndex;\r
428 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r
429} EFI_HII_IIBT_IMAGE_1BIT_BLOCK;\r
430\r
431typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK {\r
432 EFI_HII_IMAGE_BLOCK Header;\r
433 UINT8 PaletteIndex;\r
434 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r
435} EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK;\r
436\r
437typedef struct _EFI_HII_RGB_PIXEL {\r
438 UINT8 b;\r
439 UINT8 g;\r
440 UINT8 r;\r
441} EFI_HII_RGB_PIXEL;\r
442\r
443typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE {\r
444 UINT16 Width;\r
445 UINT16 Height;\r
446 EFI_HII_RGB_PIXEL Bitmap[1];\r
447} EFI_HII_IIBT_IMAGE_24BIT_BASE;\r
448\r
449typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK {\r
450 EFI_HII_IMAGE_BLOCK Header;\r
451 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r
452} EFI_HII_IIBT_IMAGE_24BIT_BLOCK;\r
453\r
454typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK {\r
455 EFI_HII_IMAGE_BLOCK Header;\r
456 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r
457} EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK;\r
458\r
459typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE {\r
460 UINT16 Width;\r
461 UINT16 Height;\r
462 UINT8 Data[1];\r
463} EFI_HII_IIBT_IMAGE_4BIT_BASE;\r
464\r
465typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK {\r
466 EFI_HII_IMAGE_BLOCK Header;\r
467 UINT8 PaletteIndex;\r
468 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r
469} EFI_HII_IIBT_IMAGE_4BIT_BLOCK;\r
470\r
471typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK {\r
472 EFI_HII_IMAGE_BLOCK Header;\r
473 UINT8 PaletteIndex;\r
474 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r
475} EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK;\r
476\r
477typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE {\r
478 UINT16 Width;\r
479 UINT16 Height;\r
480 UINT8 Data[1];\r
481} EFI_HII_IIBT_IMAGE_8BIT_BASE;\r
482\r
483typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK {\r
484 EFI_HII_IMAGE_BLOCK Header;\r
485 UINT8 PaletteIndex;\r
486 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r
487} EFI_HII_IIBT_IMAGE_8BIT_BLOCK;\r
488\r
489typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK {\r
490 EFI_HII_IMAGE_BLOCK Header;\r
491 UINT8 PaletteIndex;\r
492 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r
493} EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK;\r
494\r
495typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK {\r
496 EFI_HII_IMAGE_BLOCK Header;\r
497 EFI_IMAGE_ID ImageId;\r
498} EFI_HII_IIBT_DUPLICATE_BLOCK;\r
499\r
500typedef struct _EFI_HII_IIBT_JPEG_BLOCK {\r
501 EFI_HII_IMAGE_BLOCK Header;\r
502 UINT32 Size;\r
503 UINT8 Data[1];\r
504} EFI_HII_IIBT_JPEG_BLOCK;\r
505\r
506typedef struct _EFI_HII_IIBT_SKIP1_BLOCK {\r
507 EFI_HII_IMAGE_BLOCK Header;\r
508 UINT8 SkipCount;\r
509} EFI_HII_IIBT_SKIP1_BLOCK;\r
510\r
511typedef struct _EFI_HII_IIBT_SKIP2_BLOCK {\r
512 EFI_HII_IMAGE_BLOCK Header;\r
513 UINT16 SkipCount;\r
514} EFI_HII_IIBT_SKIP2_BLOCK;\r
515\r
516typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER {\r
517 UINT16 PaletteCount;\r
518} EFI_HII_IMAGE_PALETTE_INFO_HEADER;\r
519\r
520typedef struct _EFI_HII_IMAGE_PALETTE_INFO {\r
521 UINT16 PaletteSize;\r
522 EFI_HII_RGB_PIXEL PaletteValue[1];\r
523} EFI_HII_IMAGE_PALETTE_INFO;\r
524\r
525//\r
526// Forms Package\r
527//\r
528\r
529typedef struct _EFI_HII_FORM_PACKAGE {\r
530 EFI_HII_PACKAGE_HEADER Header;\r
531 // EFI_IFR_OP_HEADER OpCodeHeader;\r
532 // More op-codes follow\r
533} EFI_HII_FORM_PACKAGE;\r
534\r
535typedef struct {\r
536 UINT8 Hour;\r
537 UINT8 Minute;\r
538 UINT8 Second;\r
539} EFI_HII_TIME;\r
540\r
541typedef struct {\r
542 UINT16 Year;\r
543 UINT8 Month;\r
544 UINT8 Day;\r
545} EFI_HII_DATE;\r
546\r
547typedef union {\r
548 UINT8 u8;\r
549 UINT16 u16;\r
550 UINT32 u32;\r
551 UINT64 u64;\r
552 BOOLEAN b;\r
553 EFI_HII_TIME time;\r
554 EFI_HII_DATE date;\r
555 EFI_STRING_ID string;\r
556} EFI_IFR_TYPE_VALUE;\r
557\r
558#define EFI_IFR_FORM_OP 0x01\r
559#define EFI_IFR_SUBTITLE_OP 0x02\r
560#define EFI_IFR_TEXT_OP 0x03\r
561#define EFI_IFR_IMAGE_OP 0x04\r
562#define EFI_IFR_ONE_OF_OP 0x05\r
563#define EFI_IFR_CHECKBOX_OP 0x06\r
564#define EFI_IFR_NUMERIC_OP 0x07\r
565#define EFI_IFR_PASSWORD_OP 0x08\r
566#define EFI_IFR_ONE_OF_OPTION_OP 0x09\r
567#define EFI_IFR_SUPPRESS_IF_OP 0x0A\r
568#define EFI_IFR_LOCKED_OP 0x0B\r
569#define EFI_IFR_ACTION_OP 0x0C\r
570#define EFI_IFR_RESET_BUTTON_OP 0x0D\r
571#define EFI_IFR_FORM_SET_OP 0x0E\r
572#define EFI_IFR_REF_OP 0x0F\r
573#define EFI_IFR_NO_SUBMIT_IF_OP 0x10\r
574#define EFI_IFR_INCONSISTENT_IF_OP 0x11\r
575#define EFI_IFR_EQ_ID_VAL_OP 0x12\r
576#define EFI_IFR_EQ_ID_ID_OP 0x13\r
577#define EFI_IFR_EQ_ID_LIST_OP 0x14\r
578#define EFI_IFR_AND_OP 0x15\r
579#define EFI_IFR_OR_OP 0x16\r
580#define EFI_IFR_NOT_OP 0x17\r
581#define EFI_IFR_RULE_OP 0x18\r
582#define EFI_IFR_GRAY_OUT_IF_OP 0x19\r
583#define EFI_IFR_DATE_OP 0x1A\r
584#define EFI_IFR_TIME_OP 0x1B\r
585#define EFI_IFR_STRING_OP 0x1C\r
586#define EFI_IFR_REFRESH_OP 0x1D\r
587#define EFI_IFR_DISABLE_IF_OP 0x1E\r
588#define EFI_IFR_TO_LOWER_OP 0x20\r
589#define EFI_IFR_TO_UPPER_OP 0x21\r
590#define EFI_IFR_ORDERED_LIST_OP 0x23\r
591#define EFI_IFR_VARSTORE_OP 0x24\r
592#define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25\r
593#define EFI_IFR_VARSTORE_EFI_OP 0x26\r
594#define EFI_IFR_VARSTORE_DEVICE_OP 0x27\r
595#define EFI_IFR_VERSION_OP 0x28\r
596#define EFI_IFR_END_OP 0x29\r
597#define EFI_IFR_MATCH_OP 0x2A\r
598#define EFI_IFR_EQUAL_OP 0x2F\r
599#define EFI_IFR_NOT_EQUAL_OP 0x30\r
600#define EFI_IFR_GREATER_THAN_OP 0x31\r
601#define EFI_IFR_GREATER_EQUAL_OP 0x32\r
602#define EFI_IFR_LESS_THAN_OP 0x33\r
603#define EFI_IFR_LESS_EQUAL_OP 0x34\r
604#define EFI_IFR_BITWISE_AND_OP 0x35\r
605#define EFI_IFR_BITWISE_OR_OP 0x36\r
606#define EFI_IFR_BITWISE_NOT_OP 0x37\r
607#define EFI_IFR_SHIFT_LEFT_OP 0x38\r
608#define EFI_IFR_SHIFT_RIGHT_OP 0x39\r
609#define EFI_IFR_ADD_OP 0x3A\r
610#define EFI_IFR_SUBTRACT_OP 0x3B\r
611#define EFI_IFR_MULTIPLY_OP 0x3C\r
612#define EFI_IFR_DIVIDE_OP 0x3D\r
613#define EFI_IFR_MODULO_OP 0x3E\r
614#define EFI_IFR_RULE_REF_OP 0x3F\r
615#define EFI_IFR_QUESTION_REF1_OP 0x40\r
616#define EFI_IFR_QUESTION_REF2_OP 0x41\r
617#define EFI_IFR_UINT8_OP 0x42\r
618#define EFI_IFR_UINT16_OP 0x43\r
619#define EFI_IFR_UINT32_OP 0x44\r
620#define EFI_IFR_UINT64_OP 0x45\r
621#define EFI_IFR_TRUE_OP 0x46\r
622#define EFI_IFR_FALSE_OP 0x47\r
623#define EFI_IFR_TO_UINT_OP 0x48\r
624#define EFI_IFR_TO_STRING_OP 0x49\r
625#define EFI_IFR_TO_BOOLEAN_OP 0x4A\r
626#define EFI_IFR_MID_OP 0x4B\r
627#define EFI_IFR_FIND_OP 0x4C\r
628#define EFI_IFR_TOKEN_OP 0x4D\r
629#define EFI_IFR_STRING_REF1_OP 0x4E\r
630#define EFI_IFR_STRING_REF2_OP 0x4F\r
631#define EFI_IFR_CONDITIONAL_OP 0x50\r
632#define EFI_IFR_QUESTION_REF3_OP 0x51\r
633#define EFI_IFR_ZERO_OP 0x52\r
634#define EFI_IFR_ONE_OP 0x53\r
635#define EFI_IFR_ONES_OP 0x54\r
636#define EFI_IFR_UNDEFINED_OP 0x55\r
637#define EFI_IFR_LENGTH_OP 0x56\r
638#define EFI_IFR_DUP_OP 0x57\r
639#define EFI_IFR_THIS_OP 0x58\r
640#define EFI_IFR_SPAN_OP 0x59\r
641#define EFI_IFR_VALUE_OP 0x5A\r
642#define EFI_IFR_DEFAULT_OP 0x5B\r
643#define EFI_IFR_DEFAULTSTORE_OP 0x5C\r
644#define EFI_IFR_CATENATE_OP 0x5E\r
645#define EFI_IFR_GUID_OP 0x5F\r
646\r
647typedef struct _EFI_IFR_OP_HEADER {\r
648 UINT8 OpCode;\r
649 UINT8 Length:7;\r
650 UINT8 Scope:1;\r
651} EFI_IFR_OP_HEADER;\r
652\r
653typedef struct _EFI_IFR_STATEMENT_HEADER {\r
654 EFI_STRING_ID Prompt;\r
655 EFI_STRING_ID Help;\r
656} EFI_IFR_STATEMENT_HEADER;\r
657\r
658typedef struct _EFI_IFR_QUESTION_HEADER {\r
659 EFI_IFR_STATEMENT_HEADER Header;\r
660 EFI_QUESTION_ID QuestionId;\r
661 EFI_VARSTORE_ID VarStoreId;\r
662 union {\r
663 EFI_STRING_ID VarName;\r
664 UINT16 VarOffset;\r
665 } VarStoreInfo;\r
666 UINT8 Flags;\r
667} EFI_IFR_QUESTION_HEADER;\r
668\r
669#define EFI_IFR_FLAG_READ_ONLY 0x01\r
670#define EFI_IFR_FLAG_CALLBACK 0x04\r
671#define EFI_IFR_FLAG_RESET_REQUIRED 0x10\r
672#define EFI_IFR_FLAG_OPTIONS_ONLY 0x80\r
673\r
674typedef struct _EFI_IFR_DEFAULTSTORE {\r
675 EFI_IFR_OP_HEADER Header;\r
676 EFI_STRING_ID DefaultName;\r
677 UINT16 DefaultId;\r
678} EFI_IFR_DEFAULTSTORE;\r
679\r
680#define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000\r
681#define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001\r
682#define EFI_HII_DEFAULT_CLASS_SAFE 0x0002\r
683#define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000\r
684#define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff\r
685#define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000\r
686#define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff\r
687#define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000\r
688#define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff\r
689\r
690typedef struct _EFI_IFR_VARSTORE {\r
691 EFI_IFR_OP_HEADER Header;\r
692 EFI_GUID Guid;\r
693 EFI_VARSTORE_ID VarStoreId;\r
694 UINT16 Size;\r
695 UINT8 Name[1];\r
696} EFI_IFR_VARSTORE;\r
697\r
698typedef struct _EFI_IFR_VARSTORE_EFI {\r
699 EFI_IFR_OP_HEADER Header;\r
700 UINT16 VarStoreId;\r
701 EFI_GUID Guid;\r
702 UINT32 Attributes;\r
703} EFI_IFR_VARSTORE_EFI;\r
704\r
705typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {\r
706 EFI_IFR_OP_HEADER Header;\r
707 UINT16 VarStoreId;\r
708 EFI_GUID Guid;\r
709} EFI_IFR_VARSTORE_NAME_VALUE;\r
710\r
711typedef struct _EFI_IFR_FORM_SET {\r
712 EFI_IFR_OP_HEADER Header;\r
713 EFI_GUID Guid;\r
714 EFI_STRING_ID FormSetTitle;\r
715 EFI_STRING_ID Help;\r
716} EFI_IFR_FORM_SET;\r
717\r
718typedef struct _EFI_IFR_END {\r
719 EFI_IFR_OP_HEADER Header;\r
720} EFI_IFR_END;\r
721\r
722typedef struct _EFI_IFR_FORM {\r
723 EFI_IFR_OP_HEADER Header;\r
724 UINT16 FormId;\r
725 EFI_STRING_ID FormTitle;\r
726} EFI_IFR_FORM;\r
727\r
728typedef struct _EFI_IFR_IMAGE {\r
729 EFI_IFR_OP_HEADER Header;\r
730 EFI_IMAGE_ID Id;\r
731} EFI_IFR_IMAGE;\r
732\r
733typedef struct _EFI_IFR_LOCKED {\r
734 EFI_IFR_OP_HEADER Header;\r
735} EFI_IFR_LOCKED;\r
736\r
737typedef struct _EFI_IFR_RULE {\r
738 EFI_IFR_OP_HEADER Header;\r
739 UINT8 RuleId;\r
740} EFI_IFR_RULE;\r
741\r
742typedef struct _EFI_IFR_DEFAULT {\r
743 EFI_IFR_OP_HEADER Header;\r
744 UINT16 DefaultId;\r
745 UINT8 Type;\r
746 EFI_IFR_TYPE_VALUE Value;\r
747} EFI_IFR_DEFAULT;\r
748\r
749typedef struct _EFI_IFR_VALUE {\r
750 EFI_IFR_OP_HEADER Header;\r
751} EFI_IFR_VALUE;\r
752\r
753typedef struct _EFI_IFR_SUBTITLE {\r
754 EFI_IFR_OP_HEADER Header;\r
755 EFI_IFR_STATEMENT_HEADER Statement;\r
756 UINT8 Flags;\r
757} EFI_IFR_SUBTITLE;\r
758\r
759#define EFI_IFR_FLAGS_HORIZONTAL 0x01\r
760\r
761typedef struct _EFI_IFR_CHECKBOX {\r
762 EFI_IFR_OP_HEADER Header;\r
763 EFI_IFR_QUESTION_HEADER Question;\r
764 UINT8 Flags;\r
765} EFI_IFR_CHECKBOX;\r
766\r
767#define EFI_IFR_CHECKBOX_DEFAULT 0x01\r
768#define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02\r
769\r
770typedef struct _EFI_IFR_TEXT {\r
771 EFI_IFR_OP_HEADER Header;\r
772 EFI_IFR_STATEMENT_HEADER Statement;\r
773 EFI_STRING_ID TextTwo;\r
774} EFI_IFR_TEXT;\r
775\r
776typedef struct _EFI_IFR_REF {\r
777 EFI_IFR_OP_HEADER Header;\r
778 EFI_IFR_QUESTION_HEADER Question;\r
779 EFI_FORM_ID FormId;\r
780} EFI_IFR_REF;\r
781\r
782typedef struct _EFI_IFR_REF2 {\r
783 EFI_IFR_OP_HEADER Header;\r
784 EFI_IFR_QUESTION_HEADER Question;\r
785 EFI_FORM_ID FormId;\r
786 EFI_QUESTION_ID QuestionId;\r
787} EFI_IFR_REF2;\r
788\r
789typedef struct _EFI_IFR_REF3 {\r
790 EFI_IFR_OP_HEADER Header;\r
791 EFI_IFR_QUESTION_HEADER Question;\r
792 EFI_FORM_ID FormId;\r
793 EFI_QUESTION_ID QuestionId;\r
794 EFI_GUID FormSetId;\r
795} EFI_IFR_REF3;\r
796\r
797typedef struct _EFI_IFR_REF4 {\r
798 EFI_IFR_OP_HEADER Header;\r
799 EFI_IFR_QUESTION_HEADER Question;\r
800 EFI_FORM_ID FormId;\r
801 EFI_QUESTION_ID QuestionId;\r
802 EFI_GUID FormSetId;\r
803 EFI_STRING_ID DevicePath;\r
804} EFI_IFR_REF4;\r
805\r
806typedef struct _EFI_IFR_RESET_BUTTON {\r
807 EFI_IFR_OP_HEADER Header;\r
808 EFI_IFR_QUESTION_HEADER Question;\r
809 EFI_DEFAULT_ID DefaultId;\r
810} EFI_IFR_RESET_BUTTON;\r
811\r
812typedef struct _EFI_IFR_ACTION {\r
813 EFI_IFR_OP_HEADER Header;\r
814 EFI_IFR_QUESTION_HEADER Question;\r
815 EFI_STRING_ID QuestionConfig;\r
816} EFI_IFR_ACTION;\r
817\r
818typedef struct _EFI_IFR_ACTION_1 {\r
819 EFI_IFR_OP_HEADER Header;\r
820 EFI_IFR_QUESTION_HEADER Question;\r
821} EFI_IFR_ACTION_1;\r
822\r
823typedef struct _EFI_IFR_DATE {\r
824 EFI_IFR_OP_HEADER Header;\r
825 EFI_IFR_QUESTION_HEADER Question;\r
826 UINT8 Flags;\r
827} EFI_IFR_DATE;\r
828\r
829#define EFI_QF_DATE_YEAR_SUPPRESS 0x01\r
830#define EFI_QF_DATE_MONTH_SUPPRESS 0x02\r
831#define EFI_QF_DATE_DAY_SUPPRESS 0x04\r
832\r
833#define EFI_QF_DATE_STORAGE 0x30\r
834#define QF_DATE_STORAGE_NORMAL 0x00\r
835#define QF_DATE_STORAGE_TIME 0x10\r
836#define QF_DATE_STORAGE_WAKEUP 0x20\r
837\r
838typedef union {\r
839 struct {\r
840 UINT8 MinValue;\r
841 UINT8 MaxValue;\r
842 UINT8 Step;\r
843 } u8;\r
844 struct {\r
845 UINT16 MinValue;\r
846 UINT16 MaxValue;\r
847 UINT16 Step;\r
848 } u16;\r
849 struct {\r
850 UINT32 MinValue;\r
851 UINT32 MaxValue;\r
852 UINT32 Step;\r
853 } u32;\r
854 struct {\r
855 UINT64 MinValue;\r
856 UINT64 MaxValue;\r
857 UINT64 Step;\r
858 } u64;\r
859} MINMAXSTEP_DATA;\r
860\r
861typedef struct _EFI_IFR_NUMERIC {\r
862 EFI_IFR_OP_HEADER Header;\r
863 EFI_IFR_QUESTION_HEADER Question;\r
864 UINT8 Flags;\r
865 MINMAXSTEP_DATA data;\r
866} EFI_IFR_NUMERIC;\r
867\r
868#define EFI_IFR_NUMERIC_SIZE 0x03\r
869#define EFI_IFR_NUMERIC_SIZE_1 0x00\r
870#define EFI_IFR_NUMERIC_SIZE_2 0x01\r
871#define EFI_IFR_NUMERIC_SIZE_4 0x02\r
872#define EFI_IFR_NUMERIC_SIZE_8 0x03\r
873\r
874#define EFI_IFR_DISPLAY 0x30\r
875#define EFI_IFR_DISPLAY_INT_DEC 0x00\r
876#define EFI_IFR_DISPLAY_UINT_DEC 0x10\r
877#define EFI_IFR_DISPLAY_UINT_HEX 0x20\r
878\r
879typedef struct _EFI_IFR_ONE_OF {\r
880 EFI_IFR_OP_HEADER Header;\r
881 EFI_IFR_QUESTION_HEADER Question;\r
882 UINT8 Flags;\r
883 MINMAXSTEP_DATA data;\r
884} EFI_IFR_ONE_OF;\r
885\r
886typedef struct _EFI_IFR_STRING {\r
887 EFI_IFR_OP_HEADER Header;\r
888 EFI_IFR_QUESTION_HEADER Question;\r
889 UINT8 MinSize;\r
890 UINT8 MaxSize;\r
891 UINT8 Flags;\r
892} EFI_IFR_STRING;\r
893\r
894#define EFI_IFR_STRING_MULTI_LINE 0x01\r
895\r
896typedef struct _EFI_IFR_PASSWORD {\r
897 EFI_IFR_OP_HEADER Header;\r
898 EFI_IFR_QUESTION_HEADER Question;\r
899 UINT16 MinSize;\r
900 UINT16 MaxSize;\r
901} EFI_IFR_PASSWORD;\r
902\r
903typedef struct _EFI_IFR_ORDERED_LIST {\r
904 EFI_IFR_OP_HEADER Header;\r
905 EFI_IFR_QUESTION_HEADER Question;\r
906 UINT8 MaxContainers;\r
907 UINT8 Flags;\r
908} EFI_IFR_ORDERED_LIST;\r
909\r
910#define EFI_IFR_UNIQUE_SET 0x01\r
911#define EFI_IFR_NO_EMPTY_SET 0x02\r
912\r
913typedef struct _EFI_IFR_TIME {\r
914 EFI_IFR_OP_HEADER Header;\r
915 EFI_IFR_QUESTION_HEADER Question;\r
916 UINT8 Flags;\r
917} EFI_IFR_TIME;\r
918\r
919#define QF_TIME_HOUR_SUPPRESS 0x01\r
920#define QF_TIME_MINUTE_SUPPRESS 0x02\r
921#define QF_TIME_SECOND_SUPPRESS 0x04\r
922\r
923#define QF_TIME_STORAGE 0x30\r
924#define QF_TIME_STORAGE_NORMAL 0x00\r
925#define QF_TIME_STORAGE_TIME 0x10\r
926#define QF_TIME_STORAGE_WAKEUP 0x20\r
927\r
928typedef struct _EFI_IFR_DISABLE_IF {\r
929 EFI_IFR_OP_HEADER Header;\r
930} EFI_IFR_DISABLE_IF;\r
931\r
932typedef struct _EFI_IFR_SUPPRESS_IF {\r
933 EFI_IFR_OP_HEADER Header;\r
934} EFI_IFR_SUPPRESS_IF;\r
935\r
936typedef struct _EFI_IFR_GRAY_OUT_IF {\r
937 EFI_IFR_OP_HEADER Header;\r
938} EFI_IFR_GRAY_OUT_IF;\r
939\r
940typedef struct _EFI_IFR_INCONSISTENT_IF {\r
941 EFI_IFR_OP_HEADER Header;\r
942 EFI_STRING_ID Error;\r
943} EFI_IFR_INCONSISTENT_IF;\r
944\r
945typedef struct _EFI_IFR_NO_SUBMIT_IF {\r
946 EFI_IFR_OP_HEADER Header;\r
947 EFI_STRING_ID Error;\r
948} EFI_IFR_NO_SUBMIT_IF;\r
949\r
950typedef struct _EFI_IFR_REFRESH {\r
951 EFI_IFR_OP_HEADER Header;\r
952 UINT8 RefreshInterval;\r
953} EFI_IFR_REFRESH;\r
954\r
955typedef struct _EFI_IFR_VARSTORE_DEVICE {\r
956 EFI_IFR_OP_HEADER Header;\r
957 EFI_STRING_ID DevicePath;\r
958} EFI_IFR_VARSTORE_DEVICE;\r
959\r
960typedef struct _EFI_IFR_ONE_OF_OPTION {\r
961 EFI_IFR_OP_HEADER Header;\r
962 EFI_STRING_ID Option;\r
963 UINT8 Flags;\r
964 UINT8 Type;\r
965 EFI_IFR_TYPE_VALUE Value;\r
966} EFI_IFR_ONE_OF_OPTION;\r
967\r
968#define EFI_IFR_TYPE_NUM_SIZE_8 0x00\r
969#define EFI_IFR_TYPE_NUM_SIZE_16 0x01\r
970#define EFI_IFR_TYPE_NUM_SIZE_32 0x02\r
971#define EFI_IFR_TYPE_NUM_SIZE_64 0x03\r
972#define EFI_IFR_TYPE_BOOLEAN 0x04\r
973#define EFI_IFR_TYPE_TIME 0x05\r
974#define EFI_IFR_TYPE_DATE 0x06\r
975#define EFI_IFR_TYPE_STRING 0x07\r
976#define EFI_IFR_TYPE_OTHER 0x08\r
977\r
978#define EFI_IFR_OPTION_DEFAULT 0x10\r
979#define EFI_IFR_OPTION_DEFAULT_MFG 0x20\r
980\r
981typedef struct _EFI_IFR_GUID {\r
982 EFI_IFR_OP_HEADER Header;\r
983 EFI_GUID Guid;\r
984 //Optional Data Follows\r
985} EFI_IFR_GUID;\r
986\r
987typedef struct _EFI_IFR_DUP {\r
988 EFI_IFR_OP_HEADER Header;\r
989} EFI_IFR_DUP;\r
990\r
991typedef struct _EFI_IFR_EQ_ID_ID {\r
992 EFI_IFR_OP_HEADER Header;\r
993 EFI_QUESTION_ID QuestionId1;\r
994 EFI_QUESTION_ID QuestionId2;\r
995} EFI_IFR_EQ_ID_ID;\r
996\r
997typedef struct _EFI_IFR_EQ_ID_VAL {\r
998 EFI_IFR_OP_HEADER Header;\r
999 EFI_QUESTION_ID QuestionId;\r
1000 UINT16 Value;\r
1001} EFI_IFR_EQ_ID_VAL;\r
1002\r
1003typedef struct _EFI_IFR_EQ_ID_LIST {\r
1004 EFI_IFR_OP_HEADER Header;\r
1005 EFI_QUESTION_ID QuestionId;\r
1006 UINT16 ListLength;\r
1007 UINT16 ValueList[1];\r
1008} EFI_IFR_EQ_ID_LIST;\r
1009\r
1010typedef struct _EFI_IFR_QUESTION_REF1 {\r
1011 EFI_IFR_OP_HEADER Header;\r
1012 EFI_QUESTION_ID QuestionId;\r
1013} EFI_IFR_QUESTION_REF1;\r
1014\r
1015typedef struct _EFI_IFR_UINT8 {\r
1016 EFI_IFR_OP_HEADER Header;\r
1017 UINT8 Value;\r
1018} EFI_IFR_UINT8;\r
1019\r
1020typedef struct _EFI_IFR_UINT16 {\r
1021 EFI_IFR_OP_HEADER Header;\r
1022 UINT16 Value;\r
1023} EFI_IFR_UINT16;\r
1024\r
1025typedef struct _EFI_IFR_QUESTION_REF2 {\r
1026 EFI_IFR_OP_HEADER Header;\r
1027} EFI_IFR_QUESTION_REF2;\r
1028\r
1029typedef struct _EFI_IFR_UINT32 {\r
1030 EFI_IFR_OP_HEADER Header;\r
1031 UINT32 Value;\r
1032} EFI_IFR_UINT32;\r
1033\r
1034typedef struct _EFI_IFR_UINT64 {\r
1035 EFI_IFR_OP_HEADER Header;\r
1036 UINT64 Value;\r
1037} EFI_IFR_UINT64;\r
1038\r
1039typedef struct _EFI_IFR_QUESTION_REF3 {\r
1040 EFI_IFR_OP_HEADER Header;\r
1041} EFI_IFR_QUESTION_REF3;\r
1042\r
1043typedef struct _EFI_IFR_QUESTION_REF3_2 {\r
1044 EFI_IFR_OP_HEADER Header;\r
1045 EFI_STRING_ID DevicePath;\r
1046} EFI_IFR_QUESTION_REF3_2;\r
1047\r
1048typedef struct _EFI_IFR_QUESTION_REF3_3 {\r
1049 EFI_IFR_OP_HEADER Header;\r
1050 EFI_STRING_ID DevicePath;\r
1051 EFI_GUID Guid;\r
1052} EFI_IFR_QUESTION_REF3_3;\r
1053\r
1054typedef struct _EFI_IFR_RULE_REF {\r
1055 EFI_IFR_OP_HEADER Header;\r
1056 UINT8 RuleId;\r
1057} EFI_IFR_RULE_REF;\r
1058\r
1059typedef struct _EFI_IFR_STRING_REF1 {\r
1060 EFI_IFR_OP_HEADER Header;\r
1061 EFI_STRING_ID StringId;\r
1062} EFI_IFR_STRING_REF1;\r
1063\r
1064typedef struct _EFI_IFR_STRING_REF2 {\r
1065 EFI_IFR_OP_HEADER Header;\r
1066} EFI_IFR_STRING_REF2;\r
1067\r
1068typedef struct _EFI_IFR_THIS {\r
1069 EFI_IFR_OP_HEADER Header;\r
1070} EFI_IFR_THIS;\r
1071\r
1072typedef struct _EFI_IFR_TRUE {\r
1073 EFI_IFR_OP_HEADER Header;\r
1074} EFI_IFR_TRUE;\r
1075\r
1076typedef struct _EFI_IFR_FALSE {\r
1077 EFI_IFR_OP_HEADER Header;\r
1078} EFI_IFR_FALSE;\r
1079\r
1080typedef struct _EFI_IFR_ONE {\r
1081 EFI_IFR_OP_HEADER Header;\r
1082} EFI_IFR_ONE;\r
1083\r
1084typedef struct _EFI_IFR_ONES {\r
1085 EFI_IFR_OP_HEADER Header;\r
1086} EFI_IFR_ONES;\r
1087\r
1088typedef struct _EFI_IFR_ZERO {\r
1089 EFI_IFR_OP_HEADER Header;\r
1090} EFI_IFR_ZERO;\r
1091\r
1092typedef struct _EFI_IFR_UNDEFINED {\r
1093 EFI_IFR_OP_HEADER Header;\r
1094} EFI_IFR_UNDEFINED;\r
1095\r
1096typedef struct _EFI_IFR_VERSION {\r
1097 EFI_IFR_OP_HEADER Header;\r
1098} EFI_IFR_VERSION;\r
1099\r
1100typedef struct _EFI_IFR_LENGTH {\r
1101 EFI_IFR_OP_HEADER Header;\r
1102} EFI_IFR_LENGTH;\r
1103\r
1104typedef struct _EFI_IFR_NOT {\r
1105 EFI_IFR_OP_HEADER Header;\r
1106} EFI_IFR_NOT;\r
1107\r
1108typedef struct _EFI_IFR_BITWISE_NOT {\r
1109 EFI_IFR_OP_HEADER Header;\r
1110} EFI_IFR_BITWISE_NOT;\r
1111\r
1112typedef struct _EFI_IFR_TO_BOOLEAN {\r
1113 EFI_IFR_OP_HEADER Header;\r
1114} EFI_IFR_TO_BOOLEAN;\r
1115\r
1116#define EFI_IFR_STRING_UNSIGNED_DEC 0\r
1117#define EFI_IFR_STRING_SIGNED_DEC 1\r
1118#define EFI_IFR_STRING_LOWERCASE_HEX 2\r
1119#define EFI_IFR_STRING_UPPERCASE_HEX 3\r
1120\r
1121#define EFI_IFR_STRING_ASCII 0\r
1122#define EFI_IFR_STRING_UNICODE 8\r
1123\r
1124typedef struct _EFI_IFR_TO_STRING {\r
1125 EFI_IFR_OP_HEADER Header;\r
1126 UINT8 Format;\r
1127} EFI_IFR_TO_STRING;\r
1128\r
1129typedef struct _EFI_IFR_TO_UINT {\r
1130 EFI_IFR_OP_HEADER Header;\r
1131} EFI_IFR_TO_UINT;\r
1132\r
1133typedef struct _EFI_IFR_TO_UPPER {\r
1134 EFI_IFR_OP_HEADER Header;\r
1135} EFI_IFR_TO_UPPER;\r
1136\r
1137typedef struct _EFI_IFR_TO_LOWER {\r
1138 EFI_IFR_OP_HEADER Header;\r
1139} EFI_IFR_TO_LOWER;\r
1140\r
1141typedef struct _EFI_IFR_ADD {\r
1142 EFI_IFR_OP_HEADER Header;\r
1143} EFI_IFR_ADD;\r
1144\r
1145typedef struct _EFI_IFR_AND {\r
1146 EFI_IFR_OP_HEADER Header;\r
1147} EFI_IFR_AND;\r
1148\r
1149typedef struct _EFI_IFR_BITWISE_AND {\r
1150 EFI_IFR_OP_HEADER Header;\r
1151} EFI_IFR_BITWISE_AND;\r
1152\r
1153typedef struct _EFI_IFR_BITWISE_OR {\r
1154 EFI_IFR_OP_HEADER Header;\r
1155} EFI_IFR_BITWISE_OR;\r
1156\r
1157typedef struct _EFI_IFR_CATENATE {\r
1158 EFI_IFR_OP_HEADER Header;\r
1159} EFI_IFR_CATENATE;\r
1160\r
1161typedef struct _EFI_IFR_DIVIDE {\r
1162 EFI_IFR_OP_HEADER Header;\r
1163} EFI_IFR_DIVIDE;\r
1164\r
1165typedef struct _EFI_IFR_EQUAL {\r
1166 EFI_IFR_OP_HEADER Header;\r
1167} EFI_IFR_EQUAL;\r
1168\r
1169typedef struct _EFI_IFR_GREATER_EQUAL {\r
1170 EFI_IFR_OP_HEADER Header;\r
1171} EFI_IFR_GREATER_EQUAL;\r
1172\r
1173typedef struct _EFI_IFR_GREATER_THAN {\r
1174 EFI_IFR_OP_HEADER Header;\r
1175} EFI_IFR_GREATER_THAN;\r
1176\r
1177typedef struct _EFI_IFR_LESS_EQUAL {\r
1178 EFI_IFR_OP_HEADER Header;\r
1179} EFI_IFR_LESS_EQUAL;\r
1180\r
1181typedef struct _EFI_IFR_LESS_THAN {\r
1182 EFI_IFR_OP_HEADER Header;\r
1183} EFI_IFR_LESS_THAN;\r
1184\r
1185typedef struct _EFI_IFR_MATCH {\r
1186 EFI_IFR_OP_HEADER Header;\r
1187} EFI_IFR_MATCH;\r
1188\r
1189typedef struct _EFI_IFR_MULTIPLY {\r
1190 EFI_IFR_OP_HEADER Header;\r
1191} EFI_IFR_MULTIPLY;\r
1192\r
1193typedef struct _EFI_IFR_MODULO {\r
1194 EFI_IFR_OP_HEADER Header;\r
1195} EFI_IFR_MODULO;\r
1196\r
1197typedef struct _EFI_IFR_NOT_EQUAL {\r
1198 EFI_IFR_OP_HEADER Header;\r
1199} EFI_IFR_NOT_EQUAL;\r
1200\r
1201typedef struct _EFI_IFR_OR {\r
1202 EFI_IFR_OP_HEADER Header;\r
1203} EFI_IFR_OR;\r
1204\r
1205typedef struct _EFI_IFR_SHIFT_LEFT {\r
1206 EFI_IFR_OP_HEADER Header;\r
1207} EFI_IFR_SHIFT_LEFT;\r
1208\r
1209typedef struct _EFI_IFR_SHIFT_RIGHT {\r
1210 EFI_IFR_OP_HEADER Header;\r
1211} EFI_IFR_SHIFT_RIGHT;\r
1212\r
1213typedef struct _EFI_IFR_SUBTRACT {\r
1214 EFI_IFR_OP_HEADER Header;\r
1215} EFI_IFR_SUBTRACT;\r
1216\r
1217typedef struct _EFI_IFR_CONDITIONAL {\r
1218 EFI_IFR_OP_HEADER Header;\r
1219} EFI_IFR_CONDITIONAL;\r
1220\r
1221#define EFI_IFR_FF_CASE_SENSITIVE 0x00\r
1222#define EFI_IFR_FF_CASE_INSENSITIVE 0x01\r
1223\r
1224typedef struct _EFI_IFR_FIND {\r
1225 EFI_IFR_OP_HEADER Header;\r
1226 UINT8 Format;\r
1227} EFI_IFR_FIND;\r
1228\r
1229typedef struct _EFI_IFR_MID {\r
1230 EFI_IFR_OP_HEADER Header;\r
1231} EFI_IFR_MID;\r
1232\r
1233typedef struct _EFI_IFR_TOKEN {\r
1234 EFI_IFR_OP_HEADER Header;\r
1235} EFI_IFR_TOKEN;\r
1236\r
1237#define EFI_IFR_FLAGS_FIRST_MATCHING 0x00\r
1238#define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01\r
1239\r
1240typedef struct _EFI_IFR_SPAN {\r
1241 EFI_IFR_OP_HEADER Header;\r
1242 UINT8 Flags;\r
1243} EFI_IFR_SPAN;\r
1244\r
1245//\r
1246// Keyboard Package\r
1247//\r
1248\r
1249typedef enum { \r
1250 EfiKeyLCtrl,\r
1251 EfiKeyA0, \r
1252 EfiKeyLAlt,\r
1253 EfiKeySpaceBar,\r
1254 EfiKeyA2,\r
1255 EfiKeyA3,\r
1256 EfiKeyA4,\r
1257 EfiKeyRCtrl,\r
1258 EfiKeyLeftArrow,\r
1259 EfiKeyDownArrow,\r
1260 EfiKeyRightArrow,\r
1261 EfiKeyZero,\r
1262 EfiKeyPeriod,\r
1263 EfiKeyEnter,\r
1264 EfiKeyLShift,\r
1265 EfiKeyB0,\r
1266 EfiKeyB1,\r
1267 EfiKeyB2,\r
1268 EfiKeyB3,\r
1269 EfiKeyB4,\r
1270 EfiKeyB5,\r
1271 EfiKeyB6,\r
1272 EfiKeyB7,\r
1273 EfiKeyB8,\r
1274 EfiKeyB9,\r
1275 EfiKeyB10,\r
1276 EfiKeyRshift,\r
1277 EfiKeyUpArrow,\r
1278 EfiKeyOne,\r
1279 EfiKeyTwo,\r
1280 EfiKeyThree,\r
1281 EfiKeyCapsLock,\r
1282 EfiKeyC1,\r
1283 EfiKeyC2,\r
1284 EfiKeyC3,\r
1285 EfiKeyC4,\r
1286 EfiKeyC5,\r
1287 EfiKeyC6,\r
1288 EfiKeyC7,\r
1289 EfiKeyC8,\r
1290 EfiKeyC9,\r
1291 EfiKeyC10,\r
1292 EfiKeyC11,\r
1293 EfiKeyC12,\r
1294 EfiKeyFour,\r
1295 EfiKeyFive,\r
1296 EfiKeySix,\r
1297 EfiKeyPlus,\r
1298 EfiKeyTab,\r
1299 EfiKeyD1,\r
1300 EfiKeyD2,\r
1301 EfiKeyD3,\r
1302 EfiKeyD4,\r
1303 EfiKeyD5,\r
1304 EfiKeyD6,\r
1305 EfiKeyD7,\r
1306 EfiKeyD8,\r
1307 EfiKeyD9,\r
1308 EfiKeyD10,\r
1309 EfiKeyD11,\r
1310 EfiKeyD12,\r
1311 EfiKeyD13,\r
1312 EfiKeyDel,\r
1313 EfiKeyEnd,\r
1314 EfiKeyPgDn,\r
1315 EfiKeySeven,\r
1316 EfiKeyEight,\r
1317 EfiKeyNine,\r
1318 EfiKeyE0,\r
1319 EfiKeyE1,\r
1320 EfiKeyE2,\r
1321 EfiKeyE3,\r
1322 EfiKeyE4,\r
1323 EfiKeyE5,\r
1324 EfiKeyE6,\r
1325 EfiKeyE7,\r
1326 EfiKeyE8,\r
1327 EfiKeyE9,\r
1328 EfiKeyE10,\r
1329 EfiKeyE11,\r
1330 EfiKeyE12,\r
1331 EfiKeyBackSpace,\r
1332 EfiKeyIns,\r
1333 EfiKeyHome,\r
1334 EfiKeyPgUp,\r
1335 EfiKeyNLck,\r
1336 EfiKeySlash,\r
1337 EfiKeyAsterisk,\r
1338 EfiKeyMinus,\r
1339 EfiKeyEsc,\r
1340 EfiKeyF1,\r
1341 EfiKeyF2,\r
1342 EfiKeyF3,\r
1343 EfiKeyF4,\r
1344 EfiKeyF5,\r
1345 EfiKeyF6,\r
1346 EfiKeyF7,\r
1347 EfiKeyF8,\r
1348 EfiKeyF9,\r
1349 EfiKeyF10,\r
1350 EfiKeyF11,\r
1351 EfiKeyF12,\r
1352 EfiKeyPrint,\r
1353 EfiKeySLck,\r
1354 EfiKeyPause\r
1355} EFI_KEY;\r
1356\r
1357typedef struct {\r
1358 EFI_KEY Key;\r
1359 CHAR16 Unicode;\r
1360 CHAR16 ShiftedUnicode;\r
1361 CHAR16 AltGrUnicode;\r
1362 CHAR16 ShiftedAltGrUnicode;\r
1363 UINT16 Modifier;\r
1364 UINT16 AffectedAttribute;\r
1365} EFI_KEY_DESCRIPTOR;\r
1366\r
1367//\r
1368// A key which is affected by all the standard shift modifiers. \r
1369// Most keys would be expected to have this bit active.\r
1370//\r
1371#define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001\r
1372//\r
1373// This key is affected by the caps lock so that if a keyboard driver\r
fd0d281b 1374// would need to disambiguate between a key which had a "1" defined\r
1375// versus a "a" character. Having this bit turned on would tell\r
2c40a813 1376// the keyboard driver to use the appropriate shifted state or not.\r
1377//\r
1378#define EFI_AFFECTED_BY_CAPS_LOCK 0x0002\r
1379//\r
1380// Similar to the case of CAPS lock, if this bit is active, the key\r
1381// is affected by the num lock being turned on.\r
1382//\r
1383#define EFI_AFFECTED_BY_NUM_LOCK 0x0004\r
1384\r
1385typedef struct {\r
1386 UINT16 LayoutLength;\r
1387 EFI_GUID Guid;\r
1388 UINT32 LayoutDescriptorStringOffset;\r
1389 UINT8 DescriptorCount;\r
1390 // EFI_KEY_DESCRIPTOR Descriptors[];\r
1391} EFI_HII_KEYBOARD_LAYOUT;\r
1392\r
1393typedef struct {\r
1394 EFI_HII_PACKAGE_HEADER Header;\r
1395 UINT16 LayoutCount;\r
1396 // EFI_HII_KEYBOARD_LAYOUT Layout[];\r
1397} EFI_HII_KEYBOARD_PACKAGE_HDR;\r
1398\r
1399typedef struct {\r
1400 CHAR16 Language[3];\r
1401 CHAR16 Space;\r
1402 CHAR16 DescriptionString[1];\r
1403} EFI_DESCRIPTION_STRING;\r
1404\r
1405typedef struct {\r
1406 UINT16 DescriptionCount;\r
1407 EFI_DESCRIPTION_STRING DescriptionString[1];\r
1408} EFI_DESCRIPTION_STRING_BUNDLE;\r
1409\r
1410//\r
1411// Modifier values\r
1412//\r
1413#define EFI_NULL_MODIFIER 0x0000\r
1414#define EFI_LEFT_CONTROL_MODIFIER 0x0001\r
1415#define EFI_RIGHT_CONTROL_MODIFIER 0x0002\r
1416#define EFI_LEFT_ALT_MODIFIER 0x0003\r
1417#define EFI_RIGHT_ALT_MODIFIER 0x0004\r
1418#define EFI_ALT_GR_MODIFIER 0x0005\r
1419#define EFI_INSERT_MODIFIER 0x0006\r
1420#define EFI_DELETE_MODIFIER 0x0007\r
1421#define EFI_PAGE_DOWN_MODIFIER 0x0008\r
1422#define EFI_PAGE_UP_MODIFIER 0x0009\r
1423#define EFI_HOME_MODIFIER 0x000A\r
1424#define EFI_END_MODIFIER 0x000B\r
1425#define EFI_LEFT_SHIFT_MODIFIER 0x000C\r
1426#define EFI_RIGHT_SHIFT_MODIFIER 0x000D\r
1427#define EFI_CAPS_LOCK_MODIFIER 0x000E\r
1428#define EFI_NUM_LOCK _MODIFIER 0x000F\r
1429#define EFI_LEFT_ARROW_MODIFIER 0x0010\r
1430#define EFI_RIGHT_ARROW_MODIFIER 0x0011\r
1431#define EFI_DOWN_ARROW_MODIFIER 0x0012\r
1432#define EFI_UP_ARROW_MODIFIER 0x0013\r
1433#define EFI_NS_KEY_MODIFIER 0x0014\r
1434#define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015\r
1435#define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016\r
1436#define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017\r
1437#define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018\r
1438#define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019\r
1439#define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A\r
1440#define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B\r
1441#define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C\r
1442#define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D\r
1443#define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E\r
1444#define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F\r
1445#define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020\r
1446#define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021\r
1447\r
1448//\r
1449// Keys that have multiple control functions based on modifier\r
1450// settings are handled in the keyboard driver implementation.\r
1451// For instance PRINT_KEY might have a modifier held down and\r
1452// is still a nonprinting character, but might have an alternate\r
1453// control function like SYSREQUEST\r
1454//\r
1455#define EFI_PRINT_MODIFIER 0x0022\r
1456#define EFI_SYS_REQUEST_MODIFIER 0x0023\r
1457#define EFI_SCROLL_LOCK_MODIFIER 0x0024\r
1458#define EFI_PAUSE_MODIFIER 0x0025\r
1459#define EFI_BREAK_MODIFIER 0x0026\r
1460\r
1461#pragma pack()\r
1462\r
1463#endif\r
EFI Development Kit II mirror for PVE