1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Ui.h
Abstract:
Head file UI
Revision History
--*/
#ifndef _UI_H
#define _UI_H
//
// Globals
//
#define REGULAR_NUMERIC 0
#define TIME_NUMERIC 1
#define DATE_NUMERIC 2
typedef enum {
UiNoOperation,
UiDefault,
UiSelect,
UiUp,
UiDown,
UiLeft,
UiRight,
UiReset,
UiSave,
UiPrevious,
UiPageUp,
UiPageDown,
UiMaxOperation
} UI_SCREEN_OPERATION;
typedef enum {
CfInitialization,
CfCheckSelection,
CfRepaint,
CfRefreshHighLight,
CfUpdateHelpString,
CfPrepareToReadKey,
CfReadKey,
CfScreenOperation,
CfUiPrevious,
CfUiSelect,
CfUiReset,
CfUiLeft,
CfUiRight,
CfUiUp,
CfUiPageUp,
CfUiPageDown,
CfUiDown,
CfUiSave,
CfUiDefault,
CfUiNoOperation,
CfExit,
CfMaxControlFlag
} UI_CONTROL_FLAG;
#define UI_MENU_OPTION_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'm')
#define UI_MENU_LIST_SIGNATURE EFI_SIGNATURE_32 ('u', 'i', 'm', 'l')
typedef struct {
UINTN Signature;
LIST_ENTRY Link;
UINTN Row;
UINTN Col;
UINTN OptCol;
CHAR16 *Description;
UINTN Skip;
UINTN IfrNumber;
VOID *FormBinary;
EFI_HII_HANDLE Handle;
EFI_TAG *Tags;
UINTN TagIndex;
EFI_TAG *ThisTag;
UINT16 FormId;
BOOLEAN Previous;
UINT16 EntryNumber;
UINT16 Consistency;
BOOLEAN GrayOut;
} UI_MENU_OPTION;
typedef struct {
UINTN Signature;
LIST_ENTRY MenuLink;
UI_MENU_OPTION Selection;
UINTN FormerEntryNumber;
} UI_MENU_LIST;
typedef struct _MENU_REFRESH_ENTRY {
struct _MENU_REFRESH_ENTRY *Next;
EFI_FILE_FORM_TAGS *FileFormTagsHead;
UINTN CurrentColumn;
UINTN CurrentRow;
UINTN CurrentAttribute;
UI_MENU_OPTION *MenuOption; // Describes the entry needing an update
} MENU_REFRESH_ENTRY;
typedef struct {
UINT16 ScanCode;
UI_SCREEN_OPERATION ScreenOperation;
} SCAN_CODE_TO_SCREEN_OPERATION;
typedef struct {
UI_SCREEN_OPERATION ScreenOperation;
UI_CONTROL_FLAG ControlFlag;
} SCREEN_OPERATION_T0_CONTROL_FLAG;
LIST_ENTRY Menu;
LIST_ENTRY gMenuList;
MENU_REFRESH_ENTRY *gMenuRefreshHead;
INTN gEntryNumber;
BOOLEAN gLastOpr;
//
// Global Functions
//
VOID
UiInitMenu (
VOID
)
;
VOID
UiInitMenuList (
VOID
)
;
VOID
UiRemoveMenuListEntry (
IN UI_MENU_OPTION *Selection,
OUT UI_MENU_OPTION **PreviousSelection
)
;
VOID
UiFreeMenuList (
VOID
)
;
VOID
UiAddMenuListEntry (
IN UI_MENU_OPTION *Selection
)
;
VOID
UiFreeMenu (
VOID
)
;
VOID
UiAddMenuOption (
IN CHAR16 *String,
IN EFI_HII_HANDLE Handle,
IN EFI_TAG *Tag,
IN VOID *FormBinary,
IN UINTN IfrNumber
)
;
VOID
UiAddSubMenuOption (
IN CHAR16 *String,
IN EFI_HII_HANDLE Handle,
IN EFI_TAG *Tag,
IN UINTN TagIndex,
IN UINT16 FormId,
IN UINT16 MenuItemCount
)
;
UI_MENU_OPTION *
UiDisplayMenu (
IN BOOLEAN SubMenu,
IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
OUT EFI_IFR_DATA_ARRAY *PageData
)
;
VOID
InitPage (
VOID
)
;
UI_MENU_OPTION *
SetupBrowser (
IN UI_MENU_OPTION *Selection,
IN BOOLEAN Callback,
IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
IN UINT8 *CallbackData
)
;
VOID
SetUnicodeMem (
IN VOID *Buffer,
IN UINTN Size,
IN CHAR16 Value
)
;
EFI_STATUS
UiWaitForSingleEvent (
IN EFI_EVENT Event,
IN UINT64 Timeout OPTIONAL
)
;
VOID
CreatePopUp (
IN UINTN ScreenWidth,
IN UINTN NumberOfLines,
IN CHAR16 *ArrayOfStrings,
...
)
;
EFI_STATUS
ReadString (
IN UI_MENU_OPTION *MenuOption,
OUT CHAR16 *StringPtr
)
;
EFI_STATUS
ReadPassword (
IN UI_MENU_OPTION *MenuOption,
IN BOOLEAN PromptForPassword,
IN EFI_TAG *Tag,
IN EFI_IFR_DATA_ARRAY *PageData,
IN BOOLEAN SecondEntry,
IN EFI_FILE_FORM_TAGS *FileFormTags,
OUT CHAR16 *StringPtr
)
;
VOID
EncodePassword (
IN CHAR16 *Password,
IN UINT8 MaxSize
)
;
EFI_STATUS
GetSelectionInputPopUp (
IN UI_MENU_OPTION *MenuOption,
IN EFI_TAG *Tag,
IN UINTN ValueCount,
OUT UINT16 *Value,
OUT UINT16 *KeyValue
)
;
EFI_STATUS
GetSelectionInputLeftRight (
IN UI_MENU_OPTION *MenuOption,
IN EFI_TAG *Tag,
IN UINTN ValueCount,
OUT UINT16 *Value
)
;
EFI_STATUS
GetNumericInput (
IN UI_MENU_OPTION *MenuOption,
IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
IN BOOLEAN ManualInput,
IN EFI_TAG *Tag,
IN UINTN NumericType,
OUT UINT16 *Value
)
;
VOID
UpdateStatusBar (
IN UINTN MessageType,
IN UINT8 Flags,
IN BOOLEAN State
)
;
EFI_STATUS
ProcessOptions (
IN UI_MENU_OPTION *MenuOption,
IN BOOLEAN Selected,
IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
IN EFI_IFR_DATA_ARRAY *PageData,
OUT CHAR16 **OptionString
)
;
VOID
ProcessHelpString (
IN CHAR16 *StringPtr,
OUT CHAR16 **FormattedString,
IN UINTN RowCount
)
;
VOID
UpdateKeyHelp (
IN UI_MENU_OPTION *Selection,
IN BOOLEAN Selected
)
;
BOOLEAN
ValueIsNotValid (
IN BOOLEAN Complex,
IN UINT16 Value,
IN EFI_TAG *Tag,
IN EFI_FILE_FORM_TAGS *FileFormTags,
IN STRING_REF *PopUp
)
;
VOID
FreeData (
IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
IN CHAR16 *FormattedString,
IN CHAR16 *OptionString
)
;
VOID
ClearLines (
UINTN LeftColumn,
UINTN RightColumn,
UINTN TopRow,
UINTN BottomRow,
UINTN TextAttribute
)
;
UINTN
GetStringWidth (
CHAR16 *String
)
;
UINT16
GetLineByWidth (
IN CHAR16 *InputString,
IN UINT16 LineWidth,
IN OUT UINTN *Index,
OUT CHAR16 **OutputString
)
;
UINT16
GetWidth (
IN EFI_TAG *Tag,
IN EFI_HII_HANDLE Handle
)
;
VOID
NewStrCat (
CHAR16 *Destination,
CHAR16 *Source
)
;
VOID
IfrToFormTag (
IN UINT8 OpCode,
IN EFI_TAG *TargetTag,
IN VOID *FormData,
EFI_VARIABLE_DEFINITION *VariableDefinitionsHead
)
;
EFI_STATUS
ExtractNvValue (
IN EFI_FILE_FORM_TAGS *FileFormTags,
IN UINT16 VariableId,
IN UINT16 VariableSize,
IN UINT16 OffsetValue,
OUT VOID **Buffer
)
;
EFI_STATUS
ExtractRequestedNvMap (
IN EFI_FILE_FORM_TAGS *FileFormTags,
IN UINT16 VariableId,
OUT EFI_VARIABLE_DEFINITION **VariableDefinition
)
;
BOOLEAN
ValueIsScroll (
IN BOOLEAN Direction,
IN LIST_ENTRY *CurrentPos
)
;
UINTN
AdjustDateAndTimePosition (
IN BOOLEAN DirectionUp,
IN LIST_ENTRY **CurrentPosition
)
;
EFI_STATUS
WaitForKeyStroke (
OUT EFI_INPUT_KEY *Key
)
;
#endif // _UI_H
|
