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