projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 7936fb6a | 1 | /** @file\r |
| d66e6c16 | 2 | Private MACRO, structure and function definitions for Setup Browser module.\r |
| 7936fb6a | 3 | \r |
| e55e1d13 | 4 | Copyright (c) 2007 - 2010, Intel Corporation\r |
| 7936fb6a | 5 | All rights reserved. This program and the accompanying materials\r |
| 6 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 7 | which accompanies this distribution. The full text of the license may be found at\r | |
| 8 | http://opensource.org/licenses/bsd-license.php\r | |
| 9 | \r | |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 12 | \r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef _SETUP_H_\r | |
| 17 | #define _SETUP_H_\r | |
| 18 | \r | |
| 19 | \r | |
| 39099938 | 20 | #include <PiDxe.h>\r |
| 7936fb6a | 21 | \r |
| 7936fb6a | 22 | #include <Protocol/SimpleTextOut.h>\r |
| 23 | #include <Protocol/SimpleTextIn.h>\r | |
| 24 | #include <Protocol/FormBrowser2.h>\r | |
| 25 | #include <Protocol/DevicePath.h>\r | |
| 26 | #include <Protocol/UnicodeCollation.h>\r | |
| 27 | #include <Protocol/HiiConfigAccess.h>\r | |
| 28 | #include <Protocol/HiiConfigRouting.h>\r | |
| 29 | #include <Protocol/HiiDatabase.h>\r | |
| 30 | #include <Protocol/HiiString.h>\r | |
| cbf73e50 | 31 | #include <Protocol/UserManager.h>\r |
| 7936fb6a | 32 | \r |
| 5c526736 | 33 | #include <Guid/MdeModuleHii.h>\r |
| 0a1147ed | 34 | #include <Guid/HiiPlatformSetupFormset.h>\r |
| 7936fb6a | 35 | \r |
| 7936fb6a | 36 | #include <Library/PrintLib.h>\r |
| 37 | #include <Library/DebugLib.h>\r | |
| 38 | #include <Library/BaseMemoryLib.h>\r | |
| 39 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
| 40 | #include <Library/UefiDriverEntryPoint.h>\r | |
| 41 | #include <Library/UefiBootServicesTableLib.h>\r | |
| 42 | #include <Library/BaseLib.h>\r | |
| 43 | #include <Library/MemoryAllocationLib.h>\r | |
| 7936fb6a | 44 | #include <Library/HiiLib.h>\r |
| f511d656 | 45 | #include <Library/PcdLib.h>\r |
| cb7d01c0 | 46 | #include <Library/DevicePathLib.h>\r |
| 7936fb6a | 47 | \r |
| 48 | #include "Colors.h"\r | |
| 49 | \r | |
| 50 | //\r | |
| 51 | // This is the generated header file which includes whatever needs to be exported (strings + IFR)\r | |
| 52 | //\r | |
| 53 | \r | |
| 54 | extern UINT8 SetupBrowserStrings[];\r | |
| 55 | \r | |
| 56 | //\r | |
| 57 | // Screen definitions\r | |
| 58 | //\r | |
| 59 | #define BANNER_HEIGHT 6\r | |
| 60 | #define BANNER_COLUMNS 3\r | |
| 61 | \r | |
| 62 | #define FRONT_PAGE_HEADER_HEIGHT 6\r | |
| 63 | #define NONE_FRONT_PAGE_HEADER_HEIGHT 3\r | |
| 64 | #define LEFT_SKIPPED_COLUMNS 4\r | |
| 65 | #define FOOTER_HEIGHT 4\r | |
| 66 | #define STATUS_BAR_HEIGHT 1\r | |
| 67 | #define SCROLL_ARROW_HEIGHT 1\r | |
| 68 | #define POPUP_PAD_SPACE_COUNT 5\r | |
| 69 | #define POPUP_FRAME_WIDTH 2\r | |
| 70 | \r | |
| 71 | //\r | |
| 72 | // Definition for function key setting\r | |
| 73 | //\r | |
| 74 | #define NONE_FUNCTION_KEY_SETTING 0\r | |
| 8b0fc5c1 | 75 | #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)\r |
| 7936fb6a | 76 | \r |
| 7936fb6a | 77 | #define FUNCTION_NINE (1 << 2)\r |
| 78 | #define FUNCTION_TEN (1 << 3)\r | |
| 79 | \r | |
| 80 | typedef struct {\r | |
| 81 | EFI_GUID FormSetGuid;\r | |
| 82 | UINTN KeySetting;\r | |
| 83 | } FUNCTIION_KEY_SETTING;\r | |
| 84 | \r | |
| 85 | //\r | |
| 86 | // Character definitions\r | |
| 87 | //\r | |
| 88 | #define CHAR_SPACE 0x0020\r | |
| 89 | #define UPPER_LOWER_CASE_OFFSET 0x20\r | |
| 90 | \r | |
| 91 | //\r | |
| 92 | // Time definitions\r | |
| 93 | //\r | |
| 94 | #define ONE_SECOND 10000000\r | |
| 95 | \r | |
| 96 | //\r | |
| 97 | // Display definitions\r | |
| 98 | //\r | |
| 99 | #define LEFT_HYPER_DELIMITER L'<'\r | |
| 100 | #define RIGHT_HYPER_DELIMITER L'>'\r | |
| 101 | \r | |
| 102 | #define LEFT_ONEOF_DELIMITER L'<'\r | |
| 103 | #define RIGHT_ONEOF_DELIMITER L'>'\r | |
| 104 | \r | |
| 105 | #define LEFT_NUMERIC_DELIMITER L'['\r | |
| 106 | #define RIGHT_NUMERIC_DELIMITER L']'\r | |
| 107 | \r | |
| 108 | #define LEFT_CHECKBOX_DELIMITER L'['\r | |
| 109 | #define RIGHT_CHECKBOX_DELIMITER L']'\r | |
| 110 | \r | |
| 111 | #define CHECK_ON L'X'\r | |
| 112 | #define CHECK_OFF L' '\r | |
| 113 | \r | |
| 114 | #define TIME_SEPARATOR L':'\r | |
| 115 | #define DATE_SEPARATOR L'/'\r | |
| 116 | \r | |
| 117 | #define YES_ANSWER L'Y'\r | |
| 118 | #define NO_ANSWER L'N'\r | |
| 119 | \r | |
| 120 | //\r | |
| 121 | // This is the Input Error Message\r | |
| 122 | //\r | |
| 123 | #define INPUT_ERROR 1\r | |
| 124 | \r | |
| 125 | //\r | |
| 126 | // This is the NV RAM update required Message\r | |
| 127 | //\r | |
| 128 | #define NV_UPDATE_REQUIRED 2\r | |
| 129 | \r | |
| 130 | //\r | |
| 131 | // Refresh the Status Bar with flags\r | |
| 132 | //\r | |
| 133 | #define REFRESH_STATUS_BAR 0xff\r | |
| 134 | \r | |
| 135 | //\r | |
| 136 | // Incremental string lenght of ConfigRequest\r | |
| 137 | //\r | |
| 138 | #define CONFIG_REQUEST_STRING_INCREMENTAL 1024\r | |
| 139 | \r | |
| 140 | //\r | |
| 141 | // HII value compare result\r | |
| 142 | //\r | |
| 143 | #define HII_VALUE_UNDEFINED 0\r | |
| 144 | #define HII_VALUE_EQUAL 1\r | |
| 145 | #define HII_VALUE_LESS_THAN 2\r | |
| 146 | #define HII_VALUE_GREATER_THAN 3\r | |
| 147 | \r | |
| 148 | //\r | |
| 149 | // Incremental size of stack for expression\r | |
| 150 | //\r | |
| 151 | #define EXPRESSION_STACK_SIZE_INCREMENT 0x100\r | |
| 152 | \r | |
| 153 | \r | |
| 154 | #define EFI_SPECIFICATION_ERRATA_VERSION 0\r | |
| 155 | \r | |
| 156 | #define EFI_IFR_SPECIFICATION_VERSION \\r | |
| 157 | ((((EFI_SPECIFICATION_VERSION) >> 8) & 0xff00) | \\r | |
| 158 | (((EFI_SPECIFICATION_VERSION) & 0xf) << 4) | \\r | |
| 159 | ((EFI_SPECIFICATION_ERRATA_VERSION) & 0xf))\r | |
| 160 | \r | |
| f3f2e05d | 161 | #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')\r |
| 7936fb6a | 162 | typedef struct {\r |
| 163 | UINT32 Signature;\r | |
| 164 | \r | |
| 165 | EFI_HANDLE Handle;\r | |
| 166 | \r | |
| 167 | //\r | |
| 168 | // Produced protocol\r | |
| 169 | //\r | |
| 170 | EFI_FORM_BROWSER2_PROTOCOL FormBrowser2;\r | |
| 7936fb6a | 171 | \r |
| 172 | } SETUP_DRIVER_PRIVATE_DATA;\r | |
| 173 | \r | |
| 174 | typedef struct {\r | |
| 175 | EFI_STRING_ID Banner[BANNER_HEIGHT][BANNER_COLUMNS];\r | |
| 176 | } BANNER_DATA;\r | |
| 177 | \r | |
| 178 | //\r | |
| 179 | // IFR relative definition\r | |
| 180 | //\r | |
| 181 | #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r | |
| 182 | #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r | |
| 183 | #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r | |
| 184 | #define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r | |
| 185 | #define EFI_HII_EXPRESSION_DISABLE_IF 4\r | |
| 186 | #define EFI_HII_EXPRESSION_VALUE 5\r | |
| 187 | #define EFI_HII_EXPRESSION_RULE 6\r | |
| 188 | \r | |
| 189 | #define EFI_HII_VARSTORE_BUFFER 0\r | |
| 190 | #define EFI_HII_VARSTORE_NAME_VALUE 1\r | |
| 191 | #define EFI_HII_VARSTORE_EFI_VARIABLE 2\r | |
| 192 | \r | |
| 193 | #define FORM_INCONSISTENT_VALIDATION 0\r | |
| 194 | #define FORM_NO_SUBMIT_VALIDATION 1\r | |
| 195 | \r | |
| 40245175 LG |
196 | #define FORMSET_CLASS_PLATFORM_SETUP 0x0001\r |
| 197 | #define FORMSET_CLASS_FRONT_PAGE 0x0002\r | |
| 0a1147ed | 198 | \r |
| 7936fb6a | 199 | typedef struct {\r |
| 200 | UINT8 Type;\r | |
| 201 | EFI_IFR_TYPE_VALUE Value;\r | |
| 202 | } EFI_HII_VALUE;\r | |
| 203 | \r | |
| f3f2e05d | 204 | #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')\r |
| 7936fb6a | 205 | \r |
| 206 | typedef struct {\r | |
| 207 | UINTN Signature;\r | |
| 208 | LIST_ENTRY Link;\r | |
| 209 | CHAR16 *Name;\r | |
| 210 | CHAR16 *Value;\r | |
| 211 | CHAR16 *EditValue;\r | |
| 212 | } NAME_VALUE_NODE;\r | |
| 213 | \r | |
| 214 | #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r | |
| 215 | \r | |
| f3f2e05d | 216 | #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')\r |
| 7936fb6a | 217 | \r |
| 218 | typedef struct {\r | |
| 219 | UINTN Signature;\r | |
| 220 | LIST_ENTRY Link;\r | |
| 221 | \r | |
| 222 | UINT8 Type; // Storage type\r | |
| 223 | \r | |
| 224 | UINT16 VarStoreId;\r | |
| 225 | EFI_GUID Guid;\r | |
| 226 | \r | |
| 227 | CHAR16 *Name; // For EFI_IFR_VARSTORE\r | |
| 228 | UINT16 Size;\r | |
| 229 | UINT8 *Buffer;\r | |
| 230 | UINT8 *EditBuffer; // Edit copy for Buffer Storage\r | |
| 231 | \r | |
| 232 | LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE\r | |
| 233 | \r | |
| 234 | UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r | |
| 235 | \r | |
| 236 | CHAR16 *ConfigHdr; // <ConfigHdr>\r | |
| 237 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r | |
| 238 | UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r | |
| 239 | UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r | |
| 240 | } FORMSET_STORAGE;\r | |
| 241 | \r | |
| 242 | #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r | |
| 243 | \r | |
| f3f2e05d | 244 | #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')\r |
| 7936fb6a | 245 | \r |
| 246 | typedef struct {\r | |
| 247 | UINTN Signature;\r | |
| 248 | LIST_ENTRY Link;\r | |
| 249 | \r | |
| 250 | UINT8 Operand;\r | |
| 251 | \r | |
| 252 | UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r | |
| 253 | UINT8 Flags; // For EFI_IFR_SPAN\r | |
| 254 | UINT8 RuleId; // For EFI_IFR_RULE_REF\r | |
| 255 | \r | |
| 256 | EFI_HII_VALUE Value; // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1\r | |
| 257 | \r | |
| 2654f642 | 258 | EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1\r |
| 7936fb6a | 259 | EFI_QUESTION_ID QuestionId2;\r |
| 260 | \r | |
| 2654f642 | 261 | UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_LIST\r |
| 7936fb6a | 262 | UINT16 *ValueList;\r |
| 263 | \r | |
| 264 | EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r | |
| 265 | EFI_GUID Guid;\r | |
| 266 | } EXPRESSION_OPCODE;\r | |
| 267 | \r | |
| 268 | #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r | |
| 269 | \r | |
| f3f2e05d | 270 | #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')\r |
| 7936fb6a | 271 | \r |
| 272 | typedef struct {\r | |
| 273 | UINTN Signature;\r | |
| 274 | LIST_ENTRY Link;\r | |
| 275 | \r | |
| 276 | UINT8 Type; // Type for this expression\r | |
| 277 | \r | |
| 278 | UINT8 RuleId; // For EFI_IFR_RULE only\r | |
| 279 | EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r | |
| 280 | \r | |
| 281 | EFI_HII_VALUE Result; // Expression evaluation result\r | |
| 282 | \r | |
| 283 | LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)\r | |
| 284 | } FORM_EXPRESSION;\r | |
| 285 | \r | |
| 286 | #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r | |
| 287 | \r | |
| f3f2e05d | 288 | #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')\r |
| 7936fb6a | 289 | \r |
| 290 | typedef struct {\r | |
| 291 | UINTN Signature;\r | |
| 292 | LIST_ENTRY Link;\r | |
| 293 | \r | |
| 294 | UINT16 DefaultId;\r | |
| 295 | EFI_HII_VALUE Value; // Default value\r | |
| 296 | \r | |
| 297 | FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r | |
| 298 | } QUESTION_DEFAULT;\r | |
| 299 | \r | |
| 300 | #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r | |
| 301 | \r | |
| f3f2e05d | 302 | #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')\r |
| 7936fb6a | 303 | \r |
| 304 | typedef struct {\r | |
| 305 | UINTN Signature;\r | |
| 306 | LIST_ENTRY Link;\r | |
| 307 | \r | |
| 308 | EFI_STRING_ID Text;\r | |
| 309 | UINT8 Flags;\r | |
| 310 | EFI_HII_VALUE Value;\r | |
| 311 | EFI_IMAGE_ID ImageId;\r | |
| 312 | \r | |
| 313 | FORM_EXPRESSION *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r | |
| 314 | } QUESTION_OPTION;\r | |
| 315 | \r | |
| 316 | #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r | |
| 317 | \r | |
| f3f2e05d | 318 | #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')\r |
| 1ccdbf2a | 319 | \r |
| 320 | typedef union {\r | |
| 321 | EFI_STRING_ID VarName;\r | |
| 322 | UINT16 VarOffset;\r | |
| 323 | } VAR_STORE_INFO;\r | |
| 324 | \r | |
| 7936fb6a | 325 | typedef struct {\r |
| 326 | UINTN Signature;\r | |
| 327 | LIST_ENTRY Link;\r | |
| 328 | \r | |
| 329 | UINT8 Operand; // The operand (first byte) of this Statement or Question\r | |
| 330 | \r | |
| 331 | //\r | |
| 332 | // Statement Header\r | |
| 333 | //\r | |
| 334 | EFI_STRING_ID Prompt;\r | |
| 335 | EFI_STRING_ID Help;\r | |
| 336 | EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT\r | |
| 337 | \r | |
| 338 | //\r | |
| 339 | // Question Header\r | |
| 340 | //\r | |
| 341 | EFI_QUESTION_ID QuestionId; // The value of zero is reserved\r | |
| 342 | EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage\r | |
| 343 | FORMSET_STORAGE *Storage;\r | |
| 1ccdbf2a | 344 | VAR_STORE_INFO VarStoreInfo;\r |
| 7936fb6a | 345 | UINT16 StorageWidth;\r |
| 346 | UINT8 QuestionFlags;\r | |
| 347 | CHAR16 *VariableName; // Name/Value or EFI Variable name\r | |
| 348 | CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."\r | |
| 349 | \r | |
| 350 | EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof\r | |
| 351 | UINT8 *BufferValue; // Edit copy for string, password, orderedlist\r | |
| d02847d3 | 352 | UINT8 ValueType; // Data type for orderedlist value array\r |
| 7936fb6a | 353 | \r |
| 354 | //\r | |
| 355 | // OpCode specific members\r | |
| 356 | //\r | |
| 357 | UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r | |
| 358 | // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r | |
| 359 | UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST\r | |
| 360 | \r | |
| 361 | UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r | |
| 362 | EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r | |
| 363 | \r | |
| 364 | UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r | |
| 365 | UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r | |
| 366 | UINT64 Step;\r | |
| 367 | \r | |
| 368 | EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON\r | |
| 369 | EFI_FORM_ID RefFormId; // for EFI_IFR_REF\r | |
| 370 | EFI_QUESTION_ID RefQuestionId; // for EFI_IFR_REF2\r | |
| 371 | EFI_GUID RefFormSetId; // for EFI_IFR_REF3\r | |
| 372 | EFI_STRING_ID RefDevicePath; // for EFI_IFR_REF4\r | |
| 373 | \r | |
| 374 | //\r | |
| 375 | // Get from IFR parsing\r | |
| 376 | //\r | |
| 377 | FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r | |
| 378 | LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r | |
| 379 | LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r | |
| 380 | \r | |
| 381 | EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE\r | |
| 382 | UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r | |
| 383 | BOOLEAN InSubtitle; // nesting inside of EFI_IFR_SUBTITLE\r | |
| 384 | \r | |
| 385 | LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r | |
| 386 | LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)\r | |
| 387 | FORM_EXPRESSION *GrayOutExpression; // nesting inside of GrayOutIf\r | |
| 388 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r | |
| 0a1147ed | 389 | FORM_EXPRESSION *DisableExpression; // nesting inside of DisableIf\r |
| 7936fb6a | 390 | \r |
| 391 | } FORM_BROWSER_STATEMENT;\r | |
| 392 | \r | |
| 393 | #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r | |
| 394 | \r | |
| f3f2e05d | 395 | #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')\r |
| 7936fb6a | 396 | \r |
| 397 | typedef struct {\r | |
| 398 | UINTN Signature;\r | |
| 399 | LIST_ENTRY Link;\r | |
| 400 | \r | |
| 401 | UINT16 FormId;\r | |
| 402 | EFI_STRING_ID FormTitle;\r | |
| 403 | \r | |
| 404 | EFI_IMAGE_ID ImageId;\r | |
| 405 | \r | |
| 406 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r | |
| 407 | LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r | |
| 0c66bc76 | 408 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r |
| 7936fb6a | 409 | } FORM_BROWSER_FORM;\r |
| 410 | \r | |
| 411 | #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r | |
| 412 | \r | |
| f3f2e05d | 413 | #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')\r |
| 7936fb6a | 414 | \r |
| 415 | typedef struct {\r | |
| 416 | UINTN Signature;\r | |
| 417 | LIST_ENTRY Link;\r | |
| 418 | \r | |
| 419 | UINT16 DefaultId;\r | |
| 420 | EFI_STRING_ID DefaultName;\r | |
| 421 | } FORMSET_DEFAULTSTORE;\r | |
| 422 | \r | |
| 423 | #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r | |
| 424 | \r | |
| 425 | typedef struct {\r | |
| 426 | EFI_HII_HANDLE HiiHandle;\r | |
| 427 | EFI_HANDLE DriverHandle;\r | |
| 428 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
| 429 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
| 430 | \r | |
| 431 | UINTN IfrBinaryLength;\r | |
| 432 | UINT8 *IfrBinaryData;\r | |
| 433 | \r | |
| 434 | EFI_GUID Guid;\r | |
| 435 | EFI_STRING_ID FormSetTitle;\r | |
| 436 | EFI_STRING_ID Help;\r | |
| 0a1147ed LG |
437 | UINT8 NumberOfClassGuid;\r |
| 438 | EFI_GUID ClassGuid[3]; // Up to three ClassGuid\r | |
| 439 | UINT16 Class; // Tiano extended Class code\r | |
| 440 | UINT16 SubClass; // Tiano extended Subclass code\r | |
| 7936fb6a | 441 | EFI_IMAGE_ID ImageId;\r |
| 442 | \r | |
| 443 | FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r | |
| 444 | EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r | |
| 445 | \r | |
| 446 | LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r | |
| 447 | LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r | |
| 448 | LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r | |
| 0c66bc76 | 449 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r |
| 7936fb6a | 450 | } FORM_BROWSER_FORMSET;\r |
| 451 | \r | |
| ce6d12cc | 452 | #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')\r |
| 453 | \r | |
| 454 | typedef struct {\r | |
| 455 | UINTN Signature;\r | |
| 456 | LIST_ENTRY Link;\r | |
| 457 | \r | |
| 458 | //\r | |
| 459 | // Globals defined in Setup.c\r | |
| 460 | //\r | |
| 461 | BANNER_DATA *BannerData;\r | |
| 462 | UINTN ClassOfVfr;\r | |
| 463 | UINTN FunctionKeySetting;\r | |
| 464 | BOOLEAN ResetRequired;\r | |
| 465 | BOOLEAN NvUpdateRequired;\r | |
| 466 | UINT16 Direction;\r | |
| 467 | EFI_SCREEN_DESCRIPTOR ScreenDimensions;\r | |
| 468 | CHAR16 *FunctionNineString;\r | |
| 469 | CHAR16 *FunctionTenString;\r | |
| 470 | CHAR16 *EnterString;\r | |
| 471 | CHAR16 *EnterCommitString;\r | |
| 472 | CHAR16 *EnterEscapeString;\r | |
| 473 | CHAR16 *EscapeString;\r | |
| 474 | CHAR16 *SaveFailed;\r | |
| 475 | CHAR16 *MoveHighlight;\r | |
| 476 | CHAR16 *MakeSelection;\r | |
| 477 | CHAR16 *DecNumericInput;\r | |
| 478 | CHAR16 *HexNumericInput;\r | |
| 479 | CHAR16 *ToggleCheckBox;\r | |
| 480 | CHAR16 *PromptForData;\r | |
| 481 | CHAR16 *PromptForPassword;\r | |
| 482 | CHAR16 *PromptForNewPassword;\r | |
| 483 | CHAR16 *ConfirmPassword;\r | |
| 484 | CHAR16 *ConfirmError;\r | |
| 485 | CHAR16 *PassowordInvalid;\r | |
| 486 | CHAR16 *PressEnter;\r | |
| 487 | CHAR16 *EmptyString;\r | |
| 488 | CHAR16 *AreYouSure;\r | |
| 489 | CHAR16 *YesResponse;\r | |
| 490 | CHAR16 *NoResponse;\r | |
| 491 | CHAR16 *MiniString;\r | |
| 492 | CHAR16 *PlusString;\r | |
| 493 | CHAR16 *MinusString;\r | |
| 494 | CHAR16 *AdjustNumber;\r | |
| 495 | CHAR16 *SaveChanges;\r | |
| 496 | CHAR16 *OptionMismatch;\r | |
| 2bb526f3 | 497 | CHAR16 *FormSuppress;\r |
| ce6d12cc | 498 | CHAR16 PromptBlockWidth;\r |
| 499 | CHAR16 OptionBlockWidth;\r | |
| 500 | CHAR16 HelpBlockWidth;\r | |
| 501 | FORM_BROWSER_FORMSET *OldFormSet;\r | |
| 502 | \r | |
| 503 | //\r | |
| 504 | // Globals defined in Ui.c\r | |
| 505 | //\r | |
| 506 | LIST_ENTRY MenuOption;\r | |
| 507 | VOID *MenuRefreshHead;\r | |
| 508 | } BROWSER_CONTEXT;\r | |
| 509 | \r | |
| 510 | #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)\r | |
| 7936fb6a | 511 | \r |
| 512 | extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r | |
| 513 | extern EFI_HII_STRING_PROTOCOL *mHiiString;\r | |
| 514 | extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;\r | |
| 515 | \r | |
| 0a1147ed LG |
516 | extern BANNER_DATA *gBannerData;\r |
| 517 | extern EFI_HII_HANDLE gFrontPageHandle;\r | |
| 7936fb6a | 518 | extern UINTN gClassOfVfr;\r |
| 519 | extern UINTN gFunctionKeySetting;\r | |
| 520 | extern BOOLEAN gResetRequired;\r | |
| 521 | extern BOOLEAN gNvUpdateRequired;\r | |
| 522 | extern EFI_HII_HANDLE gHiiHandle;\r | |
| 7936fb6a | 523 | extern UINT16 gDirection;\r |
| 524 | extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;\r | |
| 7936fb6a | 525 | \r |
| d66e6c16 | 526 | extern FORM_BROWSER_FORMSET *gOldFormSet;\r |
| 527 | \r | |
| 7936fb6a | 528 | //\r |
| 529 | // Browser Global Strings\r | |
| 530 | //\r | |
| 7936fb6a | 531 | extern CHAR16 *gFunctionNineString;\r |
| 532 | extern CHAR16 *gFunctionTenString;\r | |
| 533 | extern CHAR16 *gEnterString;\r | |
| 534 | extern CHAR16 *gEnterCommitString;\r | |
| 8d00a0f1 | 535 | extern CHAR16 *gEnterEscapeString;\r |
| 7936fb6a | 536 | extern CHAR16 *gEscapeString;\r |
| 537 | extern CHAR16 *gSaveFailed;\r | |
| 538 | extern CHAR16 *gMoveHighlight;\r | |
| 539 | extern CHAR16 *gMakeSelection;\r | |
| 540 | extern CHAR16 *gDecNumericInput;\r | |
| 541 | extern CHAR16 *gHexNumericInput;\r | |
| 542 | extern CHAR16 *gToggleCheckBox;\r | |
| 543 | extern CHAR16 *gPromptForData;\r | |
| 544 | extern CHAR16 *gPromptForPassword;\r | |
| 545 | extern CHAR16 *gPromptForNewPassword;\r | |
| 546 | extern CHAR16 *gConfirmPassword;\r | |
| 547 | extern CHAR16 *gConfirmError;\r | |
| 548 | extern CHAR16 *gPassowordInvalid;\r | |
| 549 | extern CHAR16 *gPressEnter;\r | |
| 550 | extern CHAR16 *gEmptyString;\r | |
| 551 | extern CHAR16 *gAreYouSure;\r | |
| 552 | extern CHAR16 *gYesResponse;\r | |
| 553 | extern CHAR16 *gNoResponse;\r | |
| 554 | extern CHAR16 *gMiniString;\r | |
| 555 | extern CHAR16 *gPlusString;\r | |
| 556 | extern CHAR16 *gMinusString;\r | |
| 557 | extern CHAR16 *gAdjustNumber;\r | |
| ebe43565 | 558 | extern CHAR16 *gSaveChanges;\r |
| 8d00a0f1 | 559 | extern CHAR16 *gOptionMismatch;\r |
| 0c66bc76 | 560 | extern CHAR16 *gFormSuppress;\r |
| 7936fb6a | 561 | \r |
| 562 | extern CHAR16 gPromptBlockWidth;\r | |
| 563 | extern CHAR16 gOptionBlockWidth;\r | |
| 564 | extern CHAR16 gHelpBlockWidth;\r | |
| 565 | \r | |
| 566 | extern EFI_GUID gZeroGuid;\r | |
| 567 | extern EFI_GUID gTianoHiiIfrGuid;\r | |
| 568 | \r | |
| eccfeab1 | 569 | #include "Ui.h"\r |
| 7936fb6a | 570 | //\r |
| 571 | // Global Procedure Defines\r | |
| 572 | //\r | |
| 573 | \r | |
| 574 | /**\r | |
| 575 | Initialize the HII String Token to the correct values.\r | |
| 576 | \r | |
| 577 | **/\r | |
| 578 | VOID\r | |
| 579 | InitializeBrowserStrings (\r | |
| 580 | VOID\r | |
| ed66e1bc | 581 | );\r |
| 7936fb6a | 582 | \r |
| 583 | /**\r | |
| 584 | Prints a unicode string to the default console,\r | |
| 585 | using L"%s" format.\r | |
| 586 | \r | |
| 587 | @param String String pointer.\r | |
| 588 | \r | |
| 589 | @return Length of string printed to the console\r | |
| 590 | \r | |
| 591 | **/\r | |
| 592 | UINTN\r | |
| 593 | PrintString (\r | |
| 594 | IN CHAR16 *String\r | |
| ed66e1bc | 595 | );\r |
| 7936fb6a | 596 | \r |
| 597 | /**\r | |
| 598 | Prints a chracter to the default console,\r | |
| 599 | using L"%c" format.\r | |
| 600 | \r | |
| 601 | @param Character Character to print.\r | |
| 602 | \r | |
| 603 | @return Length of string printed to the console.\r | |
| 604 | \r | |
| 605 | **/\r | |
| 606 | UINTN\r | |
| 607 | PrintChar (\r | |
| 608 | CHAR16 Character\r | |
| ed66e1bc | 609 | );\r |
| 7936fb6a | 610 | \r |
| 611 | /**\r | |
| 612 | Prints a formatted unicode string to the default console, at\r | |
| 613 | the supplied cursor position.\r | |
| 614 | \r | |
| 615 | @param Column The cursor position to print the string at.\r | |
| 616 | @param Row The cursor position to print the string at\r | |
| 617 | @param Fmt Format string\r | |
| 618 | @param ... Variable argument list for formating string.\r | |
| 619 | \r | |
| 620 | @return Length of string printed to the console\r | |
| 621 | \r | |
| 622 | **/\r | |
| 623 | UINTN\r | |
| 624 | PrintAt (\r | |
| 625 | IN UINTN Column,\r | |
| 626 | IN UINTN Row,\r | |
| 627 | IN CHAR16 *Fmt,\r | |
| 628 | ...\r | |
| ed66e1bc | 629 | );\r |
| 7936fb6a | 630 | \r |
| 631 | /**\r | |
| 632 | Prints a unicode string to the default console, at\r | |
| 633 | the supplied cursor position, using L"%s" format.\r | |
| 634 | \r | |
| 635 | @param Column The cursor position to print the string at.\r | |
| 636 | @param Row The cursor position to print the string at\r | |
| 637 | @param String String pointer.\r | |
| 638 | \r | |
| 639 | @return Length of string printed to the console\r | |
| 640 | \r | |
| 641 | **/\r | |
| 642 | UINTN\r | |
| 643 | PrintStringAt (\r | |
| 644 | IN UINTN Column,\r | |
| 645 | IN UINTN Row,\r | |
| 646 | IN CHAR16 *String\r | |
| ed66e1bc | 647 | );\r |
| 7936fb6a | 648 | \r |
| 649 | /**\r | |
| 650 | Prints a chracter to the default console, at\r | |
| 651 | the supplied cursor position, using L"%c" format.\r | |
| 652 | \r | |
| 653 | @param Column The cursor position to print the string at.\r | |
| 654 | @param Row The cursor position to print the string at.\r | |
| 655 | @param Character Character to print.\r | |
| 656 | \r | |
| 657 | @return Length of string printed to the console.\r | |
| 658 | \r | |
| 659 | **/\r | |
| 660 | UINTN\r | |
| 661 | PrintCharAt (\r | |
| 662 | IN UINTN Column,\r | |
| 663 | IN UINTN Row,\r | |
| 664 | CHAR16 Character\r | |
| ed66e1bc | 665 | );\r |
| 7936fb6a | 666 | \r |
| 667 | /**\r | |
| 668 | Parse opcodes in the formset IFR binary.\r | |
| 669 | \r | |
| 670 | @param FormSet Pointer of the FormSet data structure.\r | |
| 671 | \r | |
| 672 | @retval EFI_SUCCESS Opcode parse success.\r | |
| 673 | @retval Other Opcode parse fail.\r | |
| 674 | \r | |
| 675 | **/\r | |
| 676 | EFI_STATUS\r | |
| 677 | ParseOpCodes (\r | |
| 678 | IN FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 679 | );\r |
| 7936fb6a | 680 | \r |
| 681 | /**\r | |
| 682 | Free resources allocated for a FormSet.\r | |
| 683 | \r | |
| 684 | @param FormSet Pointer of the FormSet\r | |
| 685 | \r | |
| 686 | **/\r | |
| 687 | VOID\r | |
| 688 | DestroyFormSet (\r | |
| 689 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 690 | );\r |
| 7936fb6a | 691 | \r |
| 692 | /**\r | |
| 693 | This function displays the page frame.\r | |
| 694 | \r | |
| 695 | **/\r | |
| 696 | VOID\r | |
| 697 | DisplayPageFrame (\r | |
| 698 | VOID\r | |
| ed66e1bc | 699 | );\r |
| 7936fb6a | 700 | \r |
| 701 | /**\r | |
| 702 | Create a new string in HII Package List.\r | |
| 703 | \r | |
| 704 | @param String The String to be added\r | |
| 705 | @param HiiHandle The package list in the HII database to insert the\r | |
| 706 | specified string.\r | |
| 707 | \r | |
| 708 | @return The output string.\r | |
| 709 | \r | |
| 710 | **/\r | |
| 711 | EFI_STRING_ID\r | |
| 712 | NewString (\r | |
| 713 | IN CHAR16 *String,\r | |
| 714 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 715 | );\r |
| 7936fb6a | 716 | \r |
| 717 | /**\r | |
| 718 | Delete a string from HII Package List.\r | |
| 719 | \r | |
| 720 | @param StringId Id of the string in HII database.\r | |
| 721 | @param HiiHandle The HII package list handle.\r | |
| 722 | \r | |
| 723 | @retval EFI_SUCCESS The string was deleted successfully.\r | |
| 724 | \r | |
| 725 | **/\r | |
| 726 | EFI_STATUS\r | |
| 727 | DeleteString (\r | |
| 728 | IN EFI_STRING_ID StringId,\r | |
| 729 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 730 | );\r |
| 7936fb6a | 731 | \r |
| 732 | /**\r | |
| 733 | Get the string based on the StringId and HII Package List Handle.\r | |
| 734 | \r | |
| 735 | @param Token The String's ID.\r | |
| 736 | @param HiiHandle The package list in the HII database to search for\r | |
| 737 | the specified string.\r | |
| 738 | \r | |
| 739 | @return The output string.\r | |
| 740 | \r | |
| 741 | **/\r | |
| 742 | CHAR16 *\r | |
| 743 | GetToken (\r | |
| 744 | IN EFI_STRING_ID Token,\r | |
| 745 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 746 | );\r |
| 7936fb6a | 747 | \r |
| 748 | /**\r | |
| 749 | Draw a pop up windows based on the dimension, number of lines and\r | |
| 750 | strings specified.\r | |
| 751 | \r | |
| 752 | @param RequestedWidth The width of the pop-up.\r | |
| 753 | @param NumberOfLines The number of lines.\r | |
| f4bcc90f | 754 | @param Marker The variable argument list for the list of string to be printed.\r |
| 7936fb6a | 755 | \r |
| 756 | **/\r | |
| 757 | VOID\r | |
| 758 | CreateSharedPopUp (\r | |
| 759 | IN UINTN RequestedWidth,\r | |
| 760 | IN UINTN NumberOfLines,\r | |
| f4bcc90f | 761 | IN VA_LIST Marker\r |
| ed66e1bc | 762 | );\r |
| 7936fb6a | 763 | \r |
| 764 | /**\r | |
| 765 | Routine used to abstract a generic dialog interface and return the selected key or string\r | |
| 766 | \r | |
| 767 | @param NumberOfLines The number of lines for the dialog box\r | |
| 768 | @param HotKey Defines whether a single character is parsed\r | |
| 769 | (TRUE) and returned in KeyValue or a string is\r | |
| 770 | returned in StringBuffer. Two special characters\r | |
| 771 | are considered when entering a string, a SCAN_ESC\r | |
| 772 | and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates\r | |
| 773 | string input and returns\r | |
| 774 | @param MaximumStringSize The maximum size in bytes of a typed in string\r | |
| 775 | (each character is a CHAR16) and the minimum\r | |
| 776 | string returned is two bytes\r | |
| 777 | @param StringBuffer The passed in pointer to the buffer which will\r | |
| 778 | hold the typed in string if HotKey is FALSE\r | |
| 779 | @param KeyValue The EFI_KEY value returned if HotKey is TRUE..\r | |
| 7936fb6a | 780 | @param ... A series of (quantity == NumberOfLines) text\r |
| 781 | strings which will be used to construct the dialog\r | |
| 782 | box\r | |
| 783 | \r | |
| 784 | @retval EFI_SUCCESS Displayed dialog and received user interaction\r | |
| 785 | @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.\r | |
| 786 | (StringBuffer == NULL) && (HotKey == FALSE))\r | |
| 787 | @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine\r | |
| 788 | \r | |
| 789 | **/\r | |
| 790 | EFI_STATUS\r | |
| 791 | CreateDialog (\r | |
| 792 | IN UINTN NumberOfLines,\r | |
| 793 | IN BOOLEAN HotKey,\r | |
| 794 | IN UINTN MaximumStringSize,\r | |
| 795 | OUT CHAR16 *StringBuffer,\r | |
| 796 | OUT EFI_INPUT_KEY *KeyValue,\r | |
| 7936fb6a | 797 | ...\r |
| ed66e1bc | 798 | );\r |
| 7936fb6a | 799 | \r |
| 800 | /**\r | |
| 801 | Get Question's current Value.\r | |
| 802 | \r | |
| 803 | @param FormSet FormSet data structure.\r | |
| 804 | @param Form Form data structure.\r | |
| 805 | @param Question Question to be initialized.\r | |
| 806 | @param Cached TRUE: get from Edit copy FALSE: get from original\r | |
| 807 | Storage\r | |
| 808 | \r | |
| 809 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 810 | \r | |
| 811 | **/\r | |
| 812 | EFI_STATUS\r | |
| 813 | GetQuestionValue (\r | |
| 814 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 815 | IN FORM_BROWSER_FORM *Form,\r | |
| 816 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
| 817 | IN BOOLEAN Cached\r | |
| ed66e1bc | 818 | );\r |
| 7936fb6a | 819 | \r |
| 820 | /**\r | |
| 821 | Save Question Value to edit copy(cached) or Storage(uncached).\r | |
| 822 | \r | |
| 823 | @param FormSet FormSet data structure.\r | |
| 824 | @param Form Form data structure.\r | |
| 825 | @param Question Pointer to the Question.\r | |
| 826 | @param Cached TRUE: set to Edit copy FALSE: set to original\r | |
| 827 | Storage\r | |
| 828 | \r | |
| 829 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 830 | \r | |
| 831 | **/\r | |
| 832 | EFI_STATUS\r | |
| 833 | SetQuestionValue (\r | |
| 834 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 835 | IN FORM_BROWSER_FORM *Form,\r | |
| 836 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
| 837 | IN BOOLEAN Cached\r | |
| ed66e1bc | 838 | );\r |
| 7936fb6a | 839 | \r |
| 840 | /**\r | |
| 841 | Perform inconsistent check for a Form.\r | |
| 842 | \r | |
| 843 | @param FormSet FormSet data structure.\r | |
| 844 | @param Form Form data structure.\r | |
| 845 | @param Question The Question to be validated.\r | |
| 846 | @param Type Validation type: InConsistent or NoSubmit\r | |
| 847 | \r | |
| 848 | @retval EFI_SUCCESS Form validation pass.\r | |
| 849 | @retval other Form validation failed.\r | |
| 850 | \r | |
| 851 | **/\r | |
| 852 | EFI_STATUS\r | |
| 853 | ValidateQuestion (\r | |
| 854 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 855 | IN FORM_BROWSER_FORM *Form,\r | |
| 856 | IN FORM_BROWSER_STATEMENT *Question,\r | |
| 857 | IN UINTN Type\r | |
| ed66e1bc | 858 | );\r |
| 7936fb6a | 859 | \r |
| 860 | /**\r | |
| 861 | Submit a Form.\r | |
| 862 | \r | |
| 863 | @param FormSet FormSet data structure.\r | |
| 864 | @param Form Form data structure.\r | |
| 865 | \r | |
| 866 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 867 | \r | |
| 868 | **/\r | |
| 869 | EFI_STATUS\r | |
| 870 | SubmitForm (\r | |
| 871 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 872 | IN FORM_BROWSER_FORM *Form\r | |
| ed66e1bc | 873 | );\r |
| 7936fb6a | 874 | \r |
| 875 | /**\r | |
| 876 | Reset Question to its default value.\r | |
| 877 | \r | |
| 878 | @param FormSet The form set.\r | |
| 879 | @param Form The form.\r | |
| 880 | @param Question The question.\r | |
| 881 | @param DefaultId The Class of the default.\r | |
| 882 | \r | |
| 883 | @retval EFI_SUCCESS Question is reset to default value.\r | |
| 884 | \r | |
| 885 | **/\r | |
| 886 | EFI_STATUS\r | |
| 887 | GetQuestionDefault (\r | |
| 888 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 889 | IN FORM_BROWSER_FORM *Form,\r | |
| 890 | IN FORM_BROWSER_STATEMENT *Question,\r | |
| 891 | IN UINT16 DefaultId\r | |
| ed66e1bc | 892 | );\r |
| 7936fb6a | 893 | \r |
| 894 | /**\r | |
| 895 | Get current setting of Questions.\r | |
| 896 | \r | |
| 897 | @param FormSet FormSet data structure.\r | |
| 898 | \r | |
| 899 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 900 | \r | |
| 901 | **/\r | |
| 902 | EFI_STATUS\r | |
| 903 | InitializeCurrentSetting (\r | |
| 904 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 905 | );\r |
| 7936fb6a | 906 | \r |
| 907 | /**\r | |
| 908 | Initialize the internal data structure of a FormSet.\r | |
| 909 | \r | |
| 910 | @param Handle PackageList Handle\r | |
| 911 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
| 912 | GUID), take the first FormSet found in package\r | |
| 913 | list.\r | |
| 914 | @param FormSet FormSet data structure.\r | |
| 915 | \r | |
| 916 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 917 | @retval EFI_NOT_FOUND The specified FormSet could not be found.\r | |
| 918 | \r | |
| 919 | **/\r | |
| 920 | EFI_STATUS\r | |
| 921 | InitializeFormSet (\r | |
| 922 | IN EFI_HII_HANDLE Handle,\r | |
| 923 | IN OUT EFI_GUID *FormSetGuid,\r | |
| 924 | OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 925 | );\r |
| 7936fb6a | 926 | \r |
| 927 | /**\r | |
| 928 | Reset Questions in a Form to their default value.\r | |
| 929 | \r | |
| 930 | @param FormSet FormSet data structure.\r | |
| 931 | @param Form The Form which to be reset.\r | |
| 932 | @param DefaultId The Class of the default.\r | |
| 933 | \r | |
| 934 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 935 | \r | |
| 936 | **/\r | |
| 937 | EFI_STATUS\r | |
| 938 | ExtractFormDefault (\r | |
| 939 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 940 | IN FORM_BROWSER_FORM *Form,\r | |
| 941 | IN UINT16 DefaultId\r | |
| ed66e1bc | 942 | );\r |
| 7936fb6a | 943 | \r |
| 944 | /**\r | |
| 945 | Initialize Question's Edit copy from Storage.\r | |
| 946 | \r | |
| eccfeab1 LG |
947 | @param Selection Selection contains the information about \r |
| 948 | the Selection, form and formset to be displayed.\r | |
| 949 | Selection action may be updated in retrieve callback.\r | |
| 7936fb6a | 950 | @param FormSet FormSet data structure.\r |
| 951 | @param Form Form data structure.\r | |
| 952 | \r | |
| 953 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 954 | \r | |
| 955 | **/\r | |
| 956 | EFI_STATUS\r | |
| 957 | LoadFormConfig (\r | |
| eccfeab1 LG |
958 | IN OUT UI_MENU_SELECTION *Selection,\r |
| 959 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 960 | IN FORM_BROWSER_FORM *Form\r | |
| ed66e1bc | 961 | );\r |
| 7936fb6a | 962 | \r |
| d66e6c16 | 963 | /**\r |
| 964 | Initialize Question's Edit copy from Storage for the whole Formset.\r | |
| 965 | \r | |
| eccfeab1 LG |
966 | @param Selection Selection contains the information about \r |
| 967 | the Selection, form and formset to be displayed.\r | |
| 968 | Selection action may be updated in retrieve callback.\r | |
| d66e6c16 | 969 | @param FormSet FormSet data structure.\r |
| 970 | \r | |
| 971 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 972 | \r | |
| 973 | **/\r | |
| 974 | EFI_STATUS\r | |
| 975 | LoadFormSetConfig (\r | |
| eccfeab1 LG |
976 | IN OUT UI_MENU_SELECTION *Selection,\r |
| 977 | IN FORM_BROWSER_FORMSET *FormSet\r | |
| d66e6c16 | 978 | );\r |
| 979 | \r | |
| 7936fb6a | 980 | /**\r |
| 981 | Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.\r | |
| 982 | \r | |
| 983 | @param Storage The Storage to be conveted.\r | |
| 984 | @param ConfigResp The returned <ConfigResp>.\r | |
| 985 | \r | |
| 986 | @retval EFI_SUCCESS Convert success.\r | |
| 987 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
| 988 | \r | |
| 989 | **/\r | |
| 990 | EFI_STATUS\r | |
| 991 | StorageToConfigResp (\r | |
| 992 | IN FORMSET_STORAGE *Storage,\r | |
| 993 | IN CHAR16 **ConfigResp\r | |
| ed66e1bc | 994 | );\r |
| 7936fb6a | 995 | \r |
| 996 | /**\r | |
| 997 | Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.\r | |
| 998 | \r | |
| 999 | @param Storage The Storage to receive the settings.\r | |
| 1000 | @param ConfigResp The <ConfigResp> to be converted.\r | |
| 1001 | \r | |
| 1002 | @retval EFI_SUCCESS Convert success.\r | |
| 1003 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
| 1004 | \r | |
| 1005 | **/\r | |
| 1006 | EFI_STATUS\r | |
| 1007 | ConfigRespToStorage (\r | |
| 1008 | IN FORMSET_STORAGE *Storage,\r | |
| 1009 | IN CHAR16 *ConfigResp\r | |
| ed66e1bc | 1010 | );\r |
| 7936fb6a | 1011 | \r |
| 1012 | /**\r | |
| 1013 | Fill storage's edit copy with settings requested from Configuration Driver.\r | |
| 1014 | \r | |
| 1015 | @param FormSet FormSet data structure.\r | |
| 1016 | @param Storage Buffer Storage.\r | |
| 1017 | \r | |
| 1018 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1019 | \r | |
| 1020 | **/\r | |
| 1021 | EFI_STATUS\r | |
| 1022 | LoadStorage (\r | |
| 1023 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 1024 | IN FORMSET_STORAGE *Storage\r | |
| ed66e1bc | 1025 | );\r |
| 7936fb6a | 1026 | \r |
| 1027 | /**\r | |
| 1028 | Fetch the Ifr binary data of a FormSet.\r | |
| 1029 | \r | |
| 1030 | @param Handle PackageList Handle\r | |
| 1031 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
| 1032 | GUID), take the first FormSet found in package\r | |
| 1033 | list.\r | |
| 1034 | @param BinaryLength The length of the FormSet IFR binary.\r | |
| 1035 | @param BinaryData The buffer designed to receive the FormSet.\r | |
| 1036 | \r | |
| 1037 | @retval EFI_SUCCESS Buffer filled with the requested FormSet.\r | |
| 1038 | BufferLength was updated.\r | |
| 1039 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
| 1040 | @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot\r | |
| 1041 | be found with the requested FormId.\r | |
| 1042 | \r | |
| 1043 | **/\r | |
| 1044 | EFI_STATUS\r | |
| 1045 | GetIfrBinaryData (\r | |
| 1046 | IN EFI_HII_HANDLE Handle,\r | |
| 1047 | IN OUT EFI_GUID *FormSetGuid,\r | |
| 1048 | OUT UINTN *BinaryLength,\r | |
| 1049 | OUT UINT8 **BinaryData\r | |
| ed66e1bc | 1050 | );\r |
| 7936fb6a | 1051 | \r |
| ce6d12cc | 1052 | /**\r |
| 1053 | Save globals used by previous call to SendForm(). SendForm() may be called from \r | |
| 1054 | HiiConfigAccess.Callback(), this will cause SendForm() be reentried.\r | |
| 1055 | So, save globals of previous call to SendForm() and restore them upon exit.\r | |
| 1056 | \r | |
| 1057 | **/\r | |
| 1058 | VOID\r | |
| 1059 | SaveBrowserContext (\r | |
| 1060 | VOID\r | |
| 1061 | );\r | |
| 1062 | \r | |
| 1063 | /**\r | |
| 1064 | Restore globals used by previous call to SendForm().\r | |
| 1065 | \r | |
| 1066 | **/\r | |
| 1067 | VOID\r | |
| 1068 | RestoreBrowserContext (\r | |
| 1069 | VOID\r | |
| 1070 | );\r | |
| 1071 | \r | |
| 7936fb6a | 1072 | /**\r |
| 1073 | This is the routine which an external caller uses to direct the browser\r | |
| 1074 | where to obtain it's information.\r | |
| 1075 | \r | |
| 1076 | \r | |
| 1077 | @param This The Form Browser protocol instanse.\r | |
| 1078 | @param Handles A pointer to an array of Handles. If HandleCount > 1 we\r | |
| 1079 | display a list of the formsets for the handles specified.\r | |
| 1080 | @param HandleCount The number of Handles specified in Handle.\r | |
| 1081 | @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r | |
| 1082 | field in the EFI_IFR_FORM_SET op-code for the specified\r | |
| 1083 | forms-based package. If FormSetGuid is NULL, then this\r | |
| 1084 | function will display the first found forms package.\r | |
| 1085 | @param FormId This field specifies which EFI_IFR_FORM to render as the first\r | |
| 1086 | displayable page. If this field has a value of 0x0000, then\r | |
| 1087 | the forms browser will render the specified forms in their encoded order.\r | |
| 1088 | ScreenDimenions - This allows the browser to be called so that it occupies a\r | |
| 1089 | portion of the physical screen instead of dynamically determining the screen dimensions.\r | |
| 1090 | ActionRequest - Points to the action recommended by the form.\r | |
| d66e6c16 | 1091 | @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r |
| 7936fb6a | 1092 | characters.\r |
| 1093 | @param ActionRequest Points to the action recommended by the form.\r | |
| 1094 | \r | |
| 1095 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1096 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
| 1097 | @retval EFI_NOT_FOUND No valid forms could be found to display.\r | |
| 1098 | \r | |
| 1099 | **/\r | |
| 1100 | EFI_STATUS\r | |
| 1101 | EFIAPI\r | |
| 1102 | SendForm (\r | |
| 1103 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
| 1104 | IN EFI_HII_HANDLE *Handles,\r | |
| 1105 | IN UINTN HandleCount,\r | |
| 1106 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
| 1107 | IN UINT16 FormId, OPTIONAL\r | |
| 1108 | IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r | |
| 1109 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r | |
| ed66e1bc | 1110 | );\r |
| 7936fb6a | 1111 | \r |
| 1112 | /**\r | |
| 1113 | This function is called by a callback handler to retrieve uncommitted state\r | |
| 1114 | data from the browser.\r | |
| 1115 | \r | |
| 1116 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL\r | |
| 1117 | instance.\r | |
| 1118 | @param ResultsDataSize A pointer to the size of the buffer associated\r | |
| 1119 | with ResultsData.\r | |
| 1120 | @param ResultsData A string returned from an IFR browser or\r | |
| 1121 | equivalent. The results string will have no\r | |
| 1122 | routing information in them.\r | |
| 1123 | @param RetrieveData A BOOLEAN field which allows an agent to retrieve\r | |
| 1124 | (if RetrieveData = TRUE) data from the uncommitted\r | |
| 1125 | browser state information or set (if RetrieveData\r | |
| 1126 | = FALSE) data in the uncommitted browser state\r | |
| 1127 | information.\r | |
| 1128 | @param VariableGuid An optional field to indicate the target variable\r | |
| 1129 | GUID name to use.\r | |
| 1130 | @param VariableName An optional field to indicate the target\r | |
| 1131 | human-readable variable name.\r | |
| 1132 | \r | |
| 1133 | @retval EFI_SUCCESS The results have been distributed or are awaiting\r | |
| 1134 | distribution.\r | |
| 1135 | @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to\r | |
| 1136 | contain the results data.\r | |
| 1137 | \r | |
| 1138 | **/\r | |
| 1139 | EFI_STATUS\r | |
| 1140 | EFIAPI\r | |
| 1141 | BrowserCallback (\r | |
| 1142 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
| 1143 | IN OUT UINTN *ResultsDataSize,\r | |
| 1144 | IN OUT EFI_STRING ResultsData,\r | |
| 1145 | IN BOOLEAN RetrieveData,\r | |
| 1146 | IN CONST EFI_GUID *VariableGuid, OPTIONAL\r | |
| 1147 | IN CONST CHAR16 *VariableName OPTIONAL\r | |
| ed66e1bc | 1148 | );\r |
| 7936fb6a | 1149 | \r |
| 1150 | #endif\r |