3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
27 // Include common header file for this module.
29 #include "CommonHeader.h"
32 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
34 extern UINT8 SetupBrowserStrings
[];
39 #define BANNER_HEIGHT 4
40 #define BANNER_COLUMNS 3
42 #define FRONT_PAGE_HEADER_HEIGHT 4
43 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
44 #define LEFT_SKIPPED_COLUMNS 4
45 #define FOOTER_HEIGHT 4
46 #define STATUS_BAR_HEIGHT 1
47 #define SCROLL_ARROW_HEIGHT 1
48 #define POPUP_PAD_SPACE_COUNT 5
49 #define POPUP_FRAME_WIDTH 2
52 #define EFI_SETUP_APPLICATION_SUBCLASS 0x00
53 #define EFI_GENERAL_APPLICATION_SUBCLASS 0x01
54 #define EFI_FRONT_PAGE_SUBCLASS 0x02
55 #define EFI_SINGLE_USE_SUBCLASS 0x03 // Used to display a single entity and then exit
57 // Definition for function key setting
59 #define NONE_FUNCTION_KEY_SETTING 0
60 #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_ONE | FUNCTION_TWO | FUNCTION_NINE | FUNCTION_TEN)
62 #define FUNCTION_ONE (1 << 0)
63 #define FUNCTION_TWO (1 << 1)
64 #define FUNCTION_NINE (1 << 2)
65 #define FUNCTION_TEN (1 << 3)
70 } FUNCTIION_KEY_SETTING
;
73 // Character definitions
75 #define CHAR_SPACE 0x0020
76 #define UPPER_LOWER_CASE_OFFSET 0x20
81 #define ONE_SECOND 10000000
84 // Display definitions
86 #define LEFT_HYPER_DELIMITER L'<'
87 #define RIGHT_HYPER_DELIMITER L'>'
89 #define LEFT_ONEOF_DELIMITER L'<'
90 #define RIGHT_ONEOF_DELIMITER L'>'
92 #define LEFT_NUMERIC_DELIMITER L'['
93 #define RIGHT_NUMERIC_DELIMITER L']'
95 #define LEFT_CHECKBOX_DELIMITER L"["
96 #define RIGHT_CHECKBOX_DELIMITER L"]"
99 #define CHECK_OFF L" "
101 #define TIME_SEPARATOR L':'
102 #define DATE_SEPARATOR L'/'
104 #define YES_ANSWER L'Y'
105 #define NO_ANSWER L'N'
108 // Up to how many lines does the ordered list display
110 #define ORDERED_LIST_SIZE 4
113 // This is the Input Error Message
115 #define INPUT_ERROR 1
118 // This is the NV RAM update required Message
120 #define NV_UPDATE_REQUIRED 2
123 // Refresh the Status Bar with flags
125 #define REFRESH_STATUS_BAR 0xff
128 // This width is basically the sum of the prompt and option widths
130 #define QUESTION_BLOCK_WIDTH 50
133 // Width of the Language Description (Using ISO-639-2 3 ASCII letter standard)
135 #define LANG_DESC_WIDTH 3
138 // Maximum Number of Binaries we can see
140 #define MAX_BINARIES 255
145 #define EFI_HII_INVALID_HANDLE 0xFFFF
148 // Invalid Offset Value
150 #define INVALID_OFFSET_VALUE 0xFFFF
153 struct StringPart
*Next
;
154 CHAR8 String
[QUESTION_BLOCK_WIDTH
+ 2];
158 // The tag definition defines the data associated with a tag (an operation
159 // in the IFR lingo). The tag is thus a modified union of all the data
160 // required for tags. The user should be careful to only rely upon information
161 // relevant to that tag as the contents of other fields is undefined.
163 // The intent here is for this to be all of the data associated with a particular tag.
164 // Some of this data is extracted from the IFR and left alone. Other data will be derived
165 // when the page is selected (since that's the first time we really know what language the
166 // page is to be displayed in) and still other data will vary based on the selection.
167 // If you'd like to consider alternatives, let me know. This structure has grown somewhat organically.
168 // It gets a new item stuffed in it when a new item is needed. When I finally decided I needed the
169 // StringPart structure, items got added here, for example.
172 UINT8 Operand
; // The operand (first byte) of the variable length tag.
173 EFI_GUID GuidValue
; // Primarily for FormSet data
174 EFI_PHYSICAL_ADDRESS CallbackHandle
;
177 UINT16 NumberOfLines
; // The number of lines the tag takes up on the page. Adjusted when we display the page as it can change from language to language.
180 UINT16 OptionWidth
; // The option can be wider than the column usually associated with options. This is the width on the last option line
181 STRING_REF Text
; // Used for title, subtitle, prompt, etc. This is the string token associated with the string. This token is language independent.
182 STRING_REF TextTwo
; // Used for title, subtitle, prompt, etc. This is the string token associated with the string. This token is language independent.
183 STRING_REF Help
; // Null means no help Same as above but for languages.
184 UINT16 Consistency
; // Do we need to check this opcode against consistency? If > 0, yes.
186 UINT16 Id2
; // The questions (mainly) have identifiers associated with them. These are filled in from the IFR tags and used by e.g. the RPN calculations. (com1 is set to, versus com2 is set to)
188 // These are the three values that are created to determine where in the variable the data is stored. This should, in general,
189 // be allocated by the build tool. The one major issue is, once storage is allocated for something, it can't be reallocated or we will get a mess.
193 // These are the three values that are created to determine where in the variable the data is stored. This should, in general,
194 // be allocated by the build tool. The one major issue is, once storage is allocated for something, it can't be reallocated or we will get a mess.
198 // These are the three values that are created to determine where in the variable the data is stored. This should, in general,
199 // be allocated by the build tool. The one major issue is, once storage is allocated for something, it can't be reallocated or we will get a mess.
203 // (Default or current)
208 // Used to preserve a value during late consistency checking
216 UINT16 ConsistencyId
;
219 UINT16 Encoding
; // Data from the tags. The first three are used by the numeric input. Encoding is used by the password stuff (a placeholder today - may go away).
220 UINT16
*IntList
; // List of the values possible for a list question
222 // The string is obtained from the string list and formatted into lines and the lines are held in this linked list.
223 // If we have more than a screen's worth of items, we will end up with cases where we have to display the last couple
224 // lines of a tag's string above the currently selected one, or, display a few lines of a tag at the bottom of a screen.
226 struct StringPart
*StringList
;
227 BOOLEAN ResetRequired
; // Primarily used to determine if a reset is required by changing this op-code.
228 UINT16 VariableNumber
; // Used to define which variable the StorageStart will be pertinent for (0-based) For single variable VFR this will always be 0.
230 // Used to define which variable the StorageStart will be pertinent for (0-based) This is used for boolean check of ID versus ID
231 // so that a user can compare the value of one variable.field content versus another variable.field content.
233 UINT16 VariableNumber2
;
236 #define EFI_FORM_DATA_SIGNATURE EFI_SIGNATURE_32 ('F', 'o', 'r', 'm')
241 EFI_HII_PROTOCOL
*Hii
;
242 EFI_FORM_BROWSER_PROTOCOL FormConfig
;
243 } EFI_FORM_CONFIGURATION_DATA
;
245 #define EFI_FORM_DATA_FROM_THIS(a) CR (a, EFI_FORM_CONFIGURATION_DATA, FormConfig, EFI_FORM_DATA_SIGNATURE)
247 typedef struct _EFI_VARIABLE_DEFINITION
{
249 CHAR8
*FakeNvRamMap
; // This is where the storage for NULL devices go (e.g. RTC)
253 UINT16 VariableFakeSize
; // For dynamically created and NULL device options, this is the latest size
254 CHAR16
*VariableName
;
255 struct _EFI_VARIABLE_DEFINITION
*Next
;
256 struct _EFI_VARIABLE_DEFINITION
*Previous
;
257 } EFI_VARIABLE_DEFINITION
;
260 UINT32 Length
; // Length in bytes between beginning of struc and end of Strings
261 CHAR8 LanguageCode
[4]; // ISO-639-2 language code with a null-terminator
262 RELOFST PrintableLanguageName
; // Translated name of the Language, "English"/"Espanol" etc
263 UINT32 Attributes
; // If on, the language is intended to be printed right to left. The default (off) is to print left to right.
264 RELOFST StringsPointers
[1]; // Pointing to string offset from beginning of String Binary
265 EFI_STRING Strings
[1]; // Array of String Entries. Note the number of entries for Strings and StringsPointers will be the same
269 // This encapsulates all the pointers associated with found IFR binaries
271 typedef struct _EFI_IFR_BINARY
{
272 struct _EFI_IFR_BINARY
*Next
;
273 VOID
*IfrPackage
; // Handy for use in freeing the data later since this is the header of the buffer
275 EFI_HII_HANDLE Handle
;
276 STRING_REF TitleToken
;
277 BOOLEAN UnRegisterOnExit
;
281 // This encapsulates all the questions (tags) for a particular Form Set
283 typedef struct _EFI_FORM_TAGS
{
284 struct _EFI_FORM_TAGS
*Next
;
289 // This is the database of all inconsistency data. Each op-code associated
290 // with inconsistency will be tracked here. This optimizes the search requirement
291 // since we will back mark the main tag structure with the op-codes that have reference
292 // to inconsistency data. This way when parsing the main tag structure and encountering
293 // the inconsistency mark - we can search this database to know what the inconsistency
294 // parameters are for that entry.
296 typedef struct _EFI_INCONSISTENCY_DATA
{
297 struct _EFI_INCONSISTENCY_DATA
*Next
;
298 struct _EFI_INCONSISTENCY_DATA
*Previous
;
305 UINT16 ConsistencyId
;
307 UINT16 VariableNumber
;
308 UINT16 VariableNumber2
;
310 } EFI_INCONSISTENCY_DATA
;
313 // Encapsulating all found Tag information from all sources
314 // Each encapsulation also contains the NvRamMap buffer and the Size of the NV store
316 typedef struct _EFI_FILE_FORM_TAGS
{
317 struct _EFI_FILE_FORM_TAGS
*NextFile
;
318 EFI_INCONSISTENCY_DATA
*InconsistentTags
;
319 EFI_VARIABLE_DEFINITION
*VariableDefinitions
;
320 EFI_FORM_TAGS FormTags
;
321 } EFI_FILE_FORM_TAGS
;
324 STRING_REF Banner
[BANNER_HEIGHT
][BANNER_COLUMNS
];
328 // Head of the Binary structures
330 EFI_IFR_BINARY
*gBinaryDataHead
;
333 // The IFR binary that the user chose to run
337 EFI_HII_PROTOCOL
*Hii
;
340 BANNER_DATA
*BannerData
;
341 EFI_HII_HANDLE FrontPageHandle
;
342 STRING_REF FrontPageTimeOutTitle
;
343 INT16 FrontPageTimeOutValue
;
345 UINTN gFunctionKeySetting
;
346 BOOLEAN gResetRequired
;
347 BOOLEAN gExitRequired
;
348 BOOLEAN gSaveRequired
;
349 BOOLEAN gNvUpdateRequired
;
350 UINT16 gConsistencyId
;
351 UINTN gPriorMenuEntry
;
352 EFI_HII_HANDLE gHiiHandle
;
354 VOID
*gPreviousValue
;
356 EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
359 BOOLEAN gTimeOnScreen
;
360 BOOLEAN gDateOnScreen
;
363 // Browser Global Strings
365 CHAR16
*gFunctionOneString
;
366 CHAR16
*gFunctionTwoString
;
367 CHAR16
*gFunctionNineString
;
368 CHAR16
*gFunctionTenString
;
369 CHAR16
*gEnterString
;
370 CHAR16
*gEnterCommitString
;
371 CHAR16
*gEscapeString
;
372 CHAR16
*gMoveHighlight
;
373 CHAR16
*gMakeSelection
;
374 CHAR16
*gNumericInput
;
375 CHAR16
*gToggleCheckBox
;
376 CHAR16
*gPromptForPassword
;
377 CHAR16
*gPromptForNewPassword
;
378 CHAR16
*gConfirmPassword
;
379 CHAR16
*gConfirmError
;
381 CHAR16
*gEmptyString
;
383 CHAR16
*gYesResponse
;
387 CHAR16
*gMinusString
;
388 CHAR16
*gAdjustNumber
;
390 CHAR16 gPromptBlockWidth
;
391 CHAR16 gOptionBlockWidth
;
392 CHAR16 gHelpBlockWidth
;
395 // Global Procedure Defines
398 InitializeBrowserStrings (
455 IN STRING_REF IfrBinaryTitle
,
456 IN EFI_HII_HANDLE HiiHandle
462 IN UINT8
*RawFormSet
,
463 IN OUT UINT16
*NumberOfTags
470 IN UINT8
*RawFormSet
,
472 IN UINT16 NumberOfLines
,
473 IN EFI_FILE_FORM_TAGS
*FileFormTags
,
474 IN UINT16 CurrentVariable
481 IN UINT8
*RawFormSet
,
483 IN EFI_FILE_FORM_TAGS
*FileFormTags
,
484 IN UINT16 CurrentVariable
490 IN UINTN RequestedWidth
,
491 IN UINTN NumberOfLines
,
492 IN CHAR16
**ArrayOfStrings
498 IN UINTN NumberOfLines
,
500 IN UINTN MaximumStringSize
,
501 OUT CHAR16
*StringBuffer
,
502 OUT EFI_INPUT_KEY
*KeyValue
,